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