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_get_main_by_index (__os_thread_index),
579 rv = (void *) clib_calljmp
580 ((uword (*)(uword)) w->thread_function,
581 (uword) arg, w->thread_stack + VLIB_THREAD_STACK_SIZE);
582 /* NOTREACHED, we hope */
587 vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id)
589 const char *sys_cpu_path = "/sys/devices/system/cpu/cpu";
590 const char *sys_node_path = "/sys/devices/system/node/node";
591 clib_bitmap_t *nbmp = 0, *cbmp = 0;
594 int core_id = -1, numa_id = -1;
596 p = format (p, "%s%u/topology/core_id%c", sys_cpu_path, cpu_id, 0);
597 clib_sysfs_read ((char *) p, "%d", &core_id);
598 vec_reset_length (p);
601 clib_sysfs_read ("/sys/devices/system/node/online", "%U",
602 unformat_bitmap_list, &nbmp);
603 clib_bitmap_foreach (node, nbmp) {
604 p = format (p, "%s%u/cpulist%c", sys_node_path, node, 0);
605 clib_sysfs_read ((char *) p, "%U", unformat_bitmap_list, &cbmp);
606 if (clib_bitmap_get (cbmp, cpu_id))
608 vec_reset_length (cbmp);
609 vec_reset_length (p);
616 w->core_id = core_id;
617 w->numa_id = numa_id;
620 static clib_error_t *
621 vlib_launch_thread_int (void *fp, vlib_worker_thread_t * w, unsigned cpu_id)
623 clib_mem_main_t *mm = &clib_mem_main;
624 vlib_thread_main_t *tm = &vlib_thread_main;
625 void *(*fp_arg) (void *) = fp;
629 vlib_get_thread_core_numa (w, cpu_id);
631 /* Set up NUMA-bound heap if indicated */
632 if (mm->per_numa_mheaps[w->numa_id] == 0)
634 /* If the user requested a NUMA heap, create it... */
635 if (tm->numa_heap_size)
637 clib_mem_set_numa_affinity (w->numa_id, 1 /* force */ );
638 numa_heap = clib_mem_create_heap (0 /* DIY */ , tm->numa_heap_size,
640 "numa %u heap", w->numa_id);
641 clib_mem_set_default_numa_affinity ();
642 mm->per_numa_mheaps[w->numa_id] = numa_heap;
646 /* Or, use the main heap */
647 mm->per_numa_mheaps[w->numa_id] = w->thread_mheap;
651 if (tm->cb.vlib_launch_thread_cb && !w->registration->use_pthreads)
652 return tm->cb.vlib_launch_thread_cb (fp, (void *) w, cpu_id);
658 CPU_SET (cpu_id, &cpuset);
660 if (pthread_create (&worker, NULL /* attr */ , fp_arg, (void *) w))
661 return clib_error_return_unix (0, "pthread_create");
663 if (pthread_setaffinity_np (worker, sizeof (cpu_set_t), &cpuset))
664 return clib_error_return_unix (0, "pthread_setaffinity_np");
670 static clib_error_t *
671 start_workers (vlib_main_t * vm)
674 vlib_worker_thread_t *w;
675 vlib_main_t *vm_clone;
677 vlib_thread_main_t *tm = &vlib_thread_main;
678 vlib_thread_registration_t *tr;
679 vlib_node_runtime_t *rt;
680 u32 n_vlib_mains = tm->n_vlib_mains;
681 u32 worker_thread_index;
682 clib_mem_heap_t *main_heap = clib_mem_get_per_cpu_heap ();
684 vec_reset_length (vlib_worker_threads);
686 /* Set up the main thread */
687 vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
688 w->elog_track.name = "main thread";
689 elog_track_register (&vm->elog_main, &w->elog_track);
691 if (vec_len (tm->thread_prefix))
693 w->name = format (0, "%v_main%c", tm->thread_prefix, '\0');
694 vlib_set_thread_name ((char *) w->name);
698 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
699 vm->elog_main.lock[0] = 0;
701 clib_callback_data_init (&vm->vlib_node_runtime_perf_callbacks,
702 &vm->worker_thread_main_loop_callback_lock);
704 /* Replace hand-crafted length-1 vector with a real vector */
707 vec_validate_aligned (vlib_mains, n_vlib_mains - 1, CLIB_CACHE_LINE_BYTES);
708 _vec_len (vlib_mains) = 0;
709 vec_add1_aligned (vlib_mains, vm, CLIB_CACHE_LINE_BYTES);
711 if (n_vlib_mains > 1)
713 vlib_worker_threads->wait_at_barrier =
714 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
715 vlib_worker_threads->workers_at_barrier =
716 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
718 vlib_worker_threads->node_reforks_required =
719 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
721 /* We'll need the rpc vector lock... */
722 clib_spinlock_init (&vm->pending_rpc_lock);
724 /* Ask for an initial barrier sync */
725 *vlib_worker_threads->workers_at_barrier = 0;
726 *vlib_worker_threads->wait_at_barrier = 1;
728 /* Without update or refork */
729 *vlib_worker_threads->node_reforks_required = 0;
730 vm->need_vlib_worker_thread_node_runtime_update = 0;
733 vm->barrier_epoch = 0;
734 vm->barrier_no_close_before = 0;
736 worker_thread_index = 1;
737 clib_spinlock_init (&vm->worker_thread_main_loop_callback_lock);
739 for (i = 0; i < vec_len (tm->registrations); i++)
741 vlib_node_main_t *nm, *nm_clone;
744 tr = tm->registrations[i];
749 for (k = 0; k < tr->count; k++)
753 vec_add2 (vlib_worker_threads, w, 1);
754 /* Currently unused, may not really work */
756 w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
761 w->thread_mheap = main_heap;
764 vlib_thread_stack_init (w - vlib_worker_threads);
765 w->thread_function = tr->function;
766 w->thread_function_arg = w;
768 w->registration = tr;
771 (char *) format (0, "%s %d", tr->name, k + 1);
772 vec_add1 (w->elog_track.name, 0);
773 elog_track_register (&vm->elog_main, &w->elog_track);
775 if (tr->no_data_structure_clone)
778 /* Fork vlib_global_main et al. Look for bugs here */
779 oldheap = clib_mem_set_heap (w->thread_mheap);
781 vm_clone = clib_mem_alloc_aligned (sizeof (*vm_clone),
782 CLIB_CACHE_LINE_BYTES);
783 clib_memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
785 vm_clone->thread_index = worker_thread_index;
786 vm_clone->heap_base = w->thread_mheap;
787 vm_clone->heap_aligned_base = (void *)
788 (((uword) w->thread_mheap) & ~(VLIB_FRAME_ALIGN - 1));
789 vm_clone->init_functions_called =
790 hash_create (0, /* value bytes */ 0);
791 vm_clone->pending_rpc_requests = 0;
792 vec_validate (vm_clone->pending_rpc_requests, 0);
793 _vec_len (vm_clone->pending_rpc_requests) = 0;
794 clib_memset (&vm_clone->random_buffer, 0,
795 sizeof (vm_clone->random_buffer));
797 (&vm_clone->worker_thread_main_loop_callback_lock);
798 clib_callback_data_init
799 (&vm_clone->vlib_node_runtime_perf_callbacks,
800 &vm_clone->worker_thread_main_loop_callback_lock);
802 nm = &vlib_mains[0]->node_main;
803 nm_clone = &vm_clone->node_main;
804 /* fork next frames array, preserving node runtime indices */
805 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
806 CLIB_CACHE_LINE_BYTES);
807 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
809 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
810 u32 save_node_runtime_index;
813 save_node_runtime_index = nf->node_runtime_index;
814 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
815 vlib_next_frame_init (nf);
816 nf->node_runtime_index = save_node_runtime_index;
817 nf->flags = save_flags;
820 /* fork the frame dispatch queue */
821 nm_clone->pending_frames = 0;
822 vec_validate (nm_clone->pending_frames, 10);
823 _vec_len (nm_clone->pending_frames) = 0;
828 /* Allocate all nodes in single block for speed */
829 n = clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*n));
831 for (j = 0; j < vec_len (nm->nodes); j++)
833 clib_memcpy (n, nm->nodes[j], sizeof (*n));
834 /* none of the copied nodes have enqueue rights given out */
835 n->owner_node_index = VLIB_INVALID_NODE_INDEX;
836 clib_memset (&n->stats_total, 0, sizeof (n->stats_total));
837 clib_memset (&n->stats_last_clear, 0,
838 sizeof (n->stats_last_clear));
839 vec_add1 (nm_clone->nodes, n);
842 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
843 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
844 CLIB_CACHE_LINE_BYTES);
846 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
848 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
849 rt->thread_index = vm_clone->thread_index;
850 /* copy initial runtime_data from node */
851 if (n->runtime_data && n->runtime_data_bytes > 0)
852 clib_memcpy (rt->runtime_data, n->runtime_data,
853 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
854 n->runtime_data_bytes));
857 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
858 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
859 CLIB_CACHE_LINE_BYTES);
860 clib_interrupt_init (
861 &nm_clone->interrupts,
862 vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
863 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
865 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
866 rt->thread_index = vm_clone->thread_index;
867 /* copy initial runtime_data from node */
868 if (n->runtime_data && n->runtime_data_bytes > 0)
869 clib_memcpy (rt->runtime_data, n->runtime_data,
870 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
871 n->runtime_data_bytes));
874 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
875 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
876 CLIB_CACHE_LINE_BYTES);
878 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
880 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
881 rt->thread_index = vm_clone->thread_index;
882 /* copy initial runtime_data from node */
883 if (n->runtime_data && n->runtime_data_bytes > 0)
884 clib_memcpy (rt->runtime_data, n->runtime_data,
885 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
886 n->runtime_data_bytes));
889 nm_clone->processes = vec_dup_aligned (nm->processes,
890 CLIB_CACHE_LINE_BYTES);
892 /* Create per-thread frame freelist */
893 nm_clone->frame_sizes = vec_new (vlib_frame_size_t, 1);
894 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
895 nm_clone->frame_size_hash = hash_create (0, sizeof (uword));
897 nm_clone->node_by_error = nm->node_by_error;
899 /* Packet trace buffers are guaranteed to be empty, nothing to do here */
901 clib_mem_set_heap (oldheap);
902 vec_add1_aligned (vlib_mains, vm_clone, CLIB_CACHE_LINE_BYTES);
904 /* Switch to the stats segment ... */
905 void *oldheap = vlib_stats_push_heap (0);
906 vm_clone->error_main.counters = vec_dup_aligned
907 (vlib_mains[0]->error_main.counters, CLIB_CACHE_LINE_BYTES);
908 vlib_stats_pop_heap2 (vm_clone->error_main.counters,
909 worker_thread_index, oldheap, 1);
911 vm_clone->error_main.counters_last_clear = vec_dup_aligned
912 (vlib_mains[0]->error_main.counters_last_clear,
913 CLIB_CACHE_LINE_BYTES);
915 worker_thread_index++;
921 /* only have non-data-structure copy threads to create... */
922 for (i = 0; i < vec_len (tm->registrations); i++)
924 tr = tm->registrations[i];
926 for (j = 0; j < tr->count; j++)
928 vec_add2 (vlib_worker_threads, w, 1);
931 w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
937 w->thread_mheap = main_heap;
939 vlib_thread_stack_init (w - vlib_worker_threads);
940 w->thread_function = tr->function;
941 w->thread_function_arg = w;
944 (char *) format (0, "%s %d", tr->name, j + 1);
945 w->registration = tr;
946 vec_add1 (w->elog_track.name, 0);
947 elog_track_register (&vm->elog_main, &w->elog_track);
952 worker_thread_index = 1;
954 for (i = 0; i < vec_len (tm->registrations); i++)
959 tr = tm->registrations[i];
961 if (tr->use_pthreads || tm->use_pthreads)
963 for (j = 0; j < tr->count; j++)
965 w = vlib_worker_threads + worker_thread_index++;
966 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
969 clib_error_report (err);
976 clib_bitmap_foreach (c, tr->coremask) {
977 w = vlib_worker_threads + worker_thread_index++;
978 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
981 clib_error_report (err);
986 vlib_worker_thread_barrier_sync (vm);
987 vlib_worker_thread_barrier_release (vm);
991 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
995 worker_thread_node_runtime_update_internal (void)
999 vlib_node_main_t *nm, *nm_clone;
1000 vlib_main_t *vm_clone;
1001 vlib_node_runtime_t *rt;
1003 ASSERT (vlib_get_thread_index () == 0);
1005 vm = vlib_get_first_main ();
1006 nm = &vm->node_main;
1008 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
1011 * Scrape all runtime stats, so we don't lose node runtime(s) with
1012 * pending counts, or throw away worker / io thread counts.
1014 for (j = 0; j < vec_len (nm->nodes); j++)
1018 vlib_node_sync_stats (vm, n);
1021 for (i = 1; i < vlib_get_n_threads (); i++)
1025 vm_clone = vlib_get_main_by_index (i);
1026 nm_clone = &vm_clone->node_main;
1028 for (j = 0; j < vec_len (nm_clone->nodes); j++)
1030 n = nm_clone->nodes[j];
1032 rt = vlib_node_get_runtime (vm_clone, n->index);
1033 vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
1037 /* Per-worker clone rebuilds are now done on each thread */
1042 vlib_worker_thread_node_refork (void)
1044 vlib_main_t *vm, *vm_clone;
1045 vlib_node_main_t *nm, *nm_clone;
1046 vlib_node_t **old_nodes_clone;
1047 vlib_node_runtime_t *rt, *old_rt;
1049 vlib_node_t *new_n_clone;
1053 vm = vlib_get_first_main ();
1054 nm = &vm->node_main;
1055 vm_clone = vlib_get_main ();
1056 nm_clone = &vm_clone->node_main;
1058 /* Re-clone error heap */
1059 u64 *old_counters = vm_clone->error_main.counters;
1060 u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
1062 clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
1063 sizeof (vm->error_main));
1064 j = vec_len (vm->error_main.counters) - 1;
1066 /* Switch to the stats segment ... */
1067 void *oldheap = vlib_stats_push_heap (0);
1068 vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
1069 vm_clone->error_main.counters = old_counters;
1070 vlib_stats_pop_heap2 (vm_clone->error_main.counters, vm_clone->thread_index,
1073 vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
1074 vm_clone->error_main.counters_last_clear = old_counters_all_clear;
1076 nm_clone = &vm_clone->node_main;
1077 vec_free (nm_clone->next_frames);
1078 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
1079 CLIB_CACHE_LINE_BYTES);
1081 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
1083 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
1084 u32 save_node_runtime_index;
1087 save_node_runtime_index = nf->node_runtime_index;
1088 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
1089 vlib_next_frame_init (nf);
1090 nf->node_runtime_index = save_node_runtime_index;
1091 nf->flags = save_flags;
1094 old_nodes_clone = nm_clone->nodes;
1095 nm_clone->nodes = 0;
1099 /* Allocate all nodes in single block for speed */
1101 clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
1102 for (j = 0; j < vec_len (nm->nodes); j++)
1104 vlib_node_t *new_n = nm->nodes[j];
1106 clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
1107 /* none of the copied nodes have enqueue rights given out */
1108 new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
1110 if (j >= vec_len (old_nodes_clone))
1112 /* new node, set to zero */
1113 clib_memset (&new_n_clone->stats_total, 0,
1114 sizeof (new_n_clone->stats_total));
1115 clib_memset (&new_n_clone->stats_last_clear, 0,
1116 sizeof (new_n_clone->stats_last_clear));
1120 vlib_node_t *old_n_clone = old_nodes_clone[j];
1121 /* Copy stats if the old data is valid */
1122 clib_memcpy_fast (&new_n_clone->stats_total,
1123 &old_n_clone->stats_total,
1124 sizeof (new_n_clone->stats_total));
1125 clib_memcpy_fast (&new_n_clone->stats_last_clear,
1126 &old_n_clone->stats_last_clear,
1127 sizeof (new_n_clone->stats_last_clear));
1129 /* keep previous node state */
1130 new_n_clone->state = old_n_clone->state;
1132 vec_add1 (nm_clone->nodes, new_n_clone);
1135 /* Free the old node clones */
1136 clib_mem_free (old_nodes_clone[0]);
1138 vec_free (old_nodes_clone);
1141 /* re-clone internal nodes */
1142 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
1143 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
1144 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1145 CLIB_CACHE_LINE_BYTES);
1147 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
1149 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1150 rt->thread_index = vm_clone->thread_index;
1151 /* copy runtime_data, will be overwritten later for existing rt */
1152 if (n->runtime_data && n->runtime_data_bytes > 0)
1153 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1154 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1155 n->runtime_data_bytes));
1158 for (j = 0; j < vec_len (old_rt); j++)
1160 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1161 rt->state = old_rt[j].state;
1162 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1163 VLIB_NODE_RUNTIME_DATA_SIZE);
1168 /* re-clone input nodes */
1169 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1170 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1171 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1172 CLIB_CACHE_LINE_BYTES);
1173 clib_interrupt_resize (
1174 &nm_clone->interrupts,
1175 vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
1177 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1179 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1180 rt->thread_index = vm_clone->thread_index;
1181 /* copy runtime_data, will be overwritten later for existing rt */
1182 if (n->runtime_data && n->runtime_data_bytes > 0)
1183 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1184 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1185 n->runtime_data_bytes));
1188 for (j = 0; j < vec_len (old_rt); j++)
1190 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1191 rt->state = old_rt[j].state;
1192 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1193 VLIB_NODE_RUNTIME_DATA_SIZE);
1198 /* re-clone pre-input nodes */
1199 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT];
1200 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
1201 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
1202 CLIB_CACHE_LINE_BYTES);
1204 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1206 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1207 rt->thread_index = vm_clone->thread_index;
1208 /* copy runtime_data, will be overwritten later for existing rt */
1209 if (n->runtime_data && n->runtime_data_bytes > 0)
1210 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1211 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1212 n->runtime_data_bytes));
1215 for (j = 0; j < vec_len (old_rt); j++)
1217 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1218 rt->state = old_rt[j].state;
1219 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1220 VLIB_NODE_RUNTIME_DATA_SIZE);
1225 nm_clone->processes = vec_dup_aligned (nm->processes,
1226 CLIB_CACHE_LINE_BYTES);
1227 nm_clone->node_by_error = nm->node_by_error;
1231 vlib_worker_thread_node_runtime_update (void)
1234 * Make a note that we need to do a node runtime update
1235 * prior to releasing the barrier.
1237 vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1241 unformat_sched_policy (unformat_input_t * input, va_list * args)
1243 u32 *r = va_arg (*args, u32 *);
1246 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1247 foreach_sched_policy
1254 static clib_error_t *
1255 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1257 vlib_thread_registration_t *tr;
1259 vlib_thread_main_t *tm = &vlib_thread_main;
1264 tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1266 tm->n_thread_stacks = 1; /* account for main thread */
1267 tm->sched_policy = ~0;
1268 tm->sched_priority = ~0;
1269 tm->main_lcore = ~0;
1275 hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1279 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1281 if (unformat (input, "use-pthreads"))
1282 tm->use_pthreads = 1;
1283 else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1285 else if (unformat (input, "main-core %u", &tm->main_lcore))
1287 else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1289 else if (unformat (input, "numa-heap-size %U",
1290 unformat_memory_size, &tm->numa_heap_size))
1292 else if (unformat (input, "coremask-%s %U", &name,
1293 unformat_bitmap_mask, &bitmap) ||
1294 unformat (input, "corelist-%s %U", &name,
1295 unformat_bitmap_list, &bitmap))
1297 p = hash_get_mem (tm->thread_registrations_by_name, name);
1299 return clib_error_return (0, "no such thread type '%s'", name);
1301 tr = (vlib_thread_registration_t *) p[0];
1303 if (tr->use_pthreads)
1304 return clib_error_return (0,
1305 "corelist cannot be set for '%s' threads",
1308 return clib_error_return
1309 (0, "core placement of '%s' threads is already configured",
1312 tr->coremask = bitmap;
1313 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1317 (input, "scheduler-policy %U", unformat_sched_policy,
1320 else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1322 else if (unformat (input, "%s %u", &name, &count))
1324 p = hash_get_mem (tm->thread_registrations_by_name, name);
1326 return clib_error_return (0, "no such thread type 3 '%s'", name);
1328 tr = (vlib_thread_registration_t *) p[0];
1330 if (tr->fixed_count)
1331 return clib_error_return
1332 (0, "number of '%s' threads not configurable", name);
1334 return clib_error_return
1335 (0, "number of '%s' threads is already configured", name);
1343 if (tm->sched_priority != ~0)
1345 if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1347 u32 prio_max = sched_get_priority_max (tm->sched_policy);
1348 u32 prio_min = sched_get_priority_min (tm->sched_policy);
1349 if (tm->sched_priority > prio_max)
1350 tm->sched_priority = prio_max;
1351 if (tm->sched_priority < prio_min)
1352 tm->sched_priority = prio_min;
1356 return clib_error_return
1358 "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1359 tm->sched_priority);
1364 if (!tm->thread_prefix)
1365 tm->thread_prefix = format (0, "vpp");
1369 tm->n_thread_stacks += tr->count;
1370 tm->n_pthreads += tr->count * tr->use_pthreads;
1371 tm->n_threads += tr->count * (tr->use_pthreads == 0);
1378 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1380 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1382 vnet_main_fixup (vlib_fork_fixup_t which)
1387 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1389 vlib_main_t *vm = vlib_get_main ();
1391 if (vlib_mains == 0)
1394 ASSERT (vlib_get_thread_index () == 0);
1395 vlib_worker_thread_barrier_sync (vm);
1399 case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1400 vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1406 vlib_worker_thread_barrier_release (vm);
1410 * Enforce minimum open time to minimize packet loss due to Rx overflow,
1411 * based on a test based heuristic that barrier should be open for at least
1412 * 3 time as long as it is closed (with an upper bound of 1ms because by that
1413 * point it is probably too late to make a difference)
1416 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1417 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1420 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1421 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1425 vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm)
1428 f64 now = vlib_time_now (vm);
1429 u32 count = vlib_get_n_threads () - 1;
1431 /* No worker threads? */
1435 deadline = now + BARRIER_SYNC_TIMEOUT;
1436 *vlib_worker_threads->wait_at_barrier = 1;
1437 while (*vlib_worker_threads->workers_at_barrier != count)
1439 if ((now = vlib_time_now (vm)) > deadline)
1441 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1446 *vlib_worker_threads->wait_at_barrier = 0;
1450 * Return true if the wroker thread barrier is held
1453 vlib_worker_thread_barrier_held (void)
1455 if (vlib_get_n_threads () < 2)
1458 return (*vlib_worker_threads->wait_at_barrier == 1);
1462 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm, const char *func_name)
1469 f64 max_vector_rate;
1473 if (vlib_get_n_threads () < 2)
1476 ASSERT (vlib_get_thread_index () == 0);
1478 vlib_worker_threads[0].barrier_caller = func_name;
1479 count = vlib_get_n_threads () - 1;
1481 /* Record entry relative to last close */
1482 now = vlib_time_now (vm);
1483 t_entry = now - vm->barrier_epoch;
1485 /* Tolerate recursive calls */
1486 if (++vlib_worker_threads[0].recursion_level > 1)
1488 barrier_trace_sync_rec (t_entry);
1492 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1493 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1494 vm->clib_time.last_cpu_time, 0 /* enter */ );
1497 * Need data to decide if we're working hard enough to honor
1498 * the barrier hold-down timer.
1500 max_vector_rate = 0.0;
1501 for (i = 1; i < vlib_get_n_threads (); i++)
1503 vlib_main_t *ovm = vlib_get_main_by_index (i);
1504 max_vector_rate = clib_max (max_vector_rate,
1505 (f64) vlib_last_vectors_per_main_loop (ovm));
1508 vlib_worker_threads[0].barrier_sync_count++;
1510 /* Enforce minimum barrier open time to minimize packet loss */
1511 ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1514 * If any worker thread seems busy, which we define
1515 * as a vector rate above 10, we enforce the barrier hold-down timer
1517 if (max_vector_rate > 10.0)
1521 now = vlib_time_now (vm);
1522 /* Barrier hold-down timer expired? */
1523 if (now >= vm->barrier_no_close_before)
1525 if ((vm->barrier_no_close_before - now)
1526 > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1529 ("clock change: would have waited for %.4f seconds",
1530 (vm->barrier_no_close_before - now));
1535 /* Record time of closure */
1536 t_open = now - vm->barrier_epoch;
1537 vm->barrier_epoch = now;
1539 deadline = now + BARRIER_SYNC_TIMEOUT;
1541 *vlib_worker_threads->wait_at_barrier = 1;
1542 while (*vlib_worker_threads->workers_at_barrier != count)
1544 if ((now = vlib_time_now (vm)) > deadline)
1546 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1551 t_closed = now - vm->barrier_epoch;
1553 barrier_trace_sync (t_entry, t_open, t_closed);
1558 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1565 f64 t_update_main = 0.0;
1566 int refork_needed = 0;
1568 if (vlib_get_n_threads () < 2)
1571 ASSERT (vlib_get_thread_index () == 0);
1574 now = vlib_time_now (vm);
1575 t_entry = now - vm->barrier_epoch;
1577 if (--vlib_worker_threads[0].recursion_level > 0)
1579 barrier_trace_release_rec (t_entry);
1583 /* Update (all) node runtimes before releasing the barrier, if needed */
1584 if (vm->need_vlib_worker_thread_node_runtime_update)
1587 * Lock stat segment here, so we's safe when
1588 * rebuilding the stat segment node clones from the
1591 vlib_stat_segment_lock ();
1593 /* Do stats elements on main thread */
1594 worker_thread_node_runtime_update_internal ();
1595 vm->need_vlib_worker_thread_node_runtime_update = 0;
1597 /* Do per thread rebuilds in parallel */
1599 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1600 (vlib_get_n_threads () - 1));
1601 now = vlib_time_now (vm);
1602 t_update_main = now - vm->barrier_epoch;
1605 deadline = now + BARRIER_SYNC_TIMEOUT;
1608 * Note when we let go of the barrier.
1609 * Workers can use this to derive a reasonably accurate
1610 * time offset. See vlib_time_now(...)
1612 vm->time_last_barrier_release = vlib_time_now (vm);
1613 CLIB_MEMORY_STORE_BARRIER ();
1615 *vlib_worker_threads->wait_at_barrier = 0;
1617 while (*vlib_worker_threads->workers_at_barrier > 0)
1619 if ((now = vlib_time_now (vm)) > deadline)
1621 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1626 /* Wait for reforks before continuing */
1629 now = vlib_time_now (vm);
1631 deadline = now + BARRIER_SYNC_TIMEOUT;
1633 while (*vlib_worker_threads->node_reforks_required > 0)
1635 if ((now = vlib_time_now (vm)) > deadline)
1637 fformat (stderr, "%s: worker thread refork deadlock\n",
1642 vlib_stat_segment_unlock ();
1645 t_closed_total = now - vm->barrier_epoch;
1647 minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1649 if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1651 minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1654 vm->barrier_no_close_before = now + minimum_open;
1656 /* Record barrier epoch (used to enforce minimum open time) */
1657 vm->barrier_epoch = now;
1659 barrier_trace_release (t_entry, t_closed_total, t_update_main);
1661 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1662 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1663 vm->clib_time.last_cpu_time, 1 /* leave */ );
1667 * Wait until each of the workers has been once around the track
1670 vlib_worker_wait_one_loop (void)
1672 ASSERT (vlib_get_thread_index () == 0);
1674 if (vlib_get_n_threads () < 2)
1677 if (vlib_worker_thread_barrier_held ())
1683 vec_validate (counts, vlib_get_n_threads () - 1);
1685 /* record the current loop counts */
1686 vec_foreach_index (ii, vlib_mains)
1687 counts[ii] = vlib_mains[ii]->main_loop_count;
1689 /* spin until each changes, apart from the main thread, or we'd be
1691 for (ii = 1; ii < vec_len (counts); ii++)
1693 while (counts[ii] == vlib_mains[ii]->main_loop_count)
1702 * Check the frame queue to see if any frames are available.
1703 * If so, pull the packets off the frames and put them to
1707 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm)
1709 u32 thread_id = vm->thread_index;
1710 vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1711 vlib_frame_queue_elt_t *elt;
1720 ASSERT (vm == vlib_mains[thread_id]);
1722 if (PREDICT_FALSE (fqm->node_index == ~0))
1725 * Gather trace data for frame queues
1727 if (PREDICT_FALSE (fq->trace))
1729 frame_queue_trace_t *fqt;
1730 frame_queue_nelt_counter_t *fqh;
1733 fqt = &fqm->frame_queue_traces[thread_id];
1735 fqt->nelts = fq->nelts;
1736 fqt->head = fq->head;
1737 fqt->head_hint = fq->head_hint;
1738 fqt->tail = fq->tail;
1739 fqt->threshold = fq->vector_threshold;
1740 fqt->n_in_use = fqt->tail - fqt->head;
1741 if (fqt->n_in_use >= fqt->nelts)
1743 // if beyond max then use max
1744 fqt->n_in_use = fqt->nelts - 1;
1747 /* Record the number of elements in use in the histogram */
1748 fqh = &fqm->frame_queue_histogram[thread_id];
1749 fqh->count[fqt->n_in_use]++;
1751 /* Record a snapshot of the elements in use */
1752 for (elix = 0; elix < fqt->nelts; elix++)
1754 elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1755 if (1 || elt->valid)
1757 fqt->n_vectors[elix] = elt->n_vectors;
1766 if (fq->head == fq->tail)
1768 fq->head_hint = fq->head;
1772 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1776 fq->head_hint = fq->head;
1780 from = elt->buffer_index;
1781 msg_type = elt->msg_type;
1783 ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1784 ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1786 f = vlib_get_frame_to_node (vm, fqm->node_index);
1788 /* If the first vector is traced, set the frame trace flag */
1789 b = vlib_get_buffer (vm, from[0]);
1790 if (b->flags & VLIB_BUFFER_IS_TRACED)
1791 f->frame_flags |= VLIB_NODE_FLAG_TRACE;
1793 to = vlib_frame_vector_args (f);
1795 n_left_to_node = elt->n_vectors;
1797 while (n_left_to_node >= 4)
1805 n_left_to_node -= 4;
1808 while (n_left_to_node > 0)
1816 vectors += elt->n_vectors;
1817 f->n_vectors = elt->n_vectors;
1818 vlib_put_frame_to_node (vm, fqm->node_index, f);
1822 elt->msg_type = 0xfefefefe;
1823 CLIB_MEMORY_BARRIER ();
1828 * Limit the number of packets pushed into the graph
1830 if (vectors >= fq->vector_threshold)
1832 fq->head_hint = fq->head;
1841 vlib_worker_thread_fn (void *arg)
1843 vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1844 vlib_thread_main_t *tm = vlib_get_thread_main ();
1845 vlib_main_t *vm = vlib_get_main ();
1848 vlib_process_finish_switch_stack (vm);
1850 ASSERT (vm->thread_index == vlib_get_thread_index ());
1852 vlib_worker_thread_init (w);
1853 clib_time_init (&vm->clib_time);
1854 clib_mem_set_heap (w->thread_mheap);
1856 e = vlib_call_init_exit_functions_no_sort
1857 (vm, &vm->worker_init_function_registrations, 1 /* call_once */ );
1859 clib_error_report (e);
1861 /* Wait until the dpdk init sequence is complete */
1862 while (tm->extern_thread_mgmt && tm->worker_thread_release == 0)
1863 vlib_worker_thread_barrier_check ();
1865 vlib_worker_loop (vm);
1869 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1872 .function = vlib_worker_thread_fn,
1877 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1879 vlib_thread_main_t *tm = vlib_get_thread_main ();
1880 vlib_frame_queue_main_t *fqm;
1881 vlib_frame_queue_t *fq;
1885 if (frame_queue_nelts == 0)
1886 frame_queue_nelts = FRAME_QUEUE_MAX_NELTS;
1888 num_threads = 1 /* main thread */ + tm->n_threads;
1889 ASSERT (frame_queue_nelts >= 8 + num_threads);
1891 vec_add2 (tm->frame_queue_mains, fqm, 1);
1893 fqm->node_index = node_index;
1894 fqm->frame_queue_nelts = frame_queue_nelts;
1895 fqm->queue_hi_thresh = frame_queue_nelts - num_threads;
1897 vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1898 vec_validate (fqm->per_thread_data, tm->n_vlib_mains - 1);
1899 _vec_len (fqm->vlib_frame_queues) = 0;
1900 for (i = 0; i < tm->n_vlib_mains; i++)
1902 vlib_frame_queue_per_thread_data_t *ptd;
1903 fq = vlib_frame_queue_alloc (frame_queue_nelts);
1904 vec_add1 (fqm->vlib_frame_queues, fq);
1906 ptd = vec_elt_at_index (fqm->per_thread_data, i);
1907 vec_validate (ptd->handoff_queue_elt_by_thread_index,
1908 tm->n_vlib_mains - 1);
1909 vec_validate_init_empty (ptd->congested_handoff_queue_by_thread_index,
1910 tm->n_vlib_mains - 1,
1911 (vlib_frame_queue_t *) (~0));
1914 return (fqm - tm->frame_queue_mains);
1918 vlib_thread_cb_register (struct vlib_main_t *vm, vlib_thread_callbacks_t * cb)
1920 vlib_thread_main_t *tm = vlib_get_thread_main ();
1922 if (tm->extern_thread_mgmt)
1925 tm->cb.vlib_launch_thread_cb = cb->vlib_launch_thread_cb;
1926 tm->extern_thread_mgmt = 1;
1931 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1934 ASSERT (vlib_get_thread_index () == 0);
1935 vlib_process_signal_event (vlib_get_main (), args->node_index,
1936 args->type_opaque, args->data);
1939 void *rpc_call_main_thread_cb_fn;
1942 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1944 if (rpc_call_main_thread_cb_fn)
1946 void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1947 (*fp) (callback, args, arg_size);
1950 clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1954 threads_init (vlib_main_t * vm)
1959 VLIB_INIT_FUNCTION (threads_init);
1962 static clib_error_t *
1963 show_clock_command_fn (vlib_main_t * vm,
1964 unformat_input_t * input, vlib_cli_command_t * cmd)
1968 clib_timebase_t _tb, *tb = &_tb;
1970 (void) unformat (input, "verbose %=", &verbose, 1);
1972 clib_timebase_init (tb, 0 /* GMT */ , CLIB_TIMEBASE_DAYLIGHT_NONE,
1975 vlib_cli_output (vm, "%U, %U GMT", format_clib_time, &vm->clib_time,
1976 verbose, format_clib_timebase_time,
1977 clib_timebase_now (tb));
1979 if (vlib_get_n_threads () == 1)
1982 vlib_cli_output (vm, "Time last barrier release %.9f",
1983 vm->time_last_barrier_release);
1985 for (i = 1; i < vlib_get_n_threads (); i++)
1987 vlib_main_t *ovm = vlib_get_main_by_index (i);
1991 vlib_cli_output (vm, "%d: %U", i, format_clib_time, &ovm->clib_time,
1995 vm, "Thread %d offset %.9f error %.9f", i, ovm->time_offset,
1996 vm->time_last_barrier_release - ovm->time_last_barrier_release);
2002 VLIB_CLI_COMMAND (f_command, static) =
2004 .path = "show clock",
2005 .short_help = "show clock",
2006 .function = show_clock_command_fn,
2010 vlib_thread_main_t *
2011 vlib_get_thread_main_not_inline (void)
2013 return vlib_get_thread_main ();
2017 * fd.io coding-style-patch-verification: ON
2020 * eval: (c-set-style "gnu")