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 extern 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;
75 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
81 /* 256 * 4 = 1024 bytes, even mult of cache line size */
82 u32 buffer_index[VLIB_FRAME_SIZE];
84 vlib_frame_queue_elt_t;
88 /* First cache line */
89 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
90 volatile u32 *wait_at_barrier;
91 volatile u32 *workers_at_barrier;
93 /* Second Cache Line */
94 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
97 void (*thread_function) (void *);
98 void *thread_function_arg;
100 elog_track_t elog_track;
102 vlib_thread_registration_t *registration;
104 u64 barrier_sync_count;
109 } vlib_worker_thread_t;
111 extern vlib_worker_thread_t *vlib_worker_threads;
116 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
121 u32 enqueue_full_events;
124 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
130 u64 vector_threshold;
132 /* dequeue hint to enqueue side */
133 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
134 volatile u64 head_hint;
136 /* read-only, constant, shared */
137 CLIB_CACHE_LINE_ALIGN_MARK (cacheline3);
138 vlib_frame_queue_elt_t *elts;
146 vlib_frame_queue_t **vlib_frame_queues;
148 /* for frame queue tracing */
149 frame_queue_trace_t *frame_queue_traces;
150 frame_queue_nelt_counter_t *frame_queue_histogram;
151 } vlib_frame_queue_main_t;
153 /* Called early, in thread 0's context */
154 clib_error_t *vlib_thread_init (vlib_main_t * vm);
156 vlib_worker_thread_t *vlib_alloc_thread (vlib_main_t * vm);
158 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
159 u32 frame_queue_index, vlib_frame_t * frame,
160 vlib_frame_queue_msg_type_t type);
163 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm);
165 u64 dispatch_node (vlib_main_t * vm,
166 vlib_node_runtime_t * node,
167 vlib_node_type_t type,
168 vlib_node_state_t dispatch_state,
169 vlib_frame_t * frame, u64 last_time_stamp);
171 u64 dispatch_pending_node (vlib_main_t * vm,
172 vlib_pending_frame_t * p, u64 last_time_stamp);
174 void vlib_worker_thread_node_runtime_update (void);
176 void vlib_create_worker_threads (vlib_main_t * vm, int n,
177 void (*thread_function) (void *));
179 void vlib_worker_thread_init (vlib_worker_thread_t * w);
180 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
182 /* Check for a barrier sync request every 30ms */
183 #define BARRIER_SYNC_DELAY (0.030000)
186 /* long barrier timeout, for gdb... */
187 #define BARRIER_SYNC_TIMEOUT (600.1)
189 #define BARRIER_SYNC_TIMEOUT (1.0)
192 void vlib_worker_thread_barrier_sync (vlib_main_t * vm);
193 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
196 vlib_smp_unsafe_warning (void)
200 if (os_get_cpu_number ())
201 fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
207 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
208 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
211 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
214 vlib_worker_thread_barrier_check (void)
216 if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
218 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
219 while (*vlib_worker_threads->wait_at_barrier)
221 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
225 #define foreach_vlib_main(body) \
227 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
230 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
232 this_vlib_main = vlib_mains[ii]; \
233 if (this_vlib_main) \
234 vec_add1 (__vlib_mains, this_vlib_main); \
237 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
239 this_vlib_main = __vlib_mains[ii]; \
240 /* body uses this_vlib_main... */ \
243 vec_free (__vlib_mains); \
246 #define foreach_sched_policy \
247 _(SCHED_OTHER, OTHER, "other") \
248 _(SCHED_BATCH, BATCH, "batch") \
249 _(SCHED_IDLE, IDLE, "idle") \
250 _(SCHED_FIFO, FIFO, "fifo") \
251 _(SCHED_RR, RR, "rr")
255 #define _(v,f,s) SCHED_POLICY_##f = v,
263 clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
265 clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 lcore);
266 } vlib_thread_callbacks_t;
270 /* Link list of registrations, built by constructors */
271 vlib_thread_registration_t *next;
273 /* Vector of registrations, w/ non-data-structure clones at the top */
274 vlib_thread_registration_t **registrations;
276 uword *thread_registrations_by_name;
278 vlib_worker_thread_t *worker_threads;
281 * Launch all threads as pthreads,
282 * not eal_rte_launch (strict affinity) threads
286 /* Number of vlib_main / vnet_main clones */
289 /* Number of thread stacks to create */
292 /* Number of pthreads */
295 /* Number of threads */
298 /* Number of cores to skip, must match the core mask */
301 /* Thread prefix name */
304 /* main thread lcore */
307 /* Bitmap of available CPU cores */
308 uword *cpu_core_bitmap;
310 /* Bitmap of available CPU sockets (NUMA nodes) */
311 uword *cpu_socket_bitmap;
313 /* Worker handoff queues */
314 vlib_frame_queue_main_t *frame_queue_mains;
316 /* worker thread initialization barrier */
317 volatile u32 worker_thread_release;
319 /* scheduling policy */
322 /* scheduling policy priority */
326 vlib_thread_callbacks_t cb;
327 int extern_thread_mgmt;
328 } vlib_thread_main_t;
330 extern vlib_thread_main_t vlib_thread_main;
332 #define VLIB_REGISTER_THREAD(x,...) \
333 __VA_ARGS__ vlib_thread_registration_t x; \
334 static void __vlib_add_thread_registration_##x (void) \
335 __attribute__((__constructor__)) ; \
336 static void __vlib_add_thread_registration_##x (void) \
338 vlib_thread_main_t * tm = &vlib_thread_main; \
342 __VA_ARGS__ vlib_thread_registration_t x
347 return vlib_thread_main.n_vlib_mains - 1;
351 vlib_get_worker_cpu_index (u32 worker_index)
353 return worker_index + 1;
357 vlib_get_worker_index (u32 cpu_index)
359 return cpu_index - 1;
363 vlib_get_current_worker_index ()
365 return os_get_cpu_number () - 1;
368 always_inline vlib_main_t *
369 vlib_get_worker_vlib_main (u32 worker_index)
372 vlib_thread_main_t *tm = &vlib_thread_main;
373 ASSERT (worker_index < tm->n_vlib_mains - 1);
374 vm = vlib_mains[worker_index + 1];
380 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
382 CLIB_MEMORY_BARRIER ();
386 static inline vlib_frame_queue_elt_t *
387 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
389 vlib_frame_queue_t *fq;
390 vlib_frame_queue_elt_t *elt;
391 vlib_thread_main_t *tm = &vlib_thread_main;
392 vlib_frame_queue_main_t *fqm =
393 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
396 fq = fqm->vlib_frame_queues[index];
399 new_tail = __sync_add_and_fetch (&fq->tail, 1);
401 /* Wait until a ring slot is available */
402 while (new_tail >= fq->head_hint + fq->nelts)
403 vlib_worker_thread_barrier_check ();
405 elt = fq->elts + (new_tail & (fq->nelts - 1));
407 /* this would be very bad... */
411 elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
412 elt->last_n_vectors = elt->n_vectors = 0;
417 static inline vlib_frame_queue_t *
418 is_vlib_frame_queue_congested (u32 frame_queue_index,
421 vlib_frame_queue_t **
422 handoff_queue_by_worker_index)
424 vlib_frame_queue_t *fq;
425 vlib_thread_main_t *tm = &vlib_thread_main;
426 vlib_frame_queue_main_t *fqm =
427 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
429 fq = handoff_queue_by_worker_index[index];
430 if (fq != (vlib_frame_queue_t *) (~0))
433 fq = fqm->vlib_frame_queues[index];
436 if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
438 /* a valid entry in the array will indicate the queue has reached
439 * the specified threshold and is congested
441 handoff_queue_by_worker_index[index] = fq;
442 fq->enqueue_full_events++;
449 static inline vlib_frame_queue_elt_t *
450 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
451 u32 vlib_worker_index,
452 vlib_frame_queue_elt_t **
453 handoff_queue_elt_by_worker_index)
455 vlib_frame_queue_elt_t *elt;
457 if (handoff_queue_elt_by_worker_index[vlib_worker_index])
458 return handoff_queue_elt_by_worker_index[vlib_worker_index];
460 elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
462 handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
467 int vlib_thread_cb_register (struct vlib_main_t *vm,
468 vlib_thread_callbacks_t * cb);
470 #endif /* included_vlib_threads_h */
473 * fd.io coding-style-patch-verification: ON
476 * eval: (c-set-style "gnu")