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