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>
49 #include <vppinfra/pmc.h>
50 #include <vppinfra/pcap.h>
55 /* By default turn off node/error event logging.
56 Override with -DVLIB_ELOG_MAIN_LOOP */
57 #ifndef VLIB_ELOG_MAIN_LOOP
58 #define VLIB_ELOG_MAIN_LOOP 0
65 pcap_main_t pcap_main;
66 u32 filter_classify_table_index;
69 typedef struct vlib_main_t
71 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
72 /* Instruction level timing state. */
73 clib_time_t clib_time;
74 /* Offset from main thread time */
76 f64 time_last_barrier_release;
78 /* Time stamp of last node dispatch. */
79 u64 cpu_time_last_node_dispatch;
81 /* Time stamp when main loop was entered (time 0). */
82 u64 cpu_time_main_loop_start;
84 /* Incremented once for each main loop. */
87 /* Count of vectors processed this main loop. */
88 u32 main_loop_vectors_processed;
89 u32 main_loop_nodes_processed;
91 /* Circular buffer of input node vector counts.
92 Indexed by low bits of
93 (main_loop_count >> VLIB_LOG2_INPUT_VECTORS_PER_MAIN_LOOP). */
94 u32 vector_counts_per_main_loop[2];
95 u32 node_counts_per_main_loop[2];
97 /* Main loop hw / sw performance counters */
98 void (**vlib_node_runtime_perf_counter_cbs) (struct vlib_main_t *,
100 vlib_node_runtime_t *,
101 vlib_frame_t *, int);
102 void (**vlib_node_runtime_perf_counter_cb_tmp) (struct vlib_main_t *,
104 vlib_node_runtime_t *,
105 vlib_frame_t *, int);
106 /* Every so often we switch to the next counter. */
107 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
109 /* Jump target to exit main loop with given code. */
110 u32 main_loop_exit_set;
111 /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
112 volatile u32 main_loop_exit_now;
113 clib_longjmp_t main_loop_exit;
114 #define VLIB_MAIN_LOOP_EXIT_NONE 0
115 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
117 #define VLIB_MAIN_LOOP_EXIT_CLI 2
119 /* Error marker to use when exiting main loop. */
120 clib_error_t *main_loop_error;
122 /* Name for e.g. syslog. */
125 /* Start of the heap. */
128 /* Truncated version, to create frame indices */
129 void *heap_aligned_base;
131 /* Size of the heap */
134 /* buffer main structure. */
135 vlib_buffer_main_t *buffer_main;
137 /* physical memory main structure. */
138 vlib_physmem_main_t physmem_main;
140 /* Node graph main structure. */
141 vlib_node_main_t node_main;
143 /* Command line interface. */
144 vlib_cli_main_t cli_main;
146 /* Packet trace buffer. */
147 vlib_trace_main_t trace_main;
149 /* Pcap dispatch trace main */
150 pcap_main_t dispatch_pcap_main;
151 uword dispatch_pcap_enable;
152 u32 *dispatch_buffer_trace_nodes;
155 /* pcap rx / tx tracing */
156 vnet_pcap_t pcap[VLIB_N_RX_TX];
158 /* Error handling. */
159 vlib_error_main_t error_main;
161 /* Punt packets to underlying operating system for when fast switching
162 code does not know what to do. */
163 void (*os_punt_frame) (struct vlib_main_t * vm,
164 struct vlib_node_runtime_t * node,
165 vlib_frame_t * frame);
167 /* Stream index to use for distribution when MC is enabled. */
170 vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
173 elog_main_t elog_main;
175 /* Event logger trace flags */
176 int elog_trace_api_messages;
177 int elog_trace_cli_commands;
178 int elog_trace_graph_dispatch;
179 int elog_trace_graph_circuit;
180 u32 elog_trace_graph_circuit_node_index;
182 /* Node call and return event types. */
183 elog_event_type_t *node_call_elog_event_types;
184 elog_event_type_t *node_return_elog_event_types;
186 elog_event_type_t *error_elog_event_types;
188 /* Seed for random number generator. */
191 /* Buffer of random data for various uses. */
192 clib_random_buffer_t random_buffer;
194 /* Hash table to record which init functions have been called. */
195 uword *init_functions_called;
197 /* thread, cpu and numa_node indices */
202 /* List of init functions to call, setup by constructors */
203 _vlib_init_function_list_elt_t *init_function_registrations;
204 _vlib_init_function_list_elt_t *worker_init_function_registrations;
205 _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
206 _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
207 _vlib_init_function_list_elt_t *api_init_function_registrations;
208 vlib_config_function_runtime_t *config_function_registrations;
210 /* control-plane API queue signal pending, length indication */
211 volatile u32 queue_signal_pending;
212 volatile u32 api_queue_nonempty;
213 void (*queue_signal_callback) (struct vlib_main_t *);
216 /* Top of (worker) dispatch loop callback */
217 void (**volatile worker_thread_main_loop_callbacks) (struct vlib_main_t *);
218 void (**volatile worker_thread_main_loop_callback_tmp)
219 (struct vlib_main_t *);
220 clib_spinlock_t worker_thread_main_loop_callback_lock;
223 volatile int parked_at_barrier;
225 /* Attempt to do a post-mortem elog dump */
226 int elog_post_mortem_dump;
229 * Need to call vlib_worker_thread_node_runtime_update before
230 * releasing worker thread barrier. Only valid in vlib_global_main.
232 int need_vlib_worker_thread_node_runtime_update;
235 * Barrier epoch - Set to current time, each time barrier_sync or
236 * barrier_release is called with zero recursion.
240 /* Earliest barrier can be closed again */
241 f64 barrier_no_close_before;
243 /* Need to check the frame queues */
244 volatile uword check_frame_queues;
246 /* RPC requests, main thread only */
247 uword *pending_rpc_requests;
248 uword *processing_rpc_requests;
249 clib_spinlock_t pending_rpc_lock;
253 /* Global main structure. */
254 extern vlib_main_t vlib_global_main;
256 void vlib_worker_loop (vlib_main_t * vm);
259 vlib_time_now (vlib_main_t * vm)
261 return clib_time_now (&vm->clib_time) + vm->time_offset;
265 vlib_time_now_ticks (vlib_main_t * vm, u64 n)
267 return clib_time_now_internal (&vm->clib_time, n);
270 /* Busy wait for specified time. */
272 vlib_time_wait (vlib_main_t * vm, f64 wait)
274 f64 t = vlib_time_now (vm);
275 f64 limit = t + wait;
277 t = vlib_time_now (vm);
280 /* Time a piece of code. */
281 #define vlib_time_code(vm,body) \
284 _t[0] = vlib_time_now (vm); \
285 do { body; } while (0); \
286 _t[1] = vlib_time_now (vm); \
287 clib_warning ("%.7e", _t[1] - _t[0]); \
290 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
292 uword __vlib_wait_with_timeout = 0; \
293 f64 __vlib_wait_time = 0; \
294 while (! (__vlib_wait_with_timeout = (test)) \
295 && __vlib_wait_time < (timeout_time)) \
297 vlib_process_suspend (vm, suspend_time); \
298 __vlib_wait_time += suspend_time; \
300 __vlib_wait_with_timeout; \
304 vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
306 vm->main_loop_error = error;
307 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
310 #define vlib_panic_with_msg(vm,args...) \
311 vlib_panic_with_error (vm, clib_error_return (0, args))
314 vlib_panic (vlib_main_t * vm)
316 vlib_panic_with_error (vm, 0);
320 vlib_vector_input_stats_index (vlib_main_t * vm, word delta)
323 i = vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
324 ASSERT (is_pow2 (ARRAY_LEN (vm->vector_counts_per_main_loop)));
325 return (i + delta) & (ARRAY_LEN (vm->vector_counts_per_main_loop) - 1);
328 /* Estimate input rate based on previous
329 2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
332 vlib_last_vectors_per_main_loop (vlib_main_t * vm)
334 u32 i = vlib_vector_input_stats_index (vm, -1);
335 u32 n = vm->vector_counts_per_main_loop[i];
336 return n >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
339 /* Total ave vector count per iteration of main loop. */
341 vlib_last_vectors_per_main_loop_as_f64 (vlib_main_t * vm)
343 u32 i = vlib_vector_input_stats_index (vm, -1);
344 u32 v = vm->vector_counts_per_main_loop[i];
345 return (f64) v / (f64) (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
348 /* Total ave vectors/node count per iteration of main loop. */
350 vlib_last_vector_length_per_node (vlib_main_t * vm)
352 u32 i = vlib_vector_input_stats_index (vm, -1);
353 u32 v = vm->vector_counts_per_main_loop[i];
354 u32 n = vm->node_counts_per_main_loop[i];
355 return n == 0 ? 0 : (f64) v / (f64) n;
361 vlib_increment_main_loop_counter (vlib_main_t * vm)
363 u32 i, c, n, v, is_wrap;
365 c = vm->main_loop_count++;
367 is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
372 i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
374 v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
375 n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
377 v += vm->main_loop_vectors_processed;
378 n += vm->main_loop_nodes_processed;
379 vm->main_loop_vectors_processed = 0;
380 vm->main_loop_nodes_processed = 0;
381 vm->vector_counts_per_main_loop[i] = v;
382 vm->node_counts_per_main_loop[i] = n;
384 if (PREDICT_FALSE (vm->main_loop_exit_now))
385 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
388 always_inline void vlib_set_queue_signal_callback
389 (vlib_main_t * vm, void (*fp) (vlib_main_t *))
391 vm->queue_signal_callback = fp;
395 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
397 /* Thread stacks, for os_get_thread_index */
398 extern u8 **vlib_thread_stacks;
400 /* Number of thread stacks that the application needs */
401 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
403 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
405 #define VLIB_PCAP_MAJOR_VERSION 1
406 #define VLIB_PCAP_MINOR_VERSION 0
413 u32 packets_to_capture;
414 u32 buffer_trace_node_index;
415 u32 buffer_traces_to_capture;
416 } vlib_pcap_dispatch_trace_args_t;
418 int vlib_pcap_dispatch_trace_configure (vlib_pcap_dispatch_trace_args_t *);
420 #endif /* included_vlib_main_h */
423 * fd.io coding-style-patch-verification: ON
426 * eval: (c-set-style "gnu")