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>
50 #include <vppinfra/pmc.h>
51 #include <vppinfra/pcap.h>
56 /* By default turn off node/error event logging.
57 Override with -DVLIB_ELOG_MAIN_LOOP */
58 #ifndef VLIB_ELOG_MAIN_LOOP
59 #define VLIB_ELOG_MAIN_LOOP 0
71 u32 max_bytes_per_pkt;
73 pcap_main_t pcap_main;
74 u32 filter_classify_table_index;
79 u8 trace_filter_enable;
80 u32 trace_classify_table_index;
81 u32 trace_filter_set_index;
82 } vlib_trace_filter_t;
86 VLIB_NODE_RUNTIME_PERF_BEFORE,
87 VLIB_NODE_RUNTIME_PERF_AFTER,
88 VLIB_NODE_RUNTIME_PERF_RESET,
89 } vlib_node_runtime_perf_call_type_t;
93 struct vlib_main_t *vm;
94 vlib_node_runtime_t *node;
98 vlib_node_runtime_perf_call_type_t call_type;
99 } vlib_node_runtime_perf_callback_args_t;
101 struct vlib_node_runtime_perf_callback_data_t;
103 typedef void (*vlib_node_runtime_perf_callback_fp_t)
104 (struct vlib_node_runtime_perf_callback_data_t * data,
105 vlib_node_runtime_perf_callback_args_t * args);
107 typedef struct vlib_node_runtime_perf_callback_data_t
109 vlib_node_runtime_perf_callback_fp_t fp;
115 } vlib_node_runtime_perf_callback_data_t;
117 clib_callback_data_typedef (vlib_node_runtime_perf_callback_set_t,
118 vlib_node_runtime_perf_callback_data_t);
120 typedef struct vlib_main_t
122 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
123 /* Instruction level timing state. */
124 clib_time_t clib_time;
125 /* Offset from main thread time */
127 f64 time_last_barrier_release;
129 /* Time stamp of last node dispatch. */
130 u64 cpu_time_last_node_dispatch;
132 /* Time stamp when main loop was entered (time 0). */
133 u64 cpu_time_main_loop_start;
135 /* Incremented once for each main loop. */
136 volatile u32 main_loop_count;
138 /* Count of vectors processed this main loop. */
139 u32 main_loop_vectors_processed;
140 u32 main_loop_nodes_processed;
142 /* Internal node vectors, calls */
143 u64 internal_node_vectors;
144 u64 internal_node_calls;
145 u64 internal_node_vectors_last_clear;
146 u64 internal_node_calls_last_clear;
148 /* Instantaneous vector rate */
149 u32 internal_node_last_vectors_per_main_loop;
151 /* Main loop hw / sw performance counters */
152 vlib_node_runtime_perf_callback_set_t vlib_node_runtime_perf_callbacks;
154 /* Every so often we switch to the next counter. */
155 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
157 /* Jump target to exit main loop with given code. */
158 u32 main_loop_exit_set;
159 /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
160 volatile u32 main_loop_exit_now;
161 clib_longjmp_t main_loop_exit;
162 #define VLIB_MAIN_LOOP_EXIT_NONE 0
163 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
165 #define VLIB_MAIN_LOOP_EXIT_CLI 2
167 /* Error marker to use when exiting main loop. */
168 clib_error_t *main_loop_error;
170 /* Name for e.g. syslog. */
173 /* Start of the heap. */
176 /* Truncated version, to create frame indices */
177 void *heap_aligned_base;
179 /* Size of the heap */
182 /* buffer main structure. */
183 vlib_buffer_main_t *buffer_main;
185 /* physical memory main structure. */
186 vlib_physmem_main_t physmem_main;
188 /* Node graph main structure. */
189 vlib_node_main_t node_main;
191 /* Command line interface. */
192 vlib_cli_main_t cli_main;
194 /* Packet trace buffer. */
195 vlib_trace_main_t trace_main;
197 /* Pcap dispatch trace main */
198 pcap_main_t dispatch_pcap_main;
199 uword dispatch_pcap_enable;
200 uword dispatch_pcap_postmortem;
201 u32 *dispatch_buffer_trace_nodes;
204 /* pcap rx / tx tracing */
207 /* Packet trace capture filter */
208 vlib_trace_filter_t trace_filter;
210 /* Error handling. */
211 vlib_error_main_t error_main;
213 /* Punt packets to underlying operating system for when fast switching
214 code does not know what to do. */
215 void (*os_punt_frame) (struct vlib_main_t * vm,
216 struct vlib_node_runtime_t * node,
217 vlib_frame_t * frame);
219 /* Stream index to use for distribution when MC is enabled. */
222 vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
225 elog_main_t elog_main;
226 u32 configured_elog_ring_size;
228 /* Event logger trace flags */
229 int elog_trace_api_messages;
230 int elog_trace_cli_commands;
231 int elog_trace_graph_dispatch;
232 int elog_trace_graph_circuit;
233 u32 elog_trace_graph_circuit_node_index;
235 /* Node call and return event types. */
236 elog_event_type_t *node_call_elog_event_types;
237 elog_event_type_t *node_return_elog_event_types;
239 elog_event_type_t *error_elog_event_types;
241 /* Seed for random number generator. */
244 /* Buffer of random data for various uses. */
245 clib_random_buffer_t random_buffer;
247 /* Hash table to record which init functions have been called. */
248 uword *init_functions_called;
250 /* thread, cpu and numa_node indices */
255 /* List of init functions to call, setup by constructors */
256 _vlib_init_function_list_elt_t *init_function_registrations;
257 _vlib_init_function_list_elt_t *worker_init_function_registrations;
258 _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
259 _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
260 _vlib_init_function_list_elt_t *api_init_function_registrations;
261 vlib_config_function_runtime_t *config_function_registrations;
263 /* control-plane API queue signal pending, length indication */
264 volatile u32 queue_signal_pending;
265 volatile u32 api_queue_nonempty;
266 void (*queue_signal_callback) (struct vlib_main_t *);
269 /* Top of (worker) dispatch loop callback */
270 void (**volatile worker_thread_main_loop_callbacks)
271 (struct vlib_main_t *, u64 t);
272 void (**volatile worker_thread_main_loop_callback_tmp)
273 (struct vlib_main_t *, u64 t);
274 clib_spinlock_t worker_thread_main_loop_callback_lock;
277 volatile int parked_at_barrier;
279 /* Attempt to do a post-mortem elog dump */
280 int elog_post_mortem_dump;
283 * Need to call vlib_worker_thread_node_runtime_update before
284 * releasing worker thread barrier. Only valid in vlib_global_main.
286 int need_vlib_worker_thread_node_runtime_update;
288 /* Dispatch loop time accounting */
289 u64 loops_this_reporting_interval;
290 f64 loop_interval_end;
291 f64 loop_interval_start;
292 f64 loops_per_second;
293 f64 seconds_per_loop;
294 f64 damping_constant;
297 * Barrier epoch - Set to current time, each time barrier_sync or
298 * barrier_release is called with zero recursion.
302 /* Earliest barrier can be closed again */
303 f64 barrier_no_close_before;
305 /* Barrier counter callback */
306 void (**volatile barrier_perf_callbacks)
307 (struct vlib_main_t *, u64 t, int leave);
308 void (**volatile barrier_perf_callbacks_tmp)
309 (struct vlib_main_t *, u64 t, int leave);
311 /* Need to check the frame queues */
312 volatile uword check_frame_queues;
314 /* RPC requests, main thread only */
315 uword *pending_rpc_requests;
316 uword *processing_rpc_requests;
317 clib_spinlock_t pending_rpc_lock;
319 /* buffer fault injector */
320 u32 buffer_alloc_success_seed;
321 f64 buffer_alloc_success_rate;
323 #ifdef CLIB_SANITIZE_ADDR
324 /* address sanitizer stack save */
325 void *asan_stack_save;
329 /* Global main structure. */
330 extern vlib_main_t vlib_global_main;
332 void vlib_worker_loop (vlib_main_t * vm);
335 vlib_time_now (vlib_main_t * vm)
338 extern __thread uword __os_thread_index;
341 * Make sure folks don't pass &vlib_global_main from a worker thread.
343 ASSERT (vm->thread_index == __os_thread_index);
344 return clib_time_now (&vm->clib_time) + vm->time_offset;
348 vlib_time_now_ticks (vlib_main_t * vm, u64 n)
350 return clib_time_now_internal (&vm->clib_time, n);
353 /* Busy wait for specified time. */
355 vlib_time_wait (vlib_main_t * vm, f64 wait)
357 f64 t = vlib_time_now (vm);
358 f64 limit = t + wait;
360 t = vlib_time_now (vm);
363 /* Time a piece of code. */
364 #define vlib_time_code(vm,body) \
367 _t[0] = vlib_time_now (vm); \
368 do { body; } while (0); \
369 _t[1] = vlib_time_now (vm); \
370 clib_warning ("%.7e", _t[1] - _t[0]); \
373 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
375 uword __vlib_wait_with_timeout = 0; \
376 f64 __vlib_wait_time = 0; \
377 while (! (__vlib_wait_with_timeout = (test)) \
378 && __vlib_wait_time < (timeout_time)) \
380 vlib_process_suspend (vm, suspend_time); \
381 __vlib_wait_time += suspend_time; \
383 __vlib_wait_with_timeout; \
387 vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
389 vm->main_loop_error = error;
390 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
393 #define vlib_panic_with_msg(vm,args...) \
394 vlib_panic_with_error (vm, clib_error_return (0, args))
397 vlib_panic (vlib_main_t * vm)
399 vlib_panic_with_error (vm, 0);
404 vlib_internal_node_vector_rate (vlib_main_t * vm)
409 calls = vm->internal_node_calls - vm->internal_node_calls_last_clear;
411 if (PREDICT_FALSE (calls == 0))
414 vectors = vm->internal_node_vectors - vm->internal_node_vectors_last_clear;
416 return (f64) vectors / (f64) calls;
420 vlib_clear_internal_node_vector_rate (vlib_main_t * vm)
422 vm->internal_node_calls_last_clear = vm->internal_node_calls;
423 vm->internal_node_vectors_last_clear = vm->internal_node_vectors;
427 vlib_increment_main_loop_counter (vlib_main_t * vm)
429 vm->main_loop_count++;
430 vm->internal_node_last_vectors_per_main_loop = 0;
432 if (PREDICT_FALSE (vm->main_loop_exit_now))
433 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
437 vlib_last_vectors_per_main_loop (vlib_main_t * vm)
439 return vm->internal_node_last_vectors_per_main_loop;
443 vlib_node_runtime_perf_counter (vlib_main_t * vm, vlib_node_runtime_t * node,
444 vlib_frame_t * frame, uword n, u64 t,
445 vlib_node_runtime_perf_call_type_t call_type)
447 vlib_node_runtime_perf_callback_data_t *v =
448 clib_callback_data_check_and_get (&vm->vlib_node_runtime_perf_callbacks);
451 vlib_node_runtime_perf_callback_args_t args = {
457 .call_type = call_type,
459 clib_callback_data_call_vec (v, &args);
463 always_inline void vlib_set_queue_signal_callback
464 (vlib_main_t * vm, void (*fp) (vlib_main_t *))
466 vm->queue_signal_callback = fp;
470 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
472 /* Thread stacks, for os_get_thread_index */
473 extern u8 **vlib_thread_stacks;
475 /* Number of thread stacks that the application needs */
476 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
478 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
480 #define VLIB_PCAP_MAJOR_VERSION 1
481 #define VLIB_PCAP_MINOR_VERSION 0
489 u32 packets_to_capture;
490 u32 buffer_trace_node_index;
491 u32 buffer_traces_to_capture;
492 } vlib_pcap_dispatch_trace_args_t;
494 int vlib_pcap_dispatch_trace_configure (vlib_pcap_dispatch_trace_args_t *);
495 vlib_main_t *vlib_get_main_not_inline (void);
496 elog_main_t *vlib_get_elog_main_not_inline ();
498 #endif /* included_vlib_main_h */
501 * fd.io coding-style-patch-verification: ON
504 * eval: (c-set-style "gnu")