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