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