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