libosmovty  1.0.1
Osmocom VTY library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
command.h
Go to the documentation of this file.
1 
3 /*
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
20  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23 
24 #pragma once
25 
26 #include <stdio.h>
27 #include <sys/types.h>
28 #include "vector.h"
29 
30 #include <osmocom/core/defs.h>
31 
37 struct host {
39  char *name;
40 
42  char *password;
44 
46  char *enable;
48 
50  int lines;
51 
53  char *logfile;
54 
56  char *config;
57 
59  int advanced;
60  int encrypt;
61 
63  const char *motd;
64  char *motdfile;
65 
67  const struct vty_app_info *app_info;
68 };
69 
71 enum node_type {
100  /*
101  * When adding new nodes to the libosmocore project, these nodes can be
102  * used to avoid ABI changes for unrelated projects.
103  */
107 };
108 
109 #include "vty.h"
110 
113 struct cmd_node {
115  int node;
116 
118  const char *prompt;
119 
121  int vtysh;
122 
124  int (*func) (struct vty *);
125 
128 
132  char name[64];
133 };
134 
136 enum {
138  CMD_ATTR_HIDDEN = (1 << 1),
139 };
140 
142 struct cmd_element {
143  const char *string;
144  int (*func) (struct cmd_element *, struct vty *, int, const char *[]);
145  const char *doc;
146  int daemon;
148  unsigned int cmdsize;
149  char *config;
151  unsigned char attr;
152 };
153 
155 struct desc {
156  const char *cmd;
157  const char *str;
158 };
159 
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
172 #define CMD_ERR_INVALID_INDENT 11
173 
174 /* Argc max counts. */
175 #define CMD_ARGC_MAX 256
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 
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 
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 *));
364 void install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
365 void install_element(int node_type, struct cmd_element *);
366 void install_element_ve(struct cmd_element *cmd);
367 void sort_node(void);
368 
369 void vty_install_default(int node_type) OSMO_DEPRECATED("Now happens implicitly with install_node()");
370 
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 *);
377 int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p);
378 void cmd_free_strvec(vector);
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;
393 extern struct cmd_element config_end_cmd;
394 char *host_config_file();
395 void host_config_set(const char *);
396 
397 char *osmo_asciidoc_escape(const char *inp);
398 
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 
int advanced
Flags for services.
Definition: command.h:59
SS7 Application Server Process.
Definition: command.h:92
const char * prompt
Prompt character at vty interface.
Definition: command.h:118
char name[64]
Human-readable ID of this node.
Definition: command.h:132
#define OSMO_DEPRECATED(text)
SS7 root node.
Definition: command.h:90
int(* func)(struct cmd_element *, struct vty *, int, const char *[])
Definition: command.h:144
const char * string
Command specification by string.
Definition: command.h:143
const char * cmd
Command string.
Definition: command.h:156
int daemon
Daemon to which this command belong.
Definition: command.h:146
const char * doc
Documentation of this command.
Definition: command.h:145
char * argv_concat(const char **argv, int argc, int shift)
Definition: command.c:113
Internal representation of a single VTY.
Definition: vty.h:65
NS node in libosmo-gb.
Definition: command.h:86
void config_replace_string(struct cmd_element *, char *,...)
SS7 xUA Listener.
Definition: command.h:93
char * config
Configuration string.
Definition: command.h:149
const struct vty_app_info * app_info
VTY application information.
Definition: command.h:67
SS7 Link.
Definition: command.h:95
char * password
Password for vty interface.
Definition: command.h:42
Definition: command.h:106
E1 line in libosmo-abis.
Definition: command.h:84
void * tall_vty_cmd_ctx
Definition: command.c:58
Configure the logging.
Definition: command.h:79
IPA proxying commands in libosmo-abis.
Definition: command.h:85
Vty node.
Definition: command.h:82
void install_element(int node_type, struct cmd_element *)
Install a command into a node.
Definition: command.c:752
char * config
config file name of this host
Definition: command.h:56
Command description structure.
Definition: command.h:155
const char * cmd_prompt(enum node_type)
Return prompt character of specified node.
Definition: command.c:483
Host configuration variable.
Definition: command.h:37
Configure the statistics.
Definition: command.h:80
char * motdfile
Definition: command.h:64
Config node.
Definition: command.h:76
void sort_node(void)
Sort each node's command element according to command string.
Definition: command.c:211
int(* func)(struct vty *)
Node's configuration write function.
Definition: command.h:124
node_type
There are some command levels which called from command node.
Definition: command.h:71
Node which has some commands and prompt string and configuration function pointer ...
Definition: command.h:113
int cmd_make_strvec2(const char *string, char **indent, vector *strvec_p)
Break up string in command tokens.
Definition: command.c:250
void install_node(struct cmd_node *, int(*)(struct vty *))
Install top node of command vector.
Definition: command.c:175
void cmd_init(int)
Definition: command.c:3772
char ** cmd_complete_command()
vector cmd_describe_command()
int cmd_execute_command(vector, struct vty *, struct cmd_element **, int)
Definition: command.c:2297
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:3681
vector cmd_make_strvec(const char *)
Breaking up string into each command piece.
Definition: command.c:321
struct cmd_element config_list_cmd
void cmd_free_strvec(vector)
Free allocated string vector.
Definition: command.c:329
Authentication mode of vty interface.
Definition: command.h:72
SS7 Application Server.
Definition: command.h:91
View node.
Definition: command.h:73
SS7 Routing Table.
Definition: command.h:94
struct cmd_element config_help_cmd
struct cmd_element config_exit_cmd
SS7 SCCP Address.
Definition: command.h:97
vector strvec
Pointing out each description vector.
Definition: command.h:147
int lines
System wide terminal lines.
Definition: command.h:50
char * logfile
Log filename.
Definition: command.h:53
int vtysh
Is this node's configuration goes to vtysh ?
Definition: command.h:121
char * enable_encrypt
Definition: command.h:47
const char * motd
Banner configuration.
Definition: command.h:63
char * osmo_asciidoc_escape(const char *inp)
escape all special asciidoc symbols
Definition: command.c:496
vector cmd_vector
Vector of this node's command list.
Definition: command.h:127
Service node.
Definition: command.h:77
char * password_encrypt
Definition: command.h:43
Reserved for later extensions.
Definition: command.h:104
int cmd_execute_command_strict(vector, struct vty *, struct cmd_element **)
Definition: command.c:2331
Generic vector interface header.
char * enable
Enable password.
Definition: command.h:46
SS7 SCCP Global Title.
Definition: command.h:98
Structure of a command element.
Definition: command.h:142
int encrypt
Definition: command.h:60
unsigned char attr
Command attributes.
Definition: command.h:151
char * name
Host name of this router.
Definition: command.h:39
void install_element_ve(struct cmd_element *cmd)
Definition: command.c:770
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:3688
int config_from_file(struct vty *, FILE *)
Definition: command.c:2467
int node
Node index.
Definition: command.h:115
vector subconfig
Sub configuration string.
Definition: command.h:150
unsigned int cmdsize
Command index count.
Definition: command.h:148
Definition: command.h:137
SS7 Linkset.
Definition: command.h:96
Control interface node.
Definition: command.h:88
enum node_type node_parent(enum node_type)
void print_version(int print_copyright)
print the version (and optionally copyright) information
Definition: command.c:104
void host_config_set(const char *)
Definition: command.c:3673
const char * str
Command's description.
Definition: command.h:157
Enable node.
Definition: command.h:75
struct cmd_element config_end_cmd
Authentication mode for change enable.
Definition: command.h:74
Information an application registers with the VTY.
Definition: vty.h:171
BSSGP node in libosmo-gb.
Definition: command.h:87
Debug node.
Definition: command.h:78
char * host_config_file()
Definition: vector.h:27
Definition: command.h:138