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