]>
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
18 * along with GNU Zebra; see the file COPYING. If not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #ifndef _ZEBRA_COMMAND_H
24 #define _ZEBRA_COMMAND_H
28 #include "lib/route_types.h"
34 DECLARE_MTYPE ( CMD_ARG
)
36 /* for test-commands.c */
39 /* Host configuration variable */
42 /* Host name of this router. */
45 /* Password for vty interface. */
47 char * password_encrypt
;
53 /* System wide terminal lines. */
59 /* config file name of this host */
63 /* Flags for services */
67 /* Banner configuration. */
72 /* There are some command levels which called from command node. */
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 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_IPV6_NODE
, /* BGP IPv6 address family */
100 BGP_IPV6M_NODE
, /* BGP IPv6 multicast address family. */
101 BGP_ENCAP_NODE
, /* BGP ENCAP SAFI */
102 BGP_ENCAPV6_NODE
, /* BGP ENCAP SAFI */
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 OSPF_NODE
, /* OSPF protocol mode */
109 OSPF6_NODE
, /* OSPF protocol for IPv6 mode */
110 LDP_NODE
, /* LDP protocol mode */
111 LDP_IPV4_NODE
, /* LDP IPv4 address family */
112 LDP_IPV6_NODE
, /* LDP IPv6 address family */
113 LDP_IPV4_IFACE_NODE
, /* LDP IPv4 Interface */
114 LDP_IPV6_IFACE_NODE
, /* LDP IPv6 Interface */
115 LDP_L2VPN_NODE
, /* LDP L2VPN node */
116 LDP_PSEUDOWIRE_NODE
, /* LDP Pseudowire node */
117 ISIS_NODE
, /* ISIS protocol mode */
118 PIM_NODE
, /* PIM protocol mode */
119 MASC_NODE
, /* MASC for multicast. */
120 IRDP_NODE
, /* ICMP Router Discovery Protocol mode. */
121 IP_NODE
, /* Static ip route node. */
122 ACCESS_NODE
, /* Access list node. */
123 PREFIX_NODE
, /* Prefix list node. */
124 ACCESS_IPV6_NODE
, /* Access list node. */
125 PREFIX_IPV6_NODE
, /* Prefix list node. */
126 AS_LIST_NODE
, /* AS list node. */
127 COMMUNITY_LIST_NODE
, /* Community list node. */
128 RMAP_NODE
, /* Route 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 VTY_NODE
, /* Vty node. */
135 LINK_PARAMS_NODE
, /* Link-parameters node */
138 /* Node which has some commands and prompt string and configuration
139 function pointer . */
145 /* Prompt character at vty interface. */
148 /* Is this node's configuration goes to vtysh ? */
151 /* Node's configuration write function */
152 int (* func
) ( struct vty
*);
154 /* Node's command graph */
155 struct graph
* cmdgraph
;
157 /* Vector of this node's command list. */
160 /* Hashed index of command node list, for de-dupping primarily */
161 struct hash
* cmd_hash
;
167 * The type determines what kind of data the token can match (in the
168 * matching use case) or hold (in the argv use case).
173 VARIABLE_TKN
, // almost anything
174 RANGE_TKN
, // integer range
175 IPV4_TKN
, // IPV4 addresses
176 IPV4_PREFIX_TKN
, // IPV4 network prefixes
177 IPV6_TKN
, // IPV6 prefixes
178 IPV6_PREFIX_TKN
, // IPV6 network prefixes
181 FORK_TKN
, // marks subgraph beginning
182 JOIN_TKN
, // marks subgraph end
183 START_TKN
, // first token in line
184 END_TKN
, // last token in line
186 SPECIAL_TKN
= FORK_TKN
,
189 /* Command attributes */
197 /* Comamand token struct. */
200 enum cmd_token_type type
; // token type
201 u_char attr
; // token attributes
202 bool allowrepeat
; // matcher allowed to match token repetively?
204 char * text
; // token text
205 char * desc
; // token description
206 long long min
, max
; // for ranges
207 char * arg
; // user input that matches this token
209 struct graph_node
* forkjoin
; // paired FORK/JOIN for JOIN/FORK
212 /* Structure of command element. */
215 const char * string
; /* Command specification by string. */
216 const char * doc
; /* Documentation of this command. */
217 int daemon
; /* Daemon to which this command belong. */
218 u_char attr
; /* Command attributes */
220 /* handler function for command */
221 int (* func
) ( const struct cmd_element
*, struct vty
*, int , struct cmd_token
*[]);
224 /* Return value of the commands. */
225 #define CMD_SUCCESS 0
226 #define CMD_WARNING 1
227 #define CMD_ERR_NO_MATCH 2
228 #define CMD_ERR_AMBIGUOUS 3
229 #define CMD_ERR_INCOMPLETE 4
230 #define CMD_ERR_EXEED_ARGC_MAX 5
231 #define CMD_ERR_NOTHING_TODO 6
232 #define CMD_COMPLETE_FULL_MATCH 7
233 #define CMD_COMPLETE_MATCH 8
234 #define CMD_COMPLETE_LIST_MATCH 9
235 #define CMD_SUCCESS_DAEMON 10
236 #define CMD_ERR_NO_FILE 11
237 #define CMD_SUSPEND 12
239 /* Argc max counts. */
240 #define CMD_ARGC_MAX 25
242 /* Turn off these macros when uisng cpp with extract.pl */
243 #ifndef VTYSH_EXTRACT_PL
245 /* helper defines for end-user DEFUN* macros */
246 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
247 static struct cmd_element cmdname = \
256 #define DEFUN_CMD_FUNC_DECL(funcname) \
257 static int funcname (const struct cmd_element *, struct vty *, int, struct cmd_token *[]);
259 #define DEFUN_CMD_FUNC_TEXT(funcname) \
260 static int funcname \
261 (const struct cmd_element *self __attribute__ ((unused)), \
262 struct vty *vty __attribute__ ((unused)), \
263 int argc __attribute__ ((unused)), \
264 struct cmd_token *argv[] __attribute__ ((unused)) )
266 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
267 DEFUN_CMD_FUNC_DECL(funcname) \
268 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
269 DEFUN_CMD_FUNC_TEXT(funcname)
271 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
272 DEFUN_CMD_FUNC_DECL(funcname) \
273 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
274 DEFUN_CMD_FUNC_TEXT(funcname)
276 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
277 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
279 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
280 DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
282 /* DEFUN_NOSH for commands that vtysh should ignore */
283 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
284 DEFUN(funcname, cmdname, cmdstr, helpstr)
286 /* DEFSH for vtysh. */
287 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
288 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
290 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
291 DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) \
294 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
295 DEFUN_CMD_FUNC_DECL(funcname) \
296 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
297 DEFUN_CMD_FUNC_TEXT(funcname)
299 /* DEFUN + DEFSH with attributes */
300 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
301 DEFUN_CMD_FUNC_DECL(funcname) \
302 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
303 DEFUN_CMD_FUNC_TEXT(funcname)
305 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
306 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
308 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
309 DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
311 /* ALIAS macro which define existing command's alias. */
312 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
313 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
315 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
316 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
318 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
319 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
321 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
322 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
324 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
325 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
327 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
328 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
330 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
331 DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
333 #endif /* VTYSH_EXTRACT_PL */
338 * Sometimes #defines create maximum values that
339 * need to have strings created from them that
340 * allow the parser to match against them.
341 * These macros allow that.
343 #define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
344 #define CMD_CREATE_STR_HELPER(s) #s
346 /* Common descriptions. */
347 #define SHOW_STR "Show running system information \n "
348 #define IP_STR "IP information \n "
349 #define IPV6_STR "IPv6 information \n "
350 #define NO_STR "Negate a command or set its defaults \n "
351 #define REDIST_STR "Redistribute information from another routing protocol \n "
352 #define CLEAR_STR "Reset functions \n "
353 #define RIP_STR "RIP information \n "
354 #define BGP_STR "BGP information \n "
355 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates \n "
356 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound' \n "
357 #define BGP_SOFT_OUT_STR "Resend all outbound updates \n "
358 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB \n "
359 #define OSPF_STR "OSPF information \n "
360 #define NEIGHBOR_STR "Specify neighbor router \n "
361 #define DEBUG_STR "Debugging functions (see also 'undebug') \n "
362 #define UNDEBUG_STR "Disable debugging functions (see also 'debug') \n "
363 #define ROUTER_STR "Enable a routing process \n "
364 #define AS_STR "AS number \n "
365 #define MBGP_STR "MBGP information \n "
366 #define MATCH_STR "Match values from routing table \n "
367 #define SET_STR "Set values in destination routing protocol \n "
368 #define OUT_STR "Filter outgoing routing updates \n "
369 #define IN_STR "Filter incoming routing updates \n "
370 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0) \n "
371 #define OSPF6_NUMBER_STR "Specify by number \n "
372 #define INTERFACE_STR "Interface infomation \n "
373 #define IFNAME_STR "Interface name(e.g. ep0) \n "
374 #define IP6_STR "IPv6 Information \n "
375 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6 \n "
376 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID \n "
377 #define SECONDS_STR "Seconds \n "
378 #define ROUTE_STR "Routing Table \n "
379 #define PREFIX_LIST_STR "Build a prefix list \n "
380 #define OSPF6_DUMP_TYPE_LIST \
381 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
382 #define ISIS_STR "IS-IS information \n "
383 #define AREA_TAG_STR "[area tag] \n "
384 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535) \n "
385 #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 "
386 #define MPLS_TE_STR "MPLS-TE specific commands \n "
387 #define LINK_PARAMS_STR "Configure interface link parameters \n "
388 #define OSPF_RI_STR "OSPF Router Information specific commands \n "
389 #define PCE_STR "PCE Router Information specific commands \n "
390 #define MPLS_STR "MPLS information \n "
392 #define CONF_BACKUP_EXT ".sav"
394 /* IPv4 only machine should not accept IPv6 address for peer's IP
395 address. So we replace VTY command string like below. */
396 #define NEIGHBOR_ADDR_STR "Neighbor address \n IPv6 address \n "
397 #define NEIGHBOR_ADDR_STR2 "Neighbor address \n Neighbor IPv6 address \n Interface name or neighbor tag \n "
398 #define NEIGHBOR_ADDR_STR3 "Neighbor address \n IPv6 address \n Interface name \n "
401 extern void install_node ( struct cmd_node
*, int (*) ( struct vty
*));
402 extern void install_default ( enum node_type
);
403 extern void install_element ( enum node_type
, struct cmd_element
*);
405 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
406 string with a space between each element (allocated using
407 XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
408 extern char * argv_concat ( struct cmd_token
** argv
, int argc
, int shift
);
409 extern int argv_find ( struct cmd_token
** argv
, int argc
, const char * text
, int * index
);
411 extern vector
cmd_make_strvec ( const char *);
412 extern void cmd_free_strvec ( vector
);
413 extern char * cmd_concat_strvec ( vector
);
414 extern vector
cmd_describe_command ( vector
, struct vty
*, int * status
);
415 extern char ** cmd_complete_command ( vector
, struct vty
*, int * status
);
416 extern const char * cmd_prompt ( enum node_type
);
417 extern int command_config_read_one_line ( struct vty
* vty
, const struct cmd_element
**, int use_config_node
);
418 extern int config_from_file ( struct vty
*, FILE *, unsigned int * line_num
);
419 extern enum node_type
node_parent ( enum node_type
);
420 extern int cmd_execute_command ( vector
, struct vty
*, const struct cmd_element
**, int );
421 extern int cmd_execute_command_strict ( vector
, struct vty
*, const struct cmd_element
**);
422 extern void cmd_init ( int );
423 extern void cmd_terminate ( void );
424 extern void cmd_exit ( struct vty
* vty
);
425 extern int cmd_list_cmds ( struct vty
* vty
, int do_permute
);
427 extern int cmd_hostname_set ( const char * hostname
);
429 /* NOT safe for general use; call this only if DEV_BUILD! */
430 extern void grammar_sandbox_init ( void );
432 /* memory management for cmd_token */
433 extern struct cmd_token
* new_cmd_token ( enum cmd_token_type
, u_char attr
,
434 const char * text
, const char * desc
);
435 extern void del_cmd_token ( struct cmd_token
*);
436 extern struct cmd_token
* copy_cmd_token ( struct cmd_token
*);
438 extern vector
completions_to_vec ( struct list
* completions
);
439 extern void command_parse_format ( struct graph
* graph
, struct cmd_element
* cmd
);
441 /* Export typical functions. */
442 extern const char * host_config_get ( void );
443 extern void host_config_set ( const char *);
445 extern void print_version ( const char *);
447 extern int cmd_banner_motd_file ( const char *);
449 /* struct host global, ick */
450 extern struct host host
;
452 /* text for <cr> command */
453 #define CMD_CR_TEXT "<cr>"
455 #endif /* _ZEBRA_COMMAND_H */