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