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