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 u8 vlib_worker_thread_barrier_held (void);
211 void vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm);
212 void vlib_worker_thread_node_refork (void);
214 * Wait until each of the workers has been once around the track
216 void vlib_worker_wait_one_loop (void);
218 static_always_inline uword
219 vlib_get_thread_index (void)
221 return __os_thread_index;
225 vlib_smp_unsafe_warning (void)
229 if (vlib_get_thread_index ())
230 fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
236 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
237 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
240 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
242 #define foreach_vlib_main(body) \
244 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
247 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
249 this_vlib_main = vlib_mains[ii]; \
251 this_vlib_main->parked_at_barrier == 1); \
252 if (this_vlib_main) \
253 vec_add1 (__vlib_mains, this_vlib_main); \
256 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
258 this_vlib_main = __vlib_mains[ii]; \
259 /* body uses this_vlib_main... */ \
262 vec_free (__vlib_mains); \
265 #define foreach_sched_policy \
266 _(SCHED_OTHER, OTHER, "other") \
267 _(SCHED_BATCH, BATCH, "batch") \
268 _(SCHED_IDLE, IDLE, "idle") \
269 _(SCHED_FIFO, FIFO, "fifo") \
270 _(SCHED_RR, RR, "rr")
274 #define _(v,f,s) SCHED_POLICY_##f = v,
282 clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
284 clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 cpu);
285 } vlib_thread_callbacks_t;
289 /* Link list of registrations, built by constructors */
290 vlib_thread_registration_t *next;
292 /* Vector of registrations, w/ non-data-structure clones at the top */
293 vlib_thread_registration_t **registrations;
295 uword *thread_registrations_by_name;
297 vlib_worker_thread_t *worker_threads;
300 * Launch all threads as pthreads,
301 * not eal_rte_launch (strict affinity) threads
305 /* Number of vlib_main / vnet_main clones */
308 /* Number of thread stacks to create */
311 /* Number of pthreads */
314 /* Number of threads */
317 /* Number of cores to skip, must match the core mask */
320 /* Thread prefix name */
323 /* main thread lcore */
326 /* Bitmap of available CPU cores */
327 uword *cpu_core_bitmap;
329 /* Bitmap of available CPU sockets (NUMA nodes) */
330 uword *cpu_socket_bitmap;
332 /* Worker handoff queues */
333 vlib_frame_queue_main_t *frame_queue_mains;
335 /* worker thread initialization barrier */
336 volatile u32 worker_thread_release;
338 /* scheduling policy */
341 /* scheduling policy priority */
345 vlib_thread_callbacks_t cb;
346 int extern_thread_mgmt;
348 /* NUMA-bound heap size */
349 uword numa_heap_size;
351 } vlib_thread_main_t;
353 extern vlib_thread_main_t vlib_thread_main;
355 #include <vlib/global_funcs.h>
357 #define VLIB_REGISTER_THREAD(x,...) \
358 __VA_ARGS__ vlib_thread_registration_t x; \
359 static void __vlib_add_thread_registration_##x (void) \
360 __attribute__((__constructor__)) ; \
361 static void __vlib_add_thread_registration_##x (void) \
363 vlib_thread_main_t * tm = &vlib_thread_main; \
367 static void __vlib_rm_thread_registration_##x (void) \
368 __attribute__((__destructor__)) ; \
369 static void __vlib_rm_thread_registration_##x (void) \
371 vlib_thread_main_t * tm = &vlib_thread_main; \
372 VLIB_REMOVE_FROM_LINKED_LIST (tm->next, &x, next); \
374 __VA_ARGS__ vlib_thread_registration_t x
379 return vlib_thread_main.n_vlib_mains - 1;
383 vlib_get_worker_thread_index (u32 worker_index)
385 return worker_index + 1;
389 vlib_get_worker_index (u32 thread_index)
391 return thread_index - 1;
395 vlib_get_current_worker_index ()
397 return vlib_get_thread_index () - 1;
401 vlib_worker_thread_barrier_check (void)
403 if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
405 vlib_main_t *vm = vlib_get_main ();
406 u32 thread_index = vm->thread_index;
407 f64 t = vlib_time_now (vm);
409 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
410 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
411 vm->clib_time.last_cpu_time, 0 /* enter */ );
413 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
415 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
417 ELOG_TYPE_DECLARE (e) = {
418 .format = "barrier-wait-thread-%d",
428 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
430 ed->thread_index = thread_index;
435 vm = vlib_get_main ();
436 vm->parked_at_barrier = 1;
438 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
439 while (*vlib_worker_threads->wait_at_barrier)
443 * Recompute the offset from thread-0 time.
444 * Note that vlib_time_now adds vm->time_offset, so
445 * clear it first. Save the resulting idea of "now", to
446 * see how well we're doing. See show_clock_command_fn(...)
450 vm->time_offset = 0.0;
451 now = vlib_time_now (vm);
452 vm->time_offset = vlib_global_main.time_last_barrier_release - now;
453 vm->time_last_barrier_release = vlib_time_now (vm);
457 vm->parked_at_barrier = 0;
458 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
460 if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
462 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
464 t = vlib_time_now (vm) - t;
465 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
467 ELOG_TYPE_DECLARE (e) = {
468 .format = "barrier-refork-thread-%d",
478 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
480 ed->thread_index = thread_index;
483 vlib_worker_thread_node_refork ();
484 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
486 while (*vlib_worker_threads->node_reforks_required)
489 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
491 t = vlib_time_now (vm) - t;
492 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
494 ELOG_TYPE_DECLARE (e) = {
495 .format = "barrier-released-thread-%d: %dus",
496 .format_args = "i4i4",
506 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
508 ed->thread_index = thread_index;
509 ed->duration = (int) (1000000.0 * t);
512 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
513 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
514 vm->clib_time.last_cpu_time, 1 /* leave */ );
518 always_inline vlib_main_t *
519 vlib_get_worker_vlib_main (u32 worker_index)
522 vlib_thread_main_t *tm = &vlib_thread_main;
523 ASSERT (worker_index < tm->n_vlib_mains - 1);
524 vm = vlib_get_main_by_index (worker_index + 1);
530 vlib_thread_is_main_w_barrier (void)
532 return (!vlib_num_workers ()
533 || ((vlib_get_thread_index () == 0
534 && vlib_worker_threads->wait_at_barrier[0])));
538 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
540 CLIB_MEMORY_BARRIER ();
544 static inline vlib_frame_queue_elt_t *
545 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
547 vlib_frame_queue_t *fq;
548 vlib_frame_queue_elt_t *elt;
549 vlib_thread_main_t *tm = &vlib_thread_main;
550 vlib_frame_queue_main_t *fqm =
551 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
554 fq = fqm->vlib_frame_queues[index];
557 new_tail = clib_atomic_add_fetch (&fq->tail, 1);
559 /* Wait until a ring slot is available */
560 while (new_tail >= fq->head_hint + fq->nelts)
561 vlib_worker_thread_barrier_check ();
563 elt = fq->elts + (new_tail & (fq->nelts - 1));
565 /* this would be very bad... */
569 elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
570 elt->last_n_vectors = elt->n_vectors = 0;
575 static inline vlib_frame_queue_t *
576 is_vlib_frame_queue_congested (u32 frame_queue_index,
579 vlib_frame_queue_t **
580 handoff_queue_by_worker_index)
582 vlib_frame_queue_t *fq;
583 vlib_thread_main_t *tm = &vlib_thread_main;
584 vlib_frame_queue_main_t *fqm =
585 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
587 fq = handoff_queue_by_worker_index[index];
588 if (fq != (vlib_frame_queue_t *) (~0))
591 fq = fqm->vlib_frame_queues[index];
594 if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
596 /* a valid entry in the array will indicate the queue has reached
597 * the specified threshold and is congested
599 handoff_queue_by_worker_index[index] = fq;
600 fq->enqueue_full_events++;
607 static inline vlib_frame_queue_elt_t *
608 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
609 u32 vlib_worker_index,
610 vlib_frame_queue_elt_t **
611 handoff_queue_elt_by_worker_index)
613 vlib_frame_queue_elt_t *elt;
615 if (handoff_queue_elt_by_worker_index[vlib_worker_index])
616 return handoff_queue_elt_by_worker_index[vlib_worker_index];
618 elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
620 handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
625 u8 *vlib_thread_stack_init (uword thread_index);
626 int vlib_thread_cb_register (struct vlib_main_t *vm,
627 vlib_thread_callbacks_t * cb);
628 extern void *rpc_call_main_thread_cb_fn;
631 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
633 void vlib_rpc_call_main_thread (void *function, u8 * args, u32 size);
634 void vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id);
635 vlib_thread_main_t *vlib_get_thread_main_not_inline (void);
637 #endif /* included_vlib_threads_h */
640 * fd.io coding-style-patch-verification: ON
643 * eval: (c-set-style "gnu")