X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=3ed8dc87d8d55fecfe2416ca4c3360211f67c4f7;hp=b4e31ea1a7e1d2a3a975ad5515999dcd1fd14306;hb=4668bd264cfe64c3e3ddd0f75cb5bf2e5e85f717;hpb=9d167d62f2eadf81e0028e471e05154c9aabbbfb diff --git a/src/helper/command.c b/src/helper/command.c index b4e31ea1a7..3ed8dc87d8 100644 --- a/src/helper/command.c +++ b/src/helper/command.c @@ -36,6 +36,7 @@ #endif // @todo the inclusion of target.h here is a layering violation +#include #include #include "command.h" #include "configuration.h" @@ -84,6 +85,18 @@ static struct log_capture_state *command_log_capture_start(Jim_Interp *interp) return state; } +/* 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) @@ -91,7 +104,17 @@ static void command_log_capture_finish(struct log_capture_state *state) log_remove_callback(tcl_output, state); - Jim_SetResult(state->interp, state->output); + 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); @@ -108,21 +131,25 @@ 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) { - 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 void script_command_args_free(const char **words, unsigned nwords) @@ -143,10 +170,6 @@ static const char **script_command_args_alloc( { 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) { @@ -158,14 +181,18 @@ static const char **script_command_args_alloc( return words; } -static struct command_context *current_command_context(Jim_Interp *interp) +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) { /* 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; } @@ -283,7 +310,7 @@ static void command_free(struct command *c) } if (c->name) - free(c->name); + free((void *)c->name); if (c->help) free((void*)c->help); if (c->usage) @@ -296,6 +323,22 @@ static struct command *command_new(struct command_context *cmd_ctx, { assert(cr->name); + /* + 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; @@ -349,7 +392,7 @@ static int register_command_handler(struct command_context *cmd_ctx, if (NULL == override_name) return JIM_ERR; - retval = Jim_Eval_Named(interp, override_name, __FILE__, __LINE__); + retval = Jim_Eval_Named(interp, override_name, 0, 0); free((void *)override_name); return retval; @@ -366,7 +409,10 @@ struct command* register_command(struct command_context *context, struct command *c = command_find(*head, name); if (NULL != c) { - LOG_ERROR("command '%s' is already registered in '%s' context", + /* 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; } @@ -448,7 +494,7 @@ int unregister_command(struct command_context *context, 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); @@ -635,7 +681,7 @@ int command_run_line(struct command_context *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"); } @@ -645,7 +691,8 @@ int command_run_line(struct command_context *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) { @@ -675,7 +722,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; } @@ -692,6 +739,7 @@ int command_run_linef(struct command_context *context, const char *format, ...) if (string != NULL) { retval = command_run_line(context, string); + free(string); } va_end(ap); return retval; @@ -737,98 +785,22 @@ 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) - return JIM_ERR; - const char *str = Jim_GetString(argv[1], NULL); - LOG_USER("%s", str); - 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) + if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) { - LOG_USER_N("%s", cp); - n = strlen(cp); - free(cp); + LOG_USER_N("%s", CMD_ARGV[1]); + return JIM_OK; } - 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; + 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) @@ -836,9 +808,21 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv) 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); int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__); + jtag_poll_set_enabled(save_poll); + command_log_capture_finish(state); return retcode; @@ -848,12 +832,12 @@ static COMMAND_HELPER(command_help_find, struct command *head, 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++; @@ -893,8 +877,7 @@ 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; } @@ -902,9 +885,6 @@ static void command_help_show_wrap(const char *str, unsigned n, unsigned n2) static COMMAND_HELPER(command_help_show, struct command *c, unsigned n, bool show_help, const char *match) { - if (!command_can_run(CMD_CTX, c)) - return ERROR_OK; - char *cmd_name = command_name(c, ' '); if (NULL == cmd_name) return -ENOMEM; @@ -914,7 +894,7 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n, bool is_match = (strstr(cmd_name, match) != NULL) || ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) || ((c->help != NULL) && (strstr(c->help, match) != NULL)); - + if (is_match) { command_help_show_indent(n); @@ -934,15 +914,27 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n, if (is_match && 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); + 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); @@ -951,8 +943,10 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n, 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, match); @@ -1075,6 +1069,7 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { struct command_context *cmd_ctx = current_command_context(interp); enum command_mode mode; + if (argc > 1) { struct command *c = cmd_ctx->commands; @@ -1185,7 +1180,7 @@ COMMAND_HANDLER(handle_help_add_command) 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 @@ -1195,7 +1190,7 @@ COMMAND_HANDLER(handle_help_add_command) 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 const char *cmd_name = CMD_ARGV[--CMD_ARGC]; @@ -1211,7 +1206,7 @@ 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) @@ -1251,59 +1246,75 @@ 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", @@ -1329,15 +1340,16 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp /* Create a jim interpreter if we were not handed one */ if (interp == NULL) { - Jim_InitEmbedded(); /* 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: @@ -1349,7 +1361,7 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp HostOs = "winxx"; #elif defined(__linux__) HostOs = "linux"; -#elif defined(__DARWIN__) +#elif defined(__APPLE__) || defined(__DARWIN__) HostOs = "darwin"; #elif defined(__CYGWIN__) HostOs = "cygwin"; @@ -1357,37 +1369,26 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp 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); } Jim_DeleteAssocData(interp, "context"); @@ -1398,7 +1399,7 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp 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; @@ -1502,7 +1503,7 @@ 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) @@ -1513,7 +1514,7 @@ COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label) if (command_parse_bool_arg(in, out) != ERROR_OK) { LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in); - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; } // fall through } @@ -1521,7 +1522,7 @@ COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label) LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled"); break; default: - return ERROR_INVALID_ARGUMENTS; + return ERROR_COMMAND_SYNTAX_ERROR; } return ERROR_OK; }