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 void vlib_worker_thread_node_runtime_update (void);
 183
 184 void vlib_create_worker_threads (vlib_main_t * vm, int n,
 185                                  void (*thread_function) (void *));
 186
 187 void vlib_worker_thread_init (vlib_worker_thread_t * w);
 188 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
 189
 190 /* Check for a barrier sync request every 30ms */
 191 #define BARRIER_SYNC_DELAY (0.030000)
 192
 193 #if CLIB_DEBUG > 0
 194 /* long barrier timeout, for gdb... */
 195 #define BARRIER_SYNC_TIMEOUT (600.1)
 196 #else
 197 #define BARRIER_SYNC_TIMEOUT (1.0)
 198 #endif
 199
 200 #define vlib_worker_thread_barrier_sync(X) {vlib_worker_thread_barrier_sync_int(X, __FUNCTION__);}
 201
 202 void vlib_worker_thread_barrier_sync_int (vlib_main_t * vm,
 203                                           const char *func_name);
 204 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
 205 u8 vlib_worker_thread_barrier_held (void);
 206 void vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm);
 207 void vlib_worker_thread_node_refork (void);
 208 /**
 209  * Wait until each of the workers has been once around the track
 210  */
 211 void vlib_worker_wait_one_loop (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 always_inline int
 230 __foreach_vlib_main_helper (vlib_main_t *ii, vlib_main_t **p)
 231 {
 232   vlib_main_t *vm;
 233   u32 index = ii - (vlib_main_t *) 0;
 234
 235   if (index >= vec_len (vlib_global_main.vlib_mains))
 236     return 0;
 237
 238   *p = vm = vlib_global_main.vlib_mains[index];
 239   ASSERT (index == 0 || vm->parked_at_barrier == 1);
 240   return 1;
 241 }
 242
 243 #define foreach_vlib_main()                                                   \
 244   for (vlib_main_t *ii = 0, *this_vlib_main;                                  \
 245        __foreach_vlib_main_helper (ii, &this_vlib_main); ii++)                \
 246     if (this_vlib_main)
 247
 248 #define foreach_sched_policy \
 249   _(SCHED_OTHER, OTHER, "other") \
 250   _(SCHED_BATCH, BATCH, "batch") \
 251   _(SCHED_IDLE, IDLE, "idle")   \
 252   _(SCHED_FIFO, FIFO, "fifo")   \
 253   _(SCHED_RR, RR, "rr")
 254
 255 typedef enum
 256 {
 257 #define _(v,f,s) SCHED_POLICY_##f = v,
 258   foreach_sched_policy
 259 #undef _
 260     SCHED_POLICY_N,
 261 } sched_policy_t;
 262
 263 typedef struct
 264 {
 265   clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
 266                                           unsigned cpu_id);
 267   clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 cpu);
 268 } vlib_thread_callbacks_t;
 269
 270 typedef struct
 271 {
 272   /* Link list of registrations, built by constructors */
 273   vlib_thread_registration_t *next;
 274
 275   /* Vector of registrations, w/ non-data-structure clones at the top */
 276   vlib_thread_registration_t **registrations;
 277
 278   uword *thread_registrations_by_name;
 279
 280   vlib_worker_thread_t *worker_threads;
 281
 282   /*
 283    * Launch all threads as pthreads,
 284    * not eal_rte_launch (strict affinity) threads
 285    */
 286   int use_pthreads;
 287
 288   /* Number of vlib_main / vnet_main clones */
 289   u32 n_vlib_mains;
 290
 291   /* Number of thread stacks to create */
 292   u32 n_thread_stacks;
 293
 294   /* Number of pthreads */
 295   u32 n_pthreads;
 296
 297   /* Number of threads */
 298   u32 n_threads;
 299
 300   /* Number of cores to skip, must match the core mask */
 301   u32 skip_cores;
 302
 303   /* Thread prefix name */
 304   u8 *thread_prefix;
 305
 306   /* main thread lcore */
 307   u32 main_lcore;
 308
 309   /* Bitmap of available CPU cores */
 310   uword *cpu_core_bitmap;
 311
 312   /* Bitmap of available CPU sockets (NUMA nodes) */
 313   uword *cpu_socket_bitmap;
 314
 315   /* Worker handoff queues */
 316   vlib_frame_queue_main_t *frame_queue_mains;
 317
 318   /* worker thread initialization barrier */
 319   volatile u32 worker_thread_release;
 320
 321   /* scheduling policy */
 322   u32 sched_policy;
 323
 324   /* scheduling policy priority */
 325   u32 sched_priority;
 326
 327   /* callbacks */
 328   vlib_thread_callbacks_t cb;
 329   int extern_thread_mgmt;
 330
 331   /* NUMA-bound heap size */
 332   uword numa_heap_size;
 333
 334 } vlib_thread_main_t;
 335
 336 extern vlib_thread_main_t vlib_thread_main;
 337
 338 #include <vlib/global_funcs.h>
 339
 340 #define VLIB_REGISTER_THREAD(x,...)                     \
 341   __VA_ARGS__ vlib_thread_registration_t x;             \
 342 static void __vlib_add_thread_registration_##x (void)   \
 343   __attribute__((__constructor__)) ;                    \
 344 static void __vlib_add_thread_registration_##x (void)   \
 345 {                                                       \
 346   vlib_thread_main_t * tm = &vlib_thread_main;          \
 347   x.next = tm->next;                                    \
 348   tm->next = &x;                                        \
 349 }                                                       \
 350 static void __vlib_rm_thread_registration_##x (void)    \
 351   __attribute__((__destructor__)) ;                     \
 352 static void __vlib_rm_thread_registration_##x (void)    \
 353 {                                                       \
 354   vlib_thread_main_t * tm = &vlib_thread_main;          \
 355   VLIB_REMOVE_FROM_LINKED_LIST (tm->next, &x, next);    \
 356 }                                                       \
 357 __VA_ARGS__ vlib_thread_registration_t x
 358
 359 always_inline u32
 360 vlib_num_workers ()
 361 {
 362   return vlib_thread_main.n_vlib_mains - 1;
 363 }
 364
 365 always_inline u32
 366 vlib_get_worker_thread_index (u32 worker_index)
 367 {
 368   return worker_index + 1;
 369 }
 370
 371 always_inline u32
 372 vlib_get_worker_index (u32 thread_index)
 373 {
 374   return thread_index - 1;
 375 }
 376
 377 always_inline u32
 378 vlib_get_current_worker_index ()
 379 {
 380   return vlib_get_thread_index () - 1;
 381 }
 382
 383 static inline void
 384 vlib_worker_thread_barrier_check (void)
 385 {
 386   if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
 387     {
 388       vlib_global_main_t *vgm = vlib_get_global_main ();
 389       vlib_main_t *vm = vlib_get_main ();
 390       u32 thread_index = vm->thread_index;
 391       f64 t = vlib_time_now (vm);
 392
 393       if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
 394         clib_call_callbacks (vm->barrier_perf_callbacks, vm,
 395                              vm->clib_time.last_cpu_time, 0 /* enter */ );
 396
 397       if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 398         {
 399           vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 400           /* *INDENT-OFF* */
 401           ELOG_TYPE_DECLARE (e) = {
 402             .format = "barrier-wait-thread-%d",
 403             .format_args = "i4",
 404           };
 405           /* *INDENT-ON* */
 406
 407           struct
 408           {
 409             u32 thread_index;
 410           } __clib_packed *ed;
 411
 412           ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e, w->elog_track);
 413           ed->thread_index = thread_index;
 414         }
 415
 416       if (CLIB_DEBUG > 0)
 417         {
 418           vm = vlib_get_main ();
 419           vm->parked_at_barrier = 1;
 420         }
 421       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
 422       while (*vlib_worker_threads->wait_at_barrier)
 423         ;
 424
 425       /*
 426        * Recompute the offset from thread-0 time.
 427        * Note that vlib_time_now adds vm->time_offset, so
 428        * clear it first. Save the resulting idea of "now", to
 429        * see how well we're doing. See show_clock_command_fn(...)
 430        */
 431       {
 432         f64 now;
 433         vm->time_offset = 0.0;
 434         now = vlib_time_now (vm);
 435         vm->time_offset = vgm->vlib_mains[0]->time_last_barrier_release - now;
 436         vm->time_last_barrier_release = vlib_time_now (vm);
 437       }
 438
 439       if (CLIB_DEBUG > 0)
 440         vm->parked_at_barrier = 0;
 441       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
 442
 443       if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
 444         {
 445           if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 446             {
 447               t = vlib_time_now (vm) - t;
 448               vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 449               /* *INDENT-OFF* */
 450               ELOG_TYPE_DECLARE (e) = {
 451                 .format = "barrier-refork-thread-%d",
 452                 .format_args = "i4",
 453               };
 454               /* *INDENT-ON* */
 455
 456               struct
 457               {
 458                 u32 thread_index;
 459               } __clib_packed *ed;
 460
 461               ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
 462                                     w->elog_track);
 463               ed->thread_index = thread_index;
 464             }
 465
 466           vlib_worker_thread_node_refork ();
 467           clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
 468                                  -1);
 469           while (*vlib_worker_threads->node_reforks_required)
 470             ;
 471         }
 472       if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 473         {
 474           t = vlib_time_now (vm) - t;
 475           vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 476           /* *INDENT-OFF* */
 477           ELOG_TYPE_DECLARE (e) = {
 478             .format = "barrier-released-thread-%d: %dus",
 479             .format_args = "i4i4",
 480           };
 481           /* *INDENT-ON* */
 482
 483           struct
 484           {
 485             u32 thread_index;
 486             u32 duration;
 487           } __clib_packed *ed;
 488
 489           ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e, w->elog_track);
 490           ed->thread_index = thread_index;
 491           ed->duration = (int) (1000000.0 * t);
 492         }
 493
 494       if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
 495         clib_call_callbacks (vm->barrier_perf_callbacks, vm,
 496                              vm->clib_time.last_cpu_time, 1 /* leave */ );
 497     }
 498 }
 499
 500 always_inline vlib_main_t *
 501 vlib_get_worker_vlib_main (u32 worker_index)
 502 {
 503   vlib_main_t *vm;
 504   vlib_thread_main_t *tm = &vlib_thread_main;
 505   ASSERT (worker_index < tm->n_vlib_mains - 1);
 506   vm = vlib_get_main_by_index (worker_index + 1);
 507   ASSERT (vm);
 508   return vm;
 509 }
 510
 511 static inline u8
 512 vlib_thread_is_main_w_barrier (void)
 513 {
 514   return (!vlib_num_workers ()
 515           || ((vlib_get_thread_index () == 0
 516                && vlib_worker_threads->wait_at_barrier[0])));
 517 }
 518
 519 static inline void
 520 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
 521 {
 522   CLIB_MEMORY_BARRIER ();
 523   hf->valid = 1;
 524 }
 525
 526 static inline vlib_frame_queue_elt_t *
 527 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
 528 {
 529   vlib_frame_queue_t *fq;
 530   vlib_frame_queue_elt_t *elt;
 531   vlib_thread_main_t *tm = &vlib_thread_main;
 532   vlib_frame_queue_main_t *fqm =
 533     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 534   u64 new_tail;
 535
 536   fq = fqm->vlib_frame_queues[index];
 537   ASSERT (fq);
 538
 539   new_tail = clib_atomic_add_fetch (&fq->tail, 1);
 540
 541   /* Wait until a ring slot is available */
 542   while (new_tail >= fq->head_hint + fq->nelts)
 543     vlib_worker_thread_barrier_check ();
 544
 545   elt = fq->elts + (new_tail & (fq->nelts - 1));
 546
 547   /* this would be very bad... */
 548   while (elt->valid)
 549     ;
 550
 551   elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
 552   elt->last_n_vectors = elt->n_vectors = 0;
 553
 554   return elt;
 555 }
 556
 557 static inline vlib_frame_queue_t *
 558 is_vlib_frame_queue_congested (u32 frame_queue_index,
 559                                u32 index,
 560                                u32 queue_hi_thresh,
 561                                vlib_frame_queue_t **
 562                                handoff_queue_by_worker_index)
 563 {
 564   vlib_frame_queue_t *fq;
 565   vlib_thread_main_t *tm = &vlib_thread_main;
 566   vlib_frame_queue_main_t *fqm =
 567     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 568
 569   fq = handoff_queue_by_worker_index[index];
 570   if (fq != (vlib_frame_queue_t *) (~0))
 571     return fq;
 572
 573   fq = fqm->vlib_frame_queues[index];
 574   ASSERT (fq);
 575
 576   if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
 577     {
 578       /* a valid entry in the array will indicate the queue has reached
 579        * the specified threshold and is congested
 580        */
 581       handoff_queue_by_worker_index[index] = fq;
 582       fq->enqueue_full_events++;
 583       return fq;
 584     }
 585
 586   return NULL;
 587 }
 588
 589 static inline vlib_frame_queue_elt_t *
 590 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
 591                                    u32 vlib_worker_index,
 592                                    vlib_frame_queue_elt_t **
 593                                    handoff_queue_elt_by_worker_index)
 594 {
 595   vlib_frame_queue_elt_t *elt;
 596
 597   if (handoff_queue_elt_by_worker_index[vlib_worker_index])
 598     return handoff_queue_elt_by_worker_index[vlib_worker_index];
 599
 600   elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
 601
 602   handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
 603
 604   return elt;
 605 }
 606
 607 u8 *vlib_thread_stack_init (uword thread_index);
 608 int vlib_thread_cb_register (struct vlib_main_t *vm,
 609                              vlib_thread_callbacks_t * cb);
 610 extern void *rpc_call_main_thread_cb_fn;
 611
 612 void
 613 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
 614                                      args);
 615 void vlib_rpc_call_main_thread (void *function, u8 * args, u32 size);
 616 void vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id);
 617 vlib_thread_main_t *vlib_get_thread_main_not_inline (void);
 618
 619 #endif /* included_vlib_threads_h */
 620
 621 /*
 622  * fd.io coding-style-patch-verification: ON
 623  *
 624  * Local Variables:
 625  * eval: (c-set-style "gnu")
 626  * End:
 627  */