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 extern vlib_main_t **vlib_mains;
  23
  24 void vlib_set_thread_name (char *name);
  25
  26 /* arg is actually a vlib__thread_t * */
  27 typedef void (vlib_thread_function_t) (void *arg);
  28
  29 typedef struct vlib_thread_registration_
  30 {
  31   /* constructor generated list of thread registrations */
  32   struct vlib_thread_registration_ *next;
  33
  34   /* config parameters */
  35   char *name;
  36   char *short_name;
  37   vlib_thread_function_t *function;
  38   uword mheap_size;
  39   int fixed_count;
  40   u32 count;
  41   int no_data_structure_clone;
  42   u32 frame_queue_nelts;
  43
  44   /* All threads of this type run on pthreads */
  45   int use_pthreads;
  46   u32 first_index;
  47   uword *coremask;
  48 } vlib_thread_registration_t;
  49
  50 /*
  51  * Frames have their cpu / vlib_main_t index in the low-order N bits
  52  * Make VLIB_MAX_CPUS a power-of-two, please...
  53  */
  54
  55 #ifndef VLIB_MAX_CPUS
  56 #define VLIB_MAX_CPUS 256
  57 #endif
  58
  59 #if VLIB_MAX_CPUS > CLIB_MAX_MHEAPS
  60 #error Please increase number of per-cpu mheaps
  61 #endif
  62
  63 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1)       /* 0x3f, max */
  64 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
  65
  66 #define VLIB_LOG2_THREAD_STACK_SIZE (21)
  67 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
  68
  69 typedef enum
  70 {
  71   VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
  72 } vlib_frame_queue_msg_type_t;
  73
  74 typedef struct
  75 {
  76   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  77   volatile u32 valid;
  78   u32 msg_type;
  79   u32 n_vectors;
  80   u32 last_n_vectors;
  81
  82   /* 256 * 4 = 1024 bytes, even mult of cache line size */
  83   u32 buffer_index[VLIB_FRAME_SIZE];
  84 }
  85 vlib_frame_queue_elt_t;
  86
  87 typedef struct
  88 {
  89   /* First cache line */
  90   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  91   volatile u32 *wait_at_barrier;
  92   volatile u32 *workers_at_barrier;
  93
  94   /* Second Cache Line */
  95     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  96   void *thread_mheap;
  97   u8 *thread_stack;
  98   void (*thread_function) (void *);
  99   void *thread_function_arg;
 100   i64 recursion_level;
 101   elog_track_t elog_track;
 102   u32 instance_id;
 103   vlib_thread_registration_t *registration;
 104   u8 *name;
 105   u64 barrier_sync_count;
 106   u8 barrier_elog_enabled;
 107   const char *barrier_caller;
 108   const char *barrier_context;
 109   volatile u32 *node_reforks_required;
 110
 111   long lwp;
 112   int cpu_id;
 113   int core_id;
 114   int numa_id;
 115   pthread_t thread_id;
 116 } vlib_worker_thread_t;
 117
 118 extern vlib_worker_thread_t *vlib_worker_threads;
 119
 120 typedef struct
 121 {
 122   /* enqueue side */
 123   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 124   volatile u64 tail;
 125   u64 enqueues;
 126   u64 enqueue_ticks;
 127   u64 enqueue_vectors;
 128   u32 enqueue_full_events;
 129
 130   /* dequeue side */
 131     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 132   volatile u64 head;
 133   u64 dequeues;
 134   u64 dequeue_ticks;
 135   u64 dequeue_vectors;
 136   u64 trace;
 137   u64 vector_threshold;
 138
 139   /* dequeue hint to enqueue side */
 140     CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
 141   volatile u64 head_hint;
 142
 143   /* read-only, constant, shared */
 144     CLIB_CACHE_LINE_ALIGN_MARK (cacheline3);
 145   vlib_frame_queue_elt_t *elts;
 146   u32 nelts;
 147 }
 148 vlib_frame_queue_t;
 149
 150 typedef struct
 151 {
 152   vlib_frame_queue_elt_t **handoff_queue_elt_by_thread_index;
 153   vlib_frame_queue_t **congested_handoff_queue_by_thread_index;
 154 } vlib_frame_queue_per_thread_data_t;
 155
 156 typedef struct
 157 {
 158   u32 node_index;
 159   u32 frame_queue_nelts;
 160   u32 queue_hi_thresh;
 161
 162   vlib_frame_queue_t **vlib_frame_queues;
 163   vlib_frame_queue_per_thread_data_t *per_thread_data;
 164
 165   /* for frame queue tracing */
 166   frame_queue_trace_t *frame_queue_traces;
 167   frame_queue_nelt_counter_t *frame_queue_histogram;
 168 } vlib_frame_queue_main_t;
 169
 170 typedef struct
 171 {
 172   uword node_index;
 173   uword type_opaque;
 174   uword data;
 175 } vlib_process_signal_event_mt_args_t;
 176
 177 /* Called early, in thread 0's context */
 178 clib_error_t *vlib_thread_init (vlib_main_t * vm);
 179
 180 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
 181                               u32 frame_queue_index, vlib_frame_t * frame,
 182                               vlib_frame_queue_msg_type_t type);
 183
 184 int
 185 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm);
 186
 187 void vlib_worker_thread_node_runtime_update (void);
 188
 189 void vlib_create_worker_threads (vlib_main_t * vm, int n,
 190                                  void (*thread_function) (void *));
 191
 192 void vlib_worker_thread_init (vlib_worker_thread_t * w);
 193 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
 194
 195 /* Check for a barrier sync request every 30ms */
 196 #define BARRIER_SYNC_DELAY (0.030000)
 197
 198 #if CLIB_DEBUG > 0
 199 /* long barrier timeout, for gdb... */
 200 #define BARRIER_SYNC_TIMEOUT (600.1)
 201 #else
 202 #define BARRIER_SYNC_TIMEOUT (1.0)
 203 #endif
 204
 205 #define vlib_worker_thread_barrier_sync(X) {vlib_worker_thread_barrier_sync_int(X, __FUNCTION__);}
 206
 207 void vlib_worker_thread_barrier_sync_int (vlib_main_t * vm,
 208                                           const char *func_name);
 209 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
 210 void vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm);
 211 void vlib_worker_thread_node_refork (void);
 212
 213 static_always_inline uword
 214 vlib_get_thread_index (void)
 215 {
 216   return __os_thread_index;
 217 }
 218
 219 always_inline void
 220 vlib_smp_unsafe_warning (void)
 221 {
 222   if (CLIB_DEBUG > 0)
 223     {
 224       if (vlib_get_thread_index ())
 225         fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
 226     }
 227 }
 228
 229 typedef enum
 230 {
 231   VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
 232   VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
 233 } vlib_fork_fixup_t;
 234
 235 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
 236
 237 #define foreach_vlib_main(body)                         \
 238 do {                                                    \
 239   vlib_main_t ** __vlib_mains = 0, *this_vlib_main;     \
 240   int ii;                                               \
 241                                                         \
 242   for (ii = 0; ii < vec_len (vlib_mains); ii++)         \
 243     {                                                   \
 244       this_vlib_main = vlib_mains[ii];                  \
 245       ASSERT (ii == 0 ||                                \
 246               this_vlib_main->parked_at_barrier == 1);  \
 247       if (this_vlib_main)                               \
 248         vec_add1 (__vlib_mains, this_vlib_main);        \
 249     }                                                   \
 250                                                         \
 251   for (ii = 0; ii < vec_len (__vlib_mains); ii++)       \
 252     {                                                   \
 253       this_vlib_main = __vlib_mains[ii];                \
 254       /* body uses this_vlib_main... */                 \
 255       (body);                                           \
 256     }                                                   \
 257   vec_free (__vlib_mains);                              \
 258 } while (0);
 259
 260 #define foreach_sched_policy \
 261   _(SCHED_OTHER, OTHER, "other") \
 262   _(SCHED_BATCH, BATCH, "batch") \
 263   _(SCHED_IDLE, IDLE, "idle")   \
 264   _(SCHED_FIFO, FIFO, "fifo")   \
 265   _(SCHED_RR, RR, "rr")
 266
 267 typedef enum
 268 {
 269 #define _(v,f,s) SCHED_POLICY_##f = v,
 270   foreach_sched_policy
 271 #undef _
 272     SCHED_POLICY_N,
 273 } sched_policy_t;
 274
 275 typedef struct
 276 {
 277   clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
 278                                           unsigned cpu_id);
 279   clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 cpu);
 280 } vlib_thread_callbacks_t;
 281
 282 typedef struct
 283 {
 284   /* Link list of registrations, built by constructors */
 285   vlib_thread_registration_t *next;
 286
 287   /* Vector of registrations, w/ non-data-structure clones at the top */
 288   vlib_thread_registration_t **registrations;
 289
 290   uword *thread_registrations_by_name;
 291
 292   vlib_worker_thread_t *worker_threads;
 293
 294   /*
 295    * Launch all threads as pthreads,
 296    * not eal_rte_launch (strict affinity) threads
 297    */
 298   int use_pthreads;
 299
 300   /* Number of vlib_main / vnet_main clones */
 301   u32 n_vlib_mains;
 302
 303   /* Number of thread stacks to create */
 304   u32 n_thread_stacks;
 305
 306   /* Number of pthreads */
 307   u32 n_pthreads;
 308
 309   /* Number of threads */
 310   u32 n_threads;
 311
 312   /* Number of cores to skip, must match the core mask */
 313   u32 skip_cores;
 314
 315   /* Thread prefix name */
 316   u8 *thread_prefix;
 317
 318   /* main thread lcore */
 319   u32 main_lcore;
 320
 321   /* Bitmap of available CPU cores */
 322   uword *cpu_core_bitmap;
 323
 324   /* Bitmap of available CPU sockets (NUMA nodes) */
 325   uword *cpu_socket_bitmap;
 326
 327   /* Worker handoff queues */
 328   vlib_frame_queue_main_t *frame_queue_mains;
 329
 330   /* worker thread initialization barrier */
 331   volatile u32 worker_thread_release;
 332
 333   /* scheduling policy */
 334   u32 sched_policy;
 335
 336   /* scheduling policy priority */
 337   u32 sched_priority;
 338
 339   /* callbacks */
 340   vlib_thread_callbacks_t cb;
 341   int extern_thread_mgmt;
 342
 343   /* NUMA-bound heap size */
 344   uword numa_heap_size;
 345
 346 } vlib_thread_main_t;
 347
 348 extern vlib_thread_main_t vlib_thread_main;
 349
 350 #include <vlib/global_funcs.h>
 351
 352 #define VLIB_REGISTER_THREAD(x,...)                     \
 353   __VA_ARGS__ vlib_thread_registration_t x;             \
 354 static void __vlib_add_thread_registration_##x (void)   \
 355   __attribute__((__constructor__)) ;                    \
 356 static void __vlib_add_thread_registration_##x (void)   \
 357 {                                                       \
 358   vlib_thread_main_t * tm = &vlib_thread_main;          \
 359   x.next = tm->next;                                    \
 360   tm->next = &x;                                        \
 361 }                                                       \
 362 static void __vlib_rm_thread_registration_##x (void)    \
 363   __attribute__((__destructor__)) ;                     \
 364 static void __vlib_rm_thread_registration_##x (void)    \
 365 {                                                       \
 366   vlib_thread_main_t * tm = &vlib_thread_main;          \
 367   VLIB_REMOVE_FROM_LINKED_LIST (tm->next, &x, next);    \
 368 }                                                       \
 369 __VA_ARGS__ vlib_thread_registration_t x
 370
 371 always_inline u32
 372 vlib_num_workers ()
 373 {
 374   return vlib_thread_main.n_vlib_mains - 1;
 375 }
 376
 377 always_inline u32
 378 vlib_get_worker_thread_index (u32 worker_index)
 379 {
 380   return worker_index + 1;
 381 }
 382
 383 always_inline u32
 384 vlib_get_worker_index (u32 thread_index)
 385 {
 386   return thread_index - 1;
 387 }
 388
 389 always_inline u32
 390 vlib_get_current_worker_index ()
 391 {
 392   return vlib_get_thread_index () - 1;
 393 }
 394
 395 static inline void
 396 vlib_worker_thread_barrier_check (void)
 397 {
 398   if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
 399     {
 400       vlib_main_t *vm = vlib_get_main ();
 401       u32 thread_index = vm->thread_index;
 402       f64 t = vlib_time_now (vm);
 403
 404       if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
 405         clib_call_callbacks (vm->barrier_perf_callbacks, vm,
 406                              vm->clib_time.last_cpu_time, 0 /* enter */ );
 407
 408       if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 409         {
 410           vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 411           /* *INDENT-OFF* */
 412           ELOG_TYPE_DECLARE (e) = {
 413             .format = "barrier-wait-thread-%d",
 414             .format_args = "i4",
 415           };
 416           /* *INDENT-ON* */
 417
 418           struct
 419           {
 420             u32 thread_index;
 421           } __clib_packed *ed;
 422
 423           ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
 424                                 w->elog_track);
 425           ed->thread_index = thread_index;
 426         }
 427
 428       if (CLIB_DEBUG > 0)
 429         {
 430           vm = vlib_get_main ();
 431           vm->parked_at_barrier = 1;
 432         }
 433       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
 434       while (*vlib_worker_threads->wait_at_barrier)
 435         ;
 436
 437       /*
 438        * Recompute the offset from thread-0 time.
 439        * Note that vlib_time_now adds vm->time_offset, so
 440        * clear it first. Save the resulting idea of "now", to
 441        * see how well we're doing. See show_clock_command_fn(...)
 442        */
 443       {
 444         f64 now;
 445         vm->time_offset = 0.0;
 446         now = vlib_time_now (vm);
 447         vm->time_offset = vlib_global_main.time_last_barrier_release - now;
 448         vm->time_last_barrier_release = vlib_time_now (vm);
 449       }
 450
 451       if (CLIB_DEBUG > 0)
 452         vm->parked_at_barrier = 0;
 453       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
 454
 455       if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
 456         {
 457           if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 458             {
 459               t = vlib_time_now (vm) - t;
 460               vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 461               /* *INDENT-OFF* */
 462               ELOG_TYPE_DECLARE (e) = {
 463                 .format = "barrier-refork-thread-%d",
 464                 .format_args = "i4",
 465               };
 466               /* *INDENT-ON* */
 467
 468               struct
 469               {
 470                 u32 thread_index;
 471               } __clib_packed *ed;
 472
 473               ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
 474                                     w->elog_track);
 475               ed->thread_index = thread_index;
 476             }
 477
 478           vlib_worker_thread_node_refork ();
 479           clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
 480                                  -1);
 481           while (*vlib_worker_threads->node_reforks_required)
 482             ;
 483         }
 484       if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 485         {
 486           t = vlib_time_now (vm) - t;
 487           vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 488           /* *INDENT-OFF* */
 489           ELOG_TYPE_DECLARE (e) = {
 490             .format = "barrier-released-thread-%d: %dus",
 491             .format_args = "i4i4",
 492           };
 493           /* *INDENT-ON* */
 494
 495           struct
 496           {
 497             u32 thread_index;
 498             u32 duration;
 499           } __clib_packed *ed;
 500
 501           ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
 502                                 w->elog_track);
 503           ed->thread_index = thread_index;
 504           ed->duration = (int) (1000000.0 * t);
 505         }
 506
 507       if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
 508         clib_call_callbacks (vm->barrier_perf_callbacks, vm,
 509                              vm->clib_time.last_cpu_time, 1 /* leave */ );
 510     }
 511 }
 512
 513 always_inline vlib_main_t *
 514 vlib_get_worker_vlib_main (u32 worker_index)
 515 {
 516   vlib_main_t *vm;
 517   vlib_thread_main_t *tm = &vlib_thread_main;
 518   ASSERT (worker_index < tm->n_vlib_mains - 1);
 519   vm = vlib_mains[worker_index + 1];
 520   ASSERT (vm);
 521   return vm;
 522 }
 523
 524 static inline u8
 525 vlib_thread_is_main_w_barrier (void)
 526 {
 527   return (!vlib_num_workers ()
 528           || ((vlib_get_thread_index () == 0
 529                && vlib_worker_threads->wait_at_barrier[0])));
 530 }
 531
 532 static inline void
 533 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
 534 {
 535   CLIB_MEMORY_BARRIER ();
 536   hf->valid = 1;
 537 }
 538
 539 static inline vlib_frame_queue_elt_t *
 540 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
 541 {
 542   vlib_frame_queue_t *fq;
 543   vlib_frame_queue_elt_t *elt;
 544   vlib_thread_main_t *tm = &vlib_thread_main;
 545   vlib_frame_queue_main_t *fqm =
 546     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 547   u64 new_tail;
 548
 549   fq = fqm->vlib_frame_queues[index];
 550   ASSERT (fq);
 551
 552   new_tail = clib_atomic_add_fetch (&fq->tail, 1);
 553
 554   /* Wait until a ring slot is available */
 555   while (new_tail >= fq->head_hint + fq->nelts)
 556     vlib_worker_thread_barrier_check ();
 557
 558   elt = fq->elts + (new_tail & (fq->nelts - 1));
 559
 560   /* this would be very bad... */
 561   while (elt->valid)
 562     ;
 563
 564   elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
 565   elt->last_n_vectors = elt->n_vectors = 0;
 566
 567   return elt;
 568 }
 569
 570 static inline vlib_frame_queue_t *
 571 is_vlib_frame_queue_congested (u32 frame_queue_index,
 572                                u32 index,
 573                                u32 queue_hi_thresh,
 574                                vlib_frame_queue_t **
 575                                handoff_queue_by_worker_index)
 576 {
 577   vlib_frame_queue_t *fq;
 578   vlib_thread_main_t *tm = &vlib_thread_main;
 579   vlib_frame_queue_main_t *fqm =
 580     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 581
 582   fq = handoff_queue_by_worker_index[index];
 583   if (fq != (vlib_frame_queue_t *) (~0))
 584     return fq;
 585
 586   fq = fqm->vlib_frame_queues[index];
 587   ASSERT (fq);
 588
 589   if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
 590     {
 591       /* a valid entry in the array will indicate the queue has reached
 592        * the specified threshold and is congested
 593        */
 594       handoff_queue_by_worker_index[index] = fq;
 595       fq->enqueue_full_events++;
 596       return fq;
 597     }
 598
 599   return NULL;
 600 }
 601
 602 static inline vlib_frame_queue_elt_t *
 603 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
 604                                    u32 vlib_worker_index,
 605                                    vlib_frame_queue_elt_t **
 606                                    handoff_queue_elt_by_worker_index)
 607 {
 608   vlib_frame_queue_elt_t *elt;
 609
 610   if (handoff_queue_elt_by_worker_index[vlib_worker_index])
 611     return handoff_queue_elt_by_worker_index[vlib_worker_index];
 612
 613   elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
 614
 615   handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
 616
 617   return elt;
 618 }
 619
 620 u8 *vlib_thread_stack_init (uword thread_index);
 621 int vlib_thread_cb_register (struct vlib_main_t *vm,
 622                              vlib_thread_callbacks_t * cb);
 623 extern void *rpc_call_main_thread_cb_fn;
 624
 625 void
 626 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
 627                                      args);
 628 void vlib_rpc_call_main_thread (void *function, u8 * args, u32 size);
 629 void vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id);
 630
 631
 632 #endif /* included_vlib_threads_h */
 633
 634 /*
 635  * fd.io coding-style-patch-verification: ON
 636  *
 637  * Local Variables:
 638  * eval: (c-set-style "gnu")
 639  * End:
 640  */