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 <vppinfra/callback.h>
20 #include <linux/sched.h>
22 extern vlib_main_t **vlib_mains;
24 void vlib_set_thread_name (char *name);
26 /* arg is actually a vlib__thread_t * */
27 typedef void (vlib_thread_function_t) (void *arg);
29 typedef struct vlib_thread_registration_
31 /* constructor generated list of thread registrations */
32 struct vlib_thread_registration_ *next;
34 /* config parameters */
37 vlib_thread_function_t *function;
41 int no_data_structure_clone;
42 u32 frame_queue_nelts;
44 /* All threads of this type run on pthreads */
48 } vlib_thread_registration_t;
51 * Frames have their cpu / vlib_main_t index in the low-order N bits
52 * Make VLIB_MAX_CPUS a power-of-two, please...
56 #define VLIB_MAX_CPUS 256
59 #if VLIB_MAX_CPUS > CLIB_MAX_MHEAPS
60 #error Please increase number of per-cpu mheaps
63 #define VLIB_CPU_MASK (VLIB_MAX_CPUS - 1) /* 0x3f, max */
64 #define VLIB_OFFSET_MASK (~VLIB_CPU_MASK)
66 #define VLIB_LOG2_THREAD_STACK_SIZE (21)
67 #define VLIB_THREAD_STACK_SIZE (1<<VLIB_LOG2_THREAD_STACK_SIZE)
71 VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME,
72 } vlib_frame_queue_msg_type_t;
76 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
82 /* 256 * 4 = 1024 bytes, even mult of cache line size */
83 u32 buffer_index[VLIB_FRAME_SIZE];
85 vlib_frame_queue_elt_t;
89 /* First cache line */
90 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
91 volatile u32 *wait_at_barrier;
92 volatile u32 *workers_at_barrier;
94 /* Second Cache Line */
95 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
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;
106 u8 barrier_elog_enabled;
107 const char *barrier_caller;
108 const char *barrier_context;
109 volatile u32 *node_reforks_required;
116 } vlib_worker_thread_t;
118 extern vlib_worker_thread_t *vlib_worker_threads;
123 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
128 u32 enqueue_full_events;
131 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
137 u64 vector_threshold;
139 /* dequeue hint to enqueue side */
140 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
141 volatile u64 head_hint;
143 /* read-only, constant, shared */
144 CLIB_CACHE_LINE_ALIGN_MARK (cacheline3);
145 vlib_frame_queue_elt_t *elts;
152 vlib_frame_queue_elt_t **handoff_queue_elt_by_thread_index;
153 vlib_frame_queue_t **congested_handoff_queue_by_thread_index;
154 } vlib_frame_queue_per_thread_data_t;
159 u32 frame_queue_nelts;
162 vlib_frame_queue_t **vlib_frame_queues;
163 vlib_frame_queue_per_thread_data_t *per_thread_data;
165 /* for frame queue tracing */
166 frame_queue_trace_t *frame_queue_traces;
167 frame_queue_nelt_counter_t *frame_queue_histogram;
168 } vlib_frame_queue_main_t;
175 } vlib_process_signal_event_mt_args_t;
177 /* Called early, in thread 0's context */
178 clib_error_t *vlib_thread_init (vlib_main_t * vm);
180 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
181 u32 frame_queue_index, vlib_frame_t * frame,
182 vlib_frame_queue_msg_type_t type);
185 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm);
187 void vlib_worker_thread_node_runtime_update (void);
189 void vlib_create_worker_threads (vlib_main_t * vm, int n,
190 void (*thread_function) (void *));
192 void vlib_worker_thread_init (vlib_worker_thread_t * w);
193 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
195 /* Check for a barrier sync request every 30ms */
196 #define BARRIER_SYNC_DELAY (0.030000)
199 /* long barrier timeout, for gdb... */
200 #define BARRIER_SYNC_TIMEOUT (600.1)
202 #define BARRIER_SYNC_TIMEOUT (1.0)
205 #define vlib_worker_thread_barrier_sync(X) {vlib_worker_thread_barrier_sync_int(X, __FUNCTION__);}
207 void vlib_worker_thread_barrier_sync_int (vlib_main_t * vm,
208 const char *func_name);
209 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
210 void vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm);
211 void vlib_worker_thread_node_refork (void);
213 static_always_inline uword
214 vlib_get_thread_index (void)
216 return __os_thread_index;
220 vlib_smp_unsafe_warning (void)
224 if (vlib_get_thread_index ())
225 fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
231 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
232 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
235 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
237 #define foreach_vlib_main(body) \
239 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
242 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
244 this_vlib_main = vlib_mains[ii]; \
246 this_vlib_main->parked_at_barrier == 1); \
247 if (this_vlib_main) \
248 vec_add1 (__vlib_mains, this_vlib_main); \
251 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
253 this_vlib_main = __vlib_mains[ii]; \
254 /* body uses this_vlib_main... */ \
257 vec_free (__vlib_mains); \
260 #define foreach_sched_policy \
261 _(SCHED_OTHER, OTHER, "other") \
262 _(SCHED_BATCH, BATCH, "batch") \
263 _(SCHED_IDLE, IDLE, "idle") \
264 _(SCHED_FIFO, FIFO, "fifo") \
265 _(SCHED_RR, RR, "rr")
269 #define _(v,f,s) SCHED_POLICY_##f = v,
277 clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
279 clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 cpu);
280 } vlib_thread_callbacks_t;
284 /* Link list of registrations, built by constructors */
285 vlib_thread_registration_t *next;
287 /* Vector of registrations, w/ non-data-structure clones at the top */
288 vlib_thread_registration_t **registrations;
290 uword *thread_registrations_by_name;
292 vlib_worker_thread_t *worker_threads;
295 * Launch all threads as pthreads,
296 * not eal_rte_launch (strict affinity) threads
300 /* Number of vlib_main / vnet_main clones */
303 /* Number of thread stacks to create */
306 /* Number of pthreads */
309 /* Number of threads */
312 /* Number of cores to skip, must match the core mask */
315 /* Thread prefix name */
318 /* main thread lcore */
321 /* Bitmap of available CPU cores */
322 uword *cpu_core_bitmap;
324 /* Bitmap of available CPU sockets (NUMA nodes) */
325 uword *cpu_socket_bitmap;
327 /* Worker handoff queues */
328 vlib_frame_queue_main_t *frame_queue_mains;
330 /* worker thread initialization barrier */
331 volatile u32 worker_thread_release;
333 /* scheduling policy */
336 /* scheduling policy priority */
340 vlib_thread_callbacks_t cb;
341 int extern_thread_mgmt;
343 /* NUMA-bound heap size */
344 uword numa_heap_size;
346 } vlib_thread_main_t;
348 extern vlib_thread_main_t vlib_thread_main;
350 #include <vlib/global_funcs.h>
352 #define VLIB_REGISTER_THREAD(x,...) \
353 __VA_ARGS__ vlib_thread_registration_t x; \
354 static void __vlib_add_thread_registration_##x (void) \
355 __attribute__((__constructor__)) ; \
356 static void __vlib_add_thread_registration_##x (void) \
358 vlib_thread_main_t * tm = &vlib_thread_main; \
362 static void __vlib_rm_thread_registration_##x (void) \
363 __attribute__((__destructor__)) ; \
364 static void __vlib_rm_thread_registration_##x (void) \
366 vlib_thread_main_t * tm = &vlib_thread_main; \
367 VLIB_REMOVE_FROM_LINKED_LIST (tm->next, &x, next); \
369 __VA_ARGS__ vlib_thread_registration_t x
374 return vlib_thread_main.n_vlib_mains - 1;
378 vlib_get_worker_thread_index (u32 worker_index)
380 return worker_index + 1;
384 vlib_get_worker_index (u32 thread_index)
386 return thread_index - 1;
390 vlib_get_current_worker_index ()
392 return vlib_get_thread_index () - 1;
396 vlib_worker_thread_barrier_check (void)
398 if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
400 vlib_main_t *vm = vlib_get_main ();
401 u32 thread_index = vm->thread_index;
402 f64 t = vlib_time_now (vm);
404 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
405 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
406 vm->clib_time.last_cpu_time, 0 /* enter */ );
408 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
410 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
412 ELOG_TYPE_DECLARE (e) = {
413 .format = "barrier-wait-thread-%d",
423 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
425 ed->thread_index = thread_index;
430 vm = vlib_get_main ();
431 vm->parked_at_barrier = 1;
433 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
434 while (*vlib_worker_threads->wait_at_barrier)
438 * Recompute the offset from thread-0 time.
439 * Note that vlib_time_now adds vm->time_offset, so
440 * clear it first. Save the resulting idea of "now", to
441 * see how well we're doing. See show_clock_command_fn(...)
445 vm->time_offset = 0.0;
446 now = vlib_time_now (vm);
447 vm->time_offset = vlib_global_main.time_last_barrier_release - now;
448 vm->time_last_barrier_release = vlib_time_now (vm);
452 vm->parked_at_barrier = 0;
453 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
455 if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
457 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
459 t = vlib_time_now (vm) - t;
460 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
462 ELOG_TYPE_DECLARE (e) = {
463 .format = "barrier-refork-thread-%d",
473 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
475 ed->thread_index = thread_index;
478 vlib_worker_thread_node_refork ();
479 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
481 while (*vlib_worker_threads->node_reforks_required)
484 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
486 t = vlib_time_now (vm) - t;
487 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
489 ELOG_TYPE_DECLARE (e) = {
490 .format = "barrier-released-thread-%d: %dus",
491 .format_args = "i4i4",
501 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
503 ed->thread_index = thread_index;
504 ed->duration = (int) (1000000.0 * t);
507 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
508 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
509 vm->clib_time.last_cpu_time, 1 /* leave */ );
513 always_inline vlib_main_t *
514 vlib_get_worker_vlib_main (u32 worker_index)
517 vlib_thread_main_t *tm = &vlib_thread_main;
518 ASSERT (worker_index < tm->n_vlib_mains - 1);
519 vm = vlib_mains[worker_index + 1];
525 vlib_thread_is_main_w_barrier (void)
527 return (!vlib_num_workers ()
528 || ((vlib_get_thread_index () == 0
529 && vlib_worker_threads->wait_at_barrier[0])));
533 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
535 CLIB_MEMORY_BARRIER ();
539 static inline vlib_frame_queue_elt_t *
540 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
542 vlib_frame_queue_t *fq;
543 vlib_frame_queue_elt_t *elt;
544 vlib_thread_main_t *tm = &vlib_thread_main;
545 vlib_frame_queue_main_t *fqm =
546 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
549 fq = fqm->vlib_frame_queues[index];
552 new_tail = clib_atomic_add_fetch (&fq->tail, 1);
554 /* Wait until a ring slot is available */
555 while (new_tail >= fq->head_hint + fq->nelts)
556 vlib_worker_thread_barrier_check ();
558 elt = fq->elts + (new_tail & (fq->nelts - 1));
560 /* this would be very bad... */
564 elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
565 elt->last_n_vectors = elt->n_vectors = 0;
570 static inline vlib_frame_queue_t *
571 is_vlib_frame_queue_congested (u32 frame_queue_index,
574 vlib_frame_queue_t **
575 handoff_queue_by_worker_index)
577 vlib_frame_queue_t *fq;
578 vlib_thread_main_t *tm = &vlib_thread_main;
579 vlib_frame_queue_main_t *fqm =
580 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
582 fq = handoff_queue_by_worker_index[index];
583 if (fq != (vlib_frame_queue_t *) (~0))
586 fq = fqm->vlib_frame_queues[index];
589 if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
591 /* a valid entry in the array will indicate the queue has reached
592 * the specified threshold and is congested
594 handoff_queue_by_worker_index[index] = fq;
595 fq->enqueue_full_events++;
602 static inline vlib_frame_queue_elt_t *
603 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
604 u32 vlib_worker_index,
605 vlib_frame_queue_elt_t **
606 handoff_queue_elt_by_worker_index)
608 vlib_frame_queue_elt_t *elt;
610 if (handoff_queue_elt_by_worker_index[vlib_worker_index])
611 return handoff_queue_elt_by_worker_index[vlib_worker_index];
613 elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
615 handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
620 u8 *vlib_thread_stack_init (uword thread_index);
621 int vlib_thread_cb_register (struct vlib_main_t *vm,
622 vlib_thread_callbacks_t * cb);
623 extern void *rpc_call_main_thread_cb_fn;
626 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
628 void vlib_rpc_call_main_thread (void *function, u8 * args, u32 size);
629 void vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id);
632 #endif /* included_vlib_threads_h */
635 * fd.io coding-style-patch-verification: ON
638 * eval: (c-set-style "gnu")