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