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   /* 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,
 121                                             vlib_physmem_region_index_t *
 122                                             idx);
 123
 124   void (*os_physmem_region_free) (struct vlib_main_t * vm,
 125                                   vlib_physmem_region_index_t idx);
 126
 127   void *(*os_physmem_alloc_aligned) (struct vlib_main_t * vm,
 128                                      vlib_physmem_region_index_t idx,
 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. */
 134   vlib_node_main_t node_main;
 135
 136   /* Command line interface. */
 137   vlib_cli_main_t cli_main;
 138
 139   /* Packet trace buffer. */
 140   vlib_trace_main_t trace_main;
 141
 142   /* Error handling. */
 143   vlib_error_main_t error_main;
 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. */
 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   /* Event logger trace flags */
 160   int elog_trace_api_messages;
 161   int elog_trace_cli_commands;
 162
 163   /* Node call and return event types. */
 164   elog_event_type_t *node_call_elog_event_types;
 165   elog_event_type_t *node_return_elog_event_types;
 166
 167   elog_event_type_t *error_elog_event_types;
 168
 169   /* Seed for random number generator. */
 170   uword random_seed;
 171
 172   /* Buffer of random data for various uses. */
 173   clib_random_buffer_t random_buffer;
 174
 175   /* Hash table to record which init functions have been called. */
 176   uword *init_functions_called;
 177
 178   /* to compare with node runtime */
 179   u32 thread_index;
 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;
 187   vlib_config_function_runtime_t *config_function_registrations;
 188
 189   /* control-plane API queue signal pending, length indication */
 190   volatile u32 queue_signal_pending;
 191   volatile u32 api_queue_nonempty;
 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 */
 199   int elog_post_mortem_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    */
 205   int need_vlib_worker_thread_node_runtime_update;
 206
 207   /*
 208    * Barrier epoch - Set to current time, each time barrier_sync or
 209    * barrier_release is called with zero recursion.
 210    */
 211   f64 barrier_epoch;
 212
 213   /* Earliest barrier can be closed again */
 214   f64 barrier_no_close_before;
 215
 216   /* Vector of pending RPC requests */
 217   uword *pending_rpc_requests;
 218
 219 } vlib_main_t;
 220
 221 /* Global main structure. */
 222 extern vlib_main_t vlib_global_main;
 223
 224 void vlib_worker_loop (vlib_main_t * vm);
 225
 226 always_inline f64
 227 vlib_time_now (vlib_main_t * vm)
 228 {
 229   return clib_time_now (&vm->clib_time);
 230 }
 231
 232 always_inline f64
 233 vlib_time_now_ticks (vlib_main_t * vm, u64 n)
 234 {
 235   return clib_time_now_internal (&vm->clib_time, n);
 236 }
 237
 238 /* Busy wait for specified time. */
 239 always_inline void
 240 vlib_time_wait (vlib_main_t * vm, f64 wait)
 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
 272 vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
 273 {
 274   vm->main_loop_error = error;
 275   clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
 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
 282 vlib_panic (vlib_main_t * vm)
 283 {
 284   vlib_panic_with_error (vm, 0);
 285 }
 286
 287 always_inline u32
 288 vlib_vector_input_stats_index (vlib_main_t * vm, word delta)
 289 {
 290   u32 i;
 291   i = vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
 292   ASSERT (is_pow2 (ARRAY_LEN (vm->vector_counts_per_main_loop)));
 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. */
 299 always_inline u32
 300 vlib_last_vectors_per_main_loop (vlib_main_t * vm)
 301 {
 302   u32 i = vlib_vector_input_stats_index (vm, -1);
 303   u32 n = vm->vector_counts_per_main_loop[i];
 304   return n >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
 305 }
 306
 307 /* Total ave vector count per iteration of main loop. */
 308 always_inline f64
 309 vlib_last_vectors_per_main_loop_as_f64 (vlib_main_t * vm)
 310 {
 311   u32 i = vlib_vector_input_stats_index (vm, -1);
 312   u32 v = vm->vector_counts_per_main_loop[i];
 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. */
 317 always_inline f64
 318 vlib_last_vector_length_per_node (vlib_main_t * vm)
 319 {
 320   u32 i = vlib_vector_input_stats_index (vm, -1);
 321   u32 v = vm->vector_counts_per_main_loop[i];
 322   u32 n = vm->node_counts_per_main_loop[i];
 323   return n == 0 ? 0 : (f64) v / (f64) n;
 324 }
 325
 326 extern u32 wraps;
 327
 328 always_inline void
 329 vlib_increment_main_loop_counter (vlib_main_t * vm)
 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
 345   v += vm->main_loop_vectors_processed;
 346   n += vm->main_loop_nodes_processed;
 347   vm->main_loop_vectors_processed = 0;
 348   vm->main_loop_nodes_processed = 0;
 349   vm->vector_counts_per_main_loop[i] = v;
 350   vm->node_counts_per_main_loop[i] = n;
 351
 352   if (PREDICT_FALSE (vm->main_loop_exit_now))
 353     clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
 354 }
 355
 356 always_inline void vlib_set_queue_signal_callback
 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  */