git.gag.com Git - fw/openocd/blob - src/helper/command.c

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