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