X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=cb576bb39d461961c49d05a7cd8bcc154279d94c;hb=dd85eebf2225ee77dedd679f745c7fb1975d8203;hp=9719d1860ce6b24b389eeae9f33148bcdec76829;hpb=ef1cfb23947bd32798077c6abb5c25a049460ae9;p=openocd.git diff --git a/src/helper/command.c b/src/helper/command.c index 9719d1860c..cb576bb39d 100644 --- a/src/helper/command.c +++ b/src/helper/command.c @@ -2,9 +2,12 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * - * Copyright (C) 2007,2008 Øyvind Harboe * + * 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) * * * @@ -27,22 +30,14 @@ #include "config.h" #endif -#include "replacements.h" +// @todo the inclusion of target.h here is a layering violation #include "target.h" #include "command.h" #include "configuration.h" - #include "log.h" #include "time_support.h" #include "jim-eventloop.h" -#include -#include -#include -#include -#include -#include -#include int fast_and_dangerous = 0; Jim_Interp *interp = NULL; @@ -53,7 +48,7 @@ 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)); @@ -61,7 +56,6 @@ static void tcl_output(void *privData, const char *file, int line, const char *f 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 */ @@ -72,10 +66,20 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) int nwords; char **words; - target_call_timer_callbacks_now(); - LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ - + /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might + * get overwritten by running other Jim commands! Treat it as an + * emphemeral global variable that is used in lieu of an argument + * to the fn and fish it out manually. + */ c = interp->cmdPrivData; + if (c==NULL) + { + LOG_ERROR("BUG: interp->cmdPrivData==NULL"); + return JIM_ERR; + } + target_call_timer_callbacks_now(); + LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ + LOG_DEBUG("script_command - %s", c->name); words = malloc(sizeof(char *) * argc); @@ -89,7 +93,7 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) break; } words[i] = strdup(w); - if (words[i] == NULL) + if (words[i] == NULL) { return JIM_ERR; } @@ -106,16 +110,16 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) */ 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 */ @@ -131,19 +135,22 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { *return_retval = retval; } - + return (retval==ERROR_OK)?JIM_OK:JIM_ERR; } +/* nice short description of source file */ +#define __THIS__FILE__ "command.c" + 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; @@ -152,7 +159,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) { @@ -182,14 +189,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 */ @@ -207,27 +214,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} {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__ ); + Jim_Eval_Named(interp, override_name, __THIS__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 *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); @@ -237,14 +244,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; @@ -254,27 +261,29 @@ 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) + c = context->commands; + + while(NULL != c) { if (strcmp(name, c->name) == 0) { @@ -285,28 +294,34 @@ int unregister_command(command_context_t *context, char *name) } else { + /* first element in command list */ context->commands = c->next; } - + /* unregister children */ - if (c->children) + while(NULL != c->children) { - for (c2 = c->children; c2; c2 = c2->next) - { - free(c2->name); - free(c2); - } + c2 = c->children; + c->children = c->children->next; + free(c2->name); + c2->name = NULL; + free(c2); + c2 = NULL; } - + /* delete command */ free(c->name); + c->name = NULL; free(c); + c = NULL; + return ERROR_OK; } - + /* remember the last command for unlinking */ p = c; + c = c->next; } - + return ERROR_OK; } @@ -320,7 +335,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); @@ -329,12 +344,12 @@ 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); - // We already printed it above - //command_output_text(context, string); + /* We already printed it above */ + /* command_output_text(context, string); */ free(string); } @@ -354,12 +369,12 @@ 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); - // We already printed it above - //command_output_text(context, string); + /* We already printed it above */ + /* command_output_text(context, string); */ free(string); } @@ -375,7 +390,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) { @@ -401,10 +416,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) @@ -430,10 +445,10 @@ int command_run_line(command_context_t *context, char *line) retcode = Jim_SetAssocData(interp, "retval", NULL, &retval); if (retcode == JIM_OK) { - retcode = Jim_Eval_Named(interp, line, __FILE__, __LINE__ ); - + retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__ ); + Jim_DeleteAssocData(interp, "retval"); - } + } Jim_DeleteAssocData(interp, "context"); } if (retcode == JIM_ERR) { @@ -445,7 +460,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) { @@ -456,7 +471,8 @@ int command_run_line(command_context_t *context, char *line) int reslen; result = Jim_GetString(Jim_GetResult(interp), &reslen); - if (reslen) { + if (reslen>0) + { int i; char buff[256+1]; for (i = 0; i < reslen; i += 256) @@ -466,11 +482,12 @@ 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"); } + retval=ERROR_OK; } return retval; } @@ -509,7 +526,7 @@ int command_done(command_context_t *context) { free(context); context = NULL; - + return ERROR_OK; } @@ -524,7 +541,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; } @@ -577,7 +594,7 @@ static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void * ptr += x; nbytes -= x; } - + return n; } @@ -621,10 +638,36 @@ 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, __THIS__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[]; + extern const char startup_tcl[]; + const char *HostOs; context->mode = COMMAND_EXEC; context->commands = NULL; @@ -640,8 +683,31 @@ command_context_t* command_init() Jim_RegisterCoreCommands(interp); #endif +#if defined( _MSC_VER ) + /* WinXX - is generic, the forward + * looking problem is this: + * + * "win32" or "win64" + * + * "winxx" is generic. + */ + HostOs = "winxx"; +#elif defined( __LINUX__) + HostOs = "linux"; +#elif defined( __DARWIN__ ) + HostOs = "darwin"; +#elif defined( __CYGWIN__ ) + HostOs = "cygwin"; +#elif defined( __MINGW32__ ) + HostOs = "mingw32"; +#else + HostOs = "other"; +#endif + Jim_SetGlobalVariableStr( interp, "ocd_HOSTOS", Jim_NewStringObj( interp, HostOs , strlen(HostOs)) ); + 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; @@ -652,7 +718,7 @@ 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(); #ifdef JIM_EMBEDDED @@ -666,11 +732,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; } @@ -689,11 +755,34 @@ 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) + { + busy_sleep(duration); + } else { - duration = strtoul(args[0], NULL, 0); - alive_sleep(duration); + long long then=timeval_ms(); + while ((timeval_ms()-then)<(long long)duration) + { + target_call_timer_callbacks_now(); + usleep(1000); + } } return ERROR_OK; @@ -703,18 +792,18 @@ 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) +void process_jim_events(void) { #ifdef JIM_EMBEDDED static int recursion = 0; - if (!recursion) + if (!recursion) { recursion++; Jim_ProcessEvents (interp, JIM_ALL_EVENTS|JIM_DONT_WAIT); @@ -727,18 +816,30 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd { Jim_CreateCommand(interp, name, cmd, NULL, NULL); - /* FIX!!! it would be prettier to invoke add_help_text... - accumulate help text in Tcl helptext list. */ + /* 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); } + +/* return global variable long value or 0 upon failure */ +long jim_global_long(const char *variable) +{ + Jim_Obj *objPtr=Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG); + long t; + if (Jim_GetLong(interp, objPtr, &t)==JIM_OK) + { + return t; + } + return 0; +}