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 #include <vlib/log.h>
  45
  46 struct vlib_cli_command_t;
  47
  48 typedef struct
  49 {
  50   u32 min_char;
  51
  52   /* Indexed by name[position] - min_char. */
  53   uword **bitmaps;
  54 } vlib_cli_parse_position_t;
  55
  56 typedef struct
  57 {
  58   u8 *name;
  59
  60   u32 index;
  61 } vlib_cli_sub_command_t;
  62
  63 typedef struct
  64 {
  65   u8 *name;
  66
  67   u32 rule_index;
  68
  69   u32 command_index;
  70 } vlib_cli_sub_rule_t;
  71
  72 typedef struct
  73 {
  74   char *name;
  75   char *short_help;
  76   char *long_help;
  77
  78   /* Number of bytes in parsed data.  Zero for vector. */
  79   uword data_size;
  80
  81   unformat_function_t *unformat_function;
  82
  83   /* Opaque for unformat function. */
  84   uword unformat_function_arg[2];
  85 } vlib_cli_parse_rule_t;
  86
  87 /* CLI command callback function. */
  88 typedef clib_error_t *(vlib_cli_command_function_t)
  89   (struct vlib_main_t * vm,
  90    unformat_input_t * input, struct vlib_cli_command_t * cmd);
  91
  92 typedef struct vlib_cli_command_t
  93 {
  94   /* Command path (e.g. "show something").
  95      Spaces delimit elements of path. */
  96   char *path;
  97
  98   /* Short/long help strings. */
  99   char *short_help;
 100   char *long_help;
 101
 102   /* Callback function. */
 103   vlib_cli_command_function_t *function;
 104
 105   /* Opaque. */
 106   uword function_arg;
 107
 108   /* Known MP-safe? */
 109   uword is_mp_safe;
 110
 111   /* Sub commands for this command. */
 112   vlib_cli_sub_command_t *sub_commands;
 113
 114   /* Hash table mapping name (e.g. last path element) to sub command index. */
 115   uword *sub_command_index_by_name;
 116
 117   /* bitmap[p][c][i] says whether sub-command i has character
 118      c in position p. */
 119   vlib_cli_parse_position_t *sub_command_positions;
 120
 121   /* Hash table mapping name (e.g. last path element) to sub rule index. */
 122   uword *sub_rule_index_by_name;
 123
 124   /* Vector of possible parse rules for this path. */
 125   vlib_cli_sub_rule_t *sub_rules;
 126
 127   /* List of CLI commands, built by constructors */
 128   struct vlib_cli_command_t *next_cli_command;
 129
 130   /* Hit counter */
 131   u32 hit_counter;
 132 } vlib_cli_command_t;
 133
 134 typedef void (vlib_cli_output_function_t) (uword arg,
 135                                            u8 * buffer, uword buffer_bytes);
 136 typedef struct vlib_cli_main_t
 137 {
 138   /* Vector of all known commands. */
 139   vlib_cli_command_t *commands;
 140
 141   /* Hash table mapping normalized path to index into all_commands. */
 142   uword *command_index_by_path;
 143
 144   /* registration list added by constructors */
 145   vlib_cli_command_t *cli_command_registrations;
 146
 147   /* index vector, to sort commands, etc. */
 148   u32 *sort_vector;
 149
 150
 151   /* performance counter callback */
 152   void (**perf_counter_cbs)
 153     (struct vlib_cli_main_t *, u32 id, int before_or_after);
 154   void (**perf_counter_cbs_tmp)
 155     (struct vlib_cli_main_t *, u32 id, int before_or_after);
 156
 157   /* cli log */
 158   vlib_log_class_t log;
 159
 160 } vlib_cli_main_t;
 161
 162 #ifndef CLIB_MARCH_VARIANT
 163 #define VLIB_CLI_COMMAND(x, ...)                                              \
 164   __VA_ARGS__ vlib_cli_command_t x;                                           \
 165   static void __vlib_cli_command_registration_##x (void)                      \
 166     __attribute__ ((__constructor__));                                        \
 167   static void __vlib_cli_command_registration_##x (void)                      \
 168   {                                                                           \
 169     vlib_global_main_t *vgm = vlib_get_global_main ();                        \
 170     vlib_cli_main_t *cm = &vgm->cli_main;                                     \
 171     x.next_cli_command = cm->cli_command_registrations;                       \
 172     cm->cli_command_registrations = &x;                                       \
 173   }                                                                           \
 174   static void __vlib_cli_command_unregistration_##x (void)                    \
 175     __attribute__ ((__destructor__));                                         \
 176   static void __vlib_cli_command_unregistration_##x (void)                    \
 177   {                                                                           \
 178     vlib_global_main_t *vgm = vlib_get_global_main ();                        \
 179     vlib_cli_main_t *cm = &vgm->cli_main;                                     \
 180     VLIB_REMOVE_FROM_LINKED_LIST (cm->cli_command_registrations, &x,          \
 181                                   next_cli_command);                          \
 182   }                                                                           \
 183   __VA_ARGS__ vlib_cli_command_t x
 184 #else
 185 /* create unused pointer to silence compiler warnings and get whole
 186    function optimized out */
 187 #define VLIB_CLI_COMMAND(x,...)                                         \
 188 static __clib_unused vlib_cli_command_t __clib_unused_##x
 189 #endif
 190
 191 #define VLIB_CLI_PARSE_RULE(x) \
 192   vlib_cli_parse_rule_t x
 193 /* Output to current CLI connection. */
 194 void vlib_cli_output (struct vlib_main_t *vm, char *fmt, ...);
 195
 196 /* Process CLI input. */
 197 int vlib_cli_input (struct vlib_main_t *vm,
 198                     unformat_input_t * input,
 199                     vlib_cli_output_function_t * function,
 200                     uword function_arg);
 201
 202 clib_error_t *vlib_cli_register (struct vlib_main_t *vm,
 203                                  vlib_cli_command_t * c);
 204 clib_error_t *vlib_cli_register_parse_rule (struct vlib_main_t *vm,
 205                                             vlib_cli_parse_rule_t * c);
 206
 207 unformat_function_t unformat_vlib_cli_line;
 208 uword unformat_vlib_cli_sub_input (unformat_input_t * i, va_list * args);
 209
 210 /* Return an vector of strings consisting of possible auto-completions
 211  * for a given input string */
 212 u8 **vlib_cli_get_possible_completions (u8 * input_str);
 213
 214 #endif /* included_vlib_cli_h */
 215
 216 /*
 217  * fd.io coding-style-patch-verification: ON
 218  *
 219  * Local Variables:
 220  * eval: (c-set-style "gnu")
 221  * End:
 222  */