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 static inline void
 205 vlib_worker_thread_barrier_check (void)
 206 {
 207   if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
 208     {
 209       clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
 210       while (*vlib_worker_threads->wait_at_barrier)
 211         ;
 212       clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
 213     }
 214 }
 215
 216 #define foreach_vlib_main(body)                         \
 217 do {                                                    \
 218   vlib_main_t ** __vlib_mains = 0, *this_vlib_main;     \
 219   int ii;                                               \
 220                                                         \
 221   for (ii = 0; ii < vec_len (vlib_mains); ii++)         \
 222     {                                                   \
 223       this_vlib_main = vlib_mains[ii];                  \
 224       if (this_vlib_main)                               \
 225         vec_add1 (__vlib_mains, this_vlib_main);        \
 226     }                                                   \
 227                                                         \
 228   for (ii = 0; ii < vec_len (__vlib_mains); ii++)       \
 229     {                                                   \
 230       this_vlib_main = __vlib_mains[ii];                \
 231       /* body uses this_vlib_main... */                 \
 232       (body);                                           \
 233     }                                                   \
 234   vec_free (__vlib_mains);                              \
 235 } while (0);
 236
 237 #define foreach_sched_policy \
 238   _(SCHED_OTHER, OTHER, "other") \
 239   _(SCHED_BATCH, BATCH, "batch") \
 240   _(SCHED_IDLE, IDLE, "idle")   \
 241   _(SCHED_FIFO, FIFO, "fifo")   \
 242   _(SCHED_RR, RR, "rr")
 243
 244 typedef enum
 245 {
 246 #define _(v,f,s) SCHED_POLICY_##f = v,
 247   foreach_sched_policy
 248 #undef _
 249     SCHED_POLICY_N,
 250 } sched_policy_t;
 251
 252 typedef struct
 253 {
 254   clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
 255                                           unsigned lcore_id);
 256   clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 lcore);
 257 } vlib_thread_callbacks_t;
 258
 259 typedef struct
 260 {
 261   /* Link list of registrations, built by constructors */
 262   vlib_thread_registration_t *next;
 263
 264   /* Vector of registrations, w/ non-data-structure clones at the top */
 265   vlib_thread_registration_t **registrations;
 266
 267   uword *thread_registrations_by_name;
 268
 269   vlib_worker_thread_t *worker_threads;
 270
 271   /*
 272    * Launch all threads as pthreads,
 273    * not eal_rte_launch (strict affinity) threads
 274    */
 275   int use_pthreads;
 276
 277   /* Number of vlib_main / vnet_main clones */
 278   u32 n_vlib_mains;
 279
 280   /* Number of thread stacks to create */
 281   u32 n_thread_stacks;
 282
 283   /* Number of pthreads */
 284   u32 n_pthreads;
 285
 286   /* Number of threads */
 287   u32 n_threads;
 288
 289   /* Number of cores to skip, must match the core mask */
 290   u32 skip_cores;
 291
 292   /* Thread prefix name */
 293   u8 *thread_prefix;
 294
 295   /* main thread lcore */
 296   u8 main_lcore;
 297
 298   /* Bitmap of available CPU cores */
 299   uword *cpu_core_bitmap;
 300
 301   /* Bitmap of available CPU sockets (NUMA nodes) */
 302   uword *cpu_socket_bitmap;
 303
 304   /* Worker handoff queues */
 305   vlib_frame_queue_main_t *frame_queue_mains;
 306
 307   /* worker thread initialization barrier */
 308   volatile u32 worker_thread_release;
 309
 310   /* scheduling policy */
 311   u32 sched_policy;
 312
 313   /* scheduling policy priority */
 314   u32 sched_priority;
 315
 316   /* callbacks */
 317   vlib_thread_callbacks_t cb;
 318   int extern_thread_mgmt;
 319 } vlib_thread_main_t;
 320
 321 extern vlib_thread_main_t vlib_thread_main;
 322
 323 #define VLIB_REGISTER_THREAD(x,...)                     \
 324   __VA_ARGS__ vlib_thread_registration_t x;             \
 325 static void __vlib_add_thread_registration_##x (void)   \
 326   __attribute__((__constructor__)) ;                    \
 327 static void __vlib_add_thread_registration_##x (void)   \
 328 {                                                       \
 329   vlib_thread_main_t * tm = &vlib_thread_main;          \
 330   x.next = tm->next;                                    \
 331   tm->next = &x;                                        \
 332 }                                                       \
 333 __VA_ARGS__ vlib_thread_registration_t x
 334
 335 always_inline u32
 336 vlib_num_workers ()
 337 {
 338   return vlib_thread_main.n_vlib_mains - 1;
 339 }
 340
 341 always_inline u32
 342 vlib_get_worker_cpu_index (u32 worker_index)
 343 {
 344   return worker_index + 1;
 345 }
 346
 347 always_inline u32
 348 vlib_get_worker_index (u32 cpu_index)
 349 {
 350   return cpu_index - 1;
 351 }
 352
 353 always_inline u32
 354 vlib_get_current_worker_index ()
 355 {
 356   return os_get_cpu_number () - 1;
 357 }
 358
 359 always_inline vlib_main_t *
 360 vlib_get_worker_vlib_main (u32 worker_index)
 361 {
 362   vlib_main_t *vm;
 363   vlib_thread_main_t *tm = &vlib_thread_main;
 364   ASSERT (worker_index < tm->n_vlib_mains - 1);
 365   vm = vlib_mains[worker_index + 1];
 366   ASSERT (vm);
 367   return vm;
 368 }
 369
 370 static inline void
 371 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
 372 {
 373   CLIB_MEMORY_BARRIER ();
 374   hf->valid = 1;
 375 }
 376
 377 static inline vlib_frame_queue_elt_t *
 378 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
 379 {
 380   vlib_frame_queue_t *fq;
 381   vlib_frame_queue_elt_t *elt;
 382   vlib_thread_main_t *tm = &vlib_thread_main;
 383   vlib_frame_queue_main_t *fqm =
 384     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 385   u64 new_tail;
 386
 387   fq = fqm->vlib_frame_queues[index];
 388   ASSERT (fq);
 389
 390   new_tail = __sync_add_and_fetch (&fq->tail, 1);
 391
 392   /* Wait until a ring slot is available */
 393   while (new_tail >= fq->head_hint + fq->nelts)
 394     vlib_worker_thread_barrier_check ();
 395
 396   elt = fq->elts + (new_tail & (fq->nelts - 1));
 397
 398   /* this would be very bad... */
 399   while (elt->valid)
 400     ;
 401
 402   elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
 403   elt->last_n_vectors = elt->n_vectors = 0;
 404
 405   return elt;
 406 }
 407
 408 static inline vlib_frame_queue_t *
 409 is_vlib_frame_queue_congested (u32 frame_queue_index,
 410                                u32 index,
 411                                u32 queue_hi_thresh,
 412                                vlib_frame_queue_t **
 413                                handoff_queue_by_worker_index)
 414 {
 415   vlib_frame_queue_t *fq;
 416   vlib_thread_main_t *tm = &vlib_thread_main;
 417   vlib_frame_queue_main_t *fqm =
 418     vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
 419
 420   fq = handoff_queue_by_worker_index[index];
 421   if (fq != (vlib_frame_queue_t *) (~0))
 422     return fq;
 423
 424   fq = fqm->vlib_frame_queues[index];
 425   ASSERT (fq);
 426
 427   if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
 428     {
 429       /* a valid entry in the array will indicate the queue has reached
 430        * the specified threshold and is congested
 431        */
 432       handoff_queue_by_worker_index[index] = fq;
 433       fq->enqueue_full_events++;
 434       return fq;
 435     }
 436
 437   return NULL;
 438 }
 439
 440 static inline vlib_frame_queue_elt_t *
 441 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
 442                                    u32 vlib_worker_index,
 443                                    vlib_frame_queue_elt_t **
 444                                    handoff_queue_elt_by_worker_index)
 445 {
 446   vlib_frame_queue_elt_t *elt;
 447
 448   if (handoff_queue_elt_by_worker_index[vlib_worker_index])
 449     return handoff_queue_elt_by_worker_index[vlib_worker_index];
 450
 451   elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
 452
 453   handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
 454
 455   return elt;
 456 }
 457
 458 int vlib_thread_cb_register (struct vlib_main_t *vm,
 459                              vlib_thread_callbacks_t * cb);
 460
 461 #endif /* included_vlib_threads_h */
 462
 463 /*
 464  * fd.io coding-style-patch-verification: ON
 465  *
 466  * Local Variables:
 467  * eval: (c-set-style "gnu")
 468  * End:
 469  */