src/vlib/cli.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  * cli.h: command line interface
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #ifndef included_vlib_cli_h
  41 #define included_vlib_cli_h
  42
  43 #include <vppinfra/format.h>
  44
  45 struct vlib_cli_command_t;
  46
  47 typedef struct
  48 {
  49   u32 min_char;
  50
  51   /* Indexed by name[position] - min_char. */
  52   uword **bitmaps;
  53 } vlib_cli_parse_position_t;
  54
  55 typedef struct
  56 {
  57   u8 *name;
  58
  59   u32 index;
  60 } vlib_cli_sub_command_t;
  61
  62 typedef struct
  63 {
  64   u8 *name;
  65
  66   u32 rule_index;
  67
  68   u32 command_index;
  69 } vlib_cli_sub_rule_t;
  70
  71 typedef struct
  72 {
  73   char *name;
  74   char *short_help;
  75   char *long_help;
  76
  77   /* Number of bytes in parsed data.  Zero for vector. */
  78   uword data_size;
  79
  80   unformat_function_t *unformat_function;
  81
  82   /* Opaque for unformat function. */
  83   uword unformat_function_arg[2];
  84 } vlib_cli_parse_rule_t;
  85
  86 /* CLI command callback function. */
  87 typedef clib_error_t *(vlib_cli_command_function_t)
  88   (struct vlib_main_t * vm,
  89    unformat_input_t * input, struct vlib_cli_command_t * cmd);
  90
  91 typedef struct vlib_cli_command_t
  92 {
  93   /* Command path (e.g. "show something").
  94      Spaces delimit elements of path. */
  95   char *path;
  96
  97   /* Short/long help strings. */
  98   char *short_help;
  99   char *long_help;
 100
 101   /* Callback function. */
 102   vlib_cli_command_function_t *function;
 103
 104   /* Opaque. */
 105   uword function_arg;
 106
 107   /* Known MP-safe? */
 108   uword is_mp_safe;
 109
 110   /* Sub commands for this command. */
 111   vlib_cli_sub_command_t *sub_commands;
 112
 113   /* Hash table mapping name (e.g. last path element) to sub command index. */
 114   uword *sub_command_index_by_name;
 115
 116   /* bitmap[p][c][i] says whether sub-command i has character
 117      c in position p. */
 118   vlib_cli_parse_position_t *sub_command_positions;
 119
 120   /* Hash table mapping name (e.g. last path element) to sub rule index. */
 121   uword *sub_rule_index_by_name;
 122
 123   /* Vector of possible parse rules for this path. */
 124   vlib_cli_sub_rule_t *sub_rules;
 125
 126   /* List of CLI commands, built by constructors */
 127   struct vlib_cli_command_t *next_cli_command;
 128
 129   /* Hit counter */
 130   u32 hit_counter;
 131 } vlib_cli_command_t;
 132
 133 typedef void (vlib_cli_output_function_t) (uword arg,
 134                                            u8 * buffer, uword buffer_bytes);
 135 typedef struct
 136 {
 137   /* Vector of all known commands. */
 138   vlib_cli_command_t *commands;
 139
 140   /* Hash table mapping normalized path to index into all_commands. */
 141   uword *command_index_by_path;
 142
 143   /* Vector of all known parse rules. */
 144   vlib_cli_parse_rule_t *parse_rules;
 145
 146   /* Hash table mapping parse rule name to index into parse_rule vector. */
 147   uword *parse_rule_index_by_name;
 148
 149   /* Data parsed for rules. */
 150   void **parse_rule_data;
 151
 152   /* registration list added by constructors */
 153   vlib_cli_command_t *cli_command_registrations;
 154
 155   /* index vector, to sort commands, etc. */
 156   u32 *sort_vector;
 157
 158 } vlib_cli_main_t;
 159
 160 #ifndef CLIB_MARCH_VARIANT
 161 #define VLIB_CLI_COMMAND(x,...)                                         \
 162     __VA_ARGS__ vlib_cli_command_t x;                                   \
 163 static void __vlib_cli_command_registration_##x (void)                  \
 164     __attribute__((__constructor__)) ;                                  \
 165 static void __vlib_cli_command_registration_##x (void)                  \
 166 {                                                                       \
 167     vlib_main_t * vm = vlib_get_main();                                 \
 168     vlib_cli_main_t *cm = &vm->cli_main;                                \
 169     x.next_cli_command = cm->cli_command_registrations;                 \
 170     cm->cli_command_registrations = &x;                                 \
 171 }                                                                       \
 172 static void __vlib_cli_command_unregistration_##x (void)                \
 173     __attribute__((__destructor__)) ;                                   \
 174 static void __vlib_cli_command_unregistration_##x (void)                \
 175 {                                                                       \
 176     vlib_main_t * vm = vlib_get_main();                                 \
 177     vlib_cli_main_t *cm = &vm->cli_main;                                \
 178     VLIB_REMOVE_FROM_LINKED_LIST (cm->cli_command_registrations, &x,    \
 179                                   next_cli_command);                    \
 180 }                                                                       \
 181 __VA_ARGS__ vlib_cli_command_t x
 182 #else
 183 /* create unused pointer to silence compiler warnings and get whole
 184    function optimized out */
 185 #define VLIB_CLI_COMMAND(x,...)                                         \
 186 static __clib_unused vlib_cli_command_t __clib_unused_##x
 187 #endif
 188
 189 #define VLIB_CLI_PARSE_RULE(x) \
 190   vlib_cli_parse_rule_t x
 191 /* Output to current CLI connection. */
 192 void vlib_cli_output (struct vlib_main_t *vm, char *fmt, ...);
 193
 194 /* Process CLI input. */
 195 int vlib_cli_input (struct vlib_main_t *vm,
 196                     unformat_input_t * input,
 197                     vlib_cli_output_function_t * function,
 198                     uword function_arg);
 199
 200 clib_error_t *vlib_cli_register (struct vlib_main_t *vm,
 201                                  vlib_cli_command_t * c);
 202 clib_error_t *vlib_cli_register_parse_rule (struct vlib_main_t *vm,
 203                                             vlib_cli_parse_rule_t * c);
 204
 205 uword unformat_vlib_cli_sub_input (unformat_input_t * i, va_list * args);
 206
 207 /* Return an vector of strings consisting of possible auto-completions
 208  * for a given input string */
 209 u8 **vlib_cli_get_possible_completions (u8 * input_str);
 210
 211 #endif /* included_vlib_cli_h */
 212
 213 /*
 214  * fd.io coding-style-patch-verification: ON
 215  *
 216  * Local Variables:
 217  * eval: (c-set-style "gnu")
 218  * End:
 219  */