FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
main.h
Go to the documentation of this file.
1 /*
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 #include <vppinfra/pmc.h>
50 #include <vppinfra/pcap.h>
51 
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 
61 typedef struct
62 {
66 } vnet_pcap_t;
67 
68 typedef struct vlib_main_t
69 {
70  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
71  /* Instruction level timing state. */
73  /* Offset from main thread time */
76 
77  /* Time stamp of last node dispatch. */
79 
80  /* Time stamp when main loop was entered (time 0). */
82 
83  /* Incremented once for each main loop. */
85 
86  /* Count of vectors processed this main loop. */
89 
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). */
95 
96  /* Main loop hw / sw performance counters */
98  u64 *, u64 *);
99 
100  /* Every so often we switch to the next counter. */
101 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
102 
103  /* Jump target to exit main loop with given code. */
105  /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
108 #define VLIB_MAIN_LOOP_EXIT_NONE 0
109 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
110  /* Exit via CLI. */
111 #define VLIB_MAIN_LOOP_EXIT_CLI 2
112 
113  /* Error marker to use when exiting main loop. */
115 
116  /* Name for e.g. syslog. */
117  char *name;
118 
119  /* Start of the heap. */
120  void *heap_base;
121 
122  /* Truncated version, to create frame indices */
124 
125  /* Size of the heap */
127 
128  /* buffer main structure. */
130 
131  /* physical memory main structure. */
133 
134  /* Node graph main structure. */
136 
137  /* Command line interface. */
139 
140  /* Packet trace buffer. */
142 
143  /* Pcap dispatch trace main */
147 
148  /* pcap rx / tx tracing */
150 
156 
157  /* Error handling. */
159 
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);
165 
166  /* Stream index to use for distribution when MC is enabled. */
168 
170 
171  /* Event logger. */
173 
174  /* Event logger trace flags */
180 
181  /* Node call and return event types. */
184 
186 
187  /* Seed for random number generator. */
189 
190  /* Buffer of random data for various uses. */
192 
193  /* Hash table to record which init functions have been called. */
195 
196  /* thread, cpu and numa_node indices */
200 
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;
208 
209  /* control-plane API queue signal pending, length indication */
212  void (*queue_signal_callback) (struct vlib_main_t *);
213  u8 **argv;
214 
215  /* Top of (worker) dispatch loop callback */
216  volatile void (*worker_thread_main_loop_callback) (struct vlib_main_t *);
217 
218  /* debugging */
219  volatile int parked_at_barrier;
220 
221  /* Attempt to do a post-mortem elog dump */
223 
224  /*
225  * Need to call vlib_worker_thread_node_runtime_update before
226  * releasing worker thread barrier. Only valid in vlib_global_main.
227  */
229 
230  /*
231  * Barrier epoch - Set to current time, each time barrier_sync or
232  * barrier_release is called with zero recursion.
233  */
235 
236  /* Earliest barrier can be closed again */
238 
239  /* Need to check the frame queues */
241 
242  /* RPC requests, main thread only */
246 
247 } vlib_main_t;
248 
249 /* Global main structure. */
251 
252 void vlib_worker_loop (vlib_main_t * vm);
253 
256 {
257  return clib_time_now (&vm->clib_time) + vm->time_offset;
258 }
259 
262 {
263  return clib_time_now_internal (&vm->clib_time, n);
264 }
265 
266 /* Busy wait for specified time. */
267 always_inline void
269 {
270  f64 t = vlib_time_now (vm);
271  f64 limit = t + wait;
272  while (t < limit)
273  t = vlib_time_now (vm);
274 }
275 
276 /* Time a piece of code. */
277 #define vlib_time_code(vm,body) \
278 do { \
279  f64 _t[2]; \
280  _t[0] = vlib_time_now (vm); \
281  do { body; } while (0); \
282  _t[1] = vlib_time_now (vm); \
283  clib_warning ("%.7e", _t[1] - _t[0]); \
284 } while (0)
285 
286 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
287 ({ \
288  uword __vlib_wait_with_timeout = 0; \
289  f64 __vlib_wait_time = 0; \
290  while (! (__vlib_wait_with_timeout = (test)) \
291  && __vlib_wait_time < (timeout_time)) \
292  { \
293  vlib_process_suspend (vm, suspend_time); \
294  __vlib_wait_time += suspend_time; \
295  } \
296  __vlib_wait_with_timeout; \
297 })
298 
299 always_inline void
301 {
302  vm->main_loop_error = error;
304 }
305 
306 #define vlib_panic_with_msg(vm,args...) \
307  vlib_panic_with_error (vm, clib_error_return (0, args))
308 
309 always_inline void
311 {
312  vlib_panic_with_error (vm, 0);
313 }
314 
317 {
318  u32 i;
321  return (i + delta) & (ARRAY_LEN (vm->vector_counts_per_main_loop) - 1);
322 }
323 
324 /* Estimate input rate based on previous
325  2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
326  samples. */
329 {
333 }
334 
335 /* Total ave vector count per iteration of main loop. */
338 {
341  return (f64) v / (f64) (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
342 }
343 
344 /* Total ave vectors/node count per iteration of main loop. */
347 {
351  return n == 0 ? 0 : (f64) v / (f64) n;
352 }
353 
354 extern u32 wraps;
355 
356 always_inline void
358 {
359  u32 i, c, n, v, is_wrap;
360 
361  c = vm->main_loop_count++;
362 
363  is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
364 
365  if (is_wrap)
366  wraps++;
367 
368  i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
369 
370  v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
371  n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
372 
374  n += vm->main_loop_nodes_processed;
378  vm->node_counts_per_main_loop[i] = n;
379 
382 }
383 
385  (vlib_main_t * vm, void (*fp) (vlib_main_t *))
386 {
387  vm->queue_signal_callback = fp;
388 }
389 
390 /* Main routine. */
391 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
392 
393 /* Thread stacks, for os_get_thread_index */
394 extern u8 **vlib_thread_stacks;
395 
396 /* Number of thread stacks that the application needs */
397 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
398 
399 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
400 
401 #define VLIB_PCAP_MAJOR_VERSION 1
402 #define VLIB_PCAP_MINOR_VERSION 0
403 
404 #endif /* included_vlib_main_h */
405 
406 /*
407  * fd.io coding-style-patch-verification: ON
408  *
409  * Local Variables:
410  * eval: (c-set-style "gnu")
411  * End:
412  */
f64 time_offset
Definition: main.h:74
_vlib_init_function_list_elt_t * worker_init_function_registrations
Definition: main.h:203
pcap_main_t pcap_main
Definition: main.h:65
static f64 vlib_last_vectors_per_main_loop_as_f64(vlib_main_t *vm)
Definition: main.h:337
uword * pending_rpc_requests
Definition: main.h:243
static void vlib_panic_with_error(vlib_main_t *vm, clib_error_t *error)
Definition: main.h:300
u32 vector_counts_per_main_loop[2]
Definition: main.h:93
clib_spinlock_t pending_rpc_lock
Definition: main.h:245
u32 mc_stream_index
Definition: main.h:167
static void vlib_time_wait(vlib_main_t *vm, f64 wait)
Definition: main.h:268
_vlib_init_function_list_elt_t * init_function_registrations
Definition: main.h:202
uword * processing_rpc_requests
Definition: main.h:244
u32 wraps
Definition: main.c:55
int elog_post_mortem_dump
Definition: main.h:222
uword dispatch_pcap_enable
Definition: main.h:145
int elog_trace_cli_commands
Definition: main.h:176
vlib_one_time_waiting_process_t * procs_waiting_for_mc_stream_join
Definition: main.h:169
vlib_physmem_main_t physmem_main
Definition: main.h:132
uword random_seed
Definition: main.h:188
unsigned long u64
Definition: types.h:89
static void vlib_increment_main_loop_counter(vlib_main_t *vm)
Definition: main.h:357
Fixed length block allocator.
PCAP utility definitions.
void(* vlib_node_runtime_perf_counter_cb)(struct vlib_main_t *, u64 *, u64 *)
Definition: main.h:97
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:255
int elog_trace_api_messages
Definition: main.h:175
static f64 clib_time_now(clib_time_t *c)
Definition: time.h:215
u32 thread_index
Definition: main.h:197
_vlib_init_function_list_elt_t * main_loop_exit_function_registrations
Definition: main.h:205
u32 main_loop_exit_set
Definition: main.h:104
int pcap_enable
Definition: main.h:151
void vlib_worker_loop(vlib_main_t *vm)
Definition: main.c:1919
int i
vlib_buffer_main_t * buffer_main
Definition: main.h:129
#define VLIB_MAIN_LOOP_EXIT_CLI
Definition: main.h:111
void clib_longjmp(clib_longjmp_t *save, uword return_value)
clib_time_t clib_time
Definition: main.h:72
u32 numa_node
Definition: main.h:199
vlib_cli_main_t cli_main
Definition: main.h:138
static u32 vlib_last_vectors_per_main_loop(vlib_main_t *vm)
Definition: main.h:328
unsigned char u8
Definition: types.h:56
u32 pcap_pkts_to_capture
Definition: main.h:155
double f64
Definition: types.h:142
volatile uword check_frame_queues
Definition: main.h:240
static f64 vlib_last_vector_length_per_node(vlib_main_t *vm)
Definition: main.h:346
volatile int parked_at_barrier
Definition: main.h:219
_vlib_init_function_list_elt_t * api_init_function_registrations
Definition: main.h:206
PCAP main state data structure.
Definition: pcap.h:156
i64 word
Definition: types.h:111
#define always_inline
Definition: clib.h:98
static uword pow2_mask(uword x)
Definition: clib.h:220
u32 main_loop_vectors_processed
Definition: main.h:87
void * heap_aligned_base
Definition: main.h:123
#define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
Definition: main.h:101
u32 cpu_id
Definition: main.h:198
elog_event_type_t * error_elog_event_types
Definition: main.h:185
f64 time_last_barrier_release
Definition: main.h:75
unsigned int u32
Definition: types.h:88
u64 cpu_time_main_loop_start
Definition: main.h:81
u8 * pcap_buffer
Definition: main.h:146
u32 node_counts_per_main_loop[2]
Definition: main.h:94
static void vlib_set_queue_signal_callback(vlib_main_t *vm, void(*fp)(vlib_main_t *))
Definition: main.h:385
int pcap_enable
Definition: main.h:63
char * name
Definition: main.h:117
static void vlib_panic(vlib_main_t *vm)
Definition: main.h:310
vlib_error_main_t error_main
Definition: main.h:158
struct vlib_main_t vlib_main_t
struct _unformat_input_t unformat_input_t
elog_event_type_t * node_return_elog_event_types
Definition: main.h:183
#define PREDICT_FALSE(x)
Definition: clib.h:111
u32 vlib_app_num_thread_stacks_needed(void)
Definition: main.c:386
u32 pcap_sw_if_index
Definition: main.h:64
uword * init_functions_called
Definition: main.h:194
volatile u32 queue_signal_pending
Definition: main.h:210
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
u8 ** argv
Definition: main.h:213
#define VLIB_MAIN_LOOP_EXIT_PANIC
Definition: main.h:109
u32 pcap_sw_if_index
Definition: main.h:154
svmdb_client_t * c
vlib_main_t * vm
Definition: buffer.c:312
int elog_trace_graph_dispatch
Definition: main.h:177
void * heap_base
Definition: main.h:120
int vlib_main(vlib_main_t *vm, unformat_input_t *input)
Definition: main.c:1975
elog_main_t elog_main
Definition: main.h:172
uword heap_size
Definition: main.h:126
#define ARRAY_LEN(x)
Definition: clib.h:62
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
#define ASSERT(truth)
_vlib_init_function_list_elt_t * main_loop_enter_function_registrations
Definition: main.h:204
u32 main_loop_nodes_processed
Definition: main.h:88
u32 elog_trace_graph_circuit_node_index
Definition: main.h:179
vlib_trace_main_t trace_main
Definition: main.h:141
int need_vlib_worker_thread_node_runtime_update
Definition: main.h:228
static u32 vlib_vector_input_stats_index(vlib_main_t *vm, word delta)
Definition: main.h:316
pcap_main_t pcap_main
Definition: main.h:152
void(* queue_signal_callback)(struct vlib_main_t *)
Definition: main.h:212
static uword is_pow2(uword x)
Definition: clib.h:235
vlib_main_t vlib_global_main
Definition: main.c:1924
f64 barrier_no_close_before
Definition: main.h:237
vlib_node_main_t node_main
Definition: main.h:135
u64 uword
Definition: types.h:112
void vlib_node_sync_stats(vlib_main_t *vm, vlib_node_t *n)
Definition: main.c:586
static f64 clib_time_now_internal(clib_time_t *c, u64 n)
Definition: time.h:197
volatile u32 api_queue_nonempty
Definition: main.h:211
f64 barrier_epoch
Definition: main.h:234
vnet_pcap_t pcap[VLIB_N_RX_TX]
Definition: main.h:149
elog_event_type_t * node_call_elog_event_types
Definition: main.h:182
volatile u32 main_loop_exit_now
Definition: main.h:106
u8 * pcap_filename
Definition: main.h:153
pcap_main_t dispatch_pcap_main
Definition: main.h:144
static f64 vlib_time_now_ticks(vlib_main_t *vm, u64 n)
Definition: main.h:261
void(* os_punt_frame)(struct vlib_main_t *vm, struct vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: main.h:162
clib_longjmp_t main_loop_exit
Definition: main.h:107
vlib_config_function_runtime_t * config_function_registrations
Definition: main.h:207
u8 ** vlib_thread_stacks
Definition: main.c:607
volatile void(* worker_thread_main_loop_callback)(struct vlib_main_t *)
Definition: main.h:216
u32 main_loop_count
Definition: main.h:84
int elog_trace_graph_circuit
Definition: main.h:178
clib_random_buffer_t random_buffer
Definition: main.h:191
clib_error_t * main_loop_error
Definition: main.h:114
u64 cpu_time_last_node_dispatch
Definition: main.h:78