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 #define VLIB_MAX_CPUS 256
  52
  53 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1) /* 0x3f, max */
  54 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
  55
  56 #define VLIB_LOG2_THREAD_STACK_SIZE (20)
  57 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
  58
  59 typedef enum {
  60     VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
  61 } vlib_frame_queue_msg_type_t;
  62
  63 typedef struct {
  64   volatile u32 valid;
  65   u32 msg_type;
  66   u32 n_vectors;
  67   u32 last_n_vectors;
  68
  69   /* 256 * 4 = 1024 bytes, even mult of cache line size */
  70   u32 buffer_index[VLIB_FRAME_SIZE];
  71
  72   /* Pad to a cache line boundary */
  73   u8 pad[CLIB_CACHE_LINE_BYTES - 4 * sizeof(u32)];
  74 } vlib_frame_queue_elt_t;
  75
  76 typedef struct {
  77   /* First cache line */
  78   volatile u32 *wait_at_barrier;
  79   volatile u32 *workers_at_barrier;
  80   u8 pad0[CLIB_CACHE_LINE_BYTES - (2 * sizeof (u32 *))];
  81
  82   /* Second Cache Line */
  83   void *thread_mheap;
  84   u8 * thread_stack;
  85   void (*thread_function)(void *);
  86   void * thread_function_arg;
  87   i64 recursion_level;
  88   elog_track_t elog_track;
  89   u32 instance_id;
  90   vlib_thread_registration_t *registration;
  91   u8 *name;
  92
  93   long lwp;
  94   int dpdk_lcore_id;
  95 } vlib_worker_thread_t;
  96
  97 vlib_worker_thread_t *vlib_worker_threads;
  98
  99 typedef struct {
 100   /* enqueue side */
 101   volatile u64 tail;
 102   u64 enqueues;
 103   u64 enqueue_ticks;
 104   u64 enqueue_vectors;
 105   u32 enqueue_full_events;
 106   u32 enqueue_efd_discards;
 107   u8 pad2[CLIB_CACHE_LINE_BYTES
 108           - (2 * sizeof(u32))
 109           - (4 * sizeof(u64))];
 110
 111   /* dequeue side */
 112   volatile u64 head;
 113   u64 dequeues;
 114   u64 dequeue_ticks;
 115   u64 dequeue_vectors;
 116   u64 trace;
 117   u64 vector_threshold;
 118   u8 pad4[CLIB_CACHE_LINE_BYTES
 119           - (6 * sizeof(u64))];
 120
 121   /* dequeue hint to enqueue side */
 122   volatile u64 head_hint;
 123   u8 pad5 [CLIB_CACHE_LINE_BYTES - sizeof(u64)];
 124
 125   /* read-only, constant, shared */
 126   vlib_frame_queue_elt_t *elts;
 127   u32 nelts;
 128 } vlib_frame_queue_t;
 129
 130 vlib_frame_queue_t **vlib_frame_queues;
 131
 132 /* Called early, in thread 0's context */
 133 clib_error_t * vlib_thread_init (vlib_main_t * vm);
 134
 135 vlib_worker_thread_t * vlib_alloc_thread (vlib_main_t * vm);
 136
 137 int vlib_frame_queue_enqueue (vlib_main_t *vm, u32 node_runtime_index,
 138                               u32 frame_queue_index, vlib_frame_t *frame,
 139                               vlib_frame_queue_msg_type_t type);
 140
 141 int vlib_frame_queue_dequeue (int thread_id,
 142                               vlib_main_t *vm,
 143                               vlib_node_main_t *nm);
 144
 145 u64 dispatch_node (vlib_main_t * vm,
 146                    vlib_node_runtime_t * node,
 147                    vlib_node_type_t type,
 148                    vlib_node_state_t dispatch_state,
 149                    vlib_frame_t * frame,
 150                    u64 last_time_stamp);
 151
 152 u64 dispatch_pending_node (vlib_main_t * vm,
 153                            vlib_pending_frame_t * p,
 154                            u64 last_time_stamp);
 155
 156 void vlib_worker_thread_node_runtime_update(void);
 157
 158 void vlib_create_worker_threads (vlib_main_t *vm, int n,
 159                                  void (*thread_function)(void *));
 160
 161 void vlib_worker_thread_init (vlib_worker_thread_t * w);
 162
 163 /* Check for a barrier sync request every 30ms */
 164 #define BARRIER_SYNC_DELAY (0.030000)
 165
 166 #if CLIB_DEBUG > 0
 167 /* long barrier timeout, for gdb... */
 168 #define BARRIER_SYNC_TIMEOUT (600.1)
 169 #else
 170 #define BARRIER_SYNC_TIMEOUT (1.0)
 171 #endif
 172
 173 void vlib_worker_thread_barrier_sync(vlib_main_t *vm);
 174 void vlib_worker_thread_barrier_release(vlib_main_t *vm);
 175
 176 always_inline void vlib_smp_unsafe_warning (void)
 177 {
 178   if (CLIB_DEBUG > 0)
 179     {
 180       if (os_get_cpu_number())
 181         fformat(stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
 182     }
 183 }
 184
 185 typedef enum {
 186     VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
 187     VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
 188 } vlib_fork_fixup_t;
 189
 190 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
 191
 192 static inline void vlib_worker_thread_barrier_check (void)
 193 {
 194     if (PREDICT_FALSE(*vlib_worker_threads->wait_at_barrier))
 195     {
 196         clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
 197         while (*vlib_worker_threads->wait_at_barrier)
 198             ;
 199         clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
 200     }
 201 }
 202
 203 #define foreach_vlib_main(body)                                         \
 204 do {                                                                    \
 205     vlib_main_t ** __vlib_mains = 0, *this_vlib_main;                   \
 206     int ii;                                                             \
 207                                                                         \
 208     if (vec_len (vlib_mains) == 0)                                      \
 209         vec_add1 (__vlib_mains, &vlib_global_main);                     \
 210     else                                                                \
 211     {                                                                   \
 212         for (ii = 0; ii < vec_len (vlib_mains); ii++)                   \
 213         {                                                               \
 214             this_vlib_main = vlib_mains[ii];                            \
 215             if (this_vlib_main)                                         \
 216                 vec_add1 (__vlib_mains, this_vlib_main);                \
 217         }                                                               \
 218     }                                                                   \
 219                                                                         \
 220     for (ii = 0; ii < vec_len (__vlib_mains); ii++)                     \
 221     {                                                                   \
 222         this_vlib_main = __vlib_mains[ii];                              \
 223         /* body uses this_vlib_main... */                               \
 224         (body);                                                         \
 225     }                                                                   \
 226     vec_free (__vlib_mains);                                            \
 227 } while (0);
 228
 229
 230 /* Early-Fast-Discard (EFD) */
 231 #define VLIB_EFD_DISABLED                   0
 232 #define VLIB_EFD_DISCARD_ENABLED            (1 << 0)
 233 #define VLIB_EFD_MONITOR_ENABLED            (1 << 1)
 234
 235 #define VLIB_EFD_DEF_WORKER_HI_THRESH_PCT   90
 236
 237 /* EFD worker thread settings */
 238 typedef struct vlib_efd_t {
 239   u16 enabled;
 240   u16 queue_hi_thresh;
 241   u8  ip_prec_bitmap;
 242   u8  mpls_exp_bitmap;
 243   u8  vlan_cos_bitmap;
 244   u8  pad;
 245 } vlib_efd_t;
 246
 247 typedef struct {
 248   /* Link list of registrations, built by constructors */
 249   vlib_thread_registration_t * next;
 250
 251   /* Vector of registrations, w/ non-data-structure clones at the top */
 252   vlib_thread_registration_t ** registrations;
 253
 254   uword * thread_registrations_by_name;
 255
 256   vlib_worker_thread_t * worker_threads;
 257
 258   /* thread / cpu / io thread parameters */
 259   u32 main_thread_is_io_node;
 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 DPDK eal threads */
 277   u32 n_eal_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   vlib_efd_t efd;
 295
 296 } vlib_thread_main_t;
 297
 298 vlib_thread_main_t vlib_thread_main;
 299
 300 #define VLIB_REGISTER_THREAD(x,...)                     \
 301   __VA_ARGS__ vlib_thread_registration_t x;             \
 302 static void __vlib_add_thread_registration_##x (void)   \
 303   __attribute__((__constructor__)) ;                    \
 304 static void __vlib_add_thread_registration_##x (void)   \
 305 {                                                       \
 306   vlib_thread_main_t * tm = &vlib_thread_main;          \
 307   x.next = tm->next;                                    \
 308   tm->next = &x;                                        \
 309 }                                                       \
 310 __VA_ARGS__ vlib_thread_registration_t x
 311
 312 #endif /* included_vlib_threads_h */