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