lib/command.h

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