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