1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
/* VTY top level
* Copyright (C) 1997, 98 Kunihiro Ishiguro
*
* Revisions: Copyright (C) 2010 Chris Hall (GMCH), Highwayman
*
* 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., 59 Temple Place - Suite 330, Boston, MA
* 02111-1307, USA.
*/
#ifndef _ZEBRA_VTY_H
#define _ZEBRA_VTY_H
#include "misc.h"
#include "thread.h"
#include "log.h"
#include "qpthreads.h"
#include "qpselect.h"
#include "qtimers.h"
#include "qpnexus.h"
#include "list_util.h"
#include "vector.h"
#include "qstring.h"
#include "node_type.h"
/*==============================================================================
* The VTYSH uses a unix socket to talk to the daemon.
*
* The ability to respond to a connection from VTYSH appears to be a *compile*
* time option. In the interests of keeping the code up to date, the VTYSH
* option is turned into a testable constant.
*/
#ifdef VTYSH
enum { VTYSH_ENABLED = true } ;
#else
enum { VTYSH_ENABLED = false } ;
#endif
/*==============================================================================
* VTY Types
*/
enum vty_type /* Command output */
{
VTY_TERMINAL, /* a telnet terminal server */
VTY_SHELL_SERVER, /* a vty_shell server */
VTY_SHELL_CLIENT, /* a vty_shell client */
VTY_CONFIG_READ, /* configuration file reader */
VTY_STDOUT, /* stdout */
VTY_STDERR, /* stderr */
} ;
typedef enum vty_type vty_type_t ;
/*==============================================================================
*
*
*
*
*/
typedef unsigned long vty_timer_time ; /* Time out time in seconds */
enum
{
VTY_WATCH_DOG_INTERVAL = 5, /* interval between barks */
VTY_HALF_CLOSE_TIMEOUT = 120, /* timeout after half_close */
VTY_TIMEOUT_DEFAULT = 600, /* terminal timeout value */
} ;
/*==============================================================================
* VTY struct.
*/
typedef struct vty_io* vty_io ; /* private to vty.c */
struct cmd_parsed ; /* in case vty.h expanded before command.h */
typedef struct vty* vty ;
struct vty
{
vty_type_t type ;
/*----------------------------------------------------------------------
* The following are the context in which commands are executed.
*/
/* Node status of this vty
*
* NB: when using qpthreads should lock VTY to access this -- so use
* vty_get_node() and vty_set_node().
*/
enum node_type node ;
/* For current referencing point of interface, route-map, access-list
* etc...
*
* NB: this value is private to the command execution, which is assumed
* to all be in the one thread... so no lock required.
*/
void *index ;
/* For multiple level index treatment such as key chain and key.
*
* NB: this value is private to the command execution, which is assumed
* to all be in the one thread... so no lock required.
*/
void *index_sub ;
/* In configure mode. */
bool config;
/*----------------------------------------------------------------------------
* The current command line.
*
* These are set when a command is parsed and dispatched.
*
* They are not touched until the command completes -- so may be read while
* the command is being parsed and executed.
*/
const char* buf ;
struct cmd_parsed* parsed ;
unsigned lineno ;
bool output_enabled ;
bool reflect_enabled ;
bool more_enabled ;
bool reflected ;
/*----------------------------------------------------------------------
* The following are used inside vty.c only.
*/
vty_io vio ; /* one vio object per vty */
} ;
/*------------------------------------------------------------------------------
* Can now include this
*/
#include "command.h"
/*------------------------------------------------------------------------------
*
*/
#define VTY_BUFSIZ 512
#define VTY_MAXHIST 51
/* Integrated configuration file. */
#define INTEGRATE_DEFAULT_CONFIG "Quagga.conf"
/* Conversion of "\n" to "\r\n" is done at output time. */
#define VTY_NEWLINE "\n"
#define VTY_NL "\n"
/* For indenting, mostly. */
extern const char vty_spaces_string[] ;
enum { VTY_MAX_SPACES = 40 } ;
#define VTY_SPACES(n) (vty_spaces_string + ((n) < VTY_MAX_SPACES \
? VTY_MAX_SPACES - (n) : 0))
/* Vty read buffer size. */
#define VTY_READ_BUFSIZ 512
/* Directory separator. */
#ifndef DIRECTORY_SEP
#define DIRECTORY_SEP '/'
#endif /* DIRECTORY_SEP */
#ifndef IS_DIRECTORY_SEP
#define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
#endif
/* GCC have printf type attribute check. */
#ifdef __GNUC__
#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
#else
#define PRINTF_ATTRIBUTE(a,b)
#endif /* __GNUC__ */
/* Utility macros to convert VTY argument to unsigned long or integer. */
#define VTY_GET_LONG(NAME,V,STR) \
do { \
char *endptr = NULL; \
(V) = strtoul ((STR), &endptr, 10); \
if (*endptr != '\0' || (V) == ULONG_MAX) \
{ \
vty_out (vty, "%% Invalid %s value%s", NAME, VTY_NEWLINE); \
return CMD_WARNING; \
} \
} while (0)
#define VTY_GET_INTEGER_RANGE(NAME,V,STR,MIN,MAX) \
do { \
unsigned long tmpl; \
VTY_GET_LONG(NAME, tmpl, STR); \
if ( (tmpl < (MIN)) || (tmpl > (MAX))) \
{ \
vty_out (vty, "%% Invalid %s value%s", NAME, VTY_NEWLINE); \
return CMD_WARNING; \
} \
(V) = tmpl; \
} while (0)
#define VTY_GET_INTEGER(NAME,V,STR) \
VTY_GET_INTEGER_RANGE(NAME,V,STR,0U,UINT32_MAX)
#define VTY_GET_IPV4_ADDRESS(NAME,V,STR) \
do { \
int retv; \
retv = inet_aton ((STR), &(V)); \
if (!retv) \
{ \
vty_out (vty, "%% Invalid %s value%s", NAME, VTY_NEWLINE); \
return CMD_WARNING; \
} \
} while (0)
#define VTY_GET_IPV4_PREFIX(NAME,V,STR) \
do { \
int retv; \
retv = str2prefix_ipv4 ((STR), &(V)); \
if (retv <= 0) \
{ \
vty_out (vty, "%% Invalid %s value%s", NAME, VTY_NEWLINE); \
return CMD_WARNING; \
} \
} while (0)
/*------------------------------------------------------------------------------
* Exported variables
*/
extern char integrate_default[];
/*------------------------------------------------------------------------------
* Prototypes.
*/
extern void vty_init (struct thread_master *);
extern void vty_init_r (qpn_nexus, qpn_nexus);
extern void vty_start(const char *addr, unsigned short port, const char *path) ;
#define vty_serv_sock(addr, port, path) vty_start(addr, port, path)
extern void vty_restart(const char *addr, unsigned short port,
const char *path) ;
extern struct vty* vty_open(enum vty_type type) ;
extern void vty_close_final(struct vty *);
extern void vty_init_vtysh (void);
extern void vty_terminate (void);
extern void vty_reset (void);
extern void vty_reset_because(const char* why) ;
extern int vty_out (struct vty *, const char *, ...) PRINTF_ATTRIBUTE(2, 3);
extern int vty_out_indent(struct vty *vty, int indent) ;
extern int vty_out_error (struct vty *vty, const char *format, ...)
PRINTF_ATTRIBUTE(2, 3);
extern void vty_out_clear(struct vty *vty) ;
extern void vty_read_config (char *config_file, char *config_default);
extern void vty_read_config_first_cmd_special(
char *config_file, char *config_default,
struct cmd_element* first_cmd, bool ignore_warnings) ;
extern void vty_time_print (struct vty *, int);
extern char *vty_get_cwd (void);
extern void vty_hello (struct vty *);
extern enum node_type vty_get_node(struct vty *);
extern void vty_set_node(struct vty *, enum node_type);
extern void vty_set_lines(struct vty *, int);
#endif /* _ZEBRA_VTY_H */
|
