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