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