X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=6acd53c1e650c014026dfc85c5ed21c1d68ed218;hb=381f9a2e8aa1697e2af3c2bcad962dfcfe7348d7;hp=ca08535a4039c6ed62913bfe3f14ec101f6e2afc;hpb=83440065c00cce9d36f23182b439d7bf2306cfb2;p=openocd.git diff --git a/src/helper/command.c b/src/helper/command.c index ca08535a40..6acd53c1e6 100644 --- a/src/helper/command.c +++ b/src/helper/command.c @@ -29,6 +29,7 @@ #include "command.h" #include "log.h" +#include "time_support.h" #include #include @@ -37,7 +38,16 @@ #include #include +int fast_and_dangerous = 0; + +void command_print_help_line(command_context_t* context, struct command_s *command, int indent); + int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); +int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); +int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); + +/* forward declaration of jim_command */ +extern int jim_command(command_context_t *context, char *line); int build_unique_lengths(command_context_t *context, command_t *commands) { @@ -76,9 +86,15 @@ int build_unique_lengths(command_context_t *context, command_t *commands) return ERROR_OK; } +/* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n). + * Makes a difference on ARM7 types machines and is not observable on GHz machines. + */ +static int unique_length_dirty = 1; + command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help) { command_t *c, *p; + unique_length_dirty = 1; if (!context || !name) return NULL; @@ -127,16 +143,54 @@ command_t* register_command(command_context_t *context, command_t *parent, char } } - /* update unique lengths */ - build_unique_lengths(context, (parent) ? parent : context->commands); - return c; } +int unregister_all_commands(command_context_t *context) +{ + command_t *c, *c2; + + unique_length_dirty = 1; + + if (context == NULL) + return ERROR_OK; + + + while(NULL != context->commands) + { + c = context->commands; + + while(NULL != c->children) + { + c2 = c->children; + c->children = c->children->next; + free(c2->name); + c2->name = NULL; + free(c2->help); + c2->help = NULL; + free(c2); + c2 = NULL; + } + + context->commands = context->commands->next; + + free(c->name); + c->name = NULL; + free(c->help); + c->help = NULL; + free(c); + c = NULL; + } + + return ERROR_OK; +} + int unregister_command(command_context_t *context, char *name) { command_t *c, *p = NULL, *c2; + unique_length_dirty = 1; + if ((!context) || (!name)) return ERROR_INVALID_ARGUMENTS; @@ -200,14 +254,24 @@ int parse_line(char *line, char *words[], int max_words) /* we're inside a word or quote, and reached its end*/ if (word_start) { - int len = p - word_start; - - /* copy the word */ - memcpy(words[nwords] = malloc(len + 1), word_start, len); - /* add terminating NUL */ - words[nwords++][len] = 0; + int len; + char *word_end=p; + + /* This will handle extra whitespace within quotes */ + while (isspace(*word_start)&&(word_start0) + { + /* copy the word */ + memcpy(words[nwords] = malloc(len + 1), word_start, len); + /* add terminating NUL */ + words[nwords++][len] = 0; + } } - /* we're done parsing the line */ if (!*p) break; @@ -215,7 +279,9 @@ int parse_line(char *line, char *words[], int max_words) /* skip over trailing quote or whitespace*/ if (inquote || isspace(*p)) p++; - + while (isspace(*p)) + p++; + inquote = 0; word_start = 0; } @@ -239,55 +305,59 @@ int parse_line(char *line, char *words[], int max_words) return nwords; } -void command_print(command_context_t *context, char *format, ...) +void command_output_text(command_context_t *context, const char *data) { - va_list ap; - char *buffer = NULL; - int n, size = 0; - char *p; + if( context && context->output_handler && data ){ + context->output_handler( context, data ); + } +} - va_start(ap, format); +void command_print_n(command_context_t *context, char *format, ...) +{ + char *string; - /* process format string */ - /* TODO: possible bug. va_list is undefined after the first call to vsnprintf */ - while (!buffer || (n = vsnprintf(buffer, size, format, ap)) >= size) - { - /* increase buffer until it fits the whole string */ - if (!(p = realloc(buffer, size += 4096))) - return; + va_list ap; + va_start(ap, format); - buffer = p; + string = alloc_vprintf(format, ap); + if (string != NULL) + { + context->output_handler(context, string); + free(string); } - - /* vsnprintf failed */ - if (n < 0) - return; - p = buffer; - - /* process lines in buffer */ - do { - char *next = strchr(p, '\n'); - - if (next) - *next++ = 0; + va_end(ap); +} - if (context->output_handler) - context->output_handler(context, p); +void command_print(command_context_t *context, char *format, ...) +{ + char *string; + + va_list ap; + 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 */ + context->output_handler(context, string); + free(string); + } - p = next; - } while (p); - - if (buffer) - free(buffer); - va_end(ap); } -int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word) +command_t *find_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word, int *new_start_word) { command_t *c; + if (unique_length_dirty) + { + unique_length_dirty = 0; + /* update unique lengths */ + build_unique_lengths(context, context->commands); + } + for (c = commands; c; c = c->next) { if (strncasecmp(c->name, words[start_word], c->unique_len)) @@ -296,46 +366,74 @@ int find_and_run_command(command_context_t *context, command_t *commands, char * if (strncasecmp(c->name, words[start_word], strlen(words[start_word]))) continue; - if ((c->mode == context->mode) || (c->mode == COMMAND_ANY)) + if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ) { if (!c->children) { if (!c->handler) { - command_print(context, "No handler for command"); - break; + return NULL; } else { - return c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1); + *new_start_word=start_word; + return c; } } else { if (start_word == num_words - 1) { - command_print(context, "Incomplete command"); - break; + return NULL; } - return find_and_run_command(context, c->children, words, num_words, start_word + 1); + return find_command(context, c->children, words, num_words, start_word + 1, new_start_word); } } } + return NULL; +} + +int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words) +{ + int start_word=0; + command_t *c; + c = find_command(context, commands, words, num_words, start_word, &start_word); + if (c == NULL) + { + /* just return command not found */ + return ERROR_COMMAND_NOTFOUND; + } - command_print(context, "Command %s not found", words[start_word]); - return ERROR_OK; + int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1); + if (retval == ERROR_COMMAND_SYNTAX_ERROR) + { + command_print(context, "Syntax error:"); + command_print_help_line(context, c, 0); + } + else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) + { + /* just fall through for a shutdown request */ + } + else if (retval != ERROR_OK) + { + /* we do not print out an error message because the command *should* + * have printed out an error + */ + LOG_DEBUG("Command failed with error code %d", retval); + } + + return retval; } -int command_run_line(command_context_t *context, char *line) +int command_run_line_internal(command_context_t *context, char *line) { + LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ + int nwords; char *words[128] = {0}; int retval; int i; - - if ((!context) || (!line)) - return ERROR_INVALID_ARGUMENTS; - + /* skip preceding whitespace */ while (isspace(*line)) line++; @@ -344,15 +442,18 @@ int command_run_line(command_context_t *context, char *line) if (!*line) return ERROR_OK; - if (context->echo) - { - command_print(context, "%s", line); - } + /* ignore comments */ + if (*line && (line[0] == '#')) + return ERROR_OK; + + LOG_DEBUG("%s", line); nwords = parse_line(line, words, sizeof(words) / sizeof(words[0])); if (nwords > 0) - retval = find_and_run_command(context, context->commands, words, nwords, 0); + { + retval = find_and_run_command(context, context->commands, words, nwords); + } else return ERROR_INVALID_ARGUMENTS; @@ -362,77 +463,57 @@ int command_run_line(command_context_t *context, char *line) return retval; } -int command_run_file(command_context_t *context, FILE *file, enum command_mode mode) +int command_run_line(command_context_t *context, char *line) { - int retval; - int old_command_mode; - char buffer[4096]; - - old_command_mode = context->mode; - context->mode = mode; - - while (fgets(buffer, 4096, file)) - { - char *p; - char *cmd, *end; - - /* stop processing line after a comment (#, !) or a LF, CR were encountered */ - if ((p = strpbrk(buffer, "#!\r\n"))) - *p = 0; + /* if a command is unknown to the "unknown" proc in tcl/commands.tcl will + * redirect it to OpenOCD. + * + * This avoids having to type the "openocd" prefix and makes OpenOCD + * commands "native" to Tcl. + */ + return jim_command(context, line); +} - /* skip over leading whitespace */ - cmd = buffer; - while (isspace(*cmd)) - cmd++; - /* empty (all whitespace) line? */ - if (!*cmd) - continue; - - /* search the end of the current line, ignore trailing whitespace */ - for (p = end = cmd; *p; p++) - if (!isspace(*p)) - end = p; - - /* terminate end */ - *++end = 0; - if (strcasecmp(cmd, "quit") == 0) - break; - - /* run line */ - if ((retval = command_run_line(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION) - break; +int command_run_linef(command_context_t *context, char *format, ...) +{ + int retval=ERROR_FAIL; + char *string; + va_list ap; + va_start(ap, format); + string = alloc_vprintf(format, ap); + if (string!=NULL) + { + retval=command_run_line(context, string); } - - context->mode = old_command_mode; - + va_end(ap); return retval; } void command_print_help_line(command_context_t* context, struct command_s *command, int indent) { command_t *c; - char indents[32] = {0}; + char *indent_text=malloc(indent + 2); + char *help = "no help available"; char name_buf[64]; - int i; - for (i = 0; i < indent; i+=2) + if (indent) { - indents[i*2] = ' '; - indents[i*2+1] = '-'; + indent_text[0] = ' '; + memset(indent_text + 1, '-', indent); + indent_text[indent + 1] = 0; } - indents[i*2] = 0; - if ((command->mode == COMMAND_EXEC) || (command->mode == COMMAND_ANY)) - { - if (command->help) - help = command->help; + if (command->help) + help = command->help; - snprintf(name_buf, 64, command->name); - strncat(name_buf, indents, 64); - command_print(context, "%20s\t%s", name_buf, help); - } + snprintf(name_buf, 64, command->name); + + if (indent) + strncat(name_buf, indent_text, 64); + + command_print(context, "%20s\t%s", name_buf, help, indent); if (command->children) { @@ -441,22 +522,29 @@ void command_print_help_line(command_context_t* context, struct command_s *comma command_print_help_line(context, c, indent + 1); } } + free(indent_text); } -int command_print_help(command_context_t* context, char* name, char** args, int argc) +int command_print_help_match(command_context_t* context, command_t* c_first, char* name, char** args, int argc) { - command_t *c; + command_t * c; - for (c = context->commands; c; c = c->next) + for (c = c_first; c; c = c->next) { - if (argc == 1) + if (argc > 0) { - if (strncasecmp(c->name, args[0], c->unique_len)) - continue; + if (strncasecmp(c->name, args[0], c->unique_len)) + continue; - if (strncasecmp(c->name, args[0], strlen(args[0]))) - continue; - } + if (strncasecmp(c->name, args[0], strlen(args[0]))) + continue; + + if (argc > 1) + { + command_print_help_match(context, c->children, name, args + 1, argc - 1); + continue; + } + } command_print_help_line(context, c, 0); } @@ -464,7 +552,12 @@ int command_print_help(command_context_t* context, char* name, char** args, int return ERROR_OK; } -void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv) +int command_print_help(command_context_t* context, char* name, char** args, int argc) +{ + return command_print_help_match(context, context->commands, name, args, argc); +} + +void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv) { context->output_handler = output_handler; context->output_handler_priv = priv; @@ -482,6 +575,7 @@ command_context_t* copy_command_context(command_context_t* context) int command_done(command_context_t *context) { free(context); + context = NULL; return ERROR_OK; } @@ -493,7 +587,6 @@ command_context_t* command_init() context->mode = COMMAND_EXEC; context->commands = NULL; context->current_target = 0; - context->echo = 0; context->output_handler = NULL; context->output_handler_priv = NULL; @@ -503,6 +596,12 @@ command_context_t* command_init() register_command(context, NULL, "sleep", handle_sleep_command, COMMAND_ANY, "sleep for milliseconds"); + register_command(context, NULL, "time", handle_time_command, + COMMAND_ANY, "time - execute and print time it took"); + + register_command(context, NULL, "fast", handle_fast_command, + COMMAND_ANY, "fast - place at beginning of config files. Sets defaults to fast and dangerous."); + return context; } @@ -521,3 +620,43 @@ int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **ar return ERROR_OK; } + +int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +{ + if (argc!=1) + return ERROR_COMMAND_SYNTAX_ERROR; + + fast_and_dangerous = strcmp("enable", args[0])==0; + + return ERROR_OK; +} + + +int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +{ + duration_t duration; + char *duration_text; + int retval; + float t; + + if (argc<1) + return ERROR_COMMAND_SYNTAX_ERROR; + + duration_start_measure(&duration); + + retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc); + if (retval == ERROR_COMMAND_NOTFOUND) + { + command_print(cmd_ctx, "Command %s not found", args[0]); + } + + duration_stop_measure(&duration, &duration_text); + + t=duration.duration.tv_sec; + t+=((float)duration.duration.tv_usec / 1000000.0); + command_print(cmd_ctx, "%s took %fs", args[0], t); + + free(duration_text); + + return retval; +}