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