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, write to the *
26 * Free Software Foundation, Inc., *
27 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
28 ***************************************************************************/
34 /* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
38 // @todo the inclusion of target.h here is a layering violation
41 #include "configuration.h"
43 #include "time_support.h"
44 #include "jim-eventloop.h"
47 /* nice short description of source file */
48 #define __THIS__FILE__ "command.c"
51 static int run_command(struct command_context
*context
,
52 struct command
*c
, const char *words
[], unsigned num_words
);
54 struct log_capture_state
{
59 static void tcl_output(void *privData
, const char *file
, unsigned line
,
60 const char *function
, const char *string
)
62 struct log_capture_state
*state
= (struct log_capture_state
*)privData
;
63 Jim_AppendString(state
->interp
, state
->output
, string
, strlen(string
));
66 static struct log_capture_state
*command_log_capture_start(Jim_Interp
*interp
)
68 /* capture log output and return it. A garbage collect can
69 * happen, so we need a reference count to this object */
70 Jim_Obj
*tclOutput
= Jim_NewStringObj(interp
, "", 0);
71 if (NULL
== tclOutput
)
74 struct log_capture_state
*state
= malloc(sizeof(*state
));
78 state
->interp
= interp
;
79 Jim_IncrRefCount(tclOutput
);
80 state
->output
= tclOutput
;
82 log_add_callback(tcl_output
, state
);
87 static void command_log_capture_finish(struct log_capture_state
*state
)
92 log_remove_callback(tcl_output
, state
);
94 Jim_SetResult(state
->interp
, state
->output
);
95 Jim_DecrRefCount(state
->interp
, state
->output
);
100 static int command_retval_set(Jim_Interp
*interp
, int retval
)
102 int *return_retval
= Jim_GetAssocData(interp
, "retval");
103 if (return_retval
!= NULL
)
104 *return_retval
= retval
;
106 return (retval
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
109 extern struct command_context
*global_cmd_ctx
;
111 void script_debug(Jim_Interp
*interp
, const char *name
,
112 unsigned argc
, Jim_Obj
*const *argv
)
114 LOG_DEBUG("command - %s", name
);
115 for (unsigned i
= 0; i
< argc
; i
++)
118 const char *w
= Jim_GetString(argv
[i
], &len
);
120 /* end of line comment? */
124 LOG_DEBUG("%s - argv[%d]=%s", name
, i
, w
);
128 static void script_command_args_free(const char **words
, unsigned nwords
)
130 for (unsigned i
= 0; i
< nwords
; i
++)
131 free((void *)words
[i
]);
134 static const char **script_command_args_alloc(
135 unsigned argc
, Jim_Obj
*const *argv
, unsigned *nwords
)
137 const char **words
= malloc(argc
* sizeof(char *));
142 for (i
= 0; i
< argc
; i
++)
145 const char *w
= Jim_GetString(argv
[i
], &len
);
146 /* a comment may end the line early */
150 words
[i
] = strdup(w
);
151 if (words
[i
] == NULL
)
153 script_command_args_free(words
, i
);
161 static struct command_context
*current_command_context(Jim_Interp
*interp
)
163 /* grab the command context from the associated data */
164 struct command_context
*cmd_ctx
= Jim_GetAssocData(interp
, "context");
167 /* Tcl can invoke commands directly instead of via command_run_line(). This would
168 * happen when the Jim Tcl interpreter is provided by eCos.
170 cmd_ctx
= global_cmd_ctx
;
175 static int script_command_run(Jim_Interp
*interp
,
176 int argc
, Jim_Obj
*const *argv
, struct command
*c
, bool capture
)
178 target_call_timer_callbacks_now();
179 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
182 const char **words
= script_command_args_alloc(argc
, argv
, &nwords
);
186 struct log_capture_state
*state
= NULL
;
188 state
= command_log_capture_start(interp
);
190 struct command_context
*cmd_ctx
= current_command_context(interp
);
191 int retval
= run_command(cmd_ctx
, c
, (const char **)words
, nwords
);
193 command_log_capture_finish(state
);
195 script_command_args_free(words
, nwords
);
196 return command_retval_set(interp
, retval
);
199 static int script_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
201 /* the private data is stashed in the interp structure */
203 struct command
*c
= interp
->cmdPrivData
;
205 script_debug(interp
, c
->name
, argc
, argv
);
206 return script_command_run(interp
, argc
, argv
, c
, true);
209 static struct command
*command_root(struct command
*c
)
211 while (NULL
!= c
->parent
)
217 * Find a command by name from a list of commands.
218 * @returns Returns the named command if it exists in the list.
219 * Returns NULL otherwise.
221 static struct command
*command_find(struct command
*head
, const char *name
)
223 for (struct command
*cc
= head
; cc
; cc
= cc
->next
)
225 if (strcmp(cc
->name
, name
) == 0)
230 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
233 return command_find(cmd_ctx
->commands
, name
);
235 struct command
*command_find_in_parent(struct command
*parent
,
238 return command_find(parent
->children
, name
);
242 * Add the command into the linked list, sorted by name.
243 * @param head Address to head of command list pointer, which may be
244 * updated if @c c gets inserted at the beginning of the list.
245 * @param c The command to add to the list pointed to by @c head.
247 static void command_add_child(struct command
**head
, struct command
*c
)
256 while ((*head
)->next
&& (strcmp(c
->name
, (*head
)->name
) > 0))
257 head
= &(*head
)->next
;
259 if (strcmp(c
->name
, (*head
)->name
) > 0) {
260 c
->next
= (*head
)->next
;
268 static struct command
**command_list_for_parent(
269 struct command_context
*cmd_ctx
, struct command
*parent
)
271 return parent
? &parent
->children
: &cmd_ctx
->commands
;
274 static void command_free(struct command
*c
)
276 /// @todo if command has a handler, unregister its jim command!
278 while (NULL
!= c
->children
)
280 struct command
*tmp
= c
->children
;
281 c
->children
= tmp
->next
;
288 free((void*)c
->help
);
290 free((void*)c
->usage
);
294 static struct command
*command_new(struct command_context
*cmd_ctx
,
295 struct command
*parent
, const struct command_registration
*cr
)
299 struct command
*c
= calloc(1, sizeof(struct command
));
303 c
->name
= strdup(cr
->name
);
305 c
->help
= strdup(cr
->help
);
307 c
->usage
= strdup(cr
->usage
);
309 if (!c
->name
|| (cr
->help
&& !c
->help
) || (cr
->usage
&& !c
->usage
))
310 goto command_new_error
;
313 c
->handler
= cr
->handler
;
314 c
->jim_handler
= cr
->jim_handler
;
315 c
->jim_handler_data
= cr
->jim_handler_data
;
318 command_add_child(command_list_for_parent(cmd_ctx
, parent
), c
);
327 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
329 static int register_command_handler(struct command_context
*cmd_ctx
,
332 Jim_Interp
*interp
= cmd_ctx
->interp
;
333 const char *ocd_name
= alloc_printf("ocd_%s", c
->name
);
334 if (NULL
== ocd_name
)
337 LOG_DEBUG("registering '%s'...", ocd_name
);
339 Jim_CmdProc func
= c
->handler
? &script_command
: &command_unknown
;
340 int retval
= Jim_CreateCommand(interp
, ocd_name
, func
, c
, NULL
);
341 free((void *)ocd_name
);
342 if (JIM_OK
!= retval
)
345 /* we now need to add an overrideable proc */
346 const char *override_name
= alloc_printf(
347 "proc %s {args} {eval ocd_bouncer %s $args}",
349 if (NULL
== override_name
)
352 retval
= Jim_Eval_Named(interp
, override_name
, __FILE__
, __LINE__
);
353 free((void *)override_name
);
358 struct command
* register_command(struct command_context
*context
,
359 struct command
*parent
, const struct command_registration
*cr
)
361 if (!context
|| !cr
->name
)
364 const char *name
= cr
->name
;
365 struct command
**head
= command_list_for_parent(context
, parent
);
366 struct command
*c
= command_find(*head
, name
);
369 LOG_ERROR("command '%s' is already registered in '%s' context",
370 name
, parent
? parent
->name
: "<global>");
374 c
= command_new(context
, parent
, cr
);
378 int retval
= ERROR_OK
;
379 if (NULL
!= cr
->jim_handler
&& NULL
== parent
)
381 retval
= Jim_CreateCommand(context
->interp
, cr
->name
,
382 cr
->jim_handler
, cr
->jim_handler_data
, NULL
);
384 else if (NULL
!= cr
->handler
|| NULL
!= parent
)
385 retval
= register_command_handler(context
, command_root(c
));
387 if (ERROR_OK
!= retval
)
389 unregister_command(context
, parent
, name
);
395 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
396 const struct command_registration
*cmds
)
398 int retval
= ERROR_OK
;
400 for (i
= 0; cmds
[i
].name
|| cmds
[i
].chain
; i
++)
402 const struct command_registration
*cr
= cmds
+ i
;
404 struct command
*c
= NULL
;
405 if (NULL
!= cr
->name
)
407 c
= register_command(cmd_ctx
, parent
, cr
);
414 if (NULL
!= cr
->chain
)
416 struct command
*p
= c
? : parent
;
417 retval
= register_commands(cmd_ctx
, p
, cr
->chain
);
418 if (ERROR_OK
!= retval
)
422 if (ERROR_OK
!= retval
)
424 for (unsigned j
= 0; j
< i
; j
++)
425 unregister_command(cmd_ctx
, parent
, cmds
[j
].name
);
430 int unregister_all_commands(struct command_context
*context
,
431 struct command
*parent
)
436 struct command
**head
= command_list_for_parent(context
, parent
);
437 while (NULL
!= *head
)
439 struct command
*tmp
= *head
;
447 int unregister_command(struct command_context
*context
,
448 struct command
*parent
, const char *name
)
450 if ((!context
) || (!name
))
451 return ERROR_INVALID_ARGUMENTS
;
453 struct command
*p
= NULL
;
454 struct command
**head
= command_list_for_parent(context
, parent
);
455 for (struct command
*c
= *head
; NULL
!= c
; p
= c
, c
= c
->next
)
457 if (strcmp(name
, c
->name
) != 0)
472 void command_set_handler_data(struct command
*c
, void *p
)
474 if (NULL
!= c
->handler
|| NULL
!= c
->jim_handler
)
475 c
->jim_handler_data
= p
;
476 for (struct command
*cc
= c
->children
; NULL
!= cc
; cc
= cc
->next
)
477 command_set_handler_data(cc
, p
);
480 void command_output_text(struct command_context
*context
, const char *data
)
482 if (context
&& context
->output_handler
&& data
) {
483 context
->output_handler(context
, data
);
487 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
492 va_start(ap
, format
);
494 string
= alloc_vprintf(format
, ap
);
497 /* we want this collected in the log + we also want to pick it up as a tcl return
500 * The latter bit isn't precisely neat, but will do for now.
502 LOG_USER_N("%s", string
);
503 /* We already printed it above */
504 /* command_output_text(context, string); */
511 void command_print(struct command_context
*context
, const char *format
, ...)
516 va_start(ap
, format
);
518 string
= alloc_vprintf(format
, ap
);
521 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
522 /* we want this collected in the log + we also want to pick it up as a tcl return
525 * The latter bit isn't precisely neat, but will do for now.
527 LOG_USER_N("%s", string
);
528 /* We already printed it above */
529 /* command_output_text(context, string); */
536 static char *__command_name(struct command
*c
, char delim
, unsigned extra
)
539 unsigned len
= strlen(c
->name
);
540 if (NULL
== c
->parent
) {
541 // allocate enough for the name, child names, and '\0'
542 name
= malloc(len
+ extra
+ 1);
543 strcpy(name
, c
->name
);
545 // parent's extra must include both the space and name
546 name
= __command_name(c
->parent
, delim
, 1 + len
+ extra
);
547 char dstr
[2] = { delim
, 0 };
549 strcat(name
, c
->name
);
553 char *command_name(struct command
*c
, char delim
)
555 return __command_name(c
, delim
, 0);
558 static bool command_can_run(struct command_context
*cmd_ctx
, struct command
*c
)
560 return c
->mode
== COMMAND_ANY
|| c
->mode
== cmd_ctx
->mode
;
563 static int run_command(struct command_context
*context
,
564 struct command
*c
, const char *words
[], unsigned num_words
)
566 if (!command_can_run(context
, c
))
568 /* Many commands may be run only before/after 'init' */
571 case COMMAND_CONFIG
: when
= "before"; break;
572 case COMMAND_EXEC
: when
= "after"; break;
573 // handle the impossible with humor; it guarantees a bug report!
574 default: when
= "if Cthulhu is summoned by"; break;
576 LOG_ERROR("The '%s' command must be used %s 'init'.",
581 struct command_invocation cmd
= {
584 .argc
= num_words
- 1,
587 int retval
= c
->handler(&cmd
);
588 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
);
598 else if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
600 /* just fall through for a shutdown request */
602 else if (retval
!= ERROR_OK
)
604 /* we do not print out an error message because the command *should*
605 * have printed out an error
607 LOG_DEBUG("Command failed with error code %d", retval
);
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 Jim_Interp
*interp
= context
->interp
;
628 Jim_DeleteAssocData(interp
, "context");
629 retcode
= Jim_SetAssocData(interp
, "context", NULL
, context
);
630 if (retcode
== JIM_OK
)
632 /* associated the return value */
633 Jim_DeleteAssocData(interp
, "retval");
634 retcode
= Jim_SetAssocData(interp
, "retval", NULL
, &retval
);
635 if (retcode
== JIM_OK
)
637 retcode
= Jim_Eval_Named(interp
, line
, __THIS__FILE__
, __LINE__
);
639 Jim_DeleteAssocData(interp
, "retval");
641 Jim_DeleteAssocData(interp
, "context");
643 if (retcode
== JIM_ERR
) {
644 if (retval
!= ERROR_COMMAND_CLOSE_CONNECTION
)
646 /* We do not print the connection closed error message */
647 Jim_PrintErrorMessage(interp
);
649 if (retval
== ERROR_OK
)
651 /* It wasn't a low level OpenOCD command that failed */
655 } else if (retcode
== JIM_EXIT
) {
657 /* exit(Jim_GetExitCode(interp)); */
662 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
667 for (i
= 0; i
< reslen
; i
+= 256)
673 strncpy(buff
, result
+ i
, chunk
);
675 LOG_USER_N("%s", buff
);
677 LOG_USER_N("%s", "\n");
684 int command_run_linef(struct command_context
*context
, const char *format
, ...)
686 int retval
= ERROR_FAIL
;
689 va_start(ap
, format
);
690 string
= alloc_vprintf(format
, ap
);
693 retval
= command_run_line(context
, string
);
699 void command_set_output_handler(struct command_context
* context
,
700 command_output_handler_t output_handler
, void *priv
)
702 context
->output_handler
= output_handler
;
703 context
->output_handler_priv
= priv
;
706 struct command_context
* copy_command_context(struct command_context
* context
)
708 struct command_context
* copy_context
= malloc(sizeof(struct command_context
));
710 *copy_context
= *context
;
715 void command_done(struct command_context
*cmd_ctx
)
723 /* find full path to file */
724 static int jim_find(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
728 const char *file
= Jim_GetString(argv
[1], NULL
);
729 char *full_path
= find_file(file
);
730 if (full_path
== NULL
)
732 Jim_Obj
*result
= Jim_NewStringObj(interp
, full_path
, strlen(full_path
));
735 Jim_SetResult(interp
, result
);
739 static int jim_echo(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
743 const char *str
= Jim_GetString(argv
[1], NULL
);
748 static size_t openocd_jim_fwrite(const void *_ptr
, size_t size
, size_t n
, void *cookie
)
754 /* make it a char easier to read code */
758 if (ptr
== NULL
|| interp
== NULL
|| nbytes
== 0) {
762 /* do we have to chunk it? */
763 if (ptr
[nbytes
] == 0)
765 /* no it is a C style string */
766 LOG_USER_N("%s", ptr
);
769 /* GRR we must chunk - not null terminated */
779 memcpy(chunk
, ptr
, x
);
783 LOG_USER_N("%s", chunk
);
791 static size_t openocd_jim_fread(void *ptr
, size_t size
, size_t n
, void *cookie
)
793 /* TCL wants to read... tell him no */
797 static int openocd_jim_vfprintf(void *cookie
, const char *fmt
, va_list ap
)
808 cp
= alloc_vprintf(fmt
, ap
);
811 LOG_USER_N("%s", cp
);
818 static int openocd_jim_fflush(void *cookie
)
820 /* nothing to flush */
824 static char* openocd_jim_fgets(char *s
, int size
, void *cookie
)
831 static int jim_capture(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
836 struct log_capture_state
*state
= command_log_capture_start(interp
);
838 const char *str
= Jim_GetString(argv
[1], NULL
);
839 int retcode
= Jim_Eval_Named(interp
, str
, __THIS__FILE__
, __LINE__
);
841 command_log_capture_finish(state
);
846 static COMMAND_HELPER(command_help_find
, struct command
*head
,
847 struct command
**out
)
850 return ERROR_INVALID_ARGUMENTS
;
851 *out
= command_find(head
, CMD_ARGV
[0]);
852 if (NULL
== *out
&& strncmp(CMD_ARGV
[0], "ocd_", 4) == 0)
853 *out
= command_find(head
, CMD_ARGV
[0] + 4);
855 return ERROR_INVALID_ARGUMENTS
;
859 return CALL_COMMAND_HANDLER(command_help_find
, (*out
)->children
, out
);
862 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
865 static COMMAND_HELPER(command_help_show_list
, struct command
*head
, unsigned n
,
868 for (struct command
*c
= head
; NULL
!= c
; c
= c
->next
)
869 CALL_COMMAND_HANDLER(command_help_show
, c
, n
, show_help
);
873 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
875 static void command_help_show_indent(unsigned n
)
877 for (unsigned i
= 0; i
< n
; i
++)
880 static void command_help_show_wrap(const char *str
, unsigned n
, unsigned n2
)
882 const char *cp
= str
, *last
= str
;
885 const char *next
= last
;
890 } while (*next
!= ' ' && *next
!= '\t' && *next
!= '\0');
891 } while ((next
- last
< HELP_LINE_WIDTH(n
)) && *next
!= '\0');
892 if (next
- last
< HELP_LINE_WIDTH(n
))
894 command_help_show_indent(n
);
895 LOG_USER_N("%.*s", (int)(cp
- last
), last
);
901 static COMMAND_HELPER(command_help_show
, struct command
*c
, unsigned n
,
904 if (!command_can_run(CMD_CTX
, c
))
907 char *cmd_name
= command_name(c
, ' ');
908 if (NULL
== cmd_name
)
911 command_help_show_indent(n
);
912 LOG_USER_N("%s", cmd_name
);
917 command_help_show_wrap(c
->usage
, 0, n
+ 5);
924 const char *stage_msg
;
926 case COMMAND_CONFIG
: stage_msg
= "CONFIG"; break;
927 case COMMAND_EXEC
: stage_msg
= "EXEC"; break;
928 case COMMAND_ANY
: stage_msg
= "CONFIG or EXEC"; break;
929 default: stage_msg
= "***UNKNOWN***"; break;
931 char *msg
= alloc_printf("%s%sValid Modes: %s",
932 c
->help
? : "", c
->help
? " " : "", stage_msg
);
935 command_help_show_wrap(msg
, n
+ 3, n
+ 3);
944 return CALL_COMMAND_HANDLER(command_help_show_list
,
945 c
->children
, n
, show_help
);
947 COMMAND_HANDLER(handle_help_command
)
949 bool full
= strcmp(CMD_NAME
, "help") == 0;
951 struct command
*c
= CMD_CTX
->commands
;
954 return CALL_COMMAND_HANDLER(command_help_show_list
, c
, 0, full
);
956 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
957 if (ERROR_OK
!= retval
)
960 return CALL_COMMAND_HANDLER(command_help_show
, c
, 0, full
);
963 static int command_unknown_find(unsigned argc
, Jim_Obj
*const *argv
,
964 struct command
*head
, struct command
**out
, bool top_level
)
968 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
969 struct command
*c
= command_find(head
, cmd_name
);
970 if (NULL
== c
&& top_level
&& strncmp(cmd_name
, "ocd_", 4) == 0)
971 c
= command_find(head
, cmd_name
+ 4);
975 return command_unknown_find(--argc
, ++argv
, (*out
)->children
, out
, false);
978 static int command_unknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
980 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
981 if (strcmp(cmd_name
, "unknown") == 0)
988 script_debug(interp
, cmd_name
, argc
, argv
);
990 struct command_context
*cmd_ctx
= current_command_context(interp
);
991 struct command
*c
= cmd_ctx
->commands
;
992 int remaining
= command_unknown_find(argc
, argv
, c
, &c
, true);
993 // if nothing could be consumed, then it's really an unknown command
994 if (remaining
== argc
)
996 const char *cmd
= Jim_GetString(argv
[0], NULL
);
997 LOG_ERROR("Unknown command:\n %s", cmd
);
1002 Jim_Obj
*const *start
;
1004 if (c
->handler
|| c
->jim_handler
)
1006 // include the command name in the list
1007 count
= remaining
+ 1;
1008 start
= argv
+ (argc
- remaining
- 1);
1012 c
= command_find(cmd_ctx
->commands
, "usage");
1015 LOG_ERROR("unknown command, but usage is missing too");
1018 count
= argc
- remaining
;
1022 // pass the command through to the intended handler
1025 interp
->cmdPrivData
= c
->jim_handler_data
;
1026 return (*c
->jim_handler
)(interp
, count
, start
);
1029 return script_command_run(interp
, count
, start
, c
, found
);
1032 static int jim_command_mode(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1034 struct command_context
*cmd_ctx
= current_command_context(interp
);
1035 enum command_mode mode
;
1038 struct command
*c
= cmd_ctx
->commands
;
1039 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1040 // if nothing could be consumed, then it's an unknown command
1041 if (remaining
== argc
- 1)
1043 Jim_SetResultString(interp
, "unknown", -1);
1049 mode
= cmd_ctx
->mode
;
1051 const char *mode_str
;
1053 case COMMAND_ANY
: mode_str
= "any"; break;
1054 case COMMAND_CONFIG
: mode_str
= "config"; break;
1055 case COMMAND_EXEC
: mode_str
= "exec"; break;
1056 default: mode_str
= "unknown"; break;
1058 Jim_SetResultString(interp
, mode_str
, -1);
1062 static int jim_command_type(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
1067 struct command_context
*cmd_ctx
= current_command_context(interp
);
1068 struct command
*c
= cmd_ctx
->commands
;
1069 int remaining
= command_unknown_find(argc
- 1, argv
+ 1, c
, &c
, true);
1070 // if nothing could be consumed, then it's an unknown command
1071 if (remaining
== argc
- 1)
1073 Jim_SetResultString(interp
, "unknown", -1);
1078 Jim_SetResultString(interp
, "native", -1);
1079 else if (c
->handler
)
1080 Jim_SetResultString(interp
, "simple", -1);
1082 Jim_SetResultString(interp
, "group", -1);
1087 int help_add_command(struct command_context
*cmd_ctx
, struct command
*parent
,
1088 const char *cmd_name
, const char *help_text
, const char *usage
)
1090 struct command
**head
= command_list_for_parent(cmd_ctx
, parent
);
1091 struct command
*nc
= command_find(*head
, cmd_name
);
1094 // add a new command with help text
1095 struct command_registration cr
= {
1097 .mode
= COMMAND_ANY
,
1101 nc
= register_command(cmd_ctx
, parent
, &cr
);
1104 LOG_ERROR("failed to add '%s' help text", cmd_name
);
1107 LOG_DEBUG("added '%s' help text", cmd_name
);
1112 bool replaced
= false;
1115 free((void *)nc
->help
);
1118 nc
->help
= strdup(help_text
);
1120 LOG_INFO("replaced existing '%s' help", cmd_name
);
1122 LOG_DEBUG("added '%s' help text", cmd_name
);
1126 bool replaced
= false;
1129 free((void *)nc
->usage
);
1132 nc
->usage
= strdup(usage
);
1134 LOG_INFO("replaced existing '%s' usage", cmd_name
);
1136 LOG_DEBUG("added '%s' usage text", cmd_name
);
1141 COMMAND_HANDLER(handle_help_add_command
)
1145 LOG_ERROR("%s: insufficient arguments", CMD_NAME
);
1146 return ERROR_INVALID_ARGUMENTS
;
1149 // save help text and remove it from argument list
1150 const char *str
= CMD_ARGV
[--CMD_ARGC
];
1151 const char *help
= !strcmp(CMD_NAME
, "add_help_text") ? str
: NULL
;
1152 const char *usage
= !strcmp(CMD_NAME
, "add_usage_text") ? str
: NULL
;
1153 if (!help
&& !usage
)
1155 LOG_ERROR("command name '%s' is unknown", CMD_NAME
);
1156 return ERROR_INVALID_ARGUMENTS
;
1158 // likewise for the leaf command name
1159 const char *cmd_name
= CMD_ARGV
[--CMD_ARGC
];
1161 struct command
*c
= NULL
;
1164 c
= CMD_CTX
->commands
;
1165 int retval
= CALL_COMMAND_HANDLER(command_help_find
, c
, &c
);
1166 if (ERROR_OK
!= retval
)
1169 return help_add_command(CMD_CTX
, c
, cmd_name
, help
, usage
);
1172 /* sleep command sleeps for <n> miliseconds
1173 * this is useful in target startup scripts
1175 COMMAND_HANDLER(handle_sleep_command
)
1180 if (strcmp(CMD_ARGV
[1], "busy") == 0)
1183 return ERROR_COMMAND_SYNTAX_ERROR
;
1185 else if (CMD_ARGC
< 1 || CMD_ARGC
> 2)
1186 return ERROR_COMMAND_SYNTAX_ERROR
;
1188 unsigned long duration
= 0;
1189 int retval
= parse_ulong(CMD_ARGV
[0], &duration
);
1190 if (ERROR_OK
!= retval
)
1195 long long then
= timeval_ms();
1196 while (timeval_ms() - then
< (long long)duration
)
1198 target_call_timer_callbacks_now();
1203 busy_sleep(duration
);
1208 static const struct command_registration command_subcommand_handlers
[] = {
1211 .mode
= COMMAND_ANY
,
1212 .jim_handler
= &jim_command_mode
,
1213 .usage
= "[<name> ...]",
1214 .help
= "Returns the command modes allowed by a command:"
1215 "'any', 'config', or 'exec'. If no command is"
1216 "specified, returns the current command mode.",
1220 .mode
= COMMAND_ANY
,
1221 .jim_handler
= &jim_command_type
,
1222 .usage
= "<name> ...",
1223 .help
= "Returns the type of built-in command:"
1224 "'native', 'simple', 'group', or 'unknown'",
1226 COMMAND_REGISTRATION_DONE
1229 static const struct command_registration command_builtin_handlers
[] = {
1231 .name
= "add_help_text",
1232 .handler
= &handle_help_add_command
,
1233 .mode
= COMMAND_ANY
,
1234 .help
= "add new command help text",
1235 .usage
= "<command> [...] <help_text>]",
1238 .name
= "add_usage_text",
1239 .handler
= &handle_help_add_command
,
1240 .mode
= COMMAND_ANY
,
1241 .help
= "add new command usage text",
1242 .usage
= "<command> [...] <usage_text>]",
1246 .handler
= &handle_sleep_command
,
1247 .mode
= COMMAND_ANY
,
1248 .help
= "sleep for n milliseconds. "
1249 "\"busy\" will busy wait",
1250 .usage
= "<n> [busy]",
1254 .handler
= &handle_help_command
,
1255 .mode
= COMMAND_ANY
,
1256 .help
= "show full command help",
1257 .usage
= "[<command> ...]",
1261 .handler
= &handle_help_command
,
1262 .mode
= COMMAND_ANY
,
1263 .help
= "show basic command usage",
1264 .usage
= "[<command> ...]",
1269 .help
= "core command group (introspection)",
1270 .chain
= command_subcommand_handlers
,
1272 COMMAND_REGISTRATION_DONE
1275 struct command_context
* command_init(const char *startup_tcl
)
1277 struct command_context
* context
= malloc(sizeof(struct command_context
));
1280 context
->mode
= COMMAND_EXEC
;
1281 context
->commands
= NULL
;
1282 context
->current_target
= 0;
1283 context
->output_handler
= NULL
;
1284 context
->output_handler_priv
= NULL
;
1286 #if !BUILD_ECOSBOARD
1288 /* Create an interpreter */
1289 context
->interp
= Jim_CreateInterp();
1290 /* Add all the Jim core commands */
1291 Jim_RegisterCoreCommands(context
->interp
);
1294 Jim_Interp
*interp
= context
->interp
;
1295 #if defined(_MSC_VER)
1296 /* WinXX - is generic, the forward
1297 * looking problem is this:
1299 * "win32" or "win64"
1301 * "winxx" is generic.
1304 #elif defined(__linux__)
1306 #elif defined(__DARWIN__)
1308 #elif defined(__CYGWIN__)
1310 #elif defined(__MINGW32__)
1312 #elif defined(__ECOS)
1315 #warn unrecognized host OS...
1318 Jim_SetGlobalVariableStr(interp
, "ocd_HOSTOS",
1319 Jim_NewStringObj(interp
, HostOs
, strlen(HostOs
)));
1321 Jim_CreateCommand(interp
, "ocd_find", jim_find
, NULL
, NULL
);
1322 Jim_CreateCommand(interp
, "echo", jim_echo
, NULL
, NULL
);
1323 Jim_CreateCommand(interp
, "capture", jim_capture
, NULL
, NULL
);
1325 /* Set Jim's STDIO */
1326 interp
->cookie_stdin
= interp
;
1327 interp
->cookie_stdout
= interp
;
1328 interp
->cookie_stderr
= interp
;
1329 interp
->cb_fwrite
= openocd_jim_fwrite
;
1330 interp
->cb_fread
= openocd_jim_fread
;
1331 interp
->cb_vfprintf
= openocd_jim_vfprintf
;
1332 interp
->cb_fflush
= openocd_jim_fflush
;
1333 interp
->cb_fgets
= openocd_jim_fgets
;
1335 register_commands(context
, NULL
, command_builtin_handlers
);
1337 #if !BUILD_ECOSBOARD
1338 Jim_EventLoopOnLoad(interp
);
1340 Jim_SetAssocData(interp
, "context", NULL
, context
);
1341 if (Jim_Eval_Named(interp
, startup_tcl
, "embedded:startup.tcl",1) == JIM_ERR
)
1343 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1344 Jim_PrintErrorMessage(interp
);
1347 Jim_DeleteAssocData(interp
, "context");
1352 int command_context_mode(struct command_context
*cmd_ctx
, enum command_mode mode
)
1355 return ERROR_INVALID_ARGUMENTS
;
1357 cmd_ctx
->mode
= mode
;
1361 void process_jim_events(struct command_context
*cmd_ctx
)
1363 #if !BUILD_ECOSBOARD
1364 static int recursion
= 0;
1369 Jim_ProcessEvents(cmd_ctx
->interp
, JIM_ALL_EVENTS
| JIM_DONT_WAIT
);
1374 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1375 int parse##name(const char *str, type *ul) \
1379 LOG_ERROR("Invalid command argument"); \
1380 return ERROR_COMMAND_ARGUMENT_INVALID; \
1383 *ul = func(str, &end, 0); \
1386 LOG_ERROR("Invalid command argument"); \
1387 return ERROR_COMMAND_ARGUMENT_INVALID; \
1389 if ((max == *ul) && (ERANGE == errno)) \
1391 LOG_ERROR("Argument overflow"); \
1392 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1394 if (min && (min == *ul) && (ERANGE == errno)) \
1396 LOG_ERROR("Argument underflow"); \
1397 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1401 DEFINE_PARSE_NUM_TYPE(_ulong
, unsigned long , strtoul
, 0, ULONG_MAX
)
1402 DEFINE_PARSE_NUM_TYPE(_ullong
, unsigned long long, strtoull
, 0, ULLONG_MAX
)
1403 DEFINE_PARSE_NUM_TYPE(_long
, long , strtol
, LONG_MIN
, LONG_MAX
)
1404 DEFINE_PARSE_NUM_TYPE(_llong
, long long, strtoll
, LLONG_MIN
, LLONG_MAX
)
1406 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1407 int parse##name(const char *str, type *ul) \
1410 int retval = parse##funcname(str, &n); \
1411 if (ERROR_OK != retval) \
1414 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1416 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1421 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1422 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1423 DEFINE_PARSE_ULONG(_uint
, unsigned, 0, UINT_MAX
)
1424 DEFINE_PARSE_ULONG(_u32
, uint32_t, 0, UINT32_MAX
)
1425 DEFINE_PARSE_ULONG(_u16
, uint16_t, 0, UINT16_MAX
)
1426 DEFINE_PARSE_ULONG(_u8
, uint8_t, 0, UINT8_MAX
)
1428 #define DEFINE_PARSE_LONG(name, type, min, max) \
1429 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1430 DEFINE_PARSE_LONG(_int
, int, n
< INT_MIN
, INT_MAX
)
1431 DEFINE_PARSE_LONG(_s32
, int32_t, n
< INT32_MIN
, INT32_MAX
)
1432 DEFINE_PARSE_LONG(_s16
, int16_t, n
< INT16_MIN
, INT16_MAX
)
1433 DEFINE_PARSE_LONG(_s8
, int8_t, n
< INT8_MIN
, INT8_MAX
)
1435 static int command_parse_bool(const char *in
, bool *out
,
1436 const char *on
, const char *off
)
1438 if (strcasecmp(in
, on
) == 0)
1440 else if (strcasecmp(in
, off
) == 0)
1443 return ERROR_COMMAND_SYNTAX_ERROR
;
1447 int command_parse_bool_arg(const char *in
, bool *out
)
1449 if (command_parse_bool(in
, out
, "on", "off") == ERROR_OK
)
1451 if (command_parse_bool(in
, out
, "enable", "disable") == ERROR_OK
)
1453 if (command_parse_bool(in
, out
, "true", "false") == ERROR_OK
)
1455 if (command_parse_bool(in
, out
, "yes", "no") == ERROR_OK
)
1457 if (command_parse_bool(in
, out
, "1", "0") == ERROR_OK
)
1459 return ERROR_INVALID_ARGUMENTS
;
1462 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
)
1466 const char *in
= CMD_ARGV
[0];
1467 if (command_parse_bool_arg(in
, out
) != ERROR_OK
)
1469 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME
, in
);
1470 return ERROR_INVALID_ARGUMENTS
;
1475 LOG_INFO("%s is %s", label
, *out
? "enabled" : "disabled");
1478 return ERROR_INVALID_ARGUMENTS
;