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/callback_data.h>
44 #include <vppinfra/elog.h>
45 #include <vppinfra/format.h>
46 #include <vppinfra/longjmp.h>
47 #include <vppinfra/pool.h>
48 #include <vppinfra/random_buffer.h>
49 #include <vppinfra/time.h>
54 /* By default turn off node/error event logging.
55 Override with -DVLIB_ELOG_MAIN_LOOP */
56 #ifndef VLIB_ELOG_MAIN_LOOP
57 #define VLIB_ELOG_MAIN_LOOP 0
62 u8 trace_filter_enable;
63 u32 classify_table_index;
64 } vlib_trace_filter_t;
68 VLIB_NODE_RUNTIME_PERF_BEFORE,
69 VLIB_NODE_RUNTIME_PERF_AFTER,
70 VLIB_NODE_RUNTIME_PERF_RESET,
71 } vlib_node_runtime_perf_call_type_t;
75 struct vlib_main_t *vm;
76 vlib_node_runtime_t *node;
80 vlib_node_runtime_perf_call_type_t call_type;
81 } vlib_node_runtime_perf_callback_args_t;
83 struct vlib_node_runtime_perf_callback_data_t;
85 typedef void (*vlib_node_runtime_perf_callback_fp_t)
86 (struct vlib_node_runtime_perf_callback_data_t * data,
87 vlib_node_runtime_perf_callback_args_t * args);
89 typedef struct vlib_node_runtime_perf_callback_data_t
91 vlib_node_runtime_perf_callback_fp_t fp;
97 } vlib_node_runtime_perf_callback_data_t;
99 clib_callback_data_typedef (vlib_node_runtime_perf_callback_set_t,
100 vlib_node_runtime_perf_callback_data_t);
102 typedef struct vlib_main_t
104 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
105 /* Instruction level timing state. */
106 clib_time_t clib_time;
107 /* Offset from main thread time */
109 f64 time_last_barrier_release;
111 /* Time stamp of last node dispatch. */
112 u64 cpu_time_last_node_dispatch;
114 /* Time stamp when main loop was entered (time 0). */
115 u64 cpu_time_main_loop_start;
117 /* Incremented once for each main loop. */
118 volatile u32 main_loop_count;
120 /* Count of vectors processed this main loop. */
121 u32 main_loop_vectors_processed;
122 u32 main_loop_nodes_processed;
124 /* Internal node vectors, calls */
125 u64 internal_node_vectors;
126 u64 internal_node_calls;
127 u64 internal_node_vectors_last_clear;
128 u64 internal_node_calls_last_clear;
130 /* Instantaneous vector rate */
131 u32 internal_node_last_vectors_per_main_loop;
133 /* Main loop hw / sw performance counters */
134 vlib_node_runtime_perf_callback_set_t vlib_node_runtime_perf_callbacks;
136 /* dispatch wrapper function */
137 vlib_node_function_t *dispatch_wrapper_fn;
139 /* Every so often we switch to the next counter. */
140 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
142 /* Jump target to exit main loop with given code. */
143 u32 main_loop_exit_set;
144 /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
145 volatile u32 main_loop_exit_now;
146 clib_longjmp_t main_loop_exit;
147 #define VLIB_MAIN_LOOP_EXIT_NONE 0
148 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
150 #define VLIB_MAIN_LOOP_EXIT_CLI 2
152 /* Error marker to use when exiting main loop. */
153 clib_error_t *main_loop_error;
155 /* Name for e.g. syslog. */
158 /* Start of the heap. */
161 /* Truncated version, to create frame indices */
162 void *heap_aligned_base;
164 /* Size of the heap */
167 /* buffer main structure. */
168 vlib_buffer_main_t *buffer_main;
170 /* physical memory main structure. */
171 vlib_physmem_main_t physmem_main;
173 /* Node graph main structure. */
174 vlib_node_main_t node_main;
176 /* Command line interface. */
177 vlib_cli_main_t cli_main;
179 /* Packet trace buffer. */
180 vlib_trace_main_t trace_main;
182 /* Packet trace capture filter */
183 vlib_trace_filter_t trace_filter;
185 /* Error handling. */
186 vlib_error_main_t error_main;
188 /* Punt packets to underlying operating system for when fast switching
189 code does not know what to do. */
190 void (*os_punt_frame) (struct vlib_main_t * vm,
191 struct vlib_node_runtime_t * node,
192 vlib_frame_t * frame);
194 /* Stream index to use for distribution when MC is enabled. */
197 vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
200 elog_main_t elog_main;
201 u32 configured_elog_ring_size;
203 /* Event logger trace flags */
204 int elog_trace_api_messages;
205 int elog_trace_cli_commands;
206 int elog_trace_graph_dispatch;
207 int elog_trace_graph_circuit;
208 u32 elog_trace_graph_circuit_node_index;
210 /* Node call and return event types. */
211 elog_event_type_t *node_call_elog_event_types;
212 elog_event_type_t *node_return_elog_event_types;
214 elog_event_type_t *error_elog_event_types;
216 /* Seed for random number generator. */
219 /* Buffer of random data for various uses. */
220 clib_random_buffer_t random_buffer;
222 /* Hash table to record which init functions have been called. */
223 uword *init_functions_called;
225 /* thread, cpu and numa_node indices */
230 /* List of init functions to call, setup by constructors */
231 _vlib_init_function_list_elt_t *init_function_registrations;
232 _vlib_init_function_list_elt_t *worker_init_function_registrations;
233 _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
234 _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
235 _vlib_init_function_list_elt_t *api_init_function_registrations;
236 vlib_config_function_runtime_t *config_function_registrations;
238 /* control-plane API queue signal pending, length indication */
239 volatile u32 queue_signal_pending;
240 volatile u32 api_queue_nonempty;
241 void (*queue_signal_callback) (struct vlib_main_t *);
244 /* Top of (worker) dispatch loop callback */
245 void (**volatile worker_thread_main_loop_callbacks)
246 (struct vlib_main_t *, u64 t);
247 void (**volatile worker_thread_main_loop_callback_tmp)
248 (struct vlib_main_t *, u64 t);
249 clib_spinlock_t worker_thread_main_loop_callback_lock;
252 volatile int parked_at_barrier;
254 /* post-mortem callbacks */
255 void (**post_mortem_callbacks) (void);
258 * Need to call vlib_worker_thread_node_runtime_update before
259 * releasing worker thread barrier. Only valid in vlib_global_main.
261 int need_vlib_worker_thread_node_runtime_update;
263 /* Dispatch loop time accounting */
264 u64 loops_this_reporting_interval;
265 f64 loop_interval_end;
266 f64 loop_interval_start;
267 f64 loops_per_second;
268 f64 seconds_per_loop;
269 f64 damping_constant;
272 * Barrier epoch - Set to current time, each time barrier_sync or
273 * barrier_release is called with zero recursion.
277 /* Earliest barrier can be closed again */
278 f64 barrier_no_close_before;
280 /* Barrier counter callback */
281 void (**volatile barrier_perf_callbacks)
282 (struct vlib_main_t *, u64 t, int leave);
283 void (**volatile barrier_perf_callbacks_tmp)
284 (struct vlib_main_t *, u64 t, int leave);
286 /* Need to check the frame queues */
287 volatile uword check_frame_queues;
289 /* RPC requests, main thread only */
290 uword *pending_rpc_requests;
291 uword *processing_rpc_requests;
292 clib_spinlock_t pending_rpc_lock;
294 /* buffer fault injector */
295 u32 buffer_alloc_success_seed;
296 f64 buffer_alloc_success_rate;
298 #ifdef CLIB_SANITIZE_ADDR
299 /* address sanitizer stack save */
300 void *asan_stack_save;
304 /* Global main structure. */
305 extern vlib_main_t vlib_global_main;
307 void vlib_worker_loop (vlib_main_t * vm);
310 vlib_time_now (vlib_main_t * vm)
313 extern __thread uword __os_thread_index;
316 * Make sure folks don't pass &vlib_global_main from a worker thread.
318 ASSERT (vm->thread_index == __os_thread_index);
319 return clib_time_now (&vm->clib_time) + vm->time_offset;
323 vlib_time_now_ticks (vlib_main_t * vm, u64 n)
325 return clib_time_now_internal (&vm->clib_time, n);
328 /* Busy wait for specified time. */
330 vlib_time_wait (vlib_main_t * vm, f64 wait)
332 f64 t = vlib_time_now (vm);
333 f64 limit = t + wait;
335 t = vlib_time_now (vm);
338 /* Time a piece of code. */
339 #define vlib_time_code(vm,body) \
342 _t[0] = vlib_time_now (vm); \
343 do { body; } while (0); \
344 _t[1] = vlib_time_now (vm); \
345 clib_warning ("%.7e", _t[1] - _t[0]); \
348 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
350 uword __vlib_wait_with_timeout = 0; \
351 f64 __vlib_wait_time = 0; \
352 while (! (__vlib_wait_with_timeout = (test)) \
353 && __vlib_wait_time < (timeout_time)) \
355 vlib_process_suspend (vm, suspend_time); \
356 __vlib_wait_time += suspend_time; \
358 __vlib_wait_with_timeout; \
362 vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
364 vm->main_loop_error = error;
365 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
368 #define vlib_panic_with_msg(vm,args...) \
369 vlib_panic_with_error (vm, clib_error_return (0, args))
372 vlib_panic (vlib_main_t * vm)
374 vlib_panic_with_error (vm, 0);
379 vlib_internal_node_vector_rate (vlib_main_t * vm)
384 calls = vm->internal_node_calls - vm->internal_node_calls_last_clear;
386 if (PREDICT_FALSE (calls == 0))
389 vectors = vm->internal_node_vectors - vm->internal_node_vectors_last_clear;
391 return (f64) vectors / (f64) calls;
395 vlib_clear_internal_node_vector_rate (vlib_main_t * vm)
397 vm->internal_node_calls_last_clear = vm->internal_node_calls;
398 vm->internal_node_vectors_last_clear = vm->internal_node_vectors;
402 vlib_increment_main_loop_counter (vlib_main_t * vm)
404 vm->main_loop_count++;
405 vm->internal_node_last_vectors_per_main_loop = 0;
407 if (PREDICT_FALSE (vm->main_loop_exit_now))
408 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
412 vlib_last_vectors_per_main_loop (vlib_main_t * vm)
414 return vm->internal_node_last_vectors_per_main_loop;
418 vlib_node_runtime_perf_counter (vlib_main_t * vm, vlib_node_runtime_t * node,
419 vlib_frame_t * frame, uword n, u64 t,
420 vlib_node_runtime_perf_call_type_t call_type)
422 vlib_node_runtime_perf_callback_data_t *v =
423 clib_callback_data_check_and_get (&vm->vlib_node_runtime_perf_callbacks);
426 vlib_node_runtime_perf_callback_args_t args = {
432 .call_type = call_type,
434 clib_callback_data_call_vec (v, &args);
438 always_inline void vlib_set_queue_signal_callback
439 (vlib_main_t * vm, void (*fp) (vlib_main_t *))
441 vm->queue_signal_callback = fp;
445 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
447 /* Thread stacks, for os_get_thread_index */
448 extern u8 **vlib_thread_stacks;
450 /* Number of thread stacks that the application needs */
451 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
453 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
454 void vlib_add_del_post_mortem_callback (void *cb, int is_add);
456 vlib_main_t *vlib_get_main_not_inline (void);
457 elog_main_t *vlib_get_elog_main_not_inline ();
459 #endif /* included_vlib_main_h */
462 * fd.io coding-style-patch-verification: ON
465 * eval: (c-set-style "gnu")