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
|
/* 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_LOCAL_H
#define _ZEBRA_VTY_LOCAL_H
#include "misc.h"
#include "vty_common.h" /* First and foremost */
#include "command_common.h"
#include "vargs.h"
#include "qpthreads.h"
#include "qpnexus.h"
#include "thread.h"
#include "qpath.h"
/*==============================================================================
* This is for access to some things in vty.c which are not required
* by external users, who use vty.h.
*
* This is for use within the command/vty family.
*
* Should not be used with vty.h ! (Except in vty.c itself.)
*
* This may duplicate things published in vty.h, but also includes things
* which are not intended for "external" use.
*/
/*==============================================================================
* 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
/*==============================================================================
* Variables in vty.c -- used in any of the family
*/
extern struct vty_io* vio_live_list ;
extern struct vty_io* vio_monitor_list ;
extern struct vio_child* vio_childer_list ;
extern struct thread_master* vty_master ;
extern bool vty_nexus ;
extern bool vty_multi_nexus ;
extern qpn_nexus vty_cli_nexus ;
extern qpn_nexus vty_cmd_nexus ;
extern qpt_mutex_t vty_child_signal_mutex ;
extern qpn_nexus vty_child_signal_nexus ;
/*==============================================================================
* To make vty qpthread safe we use a single mutex.
*
* A recursive mutex is used, which allows for the vty internals to call
* each other.
*
* There are some "uty" functions which assume the mutex is locked.
*
* vty is closely bound to the command handling -- the main vty structure
* contains the context in which commands are parsed and executed.
*
* vty also interacts with logging functions. Note that where it needs to
* LOG_LOCK() and VTY_LOCK() it will acquire the VTY_LOCK() *first*.
*/
extern qpt_mutex_t vty_mutex ;
/*------------------------------------------------------------------------------
* Sort out VTY_DEBUG.
*
* Set to 1 if defined, but blank.
* Set to QDEBUG if not defined.
*
* Force to 0 if VTY_NO_DEBUG is defined and not zero.
*
* So: defaults to same as QDEBUG, but no matter what QDEBUG is set to:
*
* * can set VTY_DEBUG == 0 to turn off debug
* * or set VTY_DEBUG != 0 to turn on debug
* * or set VTY_NO_DEBUG != 0 to force debug off
*/
#ifdef VTY_DEBUG /* If defined, make it 1 or 0 */
# if IS_BLANK_OPTION(VTY_DEBUG)
# undef VTY_DEBUG
# define VTY_DEBUG 1
# endif
#else /* If not defined, follow QDEBUG */
# define VTY_DEBUG QDEBUG
#endif
#ifdef VTY_NO_DEBUG /* Override, if defined */
# if IS_NOT_ZERO_OPTION(VTY_NO_DEBUG)
# undef VTY_DEBUG
# define VTY_DEBUG 0
# endif
#endif
enum { vty_debug = VTY_DEBUG } ;
/*------------------------------------------------------------------------------
* Locking and related functions.
*/
extern int vty_lock_count ;
Inline void
VTY_LOCK(void) /* if is qpthreads_enabled, lock vty_mutex */
{
qpt_mutex_lock(vty_mutex) ;
if (vty_debug)
++vty_lock_count ;
} ;
Inline void
VTY_UNLOCK(void) /* if is qpthreads_enabled, unlock vty_mutex */
{
if (vty_debug)
--vty_lock_count ;
qpt_mutex_unlock(vty_mutex) ;
} ;
Inline bool /* true => is (effectively) cli thread */
vty_is_cli_thread(void)
{
return !qpthreads_enabled || qpt_thread_is_self(vty_cli_nexus->thread_id) ;
} ;
Inline bool /* true => running with more than one pthread */
vty_is_multi_pthreaded(void)
{
return !qpthreads_enabled && (vty_cli_nexus != vty_cmd_nexus) ;
} ;
/* For debug (and documentation) purposes, will VTY_ASSERT_LOCKED where that
* is required.
*
* In some cases, need also to be running in the CLI thread as well.
*
* Note that both these checks will pass if !qpthreads_enabled. So can have
* code which is called before qpthreads are started up, or which will never
* run qpthreaded !
*/
extern int vty_assert_fail ;
Inline void
VTY_ASSERT_FAILED(void)
{
if (vty_assert_fail == 0) ;
{
vty_assert_fail = 1 ;
assert(0) ;
} ;
} ;
Inline void
VTY_ASSERT_LOCKED(void)
{
if (vty_debug)
if ((vty_lock_count == 0) && (qpthreads_enabled))
VTY_ASSERT_FAILED() ;
} ;
Inline void
VTY_ASSERT_CLI_THREAD(void)
{
if (vty_debug)
if (!vty_is_cli_thread())
VTY_ASSERT_FAILED() ;
} ;
Inline void
VTY_ASSERT_CLI_THREAD_LOCKED(void)
{
if (vty_debug)
{
VTY_ASSERT_CLI_THREAD() ;
VTY_ASSERT_LOCKED() ;
} ;
} ;
/*==============================================================================
* Functions in vty.c -- used in any of the vty and command family
*/
extern void vty_hello (vty vty);
extern int vty_out (vty vty, const char* format, ...) PRINTF_ATTRIBUTE(2, 3);
extern int vty_write(struct vty *vty, const void* buf, int n) ;
extern int vty_out_indent(vty vty, int indent) ;
extern void vty_out_clear(vty vty) ;
extern cmd_return_code_t vty_cat_file(vty vty, qpath path, const char* desc) ;
extern void vty_time_print (struct vty *, int) ;
extern void vty_set_lines(vty vty, int lines) ;
extern void vty_config_write_open(vty vty, int fd) ;
extern cmd_return_code_t vty_config_write_close(struct vty* vty) ;
#endif /* _ZEBRA_VTY_LOCAL_H */
|
