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