src/helper/command.h

   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  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23
  24 #ifndef COMMAND_H
  25 #define COMMAND_H
  26
  27 #include <jim-nvp.h>
  28
  29 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
  30  * used for __attribute__((format( ... ))), with GCC v4.4 or later
  31  */
  32 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
  33 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
  34 #else
  35 #define PRINTF_ATTRIBUTE_FORMAT printf
  36 #endif
  37
  38 enum command_mode {
  39         COMMAND_EXEC,
  40         COMMAND_CONFIG,
  41         COMMAND_ANY,
  42 };
  43
  44 struct command_context;
  45
  46 /** The type signature for command context's output handler. */
  47 typedef int (*command_output_handler_t)(struct command_context *context,
  48                 const char *line);
  49
  50 struct command_context {
  51         Jim_Interp *interp;
  52         enum command_mode mode;
  53         struct command *commands;
  54         int current_target;
  55         command_output_handler_t output_handler;
  56         void *output_handler_priv;
  57 };
  58
  59 struct command;
  60
  61 /**
  62  * When run_command is called, a new instance will be created on the
  63  * stack, filled with the proper values, and passed by reference to the
  64  * required COMMAND_HANDLER routine.
  65  */
  66 struct command_invocation {
  67         struct command_context *ctx;
  68         struct command *current;
  69         const char *name;
  70         unsigned argc;
  71         const char **argv;
  72 };
  73
  74 /**
  75  * Command handlers may be defined with more parameters than the base
  76  * set provided by command.c.  This macro uses C99 magic to allow
  77  * defining all such derivative types using this macro.
  78  */
  79 #define __COMMAND_HANDLER(name, extra ...) \
  80                 int name(struct command_invocation *cmd, ## extra)
  81
  82 /**
  83  * Use this to macro to call a command helper (or a nested handler).
  84  * It provides command handler authors protection against reordering or
  85  * removal of unused parameters.
  86  *
  87  * @b Note: This macro uses lexical capture to provide some arguments.
  88  * As a result, this macro should be used @b only within functions
  89  * defined by the COMMAND_HANDLER or COMMAND_HELPER macros.  Those
  90  * macros provide the expected lexical context captured by this macro.
  91  * Furthermore, it should be used only from the top-level of handler or
  92  * helper function, or care must be taken to avoid redefining the same
  93  * variables in intervening scope(s) by accident.
  94  */
  95 #define CALL_COMMAND_HANDLER(name, extra ...) \
  96                 name(cmd, ## extra)
  97
  98 /**
  99  * Always use this macro to define new command handler functions.
 100  * It ensures the parameters are ordered, typed, and named properly, so
 101  * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
 102  * All command handler functions must be defined as static in scope.
 103  */
 104 #define COMMAND_HANDLER(name) \
 105                 static __COMMAND_HANDLER(name)
 106
 107 /**
 108  * Similar to COMMAND_HANDLER, except some parameters are expected.
 109  * A helper is globally-scoped because it may be shared between several
 110  * source files (e.g. the s3c24xx device command helper).
 111  */
 112 #define COMMAND_HELPER(name, extra ...) __COMMAND_HANDLER(name, extra)
 113
 114 /**
 115  * Use this macro to access the context of the command being handled,
 116  * rather than accessing the variable directly.  It may be moved.
 117  */
 118 #define CMD_CTX (cmd->ctx)
 119 /**
 120  * Use this macro to access the number of arguments for the command being
 121  * handled, rather than accessing the variable directly.  It may be moved.
 122  */
 123 #define CMD_ARGC (cmd->argc)
 124 /**
 125  * Use this macro to access the arguments for the command being handled,
 126  * rather than accessing the variable directly.  It may be moved.
 127  */
 128 #define CMD_ARGV (cmd->argv)
 129 /**
 130  * Use this macro to access the name of the command being handled,
 131  * rather than accessing the variable directly.  It may be moved.
 132  */
 133 #define CMD_NAME (cmd->name)
 134 /**
 135  * Use this macro to access the current command being handled,
 136  * rather than accessing the variable directly.  It may be moved.
 137  */
 138 #define CMD_CURRENT (cmd->current)
 139 /**
 140  * Use this macro to access the invoked command handler's data pointer,
 141  * rather than accessing the variable directly.  It may be moved.
 142  */
 143 #define CMD_DATA (CMD_CURRENT->jim_handler_data)
 144
 145 /**
 146  * The type signature for command handling functions.  They are
 147  * usually registered as part of command_registration, providing
 148  * a high-level means for executing a command.
 149  *
 150  * If the command fails, it *MUST* return a value != ERROR_OK
 151  * (many commands break this rule, patches welcome!)
 152  *
 153  * This is *especially* important for commands such as writing
 154  * to flash or verifying memory. The reason is that those commands
 155  * can be used by programs to determine if the operation succeded
 156  * or not. If the operation failed, then a program can try
 157  * an alternative approach.
 158  *
 159  * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
 160  * printing out the syntax of the command.
 161  */
 162 typedef __COMMAND_HANDLER((*command_handler_t));
 163
 164 struct command {
 165         const char *name;
 166         const char *help;
 167         const char *usage;
 168         struct command *parent;
 169         struct command *children;
 170         command_handler_t handler;
 171         Jim_CmdProc jim_handler;
 172         void *jim_handler_data;
 173         enum command_mode mode;
 174         struct command *next;
 175 };
 176
 177 /**
 178  * @param c The command to be named.
 179  * @param delim The character to place between command names.
 180  * @returns A malloc'd string containing the full command name,
 181  * which may include one or more ancestor components.  Multiple names
 182  * are separated by single spaces.  The caller must free() the string
 183  * when done with it.
 184  */
 185 char *command_name(struct command *c, char delim);
 186
 187 /*
 188  * Commands should be registered by filling in one or more of these
 189  * structures and passing them to register_command().
 190  *
 191  * A conventioal format should be used for help strings, to provide both
 192  * usage and basic information:
 193  * @code
 194  * "@<options@> ... - some explanation text"
 195  * @endcode
 196  *
 197  * @param name The name of the command to register, which must not have
 198  * been registered previously in the intended context.
 199  * @param handler The callback function that will be called.  If NULL,
 200  * then the command serves as a placeholder for its children or a script.
 201  * @param mode The command mode(s) in which this command may be run.
 202  * @param help The help text that will be displayed to the user.
 203  */
 204 struct command_registration {
 205         const char *name;
 206         command_handler_t handler;
 207         Jim_CmdProc jim_handler;
 208         void *jim_handler_data;
 209         enum command_mode mode;
 210         const char *help;
 211         /** a string listing the options and arguments, required or optional */
 212         const char *usage;
 213
 214         /**
 215          * If non-NULL, the commands in @c chain will be registered in
 216          * the same context and scope of this registration record.
 217          * This allows modules to inherit lists commands from other
 218          * modules.
 219          */
 220         const struct command_registration *chain;
 221 };
 222
 223 /** Use this as the last entry in an array of command_registration records. */
 224 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
 225
 226 /**
 227  * Register a command @c handler that can be called from scripts during
 228  * the execution @c mode specified.
 229  *
 230  * If @c parent is non-NULL, the new command will be registered as a
 231  * sub-command under it; otherwise, it will be available as a top-level
 232  * command.
 233  *
 234  * @param cmd_ctx The command_context in which to register the command.
 235  * @param parent Register this command as a child of this, or NULL to
 236  * register a top-level command.
 237  * @param rec A command_registration record that contains the desired
 238  * command parameters.
 239  * @returns The new command, if successful; otherwise, NULL.
 240  */
 241 struct command *register_command(struct command_context *cmd_ctx,
 242                                  struct command *parent, const struct command_registration *rec);
 243
 244 /**
 245  * Register one or more commands in the specified context, as children
 246  * of @c parent (or top-level commends, if NULL).  In a registration's
 247  * record contains a non-NULL @c chain member and name is NULL, the
 248  * commands on the chain will be registered in the same context.
 249  * Otherwise, the chained commands are added as children of the command.
 250  *
 251  * @param cmd_ctx The command_context in which to register the command.
 252  * @param parent Register this command as a child of this, or NULL to
 253  * register a top-level command.
 254  * @param cmds Pointer to an array of command_registration records that
 255  * contains the desired command parameters.  The last record must have
 256  * NULL for all fields.
 257  * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
 258  */
 259 int register_commands(struct command_context *cmd_ctx, struct command *parent,
 260                 const struct command_registration *cmds);
 261
 262
 263 /**
 264  * Unregisters command @c name from the given context, @c cmd_ctx.
 265  * @param cmd_ctx The context of the registered command.
 266  * @param parent The parent of the given command, or NULL.
 267  * @param name The name of the command to unregister.
 268  * @returns ERROR_OK on success, or an error code.
 269  */
 270 int unregister_command(struct command_context *cmd_ctx,
 271                 struct command *parent, const char *name);
 272 /**
 273  * Unregisters all commands from the specfied context.
 274  * @param cmd_ctx The context that will be cleared of registered commands.
 275  * @param parent If given, only clear commands from under this one command.
 276  * @returns ERROR_OK on success, or an error code.
 277  */
 278 int unregister_all_commands(struct command_context *cmd_ctx,
 279                 struct command *parent);
 280
 281 struct command *command_find_in_context(struct command_context *cmd_ctx,
 282                 const char *name);
 283 struct command *command_find_in_parent(struct command *parent,
 284                 const char *name);
 285
 286 /**
 287  * Update the private command data field for a command and all descendents.
 288  * This is used when creating a new heirarchy of commands that depends
 289  * on obtaining a dynamically created context.  The value will be available
 290  * in command handlers by using the CMD_DATA macro.
 291  * @param c The command (group) whose data pointer(s) will be updated.
 292  * @param p The new data pointer to use for the command or its descendents.
 293  */
 294 void command_set_handler_data(struct command *c, void *p);
 295
 296 void command_set_output_handler(struct command_context *context,
 297                 command_output_handler_t output_handler, void *priv);
 298
 299
 300 int command_context_mode(struct command_context *context, enum command_mode mode);
 301
 302 /* Return the current command context associated with the Jim interpreter or
 303  * alternatively the global default command interpreter
 304  */
 305 struct command_context *current_command_context(Jim_Interp *interp);
 306 /**
 307  * Creates a new command context using the startup TCL provided and
 308  * the existing Jim interpreter, if any. If interp == NULL, then command_init
 309  * creates a command interpreter.
 310  */
 311 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp);
 312 /**
 313  * Creates a copy of an existing command context.  This does not create
 314  * a deep copy of the command list, so modifications in one context will
 315  * affect all shared contexts.  The caller must track reference counting
 316  * and ensure the commands are freed before destroying the last instance.
 317  * @param cmd_ctx The command_context that will be copied.
 318  * @returns A new command_context with the same state as the original.
 319  */
 320 struct command_context *copy_command_context(struct command_context *cmd_ctx);
 321 /**
 322  * Frees the resources associated with a command context.  The commands
 323  * are not removed, so unregister_all_commands() must be called first.
 324  * @param context The command_context that will be destroyed.
 325  */
 326 void command_done(struct command_context *context);
 327
 328 void command_print(struct command_context *context, const char *format, ...)
 329 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
 330 void command_print_sameline(struct command_context *context, const char *format, ...)
 331 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
 332 int command_run_line(struct command_context *context, char *line);
 333 int command_run_linef(struct command_context *context, const char *format, ...)
 334 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
 335 void command_output_text(struct command_context *context, const char *data);
 336
 337 void process_jim_events(struct command_context *cmd_ctx);
 338
 339 #define ERROR_COMMAND_CLOSE_CONNECTION          (-600)
 340 #define ERROR_COMMAND_SYNTAX_ERROR                      (-601)
 341 #define ERROR_COMMAND_NOTFOUND                          (-602)
 342 #define ERROR_COMMAND_ARGUMENT_INVALID          (-603)
 343 #define ERROR_COMMAND_ARGUMENT_OVERFLOW         (-604)
 344 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW        (-605)
 345
 346 int parse_ulong(const char *str, unsigned long *ul);
 347 int parse_ullong(const char *str, unsigned long long *ul);
 348
 349 int parse_long(const char *str, long *ul);
 350 int parse_llong(const char *str, long long *ul);
 351
 352 #define DECLARE_PARSE_WRAPPER(name, type) \
 353                 int parse ## name(const char *str, type * ul)
 354
 355 DECLARE_PARSE_WRAPPER(_uint, unsigned);
 356 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
 357 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
 358 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
 359
 360 DECLARE_PARSE_WRAPPER(_int, int);
 361 DECLARE_PARSE_WRAPPER(_s32, int32_t);
 362 DECLARE_PARSE_WRAPPER(_s16, int16_t);
 363 DECLARE_PARSE_WRAPPER(_s8, int8_t);
 364
 365 /**
 366  * @brief parses the string @a in into @a out as a @a type, or prints
 367  * a command error and passes the error code to the caller.  If an error
 368  * does occur, the calling function will return the error code produced
 369  * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
 370  *
 371  * This function may cause the calling function to return immediately,
 372  * so it should be used carefully to avoid leaking resources.  In most
 373  * situations, parsing should be completed in full before proceding
 374  * to allocate resources, and this strategy will most prevents leaks.
 375  */
 376 #define COMMAND_PARSE_NUMBER(type, in, out) \
 377         do { \
 378                 int retval_macro_tmp = parse_ ## type(in, &(out)); \
 379                 if (ERROR_OK != retval_macro_tmp) { \
 380                         command_print(CMD_CTX, stringify(out) \
 381                                 " option value ('%s') is not valid", in); \
 382                         return retval_macro_tmp; \
 383                 } \
 384         } while (0)
 385
 386 /**
 387  * Parse the string @c as a binary parameter, storing the boolean value
 388  * in @c out.  The strings @c on and @c off are used to match different
 389  * strings for true and false options (e.g. "on" and "off" or
 390  * "enable" and "disable").
 391  */
 392 #define COMMAND_PARSE_BOOL(in, out, on, off) \
 393         do { \
 394                 bool value; \
 395                 int retval_macro_tmp = command_parse_bool_arg(in, &value); \
 396                 if (ERROR_OK != retval_macro_tmp) { \
 397                         command_print(CMD_CTX, stringify(out) \
 398                                 " option value ('%s') is not valid", in); \
 399                         command_print(CMD_CTX, "  choices are '%s' or '%s'", \
 400                                 on, off); \
 401                         return retval_macro_tmp; \
 402                 } \
 403                 out = value; \
 404         } while (0)
 405
 406 int command_parse_bool_arg(const char *in, bool *out);
 407 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
 408
 409 /** parses an on/off command argument */
 410 #define COMMAND_PARSE_ON_OFF(in, out) \
 411         COMMAND_PARSE_BOOL(in, out, "on", "off")
 412 /** parses an enable/disable command argument */
 413 #define COMMAND_PARSE_ENABLE(in, out) \
 414         COMMAND_PARSE_BOOL(in, out, "enable", "disable")
 415
 416 void script_debug(Jim_Interp *interp, const char *cmd,
 417                   unsigned argc, Jim_Obj * const *argv);
 418
 419 #endif  /* COMMAND_H */