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

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