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
  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"
  28 #include "lib/route_types.h"
  29 #include "graph.h"
  30 #include "memory.h"
  31 #include "hash.h"
  32
  33 DECLARE_MTYPE(HOST)
  34 DECLARE_MTYPE(CMD_ARG)
  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_ENCAP_NODE,               /* BGP ENCAP SAFI */
 105   BGP_ENCAPV6_NODE,             /* BGP ENCAP SAFI */
 106   BGP_VRF_POLICY_NODE,          /* BGP VRF policy */
 107   BGP_VNC_DEFAULTS_NODE,        /* BGP VNC nve defaults */
 108   BGP_VNC_NVE_GROUP_NODE,       /* BGP VNC nve group */
 109   BGP_VNC_L2_GROUP_NODE,        /* BGP VNC L2 group */
 110   RFP_DEFAULTS_NODE,    /* RFP defaults node */
 111   BGP_EVPN_NODE,                /* BGP EVPN node. */
 112   OSPF_NODE,                    /* OSPF protocol mode */
 113   OSPF6_NODE,                   /* OSPF protocol for IPv6 mode */
 114   LDP_NODE,                     /* LDP protocol mode */
 115   LDP_IPV4_NODE,                /* LDP IPv4 address family */
 116   LDP_IPV6_NODE,                /* LDP IPv6 address family */
 117   LDP_IPV4_IFACE_NODE,          /* LDP IPv4 Interface */
 118   LDP_IPV6_IFACE_NODE,          /* LDP IPv6 Interface */
 119   LDP_L2VPN_NODE,               /* LDP L2VPN node */
 120   LDP_PSEUDOWIRE_NODE,          /* LDP Pseudowire node */
 121   ISIS_NODE,                    /* ISIS protocol mode */
 122   PIM_NODE,                     /* PIM protocol mode */
 123   MASC_NODE,                    /* MASC for multicast.  */
 124   IRDP_NODE,                    /* ICMP Router Discovery Protocol mode. */
 125   IP_NODE,                      /* Static ip route node. */
 126   ACCESS_NODE,                  /* Access list node. */
 127   PREFIX_NODE,                  /* Prefix list node. */
 128   ACCESS_IPV6_NODE,             /* Access list node. */
 129   PREFIX_IPV6_NODE,             /* Prefix list node. */
 130   AS_LIST_NODE,                 /* AS list node. */
 131   COMMUNITY_LIST_NODE,          /* Community list node. */
 132   RMAP_NODE,                    /* Route map node. */
 133   SMUX_NODE,                    /* SNMP configuration node. */
 134   DUMP_NODE,                    /* Packet dump node. */
 135   FORWARDING_NODE,              /* IP forwarding node. */
 136   PROTOCOL_NODE,                /* protocol filtering node */
 137   MPLS_NODE,                    /* MPLS config node */
 138   VTY_NODE,                     /* Vty node. */
 139   LINK_PARAMS_NODE,             /* Link-parameters node */
 140 };
 141
 142 /* Node which has some commands and prompt string and configuration
 143    function pointer . */
 144 struct cmd_node
 145 {
 146   /* Node index. */
 147   enum node_type node;
 148
 149   /* Prompt character at vty interface. */
 150   const char *prompt;
 151
 152   /* Is this node's configuration goes to vtysh ? */
 153   int vtysh;
 154
 155   /* Node's configuration write function */
 156   int (*func) (struct vty *);
 157
 158   /* Node's command graph */
 159   struct graph *cmdgraph;
 160
 161   /* Vector of this node's command list. */
 162   vector cmd_vector;
 163
 164   /* Hashed index of command node list, for de-dupping primarily */
 165   struct hash *cmd_hash;
 166 };
 167
 168 /**
 169  * Types for tokens.
 170  *
 171  * The type determines what kind of data the token can match (in the
 172  * matching use case) or hold (in the argv use case).
 173  */
 174 enum cmd_token_type
 175 {
 176   WORD_TKN,         // words
 177   VARIABLE_TKN,     // almost anything
 178   RANGE_TKN,        // integer range
 179   IPV4_TKN,         // IPV4 addresses
 180   IPV4_PREFIX_TKN,  // IPV4 network prefixes
 181   IPV6_TKN,         // IPV6 prefixes
 182   IPV6_PREFIX_TKN,  // IPV6 network prefixes
 183
 184   /* plumbing types */
 185   FORK_TKN,         // marks subgraph beginning
 186   JOIN_TKN,         // marks subgraph end
 187   START_TKN,        // first token in line
 188   END_TKN,          // last token in line
 189
 190   SPECIAL_TKN = FORK_TKN,
 191 };
 192
 193 /* Command attributes */
 194 enum
 195 {
 196   CMD_ATTR_NORMAL,
 197   CMD_ATTR_DEPRECATED,
 198   CMD_ATTR_HIDDEN,
 199 };
 200
 201 /* Comamand token struct. */
 202 struct cmd_token
 203 {
 204   enum cmd_token_type type;     // token type
 205   u_char attr;                  // token attributes
 206   bool allowrepeat;             // matcher allowed to match token repetively?
 207   uint32_t refcnt;
 208
 209   char *text;                   // token text
 210   char *desc;                   // token description
 211   long long min, max;           // for ranges
 212   char *arg;                    // user input that matches this token
 213
 214   struct graph_node *forkjoin;  // paired FORK/JOIN for JOIN/FORK
 215 };
 216
 217 /* Structure of command element. */
 218 struct cmd_element
 219 {
 220   const char *string;           /* Command specification by string. */
 221   const char *doc;              /* Documentation of this command. */
 222   int daemon;                   /* Daemon to which this command belong. */
 223   u_char attr;                  /* Command attributes */
 224
 225   /* handler function for command */
 226   int (*func) (const struct cmd_element *, struct vty *, int, struct cmd_token *[]);
 227
 228   const char *name;             /* symbol name for debugging */
 229 };
 230
 231 /* Return value of the commands. */
 232 #define CMD_SUCCESS              0
 233 #define CMD_WARNING              1
 234 #define CMD_ERR_NO_MATCH         2
 235 #define CMD_ERR_AMBIGUOUS        3
 236 #define CMD_ERR_INCOMPLETE       4
 237 #define CMD_ERR_EXEED_ARGC_MAX   5
 238 #define CMD_ERR_NOTHING_TODO     6
 239 #define CMD_COMPLETE_FULL_MATCH  7
 240 #define CMD_COMPLETE_MATCH       8
 241 #define CMD_COMPLETE_LIST_MATCH  9
 242 #define CMD_SUCCESS_DAEMON      10
 243 #define CMD_ERR_NO_FILE         11
 244 #define CMD_SUSPEND             12
 245
 246 /* Argc max counts. */
 247 #define CMD_ARGC_MAX   25
 248
 249 /* Turn off these macros when uisng cpp with extract.pl */
 250 #ifndef VTYSH_EXTRACT_PL
 251
 252 /* helper defines for end-user DEFUN* macros */
 253 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
 254   static struct cmd_element cmdname = \
 255   { \
 256     .string = cmdstr, \
 257     .func = funcname, \
 258     .doc = helpstr, \
 259     .attr = attrs, \
 260     .daemon = dnum, \
 261     .name = #cmdname, \
 262   };
 263
 264 #define DEFUN_CMD_FUNC_DECL(funcname) \
 265   static int funcname (const struct cmd_element *, struct vty *, int, struct cmd_token *[]);
 266
 267 #define DEFUN_CMD_FUNC_TEXT(funcname) \
 268   static int funcname \
 269     (const struct cmd_element *self __attribute__ ((unused)), \
 270      struct vty *vty __attribute__ ((unused)), \
 271      int argc __attribute__ ((unused)), \
 272      struct cmd_token *argv[] __attribute__ ((unused)) )
 273
 274 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
 275   DEFUN_CMD_FUNC_DECL(funcname) \
 276   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
 277   DEFUN_CMD_FUNC_TEXT(funcname)
 278
 279 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
 280   DEFUN_CMD_FUNC_DECL(funcname) \
 281   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
 282   DEFUN_CMD_FUNC_TEXT(funcname)
 283
 284 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
 285   DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 286
 287 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
 288   DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
 289
 290 /* DEFUN_NOSH for commands that vtysh should ignore */
 291 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
 292   DEFUN(funcname, cmdname, cmdstr, helpstr)
 293
 294 /* DEFSH for vtysh. */
 295 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
 296   DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
 297
 298 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr) \
 299   DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) \
 300
 301 /* DEFUN + DEFSH */
 302 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
 303   DEFUN_CMD_FUNC_DECL(funcname) \
 304   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
 305   DEFUN_CMD_FUNC_TEXT(funcname)
 306
 307 /* DEFUN + DEFSH with attributes */
 308 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
 309   DEFUN_CMD_FUNC_DECL(funcname) \
 310   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
 311   DEFUN_CMD_FUNC_TEXT(funcname)
 312
 313 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
 314   DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 315
 316 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
 317   DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
 318
 319 /* ALIAS macro which define existing command's alias. */
 320 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
 321   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
 322
 323 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
 324   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
 325
 326 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
 327   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
 328
 329 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
 330   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
 331
 332 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
 333   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
 334
 335 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
 336   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
 337
 338 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
 339   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
 340
 341 #endif /* VTYSH_EXTRACT_PL */
 342
 343 /* Some macroes */
 344
 345 /*
 346  * Sometimes #defines create maximum values that
 347  * need to have strings created from them that
 348  * allow the parser to match against them.
 349  * These macros allow that.
 350  */
 351 #define CMD_CREATE_STR(s)  CMD_CREATE_STR_HELPER(s)
 352 #define CMD_CREATE_STR_HELPER(s) #s
 353
 354 /* Common descriptions. */
 355 #define SHOW_STR "Show running system information\n"
 356 #define IP_STR "IP information\n"
 357 #define IPV6_STR "IPv6 information\n"
 358 #define NO_STR "Negate a command or set its defaults\n"
 359 #define REDIST_STR "Redistribute information from another routing protocol\n"
 360 #define CLEAR_STR "Reset functions\n"
 361 #define RIP_STR "RIP information\n"
 362 #define EIGRP_STR "EIGRP information\n"
 363 #define BGP_STR "BGP information\n"
 364 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
 365 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
 366 #define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
 367 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
 368 #define OSPF_STR "OSPF information\n"
 369 #define NEIGHBOR_STR "Specify neighbor router\n"
 370 #define DEBUG_STR "Debugging functions (see also 'undebug')\n"
 371 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
 372 #define ROUTER_STR "Enable a routing process\n"
 373 #define AS_STR "AS number\n"
 374 #define MBGP_STR "MBGP information\n"
 375 #define MATCH_STR "Match values from routing table\n"
 376 #define SET_STR "Set values in destination routing protocol\n"
 377 #define OUT_STR "Filter outgoing routing updates\n"
 378 #define IN_STR  "Filter incoming routing updates\n"
 379 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
 380 #define OSPF6_NUMBER_STR "Specify by number\n"
 381 #define INTERFACE_STR "Interface infomation\n"
 382 #define IFNAME_STR "Interface name(e.g. ep0)\n"
 383 #define IP6_STR "IPv6 Information\n"
 384 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
 385 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
 386 #define SECONDS_STR "Seconds\n"
 387 #define ROUTE_STR "Routing Table\n"
 388 #define PREFIX_LIST_STR "Build a prefix list\n"
 389 #define OSPF6_DUMP_TYPE_LIST \
 390 "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
 391 #define ISIS_STR "IS-IS information\n"
 392 #define AREA_TAG_STR "[area tag]\n"
 393 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
 394 #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"
 395 #define MPLS_TE_STR "MPLS-TE specific commands\n"
 396 #define LINK_PARAMS_STR "Configure interface link parameters\n"
 397 #define OSPF_RI_STR "OSPF Router Information specific commands\n"
 398 #define PCE_STR "PCE Router Information specific commands\n"
 399 #define MPLS_STR "MPLS information\n"
 400
 401 #define CONF_BACKUP_EXT ".sav"
 402
 403 /* IPv4 only machine should not accept IPv6 address for peer's IP
 404    address.  So we replace VTY command string like below. */
 405 #define NEIGHBOR_ADDR_STR  "Neighbor address\nIPv6 address\n"
 406 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
 407 #define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
 408
 409 /* Prototypes. */
 410 extern void install_node (struct cmd_node *, int (*) (struct vty *));
 411 extern void install_default (enum node_type);
 412 extern void install_element (enum node_type, struct cmd_element *);
 413
 414 /* known issue with uninstall_element:  changes to cmd_token->attr (i.e.
 415  * deprecated/hidden) are not reversed. */
 416 extern void uninstall_element (enum node_type, struct cmd_element *);
 417
 418 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
 419    string with a space between each element (allocated using
 420    XMALLOC(MTYPE_TMP)).  Returns NULL if shift >= argc. */
 421 extern char *argv_concat (struct cmd_token **argv, int argc, int shift);
 422 extern int argv_find (struct cmd_token **argv, int argc, const char *text, int *index);
 423
 424 extern vector cmd_make_strvec (const char *);
 425 extern void cmd_free_strvec (vector);
 426 extern vector cmd_describe_command (vector, struct vty *, int *status);
 427 extern char **cmd_complete_command (vector, struct vty *, int *status);
 428 extern const char *cmd_prompt (enum node_type);
 429 extern int command_config_read_one_line (struct vty *vty, const struct cmd_element **, int use_config_node);
 430 extern int config_from_file (struct vty *, FILE *, unsigned int *line_num);
 431 extern enum node_type node_parent (enum node_type);
 432 extern int cmd_execute_command (vector, struct vty *, const struct cmd_element **, int);
 433 extern int cmd_execute_command_strict (vector, struct vty *, const struct cmd_element **);
 434 extern void cmd_init (int);
 435 extern void cmd_terminate (void);
 436 extern void cmd_exit (struct vty *vty);
 437 extern int cmd_list_cmds (struct vty *vty, int do_permute);
 438
 439 extern int cmd_hostname_set (const char *hostname);
 440
 441 /* NOT safe for general use; call this only if DEV_BUILD! */
 442 extern void grammar_sandbox_init (void);
 443
 444 /* memory management for cmd_token */
 445 extern struct cmd_token *new_cmd_token (enum cmd_token_type, u_char attr,
 446                                         const char *text, const char *desc);
 447 extern void del_cmd_token (struct cmd_token *);
 448 extern struct cmd_token *copy_cmd_token (struct cmd_token *);
 449
 450 extern vector completions_to_vec (struct list *completions);
 451 extern void cmd_merge_graphs (struct graph *old, struct graph *new, int direction);
 452 extern void command_parse_format (struct graph *graph, struct cmd_element *cmd);
 453
 454 /* Export typical functions. */
 455 extern const char *host_config_get (void);
 456 extern void host_config_set (const char *);
 457
 458 extern void print_version (const char *);
 459
 460 extern int cmd_banner_motd_file (const char *);
 461
 462 /* struct host global, ick */
 463 extern struct host host;
 464
 465 /* text for <cr> command */
 466 #define CMD_CR_TEXT "<cr>"
 467
 468 #endif /* _ZEBRA_COMMAND_H */