]>
git.proxmox.com Git - mirror_frr.git/blob - lib/command.h
2 * Zebra configuration command interface routine
3 * Copyright (C) 1997, 98 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
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.
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.
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
22 #ifndef _ZEBRA_COMMAND_H
23 #define _ZEBRA_COMMAND_H
27 #include "lib/route_types.h"
31 #include "command_graph.h"
34 DECLARE_MTYPE ( COMPLETION
)
36 /* for test-commands.c */
39 /* Host configuration variable */
41 /* Host name of this router. */
44 /* Password for vty interface. */
46 char * password_encrypt
;
52 /* System wide terminal lines. */
58 /* config file name of this host */
62 /* Flags for services */
66 /* Banner configuration. */
71 /* List of CLI nodes. Please remember to update the name array in command.c. */
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 SERVICE_NODE
, /* Service node. */
79 DEBUG_NODE
, /* Debug node. */
80 VRF_DEBUG_NODE
, /* Vrf Debug node. */
81 DEBUG_VNC_NODE
, /* Debug VNC node. */
82 AAA_NODE
, /* AAA node. */
83 KEYCHAIN_NODE
, /* Key-chain node. */
84 KEYCHAIN_KEY_NODE
, /* Key-chain key node. */
85 NS_NODE
, /* Logical-Router node. */
86 VRF_NODE
, /* VRF mode node. */
87 INTERFACE_NODE
, /* Interface mode node. */
88 ZEBRA_NODE
, /* zebra connection node. */
89 TABLE_NODE
, /* rtm_table selection node. */
90 RIP_NODE
, /* RIP protocol mode node. */
91 RIPNG_NODE
, /* RIPng protocol mode node. */
92 BABEL_NODE
, /* BABEL protocol mode node. */
93 EIGRP_NODE
, /* EIGRP protocol mode node. */
94 BGP_NODE
, /* BGP protocol mode which includes BGP4+ */
95 BGP_VPNV4_NODE
, /* BGP MPLS-VPN PE exchange. */
96 BGP_VPNV6_NODE
, /* BGP MPLS-VPN PE exchange. */
97 BGP_IPV4_NODE
, /* BGP IPv4 unicast address family. */
98 BGP_IPV4M_NODE
, /* BGP IPv4 multicast address family. */
99 BGP_IPV4L_NODE
, /* BGP IPv4 labeled unicast address family. */
100 BGP_IPV6_NODE
, /* BGP IPv6 address family */
101 BGP_IPV6M_NODE
, /* BGP IPv6 multicast address family. */
102 BGP_IPV6L_NODE
, /* BGP IPv6 labeled unicast address family. */
103 BGP_VRF_POLICY_NODE
, /* BGP VRF policy */
104 BGP_VNC_DEFAULTS_NODE
, /* BGP VNC nve defaults */
105 BGP_VNC_NVE_GROUP_NODE
, /* BGP VNC nve group */
106 BGP_VNC_L2_GROUP_NODE
, /* BGP VNC L2 group */
107 RFP_DEFAULTS_NODE
, /* RFP defaults node */
108 BGP_EVPN_NODE
, /* BGP EVPN node. */
109 OSPF_NODE
, /* OSPF protocol mode */
110 OSPF6_NODE
, /* OSPF protocol for IPv6 mode */
111 LDP_NODE
, /* LDP protocol mode */
112 LDP_IPV4_NODE
, /* LDP IPv4 address family */
113 LDP_IPV6_NODE
, /* LDP IPv6 address family */
114 LDP_IPV4_IFACE_NODE
, /* LDP IPv4 Interface */
115 LDP_IPV6_IFACE_NODE
, /* LDP IPv6 Interface */
116 LDP_L2VPN_NODE
, /* LDP L2VPN node */
117 LDP_PSEUDOWIRE_NODE
, /* LDP Pseudowire node */
118 ISIS_NODE
, /* ISIS protocol mode */
119 PIM_NODE
, /* PIM protocol mode */
120 MASC_NODE
, /* MASC for multicast. */
121 IRDP_NODE
, /* ICMP Router Discovery Protocol mode. */
122 IP_NODE
, /* Static ip route node. */
123 ACCESS_NODE
, /* Access list node. */
124 PREFIX_NODE
, /* Prefix list node. */
125 ACCESS_IPV6_NODE
, /* Access list node. */
126 PREFIX_IPV6_NODE
, /* Prefix list node. */
127 AS_LIST_NODE
, /* AS list node. */
128 COMMUNITY_LIST_NODE
, /* Community list node. */
129 RMAP_NODE
, /* Route map node. */
130 SMUX_NODE
, /* SNMP configuration node. */
131 DUMP_NODE
, /* Packet dump node. */
132 FORWARDING_NODE
, /* IP forwarding node. */
133 PROTOCOL_NODE
, /* protocol filtering node */
134 MPLS_NODE
, /* MPLS config node */
135 PW_NODE
, /* Pseudowire config node */
136 VTY_NODE
, /* Vty node. */
137 LINK_PARAMS_NODE
, /* Link-parameters node */
138 BGP_EVPN_VNI_NODE
, /* BGP EVPN VNI */
139 NODE_TYPE_MAX
, /* maximum */
142 extern vector cmdvec
;
143 extern const char * node_names
[];
145 /* Node which has some commands and prompt string and configuration
146 function pointer . */
151 /* Prompt character at vty interface. */
154 /* Is this node's configuration goes to vtysh ? */
157 /* Node's configuration write function */
158 int (* func
)( struct vty
*);
160 /* Node's command graph */
161 struct graph
* cmdgraph
;
163 /* Vector of this node's command list. */
166 /* Hashed index of command node list, for de-dupping primarily */
167 struct hash
* cmd_hash
;
170 /* Return value of the commands. */
171 #define CMD_SUCCESS 0
172 #define CMD_WARNING 1
173 #define CMD_ERR_NO_MATCH 2
174 #define CMD_ERR_AMBIGUOUS 3
175 #define CMD_ERR_INCOMPLETE 4
176 #define CMD_ERR_EXEED_ARGC_MAX 5
177 #define CMD_ERR_NOTHING_TODO 6
178 #define CMD_COMPLETE_FULL_MATCH 7
179 #define CMD_COMPLETE_MATCH 8
180 #define CMD_COMPLETE_LIST_MATCH 9
181 #define CMD_SUCCESS_DAEMON 10
182 #define CMD_ERR_NO_FILE 11
183 #define CMD_SUSPEND 12
184 #define CMD_WARNING_CONFIG_FAILED 13
185 #define CMD_NOT_MY_INSTANCE 14
187 /* Argc max counts. */
188 #define CMD_ARGC_MAX 25
190 /* Turn off these macros when uisng cpp with extract.pl */
191 #ifndef VTYSH_EXTRACT_PL
193 /* helper defines for end-user DEFUN* macros */
194 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
195 static struct cmd_element cmdname = { \
204 #define DEFUN_CMD_FUNC_DECL(funcname) \
205 static int funcname(const struct cmd_element *, struct vty *, int, \
206 struct cmd_token *[]);
208 #define DEFUN_CMD_FUNC_TEXT(funcname) \
209 static int funcname(const struct cmd_element *self \
210 __attribute__((unused)), \
211 struct vty *vty __attribute__((unused)), \
212 int argc __attribute__((unused)), \
213 struct cmd_token *argv[] __attribute__((unused)))
215 #define DEFPY(funcname, cmdname, cmdstr, helpstr) \
216 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
219 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
220 DEFUN_CMD_FUNC_DECL(funcname) \
221 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
222 DEFUN_CMD_FUNC_TEXT(funcname)
224 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
225 DEFUN_CMD_FUNC_DECL(funcname) \
226 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
227 DEFUN_CMD_FUNC_TEXT(funcname)
229 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
230 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
232 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
233 DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
235 /* DEFUN_NOSH for commands that vtysh should ignore */
236 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
237 DEFUN(funcname, cmdname, cmdstr, helpstr)
239 /* DEFSH for vtysh. */
240 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
241 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
243 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
244 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
248 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
249 DEFUN_CMD_FUNC_DECL(funcname) \
250 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
251 DEFUN_CMD_FUNC_TEXT(funcname)
253 /* DEFUN + DEFSH with attributes */
254 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
255 DEFUN_CMD_FUNC_DECL(funcname) \
256 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
257 DEFUN_CMD_FUNC_TEXT(funcname)
259 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
260 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
263 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
264 DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
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)
271 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
272 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
274 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
275 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
278 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
279 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
280 CMD_ATTR_DEPRECATED, 0)
282 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
283 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
285 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
286 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
289 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
290 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
291 CMD_ATTR_DEPRECATED, daemon)
293 #else /* VTYSH_EXTRACT_PL */
294 #define DEFPY(funcname, cmdname, cmdstr, helpstr) \
295 DEFUN(funcname, cmdname, cmdstr, helpstr)
296 #endif /* VTYSH_EXTRACT_PL */
301 * Sometimes #defines create maximum values that
302 * need to have strings created from them that
303 * allow the parser to match against them.
304 * These macros allow that.
306 #define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
307 #define CMD_CREATE_STR_HELPER(s) #s
308 #define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
310 /* Common descriptions. */
311 #define SHOW_STR "Show running system information \n "
312 #define IP_STR "IP information \n "
313 #define IPV6_STR "IPv6 information \n "
314 #define NO_STR "Negate a command or set its defaults \n "
315 #define REDIST_STR "Redistribute information from another routing protocol \n "
316 #define CLEAR_STR "Reset functions \n "
317 #define RIP_STR "RIP information \n "
318 #define EIGRP_STR "EIGRP information \n "
319 #define BGP_STR "BGP information \n "
320 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates \n "
321 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound' \n "
322 #define BGP_SOFT_OUT_STR "Resend all outbound updates \n "
323 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB \n "
324 #define OSPF_STR "OSPF information \n "
325 #define NEIGHBOR_STR "Specify neighbor router \n "
326 #define DEBUG_STR "Debugging functions (see also 'undebug') \n "
327 #define UNDEBUG_STR "Disable debugging functions (see also 'debug') \n "
328 #define ROUTER_STR "Enable a routing process \n "
329 #define AS_STR "AS number \n "
330 #define MBGP_STR "MBGP information \n "
331 #define MATCH_STR "Match values from routing table \n "
332 #define SET_STR "Set values in destination routing protocol \n "
333 #define OUT_STR "Filter outgoing routing updates \n "
334 #define IN_STR "Filter incoming routing updates \n "
335 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0) \n "
336 #define OSPF6_NUMBER_STR "Specify by number \n "
337 #define INTERFACE_STR "Interface infomation \n "
338 #define IFNAME_STR "Interface name(e.g. ep0) \n "
339 #define IP6_STR "IPv6 Information \n "
340 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6 \n "
341 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID \n "
342 #define SECONDS_STR "Seconds \n "
343 #define ROUTE_STR "Routing Table \n "
344 #define PREFIX_LIST_STR "Build a prefix list \n "
345 #define OSPF6_DUMP_TYPE_LIST \
346 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
347 #define ISIS_STR "IS-IS information \n "
348 #define AREA_TAG_STR "[area tag] \n "
349 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535) \n "
350 #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 "
351 #define MPLS_TE_STR "MPLS-TE specific commands \n "
352 #define LINK_PARAMS_STR "Configure interface link parameters \n "
353 #define OSPF_RI_STR "OSPF Router Information specific commands \n "
354 #define PCE_STR "PCE Router Information specific commands \n "
355 #define MPLS_STR "MPLS information \n "
357 #define CONF_BACKUP_EXT ".sav"
359 /* IPv4 only machine should not accept IPv6 address for peer's IP
360 address. So we replace VTY command string like below. */
361 #define NEIGHBOR_ADDR_STR "Neighbor address \n IPv6 address \n "
362 #define NEIGHBOR_ADDR_STR2 "Neighbor address \n Neighbor IPv6 address \n Interface name or neighbor tag \n "
363 #define NEIGHBOR_ADDR_STR3 "Neighbor address \n IPv6 address \n Interface name \n "
366 extern void install_node ( struct cmd_node
*, int (*)( struct vty
*));
367 extern void install_default ( enum node_type
);
368 extern void install_element ( enum node_type
, struct cmd_element
*);
370 /* known issue with uninstall_element: changes to cmd_token->attr (i.e.
371 * deprecated/hidden) are not reversed. */
372 extern void uninstall_element ( enum node_type
, struct cmd_element
*);
374 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
375 string with a space between each element (allocated using
376 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
377 extern char * argv_concat ( struct cmd_token
** argv
, int argc
, int shift
);
378 extern int argv_find ( struct cmd_token
** argv
, int argc
, const char * text
,
381 extern vector
cmd_make_strvec ( const char *);
382 extern void cmd_free_strvec ( vector
);
383 extern vector
cmd_describe_command ( vector
, struct vty
*, int * status
);
384 extern char ** cmd_complete_command ( vector
, struct vty
*, int * status
);
385 extern const char * cmd_prompt ( enum node_type
);
386 extern int command_config_read_one_line ( struct vty
* vty
,
387 const struct cmd_element
**,
388 int use_config_node
);
389 extern int config_from_file ( struct vty
*, FILE *, unsigned int * line_num
);
390 extern enum node_type
node_parent ( enum node_type
);
391 extern int cmd_execute_command ( vector
, struct vty
*,
392 const struct cmd_element
**, int );
393 extern int cmd_execute_command_strict ( vector
, struct vty
*,
394 const struct cmd_element
**);
395 extern void cmd_init ( int );
396 extern void cmd_terminate ( void );
397 extern void cmd_exit ( struct vty
* vty
);
398 extern int cmd_list_cmds ( struct vty
* vty
, int do_permute
);
400 extern int cmd_hostname_set ( const char * hostname
);
402 /* NOT safe for general use; call this only if DEV_BUILD! */
403 extern void grammar_sandbox_init ( void );
405 extern vector
completions_to_vec ( struct list
* completions
);
407 /* Export typical functions. */
408 extern const char * host_config_get ( void );
409 extern void host_config_set ( const char *);
411 extern void print_version ( const char *);
413 extern int cmd_banner_motd_file ( const char *);
415 /* struct host global, ick */
416 extern struct host host
;
418 struct cmd_variable_handler
{
419 const char * tokenname
, * varname
;
420 void (* completions
)( vector out
, struct cmd_token
* token
);
423 extern void cmd_variable_complete ( struct cmd_token
* token
, const char * arg
,
426 cmd_variable_handler_register ( const struct cmd_variable_handler
* cvh
);
427 extern char * cmd_variable_comp2str ( vector comps
, unsigned short cols
);
429 #endif /* _ZEBRA_COMMAND_H */