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 #include <vppinfra/pmc.h>
  50 #include <vppinfra/pcap.h>
  51
  52 #include <pthread.h>
  53
  54
  55 /* By default turn off node/error event logging.
  56    Override with -DVLIB_ELOG_MAIN_LOOP */
  57 #ifndef VLIB_ELOG_MAIN_LOOP
  58 #define VLIB_ELOG_MAIN_LOOP 0
  59 #endif
  60
  61 typedef struct vlib_main_t
  62 {
  63   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  64   /* Instruction level timing state. */
  65   clib_time_t clib_time;
  66   /* Offset from main thread time */
  67   f64 time_offset;
  68   f64 time_last_barrier_release;
  69
  70   /* Time stamp of last node dispatch. */
  71   u64 cpu_time_last_node_dispatch;
  72
  73   /* Time stamp when main loop was entered (time 0). */
  74   u64 cpu_time_main_loop_start;
  75
  76   /* Incremented once for each main loop. */
  77   u32 main_loop_count;
  78
  79   /* Count of vectors processed this main loop. */
  80   u32 main_loop_vectors_processed;
  81   u32 main_loop_nodes_processed;
  82
  83   /* Circular buffer of input node vector counts.
  84      Indexed by low bits of
  85      (main_loop_count >> VLIB_LOG2_INPUT_VECTORS_PER_MAIN_LOOP). */
  86   u32 vector_counts_per_main_loop[2];
  87   u32 node_counts_per_main_loop[2];
  88
  89   /* Main loop hw / sw performance counters */
  90   void (*vlib_node_runtime_perf_counter_cb) (struct vlib_main_t *,
  91                                              u64 *, u64 *);
  92
  93   /* Every so often we switch to the next counter. */
  94 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
  95
  96   /* Jump target to exit main loop with given code. */
  97   u32 main_loop_exit_set;
  98   /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
  99   volatile u32 main_loop_exit_now;
 100   clib_longjmp_t main_loop_exit;
 101 #define VLIB_MAIN_LOOP_EXIT_NONE 0
 102 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
 103   /* Exit via CLI. */
 104 #define VLIB_MAIN_LOOP_EXIT_CLI 2
 105
 106   /* Error marker to use when exiting main loop. */
 107   clib_error_t *main_loop_error;
 108
 109   /* Name for e.g. syslog. */
 110   char *name;
 111
 112   /* Start of the heap. */
 113   void *heap_base;
 114
 115   /* Truncated version, to create frame indices */
 116   void *heap_aligned_base;
 117
 118   /* Size of the heap */
 119   uword heap_size;
 120
 121   /* buffer main structure. */
 122   vlib_buffer_main_t *buffer_main;
 123
 124   /* physical memory main structure. */
 125   vlib_physmem_main_t physmem_main;
 126
 127   /* Node graph main structure. */
 128   vlib_node_main_t node_main;
 129
 130   /* Command line interface. */
 131   vlib_cli_main_t cli_main;
 132
 133   /* Packet trace buffer. */
 134   vlib_trace_main_t trace_main;
 135
 136   /* Pcap dispatch trace main */
 137   pcap_main_t dispatch_pcap_main;
 138   uword dispatch_pcap_enable;
 139   u8 *pcap_buffer;
 140
 141   /* Error handling. */
 142   vlib_error_main_t error_main;
 143
 144   /* Punt packets to underlying operating system for when fast switching
 145      code does not know what to do. */
 146   void (*os_punt_frame) (struct vlib_main_t * vm,
 147                          struct vlib_node_runtime_t * node,
 148                          vlib_frame_t * frame);
 149
 150   /* Stream index to use for distribution when MC is enabled. */
 151   u32 mc_stream_index;
 152
 153   vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
 154
 155   /* Event logger. */
 156   elog_main_t elog_main;
 157
 158   /* Event logger trace flags */
 159   int elog_trace_api_messages;
 160   int elog_trace_cli_commands;
 161   int elog_trace_graph_dispatch;
 162   int elog_trace_graph_circuit;
 163   u32 elog_trace_graph_circuit_node_index;
 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   /* thread, cpu and numa_node indices */
 181   u32 thread_index;
 182   u32 cpu_id;
 183   u32 numa_node;
 184
 185   /* List of init functions to call, setup by constructors */
 186   _vlib_init_function_list_elt_t *init_function_registrations;
 187   _vlib_init_function_list_elt_t *worker_init_function_registrations;
 188   _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
 189   _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
 190   _vlib_init_function_list_elt_t *api_init_function_registrations;
 191   vlib_config_function_runtime_t *config_function_registrations;
 192
 193   /* control-plane API queue signal pending, length indication */
 194   volatile u32 queue_signal_pending;
 195   volatile u32 api_queue_nonempty;
 196   void (*queue_signal_callback) (struct vlib_main_t *);
 197   u8 **argv;
 198
 199   /* Top of (worker) dispatch loop callback */
 200   volatile void (*worker_thread_main_loop_callback) (struct vlib_main_t *);
 201
 202   /* debugging */
 203   volatile int parked_at_barrier;
 204
 205   /* Attempt to do a post-mortem elog dump */
 206   int elog_post_mortem_dump;
 207
 208   /*
 209    * Need to call vlib_worker_thread_node_runtime_update before
 210    * releasing worker thread barrier. Only valid in vlib_global_main.
 211    */
 212   int need_vlib_worker_thread_node_runtime_update;
 213
 214   /*
 215    * Barrier epoch - Set to current time, each time barrier_sync or
 216    * barrier_release is called with zero recursion.
 217    */
 218   f64 barrier_epoch;
 219
 220   /* Earliest barrier can be closed again */
 221   f64 barrier_no_close_before;
 222
 223   /* RPC requests, main thread only */
 224   uword *pending_rpc_requests;
 225   uword *processing_rpc_requests;
 226   clib_spinlock_t pending_rpc_lock;
 227
 228 } vlib_main_t;
 229
 230 /* Global main structure. */
 231 extern vlib_main_t vlib_global_main;
 232
 233 void vlib_worker_loop (vlib_main_t * vm);
 234
 235 always_inline f64
 236 vlib_time_now (vlib_main_t * vm)
 237 {
 238   return clib_time_now (&vm->clib_time) + vm->time_offset;
 239 }
 240
 241 always_inline f64
 242 vlib_time_now_ticks (vlib_main_t * vm, u64 n)
 243 {
 244   return clib_time_now_internal (&vm->clib_time, n);
 245 }
 246
 247 /* Busy wait for specified time. */
 248 always_inline void
 249 vlib_time_wait (vlib_main_t * vm, f64 wait)
 250 {
 251   f64 t = vlib_time_now (vm);
 252   f64 limit = t + wait;
 253   while (t < limit)
 254     t = vlib_time_now (vm);
 255 }
 256
 257 /* Time a piece of code. */
 258 #define vlib_time_code(vm,body)                 \
 259 do {                                            \
 260     f64 _t[2];                                  \
 261     _t[0] = vlib_time_now (vm);                 \
 262     do { body; } while (0);                     \
 263     _t[1] = vlib_time_now (vm);                 \
 264     clib_warning ("%.7e", _t[1] - _t[0]);       \
 265 } while (0)
 266
 267 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test)       \
 268 ({                                                                      \
 269     uword __vlib_wait_with_timeout = 0;                                 \
 270     f64 __vlib_wait_time = 0;                                           \
 271     while (! (__vlib_wait_with_timeout = (test))                        \
 272            && __vlib_wait_time < (timeout_time))                        \
 273       {                                                                 \
 274         vlib_process_suspend (vm, suspend_time);                        \
 275         __vlib_wait_time += suspend_time;                               \
 276       }                                                                 \
 277     __vlib_wait_with_timeout;                                           \
 278 })
 279
 280 always_inline void
 281 vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
 282 {
 283   vm->main_loop_error = error;
 284   clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
 285 }
 286
 287 #define vlib_panic_with_msg(vm,args...) \
 288   vlib_panic_with_error (vm, clib_error_return (0, args))
 289
 290 always_inline void
 291 vlib_panic (vlib_main_t * vm)
 292 {
 293   vlib_panic_with_error (vm, 0);
 294 }
 295
 296 always_inline u32
 297 vlib_vector_input_stats_index (vlib_main_t * vm, word delta)
 298 {
 299   u32 i;
 300   i = vm->main_loop_count >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
 301   ASSERT (is_pow2 (ARRAY_LEN (vm->vector_counts_per_main_loop)));
 302   return (i + delta) & (ARRAY_LEN (vm->vector_counts_per_main_loop) - 1);
 303 }
 304
 305 /* Estimate input rate based on previous
 306    2^VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE
 307    samples. */
 308 always_inline u32
 309 vlib_last_vectors_per_main_loop (vlib_main_t * vm)
 310 {
 311   u32 i = vlib_vector_input_stats_index (vm, -1);
 312   u32 n = vm->vector_counts_per_main_loop[i];
 313   return n >> VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE;
 314 }
 315
 316 /* Total ave vector count per iteration of main loop. */
 317 always_inline f64
 318 vlib_last_vectors_per_main_loop_as_f64 (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   return (f64) v / (f64) (1 << VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE);
 323 }
 324
 325 /* Total ave vectors/node count per iteration of main loop. */
 326 always_inline f64
 327 vlib_last_vector_length_per_node (vlib_main_t * vm)
 328 {
 329   u32 i = vlib_vector_input_stats_index (vm, -1);
 330   u32 v = vm->vector_counts_per_main_loop[i];
 331   u32 n = vm->node_counts_per_main_loop[i];
 332   return n == 0 ? 0 : (f64) v / (f64) n;
 333 }
 334
 335 extern u32 wraps;
 336
 337 always_inline void
 338 vlib_increment_main_loop_counter (vlib_main_t * vm)
 339 {
 340   u32 i, c, n, v, is_wrap;
 341
 342   c = vm->main_loop_count++;
 343
 344   is_wrap = (c & pow2_mask (VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE)) == 0;
 345
 346   if (is_wrap)
 347     wraps++;
 348
 349   i = vlib_vector_input_stats_index (vm, /* delta */ is_wrap);
 350
 351   v = is_wrap ? 0 : vm->vector_counts_per_main_loop[i];
 352   n = is_wrap ? 0 : vm->node_counts_per_main_loop[i];
 353
 354   v += vm->main_loop_vectors_processed;
 355   n += vm->main_loop_nodes_processed;
 356   vm->main_loop_vectors_processed = 0;
 357   vm->main_loop_nodes_processed = 0;
 358   vm->vector_counts_per_main_loop[i] = v;
 359   vm->node_counts_per_main_loop[i] = n;
 360
 361   if (PREDICT_FALSE (vm->main_loop_exit_now))
 362     clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
 363 }
 364
 365 always_inline void vlib_set_queue_signal_callback
 366   (vlib_main_t * vm, void (*fp) (vlib_main_t *))
 367 {
 368   vm->queue_signal_callback = fp;
 369 }
 370
 371 /* Main routine. */
 372 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
 373
 374 /* Thread stacks, for os_get_thread_index */
 375 extern u8 **vlib_thread_stacks;
 376
 377 /* Number of thread stacks that the application needs */
 378 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
 379
 380 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
 381
 382 #define VLIB_PCAP_MAJOR_VERSION 1
 383 #define VLIB_PCAP_MINOR_VERSION 0
 384
 385 #endif /* included_vlib_main_h */
 386
 387 /*
 388  * fd.io coding-style-patch-verification: ON
 389  *
 390  * Local Variables:
 391  * eval: (c-set-style "gnu")
 392  * End:
 393  */