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.
19 #include <vppinfra/format.h>
20 #include <vppinfra/time_range.h>
21 #include <vppinfra/interrupt.h>
22 #include <vppinfra/linux/sysfs.h>
23 #include <vlib/vlib.h>
25 #include <vlib/threads.h>
27 #include <vlib/stat_weak_inlines.h>
35 vlib_worker_thread_t *vlib_worker_threads;
36 vlib_thread_main_t vlib_thread_main;
39 * Barrier tracing can be enabled on a normal build to collect information
40 * on barrier use, including timings and call stacks. Deliberately not
41 * keyed off CLIB_DEBUG, because that can add significant overhead which
42 * imapacts observed timings.
46 barrier_trace_sync (f64 t_entry, f64 t_open, f64 t_closed)
48 if (!vlib_worker_threads->barrier_elog_enabled)
51 ELOG_TYPE_DECLARE (e) = {
52 .format = "bar-trace-%s-#%d",
53 .format_args = "T4i4",
58 u32 caller, count, t_entry, t_open, t_closed;
61 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
62 ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
63 ed->caller = elog_string (&vlib_global_main.elog_main,
64 (char *) vlib_worker_threads[0].barrier_caller);
65 ed->t_entry = (int) (1000000.0 * t_entry);
66 ed->t_open = (int) (1000000.0 * t_open);
67 ed->t_closed = (int) (1000000.0 * t_closed);
71 barrier_trace_sync_rec (f64 t_entry)
73 if (!vlib_worker_threads->barrier_elog_enabled)
76 ELOG_TYPE_DECLARE (e) = {
77 .format = "bar-syncrec-%s-#%d",
78 .format_args = "T4i4",
86 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
87 ed->depth = (int) vlib_worker_threads[0].recursion_level - 1;
88 ed->caller = elog_string (&vlib_global_main.elog_main,
89 (char *) vlib_worker_threads[0].barrier_caller);
93 barrier_trace_release_rec (f64 t_entry)
95 if (!vlib_worker_threads->barrier_elog_enabled)
98 ELOG_TYPE_DECLARE (e) = {
99 .format = "bar-relrrec-#%d",
108 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
109 ed->depth = (int) vlib_worker_threads[0].recursion_level;
113 barrier_trace_release (f64 t_entry, f64 t_closed_total, f64 t_update_main)
115 if (!vlib_worker_threads->barrier_elog_enabled)
118 ELOG_TYPE_DECLARE (e) = {
119 .format = "bar-rel-#%d-e%d-u%d-t%d",
120 .format_args = "i4i4i4i4",
125 u32 count, t_entry, t_update_main, t_closed_total;
128 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
129 ed->t_entry = (int) (1000000.0 * t_entry);
130 ed->t_update_main = (int) (1000000.0 * t_update_main);
131 ed->t_closed_total = (int) (1000000.0 * t_closed_total);
132 ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
134 /* Reset context for next trace */
135 vlib_worker_threads[0].barrier_context = NULL;
139 os_get_nthreads (void)
141 return vec_len (vlib_thread_stacks);
145 vlib_set_thread_name (char *name)
147 int pthread_setname_np (pthread_t __target_thread, const char *__name);
149 pthread_t thread = pthread_self ();
153 rv = pthread_setname_np (thread, name);
155 clib_warning ("pthread_setname_np returned %d", rv);
160 sort_registrations_by_no_clone (void *a0, void *a1)
162 vlib_thread_registration_t **tr0 = a0;
163 vlib_thread_registration_t **tr1 = a1;
165 return ((i32) ((*tr0)->no_data_structure_clone)
166 - ((i32) ((*tr1)->no_data_structure_clone)));
170 clib_sysfs_list_to_bitmap (char *filename)
175 fp = fopen (filename, "r");
180 vec_validate (buffer, 256 - 1);
181 if (fgets ((char *) buffer, 256, fp))
184 unformat_init_string (&in, (char *) buffer,
185 strlen ((char *) buffer));
186 if (unformat (&in, "%U", unformat_bitmap_list, &r) != 1)
187 clib_warning ("unformat_bitmap_list failed");
197 /* Called early in the init sequence */
200 vlib_thread_init (vlib_main_t * vm)
202 vlib_thread_main_t *tm = &vlib_thread_main;
203 vlib_worker_thread_t *w;
204 vlib_thread_registration_t *tr;
205 u32 n_vlib_mains = 1;
210 /* get bitmaps of active cpu cores and sockets */
211 tm->cpu_core_bitmap =
212 clib_sysfs_list_to_bitmap ("/sys/devices/system/cpu/online");
213 tm->cpu_socket_bitmap =
214 clib_sysfs_list_to_bitmap ("/sys/devices/system/node/online");
216 avail_cpu = clib_bitmap_dup (tm->cpu_core_bitmap);
219 for (i = 0; i < tm->skip_cores; i++)
221 uword c = clib_bitmap_first_set (avail_cpu);
223 return clib_error_return (0, "no available cpus to skip");
225 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
228 /* grab cpu for main thread */
229 if (tm->main_lcore == ~0)
231 /* if main-lcore is not set, we try to use lcore 1 */
232 if (clib_bitmap_get (avail_cpu, 1))
235 tm->main_lcore = clib_bitmap_first_set (avail_cpu);
236 if (tm->main_lcore == (u8) ~ 0)
237 return clib_error_return (0, "no available cpus to be used for the"
242 if (clib_bitmap_get (avail_cpu, tm->main_lcore) == 0)
243 return clib_error_return (0, "cpu %u is not available to be used"
244 " for the main thread", tm->main_lcore);
246 avail_cpu = clib_bitmap_set (avail_cpu, tm->main_lcore, 0);
248 /* assume that there is socket 0 only if there is no data from sysfs */
249 if (!tm->cpu_socket_bitmap)
250 tm->cpu_socket_bitmap = clib_bitmap_set (0, 0, 1);
252 /* pin main thread to main_lcore */
253 if (tm->cb.vlib_thread_set_lcore_cb)
255 tm->cb.vlib_thread_set_lcore_cb (0, tm->main_lcore);
261 CPU_SET (tm->main_lcore, &cpuset);
262 pthread_setaffinity_np (pthread_self (), sizeof (cpu_set_t), &cpuset);
265 /* Set up thread 0 */
266 vec_validate_aligned (vlib_worker_threads, 0, CLIB_CACHE_LINE_BYTES);
267 _vec_len (vlib_worker_threads) = 1;
268 w = vlib_worker_threads;
269 w->thread_mheap = clib_mem_get_heap ();
270 w->thread_stack = vlib_thread_stacks[0];
271 w->cpu_id = tm->main_lcore;
272 w->lwp = syscall (SYS_gettid);
273 w->thread_id = pthread_self ();
274 tm->n_vlib_mains = 1;
276 vlib_get_thread_core_numa (w, w->cpu_id);
278 if (tm->sched_policy != ~0)
280 struct sched_param sched_param;
281 if (!sched_getparam (w->lwp, &sched_param))
283 if (tm->sched_priority != ~0)
284 sched_param.sched_priority = tm->sched_priority;
285 sched_setscheduler (w->lwp, tm->sched_policy, &sched_param);
289 /* assign threads to cores and set n_vlib_mains */
294 vec_add1 (tm->registrations, tr);
298 vec_sort_with_function (tm->registrations, sort_registrations_by_no_clone);
300 for (i = 0; i < vec_len (tm->registrations); i++)
303 tr = tm->registrations[i];
304 tr->first_index = first_index;
305 first_index += tr->count;
306 n_vlib_mains += (tr->no_data_structure_clone == 0) ? tr->count : 0;
308 /* construct coremask */
309 if (tr->use_pthreads || !tr->count)
316 clib_bitmap_foreach (c, tr->coremask) {
317 if (clib_bitmap_get(avail_cpu, c) == 0)
318 return clib_error_return (0, "cpu %u is not available to be used"
319 " for the '%s' thread",c, tr->name);
321 avail_cpu = clib_bitmap_set(avail_cpu, c, 0);
327 for (j = 0; j < tr->count; j++)
329 /* Do not use CPU 0 by default - leave it to the host and IRQs */
330 uword avail_c0 = clib_bitmap_get (avail_cpu, 0);
331 avail_cpu = clib_bitmap_set (avail_cpu, 0, 0);
333 uword c = clib_bitmap_first_set (avail_cpu);
334 /* Use CPU 0 as a last resort */
335 if (c == ~0 && avail_c0)
342 return clib_error_return (0,
343 "no available cpus to be used for"
344 " the '%s' thread", tr->name);
346 avail_cpu = clib_bitmap_set (avail_cpu, 0, avail_c0);
347 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
348 tr->coremask = clib_bitmap_set (tr->coremask, c, 1);
353 clib_bitmap_free (avail_cpu);
355 tm->n_vlib_mains = n_vlib_mains;
358 * Allocate the remaining worker threads, and thread stack vector slots
359 * from now on, calls to os_get_nthreads() will return the correct
362 vec_validate_aligned (vlib_worker_threads, first_index - 1,
363 CLIB_CACHE_LINE_BYTES);
364 vec_validate (vlib_thread_stacks, vec_len (vlib_worker_threads) - 1);
369 vlib_frame_queue_alloc (int nelts)
371 vlib_frame_queue_t *fq;
373 fq = clib_mem_alloc_aligned (sizeof (*fq), CLIB_CACHE_LINE_BYTES);
374 clib_memset (fq, 0, sizeof (*fq));
376 fq->vector_threshold = 128; // packets
377 vec_validate_aligned (fq->elts, nelts - 1, CLIB_CACHE_LINE_BYTES);
381 if (((uword) & fq->tail) & (CLIB_CACHE_LINE_BYTES - 1))
382 fformat (stderr, "WARNING: fq->tail unaligned\n");
383 if (((uword) & fq->head) & (CLIB_CACHE_LINE_BYTES - 1))
384 fformat (stderr, "WARNING: fq->head unaligned\n");
385 if (((uword) fq->elts) & (CLIB_CACHE_LINE_BYTES - 1))
386 fformat (stderr, "WARNING: fq->elts unaligned\n");
388 if (sizeof (fq->elts[0]) % CLIB_CACHE_LINE_BYTES)
389 fformat (stderr, "WARNING: fq->elts[0] size %d\n",
390 sizeof (fq->elts[0]));
391 if (nelts & (nelts - 1))
393 fformat (stderr, "FATAL: nelts MUST be a power of 2\n");
401 void vl_msg_api_handler_no_free (void *) __attribute__ ((weak));
403 vl_msg_api_handler_no_free (void *v)
407 /* Turned off, save as reference material... */
410 vlib_frame_queue_dequeue_internal (int thread_id,
411 vlib_main_t * vm, vlib_node_main_t * nm)
413 vlib_frame_queue_t *fq = vlib_frame_queues[thread_id];
414 vlib_frame_queue_elt_t *elt;
416 vlib_pending_frame_t *p;
417 vlib_node_runtime_t *r;
418 u32 node_runtime_index;
423 ASSERT (vm == vlib_mains[thread_id]);
427 if (fq->head == fq->tail)
430 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
435 before = clib_cpu_time_now ();
438 node_runtime_index = elt->node_runtime_index;
439 msg_type = elt->msg_type;
443 case VLIB_FRAME_QUEUE_ELT_FREE_BUFFERS:
444 vlib_buffer_free (vm, vlib_frame_vector_args (f), f->n_vectors);
445 /* note fallthrough... */
446 case VLIB_FRAME_QUEUE_ELT_FREE_FRAME:
447 r = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
449 vlib_frame_free (vm, r, f);
451 case VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME:
452 vec_add2 (vm->node_main.pending_frames, p, 1);
453 f->flags |= (VLIB_FRAME_PENDING | VLIB_FRAME_FREE_AFTER_DISPATCH);
454 p->node_runtime_index = elt->node_runtime_index;
455 p->frame_index = vlib_frame_index (vm, f);
456 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
457 fq->dequeue_vectors += (u64) f->n_vectors;
459 case VLIB_FRAME_QUEUE_ELT_API_MSG:
460 vl_msg_api_handler_no_free (f);
463 clib_warning ("bogus frame queue message, type %d", msg_type);
468 fq->dequeue_ticks += clib_cpu_time_now () - before;
469 CLIB_MEMORY_BARRIER ();
478 vlib_frame_queue_dequeue (int thread_id,
479 vlib_main_t * vm, vlib_node_main_t * nm)
481 return vlib_frame_queue_dequeue_internal (thread_id, vm, nm);
485 vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
486 u32 frame_queue_index, vlib_frame_t * frame,
487 vlib_frame_queue_msg_type_t type)
489 vlib_frame_queue_t *fq = vlib_frame_queues[frame_queue_index];
490 vlib_frame_queue_elt_t *elt;
493 u64 before = clib_cpu_time_now ();
497 new_tail = clib_atomic_add_fetch (&fq->tail, 1);
499 /* Wait until a ring slot is available */
500 while (new_tail >= fq->head + fq->nelts)
502 f64 b4 = vlib_time_now_ticks (vm, before);
503 vlib_worker_thread_barrier_check (vm, b4);
504 /* Bad idea. Dequeue -> enqueue -> dequeue -> trouble */
505 // vlib_frame_queue_dequeue (vm->thread_index, vm, nm);
508 elt = fq->elts + (new_tail & (fq->nelts - 1));
510 /* this would be very bad... */
515 /* Once we enqueue the frame, frame->n_vectors is owned elsewhere... */
516 save_count = frame->n_vectors;
519 elt->node_runtime_index = node_runtime_index;
520 elt->msg_type = type;
521 CLIB_MEMORY_BARRIER ();
528 /* To be called by vlib worker threads upon startup */
530 vlib_worker_thread_init (vlib_worker_thread_t * w)
532 vlib_thread_main_t *tm = vlib_get_thread_main ();
535 * Note: disabling signals in worker threads as follows
536 * prevents the api post-mortem dump scheme from working
540 * pthread_sigmask (SIG_SETMASK, &s, 0);
544 clib_mem_set_heap (w->thread_mheap);
546 if (vec_len (tm->thread_prefix) && w->registration->short_name)
548 w->name = format (0, "%v_%s_%d%c", tm->thread_prefix,
549 w->registration->short_name, w->instance_id, '\0');
550 vlib_set_thread_name ((char *) w->name);
553 if (!w->registration->use_pthreads)
556 /* Initial barrier sync, for both worker and i/o threads */
557 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
559 while (*vlib_worker_threads->wait_at_barrier)
562 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
567 vlib_worker_thread_bootstrap_fn (void *arg)
570 vlib_worker_thread_t *w = arg;
572 w->lwp = syscall (SYS_gettid);
573 w->thread_id = pthread_self ();
575 __os_thread_index = w - vlib_worker_threads;
577 vlib_process_start_switch_stack (vlib_mains[__os_thread_index], 0);
578 rv = (void *) clib_calljmp
579 ((uword (*)(uword)) w->thread_function,
580 (uword) arg, w->thread_stack + VLIB_THREAD_STACK_SIZE);
581 /* NOTREACHED, we hope */
586 vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id)
588 const char *sys_cpu_path = "/sys/devices/system/cpu/cpu";
589 const char *sys_node_path = "/sys/devices/system/node/node";
590 clib_bitmap_t *nbmp = 0, *cbmp = 0;
593 int core_id = -1, numa_id = -1;
595 p = format (p, "%s%u/topology/core_id%c", sys_cpu_path, cpu_id, 0);
596 clib_sysfs_read ((char *) p, "%d", &core_id);
597 vec_reset_length (p);
600 clib_sysfs_read ("/sys/devices/system/node/online", "%U",
601 unformat_bitmap_list, &nbmp);
602 clib_bitmap_foreach (node, nbmp) {
603 p = format (p, "%s%u/cpulist%c", sys_node_path, node, 0);
604 clib_sysfs_read ((char *) p, "%U", unformat_bitmap_list, &cbmp);
605 if (clib_bitmap_get (cbmp, cpu_id))
607 vec_reset_length (cbmp);
608 vec_reset_length (p);
615 w->core_id = core_id;
616 w->numa_id = numa_id;
619 static clib_error_t *
620 vlib_launch_thread_int (void *fp, vlib_worker_thread_t * w, unsigned cpu_id)
622 clib_mem_main_t *mm = &clib_mem_main;
623 vlib_thread_main_t *tm = &vlib_thread_main;
624 void *(*fp_arg) (void *) = fp;
628 vlib_get_thread_core_numa (w, cpu_id);
630 /* Set up NUMA-bound heap if indicated */
631 if (mm->per_numa_mheaps[w->numa_id] == 0)
633 /* If the user requested a NUMA heap, create it... */
634 if (tm->numa_heap_size)
636 clib_mem_set_numa_affinity (w->numa_id, 1 /* force */ );
637 numa_heap = clib_mem_create_heap (0 /* DIY */ , tm->numa_heap_size,
639 "numa %u heap", w->numa_id);
640 clib_mem_set_default_numa_affinity ();
641 mm->per_numa_mheaps[w->numa_id] = numa_heap;
645 /* Or, use the main heap */
646 mm->per_numa_mheaps[w->numa_id] = w->thread_mheap;
650 if (tm->cb.vlib_launch_thread_cb && !w->registration->use_pthreads)
651 return tm->cb.vlib_launch_thread_cb (fp, (void *) w, cpu_id);
657 CPU_SET (cpu_id, &cpuset);
659 if (pthread_create (&worker, NULL /* attr */ , fp_arg, (void *) w))
660 return clib_error_return_unix (0, "pthread_create");
662 if (pthread_setaffinity_np (worker, sizeof (cpu_set_t), &cpuset))
663 return clib_error_return_unix (0, "pthread_setaffinity_np");
669 static clib_error_t *
670 start_workers (vlib_main_t * vm)
673 vlib_worker_thread_t *w;
674 vlib_main_t *vm_clone;
676 vlib_thread_main_t *tm = &vlib_thread_main;
677 vlib_thread_registration_t *tr;
678 vlib_node_runtime_t *rt;
679 u32 n_vlib_mains = tm->n_vlib_mains;
680 u32 worker_thread_index;
681 clib_mem_heap_t *main_heap = clib_mem_get_per_cpu_heap ();
683 vec_reset_length (vlib_worker_threads);
685 /* Set up the main thread */
686 vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
687 w->elog_track.name = "main thread";
688 elog_track_register (&vm->elog_main, &w->elog_track);
690 if (vec_len (tm->thread_prefix))
692 w->name = format (0, "%v_main%c", tm->thread_prefix, '\0');
693 vlib_set_thread_name ((char *) w->name);
697 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
698 vm->elog_main.lock[0] = 0;
700 clib_callback_data_init (&vm->vlib_node_runtime_perf_callbacks,
701 &vm->worker_thread_main_loop_callback_lock);
703 /* Replace hand-crafted length-1 vector with a real vector */
706 vec_validate_aligned (vlib_mains, n_vlib_mains - 1, CLIB_CACHE_LINE_BYTES);
707 _vec_len (vlib_mains) = 0;
708 vec_add1_aligned (vlib_mains, vm, CLIB_CACHE_LINE_BYTES);
710 if (n_vlib_mains > 1)
712 vlib_worker_threads->wait_at_barrier =
713 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
714 vlib_worker_threads->workers_at_barrier =
715 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
717 vlib_worker_threads->node_reforks_required =
718 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
720 /* We'll need the rpc vector lock... */
721 clib_spinlock_init (&vm->pending_rpc_lock);
723 /* Ask for an initial barrier sync */
724 *vlib_worker_threads->workers_at_barrier = 0;
725 *vlib_worker_threads->wait_at_barrier = 1;
727 /* Without update or refork */
728 *vlib_worker_threads->node_reforks_required = 0;
729 vm->need_vlib_worker_thread_node_runtime_update = 0;
732 vm->barrier_epoch = 0;
733 vm->barrier_no_close_before = 0;
735 worker_thread_index = 1;
736 clib_spinlock_init (&vm->worker_thread_main_loop_callback_lock);
738 for (i = 0; i < vec_len (tm->registrations); i++)
740 vlib_node_main_t *nm, *nm_clone;
743 tr = tm->registrations[i];
748 for (k = 0; k < tr->count; k++)
752 vec_add2 (vlib_worker_threads, w, 1);
753 /* Currently unused, may not really work */
755 w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
760 w->thread_mheap = main_heap;
763 vlib_thread_stack_init (w - vlib_worker_threads);
764 w->thread_function = tr->function;
765 w->thread_function_arg = w;
767 w->registration = tr;
770 (char *) format (0, "%s %d", tr->name, k + 1);
771 vec_add1 (w->elog_track.name, 0);
772 elog_track_register (&vm->elog_main, &w->elog_track);
774 if (tr->no_data_structure_clone)
777 /* Fork vlib_global_main et al. Look for bugs here */
778 oldheap = clib_mem_set_heap (w->thread_mheap);
780 vm_clone = clib_mem_alloc_aligned (sizeof (*vm_clone),
781 CLIB_CACHE_LINE_BYTES);
782 clib_memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
784 vm_clone->thread_index = worker_thread_index;
785 vm_clone->heap_base = w->thread_mheap;
786 vm_clone->heap_aligned_base = (void *)
787 (((uword) w->thread_mheap) & ~(VLIB_FRAME_ALIGN - 1));
788 vm_clone->init_functions_called =
789 hash_create (0, /* value bytes */ 0);
790 vm_clone->pending_rpc_requests = 0;
791 vec_validate (vm_clone->pending_rpc_requests, 0);
792 _vec_len (vm_clone->pending_rpc_requests) = 0;
793 clib_memset (&vm_clone->random_buffer, 0,
794 sizeof (vm_clone->random_buffer));
796 (&vm_clone->worker_thread_main_loop_callback_lock);
797 clib_callback_data_init
798 (&vm_clone->vlib_node_runtime_perf_callbacks,
799 &vm_clone->worker_thread_main_loop_callback_lock);
801 nm = &vlib_mains[0]->node_main;
802 nm_clone = &vm_clone->node_main;
803 /* fork next frames array, preserving node runtime indices */
804 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
805 CLIB_CACHE_LINE_BYTES);
806 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
808 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
809 u32 save_node_runtime_index;
812 save_node_runtime_index = nf->node_runtime_index;
813 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
814 vlib_next_frame_init (nf);
815 nf->node_runtime_index = save_node_runtime_index;
816 nf->flags = save_flags;
819 /* fork the frame dispatch queue */
820 nm_clone->pending_frames = 0;
821 vec_validate (nm_clone->pending_frames, 10);
822 _vec_len (nm_clone->pending_frames) = 0;
827 /* Allocate all nodes in single block for speed */
828 n = clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*n));
830 for (j = 0; j < vec_len (nm->nodes); j++)
832 clib_memcpy (n, nm->nodes[j], sizeof (*n));
833 /* none of the copied nodes have enqueue rights given out */
834 n->owner_node_index = VLIB_INVALID_NODE_INDEX;
835 clib_memset (&n->stats_total, 0, sizeof (n->stats_total));
836 clib_memset (&n->stats_last_clear, 0,
837 sizeof (n->stats_last_clear));
838 vec_add1 (nm_clone->nodes, n);
841 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
842 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
843 CLIB_CACHE_LINE_BYTES);
845 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
847 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
848 rt->thread_index = vm_clone->thread_index;
849 /* copy initial runtime_data from node */
850 if (n->runtime_data && n->runtime_data_bytes > 0)
851 clib_memcpy (rt->runtime_data, n->runtime_data,
852 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
853 n->runtime_data_bytes));
856 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
857 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
858 CLIB_CACHE_LINE_BYTES);
859 clib_interrupt_init (
860 &nm_clone->interrupts,
861 vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
862 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
864 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
865 rt->thread_index = vm_clone->thread_index;
866 /* copy initial runtime_data from node */
867 if (n->runtime_data && n->runtime_data_bytes > 0)
868 clib_memcpy (rt->runtime_data, n->runtime_data,
869 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
870 n->runtime_data_bytes));
873 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
874 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
875 CLIB_CACHE_LINE_BYTES);
877 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
879 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
880 rt->thread_index = vm_clone->thread_index;
881 /* copy initial runtime_data from node */
882 if (n->runtime_data && n->runtime_data_bytes > 0)
883 clib_memcpy (rt->runtime_data, n->runtime_data,
884 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
885 n->runtime_data_bytes));
888 nm_clone->processes = vec_dup_aligned (nm->processes,
889 CLIB_CACHE_LINE_BYTES);
891 /* Create per-thread frame freelist */
892 nm_clone->frame_sizes = vec_new (vlib_frame_size_t, 1);
893 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
894 nm_clone->frame_size_hash = hash_create (0, sizeof (uword));
896 nm_clone->node_by_error = nm->node_by_error;
898 /* Packet trace buffers are guaranteed to be empty, nothing to do here */
900 clib_mem_set_heap (oldheap);
901 vec_add1_aligned (vlib_mains, vm_clone, CLIB_CACHE_LINE_BYTES);
903 /* Switch to the stats segment ... */
904 void *oldheap = vlib_stats_push_heap (0);
905 vm_clone->error_main.counters = vec_dup_aligned
906 (vlib_mains[0]->error_main.counters, CLIB_CACHE_LINE_BYTES);
907 vlib_stats_pop_heap2 (vm_clone->error_main.counters,
908 worker_thread_index, oldheap, 1);
910 vm_clone->error_main.counters_last_clear = vec_dup_aligned
911 (vlib_mains[0]->error_main.counters_last_clear,
912 CLIB_CACHE_LINE_BYTES);
914 worker_thread_index++;
920 /* only have non-data-structure copy threads to create... */
921 for (i = 0; i < vec_len (tm->registrations); i++)
923 tr = tm->registrations[i];
925 for (j = 0; j < tr->count; j++)
927 vec_add2 (vlib_worker_threads, w, 1);
930 w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
936 w->thread_mheap = main_heap;
938 vlib_thread_stack_init (w - vlib_worker_threads);
939 w->thread_function = tr->function;
940 w->thread_function_arg = w;
943 (char *) format (0, "%s %d", tr->name, j + 1);
944 w->registration = tr;
945 vec_add1 (w->elog_track.name, 0);
946 elog_track_register (&vm->elog_main, &w->elog_track);
951 worker_thread_index = 1;
953 for (i = 0; i < vec_len (tm->registrations); i++)
958 tr = tm->registrations[i];
960 if (tr->use_pthreads || tm->use_pthreads)
962 for (j = 0; j < tr->count; j++)
964 w = vlib_worker_threads + worker_thread_index++;
965 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
968 clib_error_report (err);
975 clib_bitmap_foreach (c, tr->coremask) {
976 w = vlib_worker_threads + worker_thread_index++;
977 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
980 clib_error_report (err);
985 vlib_worker_thread_barrier_sync (vm);
986 vlib_worker_thread_barrier_release (vm);
990 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
994 worker_thread_node_runtime_update_internal (void)
998 vlib_node_main_t *nm, *nm_clone;
999 vlib_main_t *vm_clone;
1000 vlib_node_runtime_t *rt;
1002 vlib_node_runtime_sync_stats (vlib_main_t * vm,
1003 vlib_node_runtime_t * r,
1005 uword n_vectors, uword n_clocks);
1007 ASSERT (vlib_get_thread_index () == 0);
1010 nm = &vm->node_main;
1012 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
1015 * Scrape all runtime stats, so we don't lose node runtime(s) with
1016 * pending counts, or throw away worker / io thread counts.
1018 for (j = 0; j < vec_len (nm->nodes); j++)
1022 vlib_node_sync_stats (vm, n);
1025 for (i = 1; i < vec_len (vlib_mains); i++)
1029 vm_clone = vlib_mains[i];
1030 nm_clone = &vm_clone->node_main;
1032 for (j = 0; j < vec_len (nm_clone->nodes); j++)
1034 n = nm_clone->nodes[j];
1036 rt = vlib_node_get_runtime (vm_clone, n->index);
1037 vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
1041 /* Per-worker clone rebuilds are now done on each thread */
1046 vlib_worker_thread_node_refork (void)
1048 vlib_main_t *vm, *vm_clone;
1049 vlib_node_main_t *nm, *nm_clone;
1050 vlib_node_t **old_nodes_clone;
1051 vlib_node_runtime_t *rt, *old_rt;
1053 vlib_node_t *new_n_clone;
1058 nm = &vm->node_main;
1059 vm_clone = vlib_get_main ();
1060 nm_clone = &vm_clone->node_main;
1062 /* Re-clone error heap */
1063 u64 *old_counters = vm_clone->error_main.counters;
1064 u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
1066 clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
1067 sizeof (vm->error_main));
1068 j = vec_len (vm->error_main.counters) - 1;
1070 /* Switch to the stats segment ... */
1071 void *oldheap = vlib_stats_push_heap (0);
1072 vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
1073 vm_clone->error_main.counters = old_counters;
1074 vlib_stats_pop_heap2 (vm_clone->error_main.counters, vm_clone->thread_index,
1077 vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
1078 vm_clone->error_main.counters_last_clear = old_counters_all_clear;
1080 nm_clone = &vm_clone->node_main;
1081 vec_free (nm_clone->next_frames);
1082 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
1083 CLIB_CACHE_LINE_BYTES);
1085 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
1087 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
1088 u32 save_node_runtime_index;
1091 save_node_runtime_index = nf->node_runtime_index;
1092 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
1093 vlib_next_frame_init (nf);
1094 nf->node_runtime_index = save_node_runtime_index;
1095 nf->flags = save_flags;
1098 old_nodes_clone = nm_clone->nodes;
1099 nm_clone->nodes = 0;
1103 /* Allocate all nodes in single block for speed */
1105 clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
1106 for (j = 0; j < vec_len (nm->nodes); j++)
1108 vlib_node_t *new_n = nm->nodes[j];
1110 clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
1111 /* none of the copied nodes have enqueue rights given out */
1112 new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
1114 if (j >= vec_len (old_nodes_clone))
1116 /* new node, set to zero */
1117 clib_memset (&new_n_clone->stats_total, 0,
1118 sizeof (new_n_clone->stats_total));
1119 clib_memset (&new_n_clone->stats_last_clear, 0,
1120 sizeof (new_n_clone->stats_last_clear));
1124 vlib_node_t *old_n_clone = old_nodes_clone[j];
1125 /* Copy stats if the old data is valid */
1126 clib_memcpy_fast (&new_n_clone->stats_total,
1127 &old_n_clone->stats_total,
1128 sizeof (new_n_clone->stats_total));
1129 clib_memcpy_fast (&new_n_clone->stats_last_clear,
1130 &old_n_clone->stats_last_clear,
1131 sizeof (new_n_clone->stats_last_clear));
1133 /* keep previous node state */
1134 new_n_clone->state = old_n_clone->state;
1136 vec_add1 (nm_clone->nodes, new_n_clone);
1139 /* Free the old node clones */
1140 clib_mem_free (old_nodes_clone[0]);
1142 vec_free (old_nodes_clone);
1145 /* re-clone internal nodes */
1146 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
1147 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
1148 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1149 CLIB_CACHE_LINE_BYTES);
1151 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
1153 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1154 rt->thread_index = vm_clone->thread_index;
1155 /* copy runtime_data, will be overwritten later for existing rt */
1156 if (n->runtime_data && n->runtime_data_bytes > 0)
1157 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1158 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1159 n->runtime_data_bytes));
1162 for (j = 0; j < vec_len (old_rt); j++)
1164 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1165 rt->state = old_rt[j].state;
1166 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1167 VLIB_NODE_RUNTIME_DATA_SIZE);
1172 /* re-clone input nodes */
1173 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1174 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1175 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1176 CLIB_CACHE_LINE_BYTES);
1177 clib_interrupt_resize (
1178 &nm_clone->interrupts,
1179 vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
1181 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1183 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1184 rt->thread_index = vm_clone->thread_index;
1185 /* copy runtime_data, will be overwritten later for existing rt */
1186 if (n->runtime_data && n->runtime_data_bytes > 0)
1187 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1188 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1189 n->runtime_data_bytes));
1192 for (j = 0; j < vec_len (old_rt); j++)
1194 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1195 rt->state = old_rt[j].state;
1196 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1197 VLIB_NODE_RUNTIME_DATA_SIZE);
1202 /* re-clone pre-input nodes */
1203 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT];
1204 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
1205 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
1206 CLIB_CACHE_LINE_BYTES);
1208 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1210 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1211 rt->thread_index = vm_clone->thread_index;
1212 /* copy runtime_data, will be overwritten later for existing rt */
1213 if (n->runtime_data && n->runtime_data_bytes > 0)
1214 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1215 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1216 n->runtime_data_bytes));
1219 for (j = 0; j < vec_len (old_rt); j++)
1221 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1222 rt->state = old_rt[j].state;
1223 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1224 VLIB_NODE_RUNTIME_DATA_SIZE);
1229 nm_clone->processes = vec_dup_aligned (nm->processes,
1230 CLIB_CACHE_LINE_BYTES);
1231 nm_clone->node_by_error = nm->node_by_error;
1235 vlib_worker_thread_node_runtime_update (void)
1238 * Make a note that we need to do a node runtime update
1239 * prior to releasing the barrier.
1241 vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1245 unformat_sched_policy (unformat_input_t * input, va_list * args)
1247 u32 *r = va_arg (*args, u32 *);
1250 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1251 foreach_sched_policy
1258 static clib_error_t *
1259 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1261 vlib_thread_registration_t *tr;
1263 vlib_thread_main_t *tm = &vlib_thread_main;
1268 tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1270 tm->n_thread_stacks = 1; /* account for main thread */
1271 tm->sched_policy = ~0;
1272 tm->sched_priority = ~0;
1273 tm->main_lcore = ~0;
1279 hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1283 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1285 if (unformat (input, "use-pthreads"))
1286 tm->use_pthreads = 1;
1287 else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1289 else if (unformat (input, "main-core %u", &tm->main_lcore))
1291 else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1293 else if (unformat (input, "numa-heap-size %U",
1294 unformat_memory_size, &tm->numa_heap_size))
1296 else if (unformat (input, "coremask-%s %U", &name,
1297 unformat_bitmap_mask, &bitmap) ||
1298 unformat (input, "corelist-%s %U", &name,
1299 unformat_bitmap_list, &bitmap))
1301 p = hash_get_mem (tm->thread_registrations_by_name, name);
1303 return clib_error_return (0, "no such thread type '%s'", name);
1305 tr = (vlib_thread_registration_t *) p[0];
1307 if (tr->use_pthreads)
1308 return clib_error_return (0,
1309 "corelist cannot be set for '%s' threads",
1312 return clib_error_return
1313 (0, "core placement of '%s' threads is already configured",
1316 tr->coremask = bitmap;
1317 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1321 (input, "scheduler-policy %U", unformat_sched_policy,
1324 else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1326 else if (unformat (input, "%s %u", &name, &count))
1328 p = hash_get_mem (tm->thread_registrations_by_name, name);
1330 return clib_error_return (0, "no such thread type 3 '%s'", name);
1332 tr = (vlib_thread_registration_t *) p[0];
1334 if (tr->fixed_count)
1335 return clib_error_return
1336 (0, "number of '%s' threads not configurable", name);
1338 return clib_error_return
1339 (0, "number of '%s' threads is already configured", name);
1347 if (tm->sched_priority != ~0)
1349 if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1351 u32 prio_max = sched_get_priority_max (tm->sched_policy);
1352 u32 prio_min = sched_get_priority_min (tm->sched_policy);
1353 if (tm->sched_priority > prio_max)
1354 tm->sched_priority = prio_max;
1355 if (tm->sched_priority < prio_min)
1356 tm->sched_priority = prio_min;
1360 return clib_error_return
1362 "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1363 tm->sched_priority);
1368 if (!tm->thread_prefix)
1369 tm->thread_prefix = format (0, "vpp");
1373 tm->n_thread_stacks += tr->count;
1374 tm->n_pthreads += tr->count * tr->use_pthreads;
1375 tm->n_threads += tr->count * (tr->use_pthreads == 0);
1382 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1384 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1386 vnet_main_fixup (vlib_fork_fixup_t which)
1391 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1393 vlib_main_t *vm = vlib_get_main ();
1395 if (vlib_mains == 0)
1398 ASSERT (vlib_get_thread_index () == 0);
1399 vlib_worker_thread_barrier_sync (vm);
1403 case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1404 vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1410 vlib_worker_thread_barrier_release (vm);
1414 * Enforce minimum open time to minimize packet loss due to Rx overflow,
1415 * based on a test based heuristic that barrier should be open for at least
1416 * 3 time as long as it is closed (with an upper bound of 1ms because by that
1417 * point it is probably too late to make a difference)
1420 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1421 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1424 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1425 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1429 vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm)
1432 f64 now = vlib_time_now (vm);
1433 u32 count = vec_len (vlib_mains) - 1;
1435 /* No worker threads? */
1439 deadline = now + BARRIER_SYNC_TIMEOUT;
1440 *vlib_worker_threads->wait_at_barrier = 1;
1441 while (*vlib_worker_threads->workers_at_barrier != count)
1443 if ((now = vlib_time_now (vm)) > deadline)
1445 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1450 *vlib_worker_threads->wait_at_barrier = 0;
1454 * Return true if the wroker thread barrier is held
1457 vlib_worker_thread_barrier_held (void)
1459 if (vec_len (vlib_mains) < 2)
1462 return (*vlib_worker_threads->wait_at_barrier == 1);
1466 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm, const char *func_name)
1473 f64 max_vector_rate;
1477 if (vec_len (vlib_mains) < 2)
1480 ASSERT (vlib_get_thread_index () == 0);
1482 vlib_worker_threads[0].barrier_caller = func_name;
1483 count = vec_len (vlib_mains) - 1;
1485 /* Record entry relative to last close */
1486 now = vlib_time_now (vm);
1487 t_entry = now - vm->barrier_epoch;
1489 /* Tolerate recursive calls */
1490 if (++vlib_worker_threads[0].recursion_level > 1)
1492 barrier_trace_sync_rec (t_entry);
1496 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1497 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1498 vm->clib_time.last_cpu_time, 0 /* enter */ );
1501 * Need data to decide if we're working hard enough to honor
1502 * the barrier hold-down timer.
1504 max_vector_rate = 0.0;
1505 for (i = 1; i < vec_len (vlib_mains); i++)
1507 clib_max (max_vector_rate,
1508 (f64) vlib_last_vectors_per_main_loop (vlib_mains[i]));
1510 vlib_worker_threads[0].barrier_sync_count++;
1512 /* Enforce minimum barrier open time to minimize packet loss */
1513 ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1516 * If any worker thread seems busy, which we define
1517 * as a vector rate above 10, we enforce the barrier hold-down timer
1519 if (max_vector_rate > 10.0)
1523 now = vlib_time_now (vm);
1524 /* Barrier hold-down timer expired? */
1525 if (now >= vm->barrier_no_close_before)
1527 if ((vm->barrier_no_close_before - now)
1528 > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1531 ("clock change: would have waited for %.4f seconds",
1532 (vm->barrier_no_close_before - now));
1537 /* Record time of closure */
1538 t_open = now - vm->barrier_epoch;
1539 vm->barrier_epoch = now;
1541 deadline = now + BARRIER_SYNC_TIMEOUT;
1543 *vlib_worker_threads->wait_at_barrier = 1;
1544 while (*vlib_worker_threads->workers_at_barrier != count)
1546 if ((now = vlib_time_now (vm)) > deadline)
1548 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1553 t_closed = now - vm->barrier_epoch;
1555 barrier_trace_sync (t_entry, t_open, t_closed);
1560 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1567 f64 t_update_main = 0.0;
1568 int refork_needed = 0;
1570 if (vec_len (vlib_mains) < 2)
1573 ASSERT (vlib_get_thread_index () == 0);
1576 now = vlib_time_now (vm);
1577 t_entry = now - vm->barrier_epoch;
1579 if (--vlib_worker_threads[0].recursion_level > 0)
1581 barrier_trace_release_rec (t_entry);
1585 /* Update (all) node runtimes before releasing the barrier, if needed */
1586 if (vm->need_vlib_worker_thread_node_runtime_update)
1589 * Lock stat segment here, so we's safe when
1590 * rebuilding the stat segment node clones from the
1593 vlib_stat_segment_lock ();
1595 /* Do stats elements on main thread */
1596 worker_thread_node_runtime_update_internal ();
1597 vm->need_vlib_worker_thread_node_runtime_update = 0;
1599 /* Do per thread rebuilds in parallel */
1601 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1602 (vec_len (vlib_mains) - 1));
1603 now = vlib_time_now (vm);
1604 t_update_main = now - vm->barrier_epoch;
1607 deadline = now + BARRIER_SYNC_TIMEOUT;
1610 * Note when we let go of the barrier.
1611 * Workers can use this to derive a reasonably accurate
1612 * time offset. See vlib_time_now(...)
1614 vm->time_last_barrier_release = vlib_time_now (vm);
1615 CLIB_MEMORY_STORE_BARRIER ();
1617 *vlib_worker_threads->wait_at_barrier = 0;
1619 while (*vlib_worker_threads->workers_at_barrier > 0)
1621 if ((now = vlib_time_now (vm)) > deadline)
1623 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1628 /* Wait for reforks before continuing */
1631 now = vlib_time_now (vm);
1633 deadline = now + BARRIER_SYNC_TIMEOUT;
1635 while (*vlib_worker_threads->node_reforks_required > 0)
1637 if ((now = vlib_time_now (vm)) > deadline)
1639 fformat (stderr, "%s: worker thread refork deadlock\n",
1644 vlib_stat_segment_unlock ();
1647 t_closed_total = now - vm->barrier_epoch;
1649 minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1651 if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1653 minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1656 vm->barrier_no_close_before = now + minimum_open;
1658 /* Record barrier epoch (used to enforce minimum open time) */
1659 vm->barrier_epoch = now;
1661 barrier_trace_release (t_entry, t_closed_total, t_update_main);
1663 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1664 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1665 vm->clib_time.last_cpu_time, 1 /* leave */ );
1669 * Wait until each of the workers has been once around the track
1672 vlib_worker_wait_one_loop (void)
1674 ASSERT (vlib_get_thread_index () == 0);
1676 if (vec_len (vlib_mains) < 2)
1679 if (vlib_worker_thread_barrier_held ())
1685 vec_validate (counts, vec_len (vlib_mains) - 1);
1687 /* record the current loop counts */
1688 vec_foreach_index (ii, vlib_mains)
1689 counts[ii] = vlib_mains[ii]->main_loop_count;
1691 /* spin until each changes, apart from the main thread, or we'd be
1693 for (ii = 1; ii < vec_len (counts); ii++)
1695 while (counts[ii] == vlib_mains[ii]->main_loop_count)
1704 * Check the frame queue to see if any frames are available.
1705 * If so, pull the packets off the frames and put them to
1709 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm)
1711 u32 thread_id = vm->thread_index;
1712 vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1713 vlib_frame_queue_elt_t *elt;
1722 ASSERT (vm == vlib_mains[thread_id]);
1724 if (PREDICT_FALSE (fqm->node_index == ~0))
1727 * Gather trace data for frame queues
1729 if (PREDICT_FALSE (fq->trace))
1731 frame_queue_trace_t *fqt;
1732 frame_queue_nelt_counter_t *fqh;
1735 fqt = &fqm->frame_queue_traces[thread_id];
1737 fqt->nelts = fq->nelts;
1738 fqt->head = fq->head;
1739 fqt->head_hint = fq->head_hint;
1740 fqt->tail = fq->tail;
1741 fqt->threshold = fq->vector_threshold;
1742 fqt->n_in_use = fqt->tail - fqt->head;
1743 if (fqt->n_in_use >= fqt->nelts)
1745 // if beyond max then use max
1746 fqt->n_in_use = fqt->nelts - 1;
1749 /* Record the number of elements in use in the histogram */
1750 fqh = &fqm->frame_queue_histogram[thread_id];
1751 fqh->count[fqt->n_in_use]++;
1753 /* Record a snapshot of the elements in use */
1754 for (elix = 0; elix < fqt->nelts; elix++)
1756 elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1757 if (1 || elt->valid)
1759 fqt->n_vectors[elix] = elt->n_vectors;
1768 if (fq->head == fq->tail)
1770 fq->head_hint = fq->head;
1774 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1778 fq->head_hint = fq->head;
1782 from = elt->buffer_index;
1783 msg_type = elt->msg_type;
1785 ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1786 ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1788 f = vlib_get_frame_to_node (vm, fqm->node_index);
1790 /* If the first vector is traced, set the frame trace flag */
1791 b = vlib_get_buffer (vm, from[0]);
1792 if (b->flags & VLIB_BUFFER_IS_TRACED)
1793 f->frame_flags |= VLIB_NODE_FLAG_TRACE;
1795 to = vlib_frame_vector_args (f);
1797 n_left_to_node = elt->n_vectors;
1799 while (n_left_to_node >= 4)
1807 n_left_to_node -= 4;
1810 while (n_left_to_node > 0)
1818 vectors += elt->n_vectors;
1819 f->n_vectors = elt->n_vectors;
1820 vlib_put_frame_to_node (vm, fqm->node_index, f);
1824 elt->msg_type = 0xfefefefe;
1825 CLIB_MEMORY_BARRIER ();
1830 * Limit the number of packets pushed into the graph
1832 if (vectors >= fq->vector_threshold)
1834 fq->head_hint = fq->head;
1843 vlib_worker_thread_fn (void *arg)
1845 vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1846 vlib_thread_main_t *tm = vlib_get_thread_main ();
1847 vlib_main_t *vm = vlib_get_main ();
1850 vlib_process_finish_switch_stack (vm);
1852 ASSERT (vm->thread_index == vlib_get_thread_index ());
1854 vlib_worker_thread_init (w);
1855 clib_time_init (&vm->clib_time);
1856 clib_mem_set_heap (w->thread_mheap);
1858 e = vlib_call_init_exit_functions_no_sort
1859 (vm, &vm->worker_init_function_registrations, 1 /* call_once */ );
1861 clib_error_report (e);
1863 /* Wait until the dpdk init sequence is complete */
1864 while (tm->extern_thread_mgmt && tm->worker_thread_release == 0)
1865 vlib_worker_thread_barrier_check ();
1867 vlib_worker_loop (vm);
1871 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1874 .function = vlib_worker_thread_fn,
1879 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1881 vlib_thread_main_t *tm = vlib_get_thread_main ();
1882 vlib_frame_queue_main_t *fqm;
1883 vlib_frame_queue_t *fq;
1887 if (frame_queue_nelts == 0)
1888 frame_queue_nelts = FRAME_QUEUE_MAX_NELTS;
1890 num_threads = 1 /* main thread */ + tm->n_threads;
1891 ASSERT (frame_queue_nelts >= 8 + num_threads);
1893 vec_add2 (tm->frame_queue_mains, fqm, 1);
1895 fqm->node_index = node_index;
1896 fqm->frame_queue_nelts = frame_queue_nelts;
1897 fqm->queue_hi_thresh = frame_queue_nelts - num_threads;
1899 vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1900 vec_validate (fqm->per_thread_data, tm->n_vlib_mains - 1);
1901 _vec_len (fqm->vlib_frame_queues) = 0;
1902 for (i = 0; i < tm->n_vlib_mains; i++)
1904 vlib_frame_queue_per_thread_data_t *ptd;
1905 fq = vlib_frame_queue_alloc (frame_queue_nelts);
1906 vec_add1 (fqm->vlib_frame_queues, fq);
1908 ptd = vec_elt_at_index (fqm->per_thread_data, i);
1909 vec_validate (ptd->handoff_queue_elt_by_thread_index,
1910 tm->n_vlib_mains - 1);
1911 vec_validate_init_empty (ptd->congested_handoff_queue_by_thread_index,
1912 tm->n_vlib_mains - 1,
1913 (vlib_frame_queue_t *) (~0));
1916 return (fqm - tm->frame_queue_mains);
1920 vlib_thread_cb_register (struct vlib_main_t *vm, vlib_thread_callbacks_t * cb)
1922 vlib_thread_main_t *tm = vlib_get_thread_main ();
1924 if (tm->extern_thread_mgmt)
1927 tm->cb.vlib_launch_thread_cb = cb->vlib_launch_thread_cb;
1928 tm->extern_thread_mgmt = 1;
1933 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1936 ASSERT (vlib_get_thread_index () == 0);
1937 vlib_process_signal_event (vlib_get_main (), args->node_index,
1938 args->type_opaque, args->data);
1941 void *rpc_call_main_thread_cb_fn;
1944 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1946 if (rpc_call_main_thread_cb_fn)
1948 void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1949 (*fp) (callback, args, arg_size);
1952 clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1956 threads_init (vlib_main_t * vm)
1961 VLIB_INIT_FUNCTION (threads_init);
1964 static clib_error_t *
1965 show_clock_command_fn (vlib_main_t * vm,
1966 unformat_input_t * input, vlib_cli_command_t * cmd)
1970 clib_timebase_t _tb, *tb = &_tb;
1972 (void) unformat (input, "verbose %=", &verbose, 1);
1974 clib_timebase_init (tb, 0 /* GMT */ , CLIB_TIMEBASE_DAYLIGHT_NONE,
1977 vlib_cli_output (vm, "%U, %U GMT", format_clib_time, &vm->clib_time,
1978 verbose, format_clib_timebase_time,
1979 clib_timebase_now (tb));
1981 if (vec_len (vlib_mains) == 1)
1984 vlib_cli_output (vm, "Time last barrier release %.9f",
1985 vm->time_last_barrier_release);
1987 for (i = 1; i < vec_len (vlib_mains); i++)
1989 if (vlib_mains[i] == 0)
1992 vlib_cli_output (vm, "%d: %U", i, format_clib_time,
1993 &vlib_mains[i]->clib_time, verbose);
1995 vlib_cli_output (vm, "Thread %d offset %.9f error %.9f", i,
1996 vlib_mains[i]->time_offset,
1997 vm->time_last_barrier_release -
1998 vlib_mains[i]->time_last_barrier_release);
2004 VLIB_CLI_COMMAND (f_command, static) =
2006 .path = "show clock",
2007 .short_help = "show clock",
2008 .function = show_clock_command_fn,
2012 vlib_thread_main_t *
2013 vlib_get_thread_main_not_inline (void)
2015 return vlib_get_thread_main ();
2019 * fd.io coding-style-patch-verification: ON
2022 * eval: (c-set-style "gnu")