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