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