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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * cli.h: command line interface
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vlib_cli_h
41 #define included_vlib_cli_h
43 #include <vppinfra/format.h>
45 struct vlib_cli_command_t;
50 /* Indexed by name[position] - min_char. */
52 } vlib_cli_parse_position_t;
58 } vlib_cli_sub_command_t;
66 } vlib_cli_sub_rule_t;
73 /* Number of bytes in parsed data. Zero for vector. */
76 unformat_function_t * unformat_function;
78 /* Opaque for unformat function. */
79 uword unformat_function_arg[2];
80 } vlib_cli_parse_rule_t;
82 /* CLI command callback function. */
83 typedef clib_error_t * (vlib_cli_command_function_t)
84 (struct vlib_main_t * vm,
85 unformat_input_t * input,
86 struct vlib_cli_command_t * cmd);
88 typedef struct vlib_cli_command_t {
89 /* Command path (e.g. "show something").
90 Spaces delimit elements of path. */
93 /* Short/long help strings. */
97 /* Callback function. */
98 vlib_cli_command_function_t * function;
106 /* Sub commands for this command. */
107 vlib_cli_sub_command_t * sub_commands;
109 /* Hash table mapping name (e.g. last path element) to sub command index. */
110 uword * sub_command_index_by_name;
112 /* bitmap[p][c][i] says whether sub-command i has character
114 vlib_cli_parse_position_t * sub_command_positions;
116 /* Hash table mapping name (e.g. last path element) to sub rule index. */
117 uword * sub_rule_index_by_name;
119 /* Vector of possible parse rules for this path. */
120 vlib_cli_sub_rule_t * sub_rules;
122 /* List of CLI commands, built by constructors */
123 struct vlib_cli_command_t * next_cli_command;
125 } vlib_cli_command_t;
127 typedef void (vlib_cli_output_function_t) (uword arg,
131 /* Vector of all known commands. */
132 vlib_cli_command_t * commands;
134 /* Hash table mapping normalized path to index into all_commands. */
135 uword * command_index_by_path;
137 /* Vector of all known parse rules. */
138 vlib_cli_parse_rule_t * parse_rules;
140 /* Hash table mapping parse rule name to index into parse_rule vector. */
141 uword * parse_rule_index_by_name;
143 /* Data parsed for rules. */
144 void ** parse_rule_data;
146 /* registration list added by constructors */
147 vlib_cli_command_t *cli_command_registrations;
150 #define VLIB_CLI_COMMAND(x,...) \
151 __VA_ARGS__ vlib_cli_command_t x; \
152 static void __vlib_cli_command_registration_##x (void) \
153 __attribute__((__constructor__)) ; \
154 static void __vlib_cli_command_registration_##x (void) \
156 vlib_main_t * vm = vlib_get_main(); \
157 vlib_cli_main_t *cm = &vm->cli_main; \
158 x.next_cli_command = cm->cli_command_registrations; \
159 cm->cli_command_registrations = &x; \
161 __VA_ARGS__ vlib_cli_command_t x
164 #define VLIB_CLI_PARSE_RULE(x) \
165 vlib_cli_parse_rule_t x
167 /* Output to current CLI connection. */
168 void vlib_cli_output (struct vlib_main_t * vm, char * fmt, ...);
170 /* Process CLI input. */
171 void vlib_cli_input (struct vlib_main_t * vm,
172 unformat_input_t * input,
173 vlib_cli_output_function_t * function,
176 clib_error_t * vlib_cli_register (struct vlib_main_t * vm,
177 vlib_cli_command_t * c);
178 clib_error_t * vlib_cli_register_parse_rule (struct vlib_main_t * vm,
179 vlib_cli_parse_rule_t * c);
181 uword unformat_vlib_cli_sub_input (unformat_input_t * i, va_list * args);
183 #endif /* included_vlib_cli_h */