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   volatile u32 valid;
  76   u32 msg_type;
  77   u32 n_vectors;
  78   u32 last_n_vectors;
  79
  80   /* 256 * 4 = 1024 bytes, even mult of cache line size */
  81   u32 buffer_index[VLIB_FRAME_SIZE];
  82
  83   /* Pad to a cache line boundary */
  84   u8 pad[CLIB_CACHE_LINE_BYTES - 4 * sizeof (u32)];
  85 }
  86 vlib_frame_queue_elt_t;
  87
  88 typedef struct
  89 {
  90   /* First cache line */
  91   volatile u32 *wait_at_barrier;
  92   volatile u32 *workers_at_barrier;
  93   u8 pad0[CLIB_CACHE_LINE_BYTES - (2 * sizeof (u32 *))];
  94
  95   /* Second Cache Line */
  96   void *thread_mheap;
  97   u8 *thread_stack;
  98   void (*thread_function) (void *);
  99   void *thread_function_arg;
 100   i64 recursion_level;
 101   elog_track_t elog_track;
 102   u32 instance_id;
 103   vlib_thread_registration_t *registration;
 104   u8 *name;
 105   u64 barrier_sync_count;
 106
 107   long lwp;
 108   int dpdk_lcore_id;
 109 } vlib_worker_thread_t;
 110
 111 vlib_worker_thread_t *vlib_worker_threads;
 112
 113 typedef struct
 114 {
 115   /* enqueue side */
 116   volatile u64 tail;
 117   u64 enqueues;
 118   u64 enqueue_ticks;
 119   u64 enqueue_vectors;
 120   u32 enqueue_full_events;
 121   u32 enqueue_efd_discards;
 122   u8 pad2[CLIB_CACHE_LINE_BYTES - (2 * sizeof (u32)) - (4 * sizeof (u64))];
 123
 124   /* dequeue side */
 125   volatile u64 head;
 126   u64 dequeues;
 127   u64 dequeue_ticks;
 128   u64 dequeue_vectors;
 129   u64 trace;
 130   u64 vector_threshold;
 131   u8 pad4[CLIB_CACHE_LINE_BYTES - (6 * sizeof (u64))];
 132
 133   /* dequeue hint to enqueue side */
 134   volatile u64 head_hint;
 135   u8 pad5[CLIB_CACHE_LINE_BYTES - sizeof (u64)];
 136
 137   /* read-only, constant, shared */
 138   vlib_frame_queue_elt_t *elts;
 139   u32 nelts;
 140 }
 141 vlib_frame_queue_t;
 142
 143 vlib_frame_queue_t **vlib_frame_queues;
 144
 145 /* Called early, in thread 0's context */
 146 clib_error_t *vlib_thread_init (vlib_main_t * vm);
 147
 148 vlib_worker_thread_t *vlib_alloc_thread (vlib_main_t * vm);
 149
 150 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
 151                               u32 frame_queue_index, vlib_frame_t * frame,
 152                               vlib_frame_queue_msg_type_t type);
 153
 154 int vlib_frame_queue_dequeue (int thread_id,
 155                               vlib_main_t * vm, vlib_node_main_t * nm);
 156
 157 u64 dispatch_node (vlib_main_t * vm,
 158                    vlib_node_runtime_t * node,
 159                    vlib_node_type_t type,
 160                    vlib_node_state_t dispatch_state,
 161                    vlib_frame_t * frame, u64 last_time_stamp);
 162
 163 u64 dispatch_pending_node (vlib_main_t * vm,
 164                            vlib_pending_frame_t * p, u64 last_time_stamp);
 165
 166 void vlib_worker_thread_node_runtime_update (void);
 167
 168 void vlib_create_worker_threads (vlib_main_t * vm, int n,
 169                                  void (*thread_function) (void *));
 170
 171 void vlib_worker_thread_init (vlib_worker_thread_t * w);
 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     if (vec_len (vlib_mains) == 0)                                      \
 222         vec_add1 (__vlib_mains, &vlib_global_main);                     \
 223     else                                                                \
 224     {                                                                   \
 225         for (ii = 0; ii < vec_len (vlib_mains); ii++)                   \
 226         {                                                               \
 227             this_vlib_main = vlib_mains[ii];                            \
 228             if (this_vlib_main)                                         \
 229                 vec_add1 (__vlib_mains, this_vlib_main);                \
 230         }                                                               \
 231     }                                                                   \
 232                                                                         \
 233     for (ii = 0; ii < vec_len (__vlib_mains); ii++)                     \
 234     {                                                                   \
 235         this_vlib_main = __vlib_mains[ii];                              \
 236         /* body uses this_vlib_main... */                               \
 237         (body);                                                         \
 238     }                                                                   \
 239     vec_free (__vlib_mains);                                            \
 240 } while (0);
 241
 242
 243 /* Early-Fast-Discard (EFD) */
 244 #define VLIB_EFD_DISABLED                   0
 245 #define VLIB_EFD_DISCARD_ENABLED            (1 << 0)
 246 #define VLIB_EFD_MONITOR_ENABLED            (1 << 1)
 247
 248 #define VLIB_EFD_DEF_WORKER_HI_THRESH_PCT   90
 249
 250 /* EFD worker thread settings */
 251 typedef struct vlib_efd_t
 252 {
 253   u16 enabled;
 254   u16 queue_hi_thresh;
 255   u8 ip_prec_bitmap;
 256   u8 mpls_exp_bitmap;
 257   u8 vlan_cos_bitmap;
 258   u8 pad;
 259 } vlib_efd_t;
 260
 261 #define foreach_sched_policy \
 262   _(SCHED_OTHER, OTHER, "other") \
 263   _(SCHED_BATCH, BATCH, "batch") \
 264   _(SCHED_IDLE, IDLE, "idle")   \
 265   _(SCHED_FIFO, FIFO, "fifo")   \
 266   _(SCHED_RR, RR, "rr")
 267
 268 typedef enum
 269 {
 270 #define _(v,f,s) SCHED_POLICY_##f = v,
 271   foreach_sched_policy
 272 #undef _
 273     SCHED_POLICY_N,
 274 } sched_policy_t;
 275
 276 typedef struct
 277 {
 278   /* Link list of registrations, built by constructors */
 279   vlib_thread_registration_t *next;
 280
 281   /* Vector of registrations, w/ non-data-structure clones at the top */
 282   vlib_thread_registration_t **registrations;
 283
 284   uword *thread_registrations_by_name;
 285
 286   vlib_worker_thread_t *worker_threads;
 287
 288   /*
 289    * Launch all threads as pthreads,
 290    * not eal_rte_launch (strict affinity) threads
 291    */
 292   int use_pthreads;
 293
 294   /* Number of vlib_main / vnet_main clones */
 295   u32 n_vlib_mains;
 296
 297   /* Number of thread stacks to create */
 298   u32 n_thread_stacks;
 299
 300   /* Number of pthreads */
 301   u32 n_pthreads;
 302
 303   /* Number of DPDK eal threads */
 304   u32 n_eal_threads;
 305
 306   /* Number of cores to skip, must match the core mask */
 307   u32 skip_cores;
 308
 309   /* Thread prefix name */
 310   u8 *thread_prefix;
 311
 312   /* main thread lcore */
 313   u8 main_lcore;
 314
 315   /* Bitmap of available CPU cores */
 316   uword *cpu_core_bitmap;
 317
 318   /* Bitmap of available CPU sockets (NUMA nodes) */
 319   uword *cpu_socket_bitmap;
 320
 321   vlib_efd_t efd;
 322
 323   /* handoff node index */
 324   u32 handoff_dispatch_node_index;
 325
 326   /* for frame queue tracing */
 327   frame_queue_trace_t *frame_queue_traces;
 328   frame_queue_nelt_counter_t *frame_queue_histogram;
 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 } vlib_thread_main_t;
 340
 341 vlib_thread_main_t vlib_thread_main;
 342
 343 #define VLIB_REGISTER_THREAD(x,...)                     \
 344   __VA_ARGS__ vlib_thread_registration_t x;             \
 345 static void __vlib_add_thread_registration_##x (void)   \
 346   __attribute__((__constructor__)) ;                    \
 347 static void __vlib_add_thread_registration_##x (void)   \
 348 {                                                       \
 349   vlib_thread_main_t * tm = &vlib_thread_main;          \
 350   x.next = tm->next;                                    \
 351   tm->next = &x;                                        \
 352 }                                                       \
 353 __VA_ARGS__ vlib_thread_registration_t x
 354
 355 #endif /* included_vlib_threads_h */
 356
 357 /*
 358  * fd.io coding-style-patch-verification: ON
 359  *
 360  * Local Variables:
 361  * eval: (c-set-style "gnu")
 362  * End:
 363  */