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