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