* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * along with this program. If not, see <http://www.gnu.org/licenses/>. *
***************************************************************************/
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
-#if !BUILD_ECOSBOARD
-/* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
+/* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
#define JIM_EMBEDDED
-#endif
-// @todo the inclusion of target.h here is a layering violation
+/* @todo the inclusion of target.h here is a layering violation */
#include <jtag/jtag.h>
#include <target/target.h>
#include "command.h"
#include "time_support.h"
#include "jim-eventloop.h"
-
/* nice short description of source file */
#define __THIS__FILE__ "command.c"
-
-static int run_command(struct command_context *context,
- struct command *c, const char *words[], unsigned num_words);
-
struct log_capture_state {
Jim_Interp *interp;
Jim_Obj *output;
};
+static int unregister_command(struct command_context *context,
+ const char *cmd_prefix, const char *name);
+static int jim_command_dispatch(Jim_Interp *interp, int argc, Jim_Obj * const *argv);
+static int help_add_command(struct command_context *cmd_ctx,
+ const char *cmd_name, const char *help_text, const char *usage_text);
+static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name);
+
+/* set of functions to wrap jimtcl internal data */
+static inline bool jimcmd_is_proc(Jim_Cmd *cmd)
+{
+ return cmd->isproc;
+}
+
+bool jimcmd_is_oocd_command(Jim_Cmd *cmd)
+{
+ return !cmd->isproc && cmd->u.native.cmdProc == jim_command_dispatch;
+}
+
+void *jimcmd_privdata(Jim_Cmd *cmd)
+{
+ return cmd->isproc ? NULL : cmd->u.native.privData;
+}
+
static void tcl_output(void *privData, const char *file, unsigned line,
- const char *function, const char *string)
+ const char *function, const char *string)
{
- struct log_capture_state *state = (struct log_capture_state *)privData;
+ struct log_capture_state *state = privData;
Jim_AppendString(state->interp, state->output, string, strlen(string));
}
{
/* capture log output and return it. A garbage collect can
* happen, so we need a reference count to this object */
- Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
- if (NULL == tclOutput)
+ Jim_Obj *jim_output = Jim_NewStringObj(interp, "", 0);
+ if (!jim_output)
return NULL;
+ Jim_IncrRefCount(jim_output);
+
struct log_capture_state *state = malloc(sizeof(*state));
- if (NULL == state)
+ if (!state) {
+ LOG_ERROR("Out of memory");
+ Jim_DecrRefCount(interp, jim_output);
return NULL;
+ }
state->interp = interp;
- Jim_IncrRefCount(tclOutput);
- state->output = tclOutput;
+ state->output = jim_output;
log_add_callback(tcl_output, state);
* Therefore we set the tcl return value only if we actually
* captured output.
*/
-static void command_log_capture_finish(struct log_capture_state *state)
+static void command_log_capture_finish(struct log_capture_state *state)
{
- if (NULL == state)
+ if (!state)
return;
log_remove_callback(tcl_output, state);
Jim_GetString(state->output, &length);
if (length > 0)
- {
Jim_SetResult(state->interp, state->output);
- } else
- {
+ else {
/* No output captured, use tcl return value (which could
* be empty too). */
}
static int command_retval_set(Jim_Interp *interp, int retval)
{
int *return_retval = Jim_GetAssocData(interp, "retval");
- if (return_retval != NULL)
+ if (return_retval)
*return_retval = retval;
- return (retval == ERROR_OK) ? JIM_OK : JIM_ERR;
+ return (retval == ERROR_OK) ? JIM_OK : retval;
}
extern struct command_context *global_cmd_ctx;
/* dump a single line to the log for the command.
* Do nothing in case we are not at debug level 3 */
-void script_debug(Jim_Interp *interp, const char *name,
- unsigned argc, Jim_Obj *const *argv)
+static void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv)
{
if (debug_level < LOG_LVL_DEBUG)
return;
- char * dbg = alloc_printf("command - %s", name);
- for (unsigned i = 0; i < argc; i++)
- {
+ char *dbg = alloc_printf("command -");
+ for (unsigned i = 0; i < argc; i++) {
int len;
const char *w = Jim_GetString(argv[i], &len);
- char * t = alloc_printf("%s %s", dbg, w);
- free (dbg);
+ char *t = alloc_printf("%s %s", dbg, w);
+ free(dbg);
dbg = t;
}
LOG_DEBUG("%s", dbg);
free(dbg);
}
-static void script_command_args_free(const char **words, unsigned nwords)
+static void script_command_args_free(char **words, unsigned nwords)
{
for (unsigned i = 0; i < nwords; i++)
- free((void *)words[i]);
+ free(words[i]);
free(words);
}
-static const char **script_command_args_alloc(
- unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
+
+static char **script_command_args_alloc(
+ unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
{
- const char **words = malloc(argc * sizeof(char *));
- if (NULL == words)
+ char **words = malloc(argc * sizeof(char *));
+ if (!words)
return NULL;
unsigned i;
- for (i = 0; i < argc; i++)
- {
+ for (i = 0; i < argc; i++) {
int len;
const char *w = Jim_GetString(argv[i], &len);
words[i] = strdup(w);
- if (words[i] == NULL)
- {
+ if (!words[i]) {
script_command_args_free(words, i);
return NULL;
}
{
/* grab the command context from the associated data */
struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
- if (NULL == cmd_ctx)
- {
+ if (!cmd_ctx) {
/* Tcl can invoke commands directly instead of via command_run_line(). This would
* happen when the Jim Tcl interpreter is provided by eCos or if we are running
* commands in a startup script.
return cmd_ctx;
}
-static int script_command_run(Jim_Interp *interp,
- int argc, Jim_Obj *const *argv, struct command *c, bool capture)
-{
- target_call_timer_callbacks_now();
- LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
-
- unsigned nwords;
- const char **words = script_command_args_alloc(argc, argv, &nwords);
- if (NULL == words)
- return JIM_ERR;
-
- struct log_capture_state *state = NULL;
- if (capture)
- state = command_log_capture_start(interp);
-
- struct command_context *cmd_ctx = current_command_context(interp);
- int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
-
- command_log_capture_finish(state);
-
- script_command_args_free(words, nwords);
- return command_retval_set(interp, retval);
-}
-
-static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
- /* the private data is stashed in the interp structure */
-
- struct command *c = interp->cmdPrivData;
- assert(c);
- script_debug(interp, c->name, argc, argv);
- return script_command_run(interp, argc, argv, c, true);
-}
-
-static struct command *command_root(struct command *c)
-{
- while (NULL != c->parent)
- c = c->parent;
- return c;
-}
-
/**
- * Find a command by name from a list of commands.
- * @returns Returns the named command if it exists in the list.
+ * Find a openocd command from fullname.
+ * @returns Returns the named command if it is registred in interp.
* Returns NULL otherwise.
*/
-static struct command *command_find(struct command *head, const char *name)
-{
- for (struct command *cc = head; cc; cc = cc->next)
- {
- if (strcmp(cc->name, name) == 0)
- return cc;
- }
- return NULL;
-}
-struct command *command_find_in_context(struct command_context *cmd_ctx,
- const char *name)
-{
- return command_find(cmd_ctx->commands, name);
-}
-struct command *command_find_in_parent(struct command *parent,
- const char *name)
-{
- return command_find(parent->children, name);
-}
-
-/**
- * Add the command into the linked list, sorted by name.
- * @param head Address to head of command list pointer, which may be
- * updated if @c c gets inserted at the beginning of the list.
- * @param c The command to add to the list pointed to by @c head.
- */
-static void command_add_child(struct command **head, struct command *c)
-{
- assert(head);
- if (NULL == *head)
- {
- *head = c;
- return;
- }
-
- while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
- head = &(*head)->next;
-
- if (strcmp(c->name, (*head)->name) > 0) {
- c->next = (*head)->next;
- (*head)->next = c;
- } else {
- c->next = *head;
- *head = c;
- }
-}
-
-static struct command **command_list_for_parent(
- struct command_context *cmd_ctx, struct command *parent)
-{
- return parent ? &parent->children : &cmd_ctx->commands;
-}
-
-static void command_free(struct command *c)
+static struct command *command_find_from_name(Jim_Interp *interp, const char *name)
{
- /// @todo if command has a handler, unregister its jim command!
+ if (!name)
+ return NULL;
- while (NULL != c->children)
- {
- struct command *tmp = c->children;
- c->children = tmp->next;
- command_free(tmp);
- }
+ Jim_Obj *jim_name = Jim_NewStringObj(interp, name, -1);
+ Jim_IncrRefCount(jim_name);
+ Jim_Cmd *cmd = Jim_GetCommand(interp, jim_name, JIM_NONE);
+ Jim_DecrRefCount(interp, jim_name);
+ if (!cmd || jimcmd_is_proc(cmd) || !jimcmd_is_oocd_command(cmd))
+ return NULL;
- if (c->name)
- free((void *)c->name);
- if (c->help)
- free((void*)c->help);
- if (c->usage)
- free((void*)c->usage);
- free(c);
+ return jimcmd_privdata(cmd);
}
static struct command *command_new(struct command_context *cmd_ctx,
- struct command *parent, const struct command_registration *cr)
+ const char *full_name, const struct command_registration *cr)
{
assert(cr->name);
+ /*
+ * If it is a non-jim command with no .usage specified,
+ * log an error.
+ *
+ * strlen(.usage) == 0 means that the command takes no
+ * arguments.
+ */
+ if (!cr->jim_handler && !cr->usage)
+ LOG_ERROR("BUG: command '%s' does not have the "
+ "'.usage' field filled out",
+ full_name);
+
struct command *c = calloc(1, sizeof(struct command));
- if (NULL == c)
+ if (!c)
return NULL;
c->name = strdup(cr->name);
- if (cr->help)
- c->help = strdup(cr->help);
- if (cr->usage)
- c->usage = strdup(cr->usage);
-
- if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
- goto command_new_error;
+ if (!c->name) {
+ free(c);
+ return NULL;
+ }
- c->parent = parent;
c->handler = cr->handler;
c->jim_handler = cr->jim_handler;
- c->jim_handler_data = cr->jim_handler_data;
c->mode = cr->mode;
- command_add_child(command_list_for_parent(cmd_ctx, parent), c);
+ if (cr->help || cr->usage)
+ help_add_command(cmd_ctx, full_name, cr->help, cr->usage);
return c;
-
-command_new_error:
- command_free(c);
- return NULL;
}
-static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
-
-static int register_command_handler(struct command_context *cmd_ctx,
- struct command *c)
+static void command_free(struct Jim_Interp *interp, void *priv)
{
- Jim_Interp *interp = cmd_ctx->interp;
- const char *ocd_name = alloc_printf("ocd_%s", c->name);
- if (NULL == ocd_name)
- return JIM_ERR;
-
- LOG_DEBUG("registering '%s'...", ocd_name);
+ struct command *c = priv;
- Jim_CmdProc func = c->handler ? &script_command : &command_unknown;
- int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
- free((void *)ocd_name);
- if (JIM_OK != retval)
- return retval;
-
- /* we now need to add an overrideable proc */
- const char *override_name = alloc_printf(
- "proc %s {args} {eval ocd_bouncer %s $args}",
- c->name, c->name);
- if (NULL == override_name)
- return JIM_ERR;
-
- retval = Jim_Eval_Named(interp, override_name, 0, 0);
- free((void *)override_name);
-
- return retval;
+ free(c->name);
+ free(c);
}
-struct command* register_command(struct command_context *context,
- struct command *parent, const struct command_registration *cr)
+static struct command *register_command(struct command_context *context,
+ const char *cmd_prefix, const struct command_registration *cr)
{
+ char *full_name;
+
if (!context || !cr->name)
return NULL;
- const char *name = cr->name;
- struct command **head = command_list_for_parent(context, parent);
- struct command *c = command_find(*head, name);
- if (NULL != c)
- {
+ if (cmd_prefix)
+ full_name = alloc_printf("%s %s", cmd_prefix, cr->name);
+ else
+ full_name = strdup(cr->name);
+ if (!full_name)
+ return NULL;
+
+ struct command *c = command_find_from_name(context->interp, full_name);
+ if (c) {
/* TODO: originally we treated attempting to register a cmd twice as an error
* Sometimes we need this behaviour, such as with flash banks.
* http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
- LOG_DEBUG("command '%s' is already registered in '%s' context",
- name, parent ? parent->name : "<global>");
+ LOG_DEBUG("command '%s' is already registered", full_name);
+ free(full_name);
return c;
}
- c = command_new(context, parent, cr);
- if (NULL == c)
+ c = command_new(context, full_name, cr);
+ if (!c) {
+ free(full_name);
return NULL;
-
- int retval = ERROR_OK;
- if (NULL != cr->jim_handler && NULL == parent)
- {
- retval = Jim_CreateCommand(context->interp, cr->name,
- cr->jim_handler, cr->jim_handler_data, NULL);
}
- else if (NULL != cr->handler || NULL != parent)
- retval = register_command_handler(context, command_root(c));
- if (ERROR_OK != retval)
- {
- unregister_command(context, parent, name);
- c = NULL;
+ if (false) /* too noisy with debug_level 3 */
+ LOG_DEBUG("registering '%s'...", full_name);
+ int retval = Jim_CreateCommand(context->interp, full_name,
+ jim_command_dispatch, c, command_free);
+ if (retval != JIM_OK) {
+ command_run_linef(context, "del_help_text {%s}", full_name);
+ command_run_linef(context, "del_usage_text {%s}", full_name);
+ free(c);
+ free(full_name);
+ return NULL;
}
+
+ free(full_name);
return c;
}
-int register_commands(struct command_context *cmd_ctx, struct command *parent,
- const struct command_registration *cmds)
+int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
+ const struct command_registration *cmds, void *data,
+ struct target *override_target)
{
int retval = ERROR_OK;
unsigned i;
- for (i = 0; cmds[i].name || cmds[i].chain; i++)
- {
+ for (i = 0; cmds[i].name || cmds[i].chain; i++) {
const struct command_registration *cr = cmds + i;
struct command *c = NULL;
- if (NULL != cr->name)
- {
- c = register_command(cmd_ctx, parent, cr);
- if (NULL == c)
- {
+ if (cr->name) {
+ c = register_command(cmd_ctx, cmd_prefix, cr);
+ if (!c) {
retval = ERROR_FAIL;
break;
}
+ c->jim_handler_data = data;
+ c->jim_override_target = override_target;
}
- if (NULL != cr->chain)
- {
- struct command *p = c ? : parent;
- retval = register_commands(cmd_ctx, p, cr->chain);
- if (ERROR_OK != retval)
+ if (cr->chain) {
+ if (cr->name) {
+ if (cmd_prefix) {
+ char *new_prefix = alloc_printf("%s %s", cmd_prefix, cr->name);
+ if (!new_prefix) {
+ retval = ERROR_FAIL;
+ break;
+ }
+ retval = __register_commands(cmd_ctx, new_prefix, cr->chain, data, override_target);
+ free(new_prefix);
+ } else {
+ retval = __register_commands(cmd_ctx, cr->name, cr->chain, data, override_target);
+ }
+ } else {
+ retval = __register_commands(cmd_ctx, cmd_prefix, cr->chain, data, override_target);
+ }
+ if (retval != ERROR_OK)
break;
}
}
- if (ERROR_OK != retval)
- {
+ if (retval != ERROR_OK) {
for (unsigned j = 0; j < i; j++)
- unregister_command(cmd_ctx, parent, cmds[j].name);
+ unregister_command(cmd_ctx, cmd_prefix, cmds[j].name);
}
return retval;
}
-int unregister_all_commands(struct command_context *context,
- struct command *parent)
+static __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)))
+int unregister_commands_match(struct command_context *cmd_ctx, const char *format, ...)
{
- if (context == NULL)
- return ERROR_OK;
+ Jim_Interp *interp = cmd_ctx->interp;
+ va_list ap;
- struct command **head = command_list_for_parent(context, parent);
- while (NULL != *head)
- {
- struct command *tmp = *head;
- *head = tmp->next;
- command_free(tmp);
- }
+ va_start(ap, format);
+ char *query = alloc_vprintf(format, ap);
+ va_end(ap);
+ if (!query)
+ return ERROR_FAIL;
- return ERROR_OK;
-}
+ char *query_cmd = alloc_printf("info commands {%s}", query);
+ free(query);
+ if (!query_cmd)
+ return ERROR_FAIL;
-int unregister_command(struct command_context *context,
- struct command *parent, const char *name)
-{
- if ((!context) || (!name))
- return ERROR_INVALID_ARGUMENTS;
+ int retval = Jim_EvalSource(interp, __THIS__FILE__, __LINE__, query_cmd);
+ free(query_cmd);
+ if (retval != JIM_OK)
+ return ERROR_FAIL;
- struct command *p = NULL;
- struct command **head = command_list_for_parent(context, parent);
- for (struct command *c = *head; NULL != c; p = c, c = c->next)
- {
- if (strcmp(name, c->name) != 0)
+ Jim_Obj *list = Jim_GetResult(interp);
+ Jim_IncrRefCount(list);
+
+ int len = Jim_ListLength(interp, list);
+ for (int i = 0; i < len; i++) {
+ Jim_Obj *elem = Jim_ListGetIndex(interp, list, i);
+ Jim_IncrRefCount(elem);
+
+ const char *name = Jim_GetString(elem, NULL);
+ struct command *c = command_find_from_name(interp, name);
+ if (!c) {
+ /* not openocd command */
+ Jim_DecrRefCount(interp, elem);
continue;
+ }
+ if (false) /* too noisy with debug_level 3 */
+ LOG_DEBUG("delete command \"%s\"", name);
+#if JIM_VERSION >= 80
+ Jim_DeleteCommand(interp, elem);
+#else
+ Jim_DeleteCommand(interp, name);
+#endif
- if (p)
- p->next = c->next;
- else
- *head = c->next;
+ help_del_command(cmd_ctx, name);
- command_free(c);
- return ERROR_OK;
+ Jim_DecrRefCount(interp, elem);
}
+ Jim_DecrRefCount(interp, list);
return ERROR_OK;
}
-void command_set_handler_data(struct command *c, void *p)
+int unregister_all_commands(struct command_context *context,
+ const char *cmd_prefix)
{
- if (NULL != c->handler || NULL != c->jim_handler)
- c->jim_handler_data = p;
- for (struct command *cc = c->children; NULL != cc; cc = cc->next)
- command_set_handler_data(cc, p);
+ if (!context)
+ return ERROR_OK;
+
+ if (!cmd_prefix || !*cmd_prefix)
+ return unregister_commands_match(context, "*");
+
+ int retval = unregister_commands_match(context, "%s *", cmd_prefix);
+ if (retval != ERROR_OK)
+ return retval;
+
+ return unregister_commands_match(context, "%s", cmd_prefix);
+}
+
+static int unregister_command(struct command_context *context,
+ const char *cmd_prefix, const char *name)
+{
+ if (!context || !name)
+ return ERROR_COMMAND_SYNTAX_ERROR;
+
+ if (!cmd_prefix || !*cmd_prefix)
+ return unregister_commands_match(context, "%s", name);
+
+ return unregister_commands_match(context, "%s %s", cmd_prefix, name);
}
void command_output_text(struct command_context *context, const char *data)
{
- if (context && context->output_handler && data) {
+ if (context && context->output_handler && data)
context->output_handler(context, data);
- }
}
-void command_print_sameline(struct command_context *context, const char *format, ...)
+void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
{
char *string;
va_start(ap, format);
string = alloc_vprintf(format, ap);
- if (string != NULL)
- {
+ if (string && cmd) {
/* we want this collected in the log + we also want to pick it up as a tcl return
* value.
*
* The latter bit isn't precisely neat, but will do for now.
*/
- LOG_USER_N("%s", string);
- /* We already printed it above */
- /* command_output_text(context, string); */
+ Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
+ /* We already printed it above
+ * command_output_text(context, string); */
free(string);
}
va_end(ap);
}
-void command_print(struct command_context *context, const char *format, ...)
+void command_print(struct command_invocation *cmd, const char *format, ...)
{
char *string;
va_start(ap, format);
string = alloc_vprintf(format, ap);
- if (string != NULL)
- {
- strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
+ if (string && cmd) {
+ strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
+ *char longer */
/* we want this collected in the log + we also want to pick it up as a tcl return
* value.
*
* The latter bit isn't precisely neat, but will do for now.
*/
- LOG_USER_N("%s", string);
- /* We already printed it above */
- /* command_output_text(context, string); */
+ Jim_AppendString(cmd->ctx->interp, cmd->output, string, -1);
+ /* We already printed it above
+ * command_output_text(context, string); */
free(string);
}
va_end(ap);
}
-static char *__command_name(struct command *c, char delim, unsigned extra)
+static bool command_can_run(struct command_context *cmd_ctx, struct command *c, const char *full_name)
{
- char *name;
- unsigned len = strlen(c->name);
- if (NULL == c->parent) {
- // allocate enough for the name, child names, and '\0'
- name = malloc(len + extra + 1);
- strcpy(name, c->name);
- } else {
- // parent's extra must include both the space and name
- name = __command_name(c->parent, delim, 1 + len + extra);
- char dstr[2] = { delim, 0 };
- strcat(name, dstr);
- strcat(name, c->name);
+ if (c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode)
+ return true;
+
+ /* Many commands may be run only before/after 'init' */
+ const char *when;
+ switch (c->mode) {
+ case COMMAND_CONFIG:
+ when = "before";
+ break;
+ case COMMAND_EXEC:
+ when = "after";
+ break;
+ /* handle the impossible with humor; it guarantees a bug report! */
+ default:
+ when = "if Cthulhu is summoned by";
+ break;
}
- return name;
-}
-char *command_name(struct command *c, char delim)
-{
- return __command_name(c, delim, 0);
-}
-
-static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
-{
- return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
+ LOG_ERROR("The '%s' command must be used %s 'init'.",
+ full_name ? full_name : c->name, when);
+ return false;
}
static int run_command(struct command_context *context,
- struct command *c, const char *words[], unsigned num_words)
+ struct command *c, const char **words, unsigned num_words)
{
- if (!command_can_run(context, c))
- {
- /* Many commands may be run only before/after 'init' */
- const char *when;
- switch (c->mode) {
- case COMMAND_CONFIG: when = "before"; break;
- case COMMAND_EXEC: when = "after"; break;
- // handle the impossible with humor; it guarantees a bug report!
- default: when = "if Cthulhu is summoned by"; break;
- }
- LOG_ERROR("The '%s' command must be used %s 'init'.",
- c->name, when);
- return ERROR_FAIL;
- }
-
struct command_invocation cmd = {
- .ctx = context,
- .current = c,
- .name = c->name,
- .argc = num_words - 1,
- .argv = words + 1,
- };
+ .ctx = context,
+ .current = c,
+ .name = c->name,
+ .argc = num_words - 1,
+ .argv = words + 1,
+ };
+
+ cmd.output = Jim_NewEmptyStringObj(context->interp);
+ Jim_IncrRefCount(cmd.output);
+
int retval = c->handler(&cmd);
- if (retval == ERROR_COMMAND_SYNTAX_ERROR)
- {
+ if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
/* Print help for command */
- char *full_name = command_name(c, ' ');
- if (NULL != full_name) {
- command_run_linef(context, "usage %s", full_name);
- free(full_name);
- } else
- retval = -ENOMEM;
- }
- else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
- {
+ command_run_linef(context, "usage %s", words[0]);
+ } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) {
/* just fall through for a shutdown request */
+ } else {
+ if (retval != ERROR_OK)
+ LOG_DEBUG("Command '%s' failed with error code %d",
+ words[0], retval);
+ /* Use the command output as the Tcl result */
+ Jim_SetResult(context->interp, cmd.output);
}
- else if (retval != ERROR_OK)
- {
- /* we do not print out an error message because the command *should*
- * have printed out an error
- */
- LOG_DEBUG("Command failed with error code %d", retval);
- }
+ Jim_DecrRefCount(context->interp, cmd.output);
return retval;
}
* happen when the Jim Tcl interpreter is provided by eCos for
* instance.
*/
+ struct target *saved_target_override = context->current_target_override;
+ context->current_target_override = NULL;
+
Jim_Interp *interp = context->interp;
+ struct command_context *old_context = Jim_GetAssocData(interp, "context");
Jim_DeleteAssocData(interp, "context");
retcode = Jim_SetAssocData(interp, "context", NULL, context);
- if (retcode == JIM_OK)
- {
+ if (retcode == JIM_OK) {
/* associated the return value */
Jim_DeleteAssocData(interp, "retval");
retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
- if (retcode == JIM_OK)
- {
+ if (retcode == JIM_OK) {
retcode = Jim_Eval_Named(interp, line, 0, 0);
Jim_DeleteAssocData(interp, "retval");
}
Jim_DeleteAssocData(interp, "context");
+ int inner_retcode = Jim_SetAssocData(interp, "context", NULL, old_context);
+ if (retcode == JIM_OK)
+ retcode = inner_retcode;
}
- if (retcode == JIM_ERR) {
- if (retval != ERROR_COMMAND_CLOSE_CONNECTION)
- {
- /* We do not print the connection closed error message */
- Jim_MakeErrorMessage(interp);
- LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
- }
- if (retval == ERROR_OK)
- {
- /* It wasn't a low level OpenOCD command that failed */
- return ERROR_FAIL;
- }
- return retval;
- } else if (retcode == JIM_EXIT) {
- /* ignore. */
- /* exit(Jim_GetExitCode(interp)); */
- } else {
+ context->current_target_override = saved_target_override;
+ if (retcode == JIM_OK) {
const char *result;
int reslen;
result = Jim_GetString(Jim_GetResult(interp), &reslen);
- if (reslen > 0)
- {
- int i;
- char buff[256 + 1];
- for (i = 0; i < reslen; i += 256)
- {
- int chunk;
- chunk = reslen - i;
- if (chunk > 256)
- chunk = 256;
- strncpy(buff, result + i, chunk);
- buff[chunk] = 0;
- LOG_USER_N("%s", buff);
- }
- LOG_USER_N("\n");
+ if (reslen > 0) {
+ command_output_text(context, result);
+ command_output_text(context, "\n");
}
retval = ERROR_OK;
+ } else if (retcode == JIM_EXIT) {
+ /* ignore.
+ * exit(Jim_GetExitCode(interp)); */
+ } else if (retcode == ERROR_COMMAND_CLOSE_CONNECTION) {
+ return retcode;
+ } else {
+ Jim_MakeErrorMessage(interp);
+ /* error is broadcast */
+ LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
+
+ if (retval == ERROR_OK) {
+ /* It wasn't a low level OpenOCD command that failed */
+ return ERROR_FAIL;
+ }
+ return retval;
}
+
return retval;
}
va_list ap;
va_start(ap, format);
string = alloc_vprintf(format, ap);
- if (string != NULL)
- {
+ if (string) {
retval = command_run_line(context, string);
+ free(string);
}
va_end(ap);
return retval;
}
-void command_set_output_handler(struct command_context* context,
- command_output_handler_t output_handler, void *priv)
+void command_set_output_handler(struct command_context *context,
+ command_output_handler_t output_handler, void *priv)
{
context->output_handler = output_handler;
context->output_handler_priv = priv;
}
-struct command_context* copy_command_context(struct command_context* context)
+struct command_context *copy_command_context(struct command_context *context)
{
- struct command_context* copy_context = malloc(sizeof(struct command_context));
+ struct command_context *copy_context = malloc(sizeof(struct command_context));
*copy_context = *context;
void command_done(struct command_context *cmd_ctx)
{
- if (NULL == cmd_ctx)
+ if (!cmd_ctx)
return;
free(cmd_ctx);
return JIM_ERR;
const char *file = Jim_GetString(argv[1], NULL);
char *full_path = find_file(file);
- if (full_path == NULL)
+ if (!full_path)
return JIM_ERR;
Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
free(full_path);
return JIM_OK;
}
-COMMAND_HANDLER(jim_echo)
+COMMAND_HANDLER(handle_echo)
{
- if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n"))
- {
+ if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) {
LOG_USER_N("%s", CMD_ARGV[1]);
- return JIM_OK;
+ return ERROR_OK;
}
+
if (CMD_ARGC != 1)
- return JIM_ERR;
+ return ERROR_FAIL;
+
LOG_USER("%s", CMD_ARGV[0]);
- return JIM_OK;
+ return ERROR_OK;
}
/* Capture progress output and return as tcl return value. If the
/* disable polling during capture. This avoids capturing output
* from polling.
*
- * This is necessary in order to avoid accidentially getting a non-empty
+ * This is necessary in order to avoid accidentally getting a non-empty
* string for tcl fn's.
*/
bool save_poll = jtag_poll_get_enabled();
return retcode;
}
-static COMMAND_HELPER(command_help_find, struct command *head,
- struct command **out)
-{
- if (0 == CMD_ARGC)
- return ERROR_INVALID_ARGUMENTS;
- *out = command_find(head, CMD_ARGV[0]);
- if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
- *out = command_find(head, CMD_ARGV[0] + 4);
- if (NULL == *out)
- return ERROR_INVALID_ARGUMENTS;
- if (--CMD_ARGC == 0)
- return ERROR_OK;
- CMD_ARGV++;
- return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
-}
+struct help_entry {
+ struct list_head lh;
+ char *cmd_name;
+ char *help;
+ char *usage;
+};
-static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
- bool show_help, const char *match);
+static COMMAND_HELPER(command_help_show, struct help_entry *c,
+ bool show_help, const char *cmd_match);
-static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
- bool show_help, const char *match)
+static COMMAND_HELPER(command_help_show_list, bool show_help, const char *cmd_match)
{
- for (struct command *c = head; NULL != c; c = c->next)
- CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match);
+ struct help_entry *entry;
+
+ list_for_each_entry(entry, CMD_CTX->help_list, lh)
+ CALL_COMMAND_HANDLER(command_help_show, entry, show_help, cmd_match);
return ERROR_OK;
}
static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
{
const char *cp = str, *last = str;
- while (*cp)
- {
+ while (*cp) {
const char *next = last;
do {
cp = next;
n = n2;
}
}
-static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
- bool show_help, const char *match)
+
+static COMMAND_HELPER(command_help_show, struct help_entry *c,
+ bool show_help, const char *cmd_match)
{
- char *cmd_name = command_name(c, ' ');
- if (NULL == cmd_name)
- return -ENOMEM;
+ unsigned int n = 0;
+ for (const char *s = strchr(c->cmd_name, ' '); s; s = strchr(s + 1, ' '))
+ n++;
/* If the match string occurs anywhere, we print out
* stuff for this command. */
- bool is_match = (strstr(cmd_name, match) != NULL) ||
- ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) ||
- ((c->help != NULL) && (strstr(c->help, match) != NULL));
-
- if (is_match)
- {
- command_help_show_indent(n);
- LOG_USER_N("%s", cmd_name);
- }
- free(cmd_name);
-
- if (is_match)
- {
- if (c->usage) {
- LOG_USER_N(" ");
- command_help_show_wrap(c->usage, 0, n + 5);
+ bool is_match = strstr(c->cmd_name, cmd_match) ||
+ (c->usage && strstr(c->usage, cmd_match)) ||
+ (c->help && strstr(c->help, cmd_match));
+
+ if (is_match) {
+ if (c->usage && strlen(c->usage) > 0) {
+ char *msg = alloc_printf("%s %s", c->cmd_name, c->usage);
+ command_help_show_wrap(msg, n, n + 5);
+ free(msg);
+ } else {
+ command_help_show_wrap(c->cmd_name, n, n + 5);
}
- else
- LOG_USER_N("\n");
}
- if (is_match && show_help)
- {
+ if (is_match && show_help) {
char *msg;
+ /* TODO: factorize jim_command_mode() to avoid running jim command here */
+ char *request = alloc_printf("command mode %s", c->cmd_name);
+ if (!request) {
+ LOG_ERROR("Out of memory");
+ return ERROR_FAIL;
+ }
+ int retval = Jim_Eval(CMD_CTX->interp, request);
+ free(request);
+ enum command_mode mode = COMMAND_UNKNOWN;
+ if (retval != JIM_ERR) {
+ const char *result = Jim_GetString(Jim_GetResult(CMD_CTX->interp), NULL);
+ if (!strcmp(result, "any"))
+ mode = COMMAND_ANY;
+ else if (!strcmp(result, "config"))
+ mode = COMMAND_CONFIG;
+ else if (!strcmp(result, "exec"))
+ mode = COMMAND_EXEC;
+ }
+
/* Normal commands are runtime-only; highlight exceptions */
- if (c->mode != COMMAND_EXEC) {
+ if (mode != COMMAND_EXEC) {
const char *stage_msg = "";
- switch (c->mode) {
- case COMMAND_CONFIG:
- stage_msg = " (configuration command)";
- break;
- case COMMAND_ANY:
- stage_msg = " (command valid any time)";
- break;
- default:
- stage_msg = " (?mode error?)";
- break;
+ switch (mode) {
+ case COMMAND_CONFIG:
+ stage_msg = " (configuration command)";
+ break;
+ case COMMAND_ANY:
+ stage_msg = " (command valid any time)";
+ break;
+ default:
+ stage_msg = " (?mode error?)";
+ break;
}
- msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
+ msg = alloc_printf("%s%s", c->help ? c->help : "", stage_msg);
} else
- msg = alloc_printf("%s", c->help ? : "");
+ msg = alloc_printf("%s", c->help ? c->help : "");
- if (NULL != msg)
- {
+ if (msg) {
command_help_show_wrap(msg, n + 3, n + 3);
free(msg);
} else
return -ENOMEM;
}
- if (++n >= 2)
- return ERROR_OK;
-
- return CALL_COMMAND_HANDLER(command_help_show_list,
- c->children, n, show_help, match);
+ return ERROR_OK;
}
+
COMMAND_HANDLER(handle_help_command)
{
bool full = strcmp(CMD_NAME, "help") == 0;
int retval;
- struct command *c = CMD_CTX->commands;
- char *match = NULL;
-
- if (CMD_ARGC == 0)
- match = "";
- else if (CMD_ARGC >= 1) {
- unsigned i;
-
- for (i = 0; i < CMD_ARGC; ++i) {
- if (NULL != match) {
- char *prev = match;
-
- match = alloc_printf("%s %s", match,
- CMD_ARGV[i]);
- free(prev);
- if (NULL == match) {
- LOG_ERROR("unable to build "
- "search string");
- return -ENOMEM;
- }
- } else {
- match = alloc_printf("%s", CMD_ARGV[i]);
- if (NULL == match) {
- LOG_ERROR("unable to build "
- "search string");
- return -ENOMEM;
- }
- }
+ char *cmd_match;
+
+ if (CMD_ARGC <= 0)
+ cmd_match = strdup("");
+
+ else {
+ cmd_match = strdup(CMD_ARGV[0]);
+
+ for (unsigned int i = 1; i < CMD_ARGC && cmd_match; ++i) {
+ char *prev = cmd_match;
+ cmd_match = alloc_printf("%s %s", prev, CMD_ARGV[i]);
+ free(prev);
}
- } else
- return ERROR_COMMAND_SYNTAX_ERROR;
+ }
- retval = CALL_COMMAND_HANDLER(command_help_show_list,
- c, 0, full, match);
+ if (!cmd_match) {
+ LOG_ERROR("unable to build search string");
+ return -ENOMEM;
+ }
+ retval = CALL_COMMAND_HANDLER(command_help_show_list, full, cmd_match);
- if (CMD_ARGC >= 1)
- free(match);
+ free(cmd_match);
return retval;
}
-static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
- struct command *head, struct command **out, bool top_level)
+static char *alloc_concatenate_strings(int argc, Jim_Obj * const *argv)
{
- if (0 == argc)
- return argc;
- const char *cmd_name = Jim_GetString(argv[0], NULL);
- struct command *c = command_find(head, cmd_name);
- if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
- c = command_find(head, cmd_name + 4);
- if (NULL == c)
- return argc;
- *out = c;
- return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
-}
+ char *prev, *all;
+ int i;
+ assert(argc >= 1);
-static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
-{
- const char *cmd_name = Jim_GetString(argv[0], NULL);
- if (strcmp(cmd_name, "unknown") == 0)
- {
- if (argc == 1)
- return JIM_OK;
- argc--;
- argv++;
+ all = strdup(Jim_GetString(argv[0], NULL));
+ if (!all) {
+ LOG_ERROR("Out of memory");
+ return NULL;
}
- script_debug(interp, cmd_name, argc, argv);
- struct command_context *cmd_ctx = current_command_context(interp);
- struct command *c = cmd_ctx->commands;
- int remaining = command_unknown_find(argc, argv, c, &c, true);
- // if nothing could be consumed, then it's really an unknown command
- if (remaining == argc)
- {
- const char *cmd = Jim_GetString(argv[0], NULL);
- LOG_ERROR("Unknown command:\n %s", cmd);
- return JIM_OK;
+ for (i = 1; i < argc; ++i) {
+ prev = all;
+ all = alloc_printf("%s %s", all, Jim_GetString(argv[i], NULL));
+ free(prev);
+ if (!all) {
+ LOG_ERROR("Out of memory");
+ return NULL;
+ }
}
- bool found = true;
- Jim_Obj *const *start;
- unsigned count;
- if (c->handler || c->jim_handler)
- {
- // include the command name in the list
- count = remaining + 1;
- start = argv + (argc - remaining - 1);
- }
- else
- {
- c = command_find(cmd_ctx->commands, "usage");
- if (NULL == c)
- {
- LOG_ERROR("unknown command, but usage is missing too");
- return JIM_ERR;
+ return all;
+}
+
+static int exec_command(Jim_Interp *interp, struct command_context *cmd_ctx,
+ struct command *c, int argc, Jim_Obj * const *argv)
+{
+ if (c->jim_handler)
+ return c->jim_handler(interp, argc, argv);
+
+ /* use c->handler */
+ unsigned int nwords;
+ char **words = script_command_args_alloc(argc, argv, &nwords);
+ if (!words)
+ return JIM_ERR;
+
+ int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
+ script_command_args_free(words, nwords);
+ return command_retval_set(interp, retval);
+}
+
+static int jim_command_dispatch(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
+{
+ /* check subcommands */
+ if (argc > 1) {
+ char *s = alloc_printf("%s %s", Jim_GetString(argv[0], NULL), Jim_GetString(argv[1], NULL));
+ Jim_Obj *js = Jim_NewStringObj(interp, s, -1);
+ Jim_IncrRefCount(js);
+ free(s);
+ Jim_Cmd *cmd = Jim_GetCommand(interp, js, JIM_NONE);
+ if (cmd) {
+ int retval = Jim_EvalObjPrefix(interp, js, argc - 2, argv + 2);
+ Jim_DecrRefCount(interp, js);
+ return retval;
}
- count = argc - remaining;
- start = argv;
- found = false;
+ Jim_DecrRefCount(interp, js);
}
- // pass the command through to the intended handler
- if (c->jim_handler)
- {
- interp->cmdPrivData = c->jim_handler_data;
- return (*c->jim_handler)(interp, count, start);
+
+ script_debug(interp, argc, argv);
+
+ struct command *c = jim_to_command(interp);
+ if (!c->jim_handler && !c->handler) {
+ Jim_EvalObjPrefix(interp, Jim_NewStringObj(interp, "usage", -1), 1, argv);
+ return JIM_ERR;
}
- return script_command_run(interp, count, start, c, found);
+ struct command_context *cmd_ctx = current_command_context(interp);
+
+ if (!command_can_run(cmd_ctx, c, Jim_GetString(argv[0], NULL)))
+ return JIM_ERR;
+
+ target_call_timer_callbacks_now();
+
+ /*
+ * Black magic of overridden current target:
+ * If the command we are going to handle has a target prefix,
+ * override the current target temporarily for the time
+ * of processing the command.
+ * current_target_override is used also for event handlers
+ * therefore we prevent touching it if command has no prefix.
+ * Previous override is saved and restored back to ensure
+ * correct work when jim_command_dispatch() is re-entered.
+ */
+ struct target *saved_target_override = cmd_ctx->current_target_override;
+ if (c->jim_override_target)
+ cmd_ctx->current_target_override = c->jim_override_target;
+
+ int retval = exec_command(interp, cmd_ctx, c, argc, argv);
+
+ if (c->jim_override_target)
+ cmd_ctx->current_target_override = saved_target_override;
+
+ return retval;
}
static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
struct command_context *cmd_ctx = current_command_context(interp);
enum command_mode mode;
- if (argc > 1)
- {
- struct command *c = cmd_ctx->commands;
- int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
- // if nothing could be consumed, then it's an unknown command
- if (remaining == argc - 1)
- {
+ if (argc > 1) {
+ char *full_name = alloc_concatenate_strings(argc - 1, argv + 1);
+ if (!full_name)
+ return JIM_ERR;
+ Jim_Obj *s = Jim_NewStringObj(interp, full_name, -1);
+ Jim_IncrRefCount(s);
+ Jim_Cmd *cmd = Jim_GetCommand(interp, s, JIM_NONE);
+ Jim_DecrRefCount(interp, s);
+ free(full_name);
+ if (!cmd || !(jimcmd_is_proc(cmd) || jimcmd_is_oocd_command(cmd))) {
Jim_SetResultString(interp, "unknown", -1);
return JIM_OK;
}
- mode = c->mode;
- }
- else
+
+ if (jimcmd_is_proc(cmd)) {
+ /* tcl proc */
+ mode = COMMAND_ANY;
+ } else {
+ struct command *c = jimcmd_privdata(cmd);
+
+ mode = c->mode;
+ }
+ } else
mode = cmd_ctx->mode;
const char *mode_str;
switch (mode) {
- case COMMAND_ANY: mode_str = "any"; break;
- case COMMAND_CONFIG: mode_str = "config"; break;
- case COMMAND_EXEC: mode_str = "exec"; break;
- default: mode_str = "unknown"; break;
+ case COMMAND_ANY:
+ mode_str = "any";
+ break;
+ case COMMAND_CONFIG:
+ mode_str = "config";
+ break;
+ case COMMAND_EXEC:
+ mode_str = "exec";
+ break;
+ default:
+ mode_str = "unknown";
+ break;
}
Jim_SetResultString(interp, mode_str, -1);
return JIM_OK;
}
-static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+int help_del_all_commands(struct command_context *cmd_ctx)
{
- if (1 == argc)
- return JIM_ERR;
-
- struct command_context *cmd_ctx = current_command_context(interp);
- struct command *c = cmd_ctx->commands;
- int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
- // if nothing could be consumed, then it's an unknown command
- if (remaining == argc - 1)
- {
- Jim_SetResultString(interp, "unknown", -1);
- return JIM_OK;
+ struct help_entry *curr, *n;
+
+ list_for_each_entry_safe(curr, n, cmd_ctx->help_list, lh) {
+ list_del(&curr->lh);
+ free(curr->cmd_name);
+ free(curr->help);
+ free(curr->usage);
+ free(curr);
}
+ return ERROR_OK;
+}
- if (c->jim_handler)
- Jim_SetResultString(interp, "native", -1);
- else if (c->handler)
- Jim_SetResultString(interp, "simple", -1);
- else
- Jim_SetResultString(interp, "group", -1);
+static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name)
+{
+ struct help_entry *curr;
+
+ list_for_each_entry(curr, cmd_ctx->help_list, lh) {
+ if (!strcmp(cmd_name, curr->cmd_name)) {
+ list_del(&curr->lh);
+ free(curr->cmd_name);
+ free(curr->help);
+ free(curr->usage);
+ free(curr);
+ break;
+ }
+ }
- return JIM_OK;
+ return ERROR_OK;
}
-int help_add_command(struct command_context *cmd_ctx, struct command *parent,
- const char *cmd_name, const char *help_text, const char *usage)
+static int help_add_command(struct command_context *cmd_ctx,
+ const char *cmd_name, const char *help_text, const char *usage_text)
{
- struct command **head = command_list_for_parent(cmd_ctx, parent);
- struct command *nc = command_find(*head, cmd_name);
- if (NULL == nc)
- {
- // add a new command with help text
- struct command_registration cr = {
- .name = cmd_name,
- .mode = COMMAND_ANY,
- .help = help_text,
- .usage = usage,
- };
- nc = register_command(cmd_ctx, parent, &cr);
- if (NULL == nc)
- {
- LOG_ERROR("failed to add '%s' help text", cmd_name);
+ int cmp = -1; /* add after curr */
+ struct help_entry *curr;
+
+ list_for_each_entry_reverse(curr, cmd_ctx->help_list, lh) {
+ cmp = strcmp(cmd_name, curr->cmd_name);
+ if (cmp >= 0)
+ break;
+ }
+
+ struct help_entry *entry;
+ if (cmp) {
+ entry = calloc(1, sizeof(*entry));
+ if (!entry) {
+ LOG_ERROR("Out of memory");
return ERROR_FAIL;
}
- LOG_DEBUG("added '%s' help text", cmd_name);
- return ERROR_OK;
+ entry->cmd_name = strdup(cmd_name);
+ if (!entry->cmd_name) {
+ LOG_ERROR("Out of memory");
+ free(entry);
+ return ERROR_FAIL;
+ }
+ list_add(&entry->lh, &curr->lh);
+ } else {
+ entry = curr;
}
- if (help_text)
- {
- bool replaced = false;
- if (nc->help)
- {
- free((void *)nc->help);
- replaced = true;
+
+ if (help_text) {
+ char *text = strdup(help_text);
+ if (!text) {
+ LOG_ERROR("Out of memory");
+ return ERROR_FAIL;
}
- nc->help = strdup(help_text);
- if (replaced)
- LOG_INFO("replaced existing '%s' help", cmd_name);
- else
- LOG_DEBUG("added '%s' help text", cmd_name);
+ free(entry->help);
+ entry->help = text;
}
- if (usage)
- {
- bool replaced = false;
- if (nc->usage)
- {
- free((void *)nc->usage);
- replaced = true;
+
+ if (usage_text) {
+ char *text = strdup(usage_text);
+ if (!text) {
+ LOG_ERROR("Out of memory");
+ return ERROR_FAIL;
}
- nc->usage = strdup(usage);
- if (replaced)
- LOG_INFO("replaced existing '%s' usage", cmd_name);
- else
- LOG_DEBUG("added '%s' usage text", cmd_name);
+ free(entry->usage);
+ entry->usage = text;
}
+
return ERROR_OK;
}
COMMAND_HANDLER(handle_help_add_command)
{
- if (CMD_ARGC < 2)
- {
- LOG_ERROR("%s: insufficient arguments", CMD_NAME);
- return ERROR_INVALID_ARGUMENTS;
- }
+ if (CMD_ARGC != 2)
+ return ERROR_COMMAND_SYNTAX_ERROR;
- // save help text and remove it from argument list
- const char *str = CMD_ARGV[--CMD_ARGC];
- const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
- const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
- if (!help && !usage)
- {
+ const char *help = !strcmp(CMD_NAME, "add_help_text") ? CMD_ARGV[1] : NULL;
+ const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? CMD_ARGV[1] : NULL;
+ if (!help && !usage) {
LOG_ERROR("command name '%s' is unknown", CMD_NAME);
- return ERROR_INVALID_ARGUMENTS;
- }
- // likewise for the leaf command name
- const char *cmd_name = CMD_ARGV[--CMD_ARGC];
-
- struct command *c = NULL;
- if (CMD_ARGC > 0)
- {
- c = CMD_CTX->commands;
- int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
- if (ERROR_OK != retval)
- return retval;
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
- return help_add_command(CMD_CTX, c, cmd_name, help, usage);
+ const char *cmd_name = CMD_ARGV[0];
+ return help_add_command(CMD_CTX, cmd_name, help, usage);
}
/* sleep command sleeps for <n> milliseconds
COMMAND_HANDLER(handle_sleep_command)
{
bool busy = false;
- if (CMD_ARGC == 2)
- {
+ if (CMD_ARGC == 2) {
if (strcmp(CMD_ARGV[1], "busy") == 0)
busy = true;
else
return ERROR_COMMAND_SYNTAX_ERROR;
- }
- else if (CMD_ARGC < 1 || CMD_ARGC > 2)
+ } else if (CMD_ARGC < 1 || CMD_ARGC > 2)
return ERROR_COMMAND_SYNTAX_ERROR;
unsigned long duration = 0;
int retval = parse_ulong(CMD_ARGV[0], &duration);
- if (ERROR_OK != retval)
+ if (retval != ERROR_OK)
return retval;
- if (!busy)
- {
- long long then = timeval_ms();
- while (timeval_ms() - then < (long long)duration)
- {
+ if (!busy) {
+ int64_t then = timeval_ms();
+ while (timeval_ms() - then < (int64_t)duration) {
target_call_timer_callbacks_now();
usleep(1000);
}
- }
- else
+ } else
busy_sleep(duration);
return ERROR_OK;
.mode = COMMAND_ANY,
.jim_handler = jim_command_mode,
.usage = "[command_name ...]",
- .help = "Returns the command modes allowed by a command:"
- "'any', 'config', or 'exec'. If no command is"
- "specified, returns the current command mode. "
+ .help = "Returns the command modes allowed by a command: "
+ "'any', 'config', or 'exec'. If no command is "
+ "specified, returns the current command mode. "
"Returns 'unknown' if an unknown command is given. "
"Command can be multiple tokens.",
},
- {
- .name = "type",
- .mode = COMMAND_ANY,
- .jim_handler = jim_command_type,
- .usage = "command_name [...]",
- .help = "Returns the type of built-in command:"
- "'native', 'simple', 'group', or 'unknown'. "
- "Command can be multiple tokens.",
- },
COMMAND_REGISTRATION_DONE
};
static const struct command_registration command_builtin_handlers[] = {
+ {
+ .name = "ocd_find",
+ .mode = COMMAND_ANY,
+ .jim_handler = jim_find,
+ .help = "find full path to file",
+ .usage = "file",
+ },
+ {
+ .name = "capture",
+ .mode = COMMAND_ANY,
+ .jim_handler = jim_capture,
+ .help = "Capture progress output and return as tcl return value. If the "
+ "progress output was empty, return tcl return value.",
+ .usage = "command",
+ },
{
.name = "echo",
- .handler = jim_echo,
+ .handler = handle_echo,
.mode = COMMAND_ANY,
.help = "Logs a message at \"user\" priority. "
- "Output message to stdout. "
"Option \"-n\" suppresses trailing newline",
.usage = "[-n] string",
},
},
{
.name = "command",
- .mode= COMMAND_ANY,
+ .mode = COMMAND_ANY,
.help = "core command group (introspection)",
.chain = command_subcommand_handlers,
+ .usage = "",
},
COMMAND_REGISTRATION_DONE
};
-struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp)
+struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
{
- struct command_context* context = malloc(sizeof(struct command_context));
- const char *HostOs;
+ struct command_context *context = calloc(1, sizeof(struct command_context));
context->mode = COMMAND_EXEC;
- context->commands = NULL;
- context->current_target = 0;
- context->output_handler = NULL;
- context->output_handler_priv = NULL;
-#if !BUILD_ECOSBOARD
+ /* context can be duplicated. Put list head on separate mem-chunk to keep list consistent */
+ context->help_list = malloc(sizeof(*context->help_list));
+ INIT_LIST_HEAD(context->help_list);
+
/* Create a jim interpreter if we were not handed one */
- if (interp == NULL)
- {
+ if (!interp) {
/* Create an interpreter */
interp = Jim_CreateInterp();
/* Add all the Jim core commands */
Jim_RegisterCoreCommands(interp);
Jim_InitStaticExtensions(interp);
}
-#endif
- context->interp = interp;
-
- /* Stick to lowercase for HostOS strings. */
-#if defined(_MSC_VER)
- /* WinXX - is generic, the forward
- * looking problem is this:
- *
- * "win32" or "win64"
- *
- * "winxx" is generic.
- */
- HostOs = "winxx";
-#elif defined(__linux__)
- HostOs = "linux";
-#elif defined(__APPLE__) || defined(__DARWIN__)
- HostOs = "darwin";
-#elif defined(__CYGWIN__)
- HostOs = "cygwin";
-#elif defined(__MINGW32__)
- HostOs = "mingw32";
-#elif defined(__ECOS)
- HostOs = "ecos";
-#elif defined(__FreeBSD__)
- HostOs = "freebsd";
-#else
-#warning "Unrecognized host OS..."
- HostOs = "other";
-#endif
- Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
- Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
- Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
- Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
+ context->interp = interp;
register_commands(context, NULL, command_builtin_handlers);
Jim_SetAssocData(interp, "context", NULL, context);
- if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
- {
+ if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl", 1) == JIM_ERR) {
LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
Jim_MakeErrorMessage(interp);
LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
return context;
}
+void command_exit(struct command_context *context)
+{
+ if (!context)
+ return;
+
+ Jim_FreeInterp(context->interp);
+ free(context->help_list);
+ command_done(context);
+}
+
int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
{
if (!cmd_ctx)
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
cmd_ctx->mode = mode;
return ERROR_OK;
void process_jim_events(struct command_context *cmd_ctx)
{
-#if !BUILD_ECOSBOARD
- static int recursion = 0;
+ static int recursion;
if (recursion)
return;
recursion++;
Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
recursion--;
-#endif
}
#define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
- int parse##name(const char *str, type *ul) \
+ int parse ## name(const char *str, type * ul) \
{ \
- if (!*str) \
- { \
+ if (!*str) { \
LOG_ERROR("Invalid command argument"); \
return ERROR_COMMAND_ARGUMENT_INVALID; \
} \
char *end; \
+ errno = 0; \
*ul = func(str, &end, 0); \
- if (*end) \
- { \
+ if (*end) { \
LOG_ERROR("Invalid command argument"); \
return ERROR_COMMAND_ARGUMENT_INVALID; \
} \
- if ((max == *ul) && (ERANGE == errno)) \
- { \
- LOG_ERROR("Argument overflow"); \
- return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
+ if ((max == *ul) && (errno == ERANGE)) { \
+ LOG_ERROR("Argument overflow"); \
+ return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
} \
- if (min && (min == *ul) && (ERANGE == errno)) \
- { \
+ if (min && (min == *ul) && (errno == ERANGE)) { \
LOG_ERROR("Argument underflow"); \
return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
} \
return ERROR_OK; \
}
-DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
+DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long, strtoul, 0, ULONG_MAX)
DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
-DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
+DEFINE_PARSE_NUM_TYPE(_long, long, strtol, LONG_MIN, LONG_MAX)
DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
#define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
- int parse##name(const char *str, type *ul) \
+ int parse ## name(const char *str, type * ul) \
{ \
functype n; \
- int retval = parse##funcname(str, &n); \
- if (ERROR_OK != retval) \
+ int retval = parse ## funcname(str, &n); \
+ if (retval != ERROR_OK) \
return retval; \
if (n > max) \
- return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
+ return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
if (min) \
return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
*ul = n; \
return ERROR_OK; \
}
-#define DEFINE_PARSE_ULONG(name, type, min, max) \
- DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
-DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
-DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
-DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
-DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
+#define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
+ DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
+DEFINE_PARSE_ULONGLONG(_uint, unsigned, 0, UINT_MAX)
+DEFINE_PARSE_ULONGLONG(_u64, uint64_t, 0, UINT64_MAX)
+DEFINE_PARSE_ULONGLONG(_u32, uint32_t, 0, UINT32_MAX)
+DEFINE_PARSE_ULONGLONG(_u16, uint16_t, 0, UINT16_MAX)
+DEFINE_PARSE_ULONGLONG(_u8, uint8_t, 0, UINT8_MAX)
-#define DEFINE_PARSE_LONG(name, type, min, max) \
- DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
-DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
-DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
-DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
-DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
+DEFINE_PARSE_ULONGLONG(_target_addr, target_addr_t, 0, TARGET_ADDR_MAX)
+
+#define DEFINE_PARSE_LONGLONG(name, type, min, max) \
+ DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
+DEFINE_PARSE_LONGLONG(_int, int, n < INT_MIN, INT_MAX)
+DEFINE_PARSE_LONGLONG(_s64, int64_t, n < INT64_MIN, INT64_MAX)
+DEFINE_PARSE_LONGLONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
+DEFINE_PARSE_LONGLONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
+DEFINE_PARSE_LONGLONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
static int command_parse_bool(const char *in, bool *out,
- const char *on, const char *off)
+ const char *on, const char *off)
{
if (strcasecmp(in, on) == 0)
*out = true;
*out = false;
else
return ERROR_COMMAND_SYNTAX_ERROR;
- return ERROR_OK;
+ return ERROR_OK;
}
int command_parse_bool_arg(const char *in, bool *out)
return ERROR_OK;
if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
return ERROR_OK;
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
{
switch (CMD_ARGC) {
- case 1: {
- const char *in = CMD_ARGV[0];
- if (command_parse_bool_arg(in, out) != ERROR_OK)
- {
- LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
- return ERROR_INVALID_ARGUMENTS;
+ case 1: {
+ const char *in = CMD_ARGV[0];
+ if (command_parse_bool_arg(in, out) != ERROR_OK) {
+ LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
+ return ERROR_COMMAND_SYNTAX_ERROR;
+ }
}
- // fall through
- }
- case 0:
- LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
- break;
- default:
- return ERROR_INVALID_ARGUMENTS;
+ /* fallthrough */
+ case 0:
+ LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
+ break;
+ default:
+ return ERROR_COMMAND_SYNTAX_ERROR;
}
return ERROR_OK;
}