X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=9d19cff4f870630555d545565bfdbf0e7a445bfa;hp=4b7d8cb9b4d86f282806a0ab9341eab0f19c7c3a;hb=33bb0fe6194b697bfc7e89338c0ffac1c54d09be;hpb=42e00bb379fe7591b6d74768a45855ed5cd0c24f diff --git a/src/helper/command.c b/src/helper/command.c index 4b7d8cb9b4..9d19cff4f8 100644 --- a/src/helper/command.c +++ b/src/helper/command.c @@ -24,58 +24,95 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * ***************************************************************************/ + #ifdef HAVE_CONFIG_H #include "config.h" #endif -#if !BUILD_ECOSBOARD -/* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/ +/* see Embedded-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" +/* @todo the inclusion of target.h here is a layering violation */ +#include +#include #include "command.h" #include "configuration.h" #include "log.h" #include "time_support.h" #include "jim-eventloop.h" - /* nice short description of source file */ #define __THIS__FILE__ "command.c" -Jim_Interp *interp = NULL; - static int run_command(struct command_context *context, struct command *c, const char *words[], unsigned num_words); +struct log_capture_state { + Jim_Interp *interp; + Jim_Obj *output; +}; + static void tcl_output(void *privData, const char *file, unsigned line, - const char *function, const char *string) + const char *function, const char *string) { - Jim_Obj *tclOutput = (Jim_Obj *)privData; - Jim_AppendString(interp, tclOutput, string, strlen(string)); + struct log_capture_state *state = privData; + Jim_AppendString(state->interp, state->output, string, strlen(string)); } -static Jim_Obj *command_log_capture_start(Jim_Interp *interp) +static struct log_capture_state *command_log_capture_start(Jim_Interp *interp) { /* capture log output and return it. A garbage collect can * happen, so we need a reference count to this object */ Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0); if (NULL == tclOutput) return NULL; + + struct log_capture_state *state = malloc(sizeof(*state)); + if (NULL == state) + return NULL; + + state->interp = interp; Jim_IncrRefCount(tclOutput); - log_add_callback(tcl_output, tclOutput); - return tclOutput; + state->output = tclOutput; + + log_add_callback(tcl_output, state); + + return state; } -static void command_log_capture_finish(Jim_Interp *interp, Jim_Obj *tclOutput) +/* Classic openocd commands provide progress output which we + * will capture and return as a Tcl return value. + * + * However, if a non-openocd command has been invoked, then it + * makes sense to return the tcl return value from that command. + * + * The tcl return value is empty for openocd commands that provide + * progress output. + * + * Therefore we set the tcl return value only if we actually + * captured output. + */ +static void command_log_capture_finish(struct log_capture_state *state) { - log_remove_callback(tcl_output, tclOutput); - Jim_SetResult(interp, tclOutput); - Jim_DecrRefCount(interp, tclOutput); + if (NULL == state) + return; + + log_remove_callback(tcl_output, state); + + int length; + Jim_GetString(state->output, &length); + + if (length > 0) + Jim_SetResult(state->interp, state->output); + else { + /* No output captured, use tcl return value (which could + * be empty too). */ + } + Jim_DecrRefCount(state->interp, state->output); + + free(state); } static int command_retval_set(Jim_Interp *interp, int retval) @@ -89,48 +126,46 @@ static int command_retval_set(Jim_Interp *interp, int retval) extern struct command_context *global_cmd_ctx; +/* dump a single line to the log for the command. + * Do nothing in case we are not at debug level 3 */ void script_debug(Jim_Interp *interp, const char *name, - unsigned argc, Jim_Obj *const *argv) + unsigned argc, Jim_Obj * const *argv) { - LOG_DEBUG("command - %s", name); - for (unsigned i = 0; i < argc; i++) - { + if (debug_level < LOG_LVL_DEBUG) + return; + + char *dbg = alloc_printf("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); + char *t = alloc_printf("%s %s", dbg, w); + free(dbg); + dbg = t; } + LOG_DEBUG("%s", dbg); + free(dbg); } -static void script_command_args_free(const char **words, unsigned nwords) +static void script_command_args_free(char **words, unsigned nwords) { for (unsigned i = 0; i < nwords; i++) - free((void *)words[i]); + free(words[i]); free(words); } -static const char **script_command_args_alloc( - unsigned argc, Jim_Obj *const *argv, unsigned *nwords) + +static char **script_command_args_alloc( + unsigned argc, Jim_Obj * const *argv, unsigned *nwords) { - const char **words = malloc(argc * sizeof(char *)); + char **words = malloc(argc * sizeof(char *)); if (NULL == words) return NULL; unsigned i; - for (i = 0; i < argc; i++) - { + for (i = 0; i < argc; i++) { int len; const char *w = Jim_GetString(argv[i], &len); - /* a comment may end the line early */ - if (*w == '#') - break; - words[i] = strdup(w); - if (words[i] == NULL) - { + if (words[i] == NULL) { script_command_args_free(words, i); return NULL; } @@ -139,14 +174,17 @@ static const char **script_command_args_alloc( return words; } -static struct command_context *current_command_context(void) +struct command_context *current_command_context(Jim_Interp *interp) { /* grab the command context from the associated data */ struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context"); - if (NULL == cmd_ctx) - { + if (NULL == cmd_ctx) { /* Tcl can invoke commands directly instead of via command_run_line(). This would - * happen when the Jim Tcl interpreter is provided by eCos. + * happen when the Jim Tcl interpreter is provided by eCos or if we are running + * commands in a startup script. + * + * A telnet or gdb server would provide a non-default command context to + * handle piping of error output, have a separate current target, etc. */ cmd_ctx = global_cmd_ctx; } @@ -154,25 +192,24 @@ static struct command_context *current_command_context(void) } static int script_command_run(Jim_Interp *interp, - int argc, Jim_Obj *const *argv, struct command *c, bool capture) + int argc, Jim_Obj * const *argv, struct command *c, bool capture) { target_call_timer_callbacks_now(); - LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ + LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ unsigned nwords; - const char **words = script_command_args_alloc(argc, argv, &nwords); + char **words = script_command_args_alloc(argc, argv, &nwords); if (NULL == words) return JIM_ERR; - Jim_Obj *tclOutput = NULL; + struct log_capture_state *state = NULL; if (capture) - tclOutput = command_log_capture_start(interp); + state = command_log_capture_start(interp); - struct command_context *cmd_ctx = current_command_context(); + struct command_context *cmd_ctx = current_command_context(interp); int retval = run_command(cmd_ctx, c, (const char **)words, nwords); - if (capture) - command_log_capture_finish(interp, tclOutput); + command_log_capture_finish(state); script_command_args_free(words, nwords); return command_retval_set(interp, retval); @@ -202,20 +239,20 @@ static struct command *command_root(struct command *c) */ static struct command *command_find(struct command *head, const char *name) { - for (struct command *cc = head; cc; cc = cc->next) - { + for (struct command *cc = head; cc; cc = cc->next) { if (strcmp(cc->name, name) == 0) return cc; } return NULL; } + struct command *command_find_in_context(struct command_context *cmd_ctx, - const char *name) + const char *name) { return command_find(cmd_ctx->commands, name); } struct command *command_find_in_parent(struct command *parent, - const char *name) + const char *name) { return command_find(parent->children, name); } @@ -229,8 +266,7 @@ struct command *command_find_in_parent(struct command *parent, static void command_add_child(struct command **head, struct command *c) { assert(head); - if (NULL == *head) - { + if (NULL == *head) { *head = c; return; } @@ -248,24 +284,60 @@ static void command_add_child(struct command **head, struct command *c) } static struct command **command_list_for_parent( - struct command_context *cmd_ctx, struct command *parent) + struct command_context *cmd_ctx, struct command *parent) { return parent ? &parent->children : &cmd_ctx->commands; } +static void command_free(struct command *c) +{ + /** @todo if command has a handler, unregister its jim command! */ + + while (NULL != c->children) { + struct command *tmp = c->children; + c->children = tmp->next; + command_free(tmp); + } + + free(c->name); + free(c->help); + free(c->usage); + free(c); +} + static struct command *command_new(struct command_context *cmd_ctx, - struct command *parent, const struct command_registration *cr) + struct command *parent, const struct command_registration *cr) { assert(cr->name); - struct command *c = malloc(sizeof(struct command)); - memset(c, 0, sizeof(struct command)); + /* + * If it is a non-jim command with no .usage specified, + * log an error. + * + * strlen(.usage) == 0 means that the command takes no + * arguments. + */ + if ((cr->jim_handler == NULL) && (cr->usage == NULL)) { + LOG_DEBUG("BUG: command '%s%s%s' does not have the " + "'.usage' field filled out", + parent && parent->name ? parent->name : "", + parent && parent->name ? " " : "", + cr->name); + } + + struct command *c = calloc(1, sizeof(struct command)); + if (NULL == c) + return NULL; c->name = strdup(cr->name); if (cr->help) c->help = strdup(cr->help); if (cr->usage) c->usage = strdup(cr->usage); + + if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage)) + goto command_new_error; + c->parent = parent; c->handler = cr->handler; c->jim_handler = cr->jim_handler; @@ -275,58 +347,45 @@ static struct command *command_new(struct command_context *cmd_ctx, command_add_child(command_list_for_parent(cmd_ctx, parent), c); return c; -} -static void command_free(struct command *c) -{ - /// @todo if command has a handler, unregister its jim command! - - while (NULL != c->children) - { - struct command *tmp = c->children; - c->children = tmp->next; - command_free(tmp); - } - if (c->name) - free(c->name); - if (c->help) - free((void*)c->help); - if (c->usage) - free((void*)c->usage); - free(c); +command_new_error: + command_free(c); + return NULL; } static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv); -static int register_command_handler(struct command *c) +static int register_command_handler(struct command_context *cmd_ctx, + struct command *c) { - const char *ocd_name = alloc_printf("ocd_%s", c->name); + Jim_Interp *interp = cmd_ctx->interp; + char *ocd_name = alloc_printf("ocd_%s", c->name); if (NULL == ocd_name) return JIM_ERR; LOG_DEBUG("registering '%s'...", ocd_name); - Jim_CmdProc func = c->handler ? &script_command : &command_unknown; + Jim_CmdProc *func = c->handler ? &script_command : &command_unknown; int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL); - free((void *)ocd_name); + free(ocd_name); if (JIM_OK != retval) return retval; /* we now need to add an overrideable proc */ - const char *override_name = alloc_printf( + char *override_name = alloc_printf( "proc %s {args} {eval ocd_bouncer %s $args}", c->name, c->name); if (NULL == override_name) return JIM_ERR; - retval = Jim_Eval_Named(interp, override_name, __FILE__, __LINE__); - free((void *)override_name); + retval = Jim_Eval_Named(interp, override_name, 0, 0); + free(override_name); return retval; } -struct command* register_command(struct command_context *context, - struct command *parent, const struct command_registration *cr) +struct command *register_command(struct command_context *context, + struct command *parent, const struct command_registration *cr) { if (!context || !cr->name) return NULL; @@ -334,10 +393,12 @@ struct command* register_command(struct command_context *context, const char *name = cr->name; struct command **head = command_list_for_parent(context, parent); struct command *c = command_find(*head, name); - if (NULL != c) - { - LOG_ERROR("command '%s' is already registered in '%s' context", - name, parent ? parent->name : ""); + if (NULL != c) { + /* TODO: originally we treated attempting to register a cmd twice as an error + * Sometimes we need this behaviour, such as with flash banks. + * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */ + LOG_DEBUG("command '%s' is already registered in '%s' context", + name, parent ? parent->name : ""); return c; } @@ -346,16 +407,13 @@ struct command* register_command(struct command_context *context, return NULL; int retval = ERROR_OK; - if (NULL != cr->jim_handler && NULL == parent) - { - retval = Jim_CreateCommand(interp, cr->name, + if (NULL != cr->jim_handler && NULL == parent) { + retval = Jim_CreateCommand(context->interp, cr->name, cr->jim_handler, cr->jim_handler_data, NULL); - } - else if (NULL != cr->handler || NULL != parent) - retval = register_command_handler(command_root(c)); + } else if (NULL != cr->handler || NULL != parent) + retval = register_command_handler(context, command_root(c)); - if (ERROR_OK != retval) - { + if (ERROR_OK != retval) { unregister_command(context, parent, name); c = NULL; } @@ -363,34 +421,29 @@ struct command* register_command(struct command_context *context, } int register_commands(struct command_context *cmd_ctx, struct command *parent, - const struct command_registration *cmds) + const struct command_registration *cmds) { int retval = ERROR_OK; unsigned i; - for (i = 0; cmds[i].name || cmds[i].chain; i++) - { + for (i = 0; cmds[i].name || cmds[i].chain; i++) { const struct command_registration *cr = cmds + i; struct command *c = NULL; - if (NULL != cr->name) - { + if (NULL != cr->name) { c = register_command(cmd_ctx, parent, cr); - if (NULL == c) - { + if (NULL == c) { retval = ERROR_FAIL; break; } } - if (NULL != cr->chain) - { + if (NULL != cr->chain) { struct command *p = c ? : parent; retval = register_commands(cmd_ctx, p, cr->chain); if (ERROR_OK != retval) break; } } - if (ERROR_OK != retval) - { + if (ERROR_OK != retval) { for (unsigned j = 0; j < i; j++) unregister_command(cmd_ctx, parent, cmds[j].name); } @@ -398,14 +451,13 @@ int register_commands(struct command_context *cmd_ctx, struct command *parent, } int unregister_all_commands(struct command_context *context, - struct command *parent) + struct command *parent) { if (context == NULL) return ERROR_OK; struct command **head = command_list_for_parent(context, parent); - while (NULL != *head) - { + while (NULL != *head) { struct command *tmp = *head; *head = tmp->next; command_free(tmp); @@ -415,15 +467,14 @@ int unregister_all_commands(struct command_context *context, } int unregister_command(struct command_context *context, - struct command *parent, const char *name) + struct command *parent, const char *name) { if ((!context) || (!name)) - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; struct command *p = NULL; struct command **head = command_list_for_parent(context, parent); - for (struct command *c = *head; NULL != c; p = c, c = c->next) - { + for (struct command *c = *head; NULL != c; p = c, c = c->next) { if (strcmp(name, c->name) != 0) continue; @@ -449,9 +500,8 @@ void command_set_handler_data(struct command *c, void *p) void command_output_text(struct command_context *context, const char *data) { - if (context && context->output_handler && data) { + if (context && context->output_handler && data) context->output_handler(context, data); - } } void command_print_sameline(struct command_context *context, const char *format, ...) @@ -462,16 +512,15 @@ void command_print_sameline(struct command_context *context, const char *format, va_start(ap, format); string = alloc_vprintf(format, ap); - if (string != NULL) - { + if (string != NULL) { /* 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); } @@ -486,17 +535,17 @@ void command_print(struct command_context *context, const char *format, ...) va_start(ap, format); string = alloc_vprintf(format, ap); - if (string != NULL) - { - strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */ + if (string != NULL) { + 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); } @@ -508,11 +557,11 @@ static char *__command_name(struct command *c, char delim, unsigned extra) char *name; unsigned len = strlen(c->name); if (NULL == c->parent) { - // allocate enough for the name, child names, and '\0' + /* 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 + /* 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); @@ -520,6 +569,7 @@ static char *__command_name(struct command *c, char delim, unsigned extra) } return name; } + char *command_name(struct command *c, char delim) { return __command_name(c, delim, 0); @@ -531,38 +581,47 @@ static bool command_can_run(struct command_context *cmd_ctx, struct command *c) } static int run_command(struct command_context *context, - struct command *c, const char *words[], unsigned num_words) + struct command *c, const char *words[], unsigned num_words) { - if (!command_can_run(context, c)) - { - /* Config commands can not run after the config stage */ - LOG_ERROR("The '%s' command must be used before 'init'.", c->name); + if (!command_can_run(context, c)) { + /* Many commands may be run only before/after 'init' */ + const char *when; + switch (c->mode) { + case COMMAND_CONFIG: + when = "before"; + break; + case COMMAND_EXEC: + when = "after"; + break; + /* handle the impossible with humor; it guarantees a bug report! */ + default: + when = "if Cthulhu is summoned by"; + break; + } + LOG_ERROR("The '%s' command must be used %s 'init'.", + c->name, when); return ERROR_FAIL; } struct command_invocation cmd = { - .ctx = context, - .name = c->name, - .argc = num_words - 1, - .argv = words + 1, - }; + .ctx = context, + .current = c, + .name = c->name, + .argc = num_words - 1, + .argv = words + 1, + }; int retval = c->handler(&cmd); - if (retval == ERROR_COMMAND_SYNTAX_ERROR) - { + if (retval == ERROR_COMMAND_SYNTAX_ERROR) { /* Print help for command */ char *full_name = command_name(c, ' '); if (NULL != full_name) { - command_run_linef(context, "help %s", full_name); + command_run_linef(context, "usage %s", full_name); free(full_name); } else retval = -ENOMEM; - } - else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) - { + } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) { /* just fall through for a shutdown request */ - } - else if (retval != ERROR_OK) - { + } else if (retval != ERROR_OK) { /* we do not print out an error message because the command *should* * have printed out an error */ @@ -586,47 +645,46 @@ int command_run_line(struct command_context *context, char *line) * happen when the Jim Tcl interpreter is provided by eCos for * instance. */ + Jim_Interp *interp = context->interp; Jim_DeleteAssocData(interp, "context"); retcode = Jim_SetAssocData(interp, "context", NULL, context); - if (retcode == JIM_OK) - { + 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, __THIS__FILE__, __LINE__); + if (retcode == JIM_OK) { + retcode = Jim_Eval_Named(interp, line, 0, 0); Jim_DeleteAssocData(interp, "retval"); } Jim_DeleteAssocData(interp, "context"); } if (retcode == JIM_ERR) { - if (retval != ERROR_COMMAND_CLOSE_CONNECTION) - { + if (retval == ERROR_COMMAND_CLOSE_CONNECTION) { + /* Shutdown request is not an error */ + return ERROR_OK; + } else { /* We do not print the connection closed error message */ - Jim_PrintErrorMessage(interp); + Jim_MakeErrorMessage(interp); + LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL)); } - if (retval == ERROR_OK) - { + 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)); */ + /* ignore. + * exit(Jim_GetExitCode(interp)); */ } else { const char *result; int reslen; result = Jim_GetString(Jim_GetResult(interp), &reslen); - if (reslen > 0) - { + if (reslen > 0) { int i; char buff[256 + 1]; - for (i = 0; i < reslen; i += 256) - { + for (i = 0; i < reslen; i += 256) { int chunk; chunk = reslen - i; if (chunk > 256) @@ -635,7 +693,7 @@ int command_run_line(struct command_context *context, char *line) buff[chunk] = 0; LOG_USER_N("%s", buff); } - LOG_USER_N("%s", "\n"); + LOG_USER_N("\n"); } retval = ERROR_OK; } @@ -649,36 +707,36 @@ int command_run_linef(struct command_context *context, const char *format, ...) va_list ap; va_start(ap, format); string = alloc_vprintf(format, ap); - if (string != NULL) - { + if (string != NULL) { retval = command_run_line(context, string); + free(string); } va_end(ap); return retval; } -void command_set_output_handler(struct command_context* context, - command_output_handler_t output_handler, void *priv) +void command_set_output_handler(struct command_context *context, + command_output_handler_t output_handler, void *priv) { context->output_handler = output_handler; context->output_handler_priv = priv; } -struct command_context* copy_command_context(struct command_context* context) +struct command_context *copy_command_context(struct command_context *context) { - struct command_context* copy_context = malloc(sizeof(struct command_context)); + struct command_context *copy_context = malloc(sizeof(struct command_context)); *copy_context = *context; return copy_context; } -int command_done(struct command_context *context) +void command_done(struct command_context *cmd_ctx) { - free(context); - context = NULL; + if (NULL == cmd_ctx) + return; - return ERROR_OK; + free(cmd_ctx); } /* find full path to file */ @@ -697,123 +755,58 @@ static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv) return JIM_OK; } -static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv) +COMMAND_HANDLER(jim_echo) { - if (argc != 2) + if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) { + LOG_USER_N("%s", CMD_ARGV[1]); + return JIM_OK; + } + if (CMD_ARGC != 1) return JIM_ERR; - const char *str = Jim_GetString(argv[1], NULL); - LOG_USER("%s", str); + LOG_USER("%s", CMD_ARGV[0]); 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; -} - +/* Capture progress output and return as tcl return value. If the + * progress output was empty, return tcl return value. + */ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { if (argc != 2) return JIM_ERR; - Jim_Obj *tclOutput = command_log_capture_start(interp); + struct log_capture_state *state = command_log_capture_start(interp); + + /* disable polling during capture. This avoids capturing output + * from polling. + * + * This is necessary in order to avoid accidentally getting a non-empty + * string for tcl fn's. + */ + bool save_poll = jtag_poll_get_enabled(); + + jtag_poll_set_enabled(false); const char *str = Jim_GetString(argv[1], NULL); int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__); - command_log_capture_finish(interp, tclOutput); + jtag_poll_set_enabled(save_poll); + + command_log_capture_finish(state); return retcode; } static COMMAND_HELPER(command_help_find, struct command *head, - struct command **out) + struct command **out) { if (0 == CMD_ARGC) - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; *out = command_find(head, CMD_ARGV[0]); if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0) *out = command_find(head, CMD_ARGV[0] + 4); if (NULL == *out) - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; if (--CMD_ARGC == 0) return ERROR_OK; CMD_ARGV++; @@ -821,13 +814,13 @@ static COMMAND_HELPER(command_help_find, struct command *head, } static COMMAND_HELPER(command_help_show, struct command *c, unsigned n, - bool show_help); + bool show_help, const char *cmd_match); static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n, - bool show_help) + bool show_help, const char *cmd_match) { for (struct command *c = head; NULL != c; c = c->next) - CALL_COMMAND_HANDLER(command_help_show, c, n, show_help); + CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, cmd_match); return ERROR_OK; } @@ -841,8 +834,7 @@ static void command_help_show_indent(unsigned n) static void command_help_show_wrap(const char *str, unsigned n, unsigned n2) { const char *cp = str, *last = str; - while (*cp) - { + while (*cp) { const char *next = last; do { cp = next; @@ -853,73 +845,120 @@ static void command_help_show_wrap(const char *str, unsigned n, unsigned n2) if (next - last < HELP_LINE_WIDTH(n)) cp = next; command_help_show_indent(n); - LOG_USER_N("%.*s", (int)(cp - last), last); - LOG_USER_N("\n"); + LOG_USER("%.*s", (int)(cp - last), last); last = cp + 1; n = n2; } } + static COMMAND_HELPER(command_help_show, struct command *c, unsigned n, - bool show_help) + bool show_help, const char *cmd_match) { char *cmd_name = command_name(c, ' '); if (NULL == cmd_name) return -ENOMEM; - command_help_show_indent(n); - LOG_USER_N("%s", cmd_name); + /* If the match string occurs anywhere, we print out + * stuff for this command. */ + bool is_match = (strstr(cmd_name, cmd_match) != NULL) || + ((c->usage != NULL) && (strstr(c->usage, cmd_match) != NULL)) || + ((c->help != NULL) && (strstr(c->help, cmd_match) != NULL)); + + if (is_match) { + command_help_show_indent(n); + LOG_USER_N("%s", cmd_name); + } free(cmd_name); - if (c->usage) { - LOG_USER_N(" "); - command_help_show_wrap(c->usage, 0, n + 5); + if (is_match) { + if (c->usage && strlen(c->usage) > 0) { + LOG_USER_N(" "); + command_help_show_wrap(c->usage, 0, n + 5); + } else + LOG_USER_N("\n"); } - else - LOG_USER_N("\n"); - if (show_help) - { - const char *stage_msg; - switch (c->mode) { - case COMMAND_CONFIG: stage_msg = "CONFIG"; break; - case COMMAND_EXEC: stage_msg = "EXEC"; break; - case COMMAND_ANY: stage_msg = "CONFIG or EXEC"; break; - default: stage_msg = "***UNKNOWN***"; break; - } - char *msg = alloc_printf("%s%sValid Modes: %s", - c->help ? : "", c->help ? " " : "", stage_msg); - if (NULL != msg) - { + if (is_match && show_help) { + char *msg; + + /* Normal commands are runtime-only; highlight exceptions */ + if (c->mode != COMMAND_EXEC) { + const char *stage_msg = ""; + + switch (c->mode) { + case COMMAND_CONFIG: + stage_msg = " (configuration command)"; + break; + case COMMAND_ANY: + stage_msg = " (command valid any time)"; + break; + default: + stage_msg = " (?mode error?)"; + break; + } + msg = alloc_printf("%s%s", c->help ? : "", stage_msg); + } else + msg = alloc_printf("%s", c->help ? : ""); + + if (NULL != msg) { command_help_show_wrap(msg, n + 3, n + 3); free(msg); } else return -ENOMEM; } - if (++n >= 2) - return ERROR_OK; + if (++n > 5) { + LOG_ERROR("command recursion exceeded"); + return ERROR_FAIL; + } return CALL_COMMAND_HANDLER(command_help_show_list, - c->children, n, show_help); + c->children, n, show_help, cmd_match); } + COMMAND_HANDLER(handle_help_command) { bool full = strcmp(CMD_NAME, "help") == 0; - + int retval; struct command *c = CMD_CTX->commands; + char *cmd_match = NULL; + + if (CMD_ARGC == 0) + cmd_match = ""; + else if (CMD_ARGC >= 1) { + unsigned i; + + for (i = 0; i < CMD_ARGC; ++i) { + if (NULL != cmd_match) { + char *prev = cmd_match; + + cmd_match = alloc_printf("%s %s", cmd_match, CMD_ARGV[i]); + free(prev); + if (NULL == cmd_match) { + LOG_ERROR("unable to build search string"); + return -ENOMEM; + } + } else { + cmd_match = alloc_printf("%s", CMD_ARGV[i]); + if (NULL == cmd_match) { + LOG_ERROR("unable to build search string"); + return -ENOMEM; + } + } + } + } else + return ERROR_COMMAND_SYNTAX_ERROR; - if (0 == CMD_ARGC) - return CALL_COMMAND_HANDLER(command_help_show_list, c, 0, full); - - int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c); - if (ERROR_OK != retval) - return retval; + retval = CALL_COMMAND_HANDLER(command_help_show_list, + c, 0, full, cmd_match); - return CALL_COMMAND_HANDLER(command_help_show, c, 0, full); + if (CMD_ARGC >= 1) + free(cmd_match); + return retval; } static int command_unknown_find(unsigned argc, Jim_Obj *const *argv, - struct command *head, struct command **out, bool top_level) + struct command *head, struct command **out, bool top_level) { if (0 == argc) return argc; @@ -936,8 +975,7 @@ static int command_unknown_find(unsigned argc, Jim_Obj *const *argv, static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { const char *cmd_name = Jim_GetString(argv[0], NULL); - if (strcmp(cmd_name, "unknown") == 0) - { + if (strcmp(cmd_name, "unknown") == 0) { if (argc == 1) return JIM_OK; argc--; @@ -945,12 +983,11 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv) } script_debug(interp, cmd_name, argc, argv); - struct command_context *cmd_ctx = current_command_context(); + struct command_context *cmd_ctx = current_command_context(interp); struct command *c = cmd_ctx->commands; int remaining = command_unknown_find(argc, argv, c, &c, true); - // if nothing could be consumed, then it's really an unknown command - if (remaining == argc) - { + /* if nothing could be consumed, then it's really an unknown command */ + if (remaining == argc) { const char *cmd = Jim_GetString(argv[0], NULL); LOG_ERROR("Unknown command:\n %s", cmd); return JIM_OK; @@ -959,27 +996,22 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv) bool found = true; Jim_Obj *const *start; unsigned count; - if (c->handler || c->jim_handler) - { - // include the command name in the list + if (c->handler || c->jim_handler) { + /* include the command name in the list */ count = remaining + 1; start = argv + (argc - remaining - 1); - } - else - { - c = command_find(cmd_ctx->commands, "help"); - if (NULL == c) - { - LOG_ERROR("unknown command, but help is missing too"); + } else { + c = command_find(cmd_ctx->commands, "usage"); + if (NULL == c) { + LOG_ERROR("unknown command, but usage is missing too"); return JIM_ERR; } count = argc - remaining; start = argv; found = false; } - // pass the command through to the intended handler - if (c->jim_handler) - { + /* pass the command through to the intended handler */ + if (c->jim_handler) { interp->cmdPrivData = c->jim_handler_data; return (*c->jim_handler)(interp, count, start); } @@ -989,29 +1021,35 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv) static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { - struct command_context *cmd_ctx = current_command_context(); + struct command_context *cmd_ctx = current_command_context(interp); enum command_mode mode; - if (argc > 1) - { + + if (argc > 1) { struct command *c = cmd_ctx->commands; int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true); - // if nothing could be consumed, then it's an unknown command - if (remaining == argc - 1) - { + /* if nothing could be consumed, then it's an unknown command */ + if (remaining == argc - 1) { Jim_SetResultString(interp, "unknown", -1); return JIM_OK; } mode = c->mode; - } - else + } else mode = cmd_ctx->mode; const char *mode_str; switch (mode) { - case COMMAND_ANY: mode_str = "any"; break; - case COMMAND_CONFIG: mode_str = "config"; break; - case COMMAND_EXEC: mode_str = "exec"; break; - default: mode_str = "unknown"; break; + case COMMAND_ANY: + mode_str = "any"; + break; + case COMMAND_CONFIG: + mode_str = "config"; + break; + case COMMAND_EXEC: + mode_str = "exec"; + break; + default: + mode_str = "unknown"; + break; } Jim_SetResultString(interp, mode_str, -1); return JIM_OK; @@ -1022,12 +1060,11 @@ static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv) if (1 == argc) return JIM_ERR; - struct command_context *cmd_ctx = current_command_context(); + struct command_context *cmd_ctx = current_command_context(interp); struct command *c = cmd_ctx->commands; int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true); - // if nothing could be consumed, then it's an unknown command - if (remaining == argc - 1) - { + /* if nothing could be consumed, then it's an unknown command */ + if (remaining == argc - 1) { Jim_SetResultString(interp, "unknown", -1); return JIM_OK; } @@ -1036,41 +1073,39 @@ static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv) Jim_SetResultString(interp, "native", -1); else if (c->handler) Jim_SetResultString(interp, "simple", -1); - else + else if (remaining == 0) Jim_SetResultString(interp, "group", -1); + else + Jim_SetResultString(interp, "unknown", -1); return JIM_OK; } int help_add_command(struct command_context *cmd_ctx, struct command *parent, - const char *cmd_name, const char *help_text, const char *usage) + const char *cmd_name, const char *help_text, const char *usage) { struct command **head = command_list_for_parent(cmd_ctx, parent); struct command *nc = command_find(*head, cmd_name); - if (NULL == nc) - { - // add a new command with help text + if (NULL == nc) { + /* add a new command with help text */ struct command_registration cr = { - .name = cmd_name, - .mode = COMMAND_ANY, - .help = help_text, - .usage = usage, - }; + .name = cmd_name, + .mode = COMMAND_ANY, + .help = help_text, + .usage = usage, + }; nc = register_command(cmd_ctx, parent, &cr); - if (NULL == nc) - { + if (NULL == nc) { LOG_ERROR("failed to add '%s' help text", cmd_name); return ERROR_FAIL; } LOG_DEBUG("added '%s' help text", cmd_name); return ERROR_OK; } - if (help_text) - { + if (help_text) { bool replaced = false; - if (nc->help) - { - free((void *)nc->help); + if (nc->help) { + free(nc->help); replaced = true; } nc->help = strdup(help_text); @@ -1079,12 +1114,10 @@ int help_add_command(struct command_context *cmd_ctx, struct command *parent, else LOG_DEBUG("added '%s' help text", cmd_name); } - if (usage) - { + if (usage) { bool replaced = false; - if (nc->usage) - { - free((void *)nc->usage); + if (nc->usage) { + free(nc->usage); replaced = true; } nc->usage = strdup(usage); @@ -1098,27 +1131,24 @@ int help_add_command(struct command_context *cmd_ctx, struct command *parent, COMMAND_HANDLER(handle_help_add_command) { - if (CMD_ARGC < 2) - { + if (CMD_ARGC < 2) { LOG_ERROR("%s: insufficient arguments", CMD_NAME); - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; } - // save help text and remove it from argument list + /* save help text and remove it from argument list */ const char *str = CMD_ARGV[--CMD_ARGC]; const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL; const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL; - if (!help && !usage) - { + if (!help && !usage) { LOG_ERROR("command name '%s' is unknown", CMD_NAME); - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; } - // likewise for the leaf command name + /* likewise for the leaf command name */ const char *cmd_name = CMD_ARGV[--CMD_ARGC]; struct command *c = NULL; - if (CMD_ARGC > 0) - { + if (CMD_ARGC > 0) { c = CMD_CTX->commands; int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c); if (ERROR_OK != retval) @@ -1127,20 +1157,18 @@ COMMAND_HANDLER(handle_help_add_command) return help_add_command(CMD_CTX, c, cmd_name, help, usage); } -/* sleep command sleeps for miliseconds +/* sleep command sleeps for milliseconds * this is useful in target startup scripts */ COMMAND_HANDLER(handle_sleep_command) { bool busy = false; - if (CMD_ARGC == 2) - { + if (CMD_ARGC == 2) { if (strcmp(CMD_ARGV[1], "busy") == 0) busy = true; else return ERROR_COMMAND_SYNTAX_ERROR; - } - else if (CMD_ARGC < 1 || CMD_ARGC > 2) + } else if (CMD_ARGC < 1 || CMD_ARGC > 2) return ERROR_COMMAND_SYNTAX_ERROR; unsigned long duration = 0; @@ -1148,16 +1176,13 @@ COMMAND_HANDLER(handle_sleep_command) if (ERROR_OK != retval) return retval; - if (!busy) - { + if (!busy) { long long then = timeval_ms(); - while (timeval_ms() - then < (long long)duration) - { + while (timeval_ms() - then < (long long)duration) { target_call_timer_callbacks_now(); usleep(1000); } - } - else + } else busy_sleep(duration); return ERROR_OK; @@ -1167,72 +1192,88 @@ static const struct command_registration command_subcommand_handlers[] = { { .name = "mode", .mode = COMMAND_ANY, - .jim_handler = &jim_command_mode, - .usage = "[ ...]", + .jim_handler = jim_command_mode, + .usage = "[command_name ...]", .help = "Returns the command modes allowed by a command:" "'any', 'config', or 'exec'. If no command is" - "specified, returns the current command mode.", + "specified, returns the current command mode. " + "Returns 'unknown' if an unknown command is given. " + "Command can be multiple tokens.", }, { .name = "type", .mode = COMMAND_ANY, - .jim_handler = &jim_command_type, - .usage = " ...", + .jim_handler = jim_command_type, + .usage = "command_name [...]", .help = "Returns the type of built-in command:" - "'native', 'simple', 'group', or 'unknown'", + "'native', 'simple', 'group', or 'unknown'. " + "Command can be multiple tokens.", }, COMMAND_REGISTRATION_DONE }; static const struct command_registration command_builtin_handlers[] = { + { + .name = "echo", + .handler = jim_echo, + .mode = COMMAND_ANY, + .help = "Logs a message at \"user\" priority. " + "Output message to stdout. " + "Option \"-n\" suppresses trailing newline", + .usage = "[-n] string", + }, { .name = "add_help_text", - .handler = &handle_help_add_command, + .handler = handle_help_add_command, .mode = COMMAND_ANY, - .help = "add new command help text", - .usage = " [...] ]", + .help = "Add new command help text; " + "Command can be multiple tokens.", + .usage = "command_name helptext_string", }, { .name = "add_usage_text", - .handler = &handle_help_add_command, + .handler = handle_help_add_command, .mode = COMMAND_ANY, - .help = "add new command usage text", - .usage = " [...] ]", + .help = "Add new command usage text; " + "command can be multiple tokens.", + .usage = "command_name usage_string", }, { .name = "sleep", - .handler = &handle_sleep_command, + .handler = handle_sleep_command, .mode = COMMAND_ANY, - .help = "sleep for n milliseconds. " - "\"busy\" will busy wait", - .usage = " [busy]", + .help = "Sleep for specified number of milliseconds. " + "\"busy\" will busy wait instead (avoid this).", + .usage = "milliseconds ['busy']", }, { .name = "help", - .handler = &handle_help_command, + .handler = handle_help_command, .mode = COMMAND_ANY, - .help = "show full command help", - .usage = "[ ...]", + .help = "Show full command help; " + "command can be multiple tokens.", + .usage = "[command_name]", }, { .name = "usage", - .handler = &handle_help_command, + .handler = handle_help_command, .mode = COMMAND_ANY, - .help = "show basic command usage", - .usage = "[ ...]", + .help = "Show basic command usage; " + "command can be multiple tokens.", + .usage = "[command_name]", }, { .name = "command", - .mode= COMMAND_ANY, + .mode = COMMAND_ANY, .help = "core command group (introspection)", .chain = command_subcommand_handlers, }, COMMAND_REGISTRATION_DONE }; -struct command_context* command_init(const char *startup_tcl) +struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp) { - struct command_context* context = malloc(sizeof(struct command_context)); + struct command_context *context = malloc(sizeof(struct command_context)); const char *HostOs; context->mode = COMMAND_EXEC; @@ -1241,14 +1282,18 @@ struct command_context* command_init(const char *startup_tcl) context->output_handler = NULL; context->output_handler_priv = NULL; -#if !BUILD_ECOSBOARD - Jim_InitEmbedded(); - /* Create an interpreter */ - interp = Jim_CreateInterp(); - /* Add all the Jim core commands */ - Jim_RegisterCoreCommands(interp); -#endif + /* Create a jim interpreter if we were not handed one */ + if (interp == NULL) { + /* Create an interpreter */ + interp = Jim_CreateInterp(); + /* Add all the Jim core commands */ + Jim_RegisterCoreCommands(interp); + Jim_InitStaticExtensions(interp); + } + + context->interp = interp; + /* Stick to lowercase for HostOS strings. */ #if defined(_MSC_VER) /* WinXX - is generic, the forward * looking problem is this: @@ -1260,7 +1305,7 @@ struct command_context* command_init(const char *startup_tcl) HostOs = "winxx"; #elif defined(__linux__) HostOs = "linux"; -#elif defined(__DARWIN__) +#elif defined(__APPLE__) || defined(__DARWIN__) HostOs = "darwin"; #elif defined(__CYGWIN__) HostOs = "cygwin"; @@ -1268,37 +1313,29 @@ struct command_context* command_init(const char *startup_tcl) HostOs = "mingw32"; #elif defined(__ECOS) HostOs = "ecos"; +#elif defined(__FreeBSD__) + HostOs = "freebsd"; +#elif defined(__NetBSD__) + HostOs = "netbsd"; +#elif defined(__OpenBSD__) + HostOs = "openbsd"; #else -#warn unrecognized host OS... +#warning "Unrecognized host OS..." HostOs = "other"; #endif Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS", - Jim_NewStringObj(interp, HostOs , strlen(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; - 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; - register_commands(context, NULL, command_builtin_handlers); -#if !BUILD_ECOSBOARD - Jim_EventLoopOnLoad(interp); -#endif Jim_SetAssocData(interp, "context", NULL, context); - 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)"); - Jim_PrintErrorMessage(interp); + Jim_MakeErrorMessage(interp); + LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL)); exit(-1); } Jim_DeleteAssocData(interp, "context"); @@ -1309,89 +1346,84 @@ struct command_context* command_init(const char *startup_tcl) int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode) { if (!cmd_ctx) - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; cmd_ctx->mode = mode; return ERROR_OK; } -void process_jim_events(void) +void process_jim_events(struct command_context *cmd_ctx) { -#if !BUILD_ECOSBOARD - static int recursion = 0; + static int recursion; + if (recursion) + return; - if (!recursion) - { - recursion++; - Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT); - recursion--; - } -#endif + recursion++; + Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT); + recursion--; } #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \ - int parse##name(const char *str, type *ul) \ + int parse ## name(const char *str, type * ul) \ { \ - if (!*str) \ - { \ + if (!*str) { \ LOG_ERROR("Invalid command argument"); \ return ERROR_COMMAND_ARGUMENT_INVALID; \ } \ char *end; \ *ul = func(str, &end, 0); \ - if (*end) \ - { \ + 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 ((max == *ul) && (ERANGE == errno)) { \ + LOG_ERROR("Argument overflow"); \ + return ERROR_COMMAND_ARGUMENT_OVERFLOW; \ } \ - if (min && (min == *ul) && (ERANGE == errno)) \ - { \ + 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(_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(_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) \ + int parse ## name(const char *str, type * ul) \ { \ functype n; \ - int retval = parse##funcname(str, &n); \ - if (ERROR_OK != retval) \ + int retval = parse ## funcname(str, &n); \ + if (ERROR_OK != retval) \ return retval; \ if (n > max) \ - return ERROR_COMMAND_ARGUMENT_OVERFLOW; \ + 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) +#define DEFINE_PARSE_ULONGLONG(name, type, min, max) \ + DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong) +DEFINE_PARSE_ULONGLONG(_uint, unsigned, 0, UINT_MAX) +DEFINE_PARSE_ULONGLONG(_u64, uint64_t, 0, UINT64_MAX) +DEFINE_PARSE_ULONGLONG(_u32, uint32_t, 0, UINT32_MAX) +DEFINE_PARSE_ULONGLONG(_u16, uint16_t, 0, UINT16_MAX) +DEFINE_PARSE_ULONGLONG(_u8, uint8_t, 0, UINT8_MAX) + +#define DEFINE_PARSE_LONGLONG(name, type, min, max) \ + DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong) +DEFINE_PARSE_LONGLONG(_int, int, n < INT_MIN, INT_MAX) +DEFINE_PARSE_LONGLONG(_s64, int64_t, n < INT64_MIN, INT64_MAX) +DEFINE_PARSE_LONGLONG(_s32, int32_t, n < INT32_MIN, INT32_MAX) +DEFINE_PARSE_LONGLONG(_s16, int16_t, n < INT16_MIN, INT16_MAX) +DEFINE_PARSE_LONGLONG(_s8, int8_t, n < INT8_MIN, INT8_MAX) static int command_parse_bool(const char *in, bool *out, - const char *on, const char *off) + const char *on, const char *off) { if (strcasecmp(in, on) == 0) *out = true; @@ -1399,7 +1431,7 @@ static int command_parse_bool(const char *in, bool *out, *out = false; else return ERROR_COMMAND_SYNTAX_ERROR; - return ERROR_OK; + return ERROR_OK; } int command_parse_bool_arg(const char *in, bool *out) @@ -1414,26 +1446,25 @@ int command_parse_bool_arg(const char *in, bool *out) return ERROR_OK; if (command_parse_bool(in, out, "1", "0") == ERROR_OK) return ERROR_OK; - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; } COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label) { switch (CMD_ARGC) { - case 1: { - const char *in = CMD_ARGV[0]; - if (command_parse_bool_arg(in, out) != ERROR_OK) - { - LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in); - return ERROR_INVALID_ARGUMENTS; + case 1: { + const char *in = CMD_ARGV[0]; + if (command_parse_bool_arg(in, out) != ERROR_OK) { + LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in); + return ERROR_COMMAND_SYNTAX_ERROR; + } + /* fall through */ } - // fall through - } - case 0: - LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled"); - break; - default: - return ERROR_INVALID_ARGUMENTS; + case 0: + LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled"); + break; + default: + return ERROR_COMMAND_SYNTAX_ERROR; } return ERROR_OK; }