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
61 typedef struct vlib_main_t
63 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
64 /* Instruction level timing state. */
65 clib_time_t clib_time;
67 /* Time stamp of last node dispatch. */
68 u64 cpu_time_last_node_dispatch;
70 /* Time stamp when main loop was entered (time 0). */
71 u64 cpu_time_main_loop_start;
73 /* Incremented once for each main loop. */
76 /* Count of vectors processed this main loop. */
77 u32 main_loop_vectors_processed;
78 u32 main_loop_nodes_processed;
80 /* Circular buffer of input node vector counts.
81 Indexed by low bits of
82 (main_loop_count >> VLIB_LOG2_INPUT_VECTORS_PER_MAIN_LOOP). */
83 u32 vector_counts_per_main_loop[2];
84 u32 node_counts_per_main_loop[2];
86 /* Main loop hw / sw performance counters */
87 u64 (*vlib_node_runtime_perf_counter_cb) (struct vlib_main_t *);
91 /* Every so often we switch to the next counter. */
92 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
94 /* Jump target to exit main loop with given code. */
95 u32 main_loop_exit_set;
96 /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
97 volatile u32 main_loop_exit_now;
98 clib_longjmp_t main_loop_exit;
99 #define VLIB_MAIN_LOOP_EXIT_NONE 0
100 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
102 #define VLIB_MAIN_LOOP_EXIT_CLI 2
104 /* Error marker to use when exiting main loop. */
105 clib_error_t *main_loop_error;
107 /* Name for e.g. syslog. */
110 /* Start of the heap. */
113 /* Truncated version, to create frame indices */
114 void *heap_aligned_base;
116 /* Size of the heap */
119 /* Pool of buffer free lists. */
120 vlib_buffer_free_list_t *buffer_free_list_pool;
122 /* physical memory main structure. */
123 vlib_physmem_main_t physmem_main;
125 /* Node graph main structure. */
126 vlib_node_main_t node_main;
128 /* Command line interface. */
129 vlib_cli_main_t cli_main;
131 /* Packet trace buffer. */
132 vlib_trace_main_t trace_main;
134 /* Pcap dispatch trace main */
135 pcap_main_t dispatch_pcap_main;
136 uword dispatch_pcap_enable;
138 /* Error handling. */
139 vlib_error_main_t error_main;
141 /* Punt packets to underlying operating system for when fast switching
142 code does not know what to do. */
143 void (*os_punt_frame) (struct vlib_main_t * vm,
144 struct vlib_node_runtime_t * node,
145 vlib_frame_t * frame);
147 /* Stream index to use for distribution when MC is enabled. */
150 vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
153 elog_main_t elog_main;
155 /* Event logger trace flags */
156 int elog_trace_api_messages;
157 int elog_trace_cli_commands;
159 /* Node call and return event types. */
160 elog_event_type_t *node_call_elog_event_types;
161 elog_event_type_t *node_return_elog_event_types;
163 elog_event_type_t *error_elog_event_types;
165 /* Seed for random number generator. */
168 /* Buffer of random data for various uses. */
169 clib_random_buffer_t random_buffer;
171 /* Hash table to record which init functions have been called. */
172 uword *init_functions_called;
174 /* to compare with node runtime */
177 /* List of init functions to call, setup by constructors */
178 _vlib_init_function_list_elt_t *init_function_registrations;
179 _vlib_init_function_list_elt_t *worker_init_function_registrations;
180 _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
181 _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
182 _vlib_init_function_list_elt_t *api_init_function_registrations;
183 vlib_config_function_runtime_t *config_function_registrations;
185 /* control-plane API queue signal pending, length indication */
186 volatile u32 queue_signal_pending;
187 volatile u32 api_queue_nonempty;
188 void (*queue_signal_callback) (struct vlib_main_t *);
191 /* Top of (worker) dispatch loop callback */
192 volatile void (*worker_thread_main_loop_callback) (struct vlib_main_t *);
195 volatile int parked_at_barrier;
197 /* Attempt to do a post-mortem elog dump */
198 int elog_post_mortem_dump;
201 * Need to call vlib_worker_thread_node_runtime_update before
202 * releasing worker thread barrier. Only valid in vlib_global_main.
204 int need_vlib_worker_thread_node_runtime_update;
207 * Barrier epoch - Set to current time, each time barrier_sync or
208 * barrier_release is called with zero recursion.
212 /* Earliest barrier can be closed again */
213 f64 barrier_no_close_before;
215 /* RPC requests, main thread only */
216 uword *pending_rpc_requests;
217 uword *processing_rpc_requests;
218 clib_spinlock_t pending_rpc_lock;
222 /* Global main structure. */
223 extern vlib_main_t vlib_global_main;
225 void vlib_worker_loop (vlib_main_t * vm);
228 vlib_time_now (vlib_main_t * vm)
230 return clib_time_now (&vm->clib_time);
234 vlib_time_now_ticks (vlib_main_t * vm, u64 n)
236 return clib_time_now_internal (&vm->clib_time, n);
239 /* Busy wait for specified time. */
241 vlib_time_wait (vlib_main_t * vm, f64 wait)
243 f64 t = vlib_time_now (vm);
244 f64 limit = t + wait;
246 t = vlib_time_now (vm);
249 /* Time a piece of code. */
250 #define vlib_time_code(vm,body) \
253 _t[0] = vlib_time_now (vm); \
254 do { body; } while (0); \
255 _t[1] = vlib_time_now (vm); \
256 clib_warning ("%.7e", _t[1] - _t[0]); \
259 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
261 uword __vlib_wait_with_timeout = 0; \
262 f64 __vlib_wait_time = 0; \
263 while (! (__vlib_wait_with_timeout = (test)) \
264 && __vlib_wait_time < (timeout_time)) \
266 vlib_process_suspend (vm, suspend_time); \
267 __vlib_wait_time += suspend_time; \
269 __vlib_wait_with_timeout; \
273 vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
275 vm->main_loop_error = error;
276 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
279 #define vlib_panic_with_msg(vm,args...) \
280 vlib_panic_with_error (vm, clib_error_return (0, args))
283 vlib_panic (vlib_main_t * vm)
285 vlib_panic_with_error (vm, 0);
289 vlib_vector_input_stats_index (vlib_main_t * vm, word delta)
292 i = vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
293 ASSERT (is_pow2 (ARRAY_LEN (vm->vector_counts_per_main_loop)));
294 return (i + delta) & (ARRAY_LEN (vm->vector_counts_per_main_loop) - 1);
297 /* Estimate input rate based on previous
298 2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
301 vlib_last_vectors_per_main_loop (vlib_main_t * vm)
303 u32 i = vlib_vector_input_stats_index (vm, -1);
304 u32 n = vm->vector_counts_per_main_loop[i];
305 return n >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
308 /* Total ave vector count per iteration of main loop. */
310 vlib_last_vectors_per_main_loop_as_f64 (vlib_main_t * vm)
312 u32 i = vlib_vector_input_stats_index (vm, -1);
313 u32 v = vm->vector_counts_per_main_loop[i];
314 return (f64) v / (f64) (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
317 /* Total ave vectors/node count per iteration of main loop. */
319 vlib_last_vector_length_per_node (vlib_main_t * vm)
321 u32 i = vlib_vector_input_stats_index (vm, -1);
322 u32 v = vm->vector_counts_per_main_loop[i];
323 u32 n = vm->node_counts_per_main_loop[i];
324 return n == 0 ? 0 : (f64) v / (f64) n;
330 vlib_increment_main_loop_counter (vlib_main_t * vm)
332 u32 i, c, n, v, is_wrap;
334 c = vm->main_loop_count++;
336 is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
341 i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
343 v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
344 n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
346 v += vm->main_loop_vectors_processed;
347 n += vm->main_loop_nodes_processed;
348 vm->main_loop_vectors_processed = 0;
349 vm->main_loop_nodes_processed = 0;
350 vm->vector_counts_per_main_loop[i] = v;
351 vm->node_counts_per_main_loop[i] = n;
353 if (PREDICT_FALSE (vm->main_loop_exit_now))
354 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
357 always_inline void vlib_set_queue_signal_callback
358 (vlib_main_t * vm, void (*fp) (vlib_main_t *))
360 vm->queue_signal_callback = fp;
364 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
366 /* Thread stacks, for os_get_thread_index */
367 extern u8 **vlib_thread_stacks;
369 /* Number of thread stacks that the application needs */
370 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
372 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
374 #define VLIB_PCAP_MAJOR_VERSION 1
375 #define VLIB_PCAP_MINOR_VERSION 0
377 #endif /* included_vlib_main_h */
380 * fd.io coding-style-patch-verification: ON
383 * eval: (c-set-style "gnu")