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;
109 } vlib_worker_thread_t;
111 extern vlib_worker_thread_t *vlib_worker_threads;
116 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
121 u32 enqueue_full_events;
124 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
130 u64 vector_threshold;
132 /* dequeue hint to enqueue side */
133 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
134 volatile u64 head_hint;
136 /* read-only, constant, shared */
137 CLIB_CACHE_LINE_ALIGN_MARK (cacheline3);
138 vlib_frame_queue_elt_t *elts;
146 vlib_frame_queue_t **vlib_frame_queues;
148 /* for frame queue tracing */
149 frame_queue_trace_t *frame_queue_traces;
150 frame_queue_nelt_counter_t *frame_queue_histogram;
151 } vlib_frame_queue_main_t;
153 /* Called early, in thread 0's context */
154 clib_error_t *vlib_thread_init (vlib_main_t * vm);
156 int vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
157 u32 frame_queue_index, vlib_frame_t * frame,
158 vlib_frame_queue_msg_type_t type);
161 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm);
163 void vlib_worker_thread_node_runtime_update (void);
165 void vlib_create_worker_threads (vlib_main_t * vm, int n,
166 void (*thread_function) (void *));
168 void vlib_worker_thread_init (vlib_worker_thread_t * w);
169 u32 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts);
171 /* Check for a barrier sync request every 30ms */
172 #define BARRIER_SYNC_DELAY (0.030000)
175 /* long barrier timeout, for gdb... */
176 #define BARRIER_SYNC_TIMEOUT (600.1)
178 #define BARRIER_SYNC_TIMEOUT (1.0)
181 void vlib_worker_thread_barrier_sync (vlib_main_t * vm);
182 void vlib_worker_thread_barrier_release (vlib_main_t * vm);
184 static_always_inline uword
185 vlib_get_thread_index (void)
187 return __os_thread_index;
191 vlib_smp_unsafe_warning (void)
195 if (vlib_get_thread_index ())
196 fformat (stderr, "%s: SMP unsafe warning...\n", __FUNCTION__);
202 VLIB_WORKER_THREAD_FORK_FIXUP_ILLEGAL = 0,
203 VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX,
206 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which);
208 #define foreach_vlib_main(body) \
210 vlib_main_t ** __vlib_mains = 0, *this_vlib_main; \
213 for (ii = 0; ii < vec_len (vlib_mains); ii++) \
215 this_vlib_main = vlib_mains[ii]; \
217 this_vlib_main->parked_at_barrier == 1); \
218 if (this_vlib_main) \
219 vec_add1 (__vlib_mains, this_vlib_main); \
222 for (ii = 0; ii < vec_len (__vlib_mains); ii++) \
224 this_vlib_main = __vlib_mains[ii]; \
225 /* body uses this_vlib_main... */ \
228 vec_free (__vlib_mains); \
231 #define foreach_sched_policy \
232 _(SCHED_OTHER, OTHER, "other") \
233 _(SCHED_BATCH, BATCH, "batch") \
234 _(SCHED_IDLE, IDLE, "idle") \
235 _(SCHED_FIFO, FIFO, "fifo") \
236 _(SCHED_RR, RR, "rr")
240 #define _(v,f,s) SCHED_POLICY_##f = v,
248 clib_error_t *(*vlib_launch_thread_cb) (void *fp, vlib_worker_thread_t * w,
250 clib_error_t *(*vlib_thread_set_lcore_cb) (u32 thread, u16 lcore);
251 } vlib_thread_callbacks_t;
255 /* Link list of registrations, built by constructors */
256 vlib_thread_registration_t *next;
258 /* Vector of registrations, w/ non-data-structure clones at the top */
259 vlib_thread_registration_t **registrations;
261 uword *thread_registrations_by_name;
263 vlib_worker_thread_t *worker_threads;
266 * Launch all threads as pthreads,
267 * not eal_rte_launch (strict affinity) threads
271 /* Number of vlib_main / vnet_main clones */
274 /* Number of thread stacks to create */
277 /* Number of pthreads */
280 /* Number of threads */
283 /* Number of cores to skip, must match the core mask */
286 /* Thread prefix name */
289 /* main thread lcore */
292 /* Bitmap of available CPU cores */
293 uword *cpu_core_bitmap;
295 /* Bitmap of available CPU sockets (NUMA nodes) */
296 uword *cpu_socket_bitmap;
298 /* Worker handoff queues */
299 vlib_frame_queue_main_t *frame_queue_mains;
301 /* worker thread initialization barrier */
302 volatile u32 worker_thread_release;
304 /* scheduling policy */
307 /* scheduling policy priority */
311 vlib_thread_callbacks_t cb;
312 int extern_thread_mgmt;
313 } vlib_thread_main_t;
315 extern vlib_thread_main_t vlib_thread_main;
317 #include <vlib/global_funcs.h>
319 #define VLIB_REGISTER_THREAD(x,...) \
320 __VA_ARGS__ vlib_thread_registration_t x; \
321 static void __vlib_add_thread_registration_##x (void) \
322 __attribute__((__constructor__)) ; \
323 static void __vlib_add_thread_registration_##x (void) \
325 vlib_thread_main_t * tm = &vlib_thread_main; \
329 __VA_ARGS__ vlib_thread_registration_t x
334 return vlib_thread_main.n_vlib_mains - 1;
338 vlib_get_worker_thread_index (u32 worker_index)
340 return worker_index + 1;
344 vlib_get_worker_index (u32 thread_index)
346 return thread_index - 1;
350 vlib_get_current_worker_index ()
352 return vlib_get_thread_index () - 1;
356 vlib_worker_thread_barrier_check (void)
358 if (PREDICT_FALSE (*vlib_worker_threads->wait_at_barrier))
361 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
364 vm = vlib_get_main ();
365 vm->parked_at_barrier = 1;
367 while (*vlib_worker_threads->wait_at_barrier)
370 vm->parked_at_barrier = 0;
371 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
375 always_inline vlib_main_t *
376 vlib_get_worker_vlib_main (u32 worker_index)
379 vlib_thread_main_t *tm = &vlib_thread_main;
380 ASSERT (worker_index < tm->n_vlib_mains - 1);
381 vm = vlib_mains[worker_index + 1];
387 vlib_put_frame_queue_elt (vlib_frame_queue_elt_t * hf)
389 CLIB_MEMORY_BARRIER ();
393 static inline vlib_frame_queue_elt_t *
394 vlib_get_frame_queue_elt (u32 frame_queue_index, u32 index)
396 vlib_frame_queue_t *fq;
397 vlib_frame_queue_elt_t *elt;
398 vlib_thread_main_t *tm = &vlib_thread_main;
399 vlib_frame_queue_main_t *fqm =
400 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
403 fq = fqm->vlib_frame_queues[index];
406 new_tail = __sync_add_and_fetch (&fq->tail, 1);
408 /* Wait until a ring slot is available */
409 while (new_tail >= fq->head_hint + fq->nelts)
410 vlib_worker_thread_barrier_check ();
412 elt = fq->elts + (new_tail & (fq->nelts - 1));
414 /* this would be very bad... */
418 elt->msg_type = VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME;
419 elt->last_n_vectors = elt->n_vectors = 0;
424 static inline vlib_frame_queue_t *
425 is_vlib_frame_queue_congested (u32 frame_queue_index,
428 vlib_frame_queue_t **
429 handoff_queue_by_worker_index)
431 vlib_frame_queue_t *fq;
432 vlib_thread_main_t *tm = &vlib_thread_main;
433 vlib_frame_queue_main_t *fqm =
434 vec_elt_at_index (tm->frame_queue_mains, frame_queue_index);
436 fq = handoff_queue_by_worker_index[index];
437 if (fq != (vlib_frame_queue_t *) (~0))
440 fq = fqm->vlib_frame_queues[index];
443 if (PREDICT_FALSE (fq->tail >= (fq->head_hint + queue_hi_thresh)))
445 /* a valid entry in the array will indicate the queue has reached
446 * the specified threshold and is congested
448 handoff_queue_by_worker_index[index] = fq;
449 fq->enqueue_full_events++;
456 static inline vlib_frame_queue_elt_t *
457 vlib_get_worker_handoff_queue_elt (u32 frame_queue_index,
458 u32 vlib_worker_index,
459 vlib_frame_queue_elt_t **
460 handoff_queue_elt_by_worker_index)
462 vlib_frame_queue_elt_t *elt;
464 if (handoff_queue_elt_by_worker_index[vlib_worker_index])
465 return handoff_queue_elt_by_worker_index[vlib_worker_index];
467 elt = vlib_get_frame_queue_elt (frame_queue_index, vlib_worker_index);
469 handoff_queue_elt_by_worker_index[vlib_worker_index] = elt;
474 u8 *vlib_thread_stack_init (uword thread_index);
476 int vlib_thread_cb_register (struct vlib_main_t *vm,
477 vlib_thread_callbacks_t * cb);
479 #endif /* included_vlib_threads_h */
482 * fd.io coding-style-patch-verification: ON
485 * eval: (c-set-style "gnu")