libosmovty  0.12.0
Osmocom VTY library
command.h
Go to the documentation of this file.
1 
3 /*
4  * Copyright (C) 1997, 98 Kunihiro Ishiguro
5  *
6  * This file is part of GNU Zebra.
7  *
8  * GNU Zebra is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published
10  * by the Free Software Foundation; either version 2, or (at your
11  * option) any later version.
12  *
13  * GNU Zebra is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with GNU Zebra; see the file COPYING. If not, write to the
20  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23 
24 #pragma once
25 
26 #include <stdio.h>
27 #include <sys/types.h>
28 #include "vector.h"
29 
30 #include <osmocom/core/defs.h>
31 
37 struct host {
39  char *name;
40 
42  char *password;
44 
46  char *enable;
48 
50  int lines;
51 
53  char *logfile;
54 
56  char *config;
57 
59  int advanced;
60  int encrypt;
61 
63  const char *motd;
64  char *motdfile;
65 
67  const struct vty_app_info *app_info;
68 };
69 
71 enum node_type {
100  /*
101  * When adding new nodes to the libosmocore project, these nodes can be
102  * used to avoid ABI changes for unrelated projects.
103  */
107 };
108 
109 #include "vty.h"
110 
113 struct cmd_node {
115  int node;
116 
118  const char *prompt;
119 
121  int vtysh;
122 
124  int (*func) (struct vty *);
125 
128 
132  char name[64];
133 };
134 
135 enum {
138 };
139 
141 struct cmd_element {
142  const char *string;
143  int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
144  const char *doc;
145  int daemon;
147  unsigned int cmdsize;
148  char *config;
150  unsigned char attr;
151 };
152 
154 struct desc {
155  const char *cmd;
156  const char *str;
157 };
158 
160 #define CMD_SUCCESS 0
161 #define CMD_WARNING 1
162 #define CMD_ERR_NO_MATCH 2
163 #define CMD_ERR_AMBIGUOUS 3
164 #define CMD_ERR_INCOMPLETE 4
165 #define CMD_ERR_EXEED_ARGC_MAX 5
166 #define CMD_ERR_NOTHING_TODO 6
167 #define CMD_COMPLETE_FULL_MATCH 7
168 #define CMD_COMPLETE_MATCH 8
169 #define CMD_COMPLETE_LIST_MATCH 9
170 #define CMD_SUCCESS_DAEMON 10
171 #define CMD_ERR_INVALID_INDENT 11
172 
173 /* Argc max counts. */
174 #define CMD_ARGC_MAX 256
175 
176 /* Turn off these macros when uisng cpp with extract.pl */
177 #ifndef VTYSH_EXTRACT_PL
178 
179 /* helper defines for end-user DEFUN* macros */
180 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
181  static struct cmd_element cmdname = \
182  { \
183  .string = cmdstr, \
184  .func = funcname, \
185  .doc = helpstr, \
186  .attr = attrs, \
187  .daemon = dnum, \
188  };
189 
190 /* global (non static) cmd_element */
191 #define gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
192  struct cmd_element cmdname = \
193  { \
194  .string = cmdstr, \
195  .func = funcname, \
196  .doc = helpstr, \
197  .attr = attrs, \
198  .daemon = dnum, \
199  };
200 
201 #define DEFUN_CMD_FUNC_DECL(funcname) \
202  static int funcname (struct cmd_element *, struct vty *, int, const char *[]); \
203 
204 #define DEFUN_CMD_FUNC_TEXT(funcname) \
205  static int funcname \
206  (struct cmd_element *self, struct vty *vty, int argc, const char *argv[])
207 
214 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
215  DEFUN_CMD_FUNC_DECL(funcname) \
216  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
217  DEFUN_CMD_FUNC_TEXT(funcname)
218 
225 #define gDEFUN(funcname, cmdname, cmdstr, helpstr) \
226  DEFUN_CMD_FUNC_DECL(funcname) \
227  gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
228  DEFUN_CMD_FUNC_TEXT(funcname)
229 
230 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
231  DEFUN_CMD_FUNC_DECL(funcname) \
232  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
233  DEFUN_CMD_FUNC_TEXT(funcname)
234 
235 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
236  DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
237 
238 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
239  DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
240 
241 /* DEFUN_NOSH for commands that vtysh should ignore */
242 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
243  DEFUN(funcname, cmdname, cmdstr, helpstr)
244 
245 /* DEFSH for vtysh. */
246 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
247  DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
248 
249 /* DEFUN + DEFSH */
250 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
251  DEFUN_CMD_FUNC_DECL(funcname) \
252  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
253  DEFUN_CMD_FUNC_TEXT(funcname)
254 
255 /* DEFUN + DEFSH with attributes */
256 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
257  DEFUN_CMD_FUNC_DECL(funcname) \
258  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
259  DEFUN_CMD_FUNC_TEXT(funcname)
260 
261 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
262  DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
263 
264 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
265  DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
266 
267 /* ALIAS macro which define existing command's alias. */
268 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
269  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
270 
271 /* global (non static) cmd_element */
272 #define gALIAS(funcname, cmdname, cmdstr, helpstr) \
273  gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
274 
275 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
276  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
277 
278 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
279  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
280 
281 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
282  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
283 
284 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
285  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
286 
287 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
288  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
289 
290 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
291  DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
292 
293 #endif /* VTYSH_EXTRACT_PL */
294 
295 /* Some macroes */
296 #define CMD_OPTION(S) ((S[0]) == '[')
297 #define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<'))
298 #define CMD_VARARG(S) ((S[0]) == '.')
299 #define CMD_RANGE(S) ((S[0] == '<'))
300 
301 #define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0))
302 #define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0))
303 #define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0))
304 #define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0))
305 
306 /* Common descriptions. */
307 #define SHOW_STR "Show running system information\n"
308 #define IP_STR "IP information\n"
309 #define IPV6_STR "IPv6 information\n"
310 #define NO_STR "Negate a command or set its defaults\n"
311 #define CLEAR_STR "Reset functions\n"
312 #define RIP_STR "RIP information\n"
313 #define BGP_STR "BGP information\n"
314 #define OSPF_STR "OSPF information\n"
315 #define NEIGHBOR_STR "Specify neighbor router\n"
316 #define DEBUG_STR "Debugging functions (see also 'undebug')\n"
317 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
318 #define ROUTER_STR "Enable a routing process\n"
319 #define AS_STR "AS number\n"
320 #define MBGP_STR "MBGP information\n"
321 #define MATCH_STR "Match values from routing table\n"
322 #define SET_STR "Set values in destination routing protocol\n"
323 #define OUT_STR "Filter outgoing routing updates\n"
324 #define IN_STR "Filter incoming routing updates\n"
325 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
326 #define OSPF6_NUMBER_STR "Specify by number\n"
327 #define INTERFACE_STR "Interface infomation\n"
328 #define IFNAME_STR "Interface name(e.g. ep0)\n"
329 #define IP6_STR "IPv6 Information\n"
330 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
331 #define OSPF6_ROUTER_STR "Enable a routing process\n"
332 #define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
333 #define SECONDS_STR "<1-65535> Seconds\n"
334 #define ROUTE_STR "Routing Table\n"
335 #define PREFIX_LIST_STR "Build a prefix list\n"
336 #define OSPF6_DUMP_TYPE_LIST \
337 "(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
338 #define ISIS_STR "IS-IS information\n"
339 #define AREA_TAG_STR "[area tag]\n"
340 
341 #define CONF_BACKUP_EXT ".sav"
342 
343 /* IPv4 only machine should not accept IPv6 address for peer's IP
344  address. So we replace VTY command string like below. */
345 #ifdef HAVE_IPV6
346 #define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) "
347 #define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) "
348 #define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
349 #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) "
350 #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) "
351 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n"
352 #else
353 #define NEIGHBOR_CMD "neighbor A.B.C.D "
354 #define NO_NEIGHBOR_CMD "no neighbor A.B.C.D "
355 #define NEIGHBOR_ADDR_STR "Neighbor address\n"
356 #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) "
357 #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) "
358 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
359 #endif /* HAVE_IPV6 */
360 
361 /* Prototypes. */
362 void install_node(struct cmd_node *, int (*)(struct vty *));
363 void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
364 void install_element(int node_type, struct cmd_element *);
365 void install_element_ve(struct cmd_element *cmd);
366 void sort_node(void);
367 
368 void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
369 
370 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
371  string with a space between each element (allocated using
372  XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
373 char *argv_concat(const char **argv, int argc, int shift);
374 
375 vector cmd_make_strvec(const char *);
376 int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p);
377 void cmd_free_strvec(vector);
380 const char *cmd_prompt(enum node_type);
381 int config_from_file(struct vty *, FILE *);
382 enum node_type node_parent(enum node_type);
383 int cmd_execute_command(vector, struct vty *, struct cmd_element **, int);
384 int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **);
385 void config_replace_string(struct cmd_element *, char *, ...);
386 void cmd_init(int);
387 
388 /* Export typical functions. */
389 extern struct cmd_element config_exit_cmd;
390 extern struct cmd_element config_help_cmd;
391 extern struct cmd_element config_list_cmd;
392 extern struct cmd_element config_end_cmd;
394 void host_config_set(const char *);
395 
396 char *osmo_asciidoc_escape(const char *inp);
397 
398 /* This is called from main when a daemon is invoked with -v or --version. */
399 void print_version(int print_copyright);
400 
401 extern void *tall_vty_cmd_ctx;
402 
_vector
Definition: vector.h:27
cmd_node::node
int node
Node index.
Definition: command.h:115
tall_vty_cmd_ctx
void * tall_vty_cmd_ctx
Definition: command.c:63
host::advanced
int advanced
Flags for services.
Definition: command.h:59
cmd_node::func
int(* func)(struct vty *)
Node's configuration write function.
Definition: command.h:124
install_default
void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()")
Deprecated, now happens implicitly when calling install_node().
Definition: command.c:3687
cmd_execute_command
int cmd_execute_command(vector, struct vty *, struct cmd_element **, int)
Definition: command.c:2302
cmd_element::doc
const char * doc
Documentation of this command.
Definition: command.h:144
cmd_element::config
char * config
Configuration string.
Definition: command.h:148
config_end_cmd
struct cmd_element config_end_cmd
DEBUG_NODE
@ DEBUG_NODE
Debug node.
Definition: command.h:78
desc::cmd
const char * cmd
Command string.
Definition: command.h:155
cmd_free_strvec
void cmd_free_strvec(vector)
Free allocated string vector.
Definition: command.c:334
cmd_element
Structure of a command element.
Definition: command.h:141
node_type
node_type
There are some command levels which called from command node.
Definition: command.h:71
host::password
char * password
Password for vty interface.
Definition: command.h:42
config_list_cmd
struct cmd_element config_list_cmd
cmd_element::subconfig
vector subconfig
Sub configuration string.
Definition: command.h:149
cmd_element::cmdsize
unsigned int cmdsize
Command index count.
Definition: command.h:147
CFG_STATS_NODE
@ CFG_STATS_NODE
Configure the statistics.
Definition: command.h:80
cmd_node::name
char name[64]
Human-readable ID of this node.
Definition: command.h:132
L_E1INP_NODE
@ L_E1INP_NODE
E1 line in libosmo-abis.
Definition: command.h:84
vty.h
L_CS7_AS_NODE
@ L_CS7_AS_NODE
SS7 Application Server.
Definition: command.h:91
L_CS7_LINKSET_NODE
@ L_CS7_LINKSET_NODE
SS7 Linkset.
Definition: command.h:96
cmd_node
Node which has some commands and prompt string and configuration function pointer .
Definition: command.h:113
install_element_ve
void install_element_ve(struct cmd_element *cmd)
Definition: command.c:775
osmo_asciidoc_escape
char * osmo_asciidoc_escape(const char *inp)
escape all special asciidoc symbols
Definition: command.c:501
host_config_set
void host_config_set(const char *)
Definition: command.c:3679
cmd_element::func
int(* func)(struct cmd_element *, struct vty *, int, const char *[])
Definition: command.h:143
RESERVED3_NODE
@ RESERVED3_NODE
Reserved for later extensions.
Definition: command.h:104
L_CS7_ASP_NODE
@ L_CS7_ASP_NODE
SS7 Application Server Process.
Definition: command.h:92
AUTH_ENABLE_NODE
@ AUTH_ENABLE_NODE
Authentication mode for change enable.
Definition: command.h:74
install_node
void install_node(struct cmd_node *, int(*)(struct vty *))
Install top node of command vector.
Definition: command.c:180
CONFIG_NODE
@ CONFIG_NODE
Config node.
Definition: command.h:76
L_CTRL_NODE
@ L_CTRL_NODE
Control interface node.
Definition: command.h:88
L_CS7_RTABLE_NODE
@ L_CS7_RTABLE_NODE
SS7 Routing Table.
Definition: command.h:94
cmd_element::strvec
vector strvec
Pointing out each description vector.
Definition: command.h:146
CFG_LOG_NODE
@ CFG_LOG_NODE
Configure the logging.
Definition: command.h:79
host::motdfile
char * motdfile
Definition: command.h:64
vty_install_default
void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()")
Deprecated, now happens implicitly when calling install_node().
Definition: command.c:3694
node_parent
enum node_type node_parent(enum node_type)
vty
Internal representation of a single VTY.
Definition: vty.h:65
config_from_file
int config_from_file(struct vty *, FILE *)
Definition: command.c:2472
cmd_prompt
const char * cmd_prompt(enum node_type)
Return prompt character of specified node.
Definition: command.c:488
L_CS7_NODE
@ L_CS7_NODE
SS7 root node.
Definition: command.h:90
host::enable_encrypt
char * enable_encrypt
Definition: command.h:47
host::lines
int lines
System wide terminal lines.
Definition: command.h:50
ENABLE_NODE
@ ENABLE_NODE
Enable node.
Definition: command.h:75
config_exit_cmd
struct cmd_element config_exit_cmd
AUTH_NODE
@ AUTH_NODE
Authentication mode of vty interface.
Definition: command.h:72
cmd_element::string
const char * string
Command specification by string.
Definition: command.h:142
cmd_element::daemon
int daemon
Daemon to which this command belong.
Definition: command.h:145
cmd_element::attr
unsigned char attr
Command attributes.
Definition: command.h:150
host::app_info
const struct vty_app_info * app_info
VTY application information.
Definition: command.h:67
L_NS_NODE
@ L_NS_NODE
NS node in libosmo-gb.
Definition: command.h:86
L_IPA_NODE
@ L_IPA_NODE
IPA proxying commands in libosmo-abis.
Definition: command.h:85
host::enable
char * enable
Enable password.
Definition: command.h:46
install_element
void install_element(int node_type, struct cmd_element *)
Install a command into a node.
Definition: command.c:757
host::encrypt
int encrypt
Definition: command.h:60
VIEW_NODE
@ VIEW_NODE
View node.
Definition: command.h:73
CMD_ATTR_HIDDEN
@ CMD_ATTR_HIDDEN
Definition: command.h:137
config_help_cmd
struct cmd_element config_help_cmd
cmd_node::vtysh
int vtysh
Is this node's configuration goes to vtysh ?
Definition: command.h:121
print_version
void print_version(int print_copyright)
print the version (and optionally copyright) information
Definition: command.c:109
host::name
char * name
Host name of this router.
Definition: command.h:39
host::config
char * config
config file name of this host
Definition: command.h:56
host::password_encrypt
char * password_encrypt
Definition: command.h:43
CMD_ATTR_DEPRECATED
@ CMD_ATTR_DEPRECATED
Definition: command.h:136
L_CS7_SCCPADDR_NODE
@ L_CS7_SCCPADDR_NODE
SS7 SCCP Address.
Definition: command.h:97
desc
Command description structure.
Definition: command.h:154
host
Host configuration variable.
Definition: command.h:37
host_config_file
char * host_config_file()
host::logfile
char * logfile
Log filename.
Definition: command.h:53
L_CS7_LINK_NODE
@ L_CS7_LINK_NODE
SS7 Link.
Definition: command.h:95
cmd_complete_command
char ** cmd_complete_command()
vector.h
L_CS7_SCCPADDR_GT_NODE
@ L_CS7_SCCPADDR_GT_NODE
SS7 SCCP Global Title.
Definition: command.h:98
L_BSSGP_NODE
@ L_BSSGP_NODE
BSSGP node in libosmo-gb.
Definition: command.h:87
cmd_init
void cmd_init(int)
Definition: command.c:3778
VTY_NODE
@ VTY_NODE
Vty node.
Definition: command.h:82
SERVICE_NODE
@ SERVICE_NODE
Service node.
Definition: command.h:77
L_CS7_XUA_NODE
@ L_CS7_XUA_NODE
SS7 xUA Listener.
Definition: command.h:93
cmd_execute_command_strict
int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **)
Definition: command.c:2336
host::motd
const char * motd
Banner configuration.
Definition: command.h:63
cmd_make_strvec2
int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p)
Break up string in command tokens.
Definition: command.c:255
argv_concat
char * argv_concat(const char **argv, int argc, int shift)
Definition: command.c:118
cmd_node::cmd_vector
vector cmd_vector
Vector of this node's command list.
Definition: command.h:127
_LAST_OSMOVTY_NODE
@ _LAST_OSMOVTY_NODE
Definition: command.h:106
config_replace_string
void config_replace_string(struct cmd_element *, char *,...)
cmd_describe_command
vector cmd_describe_command()
sort_node
void sort_node(void)
Sort each node's command element according to command string.
Definition: command.c:216
cmd_node::prompt
const char * prompt
Prompt character at vty interface.
Definition: command.h:118
desc::str
const char * str
Command's description.
Definition: command.h:156
vty_app_info
Information an application registers with the VTY.
Definition: vty.h:171
cmd_make_strvec
vector cmd_make_strvec(const char *)
Breaking up string into each command piece.
Definition: command.c:326