1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
11 * part of this file is taken from libcli (libcli.sourceforge.net) *
12 * Copyright (C) David Parrish (david@dparrish.com) *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
19 * This program is distributed in the hope that it will be useful, *
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
22 * GNU General Public License for more details. *
24 * You should have received a copy of the GNU General Public License *
25 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
26 ***************************************************************************/
32 /* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
35 /* @todo the inclusion of target.h here is a layering violation */
36 #include <jtag/jtag.h>
37 #include <target/target.h>
39 #include "configuration.h"
41 #include "time_support.h"
42 #include "jim-eventloop.h"
44 /* nice short description of source file */
45 #define __THIS__FILE__ "command.c"
47 struct log_capture_state
{
52 static int unregister_command(struct command_context
*context
,
53 struct command
*parent
, const char *name
);
54 static char *command_name(struct command
*c
, char delim
);
55 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
);
56 static int help_add_command(struct command_context
*cmd_ctx
,
57 const char *cmd_name
, const char *help_text
, const char *usage_text
);
58 static int help_del_command(struct command_context
*cmd_ctx
, const char *cmd_name
);
60 /* set of functions to wrap jimtcl internal data */
61 static inline bool jimcmd_is_proc(Jim_Cmd
*cmd
)
66 static inline bool jimcmd_is_ocd_command(Jim_Cmd
*cmd
)
68 return !cmd
->isproc
&& cmd
->u
.native
.cmdProc
== command_unknown
;
71 static inline void *jimcmd_privdata(Jim_Cmd
*cmd
)
73 return cmd
->isproc
? NULL
: cmd
->u
.native
.privData
;
76 static void tcl_output(void *privData
, const char *file
, unsigned line
,
77 const char *function
, const char *string
)
79 struct log_capture_state
*state
= privData
;
80 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
83 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
85 /* capture log output and return it. A garbage collect can
86 * happen, so we need a reference count to this object */
87 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
88 if (NULL
== tclOutput
)
91 struct log_capture_state
*state
= malloc(sizeof(*state
));
95 state
->interp
= interp
;
96 Jim_IncrRefCount(tclOutput
);
97 state
->output
= tclOutput
;
99 log_add_callback(tcl_output
, state
);
104 /* Classic openocd commands provide progress output which we
105 * will capture and return as a Tcl return value.
107 * However, if a non-openocd command has been invoked, then it
108 * makes sense to return the tcl return value from that command.
110 * The tcl return value is empty for openocd commands that provide
113 * Therefore we set the tcl return value only if we actually
116 static void command_log_capture_finish(struct log_capture_state
*state
)
121 log_remove_callback(tcl_output
, state
);
124 Jim_GetString(state
->output
, &length
);
127 Jim_SetResult(state
->interp
, state
->output
);
129 /* No output captured, use tcl return value (which could
132 Jim_DecrRefCount(state
->interp
, state
->output
);
138 * FIXME: workaround for memory leak in jimtcl 0.80
139 * Jim API Jim_CreateCommand() converts the command name in a Jim object and
140 * does not free the object. Fixed for jimtcl 0.81 by e4416cf86f0b
141 * Use the internal jimtcl API Jim_CreateCommandObj, not exported by jim.h,
142 * and override the bugged API through preprocessor's macro.
143 * This workaround works only when jimtcl is compiled as OpenOCD submodule.
144 * If jimtcl is linked-in from a precompiled library, either static or dynamic,
145 * the symbol Jim_CreateCommandObj is not exported and the build will use the
147 * To be removed when OpenOCD will switch to jimtcl 0.81
149 #if JIM_VERSION == 80
150 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
151 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
);
152 int Jim_CreateCommandObj(Jim_Interp
*interp
, Jim_Obj
*cmdNameObj
,
153 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
154 __attribute__((weak
, alias("workaround_createcommand")));
155 static int workaround_createcommand(Jim_Interp
*interp
, const char *cmdName
,
156 Jim_CmdProc
*cmdProc
, void *privData
, Jim_DelCmdProc
*delProc
)
158 if ((void *)Jim_CreateCommandObj
== (void *)workaround_createcommand
)
159 return Jim_CreateCommand(interp
, cmdName
, cmdProc
, privData
, delProc
);
161 Jim_Obj
*cmd_name
= Jim_NewStringObj(interp
, cmdName
, -1);
162 Jim_IncrRefCount(cmd_name
);
163 int retval
= Jim_CreateCommandObj(interp
, cmd_name
, cmdProc
, privData
, delProc
);
164 Jim_DecrRefCount(interp
, cmd_name
);
167 #define Jim_CreateCommand workaround_createcommand
168 #endif /* JIM_VERSION == 80 */
169 /* FIXME: end of workaround for memory leak in jimtcl 0.80 */
171 static int command_retval_set(Jim_Interp
*interp
, int retval
)
173 int *return_retval
= Jim_GetAssocData(interp
, "retval");
174 if (return_retval
!= NULL
)
175 *return_retval
= retval
;
177 return (retval
== ERROR_OK
) ? JIM_OK
: retval
;
180 extern struct command_context
*global_cmd_ctx
;
182 /* dump a single line to the log for the command.
183 * Do nothing in case we are not at debug level 3 */
184 void script_debug(Jim_Interp
*interp
, unsigned int argc
, Jim_Obj
* const *argv
)
186 if (debug_level
< LOG_LVL_DEBUG
)
189 char *dbg
= alloc_printf("command -");
190 for (unsigned i
= 0; i
< argc
; i
++) {
192 const char *w
= Jim_GetString(argv
[i
], &len
);
193 char *t
= alloc_printf("%s %s", dbg
, w
);
197 LOG_DEBUG("%s", dbg
);
201 static void script_command_args_free(char **words
, unsigned nwords
)
203 for (unsigned i
= 0; i
< nwords
; i
++)
208 static char **script_command_args_alloc(
209 unsigned argc
, Jim_Obj
* const *argv
, unsigned *nwords
)
211 char **words
= malloc(argc
* sizeof(char *));
216 for (i
= 0; i
< argc
; i
++) {
218 const char *w
= Jim_GetString(argv
[i
], &len
);
219 words
[i
] = strdup(w
);
220 if (words
[i
] == NULL
) {
221 script_command_args_free(words
, i
);
229 struct command_context
*current_command_context(Jim_Interp
*interp
)
231 /* grab the command context from the associated data */
232 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
233 if (NULL
== cmd_ctx
) {
234 /* Tcl can invoke commands directly instead of via command_run_line(). This would
235 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
236 * commands in a startup script.
238 * A telnet or gdb server would provide a non-default command context to
239 * handle piping of error output, have a separate current target, etc.
241 cmd_ctx
= global_cmd_ctx
;
247 * Find a command by name from a list of commands.
248 * @returns Returns the named command if it exists in the list.
249 * Returns NULL otherwise.
251 static struct command
*command_find(struct command
*head
, const char *name
)
253 for (struct command
*cc
= head
; cc
; cc
= cc
->next
) {
254 if (strcmp(cc
->name
, name
) == 0)
261 * Add the command into the linked list, sorted by name.
262 * @param head Address to head of command list pointer, which may be
263 * updated if @c c gets inserted at the beginning of the list.
264 * @param c The command to add to the list pointed to by @c head.
266 static void command_add_child(struct command
**head
, struct command
*c
)
274 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
275 head
= &(*head
)->next
;
277 if (strcmp(c
->name
, (*head
)->name
) > 0) {
278 c
->next
= (*head
)->next
;
286 static struct command
**command_list_for_parent(
287 struct command_context
*cmd_ctx
, struct command
*parent
)
289 return parent
? &parent
->children
: &cmd_ctx
->commands
;
292 static void command_free(struct command
*c
)
294 /** @todo if command has a handler, unregister its jim command! */
296 while (NULL
!= c
->children
) {
297 struct command
*tmp
= c
->children
;
298 c
->children
= tmp
->next
;
306 static struct command
*command_new(struct command_context
*cmd_ctx
,
307 struct command
*parent
, const struct command_registration
*cr
)
312 * If it is a non-jim command with no .usage specified,
315 * strlen(.usage) == 0 means that the command takes no
318 if ((cr
->jim_handler
== NULL
) && (cr
->usage
== NULL
)) {
319 LOG_ERROR("BUG: command '%s%s%s' does not have the "
320 "'.usage' field filled out",
321 parent
&& parent
->name
? parent
->name
: "",
322 parent
&& parent
->name
? " " : "",
326 struct command
*c
= calloc(1, sizeof(struct command
));
330 c
->name
= strdup(cr
->name
);
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
);
341 if (cr
->help
|| cr
->usage
) {
342 char *full_name
= command_name(c
, ' ');
343 help_add_command(cmd_ctx
, full_name
, cr
->help
, cr
->usage
);
354 static struct command
*register_command(struct command_context
*context
,
355 struct command
*parent
, const struct command_registration
*cr
)
357 if (!context
|| !cr
->name
)
360 const char *name
= cr
->name
;
361 struct command
**head
= command_list_for_parent(context
, parent
);
362 struct command
*c
= command_find(*head
, name
);
364 /* TODO: originally we treated attempting to register a cmd twice as an error
365 * Sometimes we need this behaviour, such as with flash banks.
366 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
367 LOG_DEBUG("command '%s' is already registered in '%s' context",
368 name
, parent
? parent
->name
: "<global>");
372 c
= command_new(context
, parent
, cr
);
376 char *full_name
= command_name(c
, ' ');
377 LOG_DEBUG("registering '%s'...", full_name
);
378 int retval
= Jim_CreateCommand(context
->interp
, full_name
,
379 command_unknown
, c
, NULL
);
380 if (retval
!= JIM_OK
) {
381 unregister_command(context
, parent
, name
);
387 static int ___register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
388 const struct command_registration
*cmds
, void *data
,
389 struct target
*override_target
)
391 int retval
= ERROR_OK
;
393 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++) {
394 const struct command_registration
*cr
= cmds
+ i
;
396 struct command
*c
= NULL
;
397 if (NULL
!= cr
->name
) {
398 c
= register_command(cmd_ctx
, parent
, cr
);
403 c
->jim_handler_data
= data
;
404 c
->jim_override_target
= override_target
;
406 if (NULL
!= cr
->chain
) {
407 struct command
*p
= c
? : parent
;
408 retval
= ___register_commands(cmd_ctx
, p
, cr
->chain
, data
, override_target
);
409 if (ERROR_OK
!= retval
)
413 if (ERROR_OK
!= retval
) {
414 for (unsigned j
= 0; j
< i
; j
++)
415 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
420 int __register_commands(struct command_context
*cmd_ctx
, const char *cmd_prefix
,
421 const struct command_registration
*cmds
, void *data
,
422 struct target
*override_target
)
424 struct command
*parent
= NULL
;
427 parent
= command_find(cmd_ctx
->commands
, cmd_prefix
);
429 return ___register_commands(cmd_ctx
, parent
, cmds
, data
, override_target
);
432 int unregister_all_commands(struct command_context
*context
,
433 struct command
*parent
)
438 struct command
**head
= command_list_for_parent(context
, parent
);
439 while (NULL
!= *head
) {
440 struct command
*tmp
= *head
;
448 static int unregister_command(struct command_context
*context
,
449 struct command
*parent
, const char *name
)
451 if ((!context
) || (!name
))
452 return ERROR_COMMAND_SYNTAX_ERROR
;
454 struct command
*p
= NULL
;
455 struct command
**head
= command_list_for_parent(context
, parent
);
456 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
) {
457 if (strcmp(name
, c
->name
) != 0)
460 char *full_name
= command_name(c
, ' ');
461 help_del_command(context
, full_name
);
476 void command_output_text(struct command_context
*context
, const char *data
)
478 if (context
&& context
->output_handler
&& data
)
479 context
->output_handler(context
, data
);
482 void command_print_sameline(struct command_invocation
*cmd
, const char *format
, ...)
487 va_start(ap
, format
);
489 string
= alloc_vprintf(format
, ap
);
490 if (string
!= NULL
&& cmd
) {
491 /* we want this collected in the log + we also want to pick it up as a tcl return
494 * The latter bit isn't precisely neat, but will do for now.
496 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
497 /* We already printed it above
498 * command_output_text(context, string); */
505 void command_print(struct command_invocation
*cmd
, const char *format
, ...)
510 va_start(ap
, format
);
512 string
= alloc_vprintf(format
, ap
);
513 if (string
!= NULL
&& cmd
) {
514 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
516 /* we want this collected in the log + we also want to pick it up as a tcl return
519 * The latter bit isn't precisely neat, but will do for now.
521 Jim_AppendString(cmd
->ctx
->interp
, cmd
->output
, string
, -1);
522 /* We already printed it above
523 * command_output_text(context, string); */
530 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
533 unsigned len
= strlen(c
->name
);
534 if (NULL
== c
->parent
) {
535 /* allocate enough for the name, child names, and '\0' */
536 name
= malloc(len
+ extra
+ 1);
538 LOG_ERROR("Out of memory");
541 strcpy(name
, c
->name
);
543 /* parent's extra must include both the space and name */
544 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
545 char dstr
[2] = { delim
, 0 };
547 strcat(name
, c
->name
);
552 static char *command_name(struct command
*c
, char delim
)
554 return __command_name(c
, delim
, 0);
557 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
, const char *full_name
)
559 if (c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
)
562 /* Many commands may be run only before/after 'init' */
571 /* handle the impossible with humor; it guarantees a bug report! */
573 when
= "if Cthulhu is summoned by";
576 LOG_ERROR("The '%s' command must be used %s 'init'.",
577 full_name
? full_name
: c
->name
, when
);
581 static int run_command(struct command_context
*context
,
582 struct command
*c
, const char **words
, unsigned num_words
)
584 struct command_invocation cmd
= {
588 .argc
= num_words
- 1,
592 cmd
.output
= Jim_NewEmptyStringObj(context
->interp
);
593 Jim_IncrRefCount(cmd
.output
);
595 int retval
= c
->handler(&cmd
);
596 if (retval
== ERROR_COMMAND_SYNTAX_ERROR
) {
597 /* Print help for command */
598 command_run_linef(context
, "usage %s", words
[0]);
599 } else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
) {
600 /* just fall through for a shutdown request */
602 if (retval
!= ERROR_OK
)
603 LOG_DEBUG("Command '%s' failed with error code %d",
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
);
783 static COMMAND_HELPER(command_help_show
, struct help_entry
*c
,
784 bool show_help
, const char *cmd_match
);
786 static COMMAND_HELPER(command_help_show_list
, bool show_help
, const char *cmd_match
)
788 struct help_entry
*entry
;
790 list_for_each_entry(entry
, CMD_CTX
->help_list
, lh
)
791 CALL_COMMAND_HANDLER(command_help_show
, entry
, show_help
, cmd_match
);
795 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
797 static void command_help_show_indent(unsigned n
)
799 for (unsigned i
= 0; i
< n
; i
++)
802 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
804 const char *cp
= str
, *last
= str
;
806 const char *next
= last
;
811 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
812 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
813 if (next
- last
< HELP_LINE_WIDTH(n
))
815 command_help_show_indent(n
);
816 LOG_USER("%.*s", (int)(cp
- last
), last
);
822 static COMMAND_HELPER(command_help_show
, struct help_entry
*c
,
823 bool show_help
, const char *cmd_match
)
826 for (const char *s
= strchr(c
->cmd_name
, ' '); s
; s
= strchr(s
+ 1, ' '))
829 /* If the match string occurs anywhere, we print out
830 * stuff for this command. */
831 bool is_match
= (strstr(c
->cmd_name
, cmd_match
) != NULL
) ||
832 ((c
->usage
!= NULL
) && (strstr(c
->usage
, cmd_match
) != NULL
)) ||
833 ((c
->help
!= NULL
) && (strstr(c
->help
, cmd_match
) != NULL
));
836 command_help_show_indent(n
);
837 LOG_USER_N("%s", c
->cmd_name
);
839 if (c
->usage
&& strlen(c
->usage
) > 0) {
841 command_help_show_wrap(c
->usage
, 0, n
+ 5);
846 if (is_match
&& show_help
) {
849 /* TODO: factorize jim_command_mode() to avoid running jim command here */
850 char *request
= alloc_printf("command mode %s", c
->cmd_name
);
852 LOG_ERROR("Out of memory");
855 int retval
= Jim_Eval(CMD_CTX
->interp
, request
);
857 enum command_mode mode
= COMMAND_UNKNOWN
;
858 if (retval
!= JIM_ERR
) {
859 const char *result
= Jim_GetString(Jim_GetResult(CMD_CTX
->interp
), NULL
);
860 if (!strcmp(result
, "any"))
862 else if (!strcmp(result
, "config"))
863 mode
= COMMAND_CONFIG
;
864 else if (!strcmp(result
, "exec"))
868 /* Normal commands are runtime-only; highlight exceptions */
869 if (mode
!= COMMAND_EXEC
) {
870 const char *stage_msg
= "";
874 stage_msg
= " (configuration command)";
877 stage_msg
= " (command valid any time)";
880 stage_msg
= " (?mode error?)";
883 msg
= alloc_printf("%s%s", c
->help
? : "", stage_msg
);
885 msg
= alloc_printf("%s", c
->help
? : "");
888 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
897 COMMAND_HANDLER(handle_help_command
)
899 bool full
= strcmp(CMD_NAME
, "help") == 0;
904 cmd_match
= strdup("");
907 cmd_match
= strdup(CMD_ARGV
[0]);
909 for (unsigned int i
= 1; i
< CMD_ARGC
&& cmd_match
; ++i
) {
910 char *prev
= cmd_match
;
911 cmd_match
= alloc_printf("%s %s", prev
, CMD_ARGV
[i
]);
916 if (cmd_match
== NULL
) {
917 LOG_ERROR("unable to build search string");
920 retval
= CALL_COMMAND_HANDLER(command_help_show_list
, full
, cmd_match
);
926 static char *alloc_concatenate_strings(int argc
, Jim_Obj
* const *argv
)
933 all
= strdup(Jim_GetString(argv
[0], NULL
));
935 LOG_ERROR("Out of memory");
939 for (i
= 1; i
< argc
; ++i
) {
941 all
= alloc_printf("%s %s", all
, Jim_GetString(argv
[i
], NULL
));
944 LOG_ERROR("Out of memory");
952 static int exec_command(Jim_Interp
*interp
, struct command_context
*cmd_ctx
,
953 struct command
*c
, int argc
, Jim_Obj
* const *argv
)
956 return c
->jim_handler(interp
, argc
, argv
);
960 char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
964 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
965 script_command_args_free(words
, nwords
);
966 return command_retval_set(interp
, retval
);
969 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
971 script_debug(interp
, argc
, argv
);
973 /* check subcommands */
975 char *s
= alloc_printf("%s %s", Jim_GetString(argv
[0], NULL
), Jim_GetString(argv
[1], NULL
));
976 Jim_Obj
*js
= Jim_NewStringObj(interp
, s
, -1);
977 Jim_IncrRefCount(js
);
979 Jim_Cmd
*cmd
= Jim_GetCommand(interp
, js
, JIM_NONE
);
981 int retval
= Jim_EvalObjPrefix(interp
, js
, argc
- 2, argv
+ 2);
982 Jim_DecrRefCount(interp
, js
);
985 Jim_DecrRefCount(interp
, js
);
988 struct command
*c
= jim_to_command(interp
);
989 if (!c
->jim_handler
&& !c
->handler
) {
990 Jim_EvalObjPrefix(interp
, Jim_NewStringObj(interp
, "usage", -1), 1, argv
);
994 struct command_context
*cmd_ctx
= current_command_context(interp
);
996 if (!command_can_run(cmd_ctx
, c
, Jim_GetString(argv
[0], NULL
)))
999 target_call_timer_callbacks_now();
1002 * Black magic of overridden current target:
1003 * If the command we are going to handle has a target prefix,
1004 * override the current target temporarily for the time
1005 * of processing the command.
1006 * current_target_override is used also for event handlers
1007 * therefore we prevent touching it if command has no prefix.
1008 * Previous override is saved and restored back to ensure
1009 * correct work when command_unknown() is re-entered.
1011 struct target
*saved_target_override
= cmd_ctx
->current_target_override
;
1012 if (c
->jim_override_target
)
1013 cmd_ctx
->current_target_override
= c
->jim_override_target
;
1015 int retval
= exec_command(interp
, cmd_ctx
, c
, argc
, argv
);
1017 if (c
->jim_override_target
)
1018 cmd_ctx
->current_target_override
= saved_target_override
;
1023 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1025 struct command_context
*cmd_ctx
= current_command_context(interp
);
1026 enum command_mode mode
;
1029 char *full_name
= alloc_concatenate_strings(argc
- 1, argv
+ 1);
1032 Jim_Obj
*s
= Jim_NewStringObj(interp
, full_name
, -1);
1033 Jim_IncrRefCount(s
);
1034 Jim_Cmd
*cmd
= Jim_GetCommand(interp
, s
, JIM_NONE
);
1035 Jim_DecrRefCount(interp
, s
);
1037 if (!cmd
|| !(jimcmd_is_proc(cmd
) || jimcmd_is_ocd_command(cmd
))) {
1038 Jim_SetResultString(interp
, "unknown", -1);
1042 if (jimcmd_is_proc(cmd
)) {
1046 struct command
*c
= jimcmd_privdata(cmd
);
1051 mode
= cmd_ctx
->mode
;
1053 const char *mode_str
;
1058 case COMMAND_CONFIG
:
1059 mode_str
= "config";
1065 mode_str
= "unknown";
1068 Jim_SetResultString(interp
, mode_str
, -1);
1072 int help_del_all_commands(struct command_context
*cmd_ctx
)
1074 struct help_entry
*curr
, *n
;
1076 list_for_each_entry_safe(curr
, n
, cmd_ctx
->help_list
, lh
) {
1077 list_del(&curr
->lh
);
1078 free(curr
->cmd_name
);
1086 static int help_del_command(struct command_context
*cmd_ctx
, const char *cmd_name
)
1088 struct help_entry
*curr
;
1090 list_for_each_entry(curr
, cmd_ctx
->help_list
, lh
) {
1091 if (!strcmp(cmd_name
, curr
->cmd_name
)) {
1092 list_del(&curr
->lh
);
1093 free(curr
->cmd_name
);
1104 static int help_add_command(struct command_context
*cmd_ctx
,
1105 const char *cmd_name
, const char *help_text
, const char *usage_text
)
1107 int cmp
= -1; /* add after curr */
1108 struct help_entry
*curr
;
1110 list_for_each_entry_reverse(curr
, cmd_ctx
->help_list
, lh
) {
1111 cmp
= strcmp(cmd_name
, curr
->cmd_name
);
1116 struct help_entry
*entry
;
1118 entry
= calloc(1, sizeof(*entry
));
1120 LOG_ERROR("Out of memory");
1123 entry
->cmd_name
= strdup(cmd_name
);
1124 if (!entry
->cmd_name
) {
1125 LOG_ERROR("Out of memory");
1129 list_add(&entry
->lh
, &curr
->lh
);
1135 char *text
= strdup(help_text
);
1137 LOG_ERROR("Out of memory");
1145 char *text
= strdup(usage_text
);
1147 LOG_ERROR("Out of memory");
1151 entry
->usage
= text
;
1157 COMMAND_HANDLER(handle_help_add_command
)
1160 return ERROR_COMMAND_SYNTAX_ERROR
;
1162 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? CMD_ARGV
[1] : NULL
;
1163 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? CMD_ARGV
[1] : NULL
;
1164 if (!help
&& !usage
) {
1165 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1166 return ERROR_COMMAND_SYNTAX_ERROR
;
1168 const char *cmd_name
= CMD_ARGV
[0];
1169 return help_add_command(CMD_CTX
, cmd_name
, help
, usage
);
1172 /* sleep command sleeps for <n> milliseconds
1173 * this is useful in target startup scripts
1175 COMMAND_HANDLER(handle_sleep_command
)
1178 if (CMD_ARGC
== 2) {
1179 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1182 return ERROR_COMMAND_SYNTAX_ERROR
;
1183 } else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1184 return ERROR_COMMAND_SYNTAX_ERROR
;
1186 unsigned long duration
= 0;
1187 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1188 if (ERROR_OK
!= retval
)
1192 int64_t then
= timeval_ms();
1193 while (timeval_ms() - then
< (int64_t)duration
) {
1194 target_call_timer_callbacks_now();
1198 busy_sleep(duration
);
1203 static const struct command_registration command_subcommand_handlers
[] = {
1206 .mode
= COMMAND_ANY
,
1207 .jim_handler
= jim_command_mode
,
1208 .usage
= "[command_name ...]",
1209 .help
= "Returns the command modes allowed by a command: "
1210 "'any', 'config', or 'exec'. If no command is "
1211 "specified, returns the current command mode. "
1212 "Returns 'unknown' if an unknown command is given. "
1213 "Command can be multiple tokens.",
1215 COMMAND_REGISTRATION_DONE
1218 static const struct command_registration command_builtin_handlers
[] = {
1221 .mode
= COMMAND_ANY
,
1222 .jim_handler
= jim_find
,
1223 .help
= "find full path to file",
1228 .mode
= COMMAND_ANY
,
1229 .jim_handler
= jim_capture
,
1230 .help
= "Capture progress output and return as tcl return value. If the "
1231 "progress output was empty, return tcl return value.",
1236 .handler
= jim_echo
,
1237 .mode
= COMMAND_ANY
,
1238 .help
= "Logs a message at \"user\" priority. "
1239 "Output message to stdout. "
1240 "Option \"-n\" suppresses trailing newline",
1241 .usage
= "[-n] string",
1244 .name
= "add_help_text",
1245 .handler
= handle_help_add_command
,
1246 .mode
= COMMAND_ANY
,
1247 .help
= "Add new command help text; "
1248 "Command can be multiple tokens.",
1249 .usage
= "command_name helptext_string",
1252 .name
= "add_usage_text",
1253 .handler
= handle_help_add_command
,
1254 .mode
= COMMAND_ANY
,
1255 .help
= "Add new command usage text; "
1256 "command can be multiple tokens.",
1257 .usage
= "command_name usage_string",
1261 .handler
= handle_sleep_command
,
1262 .mode
= COMMAND_ANY
,
1263 .help
= "Sleep for specified number of milliseconds. "
1264 "\"busy\" will busy wait instead (avoid this).",
1265 .usage
= "milliseconds ['busy']",
1269 .handler
= handle_help_command
,
1270 .mode
= COMMAND_ANY
,
1271 .help
= "Show full command help; "
1272 "command can be multiple tokens.",
1273 .usage
= "[command_name]",
1277 .handler
= handle_help_command
,
1278 .mode
= COMMAND_ANY
,
1279 .help
= "Show basic command usage; "
1280 "command can be multiple tokens.",
1281 .usage
= "[command_name]",
1285 .mode
= COMMAND_ANY
,
1286 .help
= "core command group (introspection)",
1287 .chain
= command_subcommand_handlers
,
1290 COMMAND_REGISTRATION_DONE
1293 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
)
1295 struct command_context
*context
= calloc(1, sizeof(struct command_context
));
1298 context
->mode
= COMMAND_EXEC
;
1300 /* context can be duplicated. Put list head on separate mem-chunk to keep list consistent */
1301 context
->help_list
= malloc(sizeof(*context
->help_list
));
1302 INIT_LIST_HEAD(context
->help_list
);
1304 /* Create a jim interpreter if we were not handed one */
1305 if (interp
== NULL
) {
1306 /* Create an interpreter */
1307 interp
= Jim_CreateInterp();
1308 /* Add all the Jim core commands */
1309 Jim_RegisterCoreCommands(interp
);
1310 Jim_InitStaticExtensions(interp
);
1313 context
->interp
= interp
;
1315 /* Stick to lowercase for HostOS strings. */
1316 #if defined(_MSC_VER)
1317 /* WinXX - is generic, the forward
1318 * looking problem is this:
1320 * "win32" or "win64"
1322 * "winxx" is generic.
1325 #elif defined(__linux__)
1327 #elif defined(__APPLE__) || defined(__DARWIN__)
1329 #elif defined(__CYGWIN__)
1331 #elif defined(__MINGW32__)
1333 #elif defined(__ECOS)
1335 #elif defined(__FreeBSD__)
1337 #elif defined(__NetBSD__)
1339 #elif defined(__OpenBSD__)
1342 #warning "Unrecognized host OS..."
1345 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1346 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1348 register_commands(context
, NULL
, command_builtin_handlers
);
1350 Jim_SetAssocData(interp
, "context", NULL
, context
);
1351 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl", 1) == JIM_ERR
) {
1352 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1353 Jim_MakeErrorMessage(interp
);
1354 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
1357 Jim_DeleteAssocData(interp
, "context");
1362 void command_exit(struct command_context
*context
)
1367 Jim_FreeInterp(context
->interp
);
1368 free(context
->help_list
);
1369 command_done(context
);
1372 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1375 return ERROR_COMMAND_SYNTAX_ERROR
;
1377 cmd_ctx
->mode
= mode
;
1381 void process_jim_events(struct command_context
*cmd_ctx
)
1383 static int recursion
;
1388 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1392 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1393 int parse ## name(const char *str, type * ul) \
1396 LOG_ERROR("Invalid command argument"); \
1397 return ERROR_COMMAND_ARGUMENT_INVALID; \
1401 *ul = func(str, &end, 0); \
1403 LOG_ERROR("Invalid command argument"); \
1404 return ERROR_COMMAND_ARGUMENT_INVALID; \
1406 if ((max == *ul) && (ERANGE == errno)) { \
1407 LOG_ERROR("Argument overflow"); \
1408 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1410 if (min && (min == *ul) && (ERANGE == errno)) { \
1411 LOG_ERROR("Argument underflow"); \
1412 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1416 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long, strtoul
, 0, ULONG_MAX
)
1417 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1418 DEFINE_PARSE_NUM_TYPE(_long
, long, strtol
, LONG_MIN
, LONG_MAX
)
1419 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1421 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1422 int parse ## name(const char *str, type * ul) \
1425 int retval = parse ## funcname(str, &n); \
1426 if (ERROR_OK != retval) \
1429 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1431 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1436 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1437 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1438 DEFINE_PARSE_ULONGLONG(_uint
, unsigned, 0, UINT_MAX
)
1439 DEFINE_PARSE_ULONGLONG(_u64
, uint64_t, 0, UINT64_MAX
)
1440 DEFINE_PARSE_ULONGLONG(_u32
, uint32_t, 0, UINT32_MAX
)
1441 DEFINE_PARSE_ULONGLONG(_u16
, uint16_t, 0, UINT16_MAX
)
1442 DEFINE_PARSE_ULONGLONG(_u8
, uint8_t, 0, UINT8_MAX
)
1444 DEFINE_PARSE_ULONGLONG(_target_addr
, target_addr_t
, 0, TARGET_ADDR_MAX
)
1446 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1447 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1448 DEFINE_PARSE_LONGLONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1449 DEFINE_PARSE_LONGLONG(_s64
, int64_t, n
< INT64_MIN
, INT64_MAX
)
1450 DEFINE_PARSE_LONGLONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1451 DEFINE_PARSE_LONGLONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1452 DEFINE_PARSE_LONGLONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1454 static int command_parse_bool(const char *in
, bool *out
,
1455 const char *on
, const char *off
)
1457 if (strcasecmp(in
, on
) == 0)
1459 else if (strcasecmp(in
, off
) == 0)
1462 return ERROR_COMMAND_SYNTAX_ERROR
;
1466 int command_parse_bool_arg(const char *in
, bool *out
)
1468 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1470 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1472 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1474 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1476 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1478 return ERROR_COMMAND_SYNTAX_ERROR
;
1481 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1485 const char *in
= CMD_ARGV
[0];
1486 if (command_parse_bool_arg(in
, out
) != ERROR_OK
) {
1487 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1488 return ERROR_COMMAND_SYNTAX_ERROR
;
1493 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1496 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)