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