src/vlib/threads.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 #ifndef included_vlib_threads_h
  16 #define included_vlib_threads_h
  17
  18 #include <vlib/main.h>
  19 #include <vppinfra/callback.h>
  20 #include <linux/sched.h>
  21
  22 void vlib_set_thread_name (char *name);
  23
  24 /* arg is actually a vlib__thread_t * */
  25 typedef void (vlib_thread_function_t) (void *arg);
  26
  27 typedef struct vlib_thread_registration_
  28 {
  29   /* constructor generated list of thread registrations */
  30   struct vlib_thread_registration_ *next;
  31
  32   /* config parameters */
  33   char *name;
  34   char *short_name;
  35   vlib_thread_function_t *function;
  36   uword mheap_size;
  37   int fixed_count;
  38   u32 count;
  39   int no_data_structure_clone;
  40   u32 frame_queue_nelts;
  41
  42   /* All threads of this type run on pthreads */
  43   int use_pthreads;
  44   u32 first_index;
  45   uword *coremask;
  46 } vlib_thread_registration_t;
  47
  48 #define VLIB_LOG2_THREAD_STACK_SIZE (21)
  49 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
  50
  51 typedef struct
  52 {
  53   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  54   volatile u32 valid;
  55   u32 maybe_trace : 1;
  56   u32 n_vectors;
  57   u32 offset;
  58   STRUCT_MARK (end_of_reset);
  59
  60   CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  61   u32 buffer_index[VLIB_FRAME_SIZE];
  62   u32 aux_data[VLIB_FRAME_SIZE];
  63 }
  64 vlib_frame_queue_elt_t;
  65
  66 typedef struct
  67 {
  68   /* First cache line */
  69   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  70   volatile u32 *wait_at_barrier;
  71   volatile u32 *workers_at_barrier;
  72
  73   /* Second Cache Line */
  74     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  75   void *thread_mheap;
  76   u8 *thread_stack;
  77   void (*thread_function) (void *);
  78   void *thread_function_arg;
  79   i64 recursion_level;
  80   elog_track_t elog_track;
  81   u32 instance_id;
  82   vlib_thread_registration_t *registration;
  83   u8 *name;
  84   u64 barrier_sync_count;
  85   u8 barrier_elog_enabled;
  86   const char *barrier_caller;
  87   const char *barrier_context;
  88   volatile u32 *node_reforks_required;
  89   volatile u32 wait_before_barrier;
  90   volatile u32 workers_before_barrier;
  91   volatile u32 done_work_before_barrier;
  92
  93   long lwp;
  94   int cpu_id;
  95   int core_id;
  96   int numa_id;
  97   pthread_t thread_id;
  98 } vlib_worker_thread_t;
  99
 100 extern vlib_worker_thread_t *vlib_worker_threads;
 101
 102 typedef struct
 103 {
 104   /* static data */
 105   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 106   vlib_frame_queue_elt_t *elts;
 107   u64 vector_threshold;
 108   u64 trace;
 109   u32 nelts;
 110
 111   /* modified by enqueue side  */
 112   CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 113   volatile u64 tail;
 114
 115   /* modified by dequeue side  */
 116   CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
 117   volatile u64 head;
 118 }
 119 vlib_frame_queue_t;
 120
 121 struct vlib_frame_queue_main_t_;
 122 typedef u32 (vlib_frame_queue_dequeue_fn_t) (
 123   vlib_main_t *vm, struct vlib_frame_queue_main_t_ *fqm);
 124 typedef struct vlib_frame_queue_main_t_
 125 {
 126   u32 node_index;
 127   u32 frame_queue_nelts;
 128
 129   vlib_frame_queue_t **vlib_frame_queues;
 130
 131   /* for frame queue tracing */
 132   frame_queue_trace_t *frame_queue_traces;
 133   frame_queue_nelt_counter_t *frame_queue_histogram;
 134   vlib_frame_queue_dequeue_fn_t *frame_queue_dequeue_fn;
 135 } vlib_frame_queue_main_t;
 136
 137 typedef struct
 138 {
 139   uword node_index;
 140   uword type_opaque;
 141   uword data;
 142 } vlib_process_signal_event_mt_args_t;
 143
 144 /* Called early, in thread 0's context */
 145 clib_error_t *vlib_thread_init (vlib_main_t * vm);
 146
 147 void vlib_worker_thread_node_runtime_update (void);
 148
 149 void vlib_create_worker_threads (vlib_main_t * vm, int n,
 150                                  void (*thread_function) (void *));
 151
 152 void vlib_worker_thread_init (vlib_worker_thread_t * w);
 153 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
 154
 155 /* Check for a barrier sync request every 30ms */
 156 #define BARRIER_SYNC_DELAY (0.030000)
 157
 158 #if CLIB_DEBUG > 0
 159 /* long barrier timeout, for gdb... */
 160 #define BARRIER_SYNC_TIMEOUT (600.1)
 161 #else
 162 #define BARRIER_SYNC_TIMEOUT (1.0)
 163 #endif
 164
 165 #define vlib_worker_thread_barrier_sync(X) {vlib_worker_thread_barrier_sync_int(X, __FUNCTION__);}
 166
 167 void vlib_worker_thread_barrier_sync_int (vlib_main_t * vm,
 168                                           const char *func_name);
 169 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
 170 u8 vlib_worker_thread_barrier_held (void);
 171 void vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm);
 172 void vlib_worker_thread_node_refork (void);
 173 /**
 174  * Wait until each of the workers has been once around the track
 175  */
 176 void vlib_worker_wait_one_loop (void);
 177
 178 static_always_inline uword
 179 vlib_get_thread_index (void)
 180 {
 181   return __os_thread_index;
 182 }
 183
 184 always_inline void
 185 vlib_smp_unsafe_warning (void)
 186 {
 187   if (CLIB_DEBUG > 0)
 188     {
 189       if (vlib_get_thread_index ())
 190         fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
 191     }
 192 }
 193
 194 always_inline int
 195 __foreach_vlib_main_helper (vlib_main_t *ii, vlib_main_t **p)
 196 {
 197   vlib_main_t *vm;
 198   u32 index = ii - (vlib_main_t *) 0;
 199
 200   if (index >= vec_len (vlib_global_main.vlib_mains))
 201     return 0;
 202
 203   *p = vm = vlib_global_main.vlib_mains[index];
 204   ASSERT (index == 0 || vm->parked_at_barrier == 1);
 205   return 1;
 206 }
 207
 208 #define foreach_vlib_main()                                                   \
 209   for (vlib_main_t *ii = 0, *this_vlib_main;                                  \
 210        __foreach_vlib_main_helper (ii, &this_vlib_main); ii++)                \
 211     if (this_vlib_main)
 212
 213 #define foreach_sched_policy \
 214   _(SCHED_OTHER, OTHER, "other") \
 215   _(SCHED_BATCH, BATCH, "batch") \
 216   _(SCHED_IDLE, IDLE, "idle")   \
 217   _(SCHED_FIFO, FIFO, "fifo")   \
 218   _(SCHED_RR, RR, "rr")
 219
 220 typedef enum
 221 {
 222 #define _(v,f,s) SCHED_POLICY_##f = v,
 223   foreach_sched_policy
 224 #undef _
 225     SCHED_POLICY_N,
 226 } sched_policy_t;
 227
 228 typedef struct
 229 {
 230   /* Link list of registrations, built by constructors */
 231   vlib_thread_registration_t *next;
 232
 233   /* Vector of registrations, w/ non-data-structure clones at the top */
 234   vlib_thread_registration_t **registrations;
 235
 236   uword *thread_registrations_by_name;
 237
 238   vlib_worker_thread_t *worker_threads;
 239
 240   int use_pthreads;
 241
 242   /* Number of vlib_main / vnet_main clones */
 243   u32 n_vlib_mains;
 244
 245   /* Number of thread stacks to create */
 246   u32 n_thread_stacks;
 247
 248   /* Number of pthreads */
 249   u32 n_pthreads;
 250
 251   /* Number of threads */
 252   u32 n_threads;
 253
 254   /* Number of cores to skip, must match the core mask */
 255   u32 skip_cores;
 256
 257   /* Thread prefix name */
 258   u8 *thread_prefix;
 259
 260   /* main thread lcore */
 261   u32 main_lcore;
 262
 263   /* Bitmap of available CPU cores */
 264   uword *cpu_core_bitmap;
 265
 266   /* Bitmap of available CPU sockets (NUMA nodes) */
 267   uword *cpu_socket_bitmap;
 268
 269   /* Worker handoff queues */
 270   vlib_frame_queue_main_t *frame_queue_mains;
 271
 272   /* worker thread initialization barrier */
 273   volatile u32 worker_thread_release;
 274
 275   /* scheduling policy */
 276   u32 sched_policy;
 277
 278   /* scheduling policy priority */
 279   u32 sched_priority;
 280
 281   /* NUMA-bound heap size */
 282   uword numa_heap_size;
 283
 284 } vlib_thread_main_t;
 285
 286 extern vlib_thread_main_t vlib_thread_main;
 287
 288 #include <vlib/global_funcs.h>
 289
 290 #define VLIB_REGISTER_THREAD(x,...)                     \
 291   __VA_ARGS__ vlib_thread_registration_t x;             \
 292 static void __vlib_add_thread_registration_##x (void)   \
 293   __attribute__((__constructor__)) ;                    \
 294 static void __vlib_add_thread_registration_##x (void)   \
 295 {                                                       \
 296   vlib_thread_main_t * tm = &vlib_thread_main;          \
 297   x.next = tm->next;                                    \
 298   tm->next = &x;                                        \
 299 }                                                       \
 300 static void __vlib_rm_thread_registration_##x (void)    \
 301   __attribute__((__destructor__)) ;                     \
 302 static void __vlib_rm_thread_registration_##x (void)    \
 303 {                                                       \
 304   vlib_thread_main_t * tm = &vlib_thread_main;          \
 305   VLIB_REMOVE_FROM_LINKED_LIST (tm->next, &x, next);    \
 306 }                                                       \
 307 __VA_ARGS__ vlib_thread_registration_t x
 308
 309 always_inline u32
 310 vlib_num_workers ()
 311 {
 312   return vlib_thread_main.n_vlib_mains - 1;
 313 }
 314
 315 always_inline u32
 316 vlib_get_worker_thread_index (u32 worker_index)
 317 {
 318   return worker_index + 1;
 319 }
 320
 321 always_inline u32
 322 vlib_get_worker_index (u32 thread_index)
 323 {
 324   return thread_index - 1;
 325 }
 326
 327 always_inline u32
 328 vlib_get_current_worker_index ()
 329 {
 330   return vlib_get_thread_index () - 1;
 331 }
 332
 333 static inline void
 334 vlib_worker_thread_barrier_check (void)
 335 {
 336   if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
 337     {
 338       vlib_global_main_t *vgm = vlib_get_global_main ();
 339       vlib_main_t *vm = vlib_get_main ();
 340       u32 thread_index = vm->thread_index;
 341       f64 t = vlib_time_now (vm);
 342
 343       if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
 344         clib_call_callbacks (vm->barrier_perf_callbacks, vm,
 345                              vm->clib_time.last_cpu_time, 0 /* enter */ );
 346
 347       if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 348         {
 349           vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 350           /* *INDENT-OFF* */
 351           ELOG_TYPE_DECLARE (e) = {
 352             .format = "barrier-wait-thread-%d",
 353             .format_args = "i4",
 354           };
 355           /* *INDENT-ON* */
 356
 357           struct
 358           {
 359             u32 thread_index;
 360           } __clib_packed *ed;
 361
 362           ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e, w->elog_track);
 363           ed->thread_index = thread_index;
 364         }
 365
 366       if (CLIB_DEBUG > 0)
 367         {
 368           vm = vlib_get_main ();
 369           vm->parked_at_barrier = 1;
 370         }
 371       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
 372       while (*vlib_worker_threads->wait_at_barrier)
 373         ;
 374
 375       /*
 376        * Recompute the offset from thread-0 time.
 377        * Note that vlib_time_now adds vm->time_offset, so
 378        * clear it first. Save the resulting idea of "now", to
 379        * see how well we're doing. See show_clock_command_fn(...)
 380        */
 381       {
 382         f64 now;
 383         vm->time_offset = 0.0;
 384         now = vlib_time_now (vm);
 385         vm->time_offset = vgm->vlib_mains[0]->time_last_barrier_release - now;
 386         vm->time_last_barrier_release = vlib_time_now (vm);
 387       }
 388
 389       if (CLIB_DEBUG > 0)
 390         vm->parked_at_barrier = 0;
 391       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
 392
 393       if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
 394         {
 395           if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 396             {
 397               t = vlib_time_now (vm) - t;
 398               vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 399               /* *INDENT-OFF* */
 400               ELOG_TYPE_DECLARE (e) = {
 401                 .format = "barrier-refork-thread-%d",
 402                 .format_args = "i4",
 403               };
 404               /* *INDENT-ON* */
 405
 406               struct
 407               {
 408                 u32 thread_index;
 409               } __clib_packed *ed;
 410
 411               ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
 412                                     w->elog_track);
 413               ed->thread_index = thread_index;
 414             }
 415
 416           vlib_worker_thread_node_refork ();
 417           clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
 418                                  -1);
 419           while (*vlib_worker_threads->node_reforks_required)
 420             ;
 421         }
 422       if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 423         {
 424           t = vlib_time_now (vm) - t;
 425           vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 426           /* *INDENT-OFF* */
 427           ELOG_TYPE_DECLARE (e) = {
 428             .format = "barrier-released-thread-%d: %dus",
 429             .format_args = "i4i4",
 430           };
 431           /* *INDENT-ON* */
 432
 433           struct
 434           {
 435             u32 thread_index;
 436             u32 duration;
 437           } __clib_packed *ed;
 438
 439           ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e, w->elog_track);
 440           ed->thread_index = thread_index;
 441           ed->duration = (int) (1000000.0 * t);
 442         }
 443
 444       if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
 445         clib_call_callbacks (vm->barrier_perf_callbacks, vm,
 446                              vm->clib_time.last_cpu_time, 1 /* leave */ );
 447     }
 448 }
 449
 450 always_inline vlib_main_t *
 451 vlib_get_worker_vlib_main (u32 worker_index)
 452 {
 453   vlib_main_t *vm;
 454   vlib_thread_main_t *tm = &vlib_thread_main;
 455   ASSERT (worker_index < tm->n_vlib_mains - 1);
 456   vm = vlib_get_main_by_index (worker_index + 1);
 457   ASSERT (vm);
 458   return vm;
 459 }
 460
 461 static inline u8
 462 vlib_thread_is_main_w_barrier (void)
 463 {
 464   return (!vlib_num_workers ()
 465           || ((vlib_get_thread_index () == 0
 466                && vlib_worker_threads->wait_at_barrier[0])));
 467 }
 468
 469 u8 *vlib_thread_stack_init (uword thread_index);
 470 extern void *rpc_call_main_thread_cb_fn;
 471
 472 void
 473 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
 474                                      args);
 475 void vlib_rpc_call_main_thread (void *function, u8 * args, u32 size);
 476 void vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id);
 477 vlib_thread_main_t *vlib_get_thread_main_not_inline (void);
 478
 479 /**
 480  * Force workers sync from within worker
 481  *
 482  * Must be paired with @ref vlib_workers_continue
 483  */
 484 void vlib_workers_sync (void);
 485 /**
 486  * Release barrier after workers sync
 487  */
 488 void vlib_workers_continue (void);
 489
 490 #endif /* included_vlib_threads_h */
 491
 492 /*
 493  * fd.io coding-style-patch-verification: ON
 494  *
 495  * Local Variables:
 496  * eval: (c-set-style "gnu")
 497  * End:
 498  */