git.sur5r.net Git - openocd/blob - src/helper/command.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   part of this file is taken from libcli (libcli.sourceforge.net)       *
   6  *   Copyright (C) David Parrish (david@dparrish.com)                      *
   7  *                                                                         *
   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.                                   *
  12  *                                                                         *
  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.                          *
  17  *                                                                         *
  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  ***************************************************************************/
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include "replacements.h"
  28
  29 #include "command.h"
  30
  31 #include "log.h"
  32 #include "time_support.h"
  33
  34 #include <stdlib.h>
  35 #include <string.h>
  36 #include <ctype.h>
  37 #include <stdarg.h>
  38 #include <stdio.h>
  39 #include <unistd.h>
  40
  41 int fast_and_dangerous = 0;
  42
  43 void command_print_help_line(command_context_t* context, struct command_s *command, int indent);
  44
  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);
  48
  49 int build_unique_lengths(command_context_t *context, command_t *commands)
  50 {
  51         command_t *c, *p;
  52
  53         /* iterate through all commands */
  54         for (c = commands; c; c = c->next)
  55         {
  56                 /* find out how many characters are required to uniquely identify a command */
  57                 for (c->unique_len = 1; c->unique_len <= strlen(c->name); c->unique_len++)
  58                 {
  59                         int foundmatch = 0;
  60
  61                         /* for every command, see if the current length is enough */
  62                         for (p = commands; p; p = p->next)
  63                         {
  64                                 /* ignore the command itself */
  65                                 if (c == p)
  66                                         continue;
  67
  68                                 /* compare commands up to the current length */
  69                                 if (strncmp(p->name, c->name, c->unique_len) == 0)
  70                                         foundmatch++;
  71                         }
  72
  73                         /* when none of the commands matched, we've found the minimum length required */
  74                         if (!foundmatch)
  75                                 break;
  76                 }
  77
  78                 /* if the current command has children, build the unique lengths for them */
  79                 if (c->children)
  80                         build_unique_lengths(context, c->children);
  81         }
  82
  83         return ERROR_OK;
  84 }
  85
  86 /* Avoid evaluating this each time we add a command. Reduces overhead from O(n^2) to O(n).
  87  * Makes a difference on ARM7 types machines and is not observable on GHz machines.
  88  */
  89 static int unique_length_dirty = 1;
  90
  91 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)
  92 {
  93         command_t *c, *p;
  94         unique_length_dirty = 1;
  95
  96         if (!context || !name)
  97                 return NULL;
  98
  99         c = malloc(sizeof(command_t));
 100
 101         c->name = strdup(name);
 102         c->parent = parent;
 103         c->children = NULL;
 104         c->handler = handler;
 105         c->mode = mode;
 106         if (help)
 107                 c->help = strdup(help);
 108         else
 109                 c->help = NULL;
 110         c->unique_len = 0;
 111         c->next = NULL;
 112
 113         /* place command in tree */
 114         if (parent)
 115         {
 116                 if (parent->children)
 117                 {
 118                         /* find last child */
 119                         for (p = parent->children; p && p->next; p = p->next);
 120                         if (p)
 121                                 p->next = c;
 122                 }
 123                 else
 124                 {
 125                         parent->children = c;
 126                 }
 127         }
 128         else
 129         {
 130                 if (context->commands)
 131                 {
 132                         /* find last command */
 133                         for (p = context->commands; p && p->next; p = p->next);
 134                         if (p)
 135                                 p->next = c;
 136                 }
 137                 else
 138                 {
 139                         context->commands = c;
 140                 }
 141         }
 142
 143         return c;
 144 }
 145
 146 int unregister_all_commands(command_context_t *context)
 147 {
 148         command_t *c, *c2;
 149
 150         unique_length_dirty = 1;
 151
 152         if (context == NULL)
 153                 return ERROR_OK;
 154
 155
 156         while(NULL != context->commands)
 157         {
 158                 c = context->commands;
 159
 160                 while(NULL != c->children)
 161                 {
 162                         c2 = c->children;
 163                         c->children = c->children->next;
 164                         free(c2->name);
 165                         c2->name = NULL;
 166                         free(c2->help);
 167                         c2->help = NULL;
 168                         free(c2);
 169                         c2 = NULL;
 170                 }
 171
 172                 context->commands = context->commands->next;
 173
 174                 free(c->name);
 175                 c->name = NULL;
 176                 free(c->help);
 177                 c->help = NULL;
 178                 free(c);
 179                 c = NULL;
 180         }
 181
 182         return ERROR_OK;
 183 }
 184
 185 int unregister_command(command_context_t *context, char *name)
 186 {
 187         command_t *c, *p = NULL, *c2;
 188
 189         unique_length_dirty = 1;
 190
 191         if ((!context) || (!name))
 192                 return ERROR_INVALID_ARGUMENTS;
 193
 194         /* find command */
 195         for (c = context->commands; c; c = c->next)
 196         {
 197                 if (strcmp(name, c->name) == 0)
 198                 {
 199                         /* unlink command */
 200                         if (p)
 201                         {
 202                                 p->next = c->next;
 203                         }
 204                         else
 205                         {
 206                                 context->commands = c->next;
 207                         }
 208
 209                         /* unregister children */
 210                         if (c->children)
 211                         {
 212                                 for (c2 = c->children; c2; c2 = c2->next)
 213                                 {
 214                                         free(c2->name);
 215                                         if (c2->help)
 216                                                 free(c2->help);
 217                                         free(c2);
 218                                 }
 219                         }
 220
 221                         /* delete command */
 222                         free(c->name);
 223                         if (c->help)
 224                                 free(c->help);
 225                         free(c);
 226                 }
 227
 228                 /* remember the last command for unlinking */
 229                 p = c;
 230         }
 231
 232         return ERROR_OK;
 233 }
 234
 235 int parse_line(char *line, char *words[], int max_words)
 236 {
 237         int nwords = 0;
 238         char *p = line;
 239         char *word_start = line;
 240         int inquote = 0;
 241
 242         while (nwords < max_words - 1)
 243         {
 244                 /* check if we reached
 245                  * a terminating NUL
 246                  * a matching closing quote character " or '
 247                  * we're inside a word but not a quote, and the current character is whitespace
 248                  */
 249                 if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
 250                 {
 251                         /* we're inside a word or quote, and reached its end*/
 252                         if (word_start)
 253                         {
 254                                 int len;
 255                                 char *word_end=p;
 256
 257                                 /* This will handle extra whitespace within quotes */
 258                                 while (isspace(*word_start)&&(word_start<word_end))
 259                                         word_start++;
 260                                 while (isspace(*(word_end-1))&&(word_start<word_end))
 261                                         word_end--;
 262                                 len = word_end - word_start;
 263
 264                                 if (len>0)
 265                                 {
 266                                         /* copy the word */
 267                                         memcpy(words[nwords] = malloc(len + 1), word_start, len);
 268                                         /* add terminating NUL */
 269                                         words[nwords++][len] = 0;
 270                                 }
 271                         }
 272                         /* we're done parsing the line */
 273                         if (!*p)
 274                                 break;
 275
 276                         /* skip over trailing quote or whitespace*/
 277                         if (inquote || isspace(*p))
 278                                 p++;
 279                         while (isspace(*p))
 280                                 p++;
 281
 282                         inquote = 0;
 283                         word_start = 0;
 284                 }
 285                 else if (*p == '"' || *p == '\'')
 286                 {
 287                         /* we've reached the beginning of a quote */
 288                         inquote = *p++;
 289                         word_start = p;
 290                 }
 291                 else
 292                 {
 293                         /* we've reached the beginning of a new word */
 294                         if (!word_start)
 295                                 word_start = p;
 296
 297                         /* normal character, skip */
 298                         p++;
 299                 }
 300         }
 301
 302         return nwords;
 303 }
 304
 305 void command_print_n(command_context_t *context, char *format, ...)
 306 {
 307         char *string;
 308
 309         va_list ap;
 310         va_start(ap, format);
 311
 312         string = alloc_vprintf(format, ap);
 313         if (string != NULL)
 314         {
 315                 context->output_handler(context, string);
 316                 free(string);
 317         }
 318
 319         va_end(ap);
 320 }
 321
 322 void command_print(command_context_t *context, char *format, ...)
 323 {
 324         char *string;
 325
 326         va_list ap;
 327         va_start(ap, format);
 328
 329         string = alloc_vprintf(format, ap);
 330         if (string != NULL)
 331         {
 332                 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
 333                 context->output_handler(context, string);
 334                 free(string);
 335         }
 336
 337         va_end(ap);
 338 }
 339
 340 int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word)
 341 {
 342         command_t *c;
 343         int retval = ERROR_COMMAND_SYNTAX_ERROR;
 344
 345         if (unique_length_dirty)
 346         {
 347                 unique_length_dirty = 0;
 348                 /* update unique lengths */
 349                 build_unique_lengths(context, context->commands);
 350         }
 351
 352         for (c = commands; c; c = c->next)
 353         {
 354                 if (strncasecmp(c->name, words[start_word], c->unique_len))
 355                         continue;
 356
 357                 if (strncasecmp(c->name, words[start_word], strlen(words[start_word])))
 358                         continue;
 359
 360                 if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )
 361                 {
 362                         if (!c->children)
 363                         {
 364                                 if (!c->handler)
 365                                 {
 366                                         command_print(context, "No handler for command");
 367                                         retval = ERROR_COMMAND_SYNTAX_ERROR;
 368                                         break;
 369                                 }
 370                                 else
 371                                 {
 372                                         int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
 373                                         if (retval == ERROR_COMMAND_SYNTAX_ERROR)
 374                                         {
 375                                                 command_print(context, "Syntax error:");
 376                                                 command_print_help_line(context, c, 0);
 377                                         } else if (retval != ERROR_OK)
 378                                         {
 379                                                 /* we do not print out an error message because the command *should*
 380                                                  * have printed out an error
 381                                                  */
 382                                                 LOG_DEBUG("Command failed with error code %d", retval);
 383                                         }
 384                                         return retval;
 385                                 }
 386                         }
 387                         else
 388                         {
 389                                 if (start_word == num_words - 1)
 390                                 {
 391                                         command_print(context, "Incomplete command");
 392                                         break;
 393                                 }
 394                                 return find_and_run_command(context, c->children, words, num_words, start_word + 1);
 395                         }
 396                 }
 397         }
 398
 399         command_print(context, "Command %s not found", words[start_word]);
 400         return retval;
 401 }
 402
 403 int command_run_line(command_context_t *context, char *line)
 404 {
 405         int nwords;
 406         char *words[128] = {0};
 407         int retval;
 408         int i;
 409
 410         if ((!context) || (!line))
 411                 return ERROR_INVALID_ARGUMENTS;
 412
 413         /* skip preceding whitespace */
 414         while (isspace(*line))
 415                 line++;
 416
 417         /* empty line, ignore */
 418         if (!*line)
 419                 return ERROR_OK;
 420
 421         /* ignore comments */
 422         if (*line && (line[0] == '#'))
 423                 return ERROR_OK;
 424
 425         LOG_DEBUG("%s", line);
 426
 427         nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
 428
 429         if (nwords > 0)
 430                 retval = find_and_run_command(context, context->commands, words, nwords, 0);
 431         else
 432                 return ERROR_INVALID_ARGUMENTS;
 433
 434         for (i = 0; i < nwords; i++)
 435                 free(words[i]);
 436
 437         return retval;
 438 }
 439
 440 int command_run_file(command_context_t *context, FILE *file, enum command_mode mode)
 441 {
 442         int retval = ERROR_OK;
 443         int old_command_mode;
 444         char *buffer=malloc(4096);
 445         if (buffer==NULL)
 446         {
 447                 return ERROR_INVALID_ARGUMENTS;
 448         }
 449
 450         old_command_mode = context->mode;
 451         context->mode = mode;
 452
 453         while (fgets(buffer, 4096, file))
 454         {
 455                 char *p;
 456                 char *cmd, *end;
 457
 458                 /* stop processing line after a comment (#, !) or a LF, CR were encountered */
 459                 if ((p = strpbrk(buffer, "#!\r\n")))
 460                         *p = 0;
 461
 462                 /* skip over leading whitespace */
 463                 cmd = buffer;
 464                 while (isspace(*cmd))
 465                         cmd++;
 466
 467                 /* empty (all whitespace) line? */
 468                 if (!*cmd)
 469                         continue;
 470
 471                 /* search the end of the current line, ignore trailing whitespace */
 472                 for (p = end = cmd; *p; p++)
 473                         if (!isspace(*p))
 474                                 end = p;
 475
 476                 /* terminate end */
 477                 *++end = 0;
 478                 if (strcasecmp(cmd, "quit") == 0)
 479                         break;
 480
 481                 /* run line */
 482                 if ((retval = command_run_line(context, cmd)) == ERROR_COMMAND_CLOSE_CONNECTION)
 483                         break;
 484         }
 485
 486         context->mode = old_command_mode;
 487
 488
 489         free(buffer);
 490
 491         return retval;
 492 }
 493
 494 void command_print_help_line(command_context_t* context, struct command_s *command, int indent)
 495 {
 496         command_t *c;
 497         char *indent_text=malloc(indent + 2);
 498
 499         char *help = "no help available";
 500         char name_buf[64];
 501
 502         if (indent)
 503         {
 504             indent_text[0] = ' ';
 505             memset(indent_text + 1, '-', indent);
 506             indent_text[indent + 1] = 0;
 507         }
 508
 509         if (command->help)
 510                 help = command->help;
 511
 512         snprintf(name_buf, 64, command->name);
 513
 514         if (indent)
 515             strncat(name_buf, indent_text, 64);
 516
 517         command_print(context, "%20s\t%s", name_buf, help, indent);
 518
 519         if (command->children)
 520         {
 521                 for (c = command->children; c; c = c->next)
 522                 {
 523                         command_print_help_line(context, c, indent + 1);
 524                 }
 525         }
 526         free(indent_text);
 527 }
 528
 529 int command_print_help_match(command_context_t* context, command_t* c_first, char* name, char** args, int argc)
 530 {
 531         command_t * c;
 532
 533         for (c = c_first; c; c = c->next)
 534         {
 535                 if (argc > 0)
 536                 {
 537                         if (strncasecmp(c->name, args[0], c->unique_len))
 538                                 continue;
 539
 540                         if (strncasecmp(c->name, args[0], strlen(args[0])))
 541                                 continue;
 542
 543                         if (argc > 1)
 544                         {
 545                                 command_print_help_match(context, c->children, name, args + 1, argc - 1);
 546                                 continue;
 547                         }
 548                 }
 549
 550                 command_print_help_line(context, c, 0);
 551         }
 552
 553         return ERROR_OK;
 554 }
 555
 556 int command_print_help(command_context_t* context, char* name, char** args, int argc)
 557 {
 558     return command_print_help_match(context, context->commands, name, args, argc);
 559 }
 560
 561
 562 void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv)
 563 {
 564         context->output_handler = output_handler;
 565         context->output_handler_priv = priv;
 566 }
 567
 568 command_context_t* copy_command_context(command_context_t* context)
 569 {
 570         command_context_t* copy_context = malloc(sizeof(command_context_t));
 571
 572         *copy_context = *context;
 573
 574         return copy_context;
 575 }
 576
 577 int command_done(command_context_t *context)
 578 {
 579         free(context);
 580         context = NULL;
 581
 582         return ERROR_OK;
 583 }
 584
 585 command_context_t* command_init()
 586 {
 587         command_context_t* context = malloc(sizeof(command_context_t));
 588
 589         context->mode = COMMAND_EXEC;
 590         context->commands = NULL;
 591         context->current_target = 0;
 592         context->output_handler = NULL;
 593         context->output_handler_priv = NULL;
 594
 595         register_command(context, NULL, "help", command_print_help,
 596                                          COMMAND_EXEC, "display this help");
 597
 598         register_command(context, NULL, "sleep", handle_sleep_command,
 599                                          COMMAND_ANY, "sleep for <n> milliseconds");
 600
 601         register_command(context, NULL, "time", handle_time_command,
 602                                          COMMAND_ANY, "time <cmd + args> - execute <cmd + args> and print time it took");
 603
 604         register_command(context, NULL, "fast", handle_fast_command,
 605                                          COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
 606
 607         return context;
 608 }
 609
 610 /* sleep command sleeps for <n> miliseconds
 611  * this is useful in target startup scripts
 612  */
 613 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 614 {
 615         unsigned long duration = 0;
 616
 617         if (argc == 1)
 618         {
 619                 duration = strtoul(args[0], NULL, 0);
 620                 usleep(duration * 1000);
 621         }
 622
 623         return ERROR_OK;
 624 }
 625
 626 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 627 {
 628         if (argc!=1)
 629                 return ERROR_COMMAND_SYNTAX_ERROR;
 630
 631         fast_and_dangerous = strcmp("enable", args[0])==0;
 632
 633         return ERROR_OK;
 634 }
 635
 636
 637 int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 638 {
 639         duration_t duration;
 640         char *duration_text;
 641         int retval;
 642         float t;
 643
 644         if (argc<1)
 645                 return ERROR_COMMAND_SYNTAX_ERROR;
 646
 647         duration_start_measure(&duration);
 648
 649         retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc, 0);
 650
 651         duration_stop_measure(&duration, &duration_text);
 652
 653         t=duration.duration.tv_sec;
 654         t+=((float)duration.duration.tv_usec / 1000000.0);
 655         command_print(cmd_ctx, "%s took %fs", args[0], t);
 656
 657         free(duration_text);
 658
 659         return retval;
 660 }