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 (20)
  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
 106   long lwp;
 107   int lcore_id;
 108   pthread_t thread_id;
 109 } vlib_worker_thread_t;
 110
 111 extern vlib_worker_thread_t *vlib_worker_threads;
 112
 113 typedef struct
 114 {
 115   /* enqueue side */
 116   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 117   volatile u64 tail;
 118   u64 enqueues;
 119   u64 enqueue_ticks;
 120   u64 enqueue_vectors;
 121   u32 enqueue_full_events;
 122
 123   /* dequeue side */
 124     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 125   volatile u64 head;
 126   u64 dequeues;
 127   u64 dequeue_ticks;
 128   u64 dequeue_vectors;
 129   u64 trace;
 130   u64 vector_threshold;
 131
 132   /* dequeue hint to enqueue side */
 133     CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
 134   volatile u64 head_hint;
 135
 136   /* read-only, constant, shared */
 137     CLIB_CACHE_LINE_ALIGN_MARK (cacheline3);
 138   vlib_frame_queue_elt_t *elts;
 139   u32 nelts;
 140 }
 141 vlib_frame_queue_t;
 142
 143 typedef struct
 144 {
 145   u32 node_index;
 146   vlib_frame_queue_t **vlib_frame_queues;
 147
 148   /* for frame queue tracing */
 149   frame_queue_trace_t *frame_queue_traces;
 150   frame_queue_nelt_counter_t *frame_queue_histogram;
 151 } vlib_frame_queue_main_t;
 152
 153 /* Called early, in thread 0's context */
 154 clib_error_t *vlib_thread_init (vlib_main_t * vm);
 155
 156 vlib_worker_thread_t *vlib_alloc_thread (vlib_main_t * vm);
 157
 158 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
 159                               u32 frame_queue_index, vlib_frame_t * frame,
 160                               vlib_frame_queue_msg_type_t type);
 161
 162 int
 163 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm);
 164
 165 void vlib_worker_thread_node_runtime_update (void);
 166
 167 void vlib_create_worker_threads (vlib_main_t * vm, int n,
 168                                  void (*thread_function) (void *));
 169
 170 void vlib_worker_thread_init (vlib_worker_thread_t * w);
 171 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
 172
 173 /* Check for a barrier sync request every 30ms */
 174 #define BARRIER_SYNC_DELAY (0.030000)
 175
 176 #if CLIB_DEBUG > 0
 177 /* long barrier timeout, for gdb... */
 178 #define BARRIER_SYNC_TIMEOUT (600.1)
 179 #else
 180 #define BARRIER_SYNC_TIMEOUT (1.0)
 181 #endif
 182
 183 void vlib_worker_thread_barrier_sync (vlib_main_t * vm);
 184 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
 185
 186 always_inline void
 187 vlib_smp_unsafe_warning (void)
 188 {
 189   if (CLIB_DEBUG > 0)
 190     {
 191       if (os_get_cpu_number ())
 192         fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
 193     }
 194 }
 195
 196 typedef enum
 197 {
 198   VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
 199   VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
 200 } vlib_fork_fixup_t;
 201
 202 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
 203
 204 #define foreach_vlib_main(body)                         \
 205 do {                                                    \
 206   vlib_main_t ** __vlib_mains = 0, *this_vlib_main;     \
 207   int ii;                                               \
 208                                                         \
 209   for (ii = 0; ii < vec_len (vlib_mains); ii++)         \
 210     {                                                   \
 211       this_vlib_main = vlib_mains[ii];                  \
 212       ASSERT (ii == 0 ||                                \
 213               this_vlib_main->parked_at_barrier == 1);  \
 214       if (this_vlib_main)                               \
 215         vec_add1 (__vlib_mains, this_vlib_main);        \
 216     }                                                   \
 217                                                         \
 218   for (ii = 0; ii < vec_len (__vlib_mains); ii++)       \
 219     {                                                   \
 220       this_vlib_main = __vlib_mains[ii];                \
 221       /* body uses this_vlib_main... */                 \
 222       (body);                                           \
 223     }                                                   \
 224   vec_free (__vlib_mains);                              \
 225 } while (0);
 226
 227 #define foreach_sched_policy \
 228   _(SCHED_OTHER, OTHER, "other") \
 229   _(SCHED_BATCH, BATCH, "batch") \
 230   _(SCHED_IDLE, IDLE, "idle")   \
 231   _(SCHED_FIFO, FIFO, "fifo")   \
 232   _(SCHED_RR, RR, "rr")
 233
 234 typedef enum
 235 {
 236 #define _(v,f,s) SCHED_POLICY_##f = v,
 237   foreach_sched_policy
 238 #undef _
 239     SCHED_POLICY_N,
 240 } sched_policy_t;
 241
 242 typedef struct
 243 {
 244   clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
 245                                           unsigned lcore_id);
 246   clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 lcore);
 247 } vlib_thread_callbacks_t;
 248
 249 typedef struct
 250 {
 251   /* Link list of registrations, built by constructors */
 252   vlib_thread_registration_t *next;
 253
 254   /* Vector of registrations, w/ non-data-structure clones at the top */
 255   vlib_thread_registration_t **registrations;
 256
 257   uword *thread_registrations_by_name;
 258
 259   vlib_worker_thread_t *worker_threads;
 260
 261   /*
 262    * Launch all threads as pthreads,
 263    * not eal_rte_launch (strict affinity) threads
 264    */
 265   int use_pthreads;
 266
 267   /* Number of vlib_main / vnet_main clones */
 268   u32 n_vlib_mains;
 269
 270   /* Number of thread stacks to create */
 271   u32 n_thread_stacks;
 272
 273   /* Number of pthreads */
 274   u32 n_pthreads;
 275
 276   /* Number of threads */
 277   u32 n_threads;
 278
 279   /* Number of cores to skip, must match the core mask */
 280   u32 skip_cores;
 281
 282   /* Thread prefix name */
 283   u8 *thread_prefix;
 284
 285   /* main thread lcore */
 286   u8 main_lcore;
 287
 288   /* Bitmap of available CPU cores */
 289   uword *cpu_core_bitmap;
 290
 291   /* Bitmap of available CPU sockets (NUMA nodes) */
 292   uword *cpu_socket_bitmap;
 293
 294   /* Worker handoff queues */
 295   vlib_frame_queue_main_t *frame_queue_mains;
 296
 297   /* worker thread initialization barrier */
 298   volatile u32 worker_thread_release;
 299
 300   /* scheduling policy */
 301   u32 sched_policy;
 302
 303   /* scheduling policy priority */
 304   u32 sched_priority;
 305
 306   /* callbacks */
 307   vlib_thread_callbacks_t cb;
 308   int extern_thread_mgmt;
 309 } vlib_thread_main_t;
 310
 311 extern vlib_thread_main_t vlib_thread_main;
 312
 313 #include <vlib/global_funcs.h>
 314
 315 #define VLIB_REGISTER_THREAD(x,...)                     \
 316   __VA_ARGS__ vlib_thread_registration_t x;             \
 317 static void __vlib_add_thread_registration_##x (void)   \
 318   __attribute__((__constructor__)) ;                    \
 319 static void __vlib_add_thread_registration_##x (void)   \
 320 {                                                       \
 321   vlib_thread_main_t * tm = &vlib_thread_main;          \
 322   x.next = tm->next;                                    \
 323   tm->next = &x;                                        \
 324 }                                                       \
 325 __VA_ARGS__ vlib_thread_registration_t x
 326
 327 always_inline u32
 328 vlib_num_workers ()
 329 {
 330   return vlib_thread_main.n_vlib_mains - 1;
 331 }
 332
 333 always_inline u32
 334 vlib_get_worker_cpu_index (u32 worker_index)
 335 {
 336   return worker_index + 1;
 337 }
 338
 339 always_inline u32
 340 vlib_get_worker_index (u32 cpu_index)
 341 {
 342   return cpu_index - 1;
 343 }
 344
 345 always_inline u32
 346 vlib_get_current_worker_index ()
 347 {
 348   return os_get_cpu_number () - 1;
 349 }
 350
 351 static inline void
 352 vlib_worker_thread_barrier_check (void)
 353 {
 354   if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
 355     {
 356       vlib_main_t *vm;
 357       clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
 358       if (CLIB_DEBUG > 0)
 359         {
 360           vm = vlib_get_main ();
 361           vm->parked_at_barrier = 1;
 362         }
 363       while (*vlib_worker_threads->wait_at_barrier)
 364         ;
 365       if (CLIB_DEBUG > 0)
 366         vm->parked_at_barrier = 0;
 367       clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
 368     }
 369 }
 370
 371 always_inline vlib_main_t *
 372 vlib_get_worker_vlib_main (u32 worker_index)
 373 {
 374   vlib_main_t *vm;
 375   vlib_thread_main_t *tm = &vlib_thread_main;
 376   ASSERT (worker_index < tm->n_vlib_mains - 1);
 377   vm = vlib_mains[worker_index + 1];
 378   ASSERT (vm);
 379   return vm;
 380 }
 381
 382 static inline void
 383 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
 384 {
 385   CLIB_MEMORY_BARRIER ();
 386   hf->valid = 1;
 387 }
 388
 389 static inline vlib_frame_queue_elt_t *
 390 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
 391 {
 392   vlib_frame_queue_t *fq;
 393   vlib_frame_queue_elt_t *elt;
 394   vlib_thread_main_t *tm = &vlib_thread_main;
 395   vlib_frame_queue_main_t *fqm =
 396     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 397   u64 new_tail;
 398
 399   fq = fqm->vlib_frame_queues[index];
 400   ASSERT (fq);
 401
 402   new_tail = __sync_add_and_fetch (&fq->tail, 1);
 403
 404   /* Wait until a ring slot is available */
 405   while (new_tail >= fq->head_hint + fq->nelts)
 406     vlib_worker_thread_barrier_check ();
 407
 408   elt = fq->elts + (new_tail & (fq->nelts - 1));
 409
 410   /* this would be very bad... */
 411   while (elt->valid)
 412     ;
 413
 414   elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
 415   elt->last_n_vectors = elt->n_vectors = 0;
 416
 417   return elt;
 418 }
 419
 420 static inline vlib_frame_queue_t *
 421 is_vlib_frame_queue_congested (u32 frame_queue_index,
 422                                u32 index,
 423                                u32 queue_hi_thresh,
 424                                vlib_frame_queue_t **
 425                                handoff_queue_by_worker_index)
 426 {
 427   vlib_frame_queue_t *fq;
 428   vlib_thread_main_t *tm = &vlib_thread_main;
 429   vlib_frame_queue_main_t *fqm =
 430     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 431
 432   fq = handoff_queue_by_worker_index[index];
 433   if (fq != (vlib_frame_queue_t *) (~0))
 434     return fq;
 435
 436   fq = fqm->vlib_frame_queues[index];
 437   ASSERT (fq);
 438
 439   if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
 440     {
 441       /* a valid entry in the array will indicate the queue has reached
 442        * the specified threshold and is congested
 443        */
 444       handoff_queue_by_worker_index[index] = fq;
 445       fq->enqueue_full_events++;
 446       return fq;
 447     }
 448
 449   return NULL;
 450 }
 451
 452 static inline vlib_frame_queue_elt_t *
 453 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
 454                                    u32 vlib_worker_index,
 455                                    vlib_frame_queue_elt_t **
 456                                    handoff_queue_elt_by_worker_index)
 457 {
 458   vlib_frame_queue_elt_t *elt;
 459
 460   if (handoff_queue_elt_by_worker_index[vlib_worker_index])
 461     return handoff_queue_elt_by_worker_index[vlib_worker_index];
 462
 463   elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
 464
 465   handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
 466
 467   return elt;
 468 }
 469
 470 int vlib_thread_cb_register (struct vlib_main_t *vm,
 471                              vlib_thread_callbacks_t * cb);
 472
 473 #endif /* included_vlib_threads_h */
 474
 475 /*
 476  * fd.io coding-style-patch-verification: ON
 477  *
 478  * Local Variables:
 479  * eval: (c-set-style "gnu")
 480  * End:
 481  */