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