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