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 along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_COMMAND_H
  23 #define _ZEBRA_COMMAND_H
  24
  25 #include "vector.h"
  26 #include "vty.h"
  27 #include "lib/route_types.h"
  28 #include "graph.h"
  29 #include "memory.h"
  30 #include "hash.h"
  31 #include "command_graph.h"
  32
  33 DECLARE_MTYPE(HOST)
  34 DECLARE_MTYPE(COMPLETION)
  35
  36 /* for test-commands.c */
  37 DECLARE_MTYPE(STRVEC)
  38
  39 /* Host configuration variable */
  40 struct host {
  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 /* List of CLI nodes. Please remember to update the names array below. */
  72 enum node_type {
  73         AUTH_NODE,              /* Authentication mode of vty interface. */
  74         VIEW_NODE,              /* View node. Default mode of vty interface. */
  75         AUTH_ENABLE_NODE,       /* Authentication mode for change enable. */
  76         ENABLE_NODE,            /* Enable node. */
  77         CONFIG_NODE,            /* Config node. Default mode of config file. */
  78         SERVICE_NODE,           /* Service node. */
  79         DEBUG_NODE,             /* Debug node. */
  80         VRF_DEBUG_NODE,         /* Vrf Debug node. */
  81         DEBUG_VNC_NODE,         /* Debug VNC node. */
  82         AAA_NODE,               /* AAA node. */
  83         KEYCHAIN_NODE,          /* Key-chain node. */
  84         KEYCHAIN_KEY_NODE,      /* Key-chain key node. */
  85         NS_NODE,                /* Logical-Router node. */
  86         VRF_NODE,               /* VRF mode node. */
  87         INTERFACE_NODE,         /* Interface mode node. */
  88         ZEBRA_NODE,             /* zebra connection node. */
  89         TABLE_NODE,             /* rtm_table selection node. */
  90         RIP_NODE,               /* RIP protocol mode node. */
  91         RIPNG_NODE,             /* RIPng protocol mode node. */
  92         BABEL_NODE,             /* BABEL protocol mode node. */
  93         EIGRP_NODE,             /* EIGRP protocol mode node. */
  94         BGP_NODE,               /* BGP protocol mode which includes BGP4+ */
  95         BGP_VPNV4_NODE,         /* BGP MPLS-VPN PE exchange. */
  96         BGP_VPNV6_NODE,         /* BGP MPLS-VPN PE exchange. */
  97         BGP_IPV4_NODE,          /* BGP IPv4 unicast address family.  */
  98         BGP_IPV4M_NODE,         /* BGP IPv4 multicast address family.  */
  99         BGP_IPV4L_NODE,         /* BGP IPv4 labeled unicast address family.  */
 100         BGP_IPV6_NODE,          /* BGP IPv6 address family */
 101         BGP_IPV6M_NODE,         /* BGP IPv6 multicast address family. */
 102         BGP_IPV6L_NODE,         /* BGP IPv6 labeled unicast address family. */
 103         BGP_VRF_POLICY_NODE,    /* BGP VRF policy */
 104         BGP_VNC_DEFAULTS_NODE,  /* BGP VNC nve defaults */
 105         BGP_VNC_NVE_GROUP_NODE, /* BGP VNC nve group */
 106         BGP_VNC_L2_GROUP_NODE,  /* BGP VNC L2 group */
 107         RFP_DEFAULTS_NODE,      /* RFP defaults node */
 108         BGP_EVPN_NODE,          /* BGP EVPN node. */
 109         OSPF_NODE,              /* OSPF protocol mode */
 110         OSPF6_NODE,             /* OSPF protocol for IPv6 mode */
 111         LDP_NODE,               /* LDP protocol mode */
 112         LDP_IPV4_NODE,          /* LDP IPv4 address family */
 113         LDP_IPV6_NODE,          /* LDP IPv6 address family */
 114         LDP_IPV4_IFACE_NODE,    /* LDP IPv4 Interface */
 115         LDP_IPV6_IFACE_NODE,    /* LDP IPv6 Interface */
 116         LDP_L2VPN_NODE,         /* LDP L2VPN node */
 117         LDP_PSEUDOWIRE_NODE,    /* LDP Pseudowire node */
 118         ISIS_NODE,              /* ISIS protocol mode */
 119         PIM_NODE,               /* PIM protocol mode */
 120         MASC_NODE,              /* MASC for multicast.  */
 121         IRDP_NODE,              /* ICMP Router Discovery Protocol mode. */
 122         IP_NODE,                /* Static ip route node. */
 123         ACCESS_NODE,            /* Access list node. */
 124         PREFIX_NODE,            /* Prefix list node. */
 125         ACCESS_IPV6_NODE,       /* Access list node. */
 126         PREFIX_IPV6_NODE,       /* Prefix list node. */
 127         AS_LIST_NODE,           /* AS list node. */
 128         COMMUNITY_LIST_NODE,    /* Community list node. */
 129         RMAP_NODE,              /* Route map node. */
 130         SMUX_NODE,              /* SNMP configuration node. */
 131         DUMP_NODE,              /* Packet dump node. */
 132         FORWARDING_NODE,        /* IP forwarding node. */
 133         PROTOCOL_NODE,          /* protocol filtering node */
 134         MPLS_NODE,              /* MPLS config node */
 135         VTY_NODE,               /* Vty node. */
 136         LINK_PARAMS_NODE,       /* Link-parameters node */
 137         BGP_EVPN_VNI_NODE,      /* BGP EVPN VNI */
 138         NODE_TYPE_MAX,          /* maximum */
 139 };
 140
 141 extern const char *node_names[];
 142
 143 /* Node which has some commands and prompt string and configuration
 144    function pointer . */
 145 struct cmd_node {
 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 /* Return value of the commands. */
 169 #define CMD_SUCCESS              0
 170 #define CMD_WARNING              1
 171 #define CMD_ERR_NO_MATCH         2
 172 #define CMD_ERR_AMBIGUOUS        3
 173 #define CMD_ERR_INCOMPLETE       4
 174 #define CMD_ERR_EXEED_ARGC_MAX   5
 175 #define CMD_ERR_NOTHING_TODO     6
 176 #define CMD_COMPLETE_FULL_MATCH  7
 177 #define CMD_COMPLETE_MATCH       8
 178 #define CMD_COMPLETE_LIST_MATCH  9
 179 #define CMD_SUCCESS_DAEMON      10
 180 #define CMD_ERR_NO_FILE         11
 181 #define CMD_SUSPEND             12
 182 #define CMD_WARNING_CONFIG_FAILED 13
 183
 184 /* Argc max counts. */
 185 #define CMD_ARGC_MAX   25
 186
 187 /* Turn off these macros when uisng cpp with extract.pl */
 188 #ifndef VTYSH_EXTRACT_PL
 189
 190 /* helper defines for end-user DEFUN* macros */
 191 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum)     \
 192         static struct cmd_element cmdname = {                                  \
 193                 .string = cmdstr,                                              \
 194                 .func = funcname,                                              \
 195                 .doc = helpstr,                                                \
 196                 .attr = attrs,                                                 \
 197                 .daemon = dnum,                                                \
 198                 .name = #cmdname,                                              \
 199         };
 200
 201 #define DEFUN_CMD_FUNC_DECL(funcname)                                          \
 202         static int funcname(const struct cmd_element *, struct vty *, int,     \
 203                             struct cmd_token *[]);
 204
 205 #define DEFUN_CMD_FUNC_TEXT(funcname)                                          \
 206         static int funcname(const struct cmd_element *self                     \
 207                             __attribute__((unused)),                           \
 208                             struct vty *vty __attribute__((unused)),           \
 209                             int argc __attribute__((unused)),                  \
 210                             struct cmd_token *argv[] __attribute__((unused)))
 211
 212 #define DEFPY(funcname, cmdname, cmdstr, helpstr)                              \
 213         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)            \
 214         funcdecl_##funcname
 215
 216 #define DEFUN(funcname, cmdname, cmdstr, helpstr)                              \
 217         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 218         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)            \
 219         DEFUN_CMD_FUNC_TEXT(funcname)
 220
 221 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
 222         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 223         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)         \
 224         DEFUN_CMD_FUNC_TEXT(funcname)
 225
 226 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
 227         DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 228
 229 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr)                   \
 230         DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
 231
 232 /* DEFUN_NOSH for commands that vtysh should ignore */
 233 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr)                         \
 234         DEFUN(funcname, cmdname, cmdstr, helpstr)
 235
 236 /* DEFSH for vtysh. */
 237 #define DEFSH(daemon, cmdname, cmdstr, helpstr)                                \
 238         DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
 239
 240 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr)                         \
 241         DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN,     \
 242                           daemon)
 243
 244 /* DEFUN + DEFSH */
 245 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr)                    \
 246         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 247         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)       \
 248         DEFUN_CMD_FUNC_TEXT(funcname)
 249
 250 /* DEFUN + DEFSH with attributes */
 251 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr)         \
 252         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 253         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon)    \
 254         DEFUN_CMD_FUNC_TEXT(funcname)
 255
 256 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr)             \
 257         DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr,               \
 258                      CMD_ATTR_HIDDEN)
 259
 260 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr)         \
 261         DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr,               \
 262                      CMD_ATTR_DEPRECATED)
 263
 264 /* ALIAS macro which define existing command's alias. */
 265 #define ALIAS(funcname, cmdname, cmdstr, helpstr)                              \
 266         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
 267
 268 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
 269         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
 270
 271 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
 272         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
 273                           0)
 274
 275 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr)                   \
 276         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr,                  \
 277                           CMD_ATTR_DEPRECATED, 0)
 278
 279 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr)                   \
 280         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
 281
 282 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr)            \
 283         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
 284                           daemon)
 285
 286 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr)        \
 287         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr,                  \
 288                           CMD_ATTR_DEPRECATED, daemon)
 289
 290 #else /* VTYSH_EXTRACT_PL */
 291 #define DEFPY(funcname, cmdname, cmdstr, helpstr)                              \
 292         DEFUN(funcname, cmdname, cmdstr, helpstr)
 293 #endif /* VTYSH_EXTRACT_PL */
 294
 295 /* Some macroes */
 296
 297 /*
 298  * Sometimes #defines create maximum values that
 299  * need to have strings created from them that
 300  * allow the parser to match against them.
 301  * These macros allow that.
 302  */
 303 #define CMD_CREATE_STR(s)  CMD_CREATE_STR_HELPER(s)
 304 #define CMD_CREATE_STR_HELPER(s) #s
 305 #define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
 306
 307 /* Common descriptions. */
 308 #define SHOW_STR "Show running system information\n"
 309 #define IP_STR "IP information\n"
 310 #define IPV6_STR "IPv6 information\n"
 311 #define NO_STR "Negate a command or set its defaults\n"
 312 #define REDIST_STR "Redistribute information from another routing protocol\n"
 313 #define CLEAR_STR "Reset functions\n"
 314 #define RIP_STR "RIP information\n"
 315 #define EIGRP_STR "EIGRP information\n"
 316 #define BGP_STR "BGP information\n"
 317 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
 318 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
 319 #define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
 320 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
 321 #define OSPF_STR "OSPF information\n"
 322 #define NEIGHBOR_STR "Specify neighbor router\n"
 323 #define DEBUG_STR "Debugging functions (see also 'undebug')\n"
 324 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
 325 #define ROUTER_STR "Enable a routing process\n"
 326 #define AS_STR "AS number\n"
 327 #define MBGP_STR "MBGP information\n"
 328 #define MATCH_STR "Match values from routing table\n"
 329 #define SET_STR "Set values in destination routing protocol\n"
 330 #define OUT_STR "Filter outgoing routing updates\n"
 331 #define IN_STR  "Filter incoming routing updates\n"
 332 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
 333 #define OSPF6_NUMBER_STR "Specify by number\n"
 334 #define INTERFACE_STR "Interface infomation\n"
 335 #define IFNAME_STR "Interface name(e.g. ep0)\n"
 336 #define IP6_STR "IPv6 Information\n"
 337 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
 338 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
 339 #define SECONDS_STR "Seconds\n"
 340 #define ROUTE_STR "Routing Table\n"
 341 #define PREFIX_LIST_STR "Build a prefix list\n"
 342 #define OSPF6_DUMP_TYPE_LIST                                                   \
 343         "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
 344 #define ISIS_STR "IS-IS information\n"
 345 #define AREA_TAG_STR "[area tag]\n"
 346 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
 347 #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"
 348 #define MPLS_TE_STR "MPLS-TE specific commands\n"
 349 #define LINK_PARAMS_STR "Configure interface link parameters\n"
 350 #define OSPF_RI_STR "OSPF Router Information specific commands\n"
 351 #define PCE_STR "PCE Router Information specific commands\n"
 352 #define MPLS_STR "MPLS information\n"
 353
 354 #define CONF_BACKUP_EXT ".sav"
 355
 356 /* IPv4 only machine should not accept IPv6 address for peer's IP
 357    address.  So we replace VTY command string like below. */
 358 #define NEIGHBOR_ADDR_STR  "Neighbor address\nIPv6 address\n"
 359 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
 360 #define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
 361
 362 /* Prototypes. */
 363 extern void install_node(struct cmd_node *, int (*)(struct vty *));
 364 extern void install_default(enum node_type);
 365 extern void install_element(enum node_type, struct cmd_element *);
 366
 367 /* known issue with uninstall_element:  changes to cmd_token->attr (i.e.
 368  * deprecated/hidden) are not reversed. */
 369 extern void uninstall_element(enum node_type, struct cmd_element *);
 370
 371 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
 372    string with a space between each element (allocated using
 373    XMALLOC(MTYPE_TMP)).  Returns NULL if shift >= argc. */
 374 extern char *argv_concat(struct cmd_token **argv, int argc, int shift);
 375 extern int argv_find(struct cmd_token **argv, int argc, const char *text,
 376                      int *index);
 377
 378 extern vector cmd_make_strvec(const char *);
 379 extern void cmd_free_strvec(vector);
 380 extern vector cmd_describe_command(vector, struct vty *, int *status);
 381 extern char **cmd_complete_command(vector, struct vty *, int *status);
 382 extern const char *cmd_prompt(enum node_type);
 383 extern int command_config_read_one_line(struct vty *vty,
 384                                         const struct cmd_element **,
 385                                         int use_config_node);
 386 extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
 387 extern enum node_type node_parent(enum node_type);
 388 extern int cmd_execute_command(vector, struct vty *,
 389                                const struct cmd_element **, int);
 390 extern int cmd_execute_command_strict(vector, struct vty *,
 391                                       const struct cmd_element **);
 392 extern void cmd_init(int);
 393 extern void cmd_terminate(void);
 394 extern void cmd_exit(struct vty *vty);
 395 extern int cmd_list_cmds(struct vty *vty, int do_permute);
 396
 397 extern int cmd_hostname_set(const char *hostname);
 398
 399 /* NOT safe for general use; call this only if DEV_BUILD! */
 400 extern void grammar_sandbox_init(void);
 401
 402 extern vector completions_to_vec(struct list *completions);
 403
 404 /* Export typical functions. */
 405 extern const char *host_config_get(void);
 406 extern void host_config_set(const char *);
 407
 408 extern void print_version(const char *);
 409
 410 extern int cmd_banner_motd_file(const char *);
 411
 412 /* struct host global, ick */
 413 extern struct host host;
 414
 415 struct cmd_variable_handler {
 416         const char *tokenname, *varname;
 417         void (*completions)(vector out, struct cmd_token *token);
 418 };
 419
 420 extern void cmd_variable_complete(struct cmd_token *token, const char *arg,
 421                                   vector comps);
 422 extern void
 423 cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
 424 extern char *cmd_variable_comp2str(vector comps, unsigned short cols);
 425
 426 #endif /* _ZEBRA_COMMAND_H */