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
  29 /* Host configuration variable */
  30 struct host
  31 {
  32   /* Host name of this router. */
  33   char *name;
  34
  35   /* Password for vty interface. */
  36   char *password;
  37   char *password_encrypt;
  38
  39   /* Enable password */
  40   char *enable;
  41   char *enable_encrypt;
  42
  43   /* System wide terminal lines. */
  44   int lines;
  45
  46   /* Log filename. */
  47   char *logfile;
  48
  49   /* config file name of this host */
  50   char *config;
  51
  52   /* Flags for services */
  53   int advanced;
  54   int encrypt;
  55
  56   /* Banner configuration. */
  57   const char *motd;
  58   char *motdfile;
  59 };
  60
  61 /* There are some command levels which called from command node. */
  62 enum node_type
  63 {
  64   AUTH_NODE,                    /* Authentication mode of vty interface. */
  65   VIEW_NODE,                    /* View node. Default mode of vty interface. */
  66   AUTH_ENABLE_NODE,             /* Authentication mode for change enable. */
  67   ENABLE_NODE,                  /* Enable node. */
  68   CONFIG_NODE,                  /* Config node. Default mode of config file. */
  69   SERVICE_NODE,                 /* Service node. */
  70   DEBUG_NODE,                   /* Debug node. */
  71   AAA_NODE,                     /* AAA node. */
  72   KEYCHAIN_NODE,                /* Key-chain node. */
  73   KEYCHAIN_KEY_NODE,            /* Key-chain key node. */
  74   INTERFACE_NODE,               /* Interface mode node. */
  75   ZEBRA_NODE,                   /* zebra connection node. */
  76   TABLE_NODE,                   /* rtm_table selection node. */
  77   RIP_NODE,                     /* RIP protocol mode node. */
  78   RIPNG_NODE,                   /* RIPng protocol mode node. */
  79   BGP_NODE,                     /* BGP protocol mode which includes BGP4+ */
  80   BGP_VPNV4_NODE,               /* BGP MPLS-VPN PE exchange. */
  81   BGP_IPV4_NODE,                /* BGP IPv4 unicast address family.  */
  82   BGP_IPV4M_NODE,               /* BGP IPv4 multicast address family.  */
  83   BGP_IPV6_NODE,                /* BGP IPv6 address family */
  84   BGP_IPV6M_NODE,               /* BGP IPv6 multicast address family. */
  85   OSPF_NODE,                    /* OSPF protocol mode */
  86   OSPF6_NODE,                   /* OSPF protocol for IPv6 mode */
  87   ISIS_NODE,                    /* ISIS protocol mode */
  88   MASC_NODE,                    /* MASC for multicast.  */
  89   IRDP_NODE,                    /* ICMP Router Discovery Protocol mode. */
  90   IP_NODE,                      /* Static ip route node. */
  91   ACCESS_NODE,                  /* Access list node. */
  92   PREFIX_NODE,                  /* Prefix list node. */
  93   ACCESS_IPV6_NODE,             /* Access list node. */
  94   PREFIX_IPV6_NODE,             /* Prefix list node. */
  95   AS_LIST_NODE,                 /* AS list node. */
  96   COMMUNITY_LIST_NODE,          /* Community list node. */
  97   RMAP_NODE,                    /* Route map node. */
  98   SMUX_NODE,                    /* SNMP configuration node. */
  99   DUMP_NODE,                    /* Packet dump node. */
 100   FORWARDING_NODE,              /* IP forwarding node. */
 101   VTY_NODE                      /* Vty node. */
 102 };
 103
 104 /* Node which has some commands and prompt string and configuration
 105    function pointer . */
 106 struct cmd_node
 107 {
 108   /* Node index. */
 109   enum node_type node;
 110
 111   /* Prompt character at vty interface. */
 112   const char *prompt;
 113
 114   /* Is this node's configuration goes to vtysh ? */
 115   int vtysh;
 116
 117   /* Node's configuration write function */
 118   int (*func) (struct vty *);
 119
 120   /* Vector of this node's command list. */
 121   vector cmd_vector;
 122 };
 123
 124 enum
 125 {
 126   CMD_ATTR_DEPRECATED = 1,
 127   CMD_ATTR_HIDDEN,
 128 };
 129
 130 /* Structure of command element. */
 131 struct cmd_element
 132 {
 133   const char *string;                   /* Command specification by string. */
 134   int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
 135   const char *doc;                      /* Documentation of this command. */
 136   int daemon;                   /* Daemon to which this command belong. */
 137   vector strvec;                /* Pointing out each description vector. */
 138   unsigned int cmdsize;         /* Command index count. */
 139   char *config;                 /* Configuration string */
 140   vector subconfig;             /* Sub configuration string */
 141   u_char attr;                  /* Command attributes */
 142 };
 143
 144 /* Command description structure. */
 145 struct desc
 146 {
 147   const char *cmd;                      /* Command string. */
 148   const char *str;                      /* Command's description. */
 149 };
 150
 151 /* Return value of the commands. */
 152 #define CMD_SUCCESS              0
 153 #define CMD_WARNING              1
 154 #define CMD_ERR_NO_MATCH         2
 155 #define CMD_ERR_AMBIGUOUS        3
 156 #define CMD_ERR_INCOMPLETE       4
 157 #define CMD_ERR_EXEED_ARGC_MAX   5
 158 #define CMD_ERR_NOTHING_TODO     6
 159 #define CMD_COMPLETE_FULL_MATCH  7
 160 #define CMD_COMPLETE_MATCH       8
 161 #define CMD_COMPLETE_LIST_MATCH  9
 162 #define CMD_SUCCESS_DAEMON      10
 163
 164 /* Argc max counts. */
 165 #define CMD_ARGC_MAX   25
 166
 167 /* Turn off these macros when uisng cpp with extract.pl */
 168 #ifndef VTYSH_EXTRACT_PL
 169
 170 /* helper defines for end-user DEFUN* macros */
 171 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
 172   struct cmd_element cmdname = \
 173   { \
 174     .string = cmdstr, \
 175     .func = funcname, \
 176     .doc = helpstr, \
 177     .attr = attrs, \
 178     .daemon = dnum, \
 179   };
 180
 181 #define DEFUN_CMD_FUNC_DECL(funcname) \
 182   static int funcname (struct cmd_element *, struct vty *, int, const char *[]);
 183
 184 #define DEFUN_CMD_FUNC_TEXT(funcname) \
 185   static int funcname \
 186     (struct cmd_element *self, struct vty *vty, int argc, const char *argv[])
 187
 188 /* DEFUN for vty command interafce. Little bit hacky ;-). */
 189 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
 190   DEFUN_CMD_FUNC_DECL(funcname) \
 191   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
 192   DEFUN_CMD_FUNC_TEXT(funcname)
 193
 194 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
 195   DEFUN_CMD_FUNC_DECL(funcname) \
 196   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
 197   DEFUN_CMD_FUNC_TEXT(funcname)
 198
 199 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
 200   DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 201
 202 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
 203   DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
 204
 205 /* DEFUN_NOSH for commands that vtysh should ignore */
 206 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
 207   DEFUN(funcname, cmdname, cmdstr, helpstr)
 208
 209 /* DEFSH for vtysh. */
 210 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
 211   DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
 212
 213 /* DEFUN + DEFSH */
 214 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
 215   DEFUN_CMD_FUNC_DECL(funcname) \
 216   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
 217   DEFUN_CMD_FUNC_TEXT(funcname)
 218
 219 /* DEFUN + DEFSH with attributes */
 220 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
 221   DEFUN_CMD_FUNC_DECL(funcname) \
 222   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
 223   DEFUN_CMD_FUNC_TEXT(funcname)
 224
 225 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
 226   DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 227
 228 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
 229   DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
 230
 231 /* ALIAS macro which define existing command's alias. */
 232 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
 233   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
 234
 235 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
 236   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
 237
 238 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
 239   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
 240
 241 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
 242   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
 243
 244 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
 245   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
 246
 247 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
 248   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
 249
 250 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
 251   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
 252
 253 #endif /* VTYSH_EXTRACT_PL */
 254
 255 /* Some macroes */
 256 #define CMD_OPTION(S)   ((S[0]) == '[')
 257 #define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<'))
 258 #define CMD_VARARG(S)   ((S[0]) == '.')
 259 #define CMD_RANGE(S)    ((S[0] == '<'))
 260
 261 #define CMD_IPV4(S)        ((strcmp ((S), "A.B.C.D") == 0))
 262 #define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0))
 263 #define CMD_IPV6(S)        ((strcmp ((S), "X:X::X:X") == 0))
 264 #define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0))
 265
 266 /* Common descriptions. */
 267 #define SHOW_STR "Show running system information\n"
 268 #define IP_STR "IP information\n"
 269 #define IPV6_STR "IPv6 information\n"
 270 #define NO_STR "Negate a command or set its defaults\n"
 271 #define CLEAR_STR "Reset functions\n"
 272 #define RIP_STR "RIP information\n"
 273 #define BGP_STR "BGP information\n"
 274 #define OSPF_STR "OSPF information\n"
 275 #define NEIGHBOR_STR "Specify neighbor router\n"
 276 #define DEBUG_STR "Debugging functions (see also 'undebug')\n"
 277 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
 278 #define ROUTER_STR "Enable a routing process\n"
 279 #define AS_STR "AS number\n"
 280 #define MBGP_STR "MBGP information\n"
 281 #define MATCH_STR "Match values from routing table\n"
 282 #define SET_STR "Set values in destination routing protocol\n"
 283 #define OUT_STR "Filter outgoing routing updates\n"
 284 #define IN_STR  "Filter incoming routing updates\n"
 285 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
 286 #define OSPF6_NUMBER_STR "Specify by number\n"
 287 #define INTERFACE_STR "Interface infomation\n"
 288 #define IFNAME_STR "Interface name(e.g. ep0)\n"
 289 #define IP6_STR "IPv6 Information\n"
 290 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
 291 #define OSPF6_ROUTER_STR "Enable a routing process\n"
 292 #define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
 293 #define SECONDS_STR "<1-65535> Seconds\n"
 294 #define ROUTE_STR "Routing Table\n"
 295 #define PREFIX_LIST_STR "Build a prefix list\n"
 296 #define OSPF6_DUMP_TYPE_LIST \
 297 "(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
 298 #define ISIS_STR "IS-IS information\n"
 299 #define AREA_TAG_STR "[area tag]\n"
 300
 301 #define CONF_BACKUP_EXT ".sav"
 302
 303 /* IPv4 only machine should not accept IPv6 address for peer's IP
 304    address.  So we replace VTY command string like below. */
 305 #ifdef HAVE_IPV6
 306 #define NEIGHBOR_CMD       "neighbor (A.B.C.D|X:X::X:X) "
 307 #define NO_NEIGHBOR_CMD    "no neighbor (A.B.C.D|X:X::X:X) "
 308 #define NEIGHBOR_ADDR_STR  "Neighbor address\nIPv6 address\n"
 309 #define NEIGHBOR_CMD2      "neighbor (A.B.C.D|X:X::X:X|WORD) "
 310 #define NO_NEIGHBOR_CMD2   "no neighbor (A.B.C.D|X:X::X:X|WORD) "
 311 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n"
 312 #else
 313 #define NEIGHBOR_CMD       "neighbor A.B.C.D "
 314 #define NO_NEIGHBOR_CMD    "no neighbor A.B.C.D "
 315 #define NEIGHBOR_ADDR_STR  "Neighbor address\n"
 316 #define NEIGHBOR_CMD2      "neighbor (A.B.C.D|WORD) "
 317 #define NO_NEIGHBOR_CMD2   "no neighbor (A.B.C.D|WORD) "
 318 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
 319 #endif /* HAVE_IPV6 */
 320
 321 /* Prototypes. */
 322 extern void install_node (struct cmd_node *, int (*) (struct vty *));
 323 extern void install_default (enum node_type);
 324 extern void install_element (enum node_type, struct cmd_element *);
 325 extern void sort_node (void);
 326
 327 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
 328    string with a space between each element (allocated using
 329    XMALLOC(MTYPE_TMP)).  Returns NULL if shift >= argc. */
 330 extern char *argv_concat (const char **argv, int argc, int shift);
 331
 332 extern vector cmd_make_strvec (const char *);
 333 extern void cmd_free_strvec (vector);
 334 extern vector cmd_describe_command (vector, struct vty *, int *status);
 335 extern char **cmd_complete_command (vector, struct vty *, int *status);
 336 extern const char *cmd_prompt (enum node_type);
 337 extern int config_from_file (struct vty *, FILE *);
 338 extern enum node_type node_parent (enum node_type);
 339 extern int cmd_execute_command (vector, struct vty *, struct cmd_element **, int);
 340 extern int cmd_execute_command_strict (vector, struct vty *, struct cmd_element **);
 341 extern void config_replace_string (struct cmd_element *, char *, ...);
 342 extern void cmd_init (int);
 343
 344 /* Export typical functions. */
 345 extern struct cmd_element config_end_cmd;
 346 extern struct cmd_element config_exit_cmd;
 347 extern struct cmd_element config_quit_cmd;
 348 extern struct cmd_element config_help_cmd;
 349 extern struct cmd_element config_list_cmd;
 350 extern char *host_config_file (void);
 351 extern void host_config_set (char *);
 352
 353 extern void print_version (const char *);
 354
 355 #endif /* _ZEBRA_COMMAND_H */