command: fix leak when executing commands
[openocd.git] / src / helper / command.c
index 3625508f26b584afc09177dd19e391623ccdff34..b00a231268cb7fb77f47a2c7dc6b7261e0707e31 100644 (file)
@@ -36,6 +36,7 @@
 #endif
 
 // @todo the inclusion of target.h here is a layering violation
+#include <jtag/jtag.h>
 #include <target/target.h>
 #include "command.h"
 #include "configuration.h"
@@ -84,14 +85,36 @@ static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
        return state;
 }
 
-static void command_log_capture_finish(struct log_capture_state *state)
+/* Classic openocd commands provide progress output which we
+ * will capture and return as a Tcl return value.
+ *
+ * However, if a non-openocd command has been invoked, then it
+ * makes sense to return the tcl return value from that command.
+ *
+ * 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.
+ */
+static void command_log_capture_finish(struct log_capture_state *state) 
 {
        if (NULL == state)
                return;
 
        log_remove_callback(tcl_output, state);
 
-       Jim_SetResult(state->interp, state->output);
+       int length;
+       Jim_GetString(state->output, &length);
+
+       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);
 
        free(state);
@@ -121,11 +144,6 @@ void script_debug(Jim_Interp *interp, const char *name,
        {
                int len;
                const char *w = Jim_GetString(argv[i], &len);
-
-               /* end of line comment? */
-               if (*w == '#')
-                       break;
-
                char * t = alloc_printf("%s %s", dbg, w);
                free (dbg);
                dbg = t;
@@ -152,10 +170,6 @@ static const char **script_command_args_alloc(
        {
                int len;
                const char *w = Jim_GetString(argv[i], &len);
-               /* a comment may end the line early */
-               if (*w == '#')
-                       break;
-
                words[i] = strdup(w);
                if (words[i] == NULL)
                {
@@ -167,14 +181,18 @@ static const char **script_command_args_alloc(
        return words;
 }
 
-static struct command_context *current_command_context(Jim_Interp *interp)
+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)
        {
                /* Tcl can invoke commands directly instead of via command_run_line(). This would
-                * happen when the Jim Tcl interpreter is provided by eCos.
+                * happen when the Jim Tcl interpreter is provided by eCos or if we are running
+                * commands in a startup script.
+                *
+                * A telnet or gdb server would provide a non-default command context to
+                * handle piping of error output, have a separate current target, etc.
                 */
                cmd_ctx = global_cmd_ctx;
        }
@@ -292,7 +310,7 @@ static void command_free(struct command *c)
        }
 
        if (c->name)
-               free(c->name);
+               free((void *)c->name);
        if (c->help)
                free((void*)c->help);
        if (c->usage)
@@ -358,7 +376,7 @@ static int register_command_handler(struct command_context *cmd_ctx,
        if (NULL == override_name)
                return JIM_ERR;
 
-       retval = Jim_Eval_Named(interp, override_name, __THIS__FILE__ , __LINE__);
+       retval = Jim_Eval_Named(interp, override_name, 0, 0);
        free((void *)override_name);
 
        return retval;
@@ -647,7 +665,7 @@ int command_run_line(struct command_context *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, 0, 0);
 
                        Jim_DeleteAssocData(interp, "retval");
                }
@@ -657,7 +675,8 @@ int command_run_line(struct command_context *context, char *line)
                if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
                {
                        /* We do not print the connection closed error message */
-                       Jim_PrintErrorMessage(interp);
+                       Jim_MakeErrorMessage(interp);
+                       LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
                }
                if (retval == ERROR_OK)
                {
@@ -687,7 +706,7 @@ int command_run_line(struct command_context *context, char *line)
                                buff[chunk] = 0;
                                LOG_USER_N("%s", buff);
                        }
-                       LOG_USER_N("%s", "\n");
+                       LOG_USER_N("\n");
                }
                retval = ERROR_OK;
        }
@@ -704,6 +723,7 @@ int command_run_linef(struct command_context *context, const char *format, ...)
        if (string != NULL)
        {
                retval = command_run_line(context, string);
+               free(string);
        }
        va_end(ap);
        return retval;
@@ -749,98 +769,22 @@ static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        return JIM_OK;
 }
 
-static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
-       if (argc != 2)
-               return JIM_ERR;
-       const char *str = Jim_GetString(argv[1], NULL);
-       LOG_USER("%s", str);
-       return JIM_OK;
-}
-
-static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
-{
-       size_t nbytes;
-       const char *ptr;
-       Jim_Interp *interp;
-
-       /* make it a char easier to read code */
-       ptr = _ptr;
-       interp = cookie;
-       nbytes = size * n;
-       if (ptr == NULL || interp == NULL || nbytes == 0) {
-               return 0;
-       }
-
-       /* do we have to chunk it? */
-       if (ptr[nbytes] == 0)
-       {
-               /* no it is a C style string */
-               LOG_USER_N("%s", ptr);
-               return strlen(ptr);
-       }
-       /* GRR we must chunk - not null terminated */
-       while (nbytes) {
-               char chunk[128 + 1];
-               int x;
-
-               x = nbytes;
-               if (x > 128) {
-                       x = 128;
-               }
-               /* copy it */
-               memcpy(chunk, ptr, x);
-               /* terminate it */
-               chunk[n] = 0;
-               /* output it */
-               LOG_USER_N("%s", chunk);
-               ptr += x;
-               nbytes -= x;
-       }
-
-       return n;
-}
-
-static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
+COMMAND_HANDLER(jim_echo)
 {
-       /* TCL wants to read... tell him no */
-       return 0;
-}
-
-static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
-{
-       char *cp;
-       int n;
-       Jim_Interp *interp;
-
-       n = -1;
-       interp = cookie;
-       if (interp == NULL)
-               return n;
-
-       cp = alloc_vprintf(fmt, ap);
-       if (cp)
+       if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n"))
        {
-               LOG_USER_N("%s", cp);
-               n = strlen(cp);
-               free(cp);
+               LOG_USER_N("%s", CMD_ARGV[1]);
+               return JIM_OK;
        }
-       return n;
-}
-
-static int openocd_jim_fflush(void *cookie)
-{
-       /* nothing to flush */
-       return 0;
-}
-
-static char* openocd_jim_fgets(char *s, int size, void *cookie)
-{
-       /* not supported */
-       errno = ENOTSUP;
-       return NULL;
+       if (CMD_ARGC != 1)
+               return JIM_ERR;
+       LOG_USER("%s", CMD_ARGV[0]);
+       return JIM_OK;
 }
 
+/* Capture progress output and return as tcl return value. If the
+ * progress output was empty, return tcl return value.
+ */
 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        if (argc != 2)
@@ -848,9 +792,21 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
        struct log_capture_state *state = command_log_capture_start(interp);
 
+       /* disable polling during capture. This avoids capturing output
+        * from polling.
+        *
+        * This is necessary in order to avoid accidentially getting a non-empty
+        * string for tcl fn's.
+        */
+       bool save_poll = jtag_poll_get_enabled();
+
+       jtag_poll_set_enabled(false);
+
        const char *str = Jim_GetString(argv[1], NULL);
        int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
 
+       jtag_poll_set_enabled(save_poll);
+
        command_log_capture_finish(state);
 
        return retcode;
@@ -905,8 +861,7 @@ static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
                if (next - last < HELP_LINE_WIDTH(n))
                        cp = next;
                command_help_show_indent(n);
-               LOG_USER_N("%.*s", (int)(cp - last), last);
-               LOG_USER_N("\n");
+               LOG_USER("%.*s", (int)(cp - last), last);
                last = cp + 1;
                n = n2;
        }
@@ -914,9 +869,6 @@ static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
                bool show_help, const char *match)
 {
-       if (!command_can_run(CMD_CTX, c))
-               return ERROR_OK;
-
        char *cmd_name = command_name(c, ' ');
        if (NULL == cmd_name)
                return -ENOMEM;
@@ -1297,6 +1249,15 @@ static const struct command_registration command_subcommand_handlers[] = {
 };
 
 static const struct command_registration command_builtin_handlers[] = {
+       {
+               .name = "echo",
+               .handler = jim_echo,
+               .mode = COMMAND_ANY,
+               .help = "Logs a message at \"user\" priority. "
+                       "Output message to stdout. "
+                       "Option \"-n\" suppresses trailing newline",
+               .usage = "[-n] string",
+       },
        {
                .name = "add_help_text",
                .handler = handle_help_add_command,
@@ -1361,11 +1322,11 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp
        /* Create a jim interpreter if we were not handed one */
        if (interp == NULL)
        {
-               Jim_InitEmbedded();
                /* Create an interpreter */
                interp = Jim_CreateInterp();
                /* Add all the Jim core commands */
                Jim_RegisterCoreCommands(interp);
+               Jim_InitStaticExtensions(interp);
        }
 #endif
        context->interp = interp;
@@ -1400,29 +1361,16 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp
                        Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
 
        Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
-       Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
        Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
 
-       /* Set Jim's STDIO */
-       interp->cookie_stdin = interp;
-       interp->cookie_stdout = interp;
-       interp->cookie_stderr = interp;
-       interp->cb_fwrite = openocd_jim_fwrite;
-       interp->cb_fread = openocd_jim_fread ;
-       interp->cb_vfprintf = openocd_jim_vfprintf;
-       interp->cb_fflush = openocd_jim_fflush;
-       interp->cb_fgets = openocd_jim_fgets;
-
        register_commands(context, NULL, command_builtin_handlers);
 
-#if !BUILD_ECOSBOARD
-       Jim_EventLoopOnLoad(interp);
-#endif
        Jim_SetAssocData(interp, "context", NULL, context);
        if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
        {
                LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
-               Jim_PrintErrorMessage(interp);
+               Jim_MakeErrorMessage(interp);
+               LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
                exit(-1);
        }
        Jim_DeleteAssocData(interp, "context");

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)