command.c: make private routines static
[openocd.git] / src / helper / command.c
index 5dbc047e6758fbe082ac7079ce516b65d3b9a964..2b8f646b9c1716d665d5ebdeab156c127b2fd216 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008, Duane Ellis                                       *
 int fast_and_dangerous = 0;
 Jim_Interp *interp = NULL;
 
-int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int run_command(command_context_t *context,
+               command_t *c, char *words[], unsigned num_words);
 
-int run_command(command_context_t *context, command_t *c, char *words[], int num_words);
-
-static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
+static void tcl_output(void *privData, const char *file, unsigned line,
+               const char *function, const char *string)
 {
-       Jim_Obj *tclOutput=(Jim_Obj *)privData;
-
+       Jim_Obj *tclOutput = (Jim_Obj *)privData;
        Jim_AppendString(interp, tclOutput, string, strlen(string));
 }
 
@@ -94,9 +92,9 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
         * to the fn and fish it out manually.
         */
        c = interp->cmdPrivData;
-       if (c==NULL)
+       if (c == NULL)
        {
-               LOG_ERROR("BUG: interp->cmdPrivData==NULL");
+               LOG_ERROR("BUG: interp->cmdPrivData == NULL");
                return JIM_ERR;
        }
        target_call_timer_callbacks_now();
@@ -108,7 +106,7 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        for (i = 0; i < argc; i++)
        {
                int len;
-               const char *w=Jim_GetString(argv[i], &len);
+               const char *w = Jim_GetString(argv[i], &len);
                if (*w=='#')
                {
                        /* hit an end of line comment */
@@ -117,6 +115,10 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                words[i] = strdup(w);
                if (words[i] == NULL)
                {
+                       int j;
+                       for (j = 0; j < i; j++)
+                               free(words[j]);
+                       free(words);
                        return JIM_ERR;
                }
        }
@@ -157,7 +159,7 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                *return_retval = retval;
        }
 
-       return (retval==ERROR_OK)?JIM_OK:JIM_ERR;
+       return (retval == ERROR_OK)?JIM_OK:JIM_ERR;
 }
 
 /* nice short description of source file */
@@ -212,7 +214,7 @@ command_t* register_command(command_context_t *context, command_t *parent, char
        }
 
        /* just a placeholder, no handler */
-       if (c->handler==NULL)
+       if (c->handler == NULL)
                return c;
 
        /* If this is a two level command, e.g. "flash banks", then the
@@ -226,31 +228,31 @@ command_t* register_command(command_context_t *context, command_t *parent, char
        const char *t2="";
        const char *t3="";
        /* maximum of two levels :-) */
-       if (c->parent!=NULL)
+       if (c->parent != NULL)
        {
-               t1=c->parent->name;
+               t1 = c->parent->name;
                t2="_";
        }
-       t3=c->name;
-       const char *full_name=alloc_printf("ocd_%s%s%s", t1, t2, t3);
+       t3 = c->name;
+       const char *full_name = alloc_printf("ocd_%s%s%s", t1, t2, t3);
        Jim_CreateCommand(interp, full_name, script_command, c, NULL);
        free((void *)full_name);
 
        /* we now need to add an overrideable proc */
-       const char *override_name=alloc_printf("proc %s%s%s {args} {if {[catch {eval ocd_%s%s%s $args}]==0} {return \"\"} else { return -code error }", t1, t2, t3, t1, t2, t3);
-       Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__ );
+       const char *override_name = alloc_printf("proc %s%s%s {args} {if {[catch {eval ocd_%s%s%s $args}]==0} {return \"\"} else { return -code error }", t1, t2, t3, t1, t2, t3);
+       Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
        free((void *)override_name);
 
        /* accumulate help text in Tcl helptext list.  */
-       Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
+       Jim_Obj *helptext = Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
        if (Jim_IsShared(helptext))
                helptext = Jim_DuplicateObj(interp, helptext);
-       Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
+       Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
 
-       Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
+       Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
 
        /* maximum of two levels :-) */
-       if (c->parent!=NULL)
+       if (c->parent != NULL)
        {
                Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1));
        }
@@ -269,11 +271,11 @@ int unregister_all_commands(command_context_t *context)
        if (context == NULL)
                return ERROR_OK;
 
-       while(NULL != context->commands)
+       while (NULL != context->commands)
        {
                c = context->commands;
 
-               while(NULL != c->children)
+               while (NULL != c->children)
                {
                        c2 = c->children;
                        c->children = c->children->next;
@@ -304,7 +306,7 @@ int unregister_command(command_context_t *context, char *name)
        /* find command */
        c = context->commands;
 
-       while(NULL != c)
+       while (NULL != c)
        {
                if (strcmp(name, c->name) == 0)
                {
@@ -320,7 +322,7 @@ int unregister_command(command_context_t *context, char *name)
                        }
 
                        /* unregister children */
-                       while(NULL != c->children)
+                       while (NULL != c->children)
                        {
                                c2 = c->children;
                                c->children = c->children->next;
@@ -348,8 +350,8 @@ int unregister_command(command_context_t *context, char *name)
 
 void command_output_text(command_context_t *context, const char *data)
 {
-       if( context && context->output_handler && data  ){
-               context->output_handler( context, data );
+       if (context && context->output_handler && data) {
+               context->output_handler(context, data);
        }
 }
 
@@ -402,10 +404,11 @@ void command_print(command_context_t *context, const char *format, ...)
        va_end(ap);
 }
 
-int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
+static int run_command(command_context_t *context,
+               command_t *c, char *words[], unsigned num_words)
 {
-       int start_word=0;
-       if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
+       int start_word = 0;
+       if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
        {
                /* Config commands can not run after the config stage */
                LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
@@ -420,12 +423,12 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num
                const char *t2="";
                const char *t3="";
                /* maximum of two levels :-) */
-               if (c->parent!=NULL)
+               if (c->parent != NULL)
                {
-                       t1=c->parent->name;
+                       t1 = c->parent->name;
                        t2=" ";
                }
-               t3=c->name;
+               t3 = c->name;
                command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
        }
        else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
@@ -450,7 +453,7 @@ int command_run_line(command_context_t *context, char *line)
         * results
         */
        /* run the line thru a script engine */
-       int retval=ERROR_FAIL;
+       int retval = ERROR_FAIL;
        int retcode;
        /* Beware! This code needs to be reentrant. It is also possible
         * for OpenOCD commands to be invoked directly from Tcl. This would
@@ -466,19 +469,19 @@ int command_run_line(command_context_t *context, char *line)
                retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
                if (retcode == JIM_OK)
                {
-                       retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__ );
+                       retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
 
                        Jim_DeleteAssocData(interp, "retval");
                }
                Jim_DeleteAssocData(interp, "context");
        }
        if (retcode == JIM_ERR) {
-               if (retval!=ERROR_COMMAND_CLOSE_CONNECTION)
+               if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
                {
                        /* We do not print the connection closed error message */
                        Jim_PrintErrorMessage(interp);
                }
-               if (retval==ERROR_OK)
+               if (retval == ERROR_OK)
                {
                        /* It wasn't a low level OpenOCD command that failed */
                        return ERROR_FAIL;
@@ -492,37 +495,37 @@ int command_run_line(command_context_t *context, char *line)
                int reslen;
 
                result = Jim_GetString(Jim_GetResult(interp), &reslen);
-               if (reslen>0)
+               if (reslen > 0)
                {
                        int i;
-                       char buff[256+1];
+                       char buff[256 + 1];
                        for (i = 0; i < reslen; i += 256)
                        {
                                int chunk;
                                chunk = reslen - i;
                                if (chunk > 256)
                                        chunk = 256;
-                               strncpy(buff, result+i, chunk);
+                               strncpy(buff, result + i, chunk);
                                buff[chunk] = 0;
                                LOG_USER_N("%s", buff);
                        }
                        LOG_USER_N("%s", "\n");
                }
-               retval=ERROR_OK;
+               retval = ERROR_OK;
        }
        return retval;
 }
 
 int command_run_linef(command_context_t *context, const char *format, ...)
 {
-       int retval=ERROR_FAIL;
+       int retval = ERROR_FAIL;
        char *string;
        va_list ap;
        va_start(ap, format);
        string = alloc_vprintf(format, ap);
-       if (string!=NULL)
+       if (string != NULL)
        {
-               retval=command_run_line(context, string);
+               retval = command_run_line(context, string);
        }
        va_end(ap);
        return retval;
@@ -599,7 +602,7 @@ static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *
        }
        /* GRR we must chunk - not null terminated */
        while (nbytes) {
-               char chunk[128+1];
+               char chunk[128 + 1];
                int x;
 
                x = nbytes;
@@ -673,7 +676,7 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
        log_add_callback(tcl_output, tclOutput);
 
-       retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__ );
+       retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
 
        log_remove_callback(tcl_output, tclOutput);
 
@@ -684,6 +687,54 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        return retcode;
 }
 
+/* sleep command sleeps for <n> miliseconds
+ * this is useful in target startup scripts
+ */
+static int handle_sleep_command(struct command_context_s *cmd_ctx,
+               char *cmd, char **args, int argc)
+{
+       bool busy = false;
+       if (argc == 2)
+       {
+               if (strcmp(args[1], "busy") == 0)
+                       busy = true;
+               else
+                       return ERROR_COMMAND_SYNTAX_ERROR;
+       }
+       else if (argc < 1 || argc > 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       unsigned long duration = 0;
+       int retval = parse_ulong(args[0], &duration);
+       if (ERROR_OK != retval)
+               return retval;
+
+       if (!busy)
+       {
+               long long then = timeval_ms();
+               while (timeval_ms() - then < (long long)duration)
+               {
+                       target_call_timer_callbacks_now();
+                       usleep(1000);
+               }
+       }
+       else
+               busy_sleep(duration);
+
+       return ERROR_OK;
+}
+
+static int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+{
+       if (argc != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       fast_and_dangerous = strcmp("enable", args[0]) == 0;
+
+       return ERROR_OK;
+}
+
+
 command_context_t* command_init()
 {
        command_context_t* context = malloc(sizeof(command_context_t));
@@ -704,7 +755,7 @@ command_context_t* command_init()
        Jim_RegisterCoreCommands(interp);
 #endif
 
-#if defined( _MSC_VER )
+#if defined(_MSC_VER)
        /* WinXX - is generic, the forward
         * looking problem is this:
         *
@@ -713,18 +764,22 @@ command_context_t* command_init()
         * "winxx" is generic.
         */
        HostOs = "winxx";
-#elif defined( __LINUX__)
+#elif defined(__linux__)
        HostOs = "linux";
-#elif defined( __DARWIN__ )
+#elif defined(__DARWIN__)
        HostOs = "darwin";
-#elif defined( __CYGWIN__ )
+#elif defined(__CYGWIN__)
        HostOs = "cygwin";
-#elif defined( __MINGW32__ )
+#elif defined(__MINGW32__)
        HostOs = "mingw32";
+#elif defined(__ECOS)
+       HostOs = "ecos";
 #else
+#warn unrecognized host OS...
        HostOs = "other";
 #endif
-       Jim_SetGlobalVariableStr( interp, "ocd_HOSTOS", Jim_NewStringObj( interp, HostOs , strlen(HostOs)) );
+       Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
+                       Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
 
        Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
        Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
@@ -740,23 +795,24 @@ command_context_t* command_init()
        interp->cb_fflush = openocd_jim_fflush;
        interp->cb_fgets = openocd_jim_fgets;
 
-       add_default_dirs();
-
 #if !BUILD_ECOSBOARD
        Jim_EventLoopOnLoad(interp);
 #endif
-       if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1)==JIM_ERR)
+       if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
        {
-               LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
+               LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
                Jim_PrintErrorMessage(interp);
                exit(-1);
        }
 
-       register_command(context, NULL, "sleep", handle_sleep_command,
-                                        COMMAND_ANY, "<n> [busy] - sleep for n milliseconds. \"busy\" means busy wait");
-
-       register_command(context, NULL, "fast", handle_fast_command,
-                                        COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
+       register_command(context, NULL, "sleep",
+                       handle_sleep_command, COMMAND_ANY,
+                       "<n> [busy] - sleep for n milliseconds. "
+                       "\"busy\" means busy wait");
+       register_command(context, NULL, "fast",
+                       handle_fast_command, COMMAND_ANY,
+                       "fast <enable/disable> - place at beginning of "
+                       "config files. Sets defaults to fast and dangerous.");
 
        return context;
 }
@@ -770,53 +826,6 @@ int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
        return ERROR_OK;
 }
 
-/* sleep command sleeps for <n> miliseconds
- * this is useful in target startup scripts
- */
-int handle_sleep_command(struct command_context_s *cmd_ctx,
-               char *cmd, char **args, int argc)
-{
-       bool busy = false;
-       if (argc == 2)
-       {
-               if (strcmp(args[1], "busy") == 0)
-                       busy = true;
-               else
-                       return ERROR_COMMAND_SYNTAX_ERROR;
-       }
-       else if (argc < 1 || argc > 2)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       unsigned long duration = 0;
-       int retval = parse_ulong(args[0], &duration);
-       if (ERROR_OK != retval)
-               return retval;
-
-       if (!busy)
-       {
-               long long then = timeval_ms();
-               while (timeval_ms() - then < (long long)duration)
-               {
-                       target_call_timer_callbacks_now();
-                       usleep(1000);
-               }
-       }
-       else
-               busy_sleep(duration);
-
-       return ERROR_OK;
-}
-
-int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
-{
-       if (argc!=1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       fast_and_dangerous = strcmp("enable", args[0])==0;
-
-       return ERROR_OK;
-}
-
 void process_jim_events(void)
 {
 #if !BUILD_ECOSBOARD
@@ -825,7 +834,7 @@ void process_jim_events(void)
        if (!recursion)
        {
                recursion++;
-               Jim_ProcessEvents (interp, JIM_ALL_EVENTS|JIM_DONT_WAIT);
+               Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
                recursion--;
        }
 #endif
@@ -837,13 +846,13 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd
 
        /* FIX!!! it would be prettier to invoke add_help_text...
         * accumulate help text in Tcl helptext list.  */
-       Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
+       Jim_Obj *helptext = Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
        if (Jim_IsShared(helptext))
                helptext = Jim_DuplicateObj(interp, helptext);
 
-       Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
+       Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
 
-       Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
+       Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
        Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
 
        Jim_ListAppendElement(interp, cmd_entry, cmd_list);
@@ -854,9 +863,9 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd
 /* return global variable long value or 0 upon failure */
 long jim_global_long(const char *variable)
 {
-       Jim_Obj *objPtr=Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
+       Jim_Obj *objPtr = Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
        long t;
-       if (Jim_GetLong(interp, objPtr, &t)==JIM_OK)
+       if (Jim_GetLong(interp, objPtr, &t) == JIM_OK)
        {
                return t;
        }
@@ -867,15 +876,27 @@ long jim_global_long(const char *variable)
        int parse##name(const char *str, type *ul) \
        { \
                if (!*str) \
+               { \
+                       LOG_ERROR("Invalid command argument"); \
                        return ERROR_COMMAND_ARGUMENT_INVALID; \
+               } \
                char *end; \
                *ul = func(str, &end, 0); \
                if (*end) \
+               { \
+                       LOG_ERROR("Invalid command argument"); \
                        return ERROR_COMMAND_ARGUMENT_INVALID; \
-               if (*ul == max) \
+               } \
+               if ((max == *ul) && (ERANGE == errno)) \
+               { \
+                       LOG_ERROR("Argument overflow"); \
                        return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
-               if (min && min == *ul) \
+               } \
+               if (min && (min == *ul) && (ERANGE == errno)) \
+               { \
+                       LOG_ERROR("Argument underflow"); \
                        return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
+               } \
                return ERROR_OK; \
        }
 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
@@ -896,7 +917,7 @@ DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
                        return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
                *ul = n; \
                return ERROR_OK; \
-       }       
+       }
 
 #define DEFINE_PARSE_ULONG(name, type, min, max) \
        DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)