FD.io VPP  v18.01.2-1-g9b554f3
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 
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 
59 typedef struct vlib_main_t
60 {
61  /* Instruction level timing state. */
63 
64  /* Time stamp of last node dispatch. */
66 
67  /* Time stamp when main loop was entered (time 0). */
69 
70  /* Incremented once for each main loop. */
72 
73  /* Count of vectors processed this main loop. */
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). */
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. */
88  /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
91 #define VLIB_MAIN_LOOP_EXIT_NONE 0
92 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
93  /* Exit via CLI. */
94 #define VLIB_MAIN_LOOP_EXIT_CLI 2
95 
96  /* Error marker to use when exiting main loop. */
98 
99  /* Name for e.g. syslog. */
100  char *name;
101 
102  /* Start and size of CLIB heap. */
103  void *heap_base;
105 
107 
109 
110  /* Allocate/free buffer memory for DMA transfers, descriptor rings, etc.
111  buffer memory is guaranteed to be cache-aligned. */
112 
113  clib_error_t *(*os_physmem_region_alloc) (struct vlib_main_t * vm,
114  char *name, u32 size,
115  u8 numa_node, u32 flags,
117  idx);
118 
121 
122  void *(*os_physmem_alloc_aligned) (struct vlib_main_t * vm,
124  uword n_bytes, uword alignment);
125  void (*os_physmem_free) (struct vlib_main_t * vm,
126  vlib_physmem_region_index_t idx, void *x);
127 
128  /* Node graph main structure. */
130 
131  /* Command line interface. */
133 
134  /* Packet trace buffer. */
136 
137  /* Error handling. */
139 
140  /* Punt packets to underlying operating system for when fast switching
141  code does not know what to do. */
142  void (*os_punt_frame) (struct vlib_main_t * vm,
143  struct vlib_node_runtime_t * node,
144  vlib_frame_t * frame);
145 
146  /* Multicast distribution. Set to zero for MC disabled. */
148 
149  /* Stream index to use for distribution when MC is enabled. */
151 
153 
154  /* Event logger. */
156 
157  /* Node call and return event types. */
160 
162 
163  /* Seed for random number generator. */
165 
166  /* Buffer of random data for various uses. */
168 
169  /* Hash table to record which init functions have been called. */
171 
172  /* to compare with node runtime */
174 
176 
177  /* List of init functions to call, setup by constructors */
178  _vlib_init_function_list_elt_t *init_function_registrations;
179  _vlib_init_function_list_elt_t *worker_init_function_registrations;
180  _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
181  _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
182  _vlib_init_function_list_elt_t *api_init_function_registrations;
184  mc_serialize_msg_t *mc_msg_registrations; /* mc_main is a pointer... */
185 
186  /* control-plane API queue signal pending, length indication */
189  void (*queue_signal_callback) (struct vlib_main_t *);
190  u8 **argv;
191 
192  /* debugging */
193  volatile int parked_at_barrier;
194 
195  /* Attempt to do a post-mortem elog dump */
197 
198  /*
199  * Need to call vlib_worker_thread_node_runtime_update before
200  * releasing worker thread barrier. Only valid in vlib_global_main.
201  */
203 
204  /*
205  * Barrier epoch - Set to current time, each time barrier_sync or
206  * barrier_release is called with zero recursion.
207  */
209 
210  /* Earliest barrier can be closed again */
212 
213  /* Vector of pending RPC requests */
215 
216 } vlib_main_t;
217 
218 /* Global main structure. */
220 
221 void vlib_worker_loop (vlib_main_t * vm);
222 
225 {
226  return clib_time_now (&vm->clib_time);
227 }
228 
231 {
232  return clib_time_now_internal (&vm->clib_time, n);
233 }
234 
235 /* Busy wait for specified time. */
236 always_inline void
238 {
239  f64 t = vlib_time_now (vm);
240  f64 limit = t + wait;
241  while (t < limit)
242  t = vlib_time_now (vm);
243 }
244 
245 /* Time a piece of code. */
246 #define vlib_time_code(vm,body) \
247 do { \
248  f64 _t[2]; \
249  _t[0] = vlib_time_now (vm); \
250  do { body; } while (0); \
251  _t[1] = vlib_time_now (vm); \
252  clib_warning ("%.7e", _t[1] - _t[0]); \
253 } while (0)
254 
255 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test) \
256 ({ \
257  uword __vlib_wait_with_timeout = 0; \
258  f64 __vlib_wait_time = 0; \
259  while (! (__vlib_wait_with_timeout = (test)) \
260  && __vlib_wait_time < (timeout_time)) \
261  { \
262  vlib_process_suspend (vm, suspend_time); \
263  __vlib_wait_time += suspend_time; \
264  } \
265  __vlib_wait_with_timeout; \
266 })
267 
268 always_inline void
270 {
271  vm->main_loop_error = error;
273 }
274 
275 #define vlib_panic_with_msg(vm,args...) \
276  vlib_panic_with_error (vm, clib_error_return (0, args))
277 
278 always_inline void
280 {
281  vlib_panic_with_error (vm, 0);
282 }
283 
286 {
287  u32 i;
290  return (i + delta) & (ARRAY_LEN (vm->vector_counts_per_main_loop) - 1);
291 }
292 
293 /* Estimate input rate based on previous
294  2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
295  samples. */
298 {
302 }
303 
304 /* Total ave vector count per iteration of main loop. */
307 {
310  return (f64) v / (f64) (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
311 }
312 
313 /* Total ave vectors/node count per iteration of main loop. */
316 {
320  return n == 0 ? 0 : (f64) v / (f64) n;
321 }
322 
323 extern u32 wraps;
324 
325 always_inline void
327 {
328  u32 i, c, n, v, is_wrap;
329 
330  c = vm->main_loop_count++;
331 
332  is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
333 
334  if (is_wrap)
335  wraps++;
336 
337  i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
338 
339  v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
340  n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
341 
343  n += vm->main_loop_nodes_processed;
347  vm->node_counts_per_main_loop[i] = n;
348 
351 }
352 
354  (vlib_main_t * vm, void (*fp) (vlib_main_t *))
355 {
356  vm->queue_signal_callback = fp;
357 }
358 
359 /* Main routine. */
360 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
361 
362 /* Thread stacks, for os_get_thread_index */
363 extern u8 **vlib_thread_stacks;
364 
365 /* Number of thread stacks that the application needs */
366 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
367 
368 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
369 
370 #endif /* included_vlib_main_h */
371 
372 /*
373  * fd.io coding-style-patch-verification: ON
374  *
375  * Local Variables:
376  * eval: (c-set-style "gnu")
377  * End:
378  */
_vlib_init_function_list_elt_t * worker_init_function_registrations
Definition: main.h:179
static f64 vlib_last_vectors_per_main_loop_as_f64(vlib_main_t *vm)
Definition: main.h:306
uword * pending_rpc_requests
Definition: main.h:214
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:337
static void vlib_panic_with_error(vlib_main_t *vm, clib_error_t *error)
Definition: main.h:269
u32 vector_counts_per_main_loop[2]
Definition: main.h:80
u32 mc_stream_index
Definition: main.h:150
static void vlib_time_wait(vlib_main_t *vm, f64 wait)
Definition: main.h:237
_vlib_init_function_list_elt_t * init_function_registrations
Definition: main.h:178
u32 wraps
Definition: main.c:55
int elog_post_mortem_dump
Definition: main.h:196
void(* os_physmem_region_free)(struct vlib_main_t *vm, vlib_physmem_region_index_t idx)
Definition: main.h:119
vlib_one_time_waiting_process_t * procs_waiting_for_mc_stream_join
Definition: main.h:152
vlib_physmem_main_t physmem_main
Definition: main.h:108
uword random_seed
Definition: main.h:164
static void vlib_increment_main_loop_counter(vlib_main_t *vm)
Definition: main.h:326
Fixed length block allocator.
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:224
static f64 clib_time_now(clib_time_t *c)
Definition: time.h:202
u32 thread_index
Definition: main.h:173
_vlib_init_function_list_elt_t * main_loop_exit_function_registrations
Definition: main.h:181
u32 main_loop_exit_set
Definition: main.h:87
void vlib_worker_loop(vlib_main_t *vm)
Definition: main.c:1632
vlib_buffer_main_t * buffer_main
Definition: main.h:106
#define VLIB_MAIN_LOOP_EXIT_CLI
Definition: main.h:94
void clib_longjmp(clib_longjmp_t *save, uword return_value)
clib_time_t clib_time
Definition: main.h:62
vlib_cli_main_t cli_main
Definition: main.h:132
static u32 vlib_last_vectors_per_main_loop(vlib_main_t *vm)
Definition: main.h:297
mc_main_t * mc_main
Definition: main.h:147
static f64 vlib_last_vector_length_per_node(vlib_main_t *vm)
Definition: main.h:315
volatile int parked_at_barrier
Definition: main.h:193
_vlib_init_function_list_elt_t * api_init_function_registrations
Definition: main.h:182
void(* os_physmem_free)(struct vlib_main_t *vm, vlib_physmem_region_index_t idx, void *x)
Definition: main.h:125
#define always_inline
Definition: clib.h:92
static uword pow2_mask(uword x)
Definition: clib.h:265
u32 main_loop_vectors_processed
Definition: main.h:74
#define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
Definition: main.h:84
unsigned long u64
Definition: types.h:89
elog_event_type_t * error_elog_event_types
Definition: main.h:161
u64 cpu_time_main_loop_start
Definition: main.h:68
u32 node_counts_per_main_loop[2]
Definition: main.h:81
static void vlib_set_queue_signal_callback(vlib_main_t *vm, void(*fp)(vlib_main_t *))
Definition: main.h:354
char * name
Definition: main.h:100
static void vlib_panic(vlib_main_t *vm)
Definition: main.h:279
vlib_error_main_t error_main
Definition: main.h:138
struct vlib_main_t vlib_main_t
#define v
Definition: acl.c:341
struct _unformat_input_t unformat_input_t
elog_event_type_t * node_return_elog_event_types
Definition: main.h:159
#define PREDICT_FALSE(x)
Definition: clib.h:105
u32 vlib_app_num_thread_stacks_needed(void)
Definition: main.c:319
uword * init_functions_called
Definition: main.h:170
volatile u32 queue_signal_pending
Definition: main.h:187
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
u8 ** argv
Definition: main.h:190
#define VLIB_MAIN_LOOP_EXIT_PANIC
Definition: main.h:92
svmdb_client_t * c
vlib_main_t * vm
Definition: buffer.c:283
void * heap_base
Definition: main.h:103
int vlib_main(vlib_main_t *vm, unformat_input_t *input)
Definition: main.c:1676
elog_main_t elog_main
Definition: main.h:155
uword heap_size
Definition: main.h:104
#define ARRAY_LEN(x)
Definition: clib.h:59
Definition: mc.h:522
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
_vlib_init_function_list_elt_t * main_loop_enter_function_registrations
Definition: main.h:180
u32 main_loop_nodes_processed
Definition: main.h:75
u64 size
Definition: vhost-user.h:76
mc_serialize_msg_t * mc_msg_registrations
Definition: main.h:184
vlib_trace_main_t trace_main
Definition: main.h:135
int need_vlib_worker_thread_node_runtime_update
Definition: main.h:202
static u32 vlib_vector_input_stats_index(vlib_main_t *vm, word delta)
Definition: main.h:285
void(* queue_signal_callback)(struct vlib_main_t *)
Definition: main.h:189
static uword is_pow2(uword x)
Definition: clib.h:280
u64 uword
Definition: types.h:112
vlib_main_t vlib_global_main
Definition: main.c:1637
void ** mbuf_alloc_list
Definition: main.h:175
i64 word
Definition: types.h:111
f64 barrier_no_close_before
Definition: main.h:211
struct _mc_serialize_msg mc_serialize_msg_t
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
vlib_node_main_t node_main
Definition: main.h:129
void vlib_node_sync_stats(vlib_main_t *vm, vlib_node_t *n)
Definition: main.c:570
static f64 clib_time_now_internal(clib_time_t *c, u64 n)
Definition: time.h:187
volatile u32 api_queue_nonempty
Definition: main.h:188
f64 barrier_epoch
Definition: main.h:208
elog_event_type_t * node_call_elog_event_types
Definition: main.h:158
volatile u32 main_loop_exit_now
Definition: main.h:89
static f64 vlib_time_now_ticks(vlib_main_t *vm, u64 n)
Definition: main.h:230
void(* os_punt_frame)(struct vlib_main_t *vm, struct vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: main.h:142
clib_longjmp_t main_loop_exit
Definition: main.h:90
u32 flags
Definition: vhost-user.h:77
vlib_config_function_runtime_t * config_function_registrations
Definition: main.h:183
u8 ** vlib_thread_stacks
Definition: main.c:557
u32 main_loop_count
Definition: main.h:71
u8 vlib_physmem_region_index_t
Definition: physmem.h:43
clib_random_buffer_t random_buffer
Definition: main.h:167
clib_error_t * main_loop_error
Definition: main.h:97
u64 cpu_time_last_node_dispatch
Definition: main.h:65