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