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 static void tcl_output(void *privData
, const char *file
, unsigned line
,
57 const char *function
, const char *string
)
59 struct log_capture_state
*state
= privData
;
60 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
63 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
65 /* capture log output and return it. A garbage collect can
66 * happen, so we need a reference count to this object */
67 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
68 if (NULL
== tclOutput
)
71 struct log_capture_state
*state
= malloc(sizeof(*state
));
75 state
->interp
= interp
;
76 Jim_IncrRefCount(tclOutput
);
77 state
->output
= tclOutput
;
79 log_add_callback(tcl_output
, state
);
84 /* Classic openocd commands provide progress output which we
85 * will capture and return as a Tcl return value.
87 * However, if a non-openocd command has been invoked, then it
88 * makes sense to return the tcl return value from that command.
90 * The tcl return value is empty for openocd commands that provide
93 * Therefore we set the tcl return value only if we actually
96 static void command_log_capture_finish(struct log_capture_state
*state
)
101 log_remove_callback(tcl_output
, state
);
104 Jim_GetString(state
->output
, &length
);
107 Jim_SetResult(state
->interp
, state
->output
);
109 /* No output captured, use tcl return value (which could
112 Jim_DecrRefCount(state
->interp
, state
->output
);
118 * FIXME: workaround for memory leak in jimtcl 0.80
119 * Jim API Jim_CreateCommand() converts the command name in a Jim object and
120 * does not free the object. Fixed for jimtcl 0.81 by e4416cf86f0b
121 * Use the internal jimtcl API Jim_CreateCommandObj, not exported by jim.h,
122 * and override the bugged API through preprocessor's macro.
123 * This workaround works only when jimtcl is compiled as OpenOCD submodule.
124 * If jimtcl is linked-in from a precompiled library, either static or dynamic,
125 * the symbol Jim_CreateCommandObj is not exported and the build will use the
127 * To be removed when OpenOCD will switch to jimtcl 0.81
129 #if JIM_VERSION == 80
130 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
131 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
);
132 int Jim_CreateCommandObj(Jim_Interp
*interp
, Jim_Obj
*cmdNameObj
,
133 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
134 __attribute__((weak
, alias("workaround_createcommand")));
135 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
136 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
138 if ((void *)Jim_CreateCommandObj
== (void *)workaround_createcommand
)
139 return Jim_CreateCommand(interp
, cmdName
, cmdProc
, privData
, delProc
);
141 Jim_Obj
*cmd_name
= Jim_NewStringObj(interp
, cmdName
, -1);
142 Jim_IncrRefCount(cmd_name
);
143 int retval
= Jim_CreateCommandObj(interp
, cmd_name
, cmdProc
, privData
, delProc
);
144 Jim_DecrRefCount(interp
, cmd_name
);
147 #define Jim_CreateCommand workaround_createcommand
148 #endif /* JIM_VERSION == 80 */
149 /* FIXME: end of workaround for memory leak in jimtcl 0.80 */
151 static int command_retval_set(Jim_Interp
*interp
, int retval
)
153 int *return_retval
= Jim_GetAssocData(interp
, "retval");
154 if (return_retval
!= NULL
)
155 *return_retval
= retval
;
157 return (retval
== ERROR_OK
) ? JIM_OK
: retval
;
160 extern struct command_context
*global_cmd_ctx
;
162 /* dump a single line to the log for the command.
163 * Do nothing in case we are not at debug level 3 */
164 void script_debug(Jim_Interp
*interp
, unsigned int argc
, Jim_Obj
* const *argv
)
166 if (debug_level
< LOG_LVL_DEBUG
)
169 char *dbg
= alloc_printf("command -");
170 for (unsigned i
= 0; i
< argc
; i
++) {
172 const char *w
= Jim_GetString(argv
[i
], &len
);
173 char *t
= alloc_printf("%s %s", dbg
, w
);
177 LOG_DEBUG("%s", dbg
);
181 static void script_command_args_free(char **words
, unsigned nwords
)
183 for (unsigned i
= 0; i
< nwords
; i
++)
188 static char **script_command_args_alloc(
189 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
191 char **words
= malloc(argc
* sizeof(char *));
196 for (i
= 0; i
< argc
; i
++) {
198 const char *w
= Jim_GetString(argv
[i
], &len
);
199 words
[i
] = strdup(w
);
200 if (words
[i
] == NULL
) {
201 script_command_args_free(words
, i
);
209 struct command_context
*current_command_context(Jim_Interp
*interp
)
211 /* grab the command context from the associated data */
212 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
213 if (NULL
== cmd_ctx
) {
214 /* Tcl can invoke commands directly instead of via command_run_line(). This would
215 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
216 * commands in a startup script.
218 * A telnet or gdb server would provide a non-default command context to
219 * handle piping of error output, have a separate current target, etc.
221 cmd_ctx
= global_cmd_ctx
;
226 static struct command
*command_root(struct command
*c
)
228 while (NULL
!= c
->parent
)
234 * Find a command by name from a list of commands.
235 * @returns Returns the named command if it exists in the list.
236 * Returns NULL otherwise.
238 static struct command
*command_find(struct command
*head
, const char *name
)
240 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
241 if (strcmp(cc
->name
, name
) == 0)
247 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
250 return command_find(cmd_ctx
->commands
, name
);
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 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
395 const struct command_registration
*cmds
)
397 int retval
= ERROR_OK
;
399 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
400 const struct command_registration
*cr
= cmds
+ i
;
402 struct command
*c
= NULL
;
403 if (NULL
!= cr
->name
) {
404 c
= register_command(cmd_ctx
, parent
, cr
);
410 if (NULL
!= cr
->chain
) {
411 struct command
*p
= c
? : parent
;
412 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
413 if (ERROR_OK
!= retval
)
417 if (ERROR_OK
!= retval
) {
418 for (unsigned j
= 0; j
< i
; j
++)
419 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
424 int unregister_all_commands(struct command_context
*context
,
425 struct command
*parent
)
430 struct command
**head
= command_list_for_parent(context
, parent
);
431 while (NULL
!= *head
) {
432 struct command
*tmp
= *head
;
440 static int unregister_command(struct command_context
*context
,
441 struct command
*parent
, const char *name
)
443 if ((!context
) || (!name
))
444 return ERROR_COMMAND_SYNTAX_ERROR
;
446 struct command
*p
= NULL
;
447 struct command
**head
= command_list_for_parent(context
, parent
);
448 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
449 if (strcmp(name
, c
->name
) != 0)
464 void command_set_handler_data(struct command
*c
, void *p
)
466 c
->jim_handler_data
= p
;
467 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
468 command_set_handler_data(cc
, p
);
471 void command_output_text(struct command_context
*context
, const char *data
)
473 if (context
&& context
->output_handler
&& data
)
474 context
->output_handler(context
, data
);
477 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
482 va_start(ap
, format
);
484 string
= alloc_vprintf(format
, ap
);
485 if (string
!= NULL
&& cmd
) {
486 /* we want this collected in the log + we also want to pick it up as a tcl return
489 * The latter bit isn't precisely neat, but will do for now.
491 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
492 /* We already printed it above
493 * command_output_text(context, string); */
500 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
505 va_start(ap
, format
);
507 string
= alloc_vprintf(format
, ap
);
508 if (string
!= NULL
&& cmd
) {
509 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
511 /* we want this collected in the log + we also want to pick it up as a tcl return
514 * The latter bit isn't precisely neat, but will do for now.
516 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
517 /* We already printed it above
518 * command_output_text(context, string); */
525 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
528 unsigned len
= strlen(c
->name
);
529 if (NULL
== c
->parent
) {
530 /* allocate enough for the name, child names, and '\0' */
531 name
= malloc(len
+ extra
+ 1);
533 LOG_ERROR("Out of memory");
536 strcpy(name
, c
->name
);
538 /* parent's extra must include both the space and name */
539 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
540 char dstr
[2] = { delim
, 0 };
542 strcat(name
, c
->name
);
547 static char *command_name(struct command
*c
, char delim
)
549 return __command_name(c
, delim
, 0);
552 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
554 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
557 /* Many commands may be run only before/after 'init' */
566 /* handle the impossible with humor; it guarantees a bug report! */
568 when
= "if Cthulhu is summoned by";
571 char *full_name
= command_name(c
, ' ');
572 LOG_ERROR("The '%s' command must be used %s 'init'.",
573 full_name
? full_name
: c
->name
, when
);
578 static int run_command(struct command_context
*context
,
579 struct command
*c
, const char **words
, unsigned num_words
)
581 struct command_invocation cmd
= {
585 .argc
= num_words
- 1,
589 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
590 Jim_IncrRefCount(cmd
.output
);
592 int retval
= c
->handler(&cmd
);
593 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
594 /* Print help for command */
595 char *full_name
= command_name(c
, ' ');
596 if (NULL
!= full_name
) {
597 command_run_linef(context
, "usage %s", full_name
);
600 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
601 /* just fall through for a shutdown request */
603 if (retval
!= ERROR_OK
) {
604 char *full_name
= command_name(c
, ' ');
605 LOG_DEBUG("Command '%s' failed with error code %d",
606 full_name
? full_name
: c
->name
, retval
);
609 /* Use the command output as the Tcl result */
610 Jim_SetResult(context
->interp
, cmd
.output
);
612 Jim_DecrRefCount(context
->interp
, cmd
.output
);
617 int command_run_line(struct command_context
*context
, char *line
)
619 /* all the parent commands have been registered with the interpreter
620 * so, can just evaluate the line as a script and check for
623 /* run the line thru a script engine */
624 int retval
= ERROR_FAIL
;
626 /* Beware! This code needs to be reentrant. It is also possible
627 * for OpenOCD commands to be invoked directly from Tcl. This would
628 * happen when the Jim Tcl interpreter is provided by eCos for
631 struct target
*saved_target_override
= context
->current_target_override
;
632 context
->current_target_override
= NULL
;
634 Jim_Interp
*interp
= context
->interp
;
635 struct command_context
*old_context
= Jim_GetAssocData(interp
, "context");
636 Jim_DeleteAssocData(interp
, "context");
637 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
638 if (retcode
== JIM_OK
) {
639 /* associated the return value */
640 Jim_DeleteAssocData(interp
, "retval");
641 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
642 if (retcode
== JIM_OK
) {
643 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
645 Jim_DeleteAssocData(interp
, "retval");
647 Jim_DeleteAssocData(interp
, "context");
648 int inner_retcode
= Jim_SetAssocData(interp
, "context", NULL
, old_context
);
649 if (retcode
== JIM_OK
)
650 retcode
= inner_retcode
;
652 context
->current_target_override
= saved_target_override
;
653 if (retcode
== JIM_OK
) {
657 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
659 command_output_text(context
, result
);
660 command_output_text(context
, "\n");
663 } else if (retcode
== JIM_EXIT
) {
665 * exit(Jim_GetExitCode(interp)); */
666 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
669 Jim_MakeErrorMessage(interp
);
670 /* error is broadcast */
671 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
673 if (retval
== ERROR_OK
) {
674 /* It wasn't a low level OpenOCD command that failed */
683 int command_run_linef(struct command_context
*context
, const char *format
, ...)
685 int retval
= ERROR_FAIL
;
688 va_start(ap
, format
);
689 string
= alloc_vprintf(format
, ap
);
690 if (string
!= NULL
) {
691 retval
= command_run_line(context
, string
);
698 void command_set_output_handler(struct command_context
*context
,
699 command_output_handler_t output_handler
, void *priv
)
701 context
->output_handler
= output_handler
;
702 context
->output_handler_priv
= priv
;
705 struct command_context
*copy_command_context(struct command_context
*context
)
707 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
709 *copy_context
= *context
;
714 void command_done(struct command_context
*cmd_ctx
)
722 /* find full path to file */
723 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
727 const char *file
= Jim_GetString(argv
[1], NULL
);
728 char *full_path
= find_file(file
);
729 if (full_path
== NULL
)
731 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
734 Jim_SetResult(interp
, result
);
738 COMMAND_HANDLER(jim_echo
)
740 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
741 LOG_USER_N("%s", CMD_ARGV
[1]);
746 LOG_USER("%s", CMD_ARGV
[0]);
750 /* Capture progress output and return as tcl return value. If the
751 * progress output was empty, return tcl return value.
753 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
758 struct log_capture_state
*state
= command_log_capture_start(interp
);
760 /* disable polling during capture. This avoids capturing output
763 * This is necessary in order to avoid accidentally getting a non-empty
764 * string for tcl fn's.
766 bool save_poll
= jtag_poll_get_enabled();
768 jtag_poll_set_enabled(false);
770 const char *str
= Jim_GetString(argv
[1], NULL
);
771 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
773 jtag_poll_set_enabled(save_poll
);
775 command_log_capture_finish(state
);
780 static COMMAND_HELPER(command_help_find
, struct command
*head
,
781 struct command
**out
)
784 return ERROR_COMMAND_SYNTAX_ERROR
;
785 *out
= command_find(head
, CMD_ARGV
[0]);
787 return ERROR_COMMAND_SYNTAX_ERROR
;
791 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
794 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
795 bool show_help
, const char *cmd_match
);
797 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
798 bool show_help
, const char *cmd_match
)
800 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
801 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, cmd_match
);
805 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
807 static void command_help_show_indent(unsigned n
)
809 for (unsigned i
= 0; i
< n
; i
++)
812 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
814 const char *cp
= str
, *last
= str
;
816 const char *next
= last
;
821 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
822 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
823 if (next
- last
< HELP_LINE_WIDTH(n
))
825 command_help_show_indent(n
);
826 LOG_USER("%.*s", (int)(cp
- last
), last
);
832 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
833 bool show_help
, const char *cmd_match
)
835 char *cmd_name
= command_name(c
, ' ');
836 if (NULL
== cmd_name
)
839 /* If the match string occurs anywhere, we print out
840 * stuff for this command. */
841 bool is_match
= (strstr(cmd_name
, cmd_match
) != NULL
) ||
842 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
843 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
846 command_help_show_indent(n
);
847 LOG_USER_N("%s", cmd_name
);
852 if (c
->usage
&& strlen(c
->usage
) > 0) {
854 command_help_show_wrap(c
->usage
, 0, n
+ 5);
859 if (is_match
&& show_help
) {
862 /* Normal commands are runtime-only; highlight exceptions */
863 if (c
->mode
!= COMMAND_EXEC
) {
864 const char *stage_msg
= "";
868 stage_msg
= " (configuration command)";
871 stage_msg
= " (command valid any time)";
874 stage_msg
= " (?mode error?)";
877 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
879 msg
= alloc_printf("%s", c
->help
? : "");
882 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
889 LOG_ERROR("command recursion exceeded");
893 return CALL_COMMAND_HANDLER(command_help_show_list
,
894 c
->children
, n
, show_help
, cmd_match
);
897 COMMAND_HANDLER(handle_help_command
)
899 bool full
= strcmp(CMD_NAME
, "help") == 0;
901 struct command
*c
= CMD_CTX
->commands
;
905 cmd_match
= strdup("");
908 cmd_match
= strdup(CMD_ARGV
[0]);
910 for (unsigned int i
= 1; i
< CMD_ARGC
&& cmd_match
; ++i
) {
911 char *prev
= cmd_match
;
912 cmd_match
= alloc_printf("%s %s", prev
, CMD_ARGV
[i
]);
917 if (cmd_match
== NULL
) {
918 LOG_ERROR("unable to build search string");
921 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
922 c
, 0, full
, cmd_match
);
928 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
929 struct command
*head
, struct command
**out
)
933 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
934 struct command
*c
= command_find(head
, cmd_name
);
938 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
);
941 static char *alloc_concatenate_strings(int argc
, Jim_Obj
* const *argv
)
948 all
= strdup(Jim_GetString(argv
[0], NULL
));
950 LOG_ERROR("Out of memory");
954 for (i
= 1; i
< argc
; ++i
) {
956 all
= alloc_printf("%s %s", all
, Jim_GetString(argv
[i
], NULL
));
959 LOG_ERROR("Out of memory");
967 static int run_usage(Jim_Interp
*interp
, int argc_valid
, int argc
, Jim_Obj
* const *argv
)
969 struct command_context
*cmd_ctx
= current_command_context(interp
);
973 assert(argc_valid
>= 1);
974 assert(argc
>= argc_valid
);
976 command
= alloc_concatenate_strings(argc_valid
, argv
);
980 retval
= command_run_linef(cmd_ctx
, "usage %s", command
);
981 if (retval
!= ERROR_OK
) {
982 LOG_ERROR("unable to execute command \"usage %s\"", command
);
986 if (argc_valid
== argc
)
987 LOG_ERROR("%s: command requires more arguments", command
);
990 command
= alloc_concatenate_strings(argc
- argc_valid
, argv
+ argc_valid
);
993 LOG_ERROR("invalid subcommand \"%s\"", command
);
1000 static int exec_command(Jim_Interp
*interp
, struct command_context
*cmd_ctx
,
1001 struct command
*c
, int argc
, Jim_Obj
*const *argv
)
1004 return c
->jim_handler(interp
, argc
, argv
);
1006 /* use c->handler */
1007 unsigned int nwords
;
1008 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
1012 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
1013 script_command_args_free(words
, nwords
);
1014 return command_retval_set(interp
, retval
);
1017 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1019 script_debug(interp
, argc
, argv
);
1021 struct command_context
*cmd_ctx
= current_command_context(interp
);
1022 struct command
*c
= cmd_ctx
->commands
;
1023 int remaining
= command_unknown_find(argc
, argv
, c
, &c
);
1024 /* if nothing could be consumed, then it's really an unknown command */
1025 if (remaining
== argc
) {
1026 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1027 LOG_ERROR("Unknown command:\n %s", cmd
);
1031 Jim_Obj
*const *start
;
1033 if (c
->handler
|| c
->jim_handler
) {
1034 /* include the command name in the list */
1035 count
= remaining
+ 1;
1036 start
= argv
+ (argc
- remaining
- 1);
1038 count
= argc
- remaining
;
1040 run_usage(interp
, count
, argc
, start
);
1044 if (!command_can_run(cmd_ctx
, c
))
1047 target_call_timer_callbacks_now();
1050 * Black magic of overridden current target:
1051 * If the command we are going to handle has a target prefix,
1052 * override the current target temporarily for the time
1053 * of processing the command.
1054 * current_target_override is used also for event handlers
1055 * therefore we prevent touching it if command has no prefix.
1056 * Previous override is saved and restored back to ensure
1057 * correct work when command_unknown() is re-entered.
1059 struct target
*saved_target_override
= cmd_ctx
->current_target_override
;
1060 if (c
->jim_handler_data
)
1061 cmd_ctx
->current_target_override
= c
->jim_handler_data
;
1063 int retval
= exec_command(interp
, cmd_ctx
, c
, count
, start
);
1065 if (c
->jim_handler_data
)
1066 cmd_ctx
->current_target_override
= saved_target_override
;
1071 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1073 struct command_context
*cmd_ctx
= current_command_context(interp
);
1074 enum command_mode mode
;
1077 struct command
*c
= cmd_ctx
->commands
;
1078 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
);
1079 /* if nothing could be consumed, then it's an unknown command */
1080 if (remaining
== argc
- 1) {
1081 Jim_SetResultString(interp
, "unknown", -1);
1086 mode
= cmd_ctx
->mode
;
1088 const char *mode_str
;
1093 case COMMAND_CONFIG
:
1094 mode_str
= "config";
1100 mode_str
= "unknown";
1103 Jim_SetResultString(interp
, mode_str
, -1);
1107 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1108 const char *cmd_name
, const char *help_text
, const char *usage
)
1110 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1111 struct command
*nc
= command_find(*head
, cmd_name
);
1113 /* add a new command with help text */
1114 struct command_registration cr
= {
1116 .mode
= COMMAND_ANY
,
1118 .usage
= usage
? : "",
1120 nc
= register_command(cmd_ctx
, parent
, &cr
);
1122 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1125 LOG_DEBUG("added '%s' help text", cmd_name
);
1129 bool replaced
= false;
1134 nc
->help
= strdup(help_text
);
1136 LOG_INFO("replaced existing '%s' help", cmd_name
);
1138 LOG_DEBUG("added '%s' help text", cmd_name
);
1141 bool replaced
= false;
1147 nc
->usage
= strdup(usage
);
1149 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1151 LOG_DEBUG("added '%s' usage text", cmd_name
);
1156 COMMAND_HANDLER(handle_help_add_command
)
1159 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1160 return ERROR_COMMAND_SYNTAX_ERROR
;
1163 /* save help text and remove it from argument list */
1164 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1165 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1166 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1167 if (!help
&& !usage
) {
1168 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1169 return ERROR_COMMAND_SYNTAX_ERROR
;
1171 /* likewise for the leaf command name */
1172 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1174 struct command
*c
= NULL
;
1176 c
= CMD_CTX
->commands
;
1177 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1178 if (ERROR_OK
!= retval
)
1181 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1184 /* sleep command sleeps for <n> milliseconds
1185 * this is useful in target startup scripts
1187 COMMAND_HANDLER(handle_sleep_command
)
1190 if (CMD_ARGC
== 2) {
1191 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1194 return ERROR_COMMAND_SYNTAX_ERROR
;
1195 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1196 return ERROR_COMMAND_SYNTAX_ERROR
;
1198 unsigned long duration
= 0;
1199 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1200 if (ERROR_OK
!= retval
)
1204 int64_t then
= timeval_ms();
1205 while (timeval_ms() - then
< (int64_t)duration
) {
1206 target_call_timer_callbacks_now();
1210 busy_sleep(duration
);
1215 static const struct command_registration command_subcommand_handlers
[] = {
1218 .mode
= COMMAND_ANY
,
1219 .jim_handler
= jim_command_mode
,
1220 .usage
= "[command_name ...]",
1221 .help
= "Returns the command modes allowed by a command: "
1222 "'any', 'config', or 'exec'. If no command is "
1223 "specified, returns the current command mode. "
1224 "Returns 'unknown' if an unknown command is given. "
1225 "Command can be multiple tokens.",
1227 COMMAND_REGISTRATION_DONE
1230 static const struct command_registration command_builtin_handlers
[] = {
1233 .mode
= COMMAND_ANY
,
1234 .jim_handler
= jim_find
,
1235 .help
= "find full path to file",
1240 .mode
= COMMAND_ANY
,
1241 .jim_handler
= jim_capture
,
1242 .help
= "Capture progress output and return as tcl return value. If the "
1243 "progress output was empty, return tcl return value.",
1248 .handler
= jim_echo
,
1249 .mode
= COMMAND_ANY
,
1250 .help
= "Logs a message at \"user\" priority. "
1251 "Output message to stdout. "
1252 "Option \"-n\" suppresses trailing newline",
1253 .usage
= "[-n] string",
1256 .name
= "add_help_text",
1257 .handler
= handle_help_add_command
,
1258 .mode
= COMMAND_ANY
,
1259 .help
= "Add new command help text; "
1260 "Command can be multiple tokens.",
1261 .usage
= "command_name helptext_string",
1264 .name
= "add_usage_text",
1265 .handler
= handle_help_add_command
,
1266 .mode
= COMMAND_ANY
,
1267 .help
= "Add new command usage text; "
1268 "command can be multiple tokens.",
1269 .usage
= "command_name usage_string",
1273 .handler
= handle_sleep_command
,
1274 .mode
= COMMAND_ANY
,
1275 .help
= "Sleep for specified number of milliseconds. "
1276 "\"busy\" will busy wait instead (avoid this).",
1277 .usage
= "milliseconds ['busy']",
1281 .handler
= handle_help_command
,
1282 .mode
= COMMAND_ANY
,
1283 .help
= "Show full command help; "
1284 "command can be multiple tokens.",
1285 .usage
= "[command_name]",
1289 .handler
= handle_help_command
,
1290 .mode
= COMMAND_ANY
,
1291 .help
= "Show basic command usage; "
1292 "command can be multiple tokens.",
1293 .usage
= "[command_name]",
1297 .mode
= COMMAND_ANY
,
1298 .help
= "core command group (introspection)",
1299 .chain
= command_subcommand_handlers
,
1302 COMMAND_REGISTRATION_DONE
1305 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1307 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1310 context
->mode
= COMMAND_EXEC
;
1312 /* Create a jim interpreter if we were not handed one */
1313 if (interp
== NULL
) {
1314 /* Create an interpreter */
1315 interp
= Jim_CreateInterp();
1316 /* Add all the Jim core commands */
1317 Jim_RegisterCoreCommands(interp
);
1318 Jim_InitStaticExtensions(interp
);
1321 context
->interp
= interp
;
1323 /* Stick to lowercase for HostOS strings. */
1324 #if defined(_MSC_VER)
1325 /* WinXX - is generic, the forward
1326 * looking problem is this:
1328 * "win32" or "win64"
1330 * "winxx" is generic.
1333 #elif defined(__linux__)
1335 #elif defined(__APPLE__) || defined(__DARWIN__)
1337 #elif defined(__CYGWIN__)
1339 #elif defined(__MINGW32__)
1341 #elif defined(__ECOS)
1343 #elif defined(__FreeBSD__)
1345 #elif defined(__NetBSD__)
1347 #elif defined(__OpenBSD__)
1350 #warning "Unrecognized host OS..."
1353 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1354 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1356 register_commands(context
, NULL
, command_builtin_handlers
);
1358 Jim_SetAssocData(interp
, "context", NULL
, context
);
1359 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1360 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1361 Jim_MakeErrorMessage(interp
);
1362 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1365 Jim_DeleteAssocData(interp
, "context");
1370 void command_exit(struct command_context
*context
)
1375 Jim_FreeInterp(context
->interp
);
1376 command_done(context
);
1379 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1382 return ERROR_COMMAND_SYNTAX_ERROR
;
1384 cmd_ctx
->mode
= mode
;
1388 void process_jim_events(struct command_context
*cmd_ctx
)
1390 static int recursion
;
1395 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1399 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1400 int parse ## name(const char *str, type * ul) \
1403 LOG_ERROR("Invalid command argument"); \
1404 return ERROR_COMMAND_ARGUMENT_INVALID; \
1408 *ul = func(str, &end, 0); \
1410 LOG_ERROR("Invalid command argument"); \
1411 return ERROR_COMMAND_ARGUMENT_INVALID; \
1413 if ((max == *ul) && (ERANGE == errno)) { \
1414 LOG_ERROR("Argument overflow"); \
1415 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1417 if (min && (min == *ul) && (ERANGE == errno)) { \
1418 LOG_ERROR("Argument underflow"); \
1419 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1423 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1424 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1425 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1426 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1428 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1429 int parse ## name(const char *str, type * ul) \
1432 int retval = parse ## funcname(str, &n); \
1433 if (ERROR_OK != retval) \
1436 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1438 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1443 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1444 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1445 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1446 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1447 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1448 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1449 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1451 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1453 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1454 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1455 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1456 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1457 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1458 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1459 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1461 static int command_parse_bool(const char *in
, bool *out
,
1462 const char *on
, const char *off
)
1464 if (strcasecmp(in
, on
) == 0)
1466 else if (strcasecmp(in
, off
) == 0)
1469 return ERROR_COMMAND_SYNTAX_ERROR
;
1473 int command_parse_bool_arg(const char *in
, bool *out
)
1475 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1477 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1479 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1481 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1483 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1485 return ERROR_COMMAND_SYNTAX_ERROR
;
1488 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1492 const char *in
= CMD_ARGV
[0];
1493 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1494 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1495 return ERROR_COMMAND_SYNTAX_ERROR
;
1500 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1503 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)