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> |
| 27 | #include <sys/types.h> |
| 28 | #include "vector.h" |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 29 | |
Neels Hofmeyr | f4f23bd | 2017-09-20 15:39:37 +0200 | [diff] [blame] | 30 | #include <osmocom/core/defs.h> |
| 31 | |
Harald Welte | e881b1b | 2011-08-17 18:52:30 +0200 | [diff] [blame] | 32 | /*! \defgroup command VTY Command |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 33 | * @{ |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 34 | * \file command.h */ |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 35 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 36 | /*! Host configuration variable */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 37 | struct host { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 38 | /*! Host name of this router. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 39 | char *name; |
| 40 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 41 | /*! Password for vty interface. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 42 | char *password; |
| 43 | char *password_encrypt; |
| 44 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 45 | /*! Enable password */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 46 | char *enable; |
| 47 | char *enable_encrypt; |
| 48 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 49 | /*! System wide terminal lines. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 50 | int lines; |
| 51 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 52 | /*! Log filename. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 53 | char *logfile; |
| 54 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 55 | /*! config file name of this host */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 56 | char *config; |
| 57 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 58 | /*! Flags for services */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 59 | int advanced; |
| 60 | int encrypt; |
| 61 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 62 | /*! Banner configuration. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 63 | const char *motd; |
| 64 | char *motdfile; |
| 65 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 66 | /*! VTY application information */ |
Harald Welte | 237f624 | 2010-05-25 23:00:45 +0200 | [diff] [blame] | 67 | const struct vty_app_info *app_info; |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 68 | }; |
| 69 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 70 | /*! There are some command levels which called from command node. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 71 | enum node_type { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 72 | AUTH_NODE, /*!< Authentication mode of vty interface. */ |
| 73 | VIEW_NODE, /*!< View node. Default mode of vty interface. */ |
| 74 | AUTH_ENABLE_NODE, /*!< Authentication mode for change enable. */ |
| 75 | ENABLE_NODE, /*!< Enable node. */ |
| 76 | CONFIG_NODE, /*!< Config node. Default mode of config file. */ |
| 77 | SERVICE_NODE, /*!< Service node. */ |
| 78 | DEBUG_NODE, /*!< Debug node. */ |
| 79 | CFG_LOG_NODE, /*!< Configure the logging */ |
| 80 | CFG_STATS_NODE, /*!< Configure the statistics */ |
Harald Welte | 4c05301 | 2010-05-31 16:01:59 +0200 | [diff] [blame] | 81 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 82 | VTY_NODE, /*!< Vty node. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 83 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 84 | L_E1INP_NODE, /*!< E1 line in libosmo-abis. */ |
| 85 | L_IPA_NODE, /*!< IPA proxying commands in libosmo-abis. */ |
| 86 | L_NS_NODE, /*!< NS node in libosmo-gb. */ |
| 87 | L_BSSGP_NODE, /*!< BSSGP node in libosmo-gb. */ |
| 88 | L_CTRL_NODE, /*!< Control interface node. */ |
Pablo Neira Ayuso | 2ade3a0 | 2011-07-07 19:46:50 +0200 | [diff] [blame] | 89 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 90 | L_CS7_NODE, /*!< SS7 root node */ |
| 91 | L_CS7_AS_NODE, /*!< SS7 Application Server */ |
| 92 | L_CS7_ASP_NODE, /*!< SS7 Application Server Process */ |
| 93 | L_CS7_XUA_NODE, /*!< SS7 xUA Listener */ |
| 94 | L_CS7_RTABLE_NODE, /*!< SS7 Routing Table */ |
| 95 | L_CS7_LINK_NODE, /*!< SS7 Link */ |
| 96 | L_CS7_LINKSET_NODE, /*!< SS7 Linkset */ |
| 97 | L_CS7_SCCPADDR_NODE, /*!< SS7 SCCP Address */ |
| 98 | L_CS7_SCCPADDR_GT_NODE, /*!< SS7 SCCP Global Title */ |
Harald Welte | b522740 | 2017-04-14 14:01:56 +0200 | [diff] [blame] | 99 | |
Jacob Erlbeck | 34eec7d | 2015-11-02 10:50:50 +0100 | [diff] [blame] | 100 | /* |
| 101 | * When adding new nodes to the libosmocore project, these nodes can be |
| 102 | * used to avoid ABI changes for unrelated projects. |
| 103 | */ |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 104 | RESERVED3_NODE, /*!< Reserved for later extensions */ |
Jacob Erlbeck | 34eec7d | 2015-11-02 10:50:50 +0100 | [diff] [blame] | 105 | |
Harald Welte | 4c05301 | 2010-05-31 16:01:59 +0200 | [diff] [blame] | 106 | _LAST_OSMOVTY_NODE |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 107 | }; |
| 108 | |
Andreas Eversberg | 3c6a2ce | 2012-07-12 09:22:56 +0200 | [diff] [blame] | 109 | #include "vty.h" |
| 110 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 111 | /*! Node which has some commands and prompt string and |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 112 | * configuration function pointer . */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 113 | struct cmd_node { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 114 | /*! Node index */ |
Holger Hans Peter Freyther | a9e5252 | 2015-08-02 02:14:07 +0000 | [diff] [blame] | 115 | int node; |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 116 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 117 | /*! Prompt character at vty interface. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 118 | const char *prompt; |
| 119 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 120 | /*! Is this node's configuration goes to vtysh ? */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 121 | int vtysh; |
| 122 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 123 | /*! Node's configuration write function */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 124 | int (*func) (struct vty *); |
| 125 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 126 | /*! Vector of this node's command list. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 127 | vector cmd_vector; |
Neels Hofmeyr | 657c5b6 | 2017-09-18 16:42:06 +0200 | [diff] [blame] | 128 | |
| 129 | /*! Human-readable ID of this node. Should only contain alphanumeric |
| 130 | * plus '-' and '_' characters (is used as XML ID for 'show |
| 131 | * online-help'). If left NUL, this is derived from the prompt.*/ |
| 132 | char name[64]; |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 133 | }; |
| 134 | |
Vadim Yanitskiy | e65c8ba | 2018-09-24 12:56:31 +0700 | [diff] [blame] | 135 | /*! Attributes (flags) for \ref cmd_element */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 136 | enum { |
Vadim Yanitskiy | e65c8ba | 2018-09-24 12:56:31 +0700 | [diff] [blame] | 137 | CMD_ATTR_DEPRECATED = (1 << 0), |
| 138 | CMD_ATTR_HIDDEN = (1 << 1), |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 139 | }; |
| 140 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 141 | /*! Structure of a command element */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 142 | struct cmd_element { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 143 | const char *string; /*!< Command specification by string. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 144 | int (*func) (struct cmd_element *, struct vty *, int, const char *[]); |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 145 | const char *doc; /*!< Documentation of this command. */ |
| 146 | int daemon; /*!< Daemon to which this command belong. */ |
| 147 | vector strvec; /*!< Pointing out each description vector. */ |
| 148 | unsigned int cmdsize; /*!< Command index count. */ |
| 149 | char *config; /*!< Configuration string */ |
| 150 | vector subconfig; /*!< Sub configuration string */ |
| 151 | unsigned char attr; /*!< Command attributes */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 152 | }; |
| 153 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 154 | /*! Command description structure. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 155 | struct desc { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 156 | const char *cmd; /*!< Command string. */ |
| 157 | const char *str; /*!< Command's description. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 158 | }; |
| 159 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 160 | /*! Return value of the commands. */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 161 | #define CMD_SUCCESS 0 |
| 162 | #define CMD_WARNING 1 |
| 163 | #define CMD_ERR_NO_MATCH 2 |
| 164 | #define CMD_ERR_AMBIGUOUS 3 |
| 165 | #define CMD_ERR_INCOMPLETE 4 |
| 166 | #define CMD_ERR_EXEED_ARGC_MAX 5 |
| 167 | #define CMD_ERR_NOTHING_TODO 6 |
| 168 | #define CMD_COMPLETE_FULL_MATCH 7 |
| 169 | #define CMD_COMPLETE_MATCH 8 |
| 170 | #define CMD_COMPLETE_LIST_MATCH 9 |
| 171 | #define CMD_SUCCESS_DAEMON 10 |
Neels Hofmeyr | 4a31ffa | 2017-09-07 03:08:06 +0200 | [diff] [blame] | 172 | #define CMD_ERR_INVALID_INDENT 11 |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 173 | |
| 174 | /* Argc max counts. */ |
Holger Hans Peter Freyther | c0dbe0b | 2011-07-24 19:58:06 +0200 | [diff] [blame] | 175 | #define CMD_ARGC_MAX 256 |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 176 | |
| 177 | /* Turn off these macros when uisng cpp with extract.pl */ |
| 178 | #ifndef VTYSH_EXTRACT_PL |
| 179 | |
| 180 | /* helper defines for end-user DEFUN* macros */ |
| 181 | #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \ |
| 182 | static struct cmd_element cmdname = \ |
| 183 | { \ |
| 184 | .string = cmdstr, \ |
| 185 | .func = funcname, \ |
| 186 | .doc = helpstr, \ |
| 187 | .attr = attrs, \ |
| 188 | .daemon = dnum, \ |
| 189 | }; |
| 190 | |
| 191 | /* global (non static) cmd_element */ |
| 192 | #define gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \ |
| 193 | struct cmd_element cmdname = \ |
| 194 | { \ |
| 195 | .string = cmdstr, \ |
| 196 | .func = funcname, \ |
| 197 | .doc = helpstr, \ |
| 198 | .attr = attrs, \ |
| 199 | .daemon = dnum, \ |
| 200 | }; |
| 201 | |
| 202 | #define DEFUN_CMD_FUNC_DECL(funcname) \ |
| 203 | static int funcname (struct cmd_element *, struct vty *, int, const char *[]); \ |
| 204 | |
| 205 | #define DEFUN_CMD_FUNC_TEXT(funcname) \ |
| 206 | static int funcname \ |
| 207 | (struct cmd_element *self, struct vty *vty, int argc, const char *argv[]) |
| 208 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 209 | /*! Macro for defining a VTY node and function |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 210 | * \param[in] funcname Name of the function implementing the node |
| 211 | * \param[in] cmdname Name of the command node |
| 212 | * \param[in] cmdstr String with syntax of node |
| 213 | * \param[in] helpstr String with help message of node |
| 214 | */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 215 | #define DEFUN(funcname, cmdname, cmdstr, helpstr) \ |
| 216 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 217 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \ |
| 218 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 219 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 220 | /*! Macro for defining a non-static (global) VTY node and function |
Harald Welte | 7acb30c | 2011-08-17 17:13:48 +0200 | [diff] [blame] | 221 | * \param[in] funcname Name of the function implementing the node |
| 222 | * \param[in] cmdname Name of the command node |
| 223 | * \param[in] cmdstr String with syntax of node |
| 224 | * \param[in] helpstr String with help message of node |
| 225 | */ |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 226 | #define gDEFUN(funcname, cmdname, cmdstr, helpstr) \ |
| 227 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 228 | gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \ |
| 229 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 230 | |
| 231 | #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \ |
| 232 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 233 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \ |
| 234 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 235 | |
| 236 | #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ |
| 237 | DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN) |
| 238 | |
| 239 | #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ |
| 240 | DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \ |
| 241 | |
| 242 | /* DEFUN_NOSH for commands that vtysh should ignore */ |
| 243 | #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \ |
| 244 | DEFUN(funcname, cmdname, cmdstr, helpstr) |
| 245 | |
| 246 | /* DEFSH for vtysh. */ |
| 247 | #define DEFSH(daemon, cmdname, cmdstr, helpstr) \ |
| 248 | DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \ |
| 249 | |
| 250 | /* DEFUN + DEFSH */ |
| 251 | #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 252 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 253 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \ |
| 254 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 255 | |
| 256 | /* DEFUN + DEFSH with attributes */ |
| 257 | #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \ |
| 258 | DEFUN_CMD_FUNC_DECL(funcname) \ |
| 259 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \ |
| 260 | DEFUN_CMD_FUNC_TEXT(funcname) |
| 261 | |
| 262 | #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 263 | DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN) |
| 264 | |
| 265 | #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 266 | DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) |
| 267 | |
| 268 | /* ALIAS macro which define existing command's alias. */ |
| 269 | #define ALIAS(funcname, cmdname, cmdstr, helpstr) \ |
| 270 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) |
| 271 | |
| 272 | /* global (non static) cmd_element */ |
| 273 | #define gALIAS(funcname, cmdname, cmdstr, helpstr) \ |
| 274 | gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) |
| 275 | |
| 276 | #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \ |
| 277 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) |
| 278 | |
| 279 | #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \ |
| 280 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0) |
| 281 | |
| 282 | #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \ |
| 283 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0) |
| 284 | |
| 285 | #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 286 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) |
| 287 | |
| 288 | #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 289 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon) |
| 290 | |
| 291 | #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \ |
| 292 | DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon) |
| 293 | |
| 294 | #endif /* VTYSH_EXTRACT_PL */ |
| 295 | |
| 296 | /* Some macroes */ |
| 297 | #define CMD_OPTION(S) ((S[0]) == '[') |
| 298 | #define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<')) |
| 299 | #define CMD_VARARG(S) ((S[0]) == '.') |
| 300 | #define CMD_RANGE(S) ((S[0] == '<')) |
| 301 | |
| 302 | #define CMD_IPV4(S) ((strcmp ((S), "A.B.C.D") == 0)) |
| 303 | #define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0)) |
| 304 | #define CMD_IPV6(S) ((strcmp ((S), "X:X::X:X") == 0)) |
| 305 | #define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0)) |
| 306 | |
| 307 | /* Common descriptions. */ |
| 308 | #define SHOW_STR "Show running system information\n" |
| 309 | #define IP_STR "IP information\n" |
| 310 | #define IPV6_STR "IPv6 information\n" |
| 311 | #define NO_STR "Negate a command or set its defaults\n" |
| 312 | #define CLEAR_STR "Reset functions\n" |
| 313 | #define RIP_STR "RIP information\n" |
| 314 | #define BGP_STR "BGP information\n" |
| 315 | #define OSPF_STR "OSPF information\n" |
| 316 | #define NEIGHBOR_STR "Specify neighbor router\n" |
| 317 | #define DEBUG_STR "Debugging functions (see also 'undebug')\n" |
| 318 | #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n" |
| 319 | #define ROUTER_STR "Enable a routing process\n" |
| 320 | #define AS_STR "AS number\n" |
| 321 | #define MBGP_STR "MBGP information\n" |
| 322 | #define MATCH_STR "Match values from routing table\n" |
| 323 | #define SET_STR "Set values in destination routing protocol\n" |
| 324 | #define OUT_STR "Filter outgoing routing updates\n" |
| 325 | #define IN_STR "Filter incoming routing updates\n" |
| 326 | #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n" |
| 327 | #define OSPF6_NUMBER_STR "Specify by number\n" |
| 328 | #define INTERFACE_STR "Interface infomation\n" |
| 329 | #define IFNAME_STR "Interface name(e.g. ep0)\n" |
| 330 | #define IP6_STR "IPv6 Information\n" |
| 331 | #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n" |
| 332 | #define OSPF6_ROUTER_STR "Enable a routing process\n" |
| 333 | #define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n" |
| 334 | #define SECONDS_STR "<1-65535> Seconds\n" |
| 335 | #define ROUTE_STR "Routing Table\n" |
| 336 | #define PREFIX_LIST_STR "Build a prefix list\n" |
| 337 | #define OSPF6_DUMP_TYPE_LIST \ |
| 338 | "(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)" |
| 339 | #define ISIS_STR "IS-IS information\n" |
| 340 | #define AREA_TAG_STR "[area tag]\n" |
| 341 | |
| 342 | #define CONF_BACKUP_EXT ".sav" |
| 343 | |
| 344 | /* IPv4 only machine should not accept IPv6 address for peer's IP |
| 345 | address. So we replace VTY command string like below. */ |
| 346 | #ifdef HAVE_IPV6 |
| 347 | #define NEIGHBOR_CMD "neighbor (A.B.C.D|X:X::X:X) " |
| 348 | #define NO_NEIGHBOR_CMD "no neighbor (A.B.C.D|X:X::X:X) " |
| 349 | #define NEIGHBOR_ADDR_STR "Neighbor address\nIPv6 address\n" |
| 350 | #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|X:X::X:X|WORD) " |
| 351 | #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|X:X::X:X|WORD) " |
| 352 | #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n" |
| 353 | #else |
| 354 | #define NEIGHBOR_CMD "neighbor A.B.C.D " |
| 355 | #define NO_NEIGHBOR_CMD "no neighbor A.B.C.D " |
| 356 | #define NEIGHBOR_ADDR_STR "Neighbor address\n" |
| 357 | #define NEIGHBOR_CMD2 "neighbor (A.B.C.D|WORD) " |
| 358 | #define NO_NEIGHBOR_CMD2 "no neighbor (A.B.C.D|WORD) " |
| 359 | #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n" |
| 360 | #endif /* HAVE_IPV6 */ |
| 361 | |
| 362 | /* Prototypes. */ |
| 363 | void install_node(struct cmd_node *, int (*)(struct vty *)); |
Neels Hofmeyr | 4a73d5e | 2017-09-24 18:39:41 +0200 | [diff] [blame] | 364 | 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] | 365 | void install_element(int node_type, struct cmd_element *); |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 366 | void install_element_ve(struct cmd_element *cmd); |
Harald Welte | 95b2b47 | 2011-07-16 11:58:09 +0200 | [diff] [blame] | 367 | void sort_node(void); |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 368 | |
Neels Hofmeyr | 4a73d5e | 2017-09-24 18:39:41 +0200 | [diff] [blame] | 369 | 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] | 370 | |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 371 | /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated |
| 372 | string with a space between each element (allocated using |
| 373 | XMALLOC(MTYPE_TMP)). Returns NULL if shift >= argc. */ |
| 374 | char *argv_concat(const char **argv, int argc, int shift); |
| 375 | |
| 376 | vector cmd_make_strvec(const char *); |
Neels Hofmeyr | 4a31ffa | 2017-09-07 03:08:06 +0200 | [diff] [blame] | 377 | int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p); |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 378 | void cmd_free_strvec(vector); |
| 379 | vector cmd_describe_command(); |
| 380 | char **cmd_complete_command(); |
| 381 | const char *cmd_prompt(enum node_type); |
| 382 | int config_from_file(struct vty *, FILE *); |
| 383 | enum node_type node_parent(enum node_type); |
| 384 | int cmd_execute_command(vector, struct vty *, struct cmd_element **, int); |
| 385 | int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **); |
| 386 | void config_replace_string(struct cmd_element *, char *, ...); |
| 387 | void cmd_init(int); |
| 388 | |
| 389 | /* Export typical functions. */ |
| 390 | extern struct cmd_element config_exit_cmd; |
| 391 | extern struct cmd_element config_help_cmd; |
| 392 | extern struct cmd_element config_list_cmd; |
Harald Welte | 8ec7f90 | 2012-10-22 19:43:26 +0200 | [diff] [blame] | 393 | extern struct cmd_element config_end_cmd; |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 394 | char *host_config_file(); |
| 395 | void host_config_set(const char *); |
| 396 | |
Alexander Couzens | ad580ba | 2016-05-16 16:01:45 +0200 | [diff] [blame] | 397 | char *osmo_asciidoc_escape(const char *inp); |
| 398 | |
Harald Welte | 3fb0b6f | 2010-05-19 19:02:52 +0200 | [diff] [blame] | 399 | /* This is called from main when a daemon is invoked with -v or --version. */ |
| 400 | void print_version(int print_copyright); |
| 401 | |
| 402 | extern void *tall_vty_cmd_ctx; |
| 403 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 404 | /*! @} */ |