]> git.proxmox.com Git - mirror_frr.git/blame_incremental - lib/command.h
projects / mirror_frr.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Merge pull request #3235 from opensourcerouting/buildfoo-20181024
[mirror_frr.git] / lib / command.h
... / ...
CommitLineData
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 along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#ifndef _ZEBRA_COMMAND_H
23#define _ZEBRA_COMMAND_H
24
25#include "vector.h"
26#include "vty.h"
27#include "lib/route_types.h"
28#include "graph.h"
29#include "memory.h"
30#include "hash.h"
31#include "command_graph.h"
32
33DECLARE_MTYPE(HOST)
34DECLARE_MTYPE(COMPLETION)
35
36/* Host configuration variable */
37struct host {
38 /* Host name of this router. */
39 char *name;
40
41 /* Domainname of this router */
42 char *domainname;
43
44 /* Password for vty interface. */
45 char *password;
46 char *password_encrypt;
47
48 /* Enable password */
49 char *enable;
50 char *enable_encrypt;
51
52 /* System wide terminal lines. */
53 int lines;
54
55 /* Log filename. */
56 char *logfile;
57
58 /* config file name of this host */
59 char *config;
60 int noconfig;
61
62 /* Flags for services */
63 int advanced;
64 int encrypt;
65
66 /* Banner configuration. */
67 const char *motd;
68 char *motdfile;
69};
70
71/* List of CLI nodes. Please remember to update the name array in command.c. */
72enum node_type {
73 AUTH_NODE, /* Authentication mode of vty interface. */
74 VIEW_NODE, /* View node. Default mode of vty interface. */
75 AUTH_ENABLE_NODE, /* Authentication mode for change enable. */
76 ENABLE_NODE, /* Enable node. */
77 CONFIG_NODE, /* Config node. Default mode of config file. */
78 DEBUG_NODE, /* Debug node. */
79 VRF_DEBUG_NODE, /* Vrf Debug node. */
80 DEBUG_VNC_NODE, /* Debug VNC node. */
81 AAA_NODE, /* AAA node. */
82 KEYCHAIN_NODE, /* Key-chain node. */
83 KEYCHAIN_KEY_NODE, /* Key-chain key node. */
84 LOGICALROUTER_NODE, /* Logical-Router node. */
85 IP_NODE, /* Static ip route node. */
86 VRF_NODE, /* VRF mode node. */
87 INTERFACE_NODE, /* Interface mode node. */
88 NH_GROUP_NODE, /* Nexthop-Group mode node. */
89 ZEBRA_NODE, /* zebra connection node. */
90 TABLE_NODE, /* rtm_table selection node. */
91 RIP_NODE, /* RIP protocol mode node. */
92 RIPNG_NODE, /* RIPng protocol mode node. */
93 BABEL_NODE, /* BABEL protocol mode node. */
94 EIGRP_NODE, /* EIGRP protocol mode node. */
95 BGP_NODE, /* BGP protocol mode which includes BGP4+ */
96 BGP_VPNV4_NODE, /* BGP MPLS-VPN PE exchange. */
97 BGP_VPNV6_NODE, /* BGP MPLS-VPN PE exchange. */
98 BGP_IPV4_NODE, /* BGP IPv4 unicast address family. */
99 BGP_IPV4M_NODE, /* BGP IPv4 multicast address family. */
100 BGP_IPV4L_NODE, /* BGP IPv4 labeled unicast address family. */
101 BGP_IPV6_NODE, /* BGP IPv6 address family */
102 BGP_IPV6M_NODE, /* BGP IPv6 multicast address family. */
103 BGP_IPV6L_NODE, /* BGP IPv6 labeled unicast address family. */
104 BGP_VRF_POLICY_NODE, /* BGP VRF policy */
105 BGP_VNC_DEFAULTS_NODE, /* BGP VNC nve defaults */
106 BGP_VNC_NVE_GROUP_NODE, /* BGP VNC nve group */
107 BGP_VNC_L2_GROUP_NODE, /* BGP VNC L2 group */
108 RFP_DEFAULTS_NODE, /* RFP defaults node */
109 BGP_EVPN_NODE, /* BGP EVPN node. */
110 OSPF_NODE, /* OSPF protocol mode */
111 OSPF6_NODE, /* OSPF protocol for IPv6 mode */
112 LDP_NODE, /* LDP protocol mode */
113 LDP_IPV4_NODE, /* LDP IPv4 address family */
114 LDP_IPV6_NODE, /* LDP IPv6 address family */
115 LDP_IPV4_IFACE_NODE, /* LDP IPv4 Interface */
116 LDP_IPV6_IFACE_NODE, /* LDP IPv6 Interface */
117 LDP_L2VPN_NODE, /* LDP L2VPN node */
118 LDP_PSEUDOWIRE_NODE, /* LDP Pseudowire node */
119 ISIS_NODE, /* ISIS protocol mode */
120 ACCESS_NODE, /* Access list node. */
121 PREFIX_NODE, /* Prefix list node. */
122 ACCESS_IPV6_NODE, /* Access list node. */
123 ACCESS_MAC_NODE, /* MAC access list node*/
124 PREFIX_IPV6_NODE, /* Prefix list node. */
125 AS_LIST_NODE, /* AS list node. */
126 COMMUNITY_LIST_NODE, /* Community list node. */
127 RMAP_NODE, /* Route map node. */
128 PBRMAP_NODE, /* PBR map node. */
129 SMUX_NODE, /* SNMP configuration node. */
130 DUMP_NODE, /* Packet dump node. */
131 FORWARDING_NODE, /* IP forwarding node. */
132 PROTOCOL_NODE, /* protocol filtering node */
133 MPLS_NODE, /* MPLS config node */
134 PW_NODE, /* Pseudowire config node */
135 VTY_NODE, /* Vty node. */
136 LINK_PARAMS_NODE, /* Link-parameters node */
137 BGP_EVPN_VNI_NODE, /* BGP EVPN VNI */
138 RPKI_NODE, /* RPKI node for configuration of RPKI cache server
139 connections.*/
140 BGP_FLOWSPECV4_NODE, /* BGP IPv4 FLOWSPEC Address-Family */
141 BGP_FLOWSPECV6_NODE, /* BGP IPv6 FLOWSPEC Address-Family */
142 BFD_NODE, /* BFD protocol mode. */
143 BFD_PEER_NODE, /* BFD peer configuration mode. */
144 OPENFABRIC_NODE, /* OpenFabric router configuration node */
145 NODE_TYPE_MAX, /* maximum */
146};
147
148extern vector cmdvec;
149extern const struct message tokennames[];
150extern const char *node_names[];
151
152/* Node which has some commands and prompt string and configuration
153 function pointer . */
154struct cmd_node {
155 /* Node index. */
156 enum node_type node;
157
158 /* Prompt character at vty interface. */
159 const char *prompt;
160
161 /* Is this node's configuration goes to vtysh ? */
162 int vtysh;
163
164 /* Node's configuration write function */
165 int (*func)(struct vty *);
166
167 /* Node's command graph */
168 struct graph *cmdgraph;
169
170 /* Vector of this node's command list. */
171 vector cmd_vector;
172
173 /* Hashed index of command node list, for de-dupping primarily */
174 struct hash *cmd_hash;
175};
176
177/* Return value of the commands. */
178#define CMD_SUCCESS 0
179#define CMD_WARNING 1
180#define CMD_ERR_NO_MATCH 2
181#define CMD_ERR_AMBIGUOUS 3
182#define CMD_ERR_INCOMPLETE 4
183#define CMD_ERR_EXEED_ARGC_MAX 5
184#define CMD_ERR_NOTHING_TODO 6
185#define CMD_COMPLETE_FULL_MATCH 7
186#define CMD_COMPLETE_MATCH 8
187#define CMD_COMPLETE_LIST_MATCH 9
188#define CMD_SUCCESS_DAEMON 10
189#define CMD_ERR_NO_FILE 11
190#define CMD_SUSPEND 12
191#define CMD_WARNING_CONFIG_FAILED 13
192#define CMD_NOT_MY_INSTANCE 14
193
194/* Argc max counts. */
195#define CMD_ARGC_MAX 256
196
197/* Turn off these macros when uisng cpp with extract.pl */
198#ifndef VTYSH_EXTRACT_PL
199
200/* helper defines for end-user DEFUN* macros */
201#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
202 static struct cmd_element cmdname = { \
203 .string = cmdstr, \
204 .func = funcname, \
205 .doc = helpstr, \
206 .attr = attrs, \
207 .daemon = dnum, \
208 .name = #cmdname, \
209 };
210
211#define DEFUN_CMD_FUNC_DECL(funcname) \
212 static int funcname(const struct cmd_element *, struct vty *, int, \
213 struct cmd_token *[]);
214
215#define DEFUN_CMD_FUNC_TEXT(funcname) \
216 static int funcname(const struct cmd_element *self \
217 __attribute__((unused)), \
218 struct vty *vty __attribute__((unused)), \
219 int argc __attribute__((unused)), \
220 struct cmd_token *argv[] __attribute__((unused)))
221
222#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
223 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
224 funcdecl_##funcname
225
226#define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
227 DEFPY(funcname, cmdname, cmdstr, helpstr)
228
229#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
230 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
231 funcdecl_##funcname
232
233#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
234 DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
235
236#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
237 DEFUN_CMD_FUNC_DECL(funcname) \
238 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
239 DEFUN_CMD_FUNC_TEXT(funcname)
240
241#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
242 DEFUN_CMD_FUNC_DECL(funcname) \
243 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
244 DEFUN_CMD_FUNC_TEXT(funcname)
245
246#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
247 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
248
249/* DEFUN_NOSH for commands that vtysh should ignore */
250#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
251 DEFUN(funcname, cmdname, cmdstr, helpstr)
252
253/* DEFSH for vtysh. */
254#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
255 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
256
257#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
258 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
259 daemon)
260
261/* DEFUN + DEFSH */
262#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
263 DEFUN_CMD_FUNC_DECL(funcname) \
264 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
265 DEFUN_CMD_FUNC_TEXT(funcname)
266
267/* DEFUN + DEFSH with attributes */
268#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
269 DEFUN_CMD_FUNC_DECL(funcname) \
270 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
271 DEFUN_CMD_FUNC_TEXT(funcname)
272
273#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
274 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
275 CMD_ATTR_HIDDEN)
276
277#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
278 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
279 CMD_ATTR_DEPRECATED)
280
281/* ALIAS macro which define existing command's alias. */
282#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
283 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
284
285#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
286 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
287
288#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
289 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
290 0)
291
292#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
293 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
294 CMD_ATTR_DEPRECATED, 0)
295
296#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
297 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
298
299#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
300 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
301 daemon)
302
303#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
304 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
305 CMD_ATTR_DEPRECATED, daemon)
306
307#else /* VTYSH_EXTRACT_PL */
308#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
309 DEFUN(funcname, cmdname, cmdstr, helpstr)
310
311#define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr) \
312 DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr)
313
314#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
315 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)
316#endif /* VTYSH_EXTRACT_PL */
317
318/* Some macroes */
319
320/*
321 * Sometimes #defines create maximum values that
322 * need to have strings created from them that
323 * allow the parser to match against them.
324 * These macros allow that.
325 */
326#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
327#define CMD_CREATE_STR_HELPER(s) #s
328#define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
329
330/* Common descriptions. */
331#define SHOW_STR "Show running system information\n"
332#define IP_STR "IP information\n"
333#define IPV6_STR "IPv6 information\n"
334#define NO_STR "Negate a command or set its defaults\n"
335#define REDIST_STR "Redistribute information from another routing protocol\n"
336#define CLEAR_STR "Reset functions\n"
337#define RIP_STR "RIP information\n"
338#define EIGRP_STR "EIGRP information\n"
339#define BGP_STR "BGP information\n"
340#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
341#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
342#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
343#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
344#define OSPF_STR "OSPF information\n"
345#define NEIGHBOR_STR "Specify neighbor router\n"
346#define DEBUG_STR "Debugging functions\n"
347#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
348#define ROUTER_STR "Enable a routing process\n"
349#define AS_STR "AS number\n"
350#define MAC_STR "MAC address\n"
351#define MBGP_STR "MBGP information\n"
352#define MATCH_STR "Match values from routing table\n"
353#define SET_STR "Set values in destination routing protocol\n"
354#define OUT_STR "Filter outgoing routing updates\n"
355#define IN_STR "Filter incoming routing updates\n"
356#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
357#define OSPF6_NUMBER_STR "Specify by number\n"
358#define INTERFACE_STR "Interface information\n"
359#define IFNAME_STR "Interface name(e.g. ep0)\n"
360#define IP6_STR "IPv6 Information\n"
361#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
362#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
363#define SECONDS_STR "Seconds\n"
364#define ROUTE_STR "Routing Table\n"
365#define PREFIX_LIST_STR "Build a prefix list\n"
366#define OSPF6_DUMP_TYPE_LIST \
367 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
368#define AREA_TAG_STR "[area tag]\n"
369#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
370#define COMMUNITY_VAL_STR "Community number in AA:NN format (where AA and NN are (0-65535)) or local-AS|no-advertise|no-export|internet or additive\n"
371#define MPLS_TE_STR "MPLS-TE specific commands\n"
372#define LINK_PARAMS_STR "Configure interface link parameters\n"
373#define OSPF_RI_STR "OSPF Router Information specific commands\n"
374#define PCE_STR "PCE Router Information specific commands\n"
375#define MPLS_STR "MPLS information\n"
376#define SR_STR "Segment-Routing specific commands\n"
377#define WATCHFRR_STR "watchfrr information\n"
378#define ZEBRA_STR "Zebra information\n"
379
380#define CONF_BACKUP_EXT ".sav"
381
382/* Command warnings. */
383#define NO_PASSWD_CMD_WARNING \
384 "Please be aware that removing the password is a security risk and you should think twice about this command.\n"
385
386/* IPv4 only machine should not accept IPv6 address for peer's IP
387 address. So we replace VTY command string like below. */
388#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
389#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
390#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
391
392/* Prototypes. */
393extern void install_node(struct cmd_node *, int (*)(struct vty *));
394extern void install_default(enum node_type);
395extern void install_element(enum node_type, struct cmd_element *);
396
397/* known issue with uninstall_element: changes to cmd_token->attr (i.e.
398 * deprecated/hidden) are not reversed. */
399extern void uninstall_element(enum node_type, struct cmd_element *);
400
401/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
402 string with a space between each element (allocated using
403 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
404extern char *argv_concat(struct cmd_token **argv, int argc, int shift);
405
406/*
407 * It is preferred that you set the index initial value
408 * to a 0. This way in the future if you modify the
409 * cli then there is no need to modify the initial
410 * value of the index
411 */
412extern int argv_find(struct cmd_token **argv, int argc, const char *text,
413 int *index);
414
415extern vector cmd_make_strvec(const char *);
416extern void cmd_free_strvec(vector);
417extern vector cmd_describe_command(vector, struct vty *, int *status);
418extern char **cmd_complete_command(vector, struct vty *, int *status);
419extern const char *cmd_prompt(enum node_type);
420extern int command_config_read_one_line(struct vty *vty,
421 const struct cmd_element **,
422 uint32_t line_num, int use_config_node);
423extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
424extern enum node_type node_parent(enum node_type);
425/*
426 * Execute command under the given vty context.
427 *
428 * vty
429 * The vty context to execute under.
430 *
431 * cmd
432 * The command string to execute.
433 *
434 * matched
435 * If non-null and a match was found, the address of the matched command is
436 * stored here. No action otherwise.
437 *
438 * vtysh
439 * Whether or not this is being called from vtysh. If this is nonzero,
440 * XXX: then what?
441 *
442 * Returns:
443 * XXX: what does it return
444 */
445extern int cmd_execute(struct vty *vty, const char *cmd,
446 const struct cmd_element **matched, int vtysh);
447extern int cmd_execute_command(vector, struct vty *,
448 const struct cmd_element **, int);
449extern int cmd_execute_command_strict(vector, struct vty *,
450 const struct cmd_element **);
451extern void cmd_init(int);
452extern void cmd_terminate(void);
453extern void cmd_exit(struct vty *vty);
454extern int cmd_list_cmds(struct vty *vty, int do_permute);
455
456extern int cmd_domainname_set(const char *domainname);
457extern int cmd_hostname_set(const char *hostname);
458extern const char *cmd_hostname_get(void);
459extern const char *cmd_domainname_get(void);
460
461/* NOT safe for general use; call this only if DEV_BUILD! */
462extern void grammar_sandbox_init(void);
463
464extern vector completions_to_vec(struct list *completions);
465
466/* Export typical functions. */
467extern const char *host_config_get(void);
468extern void host_config_set(const char *);
469
470extern void print_version(const char *);
471
472extern int cmd_banner_motd_file(const char *);
473
474/* struct host global, ick */
475extern struct host host;
476
477struct cmd_variable_handler {
478 const char *tokenname, *varname;
479 void (*completions)(vector out, struct cmd_token *token);
480};
481
482extern void cmd_variable_complete(struct cmd_token *token, const char *arg,
483 vector comps);
484extern void
485cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
486extern char *cmd_variable_comp2str(vector comps, unsigned short cols);
487
488extern void command_setup_early_logging(const char *dest, const char *level);
489#endif /* _ZEBRA_COMMAND_H */
FRRouting mirror