blob: 0197b4f30cc6e4d4c6cd2957861613017a3f2a14 [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>
49
50#include <pthread.h>
51
52
53/* By default turn off node/error event logging.
54 Override with -DVLIB_ELOG_MAIN_LOOP */
55#ifndef VLIB_ELOG_MAIN_LOOP
56#define VLIB_ELOG_MAIN_LOOP 0
57#endif
58
Dave Barach9b8ffd92016-07-08 08:13:45 -040059typedef struct vlib_main_t
60{
Ed Warnickecb9cada2015-12-08 15:45:58 -070061 /* Instruction level timing state. */
62 clib_time_t clib_time;
63
64 /* Time stamp of last node dispatch. */
65 u64 cpu_time_last_node_dispatch;
66
67 /* Time stamp when main loop was entered (time 0). */
68 u64 cpu_time_main_loop_start;
69
70 /* Incremented once for each main loop. */
71 u32 main_loop_count;
72
73 /* Count of vectors processed this main loop. */
74 u32 main_loop_vectors_processed;
75 u32 main_loop_nodes_processed;
76
77 /* Circular buffer of input node vector counts.
78 Indexed by low bits of
79 (main_loop_count >> VLIB_LOG2_INPUT_VECTORS_PER_MAIN_LOOP). */
80 u32 vector_counts_per_main_loop[2];
81 u32 node_counts_per_main_loop[2];
82
83 /* Every so often we switch to the next counter. */
84#define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
85
86 /* Jump target to exit main loop with given code. */
87 u32 main_loop_exit_set;
88 clib_longjmp_t main_loop_exit;
89#define VLIB_MAIN_LOOP_EXIT_NONE 0
90#define VLIB_MAIN_LOOP_EXIT_PANIC 1
91 /* Exit via CLI. */
92#define VLIB_MAIN_LOOP_EXIT_CLI 2
93
94 /* Error marker to use when exiting main loop. */
Dave Barach9b8ffd92016-07-08 08:13:45 -040095 clib_error_t *main_loop_error;
Ed Warnickecb9cada2015-12-08 15:45:58 -070096
97 /* Name for e.g. syslog. */
Dave Barach9b8ffd92016-07-08 08:13:45 -040098 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -070099
100 /* Start and size of CLIB heap. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400101 void *heap_base;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700102 uword heap_size;
103
Dave Barach9b8ffd92016-07-08 08:13:45 -0400104 vlib_buffer_main_t *buffer_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105
106 vlib_physmem_main_t physmem_main;
107
108 /* Allocate/free buffer memory for DMA transfers, descriptor rings, etc.
109 buffer memory is guaranteed to be cache-aligned. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400110 void *(*os_physmem_alloc_aligned) (vlib_physmem_main_t * pm,
111 uword n_bytes, uword alignment);
112 void (*os_physmem_free) (void *x);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700113
114 /* Node graph main structure. */
115 vlib_node_main_t node_main;
116
117 /* Command line interface. */
118 vlib_cli_main_t cli_main;
119
120 /* Packet trace buffer. */
121 vlib_trace_main_t trace_main;
122
123 /* Error handling. */
124 vlib_error_main_t error_main;
125
126 /* Punt packets to underlying operating system for when fast switching
127 code does not know what to do. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400128 void (*os_punt_frame) (struct vlib_main_t * vm,
129 struct vlib_node_runtime_t * node,
130 vlib_frame_t * frame);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700131
132 /* Multicast distribution. Set to zero for MC disabled. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400133 mc_main_t *mc_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700134
135 /* Stream index to use for distribution when MC is enabled. */
136 u32 mc_stream_index;
137
Dave Barach9b8ffd92016-07-08 08:13:45 -0400138 vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700139
140 /* Event logger. */
141 elog_main_t elog_main;
142
143 /* Node call and return event types. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400144 elog_event_type_t *node_call_elog_event_types;
145 elog_event_type_t *node_return_elog_event_types;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700146
Dave Barach9b8ffd92016-07-08 08:13:45 -0400147 elog_event_type_t *error_elog_event_types;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148
149 /* Seed for random number generator. */
150 uword random_seed;
151
152 /* Buffer of random data for various uses. */
153 clib_random_buffer_t random_buffer;
154
155 /* Hash table to record which init functions have been called. */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400156 uword *init_functions_called;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700157
158 /* to compare with node runtime */
159 u32 cpu_index;
160
161 void **mbuf_alloc_list;
162
163 /* List of init functions to call, setup by constructors */
164 _vlib_init_function_list_elt_t *init_function_registrations;
Damjan Marione9f929b2017-03-16 11:32:09 +0100165 _vlib_init_function_list_elt_t *worker_init_function_registrations;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700166 _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
167 _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
168 _vlib_init_function_list_elt_t *api_init_function_registrations;
169 vlib_config_function_runtime_t *config_function_registrations;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400170 mc_serialize_msg_t *mc_msg_registrations; /* mc_main is a pointer... */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700171
Dave Barachdae88b92016-04-19 09:38:35 -0400172 /* control-plane API queue signal pending, length indication */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700173 volatile u32 queue_signal_pending;
Dave Barachdae88b92016-04-19 09:38:35 -0400174 volatile u32 api_queue_nonempty;
Dave Barach9b8ffd92016-07-08 08:13:45 -0400175 void (*queue_signal_callback) (struct vlib_main_t *);
Dave Barachbfdedbd2016-01-20 09:11:55 -0500176 u8 **argv;
Damjan Marionce359db2017-03-16 16:15:38 +0100177
178 /* debugging */
179 volatile int parked_at_barrier;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700180} vlib_main_t;
181
182/* Global main structure. */
Damjan Marion6a7acc22016-12-19 16:28:36 +0100183extern vlib_main_t vlib_global_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700184
Damjan Marione9d52d52017-03-09 15:42:26 +0100185void vlib_worker_loop (vlib_main_t * vm);
186
Ed Warnickecb9cada2015-12-08 15:45:58 -0700187always_inline f64
188vlib_time_now (vlib_main_t * vm)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400189{
190 return clib_time_now (&vm->clib_time);
191}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700192
193always_inline f64
194vlib_time_now_ticks (vlib_main_t * vm, u64 n)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400195{
196 return clib_time_now_internal (&vm->clib_time, n);
197}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700198
199/* Busy wait for specified time. */
200always_inline void
201vlib_time_wait (vlib_main_t * vm, f64 wait)
202{
203 f64 t = vlib_time_now (vm);
204 f64 limit = t + wait;
205 while (t < limit)
206 t = vlib_time_now (vm);
207}
208
209/* Time a piece of code. */
210#define vlib_time_code(vm,body) \
211do { \
212 f64 _t[2]; \
213 _t[0] = vlib_time_now (vm); \
214 do { body; } while (0); \
215 _t[1] = vlib_time_now (vm); \
216 clib_warning ("%.7e", _t[1] - _t[0]); \
217} while (0)
218
219#define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
220({ \
221 uword __vlib_wait_with_timeout = 0; \
222 f64 __vlib_wait_time = 0; \
223 while (! (__vlib_wait_with_timeout = (test)) \
224 && __vlib_wait_time < (timeout_time)) \
225 { \
226 vlib_process_suspend (vm, suspend_time); \
227 __vlib_wait_time += suspend_time; \
228 } \
229 __vlib_wait_with_timeout; \
230})
231
232always_inline void
233vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
234{
235 vm->main_loop_error = error;
236 clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
237}
238
239#define vlib_panic_with_msg(vm,args...) \
240 vlib_panic_with_error (vm, clib_error_return (0, args))
241
242always_inline void
243vlib_panic (vlib_main_t * vm)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400244{
245 vlib_panic_with_error (vm, 0);
246}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700247
248always_inline u32
249vlib_vector_input_stats_index (vlib_main_t * vm, word delta)
250{
251 u32 i;
252 i = vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
253 ASSERT (is_pow2 (ARRAY_LEN (vm->vector_counts_per_main_loop)));
254 return (i + delta) & (ARRAY_LEN (vm->vector_counts_per_main_loop) - 1);
255}
256
257/* Estimate input rate based on previous
258 2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
259 samples. */
260always_inline u32
261vlib_last_vectors_per_main_loop (vlib_main_t * vm)
262{
263 u32 i = vlib_vector_input_stats_index (vm, -1);
264 u32 n = vm->vector_counts_per_main_loop[i];
265 return n >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
266}
267
268/* Total ave vector count per iteration of main loop. */
269always_inline f64
270vlib_last_vectors_per_main_loop_as_f64 (vlib_main_t * vm)
271{
272 u32 i = vlib_vector_input_stats_index (vm, -1);
273 u32 v = vm->vector_counts_per_main_loop[i];
274 return (f64) v / (f64) (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
275}
276
277/* Total ave vectors/node count per iteration of main loop. */
278always_inline f64
279vlib_last_vector_length_per_node (vlib_main_t * vm)
280{
281 u32 i = vlib_vector_input_stats_index (vm, -1);
282 u32 v = vm->vector_counts_per_main_loop[i];
283 u32 n = vm->node_counts_per_main_loop[i];
284 return n == 0 ? 0 : (f64) v / (f64) n;
285}
286
Damjan Marion6a7acc22016-12-19 16:28:36 +0100287extern u32 wraps;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700288
289always_inline void
290vlib_increment_main_loop_counter (vlib_main_t * vm)
291{
292 u32 i, c, n, v, is_wrap;
293
294 c = vm->main_loop_count++;
295
296 is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
297
298 if (is_wrap)
Dave Barach9b8ffd92016-07-08 08:13:45 -0400299 wraps++;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700300
301 i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
302
303 v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
304 n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
305
306 v += vm->main_loop_vectors_processed;
307 n += vm->main_loop_nodes_processed;
308 vm->main_loop_vectors_processed = 0;
309 vm->main_loop_nodes_processed = 0;
310 vm->vector_counts_per_main_loop[i] = v;
311 vm->node_counts_per_main_loop[i] = n;
312}
313
Dave Barach9b8ffd92016-07-08 08:13:45 -0400314always_inline void vlib_set_queue_signal_callback
315 (vlib_main_t * vm, void (*fp) (vlib_main_t *))
Ed Warnickecb9cada2015-12-08 15:45:58 -0700316{
317 vm->queue_signal_callback = fp;
318}
319
320/* Main routine. */
321int vlib_main (vlib_main_t * vm, unformat_input_t * input);
322
323/* Thread stacks, for os_get_cpu_number */
Damjan Marion6a7acc22016-12-19 16:28:36 +0100324extern u8 **vlib_thread_stacks;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700325
326/* Number of thread stacks that the application needs */
327u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
328
Dave Barach6931f592016-05-13 12:55:01 -0400329extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
330
Ed Warnickecb9cada2015-12-08 15:45:58 -0700331#endif /* included_vlib_main_h */
Dave Barach9b8ffd92016-07-08 08:13:45 -0400332
333/*
334 * fd.io coding-style-patch-verification: ON
335 *
336 * Local Variables:
337 * eval: (c-set-style "gnu")
338 * End:
339 */