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
, 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 unregister_all_commands(struct command_context
*context
,
428 struct command
*parent
)
433 struct command
**head
= command_list_for_parent(context
, parent
);
434 while (NULL
!= *head
) {
435 struct command
*tmp
= *head
;
443 static int unregister_command(struct command_context
*context
,
444 struct command
*parent
, const char *name
)
446 if ((!context
) || (!name
))
447 return ERROR_COMMAND_SYNTAX_ERROR
;
449 struct command
*p
= NULL
;
450 struct command
**head
= command_list_for_parent(context
, parent
);
451 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
452 if (strcmp(name
, c
->name
) != 0)
467 void command_output_text(struct command_context
*context
, const char *data
)
469 if (context
&& context
->output_handler
&& data
)
470 context
->output_handler(context
, data
);
473 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
478 va_start(ap
, format
);
480 string
= alloc_vprintf(format
, ap
);
481 if (string
!= NULL
&& cmd
) {
482 /* we want this collected in the log + we also want to pick it up as a tcl return
485 * The latter bit isn't precisely neat, but will do for now.
487 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
488 /* We already printed it above
489 * command_output_text(context, string); */
496 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
501 va_start(ap
, format
);
503 string
= alloc_vprintf(format
, ap
);
504 if (string
!= NULL
&& cmd
) {
505 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
507 /* we want this collected in the log + we also want to pick it up as a tcl return
510 * The latter bit isn't precisely neat, but will do for now.
512 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
513 /* We already printed it above
514 * command_output_text(context, string); */
521 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
524 unsigned len
= strlen(c
->name
);
525 if (NULL
== c
->parent
) {
526 /* allocate enough for the name, child names, and '\0' */
527 name
= malloc(len
+ extra
+ 1);
529 LOG_ERROR("Out of memory");
532 strcpy(name
, c
->name
);
534 /* parent's extra must include both the space and name */
535 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
536 char dstr
[2] = { delim
, 0 };
538 strcat(name
, c
->name
);
543 static char *command_name(struct command
*c
, char delim
)
545 return __command_name(c
, delim
, 0);
548 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
550 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
553 /* Many commands may be run only before/after 'init' */
562 /* handle the impossible with humor; it guarantees a bug report! */
564 when
= "if Cthulhu is summoned by";
567 char *full_name
= command_name(c
, ' ');
568 LOG_ERROR("The '%s' command must be used %s 'init'.",
569 full_name
? full_name
: c
->name
, when
);
574 static int run_command(struct command_context
*context
,
575 struct command
*c
, const char **words
, unsigned num_words
)
577 struct command_invocation cmd
= {
581 .argc
= num_words
- 1,
585 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
586 Jim_IncrRefCount(cmd
.output
);
588 int retval
= c
->handler(&cmd
);
589 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
590 /* Print help for command */
591 char *full_name
= command_name(c
, ' ');
592 if (NULL
!= full_name
) {
593 command_run_linef(context
, "usage %s", full_name
);
596 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
597 /* just fall through for a shutdown request */
599 if (retval
!= ERROR_OK
) {
600 char *full_name
= command_name(c
, ' ');
601 LOG_DEBUG("Command '%s' failed with error code %d",
602 full_name
? full_name
: c
->name
, retval
);
605 /* Use the command output as the Tcl result */
606 Jim_SetResult(context
->interp
, cmd
.output
);
608 Jim_DecrRefCount(context
->interp
, cmd
.output
);
613 int command_run_line(struct command_context
*context
, char *line
)
615 /* all the parent commands have been registered with the interpreter
616 * so, can just evaluate the line as a script and check for
619 /* run the line thru a script engine */
620 int retval
= ERROR_FAIL
;
622 /* Beware! This code needs to be reentrant. It is also possible
623 * for OpenOCD commands to be invoked directly from Tcl. This would
624 * happen when the Jim Tcl interpreter is provided by eCos for
627 struct target
*saved_target_override
= context
->current_target_override
;
628 context
->current_target_override
= NULL
;
630 Jim_Interp
*interp
= context
->interp
;
631 struct command_context
*old_context
= Jim_GetAssocData(interp
, "context");
632 Jim_DeleteAssocData(interp
, "context");
633 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
634 if (retcode
== JIM_OK
) {
635 /* associated the return value */
636 Jim_DeleteAssocData(interp
, "retval");
637 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
638 if (retcode
== JIM_OK
) {
639 retcode
= Jim_Eval_Named(interp
, line
, 0, 0);
641 Jim_DeleteAssocData(interp
, "retval");
643 Jim_DeleteAssocData(interp
, "context");
644 int inner_retcode
= Jim_SetAssocData(interp
, "context", NULL
, old_context
);
645 if (retcode
== JIM_OK
)
646 retcode
= inner_retcode
;
648 context
->current_target_override
= saved_target_override
;
649 if (retcode
== JIM_OK
) {
653 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
655 command_output_text(context
, result
);
656 command_output_text(context
, "\n");
659 } else if (retcode
== JIM_EXIT
) {
661 * exit(Jim_GetExitCode(interp)); */
662 } else if (retcode
== ERROR_COMMAND_CLOSE_CONNECTION
) {
665 Jim_MakeErrorMessage(interp
);
666 /* error is broadcast */
667 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
669 if (retval
== ERROR_OK
) {
670 /* It wasn't a low level OpenOCD command that failed */
679 int command_run_linef(struct command_context
*context
, const char *format
, ...)
681 int retval
= ERROR_FAIL
;
684 va_start(ap
, format
);
685 string
= alloc_vprintf(format
, ap
);
686 if (string
!= NULL
) {
687 retval
= command_run_line(context
, string
);
694 void command_set_output_handler(struct command_context
*context
,
695 command_output_handler_t output_handler
, void *priv
)
697 context
->output_handler
= output_handler
;
698 context
->output_handler_priv
= priv
;
701 struct command_context
*copy_command_context(struct command_context
*context
)
703 struct command_context
*copy_context
= malloc(sizeof(struct command_context
));
705 *copy_context
= *context
;
710 void command_done(struct command_context
*cmd_ctx
)
718 /* find full path to file */
719 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
723 const char *file
= Jim_GetString(argv
[1], NULL
);
724 char *full_path
= find_file(file
);
725 if (full_path
== NULL
)
727 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
730 Jim_SetResult(interp
, result
);
734 COMMAND_HANDLER(jim_echo
)
736 if (CMD_ARGC
== 2 && !strcmp(CMD_ARGV
[0], "-n")) {
737 LOG_USER_N("%s", CMD_ARGV
[1]);
742 LOG_USER("%s", CMD_ARGV
[0]);
746 /* Capture progress output and return as tcl return value. If the
747 * progress output was empty, return tcl return value.
749 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
754 struct log_capture_state
*state
= command_log_capture_start(interp
);
756 /* disable polling during capture. This avoids capturing output
759 * This is necessary in order to avoid accidentally getting a non-empty
760 * string for tcl fn's.
762 bool save_poll
= jtag_poll_get_enabled();
764 jtag_poll_set_enabled(false);
766 const char *str
= Jim_GetString(argv
[1], NULL
);
767 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
769 jtag_poll_set_enabled(save_poll
);
771 command_log_capture_finish(state
);
776 static COMMAND_HELPER(command_help_find
, struct command
*head
,
777 struct command
**out
)
780 return ERROR_COMMAND_SYNTAX_ERROR
;
781 *out
= command_find(head
, CMD_ARGV
[0]);
783 return ERROR_COMMAND_SYNTAX_ERROR
;
787 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
790 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
791 bool show_help
, const char *cmd_match
);
793 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
794 bool show_help
, const char *cmd_match
)
796 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
797 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
, cmd_match
);
801 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
803 static void command_help_show_indent(unsigned n
)
805 for (unsigned i
= 0; i
< n
; i
++)
808 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
810 const char *cp
= str
, *last
= str
;
812 const char *next
= last
;
817 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
818 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
819 if (next
- last
< HELP_LINE_WIDTH(n
))
821 command_help_show_indent(n
);
822 LOG_USER("%.*s", (int)(cp
- last
), last
);
828 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
829 bool show_help
, const char *cmd_match
)
831 char *cmd_name
= command_name(c
, ' ');
832 if (NULL
== cmd_name
)
835 /* If the match string occurs anywhere, we print out
836 * stuff for this command. */
837 bool is_match
= (strstr(cmd_name
, cmd_match
) != NULL
) ||
838 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
839 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
842 command_help_show_indent(n
);
843 LOG_USER_N("%s", cmd_name
);
848 if (c
->usage
&& strlen(c
->usage
) > 0) {
850 command_help_show_wrap(c
->usage
, 0, n
+ 5);
855 if (is_match
&& show_help
) {
858 /* Normal commands are runtime-only; highlight exceptions */
859 if (c
->mode
!= COMMAND_EXEC
) {
860 const char *stage_msg
= "";
864 stage_msg
= " (configuration command)";
867 stage_msg
= " (command valid any time)";
870 stage_msg
= " (?mode error?)";
873 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
875 msg
= alloc_printf("%s", c
->help
? : "");
878 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
885 LOG_ERROR("command recursion exceeded");
889 return CALL_COMMAND_HANDLER(command_help_show_list
,
890 c
->children
, n
, show_help
, cmd_match
);
893 COMMAND_HANDLER(handle_help_command
)
895 bool full
= strcmp(CMD_NAME
, "help") == 0;
897 struct command
*c
= CMD_CTX
->commands
;
901 cmd_match
= strdup("");
904 cmd_match
= strdup(CMD_ARGV
[0]);
906 for (unsigned int i
= 1; i
< CMD_ARGC
&& cmd_match
; ++i
) {
907 char *prev
= cmd_match
;
908 cmd_match
= alloc_printf("%s %s", prev
, CMD_ARGV
[i
]);
913 if (cmd_match
== NULL
) {
914 LOG_ERROR("unable to build search string");
917 retval
= CALL_COMMAND_HANDLER(command_help_show_list
,
918 c
, 0, full
, cmd_match
);
924 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
925 struct command
*head
, struct command
**out
)
929 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
930 struct command
*c
= command_find(head
, cmd_name
);
934 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
);
937 static char *alloc_concatenate_strings(int argc
, Jim_Obj
* const *argv
)
944 all
= strdup(Jim_GetString(argv
[0], NULL
));
946 LOG_ERROR("Out of memory");
950 for (i
= 1; i
< argc
; ++i
) {
952 all
= alloc_printf("%s %s", all
, Jim_GetString(argv
[i
], NULL
));
955 LOG_ERROR("Out of memory");
963 static int run_usage(Jim_Interp
*interp
, int argc_valid
, int argc
, Jim_Obj
* const *argv
)
965 struct command_context
*cmd_ctx
= current_command_context(interp
);
969 assert(argc_valid
>= 1);
970 assert(argc
>= argc_valid
);
972 command
= alloc_concatenate_strings(argc_valid
, argv
);
976 retval
= command_run_linef(cmd_ctx
, "usage %s", command
);
977 if (retval
!= ERROR_OK
) {
978 LOG_ERROR("unable to execute command \"usage %s\"", command
);
982 if (argc_valid
== argc
)
983 LOG_ERROR("%s: command requires more arguments", command
);
986 command
= alloc_concatenate_strings(argc
- argc_valid
, argv
+ argc_valid
);
989 LOG_ERROR("invalid subcommand \"%s\"", command
);
996 static int exec_command(Jim_Interp
*interp
, struct command_context
*cmd_ctx
,
997 struct command
*c
, int argc
, Jim_Obj
*const *argv
)
1000 return c
->jim_handler(interp
, argc
, argv
);
1002 /* use c->handler */
1003 unsigned int nwords
;
1004 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
1008 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
1009 script_command_args_free(words
, nwords
);
1010 return command_retval_set(interp
, retval
);
1013 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1015 script_debug(interp
, argc
, argv
);
1017 struct command_context
*cmd_ctx
= current_command_context(interp
);
1018 struct command
*c
= cmd_ctx
->commands
;
1019 int remaining
= command_unknown_find(argc
, argv
, c
, &c
);
1020 /* if nothing could be consumed, then it's really an unknown command */
1021 if (remaining
== argc
) {
1022 const char *cmd
= Jim_GetString(argv
[0], NULL
);
1023 LOG_ERROR("Unknown command:\n %s", cmd
);
1027 Jim_Obj
*const *start
;
1029 if (c
->handler
|| c
->jim_handler
) {
1030 /* include the command name in the list */
1031 count
= remaining
+ 1;
1032 start
= argv
+ (argc
- remaining
- 1);
1034 count
= argc
- remaining
;
1036 run_usage(interp
, count
, argc
, start
);
1040 if (!command_can_run(cmd_ctx
, c
))
1043 target_call_timer_callbacks_now();
1046 * Black magic of overridden current target:
1047 * If the command we are going to handle has a target prefix,
1048 * override the current target temporarily for the time
1049 * of processing the command.
1050 * current_target_override is used also for event handlers
1051 * therefore we prevent touching it if command has no prefix.
1052 * Previous override is saved and restored back to ensure
1053 * correct work when command_unknown() is re-entered.
1055 struct target
*saved_target_override
= cmd_ctx
->current_target_override
;
1056 if (c
->jim_override_target
)
1057 cmd_ctx
->current_target_override
= c
->jim_override_target
;
1059 int retval
= exec_command(interp
, cmd_ctx
, c
, count
, start
);
1061 if (c
->jim_override_target
)
1062 cmd_ctx
->current_target_override
= saved_target_override
;
1067 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1069 struct command_context
*cmd_ctx
= current_command_context(interp
);
1070 enum command_mode mode
;
1073 struct command
*c
= cmd_ctx
->commands
;
1074 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
);
1075 /* if nothing could be consumed, then it's an unknown command */
1076 if (remaining
== argc
- 1) {
1077 Jim_SetResultString(interp
, "unknown", -1);
1082 mode
= cmd_ctx
->mode
;
1084 const char *mode_str
;
1089 case COMMAND_CONFIG
:
1090 mode_str
= "config";
1096 mode_str
= "unknown";
1099 Jim_SetResultString(interp
, mode_str
, -1);
1103 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1104 const char *cmd_name
, const char *help_text
, const char *usage
)
1106 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1107 struct command
*nc
= command_find(*head
, cmd_name
);
1109 /* add a new command with help text */
1110 struct command_registration cr
= {
1112 .mode
= COMMAND_ANY
,
1114 .usage
= usage
? : "",
1116 nc
= register_command(cmd_ctx
, parent
, &cr
);
1118 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1121 LOG_DEBUG("added '%s' help text", cmd_name
);
1125 bool replaced
= false;
1130 nc
->help
= strdup(help_text
);
1132 LOG_INFO("replaced existing '%s' help", cmd_name
);
1134 LOG_DEBUG("added '%s' help text", cmd_name
);
1137 bool replaced
= false;
1143 nc
->usage
= strdup(usage
);
1145 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1147 LOG_DEBUG("added '%s' usage text", cmd_name
);
1152 COMMAND_HANDLER(handle_help_add_command
)
1155 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1156 return ERROR_COMMAND_SYNTAX_ERROR
;
1159 /* save help text and remove it from argument list */
1160 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1161 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1162 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1163 if (!help
&& !usage
) {
1164 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1165 return ERROR_COMMAND_SYNTAX_ERROR
;
1167 /* likewise for the leaf command name */
1168 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1170 struct command
*c
= NULL
;
1172 c
= CMD_CTX
->commands
;
1173 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1174 if (ERROR_OK
!= retval
)
1177 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1180 /* sleep command sleeps for <n> milliseconds
1181 * this is useful in target startup scripts
1183 COMMAND_HANDLER(handle_sleep_command
)
1186 if (CMD_ARGC
== 2) {
1187 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1190 return ERROR_COMMAND_SYNTAX_ERROR
;
1191 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1192 return ERROR_COMMAND_SYNTAX_ERROR
;
1194 unsigned long duration
= 0;
1195 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1196 if (ERROR_OK
!= retval
)
1200 int64_t then
= timeval_ms();
1201 while (timeval_ms() - then
< (int64_t)duration
) {
1202 target_call_timer_callbacks_now();
1206 busy_sleep(duration
);
1211 static const struct command_registration command_subcommand_handlers
[] = {
1214 .mode
= COMMAND_ANY
,
1215 .jim_handler
= jim_command_mode
,
1216 .usage
= "[command_name ...]",
1217 .help
= "Returns the command modes allowed by a command: "
1218 "'any', 'config', or 'exec'. If no command is "
1219 "specified, returns the current command mode. "
1220 "Returns 'unknown' if an unknown command is given. "
1221 "Command can be multiple tokens.",
1223 COMMAND_REGISTRATION_DONE
1226 static const struct command_registration command_builtin_handlers
[] = {
1229 .mode
= COMMAND_ANY
,
1230 .jim_handler
= jim_find
,
1231 .help
= "find full path to file",
1236 .mode
= COMMAND_ANY
,
1237 .jim_handler
= jim_capture
,
1238 .help
= "Capture progress output and return as tcl return value. If the "
1239 "progress output was empty, return tcl return value.",
1244 .handler
= jim_echo
,
1245 .mode
= COMMAND_ANY
,
1246 .help
= "Logs a message at \"user\" priority. "
1247 "Output message to stdout. "
1248 "Option \"-n\" suppresses trailing newline",
1249 .usage
= "[-n] string",
1252 .name
= "add_help_text",
1253 .handler
= handle_help_add_command
,
1254 .mode
= COMMAND_ANY
,
1255 .help
= "Add new command help text; "
1256 "Command can be multiple tokens.",
1257 .usage
= "command_name helptext_string",
1260 .name
= "add_usage_text",
1261 .handler
= handle_help_add_command
,
1262 .mode
= COMMAND_ANY
,
1263 .help
= "Add new command usage text; "
1264 "command can be multiple tokens.",
1265 .usage
= "command_name usage_string",
1269 .handler
= handle_sleep_command
,
1270 .mode
= COMMAND_ANY
,
1271 .help
= "Sleep for specified number of milliseconds. "
1272 "\"busy\" will busy wait instead (avoid this).",
1273 .usage
= "milliseconds ['busy']",
1277 .handler
= handle_help_command
,
1278 .mode
= COMMAND_ANY
,
1279 .help
= "Show full command help; "
1280 "command can be multiple tokens.",
1281 .usage
= "[command_name]",
1285 .handler
= handle_help_command
,
1286 .mode
= COMMAND_ANY
,
1287 .help
= "Show basic command usage; "
1288 "command can be multiple tokens.",
1289 .usage
= "[command_name]",
1293 .mode
= COMMAND_ANY
,
1294 .help
= "core command group (introspection)",
1295 .chain
= command_subcommand_handlers
,
1298 COMMAND_REGISTRATION_DONE
1301 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1303 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1306 context
->mode
= COMMAND_EXEC
;
1308 /* Create a jim interpreter if we were not handed one */
1309 if (interp
== NULL
) {
1310 /* Create an interpreter */
1311 interp
= Jim_CreateInterp();
1312 /* Add all the Jim core commands */
1313 Jim_RegisterCoreCommands(interp
);
1314 Jim_InitStaticExtensions(interp
);
1317 context
->interp
= interp
;
1319 /* Stick to lowercase for HostOS strings. */
1320 #if defined(_MSC_VER)
1321 /* WinXX - is generic, the forward
1322 * looking problem is this:
1324 * "win32" or "win64"
1326 * "winxx" is generic.
1329 #elif defined(__linux__)
1331 #elif defined(__APPLE__) || defined(__DARWIN__)
1333 #elif defined(__CYGWIN__)
1335 #elif defined(__MINGW32__)
1337 #elif defined(__ECOS)
1339 #elif defined(__FreeBSD__)
1341 #elif defined(__NetBSD__)
1343 #elif defined(__OpenBSD__)
1346 #warning "Unrecognized host OS..."
1349 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1350 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1352 register_commands(context
, NULL
, command_builtin_handlers
);
1354 Jim_SetAssocData(interp
, "context", NULL
, context
);
1355 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1356 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1357 Jim_MakeErrorMessage(interp
);
1358 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1361 Jim_DeleteAssocData(interp
, "context");
1366 void command_exit(struct command_context
*context
)
1371 Jim_FreeInterp(context
->interp
);
1372 command_done(context
);
1375 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1378 return ERROR_COMMAND_SYNTAX_ERROR
;
1380 cmd_ctx
->mode
= mode
;
1384 void process_jim_events(struct command_context
*cmd_ctx
)
1386 static int recursion
;
1391 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1395 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1396 int parse ## name(const char *str, type * ul) \
1399 LOG_ERROR("Invalid command argument"); \
1400 return ERROR_COMMAND_ARGUMENT_INVALID; \
1404 *ul = func(str, &end, 0); \
1406 LOG_ERROR("Invalid command argument"); \
1407 return ERROR_COMMAND_ARGUMENT_INVALID; \
1409 if ((max == *ul) && (ERANGE == errno)) { \
1410 LOG_ERROR("Argument overflow"); \
1411 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1413 if (min && (min == *ul) && (ERANGE == errno)) { \
1414 LOG_ERROR("Argument underflow"); \
1415 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1419 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1420 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1421 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1422 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1424 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1425 int parse ## name(const char *str, type * ul) \
1428 int retval = parse ## funcname(str, &n); \
1429 if (ERROR_OK != retval) \
1432 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1434 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1439 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1440 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1441 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1442 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1443 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1444 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1445 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1447 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1449 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1450 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1451 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1452 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1453 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1454 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1455 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1457 static int command_parse_bool(const char *in
, bool *out
,
1458 const char *on
, const char *off
)
1460 if (strcasecmp(in
, on
) == 0)
1462 else if (strcasecmp(in
, off
) == 0)
1465 return ERROR_COMMAND_SYNTAX_ERROR
;
1469 int command_parse_bool_arg(const char *in
, bool *out
)
1471 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1473 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1475 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1477 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1479 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1481 return ERROR_COMMAND_SYNTAX_ERROR
;
1484 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1488 const char *in
= CMD_ARGV
[0];
1489 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1490 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1491 return ERROR_COMMAND_SYNTAX_ERROR
;
1496 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1499 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)