2017-06-20 02:35:06 +00:00
|
|
|
/*! \file command.h
|
|
|
|
* Zebra configuration command interface routine. */
|
2010-05-19 17:02:52 +00:00
|
|
|
/*
|
|
|
|
* Copyright (C) 1997, 98 Kunihiro Ishiguro
|
|
|
|
*
|
|
|
|
* This file is part of GNU Zebra.
|
|
|
|
*
|
|
|
|
* GNU Zebra is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published
|
|
|
|
* by the Free Software Foundation; either version 2, or (at your
|
|
|
|
* option) any later version.
|
|
|
|
*
|
|
|
|
* GNU Zebra is distributed in the hope that it will be useful, but
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with GNU Zebra; see the file COPYING. If not, write to the
|
2015-11-11 15:02:54 +00:00
|
|
|
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
|
* Boston, MA 02110-1301, USA.
|
2010-05-19 17:02:52 +00:00
|
|
|
*/
|
|
|
|
|
2014-06-16 08:13:40 +00:00
|
|
|
#pragma once
|
2010-05-19 17:02:52 +00:00
|
|
|
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include "vector.h"
|
|
|
|
|
vty: install 'exit', 'end',... commands on *all* nodes
In many callers of the VTY API, we are lacking the vty_install_default() step
at certain node levels. This creates nodes that lack the 'exit' command, and
hence the only way to exit such a node is to restart the telnet session.
Historically, the VTY looked for missing commands on the immediate parent node,
and hence possibly found the parent's 'exit' command when the local node was
missing it. That is why we so far did not notice the missing default commands.
Furthermore, some callers call install_default() instead of
vty_install_default(). Only vty_install_default() also includes the 'exit' and
'end' commands. There is no reason why there are two sets of default commands.
To end this confusion, to catch all missing 'exit' commands and to prevent this
from re-appearing in the future, simply *always* install all default commands
implicitly when calling install_node().
In cmd_init(), there are some top-level nodes that apparently do not want the
default commands installed. Keep those the way they are, by changing the
invocation to new install_node_bare() ({VIEW,AUTH,AUTH_ENABLE}_NODE).
Make both install_default() and vty_install_default() no-ops so that users of
the API may still call them without harm. Do not yet deprecate yet, which
follows in Icf5d83f641e838cebcccc635a043e94ba352abff.
Drop all invocations to these two functions found in libosmocore.
Change-Id: I5021c64a787b63314e0f2f1cba0b8fc7bff4f09b
2017-09-20 13:39:37 +00:00
|
|
|
#include <osmocom/core/defs.h>
|
|
|
|
|
2011-08-17 16:52:30 +00:00
|
|
|
/*! \defgroup command VTY Command
|
2011-08-17 15:13:48 +00:00
|
|
|
* @{
|
2017-06-20 02:35:06 +00:00
|
|
|
* \file command.h */
|
2011-08-17 15:13:48 +00:00
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Host configuration variable */
|
2010-05-19 17:02:52 +00:00
|
|
|
struct host {
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Host name of this router. */
|
2010-05-19 17:02:52 +00:00
|
|
|
char *name;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Password for vty interface. */
|
2010-05-19 17:02:52 +00:00
|
|
|
char *password;
|
|
|
|
char *password_encrypt;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Enable password */
|
2010-05-19 17:02:52 +00:00
|
|
|
char *enable;
|
|
|
|
char *enable_encrypt;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! System wide terminal lines. */
|
2010-05-19 17:02:52 +00:00
|
|
|
int lines;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Log filename. */
|
2010-05-19 17:02:52 +00:00
|
|
|
char *logfile;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! config file name of this host */
|
2010-05-19 17:02:52 +00:00
|
|
|
char *config;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Flags for services */
|
2010-05-19 17:02:52 +00:00
|
|
|
int advanced;
|
|
|
|
int encrypt;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Banner configuration. */
|
2010-05-19 17:02:52 +00:00
|
|
|
const char *motd;
|
|
|
|
char *motdfile;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! VTY application information */
|
2010-05-25 21:00:45 +00:00
|
|
|
const struct vty_app_info *app_info;
|
2010-05-19 17:02:52 +00:00
|
|
|
};
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! There are some command levels which called from command node. */
|
2010-05-19 17:02:52 +00:00
|
|
|
enum node_type {
|
2017-06-19 22:17:59 +00:00
|
|
|
AUTH_NODE, /*!< Authentication mode of vty interface. */
|
|
|
|
VIEW_NODE, /*!< View node. Default mode of vty interface. */
|
|
|
|
AUTH_ENABLE_NODE, /*!< Authentication mode for change enable. */
|
|
|
|
ENABLE_NODE, /*!< Enable node. */
|
|
|
|
CONFIG_NODE, /*!< Config node. Default mode of config file. */
|
|
|
|
SERVICE_NODE, /*!< Service node. */
|
|
|
|
DEBUG_NODE, /*!< Debug node. */
|
|
|
|
CFG_LOG_NODE, /*!< Configure the logging */
|
|
|
|
CFG_STATS_NODE, /*!< Configure the statistics */
|
|
|
|
|
|
|
|
VTY_NODE, /*!< Vty node. */
|
|
|
|
|
|
|
|
L_E1INP_NODE, /*!< E1 line in libosmo-abis. */
|
|
|
|
L_IPA_NODE, /*!< IPA proxying commands in libosmo-abis. */
|
|
|
|
L_NS_NODE, /*!< NS node in libosmo-gb. */
|
|
|
|
L_BSSGP_NODE, /*!< BSSGP node in libosmo-gb. */
|
|
|
|
L_CTRL_NODE, /*!< Control interface node. */
|
|
|
|
|
|
|
|
L_CS7_NODE, /*!< SS7 root node */
|
|
|
|
L_CS7_AS_NODE, /*!< SS7 Application Server */
|
|
|
|
L_CS7_ASP_NODE, /*!< SS7 Application Server Process */
|
|
|
|
L_CS7_XUA_NODE, /*!< SS7 xUA Listener */
|
|
|
|
L_CS7_RTABLE_NODE, /*!< SS7 Routing Table */
|
|
|
|
L_CS7_LINK_NODE, /*!< SS7 Link */
|
|
|
|
L_CS7_LINKSET_NODE, /*!< SS7 Linkset */
|
|
|
|
L_CS7_SCCPADDR_NODE, /*!< SS7 SCCP Address */
|
|
|
|
L_CS7_SCCPADDR_GT_NODE, /*!< SS7 SCCP Global Title */
|
2017-04-14 12:01:56 +00:00
|
|
|
|
2020-07-28 09:57:51 +00:00
|
|
|
L_CPU_SCHED_NODE, /*!< CPU Sched related options node */
|
2015-11-02 09:50:50 +00:00
|
|
|
/*
|
|
|
|
* When adding new nodes to the libosmocore project, these nodes can be
|
|
|
|
* used to avoid ABI changes for unrelated projects.
|
|
|
|
*/
|
2017-06-19 22:17:59 +00:00
|
|
|
RESERVED3_NODE, /*!< Reserved for later extensions */
|
2015-11-02 09:50:50 +00:00
|
|
|
|
2010-05-31 14:01:59 +00:00
|
|
|
_LAST_OSMOVTY_NODE
|
2010-05-19 17:02:52 +00:00
|
|
|
};
|
|
|
|
|
2012-07-12 07:22:56 +00:00
|
|
|
#include "vty.h"
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Node which has some commands and prompt string and
|
2011-08-17 15:13:48 +00:00
|
|
|
* configuration function pointer . */
|
2010-05-19 17:02:52 +00:00
|
|
|
struct cmd_node {
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Node index */
|
2015-08-02 02:14:07 +00:00
|
|
|
int node;
|
2010-05-19 17:02:52 +00:00
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Prompt character at vty interface. */
|
2010-05-19 17:02:52 +00:00
|
|
|
const char *prompt;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Is this node's configuration goes to vtysh ? */
|
2010-05-19 17:02:52 +00:00
|
|
|
int vtysh;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Node's configuration write function */
|
2010-05-19 17:02:52 +00:00
|
|
|
int (*func) (struct vty *);
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Vector of this node's command list. */
|
2010-05-19 17:02:52 +00:00
|
|
|
vector cmd_vector;
|
vty: derive node name from prompt, use as XML ids
The 'show online-help' produces XML output with <node id="..."> ids. We
reference those from the osmo-gsm-manuals.
Instead of numeric IDs coming from internal code, rather use a human-readable
node ID -- referencing id='config-msc' is much easier than referencing id='23'.
Add a char name[] to struct cmd_node, to hold this name. This may be provided
upon struct definition.
Since callers of the VTY API so far don't have a name yet, we would need to add
names everywhere to get meaningful node IDs. There is a way to get node ID
names without touching dependent code:
My first idea was to find out which command entered the node, i.e. command
'msc' enters the MSC_NODE. But it is impossible to derive which command entered
which node from data structs, it's hidden in the vty command definition.
But in fact all (TM) known API callers indeed provide a prompt string that
contains a logical and human readable string name. Thus, if the name is unset
in the struct, parse the prompt string and strip all "weird" characters to
obtain a node name from that. We can still set names later on, but for now will
have meaningful node IDs (e.g. 'config-msc' from '%s(config-msc)# ') without
touching any dependent code.
When VTY nodes get identical node names, which is quite possible, the XML
export de-dups these by appending _2, _3,... suffixes. The first occurence is
called e.g. 'name', the second 'name_2', then 'name_3', and so forth.
If a node has no name (even after parsing the prompt), it will be named merely
by the suffix. The first empty node will become id='_1', then '_2', '_3', and
so forth. This happens for nodes like VIEW_NODE or AUTH_NODE.
If this is merged, we need to adjust the references in osmo-gsm-manuals.git.
This can happen in our own time though, because we manually create the vty
reference xml and copy it to the osmo-gsm-manuals.git and then update the
references from the vty_additions.xml. This anyway has to happen because
currently the references tend to be hopelessly out of sync anyway, placing
comments at wildly unrelated VTY commands.
Change-Id: I8fa555570268b231c5e01727c661da92fad265de
2017-09-18 14:42:06 +00:00
|
|
|
|
|
|
|
/*! Human-readable ID of this node. Should only contain alphanumeric
|
|
|
|
* plus '-' and '_' characters (is used as XML ID for 'show
|
|
|
|
* online-help'). If left NUL, this is derived from the prompt.*/
|
|
|
|
char name[64];
|
2010-05-19 17:02:52 +00:00
|
|
|
};
|
|
|
|
|
2018-09-24 05:56:31 +00:00
|
|
|
/*! Attributes (flags) for \ref cmd_element */
|
2010-05-19 17:02:52 +00:00
|
|
|
enum {
|
2018-09-24 05:56:31 +00:00
|
|
|
CMD_ATTR_DEPRECATED = (1 << 0),
|
|
|
|
CMD_ATTR_HIDDEN = (1 << 1),
|
2010-05-19 17:02:52 +00:00
|
|
|
};
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Structure of a command element */
|
2010-05-19 17:02:52 +00:00
|
|
|
struct cmd_element {
|
2017-06-19 22:17:59 +00:00
|
|
|
const char *string; /*!< Command specification by string. */
|
2010-05-19 17:02:52 +00:00
|
|
|
int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
|
2017-06-19 22:17:59 +00:00
|
|
|
const char *doc; /*!< Documentation of this command. */
|
|
|
|
int daemon; /*!< Daemon to which this command belong. */
|
|
|
|
vector strvec; /*!< Pointing out each description vector. */
|
|
|
|
unsigned int cmdsize; /*!< Command index count. */
|
|
|
|
char *config; /*!< Configuration string */
|
|
|
|
vector subconfig; /*!< Sub configuration string */
|
2020-08-15 15:16:30 +00:00
|
|
|
unsigned char attr; /*!< Command attributes (global) */
|
|
|
|
unsigned int usrattr; /*!< Command attributes (program specific) */
|
2010-05-19 17:02:52 +00:00
|
|
|
};
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Command description structure. */
|
2010-05-19 17:02:52 +00:00
|
|
|
struct desc {
|
2017-06-19 22:17:59 +00:00
|
|
|
const char *cmd; /*!< Command string. */
|
|
|
|
const char *str; /*!< Command's description. */
|
2010-05-19 17:02:52 +00:00
|
|
|
};
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Return value of the commands. */
|
2010-05-19 17:02:52 +00:00
|
|
|
#define CMD_SUCCESS 0
|
|
|
|
#define CMD_WARNING 1
|
|
|
|
#define CMD_ERR_NO_MATCH 2
|
|
|
|
#define CMD_ERR_AMBIGUOUS 3
|
|
|
|
#define CMD_ERR_INCOMPLETE 4
|
|
|
|
#define CMD_ERR_EXEED_ARGC_MAX 5
|
|
|
|
#define CMD_ERR_NOTHING_TODO 6
|
|
|
|
#define CMD_COMPLETE_FULL_MATCH 7
|
|
|
|
#define CMD_COMPLETE_MATCH 8
|
|
|
|
#define CMD_COMPLETE_LIST_MATCH 9
|
|
|
|
#define CMD_SUCCESS_DAEMON 10
|
VTY: implicit node exit by de-indenting, not parent lookup
Note: This will break users' config files if they do not use consistent
indenting. (see below for a definition of "consistent".)
When reading VTY commands from a file, use indenting as means to implicitly
exit child nodes. Do not look for commands in the parent node implicitly.
The VTY so far implies 'exit' commands if a VTY line cannot be parsed on the
current node, but succeeds on the parent node. That is the mechanism by which
our VTY config files do not need 'exit' at the end of each child node.
We've hit problems with this in the following scenarios, which will show
improved user experience after this patch:
*) When both a parent and its child node have commands with identical names:
cs7 instace 0
point-code 1.2.3
sccp-address osmo-msc
point-code 0.0.1
If I put the parent's command below the child, it is still interpreted in the
context of the child node:
cs7 instace 0
sccp-address osmo-msc
point-code 0.0.1
point-code 1.2.3
Though the indenting lets me assume I am setting the cs7 instance's global PC
to 1.2.3, I'm actually overwriting osmo-msc's PC with 1.2.3 and discarding the
0.0.1.
*) When a software change moves a VTY command from a child to a parent. Say
'timezone' moved from 'bts' to 'network' level:
network
timezone 1 2
Say a user still has an old config file with 'timezone' on the child level:
network
bts 0
timezone 1 2
trx 0
The user would expect an error message that 'timezone' is invalid on the 'bts'
level. Instead, the VTY finds the parent node's 'timezone', steps out of 'bts'
to the 'network' level, and instead says that the 'trx' command does not exist.
Format:
Consistent means that two adjacent indenting lines have the exact
same indenting characters for the common length:
Weird mix if you ask me, but correct and consistent:
ROOT
<space>PARENT
<space><tab><space>CHILD
<space><tab><space><tab><tab>GRANDCHILD
<space><tab><space><tab><tab>GRANDCHILD2
<space>SIBLING
Inconsistent:
ROOT
<space>PARENT
<tab><space>CHILD
<space><space><tab>GRANDCHILD
<space><tab><tab>GRANDCHILD2
<tab>SIBLING
Also, when going back to a parent level, the exact same indenting must be used
as before in that node:
Incorrect:
ROOT
<tab>PARENT
<tab><tab><tab>CHILD
<tab><tab>SIBLING
As not really intended side effect, it is also permitted to indent the entire
file starting from the root level. We could guard against it but there's no
harm:
Correct and consistent:
<tab>ROOT
<tab><tab>PARENT
<tab><tab><tab><tab>CHILD
<tab><tab>SIBLING
Implementation:
Track parent nodes state: whenever a command enters a child node, push a parent
node onto an llist to remember the exact indentation characters used for that
level.
As soon as the first line on a child node is parsed, remember this new
indentation (which must have a longer strlen() than its parent level) to apply
to all remaining child siblings and grandchildren.
If the amount of spaces that indent a following VTY command are less than this
expected indentation, call vty_go_parent() until it matches up.
At any level, if the common length of indentation characters mismatch, abort
parsing in error.
Transitions to child node are spread across VTY implementations and are hard to
change. But transitions to the parent node are all handled by vty_go_parent().
By popping a parent from the list of parents in vty_go_parent(), we can also
detect that a command has changed the node without changing the parent, hence
it must have stepped into a child node, and we can push a parent frame.
The behavior on the interactive telnet VTY remains unchanged.
Change-Id: I24cbb3f6de111f2d31110c3c484c066f1153aac9
2017-09-07 01:08:06 +00:00
|
|
|
#define CMD_ERR_INVALID_INDENT 11
|
2010-05-19 17:02:52 +00:00
|
|
|
|
|
|
|
/* Argc max counts. */
|
2011-07-24 17:58:06 +00:00
|
|
|
#define CMD_ARGC_MAX 256
|
2010-05-19 17:02:52 +00:00
|
|
|
|
|
|
|
/* Turn off these macros when uisng cpp with extract.pl */
|
|
|
|
#ifndef VTYSH_EXTRACT_PL
|
|
|
|
|
|
|
|
/* helper defines for end-user DEFUN* macros */
|
|
|
|
#define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
|
|
|
|
static struct cmd_element cmdname = \
|
|
|
|
{ \
|
|
|
|
.string = cmdstr, \
|
|
|
|
.func = funcname, \
|
|
|
|
.doc = helpstr, \
|
|
|
|
.attr = attrs, \
|
|
|
|
.daemon = dnum, \
|
|
|
|
};
|
|
|
|
|
|
|
|
/* global (non static) cmd_element */
|
|
|
|
#define gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
|
|
|
|
struct cmd_element cmdname = \
|
|
|
|
{ \
|
|
|
|
.string = cmdstr, \
|
|
|
|
.func = funcname, \
|
|
|
|
.doc = helpstr, \
|
|
|
|
.attr = attrs, \
|
|
|
|
.daemon = dnum, \
|
|
|
|
};
|
|
|
|
|
2020-08-15 15:16:30 +00:00
|
|
|
#define DEFUN_CMD_ELEMENT_ATTR_USRATTR(funcname, cmdname, cmdstr, helpstr, attrs, usrattrs) \
|
|
|
|
static struct cmd_element cmdname = \
|
|
|
|
{ \
|
|
|
|
.string = cmdstr, \
|
|
|
|
.func = funcname, \
|
|
|
|
.doc = helpstr, \
|
|
|
|
.attr = attrs, \
|
|
|
|
.usrattr = usrattrs, \
|
|
|
|
};
|
|
|
|
|
2010-05-19 17:02:52 +00:00
|
|
|
#define DEFUN_CMD_FUNC_DECL(funcname) \
|
|
|
|
static int funcname (struct cmd_element *, struct vty *, int, const char *[]); \
|
|
|
|
|
|
|
|
#define DEFUN_CMD_FUNC_TEXT(funcname) \
|
|
|
|
static int funcname \
|
|
|
|
(struct cmd_element *self, struct vty *vty, int argc, const char *argv[])
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Macro for defining a VTY node and function
|
2011-08-17 15:13:48 +00:00
|
|
|
* \param[in] funcname Name of the function implementing the node
|
|
|
|
* \param[in] cmdname Name of the command node
|
|
|
|
* \param[in] cmdstr String with syntax of node
|
|
|
|
* \param[in] helpstr String with help message of node
|
|
|
|
*/
|
2010-05-19 17:02:52 +00:00
|
|
|
#define DEFUN(funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_FUNC_DECL(funcname) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
|
|
|
|
DEFUN_CMD_FUNC_TEXT(funcname)
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Macro for defining a non-static (global) VTY node and function
|
2011-08-17 15:13:48 +00:00
|
|
|
* \param[in] funcname Name of the function implementing the node
|
|
|
|
* \param[in] cmdname Name of the command node
|
|
|
|
* \param[in] cmdstr String with syntax of node
|
|
|
|
* \param[in] helpstr String with help message of node
|
|
|
|
*/
|
2010-05-19 17:02:52 +00:00
|
|
|
#define gDEFUN(funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_FUNC_DECL(funcname) \
|
|
|
|
gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
|
|
|
|
DEFUN_CMD_FUNC_TEXT(funcname)
|
|
|
|
|
|
|
|
#define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
|
|
|
|
DEFUN_CMD_FUNC_DECL(funcname) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
|
|
|
|
DEFUN_CMD_FUNC_TEXT(funcname)
|
|
|
|
|
|
|
|
#define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
|
|
|
|
|
|
|
|
#define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
|
2020-08-12 09:41:34 +00:00
|
|
|
DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
|
2010-05-19 17:02:52 +00:00
|
|
|
|
2020-08-15 15:16:30 +00:00
|
|
|
/*! Macro for defining a VTY node and function with global & program specific attributes.
|
|
|
|
* \param[in] funcname Name of the function implementing the node.
|
|
|
|
* \param[in] cmdname Name of the command node.
|
|
|
|
* \param[in] attr Global attributes (see CMD_ATTR_*).
|
|
|
|
* \param[in] usrattr Program specific attributes.
|
|
|
|
* \param[in] cmdstr String with syntax of node.
|
|
|
|
* \param[in] helpstr String with help message of node.
|
|
|
|
*/
|
|
|
|
#define DEFUN_ATTR_USRATTR(funcname, cmdname, attr, usrattr, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_FUNC_DECL(funcname) \
|
|
|
|
DEFUN_CMD_ELEMENT_ATTR_USRATTR(funcname, cmdname, cmdstr, helpstr, attr, usrattr) \
|
|
|
|
DEFUN_CMD_FUNC_TEXT(funcname)
|
|
|
|
|
|
|
|
#define DEFUN_USRATTR(funcname, cmdname, usrattr, cmdstr, helpstr) \
|
|
|
|
DEFUN_ATTR_USRATTR(funcname, cmdname, 0, usrattr, cmdstr, helpstr)
|
|
|
|
|
2010-05-19 17:02:52 +00:00
|
|
|
/* DEFUN_NOSH for commands that vtysh should ignore */
|
|
|
|
#define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN(funcname, cmdname, cmdstr, helpstr)
|
|
|
|
|
|
|
|
/* DEFSH for vtysh. */
|
|
|
|
#define DEFSH(daemon, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
|
|
|
|
|
|
|
|
/* DEFUN + DEFSH */
|
|
|
|
#define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_FUNC_DECL(funcname) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
|
|
|
|
DEFUN_CMD_FUNC_TEXT(funcname)
|
|
|
|
|
|
|
|
/* DEFUN + DEFSH with attributes */
|
|
|
|
#define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
|
|
|
|
DEFUN_CMD_FUNC_DECL(funcname) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
|
|
|
|
DEFUN_CMD_FUNC_TEXT(funcname)
|
|
|
|
|
|
|
|
#define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
|
|
|
|
|
|
|
|
#define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
|
|
|
|
|
|
|
|
/* ALIAS macro which define existing command's alias. */
|
|
|
|
#define ALIAS(funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
|
|
|
|
|
|
|
|
/* global (non static) cmd_element */
|
|
|
|
#define gALIAS(funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
|
|
|
|
|
|
|
|
#define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
|
|
|
|
|
|
|
|
#define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
|
|
|
|
|
|
|
|
#define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
|
|
|
|
|
|
|
|
#define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
|
|
|
|
|
|
|
|
#define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
|
|
|
|
|
|
|
|
#define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
|
|
|
|
DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
|
|
|
|
|
|
|
|
#endif /* VTYSH_EXTRACT_PL */
|
|
|
|
|
|
|
|
/* Some macroes */
|
|
|
|
#define CMD_OPTION(S) ((S[0]) == '[')
|
|
|
|
#define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<'))
|
|
|
|
#define CMD_VARARG(S) ((S[0]) == '.')
|
|
|
|
#define CMD_RANGE(S) ((S[0] == '<'))
|
|
|
|
|
|
|
|
#define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0))
|
|
|
|
#define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0))
|
|
|
|
#define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0))
|
|
|
|
#define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0))
|
|
|
|
|
2020-06-07 22:28:36 +00:00
|
|
|
#define VTY_IPV4_CMD "A.B.C.D"
|
|
|
|
#define VTY_IPV6_CMD "X:X::X:X"
|
|
|
|
#define VTY_IPV46_CMD "(" VTY_IPV4_CMD "|" VTY_IPV6_CMD ")"
|
|
|
|
|
2010-05-19 17:02:52 +00:00
|
|
|
/* Common descriptions. */
|
|
|
|
#define SHOW_STR "Show running system information\n"
|
|
|
|
#define IP_STR "IP information\n"
|
|
|
|
#define IPV6_STR "IPv6 information\n"
|
|
|
|
#define NO_STR "Negate a command or set its defaults\n"
|
|
|
|
#define CLEAR_STR "Reset functions\n"
|
|
|
|
#define RIP_STR "RIP information\n"
|
|
|
|
#define BGP_STR "BGP information\n"
|
|
|
|
#define OSPF_STR "OSPF information\n"
|
|
|
|
#define NEIGHBOR_STR "Specify neighbor router\n"
|
|
|
|
#define DEBUG_STR "Debugging functions (see also 'undebug')\n"
|
|
|
|
#define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
|
|
|
|
#define ROUTER_STR "Enable a routing process\n"
|
|
|
|
#define AS_STR "AS number\n"
|
|
|
|
#define MBGP_STR "MBGP information\n"
|
|
|
|
#define MATCH_STR "Match values from routing table\n"
|
|
|
|
#define SET_STR "Set values in destination routing protocol\n"
|
|
|
|
#define OUT_STR "Filter outgoing routing updates\n"
|
|
|
|
#define IN_STR "Filter incoming routing updates\n"
|
|
|
|
#define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
|
|
|
|
#define OSPF6_NUMBER_STR "Specify by number\n"
|
|
|
|
#define INTERFACE_STR "Interface infomation\n"
|
|
|
|
#define IFNAME_STR "Interface name(e.g. ep0)\n"
|
|
|
|
#define IP6_STR "IPv6 Information\n"
|
|
|
|
#define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
|
|
|
|
#define OSPF6_ROUTER_STR "Enable a routing process\n"
|
|
|
|
#define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
|
|
|
|
#define SECONDS_STR "<1-65535> Seconds\n"
|
|
|
|
#define ROUTE_STR "Routing Table\n"
|
|
|
|
#define PREFIX_LIST_STR "Build a prefix list\n"
|
|
|
|
#define OSPF6_DUMP_TYPE_LIST \
|
|
|
|
"(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
|
|
|
|
#define ISIS_STR "IS-IS information\n"
|
|
|
|
#define AREA_TAG_STR "[area tag]\n"
|
|
|
|
|
|
|
|
#define CONF_BACKUP_EXT ".sav"
|
|
|
|
|
|
|
|
/* IPv4 only machine should not accept IPv6 address for peer's IP
|
|
|
|
address. So we replace VTY command string like below. */
|
|
|
|
#ifdef HAVE_IPV6
|
|
|
|
#define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) "
|
|
|
|
#define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) "
|
|
|
|
#define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n"
|
|
|
|
#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) "
|
|
|
|
#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) "
|
|
|
|
#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n"
|
|
|
|
#else
|
|
|
|
#define NEIGHBOR_CMD "neighbor A.B.C.D "
|
|
|
|
#define NO_NEIGHBOR_CMD "no neighbor A.B.C.D "
|
|
|
|
#define NEIGHBOR_ADDR_STR "Neighbor address\n"
|
|
|
|
#define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) "
|
|
|
|
#define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) "
|
|
|
|
#define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
|
|
|
|
#endif /* HAVE_IPV6 */
|
|
|
|
|
|
|
|
/* Prototypes. */
|
|
|
|
void install_node(struct cmd_node *, int (*)(struct vty *));
|
2017-09-24 16:39:41 +00:00
|
|
|
void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
|
2015-08-02 02:14:07 +00:00
|
|
|
void install_element(int node_type, struct cmd_element *);
|
2010-05-19 17:02:52 +00:00
|
|
|
void install_element_ve(struct cmd_element *cmd);
|
2011-07-16 09:58:09 +00:00
|
|
|
void sort_node(void);
|
2010-05-19 17:02:52 +00:00
|
|
|
|
2017-09-24 16:39:41 +00:00
|
|
|
void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
|
2013-09-06 14:52:00 +00:00
|
|
|
|
2010-05-19 17:02:52 +00:00
|
|
|
/* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
|
|
|
|
string with a space between each element (allocated using
|
|
|
|
XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */
|
|
|
|
char *argv_concat(const char **argv, int argc, int shift);
|
|
|
|
|
|
|
|
vector cmd_make_strvec(const char *);
|
VTY: implicit node exit by de-indenting, not parent lookup
Note: This will break users' config files if they do not use consistent
indenting. (see below for a definition of "consistent".)
When reading VTY commands from a file, use indenting as means to implicitly
exit child nodes. Do not look for commands in the parent node implicitly.
The VTY so far implies 'exit' commands if a VTY line cannot be parsed on the
current node, but succeeds on the parent node. That is the mechanism by which
our VTY config files do not need 'exit' at the end of each child node.
We've hit problems with this in the following scenarios, which will show
improved user experience after this patch:
*) When both a parent and its child node have commands with identical names:
cs7 instace 0
point-code 1.2.3
sccp-address osmo-msc
point-code 0.0.1
If I put the parent's command below the child, it is still interpreted in the
context of the child node:
cs7 instace 0
sccp-address osmo-msc
point-code 0.0.1
point-code 1.2.3
Though the indenting lets me assume I am setting the cs7 instance's global PC
to 1.2.3, I'm actually overwriting osmo-msc's PC with 1.2.3 and discarding the
0.0.1.
*) When a software change moves a VTY command from a child to a parent. Say
'timezone' moved from 'bts' to 'network' level:
network
timezone 1 2
Say a user still has an old config file with 'timezone' on the child level:
network
bts 0
timezone 1 2
trx 0
The user would expect an error message that 'timezone' is invalid on the 'bts'
level. Instead, the VTY finds the parent node's 'timezone', steps out of 'bts'
to the 'network' level, and instead says that the 'trx' command does not exist.
Format:
Consistent means that two adjacent indenting lines have the exact
same indenting characters for the common length:
Weird mix if you ask me, but correct and consistent:
ROOT
<space>PARENT
<space><tab><space>CHILD
<space><tab><space><tab><tab>GRANDCHILD
<space><tab><space><tab><tab>GRANDCHILD2
<space>SIBLING
Inconsistent:
ROOT
<space>PARENT
<tab><space>CHILD
<space><space><tab>GRANDCHILD
<space><tab><tab>GRANDCHILD2
<tab>SIBLING
Also, when going back to a parent level, the exact same indenting must be used
as before in that node:
Incorrect:
ROOT
<tab>PARENT
<tab><tab><tab>CHILD
<tab><tab>SIBLING
As not really intended side effect, it is also permitted to indent the entire
file starting from the root level. We could guard against it but there's no
harm:
Correct and consistent:
<tab>ROOT
<tab><tab>PARENT
<tab><tab><tab><tab>CHILD
<tab><tab>SIBLING
Implementation:
Track parent nodes state: whenever a command enters a child node, push a parent
node onto an llist to remember the exact indentation characters used for that
level.
As soon as the first line on a child node is parsed, remember this new
indentation (which must have a longer strlen() than its parent level) to apply
to all remaining child siblings and grandchildren.
If the amount of spaces that indent a following VTY command are less than this
expected indentation, call vty_go_parent() until it matches up.
At any level, if the common length of indentation characters mismatch, abort
parsing in error.
Transitions to child node are spread across VTY implementations and are hard to
change. But transitions to the parent node are all handled by vty_go_parent().
By popping a parent from the list of parents in vty_go_parent(), we can also
detect that a command has changed the node without changing the parent, hence
it must have stepped into a child node, and we can push a parent frame.
The behavior on the interactive telnet VTY remains unchanged.
Change-Id: I24cbb3f6de111f2d31110c3c484c066f1153aac9
2017-09-07 01:08:06 +00:00
|
|
|
int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p);
|
2010-05-19 17:02:52 +00:00
|
|
|
void cmd_free_strvec(vector);
|
|
|
|
vector cmd_describe_command();
|
|
|
|
char **cmd_complete_command();
|
|
|
|
const char *cmd_prompt(enum node_type);
|
|
|
|
int config_from_file(struct vty *, FILE *);
|
|
|
|
enum node_type node_parent(enum node_type);
|
|
|
|
int cmd_execute_command(vector, struct vty *, struct cmd_element **, int);
|
|
|
|
int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **);
|
|
|
|
void config_replace_string(struct cmd_element *, char *, ...);
|
|
|
|
void cmd_init(int);
|
|
|
|
|
|
|
|
/* Export typical functions. */
|
|
|
|
extern struct cmd_element config_exit_cmd;
|
|
|
|
extern struct cmd_element config_help_cmd;
|
|
|
|
extern struct cmd_element config_list_cmd;
|
2012-10-22 17:43:26 +00:00
|
|
|
extern struct cmd_element config_end_cmd;
|
2010-05-19 17:02:52 +00:00
|
|
|
char *host_config_file();
|
|
|
|
void host_config_set(const char *);
|
|
|
|
|
2016-05-16 14:01:45 +00:00
|
|
|
char *osmo_asciidoc_escape(const char *inp);
|
|
|
|
|
2010-05-19 17:02:52 +00:00
|
|
|
/* This is called from main when a daemon is invoked with -v or --version. */
|
|
|
|
void print_version(int print_copyright);
|
|
|
|
|
|
|
|
extern void *tall_vty_cmd_ctx;
|
|
|
|
|
enable vty xml dumping to stdout
Allow dumping the VTY XML reference (for generating manuals) to a normal FILE*
stream instead of a vty output buffer.
We currently generate the VTY reference by starting the client program,
connecting to the VTY telnet and dumping the reference. That is weirdly
convoluted, especially since there has to be a valid config file that
successfully starts up a minimal set of external links before the reference can
be generated. IMO we should have dumped the XML reference to stdout from the
start, and never to a VTY session.
With this patch, it is trivial to generate the XML VTY reference by a
commandline switch. The client program will set up the entire VTY, and
immediately after parsing the cmdline options but before parsing a config file,
just dumps the reference and doesn't even start establishing local ports. That
would allow generating the XML reference on the fly during the build process of
the manuals, without the need of a docker container or somesuch.
A first implementation of such a commandline switch is `osmo-bsc -X`, added in
I316efedb2c1652791434ecf14a1e261367cd2fb7
This patch jumps through a bit of a hoop to still allow dumping to a VTY buffer
without code dup, to still allow dumping the XML reference through telnet VTY,
until all our programs have implemented an -X switch (TM).
Change-Id: Ic74bbdb6dc5ea05f03c791cc70184861e39cd492
2020-05-14 14:51:26 +00:00
|
|
|
int vty_dump_xml_ref(FILE *stream);
|
|
|
|
|
2012-04-18 19:53:23 +00:00
|
|
|
/*! @} */
|