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