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