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