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 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 DECLARE_MTYPE(COMPLETION);
  38
  39 /*
  40  * From RFC 1123 (Requirements for Internet Hosts), Section 2.1 on hostnames:
  41  * One aspect of host name syntax is hereby changed: the restriction on
  42  * the first character is relaxed to allow either a letter or a digit.
  43  * Host software MUST support this more liberal syntax.
  44  *
  45  * Host software MUST handle host names of up to 63 characters and
  46  * SHOULD handle host names of up to 255 characters.
  47  */
  48 #define HOSTNAME_LEN   255
  49
  50 /* Host configuration variable */
  51 struct host {
  52         /* Host name of this router. */
  53         char *name;
  54
  55         /* Domainname of this router */
  56         char *domainname;
  57
  58         /*
  59          * Some extra system data that is useful
  60          */
  61         char *system;
  62         char *release;
  63         char *version;
  64
  65         /* Password for vty interface. */
  66         char *password;
  67         char *password_encrypt;
  68
  69         /* Enable password */
  70         char *enable;
  71         char *enable_encrypt;
  72
  73         /* System wide terminal lines. */
  74         int lines;
  75
  76         /* config file name of this host */
  77         char *config;
  78         int noconfig;
  79
  80         /* Flags for services */
  81         int advanced;
  82         int encrypt;
  83
  84         /* Banner configuration. */
  85         char *motd;
  86         char *motdfile;
  87 };
  88
  89 /* List of CLI nodes. Please remember to update the name array in command.c. */
  90 enum node_type {
  91         AUTH_NODE,               /* Authentication mode of vty interface. */
  92         VIEW_NODE,               /* View node. Default mode of vty interface. */
  93         AUTH_ENABLE_NODE,       /* Authentication mode for change enable. */
  94         ENABLE_NODE,             /* Enable node. */
  95         CONFIG_NODE,             /* Config node. Default mode of config file. */
  96         DEBUG_NODE,              /* Debug node. */
  97         VRF_DEBUG_NODE,          /* Vrf Debug node. */
  98         NORTHBOUND_DEBUG_NODE,   /* Northbound Debug node. */
  99         DEBUG_VNC_NODE,          /* Debug VNC node. */
 100         RMAP_DEBUG_NODE,         /* Route-map debug node */
 101         RESOLVER_DEBUG_NODE,     /* Resolver debug node */
 102         AAA_NODE,                /* AAA node. */
 103         KEYCHAIN_NODE,           /* Key-chain node. */
 104         KEYCHAIN_KEY_NODE,       /* Key-chain key node. */
 105         IP_NODE,                 /* Static ip route node. */
 106         VRF_NODE,                /* VRF mode node. */
 107         INTERFACE_NODE,          /* Interface mode node. */
 108         NH_GROUP_NODE,           /* Nexthop-Group mode node. */
 109         ZEBRA_NODE,              /* zebra connection node. */
 110         TABLE_NODE,              /* rtm_table selection node. */
 111         RIP_NODE,                /* RIP protocol mode node. */
 112         RIPNG_NODE,              /* RIPng protocol mode node. */
 113         BABEL_NODE,              /* BABEL protocol mode node. */
 114         EIGRP_NODE,              /* EIGRP protocol mode node. */
 115         BGP_NODE,                /* BGP protocol mode which includes BGP4+ */
 116         BGP_VPNV4_NODE,          /* BGP MPLS-VPN PE exchange. */
 117         BGP_VPNV6_NODE,          /* BGP MPLS-VPN PE exchange. */
 118         BGP_IPV4_NODE,           /* BGP IPv4 unicast address family.  */
 119         BGP_IPV4M_NODE,          /* BGP IPv4 multicast address family.  */
 120         BGP_IPV4L_NODE,          /* BGP IPv4 labeled unicast address family.  */
 121         BGP_IPV6_NODE,           /* BGP IPv6 address family */
 122         BGP_IPV6M_NODE,          /* BGP IPv6 multicast address family. */
 123         BGP_IPV6L_NODE,          /* BGP IPv6 labeled unicast address family. */
 124         BGP_VRF_POLICY_NODE,     /* BGP VRF policy */
 125         BGP_VNC_DEFAULTS_NODE,   /* BGP VNC nve defaults */
 126         BGP_VNC_NVE_GROUP_NODE,  /* BGP VNC nve group */
 127         BGP_VNC_L2_GROUP_NODE,   /* BGP VNC L2 group */
 128         RFP_DEFAULTS_NODE,       /* RFP defaults node */
 129         BGP_EVPN_NODE,           /* BGP EVPN node. */
 130         BGP_SRV6_NODE,           /* BGP SRv6 node. */
 131         OSPF_NODE,               /* OSPF protocol mode */
 132         OSPF6_NODE,              /* OSPF protocol for IPv6 mode */
 133         LDP_NODE,                /* LDP protocol mode */
 134         LDP_IPV4_NODE,           /* LDP IPv4 address family */
 135         LDP_IPV6_NODE,           /* LDP IPv6 address family */
 136         LDP_IPV4_IFACE_NODE,     /* LDP IPv4 Interface */
 137         LDP_IPV6_IFACE_NODE,     /* LDP IPv6 Interface */
 138         LDP_L2VPN_NODE,          /* LDP L2VPN node */
 139         LDP_PSEUDOWIRE_NODE,     /* LDP Pseudowire node */
 140         ISIS_NODE,               /* ISIS protocol mode */
 141         ACCESS_NODE,             /* Access list node. */
 142         PREFIX_NODE,             /* Prefix list node. */
 143         ACCESS_IPV6_NODE,       /* Access list node. */
 144         ACCESS_MAC_NODE,         /* MAC access list node*/
 145         PREFIX_IPV6_NODE,       /* Prefix list node. */
 146         AS_LIST_NODE,            /* AS list node. */
 147         COMMUNITY_LIST_NODE,     /* Community list node. */
 148         COMMUNITY_ALIAS_NODE, /* Community alias node. */
 149         RMAP_NODE,               /* Route map node. */
 150         PBRMAP_NODE,             /* PBR map node. */
 151         SMUX_NODE,               /* SNMP configuration node. */
 152         DUMP_NODE,               /* Packet dump node. */
 153         FORWARDING_NODE,         /* IP forwarding node. */
 154         PROTOCOL_NODE,           /* protocol filtering node */
 155         MPLS_NODE,               /* MPLS config node */
 156         PW_NODE,                 /* Pseudowire config node */
 157         SEGMENT_ROUTING_NODE,    /* Segment routing root node */
 158         SR_TRAFFIC_ENG_NODE,     /* SR Traffic Engineering node */
 159         SR_SEGMENT_LIST_NODE,    /* SR segment list config node */
 160         SR_POLICY_NODE,          /* SR policy config node */
 161         SR_CANDIDATE_DYN_NODE,   /* SR dynamic candidate path config node */
 162         PCEP_NODE,               /* PCEP node */
 163         PCEP_PCE_CONFIG_NODE,    /* PCE shared configuration node */
 164         PCEP_PCE_NODE,           /* PCE configuration node */
 165         PCEP_PCC_NODE,           /* PCC configuration node */
 166         SRV6_NODE,               /* SRv6 node */
 167         SRV6_LOCS_NODE,          /* SRv6 locators node */
 168         SRV6_LOC_NODE,           /* SRv6 locator node */
 169         VTY_NODE,                /* Vty node. */
 170         FPM_NODE,                /* Dataplane FPM node. */
 171         LINK_PARAMS_NODE,       /* Link-parameters node */
 172         BGP_EVPN_VNI_NODE,       /* BGP EVPN VNI */
 173         RPKI_NODE,     /* RPKI node for configuration of RPKI cache server
 174                           connections.*/
 175         BGP_FLOWSPECV4_NODE,    /* BGP IPv4 FLOWSPEC Address-Family */
 176         BGP_FLOWSPECV6_NODE,    /* BGP IPv6 FLOWSPEC Address-Family */
 177         BFD_NODE,                /* BFD protocol mode. */
 178         BFD_PEER_NODE,           /* BFD peer configuration mode. */
 179         BFD_PROFILE_NODE,        /* BFD profile configuration mode. */
 180         OPENFABRIC_NODE,        /* OpenFabric router configuration node */
 181         VRRP_NODE,               /* VRRP node */
 182         BMP_NODE,               /* BMP config under router bgp */
 183         NODE_TYPE_MAX, /* maximum */
 184 };
 185
 186 extern vector cmdvec;
 187 extern const struct message tokennames[];
 188
 189 /* for external users depending on struct layout */
 190 #define FRR_CMD_NODE_20200416
 191
 192 /* Node which has some commands and prompt string and configuration
 193    function pointer . */
 194 struct cmd_node {
 195         const char *name;
 196
 197         /* Node index. */
 198         enum node_type node;
 199         enum node_type parent_node;
 200
 201         /* Prompt character at vty interface. */
 202         const char *prompt;
 203
 204         /* Node's configuration write function */
 205         int (*config_write)(struct vty *);
 206
 207         /* called when leaving the node on a VTY session.
 208          * return 1 if normal exit processing should happen, 0 to suppress
 209          */
 210         int (*node_exit)(struct vty *);
 211
 212         /* Node's command graph */
 213         struct graph *cmdgraph;
 214
 215         /* Vector of this node's command list. */
 216         vector cmd_vector;
 217
 218         /* Hashed index of command node list, for de-dupping primarily */
 219         struct hash *cmd_hash;
 220
 221         /* set as soon as any command is in cmdgraph */
 222         bool graph_built;
 223
 224         /* don't decrement vty->xpath_index on leaving this node */
 225         bool no_xpath;
 226 };
 227
 228 /* Return value of the commands. */
 229 #define CMD_SUCCESS              0
 230 #define CMD_WARNING              1
 231 #define CMD_ERR_NO_MATCH         2
 232 #define CMD_ERR_AMBIGUOUS        3
 233 #define CMD_ERR_INCOMPLETE       4
 234 #define CMD_ERR_EXEED_ARGC_MAX   5
 235 #define CMD_ERR_NOTHING_TODO     6
 236 #define CMD_COMPLETE_FULL_MATCH  7
 237 #define CMD_COMPLETE_MATCH       8
 238 #define CMD_COMPLETE_LIST_MATCH  9
 239 #define CMD_SUCCESS_DAEMON      10
 240 #define CMD_ERR_NO_FILE         11
 241 #define CMD_SUSPEND             12
 242 #define CMD_WARNING_CONFIG_FAILED 13
 243 #define CMD_NOT_MY_INSTANCE     14
 244 #define CMD_NO_LEVEL_UP 15
 245 #define CMD_ERR_NO_DAEMON 16
 246
 247 /* Argc max counts. */
 248 #define CMD_ARGC_MAX   256
 249
 250 /* Turn off these macros when using cpp with extract.pl */
 251 #ifndef VTYSH_EXTRACT_PL
 252
 253 /* helper defines for end-user DEFUN* macros */
 254 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum)     \
 255         static const struct cmd_element cmdname = {                            \
 256                 .string = cmdstr,                                              \
 257                 .func = funcname,                                              \
 258                 .doc = helpstr,                                                \
 259                 .attr = attrs,                                                 \
 260                 .daemon = dnum,                                                \
 261                 .name = #cmdname,                                              \
 262                 .xref = XREF_INIT(XREFT_DEFUN, NULL, #funcname),               \
 263         };                                                                     \
 264         XREF_LINK(cmdname.xref);                                               \
 265         /* end */
 266
 267
 268 #define DEFUN_CMD_FUNC_DECL(funcname)                                          \
 269         static int funcname(const struct cmd_element *, struct vty *, int,     \
 270                             struct cmd_token *[]);
 271
 272 #define DEFUN_CMD_FUNC_TEXT(funcname)                                          \
 273         static int funcname(const struct cmd_element *self                     \
 274                             __attribute__((unused)),                           \
 275                             struct vty *vty __attribute__((unused)),           \
 276                             int argc __attribute__((unused)),                  \
 277                             struct cmd_token *argv[] __attribute__((unused)))
 278
 279 #define DEFPY(funcname, cmdname, cmdstr, helpstr)                              \
 280         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)            \
 281         funcdecl_##funcname
 282
 283 #define DEFPY_NOSH(funcname, cmdname, cmdstr, helpstr)                         \
 284         DEFPY(funcname, cmdname, cmdstr, helpstr)
 285
 286 #define DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
 287         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)         \
 288         funcdecl_##funcname
 289
 290 #define DEFPY_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
 291         DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 292
 293 #define DEFPY_YANG(funcname, cmdname, cmdstr, helpstr)                         \
 294         DEFPY_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
 295
 296 #define DEFPY_YANG_NOSH(funcname, cmdname, cmdstr, helpstr)                    \
 297         DEFPY_YANG(funcname, cmdname, cmdstr, helpstr)
 298
 299 #define DEFUN(funcname, cmdname, cmdstr, helpstr)                              \
 300         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 301         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)            \
 302         DEFUN_CMD_FUNC_TEXT(funcname)
 303
 304 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
 305         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 306         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)         \
 307         DEFUN_CMD_FUNC_TEXT(funcname)
 308
 309 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
 310         DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 311
 312 #define DEFUN_YANG(funcname, cmdname, cmdstr, helpstr)                         \
 313         DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
 314
 315 /* DEFUN_NOSH for commands that vtysh should ignore */
 316 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr)                         \
 317         DEFUN(funcname, cmdname, cmdstr, helpstr)
 318
 319 #define DEFUN_YANG_NOSH(funcname, cmdname, cmdstr, helpstr)                    \
 320         DEFUN_YANG(funcname, cmdname, cmdstr, helpstr)
 321
 322 /* DEFSH for vtysh. */
 323 #define DEFSH(daemon, cmdname, cmdstr, helpstr)                                \
 324         DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon)
 325
 326 #define DEFSH_HIDDEN(daemon, cmdname, cmdstr, helpstr)                         \
 327         DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN,     \
 328                           daemon)
 329
 330 #define DEFSH_YANG(daemon, cmdname, cmdstr, helpstr)                           \
 331         DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, daemon)
 332
 333 /* DEFUN + DEFSH */
 334 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr)                    \
 335         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 336         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)       \
 337         DEFUN_CMD_FUNC_TEXT(funcname)
 338
 339 /* DEFUN + DEFSH with attributes */
 340 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr)         \
 341         DEFUN_CMD_FUNC_DECL(funcname)                                          \
 342         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon)    \
 343         DEFUN_CMD_FUNC_TEXT(funcname)
 344
 345 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr)             \
 346         DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr,               \
 347                      CMD_ATTR_HIDDEN)
 348
 349 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr)         \
 350         DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr,               \
 351                      CMD_ATTR_DEPRECATED)
 352
 353 #define DEFUNSH_YANG(daemon, funcname, cmdname, cmdstr, helpstr)               \
 354         DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG)
 355
 356 /* ALIAS macro which define existing command's alias. */
 357 #define ALIAS(funcname, cmdname, cmdstr, helpstr)                              \
 358         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
 359
 360 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr)                   \
 361         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
 362
 363 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr)                       \
 364         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
 365                           0)
 366
 367 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr)                   \
 368         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr,                  \
 369                           CMD_ATTR_DEPRECATED, 0)
 370
 371 #define ALIAS_YANG(funcname, cmdname, cmdstr, helpstr)                         \
 372         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_YANG, 0)
 373
 374 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr)                   \
 375         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
 376
 377 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr)            \
 378         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, \
 379                           daemon)
 380
 381 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr)        \
 382         DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr,                  \
 383                           CMD_ATTR_DEPRECATED, daemon)
 384
 385 #endif /* VTYSH_EXTRACT_PL */
 386
 387 /* Some macroes */
 388
 389 /*
 390  * Sometimes #defines create maximum values that
 391  * need to have strings created from them that
 392  * allow the parser to match against them.
 393  * These macros allow that.
 394  */
 395 #define CMD_CREATE_STR(s)  CMD_CREATE_STR_HELPER(s)
 396 #define CMD_CREATE_STR_HELPER(s) #s
 397 #define CMD_RANGE_STR(a,s) "(" CMD_CREATE_STR(a) "-" CMD_CREATE_STR(s) ")"
 398
 399 /* Common descriptions. */
 400 #define SHOW_STR "Show running system information\n"
 401 #define IP_STR "IP information\n"
 402 #define IPV6_STR "IPv6 information\n"
 403 #define SRTE_STR "SR-TE information\n"
 404 #define SRTE_COLOR_STR "SR-TE Color information\n"
 405 #define NO_STR "Negate a command or set its defaults\n"
 406 #define IGNORED_IN_NO_STR "Ignored value in no form\n"
 407 #define REDIST_STR "Redistribute information from another routing protocol\n"
 408 #define CLEAR_STR "Reset functions\n"
 409 #define RIP_STR "RIP information\n"
 410 #define EIGRP_STR "EIGRP information\n"
 411 #define BGP_STR "BGP information\n"
 412 #define BGP_SOFT_STR "Soft reconfig inbound and outbound updates\n"
 413 #define BGP_SOFT_IN_STR "Send route-refresh unless using 'soft-reconfiguration inbound'\n"
 414 #define BGP_SOFT_OUT_STR "Resend all outbound updates\n"
 415 #define BGP_SOFT_RSCLIENT_RIB_STR "Soft reconfig for rsclient RIB\n"
 416 #define OSPF_STR "OSPF information\n"
 417 #define NEIGHBOR_STR "Specify neighbor router\n"
 418 #define DEBUG_STR "Debugging functions\n"
 419 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
 420 #define ROUTER_STR "Enable a routing process\n"
 421 #define AS_STR "AS number\n"
 422 #define MAC_STR "MAC address\n"
 423 #define MBGP_STR "MBGP information\n"
 424 #define MATCH_STR "Match values from routing table\n"
 425 #define SET_STR "Set values in destination routing protocol\n"
 426 #define OUT_STR "Filter outgoing routing updates\n"
 427 #define IN_STR  "Filter incoming routing updates\n"
 428 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
 429 #define OSPF6_NUMBER_STR "Specify by number\n"
 430 #define INTERFACE_STR "Interface information\n"
 431 #define IFNAME_STR "Interface name(e.g. ep0)\n"
 432 #define IP6_STR "IPv6 Information\n"
 433 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
 434 #define OSPF6_INSTANCE_STR "(1-65535) Instance ID\n"
 435 #define SECONDS_STR "Seconds\n"
 436 #define ROUTE_STR "Routing Table\n"
 437 #define PREFIX_LIST_STR "Build a prefix list\n"
 438 #define OSPF6_DUMP_TYPE_LIST                                                   \
 439         "<neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr>"
 440 #define AREA_TAG_STR "[area tag]\n"
 441 #define COMMUNITY_AANN_STR "Community number where AA and NN are (0-65535)\n"
 442 #define COMMUNITY_VAL_STR                                                      \
 443         "Community number in AA:NN format (where AA and NN are (0-65535)) or local-AS|no-advertise|no-export|internet|graceful-shutdown|accept-own-nexthop|accept-own|route-filter-translated-v4|route-filter-v4|route-filter-translated-v6|route-filter-v6|llgr-stale|no-llgr|blackhole|no-peer or additive\n"
 444 #define MPLS_TE_STR "MPLS-TE specific commands\n"
 445 #define LINK_PARAMS_STR "Configure interface link parameters\n"
 446 #define OSPF_RI_STR "OSPF Router Information specific commands\n"
 447 #define PCE_STR "PCE Router Information specific commands\n"
 448 #define MPLS_STR "MPLS information\n"
 449 #define SR_STR "Segment-Routing specific commands\n"
 450 #define WATCHFRR_STR "watchfrr information\n"
 451 #define ZEBRA_STR "Zebra information\n"
 452 #define FILTER_LOG_STR "Filter Logs\n"
 453 #define BFD_PROFILE_STR "BFD profile.\n"
 454 #define BFD_PROFILE_NAME_STR "BFD profile name.\n"
 455 #define SHARP_STR "Sharp Routing Protocol\n"
 456 #define OSPF_GR_STR                                                            \
 457         "OSPF non-stop forwarding (NSF) also known as OSPF Graceful Restart\n"
 458
 459 #define CMD_VNI_RANGE "(1-16777215)"
 460 #define CONF_BACKUP_EXT ".sav"
 461 #define MPLS_LDP_SYNC_STR "Enable MPLS LDP-SYNC\n"
 462 #define NO_MPLS_LDP_SYNC_STR "Disable MPLS LDP-SYNC\n"
 463 #define MPLS_LDP_SYNC_HOLDDOWN_STR                                             \
 464         "Time to wait for LDP-SYNC to occur before restoring if cost\n"
 465 #define NO_MPLS_LDP_SYNC_HOLDDOWN_STR "holddown timer disable\n"
 466
 467 /* Command warnings. */
 468 #define NO_PASSWD_CMD_WARNING                                                  \
 469         "Please be aware that removing the password is a security risk and you should think twice about this command.\n"
 470
 471 /* IPv4 only machine should not accept IPv6 address for peer's IP
 472    address.  So we replace VTY command string like below. */
 473 #define NEIGHBOR_ADDR_STR  "Neighbor address\nIPv6 address\n"
 474 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nInterface name or neighbor tag\n"
 475 #define NEIGHBOR_ADDR_STR3 "Neighbor address\nIPv6 address\nInterface name\n"
 476
 477 /* Graceful Restart cli help strings */
 478 #define GR_CMD "Global Graceful Restart command\n"
 479 #define NO_GR_CMD "Undo Global Graceful Restart command\n"
 480 #define GR "Global Graceful Restart - GR Mode\n"
 481 #define GR_DISABLE "Global Graceful Restart - Disable Mode\n"
 482 #define NO_GR_DISABLE "Undo Global Graceful Restart - Disable Mode\n"
 483 #define GR_DEBUG "Graceful Restart - Enable Debug Logs\n"
 484 #define GR_SHOW "Graceful Restart - Show command for Global and all neighbor mode\n"
 485 #define GR_NEIGHBOR_CMD "Graceful Restart command for a neighbor\n"
 486 #define NO_GR_NEIGHBOR_CMD "Undo Graceful Restart command for a neighbor\n"
 487 #define GR_NEIGHBOR_DISABLE_CMD "Graceful Restart Disable command for a neighbor\n"
 488 #define NO_GR_NEIGHBOR_DISABLE_CMD "Undo Graceful Restart Disable command for a neighbor\n"
 489 #define GR_NEIGHBOR_HELPER_CMD "Graceful Restart Helper command for a neighbor\n"
 490 #define NO_GR_NEIGHBOR_HELPER_CMD "Undo Graceful Restart Helper command for a neighbor\n"
 491
 492 /* EVPN help Strings */
 493 #define EVPN_RT_HELP_STR "EVPN route information\n"
 494 #define EVPN_RT_DIST_HELP_STR "Route Distinguisher\n"
 495 #define EVPN_ASN_IP_HELP_STR "ASN:XX or A.B.C.D:XX\n"
 496 #define EVPN_TYPE_HELP_STR "Specify Route type\n"
 497 #define EVPN_TYPE_1_HELP_STR "EAD (Type-1) route\n"
 498 #define EVPN_TYPE_2_HELP_STR "MAC-IP (Type-2) route\n"
 499 #define EVPN_TYPE_3_HELP_STR "Multicast (Type-3) route\n"
 500 #define EVPN_TYPE_4_HELP_STR "Ethernet Segment (Type-4) route\n"
 501 #define EVPN_TYPE_5_HELP_STR "Prefix (Type-5) route\n"
 502 #define EVPN_TYPE_ALL_LIST "<ead|1|macip|2|multicast|3|es|4|prefix|5>"
 503 #define EVPN_TYPE_ALL_LIST_HELP_STR                                            \
 504         EVPN_TYPE_1_HELP_STR EVPN_TYPE_1_HELP_STR                              \
 505         EVPN_TYPE_2_HELP_STR EVPN_TYPE_2_HELP_STR                              \
 506         EVPN_TYPE_3_HELP_STR EVPN_TYPE_3_HELP_STR                              \
 507         EVPN_TYPE_4_HELP_STR EVPN_TYPE_4_HELP_STR                              \
 508         EVPN_TYPE_5_HELP_STR EVPN_TYPE_5_HELP_STR
 509
 510
 511 /* Prototypes. */
 512 extern void install_node(struct cmd_node *node);
 513 extern void install_default(enum node_type);
 514
 515 struct xref_install_element {
 516         struct xref xref;
 517
 518         const struct cmd_element *cmd_element;
 519         enum node_type node_type;
 520 };
 521
 522 #ifndef VTYSH_EXTRACT_PL
 523 #define install_element(node_type_, cmd_element_) do {                         \
 524                 static const struct xref_install_element _xref                 \
 525                                 __attribute__((used)) = {                      \
 526                         .xref = XREF_INIT(XREFT_INSTALL_ELEMENT, NULL,         \
 527                                           __func__),                           \
 528                         .cmd_element = cmd_element_,                           \
 529                         .node_type = node_type_,                               \
 530                 };                                                             \
 531                 XREF_LINK(_xref.xref);                                         \
 532                 _install_element(node_type_, cmd_element_);                    \
 533         } while (0)
 534 #endif
 535
 536 extern void _install_element(enum node_type, const struct cmd_element *);
 537
 538 /* known issue with uninstall_element:  changes to cmd_token->attr (i.e.
 539  * deprecated/hidden) are not reversed. */
 540 extern void uninstall_element(enum node_type, const struct cmd_element *);
 541
 542 /* construct CLI tree only when entering nodes */
 543 extern void cmd_defer_tree(bool val);
 544
 545 /* finish CLI tree for node when above is true (noop otherwise) */
 546 extern void cmd_finalize_node(struct cmd_node *node);
 547
 548 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
 549    string with a space between each element (allocated using
 550    XMALLOC(MTYPE_TMP)).  Returns NULL if shift >= argc. */
 551 extern char *argv_concat(struct cmd_token **argv, int argc, int shift);
 552
 553 /*
 554  * It is preferred that you set the index initial value
 555  * to a 0.  This way in the future if you modify the
 556  * cli then there is no need to modify the initial
 557  * value of the index
 558  */
 559 extern int argv_find(struct cmd_token **argv, int argc, const char *text,
 560                      int *index);
 561
 562 extern vector cmd_make_strvec(const char *);
 563 extern void cmd_free_strvec(vector);
 564 extern vector cmd_describe_command(vector, struct vty *, int *status);
 565 extern char **cmd_complete_command(vector, struct vty *, int *status);
 566 extern const char *cmd_prompt(enum node_type);
 567 extern int command_config_read_one_line(struct vty *vty,
 568                                         const struct cmd_element **,
 569                                         uint32_t line_num, int use_config_node);
 570 extern int config_from_file(struct vty *, FILE *, unsigned int *line_num);
 571 extern enum node_type node_parent(enum node_type);
 572 /*
 573  * Execute command under the given vty context.
 574  *
 575  * vty
 576  *    The vty context to execute under.
 577  *
 578  * cmd
 579  *    The command string to execute.
 580  *
 581  * matched
 582  *    If non-null and a match was found, the address of the matched command is
 583  *    stored here. No action otherwise.
 584  *
 585  * vtysh
 586  *    Whether or not this is being called from vtysh. If this is nonzero,
 587  *    XXX: then what?
 588  *
 589  * Returns:
 590  *    XXX: what does it return
 591  */
 592 extern int cmd_execute(struct vty *vty, const char *cmd,
 593                        const struct cmd_element **matched, int vtysh);
 594 extern int cmd_execute_command(vector, struct vty *,
 595                                const struct cmd_element **, int);
 596 extern int cmd_execute_command_strict(vector, struct vty *,
 597                                       const struct cmd_element **);
 598 extern void cmd_init(int terminal);
 599 extern void cmd_init_config_callbacks(void (*start_config_cb)(void),
 600                                       void (*end_config_cb)(void));
 601 extern void cmd_terminate(void);
 602 extern void cmd_exit(struct vty *vty);
 603 extern int cmd_list_cmds(struct vty *vty, int do_permute);
 604 extern int cmd_find_cmds(struct vty *vty, struct cmd_token **argv, int argc);
 605
 606 extern int cmd_domainname_set(const char *domainname);
 607 extern int cmd_hostname_set(const char *hostname);
 608 extern const char *cmd_hostname_get(void);
 609 extern const char *cmd_domainname_get(void);
 610 extern const char *cmd_system_get(void);
 611 extern const char *cmd_release_get(void);
 612 extern const char *cmd_version_get(void);
 613
 614 /* NOT safe for general use; call this only if DEV_BUILD! */
 615 extern void grammar_sandbox_init(void);
 616
 617 extern vector completions_to_vec(struct list *completions);
 618
 619 /* Export typical functions. */
 620 extern const char *host_config_get(void);
 621 extern void host_config_set(const char *);
 622
 623 extern void print_version(const char *);
 624
 625 extern int cmd_banner_motd_file(const char *);
 626 extern void cmd_banner_motd_line(const char *line);
 627
 628 /* struct host global, ick */
 629 extern struct host host;
 630
 631 struct cmd_variable_handler {
 632         const char *tokenname, *varname;
 633         void (*completions)(vector out, struct cmd_token *token);
 634 };
 635
 636 extern void cmd_variable_complete(struct cmd_token *token, const char *arg,
 637                                   vector comps);
 638 extern void
 639 cmd_variable_handler_register(const struct cmd_variable_handler *cvh);
 640 extern char *cmd_variable_comp2str(vector comps, unsigned short cols);
 641
 642 extern void command_setup_early_logging(const char *dest, const char *level);
 643
 644 #ifdef __cplusplus
 645 }
 646 #endif
 647
 648 #endif /* _ZEBRA_COMMAND_H */