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 <linux/sched.h>
  20
  21 extern vlib_main_t **vlib_mains;
  22
  23 void vlib_set_thread_name (char *name);
  24
  25 /* arg is actually a vlib__thread_t * */
  26 typedef void (vlib_thread_function_t) (void *arg);
  27
  28 typedef struct vlib_thread_registration_
  29 {
  30   /* constructor generated list of thread registrations */
  31   struct vlib_thread_registration_ *next;
  32
  33   /* config parameters */
  34   char *name;
  35   char *short_name;
  36   vlib_thread_function_t *function;
  37   uword mheap_size;
  38   int fixed_count;
  39   u32 count;
  40   int no_data_structure_clone;
  41   u32 frame_queue_nelts;
  42
  43   /* All threads of this type run on pthreads */
  44   int use_pthreads;
  45   u32 first_index;
  46   uword *coremask;
  47 } vlib_thread_registration_t;
  48
  49 /*
  50  * Frames have their cpu / vlib_main_t index in the low-order N bits
  51  * Make VLIB_MAX_CPUS a power-of-two, please...
  52  */
  53
  54 #ifndef VLIB_MAX_CPUS
  55 #define VLIB_MAX_CPUS 256
  56 #endif
  57
  58 #if VLIB_MAX_CPUS > CLIB_MAX_MHEAPS
  59 #error Please increase number of per-cpu mheaps
  60 #endif
  61
  62 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1)       /* 0x3f, max */
  63 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
  64
  65 #define VLIB_LOG2_THREAD_STACK_SIZE (21)
  66 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
  67
  68 typedef enum
  69 {
  70   VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
  71 } vlib_frame_queue_msg_type_t;
  72
  73 typedef struct
  74 {
  75   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  76   volatile u32 valid;
  77   u32 msg_type;
  78   u32 n_vectors;
  79   u32 last_n_vectors;
  80
  81   /* 256 * 4 = 1024 bytes, even mult of cache line size */
  82   u32 buffer_index[VLIB_FRAME_SIZE];
  83 }
  84 vlib_frame_queue_elt_t;
  85
  86 typedef struct
  87 {
  88   /* First cache line */
  89   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  90   volatile u32 *wait_at_barrier;
  91   volatile u32 *workers_at_barrier;
  92
  93   /* Second Cache Line */
  94     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  95   void *thread_mheap;
  96   u8 *thread_stack;
  97   void (*thread_function) (void *);
  98   void *thread_function_arg;
  99   i64 recursion_level;
 100   elog_track_t elog_track;
 101   u32 instance_id;
 102   vlib_thread_registration_t *registration;
 103   u8 *name;
 104   u64 barrier_sync_count;
 105   u8 barrier_elog_enabled;
 106   const char *barrier_caller;
 107   const char *barrier_context;
 108   volatile u32 *node_reforks_required;
 109
 110   long lwp;
 111   int cpu_id;
 112   int core_id;
 113   int socket_id;
 114   pthread_t thread_id;
 115 } vlib_worker_thread_t;
 116
 117 extern vlib_worker_thread_t *vlib_worker_threads;
 118
 119 typedef struct
 120 {
 121   /* enqueue side */
 122   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 123   volatile u64 tail;
 124   u64 enqueues;
 125   u64 enqueue_ticks;
 126   u64 enqueue_vectors;
 127   u32 enqueue_full_events;
 128
 129   /* dequeue side */
 130     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 131   volatile u64 head;
 132   u64 dequeues;
 133   u64 dequeue_ticks;
 134   u64 dequeue_vectors;
 135   u64 trace;
 136   u64 vector_threshold;
 137
 138   /* dequeue hint to enqueue side */
 139     CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
 140   volatile u64 head_hint;
 141
 142   /* read-only, constant, shared */
 143     CLIB_CACHE_LINE_ALIGN_MARK (cacheline3);
 144   vlib_frame_queue_elt_t *elts;
 145   u32 nelts;
 146 }
 147 vlib_frame_queue_t;
 148
 149 typedef struct
 150 {
 151   vlib_frame_queue_elt_t **handoff_queue_elt_by_thread_index;
 152   vlib_frame_queue_t **congested_handoff_queue_by_thread_index;
 153 } vlib_frame_queue_per_thread_data_t;
 154
 155 typedef struct
 156 {
 157   u32 node_index;
 158   u32 frame_queue_nelts;
 159   u32 queue_hi_thresh;
 160
 161   vlib_frame_queue_t **vlib_frame_queues;
 162   vlib_frame_queue_per_thread_data_t *per_thread_data;
 163
 164   /* for frame queue tracing */
 165   frame_queue_trace_t *frame_queue_traces;
 166   frame_queue_nelt_counter_t *frame_queue_histogram;
 167 } vlib_frame_queue_main_t;
 168
 169 typedef struct
 170 {
 171   uword node_index;
 172   uword type_opaque;
 173   uword data;
 174 } vlib_process_signal_event_mt_args_t;
 175
 176 /* Called early, in thread 0's context */
 177 clib_error_t *vlib_thread_init (vlib_main_t * vm);
 178
 179 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
 180                               u32 frame_queue_index, vlib_frame_t * frame,
 181                               vlib_frame_queue_msg_type_t type);
 182
 183 int
 184 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm);
 185
 186 void vlib_worker_thread_node_runtime_update (void);
 187
 188 void vlib_create_worker_threads (vlib_main_t * vm, int n,
 189                                  void (*thread_function) (void *));
 190
 191 void vlib_worker_thread_init (vlib_worker_thread_t * w);
 192 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
 193
 194 /* Check for a barrier sync request every 30ms */
 195 #define BARRIER_SYNC_DELAY (0.030000)
 196
 197 #if CLIB_DEBUG > 0
 198 /* long barrier timeout, for gdb... */
 199 #define BARRIER_SYNC_TIMEOUT (600.1)
 200 #else
 201 #define BARRIER_SYNC_TIMEOUT (1.0)
 202 #endif
 203
 204 #define vlib_worker_thread_barrier_sync(X) {vlib_worker_thread_barrier_sync_int(X, __FUNCTION__);}
 205
 206 void vlib_worker_thread_barrier_sync_int (vlib_main_t * vm,
 207                                           const char *func_name);
 208 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
 209 u8 vlib_worker_thread_barrier_held (void);
 210 void vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm);
 211 void vlib_worker_thread_node_refork (void);
 212 /**
 213  * Wait until each of the workers has been once around the track
 214  */
 215 void vlib_worker_wait_one_loop (void);
 216
 217 static_always_inline uword
 218 vlib_get_thread_index (void)
 219 {
 220   return __os_thread_index;
 221 }
 222
 223 always_inline void
 224 vlib_smp_unsafe_warning (void)
 225 {
 226   if (CLIB_DEBUG > 0)
 227     {
 228       if (vlib_get_thread_index ())
 229         fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
 230     }
 231 }
 232
 233 typedef enum
 234 {
 235   VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
 236   VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
 237 } vlib_fork_fixup_t;
 238
 239 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
 240
 241 #define foreach_vlib_main(body)                         \
 242 do {                                                    \
 243   vlib_main_t ** __vlib_mains = 0, *this_vlib_main;     \
 244   int ii;                                               \
 245                                                         \
 246   for (ii = 0; ii < vec_len (vlib_mains); ii++)         \
 247     {                                                   \
 248       this_vlib_main = vlib_mains[ii];                  \
 249       ASSERT (ii == 0 ||                                \
 250               this_vlib_main->parked_at_barrier == 1);  \
 251       if (this_vlib_main)                               \
 252         vec_add1 (__vlib_mains, this_vlib_main);        \
 253     }                                                   \
 254                                                         \
 255   for (ii = 0; ii < vec_len (__vlib_mains); ii++)       \
 256     {                                                   \
 257       this_vlib_main = __vlib_mains[ii];                \
 258       /* body uses this_vlib_main... */                 \
 259       (body);                                           \
 260     }                                                   \
 261   vec_free (__vlib_mains);                              \
 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 } 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 (vlib_worker_threads->barrier_elog_enabled))
 405         {
 406           vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 407           /* *INDENT-OFF* */
 408           ELOG_TYPE_DECLARE (e) = {
 409             .format = "barrier-wait-thread-%d",
 410             .format_args = "i4",
 411           };
 412           /* *INDENT-ON* */
 413
 414           struct
 415           {
 416             u32 thread_index;
 417           } __clib_packed *ed;
 418
 419           ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
 420                                 w->elog_track);
 421           ed->thread_index = thread_index;
 422         }
 423
 424       if (CLIB_DEBUG > 0)
 425         {
 426           vm = vlib_get_main ();
 427           vm->parked_at_barrier = 1;
 428         }
 429       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
 430       while (*vlib_worker_threads->wait_at_barrier)
 431         ;
 432
 433       /*
 434        * Recompute the offset from thread-0 time.
 435        * Note that vlib_time_now adds vm->time_offset, so
 436        * clear it first. Save the resulting idea of "now", to
 437        * see how well we're doing. See show_clock_command_fn(...)
 438        */
 439       {
 440         f64 now;
 441         vm->time_offset = 0.0;
 442         now = vlib_time_now (vm);
 443         vm->time_offset = vlib_global_main.time_last_barrier_release - now;
 444         vm->time_last_barrier_release = vlib_time_now (vm);
 445       }
 446
 447       if (CLIB_DEBUG > 0)
 448         vm->parked_at_barrier = 0;
 449       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
 450
 451       if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
 452         {
 453           if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 454             {
 455               t = vlib_time_now (vm) - t;
 456               vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 457               /* *INDENT-OFF* */
 458               ELOG_TYPE_DECLARE (e) = {
 459                 .format = "barrier-refork-thread-%d",
 460                 .format_args = "i4",
 461               };
 462               /* *INDENT-ON* */
 463
 464               struct
 465               {
 466                 u32 thread_index;
 467               } __clib_packed *ed;
 468
 469               ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
 470                                     w->elog_track);
 471               ed->thread_index = thread_index;
 472             }
 473
 474           vlib_worker_thread_node_refork ();
 475           clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
 476                                  -1);
 477           while (*vlib_worker_threads->node_reforks_required)
 478             ;
 479         }
 480       if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
 481         {
 482           t = vlib_time_now (vm) - t;
 483           vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
 484           /* *INDENT-OFF* */
 485           ELOG_TYPE_DECLARE (e) = {
 486             .format = "barrier-released-thread-%d: %dus",
 487             .format_args = "i4i4",
 488           };
 489           /* *INDENT-ON* */
 490
 491           struct
 492           {
 493             u32 thread_index;
 494             u32 duration;
 495           } __clib_packed *ed;
 496
 497           ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
 498                                 w->elog_track);
 499           ed->thread_index = thread_index;
 500           ed->duration = (int) (1000000.0 * t);
 501         }
 502     }
 503 }
 504
 505 always_inline vlib_main_t *
 506 vlib_get_worker_vlib_main (u32 worker_index)
 507 {
 508   vlib_main_t *vm;
 509   vlib_thread_main_t *tm = &vlib_thread_main;
 510   ASSERT (worker_index < tm->n_vlib_mains - 1);
 511   vm = vlib_mains[worker_index + 1];
 512   ASSERT (vm);
 513   return vm;
 514 }
 515
 516 static inline u8
 517 vlib_thread_is_main_w_barrier (void)
 518 {
 519   return (!vlib_num_workers ()
 520           || ((vlib_get_thread_index () == 0
 521                && vlib_worker_threads->wait_at_barrier[0])));
 522 }
 523
 524 static inline void
 525 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
 526 {
 527   CLIB_MEMORY_BARRIER ();
 528   hf->valid = 1;
 529 }
 530
 531 static inline vlib_frame_queue_elt_t *
 532 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
 533 {
 534   vlib_frame_queue_t *fq;
 535   vlib_frame_queue_elt_t *elt;
 536   vlib_thread_main_t *tm = &vlib_thread_main;
 537   vlib_frame_queue_main_t *fqm =
 538     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 539   u64 new_tail;
 540
 541   fq = fqm->vlib_frame_queues[index];
 542   ASSERT (fq);
 543
 544   new_tail = clib_atomic_add_fetch (&fq->tail, 1);
 545
 546   /* Wait until a ring slot is available */
 547   while (new_tail >= fq->head_hint + fq->nelts)
 548     vlib_worker_thread_barrier_check ();
 549
 550   elt = fq->elts + (new_tail & (fq->nelts - 1));
 551
 552   /* this would be very bad... */
 553   while (elt->valid)
 554     ;
 555
 556   elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
 557   elt->last_n_vectors = elt->n_vectors = 0;
 558
 559   return elt;
 560 }
 561
 562 static inline vlib_frame_queue_t *
 563 is_vlib_frame_queue_congested (u32 frame_queue_index,
 564                                u32 index,
 565                                u32 queue_hi_thresh,
 566                                vlib_frame_queue_t **
 567                                handoff_queue_by_worker_index)
 568 {
 569   vlib_frame_queue_t *fq;
 570   vlib_thread_main_t *tm = &vlib_thread_main;
 571   vlib_frame_queue_main_t *fqm =
 572     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 573
 574   fq = handoff_queue_by_worker_index[index];
 575   if (fq != (vlib_frame_queue_t *) (~0))
 576     return fq;
 577
 578   fq = fqm->vlib_frame_queues[index];
 579   ASSERT (fq);
 580
 581   if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
 582     {
 583       /* a valid entry in the array will indicate the queue has reached
 584        * the specified threshold and is congested
 585        */
 586       handoff_queue_by_worker_index[index] = fq;
 587       fq->enqueue_full_events++;
 588       return fq;
 589     }
 590
 591   return NULL;
 592 }
 593
 594 static inline vlib_frame_queue_elt_t *
 595 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
 596                                    u32 vlib_worker_index,
 597                                    vlib_frame_queue_elt_t **
 598                                    handoff_queue_elt_by_worker_index)
 599 {
 600   vlib_frame_queue_elt_t *elt;
 601
 602   if (handoff_queue_elt_by_worker_index[vlib_worker_index])
 603     return handoff_queue_elt_by_worker_index[vlib_worker_index];
 604
 605   elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
 606
 607   handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
 608
 609   return elt;
 610 }
 611
 612 u8 *vlib_thread_stack_init (uword thread_index);
 613 int vlib_thread_cb_register (struct vlib_main_t *vm,
 614                              vlib_thread_callbacks_t * cb);
 615 extern void *rpc_call_main_thread_cb_fn;
 616
 617 void
 618 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
 619                                      args);
 620 void vlib_rpc_call_main_thread (void *function, u8 * args, u32 size);
 621 #endif /* included_vlib_threads_h */
 622
 623 /*
 624  * fd.io coding-style-patch-verification: ON
 625  *
 626  * Local Variables:
 627  * eval: (c-set-style "gnu")
 628  * End:
 629  */