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;
68 typedef struct vlib_main_t
70 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
71 /* Instruction level timing state. */
72 clib_time_t clib_time;
73 /* Offset from main thread time */
75 f64 time_last_barrier_release;
77 /* Time stamp of last node dispatch. */
78 u64 cpu_time_last_node_dispatch;
80 /* Time stamp when main loop was entered (time 0). */
81 u64 cpu_time_main_loop_start;
83 /* Incremented once for each main loop. */
86 /* Count of vectors processed this main loop. */
87 u32 main_loop_vectors_processed;
88 u32 main_loop_nodes_processed;
90 /* Circular buffer of input node vector counts.
91 Indexed by low bits of
92 (main_loop_count >> VLIB_LOG2_INPUT_VECTORS_PER_MAIN_LOOP). */
93 u32 vector_counts_per_main_loop[2];
94 u32 node_counts_per_main_loop[2];
96 /* Main loop hw / sw performance counters */
97 void (**vlib_node_runtime_perf_counter_cbs) (struct vlib_main_t *,
99 vlib_node_runtime_t *,
100 vlib_frame_t *, int);
101 void (**vlib_node_runtime_perf_counter_cb_tmp) (struct vlib_main_t *,
103 vlib_node_runtime_t *,
104 vlib_frame_t *, int);
105 /* Every so often we switch to the next counter. */
106 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
108 /* Jump target to exit main loop with given code. */
109 u32 main_loop_exit_set;
110 /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
111 volatile u32 main_loop_exit_now;
112 clib_longjmp_t main_loop_exit;
113 #define VLIB_MAIN_LOOP_EXIT_NONE 0
114 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
116 #define VLIB_MAIN_LOOP_EXIT_CLI 2
118 /* Error marker to use when exiting main loop. */
119 clib_error_t *main_loop_error;
121 /* Name for e.g. syslog. */
124 /* Start of the heap. */
127 /* Truncated version, to create frame indices */
128 void *heap_aligned_base;
130 /* Size of the heap */
133 /* buffer main structure. */
134 vlib_buffer_main_t *buffer_main;
136 /* physical memory main structure. */
137 vlib_physmem_main_t physmem_main;
139 /* Node graph main structure. */
140 vlib_node_main_t node_main;
142 /* Command line interface. */
143 vlib_cli_main_t cli_main;
145 /* Packet trace buffer. */
146 vlib_trace_main_t trace_main;
148 /* Pcap dispatch trace main */
149 pcap_main_t dispatch_pcap_main;
150 uword dispatch_pcap_enable;
151 u32 *dispatch_buffer_trace_nodes;
154 /* pcap rx / tx tracing */
155 vnet_pcap_t pcap[VLIB_N_RX_TX];
157 /* Error handling. */
158 vlib_error_main_t error_main;
160 /* Punt packets to underlying operating system for when fast switching
161 code does not know what to do. */
162 void (*os_punt_frame) (struct vlib_main_t * vm,
163 struct vlib_node_runtime_t * node,
164 vlib_frame_t * frame);
166 /* Stream index to use for distribution when MC is enabled. */
169 vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
172 elog_main_t elog_main;
174 /* Event logger trace flags */
175 int elog_trace_api_messages;
176 int elog_trace_cli_commands;
177 int elog_trace_graph_dispatch;
178 int elog_trace_graph_circuit;
179 u32 elog_trace_graph_circuit_node_index;
181 /* Node call and return event types. */
182 elog_event_type_t *node_call_elog_event_types;
183 elog_event_type_t *node_return_elog_event_types;
185 elog_event_type_t *error_elog_event_types;
187 /* Seed for random number generator. */
190 /* Buffer of random data for various uses. */
191 clib_random_buffer_t random_buffer;
193 /* Hash table to record which init functions have been called. */
194 uword *init_functions_called;
196 /* thread, cpu and numa_node indices */
201 /* List of init functions to call, setup by constructors */
202 _vlib_init_function_list_elt_t *init_function_registrations;
203 _vlib_init_function_list_elt_t *worker_init_function_registrations;
204 _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
205 _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
206 _vlib_init_function_list_elt_t *api_init_function_registrations;
207 vlib_config_function_runtime_t *config_function_registrations;
209 /* control-plane API queue signal pending, length indication */
210 volatile u32 queue_signal_pending;
211 volatile u32 api_queue_nonempty;
212 void (*queue_signal_callback) (struct vlib_main_t *);
215 /* Top of (worker) dispatch loop callback */
216 void (**volatile worker_thread_main_loop_callbacks) (struct vlib_main_t *);
217 void (**volatile worker_thread_main_loop_callback_tmp)
218 (struct vlib_main_t *);
219 clib_spinlock_t worker_thread_main_loop_callback_lock;
222 volatile int parked_at_barrier;
224 /* Attempt to do a post-mortem elog dump */
225 int elog_post_mortem_dump;
228 * Need to call vlib_worker_thread_node_runtime_update before
229 * releasing worker thread barrier. Only valid in vlib_global_main.
231 int need_vlib_worker_thread_node_runtime_update;
234 * Barrier epoch - Set to current time, each time barrier_sync or
235 * barrier_release is called with zero recursion.
239 /* Earliest barrier can be closed again */
240 f64 barrier_no_close_before;
242 /* Need to check the frame queues */
243 volatile uword check_frame_queues;
245 /* RPC requests, main thread only */
246 uword *pending_rpc_requests;
247 uword *processing_rpc_requests;
248 clib_spinlock_t pending_rpc_lock;
252 /* Global main structure. */
253 extern vlib_main_t vlib_global_main;
255 void vlib_worker_loop (vlib_main_t * vm);
258 vlib_time_now (vlib_main_t * vm)
260 return clib_time_now (&vm->clib_time) + vm->time_offset;
264 vlib_time_now_ticks (vlib_main_t * vm, u64 n)
266 return clib_time_now_internal (&vm->clib_time, n);
269 /* Busy wait for specified time. */
271 vlib_time_wait (vlib_main_t * vm, f64 wait)
273 f64 t = vlib_time_now (vm);
274 f64 limit = t + wait;
276 t = vlib_time_now (vm);
279 /* Time a piece of code. */
280 #define vlib_time_code(vm,body) \
283 _t[0] = vlib_time_now (vm); \
284 do { body; } while (0); \
285 _t[1] = vlib_time_now (vm); \
286 clib_warning ("%.7e", _t[1] - _t[0]); \
289 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
291 uword __vlib_wait_with_timeout = 0; \
292 f64 __vlib_wait_time = 0; \
293 while (! (__vlib_wait_with_timeout = (test)) \
294 && __vlib_wait_time < (timeout_time)) \
296 vlib_process_suspend (vm, suspend_time); \
297 __vlib_wait_time += suspend_time; \
299 __vlib_wait_with_timeout; \
303 vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
305 vm->main_loop_error = error;
306 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
309 #define vlib_panic_with_msg(vm,args...) \
310 vlib_panic_with_error (vm, clib_error_return (0, args))
313 vlib_panic (vlib_main_t * vm)
315 vlib_panic_with_error (vm, 0);
319 vlib_vector_input_stats_index (vlib_main_t * vm, word delta)
322 i = vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
323 ASSERT (is_pow2 (ARRAY_LEN (vm->vector_counts_per_main_loop)));
324 return (i + delta) & (ARRAY_LEN (vm->vector_counts_per_main_loop) - 1);
327 /* Estimate input rate based on previous
328 2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
331 vlib_last_vectors_per_main_loop (vlib_main_t * vm)
333 u32 i = vlib_vector_input_stats_index (vm, -1);
334 u32 n = vm->vector_counts_per_main_loop[i];
335 return n >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
338 /* Total ave vector count per iteration of main loop. */
340 vlib_last_vectors_per_main_loop_as_f64 (vlib_main_t * vm)
342 u32 i = vlib_vector_input_stats_index (vm, -1);
343 u32 v = vm->vector_counts_per_main_loop[i];
344 return (f64) v / (f64) (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
347 /* Total ave vectors/node count per iteration of main loop. */
349 vlib_last_vector_length_per_node (vlib_main_t * vm)
351 u32 i = vlib_vector_input_stats_index (vm, -1);
352 u32 v = vm->vector_counts_per_main_loop[i];
353 u32 n = vm->node_counts_per_main_loop[i];
354 return n == 0 ? 0 : (f64) v / (f64) n;
360 vlib_increment_main_loop_counter (vlib_main_t * vm)
362 u32 i, c, n, v, is_wrap;
364 c = vm->main_loop_count++;
366 is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
371 i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
373 v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
374 n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
376 v += vm->main_loop_vectors_processed;
377 n += vm->main_loop_nodes_processed;
378 vm->main_loop_vectors_processed = 0;
379 vm->main_loop_nodes_processed = 0;
380 vm->vector_counts_per_main_loop[i] = v;
381 vm->node_counts_per_main_loop[i] = n;
383 if (PREDICT_FALSE (vm->main_loop_exit_now))
384 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
387 always_inline void vlib_set_queue_signal_callback
388 (vlib_main_t * vm, void (*fp) (vlib_main_t *))
390 vm->queue_signal_callback = fp;
394 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
396 /* Thread stacks, for os_get_thread_index */
397 extern u8 **vlib_thread_stacks;
399 /* Number of thread stacks that the application needs */
400 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
402 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
404 #define VLIB_PCAP_MAJOR_VERSION 1
405 #define VLIB_PCAP_MINOR_VERSION 0
412 u32 packets_to_capture;
413 u32 buffer_trace_node_index;
414 u32 buffer_traces_to_capture;
415 } vlib_pcap_dispatch_trace_args_t;
417 int vlib_pcap_dispatch_trace_configure (vlib_pcap_dispatch_trace_args_t *);
419 #endif /* included_vlib_main_h */
422 * fd.io coding-style-patch-verification: ON
425 * eval: (c-set-style "gnu")