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