2 * CLI backend interface.
5 * Copyright (C) 2016 Cumulus Networks, Inc.
6 * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
7 * Copyright (C) 2013 by Open Source Routing.
8 * Copyright (C) 2013 by Internet Systems Consortium, Inc. ("ISC")
10 * This file is part of GNU Zebra.
12 * GNU Zebra is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2, or (at your option) any
17 * GNU Zebra is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; see the file COPYING; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28 #include <lib/version.h>
39 #include "workqueue.h"
41 #include "command_match.h"
42 #include "command_graph.h"
48 #include "lib_errors.h"
49 #include "northbound_cli.h"
53 #include "frrscript.h"
55 DEFINE_MTYPE_STATIC(LIB
, HOST
, "Host config");
56 DEFINE_MTYPE(LIB
, COMPLETION
, "Completion item");
63 /* clang-format off */
64 const struct message tokennames
[] = {
69 item(IPV4_PREFIX_TKN
),
71 item(IPV6_PREFIX_TKN
),
83 /* Command vector which includes some level of command lists. Normally
84 each daemon maintains each own cmdvec. */
87 /* Host information structure. */
90 /* for vtysh, put together CLI trees only when switching into node */
91 static bool defer_cli_tree
;
94 * Returns host.name if any, otherwise
95 * it returns the system hostname.
97 const char *cmd_hostname_get(void)
103 * Returns unix domainname
105 const char *cmd_domainname_get(void)
107 return host
.domainname
;
110 const char *cmd_system_get(void)
115 const char *cmd_release_get(void)
120 const char *cmd_version_get(void)
125 bool cmd_allow_reserved_ranges_get(void)
127 return host
.allow_reserved_ranges
;
130 static int root_on_exit(struct vty
*vty
);
132 /* Standard command node structures. */
133 static struct cmd_node auth_node
= {
136 .prompt
= "Password: ",
139 static struct cmd_node view_node
= {
143 .node_exit
= root_on_exit
,
146 static struct cmd_node auth_enable_node
= {
147 .name
= "auth enable",
148 .node
= AUTH_ENABLE_NODE
,
149 .prompt
= "Password: ",
152 static struct cmd_node enable_node
= {
156 .node_exit
= root_on_exit
,
159 static int config_write_host(struct vty
*vty
);
160 static struct cmd_node config_node
= {
163 .parent_node
= ENABLE_NODE
,
164 .prompt
= "%s(config)# ",
165 .config_write
= config_write_host
,
166 .node_exit
= vty_config_node_exit
,
169 /* This is called from main when a daemon is invoked with -v or --version. */
170 void print_version(const char *progname
)
172 printf("%s version %s\n", progname
, FRR_VERSION
);
173 printf("%s\n", FRR_COPYRIGHT
);
174 #ifdef ENABLE_VERSION_BUILD_CONFIG
175 printf("configured with:\n\t%s\n", FRR_CONFIG_ARGS
);
179 char *argv_concat(struct cmd_token
**argv
, int argc
, int shift
)
181 int cnt
= MAX(argc
- shift
, 0);
182 const char *argstr
[cnt
+ 1];
187 for (int i
= 0; i
< cnt
; i
++)
188 argstr
[i
] = argv
[i
+ shift
]->arg
;
190 return frrstr_join(argstr
, cnt
, " ");
193 vector
cmd_make_strvec(const char *string
)
198 const char *copy
= string
;
200 /* skip leading whitespace */
201 while (isspace((unsigned char)*copy
) && *copy
!= '\0')
204 /* if the entire string was whitespace or a comment, return */
205 if (*copy
== '\0' || *copy
== '!' || *copy
== '#')
208 vector result
= frrstr_split_vec(copy
, "\n\r\t ");
210 for (unsigned int i
= 0; i
< vector_active(result
); i
++) {
211 if (strlen(vector_slot(result
, i
)) == 0) {
212 XFREE(MTYPE_TMP
, vector_slot(result
, i
));
213 vector_unset(result
, i
);
217 vector_compact(result
);
222 void cmd_free_strvec(vector v
)
224 frrstr_strvec_free(v
);
228 * Convenience function for accessing argv data.
232 * @param text definition snippet of the desired token
233 * @param index the starting index, and where to store the
234 * index of the found token if it exists
235 * @return 1 if found, 0 otherwise
237 int argv_find(struct cmd_token
**argv
, int argc
, const char *text
, int *index
)
240 for (int i
= *index
; i
< argc
&& found
== 0; i
++)
241 if ((found
= strmatch(text
, argv
[i
]->text
)))
246 static unsigned int cmd_hash_key(const void *p
)
248 int size
= sizeof(p
);
250 return jhash(p
, size
, 0);
253 static bool cmd_hash_cmp(const void *a
, const void *b
)
258 /* Install top node of command vector. */
259 void install_node(struct cmd_node
*node
)
261 #define CMD_HASH_STR_SIZE 256
262 char hash_name
[CMD_HASH_STR_SIZE
];
264 vector_set_index(cmdvec
, node
->node
, node
);
265 node
->cmdgraph
= graph_new();
266 node
->cmd_vector
= vector_init(VECTOR_MIN_SIZE
);
268 struct cmd_token
*token
= cmd_token_new(START_TKN
, 0, NULL
, NULL
);
269 graph_new_node(node
->cmdgraph
, token
,
270 (void (*)(void *)) & cmd_token_del
);
272 snprintf(hash_name
, sizeof(hash_name
), "Command Hash: %s", node
->name
);
274 hash_create_size(16, cmd_hash_key
, cmd_hash_cmp
, hash_name
);
277 /* Return prompt character of specified node. */
278 const char *cmd_prompt(enum node_type node
)
280 struct cmd_node
*cnode
;
282 cnode
= vector_slot(cmdvec
, node
);
283 return cnode
->prompt
;
286 void cmd_defer_tree(bool val
)
288 defer_cli_tree
= val
;
291 /* Install a command into a node. */
292 void _install_element(enum node_type ntype
, const struct cmd_element
*cmd
)
294 struct cmd_node
*cnode
;
296 /* cmd_init hasn't been called */
298 fprintf(stderr
, "%s called before cmd_init, breakage likely\n",
303 cnode
= vector_lookup(cmdvec
, ntype
);
308 "\tnode %d does not exist.\n"
309 "\tplease call install_node() before install_element()\n",
310 cmd
->name
, cmd
->string
, ntype
);
314 if (hash_lookup(cnode
->cmd_hash
, (void *)cmd
) != NULL
) {
317 "\tnode %d (%s) already has this command installed.\n"
318 "\tduplicate install_element call?\n",
319 cmd
->name
, cmd
->string
, ntype
, cnode
->name
);
323 (void)hash_get(cnode
->cmd_hash
, (void *)cmd
, hash_alloc_intern
);
325 if (cnode
->graph_built
|| !defer_cli_tree
) {
326 struct graph
*graph
= graph_new();
327 struct cmd_token
*token
=
328 cmd_token_new(START_TKN
, 0, NULL
, NULL
);
329 graph_new_node(graph
, token
,
330 (void (*)(void *)) & cmd_token_del
);
332 cmd_graph_parse(graph
, cmd
);
333 cmd_graph_names(graph
);
334 cmd_graph_merge(cnode
->cmdgraph
, graph
, +1);
335 graph_delete_graph(graph
);
337 cnode
->graph_built
= true;
340 vector_set(cnode
->cmd_vector
, (void *)cmd
);
342 if (ntype
== VIEW_NODE
)
343 _install_element(ENABLE_NODE
, cmd
);
346 static void cmd_finalize_iter(struct hash_bucket
*hb
, void *arg
)
348 struct cmd_node
*cnode
= arg
;
349 const struct cmd_element
*cmd
= hb
->data
;
350 struct graph
*graph
= graph_new();
351 struct cmd_token
*token
= cmd_token_new(START_TKN
, 0, NULL
, NULL
);
353 graph_new_node(graph
, token
, (void (*)(void *)) & cmd_token_del
);
355 cmd_graph_parse(graph
, cmd
);
356 cmd_graph_names(graph
);
357 cmd_graph_merge(cnode
->cmdgraph
, graph
, +1);
358 graph_delete_graph(graph
);
361 void cmd_finalize_node(struct cmd_node
*cnode
)
363 if (cnode
->graph_built
)
366 hash_iterate(cnode
->cmd_hash
, cmd_finalize_iter
, cnode
);
367 cnode
->graph_built
= true;
370 void uninstall_element(enum node_type ntype
, const struct cmd_element
*cmd
)
372 struct cmd_node
*cnode
;
374 /* cmd_init hasn't been called */
376 fprintf(stderr
, "%s called before cmd_init, breakage likely\n",
381 cnode
= vector_lookup(cmdvec
, ntype
);
386 "\tnode %d does not exist.\n"
387 "\tplease call install_node() before uninstall_element()\n",
388 cmd
->name
, cmd
->string
, ntype
);
392 if (hash_release(cnode
->cmd_hash
, (void *)cmd
) == NULL
) {
395 "\tnode %d (%s) does not have this command installed.\n"
396 "\tduplicate uninstall_element call?\n",
397 cmd
->name
, cmd
->string
, ntype
, cnode
->name
);
401 vector_unset_value(cnode
->cmd_vector
, (void *)cmd
);
403 if (cnode
->graph_built
) {
404 struct graph
*graph
= graph_new();
405 struct cmd_token
*token
=
406 cmd_token_new(START_TKN
, 0, NULL
, NULL
);
407 graph_new_node(graph
, token
,
408 (void (*)(void *)) & cmd_token_del
);
410 cmd_graph_parse(graph
, cmd
);
411 cmd_graph_names(graph
);
412 cmd_graph_merge(cnode
->cmdgraph
, graph
, -1);
413 graph_delete_graph(graph
);
416 if (ntype
== VIEW_NODE
)
417 uninstall_element(ENABLE_NODE
, cmd
);
421 static const unsigned char itoa64
[] =
422 "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
424 static void to64(char *s
, long v
, int n
)
427 *s
++ = itoa64
[v
& 0x3f];
432 static char *zencrypt(const char *passwd
)
437 gettimeofday(&tv
, 0);
439 to64(&salt
[0], frr_weak_random(), 3);
440 to64(&salt
[3], tv
.tv_usec
, 3);
443 return crypt(passwd
, salt
);
446 static bool full_cli
;
448 /* This function write configuration of this host. */
449 static int config_write_host(struct vty
*vty
)
453 name
= cmd_hostname_get();
454 if (name
&& name
[0] != '\0')
455 vty_out(vty
, "hostname %s\n", name
);
457 name
= cmd_domainname_get();
458 if (name
&& name
[0] != '\0')
459 vty_out(vty
, "domainname %s\n", name
);
461 if (cmd_allow_reserved_ranges_get())
462 vty_out(vty
, "allow-reserved-ranges\n");
464 /* The following are all configuration commands that are not sent to
465 * watchfrr. For instance watchfrr is hardcoded to log to syslog so
466 * we would always display 'log syslog informational' in the config
467 * which would cause other daemons to then switch to syslog when they
472 if (host
.password_encrypt
)
473 vty_out(vty
, "password 8 %s\n",
474 host
.password_encrypt
);
475 if (host
.enable_encrypt
)
476 vty_out(vty
, "enable password 8 %s\n",
477 host
.enable_encrypt
);
480 vty_out(vty
, "password %s\n", host
.password
);
482 vty_out(vty
, "enable password %s\n",
485 log_config_write(vty
);
487 /* print disable always, but enable only if default is flipped
488 * => prep for future removal of compile-time knob
490 if (!cputime_enabled
)
491 vty_out(vty
, "no service cputime-stats\n");
492 #ifdef EXCLUDE_CPU_TIME
494 vty_out(vty
, "service cputime-stats\n");
497 if (!cputime_threshold
)
498 vty_out(vty
, "no service cputime-warning\n");
499 #if defined(CONSUMED_TIME_CHECK) && CONSUMED_TIME_CHECK != 5000000
500 else /* again, always print non-default */
502 else if (cputime_threshold
!= 5000000)
504 vty_out(vty
, "service cputime-warning %lu\n",
507 if (!walltime_threshold
)
508 vty_out(vty
, "no service walltime-warning\n");
509 #if defined(CONSUMED_TIME_CHECK) && CONSUMED_TIME_CHECK != 5000000
510 else /* again, always print non-default */
512 else if (walltime_threshold
!= 5000000)
514 vty_out(vty
, "service walltime-warning %lu\n",
518 vty_out(vty
, "service advanced-vty\n");
521 vty_out(vty
, "service password-encryption\n");
524 vty_out(vty
, "service terminal-length %d\n",
528 vty_out(vty
, "banner motd file %s\n", host
.motdfile
);
530 && strncmp(host
.motd
, FRR_DEFAULT_MOTD
,
532 vty_out(vty
, "banner motd line %s\n", host
.motd
);
534 vty_out(vty
, "no banner motd\n");
537 if (debug_memstats_at_exit
)
538 vty_out(vty
, "!\ndebug memstats-at-exit\n");
543 /* Utility function for getting command graph. */
544 static struct graph
*cmd_node_graph(vector v
, enum node_type ntype
)
546 struct cmd_node
*cnode
= vector_slot(v
, ntype
);
548 cmd_finalize_node(cnode
);
549 return cnode
->cmdgraph
;
552 static int cmd_try_do_shortcut(enum node_type node
, char *first_word
)
554 if (first_word
!= NULL
&& node
!= AUTH_NODE
&& node
!= VIEW_NODE
555 && node
!= AUTH_ENABLE_NODE
&& 0 == strcmp("do", first_word
))
561 * Compare function for cmd_token.
562 * Used with qsort to sort command completions.
564 static int compare_completions(const void *fst
, const void *snd
)
566 const struct cmd_token
*first
= *(const struct cmd_token
* const *)fst
,
567 *secnd
= *(const struct cmd_token
* const *)snd
;
568 return strcmp(first
->text
, secnd
->text
);
572 * Takes a list of completions returned by command_complete,
573 * dedeuplicates them based on both text and description,
574 * sorts them, and returns them as a vector.
576 * @param completions linked list of cmd_token
577 * @return deduplicated and sorted vector with
579 vector
completions_to_vec(struct list
*completions
)
581 vector comps
= vector_init(VECTOR_MIN_SIZE
);
584 struct cmd_token
*token
, *cr
= NULL
;
585 unsigned int i
, exists
;
586 for (ALL_LIST_ELEMENTS_RO(completions
, ln
, token
)) {
587 if (token
->type
== END_TKN
&& (cr
= token
))
590 // linear search for token in completions vector
592 for (i
= 0; i
< vector_active(comps
) && !exists
; i
++) {
593 struct cmd_token
*curr
= vector_slot(comps
, i
);
595 exists
= !strcmp(curr
->text
, token
->text
)
596 && !strcmp(curr
->desc
, token
->desc
);
598 exists
= !strcmp(curr
->text
, token
->text
);
599 #endif /* VTYSH_DEBUG */
603 vector_set(comps
, token
);
607 qsort(comps
->index
, vector_active(comps
), sizeof(void *),
608 &compare_completions
);
610 // make <cr> the first element, if it is present
612 vector_set_index(comps
, vector_active(comps
), NULL
);
613 memmove(comps
->index
+ 1, comps
->index
,
614 (comps
->alloced
- 1) * sizeof(void *));
615 vector_set_index(comps
, 0, cr
);
621 * Generates a vector of cmd_token representing possible completions
622 * on the current input.
624 * @param vline the vectorized input line
625 * @param vty the vty with the node to match on
626 * @param status pointer to matcher status code
627 * @return vector of struct cmd_token * with possible completions
629 static vector
cmd_complete_command_real(vector vline
, struct vty
*vty
,
632 struct list
*completions
;
633 struct graph
*cmdgraph
= cmd_node_graph(cmdvec
, vty
->node
);
635 enum matcher_rv rv
= command_complete(cmdgraph
, vline
, &completions
);
637 if (MATCHER_ERROR(rv
)) {
638 *status
= CMD_ERR_NO_MATCH
;
642 vector comps
= completions_to_vec(completions
);
643 list_delete(&completions
);
645 // set status code appropriately
646 switch (vector_active(comps
)) {
648 *status
= CMD_ERR_NO_MATCH
;
651 *status
= CMD_COMPLETE_FULL_MATCH
;
654 *status
= CMD_COMPLETE_LIST_MATCH
;
660 vector
cmd_describe_command(vector vline
, struct vty
*vty
, int *status
)
664 if (cmd_try_do_shortcut(vty
->node
, vector_slot(vline
, 0))) {
665 enum node_type onode
;
666 int orig_xpath_index
;
667 vector shifted_vline
;
671 orig_xpath_index
= vty
->xpath_index
;
672 vty
->node
= ENABLE_NODE
;
673 vty
->xpath_index
= 0;
674 /* We can try it on enable node, cos' the vty is authenticated
677 shifted_vline
= vector_init(vector_count(vline
));
679 for (index
= 1; index
< vector_active(vline
); index
++) {
680 vector_set_index(shifted_vline
, index
- 1,
681 vector_lookup(vline
, index
));
684 ret
= cmd_complete_command_real(shifted_vline
, vty
, status
);
686 vector_free(shifted_vline
);
688 vty
->xpath_index
= orig_xpath_index
;
692 return cmd_complete_command_real(vline
, vty
, status
);
695 static struct list
*varhandlers
= NULL
;
697 void cmd_variable_complete(struct cmd_token
*token
, const char *arg
,
701 const struct cmd_variable_handler
*cvh
;
705 tmpcomps
= arg
? vector_init(VECTOR_MIN_SIZE
) : comps
;
707 for (ALL_LIST_ELEMENTS_RO(varhandlers
, ln
, cvh
)) {
708 if (cvh
->tokenname
&& strcmp(cvh
->tokenname
, token
->text
))
710 if (cvh
->varname
&& (!token
->varname
711 || strcmp(cvh
->varname
, token
->varname
)))
713 cvh
->completions(tmpcomps
, token
);
721 for (i
= vector_active(tmpcomps
); i
; i
--) {
722 char *item
= vector_slot(tmpcomps
, i
- 1);
723 if (strlen(item
) >= argsz
&& !strncmp(item
, arg
, argsz
))
724 vector_set(comps
, item
);
726 XFREE(MTYPE_COMPLETION
, item
);
728 vector_free(tmpcomps
);
731 #define AUTOCOMP_INDENT 5
733 char *cmd_variable_comp2str(vector comps
, unsigned short cols
)
736 char *buf
= XCALLOC(MTYPE_TMP
, bsz
);
737 int lc
= AUTOCOMP_INDENT
;
738 size_t cs
= AUTOCOMP_INDENT
;
740 snprintf(buf
, bsz
, "%*s", AUTOCOMP_INDENT
, "");
741 for (size_t j
= 0; j
< vector_active(comps
); j
++) {
742 char *item
= vector_slot(comps
, j
);
743 itemlen
= strlen(item
);
745 if (cs
+ itemlen
+ AUTOCOMP_INDENT
+ 3 >= bsz
)
746 buf
= XREALLOC(MTYPE_TMP
, buf
, (bsz
*= 2));
748 if (lc
+ itemlen
+ 1 >= cols
) {
749 cs
+= snprintf(&buf
[cs
], bsz
- cs
, "\n%*s",
750 AUTOCOMP_INDENT
, "");
751 lc
= AUTOCOMP_INDENT
;
754 size_t written
= snprintf(&buf
[cs
], bsz
- cs
, "%s ", item
);
757 XFREE(MTYPE_COMPLETION
, item
);
758 vector_set_index(comps
, j
, NULL
);
763 void cmd_variable_handler_register(const struct cmd_variable_handler
*cvh
)
768 for (; cvh
->completions
; cvh
++)
769 listnode_add(varhandlers
, (void *)cvh
);
772 DEFUN_HIDDEN (autocomplete
,
774 "autocomplete TYPE TEXT VARNAME",
775 "Autocompletion handler (internal, for vtysh)\n"
778 "cmd_token->varname\n")
780 struct cmd_token tok
;
781 vector comps
= vector_init(32);
784 memset(&tok
, 0, sizeof(tok
));
785 tok
.type
= atoi(argv
[1]->arg
);
786 tok
.text
= argv
[2]->arg
;
787 tok
.varname
= argv
[3]->arg
;
788 if (!strcmp(tok
.varname
, "-"))
791 cmd_variable_complete(&tok
, NULL
, comps
);
793 for (i
= 0; i
< vector_active(comps
); i
++) {
794 char *text
= vector_slot(comps
, i
);
795 vty_out(vty
, "%s\n", text
);
796 XFREE(MTYPE_COMPLETION
, text
);
804 * Generate possible tab-completions for the given input. This function only
805 * returns results that would result in a valid command if used as Readline
806 * completions (as is the case in vtysh). For instance, if the passed vline ends
807 * with '4.3.2', the strings 'A.B.C.D' and 'A.B.C.D/M' will _not_ be returned.
809 * @param vline vectorized input line
811 * @param status location to store matcher status code in
812 * @return set of valid strings for use with Readline as tab-completions.
815 char **cmd_complete_command(vector vline
, struct vty
*vty
, int *status
)
818 int original_node
= vty
->node
;
819 vector input_line
= vector_init(vector_count(vline
));
821 // if the first token is 'do' we'll want to execute the command in the
823 int do_shortcut
= cmd_try_do_shortcut(vty
->node
, vector_slot(vline
, 0));
824 vty
->node
= do_shortcut
? ENABLE_NODE
: original_node
;
826 // construct the input line we'll be matching on
827 unsigned int offset
= (do_shortcut
) ? 1 : 0;
828 for (unsigned index
= 0; index
+ offset
< vector_active(vline
); index
++)
829 vector_set_index(input_line
, index
,
830 vector_lookup(vline
, index
+ offset
));
832 // get token completions -- this is a copying operation
833 vector comps
= NULL
, initial_comps
;
834 initial_comps
= cmd_complete_command_real(input_line
, vty
, status
);
836 if (!MATCHER_ERROR(*status
)) {
837 assert(initial_comps
);
838 // filter out everything that is not suitable for a
840 comps
= vector_init(VECTOR_MIN_SIZE
);
841 for (unsigned int i
= 0; i
< vector_active(initial_comps
);
843 struct cmd_token
*token
= vector_slot(initial_comps
, i
);
844 if (token
->type
== WORD_TKN
)
845 vector_set(comps
, XSTRDUP(MTYPE_COMPLETION
,
847 else if (IS_VARYING_TOKEN(token
->type
)) {
848 const char *ref
= vector_lookup(
849 vline
, vector_active(vline
) - 1);
850 cmd_variable_complete(token
, ref
, comps
);
853 vector_free(initial_comps
);
855 // since we filtered results, we need to re-set status code
856 switch (vector_active(comps
)) {
858 *status
= CMD_ERR_NO_MATCH
;
861 *status
= CMD_COMPLETE_FULL_MATCH
;
864 *status
= CMD_COMPLETE_LIST_MATCH
;
867 // copy completions text into an array of char*
868 ret
= XMALLOC(MTYPE_TMP
,
869 (vector_active(comps
) + 1) * sizeof(char *));
871 for (i
= 0; i
< vector_active(comps
); i
++) {
872 ret
[i
] = vector_slot(comps
, i
);
874 // set the last element to NULL, because this array is used in
875 // a Readline completion_generator function which expects NULL
876 // as a sentinel value
880 } else if (initial_comps
)
881 vector_free(initial_comps
);
883 // comps should always be null here
886 // free the adjusted input line
887 vector_free(input_line
);
889 // reset vty->node to its original value
890 vty
->node
= original_node
;
895 /* return parent node */
896 /* MUST eventually converge on CONFIG_NODE */
897 enum node_type
node_parent(enum node_type node
)
899 struct cmd_node
*cnode
;
901 assert(node
> CONFIG_NODE
);
903 cnode
= vector_lookup(cmdvec
, node
);
905 return cnode
->parent_node
;
908 /* Execute command by argument vline vector. */
909 static int cmd_execute_command_real(vector vline
, enum cmd_filter_type filter
,
911 const struct cmd_element
**cmd
,
912 unsigned int up_level
)
914 struct list
*argv_list
;
915 enum matcher_rv status
;
916 const struct cmd_element
*matched_element
= NULL
;
918 int xpath_index
= vty
->xpath_index
;
919 int node
= vty
->node
;
921 /* only happens for legacy split config file load; need to check for
922 * a match before calling node_exit handlers below
924 for (i
= 0; i
< up_level
; i
++) {
925 struct cmd_node
*cnode
;
927 if (node
<= CONFIG_NODE
)
928 return CMD_NO_LEVEL_UP
;
930 cnode
= vector_slot(cmdvec
, node
);
931 node
= node_parent(node
);
933 if (xpath_index
> 0 && !cnode
->no_xpath
)
937 struct graph
*cmdgraph
= cmd_node_graph(cmdvec
, node
);
938 status
= command_match(cmdgraph
, vline
, &argv_list
, &matched_element
);
941 *cmd
= matched_element
;
943 // if matcher error, return corresponding CMD_ERR
944 if (MATCHER_ERROR(status
)) {
946 list_delete(&argv_list
);
948 case MATCHER_INCOMPLETE
:
949 return CMD_ERR_INCOMPLETE
;
950 case MATCHER_AMBIGUOUS
:
951 return CMD_ERR_AMBIGUOUS
;
953 return CMD_ERR_NO_MATCH
;
957 for (i
= 0; i
< up_level
; i
++)
960 // build argv array from argv list
961 struct cmd_token
**argv
= XMALLOC(
962 MTYPE_TMP
, argv_list
->count
* sizeof(struct cmd_token
*));
964 struct cmd_token
*token
;
967 for (ALL_LIST_ELEMENTS_RO(argv_list
, ln
, token
))
970 int argc
= argv_list
->count
;
973 if (matched_element
->daemon
)
974 ret
= CMD_SUCCESS_DAEMON
;
977 /* Clear array of enqueued configuration changes. */
978 vty
->num_cfg_changes
= 0;
979 memset(&vty
->cfg_changes
, 0, sizeof(vty
->cfg_changes
));
981 /* Regenerate candidate configuration if necessary. */
982 if (frr_get_cli_mode() == FRR_CLI_CLASSIC
983 && running_config
->version
984 > vty
->candidate_config
->version
)
985 nb_config_replace(vty
->candidate_config
,
986 running_config
, true);
989 * Perform pending commit (if any) before executing
992 if (!(matched_element
->attr
& CMD_ATTR_YANG
))
993 (void)nb_cli_pending_commit_check(vty
);
996 ret
= matched_element
->func(matched_element
, vty
, argc
, argv
);
999 // delete list and cmd_token's in it
1000 list_delete(&argv_list
);
1001 XFREE(MTYPE_TMP
, argv
);
1007 * Execute a given command, handling things like "do ..." and checking
1008 * whether the given command might apply at a parent node if doesn't
1009 * apply for the current node.
1011 * @param vline Command line input, vector of char* where each element is
1013 * @param vty The vty context in which the command should be executed.
1014 * @param cmd Pointer where the struct cmd_element of the matched command
1015 * will be stored, if any. May be set to NULL if this info is
1017 * @param vtysh If set != 0, don't lookup the command at parent nodes.
1018 * @return The status of the command that has been executed or an error code
1019 * as to why no command could be executed.
1021 int cmd_execute_command(vector vline
, struct vty
*vty
,
1022 const struct cmd_element
**cmd
, int vtysh
)
1024 int ret
, saved_ret
= 0;
1025 enum node_type onode
, try_node
;
1026 int orig_xpath_index
;
1028 onode
= try_node
= vty
->node
;
1029 orig_xpath_index
= vty
->xpath_index
;
1031 if (cmd_try_do_shortcut(vty
->node
, vector_slot(vline
, 0))) {
1032 vector shifted_vline
;
1035 vty
->node
= ENABLE_NODE
;
1036 vty
->xpath_index
= 0;
1037 /* We can try it on enable node, cos' the vty is authenticated
1040 shifted_vline
= vector_init(vector_count(vline
));
1042 for (index
= 1; index
< vector_active(vline
); index
++)
1043 vector_set_index(shifted_vline
, index
- 1,
1044 vector_lookup(vline
, index
));
1046 ret
= cmd_execute_command_real(shifted_vline
, FILTER_RELAXED
,
1049 vector_free(shifted_vline
);
1051 vty
->xpath_index
= orig_xpath_index
;
1056 cmd_execute_command_real(vline
, FILTER_RELAXED
, vty
, cmd
, 0);
1061 if (ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1062 && ret
!= CMD_ERR_AMBIGUOUS
&& ret
!= CMD_ERR_INCOMPLETE
1063 && ret
!= CMD_NOT_MY_INSTANCE
&& ret
!= CMD_WARNING_CONFIG_FAILED
) {
1064 /* This assumes all nodes above CONFIG_NODE are childs of
1066 while (vty
->node
> CONFIG_NODE
) {
1067 struct cmd_node
*cnode
= vector_slot(cmdvec
, try_node
);
1069 try_node
= node_parent(try_node
);
1070 vty
->node
= try_node
;
1071 if (vty
->xpath_index
> 0 && !cnode
->no_xpath
)
1074 ret
= cmd_execute_command_real(vline
, FILTER_RELAXED
,
1076 if (ret
== CMD_SUCCESS
|| ret
== CMD_WARNING
1077 || ret
== CMD_ERR_AMBIGUOUS
|| ret
== CMD_ERR_INCOMPLETE
1078 || ret
== CMD_NOT_MY_INSTANCE
1079 || ret
== CMD_WARNING_CONFIG_FAILED
)
1082 /* no command succeeded, reset the vty to the original node */
1084 vty
->xpath_index
= orig_xpath_index
;
1087 /* return command status for original node */
1092 * Execute a given command, matching it strictly against the current node.
1093 * This mode is used when reading config files.
1095 * @param vline Command line input, vector of char* where each element is
1097 * @param vty The vty context in which the command should be executed.
1098 * @param cmd Pointer where the struct cmd_element* of the matched command
1099 * will be stored, if any. May be set to NULL if this info is
1101 * @return The status of the command that has been executed or an error code
1102 * as to why no command could be executed.
1104 int cmd_execute_command_strict(vector vline
, struct vty
*vty
,
1105 const struct cmd_element
**cmd
)
1107 return cmd_execute_command_real(vline
, FILTER_STRICT
, vty
, cmd
, 0);
1111 * Hook for preprocessing command string before executing.
1113 * All subscribers are called with the raw command string that is to be
1114 * executed. If any changes are to be made, a new string should be allocated
1115 * with MTYPE_TMP and *cmd_out updated to point to this new string. The caller
1116 * is then responsible for freeing this string.
1118 * All processing functions must be mutually exclusive in their action, i.e. if
1119 * one subscriber decides to modify the command, all others must not modify it
1120 * when called. Feeding the output of one processing command into a subsequent
1121 * one is not supported.
1123 * This hook is intentionally internal to the command processing system.
1126 * The raw command string.
1129 * The result of any processing.
1131 DECLARE_HOOK(cmd_execute
,
1132 (struct vty
*vty
, const char *cmd_in
, char **cmd_out
),
1133 (vty
, cmd_in
, cmd_out
));
1134 DEFINE_HOOK(cmd_execute
, (struct vty
*vty
, const char *cmd_in
, char **cmd_out
),
1135 (vty
, cmd_in
, cmd_out
));
1137 /* Hook executed after a CLI command. */
1138 DECLARE_KOOH(cmd_execute_done
, (struct vty
*vty
, const char *cmd_exec
),
1140 DEFINE_KOOH(cmd_execute_done
, (struct vty
*vty
, const char *cmd_exec
),
1144 * cmd_execute hook subscriber to handle `|` actions.
1146 static int handle_pipe_action(struct vty
*vty
, const char *cmd_in
,
1150 char *orig
, *working
, *token
, *u
;
1151 char *pipe
= strstr(cmd_in
, "| ");
1157 /* duplicate string for processing purposes, not including pipe */
1158 orig
= working
= XSTRDUP(MTYPE_TMP
, pipe
+ 2);
1160 /* retrieve action */
1161 token
= strsep(&working
, " ");
1164 /* match result to known actions */
1165 if (strmatch(token
, "include")) {
1166 /* the remaining text should be a regexp */
1167 char *regexp
= working
;
1170 vty_out(vty
, "%% Need a regexp to filter with\n");
1175 bool succ
= vty_set_include(vty
, regexp
);
1178 vty_out(vty
, "%% Bad regexp '%s'\n", regexp
);
1182 *cmd_out
= XSTRDUP(MTYPE_TMP
, cmd_in
);
1186 vty_out(vty
, "%% Unknown action '%s'\n", token
);
1192 XFREE(MTYPE_TMP
, orig
);
1196 static int handle_pipe_action_done(struct vty
*vty
, const char *cmd_exec
)
1199 vty_set_include(vty
, NULL
);
1204 int cmd_execute(struct vty
*vty
, const char *cmd
,
1205 const struct cmd_element
**matched
, int vtysh
)
1208 char *cmd_out
= NULL
;
1209 const char *cmd_exec
= NULL
;
1212 ret
= hook_call(cmd_execute
, vty
, cmd
, &cmd_out
);
1218 cmd_exec
= cmd_out
? (const char *)cmd_out
: cmd
;
1220 vline
= cmd_make_strvec(cmd_exec
);
1223 ret
= cmd_execute_command(vline
, vty
, matched
, vtysh
);
1224 cmd_free_strvec(vline
);
1230 hook_call(cmd_execute_done
, vty
, cmd_exec
);
1232 XFREE(MTYPE_TMP
, cmd_out
);
1239 * Parse one line of config, walking up the parse tree attempting to find a
1242 * @param vty The vty context in which the command should be executed.
1243 * @param cmd Pointer where the struct cmd_element* of the match command
1244 * will be stored, if any. May be set to NULL if this info is
1246 * @param use_daemon Boolean to control whether or not we match on
1247 * CMD_SUCCESS_DAEMON
1249 * @return The status of the command that has been executed or an error code
1250 * as to why no command could be executed.
1252 int command_config_read_one_line(struct vty
*vty
,
1253 const struct cmd_element
**cmd
,
1254 uint32_t line_num
, int use_daemon
)
1258 unsigned up_level
= 0;
1260 vline
= cmd_make_strvec(vty
->buf
);
1262 /* In case of comment line */
1266 /* Execute configuration command : this is strict match */
1267 ret
= cmd_execute_command_strict(vline
, vty
, cmd
);
1269 /* The logic for trying parent nodes is in cmd_execute_command_real()
1270 * since calling ->node_exit() correctly is a bit involved. This is
1271 * also the only reason CMD_NO_LEVEL_UP exists.
1273 while (!(use_daemon
&& ret
== CMD_SUCCESS_DAEMON
)
1274 && !(!use_daemon
&& ret
== CMD_ERR_NOTHING_TODO
)
1275 && ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1276 && ret
!= CMD_ERR_AMBIGUOUS
&& ret
!= CMD_ERR_INCOMPLETE
1277 && ret
!= CMD_NOT_MY_INSTANCE
&& ret
!= CMD_WARNING_CONFIG_FAILED
1278 && ret
!= CMD_NO_LEVEL_UP
)
1279 ret
= cmd_execute_command_real(vline
, FILTER_STRICT
, vty
, cmd
,
1282 if (ret
== CMD_NO_LEVEL_UP
)
1283 ret
= CMD_ERR_NO_MATCH
;
1285 if (ret
!= CMD_SUCCESS
&&
1286 ret
!= CMD_WARNING
&&
1287 ret
!= CMD_SUCCESS_DAEMON
) {
1288 struct vty_error
*ve
= XCALLOC(MTYPE_TMP
, sizeof(*ve
));
1290 memcpy(ve
->error_buf
, vty
->buf
, VTY_BUFSIZ
);
1291 ve
->line_num
= line_num
;
1293 vty
->error
= list_new();
1295 listnode_add(vty
->error
, ve
);
1298 cmd_free_strvec(vline
);
1303 /* Configuration make from file. */
1304 int config_from_file(struct vty
*vty
, FILE *fp
, unsigned int *line_num
)
1306 int ret
, error_ret
= 0;
1309 while (fgets(vty
->buf
, VTY_BUFSIZ
, fp
)) {
1312 ret
= command_config_read_one_line(vty
, NULL
, *line_num
, 0);
1314 if (ret
!= CMD_SUCCESS
&& ret
!= CMD_WARNING
1315 && ret
!= CMD_ERR_NOTHING_TODO
)
1326 /* Configuration from terminal */
1327 DEFUN (config_terminal
,
1328 config_terminal_cmd
,
1329 "configure [terminal]",
1330 "Configuration from vty interface\n"
1331 "Configuration terminal\n")
1333 return vty_config_enter(vty
, false, false);
1336 /* Enable command */
1340 "Turn on privileged mode command\n")
1342 /* If enable password is NULL, change to ENABLE_NODE */
1343 if ((host
.enable
== NULL
&& host
.enable_encrypt
== NULL
)
1344 || vty
->type
== VTY_SHELL_SERV
)
1345 vty
->node
= ENABLE_NODE
;
1347 vty
->node
= AUTH_ENABLE_NODE
;
1352 /* Disable command */
1356 "Turn off privileged mode command\n")
1358 if (vty
->node
== ENABLE_NODE
)
1359 vty
->node
= VIEW_NODE
;
1363 /* Down vty node level. */
1367 "Exit current mode and down to previous mode\n")
1373 static int root_on_exit(struct vty
*vty
)
1378 vty
->status
= VTY_CLOSE
;
1382 void cmd_exit(struct vty
*vty
)
1384 struct cmd_node
*cnode
= vector_lookup(cmdvec
, vty
->node
);
1386 if (cnode
->node_exit
) {
1387 if (!cnode
->node_exit(vty
))
1390 if (cnode
->parent_node
)
1391 vty
->node
= cnode
->parent_node
;
1392 if (vty
->xpath_index
> 0 && !cnode
->no_xpath
)
1400 "Exit current mode and down to previous mode\n")
1402 return config_exit(self
, vty
, argc
, argv
);
1406 /* End of configuration. */
1410 "End current mode and change to enable mode.\n")
1413 vty_config_exit(vty
);
1414 vty
->node
= ENABLE_NODE
;
1420 DEFUN (show_version
,
1424 "Displays zebra version\n")
1426 vty_out(vty
, "%s %s (%s) on %s(%s).\n", FRR_FULL_NAME
, FRR_VERSION
,
1427 cmd_hostname_get() ? cmd_hostname_get() : "", cmd_system_get(),
1429 vty_out(vty
, "%s%s\n", FRR_COPYRIGHT
, GIT_INFO
);
1430 #ifdef ENABLE_VERSION_BUILD_CONFIG
1431 vty_out(vty
, "configured with:\n %s\n", FRR_CONFIG_ARGS
);
1436 /* Help display function for all node. */
1440 "Description of the interactive help system\n")
1443 "Quagga VTY provides advanced help feature. When you need help,\n\
1444 anytime at the command line please press '?'.\n\
1446 If nothing matches, the help list will be empty and you must backup\n\
1447 until entering a '?' shows the available options.\n\
1448 Two styles of help are provided:\n\
1449 1. Full help is available when you are ready to enter a\n\
1450 command argument (e.g. 'show ?') and describes each possible\n\
1452 2. Partial help is provided when an abbreviated argument is entered\n\
1453 and you want to know what arguments match the input\n\
1454 (e.g. 'show me?'.)\n\n");
1458 static void permute(struct graph_node
*start
, struct vty
*vty
)
1460 static struct list
*position
= NULL
;
1462 position
= list_new();
1464 struct cmd_token
*stok
= start
->data
;
1465 struct graph_node
*gnn
;
1466 struct listnode
*ln
;
1469 listnode_add(position
, start
);
1470 for (unsigned int i
= 0; i
< vector_active(start
->to
); i
++) {
1471 struct graph_node
*gn
= vector_slot(start
->to
, i
);
1472 struct cmd_token
*tok
= gn
->data
;
1473 if (tok
->attr
& CMD_ATTR_HIDDEN
)
1475 else if (tok
->type
== END_TKN
|| gn
== start
) {
1477 for (ALL_LIST_ELEMENTS_RO(position
, ln
, gnn
)) {
1478 struct cmd_token
*tt
= gnn
->data
;
1479 if (tt
->type
< SPECIAL_TKN
)
1480 vty_out(vty
, " %s", tt
->text
);
1483 vty_out(vty
, "...");
1487 if (stok
->type
== FORK_TKN
&& tok
->type
!= FORK_TKN
)
1488 for (ALL_LIST_ELEMENTS_RO(position
, ln
, gnn
))
1497 list_delete_node(position
, listtail(position
));
1500 static void print_cmd(struct vty
*vty
, const char *cmd
)
1502 int i
, j
, len
= strlen(cmd
);
1507 for (i
= 0; i
< len
; i
++) {
1511 else if (strchr(" ()<>[]{}|", cmd
[i
]))
1517 if (isspace(cmd
[i
])) {
1518 /* skip leading whitespace */
1521 /* skip trailing whitespace */
1524 /* skip all whitespace after opening brackets or pipe */
1525 if (strchr("(<[{|", cmd
[i
- 1])) {
1526 while (isspace(cmd
[i
+ 1]))
1530 /* skip repeated whitespace */
1531 if (isspace(cmd
[i
+ 1]))
1533 /* skip whitespace before closing brackets or pipe */
1534 if (strchr(")>]}|", cmd
[i
+ 1]))
1536 /* convert tabs to spaces */
1537 if (cmd
[i
] == '\t') {
1547 vty_out(vty
, "%s\n", buf
);
1550 int cmd_list_cmds(struct vty
*vty
, int do_permute
)
1552 struct cmd_node
*node
= vector_slot(cmdvec
, vty
->node
);
1555 cmd_finalize_node(node
);
1556 permute(vector_slot(node
->cmdgraph
->nodes
, 0), vty
);
1558 /* loop over all commands at this node */
1559 const struct cmd_element
*element
= NULL
;
1560 for (unsigned int i
= 0; i
< vector_active(node
->cmd_vector
);
1562 if ((element
= vector_slot(node
->cmd_vector
, i
)) &&
1563 !(element
->attr
& CMD_ATTR_HIDDEN
)) {
1565 print_cmd(vty
, element
->string
);
1571 /* Help display function for all node. */
1574 "list [permutations]",
1575 "Print command list\n"
1576 "Print all possible command permutations\n")
1578 return cmd_list_cmds(vty
, argc
== 2);
1581 DEFUN (show_commandtree
,
1582 show_commandtree_cmd
,
1583 "show commandtree [permutations]",
1585 "Show command tree\n"
1586 "Permutations that we are interested in\n")
1588 return cmd_list_cmds(vty
, argc
== 3);
1591 DEFUN_HIDDEN(show_cli_graph
,
1596 "Dump current command space as DOT graph\n")
1598 struct cmd_node
*cn
= vector_slot(cmdvec
, vty
->node
);
1601 cmd_finalize_node(cn
);
1602 dot
= cmd_graph_dump_dot(cn
->cmdgraph
);
1604 vty_out(vty
, "%s\n", dot
);
1605 XFREE(MTYPE_TMP
, dot
);
1609 static int vty_write_config(struct vty
*vty
)
1612 struct cmd_node
*node
;
1617 nb_cli_show_config_prepare(running_config
, false);
1619 if (vty
->type
== VTY_TERM
) {
1620 vty_out(vty
, "\nCurrent configuration:\n");
1621 vty_out(vty
, "!\n");
1624 if (strcmp(frr_defaults_version(), FRR_VER_SHORT
))
1625 vty_out(vty
, "! loaded from %s\n", frr_defaults_version());
1626 vty_out(vty
, "frr version %s\n", FRR_VER_SHORT
);
1627 vty_out(vty
, "frr defaults %s\n", frr_defaults_profile());
1628 vty_out(vty
, "!\n");
1630 for (i
= 0; i
< vector_active(cmdvec
); i
++)
1631 if ((node
= vector_slot(cmdvec
, i
)) && node
->config_write
) {
1632 if ((*node
->config_write
)(vty
))
1633 vty_out(vty
, "!\n");
1636 if (vty
->type
== VTY_TERM
) {
1637 vty_out(vty
, "end\n");
1643 static int file_write_config(struct vty
*vty
)
1646 char *config_file
, *slash
;
1647 char *config_file_tmp
= NULL
;
1648 char *config_file_sav
= NULL
;
1649 int ret
= CMD_WARNING
;
1650 struct vty
*file_vty
;
1651 struct stat conf_stat
;
1656 /* Check and see if we are operating under vtysh configuration */
1657 if (host
.config
== NULL
) {
1659 "Can't save to configuration file, using vtysh.\n");
1664 config_file
= host
.config
;
1667 #define O_DIRECTORY 0
1669 slash
= strrchr(config_file
, '/');
1671 char *config_dir
= XSTRDUP(MTYPE_TMP
, config_file
);
1672 config_dir
[slash
- config_file
] = '\0';
1673 dirfd
= open(config_dir
, O_DIRECTORY
| O_RDONLY
);
1674 XFREE(MTYPE_TMP
, config_dir
);
1676 dirfd
= open(".", O_DIRECTORY
| O_RDONLY
);
1677 /* if dirfd is invalid, directory sync fails, but we're still OK */
1679 size_t config_file_sav_sz
= strlen(config_file
) + strlen(CONF_BACKUP_EXT
) + 1;
1680 config_file_sav
= XMALLOC(MTYPE_TMP
, config_file_sav_sz
);
1681 strlcpy(config_file_sav
, config_file
, config_file_sav_sz
);
1682 strlcat(config_file_sav
, CONF_BACKUP_EXT
, config_file_sav_sz
);
1685 config_file_tmp
= XMALLOC(MTYPE_TMP
, strlen(config_file
) + 8);
1686 snprintf(config_file_tmp
, strlen(config_file
) + 8, "%s.XXXXXX",
1689 /* Open file to configuration write. */
1690 fd
= mkstemp(config_file_tmp
);
1692 vty_out(vty
, "Can't open configuration file %s.\n",
1696 if (fchmod(fd
, CONFIGFILE_MASK
) != 0) {
1697 vty_out(vty
, "Can't chmod configuration file %s: %s (%d).\n",
1698 config_file_tmp
, safe_strerror(errno
), errno
);
1702 /* Make vty for configuration file. */
1703 file_vty
= vty_new();
1705 file_vty
->type
= VTY_FILE
;
1707 /* Config file header print. */
1708 vty_out(file_vty
, "!\n! Zebra configuration saved from vty\n! ");
1709 vty_time_print(file_vty
, 1);
1710 vty_out(file_vty
, "!\n");
1711 vty_write_config(file_vty
);
1712 vty_close(file_vty
);
1714 if (stat(config_file
, &conf_stat
) >= 0) {
1715 if (unlink(config_file_sav
) != 0)
1716 if (errno
!= ENOENT
) {
1718 "Can't unlink backup configuration file %s.\n",
1722 if (link(config_file
, config_file_sav
) != 0) {
1724 "Can't backup old configuration file %s.\n",
1731 if (rename(config_file_tmp
, config_file
) != 0) {
1732 vty_out(vty
, "Can't save configuration file %s.\n",
1739 vty_out(vty
, "Configuration saved to %s\n", config_file
);
1743 if (ret
!= CMD_SUCCESS
)
1744 unlink(config_file_tmp
);
1747 XFREE(MTYPE_TMP
, config_file_tmp
);
1748 XFREE(MTYPE_TMP
, config_file_sav
);
1752 /* Write current configuration into file. */
1754 DEFUN (config_write
,
1756 "write [<file|memory|terminal>]",
1757 "Write running configuration to memory, network, or terminal\n"
1758 "Write to configuration file\n"
1759 "Write configuration currently in memory\n"
1760 "Write configuration to terminal\n")
1762 const int idx_type
= 1;
1764 // if command was 'write terminal' or 'write memory'
1765 if (argc
== 2 && (!strcmp(argv
[idx_type
]->text
, "terminal"))) {
1766 return vty_write_config(vty
);
1769 return file_write_config(vty
);
1772 /* ALIAS_FIXME for 'write <terminal|memory>' */
1773 DEFUN (show_running_config
,
1774 show_running_config_cmd
,
1775 "show running-config",
1777 "running configuration (same as write terminal)\n")
1779 return vty_write_config(vty
);
1782 /* ALIAS_FIXME for 'write file' */
1783 DEFUN (copy_runningconf_startupconf
,
1784 copy_runningconf_startupconf_cmd
,
1785 "copy running-config startup-config",
1786 "Copy configuration\n"
1787 "Copy running config to... \n"
1788 "Copy running config to startup config (same as write file/memory)\n")
1790 return file_write_config(vty
);
1794 /* Write startup configuration into the terminal. */
1795 DEFUN (show_startup_config
,
1796 show_startup_config_cmd
,
1797 "show startup-config",
1799 "Contents of startup configuration\n")
1806 if (host
.config
== NULL
)
1809 confp
= fopen(host
.config
, "r");
1810 if (confp
== NULL
) {
1811 vty_out(vty
, "Can't open configuration file [%s] due to '%s'\n",
1812 host
.config
, safe_strerror(errno
));
1816 while (fgets(buf
, BUFSIZ
, confp
)) {
1819 while (*cp
!= '\r' && *cp
!= '\n' && *cp
!= '\0')
1823 vty_out(vty
, "%s\n", buf
);
1831 int cmd_domainname_set(const char *domainname
)
1833 XFREE(MTYPE_HOST
, host
.domainname
);
1834 host
.domainname
= domainname
? XSTRDUP(MTYPE_HOST
, domainname
) : NULL
;
1838 /* Hostname configuration */
1839 DEFUN(config_domainname
,
1842 "Set system's domain name\n"
1843 "This system's domain name\n")
1845 struct cmd_token
*word
= argv
[1];
1847 if (!isalpha((unsigned char)word
->arg
[0])) {
1848 vty_out(vty
, "Please specify string starting with alphabet\n");
1849 return CMD_WARNING_CONFIG_FAILED
;
1852 return cmd_domainname_set(word
->arg
);
1855 DEFUN(config_no_domainname
,
1857 "no domainname [DOMAINNAME]",
1859 "Reset system's domain name\n"
1860 "domain name of this router\n")
1862 return cmd_domainname_set(NULL
);
1865 int cmd_hostname_set(const char *hostname
)
1867 XFREE(MTYPE_HOST
, host
.name
);
1868 host
.name
= hostname
? XSTRDUP(MTYPE_HOST
, hostname
) : NULL
;
1872 /* Hostname configuration */
1873 DEFUN (config_hostname
,
1876 "Set system's network name\n"
1877 "This system's network name\n")
1879 struct cmd_token
*word
= argv
[1];
1881 if (!isalnum((unsigned char)word
->arg
[0])) {
1883 "Please specify string starting with alphabet or number\n");
1884 return CMD_WARNING_CONFIG_FAILED
;
1887 /* With reference to RFC 1123 Section 2.1 */
1888 if (strlen(word
->arg
) > HOSTNAME_LEN
) {
1889 vty_out(vty
, "Hostname length should be less than %d chars\n",
1891 return CMD_WARNING_CONFIG_FAILED
;
1894 return cmd_hostname_set(word
->arg
);
1897 DEFUN (config_no_hostname
,
1899 "no hostname [HOSTNAME]",
1901 "Reset system's network name\n"
1902 "Host name of this router\n")
1904 return cmd_hostname_set(NULL
);
1907 /* VTY interface password set. */
1908 DEFUN (config_password
,
1910 "password [(8-8)] WORD",
1911 "Modify the terminal connection password\n"
1912 "Specifies a HIDDEN password will follow\n"
1913 "The password string\n")
1917 if (argc
== 3) // '8' was specified
1920 XFREE(MTYPE_HOST
, host
.password
);
1921 host
.password
= NULL
;
1922 if (host
.password_encrypt
)
1923 XFREE(MTYPE_HOST
, host
.password_encrypt
);
1924 host
.password_encrypt
=
1925 XSTRDUP(MTYPE_HOST
, argv
[idx_word
]->arg
);
1929 if (!isalnum((unsigned char)argv
[idx_8
]->arg
[0])) {
1931 "Please specify string starting with alphanumeric\n");
1932 return CMD_WARNING_CONFIG_FAILED
;
1936 XFREE(MTYPE_HOST
, host
.password
);
1937 host
.password
= NULL
;
1940 if (host
.password_encrypt
)
1941 XFREE(MTYPE_HOST
, host
.password_encrypt
);
1942 host
.password_encrypt
=
1943 XSTRDUP(MTYPE_HOST
, zencrypt(argv
[idx_8
]->arg
));
1945 host
.password
= XSTRDUP(MTYPE_HOST
, argv
[idx_8
]->arg
);
1950 /* VTY interface password delete. */
1951 DEFUN (no_config_password
,
1955 "Modify the terminal connection password\n")
1957 bool warned
= false;
1959 if (host
.password
) {
1960 if (!vty_shell_serv(vty
)) {
1961 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
1964 XFREE(MTYPE_HOST
, host
.password
);
1966 host
.password
= NULL
;
1968 if (host
.password_encrypt
) {
1969 if (!warned
&& !vty_shell_serv(vty
))
1970 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
1971 XFREE(MTYPE_HOST
, host
.password_encrypt
);
1973 host
.password_encrypt
= NULL
;
1978 /* VTY enable password set. */
1979 DEFUN (config_enable_password
,
1980 enable_password_cmd
,
1981 "enable password [(8-8)] WORD",
1982 "Modify enable password parameters\n"
1983 "Assign the privileged level password\n"
1984 "Specifies a HIDDEN password will follow\n"
1985 "The HIDDEN 'enable' password string\n")
1990 /* Crypt type is specified. */
1992 if (argv
[idx_8
]->arg
[0] == '8') {
1994 XFREE(MTYPE_HOST
, host
.enable
);
1997 if (host
.enable_encrypt
)
1998 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
1999 host
.enable_encrypt
=
2000 XSTRDUP(MTYPE_HOST
, argv
[idx_word
]->arg
);
2004 vty_out(vty
, "Unknown encryption type.\n");
2005 return CMD_WARNING_CONFIG_FAILED
;
2009 if (!isalnum((unsigned char)argv
[idx_8
]->arg
[0])) {
2011 "Please specify string starting with alphanumeric\n");
2012 return CMD_WARNING_CONFIG_FAILED
;
2016 XFREE(MTYPE_HOST
, host
.enable
);
2019 /* Plain password input. */
2021 if (host
.enable_encrypt
)
2022 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2023 host
.enable_encrypt
=
2024 XSTRDUP(MTYPE_HOST
, zencrypt(argv
[idx_8
]->arg
));
2026 host
.enable
= XSTRDUP(MTYPE_HOST
, argv
[idx_8
]->arg
);
2031 /* VTY enable password delete. */
2032 DEFUN (no_config_enable_password
,
2033 no_enable_password_cmd
,
2034 "no enable password",
2036 "Modify enable password parameters\n"
2037 "Assign the privileged level password\n")
2039 bool warned
= false;
2042 if (!vty_shell_serv(vty
)) {
2043 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2046 XFREE(MTYPE_HOST
, host
.enable
);
2050 if (host
.enable_encrypt
) {
2051 if (!warned
&& !vty_shell_serv(vty
))
2052 vty_out(vty
, NO_PASSWD_CMD_WARNING
);
2053 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2055 host
.enable_encrypt
= NULL
;
2060 DEFUN (service_password_encrypt
,
2061 service_password_encrypt_cmd
,
2062 "service password-encryption",
2063 "Set up miscellaneous service\n"
2064 "Enable encrypted passwords\n")
2071 if (host
.password
) {
2072 if (host
.password_encrypt
)
2073 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2074 host
.password_encrypt
=
2075 XSTRDUP(MTYPE_HOST
, zencrypt(host
.password
));
2078 if (host
.enable_encrypt
)
2079 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2080 host
.enable_encrypt
=
2081 XSTRDUP(MTYPE_HOST
, zencrypt(host
.enable
));
2087 DEFUN (no_service_password_encrypt
,
2088 no_service_password_encrypt_cmd
,
2089 "no service password-encryption",
2091 "Set up miscellaneous service\n"
2092 "Enable encrypted passwords\n")
2099 if (host
.password_encrypt
)
2100 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2101 host
.password_encrypt
= NULL
;
2103 if (host
.enable_encrypt
)
2104 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2105 host
.enable_encrypt
= NULL
;
2110 DEFUN (config_terminal_length
,
2111 config_terminal_length_cmd
,
2112 "terminal length (0-512)",
2113 "Set terminal line parameters\n"
2114 "Set number of lines on a screen\n"
2115 "Number of lines on screen (0 for no pausing)\n")
2119 vty
->lines
= atoi(argv
[idx_number
]->arg
);
2124 DEFUN (config_terminal_no_length
,
2125 config_terminal_no_length_cmd
,
2126 "terminal no length",
2127 "Set terminal line parameters\n"
2129 "Set number of lines on a screen\n")
2135 DEFUN (service_terminal_length
,
2136 service_terminal_length_cmd
,
2137 "service terminal-length (0-512)",
2138 "Set up miscellaneous service\n"
2139 "System wide terminal length configuration\n"
2140 "Number of lines of VTY (0 means no line control)\n")
2144 host
.lines
= atoi(argv
[idx_number
]->arg
);
2149 DEFUN (no_service_terminal_length
,
2150 no_service_terminal_length_cmd
,
2151 "no service terminal-length [(0-512)]",
2153 "Set up miscellaneous service\n"
2154 "System wide terminal length configuration\n"
2155 "Number of lines of VTY (0 means no line control)\n")
2161 DEFUN_HIDDEN (do_echo
,
2164 "Echo a message back to the vty\n"
2165 "The message to echo\n")
2169 vty_out(vty
, "%s\n",
2170 ((message
= argv_concat(argv
, argc
, 1)) ? message
: ""));
2172 XFREE(MTYPE_TMP
, message
);
2176 DEFUN (config_logmsg
,
2178 "logmsg <emergencies|alerts|critical|errors|warnings|notifications|informational|debugging> MESSAGE...",
2179 "Send a message to enabled logging destinations\n"
2181 "The message to send\n")
2183 int idx_log_level
= 1;
2184 int idx_message
= 2;
2188 level
= log_level_match(argv
[idx_log_level
]->arg
);
2189 if (level
== ZLOG_DISABLED
)
2190 return CMD_ERR_NO_MATCH
;
2193 ((message
= argv_concat(argv
, argc
, idx_message
)) ? message
: ""));
2195 XFREE(MTYPE_TMP
, message
);
2200 DEFUN (debug_memstats
,
2202 "[no] debug memstats-at-exit",
2205 "Print memory type statistics at exit\n")
2207 debug_memstats_at_exit
= !!strcmp(argv
[0]->text
, "no");
2211 int cmd_banner_motd_file(const char *file
)
2213 int success
= CMD_SUCCESS
;
2218 rpath
= realpath(file
, p
);
2220 return CMD_ERR_NO_FILE
;
2221 in
= strstr(rpath
, SYSCONFDIR
);
2223 XFREE(MTYPE_HOST
, host
.motdfile
);
2224 host
.motdfile
= XSTRDUP(MTYPE_HOST
, file
);
2226 success
= CMD_WARNING_CONFIG_FAILED
;
2231 void cmd_banner_motd_line(const char *line
)
2233 XFREE(MTYPE_HOST
, host
.motd
);
2234 host
.motd
= XSTRDUP(MTYPE_HOST
, line
);
2237 DEFUN (banner_motd_file
,
2238 banner_motd_file_cmd
,
2239 "banner motd file FILE",
2242 "Banner from a file\n"
2246 const char *filename
= argv
[idx_file
]->arg
;
2247 int cmd
= cmd_banner_motd_file(filename
);
2249 if (cmd
== CMD_ERR_NO_FILE
)
2250 vty_out(vty
, "%s does not exist\n", filename
);
2251 else if (cmd
== CMD_WARNING_CONFIG_FAILED
)
2252 vty_out(vty
, "%s must be in %s\n", filename
, SYSCONFDIR
);
2257 DEFUN (banner_motd_line
,
2258 banner_motd_line_cmd
,
2259 "banner motd line LINE...",
2262 "Banner from an input\n"
2268 argv_find(argv
, argc
, "LINE", &idx
);
2269 motd
= argv_concat(argv
, argc
, idx
);
2271 cmd_banner_motd_line(motd
);
2272 XFREE(MTYPE_TMP
, motd
);
2277 DEFUN (banner_motd_default
,
2278 banner_motd_default_cmd
,
2279 "banner motd default",
2280 "Set banner string\n"
2281 "Strings for motd\n"
2284 cmd_banner_motd_line(FRR_DEFAULT_MOTD
);
2288 DEFUN (no_banner_motd
,
2292 "Set banner string\n"
2293 "Strings for motd\n")
2297 XFREE(MTYPE_HOST
, host
.motdfile
);
2298 host
.motdfile
= NULL
;
2302 DEFUN(allow_reserved_ranges
, allow_reserved_ranges_cmd
, "allow-reserved-ranges",
2303 "Allow using IPv4 (Class E) reserved IP space\n")
2305 host
.allow_reserved_ranges
= true;
2309 DEFUN(no_allow_reserved_ranges
, no_allow_reserved_ranges_cmd
,
2310 "no allow-reserved-ranges",
2311 NO_STR
"Allow using IPv4 (Class E) reserved IP space\n")
2313 host
.allow_reserved_ranges
= false;
2317 int cmd_find_cmds(struct vty
*vty
, struct cmd_token
**argv
, int argc
)
2319 const struct cmd_node
*node
;
2320 const struct cmd_element
*cli
;
2325 char *pattern
= argv_concat(argv
, argc
, 1);
2326 int cr
= regcomp(&exp
, pattern
, REG_NOSUB
| REG_EXTENDED
);
2327 XFREE(MTYPE_TMP
, pattern
);
2332 vty_out(vty
, "%% Invalid {...} expression\n");
2335 vty_out(vty
, "%% Bad repetition operator\n");
2338 vty_out(vty
, "%% Regex syntax error\n");
2341 vty_out(vty
, "%% Invalid collating element\n");
2344 vty_out(vty
, "%% Invalid character class name\n");
2348 "%% Regex ended with escape character (\\)\n");
2352 "%% Invalid number in \\digit construction\n");
2355 vty_out(vty
, "%% Unbalanced square brackets\n");
2358 vty_out(vty
, "%% Unbalanced parentheses\n");
2361 vty_out(vty
, "%% Unbalanced braces\n");
2365 "%% Invalid endpoint in range expression\n");
2368 vty_out(vty
, "%% Failed to compile (out of memory)\n");
2376 for (unsigned int i
= 0; i
< vector_active(cmdvec
); i
++) {
2377 node
= vector_slot(cmdvec
, i
);
2380 clis
= node
->cmd_vector
;
2381 for (unsigned int j
= 0; j
< vector_active(clis
); j
++) {
2382 cli
= vector_slot(clis
, j
);
2384 if (regexec(&exp
, cli
->string
, 0, NULL
, 0) == 0) {
2385 vty_out(vty
, " (%s) ", node
->name
);
2386 print_cmd(vty
, cli
->string
);
2399 "Find CLI command matching a regular expression\n"
2400 "Search pattern (POSIX regex)\n")
2402 return cmd_find_cmds(vty
, argv
, argc
);
2405 #if defined(DEV_BUILD) && defined(HAVE_SCRIPTING)
2406 DEFUN(script
, script_cmd
, "script SCRIPT FUNCTION",
2407 "Test command - execute a function in a script\n"
2408 "Script name (same as filename in /etc/frr/scripts/)\n"
2409 "Function name (in the script)\n")
2413 (void)str2prefix("1.2.3.4/24", &p
);
2414 struct frrscript
*fs
= frrscript_new(argv
[1]->arg
);
2416 if (frrscript_load(fs
, argv
[2]->arg
, NULL
)) {
2418 "/etc/frr/scripts/%s.lua or function '%s' not found\n",
2419 argv
[1]->arg
, argv
[2]->arg
);
2422 int ret
= frrscript_call(fs
, argv
[2]->arg
, ("p", &p
));
2424 prefix2str(&p
, buf
, sizeof(buf
));
2425 vty_out(vty
, "p: %s\n", buf
);
2426 vty_out(vty
, "Script result: %d\n", ret
);
2428 frrscript_delete(fs
);
2434 /* Set config filename. Called from vty.c */
2435 void host_config_set(const char *filename
)
2437 XFREE(MTYPE_HOST
, host
.config
);
2438 host
.config
= XSTRDUP(MTYPE_HOST
, filename
);
2441 const char *host_config_get(void)
2446 void cmd_show_lib_debugs(struct vty
*vty
)
2448 route_map_show_debug(vty
);
2451 void install_default(enum node_type node
)
2453 _install_element(node
, &config_exit_cmd
);
2454 _install_element(node
, &config_quit_cmd
);
2455 _install_element(node
, &config_end_cmd
);
2456 _install_element(node
, &config_help_cmd
);
2457 _install_element(node
, &config_list_cmd
);
2458 _install_element(node
, &show_cli_graph_cmd
);
2459 _install_element(node
, &find_cmd
);
2461 _install_element(node
, &config_write_cmd
);
2462 _install_element(node
, &show_running_config_cmd
);
2464 _install_element(node
, &autocomplete_cmd
);
2466 nb_cli_install_default(node
);
2469 /* Initialize command interface. Install basic nodes and commands.
2471 * terminal = 0 -- vtysh / no logging, no config control
2472 * terminal = 1 -- normal daemon
2473 * terminal = -1 -- watchfrr / no logging, but minimal config control */
2474 void cmd_init(int terminal
)
2476 struct utsname names
;
2481 /* register command preprocessors */
2482 hook_register(cmd_execute
, handle_pipe_action
);
2483 hook_register(cmd_execute_done
, handle_pipe_action_done
);
2485 varhandlers
= list_new();
2487 /* Allocate initial top vector of commands. */
2488 cmdvec
= vector_init(VECTOR_MIN_SIZE
);
2490 /* Default host value settings. */
2491 host
.name
= XSTRDUP(MTYPE_HOST
, names
.nodename
);
2492 host
.system
= XSTRDUP(MTYPE_HOST
, names
.sysname
);
2493 host
.release
= XSTRDUP(MTYPE_HOST
, names
.release
);
2494 host
.version
= XSTRDUP(MTYPE_HOST
, names
.version
);
2496 #ifdef HAVE_STRUCT_UTSNAME_DOMAINNAME
2497 if ((strcmp(names
.domainname
, "(none)") == 0))
2498 host
.domainname
= NULL
;
2500 host
.domainname
= XSTRDUP(MTYPE_HOST
, names
.domainname
);
2502 host
.domainname
= NULL
;
2504 host
.password
= NULL
;
2507 host
.noconfig
= (terminal
< 0);
2509 cmd_banner_motd_line(FRR_DEFAULT_MOTD
);
2510 host
.motdfile
= NULL
;
2511 host
.allow_reserved_ranges
= false;
2513 /* Install top nodes. */
2514 install_node(&view_node
);
2515 install_node(&enable_node
);
2516 install_node(&auth_node
);
2517 install_node(&auth_enable_node
);
2518 install_node(&config_node
);
2520 /* Each node's basic commands. */
2521 install_element(VIEW_NODE
, &show_version_cmd
);
2522 install_element(ENABLE_NODE
, &show_startup_config_cmd
);
2525 install_element(ENABLE_NODE
, &debug_memstats_cmd
);
2527 install_element(VIEW_NODE
, &config_list_cmd
);
2528 install_element(VIEW_NODE
, &config_exit_cmd
);
2529 install_element(VIEW_NODE
, &config_quit_cmd
);
2530 install_element(VIEW_NODE
, &config_help_cmd
);
2531 install_element(VIEW_NODE
, &config_enable_cmd
);
2532 install_element(VIEW_NODE
, &config_terminal_length_cmd
);
2533 install_element(VIEW_NODE
, &config_terminal_no_length_cmd
);
2534 install_element(VIEW_NODE
, &show_commandtree_cmd
);
2535 install_element(VIEW_NODE
, &echo_cmd
);
2536 install_element(VIEW_NODE
, &autocomplete_cmd
);
2537 install_element(VIEW_NODE
, &find_cmd
);
2538 #if defined(DEV_BUILD) && defined(HAVE_SCRIPTING)
2539 install_element(VIEW_NODE
, &script_cmd
);
2543 install_element(ENABLE_NODE
, &config_end_cmd
);
2544 install_element(ENABLE_NODE
, &config_disable_cmd
);
2545 install_element(ENABLE_NODE
, &config_terminal_cmd
);
2546 install_element(ENABLE_NODE
, ©_runningconf_startupconf_cmd
);
2547 install_element(ENABLE_NODE
, &config_write_cmd
);
2548 install_element(ENABLE_NODE
, &show_running_config_cmd
);
2549 install_element(ENABLE_NODE
, &config_logmsg_cmd
);
2551 install_default(CONFIG_NODE
);
2554 workqueue_cmd_init();
2558 install_element(CONFIG_NODE
, &hostname_cmd
);
2559 install_element(CONFIG_NODE
, &no_hostname_cmd
);
2560 install_element(CONFIG_NODE
, &domainname_cmd
);
2561 install_element(CONFIG_NODE
, &no_domainname_cmd
);
2566 install_element(CONFIG_NODE
, &debug_memstats_cmd
);
2568 install_element(CONFIG_NODE
, &password_cmd
);
2569 install_element(CONFIG_NODE
, &no_password_cmd
);
2570 install_element(CONFIG_NODE
, &enable_password_cmd
);
2571 install_element(CONFIG_NODE
, &no_enable_password_cmd
);
2573 install_element(CONFIG_NODE
, &service_password_encrypt_cmd
);
2574 install_element(CONFIG_NODE
, &no_service_password_encrypt_cmd
);
2575 install_element(CONFIG_NODE
, &banner_motd_default_cmd
);
2576 install_element(CONFIG_NODE
, &banner_motd_file_cmd
);
2577 install_element(CONFIG_NODE
, &banner_motd_line_cmd
);
2578 install_element(CONFIG_NODE
, &no_banner_motd_cmd
);
2579 install_element(CONFIG_NODE
, &service_terminal_length_cmd
);
2580 install_element(CONFIG_NODE
, &no_service_terminal_length_cmd
);
2581 install_element(CONFIG_NODE
, &allow_reserved_ranges_cmd
);
2582 install_element(CONFIG_NODE
, &no_allow_reserved_ranges_cmd
);
2585 vrf_install_commands();
2589 grammar_sandbox_init();
2593 void cmd_terminate(void)
2595 struct cmd_node
*cmd_node
;
2597 hook_unregister(cmd_execute
, handle_pipe_action
);
2598 hook_unregister(cmd_execute_done
, handle_pipe_action_done
);
2601 for (unsigned int i
= 0; i
< vector_active(cmdvec
); i
++)
2602 if ((cmd_node
= vector_slot(cmdvec
, i
)) != NULL
) {
2603 // deleting the graph delets the cmd_element as
2605 graph_delete_graph(cmd_node
->cmdgraph
);
2606 vector_free(cmd_node
->cmd_vector
);
2607 hash_clean(cmd_node
->cmd_hash
, NULL
);
2608 hash_free(cmd_node
->cmd_hash
);
2609 cmd_node
->cmd_hash
= NULL
;
2612 vector_free(cmdvec
);
2616 XFREE(MTYPE_HOST
, host
.name
);
2617 XFREE(MTYPE_HOST
, host
.system
);
2618 XFREE(MTYPE_HOST
, host
.release
);
2619 XFREE(MTYPE_HOST
, host
.version
);
2620 XFREE(MTYPE_HOST
, host
.domainname
);
2621 XFREE(MTYPE_HOST
, host
.password
);
2622 XFREE(MTYPE_HOST
, host
.password_encrypt
);
2623 XFREE(MTYPE_HOST
, host
.enable
);
2624 XFREE(MTYPE_HOST
, host
.enable_encrypt
);
2625 XFREE(MTYPE_HOST
, host
.motdfile
);
2626 XFREE(MTYPE_HOST
, host
.config
);
2627 XFREE(MTYPE_HOST
, host
.motd
);
2629 list_delete(&varhandlers
);