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 Jim_Interp *interp = NULL;
49 static int run_command(struct command_context *context,
50 struct command *c, const char *words[], unsigned num_words);
52 static void tcl_output(void *privData, const char *file, unsigned line,
53 const char *function, const char *string)
55 Jim_Obj *tclOutput = (Jim_Obj *)privData;
56 Jim_AppendString(interp, tclOutput, string, strlen(string));
59 extern struct command_context *global_cmd_ctx;
61 void script_debug(Jim_Interp *interp, const char *name,
62 unsigned argc, Jim_Obj *const *argv)
64 LOG_DEBUG("command - %s", name);
65 for (unsigned i = 0; i < argc; i++)
68 const char *w = Jim_GetString(argv[i], &len);
70 /* end of line comment? */
74 LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
78 static void script_command_args_free(const char **words, unsigned nwords)
80 for (unsigned i = 0; i < nwords; i++)
81 free((void *)words[i]);
84 static const char **script_command_args_alloc(
85 unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
87 const char **words = malloc(argc * sizeof(char *));
92 for (i = 0; i < argc; i++)
95 const char *w = Jim_GetString(argv[i], &len);
96 /* a comment may end the line early */
100 words[i] = strdup(w);
101 if (words[i] == NULL)
103 script_command_args_free(words, i);
111 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
113 /* the private data is stashed in the interp structure */
115 struct command_context *context;
118 /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
119 * get overwritten by running other Jim commands! Treat it as an
120 * emphemeral global variable that is used in lieu of an argument
121 * to the fn and fish it out manually.
123 c = interp->cmdPrivData;
126 LOG_ERROR("BUG: interp->cmdPrivData == NULL");
129 target_call_timer_callbacks_now();
130 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
132 script_debug(interp, c->name, argc, argv);
135 const char **words = script_command_args_alloc(argc, argv, &nwords);
139 /* grab the command context from the associated data */
140 context = Jim_GetAssocData(interp, "context");
143 /* Tcl can invoke commands directly instead of via command_run_line(). This would
144 * happen when the Jim Tcl interpreter is provided by eCos.
146 context = global_cmd_ctx;
149 /* capture log output and return it */
150 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
151 /* a garbage collect can happen, so we need a reference count to this object */
152 Jim_IncrRefCount(tclOutput);
154 log_add_callback(tcl_output, tclOutput);
156 retval = run_command(context, c, (const char **)words, nwords);
158 log_remove_callback(tcl_output, tclOutput);
160 /* We dump output into this local variable */
161 Jim_SetResult(interp, tclOutput);
162 Jim_DecrRefCount(interp, tclOutput);
164 script_command_args_free(words, nwords);
166 int *return_retval = Jim_GetAssocData(interp, "retval");
167 if (return_retval != NULL)
169 *return_retval = retval;
172 return (retval == ERROR_OK)?JIM_OK:JIM_ERR;
175 static Jim_Obj *command_name_list(struct command *c)
177 Jim_Obj *cmd_list = c->parent ?
178 command_name_list(c->parent) :
179 Jim_NewListObj(interp, NULL, 0);
180 Jim_ListAppendElement(interp, cmd_list,
181 Jim_NewStringObj(interp, c->name, -1));
186 static void command_helptext_add(Jim_Obj *cmd_list, const char *help)
188 Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
189 Jim_ListAppendElement(interp, cmd_entry, cmd_list);
190 Jim_ListAppendElement(interp, cmd_entry,
191 Jim_NewStringObj(interp, help ? : "", -1));
193 /* accumulate help text in Tcl helptext list. */
194 Jim_Obj *helptext = Jim_GetGlobalVariableStr(interp,
195 "ocd_helptext", JIM_ERRMSG);
196 if (Jim_IsShared(helptext))
197 helptext = Jim_DuplicateObj(interp, helptext);
198 Jim_ListAppendElement(interp, helptext, cmd_entry);
201 /* nice short description of source file */
202 #define __THIS__FILE__ "command.c"
205 * Find a command by name from a list of commands.
206 * @returns The named command if found, or NULL.
208 static struct command *command_find(struct command *head, const char *name)
210 for (struct command *cc = head; cc; cc = cc->next)
212 if (strcmp(cc->name, name) == 0)
219 * Add the command to the end of linked list.
220 * @returns Returns false if the named command already exists in the list.
221 * Returns true otherwise.
223 static void command_add_child(struct command **head, struct command *c)
231 struct command *cc = *head;
232 while (cc->next) cc = cc->next;
236 static struct command **command_list_for_parent(
237 struct command_context *cmd_ctx, struct command *parent)
239 return parent ? &parent->children : &cmd_ctx->commands;
242 static struct command *command_new(struct command_context *cmd_ctx,
243 struct command *parent, const char *name,
244 command_handler_t handler, enum command_mode mode,
249 struct command *c = malloc(sizeof(struct command));
250 memset(c, 0, sizeof(struct command));
252 c->name = strdup(name);
254 c->handler = handler;
257 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
259 command_helptext_add(command_name_list(c), help);
263 static void command_free(struct command *c)
265 /// @todo if command has a handler, unregister its jim command!
267 while (NULL != c->children)
269 struct command *tmp = c->children;
270 c->children = tmp->next;
279 struct command* register_command(struct command_context *context,
280 struct command *parent, const char *name,
281 command_handler_t handler, enum command_mode mode,
284 if (!context || !name)
287 struct command **head = command_list_for_parent(context, parent);
288 struct command *c = command_find(*head, name);
291 LOG_ERROR("command '%s' is already registered in '%s' context",
292 name, parent ? parent->name : "<global>");
296 c = command_new(context, parent, name, handler, mode, help);
297 /* if allocation failed or it is a placeholder (no handler), we're done */
298 if (NULL == c || NULL == c->handler)
301 const char *full_name = command_name(c, '_');
303 const char *ocd_name = alloc_printf("ocd_%s", full_name);
304 Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
305 free((void *)ocd_name);
307 /* we now need to add an overrideable proc */
308 const char *override_name = alloc_printf("proc %s {args} {"
309 "if {[catch {eval ocd_%s $args}] == 0} "
310 "{return \"\"} else {return -code error}}",
311 full_name, full_name);
312 Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
313 free((void *)override_name);
315 free((void *)full_name);
320 int unregister_all_commands(struct command_context *context,
321 struct command *parent)
326 struct command **head = command_list_for_parent(context, parent);
327 while (NULL != *head)
329 struct command *tmp = *head;
337 int unregister_command(struct command_context *context,
338 struct command *parent, const char *name)
340 if ((!context) || (!name))
341 return ERROR_INVALID_ARGUMENTS;
343 struct command *p = NULL;
344 struct command **head = command_list_for_parent(context, parent);
345 for (struct command *c = *head; NULL != c; p = c, c = c->next)
347 if (strcmp(name, c->name) != 0)
362 void command_output_text(struct command_context *context, const char *data)
364 if (context && context->output_handler && data) {
365 context->output_handler(context, data);
369 void command_print_sameline(struct command_context *context, const char *format, ...)
374 va_start(ap, format);
376 string = alloc_vprintf(format, ap);
379 /* we want this collected in the log + we also want to pick it up as a tcl return
382 * The latter bit isn't precisely neat, but will do for now.
384 LOG_USER_N("%s", string);
385 /* We already printed it above */
386 /* command_output_text(context, string); */
393 void command_print(struct command_context *context, const char *format, ...)
398 va_start(ap, format);
400 string = alloc_vprintf(format, ap);
403 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
404 /* we want this collected in the log + we also want to pick it up as a tcl return
407 * The latter bit isn't precisely neat, but will do for now.
409 LOG_USER_N("%s", string);
410 /* We already printed it above */
411 /* command_output_text(context, string); */
418 static char *__command_name(struct command *c, char delim, unsigned extra)
421 unsigned len = strlen(c->name);
422 if (NULL == c->parent) {
423 // allocate enough for the name, child names, and '\0'
424 name = malloc(len + extra + 1);
425 strcpy(name, c->name);
427 // parent's extra must include both the space and name
428 name = __command_name(c->parent, delim, 1 + len + extra);
429 char dstr[2] = { delim, 0 };
431 strcat(name, c->name);
435 char *command_name(struct command *c, char delim)
437 return __command_name(c, delim, 0);
440 static int run_command(struct command_context *context,
441 struct command *c, const char *words[], unsigned num_words)
443 if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
445 /* Config commands can not run after the config stage */
446 LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
450 struct command_invocation cmd = {
453 .argc = num_words - 1,
456 int retval = c->handler(&cmd);
457 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
459 /* Print help for command */
460 char *full_name = command_name(c, ' ');
461 if (NULL != full_name) {
462 command_run_linef(context, "help %s", full_name);
467 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
469 /* just fall through for a shutdown request */
471 else if (retval != ERROR_OK)
473 /* we do not print out an error message because the command *should*
474 * have printed out an error
476 LOG_DEBUG("Command failed with error code %d", retval);
482 int command_run_line(struct command_context *context, char *line)
484 /* all the parent commands have been registered with the interpreter
485 * so, can just evaluate the line as a script and check for
488 /* run the line thru a script engine */
489 int retval = ERROR_FAIL;
491 /* Beware! This code needs to be reentrant. It is also possible
492 * for OpenOCD commands to be invoked directly from Tcl. This would
493 * happen when the Jim Tcl interpreter is provided by eCos for
496 Jim_DeleteAssocData(interp, "context");
497 retcode = Jim_SetAssocData(interp, "context", NULL, context);
498 if (retcode == JIM_OK)
500 /* associated the return value */
501 Jim_DeleteAssocData(interp, "retval");
502 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
503 if (retcode == JIM_OK)
505 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
507 Jim_DeleteAssocData(interp, "retval");
509 Jim_DeleteAssocData(interp, "context");
511 if (retcode == JIM_ERR) {
512 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
514 /* We do not print the connection closed error message */
515 Jim_PrintErrorMessage(interp);
517 if (retval == ERROR_OK)
519 /* It wasn't a low level OpenOCD command that failed */
523 } else if (retcode == JIM_EXIT) {
525 /* exit(Jim_GetExitCode(interp)); */
530 result = Jim_GetString(Jim_GetResult(interp), &reslen);
535 for (i = 0; i < reslen; i += 256)
541 strncpy(buff, result + i, chunk);
543 LOG_USER_N("%s", buff);
545 LOG_USER_N("%s", "\n");
552 int command_run_linef(struct command_context *context, const char *format, ...)
554 int retval = ERROR_FAIL;
557 va_start(ap, format);
558 string = alloc_vprintf(format, ap);
561 retval = command_run_line(context, string);
567 void command_set_output_handler(struct command_context* context,
568 command_output_handler_t output_handler, void *priv)
570 context->output_handler = output_handler;
571 context->output_handler_priv = priv;
574 struct command_context* copy_command_context(struct command_context* context)
576 struct command_context* copy_context = malloc(sizeof(struct command_context));
578 *copy_context = *context;
583 int command_done(struct command_context *context)
591 /* find full path to file */
592 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
596 const char *file = Jim_GetString(argv[1], NULL);
597 char *full_path = find_file(file);
598 if (full_path == NULL)
600 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
603 Jim_SetResult(interp, result);
607 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
611 const char *str = Jim_GetString(argv[1], NULL);
616 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
622 /* make it a char easier to read code */
626 if (ptr == NULL || interp == NULL || nbytes == 0) {
630 /* do we have to chunk it? */
631 if (ptr[nbytes] == 0)
633 /* no it is a C style string */
634 LOG_USER_N("%s", ptr);
637 /* GRR we must chunk - not null terminated */
647 memcpy(chunk, ptr, x);
651 LOG_USER_N("%s", chunk);
659 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
661 /* TCL wants to read... tell him no */
665 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
676 cp = alloc_vprintf(fmt, ap);
679 LOG_USER_N("%s", cp);
686 static int openocd_jim_fflush(void *cookie)
688 /* nothing to flush */
692 static char* openocd_jim_fgets(char *s, int size, void *cookie)
699 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
704 const char *str = Jim_GetString(argv[1], NULL);
706 /* capture log output and return it */
707 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
708 /* a garbage collect can happen, so we need a reference count to this object */
709 Jim_IncrRefCount(tclOutput);
711 log_add_callback(tcl_output, tclOutput);
713 retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
715 log_remove_callback(tcl_output, tclOutput);
717 /* We dump output into this local variable */
718 Jim_SetResult(interp, tclOutput);
719 Jim_DecrRefCount(interp, tclOutput);
724 /* sleep command sleeps for <n> miliseconds
725 * this is useful in target startup scripts
727 COMMAND_HANDLER(handle_sleep_command)
732 if (strcmp(CMD_ARGV[1], "busy") == 0)
735 return ERROR_COMMAND_SYNTAX_ERROR;
737 else if (CMD_ARGC < 1 || CMD_ARGC > 2)
738 return ERROR_COMMAND_SYNTAX_ERROR;
740 unsigned long duration = 0;
741 int retval = parse_ulong(CMD_ARGV[0], &duration);
742 if (ERROR_OK != retval)
747 long long then = timeval_ms();
748 while (timeval_ms() - then < (long long)duration)
750 target_call_timer_callbacks_now();
755 busy_sleep(duration);
760 struct command_context* command_init(const char *startup_tcl)
762 struct command_context* context = malloc(sizeof(struct command_context));
765 context->mode = COMMAND_EXEC;
766 context->commands = NULL;
767 context->current_target = 0;
768 context->output_handler = NULL;
769 context->output_handler_priv = NULL;
773 /* Create an interpreter */
774 interp = Jim_CreateInterp();
775 /* Add all the Jim core commands */
776 Jim_RegisterCoreCommands(interp);
779 #if defined(_MSC_VER)
780 /* WinXX - is generic, the forward
781 * looking problem is this:
785 * "winxx" is generic.
788 #elif defined(__linux__)
790 #elif defined(__DARWIN__)
792 #elif defined(__CYGWIN__)
794 #elif defined(__MINGW32__)
796 #elif defined(__ECOS)
799 #warn unrecognized host OS...
802 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
803 Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
805 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
806 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
807 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
809 /* Set Jim's STDIO */
810 interp->cookie_stdin = interp;
811 interp->cookie_stdout = interp;
812 interp->cookie_stderr = interp;
813 interp->cb_fwrite = openocd_jim_fwrite;
814 interp->cb_fread = openocd_jim_fread ;
815 interp->cb_vfprintf = openocd_jim_vfprintf;
816 interp->cb_fflush = openocd_jim_fflush;
817 interp->cb_fgets = openocd_jim_fgets;
820 Jim_EventLoopOnLoad(interp);
822 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
824 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
825 Jim_PrintErrorMessage(interp);
829 register_command(context, NULL, "sleep",
830 handle_sleep_command, COMMAND_ANY,
831 "<n> [busy] - sleep for n milliseconds. "
832 "\"busy\" means busy wait");
837 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
840 return ERROR_INVALID_ARGUMENTS;
842 cmd_ctx->mode = mode;
846 void process_jim_events(void)
849 static int recursion = 0;
854 Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
860 void register_jim(struct command_context *cmd_ctx, const char *name,
861 Jim_CmdProc cmd, const char *help)
863 Jim_CreateCommand(interp, name, cmd, NULL, NULL);
865 Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
866 Jim_ListAppendElement(interp, cmd_list,
867 Jim_NewStringObj(interp, name, -1));
869 command_helptext_add(cmd_list, help);
872 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
873 int parse##name(const char *str, type *ul) \
877 LOG_ERROR("Invalid command argument"); \
878 return ERROR_COMMAND_ARGUMENT_INVALID; \
881 *ul = func(str, &end, 0); \
884 LOG_ERROR("Invalid command argument"); \
885 return ERROR_COMMAND_ARGUMENT_INVALID; \
887 if ((max == *ul) && (ERANGE == errno)) \
889 LOG_ERROR("Argument overflow"); \
890 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
892 if (min && (min == *ul) && (ERANGE == errno)) \
894 LOG_ERROR("Argument underflow"); \
895 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
899 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
900 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
901 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
902 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
904 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
905 int parse##name(const char *str, type *ul) \
908 int retval = parse##funcname(str, &n); \
909 if (ERROR_OK != retval) \
912 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
914 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
919 #define DEFINE_PARSE_ULONG(name, type, min, max) \
920 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
921 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
922 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
923 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
924 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
926 #define DEFINE_PARSE_LONG(name, type, min, max) \
927 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
928 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
929 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
930 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
931 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
933 static int command_parse_bool(const char *in, bool *out,
934 const char *on, const char *off)
936 if (strcasecmp(in, on) == 0)
938 else if (strcasecmp(in, off) == 0)
941 return ERROR_COMMAND_SYNTAX_ERROR;
945 int command_parse_bool_arg(const char *in, bool *out)
947 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
949 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
951 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
953 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
955 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
957 return ERROR_INVALID_ARGUMENTS;
960 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
964 const char *in = CMD_ARGV[0];
965 if (command_parse_bool_arg(in, out) != ERROR_OK)
967 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
968 return ERROR_INVALID_ARGUMENTS;
973 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
976 return ERROR_INVALID_ARGUMENTS;