helper/command: pass command prefix to command registration
[openocd.git] / src / helper / command.c
index 271e7b993fb46355c191953ac9cec0ce46c52587..114d0732866a8cd1f3a1db26acb2b65d88571e43 100644 (file)
@@ -44,9 +44,6 @@
 /* nice short description of source file */
 #define __THIS__FILE__ "command.c"
 
-static int run_command(struct command_context *context,
-               struct command *c, const char *words[], unsigned num_words);
-
 struct log_capture_state {
        Jim_Interp *interp;
        Jim_Obj *output;
@@ -117,6 +114,40 @@ static void command_log_capture_finish(struct log_capture_state *state)
        free(state);
 }
 
+/*
+ * FIXME: workaround for memory leak in jimtcl 0.80
+ * Jim API Jim_CreateCommand() converts the command name in a Jim object and
+ * does not free the object. Fixed for jimtcl 0.81 by e4416cf86f0b
+ * Use the internal jimtcl API Jim_CreateCommandObj, not exported by jim.h,
+ * and override the bugged API through preprocessor's macro.
+ * This workaround works only when jimtcl is compiled as OpenOCD submodule.
+ * If jimtcl is linked-in from a precompiled library, either static or dynamic,
+ * the symbol Jim_CreateCommandObj is not exported and the build will use the
+ * bugged API.
+ * To be removed when OpenOCD will switch to jimtcl 0.81
+ */
+#if JIM_VERSION == 80
+static int workaround_createcommand(Jim_Interp *interp, const char *cmdName,
+       Jim_CmdProc *cmdProc, void *privData, Jim_DelCmdProc *delProc);
+int Jim_CreateCommandObj(Jim_Interp *interp, Jim_Obj *cmdNameObj,
+       Jim_CmdProc *cmdProc, void *privData, Jim_DelCmdProc *delProc)
+__attribute__((weak, alias("workaround_createcommand")));
+static int workaround_createcommand(Jim_Interp *interp, const char *cmdName,
+       Jim_CmdProc *cmdProc, void *privData, Jim_DelCmdProc *delProc)
+{
+       if ((void *)Jim_CreateCommandObj == (void *)workaround_createcommand)
+               return Jim_CreateCommand(interp, cmdName, cmdProc, privData, delProc);
+
+       Jim_Obj *cmd_name = Jim_NewStringObj(interp, cmdName, -1);
+       Jim_IncrRefCount(cmd_name);
+       int retval = Jim_CreateCommandObj(interp, cmd_name, cmdProc, privData, delProc);
+       Jim_DecrRefCount(interp, cmd_name);
+       return retval;
+}
+#define Jim_CreateCommand workaround_createcommand
+#endif /* JIM_VERSION == 80 */
+/* FIXME: end of workaround for memory leak in jimtcl 0.80 */
+
 static int command_retval_set(Jim_Interp *interp, int retval)
 {
        int *return_retval = Jim_GetAssocData(interp, "retval");
@@ -192,34 +223,6 @@ struct command_context *current_command_context(Jim_Interp *interp)
        return cmd_ctx;
 }
 
-static int script_command_run(Jim_Interp *interp,
-       int argc, Jim_Obj * const *argv, struct command *c)
-{
-       target_call_timer_callbacks_now();
-       LOG_USER_N("%s", "");   /* Keep GDB connection alive*/
-
-       unsigned nwords;
-       char **words = script_command_args_alloc(argc, argv, &nwords);
-       if (NULL == words)
-               return JIM_ERR;
-
-       struct command_context *cmd_ctx = current_command_context(interp);
-       int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
-
-       script_command_args_free(words, nwords);
-       return command_retval_set(interp, retval);
-}
-
-static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
-       /* the private data is stashed in the interp structure */
-
-       struct command *c = interp->cmdPrivData;
-       assert(c);
-       script_debug(interp, argc, argv);
-       return script_command_run(interp, argc, argv, c);
-}
-
 static struct command *command_root(struct command *c)
 {
        while (NULL != c->parent)
@@ -241,12 +244,6 @@ static struct command *command_find(struct command *head, const char *name)
        return NULL;
 }
 
-struct command *command_find_in_context(struct command_context *cmd_ctx,
-       const char *name)
-{
-       return command_find(cmd_ctx->commands, name);
-}
-
 /**
  * Add the command into the linked list, sorted by name.
  * @param head Address to head of command list pointer, which may be
@@ -349,12 +346,11 @@ static int register_command_handler(struct command_context *cmd_ctx,
 {
        Jim_Interp *interp = cmd_ctx->interp;
 
+#if 0
        LOG_DEBUG("registering '%s'...", c->name);
+#endif
 
-       Jim_CmdProc *func = c->handler ? &script_command : &command_unknown;
-       int retval = Jim_CreateCommand(interp, c->name, func, c, NULL);
-
-       return retval;
+       return Jim_CreateCommand(interp, c->name, command_unknown, c, NULL);
 }
 
 static struct command *register_command(struct command_context *context,
@@ -379,22 +375,19 @@ static struct command *register_command(struct command_context *context,
        if (NULL == c)
                return NULL;
 
-       int retval = JIM_OK;
-       if (NULL != cr->jim_handler && NULL == parent) {
-               retval = Jim_CreateCommand(context->interp, cr->name,
-                               cr->jim_handler, NULL, NULL);
-       } else if (NULL != cr->handler || NULL != parent)
-               retval = register_command_handler(context, command_root(c));
-
-       if (retval != JIM_OK) {
-               unregister_command(context, parent, name);
-               c = NULL;
+       if (cr->jim_handler || cr->handler) {
+               int retval = register_command_handler(context, command_root(c));
+               if (retval != JIM_OK) {
+                       unregister_command(context, parent, name);
+                       return NULL;
+               }
        }
        return c;
 }
 
-int register_commands(struct command_context *cmd_ctx, struct command *parent,
-       const struct command_registration *cmds)
+static int ___register_commands(struct command_context *cmd_ctx, struct command *parent,
+       const struct command_registration *cmds, void *data,
+       struct target *override_target)
 {
        int retval = ERROR_OK;
        unsigned i;
@@ -408,10 +401,12 @@ int register_commands(struct command_context *cmd_ctx, struct command *parent,
                                retval = ERROR_FAIL;
                                break;
                        }
+                       c->jim_handler_data = data;
+                       c->jim_override_target = override_target;
                }
                if (NULL != cr->chain) {
                        struct command *p = c ? : parent;
-                       retval = register_commands(cmd_ctx, p, cr->chain);
+                       retval = ___register_commands(cmd_ctx, p, cr->chain, data, override_target);
                        if (ERROR_OK != retval)
                                break;
                }
@@ -423,6 +418,18 @@ int register_commands(struct command_context *cmd_ctx, struct command *parent,
        return retval;
 }
 
+int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
+       const struct command_registration *cmds, void *data,
+       struct target *override_target)
+{
+       struct command *parent = NULL;
+
+       if (cmd_prefix)
+               parent = command_find(cmd_ctx->commands, cmd_prefix);
+
+       return ___register_commands(cmd_ctx, parent, cmds, data, override_target);
+}
+
 int unregister_all_commands(struct command_context *context,
        struct command *parent)
 {
@@ -463,14 +470,6 @@ static int unregister_command(struct command_context *context,
        return ERROR_OK;
 }
 
-void command_set_handler_data(struct command *c, void *p)
-{
-       if (NULL != c->handler || NULL != c->jim_handler)
-               c->jim_handler_data = p;
-       for (struct command *cc = c->children; NULL != cc; cc = cc->next)
-               command_set_handler_data(cc, p);
-}
-
 void command_output_text(struct command_context *context, const char *data)
 {
        if (context && context->output_handler && data)
@@ -579,11 +578,8 @@ static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
 }
 
 static int run_command(struct command_context *context,
-       struct command *c, const char *words[], unsigned num_words)
+       struct command *c, const char **words, unsigned num_words)
 {
-       if (!command_can_run(context, c))
-               return ERROR_FAIL;
-
        struct command_invocation cmd = {
                .ctx = context,
                .current = c,
@@ -591,26 +587,11 @@ static int run_command(struct command_context *context,
                .argc = num_words - 1,
                .argv = words + 1,
        };
-       /* Black magic of overridden current target:
-        * If the command we are going to handle has a target prefix,
-        * override the current target temporarily for the time
-        * of processing the command.
-        * current_target_override is used also for event handlers
-        * therefore we prevent touching it if command has no prefix.
-        * Previous override is saved and restored back to ensure
-        * correct work when run_command() is re-entered. */
-       struct target *saved_target_override = context->current_target_override;
-       if (c->jim_handler_data)
-               context->current_target_override = c->jim_handler_data;
 
        cmd.output = Jim_NewEmptyStringObj(context->interp);
        Jim_IncrRefCount(cmd.output);
 
        int retval = c->handler(&cmd);
-
-       if (c->jim_handler_data)
-               context->current_target_override = saved_target_override;
-
        if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
                /* Print help for command */
                char *full_name = command_name(c, ' ');
@@ -920,39 +901,29 @@ COMMAND_HANDLER(handle_help_command)
        bool full = strcmp(CMD_NAME, "help") == 0;
        int retval;
        struct command *c = CMD_CTX->commands;
-       char *cmd_match = NULL;
-
-       if (CMD_ARGC == 0)
-               cmd_match = "";
-       else if (CMD_ARGC >= 1) {
-               unsigned i;
-
-               for (i = 0; i < CMD_ARGC; ++i) {
-                       if (NULL != cmd_match) {
-                               char *prev = cmd_match;
-
-                               cmd_match = alloc_printf("%s %s", cmd_match, CMD_ARGV[i]);
-                               free(prev);
-                               if (NULL == cmd_match) {
-                                       LOG_ERROR("unable to build search string");
-                                       return -ENOMEM;
-                               }
-                       } else {
-                               cmd_match = alloc_printf("%s", CMD_ARGV[i]);
-                               if (NULL == cmd_match) {
-                                       LOG_ERROR("unable to build search string");
-                                       return -ENOMEM;
-                               }
-                       }
+       char *cmd_match;
+
+       if (CMD_ARGC <= 0)
+               cmd_match = strdup("");
+
+       else {
+               cmd_match = strdup(CMD_ARGV[0]);
+
+               for (unsigned int i = 1; i < CMD_ARGC && cmd_match; ++i) {
+                       char *prev = cmd_match;
+                       cmd_match = alloc_printf("%s %s", prev, CMD_ARGV[i]);
+                       free(prev);
                }
-       } else
-               return ERROR_COMMAND_SYNTAX_ERROR;
+       }
 
+       if (cmd_match == NULL) {
+               LOG_ERROR("unable to build search string");
+               return -ENOMEM;
+       }
        retval = CALL_COMMAND_HANDLER(command_help_show_list,
                        c, 0, full, cmd_match);
 
-       if (CMD_ARGC >= 1)
-               free(cmd_match);
+       free(cmd_match);
        return retval;
 }
 
@@ -1028,6 +999,23 @@ static int run_usage(Jim_Interp *interp, int argc_valid, int argc, Jim_Obj * con
        return retval;
 }
 
+static int exec_command(Jim_Interp *interp, struct command_context *cmd_ctx,
+               struct command *c, int argc, Jim_Obj *const *argv)
+{
+       if (c->jim_handler)
+               return c->jim_handler(interp, argc, argv);
+
+       /* use c->handler */
+       unsigned int nwords;
+       char **words = script_command_args_alloc(argc, argv, &nwords);
+       if (!words)
+               return JIM_ERR;
+
+       int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
+       script_command_args_free(words, nwords);
+       return command_retval_set(interp, retval);
+}
+
 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        script_debug(interp, argc, argv);
@@ -1054,16 +1042,32 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                run_usage(interp, count, argc, start);
                return JIM_ERR;
        }
-       /* pass the command through to the intended handler */
-       if (c->jim_handler) {
-               if (!command_can_run(cmd_ctx, c))
-                       return JIM_ERR;
 
-               interp->cmdPrivData = c->jim_handler_data;
-               return (*c->jim_handler)(interp, count, start);
-       }
+       if (!command_can_run(cmd_ctx, c))
+               return JIM_ERR;
+
+       target_call_timer_callbacks_now();
+
+       /*
+        * Black magic of overridden current target:
+        * If the command we are going to handle has a target prefix,
+        * override the current target temporarily for the time
+        * of processing the command.
+        * current_target_override is used also for event handlers
+        * therefore we prevent touching it if command has no prefix.
+        * Previous override is saved and restored back to ensure
+        * correct work when command_unknown() is re-entered.
+        */
+       struct target *saved_target_override = cmd_ctx->current_target_override;
+       if (c->jim_override_target)
+               cmd_ctx->current_target_override = c->jim_override_target;
+
+       int retval = exec_command(interp, cmd_ctx, c, count, start);
 
-       return script_command_run(interp, count, start, c);
+       if (c->jim_override_target)
+               cmd_ctx->current_target_override = saved_target_override;
+
+       return retval;
 }
 
 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)

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)