Change return value on error.
[fw/openocd] / src / helper / ioutil.c
index 77e5e35682065cefe6c9ca2027ca463968a42b6d..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  *
@@ -38,9 +38,6 @@
 #ifdef HAVE_NET_IF_H
 #include <net/if.h>
 #endif
-//#ifdef HAVE_NETINET_TCP_H
-//#include <netinet/tcp.h>
-//#endif
 #ifdef HAVE_SYS_IOCTL_H
 #include <sys/ioctl.h>
 #endif
 #endif
 
 
-int handle_rm_command(struct command_context_s *cmd_ctx, char *cmd,
-               char **args, int argc)
-{
-       if (argc != 1)
-       {
-               command_print(cmd_ctx, "rm <filename>");
-               return ERROR_INVALID_ARGUMENTS;
-       }
-
-       if (unlink(args[0]) != 0)
-       {
-               command_print(cmd_ctx, "failed: %d", errno);
-       }
-
-       return ERROR_OK;
-}
-
-
 /* loads a file and returns a pointer to it in memory. The file contains
  * a 0 byte(sentinel) after len bytes - the length of the file. */
 int loadFile(const char *fileName, void **data, size_t *len)
@@ -84,36 +63,36 @@ int loadFile(const char *fileName, void **data, size_t *len)
 
        FILE * pFile;
        pFile = fopen(fileName,"rb");
-       if (pFile==NULL)
+       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)
+       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;
        }
        *len = fsize;
 
-       if (fseek(pFile, 0, SEEK_SET)!=0)
+       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)
+       if (*data == NULL)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                fclose(pFile);
                return ERROR_FAIL;
        }
@@ -122,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);
@@ -134,109 +113,100 @@ int loadFile(const char *fileName, void **data, size_t *len)
        return ERROR_OK;
 }
 
-
-
-int handle_cat_command(struct command_context_s *cmd_ctx, char *cmd,
-               char **args, int argc)
+COMMAND_HANDLER(handle_cat_command)
 {
-       if (argc != 1)
+       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.
        void *data;
        size_t len;
 
-       int retval = loadFile(args[0], &data, &len);
+       int retval = loadFile(CMD_ARGV[0], &data, &len);
        if (retval == ERROR_OK)
        {
-               command_print(cmd_ctx, "%s", (char *)data);
+               command_print(CMD_CTX, "%s", (char *)data);
                free(data);
        }
        else
        {
-               command_print(cmd_ctx, "%s not found %d", args[0], retval);
+               command_print(CMD_CTX, "%s not found", CMD_ARGV[0]);
        }
 
        return ERROR_OK;
 }
-int handle_trunc_command(struct command_context_s *cmd_ctx, char *cmd,
-               char **args, int argc)
+
+COMMAND_HANDLER(handle_trunc_command)
 {
-       if (argc != 1)
+       if (CMD_ARGC != 1)
        {
-               command_print(cmd_ctx, "trunc <filename>");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        FILE *config_file = NULL;
-       config_file = fopen(args[0], "w");
+       config_file = fopen(CMD_ARGV[0], "w");
        if (config_file != NULL)
                fclose(config_file);
 
        return ERROR_OK;
 }
 
-
-int handle_meminfo_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_meminfo_command)
 {
        static int prev = 0;
        struct mallinfo info;
 
-       if (argc != 0)
+       if (CMD_ARGC != 0)
        {
-               command_print(cmd_ctx, "meminfo");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        info = mallinfo();
 
        if (prev > 0)
        {
-               command_print(cmd_ctx, "Diff:            %d", prev - info.fordblks);
+               command_print(CMD_CTX, "Diff:            %d", prev - info.fordblks);
        }
        prev = info.fordblks;
 
-       command_print(cmd_ctx, "Available ram:   %d", info.fordblks );
+       command_print(CMD_CTX, "Available ram:   %d", info.fordblks);
 
        return ERROR_OK;
 }
 
 
-int handle_append_command(struct command_context_s *cmd_ctx, char *cmd,
-               char **args, int argc)
+COMMAND_HANDLER(handle_append_command)
 {
-       if (argc < 1)
+       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;
+       int retval = ERROR_FAIL;
        FILE *config_file = NULL;
-       config_file = fopen(args[0], "a");
+
+       config_file = fopen(CMD_ARGV[0], "a");
        if (config_file != NULL)
        {
-               int i;
                fseek(config_file, 0, SEEK_END);
 
-               for (i = 1; i < argc; i++)
+               unsigned i;
+               for (i = 1; i < CMD_ARGC; i++)
                {
-                       if (fwrite(args[i], 1, strlen(args[i]), config_file)!=strlen(args[i]))
+                       if (fwrite(CMD_ARGV[i], 1, strlen(CMD_ARGV[i]),
+                                       config_file) != strlen(CMD_ARGV[i]))
                                break;
-                       if (i != argc - 1)
+                       if (i != CMD_ARGC - 1)
                        {
-                               if (fwrite(" ", 1, 1, config_file)!=1)
+                               if (fwrite(" ", 1, 1, config_file) != 1)
                                        break;
                        }
                }
-               if ((i==argc)&&(fwrite("\n", 1, 1, config_file)==1))
-               {
-                       retval=ERROR_OK;
-               }
+               if ((i == CMD_ARGC) && (fwrite("\n", 1, 1, config_file) == 1))
+                       retval = ERROR_OK;
+
                fclose(config_file);
        }
 
@@ -245,24 +215,24 @@ int handle_append_command(struct command_context_s *cmd_ctx, char *cmd,
 
 
 
-int handle_cp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_cp_command)
 {
-       if (argc != 2)
+       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.
        void *data;
        size_t len;
 
-       int retval = loadFile(args[0], &data, &len);
+       int retval = loadFile(CMD_ARGV[0], &data, &len);
        if (retval != ERROR_OK)
                return retval;
 
-       FILE *f = fopen(args[1], "wb");
+       FILE *f = fopen(CMD_ARGV[1], "wb");
        if (f == NULL)
-               retval = ERROR_INVALID_ARGUMENTS;
+               retval = ERROR_COMMAND_SYNTAX_ERROR;
 
        size_t pos = 0;
        for (;;)
@@ -274,15 +244,15 @@ int handle_cp_command(struct command_context_s *cmd_ctx, char *cmd, char **args,
                        chunk = maxChunk;
                }
 
-               if ((retval==ERROR_OK)&&(fwrite(((char *)data)+pos, 1, chunk, f)!=chunk))
-                       retval = ERROR_INVALID_ARGUMENTS;
+               if ((retval == ERROR_OK) && (fwrite(((char *)data) + pos, 1, chunk, f) != chunk))
+                       retval = ERROR_COMMAND_SYNTAX_ERROR;
 
                if (retval != ERROR_OK)
                {
                        break;
                }
 
-               command_print(cmd_ctx, "%d", len - pos);
+               command_print(CMD_CTX, "%zu", len - pos);
 
                pos += chunk;
 
@@ -292,10 +262,10 @@ int handle_cp_command(struct command_context_s *cmd_ctx, char *cmd, char **args,
 
        if (retval == ERROR_OK)
        {
-               command_print(cmd_ctx, "Copied %s to %s", args[0], args[1]);
+               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)
@@ -304,7 +274,7 @@ int handle_cp_command(struct command_context_s *cmd_ctx, char *cmd, char **args,
                fclose(f);
 
        if (retval != ERROR_OK)
-               unlink(args[1]);
+               unlink(CMD_ARGV[1]);
 
        return retval;
 }
@@ -323,36 +293,36 @@ void copyfile(char *name2, char *name1)
        int fd1, fd2;
        ssize_t done, wrote;
 
-       fd1 = open(name1, O_WRONLY | O_CREAT);
+       fd1 = open(name1, O_WRONLY | O_CREAT, 0664);
        if (fd1 < 0)
-               SHOW_RESULT( open, fd1 );
+               SHOW_RESULT(open, fd1);
 
        fd2 = open(name2, O_RDONLY);
        if (fd2 < 0)
-               SHOW_RESULT( open, fd2 );
+               SHOW_RESULT(open, fd2);
 
        for (;;)
        {
-               done = read(fd2, buf, IOSIZE );
+               done = read(fd2, buf, IOSIZE);
                if (done < 0)
                {
-                       SHOW_RESULT( read, done );
+                       SHOW_RESULT(read, done);
                        break;
                }
 
-        if( done == 0 ) break;
+        if (done == 0) break;
 
                wrote = write(fd1, buf, done);
-        if( wrote != done ) SHOW_RESULT( write, wrote );
+        if (wrote != done) SHOW_RESULT(write, wrote);
 
-        if( wrote != done ) break;
+        if (wrote != done) break;
        }
 
        err = close(fd1);
-    if( err < 0 ) SHOW_RESULT( close, err );
+    if (err < 0) SHOW_RESULT(close, err);
 
        err = close(fd2);
-    if( err < 0 ) SHOW_RESULT( close, err );
+    if (err < 0) SHOW_RESULT(close, err);
 
 }
 
@@ -363,7 +333,7 @@ void copydir(char *name, char *destdir)
        DIR *dirp;
 
        dirp = opendir(destdir);
-       if (dirp==NULL)
+       if (dirp == NULL)
        {
                mkdir(destdir, 0777);
        } else
@@ -372,7 +342,7 @@ void copydir(char *name, char *destdir)
        }
 
        dirp = opendir(name);
-    if( dirp == NULL ) SHOW_RESULT( opendir, -1 );
+    if (dirp == NULL) SHOW_RESULT(opendir, -1);
 
        for (;;)
        {
@@ -421,36 +391,29 @@ void copydir(char *name, char *destdir)
        }
 
        err = closedir(dirp);
-    if( err < 0 ) SHOW_RESULT( stat, err );
+    if (err < 0) SHOW_RESULT(stat, err);
 }
 
 
 
 
-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)
 {
@@ -477,7 +440,7 @@ zylinjtag_Jim_Command_ls(Jim_Interp *interp,
                if (entry == NULL)
                        break;
 
-               if ((strcmp(".", entry->d_name)==0)||(strcmp("..", entry->d_name)==0))
+               if ((strcmp(".", entry->d_name) == 0)||(strcmp("..", entry->d_name) == 0))
                        continue;
 
         Jim_ListAppendElement(interp, objPtr, Jim_NewStringObj(interp, entry->d_name, strlen(entry->d_name)));
@@ -490,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)
 {
@@ -512,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)
 {
@@ -536,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__)
@@ -583,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)
 {
 
@@ -613,7 +576,7 @@ static int zylinjtag_Jim_Command_mac(Jim_Interp *interp, int argc,
        {
                //if (ifr->ifr_addr.sa_family == AF_INET)
                {
-                       if (strcmp("eth0", ifr->ifr_name)!=0)
+                       if (strcmp("eth0", ifr->ifr_name) != 0)
                                continue;
                        strncpy(ifreq.ifr_name, ifr->ifr_name, sizeof(ifreq.ifr_name));
                        if (ioctl(SockFD, SIOCGIFHWADDR, &ifreq) < 0)
@@ -649,41 +612,92 @@ static int zylinjtag_Jim_Command_mac(Jim_Interp *interp, int argc,
 
 }
 
-
-
-int ioutil_init(struct command_context_s *cmd_ctx)
+static const struct command_registration ioutil_command_handlers[] = {
+       {
+               .name = "cat",
+               .handler = handle_cat_command,
+               .mode = COMMAND_ANY,
+               .help = "display text file content",
+               .usage= "file_name",
+       },
+       {
+               .name = "trunc",
+               .handler = handle_trunc_command,
+               .mode = COMMAND_ANY,
+               .help = "truncate a file to zero length",
+               .usage= "file_name",
+       },
+       {
+               .name = "cp",
+               .handler = handle_cp_command,
+               .mode = COMMAND_ANY,
+               .help = "copy a file",
+               .usage = "src_file_name dst_file_name",
+       },
+       {
+               .name = "append_file",
+               .handler = handle_append_command,
+               .mode = COMMAND_ANY,
+               .help = "append a variable number of strings to a file",
+               .usage = "file_name [<string1>, [<string2>, ...]]",
+       },
+       {
+               .name = "meminfo",
+               .handler = handle_meminfo_command,
+               .mode = COMMAND_ANY,
+               .help = "display free heap space",
+       },
+       {
+               .name = "rm",
+               .mode = COMMAND_ANY,
+               .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 = ioutil_Jim_Command_peek,
+               .help = "peek at a memory address",
+               .usage = "address",
+       },
+       {
+               .name = "poke",
+               .mode = COMMAND_ANY,
+               .jim_handler = ioutil_Jim_Command_poke,
+               .help = "poke at a memory address",
+               .usage = "address value",
+       },
+       {
+               .name = "ls",
+               .mode = COMMAND_ANY,
+               .jim_handler = ioutil_Jim_Command_ls,
+               .help = "show a listing of files",
+               .usage = "dirname",
+       },
+       {
+               .name = "mac",
+               .mode = COMMAND_ANY,
+               .jim_handler = ioutil_Jim_Command_mac,
+               .help = "show MAC address",
+       },
+       {
+               .name = "ip",
+               .jim_handler = ioutil_Jim_Command_ip,
+               .mode = COMMAND_ANY,
+               .help = "show IP address",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+int ioutil_init(struct command_context *cmd_ctx)
 {
-       register_command(cmd_ctx, NULL, "rm", handle_rm_command, COMMAND_ANY,
-                       "remove file");
-
-       register_command(cmd_ctx, NULL, "cat", handle_cat_command, COMMAND_ANY,
-                       "display file content");
-
-       register_command(cmd_ctx, NULL, "trunc", handle_trunc_command, COMMAND_ANY,
-                       "truncate a file to 0 size");
-
-       register_command(cmd_ctx, NULL, "cp", handle_cp_command,
-                                        COMMAND_ANY, "copy a file <from> <to>");
-
-       register_command(cmd_ctx, NULL, "append_file", handle_append_command,
-                       COMMAND_ANY, "append a variable number of strings to a file");
-
-       register_command(cmd_ctx, NULL, "meminfo", handle_meminfo_command,
-                       COMMAND_ANY, "display available ram memory");
-
-    Jim_CreateCommand(interp, "rm", zylinjtag_Jim_Command_rm, NULL, NULL);
-
-    Jim_CreateCommand(interp, "peek", zylinjtag_Jim_Command_peek, NULL, NULL);
-    Jim_CreateCommand(interp, "poke", zylinjtag_Jim_Command_poke, NULL, NULL);
-    Jim_CreateCommand(interp, "ls", zylinjtag_Jim_Command_ls, NULL, NULL);
-
-       Jim_CreateCommand(interp, "mac", zylinjtag_Jim_Command_mac,
-                       NULL, NULL);
-
-       Jim_CreateCommand(interp, "ip", zylinjtag_Jim_Command_ip,
-                       NULL, NULL);
-
-    return ERROR_OK;
+       return register_commands(cmd_ctx, NULL, ioutil_command_handlers);
 }
-
-