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