1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
11 * part of this file is taken from libcli (libcli.sourceforge.net) *
12 * Copyright (C) David Parrish (david@dparrish.com) *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
19 * This program is distributed in the hope that it will be useful, *
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
22 * GNU General Public License for more details. *
24 * You should have received a copy of the GNU General Public License *
25 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
26 ***************************************************************************/
32 /* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
35 /* @todo the inclusion of target.h here is a layering violation */
36 #include <jtag/jtag.h>
37 #include <target/target.h>
39 #include "configuration.h"
41 #include "time_support.h"
42 #include "jim-eventloop.h"
44 /* nice short description of source file */
45 #define __THIS__FILE__ "command.c"
47 struct log_capture_state {
52 static int unregister_command(struct command_context *context,
53 const char *cmd_prefix, const char *name);
54 static int jim_command_dispatch(Jim_Interp *interp, int argc, Jim_Obj * const *argv);
55 static int help_add_command(struct command_context *cmd_ctx,
56 const char *cmd_name, const char *help_text, const char *usage_text);
57 static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name);
59 /* set of functions to wrap jimtcl internal data */
60 static inline bool jimcmd_is_proc(Jim_Cmd *cmd)
65 bool jimcmd_is_oocd_command(Jim_Cmd *cmd)
67 return !cmd->isproc && cmd->u.native.cmdProc == jim_command_dispatch;
70 void *jimcmd_privdata(Jim_Cmd *cmd)
72 return cmd->isproc ? NULL : cmd->u.native.privData;
75 static void tcl_output(void *privData, const char *file, unsigned line,
76 const char *function, const char *string)
78 struct log_capture_state *state = privData;
79 Jim_AppendString(state->interp, state->output, string, strlen(string));
82 static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
84 /* capture log output and return it. A garbage collect can
85 * happen, so we need a reference count to this object */
86 Jim_Obj *jim_output = Jim_NewStringObj(interp, "", 0);
90 Jim_IncrRefCount(jim_output);
92 struct log_capture_state *state = malloc(sizeof(*state));
94 LOG_ERROR("Out of memory");
95 Jim_DecrRefCount(interp, jim_output);
99 state->interp = interp;
100 state->output = jim_output;
102 log_add_callback(tcl_output, state);
107 /* Classic openocd commands provide progress output which we
108 * will capture and return as a Tcl return value.
110 * However, if a non-openocd command has been invoked, then it
111 * makes sense to return the tcl return value from that command.
113 * The tcl return value is empty for openocd commands that provide
116 * Therefore we set the tcl return value only if we actually
119 static void command_log_capture_finish(struct log_capture_state *state)
124 log_remove_callback(tcl_output, state);
127 Jim_GetString(state->output, &length);
130 Jim_SetResult(state->interp, state->output);
132 /* No output captured, use tcl return value (which could
135 Jim_DecrRefCount(state->interp, state->output);
141 * FIXME: workaround for memory leak in jimtcl 0.80
142 * Jim API Jim_CreateCommand() converts the command name in a Jim object and
143 * does not free the object. Fixed for jimtcl 0.81 by e4416cf86f0b
144 * Use the internal jimtcl API Jim_CreateCommandObj, not exported by jim.h,
145 * and override the bugged API through preprocessor's macro.
146 * This workaround works only when jimtcl is compiled as OpenOCD submodule.
147 * It's broken on macOS, so it's currently restricted on Linux only.
148 * If jimtcl is linked-in from a precompiled library, either static or dynamic,
149 * the symbol Jim_CreateCommandObj is not exported and the build will use the
151 * To be removed when OpenOCD will switch to jimtcl 0.81
153 #if JIM_VERSION == 80 && defined __linux__
154 static int workaround_createcommand(Jim_Interp *interp, const char *cmdName,
155 Jim_CmdProc *cmdProc, void *privData, Jim_DelCmdProc *delProc);
156 int Jim_CreateCommandObj(Jim_Interp *interp, Jim_Obj *cmdNameObj,
157 Jim_CmdProc *cmdProc, void *privData, Jim_DelCmdProc *delProc)
158 __attribute__((weak, alias("workaround_createcommand")));
159 static int workaround_createcommand(Jim_Interp *interp, const char *cmdName,
160 Jim_CmdProc *cmdProc, void *privData, Jim_DelCmdProc *delProc)
162 if ((void *)Jim_CreateCommandObj == (void *)workaround_createcommand)
163 return Jim_CreateCommand(interp, cmdName, cmdProc, privData, delProc);
165 Jim_Obj *cmd_name = Jim_NewStringObj(interp, cmdName, -1);
166 Jim_IncrRefCount(cmd_name);
167 int retval = Jim_CreateCommandObj(interp, cmd_name, cmdProc, privData, delProc);
168 Jim_DecrRefCount(interp, cmd_name);
171 #define Jim_CreateCommand workaround_createcommand
172 #endif /* JIM_VERSION == 80 && defined __linux__*/
173 /* FIXME: end of workaround for memory leak in jimtcl 0.80 */
175 static int command_retval_set(Jim_Interp *interp, int retval)
177 int *return_retval = Jim_GetAssocData(interp, "retval");
179 *return_retval = retval;
181 return (retval == ERROR_OK) ? JIM_OK : retval;
184 extern struct command_context *global_cmd_ctx;
186 /* dump a single line to the log for the command.
187 * Do nothing in case we are not at debug level 3 */
188 static void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv)
190 if (debug_level < LOG_LVL_DEBUG)
193 char *dbg = alloc_printf("command -");
194 for (unsigned i = 0; i < argc; i++) {
196 const char *w = Jim_GetString(argv[i], &len);
197 char *t = alloc_printf("%s %s", dbg, w);
201 LOG_DEBUG("%s", dbg);
205 static void script_command_args_free(char **words, unsigned nwords)
207 for (unsigned i = 0; i < nwords; i++)
212 static char **script_command_args_alloc(
213 unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
215 char **words = malloc(argc * sizeof(char *));
220 for (i = 0; i < argc; i++) {
222 const char *w = Jim_GetString(argv[i], &len);
223 words[i] = strdup(w);
225 script_command_args_free(words, i);
233 struct command_context *current_command_context(Jim_Interp *interp)
235 /* grab the command context from the associated data */
236 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
238 /* Tcl can invoke commands directly instead of via command_run_line(). This would
239 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
240 * commands in a startup script.
242 * A telnet or gdb server would provide a non-default command context to
243 * handle piping of error output, have a separate current target, etc.
245 cmd_ctx = global_cmd_ctx;
251 * Find a openocd command from fullname.
252 * @returns Returns the named command if it is registred in interp.
253 * Returns NULL otherwise.
255 static struct command *command_find_from_name(Jim_Interp *interp, const char *name)
260 Jim_Obj *jim_name = Jim_NewStringObj(interp, name, -1);
261 Jim_IncrRefCount(jim_name);
262 Jim_Cmd *cmd = Jim_GetCommand(interp, jim_name, JIM_NONE);
263 Jim_DecrRefCount(interp, jim_name);
264 if (!cmd || jimcmd_is_proc(cmd) || !jimcmd_is_oocd_command(cmd))
267 return jimcmd_privdata(cmd);
270 static struct command *command_new(struct command_context *cmd_ctx,
271 const char *full_name, const struct command_registration *cr)
276 * If it is a non-jim command with no .usage specified,
279 * strlen(.usage) == 0 means that the command takes no
282 if (!cr->jim_handler && !cr->usage)
283 LOG_ERROR("BUG: command '%s' does not have the "
284 "'.usage' field filled out",
287 struct command *c = calloc(1, sizeof(struct command));
291 c->name = strdup(cr->name);
297 c->handler = cr->handler;
298 c->jim_handler = cr->jim_handler;
301 if (cr->help || cr->usage)
302 help_add_command(cmd_ctx, full_name, cr->help, cr->usage);
307 static void command_free(struct Jim_Interp *interp, void *priv)
309 struct command *c = priv;
315 static struct command *register_command(struct command_context *context,
316 const char *cmd_prefix, const struct command_registration *cr)
320 if (!context || !cr->name)
324 full_name = alloc_printf("%s %s", cmd_prefix, cr->name);
326 full_name = strdup(cr->name);
330 struct command *c = command_find_from_name(context->interp, full_name);
332 /* TODO: originally we treated attempting to register a cmd twice as an error
333 * Sometimes we need this behaviour, such as with flash banks.
334 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
335 LOG_DEBUG("command '%s' is already registered", full_name);
340 c = command_new(context, full_name, cr);
346 if (false) /* too noisy with debug_level 3 */
347 LOG_DEBUG("registering '%s'...", full_name);
348 int retval = Jim_CreateCommand(context->interp, full_name,
349 jim_command_dispatch, c, command_free);
350 if (retval != JIM_OK) {
351 command_run_linef(context, "del_help_text {%s}", full_name);
352 command_run_linef(context, "del_usage_text {%s}", full_name);
362 int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
363 const struct command_registration *cmds, void *data,
364 struct target *override_target)
366 int retval = ERROR_OK;
368 for (i = 0; cmds[i].name || cmds[i].chain; i++) {
369 const struct command_registration *cr = cmds + i;
371 struct command *c = NULL;
373 c = register_command(cmd_ctx, cmd_prefix, cr);
378 c->jim_handler_data = data;
379 c->jim_override_target = override_target;
384 char *new_prefix = alloc_printf("%s %s", cmd_prefix, cr->name);
389 retval = __register_commands(cmd_ctx, new_prefix, cr->chain, data, override_target);
392 retval = __register_commands(cmd_ctx, cr->name, cr->chain, data, override_target);
395 retval = __register_commands(cmd_ctx, cmd_prefix, cr->chain, data, override_target);
397 if (retval != ERROR_OK)
401 if (retval != ERROR_OK) {
402 for (unsigned j = 0; j < i; j++)
403 unregister_command(cmd_ctx, cmd_prefix, cmds[j].name);
408 static __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)))
409 int unregister_commands_match(struct command_context *cmd_ctx, const char *format, ...)
411 Jim_Interp *interp = cmd_ctx->interp;
414 va_start(ap, format);
415 char *query = alloc_vprintf(format, ap);
420 char *query_cmd = alloc_printf("info commands {%s}", query);
425 int retval = Jim_EvalSource(interp, __THIS__FILE__, __LINE__, query_cmd);
427 if (retval != JIM_OK)
430 Jim_Obj *list = Jim_GetResult(interp);
431 Jim_IncrRefCount(list);
433 int len = Jim_ListLength(interp, list);
434 for (int i = 0; i < len; i++) {
435 Jim_Obj *elem = Jim_ListGetIndex(interp, list, i);
436 Jim_IncrRefCount(elem);
438 const char *name = Jim_GetString(elem, NULL);
439 struct command *c = command_find_from_name(interp, name);
441 /* not openocd command */
442 Jim_DecrRefCount(interp, elem);
445 if (false) /* too noisy with debug_level 3 */
446 LOG_DEBUG("delete command \"%s\"", name);
447 #if JIM_VERSION >= 80
448 Jim_DeleteCommand(interp, elem);
450 Jim_DeleteCommand(interp, name);
453 help_del_command(cmd_ctx, name);
455 Jim_DecrRefCount(interp, elem);
458 Jim_DecrRefCount(interp, list);
462 int unregister_all_commands(struct command_context *context,
463 const char *cmd_prefix)
468 if (!cmd_prefix || !*cmd_prefix)
469 return unregister_commands_match(context, "*");
471 int retval = unregister_commands_match(context, "%s *", cmd_prefix);
472 if (retval != ERROR_OK)
475 return unregister_commands_match(context, "%s", cmd_prefix);
478 static int unregister_command(struct command_context *context,
479 const char *cmd_prefix, const char *name)
481 if (!context || !name)
482 return ERROR_COMMAND_SYNTAX_ERROR;
484 if (!cmd_prefix || !*cmd_prefix)
485 return unregister_commands_match(context, "%s", name);
487 return unregister_commands_match(context, "%s %s", cmd_prefix, name);
490 void command_output_text(struct command_context *context, const char *data)
492 if (context && context->output_handler && data)
493 context->output_handler(context, data);
496 void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
501 va_start(ap, format);
503 string = alloc_vprintf(format, ap);
505 /* we want this collected in the log + we also want to pick it up as a tcl return
508 * The latter bit isn't precisely neat, but will do for now.
510 Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
511 /* We already printed it above
512 * command_output_text(context, string); */
519 void command_print(struct command_invocation *cmd, const char *format, ...)
524 va_start(ap, format);
526 string = alloc_vprintf(format, ap);
528 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
530 /* we want this collected in the log + we also want to pick it up as a tcl return
533 * The latter bit isn't precisely neat, but will do for now.
535 Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
536 /* We already printed it above
537 * command_output_text(context, string); */
544 static bool command_can_run(struct command_context *cmd_ctx, struct command *c, const char *full_name)
546 if (c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode)
549 /* Many commands may be run only before/after 'init' */
558 /* handle the impossible with humor; it guarantees a bug report! */
560 when = "if Cthulhu is summoned by";
563 LOG_ERROR("The '%s' command must be used %s 'init'.",
564 full_name ? full_name : c->name, when);
568 static int run_command(struct command_context *context,
569 struct command *c, const char **words, unsigned num_words)
571 struct command_invocation cmd = {
575 .argc = num_words - 1,
579 cmd.output = Jim_NewEmptyStringObj(context->interp);
580 Jim_IncrRefCount(cmd.output);
582 int retval = c->handler(&cmd);
583 if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
584 /* Print help for command */
585 command_run_linef(context, "usage %s", words[0]);
586 } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) {
587 /* just fall through for a shutdown request */
589 if (retval != ERROR_OK)
590 LOG_DEBUG("Command '%s' failed with error code %d",
592 /* Use the command output as the Tcl result */
593 Jim_SetResult(context->interp, cmd.output);
595 Jim_DecrRefCount(context->interp, cmd.output);
600 int command_run_line(struct command_context *context, char *line)
602 /* all the parent commands have been registered with the interpreter
603 * so, can just evaluate the line as a script and check for
606 /* run the line thru a script engine */
607 int retval = ERROR_FAIL;
609 /* Beware! This code needs to be reentrant. It is also possible
610 * for OpenOCD commands to be invoked directly from Tcl. This would
611 * happen when the Jim Tcl interpreter is provided by eCos for
614 struct target *saved_target_override = context->current_target_override;
615 context->current_target_override = NULL;
617 Jim_Interp *interp = context->interp;
618 struct command_context *old_context = Jim_GetAssocData(interp, "context");
619 Jim_DeleteAssocData(interp, "context");
620 retcode = Jim_SetAssocData(interp, "context", NULL, context);
621 if (retcode == JIM_OK) {
622 /* associated the return value */
623 Jim_DeleteAssocData(interp, "retval");
624 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
625 if (retcode == JIM_OK) {
626 retcode = Jim_Eval_Named(interp, line, 0, 0);
628 Jim_DeleteAssocData(interp, "retval");
630 Jim_DeleteAssocData(interp, "context");
631 int inner_retcode = Jim_SetAssocData(interp, "context", NULL, old_context);
632 if (retcode == JIM_OK)
633 retcode = inner_retcode;
635 context->current_target_override = saved_target_override;
636 if (retcode == JIM_OK) {
640 result = Jim_GetString(Jim_GetResult(interp), &reslen);
642 command_output_text(context, result);
643 command_output_text(context, "\n");
646 } else if (retcode == JIM_EXIT) {
648 * exit(Jim_GetExitCode(interp)); */
649 } else if (retcode == ERROR_COMMAND_CLOSE_CONNECTION) {
652 Jim_MakeErrorMessage(interp);
653 /* error is broadcast */
654 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
656 if (retval == ERROR_OK) {
657 /* It wasn't a low level OpenOCD command that failed */
666 int command_run_linef(struct command_context *context, const char *format, ...)
668 int retval = ERROR_FAIL;
671 va_start(ap, format);
672 string = alloc_vprintf(format, ap);
674 retval = command_run_line(context, string);
681 void command_set_output_handler(struct command_context *context,
682 command_output_handler_t output_handler, void *priv)
684 context->output_handler = output_handler;
685 context->output_handler_priv = priv;
688 struct command_context *copy_command_context(struct command_context *context)
690 struct command_context *copy_context = malloc(sizeof(struct command_context));
692 *copy_context = *context;
697 void command_done(struct command_context *cmd_ctx)
705 /* find full path to file */
706 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
710 const char *file = Jim_GetString(argv[1], NULL);
711 char *full_path = find_file(file);
714 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
717 Jim_SetResult(interp, result);
721 COMMAND_HANDLER(handle_echo)
723 if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) {
724 LOG_USER_N("%s", CMD_ARGV[1]);
731 LOG_USER("%s", CMD_ARGV[0]);
735 /* Capture progress output and return as tcl return value. If the
736 * progress output was empty, return tcl return value.
738 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
743 struct log_capture_state *state = command_log_capture_start(interp);
745 /* disable polling during capture. This avoids capturing output
748 * This is necessary in order to avoid accidentally getting a non-empty
749 * string for tcl fn's.
751 bool save_poll = jtag_poll_get_enabled();
753 jtag_poll_set_enabled(false);
755 const char *str = Jim_GetString(argv[1], NULL);
756 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
758 jtag_poll_set_enabled(save_poll);
760 command_log_capture_finish(state);
772 static COMMAND_HELPER(command_help_show, struct help_entry *c,
773 bool show_help, const char *cmd_match);
775 static COMMAND_HELPER(command_help_show_list, bool show_help, const char *cmd_match)
777 struct help_entry *entry;
779 list_for_each_entry(entry, CMD_CTX->help_list, lh)
780 CALL_COMMAND_HANDLER(command_help_show, entry, show_help, cmd_match);
784 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
786 static void command_help_show_indent(unsigned n)
788 for (unsigned i = 0; i < n; i++)
791 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
793 const char *cp = str, *last = str;
795 const char *next = last;
800 } while (*next != ' ' && *next != '\t' && *next != '\0');
801 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
802 if (next - last < HELP_LINE_WIDTH(n))
804 command_help_show_indent(n);
805 LOG_USER("%.*s", (int)(cp - last), last);
811 static COMMAND_HELPER(command_help_show, struct help_entry *c,
812 bool show_help, const char *cmd_match)
815 for (const char *s = strchr(c->cmd_name, ' '); s; s = strchr(s + 1, ' '))
818 /* If the match string occurs anywhere, we print out
819 * stuff for this command. */
820 bool is_match = strstr(c->cmd_name, cmd_match) ||
821 (c->usage && strstr(c->usage, cmd_match)) ||
822 (c->help && strstr(c->help, cmd_match));
825 if (c->usage && strlen(c->usage) > 0) {
826 char *msg = alloc_printf("%s %s", c->cmd_name, c->usage);
827 command_help_show_wrap(msg, n, n + 5);
830 command_help_show_wrap(c->cmd_name, n, n + 5);
834 if (is_match && show_help) {
837 /* TODO: factorize jim_command_mode() to avoid running jim command here */
838 char *request = alloc_printf("command mode %s", c->cmd_name);
840 LOG_ERROR("Out of memory");
843 int retval = Jim_Eval(CMD_CTX->interp, request);
845 enum command_mode mode = COMMAND_UNKNOWN;
846 if (retval != JIM_ERR) {
847 const char *result = Jim_GetString(Jim_GetResult(CMD_CTX->interp), NULL);
848 if (!strcmp(result, "any"))
850 else if (!strcmp(result, "config"))
851 mode = COMMAND_CONFIG;
852 else if (!strcmp(result, "exec"))
856 /* Normal commands are runtime-only; highlight exceptions */
857 if (mode != COMMAND_EXEC) {
858 const char *stage_msg = "";
862 stage_msg = " (configuration command)";
865 stage_msg = " (command valid any time)";
868 stage_msg = " (?mode error?)";
871 msg = alloc_printf("%s%s", c->help ? c->help : "", stage_msg);
873 msg = alloc_printf("%s", c->help ? c->help : "");
876 command_help_show_wrap(msg, n + 3, n + 3);
885 COMMAND_HANDLER(handle_help_command)
887 bool full = strcmp(CMD_NAME, "help") == 0;
892 cmd_match = strdup("");
895 cmd_match = strdup(CMD_ARGV[0]);
897 for (unsigned int i = 1; i < CMD_ARGC && cmd_match; ++i) {
898 char *prev = cmd_match;
899 cmd_match = alloc_printf("%s %s", prev, CMD_ARGV[i]);
905 LOG_ERROR("unable to build search string");
908 retval = CALL_COMMAND_HANDLER(command_help_show_list, full, cmd_match);
914 static char *alloc_concatenate_strings(int argc, Jim_Obj * const *argv)
921 all = strdup(Jim_GetString(argv[0], NULL));
923 LOG_ERROR("Out of memory");
927 for (i = 1; i < argc; ++i) {
929 all = alloc_printf("%s %s", all, Jim_GetString(argv[i], NULL));
932 LOG_ERROR("Out of memory");
940 static int exec_command(Jim_Interp *interp, struct command_context *cmd_ctx,
941 struct command *c, int argc, Jim_Obj * const *argv)
944 return c->jim_handler(interp, argc, argv);
948 char **words = script_command_args_alloc(argc, argv, &nwords);
952 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
953 script_command_args_free(words, nwords);
954 return command_retval_set(interp, retval);
957 static int jim_command_dispatch(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
959 /* check subcommands */
961 char *s = alloc_printf("%s %s", Jim_GetString(argv[0], NULL), Jim_GetString(argv[1], NULL));
962 Jim_Obj *js = Jim_NewStringObj(interp, s, -1);
963 Jim_IncrRefCount(js);
965 Jim_Cmd *cmd = Jim_GetCommand(interp, js, JIM_NONE);
967 int retval = Jim_EvalObjPrefix(interp, js, argc - 2, argv + 2);
968 Jim_DecrRefCount(interp, js);
971 Jim_DecrRefCount(interp, js);
974 script_debug(interp, argc, argv);
976 struct command *c = jim_to_command(interp);
977 if (!c->jim_handler && !c->handler) {
978 Jim_EvalObjPrefix(interp, Jim_NewStringObj(interp, "usage", -1), 1, argv);
982 struct command_context *cmd_ctx = current_command_context(interp);
984 if (!command_can_run(cmd_ctx, c, Jim_GetString(argv[0], NULL)))
987 target_call_timer_callbacks_now();
990 * Black magic of overridden current target:
991 * If the command we are going to handle has a target prefix,
992 * override the current target temporarily for the time
993 * of processing the command.
994 * current_target_override is used also for event handlers
995 * therefore we prevent touching it if command has no prefix.
996 * Previous override is saved and restored back to ensure
997 * correct work when jim_command_dispatch() is re-entered.
999 struct target *saved_target_override = cmd_ctx->current_target_override;
1000 if (c->jim_override_target)
1001 cmd_ctx->current_target_override = c->jim_override_target;
1003 int retval = exec_command(interp, cmd_ctx, c, argc, argv);
1005 if (c->jim_override_target)
1006 cmd_ctx->current_target_override = saved_target_override;
1011 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1013 struct command_context *cmd_ctx = current_command_context(interp);
1014 enum command_mode mode;
1017 char *full_name = alloc_concatenate_strings(argc - 1, argv + 1);
1020 Jim_Obj *s = Jim_NewStringObj(interp, full_name, -1);
1021 Jim_IncrRefCount(s);
1022 Jim_Cmd *cmd = Jim_GetCommand(interp, s, JIM_NONE);
1023 Jim_DecrRefCount(interp, s);
1025 if (!cmd || !(jimcmd_is_proc(cmd) || jimcmd_is_oocd_command(cmd))) {
1026 Jim_SetResultString(interp, "unknown", -1);
1030 if (jimcmd_is_proc(cmd)) {
1034 struct command *c = jimcmd_privdata(cmd);
1039 mode = cmd_ctx->mode;
1041 const char *mode_str;
1046 case COMMAND_CONFIG:
1047 mode_str = "config";
1053 mode_str = "unknown";
1056 Jim_SetResultString(interp, mode_str, -1);
1060 int help_del_all_commands(struct command_context *cmd_ctx)
1062 struct help_entry *curr, *n;
1064 list_for_each_entry_safe(curr, n, cmd_ctx->help_list, lh) {
1065 list_del(&curr->lh);
1066 free(curr->cmd_name);
1074 static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name)
1076 struct help_entry *curr;
1078 list_for_each_entry(curr, cmd_ctx->help_list, lh) {
1079 if (!strcmp(cmd_name, curr->cmd_name)) {
1080 list_del(&curr->lh);
1081 free(curr->cmd_name);
1092 static int help_add_command(struct command_context *cmd_ctx,
1093 const char *cmd_name, const char *help_text, const char *usage_text)
1095 int cmp = -1; /* add after curr */
1096 struct help_entry *curr;
1098 list_for_each_entry_reverse(curr, cmd_ctx->help_list, lh) {
1099 cmp = strcmp(cmd_name, curr->cmd_name);
1104 struct help_entry *entry;
1106 entry = calloc(1, sizeof(*entry));
1108 LOG_ERROR("Out of memory");
1111 entry->cmd_name = strdup(cmd_name);
1112 if (!entry->cmd_name) {
1113 LOG_ERROR("Out of memory");
1117 list_add(&entry->lh, &curr->lh);
1123 char *text = strdup(help_text);
1125 LOG_ERROR("Out of memory");
1133 char *text = strdup(usage_text);
1135 LOG_ERROR("Out of memory");
1139 entry->usage = text;
1145 COMMAND_HANDLER(handle_help_add_command)
1148 return ERROR_COMMAND_SYNTAX_ERROR;
1150 const char *help = !strcmp(CMD_NAME, "add_help_text") ? CMD_ARGV[1] : NULL;
1151 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? CMD_ARGV[1] : NULL;
1152 if (!help && !usage) {
1153 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1154 return ERROR_COMMAND_SYNTAX_ERROR;
1156 const char *cmd_name = CMD_ARGV[0];
1157 return help_add_command(CMD_CTX, cmd_name, help, usage);
1160 /* sleep command sleeps for <n> milliseconds
1161 * this is useful in target startup scripts
1163 COMMAND_HANDLER(handle_sleep_command)
1166 if (CMD_ARGC == 2) {
1167 if (strcmp(CMD_ARGV[1], "busy") == 0)
1170 return ERROR_COMMAND_SYNTAX_ERROR;
1171 } else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1172 return ERROR_COMMAND_SYNTAX_ERROR;
1174 unsigned long duration = 0;
1175 int retval = parse_ulong(CMD_ARGV[0], &duration);
1176 if (retval != ERROR_OK)
1180 int64_t then = timeval_ms();
1181 while (timeval_ms() - then < (int64_t)duration) {
1182 target_call_timer_callbacks_now();
1186 busy_sleep(duration);
1191 static const struct command_registration command_subcommand_handlers[] = {
1194 .mode = COMMAND_ANY,
1195 .jim_handler = jim_command_mode,
1196 .usage = "[command_name ...]",
1197 .help = "Returns the command modes allowed by a command: "
1198 "'any', 'config', or 'exec'. If no command is "
1199 "specified, returns the current command mode. "
1200 "Returns 'unknown' if an unknown command is given. "
1201 "Command can be multiple tokens.",
1203 COMMAND_REGISTRATION_DONE
1206 static const struct command_registration command_builtin_handlers[] = {
1209 .mode = COMMAND_ANY,
1210 .jim_handler = jim_find,
1211 .help = "find full path to file",
1216 .mode = COMMAND_ANY,
1217 .jim_handler = jim_capture,
1218 .help = "Capture progress output and return as tcl return value. If the "
1219 "progress output was empty, return tcl return value.",
1224 .handler = handle_echo,
1225 .mode = COMMAND_ANY,
1226 .help = "Logs a message at \"user\" priority. "
1227 "Option \"-n\" suppresses trailing newline",
1228 .usage = "[-n] string",
1231 .name = "add_help_text",
1232 .handler = handle_help_add_command,
1233 .mode = COMMAND_ANY,
1234 .help = "Add new command help text; "
1235 "Command can be multiple tokens.",
1236 .usage = "command_name helptext_string",
1239 .name = "add_usage_text",
1240 .handler = handle_help_add_command,
1241 .mode = COMMAND_ANY,
1242 .help = "Add new command usage text; "
1243 "command can be multiple tokens.",
1244 .usage = "command_name usage_string",
1248 .handler = handle_sleep_command,
1249 .mode = COMMAND_ANY,
1250 .help = "Sleep for specified number of milliseconds. "
1251 "\"busy\" will busy wait instead (avoid this).",
1252 .usage = "milliseconds ['busy']",
1256 .handler = handle_help_command,
1257 .mode = COMMAND_ANY,
1258 .help = "Show full command help; "
1259 "command can be multiple tokens.",
1260 .usage = "[command_name]",
1264 .handler = handle_help_command,
1265 .mode = COMMAND_ANY,
1266 .help = "Show basic command usage; "
1267 "command can be multiple tokens.",
1268 .usage = "[command_name]",
1272 .mode = COMMAND_ANY,
1273 .help = "core command group (introspection)",
1274 .chain = command_subcommand_handlers,
1277 COMMAND_REGISTRATION_DONE
1280 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
1282 struct command_context *context = calloc(1, sizeof(struct command_context));
1284 context->mode = COMMAND_EXEC;
1286 /* context can be duplicated. Put list head on separate mem-chunk to keep list consistent */
1287 context->help_list = malloc(sizeof(*context->help_list));
1288 INIT_LIST_HEAD(context->help_list);
1290 /* Create a jim interpreter if we were not handed one */
1292 /* Create an interpreter */
1293 interp = Jim_CreateInterp();
1294 /* Add all the Jim core commands */
1295 Jim_RegisterCoreCommands(interp);
1296 Jim_InitStaticExtensions(interp);
1299 context->interp = interp;
1301 register_commands(context, NULL, command_builtin_handlers);
1303 Jim_SetAssocData(interp, "context", NULL, context);
1304 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl", 1) == JIM_ERR) {
1305 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1306 Jim_MakeErrorMessage(interp);
1307 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
1310 Jim_DeleteAssocData(interp, "context");
1315 void command_exit(struct command_context *context)
1320 Jim_FreeInterp(context->interp);
1321 free(context->help_list);
1322 command_done(context);
1325 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1328 return ERROR_COMMAND_SYNTAX_ERROR;
1330 cmd_ctx->mode = mode;
1334 void process_jim_events(struct command_context *cmd_ctx)
1336 static int recursion;
1341 Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1345 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1346 int parse ## name(const char *str, type * ul) \
1349 LOG_ERROR("Invalid command argument"); \
1350 return ERROR_COMMAND_ARGUMENT_INVALID; \
1354 *ul = func(str, &end, 0); \
1356 LOG_ERROR("Invalid command argument"); \
1357 return ERROR_COMMAND_ARGUMENT_INVALID; \
1359 if ((max == *ul) && (errno == ERANGE)) { \
1360 LOG_ERROR("Argument overflow"); \
1361 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1363 if (min && (min == *ul) && (errno == ERANGE)) { \
1364 LOG_ERROR("Argument underflow"); \
1365 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1369 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long, strtoul, 0, ULONG_MAX)
1370 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1371 DEFINE_PARSE_NUM_TYPE(_long, long, strtol, LONG_MIN, LONG_MAX)
1372 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1374 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1375 int parse ## name(const char *str, type * ul) \
1378 int retval = parse ## funcname(str, &n); \
1379 if (retval != ERROR_OK) \
1382 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1384 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1389 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1390 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1391 DEFINE_PARSE_ULONGLONG(_uint, unsigned, 0, UINT_MAX)
1392 DEFINE_PARSE_ULONGLONG(_u64, uint64_t, 0, UINT64_MAX)
1393 DEFINE_PARSE_ULONGLONG(_u32, uint32_t, 0, UINT32_MAX)
1394 DEFINE_PARSE_ULONGLONG(_u16, uint16_t, 0, UINT16_MAX)
1395 DEFINE_PARSE_ULONGLONG(_u8, uint8_t, 0, UINT8_MAX)
1397 DEFINE_PARSE_ULONGLONG(_target_addr, target_addr_t, 0, TARGET_ADDR_MAX)
1399 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1400 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1401 DEFINE_PARSE_LONGLONG(_int, int, n < INT_MIN, INT_MAX)
1402 DEFINE_PARSE_LONGLONG(_s64, int64_t, n < INT64_MIN, INT64_MAX)
1403 DEFINE_PARSE_LONGLONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1404 DEFINE_PARSE_LONGLONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1405 DEFINE_PARSE_LONGLONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1407 static int command_parse_bool(const char *in, bool *out,
1408 const char *on, const char *off)
1410 if (strcasecmp(in, on) == 0)
1412 else if (strcasecmp(in, off) == 0)
1415 return ERROR_COMMAND_SYNTAX_ERROR;
1419 int command_parse_bool_arg(const char *in, bool *out)
1421 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1423 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1425 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1427 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1429 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1431 return ERROR_COMMAND_SYNTAX_ERROR;
1434 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1438 const char *in = CMD_ARGV[0];
1439 if (command_parse_bool_arg(in, out) != ERROR_OK) {
1440 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1441 return ERROR_COMMAND_SYNTAX_ERROR;
1446 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1449 return ERROR_COMMAND_SYNTAX_ERROR;