target/target: Add 'debug_reason' to current target
[openocd.git] / src / helper / command.c
index d79d7f464771d483f350c6cdd3ccb4ec2a1aff4e..a775c730b88f8d5d499369b64091911531e68b17 100644 (file)
@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
  *   part of this file is taken from libcli (libcli.sourceforge.net)       *
  *   Copyright (C) David Parrish (david@dparrish.com)                      *
- *                                                                         *
- *   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  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-/* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
-#define JIM_EMBEDDED
-
 /* @todo the inclusion of target.h here is a layering violation */
 #include <jtag/jtag.h>
 #include <target/target.h>
@@ -50,9 +36,8 @@ struct log_capture_state {
 };
 
 static int unregister_command(struct command_context *context,
-       struct command *parent, const char *name);
-static char *command_name(struct command *c, char delim);
-static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj * const *argv);
+       const char *cmd_prefix, const char *name);
+static int jim_command_dispatch(Jim_Interp *interp, int argc, Jim_Obj * const *argv);
 static int help_add_command(struct command_context *cmd_ctx,
        const char *cmd_name, const char *help_text, const char *usage_text);
 static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name);
@@ -63,12 +48,12 @@ static inline bool jimcmd_is_proc(Jim_Cmd *cmd)
        return cmd->isproc;
 }
 
-static inline bool jimcmd_is_ocd_command(Jim_Cmd *cmd)
+bool jimcmd_is_oocd_command(Jim_Cmd *cmd)
 {
-       return !cmd->isproc && cmd->u.native.cmdProc == command_unknown;
+       return !cmd->isproc && cmd->u.native.cmdProc == jim_command_dispatch;
 }
 
-static inline void *jimcmd_privdata(Jim_Cmd *cmd)
+void *jimcmd_privdata(Jim_Cmd *cmd)
 {
        return cmd->isproc ? NULL : cmd->u.native.privData;
 }
@@ -84,17 +69,21 @@ static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
 {
        /* capture log output and return it. A garbage collect can
         * happen, so we need a reference count to this object */
-       Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
-       if (NULL == tclOutput)
+       Jim_Obj *jim_output = Jim_NewStringObj(interp, "", 0);
+       if (!jim_output)
                return NULL;
 
+       Jim_IncrRefCount(jim_output);
+
        struct log_capture_state *state = malloc(sizeof(*state));
-       if (NULL == state)
+       if (!state) {
+               LOG_ERROR("Out of memory");
+               Jim_DecrRefCount(interp, jim_output);
                return NULL;
+       }
 
        state->interp = interp;
-       Jim_IncrRefCount(tclOutput);
-       state->output = tclOutput;
+       state->output = jim_output;
 
        log_add_callback(tcl_output, state);
 
@@ -110,68 +99,36 @@ static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
  * The tcl return value is empty for openocd commands that provide
  * progress output.
  *
- * Therefore we set the tcl return value only if we actually
- * captured output.
+ * For other commands, we prepend the logs to the tcl return value.
  */
 static void command_log_capture_finish(struct log_capture_state *state)
 {
-       if (NULL == state)
+       if (!state)
                return;
 
        log_remove_callback(tcl_output, state);
 
-       int length;
-       Jim_GetString(state->output, &length);
+       int loglen;
+       const char *log_result = Jim_GetString(state->output, &loglen);
+       int reslen;
+       const char *cmd_result = Jim_GetString(Jim_GetResult(state->interp), &reslen);
 
-       if (length > 0)
-               Jim_SetResult(state->interp, state->output);
-       else {
-               /* No output captured, use tcl return value (which could
-                * be empty too). */
-       }
-       Jim_DecrRefCount(state->interp, state->output);
+       // Just in case the log doesn't end with a newline, we add it
+       if (loglen != 0 && reslen != 0 && log_result[loglen - 1] != '\n')
+               Jim_AppendString(state->interp, state->output, "\n", 1);
 
-       free(state);
-}
+       Jim_AppendString(state->interp, state->output, cmd_result, reslen);
 
-/*
- * 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_SetResult(state->interp, state->output);
+       Jim_DecrRefCount(state->interp, state->output);
 
-       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;
+       free(state);
 }
-#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");
-       if (return_retval != NULL)
+       if (return_retval)
                *return_retval = retval;
 
        return (retval == ERROR_OK) ? JIM_OK : retval;
@@ -181,15 +138,14 @@ extern struct command_context *global_cmd_ctx;
 
 /* dump a single line to the log for the command.
  * Do nothing in case we are not at debug level 3 */
-void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv)
+static void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv)
 {
        if (debug_level < LOG_LVL_DEBUG)
                return;
 
        char *dbg = alloc_printf("command -");
        for (unsigned i = 0; i < argc; i++) {
-               int len;
-               const char *w = Jim_GetString(argv[i], &len);
+               const char *w = Jim_GetString(argv[i], NULL);
                char *t = alloc_printf("%s %s", dbg, w);
                free(dbg);
                dbg = t;
@@ -198,39 +154,11 @@ void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv)
        free(dbg);
 }
 
-static void script_command_args_free(char **words, unsigned nwords)
-{
-       for (unsigned i = 0; i < nwords; i++)
-               free(words[i]);
-       free(words);
-}
-
-static char **script_command_args_alloc(
-       unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
-{
-       char **words = malloc(argc * sizeof(char *));
-       if (NULL == words)
-               return NULL;
-
-       unsigned i;
-       for (i = 0; i < argc; i++) {
-               int len;
-               const char *w = Jim_GetString(argv[i], &len);
-               words[i] = strdup(w);
-               if (words[i] == NULL) {
-                       script_command_args_free(words, i);
-                       return NULL;
-               }
-       }
-       *nwords = i;
-       return words;
-}
-
 struct command_context *current_command_context(Jim_Interp *interp)
 {
        /* grab the command context from the associated data */
        struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
-       if (NULL == cmd_ctx) {
+       if (!cmd_ctx) {
                /* Tcl can invoke commands directly instead of via command_run_line(). This would
                 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
                 * commands in a startup script.
@@ -257,74 +185,14 @@ static struct command *command_find_from_name(Jim_Interp *interp, const char *na
        Jim_IncrRefCount(jim_name);
        Jim_Cmd *cmd = Jim_GetCommand(interp, jim_name, JIM_NONE);
        Jim_DecrRefCount(interp, jim_name);
-       if (!cmd || jimcmd_is_proc(cmd) || !jimcmd_is_ocd_command(cmd))
+       if (!cmd || jimcmd_is_proc(cmd) || !jimcmd_is_oocd_command(cmd))
                return NULL;
 
        return jimcmd_privdata(cmd);
 }
 
-/**
- * Find a command by name from a list of commands.
- * @returns Returns the named command if it exists in the list.
- * Returns NULL otherwise.
- */
-static struct command *command_find(struct command *head, const char *name)
-{
-       for (struct command *cc = head; cc; cc = cc->next) {
-               if (strcmp(cc->name, name) == 0)
-                       return cc;
-       }
-       return NULL;
-}
-
-/**
- * Add the command into the linked list, sorted by name.
- * @param head Address to head of command list pointer, which may be
- * updated if @c c gets inserted at the beginning of the list.
- * @param c The command to add to the list pointed to by @c head.
- */
-static void command_add_child(struct command **head, struct command *c)
-{
-       assert(head);
-       if (NULL == *head) {
-               *head = c;
-               return;
-       }
-
-       while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
-               head = &(*head)->next;
-
-       if (strcmp(c->name, (*head)->name) > 0) {
-               c->next = (*head)->next;
-               (*head)->next = c;
-       } else {
-               c->next = *head;
-               *head = c;
-       }
-}
-
-static struct command **command_list_for_parent(
-       struct command_context *cmd_ctx, struct command *parent)
-{
-       return parent ? &parent->children : &cmd_ctx->commands;
-}
-
-static void command_free(struct command *c)
-{
-       /** @todo if command has a handler, unregister its jim command! */
-
-       while (NULL != c->children) {
-               struct command *tmp = c->children;
-               c->children = tmp->next;
-               command_free(tmp);
-       }
-
-       free(c->name);
-       free(c);
-}
-
 static struct command *command_new(struct command_context *cmd_ctx,
-       struct command *parent, const struct command_registration *cr)
+       const char *full_name, const struct command_registration *cr)
 {
        assert(cr->name);
 
@@ -335,76 +203,87 @@ static struct command *command_new(struct command_context *cmd_ctx,
         * strlen(.usage) == 0 means that the command takes no
         * arguments.
        */
-       if ((cr->jim_handler == NULL) && (cr->usage == NULL)) {
-               LOG_ERROR("BUG: command '%s%s%s' does not have the "
+       if (!cr->jim_handler && !cr->usage)
+               LOG_ERROR("BUG: command '%s' does not have the "
                        "'.usage' field filled out",
-                       parent && parent->name ? parent->name : "",
-                       parent && parent->name ? " " : "",
-                       cr->name);
-       }
+                       full_name);
 
        struct command *c = calloc(1, sizeof(struct command));
-       if (NULL == c)
+       if (!c)
                return NULL;
 
        c->name = strdup(cr->name);
-       if (!c->name)
-               goto command_new_error;
+       if (!c->name) {
+               free(c);
+               return NULL;
+       }
 
-       c->parent = parent;
        c->handler = cr->handler;
        c->jim_handler = cr->jim_handler;
        c->mode = cr->mode;
 
-       command_add_child(command_list_for_parent(cmd_ctx, parent), c);
-
-       if (cr->help || cr->usage) {
-               char *full_name = command_name(c, ' ');
+       if (cr->help || cr->usage)
                help_add_command(cmd_ctx, full_name, cr->help, cr->usage);
-               free(full_name);
-       }
 
        return c;
+}
+
+static void command_free(struct Jim_Interp *interp, void *priv)
+{
+       struct command *c = priv;
 
-command_new_error:
-       command_free(c);
-       return NULL;
+       free(c->name);
+       free(c);
 }
 
 static struct command *register_command(struct command_context *context,
-       struct command *parent, const struct command_registration *cr)
+       const char *cmd_prefix, const struct command_registration *cr)
 {
+       char *full_name;
+
        if (!context || !cr->name)
                return NULL;
 
-       const char *name = cr->name;
-       struct command **head = command_list_for_parent(context, parent);
-       struct command *c = command_find(*head, name);
-       if (NULL != c) {
+       if (cmd_prefix)
+               full_name = alloc_printf("%s %s", cmd_prefix, cr->name);
+       else
+               full_name = strdup(cr->name);
+       if (!full_name)
+               return NULL;
+
+       struct command *c = command_find_from_name(context->interp, full_name);
+       if (c) {
                /* TODO: originally we treated attempting to register a cmd twice as an error
                 * Sometimes we need this behaviour, such as with flash banks.
                 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
-               LOG_DEBUG("command '%s' is already registered in '%s' context",
-                       name, parent ? parent->name : "<global>");
+               LOG_DEBUG("command '%s' is already registered", full_name);
+               free(full_name);
                return c;
        }
 
-       c = command_new(context, parent, cr);
-       if (NULL == c)
+       c = command_new(context, full_name, cr);
+       if (!c) {
+               free(full_name);
                return NULL;
+       }
 
-       char *full_name = command_name(c, ' ');
-       LOG_DEBUG("registering '%s'...", full_name);
+       if (false) /* too noisy with debug_level 3 */
+               LOG_DEBUG("registering '%s'...", full_name);
        int retval = Jim_CreateCommand(context->interp, full_name,
-                               command_unknown, c, NULL);
+                               jim_command_dispatch, c, command_free);
        if (retval != JIM_OK) {
-               unregister_command(context, parent, name);
+               command_run_linef(context, "del_help_text {%s}", full_name);
+               command_run_linef(context, "del_usage_text {%s}", full_name);
+               free(c);
+               free(full_name);
                return NULL;
        }
+
+       free(full_name);
        return c;
 }
 
-static int ___register_commands(struct command_context *cmd_ctx, struct command *parent,
+int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
        const struct command_registration *cmds, void *data,
        struct target *override_target)
 {
@@ -414,41 +293,42 @@ static int ___register_commands(struct command_context *cmd_ctx, struct command
                const struct command_registration *cr = cmds + i;
 
                struct command *c = NULL;
-               if (NULL != cr->name) {
-                       c = register_command(cmd_ctx, parent, cr);
-                       if (NULL == c) {
+               if (cr->name) {
+                       c = register_command(cmd_ctx, cmd_prefix, cr);
+                       if (!c) {
                                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, data, override_target);
-                       if (ERROR_OK != retval)
+               if (cr->chain) {
+                       if (cr->name) {
+                               if (cmd_prefix) {
+                                       char *new_prefix = alloc_printf("%s %s", cmd_prefix, cr->name);
+                                       if (!new_prefix) {
+                                               retval = ERROR_FAIL;
+                                               break;
+                                       }
+                                       retval = __register_commands(cmd_ctx, new_prefix, cr->chain, data, override_target);
+                                       free(new_prefix);
+                               } else {
+                                       retval = __register_commands(cmd_ctx, cr->name, cr->chain, data, override_target);
+                               }
+                       } else {
+                               retval = __register_commands(cmd_ctx, cmd_prefix, cr->chain, data, override_target);
+                       }
+                       if (retval != ERROR_OK)
                                break;
                }
        }
-       if (ERROR_OK != retval) {
+       if (retval != ERROR_OK) {
                for (unsigned j = 0; j < i; j++)
-                       unregister_command(cmd_ctx, parent, cmds[j].name);
+                       unregister_command(cmd_ctx, cmd_prefix, cmds[j].name);
        }
        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);
-}
-
 static __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)))
 int unregister_commands_match(struct command_context *cmd_ctx, const char *format, ...)
 {
@@ -486,8 +366,13 @@ int unregister_commands_match(struct command_context *cmd_ctx, const char *forma
                        Jim_DecrRefCount(interp, elem);
                        continue;
                }
-               LOG_DEBUG("delete command \"%s\"", name);
+               if (false) /* too noisy with debug_level 3 */
+                       LOG_DEBUG("delete command \"%s\"", name);
+#if JIM_VERSION >= 80
                Jim_DeleteCommand(interp, elem);
+#else
+               Jim_DeleteCommand(interp, name);
+#endif
 
                help_del_command(cmd_ctx, name);
 
@@ -501,68 +386,29 @@ int unregister_commands_match(struct command_context *cmd_ctx, const char *forma
 int unregister_all_commands(struct command_context *context,
        const char *cmd_prefix)
 {
-       struct command *parent = NULL;
-
        if (!context)
                return ERROR_OK;
 
-       if (!cmd_prefix || !*cmd_prefix) {
-               int retval = unregister_commands_match(context, "*");
-               if (retval != ERROR_OK)
-                       return retval;
-       } else {
-               Jim_Cmd *cmd = Jim_GetCommand(context->interp, Jim_NewStringObj(context->interp, cmd_prefix, -1), JIM_NONE);
-               if (cmd && jimcmd_is_ocd_command(cmd))
-                       parent = jimcmd_privdata(cmd);
-
-               int retval = unregister_commands_match(context, "%s *", cmd_prefix);
-               if (retval != ERROR_OK)
-                       return retval;
-               retval = unregister_commands_match(context, "%s", cmd_prefix);
-               if (retval != ERROR_OK)
-                       return retval;
-       }
+       if (!cmd_prefix || !*cmd_prefix)
+               return unregister_commands_match(context, "*");
 
-       struct command **head = command_list_for_parent(context, parent);
-       while (NULL != *head) {
-               struct command *tmp = *head;
-               *head = tmp->next;
-               command_free(tmp);
-       }
+       int retval = unregister_commands_match(context, "%s *", cmd_prefix);
+       if (retval != ERROR_OK)
+               return retval;
 
-       return ERROR_OK;
+       return unregister_commands_match(context, "%s", cmd_prefix);
 }
 
 static int unregister_command(struct command_context *context,
-       struct command *parent, const char *name)
+       const char *cmd_prefix, const char *name)
 {
-       if ((!context) || (!name))
+       if (!context || !name)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       struct command *p = NULL;
-       struct command **head = command_list_for_parent(context, parent);
-       for (struct command *c = *head; NULL != c; p = c, c = c->next) {
-               if (strcmp(name, c->name) != 0)
-                       continue;
-
-               char *full_name = command_name(c, ' ');
-
-               int retval = unregister_commands_match(context, "%s", full_name);
-               if (retval != ERROR_OK)
-                       return retval;
-
-               free(full_name);
-
-               if (p)
-                       p->next = c->next;
-               else
-                       *head = c->next;
-
-               command_free(c);
-               return ERROR_OK;
-       }
+       if (!cmd_prefix || !*cmd_prefix)
+               return unregister_commands_match(context, "%s", name);
 
-       return ERROR_OK;
+       return unregister_commands_match(context, "%s %s", cmd_prefix, name);
 }
 
 void command_output_text(struct command_context *context, const char *data)
@@ -579,7 +425,7 @@ void command_print_sameline(struct command_invocation *cmd, const char *format,
        va_start(ap, format);
 
        string = alloc_vprintf(format, ap);
-       if (string != NULL && cmd) {
+       if (string && cmd) {
                /* we want this collected in the log + we also want to pick it up as a tcl return
                 * value.
                 *
@@ -602,7 +448,7 @@ void command_print(struct command_invocation *cmd, const char *format, ...)
        va_start(ap, format);
 
        string = alloc_vprintf(format, ap);
-       if (string != NULL && cmd) {
+       if (string && cmd) {
                strcat(string, "\n");   /* alloc_vprintf guaranteed the buffer to be at least one
                                         *char longer */
                /* we want this collected in the log + we also want to pick it up as a tcl return
@@ -619,33 +465,6 @@ void command_print(struct command_invocation *cmd, const char *format, ...)
        va_end(ap);
 }
 
-static char *__command_name(struct command *c, char delim, unsigned extra)
-{
-       char *name;
-       unsigned len = strlen(c->name);
-       if (NULL == c->parent) {
-               /* allocate enough for the name, child names, and '\0' */
-               name = malloc(len + extra + 1);
-               if (!name) {
-                       LOG_ERROR("Out of memory");
-                       return NULL;
-               }
-               strcpy(name, c->name);
-       } else {
-               /* parent's extra must include both the space and name */
-               name = __command_name(c->parent, delim, 1 + len + extra);
-               char dstr[2] = { delim, 0 };
-               strcat(name, dstr);
-               strcat(name, c->name);
-       }
-       return name;
-}
-
-static char *command_name(struct command *c, char delim)
-{
-       return __command_name(c, delim, 0);
-}
-
 static bool command_can_run(struct command_context *cmd_ctx, struct command *c, const char *full_name)
 {
        if (c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode)
@@ -670,15 +489,29 @@ static bool command_can_run(struct command_context *cmd_ctx, struct command *c,
        return false;
 }
 
-static int run_command(struct command_context *context,
-       struct command *c, const char **words, unsigned num_words)
+static int exec_command(Jim_Interp *interp, struct command_context *context,
+               struct command *c, int argc, Jim_Obj * const *argv)
 {
+       if (c->jim_handler)
+               return c->jim_handler(interp, argc, argv);
+
+       /* use c->handler */
+       const char **words = malloc(argc * sizeof(char *));
+       if (!words) {
+               LOG_ERROR("Out of memory");
+               return JIM_ERR;
+       }
+
+       for (int i = 0; i < argc; i++)
+               words[i] = Jim_GetString(argv[i], NULL);
+
        struct command_invocation cmd = {
                .ctx = context,
                .current = c,
                .name = c->name,
-               .argc = num_words - 1,
+               .argc = argc - 1,
                .argv = words + 1,
+               .jimtcl_argv = argv + 1,
        };
 
        cmd.output = Jim_NewEmptyStringObj(context->interp);
@@ -694,12 +527,21 @@ static int run_command(struct command_context *context,
                if (retval != ERROR_OK)
                        LOG_DEBUG("Command '%s' failed with error code %d",
                                                words[0], retval);
-               /* Use the command output as the Tcl result */
-               Jim_SetResult(context->interp, cmd.output);
+               /*
+                * Use the command output as the Tcl result.
+                * Drop last '\n' to allow command output concatenation
+                * while keep using command_print() everywhere.
+                */
+               const char *output_txt = Jim_String(cmd.output);
+               int len = strlen(output_txt);
+               if (len && output_txt[len - 1] == '\n')
+                       --len;
+               Jim_SetResultString(context->interp, output_txt, len);
        }
        Jim_DecrRefCount(context->interp, cmd.output);
 
-       return retval;
+       free(words);
+       return command_retval_set(interp, retval);
 }
 
 int command_run_line(struct command_context *context, char *line)
@@ -728,7 +570,7 @@ int command_run_line(struct command_context *context, char *line)
                Jim_DeleteAssocData(interp, "retval");
                retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
                if (retcode == JIM_OK) {
-                       retcode = Jim_Eval_Named(interp, line, 0, 0);
+                       retcode = Jim_Eval_Named(interp, line, NULL, 0);
 
                        Jim_DeleteAssocData(interp, "retval");
                }
@@ -775,7 +617,7 @@ int command_run_linef(struct command_context *context, const char *format, ...)
        va_list ap;
        va_start(ap, format);
        string = alloc_vprintf(format, ap);
-       if (string != NULL) {
+       if (string) {
                retval = command_run_line(context, string);
                free(string);
        }
@@ -801,42 +643,44 @@ struct command_context *copy_command_context(struct command_context *context)
 
 void command_done(struct command_context *cmd_ctx)
 {
-       if (NULL == cmd_ctx)
+       if (!cmd_ctx)
                return;
 
        free(cmd_ctx);
 }
 
 /* find full path to file */
-static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+COMMAND_HANDLER(handle_find)
 {
-       if (argc != 2)
-               return JIM_ERR;
-       const char *file = Jim_GetString(argv[1], NULL);
-       char *full_path = find_file(file);
-       if (full_path == NULL)
-               return JIM_ERR;
-       Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       char *full_path = find_file(CMD_ARGV[0]);
+       if (!full_path)
+               return ERROR_COMMAND_ARGUMENT_INVALID;
+
+       command_print(CMD, "%s", full_path);
        free(full_path);
 
-       Jim_SetResult(interp, result);
-       return JIM_OK;
+       return ERROR_OK;
 }
 
-COMMAND_HANDLER(jim_echo)
+COMMAND_HANDLER(handle_echo)
 {
        if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) {
                LOG_USER_N("%s", CMD_ARGV[1]);
-               return JIM_OK;
+               return ERROR_OK;
        }
+
        if (CMD_ARGC != 1)
-               return JIM_ERR;
+               return ERROR_FAIL;
+
        LOG_USER("%s", CMD_ARGV[0]);
-       return JIM_OK;
+       return ERROR_OK;
 }
 
-/* Capture progress output and return as tcl return value. If the
- * progress output was empty, return tcl return value.
+/* Return both the progress output (LOG_INFO and higher)
+ * and the tcl return value of a command.
  */
 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
@@ -851,14 +695,12 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
         * This is necessary in order to avoid accidentally getting a non-empty
         * string for tcl fn's.
         */
-       bool save_poll = jtag_poll_get_enabled();
-
-       jtag_poll_set_enabled(false);
+       bool save_poll_mask = jtag_poll_mask();
 
        const char *str = Jim_GetString(argv[1], NULL);
        int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
 
-       jtag_poll_set_enabled(save_poll);
+       jtag_poll_unmask(save_poll_mask);
 
        command_log_capture_finish(state);
 
@@ -920,19 +762,18 @@ static COMMAND_HELPER(command_help_show, struct help_entry *c,
 
        /* If the match string occurs anywhere, we print out
         * stuff for this command. */
-       bool is_match = (strstr(c->cmd_name, cmd_match) != NULL) ||
-               ((c->usage != NULL) && (strstr(c->usage, cmd_match) != NULL)) ||
-               ((c->help != NULL) && (strstr(c->help, cmd_match) != NULL));
+       bool is_match = strstr(c->cmd_name, cmd_match) ||
+               (c->usage && strstr(c->usage, cmd_match)) ||
+               (c->help && strstr(c->help, cmd_match));
 
        if (is_match) {
-               command_help_show_indent(n);
-               LOG_USER_N("%s", c->cmd_name);
-
                if (c->usage && strlen(c->usage) > 0) {
-                       LOG_USER_N(" ");
-                       command_help_show_wrap(c->usage, 0, n + 5);
-               } else
-                       LOG_USER_N("\n");
+                       char *msg = alloc_printf("%s %s", c->cmd_name, c->usage);
+                       command_help_show_wrap(msg, n, n + 5);
+                       free(msg);
+               } else {
+                       command_help_show_wrap(c->cmd_name, n, n + 5);
+               }
        }
 
        if (is_match && show_help) {
@@ -972,11 +813,11 @@ static COMMAND_HELPER(command_help_show, struct help_entry *c,
                                        stage_msg = " (?mode error?)";
                                        break;
                        }
-                       msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
+                       msg = alloc_printf("%s%s", c->help ? c->help : "", stage_msg);
                } else
-                       msg = alloc_printf("%s", c->help ? : "");
+                       msg = alloc_printf("%s", c->help ? c->help : "");
 
-               if (NULL != msg) {
+               if (msg) {
                        command_help_show_wrap(msg, n + 3, n + 3);
                        free(msg);
                } else
@@ -1005,7 +846,7 @@ COMMAND_HANDLER(handle_help_command)
                }
        }
 
-       if (cmd_match == NULL) {
+       if (!cmd_match) {
                LOG_ERROR("unable to build search string");
                return -ENOMEM;
        }
@@ -1041,27 +882,8 @@ static char *alloc_concatenate_strings(int argc, Jim_Obj * const *argv)
        return all;
 }
 
-static int exec_command(Jim_Interp *interp, struct command_context *cmd_ctx,
-               struct command *c, int argc, Jim_Obj * const *argv)
+static int jim_command_dispatch(Jim_Interp *interp, 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);
-
        /* check subcommands */
        if (argc > 1) {
                char *s = alloc_printf("%s %s", Jim_GetString(argv[0], NULL), Jim_GetString(argv[1], NULL));
@@ -1077,6 +899,8 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                Jim_DecrRefCount(interp, js);
        }
 
+       script_debug(interp, argc, argv);
+
        struct command *c = jim_to_command(interp);
        if (!c->jim_handler && !c->handler) {
                Jim_EvalObjPrefix(interp, Jim_NewStringObj(interp, "usage", -1), 1, argv);
@@ -1088,7 +912,7 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        if (!command_can_run(cmd_ctx, c, Jim_GetString(argv[0], NULL)))
                return JIM_ERR;
 
-       target_call_timer_callbacks_now();
+       target_call_timer_callbacks();
 
        /*
         * Black magic of overridden current target:
@@ -1098,7 +922,7 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
         * 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.
+        * correct work when jim_command_dispatch() is re-entered.
         */
        struct target *saved_target_override = cmd_ctx->current_target_override;
        if (c->jim_override_target)
@@ -1126,7 +950,7 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                Jim_Cmd *cmd = Jim_GetCommand(interp, s, JIM_NONE);
                Jim_DecrRefCount(interp, s);
                free(full_name);
-               if (!cmd || !(jimcmd_is_proc(cmd) || jimcmd_is_ocd_command(cmd))) {
+               if (!cmd || !(jimcmd_is_proc(cmd) || jimcmd_is_oocd_command(cmd))) {
                        Jim_SetResultString(interp, "unknown", -1);
                        return JIM_OK;
                }
@@ -1277,13 +1101,14 @@ COMMAND_HANDLER(handle_sleep_command)
 
        unsigned long duration = 0;
        int retval = parse_ulong(CMD_ARGV[0], &duration);
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return retval;
 
        if (!busy) {
                int64_t then = timeval_ms();
                while (timeval_ms() - then < (int64_t)duration) {
                        target_call_timer_callbacks_now();
+                       keep_alive();
                        usleep(1000);
                }
        } else
@@ -1311,7 +1136,7 @@ static const struct command_registration command_builtin_handlers[] = {
        {
                .name = "ocd_find",
                .mode = COMMAND_ANY,
-               .jim_handler = jim_find,
+               .handler = handle_find,
                .help = "find full path to file",
                .usage = "file",
        },
@@ -1325,10 +1150,9 @@ static const struct command_registration command_builtin_handlers[] = {
        },
        {
                .name = "echo",
-               .handler = jim_echo,
+               .handler = handle_echo,
                .mode = COMMAND_ANY,
                .help = "Logs a message at \"user\" priority. "
-                       "Output message to stdout. "
                        "Option \"-n\" suppresses trailing newline",
                .usage = "[-n] string",
        },
@@ -1385,7 +1209,6 @@ static const struct command_registration command_builtin_handlers[] = {
 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
 {
        struct command_context *context = calloc(1, sizeof(struct command_context));
-       const char *HostOs;
 
        context->mode = COMMAND_EXEC;
 
@@ -1394,7 +1217,7 @@ struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp
        INIT_LIST_HEAD(context->help_list);
 
        /* Create a jim interpreter if we were not handed one */
-       if (interp == NULL) {
+       if (!interp) {
                /* Create an interpreter */
                interp = Jim_CreateInterp();
                /* Add all the Jim core commands */
@@ -1404,39 +1227,6 @@ struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp
 
        context->interp = interp;
 
-       /* Stick to lowercase for HostOS strings. */
-#if defined(_MSC_VER)
-       /* WinXX - is generic, the forward
-        * looking problem is this:
-        *
-        *   "win32" or "win64"
-        *
-        * "winxx" is generic.
-        */
-       HostOs = "winxx";
-#elif defined(__linux__)
-       HostOs = "linux";
-#elif defined(__APPLE__) || defined(__DARWIN__)
-       HostOs = "darwin";
-#elif defined(__CYGWIN__)
-       HostOs = "cygwin";
-#elif defined(__MINGW32__)
-       HostOs = "mingw32";
-#elif defined(__ECOS)
-       HostOs = "ecos";
-#elif defined(__FreeBSD__)
-       HostOs = "freebsd";
-#elif defined(__NetBSD__)
-       HostOs = "netbsd";
-#elif defined(__OpenBSD__)
-       HostOs = "openbsd";
-#else
-#warning "Unrecognized host OS..."
-       HostOs = "other";
-#endif
-       Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
-               Jim_NewStringObj(interp, HostOs, strlen(HostOs)));
-
        register_commands(context, NULL, command_builtin_handlers);
 
        Jim_SetAssocData(interp, "context", NULL, context);
@@ -1495,11 +1285,11 @@ void process_jim_events(struct command_context *cmd_ctx)
                        LOG_ERROR("Invalid command argument"); \
                        return ERROR_COMMAND_ARGUMENT_INVALID; \
                } \
-               if ((max == *ul) && (ERANGE == errno)) { \
+               if ((max == *ul) && (errno == ERANGE)) { \
                        LOG_ERROR("Argument overflow"); \
                        return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
                } \
-               if (min && (min == *ul) && (ERANGE == errno)) { \
+               if (min && (min == *ul) && (errno == ERANGE)) { \
                        LOG_ERROR("Argument underflow"); \
                        return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
                } \
@@ -1515,7 +1305,7 @@ DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
        { \
                functype n; \
                int retval = parse ## funcname(str, &n); \
-               if (ERROR_OK != retval) \
+               if (retval != ERROR_OK) \
                        return retval; \
                if (n > max) \
                        return ERROR_COMMAND_ARGUMENT_OVERFLOW; \

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)