X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=d34c402bafc9e6871a3b4b82125625a10dc5802b;hb=cd9e0e3115c2e6540e75eb7bf7b159c82d70fbb6;hp=f86777cd6ff55592d59e2663f50cb9c683a45d8a;hpb=d0eef63f68cb3183342f092a19d703fe236511da;p=openocd.git diff --git a/src/helper/command.c b/src/helper/command.c index f86777cd6f..d34c402baf 100644 --- a/src/helper/command.c +++ b/src/helper/command.c @@ -2,6 +2,12 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * + * Copyright (C) 2007,2008 Øyvind Harboe * + * oyvind.harboe@zylin.com * + * * + * Copyright (C) 2008, Duane Ellis * + * openocd@duaneeellis.com * + * * * part of this file is taken from libcli (libcli.sourceforge.net) * * Copyright (C) David Parrish (david@dparrish.com) * * * @@ -25,11 +31,13 @@ #endif #include "replacements.h" - +#include "target.h" #include "command.h" +#include "configuration.h" #include "log.h" #include "time_support.h" +#include "jim-eventloop.h" #include #include @@ -37,29 +45,108 @@ #include #include #include - -#include +#include int fast_and_dangerous = 0; +Jim_Interp *interp = NULL; int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -/* forward declaration of jim_command */ -extern int jim_command(command_context_t *context, char *line); +int run_command(command_context_t *context, command_t *c, char *words[], int num_words); + +static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string) +{ + Jim_Obj *tclOutput=(Jim_Obj *)privData; + + Jim_AppendString(interp, tclOutput, string, strlen(string)); +} + +extern command_context_t *global_cmd_ctx; + + +static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) +{ + /* the private data is stashed in the interp structure */ + command_t *c; + command_context_t *context; + int retval; + int i; + int nwords; + char **words; + + target_call_timer_callbacks_now(); + LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ + + c = interp->cmdPrivData; + LOG_DEBUG("script_command - %s", c->name); + + words = malloc(sizeof(char *) * argc); + for (i = 0; i < argc; i++) + { + int len; + const char *w=Jim_GetString(argv[i], &len); + if (*w=='#') + { + /* hit an end of line comment */ + break; + } + words[i] = strdup(w); + if (words[i] == NULL) + { + return JIM_ERR; + } + LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]); + } + nwords = i; + + /* grab the command context from the associated data */ + context = Jim_GetAssocData(interp, "context"); + if (context == NULL) + { + /* Tcl can invoke commands directly instead of via command_run_line(). This would + * happen when the Jim Tcl interpreter is provided by eCos. + */ + context = global_cmd_ctx; + } + + /* capture log output and return it */ + Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0); + /* a garbage collect can happen, so we need a reference count to this object */ + Jim_IncrRefCount(tclOutput); + + log_add_callback(tcl_output, tclOutput); + + retval = run_command(context, c, words, nwords); + + log_remove_callback(tcl_output, tclOutput); + /* We dump output into this local variable */ + Jim_SetResult(interp, tclOutput); + Jim_DecrRefCount(interp, tclOutput); + for (i = 0; i < nwords; i++) + free(words[i]); + free(words); + + int *return_retval = Jim_GetAssocData(interp, "retval"); + if (return_retval != NULL) + { + *return_retval = retval; + } + + return (retval==ERROR_OK)?JIM_OK:JIM_ERR; +} command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help) { command_t *c, *p; - + if (!context || !name) return NULL; - + c = malloc(sizeof(command_t)); - + c->name = strdup(name); c->parent = parent; c->children = NULL; @@ -68,7 +155,7 @@ command_t* register_command(command_context_t *context, command_t *parent, char if (!help) help=""; c->next = NULL; - + /* place command in tree */ if (parent) { @@ -98,21 +185,52 @@ command_t* register_command(command_context_t *context, command_t *parent, char context->commands = c; } } + + /* just a placeholder, no handler */ + if (c->handler==NULL) + return c; + + /* If this is a two level command, e.g. "flash banks", then the + * "unknown" proc in startup.tcl must redirect to this command. + * + * "flash banks" is translated by "unknown" to "flash_banks" + * if such a proc exists + */ + /* Print help for command */ + const char *t1=""; + const char *t2=""; + const char *t3=""; + /* maximum of two levels :-) */ + if (c->parent!=NULL) + { + t1=c->parent->name; + t2="_"; + } + t3=c->name; + const char *full_name=alloc_printf("ocd_%s%s%s", t1, t2, t3); + Jim_CreateCommand(interp, full_name, script_command, c, NULL); + free((void *)full_name); + + /* we now need to add an overrideable proc */ + const char *override_name=alloc_printf("proc %s%s%s {args} {if {[catch {eval \"ocd_%s%s%s $args\"}]==0} {return \"\"} else { return -code error }", t1, t2, t3, t1, t2, t3); + Jim_Eval_Named(interp, override_name, __FILE__, __LINE__ ); + free((void *)override_name); + /* accumulate help text in Tcl helptext list. */ Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG); if (Jim_IsShared(helptext)) helptext = Jim_DuplicateObj(interp, helptext); Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0); - + Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0); /* maximum of two levels :-) */ if (c->parent!=NULL) { Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1)); - } + } Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->name, -1)); - + Jim_ListAppendElement(interp, cmd_entry, cmd_list); Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1)); Jim_ListAppendElement(interp, helptext, cmd_entry); @@ -122,15 +240,14 @@ command_t* register_command(command_context_t *context, command_t *parent, char int unregister_all_commands(command_context_t *context) { command_t *c, *c2; - + if (context == NULL) return ERROR_OK; - - + while(NULL != context->commands) { c = context->commands; - + while(NULL != c->children) { c2 = c->children; @@ -140,25 +257,25 @@ int unregister_all_commands(command_context_t *context) free(c2); c2 = NULL; } - + context->commands = context->commands->next; - + free(c->name); c->name = NULL; free(c); - c = NULL; + c = NULL; } - + return ERROR_OK; } int unregister_command(command_context_t *context, char *name) { command_t *c, *p = NULL, *c2; - + if ((!context) || (!name)) return ERROR_INVALID_ARGUMENTS; - + /* find command */ for (c = context->commands; c; c = c->next) { @@ -173,7 +290,7 @@ int unregister_command(command_context_t *context, char *name) { context->commands = c->next; } - + /* unregister children */ if (c->children) { @@ -183,87 +300,17 @@ int unregister_command(command_context_t *context, char *name) free(c2); } } - + /* delete command */ free(c->name); free(c); } - + /* remember the last command for unlinking */ p = c; } - - return ERROR_OK; -} - -int parse_line(char *line, char *words[], int max_words) -{ - int nwords = 0; - char *p = line; - char *word_start = line; - int inquote = 0; - while (nwords < max_words - 1) - { - /* check if we reached - * a terminating NUL - * a matching closing quote character " or ' - * we're inside a word but not a quote, and the current character is whitespace - */ - if (!*p || *p == inquote || (word_start && !inquote && isspace(*p))) - { - /* we're inside a word or quote, and reached its end*/ - if (word_start) - { - int len; - char *word_end=p; - - /* This will handle extra whitespace within quotes */ - while (isspace(*word_start)&&(word_start0) - { - /* copy the word */ - memcpy(words[nwords] = malloc(len + 1), word_start, len); - /* add terminating NUL */ - words[nwords++][len] = 0; - } - } - /* we're done parsing the line */ - if (!*p) - break; - - /* skip over trailing quote or whitespace*/ - if (inquote || isspace(*p)) - p++; - while (isspace(*p)) - p++; - - inquote = 0; - word_start = 0; - } - else if (*p == '"' || *p == '\'') - { - /* we've reached the beginning of a quote */ - inquote = *p++; - word_start = p; - } - else - { - /* we've reached the beginning of a new word */ - if (!word_start) - word_start = p; - - /* normal character, skip */ - p++; - } - } - - return nwords; + return ERROR_OK; } void command_output_text(command_context_t *context, const char *data) @@ -276,14 +323,21 @@ void command_output_text(command_context_t *context, const char *data) void command_print_n(command_context_t *context, char *format, ...) { char *string; - + va_list ap; va_start(ap, format); string = alloc_vprintf(format, ap); if (string != NULL) { - context->output_handler(context, string); + /* we want this collected in the log + we also want to pick it up as a tcl return + * value. + * + * The latter bit isn't precisely neat, but will do for now. + */ + LOG_USER_N("%s", string); + // We already printed it above + //command_output_text(context, string); free(string); } @@ -301,60 +355,30 @@ void command_print(command_context_t *context, char *format, ...) if (string != NULL) { strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */ - context->output_handler(context, string); + /* we want this collected in the log + we also want to pick it up as a tcl return + * value. + * + * The latter bit isn't precisely neat, but will do for now. + */ + LOG_USER_N("%s", string); + // We already printed it above + //command_output_text(context, string); free(string); } va_end(ap); } -command_t *find_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word, int *new_start_word) -{ - command_t *c; - - for (c = commands; c; c = c->next) - { - if (strcasecmp(c->name, words[start_word])) - continue; - - if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ) - { - if (!c->children) - { - if (!c->handler) - { - return NULL; - } - else - { - *new_start_word=start_word; - return c; - } - } - else - { - if (start_word == num_words - 1) - { - return NULL; - } - return find_command(context, c->children, words, num_words, start_word + 1, new_start_word); - } - } - } - return NULL; -} - -int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words) +int run_command(command_context_t *context, command_t *c, char *words[], int num_words) { int start_word=0; - command_t *c; - c = find_command(context, commands, words, num_words, start_word, &start_word); - if (c == NULL) + if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )) { - /* just return command not found */ - return ERROR_COMMAND_NOTFOUND; + /* Config commands can not run after the config stage */ + LOG_ERROR("Illegal mode for command"); + return ERROR_FAIL; } - + int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1); if (retval == ERROR_COMMAND_SYNTAX_ERROR) { @@ -370,8 +394,6 @@ int find_and_run_command(command_context_t *context, command_t *commands, char * } t3=c->name; command_run_linef(context, "help {%s%s%s}", t1, t2, t3); - - } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) { @@ -382,61 +404,79 @@ int find_and_run_command(command_context_t *context, command_t *commands, char * /* we do not print out an error message because the command *should* * have printed out an error */ - LOG_DEBUG("Command failed with error code %d", retval); + LOG_DEBUG("Command failed with error code %d", retval); } - - return retval; -} - -int command_run_line_internal(command_context_t *context, char *line) -{ - LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ - - int nwords; - char *words[128] = {0}; - int retval; - int i; - - /* skip preceding whitespace */ - while (isspace(*line)) - line++; - - /* empty line, ignore */ - if (!*line) - return ERROR_OK; - - /* ignore comments */ - if (*line && (line[0] == '#')) - return ERROR_OK; - - LOG_DEBUG("%s", line); - nwords = parse_line(line, words, sizeof(words) / sizeof(words[0])); - - if (nwords > 0) - { - retval = find_and_run_command(context, context->commands, words, nwords); - } - else - return ERROR_INVALID_ARGUMENTS; - - for (i = 0; i < nwords; i++) - free(words[i]); - return retval; } int command_run_line(command_context_t *context, char *line) { - /* if a command is unknown to the "unknown" proc in tcl/commands.tcl will - * redirect it to OpenOCD. - * - * This avoids having to type the "openocd" prefix and makes OpenOCD - * commands "native" to Tcl. + /* all the parent commands have been registered with the interpreter + * so, can just evaluate the line as a script and check for + * results */ - return jim_command(context, line); -} + /* run the line thru a script engine */ + int retval=ERROR_FAIL; + int retcode; + /* Beware! This code needs to be reentrant. It is also possible + * for OpenOCD commands to be invoked directly from Tcl. This would + * happen when the Jim Tcl interpreter is provided by eCos for + * instance. + */ + Jim_DeleteAssocData(interp, "context"); + retcode = Jim_SetAssocData(interp, "context", NULL, context); + if (retcode == JIM_OK) + { + /* associated the return value */ + Jim_DeleteAssocData(interp, "retval"); + retcode = Jim_SetAssocData(interp, "retval", NULL, &retval); + if (retcode == JIM_OK) + { + retcode = Jim_Eval_Named(interp, line, __FILE__, __LINE__ ); + Jim_DeleteAssocData(interp, "retval"); + } + Jim_DeleteAssocData(interp, "context"); + } + if (retcode == JIM_ERR) { + if (retval!=ERROR_COMMAND_CLOSE_CONNECTION) + { + /* We do not print the connection closed error message */ + Jim_PrintErrorMessage(interp); + } + if (retval==ERROR_OK) + { + /* It wasn't a low level OpenOCD command that failed */ + return ERROR_FAIL; + } + return retval; + } else if (retcode == JIM_EXIT) { + /* ignore. */ + /* exit(Jim_GetExitCode(interp)); */ + } else { + const char *result; + int reslen; + + result = Jim_GetString(Jim_GetResult(interp), &reslen); + if (reslen) { + int i; + char buff[256+1]; + for (i = 0; i < reslen; i += 256) + { + int chunk; + chunk = reslen - i; + if (chunk > 256) + chunk = 256; + strncpy(buff, result+i, chunk); + buff[chunk] = 0; + LOG_USER_N("%s", buff); + } + LOG_USER_N("%s", "\n"); + } + } + return retval; +} int command_run_linef(command_context_t *context, char *format, ...) { @@ -453,8 +493,6 @@ int command_run_linef(command_context_t *context, char *format, ...) return retval; } - - void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv) { context->output_handler = output_handler; @@ -466,7 +504,7 @@ command_context_t* copy_command_context(command_context_t* context) command_context_t* copy_context = malloc(sizeof(command_context_t)); *copy_context = *context; - + return copy_context; } @@ -474,43 +512,236 @@ int command_done(command_context_t *context) { free(context); context = NULL; - + return ERROR_OK; } +/* find full path to file */ +static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv) +{ + if (argc != 2) + return JIM_ERR; + const char *file = Jim_GetString(argv[1], NULL); + char *full_path = find_file(file); + if (full_path == NULL) + return JIM_ERR; + Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path)); + free(full_path); + + Jim_SetResult(interp, result); + return JIM_OK; +} + +static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv) +{ + if (argc != 2) + return JIM_ERR; + const char *str = Jim_GetString(argv[1], NULL); + LOG_USER("%s", str); + return JIM_OK; +} + +static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie) +{ + size_t nbytes; + const char *ptr; + Jim_Interp *interp; + + /* make it a char easier to read code */ + ptr = _ptr; + interp = cookie; + nbytes = size * n; + if (ptr == NULL || interp == NULL || nbytes == 0) { + return 0; + } + + /* do we have to chunk it? */ + if (ptr[nbytes] == 0) + { + /* no it is a C style string */ + LOG_USER_N("%s", ptr); + return strlen(ptr); + } + /* GRR we must chunk - not null terminated */ + while (nbytes) { + char chunk[128+1]; + int x; + + x = nbytes; + if (x > 128) { + x = 128; + } + /* copy it */ + memcpy(chunk, ptr, x); + /* terminate it */ + chunk[n] = 0; + /* output it */ + LOG_USER_N("%s", chunk); + ptr += x; + nbytes -= x; + } + + return n; +} + +static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie) +{ + /* TCL wants to read... tell him no */ + return 0; +} + +static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap) +{ + char *cp; + int n; + Jim_Interp *interp; + + n = -1; + interp = cookie; + if (interp == NULL) + return n; + + cp = alloc_vprintf(fmt, ap); + if (cp) + { + LOG_USER_N("%s", cp); + n = strlen(cp); + free(cp); + } + return n; +} + +static int openocd_jim_fflush(void *cookie) +{ + /* nothing to flush */ + return 0; +} + +static char* openocd_jim_fgets(char *s, int size, void *cookie) +{ + /* not supported */ + errno = ENOTSUP; + return NULL; +} + + +static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv) +{ + if (argc != 2) + return JIM_ERR; + int retcode; + const char *str = Jim_GetString(argv[1], NULL); + + /* capture log output and return it */ + Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0); + /* a garbage collect can happen, so we need a reference count to this object */ + Jim_IncrRefCount(tclOutput); + + log_add_callback(tcl_output, tclOutput); + + retcode = Jim_Eval_Named(interp, str, __FILE__, __LINE__ ); + + log_remove_callback(tcl_output, tclOutput); + + /* We dump output into this local variable */ + Jim_SetResult(interp, tclOutput); + Jim_DecrRefCount(interp, tclOutput); + + return retcode; +} + command_context_t* command_init() { command_context_t* context = malloc(sizeof(command_context_t)); - + extern unsigned const char startup_tcl[]; + context->mode = COMMAND_EXEC; context->commands = NULL; context->current_target = 0; context->output_handler = NULL; context->output_handler_priv = NULL; - + +#ifdef JIM_EMBEDDED + Jim_InitEmbedded(); + /* Create an interpreter */ + interp = Jim_CreateInterp(); + /* Add all the Jim core commands */ + Jim_RegisterCoreCommands(interp); +#endif + + Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL); + Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL); + Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL); + + /* Set Jim's STDIO */ + interp->cookie_stdin = interp; + interp->cookie_stdout = interp; + interp->cookie_stderr = interp; + interp->cb_fwrite = openocd_jim_fwrite; + interp->cb_fread = openocd_jim_fread ; + interp->cb_vfprintf = openocd_jim_vfprintf; + interp->cb_fflush = openocd_jim_fflush; + interp->cb_fgets = openocd_jim_fgets; + + add_default_dirs(); + +#ifdef JIM_EMBEDDED + Jim_EventLoopOnLoad(interp); +#endif + if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1)==JIM_ERR) + { + LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)"); + Jim_PrintErrorMessage(interp); + exit(-1); + } + register_command(context, NULL, "sleep", handle_sleep_command, - COMMAND_ANY, "sleep for milliseconds"); - - register_command(context, NULL, "time", handle_time_command, - COMMAND_ANY, "time - execute and print time it took"); - + COMMAND_ANY, " [busy] - sleep for n milliseconds. \"busy\" means busy wait"); + register_command(context, NULL, "fast", handle_fast_command, COMMAND_ANY, "fast - place at beginning of config files. Sets defaults to fast and dangerous."); - + return context; } +int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode) +{ + if (!cmd_ctx) + return ERROR_INVALID_ARGUMENTS; + + cmd_ctx->mode = mode; + return ERROR_OK; +} + /* sleep command sleeps for miliseconds * this is useful in target startup scripts */ int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) { unsigned long duration = 0; - - if (argc == 1) + int busy = 0; + + if (argc==1) + { + + } else if (argc==2) { - duration = strtoul(args[0], NULL, 0); - usleep(duration * 1000); + if (strcmp(args[1], "busy")!=0) + return ERROR_COMMAND_SYNTAX_ERROR; + busy = 1; + } else + { + return ERROR_COMMAND_SYNTAX_ERROR; + } + + duration = strtoul(args[0], NULL, 0); + + if (busy) + { + busy_sleep(duration); + } else + { + alive_sleep(duration); } return ERROR_OK; @@ -520,38 +751,42 @@ int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **arg { if (argc!=1) return ERROR_COMMAND_SYNTAX_ERROR; - + fast_and_dangerous = strcmp("enable", args[0])==0; - + return ERROR_OK; } - -int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +void process_jim_events(void) { - duration_t duration; - char *duration_text; - int retval; - float t; - - if (argc<1) - return ERROR_COMMAND_SYNTAX_ERROR; - - duration_start_measure(&duration); - - retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc); - if (retval == ERROR_COMMAND_NOTFOUND) +#ifdef JIM_EMBEDDED + static int recursion = 0; + + if (!recursion) { - command_print(cmd_ctx, "Command %s not found", args[0]); + recursion++; + Jim_ProcessEvents (interp, JIM_ALL_EVENTS|JIM_DONT_WAIT); + recursion--; } - - duration_stop_measure(&duration, &duration_text); - - t=duration.duration.tv_sec; - t+=((float)duration.duration.tv_usec / 1000000.0); - command_print(cmd_ctx, "%s took %fs", args[0], t); - - free(duration_text); +#endif +} - return retval; +void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help) +{ + Jim_CreateCommand(interp, name, cmd, NULL, NULL); + + /* FIX!!! it would be prettier to invoke add_help_text... + accumulate help text in Tcl helptext list. */ + Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG); + if (Jim_IsShared(helptext)) + helptext = Jim_DuplicateObj(interp, helptext); + + Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0); + + Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0); + Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1)); + + Jim_ListAppendElement(interp, cmd_entry, cmd_list); + Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1)); + Jim_ListAppendElement(interp, helptext, cmd_entry); }