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