[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 GNU Zebra; see the file COPYING.  If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, 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"

DECLARE_MTYPE(HOST)

/* 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. */
  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_IPV6_NODE,                /* BGP IPv6 address family */
  BGP_IPV6M_NODE,               /* BGP IPv6 multicast address family. */
  BGP_ENCAP_NODE,               /* BGP ENCAP SAFI */
  BGP_ENCAPV6_NODE,             /* BGP ENCAP SAFI */
  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 */
  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;
};

/**
 * Types for tokens.
 *
 * The type determines what kind of data the token can match (in the
 * matching use case) or hold (in the argv use case).
 */
enum cmd_token_type
{
  WORD_TKN,         // words
  VARIABLE_TKN,     // almost anything
  RANGE_TKN,        // integer range
  IPV4_TKN,         // IPV4 addresses
  IPV4_PREFIX_TKN,  // IPV4 network prefixes
  IPV6_TKN,         // IPV6 prefixes
  IPV6_PREFIX_TKN,  // IPV6 network prefixes

  /* plumbing types */
  SELECTOR_TKN,     // marks beginning of selector
  OPTION_TKN,       // marks beginning of option
  NUL_TKN,          // dummy token
  START_TKN,        // first token in line
  END_TKN,          // last token in line
};

/* Command attributes */
enum
{
  CMD_ATTR_NORMAL,
  CMD_ATTR_DEPRECATED,
  CMD_ATTR_HIDDEN,
};

/* Comamand token struct. */
struct cmd_token
{
  enum cmd_token_type type;     // token type
  u_char attr;                  // token attributes
  bool allowrepeat;             // matcher allowed to match token repetively?

  char *text;                   // token text
  char *desc;                   // token description
  long long min, max;           // for ranges
  char *arg;                    // user input that matches this token
};

/* Structure of command element. */
struct cmd_element
{
  const char *string;           /* Command specification by string. */
  const char *doc;              /* Documentation of this command. */
  int daemon;                   /* Daemon to which this command belong. */
  u_char attr;                  /* Command attributes */

  /* handler function for command */
  int (*func) (const struct cmd_element *, struct vty *, int, struct cmd_token *[]);
};

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

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

#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 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)

#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

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

/* 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 char *cmd_concat_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);

/* memory management for cmd_token */
struct cmd_token *
new_cmd_token (enum cmd_token_type, u_char attr, char *, char *);
void
del_cmd_token (struct cmd_token *);
struct cmd_token *
copy_cmd_token (struct cmd_token *);

extern void command_parse_format (struct graph *graph, struct cmd_element *cmd);

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

/* text for <cr> command */
#define CMD_CR_TEXT "<cr>"

#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	*
	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.
	21	*/
	22
	23	#ifndef _ZEBRA_COMMAND_H
	24	#define _ZEBRA_COMMAND_H
	25
	26	#include "vector.h"
	27	#include "vty.h"
9c42a6eb	28	#include "lib/route_types.h"
d0bfb22c	29	#include "graph.h"
4a1ab8e4	30	#include "memory.h"
274f29b2	31	#include "hash.h"
4a1ab8e4 DL	32
	33	DECLARE_MTYPE(HOST)
	34
	35	/* for test-commands.c */
	36	DECLARE_MTYPE(STRVEC)
718e3744	37
	38	/* Host configuration variable */
	39	struct host
	40	{
	41	/* Host name of this router. */
	42	char *name;
	43
	44	/* Password for vty interface. */
	45	char *password;
	46	char *password_encrypt;
	47
	48	/* Enable password */
	49	char *enable;
	50	char *enable_encrypt;
	51
	52	/* System wide terminal lines. */
	53	int lines;
	54
	55	/* Log filename. */
	56	char *logfile;
	57
718e3744	58	/* config file name of this host */
718e3744	59	char *config;
87f44e2f	60	int noconfig;
718e3744	61
	62	/* Flags for services */
	63	int advanced;
	64	int encrypt;
	65
	66	/* Banner configuration. */
8c328f11	67	const char *motd;
3b0c5d9a	68	char *motdfile;
718e3744	69	};
	70
	71	/* There are some command levels which called from command node. */
d0bfb22c	72	enum node_type
718e3744	73	{
d0bfb22c	74	AUTH_NODE, /* Authentication mode of vty interface. */
d0bfb22c QY	75	VIEW_NODE, /* View node. Default mode of vty interface. */
	76	AUTH_ENABLE_NODE, /* Authentication mode for change enable. */
	77	ENABLE_NODE, /* Enable node. */
	78	CONFIG_NODE, /* Config node. Default mode of config file. */
	79	SERVICE_NODE, /* Service node. */
	80	DEBUG_NODE, /* Debug node. */
19dc275e	81	VRF_DEBUG_NODE, /* Vrf Debug node. */
65efcfce	82	DEBUG_VNC_NODE, /* Debug VNC node. */
d0bfb22c QY	83	AAA_NODE, /* AAA node. */
	84	KEYCHAIN_NODE, /* Key-chain node. */
	85	KEYCHAIN_KEY_NODE, /* Key-chain key node. */
844ec28c	86	NS_NODE, /* Logical-Router node. */
d0bfb22c QY	87	VRF_NODE, /* VRF mode node. */
	88	INTERFACE_NODE, /* Interface mode node. */
	89	ZEBRA_NODE, /* zebra connection node. */
	90	TABLE_NODE, /* rtm_table selection node. */
	91	RIP_NODE, /* RIP protocol mode node. */
	92	RIPNG_NODE, /* RIPng protocol mode node. */
	93	BGP_NODE, /* BGP protocol mode which includes BGP4+ */
	94	BGP_VPNV4_NODE, /* BGP MPLS-VPN PE exchange. */
	95	BGP_VPNV6_NODE, /* BGP MPLS-VPN PE exchange. */
	96	BGP_IPV4_NODE, /* BGP IPv4 unicast address family. */
	97	BGP_IPV4M_NODE, /* BGP IPv4 multicast address family. */
	98	BGP_IPV6_NODE, /* BGP IPv6 address family */
	99	BGP_IPV6M_NODE, /* BGP IPv6 multicast address family. */
	100	BGP_ENCAP_NODE, /* BGP ENCAP SAFI */
	101	BGP_ENCAPV6_NODE, /* BGP ENCAP SAFI */
65efcfce LB	102	BGP_VNC_DEFAULTS_NODE, /* BGP VNC nve defaults */
	103	BGP_VNC_NVE_GROUP_NODE, /* BGP VNC nve group */
	104	BGP_VNC_L2_GROUP_NODE, /* BGP VNC L2 group */
	105	RFP_DEFAULTS_NODE, /* RFP defaults node */
d0bfb22c QY	106	OSPF_NODE, /* OSPF protocol mode */
d0bfb22c QY	107	OSPF6_NODE, /* OSPF protocol for IPv6 mode */
eac6e3f0 RW	108	LDP_NODE, /* LDP protocol mode */
	109	LDP_IPV4_NODE, /* LDP IPv4 address family */
	110	LDP_IPV6_NODE, /* LDP IPv6 address family */
	111	LDP_IPV4_IFACE_NODE, /* LDP IPv4 Interface */
	112	LDP_IPV6_IFACE_NODE, /* LDP IPv6 Interface */
	113	LDP_L2VPN_NODE, /* LDP L2VPN node */
	114	LDP_PSEUDOWIRE_NODE, /* LDP Pseudowire node */
d0bfb22c QY	115	ISIS_NODE, /* ISIS protocol mode */
	116	PIM_NODE, /* PIM protocol mode */
	117	MASC_NODE, /* MASC for multicast. */
	118	IRDP_NODE, /* ICMP Router Discovery Protocol mode. */
	119	IP_NODE, /* Static ip route node. */
	120	ACCESS_NODE, /* Access list node. */
	121	PREFIX_NODE, /* Prefix list node. */
	122	ACCESS_IPV6_NODE, /* Access list node. */
	123	PREFIX_IPV6_NODE, /* Prefix list node. */
	124	AS_LIST_NODE, /* AS list node. */
	125	COMMUNITY_LIST_NODE, /* Community list node. */
	126	RMAP_NODE, /* Route map node. */
	127	SMUX_NODE, /* SNMP configuration node. */
	128	DUMP_NODE, /* Packet dump node. */
	129	FORWARDING_NODE, /* IP forwarding node. */
7514fb77	130	PROTOCOL_NODE, /* protocol filtering node */
7758e3f3	131	MPLS_NODE, /* MPLS config node */
d0bfb22c	132	VTY_NODE, /* Vty node. */
844ec28c	133	LINK_PARAMS_NODE, /* Link-parameters node */
718e3744	134	};
	135
	136	/* Node which has some commands and prompt string and configuration
	137	function pointer . */
d0bfb22c	138	struct cmd_node
718e3744	139	{
718e3744	140	/* Node index. */
d0bfb22c	141	enum node_type node;
718e3744	142
718e3744	143	/* Prompt character at vty interface. */
d0bfb22c	144	const char *prompt;
718e3744	145
	146	/* Is this node's configuration goes to vtysh ? */
	147	int vtysh;
d0bfb22c	148
718e3744	149	/* Node's configuration write function */
	150	int (func) (struct vty );
	151
d0bfb22c QY	152	/* Node's command graph */
	153	struct graph *cmdgraph;
	154
718e3744	155	/* Vector of this node's command list. */
d0bfb22c	156	vector cmd_vector;
274f29b2 PJ	157
	158	/* Hashed index of command node list, for de-dupping primarily */
	159	struct hash *cmd_hash;
718e3744	160	};
718e3744	161
d0bfb22c QY	162	/**
	163	* Types for tokens.
	164	*
	165	* The type determines what kind of data the token can match (in the
	166	* matching use case) or hold (in the argv use case).
	167	*/
	168	enum cmd_token_type
406d6716	169	{
d0bfb22c	170	WORD_TKN, // words
d0bfb22c QY	171	VARIABLE_TKN, // almost anything
	172	RANGE_TKN, // integer range
	173	IPV4_TKN, // IPV4 addresses
	174	IPV4_PREFIX_TKN, // IPV4 network prefixes
	175	IPV6_TKN, // IPV6 prefixes
	176	IPV6_PREFIX_TKN, // IPV6 network prefixes
	177
	178	/* plumbing types */
	179	SELECTOR_TKN, // marks beginning of selector
	180	OPTION_TKN, // marks beginning of option
	181	NUL_TKN, // dummy token
	182	START_TKN, // first token in line
	183	END_TKN, // last token in line
406d6716	184	};
406d6716	185
ce882f81 QY	186	/* Command attributes */
	187	enum
	188	{
	189	CMD_ATTR_NORMAL,
	190	CMD_ATTR_DEPRECATED,
	191	CMD_ATTR_HIDDEN,
	192	};
	193
	194	/* Comamand token struct. */
d0bfb22c	195	struct cmd_token
718e3744	196	{
ebacb4ed	197	enum cmd_token_type type; // token type
ce882f81	198	u_char attr; // token attributes
4d94b292 DL	199	bool allowrepeat; // matcher allowed to match token repetively?
4d94b292 DL	200
d0bfb22c QY	201	char *text; // token text
d0bfb22c QY	202	char *desc; // token description
d0bfb22c	203	long long min, max; // for ranges
d0bfb22c	204	char *arg; // user input that matches this token
cd40b329 CF	205	};
cd40b329 CF	206
d0bfb22c QY	207	/* Structure of command element. */
d0bfb22c QY	208	struct cmd_element
718e3744	209	{
d0bfb22c QY	210	const char string; / Command specification by string. */
	211	const char doc; / Documentation of this command. */
	212	int daemon; /* Daemon to which this command belong. */
	213	u_char attr; /* Command attributes */
cd40b329	214
d0bfb22c	215	/* handler function for command */
17aca20b	216	int (func) (const struct cmd_element , struct vty , int, struct cmd_token []);
718e3744	217	};
	218
	219	/* Return value of the commands. */
	220	#define CMD_SUCCESS 0
	221	#define CMD_WARNING 1
	222	#define CMD_ERR_NO_MATCH 2
	223	#define CMD_ERR_AMBIGUOUS 3
	224	#define CMD_ERR_INCOMPLETE 4
	225	#define CMD_ERR_EXEED_ARGC_MAX 5
	226	#define CMD_ERR_NOTHING_TODO 6
	227	#define CMD_COMPLETE_FULL_MATCH 7
	228	#define CMD_COMPLETE_MATCH 8
	229	#define CMD_COMPLETE_LIST_MATCH 9
	230	#define CMD_SUCCESS_DAEMON 10
1db63918	231	#define CMD_ERR_NO_FILE 11
95c4aff2	232	#define CMD_SUSPEND 12
718e3744	233
	234	/* Argc max counts. */
	235	#define CMD_ARGC_MAX 25
	236
	237	/* Turn off these macros when uisng cpp with extract.pl */
d0bfb22c	238	#ifndef VTYSH_EXTRACT_PL
718e3744	239
406d6716	240	/* helper defines for end-user DEFUN* macros */
406d6716	241	#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
555a5bfe	242	static struct cmd_element cmdname = \
718e3744	243	{ \
9035efaa	244	.string = cmdstr, \
9035efaa	245	.func = funcname, \
406d6716	246	.doc = helpstr, \
	247	.attr = attrs, \
	248	.daemon = dnum, \
	249	};
	250
	251	#define DEFUN_CMD_FUNC_DECL(funcname) \
17aca20b	252	static int funcname (const struct cmd_element , struct vty , int, struct cmd_token *[]);
406d6716	253
406d6716	254	#define DEFUN_CMD_FUNC_TEXT(funcname) \
274a4a44	255	static int funcname \
17aca20b	256	(const struct cmd_element *self __attribute__ ((unused)), \
6cf0cf0c PJ	257	struct vty *vty __attribute__ ((unused)), \
6cf0cf0c PJ	258	int argc __attribute__ ((unused)), \
d0bfb22c	259	struct cmd_token *argv[] __attribute__ ((unused)) )
406d6716	260
406d6716	261	#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
	262	DEFUN_CMD_FUNC_DECL(funcname) \
	263	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
	264	DEFUN_CMD_FUNC_TEXT(funcname)
	265
	266	#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
	267	DEFUN_CMD_FUNC_DECL(funcname) \
	268	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
	269	DEFUN_CMD_FUNC_TEXT(funcname)
	270
	271	#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
	272	DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
	273
	274	#define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
2557aed1	275	DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
718e3744	276
	277	/* DEFUN_NOSH for commands that vtysh should ignore */
	278	#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
	279	DEFUN(funcname, cmdname, cmdstr, helpstr)
	280
	281	/* DEFSH for vtysh. */
	282	#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
406d6716	283	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
718e3744	284
abaaab4e DW	285	#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
	286	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) \
	287
718e3744	288	/* DEFUN + DEFSH */
718e3744	289	#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
406d6716	290	DEFUN_CMD_FUNC_DECL(funcname) \
	291	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
	292	DEFUN_CMD_FUNC_TEXT(funcname)
718e3744	293
274a4a44	294	/* DEFUN + DEFSH with attributes */
	295	#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
	296	DEFUN_CMD_FUNC_DECL(funcname) \
	297	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
	298	DEFUN_CMD_FUNC_TEXT(funcname)
	299
	300	#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
	301	DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
	302
	303	#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
	304	DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
	305
718e3744	306	/* ALIAS macro which define existing command's alias. */
718e3744	307	#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
406d6716	308	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
	309
	310	#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
274a4a44	311	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716	312
	313	#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
	314	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
	315
	316	#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
	317	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
718e3744	318
274a4a44	319	#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
	320	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
	321
	322	#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
	323	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
	324
	325	#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
	326	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
	327
718e3744	328	#endif /* VTYSH_EXTRACT_PL */
	329
	330	/* Some macroes */
ba6d273b DS	331
	332	/*
	333	* Sometimes #defines create maximum values that
	334	* need to have strings created from them that
	335	* allow the parser to match against them.
	336	* These macros allow that.
	337	*/
	338	#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
	339	#define CMD_CREATE_STR_HELPER(s) #s
ba6d273b	340
718e3744	341	/* Common descriptions. */
	342	#define SHOW_STR "Show running system information\n"
	343	#define IP_STR "IP information\n"
	344	#define IPV6_STR "IPv6 information\n"
	345	#define NO_STR "Negate a command or set its defaults\n"
9c42a6eb	346	#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744	347	#define CLEAR_STR "Reset functions\n"
	348	#define RIP_STR "RIP information\n"
	349	#define BGP_STR "BGP information\n"
e0bce756 DS	350	#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
	351	#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
	352	#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
	353	#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744	354	#define OSPF_STR "OSPF information\n"
	355	#define NEIGHBOR_STR "Specify neighbor router\n"
	356	#define DEBUG_STR "Debugging functions (see also 'undebug')\n"
	357	#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
	358	#define ROUTER_STR "Enable a routing process\n"
	359	#define AS_STR "AS number\n"
	360	#define MBGP_STR "MBGP information\n"
	361	#define MATCH_STR "Match values from routing table\n"
	362	#define SET_STR "Set values in destination routing protocol\n"
	363	#define OUT_STR "Filter outgoing routing updates\n"
	364	#define IN_STR "Filter incoming routing updates\n"
	365	#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
	366	#define OSPF6_NUMBER_STR "Specify by number\n"
	367	#define INTERFACE_STR "Interface infomation\n"
	368	#define IFNAME_STR "Interface name(e.g. ep0)\n"
	369	#define IP6_STR "IPv6 Information\n"
	370	#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
d0bfb22c	371	#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
98cfd06b	372	#define SECONDS_STR "Seconds\n"
718e3744	373	#define ROUTE_STR "Routing Table\n"
	374	#define PREFIX_LIST_STR "Build a prefix list\n"
	375	#define OSPF6_DUMP_TYPE_LIST \
d0bfb22c	376	"<neighbor\|interface\|area\|lsa\|zebra\|config\|dbex\|spf\|route\|lsdb\|redistribute\|hook\|asbr\|prefix\|abr>"
9e867fe6	377	#define ISIS_STR "IS-IS information\n"
9e867fe6	378	#define AREA_TAG_STR "[area tag]\n"
d0bfb22c QY	379	#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
d0bfb22c QY	380	#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	381	#define MPLS_TE_STR "MPLS-TE specific commands\n"
	382	#define LINK_PARAMS_STR "Configure interface link parameters\n"
	383	#define OSPF_RI_STR "OSPF Router Information specific commands\n"
	384	#define PCE_STR "PCE Router Information specific commands\n"
7758e3f3	385	#define MPLS_STR "MPLS information\n"
718e3744	386
	387	#define CONF_BACKUP_EXT ".sav"
	388
	389	/* IPv4 only machine should not accept IPv6 address for peer's IP
	390	address. So we replace VTY command string like below. */
718e3744	391	#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
a80beece DS	392	#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
a80beece DS	393	#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744	394
718e3744	395	/* Prototypes. */
8cc4198f	396	extern void install_node (struct cmd_node , int () (struct vty *));
	397	extern void install_default (enum node_type);
	398	extern void install_element (enum node_type, struct cmd_element *);
718e3744	399
f6834d4c	400	/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
	401	string with a space between each element (allocated using
	402	XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
d0bfb22c	403	extern char argv_concat (struct cmd_token *argv, int argc, int shift);
ae19d7dd	404	extern int argv_find (struct cmd_token *argv, int argc, const char text, int *index);
8cc4198f	405
	406	extern vector cmd_make_strvec (const char *);
	407	extern void cmd_free_strvec (vector);
42debbb4	408	extern char *cmd_concat_strvec (vector);
8cc4198f	409	extern vector cmd_describe_command (vector, struct vty , int status);
	410	extern char *cmd_complete_command (vector, struct vty , int *status);
	411	extern const char *cmd_prompt (enum node_type);
17aca20b	412	extern int command_config_read_one_line (struct vty vty, const struct cmd_element *, int use_config_node);
13fbc82d	413	extern int config_from_file (struct vty , FILE , unsigned int *line_num);
8cc4198f	414	extern enum node_type node_parent (enum node_type);
17aca20b QY	415	extern int cmd_execute_command (vector, struct vty , const struct cmd_element *, int);
17aca20b QY	416	extern int cmd_execute_command_strict (vector, struct vty , const struct cmd_element *);
8cc4198f	417	extern void cmd_init (int);
228da428	418	extern void cmd_terminate (void);
0b84f294 DL	419	extern void cmd_exit (struct vty *vty);
0b84f294 DL	420	extern int cmd_list_cmds (struct vty *vty, int do_permute);
718e3744	421
d0bfb22c QY	422	/* memory management for cmd_token */
d0bfb22c QY	423	struct cmd_token *
ce882f81	424	new_cmd_token (enum cmd_token_type, u_char attr, char , char );
d0bfb22c QY	425	void
	426	del_cmd_token (struct cmd_token *);
	427	struct cmd_token *
	428	copy_cmd_token (struct cmd_token *);
	429
2ab40270 DL	430	extern void command_parse_format (struct graph graph, struct cmd_element cmd);
2ab40270 DL	431
718e3744	432	/* Export typical functions. */
57387fb2	433	extern const char *host_config_get (void);
c0e8c16f	434	extern void host_config_set (const char *);
6590f2c3	435
8cc4198f	436	extern void print_version (const char *);
86228fde	437
7cfc61d3 DS	438	extern int cmd_banner_motd_file (const char *);
7cfc61d3 DS	439
86228fde	440	/* struct host global, ick */
d0bfb22c QY	441	extern struct host host;
	442
	443	/* text for <cr> command */
	444	#define CMD_CR_TEXT "<cr>"
228da428	445
718e3744	446	#endif /* _ZEBRA_COMMAND_H */