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
  20 vlib_main_t **vlib_mains;
  21
  22 void
  23 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   /* constructor generated list of thread registrations */
  30   struct vlib_thread_registration_ * next;
  31
  32   /* config parameters */
  33   char * name;
  34   char * short_name;
  35   vlib_thread_function_t * function;
  36   uword mheap_size;
  37   int fixed_count;
  38   u32 count;
  39   int no_data_structure_clone;
  40   /* All threads of this type run on pthreads */
  41   int use_pthreads;
  42   u32 first_index;
  43   uword * coremask;
  44 } vlib_thread_registration_t;
  45
  46 /*
  47  * Frames have their cpu / vlib_main_t index in the low-order N bits
  48  * Make VLIB_MAX_CPUS a power-of-two, please...
  49  */
  50
  51 #ifndef VLIB_MAX_CPUS
  52 #define VLIB_MAX_CPUS 256
  53 #endif
  54
  55 #if VLIB_MAX_CPUS > CLIB_MAX_MHEAPS
  56 #error Please increase number of per-cpu mheaps
  57 #endif
  58
  59 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1) /* 0x3f, max */
  60 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
  61
  62 #define VLIB_LOG2_THREAD_STACK_SIZE (20)
  63 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
  64
  65 typedef enum {
  66     VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
  67 } vlib_frame_queue_msg_type_t;
  68
  69 typedef struct {
  70   volatile u32 valid;
  71   u32 msg_type;
  72   u32 n_vectors;
  73   u32 last_n_vectors;
  74
  75   /* 256 * 4 = 1024 bytes, even mult of cache line size */
  76   u32 buffer_index[VLIB_FRAME_SIZE];
  77
  78   /* Pad to a cache line boundary */
  79   u8 pad[CLIB_CACHE_LINE_BYTES - 4 * sizeof(u32)];
  80 } vlib_frame_queue_elt_t;
  81
  82 typedef struct {
  83   /* First cache line */
  84   volatile u32 *wait_at_barrier;
  85   volatile u32 *workers_at_barrier;
  86   u8 pad0[CLIB_CACHE_LINE_BYTES - (2 * sizeof (u32 *))];
  87
  88   /* Second Cache Line */
  89   void *thread_mheap;
  90   u8 * thread_stack;
  91   void (*thread_function)(void *);
  92   void * thread_function_arg;
  93   i64 recursion_level;
  94   elog_track_t elog_track;
  95   u32 instance_id;
  96   vlib_thread_registration_t *registration;
  97   u8 *name;
  98   u64 barrier_sync_count;
  99
 100   long lwp;
 101   int dpdk_lcore_id;
 102 } vlib_worker_thread_t;
 103
 104 vlib_worker_thread_t *vlib_worker_threads;
 105
 106 typedef struct {
 107   /* enqueue side */
 108   volatile u64 tail;
 109   u64 enqueues;
 110   u64 enqueue_ticks;
 111   u64 enqueue_vectors;
 112   u32 enqueue_full_events;
 113   u32 enqueue_efd_discards;
 114   u8 pad2[CLIB_CACHE_LINE_BYTES
 115           - (2 * sizeof(u32))
 116           - (4 * sizeof(u64))];
 117
 118   /* dequeue side */
 119   volatile u64 head;
 120   u64 dequeues;
 121   u64 dequeue_ticks;
 122   u64 dequeue_vectors;
 123   u64 trace;
 124   u64 vector_threshold;
 125   u8 pad4[CLIB_CACHE_LINE_BYTES
 126           - (6 * sizeof(u64))];
 127
 128   /* dequeue hint to enqueue side */
 129   volatile u64 head_hint;
 130   u8 pad5 [CLIB_CACHE_LINE_BYTES - sizeof(u64)];
 131
 132   /* read-only, constant, shared */
 133   vlib_frame_queue_elt_t *elts;
 134   u32 nelts;
 135 } vlib_frame_queue_t;
 136
 137 vlib_frame_queue_t **vlib_frame_queues;
 138
 139 /* Called early, in thread 0's context */
 140 clib_error_t * vlib_thread_init (vlib_main_t * vm);
 141
 142 vlib_worker_thread_t * vlib_alloc_thread (vlib_main_t * vm);
 143
 144 int vlib_frame_queue_enqueue (vlib_main_t *vm, u32 node_runtime_index,
 145                               u32 frame_queue_index, vlib_frame_t *frame,
 146                               vlib_frame_queue_msg_type_t type);
 147
 148 int vlib_frame_queue_dequeue (int thread_id,
 149                               vlib_main_t *vm,
 150                               vlib_node_main_t *nm);
 151
 152 u64 dispatch_node (vlib_main_t * vm,
 153                    vlib_node_runtime_t * node,
 154                    vlib_node_type_t type,
 155                    vlib_node_state_t dispatch_state,
 156                    vlib_frame_t * frame,
 157                    u64 last_time_stamp);
 158
 159 u64 dispatch_pending_node (vlib_main_t * vm,
 160                            vlib_pending_frame_t * p,
 161                            u64 last_time_stamp);
 162
 163 void vlib_worker_thread_node_runtime_update(void);
 164
 165 void vlib_create_worker_threads (vlib_main_t *vm, int n,
 166                                  void (*thread_function)(void *));
 167
 168 void vlib_worker_thread_init (vlib_worker_thread_t * w);
 169
 170 /* Check for a barrier sync request every 30ms */
 171 #define BARRIER_SYNC_DELAY (0.030000)
 172
 173 #if CLIB_DEBUG > 0
 174 /* long barrier timeout, for gdb... */
 175 #define BARRIER_SYNC_TIMEOUT (600.1)
 176 #else
 177 #define BARRIER_SYNC_TIMEOUT (1.0)
 178 #endif
 179
 180 void vlib_worker_thread_barrier_sync(vlib_main_t *vm);
 181 void vlib_worker_thread_barrier_release(vlib_main_t *vm);
 182
 183 always_inline void vlib_smp_unsafe_warning (void)
 184 {
 185   if (CLIB_DEBUG > 0)
 186     {
 187       if (os_get_cpu_number())
 188         fformat(stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
 189     }
 190 }
 191
 192 typedef enum {
 193     VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
 194     VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
 195 } vlib_fork_fixup_t;
 196
 197 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
 198
 199 static inline void vlib_worker_thread_barrier_check (void)
 200 {
 201     if (PREDICT_FALSE(*vlib_worker_threads->wait_at_barrier))
 202     {
 203         clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
 204         while (*vlib_worker_threads->wait_at_barrier)
 205             ;
 206         clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
 207     }
 208 }
 209
 210 #define foreach_vlib_main(body)                                         \
 211 do {                                                                    \
 212     vlib_main_t ** __vlib_mains = 0, *this_vlib_main;                   \
 213     int ii;                                                             \
 214                                                                         \
 215     if (vec_len (vlib_mains) == 0)                                      \
 216         vec_add1 (__vlib_mains, &vlib_global_main);                     \
 217     else                                                                \
 218     {                                                                   \
 219         for (ii = 0; ii < vec_len (vlib_mains); ii++)                   \
 220         {                                                               \
 221             this_vlib_main = vlib_mains[ii];                            \
 222             if (this_vlib_main)                                         \
 223                 vec_add1 (__vlib_mains, this_vlib_main);                \
 224         }                                                               \
 225     }                                                                   \
 226                                                                         \
 227     for (ii = 0; ii < vec_len (__vlib_mains); ii++)                     \
 228     {                                                                   \
 229         this_vlib_main = __vlib_mains[ii];                              \
 230         /* body uses this_vlib_main... */                               \
 231         (body);                                                         \
 232     }                                                                   \
 233     vec_free (__vlib_mains);                                            \
 234 } while (0);
 235
 236
 237 /* Early-Fast-Discard (EFD) */
 238 #define VLIB_EFD_DISABLED                   0
 239 #define VLIB_EFD_DISCARD_ENABLED            (1 << 0)
 240 #define VLIB_EFD_MONITOR_ENABLED            (1 << 1)
 241
 242 #define VLIB_EFD_DEF_WORKER_HI_THRESH_PCT   90
 243
 244 /* EFD worker thread settings */
 245 typedef struct vlib_efd_t {
 246   u16 enabled;
 247   u16 queue_hi_thresh;
 248   u8  ip_prec_bitmap;
 249   u8  mpls_exp_bitmap;
 250   u8  vlan_cos_bitmap;
 251   u8  pad;
 252 } vlib_efd_t;
 253
 254 typedef struct {
 255   /* Link list of registrations, built by constructors */
 256   vlib_thread_registration_t * next;
 257
 258   /* Vector of registrations, w/ non-data-structure clones at the top */
 259   vlib_thread_registration_t ** registrations;
 260
 261   uword * thread_registrations_by_name;
 262
 263   vlib_worker_thread_t * worker_threads;
 264
 265   /* thread / cpu / io thread parameters */
 266   u32 main_thread_is_io_node;
 267
 268   /*
 269    * Launch all threads as pthreads,
 270    * not eal_rte_launch (strict affinity) threads
 271    */
 272   int use_pthreads;
 273
 274   /* Number of vlib_main / vnet_main clones */
 275   u32 n_vlib_mains;
 276
 277   /* Number of thread stacks to create */
 278   u32 n_thread_stacks;
 279
 280   /* Number of pthreads */
 281   u32 n_pthreads;
 282
 283   /* Number of DPDK eal threads */
 284   u32 n_eal_threads;
 285
 286   /* Number of cores to skip, must match the core mask */
 287   u32 skip_cores;
 288
 289   /* Thread prefix name */
 290   u8 *thread_prefix;
 291
 292   /* main thread lcore */
 293   u8 main_lcore;
 294
 295   /* Bitmap of available CPU cores */
 296   uword * cpu_core_bitmap;
 297
 298   /* Bitmap of available CPU sockets (NUMA nodes) */
 299   uword * cpu_socket_bitmap;
 300
 301   vlib_efd_t efd;
 302
 303 } vlib_thread_main_t;
 304
 305 vlib_thread_main_t vlib_thread_main;
 306
 307 #define VLIB_REGISTER_THREAD(x,...)                     \
 308   __VA_ARGS__ vlib_thread_registration_t x;             \
 309 static void __vlib_add_thread_registration_##x (void)   \
 310   __attribute__((__constructor__)) ;                    \
 311 static void __vlib_add_thread_registration_##x (void)   \
 312 {                                                       \
 313   vlib_thread_main_t * tm = &vlib_thread_main;          \
 314   x.next = tm->next;                                    \
 315   tm->next = &x;                                        \
 316 }                                                       \
 317 __VA_ARGS__ vlib_thread_registration_t x
 318
 319 #endif /* included_vlib_threads_h */