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