FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
cli.h
Go to the documentation of this file.
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 {
51 
52  /* Indexed by name[position] - min_char. */
55 
56 typedef struct
57 {
58  u8 *name;
59 
62 
63 typedef struct
64 {
65  u8 *name;
66 
68 
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. */
80 
82 
83  /* Opaque for unformat function. */
84  uword unformat_function_arg[2];
86 
87 /* CLI command callback function. */
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. */
104 
105  /* Opaque. */
107 
108  /* Known MP-safe? */
110 
111  /* Sub commands for this command. */
113 
114  /* Hash table mapping name (e.g. last path element) to sub command index. */
116 
117  /* bitmap[p][c][i] says whether sub-command i has character
118  c in position p. */
120 
121  /* Hash table mapping name (e.g. last path element) to sub rule index. */
123 
124  /* Vector of possible parse rules for this path. */
126 
127  /* List of CLI commands, built by constructors */
129 
130  /* Hit counter */
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. */
140 
141  /* Hash table mapping normalized path to index into all_commands. */
143 
144  /* registration list added by constructors */
146 
147  /* index vector, to sort commands, etc. */
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 */
159 
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 
206 
208 
209 /* Return an vector of strings consisting of possible auto-completions
210  * for a given input string */
211 u8 **vlib_cli_get_possible_completions (u8 * input_str);
212 
213 #endif /* included_vlib_cli_h */
214 
215 /*
216  * fd.io coding-style-patch-verification: ON
217  *
218  * Local Variables:
219  * eval: (c-set-style "gnu")
220  * End:
221  */
vlib_cli_parse_rule_t
Definition: cli.h:72
vlib_cli_parse_rule_t::long_help
char * long_help
Definition: cli.h:76
vlib_cli_parse_rule_t::name
char * name
Definition: cli.h:74
buffer
char * buffer
Definition: cJSON.h:163
vlib_cli_command_t::sub_rules
vlib_cli_sub_rule_t * sub_rules
Definition: cli.h:125
vlib_cli_parse_position_t::bitmaps
uword ** bitmaps
Definition: cli.h:53
unformat_vlib_cli_sub_input
uword unformat_vlib_cli_sub_input(unformat_input_t *i, va_list *args)
Definition: cli.c:163
vlib_cli_command_t::sub_commands
vlib_cli_sub_command_t * sub_commands
Definition: cli.h:112
vlib_cli_sub_command_t::index
u32 index
Definition: cli.h:60
vlib_log_class_t
u32 vlib_log_class_t
Definition: vlib.h:52
vlib_cli_register_parse_rule
clib_error_t * vlib_cli_register_parse_rule(struct vlib_main_t *vm, vlib_cli_parse_rule_t *c)
vlib_cli_command_t::path
char * path
Definition: cli.h:96
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
vlib_cli_command_t::long_help
char * long_help
Definition: cli.h:100
unformat_input_t
struct _unformat_input_t unformat_input_t
vlib_cli_input
int vlib_cli_input(struct vlib_main_t *vm, unformat_input_t *input, vlib_cli_output_function_t *function, uword function_arg)
Definition: cli.c:675
vlib_cli_parse_position_t::min_char
u32 min_char
Definition: cli.h:50
vlib_cli_command_t::hit_counter
u32 hit_counter
Definition: cli.h:131
vlib_cli_command_t::next_cli_command
struct vlib_cli_command_t * next_cli_command
Definition: cli.h:128
vlib_cli_command_t::sub_command_positions
vlib_cli_parse_position_t * sub_command_positions
Definition: cli.h:119
vlib_cli_command_t::is_mp_safe
uword is_mp_safe
Definition: cli.h:109
vlib_cli_command_t
struct vlib_cli_command_t vlib_cli_command_t
vlib_cli_command_t::sub_command_index_by_name
uword * sub_command_index_by_name
Definition: cli.h:115
vlib_cli_sub_rule_t::name
u8 * name
Definition: cli.h:65
vlib_cli_main_t
struct vlib_cli_main_t vlib_cli_main_t
c
svmdb_client_t * c
Definition: vpp_get_metrics.c:48
log.h
vlib_cli_register
clib_error_t * vlib_cli_register(struct vlib_main_t *vm, vlib_cli_command_t *c)
Definition: cli.c:1357
vlib_cli_sub_rule_t::rule_index
u32 rule_index
Definition: cli.h:67
uword
u64 uword
Definition: types.h:112
vlib_cli_command_t::short_help
char * short_help
Definition: cli.h:99
vlib_cli_parse_rule_t::unformat_function
unformat_function_t * unformat_function
Definition: cli.h:81
vlib_cli_main_t
Definition: cli.h:136
format.h
vlib_cli_output_function_t
void() vlib_cli_output_function_t(uword arg, u8 *buffer, uword buffer_bytes)
Definition: cli.h:134
fmt
int cJSON_bool fmt
Definition: cJSON.h:160
vlib_cli_main_t::perf_counter_cbs
void(** perf_counter_cbs)(struct vlib_cli_main_t *, u32 id, int before_or_after)
Definition: cli.h:153
vlib_cli_parse_position_t
Definition: cli.h:48
vlib_cli_parse_rule_t::data_size
uword data_size
Definition: cli.h:79
id
u8 id[64]
Definition: dhcp.api:160
u32
unsigned int u32
Definition: types.h:88
vlib_cli_get_possible_completions
u8 ** vlib_cli_get_possible_completions(u8 *input_str)
Definition: cli.c:238
vlib_cli_main_t::sort_vector
u32 * sort_vector
Definition: cli.h:148
vlib_cli_main_t::commands
vlib_cli_command_t * commands
Definition: cli.h:139
vlib_cli_main_t::perf_counter_cbs_tmp
void(** perf_counter_cbs_tmp)(struct vlib_cli_main_t *, u32 id, int before_or_after)
Definition: cli.h:155
vlib_cli_command_t::sub_rule_index_by_name
uword * sub_rule_index_by_name
Definition: cli.h:122
unformat_function_t
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:225
vlib_cli_output
void vlib_cli_output(struct vlib_main_t *vm, char *fmt,...)
Definition: cli.c:716
vlib_main_t
Definition: main.h:102
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
vlib_cli_command_function_t
clib_error_t *() vlib_cli_command_function_t(struct vlib_main_t *vm, unformat_input_t *input, struct vlib_cli_command_t *cmd)
Definition: cli.h:89
i
int i
Definition: flowhash_template.h:376
vlib_cli_main_t::cli_command_registrations
vlib_cli_command_t * cli_command_registrations
Definition: cli.h:145
vlib_cli_command_t::function_arg
uword function_arg
Definition: cli.h:106
vlib_cli_command_t
Definition: cli.h:92
vlib_cli_main_t::command_index_by_path
uword * command_index_by_path
Definition: cli.h:142
vlib_cli_sub_rule_t::command_index
u32 command_index
Definition: cli.h:69
vlib_cli_sub_command_t::name
u8 * name
Definition: cli.h:58
vlib_cli_sub_rule_t
Definition: cli.h:63
vlib_cli_parse_rule_t::short_help
char * short_help
Definition: cli.h:75
vlib_cli_sub_command_t
Definition: cli.h:56
vlib_cli_main_t::log
vlib_log_class_t log
Definition: cli.h:158