Change return value on error.
[fw/openocd] / src / helper / ioutil.c
index ed82ba1cd78fa823476b2ab8cea0dd7d530fad21..8dc70312afcd8876e78738e9b155245e23994e9d 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2007-2008 by Øyvind Harboe                              *
+ *   Copyright (C) 2007-2010 by Øyvind Harboe                              *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
@@ -65,19 +65,19 @@ int loadFile(const char *fileName, void **data, size_t *len)
        pFile = fopen(fileName,"rb");
        if (pFile == NULL)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                return ERROR_FAIL;
        }
        if (fseek(pFile, 0, SEEK_END) != 0)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                fclose(pFile);
                return ERROR_FAIL;
        }
        long fsize = ftell(pFile);
        if (fsize == -1)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                fclose(pFile);
                return ERROR_FAIL;
        }
@@ -85,14 +85,14 @@ int loadFile(const char *fileName, void **data, size_t *len)
 
        if (fseek(pFile, 0, SEEK_SET) != 0)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                fclose(pFile);
                return ERROR_FAIL;
        }
        *data = malloc(*len + 1);
        if (*data == NULL)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                fclose(pFile);
                return ERROR_FAIL;
        }
@@ -101,7 +101,7 @@ int loadFile(const char *fileName, void **data, size_t *len)
        {
                fclose(pFile);
                free(*data);
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                return ERROR_FAIL;
        }
        fclose(pFile);
@@ -117,8 +117,7 @@ COMMAND_HANDLER(handle_cat_command)
 {
        if (CMD_ARGC != 1)
        {
-               command_print(CMD_CTX, "cat <filename>");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        // NOTE!!! we only have line printing capability so we print the entire file as a single line.
@@ -133,7 +132,7 @@ COMMAND_HANDLER(handle_cat_command)
        }
        else
        {
-               command_print(CMD_CTX, "%s not found %d", CMD_ARGV[0], retval);
+               command_print(CMD_CTX, "%s not found", CMD_ARGV[0]);
        }
 
        return ERROR_OK;
@@ -143,8 +142,7 @@ COMMAND_HANDLER(handle_trunc_command)
 {
        if (CMD_ARGC != 1)
        {
-               command_print(CMD_CTX, "trunc <filename>");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        FILE *config_file = NULL;
@@ -162,8 +160,7 @@ COMMAND_HANDLER(handle_meminfo_command)
 
        if (CMD_ARGC != 0)
        {
-               command_print(CMD_CTX, "meminfo");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        info = mallinfo();
@@ -184,13 +181,12 @@ COMMAND_HANDLER(handle_append_command)
 {
        if (CMD_ARGC < 1)
        {
-               command_print(CMD_CTX,
-                               "append <filename> [<string1>, [<string2>, ...]]");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        int retval = ERROR_FAIL;
        FILE *config_file = NULL;
+
        config_file = fopen(CMD_ARGV[0], "a");
        if (config_file != NULL)
        {
@@ -199,7 +195,8 @@ COMMAND_HANDLER(handle_append_command)
                unsigned i;
                for (i = 1; i < CMD_ARGC; i++)
                {
-                       if (fwrite(CMD_ARGV[i], 1, strlen(CMD_ARGV[i]), config_file) != strlen(CMD_ARGV[i]))
+                       if (fwrite(CMD_ARGV[i], 1, strlen(CMD_ARGV[i]),
+                                       config_file) != strlen(CMD_ARGV[i]))
                                break;
                        if (i != CMD_ARGC - 1)
                        {
@@ -208,9 +205,8 @@ COMMAND_HANDLER(handle_append_command)
                        }
                }
                if ((i == CMD_ARGC) && (fwrite("\n", 1, 1, config_file) == 1))
-               {
                        retval = ERROR_OK;
-               }
+
                fclose(config_file);
        }
 
@@ -223,7 +219,7 @@ COMMAND_HANDLER(handle_cp_command)
 {
        if (CMD_ARGC != 2)
        {
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        // NOTE!!! we only have line printing capability so we print the entire file as a single line.
@@ -236,7 +232,7 @@ COMMAND_HANDLER(handle_cp_command)
 
        FILE *f = fopen(CMD_ARGV[1], "wb");
        if (f == NULL)
-               retval = ERROR_INVALID_ARGUMENTS;
+               retval = ERROR_COMMAND_SYNTAX_ERROR;
 
        size_t pos = 0;
        for (;;)
@@ -249,7 +245,7 @@ COMMAND_HANDLER(handle_cp_command)
                }
 
                if ((retval == ERROR_OK) && (fwrite(((char *)data) + pos, 1, chunk, f) != chunk))
-                       retval = ERROR_INVALID_ARGUMENTS;
+                       retval = ERROR_COMMAND_SYNTAX_ERROR;
 
                if (retval != ERROR_OK)
                {
@@ -269,7 +265,7 @@ COMMAND_HANDLER(handle_cp_command)
                command_print(CMD_CTX, "Copied %s to %s", CMD_ARGV[0], CMD_ARGV[1]);
        } else
        {
-               command_print(CMD_CTX, "Failed: %d", retval);
+               command_print(CMD_CTX, "copy failed");
        }
 
        if (data != NULL)
@@ -401,30 +397,23 @@ void copydir(char *name, char *destdir)
 
 
 
-static int
-zylinjtag_Jim_Command_rm(Jim_Interp *interp,
-                                   int argc,
-               Jim_Obj * const *argv)
+COMMAND_HANDLER(handle_rm_command)
 {
-       int del;
-       if (argc != 2)
-       {
-               Jim_WrongNumArgs(interp, 1, argv, "rm ?dirorfile?");
-               return JIM_ERR;
-       }
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-       del = 0;
-       if (unlink(Jim_GetString(argv[1], NULL)) == 0)
-               del = 1;
-       if (rmdir(Jim_GetString(argv[1], NULL)) == 0)
-               del = 1;
+       bool del = false;
+       if (rmdir(CMD_ARGV[0]) == 0)
+               del = true;
+       else if (unlink(CMD_ARGV[0]) == 0)
+               del = true;
 
-       return del ? JIM_OK : JIM_ERR;
+       return del ? ERROR_OK : ERROR_FAIL;
 }
 
 
 static int
-zylinjtag_Jim_Command_ls(Jim_Interp *interp,
+ioutil_Jim_Command_ls(Jim_Interp *interp,
                                    int argc,
                Jim_Obj * const *argv)
 {
@@ -464,7 +453,7 @@ zylinjtag_Jim_Command_ls(Jim_Interp *interp,
 }
 
 static int
-zylinjtag_Jim_Command_peek(Jim_Interp *interp,
+ioutil_Jim_Command_peek(Jim_Interp *interp,
                                    int argc,
                Jim_Obj * const *argv)
 {
@@ -486,7 +475,7 @@ zylinjtag_Jim_Command_peek(Jim_Interp *interp,
 }
 
 static int
-zylinjtag_Jim_Command_poke(Jim_Interp *interp,
+ioutil_Jim_Command_poke(Jim_Interp *interp,
                                    int argc,
                Jim_Obj * const *argv)
 {
@@ -510,7 +499,7 @@ zylinjtag_Jim_Command_poke(Jim_Interp *interp,
 
 
 /* not so pretty code to fish out ip number*/
-static int zylinjtag_Jim_Command_ip(Jim_Interp *interp, int argc,
+static int ioutil_Jim_Command_ip(Jim_Interp *interp, int argc,
                Jim_Obj * const *argv)
 {
 #if !defined(__CYGWIN__)
@@ -557,7 +546,7 @@ static int zylinjtag_Jim_Command_ip(Jim_Interp *interp, int argc,
 }
 
 /* not so pretty code to fish out eth0 mac address */
-static int zylinjtag_Jim_Command_mac(Jim_Interp *interp, int argc,
+static int ioutil_Jim_Command_mac(Jim_Interp *interp, int argc,
                Jim_Obj * const *argv)
 {
 
@@ -626,76 +615,82 @@ static int zylinjtag_Jim_Command_mac(Jim_Interp *interp, int argc,
 static const struct command_registration ioutil_command_handlers[] = {
        {
                .name = "cat",
-               .handler = &handle_cat_command,
+               .handler = handle_cat_command,
                .mode = COMMAND_ANY,
-               .help = "display file content",
-               .usage= "<file_name>",
+               .help = "display text file content",
+               .usage= "file_name",
        },
        {
                .name = "trunc",
-               .handler = &handle_trunc_command,
+               .handler = handle_trunc_command,
                .mode = COMMAND_ANY,
-               .help = "truncate a file 0 size",
-               .usage= "<file_name>",
+               .help = "truncate a file to zero length",
+               .usage= "file_name",
        },
        {
                .name = "cp",
-               .handler = &handle_cp_command,
+               .handler = handle_cp_command,
                .mode = COMMAND_ANY,
                .help = "copy a file",
-               .usage = "<src> <dst>",
+               .usage = "src_file_name dst_file_name",
        },
        {
                .name = "append_file",
-               .handler = &handle_append_command,
+               .handler = handle_append_command,
                .mode = COMMAND_ANY,
                .help = "append a variable number of strings to a file",
-               .usage= "<file_name> [<string> ...]",
+               .usage = "file_name [<string1>, [<string2>, ...]]",
        },
        {
                .name = "meminfo",
-               .handler = &handle_meminfo_command,
+               .handler = handle_meminfo_command,
                .mode = COMMAND_ANY,
-               .help = "display available ram memory",
+               .help = "display free heap space",
        },
-       // jim handlers
        {
                .name = "rm",
                .mode = COMMAND_ANY,
-               .jim_handler = &zylinjtag_Jim_Command_rm,
-               .help = "remove a file",
-               .usage = "<file>",
+               .handler = handle_rm_command,
+               .help = "remove a directory or file",
+               .usage = "file_name",
        },
+
+       /*
+        * Peek and poke are security holes -- they manipulate
+        * server-internal addresses.
+        */
+
+       // jim handlers
        {
                .name = "peek",
                .mode = COMMAND_ANY,
-               .jim_handler = &zylinjtag_Jim_Command_peek,
+               .jim_handler = ioutil_Jim_Command_peek,
                .help = "peek at a memory address",
-               .usage = "<addr>",
+               .usage = "address",
        },
        {
                .name = "poke",
                .mode = COMMAND_ANY,
-               .jim_handler = &zylinjtag_Jim_Command_poke,
+               .jim_handler = ioutil_Jim_Command_poke,
                .help = "poke at a memory address",
-               .usage = "<addr> <value>",
+               .usage = "address value",
        },
        {
                .name = "ls",
                .mode = COMMAND_ANY,
-               .jim_handler = &zylinjtag_Jim_Command_ls,
+               .jim_handler = ioutil_Jim_Command_ls,
                .help = "show a listing of files",
-               .usage = "<dir>",
+               .usage = "dirname",
        },
        {
                .name = "mac",
                .mode = COMMAND_ANY,
-               .jim_handler = &zylinjtag_Jim_Command_mac,
+               .jim_handler = ioutil_Jim_Command_mac,
                .help = "show MAC address",
        },
        {
                .name = "ip",
-               .jim_handler = &zylinjtag_Jim_Command_ip,
+               .jim_handler = ioutil_Jim_Command_ip,
                .mode = COMMAND_ANY,
                .help = "show IP address",
        },