Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file command.h |
| 2 | * Zebra configuration command interface routine. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 3 | /* |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 4 | * Copyright (C) 1997, 98 Kunihiro Ishiguro |
| 5 | * |
| 6 | * This file is part of GNU Zebra. |
| 7 | * |
| 8 | * GNU Zebra is free software; you can redistribute it and/or modify |
| 9 | * it under the terms of the GNU General Public License as published |
| 10 | * by the Free Software Foundation; either version 2, or (at your |
| 11 | * option) any later version. |
| 12 | * |
| 13 | * GNU Zebra is distributed in the hope that it will be useful, but |
| 14 | * WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 16 | * General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU General Public License |
| 19 | * along with GNU Zebra; see the file COPYING. If not, write to the |
Jaroslav Škarvada | 2b82c1c | 2015-11-11 16:02:54 +0100 | [diff] [blame] | 20 | * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| 21 | * Boston, MA 02110-1301, USA. |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 22 | */ |
| 23 | |
Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 24 | #pragma once |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 25 | |
| 26 | #include <stdio.h> |
Vadim Yanitskiy | 72b9088 | 2020-10-21 05:07:34 +0700 | [diff] [blame] | 27 | #include <stdbool.h> |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 28 | #include <sys/types.h> |
| 29 | #include "vector.h" |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 30 | |
Neels Hofmeyr | f4f23bd | 2017-09-20 15:39:37 +0200 | [diff] [blame] | 31 | #include <osmocom/core/defs.h> |
Vadim Yanitskiy | 4165d04 | 2020-10-23 16:40:57 +0700 | [diff] [blame] | 32 | #include <osmocom/core/utils.h> |
Neels Hofmeyr | f4f23bd | 2017-09-20 15:39:37 +0200 | [diff] [blame] | 33 | |
Harald Welte | e881b1b | 2011-08-17 18:52:30 +0200 | [diff] [blame] | 34 | /*! \defgroup command VTY Command |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 35 | * @{ |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 36 | * \file command.h */ |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 37 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 38 | /*! Host configuration variable */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 39 | struct host { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 40 | /*! Host name of this router. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 41 | char *name; |
| 42 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 43 | /*! Password for vty interface. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 44 | char *password; |
| 45 | char *password_encrypt; |
| 46 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 47 | /*! Enable password */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 48 | char *enable; |
| 49 | char *enable_encrypt; |
| 50 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 51 | /*! System wide terminal lines. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 52 | int lines; |
| 53 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 54 | /*! Log filename. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 55 | char *logfile; |
| 56 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 57 | /*! config file name of this host */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 58 | char *config; |
| 59 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 60 | /*! Flags for services */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 61 | int advanced; |
| 62 | int encrypt; |
| 63 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 64 | /*! Banner configuration. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 65 | const char *motd; |
| 66 | char *motdfile; |
| 67 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 68 | /*! VTY application information */ |
Harald Welte | 237f624 | 2010-05-25 23:00:45 +0200 | [diff] [blame] | 69 | const struct vty_app_info *app_info; |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 70 | }; |
| 71 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 72 | /*! There are some command levels which called from command node. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 73 | enum node_type { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 74 | AUTH_NODE, /*!< Authentication mode of vty interface. */ |
| 75 | VIEW_NODE, /*!< View node. Default mode of vty interface. */ |
| 76 | AUTH_ENABLE_NODE, /*!< Authentication mode for change enable. */ |
| 77 | ENABLE_NODE, /*!< Enable node. */ |
| 78 | CONFIG_NODE, /*!< Config node. Default mode of config file. */ |
| 79 | SERVICE_NODE, /*!< Service node. */ |
| 80 | DEBUG_NODE, /*!< Debug node. */ |
| 81 | CFG_LOG_NODE, /*!< Configure the logging */ |
| 82 | CFG_STATS_NODE, /*!< Configure the statistics */ |
Harald Welte | 4c05301 | 2010-05-31 16:01:59 +0200 | [diff] [blame] | 83 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 84 | VTY_NODE, /*!< Vty node. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 85 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 86 | L_E1INP_NODE, /*!< E1 line in libosmo-abis. */ |
| 87 | L_IPA_NODE, /*!< IPA proxying commands in libosmo-abis. */ |
| 88 | L_NS_NODE, /*!< NS node in libosmo-gb. */ |
| 89 | L_BSSGP_NODE, /*!< BSSGP node in libosmo-gb. */ |
| 90 | L_CTRL_NODE, /*!< Control interface node. */ |
Pablo Neira Ayuso | 2ade3a0 | 2011-07-07 19:46:50 +0200 | [diff] [blame] | 91 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 92 | L_CS7_NODE, /*!< SS7 root node */ |
| 93 | L_CS7_AS_NODE, /*!< SS7 Application Server */ |
| 94 | L_CS7_ASP_NODE, /*!< SS7 Application Server Process */ |
| 95 | L_CS7_XUA_NODE, /*!< SS7 xUA Listener */ |
| 96 | L_CS7_RTABLE_NODE, /*!< SS7 Routing Table */ |
| 97 | L_CS7_LINK_NODE, /*!< SS7 Link */ |
| 98 | L_CS7_LINKSET_NODE, /*!< SS7 Linkset */ |
| 99 | L_CS7_SCCPADDR_NODE, /*!< SS7 SCCP Address */ |
| 100 | L_CS7_SCCPADDR_GT_NODE, /*!< SS7 SCCP Global Title */ |
Harald Welte | b522740 | 2017-04-14 14:01:56 +0200 | [diff] [blame] | 101 | |
Philipp Maier | 466be65 | 2021-07-23 13:56:05 +0200 | [diff] [blame] | 102 | L_CPU_SCHED_NODE, /*!< CPU Sched related options node */ |
Alexander Couzens | 412bc34 | 2020-11-19 05:24:37 +0100 | [diff] [blame] | 103 | L_NS_BIND_NODE, /*!< NS bind node */ |
| 104 | L_NS_NSE_NODE, /*!< NS NSE node */ |
Jacob Erlbeck | 34eec7d | 2015-11-02 10:50:50 +0100 | [diff] [blame] | 105 | /* |
| 106 | * When adding new nodes to the libosmocore project, these nodes can be |
| 107 | * used to avoid ABI changes for unrelated projects. |
| 108 | */ |
Harald Welte | a0fb376 | 2021-03-04 21:25:11 +0100 | [diff] [blame] | 109 | RESERVED1_NODE, /*!< Reserved for later extensions */ |
| 110 | RESERVED2_NODE, /*!< Reserved for later extensions */ |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 111 | RESERVED3_NODE, /*!< Reserved for later extensions */ |
Harald Welte | a0fb376 | 2021-03-04 21:25:11 +0100 | [diff] [blame] | 112 | RESERVED4_NODE, /*!< Reserved for later extensions */ |
| 113 | RESERVED5_NODE, /*!< Reserved for later extensions */ |
| 114 | RESERVED6_NODE, /*!< Reserved for later extensions */ |
| 115 | RESERVED7_NODE, /*!< Reserved for later extensions */ |
| 116 | RESERVED8_NODE, /*!< Reserved for later extensions */ |
Jacob Erlbeck | 34eec7d | 2015-11-02 10:50:50 +0100 | [diff] [blame] | 117 | |
Harald Welte | 4c05301 | 2010-05-31 16:01:59 +0200 | [diff] [blame] | 118 | _LAST_OSMOVTY_NODE |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 119 | }; |
| 120 | |
Andreas Eversberg | 3c6a2ce | 2012-07-12 09:22:56 +0200 | [diff] [blame] | 121 | #include "vty.h" |
| 122 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 123 | /*! Node which has some commands and prompt string and |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 124 | * configuration function pointer . */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 125 | struct cmd_node { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 126 | /*! Node index */ |
Holger Hans Peter Freyther | a9e5252 | 2015-08-02 02:14:07 +0000 | [diff] [blame] | 127 | int node; |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 128 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 129 | /*! Prompt character at vty interface. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 130 | const char *prompt; |
| 131 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 132 | /*! Is this node's configuration goes to vtysh ? */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 133 | int vtysh; |
| 134 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 135 | /*! Node's configuration write function */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 136 | int (*func) (struct vty *); |
| 137 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 138 | /*! Vector of this node's command list. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 139 | vector cmd_vector; |
Neels Hofmeyr | 657c5b6 | 2017-09-18 16:42:06 +0200 | [diff] [blame] | 140 | |
| 141 | /*! Human-readable ID of this node. Should only contain alphanumeric |
| 142 | * plus '-' and '_' characters (is used as XML ID for 'show |
| 143 | * online-help'). If left NUL, this is derived from the prompt.*/ |
| 144 | char name[64]; |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 145 | }; |
| 146 | |
Vadim Yanitskiy | e65c8ba | 2018-09-24 12:56:31 +0700 | [diff] [blame] | 147 | /*! Attributes (flags) for \ref cmd_element */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 148 | enum { |
Vadim Yanitskiy | e65c8ba | 2018-09-24 12:56:31 +0700 | [diff] [blame] | 149 | CMD_ATTR_DEPRECATED = (1 << 0), |
| 150 | CMD_ATTR_HIDDEN = (1 << 1), |
Vadim Yanitskiy | 4a96b7c | 2020-09-28 12:42:27 +0700 | [diff] [blame] | 151 | CMD_ATTR_IMMEDIATE = (1 << 2), |
Vadim Yanitskiy | ceb3b39 | 2020-10-06 00:20:24 +0700 | [diff] [blame] | 152 | CMD_ATTR_NODE_EXIT = (1 << 3), |
Vadim Yanitskiy | 99d5c2d | 2020-10-06 00:22:06 +0700 | [diff] [blame] | 153 | CMD_ATTR_LIB_COMMAND = (1 << 4), |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 154 | }; |
| 155 | |
Vadim Yanitskiy | c0745eb | 2020-10-04 18:37:13 +0700 | [diff] [blame] | 156 | /*! Attributes shared between libraries (up to 32 entries). */ |
| 157 | enum { |
| 158 | /* The entries of this enum shall conform the following requirements: |
| 159 | * 1. Naming format: 'OSMO_' + <LIBNAME> + '_LIB_ATTR_' + <ATTRNAME>, |
| 160 | * where LIBNAME is a short name of the library, e.g. 'ABIS', 'MGCP', |
| 161 | * and ATTRNAME is a brief name of the attribute, e.g. RTP_CONN_EST; |
| 162 | * for example: 'OSMO_ABIS_LIB_ATTR_RSL_LINK_UP'. |
| 163 | * 2. Brevity: shortenings and abbreviations are welcome! |
| 164 | * 3. Values are not flags but indexes, unlike CMD_ATTR_*. |
| 165 | * 4. Ordering: new entries added before _OSMO_CORE_LIB_ATTR_COUNT. */ |
Philipp Maier | 608b1a4 | 2020-10-05 20:54:51 +0200 | [diff] [blame] | 166 | OSMO_SCCP_LIB_ATTR_RSTRT_ASP, |
Philipp Maier | a5218ea | 2020-10-08 17:30:42 +0200 | [diff] [blame] | 167 | OSMO_ABIS_LIB_ATTR_IPA_NEW_LNK, |
| 168 | OSMO_ABIS_LIB_ATTR_LINE_UPD, |
Vadim Yanitskiy | c0745eb | 2020-10-04 18:37:13 +0700 | [diff] [blame] | 169 | |
| 170 | /* Keep this floating entry last, it's needed for count check. */ |
| 171 | _OSMO_CORE_LIB_ATTR_COUNT |
| 172 | }; |
| 173 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 174 | /*! Structure of a command element */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 175 | struct cmd_element { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 176 | const char *string; /*!< Command specification by string. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 177 | int (*func) (struct cmd_element *, struct vty *, int, const char *[]); |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 178 | const char *doc; /*!< Documentation of this command. */ |
| 179 | int daemon; /*!< Daemon to which this command belong. */ |
| 180 | vector strvec; /*!< Pointing out each description vector. */ |
| 181 | unsigned int cmdsize; /*!< Command index count. */ |
| 182 | char *config; /*!< Configuration string */ |
| 183 | vector subconfig; /*!< Sub configuration string */ |
Vadim Yanitskiy | 7f1ecd9 | 2020-08-15 22:16:30 +0700 | [diff] [blame] | 184 | unsigned char attr; /*!< Command attributes (global) */ |
| 185 | unsigned int usrattr; /*!< Command attributes (program specific) */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 186 | }; |
| 187 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 188 | /*! Command description structure. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 189 | struct desc { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 190 | const char *cmd; /*!< Command string. */ |
| 191 | const char *str; /*!< Command's description. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 192 | }; |
| 193 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 194 | /*! Return value of the commands. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 195 | #define CMD_SUCCESS 0 |
| 196 | #define CMD_WARNING 1 |
| 197 | #define CMD_ERR_NO_MATCH 2 |
| 198 | #define CMD_ERR_AMBIGUOUS 3 |
| 199 | #define CMD_ERR_INCOMPLETE 4 |
| 200 | #define CMD_ERR_EXEED_ARGC_MAX 5 |
| 201 | #define CMD_ERR_NOTHING_TODO 6 |
| 202 | #define CMD_COMPLETE_FULL_MATCH 7 |
| 203 | #define CMD_COMPLETE_MATCH 8 |
| 204 | #define CMD_COMPLETE_LIST_MATCH 9 |
| 205 | #define CMD_SUCCESS_DAEMON 10 |
Neels Hofmeyr | 4a31ffa | 2017-09-07 03:08:06 +0200 | [diff] [blame] | 206 | #define CMD_ERR_INVALID_INDENT 11 |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 207 | |
| 208 | /* Argc max counts. */ |
Holger Hans Peter Freyther | c0dbe0b | 2011-07-24 19:58:06 +0200 | [diff] [blame] | 209 | #define CMD_ARGC_MAX 256 |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 210 | |
| 211 | /* Turn off these macros when uisng cpp with extract.pl */ |
| 212 | #ifndef VTYSH_EXTRACT_PL |
| 213 | |
| 214 | /* helper defines for end-user DEFUN* macros */ |
| 215 | #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \ |
| 216 | static struct cmd_element cmdname = \ |
| 217 | { \ |
| 218 | .string = cmdstr, \ |
| 219 | .func = funcname, \ |
| 220 | .doc = helpstr, \ |
| 221 | .attr = attrs, \ |
| 222 | .daemon = dnum, \ |
| 223 | }; |
| 224 | |
| 225 | /* global (non static) cmd_element */ |
| 226 | #define gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \ |
| 227 | struct cmd_element cmdname = \ |
| 228 | { \ |
| 229 | .string = cmdstr, \ |
| 230 | .func = funcname, \ |
| 231 | .doc = helpstr, \ |
| 232 | .attr = attrs, \ |
| 233 | .daemon = dnum, \ |
| 234 | }; |
| 235 | |
Vadim Yanitskiy | 7f1ecd9 | 2020-08-15 22:16:30 +0700 | [diff] [blame] | 236 | #define DEFUN_CMD_ELEMENT_ATTR_USRATTR(funcname, cmdname, cmdstr, helpstr, attrs, usrattrs) \ |
| 237 | static struct cmd_element cmdname = \ |
| 238 | { \ |
| 239 | .string = cmdstr, \ |
| 240 | .func = funcname, \ |
| 241 | .doc = helpstr, \ |
| 242 | .attr = attrs, \ |
| 243 | .usrattr = usrattrs, \ |
| 244 | }; |
| 245 | |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 246 | #define DEFUN_CMD_FUNC_DECL(funcname) \ |
| 247 | static int funcname (struct cmd_element *, struct vty *, int, const char *[]); \ |
| 248 | |
| 249 | #define DEFUN_CMD_FUNC_TEXT(funcname) \ |
| 250 | static int funcname \ |
| 251 | (struct cmd_element *self, struct vty *vty, int argc, const char *argv[]) |
| 252 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 253 | /*! Macro for defining a VTY node and function |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 254 | * \param[in] funcname Name of the function implementing the node |
| 255 | * \param[in] cmdname Name of the command node |
| 256 | * \param[in] cmdstr String with syntax of node |
| 257 | * \param[in] helpstr String with help message of node |
| 258 | */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 259 | #define DEFUN(funcname, cmdname, cmdstr, helpstr) \ |
| 260 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 261 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \ |
| 262 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 263 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 264 | /*! Macro for defining a non-static (global) VTY node and function |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 265 | * \param[in] funcname Name of the function implementing the node |
| 266 | * \param[in] cmdname Name of the command node |
| 267 | * \param[in] cmdstr String with syntax of node |
| 268 | * \param[in] helpstr String with help message of node |
| 269 | */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 270 | #define gDEFUN(funcname, cmdname, cmdstr, helpstr) \ |
| 271 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 272 | gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \ |
| 273 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 274 | |
| 275 | #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \ |
| 276 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 277 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \ |
| 278 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 279 | |
| 280 | #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ |
| 281 | DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN) |
| 282 | |
| 283 | #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ |
Vadim Yanitskiy | 523c4e0 | 2020-08-12 16:41:34 +0700 | [diff] [blame] | 284 | DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 285 | |
Vadim Yanitskiy | 7f1ecd9 | 2020-08-15 22:16:30 +0700 | [diff] [blame] | 286 | /*! Macro for defining a VTY node and function with global & program specific attributes. |
| 287 | * \param[in] funcname Name of the function implementing the node. |
| 288 | * \param[in] cmdname Name of the command node. |
| 289 | * \param[in] attr Global attributes (see CMD_ATTR_*). |
| 290 | * \param[in] usrattr Program specific attributes. |
| 291 | * \param[in] cmdstr String with syntax of node. |
| 292 | * \param[in] helpstr String with help message of node. |
| 293 | */ |
| 294 | #define DEFUN_ATTR_USRATTR(funcname, cmdname, attr, usrattr, cmdstr, helpstr) \ |
| 295 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 296 | DEFUN_CMD_ELEMENT_ATTR_USRATTR(funcname, cmdname, cmdstr, helpstr, attr, usrattr) \ |
| 297 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 298 | |
| 299 | #define DEFUN_USRATTR(funcname, cmdname, usrattr, cmdstr, helpstr) \ |
| 300 | DEFUN_ATTR_USRATTR(funcname, cmdname, 0, usrattr, cmdstr, helpstr) |
| 301 | |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 302 | /* DEFUN_NOSH for commands that vtysh should ignore */ |
| 303 | #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \ |
| 304 | DEFUN(funcname, cmdname, cmdstr, helpstr) |
| 305 | |
| 306 | /* DEFSH for vtysh. */ |
| 307 | #define DEFSH(daemon, cmdname, cmdstr, helpstr) \ |
| 308 | DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \ |
| 309 | |
| 310 | /* DEFUN + DEFSH */ |
| 311 | #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 312 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 313 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \ |
| 314 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 315 | |
| 316 | /* DEFUN + DEFSH with attributes */ |
| 317 | #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \ |
| 318 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 319 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \ |
| 320 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 321 | |
| 322 | #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 323 | DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN) |
| 324 | |
| 325 | #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 326 | DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) |
| 327 | |
| 328 | /* ALIAS macro which define existing command's alias. */ |
| 329 | #define ALIAS(funcname, cmdname, cmdstr, helpstr) \ |
| 330 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) |
| 331 | |
| 332 | /* global (non static) cmd_element */ |
| 333 | #define gALIAS(funcname, cmdname, cmdstr, helpstr) \ |
| 334 | gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) |
| 335 | |
| 336 | #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \ |
| 337 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) |
| 338 | |
| 339 | #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ |
| 340 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0) |
| 341 | |
| 342 | #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ |
| 343 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0) |
| 344 | |
| 345 | #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 346 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) |
| 347 | |
| 348 | #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 349 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) |
| 350 | |
| 351 | #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 352 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon) |
| 353 | |
| 354 | #endif /* VTYSH_EXTRACT_PL */ |
| 355 | |
| 356 | /* Some macroes */ |
| 357 | #define CMD_OPTION(S) ((S[0]) == '[') |
| 358 | #define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<')) |
| 359 | #define CMD_VARARG(S) ((S[0]) == '.') |
| 360 | #define CMD_RANGE(S) ((S[0] == '<')) |
| 361 | |
| 362 | #define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0)) |
| 363 | #define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0)) |
| 364 | #define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0)) |
| 365 | #define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0)) |
| 366 | |
Alexander Couzens | 99c538e | 2020-06-08 00:28:36 +0200 | [diff] [blame] | 367 | #define VTY_IPV4_CMD "A.B.C.D" |
| 368 | #define VTY_IPV6_CMD "X:X::X:X" |
| 369 | #define VTY_IPV46_CMD "(" VTY_IPV4_CMD "|" VTY_IPV6_CMD ")" |
| 370 | |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 371 | /* Common descriptions. */ |
| 372 | #define SHOW_STR "Show running system information\n" |
| 373 | #define IP_STR "IP information\n" |
| 374 | #define IPV6_STR "IPv6 information\n" |
| 375 | #define NO_STR "Negate a command or set its defaults\n" |
| 376 | #define CLEAR_STR "Reset functions\n" |
| 377 | #define RIP_STR "RIP information\n" |
| 378 | #define BGP_STR "BGP information\n" |
| 379 | #define OSPF_STR "OSPF information\n" |
| 380 | #define NEIGHBOR_STR "Specify neighbor router\n" |
| 381 | #define DEBUG_STR "Debugging functions (see also 'undebug')\n" |
| 382 | #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n" |
| 383 | #define ROUTER_STR "Enable a routing process\n" |
| 384 | #define AS_STR "AS number\n" |
| 385 | #define MBGP_STR "MBGP information\n" |
| 386 | #define MATCH_STR "Match values from routing table\n" |
| 387 | #define SET_STR "Set values in destination routing protocol\n" |
| 388 | #define OUT_STR "Filter outgoing routing updates\n" |
| 389 | #define IN_STR "Filter incoming routing updates\n" |
| 390 | #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n" |
| 391 | #define OSPF6_NUMBER_STR "Specify by number\n" |
| 392 | #define INTERFACE_STR "Interface infomation\n" |
| 393 | #define IFNAME_STR "Interface name(e.g. ep0)\n" |
| 394 | #define IP6_STR "IPv6 Information\n" |
| 395 | #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n" |
| 396 | #define OSPF6_ROUTER_STR "Enable a routing process\n" |
| 397 | #define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n" |
| 398 | #define SECONDS_STR "<1-65535> Seconds\n" |
| 399 | #define ROUTE_STR "Routing Table\n" |
| 400 | #define PREFIX_LIST_STR "Build a prefix list\n" |
| 401 | #define OSPF6_DUMP_TYPE_LIST \ |
| 402 | "(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)" |
| 403 | #define ISIS_STR "IS-IS information\n" |
| 404 | #define AREA_TAG_STR "[area tag]\n" |
| 405 | |
| 406 | #define CONF_BACKUP_EXT ".sav" |
| 407 | |
| 408 | /* IPv4 only machine should not accept IPv6 address for peer's IP |
| 409 | address. So we replace VTY command string like below. */ |
| 410 | #ifdef HAVE_IPV6 |
| 411 | #define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) " |
| 412 | #define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) " |
| 413 | #define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n" |
| 414 | #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) " |
| 415 | #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) " |
| 416 | #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n" |
| 417 | #else |
| 418 | #define NEIGHBOR_CMD "neighbor A.B.C.D " |
| 419 | #define NO_NEIGHBOR_CMD "no neighbor A.B.C.D " |
| 420 | #define NEIGHBOR_ADDR_STR "Neighbor address\n" |
| 421 | #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) " |
| 422 | #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) " |
| 423 | #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n" |
| 424 | #endif /* HAVE_IPV6 */ |
| 425 | |
| 426 | /* Prototypes. */ |
| 427 | void install_node(struct cmd_node *, int (*)(struct vty *)); |
Neels Hofmeyr | 4a73d5e | 2017-09-24 18:39:41 +0200 | [diff] [blame] | 428 | void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()"); |
Holger Hans Peter Freyther | a9e5252 | 2015-08-02 02:14:07 +0000 | [diff] [blame] | 429 | void install_element(int node_type, struct cmd_element *); |
Vadim Yanitskiy | 99d5c2d | 2020-10-06 00:22:06 +0700 | [diff] [blame] | 430 | void install_lib_element(int node_type, struct cmd_element *); |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 431 | void install_element_ve(struct cmd_element *cmd); |
Vadim Yanitskiy | 99d5c2d | 2020-10-06 00:22:06 +0700 | [diff] [blame] | 432 | void install_lib_element_ve(struct cmd_element *cmd); |
Harald Welte | 95b2b47 | 2011-07-16 11:58:09 +0200 | [diff] [blame] | 433 | void sort_node(void); |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 434 | |
Neels Hofmeyr | 4a73d5e | 2017-09-24 18:39:41 +0200 | [diff] [blame] | 435 | void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()"); |
Jacob Erlbeck | 0c987bd | 2013-09-06 16:52:00 +0200 | [diff] [blame] | 436 | |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 437 | /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated |
| 438 | string with a space between each element (allocated using |
| 439 | XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */ |
| 440 | char *argv_concat(const char **argv, int argc, int shift); |
| 441 | |
| 442 | vector cmd_make_strvec(const char *); |
Neels Hofmeyr | 4a31ffa | 2017-09-07 03:08:06 +0200 | [diff] [blame] | 443 | int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p); |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 444 | void cmd_free_strvec(vector); |
Harald Welte | e61d459 | 2022-11-03 11:05:58 +0100 | [diff] [blame] | 445 | vector cmd_describe_command(vector vline, struct vty *vty, int *status); |
| 446 | char **cmd_complete_command(vector vline, struct vty *vty, int *status); |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 447 | const char *cmd_prompt(enum node_type); |
| 448 | int config_from_file(struct vty *, FILE *); |
| 449 | enum node_type node_parent(enum node_type); |
| 450 | int cmd_execute_command(vector, struct vty *, struct cmd_element **, int); |
| 451 | int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **); |
| 452 | void config_replace_string(struct cmd_element *, char *, ...); |
| 453 | void cmd_init(int); |
| 454 | |
| 455 | /* Export typical functions. */ |
| 456 | extern struct cmd_element config_exit_cmd; |
| 457 | extern struct cmd_element config_help_cmd; |
| 458 | extern struct cmd_element config_list_cmd; |
Harald Welte | 8ec7f90 | 2012-10-22 19:43:26 +0200 | [diff] [blame] | 459 | extern struct cmd_element config_end_cmd; |
Pau Espin Pedrol | ebb6c1f | 2021-05-17 18:54:21 +0200 | [diff] [blame] | 460 | const char *host_config_file(void); |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 461 | void host_config_set(const char *); |
| 462 | |
Alexander Couzens | ad580ba | 2016-05-16 16:01:45 +0200 | [diff] [blame] | 463 | char *osmo_asciidoc_escape(const char *inp); |
| 464 | |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 465 | /* This is called from main when a daemon is invoked with -v or --version. */ |
| 466 | void print_version(int print_copyright); |
| 467 | |
| 468 | extern void *tall_vty_cmd_ctx; |
| 469 | |
Vadim Yanitskiy | 4165d04 | 2020-10-23 16:40:57 +0700 | [diff] [blame] | 470 | /*! VTY reference generation mode. */ |
| 471 | enum vty_ref_gen_mode { |
| 472 | /*! Default mode: all commands except deprecated and hidden. */ |
| 473 | VTY_REF_GEN_MODE_DEFAULT = 0, |
| 474 | /*! Expert mode: all commands including hidden, excluding deprecated. */ |
| 475 | VTY_REF_GEN_MODE_EXPERT, |
Vadim Yanitskiy | 7031ac1 | 2020-11-17 16:22:44 +0700 | [diff] [blame] | 476 | /*! "Inverse" mode: only hidden commands. */ |
| 477 | VTY_REF_GEN_MODE_HIDDEN, |
Vadim Yanitskiy | 4165d04 | 2020-10-23 16:40:57 +0700 | [diff] [blame] | 478 | }; |
| 479 | |
| 480 | extern const struct value_string vty_ref_gen_mode_names[]; |
| 481 | extern const struct value_string vty_ref_gen_mode_desc[]; |
| 482 | |
| 483 | int vty_dump_xml_ref_mode(FILE *stream, enum vty_ref_gen_mode mode); |
| 484 | int vty_dump_xml_ref(FILE *stream) OSMO_DEPRECATED("Use vty_dump_xml_ref_mode() instead"); |
Neels Hofmeyr | cf70aa0 | 2020-05-14 16:51:26 +0200 | [diff] [blame] | 485 | |
Philipp Maier | eabc6fd | 2021-06-15 11:08:23 +0200 | [diff] [blame] | 486 | int vty_cmd_range_match(const char *range, const char *str); |
| 487 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 488 | /*! @} */ |