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 /*
  22  * To enable detailed tracing of barrier usage, including call stacks and
  23  * timings, define BARRIER_TRACING here or in relevant TAGS.  If also used
  24  * with CLIB_DEBUG, timing will _not_ be representative of normal code
  25  * execution.
  26  *
  27  */
  28
  29 // #define BARRIER_TRACING 1
  30
  31 /*
  32  * Two options for barrier tracing output: syslog & elog.
  33  */
  34
  35 // #define BARRIER_TRACING_ELOG 1
  36
  37 extern vlib_main_t **vlib_mains;
  38
  39 void vlib_set_thread_name (char *name);
  40
  41 /* arg is actually a vlib__thread_t * */
  42 typedef void (vlib_thread_function_t) (void *arg);
  43
  44 typedef struct vlib_thread_registration_
  45 {
  46   /* constructor generated list of thread registrations */
  47   struct vlib_thread_registration_ *next;
  48
  49   /* config parameters */
  50   char *name;
  51   char *short_name;
  52   vlib_thread_function_t *function;
  53   uword mheap_size;
  54   int fixed_count;
  55   u32 count;
  56   int no_data_structure_clone;
  57   u32 frame_queue_nelts;
  58
  59   /* All threads of this type run on pthreads */
  60   int use_pthreads;
  61   u32 first_index;
  62   uword *coremask;
  63 } vlib_thread_registration_t;
  64
  65 /*
  66  * Frames have their cpu / vlib_main_t index in the low-order N bits
  67  * Make VLIB_MAX_CPUS a power-of-two, please...
  68  */
  69
  70 #ifndef VLIB_MAX_CPUS
  71 #define VLIB_MAX_CPUS 256
  72 #endif
  73
  74 #if VLIB_MAX_CPUS > CLIB_MAX_MHEAPS
  75 #error Please increase number of per-cpu mheaps
  76 #endif
  77
  78 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1)       /* 0x3f, max */
  79 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
  80
  81 #define VLIB_LOG2_THREAD_STACK_SIZE (21)
  82 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
  83
  84 typedef enum
  85 {
  86   VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
  87 } vlib_frame_queue_msg_type_t;
  88
  89 typedef struct
  90 {
  91   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  92   volatile u32 valid;
  93   u32 msg_type;
  94   u32 n_vectors;
  95   u32 last_n_vectors;
  96
  97   /* 256 * 4 = 1024 bytes, even mult of cache line size */
  98   u32 buffer_index[VLIB_FRAME_SIZE];
  99 }
 100 vlib_frame_queue_elt_t;
 101
 102 typedef struct
 103 {
 104   /* First cache line */
 105   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 106   volatile u32 *wait_at_barrier;
 107   volatile u32 *workers_at_barrier;
 108
 109   /* Second Cache Line */
 110     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 111   void *thread_mheap;
 112   u8 *thread_stack;
 113   void (*thread_function) (void *);
 114   void *thread_function_arg;
 115   i64 recursion_level;
 116   elog_track_t elog_track;
 117   u32 instance_id;
 118   vlib_thread_registration_t *registration;
 119   u8 *name;
 120   u64 barrier_sync_count;
 121 #ifdef BARRIER_TRACING
 122   const char *barrier_caller;
 123   const char *barrier_context;
 124 #endif
 125   volatile u32 *node_reforks_required;
 126
 127   long lwp;
 128   int lcore_id;
 129   pthread_t thread_id;
 130 } vlib_worker_thread_t;
 131
 132 extern vlib_worker_thread_t *vlib_worker_threads;
 133
 134 typedef struct
 135 {
 136   /* enqueue side */
 137   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 138   volatile u64 tail;
 139   u64 enqueues;
 140   u64 enqueue_ticks;
 141   u64 enqueue_vectors;
 142   u32 enqueue_full_events;
 143
 144   /* dequeue side */
 145     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 146   volatile u64 head;
 147   u64 dequeues;
 148   u64 dequeue_ticks;
 149   u64 dequeue_vectors;
 150   u64 trace;
 151   u64 vector_threshold;
 152
 153   /* dequeue hint to enqueue side */
 154     CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
 155   volatile u64 head_hint;
 156
 157   /* read-only, constant, shared */
 158     CLIB_CACHE_LINE_ALIGN_MARK (cacheline3);
 159   vlib_frame_queue_elt_t *elts;
 160   u32 nelts;
 161 }
 162 vlib_frame_queue_t;
 163
 164 typedef struct
 165 {
 166   u32 node_index;
 167   vlib_frame_queue_t **vlib_frame_queues;
 168
 169   /* for frame queue tracing */
 170   frame_queue_trace_t *frame_queue_traces;
 171   frame_queue_nelt_counter_t *frame_queue_histogram;
 172 } vlib_frame_queue_main_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 #ifdef BARRIER_TRACING
 203 #define vlib_worker_thread_barrier_sync(X) {vlib_worker_threads[0].barrier_caller=__FUNCTION__;vlib_worker_thread_barrier_sync_int(X);}
 204 #else
 205 #define vlib_worker_thread_barrier_sync(X) vlib_worker_thread_barrier_sync_int(X)
 206 #endif
 207
 208
 209 void vlib_worker_thread_barrier_sync_int (vlib_main_t * vm);
 210 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
 211 void vlib_worker_thread_node_refork (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 typedef enum
 230 {
 231   VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
 232   VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
 233 } vlib_fork_fixup_t;
 234
 235 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
 236
 237 #define foreach_vlib_main(body)                         \
 238 do {                                                    \
 239   vlib_main_t ** __vlib_mains = 0, *this_vlib_main;     \
 240   int ii;                                               \
 241                                                         \
 242   for (ii = 0; ii < vec_len (vlib_mains); ii++)         \
 243     {                                                   \
 244       this_vlib_main = vlib_mains[ii];                  \
 245       ASSERT (ii == 0 ||                                \
 246               this_vlib_main->parked_at_barrier == 1);  \
 247       if (this_vlib_main)                               \
 248         vec_add1 (__vlib_mains, this_vlib_main);        \
 249     }                                                   \
 250                                                         \
 251   for (ii = 0; ii < vec_len (__vlib_mains); ii++)       \
 252     {                                                   \
 253       this_vlib_main = __vlib_mains[ii];                \
 254       /* body uses this_vlib_main... */                 \
 255       (body);                                           \
 256     }                                                   \
 257   vec_free (__vlib_mains);                              \
 258 } while (0);
 259
 260 #define foreach_sched_policy \
 261   _(SCHED_OTHER, OTHER, "other") \
 262   _(SCHED_BATCH, BATCH, "batch") \
 263   _(SCHED_IDLE, IDLE, "idle")   \
 264   _(SCHED_FIFO, FIFO, "fifo")   \
 265   _(SCHED_RR, RR, "rr")
 266
 267 typedef enum
 268 {
 269 #define _(v,f,s) SCHED_POLICY_##f = v,
 270   foreach_sched_policy
 271 #undef _
 272     SCHED_POLICY_N,
 273 } sched_policy_t;
 274
 275 typedef struct
 276 {
 277   clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
 278                                           unsigned lcore_id);
 279   clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 lcore);
 280 } vlib_thread_callbacks_t;
 281
 282 typedef struct
 283 {
 284   /* Link list of registrations, built by constructors */
 285   vlib_thread_registration_t *next;
 286
 287   /* Vector of registrations, w/ non-data-structure clones at the top */
 288   vlib_thread_registration_t **registrations;
 289
 290   uword *thread_registrations_by_name;
 291
 292   vlib_worker_thread_t *worker_threads;
 293
 294   /*
 295    * Launch all threads as pthreads,
 296    * not eal_rte_launch (strict affinity) threads
 297    */
 298   int use_pthreads;
 299
 300   /* Number of vlib_main / vnet_main clones */
 301   u32 n_vlib_mains;
 302
 303   /* Number of thread stacks to create */
 304   u32 n_thread_stacks;
 305
 306   /* Number of pthreads */
 307   u32 n_pthreads;
 308
 309   /* Number of threads */
 310   u32 n_threads;
 311
 312   /* Number of cores to skip, must match the core mask */
 313   u32 skip_cores;
 314
 315   /* Thread prefix name */
 316   u8 *thread_prefix;
 317
 318   /* main thread lcore */
 319   u8 main_lcore;
 320
 321   /* Bitmap of available CPU cores */
 322   uword *cpu_core_bitmap;
 323
 324   /* Bitmap of available CPU sockets (NUMA nodes) */
 325   uword *cpu_socket_bitmap;
 326
 327   /* Worker handoff queues */
 328   vlib_frame_queue_main_t *frame_queue_mains;
 329
 330   /* worker thread initialization barrier */
 331   volatile u32 worker_thread_release;
 332
 333   /* scheduling policy */
 334   u32 sched_policy;
 335
 336   /* scheduling policy priority */
 337   u32 sched_priority;
 338
 339   /* callbacks */
 340   vlib_thread_callbacks_t cb;
 341   int extern_thread_mgmt;
 342 } vlib_thread_main_t;
 343
 344 extern vlib_thread_main_t vlib_thread_main;
 345
 346 #include <vlib/global_funcs.h>
 347
 348 #define VLIB_REGISTER_THREAD(x,...)                     \
 349   __VA_ARGS__ vlib_thread_registration_t x;             \
 350 static void __vlib_add_thread_registration_##x (void)   \
 351   __attribute__((__constructor__)) ;                    \
 352 static void __vlib_add_thread_registration_##x (void)   \
 353 {                                                       \
 354   vlib_thread_main_t * tm = &vlib_thread_main;          \
 355   x.next = tm->next;                                    \
 356   tm->next = &x;                                        \
 357 }                                                       \
 358 __VA_ARGS__ vlib_thread_registration_t x
 359
 360 always_inline u32
 361 vlib_num_workers ()
 362 {
 363   return vlib_thread_main.n_vlib_mains - 1;
 364 }
 365
 366 always_inline u32
 367 vlib_get_worker_thread_index (u32 worker_index)
 368 {
 369   return worker_index + 1;
 370 }
 371
 372 always_inline u32
 373 vlib_get_worker_index (u32 thread_index)
 374 {
 375   return thread_index - 1;
 376 }
 377
 378 always_inline u32
 379 vlib_get_current_worker_index ()
 380 {
 381   return vlib_get_thread_index () - 1;
 382 }
 383
 384 static inline void
 385 vlib_worker_thread_barrier_check (void)
 386 {
 387   if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
 388     {
 389       vlib_main_t *vm;
 390       clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
 391       if (CLIB_DEBUG > 0)
 392         {
 393           vm = vlib_get_main ();
 394           vm->parked_at_barrier = 1;
 395         }
 396       while (*vlib_worker_threads->wait_at_barrier)
 397         ;
 398       if (CLIB_DEBUG > 0)
 399         vm->parked_at_barrier = 0;
 400       clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
 401
 402       if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
 403         {
 404           vlib_worker_thread_node_refork ();
 405           clib_smp_atomic_add (vlib_worker_threads->node_reforks_required,
 406                                -1);
 407           while (*vlib_worker_threads->node_reforks_required)
 408             ;
 409         }
 410     }
 411 }
 412
 413 always_inline vlib_main_t *
 414 vlib_get_worker_vlib_main (u32 worker_index)
 415 {
 416   vlib_main_t *vm;
 417   vlib_thread_main_t *tm = &vlib_thread_main;
 418   ASSERT (worker_index < tm->n_vlib_mains - 1);
 419   vm = vlib_mains[worker_index + 1];
 420   ASSERT (vm);
 421   return vm;
 422 }
 423
 424 static inline void
 425 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
 426 {
 427   CLIB_MEMORY_BARRIER ();
 428   hf->valid = 1;
 429 }
 430
 431 static inline vlib_frame_queue_elt_t *
 432 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
 433 {
 434   vlib_frame_queue_t *fq;
 435   vlib_frame_queue_elt_t *elt;
 436   vlib_thread_main_t *tm = &vlib_thread_main;
 437   vlib_frame_queue_main_t *fqm =
 438     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 439   u64 new_tail;
 440
 441   fq = fqm->vlib_frame_queues[index];
 442   ASSERT (fq);
 443
 444   new_tail = __sync_add_and_fetch (&fq->tail, 1);
 445
 446   /* Wait until a ring slot is available */
 447   while (new_tail >= fq->head_hint + fq->nelts)
 448     vlib_worker_thread_barrier_check ();
 449
 450   elt = fq->elts + (new_tail & (fq->nelts - 1));
 451
 452   /* this would be very bad... */
 453   while (elt->valid)
 454     ;
 455
 456   elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
 457   elt->last_n_vectors = elt->n_vectors = 0;
 458
 459   return elt;
 460 }
 461
 462 static inline vlib_frame_queue_t *
 463 is_vlib_frame_queue_congested (u32 frame_queue_index,
 464                                u32 index,
 465                                u32 queue_hi_thresh,
 466                                vlib_frame_queue_t **
 467                                handoff_queue_by_worker_index)
 468 {
 469   vlib_frame_queue_t *fq;
 470   vlib_thread_main_t *tm = &vlib_thread_main;
 471   vlib_frame_queue_main_t *fqm =
 472     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 473
 474   fq = handoff_queue_by_worker_index[index];
 475   if (fq != (vlib_frame_queue_t *) (~0))
 476     return fq;
 477
 478   fq = fqm->vlib_frame_queues[index];
 479   ASSERT (fq);
 480
 481   if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
 482     {
 483       /* a valid entry in the array will indicate the queue has reached
 484        * the specified threshold and is congested
 485        */
 486       handoff_queue_by_worker_index[index] = fq;
 487       fq->enqueue_full_events++;
 488       return fq;
 489     }
 490
 491   return NULL;
 492 }
 493
 494 static inline vlib_frame_queue_elt_t *
 495 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
 496                                    u32 vlib_worker_index,
 497                                    vlib_frame_queue_elt_t **
 498                                    handoff_queue_elt_by_worker_index)
 499 {
 500   vlib_frame_queue_elt_t *elt;
 501
 502   if (handoff_queue_elt_by_worker_index[vlib_worker_index])
 503     return handoff_queue_elt_by_worker_index[vlib_worker_index];
 504
 505   elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
 506
 507   handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
 508
 509   return elt;
 510 }
 511
 512 u8 *vlib_thread_stack_init (uword thread_index);
 513
 514 int vlib_thread_cb_register (struct vlib_main_t *vm,
 515                              vlib_thread_callbacks_t * cb);
 516
 517 #endif /* included_vlib_threads_h */
 518
 519 /*
 520  * fd.io coding-style-patch-verification: ON
 521  *
 522  * Local Variables:
 523  * eval: (c-set-style "gnu")
 524  * End:
 525  */