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;
46 #define VLIB_MAX_CPUS 32
49 * Objects passed around by "index" are cache-line aligned.
50 * We can stick the owner CPU into the low 6 bits.
52 #if VLIB_MAX_CPUS > 64
53 #error VLIB_MAX_CPUS must be <= 64
56 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1) /* 0x3f, max */
57 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
59 #define VLIB_LOG2_THREAD_STACK_SIZE (20)
60 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
63 VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
64 } vlib_frame_queue_msg_type_t;
72 /* 256 * 4 = 1024 bytes, even mult of cache line size */
73 u32 buffer_index[VLIB_FRAME_SIZE];
75 /* Pad to a cache line boundary */
76 u8 pad[CLIB_CACHE_LINE_BYTES - 4 * sizeof(u32)];
77 } vlib_frame_queue_elt_t;
80 /* First cache line */
81 volatile u32 *wait_at_barrier;
82 volatile u32 *workers_at_barrier;
83 u8 pad0[CLIB_CACHE_LINE_BYTES - (2 * sizeof (u32 *))];
85 /* Second Cache Line */
88 void (*thread_function)(void *);
89 void * thread_function_arg;
91 elog_track_t elog_track;
93 vlib_thread_registration_t *registration;
98 } vlib_worker_thread_t;
100 vlib_worker_thread_t *vlib_worker_threads;
108 u32 enqueue_full_events;
109 u32 enqueue_efd_discards;
110 u8 pad2[CLIB_CACHE_LINE_BYTES
112 - (4 * sizeof(u64))];
120 u64 vector_threshold;
121 u8 pad4[CLIB_CACHE_LINE_BYTES
122 - (6 * sizeof(u64))];
124 /* dequeue hint to enqueue side */
125 volatile u64 head_hint;
126 u8 pad5 [CLIB_CACHE_LINE_BYTES - sizeof(u64)];
128 /* read-only, constant, shared */
129 vlib_frame_queue_elt_t *elts;
131 } vlib_frame_queue_t;
133 vlib_frame_queue_t **vlib_frame_queues;
135 /* Called early, in thread 0's context */
136 clib_error_t * vlib_thread_init (vlib_main_t * vm);
138 vlib_worker_thread_t * vlib_alloc_thread (vlib_main_t * vm);
140 int vlib_frame_queue_enqueue (vlib_main_t *vm, u32 node_runtime_index,
141 u32 frame_queue_index, vlib_frame_t *frame,
142 vlib_frame_queue_msg_type_t type);
144 int vlib_frame_queue_dequeue (int thread_id,
146 vlib_node_main_t *nm);
148 u64 dispatch_node (vlib_main_t * vm,
149 vlib_node_runtime_t * node,
150 vlib_node_type_t type,
151 vlib_node_state_t dispatch_state,
152 vlib_frame_t * frame,
153 u64 last_time_stamp);
155 u64 dispatch_pending_node (vlib_main_t * vm,
156 vlib_pending_frame_t * p,
157 u64 last_time_stamp);
159 void vlib_worker_thread_node_runtime_update(void);
161 void vlib_create_worker_threads (vlib_main_t *vm, int n,
162 void (*thread_function)(void *));
164 void vlib_worker_thread_init (vlib_worker_thread_t * w);
166 /* Check for a barrier sync request every 30ms */
167 #define BARRIER_SYNC_DELAY (0.030000)
170 /* long barrier timeout, for gdb... */
171 #define BARRIER_SYNC_TIMEOUT (600.1)
173 #define BARRIER_SYNC_TIMEOUT (1.0)
176 void vlib_worker_thread_barrier_sync(vlib_main_t *vm);
177 void vlib_worker_thread_barrier_release(vlib_main_t *vm);
179 always_inline void vlib_smp_unsafe_warning (void)
183 if (os_get_cpu_number())
184 fformat(stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
189 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
190 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
193 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
195 static inline void vlib_worker_thread_barrier_check (void)
197 if (PREDICT_FALSE(*vlib_worker_threads->wait_at_barrier))
199 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
200 while (*vlib_worker_threads->wait_at_barrier)
202 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
206 #define foreach_vlib_main(body) \
208 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
211 if (vec_len (vlib_mains) == 0) \
212 vec_add1 (__vlib_mains, &vlib_global_main); \
215 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
217 this_vlib_main = vlib_mains[ii]; \
218 if (this_vlib_main) \
219 vec_add1 (__vlib_mains, this_vlib_main); \
223 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
225 this_vlib_main = __vlib_mains[ii]; \
226 /* body uses this_vlib_main... */ \
229 vec_free (__vlib_mains); \
233 /* Early-Fast-Discard (EFD) */
234 #define VLIB_EFD_DISABLED 0
235 #define VLIB_EFD_DISCARD_ENABLED (1 << 0)
236 #define VLIB_EFD_MONITOR_ENABLED (1 << 1)
238 #define VLIB_EFD_DEF_WORKER_HI_THRESH_PCT 90
240 /* EFD worker thread settings */
241 typedef struct vlib_efd_t {
251 /* Link list of registrations, built by constructors */
252 vlib_thread_registration_t * next;
254 /* Vector of registrations, w/ non-data-structure clones at the top */
255 vlib_thread_registration_t ** registrations;
257 uword * thread_registrations_by_name;
259 vlib_worker_thread_t * worker_threads;
261 /* thread / cpu / io thread parameters */
262 u32 main_thread_is_io_node;
265 * Launch all threads as pthreads,
266 * not eal_rte_launch (strict affinity) threads
270 /* Number of vlib_main / vnet_main clones */
273 /* Number of thread stacks to create */
276 /* Number of pthreads */
279 /* Number of DPDK eal threads */
282 /* Number of cores to skip, must match the core mask */
285 /* Thread prefix name */
288 /* main thread lcore */
291 /* Bitmap of available CPU cores */
292 uword * cpu_core_bitmap;
294 /* Bitmap of available CPU sockets (NUMA nodes) */
295 uword * cpu_socket_bitmap;
299 } vlib_thread_main_t;
301 vlib_thread_main_t vlib_thread_main;
303 #define VLIB_REGISTER_THREAD(x,...) \
304 __VA_ARGS__ vlib_thread_registration_t x; \
305 static void __vlib_add_thread_registration_##x (void) \
306 __attribute__((__constructor__)) ; \
307 static void __vlib_add_thread_registration_##x (void) \
309 vlib_thread_main_t * tm = &vlib_thread_main; \
313 __VA_ARGS__ vlib_thread_registration_t x
315 #endif /* included_vlib_threads_h */