FD.io VPP  v21.01.1
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/callback_data.h>
44 #include <vppinfra/elog.h>
45 #include <vppinfra/format.h>
46 #include <vppinfra/longjmp.h>
47 #include <vppinfra/pool.h>
48 #include <vppinfra/random_buffer.h>
49 #include <vppinfra/time.h>
50 #include <vppinfra/pmc.h>
51 #include <vppinfra/pcap.h>
52 
53 #include <pthread.h>
54 
55 
56 /* By default turn off node/error event logging.
57  Override with -DVLIB_ELOG_MAIN_LOOP */
58 #ifndef VLIB_ELOG_MAIN_LOOP
59 #define VLIB_ELOG_MAIN_LOOP 0
60 #endif
61 
62 typedef struct
63 {
64  /* Trace RX pkts */
66  /* Trace TX pkts */
68  /* Trace drop pkts */
75 } vnet_pcap_t;
76 
77 typedef struct
78 {
82 
83 typedef enum
84 {
89 
90 typedef struct
91 {
92  struct vlib_main_t *vm;
97  vlib_node_runtime_perf_call_type_t call_type;
99 
101 
105 
107 {
109  union
110  {
111  void *v;
113  } u[3];
115 
116 clib_callback_data_typedef (vlib_node_runtime_perf_callback_set_t,
118 
119 typedef struct vlib_main_t
120 {
121  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
122  /* Instruction level timing state. */
124  /* Offset from main thread time */
127 
128  /* Time stamp of last node dispatch. */
130 
131  /* Time stamp when main loop was entered (time 0). */
133 
134  /* Incremented once for each main loop. */
136 
137  /* Count of vectors processed this main loop. */
140 
141  /* Internal node vectors, calls */
146 
147  /* Instantaneous vector rate */
149 
150  /* Main loop hw / sw performance counters */
151  vlib_node_runtime_perf_callback_set_t vlib_node_runtime_perf_callbacks;
152 
153  /* Every so often we switch to the next counter. */
154 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
155 
156  /* Jump target to exit main loop with given code. */
158  /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
161 #define VLIB_MAIN_LOOP_EXIT_NONE 0
162 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
163  /* Exit via CLI. */
164 #define VLIB_MAIN_LOOP_EXIT_CLI 2
165 
166  /* Error marker to use when exiting main loop. */
168 
169  /* Name for e.g. syslog. */
170  char *name;
171 
172  /* Start of the heap. */
173  void *heap_base;
174 
175  /* Truncated version, to create frame indices */
177 
178  /* Size of the heap */
180 
181  /* buffer main structure. */
183 
184  /* physical memory main structure. */
186 
187  /* Node graph main structure. */
189 
190  /* Command line interface. */
192 
193  /* Packet trace buffer. */
195 
196  /* Pcap dispatch trace main */
202 
203  /* pcap rx / tx tracing */
205 
206  /* Packet trace capture filter */
208 
209  /* Error handling. */
211 
212  /* Punt packets to underlying operating system for when fast switching
213  code does not know what to do. */
214  void (*os_punt_frame) (struct vlib_main_t * vm,
215  struct vlib_node_runtime_t * node,
216  vlib_frame_t * frame);
217 
218  /* Stream index to use for distribution when MC is enabled. */
220 
222 
223  /* Event logger. */
226 
227  /* Event logger trace flags */
233 
234  /* Node call and return event types. */
237 
239 
240  /* Seed for random number generator. */
242 
243  /* Buffer of random data for various uses. */
245 
246  /* Hash table to record which init functions have been called. */
248 
249  /* thread, cpu and numa_node indices */
253 
254  /* List of init functions to call, setup by constructors */
255  _vlib_init_function_list_elt_t *init_function_registrations;
256  _vlib_init_function_list_elt_t *worker_init_function_registrations;
257  _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
258  _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
259  _vlib_init_function_list_elt_t *api_init_function_registrations;
261 
262  /* control-plane API queue signal pending, length indication */
265  void (*queue_signal_callback) (struct vlib_main_t *);
266  u8 **argv;
267 
268  /* Top of (worker) dispatch loop callback */
269  void (**volatile worker_thread_main_loop_callbacks)
270  (struct vlib_main_t *, u64 t);
271  void (**volatile worker_thread_main_loop_callback_tmp)
272  (struct vlib_main_t *, u64 t);
274 
275  /* debugging */
276  volatile int parked_at_barrier;
277 
278  /* Attempt to do a post-mortem elog dump */
280 
281  /*
282  * Need to call vlib_worker_thread_node_runtime_update before
283  * releasing worker thread barrier. Only valid in vlib_global_main.
284  */
286 
287  /* Dispatch loop time accounting */
294 
295  /*
296  * Barrier epoch - Set to current time, each time barrier_sync or
297  * barrier_release is called with zero recursion.
298  */
300 
301  /* Earliest barrier can be closed again */
303 
304  /* Barrier counter callback */
305  void (**volatile barrier_perf_callbacks)
306  (struct vlib_main_t *, u64 t, int leave);
307  void (**volatile barrier_perf_callbacks_tmp)
308  (struct vlib_main_t *, u64 t, int leave);
309 
310  /* Need to check the frame queues */
312 
313  /* RPC requests, main thread only */
317 
318  /* buffer fault injector */
321 
322 #ifdef CLIB_SANITIZE_ADDR
323  /* address sanitizer stack save */
324  void *asan_stack_save;
325 #endif
326 } vlib_main_t;
327 
328 /* Global main structure. */
330 
331 void vlib_worker_loop (vlib_main_t * vm);
332 
335 {
336 #if CLIB_DEBUG > 0
337  extern __thread uword __os_thread_index;
338 #endif
339  /*
340  * Make sure folks don't pass &vlib_global_main from a worker thread.
341  */
342  ASSERT (vm->thread_index == __os_thread_index);
343  return clib_time_now (&vm->clib_time) + vm->time_offset;
344 }
345 
348 {
349  return clib_time_now_internal (&vm->clib_time, n);
350 }
351 
352 /* Busy wait for specified time. */
353 always_inline void
355 {
356  f64 t = vlib_time_now (vm);
357  f64 limit = t + wait;
358  while (t < limit)
359  t = vlib_time_now (vm);
360 }
361 
362 /* Time a piece of code. */
363 #define vlib_time_code(vm,body) \
364 do { \
365  f64 _t[2]; \
366  _t[0] = vlib_time_now (vm); \
367  do { body; } while (0); \
368  _t[1] = vlib_time_now (vm); \
369  clib_warning ("%.7e", _t[1] - _t[0]); \
370 } while (0)
371 
372 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
373 ({ \
374  uword __vlib_wait_with_timeout = 0; \
375  f64 __vlib_wait_time = 0; \
376  while (! (__vlib_wait_with_timeout = (test)) \
377  && __vlib_wait_time < (timeout_time)) \
378  { \
379  vlib_process_suspend (vm, suspend_time); \
380  __vlib_wait_time += suspend_time; \
381  } \
382  __vlib_wait_with_timeout; \
383 })
384 
385 always_inline void
387 {
388  vm->main_loop_error = error;
390 }
391 
392 #define vlib_panic_with_msg(vm,args...) \
393  vlib_panic_with_error (vm, clib_error_return (0, args))
394 
395 always_inline void
397 {
398  vlib_panic_with_error (vm, 0);
399 }
400 
401 
404 {
405  u64 vectors;
406  u64 calls;
407 
409 
410  if (PREDICT_FALSE (calls == 0))
411  return 0.0;
412 
414 
415  return (f64) vectors / (f64) calls;
416 }
417 
418 always_inline void
420 {
423 }
424 
425 always_inline void
427 {
428  vm->main_loop_count++;
430 
433 }
434 
437 {
439 }
440 
441 always_inline void
443  vlib_frame_t * frame, uword n, u64 t,
444  vlib_node_runtime_perf_call_type_t call_type)
445 {
448  if (vec_len (v))
449  {
451  .vm = vm,
452  .node = node,
453  .frame = frame,
454  .packets = n,
455  .cpu_time_now = t,
456  .call_type = call_type,
457  };
458  clib_callback_data_call_vec (v, &args);
459  }
460 }
461 
463  (vlib_main_t * vm, void (*fp) (vlib_main_t *))
464 {
466 }
467 
468 /* Main routine. */
469 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
470 
471 /* Thread stacks, for os_get_thread_index */
472 extern u8 **vlib_thread_stacks;
473 
474 /* Number of thread stacks that the application needs */
475 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
476 
477 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
478 
479 #define VLIB_PCAP_MAJOR_VERSION 1
480 #define VLIB_PCAP_MINOR_VERSION 0
481 
482 typedef struct
483 {
485  int enable;
486  int status;
492 
496 
497 #endif /* included_vlib_main_h */
498 
499 /*
500  * fd.io coding-style-patch-verification: ON
501  *
502  * Local Variables:
503  * eval: (c-set-style "gnu")
504  * End:
505  */
f64 time_offset
Definition: main.h:125
_vlib_init_function_list_elt_t * worker_init_function_registrations
Definition: main.h:256
volatile u32 main_loop_count
Definition: main.h:135
pcap_main_t pcap_main
Definition: main.h:73
uword * pending_rpc_requests
Definition: main.h:314
u64 internal_node_vectors
Definition: main.h:142
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
static void vlib_panic_with_error(vlib_main_t *vm, clib_error_t *error)
Definition: main.h:386
clib_spinlock_t pending_rpc_lock
Definition: main.h:316
u32 mc_stream_index
Definition: main.h:219
static void vlib_time_wait(vlib_main_t *vm, f64 wait)
Definition: main.h:354
_vlib_init_function_list_elt_t * init_function_registrations
Definition: main.h:255
u32 classify_table_index
Definition: main.h:80
uword * processing_rpc_requests
Definition: main.h:315
u32 max_bytes_per_pkt
Definition: main.h:71
vlib_node_runtime_perf_call_type_t
Definition: main.h:83
int elog_post_mortem_dump
Definition: main.h:279
uword dispatch_pcap_enable
Definition: main.h:198
int elog_trace_cli_commands
Definition: main.h:229
vlib_one_time_waiting_process_t * procs_waiting_for_mc_stream_join
Definition: main.h:221
vlib_physmem_main_t physmem_main
Definition: main.h:185
uword random_seed
Definition: main.h:241
unsigned long u64
Definition: types.h:89
clib_spinlock_t worker_thread_main_loop_callback_lock
Definition: main.h:273
static void vlib_increment_main_loop_counter(vlib_main_t *vm)
Definition: main.h:426
Fixed length block allocator.
f64 loop_interval_start
Definition: main.h:290
PCAP utility definitions.
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:334
int elog_trace_api_messages
Definition: main.h:228
f64 buffer_alloc_success_rate
Definition: main.h:320
static f64 clib_time_now(clib_time_t *c)
Definition: time.h:230
u32 thread_index
Definition: main.h:250
_vlib_init_function_list_elt_t * main_loop_exit_function_registrations
Definition: main.h:258
struct vlib_main_t * vm
Definition: main.h:92
u32 main_loop_exit_set
Definition: main.h:157
f64 loops_per_second
Definition: main.h:291
void vlib_worker_loop(vlib_main_t *vm)
Definition: main.c:2036
#define clib_callback_data_check_and_get(set_)
Check for and get current callback set.
vlib_buffer_main_t * buffer_main
Definition: main.h:182
clib_callback_data_typedef(vlib_node_runtime_perf_callback_set_t, vlib_node_runtime_perf_callback_data_t)
#define VLIB_MAIN_LOOP_EXIT_CLI
Definition: main.h:164
vlib_main_t * vlib_get_main_not_inline(void)
Definition: main.c:2582
void clib_longjmp(clib_longjmp_t *save, uword return_value)
vlib_main_t * vm
Definition: in2out_ed.c:1580
clib_time_t clib_time
Definition: main.h:123
u32 numa_node
Definition: main.h:252
u32 configured_elog_ring_size
Definition: main.h:225
elog_main_t * vlib_get_elog_main_not_inline()
Definition: main.c:2588
vlib_cli_main_t cli_main
Definition: main.h:191
static u32 vlib_last_vectors_per_main_loop(vlib_main_t *vm)
Definition: main.h:436
unsigned char u8
Definition: types.h:56
u8 data[128]
Definition: ipsec_types.api:90
double f64
Definition: types.h:142
u64 internal_node_calls
Definition: main.h:143
volatile uword check_frame_queues
Definition: main.h:311
volatile int parked_at_barrier
Definition: main.h:276
_vlib_init_function_list_elt_t * api_init_function_registrations
Definition: main.h:259
PCAP main state data structure.
Definition: pcap.h:156
u32 main_loop_vectors_processed
Definition: main.h:138
void * heap_aligned_base
Definition: main.h:176
u32 filter_classify_table_index
Definition: main.h:74
u32 cpu_id
Definition: main.h:251
u8 pcap_rx_enable
Definition: main.h:65
elog_event_type_t * error_elog_event_types
Definition: main.h:238
f64 time_last_barrier_release
Definition: main.h:126
unsigned int u32
Definition: types.h:88
u64 cpu_time_main_loop_start
Definition: main.h:132
u8 trace_filter_enable
Definition: main.h:79
u8 * pcap_buffer
Definition: main.h:201
f64 seconds_per_loop
Definition: main.h:292
static void vlib_set_queue_signal_callback(vlib_main_t *vm, void(*fp)(vlib_main_t *))
Definition: main.h:463
char * name
Definition: main.h:170
Definition: cJSON.c:84
static void vlib_panic(vlib_main_t *vm)
Definition: main.h:396
void(**volatile worker_thread_main_loop_callback_tmp)(struct vlib_main_t *, u64 t)
Definition: main.h:272
u8 pcap_drop_enable
Definition: main.h:69
vlib_error_main_t error_main
Definition: main.h:210
struct vlib_main_t vlib_main_t
struct _unformat_input_t unformat_input_t
int vlib_pcap_dispatch_trace_configure(vlib_pcap_dispatch_trace_args_t *)
Definition: main.c:2296
elog_event_type_t * node_return_elog_event_types
Definition: main.h:236
vlib_node_runtime_perf_callback_fp_t fp
Definition: main.h:108
uword dispatch_pcap_postmortem
Definition: main.h:199
#define PREDICT_FALSE(x)
Definition: clib.h:121
void(* vlib_node_runtime_perf_callback_fp_t)(struct vlib_node_runtime_perf_callback_data_t *data, vlib_node_runtime_perf_callback_args_t *args)
Definition: main.h:103
#define always_inline
Definition: ipsec.h:28
u32 vlib_app_num_thread_stacks_needed(void)
Definition: main.c:460
u64 internal_node_calls_last_clear
Definition: main.h:145
u32 pcap_sw_if_index
Definition: main.h:72
uword * init_functions_called
Definition: main.h:247
volatile u32 queue_signal_pending
Definition: main.h:263
f64 damping_constant
Definition: main.h:293
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
void(**volatile barrier_perf_callbacks_tmp)(struct vlib_main_t *, u64 t, int leave)
Definition: main.h:308
u8 ** argv
Definition: main.h:266
#define VLIB_MAIN_LOOP_EXIT_PANIC
Definition: main.h:162
int elog_trace_graph_dispatch
Definition: main.h:230
static void vlib_clear_internal_node_vector_rate(vlib_main_t *vm)
Definition: main.h:419
void * heap_base
Definition: main.h:173
Callback multiplex scheme.
int vlib_main(vlib_main_t *vm, unformat_input_t *input)
Definition: main.c:2130
elog_main_t elog_main
Definition: main.h:224
void(**volatile worker_thread_main_loop_callbacks)(struct vlib_main_t *, u64 t)
Definition: main.h:270
uword heap_size
Definition: main.h:179
struct vlib_node_runtime_perf_callback_data_t vlib_node_runtime_perf_callback_data_t
vlib_node_runtime_perf_callback_set_t vlib_node_runtime_perf_callbacks
Definition: main.h:151
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1580
static void vlib_node_runtime_perf_counter(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame, uword n, u64 t, vlib_node_runtime_perf_call_type_t call_type)
Definition: main.h:442
#define ASSERT(truth)
u8 pad1
Definition: main.h:70
_vlib_init_function_list_elt_t * main_loop_enter_function_registrations
Definition: main.h:257
u32 main_loop_nodes_processed
Definition: main.h:139
u64 loops_this_reporting_interval
Definition: main.h:288
u32 elog_trace_graph_circuit_node_index
Definition: main.h:232
vlib_trace_main_t trace_main
Definition: main.h:194
int need_vlib_worker_thread_node_runtime_update
Definition: main.h:285
void(* queue_signal_callback)(struct vlib_main_t *)
Definition: main.h:265
vlib_main_t vlib_global_main
Definition: main.c:2041
void(**volatile barrier_perf_callbacks)(struct vlib_main_t *, u64 t, int leave)
Definition: main.h:306
u32 buffer_alloc_success_seed
Definition: main.h:319
f64 barrier_no_close_before
Definition: main.h:302
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
vlib_node_main_t node_main
Definition: main.h:188
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: in2out_ed.c:1581
u64 uword
Definition: types.h:112
void vlib_node_sync_stats(vlib_main_t *vm, vlib_node_t *n)
Definition: main.c:599
static f64 clib_time_now_internal(clib_time_t *c, u64 n)
Definition: time.h:210
#define clib_callback_data_call_vec(vec_,...)
Iterate and call a callback vector.
volatile u32 api_queue_nonempty
Definition: main.h:264
vlib_node_runtime_perf_call_type_t call_type
Definition: main.h:97
f64 barrier_epoch
Definition: main.h:299
elog_event_type_t * node_call_elog_event_types
Definition: main.h:235
volatile u32 main_loop_exit_now
Definition: main.h:159
u64 internal_node_vectors_last_clear
Definition: main.h:144
pcap_main_t dispatch_pcap_main
Definition: main.h:197
f64 loop_interval_end
Definition: main.h:289
static f64 vlib_time_now_ticks(vlib_main_t *vm, u64 n)
Definition: main.h:347
vlib_node_runtime_t * node
Definition: main.h:93
vlib_trace_filter_t trace_filter
Definition: main.h:207
u32 internal_node_last_vectors_per_main_loop
Definition: main.h:148
u8 pcap_tx_enable
Definition: main.h:67
clib_longjmp_t main_loop_exit
Definition: main.h:160
vnet_pcap_t pcap
Definition: main.h:204
vlib_config_function_runtime_t * config_function_registrations
Definition: main.h:260
u8 ** vlib_thread_stacks
Definition: main.c:658
static f64 vlib_internal_node_vector_rate(vlib_main_t *vm)
Definition: main.h:403
int elog_trace_graph_circuit
Definition: main.h:231
clib_random_buffer_t random_buffer
Definition: main.h:244
u32 * dispatch_buffer_trace_nodes
Definition: main.h:200
clib_error_t * main_loop_error
Definition: main.h:167
u64 cpu_time_last_node_dispatch
Definition: main.h:129