blob: 88ce98bb405e7ee439ff31217209c4d3591320cb [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 Barach5ecd5a52019-02-25 15:27:28 -050061typedef struct
62{
63 int pcap_enable;
64 u32 pcap_sw_if_index;
65 pcap_main_t pcap_main;
Dave Barach9137e542019-09-13 17:47:50 -040066 u32 filter_classify_table_index;
Dave Barach5ecd5a52019-02-25 15:27:28 -050067} vnet_pcap_t;
68
Dave Barach9b8ffd92016-07-08 08:13:45 -040069typedef struct vlib_main_t
70{
Damjan Marionbe3f4d52018-03-27 21:06:10 +020071 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Ed Warnickecb9cada2015-12-08 15:45:58 -070072 /* Instruction level timing state. */
73 clib_time_t clib_time;
Dave Baracha4324a92019-02-19 17:05:30 -050074 /* Offset from main thread time */
75 f64 time_offset;
76 f64 time_last_barrier_release;
Ed Warnickecb9cada2015-12-08 15:45:58 -070077
78 /* Time stamp of last node dispatch. */
79 u64 cpu_time_last_node_dispatch;
80
81 /* Time stamp when main loop was entered (time 0). */
82 u64 cpu_time_main_loop_start;
83
84 /* Incremented once for each main loop. */
85 u32 main_loop_count;
86
87 /* Count of vectors processed this main loop. */
88 u32 main_loop_vectors_processed;
89 u32 main_loop_nodes_processed;
90
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];
96
Dave Barach4d1a8662018-09-10 12:31:15 -040097 /* Main loop hw / sw performance counters */
Dave Barach5f2cfb22019-05-20 10:28:57 -040098 void (**vlib_node_runtime_perf_counter_cbs) (struct vlib_main_t *,
99 u64 *, u64 *,
100 vlib_node_runtime_t *,
101 vlib_frame_t *, int);
102 void (**vlib_node_runtime_perf_counter_cb_tmp) (struct vlib_main_t *,
103 u64 *, u64 *,
104 vlib_node_runtime_t *,
105 vlib_frame_t *, int);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700106 /* Every so often we switch to the next counter. */
107#define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
108
109 /* Jump target to exit main loop with given code. */
110 u32 main_loop_exit_set;
Dave Barach903651c2017-10-13 19:16:56 -0400111 /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
112 volatile u32 main_loop_exit_now;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700113 clib_longjmp_t main_loop_exit;
114#define VLIB_MAIN_LOOP_EXIT_NONE 0
115#define VLIB_MAIN_LOOP_EXIT_PANIC 1
116 /* Exit via CLI. */
117#define VLIB_MAIN_LOOP_EXIT_CLI 2
118
119 /* Error marker to use when exiting main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400120 clib_error_t *main_loop_error;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700121
122 /* Name for e.g. syslog. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400123 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700124
Dave Barach6a5adc32018-07-04 10:56:23 -0400125 /* Start of the heap. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400126 void *heap_base;
Dave Barach6a5adc32018-07-04 10:56:23 -0400127
128 /* Truncated version, to create frame indices */
129 void *heap_aligned_base;
130
131 /* Size of the heap */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700132 uword heap_size;
133
Damjan Mariond50e3472019-01-20 00:03:56 +0100134 /* buffer main structure. */
135 vlib_buffer_main_t *buffer_main;
136
Damjan Marion68b4da62018-09-30 18:26:20 +0200137 /* physical memory main structure. */
138 vlib_physmem_main_t physmem_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700139
140 /* Node graph main structure. */
141 vlib_node_main_t node_main;
142
143 /* Command line interface. */
144 vlib_cli_main_t cli_main;
145
146 /* Packet trace buffer. */
147 vlib_trace_main_t trace_main;
148
Dave Barach3ae28732018-11-16 17:19:00 -0500149 /* Pcap dispatch trace main */
150 pcap_main_t dispatch_pcap_main;
151 uword dispatch_pcap_enable;
Dave Barache5948fb2019-08-29 18:01:30 -0400152 u32 *dispatch_buffer_trace_nodes;
Dave Barach7fff3d22018-11-27 16:52:59 -0500153 u8 *pcap_buffer;
Dave Barach3ae28732018-11-16 17:19:00 -0500154
Dave Barach5ecd5a52019-02-25 15:27:28 -0500155 /* pcap rx / tx tracing */
156 vnet_pcap_t pcap[VLIB_N_RX_TX];
157
Ed Warnickecb9cada2015-12-08 15:45:58 -0700158 /* Error handling. */
159 vlib_error_main_t error_main;
160
161 /* Punt packets to underlying operating system for when fast switching
162 code does not know what to do. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400163 void (*os_punt_frame) (struct vlib_main_t * vm,
164 struct vlib_node_runtime_t * node,
165 vlib_frame_t * frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700166
Ed Warnickecb9cada2015-12-08 15:45:58 -0700167 /* Stream index to use for distribution when MC is enabled. */
168 u32 mc_stream_index;
169
Dave Barach9b8ffd92016-07-08 08:13:45 -0400170 vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700171
172 /* Event logger. */
173 elog_main_t elog_main;
174
Dave Barachc3a06552018-10-01 09:25:32 -0400175 /* Event logger trace flags */
176 int elog_trace_api_messages;
177 int elog_trace_cli_commands;
Dave Barach900cbad2019-01-31 19:12:51 -0500178 int elog_trace_graph_dispatch;
179 int elog_trace_graph_circuit;
180 u32 elog_trace_graph_circuit_node_index;
Dave Barachc3a06552018-10-01 09:25:32 -0400181
Ed Warnickecb9cada2015-12-08 15:45:58 -0700182 /* Node call and return event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400183 elog_event_type_t *node_call_elog_event_types;
184 elog_event_type_t *node_return_elog_event_types;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700185
Dave Barach9b8ffd92016-07-08 08:13:45 -0400186 elog_event_type_t *error_elog_event_types;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700187
188 /* Seed for random number generator. */
189 uword random_seed;
190
191 /* Buffer of random data for various uses. */
192 clib_random_buffer_t random_buffer;
193
194 /* Hash table to record which init functions have been called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400195 uword *init_functions_called;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700196
Damjan Marion0a78fa12019-01-19 23:45:36 +0100197 /* thread, cpu and numa_node indices */
Damjan Marion586afd72017-04-05 19:18:20 +0200198 u32 thread_index;
Damjan Marionee721412019-01-27 17:54:11 +0100199 u32 cpu_id;
Damjan Marion0a78fa12019-01-19 23:45:36 +0100200 u32 numa_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700201
Ed Warnickecb9cada2015-12-08 15:45:58 -0700202 /* List of init functions to call, setup by constructors */
203 _vlib_init_function_list_elt_t *init_function_registrations;
Damjan Marione9f929b2017-03-16 11:32:09 +0100204 _vlib_init_function_list_elt_t *worker_init_function_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700205 _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;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700209
Dave Barachdae88b92016-04-19 09:38:35 -0400210 /* control-plane API queue signal pending, length indication */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700211 volatile u32 queue_signal_pending;
Dave Barachdae88b92016-04-19 09:38:35 -0400212 volatile u32 api_queue_nonempty;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400213 void (*queue_signal_callback) (struct vlib_main_t *);
Dave Barachbfdedbd2016-01-20 09:11:55 -0500214 u8 **argv;
Damjan Marionce359db2017-03-16 16:15:38 +0100215
Dave Barach4d1a8662018-09-10 12:31:15 -0400216 /* Top of (worker) dispatch loop callback */
Dave Barach5f2cfb22019-05-20 10:28:57 -0400217 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;
Dave Barach4d1a8662018-09-10 12:31:15 -0400221
Damjan Marionce359db2017-03-16 16:15:38 +0100222 /* debugging */
223 volatile int parked_at_barrier;
Dave Barach81481312017-05-16 09:08:14 -0400224
225 /* Attempt to do a post-mortem elog dump */
226 int elog_post_mortem_dump;
227
Colin Tregenza Dancer21596182017-09-04 15:27:49 +0100228 /*
229 * Need to call vlib_worker_thread_node_runtime_update before
230 * releasing worker thread barrier. Only valid in vlib_global_main.
231 */
232 int need_vlib_worker_thread_node_runtime_update;
233
Colin Tregenza Dancereb1ac172017-09-06 20:23:24 +0100234 /*
235 * Barrier epoch - Set to current time, each time barrier_sync or
236 * barrier_release is called with zero recursion.
237 */
238 f64 barrier_epoch;
239
240 /* Earliest barrier can be closed again */
241 f64 barrier_no_close_before;
242
Dave Barach80965f52019-03-11 09:57:38 -0400243 /* Need to check the frame queues */
244 volatile uword check_frame_queues;
245
Dave Barachf6c68d72018-11-01 08:12:52 -0400246 /* RPC requests, main thread only */
Dave Barach2877eee2017-12-15 12:22:57 -0500247 uword *pending_rpc_requests;
Dave Barachf6c68d72018-11-01 08:12:52 -0400248 uword *processing_rpc_requests;
249 clib_spinlock_t pending_rpc_lock;
Dave Barach2877eee2017-12-15 12:22:57 -0500250
Ed Warnickecb9cada2015-12-08 15:45:58 -0700251} vlib_main_t;
252
253/* Global main structure. */
Damjan Marion6a7acc22016-12-19 16:28:36 +0100254extern vlib_main_t vlib_global_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700255
Damjan Marione9d52d52017-03-09 15:42:26 +0100256void vlib_worker_loop (vlib_main_t * vm);
257
Ed Warnickecb9cada2015-12-08 15:45:58 -0700258always_inline f64
259vlib_time_now (vlib_main_t * vm)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400260{
Dave Baracha4324a92019-02-19 17:05:30 -0500261 return clib_time_now (&vm->clib_time) + vm->time_offset;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400262}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700263
264always_inline f64
265vlib_time_now_ticks (vlib_main_t * vm, u64 n)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400266{
267 return clib_time_now_internal (&vm->clib_time, n);
268}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700269
270/* Busy wait for specified time. */
271always_inline void
272vlib_time_wait (vlib_main_t * vm, f64 wait)
273{
274 f64 t = vlib_time_now (vm);
275 f64 limit = t + wait;
276 while (t < limit)
277 t = vlib_time_now (vm);
278}
279
280/* Time a piece of code. */
281#define vlib_time_code(vm,body) \
282do { \
283 f64 _t[2]; \
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]); \
288} while (0)
289
290#define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
291({ \
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)) \
296 { \
297 vlib_process_suspend (vm, suspend_time); \
298 __vlib_wait_time += suspend_time; \
299 } \
300 __vlib_wait_with_timeout; \
301})
302
303always_inline void
304vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
305{
306 vm->main_loop_error = error;
307 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
308}
309
310#define vlib_panic_with_msg(vm,args...) \
311 vlib_panic_with_error (vm, clib_error_return (0, args))
312
313always_inline void
314vlib_panic (vlib_main_t * vm)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400315{
316 vlib_panic_with_error (vm, 0);
317}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700318
319always_inline u32
320vlib_vector_input_stats_index (vlib_main_t * vm, word delta)
321{
322 u32 i;
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);
326}
327
328/* Estimate input rate based on previous
329 2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
330 samples. */
331always_inline u32
332vlib_last_vectors_per_main_loop (vlib_main_t * vm)
333{
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;
337}
338
339/* Total ave vector count per iteration of main loop. */
340always_inline f64
341vlib_last_vectors_per_main_loop_as_f64 (vlib_main_t * vm)
342{
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);
346}
347
348/* Total ave vectors/node count per iteration of main loop. */
349always_inline f64
350vlib_last_vector_length_per_node (vlib_main_t * vm)
351{
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;
356}
357
Damjan Marion6a7acc22016-12-19 16:28:36 +0100358extern u32 wraps;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700359
360always_inline void
361vlib_increment_main_loop_counter (vlib_main_t * vm)
362{
363 u32 i, c, n, v, is_wrap;
364
365 c = vm->main_loop_count++;
366
367 is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
368
369 if (is_wrap)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400370 wraps++;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700371
372 i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
373
374 v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
375 n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
376
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;
Dave Barach903651c2017-10-13 19:16:56 -0400383
384 if (PREDICT_FALSE (vm->main_loop_exit_now))
385 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700386}
387
Dave Barach9b8ffd92016-07-08 08:13:45 -0400388always_inline void vlib_set_queue_signal_callback
389 (vlib_main_t * vm, void (*fp) (vlib_main_t *))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700390{
391 vm->queue_signal_callback = fp;
392}
393
394/* Main routine. */
395int vlib_main (vlib_main_t * vm, unformat_input_t * input);
396
Damjan Marionf55f9b82017-05-10 21:06:28 +0200397/* Thread stacks, for os_get_thread_index */
Damjan Marion6a7acc22016-12-19 16:28:36 +0100398extern u8 **vlib_thread_stacks;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700399
400/* Number of thread stacks that the application needs */
401u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
402
Dave Barach6931f592016-05-13 12:55:01 -0400403extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
404
Dave Barach1201a802018-11-20 12:08:39 -0500405#define VLIB_PCAP_MAJOR_VERSION 1
406#define VLIB_PCAP_MINOR_VERSION 0
407
Dave Barache5948fb2019-08-29 18:01:30 -0400408typedef struct
409{
410 u8 *filename;
411 int enable;
412 int status;
413 u32 packets_to_capture;
414 u32 buffer_trace_node_index;
415 u32 buffer_traces_to_capture;
416} vlib_pcap_dispatch_trace_args_t;
417
418int vlib_pcap_dispatch_trace_configure (vlib_pcap_dispatch_trace_args_t *);
419
Ed Warnickecb9cada2015-12-08 15:45:58 -0700420#endif /* included_vlib_main_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400421
422/*
423 * fd.io coding-style-patch-verification: ON
424 *
425 * Local Variables:
426 * eval: (c-set-style "gnu")
427 * End:
428 */