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>
19 #include <linux/sched.h>
21 vlib_main_t **vlib_mains;
23 void 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_
30 /* constructor generated list of thread registrations */
31 struct vlib_thread_registration_ *next;
33 /* config parameters */
36 vlib_thread_function_t *function;
40 int no_data_structure_clone;
41 u32 frame_queue_nelts;
43 /* All threads of this type run on pthreads */
47 } vlib_thread_registration_t;
50 * Frames have their cpu / vlib_main_t index in the low-order N bits
51 * Make VLIB_MAX_CPUS a power-of-two, please...
55 #define VLIB_MAX_CPUS 256
58 #if VLIB_MAX_CPUS > CLIB_MAX_MHEAPS
59 #error Please increase number of per-cpu mheaps
62 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1) /* 0x3f, max */
63 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
65 #define VLIB_LOG2_THREAD_STACK_SIZE (20)
66 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
70 VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
71 } vlib_frame_queue_msg_type_t;
80 /* 256 * 4 = 1024 bytes, even mult of cache line size */
81 u32 buffer_index[VLIB_FRAME_SIZE];
83 /* Pad to a cache line boundary */
84 u8 pad[CLIB_CACHE_LINE_BYTES - 4 * sizeof (u32)];
86 vlib_frame_queue_elt_t;
90 /* First cache line */
91 volatile u32 *wait_at_barrier;
92 volatile u32 *workers_at_barrier;
93 u8 pad0[CLIB_CACHE_LINE_BYTES - (2 * sizeof (u32 *))];
95 /* Second Cache Line */
98 void (*thread_function) (void *);
99 void *thread_function_arg;
101 elog_track_t elog_track;
103 vlib_thread_registration_t *registration;
105 u64 barrier_sync_count;
109 } vlib_worker_thread_t;
111 vlib_worker_thread_t *vlib_worker_threads;
120 u32 enqueue_full_events;
121 u32 enqueue_efd_discards;
122 u8 pad2[CLIB_CACHE_LINE_BYTES - (2 * sizeof (u32)) - (4 * sizeof (u64))];
130 u64 vector_threshold;
131 u8 pad4[CLIB_CACHE_LINE_BYTES - (6 * sizeof (u64))];
133 /* dequeue hint to enqueue side */
134 volatile u64 head_hint;
135 u8 pad5[CLIB_CACHE_LINE_BYTES - sizeof (u64)];
137 /* read-only, constant, shared */
138 vlib_frame_queue_elt_t *elts;
143 vlib_frame_queue_t **vlib_frame_queues;
145 /* Called early, in thread 0's context */
146 clib_error_t *vlib_thread_init (vlib_main_t * vm);
148 vlib_worker_thread_t *vlib_alloc_thread (vlib_main_t * vm);
150 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
151 u32 frame_queue_index, vlib_frame_t * frame,
152 vlib_frame_queue_msg_type_t type);
154 int vlib_frame_queue_dequeue (int thread_id,
155 vlib_main_t * vm, vlib_node_main_t * nm);
157 u64 dispatch_node (vlib_main_t * vm,
158 vlib_node_runtime_t * node,
159 vlib_node_type_t type,
160 vlib_node_state_t dispatch_state,
161 vlib_frame_t * frame, u64 last_time_stamp);
163 u64 dispatch_pending_node (vlib_main_t * vm,
164 vlib_pending_frame_t * p, u64 last_time_stamp);
166 void vlib_worker_thread_node_runtime_update (void);
168 void vlib_create_worker_threads (vlib_main_t * vm, int n,
169 void (*thread_function) (void *));
171 void vlib_worker_thread_init (vlib_worker_thread_t * w);
173 /* Check for a barrier sync request every 30ms */
174 #define BARRIER_SYNC_DELAY (0.030000)
177 /* long barrier timeout, for gdb... */
178 #define BARRIER_SYNC_TIMEOUT (600.1)
180 #define BARRIER_SYNC_TIMEOUT (1.0)
183 void vlib_worker_thread_barrier_sync (vlib_main_t * vm);
184 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
187 vlib_smp_unsafe_warning (void)
191 if (os_get_cpu_number ())
192 fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
198 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
199 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
202 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
205 vlib_worker_thread_barrier_check (void)
207 if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
209 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
210 while (*vlib_worker_threads->wait_at_barrier)
212 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
216 #define foreach_vlib_main(body) \
218 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
221 if (vec_len (vlib_mains) == 0) \
222 vec_add1 (__vlib_mains, &vlib_global_main); \
225 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
227 this_vlib_main = vlib_mains[ii]; \
228 if (this_vlib_main) \
229 vec_add1 (__vlib_mains, this_vlib_main); \
233 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
235 this_vlib_main = __vlib_mains[ii]; \
236 /* body uses this_vlib_main... */ \
239 vec_free (__vlib_mains); \
243 /* Early-Fast-Discard (EFD) */
244 #define VLIB_EFD_DISABLED 0
245 #define VLIB_EFD_DISCARD_ENABLED (1 << 0)
246 #define VLIB_EFD_MONITOR_ENABLED (1 << 1)
248 #define VLIB_EFD_DEF_WORKER_HI_THRESH_PCT 90
250 /* EFD worker thread settings */
251 typedef struct vlib_efd_t
261 #define foreach_sched_policy \
262 _(SCHED_OTHER, OTHER, "other") \
263 _(SCHED_BATCH, BATCH, "batch") \
264 _(SCHED_IDLE, IDLE, "idle") \
265 _(SCHED_FIFO, FIFO, "fifo") \
266 _(SCHED_RR, RR, "rr")
270 #define _(v,f,s) SCHED_POLICY_##f = v,
278 /* Link list of registrations, built by constructors */
279 vlib_thread_registration_t *next;
281 /* Vector of registrations, w/ non-data-structure clones at the top */
282 vlib_thread_registration_t **registrations;
284 uword *thread_registrations_by_name;
286 vlib_worker_thread_t *worker_threads;
289 * Launch all threads as pthreads,
290 * not eal_rte_launch (strict affinity) threads
294 /* Number of vlib_main / vnet_main clones */
297 /* Number of thread stacks to create */
300 /* Number of pthreads */
303 /* Number of DPDK eal threads */
306 /* Number of cores to skip, must match the core mask */
309 /* Thread prefix name */
312 /* main thread lcore */
315 /* Bitmap of available CPU cores */
316 uword *cpu_core_bitmap;
318 /* Bitmap of available CPU sockets (NUMA nodes) */
319 uword *cpu_socket_bitmap;
323 /* handoff node index */
324 u32 handoff_dispatch_node_index;
326 /* for frame queue tracing */
327 frame_queue_trace_t *frame_queue_traces;
328 frame_queue_nelt_counter_t *frame_queue_histogram;
330 /* worker thread initialization barrier */
331 volatile u32 worker_thread_release;
333 /* scheduling policy */
336 /* scheduling policy priority */
339 } vlib_thread_main_t;
341 vlib_thread_main_t vlib_thread_main;
343 #define VLIB_REGISTER_THREAD(x,...) \
344 __VA_ARGS__ vlib_thread_registration_t x; \
345 static void __vlib_add_thread_registration_##x (void) \
346 __attribute__((__constructor__)) ; \
347 static void __vlib_add_thread_registration_##x (void) \
349 vlib_thread_main_t * tm = &vlib_thread_main; \
353 __VA_ARGS__ vlib_thread_registration_t x
355 #endif /* included_vlib_threads_h */
358 * fd.io coding-style-patch-verification: ON
361 * eval: (c-set-style "gnu")