src/shared/libosmocore/include/osmocom/vty/command.h

   1 /*
   2  * Zebra configuration command interface routine
   3  * Copyright (C) 1997, 98 Kunihiro Ishiguro
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation; either version 2, or (at your
  10  * option) any later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Zebra; see the file COPYING.  If not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifndef _ZEBRA_COMMAND_H
  24 #define _ZEBRA_COMMAND_H
  25
  26 #include <stdio.h>
  27 #include <sys/types.h>
  28 #include "vector.h"
  29 #include "vty.h"
  30
  31 /* Host configuration variable */
  32 struct host {
  33         /* Host name of this router. */
  34         char *name;
  35
  36         /* Password for vty interface. */
  37         char *password;
  38         char *password_encrypt;
  39
  40         /* Enable password */
  41         char *enable;
  42         char *enable_encrypt;
  43
  44         /* System wide terminal lines. */
  45         int lines;
  46
  47         /* Log filename. */
  48         char *logfile;
  49
  50         /* config file name of this host */
  51         char *config;
  52
  53         /* Flags for services */
  54         int advanced;
  55         int encrypt;
  56
  57         /* Banner configuration. */
  58         const char *motd;
  59         char *motdfile;
  60
  61         const struct vty_app_info *app_info;
  62 };
  63
  64 /* There are some command levels which called from command node. */
  65 enum node_type {
  66         AUTH_NODE,              /* Authentication mode of vty interface. */
  67         VIEW_NODE,              /* View node. Default mode of vty interface. */
  68         AUTH_ENABLE_NODE,       /* Authentication mode for change enable. */
  69         ENABLE_NODE,            /* Enable node. */
  70         CONFIG_NODE,            /* Config node. Default mode of config file. */
  71         SERVICE_NODE,           /* Service node. */
  72         DEBUG_NODE,             /* Debug node. */
  73
  74         VTY_NODE,               /* Vty node. */
  75
  76         _LAST_OSMOVTY_NODE
  77 };
  78
  79 /* Node which has some commands and prompt string and configuration
  80    function pointer . */
  81 struct cmd_node {
  82         /* Node index. */
  83         enum node_type node;
  84
  85         /* Prompt character at vty interface. */
  86         const char *prompt;
  87
  88         /* Is this node's configuration goes to vtysh ? */
  89         int vtysh;
  90
  91         /* Node's configuration write function */
  92         int (*func) (struct vty *);
  93
  94         /* Vector of this node's command list. */
  95         vector cmd_vector;
  96 };
  97
  98 enum {
  99         CMD_ATTR_DEPRECATED = 1,
 100         CMD_ATTR_HIDDEN,
 101 };
 102
 103 /* Structure of command element. */
 104 struct cmd_element {
 105         const char *string;     /* Command specification by string. */
 106         int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
 107         const char *doc;        /* Documentation of this command. */
 108         int daemon;             /* Daemon to which this command belong. */
 109         vector strvec;          /* Pointing out each description vector. */
 110         unsigned int cmdsize;   /* Command index count. */
 111         char *config;           /* Configuration string */
 112         vector subconfig;       /* Sub configuration string */
 113         u_char attr;            /* Command attributes */
 114 };
 115
 116 /* Command description structure. */
 117 struct desc {
 118         const char *cmd;        /* Command string. */
 119         const char *str;        /* Command's description. */
 120 };
 121
 122 /* Return value of the commands. */
 123 #define CMD_SUCCESS              0
 124 #define CMD_WARNING              1
 125 #define CMD_ERR_NO_MATCH         2
 126 #define CMD_ERR_AMBIGUOUS        3
 127 #define CMD_ERR_INCOMPLETE       4
 128 #define CMD_ERR_EXEED_ARGC_MAX   5
 129 #define CMD_ERR_NOTHING_TODO     6
 130 #define CMD_COMPLETE_FULL_MATCH  7
 131 #define CMD_COMPLETE_MATCH       8
 132 #define CMD_COMPLETE_LIST_MATCH  9
 133 #define CMD_SUCCESS_DAEMON      10
 134
 135 /* Argc max counts. */
 136 #define CMD_ARGC_MAX   25
 137
 138 /* Turn off these macros when uisng cpp with extract.pl */
 139 #ifndef VTYSH_EXTRACT_PL
 140
 141 /* helper defines for end-user DEFUN* macros */
 142 #define DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
 143   static struct cmd_element cmdname = \
 144   { \
 145     .string = cmdstr, \
 146     .func = funcname, \
 147     .doc = helpstr, \
 148     .attr = attrs, \
 149     .daemon = dnum, \
 150   };
 151
 152 /* global (non static) cmd_element */
 153 #define gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attrs, dnum) \
 154   struct cmd_element cmdname = \
 155   { \
 156     .string = cmdstr, \
 157     .func = funcname, \
 158     .doc = helpstr, \
 159     .attr = attrs, \
 160     .daemon = dnum, \
 161   };
 162
 163 #define DEFUN_CMD_FUNC_DECL(funcname) \
 164   static int funcname (struct cmd_element *, struct vty *, int, const char *[]); \
 165
 166 #define DEFUN_CMD_FUNC_TEXT(funcname) \
 167   static int funcname \
 168     (struct cmd_element *self, struct vty *vty, int argc, const char *argv[])
 169
 170 /* DEFUN for vty command interafce. Little bit hacky ;-). */
 171 #define DEFUN(funcname, cmdname, cmdstr, helpstr) \
 172   DEFUN_CMD_FUNC_DECL(funcname) \
 173   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
 174   DEFUN_CMD_FUNC_TEXT(funcname)
 175
 176 /* global (non static) cmd_element */
 177 #define gDEFUN(funcname, cmdname, cmdstr, helpstr) \
 178   DEFUN_CMD_FUNC_DECL(funcname) \
 179   gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0) \
 180   DEFUN_CMD_FUNC_TEXT(funcname)
 181
 182 #define DEFUN_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
 183   DEFUN_CMD_FUNC_DECL(funcname) \
 184   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0) \
 185   DEFUN_CMD_FUNC_TEXT(funcname)
 186
 187 #define DEFUN_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
 188   DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 189
 190 #define DEFUN_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
 191   DEFUN_ATTR (funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED) \
 192
 193 /* DEFUN_NOSH for commands that vtysh should ignore */
 194 #define DEFUN_NOSH(funcname, cmdname, cmdstr, helpstr) \
 195   DEFUN(funcname, cmdname, cmdstr, helpstr)
 196
 197 /* DEFSH for vtysh. */
 198 #define DEFSH(daemon, cmdname, cmdstr, helpstr) \
 199   DEFUN_CMD_ELEMENT(NULL, cmdname, cmdstr, helpstr, 0, daemon) \
 200
 201 /* DEFUN + DEFSH */
 202 #define DEFUNSH(daemon, funcname, cmdname, cmdstr, helpstr) \
 203   DEFUN_CMD_FUNC_DECL(funcname) \
 204   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon) \
 205   DEFUN_CMD_FUNC_TEXT(funcname)
 206
 207 /* DEFUN + DEFSH with attributes */
 208 #define DEFUNSH_ATTR(daemon, funcname, cmdname, cmdstr, helpstr, attr) \
 209   DEFUN_CMD_FUNC_DECL(funcname) \
 210   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, daemon) \
 211   DEFUN_CMD_FUNC_TEXT(funcname)
 212
 213 #define DEFUNSH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
 214   DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN)
 215
 216 #define DEFUNSH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
 217   DEFUNSH_ATTR (daemon, funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED)
 218
 219 /* ALIAS macro which define existing command's alias. */
 220 #define ALIAS(funcname, cmdname, cmdstr, helpstr) \
 221   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
 222
 223 /* global (non static) cmd_element */
 224 #define gALIAS(funcname, cmdname, cmdstr, helpstr) \
 225   gDEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, 0)
 226
 227 #define ALIAS_ATTR(funcname, cmdname, cmdstr, helpstr, attr) \
 228   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, attr, 0)
 229
 230 #define ALIAS_HIDDEN(funcname, cmdname, cmdstr, helpstr) \
 231   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, 0)
 232
 233 #define ALIAS_DEPRECATED(funcname, cmdname, cmdstr, helpstr) \
 234   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, 0)
 235
 236 #define ALIAS_SH(daemon, funcname, cmdname, cmdstr, helpstr) \
 237   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, 0, daemon)
 238
 239 #define ALIAS_SH_HIDDEN(daemon, funcname, cmdname, cmdstr, helpstr) \
 240   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_HIDDEN, daemon)
 241
 242 #define ALIAS_SH_DEPRECATED(daemon, funcname, cmdname, cmdstr, helpstr) \
 243   DEFUN_CMD_ELEMENT(funcname, cmdname, cmdstr, helpstr, CMD_ATTR_DEPRECATED, daemon)
 244
 245 #endif                          /* VTYSH_EXTRACT_PL */
 246
 247 /* Some macroes */
 248 #define CMD_OPTION(S)   ((S[0]) == '[')
 249 #define CMD_VARIABLE(S) (((S[0]) >= 'A' && (S[0]) <= 'Z') || ((S[0]) == '<'))
 250 #define CMD_VARARG(S)   ((S[0]) == '.')
 251 #define CMD_RANGE(S)    ((S[0] == '<'))
 252
 253 #define CMD_IPV4(S)        ((strcmp ((S), "A.B.C.D") == 0))
 254 #define CMD_IPV4_PREFIX(S) ((strcmp ((S), "A.B.C.D/M") == 0))
 255 #define CMD_IPV6(S)        ((strcmp ((S), "X:X::X:X") == 0))
 256 #define CMD_IPV6_PREFIX(S) ((strcmp ((S), "X:X::X:X/M") == 0))
 257
 258 /* Common descriptions. */
 259 #define SHOW_STR "Show running system information\n"
 260 #define IP_STR "IP information\n"
 261 #define IPV6_STR "IPv6 information\n"
 262 #define NO_STR "Negate a command or set its defaults\n"
 263 #define CLEAR_STR "Reset functions\n"
 264 #define RIP_STR "RIP information\n"
 265 #define BGP_STR "BGP information\n"
 266 #define OSPF_STR "OSPF information\n"
 267 #define NEIGHBOR_STR "Specify neighbor router\n"
 268 #define DEBUG_STR "Debugging functions (see also 'undebug')\n"
 269 #define UNDEBUG_STR "Disable debugging functions (see also 'debug')\n"
 270 #define ROUTER_STR "Enable a routing process\n"
 271 #define AS_STR "AS number\n"
 272 #define MBGP_STR "MBGP information\n"
 273 #define MATCH_STR "Match values from routing table\n"
 274 #define SET_STR "Set values in destination routing protocol\n"
 275 #define OUT_STR "Filter outgoing routing updates\n"
 276 #define IN_STR  "Filter incoming routing updates\n"
 277 #define V4NOTATION_STR "specify by IPv4 address notation(e.g. 0.0.0.0)\n"
 278 #define OSPF6_NUMBER_STR "Specify by number\n"
 279 #define INTERFACE_STR "Interface infomation\n"
 280 #define IFNAME_STR "Interface name(e.g. ep0)\n"
 281 #define IP6_STR "IPv6 Information\n"
 282 #define OSPF6_STR "Open Shortest Path First (OSPF) for IPv6\n"
 283 #define OSPF6_ROUTER_STR "Enable a routing process\n"
 284 #define OSPF6_INSTANCE_STR "<1-65535> Instance ID\n"
 285 #define SECONDS_STR "<1-65535> Seconds\n"
 286 #define ROUTE_STR "Routing Table\n"
 287 #define PREFIX_LIST_STR "Build a prefix list\n"
 288 #define OSPF6_DUMP_TYPE_LIST \
 289 "(neighbor|interface|area|lsa|zebra|config|dbex|spf|route|lsdb|redistribute|hook|asbr|prefix|abr)"
 290 #define ISIS_STR "IS-IS information\n"
 291 #define AREA_TAG_STR "[area tag]\n"
 292
 293 #define CONF_BACKUP_EXT ".sav"
 294
 295 /* IPv4 only machine should not accept IPv6 address for peer's IP
 296    address.  So we replace VTY command string like below. */
 297 #ifdef HAVE_IPV6
 298 #define NEIGHBOR_CMD       "neighbor (A.B.C.D|X:X::X:X) "
 299 #define NO_NEIGHBOR_CMD    "no neighbor (A.B.C.D|X:X::X:X) "
 300 #define NEIGHBOR_ADDR_STR  "Neighbor address\nIPv6 address\n"
 301 #define NEIGHBOR_CMD2      "neighbor (A.B.C.D|X:X::X:X|WORD) "
 302 #define NO_NEIGHBOR_CMD2   "no neighbor (A.B.C.D|X:X::X:X|WORD) "
 303 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor IPv6 address\nNeighbor tag\n"
 304 #else
 305 #define NEIGHBOR_CMD       "neighbor A.B.C.D "
 306 #define NO_NEIGHBOR_CMD    "no neighbor A.B.C.D "
 307 #define NEIGHBOR_ADDR_STR  "Neighbor address\n"
 308 #define NEIGHBOR_CMD2      "neighbor (A.B.C.D|WORD) "
 309 #define NO_NEIGHBOR_CMD2   "no neighbor (A.B.C.D|WORD) "
 310 #define NEIGHBOR_ADDR_STR2 "Neighbor address\nNeighbor tag\n"
 311 #endif                          /* HAVE_IPV6 */
 312
 313 /* Prototypes. */
 314 void install_node(struct cmd_node *, int (*)(struct vty *));
 315 void install_default(enum node_type);
 316 void install_element(enum node_type, struct cmd_element *);
 317 void install_element_ve(struct cmd_element *cmd);
 318 void sort_node();
 319
 320 /* Concatenates argv[shift] through argv[argc-1] into a single NUL-terminated
 321    string with a space between each element (allocated using
 322    XMALLOC(MTYPE_TMP)).  Returns NULL if shift >= argc. */
 323 char *argv_concat(const char **argv, int argc, int shift);
 324
 325 vector cmd_make_strvec(const char *);
 326 void cmd_free_strvec(vector);
 327 vector cmd_describe_command();
 328 char **cmd_complete_command();
 329 const char *cmd_prompt(enum node_type);
 330 int config_from_file(struct vty *, FILE *);
 331 enum node_type node_parent(enum node_type);
 332 int cmd_execute_command(vector, struct vty *, struct cmd_element **, int);
 333 int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **);
 334 void config_replace_string(struct cmd_element *, char *, ...);
 335 void cmd_init(int);
 336
 337 /* Export typical functions. */
 338 extern struct cmd_element config_exit_cmd;
 339 extern struct cmd_element config_help_cmd;
 340 extern struct cmd_element config_list_cmd;
 341 char *host_config_file();
 342 void host_config_set(const char *);
 343
 344 /* This is called from main when a daemon is invoked with -v or --version. */
 345 void print_version(int print_copyright);
 346
 347 extern void *tall_vty_cmd_ctx;
 348
 349 #endif                          /* _ZEBRA_COMMAND_H */