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/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 /* nice short description of source file */
  48 #define __THIS__FILE__ "command.c"
  49
  50
  51 static int run_command(struct command_context *context,
  52                 struct command *c, const char *words[], unsigned num_words);
  53
  54 struct log_capture_state {
  55         Jim_Interp *interp;
  56         Jim_Obj *output;
  57 };
  58
  59 static void tcl_output(void *privData, const char *file, unsigned line,
  60                 const char *function, const char *string)
  61 {
  62         struct log_capture_state *state = (struct log_capture_state *)privData;
  63         Jim_AppendString(state->interp, state->output, string, strlen(string));
  64 }
  65
  66 static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
  67 {
  68         /* capture log output and return it. A garbage collect can
  69          * happen, so we need a reference count to this object */
  70         Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
  71         if (NULL == tclOutput)
  72                 return NULL;
  73
  74         struct log_capture_state *state = malloc(sizeof(*state));
  75         if (NULL == state)
  76                 return NULL;
  77
  78         state->interp = interp;
  79         Jim_IncrRefCount(tclOutput);
  80         state->output = tclOutput;
  81
  82         log_add_callback(tcl_output, state);
  83
  84         return state;
  85 }
  86
  87 static void command_log_capture_finish(struct log_capture_state *state)
  88 {
  89         if (NULL == state)
  90                 return;
  91
  92         log_remove_callback(tcl_output, state);
  93
  94         Jim_SetResult(state->interp, state->output);
  95         Jim_DecrRefCount(state->interp, state->output);
  96
  97         free(state);
  98 }
  99
 100 static int command_retval_set(Jim_Interp *interp, int retval)
 101 {
 102         int *return_retval = Jim_GetAssocData(interp, "retval");
 103         if (return_retval != NULL)
 104                 *return_retval = retval;
 105
 106         return (retval == ERROR_OK) ? JIM_OK : JIM_ERR;
 107 }
 108
 109 extern struct command_context *global_cmd_ctx;
 110
 111 /* dump a single line to the log for the command.
 112  * Do nothing in case we are not at debug level 3 */
 113 void script_debug(Jim_Interp *interp, const char *name,
 114                 unsigned argc, Jim_Obj *const *argv)
 115 {
 116         if (debug_level < LOG_LVL_DEBUG)
 117                 return;
 118
 119         char * dbg = alloc_printf("command - %s", name);
 120         for (unsigned i = 0; i < argc; i++)
 121         {
 122                 int len;
 123                 const char *w = Jim_GetString(argv[i], &len);
 124
 125                 /* end of line comment? */
 126                 if (*w == '#')
 127                         break;
 128
 129                 char * t = alloc_printf("%s %s", dbg, w);
 130                 free (dbg);
 131                 dbg = t;
 132         }
 133         LOG_DEBUG("%s", dbg);
 134         free(dbg);
 135 }
 136
 137 static void script_command_args_free(const char **words, unsigned nwords)
 138 {
 139         for (unsigned i = 0; i < nwords; i++)
 140                 free((void *)words[i]);
 141         free(words);
 142 }
 143 static const char **script_command_args_alloc(
 144                 unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
 145 {
 146         const char **words = malloc(argc * sizeof(char *));
 147         if (NULL == words)
 148                 return NULL;
 149
 150         unsigned i;
 151         for (i = 0; i < argc; i++)
 152         {
 153                 int len;
 154                 const char *w = Jim_GetString(argv[i], &len);
 155                 /* a comment may end the line early */
 156                 if (*w == '#')
 157                         break;
 158
 159                 words[i] = strdup(w);
 160                 if (words[i] == NULL)
 161                 {
 162                         script_command_args_free(words, i);
 163                         return NULL;
 164                 }
 165         }
 166         *nwords = i;
 167         return words;
 168 }
 169
 170 struct command_context *current_command_context(Jim_Interp *interp)
 171 {
 172         /* grab the command context from the associated data */
 173         struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
 174         if (NULL == cmd_ctx)
 175         {
 176                 /* Tcl can invoke commands directly instead of via command_run_line(). This would
 177                  * happen when the Jim Tcl interpreter is provided by eCos or if we are running
 178                  * commands in a startup script.
 179                  *
 180                  * A telnet or gdb server would provide a non-default command context to
 181                  * handle piping of error output, have a separate current target, etc.
 182                  */
 183                 cmd_ctx = global_cmd_ctx;
 184         }
 185         return cmd_ctx;
 186 }
 187
 188 static int script_command_run(Jim_Interp *interp,
 189                 int argc, Jim_Obj *const *argv, struct command *c, bool capture)
 190 {
 191         target_call_timer_callbacks_now();
 192         LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
 193
 194         unsigned nwords;
 195         const char **words = script_command_args_alloc(argc, argv, &nwords);
 196         if (NULL == words)
 197                 return JIM_ERR;
 198
 199         struct log_capture_state *state = NULL;
 200         if (capture)
 201                 state = command_log_capture_start(interp);
 202
 203         struct command_context *cmd_ctx = current_command_context(interp);
 204         int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
 205
 206         command_log_capture_finish(state);
 207
 208         script_command_args_free(words, nwords);
 209         return command_retval_set(interp, retval);
 210 }
 211
 212 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 213 {
 214         /* the private data is stashed in the interp structure */
 215
 216         struct command *c = interp->cmdPrivData;
 217         assert(c);
 218         script_debug(interp, c->name, argc, argv);
 219         return script_command_run(interp, argc, argv, c, true);
 220 }
 221
 222 static struct command *command_root(struct command *c)
 223 {
 224         while (NULL != c->parent)
 225                 c = c->parent;
 226         return c;
 227 }
 228
 229 /**
 230  * Find a command by name from a list of commands.
 231  * @returns Returns the named command if it exists in the list.
 232  * Returns NULL otherwise.
 233  */
 234 static struct command *command_find(struct command *head, const char *name)
 235 {
 236         for (struct command *cc = head; cc; cc = cc->next)
 237         {
 238                 if (strcmp(cc->name, name) == 0)
 239                         return cc;
 240         }
 241         return NULL;
 242 }
 243 struct command *command_find_in_context(struct command_context *cmd_ctx,
 244                 const char *name)
 245 {
 246         return command_find(cmd_ctx->commands, name);
 247 }
 248 struct command *command_find_in_parent(struct command *parent,
 249                 const char *name)
 250 {
 251         return command_find(parent->children, name);
 252 }
 253
 254 /**
 255  * Add the command into the linked list, sorted by name.
 256  * @param head Address to head of command list pointer, which may be
 257  * updated if @c c gets inserted at the beginning of the list.
 258  * @param c The command to add to the list pointed to by @c head.
 259  */
 260 static void command_add_child(struct command **head, struct command *c)
 261 {
 262         assert(head);
 263         if (NULL == *head)
 264         {
 265                 *head = c;
 266                 return;
 267         }
 268
 269         while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
 270                 head = &(*head)->next;
 271
 272         if (strcmp(c->name, (*head)->name) > 0) {
 273                 c->next = (*head)->next;
 274                 (*head)->next = c;
 275         } else {
 276                 c->next = *head;
 277                 *head = c;
 278         }
 279 }
 280
 281 static struct command **command_list_for_parent(
 282                 struct command_context *cmd_ctx, struct command *parent)
 283 {
 284         return parent ? &parent->children : &cmd_ctx->commands;
 285 }
 286
 287 static void command_free(struct command *c)
 288 {
 289         /// @todo if command has a handler, unregister its jim command!
 290
 291         while (NULL != c->children)
 292         {
 293                 struct command *tmp = c->children;
 294                 c->children = tmp->next;
 295                 command_free(tmp);
 296         }
 297
 298         if (c->name)
 299                 free(c->name);
 300         if (c->help)
 301                 free((void*)c->help);
 302         if (c->usage)
 303                 free((void*)c->usage);
 304         free(c);
 305 }
 306
 307 static struct command *command_new(struct command_context *cmd_ctx,
 308                 struct command *parent, const struct command_registration *cr)
 309 {
 310         assert(cr->name);
 311
 312         struct command *c = calloc(1, sizeof(struct command));
 313         if (NULL == c)
 314                 return NULL;
 315
 316         c->name = strdup(cr->name);
 317         if (cr->help)
 318                 c->help = strdup(cr->help);
 319         if (cr->usage)
 320                 c->usage = strdup(cr->usage);
 321
 322         if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
 323                 goto command_new_error;
 324
 325         c->parent = parent;
 326         c->handler = cr->handler;
 327         c->jim_handler = cr->jim_handler;
 328         c->jim_handler_data = cr->jim_handler_data;
 329         c->mode = cr->mode;
 330
 331         command_add_child(command_list_for_parent(cmd_ctx, parent), c);
 332
 333         return c;
 334
 335 command_new_error:
 336         command_free(c);
 337         return NULL;
 338 }
 339
 340 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
 341
 342 static int register_command_handler(struct command_context *cmd_ctx,
 343                 struct command *c)
 344 {
 345         Jim_Interp *interp = cmd_ctx->interp;
 346         const char *ocd_name = alloc_printf("ocd_%s", c->name);
 347         if (NULL == ocd_name)
 348                 return JIM_ERR;
 349
 350         LOG_DEBUG("registering '%s'...", ocd_name);
 351
 352         Jim_CmdProc func = c->handler ? &script_command : &command_unknown;
 353         int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
 354         free((void *)ocd_name);
 355         if (JIM_OK != retval)
 356                 return retval;
 357
 358         /* we now need to add an overrideable proc */
 359         const char *override_name = alloc_printf(
 360                         "proc %s {args} {eval ocd_bouncer %s $args}",
 361                         c->name, c->name);
 362         if (NULL == override_name)
 363                 return JIM_ERR;
 364
 365         retval = Jim_Eval_Named(interp, override_name, 0, 0);
 366         free((void *)override_name);
 367
 368         return retval;
 369 }
 370
 371 struct command* register_command(struct command_context *context,
 372                 struct command *parent, const struct command_registration *cr)
 373 {
 374         if (!context || !cr->name)
 375                 return NULL;
 376
 377         const char *name = cr->name;
 378         struct command **head = command_list_for_parent(context, parent);
 379         struct command *c = command_find(*head, name);
 380         if (NULL != c)
 381         {
 382                 /* TODO: originally we treated attempting to register a cmd twice as an error
 383                  * Sometimes we need this behaviour, such as with flash banks.
 384                  * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
 385                 LOG_DEBUG("command '%s' is already registered in '%s' context",
 386                                 name, parent ? parent->name : "<global>");
 387                 return c;
 388         }
 389
 390         c = command_new(context, parent, cr);
 391         if (NULL == c)
 392                 return NULL;
 393
 394         int retval = ERROR_OK;
 395         if (NULL != cr->jim_handler && NULL == parent)
 396         {
 397                 retval = Jim_CreateCommand(context->interp, cr->name,
 398                                 cr->jim_handler, cr->jim_handler_data, NULL);
 399         }
 400         else if (NULL != cr->handler || NULL != parent)
 401                 retval = register_command_handler(context, command_root(c));
 402
 403         if (ERROR_OK != retval)
 404         {
 405                 unregister_command(context, parent, name);
 406                 c = NULL;
 407         }
 408         return c;
 409 }
 410
 411 int register_commands(struct command_context *cmd_ctx, struct command *parent,
 412                 const struct command_registration *cmds)
 413 {
 414         int retval = ERROR_OK;
 415         unsigned i;
 416         for (i = 0; cmds[i].name || cmds[i].chain; i++)
 417         {
 418                 const struct command_registration *cr = cmds + i;
 419
 420                 struct command *c = NULL;
 421                 if (NULL != cr->name)
 422                 {
 423                         c = register_command(cmd_ctx, parent, cr);
 424                         if (NULL == c)
 425                         {
 426                                 retval = ERROR_FAIL;
 427                                 break;
 428                         }
 429                 }
 430                 if (NULL != cr->chain)
 431                 {
 432                         struct command *p = c ? : parent;
 433                         retval = register_commands(cmd_ctx, p, cr->chain);
 434                         if (ERROR_OK != retval)
 435                                 break;
 436                 }
 437         }
 438         if (ERROR_OK != retval)
 439         {
 440                 for (unsigned j = 0; j < i; j++)
 441                         unregister_command(cmd_ctx, parent, cmds[j].name);
 442         }
 443         return retval;
 444 }
 445
 446 int unregister_all_commands(struct command_context *context,
 447                 struct command *parent)
 448 {
 449         if (context == NULL)
 450                 return ERROR_OK;
 451
 452         struct command **head = command_list_for_parent(context, parent);
 453         while (NULL != *head)
 454         {
 455                 struct command *tmp = *head;
 456                 *head = tmp->next;
 457                 command_free(tmp);
 458         }
 459
 460         return ERROR_OK;
 461 }
 462
 463 int unregister_command(struct command_context *context,
 464                 struct command *parent, const char *name)
 465 {
 466         if ((!context) || (!name))
 467                 return ERROR_INVALID_ARGUMENTS;
 468
 469         struct command *p = NULL;
 470         struct command **head = command_list_for_parent(context, parent);
 471         for (struct command *c = *head; NULL != c; p = c, c = c->next)
 472         {
 473                 if (strcmp(name, c->name) != 0)
 474                         continue;
 475
 476                 if (p)
 477                         p->next = c->next;
 478                 else
 479                         *head = c->next;
 480
 481                 command_free(c);
 482                 return ERROR_OK;
 483         }
 484
 485         return ERROR_OK;
 486 }
 487
 488 void command_set_handler_data(struct command *c, void *p)
 489 {
 490         if (NULL != c->handler || NULL != c->jim_handler)
 491                 c->jim_handler_data = p;
 492         for (struct command *cc = c->children; NULL != cc; cc = cc->next)
 493                 command_set_handler_data(cc, p);
 494 }
 495
 496 void command_output_text(struct command_context *context, const char *data)
 497 {
 498         if (context && context->output_handler && data) {
 499                 context->output_handler(context, data);
 500         }
 501 }
 502
 503 void command_print_sameline(struct command_context *context, const char *format, ...)
 504 {
 505         char *string;
 506
 507         va_list ap;
 508         va_start(ap, format);
 509
 510         string = alloc_vprintf(format, ap);
 511         if (string != NULL)
 512         {
 513                 /* we want this collected in the log + we also want to pick it up as a tcl return
 514                  * value.
 515                  *
 516                  * The latter bit isn't precisely neat, but will do for now.
 517                  */
 518                 LOG_USER_N("%s", string);
 519                 /* We already printed it above */
 520                 /* command_output_text(context, string); */
 521                 free(string);
 522         }
 523
 524         va_end(ap);
 525 }
 526
 527 void command_print(struct command_context *context, const char *format, ...)
 528 {
 529         char *string;
 530
 531         va_list ap;
 532         va_start(ap, format);
 533
 534         string = alloc_vprintf(format, ap);
 535         if (string != NULL)
 536         {
 537                 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
 538                 /* we want this collected in the log + we also want to pick it up as a tcl return
 539                  * value.
 540                  *
 541                  * The latter bit isn't precisely neat, but will do for now.
 542                  */
 543                 LOG_USER_N("%s", string);
 544                 /* We already printed it above */
 545                 /* command_output_text(context, string); */
 546                 free(string);
 547         }
 548
 549         va_end(ap);
 550 }
 551
 552 static char *__command_name(struct command *c, char delim, unsigned extra)
 553 {
 554         char *name;
 555         unsigned len = strlen(c->name);
 556         if (NULL == c->parent) {
 557                 // allocate enough for the name, child names, and '\0'
 558                 name = malloc(len + extra + 1);
 559                 strcpy(name, c->name);
 560         } else {
 561                 // parent's extra must include both the space and name
 562                 name = __command_name(c->parent, delim, 1 + len + extra);
 563                 char dstr[2] = { delim, 0 };
 564                 strcat(name, dstr);
 565                 strcat(name, c->name);
 566         }
 567         return name;
 568 }
 569 char *command_name(struct command *c, char delim)
 570 {
 571         return __command_name(c, delim, 0);
 572 }
 573
 574 static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
 575 {
 576         return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
 577 }
 578
 579 static int run_command(struct command_context *context,
 580                 struct command *c, const char *words[], unsigned num_words)
 581 {
 582         if (!command_can_run(context, c))
 583         {
 584                 /* Many commands may be run only before/after 'init' */
 585                 const char *when;
 586                 switch (c->mode) {
 587                 case COMMAND_CONFIG: when = "before"; break;
 588                 case COMMAND_EXEC: when = "after"; break;
 589                 // handle the impossible with humor; it guarantees a bug report!
 590                 default: when = "if Cthulhu is summoned by"; break;
 591                 }
 592                 LOG_ERROR("The '%s' command must be used %s 'init'.",
 593                                 c->name, when);
 594                 return ERROR_FAIL;
 595         }
 596
 597         struct command_invocation cmd = {
 598                         .ctx = context,
 599                         .current = c,
 600                         .name = c->name,
 601                         .argc = num_words - 1,
 602                         .argv = words + 1,
 603                 };
 604         int retval = c->handler(&cmd);
 605         if (retval == ERROR_COMMAND_SYNTAX_ERROR)
 606         {
 607                 /* Print help for command */
 608                 char *full_name = command_name(c, ' ');
 609                 if (NULL != full_name) {
 610                         command_run_linef(context, "usage %s", full_name);
 611                         free(full_name);
 612                 } else
 613                         retval = -ENOMEM;
 614         }
 615         else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
 616         {
 617                 /* just fall through for a shutdown request */
 618         }
 619         else if (retval != ERROR_OK)
 620         {
 621                 /* we do not print out an error message because the command *should*
 622                  * have printed out an error
 623                  */
 624                 LOG_DEBUG("Command failed with error code %d", retval);
 625         }
 626
 627         return retval;
 628 }
 629
 630 int command_run_line(struct command_context *context, char *line)
 631 {
 632         /* all the parent commands have been registered with the interpreter
 633          * so, can just evaluate the line as a script and check for
 634          * results
 635          */
 636         /* run the line thru a script engine */
 637         int retval = ERROR_FAIL;
 638         int retcode;
 639         /* Beware! This code needs to be reentrant. It is also possible
 640          * for OpenOCD commands to be invoked directly from Tcl. This would
 641          * happen when the Jim Tcl interpreter is provided by eCos for
 642          * instance.
 643          */
 644         Jim_Interp *interp = context->interp;
 645         Jim_DeleteAssocData(interp, "context");
 646         retcode = Jim_SetAssocData(interp, "context", NULL, context);
 647         if (retcode == JIM_OK)
 648         {
 649                 /* associated the return value */
 650                 Jim_DeleteAssocData(interp, "retval");
 651                 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
 652                 if (retcode == JIM_OK)
 653                 {
 654                         retcode = Jim_Eval_Named(interp, line, 0, 0);
 655
 656                         Jim_DeleteAssocData(interp, "retval");
 657                 }
 658                 Jim_DeleteAssocData(interp, "context");
 659         }
 660         if (retcode == JIM_ERR) {
 661                 if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
 662                 {
 663                         /* We do not print the connection closed error message */
 664                         Jim_PrintErrorMessage(interp);
 665                 }
 666                 if (retval == ERROR_OK)
 667                 {
 668                         /* It wasn't a low level OpenOCD command that failed */
 669                         return ERROR_FAIL;
 670                 }
 671                 return retval;
 672         } else if (retcode == JIM_EXIT) {
 673                 /* ignore. */
 674                 /* exit(Jim_GetExitCode(interp)); */
 675         } else {
 676                 const char *result;
 677                 int reslen;
 678
 679                 result = Jim_GetString(Jim_GetResult(interp), &reslen);
 680                 if (reslen > 0)
 681                 {
 682                         int i;
 683                         char buff[256 + 1];
 684                         for (i = 0; i < reslen; i += 256)
 685                         {
 686                                 int chunk;
 687                                 chunk = reslen - i;
 688                                 if (chunk > 256)
 689                                         chunk = 256;
 690                                 strncpy(buff, result + i, chunk);
 691                                 buff[chunk] = 0;
 692                                 LOG_USER_N("%s", buff);
 693                         }
 694                         LOG_USER_N("%s", "\n");
 695                 }
 696                 retval = ERROR_OK;
 697         }
 698         return retval;
 699 }
 700
 701 int command_run_linef(struct command_context *context, const char *format, ...)
 702 {
 703         int retval = ERROR_FAIL;
 704         char *string;
 705         va_list ap;
 706         va_start(ap, format);
 707         string = alloc_vprintf(format, ap);
 708         if (string != NULL)
 709         {
 710                 retval = command_run_line(context, string);
 711         }
 712         va_end(ap);
 713         return retval;
 714 }
 715
 716 void command_set_output_handler(struct command_context* context,
 717                 command_output_handler_t output_handler, void *priv)
 718 {
 719         context->output_handler = output_handler;
 720         context->output_handler_priv = priv;
 721 }
 722
 723 struct command_context* copy_command_context(struct command_context* context)
 724 {
 725         struct command_context* copy_context = malloc(sizeof(struct command_context));
 726
 727         *copy_context = *context;
 728
 729         return copy_context;
 730 }
 731
 732 void command_done(struct command_context *cmd_ctx)
 733 {
 734         if (NULL == cmd_ctx)
 735                 return;
 736
 737         free(cmd_ctx);
 738 }
 739
 740 /* find full path to file */
 741 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 742 {
 743         if (argc != 2)
 744                 return JIM_ERR;
 745         const char *file = Jim_GetString(argv[1], NULL);
 746         char *full_path = find_file(file);
 747         if (full_path == NULL)
 748                 return JIM_ERR;
 749         Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
 750         free(full_path);
 751
 752         Jim_SetResult(interp, result);
 753         return JIM_OK;
 754 }
 755
 756 static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 757 {
 758         if (argc != 2)
 759                 return JIM_ERR;
 760         const char *str = Jim_GetString(argv[1], NULL);
 761         LOG_USER("%s", str);
 762         return JIM_OK;
 763 }
 764
 765 static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
 766 {
 767         size_t nbytes;
 768         const char *ptr;
 769         Jim_Interp *interp;
 770
 771         /* make it a char easier to read code */
 772         ptr = _ptr;
 773         interp = cookie;
 774         nbytes = size * n;
 775         if (ptr == NULL || interp == NULL || nbytes == 0) {
 776                 return 0;
 777         }
 778
 779         /* do we have to chunk it? */
 780         if (ptr[nbytes] == 0)
 781         {
 782                 /* no it is a C style string */
 783                 LOG_USER_N("%s", ptr);
 784                 return strlen(ptr);
 785         }
 786         /* GRR we must chunk - not null terminated */
 787         while (nbytes) {
 788                 char chunk[128 + 1];
 789                 int x;
 790
 791                 x = nbytes;
 792                 if (x > 128) {
 793                         x = 128;
 794                 }
 795                 /* copy it */
 796                 memcpy(chunk, ptr, x);
 797                 /* terminate it */
 798                 chunk[n] = 0;
 799                 /* output it */
 800                 LOG_USER_N("%s", chunk);
 801                 ptr += x;
 802                 nbytes -= x;
 803         }
 804
 805         return n;
 806 }
 807
 808 static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
 809 {
 810         /* TCL wants to read... tell him no */
 811         return 0;
 812 }
 813
 814 static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
 815 {
 816         char *cp;
 817         int n;
 818         Jim_Interp *interp;
 819
 820         n = -1;
 821         interp = cookie;
 822         if (interp == NULL)
 823                 return n;
 824
 825         cp = alloc_vprintf(fmt, ap);
 826         if (cp)
 827         {
 828                 LOG_USER_N("%s", cp);
 829                 n = strlen(cp);
 830                 free(cp);
 831         }
 832         return n;
 833 }
 834
 835 static int openocd_jim_fflush(void *cookie)
 836 {
 837         /* nothing to flush */
 838         return 0;
 839 }
 840
 841 static char* openocd_jim_fgets(char *s, int size, void *cookie)
 842 {
 843         /* not supported */
 844         errno = ENOTSUP;
 845         return NULL;
 846 }
 847
 848 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 849 {
 850         if (argc != 2)
 851                 return JIM_ERR;
 852
 853         struct log_capture_state *state = command_log_capture_start(interp);
 854
 855         const char *str = Jim_GetString(argv[1], NULL);
 856         int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
 857
 858         command_log_capture_finish(state);
 859
 860         return retcode;
 861 }
 862
 863 static COMMAND_HELPER(command_help_find, struct command *head,
 864                 struct command **out)
 865 {
 866         if (0 == CMD_ARGC)
 867                 return ERROR_INVALID_ARGUMENTS;
 868         *out = command_find(head, CMD_ARGV[0]);
 869         if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
 870                 *out = command_find(head, CMD_ARGV[0] + 4);
 871         if (NULL == *out)
 872                 return ERROR_INVALID_ARGUMENTS;
 873         if (--CMD_ARGC == 0)
 874                 return ERROR_OK;
 875         CMD_ARGV++;
 876         return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
 877 }
 878
 879 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 880                 bool show_help, const char *match);
 881
 882 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
 883                 bool show_help, const char *match)
 884 {
 885         for (struct command *c = head; NULL != c; c = c->next)
 886                 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match);
 887         return ERROR_OK;
 888 }
 889
 890 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
 891
 892 static void command_help_show_indent(unsigned n)
 893 {
 894         for (unsigned i = 0; i < n; i++)
 895                 LOG_USER_N("  ");
 896 }
 897 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
 898 {
 899         const char *cp = str, *last = str;
 900         while (*cp)
 901         {
 902                 const char *next = last;
 903                 do {
 904                         cp = next;
 905                         do {
 906                                 next++;
 907                         } while (*next != ' ' && *next != '\t' && *next != '\0');
 908                 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
 909                 if (next - last < HELP_LINE_WIDTH(n))
 910                         cp = next;
 911                 command_help_show_indent(n);
 912                 LOG_USER_N("%.*s", (int)(cp - last), last);
 913                 LOG_USER_N("\n");
 914                 last = cp + 1;
 915                 n = n2;
 916         }
 917 }
 918 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 919                 bool show_help, const char *match)
 920 {
 921         if (!command_can_run(CMD_CTX, c))
 922                 return ERROR_OK;
 923
 924         char *cmd_name = command_name(c, ' ');
 925         if (NULL == cmd_name)
 926                 return -ENOMEM;
 927
 928         /* If the match string occurs anywhere, we print out
 929          * stuff for this command. */
 930         bool is_match = (strstr(cmd_name, match) != NULL) ||
 931         ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) ||
 932         ((c->help != NULL) && (strstr(c->help, match) != NULL));
 933
 934         if (is_match)
 935         {
 936                 command_help_show_indent(n);
 937                 LOG_USER_N("%s", cmd_name);
 938         }
 939         free(cmd_name);
 940
 941         if (is_match)
 942         {
 943                 if (c->usage) {
 944                         LOG_USER_N(" ");
 945                         command_help_show_wrap(c->usage, 0, n + 5);
 946                 }
 947                 else
 948                         LOG_USER_N("\n");
 949         }
 950
 951         if (is_match && show_help)
 952         {
 953                 char *msg;
 954
 955                 /* Normal commands are runtime-only; highlight exceptions */
 956                 if (c->mode != COMMAND_EXEC) {
 957                         const char *stage_msg = "";
 958
 959                         switch (c->mode) {
 960                         case COMMAND_CONFIG:
 961                                 stage_msg = " (configuration command)";
 962                                 break;
 963                         case COMMAND_ANY:
 964                                 stage_msg = " (command valid any time)";
 965                                 break;
 966                         default:
 967                                 stage_msg = " (?mode error?)";
 968                                 break;
 969                         }
 970                         msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
 971                 } else
 972                         msg = alloc_printf("%s", c->help ? : "");
 973
 974                 if (NULL != msg)
 975                 {
 976                         command_help_show_wrap(msg, n + 3, n + 3);
 977                         free(msg);
 978                 } else
 979                         return -ENOMEM;
 980         }
 981
 982         if (++n >= 2)
 983                 return ERROR_OK;
 984
 985         return CALL_COMMAND_HANDLER(command_help_show_list,
 986                         c->children, n, show_help, match);
 987 }
 988 COMMAND_HANDLER(handle_help_command)
 989 {
 990         bool full = strcmp(CMD_NAME, "help") == 0;
 991         int retval;
 992         struct command *c = CMD_CTX->commands;
 993         char *match = NULL;
 994
 995         if (CMD_ARGC == 0)
 996                 match = "";
 997         else if (CMD_ARGC >= 1) {
 998                 unsigned i;
 999
1000                 for (i = 0; i < CMD_ARGC; ++i) {
1001                         if (NULL != match) {
1002                                 char *prev = match;
1003
1004                                 match = alloc_printf("%s %s", match,
1005                                                 CMD_ARGV[i]);
1006                                 free(prev);
1007                                 if (NULL == match) {
1008                                         LOG_ERROR("unable to build "
1009                                                         "search string");
1010                                         return -ENOMEM;
1011                                 }
1012                         } else {
1013                                 match = alloc_printf("%s", CMD_ARGV[i]);
1014                                 if (NULL == match) {
1015                                         LOG_ERROR("unable to build "
1016                                                         "search string");
1017                                         return -ENOMEM;
1018                                 }
1019                         }
1020                 }
1021         } else
1022                 return ERROR_COMMAND_SYNTAX_ERROR;
1023
1024         retval = CALL_COMMAND_HANDLER(command_help_show_list,
1025                         c, 0, full, match);
1026
1027         if (CMD_ARGC >= 1)
1028                 free(match);
1029         return retval;
1030 }
1031
1032 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
1033                 struct command *head, struct command **out, bool top_level)
1034 {
1035         if (0 == argc)
1036                 return argc;
1037         const char *cmd_name = Jim_GetString(argv[0], NULL);
1038         struct command *c = command_find(head, cmd_name);
1039         if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
1040                 c = command_find(head, cmd_name + 4);
1041         if (NULL == c)
1042                 return argc;
1043         *out = c;
1044         return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
1045 }
1046
1047
1048 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1049 {
1050         const char *cmd_name = Jim_GetString(argv[0], NULL);
1051         if (strcmp(cmd_name, "unknown") == 0)
1052         {
1053                 if (argc == 1)
1054                         return JIM_OK;
1055                 argc--;
1056                 argv++;
1057         }
1058         script_debug(interp, cmd_name, argc, argv);
1059
1060         struct command_context *cmd_ctx = current_command_context(interp);
1061         struct command *c = cmd_ctx->commands;
1062         int remaining = command_unknown_find(argc, argv, c, &c, true);
1063         // if nothing could be consumed, then it's really an unknown command
1064         if (remaining == argc)
1065         {
1066                 const char *cmd = Jim_GetString(argv[0], NULL);
1067                 LOG_ERROR("Unknown command:\n  %s", cmd);
1068                 return JIM_OK;
1069         }
1070
1071         bool found = true;
1072         Jim_Obj *const *start;
1073         unsigned count;
1074         if (c->handler || c->jim_handler)
1075         {
1076                 // include the command name in the list
1077                 count = remaining + 1;
1078                 start = argv + (argc - remaining - 1);
1079         }
1080         else
1081         {
1082                 c = command_find(cmd_ctx->commands, "usage");
1083                 if (NULL == c)
1084                 {
1085                         LOG_ERROR("unknown command, but usage is missing too");
1086                         return JIM_ERR;
1087                 }
1088                 count = argc - remaining;
1089                 start = argv;
1090                 found = false;
1091         }
1092         // pass the command through to the intended handler
1093         if (c->jim_handler)
1094         {
1095                 interp->cmdPrivData = c->jim_handler_data;
1096                 return (*c->jim_handler)(interp, count, start);
1097         }
1098
1099         return script_command_run(interp, count, start, c, found);
1100 }
1101
1102 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1103 {
1104         struct command_context *cmd_ctx = current_command_context(interp);
1105         enum command_mode mode;
1106
1107         if (argc > 1)
1108         {
1109                 struct command *c = cmd_ctx->commands;
1110                 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1111                 // if nothing could be consumed, then it's an unknown command
1112                 if (remaining == argc - 1)
1113                 {
1114                         Jim_SetResultString(interp, "unknown", -1);
1115                         return JIM_OK;
1116                 }
1117                 mode = c->mode;
1118         }
1119         else
1120                 mode = cmd_ctx->mode;
1121
1122         const char *mode_str;
1123         switch (mode) {
1124         case COMMAND_ANY: mode_str = "any"; break;
1125         case COMMAND_CONFIG: mode_str = "config"; break;
1126         case COMMAND_EXEC: mode_str = "exec"; break;
1127         default: mode_str = "unknown"; break;
1128         }
1129         Jim_SetResultString(interp, mode_str, -1);
1130         return JIM_OK;
1131 }
1132
1133 static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1134 {
1135         if (1 == argc)
1136                 return JIM_ERR;
1137
1138         struct command_context *cmd_ctx = current_command_context(interp);
1139         struct command *c = cmd_ctx->commands;
1140         int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1141         // if nothing could be consumed, then it's an unknown command
1142         if (remaining == argc - 1)
1143         {
1144                 Jim_SetResultString(interp, "unknown", -1);
1145                 return JIM_OK;
1146         }
1147
1148         if (c->jim_handler)
1149                 Jim_SetResultString(interp, "native", -1);
1150         else if (c->handler)
1151                 Jim_SetResultString(interp, "simple", -1);
1152         else
1153                 Jim_SetResultString(interp, "group", -1);
1154
1155         return JIM_OK;
1156 }
1157
1158 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
1159                 const char *cmd_name, const char *help_text, const char *usage)
1160 {
1161         struct command **head = command_list_for_parent(cmd_ctx, parent);
1162         struct command *nc = command_find(*head, cmd_name);
1163         if (NULL == nc)
1164         {
1165                 // add a new command with help text
1166                 struct command_registration cr = {
1167                                 .name = cmd_name,
1168                                 .mode = COMMAND_ANY,
1169                                 .help = help_text,
1170                                 .usage = usage,
1171                         };
1172                 nc = register_command(cmd_ctx, parent, &cr);
1173                 if (NULL == nc)
1174                 {
1175                         LOG_ERROR("failed to add '%s' help text", cmd_name);
1176                         return ERROR_FAIL;
1177                 }
1178                 LOG_DEBUG("added '%s' help text", cmd_name);
1179                 return ERROR_OK;
1180         }
1181         if (help_text)
1182         {
1183                 bool replaced = false;
1184                 if (nc->help)
1185                 {
1186                         free((void *)nc->help);
1187                         replaced = true;
1188                 }
1189                 nc->help = strdup(help_text);
1190                 if (replaced)
1191                         LOG_INFO("replaced existing '%s' help", cmd_name);
1192                 else
1193                         LOG_DEBUG("added '%s' help text", cmd_name);
1194         }
1195         if (usage)
1196         {
1197                 bool replaced = false;
1198                 if (nc->usage)
1199                 {
1200                         free((void *)nc->usage);
1201                         replaced = true;
1202                 }
1203                 nc->usage = strdup(usage);
1204                 if (replaced)
1205                         LOG_INFO("replaced existing '%s' usage", cmd_name);
1206                 else
1207                         LOG_DEBUG("added '%s' usage text", cmd_name);
1208         }
1209         return ERROR_OK;
1210 }
1211
1212 COMMAND_HANDLER(handle_help_add_command)
1213 {
1214         if (CMD_ARGC < 2)
1215         {
1216                 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1217                 return ERROR_INVALID_ARGUMENTS;
1218         }
1219
1220         // save help text and remove it from argument list
1221         const char *str = CMD_ARGV[--CMD_ARGC];
1222         const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1223         const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1224         if (!help && !usage)
1225         {
1226                 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1227                 return ERROR_INVALID_ARGUMENTS;
1228         }
1229         // likewise for the leaf command name
1230         const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1231
1232         struct command *c = NULL;
1233         if (CMD_ARGC > 0)
1234         {
1235                 c = CMD_CTX->commands;
1236                 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1237                 if (ERROR_OK != retval)
1238                         return retval;
1239         }
1240         return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1241 }
1242
1243 /* sleep command sleeps for <n> milliseconds
1244  * this is useful in target startup scripts
1245  */
1246 COMMAND_HANDLER(handle_sleep_command)
1247 {
1248         bool busy = false;
1249         if (CMD_ARGC == 2)
1250         {
1251                 if (strcmp(CMD_ARGV[1], "busy") == 0)
1252                         busy = true;
1253                 else
1254                         return ERROR_COMMAND_SYNTAX_ERROR;
1255         }
1256         else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1257                 return ERROR_COMMAND_SYNTAX_ERROR;
1258
1259         unsigned long duration = 0;
1260         int retval = parse_ulong(CMD_ARGV[0], &duration);
1261         if (ERROR_OK != retval)
1262                 return retval;
1263
1264         if (!busy)
1265         {
1266                 long long then = timeval_ms();
1267                 while (timeval_ms() - then < (long long)duration)
1268                 {
1269                         target_call_timer_callbacks_now();
1270                         usleep(1000);
1271                 }
1272         }
1273         else
1274                 busy_sleep(duration);
1275
1276         return ERROR_OK;
1277 }
1278
1279 static const struct command_registration command_subcommand_handlers[] = {
1280         {
1281                 .name = "mode",
1282                 .mode = COMMAND_ANY,
1283                 .jim_handler = jim_command_mode,
1284                 .usage = "[command_name ...]",
1285                 .help = "Returns the command modes allowed by a  command:"
1286                         "'any', 'config', or 'exec'.  If no command is"
1287                         "specified, returns the current command mode.  "
1288                         "Returns 'unknown' if an unknown command is given. "
1289                         "Command can be multiple tokens.",
1290         },
1291         {
1292                 .name = "type",
1293                 .mode = COMMAND_ANY,
1294                 .jim_handler = jim_command_type,
1295                 .usage = "command_name [...]",
1296                 .help = "Returns the type of built-in command:"
1297                         "'native', 'simple', 'group', or 'unknown'. "
1298                         "Command can be multiple tokens.",
1299         },
1300         COMMAND_REGISTRATION_DONE
1301 };
1302
1303 static const struct command_registration command_builtin_handlers[] = {
1304         {
1305                 .name = "add_help_text",
1306                 .handler = handle_help_add_command,
1307                 .mode = COMMAND_ANY,
1308                 .help = "Add new command help text; "
1309                         "Command can be multiple tokens.",
1310                 .usage = "command_name helptext_string",
1311         },
1312         {
1313                 .name = "add_usage_text",
1314                 .handler = handle_help_add_command,
1315                 .mode = COMMAND_ANY,
1316                 .help = "Add new command usage text; "
1317                         "command can be multiple tokens.",
1318                 .usage = "command_name usage_string",
1319         },
1320         {
1321                 .name = "sleep",
1322                 .handler = handle_sleep_command,
1323                 .mode = COMMAND_ANY,
1324                 .help = "Sleep for specified number of milliseconds.  "
1325                         "\"busy\" will busy wait instead (avoid this).",
1326                 .usage = "milliseconds ['busy']",
1327         },
1328         {
1329                 .name = "help",
1330                 .handler = handle_help_command,
1331                 .mode = COMMAND_ANY,
1332                 .help = "Show full command help; "
1333                         "command can be multiple tokens.",
1334                 .usage = "[command_name]",
1335         },
1336         {
1337                 .name = "usage",
1338                 .handler = handle_help_command,
1339                 .mode = COMMAND_ANY,
1340                 .help = "Show basic command usage; "
1341                         "command can be multiple tokens.",
1342                 .usage = "[command_name]",
1343         },
1344         {
1345                 .name = "command",
1346                 .mode= COMMAND_ANY,
1347                 .help = "core command group (introspection)",
1348                 .chain = command_subcommand_handlers,
1349         },
1350         COMMAND_REGISTRATION_DONE
1351 };
1352
1353 struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp)
1354 {
1355         struct command_context* context = malloc(sizeof(struct command_context));
1356         const char *HostOs;
1357
1358         context->mode = COMMAND_EXEC;
1359         context->commands = NULL;
1360         context->current_target = 0;
1361         context->output_handler = NULL;
1362         context->output_handler_priv = NULL;
1363
1364 #if !BUILD_ECOSBOARD
1365         /* Create a jim interpreter if we were not handed one */
1366         if (interp == NULL)
1367         {
1368                 Jim_InitEmbedded();
1369                 /* Create an interpreter */
1370                 interp = Jim_CreateInterp();
1371                 /* Add all the Jim core commands */
1372                 Jim_RegisterCoreCommands(interp);
1373         }
1374 #endif
1375         context->interp = interp;
1376
1377         /* Stick to lowercase for HostOS strings. */
1378 #if defined(_MSC_VER)
1379         /* WinXX - is generic, the forward
1380          * looking problem is this:
1381          *
1382          *   "win32" or "win64"
1383          *
1384          * "winxx" is generic.
1385          */
1386         HostOs = "winxx";
1387 #elif defined(__linux__)
1388         HostOs = "linux";
1389 #elif defined(__APPLE__) || defined(__DARWIN__)
1390         HostOs = "darwin";
1391 #elif defined(__CYGWIN__)
1392         HostOs = "cygwin";
1393 #elif defined(__MINGW32__)
1394         HostOs = "mingw32";
1395 #elif defined(__ECOS)
1396         HostOs = "ecos";
1397 #elif defined(__FreeBSD__)
1398         HostOs = "freebsd";
1399 #else
1400 #warning "Unrecognized host OS..."
1401         HostOs = "other";
1402 #endif
1403         Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1404                         Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
1405
1406         Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1407         Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
1408         Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1409
1410         /* Set Jim's STDIO */
1411         interp->cookie_stdin = interp;
1412         interp->cookie_stdout = interp;
1413         interp->cookie_stderr = interp;
1414         interp->cb_fwrite = openocd_jim_fwrite;
1415         interp->cb_fread = openocd_jim_fread ;
1416         interp->cb_vfprintf = openocd_jim_vfprintf;
1417         interp->cb_fflush = openocd_jim_fflush;
1418         interp->cb_fgets = openocd_jim_fgets;
1419
1420         register_commands(context, NULL, command_builtin_handlers);
1421
1422 #if !BUILD_ECOSBOARD
1423         Jim_EventLoopOnLoad(interp);
1424 #endif
1425         Jim_SetAssocData(interp, "context", NULL, context);
1426         if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
1427         {
1428                 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1429                 Jim_PrintErrorMessage(interp);
1430                 exit(-1);
1431         }
1432         Jim_DeleteAssocData(interp, "context");
1433
1434         return context;
1435 }
1436
1437 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1438 {
1439         if (!cmd_ctx)
1440                 return ERROR_INVALID_ARGUMENTS;
1441
1442         cmd_ctx->mode = mode;
1443         return ERROR_OK;
1444 }
1445
1446 void process_jim_events(struct command_context *cmd_ctx)
1447 {
1448 #if !BUILD_ECOSBOARD
1449         static int recursion = 0;
1450         if (recursion)
1451                 return;
1452
1453         recursion++;
1454         Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1455         recursion--;
1456 #endif
1457 }
1458
1459 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1460         int parse##name(const char *str, type *ul) \
1461         { \
1462                 if (!*str) \
1463                 { \
1464                         LOG_ERROR("Invalid command argument"); \
1465                         return ERROR_COMMAND_ARGUMENT_INVALID; \
1466                 } \
1467                 char *end; \
1468                 *ul = func(str, &end, 0); \
1469                 if (*end) \
1470                 { \
1471                         LOG_ERROR("Invalid command argument"); \
1472                         return ERROR_COMMAND_ARGUMENT_INVALID; \
1473                 } \
1474                 if ((max == *ul) && (ERANGE == errno)) \
1475                 { \
1476                         LOG_ERROR("Argument overflow"); \
1477                         return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1478                 } \
1479                 if (min && (min == *ul) && (ERANGE == errno)) \
1480                 { \
1481                         LOG_ERROR("Argument underflow"); \
1482                         return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1483                 } \
1484                 return ERROR_OK; \
1485         }
1486 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
1487 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1488 DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
1489 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1490
1491 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1492         int parse##name(const char *str, type *ul) \
1493         { \
1494                 functype n; \
1495                 int retval = parse##funcname(str, &n); \
1496                 if (ERROR_OK != retval) \
1497                         return retval; \
1498                 if (n > max) \
1499                         return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1500                 if (min) \
1501                         return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1502                 *ul = n; \
1503                 return ERROR_OK; \
1504         }
1505
1506 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1507         DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1508 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
1509 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
1510 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
1511 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
1512
1513 #define DEFINE_PARSE_LONG(name, type, min, max) \
1514         DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1515 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
1516 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1517 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1518 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1519
1520 static int command_parse_bool(const char *in, bool *out,
1521                 const char *on, const char *off)
1522 {
1523         if (strcasecmp(in, on) == 0)
1524                 *out = true;
1525         else if (strcasecmp(in, off) == 0)
1526                 *out = false;
1527         else
1528                 return ERROR_COMMAND_SYNTAX_ERROR;
1529         return  ERROR_OK;
1530 }
1531
1532 int command_parse_bool_arg(const char *in, bool *out)
1533 {
1534         if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1535                 return ERROR_OK;
1536         if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1537                 return ERROR_OK;
1538         if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1539                 return ERROR_OK;
1540         if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1541                 return ERROR_OK;
1542         if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1543                 return ERROR_OK;
1544         return ERROR_INVALID_ARGUMENTS;
1545 }
1546
1547 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1548 {
1549         switch (CMD_ARGC) {
1550         case 1: {
1551                 const char *in = CMD_ARGV[0];
1552                 if (command_parse_bool_arg(in, out) != ERROR_OK)
1553                 {
1554                         LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1555                         return ERROR_INVALID_ARGUMENTS;
1556                 }
1557                 // fall through
1558         }
1559         case 0:
1560                 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1561                 break;
1562         default:
1563                 return ERROR_INVALID_ARGUMENTS;
1564         }
1565         return ERROR_OK;
1566 }