git.gag.com Git - fw/openocd/blob - src/helper/command.c

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