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/linux/sysfs.h>
22 #include <vlib/vlib.h>
24 #include <vlib/threads.h>
26 #include <vlib/stat_weak_inlines.h>
34 vlib_worker_thread_t *vlib_worker_threads;
35 vlib_thread_main_t vlib_thread_main;
38 * Barrier tracing can be enabled on a normal build to collect information
39 * on barrier use, including timings and call stacks. Deliberately not
40 * keyed off CLIB_DEBUG, because that can add significant overhead which
41 * imapacts observed timings.
45 barrier_trace_sync (f64 t_entry, f64 t_open, f64 t_closed)
47 if (!vlib_worker_threads->barrier_elog_enabled)
51 ELOG_TYPE_DECLARE (e) =
53 .format = "bar-trace-%s-#%d",
54 .format_args = "T4i4",
59 u32 caller, count, t_entry, t_open, t_closed;
62 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
63 ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
64 ed->caller = elog_string (&vlib_global_main.elog_main,
65 (char *) vlib_worker_threads[0].barrier_caller);
66 ed->t_entry = (int) (1000000.0 * t_entry);
67 ed->t_open = (int) (1000000.0 * t_open);
68 ed->t_closed = (int) (1000000.0 * t_closed);
72 barrier_trace_sync_rec (f64 t_entry)
74 if (!vlib_worker_threads->barrier_elog_enabled)
78 ELOG_TYPE_DECLARE (e) =
80 .format = "bar-syncrec-%s-#%d",
81 .format_args = "T4i4",
89 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
90 ed->depth = (int) vlib_worker_threads[0].recursion_level - 1;
91 ed->caller = elog_string (&vlib_global_main.elog_main,
92 (char *) vlib_worker_threads[0].barrier_caller);
96 barrier_trace_release_rec (f64 t_entry)
98 if (!vlib_worker_threads->barrier_elog_enabled)
102 ELOG_TYPE_DECLARE (e) =
104 .format = "bar-relrrec-#%d",
113 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
114 ed->depth = (int) vlib_worker_threads[0].recursion_level;
118 barrier_trace_release (f64 t_entry, f64 t_closed_total, f64 t_update_main)
120 if (!vlib_worker_threads->barrier_elog_enabled)
124 ELOG_TYPE_DECLARE (e) =
126 .format = "bar-rel-#%d-e%d-u%d-t%d",
127 .format_args = "i4i4i4i4",
132 u32 count, t_entry, t_update_main, t_closed_total;
135 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
136 ed->t_entry = (int) (1000000.0 * t_entry);
137 ed->t_update_main = (int) (1000000.0 * t_update_main);
138 ed->t_closed_total = (int) (1000000.0 * t_closed_total);
139 ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
141 /* Reset context for next trace */
142 vlib_worker_threads[0].barrier_context = NULL;
146 os_get_nthreads (void)
148 return vec_len (vlib_thread_stacks);
152 vlib_set_thread_name (char *name)
154 int pthread_setname_np (pthread_t __target_thread, const char *__name);
156 pthread_t thread = pthread_self ();
160 rv = pthread_setname_np (thread, name);
162 clib_warning ("pthread_setname_np returned %d", rv);
167 sort_registrations_by_no_clone (void *a0, void *a1)
169 vlib_thread_registration_t **tr0 = a0;
170 vlib_thread_registration_t **tr1 = a1;
172 return ((i32) ((*tr0)->no_data_structure_clone)
173 - ((i32) ((*tr1)->no_data_structure_clone)));
177 clib_sysfs_list_to_bitmap (char *filename)
182 fp = fopen (filename, "r");
187 vec_validate (buffer, 256 - 1);
188 if (fgets ((char *) buffer, 256, fp))
191 unformat_init_string (&in, (char *) buffer,
192 strlen ((char *) buffer));
193 if (unformat (&in, "%U", unformat_bitmap_list, &r) != 1)
194 clib_warning ("unformat_bitmap_list failed");
204 /* Called early in the init sequence */
207 vlib_thread_init (vlib_main_t * vm)
209 vlib_thread_main_t *tm = &vlib_thread_main;
210 vlib_worker_thread_t *w;
211 vlib_thread_registration_t *tr;
212 u32 n_vlib_mains = 1;
217 /* get bitmaps of active cpu cores and sockets */
218 tm->cpu_core_bitmap =
219 clib_sysfs_list_to_bitmap ("/sys/devices/system/cpu/online");
220 tm->cpu_socket_bitmap =
221 clib_sysfs_list_to_bitmap ("/sys/devices/system/node/online");
223 avail_cpu = clib_bitmap_dup (tm->cpu_core_bitmap);
226 for (i = 0; i < tm->skip_cores; i++)
228 uword c = clib_bitmap_first_set (avail_cpu);
230 return clib_error_return (0, "no available cpus to skip");
232 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
235 /* grab cpu for main thread */
236 if (tm->main_lcore == ~0)
238 /* if main-lcore is not set, we try to use lcore 1 */
239 if (clib_bitmap_get (avail_cpu, 1))
242 tm->main_lcore = clib_bitmap_first_set (avail_cpu);
243 if (tm->main_lcore == (u8) ~ 0)
244 return clib_error_return (0, "no available cpus to be used for the"
249 if (clib_bitmap_get (avail_cpu, tm->main_lcore) == 0)
250 return clib_error_return (0, "cpu %u is not available to be used"
251 " for the main thread", tm->main_lcore);
253 avail_cpu = clib_bitmap_set (avail_cpu, tm->main_lcore, 0);
255 /* assume that there is socket 0 only if there is no data from sysfs */
256 if (!tm->cpu_socket_bitmap)
257 tm->cpu_socket_bitmap = clib_bitmap_set (0, 0, 1);
259 /* pin main thread to main_lcore */
260 if (tm->cb.vlib_thread_set_lcore_cb)
262 tm->cb.vlib_thread_set_lcore_cb (0, tm->main_lcore);
268 CPU_SET (tm->main_lcore, &cpuset);
269 pthread_setaffinity_np (pthread_self (), sizeof (cpu_set_t), &cpuset);
272 /* Set up thread 0 */
273 vec_validate_aligned (vlib_worker_threads, 0, CLIB_CACHE_LINE_BYTES);
274 _vec_len (vlib_worker_threads) = 1;
275 w = vlib_worker_threads;
276 w->thread_mheap = clib_mem_get_heap ();
277 w->thread_stack = vlib_thread_stacks[0];
278 w->cpu_id = tm->main_lcore;
279 w->lwp = syscall (SYS_gettid);
280 w->thread_id = pthread_self ();
281 tm->n_vlib_mains = 1;
283 vlib_get_thread_core_numa (w, w->cpu_id);
285 if (tm->sched_policy != ~0)
287 struct sched_param sched_param;
288 if (!sched_getparam (w->lwp, &sched_param))
290 if (tm->sched_priority != ~0)
291 sched_param.sched_priority = tm->sched_priority;
292 sched_setscheduler (w->lwp, tm->sched_policy, &sched_param);
296 /* assign threads to cores and set n_vlib_mains */
301 vec_add1 (tm->registrations, tr);
305 vec_sort_with_function (tm->registrations, sort_registrations_by_no_clone);
307 for (i = 0; i < vec_len (tm->registrations); i++)
310 tr = tm->registrations[i];
311 tr->first_index = first_index;
312 first_index += tr->count;
313 n_vlib_mains += (tr->no_data_structure_clone == 0) ? tr->count : 0;
315 /* construct coremask */
316 if (tr->use_pthreads || !tr->count)
323 clib_bitmap_foreach (c, tr->coremask) {
324 if (clib_bitmap_get(avail_cpu, c) == 0)
325 return clib_error_return (0, "cpu %u is not available to be used"
326 " for the '%s' thread",c, tr->name);
328 avail_cpu = clib_bitmap_set(avail_cpu, c, 0);
334 for (j = 0; j < tr->count; j++)
336 /* Do not use CPU 0 by default - leave it to the host and IRQs */
337 uword avail_c0 = clib_bitmap_get (avail_cpu, 0);
338 avail_cpu = clib_bitmap_set (avail_cpu, 0, 0);
340 uword c = clib_bitmap_first_set (avail_cpu);
341 /* Use CPU 0 as a last resort */
342 if (c == ~0 && avail_c0)
349 return clib_error_return (0,
350 "no available cpus to be used for"
351 " the '%s' thread", tr->name);
353 avail_cpu = clib_bitmap_set (avail_cpu, 0, avail_c0);
354 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
355 tr->coremask = clib_bitmap_set (tr->coremask, c, 1);
360 clib_bitmap_free (avail_cpu);
362 tm->n_vlib_mains = n_vlib_mains;
365 * Allocate the remaining worker threads, and thread stack vector slots
366 * from now on, calls to os_get_nthreads() will return the correct
369 vec_validate_aligned (vlib_worker_threads, first_index - 1,
370 CLIB_CACHE_LINE_BYTES);
371 vec_validate (vlib_thread_stacks, vec_len (vlib_worker_threads) - 1);
376 vlib_frame_queue_alloc (int nelts)
378 vlib_frame_queue_t *fq;
380 fq = clib_mem_alloc_aligned (sizeof (*fq), CLIB_CACHE_LINE_BYTES);
381 clib_memset (fq, 0, sizeof (*fq));
383 fq->vector_threshold = 128; // packets
384 vec_validate_aligned (fq->elts, nelts - 1, CLIB_CACHE_LINE_BYTES);
388 if (((uword) & fq->tail) & (CLIB_CACHE_LINE_BYTES - 1))
389 fformat (stderr, "WARNING: fq->tail unaligned\n");
390 if (((uword) & fq->head) & (CLIB_CACHE_LINE_BYTES - 1))
391 fformat (stderr, "WARNING: fq->head unaligned\n");
392 if (((uword) fq->elts) & (CLIB_CACHE_LINE_BYTES - 1))
393 fformat (stderr, "WARNING: fq->elts unaligned\n");
395 if (sizeof (fq->elts[0]) % CLIB_CACHE_LINE_BYTES)
396 fformat (stderr, "WARNING: fq->elts[0] size %d\n",
397 sizeof (fq->elts[0]));
398 if (nelts & (nelts - 1))
400 fformat (stderr, "FATAL: nelts MUST be a power of 2\n");
408 void vl_msg_api_handler_no_free (void *) __attribute__ ((weak));
410 vl_msg_api_handler_no_free (void *v)
414 /* Turned off, save as reference material... */
417 vlib_frame_queue_dequeue_internal (int thread_id,
418 vlib_main_t * vm, vlib_node_main_t * nm)
420 vlib_frame_queue_t *fq = vlib_frame_queues[thread_id];
421 vlib_frame_queue_elt_t *elt;
423 vlib_pending_frame_t *p;
424 vlib_node_runtime_t *r;
425 u32 node_runtime_index;
430 ASSERT (vm == vlib_mains[thread_id]);
434 if (fq->head == fq->tail)
437 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
442 before = clib_cpu_time_now ();
445 node_runtime_index = elt->node_runtime_index;
446 msg_type = elt->msg_type;
450 case VLIB_FRAME_QUEUE_ELT_FREE_BUFFERS:
451 vlib_buffer_free (vm, vlib_frame_vector_args (f), f->n_vectors);
452 /* note fallthrough... */
453 case VLIB_FRAME_QUEUE_ELT_FREE_FRAME:
454 r = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
456 vlib_frame_free (vm, r, f);
458 case VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME:
459 vec_add2 (vm->node_main.pending_frames, p, 1);
460 f->flags |= (VLIB_FRAME_PENDING | VLIB_FRAME_FREE_AFTER_DISPATCH);
461 p->node_runtime_index = elt->node_runtime_index;
462 p->frame_index = vlib_frame_index (vm, f);
463 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
464 fq->dequeue_vectors += (u64) f->n_vectors;
466 case VLIB_FRAME_QUEUE_ELT_API_MSG:
467 vl_msg_api_handler_no_free (f);
470 clib_warning ("bogus frame queue message, type %d", msg_type);
475 fq->dequeue_ticks += clib_cpu_time_now () - before;
476 CLIB_MEMORY_BARRIER ();
485 vlib_frame_queue_dequeue (int thread_id,
486 vlib_main_t * vm, vlib_node_main_t * nm)
488 return vlib_frame_queue_dequeue_internal (thread_id, vm, nm);
492 vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
493 u32 frame_queue_index, vlib_frame_t * frame,
494 vlib_frame_queue_msg_type_t type)
496 vlib_frame_queue_t *fq = vlib_frame_queues[frame_queue_index];
497 vlib_frame_queue_elt_t *elt;
500 u64 before = clib_cpu_time_now ();
504 new_tail = clib_atomic_add_fetch (&fq->tail, 1);
506 /* Wait until a ring slot is available */
507 while (new_tail >= fq->head + fq->nelts)
509 f64 b4 = vlib_time_now_ticks (vm, before);
510 vlib_worker_thread_barrier_check (vm, b4);
511 /* Bad idea. Dequeue -> enqueue -> dequeue -> trouble */
512 // vlib_frame_queue_dequeue (vm->thread_index, vm, nm);
515 elt = fq->elts + (new_tail & (fq->nelts - 1));
517 /* this would be very bad... */
522 /* Once we enqueue the frame, frame->n_vectors is owned elsewhere... */
523 save_count = frame->n_vectors;
526 elt->node_runtime_index = node_runtime_index;
527 elt->msg_type = type;
528 CLIB_MEMORY_BARRIER ();
535 /* To be called by vlib worker threads upon startup */
537 vlib_worker_thread_init (vlib_worker_thread_t * w)
539 vlib_thread_main_t *tm = vlib_get_thread_main ();
542 * Note: disabling signals in worker threads as follows
543 * prevents the api post-mortem dump scheme from working
547 * pthread_sigmask (SIG_SETMASK, &s, 0);
551 clib_mem_set_heap (w->thread_mheap);
553 if (vec_len (tm->thread_prefix) && w->registration->short_name)
555 w->name = format (0, "%v_%s_%d%c", tm->thread_prefix,
556 w->registration->short_name, w->instance_id, '\0');
557 vlib_set_thread_name ((char *) w->name);
560 if (!w->registration->use_pthreads)
563 /* Initial barrier sync, for both worker and i/o threads */
564 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
566 while (*vlib_worker_threads->wait_at_barrier)
569 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
574 vlib_worker_thread_bootstrap_fn (void *arg)
577 vlib_worker_thread_t *w = arg;
579 w->lwp = syscall (SYS_gettid);
580 w->thread_id = pthread_self ();
582 __os_thread_index = w - vlib_worker_threads;
584 vlib_process_start_switch_stack (vlib_mains[__os_thread_index], 0);
585 rv = (void *) clib_calljmp
586 ((uword (*)(uword)) w->thread_function,
587 (uword) arg, w->thread_stack + VLIB_THREAD_STACK_SIZE);
588 /* NOTREACHED, we hope */
593 vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id)
595 const char *sys_cpu_path = "/sys/devices/system/cpu/cpu";
596 const char *sys_node_path = "/sys/devices/system/node/node";
597 clib_bitmap_t *nbmp = 0, *cbmp = 0;
600 int core_id = -1, numa_id = -1;
602 p = format (p, "%s%u/topology/core_id%c", sys_cpu_path, cpu_id, 0);
603 clib_sysfs_read ((char *) p, "%d", &core_id);
604 vec_reset_length (p);
607 clib_sysfs_read ("/sys/devices/system/node/online", "%U",
608 unformat_bitmap_list, &nbmp);
609 clib_bitmap_foreach (node, nbmp) {
610 p = format (p, "%s%u/cpulist%c", sys_node_path, node, 0);
611 clib_sysfs_read ((char *) p, "%U", unformat_bitmap_list, &cbmp);
612 if (clib_bitmap_get (cbmp, cpu_id))
614 vec_reset_length (cbmp);
615 vec_reset_length (p);
622 w->core_id = core_id;
623 w->numa_id = numa_id;
626 static clib_error_t *
627 vlib_launch_thread_int (void *fp, vlib_worker_thread_t * w, unsigned cpu_id)
629 clib_mem_main_t *mm = &clib_mem_main;
630 vlib_thread_main_t *tm = &vlib_thread_main;
631 void *(*fp_arg) (void *) = fp;
635 vlib_get_thread_core_numa (w, cpu_id);
637 /* Set up NUMA-bound heap if indicated */
638 if (mm->per_numa_mheaps[w->numa_id] == 0)
640 /* If the user requested a NUMA heap, create it... */
641 if (tm->numa_heap_size)
643 clib_mem_set_numa_affinity (w->numa_id, 1 /* force */ );
644 numa_heap = clib_mem_create_heap (0 /* DIY */ , tm->numa_heap_size,
646 "numa %u heap", w->numa_id);
647 clib_mem_set_default_numa_affinity ();
648 mm->per_numa_mheaps[w->numa_id] = numa_heap;
652 /* Or, use the main heap */
653 mm->per_numa_mheaps[w->numa_id] = w->thread_mheap;
657 if (tm->cb.vlib_launch_thread_cb && !w->registration->use_pthreads)
658 return tm->cb.vlib_launch_thread_cb (fp, (void *) w, cpu_id);
664 CPU_SET (cpu_id, &cpuset);
666 if (pthread_create (&worker, NULL /* attr */ , fp_arg, (void *) w))
667 return clib_error_return_unix (0, "pthread_create");
669 if (pthread_setaffinity_np (worker, sizeof (cpu_set_t), &cpuset))
670 return clib_error_return_unix (0, "pthread_setaffinity_np");
676 static clib_error_t *
677 start_workers (vlib_main_t * vm)
680 vlib_worker_thread_t *w;
681 vlib_main_t *vm_clone;
683 vlib_thread_main_t *tm = &vlib_thread_main;
684 vlib_thread_registration_t *tr;
685 vlib_node_runtime_t *rt;
686 u32 n_vlib_mains = tm->n_vlib_mains;
687 u32 worker_thread_index;
688 clib_mem_heap_t *main_heap = clib_mem_get_per_cpu_heap ();
690 vec_reset_length (vlib_worker_threads);
692 /* Set up the main thread */
693 vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
694 w->elog_track.name = "main thread";
695 elog_track_register (&vm->elog_main, &w->elog_track);
697 if (vec_len (tm->thread_prefix))
699 w->name = format (0, "%v_main%c", tm->thread_prefix, '\0');
700 vlib_set_thread_name ((char *) w->name);
704 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
705 vm->elog_main.lock[0] = 0;
707 clib_callback_data_init (&vm->vlib_node_runtime_perf_callbacks,
708 &vm->worker_thread_main_loop_callback_lock);
710 /* Replace hand-crafted length-1 vector with a real vector */
713 vec_validate_aligned (vlib_mains, n_vlib_mains - 1, CLIB_CACHE_LINE_BYTES);
714 _vec_len (vlib_mains) = 0;
715 vec_add1_aligned (vlib_mains, vm, CLIB_CACHE_LINE_BYTES);
717 if (n_vlib_mains > 1)
719 vlib_worker_threads->wait_at_barrier =
720 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
721 vlib_worker_threads->workers_at_barrier =
722 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
724 vlib_worker_threads->node_reforks_required =
725 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
727 /* We'll need the rpc vector lock... */
728 clib_spinlock_init (&vm->pending_rpc_lock);
730 /* Ask for an initial barrier sync */
731 *vlib_worker_threads->workers_at_barrier = 0;
732 *vlib_worker_threads->wait_at_barrier = 1;
734 /* Without update or refork */
735 *vlib_worker_threads->node_reforks_required = 0;
736 vm->need_vlib_worker_thread_node_runtime_update = 0;
739 vm->barrier_epoch = 0;
740 vm->barrier_no_close_before = 0;
742 worker_thread_index = 1;
743 clib_spinlock_init (&vm->worker_thread_main_loop_callback_lock);
745 for (i = 0; i < vec_len (tm->registrations); i++)
747 vlib_node_main_t *nm, *nm_clone;
750 tr = tm->registrations[i];
755 for (k = 0; k < tr->count; k++)
759 vec_add2 (vlib_worker_threads, w, 1);
760 /* Currently unused, may not really work */
762 w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
767 w->thread_mheap = main_heap;
770 vlib_thread_stack_init (w - vlib_worker_threads);
771 w->thread_function = tr->function;
772 w->thread_function_arg = w;
774 w->registration = tr;
777 (char *) format (0, "%s %d", tr->name, k + 1);
778 vec_add1 (w->elog_track.name, 0);
779 elog_track_register (&vm->elog_main, &w->elog_track);
781 if (tr->no_data_structure_clone)
784 /* Fork vlib_global_main et al. Look for bugs here */
785 oldheap = clib_mem_set_heap (w->thread_mheap);
787 vm_clone = clib_mem_alloc_aligned (sizeof (*vm_clone),
788 CLIB_CACHE_LINE_BYTES);
789 clib_memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
791 vm_clone->thread_index = worker_thread_index;
792 vm_clone->heap_base = w->thread_mheap;
793 vm_clone->heap_aligned_base = (void *)
794 (((uword) w->thread_mheap) & ~(VLIB_FRAME_ALIGN - 1));
795 vm_clone->init_functions_called =
796 hash_create (0, /* value bytes */ 0);
797 vm_clone->pending_rpc_requests = 0;
798 vec_validate (vm_clone->pending_rpc_requests, 0);
799 _vec_len (vm_clone->pending_rpc_requests) = 0;
800 clib_memset (&vm_clone->random_buffer, 0,
801 sizeof (vm_clone->random_buffer));
803 (&vm_clone->worker_thread_main_loop_callback_lock);
804 clib_callback_data_init
805 (&vm_clone->vlib_node_runtime_perf_callbacks,
806 &vm_clone->worker_thread_main_loop_callback_lock);
808 nm = &vlib_mains[0]->node_main;
809 nm_clone = &vm_clone->node_main;
810 /* fork next frames array, preserving node runtime indices */
811 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
812 CLIB_CACHE_LINE_BYTES);
813 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
815 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
816 u32 save_node_runtime_index;
819 save_node_runtime_index = nf->node_runtime_index;
820 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
821 vlib_next_frame_init (nf);
822 nf->node_runtime_index = save_node_runtime_index;
823 nf->flags = save_flags;
826 /* fork the frame dispatch queue */
827 nm_clone->pending_frames = 0;
828 vec_validate (nm_clone->pending_frames, 10);
829 _vec_len (nm_clone->pending_frames) = 0;
834 /* Allocate all nodes in single block for speed */
835 n = clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*n));
837 for (j = 0; j < vec_len (nm->nodes); j++)
839 clib_memcpy (n, nm->nodes[j], sizeof (*n));
840 /* none of the copied nodes have enqueue rights given out */
841 n->owner_node_index = VLIB_INVALID_NODE_INDEX;
842 clib_memset (&n->stats_total, 0, sizeof (n->stats_total));
843 clib_memset (&n->stats_last_clear, 0,
844 sizeof (n->stats_last_clear));
845 vec_add1 (nm_clone->nodes, n);
848 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
849 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
850 CLIB_CACHE_LINE_BYTES);
852 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
854 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
855 rt->thread_index = vm_clone->thread_index;
856 /* copy initial runtime_data from node */
857 if (n->runtime_data && n->runtime_data_bytes > 0)
858 clib_memcpy (rt->runtime_data, n->runtime_data,
859 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
860 n->runtime_data_bytes));
863 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
864 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
865 CLIB_CACHE_LINE_BYTES);
866 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
868 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
869 rt->thread_index = vm_clone->thread_index;
870 /* copy initial runtime_data from node */
871 if (n->runtime_data && n->runtime_data_bytes > 0)
872 clib_memcpy (rt->runtime_data, n->runtime_data,
873 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
874 n->runtime_data_bytes));
877 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
878 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
879 CLIB_CACHE_LINE_BYTES);
881 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
883 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
884 rt->thread_index = vm_clone->thread_index;
885 /* copy initial runtime_data from node */
886 if (n->runtime_data && n->runtime_data_bytes > 0)
887 clib_memcpy (rt->runtime_data, n->runtime_data,
888 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
889 n->runtime_data_bytes));
892 nm_clone->processes = vec_dup_aligned (nm->processes,
893 CLIB_CACHE_LINE_BYTES);
895 /* Create per-thread frame freelist */
896 nm_clone->frame_sizes = vec_new (vlib_frame_size_t, 1);
897 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
898 nm_clone->frame_size_hash = hash_create (0, sizeof (uword));
900 nm_clone->node_by_error = nm->node_by_error;
902 /* Packet trace buffers are guaranteed to be empty, nothing to do here */
904 clib_mem_set_heap (oldheap);
905 vec_add1_aligned (vlib_mains, vm_clone, CLIB_CACHE_LINE_BYTES);
907 /* Switch to the stats segment ... */
908 void *oldheap = vlib_stats_push_heap (0);
909 vm_clone->error_main.counters = vec_dup_aligned
910 (vlib_mains[0]->error_main.counters, CLIB_CACHE_LINE_BYTES);
911 vlib_stats_pop_heap2 (vm_clone->error_main.counters,
912 worker_thread_index, oldheap, 1);
914 vm_clone->error_main.counters_last_clear = vec_dup_aligned
915 (vlib_mains[0]->error_main.counters_last_clear,
916 CLIB_CACHE_LINE_BYTES);
918 worker_thread_index++;
924 /* only have non-data-structure copy threads to create... */
925 for (i = 0; i < vec_len (tm->registrations); i++)
927 tr = tm->registrations[i];
929 for (j = 0; j < tr->count; j++)
931 vec_add2 (vlib_worker_threads, w, 1);
934 w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
940 w->thread_mheap = main_heap;
942 vlib_thread_stack_init (w - vlib_worker_threads);
943 w->thread_function = tr->function;
944 w->thread_function_arg = w;
947 (char *) format (0, "%s %d", tr->name, j + 1);
948 w->registration = tr;
949 vec_add1 (w->elog_track.name, 0);
950 elog_track_register (&vm->elog_main, &w->elog_track);
955 worker_thread_index = 1;
957 for (i = 0; i < vec_len (tm->registrations); i++)
962 tr = tm->registrations[i];
964 if (tr->use_pthreads || tm->use_pthreads)
966 for (j = 0; j < tr->count; j++)
968 w = vlib_worker_threads + worker_thread_index++;
969 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
972 clib_error_report (err);
979 clib_bitmap_foreach (c, tr->coremask) {
980 w = vlib_worker_threads + worker_thread_index++;
981 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
984 clib_error_report (err);
989 vlib_worker_thread_barrier_sync (vm);
990 vlib_worker_thread_barrier_release (vm);
994 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
998 worker_thread_node_runtime_update_internal (void)
1002 vlib_node_main_t *nm, *nm_clone;
1003 vlib_main_t *vm_clone;
1004 vlib_node_runtime_t *rt;
1006 vlib_node_runtime_sync_stats (vlib_main_t * vm,
1007 vlib_node_runtime_t * r,
1009 uword n_vectors, uword n_clocks);
1011 ASSERT (vlib_get_thread_index () == 0);
1014 nm = &vm->node_main;
1016 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
1019 * Scrape all runtime stats, so we don't lose node runtime(s) with
1020 * pending counts, or throw away worker / io thread counts.
1022 for (j = 0; j < vec_len (nm->nodes); j++)
1026 vlib_node_sync_stats (vm, n);
1029 for (i = 1; i < vec_len (vlib_mains); i++)
1033 vm_clone = vlib_mains[i];
1034 nm_clone = &vm_clone->node_main;
1036 for (j = 0; j < vec_len (nm_clone->nodes); j++)
1038 n = nm_clone->nodes[j];
1040 rt = vlib_node_get_runtime (vm_clone, n->index);
1041 vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
1045 /* Per-worker clone rebuilds are now done on each thread */
1050 vlib_worker_thread_node_refork (void)
1052 vlib_main_t *vm, *vm_clone;
1053 vlib_node_main_t *nm, *nm_clone;
1054 vlib_node_t **old_nodes_clone;
1055 vlib_node_runtime_t *rt, *old_rt;
1057 vlib_node_t *new_n_clone;
1062 nm = &vm->node_main;
1063 vm_clone = vlib_get_main ();
1064 nm_clone = &vm_clone->node_main;
1066 /* Re-clone error heap */
1067 u64 *old_counters = vm_clone->error_main.counters;
1068 u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
1070 clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
1071 sizeof (vm->error_main));
1072 j = vec_len (vm->error_main.counters) - 1;
1074 /* Switch to the stats segment ... */
1075 void *oldheap = vlib_stats_push_heap (0);
1076 vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
1077 vm_clone->error_main.counters = old_counters;
1078 vlib_stats_pop_heap2 (vm_clone->error_main.counters, vm_clone->thread_index,
1081 vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
1082 vm_clone->error_main.counters_last_clear = old_counters_all_clear;
1084 nm_clone = &vm_clone->node_main;
1085 vec_free (nm_clone->next_frames);
1086 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
1087 CLIB_CACHE_LINE_BYTES);
1089 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
1091 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
1092 u32 save_node_runtime_index;
1095 save_node_runtime_index = nf->node_runtime_index;
1096 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
1097 vlib_next_frame_init (nf);
1098 nf->node_runtime_index = save_node_runtime_index;
1099 nf->flags = save_flags;
1102 old_nodes_clone = nm_clone->nodes;
1103 nm_clone->nodes = 0;
1107 /* Allocate all nodes in single block for speed */
1109 clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
1110 for (j = 0; j < vec_len (nm->nodes); j++)
1112 vlib_node_t *new_n = nm->nodes[j];
1114 clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
1115 /* none of the copied nodes have enqueue rights given out */
1116 new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
1118 if (j >= vec_len (old_nodes_clone))
1120 /* new node, set to zero */
1121 clib_memset (&new_n_clone->stats_total, 0,
1122 sizeof (new_n_clone->stats_total));
1123 clib_memset (&new_n_clone->stats_last_clear, 0,
1124 sizeof (new_n_clone->stats_last_clear));
1128 vlib_node_t *old_n_clone = old_nodes_clone[j];
1129 /* Copy stats if the old data is valid */
1130 clib_memcpy_fast (&new_n_clone->stats_total,
1131 &old_n_clone->stats_total,
1132 sizeof (new_n_clone->stats_total));
1133 clib_memcpy_fast (&new_n_clone->stats_last_clear,
1134 &old_n_clone->stats_last_clear,
1135 sizeof (new_n_clone->stats_last_clear));
1137 /* keep previous node state */
1138 new_n_clone->state = old_n_clone->state;
1140 vec_add1 (nm_clone->nodes, new_n_clone);
1143 /* Free the old node clones */
1144 clib_mem_free (old_nodes_clone[0]);
1146 vec_free (old_nodes_clone);
1149 /* re-clone internal nodes */
1150 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
1151 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
1152 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1153 CLIB_CACHE_LINE_BYTES);
1155 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
1157 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1158 rt->thread_index = vm_clone->thread_index;
1159 /* copy runtime_data, will be overwritten later for existing rt */
1160 if (n->runtime_data && n->runtime_data_bytes > 0)
1161 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1162 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1163 n->runtime_data_bytes));
1166 for (j = 0; j < vec_len (old_rt); j++)
1168 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1169 rt->state = old_rt[j].state;
1170 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1171 VLIB_NODE_RUNTIME_DATA_SIZE);
1176 /* re-clone input nodes */
1177 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1178 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1179 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1180 CLIB_CACHE_LINE_BYTES);
1182 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1184 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1185 rt->thread_index = vm_clone->thread_index;
1186 /* copy runtime_data, will be overwritten later for existing rt */
1187 if (n->runtime_data && n->runtime_data_bytes > 0)
1188 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1189 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1190 n->runtime_data_bytes));
1193 for (j = 0; j < vec_len (old_rt); j++)
1195 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1196 rt->state = old_rt[j].state;
1197 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1198 VLIB_NODE_RUNTIME_DATA_SIZE);
1203 /* re-clone pre-input nodes */
1204 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT];
1205 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
1206 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
1207 CLIB_CACHE_LINE_BYTES);
1209 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1211 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1212 rt->thread_index = vm_clone->thread_index;
1213 /* copy runtime_data, will be overwritten later for existing rt */
1214 if (n->runtime_data && n->runtime_data_bytes > 0)
1215 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1216 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1217 n->runtime_data_bytes));
1220 for (j = 0; j < vec_len (old_rt); j++)
1222 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1223 rt->state = old_rt[j].state;
1224 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1225 VLIB_NODE_RUNTIME_DATA_SIZE);
1230 nm_clone->processes = vec_dup_aligned (nm->processes,
1231 CLIB_CACHE_LINE_BYTES);
1232 nm_clone->node_by_error = nm->node_by_error;
1236 vlib_worker_thread_node_runtime_update (void)
1239 * Make a note that we need to do a node runtime update
1240 * prior to releasing the barrier.
1242 vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1246 unformat_sched_policy (unformat_input_t * input, va_list * args)
1248 u32 *r = va_arg (*args, u32 *);
1251 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1252 foreach_sched_policy
1259 static clib_error_t *
1260 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1262 vlib_thread_registration_t *tr;
1264 vlib_thread_main_t *tm = &vlib_thread_main;
1269 tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1271 tm->n_thread_stacks = 1; /* account for main thread */
1272 tm->sched_policy = ~0;
1273 tm->sched_priority = ~0;
1274 tm->main_lcore = ~0;
1280 hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1284 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1286 if (unformat (input, "use-pthreads"))
1287 tm->use_pthreads = 1;
1288 else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1290 else if (unformat (input, "main-core %u", &tm->main_lcore))
1292 else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1294 else if (unformat (input, "numa-heap-size %U",
1295 unformat_memory_size, &tm->numa_heap_size))
1297 else if (unformat (input, "coremask-%s %U", &name,
1298 unformat_bitmap_mask, &bitmap) ||
1299 unformat (input, "corelist-%s %U", &name,
1300 unformat_bitmap_list, &bitmap))
1302 p = hash_get_mem (tm->thread_registrations_by_name, name);
1304 return clib_error_return (0, "no such thread type '%s'", name);
1306 tr = (vlib_thread_registration_t *) p[0];
1308 if (tr->use_pthreads)
1309 return clib_error_return (0,
1310 "corelist cannot be set for '%s' threads",
1313 return clib_error_return
1314 (0, "core placement of '%s' threads is already configured",
1317 tr->coremask = bitmap;
1318 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1322 (input, "scheduler-policy %U", unformat_sched_policy,
1325 else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1327 else if (unformat (input, "%s %u", &name, &count))
1329 p = hash_get_mem (tm->thread_registrations_by_name, name);
1331 return clib_error_return (0, "no such thread type 3 '%s'", name);
1333 tr = (vlib_thread_registration_t *) p[0];
1335 if (tr->fixed_count)
1336 return clib_error_return
1337 (0, "number of '%s' threads not configurable", name);
1339 return clib_error_return
1340 (0, "number of '%s' threads is already configured", name);
1348 if (tm->sched_priority != ~0)
1350 if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1352 u32 prio_max = sched_get_priority_max (tm->sched_policy);
1353 u32 prio_min = sched_get_priority_min (tm->sched_policy);
1354 if (tm->sched_priority > prio_max)
1355 tm->sched_priority = prio_max;
1356 if (tm->sched_priority < prio_min)
1357 tm->sched_priority = prio_min;
1361 return clib_error_return
1363 "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1364 tm->sched_priority);
1369 if (!tm->thread_prefix)
1370 tm->thread_prefix = format (0, "vpp");
1374 tm->n_thread_stacks += tr->count;
1375 tm->n_pthreads += tr->count * tr->use_pthreads;
1376 tm->n_threads += tr->count * (tr->use_pthreads == 0);
1383 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1385 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1387 vnet_main_fixup (vlib_fork_fixup_t which)
1392 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1394 vlib_main_t *vm = vlib_get_main ();
1396 if (vlib_mains == 0)
1399 ASSERT (vlib_get_thread_index () == 0);
1400 vlib_worker_thread_barrier_sync (vm);
1404 case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1405 vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1411 vlib_worker_thread_barrier_release (vm);
1415 * Enforce minimum open time to minimize packet loss due to Rx overflow,
1416 * based on a test based heuristic that barrier should be open for at least
1417 * 3 time as long as it is closed (with an upper bound of 1ms because by that
1418 * point it is probably too late to make a difference)
1421 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1422 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1425 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1426 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1430 vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm)
1433 f64 now = vlib_time_now (vm);
1434 u32 count = vec_len (vlib_mains) - 1;
1436 /* No worker threads? */
1440 deadline = now + BARRIER_SYNC_TIMEOUT;
1441 *vlib_worker_threads->wait_at_barrier = 1;
1442 while (*vlib_worker_threads->workers_at_barrier != count)
1444 if ((now = vlib_time_now (vm)) > deadline)
1446 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1451 *vlib_worker_threads->wait_at_barrier = 0;
1455 * Return true if the wroker thread barrier is held
1458 vlib_worker_thread_barrier_held (void)
1460 if (vec_len (vlib_mains) < 2)
1463 return (*vlib_worker_threads->wait_at_barrier == 1);
1467 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm, const char *func_name)
1474 f64 max_vector_rate;
1478 if (vec_len (vlib_mains) < 2)
1481 ASSERT (vlib_get_thread_index () == 0);
1483 vlib_worker_threads[0].barrier_caller = func_name;
1484 count = vec_len (vlib_mains) - 1;
1486 /* Record entry relative to last close */
1487 now = vlib_time_now (vm);
1488 t_entry = now - vm->barrier_epoch;
1490 /* Tolerate recursive calls */
1491 if (++vlib_worker_threads[0].recursion_level > 1)
1493 barrier_trace_sync_rec (t_entry);
1497 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1498 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1499 vm->clib_time.last_cpu_time, 0 /* enter */ );
1502 * Need data to decide if we're working hard enough to honor
1503 * the barrier hold-down timer.
1505 max_vector_rate = 0.0;
1506 for (i = 1; i < vec_len (vlib_mains); i++)
1508 clib_max (max_vector_rate,
1509 (f64) vlib_last_vectors_per_main_loop (vlib_mains[i]));
1511 vlib_worker_threads[0].barrier_sync_count++;
1513 /* Enforce minimum barrier open time to minimize packet loss */
1514 ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1517 * If any worker thread seems busy, which we define
1518 * as a vector rate above 10, we enforce the barrier hold-down timer
1520 if (max_vector_rate > 10.0)
1524 now = vlib_time_now (vm);
1525 /* Barrier hold-down timer expired? */
1526 if (now >= vm->barrier_no_close_before)
1528 if ((vm->barrier_no_close_before - now)
1529 > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1532 ("clock change: would have waited for %.4f seconds",
1533 (vm->barrier_no_close_before - now));
1538 /* Record time of closure */
1539 t_open = now - vm->barrier_epoch;
1540 vm->barrier_epoch = now;
1542 deadline = now + BARRIER_SYNC_TIMEOUT;
1544 *vlib_worker_threads->wait_at_barrier = 1;
1545 while (*vlib_worker_threads->workers_at_barrier != count)
1547 if ((now = vlib_time_now (vm)) > deadline)
1549 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1554 t_closed = now - vm->barrier_epoch;
1556 barrier_trace_sync (t_entry, t_open, t_closed);
1561 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1568 f64 t_update_main = 0.0;
1569 int refork_needed = 0;
1571 if (vec_len (vlib_mains) < 2)
1574 ASSERT (vlib_get_thread_index () == 0);
1577 now = vlib_time_now (vm);
1578 t_entry = now - vm->barrier_epoch;
1580 if (--vlib_worker_threads[0].recursion_level > 0)
1582 barrier_trace_release_rec (t_entry);
1586 /* Update (all) node runtimes before releasing the barrier, if needed */
1587 if (vm->need_vlib_worker_thread_node_runtime_update)
1590 * Lock stat segment here, so we's safe when
1591 * rebuilding the stat segment node clones from the
1594 vlib_stat_segment_lock ();
1596 /* Do stats elements on main thread */
1597 worker_thread_node_runtime_update_internal ();
1598 vm->need_vlib_worker_thread_node_runtime_update = 0;
1600 /* Do per thread rebuilds in parallel */
1602 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1603 (vec_len (vlib_mains) - 1));
1604 now = vlib_time_now (vm);
1605 t_update_main = now - vm->barrier_epoch;
1608 deadline = now + BARRIER_SYNC_TIMEOUT;
1611 * Note when we let go of the barrier.
1612 * Workers can use this to derive a reasonably accurate
1613 * time offset. See vlib_time_now(...)
1615 vm->time_last_barrier_release = vlib_time_now (vm);
1616 CLIB_MEMORY_STORE_BARRIER ();
1618 *vlib_worker_threads->wait_at_barrier = 0;
1620 while (*vlib_worker_threads->workers_at_barrier > 0)
1622 if ((now = vlib_time_now (vm)) > deadline)
1624 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1629 /* Wait for reforks before continuing */
1632 now = vlib_time_now (vm);
1634 deadline = now + BARRIER_SYNC_TIMEOUT;
1636 while (*vlib_worker_threads->node_reforks_required > 0)
1638 if ((now = vlib_time_now (vm)) > deadline)
1640 fformat (stderr, "%s: worker thread refork deadlock\n",
1645 vlib_stat_segment_unlock ();
1648 t_closed_total = now - vm->barrier_epoch;
1650 minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1652 if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1654 minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1657 vm->barrier_no_close_before = now + minimum_open;
1659 /* Record barrier epoch (used to enforce minimum open time) */
1660 vm->barrier_epoch = now;
1662 barrier_trace_release (t_entry, t_closed_total, t_update_main);
1664 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1665 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1666 vm->clib_time.last_cpu_time, 1 /* leave */ );
1670 * Wait until each of the workers has been once around the track
1673 vlib_worker_wait_one_loop (void)
1675 ASSERT (vlib_get_thread_index () == 0);
1677 if (vec_len (vlib_mains) < 2)
1680 if (vlib_worker_thread_barrier_held ())
1686 vec_validate (counts, vec_len (vlib_mains) - 1);
1688 /* record the current loop counts */
1689 vec_foreach_index (ii, vlib_mains)
1690 counts[ii] = vlib_mains[ii]->main_loop_count;
1692 /* spin until each changes, apart from the main thread, or we'd be
1694 for (ii = 1; ii < vec_len (counts); ii++)
1696 while (counts[ii] == vlib_mains[ii]->main_loop_count)
1705 * Check the frame queue to see if any frames are available.
1706 * If so, pull the packets off the frames and put them to
1710 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm)
1712 u32 thread_id = vm->thread_index;
1713 vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1714 vlib_frame_queue_elt_t *elt;
1723 ASSERT (vm == vlib_mains[thread_id]);
1725 if (PREDICT_FALSE (fqm->node_index == ~0))
1728 * Gather trace data for frame queues
1730 if (PREDICT_FALSE (fq->trace))
1732 frame_queue_trace_t *fqt;
1733 frame_queue_nelt_counter_t *fqh;
1736 fqt = &fqm->frame_queue_traces[thread_id];
1738 fqt->nelts = fq->nelts;
1739 fqt->head = fq->head;
1740 fqt->head_hint = fq->head_hint;
1741 fqt->tail = fq->tail;
1742 fqt->threshold = fq->vector_threshold;
1743 fqt->n_in_use = fqt->tail - fqt->head;
1744 if (fqt->n_in_use >= fqt->nelts)
1746 // if beyond max then use max
1747 fqt->n_in_use = fqt->nelts - 1;
1750 /* Record the number of elements in use in the histogram */
1751 fqh = &fqm->frame_queue_histogram[thread_id];
1752 fqh->count[fqt->n_in_use]++;
1754 /* Record a snapshot of the elements in use */
1755 for (elix = 0; elix < fqt->nelts; elix++)
1757 elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1758 if (1 || elt->valid)
1760 fqt->n_vectors[elix] = elt->n_vectors;
1769 if (fq->head == fq->tail)
1771 fq->head_hint = fq->head;
1775 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1779 fq->head_hint = fq->head;
1783 from = elt->buffer_index;
1784 msg_type = elt->msg_type;
1786 ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1787 ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1789 f = vlib_get_frame_to_node (vm, fqm->node_index);
1791 /* If the first vector is traced, set the frame trace flag */
1792 b = vlib_get_buffer (vm, from[0]);
1793 if (b->flags & VLIB_BUFFER_IS_TRACED)
1794 f->frame_flags |= VLIB_NODE_FLAG_TRACE;
1796 to = vlib_frame_vector_args (f);
1798 n_left_to_node = elt->n_vectors;
1800 while (n_left_to_node >= 4)
1808 n_left_to_node -= 4;
1811 while (n_left_to_node > 0)
1819 vectors += elt->n_vectors;
1820 f->n_vectors = elt->n_vectors;
1821 vlib_put_frame_to_node (vm, fqm->node_index, f);
1825 elt->msg_type = 0xfefefefe;
1826 CLIB_MEMORY_BARRIER ();
1831 * Limit the number of packets pushed into the graph
1833 if (vectors >= fq->vector_threshold)
1835 fq->head_hint = fq->head;
1844 vlib_worker_thread_fn (void *arg)
1846 vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1847 vlib_thread_main_t *tm = vlib_get_thread_main ();
1848 vlib_main_t *vm = vlib_get_main ();
1851 vlib_process_finish_switch_stack (vm);
1853 ASSERT (vm->thread_index == vlib_get_thread_index ());
1855 vlib_worker_thread_init (w);
1856 clib_time_init (&vm->clib_time);
1857 clib_mem_set_heap (w->thread_mheap);
1859 e = vlib_call_init_exit_functions_no_sort
1860 (vm, &vm->worker_init_function_registrations, 1 /* call_once */ );
1862 clib_error_report (e);
1864 /* Wait until the dpdk init sequence is complete */
1865 while (tm->extern_thread_mgmt && tm->worker_thread_release == 0)
1866 vlib_worker_thread_barrier_check ();
1868 vlib_worker_loop (vm);
1872 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1875 .function = vlib_worker_thread_fn,
1880 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1882 vlib_thread_main_t *tm = vlib_get_thread_main ();
1883 vlib_frame_queue_main_t *fqm;
1884 vlib_frame_queue_t *fq;
1888 if (frame_queue_nelts == 0)
1889 frame_queue_nelts = FRAME_QUEUE_MAX_NELTS;
1891 num_threads = 1 /* main thread */ + tm->n_threads;
1892 ASSERT (frame_queue_nelts >= 8 + num_threads);
1894 vec_add2 (tm->frame_queue_mains, fqm, 1);
1896 fqm->node_index = node_index;
1897 fqm->frame_queue_nelts = frame_queue_nelts;
1898 fqm->queue_hi_thresh = frame_queue_nelts - num_threads;
1900 vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1901 vec_validate (fqm->per_thread_data, tm->n_vlib_mains - 1);
1902 _vec_len (fqm->vlib_frame_queues) = 0;
1903 for (i = 0; i < tm->n_vlib_mains; i++)
1905 vlib_frame_queue_per_thread_data_t *ptd;
1906 fq = vlib_frame_queue_alloc (frame_queue_nelts);
1907 vec_add1 (fqm->vlib_frame_queues, fq);
1909 ptd = vec_elt_at_index (fqm->per_thread_data, i);
1910 vec_validate (ptd->handoff_queue_elt_by_thread_index,
1911 tm->n_vlib_mains - 1);
1912 vec_validate_init_empty (ptd->congested_handoff_queue_by_thread_index,
1913 tm->n_vlib_mains - 1,
1914 (vlib_frame_queue_t *) (~0));
1917 return (fqm - tm->frame_queue_mains);
1921 vlib_thread_cb_register (struct vlib_main_t *vm, vlib_thread_callbacks_t * cb)
1923 vlib_thread_main_t *tm = vlib_get_thread_main ();
1925 if (tm->extern_thread_mgmt)
1928 tm->cb.vlib_launch_thread_cb = cb->vlib_launch_thread_cb;
1929 tm->extern_thread_mgmt = 1;
1934 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1937 ASSERT (vlib_get_thread_index () == 0);
1938 vlib_process_signal_event (vlib_get_main (), args->node_index,
1939 args->type_opaque, args->data);
1942 void *rpc_call_main_thread_cb_fn;
1945 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1947 if (rpc_call_main_thread_cb_fn)
1949 void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1950 (*fp) (callback, args, arg_size);
1953 clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1957 threads_init (vlib_main_t * vm)
1962 VLIB_INIT_FUNCTION (threads_init);
1965 static clib_error_t *
1966 show_clock_command_fn (vlib_main_t * vm,
1967 unformat_input_t * input, vlib_cli_command_t * cmd)
1971 clib_timebase_t _tb, *tb = &_tb;
1973 (void) unformat (input, "verbose %=", &verbose, 1);
1975 clib_timebase_init (tb, 0 /* GMT */ , CLIB_TIMEBASE_DAYLIGHT_NONE,
1978 vlib_cli_output (vm, "%U, %U GMT", format_clib_time, &vm->clib_time,
1979 verbose, format_clib_timebase_time,
1980 clib_timebase_now (tb));
1982 if (vec_len (vlib_mains) == 1)
1985 vlib_cli_output (vm, "Time last barrier release %.9f",
1986 vm->time_last_barrier_release);
1988 for (i = 1; i < vec_len (vlib_mains); i++)
1990 if (vlib_mains[i] == 0)
1993 vlib_cli_output (vm, "%d: %U", i, format_clib_time,
1994 &vlib_mains[i]->clib_time, verbose);
1996 vlib_cli_output (vm, "Thread %d offset %.9f error %.9f", i,
1997 vlib_mains[i]->time_offset,
1998 vm->time_last_barrier_release -
1999 vlib_mains[i]->time_last_barrier_release);
2005 VLIB_CLI_COMMAND (f_command, static) =
2007 .path = "show clock",
2008 .short_help = "show clock",
2009 .function = show_clock_command_fn,
2013 vlib_thread_main_t *
2014 vlib_get_thread_main_not_inline (void)
2016 return vlib_get_thread_main ();
2020 * fd.io coding-style-patch-verification: ON
2023 * eval: (c-set-style "gnu")