X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=b00a231268cb7fb77f47a2c7dc6b7261e0707e31;hp=5ac5c3015d43c6b1b41a398b7c650baad9ddad47;hb=68bd107c6db941ec7b22f3e491e314041a95224b;hpb=46d9ba4c8b675deb96ac533885500eb62b6c9909 diff --git a/src/helper/command.c b/src/helper/command.c index 5ac5c3015d..b00a231268 100644 --- a/src/helper/command.c +++ b/src/helper/command.c @@ -36,7 +36,8 @@ #endif // @todo the inclusion of target.h here is a layering violation -#include "target.h" +#include +#include #include "command.h" #include "configuration.h" #include "log.h" @@ -44,316 +45,476 @@ #include "jim-eventloop.h" -int fast_and_dangerous = 0; -Jim_Interp *interp = NULL; +/* nice short description of source file */ +#define __THIS__FILE__ "command.c" + -static int run_command(command_context_t *context, - command_t *c, char *words[], unsigned num_words); +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) { - Jim_Obj *tclOutput = (Jim_Obj *)privData; - Jim_AppendString(interp, tclOutput, string, strlen(string)); + struct log_capture_state *state = (struct log_capture_state *)privData; + Jim_AppendString(state->interp, state->output, string, strlen(string)); +} + +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); + state->output = tclOutput; + + log_add_callback(tcl_output, state); + + return state; } -extern command_context_t *global_cmd_ctx; +/* 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) +{ + 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) +{ + int *return_retval = Jim_GetAssocData(interp, "retval"); + if (return_retval != NULL) + *return_retval = retval; + + return (retval == ERROR_OK) ? JIM_OK : JIM_ERR; +} + +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) { - LOG_DEBUG("command - %s", name); + 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 int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) +static void script_command_args_free(const char **words, unsigned nwords) { - /* the private data is stashed in the interp structure */ - command_t *c; - command_context_t *context; - int retval; - int i; - int nwords; - char **words; - - /* 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*/ - - script_debug(interp, c->name, argc, argv); + for (unsigned i = 0; i < nwords; i++) + free((void *)words[i]); + free(words); +} +static const char **script_command_args_alloc( + unsigned argc, Jim_Obj *const *argv, unsigned *nwords) +{ + const char **words = malloc(argc * sizeof(char *)); + if (NULL == words) + return NULL; - words = malloc(sizeof(char *) * argc); + unsigned i; for (i = 0; i < argc; i++) { int len; const char *w = Jim_GetString(argv[i], &len); - if (*w=='#') - { - /* hit an end of line comment */ - break; - } words[i] = strdup(w); if (words[i] == NULL) { - int j; - for (j = 0; j < i; j++) - free(words[j]); - free(words); - return JIM_ERR; + script_command_args_free(words, i); + return NULL; } } - nwords = i; + *nwords = i; + return words; +} +struct command_context *current_command_context(Jim_Interp *interp) +{ /* grab the command context from the associated data */ - context = Jim_GetAssocData(interp, "context"); - if (context == NULL) + struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context"); + 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. */ - context = global_cmd_ctx; + cmd_ctx = global_cmd_ctx; } + return 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); +static int script_command_run(Jim_Interp *interp, + 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_add_callback(tcl_output, tclOutput); + unsigned nwords; + const char **words = script_command_args_alloc(argc, argv, &nwords); + if (NULL == words) + return JIM_ERR; - retval = run_command(context, c, words, nwords); + struct log_capture_state *state = NULL; + if (capture) + state = command_log_capture_start(interp); - log_remove_callback(tcl_output, tclOutput); + struct command_context *cmd_ctx = current_command_context(interp); + int retval = run_command(cmd_ctx, c, (const char **)words, nwords); - /* We dump output into this local variable */ - Jim_SetResult(interp, tclOutput); - Jim_DecrRefCount(interp, tclOutput); + command_log_capture_finish(state); - for (i = 0; i < nwords; i++) - free(words[i]); - free(words); + script_command_args_free(words, nwords); + return command_retval_set(interp, retval); +} - int *return_retval = Jim_GetAssocData(interp, "retval"); - if (return_retval != NULL) - { - *return_retval = retval; - } +static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) +{ + /* the private data is stashed in the interp structure */ - return (retval == ERROR_OK)?JIM_OK:JIM_ERR; + struct command *c = interp->cmdPrivData; + assert(c); + script_debug(interp, c->name, argc, argv); + return script_command_run(interp, argc, argv, c, true); } -static Jim_Obj *command_name_list(struct command_s *c) +static struct command *command_root(struct command *c) { - Jim_Obj *cmd_list = c->parent ? - command_name_list(c->parent) : - Jim_NewListObj(interp, NULL, 0); - Jim_ListAppendElement(interp, cmd_list, - Jim_NewStringObj(interp, c->name, -1)); + while (NULL != c->parent) + c = c->parent; + return c; +} - return cmd_list; +/** + * Find a command by name from a list of commands. + * @returns Returns the named command if it exists in the list. + * Returns NULL otherwise. + */ +static struct command *command_find(struct command *head, const char *name) +{ + 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) +{ + return command_find(cmd_ctx->commands, name); +} +struct command *command_find_in_parent(struct command *parent, + const char *name) +{ + return command_find(parent->children, name); } -static void command_helptext_add(Jim_Obj *cmd_list, const char *help) +/** + * Add the command into the linked list, sorted by name. + * @param head Address to head of command list pointer, which may be + * updated if @c c gets inserted at the beginning of the list. + * @param c The command to add to the list pointed to by @c head. + */ +static void command_add_child(struct command **head, struct command *c) { - Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0); - Jim_ListAppendElement(interp, cmd_entry, cmd_list); - Jim_ListAppendElement(interp, cmd_entry, - Jim_NewStringObj(interp, help ? : "", -1)); + assert(head); + if (NULL == *head) + { + *head = c; + return; + } + + while ((*head)->next && (strcmp(c->name, (*head)->name) > 0)) + head = &(*head)->next; + + if (strcmp(c->name, (*head)->name) > 0) { + c->next = (*head)->next; + (*head)->next = c; + } else { + c->next = *head; + *head = c; + } +} - /* 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_ListAppendElement(interp, helptext, cmd_entry); +static struct command **command_list_for_parent( + struct command_context *cmd_ctx, struct command *parent) +{ + return parent ? &parent->children : &cmd_ctx->commands; } -/* nice short description of source file */ -#define __THIS__FILE__ "command.c" +static void command_free(struct command *c) +{ + /// @todo if command has a handler, unregister its jim command! -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) + while (NULL != c->children) + { + struct command *tmp = c->children; + c->children = tmp->next; + command_free(tmp); + } + + if (c->name) + free((void *)c->name); + if (c->help) + free((void*)c->help); + if (c->usage) + free((void*)c->usage); + free(c); +} + +static struct command *command_new(struct command_context *cmd_ctx, + struct command *parent, const struct command_registration *cr) { - command_t *c, *p; + assert(cr->name); - if (!context || !name) + struct command *c = calloc(1, sizeof(struct command)); + if (NULL == c) return NULL; - c = malloc(sizeof(command_t)); + 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->name = strdup(name); c->parent = parent; - c->children = NULL; - c->handler = handler; - c->mode = mode; - c->next = NULL; + c->handler = cr->handler; + c->jim_handler = cr->jim_handler; + c->jim_handler_data = cr->jim_handler_data; + c->mode = cr->mode; - /* place command in tree */ - if (parent) - { - if (parent->children) - { - /* find last child */ - for (p = parent->children; p && p->next; p = p->next); - if (p) - p->next = c; - } - else - { - parent->children = c; - } - } - else - { - if (context->commands) - { - /* find last command */ - for (p = context->commands; p && p->next; p = p->next); - if (p) - p->next = c; - } - else - { - context->commands = c; - } - } + command_add_child(command_list_for_parent(cmd_ctx, parent), c); - command_helptext_add(command_name_list(c), help); + return c; - /* just a placeholder, no handler */ - if (c->handler == NULL) - return 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_context *cmd_ctx, + struct command *c) +{ + Jim_Interp *interp = cmd_ctx->interp; + const char *ocd_name = alloc_printf("ocd_%s", c->name); + if (NULL == ocd_name) + return JIM_ERR; - const char *full_name = command_name(c, '_'); + LOG_DEBUG("registering '%s'...", ocd_name); - const char *ocd_name = alloc_printf("ocd_%s", full_name); - Jim_CreateCommand(interp, ocd_name, script_command, c, NULL); + Jim_CmdProc func = c->handler ? &script_command : &command_unknown; + int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL); free((void *)ocd_name); + if (JIM_OK != retval) + return retval; /* we now need to add an overrideable proc */ - 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); + const char *override_name = alloc_printf( + "proc %s {args} {eval ocd_bouncer %s $args}", + c->name, c->name); + if (NULL == override_name) + return JIM_ERR; - free((void *)full_name); + retval = Jim_Eval_Named(interp, override_name, 0, 0); + free((void *)override_name); - return c; + return retval; } -int unregister_all_commands(command_context_t *context) +struct command* register_command(struct command_context *context, + struct command *parent, const struct command_registration *cr) { - command_t *c, *c2; + if (!context || !cr->name) + return NULL; - if (context == NULL) - return ERROR_OK; + const char *name = cr->name; + struct command **head = command_list_for_parent(context, parent); + struct command *c = command_find(*head, 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; + } - while (NULL != context->commands) + c = command_new(context, parent, cr); + if (NULL == c) + return NULL; + + int retval = ERROR_OK; + 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(context, command_root(c)); + + if (ERROR_OK != retval) + { + unregister_command(context, parent, name); + c = NULL; + } + return c; +} + +int register_commands(struct command_context *cmd_ctx, struct command *parent, + const struct command_registration *cmds) +{ + int retval = ERROR_OK; + unsigned i; + for (i = 0; cmds[i].name || cmds[i].chain; i++) { - c = context->commands; + const struct command_registration *cr = cmds + i; - while (NULL != c->children) + struct command *c = NULL; + if (NULL != cr->name) + { + c = register_command(cmd_ctx, parent, cr); + if (NULL == c) + { + retval = ERROR_FAIL; + break; + } + } + if (NULL != cr->chain) { - c2 = c->children; - c->children = c->children->next; - free(c2->name); - c2->name = NULL; - free(c2); - c2 = NULL; + struct command *p = c ? : parent; + retval = register_commands(cmd_ctx, p, cr->chain); + if (ERROR_OK != retval) + break; } + } + if (ERROR_OK != retval) + { + for (unsigned j = 0; j < i; j++) + unregister_command(cmd_ctx, parent, cmds[j].name); + } + return retval; +} - context->commands = context->commands->next; +int unregister_all_commands(struct command_context *context, + struct command *parent) +{ + if (context == NULL) + return ERROR_OK; - free(c->name); - c->name = NULL; - free(c); - c = NULL; + struct command **head = command_list_for_parent(context, parent); + while (NULL != *head) + { + struct command *tmp = *head; + *head = tmp->next; + command_free(tmp); } return ERROR_OK; } -int unregister_command(command_context_t *context, char *name) +int unregister_command(struct command_context *context, + struct command *parent, const char *name) { - command_t *c, *p = NULL, *c2; - if ((!context) || (!name)) return ERROR_INVALID_ARGUMENTS; - /* find command */ - c = context->commands; - - while (NULL != c) + 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) { - if (strcmp(name, c->name) == 0) - { - /* unlink command */ - if (p) - { - p->next = c->next; - } - else - { - /* first element in command list */ - context->commands = c->next; - } + if (strcmp(name, c->name) != 0) + continue; - /* unregister children */ - while (NULL != c->children) - { - 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; - } + if (p) + p->next = c->next; + else + *head = c->next; - /* remember the last command for unlinking */ - p = c; - c = c->next; + command_free(c); + return ERROR_OK; } return ERROR_OK; } -void command_output_text(command_context_t *context, const char *data) +void command_set_handler_data(struct command *c, void *p) +{ + if (NULL != c->handler || NULL != c->jim_handler) + c->jim_handler_data = p; + for (struct command *cc = c->children; NULL != cc; cc = cc->next) + command_set_handler_data(cc, p); +} + +void command_output_text(struct command_context *context, const char *data) { if (context && context->output_handler && data) { context->output_handler(context, data); } } -void command_print_sameline(command_context_t *context, const char *format, ...) +void command_print_sameline(struct command_context *context, const char *format, ...) { char *string; @@ -377,7 +538,7 @@ void command_print_sameline(command_context_t *context, const char *format, ...) va_end(ap); } -void command_print(command_context_t *context, const char *format, ...) +void command_print(struct command_context *context, const char *format, ...) { char *string; @@ -402,7 +563,7 @@ void command_print(command_context_t *context, const char *format, ...) va_end(ap); } -static char *__command_name(struct command_s *c, char delim, unsigned extra) +static char *__command_name(struct command *c, char delim, unsigned extra) { char *name; unsigned len = strlen(c->name); @@ -419,29 +580,48 @@ static char *__command_name(struct command_s *c, char delim, unsigned extra) } return name; } -char *command_name(struct command_s *c, char delim) +char *command_name(struct command *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) +static bool command_can_run(struct command_context *cmd_ctx, struct command *c) +{ + return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode; +} + +static int run_command(struct command_context *context, + struct command *c, const char *words[], unsigned num_words) { - int start_word = 0; - if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode))) + if (!command_can_run(context, c)) { - /* Config commands can not run after the config stage */ - LOG_ERROR("Command '%s' only runs during configuration stage", c->name); + /* 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; } - int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1); + struct command_invocation cmd = { + .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) { /* 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; @@ -461,7 +641,7 @@ static int run_command(command_context_t *context, return retval; } -int command_run_line(command_context_t *context, char *line) +int command_run_line(struct command_context *context, char *line) { /* all the parent commands have been registered with the interpreter * so, can just evaluate the line as a script and check for @@ -475,6 +655,7 @@ int command_run_line(command_context_t *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) @@ -484,7 +665,7 @@ 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, 0, 0); Jim_DeleteAssocData(interp, "retval"); } @@ -494,7 +675,8 @@ int command_run_line(command_context_t *context, char *line) if (retval != ERROR_COMMAND_CLOSE_CONNECTION) { /* 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) { @@ -524,14 +706,14 @@ int command_run_line(command_context_t *context, char *line) buff[chunk] = 0; LOG_USER_N("%s", buff); } - LOG_USER_N("%s", "\n"); + LOG_USER_N("\n"); } retval = ERROR_OK; } return retval; } -int command_run_linef(command_context_t *context, const char *format, ...) +int command_run_linef(struct command_context *context, const char *format, ...) { int retval = ERROR_FAIL; char *string; @@ -541,32 +723,34 @@ int command_run_linef(command_context_t *context, const char *format, ...) if (string != NULL) { retval = command_run_line(context, string); + free(string); } va_end(ap); return retval; } -void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), 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; } -command_context_t* copy_command_context(command_context_t* context) +struct command_context* copy_command_context(struct command_context* context) { - command_context_t* copy_context = malloc(sizeof(command_context_t)); + struct command_context* copy_context = malloc(sizeof(struct command_context)); *copy_context = *context; return copy_context; } -int command_done(command_context_t *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 */ @@ -585,142 +769,443 @@ 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 (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; + LOG_USER("%s", CMD_ARGV[0]); + return JIM_OK; +} + +/* 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; + + 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 accidentially 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); - LOG_USER("%s", str); - return JIM_OK; + int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__); + + jtag_poll_set_enabled(save_poll); + + command_log_capture_finish(state); + + return retcode; } -static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie) +static COMMAND_HELPER(command_help_find, struct command *head, + struct command **out) { - size_t nbytes; - const char *ptr; - Jim_Interp *interp; + if (0 == CMD_ARGC) + return ERROR_INVALID_ARGUMENTS; + *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; + if (--CMD_ARGC == 0) + return ERROR_OK; + CMD_ARGV++; + return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out); +} + +static COMMAND_HELPER(command_help_show, struct command *c, unsigned n, + bool show_help, const char *match); + +static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n, + bool show_help, const char *match) +{ + for (struct command *c = head; NULL != c; c = c->next) + CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match); + return ERROR_OK; +} - /* make it a char easier to read code */ - ptr = _ptr; - interp = cookie; - nbytes = size * n; - if (ptr == NULL || interp == NULL || nbytes == 0) { - return 0; +#define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n)) + +static void command_help_show_indent(unsigned n) +{ + for (unsigned i = 0; i < n; i++) + LOG_USER_N(" "); +} +static void command_help_show_wrap(const char *str, unsigned n, unsigned n2) +{ + const char *cp = str, *last = str; + while (*cp) + { + const char *next = last; + do { + cp = next; + do { + next++; + } while (*next != ' ' && *next != '\t' && *next != '\0'); + } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0'); + if (next - last < HELP_LINE_WIDTH(n)) + cp = next; + command_help_show_indent(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, const char *match) +{ + char *cmd_name = command_name(c, ' '); + if (NULL == cmd_name) + return -ENOMEM; + + /* If the match string occurs anywhere, we print out + * stuff for this command. */ + bool is_match = (strstr(cmd_name, match) != NULL) || + ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) || + ((c->help != NULL) && (strstr(c->help, match) != NULL)); - /* do we have to chunk it? */ - if (ptr[nbytes] == 0) + if (is_match) { - /* no it is a C style string */ - LOG_USER_N("%s", ptr); - return strlen(ptr); + command_help_show_indent(n); + LOG_USER_N("%s", cmd_name); } - /* GRR we must chunk - not null terminated */ - while (nbytes) { - char chunk[128 + 1]; - int x; + free(cmd_name); - x = nbytes; - if (x > 128) { - x = 128; + if (is_match) + { + if (c->usage) { + LOG_USER_N(" "); + command_help_show_wrap(c->usage, 0, n + 5); } - /* copy it */ - memcpy(chunk, ptr, x); - /* terminate it */ - chunk[n] = 0; - /* output it */ - LOG_USER_N("%s", chunk); - ptr += x; - nbytes -= x; + else + LOG_USER_N("\n"); + } + + 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; } - return n; + if (++n >= 2) + return ERROR_OK; + + return CALL_COMMAND_HANDLER(command_help_show_list, + c->children, n, show_help, match); +} +COMMAND_HANDLER(handle_help_command) +{ + bool full = strcmp(CMD_NAME, "help") == 0; + int retval; + struct command *c = CMD_CTX->commands; + char *match = NULL; + + if (CMD_ARGC == 0) + match = ""; + else if (CMD_ARGC >= 1) { + unsigned i; + + for (i = 0; i < CMD_ARGC; ++i) { + if (NULL != match) { + char *prev = match; + + match = alloc_printf("%s %s", match, + CMD_ARGV[i]); + free(prev); + if (NULL == match) { + LOG_ERROR("unable to build " + "search string"); + return -ENOMEM; + } + } else { + match = alloc_printf("%s", CMD_ARGV[i]); + if (NULL == match) { + LOG_ERROR("unable to build " + "search string"); + return -ENOMEM; + } + } + } + } else + return ERROR_COMMAND_SYNTAX_ERROR; + + retval = CALL_COMMAND_HANDLER(command_help_show_list, + c, 0, full, match); + + if (CMD_ARGC >= 1) + free(match); + return retval; } -static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie) +static int command_unknown_find(unsigned argc, Jim_Obj *const *argv, + struct command *head, struct command **out, bool top_level) { - /* TCL wants to read... tell him no */ - return 0; + if (0 == argc) + return argc; + const char *cmd_name = Jim_GetString(argv[0], NULL); + struct command *c = command_find(head, cmd_name); + if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0) + c = command_find(head, cmd_name + 4); + if (NULL == c) + return argc; + *out = c; + return command_unknown_find(--argc, ++argv, (*out)->children, out, false); } -static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap) + +static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { - char *cp; - int n; - Jim_Interp *interp; + const char *cmd_name = Jim_GetString(argv[0], NULL); + if (strcmp(cmd_name, "unknown") == 0) + { + if (argc == 1) + return JIM_OK; + argc--; + argv++; + } + script_debug(interp, cmd_name, argc, argv); - n = -1; - interp = cookie; - if (interp == NULL) - return n; + 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) + { + const char *cmd = Jim_GetString(argv[0], NULL); + LOG_ERROR("Unknown command:\n %s", cmd); + return JIM_OK; + } - cp = alloc_vprintf(fmt, ap); - if (cp) + bool found = true; + Jim_Obj *const *start; + unsigned count; + if (c->handler || c->jim_handler) { - LOG_USER_N("%s", cp); - n = strlen(cp); - free(cp); + // include the command name in the list + count = remaining + 1; + start = argv + (argc - remaining - 1); + } + 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) + { + interp->cmdPrivData = c->jim_handler_data; + return (*c->jim_handler)(interp, count, start); } - return n; -} -static int openocd_jim_fflush(void *cookie) -{ - /* nothing to flush */ - return 0; + return script_command_run(interp, count, start, c, found); } -static char* openocd_jim_fgets(char *s, int size, void *cookie) +static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { - /* not supported */ - errno = ENOTSUP; - return NULL; + struct command_context *cmd_ctx = current_command_context(interp); + enum command_mode mode; + + 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) + { + Jim_SetResultString(interp, "unknown", -1); + return JIM_OK; + } + mode = c->mode; + } + 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; + } + Jim_SetResultString(interp, mode_str, -1); + return JIM_OK; } -static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv) +static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { - if (argc != 2) + if (1 == argc) 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); + 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) + { + Jim_SetResultString(interp, "unknown", -1); + return JIM_OK; + } - log_add_callback(tcl_output, tclOutput); + if (c->jim_handler) + Jim_SetResultString(interp, "native", -1); + else if (c->handler) + Jim_SetResultString(interp, "simple", -1); + else + Jim_SetResultString(interp, "group", -1); - retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__); + return JIM_OK; +} - log_remove_callback(tcl_output, tclOutput); +int help_add_command(struct command_context *cmd_ctx, struct command *parent, + 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 + struct command_registration cr = { + .name = cmd_name, + .mode = COMMAND_ANY, + .help = help_text, + .usage = usage, + }; + nc = register_command(cmd_ctx, parent, &cr); + 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) + { + bool replaced = false; + if (nc->help) + { + free((void *)nc->help); + replaced = true; + } + nc->help = strdup(help_text); + if (replaced) + LOG_INFO("replaced existing '%s' help", cmd_name); + else + LOG_DEBUG("added '%s' help text", cmd_name); + } + if (usage) + { + bool replaced = false; + if (nc->usage) + { + free((void *)nc->usage); + replaced = true; + } + nc->usage = strdup(usage); + if (replaced) + LOG_INFO("replaced existing '%s' usage", cmd_name); + else + LOG_DEBUG("added '%s' usage text", cmd_name); + } + return ERROR_OK; +} - /* We dump output into this local variable */ - Jim_SetResult(interp, tclOutput); - Jim_DecrRefCount(interp, tclOutput); +COMMAND_HANDLER(handle_help_add_command) +{ + if (CMD_ARGC < 2) + { + LOG_ERROR("%s: insufficient arguments", CMD_NAME); + return ERROR_INVALID_ARGUMENTS; + } - return retcode; + // 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) + { + LOG_ERROR("command name '%s' is unknown", CMD_NAME); + return ERROR_INVALID_ARGUMENTS; + } + // likewise for the leaf command name + const char *cmd_name = CMD_ARGV[--CMD_ARGC]; + + struct command *c = NULL; + if (CMD_ARGC > 0) + { + c = CMD_CTX->commands; + int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c); + if (ERROR_OK != retval) + return retval; + } + 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 */ -static int handle_sleep_command(struct command_context_s *cmd_ctx, - char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_sleep_command) { bool busy = false; - if (argc == 2) + if (CMD_ARGC == 2) { - if (strcmp(args[1], "busy") == 0) + if (strcmp(CMD_ARGV[1], "busy") == 0) busy = true; else return ERROR_COMMAND_SYNTAX_ERROR; } - else if (argc < 1 || argc > 2) + else if (CMD_ARGC < 1 || CMD_ARGC > 2) return ERROR_COMMAND_SYNTAX_ERROR; unsigned long duration = 0; - int retval = parse_ulong(args[0], &duration); + int retval = parse_ulong(CMD_ARGV[0], &duration); if (ERROR_OK != retval) return retval; @@ -739,21 +1224,92 @@ static int handle_sleep_command(struct command_context_s *cmd_ctx, 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() +static const struct command_registration command_subcommand_handlers[] = { + { + .name = "mode", + .mode = COMMAND_ANY, + .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. " + "Returns 'unknown' if an unknown command is given. " + "Command can be multiple tokens.", + }, + { + .name = "type", + .mode = COMMAND_ANY, + .jim_handler = jim_command_type, + .usage = "command_name [...]", + .help = "Returns the type of built-in command:" + "'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, + .mode = COMMAND_ANY, + .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, + .mode = COMMAND_ANY, + .help = "Add new command usage text; " + "command can be multiple tokens.", + .usage = "command_name usage_string", + }, + { + .name = "sleep", + .handler = handle_sleep_command, + .mode = COMMAND_ANY, + .help = "Sleep for specified number of milliseconds. " + "\"busy\" will busy wait instead (avoid this).", + .usage = "milliseconds ['busy']", + }, + { + .name = "help", + .handler = handle_help_command, + .mode = COMMAND_ANY, + .help = "Show full command help; " + "command can be multiple tokens.", + .usage = "[command_name]", + }, + { + .name = "usage", + .handler = handle_help_command, + .mode = COMMAND_ANY, + .help = "Show basic command usage; " + "command can be multiple tokens.", + .usage = "[command_name]", + }, + { + .name = "command", + .mode= COMMAND_ANY, + .help = "core command group (introspection)", + .chain = command_subcommand_handlers, + }, + COMMAND_REGISTRATION_DONE +}; + +struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp) { - command_context_t* context = malloc(sizeof(command_context_t)); - extern const char startup_tcl[]; + struct command_context* context = malloc(sizeof(struct command_context)); const char *HostOs; context->mode = COMMAND_EXEC; @@ -763,13 +1319,19 @@ command_context_t* command_init() 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); + /* 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); + } #endif + context->interp = interp; + /* Stick to lowercase for HostOS strings. */ #if defined(_MSC_VER) /* WinXX - is generic, the forward * looking problem is this: @@ -781,7 +1343,7 @@ command_context_t* command_init() HostOs = "winxx"; #elif defined(__linux__) HostOs = "linux"; -#elif defined(__DARWIN__) +#elif defined(__APPLE__) || defined(__DARWIN__) HostOs = "darwin"; #elif defined(__CYGWIN__) HostOs = "cygwin"; @@ -789,50 +1351,34 @@ command_context_t* command_init() HostOs = "mingw32"; #elif defined(__ECOS) HostOs = "ecos"; +#elif defined(__FreeBSD__) + HostOs = "freebsd"; #else -#warn unrecognized host OS... +#warning "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); - /* 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) { 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); } - - 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."); + Jim_DeleteAssocData(interp, "context"); return context; } -int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode) +int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode) { if (!cmd_ctx) return ERROR_INVALID_ARGUMENTS; @@ -841,43 +1387,19 @@ int command_context_mode(command_context_t *cmd_ctx, enum command_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; + if (recursion) + return; - if (!recursion) - { - recursion++; - Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT); - recursion--; - } + recursion++; + Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT); + recursion--; #endif } -void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help) -{ - Jim_CreateCommand(interp, name, cmd, NULL, NULL); - - Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0); - Jim_ListAppendElement(interp, cmd_list, - Jim_NewStringObj(interp, name, -1)); - - command_helptext_add(cmd_list, help); -} - -/* 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; -} - #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \ int parse##name(const char *str, type *ul) \ { \ @@ -938,3 +1460,51 @@ 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) + +static int command_parse_bool(const char *in, bool *out, + const char *on, const char *off) +{ + if (strcasecmp(in, on) == 0) + *out = true; + else if (strcasecmp(in, off) == 0) + *out = false; + else + return ERROR_COMMAND_SYNTAX_ERROR; + return ERROR_OK; +} + +int command_parse_bool_arg(const char *in, bool *out) +{ + if (command_parse_bool(in, out, "on", "off") == ERROR_OK) + return ERROR_OK; + if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK) + return ERROR_OK; + if (command_parse_bool(in, out, "true", "false") == ERROR_OK) + return ERROR_OK; + if (command_parse_bool(in, out, "yes", "no") == ERROR_OK) + return ERROR_OK; + if (command_parse_bool(in, out, "1", "0") == ERROR_OK) + return ERROR_OK; + return ERROR_INVALID_ARGUMENTS; +} + +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; + } + // fall through + } + case 0: + LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled"); + break; + default: + return ERROR_INVALID_ARGUMENTS; + } + return ERROR_OK; +}