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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef included_vlib_threads_h
16 #define included_vlib_threads_h
18 #include <vlib/main.h>
20 vlib_main_t **vlib_mains;
23 vlib_set_thread_name (char *name);
25 /* arg is actually a vlib__thread_t * */
26 typedef void (vlib_thread_function_t) (void * arg);
28 typedef struct vlib_thread_registration_ {
29 /* constructor generated list of thread registrations */
30 struct vlib_thread_registration_ * next;
32 /* config parameters */
35 vlib_thread_function_t * function;
39 int no_data_structure_clone;
40 u32 frame_queue_nelts;
42 /* All threads of this type run on pthreads */
46 } vlib_thread_registration_t;
49 * Frames have their cpu / vlib_main_t index in the low-order N bits
50 * Make VLIB_MAX_CPUS a power-of-two, please...
54 #define VLIB_MAX_CPUS 256
57 #if VLIB_MAX_CPUS > CLIB_MAX_MHEAPS
58 #error Please increase number of per-cpu mheaps
61 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1) /* 0x3f, max */
62 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
64 #define VLIB_LOG2_THREAD_STACK_SIZE (20)
65 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
68 VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
69 } vlib_frame_queue_msg_type_t;
77 /* 256 * 4 = 1024 bytes, even mult of cache line size */
78 u32 buffer_index[VLIB_FRAME_SIZE];
80 /* Pad to a cache line boundary */
81 u8 pad[CLIB_CACHE_LINE_BYTES - 4 * sizeof(u32)];
82 } vlib_frame_queue_elt_t;
85 /* First cache line */
86 volatile u32 *wait_at_barrier;
87 volatile u32 *workers_at_barrier;
88 u8 pad0[CLIB_CACHE_LINE_BYTES - (2 * sizeof (u32 *))];
90 /* Second Cache Line */
93 void (*thread_function)(void *);
94 void * thread_function_arg;
96 elog_track_t elog_track;
98 vlib_thread_registration_t *registration;
100 u64 barrier_sync_count;
104 } vlib_worker_thread_t;
106 vlib_worker_thread_t *vlib_worker_threads;
114 u32 enqueue_full_events;
115 u32 enqueue_efd_discards;
116 u8 pad2[CLIB_CACHE_LINE_BYTES
118 - (4 * sizeof(u64))];
126 u64 vector_threshold;
127 u8 pad4[CLIB_CACHE_LINE_BYTES
128 - (6 * sizeof(u64))];
130 /* dequeue hint to enqueue side */
131 volatile u64 head_hint;
132 u8 pad5 [CLIB_CACHE_LINE_BYTES - sizeof(u64)];
134 /* read-only, constant, shared */
135 vlib_frame_queue_elt_t *elts;
137 } vlib_frame_queue_t;
139 vlib_frame_queue_t **vlib_frame_queues;
141 /* Called early, in thread 0's context */
142 clib_error_t * vlib_thread_init (vlib_main_t * vm);
144 vlib_worker_thread_t * vlib_alloc_thread (vlib_main_t * vm);
146 int vlib_frame_queue_enqueue (vlib_main_t *vm, u32 node_runtime_index,
147 u32 frame_queue_index, vlib_frame_t *frame,
148 vlib_frame_queue_msg_type_t type);
150 int vlib_frame_queue_dequeue (int thread_id,
152 vlib_node_main_t *nm);
154 u64 dispatch_node (vlib_main_t * vm,
155 vlib_node_runtime_t * node,
156 vlib_node_type_t type,
157 vlib_node_state_t dispatch_state,
158 vlib_frame_t * frame,
159 u64 last_time_stamp);
161 u64 dispatch_pending_node (vlib_main_t * vm,
162 vlib_pending_frame_t * p,
163 u64 last_time_stamp);
165 void vlib_worker_thread_node_runtime_update(void);
167 void vlib_create_worker_threads (vlib_main_t *vm, int n,
168 void (*thread_function)(void *));
170 void vlib_worker_thread_init (vlib_worker_thread_t * w);
172 /* Check for a barrier sync request every 30ms */
173 #define BARRIER_SYNC_DELAY (0.030000)
176 /* long barrier timeout, for gdb... */
177 #define BARRIER_SYNC_TIMEOUT (600.1)
179 #define BARRIER_SYNC_TIMEOUT (1.0)
182 void vlib_worker_thread_barrier_sync(vlib_main_t *vm);
183 void vlib_worker_thread_barrier_release(vlib_main_t *vm);
185 always_inline void vlib_smp_unsafe_warning (void)
189 if (os_get_cpu_number())
190 fformat(stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
195 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
196 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
199 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
201 static inline void vlib_worker_thread_barrier_check (void)
203 if (PREDICT_FALSE(*vlib_worker_threads->wait_at_barrier))
205 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
206 while (*vlib_worker_threads->wait_at_barrier)
208 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
212 #define foreach_vlib_main(body) \
214 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
217 if (vec_len (vlib_mains) == 0) \
218 vec_add1 (__vlib_mains, &vlib_global_main); \
221 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
223 this_vlib_main = vlib_mains[ii]; \
224 if (this_vlib_main) \
225 vec_add1 (__vlib_mains, this_vlib_main); \
229 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
231 this_vlib_main = __vlib_mains[ii]; \
232 /* body uses this_vlib_main... */ \
235 vec_free (__vlib_mains); \
239 /* Early-Fast-Discard (EFD) */
240 #define VLIB_EFD_DISABLED 0
241 #define VLIB_EFD_DISCARD_ENABLED (1 << 0)
242 #define VLIB_EFD_MONITOR_ENABLED (1 << 1)
244 #define VLIB_EFD_DEF_WORKER_HI_THRESH_PCT 90
246 /* EFD worker thread settings */
247 typedef struct vlib_efd_t {
257 /* Link list of registrations, built by constructors */
258 vlib_thread_registration_t * next;
260 /* Vector of registrations, w/ non-data-structure clones at the top */
261 vlib_thread_registration_t ** registrations;
263 uword * thread_registrations_by_name;
265 vlib_worker_thread_t * worker_threads;
268 * Launch all threads as pthreads,
269 * not eal_rte_launch (strict affinity) threads
273 /* Number of vlib_main / vnet_main clones */
276 /* Number of thread stacks to create */
279 /* Number of pthreads */
282 /* Number of DPDK eal threads */
285 /* Number of cores to skip, must match the core mask */
288 /* Thread prefix name */
291 /* main thread lcore */
294 /* Bitmap of available CPU cores */
295 uword * cpu_core_bitmap;
297 /* Bitmap of available CPU sockets (NUMA nodes) */
298 uword * cpu_socket_bitmap;
302 } vlib_thread_main_t;
304 vlib_thread_main_t vlib_thread_main;
306 #define VLIB_REGISTER_THREAD(x,...) \
307 __VA_ARGS__ vlib_thread_registration_t x; \
308 static void __vlib_add_thread_registration_##x (void) \
309 __attribute__((__constructor__)) ; \
310 static void __vlib_add_thread_registration_##x (void) \
312 vlib_thread_main_t * tm = &vlib_thread_main; \
316 __VA_ARGS__ vlib_thread_registration_t x
318 #endif /* included_vlib_threads_h */