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 (21)
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;
105 u8 barrier_elog_enabled;
106 const char *barrier_caller;
107 const char *barrier_context;
108 volatile u32 *node_reforks_required;
113 } vlib_worker_thread_t;
115 extern vlib_worker_thread_t *vlib_worker_threads;
120 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
125 u32 enqueue_full_events;
128 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
134 u64 vector_threshold;
136 /* dequeue hint to enqueue side */
137 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
138 volatile u64 head_hint;
140 /* read-only, constant, shared */
141 CLIB_CACHE_LINE_ALIGN_MARK (cacheline3);
142 vlib_frame_queue_elt_t *elts;
149 vlib_frame_queue_elt_t **handoff_queue_elt_by_thread_index;
150 vlib_frame_queue_t **congested_handoff_queue_by_thread_index;
151 } vlib_frame_queue_per_thread_data_t;
156 u32 frame_queue_nelts;
159 vlib_frame_queue_t **vlib_frame_queues;
160 vlib_frame_queue_per_thread_data_t *per_thread_data;
162 /* for frame queue tracing */
163 frame_queue_trace_t *frame_queue_traces;
164 frame_queue_nelt_counter_t *frame_queue_histogram;
165 } vlib_frame_queue_main_t;
172 } vlib_process_signal_event_mt_args_t;
174 /* Called early, in thread 0's context */
175 clib_error_t *vlib_thread_init (vlib_main_t * vm);
177 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
178 u32 frame_queue_index, vlib_frame_t * frame,
179 vlib_frame_queue_msg_type_t type);
182 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm);
184 void vlib_worker_thread_node_runtime_update (void);
186 void vlib_create_worker_threads (vlib_main_t * vm, int n,
187 void (*thread_function) (void *));
189 void vlib_worker_thread_init (vlib_worker_thread_t * w);
190 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
192 /* Check for a barrier sync request every 30ms */
193 #define BARRIER_SYNC_DELAY (0.030000)
196 /* long barrier timeout, for gdb... */
197 #define BARRIER_SYNC_TIMEOUT (600.1)
199 #define BARRIER_SYNC_TIMEOUT (1.0)
202 #define vlib_worker_thread_barrier_sync(X) {vlib_worker_threads[0].barrier_caller=__FUNCTION__;vlib_worker_thread_barrier_sync_int(X);}
204 void vlib_worker_thread_barrier_sync_int (vlib_main_t * vm);
205 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
206 void vlib_worker_thread_node_refork (void);
208 static_always_inline uword
209 vlib_get_thread_index (void)
211 return __os_thread_index;
215 vlib_smp_unsafe_warning (void)
219 if (vlib_get_thread_index ())
220 fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
226 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
227 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
230 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
232 #define foreach_vlib_main(body) \
234 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
237 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
239 this_vlib_main = vlib_mains[ii]; \
241 this_vlib_main->parked_at_barrier == 1); \
242 if (this_vlib_main) \
243 vec_add1 (__vlib_mains, this_vlib_main); \
246 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
248 this_vlib_main = __vlib_mains[ii]; \
249 /* body uses this_vlib_main... */ \
252 vec_free (__vlib_mains); \
255 #define foreach_sched_policy \
256 _(SCHED_OTHER, OTHER, "other") \
257 _(SCHED_BATCH, BATCH, "batch") \
258 _(SCHED_IDLE, IDLE, "idle") \
259 _(SCHED_FIFO, FIFO, "fifo") \
260 _(SCHED_RR, RR, "rr")
264 #define _(v,f,s) SCHED_POLICY_##f = v,
272 clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
274 clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 lcore);
275 } vlib_thread_callbacks_t;
279 /* Link list of registrations, built by constructors */
280 vlib_thread_registration_t *next;
282 /* Vector of registrations, w/ non-data-structure clones at the top */
283 vlib_thread_registration_t **registrations;
285 uword *thread_registrations_by_name;
287 vlib_worker_thread_t *worker_threads;
290 * Launch all threads as pthreads,
291 * not eal_rte_launch (strict affinity) threads
295 /* Number of vlib_main / vnet_main clones */
298 /* Number of thread stacks to create */
301 /* Number of pthreads */
304 /* Number of threads */
307 /* Number of cores to skip, must match the core mask */
310 /* Thread prefix name */
313 /* main thread lcore */
316 /* Bitmap of available CPU cores */
317 uword *cpu_core_bitmap;
319 /* Bitmap of available CPU sockets (NUMA nodes) */
320 uword *cpu_socket_bitmap;
322 /* Worker handoff queues */
323 vlib_frame_queue_main_t *frame_queue_mains;
325 /* worker thread initialization barrier */
326 volatile u32 worker_thread_release;
328 /* scheduling policy */
331 /* scheduling policy priority */
335 vlib_thread_callbacks_t cb;
336 int extern_thread_mgmt;
337 } vlib_thread_main_t;
339 extern vlib_thread_main_t vlib_thread_main;
341 #include <vlib/global_funcs.h>
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 static void __vlib_rm_thread_registration_##x (void) \
354 __attribute__((__destructor__)) ; \
355 static void __vlib_rm_thread_registration_##x (void) \
357 vlib_thread_main_t * tm = &vlib_thread_main; \
358 VLIB_REMOVE_FROM_LINKED_LIST (tm->next, &x, next); \
360 __VA_ARGS__ vlib_thread_registration_t x
365 return vlib_thread_main.n_vlib_mains - 1;
369 vlib_get_worker_thread_index (u32 worker_index)
371 return worker_index + 1;
375 vlib_get_worker_index (u32 thread_index)
377 return thread_index - 1;
381 vlib_get_current_worker_index ()
383 return vlib_get_thread_index () - 1;
387 vlib_worker_thread_barrier_check (void)
389 if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
391 vlib_main_t *vm = vlib_get_main ();
392 u32 thread_index = vm->thread_index;
393 f64 t = vlib_time_now (vm);
395 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
397 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
399 ELOG_TYPE_DECLARE (e) = {
400 .format = "barrier-wait-thread-%d",
410 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
412 ed->thread_index = thread_index;
415 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
418 vm = vlib_get_main ();
419 vm->parked_at_barrier = 1;
421 while (*vlib_worker_threads->wait_at_barrier)
424 vm->parked_at_barrier = 0;
425 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
427 if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
429 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
431 t = vlib_time_now (vm) - t;
432 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
434 ELOG_TYPE_DECLARE (e) = {
435 .format = "barrier-refork-thread-%d",
445 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
447 ed->thread_index = thread_index;
450 vlib_worker_thread_node_refork ();
451 clib_smp_atomic_add (vlib_worker_threads->node_reforks_required,
453 while (*vlib_worker_threads->node_reforks_required)
456 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
458 t = vlib_time_now (vm) - t;
459 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
461 ELOG_TYPE_DECLARE (e) = {
462 .format = "barrier-released-thread-%d: %dus",
463 .format_args = "i4i4",
473 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
475 ed->thread_index = thread_index;
476 ed->duration = (int) (1000000.0 * t);
481 always_inline vlib_main_t *
482 vlib_get_worker_vlib_main (u32 worker_index)
485 vlib_thread_main_t *tm = &vlib_thread_main;
486 ASSERT (worker_index < tm->n_vlib_mains - 1);
487 vm = vlib_mains[worker_index + 1];
493 vlib_thread_is_main_w_barrier (void)
495 return (!vlib_num_workers ()
496 || ((vlib_get_thread_index () == 0
497 && vlib_worker_threads->wait_at_barrier[0])));
501 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
503 CLIB_MEMORY_BARRIER ();
507 static inline vlib_frame_queue_elt_t *
508 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
510 vlib_frame_queue_t *fq;
511 vlib_frame_queue_elt_t *elt;
512 vlib_thread_main_t *tm = &vlib_thread_main;
513 vlib_frame_queue_main_t *fqm =
514 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
517 fq = fqm->vlib_frame_queues[index];
520 new_tail = __sync_add_and_fetch (&fq->tail, 1);
522 /* Wait until a ring slot is available */
523 while (new_tail >= fq->head_hint + fq->nelts)
524 vlib_worker_thread_barrier_check ();
526 elt = fq->elts + (new_tail & (fq->nelts - 1));
528 /* this would be very bad... */
532 elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
533 elt->last_n_vectors = elt->n_vectors = 0;
538 static inline vlib_frame_queue_t *
539 is_vlib_frame_queue_congested (u32 frame_queue_index,
542 vlib_frame_queue_t **
543 handoff_queue_by_worker_index)
545 vlib_frame_queue_t *fq;
546 vlib_thread_main_t *tm = &vlib_thread_main;
547 vlib_frame_queue_main_t *fqm =
548 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
550 fq = handoff_queue_by_worker_index[index];
551 if (fq != (vlib_frame_queue_t *) (~0))
554 fq = fqm->vlib_frame_queues[index];
557 if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
559 /* a valid entry in the array will indicate the queue has reached
560 * the specified threshold and is congested
562 handoff_queue_by_worker_index[index] = fq;
563 fq->enqueue_full_events++;
570 static inline vlib_frame_queue_elt_t *
571 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
572 u32 vlib_worker_index,
573 vlib_frame_queue_elt_t **
574 handoff_queue_elt_by_worker_index)
576 vlib_frame_queue_elt_t *elt;
578 if (handoff_queue_elt_by_worker_index[vlib_worker_index])
579 return handoff_queue_elt_by_worker_index[vlib_worker_index];
581 elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
583 handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
588 u8 *vlib_thread_stack_init (uword thread_index);
589 int vlib_thread_cb_register (struct vlib_main_t *vm,
590 vlib_thread_callbacks_t * cb);
591 extern void *rpc_call_main_thread_cb_fn;
594 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
596 void vlib_rpc_call_main_thread (void *function, u8 * args, u32 size);
598 #endif /* included_vlib_threads_h */
601 * fd.io coding-style-patch-verification: ON
604 * eval: (c-set-style "gnu")