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 /* All threads of this type run on pthreads */
44 } vlib_thread_registration_t;
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...
52 #define VLIB_MAX_CPUS 256
55 #if VLIB_MAX_CPUS > CLIB_MAX_MHEAPS
56 #error Please increase number of per-cpu mheaps
59 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1) /* 0x3f, max */
60 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
62 #define VLIB_LOG2_THREAD_STACK_SIZE (20)
63 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
66 VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
67 } vlib_frame_queue_msg_type_t;
75 /* 256 * 4 = 1024 bytes, even mult of cache line size */
76 u32 buffer_index[VLIB_FRAME_SIZE];
78 /* Pad to a cache line boundary */
79 u8 pad[CLIB_CACHE_LINE_BYTES - 4 * sizeof(u32)];
80 } vlib_frame_queue_elt_t;
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 *))];
88 /* Second Cache Line */
91 void (*thread_function)(void *);
92 void * thread_function_arg;
94 elog_track_t elog_track;
96 vlib_thread_registration_t *registration;
98 u64 barrier_sync_count;
102 } vlib_worker_thread_t;
104 vlib_worker_thread_t *vlib_worker_threads;
112 u32 enqueue_full_events;
113 u32 enqueue_efd_discards;
114 u8 pad2[CLIB_CACHE_LINE_BYTES
116 - (4 * sizeof(u64))];
124 u64 vector_threshold;
125 u8 pad4[CLIB_CACHE_LINE_BYTES
126 - (6 * sizeof(u64))];
128 /* dequeue hint to enqueue side */
129 volatile u64 head_hint;
130 u8 pad5 [CLIB_CACHE_LINE_BYTES - sizeof(u64)];
132 /* read-only, constant, shared */
133 vlib_frame_queue_elt_t *elts;
135 } vlib_frame_queue_t;
137 vlib_frame_queue_t **vlib_frame_queues;
139 /* Called early, in thread 0's context */
140 clib_error_t * vlib_thread_init (vlib_main_t * vm);
142 vlib_worker_thread_t * vlib_alloc_thread (vlib_main_t * vm);
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);
148 int vlib_frame_queue_dequeue (int thread_id,
150 vlib_node_main_t *nm);
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);
159 u64 dispatch_pending_node (vlib_main_t * vm,
160 vlib_pending_frame_t * p,
161 u64 last_time_stamp);
163 void vlib_worker_thread_node_runtime_update(void);
165 void vlib_create_worker_threads (vlib_main_t *vm, int n,
166 void (*thread_function)(void *));
168 void vlib_worker_thread_init (vlib_worker_thread_t * w);
170 /* Check for a barrier sync request every 30ms */
171 #define BARRIER_SYNC_DELAY (0.030000)
174 /* long barrier timeout, for gdb... */
175 #define BARRIER_SYNC_TIMEOUT (600.1)
177 #define BARRIER_SYNC_TIMEOUT (1.0)
180 void vlib_worker_thread_barrier_sync(vlib_main_t *vm);
181 void vlib_worker_thread_barrier_release(vlib_main_t *vm);
183 always_inline void vlib_smp_unsafe_warning (void)
187 if (os_get_cpu_number())
188 fformat(stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
193 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
194 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
197 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
199 static inline void vlib_worker_thread_barrier_check (void)
201 if (PREDICT_FALSE(*vlib_worker_threads->wait_at_barrier))
203 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
204 while (*vlib_worker_threads->wait_at_barrier)
206 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
210 #define foreach_vlib_main(body) \
212 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
215 if (vec_len (vlib_mains) == 0) \
216 vec_add1 (__vlib_mains, &vlib_global_main); \
219 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
221 this_vlib_main = vlib_mains[ii]; \
222 if (this_vlib_main) \
223 vec_add1 (__vlib_mains, this_vlib_main); \
227 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
229 this_vlib_main = __vlib_mains[ii]; \
230 /* body uses this_vlib_main... */ \
233 vec_free (__vlib_mains); \
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)
242 #define VLIB_EFD_DEF_WORKER_HI_THRESH_PCT 90
244 /* EFD worker thread settings */
245 typedef struct vlib_efd_t {
255 /* Link list of registrations, built by constructors */
256 vlib_thread_registration_t * next;
258 /* Vector of registrations, w/ non-data-structure clones at the top */
259 vlib_thread_registration_t ** registrations;
261 uword * thread_registrations_by_name;
263 vlib_worker_thread_t * worker_threads;
265 /* thread / cpu / io thread parameters */
266 u32 main_thread_is_io_node;
269 * Launch all threads as pthreads,
270 * not eal_rte_launch (strict affinity) threads
274 /* Number of vlib_main / vnet_main clones */
277 /* Number of thread stacks to create */
280 /* Number of pthreads */
283 /* Number of DPDK eal threads */
286 /* Number of cores to skip, must match the core mask */
289 /* Thread prefix name */
292 /* main thread lcore */
295 /* Bitmap of available CPU cores */
296 uword * cpu_core_bitmap;
298 /* Bitmap of available CPU sockets (NUMA nodes) */
299 uword * cpu_socket_bitmap;
303 } vlib_thread_main_t;
305 vlib_thread_main_t vlib_thread_main;
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) \
313 vlib_thread_main_t * tm = &vlib_thread_main; \
317 __VA_ARGS__ vlib_thread_registration_t x
319 #endif /* included_vlib_threads_h */