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