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_threads[0].barrier_caller=__FUNCTION__;vlib_worker_thread_barrier_sync_int(X);}
206 void vlib_worker_thread_barrier_sync_int (vlib_main_t * vm);
207 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
208 void vlib_worker_thread_node_refork (void);
210 static_always_inline uword
211 vlib_get_thread_index (void)
213 return __os_thread_index;
217 vlib_smp_unsafe_warning (void)
221 if (vlib_get_thread_index ())
222 fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
228 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
229 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
232 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
234 #define foreach_vlib_main(body) \
236 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
239 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
241 this_vlib_main = vlib_mains[ii]; \
243 this_vlib_main->parked_at_barrier == 1); \
244 if (this_vlib_main) \
245 vec_add1 (__vlib_mains, this_vlib_main); \
248 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
250 this_vlib_main = __vlib_mains[ii]; \
251 /* body uses this_vlib_main... */ \
254 vec_free (__vlib_mains); \
257 #define foreach_sched_policy \
258 _(SCHED_OTHER, OTHER, "other") \
259 _(SCHED_BATCH, BATCH, "batch") \
260 _(SCHED_IDLE, IDLE, "idle") \
261 _(SCHED_FIFO, FIFO, "fifo") \
262 _(SCHED_RR, RR, "rr")
266 #define _(v,f,s) SCHED_POLICY_##f = v,
274 clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
276 clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 cpu);
277 } vlib_thread_callbacks_t;
281 /* Link list of registrations, built by constructors */
282 vlib_thread_registration_t *next;
284 /* Vector of registrations, w/ non-data-structure clones at the top */
285 vlib_thread_registration_t **registrations;
287 uword *thread_registrations_by_name;
289 vlib_worker_thread_t *worker_threads;
292 * Launch all threads as pthreads,
293 * not eal_rte_launch (strict affinity) threads
297 /* Number of vlib_main / vnet_main clones */
300 /* Number of thread stacks to create */
303 /* Number of pthreads */
306 /* Number of threads */
309 /* Number of cores to skip, must match the core mask */
312 /* Thread prefix name */
315 /* main thread lcore */
318 /* Bitmap of available CPU cores */
319 uword *cpu_core_bitmap;
321 /* Bitmap of available CPU sockets (NUMA nodes) */
322 uword *cpu_socket_bitmap;
324 /* Worker handoff queues */
325 vlib_frame_queue_main_t *frame_queue_mains;
327 /* worker thread initialization barrier */
328 volatile u32 worker_thread_release;
330 /* scheduling policy */
333 /* scheduling policy priority */
337 vlib_thread_callbacks_t cb;
338 int extern_thread_mgmt;
339 } vlib_thread_main_t;
341 extern vlib_thread_main_t vlib_thread_main;
343 #include <vlib/global_funcs.h>
345 #define VLIB_REGISTER_THREAD(x,...) \
346 __VA_ARGS__ vlib_thread_registration_t x; \
347 static void __vlib_add_thread_registration_##x (void) \
348 __attribute__((__constructor__)) ; \
349 static void __vlib_add_thread_registration_##x (void) \
351 vlib_thread_main_t * tm = &vlib_thread_main; \
355 static void __vlib_rm_thread_registration_##x (void) \
356 __attribute__((__destructor__)) ; \
357 static void __vlib_rm_thread_registration_##x (void) \
359 vlib_thread_main_t * tm = &vlib_thread_main; \
360 VLIB_REMOVE_FROM_LINKED_LIST (tm->next, &x, next); \
362 __VA_ARGS__ vlib_thread_registration_t x
367 return vlib_thread_main.n_vlib_mains - 1;
371 vlib_get_worker_thread_index (u32 worker_index)
373 return worker_index + 1;
377 vlib_get_worker_index (u32 thread_index)
379 return thread_index - 1;
383 vlib_get_current_worker_index ()
385 return vlib_get_thread_index () - 1;
389 vlib_worker_thread_barrier_check (void)
391 if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
393 vlib_main_t *vm = vlib_get_main ();
394 u32 thread_index = vm->thread_index;
395 f64 t = vlib_time_now (vm);
397 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
399 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
401 ELOG_TYPE_DECLARE (e) = {
402 .format = "barrier-wait-thread-%d",
412 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
414 ed->thread_index = thread_index;
417 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
420 vm = vlib_get_main ();
421 vm->parked_at_barrier = 1;
423 while (*vlib_worker_threads->wait_at_barrier)
426 vm->parked_at_barrier = 0;
427 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
429 if (PREDICT_FALSE (*vlib_worker_threads->node_reforks_required))
431 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
433 t = vlib_time_now (vm) - t;
434 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
436 ELOG_TYPE_DECLARE (e) = {
437 .format = "barrier-refork-thread-%d",
447 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
449 ed->thread_index = thread_index;
452 vlib_worker_thread_node_refork ();
453 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
455 while (*vlib_worker_threads->node_reforks_required)
458 if (PREDICT_FALSE (vlib_worker_threads->barrier_elog_enabled))
460 t = vlib_time_now (vm) - t;
461 vlib_worker_thread_t *w = vlib_worker_threads + thread_index;
463 ELOG_TYPE_DECLARE (e) = {
464 .format = "barrier-released-thread-%d: %dus",
465 .format_args = "i4i4",
475 ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e,
477 ed->thread_index = thread_index;
478 ed->duration = (int) (1000000.0 * t);
483 always_inline vlib_main_t *
484 vlib_get_worker_vlib_main (u32 worker_index)
487 vlib_thread_main_t *tm = &vlib_thread_main;
488 ASSERT (worker_index < tm->n_vlib_mains - 1);
489 vm = vlib_mains[worker_index + 1];
495 vlib_thread_is_main_w_barrier (void)
497 return (!vlib_num_workers ()
498 || ((vlib_get_thread_index () == 0
499 && vlib_worker_threads->wait_at_barrier[0])));
503 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
505 CLIB_MEMORY_BARRIER ();
509 static inline vlib_frame_queue_elt_t *
510 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
512 vlib_frame_queue_t *fq;
513 vlib_frame_queue_elt_t *elt;
514 vlib_thread_main_t *tm = &vlib_thread_main;
515 vlib_frame_queue_main_t *fqm =
516 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
519 fq = fqm->vlib_frame_queues[index];
522 new_tail = clib_atomic_add_fetch (&fq->tail, 1);
524 /* Wait until a ring slot is available */
525 while (new_tail >= fq->head_hint + fq->nelts)
526 vlib_worker_thread_barrier_check ();
528 elt = fq->elts + (new_tail & (fq->nelts - 1));
530 /* this would be very bad... */
534 elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
535 elt->last_n_vectors = elt->n_vectors = 0;
540 static inline vlib_frame_queue_t *
541 is_vlib_frame_queue_congested (u32 frame_queue_index,
544 vlib_frame_queue_t **
545 handoff_queue_by_worker_index)
547 vlib_frame_queue_t *fq;
548 vlib_thread_main_t *tm = &vlib_thread_main;
549 vlib_frame_queue_main_t *fqm =
550 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
552 fq = handoff_queue_by_worker_index[index];
553 if (fq != (vlib_frame_queue_t *) (~0))
556 fq = fqm->vlib_frame_queues[index];
559 if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
561 /* a valid entry in the array will indicate the queue has reached
562 * the specified threshold and is congested
564 handoff_queue_by_worker_index[index] = fq;
565 fq->enqueue_full_events++;
572 static inline vlib_frame_queue_elt_t *
573 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
574 u32 vlib_worker_index,
575 vlib_frame_queue_elt_t **
576 handoff_queue_elt_by_worker_index)
578 vlib_frame_queue_elt_t *elt;
580 if (handoff_queue_elt_by_worker_index[vlib_worker_index])
581 return handoff_queue_elt_by_worker_index[vlib_worker_index];
583 elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
585 handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
590 u8 *vlib_thread_stack_init (uword thread_index);
591 int vlib_thread_cb_register (struct vlib_main_t *vm,
592 vlib_thread_callbacks_t * cb);
593 extern void *rpc_call_main_thread_cb_fn;
596 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
598 void vlib_rpc_call_main_thread (void *function, u8 * args, u32 size);
600 u32 elog_global_id_for_msg_name (const char *msg_name);
601 #endif /* included_vlib_threads_h */
604 * fd.io coding-style-patch-verification: ON
607 * eval: (c-set-style "gnu")