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 struct command
*parent
, const char *name
);
54 static char *command_name(struct command
*c
, char delim
);
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 /* wrap jimtcl internal data */
60 static inline bool jimcmd_is_proc(Jim_Cmd
*cmd
)
65 static void tcl_output(void *privData
, const char *file
, unsigned line
,
66 const char *function
, const char *string
)
68 struct log_capture_state
*state
= privData
;
69 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
72 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
74 /* capture log output and return it. A garbage collect can
75 * happen, so we need a reference count to this object */
76 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
77 if (NULL
== tclOutput
)
80 struct log_capture_state
*state
= malloc(sizeof(*state
));
84 state
->interp
= interp
;
85 Jim_IncrRefCount(tclOutput
);
86 state
->output
= tclOutput
;
88 log_add_callback(tcl_output
, state
);
93 /* Classic openocd commands provide progress output which we
94 * will capture and return as a Tcl return value.
96 * However, if a non-openocd command has been invoked, then it
97 * makes sense to return the tcl return value from that command.
99 * The tcl return value is empty for openocd commands that provide
102 * Therefore we set the tcl return value only if we actually
105 static void command_log_capture_finish(struct log_capture_state
*state
)
110 log_remove_callback(tcl_output
, state
);
113 Jim_GetString(state
->output
, &length
);
116 Jim_SetResult(state
->interp
, state
->output
);
118 /* No output captured, use tcl return value (which could
121 Jim_DecrRefCount(state
->interp
, state
->output
);
127 * FIXME: workaround for memory leak in jimtcl 0.80
128 * Jim API Jim_CreateCommand() converts the command name in a Jim object and
129 * does not free the object. Fixed for jimtcl 0.81 by e4416cf86f0b
130 * Use the internal jimtcl API Jim_CreateCommandObj, not exported by jim.h,
131 * and override the bugged API through preprocessor's macro.
132 * This workaround works only when jimtcl is compiled as OpenOCD submodule.
133 * If jimtcl is linked-in from a precompiled library, either static or dynamic,
134 * the symbol Jim_CreateCommandObj is not exported and the build will use the
136 * To be removed when OpenOCD will switch to jimtcl 0.81
138 #if JIM_VERSION == 80
139 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
140 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
);
141 int Jim_CreateCommandObj(Jim_Interp
*interp
, Jim_Obj
*cmdNameObj
,
142 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
143 __attribute__((weak
, alias("workaround_createcommand")));
144 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
145 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
147 if ((void *)Jim_CreateCommandObj
== (void *)workaround_createcommand
)
148 return Jim_CreateCommand(interp
, cmdName
, cmdProc
, privData
, delProc
);
150 Jim_Obj
*cmd_name
= Jim_NewStringObj(interp
, cmdName
, -1);
151 Jim_IncrRefCount(cmd_name
);
152 int retval
= Jim_CreateCommandObj(interp
, cmd_name
, cmdProc
, privData
, delProc
);
153 Jim_DecrRefCount(interp
, cmd_name
);
156 #define Jim_CreateCommand workaround_createcommand
157 #endif /* JIM_VERSION == 80 */
158 /* FIXME: end of workaround for memory leak in jimtcl 0.80 */
160 static int command_retval_set(Jim_Interp
*interp
, int retval
)
162 int *return_retval
= Jim_GetAssocData(interp
, "retval");
163 if (return_retval
!= NULL
)
164 *return_retval
= retval
;
166 return (retval
== ERROR_OK
) ? JIM_OK
: retval
;
169 extern struct command_context
*global_cmd_ctx
;
171 /* dump a single line to the log for the command.
172 * Do nothing in case we are not at debug level 3 */
173 void script_debug(Jim_Interp
*interp
, unsigned int argc
, Jim_Obj
* const *argv
)
175 if (debug_level
< LOG_LVL_DEBUG
)
178 char *dbg
= alloc_printf("command -");
179 for (unsigned i
= 0; i
< argc
; i
++) {
181 const char *w
= Jim_GetString(argv
[i
], &len
);
182 char *t
= alloc_printf("%s %s", dbg
, w
);
186 LOG_DEBUG("%s", dbg
);
190 static void script_command_args_free(char **words
, unsigned nwords
)
192 for (unsigned i
= 0; i
< nwords
; i
++)
197 static char **script_command_args_alloc(
198 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
200 char **words
= malloc(argc
* sizeof(char *));
205 for (i
= 0; i
< argc
; i
++) {
207 const char *w
= Jim_GetString(argv
[i
], &len
);
208 words
[i
] = strdup(w
);
209 if (words
[i
] == NULL
) {
210 script_command_args_free(words
, i
);
218 struct command_context
*current_command_context(Jim_Interp
*interp
)
220 /* grab the command context from the associated data */
221 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
222 if (NULL
== cmd_ctx
) {
223 /* Tcl can invoke commands directly instead of via command_run_line(). This would
224 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
225 * commands in a startup script.
227 * A telnet or gdb server would provide a non-default command context to
228 * handle piping of error output, have a separate current target, etc.
230 cmd_ctx
= global_cmd_ctx
;
235 static struct command
*command_root(struct command
*c
)
237 while (NULL
!= c
->parent
)
243 * Find a command by name from a list of commands.
244 * @returns Returns the named command if it exists in the list.
245 * Returns NULL otherwise.
247 static struct command
*command_find(struct command
*head
, const char *name
)
249 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
250 if (strcmp(cc
->name
, name
) == 0)
257 * Add the command into the linked list, sorted by name.
258 * @param head Address to head of command list pointer, which may be
259 * updated if @c c gets inserted at the beginning of the list.
260 * @param c The command to add to the list pointed to by @c head.
262 static void command_add_child(struct command
**head
, struct command
*c
)
270 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
271 head
= &(*head
)->next
;
273 if (strcmp(c
->name
, (*head
)->name
) > 0) {
274 c
->next
= (*head
)->next
;
282 static struct command
**command_list_for_parent(
283 struct command_context
*cmd_ctx
, struct command
*parent
)
285 return parent
? &parent
->children
: &cmd_ctx
->commands
;
288 static void command_free(struct command
*c
)
290 /** @todo if command has a handler, unregister its jim command! */
292 while (NULL
!= c
->children
) {
293 struct command
*tmp
= c
->children
;
294 c
->children
= tmp
->next
;
302 static struct command
*command_new(struct command_context
*cmd_ctx
,
303 struct command
*parent
, const struct command_registration
*cr
)
308 * If it is a non-jim command with no .usage specified,
311 * strlen(.usage) == 0 means that the command takes no
314 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
315 LOG_ERROR("BUG: command '%s%s%s' does not have the "
316 "'.usage' field filled out",
317 parent
&& parent
->name
? parent
->name
: "",
318 parent
&& parent
->name
? " " : "",
322 struct command
*c
= calloc(1, sizeof(struct command
));
326 c
->name
= strdup(cr
->name
);
328 goto command_new_error
;
331 c
->handler
= cr
->handler
;
332 c
->jim_handler
= cr
->jim_handler
;
335 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
337 if (cr
->help
|| cr
->usage
) {
338 char *full_name
= command_name(c
, ' ');
339 help_add_command(cmd_ctx
, full_name
, cr
->help
, cr
->usage
);
350 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
352 static int register_command_handler(struct command_context
*cmd_ctx
,
355 Jim_Interp
*interp
= cmd_ctx
->interp
;
358 LOG_DEBUG("registering '%s'...", c
->name
);
361 return Jim_CreateCommand(interp
, c
->name
, command_unknown
, c
, NULL
);
364 static struct command
*register_command(struct command_context
*context
,
365 struct command
*parent
, const struct command_registration
*cr
)
367 if (!context
|| !cr
->name
)
370 const char *name
= cr
->name
;
371 struct command
**head
= command_list_for_parent(context
, parent
);
372 struct command
*c
= command_find(*head
, name
);
374 /* TODO: originally we treated attempting to register a cmd twice as an error
375 * Sometimes we need this behaviour, such as with flash banks.
376 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
377 LOG_DEBUG("command '%s' is already registered in '%s' context",
378 name
, parent
? parent
->name
: "<global>");
382 c
= command_new(context
, parent
, cr
);
386 if (cr
->jim_handler
|| cr
->handler
) {
387 int retval
= register_command_handler(context
, command_root(c
));
388 if (retval
!= JIM_OK
) {
389 unregister_command(context
, parent
, name
);
396 static int ___register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
397 const struct command_registration
*cmds
, void *data
,
398 struct target
*override_target
)
400 int retval
= ERROR_OK
;
402 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
403 const struct command_registration
*cr
= cmds
+ i
;
405 struct command
*c
= NULL
;
406 if (NULL
!= cr
->name
) {
407 c
= register_command(cmd_ctx
, parent
, cr
);
412 c
->jim_handler_data
= data
;
413 c
->jim_override_target
= override_target
;
415 if (NULL
!= cr
->chain
) {
416 struct command
*p
= c
? : parent
;
417 retval
= ___register_commands(cmd_ctx
, p
, cr
->chain
, data
, override_target
);
418 if (ERROR_OK
!= retval
)
422 if (ERROR_OK
!= retval
) {
423 for (unsigned j
= 0; j
< i
; j
++)
424 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
429 int __register_commands(struct command_context
*cmd_ctx
, const char *cmd_prefix
,
430 const struct command_registration
*cmds
, void *data
,
431 struct target
*override_target
)
433 struct command
*parent
= NULL
;
436 parent
= command_find(cmd_ctx
->commands
, cmd_prefix
);
438 return ___register_commands(cmd_ctx
, parent
, cmds
, data
, override_target
);
441 int unregister_all_commands(struct command_context
*context
,
442 struct command
*parent
)
447 struct command
**head
= command_list_for_parent(context
, parent
);
448 while (NULL
!= *head
) {
449 struct command
*tmp
= *head
;
457 static int unregister_command(struct command_context
*context
,
458 struct command
*parent
, const char *name
)
460 if ((!context
) || (!name
))
461 return ERROR_COMMAND_SYNTAX_ERROR
;
463 struct command
*p
= NULL
;
464 struct command
**head
= command_list_for_parent(context
, parent
);
465 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
466 if (strcmp(name
, c
->name
) != 0)
469 char *full_name
= command_name(c
, ' ');
470 help_del_command(context
, full_name
);
485 void command_output_text(struct command_context
*context
, const char *data
)
487 if (context
&& context
->output_handler
&& data
)
488 context
->output_handler(context
, data
);
491 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
496 va_start(ap
, format
);
498 string
= alloc_vprintf(format
, ap
);
499 if (string
!= NULL
&& cmd
) {
500 /* we want this collected in the log + we also want to pick it up as a tcl return
503 * The latter bit isn't precisely neat, but will do for now.
505 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
506 /* We already printed it above
507 * command_output_text(context, string); */
514 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
519 va_start(ap
, format
);
521 string
= alloc_vprintf(format
, ap
);
522 if (string
!= NULL
&& cmd
) {
523 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
525 /* we want this collected in the log + we also want to pick it up as a tcl return
528 * The latter bit isn't precisely neat, but will do for now.
530 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
531 /* We already printed it above
532 * command_output_text(context, string); */
539 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
542 unsigned len
= strlen(c
->name
);
543 if (NULL
== c
->parent
) {
544 /* allocate enough for the name, child names, and '\0' */
545 name
= malloc(len
+ extra
+ 1);
547 LOG_ERROR("Out of memory");
550 strcpy(name
, c
->name
);
552 /* parent's extra must include both the space and name */
553 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
554 char dstr
[2] = { delim
, 0 };
556 strcat(name
, c
->name
);
561 static char *command_name(struct command
*c
, char delim
)
563 return __command_name(c
, delim
, 0);
566 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
568 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
571 /* Many commands may be run only before/after 'init' */
580 /* handle the impossible with humor; it guarantees a bug report! */
582 when
= "if Cthulhu is summoned by";
585 char *full_name
= command_name(c
, ' ');
586 LOG_ERROR("The '%s' command must be used %s 'init'.",
587 full_name
? full_name
: c
->name
, when
);
592 static int run_command(struct command_context
*context
,
593 struct command
*c
, const char **words
, unsigned num_words
)
595 struct command_invocation cmd
= {
599 .argc
= num_words
- 1,
603 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
604 Jim_IncrRefCount(cmd
.output
);
606 int retval
= c
->handler(&cmd
);
607 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
608 /* Print help for command */
609 char *full_name
= command_name(c
, ' ');
610 if (NULL
!= full_name
) {
611 command_run_linef(context
, "usage %s", full_name
);
614 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
615 /* just fall through for a shutdown request */
617 if (retval
!= ERROR_OK
) {
618 char *full_name
= command_name(c
, ' ');
619 LOG_DEBUG("Command '%s' failed with error code %d",
620 full_name
? full_name
: c
->name
, retval
);
623 /* Use the command output as the Tcl result */
624 Jim_SetResult(context
->interp
, cmd
.output
);
626 Jim_DecrRefCount(context
->interp
, cmd
.output
);
631 int command_run_line(struct command_context
*context
, char *line
)
633 /* all the parent commands have been registered with the interpreter
634 * so, can just evaluate the line as a script and check for
637 /* run the line thru a script engine */
638 int retval
= ERROR_FAIL
;
640 /* Beware! This code needs to be reentrant. It is also possible
641 * for OpenOCD commands to be invoked directly from Tcl. This would
642 * happen when the Jim Tcl interpreter is provided by eCos for
645 struct target
*saved_target_override
= context
->current_target_override
;
646 context
->current_target_override
= NULL
;
648 Jim_Interp
*interp
= context
->interp
;
649 struct command_context
*old_context
= Jim_GetAssocData(interp
, "context");
650 Jim_DeleteAssocData(interp
, "context");
651 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
652 if (retcode
== JIM_OK
) {
653 /* associated the return value */
654 Jim_DeleteAssocData(interp
, "retval");
655 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
656 if (retcode
== JIM_OK
) {
657 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
659 Jim_DeleteAssocData(interp
, "retval");
661 Jim_DeleteAssocData(interp
, "context");
662 int inner_retcode
= Jim_SetAssocData(interp
, "context", NULL
, old_context
);
663 if (retcode
== JIM_OK
)
664 retcode
= inner_retcode
;
666 context
->current_target_override
= saved_target_override
;
667 if (retcode
== JIM_OK
) {
671 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
673 command_output_text(context
, result
);
674 command_output_text(context
, "\n");
677 } else if (retcode
== JIM_EXIT
) {
679 * exit(Jim_GetExitCode(interp)); */
680 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
683 Jim_MakeErrorMessage(interp
);
684 /* error is broadcast */
685 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
687 if (retval
== ERROR_OK
) {
688 /* It wasn't a low level OpenOCD command that failed */
697 int command_run_linef(struct command_context
*context
, const char *format
, ...)
699 int retval
= ERROR_FAIL
;
702 va_start(ap
, format
);
703 string
= alloc_vprintf(format
, ap
);
704 if (string
!= NULL
) {
705 retval
= command_run_line(context
, string
);
712 void command_set_output_handler(struct command_context
*context
,
713 command_output_handler_t output_handler
, void *priv
)
715 context
->output_handler
= output_handler
;
716 context
->output_handler_priv
= priv
;
719 struct command_context
*copy_command_context(struct command_context
*context
)
721 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
723 *copy_context
= *context
;
728 void command_done(struct command_context
*cmd_ctx
)
736 /* find full path to file */
737 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
741 const char *file
= Jim_GetString(argv
[1], NULL
);
742 char *full_path
= find_file(file
);
743 if (full_path
== NULL
)
745 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
748 Jim_SetResult(interp
, result
);
752 COMMAND_HANDLER(jim_echo
)
754 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
755 LOG_USER_N("%s", CMD_ARGV
[1]);
760 LOG_USER("%s", CMD_ARGV
[0]);
764 /* Capture progress output and return as tcl return value. If the
765 * progress output was empty, return tcl return value.
767 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
772 struct log_capture_state
*state
= command_log_capture_start(interp
);
774 /* disable polling during capture. This avoids capturing output
777 * This is necessary in order to avoid accidentally getting a non-empty
778 * string for tcl fn's.
780 bool save_poll
= jtag_poll_get_enabled();
782 jtag_poll_set_enabled(false);
784 const char *str
= Jim_GetString(argv
[1], NULL
);
785 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
787 jtag_poll_set_enabled(save_poll
);
789 command_log_capture_finish(state
);
801 static COMMAND_HELPER(command_help_show
, struct help_entry
*c
,
802 bool show_help
, const char *cmd_match
);
804 static COMMAND_HELPER(command_help_show_list
, bool show_help
, const char *cmd_match
)
806 struct help_entry
*entry
;
808 list_for_each_entry(entry
, CMD_CTX
->help_list
, lh
)
809 CALL_COMMAND_HANDLER(command_help_show
, entry
, show_help
, cmd_match
);
813 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
815 static void command_help_show_indent(unsigned n
)
817 for (unsigned i
= 0; i
< n
; i
++)
820 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
822 const char *cp
= str
, *last
= str
;
824 const char *next
= last
;
829 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
830 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
831 if (next
- last
< HELP_LINE_WIDTH(n
))
833 command_help_show_indent(n
);
834 LOG_USER("%.*s", (int)(cp
- last
), last
);
840 static COMMAND_HELPER(command_help_show
, struct help_entry
*c
,
841 bool show_help
, const char *cmd_match
)
844 for (const char *s
= strchr(c
->cmd_name
, ' '); s
; s
= strchr(s
+ 1, ' '))
847 /* If the match string occurs anywhere, we print out
848 * stuff for this command. */
849 bool is_match
= (strstr(c
->cmd_name
, cmd_match
) != NULL
) ||
850 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
851 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
854 command_help_show_indent(n
);
855 LOG_USER_N("%s", c
->cmd_name
);
857 if (c
->usage
&& strlen(c
->usage
) > 0) {
859 command_help_show_wrap(c
->usage
, 0, n
+ 5);
864 if (is_match
&& show_help
) {
867 /* TODO: factorize jim_command_mode() to avoid running jim command here */
868 char *request
= alloc_printf("command mode %s", c
->cmd_name
);
870 LOG_ERROR("Out of memory");
873 int retval
= Jim_Eval(CMD_CTX
->interp
, request
);
875 enum command_mode mode
= COMMAND_UNKNOWN
;
876 if (retval
!= JIM_ERR
) {
877 const char *result
= Jim_GetString(Jim_GetResult(CMD_CTX
->interp
), NULL
);
878 if (!strcmp(result
, "any"))
880 else if (!strcmp(result
, "config"))
881 mode
= COMMAND_CONFIG
;
882 else if (!strcmp(result
, "exec"))
886 /* Normal commands are runtime-only; highlight exceptions */
887 if (mode
!= COMMAND_EXEC
) {
888 const char *stage_msg
= "";
892 stage_msg
= " (configuration command)";
895 stage_msg
= " (command valid any time)";
898 stage_msg
= " (?mode error?)";
901 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
903 msg
= alloc_printf("%s", c
->help
? : "");
906 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
915 COMMAND_HANDLER(handle_help_command
)
917 bool full
= strcmp(CMD_NAME
, "help") == 0;
922 cmd_match
= strdup("");
925 cmd_match
= strdup(CMD_ARGV
[0]);
927 for (unsigned int i
= 1; i
< CMD_ARGC
&& cmd_match
; ++i
) {
928 char *prev
= cmd_match
;
929 cmd_match
= alloc_printf("%s %s", prev
, CMD_ARGV
[i
]);
934 if (cmd_match
== NULL
) {
935 LOG_ERROR("unable to build search string");
938 retval
= CALL_COMMAND_HANDLER(command_help_show_list
, full
, cmd_match
);
944 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
945 struct command
*head
, struct command
**out
)
949 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
950 struct command
*c
= command_find(head
, cmd_name
);
954 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
);
957 static char *alloc_concatenate_strings(int argc
, Jim_Obj
* const *argv
)
964 all
= strdup(Jim_GetString(argv
[0], NULL
));
966 LOG_ERROR("Out of memory");
970 for (i
= 1; i
< argc
; ++i
) {
972 all
= alloc_printf("%s %s", all
, Jim_GetString(argv
[i
], NULL
));
975 LOG_ERROR("Out of memory");
983 static int run_usage(Jim_Interp
*interp
, int argc_valid
, int argc
, Jim_Obj
* const *argv
)
985 struct command_context
*cmd_ctx
= current_command_context(interp
);
989 assert(argc_valid
>= 1);
990 assert(argc
>= argc_valid
);
992 command
= alloc_concatenate_strings(argc_valid
, argv
);
996 retval
= command_run_linef(cmd_ctx
, "usage %s", command
);
997 if (retval
!= ERROR_OK
) {
998 LOG_ERROR("unable to execute command \"usage %s\"", command
);
1002 if (argc_valid
== argc
)
1003 LOG_ERROR("%s: command requires more arguments", command
);
1006 command
= alloc_concatenate_strings(argc
- argc_valid
, argv
+ argc_valid
);
1009 LOG_ERROR("invalid subcommand \"%s\"", command
);
1016 static int exec_command(Jim_Interp
*interp
, struct command_context
*cmd_ctx
,
1017 struct command
*c
, int argc
, Jim_Obj
*const *argv
)
1020 return c
->jim_handler(interp
, argc
, argv
);
1022 /* use c->handler */
1023 unsigned int nwords
;
1024 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
1028 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
1029 script_command_args_free(words
, nwords
);
1030 return command_retval_set(interp
, retval
);
1033 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1035 script_debug(interp
, argc
, argv
);
1037 struct command_context
*cmd_ctx
= current_command_context(interp
);
1038 struct command
*c
= cmd_ctx
->commands
;
1039 int remaining
= command_unknown_find(argc
, argv
, c
, &c
);
1040 /* if nothing could be consumed, then it's really an unknown command */
1041 if (remaining
== argc
) {
1042 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1043 LOG_ERROR("Unknown command:\n %s", cmd
);
1047 Jim_Obj
*const *start
;
1049 if (c
->handler
|| c
->jim_handler
) {
1050 /* include the command name in the list */
1051 count
= remaining
+ 1;
1052 start
= argv
+ (argc
- remaining
- 1);
1054 count
= argc
- remaining
;
1056 run_usage(interp
, count
, argc
, start
);
1060 if (!command_can_run(cmd_ctx
, c
))
1063 target_call_timer_callbacks_now();
1066 * Black magic of overridden current target:
1067 * If the command we are going to handle has a target prefix,
1068 * override the current target temporarily for the time
1069 * of processing the command.
1070 * current_target_override is used also for event handlers
1071 * therefore we prevent touching it if command has no prefix.
1072 * Previous override is saved and restored back to ensure
1073 * correct work when command_unknown() is re-entered.
1075 struct target
*saved_target_override
= cmd_ctx
->current_target_override
;
1076 if (c
->jim_override_target
)
1077 cmd_ctx
->current_target_override
= c
->jim_override_target
;
1079 int retval
= exec_command(interp
, cmd_ctx
, c
, count
, start
);
1081 if (c
->jim_override_target
)
1082 cmd_ctx
->current_target_override
= saved_target_override
;
1087 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1089 struct command_context
*cmd_ctx
= current_command_context(interp
);
1090 enum command_mode mode
;
1093 char *full_name
= alloc_concatenate_strings(argc
- 1, argv
+ 1);
1096 Jim_Obj
*s
= Jim_NewStringObj(interp
, full_name
, -1);
1097 Jim_IncrRefCount(s
);
1098 Jim_Cmd
*cmd
= Jim_GetCommand(interp
, s
, JIM_NONE
);
1099 Jim_DecrRefCount(interp
, s
);
1101 if (cmd
&& jimcmd_is_proc(cmd
)) {
1102 Jim_SetResultString(interp
, "any", -1);
1105 struct command
*c
= cmd_ctx
->commands
;
1106 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
);
1107 /* if nothing could be consumed, then it's an unknown command */
1108 if (remaining
== argc
- 1) {
1109 Jim_SetResultString(interp
, "unknown", -1);
1114 mode
= cmd_ctx
->mode
;
1116 const char *mode_str
;
1121 case COMMAND_CONFIG
:
1122 mode_str
= "config";
1128 mode_str
= "unknown";
1131 Jim_SetResultString(interp
, mode_str
, -1);
1135 int help_del_all_commands(struct command_context
*cmd_ctx
)
1137 struct help_entry
*curr
, *n
;
1139 list_for_each_entry_safe(curr
, n
, cmd_ctx
->help_list
, lh
) {
1140 list_del(&curr
->lh
);
1141 free(curr
->cmd_name
);
1149 static int help_del_command(struct command_context
*cmd_ctx
, const char *cmd_name
)
1151 struct help_entry
*curr
;
1153 list_for_each_entry(curr
, cmd_ctx
->help_list
, lh
) {
1154 if (!strcmp(cmd_name
, curr
->cmd_name
)) {
1155 list_del(&curr
->lh
);
1156 free(curr
->cmd_name
);
1167 static int help_add_command(struct command_context
*cmd_ctx
,
1168 const char *cmd_name
, const char *help_text
, const char *usage_text
)
1170 int cmp
= -1; /* add after curr */
1171 struct help_entry
*curr
;
1173 list_for_each_entry_reverse(curr
, cmd_ctx
->help_list
, lh
) {
1174 cmp
= strcmp(cmd_name
, curr
->cmd_name
);
1179 struct help_entry
*entry
;
1181 entry
= calloc(1, sizeof(*entry
));
1183 LOG_ERROR("Out of memory");
1186 entry
->cmd_name
= strdup(cmd_name
);
1187 if (!entry
->cmd_name
) {
1188 LOG_ERROR("Out of memory");
1192 list_add(&entry
->lh
, &curr
->lh
);
1198 char *text
= strdup(help_text
);
1200 LOG_ERROR("Out of memory");
1208 char *text
= strdup(usage_text
);
1210 LOG_ERROR("Out of memory");
1214 entry
->usage
= text
;
1220 COMMAND_HANDLER(handle_help_add_command
)
1223 return ERROR_COMMAND_SYNTAX_ERROR
;
1225 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? CMD_ARGV
[1] : NULL
;
1226 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? CMD_ARGV
[1] : NULL
;
1227 if (!help
&& !usage
) {
1228 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1229 return ERROR_COMMAND_SYNTAX_ERROR
;
1231 const char *cmd_name
= CMD_ARGV
[0];
1232 return help_add_command(CMD_CTX
, cmd_name
, help
, usage
);
1235 /* sleep command sleeps for <n> milliseconds
1236 * this is useful in target startup scripts
1238 COMMAND_HANDLER(handle_sleep_command
)
1241 if (CMD_ARGC
== 2) {
1242 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1245 return ERROR_COMMAND_SYNTAX_ERROR
;
1246 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1247 return ERROR_COMMAND_SYNTAX_ERROR
;
1249 unsigned long duration
= 0;
1250 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1251 if (ERROR_OK
!= retval
)
1255 int64_t then
= timeval_ms();
1256 while (timeval_ms() - then
< (int64_t)duration
) {
1257 target_call_timer_callbacks_now();
1261 busy_sleep(duration
);
1266 static const struct command_registration command_subcommand_handlers
[] = {
1269 .mode
= COMMAND_ANY
,
1270 .jim_handler
= jim_command_mode
,
1271 .usage
= "[command_name ...]",
1272 .help
= "Returns the command modes allowed by a command: "
1273 "'any', 'config', or 'exec'. If no command is "
1274 "specified, returns the current command mode. "
1275 "Returns 'unknown' if an unknown command is given. "
1276 "Command can be multiple tokens.",
1278 COMMAND_REGISTRATION_DONE
1281 static const struct command_registration command_builtin_handlers
[] = {
1284 .mode
= COMMAND_ANY
,
1285 .jim_handler
= jim_find
,
1286 .help
= "find full path to file",
1291 .mode
= COMMAND_ANY
,
1292 .jim_handler
= jim_capture
,
1293 .help
= "Capture progress output and return as tcl return value. If the "
1294 "progress output was empty, return tcl return value.",
1299 .handler
= jim_echo
,
1300 .mode
= COMMAND_ANY
,
1301 .help
= "Logs a message at \"user\" priority. "
1302 "Output message to stdout. "
1303 "Option \"-n\" suppresses trailing newline",
1304 .usage
= "[-n] string",
1307 .name
= "add_help_text",
1308 .handler
= handle_help_add_command
,
1309 .mode
= COMMAND_ANY
,
1310 .help
= "Add new command help text; "
1311 "Command can be multiple tokens.",
1312 .usage
= "command_name helptext_string",
1315 .name
= "add_usage_text",
1316 .handler
= handle_help_add_command
,
1317 .mode
= COMMAND_ANY
,
1318 .help
= "Add new command usage text; "
1319 "command can be multiple tokens.",
1320 .usage
= "command_name usage_string",
1324 .handler
= handle_sleep_command
,
1325 .mode
= COMMAND_ANY
,
1326 .help
= "Sleep for specified number of milliseconds. "
1327 "\"busy\" will busy wait instead (avoid this).",
1328 .usage
= "milliseconds ['busy']",
1332 .handler
= handle_help_command
,
1333 .mode
= COMMAND_ANY
,
1334 .help
= "Show full command help; "
1335 "command can be multiple tokens.",
1336 .usage
= "[command_name]",
1340 .handler
= handle_help_command
,
1341 .mode
= COMMAND_ANY
,
1342 .help
= "Show basic command usage; "
1343 "command can be multiple tokens.",
1344 .usage
= "[command_name]",
1348 .mode
= COMMAND_ANY
,
1349 .help
= "core command group (introspection)",
1350 .chain
= command_subcommand_handlers
,
1353 COMMAND_REGISTRATION_DONE
1356 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1358 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1361 context
->mode
= COMMAND_EXEC
;
1363 /* context can be duplicated. Put list head on separate mem-chunk to keep list consistent */
1364 context
->help_list
= malloc(sizeof(*context
->help_list
));
1365 INIT_LIST_HEAD(context
->help_list
);
1367 /* Create a jim interpreter if we were not handed one */
1368 if (interp
== NULL
) {
1369 /* Create an interpreter */
1370 interp
= Jim_CreateInterp();
1371 /* Add all the Jim core commands */
1372 Jim_RegisterCoreCommands(interp
);
1373 Jim_InitStaticExtensions(interp
);
1376 context
->interp
= interp
;
1378 /* Stick to lowercase for HostOS strings. */
1379 #if defined(_MSC_VER)
1380 /* WinXX - is generic, the forward
1381 * looking problem is this:
1383 * "win32" or "win64"
1385 * "winxx" is generic.
1388 #elif defined(__linux__)
1390 #elif defined(__APPLE__) || defined(__DARWIN__)
1392 #elif defined(__CYGWIN__)
1394 #elif defined(__MINGW32__)
1396 #elif defined(__ECOS)
1398 #elif defined(__FreeBSD__)
1400 #elif defined(__NetBSD__)
1402 #elif defined(__OpenBSD__)
1405 #warning "Unrecognized host OS..."
1408 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1409 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1411 register_commands(context
, NULL
, command_builtin_handlers
);
1413 Jim_SetAssocData(interp
, "context", NULL
, context
);
1414 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1415 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1416 Jim_MakeErrorMessage(interp
);
1417 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1420 Jim_DeleteAssocData(interp
, "context");
1425 void command_exit(struct command_context
*context
)
1430 Jim_FreeInterp(context
->interp
);
1431 free(context
->help_list
);
1432 command_done(context
);
1435 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1438 return ERROR_COMMAND_SYNTAX_ERROR
;
1440 cmd_ctx
->mode
= mode
;
1444 void process_jim_events(struct command_context
*cmd_ctx
)
1446 static int recursion
;
1451 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1455 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1456 int parse ## name(const char *str, type * ul) \
1459 LOG_ERROR("Invalid command argument"); \
1460 return ERROR_COMMAND_ARGUMENT_INVALID; \
1464 *ul = func(str, &end, 0); \
1466 LOG_ERROR("Invalid command argument"); \
1467 return ERROR_COMMAND_ARGUMENT_INVALID; \
1469 if ((max == *ul) && (ERANGE == errno)) { \
1470 LOG_ERROR("Argument overflow"); \
1471 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1473 if (min && (min == *ul) && (ERANGE == errno)) { \
1474 LOG_ERROR("Argument underflow"); \
1475 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1479 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1480 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1481 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1482 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1484 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1485 int parse ## name(const char *str, type * ul) \
1488 int retval = parse ## funcname(str, &n); \
1489 if (ERROR_OK != retval) \
1492 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1494 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1499 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1500 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1501 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1502 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1503 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1504 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1505 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1507 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1509 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1510 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1511 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1512 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1513 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1514 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1515 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1517 static int command_parse_bool(const char *in
, bool *out
,
1518 const char *on
, const char *off
)
1520 if (strcasecmp(in
, on
) == 0)
1522 else if (strcasecmp(in
, off
) == 0)
1525 return ERROR_COMMAND_SYNTAX_ERROR
;
1529 int command_parse_bool_arg(const char *in
, bool *out
)
1531 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1533 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1535 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1537 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1539 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1541 return ERROR_COMMAND_SYNTAX_ERROR
;
1544 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1548 const char *in
= CMD_ARGV
[0];
1549 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1550 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1551 return ERROR_COMMAND_SYNTAX_ERROR
;
1556 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1559 return ERROR_COMMAND_SYNTAX_ERROR
;
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)