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;
115 } vlib_worker_thread_t;
117 extern vlib_worker_thread_t *vlib_worker_threads;
122 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
127 u32 enqueue_full_events;
130 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
136 u64 vector_threshold;
138 /* dequeue hint to enqueue side */
139 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
140 volatile u64 head_hint;
142 /* read-only, constant, shared */
143 CLIB_CACHE_LINE_ALIGN_MARK (cacheline3);
144 vlib_frame_queue_elt_t *elts;
151 vlib_frame_queue_elt_t **handoff_queue_elt_by_thread_index;
152 vlib_frame_queue_t **congested_handoff_queue_by_thread_index;
153 } vlib_frame_queue_per_thread_data_t;
158 u32 frame_queue_nelts;
161 vlib_frame_queue_t **vlib_frame_queues;
162 vlib_frame_queue_per_thread_data_t *per_thread_data;
164 /* for frame queue tracing */
165 frame_queue_trace_t *frame_queue_traces;
166 frame_queue_nelt_counter_t *frame_queue_histogram;
167 } vlib_frame_queue_main_t;
174 } vlib_process_signal_event_mt_args_t;
176 /* Called early, in thread 0's context */
177 clib_error_t *vlib_thread_init (vlib_main_t * vm);
179 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
180 u32 frame_queue_index, vlib_frame_t * frame,
181 vlib_frame_queue_msg_type_t type);
184 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm);
186 void vlib_worker_thread_node_runtime_update (void);
188 void vlib_create_worker_threads (vlib_main_t * vm, int n,
189 void (*thread_function) (void *));
191 void vlib_worker_thread_init (vlib_worker_thread_t * w);
192 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
194 /* Check for a barrier sync request every 30ms */
195 #define BARRIER_SYNC_DELAY (0.030000)
198 /* long barrier timeout, for gdb... */
199 #define BARRIER_SYNC_TIMEOUT (600.1)
201 #define BARRIER_SYNC_TIMEOUT (1.0)
204 #define vlib_worker_thread_barrier_sync(X) {vlib_worker_thread_barrier_sync_int(X, __FUNCTION__);}
206 void vlib_worker_thread_barrier_sync_int (vlib_main_t * vm,
207 const char *func_name);
208 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
209 void vlib_worker_thread_node_refork (void);
211 static_always_inline uword
212 vlib_get_thread_index (void)
214 return __os_thread_index;
218 vlib_smp_unsafe_warning (void)
222 if (vlib_get_thread_index ())
223 fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
229 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
230 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
233 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
235 #define foreach_vlib_main(body) \
237 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
240 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
242 this_vlib_main = vlib_mains[ii]; \
244 this_vlib_main->parked_at_barrier == 1); \
245 if (this_vlib_main) \
246 vec_add1 (__vlib_mains, this_vlib_main); \
249 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
251 this_vlib_main = __vlib_mains[ii]; \
252 /* body uses this_vlib_main... */ \
255 vec_free (__vlib_mains); \
258 #define foreach_sched_policy \
259 _(SCHED_OTHER, OTHER, "other") \
260 _(SCHED_BATCH, BATCH, "batch") \
261 _(SCHED_IDLE, IDLE, "idle") \
262 _(SCHED_FIFO, FIFO, "fifo") \
263 _(SCHED_RR, RR, "rr")
267 #define _(v,f,s) SCHED_POLICY_##f = v,
275 clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
277 clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 cpu);
278 } vlib_thread_callbacks_t;
282 /* Link list of registrations, built by constructors */
283 vlib_thread_registration_t *next;
285 /* Vector of registrations, w/ non-data-structure clones at the top */
286 vlib_thread_registration_t **registrations;
288 uword *thread_registrations_by_name;
290 vlib_worker_thread_t *worker_threads;
293 * Launch all threads as pthreads,
294 * not eal_rte_launch (strict affinity) threads
298 /* Number of vlib_main / vnet_main clones */
301 /* Number of thread stacks to create */
304 /* Number of pthreads */
307 /* Number of threads */
310 /* Number of cores to skip, must match the core mask */
313 /* Thread prefix name */
316 /* main thread lcore */
319 /* Bitmap of available CPU cores */
320 uword *cpu_core_bitmap;
322 /* Bitmap of available CPU sockets (NUMA nodes) */
323 uword *cpu_socket_bitmap;
325 /* Worker handoff queues */
326 vlib_frame_queue_main_t *frame_queue_mains;
328 /* worker thread initialization barrier */
329 volatile u32 worker_thread_release;
331 /* scheduling policy */
334 /* scheduling policy priority */
338 vlib_thread_callbacks_t cb;
339 int extern_thread_mgmt;
340 } vlib_thread_main_t;
342 extern vlib_thread_main_t vlib_thread_main;
344 #include <vlib/global_funcs.h>
346 #define VLIB_REGISTER_THREAD(x,...) \
347 __VA_ARGS__ vlib_thread_registration_t x; \
348 static void __vlib_add_thread_registration_##x (void) \
349 __attribute__((__constructor__)) ; \
350 static void __vlib_add_thread_registration_##x (void) \
352 vlib_thread_main_t * tm = &vlib_thread_main; \
356 static void __vlib_rm_thread_registration_##x (void) \
357 __attribute__((__destructor__)) ; \
358 static void __vlib_rm_thread_registration_##x (void) \
360 vlib_thread_main_t * tm = &vlib_thread_main; \
361 VLIB_REMOVE_FROM_LINKED_LIST (tm->next, &x, next); \
363 __VA_ARGS__ vlib_thread_registration_t x
368 return vlib_thread_main.n_vlib_mains - 1;
372 vlib_get_worker_thread_index (u32 worker_index)
374 return worker_index + 1;
378 vlib_get_worker_index (u32 thread_index)
380 return thread_index - 1;
384 vlib_get_current_worker_index ()
386 return vlib_get_thread_index () - 1;
390 vlib_worker_thread_barrier_check (void)
392 if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
394 vlib_main_t *vm = vlib_get_main ();
395 u32 thread_index = vm->thread_index;
396 f64 t = vlib_time_now (vm);
398 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
400 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
402 ELOG_TYPE_DECLARE (e) = {
403 .format = "barrier-wait-thread-%d",
413 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
415 ed->thread_index = thread_index;
418 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
421 vm = vlib_get_main ();
422 vm->parked_at_barrier = 1;
424 while (*vlib_worker_threads->wait_at_barrier)
428 * Recompute the offset from thread-0 time.
429 * Note that vlib_time_now adds vm->time_offset, so
430 * clear it first. Save the resulting idea of "now", to
431 * see how well we're doing. See show_clock_command_fn(...)
435 vm->time_offset = 0.0;
436 now = vlib_time_now (vm);
437 vm->time_offset = vlib_global_main.time_last_barrier_release - now;
438 vm->time_last_barrier_release = vlib_time_now (vm);
442 vm->parked_at_barrier = 0;
443 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
445 if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
447 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
449 t = vlib_time_now (vm) - t;
450 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
452 ELOG_TYPE_DECLARE (e) = {
453 .format = "barrier-refork-thread-%d",
463 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
465 ed->thread_index = thread_index;
468 vlib_worker_thread_node_refork ();
469 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
471 while (*vlib_worker_threads->node_reforks_required)
474 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
476 t = vlib_time_now (vm) - t;
477 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
479 ELOG_TYPE_DECLARE (e) = {
480 .format = "barrier-released-thread-%d: %dus",
481 .format_args = "i4i4",
491 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
493 ed->thread_index = thread_index;
494 ed->duration = (int) (1000000.0 * t);
499 always_inline vlib_main_t *
500 vlib_get_worker_vlib_main (u32 worker_index)
503 vlib_thread_main_t *tm = &vlib_thread_main;
504 ASSERT (worker_index < tm->n_vlib_mains - 1);
505 vm = vlib_mains[worker_index + 1];
511 vlib_thread_is_main_w_barrier (void)
513 return (!vlib_num_workers ()
514 || ((vlib_get_thread_index () == 0
515 && vlib_worker_threads->wait_at_barrier[0])));
519 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
521 CLIB_MEMORY_BARRIER ();
525 static inline vlib_frame_queue_elt_t *
526 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
528 vlib_frame_queue_t *fq;
529 vlib_frame_queue_elt_t *elt;
530 vlib_thread_main_t *tm = &vlib_thread_main;
531 vlib_frame_queue_main_t *fqm =
532 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
535 fq = fqm->vlib_frame_queues[index];
538 new_tail = clib_atomic_add_fetch (&fq->tail, 1);
540 /* Wait until a ring slot is available */
541 while (new_tail >= fq->head_hint + fq->nelts)
542 vlib_worker_thread_barrier_check ();
544 elt = fq->elts + (new_tail & (fq->nelts - 1));
546 /* this would be very bad... */
550 elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
551 elt->last_n_vectors = elt->n_vectors = 0;
556 static inline vlib_frame_queue_t *
557 is_vlib_frame_queue_congested (u32 frame_queue_index,
560 vlib_frame_queue_t **
561 handoff_queue_by_worker_index)
563 vlib_frame_queue_t *fq;
564 vlib_thread_main_t *tm = &vlib_thread_main;
565 vlib_frame_queue_main_t *fqm =
566 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
568 fq = handoff_queue_by_worker_index[index];
569 if (fq != (vlib_frame_queue_t *) (~0))
572 fq = fqm->vlib_frame_queues[index];
575 if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
577 /* a valid entry in the array will indicate the queue has reached
578 * the specified threshold and is congested
580 handoff_queue_by_worker_index[index] = fq;
581 fq->enqueue_full_events++;
588 static inline vlib_frame_queue_elt_t *
589 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
590 u32 vlib_worker_index,
591 vlib_frame_queue_elt_t **
592 handoff_queue_elt_by_worker_index)
594 vlib_frame_queue_elt_t *elt;
596 if (handoff_queue_elt_by_worker_index[vlib_worker_index])
597 return handoff_queue_elt_by_worker_index[vlib_worker_index];
599 elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
601 handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
606 u8 *vlib_thread_stack_init (uword thread_index);
607 int vlib_thread_cb_register (struct vlib_main_t *vm,
608 vlib_thread_callbacks_t * cb);
609 extern void *rpc_call_main_thread_cb_fn;
612 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
614 void vlib_rpc_call_main_thread (void *function, u8 * args, u32 size);
616 u32 elog_global_id_for_msg_name (const char *msg_name);
617 #endif /* included_vlib_threads_h */
620 * fd.io coding-style-patch-verification: ON
623 * eval: (c-set-style "gnu")