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