X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=3b531807f3dd1aba1d0364aaf6278c84d7982905;hb=aacc26559e4984b649083ac046db2cbcb54e2f70;hp=046f9d8a3860214e08c82957e61f2753ae15277a;hpb=0e4dee1164005f97f6fe98b38f65917b178f8492;p=openocd.git
diff --git a/src/helper/command.c b/src/helper/command.c
index 046f9d8a38..3b531807f3 100644
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -22,9 +22,7 @@
* 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, write to the *
- * Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * along with this program. If not, see . *
***************************************************************************/
#ifdef HAVE_CONFIG_H
@@ -46,18 +44,28 @@
/* 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;
};
+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 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);
+
+/* wrap jimtcl internal data */
+static inline bool jimcmd_is_proc(Jim_Cmd *cmd)
+{
+ return cmd->isproc;
+}
+
static void tcl_output(void *privData, const char *file, unsigned line,
const char *function, const char *string)
{
- struct log_capture_state *state = (struct log_capture_state *)privData;
+ struct log_capture_state *state = privData;
Jim_AppendString(state->interp, state->output, string, strlen(string));
}
@@ -115,26 +123,59 @@ 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");
if (return_retval != NULL)
*return_retval = retval;
- return (retval == ERROR_OK) ? JIM_OK : JIM_ERR;
+ return (retval == ERROR_OK) ? JIM_OK : retval;
}
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, const char *name,
- unsigned argc, Jim_Obj * const *argv)
+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 - %s", name);
+ char *dbg = alloc_printf("command -");
for (unsigned i = 0; i < argc; i++) {
int len;
const char *w = Jim_GetString(argv[i], &len);
@@ -146,17 +187,17 @@ void script_debug(Jim_Interp *interp, const char *name,
free(dbg);
}
-static void script_command_args_free(const char **words, unsigned nwords)
+static void script_command_args_free(char **words, unsigned nwords)
{
for (unsigned i = 0; i < nwords; i++)
- free((void *)words[i]);
+ free(words[i]);
free(words);
}
-static const char **script_command_args_alloc(
+static char **script_command_args_alloc(
unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
{
- const char **words = malloc(argc * sizeof(char *));
+ char **words = malloc(argc * sizeof(char *));
if (NULL == words)
return NULL;
@@ -191,40 +232,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, bool capture)
-{
- target_call_timer_callbacks_now();
- LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
-
- unsigned nwords;
- const char **words = script_command_args_alloc(argc, argv, &nwords);
- if (NULL == words)
- return JIM_ERR;
-
- struct log_capture_state *state = NULL;
- if (capture)
- state = command_log_capture_start(interp);
-
- struct command_context *cmd_ctx = current_command_context(interp);
- int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
-
- command_log_capture_finish(state);
-
- 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, c->name, argc, argv);
- return script_command_run(interp, argc, argv, c, true);
-}
-
static struct command *command_root(struct command *c)
{
while (NULL != c->parent)
@@ -246,17 +253,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);
-}
-struct command *command_find_in_parent(struct command *parent,
- const char *name)
-{
- return command_find(parent->children, name);
-}
-
/**
* Add the command into the linked list, sorted by name.
* @param head Address to head of command list pointer, which may be
@@ -299,12 +295,7 @@ static void command_free(struct command *c)
command_free(tmp);
}
- if (c->name)
- free((void *)c->name);
- if (c->help)
- free((void *)c->help);
- if (c->usage)
- free((void *)c->usage);
+ free(c->name);
free(c);
}
@@ -321,7 +312,7 @@ static struct command *command_new(struct command_context *cmd_ctx,
* arguments.
*/
if ((cr->jim_handler == NULL) && (cr->usage == NULL)) {
- LOG_DEBUG("BUG: command '%s%s%s' does not have the "
+ LOG_ERROR("BUG: command '%s%s%s' does not have the "
"'.usage' field filled out",
parent && parent->name ? parent->name : "",
parent && parent->name ? " " : "",
@@ -333,22 +324,22 @@ static struct command *command_new(struct command_context *cmd_ctx,
return NULL;
c->name = strdup(cr->name);
- if (cr->help)
- c->help = strdup(cr->help);
- if (cr->usage)
- c->usage = strdup(cr->usage);
-
- if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
+ if (!c->name)
goto command_new_error;
c->parent = parent;
c->handler = cr->handler;
c->jim_handler = cr->jim_handler;
- c->jim_handler_data = cr->jim_handler_data;
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, ' ');
+ help_add_command(cmd_ctx, full_name, cr->help, cr->usage);
+ free(full_name);
+ }
+
return c;
command_new_error:
@@ -362,32 +353,15 @@ static int register_command_handler(struct command_context *cmd_ctx,
struct command *c)
{
Jim_Interp *interp = cmd_ctx->interp;
- const char *ocd_name = alloc_printf("ocd_%s", c->name);
- if (NULL == ocd_name)
- return JIM_ERR;
-
- LOG_DEBUG("registering '%s'...", ocd_name);
-
- Jim_CmdProc func = c->handler ? &script_command : &command_unknown;
- int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
- free((void *)ocd_name);
- if (JIM_OK != retval)
- return retval;
-
- /* we now need to add an overrideable proc */
- const char *override_name = alloc_printf(
- "proc %s {args} {eval ocd_bouncer %s $args}",
- c->name, c->name);
- if (NULL == override_name)
- return JIM_ERR;
- retval = Jim_Eval_Named(interp, override_name, 0, 0);
- free((void *)override_name);
+#if 0
+ LOG_DEBUG("registering '%s'...", c->name);
+#endif
- return retval;
+ return Jim_CreateCommand(interp, c->name, command_unknown, c, NULL);
}
-struct command *register_command(struct command_context *context,
+static struct command *register_command(struct command_context *context,
struct command *parent, const struct command_registration *cr)
{
if (!context || !cr->name)
@@ -409,22 +383,19 @@ struct command *register_command(struct command_context *context,
if (NULL == c)
return NULL;
- int retval = ERROR_OK;
- if (NULL != cr->jim_handler && NULL == parent) {
- retval = Jim_CreateCommand(context->interp, cr->name,
- cr->jim_handler, cr->jim_handler_data, NULL);
- } else if (NULL != cr->handler || NULL != parent)
- retval = register_command_handler(context, command_root(c));
-
- if (ERROR_OK != retval) {
- 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;
@@ -438,10 +409,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;
}
@@ -453,6 +426,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)
{
@@ -469,7 +454,7 @@ int unregister_all_commands(struct command_context *context,
return ERROR_OK;
}
-int unregister_command(struct command_context *context,
+static int unregister_command(struct command_context *context,
struct command *parent, const char *name)
{
if ((!context) || (!name))
@@ -481,6 +466,10 @@ int unregister_command(struct command_context *context,
if (strcmp(name, c->name) != 0)
continue;
+ char *full_name = command_name(c, ' ');
+ help_del_command(context, full_name);
+ free(full_name);
+
if (p)
p->next = c->next;
else
@@ -493,21 +482,13 @@ 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)
context->output_handler(context, data);
}
-void command_print_sameline(struct command_context *context, const char *format, ...)
+void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
{
char *string;
@@ -515,13 +496,13 @@ void command_print_sameline(struct command_context *context, const char *format,
va_start(ap, format);
string = alloc_vprintf(format, ap);
- if (string != NULL) {
+ if (string != NULL && cmd) {
/* we want this collected in the log + we also want to pick it up as a tcl return
* value.
*
* The latter bit isn't precisely neat, but will do for now.
*/
- LOG_USER_N("%s", string);
+ Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
/* We already printed it above
* command_output_text(context, string); */
free(string);
@@ -530,7 +511,7 @@ void command_print_sameline(struct command_context *context, const char *format,
va_end(ap);
}
-void command_print(struct command_context *context, const char *format, ...)
+void command_print(struct command_invocation *cmd, const char *format, ...)
{
char *string;
@@ -538,7 +519,7 @@ void command_print(struct command_context *context, const char *format, ...)
va_start(ap, format);
string = alloc_vprintf(format, ap);
- if (string != NULL) {
+ if (string != NULL && 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
@@ -546,7 +527,7 @@ void command_print(struct command_context *context, const char *format, ...)
*
* The latter bit isn't precisely neat, but will do for now.
*/
- LOG_USER_N("%s", string);
+ Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
/* We already printed it above
* command_output_text(context, string); */
free(string);
@@ -562,6 +543,10 @@ static char *__command_name(struct command *c, char delim, unsigned extra)
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 */
@@ -573,39 +558,40 @@ static char *__command_name(struct command *c, char delim, unsigned extra)
return name;
}
-char *command_name(struct command *c, char delim)
+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)
{
- return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
+ if (c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode)
+ return true;
+
+ /* Many commands may be run only before/after 'init' */
+ const char *when;
+ switch (c->mode) {
+ case COMMAND_CONFIG:
+ when = "before";
+ break;
+ case COMMAND_EXEC:
+ when = "after";
+ break;
+ /* handle the impossible with humor; it guarantees a bug report! */
+ default:
+ when = "if Cthulhu is summoned by";
+ break;
+ }
+ char *full_name = command_name(c, ' ');
+ LOG_ERROR("The '%s' command must be used %s 'init'.",
+ full_name ? full_name : c->name, when);
+ free(full_name);
+ return false;
}
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)) {
- /* Many commands may be run only before/after 'init' */
- const char *when;
- switch (c->mode) {
- case COMMAND_CONFIG:
- when = "before";
- break;
- case COMMAND_EXEC:
- when = "after";
- break;
- /* handle the impossible with humor; it guarantees a bug report! */
- default:
- when = "if Cthulhu is summoned by";
- break;
- }
- LOG_ERROR("The '%s' command must be used %s 'init'.",
- c->name, when);
- return ERROR_FAIL;
- }
-
struct command_invocation cmd = {
.ctx = context,
.current = c,
@@ -613,6 +599,10 @@ static int run_command(struct command_context *context,
.argc = num_words - 1,
.argv = words + 1,
};
+
+ cmd.output = Jim_NewEmptyStringObj(context->interp);
+ Jim_IncrRefCount(cmd.output);
+
int retval = c->handler(&cmd);
if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
/* Print help for command */
@@ -620,16 +610,20 @@ static int run_command(struct command_context *context,
if (NULL != full_name) {
command_run_linef(context, "usage %s", full_name);
free(full_name);
- } else
- retval = -ENOMEM;
+ }
} else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) {
/* just fall through for a shutdown request */
- } else if (retval != ERROR_OK) {
- /* we do not print out an error message because the command *should*
- * have printed out an error
- */
- LOG_DEBUG("Command failed with error code %d", retval);
+ } else {
+ if (retval != ERROR_OK) {
+ char *full_name = command_name(c, ' ');
+ LOG_DEBUG("Command '%s' failed with error code %d",
+ full_name ? full_name : c->name, retval);
+ free(full_name);
+ }
+ /* Use the command output as the Tcl result */
+ Jim_SetResult(context->interp, cmd.output);
}
+ Jim_DecrRefCount(context->interp, cmd.output);
return retval;
}
@@ -648,7 +642,11 @@ int command_run_line(struct command_context *context, char *line)
* happen when the Jim Tcl interpreter is provided by eCos for
* instance.
*/
+ struct target *saved_target_override = context->current_target_override;
+ context->current_target_override = NULL;
+
Jim_Interp *interp = context->interp;
+ struct command_context *old_context = Jim_GetAssocData(interp, "context");
Jim_DeleteAssocData(interp, "context");
retcode = Jim_SetAssocData(interp, "context", NULL, context);
if (retcode == JIM_OK) {
@@ -661,42 +659,38 @@ int command_run_line(struct command_context *context, char *line)
Jim_DeleteAssocData(interp, "retval");
}
Jim_DeleteAssocData(interp, "context");
+ int inner_retcode = Jim_SetAssocData(interp, "context", NULL, old_context);
+ if (retcode == JIM_OK)
+ retcode = inner_retcode;
}
- if (retcode == JIM_ERR) {
- if (retval != ERROR_COMMAND_CLOSE_CONNECTION) {
- /* We do not print the connection closed error message */
- Jim_MakeErrorMessage(interp);
- LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
- }
- if (retval == ERROR_OK) {
- /* It wasn't a low level OpenOCD command that failed */
- return ERROR_FAIL;
- }
- return retval;
- } else if (retcode == JIM_EXIT) {
- /* ignore.
- * exit(Jim_GetExitCode(interp)); */
- } else {
+ context->current_target_override = saved_target_override;
+ if (retcode == JIM_OK) {
const char *result;
int reslen;
result = Jim_GetString(Jim_GetResult(interp), &reslen);
if (reslen > 0) {
- int i;
- 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);
- buff[chunk] = 0;
- LOG_USER_N("%s", buff);
- }
- LOG_USER_N("\n");
+ command_output_text(context, result);
+ command_output_text(context, "\n");
}
retval = ERROR_OK;
+ } else if (retcode == JIM_EXIT) {
+ /* ignore.
+ * exit(Jim_GetExitCode(interp)); */
+ } else if (retcode == ERROR_COMMAND_CLOSE_CONNECTION) {
+ return retcode;
+ } else {
+ Jim_MakeErrorMessage(interp);
+ /* error is broadcast */
+ LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
+
+ if (retval == ERROR_OK) {
+ /* It wasn't a low level OpenOCD command that failed */
+ return ERROR_FAIL;
+ }
+ return retval;
}
+
return retval;
}
@@ -797,30 +791,22 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
return retcode;
}
-static COMMAND_HELPER(command_help_find, struct command *head,
- struct command **out)
-{
- if (0 == CMD_ARGC)
- return ERROR_COMMAND_SYNTAX_ERROR;
- *out = command_find(head, CMD_ARGV[0]);
- if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
- *out = command_find(head, CMD_ARGV[0] + 4);
- if (NULL == *out)
- return ERROR_COMMAND_SYNTAX_ERROR;
- if (--CMD_ARGC == 0)
- return ERROR_OK;
- CMD_ARGV++;
- return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
-}
+struct help_entry {
+ struct list_head lh;
+ char *cmd_name;
+ char *help;
+ char *usage;
+};
-static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
- bool show_help, const char *match);
+static COMMAND_HELPER(command_help_show, struct help_entry *c,
+ bool show_help, const char *cmd_match);
-static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
- bool show_help, const char *match)
+static COMMAND_HELPER(command_help_show_list, bool show_help, const char *cmd_match)
{
- for (struct command *c = head; NULL != c; c = c->next)
- CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match);
+ struct help_entry *entry;
+
+ list_for_each_entry(entry, CMD_CTX->help_list, lh)
+ CALL_COMMAND_HANDLER(command_help_show, entry, show_help, cmd_match);
return ERROR_OK;
}
@@ -851,27 +837,24 @@ 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)
+static COMMAND_HELPER(command_help_show, struct help_entry *c,
+ bool show_help, const char *cmd_match)
{
- char *cmd_name = command_name(c, ' ');
- if (NULL == cmd_name)
- return -ENOMEM;
+ unsigned int n = 0;
+ for (const char *s = strchr(c->cmd_name, ' '); s; s = strchr(s + 1, ' '))
+ n++;
/* If the match string occurs anywhere, we print out
* stuff for this command. */
- bool is_match = (strstr(cmd_name, match) != NULL) ||
- ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) ||
- ((c->help != NULL) && (strstr(c->help, match) != NULL));
+ 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));
if (is_match) {
command_help_show_indent(n);
- LOG_USER_N("%s", cmd_name);
- }
- free(cmd_name);
+ LOG_USER_N("%s", c->cmd_name);
- if (is_match) {
- if (c->usage) {
+ if (c->usage && strlen(c->usage) > 0) {
LOG_USER_N(" ");
command_help_show_wrap(c->usage, 0, n + 5);
} else
@@ -881,11 +864,30 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
if (is_match && show_help) {
char *msg;
+ /* TODO: factorize jim_command_mode() to avoid running jim command here */
+ char *request = alloc_printf("command mode %s", c->cmd_name);
+ if (!request) {
+ LOG_ERROR("Out of memory");
+ return ERROR_FAIL;
+ }
+ int retval = Jim_Eval(CMD_CTX->interp, request);
+ free(request);
+ enum command_mode mode = COMMAND_UNKNOWN;
+ if (retval != JIM_ERR) {
+ const char *result = Jim_GetString(Jim_GetResult(CMD_CTX->interp), NULL);
+ if (!strcmp(result, "any"))
+ mode = COMMAND_ANY;
+ else if (!strcmp(result, "config"))
+ mode = COMMAND_CONFIG;
+ else if (!strcmp(result, "exec"))
+ mode = COMMAND_EXEC;
+ }
+
/* Normal commands are runtime-only; highlight exceptions */
- if (c->mode != COMMAND_EXEC) {
+ if (mode != COMMAND_EXEC) {
const char *stage_msg = "";
- switch (c->mode) {
+ switch (mode) {
case COMMAND_CONFIG:
stage_msg = " (configuration command)";
break;
@@ -907,85 +909,134 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
return -ENOMEM;
}
- if (++n > 5) {
- LOG_ERROR("command recursion exceeded");
- return ERROR_FAIL;
- }
-
- return CALL_COMMAND_HANDLER(command_help_show_list,
- c->children, n, show_help, match);
+ return ERROR_OK;
}
COMMAND_HANDLER(handle_help_command)
{
bool full = strcmp(CMD_NAME, "help") == 0;
int retval;
- struct command *c = CMD_CTX->commands;
- char *match = NULL;
-
- if (CMD_ARGC == 0)
- match = "";
- else if (CMD_ARGC >= 1) {
- unsigned i;
-
- for (i = 0; i < CMD_ARGC; ++i) {
- if (NULL != match) {
- char *prev = match;
-
- match = alloc_printf("%s %s", match, CMD_ARGV[i]);
- free(prev);
- if (NULL == match) {
- LOG_ERROR("unable to build search string");
- return -ENOMEM;
- }
- } else {
- match = alloc_printf("%s", CMD_ARGV[i]);
- if (NULL == 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;
+ }
- retval = CALL_COMMAND_HANDLER(command_help_show_list,
- c, 0, full, match);
+ if (cmd_match == NULL) {
+ LOG_ERROR("unable to build search string");
+ return -ENOMEM;
+ }
+ retval = CALL_COMMAND_HANDLER(command_help_show_list, full, cmd_match);
- if (CMD_ARGC >= 1)
- free(match);
+ free(cmd_match);
return retval;
}
static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
- struct command *head, struct command **out, bool top_level)
+ struct command *head, struct command **out)
{
if (0 == argc)
return argc;
const char *cmd_name = Jim_GetString(argv[0], NULL);
struct command *c = command_find(head, cmd_name);
- if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
- c = command_find(head, cmd_name + 4);
if (NULL == c)
return argc;
*out = c;
- return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
+ return command_unknown_find(--argc, ++argv, (*out)->children, out);
}
-static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+static char *alloc_concatenate_strings(int argc, Jim_Obj * const *argv)
{
- const char *cmd_name = Jim_GetString(argv[0], NULL);
- if (strcmp(cmd_name, "unknown") == 0) {
- if (argc == 1)
- return JIM_OK;
- argc--;
- argv++;
+ char *prev, *all;
+ int i;
+
+ assert(argc >= 1);
+
+ all = strdup(Jim_GetString(argv[0], NULL));
+ if (!all) {
+ LOG_ERROR("Out of memory");
+ return NULL;
+ }
+
+ for (i = 1; i < argc; ++i) {
+ prev = all;
+ all = alloc_printf("%s %s", all, Jim_GetString(argv[i], NULL));
+ free(prev);
+ if (!all) {
+ LOG_ERROR("Out of memory");
+ return NULL;
+ }
}
- script_debug(interp, cmd_name, argc, argv);
+
+ return all;
+}
+
+static int run_usage(Jim_Interp *interp, int argc_valid, int argc, Jim_Obj * const *argv)
+{
+ struct command_context *cmd_ctx = current_command_context(interp);
+ char *command;
+ int retval;
+
+ assert(argc_valid >= 1);
+ assert(argc >= argc_valid);
+
+ command = alloc_concatenate_strings(argc_valid, argv);
+ if (!command)
+ return JIM_ERR;
+
+ retval = command_run_linef(cmd_ctx, "usage %s", command);
+ if (retval != ERROR_OK) {
+ LOG_ERROR("unable to execute command \"usage %s\"", command);
+ return JIM_ERR;
+ }
+
+ if (argc_valid == argc)
+ LOG_ERROR("%s: command requires more arguments", command);
+ else {
+ free(command);
+ command = alloc_concatenate_strings(argc - argc_valid, argv + argc_valid);
+ if (!command)
+ return JIM_ERR;
+ LOG_ERROR("invalid subcommand \"%s\"", command);
+ }
+
+ free(command);
+ 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);
struct command_context *cmd_ctx = current_command_context(interp);
struct command *c = cmd_ctx->commands;
- int remaining = command_unknown_find(argc, argv, c, &c, true);
+ int remaining = command_unknown_find(argc, argv, c, &c);
/* if nothing could be consumed, then it's really an unknown command */
if (remaining == argc) {
const char *cmd = Jim_GetString(argv[0], NULL);
@@ -993,7 +1044,6 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
return JIM_OK;
}
- bool found = true;
Jim_Obj *const *start;
unsigned count;
if (c->handler || c->jim_handler) {
@@ -1001,22 +1051,37 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
count = remaining + 1;
start = argv + (argc - remaining - 1);
} else {
- c = command_find(cmd_ctx->commands, "usage");
- if (NULL == c) {
- LOG_ERROR("unknown command, but usage is missing too");
- return JIM_ERR;
- }
count = argc - remaining;
start = argv;
- found = false;
- }
- /* pass the command through to the intended handler */
- if (c->jim_handler) {
- interp->cmdPrivData = c->jim_handler_data;
- return (*c->jim_handler)(interp, count, start);
+ run_usage(interp, count, argc, start);
+ return JIM_ERR;
}
- return script_command_run(interp, count, start, c, found);
+ 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);
+
+ 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)
@@ -1025,8 +1090,20 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
enum command_mode mode;
if (argc > 1) {
+ char *full_name = alloc_concatenate_strings(argc - 1, argv + 1);
+ if (!full_name)
+ return JIM_ERR;
+ Jim_Obj *s = Jim_NewStringObj(interp, full_name, -1);
+ Jim_IncrRefCount(s);
+ Jim_Cmd *cmd = Jim_GetCommand(interp, s, JIM_NONE);
+ Jim_DecrRefCount(interp, s);
+ free(full_name);
+ if (cmd && jimcmd_is_proc(cmd)) {
+ Jim_SetResultString(interp, "any", -1);
+ return JIM_OK;
+ }
struct command *c = cmd_ctx->commands;
- int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
+ int remaining = command_unknown_find(argc - 1, argv + 1, c, &c);
/* if nothing could be consumed, then it's an unknown command */
if (remaining == argc - 1) {
Jim_SetResultString(interp, "unknown", -1);
@@ -1055,104 +1132,104 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
return JIM_OK;
}
-static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+int help_del_all_commands(struct command_context *cmd_ctx)
{
- if (1 == argc)
- return JIM_ERR;
-
- struct command_context *cmd_ctx = current_command_context(interp);
- struct command *c = cmd_ctx->commands;
- int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
- /* if nothing could be consumed, then it's an unknown command */
- if (remaining == argc - 1) {
- Jim_SetResultString(interp, "unknown", -1);
- return JIM_OK;
+ struct help_entry *curr, *n;
+
+ list_for_each_entry_safe(curr, n, cmd_ctx->help_list, lh) {
+ list_del(&curr->lh);
+ free(curr->cmd_name);
+ free(curr->help);
+ free(curr->usage);
+ free(curr);
}
+ return ERROR_OK;
+}
- if (c->jim_handler)
- Jim_SetResultString(interp, "native", -1);
- else if (c->handler)
- Jim_SetResultString(interp, "simple", -1);
- else
- Jim_SetResultString(interp, "group", -1);
+static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name)
+{
+ struct help_entry *curr;
+
+ list_for_each_entry(curr, cmd_ctx->help_list, lh) {
+ if (!strcmp(cmd_name, curr->cmd_name)) {
+ list_del(&curr->lh);
+ free(curr->cmd_name);
+ free(curr->help);
+ free(curr->usage);
+ free(curr);
+ break;
+ }
+ }
- return JIM_OK;
+ return ERROR_OK;
}
-int help_add_command(struct command_context *cmd_ctx, struct command *parent,
- const char *cmd_name, const char *help_text, const char *usage)
+static int help_add_command(struct command_context *cmd_ctx,
+ const char *cmd_name, const char *help_text, const char *usage_text)
{
- struct command **head = command_list_for_parent(cmd_ctx, parent);
- struct command *nc = command_find(*head, cmd_name);
- if (NULL == nc) {
- /* add a new command with help text */
- struct command_registration cr = {
- .name = cmd_name,
- .mode = COMMAND_ANY,
- .help = help_text,
- .usage = usage,
- };
- nc = register_command(cmd_ctx, parent, &cr);
- if (NULL == nc) {
- LOG_ERROR("failed to add '%s' help text", cmd_name);
+ int cmp = -1; /* add after curr */
+ struct help_entry *curr;
+
+ list_for_each_entry_reverse(curr, cmd_ctx->help_list, lh) {
+ cmp = strcmp(cmd_name, curr->cmd_name);
+ if (cmp >= 0)
+ break;
+ }
+
+ struct help_entry *entry;
+ if (cmp) {
+ entry = calloc(1, sizeof(*entry));
+ if (!entry) {
+ LOG_ERROR("Out of memory");
return ERROR_FAIL;
}
- LOG_DEBUG("added '%s' help text", cmd_name);
- return ERROR_OK;
+ entry->cmd_name = strdup(cmd_name);
+ if (!entry->cmd_name) {
+ LOG_ERROR("Out of memory");
+ free(entry);
+ return ERROR_FAIL;
+ }
+ list_add(&entry->lh, &curr->lh);
+ } else {
+ entry = curr;
}
+
if (help_text) {
- bool replaced = false;
- if (nc->help) {
- free((void *)nc->help);
- replaced = true;
+ char *text = strdup(help_text);
+ if (!text) {
+ LOG_ERROR("Out of memory");
+ return ERROR_FAIL;
}
- nc->help = strdup(help_text);
- if (replaced)
- LOG_INFO("replaced existing '%s' help", cmd_name);
- else
- LOG_DEBUG("added '%s' help text", cmd_name);
+ free(entry->help);
+ entry->help = text;
}
- if (usage) {
- bool replaced = false;
- if (nc->usage) {
- free((void *)nc->usage);
- replaced = true;
+
+ if (usage_text) {
+ char *text = strdup(usage_text);
+ if (!text) {
+ LOG_ERROR("Out of memory");
+ return ERROR_FAIL;
}
- nc->usage = strdup(usage);
- if (replaced)
- LOG_INFO("replaced existing '%s' usage", cmd_name);
- else
- LOG_DEBUG("added '%s' usage text", cmd_name);
+ free(entry->usage);
+ entry->usage = text;
}
+
return ERROR_OK;
}
COMMAND_HANDLER(handle_help_add_command)
{
- if (CMD_ARGC < 2) {
- LOG_ERROR("%s: insufficient arguments", CMD_NAME);
+ if (CMD_ARGC != 2)
return ERROR_COMMAND_SYNTAX_ERROR;
- }
- /* save help text and remove it from argument list */
- const char *str = CMD_ARGV[--CMD_ARGC];
- const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
- const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
+ const char *help = !strcmp(CMD_NAME, "add_help_text") ? CMD_ARGV[1] : NULL;
+ const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? CMD_ARGV[1] : NULL;
if (!help && !usage) {
LOG_ERROR("command name '%s' is unknown", CMD_NAME);
return ERROR_COMMAND_SYNTAX_ERROR;
}
- /* likewise for the leaf command name */
- const char *cmd_name = CMD_ARGV[--CMD_ARGC];
-
- struct command *c = NULL;
- if (CMD_ARGC > 0) {
- c = CMD_CTX->commands;
- int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
- if (ERROR_OK != retval)
- return retval;
- }
- return help_add_command(CMD_CTX, c, cmd_name, help, usage);
+ const char *cmd_name = CMD_ARGV[0];
+ return help_add_command(CMD_CTX, cmd_name, help, usage);
}
/* sleep command sleeps for milliseconds
@@ -1175,8 +1252,8 @@ COMMAND_HANDLER(handle_sleep_command)
return retval;
if (!busy) {
- long long then = timeval_ms();
- while (timeval_ms() - then < (long long)duration) {
+ int64_t then = timeval_ms();
+ while (timeval_ms() - then < (int64_t)duration) {
target_call_timer_callbacks_now();
usleep(1000);
}
@@ -1192,25 +1269,31 @@ static const struct command_registration command_subcommand_handlers[] = {
.mode = COMMAND_ANY,
.jim_handler = jim_command_mode,
.usage = "[command_name ...]",
- .help = "Returns the command modes allowed by a command:"
- "'any', 'config', or 'exec'. If no command is"
- "specified, returns the current command mode. "
+ .help = "Returns the command modes allowed by a command: "
+ "'any', 'config', or 'exec'. If no command is "
+ "specified, returns the current command mode. "
"Returns 'unknown' if an unknown command is given. "
"Command can be multiple tokens.",
},
- {
- .name = "type",
- .mode = COMMAND_ANY,
- .jim_handler = jim_command_type,
- .usage = "command_name [...]",
- .help = "Returns the type of built-in command:"
- "'native', 'simple', 'group', or 'unknown'. "
- "Command can be multiple tokens.",
- },
COMMAND_REGISTRATION_DONE
};
static const struct command_registration command_builtin_handlers[] = {
+ {
+ .name = "ocd_find",
+ .mode = COMMAND_ANY,
+ .jim_handler = jim_find,
+ .help = "find full path to file",
+ .usage = "file",
+ },
+ {
+ .name = "capture",
+ .mode = COMMAND_ANY,
+ .jim_handler = jim_capture,
+ .help = "Capture progress output and return as tcl return value. If the "
+ "progress output was empty, return tcl return value.",
+ .usage = "command",
+ },
{
.name = "echo",
.handler = jim_echo,
@@ -1265,20 +1348,21 @@ static const struct command_registration command_builtin_handlers[] = {
.mode = COMMAND_ANY,
.help = "core command group (introspection)",
.chain = command_subcommand_handlers,
+ .usage = "",
},
COMMAND_REGISTRATION_DONE
};
struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
{
- struct command_context *context = malloc(sizeof(struct command_context));
+ struct command_context *context = calloc(1, sizeof(struct command_context));
const char *HostOs;
context->mode = COMMAND_EXEC;
- context->commands = NULL;
- context->current_target = 0;
- context->output_handler = NULL;
- context->output_handler_priv = NULL;
+
+ /* context can be duplicated. Put list head on separate mem-chunk to keep list consistent */
+ context->help_list = malloc(sizeof(*context->help_list));
+ INIT_LIST_HEAD(context->help_list);
/* Create a jim interpreter if we were not handed one */
if (interp == NULL) {
@@ -1313,6 +1397,8 @@ struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp
HostOs = "ecos";
#elif defined(__FreeBSD__)
HostOs = "freebsd";
+#elif defined(__NetBSD__)
+ HostOs = "netbsd";
#elif defined(__OpenBSD__)
HostOs = "openbsd";
#else
@@ -1322,9 +1408,6 @@ struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp
Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
Jim_NewStringObj(interp, HostOs, strlen(HostOs)));
- Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
- Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
-
register_commands(context, NULL, command_builtin_handlers);
Jim_SetAssocData(interp, "context", NULL, context);
@@ -1339,6 +1422,16 @@ struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp
return context;
}
+void command_exit(struct command_context *context)
+{
+ if (!context)
+ return;
+
+ Jim_FreeInterp(context->interp);
+ free(context->help_list);
+ command_done(context);
+}
+
int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
{
if (!cmd_ctx)
@@ -1367,6 +1460,7 @@ void process_jim_events(struct command_context *cmd_ctx)
return ERROR_COMMAND_ARGUMENT_INVALID; \
} \
char *end; \
+ errno = 0; \
*ul = func(str, &end, 0); \
if (*end) { \
LOG_ERROR("Invalid command argument"); \
@@ -1402,19 +1496,23 @@ DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
return ERROR_OK; \
}
-#define DEFINE_PARSE_ULONG(name, type, min, max) \
- DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
-DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
-DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
-DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
-DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
+#define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
+ DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
+DEFINE_PARSE_ULONGLONG(_uint, unsigned, 0, UINT_MAX)
+DEFINE_PARSE_ULONGLONG(_u64, uint64_t, 0, UINT64_MAX)
+DEFINE_PARSE_ULONGLONG(_u32, uint32_t, 0, UINT32_MAX)
+DEFINE_PARSE_ULONGLONG(_u16, uint16_t, 0, UINT16_MAX)
+DEFINE_PARSE_ULONGLONG(_u8, uint8_t, 0, UINT8_MAX)
+
+DEFINE_PARSE_ULONGLONG(_target_addr, target_addr_t, 0, TARGET_ADDR_MAX)
-#define DEFINE_PARSE_LONG(name, type, min, max) \
- DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
-DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
-DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
-DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
-DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
+#define DEFINE_PARSE_LONGLONG(name, type, min, max) \
+ DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
+DEFINE_PARSE_LONGLONG(_int, int, n < INT_MIN, INT_MAX)
+DEFINE_PARSE_LONGLONG(_s64, int64_t, n < INT64_MIN, INT64_MAX)
+DEFINE_PARSE_LONGLONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
+DEFINE_PARSE_LONGLONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
+DEFINE_PARSE_LONGLONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
static int command_parse_bool(const char *in, bool *out,
const char *on, const char *off)
@@ -1452,8 +1550,8 @@ COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
return ERROR_COMMAND_SYNTAX_ERROR;
}
- /* fall through */
}
+ /* fallthrough */
case 0:
LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
break;