]> git.proxmox.com Git - mirror_frr.git/blame - lib/command.c
Merge pull request #13357 from Jafaral/fix_ospf_prop
[mirror_frr.git] / lib / command.c
CommitLineData
acddc0ed 1// SPDX-License-Identifier: GPL-2.0-or-later
274a4a44 2/*
9547b5d0
QY
3 * CLI backend interface.
4 *
5 * --
6 * Copyright (C) 2016 Cumulus Networks, Inc.
7 * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
8 * Copyright (C) 2013 by Open Source Routing.
9 * Copyright (C) 2013 by Internet Systems Consortium, Inc. ("ISC")
9547b5d0 10 */
718e3744 11
12#include <zebra.h>
fe011935 13#include <lib/version.h>
718e3744 14
fe011935
QY
15#include "command.h"
16#include "frrstr.h"
718e3744 17#include "memory.h"
18#include "log.h"
0bdeb5e5 19#include "log_vty.h"
24a58196 20#include "frrevent.h"
b21b19c5 21#include "vector.h"
d0bfb22c 22#include "linklist.h"
b21b19c5 23#include "vty.h"
354d119a 24#include "workqueue.h"
19dc275e 25#include "vrf.h"
d0bfb22c 26#include "command_match.h"
5894e76d 27#include "command_graph.h"
1bf9f027 28#include "qobj.h"
8efe88ea 29#include "defaults.h"
9eed278b 30#include "libfrr.h"
bd74dc61 31#include "jhash.h"
01e24c4a 32#include "hook.h"
481bc15f 33#include "lib_errors.h"
cfa0facb
CH
34#include "mgmt_be_client.h"
35#include "mgmt_fe_client.h"
1c2facd1 36#include "northbound_cli.h"
5920b3eb 37#include "network.h"
cf00164b 38#include "routemap.h"
d0bfb22c 39
3d19ffc5
QY
40#include "frrscript.h"
41
bf8d3d6a
DL
42DEFINE_MTYPE_STATIC(LIB, HOST, "Host config");
43DEFINE_MTYPE(LIB, COMPLETION, "Completion item");
4a1ab8e4 44
26fbe472
QY
45#define item(x) \
46 { \
47 x, #x \
48 }
49
50/* clang-format off */
51const struct message tokennames[] = {
52 item(WORD_TKN),
53 item(VARIABLE_TKN),
54 item(RANGE_TKN),
55 item(IPV4_TKN),
56 item(IPV4_PREFIX_TKN),
57 item(IPV6_TKN),
58 item(IPV6_PREFIX_TKN),
59 item(MAC_TKN),
60 item(MAC_PREFIX_TKN),
8079a413 61 item(ASNUM_TKN),
26fbe472
QY
62 item(FORK_TKN),
63 item(JOIN_TKN),
64 item(START_TKN),
65 item(END_TKN),
90c8406c 66 item(NEG_ONLY_TKN),
26fbe472
QY
67 {0},
68};
26fbe472 69/* clang-format on */
a83a5331 70
718e3744 71/* Command vector which includes some level of command lists. Normally
72 each daemon maintains each own cmdvec. */
eb820afe 73vector cmdvec = NULL;
718e3744 74
75/* Host information structure. */
76struct host host;
77
0e06eb8b
DL
78/* for vtysh, put together CLI trees only when switching into node */
79static bool defer_cli_tree;
80
419cd5a0
MK
81/*
82 * Returns host.name if any, otherwise
83 * it returns the system hostname.
84 */
6b3ee3a0 85const char *cmd_hostname_get(void)
419cd5a0
MK
86{
87 return host.name;
88}
89
90/*
91 * Returns unix domainname
92 */
6b3ee3a0 93const char *cmd_domainname_get(void)
419cd5a0
MK
94{
95 return host.domainname;
96}
97
46b48b33
DS
98const char *cmd_system_get(void)
99{
100 return host.system;
101}
102
103const char *cmd_release_get(void)
104{
105 return host.release;
106}
107
108const char *cmd_version_get(void)
109{
110 return host.version;
111}
112
ac156aec
DA
113bool cmd_allow_reserved_ranges_get(void)
114{
115 return host.allow_reserved_ranges;
116}
117
234f6fd4
DA
118const char *cmd_software_version_get(void)
119{
120 return FRR_FULL_NAME "/" FRR_VERSION;
121}
122
791ded4a
DL
123static int root_on_exit(struct vty *vty);
124
718e3744 125/* Standard command node structures. */
d62a17ae 126static struct cmd_node auth_node = {
f4b8291f 127 .name = "auth",
62b346ee
DL
128 .node = AUTH_NODE,
129 .prompt = "Password: ",
718e3744 130};
131
d62a17ae 132static struct cmd_node view_node = {
f4b8291f 133 .name = "view",
62b346ee
DL
134 .node = VIEW_NODE,
135 .prompt = "%s> ",
791ded4a 136 .node_exit = root_on_exit,
718e3744 137};
138
d62a17ae 139static struct cmd_node auth_enable_node = {
f4b8291f 140 .name = "auth enable",
62b346ee
DL
141 .node = AUTH_ENABLE_NODE,
142 .prompt = "Password: ",
718e3744 143};
144
d62a17ae 145static struct cmd_node enable_node = {
f4b8291f 146 .name = "enable",
62b346ee
DL
147 .node = ENABLE_NODE,
148 .prompt = "%s# ",
791ded4a 149 .node_exit = root_on_exit,
718e3744 150};
151
612c2c15 152static int config_write_host(struct vty *vty);
62b346ee 153static struct cmd_node config_node = {
f4b8291f 154 .name = "config",
62b346ee 155 .node = CONFIG_NODE,
24389580 156 .parent_node = ENABLE_NODE,
62b346ee 157 .prompt = "%s(config)# ",
612c2c15 158 .config_write = config_write_host,
791ded4a 159 .node_exit = vty_config_node_exit,
62b346ee 160};
6590f2c3 161
cb585b65 162/* This is called from main when a daemon is invoked with -v or --version. */
d62a17ae 163void print_version(const char *progname)
6590f2c3 164{
d62a17ae 165 printf("%s version %s\n", progname, FRR_VERSION);
166 printf("%s\n", FRR_COPYRIGHT);
e063f271 167#ifdef ENABLE_VERSION_BUILD_CONFIG
d62a17ae 168 printf("configured with:\n\t%s\n", FRR_CONFIG_ARGS);
e063f271 169#endif
6590f2c3 170}
171
d62a17ae 172char *argv_concat(struct cmd_token **argv, int argc, int shift)
173{
a6a87d63 174 int cnt = MAX(argc - shift, 0);
175 const char *argstr[cnt + 1];
176
177 if (!cnt)
178 return NULL;
fe011935
QY
179
180 for (int i = 0; i < cnt; i++)
181 argstr[i] = argv[i + shift]->arg;
182
183 return frrstr_join(argstr, cnt, " ");
184}
185
186vector cmd_make_strvec(const char *string)
187{
188 if (!string)
d62a17ae 189 return NULL;
fe011935
QY
190
191 const char *copy = string;
192
193 /* skip leading whitespace */
fefa5e0f 194 while (isspace((unsigned char)*copy) && *copy != '\0')
fe011935
QY
195 copy++;
196
197 /* if the entire string was whitespace or a comment, return */
198 if (*copy == '\0' || *copy == '!' || *copy == '#')
199 return NULL;
200
0a334343 201 vector result = frrstr_split_vec(copy, "\n\r\t ");
fe011935
QY
202
203 for (unsigned int i = 0; i < vector_active(result); i++) {
204 if (strlen(vector_slot(result, i)) == 0) {
205 XFREE(MTYPE_TMP, vector_slot(result, i));
f428cb8a 206 vector_unset(result, i);
fe011935 207 }
d62a17ae 208 }
f428cb8a
QY
209
210 vector_compact(result);
211
fe011935
QY
212 return result;
213}
214
215void cmd_free_strvec(vector v)
216{
217 frrstr_strvec_free(v);
718e3744 218}
219
ae19d7dd
QY
220/**
221 * Convenience function for accessing argv data.
222 *
223 * @param argc
224 * @param argv
225 * @param text definition snippet of the desired token
226 * @param index the starting index, and where to store the
227 * index of the found token if it exists
228 * @return 1 if found, 0 otherwise
229 */
d62a17ae 230int argv_find(struct cmd_token **argv, int argc, const char *text, int *index)
ae19d7dd 231{
d62a17ae 232 int found = 0;
233 for (int i = *index; i < argc && found == 0; i++)
234 if ((found = strmatch(text, argv[i]->text)))
235 *index = i;
236 return found;
ae19d7dd
QY
237}
238
d8b87afe 239static unsigned int cmd_hash_key(const void *p)
274f29b2 240{
bd74dc61
DS
241 int size = sizeof(p);
242
243 return jhash(p, size, 0);
274f29b2
PJ
244}
245
74df8d6d 246static bool cmd_hash_cmp(const void *a, const void *b)
274f29b2 247{
d62a17ae 248 return a == b;
274f29b2
PJ
249}
250
718e3744 251/* Install top node of command vector. */
612c2c15 252void install_node(struct cmd_node *node)
718e3744 253{
c81d78cf
DS
254#define CMD_HASH_STR_SIZE 256
255 char hash_name[CMD_HASH_STR_SIZE];
256
d62a17ae 257 vector_set_index(cmdvec, node->node, node);
d62a17ae 258 node->cmdgraph = graph_new();
259 node->cmd_vector = vector_init(VECTOR_MIN_SIZE);
260 // add start node
9eebf97e 261 struct cmd_token *token = cmd_token_new(START_TKN, 0, NULL, NULL);
d62a17ae 262 graph_new_node(node->cmdgraph, token,
263 (void (*)(void *)) & cmd_token_del);
c81d78cf
DS
264
265 snprintf(hash_name, sizeof(hash_name), "Command Hash: %s", node->name);
266 node->cmd_hash =
267 hash_create_size(16, cmd_hash_key, cmd_hash_cmp, hash_name);
718e3744 268}
269
718e3744 270/* Return prompt character of specified node. */
d62a17ae 271const char *cmd_prompt(enum node_type node)
718e3744 272{
d62a17ae 273 struct cmd_node *cnode;
718e3744 274
d62a17ae 275 cnode = vector_slot(cmdvec, node);
276 return cnode->prompt;
718e3744 277}
278
0e06eb8b
DL
279void cmd_defer_tree(bool val)
280{
281 defer_cli_tree = val;
282}
283
718e3744 284/* Install a command into a node. */
01485adb 285void _install_element(enum node_type ntype, const struct cmd_element *cmd)
718e3744 286{
d62a17ae 287 struct cmd_node *cnode;
d0bfb22c 288
d62a17ae 289 /* cmd_init hasn't been called */
290 if (!cmdvec) {
291 fprintf(stderr, "%s called before cmd_init, breakage likely\n",
292 __func__);
293 return;
294 }
ebacb4ed 295
3cbb67f2 296 cnode = vector_lookup(cmdvec, ntype);
718e3744 297
d62a17ae 298 if (cnode == NULL) {
299 fprintf(stderr,
3cbb67f2 300 "%s[%s]:\n"
f4b8291f 301 "\tnode %d does not exist.\n"
3cbb67f2 302 "\tplease call install_node() before install_element()\n",
f4b8291f 303 cmd->name, cmd->string, ntype);
d62a17ae 304 exit(EXIT_FAILURE);
305 }
ebacb4ed 306
154e9ca1 307 if (hash_lookup(cnode->cmd_hash, (void *)cmd) != NULL) {
d62a17ae 308 fprintf(stderr,
3cbb67f2
DL
309 "%s[%s]:\n"
310 "\tnode %d (%s) already has this command installed.\n"
311 "\tduplicate install_element call?\n",
f4b8291f 312 cmd->name, cmd->string, ntype, cnode->name);
d62a17ae 313 return;
314 }
ebacb4ed 315
8e3aae66 316 (void)hash_get(cnode->cmd_hash, (void *)cmd, hash_alloc_intern);
ebacb4ed 317
0e06eb8b
DL
318 if (cnode->graph_built || !defer_cli_tree) {
319 struct graph *graph = graph_new();
320 struct cmd_token *token =
9eebf97e 321 cmd_token_new(START_TKN, 0, NULL, NULL);
0e06eb8b
DL
322 graph_new_node(graph, token,
323 (void (*)(void *)) & cmd_token_del);
324
325 cmd_graph_parse(graph, cmd);
326 cmd_graph_names(graph);
327 cmd_graph_merge(cnode->cmdgraph, graph, +1);
328 graph_delete_graph(graph);
329
330 cnode->graph_built = true;
331 }
332
333 vector_set(cnode->cmd_vector, (void *)cmd);
334
335 if (ntype == VIEW_NODE)
336 _install_element(ENABLE_NODE, cmd);
337}
338
339static void cmd_finalize_iter(struct hash_bucket *hb, void *arg)
340{
341 struct cmd_node *cnode = arg;
342 const struct cmd_element *cmd = hb->data;
d62a17ae 343 struct graph *graph = graph_new();
9eebf97e 344 struct cmd_token *token = cmd_token_new(START_TKN, 0, NULL, NULL);
0e06eb8b 345
d62a17ae 346 graph_new_node(graph, token, (void (*)(void *)) & cmd_token_del);
de8f7a39 347
d62a17ae 348 cmd_graph_parse(graph, cmd);
349 cmd_graph_names(graph);
350 cmd_graph_merge(cnode->cmdgraph, graph, +1);
351 graph_delete_graph(graph);
0e06eb8b 352}
de8f7a39 353
0e06eb8b
DL
354void cmd_finalize_node(struct cmd_node *cnode)
355{
356 if (cnode->graph_built)
357 return;
735e62a0 358
0e06eb8b
DL
359 hash_iterate(cnode->cmd_hash, cmd_finalize_iter, cnode);
360 cnode->graph_built = true;
718e3744 361}
362
154e9ca1 363void uninstall_element(enum node_type ntype, const struct cmd_element *cmd)
de8f7a39 364{
d62a17ae 365 struct cmd_node *cnode;
de8f7a39 366
d62a17ae 367 /* cmd_init hasn't been called */
368 if (!cmdvec) {
369 fprintf(stderr, "%s called before cmd_init, breakage likely\n",
370 __func__);
371 return;
372 }
de8f7a39 373
3cbb67f2 374 cnode = vector_lookup(cmdvec, ntype);
de8f7a39 375
d62a17ae 376 if (cnode == NULL) {
377 fprintf(stderr,
3cbb67f2 378 "%s[%s]:\n"
f4b8291f 379 "\tnode %d does not exist.\n"
3cbb67f2 380 "\tplease call install_node() before uninstall_element()\n",
f4b8291f 381 cmd->name, cmd->string, ntype);
d62a17ae 382 exit(EXIT_FAILURE);
383 }
de8f7a39 384
154e9ca1 385 if (hash_release(cnode->cmd_hash, (void *)cmd) == NULL) {
d62a17ae 386 fprintf(stderr,
3cbb67f2
DL
387 "%s[%s]:\n"
388 "\tnode %d (%s) does not have this command installed.\n"
389 "\tduplicate uninstall_element call?\n",
f4b8291f 390 cmd->name, cmd->string, ntype, cnode->name);
d62a17ae 391 return;
392 }
de8f7a39 393
154e9ca1 394 vector_unset_value(cnode->cmd_vector, (void *)cmd);
de8f7a39 395
0e06eb8b
DL
396 if (cnode->graph_built) {
397 struct graph *graph = graph_new();
398 struct cmd_token *token =
9eebf97e 399 cmd_token_new(START_TKN, 0, NULL, NULL);
0e06eb8b
DL
400 graph_new_node(graph, token,
401 (void (*)(void *)) & cmd_token_del);
402
403 cmd_graph_parse(graph, cmd);
404 cmd_graph_names(graph);
405 cmd_graph_merge(cnode->cmdgraph, graph, -1);
406 graph_delete_graph(graph);
407 }
de8f7a39 408
d62a17ae 409 if (ntype == VIEW_NODE)
410 uninstall_element(ENABLE_NODE, cmd);
de8f7a39
DL
411}
412
413
2d362d10 414static const unsigned char itoa64[] =
d62a17ae 415 "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
718e3744 416
d62a17ae 417static void to64(char *s, long v, int n)
718e3744 418{
d62a17ae 419 while (--n >= 0) {
420 *s++ = itoa64[v & 0x3f];
421 v >>= 6;
422 }
718e3744 423}
424
d62a17ae 425static char *zencrypt(const char *passwd)
718e3744 426{
d62a17ae 427 char salt[6];
428 struct timeval tv;
718e3744 429
d62a17ae 430 gettimeofday(&tv, 0);
d0bfb22c 431
5920b3eb 432 to64(&salt[0], frr_weak_random(), 3);
d62a17ae 433 to64(&salt[3], tv.tv_usec, 3);
434 salt[5] = '\0';
718e3744 435
d62a17ae 436 return crypt(passwd, salt);
718e3744 437}
438
0bdeb5e5
DL
439static bool full_cli;
440
718e3744 441/* This function write configuration of this host. */
d62a17ae 442static int config_write_host(struct vty *vty)
443{
a7141b85 444 const char *name;
d62a17ae 445
a7141b85
DS
446 name = cmd_hostname_get();
447 if (name && name[0] != '\0')
448 vty_out(vty, "hostname %s\n", name);
449
450 name = cmd_domainname_get();
451 if (name && name[0] != '\0')
452 vty_out(vty, "domainname %s\n", name);
3b103fec 453
ac156aec
DA
454 if (cmd_allow_reserved_ranges_get())
455 vty_out(vty, "allow-reserved-ranges\n");
456
0204baa8 457 /* The following are all configuration commands that are not sent to
3518f352
DS
458 * watchfrr. For instance watchfrr is hardcoded to log to syslog so
459 * we would always display 'log syslog informational' in the config
460 * which would cause other daemons to then switch to syslog when they
461 * parse frr.conf.
462 */
0bdeb5e5 463 if (full_cli) {
0204baa8
DW
464 if (host.encrypt) {
465 if (host.password_encrypt)
3518f352
DS
466 vty_out(vty, "password 8 %s\n",
467 host.password_encrypt);
0204baa8
DW
468 if (host.enable_encrypt)
469 vty_out(vty, "enable password 8 %s\n",
470 host.enable_encrypt);
471 } else {
472 if (host.password)
473 vty_out(vty, "password %s\n", host.password);
474 if (host.enable)
3518f352
DS
475 vty_out(vty, "enable password %s\n",
476 host.enable);
0204baa8 477 }
0bdeb5e5 478 log_config_write(vty);
d62a17ae 479
45f01188
DL
480 /* print disable always, but enable only if default is flipped
481 * => prep for future removal of compile-time knob
482 */
483 if (!cputime_enabled)
484 vty_out(vty, "no service cputime-stats\n");
485#ifdef EXCLUDE_CPU_TIME
486 else
487 vty_out(vty, "service cputime-stats\n");
488#endif
489
490 if (!cputime_threshold)
491 vty_out(vty, "no service cputime-warning\n");
492#if defined(CONSUMED_TIME_CHECK) && CONSUMED_TIME_CHECK != 5000000
493 else /* again, always print non-default */
494#else
495 else if (cputime_threshold != 5000000)
496#endif
497 vty_out(vty, "service cputime-warning %lu\n",
ef78e4fd 498 cputime_threshold / 1000);
45f01188
DL
499
500 if (!walltime_threshold)
501 vty_out(vty, "no service walltime-warning\n");
502#if defined(CONSUMED_TIME_CHECK) && CONSUMED_TIME_CHECK != 5000000
503 else /* again, always print non-default */
504#else
505 else if (walltime_threshold != 5000000)
506#endif
507 vty_out(vty, "service walltime-warning %lu\n",
ef78e4fd 508 walltime_threshold / 1000);
45f01188 509
0204baa8
DW
510 if (host.advanced)
511 vty_out(vty, "service advanced-vty\n");
d62a17ae 512
0204baa8
DW
513 if (host.encrypt)
514 vty_out(vty, "service password-encryption\n");
d62a17ae 515
0204baa8 516 if (host.lines >= 0)
3518f352
DS
517 vty_out(vty, "service terminal-length %d\n",
518 host.lines);
d62a17ae 519
0204baa8
DW
520 if (host.motdfile)
521 vty_out(vty, "banner motd file %s\n", host.motdfile);
19d61463
DA
522 else if (host.motd
523 && strncmp(host.motd, FRR_DEFAULT_MOTD,
524 strlen(host.motd)))
525 vty_out(vty, "banner motd line %s\n", host.motd);
0204baa8
DW
526 else if (!host.motd)
527 vty_out(vty, "no banner motd\n");
528 }
d62a17ae 529
9eed278b
DL
530 if (debug_memstats_at_exit)
531 vty_out(vty, "!\ndebug memstats-at-exit\n");
532
d62a17ae 533 return 1;
718e3744 534}
535
d0bfb22c 536/* Utility function for getting command graph. */
d62a17ae 537static struct graph *cmd_node_graph(vector v, enum node_type ntype)
718e3744 538{
d62a17ae 539 struct cmd_node *cnode = vector_slot(v, ntype);
0e06eb8b
DL
540
541 cmd_finalize_node(cnode);
d62a17ae 542 return cnode->cmdgraph;
718e3744 543}
544
d62a17ae 545static int cmd_try_do_shortcut(enum node_type node, char *first_word)
546{
547 if (first_word != NULL && node != AUTH_NODE && node != VIEW_NODE
548 && node != AUTH_ENABLE_NODE && 0 == strcmp("do", first_word))
549 return 1;
550 return 0;
718e3744 551}
552
d0bfb22c
QY
553/**
554 * Compare function for cmd_token.
555 * Used with qsort to sort command completions.
556 */
d62a17ae 557static int compare_completions(const void *fst, const void *snd)
718e3744 558{
36de6e0e
A
559 const struct cmd_token *first = *(const struct cmd_token * const *)fst,
560 *secnd = *(const struct cmd_token * const *)snd;
d62a17ae 561 return strcmp(first->text, secnd->text);
718e3744 562}
563
d0bfb22c
QY
564/**
565 * Takes a list of completions returned by command_complete,
566 * dedeuplicates them based on both text and description,
6011c1b2
QY
567 * sorts them, and returns them as a vector.
568 *
569 * @param completions linked list of cmd_token
570 * @return deduplicated and sorted vector with
d0bfb22c 571 */
d62a17ae 572vector completions_to_vec(struct list *completions)
573{
574 vector comps = vector_init(VECTOR_MIN_SIZE);
575
576 struct listnode *ln;
577 struct cmd_token *token, *cr = NULL;
578 unsigned int i, exists;
579 for (ALL_LIST_ELEMENTS_RO(completions, ln, token)) {
580 if (token->type == END_TKN && (cr = token))
581 continue;
582
583 // linear search for token in completions vector
584 exists = 0;
585 for (i = 0; i < vector_active(comps) && !exists; i++) {
586 struct cmd_token *curr = vector_slot(comps, i);
53205694 587#ifdef VTYSH_DEBUG
d62a17ae 588 exists = !strcmp(curr->text, token->text)
589 && !strcmp(curr->desc, token->desc);
53205694 590#else
d62a17ae 591 exists = !strcmp(curr->text, token->text);
53205694 592#endif /* VTYSH_DEBUG */
d62a17ae 593 }
909a2155 594
d62a17ae 595 if (!exists)
596 vector_set(comps, token);
597 }
cd40b329 598
d62a17ae 599 // sort completions
600 qsort(comps->index, vector_active(comps), sizeof(void *),
601 &compare_completions);
cd40b329 602
d62a17ae 603 // make <cr> the first element, if it is present
604 if (cr) {
605 vector_set_index(comps, vector_active(comps), NULL);
606 memmove(comps->index + 1, comps->index,
607 (comps->alloced - 1) * sizeof(void *));
608 vector_set_index(comps, 0, cr);
609 }
6011c1b2 610
d62a17ae 611 return comps;
cd40b329 612}
d0bfb22c
QY
613/**
614 * Generates a vector of cmd_token representing possible completions
615 * on the current input.
616 *
617 * @param vline the vectorized input line
618 * @param vty the vty with the node to match on
619 * @param status pointer to matcher status code
ebacb4ed 620 * @return vector of struct cmd_token * with possible completions
d0bfb22c 621 */
d62a17ae 622static vector cmd_complete_command_real(vector vline, struct vty *vty,
623 int *status)
cd40b329 624{
d62a17ae 625 struct list *completions;
626 struct graph *cmdgraph = cmd_node_graph(cmdvec, vty->node);
cd40b329 627
d62a17ae 628 enum matcher_rv rv = command_complete(cmdgraph, vline, &completions);
cd40b329 629
d62a17ae 630 if (MATCHER_ERROR(rv)) {
631 *status = CMD_ERR_NO_MATCH;
632 return NULL;
633 }
b92938a7 634
d62a17ae 635 vector comps = completions_to_vec(completions);
6a154c88 636 list_delete(&completions);
b92938a7 637
d62a17ae 638 // set status code appropriately
639 switch (vector_active(comps)) {
640 case 0:
641 *status = CMD_ERR_NO_MATCH;
642 break;
643 case 1:
644 *status = CMD_COMPLETE_FULL_MATCH;
645 break;
646 default:
647 *status = CMD_COMPLETE_LIST_MATCH;
648 }
718e3744 649
d62a17ae 650 return comps;
d0bfb22c 651}
718e3744 652
d62a17ae 653vector cmd_describe_command(vector vline, struct vty *vty, int *status)
d0bfb22c 654{
d62a17ae 655 vector ret;
718e3744 656
d62a17ae 657 if (cmd_try_do_shortcut(vty->node, vector_slot(vline, 0))) {
658 enum node_type onode;
1c2facd1 659 int orig_xpath_index;
d62a17ae 660 vector shifted_vline;
661 unsigned int index;
718e3744 662
d62a17ae 663 onode = vty->node;
1c2facd1 664 orig_xpath_index = vty->xpath_index;
d62a17ae 665 vty->node = ENABLE_NODE;
1c2facd1 666 vty->xpath_index = 0;
d62a17ae 667 /* We can try it on enable node, cos' the vty is authenticated
668 */
718e3744 669
d62a17ae 670 shifted_vline = vector_init(vector_count(vline));
671 /* use memcpy? */
672 for (index = 1; index < vector_active(vline); index++) {
673 vector_set_index(shifted_vline, index - 1,
674 vector_lookup(vline, index));
675 }
718e3744 676
d62a17ae 677 ret = cmd_complete_command_real(shifted_vline, vty, status);
d0bfb22c 678
d62a17ae 679 vector_free(shifted_vline);
680 vty->node = onode;
1c2facd1 681 vty->xpath_index = orig_xpath_index;
d62a17ae 682 return ret;
683 }
718e3744 684
d62a17ae 685 return cmd_complete_command_real(vline, vty, status);
718e3744 686}
687
70d44c5c
DL
688static struct list *varhandlers = NULL;
689
d62a17ae 690void cmd_variable_complete(struct cmd_token *token, const char *arg,
691 vector comps)
692{
693 struct listnode *ln;
694 const struct cmd_variable_handler *cvh;
695 size_t i, argsz;
696 vector tmpcomps;
697
698 tmpcomps = arg ? vector_init(VECTOR_MIN_SIZE) : comps;
699
700 for (ALL_LIST_ELEMENTS_RO(varhandlers, ln, cvh)) {
701 if (cvh->tokenname && strcmp(cvh->tokenname, token->text))
702 continue;
9d303b37
DL
703 if (cvh->varname && (!token->varname
704 || strcmp(cvh->varname, token->varname)))
d62a17ae 705 continue;
706 cvh->completions(tmpcomps, token);
707 break;
708 }
709
710 if (!arg)
711 return;
712
713 argsz = strlen(arg);
714 for (i = vector_active(tmpcomps); i; i--) {
715 char *item = vector_slot(tmpcomps, i - 1);
716 if (strlen(item) >= argsz && !strncmp(item, arg, argsz))
717 vector_set(comps, item);
718 else
719 XFREE(MTYPE_COMPLETION, item);
720 }
721 vector_free(tmpcomps);
70d44c5c
DL
722}
723
1a0f614d
QY
724#define AUTOCOMP_INDENT 5
725
d62a17ae 726char *cmd_variable_comp2str(vector comps, unsigned short cols)
1a0f614d 727{
d62a17ae 728 size_t bsz = 16;
729 char *buf = XCALLOC(MTYPE_TMP, bsz);
730 int lc = AUTOCOMP_INDENT;
731 size_t cs = AUTOCOMP_INDENT;
732 size_t itemlen;
733 snprintf(buf, bsz, "%*s", AUTOCOMP_INDENT, "");
734 for (size_t j = 0; j < vector_active(comps); j++) {
735 char *item = vector_slot(comps, j);
736 itemlen = strlen(item);
1a0f614d 737
d62a17ae 738 if (cs + itemlen + AUTOCOMP_INDENT + 3 >= bsz)
739 buf = XREALLOC(MTYPE_TMP, buf, (bsz *= 2));
1a0f614d 740
d62a17ae 741 if (lc + itemlen + 1 >= cols) {
742 cs += snprintf(&buf[cs], bsz - cs, "\n%*s",
743 AUTOCOMP_INDENT, "");
744 lc = AUTOCOMP_INDENT;
745 }
1a0f614d 746
d62a17ae 747 size_t written = snprintf(&buf[cs], bsz - cs, "%s ", item);
748 lc += written;
749 cs += written;
750 XFREE(MTYPE_COMPLETION, item);
751 vector_set_index(comps, j, NULL);
752 }
753 return buf;
1a0f614d
QY
754}
755
d62a17ae 756void cmd_variable_handler_register(const struct cmd_variable_handler *cvh)
70d44c5c 757{
d62a17ae 758 if (!varhandlers)
759 return;
70d44c5c 760
d62a17ae 761 for (; cvh->completions; cvh++)
762 listnode_add(varhandlers, (void *)cvh);
70d44c5c
DL
763}
764
7f059ea6
DL
765DEFUN_HIDDEN (autocomplete,
766 autocomplete_cmd,
767 "autocomplete TYPE TEXT VARNAME",
768 "Autocompletion handler (internal, for vtysh)\n"
769 "cmd_token->type\n"
770 "cmd_token->text\n"
771 "cmd_token->varname\n")
772{
d62a17ae 773 struct cmd_token tok;
774 vector comps = vector_init(32);
775 size_t i;
7f059ea6 776
d62a17ae 777 memset(&tok, 0, sizeof(tok));
778 tok.type = atoi(argv[1]->arg);
779 tok.text = argv[2]->arg;
780 tok.varname = argv[3]->arg;
781 if (!strcmp(tok.varname, "-"))
782 tok.varname = NULL;
7f059ea6 783
d62a17ae 784 cmd_variable_complete(&tok, NULL, comps);
7f059ea6 785
d62a17ae 786 for (i = 0; i < vector_active(comps); i++) {
787 char *text = vector_slot(comps, i);
788 vty_out(vty, "%s\n", text);
789 XFREE(MTYPE_COMPLETION, text);
790 }
7f059ea6 791
d62a17ae 792 vector_free(comps);
793 return CMD_SUCCESS;
7f059ea6
DL
794}
795
ebacb4ed
QY
796/**
797 * Generate possible tab-completions for the given input. This function only
798 * returns results that would result in a valid command if used as Readline
799 * completions (as is the case in vtysh). For instance, if the passed vline ends
800 * with '4.3.2', the strings 'A.B.C.D' and 'A.B.C.D/M' will _not_ be returned.
801 *
802 * @param vline vectorized input line
803 * @param vty the vty
804 * @param status location to store matcher status code in
805 * @return set of valid strings for use with Readline as tab-completions.
806 */
807
d62a17ae 808char **cmd_complete_command(vector vline, struct vty *vty, int *status)
809{
810 char **ret = NULL;
811 int original_node = vty->node;
812 vector input_line = vector_init(vector_count(vline));
813
814 // if the first token is 'do' we'll want to execute the command in the
815 // enable node
816 int do_shortcut = cmd_try_do_shortcut(vty->node, vector_slot(vline, 0));
817 vty->node = do_shortcut ? ENABLE_NODE : original_node;
818
819 // construct the input line we'll be matching on
820 unsigned int offset = (do_shortcut) ? 1 : 0;
821 for (unsigned index = 0; index + offset < vector_active(vline); index++)
822 vector_set_index(input_line, index,
823 vector_lookup(vline, index + offset));
824
825 // get token completions -- this is a copying operation
826 vector comps = NULL, initial_comps;
827 initial_comps = cmd_complete_command_real(input_line, vty, status);
828
829 if (!MATCHER_ERROR(*status)) {
830 assert(initial_comps);
831 // filter out everything that is not suitable for a
832 // tab-completion
833 comps = vector_init(VECTOR_MIN_SIZE);
834 for (unsigned int i = 0; i < vector_active(initial_comps);
835 i++) {
836 struct cmd_token *token = vector_slot(initial_comps, i);
837 if (token->type == WORD_TKN)
838 vector_set(comps, XSTRDUP(MTYPE_COMPLETION,
839 token->text));
840 else if (IS_VARYING_TOKEN(token->type)) {
841 const char *ref = vector_lookup(
842 vline, vector_active(vline) - 1);
843 cmd_variable_complete(token, ref, comps);
844 }
845 }
846 vector_free(initial_comps);
847
848 // since we filtered results, we need to re-set status code
849 switch (vector_active(comps)) {
850 case 0:
851 *status = CMD_ERR_NO_MATCH;
852 break;
853 case 1:
854 *status = CMD_COMPLETE_FULL_MATCH;
855 break;
856 default:
857 *status = CMD_COMPLETE_LIST_MATCH;
858 }
859
860 // copy completions text into an array of char*
861 ret = XMALLOC(MTYPE_TMP,
862 (vector_active(comps) + 1) * sizeof(char *));
863 unsigned int i;
864 for (i = 0; i < vector_active(comps); i++) {
865 ret[i] = vector_slot(comps, i);
866 }
867 // set the last element to NULL, because this array is used in
868 // a Readline completion_generator function which expects NULL
869 // as a sentinel value
870 ret[i] = NULL;
871 vector_free(comps);
872 comps = NULL;
873 } else if (initial_comps)
874 vector_free(initial_comps);
875
876 // comps should always be null here
877 assert(!comps);
878
879 // free the adjusted input line
880 vector_free(input_line);
881
882 // reset vty->node to its original value
883 vty->node = original_node;
884
885 return ret;
cde9f101 886}
b92938a7 887
b92938a7 888/* return parent node */
889/* MUST eventually converge on CONFIG_NODE */
d62a17ae 890enum node_type node_parent(enum node_type node)
891{
c1e7a5e4 892 struct cmd_node *cnode;
d62a17ae 893
894 assert(node > CONFIG_NODE);
895
c1e7a5e4 896 cnode = vector_lookup(cmdvec, node);
d62a17ae 897
c1e7a5e4 898 return cnode->parent_node;
b92938a7 899}
900
718e3744 901/* Execute command by argument vline vector. */
c139972c 902static int cmd_execute_command_real(vector vline, enum cmd_filter_type filter,
d62a17ae 903 struct vty *vty,
e3476061
DL
904 const struct cmd_element **cmd,
905 unsigned int up_level)
d62a17ae 906{
907 struct list *argv_list;
908 enum matcher_rv status;
909 const struct cmd_element *matched_element = NULL;
e3476061
DL
910 unsigned int i;
911 int xpath_index = vty->xpath_index;
912 int node = vty->node;
d62a17ae 913
e3476061
DL
914 /* only happens for legacy split config file load; need to check for
915 * a match before calling node_exit handlers below
916 */
917 for (i = 0; i < up_level; i++) {
dd2c81b8
DL
918 struct cmd_node *cnode;
919
e3476061
DL
920 if (node <= CONFIG_NODE)
921 return CMD_NO_LEVEL_UP;
922
dd2c81b8 923 cnode = vector_slot(cmdvec, node);
e3476061
DL
924 node = node_parent(node);
925
dd2c81b8 926 if (xpath_index > 0 && !cnode->no_xpath)
e3476061
DL
927 xpath_index--;
928 }
929
930 struct graph *cmdgraph = cmd_node_graph(cmdvec, node);
d62a17ae 931 status = command_match(cmdgraph, vline, &argv_list, &matched_element);
932
933 if (cmd)
934 *cmd = matched_element;
935
936 // if matcher error, return corresponding CMD_ERR
937 if (MATCHER_ERROR(status)) {
938 if (argv_list)
6a154c88 939 list_delete(&argv_list);
d62a17ae 940 switch (status) {
941 case MATCHER_INCOMPLETE:
942 return CMD_ERR_INCOMPLETE;
943 case MATCHER_AMBIGUOUS:
944 return CMD_ERR_AMBIGUOUS;
bde30e78
DS
945 case MATCHER_NO_MATCH:
946 case MATCHER_OK:
d62a17ae 947 return CMD_ERR_NO_MATCH;
948 }
949 }
950
e3476061
DL
951 for (i = 0; i < up_level; i++)
952 cmd_exit(vty);
953
d62a17ae 954 // build argv array from argv list
955 struct cmd_token **argv = XMALLOC(
956 MTYPE_TMP, argv_list->count * sizeof(struct cmd_token *));
957 struct listnode *ln;
958 struct cmd_token *token;
e3476061
DL
959
960 i = 0;
d62a17ae 961 for (ALL_LIST_ELEMENTS_RO(argv_list, ln, token))
962 argv[i++] = token;
963
964 int argc = argv_list->count;
965
966 int ret;
967 if (matched_element->daemon)
968 ret = CMD_SUCCESS_DAEMON;
a6233bfc 969 else {
eaf6705d
RW
970 if (vty->config) {
971 /* Clear array of enqueued configuration changes. */
972 vty->num_cfg_changes = 0;
973 memset(&vty->cfg_changes, 0, sizeof(vty->cfg_changes));
974
689b9cf5
RW
975 /* Regenerate candidate configuration if necessary. */
976 if (frr_get_cli_mode() == FRR_CLI_CLASSIC
977 && running_config->version
978 > vty->candidate_config->version)
eaf6705d
RW
979 nb_config_replace(vty->candidate_config,
980 running_config, true);
b855e95f
RW
981
982 /*
983 * Perform pending commit (if any) before executing
984 * non-YANG command.
985 */
9eebf97e 986 if (!(matched_element->attr & CMD_ATTR_YANG))
fd396924 987 (void)nb_cli_pending_commit_check(vty);
eaf6705d 988 }
a6233bfc 989
d62a17ae 990 ret = matched_element->func(matched_element, vty, argc, argv);
a6233bfc 991 }
d62a17ae 992
993 // delete list and cmd_token's in it
6a154c88 994 list_delete(&argv_list);
d62a17ae 995 XFREE(MTYPE_TMP, argv);
996
997 return ret;
718e3744 998}
999
cd40b329
CF
1000/**
1001 * Execute a given command, handling things like "do ..." and checking
1002 * whether the given command might apply at a parent node if doesn't
1003 * apply for the current node.
1004 *
1005 * @param vline Command line input, vector of char* where each element is
1006 * one input token.
1007 * @param vty The vty context in which the command should be executed.
1008 * @param cmd Pointer where the struct cmd_element of the matched command
1009 * will be stored, if any. May be set to NULL if this info is
1010 * not needed.
1011 * @param vtysh If set != 0, don't lookup the command at parent nodes.
1012 * @return The status of the command that has been executed or an error code
1013 * as to why no command could be executed.
1014 */
d62a17ae 1015int cmd_execute_command(vector vline, struct vty *vty,
1016 const struct cmd_element **cmd, int vtysh)
17aca20b 1017{
d62a17ae 1018 int ret, saved_ret = 0;
1019 enum node_type onode, try_node;
1c2facd1 1020 int orig_xpath_index;
eda031f6 1021
d62a17ae 1022 onode = try_node = vty->node;
1c2facd1 1023 orig_xpath_index = vty->xpath_index;
b92938a7 1024
d62a17ae 1025 if (cmd_try_do_shortcut(vty->node, vector_slot(vline, 0))) {
1026 vector shifted_vline;
1027 unsigned int index;
b92938a7 1028
d62a17ae 1029 vty->node = ENABLE_NODE;
1c2facd1 1030 vty->xpath_index = 0;
d62a17ae 1031 /* We can try it on enable node, cos' the vty is authenticated
1032 */
b92938a7 1033
d62a17ae 1034 shifted_vline = vector_init(vector_count(vline));
1035 /* use memcpy? */
1036 for (index = 1; index < vector_active(vline); index++)
1037 vector_set_index(shifted_vline, index - 1,
1038 vector_lookup(vline, index));
b92938a7 1039
d62a17ae 1040 ret = cmd_execute_command_real(shifted_vline, FILTER_RELAXED,
e3476061 1041 vty, cmd, 0);
b92938a7 1042
d62a17ae 1043 vector_free(shifted_vline);
1044 vty->node = onode;
1c2facd1 1045 vty->xpath_index = orig_xpath_index;
d62a17ae 1046 return ret;
1047 }
b92938a7 1048
d62a17ae 1049 saved_ret = ret =
e3476061 1050 cmd_execute_command_real(vline, FILTER_RELAXED, vty, cmd, 0);
b92938a7 1051
d62a17ae 1052 if (vtysh)
1053 return saved_ret;
87d683b0 1054
825d5fbf 1055 if (ret != CMD_SUCCESS && ret != CMD_WARNING
4bb7f7c2 1056 && ret != CMD_ERR_AMBIGUOUS && ret != CMD_ERR_INCOMPLETE
825d5fbf 1057 && ret != CMD_NOT_MY_INSTANCE && ret != CMD_WARNING_CONFIG_FAILED) {
d62a17ae 1058 /* This assumes all nodes above CONFIG_NODE are childs of
1059 * CONFIG_NODE */
1060 while (vty->node > CONFIG_NODE) {
dd2c81b8
DL
1061 struct cmd_node *cnode = vector_slot(cmdvec, try_node);
1062
d62a17ae 1063 try_node = node_parent(try_node);
1064 vty->node = try_node;
dd2c81b8 1065 if (vty->xpath_index > 0 && !cnode->no_xpath)
1c2facd1 1066 vty->xpath_index--;
dd2c81b8 1067
d62a17ae 1068 ret = cmd_execute_command_real(vline, FILTER_RELAXED,
e3476061 1069 vty, cmd, 0);
825d5fbf 1070 if (ret == CMD_SUCCESS || ret == CMD_WARNING
4bb7f7c2 1071 || ret == CMD_ERR_AMBIGUOUS || ret == CMD_ERR_INCOMPLETE
825d5fbf
CS
1072 || ret == CMD_NOT_MY_INSTANCE
1073 || ret == CMD_WARNING_CONFIG_FAILED)
d62a17ae 1074 return ret;
1075 }
1076 /* no command succeeded, reset the vty to the original node */
1077 vty->node = onode;
1c2facd1 1078 vty->xpath_index = orig_xpath_index;
d62a17ae 1079 }
04e64062 1080
d62a17ae 1081 /* return command status for original node */
1082 return saved_ret;
b92938a7 1083}
1084
cd40b329
CF
1085/**
1086 * Execute a given command, matching it strictly against the current node.
1087 * This mode is used when reading config files.
1088 *
1089 * @param vline Command line input, vector of char* where each element is
1090 * one input token.
1091 * @param vty The vty context in which the command should be executed.
1092 * @param cmd Pointer where the struct cmd_element* of the matched command
1093 * will be stored, if any. May be set to NULL if this info is
1094 * not needed.
1095 * @return The status of the command that has been executed or an error code
1096 * as to why no command could be executed.
1097 */
d62a17ae 1098int cmd_execute_command_strict(vector vline, struct vty *vty,
1099 const struct cmd_element **cmd)
718e3744 1100{
e3476061 1101 return cmd_execute_command_real(vline, FILTER_STRICT, vty, cmd, 0);
718e3744 1102}
1103
01e24c4a
QY
1104/*
1105 * Hook for preprocessing command string before executing.
1106 *
1107 * All subscribers are called with the raw command string that is to be
1108 * executed. If any changes are to be made, a new string should be allocated
1109 * with MTYPE_TMP and *cmd_out updated to point to this new string. The caller
1110 * is then responsible for freeing this string.
1111 *
1112 * All processing functions must be mutually exclusive in their action, i.e. if
1113 * one subscriber decides to modify the command, all others must not modify it
1114 * when called. Feeding the output of one processing command into a subsequent
1115 * one is not supported.
1116 *
1117 * This hook is intentionally internal to the command processing system.
1118 *
1119 * cmd_in
1120 * The raw command string.
1121 *
1122 * cmd_out
1123 * The result of any processing.
1124 */
1125DECLARE_HOOK(cmd_execute,
0a334343 1126 (struct vty *vty, const char *cmd_in, char **cmd_out),
01e24c4a 1127 (vty, cmd_in, cmd_out));
0a334343 1128DEFINE_HOOK(cmd_execute, (struct vty *vty, const char *cmd_in, char **cmd_out),
01e24c4a
QY
1129 (vty, cmd_in, cmd_out));
1130
1131/* Hook executed after a CLI command. */
0a334343 1132DECLARE_KOOH(cmd_execute_done, (struct vty *vty, const char *cmd_exec),
01e24c4a 1133 (vty, cmd_exec));
0a334343 1134DEFINE_KOOH(cmd_execute_done, (struct vty *vty, const char *cmd_exec),
01e24c4a
QY
1135 (vty, cmd_exec));
1136
fe6b47b9
QY
1137/*
1138 * cmd_execute hook subscriber to handle `|` actions.
1139 */
1140static int handle_pipe_action(struct vty *vty, const char *cmd_in,
1141 char **cmd_out)
1142{
1143 /* look for `|` */
9f227e4c 1144 char *orig, *working, *token, *u;
fe6b47b9 1145 char *pipe = strstr(cmd_in, "| ");
2f272cb4 1146 int ret = 0;
fe6b47b9
QY
1147
1148 if (!pipe)
1149 return 0;
1150
1151 /* duplicate string for processing purposes, not including pipe */
1152 orig = working = XSTRDUP(MTYPE_TMP, pipe + 2);
1153
1154 /* retrieve action */
1155 token = strsep(&working, " ");
4f4060f6 1156 assert(token);
fe6b47b9
QY
1157
1158 /* match result to known actions */
1159 if (strmatch(token, "include")) {
1160 /* the remaining text should be a regexp */
1161 char *regexp = working;
5d806ec6
QY
1162
1163 if (!regexp) {
1164 vty_out(vty, "%% Need a regexp to filter with\n");
2f272cb4 1165 ret = 1;
5d806ec6
QY
1166 goto fail;
1167 }
1168
fe6b47b9 1169 bool succ = vty_set_include(vty, regexp);
0a334343 1170
fe6b47b9 1171 if (!succ) {
5d806ec6 1172 vty_out(vty, "%% Bad regexp '%s'\n", regexp);
2f272cb4 1173 ret = 1;
fe6b47b9
QY
1174 goto fail;
1175 }
2cddf2ff 1176 *cmd_out = XSTRDUP(MTYPE_TMP, cmd_in);
9f227e4c 1177 u = *cmd_out;
1178 strsep(&u, "|");
fe6b47b9 1179 } else {
5d806ec6 1180 vty_out(vty, "%% Unknown action '%s'\n", token);
2f272cb4 1181 ret = 1;
fe6b47b9
QY
1182 goto fail;
1183 }
1184
1185fail:
1186 XFREE(MTYPE_TMP, orig);
2f272cb4 1187 return ret;
fe6b47b9
QY
1188}
1189
1190static int handle_pipe_action_done(struct vty *vty, const char *cmd_exec)
1191{
0b42d81a 1192 if (vty->filter)
fe6b47b9 1193 vty_set_include(vty, NULL);
0b42d81a 1194
fe6b47b9
QY
1195 return 0;
1196}
1197
01e24c4a
QY
1198int cmd_execute(struct vty *vty, const char *cmd,
1199 const struct cmd_element **matched, int vtysh)
1200{
1201 int ret;
1202 char *cmd_out = NULL;
2f272cb4 1203 const char *cmd_exec = NULL;
01e24c4a
QY
1204 vector vline;
1205
2f272cb4
IR
1206 ret = hook_call(cmd_execute, vty, cmd, &cmd_out);
1207 if (ret) {
1208 ret = CMD_WARNING;
1209 goto free;
1210 }
1211
01e24c4a
QY
1212 cmd_exec = cmd_out ? (const char *)cmd_out : cmd;
1213
1214 vline = cmd_make_strvec(cmd_exec);
1215
1216 if (vline) {
1217 ret = cmd_execute_command(vline, vty, matched, vtysh);
1218 cmd_free_strvec(vline);
1219 } else {
1220 ret = CMD_SUCCESS;
1221 }
1222
2f272cb4 1223free:
01e24c4a
QY
1224 hook_call(cmd_execute_done, vty, cmd_exec);
1225
0a22ddfb 1226 XFREE(MTYPE_TMP, cmd_out);
01e24c4a
QY
1227
1228 return ret;
1229}
1230
1231
bed578b8 1232/**
d62a17ae 1233 * Parse one line of config, walking up the parse tree attempting to find a
1234 * match
bed578b8
DS
1235 *
1236 * @param vty The vty context in which the command should be executed.
1237 * @param cmd Pointer where the struct cmd_element* of the match command
1238 * will be stored, if any. May be set to NULL if this info is
1239 * not needed.
d62a17ae 1240 * @param use_daemon Boolean to control whether or not we match on
1241 * CMD_SUCCESS_DAEMON
bed578b8
DS
1242 * or not.
1243 * @return The status of the command that has been executed or an error code
1244 * as to why no command could be executed.
1245 */
d62a17ae 1246int command_config_read_one_line(struct vty *vty,
7ab57d19
DS
1247 const struct cmd_element **cmd,
1248 uint32_t line_num, int use_daemon)
bed578b8 1249{
d62a17ae 1250 vector vline;
d62a17ae 1251 int ret;
e3476061 1252 unsigned up_level = 0;
bed578b8 1253
d62a17ae 1254 vline = cmd_make_strvec(vty->buf);
bed578b8 1255
d62a17ae 1256 /* In case of comment line */
1257 if (vline == NULL)
1258 return CMD_SUCCESS;
bed578b8 1259
d62a17ae 1260 /* Execute configuration command : this is strict match */
1261 ret = cmd_execute_command_strict(vline, vty, cmd);
bed578b8 1262
e3476061
DL
1263 /* The logic for trying parent nodes is in cmd_execute_command_real()
1264 * since calling ->node_exit() correctly is a bit involved. This is
1265 * also the only reason CMD_NO_LEVEL_UP exists.
1266 */
1267 while (!(use_daemon && ret == CMD_SUCCESS_DAEMON)
1268 && !(!use_daemon && ret == CMD_ERR_NOTHING_TODO)
1269 && ret != CMD_SUCCESS && ret != CMD_WARNING
4bb7f7c2 1270 && ret != CMD_ERR_AMBIGUOUS && ret != CMD_ERR_INCOMPLETE
e3476061
DL
1271 && ret != CMD_NOT_MY_INSTANCE && ret != CMD_WARNING_CONFIG_FAILED
1272 && ret != CMD_NO_LEVEL_UP)
1273 ret = cmd_execute_command_real(vline, FILTER_STRICT, vty, cmd,
1274 ++up_level);
1275
1276 if (ret == CMD_NO_LEVEL_UP)
1277 ret = CMD_ERR_NO_MATCH;
bed578b8 1278
b45d8ccc
DS
1279 if (ret != CMD_SUCCESS &&
1280 ret != CMD_WARNING &&
1281 ret != CMD_SUCCESS_DAEMON) {
7ab57d19
DS
1282 struct vty_error *ve = XCALLOC(MTYPE_TMP, sizeof(*ve));
1283
1284 memcpy(ve->error_buf, vty->buf, VTY_BUFSIZ);
1285 ve->line_num = line_num;
1286 if (!vty->error)
1287 vty->error = list_new();
1288
1289 listnode_add(vty->error, ve);
1290 }
cbd7259d 1291
d62a17ae 1292 cmd_free_strvec(vline);
bed578b8 1293
d62a17ae 1294 return ret;
bed578b8
DS
1295}
1296
5689fe5f 1297/* Configuration make from file. */
d62a17ae 1298int config_from_file(struct vty *vty, FILE *fp, unsigned int *line_num)
718e3744 1299{
d62a17ae 1300 int ret, error_ret = 0;
1301 *line_num = 0;
718e3744 1302
d62a17ae 1303 while (fgets(vty->buf, VTY_BUFSIZ, fp)) {
7ab57d19 1304 ++(*line_num);
13fbc82d 1305
7ab57d19 1306 ret = command_config_read_one_line(vty, NULL, *line_num, 0);
718e3744 1307
d62a17ae 1308 if (ret != CMD_SUCCESS && ret != CMD_WARNING
1309 && ret != CMD_ERR_NOTHING_TODO)
1310 error_ret = ret;
1311 }
5689fe5f 1312
d62a17ae 1313 if (error_ret) {
1314 return error_ret;
1315 }
5689fe5f 1316
d62a17ae 1317 return CMD_SUCCESS;
718e3744 1318}
1319
5689fe5f 1320/* Configuration from terminal */
718e3744 1321DEFUN (config_terminal,
1322 config_terminal_cmd,
dc1c13c0 1323 "configure [terminal]",
718e3744 1324 "Configuration from vty interface\n"
1325 "Configuration terminal\n")
1326{
f344c66e 1327 return vty_config_enter(vty, false, false);
718e3744 1328}
1329
1330/* Enable command */
d0bfb22c 1331DEFUN (enable,
718e3744 1332 config_enable_cmd,
1333 "enable",
1334 "Turn on privileged mode command\n")
1335{
d62a17ae 1336 /* If enable password is NULL, change to ENABLE_NODE */
1337 if ((host.enable == NULL && host.enable_encrypt == NULL)
1338 || vty->type == VTY_SHELL_SERV)
1339 vty->node = ENABLE_NODE;
1340 else
1341 vty->node = AUTH_ENABLE_NODE;
718e3744 1342
d62a17ae 1343 return CMD_SUCCESS;
718e3744 1344}
1345
1346/* Disable command */
d0bfb22c 1347DEFUN (disable,
718e3744 1348 config_disable_cmd,
1349 "disable",
1350 "Turn off privileged mode command\n")
1351{
d62a17ae 1352 if (vty->node == ENABLE_NODE)
1353 vty->node = VIEW_NODE;
1354 return CMD_SUCCESS;
718e3744 1355}
1356
1357/* Down vty node level. */
1358DEFUN (config_exit,
1359 config_exit_cmd,
1360 "exit",
1361 "Exit current mode and down to previous mode\n")
0b84f294 1362{
d62a17ae 1363 cmd_exit(vty);
1364 return CMD_SUCCESS;
1365}
1366
791ded4a
DL
1367static int root_on_exit(struct vty *vty)
1368{
1369 if (vty_shell(vty))
1370 exit(0);
1371 else
1372 vty->status = VTY_CLOSE;
1373 return 0;
1374}
1375
d62a17ae 1376void cmd_exit(struct vty *vty)
1377{
24389580 1378 struct cmd_node *cnode = vector_lookup(cmdvec, vty->node);
1c2facd1 1379
791ded4a
DL
1380 if (cnode->node_exit) {
1381 if (!cnode->node_exit(vty))
1382 return;
d62a17ae 1383 }
791ded4a
DL
1384 if (cnode->parent_node)
1385 vty->node = cnode->parent_node;
dd2c81b8 1386 if (vty->xpath_index > 0 && !cnode->no_xpath)
1c2facd1 1387 vty->xpath_index--;
718e3744 1388}
1389
f667a580
QY
1390/* ALIAS_FIXME */
1391DEFUN (config_quit,
1392 config_quit_cmd,
1393 "quit",
1394 "Exit current mode and down to previous mode\n")
1395{
d62a17ae 1396 return config_exit(self, vty, argc, argv);
f667a580
QY
1397}
1398
d0bfb22c 1399
718e3744 1400/* End of configuration. */
1401DEFUN (config_end,
1402 config_end_cmd,
1403 "end",
efd7904e 1404 "End current mode and change to enable mode.\n")
718e3744 1405{
cf09d3ca 1406 if (vty->config) {
f344c66e 1407 vty_config_exit(vty);
d62a17ae 1408 vty->node = ENABLE_NODE;
d62a17ae 1409 }
1410 return CMD_SUCCESS;
718e3744 1411}
1412
1413/* Show version. */
1414DEFUN (show_version,
1415 show_version_cmd,
1416 "show version",
1417 SHOW_STR
1418 "Displays zebra version\n")
1419{
46b48b33
DS
1420 vty_out(vty, "%s %s (%s) on %s(%s).\n", FRR_FULL_NAME, FRR_VERSION,
1421 cmd_hostname_get() ? cmd_hostname_get() : "", cmd_system_get(),
1422 cmd_release_get());
d62a17ae 1423 vty_out(vty, "%s%s\n", FRR_COPYRIGHT, GIT_INFO);
e063f271 1424#ifdef ENABLE_VERSION_BUILD_CONFIG
d62a17ae 1425 vty_out(vty, "configured with:\n %s\n", FRR_CONFIG_ARGS);
e063f271 1426#endif
d62a17ae 1427 return CMD_SUCCESS;
718e3744 1428}
1429
1430/* Help display function for all node. */
1431DEFUN (config_help,
1432 config_help_cmd,
1433 "help",
1434 "Description of the interactive help system\n")
1435{
d62a17ae 1436 vty_out(vty,
1437 "Quagga VTY provides advanced help feature. When you need help,\n\
61b7d449
DL
1438anytime at the command line please press '?'.\n\
1439\n\
1440If nothing matches, the help list will be empty and you must backup\n\
1441 until entering a '?' shows the available options.\n\
1442Two styles of help are provided:\n\
14431. Full help is available when you are ready to enter a\n\
1444command argument (e.g. 'show ?') and describes each possible\n\
1445argument.\n\
14462. Partial help is provided when an abbreviated argument is entered\n\
1447 and you want to know what arguments match the input\n\
1448 (e.g. 'show me?'.)\n\n");
d62a17ae 1449 return CMD_SUCCESS;
1450}
1451
1452static void permute(struct graph_node *start, struct vty *vty)
1453{
1454 static struct list *position = NULL;
1455 if (!position)
1456 position = list_new();
1457
1458 struct cmd_token *stok = start->data;
1459 struct graph_node *gnn;
1460 struct listnode *ln;
1461
1462 // recursive dfs
1463 listnode_add(position, start);
1464 for (unsigned int i = 0; i < vector_active(start->to); i++) {
1465 struct graph_node *gn = vector_slot(start->to, i);
1466 struct cmd_token *tok = gn->data;
9eebf97e 1467 if (tok->attr & CMD_ATTR_HIDDEN)
d62a17ae 1468 continue;
1469 else if (tok->type == END_TKN || gn == start) {
1470 vty_out(vty, " ");
1471 for (ALL_LIST_ELEMENTS_RO(position, ln, gnn)) {
1472 struct cmd_token *tt = gnn->data;
1473 if (tt->type < SPECIAL_TKN)
1474 vty_out(vty, " %s", tt->text);
1475 }
1476 if (gn == start)
1477 vty_out(vty, "...");
1478 vty_out(vty, "\n");
1479 } else {
1480 bool skip = false;
1481 if (stok->type == FORK_TKN && tok->type != FORK_TKN)
1482 for (ALL_LIST_ELEMENTS_RO(position, ln, gnn))
1483 if (gnn == gn) {
1484 skip = true;
1485 break;
1486 }
1487 if (!skip)
1488 permute(gn, vty);
1489 }
1490 }
1491 list_delete_node(position, listtail(position));
1492}
1493
5b96d81c
IR
1494static void print_cmd(struct vty *vty, const char *cmd)
1495{
1496 int i, j, len = strlen(cmd);
77af3a34 1497 char buf[len + 1];
5b96d81c
IR
1498 bool skip = false;
1499
1500 j = 0;
1501 for (i = 0; i < len; i++) {
1502 /* skip varname */
1503 if (cmd[i] == '$')
1504 skip = true;
1505 else if (strchr(" ()<>[]{}|", cmd[i]))
1506 skip = false;
1507
1508 if (skip)
1509 continue;
1510
1511 if (isspace(cmd[i])) {
1512 /* skip leading whitespace */
1513 if (i == 0)
1514 continue;
1515 /* skip trailing whitespace */
1516 if (i == len - 1)
1517 continue;
1518 /* skip all whitespace after opening brackets or pipe */
1519 if (strchr("(<[{|", cmd[i - 1])) {
1520 while (isspace(cmd[i + 1]))
1521 i++;
1522 continue;
1523 }
1524 /* skip repeated whitespace */
1525 if (isspace(cmd[i + 1]))
1526 continue;
1527 /* skip whitespace before closing brackets or pipe */
1528 if (strchr(")>]}|", cmd[i + 1]))
1529 continue;
1530 /* convert tabs to spaces */
1531 if (cmd[i] == '\t') {
1532 buf[j++] = ' ';
1533 continue;
1534 }
1535 }
1536
1537 buf[j++] = cmd[i];
1538 }
1539 buf[j] = 0;
1540
1541 vty_out(vty, "%s\n", buf);
1542}
1543
d62a17ae 1544int cmd_list_cmds(struct vty *vty, int do_permute)
1545{
1546 struct cmd_node *node = vector_slot(cmdvec, vty->node);
1547
0e06eb8b
DL
1548 if (do_permute) {
1549 cmd_finalize_node(node);
d62a17ae 1550 permute(vector_slot(node->cmdgraph->nodes, 0), vty);
0e06eb8b 1551 } else {
d62a17ae 1552 /* loop over all commands at this node */
154e9ca1 1553 const struct cmd_element *element = NULL;
d62a17ae 1554 for (unsigned int i = 0; i < vector_active(node->cmd_vector);
1555 i++)
9eebf97e
DL
1556 if ((element = vector_slot(node->cmd_vector, i)) &&
1557 !(element->attr & CMD_ATTR_HIDDEN)) {
5b96d81c
IR
1558 vty_out(vty, " ");
1559 print_cmd(vty, element->string);
1560 }
d62a17ae 1561 }
1562 return CMD_SUCCESS;
718e3744 1563}
1564
0b84f294
DL
1565/* Help display function for all node. */
1566DEFUN (config_list,
1567 config_list_cmd,
1568 "list [permutations]",
1569 "Print command list\n"
1570 "Print all possible command permutations\n")
1571{
d62a17ae 1572 return cmd_list_cmds(vty, argc == 2);
0b84f294
DL
1573}
1574
a2454870
QY
1575DEFUN (show_commandtree,
1576 show_commandtree_cmd,
1577 "show commandtree [permutations]",
1578 SHOW_STR
5a1945e4
DS
1579 "Show command tree\n"
1580 "Permutations that we are interested in\n")
a2454870 1581{
d62a17ae 1582 return cmd_list_cmds(vty, argc == 3);
a2454870
QY
1583}
1584
26fbe472
QY
1585DEFUN_HIDDEN(show_cli_graph,
1586 show_cli_graph_cmd,
1587 "show cli graph",
1588 SHOW_STR
1589 "CLI reflection\n"
1590 "Dump current command space as DOT graph\n")
1591{
1592 struct cmd_node *cn = vector_slot(cmdvec, vty->node);
0e06eb8b
DL
1593 char *dot;
1594
1595 cmd_finalize_node(cn);
1596 dot = cmd_graph_dump_dot(cn->cmdgraph);
26fbe472
QY
1597
1598 vty_out(vty, "%s\n", dot);
1599 XFREE(MTYPE_TMP, dot);
1600 return CMD_SUCCESS;
1601}
1602
f806f29c 1603static int vty_write_config(struct vty *vty)
8efe88ea 1604{
d62a17ae 1605 size_t i;
1606 struct cmd_node *node;
8efe88ea 1607
f806f29c 1608 if (host.noconfig)
1609 return CMD_SUCCESS;
1610
5e6a9350
RW
1611 nb_cli_show_config_prepare(running_config, false);
1612
d62a17ae 1613 if (vty->type == VTY_TERM) {
1614 vty_out(vty, "\nCurrent configuration:\n");
1615 vty_out(vty, "!\n");
1616 }
8efe88ea 1617
ac4adef4
DL
1618 if (strcmp(frr_defaults_version(), FRR_VER_SHORT))
1619 vty_out(vty, "! loaded from %s\n", frr_defaults_version());
d62a17ae 1620 vty_out(vty, "frr version %s\n", FRR_VER_SHORT);
ac4adef4 1621 vty_out(vty, "frr defaults %s\n", frr_defaults_profile());
d62a17ae 1622 vty_out(vty, "!\n");
8efe88ea 1623
8685be73 1624 for (i = 0; i < vector_active(cmdvec); i++)
612c2c15
DL
1625 if ((node = vector_slot(cmdvec, i)) && node->config_write) {
1626 if ((*node->config_write)(vty))
8685be73
RW
1627 vty_out(vty, "!\n");
1628 }
8efe88ea 1629
d62a17ae 1630 if (vty->type == VTY_TERM) {
1631 vty_out(vty, "end\n");
1632 }
8efe88ea 1633
f806f29c 1634 return CMD_SUCCESS;
1635}
d862bffb 1636
f806f29c 1637static int file_write_config(struct vty *vty)
718e3744 1638{
d62a17ae 1639 int fd, dirfd;
1640 char *config_file, *slash;
1641 char *config_file_tmp = NULL;
1642 char *config_file_sav = NULL;
1643 int ret = CMD_WARNING;
1644 struct vty *file_vty;
1645 struct stat conf_stat;
1646
d62a17ae 1647 if (host.noconfig)
1648 return CMD_SUCCESS;
1649
1650 /* Check and see if we are operating under vtysh configuration */
1651 if (host.config == NULL) {
1652 vty_out(vty,
1653 "Can't save to configuration file, using vtysh.\n");
1654 return CMD_WARNING;
1655 }
1656
1657 /* Get filename. */
1658 config_file = host.config;
d0bfb22c 1659
056cfe49
DL
1660#ifndef O_DIRECTORY
1661#define O_DIRECTORY 0
1662#endif
d62a17ae 1663 slash = strrchr(config_file, '/');
1664 if (slash) {
1665 char *config_dir = XSTRDUP(MTYPE_TMP, config_file);
1666 config_dir[slash - config_file] = '\0';
1667 dirfd = open(config_dir, O_DIRECTORY | O_RDONLY);
1668 XFREE(MTYPE_TMP, config_dir);
1669 } else
1670 dirfd = open(".", O_DIRECTORY | O_RDONLY);
1671 /* if dirfd is invalid, directory sync fails, but we're still OK */
1672
9f73d2c9
QY
1673 size_t config_file_sav_sz = strlen(config_file) + strlen(CONF_BACKUP_EXT) + 1;
1674 config_file_sav = XMALLOC(MTYPE_TMP, config_file_sav_sz);
1675 strlcpy(config_file_sav, config_file, config_file_sav_sz);
1676 strlcat(config_file_sav, CONF_BACKUP_EXT, config_file_sav_sz);
d62a17ae 1677
1678
1679 config_file_tmp = XMALLOC(MTYPE_TMP, strlen(config_file) + 8);
fc746f1c
QY
1680 snprintf(config_file_tmp, strlen(config_file) + 8, "%s.XXXXXX",
1681 config_file);
d62a17ae 1682
1683 /* Open file to configuration write. */
1684 fd = mkstemp(config_file_tmp);
1685 if (fd < 0) {
1686 vty_out(vty, "Can't open configuration file %s.\n",
1687 config_file_tmp);
1688 goto finished;
1689 }
1690 if (fchmod(fd, CONFIGFILE_MASK) != 0) {
1691 vty_out(vty, "Can't chmod configuration file %s: %s (%d).\n",
1692 config_file_tmp, safe_strerror(errno), errno);
1693 goto finished;
1694 }
1695
1696 /* Make vty for configuration file. */
1697 file_vty = vty_new();
1698 file_vty->wfd = fd;
1699 file_vty->type = VTY_FILE;
1700
1701 /* Config file header print. */
1702 vty_out(file_vty, "!\n! Zebra configuration saved from vty\n! ");
1703 vty_time_print(file_vty, 1);
1704 vty_out(file_vty, "!\n");
1705 vty_write_config(file_vty);
1706 vty_close(file_vty);
1707
1708 if (stat(config_file, &conf_stat) >= 0) {
1709 if (unlink(config_file_sav) != 0)
1710 if (errno != ENOENT) {
1711 vty_out(vty,
1712 "Can't unlink backup configuration file %s.\n",
1713 config_file_sav);
1714 goto finished;
1715 }
1716 if (link(config_file, config_file_sav) != 0) {
1717 vty_out(vty,
1718 "Can't backup old configuration file %s.\n",
1719 config_file_sav);
1720 goto finished;
1721 }
1722 if (dirfd >= 0)
1723 fsync(dirfd);
1724 }
1725 if (rename(config_file_tmp, config_file) != 0) {
1726 vty_out(vty, "Can't save configuration file %s.\n",
1727 config_file);
1728 goto finished;
1729 }
1730 if (dirfd >= 0)
1731 fsync(dirfd);
1732
1733 vty_out(vty, "Configuration saved to %s\n", config_file);
1734 ret = CMD_SUCCESS;
05865c90 1735
1736finished:
d62a17ae 1737 if (ret != CMD_SUCCESS)
1738 unlink(config_file_tmp);
1739 if (dirfd >= 0)
1740 close(dirfd);
1741 XFREE(MTYPE_TMP, config_file_tmp);
1742 XFREE(MTYPE_TMP, config_file_sav);
1743 return ret;
718e3744 1744}
1745
f806f29c 1746/* Write current configuration into file. */
1747
1748DEFUN (config_write,
1749 config_write_cmd,
1750 "write [<file|memory|terminal>]",
1751 "Write running configuration to memory, network, or terminal\n"
1752 "Write to configuration file\n"
1753 "Write configuration currently in memory\n"
1754 "Write configuration to terminal\n")
1755{
1756 const int idx_type = 1;
1757
1758 // if command was 'write terminal' or 'write memory'
1759 if (argc == 2 && (!strcmp(argv[idx_type]->text, "terminal"))) {
1760 return vty_write_config(vty);
1761 }
1762
1763 return file_write_config(vty);
1764}
1765
d862bffb
QY
1766/* ALIAS_FIXME for 'write <terminal|memory>' */
1767DEFUN (show_running_config,
1768 show_running_config_cmd,
1769 "show running-config",
1770 SHOW_STR
f806f29c 1771 "running configuration (same as write terminal)\n")
d862bffb 1772{
f806f29c 1773 return vty_write_config(vty);
d862bffb 1774}
718e3744 1775
d862bffb
QY
1776/* ALIAS_FIXME for 'write file' */
1777DEFUN (copy_runningconf_startupconf,
1778 copy_runningconf_startupconf_cmd,
1779 "copy running-config startup-config",
1780 "Copy configuration\n"
1781 "Copy running config to... \n"
f806f29c 1782 "Copy running config to startup config (same as write file/memory)\n")
d862bffb 1783{
f806f29c 1784 return file_write_config(vty);
d862bffb
QY
1785}
1786/** -- **/
718e3744 1787
1788/* Write startup configuration into the terminal. */
1789DEFUN (show_startup_config,
1790 show_startup_config_cmd,
1791 "show startup-config",
1792 SHOW_STR
d0bfb22c 1793 "Contents of startup configuration\n")
718e3744 1794{
d62a17ae 1795 char buf[BUFSIZ];
1796 FILE *confp;
718e3744 1797
d62a17ae 1798 if (host.noconfig)
1799 return CMD_SUCCESS;
1800 if (host.config == NULL)
1801 return CMD_WARNING;
87f44e2f 1802
d62a17ae 1803 confp = fopen(host.config, "r");
1804 if (confp == NULL) {
1805 vty_out(vty, "Can't open configuration file [%s] due to '%s'\n",
1806 host.config, safe_strerror(errno));
1807 return CMD_WARNING;
1808 }
718e3744 1809
d62a17ae 1810 while (fgets(buf, BUFSIZ, confp)) {
1811 char *cp = buf;
718e3744 1812
d62a17ae 1813 while (*cp != '\r' && *cp != '\n' && *cp != '\0')
1814 cp++;
1815 *cp = '\0';
718e3744 1816
d62a17ae 1817 vty_out(vty, "%s\n", buf);
1818 }
718e3744 1819
d62a17ae 1820 fclose(confp);
718e3744 1821
d62a17ae 1822 return CMD_SUCCESS;
718e3744 1823}
1824
6b3ee3a0
MK
1825int cmd_domainname_set(const char *domainname)
1826{
1827 XFREE(MTYPE_HOST, host.domainname);
1828 host.domainname = domainname ? XSTRDUP(MTYPE_HOST, domainname) : NULL;
1829 return CMD_SUCCESS;
1830}
1831
1832/* Hostname configuration */
60466a63
QY
1833DEFUN(config_domainname,
1834 domainname_cmd,
1835 "domainname WORD",
1836 "Set system's domain name\n"
1837 "This system's domain name\n")
6b3ee3a0
MK
1838{
1839 struct cmd_token *word = argv[1];
1840
fefa5e0f 1841 if (!isalpha((unsigned char)word->arg[0])) {
6b3ee3a0
MK
1842 vty_out(vty, "Please specify string starting with alphabet\n");
1843 return CMD_WARNING_CONFIG_FAILED;
1844 }
1845
1846 return cmd_domainname_set(word->arg);
1847}
1848
60466a63
QY
1849DEFUN(config_no_domainname,
1850 no_domainname_cmd,
1851 "no domainname [DOMAINNAME]",
1852 NO_STR
1853 "Reset system's domain name\n"
1854 "domain name of this router\n")
6b3ee3a0
MK
1855{
1856 return cmd_domainname_set(NULL);
1857}
1858
d62a17ae 1859int cmd_hostname_set(const char *hostname)
bff9c3e9 1860{
d62a17ae 1861 XFREE(MTYPE_HOST, host.name);
1862 host.name = hostname ? XSTRDUP(MTYPE_HOST, hostname) : NULL;
1863 return CMD_SUCCESS;
bff9c3e9
DL
1864}
1865
718e3744 1866/* Hostname configuration */
d0bfb22c 1867DEFUN (config_hostname,
718e3744 1868 hostname_cmd,
1869 "hostname WORD",
1870 "Set system's network name\n"
1871 "This system's network name\n")
1872{
d62a17ae 1873 struct cmd_token *word = argv[1];
d0bfb22c 1874
fefa5e0f 1875 if (!isalnum((unsigned char)word->arg[0])) {
63e653a2
LK
1876 vty_out(vty,
1877 "Please specify string starting with alphabet or number\n");
1878 return CMD_WARNING_CONFIG_FAILED;
1879 }
1880
1881 /* With reference to RFC 1123 Section 2.1 */
1882 if (strlen(word->arg) > HOSTNAME_LEN) {
1883 vty_out(vty, "Hostname length should be less than %d chars\n",
1884 HOSTNAME_LEN);
d62a17ae 1885 return CMD_WARNING_CONFIG_FAILED;
1886 }
718e3744 1887
d62a17ae 1888 return cmd_hostname_set(word->arg);
718e3744 1889}
1890
d0bfb22c 1891DEFUN (config_no_hostname,
718e3744 1892 no_hostname_cmd,
1893 "no hostname [HOSTNAME]",
1894 NO_STR
1895 "Reset system's network name\n"
1896 "Host name of this router\n")
1897{
d62a17ae 1898 return cmd_hostname_set(NULL);
718e3744 1899}
1900
1901/* VTY interface password set. */
f412b39a
DW
1902DEFUN (config_password,
1903 password_cmd,
98463e0a 1904 "password [(8-8)] WORD",
322e2d5c 1905 "Modify the terminal connection password\n"
718e3744 1906 "Specifies a HIDDEN password will follow\n"
d0bfb22c 1907 "The password string\n")
718e3744 1908{
d62a17ae 1909 int idx_8 = 1;
1910 int idx_word = 2;
1911 if (argc == 3) // '8' was specified
1912 {
1913 if (host.password)
1914 XFREE(MTYPE_HOST, host.password);
1915 host.password = NULL;
1916 if (host.password_encrypt)
1917 XFREE(MTYPE_HOST, host.password_encrypt);
1918 host.password_encrypt =
1919 XSTRDUP(MTYPE_HOST, argv[idx_word]->arg);
1920 return CMD_SUCCESS;
1921 }
1922
fefa5e0f 1923 if (!isalnum((unsigned char)argv[idx_8]->arg[0])) {
d62a17ae 1924 vty_out(vty,
1925 "Please specify string starting with alphanumeric\n");
1926 return CMD_WARNING_CONFIG_FAILED;
1927 }
1928
1929 if (host.password)
1930 XFREE(MTYPE_HOST, host.password);
1931 host.password = NULL;
1932
1933 if (host.encrypt) {
1934 if (host.password_encrypt)
1935 XFREE(MTYPE_HOST, host.password_encrypt);
1936 host.password_encrypt =
1937 XSTRDUP(MTYPE_HOST, zencrypt(argv[idx_8]->arg));
1938 } else
1939 host.password = XSTRDUP(MTYPE_HOST, argv[idx_8]->arg);
1940
1941 return CMD_SUCCESS;
718e3744 1942}
1943
322e2d5c
PM
1944/* VTY interface password delete. */
1945DEFUN (no_config_password,
1946 no_password_cmd,
1947 "no password",
1948 NO_STR
1949 "Modify the terminal connection password\n")
1950{
1951 bool warned = false;
1952
1953 if (host.password) {
eb83f7ce 1954 if (!vty_shell_serv(vty)) {
4911ca9c 1955 vty_out(vty, NO_PASSWD_CMD_WARNING);
eb83f7ce
PM
1956 warned = true;
1957 }
322e2d5c
PM
1958 XFREE(MTYPE_HOST, host.password);
1959 }
1960 host.password = NULL;
1961
1962 if (host.password_encrypt) {
eb83f7ce 1963 if (!warned && !vty_shell_serv(vty))
4911ca9c 1964 vty_out(vty, NO_PASSWD_CMD_WARNING);
322e2d5c
PM
1965 XFREE(MTYPE_HOST, host.password_encrypt);
1966 }
1967 host.password_encrypt = NULL;
1968
1969 return CMD_SUCCESS;
1970}
1971
718e3744 1972/* VTY enable password set. */
f412b39a
DW
1973DEFUN (config_enable_password,
1974 enable_password_cmd,
98463e0a 1975 "enable password [(8-8)] WORD",
718e3744 1976 "Modify enable password parameters\n"
1977 "Assign the privileged level password\n"
1978 "Specifies a HIDDEN password will follow\n"
718e3744 1979 "The HIDDEN 'enable' password string\n")
1980{
d62a17ae 1981 int idx_8 = 2;
1982 int idx_word = 3;
1983
1984 /* Crypt type is specified. */
1985 if (argc == 4) {
1986 if (argv[idx_8]->arg[0] == '8') {
1987 if (host.enable)
1988 XFREE(MTYPE_HOST, host.enable);
1989 host.enable = NULL;
1990
1991 if (host.enable_encrypt)
1992 XFREE(MTYPE_HOST, host.enable_encrypt);
1993 host.enable_encrypt =
1994 XSTRDUP(MTYPE_HOST, argv[idx_word]->arg);
1995
1996 return CMD_SUCCESS;
1997 } else {
1998 vty_out(vty, "Unknown encryption type.\n");
1999 return CMD_WARNING_CONFIG_FAILED;
2000 }
2001 }
2002
fefa5e0f 2003 if (!isalnum((unsigned char)argv[idx_8]->arg[0])) {
d62a17ae 2004 vty_out(vty,
2005 "Please specify string starting with alphanumeric\n");
2006 return CMD_WARNING_CONFIG_FAILED;
2007 }
2008
2009 if (host.enable)
2010 XFREE(MTYPE_HOST, host.enable);
2011 host.enable = NULL;
2012
2013 /* Plain password input. */
2014 if (host.encrypt) {
2015 if (host.enable_encrypt)
2016 XFREE(MTYPE_HOST, host.enable_encrypt);
2017 host.enable_encrypt =
2018 XSTRDUP(MTYPE_HOST, zencrypt(argv[idx_8]->arg));
2019 } else
2020 host.enable = XSTRDUP(MTYPE_HOST, argv[idx_8]->arg);
2021
2022 return CMD_SUCCESS;
718e3744 2023}
2024
718e3744 2025/* VTY enable password delete. */
f412b39a
DW
2026DEFUN (no_config_enable_password,
2027 no_enable_password_cmd,
718e3744 2028 "no enable password",
2029 NO_STR
2030 "Modify enable password parameters\n"
2031 "Assign the privileged level password\n")
2032{
322e2d5c
PM
2033 bool warned = false;
2034
2035 if (host.enable) {
eb83f7ce 2036 if (!vty_shell_serv(vty)) {
4911ca9c 2037 vty_out(vty, NO_PASSWD_CMD_WARNING);
eb83f7ce
PM
2038 warned = true;
2039 }
d62a17ae 2040 XFREE(MTYPE_HOST, host.enable);
322e2d5c 2041 }
d62a17ae 2042 host.enable = NULL;
718e3744 2043
322e2d5c 2044 if (host.enable_encrypt) {
eb83f7ce 2045 if (!warned && !vty_shell_serv(vty))
4911ca9c 2046 vty_out(vty, NO_PASSWD_CMD_WARNING);
d62a17ae 2047 XFREE(MTYPE_HOST, host.enable_encrypt);
322e2d5c 2048 }
d62a17ae 2049 host.enable_encrypt = NULL;
718e3744 2050
d62a17ae 2051 return CMD_SUCCESS;
718e3744 2052}
d0bfb22c 2053
718e3744 2054DEFUN (service_password_encrypt,
2055 service_password_encrypt_cmd,
2056 "service password-encryption",
2057 "Set up miscellaneous service\n"
2058 "Enable encrypted passwords\n")
2059{
d62a17ae 2060 if (host.encrypt)
2061 return CMD_SUCCESS;
718e3744 2062
d62a17ae 2063 host.encrypt = 1;
718e3744 2064
d62a17ae 2065 if (host.password) {
2066 if (host.password_encrypt)
2067 XFREE(MTYPE_HOST, host.password_encrypt);
2068 host.password_encrypt =
2069 XSTRDUP(MTYPE_HOST, zencrypt(host.password));
2070 }
2071 if (host.enable) {
2072 if (host.enable_encrypt)
2073 XFREE(MTYPE_HOST, host.enable_encrypt);
2074 host.enable_encrypt =
2075 XSTRDUP(MTYPE_HOST, zencrypt(host.enable));
2076 }
718e3744 2077
d62a17ae 2078 return CMD_SUCCESS;
718e3744 2079}
2080
2081DEFUN (no_service_password_encrypt,
2082 no_service_password_encrypt_cmd,
2083 "no service password-encryption",
2084 NO_STR
2085 "Set up miscellaneous service\n"
2086 "Enable encrypted passwords\n")
2087{
d62a17ae 2088 if (!host.encrypt)
2089 return CMD_SUCCESS;
718e3744 2090
d62a17ae 2091 host.encrypt = 0;
718e3744 2092
d62a17ae 2093 if (host.password_encrypt)
2094 XFREE(MTYPE_HOST, host.password_encrypt);
2095 host.password_encrypt = NULL;
718e3744 2096
d62a17ae 2097 if (host.enable_encrypt)
2098 XFREE(MTYPE_HOST, host.enable_encrypt);
2099 host.enable_encrypt = NULL;
718e3744 2100
d62a17ae 2101 return CMD_SUCCESS;
718e3744 2102}
2103
f412b39a
DW
2104DEFUN (config_terminal_length,
2105 config_terminal_length_cmd,
d0bfb22c 2106 "terminal length (0-512)",
718e3744 2107 "Set terminal line parameters\n"
2108 "Set number of lines on a screen\n"
2109 "Number of lines on screen (0 for no pausing)\n")
2110{
d62a17ae 2111 int idx_number = 2;
718e3744 2112
d62a17ae 2113 vty->lines = atoi(argv[idx_number]->arg);
718e3744 2114
d62a17ae 2115 return CMD_SUCCESS;
718e3744 2116}
2117
f412b39a
DW
2118DEFUN (config_terminal_no_length,
2119 config_terminal_no_length_cmd,
718e3744 2120 "terminal no length",
2121 "Set terminal line parameters\n"
2122 NO_STR
2123 "Set number of lines on a screen\n")
2124{
d62a17ae 2125 vty->lines = -1;
2126 return CMD_SUCCESS;
718e3744 2127}
2128
f412b39a
DW
2129DEFUN (service_terminal_length,
2130 service_terminal_length_cmd,
d0bfb22c 2131 "service terminal-length (0-512)",
718e3744 2132 "Set up miscellaneous service\n"
2133 "System wide terminal length configuration\n"
2134 "Number of lines of VTY (0 means no line control)\n")
2135{
d62a17ae 2136 int idx_number = 2;
718e3744 2137
d62a17ae 2138 host.lines = atoi(argv[idx_number]->arg);
718e3744 2139
d62a17ae 2140 return CMD_SUCCESS;
718e3744 2141}
2142
f412b39a
DW
2143DEFUN (no_service_terminal_length,
2144 no_service_terminal_length_cmd,
d0bfb22c 2145 "no service terminal-length [(0-512)]",
718e3744 2146 NO_STR
2147 "Set up miscellaneous service\n"
2148 "System wide terminal length configuration\n"
2149 "Number of lines of VTY (0 means no line control)\n")
2150{
d62a17ae 2151 host.lines = -1;
2152 return CMD_SUCCESS;
718e3744 2153}
2154
2885f72d 2155DEFUN_HIDDEN (do_echo,
d0bfb22c
QY
2156 echo_cmd,
2157 "echo MESSAGE...",
2158 "Echo a message back to the vty\n"
2159 "The message to echo\n")
2885f72d 2160{
d62a17ae 2161 char *message;
2885f72d 2162
d62a17ae 2163 vty_out(vty, "%s\n",
2164 ((message = argv_concat(argv, argc, 1)) ? message : ""));
2165 if (message)
2166 XFREE(MTYPE_TMP, message);
2167 return CMD_SUCCESS;
2885f72d 2168}
2169
274a4a44 2170DEFUN (config_logmsg,
2171 config_logmsg_cmd,
199d90a1 2172 "logmsg <emergencies|alerts|critical|errors|warnings|notifications|informational|debugging> MESSAGE...",
274a4a44 2173 "Send a message to enabled logging destinations\n"
2174 LOG_LEVEL_DESC
2175 "The message to send\n")
2176{
d62a17ae 2177 int idx_log_level = 1;
2178 int idx_message = 2;
2179 int level;
2180 char *message;
274a4a44 2181
0bdeb5e5
DL
2182 level = log_level_match(argv[idx_log_level]->arg);
2183 if (level == ZLOG_DISABLED)
d62a17ae 2184 return CMD_ERR_NO_MATCH;
274a4a44 2185
d62a17ae 2186 zlog(level, "%s",
2187 ((message = argv_concat(argv, argc, idx_message)) ? message : ""));
2188 if (message)
2189 XFREE(MTYPE_TMP, message);
65efcfce 2190
d62a17ae 2191 return CMD_SUCCESS;
274a4a44 2192}
2193
9eed278b
DL
2194DEFUN (debug_memstats,
2195 debug_memstats_cmd,
2196 "[no] debug memstats-at-exit",
2197 NO_STR
2198 DEBUG_STR
2199 "Print memory type statistics at exit\n")
2200{
2201 debug_memstats_at_exit = !!strcmp(argv[0]->text, "no");
2202 return CMD_SUCCESS;
2203}
2204
d62a17ae 2205int cmd_banner_motd_file(const char *file)
7cfc61d3 2206{
d62a17ae 2207 int success = CMD_SUCCESS;
2208 char p[PATH_MAX];
2209 char *rpath;
2210 char *in;
7cfc61d3 2211
d62a17ae 2212 rpath = realpath(file, p);
2213 if (!rpath)
2214 return CMD_ERR_NO_FILE;
2215 in = strstr(rpath, SYSCONFDIR);
2216 if (in == rpath) {
0a22ddfb 2217 XFREE(MTYPE_HOST, host.motdfile);
d62a17ae 2218 host.motdfile = XSTRDUP(MTYPE_HOST, file);
2219 } else
2220 success = CMD_WARNING_CONFIG_FAILED;
1ee08155 2221
d62a17ae 2222 return success;
7cfc61d3
DS
2223}
2224
19d61463
DA
2225void cmd_banner_motd_line(const char *line)
2226{
e1b36e13 2227 XFREE(MTYPE_HOST, host.motd);
19d61463
DA
2228 host.motd = XSTRDUP(MTYPE_HOST, line);
2229}
2230
3b0c5d9a 2231DEFUN (banner_motd_file,
2232 banner_motd_file_cmd,
4d833e55 2233 "banner motd file FILE",
3b0c5d9a 2234 "Set banner\n"
2235 "Banner for motd\n"
2236 "Banner from a file\n"
2237 "Filename\n")
2238{
d62a17ae 2239 int idx_file = 3;
2240 const char *filename = argv[idx_file]->arg;
2241 int cmd = cmd_banner_motd_file(filename);
1ee08155 2242
d62a17ae 2243 if (cmd == CMD_ERR_NO_FILE)
4d4c404b 2244 vty_out(vty, "%s does not exist\n", filename);
d62a17ae 2245 else if (cmd == CMD_WARNING_CONFIG_FAILED)
4d4c404b 2246 vty_out(vty, "%s must be in %s\n", filename, SYSCONFDIR);
1ee08155 2247
d62a17ae 2248 return cmd;
3b0c5d9a 2249}
718e3744 2250
19d61463
DA
2251DEFUN (banner_motd_line,
2252 banner_motd_line_cmd,
2253 "banner motd line LINE...",
2254 "Set banner\n"
2255 "Banner for motd\n"
2256 "Banner from an input\n"
2257 "Text\n")
2258{
2259 int idx = 0;
2260 char *motd;
2261
2262 argv_find(argv, argc, "LINE", &idx);
2263 motd = argv_concat(argv, argc, idx);
2264
2265 cmd_banner_motd_line(motd);
2266 XFREE(MTYPE_TMP, motd);
2267
2268 return CMD_SUCCESS;
2269}
2270
718e3744 2271DEFUN (banner_motd_default,
2272 banner_motd_default_cmd,
2273 "banner motd default",
2274 "Set banner string\n"
2275 "Strings for motd\n"
2276 "Default string\n")
2277{
19d61463 2278 cmd_banner_motd_line(FRR_DEFAULT_MOTD);
d62a17ae 2279 return CMD_SUCCESS;
718e3744 2280}
2281
2282DEFUN (no_banner_motd,
2283 no_banner_motd_cmd,
2284 "no banner motd",
2285 NO_STR
2286 "Set banner string\n"
2287 "Strings for motd\n")
2288{
d62a17ae 2289 host.motd = NULL;
2290 if (host.motdfile)
2291 XFREE(MTYPE_HOST, host.motdfile);
2292 host.motdfile = NULL;
2293 return CMD_SUCCESS;
718e3744 2294}
2295
ac156aec
DA
2296DEFUN(allow_reserved_ranges, allow_reserved_ranges_cmd, "allow-reserved-ranges",
2297 "Allow using IPv4 (Class E) reserved IP space\n")
2298{
2299 host.allow_reserved_ranges = true;
2300 return CMD_SUCCESS;
2301}
2302
2303DEFUN(no_allow_reserved_ranges, no_allow_reserved_ranges_cmd,
2304 "no allow-reserved-ranges",
2305 NO_STR "Allow using IPv4 (Class E) reserved IP space\n")
2306{
2307 host.allow_reserved_ranges = false;
2308 return CMD_SUCCESS;
2309}
2310
c2278962 2311int cmd_find_cmds(struct vty *vty, struct cmd_token **argv, int argc)
a83a5331 2312{
cf6c83e7
QY
2313 const struct cmd_node *node;
2314 const struct cmd_element *cli;
2315 vector clis;
a83a5331 2316
68912a20
QY
2317 regex_t exp = {};
2318
767f67a4 2319 char *pattern = argv_concat(argv, argc, 1);
68912a20 2320 int cr = regcomp(&exp, pattern, REG_NOSUB | REG_EXTENDED);
767f67a4 2321 XFREE(MTYPE_TMP, pattern);
68912a20
QY
2322
2323 if (cr != 0) {
2324 switch (cr) {
2325 case REG_BADBR:
2326 vty_out(vty, "%% Invalid {...} expression\n");
2327 break;
2328 case REG_BADRPT:
2329 vty_out(vty, "%% Bad repetition operator\n");
2330 break;
2331 case REG_BADPAT:
2332 vty_out(vty, "%% Regex syntax error\n");
2333 break;
2334 case REG_ECOLLATE:
2335 vty_out(vty, "%% Invalid collating element\n");
2336 break;
2337 case REG_ECTYPE:
2338 vty_out(vty, "%% Invalid character class name\n");
2339 break;
2340 case REG_EESCAPE:
2341 vty_out(vty,
2342 "%% Regex ended with escape character (\\)\n");
2343 break;
2344 case REG_ESUBREG:
2345 vty_out(vty,
2346 "%% Invalid number in \\digit construction\n");
2347 break;
2348 case REG_EBRACK:
2349 vty_out(vty, "%% Unbalanced square brackets\n");
2350 break;
2351 case REG_EPAREN:
2352 vty_out(vty, "%% Unbalanced parentheses\n");
2353 break;
2354 case REG_EBRACE:
2355 vty_out(vty, "%% Unbalanced braces\n");
2356 break;
2357 case REG_ERANGE:
2358 vty_out(vty,
2359 "%% Invalid endpoint in range expression\n");
2360 break;
2361 case REG_ESPACE:
2362 vty_out(vty, "%% Failed to compile (out of memory)\n");
2363 break;
2364 }
2365
2366 goto done;
2367 }
2368
2369
a83a5331 2370 for (unsigned int i = 0; i < vector_active(cmdvec); i++) {
cf6c83e7 2371 node = vector_slot(cmdvec, i);
a83a5331
QY
2372 if (!node)
2373 continue;
cf6c83e7 2374 clis = node->cmd_vector;
a83a5331 2375 for (unsigned int j = 0; j < vector_active(clis); j++) {
cf6c83e7 2376 cli = vector_slot(clis, j);
68912a20 2377
5b96d81c
IR
2378 if (regexec(&exp, cli->string, 0, NULL, 0) == 0) {
2379 vty_out(vty, " (%s) ", node->name);
2380 print_cmd(vty, cli->string);
2381 }
a83a5331
QY
2382 }
2383 }
2384
68912a20
QY
2385done:
2386 regfree(&exp);
a83a5331
QY
2387 return CMD_SUCCESS;
2388}
2389
c2278962
IR
2390DEFUN(find,
2391 find_cmd,
2392 "find REGEX...",
2393 "Find CLI command matching a regular expression\n"
2394 "Search pattern (POSIX regex)\n")
2395{
2396 return cmd_find_cmds(vty, argv, argc);
2397}
2398
fa22080d 2399#if defined(DEV_BUILD) && defined(HAVE_SCRIPTING)
8be973f5
DL
2400DEFUN(script, script_cmd, "script SCRIPT FUNCTION",
2401 "Test command - execute a function in a script\n"
2402 "Script name (same as filename in /etc/frr/scripts/)\n"
2403 "Function name (in the script)\n")
5f98c815 2404{
3d19ffc5 2405 struct prefix p;
45e56ec4
DS
2406
2407 (void)str2prefix("1.2.3.4/24", &p);
a71096fb 2408 struct frrscript *fs = frrscript_new(argv[1]->arg);
5f98c815 2409
596b44af
DL
2410 if (frrscript_load(fs, argv[2]->arg, NULL)) {
2411 vty_out(vty,
8be973f5 2412 "/etc/frr/scripts/%s.lua or function '%s' not found\n",
596b44af 2413 argv[1]->arg, argv[2]->arg);
3d19ffc5 2414 }
5f98c815 2415
a71096fb
DL
2416 int ret = frrscript_call(fs, argv[2]->arg, ("p", &p));
2417 char buf[40];
2418 prefix2str(&p, buf, sizeof(buf));
2419 vty_out(vty, "p: %s\n", buf);
2420 vty_out(vty, "Script result: %d\n", ret);
5f98c815 2421
64d457d7 2422 frrscript_delete(fs);
ad6e9b85 2423
5f98c815
QY
2424 return CMD_SUCCESS;
2425}
2426#endif
2427
718e3744 2428/* Set config filename. Called from vty.c */
d62a17ae 2429void host_config_set(const char *filename)
718e3744 2430{
0a22ddfb 2431 XFREE(MTYPE_HOST, host.config);
d62a17ae 2432 host.config = XSTRDUP(MTYPE_HOST, filename);
718e3744 2433}
2434
d62a17ae 2435const char *host_config_get(void)
57387fb2 2436{
d62a17ae 2437 return host.config;
57387fb2
CF
2438}
2439
cf00164b
DS
2440void cmd_show_lib_debugs(struct vty *vty)
2441{
2442 route_map_show_debug(vty);
cfa0facb
CH
2443 mgmt_debug_be_client_show_debug(vty);
2444 mgmt_debug_fe_client_show_debug(vty);
cf00164b
DS
2445}
2446
d62a17ae 2447void install_default(enum node_type node)
718e3744 2448{
01485adb
DL
2449 _install_element(node, &config_exit_cmd);
2450 _install_element(node, &config_quit_cmd);
2451 _install_element(node, &config_end_cmd);
2452 _install_element(node, &config_help_cmd);
2453 _install_element(node, &config_list_cmd);
2454 _install_element(node, &show_cli_graph_cmd);
2455 _install_element(node, &find_cmd);
718e3744 2456
01485adb
DL
2457 _install_element(node, &config_write_cmd);
2458 _install_element(node, &show_running_config_cmd);
7f059ea6 2459
01485adb 2460 _install_element(node, &autocomplete_cmd);
1c2facd1
RW
2461
2462 nb_cli_install_default(node);
718e3744 2463}
2464
87f44e2f
DL
2465/* Initialize command interface. Install basic nodes and commands.
2466 *
2467 * terminal = 0 -- vtysh / no logging, no config control
2468 * terminal = 1 -- normal daemon
9473e340 2469 * terminal = -1 -- watchfrr / no logging, but minimal config control */
d62a17ae 2470void cmd_init(int terminal)
2471{
419cd5a0
MK
2472 struct utsname names;
2473
419cd5a0 2474 uname(&names);
d62a17ae 2475 qobj_init();
2476
fe6b47b9
QY
2477 /* register command preprocessors */
2478 hook_register(cmd_execute, handle_pipe_action);
2479 hook_register(cmd_execute_done, handle_pipe_action_done);
2480
d62a17ae 2481 varhandlers = list_new();
2482
2483 /* Allocate initial top vector of commands. */
2484 cmdvec = vector_init(VECTOR_MIN_SIZE);
2485
2486 /* Default host value settings. */
419cd5a0 2487 host.name = XSTRDUP(MTYPE_HOST, names.nodename);
46b48b33
DS
2488 host.system = XSTRDUP(MTYPE_HOST, names.sysname);
2489 host.release = XSTRDUP(MTYPE_HOST, names.release);
2490 host.version = XSTRDUP(MTYPE_HOST, names.version);
2491
419cd5a0 2492#ifdef HAVE_STRUCT_UTSNAME_DOMAINNAME
6b3ee3a0
MK
2493 if ((strcmp(names.domainname, "(none)") == 0))
2494 host.domainname = NULL;
2495 else
2496 host.domainname = XSTRDUP(MTYPE_HOST, names.domainname);
419cd5a0
MK
2497#else
2498 host.domainname = NULL;
2499#endif
d62a17ae 2500 host.password = NULL;
2501 host.enable = NULL;
d62a17ae 2502 host.config = NULL;
2503 host.noconfig = (terminal < 0);
2504 host.lines = -1;
19d61463 2505 cmd_banner_motd_line(FRR_DEFAULT_MOTD);
d62a17ae 2506 host.motdfile = NULL;
ac156aec 2507 host.allow_reserved_ranges = false;
d62a17ae 2508
2509 /* Install top nodes. */
612c2c15
DL
2510 install_node(&view_node);
2511 install_node(&enable_node);
2512 install_node(&auth_node);
2513 install_node(&auth_enable_node);
2514 install_node(&config_node);
d62a17ae 2515
2516 /* Each node's basic commands. */
2517 install_element(VIEW_NODE, &show_version_cmd);
a83a5331
QY
2518 install_element(ENABLE_NODE, &show_startup_config_cmd);
2519
d62a17ae 2520 if (terminal) {
85a6806d
MS
2521 install_element(ENABLE_NODE, &debug_memstats_cmd);
2522
d62a17ae 2523 install_element(VIEW_NODE, &config_list_cmd);
2524 install_element(VIEW_NODE, &config_exit_cmd);
2525 install_element(VIEW_NODE, &config_quit_cmd);
2526 install_element(VIEW_NODE, &config_help_cmd);
2527 install_element(VIEW_NODE, &config_enable_cmd);
2528 install_element(VIEW_NODE, &config_terminal_length_cmd);
2529 install_element(VIEW_NODE, &config_terminal_no_length_cmd);
d62a17ae 2530 install_element(VIEW_NODE, &show_commandtree_cmd);
2531 install_element(VIEW_NODE, &echo_cmd);
2532 install_element(VIEW_NODE, &autocomplete_cmd);
a83a5331 2533 install_element(VIEW_NODE, &find_cmd);
fa22080d 2534#if defined(DEV_BUILD) && defined(HAVE_SCRIPTING)
3d19ffc5
QY
2535 install_element(VIEW_NODE, &script_cmd);
2536#endif
2537
d62a17ae 2538
d62a17ae 2539 install_element(ENABLE_NODE, &config_end_cmd);
2540 install_element(ENABLE_NODE, &config_disable_cmd);
2541 install_element(ENABLE_NODE, &config_terminal_cmd);
2542 install_element(ENABLE_NODE, &copy_runningconf_startupconf_cmd);
2543 install_element(ENABLE_NODE, &config_write_cmd);
2544 install_element(ENABLE_NODE, &show_running_config_cmd);
d62a17ae 2545 install_element(ENABLE_NODE, &config_logmsg_cmd);
a83a5331 2546
d62a17ae 2547 install_default(CONFIG_NODE);
2548
5f6eaa9b 2549 event_cmd_init();
d62a17ae 2550 workqueue_cmd_init();
2551 hash_cmd_init();
2552 }
2553
2554 install_element(CONFIG_NODE, &hostname_cmd);
2555 install_element(CONFIG_NODE, &no_hostname_cmd);
6b3ee3a0
MK
2556 install_element(CONFIG_NODE, &domainname_cmd);
2557 install_element(CONFIG_NODE, &no_domainname_cmd);
d62a17ae 2558
2559 if (terminal > 0) {
0bdeb5e5
DL
2560 full_cli = true;
2561
85a6806d
MS
2562 install_element(CONFIG_NODE, &debug_memstats_cmd);
2563
d62a17ae 2564 install_element(CONFIG_NODE, &password_cmd);
322e2d5c 2565 install_element(CONFIG_NODE, &no_password_cmd);
d62a17ae 2566 install_element(CONFIG_NODE, &enable_password_cmd);
2567 install_element(CONFIG_NODE, &no_enable_password_cmd);
2568
d62a17ae 2569 install_element(CONFIG_NODE, &service_password_encrypt_cmd);
2570 install_element(CONFIG_NODE, &no_service_password_encrypt_cmd);
2571 install_element(CONFIG_NODE, &banner_motd_default_cmd);
2572 install_element(CONFIG_NODE, &banner_motd_file_cmd);
19d61463 2573 install_element(CONFIG_NODE, &banner_motd_line_cmd);
d62a17ae 2574 install_element(CONFIG_NODE, &no_banner_motd_cmd);
2575 install_element(CONFIG_NODE, &service_terminal_length_cmd);
2576 install_element(CONFIG_NODE, &no_service_terminal_length_cmd);
ac156aec
DA
2577 install_element(CONFIG_NODE, &allow_reserved_ranges_cmd);
2578 install_element(CONFIG_NODE, &no_allow_reserved_ranges_cmd);
d62a17ae 2579
0bdeb5e5 2580 log_cmd_init();
d62a17ae 2581 vrf_install_commands();
2582 }
af2567b6
DL
2583
2584#ifdef DEV_BUILD
d62a17ae 2585 grammar_sandbox_init();
af2567b6 2586#endif
718e3744 2587}
228da428 2588
4d762f26 2589void cmd_terminate(void)
d62a17ae 2590{
2591 struct cmd_node *cmd_node;
2592
5d806ec6
QY
2593 hook_unregister(cmd_execute, handle_pipe_action);
2594 hook_unregister(cmd_execute_done, handle_pipe_action_done);
2595
d62a17ae 2596 if (cmdvec) {
2597 for (unsigned int i = 0; i < vector_active(cmdvec); i++)
2598 if ((cmd_node = vector_slot(cmdvec, i)) != NULL) {
2599 // deleting the graph delets the cmd_element as
2600 // well
2601 graph_delete_graph(cmd_node->cmdgraph);
2602 vector_free(cmd_node->cmd_vector);
d8bc11a5 2603 hash_clean_and_free(&cmd_node->cmd_hash, NULL);
d62a17ae 2604 }
2605
2606 vector_free(cmdvec);
2607 cmdvec = NULL;
2608 }
2609
0a22ddfb 2610 XFREE(MTYPE_HOST, host.name);
46b48b33
DS
2611 XFREE(MTYPE_HOST, host.system);
2612 XFREE(MTYPE_HOST, host.release);
2613 XFREE(MTYPE_HOST, host.version);
0a22ddfb
QY
2614 XFREE(MTYPE_HOST, host.domainname);
2615 XFREE(MTYPE_HOST, host.password);
2616 XFREE(MTYPE_HOST, host.password_encrypt);
2617 XFREE(MTYPE_HOST, host.enable);
2618 XFREE(MTYPE_HOST, host.enable_encrypt);
0a22ddfb
QY
2619 XFREE(MTYPE_HOST, host.motdfile);
2620 XFREE(MTYPE_HOST, host.config);
19d61463 2621 XFREE(MTYPE_HOST, host.motd);
d62a17ae 2622
6a154c88 2623 list_delete(&varhandlers);
d62a17ae 2624 qobj_finish();
228da428 2625}