X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=86158d72b23f3f7f992aac04952f8dc7e6b9c192;hp=9ca64dd2df37bb50ca3934b4bea5b5453baf9940;hb=2d3cc1eac126990c5cd4ca8a47b0c09814dc1e5c;hpb=ded28546f84eb39a8a89994ddc7b026a460d6381 diff --git a/src/helper/command.c b/src/helper/command.c index 9ca64dd2df..86158d72b2 100644 --- a/src/helper/command.c +++ b/src/helper/command.c @@ -2,7 +2,7 @@ * 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 * @@ -30,40 +30,52 @@ #include "config.h" #endif -#include "replacements.h" +#if !BUILD_ECOSBOARD +/* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/ +#define JIM_EMBEDDED +#endif + +// @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; -int handle_sleep_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); - -int run_command(command_context_t *context, command_t *c, char *words[], int num_words); +static int run_command(command_context_t *context, + command_t *c, char *words[], unsigned num_words); -static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string) +static void tcl_output(void *privData, const char *file, unsigned line, + const char *function, const char *string) { - Jim_Obj *tclOutput=(Jim_Obj *)privData; - + Jim_Obj *tclOutput = (Jim_Obj *)privData; Jim_AppendString(interp, tclOutput, string, strlen(string)); } extern command_context_t *global_cmd_ctx; +void script_debug(Jim_Interp *interp, const char *name, + unsigned argc, Jim_Obj *const *argv) +{ + LOG_DEBUG("command - %s", name); + for (unsigned i = 0; i < argc; i++) + { + int len; + const char *w = Jim_GetString(argv[i], &len); + + /* end of line comment? */ + if (*w == '#') + break; + + LOG_DEBUG("%s - argv[%d]=%s", name, i, w); + } +} + static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { /* the private data is stashed in the interp structure */ @@ -80,21 +92,21 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) * to the fn and fish it out manually. */ c = interp->cmdPrivData; - if (c==NULL) + if (c == NULL) { - LOG_ERROR("BUG: interp->cmdPrivData==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); + script_debug(interp, c->name, argc, argv); words = malloc(sizeof(char *) * argc); for (i = 0; i < argc; i++) { int len; - const char *w=Jim_GetString(argv[i], &len); + const char *w = Jim_GetString(argv[i], &len); if (*w=='#') { /* hit an end of line comment */ @@ -103,9 +115,12 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) words[i] = strdup(w); if (words[i] == NULL) { + int j; + for (j = 0; j < i; j++) + free(words[j]); + free(words); return JIM_ERR; } - LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]); } nwords = i; @@ -144,9 +159,12 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) *return_retval = retval; } - return (retval==ERROR_OK)?JIM_OK:JIM_ERR; + 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; @@ -196,45 +214,35 @@ command_t* register_command(command_context_t *context, command_t *parent, char } /* just a placeholder, no handler */ - if (c->handler==NULL) + 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); + const char *full_name = command_name(c, '_'); + + const char *ocd_name = alloc_printf("ocd_%s", full_name); + Jim_CreateCommand(interp, ocd_name, script_command, c, NULL); + free((void *)ocd_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__ ); + const char *override_name = alloc_printf("proc %s {args} {" + "if {[catch {eval ocd_%s $args}] == 0} " + "{return \"\"} else {return -code error}}", + full_name, full_name); + Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__); free((void *)override_name); + free((void *)full_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 *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_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0); /* maximum of two levels :-) */ - if (c->parent!=NULL) + if (c->parent != NULL) { Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1)); } @@ -253,11 +261,11 @@ int unregister_all_commands(command_context_t *context) if (context == NULL) return ERROR_OK; - while(NULL != context->commands) + while (NULL != context->commands) { c = context->commands; - while(NULL != c->children) + while (NULL != c->children) { c2 = c->children; c->children = c->children->next; @@ -286,7 +294,9 @@ int unregister_command(command_context_t *context, char *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) { @@ -297,26 +307,32 @@ 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; @@ -324,12 +340,12 @@ int unregister_command(command_context_t *context, char *name) void command_output_text(command_context_t *context, const char *data) { - if( context && context->output_handler && data ){ - context->output_handler( context, data ); + if (context && context->output_handler && data) { + context->output_handler(context, data); } } -void command_print_n(command_context_t *context, char *format, ...) +void command_print_sameline(command_context_t *context, const char *format, ...) { char *string; @@ -345,15 +361,15 @@ void command_print_n(command_context_t *context, char *format, ...) * 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); } va_end(ap); } -void command_print(command_context_t *context, char *format, ...) +void command_print(command_context_t *context, const char *format, ...) { char *string; @@ -370,21 +386,44 @@ void command_print(command_context_t *context, char *format, ...) * 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); } va_end(ap); } -int run_command(command_context_t *context, command_t *c, char *words[], int num_words) +static char *__command_name(struct command_s *c, char delim, unsigned extra) { - int start_word=0; - if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )) + char *name; + unsigned len = strlen(c->name); + if (NULL == c->parent) { + // allocate enough for the name, child names, and '\0' + name = malloc(len + extra + 1); + strcpy(name, c->name); + } else { + // parent's extra must include both the space and name + name = __command_name(c->parent, delim, 1 + len + extra); + char dstr[2] = { delim, 0 }; + strcat(name, dstr); + strcat(name, c->name); + } + return name; +} +char *command_name(struct command_s *c, char delim) +{ + return __command_name(c, delim, 0); +} + +static int run_command(command_context_t *context, + command_t *c, char *words[], unsigned num_words) +{ + int start_word = 0; + if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode))) { /* Config commands can not run after the config stage */ - LOG_ERROR("Illegal mode for command"); + LOG_ERROR("Command '%s' only runs during configuration stage", c->name); return ERROR_FAIL; } @@ -392,17 +431,12 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num if (retval == ERROR_COMMAND_SYNTAX_ERROR) { /* 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; - command_run_linef(context, "help {%s%s%s}", t1, t2, t3); + char *full_name = command_name(c, ' '); + if (NULL != full_name) { + command_run_linef(context, "help %s", full_name); + free(full_name); + } else + retval = -ENOMEM; } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) { @@ -426,7 +460,7 @@ int command_run_line(command_context_t *context, char *line) * results */ /* run the line thru a script engine */ - int retval=ERROR_FAIL; + 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 @@ -442,19 +476,19 @@ 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) { - if (retval!=ERROR_COMMAND_CLOSE_CONNECTION) + if (retval != ERROR_COMMAND_CLOSE_CONNECTION) { /* We do not print the connection closed error message */ Jim_PrintErrorMessage(interp); } - if (retval==ERROR_OK) + if (retval == ERROR_OK) { /* It wasn't a low level OpenOCD command that failed */ return ERROR_FAIL; @@ -468,35 +502,37 @@ 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]; + 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); + strncpy(buff, result + i, chunk); buff[chunk] = 0; LOG_USER_N("%s", buff); } LOG_USER_N("%s", "\n"); } + retval = ERROR_OK; } return retval; } -int command_run_linef(command_context_t *context, char *format, ...) +int command_run_linef(command_context_t *context, const char *format, ...) { - int retval=ERROR_FAIL; + int retval = ERROR_FAIL; char *string; va_list ap; va_start(ap, format); string = alloc_vprintf(format, ap); - if (string!=NULL) + if (string != NULL) { - retval=command_run_line(context, string); + retval = command_run_line(context, string); } va_end(ap); return retval; @@ -573,7 +609,7 @@ static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void * } /* GRR we must chunk - not null terminated */ while (nbytes) { - char chunk[128+1]; + char chunk[128 + 1]; int x; x = nbytes; @@ -633,7 +669,6 @@ 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) @@ -648,7 +683,7 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv) log_add_callback(tcl_output, tclOutput); - retcode = Jim_Eval_Named(interp, str, __FILE__, __LINE__ ); + retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__); log_remove_callback(tcl_output, tclOutput); @@ -659,10 +694,59 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv) return retcode; } +/* sleep command sleeps for miliseconds + * this is useful in target startup scripts + */ +static int handle_sleep_command(struct command_context_s *cmd_ctx, + char *cmd, char **args, int argc) +{ + bool busy = false; + if (argc == 2) + { + if (strcmp(args[1], "busy") == 0) + busy = true; + else + return ERROR_COMMAND_SYNTAX_ERROR; + } + else if (argc < 1 || argc > 2) + return ERROR_COMMAND_SYNTAX_ERROR; + + unsigned long duration = 0; + int retval = parse_ulong(args[0], &duration); + if (ERROR_OK != retval) + return retval; + + if (!busy) + { + long long then = timeval_ms(); + while (timeval_ms() - then < (long long)duration) + { + target_call_timer_callbacks_now(); + usleep(1000); + } + } + else + busy_sleep(duration); + + return ERROR_OK; +} + +static int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +{ + if (argc != 1) + return ERROR_COMMAND_SYNTAX_ERROR; + + fast_and_dangerous = strcmp("enable", args[0]) == 0; + + return ERROR_OK; +} + + command_context_t* command_init() { command_context_t* context = malloc(sizeof(command_context_t)); extern const char startup_tcl[]; + const char *HostOs; context->mode = COMMAND_EXEC; context->commands = NULL; @@ -670,7 +754,7 @@ command_context_t* command_init() context->output_handler = NULL; context->output_handler_priv = NULL; -#ifdef JIM_EMBEDDED +#if !BUILD_ECOSBOARD Jim_InitEmbedded(); /* Create an interpreter */ interp = Jim_CreateInterp(); @@ -678,6 +762,32 @@ 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"; +#elif defined(__ECOS) + HostOs = "ecos"; +#else +#warn unrecognized host OS... + 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); @@ -692,23 +802,24 @@ command_context_t* command_init() interp->cb_fflush = openocd_jim_fflush; interp->cb_fgets = openocd_jim_fgets; - add_default_dirs(); - -#ifdef JIM_EMBEDDED +#if !BUILD_ECOSBOARD Jim_EventLoopOnLoad(interp); #endif - if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1)==JIM_ERR) + 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)"); + LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)"); Jim_PrintErrorMessage(interp); exit(-1); } - register_command(context, NULL, "sleep", handle_sleep_command, - 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."); + register_command(context, NULL, "sleep", + handle_sleep_command, 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; } @@ -722,64 +833,15 @@ int command_context_mode(command_context_t *cmd_ctx, enum command_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; - 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 - { - long long then=timeval_ms(); - while ((timeval_ms()-then) max) \ + return ERROR_COMMAND_ARGUMENT_OVERFLOW; \ + if (min) \ + return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \ + *ul = n; \ + return ERROR_OK; \ + } + +#define DEFINE_PARSE_ULONG(name, type, min, max) \ + DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong) +DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX) +DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX) +DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX) +DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX) + +#define DEFINE_PARSE_LONG(name, type, min, max) \ + DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long) +DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX) +DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX) +DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX) +DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)