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
);
56 /* wrap jimtcl internal data */
57 static inline bool jimcmd_is_proc(Jim_Cmd
*cmd
)
62 static void tcl_output(void *privData
, const char *file
, unsigned line
,
63 const char *function
, const char *string
)
65 struct log_capture_state
*state
= privData
;
66 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
69 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
71 /* capture log output and return it. A garbage collect can
72 * happen, so we need a reference count to this object */
73 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
74 if (NULL
== tclOutput
)
77 struct log_capture_state
*state
= malloc(sizeof(*state
));
81 state
->interp
= interp
;
82 Jim_IncrRefCount(tclOutput
);
83 state
->output
= tclOutput
;
85 log_add_callback(tcl_output
, state
);
90 /* Classic openocd commands provide progress output which we
91 * will capture and return as a Tcl return value.
93 * However, if a non-openocd command has been invoked, then it
94 * makes sense to return the tcl return value from that command.
96 * The tcl return value is empty for openocd commands that provide
99 * Therefore we set the tcl return value only if we actually
102 static void command_log_capture_finish(struct log_capture_state
*state
)
107 log_remove_callback(tcl_output
, state
);
110 Jim_GetString(state
->output
, &length
);
113 Jim_SetResult(state
->interp
, state
->output
);
115 /* No output captured, use tcl return value (which could
118 Jim_DecrRefCount(state
->interp
, state
->output
);
124 * FIXME: workaround for memory leak in jimtcl 0.80
125 * Jim API Jim_CreateCommand() converts the command name in a Jim object and
126 * does not free the object. Fixed for jimtcl 0.81 by e4416cf86f0b
127 * Use the internal jimtcl API Jim_CreateCommandObj, not exported by jim.h,
128 * and override the bugged API through preprocessor's macro.
129 * This workaround works only when jimtcl is compiled as OpenOCD submodule.
130 * If jimtcl is linked-in from a precompiled library, either static or dynamic,
131 * the symbol Jim_CreateCommandObj is not exported and the build will use the
133 * To be removed when OpenOCD will switch to jimtcl 0.81
135 #if JIM_VERSION == 80
136 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
137 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
);
138 int Jim_CreateCommandObj(Jim_Interp
*interp
, Jim_Obj
*cmdNameObj
,
139 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
140 __attribute__((weak
, alias("workaround_createcommand")));
141 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
142 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
144 if ((void *)Jim_CreateCommandObj
== (void *)workaround_createcommand
)
145 return Jim_CreateCommand(interp
, cmdName
, cmdProc
, privData
, delProc
);
147 Jim_Obj
*cmd_name
= Jim_NewStringObj(interp
, cmdName
, -1);
148 Jim_IncrRefCount(cmd_name
);
149 int retval
= Jim_CreateCommandObj(interp
, cmd_name
, cmdProc
, privData
, delProc
);
150 Jim_DecrRefCount(interp
, cmd_name
);
153 #define Jim_CreateCommand workaround_createcommand
154 #endif /* JIM_VERSION == 80 */
155 /* FIXME: end of workaround for memory leak in jimtcl 0.80 */
157 static int command_retval_set(Jim_Interp
*interp
, int retval
)
159 int *return_retval
= Jim_GetAssocData(interp
, "retval");
160 if (return_retval
!= NULL
)
161 *return_retval
= retval
;
163 return (retval
== ERROR_OK
) ? JIM_OK
: retval
;
166 extern struct command_context
*global_cmd_ctx
;
168 /* dump a single line to the log for the command.
169 * Do nothing in case we are not at debug level 3 */
170 void script_debug(Jim_Interp
*interp
, unsigned int argc
, Jim_Obj
* const *argv
)
172 if (debug_level
< LOG_LVL_DEBUG
)
175 char *dbg
= alloc_printf("command -");
176 for (unsigned i
= 0; i
< argc
; i
++) {
178 const char *w
= Jim_GetString(argv
[i
], &len
);
179 char *t
= alloc_printf("%s %s", dbg
, w
);
183 LOG_DEBUG("%s", dbg
);
187 static void script_command_args_free(char **words
, unsigned nwords
)
189 for (unsigned i
= 0; i
< nwords
; i
++)
194 static char **script_command_args_alloc(
195 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
197 char **words
= malloc(argc
* sizeof(char *));
202 for (i
= 0; i
< argc
; i
++) {
204 const char *w
= Jim_GetString(argv
[i
], &len
);
205 words
[i
] = strdup(w
);
206 if (words
[i
] == NULL
) {
207 script_command_args_free(words
, i
);
215 struct command_context
*current_command_context(Jim_Interp
*interp
)
217 /* grab the command context from the associated data */
218 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
219 if (NULL
== cmd_ctx
) {
220 /* Tcl can invoke commands directly instead of via command_run_line(). This would
221 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
222 * commands in a startup script.
224 * A telnet or gdb server would provide a non-default command context to
225 * handle piping of error output, have a separate current target, etc.
227 cmd_ctx
= global_cmd_ctx
;
232 static struct command
*command_root(struct command
*c
)
234 while (NULL
!= c
->parent
)
240 * Find a command by name from a list of commands.
241 * @returns Returns the named command if it exists in the list.
242 * Returns NULL otherwise.
244 static struct command
*command_find(struct command
*head
, const char *name
)
246 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
247 if (strcmp(cc
->name
, name
) == 0)
254 * Add the command into the linked list, sorted by name.
255 * @param head Address to head of command list pointer, which may be
256 * updated if @c c gets inserted at the beginning of the list.
257 * @param c The command to add to the list pointed to by @c head.
259 static void command_add_child(struct command
**head
, struct command
*c
)
267 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
268 head
= &(*head
)->next
;
270 if (strcmp(c
->name
, (*head
)->name
) > 0) {
271 c
->next
= (*head
)->next
;
279 static struct command
**command_list_for_parent(
280 struct command_context
*cmd_ctx
, struct command
*parent
)
282 return parent
? &parent
->children
: &cmd_ctx
->commands
;
285 static void command_free(struct command
*c
)
287 /** @todo if command has a handler, unregister its jim command! */
289 while (NULL
!= c
->children
) {
290 struct command
*tmp
= c
->children
;
291 c
->children
= tmp
->next
;
301 static struct command
*command_new(struct command_context
*cmd_ctx
,
302 struct command
*parent
, const struct command_registration
*cr
)
307 * If it is a non-jim command with no .usage specified,
310 * strlen(.usage) == 0 means that the command takes no
313 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
314 LOG_ERROR("BUG: command '%s%s%s' does not have the "
315 "'.usage' field filled out",
316 parent
&& parent
->name
? parent
->name
: "",
317 parent
&& parent
->name
? " " : "",
321 struct command
*c
= calloc(1, sizeof(struct command
));
325 c
->name
= strdup(cr
->name
);
327 c
->help
= strdup(cr
->help
);
329 c
->usage
= strdup(cr
->usage
);
331 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
332 goto command_new_error
;
335 c
->handler
= cr
->handler
;
336 c
->jim_handler
= cr
->jim_handler
;
339 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
348 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
350 static int register_command_handler(struct command_context
*cmd_ctx
,
353 Jim_Interp
*interp
= cmd_ctx
->interp
;
356 LOG_DEBUG("registering '%s'...", c
->name
);
359 return Jim_CreateCommand(interp
, c
->name
, command_unknown
, c
, NULL
);
362 static struct command
*register_command(struct command_context
*context
,
363 struct command
*parent
, const struct command_registration
*cr
)
365 if (!context
|| !cr
->name
)
368 const char *name
= cr
->name
;
369 struct command
**head
= command_list_for_parent(context
, parent
);
370 struct command
*c
= command_find(*head
, name
);
372 /* TODO: originally we treated attempting to register a cmd twice as an error
373 * Sometimes we need this behaviour, such as with flash banks.
374 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
375 LOG_DEBUG("command '%s' is already registered in '%s' context",
376 name
, parent
? parent
->name
: "<global>");
380 c
= command_new(context
, parent
, cr
);
384 if (cr
->jim_handler
|| cr
->handler
) {
385 int retval
= register_command_handler(context
, command_root(c
));
386 if (retval
!= JIM_OK
) {
387 unregister_command(context
, parent
, name
);
394 static int ___register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
395 const struct command_registration
*cmds
, void *data
,
396 struct target
*override_target
)
398 int retval
= ERROR_OK
;
400 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
401 const struct command_registration
*cr
= cmds
+ i
;
403 struct command
*c
= NULL
;
404 if (NULL
!= cr
->name
) {
405 c
= register_command(cmd_ctx
, parent
, cr
);
410 c
->jim_handler_data
= data
;
411 c
->jim_override_target
= override_target
;
413 if (NULL
!= cr
->chain
) {
414 struct command
*p
= c
? : parent
;
415 retval
= ___register_commands(cmd_ctx
, p
, cr
->chain
, data
, override_target
);
416 if (ERROR_OK
!= retval
)
420 if (ERROR_OK
!= retval
) {
421 for (unsigned j
= 0; j
< i
; j
++)
422 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
427 int __register_commands(struct command_context
*cmd_ctx
, const char *cmd_prefix
,
428 const struct command_registration
*cmds
, void *data
,
429 struct target
*override_target
)
431 struct command
*parent
= NULL
;
434 parent
= command_find(cmd_ctx
->commands
, cmd_prefix
);
436 return ___register_commands(cmd_ctx
, parent
, cmds
, data
, override_target
);
439 int unregister_all_commands(struct command_context
*context
,
440 struct command
*parent
)
445 struct command
**head
= command_list_for_parent(context
, parent
);
446 while (NULL
!= *head
) {
447 struct command
*tmp
= *head
;
455 static int unregister_command(struct command_context
*context
,
456 struct command
*parent
, const char *name
)
458 if ((!context
) || (!name
))
459 return ERROR_COMMAND_SYNTAX_ERROR
;
461 struct command
*p
= NULL
;
462 struct command
**head
= command_list_for_parent(context
, parent
);
463 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
464 if (strcmp(name
, c
->name
) != 0)
479 void command_output_text(struct command_context
*context
, const char *data
)
481 if (context
&& context
->output_handler
&& data
)
482 context
->output_handler(context
, data
);
485 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
490 va_start(ap
, format
);
492 string
= alloc_vprintf(format
, ap
);
493 if (string
!= NULL
&& cmd
) {
494 /* we want this collected in the log + we also want to pick it up as a tcl return
497 * The latter bit isn't precisely neat, but will do for now.
499 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
500 /* We already printed it above
501 * command_output_text(context, string); */
508 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
513 va_start(ap
, format
);
515 string
= alloc_vprintf(format
, ap
);
516 if (string
!= NULL
&& cmd
) {
517 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
519 /* we want this collected in the log + we also want to pick it up as a tcl return
522 * The latter bit isn't precisely neat, but will do for now.
524 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
525 /* We already printed it above
526 * command_output_text(context, string); */
533 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
536 unsigned len
= strlen(c
->name
);
537 if (NULL
== c
->parent
) {
538 /* allocate enough for the name, child names, and '\0' */
539 name
= malloc(len
+ extra
+ 1);
541 LOG_ERROR("Out of memory");
544 strcpy(name
, c
->name
);
546 /* parent's extra must include both the space and name */
547 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
548 char dstr
[2] = { delim
, 0 };
550 strcat(name
, c
->name
);
555 static char *command_name(struct command
*c
, char delim
)
557 return __command_name(c
, delim
, 0);
560 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
562 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
565 /* Many commands may be run only before/after 'init' */
574 /* handle the impossible with humor; it guarantees a bug report! */
576 when
= "if Cthulhu is summoned by";
579 char *full_name
= command_name(c
, ' ');
580 LOG_ERROR("The '%s' command must be used %s 'init'.",
581 full_name
? full_name
: c
->name
, when
);
586 static int run_command(struct command_context
*context
,
587 struct command
*c
, const char **words
, unsigned num_words
)
589 struct command_invocation cmd
= {
593 .argc
= num_words
- 1,
597 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
598 Jim_IncrRefCount(cmd
.output
);
600 int retval
= c
->handler(&cmd
);
601 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
602 /* Print help for command */
603 char *full_name
= command_name(c
, ' ');
604 if (NULL
!= full_name
) {
605 command_run_linef(context
, "usage %s", full_name
);
608 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
609 /* just fall through for a shutdown request */
611 if (retval
!= ERROR_OK
) {
612 char *full_name
= command_name(c
, ' ');
613 LOG_DEBUG("Command '%s' failed with error code %d",
614 full_name
? full_name
: c
->name
, retval
);
617 /* Use the command output as the Tcl result */
618 Jim_SetResult(context
->interp
, cmd
.output
);
620 Jim_DecrRefCount(context
->interp
, cmd
.output
);
625 int command_run_line(struct command_context
*context
, char *line
)
627 /* all the parent commands have been registered with the interpreter
628 * so, can just evaluate the line as a script and check for
631 /* run the line thru a script engine */
632 int retval
= ERROR_FAIL
;
634 /* Beware! This code needs to be reentrant. It is also possible
635 * for OpenOCD commands to be invoked directly from Tcl. This would
636 * happen when the Jim Tcl interpreter is provided by eCos for
639 struct target
*saved_target_override
= context
->current_target_override
;
640 context
->current_target_override
= NULL
;
642 Jim_Interp
*interp
= context
->interp
;
643 struct command_context
*old_context
= Jim_GetAssocData(interp
, "context");
644 Jim_DeleteAssocData(interp
, "context");
645 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
646 if (retcode
== JIM_OK
) {
647 /* associated the return value */
648 Jim_DeleteAssocData(interp
, "retval");
649 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
650 if (retcode
== JIM_OK
) {
651 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
653 Jim_DeleteAssocData(interp
, "retval");
655 Jim_DeleteAssocData(interp
, "context");
656 int inner_retcode
= Jim_SetAssocData(interp
, "context", NULL
, old_context
);
657 if (retcode
== JIM_OK
)
658 retcode
= inner_retcode
;
660 context
->current_target_override
= saved_target_override
;
661 if (retcode
== JIM_OK
) {
665 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
667 command_output_text(context
, result
);
668 command_output_text(context
, "\n");
671 } else if (retcode
== JIM_EXIT
) {
673 * exit(Jim_GetExitCode(interp)); */
674 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
677 Jim_MakeErrorMessage(interp
);
678 /* error is broadcast */
679 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
681 if (retval
== ERROR_OK
) {
682 /* It wasn't a low level OpenOCD command that failed */
691 int command_run_linef(struct command_context
*context
, const char *format
, ...)
693 int retval
= ERROR_FAIL
;
696 va_start(ap
, format
);
697 string
= alloc_vprintf(format
, ap
);
698 if (string
!= NULL
) {
699 retval
= command_run_line(context
, string
);
706 void command_set_output_handler(struct command_context
*context
,
707 command_output_handler_t output_handler
, void *priv
)
709 context
->output_handler
= output_handler
;
710 context
->output_handler_priv
= priv
;
713 struct command_context
*copy_command_context(struct command_context
*context
)
715 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
717 *copy_context
= *context
;
722 void command_done(struct command_context
*cmd_ctx
)
730 /* find full path to file */
731 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
735 const char *file
= Jim_GetString(argv
[1], NULL
);
736 char *full_path
= find_file(file
);
737 if (full_path
== NULL
)
739 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
742 Jim_SetResult(interp
, result
);
746 COMMAND_HANDLER(jim_echo
)
748 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
749 LOG_USER_N("%s", CMD_ARGV
[1]);
754 LOG_USER("%s", CMD_ARGV
[0]);
758 /* Capture progress output and return as tcl return value. If the
759 * progress output was empty, return tcl return value.
761 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
766 struct log_capture_state
*state
= command_log_capture_start(interp
);
768 /* disable polling during capture. This avoids capturing output
771 * This is necessary in order to avoid accidentally getting a non-empty
772 * string for tcl fn's.
774 bool save_poll
= jtag_poll_get_enabled();
776 jtag_poll_set_enabled(false);
778 const char *str
= Jim_GetString(argv
[1], NULL
);
779 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
781 jtag_poll_set_enabled(save_poll
);
783 command_log_capture_finish(state
);
788 static COMMAND_HELPER(command_help_find
, struct command
*head
,
789 struct command
**out
)
792 return ERROR_COMMAND_SYNTAX_ERROR
;
793 *out
= command_find(head
, CMD_ARGV
[0]);
795 return ERROR_COMMAND_SYNTAX_ERROR
;
799 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
802 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
803 bool show_help
, const char *cmd_match
);
805 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
806 bool show_help
, const char *cmd_match
)
808 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
809 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, 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 command
*c
, unsigned n
,
841 bool show_help
, const char *cmd_match
)
843 char *cmd_name
= command_name(c
, ' ');
844 if (NULL
== cmd_name
)
847 /* If the match string occurs anywhere, we print out
848 * stuff for this command. */
849 bool is_match
= (strstr(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", cmd_name
);
860 if (c
->usage
&& strlen(c
->usage
) > 0) {
862 command_help_show_wrap(c
->usage
, 0, n
+ 5);
867 if (is_match
&& show_help
) {
870 /* Normal commands are runtime-only; highlight exceptions */
871 if (c
->mode
!= COMMAND_EXEC
) {
872 const char *stage_msg
= "";
876 stage_msg
= " (configuration command)";
879 stage_msg
= " (command valid any time)";
882 stage_msg
= " (?mode error?)";
885 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
887 msg
= alloc_printf("%s", c
->help
? : "");
890 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
897 LOG_ERROR("command recursion exceeded");
901 return CALL_COMMAND_HANDLER(command_help_show_list
,
902 c
->children
, n
, show_help
, cmd_match
);
905 COMMAND_HANDLER(handle_help_command
)
907 bool full
= strcmp(CMD_NAME
, "help") == 0;
909 struct command
*c
= CMD_CTX
->commands
;
913 cmd_match
= strdup("");
916 cmd_match
= strdup(CMD_ARGV
[0]);
918 for (unsigned int i
= 1; i
< CMD_ARGC
&& cmd_match
; ++i
) {
919 char *prev
= cmd_match
;
920 cmd_match
= alloc_printf("%s %s", prev
, CMD_ARGV
[i
]);
925 if (cmd_match
== NULL
) {
926 LOG_ERROR("unable to build search string");
929 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
930 c
, 0, full
, cmd_match
);
936 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
937 struct command
*head
, struct command
**out
)
941 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
942 struct command
*c
= command_find(head
, cmd_name
);
946 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
);
949 static char *alloc_concatenate_strings(int argc
, Jim_Obj
* const *argv
)
956 all
= strdup(Jim_GetString(argv
[0], NULL
));
958 LOG_ERROR("Out of memory");
962 for (i
= 1; i
< argc
; ++i
) {
964 all
= alloc_printf("%s %s", all
, Jim_GetString(argv
[i
], NULL
));
967 LOG_ERROR("Out of memory");
975 static int run_usage(Jim_Interp
*interp
, int argc_valid
, int argc
, Jim_Obj
* const *argv
)
977 struct command_context
*cmd_ctx
= current_command_context(interp
);
981 assert(argc_valid
>= 1);
982 assert(argc
>= argc_valid
);
984 command
= alloc_concatenate_strings(argc_valid
, argv
);
988 retval
= command_run_linef(cmd_ctx
, "usage %s", command
);
989 if (retval
!= ERROR_OK
) {
990 LOG_ERROR("unable to execute command \"usage %s\"", command
);
994 if (argc_valid
== argc
)
995 LOG_ERROR("%s: command requires more arguments", command
);
998 command
= alloc_concatenate_strings(argc
- argc_valid
, argv
+ argc_valid
);
1001 LOG_ERROR("invalid subcommand \"%s\"", command
);
1008 static int exec_command(Jim_Interp
*interp
, struct command_context
*cmd_ctx
,
1009 struct command
*c
, int argc
, Jim_Obj
*const *argv
)
1012 return c
->jim_handler(interp
, argc
, argv
);
1014 /* use c->handler */
1015 unsigned int nwords
;
1016 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
1020 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
1021 script_command_args_free(words
, nwords
);
1022 return command_retval_set(interp
, retval
);
1025 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1027 script_debug(interp
, argc
, argv
);
1029 struct command_context
*cmd_ctx
= current_command_context(interp
);
1030 struct command
*c
= cmd_ctx
->commands
;
1031 int remaining
= command_unknown_find(argc
, argv
, c
, &c
);
1032 /* if nothing could be consumed, then it's really an unknown command */
1033 if (remaining
== argc
) {
1034 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1035 LOG_ERROR("Unknown command:\n %s", cmd
);
1039 Jim_Obj
*const *start
;
1041 if (c
->handler
|| c
->jim_handler
) {
1042 /* include the command name in the list */
1043 count
= remaining
+ 1;
1044 start
= argv
+ (argc
- remaining
- 1);
1046 count
= argc
- remaining
;
1048 run_usage(interp
, count
, argc
, start
);
1052 if (!command_can_run(cmd_ctx
, c
))
1055 target_call_timer_callbacks_now();
1058 * Black magic of overridden current target:
1059 * If the command we are going to handle has a target prefix,
1060 * override the current target temporarily for the time
1061 * of processing the command.
1062 * current_target_override is used also for event handlers
1063 * therefore we prevent touching it if command has no prefix.
1064 * Previous override is saved and restored back to ensure
1065 * correct work when command_unknown() is re-entered.
1067 struct target
*saved_target_override
= cmd_ctx
->current_target_override
;
1068 if (c
->jim_override_target
)
1069 cmd_ctx
->current_target_override
= c
->jim_override_target
;
1071 int retval
= exec_command(interp
, cmd_ctx
, c
, count
, start
);
1073 if (c
->jim_override_target
)
1074 cmd_ctx
->current_target_override
= saved_target_override
;
1079 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1081 struct command_context
*cmd_ctx
= current_command_context(interp
);
1082 enum command_mode mode
;
1085 char *full_name
= alloc_concatenate_strings(argc
- 1, argv
+ 1);
1088 Jim_Obj
*s
= Jim_NewStringObj(interp
, full_name
, -1);
1089 Jim_IncrRefCount(s
);
1090 Jim_Cmd
*cmd
= Jim_GetCommand(interp
, s
, JIM_NONE
);
1091 Jim_DecrRefCount(interp
, s
);
1093 if (cmd
&& jimcmd_is_proc(cmd
)) {
1094 Jim_SetResultString(interp
, "any", -1);
1097 struct command
*c
= cmd_ctx
->commands
;
1098 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
);
1099 /* if nothing could be consumed, then it's an unknown command */
1100 if (remaining
== argc
- 1) {
1101 Jim_SetResultString(interp
, "unknown", -1);
1106 mode
= cmd_ctx
->mode
;
1108 const char *mode_str
;
1113 case COMMAND_CONFIG
:
1114 mode_str
= "config";
1120 mode_str
= "unknown";
1123 Jim_SetResultString(interp
, mode_str
, -1);
1127 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1128 const char *cmd_name
, const char *help_text
, const char *usage
)
1130 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1131 struct command
*nc
= command_find(*head
, cmd_name
);
1133 /* add a new command with help text */
1134 struct command_registration cr
= {
1136 .mode
= COMMAND_ANY
,
1138 .usage
= usage
? : "",
1140 nc
= register_command(cmd_ctx
, parent
, &cr
);
1142 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1145 LOG_DEBUG("added '%s' help text", cmd_name
);
1149 bool replaced
= false;
1154 nc
->help
= strdup(help_text
);
1156 LOG_INFO("replaced existing '%s' help", cmd_name
);
1158 LOG_DEBUG("added '%s' help text", cmd_name
);
1161 bool replaced
= false;
1167 nc
->usage
= strdup(usage
);
1169 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1171 LOG_DEBUG("added '%s' usage text", cmd_name
);
1176 COMMAND_HANDLER(handle_help_add_command
)
1179 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1180 return ERROR_COMMAND_SYNTAX_ERROR
;
1183 /* save help text and remove it from argument list */
1184 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1185 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1186 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1187 if (!help
&& !usage
) {
1188 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1189 return ERROR_COMMAND_SYNTAX_ERROR
;
1191 /* likewise for the leaf command name */
1192 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1194 struct command
*c
= NULL
;
1196 c
= CMD_CTX
->commands
;
1197 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1198 if (ERROR_OK
!= retval
)
1201 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1204 /* sleep command sleeps for <n> milliseconds
1205 * this is useful in target startup scripts
1207 COMMAND_HANDLER(handle_sleep_command
)
1210 if (CMD_ARGC
== 2) {
1211 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1214 return ERROR_COMMAND_SYNTAX_ERROR
;
1215 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1216 return ERROR_COMMAND_SYNTAX_ERROR
;
1218 unsigned long duration
= 0;
1219 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1220 if (ERROR_OK
!= retval
)
1224 int64_t then
= timeval_ms();
1225 while (timeval_ms() - then
< (int64_t)duration
) {
1226 target_call_timer_callbacks_now();
1230 busy_sleep(duration
);
1235 static const struct command_registration command_subcommand_handlers
[] = {
1238 .mode
= COMMAND_ANY
,
1239 .jim_handler
= jim_command_mode
,
1240 .usage
= "[command_name ...]",
1241 .help
= "Returns the command modes allowed by a command: "
1242 "'any', 'config', or 'exec'. If no command is "
1243 "specified, returns the current command mode. "
1244 "Returns 'unknown' if an unknown command is given. "
1245 "Command can be multiple tokens.",
1247 COMMAND_REGISTRATION_DONE
1250 static const struct command_registration command_builtin_handlers
[] = {
1253 .mode
= COMMAND_ANY
,
1254 .jim_handler
= jim_find
,
1255 .help
= "find full path to file",
1260 .mode
= COMMAND_ANY
,
1261 .jim_handler
= jim_capture
,
1262 .help
= "Capture progress output and return as tcl return value. If the "
1263 "progress output was empty, return tcl return value.",
1268 .handler
= jim_echo
,
1269 .mode
= COMMAND_ANY
,
1270 .help
= "Logs a message at \"user\" priority. "
1271 "Output message to stdout. "
1272 "Option \"-n\" suppresses trailing newline",
1273 .usage
= "[-n] string",
1276 .name
= "add_help_text",
1277 .handler
= handle_help_add_command
,
1278 .mode
= COMMAND_ANY
,
1279 .help
= "Add new command help text; "
1280 "Command can be multiple tokens.",
1281 .usage
= "command_name helptext_string",
1284 .name
= "add_usage_text",
1285 .handler
= handle_help_add_command
,
1286 .mode
= COMMAND_ANY
,
1287 .help
= "Add new command usage text; "
1288 "command can be multiple tokens.",
1289 .usage
= "command_name usage_string",
1293 .handler
= handle_sleep_command
,
1294 .mode
= COMMAND_ANY
,
1295 .help
= "Sleep for specified number of milliseconds. "
1296 "\"busy\" will busy wait instead (avoid this).",
1297 .usage
= "milliseconds ['busy']",
1301 .handler
= handle_help_command
,
1302 .mode
= COMMAND_ANY
,
1303 .help
= "Show full command help; "
1304 "command can be multiple tokens.",
1305 .usage
= "[command_name]",
1309 .handler
= handle_help_command
,
1310 .mode
= COMMAND_ANY
,
1311 .help
= "Show basic command usage; "
1312 "command can be multiple tokens.",
1313 .usage
= "[command_name]",
1317 .mode
= COMMAND_ANY
,
1318 .help
= "core command group (introspection)",
1319 .chain
= command_subcommand_handlers
,
1322 COMMAND_REGISTRATION_DONE
1325 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1327 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1330 context
->mode
= COMMAND_EXEC
;
1332 /* Create a jim interpreter if we were not handed one */
1333 if (interp
== NULL
) {
1334 /* Create an interpreter */
1335 interp
= Jim_CreateInterp();
1336 /* Add all the Jim core commands */
1337 Jim_RegisterCoreCommands(interp
);
1338 Jim_InitStaticExtensions(interp
);
1341 context
->interp
= interp
;
1343 /* Stick to lowercase for HostOS strings. */
1344 #if defined(_MSC_VER)
1345 /* WinXX - is generic, the forward
1346 * looking problem is this:
1348 * "win32" or "win64"
1350 * "winxx" is generic.
1353 #elif defined(__linux__)
1355 #elif defined(__APPLE__) || defined(__DARWIN__)
1357 #elif defined(__CYGWIN__)
1359 #elif defined(__MINGW32__)
1361 #elif defined(__ECOS)
1363 #elif defined(__FreeBSD__)
1365 #elif defined(__NetBSD__)
1367 #elif defined(__OpenBSD__)
1370 #warning "Unrecognized host OS..."
1373 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1374 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1376 register_commands(context
, NULL
, command_builtin_handlers
);
1378 Jim_SetAssocData(interp
, "context", NULL
, context
);
1379 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1380 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1381 Jim_MakeErrorMessage(interp
);
1382 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1385 Jim_DeleteAssocData(interp
, "context");
1390 void command_exit(struct command_context
*context
)
1395 Jim_FreeInterp(context
->interp
);
1396 command_done(context
);
1399 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1402 return ERROR_COMMAND_SYNTAX_ERROR
;
1404 cmd_ctx
->mode
= mode
;
1408 void process_jim_events(struct command_context
*cmd_ctx
)
1410 static int recursion
;
1415 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1419 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1420 int parse ## name(const char *str, type * ul) \
1423 LOG_ERROR("Invalid command argument"); \
1424 return ERROR_COMMAND_ARGUMENT_INVALID; \
1428 *ul = func(str, &end, 0); \
1430 LOG_ERROR("Invalid command argument"); \
1431 return ERROR_COMMAND_ARGUMENT_INVALID; \
1433 if ((max == *ul) && (ERANGE == errno)) { \
1434 LOG_ERROR("Argument overflow"); \
1435 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1437 if (min && (min == *ul) && (ERANGE == errno)) { \
1438 LOG_ERROR("Argument underflow"); \
1439 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1443 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1444 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1445 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1446 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1448 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1449 int parse ## name(const char *str, type * ul) \
1452 int retval = parse ## funcname(str, &n); \
1453 if (ERROR_OK != retval) \
1456 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1458 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1463 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1464 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1465 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1466 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1467 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1468 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1469 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1471 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1473 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1474 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1475 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1476 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1477 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1478 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1479 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1481 static int command_parse_bool(const char *in
, bool *out
,
1482 const char *on
, const char *off
)
1484 if (strcasecmp(in
, on
) == 0)
1486 else if (strcasecmp(in
, off
) == 0)
1489 return ERROR_COMMAND_SYNTAX_ERROR
;
1493 int command_parse_bool_arg(const char *in
, bool *out
)
1495 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1497 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1499 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1501 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1503 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1505 return ERROR_COMMAND_SYNTAX_ERROR
;
1508 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1512 const char *in
= CMD_ARGV
[0];
1513 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1514 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1515 return ERROR_COMMAND_SYNTAX_ERROR
;
1520 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1523 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)