X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=d29b6ec327a00a30f7d47baf898ba9f5503924f3;hp=bd6b693e8aad350d20094dfaee4666e7ab919167;hb=841721929a63bb77379b1598d91ed85b85021734;hpb=5c123481a12b229df1f20515515024aa26457726 diff --git a/src/helper/command.c b/src/helper/command.c index bd6b693e8a..d29b6ec327 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 * @@ -47,20 +47,34 @@ 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 void tcl_output(void *privData, const char *file, int 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, int argc, Jim_Obj *const *argv) +{ + int i; + + LOG_DEBUG("command - %s", name); + for (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 */ @@ -77,21 +91,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 */ @@ -100,9 +114,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; @@ -141,7 +158,7 @@ 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 */ @@ -196,7 +213,7 @@ 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 @@ -210,31 +227,31 @@ command_t* register_command(command_context_t *context, command_t *parent, char const char *t2=""; const char *t3=""; /* maximum of two levels :-) */ - if (c->parent!=NULL) + if (c->parent != NULL) { - t1=c->parent->name; + t1 = c->parent->name; t2="_"; } - t3=c->name; - const char *full_name=alloc_printf("ocd_%s%s%s", t1, t2, t3); + 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, __THIS__FILE__, __LINE__ ); + 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, __THIS__FILE__, __LINE__); free((void *)override_name); /* accumulate help text in Tcl helptext list. */ - Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG); + 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_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 +270,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; @@ -288,7 +305,7 @@ int unregister_command(command_context_t *context, char *name) /* find command */ c = context->commands; - while(NULL != c) + while (NULL != c) { if (strcmp(name, c->name) == 0) { @@ -304,7 +321,7 @@ int unregister_command(command_context_t *context, char *name) } /* unregister children */ - while(NULL != c->children) + while (NULL != c->children) { c2 = c->children; c->children = c->children->next; @@ -332,8 +349,8 @@ 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); } } @@ -388,8 +405,8 @@ void command_print(command_context_t *context, const char *format, ...) int run_command(command_context_t *context, command_t *c, char *words[], int num_words) { - int start_word=0; - if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )) + 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("Command '%s' only runs during configuration stage", c->name); @@ -404,12 +421,12 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num const char *t2=""; const char *t3=""; /* maximum of two levels :-) */ - if (c->parent!=NULL) + if (c->parent != NULL) { - t1=c->parent->name; + t1 = c->parent->name; t2=" "; } - t3=c->name; + t3 = c->name; command_run_linef(context, "help {%s%s%s}", t1, t2, t3); } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) @@ -434,7 +451,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 @@ -450,19 +467,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, __THIS__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; @@ -476,37 +493,37 @@ int command_run_line(command_context_t *context, char *line) int reslen; result = Jim_GetString(Jim_GetResult(interp), &reslen); - if (reslen>0) + 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; + retval = ERROR_OK; } return retval; } 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; @@ -583,7 +600,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; @@ -657,7 +674,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, __THIS__FILE__, __LINE__ ); + retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__); log_remove_callback(tcl_output, tclOutput); @@ -668,6 +685,54 @@ 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)); @@ -688,7 +753,7 @@ command_context_t* command_init() Jim_RegisterCoreCommands(interp); #endif -#if defined( _MSC_VER ) +#if defined(_MSC_VER) /* WinXX - is generic, the forward * looking problem is this: * @@ -697,18 +762,20 @@ command_context_t* command_init() * "winxx" is generic. */ HostOs = "winxx"; -#elif defined( __LINUX__) +#elif defined(__linux__) HostOs = "linux"; -#elif defined( __DARWIN__ ) +#elif defined(__DARWIN__) HostOs = "darwin"; -#elif defined( __CYGWIN__ ) +#elif defined(__CYGWIN__) HostOs = "cygwin"; -#elif defined( __MINGW32__ ) +#elif defined(__MINGW32__) HostOs = "mingw32"; #else +#warn unrecognized host OS... HostOs = "other"; #endif - Jim_SetGlobalVariableStr( interp, "ocd_HOSTOS", Jim_NewStringObj( interp, HostOs , strlen(HostOs)) ); + 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); @@ -724,23 +791,24 @@ command_context_t* command_init() interp->cb_fflush = openocd_jim_fflush; interp->cb_fgets = openocd_jim_fgets; - add_default_dirs(); - #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; } @@ -754,55 +822,6 @@ 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)<(long long)duration) - { - target_call_timer_callbacks_now(); - usleep(1000); - } - } - - return ERROR_OK; -} - -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; -} - void process_jim_events(void) { #if !BUILD_ECOSBOARD @@ -811,7 +830,7 @@ void process_jim_events(void) if (!recursion) { recursion++; - Jim_ProcessEvents (interp, JIM_ALL_EVENTS|JIM_DONT_WAIT); + Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT); recursion--; } #endif @@ -823,13 +842,13 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd /* 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); + 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_entry = Jim_NewListObj(interp, NULL, 0); - Jim_Obj *cmd_list=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); @@ -840,26 +859,72 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd /* 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); + Jim_Obj *objPtr = Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG); long t; - if (Jim_GetLong(interp, objPtr, &t)==JIM_OK) + if (Jim_GetLong(interp, objPtr, &t) == JIM_OK) { return t; } return 0; } -int parse_ullong(const char *str, unsigned long long *ul) -{ - char *end; - *ul = strtoull(str, &end, 0); - bool okay = *str && !*end && ULLONG_MAX != *ul; - return okay ? ERROR_OK : ERROR_COMMAND_SYNTAX_ERROR; -} -int parse_ulong(const char *str, unsigned long *ul) -{ - char *end; - *ul = strtoul(str, &end, 0); - bool okay = *str && !*end && ULONG_MAX != *ul; - return okay ? ERROR_OK : ERROR_COMMAND_SYNTAX_ERROR; -} +#define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \ + int parse##name(const char *str, type *ul) \ + { \ + if (!*str) \ + { \ + LOG_ERROR("Invalid command argument"); \ + return ERROR_COMMAND_ARGUMENT_INVALID; \ + } \ + char *end; \ + *ul = func(str, &end, 0); \ + if (*end) \ + { \ + LOG_ERROR("Invalid command argument"); \ + return ERROR_COMMAND_ARGUMENT_INVALID; \ + } \ + if ((max == *ul) && (ERANGE == errno)) \ + { \ + LOG_ERROR("Argument overflow"); \ + return ERROR_COMMAND_ARGUMENT_OVERFLOW; \ + } \ + if (min && (min == *ul) && (ERANGE == errno)) \ + { \ + LOG_ERROR("Argument underflow"); \ + return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \ + } \ + return ERROR_OK; \ + } +DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX) +DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX) +DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX) +DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX) + +#define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \ + int parse##name(const char *str, type *ul) \ + { \ + functype n; \ + int retval = parse##funcname(str, &n); \ + if (ERROR_OK != retval) \ + return retval; \ + if (n > 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)