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