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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
/*
* Copyright (c) 2015 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* init.h: mechanism for functions to be called at init/exit.
*
* Copyright (c) 2008 Eliot Dresselhaus
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef included_vlib_init_h
#define included_vlib_init_h
#include <vppinfra/error.h>
#include <vppinfra/format.h>
#include <vppinfra/hash.h>
/* Init/exit functions: called at start/end of main routine. Init
functions are typically used to register and setup packet
processing nodes. */
typedef clib_error_t *(vlib_init_function_t) (struct vlib_main_t * vm);
typedef struct _vlib_init_function_list_elt
{
struct _vlib_init_function_list_elt *next_init_function;
vlib_init_function_t *f;
} _vlib_init_function_list_elt_t;
/* Configuration functions: called with configuration input just before
main polling loop starts. */
typedef clib_error_t *(vlib_config_function_t) (struct vlib_main_t * vm,
unformat_input_t * input);
typedef struct vlib_config_function_runtime_t
{
/* Function to call. Set to null once function has already been called. */
vlib_config_function_t *function;
/* Input for function. */
unformat_input_t input;
/* next config function registration */
struct vlib_config_function_runtime_t *next_registration;
/* To be invoked as soon as the clib heap is available */
u8 is_early;
/* Name used to distinguish input on command line. */
char name[32];
} vlib_config_function_runtime_t;
#define VLIB_REMOVE_FROM_LINKED_LIST(first,p,next) \
{ \
if (first == p) \
first = (p)->next; \
else \
{ \
__typeof__ (p) current = first; \
while (current->next) \
{ \
if (current->next == p) \
{ \
current->next = current->next->next; \
break; \
} \
current = current->next; \
} \
} \
}
#define _VLIB_INIT_FUNCTION_SYMBOL(x, type) \
_vlib_##type##_function_##x
#define VLIB_INIT_FUNCTION_SYMBOL(x) \
_VLIB_INIT_FUNCTION_SYMBOL(x, init)
#define VLIB_MAIN_LOOP_ENTER_FUNCTION_SYMBOL(x) \
_VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_enter)
#define VLIB_MAIN_LOOP_EXIT_FUNCTION_SYMBOL(x) \
_VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_exit)
#define VLIB_CONFIG_FUNCTION_SYMBOL(x) \
_VLIB_INIT_FUNCTION_SYMBOL(x, config)
/* Declaration is global (e.g. not static) so that init functions can
be called from other modules to resolve init function depend. */
#define VLIB_DECLARE_INIT_FUNCTION(x, tag) \
vlib_init_function_t * _VLIB_INIT_FUNCTION_SYMBOL (x, tag) = x; \
static void __vlib_add_##tag##_function_##x (void) \
__attribute__((__constructor__)) ; \
static void __vlib_add_##tag##_function_##x (void) \
{ \
vlib_main_t * vm = vlib_get_main(); \
static _vlib_init_function_list_elt_t _vlib_init_function; \
_vlib_init_function.next_init_function \
= vm->tag##_function_registrations; \
vm->tag##_function_registrations = &_vlib_init_function; \
_vlib_init_function.f = &x; \
} \
static void __vlib_rm_##tag##_function_##x (void) \
__attribute__((__destructor__)) ; \
static void __vlib_rm_##tag##_function_##x (void) \
{ \
vlib_main_t * vm = vlib_get_main(); \
_vlib_init_function_list_elt_t *next; \
if (vm->tag##_function_registrations->f == &x) \
{ \
vm->tag##_function_registrations = \
vm->tag##_function_registrations->next_init_function; \
return; \
} \
next = vm->tag##_function_registrations; \
while (next->next_init_function) \
{ \
if (next->next_init_function->f == &x) \
{ \
next->next_init_function = \
next->next_init_function->next_init_function; \
return; \
} \
next = next->next_init_function; \
} \
}
#define VLIB_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,init)
#define VLIB_WORKER_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,worker_init)
#define VLIB_MAIN_LOOP_ENTER_FUNCTION(x) \
VLIB_DECLARE_INIT_FUNCTION(x,main_loop_enter)
#define VLIB_MAIN_LOOP_EXIT_FUNCTION(x) \
VLIB_DECLARE_INIT_FUNCTION(x,main_loop_exit)
#define VLIB_CONFIG_FUNCTION(x,n,...) \
__VA_ARGS__ vlib_config_function_runtime_t \
VLIB_CONFIG_FUNCTION_SYMBOL(x); \
static void __vlib_add_config_function_##x (void) \
__attribute__((__constructor__)) ; \
static void __vlib_add_config_function_##x (void) \
{ \
vlib_main_t * vm = vlib_get_main(); \
VLIB_CONFIG_FUNCTION_SYMBOL(x).next_registration \
= vm->config_function_registrations; \
vm->config_function_registrations \
= &VLIB_CONFIG_FUNCTION_SYMBOL(x); \
} \
static void __vlib_rm_config_function_##x (void) \
__attribute__((__destructor__)) ; \
static void __vlib_rm_config_function_##x (void) \
{ \
vlib_main_t * vm = vlib_get_main(); \
vlib_config_function_runtime_t *p = \
& VLIB_CONFIG_FUNCTION_SYMBOL (x); \
VLIB_REMOVE_FROM_LINKED_LIST \
(vm->config_function_registrations, p, next_registration);\
} \
vlib_config_function_runtime_t \
VLIB_CONFIG_FUNCTION_SYMBOL (x) \
= { \
.name = n, \
.function = x, \
.is_early = 0, \
}
#define VLIB_EARLY_CONFIG_FUNCTION(x,n,...) \
__VA_ARGS__ vlib_config_function_runtime_t \
VLIB_CONFIG_FUNCTION_SYMBOL(x); \
static void __vlib_add_config_function_##x (void) \
__attribute__((__constructor__)) ; \
static void __vlib_add_config_function_##x (void) \
{ \
vlib_main_t * vm = vlib_get_main(); \
VLIB_CONFIG_FUNCTION_SYMBOL(x).next_registration \
= vm->config_function_registrations; \
vm->config_function_registrations \
= &VLIB_CONFIG_FUNCTION_SYMBOL(x); \
} \
static void __vlib_rm_config_function_##x (void) \
__attribute__((__destructor__)) ; \
static void __vlib_rm_config_function_##x (void) \
{ \
vlib_main_t * vm = vlib_get_main(); \
vlib_config_function_runtime_t *p = \
& VLIB_CONFIG_FUNCTION_SYMBOL (x); \
VLIB_REMOVE_FROM_LINKED_LIST \
(vm->config_function_registrations, p, next_registration);\
} \
vlib_config_function_runtime_t \
VLIB_CONFIG_FUNCTION_SYMBOL (x) \
= { \
.name = n, \
.function = x, \
.is_early = 1, \
}
/* Call given init function: used for init function dependencies. */
#define vlib_call_init_function(vm, x) \
({ \
extern vlib_init_function_t * VLIB_INIT_FUNCTION_SYMBOL (x); \
vlib_init_function_t * _f = VLIB_INIT_FUNCTION_SYMBOL (x); \
clib_error_t * _error = 0; \
if (! hash_get (vm->init_functions_called, _f)) \
{ \
hash_set1 (vm->init_functions_called, _f); \
_error = _f (vm); \
} \
_error; \
})
/* Don't call given init function: used to suppress parts of the netstack */
#define vlib_mark_init_function_complete(vm, x) \
({ \
extern vlib_init_function_t * VLIB_INIT_FUNCTION_SYMBOL (x); \
vlib_init_function_t * _f = VLIB_INIT_FUNCTION_SYMBOL (x); \
hash_set1 (vm->init_functions_called, _f); \
})
#define vlib_call_post_graph_init_function(vm, x) \
({ \
extern vlib_init_function_t * VLIB_POST_GRAPH_INIT_FUNCTION_SYMBOL (x); \
vlib_init_function_t * _f = VLIB_POST_GRAPH_INIT_FUNCTION_SYMBOL (x); \
clib_error_t * _error = 0; \
if (! hash_get (vm->init_functions_called, _f)) \
{ \
hash_set1 (vm->init_functions_called, _f); \
_error = _f (vm); \
} \
_error; \
})
#define vlib_call_config_function(vm, x) \
({ \
vlib_config_function_runtime_t * _r; \
clib_error_t * _error = 0; \
extern vlib_config_function_runtime_t \
VLIB_CONFIG_FUNCTION_SYMBOL (x); \
\
_r = &VLIB_CONFIG_FUNCTION_SYMBOL (x); \
if (! hash_get (vm->init_functions_called, _r->function)) \
{ \
hash_set1 (vm->init_functions_called, _r->function); \
_error = _r->function (vm, &_r->input); \
} \
_error; \
})
/* External functions. */
clib_error_t *vlib_call_all_init_functions (struct vlib_main_t *vm);
clib_error_t *vlib_call_all_config_functions (struct vlib_main_t *vm,
unformat_input_t * input,
int is_early);
clib_error_t *vlib_call_all_main_loop_enter_functions (struct vlib_main_t
*vm);
clib_error_t *vlib_call_all_main_loop_exit_functions (struct vlib_main_t *vm);
clib_error_t *vlib_call_init_exit_functions (struct vlib_main_t *vm,
_vlib_init_function_list_elt_t *
head, int call_once);
#define foreach_vlib_module_reference \
_ (node_cli) \
_ (trace_cli)
/* Dummy function to get node_cli.c linked in. */
#define _(x) void vlib_##x##_reference (void);
foreach_vlib_module_reference
#undef _
#endif /* included_vlib_init_h */
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
