blob: f89ecd3299f1e6a7f70183285eb76736dc637475 [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15/*
16 * main.h: VLIB main data structure
17 *
18 * Copyright (c) 2008 Eliot Dresselhaus
19 *
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:
27 *
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
30 *
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.
38 */
39
40#ifndef included_vlib_main_h
41#define included_vlib_main_h
42
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>
Dave Barach4d1a8662018-09-10 12:31:15 -040049#include <vppinfra/pmc.h>
Dave Barach3ae28732018-11-16 17:19:00 -050050#include <vppinfra/pcap.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070051
52#include <pthread.h>
53
54
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
59#endif
60
Dave Barach9b8ffd92016-07-08 08:13:45 -040061typedef struct vlib_main_t
62{
Damjan Marionbe3f4d52018-03-27 21:06:10 +020063 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070064 /* Instruction level timing state. */
65 clib_time_t clib_time;
66
67 /* Time stamp of last node dispatch. */
68 u64 cpu_time_last_node_dispatch;
69
70 /* Time stamp when main loop was entered (time 0). */
71 u64 cpu_time_main_loop_start;
72
73 /* Incremented once for each main loop. */
74 u32 main_loop_count;
75
76 /* Count of vectors processed this main loop. */
77 u32 main_loop_vectors_processed;
78 u32 main_loop_nodes_processed;
79
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];
85
Dave Barach4d1a8662018-09-10 12:31:15 -040086 /* Main loop hw / sw performance counters */
Dave Barachec595ef2019-01-24 10:34:24 -050087 void (*vlib_node_runtime_perf_counter_cb) (struct vlib_main_t *,
88 u64 *, u64 *);
Dave Barach4d1a8662018-09-10 12:31:15 -040089
Ed Warnickecb9cada2015-12-08 15:45:58 -070090 /* Every so often we switch to the next counter. */
91#define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
92
93 /* Jump target to exit main loop with given code. */
94 u32 main_loop_exit_set;
Dave Barach903651c2017-10-13 19:16:56 -040095 /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
96 volatile u32 main_loop_exit_now;
Ed Warnickecb9cada2015-12-08 15:45:58 -070097 clib_longjmp_t main_loop_exit;
98#define VLIB_MAIN_LOOP_EXIT_NONE 0
99#define VLIB_MAIN_LOOP_EXIT_PANIC 1
100 /* Exit via CLI. */
101#define VLIB_MAIN_LOOP_EXIT_CLI 2
102
103 /* Error marker to use when exiting main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400104 clib_error_t *main_loop_error;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105
106 /* Name for e.g. syslog. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400107 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700108
Dave Barach6a5adc32018-07-04 10:56:23 -0400109 /* Start of the heap. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400110 void *heap_base;
Dave Barach6a5adc32018-07-04 10:56:23 -0400111
112 /* Truncated version, to create frame indices */
113 void *heap_aligned_base;
114
115 /* Size of the heap */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700116 uword heap_size;
117
Damjan Mariond50e3472019-01-20 00:03:56 +0100118 /* buffer main structure. */
119 vlib_buffer_main_t *buffer_main;
120
Damjan Marion68b4da62018-09-30 18:26:20 +0200121 /* physical memory main structure. */
122 vlib_physmem_main_t physmem_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700123
124 /* Node graph main structure. */
125 vlib_node_main_t node_main;
126
127 /* Command line interface. */
128 vlib_cli_main_t cli_main;
129
130 /* Packet trace buffer. */
131 vlib_trace_main_t trace_main;
132
Dave Barach3ae28732018-11-16 17:19:00 -0500133 /* Pcap dispatch trace main */
134 pcap_main_t dispatch_pcap_main;
135 uword dispatch_pcap_enable;
Dave Barach7fff3d22018-11-27 16:52:59 -0500136 u8 *pcap_buffer;
Dave Barach3ae28732018-11-16 17:19:00 -0500137
Ed Warnickecb9cada2015-12-08 15:45:58 -0700138 /* Error handling. */
139 vlib_error_main_t error_main;
140
141 /* Punt packets to underlying operating system for when fast switching
142 code does not know what to do. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400143 void (*os_punt_frame) (struct vlib_main_t * vm,
144 struct vlib_node_runtime_t * node,
145 vlib_frame_t * frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700146
Ed Warnickecb9cada2015-12-08 15:45:58 -0700147 /* Stream index to use for distribution when MC is enabled. */
148 u32 mc_stream_index;
149
Dave Barach9b8ffd92016-07-08 08:13:45 -0400150 vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700151
152 /* Event logger. */
153 elog_main_t elog_main;
154
Dave Barachc3a06552018-10-01 09:25:32 -0400155 /* Event logger trace flags */
156 int elog_trace_api_messages;
157 int elog_trace_cli_commands;
Dave Barach900cbad2019-01-31 19:12:51 -0500158 int elog_trace_graph_dispatch;
159 int elog_trace_graph_circuit;
160 u32 elog_trace_graph_circuit_node_index;
Dave Barachc3a06552018-10-01 09:25:32 -0400161
Ed Warnickecb9cada2015-12-08 15:45:58 -0700162 /* Node call and return event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400163 elog_event_type_t *node_call_elog_event_types;
164 elog_event_type_t *node_return_elog_event_types;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700165
Dave Barach9b8ffd92016-07-08 08:13:45 -0400166 elog_event_type_t *error_elog_event_types;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700167
168 /* Seed for random number generator. */
169 uword random_seed;
170
171 /* Buffer of random data for various uses. */
172 clib_random_buffer_t random_buffer;
173
174 /* Hash table to record which init functions have been called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400175 uword *init_functions_called;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700176
Damjan Marion0a78fa12019-01-19 23:45:36 +0100177 /* thread, cpu and numa_node indices */
Damjan Marion586afd72017-04-05 19:18:20 +0200178 u32 thread_index;
Damjan Marionee721412019-01-27 17:54:11 +0100179 u32 cpu_id;
Damjan Marion0a78fa12019-01-19 23:45:36 +0100180 u32 numa_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700181
Ed Warnickecb9cada2015-12-08 15:45:58 -0700182 /* List of init functions to call, setup by constructors */
183 _vlib_init_function_list_elt_t *init_function_registrations;
Damjan Marione9f929b2017-03-16 11:32:09 +0100184 _vlib_init_function_list_elt_t *worker_init_function_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700185 _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
186 _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
187 _vlib_init_function_list_elt_t *api_init_function_registrations;
188 vlib_config_function_runtime_t *config_function_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700189
Dave Barachdae88b92016-04-19 09:38:35 -0400190 /* control-plane API queue signal pending, length indication */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700191 volatile u32 queue_signal_pending;
Dave Barachdae88b92016-04-19 09:38:35 -0400192 volatile u32 api_queue_nonempty;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400193 void (*queue_signal_callback) (struct vlib_main_t *);
Dave Barachbfdedbd2016-01-20 09:11:55 -0500194 u8 **argv;
Damjan Marionce359db2017-03-16 16:15:38 +0100195
Dave Barach4d1a8662018-09-10 12:31:15 -0400196 /* Top of (worker) dispatch loop callback */
197 volatile void (*worker_thread_main_loop_callback) (struct vlib_main_t *);
198
Damjan Marionce359db2017-03-16 16:15:38 +0100199 /* debugging */
200 volatile int parked_at_barrier;
Dave Barach81481312017-05-16 09:08:14 -0400201
202 /* Attempt to do a post-mortem elog dump */
203 int elog_post_mortem_dump;
204
Colin Tregenza Dancer21596182017-09-04 15:27:49 +0100205 /*
206 * Need to call vlib_worker_thread_node_runtime_update before
207 * releasing worker thread barrier. Only valid in vlib_global_main.
208 */
209 int need_vlib_worker_thread_node_runtime_update;
210
Colin Tregenza Dancereb1ac172017-09-06 20:23:24 +0100211 /*
212 * Barrier epoch - Set to current time, each time barrier_sync or
213 * barrier_release is called with zero recursion.
214 */
215 f64 barrier_epoch;
216
217 /* Earliest barrier can be closed again */
218 f64 barrier_no_close_before;
219
Dave Barachf6c68d72018-11-01 08:12:52 -0400220 /* RPC requests, main thread only */
Dave Barach2877eee2017-12-15 12:22:57 -0500221 uword *pending_rpc_requests;
Dave Barachf6c68d72018-11-01 08:12:52 -0400222 uword *processing_rpc_requests;
223 clib_spinlock_t pending_rpc_lock;
Dave Barach2877eee2017-12-15 12:22:57 -0500224
Ed Warnickecb9cada2015-12-08 15:45:58 -0700225} vlib_main_t;
226
227/* Global main structure. */
Damjan Marion6a7acc22016-12-19 16:28:36 +0100228extern vlib_main_t vlib_global_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700229
Damjan Marione9d52d52017-03-09 15:42:26 +0100230void vlib_worker_loop (vlib_main_t * vm);
231
Ed Warnickecb9cada2015-12-08 15:45:58 -0700232always_inline f64
233vlib_time_now (vlib_main_t * vm)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400234{
235 return clib_time_now (&vm->clib_time);
236}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700237
238always_inline f64
239vlib_time_now_ticks (vlib_main_t * vm, u64 n)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400240{
241 return clib_time_now_internal (&vm->clib_time, n);
242}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700243
244/* Busy wait for specified time. */
245always_inline void
246vlib_time_wait (vlib_main_t * vm, f64 wait)
247{
248 f64 t = vlib_time_now (vm);
249 f64 limit = t + wait;
250 while (t < limit)
251 t = vlib_time_now (vm);
252}
253
254/* Time a piece of code. */
255#define vlib_time_code(vm,body) \
256do { \
257 f64 _t[2]; \
258 _t[0] = vlib_time_now (vm); \
259 do { body; } while (0); \
260 _t[1] = vlib_time_now (vm); \
261 clib_warning ("%.7e", _t[1] - _t[0]); \
262} while (0)
263
264#define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
265({ \
266 uword __vlib_wait_with_timeout = 0; \
267 f64 __vlib_wait_time = 0; \
268 while (! (__vlib_wait_with_timeout = (test)) \
269 && __vlib_wait_time < (timeout_time)) \
270 { \
271 vlib_process_suspend (vm, suspend_time); \
272 __vlib_wait_time += suspend_time; \
273 } \
274 __vlib_wait_with_timeout; \
275})
276
277always_inline void
278vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
279{
280 vm->main_loop_error = error;
281 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
282}
283
284#define vlib_panic_with_msg(vm,args...) \
285 vlib_panic_with_error (vm, clib_error_return (0, args))
286
287always_inline void
288vlib_panic (vlib_main_t * vm)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400289{
290 vlib_panic_with_error (vm, 0);
291}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700292
293always_inline u32
294vlib_vector_input_stats_index (vlib_main_t * vm, word delta)
295{
296 u32 i;
297 i = vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
298 ASSERT (is_pow2 (ARRAY_LEN (vm->vector_counts_per_main_loop)));
299 return (i + delta) & (ARRAY_LEN (vm->vector_counts_per_main_loop) - 1);
300}
301
302/* Estimate input rate based on previous
303 2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
304 samples. */
305always_inline u32
306vlib_last_vectors_per_main_loop (vlib_main_t * vm)
307{
308 u32 i = vlib_vector_input_stats_index (vm, -1);
309 u32 n = vm->vector_counts_per_main_loop[i];
310 return n >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
311}
312
313/* Total ave vector count per iteration of main loop. */
314always_inline f64
315vlib_last_vectors_per_main_loop_as_f64 (vlib_main_t * vm)
316{
317 u32 i = vlib_vector_input_stats_index (vm, -1);
318 u32 v = vm->vector_counts_per_main_loop[i];
319 return (f64) v / (f64) (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
320}
321
322/* Total ave vectors/node count per iteration of main loop. */
323always_inline f64
324vlib_last_vector_length_per_node (vlib_main_t * vm)
325{
326 u32 i = vlib_vector_input_stats_index (vm, -1);
327 u32 v = vm->vector_counts_per_main_loop[i];
328 u32 n = vm->node_counts_per_main_loop[i];
329 return n == 0 ? 0 : (f64) v / (f64) n;
330}
331
Damjan Marion6a7acc22016-12-19 16:28:36 +0100332extern u32 wraps;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333
334always_inline void
335vlib_increment_main_loop_counter (vlib_main_t * vm)
336{
337 u32 i, c, n, v, is_wrap;
338
339 c = vm->main_loop_count++;
340
341 is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
342
343 if (is_wrap)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400344 wraps++;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700345
346 i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
347
348 v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
349 n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
350
351 v += vm->main_loop_vectors_processed;
352 n += vm->main_loop_nodes_processed;
353 vm->main_loop_vectors_processed = 0;
354 vm->main_loop_nodes_processed = 0;
355 vm->vector_counts_per_main_loop[i] = v;
356 vm->node_counts_per_main_loop[i] = n;
Dave Barach903651c2017-10-13 19:16:56 -0400357
358 if (PREDICT_FALSE (vm->main_loop_exit_now))
359 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700360}
361
Dave Barach9b8ffd92016-07-08 08:13:45 -0400362always_inline void vlib_set_queue_signal_callback
363 (vlib_main_t * vm, void (*fp) (vlib_main_t *))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700364{
365 vm->queue_signal_callback = fp;
366}
367
368/* Main routine. */
369int vlib_main (vlib_main_t * vm, unformat_input_t * input);
370
Damjan Marionf55f9b82017-05-10 21:06:28 +0200371/* Thread stacks, for os_get_thread_index */
Damjan Marion6a7acc22016-12-19 16:28:36 +0100372extern u8 **vlib_thread_stacks;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700373
374/* Number of thread stacks that the application needs */
375u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
376
Dave Barach6931f592016-05-13 12:55:01 -0400377extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
378
Dave Barach1201a802018-11-20 12:08:39 -0500379#define VLIB_PCAP_MAJOR_VERSION 1
380#define VLIB_PCAP_MINOR_VERSION 0
381
Ed Warnickecb9cada2015-12-08 15:45:58 -0700382#endif /* included_vlib_main_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400383
384/*
385 * fd.io coding-style-patch-verification: ON
386 *
387 * Local Variables:
388 * eval: (c-set-style "gnu")
389 * End:
390 */