[mirror_frr.git] / lib / command.h

/*
 * Zebra configuration command interface routine
 * Copyright (C) 1997, 98 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_COMMAND_H
#define _ZEBRA_COMMAND_H

#include "vector.h"
#include "vty.h"
#include "lib/route_types.h"
#include "graph.h"
#include "memory.h"
#include "hash.h"
#include "command_graph.h"

DECLARE_MTYPE(HOST)
DECLARE_MTYPE(COMPLETION)

/* for test-commands.c */
DECLARE_MTYPE(STRVEC)

/* Host configuration variable */
struct host {
	/* Host name of this router. */
	char *name;

	/* Domainname of this router */
	char *domainname;

	/* Password for vty interface. */
	char *password;
	char *password_encrypt;

	/* Enable password */
	char *enable;
	char *enable_encrypt;

	/* System wide terminal lines. */
	int lines;

	/* Log filename. */
	char *logfile;

	/* config file name of this host */
	char *config;
	int noconfig;

	/* Flags for services */
	int advanced;
	int encrypt;

	/* Banner configuration. */
	const char *motd;
	char *motdfile;
};

/* List of CLI nodes. Please remember to update the name array in command.c. */
enum node_type {
	AUTH_NODE,		 /* Authentication mode of vty interface. */
	VIEW_NODE,		 /* View node. Default mode of vty interface. */
	AUTH_ENABLE_NODE,	/* Authentication mode for change enable. */
	ENABLE_NODE,		 /* Enable node. */
	CONFIG_NODE,		 /* Config node. Default mode of config file. */
	DEBUG_NODE,		 /* Debug node. */
	VRF_DEBUG_NODE,		 /* Vrf Debug node. */
	DEBUG_VNC_NODE,		 /* Debug VNC node. */
	AAA_NODE,		 /* AAA node. */
	KEYCHAIN_NODE,		 /* Key-chain node. */
	KEYCHAIN_KEY_NODE,       /* Key-chain key node. */
	LOGICALROUTER_NODE,      /* Logical-Router node. */
	VRF_NODE,		 /* VRF mode node. */
	INTERFACE_NODE,		 /* Interface mode node. */
	NH_GROUP_NODE,		 /* Nexthop-Group mode node. */
	ZEBRA_NODE,		 /* zebra connection node. */
	TABLE_NODE,		 /* rtm_table selection node. */
	RIP_NODE,		 /* RIP protocol mode node. */
	RIPNG_NODE,		 /* RIPng protocol mode node. */
	BABEL_NODE,		 /* BABEL protocol mode node. */
	EIGRP_NODE,		 /* EIGRP protocol mode node. */
	BGP_NODE,		 /* BGP protocol mode which includes BGP4+ */
	BGP_VPNV4_NODE,		 /* BGP MPLS-VPN PE exchange. */
	BGP_VPNV6_NODE,		 /* BGP MPLS-VPN PE exchange. */
	BGP_IPV4_NODE,		 /* BGP IPv4 unicast address family.  */
	BGP_IPV4M_NODE,		 /* BGP IPv4 multicast address family.  */
	BGP_IPV4L_NODE,		 /* BGP IPv4 labeled unicast address family.  */
	BGP_IPV6_NODE,		 /* BGP IPv6 address family */
	BGP_IPV6M_NODE,		 /* BGP IPv6 multicast address family. */
	BGP_IPV6L_NODE,		 /* BGP IPv6 labeled unicast address family. */
	BGP_VRF_POLICY_NODE,     /* BGP VRF policy */
	BGP_VNC_DEFAULTS_NODE,   /* BGP VNC nve defaults */
	BGP_VNC_NVE_GROUP_NODE,  /* BGP VNC nve group */
	BGP_VNC_L2_GROUP_NODE,   /* BGP VNC L2 group */
	RFP_DEFAULTS_NODE,       /* RFP defaults node */
	BGP_EVPN_NODE,		 /* BGP EVPN node. */
	OSPF_NODE,		 /* OSPF protocol mode */
	OSPF6_NODE,		 /* OSPF protocol for IPv6 mode */
	LDP_NODE,		 /* LDP protocol mode */
	LDP_IPV4_NODE,		 /* LDP IPv4 address family */
	LDP_IPV6_NODE,		 /* LDP IPv6 address family */
	LDP_IPV4_IFACE_NODE,     /* LDP IPv4 Interface */
	LDP_IPV6_IFACE_NODE,     /* LDP IPv6 Interface */
	LDP_L2VPN_NODE,		 /* LDP L2VPN node */
	LDP_PSEUDOWIRE_NODE,     /* LDP Pseudowire node */
	ISIS_NODE,		 /* ISIS protocol mode */
	IP_NODE,		 /* Static ip route node. */
	ACCESS_NODE,		 /* Access list node. */
	PREFIX_NODE,		 /* Prefix list node. */
	ACCESS_IPV6_NODE,	/* Access list node. */
	ACCESS_MAC_NODE,	 /* MAC access list node*/
	PREFIX_IPV6_NODE,	/* Prefix list node. */
	AS_LIST_NODE,		 /* AS list node. */
	COMMUNITY_LIST_NODE,     /* Community list node. */
	RMAP_NODE,		 /* Route map node. */
	PBRMAP_NODE,		 /* PBR map node. */
	SMUX_NODE,		 /* SNMP configuration node. */
	DUMP_NODE,		 /* Packet dump node. */
	FORWARDING_NODE,	 /* IP forwarding node. */
	PROTOCOL_NODE,		 /* protocol filtering node */
	MPLS_NODE,		 /* MPLS config node */
	PW_NODE,		 /* Pseudowire config node */
	VTY_NODE,		 /* Vty node. */
	LINK_PARAMS_NODE,	/* Link-parameters node */
	BGP_EVPN_VNI_NODE,       /* BGP EVPN VNI */
	RPKI_NODE,     /* RPKI node for configuration of RPKI cache server
			  connections.*/
	BGP_FLOWSPECV4_NODE,	/* BGP IPv4 FLOWSPEC Address-Family */
	BGP_FLOWSPECV6_NODE,	/* BGP IPv6 FLOWSPEC Address-Family */
	NODE_TYPE_MAX, /* maximum */
};

extern vector cmdvec;
extern const struct message tokennames[];
extern const char *node_names[];

/* Node which has some commands and prompt string and configuration
   function pointer . */
struct cmd_node {
	/* Node index. */
	enum node_type node;

	/* Prompt character at vty interface. */
	const char *prompt;

	/* Is this node's configuration goes to vtysh ? */
	int vtysh;

	/* Node's configuration write function */
	int (*func)(struct vty *);

	/* Node's command graph */
	struct graph *cmdgraph;

	/* Vector of this node's command list. */
	vector cmd_vector;

	/* Hashed index of command node list, for de-dupping primarily */
	struct hash *cmd_hash;
};

/* Return value of the commands. */
#define CMD_SUCCESS              0
#define CMD_WARNING              1
#define CMD_ERR_NO_MATCH         2
#define CMD_ERR_AMBIGUOUS        3
#define CMD_ERR_INCOMPLETE       4
#define CMD_ERR_EXEED_ARGC_MAX   5
#define CMD_ERR_NOTHING_TODO     6
#define CMD_COMPLETE_FULL_MATCH  7
#define CMD_COMPLETE_MATCH       8
#define CMD_COMPLETE_LIST_MATCH  9
#define CMD_SUCCESS_DAEMON      10
#define CMD_ERR_NO_FILE         11
#define CMD_SUSPEND             12
#define CMD_WARNING_CONFIG_FAILED 13
#define CMD_NOT_MY_INSTANCE	14

/* Argc max counts. */
#define CMD_ARGC_MAX   256

/* Turn off these macros when uisng cpp with extract.pl */
#ifndef VTYSH_EXTRACT_PL

/* helper defines for end-user DEFUN* macros */
#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum)     \
	static struct cmd_element cmdname = {                                  \
		.string = cmdstr,                                              \
		.func = funcname,                                              \
		.doc = helpstr,                                                \
		.attr = attrs,                                                 \
		.daemon = dnum,                                                \
		.name = #cmdname,                                              \
	};

#define DEFUN_CMD_FUNC_DECL(funcname)                                          \
	static int funcname(const struct cmd_element *, struct vty *, int,     \
			    struct cmd_token *[]);

#define DEFUN_CMD_FUNC_TEXT(funcname)                                          \
	static int funcname(const struct cmd_element *self                     \
			    __attribute__((unused)),                           \
			    struct vty *vty __attribute__((unused)),           \
			    int argc __attribute__((unused)),                  \
			    struct cmd_token *argv[] __attribute__((unused)))

#define DEFPY(funcname, cmdname, cmdstr, helpstr)                              \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)            \
	funcdecl_##funcname

#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)         \
	funcdecl_##funcname

#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
	DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)

#define DEFUN(funcname, cmdname, cmdstr, helpstr)                              \
	DEFUN_CMD_FUNC_DECL(funcname)                                          \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)            \
	DEFUN_CMD_FUNC_TEXT(funcname)

#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
	DEFUN_CMD_FUNC_DECL(funcname)                                          \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)         \
	DEFUN_CMD_FUNC_TEXT(funcname)

#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
	DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)

#define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr)                   \
	DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)

/* DEFUN_NOSH for commands that vtysh should ignore */
#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr)                         \
	DEFUN(funcname, cmdname, cmdstr, helpstr)

/* DEFSH for vtysh. */
#define DEFSH(daemon, cmdname, cmdstr, helpstr)                                \
	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)

#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr)                         \
	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN,     \
			  daemon)

/* DEFUN + DEFSH */
#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr)                    \
	DEFUN_CMD_FUNC_DECL(funcname)                                          \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)       \
	DEFUN_CMD_FUNC_TEXT(funcname)

/* DEFUN + DEFSH with attributes */
#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr)         \
	DEFUN_CMD_FUNC_DECL(funcname)                                          \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon)    \
	DEFUN_CMD_FUNC_TEXT(funcname)

#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr)             \
	DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr,               \
		     CMD_ATTR_HIDDEN)

#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr)         \
	DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr,               \
		     CMD_ATTR_DEPRECATED)

/* ALIAS macro which define existing command's alias. */
#define ALIAS(funcname, cmdname, cmdstr, helpstr)                              \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)

#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)

#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
			  0)

#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr)                   \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr,                  \
			  CMD_ATTR_DEPRECATED, 0)

#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr)                   \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)

#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr)            \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
			  daemon)

#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr)        \
	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr,                  \
			  CMD_ATTR_DEPRECATED, daemon)

#else /* VTYSH_EXTRACT_PL */
#define DEFPY(funcname, cmdname, cmdstr, helpstr)                              \
	DEFUN(funcname, cmdname, cmdstr, helpstr)

#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
	DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)
#endif /* VTYSH_EXTRACT_PL */

/* Some macroes */

/*
 * Sometimes #defines create maximum values that
 * need to have strings created from them that
 * allow the parser to match against them.
 * These macros allow that.
 */
#define CMD_CREATE_STR(s)  CMD_CREATE_STR_HELPER(s)
#define CMD_CREATE_STR_HELPER(s) #s
#define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"

/* Common descriptions. */
#define SHOW_STR "Show running system information\n"
#define IP_STR "IP information\n"
#define IPV6_STR "IPv6 information\n"
#define NO_STR "Negate a command or set its defaults\n"
#define REDIST_STR "Redistribute information from another routing protocol\n"
#define CLEAR_STR "Reset functions\n"
#define RIP_STR "RIP information\n"
#define EIGRP_STR "EIGRP information\n"
#define BGP_STR "BGP information\n"
#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
#define OSPF_STR "OSPF information\n"
#define NEIGHBOR_STR "Specify neighbor router\n"
#define DEBUG_STR "Debugging functions\n"
#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
#define ROUTER_STR "Enable a routing process\n"
#define AS_STR "AS number\n"
#define MBGP_STR "MBGP information\n"
#define MATCH_STR "Match values from routing table\n"
#define SET_STR "Set values in destination routing protocol\n"
#define OUT_STR "Filter outgoing routing updates\n"
#define IN_STR  "Filter incoming routing updates\n"
#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
#define OSPF6_NUMBER_STR "Specify by number\n"
#define INTERFACE_STR "Interface infomation\n"
#define IFNAME_STR "Interface name(e.g. ep0)\n"
#define IP6_STR "IPv6 Information\n"
#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
#define SECONDS_STR "Seconds\n"
#define ROUTE_STR "Routing Table\n"
#define PREFIX_LIST_STR "Build a prefix list\n"
#define OSPF6_DUMP_TYPE_LIST                                                   \
	"<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
#define ISIS_STR "IS-IS information\n"
#define AREA_TAG_STR "[area tag]\n"
#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
#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"
#define MPLS_TE_STR "MPLS-TE specific commands\n"
#define LINK_PARAMS_STR "Configure interface link parameters\n"
#define OSPF_RI_STR "OSPF Router Information specific commands\n"
#define PCE_STR "PCE Router Information specific commands\n"
#define MPLS_STR "MPLS information\n"
#define SR_STR "Segment-Routing specific commands\n"
#define WATCHFRR_STR "watchfrr information\n"
#define ZEBRA_STR "Zebra information\n"

#define CONF_BACKUP_EXT ".sav"

/* IPv4 only machine should not accept IPv6 address for peer's IP
   address.  So we replace VTY command string like below. */
#define NEIGHBOR_ADDR_STR  "Neighbor address\nIPv6 address\n"
#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"

/* Prototypes. */
extern void install_node(struct cmd_node *, int (*)(struct vty *));
extern void install_default(enum node_type);
extern void install_element(enum node_type, struct cmd_element *);

/* known issue with uninstall_element:  changes to cmd_token->attr (i.e.
 * deprecated/hidden) are not reversed. */
extern void uninstall_element(enum node_type, struct cmd_element *);

/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
   string with a space between each element (allocated using
   XMALLOC(MTYPE_TMP)).  Returns NULL if shift >= argc. */
extern char *argv_concat(struct cmd_token **argv, int argc, int shift);

/*
 * It is preferred that you set the index initial value
 * to a 0.  This way in the future if you modify the
 * cli then there is no need to modify the initial
 * value of the index
 */
extern int argv_find(struct cmd_token **argv, int argc, const char *text,
		     int *index);

extern vector cmd_make_strvec(const char *);
extern void cmd_free_strvec(vector);
extern vector cmd_describe_command(vector, struct vty *, int *status);
extern char **cmd_complete_command(vector, struct vty *, int *status);
extern const char *cmd_prompt(enum node_type);
extern int command_config_read_one_line(struct vty *vty,
					const struct cmd_element **,
					int use_config_node);
extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
extern enum node_type node_parent(enum node_type);
extern int cmd_execute_command(vector, struct vty *,
			       const struct cmd_element **, int);
extern int cmd_execute_command_strict(vector, struct vty *,
				      const struct cmd_element **);
extern void cmd_init(int);
extern void cmd_terminate(void);
extern void cmd_exit(struct vty *vty);
extern int cmd_list_cmds(struct vty *vty, int do_permute);

extern int cmd_domainname_set(const char *domainname);
extern int cmd_hostname_set(const char *hostname);
extern const char *cmd_hostname_get(void);
extern const char *cmd_domainname_get(void);

/* NOT safe for general use; call this only if DEV_BUILD! */
extern void grammar_sandbox_init(void);

extern vector completions_to_vec(struct list *completions);

/* Export typical functions. */
extern const char *host_config_get(void);
extern void host_config_set(const char *);

extern void print_version(const char *);

extern int cmd_banner_motd_file(const char *);

/* struct host global, ick */
extern struct host host;

struct cmd_variable_handler {
	const char *tokenname, *varname;
	void (*completions)(vector out, struct cmd_token *token);
};

extern void cmd_variable_complete(struct cmd_token *token, const char *arg,
				  vector comps);
extern void
cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
extern char *cmd_variable_comp2str(vector comps, unsigned short cols);

#endif /* _ZEBRA_COMMAND_H */
Commit	Line	Data
718e3744	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.
d0bfb22c	11	*
718e3744	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	*
896014f4 DL	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
718e3744	20	*/
	21
	22	#ifndef _ZEBRA_COMMAND_H
	23	#define _ZEBRA_COMMAND_H
	24
	25	#include "vector.h"
	26	#include "vty.h"
9c42a6eb	27	#include "lib/route_types.h"
d0bfb22c	28	#include "graph.h"
4a1ab8e4	29	#include "memory.h"
274f29b2	30	#include "hash.h"
5894e76d	31	#include "command_graph.h"
4a1ab8e4 DL	32
4a1ab8e4 DL	33	DECLARE_MTYPE(HOST)
70d44c5c	34	DECLARE_MTYPE(COMPLETION)
4a1ab8e4 DL	35
	36	/* for test-commands.c */
	37	DECLARE_MTYPE(STRVEC)
718e3744	38
718e3744	39	/* Host configuration variable */
d62a17ae	40	struct host {
	41	/* Host name of this router. */
	42	char *name;
718e3744	43
6f9d219a	44	/* Domainname of this router */
419cd5a0 MK	45	char *domainname;
419cd5a0 MK	46
d62a17ae	47	/* Password for vty interface. */
	48	char *password;
	49	char *password_encrypt;
718e3744	50
d62a17ae	51	/* Enable password */
	52	char *enable;
	53	char *enable_encrypt;
718e3744	54
d62a17ae	55	/* System wide terminal lines. */
d62a17ae	56	int lines;
718e3744	57
d62a17ae	58	/* Log filename. */
d62a17ae	59	char *logfile;
718e3744	60
d62a17ae	61	/* config file name of this host */
	62	char *config;
	63	int noconfig;
718e3744	64
d62a17ae	65	/* Flags for services */
	66	int advanced;
	67	int encrypt;
718e3744	68
d62a17ae	69	/* Banner configuration. */
	70	const char *motd;
	71	char *motdfile;
718e3744	72	};
718e3744	73
cf6c83e7	74	/* List of CLI nodes. Please remember to update the name array in command.c. */
d62a17ae	75	enum node_type {
9f36abf9 PZ	76	AUTH_NODE, /* Authentication mode of vty interface. */
	77	VIEW_NODE, /* View node. Default mode of vty interface. */
	78	AUTH_ENABLE_NODE, /* Authentication mode for change enable. */
	79	ENABLE_NODE, /* Enable node. */
	80	CONFIG_NODE, /* Config node. Default mode of config file. */
9f36abf9 PZ	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	LOGICALROUTER_NODE, /* Logical-Router node. */
	88	VRF_NODE, /* VRF mode node. */
	89	INTERFACE_NODE, /* Interface mode node. */
	90	NH_GROUP_NODE, /* Nexthop-Group mode node. */
	91	ZEBRA_NODE, /* zebra connection node. */
	92	TABLE_NODE, /* rtm_table selection node. */
	93	RIP_NODE, /* RIP protocol mode node. */
	94	RIPNG_NODE, /* RIPng protocol mode node. */
	95	BABEL_NODE, /* BABEL protocol mode node. */
	96	EIGRP_NODE, /* EIGRP protocol mode node. */
	97	BGP_NODE, /* BGP protocol mode which includes BGP4+ */
	98	BGP_VPNV4_NODE, /* BGP MPLS-VPN PE exchange. */
	99	BGP_VPNV6_NODE, /* BGP MPLS-VPN PE exchange. */
	100	BGP_IPV4_NODE, /* BGP IPv4 unicast address family. */
	101	BGP_IPV4M_NODE, /* BGP IPv4 multicast address family. */
	102	BGP_IPV4L_NODE, /* BGP IPv4 labeled unicast address family. */
	103	BGP_IPV6_NODE, /* BGP IPv6 address family */
	104	BGP_IPV6M_NODE, /* BGP IPv6 multicast address family. */
	105	BGP_IPV6L_NODE, /* BGP IPv6 labeled unicast address family. */
	106	BGP_VRF_POLICY_NODE, /* BGP VRF policy */
	107	BGP_VNC_DEFAULTS_NODE, /* BGP VNC nve defaults */
	108	BGP_VNC_NVE_GROUP_NODE, /* BGP VNC nve group */
	109	BGP_VNC_L2_GROUP_NODE, /* BGP VNC L2 group */
	110	RFP_DEFAULTS_NODE, /* RFP defaults node */
	111	BGP_EVPN_NODE, /* BGP EVPN node. */
9f36abf9 PZ	112	OSPF_NODE, /* OSPF protocol mode */
	113	OSPF6_NODE, /* OSPF protocol for IPv6 mode */
	114	LDP_NODE, /* LDP protocol mode */
	115	LDP_IPV4_NODE, /* LDP IPv4 address family */
	116	LDP_IPV6_NODE, /* LDP IPv6 address family */
	117	LDP_IPV4_IFACE_NODE, /* LDP IPv4 Interface */
	118	LDP_IPV6_IFACE_NODE, /* LDP IPv6 Interface */
	119	LDP_L2VPN_NODE, /* LDP L2VPN node */
	120	LDP_PSEUDOWIRE_NODE, /* LDP Pseudowire node */
	121	ISIS_NODE, /* ISIS protocol mode */
9f36abf9 PZ	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	ACCESS_MAC_NODE, /* MAC access list node*/
	127	PREFIX_IPV6_NODE, /* Prefix list node. */
	128	AS_LIST_NODE, /* AS list node. */
	129	COMMUNITY_LIST_NODE, /* Community list node. */
	130	RMAP_NODE, /* Route map node. */
e5c83d9b	131	PBRMAP_NODE, /* PBR map node. */
9f36abf9 PZ	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	PW_NODE, /* Pseudowire config node */
	138	VTY_NODE, /* Vty node. */
	139	LINK_PARAMS_NODE, /* Link-parameters node */
	140	BGP_EVPN_VNI_NODE, /* BGP EVPN VNI */
996c9314 LB	141	RPKI_NODE, /* RPKI node for configuration of RPKI cache server
996c9314 LB	142	connections.*/
7c40bf39	143	BGP_FLOWSPECV4_NODE, /* BGP IPv4 FLOWSPEC Address-Family */
7c40bf39	144	BGP_FLOWSPECV6_NODE, /* BGP IPv6 FLOWSPEC Address-Family */
996c9314	145	NODE_TYPE_MAX, /* maximum */
718e3744	146	};
718e3744	147
cf6c83e7	148	extern vector cmdvec;
26fbe472	149	extern const struct message tokennames[];
a83a5331 QY	150	extern const char *node_names[];
a83a5331 QY	151
718e3744	152	/* Node which has some commands and prompt string and configuration
718e3744	153	function pointer . */
d62a17ae	154	struct cmd_node {
	155	/* Node index. */
	156	enum node_type node;
718e3744	157
d62a17ae	158	/* Prompt character at vty interface. */
d62a17ae	159	const char *prompt;
718e3744	160
d62a17ae	161	/* Is this node's configuration goes to vtysh ? */
d62a17ae	162	int vtysh;
d0bfb22c	163
d62a17ae	164	/* Node's configuration write function */
d62a17ae	165	int (func)(struct vty );
718e3744	166
d62a17ae	167	/* Node's command graph */
d62a17ae	168	struct graph *cmdgraph;
d0bfb22c	169
d62a17ae	170	/* Vector of this node's command list. */
d62a17ae	171	vector cmd_vector;
274f29b2	172
d62a17ae	173	/* Hashed index of command node list, for de-dupping primarily */
d62a17ae	174	struct hash *cmd_hash;
718e3744	175	};
718e3744	176
718e3744	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
1db63918	189	#define CMD_ERR_NO_FILE 11
95c4aff2	190	#define CMD_SUSPEND 12
f1a05de9	191	#define CMD_WARNING_CONFIG_FAILED 13
a3d826f0	192	#define CMD_NOT_MY_INSTANCE 14
718e3744	193
718e3744	194	/* Argc max counts. */
09f6d019	195	#define CMD_ARGC_MAX 256
718e3744	196
718e3744	197	/* Turn off these macros when uisng cpp with extract.pl */
d0bfb22c	198	#ifndef VTYSH_EXTRACT_PL
718e3744	199
406d6716	200	/* helper defines for end-user DEFUN* macros */
d62a17ae	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
e31f4dbe QY	226	#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
	227	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
	228	funcdecl_##funcname
	229
	230	#define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
	231	DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
	232
d62a17ae	233	#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
	234	DEFUN_CMD_FUNC_DECL(funcname) \
	235	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
	236	DEFUN_CMD_FUNC_TEXT(funcname)
	237
	238	#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
	239	DEFUN_CMD_FUNC_DECL(funcname) \
	240	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
	241	DEFUN_CMD_FUNC_TEXT(funcname)
	242
	243	#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
	244	DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
	245
	246	#define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
	247	DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
718e3744	248
718e3744	249	/* DEFUN_NOSH for commands that vtysh should ignore */
d62a17ae	250	#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
d62a17ae	251	DEFUN(funcname, cmdname, cmdstr, helpstr)
718e3744	252
718e3744	253	/* DEFSH for vtysh. */
d62a17ae	254	#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
d62a17ae	255	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
718e3744	256
d62a17ae	257	#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
	258	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
	259	daemon)
abaaab4e	260
718e3744	261	/* DEFUN + DEFSH */
d62a17ae	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)
718e3744	266
274a4a44	267	/* DEFUN + DEFSH with attributes */
d62a17ae	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)
274a4a44	272
d62a17ae	273	#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
	274	DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
	275	CMD_ATTR_HIDDEN)
274a4a44	276
d62a17ae	277	#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
	278	DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, \
	279	CMD_ATTR_DEPRECATED)
274a4a44	280
718e3744	281	/* ALIAS macro which define existing command's alias. */
d62a17ae	282	#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
d62a17ae	283	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
406d6716	284
d62a17ae	285	#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
d62a17ae	286	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716	287
d62a17ae	288	#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
	289	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
	290	0)
406d6716	291
d62a17ae	292	#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
	293	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
	294	CMD_ATTR_DEPRECATED, 0)
718e3744	295
d62a17ae	296	#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
d62a17ae	297	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
274a4a44	298
d62a17ae	299	#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
	300	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
	301	daemon)
274a4a44	302
d62a17ae	303	#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
	304	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, \
	305	CMD_ATTR_DEPRECATED, daemon)
274a4a44	306
5578a14d	307	#else /* VTYSH_EXTRACT_PL */
d62a17ae	308	#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
d62a17ae	309	DEFUN(funcname, cmdname, cmdstr, helpstr)
e31f4dbe QY	310
	311	#define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
	312	DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)
718e3744	313	#endif /* VTYSH_EXTRACT_PL */
	314
	315	/* Some macroes */
ba6d273b DS	316
	317	/*
	318	* Sometimes #defines create maximum values that
	319	* need to have strings created from them that
	320	* allow the parser to match against them.
	321	* These macros allow that.
	322	*/
	323	#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
	324	#define CMD_CREATE_STR_HELPER(s) #s
6319fd63	325	#define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
ba6d273b	326
718e3744	327	/* Common descriptions. */
	328	#define SHOW_STR "Show running system information\n"
	329	#define IP_STR "IP information\n"
	330	#define IPV6_STR "IPv6 information\n"
	331	#define NO_STR "Negate a command or set its defaults\n"
9c42a6eb	332	#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744	333	#define CLEAR_STR "Reset functions\n"
718e3744	334	#define RIP_STR "RIP information\n"
7f57883e	335	#define EIGRP_STR "EIGRP information\n"
718e3744	336	#define BGP_STR "BGP information\n"
e0bce756 DS	337	#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
	338	#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
	339	#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
	340	#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744	341	#define OSPF_STR "OSPF information\n"
718e3744	342	#define NEIGHBOR_STR "Specify neighbor router\n"
ef7eec74	343	#define DEBUG_STR "Debugging functions\n"
718e3744	344	#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
	345	#define ROUTER_STR "Enable a routing process\n"
	346	#define AS_STR "AS number\n"
	347	#define MBGP_STR "MBGP information\n"
	348	#define MATCH_STR "Match values from routing table\n"
	349	#define SET_STR "Set values in destination routing protocol\n"
	350	#define OUT_STR "Filter outgoing routing updates\n"
	351	#define IN_STR "Filter incoming routing updates\n"
	352	#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
	353	#define OSPF6_NUMBER_STR "Specify by number\n"
	354	#define INTERFACE_STR "Interface infomation\n"
	355	#define IFNAME_STR "Interface name(e.g. ep0)\n"
	356	#define IP6_STR "IPv6 Information\n"
	357	#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
d0bfb22c	358	#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
98cfd06b	359	#define SECONDS_STR "Seconds\n"
718e3744	360	#define ROUTE_STR "Routing Table\n"
718e3744	361	#define PREFIX_LIST_STR "Build a prefix list\n"
d62a17ae	362	#define OSPF6_DUMP_TYPE_LIST \
d62a17ae	363	"<neighbor\|interface\|area\|lsa\|zebra\|config\|dbex\|spf\|route\|lsdb\|redistribute\|hook\|asbr\|prefix\|abr>"
9e867fe6	364	#define ISIS_STR "IS-IS information\n"
9e867fe6	365	#define AREA_TAG_STR "[area tag]\n"
d0bfb22c QY	366	#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
d0bfb22c QY	367	#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"
16f1b9ee OD	368	#define MPLS_TE_STR "MPLS-TE specific commands\n"
	369	#define LINK_PARAMS_STR "Configure interface link parameters\n"
	370	#define OSPF_RI_STR "OSPF Router Information specific commands\n"
	371	#define PCE_STR "PCE Router Information specific commands\n"
7758e3f3	372	#define MPLS_STR "MPLS information\n"
cf9b9f77	373	#define SR_STR "Segment-Routing specific commands\n"
dff13b6f	374	#define WATCHFRR_STR "watchfrr information\n"
41e7fb80	375	#define ZEBRA_STR "Zebra information\n"
718e3744	376
	377	#define CONF_BACKUP_EXT ".sav"
	378
	379	/* IPv4 only machine should not accept IPv6 address for peer's IP
	380	address. So we replace VTY command string like below. */
718e3744	381	#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
a80beece DS	382	#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
a80beece DS	383	#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744	384
718e3744	385	/* Prototypes. */
d62a17ae	386	extern void install_node(struct cmd_node , int ()(struct vty *));
	387	extern void install_default(enum node_type);
	388	extern void install_element(enum node_type, struct cmd_element *);
718e3744	389
de8f7a39 DL	390	/* known issue with uninstall_element: changes to cmd_token->attr (i.e.
de8f7a39 DL	391	* deprecated/hidden) are not reversed. */
d62a17ae	392	extern void uninstall_element(enum node_type, struct cmd_element *);
de8f7a39	393
f6834d4c	394	/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
	395	string with a space between each element (allocated using
	396	XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
d62a17ae	397	extern char argv_concat(struct cmd_token *argv, int argc, int shift);
b286ddb0 DS	398
	399	/*
	400	* It is preferred that you set the index initial value
	401	* to a 0. This way in the future if you modify the
	402	* cli then there is no need to modify the initial
	403	* value of the index
	404	*/
d62a17ae	405	extern int argv_find(struct cmd_token *argv, int argc, const char text,
	406	int *index);
	407
	408	extern vector cmd_make_strvec(const char *);
	409	extern void cmd_free_strvec(vector);
	410	extern vector cmd_describe_command(vector, struct vty , int status);
	411	extern char *cmd_complete_command(vector, struct vty , int *status);
	412	extern const char *cmd_prompt(enum node_type);
	413	extern int command_config_read_one_line(struct vty *vty,
	414	const struct cmd_element **,
	415	int use_config_node);
	416	extern int config_from_file(struct vty , FILE , unsigned int *line_num);
	417	extern enum node_type node_parent(enum node_type);
	418	extern int cmd_execute_command(vector, struct vty *,
	419	const struct cmd_element **, int);
	420	extern int cmd_execute_command_strict(vector, struct vty *,
	421	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);
	426
6b3ee3a0	427	extern int cmd_domainname_set(const char *domainname);
d62a17ae	428	extern int cmd_hostname_set(const char *hostname);
6b3ee3a0 MK	429	extern const char *cmd_hostname_get(void);
6b3ee3a0 MK	430	extern const char *cmd_domainname_get(void);
bff9c3e9	431
af2567b6	432	/* NOT safe for general use; call this only if DEV_BUILD! */
d62a17ae	433	extern void grammar_sandbox_init(void);
af2567b6	434
d62a17ae	435	extern vector completions_to_vec(struct list *completions);
2ab40270	436
718e3744	437	/* Export typical functions. */
d62a17ae	438	extern const char *host_config_get(void);
d62a17ae	439	extern void host_config_set(const char *);
6590f2c3	440
d62a17ae	441	extern void print_version(const char *);
86228fde	442
d62a17ae	443	extern int cmd_banner_motd_file(const char *);
7cfc61d3	444
86228fde	445	/* struct host global, ick */
d0bfb22c QY	446	extern struct host host;
d0bfb22c QY	447
70d44c5c	448	struct cmd_variable_handler {
d62a17ae	449	const char tokenname, varname;
d62a17ae	450	void (completions)(vector out, struct cmd_token token);
70d44c5c DL	451	};
70d44c5c DL	452
d62a17ae	453	extern void cmd_variable_complete(struct cmd_token token, const char arg,
	454	vector comps);
	455	extern void
	456	cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
	457	extern char *cmd_variable_comp2str(vector comps, unsigned short cols);
228da428	458
718e3744	459	#endif /* _ZEBRA_COMMAND_H */