command.h
Go to the documentation of this file.
/*
* 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
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#pragma once
#include <stdio.h>
#include <sys/types.h>
#include "vector.h"
#include <osmocom/core/defs.h>
struct host {
char *name;
char *password;
char *password_encrypt;
char *enable;
char *enable_encrypt;
int lines;
char *logfile;
char *config;
int advanced;
int encrypt;
const char *motd;
char *motdfile;
const struct vty_app_info *app_info;
};
enum node_type {
AUTH_NODE,
VIEW_NODE,
AUTH_ENABLE_NODE,
ENABLE_NODE,
CONFIG_NODE,
SERVICE_NODE,
DEBUG_NODE,
CFG_LOG_NODE,
CFG_STATS_NODE,
VTY_NODE,
L_E1INP_NODE,
L_IPA_NODE,
L_NS_NODE,
L_BSSGP_NODE,
L_CTRL_NODE,
L_CS7_NODE,
L_CS7_AS_NODE,
L_CS7_ASP_NODE,
L_CS7_XUA_NODE,
L_CS7_RTABLE_NODE,
L_CS7_LINK_NODE,
L_CS7_LINKSET_NODE,
L_CS7_SCCPADDR_NODE,
L_CS7_SCCPADDR_GT_NODE,
L_CPU_SCHED_NODE,
/*
* When adding new nodes to the libosmocore project, these nodes can be
* used to avoid ABI changes for unrelated projects.
*/
RESERVED3_NODE,
_LAST_OSMOVTY_NODE
};
#include "vty.h"
struct cmd_node {
int node;
const char *prompt;
int vtysh;
int (*func) (struct vty *);
vector cmd_vector;
char name[64];
};
enum {
CMD_ATTR_DEPRECATED = (1 << 0),
CMD_ATTR_HIDDEN = (1 << 1),
};
struct cmd_element {
const char *string;
int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
const char *doc;
int daemon;
vector strvec;
unsigned int cmdsize;
char *config;
vector subconfig;
unsigned char attr;
};
struct desc {
const char *cmd;
const char *str;
};
#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
#define CMD_ERR_INVALID_INDENT 11
/* Argc max counts. */
#define CMD_ARGC_MAX 256
/* 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, \
};
#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[])
#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)
#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) \
DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
/* 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))
#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 ")"
/* 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 *));
void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
void install_element(int node_type, struct cmd_element *);
void install_element_ve(struct cmd_element *cmd);
void sort_node(void);
void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
/* 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 *);
int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p);
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;
extern struct cmd_element config_end_cmd;
char *host_config_file();
void host_config_set(const char *);
char *osmo_asciidoc_escape(const char *inp);
/* 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;
int vty_dump_xml_ref(FILE *stream);
defs.h
argv
argv
Definition: tdef_vty.c:299
argc
argc
Definition: tdef_vty.c:299
argv_concat
char * argv_concat(const char **argv, int argc, int shift)
Definition: command.c:124
config_exit_cmd
struct cmd_element config_exit_cmd
node_parent
enum node_type node_parent(enum node_type)
config_help_cmd
struct cmd_element config_help_cmd
install_element_ve
void install_element_ve(struct cmd_element *cmd)
Definition: command.c:817
cmd_execute_command
int cmd_execute_command(vector, struct vty *, struct cmd_element **, int)
Definition: command.c:2431
cmd_free_strvec
void cmd_free_strvec(vector)
Free allocated string vector.
Definition: command.c:328
host_config_set
void host_config_set(const char *)
Definition: command.c:3814
tall_vty_cmd_ctx
void * tall_vty_cmd_ctx
Definition: command.c:69
config_end_cmd
struct cmd_element config_end_cmd
vty_install_default
void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()")
Deprecated, now happens implicitly when calling install_node().
Definition: command.c:3829
install_element
void install_element(int node_type, struct cmd_element *)
Install a command into a node.
Definition: command.c:799
cmd_prompt
const char * cmd_prompt(enum node_type)
Return prompt character of specified node.
Definition: command.c:500
vty_dump_xml_ref
int vty_dump_xml_ref(FILE *stream)
Print the XML reference of all VTY nodes to the given stream.
Definition: command.c:774
node_type
node_type
There are some command levels which called from command node.
Definition: command.h:71
install_node
void install_node(struct cmd_node *, int(*)(struct vty *))
Install top node of command vector.
Definition: command.c:186
install_default
void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()")
Deprecated, now happens implicitly when calling install_node().
Definition: command.c:3822
cmd_make_strvec
vector cmd_make_strvec(const char *)
Breaking up string into each command piece.
Definition: command.c:320
cmd_complete_command
char ** cmd_complete_command()
cmd_make_strvec2
int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p)
Break up string in command tokens.
Definition: command.c:249
config_from_file
int config_from_file(struct vty *, FILE *)
Definition: command.c:2601
cmd_execute_command_strict
int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **)
Definition: command.c:2465
cmd_describe_command
vector cmd_describe_command()
cmd_init
void cmd_init(int)
Definition: command.c:3913
print_version
void print_version(int print_copyright)
print the version (and optionally copyright) information
Definition: command.c:115
config_list_cmd
struct cmd_element config_list_cmd
sort_node
void sort_node(void)
Sort each node's command element according to command string.
Definition: command.c:210
host_config_file
char * host_config_file()
config_replace_string
void config_replace_string(struct cmd_element *, char *,...)
osmo_asciidoc_escape
char * osmo_asciidoc_escape(const char *inp)
escape all special asciidoc symbols
Definition: command.c:513
CMD_ATTR_DEPRECATED
@ CMD_ATTR_DEPRECATED
Definition: command.h:138
CMD_ATTR_HIDDEN
@ CMD_ATTR_HIDDEN
Definition: command.h:139
L_CS7_RTABLE_NODE
@ L_CS7_RTABLE_NODE
SS7 Routing Table.
Definition: command.h:94
L_IPA_NODE
@ L_IPA_NODE
IPA proxying commands in libosmo-abis.
Definition: command.h:85
L_CS7_LINKSET_NODE
@ L_CS7_LINKSET_NODE
SS7 Linkset.
Definition: command.h:96
SERVICE_NODE
@ SERVICE_NODE
Service node.
Definition: command.h:77
L_CS7_AS_NODE
@ L_CS7_AS_NODE
SS7 Application Server.
Definition: command.h:91
L_CS7_NODE
@ L_CS7_NODE
SS7 root node.
Definition: command.h:90
L_CS7_LINK_NODE
@ L_CS7_LINK_NODE
SS7 Link.
Definition: command.h:95
AUTH_NODE
@ AUTH_NODE
Authentication mode of vty interface.
Definition: command.h:72
L_NS_NODE
@ L_NS_NODE
NS node in libosmo-gb.
Definition: command.h:86
VTY_NODE
@ VTY_NODE
Vty node.
Definition: command.h:82
CONFIG_NODE
@ CONFIG_NODE
Config node.
Definition: command.h:76
L_E1INP_NODE
@ L_E1INP_NODE
E1 line in libosmo-abis.
Definition: command.h:84
DEBUG_NODE
@ DEBUG_NODE
Debug node.
Definition: command.h:78
L_CS7_XUA_NODE
@ L_CS7_XUA_NODE
SS7 xUA Listener.
Definition: command.h:93
CFG_LOG_NODE
@ CFG_LOG_NODE
Configure the logging.
Definition: command.h:79
L_CPU_SCHED_NODE
@ L_CPU_SCHED_NODE
CPU Sched related options node.
Definition: command.h:100
ENABLE_NODE
@ ENABLE_NODE
Enable node.
Definition: command.h:75
AUTH_ENABLE_NODE
@ AUTH_ENABLE_NODE
Authentication mode for change enable.
Definition: command.h:74
L_CTRL_NODE
@ L_CTRL_NODE
Control interface node.
Definition: command.h:88
L_CS7_SCCPADDR_NODE
@ L_CS7_SCCPADDR_NODE
SS7 SCCP Address.
Definition: command.h:97
_LAST_OSMOVTY_NODE
@ _LAST_OSMOVTY_NODE
Definition: command.h:107
RESERVED3_NODE
@ RESERVED3_NODE
Reserved for later extensions.
Definition: command.h:105
VIEW_NODE
@ VIEW_NODE
View node.
Definition: command.h:73
L_CS7_SCCPADDR_GT_NODE
@ L_CS7_SCCPADDR_GT_NODE
SS7 SCCP Global Title.
Definition: command.h:98
CFG_STATS_NODE
@ CFG_STATS_NODE
Configure the statistics.
Definition: command.h:80
L_BSSGP_NODE
@ L_BSSGP_NODE
BSSGP node in libosmo-gb.
Definition: command.h:87
L_CS7_ASP_NODE
@ L_CS7_ASP_NODE
SS7 Application Server Process.
Definition: command.h:92
OSMO_DEPRECATED
#define OSMO_DEPRECATED(text)
_vector
Definition: vector.h:27
cmd_element
Structure of a command element.
Definition: command.h:143
cmd_element::attr
unsigned char attr
Command attributes.
Definition: command.h:152
cmd_element::strvec
vector strvec
Pointing out each description vector.
Definition: command.h:148
cmd_element::subconfig
vector subconfig
Sub configuration string.
Definition: command.h:151
cmd_element::func
int(* func)(struct cmd_element *, struct vty *, int, const char *[])
Definition: command.h:145
cmd_element::string
const char * string
Command specification by string.
Definition: command.h:144
cmd_element::config
char * config
Configuration string.
Definition: command.h:150
cmd_element::cmdsize
unsigned int cmdsize
Command index count.
Definition: command.h:149
cmd_element::doc
const char * doc
Documentation of this command.
Definition: command.h:146
cmd_element::daemon
int daemon
Daemon to which this command belong.
Definition: command.h:147
cmd_node
Node which has some commands and prompt string and configuration function pointer .
Definition: command.h:114
cmd_node::vtysh
int vtysh
Is this node's configuration goes to vtysh ?
Definition: command.h:122
cmd_node::cmd_vector
vector cmd_vector
Vector of this node's command list.
Definition: command.h:128
cmd_node::name
char name[64]
Human-readable ID of this node.
Definition: command.h:133
cmd_node::prompt
const char * prompt
Prompt character at vty interface.
Definition: command.h:119
cmd_node::node
int node
Node index.
Definition: command.h:116
cmd_node::func
int(* func)(struct vty *)
Node's configuration write function.
Definition: command.h:125
desc
Command description structure.
Definition: command.h:156
desc::cmd
const char * cmd
Command string.
Definition: command.h:157
desc::str
const char * str
Command's description.
Definition: command.h:158
host
Host configuration variable.
Definition: command.h:37
host::lines
int lines
System wide terminal lines.
Definition: command.h:50
host::logfile
char * logfile
Log filename.
Definition: command.h:53
host::config
char * config
config file name of this host
Definition: command.h:56
host::app_info
const struct vty_app_info * app_info
VTY application information.
Definition: command.h:67
host::password_encrypt
char * password_encrypt
Definition: command.h:43
host::motd
const char * motd
Banner configuration.
Definition: command.h:63
host::encrypt
int encrypt
Definition: command.h:60
host::enable
char * enable
Enable password.
Definition: command.h:46
host::password
char * password
Password for vty interface.
Definition: command.h:42
host::name
char * name
Host name of this router.
Definition: command.h:39
host::advanced
int advanced
Flags for services.
Definition: command.h:59
host::enable_encrypt
char * enable_encrypt
Definition: command.h:47
host::motdfile
char * motdfile
Definition: command.h:64
vty_app_info
Information an application registers with the VTY.
Definition: vty.h:173
vty
Internal representation of a single VTY.
Definition: vty.h:67
vector.h
Generic vector interface header.
vty.h