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