1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * part of this file is taken from libcli (libcli.sourceforge.net) *
6 * Copyright (C) David Parrish (david@dparrish.com) *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
27 #include "replacements.h"
32 #include "time_support.h"
41 int fast_and_dangerous = 0;
43 void command_print_help_line(command_context_t* context, struct command_s *command, int indent);
45 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
46 int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
47 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
49 /* forward declaration of jim_command */
50 extern int jim_command(command_context_t *context, char *line);
52 int build_unique_lengths(command_context_t *context, command_t *commands)
56 /* iterate through all commands */
57 for (c = commands; c; c = c->next)
59 /* find out how many characters are required to uniquely identify a command */
60 for (c->unique_len = 1; c->unique_len <= strlen(c->name); c->unique_len++)
64 /* for every command, see if the current length is enough */
65 for (p = commands; p; p = p->next)
67 /* ignore the command itself */
71 /* compare commands up to the current length */
72 if (strncmp(p->name, c->name, c->unique_len) == 0)
76 /* when none of the commands matched, we've found the minimum length required */
81 /* if the current command has children, build the unique lengths for them */
83 build_unique_lengths(context, c->children);
89 /* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n).
90 * Makes a difference on ARM7 types machines and is not observable on GHz machines.
92 static int unique_length_dirty = 1;
94 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)
97 unique_length_dirty = 1;
99 if (!context || !name)
102 c = malloc(sizeof(command_t));
104 c->name = strdup(name);
107 c->handler = handler;
110 c->help = strdup(help);
116 /* place command in tree */
119 if (parent->children)
121 /* find last child */
122 for (p = parent->children; p && p->next; p = p->next);
128 parent->children = c;
133 if (context->commands)
135 /* find last command */
136 for (p = context->commands; p && p->next; p = p->next);
142 context->commands = c;
149 int unregister_all_commands(command_context_t *context)
153 unique_length_dirty = 1;
159 while(NULL != context->commands)
161 c = context->commands;
163 while(NULL != c->children)
166 c->children = c->children->next;
175 context->commands = context->commands->next;
188 int unregister_command(command_context_t *context, char *name)
190 command_t *c, *p = NULL, *c2;
192 unique_length_dirty = 1;
194 if ((!context) || (!name))
195 return ERROR_INVALID_ARGUMENTS;
198 for (c = context->commands; c; c = c->next)
200 if (strcmp(name, c->name) == 0)
209 context->commands = c->next;
212 /* unregister children */
215 for (c2 = c->children; c2; c2 = c2->next)
231 /* remember the last command for unlinking */
238 int parse_line(char *line, char *words[], int max_words)
242 char *word_start = line;
245 while (nwords < max_words - 1)
247 /* check if we reached
249 * a matching closing quote character " or '
250 * we're inside a word but not a quote, and the current character is whitespace
252 if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
254 /* we're inside a word or quote, and reached its end*/
260 /* This will handle extra whitespace within quotes */
261 while (isspace(*word_start)&&(word_start<word_end))
263 while (isspace(*(word_end-1))&&(word_start<word_end))
265 len = word_end - word_start;
270 memcpy(words[nwords] = malloc(len + 1), word_start, len);
271 /* add terminating NUL */
272 words[nwords++][len] = 0;
275 /* we're done parsing the line */
279 /* skip over trailing quote or whitespace*/
280 if (inquote || isspace(*p))
288 else if (*p == '"' || *p == '\'')
290 /* we've reached the beginning of a quote */
296 /* we've reached the beginning of a new word */
300 /* normal character, skip */
308 void command_output_text( command_context_t *context, const char *data )
310 if( context && context->output_handler && data ){
311 context->output_handler( context, data );
316 void command_print_n(command_context_t *context, char *format, ...)
321 va_start(ap, format);
323 string = alloc_vprintf(format, ap);
326 context->output_handler(context, string);
333 void command_print(command_context_t *context, char *format, ...)
338 va_start(ap, format);
340 string = alloc_vprintf(format, ap);
343 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
344 context->output_handler(context, string);
351 command_t *find_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word, int *new_start_word)
355 if (unique_length_dirty)
357 unique_length_dirty = 0;
358 /* update unique lengths */
359 build_unique_lengths(context, context->commands);
362 for (c = commands; c; c = c->next)
364 if (strncasecmp(c->name, words[start_word], c->unique_len))
367 if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))
370 if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )
380 *new_start_word=start_word;
386 if (start_word == num_words - 1)
390 return find_command(context, c->children, words, num_words, start_word + 1, new_start_word);
397 int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words)
401 c=find_command(context, commands, words, num_words, start_word, &start_word);
404 command_print(context, "Command %s not found", words[start_word]);
405 return ERROR_COMMAND_SYNTAX_ERROR;
408 int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
409 if (retval == ERROR_COMMAND_SYNTAX_ERROR)
411 command_print(context, "Syntax error:");
412 command_print_help_line(context, c, 0);
414 else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
416 /* just fall through for a shutdown request */
418 else if (retval != ERROR_OK)
420 /* we do not print out an error message because the command *should*
421 * have printed out an error
423 LOG_DEBUG("Command failed with error code %d", retval);
428 int command_run_line_internal_op(command_context_t *context, char *line, int run)
430 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
433 char *words[128] = {0};
437 /* skip preceding whitespace */
438 while (isspace(*line))
441 /* empty line, ignore */
445 /* ignore comments */
446 if (*line && (line[0] == '#'))
449 LOG_DEBUG("%s", line);
451 nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
456 retval = find_and_run_command(context, context->commands, words, nwords);
460 return (find_command(context, context->commands, words, nwords, 0, &t)!=NULL)?ERROR_OK:ERROR_FAIL;
463 return ERROR_INVALID_ARGUMENTS;
465 for (i = 0; i < nwords; i++)
471 int command_run_line_internal(command_context_t *context, char *line)
473 return command_run_line_internal_op(context, line, 1);
476 int command_run_line(command_context_t *context, char *line)
478 if ((!context) || (!line))
479 return ERROR_INVALID_ARGUMENTS;
481 if (command_run_line_internal_op(context, line, 0)!=ERROR_OK)
483 /* If we can't find a command, then try the interpreter.
484 * If there is no interpreter implemented, then this will
485 * simply print a syntax error.
487 * These hooks were left in to reduce patch size for
488 * wip to add scripting language.
490 return jim_command(context, line);
493 return command_run_line_internal(context, line);
496 int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
498 int retval = ERROR_OK;
499 int old_command_mode;
500 char *buffer=malloc(4096);
503 return ERROR_INVALID_ARGUMENTS;
506 old_command_mode = context->mode;
507 context->mode = mode;
509 while (fgets(buffer, 4096, file))
514 /* stop processing line after a comment (#, !) or a LF, CR were encountered */
515 if ((p = strpbrk(buffer, "#!\r\n")))
518 /* skip over leading whitespace */
520 while (isspace(*cmd))
523 /* empty (all whitespace) line? */
527 /* search the end of the current line, ignore trailing whitespace */
528 for (p = end = cmd; *p; p++)
534 if (strcasecmp(cmd, "quit") == 0)
538 if ((retval = command_run_line(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION)
542 context->mode = old_command_mode;
550 int command_run_linef(command_context_t *context, char *format, ...)
552 int retval=ERROR_FAIL;
555 va_start(ap, format);
556 string = alloc_vprintf(format, ap);
559 retval=command_run_line(context, string);
565 void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
568 char *indent_text=malloc(indent + 2);
570 char *help = "no help available";
575 indent_text[0] = ' ';
576 memset(indent_text + 1, '-', indent);
577 indent_text[indent + 1] = 0;
581 help = command->help;
583 snprintf(name_buf, 64, command->name);
586 strncat(name_buf, indent_text, 64);
588 command_print(context, "%20s\t%s", name_buf, help, indent);
590 if (command->children)
592 for (c = command->children; c; c = c->next)
594 command_print_help_line(context, c, indent + 1);
600 int command_print_help_match(command_context_t* context, command_t* c_first, char* name, char** args, int argc)
604 for (c = c_first; c; c = c->next)
608 if (strncasecmp(c->name, args[0], c->unique_len))
611 if (strncasecmp(c->name, args[0], strlen(args[0])))
616 command_print_help_match(context, c->children, name, args + 1, argc - 1);
621 command_print_help_line(context, c, 0);
627 int command_print_help(command_context_t* context, char* name, char** args, int argc)
629 return command_print_help_match(context, context->commands, name, args, argc);
632 void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv)
634 context->output_handler = output_handler;
635 context->output_handler_priv = priv;
638 command_context_t* copy_command_context(command_context_t* context)
640 command_context_t* copy_context = malloc(sizeof(command_context_t));
642 *copy_context = *context;
647 int command_done(command_context_t *context)
655 command_context_t* command_init()
657 command_context_t* context = malloc(sizeof(command_context_t));
659 context->mode = COMMAND_EXEC;
660 context->commands = NULL;
661 context->current_target = 0;
662 context->output_handler = NULL;
663 context->output_handler_priv = NULL;
665 register_command(context, NULL, "help", command_print_help,
666 COMMAND_EXEC, "display this help");
668 register_command(context, NULL, "sleep", handle_sleep_command,
669 COMMAND_ANY, "sleep for <n> milliseconds");
671 register_command(context, NULL, "time", handle_time_command,
672 COMMAND_ANY, "time <cmd + args> - execute <cmd + args> and print time it took");
674 register_command(context, NULL, "fast", handle_fast_command,
675 COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
680 /* sleep command sleeps for <n> miliseconds
681 * this is useful in target startup scripts
683 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
685 unsigned long duration = 0;
689 duration = strtoul(args[0], NULL, 0);
690 usleep(duration * 1000);
696 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
699 return ERROR_COMMAND_SYNTAX_ERROR;
701 fast_and_dangerous = strcmp("enable", args[0])==0;
707 int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
715 return ERROR_COMMAND_SYNTAX_ERROR;
717 duration_start_measure(&duration);
719 retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc);
721 duration_stop_measure(&duration, &duration_text);
723 t=duration.duration.tv_sec;
724 t+=((float)duration.duration.tv_usec / 1000000.0);
725 command_print(cmd_ctx, "%s took %fs", args[0], t);
732 * Local Variables: **
734 * c-basic-offset: 4 **