git.gag.com Git - fw/openocd/blob - src/helper/command.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008, Duane Ellis                                       *
   9  *   openocd@duaneeellis.com                                               *
  10  *                                                                         *
  11  *   part of this file is taken from libcli (libcli.sourceforge.net)       *
  12  *   Copyright (C) David Parrish (david@dparrish.com)                      *
  13  *                                                                         *
  14  *   This program is free software; you can redistribute it and/or modify  *
  15  *   it under the terms of the GNU General Public License as published by  *
  16  *   the Free Software Foundation; either version 2 of the License, or     *
  17  *   (at your option) any later version.                                   *
  18  *                                                                         *
  19  *   This program is distributed in the hope that it will be useful,       *
  20  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  21  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  22  *   GNU General Public License for more details.                          *
  23  *                                                                         *
  24  *   You should have received a copy of the GNU General Public License     *
  25  *   along with this program; if not, write to the                         *
  26  *   Free Software Foundation, Inc.,                                       *
  27  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  28  ***************************************************************************/
  29 #ifdef HAVE_CONFIG_H
  30 #include "config.h"
  31 #endif
  32
  33 #if !BUILD_ECOSBOARD
  34 /* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
  35 #define JIM_EMBEDDED
  36 #endif
  37
  38 // @todo the inclusion of target.h here is a layering violation
  39 #include "target.h"
  40 #include "command.h"
  41 #include "configuration.h"
  42 #include "log.h"
  43 #include "time_support.h"
  44 #include "jim-eventloop.h"
  45
  46
  47 Jim_Interp *interp = NULL;
  48
  49 static int run_command(struct command_context *context,
  50                 struct command *c, const char *words[], unsigned num_words);
  51
  52 static void tcl_output(void *privData, const char *file, unsigned line,
  53                 const char *function, const char *string)
  54 {
  55         Jim_Obj *tclOutput = (Jim_Obj *)privData;
  56         Jim_AppendString(interp, tclOutput, string, strlen(string));
  57 }
  58
  59 extern struct command_context *global_cmd_ctx;
  60
  61 void script_debug(Jim_Interp *interp, const char *name,
  62                 unsigned argc, Jim_Obj *const *argv)
  63 {
  64         LOG_DEBUG("command - %s", name);
  65         for (unsigned i = 0; i < argc; i++)
  66         {
  67                 int len;
  68                 const char *w = Jim_GetString(argv[i], &len);
  69
  70                 /* end of line comment? */
  71                 if (*w == '#')
  72                         break;
  73
  74                 LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
  75         }
  76 }
  77
  78 static void script_command_args_free(const char **words, unsigned nwords)
  79 {
  80         for (unsigned i = 0; i < nwords; i++)
  81                 free((void *)words[i]);
  82         free(words);
  83 }
  84 static const char **script_command_args_alloc(
  85                 unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
  86 {
  87         const char **words = malloc(argc * sizeof(char *));
  88         if (NULL == words)
  89                 return NULL;
  90
  91         unsigned i;
  92         for (i = 0; i < argc; i++)
  93         {
  94                 int len;
  95                 const char *w = Jim_GetString(argv[i], &len);
  96                 /* a comment may end the line early */
  97                 if (*w == '#')
  98                         break;
  99
 100                 words[i] = strdup(w);
 101                 if (words[i] == NULL)
 102                 {
 103                         script_command_args_free(words, i);
 104                         return NULL;
 105                 }
 106         }
 107         *nwords = i;
 108         return words;
 109 }
 110
 111 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 112 {
 113         /* the private data is stashed in the interp structure */
 114         struct command *c;
 115         struct command_context *context;
 116         int retval;
 117
 118         /* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
 119          * get overwritten by running other Jim commands! Treat it as an
 120          * emphemeral global variable that is used in lieu of an argument
 121          * to the fn and fish it out manually.
 122          */
 123         c = interp->cmdPrivData;
 124         if (c == NULL)
 125         {
 126                 LOG_ERROR("BUG: interp->cmdPrivData == NULL");
 127                 return JIM_ERR;
 128         }
 129         target_call_timer_callbacks_now();
 130         LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
 131
 132         script_debug(interp, c->name, argc, argv);
 133
 134         unsigned nwords;
 135         const char **words = script_command_args_alloc(argc, argv, &nwords);
 136         if (NULL == words)
 137                 return JIM_ERR;
 138
 139         /* grab the command context from the associated data */
 140         context = Jim_GetAssocData(interp, "context");
 141         if (context == NULL)
 142         {
 143                 /* Tcl can invoke commands directly instead of via command_run_line(). This would
 144                  * happen when the Jim Tcl interpreter is provided by eCos.
 145                  */
 146                 context = global_cmd_ctx;
 147         }
 148
 149         /* capture log output and return it */
 150         Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
 151         /* a garbage collect can happen, so we need a reference count to this object */
 152         Jim_IncrRefCount(tclOutput);
 153
 154         log_add_callback(tcl_output, tclOutput);
 155
 156         retval = run_command(context, c, (const char **)words, nwords);
 157
 158         log_remove_callback(tcl_output, tclOutput);
 159
 160         /* We dump output into this local variable */
 161         Jim_SetResult(interp, tclOutput);
 162         Jim_DecrRefCount(interp, tclOutput);
 163
 164         script_command_args_free(words, nwords);
 165
 166         int *return_retval = Jim_GetAssocData(interp, "retval");
 167         if (return_retval != NULL)
 168         {
 169                 *return_retval = retval;
 170         }
 171
 172         return (retval == ERROR_OK)?JIM_OK:JIM_ERR;
 173 }
 174
 175 /* nice short description of source file */
 176 #define __THIS__FILE__ "command.c"
 177
 178 /**
 179  * Find a command by name from a list of commands.
 180  * @returns Returns the named command if it exists in the list.
 181  * Returns NULL otherwise.
 182  */
 183 static struct command *command_find(struct command *head, const char *name)
 184 {
 185         for (struct command *cc = head; cc; cc = cc->next)
 186         {
 187                 if (strcmp(cc->name, name) == 0)
 188                         return cc;
 189         }
 190         return NULL;
 191 }
 192
 193 /**
 194  * Add the command into the linked list, sorted by name.
 195  * @param head Address to head of command list pointer, which may be
 196  * updated if @c c gets inserted at the beginning of the list.
 197  * @param c The command to add to the list pointed to by @c head.
 198  */
 199 static void command_add_child(struct command **head, struct command *c)
 200 {
 201         assert(head);
 202         if (NULL == *head)
 203         {
 204                 *head = c;
 205                 return;
 206         }
 207
 208         while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
 209                 head = &(*head)->next;
 210
 211         if (strcmp(c->name, (*head)->name) > 0) {
 212                 c->next = (*head)->next;
 213                 (*head)->next = c;
 214         } else {
 215                 c->next = *head;
 216                 *head = c;
 217         }
 218 }
 219
 220 static struct command **command_list_for_parent(
 221                 struct command_context *cmd_ctx, struct command *parent)
 222 {
 223         return parent ? &parent->children : &cmd_ctx->commands;
 224 }
 225
 226 static struct command *command_new(struct command_context *cmd_ctx,
 227                 struct command *parent, const char *name,
 228                 command_handler_t handler, enum command_mode mode,
 229                 const char *help, const char *usage)
 230 {
 231         assert(name);
 232
 233         struct command *c = malloc(sizeof(struct command));
 234         memset(c, 0, sizeof(struct command));
 235
 236         c->name = strdup(name);
 237         if (help)
 238                 c->help = strdup(help);
 239         if (usage)
 240                 c->usage = strdup(usage);
 241         c->parent = parent;
 242         c->handler = handler;
 243         c->mode = mode;
 244
 245         command_add_child(command_list_for_parent(cmd_ctx, parent), c);
 246
 247         return c;
 248 }
 249 static void command_free(struct command *c)
 250 {
 251         /// @todo if command has a handler, unregister its jim command!
 252
 253         while (NULL != c->children)
 254         {
 255                 struct command *tmp = c->children;
 256                 c->children = tmp->next;
 257                 command_free(tmp);
 258         }
 259
 260         if (c->name)
 261                 free(c->name);
 262         if (c->help)
 263                 free((void*)c->help);
 264         if (c->usage)
 265                 free((void*)c->usage);
 266         free(c);
 267 }
 268
 269 struct command* register_command(struct command_context *context,
 270                 struct command *parent, const struct command_registration *cr)
 271 {
 272         if (!context || !cr->name)
 273                 return NULL;
 274
 275         const char *name = cr->name;
 276         struct command **head = command_list_for_parent(context, parent);
 277         struct command *c = command_find(*head, name);
 278         if (NULL != c)
 279         {
 280                 LOG_ERROR("command '%s' is already registered in '%s' context",
 281                                 name, parent ? parent->name : "<global>");
 282                 return c;
 283         }
 284
 285         c = command_new(context, parent, name, cr->handler, cr->mode, cr->help, cr->usage);
 286         /* if allocation failed or it is a placeholder (no handler), we're done */
 287         if (NULL == c || NULL == c->handler)
 288                 return c;
 289
 290         const char *full_name = command_name(c, '_');
 291
 292         const char *ocd_name = alloc_printf("ocd_%s", full_name);
 293         Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
 294         free((void *)ocd_name);
 295
 296         /* we now need to add an overrideable proc */
 297         const char *override_name = alloc_printf("proc %s {args} {"
 298                         "if {[catch {eval ocd_%s $args}] == 0} "
 299                         "{return \"\"} else {return -code error}}",
 300                         full_name, full_name);
 301         Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
 302         free((void *)override_name);
 303
 304         free((void *)full_name);
 305
 306         return c;
 307 }
 308
 309 int register_commands(struct command_context *cmd_ctx, struct command *parent,
 310                 const struct command_registration *cmds)
 311 {
 312         unsigned i;
 313         for (i = 0; cmds[i].name; i++)
 314         {
 315                 struct command *c = register_command(cmd_ctx, parent, cmds + i);
 316                 if (NULL != c)
 317                         continue;
 318
 319                 for (unsigned j = 0; j < i; j++)
 320                         unregister_command(cmd_ctx, parent, cmds[j].name);
 321                 return ERROR_FAIL;
 322         }
 323         return ERROR_OK;
 324 }
 325
 326 int unregister_all_commands(struct command_context *context,
 327                 struct command *parent)
 328 {
 329         if (context == NULL)
 330                 return ERROR_OK;
 331
 332         struct command **head = command_list_for_parent(context, parent);
 333         while (NULL != *head)
 334         {
 335                 struct command *tmp = *head;
 336                 *head = tmp->next;
 337                 command_free(tmp);
 338         }
 339
 340         return ERROR_OK;
 341 }
 342
 343 int unregister_command(struct command_context *context,
 344                 struct command *parent, const char *name)
 345 {
 346         if ((!context) || (!name))
 347                 return ERROR_INVALID_ARGUMENTS;
 348
 349         struct command *p = NULL;
 350         struct command **head = command_list_for_parent(context, parent);
 351         for (struct command *c = *head; NULL != c; p = c, c = c->next)
 352         {
 353                 if (strcmp(name, c->name) != 0)
 354                         continue;
 355
 356                 if (p)
 357                         p->next = c->next;
 358                 else
 359                         *head = c->next;
 360
 361                 command_free(c);
 362                 return ERROR_OK;
 363         }
 364
 365         return ERROR_OK;
 366 }
 367
 368 void command_output_text(struct command_context *context, const char *data)
 369 {
 370         if (context && context->output_handler && data) {
 371                 context->output_handler(context, data);
 372         }
 373 }
 374
 375 void command_print_sameline(struct command_context *context, const char *format, ...)
 376 {
 377         char *string;
 378
 379         va_list ap;
 380         va_start(ap, format);
 381
 382         string = alloc_vprintf(format, ap);
 383         if (string != NULL)
 384         {
 385                 /* we want this collected in the log + we also want to pick it up as a tcl return
 386                  * value.
 387                  *
 388                  * The latter bit isn't precisely neat, but will do for now.
 389                  */
 390                 LOG_USER_N("%s", string);
 391                 /* We already printed it above */
 392                 /* command_output_text(context, string); */
 393                 free(string);
 394         }
 395
 396         va_end(ap);
 397 }
 398
 399 void command_print(struct command_context *context, const char *format, ...)
 400 {
 401         char *string;
 402
 403         va_list ap;
 404         va_start(ap, format);
 405
 406         string = alloc_vprintf(format, ap);
 407         if (string != NULL)
 408         {
 409                 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
 410                 /* we want this collected in the log + we also want to pick it up as a tcl return
 411                  * value.
 412                  *
 413                  * The latter bit isn't precisely neat, but will do for now.
 414                  */
 415                 LOG_USER_N("%s", string);
 416                 /* We already printed it above */
 417                 /* command_output_text(context, string); */
 418                 free(string);
 419         }
 420
 421         va_end(ap);
 422 }
 423
 424 static char *__command_name(struct command *c, char delim, unsigned extra)
 425 {
 426         char *name;
 427         unsigned len = strlen(c->name);
 428         if (NULL == c->parent) {
 429                 // allocate enough for the name, child names, and '\0'
 430                 name = malloc(len + extra + 1);
 431                 strcpy(name, c->name);
 432         } else {
 433                 // parent's extra must include both the space and name
 434                 name = __command_name(c->parent, delim, 1 + len + extra);
 435                 char dstr[2] = { delim, 0 };
 436                 strcat(name, dstr);
 437                 strcat(name, c->name);
 438         }
 439         return name;
 440 }
 441 char *command_name(struct command *c, char delim)
 442 {
 443         return __command_name(c, delim, 0);
 444 }
 445
 446 static int run_command(struct command_context *context,
 447                 struct command *c, const char *words[], unsigned num_words)
 448 {
 449         if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
 450         {
 451                 /* Config commands can not run after the config stage */
 452                 LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
 453                 return ERROR_FAIL;
 454         }
 455
 456         struct command_invocation cmd = {
 457                         .ctx = context,
 458                         .name = c->name,
 459                         .argc = num_words - 1,
 460                         .argv = words + 1,
 461                 };
 462         int retval = c->handler(&cmd);
 463         if (retval == ERROR_COMMAND_SYNTAX_ERROR)
 464         {
 465                 /* Print help for command */
 466                 char *full_name = command_name(c, ' ');
 467                 if (NULL != full_name) {
 468                         command_run_linef(context, "help %s", full_name);
 469                         free(full_name);
 470                 } else
 471                         retval = -ENOMEM;
 472         }
 473         else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
 474         {
 475                 /* just fall through for a shutdown request */
 476         }
 477         else if (retval != ERROR_OK)
 478         {
 479                 /* we do not print out an error message because the command *should*
 480                  * have printed out an error
 481                  */
 482                 LOG_DEBUG("Command failed with error code %d", retval);
 483         }
 484
 485         return retval;
 486 }
 487
 488 int command_run_line(struct command_context *context, char *line)
 489 {
 490         /* all the parent commands have been registered with the interpreter
 491          * so, can just evaluate the line as a script and check for
 492          * results
 493          */
 494         /* run the line thru a script engine */
 495         int retval = ERROR_FAIL;
 496         int retcode;
 497         /* Beware! This code needs to be reentrant. It is also possible
 498          * for OpenOCD commands to be invoked directly from Tcl. This would
 499          * happen when the Jim Tcl interpreter is provided by eCos for
 500          * instance.
 501          */
 502         Jim_DeleteAssocData(interp, "context");
 503         retcode = Jim_SetAssocData(interp, "context", NULL, context);
 504         if (retcode == JIM_OK)
 505         {
 506                 /* associated the return value */
 507                 Jim_DeleteAssocData(interp, "retval");
 508                 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
 509                 if (retcode == JIM_OK)
 510                 {
 511                         retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
 512
 513                         Jim_DeleteAssocData(interp, "retval");
 514                 }
 515                 Jim_DeleteAssocData(interp, "context");
 516         }
 517         if (retcode == JIM_ERR) {
 518                 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
 519                 {
 520                         /* We do not print the connection closed error message */
 521                         Jim_PrintErrorMessage(interp);
 522                 }
 523                 if (retval == ERROR_OK)
 524                 {
 525                         /* It wasn't a low level OpenOCD command that failed */
 526                         return ERROR_FAIL;
 527                 }
 528                 return retval;
 529         } else if (retcode == JIM_EXIT) {
 530                 /* ignore. */
 531                 /* exit(Jim_GetExitCode(interp)); */
 532         } else {
 533                 const char *result;
 534                 int reslen;
 535
 536                 result = Jim_GetString(Jim_GetResult(interp), &reslen);
 537                 if (reslen > 0)
 538                 {
 539                         int i;
 540                         char buff[256 + 1];
 541                         for (i = 0; i < reslen; i += 256)
 542                         {
 543                                 int chunk;
 544                                 chunk = reslen - i;
 545                                 if (chunk > 256)
 546                                         chunk = 256;
 547                                 strncpy(buff, result + i, chunk);
 548                                 buff[chunk] = 0;
 549                                 LOG_USER_N("%s", buff);
 550                         }
 551                         LOG_USER_N("%s", "\n");
 552                 }
 553                 retval = ERROR_OK;
 554         }
 555         return retval;
 556 }
 557
 558 int command_run_linef(struct command_context *context, const char *format, ...)
 559 {
 560         int retval = ERROR_FAIL;
 561         char *string;
 562         va_list ap;
 563         va_start(ap, format);
 564         string = alloc_vprintf(format, ap);
 565         if (string != NULL)
 566         {
 567                 retval = command_run_line(context, string);
 568         }
 569         va_end(ap);
 570         return retval;
 571 }
 572
 573 void command_set_output_handler(struct command_context* context,
 574                 command_output_handler_t output_handler, void *priv)
 575 {
 576         context->output_handler = output_handler;
 577         context->output_handler_priv = priv;
 578 }
 579
 580 struct command_context* copy_command_context(struct command_context* context)
 581 {
 582         struct command_context* copy_context = malloc(sizeof(struct command_context));
 583
 584         *copy_context = *context;
 585
 586         return copy_context;
 587 }
 588
 589 int command_done(struct command_context *context)
 590 {
 591         free(context);
 592         context = NULL;
 593
 594         return ERROR_OK;
 595 }
 596
 597 /* find full path to file */
 598 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 599 {
 600         if (argc != 2)
 601                 return JIM_ERR;
 602         const char *file = Jim_GetString(argv[1], NULL);
 603         char *full_path = find_file(file);
 604         if (full_path == NULL)
 605                 return JIM_ERR;
 606         Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
 607         free(full_path);
 608
 609         Jim_SetResult(interp, result);
 610         return JIM_OK;
 611 }
 612
 613 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 614 {
 615         if (argc != 2)
 616                 return JIM_ERR;
 617         const char *str = Jim_GetString(argv[1], NULL);
 618         LOG_USER("%s", str);
 619         return JIM_OK;
 620 }
 621
 622 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
 623 {
 624         size_t nbytes;
 625         const char *ptr;
 626         Jim_Interp *interp;
 627
 628         /* make it a char easier to read code */
 629         ptr = _ptr;
 630         interp = cookie;
 631         nbytes = size * n;
 632         if (ptr == NULL || interp == NULL || nbytes == 0) {
 633                 return 0;
 634         }
 635
 636         /* do we have to chunk it? */
 637         if (ptr[nbytes] == 0)
 638         {
 639                 /* no it is a C style string */
 640                 LOG_USER_N("%s", ptr);
 641                 return strlen(ptr);
 642         }
 643         /* GRR we must chunk - not null terminated */
 644         while (nbytes) {
 645                 char chunk[128 + 1];
 646                 int x;
 647
 648                 x = nbytes;
 649                 if (x > 128) {
 650                         x = 128;
 651                 }
 652                 /* copy it */
 653                 memcpy(chunk, ptr, x);
 654                 /* terminate it */
 655                 chunk[n] = 0;
 656                 /* output it */
 657                 LOG_USER_N("%s", chunk);
 658                 ptr += x;
 659                 nbytes -= x;
 660         }
 661
 662         return n;
 663 }
 664
 665 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
 666 {
 667         /* TCL wants to read... tell him no */
 668         return 0;
 669 }
 670
 671 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
 672 {
 673         char *cp;
 674         int n;
 675         Jim_Interp *interp;
 676
 677         n = -1;
 678         interp = cookie;
 679         if (interp == NULL)
 680                 return n;
 681
 682         cp = alloc_vprintf(fmt, ap);
 683         if (cp)
 684         {
 685                 LOG_USER_N("%s", cp);
 686                 n = strlen(cp);
 687                 free(cp);
 688         }
 689         return n;
 690 }
 691
 692 static int openocd_jim_fflush(void *cookie)
 693 {
 694         /* nothing to flush */
 695         return 0;
 696 }
 697
 698 static char* openocd_jim_fgets(char *s, int size, void *cookie)
 699 {
 700         /* not supported */
 701         errno = ENOTSUP;
 702         return NULL;
 703 }
 704
 705 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 706 {
 707         if (argc != 2)
 708                 return JIM_ERR;
 709         int retcode;
 710         const char *str = Jim_GetString(argv[1], NULL);
 711
 712         /* capture log output and return it */
 713         Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
 714         /* a garbage collect can happen, so we need a reference count to this object */
 715         Jim_IncrRefCount(tclOutput);
 716
 717         log_add_callback(tcl_output, tclOutput);
 718
 719         retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
 720
 721         log_remove_callback(tcl_output, tclOutput);
 722
 723         /* We dump output into this local variable */
 724         Jim_SetResult(interp, tclOutput);
 725         Jim_DecrRefCount(interp, tclOutput);
 726
 727         return retcode;
 728 }
 729
 730 static COMMAND_HELPER(command_help_find, struct command *head,
 731                 struct command **out)
 732 {
 733         if (0 == CMD_ARGC)
 734                 return ERROR_INVALID_ARGUMENTS;
 735         *out = command_find(head, CMD_ARGV[0]);
 736         if (NULL == *out)
 737                 return ERROR_INVALID_ARGUMENTS;
 738         if (--CMD_ARGC == 0)
 739                 return ERROR_OK;
 740         CMD_ARGV++;
 741         return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
 742 }
 743
 744 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 745                 bool show_help);
 746
 747 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
 748                 bool show_help)
 749 {
 750         for (struct command *c = head; NULL != c; c = c->next)
 751                 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help);
 752         return ERROR_OK;
 753 }
 754 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 755                 bool show_help)
 756 {
 757         const char *usage = c->usage ? : "";
 758         const char *help = "";
 759         const char *sep = "";
 760         if (show_help && c->help)
 761         {
 762                 help = c->help ? : "";
 763                 sep = c->usage ? " | " : "";
 764         }
 765         command_run_linef(CMD_CTX, "cmd_help {%s} {%s%s%s} %d",
 766                         command_name(c, ' '), usage, sep, help, n);
 767
 768         if (++n >= 2)
 769                 return ERROR_OK;
 770
 771         return CALL_COMMAND_HANDLER(command_help_show_list,
 772                         c->children, n, show_help);
 773 }
 774 COMMAND_HANDLER(handle_help_command)
 775 {
 776         struct command *c = CMD_CTX->commands;
 777
 778         if (0 == CMD_ARGC)
 779                 return CALL_COMMAND_HANDLER(command_help_show_list, c, 0, true);
 780
 781         int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
 782         if (ERROR_OK != retval)
 783                 return retval;
 784
 785         return CALL_COMMAND_HANDLER(command_help_show, c, 0, true);
 786 }
 787
 788 COMMAND_HANDLER(handle_usage_command)
 789 {
 790         struct command *c = CMD_CTX->commands;
 791
 792         if (0 == CMD_ARGC)
 793                 return CALL_COMMAND_HANDLER(command_help_show_list, c, 0, false);
 794
 795         int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
 796         if (ERROR_OK != retval)
 797                 return retval;
 798
 799         return CALL_COMMAND_HANDLER(command_help_show, c, 0, false);
 800 }
 801
 802
 803 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
 804                 const char *cmd_name, const char *help_text, const char *usage)
 805 {
 806         struct command **head = command_list_for_parent(cmd_ctx, parent);
 807         struct command *nc = command_find(*head, cmd_name);
 808         if (NULL == nc)
 809         {
 810                 // add a new command with help text
 811                 struct command_registration cr = {
 812                                 .name = cmd_name,
 813                                 .mode = COMMAND_ANY,
 814                                 .help = help_text,
 815                                 .usage = usage,
 816                         };
 817                 nc = register_command(cmd_ctx, parent, &cr);
 818                 if (NULL == nc)
 819                 {
 820                         LOG_ERROR("failed to add '%s' help text", cmd_name);
 821                         return ERROR_FAIL;
 822                 }
 823                 LOG_DEBUG("added '%s' help text", cmd_name);
 824         }
 825         else
 826         {
 827                 bool replaced = false;
 828                 if (nc->help)
 829                 {
 830                         free((void *)nc->help);
 831                         replaced = true;
 832                 }
 833                 nc->help = strdup(help_text);
 834
 835                 if (replaced)
 836                         LOG_INFO("replaced existing '%s' help", cmd_name);
 837                 else
 838                         LOG_DEBUG("added '%s' help text", cmd_name);
 839         }
 840         return ERROR_OK;
 841 }
 842
 843 COMMAND_HANDLER(handle_help_add_command)
 844 {
 845         if (CMD_ARGC < 2)
 846         {
 847                 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
 848                 return ERROR_INVALID_ARGUMENTS;
 849         }
 850
 851         // save help text and remove it from argument list
 852         const char *help_text = CMD_ARGV[--CMD_ARGC];
 853         // likewise for the leaf command name
 854         const char *cmd_name = CMD_ARGV[--CMD_ARGC];
 855
 856         struct command *c = NULL;
 857         if (CMD_ARGC > 0)
 858         {
 859                 c = CMD_CTX->commands;
 860                 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
 861                 if (ERROR_OK != retval)
 862                         return retval;
 863         }
 864         return help_add_command(CMD_CTX, c, cmd_name, help_text, NULL);
 865 }
 866
 867 /* sleep command sleeps for <n> miliseconds
 868  * this is useful in target startup scripts
 869  */
 870 COMMAND_HANDLER(handle_sleep_command)
 871 {
 872         bool busy = false;
 873         if (CMD_ARGC == 2)
 874         {
 875                 if (strcmp(CMD_ARGV[1], "busy") == 0)
 876                         busy = true;
 877                 else
 878                         return ERROR_COMMAND_SYNTAX_ERROR;
 879         }
 880         else if (CMD_ARGC < 1 || CMD_ARGC > 2)
 881                 return ERROR_COMMAND_SYNTAX_ERROR;
 882
 883         unsigned long duration = 0;
 884         int retval = parse_ulong(CMD_ARGV[0], &duration);
 885         if (ERROR_OK != retval)
 886                 return retval;
 887
 888         if (!busy)
 889         {
 890                 long long then = timeval_ms();
 891                 while (timeval_ms() - then < (long long)duration)
 892                 {
 893                         target_call_timer_callbacks_now();
 894                         usleep(1000);
 895                 }
 896         }
 897         else
 898                 busy_sleep(duration);
 899
 900         return ERROR_OK;
 901 }
 902
 903 struct command_context* command_init(const char *startup_tcl)
 904 {
 905         struct command_context* context = malloc(sizeof(struct command_context));
 906         const char *HostOs;
 907
 908         context->mode = COMMAND_EXEC;
 909         context->commands = NULL;
 910         context->current_target = 0;
 911         context->output_handler = NULL;
 912         context->output_handler_priv = NULL;
 913
 914 #if !BUILD_ECOSBOARD
 915         Jim_InitEmbedded();
 916         /* Create an interpreter */
 917         interp = Jim_CreateInterp();
 918         /* Add all the Jim core commands */
 919         Jim_RegisterCoreCommands(interp);
 920 #endif
 921
 922 #if defined(_MSC_VER)
 923         /* WinXX - is generic, the forward
 924          * looking problem is this:
 925          *
 926          *   "win32" or "win64"
 927          *
 928          * "winxx" is generic.
 929          */
 930         HostOs = "winxx";
 931 #elif defined(__linux__)
 932         HostOs = "linux";
 933 #elif defined(__DARWIN__)
 934         HostOs = "darwin";
 935 #elif defined(__CYGWIN__)
 936         HostOs = "cygwin";
 937 #elif defined(__MINGW32__)
 938         HostOs = "mingw32";
 939 #elif defined(__ECOS)
 940         HostOs = "ecos";
 941 #else
 942 #warn unrecognized host OS...
 943         HostOs = "other";
 944 #endif
 945         Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
 946                         Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
 947
 948         Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
 949         Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
 950         Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
 951
 952         /* Set Jim's STDIO */
 953         interp->cookie_stdin = interp;
 954         interp->cookie_stdout = interp;
 955         interp->cookie_stderr = interp;
 956         interp->cb_fwrite = openocd_jim_fwrite;
 957         interp->cb_fread = openocd_jim_fread ;
 958         interp->cb_vfprintf = openocd_jim_vfprintf;
 959         interp->cb_fflush = openocd_jim_fflush;
 960         interp->cb_fgets = openocd_jim_fgets;
 961
 962         COMMAND_REGISTER(context, NULL, "add_help_text",
 963                         handle_help_add_command, COMMAND_ANY,
 964                         "<command> [...] <help_text>] - "
 965                         "add new command help text");
 966
 967 #if !BUILD_ECOSBOARD
 968         Jim_EventLoopOnLoad(interp);
 969 #endif
 970         Jim_SetAssocData(interp, "context", NULL, context);
 971         if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
 972         {
 973                 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
 974                 Jim_PrintErrorMessage(interp);
 975                 exit(-1);
 976         }
 977         Jim_DeleteAssocData(interp, "context");
 978
 979         COMMAND_REGISTER(context, NULL, "sleep",
 980                         handle_sleep_command, COMMAND_ANY,
 981                         "<n> [busy] - sleep for n milliseconds. "
 982                         "\"busy\" means busy wait");
 983
 984         COMMAND_REGISTER(context, NULL, "help",
 985                         &handle_help_command, COMMAND_ANY,
 986                         "[<command_name> ...] - show built-in command help");
 987         COMMAND_REGISTER(context, NULL, "usage",
 988                         &handle_usage_command, COMMAND_ANY,
 989                         "[<command_name> ...] | "
 990                         "show command usage");
 991
 992         return context;
 993 }
 994
 995 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
 996 {
 997         if (!cmd_ctx)
 998                 return ERROR_INVALID_ARGUMENTS;
 999
1000         cmd_ctx->mode = mode;
1001         return ERROR_OK;
1002 }
1003
1004 void process_jim_events(void)
1005 {
1006 #if !BUILD_ECOSBOARD
1007         static int recursion = 0;
1008
1009         if (!recursion)
1010         {
1011                 recursion++;
1012                 Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1013                 recursion--;
1014         }
1015 #endif
1016 }
1017
1018 void register_jim(struct command_context *cmd_ctx, const char *name,
1019                 Jim_CmdProc cmd, const char *help)
1020 {
1021         Jim_CreateCommand(interp, name, cmd, NULL, NULL);
1022
1023         Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
1024         Jim_ListAppendElement(interp, cmd_list,
1025                         Jim_NewStringObj(interp, name, -1));
1026
1027         help_add_command(cmd_ctx, NULL, name, help, NULL);
1028 }
1029
1030 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1031         int parse##name(const char *str, type *ul) \
1032         { \
1033                 if (!*str) \
1034                 { \
1035                         LOG_ERROR("Invalid command argument"); \
1036                         return ERROR_COMMAND_ARGUMENT_INVALID; \
1037                 } \
1038                 char *end; \
1039                 *ul = func(str, &end, 0); \
1040                 if (*end) \
1041                 { \
1042                         LOG_ERROR("Invalid command argument"); \
1043                         return ERROR_COMMAND_ARGUMENT_INVALID; \
1044                 } \
1045                 if ((max == *ul) && (ERANGE == errno)) \
1046                 { \
1047                         LOG_ERROR("Argument overflow"); \
1048                         return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1049                 } \
1050                 if (min && (min == *ul) && (ERANGE == errno)) \
1051                 { \
1052                         LOG_ERROR("Argument underflow"); \
1053                         return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1054                 } \
1055                 return ERROR_OK; \
1056         }
1057 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
1058 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1059 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
1060 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1061
1062 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1063         int parse##name(const char *str, type *ul) \
1064         { \
1065                 functype n; \
1066                 int retval = parse##funcname(str, &n); \
1067                 if (ERROR_OK != retval) \
1068                         return retval; \
1069                 if (n > max) \
1070                         return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1071                 if (min) \
1072                         return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1073                 *ul = n; \
1074                 return ERROR_OK; \
1075         }
1076
1077 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1078         DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1079 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
1080 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
1081 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
1082 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
1083
1084 #define DEFINE_PARSE_LONG(name, type, min, max) \
1085         DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1086 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
1087 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1088 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1089 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1090
1091 static int command_parse_bool(const char *in, bool *out,
1092                 const char *on, const char *off)
1093 {
1094         if (strcasecmp(in, on) == 0)
1095                 *out = true;
1096         else if (strcasecmp(in, off) == 0)
1097                 *out = false;
1098         else
1099                 return ERROR_COMMAND_SYNTAX_ERROR;
1100         return  ERROR_OK;
1101 }
1102
1103 int command_parse_bool_arg(const char *in, bool *out)
1104 {
1105         if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1106                 return ERROR_OK;
1107         if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1108                 return ERROR_OK;
1109         if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1110                 return ERROR_OK;
1111         if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1112                 return ERROR_OK;
1113         if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1114                 return ERROR_OK;
1115         return ERROR_INVALID_ARGUMENTS;
1116 }
1117
1118 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1119 {
1120         switch (CMD_ARGC) {
1121         case 1: {
1122                 const char *in = CMD_ARGV[0];
1123                 if (command_parse_bool_arg(in, out) != ERROR_OK)
1124                 {
1125                         LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1126                         return ERROR_INVALID_ARGUMENTS;
1127                 }
1128                 // fall through
1129         }
1130         case 0:
1131                 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1132                 break;
1133         default:
1134                 return ERROR_INVALID_ARGUMENTS;
1135         }
1136         return ERROR_OK;
1137 }