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