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 int fast_and_dangerous = 0;
48 Jim_Interp *interp = NULL;
50 static int run_command(struct command_context *context,
51 struct command *c, const char *words[], unsigned num_words);
53 static void tcl_output(void *privData, const char *file, unsigned line,
54 const char *function, const char *string)
56 Jim_Obj *tclOutput = (Jim_Obj *)privData;
57 Jim_AppendString(interp, tclOutput, string, strlen(string));
60 extern struct command_context *global_cmd_ctx;
62 void script_debug(Jim_Interp *interp, const char *name,
63 unsigned argc, Jim_Obj *const *argv)
65 LOG_DEBUG("command - %s", name);
66 for (unsigned i = 0; i < argc; i++)
69 const char *w = Jim_GetString(argv[i], &len);
71 /* end of line comment? */
75 LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
79 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
81 /* the private data is stashed in the interp structure */
83 struct command_context *context;
89 /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
90 * get overwritten by running other Jim commands! Treat it as an
91 * emphemeral global variable that is used in lieu of an argument
92 * to the fn and fish it out manually.
94 c = interp->cmdPrivData;
97 LOG_ERROR("BUG: interp->cmdPrivData == NULL");
100 target_call_timer_callbacks_now();
101 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
103 script_debug(interp, c->name, argc, argv);
105 words = malloc(argc * sizeof(char *));
106 for (i = 0; i < argc; i++)
109 const char *w = Jim_GetString(argv[i], &len);
112 /* hit an end of line comment */
115 words[i] = strdup(w);
116 if (words[i] == NULL)
119 for (j = 0; j < i; j++)
127 /* grab the command context from the associated data */
128 context = Jim_GetAssocData(interp, "context");
131 /* Tcl can invoke commands directly instead of via command_run_line(). This would
132 * happen when the Jim Tcl interpreter is provided by eCos.
134 context = global_cmd_ctx;
137 /* capture log output and return it */
138 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
139 /* a garbage collect can happen, so we need a reference count to this object */
140 Jim_IncrRefCount(tclOutput);
142 log_add_callback(tcl_output, tclOutput);
144 // turn words[0] into CMD_ARGV[-1] with this cast
145 retval = run_command(context, c, (const char **)words, nwords);
147 log_remove_callback(tcl_output, tclOutput);
149 /* We dump output into this local variable */
150 Jim_SetResult(interp, tclOutput);
151 Jim_DecrRefCount(interp, tclOutput);
153 for (i = 0; i < nwords; i++)
157 int *return_retval = Jim_GetAssocData(interp, "retval");
158 if (return_retval != NULL)
160 *return_retval = retval;
163 return (retval == ERROR_OK)?JIM_OK:JIM_ERR;
166 static Jim_Obj *command_name_list(struct command *c)
168 Jim_Obj *cmd_list = c->parent ?
169 command_name_list(c->parent) :
170 Jim_NewListObj(interp, NULL, 0);
171 Jim_ListAppendElement(interp, cmd_list,
172 Jim_NewStringObj(interp, c->name, -1));
177 static void command_helptext_add(Jim_Obj *cmd_list, const char *help)
179 Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
180 Jim_ListAppendElement(interp, cmd_entry, cmd_list);
181 Jim_ListAppendElement(interp, cmd_entry,
182 Jim_NewStringObj(interp, help ? : "", -1));
184 /* accumulate help text in Tcl helptext list. */
185 Jim_Obj *helptext = Jim_GetGlobalVariableStr(interp,
186 "ocd_helptext", JIM_ERRMSG);
187 if (Jim_IsShared(helptext))
188 helptext = Jim_DuplicateObj(interp, helptext);
189 Jim_ListAppendElement(interp, helptext, cmd_entry);
192 /* nice short description of source file */
193 #define __THIS__FILE__ "command.c"
196 * Find a command by name from a list of commands.
197 * @returns The named command if found, or NULL.
199 static struct command *command_find(struct command **head, const char *name)
202 for (struct command *cc = *head; cc; cc = cc->next)
204 if (strcmp(cc->name, name) == 0)
211 * Add the command to the end of linked list.
212 * @returns Returns false if the named command already exists in the list.
213 * Returns true otherwise.
215 static void command_add_child(struct command **head, struct command *c)
223 struct command *cc = *head;
224 while (cc->next) cc = cc->next;
228 struct command* register_command(struct command_context *context,
229 struct command *parent, char *name, command_handler_t handler,
230 enum command_mode mode, char *help)
232 if (!context || !name)
235 struct command **head = parent ? &parent->children : &context->commands;
236 struct command *c = command_find(head, name);
240 c = malloc(sizeof(struct command));
242 c->name = strdup(name);
245 c->handler = handler;
249 command_add_child(head, c);
251 command_helptext_add(command_name_list(c), help);
253 /* just a placeholder, no handler */
254 if (c->handler == NULL)
257 const char *full_name = command_name(c, '_');
259 const char *ocd_name = alloc_printf("ocd_%s", full_name);
260 Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
261 free((void *)ocd_name);
263 /* we now need to add an overrideable proc */
264 const char *override_name = alloc_printf("proc %s {args} {"
265 "if {[catch {eval ocd_%s $args}] == 0} "
266 "{return \"\"} else {return -code error}}",
267 full_name, full_name);
268 Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
269 free((void *)override_name);
271 free((void *)full_name);
276 int unregister_all_commands(struct command_context *context)
278 struct command *c, *c2;
283 while (NULL != context->commands)
285 c = context->commands;
287 while (NULL != c->children)
290 c->children = c->children->next;
297 context->commands = context->commands->next;
308 int unregister_command(struct command_context *context, char *name)
310 struct command *c, *p = NULL, *c2;
312 if ((!context) || (!name))
313 return ERROR_INVALID_ARGUMENTS;
316 c = context->commands;
320 if (strcmp(name, c->name) == 0)
329 /* first element in command list */
330 context->commands = c->next;
333 /* unregister children */
334 while (NULL != c->children)
337 c->children = c->children->next;
352 /* remember the last command for unlinking */
360 void command_output_text(struct command_context *context, const char *data)
362 if (context && context->output_handler && data) {
363 context->output_handler(context, data);
367 void command_print_sameline(struct command_context *context, const char *format, ...)
372 va_start(ap, format);
374 string = alloc_vprintf(format, ap);
377 /* we want this collected in the log + we also want to pick it up as a tcl return
380 * The latter bit isn't precisely neat, but will do for now.
382 LOG_USER_N("%s", string);
383 /* We already printed it above */
384 /* command_output_text(context, string); */
391 void command_print(struct command_context *context, const char *format, ...)
396 va_start(ap, format);
398 string = alloc_vprintf(format, ap);
401 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
402 /* we want this collected in the log + we also want to pick it up as a tcl return
405 * The latter bit isn't precisely neat, but will do for now.
407 LOG_USER_N("%s", string);
408 /* We already printed it above */
409 /* command_output_text(context, string); */
416 static char *__command_name(struct command *c, char delim, unsigned extra)
419 unsigned len = strlen(c->name);
420 if (NULL == c->parent) {
421 // allocate enough for the name, child names, and '\0'
422 name = malloc(len + extra + 1);
423 strcpy(name, c->name);
425 // parent's extra must include both the space and name
426 name = __command_name(c->parent, delim, 1 + len + extra);
427 char dstr[2] = { delim, 0 };
429 strcat(name, c->name);
433 char *command_name(struct command *c, char delim)
435 return __command_name(c, delim, 0);
438 static int run_command(struct command_context *context,
439 struct command *c, const char *words[], unsigned num_words)
441 if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
443 /* Config commands can not run after the config stage */
444 LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
448 struct command_invocation cmd = {
451 .argc = num_words - 1,
454 int retval = c->handler(&cmd);
455 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
457 /* Print help for command */
458 char *full_name = command_name(c, ' ');
459 if (NULL != full_name) {
460 command_run_linef(context, "help %s", full_name);
465 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
467 /* just fall through for a shutdown request */
469 else if (retval != ERROR_OK)
471 /* we do not print out an error message because the command *should*
472 * have printed out an error
474 LOG_DEBUG("Command failed with error code %d", retval);
480 int command_run_line(struct command_context *context, char *line)
482 /* all the parent commands have been registered with the interpreter
483 * so, can just evaluate the line as a script and check for
486 /* run the line thru a script engine */
487 int retval = ERROR_FAIL;
489 /* Beware! This code needs to be reentrant. It is also possible
490 * for OpenOCD commands to be invoked directly from Tcl. This would
491 * happen when the Jim Tcl interpreter is provided by eCos for
494 Jim_DeleteAssocData(interp, "context");
495 retcode = Jim_SetAssocData(interp, "context", NULL, context);
496 if (retcode == JIM_OK)
498 /* associated the return value */
499 Jim_DeleteAssocData(interp, "retval");
500 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
501 if (retcode == JIM_OK)
503 retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
505 Jim_DeleteAssocData(interp, "retval");
507 Jim_DeleteAssocData(interp, "context");
509 if (retcode == JIM_ERR) {
510 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
512 /* We do not print the connection closed error message */
513 Jim_PrintErrorMessage(interp);
515 if (retval == ERROR_OK)
517 /* It wasn't a low level OpenOCD command that failed */
521 } else if (retcode == JIM_EXIT) {
523 /* exit(Jim_GetExitCode(interp)); */
528 result = Jim_GetString(Jim_GetResult(interp), &reslen);
533 for (i = 0; i < reslen; i += 256)
539 strncpy(buff, result + i, chunk);
541 LOG_USER_N("%s", buff);
543 LOG_USER_N("%s", "\n");
550 int command_run_linef(struct command_context *context, const char *format, ...)
552 int retval = ERROR_FAIL;
555 va_start(ap, format);
556 string = alloc_vprintf(format, ap);
559 retval = command_run_line(context, string);
565 void command_set_output_handler(struct command_context* context,
566 command_output_handler_t output_handler, void *priv)
568 context->output_handler = output_handler;
569 context->output_handler_priv = priv;
572 struct command_context* copy_command_context(struct command_context* context)
574 struct command_context* copy_context = malloc(sizeof(struct command_context));
576 *copy_context = *context;
581 int command_done(struct command_context *context)
589 /* find full path to file */
590 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
594 const char *file = Jim_GetString(argv[1], NULL);
595 char *full_path = find_file(file);
596 if (full_path == NULL)
598 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
601 Jim_SetResult(interp, result);
605 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
609 const char *str = Jim_GetString(argv[1], NULL);
614 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
620 /* make it a char easier to read code */
624 if (ptr == NULL || interp == NULL || nbytes == 0) {
628 /* do we have to chunk it? */
629 if (ptr[nbytes] == 0)
631 /* no it is a C style string */
632 LOG_USER_N("%s", ptr);
635 /* GRR we must chunk - not null terminated */
645 memcpy(chunk, ptr, x);
649 LOG_USER_N("%s", chunk);
657 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
659 /* TCL wants to read... tell him no */
663 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
674 cp = alloc_vprintf(fmt, ap);
677 LOG_USER_N("%s", cp);
684 static int openocd_jim_fflush(void *cookie)
686 /* nothing to flush */
690 static char* openocd_jim_fgets(char *s, int size, void *cookie)
697 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
702 const char *str = Jim_GetString(argv[1], NULL);
704 /* capture log output and return it */
705 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
706 /* a garbage collect can happen, so we need a reference count to this object */
707 Jim_IncrRefCount(tclOutput);
709 log_add_callback(tcl_output, tclOutput);
711 retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
713 log_remove_callback(tcl_output, tclOutput);
715 /* We dump output into this local variable */
716 Jim_SetResult(interp, tclOutput);
717 Jim_DecrRefCount(interp, tclOutput);
722 /* sleep command sleeps for <n> miliseconds
723 * this is useful in target startup scripts
725 COMMAND_HANDLER(handle_sleep_command)
730 if (strcmp(CMD_ARGV[1], "busy") == 0)
733 return ERROR_COMMAND_SYNTAX_ERROR;
735 else if (CMD_ARGC < 1 || CMD_ARGC > 2)
736 return ERROR_COMMAND_SYNTAX_ERROR;
738 unsigned long duration = 0;
739 int retval = parse_ulong(CMD_ARGV[0], &duration);
740 if (ERROR_OK != retval)
745 long long then = timeval_ms();
746 while (timeval_ms() - then < (long long)duration)
748 target_call_timer_callbacks_now();
753 busy_sleep(duration);
758 COMMAND_HANDLER(handle_fast_command)
761 return ERROR_COMMAND_SYNTAX_ERROR;
763 fast_and_dangerous = strcmp("enable", CMD_ARGV[0]) == 0;
769 struct command_context* command_init()
771 struct command_context* context = malloc(sizeof(struct command_context));
772 extern const char startup_tcl[];
775 context->mode = COMMAND_EXEC;
776 context->commands = NULL;
777 context->current_target = 0;
778 context->output_handler = NULL;
779 context->output_handler_priv = NULL;
783 /* Create an interpreter */
784 interp = Jim_CreateInterp();
785 /* Add all the Jim core commands */
786 Jim_RegisterCoreCommands(interp);
789 #if defined(_MSC_VER)
790 /* WinXX - is generic, the forward
791 * looking problem is this:
795 * "winxx" is generic.
798 #elif defined(__linux__)
800 #elif defined(__DARWIN__)
802 #elif defined(__CYGWIN__)
804 #elif defined(__MINGW32__)
806 #elif defined(__ECOS)
809 #warn unrecognized host OS...
812 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
813 Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
815 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
816 Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
817 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
819 /* Set Jim's STDIO */
820 interp->cookie_stdin = interp;
821 interp->cookie_stdout = interp;
822 interp->cookie_stderr = interp;
823 interp->cb_fwrite = openocd_jim_fwrite;
824 interp->cb_fread = openocd_jim_fread ;
825 interp->cb_vfprintf = openocd_jim_vfprintf;
826 interp->cb_fflush = openocd_jim_fflush;
827 interp->cb_fgets = openocd_jim_fgets;
830 Jim_EventLoopOnLoad(interp);
832 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
834 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
835 Jim_PrintErrorMessage(interp);
839 register_command(context, NULL, "sleep",
840 handle_sleep_command, COMMAND_ANY,
841 "<n> [busy] - sleep for n milliseconds. "
842 "\"busy\" means busy wait");
843 register_command(context, NULL, "fast",
844 handle_fast_command, COMMAND_ANY,
845 "fast <enable/disable> - place at beginning of "
846 "config files. Sets defaults to fast and dangerous.");
851 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
854 return ERROR_INVALID_ARGUMENTS;
856 cmd_ctx->mode = mode;
860 void process_jim_events(void)
863 static int recursion = 0;
868 Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
874 void register_jim(struct command_context *cmd_ctx, const char *name,
875 Jim_CmdProc cmd, const char *help)
877 Jim_CreateCommand(interp, name, cmd, NULL, NULL);
879 Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
880 Jim_ListAppendElement(interp, cmd_list,
881 Jim_NewStringObj(interp, name, -1));
883 command_helptext_add(cmd_list, help);
886 /* return global variable long value or 0 upon failure */
887 long jim_global_long(const char *variable)
889 Jim_Obj *objPtr = Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
891 if (Jim_GetLong(interp, objPtr, &t) == JIM_OK)
898 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
899 int parse##name(const char *str, type *ul) \
903 LOG_ERROR("Invalid command argument"); \
904 return ERROR_COMMAND_ARGUMENT_INVALID; \
907 *ul = func(str, &end, 0); \
910 LOG_ERROR("Invalid command argument"); \
911 return ERROR_COMMAND_ARGUMENT_INVALID; \
913 if ((max == *ul) && (ERANGE == errno)) \
915 LOG_ERROR("Argument overflow"); \
916 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
918 if (min && (min == *ul) && (ERANGE == errno)) \
920 LOG_ERROR("Argument underflow"); \
921 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
925 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
926 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
927 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
928 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
930 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
931 int parse##name(const char *str, type *ul) \
934 int retval = parse##funcname(str, &n); \
935 if (ERROR_OK != retval) \
938 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
940 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
945 #define DEFINE_PARSE_ULONG(name, type, min, max) \
946 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
947 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
948 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
949 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
950 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
952 #define DEFINE_PARSE_LONG(name, type, min, max) \
953 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
954 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
955 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
956 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
957 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)