]>
Commit | Line | Data |
---|---|---|
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 | ||
33 | DECLARE_MTYPE(HOST) | |
34 | DECLARE_MTYPE(COMPLETION) | |
35 | ||
36 | /* for test-commands.c */ | |
37 | DECLARE_MTYPE(STRVEC) | |
38 | ||
39 | /* Host configuration variable */ | |
40 | struct host | |
41 | { | |
42 | /* Host name of this router. */ | |
43 | char *name; | |
44 | ||
45 | /* Password for vty interface. */ | |
46 | char *password; | |
47 | char *password_encrypt; | |
48 | ||
49 | /* Enable password */ | |
50 | char *enable; | |
51 | char *enable_encrypt; | |
52 | ||
53 | /* System wide terminal lines. */ | |
54 | int lines; | |
55 | ||
56 | /* Log filename. */ | |
57 | char *logfile; | |
58 | ||
59 | /* config file name of this host */ | |
60 | char *config; | |
61 | int noconfig; | |
62 | ||
63 | /* Flags for services */ | |
64 | int advanced; | |
65 | int encrypt; | |
66 | ||
67 | /* Banner configuration. */ | |
68 | const char *motd; | |
69 | char *motdfile; | |
70 | }; | |
71 | ||
72 | /* There are some command levels which called from command node. */ | |
73 | enum node_type | |
74 | { | |
75 | AUTH_NODE, /* Authentication mode of vty interface. */ | |
76 | VIEW_NODE, /* View node. Default mode of vty interface. */ | |
77 | AUTH_ENABLE_NODE, /* Authentication mode for change enable. */ | |
78 | ENABLE_NODE, /* Enable node. */ | |
79 | CONFIG_NODE, /* Config node. Default mode of config file. */ | |
80 | SERVICE_NODE, /* Service node. */ | |
81 | DEBUG_NODE, /* Debug node. */ | |
82 | VRF_DEBUG_NODE, /* Vrf Debug node. */ | |
83 | DEBUG_VNC_NODE, /* Debug VNC node. */ | |
84 | AAA_NODE, /* AAA node. */ | |
85 | KEYCHAIN_NODE, /* Key-chain node. */ | |
86 | KEYCHAIN_KEY_NODE, /* Key-chain key node. */ | |
87 | NS_NODE, /* Logical-Router node. */ | |
88 | VRF_NODE, /* VRF mode node. */ | |
89 | INTERFACE_NODE, /* Interface mode node. */ | |
90 | ZEBRA_NODE, /* zebra connection node. */ | |
91 | TABLE_NODE, /* rtm_table selection node. */ | |
92 | RIP_NODE, /* RIP protocol mode node. */ | |
93 | RIPNG_NODE, /* RIPng protocol mode node. */ | |
94 | BABEL_NODE, /* BABEL protocol mode node. */ | |
95 | EIGRP_NODE, /* EIGRP protocol mode node. */ | |
96 | BGP_NODE, /* BGP protocol mode which includes BGP4+ */ | |
97 | BGP_VPNV4_NODE, /* BGP MPLS-VPN PE exchange. */ | |
98 | BGP_VPNV6_NODE, /* BGP MPLS-VPN PE exchange. */ | |
99 | BGP_IPV4_NODE, /* BGP IPv4 unicast address family. */ | |
100 | BGP_IPV4M_NODE, /* BGP IPv4 multicast address family. */ | |
101 | BGP_IPV4L_NODE, /* BGP IPv4 labeled unicast address family. */ | |
102 | BGP_IPV6_NODE, /* BGP IPv6 address family */ | |
103 | BGP_IPV6M_NODE, /* BGP IPv6 multicast address family. */ | |
104 | BGP_IPV6L_NODE, /* BGP IPv6 labeled unicast address family. */ | |
105 | BGP_VRF_POLICY_NODE, /* BGP VRF policy */ | |
106 | BGP_VNC_DEFAULTS_NODE, /* BGP VNC nve defaults */ | |
107 | BGP_VNC_NVE_GROUP_NODE, /* BGP VNC nve group */ | |
108 | BGP_VNC_L2_GROUP_NODE, /* BGP VNC L2 group */ | |
109 | RFP_DEFAULTS_NODE, /* RFP defaults node */ | |
110 | BGP_EVPN_NODE, /* BGP EVPN node. */ | |
111 | OSPF_NODE, /* OSPF protocol mode */ | |
112 | OSPF6_NODE, /* OSPF protocol for IPv6 mode */ | |
113 | LDP_NODE, /* LDP protocol mode */ | |
114 | LDP_IPV4_NODE, /* LDP IPv4 address family */ | |
115 | LDP_IPV6_NODE, /* LDP IPv6 address family */ | |
116 | LDP_IPV4_IFACE_NODE, /* LDP IPv4 Interface */ | |
117 | LDP_IPV6_IFACE_NODE, /* LDP IPv6 Interface */ | |
118 | LDP_L2VPN_NODE, /* LDP L2VPN node */ | |
119 | LDP_PSEUDOWIRE_NODE, /* LDP Pseudowire node */ | |
120 | ISIS_NODE, /* ISIS protocol mode */ | |
121 | PIM_NODE, /* PIM protocol mode */ | |
122 | MASC_NODE, /* MASC for multicast. */ | |
123 | IRDP_NODE, /* ICMP Router Discovery Protocol mode. */ | |
124 | IP_NODE, /* Static ip route node. */ | |
125 | ACCESS_NODE, /* Access list node. */ | |
126 | PREFIX_NODE, /* Prefix list node. */ | |
127 | ACCESS_IPV6_NODE, /* Access list node. */ | |
128 | PREFIX_IPV6_NODE, /* Prefix list node. */ | |
129 | AS_LIST_NODE, /* AS list node. */ | |
130 | COMMUNITY_LIST_NODE, /* Community list node. */ | |
131 | RMAP_NODE, /* Route map node. */ | |
132 | SMUX_NODE, /* SNMP configuration node. */ | |
133 | DUMP_NODE, /* Packet dump node. */ | |
134 | FORWARDING_NODE, /* IP forwarding node. */ | |
135 | PROTOCOL_NODE, /* protocol filtering node */ | |
136 | MPLS_NODE, /* MPLS config node */ | |
137 | VTY_NODE, /* Vty node. */ | |
138 | LINK_PARAMS_NODE, /* Link-parameters node */ | |
139 | }; | |
140 | ||
141 | /* Node which has some commands and prompt string and configuration | |
142 | function pointer . */ | |
143 | struct cmd_node | |
144 | { | |
145 | /* Node index. */ | |
146 | enum node_type node; | |
147 | ||
148 | /* Prompt character at vty interface. */ | |
149 | const char *prompt; | |
150 | ||
151 | /* Is this node's configuration goes to vtysh ? */ | |
152 | int vtysh; | |
153 | ||
154 | /* Node's configuration write function */ | |
155 | int (*func) (struct vty *); | |
156 | ||
157 | /* Node's command graph */ | |
158 | struct graph *cmdgraph; | |
159 | ||
160 | /* Vector of this node's command list. */ | |
161 | vector cmd_vector; | |
162 | ||
163 | /* Hashed index of command node list, for de-dupping primarily */ | |
164 | struct hash *cmd_hash; | |
165 | }; | |
166 | ||
167 | /* Return value of the commands. */ | |
168 | #define CMD_SUCCESS 0 | |
169 | #define CMD_WARNING 1 | |
170 | #define CMD_ERR_NO_MATCH 2 | |
171 | #define CMD_ERR_AMBIGUOUS 3 | |
172 | #define CMD_ERR_INCOMPLETE 4 | |
173 | #define CMD_ERR_EXEED_ARGC_MAX 5 | |
174 | #define CMD_ERR_NOTHING_TODO 6 | |
175 | #define CMD_COMPLETE_FULL_MATCH 7 | |
176 | #define CMD_COMPLETE_MATCH 8 | |
177 | #define CMD_COMPLETE_LIST_MATCH 9 | |
178 | #define CMD_SUCCESS_DAEMON 10 | |
179 | #define CMD_ERR_NO_FILE 11 | |
180 | #define CMD_SUSPEND 12 | |
181 | ||
182 | /* Argc max counts. */ | |
183 | #define CMD_ARGC_MAX 25 | |
184 | ||
185 | /* Turn off these macros when uisng cpp with extract.pl */ | |
186 | #ifndef VTYSH_EXTRACT_PL | |
187 | ||
188 | /* helper defines for end-user DEFUN* macros */ | |
189 | #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \ | |
190 | static struct cmd_element cmdname = \ | |
191 | { \ | |
192 | .string = cmdstr, \ | |
193 | .func = funcname, \ | |
194 | .doc = helpstr, \ | |
195 | .attr = attrs, \ | |
196 | .daemon = dnum, \ | |
197 | .name = #cmdname, \ | |
198 | }; | |
199 | ||
200 | #define DEFUN_CMD_FUNC_DECL(funcname) \ | |
201 | static int funcname (const struct cmd_element *, struct vty *, int, struct cmd_token *[]); | |
202 | ||
203 | #define DEFUN_CMD_FUNC_TEXT(funcname) \ | |
204 | static int funcname \ | |
205 | (const struct cmd_element *self __attribute__ ((unused)), \ | |
206 | struct vty *vty __attribute__ ((unused)), \ | |
207 | int argc __attribute__ ((unused)), \ | |
208 | struct cmd_token *argv[] __attribute__ ((unused)) ) | |
209 | ||
210 | #define DEFPY(funcname, cmdname, cmdstr, helpstr) \ | |
211 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \ | |
212 | funcdecl_##funcname | |
213 | ||
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 | ||
219 | #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \ | |
220 | DEFUN_CMD_FUNC_DECL(funcname) \ | |
221 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \ | |
222 | DEFUN_CMD_FUNC_TEXT(funcname) | |
223 | ||
224 | #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ | |
225 | DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN) | |
226 | ||
227 | #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ | |
228 | DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \ | |
229 | ||
230 | /* DEFUN_NOSH for commands that vtysh should ignore */ | |
231 | #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \ | |
232 | DEFUN(funcname, cmdname, cmdstr, helpstr) | |
233 | ||
234 | /* DEFSH for vtysh. */ | |
235 | #define DEFSH(daemon, cmdname, cmdstr, helpstr) \ | |
236 | DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \ | |
237 | ||
238 | #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \ | |
239 | DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 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 | #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \ | |
264 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) | |
265 | ||
266 | #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ | |
267 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0) | |
268 | ||
269 | #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ | |
270 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0) | |
271 | ||
272 | #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \ | |
273 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) | |
274 | ||
275 | #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \ | |
276 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) | |
277 | ||
278 | #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \ | |
279 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon) | |
280 | ||
281 | #else /* VTYSH_EXTRACT_PL */ | |
282 | #define DEFPY(funcname, cmdname, cmdstr, helpstr) \ | |
283 | DEFUN(funcname, cmdname, cmdstr, helpstr) | |
284 | #endif /* VTYSH_EXTRACT_PL */ | |
285 | ||
286 | /* Some macroes */ | |
287 | ||
288 | /* | |
289 | * Sometimes #defines create maximum values that | |
290 | * need to have strings created from them that | |
291 | * allow the parser to match against them. | |
292 | * These macros allow that. | |
293 | */ | |
294 | #define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s) | |
295 | #define CMD_CREATE_STR_HELPER(s) #s | |
296 | #define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")" | |
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 REDIST_STR "Redistribute information from another routing protocol\n" | |
304 | #define CLEAR_STR "Reset functions\n" | |
305 | #define RIP_STR "RIP information\n" | |
306 | #define EIGRP_STR "EIGRP information\n" | |
307 | #define BGP_STR "BGP information\n" | |
308 | #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n" | |
309 | #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n" | |
310 | #define BGP_SOFT_OUT_STR "Resend all outbound updates\n" | |
311 | #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n" | |
312 | #define OSPF_STR "OSPF information\n" | |
313 | #define NEIGHBOR_STR "Specify neighbor router\n" | |
314 | #define DEBUG_STR "Debugging functions (see also 'undebug')\n" | |
315 | #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n" | |
316 | #define ROUTER_STR "Enable a routing process\n" | |
317 | #define AS_STR "AS number\n" | |
318 | #define MBGP_STR "MBGP information\n" | |
319 | #define MATCH_STR "Match values from routing table\n" | |
320 | #define SET_STR "Set values in destination routing protocol\n" | |
321 | #define OUT_STR "Filter outgoing routing updates\n" | |
322 | #define IN_STR "Filter incoming routing updates\n" | |
323 | #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n" | |
324 | #define OSPF6_NUMBER_STR "Specify by number\n" | |
325 | #define INTERFACE_STR "Interface infomation\n" | |
326 | #define IFNAME_STR "Interface name(e.g. ep0)\n" | |
327 | #define IP6_STR "IPv6 Information\n" | |
328 | #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n" | |
329 | #define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n" | |
330 | #define SECONDS_STR "Seconds\n" | |
331 | #define ROUTE_STR "Routing Table\n" | |
332 | #define PREFIX_LIST_STR "Build a prefix list\n" | |
333 | #define OSPF6_DUMP_TYPE_LIST \ | |
334 | "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>" | |
335 | #define ISIS_STR "IS-IS information\n" | |
336 | #define AREA_TAG_STR "[area tag]\n" | |
337 | #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n" | |
338 | #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" | |
339 | #define MPLS_TE_STR "MPLS-TE specific commands\n" | |
340 | #define LINK_PARAMS_STR "Configure interface link parameters\n" | |
341 | #define OSPF_RI_STR "OSPF Router Information specific commands\n" | |
342 | #define PCE_STR "PCE Router Information specific commands\n" | |
343 | #define MPLS_STR "MPLS information\n" | |
344 | ||
345 | #define CONF_BACKUP_EXT ".sav" | |
346 | ||
347 | /* IPv4 only machine should not accept IPv6 address for peer's IP | |
348 | address. So we replace VTY command string like below. */ | |
349 | #define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n" | |
350 | #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n" | |
351 | #define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n" | |
352 | ||
353 | /* Prototypes. */ | |
354 | extern void install_node (struct cmd_node *, int (*) (struct vty *)); | |
355 | extern void install_default (enum node_type); | |
356 | extern void install_element (enum node_type, struct cmd_element *); | |
357 | ||
358 | /* known issue with uninstall_element: changes to cmd_token->attr (i.e. | |
359 | * deprecated/hidden) are not reversed. */ | |
360 | extern void uninstall_element (enum node_type, struct cmd_element *); | |
361 | ||
362 | /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated | |
363 | string with a space between each element (allocated using | |
364 | XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */ | |
365 | extern char *argv_concat (struct cmd_token **argv, int argc, int shift); | |
366 | extern int argv_find (struct cmd_token **argv, int argc, const char *text, int *index); | |
367 | ||
368 | extern vector cmd_make_strvec (const char *); | |
369 | extern void cmd_free_strvec (vector); | |
370 | extern vector cmd_describe_command (vector, struct vty *, int *status); | |
371 | extern char **cmd_complete_command (vector, struct vty *, int *status); | |
372 | extern const char *cmd_prompt (enum node_type); | |
373 | extern int command_config_read_one_line (struct vty *vty, const struct cmd_element **, int use_config_node); | |
374 | extern int config_from_file (struct vty *, FILE *, unsigned int *line_num); | |
375 | extern enum node_type node_parent (enum node_type); | |
376 | extern int cmd_execute_command (vector, struct vty *, const struct cmd_element **, int); | |
377 | extern int cmd_execute_command_strict (vector, struct vty *, const struct cmd_element **); | |
378 | extern void cmd_init (int); | |
379 | extern void cmd_terminate (void); | |
380 | extern void cmd_exit (struct vty *vty); | |
381 | extern int cmd_list_cmds (struct vty *vty, int do_permute); | |
382 | ||
383 | extern int cmd_hostname_set (const char *hostname); | |
384 | ||
385 | /* NOT safe for general use; call this only if DEV_BUILD! */ | |
386 | extern void grammar_sandbox_init (void); | |
387 | ||
388 | extern vector completions_to_vec (struct list *completions); | |
389 | ||
390 | /* Export typical functions. */ | |
391 | extern const char *host_config_get (void); | |
392 | extern void host_config_set (const char *); | |
393 | ||
394 | extern void print_version (const char *); | |
395 | ||
396 | extern int cmd_banner_motd_file (const char *); | |
397 | ||
398 | /* struct host global, ick */ | |
399 | extern struct host host; | |
400 | ||
401 | struct cmd_variable_handler { | |
402 | const char *tokenname, *varname; | |
403 | void (*completions)(vector out, struct cmd_token *token); | |
404 | }; | |
405 | ||
406 | extern void cmd_variable_complete (struct cmd_token *token, const char *arg, vector comps); | |
407 | extern void cmd_variable_handler_register (const struct cmd_variable_handler *cvh); | |
408 | ||
409 | #endif /* _ZEBRA_COMMAND_H */ |