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