lib/command.h

   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.
  11  *
  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 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
  20  */
  21
  22 #ifndef _ZEBRA_COMMAND_H
  23 #define _ZEBRA_COMMAND_H
  24
  25 #include "vector.h"
  26 #include "vty.h"
  27 #include "lib/route_types.h"
  28 #include "graph.h"
  29 #include "memory.h"
  30 #include "hash.h"
  31 #include "command_graph.h"
  32
  33 DECLARE_MTYPE(HOST)
  34 DECLARE_MTYPE(COMPLETION)
  35
  36 /* for test-commands.c */
  37 DECLARE_MTYPE(STRVEC)
  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
  59   /* config file name of this host */
  60   char *config;
  61   int noconfig;
  62
  63   /* Flags for services */
  64   int advanced;
  65   int encrypt;
  66
  67   /* Banner configuration. */
  68   const char *motd;
  69   char *motdfile;
  70 };
  71
  72 /* There are some command levels which called from command node. */
  73 enum node_type
  74 {
  75   AUTH_NODE,                    /* Authentication mode of vty interface. */
  76   VIEW_NODE,                    /* View node. Default mode of vty interface. */
  77   AUTH_ENABLE_NODE,             /* Authentication mode for change enable. */
  78   ENABLE_NODE,                  /* Enable node. */
  79   CONFIG_NODE,                  /* Config node. Default mode of config file. */
  80   SERVICE_NODE,                 /* Service node. */
  81   DEBUG_NODE,                   /* Debug node. */
  82   VRF_DEBUG_NODE,               /* Vrf Debug node. */
  83   DEBUG_VNC_NODE,               /* Debug VNC node. */
  84   AAA_NODE,                     /* AAA node. */
  85   KEYCHAIN_NODE,                /* Key-chain node. */
  86   KEYCHAIN_KEY_NODE,            /* Key-chain key node. */
  87   NS_NODE,                      /* Logical-Router node. */
  88   VRF_NODE,                     /* VRF mode node. */
  89   INTERFACE_NODE,               /* Interface mode node. */
  90   ZEBRA_NODE,                   /* zebra connection node. */
  91   TABLE_NODE,                   /* rtm_table selection node. */
  92   RIP_NODE,                     /* RIP protocol mode node. */
  93   RIPNG_NODE,                   /* RIPng protocol mode node. */
  94   EIGRP_NODE,                   /* EIGRP protocol mode node. */
  95   BGP_NODE,                     /* BGP protocol mode which includes BGP4+ */
  96   BGP_VPNV4_NODE,               /* BGP MPLS-VPN PE exchange. */
  97   BGP_VPNV6_NODE,               /* BGP MPLS-VPN PE exchange. */
  98   BGP_IPV4_NODE,                /* BGP IPv4 unicast address family.  */
  99   BGP_IPV4M_NODE,               /* BGP IPv4 multicast address family.  */
 100   BGP_IPV4L_NODE,               /* BGP IPv4 labeled unicast address family.  */
 101   BGP_IPV6_NODE,                /* BGP IPv6 address family */
 102   BGP_IPV6M_NODE,               /* BGP IPv6 multicast address family. */
 103   BGP_IPV6L_NODE,               /* BGP IPv6 labeled unicast address family. */
 104   BGP_VRF_POLICY_NODE,          /* BGP VRF policy */
 105   BGP_VNC_DEFAULTS_NODE,        /* BGP VNC nve defaults */
 106   BGP_VNC_NVE_GROUP_NODE,       /* BGP VNC nve group */
 107   BGP_VNC_L2_GROUP_NODE,        /* BGP VNC L2 group */
 108   RFP_DEFAULTS_NODE,    /* RFP defaults node */
 109   BGP_EVPN_NODE,                /* BGP EVPN node. */
 110   OSPF_NODE,                    /* OSPF protocol mode */
 111   OSPF6_NODE,                   /* OSPF protocol for IPv6 mode */
 112   LDP_NODE,                     /* LDP protocol mode */
 113   LDP_IPV4_NODE,                /* LDP IPv4 address family */
 114   LDP_IPV6_NODE,                /* LDP IPv6 address family */
 115   LDP_IPV4_IFACE_NODE,          /* LDP IPv4 Interface */
 116   LDP_IPV6_IFACE_NODE,          /* LDP IPv6 Interface */
 117   LDP_L2VPN_NODE,               /* LDP L2VPN node */
 118   LDP_PSEUDOWIRE_NODE,          /* LDP Pseudowire node */
 119   ISIS_NODE,                    /* ISIS protocol mode */
 120   PIM_NODE,                     /* PIM protocol mode */
 121   MASC_NODE,                    /* MASC for multicast.  */
 122   IRDP_NODE,                    /* ICMP Router Discovery Protocol mode. */
 123   IP_NODE,                      /* Static ip route node. */
 124   ACCESS_NODE,                  /* Access list node. */
 125   PREFIX_NODE,                  /* Prefix list node. */
 126   ACCESS_IPV6_NODE,             /* Access list node. */
 127   PREFIX_IPV6_NODE,             /* Prefix list node. */
 128   AS_LIST_NODE,                 /* AS list node. */
 129   COMMUNITY_LIST_NODE,          /* Community list node. */
 130   RMAP_NODE,                    /* Route map node. */
 131   SMUX_NODE,                    /* SNMP configuration node. */
 132   DUMP_NODE,                    /* Packet dump node. */
 133   FORWARDING_NODE,              /* IP forwarding node. */
 134   PROTOCOL_NODE,                /* protocol filtering node */
 135   MPLS_NODE,                    /* MPLS config node */
 136   VTY_NODE,                     /* Vty node. */
 137   LINK_PARAMS_NODE,             /* Link-parameters node */
 138 };
 139
 140 /* Node which has some commands and prompt string and configuration
 141    function pointer . */
 142 struct cmd_node
 143 {
 144   /* Node index. */
 145   enum node_type node;
 146
 147   /* Prompt character at vty interface. */
 148   const char *prompt;
 149
 150   /* Is this node's configuration goes to vtysh ? */
 151   int vtysh;
 152
 153   /* Node's configuration write function */
 154   int (*func) (struct vty *);
 155
 156   /* Node's command graph */
 157   struct graph *cmdgraph;
 158
 159   /* Vector of this node's command list. */
 160   vector cmd_vector;
 161
 162   /* Hashed index of command node list, for de-dupping primarily */
 163   struct hash *cmd_hash;
 164 };
 165
 166 /* Return value of the commands. */
 167 #define CMD_SUCCESS              0
 168 #define CMD_WARNING              1
 169 #define CMD_ERR_NO_MATCH         2
 170 #define CMD_ERR_AMBIGUOUS        3
 171 #define CMD_ERR_INCOMPLETE       4
 172 #define CMD_ERR_EXEED_ARGC_MAX   5
 173 #define CMD_ERR_NOTHING_TODO     6
 174 #define CMD_COMPLETE_FULL_MATCH  7
 175 #define CMD_COMPLETE_MATCH       8
 176 #define CMD_COMPLETE_LIST_MATCH  9
 177 #define CMD_SUCCESS_DAEMON      10
 178 #define CMD_ERR_NO_FILE         11
 179 #define CMD_SUSPEND             12
 180
 181 /* Argc max counts. */
 182 #define CMD_ARGC_MAX   25
 183
 184 /* Turn off these macros when uisng cpp with extract.pl */
 185 #ifndef VTYSH_EXTRACT_PL
 186
 187 /* helper defines for end-user DEFUN* macros */
 188 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
 189   static struct cmd_element cmdname = \
 190   { \
 191     .string = cmdstr, \
 192     .func = funcname, \
 193     .doc = helpstr, \
 194     .attr = attrs, \
 195     .daemon = dnum, \
 196     .name = #cmdname, \
 197   };
 198
 199 #define DEFUN_CMD_FUNC_DECL(funcname) \
 200   static int funcname (const struct cmd_element *, struct vty *, int, struct cmd_token *[]);
 201
 202 #define DEFUN_CMD_FUNC_TEXT(funcname) \
 203   static int funcname \
 204     (const struct cmd_element *self __attribute__ ((unused)), \
 205      struct vty *vty __attribute__ ((unused)), \
 206      int argc __attribute__ ((unused)), \
 207      struct cmd_token *argv[] __attribute__ ((unused)) )
 208
 209 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
 210   DEFUN_CMD_FUNC_DECL(funcname) \
 211   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
 212   DEFUN_CMD_FUNC_TEXT(funcname)
 213
 214 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
 215   DEFUN_CMD_FUNC_DECL(funcname) \
 216   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
 217   DEFUN_CMD_FUNC_TEXT(funcname)
 218
 219 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
 220   DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 221
 222 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
 223   DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
 224
 225 /* DEFUN_NOSH for commands that vtysh should ignore */
 226 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
 227   DEFUN(funcname, cmdname, cmdstr, helpstr)
 228
 229 /* DEFSH for vtysh. */
 230 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
 231   DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
 232
 233 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
 234   DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) \
 235
 236 /* DEFUN + DEFSH */
 237 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
 238   DEFUN_CMD_FUNC_DECL(funcname) \
 239   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
 240   DEFUN_CMD_FUNC_TEXT(funcname)
 241
 242 /* DEFUN + DEFSH with attributes */
 243 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
 244   DEFUN_CMD_FUNC_DECL(funcname) \
 245   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
 246   DEFUN_CMD_FUNC_TEXT(funcname)
 247
 248 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
 249   DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 250
 251 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
 252   DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
 253
 254 /* ALIAS macro which define existing command's alias. */
 255 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
 256   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
 257
 258 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
 259   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
 260
 261 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
 262   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
 263
 264 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
 265   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
 266
 267 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
 268   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
 269
 270 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
 271   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
 272
 273 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
 274   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
 275
 276 #endif /* VTYSH_EXTRACT_PL */
 277
 278 /* Some macroes */
 279
 280 /*
 281  * Sometimes #defines create maximum values that
 282  * need to have strings created from them that
 283  * allow the parser to match against them.
 284  * These macros allow that.
 285  */
 286 #define CMD_CREATE_STR(s)  CMD_CREATE_STR_HELPER(s)
 287 #define CMD_CREATE_STR_HELPER(s) #s
 288
 289 /* Common descriptions. */
 290 #define SHOW_STR "Show running system information\n"
 291 #define IP_STR "IP information\n"
 292 #define IPV6_STR "IPv6 information\n"
 293 #define NO_STR "Negate a command or set its defaults\n"
 294 #define REDIST_STR "Redistribute information from another routing protocol\n"
 295 #define CLEAR_STR "Reset functions\n"
 296 #define RIP_STR "RIP information\n"
 297 #define EIGRP_STR "EIGRP information\n"
 298 #define BGP_STR "BGP information\n"
 299 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
 300 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
 301 #define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
 302 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
 303 #define OSPF_STR "OSPF information\n"
 304 #define NEIGHBOR_STR "Specify neighbor router\n"
 305 #define DEBUG_STR "Debugging functions (see also 'undebug')\n"
 306 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
 307 #define ROUTER_STR "Enable a routing process\n"
 308 #define AS_STR "AS number\n"
 309 #define MBGP_STR "MBGP information\n"
 310 #define MATCH_STR "Match values from routing table\n"
 311 #define SET_STR "Set values in destination routing protocol\n"
 312 #define OUT_STR "Filter outgoing routing updates\n"
 313 #define IN_STR  "Filter incoming routing updates\n"
 314 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
 315 #define OSPF6_NUMBER_STR "Specify by number\n"
 316 #define INTERFACE_STR "Interface infomation\n"
 317 #define IFNAME_STR "Interface name(e.g. ep0)\n"
 318 #define IP6_STR "IPv6 Information\n"
 319 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
 320 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
 321 #define SECONDS_STR "Seconds\n"
 322 #define ROUTE_STR "Routing Table\n"
 323 #define PREFIX_LIST_STR "Build a prefix list\n"
 324 #define OSPF6_DUMP_TYPE_LIST \
 325 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
 326 #define ISIS_STR "IS-IS information\n"
 327 #define AREA_TAG_STR "[area tag]\n"
 328 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
 329 #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"
 330 #define MPLS_TE_STR "MPLS-TE specific commands\n"
 331 #define LINK_PARAMS_STR "Configure interface link parameters\n"
 332 #define OSPF_RI_STR "OSPF Router Information specific commands\n"
 333 #define PCE_STR "PCE Router Information specific commands\n"
 334 #define MPLS_STR "MPLS information\n"
 335
 336 #define CONF_BACKUP_EXT ".sav"
 337
 338 /* IPv4 only machine should not accept IPv6 address for peer's IP
 339    address.  So we replace VTY command string like below. */
 340 #define NEIGHBOR_ADDR_STR  "Neighbor address\nIPv6 address\n"
 341 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
 342 #define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
 343
 344 /* Prototypes. */
 345 extern void install_node (struct cmd_node *, int (*) (struct vty *));
 346 extern void install_default (enum node_type);
 347 extern void install_element (enum node_type, struct cmd_element *);
 348
 349 /* known issue with uninstall_element:  changes to cmd_token->attr (i.e.
 350  * deprecated/hidden) are not reversed. */
 351 extern void uninstall_element (enum node_type, struct cmd_element *);
 352
 353 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
 354    string with a space between each element (allocated using
 355    XMALLOC(MTYPE_TMP)).  Returns NULL if shift >= argc. */
 356 extern char *argv_concat (struct cmd_token **argv, int argc, int shift);
 357 extern int argv_find (struct cmd_token **argv, int argc, const char *text, int *index);
 358
 359 extern vector cmd_make_strvec (const char *);
 360 extern void cmd_free_strvec (vector);
 361 extern vector cmd_describe_command (vector, struct vty *, int *status);
 362 extern char **cmd_complete_command (vector, struct vty *, int *status);
 363 extern const char *cmd_prompt (enum node_type);
 364 extern int command_config_read_one_line (struct vty *vty, const struct cmd_element **, int use_config_node);
 365 extern int config_from_file (struct vty *, FILE *, unsigned int *line_num);
 366 extern enum node_type node_parent (enum node_type);
 367 extern int cmd_execute_command (vector, struct vty *, const struct cmd_element **, int);
 368 extern int cmd_execute_command_strict (vector, struct vty *, const struct cmd_element **);
 369 extern void cmd_init (int);
 370 extern void cmd_terminate (void);
 371 extern void cmd_exit (struct vty *vty);
 372 extern int cmd_list_cmds (struct vty *vty, int do_permute);
 373
 374 extern int cmd_hostname_set (const char *hostname);
 375
 376 /* NOT safe for general use; call this only if DEV_BUILD! */
 377 extern void grammar_sandbox_init (void);
 378
 379 extern vector completions_to_vec (struct list *completions);
 380
 381 /* Export typical functions. */
 382 extern const char *host_config_get (void);
 383 extern void host_config_set (const char *);
 384
 385 extern void print_version (const char *);
 386
 387 extern int cmd_banner_motd_file (const char *);
 388
 389 /* struct host global, ick */
 390 extern struct host host;
 391
 392 struct cmd_variable_handler {
 393         const char *tokenname, *varname;
 394         void (*completions)(vector out, struct cmd_token *token);
 395 };
 396
 397 extern void cmd_variable_complete (struct cmd_token *token, const char *arg, vector comps);
 398 extern void cmd_variable_handler_register (const struct cmd_variable_handler *cvh);
 399
 400 #endif /* _ZEBRA_COMMAND_H */