X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=d34c402bafc9e6871a3b4b82125625a10dc5802b;hb=cd9e0e3115c2e6540e75eb7bf7b159c82d70fbb6;hp=81eadd3fad41191565ac2d9211c6e2bffcea4d7c;hpb=2637bbccaf12edd22bc6d82759b1e3c187d303a1;p=openocd.git diff --git a/src/helper/command.c b/src/helper/command.c index 81eadd3fad..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) * * * @@ -31,6 +37,7 @@ #include "log.h" #include "time_support.h" +#include "jim-eventloop.h" #include #include @@ -49,25 +56,28 @@ int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **arg 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 retval; int i; int nwords; char **words; target_call_timer_callbacks_now(); - LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ - + LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ + c = interp->cmdPrivData; LOG_DEBUG("script_command - %s", c->name); @@ -75,14 +85,14 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) for (i = 0; i < argc; i++) { int len; - char *w=Jim_GetString(argv[i], &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) + if (words[i] == NULL) { return JIM_ERR; } @@ -92,37 +102,51 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) /* grab the command context from the associated data */ context = Jim_GetAssocData(interp, "context"); - retval = Jim_GetAssocData(interp, "retval"); - if (context != NULL && retval != NULL) + if (context == NULL) { - /* capture log output and return it */ - Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0); - 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_SetVariableStr(interp, "ocd_output", tclOutput); + /* 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); - return (*retval==ERROR_OK)?JIM_OK:JIM_ERR; + 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; @@ -131,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) { @@ -161,14 +185,14 @@ 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 */ @@ -186,27 +210,27 @@ command_t* register_command(command_context_t *context, command_t *parent, char 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} {return [eval \"ocd_%s%s%s $args\"]}", t1, t2, t3, t1, t2, t3); - Jim_Eval(interp, override_name); + 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); @@ -216,14 +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; @@ -233,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) { @@ -266,7 +290,7 @@ int unregister_command(command_context_t *context, char *name) { context->commands = c->next; } - + /* unregister children */ if (c->children) { @@ -276,16 +300,16 @@ 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; } @@ -299,7 +323,7 @@ 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); @@ -308,7 +332,7 @@ void command_print_n(command_context_t *context, char *format, ...) { /* 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); @@ -333,7 +357,7 @@ void command_print(command_context_t *context, char *format, ...) strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */ /* 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); @@ -354,7 +378,7 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num 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) { @@ -380,10 +404,10 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num /* 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; + + return retval; } int command_run_line(command_context_t *context, char *line) @@ -393,21 +417,28 @@ int command_run_line(command_context_t *context, char *line) * results */ /* run the line thru a script engine */ - int retval; + int retval=ERROR_FAIL; int retcode; - Jim_DeleteAssocData(interp, "context"); /* remove existing */ + /* 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) - return ERROR_FAIL; - - /* associated the return value */ - retval = ERROR_OK; - Jim_DeleteAssocData(interp, "retval"); /* remove existing */ - retcode = Jim_SetAssocData(interp, "retval", NULL, &retval); - if (retcode != JIM_OK) - return ERROR_FAIL; + 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__ ); - retcode = Jim_Eval(interp, line); + Jim_DeleteAssocData(interp, "retval"); + } + Jim_DeleteAssocData(interp, "context"); + } if (retcode == JIM_ERR) { if (retval!=ERROR_COMMAND_CLOSE_CONNECTION) { @@ -417,7 +448,7 @@ int command_run_line(command_context_t *context, char *line) if (retval==ERROR_OK) { /* It wasn't a low level OpenOCD command that failed */ - return ERROR_FAIL; + return ERROR_FAIL; } return retval; } else if (retcode == JIM_EXIT) { @@ -438,7 +469,7 @@ int command_run_line(command_context_t *context, char *line) if (chunk > 256) chunk = 256; strncpy(buff, result+i, chunk); - buff[chunk] = 0; + buff[chunk] = 0; LOG_USER_N("%s", buff); } LOG_USER_N("%s", "\n"); @@ -481,7 +512,7 @@ int command_done(command_context_t *context) { free(context); context = NULL; - + return ERROR_OK; } @@ -496,7 +527,7 @@ static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv) return JIM_ERR; Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path)); free(full_path); - + Jim_SetResult(interp, result); return JIM_OK; } @@ -515,7 +546,6 @@ static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void * size_t nbytes; const char *ptr; Jim_Interp *interp; - command_context_t *context; /* make it a char easier to read code */ ptr = _ptr; @@ -525,19 +555,11 @@ static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void * return 0; } - context = Jim_GetAssocData(interp, "context"); - if (context == NULL) - { - LOG_ERROR("openocd_jim_fwrite: no command context"); - /* TODO: Where should this go? */ - return n; - } - /* do we have to chunk it? */ if (ptr[nbytes] == 0) { /* no it is a C style string */ - command_output_text(context, ptr); + LOG_USER_N("%s", ptr); return strlen(ptr); } /* GRR we must chunk - not null terminated */ @@ -554,11 +576,11 @@ static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void * /* terminate it */ chunk[n] = 0; /* output it */ - command_output_text(context, chunk); + LOG_USER_N("%s", chunk); ptr += x; nbytes -= x; } - + return n; } @@ -573,24 +595,16 @@ static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap) char *cp; int n; Jim_Interp *interp; - command_context_t *context; n = -1; interp = cookie; if (interp == NULL) return n; - context = Jim_GetAssocData(interp, "context"); - if (context == NULL) - { - LOG_ERROR("openocd_jim_vfprintf: no command context"); - return n; - } - cp = alloc_vprintf(fmt, ap); if (cp) { - command_output_text(context, cp); + LOG_USER_N("%s", cp); n = strlen(cp); free(cp); } @@ -610,6 +624,32 @@ static char* openocd_jim_fgets(char *s, int size, void *cookie) 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)); @@ -631,6 +671,7 @@ command_context_t* command_init() 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; @@ -641,10 +682,13 @@ command_context_t* command_init() interp->cb_vfprintf = openocd_jim_vfprintf; interp->cb_fflush = openocd_jim_fflush; interp->cb_fgets = openocd_jim_fgets; - + add_default_dirs(); - if (Jim_Eval(interp, startup_tcl)==JIM_ERR) +#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); @@ -652,11 +696,11 @@ command_context_t* command_init() } register_command(context, NULL, "sleep", handle_sleep_command, - COMMAND_ANY, "sleep for milliseconds"); - + 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; } @@ -675,11 +719,29 @@ int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode) 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) + { + 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) { - duration = strtoul(args[0], NULL, 0); - usleep(duration * 1000); + busy_sleep(duration); + } else + { + alive_sleep(duration); } return ERROR_OK; @@ -689,27 +751,41 @@ 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; } +void process_jim_events(void) +{ +#ifdef JIM_EMBEDDED + static int recursion = 0; + + if (!recursion) + { + recursion++; + Jim_ProcessEvents (interp, JIM_ALL_EVENTS|JIM_DONT_WAIT); + recursion--; + } +#endif +} + 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... + /* 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);