[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;

  /* 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;
};

/* There are some command levels which called from command node. */
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. */
  SERVICE_NODE,                 /* Service node. */
  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. */
  NS_NODE,                      /* Logical-Router node. */
  VRF_NODE,                     /* VRF mode node. */
  INTERFACE_NODE,               /* Interface 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 */
  PIM_NODE,                     /* PIM protocol mode */
  MASC_NODE,                    /* MASC for multicast.  */
  IRDP_NODE,                    /* ICMP Router Discovery Protocol mode. */
  IP_NODE,                      /* Static ip route node. */
  ACCESS_NODE,                  /* Access list node. */
  PREFIX_NODE,                  /* Prefix list node. */
  ACCESS_IPV6_NODE,             /* 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. */
  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 */
  VTY_NODE,                     /* Vty node. */
  LINK_PARAMS_NODE,             /* Link-parameters node */
};

/* 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

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

/* 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 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)
#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 (see also 'undebug')\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 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);
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_hostname_set (const char *hostname);

/* 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, const char nl[]);

#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
	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
718e3744	59	/* config file name of this host */
718e3744	60	char *config;
87f44e2f	61	int noconfig;
718e3744	62
	63	/* Flags for services */
	64	int advanced;
	65	int encrypt;
	66
	67	/* Banner configuration. */
8c328f11	68	const char *motd;
3b0c5d9a	69	char *motdfile;
718e3744	70	};
	71
	72	/* There are some command levels which called from command node. */
d0bfb22c	73	enum node_type
718e3744	74	{
d0bfb22c	75	AUTH_NODE, /* Authentication mode of vty interface. */
d0bfb22c QY	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. */
19dc275e	82	VRF_DEBUG_NODE, /* Vrf Debug node. */
65efcfce	83	DEBUG_VNC_NODE, /* Debug VNC node. */
d0bfb22c QY	84	AAA_NODE, /* AAA node. */
	85	KEYCHAIN_NODE, /* Key-chain node. */
	86	KEYCHAIN_KEY_NODE, /* Key-chain key node. */
844ec28c	87	NS_NODE, /* Logical-Router node. */
d0bfb22c QY	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. */
ca10883e	94	BABEL_NODE, /* BABEL protocol mode node. */
7f57883e	95	EIGRP_NODE, /* EIGRP protocol mode node. */
d0bfb22c QY	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. */
f51bae9c	101	BGP_IPV4L_NODE, /* BGP IPv4 labeled unicast address family. */
d0bfb22c QY	102	BGP_IPV6_NODE, /* BGP IPv6 address family */
d0bfb22c QY	103	BGP_IPV6M_NODE, /* BGP IPv6 multicast address family. */
f51bae9c	104	BGP_IPV6L_NODE, /* BGP IPv6 labeled unicast address family. */
5ff06872	105	BGP_VRF_POLICY_NODE, /* BGP VRF policy */
65efcfce LB	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 */
9e6df0b7	110	BGP_EVPN_NODE, /* BGP EVPN node. */
d0bfb22c QY	111	OSPF_NODE, /* OSPF protocol mode */
d0bfb22c QY	112	OSPF6_NODE, /* OSPF protocol for IPv6 mode */
eac6e3f0 RW	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 */
d0bfb22c QY	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. */
7514fb77	135	PROTOCOL_NODE, /* protocol filtering node */
7758e3f3	136	MPLS_NODE, /* MPLS config node */
d0bfb22c	137	VTY_NODE, /* Vty node. */
844ec28c	138	LINK_PARAMS_NODE, /* Link-parameters node */
718e3744	139	};
	140
	141	/* Node which has some commands and prompt string and configuration
	142	function pointer . */
d0bfb22c	143	struct cmd_node
718e3744	144	{
718e3744	145	/* Node index. */
d0bfb22c	146	enum node_type node;
718e3744	147
718e3744	148	/* Prompt character at vty interface. */
d0bfb22c	149	const char *prompt;
718e3744	150
	151	/* Is this node's configuration goes to vtysh ? */
	152	int vtysh;
d0bfb22c	153
718e3744	154	/* Node's configuration write function */
	155	int (func) (struct vty );
	156
d0bfb22c QY	157	/* Node's command graph */
	158	struct graph *cmdgraph;
	159
718e3744	160	/* Vector of this node's command list. */
d0bfb22c	161	vector cmd_vector;
274f29b2 PJ	162
	163	/* Hashed index of command node list, for de-dupping primarily */
	164	struct hash *cmd_hash;
718e3744	165	};
718e3744	166
718e3744	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
1db63918	179	#define CMD_ERR_NO_FILE 11
95c4aff2	180	#define CMD_SUSPEND 12
f1a05de9	181	#define CMD_WARNING_CONFIG_FAILED 13
718e3744	182
	183	/* Argc max counts. */
	184	#define CMD_ARGC_MAX 25
	185
	186	/* Turn off these macros when uisng cpp with extract.pl */
d0bfb22c	187	#ifndef VTYSH_EXTRACT_PL
718e3744	188
406d6716	189	/* helper defines for end-user DEFUN* macros */
406d6716	190	#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
555a5bfe	191	static struct cmd_element cmdname = \
718e3744	192	{ \
9035efaa	193	.string = cmdstr, \
9035efaa	194	.func = funcname, \
406d6716	195	.doc = helpstr, \
	196	.attr = attrs, \
	197	.daemon = dnum, \
db85c8b3	198	.name = #cmdname, \
406d6716	199	};
	200
	201	#define DEFUN_CMD_FUNC_DECL(funcname) \
17aca20b	202	static int funcname (const struct cmd_element , struct vty , int, struct cmd_token *[]);
406d6716	203
406d6716	204	#define DEFUN_CMD_FUNC_TEXT(funcname) \
274a4a44	205	static int funcname \
17aca20b	206	(const struct cmd_element *self __attribute__ ((unused)), \
6cf0cf0c PJ	207	struct vty *vty __attribute__ ((unused)), \
6cf0cf0c PJ	208	int argc __attribute__ ((unused)), \
d0bfb22c	209	struct cmd_token *argv[] __attribute__ ((unused)) )
406d6716	210
5578a14d DL	211	#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
	212	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
	213	funcdecl_##funcname
	214
406d6716	215	#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
	216	DEFUN_CMD_FUNC_DECL(funcname) \
	217	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
	218	DEFUN_CMD_FUNC_TEXT(funcname)
	219
	220	#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
	221	DEFUN_CMD_FUNC_DECL(funcname) \
	222	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
	223	DEFUN_CMD_FUNC_TEXT(funcname)
	224
	225	#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
	226	DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
	227
	228	#define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
2557aed1	229	DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
718e3744	230
	231	/* DEFUN_NOSH for commands that vtysh should ignore */
	232	#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
	233	DEFUN(funcname, cmdname, cmdstr, helpstr)
	234
	235	/* DEFSH for vtysh. */
	236	#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
406d6716	237	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
718e3744	238
abaaab4e DW	239	#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
	240	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) \
	241
718e3744	242	/* DEFUN + DEFSH */
718e3744	243	#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
406d6716	244	DEFUN_CMD_FUNC_DECL(funcname) \
	245	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
	246	DEFUN_CMD_FUNC_TEXT(funcname)
718e3744	247
274a4a44	248	/* DEFUN + DEFSH with attributes */
	249	#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
	250	DEFUN_CMD_FUNC_DECL(funcname) \
	251	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
	252	DEFUN_CMD_FUNC_TEXT(funcname)
	253
	254	#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
	255	DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
	256
	257	#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
	258	DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
	259
718e3744	260	/* ALIAS macro which define existing command's alias. */
718e3744	261	#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
406d6716	262	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
	263
	264	#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
274a4a44	265	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716	266
	267	#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
	268	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
	269
	270	#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
	271	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
718e3744	272
274a4a44	273	#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
	274	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
	275
	276	#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
	277	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
	278
	279	#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
	280	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
	281
5578a14d DL	282	#else /* VTYSH_EXTRACT_PL */
	283	#define DEFPY(funcname, cmdname, cmdstr, helpstr) \
	284	DEFUN(funcname, cmdname, cmdstr, helpstr)
718e3744	285	#endif /* VTYSH_EXTRACT_PL */
	286
	287	/* Some macroes */
ba6d273b DS	288
	289	/*
	290	* Sometimes #defines create maximum values that
	291	* need to have strings created from them that
	292	* allow the parser to match against them.
	293	* These macros allow that.
	294	*/
	295	#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
	296	#define CMD_CREATE_STR_HELPER(s) #s
6319fd63	297	#define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
ba6d273b	298
718e3744	299	/* Common descriptions. */
	300	#define SHOW_STR "Show running system information\n"
	301	#define IP_STR "IP information\n"
	302	#define IPV6_STR "IPv6 information\n"
	303	#define NO_STR "Negate a command or set its defaults\n"
9c42a6eb	304	#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744	305	#define CLEAR_STR "Reset functions\n"
718e3744	306	#define RIP_STR "RIP information\n"
7f57883e	307	#define EIGRP_STR "EIGRP information\n"
718e3744	308	#define BGP_STR "BGP information\n"
e0bce756 DS	309	#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
	310	#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
	311	#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
	312	#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744	313	#define OSPF_STR "OSPF information\n"
	314	#define NEIGHBOR_STR "Specify neighbor router\n"
	315	#define DEBUG_STR "Debugging functions (see also 'undebug')\n"
	316	#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
	317	#define ROUTER_STR "Enable a routing process\n"
	318	#define AS_STR "AS number\n"
	319	#define MBGP_STR "MBGP information\n"
	320	#define MATCH_STR "Match values from routing table\n"
	321	#define SET_STR "Set values in destination routing protocol\n"
	322	#define OUT_STR "Filter outgoing routing updates\n"
	323	#define IN_STR "Filter incoming routing updates\n"
	324	#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
	325	#define OSPF6_NUMBER_STR "Specify by number\n"
	326	#define INTERFACE_STR "Interface infomation\n"
	327	#define IFNAME_STR "Interface name(e.g. ep0)\n"
	328	#define IP6_STR "IPv6 Information\n"
	329	#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
d0bfb22c	330	#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
98cfd06b	331	#define SECONDS_STR "Seconds\n"
718e3744	332	#define ROUTE_STR "Routing Table\n"
	333	#define PREFIX_LIST_STR "Build a prefix list\n"
	334	#define OSPF6_DUMP_TYPE_LIST \
d0bfb22c	335	"<neighbor\|interface\|area\|lsa\|zebra\|config\|dbex\|spf\|route\|lsdb\|redistribute\|hook\|asbr\|prefix\|abr>"
9e867fe6	336	#define ISIS_STR "IS-IS information\n"
9e867fe6	337	#define AREA_TAG_STR "[area tag]\n"
d0bfb22c QY	338	#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
d0bfb22c QY	339	#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	340	#define MPLS_TE_STR "MPLS-TE specific commands\n"
	341	#define LINK_PARAMS_STR "Configure interface link parameters\n"
	342	#define OSPF_RI_STR "OSPF Router Information specific commands\n"
	343	#define PCE_STR "PCE Router Information specific commands\n"
7758e3f3	344	#define MPLS_STR "MPLS information\n"
718e3744	345
	346	#define CONF_BACKUP_EXT ".sav"
	347
	348	/* IPv4 only machine should not accept IPv6 address for peer's IP
	349	address. So we replace VTY command string like below. */
718e3744	350	#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
a80beece DS	351	#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
a80beece DS	352	#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744	353
718e3744	354	/* Prototypes. */
8cc4198f	355	extern void install_node (struct cmd_node , int () (struct vty *));
	356	extern void install_default (enum node_type);
	357	extern void install_element (enum node_type, struct cmd_element *);
718e3744	358
de8f7a39 DL	359	/* known issue with uninstall_element: changes to cmd_token->attr (i.e.
	360	* deprecated/hidden) are not reversed. */
	361	extern void uninstall_element (enum node_type, struct cmd_element *);
	362
f6834d4c	363	/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
	364	string with a space between each element (allocated using
	365	XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
d0bfb22c	366	extern char argv_concat (struct cmd_token *argv, int argc, int shift);
ae19d7dd	367	extern int argv_find (struct cmd_token *argv, int argc, const char text, int *index);
8cc4198f	368
	369	extern vector cmd_make_strvec (const char *);
	370	extern void cmd_free_strvec (vector);
	371	extern vector cmd_describe_command (vector, struct vty , int status);
	372	extern char *cmd_complete_command (vector, struct vty , int *status);
	373	extern const char *cmd_prompt (enum node_type);
17aca20b	374	extern int command_config_read_one_line (struct vty vty, const struct cmd_element *, int use_config_node);
13fbc82d	375	extern int config_from_file (struct vty , FILE , unsigned int *line_num);
8cc4198f	376	extern enum node_type node_parent (enum node_type);
17aca20b QY	377	extern int cmd_execute_command (vector, struct vty , const struct cmd_element *, int);
17aca20b QY	378	extern int cmd_execute_command_strict (vector, struct vty , const struct cmd_element *);
8cc4198f	379	extern void cmd_init (int);
228da428	380	extern void cmd_terminate (void);
0b84f294 DL	381	extern void cmd_exit (struct vty *vty);
0b84f294 DL	382	extern int cmd_list_cmds (struct vty *vty, int do_permute);
718e3744	383
bff9c3e9 DL	384	extern int cmd_hostname_set (const char *hostname);
bff9c3e9 DL	385
af2567b6 DL	386	/* NOT safe for general use; call this only if DEV_BUILD! */
	387	extern void grammar_sandbox_init (void);
	388
af2567b6	389	extern vector completions_to_vec (struct list *completions);
2ab40270	390
718e3744	391	/* Export typical functions. */
57387fb2	392	extern const char *host_config_get (void);
c0e8c16f	393	extern void host_config_set (const char *);
6590f2c3	394
8cc4198f	395	extern void print_version (const char *);
86228fde	396
7cfc61d3 DS	397	extern int cmd_banner_motd_file (const char *);
7cfc61d3 DS	398
86228fde	399	/* struct host global, ick */
d0bfb22c QY	400	extern struct host host;
d0bfb22c QY	401
70d44c5c DL	402	struct cmd_variable_handler {
	403	const char tokenname, varname;
	404	void (completions)(vector out, struct cmd_token token);
	405	};
	406
	407	extern void cmd_variable_complete (struct cmd_token token, const char arg, vector comps);
	408	extern void cmd_variable_handler_register (const struct cmd_variable_handler *cvh);
1a0f614d	409	extern char *cmd_variable_comp2str (vector comps, unsigned short cols, const char nl[]);
228da428	410
718e3744	411	#endif /* _ZEBRA_COMMAND_H */