FD.io VPP  v21.06
Vector Packet Processing
init.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * init.h: mechanism for functions to be called at init/exit.
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #ifndef included_vlib_init_h
41 #define included_vlib_init_h
42 
43 #include <vppinfra/error.h>
44 #include <vppinfra/format.h>
45 #include <vppinfra/hash.h>
46 
47 /* Init/exit functions: called at start/end of main routine. Init
48  functions are typically used to register and setup packet
49  processing nodes. */
50 
51 typedef clib_error_t *(vlib_init_function_t) (struct vlib_main_t * vm);
52 
53 typedef struct _vlib_init_function_list_elt
54 {
55  struct _vlib_init_function_list_elt *next_init_function;
56  vlib_init_function_t *f;
57  char *name;
58  char **runs_before;
59  char **runs_after;
60  char **init_order;
61 } _vlib_init_function_list_elt_t;
62 
63 /* Configuration functions: called with configuration input just before
64  main polling loop starts. */
65 typedef clib_error_t *(vlib_config_function_t) (struct vlib_main_t * vm,
66  unformat_input_t * input);
67 
68 typedef struct vlib_config_function_runtime_t
69 {
70  /* Function to call. Set to null once function has already been called. */
71  vlib_config_function_t *function;
72 
73  /* Input for function. */
74  unformat_input_t input;
75 
76  /* next config function registration */
77  struct vlib_config_function_runtime_t *next_registration;
78 
79  /* To be invoked as soon as the clib heap is available */
80  u8 is_early;
81 
82  /* Name used to distinguish input on command line. */
83  char name[32];
84 } vlib_config_function_runtime_t;
85 
86 #define VLIB_REMOVE_FROM_LINKED_LIST(first,p,next) \
87 { \
88  ASSERT (first); \
89  if (first == p) \
90  first = (p)->next; \
91  else \
92  { \
93  __typeof__ (p) current = first; \
94  while (current->next) \
95  { \
96  if (current->next == p) \
97  { \
98  current->next = current->next->next; \
99  break; \
100  } \
101  current = current->next; \
102  } \
103  ASSERT (current); \
104  } \
105 }
106 
107 #define _VLIB_INIT_FUNCTION_SYMBOL(x, type) \
108  _vlib_##type##_function_##x
109 
110 #define VLIB_INIT_FUNCTION_SYMBOL(x) \
111  _VLIB_INIT_FUNCTION_SYMBOL(x, init)
112 #define VLIB_MAIN_LOOP_ENTER_FUNCTION_SYMBOL(x) \
113  _VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_enter)
114 #define VLIB_MAIN_LOOP_EXIT_FUNCTION_SYMBOL(x) \
115  _VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_exit)
116 #define VLIB_CONFIG_FUNCTION_SYMBOL(x) \
117  _VLIB_INIT_FUNCTION_SYMBOL(x, config)
118 
119 /* Declaration is global (e.g. not static) so that init functions can
120  be called from other modules to resolve init function depend. */
121 
122 #ifndef CLIB_MARCH_VARIANT
123 #define VLIB_DECLARE_INIT_FUNCTION(x, tag) \
124  vlib_init_function_t *_VLIB_INIT_FUNCTION_SYMBOL (x, tag) = x; \
125  static void __vlib_add_##tag##_function_##x (void) \
126  __attribute__ ((__constructor__)); \
127  static _vlib_init_function_list_elt_t _vlib_init_function_##tag##_##x; \
128  static void __vlib_add_##tag##_function_##x (void) \
129  { \
130  vlib_global_main_t *vgm = vlib_get_global_main (); \
131  _vlib_init_function_##tag##_##x.next_init_function = \
132  vgm->tag##_function_registrations; \
133  vgm->tag##_function_registrations = &_vlib_init_function_##tag##_##x; \
134  _vlib_init_function_##tag##_##x.f = &x; \
135  _vlib_init_function_##tag##_##x.name = #x; \
136  } \
137  static void __vlib_rm_##tag##_function_##x (void) \
138  __attribute__ ((__destructor__)); \
139  static void __vlib_rm_##tag##_function_##x (void) \
140  { \
141  vlib_global_main_t *vgm = vlib_get_global_main (); \
142  _vlib_init_function_list_elt_t *this, *prev; \
143  this = vgm->tag##_function_registrations; \
144  if (this == 0) \
145  return; \
146  if (this->f == &x) \
147  { \
148  vgm->tag##_function_registrations = this->next_init_function; \
149  return; \
150  } \
151  prev = this; \
152  this = this->next_init_function; \
153  while (this) \
154  { \
155  if (this->f == &x) \
156  { \
157  prev->next_init_function = this->next_init_function; \
158  return; \
159  } \
160  prev = this; \
161  this = this->next_init_function; \
162  } \
163  } \
164  static _vlib_init_function_list_elt_t _vlib_init_function_##tag##_##x
165 #else
166 /* create unused pointer to silence compiler warnings and get whole
167  function optimized out */
168 #define VLIB_DECLARE_INIT_FUNCTION(x, tag) \
169 static __clib_unused void * __clib_unused_##tag##_##x = x
170 #endif
171 
172 #define VLIB_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,init)
173 #define VLIB_WORKER_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,worker_init)
174 
175 #define VLIB_MAIN_LOOP_ENTER_FUNCTION(x) \
176  VLIB_DECLARE_INIT_FUNCTION(x,main_loop_enter)
177 #define VLIB_MAIN_LOOP_EXIT_FUNCTION(x) \
178 VLIB_DECLARE_INIT_FUNCTION(x,main_loop_exit)
179 
180 #ifndef CLIB_MARCH_VARIANT
181 #define VLIB_CONFIG_FUNCTION(x, n, ...) \
182  __VA_ARGS__ vlib_config_function_runtime_t VLIB_CONFIG_FUNCTION_SYMBOL (x); \
183  static void __vlib_add_config_function_##x (void) \
184  __attribute__ ((__constructor__)); \
185  static void __vlib_add_config_function_##x (void) \
186  { \
187  vlib_global_main_t *vgm = vlib_get_global_main (); \
188  VLIB_CONFIG_FUNCTION_SYMBOL (x).next_registration = \
189  vgm->config_function_registrations; \
190  vgm->config_function_registrations = &VLIB_CONFIG_FUNCTION_SYMBOL (x); \
191  } \
192  static void __vlib_rm_config_function_##x (void) \
193  __attribute__ ((__destructor__)); \
194  static void __vlib_rm_config_function_##x (void) \
195  { \
196  vlib_global_main_t *vgm = vlib_get_global_main (); \
197  vlib_config_function_runtime_t *p = &VLIB_CONFIG_FUNCTION_SYMBOL (x); \
198  VLIB_REMOVE_FROM_LINKED_LIST (vgm->config_function_registrations, p, \
199  next_registration); \
200  } \
201  vlib_config_function_runtime_t VLIB_CONFIG_FUNCTION_SYMBOL (x) = { \
202  .name = n, \
203  .function = x, \
204  .is_early = 0, \
205  }
206 #else
207 /* create unused pointer to silence compiler warnings and get whole
208  function optimized out */
209 #define VLIB_CONFIG_FUNCTION(x,n,...) \
210  static __clib_unused vlib_config_function_runtime_t \
211  VLIB_CONFIG_FUNCTION_SYMBOL (__clib_unused_##x) \
212  = { \
213  .name = n, \
214  .function = x, \
215  .is_early = 0, \
216  }
217 #endif
218 
219 #ifndef CLIB_MARCH_VARIANT
220 #define VLIB_EARLY_CONFIG_FUNCTION(x, n, ...) \
221  __VA_ARGS__ vlib_config_function_runtime_t VLIB_CONFIG_FUNCTION_SYMBOL (x); \
222  static void __vlib_add_config_function_##x (void) \
223  __attribute__ ((__constructor__)); \
224  static void __vlib_add_config_function_##x (void) \
225  { \
226  vlib_global_main_t *vgm = vlib_get_global_main (); \
227  VLIB_CONFIG_FUNCTION_SYMBOL (x).next_registration = \
228  vgm->config_function_registrations; \
229  vgm->config_function_registrations = &VLIB_CONFIG_FUNCTION_SYMBOL (x); \
230  } \
231  static void __vlib_rm_config_function_##x (void) \
232  __attribute__ ((__destructor__)); \
233  static void __vlib_rm_config_function_##x (void) \
234  { \
235  vlib_global_main_t *vgm = vlib_get_global_main (); \
236  vlib_config_function_runtime_t *p = &VLIB_CONFIG_FUNCTION_SYMBOL (x); \
237  VLIB_REMOVE_FROM_LINKED_LIST (vgm->config_function_registrations, p, \
238  next_registration); \
239  } \
240  vlib_config_function_runtime_t VLIB_CONFIG_FUNCTION_SYMBOL (x) = { \
241  .name = n, \
242  .function = x, \
243  .is_early = 1, \
244  }
245 #else
246 /* create unused pointer to silence compiler warnings and get whole
247  function optimized out */
248 #define VLIB_EARLY_CONFIG_FUNCTION(x,n,...) \
249  static __clib_unused vlib_config_function_runtime_t \
250  VLIB_CONFIG_FUNCTION_SYMBOL (__clib_unused_##x) \
251  = { \
252  .name = n, \
253  .function = x, \
254  .is_early = 1, \
255  }
256 #endif
257 
258 /* Call given init function: used for init function dependencies. */
259 #define vlib_call_init_function(vm, x) \
260  ({ \
261  vlib_global_main_t *vgm = &vlib_global_main; \
262  extern vlib_init_function_t *VLIB_INIT_FUNCTION_SYMBOL (x); \
263  vlib_init_function_t *_f = VLIB_INIT_FUNCTION_SYMBOL (x); \
264  clib_error_t *_error = 0; \
265  if (!hash_get (vgm->init_functions_called, _f)) \
266  { \
267  hash_set1 (vgm->init_functions_called, _f); \
268  _error = _f (vm); \
269  } \
270  _error; \
271  })
272 
273 /* Don't call given init function: used to suppress parts of the netstack */
274 #define vlib_mark_init_function_complete(vm, x) \
275  ({ \
276  vlib_global_main_t *vgm = &vlib_global_main; \
277  extern vlib_init_function_t *VLIB_INIT_FUNCTION_SYMBOL (x); \
278  vlib_init_function_t *_f = VLIB_INIT_FUNCTION_SYMBOL (x); \
279  hash_set1 (vgm->init_functions_called, _f); \
280  })
281 
282 #define vlib_call_post_graph_init_function(vm, x) \
283  ({ \
284  vlib_global_main_t *vgm = &vlib_global_main; \
285  extern vlib_init_function_t *VLIB_POST_GRAPH_INIT_FUNCTION_SYMBOL (x); \
286  vlib_init_function_t *_f = VLIB_POST_GRAPH_INIT_FUNCTION_SYMBOL (x); \
287  clib_error_t *_error = 0; \
288  if (!hash_get (vgm->init_functions_called, _f)) \
289  { \
290  hash_set1 (vgm->init_functions_called, _f); \
291  _error = _f (vm); \
292  } \
293  _error; \
294  })
295 
296 #define vlib_call_config_function(vm, x) \
297  ({ \
298  vlib_global_main_t *vgm = &vlib_global_main; \
299  vlib_config_function_runtime_t *_r; \
300  clib_error_t *_error = 0; \
301  extern vlib_config_function_runtime_t VLIB_CONFIG_FUNCTION_SYMBOL (x); \
302  \
303  _r = &VLIB_CONFIG_FUNCTION_SYMBOL (x); \
304  if (!hash_get (vgm->init_functions_called, _r->function)) \
305  { \
306  hash_set1 (vgm->init_functions_called, _r->function); \
307  _error = _r->function (vm, &_r->input); \
308  } \
309  _error; \
310  })
311 
312 #define vlib_call_main_loop_enter_function(vm, x) \
313  ({ \
314  vlib_global_main_t *vgm = &vlib_global_main; \
315  extern vlib_init_function_t *VLIB_MAIN_LOOP_ENTER_FUNCTION_SYMBOL (x); \
316  vlib_init_function_t *_f = VLIB_MAIN_LOOP_ENTER_FUNCTION_SYMBOL (x); \
317  clib_error_t *_error = 0; \
318  if (!hash_get (vgm->init_functions_called, _f)) \
319  { \
320  hash_set1 (vgm->init_functions_called, _f); \
321  _error = _f (vm); \
322  } \
323  _error; \
324  })
325 
326 /* External functions. */
327 clib_error_t *vlib_call_all_init_functions (struct vlib_main_t *vm);
328 clib_error_t *vlib_call_all_config_functions (struct vlib_main_t *vm,
329  unformat_input_t * input,
330  int is_early);
331 clib_error_t *vlib_call_all_main_loop_enter_functions (struct vlib_main_t
332  *vm);
333 clib_error_t *vlib_call_all_main_loop_exit_functions (struct vlib_main_t *vm);
334 clib_error_t *
335 vlib_call_init_exit_functions (struct vlib_main_t *vm,
336  _vlib_init_function_list_elt_t **headp,
337  int call_once, int is_global);
338 clib_error_t *
339 vlib_call_init_exit_functions_no_sort (struct vlib_main_t *vm,
340  _vlib_init_function_list_elt_t **headp,
341  int call_once, int is_global);
342 clib_error_t *vlib_sort_init_exit_functions (_vlib_init_function_list_elt_t
343  **);
344 #define foreach_vlib_module_reference \
345  _ (node_cli) \
346  _ (trace_cli)
347 
348 /* Dummy function to get node_cli.c linked in. */
349 #define _(x) void vlib_##x##_reference (void);
350 foreach_vlib_module_reference
351 #undef _
352 #define VLIB_INITS(...) (char*[]) { __VA_ARGS__, 0}
353 #endif /* included_vlib_init_h */
354 /*
355  * fd.io coding-style-patch-verification: ON
356  *
357  * Local Variables:
358  * eval: (c-set-style "gnu")
359  * End:
360  */
vlib_call_all_main_loop_exit_functions
clib_error_t * vlib_call_all_main_loop_exit_functions(struct vlib_main_t *vm)
Definition: init.c:414
vlib_call_init_exit_functions_no_sort
clib_error_t * vlib_call_init_exit_functions_no_sort(struct vlib_main_t *vm, _vlib_init_function_list_elt_t **headp, int call_once, int is_global)
Definition: init.c:382
is_global
#define is_global(M)
Definition: dlmalloc.c:1220
vlib_config_function_runtime_t::is_early
u8 is_early
Definition: init.h:80
foreach_vlib_module_reference
#define foreach_vlib_module_reference
Definition: init.h:344
name
string name[64]
Definition: fib.api:25
u8
unsigned char u8
Definition: types.h:56
vlib_call_all_init_functions
clib_error_t * vlib_call_all_init_functions(struct vlib_main_t *vm)
Definition: init.c:391
vlib_config_function_runtime_t::input
unformat_input_t input
Definition: init.h:74
f
vlib_frame_t * f
Definition: interface_output.c:1080
vlib_config_function_runtime_t
Definition: init.h:68
unformat_input_t
struct _unformat_input_t unformat_input_t
vlib_call_init_exit_functions
clib_error_t * vlib_call_init_exit_functions(struct vlib_main_t *vm, _vlib_init_function_list_elt_t **headp, int call_once, int is_global)
Definition: init.c:373
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
vlib_init_function_t
clib_error_t *() vlib_init_function_t(struct vlib_main_t *vm)
Definition: init.h:51
vlib_config_function_runtime_t
struct vlib_config_function_runtime_t vlib_config_function_runtime_t
vlib_call_all_config_functions
clib_error_t * vlib_call_all_config_functions(struct vlib_main_t *vm, unformat_input_t *input, int is_early)
Definition: init.c:423
clib_error_t
Definition: clib_error.h:21
vlib_call_all_main_loop_enter_functions
clib_error_t * vlib_call_all_main_loop_enter_functions(struct vlib_main_t *vm)
Definition: init.c:405
vlib_sort_init_exit_functions
clib_error_t * vlib_sort_init_exit_functions(_vlib_init_function_list_elt_t **)
Topological sorter for init function chains.
Definition: init.c:76
vlib_main_t
Definition: main.h:102
vlib_config_function_t
clib_error_t *() vlib_config_function_t(struct vlib_main_t *vm, unformat_input_t *input)
Definition: init.h:65
vlib_config_function_runtime_t::next_registration
struct vlib_config_function_runtime_t * next_registration
Definition: init.h:77