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/callback_data.h>
  44 #include <vppinfra/elog.h>
  45 #include <vppinfra/format.h>
  46 #include <vppinfra/longjmp.h>
  47 #include <vppinfra/pool.h>
  48 #include <vppinfra/random_buffer.h>
  49 #include <vppinfra/time.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
  62 {
  63   u8 trace_filter_enable;
  64   u32 classify_table_index;
  65 } vlib_trace_filter_t;
  66
  67 typedef enum
  68 {
  69   VLIB_NODE_RUNTIME_PERF_BEFORE,
  70   VLIB_NODE_RUNTIME_PERF_AFTER,
  71   VLIB_NODE_RUNTIME_PERF_RESET,
  72 } vlib_node_runtime_perf_call_type_t;
  73
  74 typedef struct
  75 {
  76   struct vlib_main_t *vm;
  77   vlib_node_runtime_t *node;
  78   vlib_frame_t *frame;
  79   uword packets;
  80   u64 cpu_time_now;
  81   vlib_node_runtime_perf_call_type_t call_type;
  82 } vlib_node_runtime_perf_callback_args_t;
  83
  84 struct vlib_node_runtime_perf_callback_data_t;
  85
  86 typedef void (*vlib_node_runtime_perf_callback_fp_t)
  87   (struct vlib_node_runtime_perf_callback_data_t * data,
  88    vlib_node_runtime_perf_callback_args_t * args);
  89
  90 typedef struct vlib_node_runtime_perf_callback_data_t
  91 {
  92   vlib_node_runtime_perf_callback_fp_t fp;
  93   union
  94   {
  95     void *v;
  96     u64 u;
  97   } u[3];
  98 } vlib_node_runtime_perf_callback_data_t;
  99
 100 clib_callback_data_typedef (vlib_node_runtime_perf_callback_set_t,
 101                             vlib_node_runtime_perf_callback_data_t);
 102
 103 typedef struct vlib_main_t
 104 {
 105   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 106   /* Instruction level timing state. */
 107   clib_time_t clib_time;
 108   /* Offset from main thread time */
 109   f64 time_offset;
 110   f64 time_last_barrier_release;
 111
 112   /* Time stamp of last node dispatch. */
 113   u64 cpu_time_last_node_dispatch;
 114
 115   /* Time stamp when main loop was entered (time 0). */
 116   u64 cpu_time_main_loop_start;
 117
 118   /* Incremented once for each main loop. */
 119   volatile u32 main_loop_count;
 120
 121   /* Count of vectors processed this main loop. */
 122   u32 main_loop_vectors_processed;
 123   u32 main_loop_nodes_processed;
 124
 125   /* Internal node vectors, calls */
 126   u64 internal_node_vectors;
 127   u64 internal_node_calls;
 128   u64 internal_node_vectors_last_clear;
 129   u64 internal_node_calls_last_clear;
 130
 131   /* Instantaneous vector rate */
 132   u32 internal_node_last_vectors_per_main_loop;
 133
 134   /* Main loop hw / sw performance counters */
 135   vlib_node_runtime_perf_callback_set_t vlib_node_runtime_perf_callbacks;
 136
 137   /* dispatch wrapper function */
 138   vlib_node_function_t *dispatch_wrapper_fn;
 139
 140   /* Every so often we switch to the next counter. */
 141 #define VLIB_LOG2_MAIN_LOOPS_PER_STATS_UPDATE 7
 142
 143   /* Jump target to exit main loop with given code. */
 144   u32 main_loop_exit_set;
 145   /* Set e.g. in the SIGTERM signal handler, checked in a safe place... */
 146   volatile u32 main_loop_exit_now;
 147   clib_longjmp_t main_loop_exit;
 148 #define VLIB_MAIN_LOOP_EXIT_NONE 0
 149 #define VLIB_MAIN_LOOP_EXIT_PANIC 1
 150   /* Exit via CLI. */
 151 #define VLIB_MAIN_LOOP_EXIT_CLI 2
 152
 153   /* Error marker to use when exiting main loop. */
 154   clib_error_t *main_loop_error;
 155
 156   /* Name for e.g. syslog. */
 157   char *name;
 158
 159   /* Start of the heap. */
 160   void *heap_base;
 161
 162   /* Truncated version, to create frame indices */
 163   void *heap_aligned_base;
 164
 165   /* Size of the heap */
 166   uword heap_size;
 167
 168   /* buffer main structure. */
 169   vlib_buffer_main_t *buffer_main;
 170
 171   /* physical memory main structure. */
 172   vlib_physmem_main_t physmem_main;
 173
 174   /* Node graph main structure. */
 175   vlib_node_main_t node_main;
 176
 177   /* Command line interface. */
 178   vlib_cli_main_t cli_main;
 179
 180   /* Packet trace buffer. */
 181   vlib_trace_main_t trace_main;
 182
 183   /* Pcap dispatch trace main */
 184   pcap_main_t dispatch_pcap_main;
 185   uword dispatch_pcap_enable;
 186   uword dispatch_pcap_postmortem;
 187   u32 *dispatch_buffer_trace_nodes;
 188   u8 *pcap_buffer;
 189
 190   /* Packet trace capture filter */
 191   vlib_trace_filter_t trace_filter;
 192
 193   /* Error handling. */
 194   vlib_error_main_t error_main;
 195
 196   /* Punt packets to underlying operating system for when fast switching
 197      code does not know what to do. */
 198   void (*os_punt_frame) (struct vlib_main_t * vm,
 199                          struct vlib_node_runtime_t * node,
 200                          vlib_frame_t * frame);
 201
 202   /* Stream index to use for distribution when MC is enabled. */
 203   u32 mc_stream_index;
 204
 205   vlib_one_time_waiting_process_t *procs_waiting_for_mc_stream_join;
 206
 207   /* Event logger. */
 208   elog_main_t elog_main;
 209   u32 configured_elog_ring_size;
 210
 211   /* Event logger trace flags */
 212   int elog_trace_api_messages;
 213   int elog_trace_cli_commands;
 214   int elog_trace_graph_dispatch;
 215   int elog_trace_graph_circuit;
 216   u32 elog_trace_graph_circuit_node_index;
 217
 218   /* Node call and return event types. */
 219   elog_event_type_t *node_call_elog_event_types;
 220   elog_event_type_t *node_return_elog_event_types;
 221
 222   elog_event_type_t *error_elog_event_types;
 223
 224   /* Seed for random number generator. */
 225   uword random_seed;
 226
 227   /* Buffer of random data for various uses. */
 228   clib_random_buffer_t random_buffer;
 229
 230   /* Hash table to record which init functions have been called. */
 231   uword *init_functions_called;
 232
 233   /* thread, cpu and numa_node indices */
 234   u32 thread_index;
 235   u32 cpu_id;
 236   u32 numa_node;
 237
 238   /* List of init functions to call, setup by constructors */
 239   _vlib_init_function_list_elt_t *init_function_registrations;
 240   _vlib_init_function_list_elt_t *worker_init_function_registrations;
 241   _vlib_init_function_list_elt_t *main_loop_enter_function_registrations;
 242   _vlib_init_function_list_elt_t *main_loop_exit_function_registrations;
 243   _vlib_init_function_list_elt_t *api_init_function_registrations;
 244   vlib_config_function_runtime_t *config_function_registrations;
 245
 246   /* control-plane API queue signal pending, length indication */
 247   volatile u32 queue_signal_pending;
 248   volatile u32 api_queue_nonempty;
 249   void (*queue_signal_callback) (struct vlib_main_t *);
 250   u8 **argv;
 251
 252   /* Top of (worker) dispatch loop callback */
 253   void (**volatile worker_thread_main_loop_callbacks)
 254     (struct vlib_main_t *, u64 t);
 255   void (**volatile worker_thread_main_loop_callback_tmp)
 256     (struct vlib_main_t *, u64 t);
 257   clib_spinlock_t worker_thread_main_loop_callback_lock;
 258
 259   /* debugging */
 260   volatile int parked_at_barrier;
 261
 262   /* Attempt to do a post-mortem elog dump */
 263   int elog_post_mortem_dump;
 264
 265   /*
 266    * Need to call vlib_worker_thread_node_runtime_update before
 267    * releasing worker thread barrier. Only valid in vlib_global_main.
 268    */
 269   int need_vlib_worker_thread_node_runtime_update;
 270
 271   /* Dispatch loop time accounting */
 272   u64 loops_this_reporting_interval;
 273   f64 loop_interval_end;
 274   f64 loop_interval_start;
 275   f64 loops_per_second;
 276   f64 seconds_per_loop;
 277   f64 damping_constant;
 278
 279   /*
 280    * Barrier epoch - Set to current time, each time barrier_sync or
 281    * barrier_release is called with zero recursion.
 282    */
 283   f64 barrier_epoch;
 284
 285   /* Earliest barrier can be closed again */
 286   f64 barrier_no_close_before;
 287
 288   /* Barrier counter callback */
 289   void (**volatile barrier_perf_callbacks)
 290     (struct vlib_main_t *, u64 t, int leave);
 291   void (**volatile barrier_perf_callbacks_tmp)
 292     (struct vlib_main_t *, u64 t, int leave);
 293
 294   /* Need to check the frame queues */
 295   volatile uword check_frame_queues;
 296
 297   /* RPC requests, main thread only */
 298   uword *pending_rpc_requests;
 299   uword *processing_rpc_requests;
 300   clib_spinlock_t pending_rpc_lock;
 301
 302   /* buffer fault injector */
 303   u32 buffer_alloc_success_seed;
 304   f64 buffer_alloc_success_rate;
 305
 306 #ifdef CLIB_SANITIZE_ADDR
 307   /* address sanitizer stack save */
 308   void *asan_stack_save;
 309 #endif
 310 } vlib_main_t;
 311
 312 /* Global main structure. */
 313 extern vlib_main_t vlib_global_main;
 314
 315 void vlib_worker_loop (vlib_main_t * vm);
 316
 317 always_inline f64
 318 vlib_time_now (vlib_main_t * vm)
 319 {
 320 #if CLIB_DEBUG > 0
 321   extern __thread uword __os_thread_index;
 322 #endif
 323   /*
 324    * Make sure folks don't pass &vlib_global_main from a worker thread.
 325    */
 326   ASSERT (vm->thread_index == __os_thread_index);
 327   return clib_time_now (&vm->clib_time) + vm->time_offset;
 328 }
 329
 330 always_inline f64
 331 vlib_time_now_ticks (vlib_main_t * vm, u64 n)
 332 {
 333   return clib_time_now_internal (&vm->clib_time, n);
 334 }
 335
 336 /* Busy wait for specified time. */
 337 always_inline void
 338 vlib_time_wait (vlib_main_t * vm, f64 wait)
 339 {
 340   f64 t = vlib_time_now (vm);
 341   f64 limit = t + wait;
 342   while (t < limit)
 343     t = vlib_time_now (vm);
 344 }
 345
 346 /* Time a piece of code. */
 347 #define vlib_time_code(vm,body)                 \
 348 do {                                            \
 349     f64 _t[2];                                  \
 350     _t[0] = vlib_time_now (vm);                 \
 351     do { body; } while (0);                     \
 352     _t[1] = vlib_time_now (vm);                 \
 353     clib_warning ("%.7e", _t[1] - _t[0]);       \
 354 } while (0)
 355
 356 #define vlib_wait_with_timeout(vm,suspend_time,timeout_time,test)       \
 357 ({                                                                      \
 358     uword __vlib_wait_with_timeout = 0;                                 \
 359     f64 __vlib_wait_time = 0;                                           \
 360     while (! (__vlib_wait_with_timeout = (test))                        \
 361            && __vlib_wait_time < (timeout_time))                        \
 362       {                                                                 \
 363         vlib_process_suspend (vm, suspend_time);                        \
 364         __vlib_wait_time += suspend_time;                               \
 365       }                                                                 \
 366     __vlib_wait_with_timeout;                                           \
 367 })
 368
 369 always_inline void
 370 vlib_panic_with_error (vlib_main_t * vm, clib_error_t * error)
 371 {
 372   vm->main_loop_error = error;
 373   clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_PANIC);
 374 }
 375
 376 #define vlib_panic_with_msg(vm,args...) \
 377   vlib_panic_with_error (vm, clib_error_return (0, args))
 378
 379 always_inline void
 380 vlib_panic (vlib_main_t * vm)
 381 {
 382   vlib_panic_with_error (vm, 0);
 383 }
 384
 385
 386 always_inline f64
 387 vlib_internal_node_vector_rate (vlib_main_t * vm)
 388 {
 389   u64 vectors;
 390   u64 calls;
 391
 392   calls = vm->internal_node_calls - vm->internal_node_calls_last_clear;
 393
 394   if (PREDICT_FALSE (calls == 0))
 395     return 0.0;
 396
 397   vectors = vm->internal_node_vectors - vm->internal_node_vectors_last_clear;
 398
 399   return (f64) vectors / (f64) calls;
 400 }
 401
 402 always_inline void
 403 vlib_clear_internal_node_vector_rate (vlib_main_t * vm)
 404 {
 405   vm->internal_node_calls_last_clear = vm->internal_node_calls;
 406   vm->internal_node_vectors_last_clear = vm->internal_node_vectors;
 407 }
 408
 409 always_inline void
 410 vlib_increment_main_loop_counter (vlib_main_t * vm)
 411 {
 412   vm->main_loop_count++;
 413   vm->internal_node_last_vectors_per_main_loop = 0;
 414
 415   if (PREDICT_FALSE (vm->main_loop_exit_now))
 416     clib_longjmp (&vm->main_loop_exit, VLIB_MAIN_LOOP_EXIT_CLI);
 417 }
 418
 419 always_inline u32
 420 vlib_last_vectors_per_main_loop (vlib_main_t * vm)
 421 {
 422   return vm->internal_node_last_vectors_per_main_loop;
 423 }
 424
 425 always_inline void
 426 vlib_node_runtime_perf_counter (vlib_main_t * vm, vlib_node_runtime_t * node,
 427                                 vlib_frame_t * frame, uword n, u64 t,
 428                                 vlib_node_runtime_perf_call_type_t call_type)
 429 {
 430   vlib_node_runtime_perf_callback_data_t *v =
 431     clib_callback_data_check_and_get (&vm->vlib_node_runtime_perf_callbacks);
 432   if (vec_len (v))
 433     {
 434       vlib_node_runtime_perf_callback_args_t args = {
 435         .vm = vm,
 436         .node = node,
 437         .frame = frame,
 438         .packets = n,
 439         .cpu_time_now = t,
 440         .call_type = call_type,
 441       };
 442       clib_callback_data_call_vec (v, &args);
 443     }
 444 }
 445
 446 always_inline void vlib_set_queue_signal_callback
 447   (vlib_main_t * vm, void (*fp) (vlib_main_t *))
 448 {
 449   vm->queue_signal_callback = fp;
 450 }
 451
 452 /* Main routine. */
 453 int vlib_main (vlib_main_t * vm, unformat_input_t * input);
 454
 455 /* Thread stacks, for os_get_thread_index */
 456 extern u8 **vlib_thread_stacks;
 457
 458 /* Number of thread stacks that the application needs */
 459 u32 vlib_app_num_thread_stacks_needed (void) __attribute__ ((weak));
 460
 461 extern void vlib_node_sync_stats (vlib_main_t * vm, vlib_node_t * n);
 462
 463 #define VLIB_PCAP_MAJOR_VERSION 1
 464 #define VLIB_PCAP_MINOR_VERSION 0
 465
 466 typedef struct
 467 {
 468   u8 *filename;
 469   int enable;
 470   int status;
 471   int post_mortem;
 472   u32 packets_to_capture;
 473   u32 buffer_trace_node_index;
 474   u32 buffer_traces_to_capture;
 475 } vlib_pcap_dispatch_trace_args_t;
 476
 477 int vlib_pcap_dispatch_trace_configure (vlib_pcap_dispatch_trace_args_t *);
 478 vlib_main_t *vlib_get_main_not_inline (void);
 479 elog_main_t *vlib_get_elog_main_not_inline ();
 480
 481 #endif /* included_vlib_main_h */
 482
 483 /*
 484  * fd.io coding-style-patch-verification: ON
 485  *
 486  * Local Variables:
 487  * eval: (c-set-style "gnu")
 488  * End:
 489  */