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 * main.h: VLIB main data structure
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_main_h
41 #define included_vlib_main_h
43 #include <vppinfra/elog.h>
44 #include <vppinfra/format.h>
45 #include <vppinfra/longjmp.h>
46 #include <vppinfra/pool.h>
47 #include <vppinfra/random_buffer.h>
48 #include <vppinfra/time.h>
53 /* By default turn off node/error event logging.
54 Override with -DVLIB_ELOG_MAIN_LOOP */
55 #ifndef VLIB_ELOG_MAIN_LOOP
56 #define VLIB_ELOG_MAIN_LOOP 0
59 typedef struct vlib_main_t
61 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
62 /* Instruction level timing state. */
63 clib_time_t clib_time;
65 /* Time stamp of last node dispatch. */
66 u64 cpu_time_last_node_dispatch;
68 /* Time stamp when main loop was entered (time 0). */
69 u64 cpu_time_main_loop_start;
71 /* Incremented once for each main loop. */
74 /* Count of vectors processed this main loop. */
75 u32 main_loop_vectors_processed;
76 u32 main_loop_nodes_processed;
78 /* Circular buffer of input node vector counts.
79 Indexed by low bits of
80 (main_loop_count >> VLIB_LOG2_INPUT_VECTORS_PER_MAIN_LOOP). */
81 u32 vector_counts_per_main_loop[2];
82 u32 node_counts_per_main_loop[2];
84 /* Every so often we switch to the next counter. */
85 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
87 /* Jump target to exit main loop with given code. */
88 u32 main_loop_exit_set;
89 /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
90 volatile u32 main_loop_exit_now;
91 clib_longjmp_t main_loop_exit;
92 #define VLIB_MAIN_LOOP_EXIT_NONE 0
93 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
95 #define VLIB_MAIN_LOOP_EXIT_CLI 2
97 /* Error marker to use when exiting main loop. */
98 clib_error_t *main_loop_error;
100 /* Name for e.g. syslog. */
103 /* Start of the heap. */
106 /* Truncated version, to create frame indices */
107 void *heap_aligned_base;
109 /* Size of the heap */
112 /* Pool of buffer free lists. */
113 vlib_buffer_free_list_t *buffer_free_list_pool;
115 /* Allocate/free buffer memory for DMA transfers, descriptor rings, etc.
116 buffer memory is guaranteed to be cache-aligned. */
118 clib_error_t *(*os_physmem_region_alloc) (struct vlib_main_t * vm,
119 char *name, u32 size,
120 u8 numa_node, u32 flags,
121 vlib_physmem_region_index_t *
124 void (*os_physmem_region_free) (struct vlib_main_t * vm,
125 vlib_physmem_region_index_t idx);
127 void *(*os_physmem_alloc_aligned) (struct vlib_main_t * vm,
128 vlib_physmem_region_index_t idx,
129 uword n_bytes, uword alignment);
130 void (*os_physmem_free) (struct vlib_main_t * vm,
131 vlib_physmem_region_index_t idx, void *x);
133 /* Node graph main structure. */
134 vlib_node_main_t node_main;
136 /* Command line interface. */
137 vlib_cli_main_t cli_main;
139 /* Packet trace buffer. */
140 vlib_trace_main_t trace_main;
142 /* Error handling. */
143 vlib_error_main_t error_main;
145 /* Punt packets to underlying operating system for when fast switching
146 code does not know what to do. */
147 void (*os_punt_frame) (struct vlib_main_t * vm,
148 struct vlib_node_runtime_t * node,
149 vlib_frame_t * frame);
151 /* Multicast distribution. Set to zero for MC disabled. */
154 /* Stream index to use for distribution when MC is enabled. */
157 vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
160 elog_main_t elog_main;
162 /* Node call and return event types. */
163 elog_event_type_t *node_call_elog_event_types;
164 elog_event_type_t *node_return_elog_event_types;
166 elog_event_type_t *error_elog_event_types;
168 /* Seed for random number generator. */
171 /* Buffer of random data for various uses. */
172 clib_random_buffer_t random_buffer;
174 /* Hash table to record which init functions have been called. */
175 uword *init_functions_called;
177 /* to compare with node runtime */
180 /* List of init functions to call, setup by constructors */
181 _vlib_init_function_list_elt_t *init_function_registrations;
182 _vlib_init_function_list_elt_t *worker_init_function_registrations;
183 _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
184 _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
185 _vlib_init_function_list_elt_t *api_init_function_registrations;
186 vlib_config_function_runtime_t *config_function_registrations;
187 mc_serialize_msg_t *mc_msg_registrations; /* mc_main is a pointer... */
189 /* control-plane API queue signal pending, length indication */
190 volatile u32 queue_signal_pending;
191 volatile u32 api_queue_nonempty;
192 void (*queue_signal_callback) (struct vlib_main_t *);
196 volatile int parked_at_barrier;
198 /* Attempt to do a post-mortem elog dump */
199 int elog_post_mortem_dump;
202 * Need to call vlib_worker_thread_node_runtime_update before
203 * releasing worker thread barrier. Only valid in vlib_global_main.
205 int need_vlib_worker_thread_node_runtime_update;
208 * Barrier epoch - Set to current time, each time barrier_sync or
209 * barrier_release is called with zero recursion.
213 /* Earliest barrier can be closed again */
214 f64 barrier_no_close_before;
216 /* Vector of pending RPC requests */
217 uword *pending_rpc_requests;
221 /* Global main structure. */
222 extern vlib_main_t vlib_global_main;
224 void vlib_worker_loop (vlib_main_t * vm);
227 vlib_time_now (vlib_main_t * vm)
229 return clib_time_now (&vm->clib_time);
233 vlib_time_now_ticks (vlib_main_t * vm, u64 n)
235 return clib_time_now_internal (&vm->clib_time, n);
238 /* Busy wait for specified time. */
240 vlib_time_wait (vlib_main_t * vm, f64 wait)
242 f64 t = vlib_time_now (vm);
243 f64 limit = t + wait;
245 t = vlib_time_now (vm);
248 /* Time a piece of code. */
249 #define vlib_time_code(vm,body) \
252 _t[0] = vlib_time_now (vm); \
253 do { body; } while (0); \
254 _t[1] = vlib_time_now (vm); \
255 clib_warning ("%.7e", _t[1] - _t[0]); \
258 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
260 uword __vlib_wait_with_timeout = 0; \
261 f64 __vlib_wait_time = 0; \
262 while (! (__vlib_wait_with_timeout = (test)) \
263 && __vlib_wait_time < (timeout_time)) \
265 vlib_process_suspend (vm, suspend_time); \
266 __vlib_wait_time += suspend_time; \
268 __vlib_wait_with_timeout; \
272 vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
274 vm->main_loop_error = error;
275 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
278 #define vlib_panic_with_msg(vm,args...) \
279 vlib_panic_with_error (vm, clib_error_return (0, args))
282 vlib_panic (vlib_main_t * vm)
284 vlib_panic_with_error (vm, 0);
288 vlib_vector_input_stats_index (vlib_main_t * vm, word delta)
291 i = vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
292 ASSERT (is_pow2 (ARRAY_LEN (vm->vector_counts_per_main_loop)));
293 return (i + delta) & (ARRAY_LEN (vm->vector_counts_per_main_loop) - 1);
296 /* Estimate input rate based on previous
297 2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
300 vlib_last_vectors_per_main_loop (vlib_main_t * vm)
302 u32 i = vlib_vector_input_stats_index (vm, -1);
303 u32 n = vm->vector_counts_per_main_loop[i];
304 return n >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
307 /* Total ave vector count per iteration of main loop. */
309 vlib_last_vectors_per_main_loop_as_f64 (vlib_main_t * vm)
311 u32 i = vlib_vector_input_stats_index (vm, -1);
312 u32 v = vm->vector_counts_per_main_loop[i];
313 return (f64) v / (f64) (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
316 /* Total ave vectors/node count per iteration of main loop. */
318 vlib_last_vector_length_per_node (vlib_main_t * vm)
320 u32 i = vlib_vector_input_stats_index (vm, -1);
321 u32 v = vm->vector_counts_per_main_loop[i];
322 u32 n = vm->node_counts_per_main_loop[i];
323 return n == 0 ? 0 : (f64) v / (f64) n;
329 vlib_increment_main_loop_counter (vlib_main_t * vm)
331 u32 i, c, n, v, is_wrap;
333 c = vm->main_loop_count++;
335 is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
340 i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
342 v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
343 n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
345 v += vm->main_loop_vectors_processed;
346 n += vm->main_loop_nodes_processed;
347 vm->main_loop_vectors_processed = 0;
348 vm->main_loop_nodes_processed = 0;
349 vm->vector_counts_per_main_loop[i] = v;
350 vm->node_counts_per_main_loop[i] = n;
352 if (PREDICT_FALSE (vm->main_loop_exit_now))
353 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
356 always_inline void vlib_set_queue_signal_callback
357 (vlib_main_t * vm, void (*fp) (vlib_main_t *))
359 vm->queue_signal_callback = fp;
363 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
365 /* Thread stacks, for os_get_thread_index */
366 extern u8 **vlib_thread_stacks;
368 /* Number of thread stacks that the application needs */
369 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
371 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
373 #endif /* included_vlib_main_h */
376 * fd.io coding-style-patch-verification: ON
379 * eval: (c-set-style "gnu")