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