[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)
DECLARE_MTYPE(CMD_ARG)

/* 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_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_ENCAP_NODE,               /* BGP ENCAP SAFI */
  BGP_ENCAPV6_NODE,             /* BGP ENCAP SAFI */
  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;
};

/**
 * 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 */
  FORK_TKN,         // marks subgraph beginning
  JOIN_TKN,         // marks subgraph end
  START_TKN,        // first token in line
  END_TKN,          // last token in line

  SPECIAL_TKN = FORK_TKN,
};

/* 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?
  uint32_t refcnt;

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

  struct graph_node *forkjoin;  // paired FORK/JOIN for JOIN/FORK
};

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

  const char *name;             /* symbol name for debugging */
};

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

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

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

extern vector completions_to_vec (struct list *completions);
extern void cmd_merge_graphs (struct graph *old, struct graph *new, int direction);
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
4a1ab8e4 DL	33	DECLARE_MTYPE(HOST)
83364d20	34	DECLARE_MTYPE(CMD_ARG)
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. */
	94	BGP_NODE, /* BGP protocol mode which includes BGP4+ */
	95	BGP_VPNV4_NODE, /* BGP MPLS-VPN PE exchange. */
	96	BGP_VPNV6_NODE, /* BGP MPLS-VPN PE exchange. */
	97	BGP_IPV4_NODE, /* BGP IPv4 unicast address family. */
	98	BGP_IPV4M_NODE, /* BGP IPv4 multicast address family. */
f51bae9c	99	BGP_IPV4L_NODE, /* BGP IPv4 labeled unicast address family. */
d0bfb22c QY	100	BGP_IPV6_NODE, /* BGP IPv6 address family */
d0bfb22c QY	101	BGP_IPV6M_NODE, /* BGP IPv6 multicast address family. */
f51bae9c	102	BGP_IPV6L_NODE, /* BGP IPv6 labeled unicast address family. */
d0bfb22c QY	103	BGP_ENCAP_NODE, /* BGP ENCAP SAFI */
d0bfb22c QY	104	BGP_ENCAPV6_NODE, /* BGP ENCAP SAFI */
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
d0bfb22c QY	167	/**
	168	* Types for tokens.
	169	*
	170	* The type determines what kind of data the token can match (in the
	171	* matching use case) or hold (in the argv use case).
	172	*/
	173	enum cmd_token_type
406d6716	174	{
d0bfb22c	175	WORD_TKN, // words
d0bfb22c QY	176	VARIABLE_TKN, // almost anything
	177	RANGE_TKN, // integer range
	178	IPV4_TKN, // IPV4 addresses
	179	IPV4_PREFIX_TKN, // IPV4 network prefixes
	180	IPV6_TKN, // IPV6 prefixes
	181	IPV6_PREFIX_TKN, // IPV6 network prefixes
	182
	183	/* plumbing types */
0bf5b1cb DL	184	FORK_TKN, // marks subgraph beginning
0bf5b1cb DL	185	JOIN_TKN, // marks subgraph end
d0bfb22c QY	186	START_TKN, // first token in line
d0bfb22c QY	187	END_TKN, // last token in line
0bf5b1cb DL	188
0bf5b1cb DL	189	SPECIAL_TKN = FORK_TKN,
406d6716	190	};
406d6716	191
ce882f81 QY	192	/* Command attributes */
	193	enum
	194	{
	195	CMD_ATTR_NORMAL,
	196	CMD_ATTR_DEPRECATED,
	197	CMD_ATTR_HIDDEN,
	198	};
	199
	200	/* Comamand token struct. */
d0bfb22c	201	struct cmd_token
718e3744	202	{
ebacb4ed	203	enum cmd_token_type type; // token type
ce882f81	204	u_char attr; // token attributes
4d94b292	205	bool allowrepeat; // matcher allowed to match token repetively?
de8f7a39	206	uint32_t refcnt;
4d94b292	207
d0bfb22c QY	208	char *text; // token text
d0bfb22c QY	209	char *desc; // token description
d0bfb22c	210	long long min, max; // for ranges
d0bfb22c	211	char *arg; // user input that matches this token
ab037159 DL	212
ab037159 DL	213	struct graph_node *forkjoin; // paired FORK/JOIN for JOIN/FORK
cd40b329 CF	214	};
cd40b329 CF	215
d0bfb22c QY	216	/* Structure of command element. */
d0bfb22c QY	217	struct cmd_element
718e3744	218	{
d0bfb22c QY	219	const char string; / Command specification by string. */
	220	const char doc; / Documentation of this command. */
	221	int daemon; /* Daemon to which this command belong. */
	222	u_char attr; /* Command attributes */
cd40b329	223
d0bfb22c	224	/* handler function for command */
17aca20b	225	int (func) (const struct cmd_element , struct vty , int, struct cmd_token []);
db85c8b3 DL	226
db85c8b3 DL	227	const char name; / symbol name for debugging */
718e3744	228	};
	229
	230	/* Return value of the commands. */
	231	#define CMD_SUCCESS 0
	232	#define CMD_WARNING 1
	233	#define CMD_ERR_NO_MATCH 2
	234	#define CMD_ERR_AMBIGUOUS 3
	235	#define CMD_ERR_INCOMPLETE 4
	236	#define CMD_ERR_EXEED_ARGC_MAX 5
	237	#define CMD_ERR_NOTHING_TODO 6
	238	#define CMD_COMPLETE_FULL_MATCH 7
	239	#define CMD_COMPLETE_MATCH 8
	240	#define CMD_COMPLETE_LIST_MATCH 9
	241	#define CMD_SUCCESS_DAEMON 10
1db63918	242	#define CMD_ERR_NO_FILE 11
95c4aff2	243	#define CMD_SUSPEND 12
718e3744	244
	245	/* Argc max counts. */
	246	#define CMD_ARGC_MAX 25
	247
	248	/* Turn off these macros when uisng cpp with extract.pl */
d0bfb22c	249	#ifndef VTYSH_EXTRACT_PL
718e3744	250
406d6716	251	/* helper defines for end-user DEFUN* macros */
406d6716	252	#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
555a5bfe	253	static struct cmd_element cmdname = \
718e3744	254	{ \
9035efaa	255	.string = cmdstr, \
9035efaa	256	.func = funcname, \
406d6716	257	.doc = helpstr, \
	258	.attr = attrs, \
	259	.daemon = dnum, \
db85c8b3	260	.name = #cmdname, \
406d6716	261	};
	262
	263	#define DEFUN_CMD_FUNC_DECL(funcname) \
17aca20b	264	static int funcname (const struct cmd_element , struct vty , int, struct cmd_token *[]);
406d6716	265
406d6716	266	#define DEFUN_CMD_FUNC_TEXT(funcname) \
274a4a44	267	static int funcname \
17aca20b	268	(const struct cmd_element *self __attribute__ ((unused)), \
6cf0cf0c PJ	269	struct vty *vty __attribute__ ((unused)), \
6cf0cf0c PJ	270	int argc __attribute__ ((unused)), \
d0bfb22c	271	struct cmd_token *argv[] __attribute__ ((unused)) )
406d6716	272
406d6716	273	#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
	274	DEFUN_CMD_FUNC_DECL(funcname) \
	275	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
	276	DEFUN_CMD_FUNC_TEXT(funcname)
	277
	278	#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
	279	DEFUN_CMD_FUNC_DECL(funcname) \
	280	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
	281	DEFUN_CMD_FUNC_TEXT(funcname)
	282
	283	#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
	284	DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
	285
	286	#define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
2557aed1	287	DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
718e3744	288
	289	/* DEFUN_NOSH for commands that vtysh should ignore */
	290	#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
	291	DEFUN(funcname, cmdname, cmdstr, helpstr)
	292
	293	/* DEFSH for vtysh. */
	294	#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
406d6716	295	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
718e3744	296
abaaab4e DW	297	#define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
	298	DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) \
	299
718e3744	300	/* DEFUN + DEFSH */
718e3744	301	#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
406d6716	302	DEFUN_CMD_FUNC_DECL(funcname) \
	303	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
	304	DEFUN_CMD_FUNC_TEXT(funcname)
718e3744	305
274a4a44	306	/* DEFUN + DEFSH with attributes */
	307	#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
	308	DEFUN_CMD_FUNC_DECL(funcname) \
	309	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
	310	DEFUN_CMD_FUNC_TEXT(funcname)
	311
	312	#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
	313	DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
	314
	315	#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
	316	DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
	317
718e3744	318	/* ALIAS macro which define existing command's alias. */
718e3744	319	#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
406d6716	320	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
	321
	322	#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
274a4a44	323	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
406d6716	324
	325	#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
	326	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
	327
	328	#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
	329	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
718e3744	330
274a4a44	331	#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
	332	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
	333
	334	#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
	335	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
	336
	337	#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
	338	DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
	339
718e3744	340	#endif /* VTYSH_EXTRACT_PL */
	341
	342	/* Some macroes */
ba6d273b DS	343
	344	/*
	345	* Sometimes #defines create maximum values that
	346	* need to have strings created from them that
	347	* allow the parser to match against them.
	348	* These macros allow that.
	349	*/
	350	#define CMD_CREATE_STR(s) CMD_CREATE_STR_HELPER(s)
	351	#define CMD_CREATE_STR_HELPER(s) #s
ba6d273b	352
718e3744	353	/* Common descriptions. */
	354	#define SHOW_STR "Show running system information\n"
	355	#define IP_STR "IP information\n"
	356	#define IPV6_STR "IPv6 information\n"
	357	#define NO_STR "Negate a command or set its defaults\n"
9c42a6eb	358	#define REDIST_STR "Redistribute information from another routing protocol\n"
718e3744	359	#define CLEAR_STR "Reset functions\n"
	360	#define RIP_STR "RIP information\n"
	361	#define BGP_STR "BGP information\n"
e0bce756 DS	362	#define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
	363	#define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
	364	#define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
	365	#define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
718e3744	366	#define OSPF_STR "OSPF information\n"
	367	#define NEIGHBOR_STR "Specify neighbor router\n"
	368	#define DEBUG_STR "Debugging functions (see also 'undebug')\n"
	369	#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
	370	#define ROUTER_STR "Enable a routing process\n"
	371	#define AS_STR "AS number\n"
	372	#define MBGP_STR "MBGP information\n"
	373	#define MATCH_STR "Match values from routing table\n"
	374	#define SET_STR "Set values in destination routing protocol\n"
	375	#define OUT_STR "Filter outgoing routing updates\n"
	376	#define IN_STR "Filter incoming routing updates\n"
	377	#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
	378	#define OSPF6_NUMBER_STR "Specify by number\n"
	379	#define INTERFACE_STR "Interface infomation\n"
	380	#define IFNAME_STR "Interface name(e.g. ep0)\n"
	381	#define IP6_STR "IPv6 Information\n"
	382	#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
d0bfb22c	383	#define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
98cfd06b	384	#define SECONDS_STR "Seconds\n"
718e3744	385	#define ROUTE_STR "Routing Table\n"
	386	#define PREFIX_LIST_STR "Build a prefix list\n"
	387	#define OSPF6_DUMP_TYPE_LIST \
d0bfb22c	388	"<neighbor\|interface\|area\|lsa\|zebra\|config\|dbex\|spf\|route\|lsdb\|redistribute\|hook\|asbr\|prefix\|abr>"
9e867fe6	389	#define ISIS_STR "IS-IS information\n"
9e867fe6	390	#define AREA_TAG_STR "[area tag]\n"
d0bfb22c QY	391	#define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
d0bfb22c QY	392	#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	393	#define MPLS_TE_STR "MPLS-TE specific commands\n"
	394	#define LINK_PARAMS_STR "Configure interface link parameters\n"
	395	#define OSPF_RI_STR "OSPF Router Information specific commands\n"
	396	#define PCE_STR "PCE Router Information specific commands\n"
7758e3f3	397	#define MPLS_STR "MPLS information\n"
718e3744	398
	399	#define CONF_BACKUP_EXT ".sav"
	400
	401	/* IPv4 only machine should not accept IPv6 address for peer's IP
	402	address. So we replace VTY command string like below. */
718e3744	403	#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
a80beece DS	404	#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
a80beece DS	405	#define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
718e3744	406
718e3744	407	/* Prototypes. */
8cc4198f	408	extern void install_node (struct cmd_node , int () (struct vty *));
	409	extern void install_default (enum node_type);
	410	extern void install_element (enum node_type, struct cmd_element *);
718e3744	411
de8f7a39 DL	412	/* known issue with uninstall_element: changes to cmd_token->attr (i.e.
	413	* deprecated/hidden) are not reversed. */
	414	extern void uninstall_element (enum node_type, struct cmd_element *);
	415
f6834d4c	416	/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
	417	string with a space between each element (allocated using
	418	XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
d0bfb22c	419	extern char argv_concat (struct cmd_token *argv, int argc, int shift);
ae19d7dd	420	extern int argv_find (struct cmd_token *argv, int argc, const char text, int *index);
8cc4198f	421
	422	extern vector cmd_make_strvec (const char *);
	423	extern void cmd_free_strvec (vector);
	424	extern vector cmd_describe_command (vector, struct vty , int status);
	425	extern char *cmd_complete_command (vector, struct vty , int *status);
	426	extern const char *cmd_prompt (enum node_type);
17aca20b	427	extern int command_config_read_one_line (struct vty vty, const struct cmd_element *, int use_config_node);
13fbc82d	428	extern int config_from_file (struct vty , FILE , unsigned int *line_num);
8cc4198f	429	extern enum node_type node_parent (enum node_type);
17aca20b QY	430	extern int cmd_execute_command (vector, struct vty , const struct cmd_element *, int);
17aca20b QY	431	extern int cmd_execute_command_strict (vector, struct vty , const struct cmd_element *);
8cc4198f	432	extern void cmd_init (int);
228da428	433	extern void cmd_terminate (void);
0b84f294 DL	434	extern void cmd_exit (struct vty *vty);
0b84f294 DL	435	extern int cmd_list_cmds (struct vty *vty, int do_permute);
718e3744	436
bff9c3e9 DL	437	extern int cmd_hostname_set (const char *hostname);
bff9c3e9 DL	438
af2567b6 DL	439	/* NOT safe for general use; call this only if DEV_BUILD! */
	440	extern void grammar_sandbox_init (void);
	441
d0bfb22c	442	/* memory management for cmd_token */
83364d20 DL	443	extern struct cmd_token *new_cmd_token (enum cmd_token_type, u_char attr,
	444	const char text, const char desc);
	445	extern void del_cmd_token (struct cmd_token *);
	446	extern struct cmd_token copy_cmd_token (struct cmd_token );
d0bfb22c	447
af2567b6	448	extern vector completions_to_vec (struct list *completions);
de8f7a39	449	extern void cmd_merge_graphs (struct graph old, struct graph new, int direction);
2ab40270 DL	450	extern void command_parse_format (struct graph graph, struct cmd_element cmd);
2ab40270 DL	451
718e3744	452	/* Export typical functions. */
57387fb2	453	extern const char *host_config_get (void);
c0e8c16f	454	extern void host_config_set (const char *);
6590f2c3	455
8cc4198f	456	extern void print_version (const char *);
86228fde	457
7cfc61d3 DS	458	extern int cmd_banner_motd_file (const char *);
7cfc61d3 DS	459
86228fde	460	/* struct host global, ick */
d0bfb22c QY	461	extern struct host host;
	462
	463	/* text for <cr> command */
	464	#define CMD_CR_TEXT "<cr>"
228da428	465
718e3744	466	#endif /* _ZEBRA_COMMAND_H */