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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * init.h: mechanism for functions to be called at init/exit.
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vlib_init_h
41 #define included_vlib_init_h
43 #include <vppinfra/error.h>
44 #include <vppinfra/format.h>
45 #include <vppinfra/hash.h>
47 /* Init/exit functions: called at start/end of main routine. Init
48 functions are typically used to register and setup packet
51 typedef clib_error_t *(vlib_init_function_t) (struct vlib_main_t * vm);
53 typedef struct _vlib_init_function_list_elt
55 struct _vlib_init_function_list_elt *next_init_function;
56 vlib_init_function_t *f;
57 } _vlib_init_function_list_elt_t;
59 /* Configuration functions: called with configuration input just before
60 main polling loop starts. */
61 typedef clib_error_t *(vlib_config_function_t) (struct vlib_main_t * vm,
62 unformat_input_t * input);
64 typedef struct vlib_config_function_runtime_t
66 /* Function to call. Set to null once function has already been called. */
67 vlib_config_function_t *function;
69 /* Input for function. */
70 unformat_input_t input;
72 /* next config function registration */
73 struct vlib_config_function_runtime_t *next_registration;
75 /* To be invoked as soon as the clib heap is available */
78 /* Name used to distinguish input on command line. */
80 } vlib_config_function_runtime_t;
82 #define _VLIB_INIT_FUNCTION_SYMBOL(x, type) \
83 _vlib_##type##_function_##x
85 #define VLIB_INIT_FUNCTION_SYMBOL(x) \
86 _VLIB_INIT_FUNCTION_SYMBOL(x, init)
87 #define VLIB_MAIN_LOOP_ENTER_FUNCTION_SYMBOL(x) \
88 _VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_enter)
89 #define VLIB_MAIN_LOOP_EXIT_FUNCTION_SYMBOL(x) \
90 _VLIB_INIT_FUNCTION_SYMBOL(x, main_loop_exit)
91 #define VLIB_CONFIG_FUNCTION_SYMBOL(x) \
92 _VLIB_INIT_FUNCTION_SYMBOL(x, config)
94 /* Declaration is global (e.g. not static) so that init functions can
95 be called from other modules to resolve init function depend. */
97 #define VLIB_DECLARE_INIT_FUNCTION(x, tag) \
98 vlib_init_function_t * _VLIB_INIT_FUNCTION_SYMBOL (x, tag) = x; \
99 static void __vlib_add_##tag##_function_##x (void) \
100 __attribute__((__constructor__)) ; \
101 static void __vlib_add_##tag##_function_##x (void) \
103 vlib_main_t * vm = vlib_get_main(); \
104 static _vlib_init_function_list_elt_t _vlib_init_function; \
105 _vlib_init_function.next_init_function \
106 = vm->tag##_function_registrations; \
107 vm->tag##_function_registrations = &_vlib_init_function; \
108 _vlib_init_function.f = &x; \
111 #define VLIB_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,init)
113 #define VLIB_MAIN_LOOP_ENTER_FUNCTION(x) \
114 VLIB_DECLARE_INIT_FUNCTION(x,main_loop_enter)
115 #define VLIB_MAIN_LOOP_EXIT_FUNCTION(x) \
116 VLIB_DECLARE_INIT_FUNCTION(x,main_loop_exit)
118 #define VLIB_CONFIG_FUNCTION(x,n,...) \
119 __VA_ARGS__ vlib_config_function_runtime_t \
120 VLIB_CONFIG_FUNCTION_SYMBOL(x); \
121 static void __vlib_add_config_function_##x (void) \
122 __attribute__((__constructor__)) ; \
123 static void __vlib_add_config_function_##x (void) \
125 vlib_main_t * vm = vlib_get_main(); \
126 VLIB_CONFIG_FUNCTION_SYMBOL(x).next_registration \
127 = vm->config_function_registrations; \
128 vm->config_function_registrations \
129 = &VLIB_CONFIG_FUNCTION_SYMBOL(x); \
131 vlib_config_function_runtime_t \
132 VLIB_CONFIG_FUNCTION_SYMBOL (x) \
139 #define VLIB_EARLY_CONFIG_FUNCTION(x,n,...) \
140 __VA_ARGS__ vlib_config_function_runtime_t \
141 VLIB_CONFIG_FUNCTION_SYMBOL(x); \
142 static void __vlib_add_config_function_##x (void) \
143 __attribute__((__constructor__)) ; \
144 static void __vlib_add_config_function_##x (void) \
146 vlib_main_t * vm = vlib_get_main(); \
147 VLIB_CONFIG_FUNCTION_SYMBOL(x).next_registration \
148 = vm->config_function_registrations; \
149 vm->config_function_registrations \
150 = &VLIB_CONFIG_FUNCTION_SYMBOL(x); \
152 vlib_config_function_runtime_t \
153 VLIB_CONFIG_FUNCTION_SYMBOL (x) \
160 /* Call given init function: used for init function dependencies. */
161 #define vlib_call_init_function(vm, x) \
163 extern vlib_init_function_t * VLIB_INIT_FUNCTION_SYMBOL (x); \
164 vlib_init_function_t * _f = VLIB_INIT_FUNCTION_SYMBOL (x); \
165 clib_error_t * _error = 0; \
166 if (! hash_get (vm->init_functions_called, _f)) \
168 hash_set1 (vm->init_functions_called, _f); \
174 /* Don't call given init function: used to suppress parts of the netstack */
175 #define vlib_mark_init_function_complete(vm, x) \
177 extern vlib_init_function_t * VLIB_INIT_FUNCTION_SYMBOL (x); \
178 vlib_init_function_t * _f = VLIB_INIT_FUNCTION_SYMBOL (x); \
179 hash_set1 (vm->init_functions_called, _f); \
182 #define vlib_call_post_graph_init_function(vm, x) \
184 extern vlib_init_function_t * VLIB_POST_GRAPH_INIT_FUNCTION_SYMBOL (x); \
185 vlib_init_function_t * _f = VLIB_POST_GRAPH_INIT_FUNCTION_SYMBOL (x); \
186 clib_error_t * _error = 0; \
187 if (! hash_get (vm->init_functions_called, _f)) \
189 hash_set1 (vm->init_functions_called, _f); \
195 #define vlib_call_config_function(vm, x) \
197 vlib_config_function_runtime_t * _r; \
198 clib_error_t * _error = 0; \
199 extern vlib_config_function_runtime_t \
200 VLIB_CONFIG_FUNCTION_SYMBOL (x); \
202 _r = &VLIB_CONFIG_FUNCTION_SYMBOL (x); \
203 if (! hash_get (vm->init_functions_called, _r->function)) \
205 hash_set1 (vm->init_functions_called, _r->function); \
206 _error = _r->function (vm, &_r->input); \
211 /* External functions. */
212 clib_error_t *vlib_call_all_init_functions (struct vlib_main_t *vm);
213 clib_error_t *vlib_call_all_config_functions (struct vlib_main_t *vm,
214 unformat_input_t * input,
216 clib_error_t *vlib_call_all_main_loop_enter_functions (struct vlib_main_t
218 clib_error_t *vlib_call_all_main_loop_exit_functions (struct vlib_main_t *vm);
219 clib_error_t *vlib_call_init_exit_functions (struct vlib_main_t *vm,
220 _vlib_init_function_list_elt_t *
221 head, int call_once);
223 #define foreach_vlib_module_reference \
227 /* Dummy function to get node_cli.c linked in. */
228 #define _(x) void vlib_##x##_reference (void);
229 foreach_vlib_module_reference
231 #endif /* included_vlib_init_h */
233 * fd.io coding-style-patch-verification: ON
236 * eval: (c-set-style "gnu")