src/helper/command.c

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