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