FD.io VPP  v20.09-64-g4f7b92f0a
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 {
83 
84 typedef enum
85 {
90 
91 typedef struct
92 {
93  struct vlib_main_t *vm;
98  vlib_node_runtime_perf_call_type_t call_type;
100 
102 
106 
108 {
110  union
111  {
112  void *v;
114  } u[3];
116 
117 clib_callback_data_typedef (vlib_node_runtime_perf_callback_set_t,
119 
120 typedef struct vlib_main_t
121 {
122  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
123  /* Instruction level timing state. */
125  /* Offset from main thread time */
128 
129  /* Time stamp of last node dispatch. */
131 
132  /* Time stamp when main loop was entered (time 0). */
134 
135  /* Incremented once for each main loop. */
137 
138  /* Count of vectors processed this main loop. */
141 
142  /* Internal node vectors, calls */
147 
148  /* Instantaneous vector rate */
150 
151  /* Main loop hw / sw performance counters */
152  vlib_node_runtime_perf_callback_set_t vlib_node_runtime_perf_callbacks;
153 
154  /* Every so often we switch to the next counter. */
155 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
156 
157  /* Jump target to exit main loop with given code. */
159  /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
162 #define VLIB_MAIN_LOOP_EXIT_NONE 0
163 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
164  /* Exit via CLI. */
165 #define VLIB_MAIN_LOOP_EXIT_CLI 2
166 
167  /* Error marker to use when exiting main loop. */
169 
170  /* Name for e.g. syslog. */
171  char *name;
172 
173  /* Start of the heap. */
174  void *heap_base;
175 
176  /* Truncated version, to create frame indices */
178 
179  /* Size of the heap */
181 
182  /* buffer main structure. */
184 
185  /* physical memory main structure. */
187 
188  /* Node graph main structure. */
190 
191  /* Command line interface. */
193 
194  /* Packet trace buffer. */
196 
197  /* 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. */
225 
226  /* Event logger trace flags */
232 
233  /* Node call and return event types. */
236 
238 
239  /* Seed for random number generator. */
241 
242  /* Buffer of random data for various uses. */
244 
245  /* Hash table to record which init functions have been called. */
247 
248  /* thread, cpu and numa_node indices */
252 
253  /* List of init functions to call, setup by constructors */
254  _vlib_init_function_list_elt_t *init_function_registrations;
255  _vlib_init_function_list_elt_t *worker_init_function_registrations;
256  _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
257  _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
258  _vlib_init_function_list_elt_t *api_init_function_registrations;
260 
261  /* control-plane API queue signal pending, length indication */
264  void (*queue_signal_callback) (struct vlib_main_t *);
265  u8 **argv;
266 
267  /* Top of (worker) dispatch loop callback */
268  void (**volatile worker_thread_main_loop_callbacks)
269  (struct vlib_main_t *, u64 t);
270  void (**volatile worker_thread_main_loop_callback_tmp)
271  (struct vlib_main_t *, u64 t);
273 
274  /* debugging */
275  volatile int parked_at_barrier;
276 
277  /* Attempt to do a post-mortem elog dump */
279 
280  /*
281  * Need to call vlib_worker_thread_node_runtime_update before
282  * releasing worker thread barrier. Only valid in vlib_global_main.
283  */
285 
286  /* Dispatch loop time accounting */
293 
294  /*
295  * Barrier epoch - Set to current time, each time barrier_sync or
296  * barrier_release is called with zero recursion.
297  */
299 
300  /* Earliest barrier can be closed again */
302 
303  /* Barrier counter callback */
304  void (**volatile barrier_perf_callbacks)
305  (struct vlib_main_t *, u64 t, int leave);
306  void (**volatile barrier_perf_callbacks_tmp)
307  (struct vlib_main_t *, u64 t, int leave);
308 
309  /* Need to check the frame queues */
311 
312  /* RPC requests, main thread only */
316 
317  /* buffer fault injector */
320 
321 #ifdef CLIB_SANITIZE_ADDR
322  /* address sanitizer stack save */
323  void *asan_stack_save;
324 #endif
325 } vlib_main_t;
326 
327 /* Global main structure. */
329 
330 void vlib_worker_loop (vlib_main_t * vm);
331 
334 {
335 #if CLIB_DEBUG > 0
336  extern __thread uword __os_thread_index;
337 #endif
338  /*
339  * Make sure folks don't pass &vlib_global_main from a worker thread.
340  */
341  ASSERT (vm->thread_index == __os_thread_index);
342  return clib_time_now (&vm->clib_time) + vm->time_offset;
343 }
344 
347 {
348  return clib_time_now_internal (&vm->clib_time, n);
349 }
350 
351 /* Busy wait for specified time. */
352 always_inline void
354 {
355  f64 t = vlib_time_now (vm);
356  f64 limit = t + wait;
357  while (t < limit)
358  t = vlib_time_now (vm);
359 }
360 
361 /* Time a piece of code. */
362 #define vlib_time_code(vm,body) \
363 do { \
364  f64 _t[2]; \
365  _t[0] = vlib_time_now (vm); \
366  do { body; } while (0); \
367  _t[1] = vlib_time_now (vm); \
368  clib_warning ("%.7e", _t[1] - _t[0]); \
369 } while (0)
370 
371 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
372 ({ \
373  uword __vlib_wait_with_timeout = 0; \
374  f64 __vlib_wait_time = 0; \
375  while (! (__vlib_wait_with_timeout = (test)) \
376  && __vlib_wait_time < (timeout_time)) \
377  { \
378  vlib_process_suspend (vm, suspend_time); \
379  __vlib_wait_time += suspend_time; \
380  } \
381  __vlib_wait_with_timeout; \
382 })
383 
384 always_inline void
386 {
387  vm->main_loop_error = error;
389 }
390 
391 #define vlib_panic_with_msg(vm,args...) \
392  vlib_panic_with_error (vm, clib_error_return (0, args))
393 
394 always_inline void
396 {
397  vlib_panic_with_error (vm, 0);
398 }
399 
400 
403 {
404  u64 vectors;
405  u64 calls;
406 
408 
409  if (PREDICT_FALSE (calls == 0))
410  return 0.0;
411 
413 
414  return (f64) vectors / (f64) calls;
415 }
416 
417 always_inline void
419 {
422 }
423 
424 always_inline void
426 {
427  vm->main_loop_count++;
429 
432 }
433 
436 {
438 }
439 
440 always_inline void
442  vlib_frame_t * frame, uword n, u64 t,
443  vlib_node_runtime_perf_call_type_t call_type)
444 {
447  if (vec_len (v))
448  {
450  .vm = vm,
451  .node = node,
452  .frame = frame,
453  .packets = n,
454  .cpu_time_now = t,
455  .call_type = call_type,
456  };
457  clib_callback_data_call_vec (v, &args);
458  }
459 }
460 
462  (vlib_main_t * vm, void (*fp) (vlib_main_t *))
463 {
465 }
466 
467 /* Main routine. */
468 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
469 
470 /* Thread stacks, for os_get_thread_index */
471 extern u8 **vlib_thread_stacks;
472 
473 /* Number of thread stacks that the application needs */
474 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
475 
476 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
477 
478 #define VLIB_PCAP_MAJOR_VERSION 1
479 #define VLIB_PCAP_MINOR_VERSION 0
480 
481 typedef struct
482 {
484  int enable;
485  int status;
490 
492 
493 #endif /* included_vlib_main_h */
494 
495 /*
496  * fd.io coding-style-patch-verification: ON
497  *
498  * Local Variables:
499  * eval: (c-set-style "gnu")
500  * End:
501  */
f64 time_offset
Definition: main.h:126
_vlib_init_function_list_elt_t * worker_init_function_registrations
Definition: main.h:255
volatile u32 main_loop_count
Definition: main.h:136
pcap_main_t pcap_main
Definition: main.h:73
uword * pending_rpc_requests
Definition: main.h:313
u64 internal_node_vectors
Definition: main.h:143
#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:385
clib_spinlock_t pending_rpc_lock
Definition: main.h:315
u32 mc_stream_index
Definition: main.h:219
static void vlib_time_wait(vlib_main_t *vm, f64 wait)
Definition: main.h:353
_vlib_init_function_list_elt_t * init_function_registrations
Definition: main.h:254
uword * processing_rpc_requests
Definition: main.h:314
u32 max_bytes_per_pkt
Definition: main.h:71
vlib_node_runtime_perf_call_type_t
Definition: main.h:84
int elog_post_mortem_dump
Definition: main.h:278
uword dispatch_pcap_enable
Definition: main.h:199
int elog_trace_cli_commands
Definition: main.h:228
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:186
uword random_seed
Definition: main.h:240
unsigned long u64
Definition: types.h:89
clib_spinlock_t worker_thread_main_loop_callback_lock
Definition: main.h:272
static void vlib_increment_main_loop_counter(vlib_main_t *vm)
Definition: main.h:425
Fixed length block allocator.
f64 loop_interval_start
Definition: main.h:289
PCAP utility definitions.
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:333
int elog_trace_api_messages
Definition: main.h:227
f64 buffer_alloc_success_rate
Definition: main.h:319
static f64 clib_time_now(clib_time_t *c)
Definition: time.h:230
u32 thread_index
Definition: main.h:249
_vlib_init_function_list_elt_t * main_loop_exit_function_registrations
Definition: main.h:257
struct vlib_main_t * vm
Definition: main.h:93
u32 main_loop_exit_set
Definition: main.h:158
f64 loops_per_second
Definition: main.h:290
void vlib_worker_loop(vlib_main_t *vm)
Definition: main.c:1978
#define clib_callback_data_check_and_get(set_)
Check for and get current callback set.
vlib_buffer_main_t * buffer_main
Definition: main.h:183
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:165
void clib_longjmp(clib_longjmp_t *save, uword return_value)
vlib_main_t * vm
Definition: in2out_ed.c:1582
clib_time_t clib_time
Definition: main.h:124
u32 numa_node
Definition: main.h:251
vlib_cli_main_t cli_main
Definition: main.h:192
static u32 vlib_last_vectors_per_main_loop(vlib_main_t *vm)
Definition: main.h:435
unsigned char u8
Definition: types.h:56
u8 data[128]
Definition: ipsec_types.api:89
double f64
Definition: types.h:142
u64 internal_node_calls
Definition: main.h:144
volatile uword check_frame_queues
Definition: main.h:310
volatile int parked_at_barrier
Definition: main.h:275
_vlib_init_function_list_elt_t * api_init_function_registrations
Definition: main.h:258
PCAP main state data structure.
Definition: pcap.h:156
u32 main_loop_vectors_processed
Definition: main.h:139
void * heap_aligned_base
Definition: main.h:177
u32 filter_classify_table_index
Definition: main.h:74
u32 cpu_id
Definition: main.h:250
u8 pcap_rx_enable
Definition: main.h:65
elog_event_type_t * error_elog_event_types
Definition: main.h:237
f64 time_last_barrier_release
Definition: main.h:127
unsigned int u32
Definition: types.h:88
u64 cpu_time_main_loop_start
Definition: main.h:133
u8 trace_filter_enable
Definition: main.h:79
u8 * pcap_buffer
Definition: main.h:201
f64 seconds_per_loop
Definition: main.h:291
static void vlib_set_queue_signal_callback(vlib_main_t *vm, void(*fp)(vlib_main_t *))
Definition: main.h:462
u32 trace_filter_set_index
Definition: main.h:81
char * name
Definition: main.h:171
static void vlib_panic(vlib_main_t *vm)
Definition: main.h:395
void(**volatile worker_thread_main_loop_callback_tmp)(struct vlib_main_t *, u64 t)
Definition: main.h:271
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:2238
elog_event_type_t * node_return_elog_event_types
Definition: main.h:235
vlib_node_runtime_perf_callback_fp_t fp
Definition: main.h:109
#define PREDICT_FALSE(x)
Definition: clib.h:120
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:104
#define always_inline
Definition: ipsec.h:28
u32 vlib_app_num_thread_stacks_needed(void)
Definition: main.c:419
u64 internal_node_calls_last_clear
Definition: main.h:146
u32 pcap_sw_if_index
Definition: main.h:72
uword * init_functions_called
Definition: main.h:246
volatile u32 queue_signal_pending
Definition: main.h:262
f64 damping_constant
Definition: main.h:292
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:307
u8 ** argv
Definition: main.h:265
#define VLIB_MAIN_LOOP_EXIT_PANIC
Definition: main.h:163
int elog_trace_graph_dispatch
Definition: main.h:229
static void vlib_clear_internal_node_vector_rate(vlib_main_t *vm)
Definition: main.h:418
void * heap_base
Definition: main.h:174
Callback multiplex scheme.
int vlib_main(vlib_main_t *vm, unformat_input_t *input)
Definition: main.c:2071
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:269
uword heap_size
Definition: main.h:180
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:152
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1582
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:441
#define ASSERT(truth)
u8 pad1
Definition: main.h:70
_vlib_init_function_list_elt_t * main_loop_enter_function_registrations
Definition: main.h:256
u32 main_loop_nodes_processed
Definition: main.h:140
u64 loops_this_reporting_interval
Definition: main.h:287
u32 elog_trace_graph_circuit_node_index
Definition: main.h:231
vlib_trace_main_t trace_main
Definition: main.h:195
int need_vlib_worker_thread_node_runtime_update
Definition: main.h:284
void(* queue_signal_callback)(struct vlib_main_t *)
Definition: main.h:264
vlib_main_t vlib_global_main
Definition: main.c:1983
void(**volatile barrier_perf_callbacks)(struct vlib_main_t *, u64 t, int leave)
Definition: main.h:305
u32 buffer_alloc_success_seed
Definition: main.h:318
f64 barrier_no_close_before
Definition: main.h:301
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
vlib_node_main_t node_main
Definition: main.h:189
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: in2out_ed.c:1583
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:263
vlib_node_runtime_perf_call_type_t call_type
Definition: main.h:98
f64 barrier_epoch
Definition: main.h:298
elog_event_type_t * node_call_elog_event_types
Definition: main.h:234
volatile u32 main_loop_exit_now
Definition: main.h:160
u64 internal_node_vectors_last_clear
Definition: main.h:145
pcap_main_t dispatch_pcap_main
Definition: main.h:198
f64 loop_interval_end
Definition: main.h:288
static f64 vlib_time_now_ticks(vlib_main_t *vm, u64 n)
Definition: main.h:346
vlib_node_runtime_t * node
Definition: main.h:94
vlib_trace_filter_t trace_filter
Definition: main.h:207
u32 internal_node_last_vectors_per_main_loop
Definition: main.h:149
u8 pcap_tx_enable
Definition: main.h:67
clib_longjmp_t main_loop_exit
Definition: main.h:161
vnet_pcap_t pcap
Definition: main.h:204
vlib_config_function_runtime_t * config_function_registrations
Definition: main.h:259
u8 ** vlib_thread_stacks
Definition: main.c:648
static f64 vlib_internal_node_vector_rate(vlib_main_t *vm)
Definition: main.h:402
int elog_trace_graph_circuit
Definition: main.h:230
clib_random_buffer_t random_buffer
Definition: main.h:243
u32 trace_classify_table_index
Definition: main.h:80
u32 * dispatch_buffer_trace_nodes
Definition: main.h:200
clib_error_t * main_loop_error
Definition: main.h:168
u64 cpu_time_last_node_dispatch
Definition: main.h:130