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 vlib_thread_main_t *tm = &vlib_thread_main;
630 void *(*fp_arg) (void *) = fp;
634 vlib_get_thread_core_numa (w, cpu_id);
636 /* Set up NUMA-bound heap if indicated */
637 if (clib_per_numa_mheaps[w->numa_id] == 0)
639 /* If the user requested a NUMA heap, create it... */
640 if (tm->numa_heap_size)
642 numa_heap = clib_mem_init_thread_safe_numa
643 (0 /* DIY */ , tm->numa_heap_size, w->numa_id);
644 clib_per_numa_mheaps[w->numa_id] = numa_heap;
648 /* Or, use the main heap */
649 clib_per_numa_mheaps[w->numa_id] = w->thread_mheap;
653 if (tm->cb.vlib_launch_thread_cb && !w->registration->use_pthreads)
654 return tm->cb.vlib_launch_thread_cb (fp, (void *) w, cpu_id);
660 CPU_SET (cpu_id, &cpuset);
662 if (pthread_create (&worker, NULL /* attr */ , fp_arg, (void *) w))
663 return clib_error_return_unix (0, "pthread_create");
665 if (pthread_setaffinity_np (worker, sizeof (cpu_set_t), &cpuset))
666 return clib_error_return_unix (0, "pthread_setaffinity_np");
672 static clib_error_t *
673 start_workers (vlib_main_t * vm)
676 vlib_worker_thread_t *w;
677 vlib_main_t *vm_clone;
679 vlib_thread_main_t *tm = &vlib_thread_main;
680 vlib_thread_registration_t *tr;
681 vlib_node_runtime_t *rt;
682 u32 n_vlib_mains = tm->n_vlib_mains;
683 u32 worker_thread_index;
684 u8 *main_heap = clib_mem_get_per_cpu_heap ();
686 vec_reset_length (vlib_worker_threads);
688 /* Set up the main thread */
689 vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
690 w->elog_track.name = "main thread";
691 elog_track_register (&vm->elog_main, &w->elog_track);
693 if (vec_len (tm->thread_prefix))
695 w->name = format (0, "%v_main%c", tm->thread_prefix, '\0');
696 vlib_set_thread_name ((char *) w->name);
700 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
701 vm->elog_main.lock[0] = 0;
703 clib_callback_data_init (&vm->vlib_node_runtime_perf_callbacks,
704 &vm->worker_thread_main_loop_callback_lock);
706 if (n_vlib_mains > 1)
708 /* Replace hand-crafted length-1 vector with a real vector */
711 vec_validate_aligned (vlib_mains, tm->n_vlib_mains - 1,
712 CLIB_CACHE_LINE_BYTES);
713 _vec_len (vlib_mains) = 0;
714 vec_add1_aligned (vlib_mains, vm, CLIB_CACHE_LINE_BYTES);
716 vlib_worker_threads->wait_at_barrier =
717 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
718 vlib_worker_threads->workers_at_barrier =
719 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
721 vlib_worker_threads->node_reforks_required =
722 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
724 /* We'll need the rpc vector lock... */
725 clib_spinlock_init (&vm->pending_rpc_lock);
727 /* Ask for an initial barrier sync */
728 *vlib_worker_threads->workers_at_barrier = 0;
729 *vlib_worker_threads->wait_at_barrier = 1;
731 /* Without update or refork */
732 *vlib_worker_threads->node_reforks_required = 0;
733 vm->need_vlib_worker_thread_node_runtime_update = 0;
736 vm->barrier_epoch = 0;
737 vm->barrier_no_close_before = 0;
739 worker_thread_index = 1;
740 clib_spinlock_init (&vm->worker_thread_main_loop_callback_lock);
742 for (i = 0; i < vec_len (tm->registrations); i++)
744 vlib_node_main_t *nm, *nm_clone;
747 tr = tm->registrations[i];
752 for (k = 0; k < tr->count; k++)
756 vec_add2 (vlib_worker_threads, w, 1);
757 /* Currently unused, may not really work */
759 w->thread_mheap = create_mspace (tr->mheap_size,
762 w->thread_mheap = main_heap;
765 vlib_thread_stack_init (w - vlib_worker_threads);
766 w->thread_function = tr->function;
767 w->thread_function_arg = w;
769 w->registration = tr;
772 (char *) format (0, "%s %d", tr->name, k + 1);
773 vec_add1 (w->elog_track.name, 0);
774 elog_track_register (&vm->elog_main, &w->elog_track);
776 if (tr->no_data_structure_clone)
779 /* Fork vlib_global_main et al. Look for bugs here */
780 oldheap = clib_mem_set_heap (w->thread_mheap);
782 vm_clone = clib_mem_alloc_aligned (sizeof (*vm_clone),
783 CLIB_CACHE_LINE_BYTES);
784 clib_memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
786 vm_clone->thread_index = worker_thread_index;
787 vm_clone->heap_base = w->thread_mheap;
788 vm_clone->heap_aligned_base = (void *)
789 (((uword) w->thread_mheap) & ~(VLIB_FRAME_ALIGN - 1));
790 vm_clone->init_functions_called =
791 hash_create (0, /* value bytes */ 0);
792 vm_clone->pending_rpc_requests = 0;
793 vec_validate (vm_clone->pending_rpc_requests, 0);
794 _vec_len (vm_clone->pending_rpc_requests) = 0;
795 clib_memset (&vm_clone->random_buffer, 0,
796 sizeof (vm_clone->random_buffer));
798 (&vm_clone->worker_thread_main_loop_callback_lock);
799 clib_callback_data_init
800 (&vm_clone->vlib_node_runtime_perf_callbacks,
801 &vm_clone->worker_thread_main_loop_callback_lock);
803 nm = &vlib_mains[0]->node_main;
804 nm_clone = &vm_clone->node_main;
805 /* fork next frames array, preserving node runtime indices */
806 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
807 CLIB_CACHE_LINE_BYTES);
808 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
810 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
811 u32 save_node_runtime_index;
814 save_node_runtime_index = nf->node_runtime_index;
815 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
816 vlib_next_frame_init (nf);
817 nf->node_runtime_index = save_node_runtime_index;
818 nf->flags = save_flags;
821 /* fork the frame dispatch queue */
822 nm_clone->pending_frames = 0;
823 vec_validate (nm_clone->pending_frames, 10);
824 _vec_len (nm_clone->pending_frames) = 0;
829 /* Allocate all nodes in single block for speed */
830 n = clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*n));
832 for (j = 0; j < vec_len (nm->nodes); j++)
834 clib_memcpy (n, nm->nodes[j], sizeof (*n));
835 /* none of the copied nodes have enqueue rights given out */
836 n->owner_node_index = VLIB_INVALID_NODE_INDEX;
837 clib_memset (&n->stats_total, 0, sizeof (n->stats_total));
838 clib_memset (&n->stats_last_clear, 0,
839 sizeof (n->stats_last_clear));
840 vec_add1 (nm_clone->nodes, n);
843 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
844 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
845 CLIB_CACHE_LINE_BYTES);
847 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
849 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
850 rt->thread_index = vm_clone->thread_index;
851 /* copy initial runtime_data from node */
852 if (n->runtime_data && n->runtime_data_bytes > 0)
853 clib_memcpy (rt->runtime_data, n->runtime_data,
854 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
855 n->runtime_data_bytes));
858 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
859 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
860 CLIB_CACHE_LINE_BYTES);
861 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
863 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
864 rt->thread_index = vm_clone->thread_index;
865 /* copy initial runtime_data from node */
866 if (n->runtime_data && n->runtime_data_bytes > 0)
867 clib_memcpy (rt->runtime_data, n->runtime_data,
868 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
869 n->runtime_data_bytes));
872 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
873 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
874 CLIB_CACHE_LINE_BYTES);
876 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
878 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
879 rt->thread_index = vm_clone->thread_index;
880 /* copy initial runtime_data from node */
881 if (n->runtime_data && n->runtime_data_bytes > 0)
882 clib_memcpy (rt->runtime_data, n->runtime_data,
883 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
884 n->runtime_data_bytes));
887 nm_clone->processes = vec_dup_aligned (nm->processes,
888 CLIB_CACHE_LINE_BYTES);
890 /* Create per-thread frame freelist */
891 nm_clone->frame_sizes = vec_new (vlib_frame_size_t, 1);
892 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
893 nm_clone->frame_size_hash = hash_create (0, sizeof (uword));
895 nm_clone->node_by_error = nm->node_by_error;
897 /* Packet trace buffers are guaranteed to be empty, nothing to do here */
899 clib_mem_set_heap (oldheap);
900 vec_add1_aligned (vlib_mains, vm_clone, CLIB_CACHE_LINE_BYTES);
902 /* Switch to the stats segment ... */
903 void *oldheap = vlib_stats_push_heap (0);
904 vm_clone->error_main.counters = vec_dup_aligned
905 (vlib_mains[0]->error_main.counters, CLIB_CACHE_LINE_BYTES);
906 vlib_stats_pop_heap2 (vm_clone->error_main.counters,
907 worker_thread_index, oldheap, 1);
909 vm_clone->error_main.counters_last_clear = vec_dup_aligned
910 (vlib_mains[0]->error_main.counters_last_clear,
911 CLIB_CACHE_LINE_BYTES);
913 worker_thread_index++;
919 /* only have non-data-structure copy threads to create... */
920 for (i = 0; i < vec_len (tm->registrations); i++)
922 tr = tm->registrations[i];
924 for (j = 0; j < tr->count; j++)
926 vec_add2 (vlib_worker_threads, w, 1);
930 create_mspace (tr->mheap_size, 0 /* locked */ );
933 w->thread_mheap = main_heap;
935 vlib_thread_stack_init (w - vlib_worker_threads);
936 w->thread_function = tr->function;
937 w->thread_function_arg = w;
940 (char *) format (0, "%s %d", tr->name, j + 1);
941 w->registration = tr;
942 vec_add1 (w->elog_track.name, 0);
943 elog_track_register (&vm->elog_main, &w->elog_track);
948 worker_thread_index = 1;
950 for (i = 0; i < vec_len (tm->registrations); i++)
955 tr = tm->registrations[i];
957 if (tr->use_pthreads || tm->use_pthreads)
959 for (j = 0; j < tr->count; j++)
961 w = vlib_worker_threads + worker_thread_index++;
962 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
965 clib_error_report (err);
972 clib_bitmap_foreach (c, tr->coremask, ({
973 w = vlib_worker_threads + worker_thread_index++;
974 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
977 clib_error_report (err);
982 vlib_worker_thread_barrier_sync (vm);
983 vlib_worker_thread_barrier_release (vm);
987 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
991 worker_thread_node_runtime_update_internal (void)
995 vlib_node_main_t *nm, *nm_clone;
996 vlib_main_t *vm_clone;
997 vlib_node_runtime_t *rt;
999 vlib_node_runtime_sync_stats (vlib_main_t * vm,
1000 vlib_node_runtime_t * r,
1002 uword n_vectors, uword n_clocks);
1004 ASSERT (vlib_get_thread_index () == 0);
1007 nm = &vm->node_main;
1009 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
1012 * Scrape all runtime stats, so we don't lose node runtime(s) with
1013 * pending counts, or throw away worker / io thread counts.
1015 for (j = 0; j < vec_len (nm->nodes); j++)
1019 vlib_node_sync_stats (vm, n);
1022 for (i = 1; i < vec_len (vlib_mains); i++)
1026 vm_clone = vlib_mains[i];
1027 nm_clone = &vm_clone->node_main;
1029 for (j = 0; j < vec_len (nm_clone->nodes); j++)
1031 n = nm_clone->nodes[j];
1033 rt = vlib_node_get_runtime (vm_clone, n->index);
1034 vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
1038 /* Per-worker clone rebuilds are now done on each thread */
1043 vlib_worker_thread_node_refork (void)
1045 vlib_main_t *vm, *vm_clone;
1046 vlib_node_main_t *nm, *nm_clone;
1047 vlib_node_t **old_nodes_clone;
1048 vlib_node_runtime_t *rt, *old_rt;
1050 vlib_node_t *new_n_clone;
1055 nm = &vm->node_main;
1056 vm_clone = vlib_get_main ();
1057 nm_clone = &vm_clone->node_main;
1059 /* Re-clone error heap */
1060 u64 *old_counters = vm_clone->error_main.counters;
1061 u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
1063 clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
1064 sizeof (vm->error_main));
1065 j = vec_len (vm->error_main.counters) - 1;
1067 /* Switch to the stats segment ... */
1068 void *oldheap = vlib_stats_push_heap (0);
1069 vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
1070 vm_clone->error_main.counters = old_counters;
1071 vlib_stats_pop_heap2 (vm_clone->error_main.counters, vm_clone->thread_index,
1074 vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
1075 vm_clone->error_main.counters_last_clear = old_counters_all_clear;
1077 nm_clone = &vm_clone->node_main;
1078 vec_free (nm_clone->next_frames);
1079 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
1080 CLIB_CACHE_LINE_BYTES);
1082 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
1084 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
1085 u32 save_node_runtime_index;
1088 save_node_runtime_index = nf->node_runtime_index;
1089 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
1090 vlib_next_frame_init (nf);
1091 nf->node_runtime_index = save_node_runtime_index;
1092 nf->flags = save_flags;
1095 old_nodes_clone = nm_clone->nodes;
1096 nm_clone->nodes = 0;
1100 /* Allocate all nodes in single block for speed */
1102 clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
1103 for (j = 0; j < vec_len (nm->nodes); j++)
1105 vlib_node_t *new_n = nm->nodes[j];
1107 clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
1108 /* none of the copied nodes have enqueue rights given out */
1109 new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
1111 if (j >= vec_len (old_nodes_clone))
1113 /* new node, set to zero */
1114 clib_memset (&new_n_clone->stats_total, 0,
1115 sizeof (new_n_clone->stats_total));
1116 clib_memset (&new_n_clone->stats_last_clear, 0,
1117 sizeof (new_n_clone->stats_last_clear));
1121 vlib_node_t *old_n_clone = old_nodes_clone[j];
1122 /* Copy stats if the old data is valid */
1123 clib_memcpy_fast (&new_n_clone->stats_total,
1124 &old_n_clone->stats_total,
1125 sizeof (new_n_clone->stats_total));
1126 clib_memcpy_fast (&new_n_clone->stats_last_clear,
1127 &old_n_clone->stats_last_clear,
1128 sizeof (new_n_clone->stats_last_clear));
1130 /* keep previous node state */
1131 new_n_clone->state = old_n_clone->state;
1133 vec_add1 (nm_clone->nodes, new_n_clone);
1136 /* Free the old node clones */
1137 clib_mem_free (old_nodes_clone[0]);
1139 vec_free (old_nodes_clone);
1142 /* re-clone internal nodes */
1143 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
1144 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
1145 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1146 CLIB_CACHE_LINE_BYTES);
1148 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
1150 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1151 rt->thread_index = vm_clone->thread_index;
1152 /* copy runtime_data, will be overwritten later for existing rt */
1153 if (n->runtime_data && n->runtime_data_bytes > 0)
1154 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1155 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1156 n->runtime_data_bytes));
1159 for (j = 0; j < vec_len (old_rt); j++)
1161 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1162 rt->state = old_rt[j].state;
1163 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1164 VLIB_NODE_RUNTIME_DATA_SIZE);
1169 /* re-clone input nodes */
1170 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1171 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1172 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1173 CLIB_CACHE_LINE_BYTES);
1175 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1177 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1178 rt->thread_index = vm_clone->thread_index;
1179 /* copy runtime_data, will be overwritten later for existing rt */
1180 if (n->runtime_data && n->runtime_data_bytes > 0)
1181 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1182 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1183 n->runtime_data_bytes));
1186 for (j = 0; j < vec_len (old_rt); j++)
1188 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1189 rt->state = old_rt[j].state;
1190 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1191 VLIB_NODE_RUNTIME_DATA_SIZE);
1196 /* re-clone pre-input nodes */
1197 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT];
1198 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
1199 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
1200 CLIB_CACHE_LINE_BYTES);
1202 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1204 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1205 rt->thread_index = vm_clone->thread_index;
1206 /* copy runtime_data, will be overwritten later for existing rt */
1207 if (n->runtime_data && n->runtime_data_bytes > 0)
1208 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1209 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1210 n->runtime_data_bytes));
1213 for (j = 0; j < vec_len (old_rt); j++)
1215 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1216 rt->state = old_rt[j].state;
1217 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1218 VLIB_NODE_RUNTIME_DATA_SIZE);
1223 nm_clone->processes = vec_dup_aligned (nm->processes,
1224 CLIB_CACHE_LINE_BYTES);
1225 nm_clone->node_by_error = nm->node_by_error;
1229 vlib_worker_thread_node_runtime_update (void)
1232 * Make a note that we need to do a node runtime update
1233 * prior to releasing the barrier.
1235 vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1239 unformat_sched_policy (unformat_input_t * input, va_list * args)
1241 u32 *r = va_arg (*args, u32 *);
1244 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1245 foreach_sched_policy
1252 static clib_error_t *
1253 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1255 vlib_thread_registration_t *tr;
1257 vlib_thread_main_t *tm = &vlib_thread_main;
1262 tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1264 tm->n_thread_stacks = 1; /* account for main thread */
1265 tm->sched_policy = ~0;
1266 tm->sched_priority = ~0;
1267 tm->main_lcore = ~0;
1273 hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1277 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1279 if (unformat (input, "use-pthreads"))
1280 tm->use_pthreads = 1;
1281 else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1283 else if (unformat (input, "main-core %u", &tm->main_lcore))
1285 else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1287 else if (unformat (input, "numa-heap-size %U",
1288 unformat_memory_size, &tm->numa_heap_size))
1290 else if (unformat (input, "coremask-%s %U", &name,
1291 unformat_bitmap_mask, &bitmap) ||
1292 unformat (input, "corelist-%s %U", &name,
1293 unformat_bitmap_list, &bitmap))
1295 p = hash_get_mem (tm->thread_registrations_by_name, name);
1297 return clib_error_return (0, "no such thread type '%s'", name);
1299 tr = (vlib_thread_registration_t *) p[0];
1301 if (tr->use_pthreads)
1302 return clib_error_return (0,
1303 "corelist cannot be set for '%s' threads",
1306 return clib_error_return
1307 (0, "core placement of '%s' threads is already configured",
1310 tr->coremask = bitmap;
1311 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1315 (input, "scheduler-policy %U", unformat_sched_policy,
1318 else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1320 else if (unformat (input, "%s %u", &name, &count))
1322 p = hash_get_mem (tm->thread_registrations_by_name, name);
1324 return clib_error_return (0, "no such thread type 3 '%s'", name);
1326 tr = (vlib_thread_registration_t *) p[0];
1328 if (tr->fixed_count)
1329 return clib_error_return
1330 (0, "number of '%s' threads not configurable", name);
1332 return clib_error_return
1333 (0, "number of '%s' threads is already configured", name);
1341 if (tm->sched_priority != ~0)
1343 if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1345 u32 prio_max = sched_get_priority_max (tm->sched_policy);
1346 u32 prio_min = sched_get_priority_min (tm->sched_policy);
1347 if (tm->sched_priority > prio_max)
1348 tm->sched_priority = prio_max;
1349 if (tm->sched_priority < prio_min)
1350 tm->sched_priority = prio_min;
1354 return clib_error_return
1356 "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1357 tm->sched_priority);
1362 if (!tm->thread_prefix)
1363 tm->thread_prefix = format (0, "vpp");
1367 tm->n_thread_stacks += tr->count;
1368 tm->n_pthreads += tr->count * tr->use_pthreads;
1369 tm->n_threads += tr->count * (tr->use_pthreads == 0);
1376 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1378 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1380 vnet_main_fixup (vlib_fork_fixup_t which)
1385 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1387 vlib_main_t *vm = vlib_get_main ();
1389 if (vlib_mains == 0)
1392 ASSERT (vlib_get_thread_index () == 0);
1393 vlib_worker_thread_barrier_sync (vm);
1397 case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1398 vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1404 vlib_worker_thread_barrier_release (vm);
1408 * Enforce minimum open time to minimize packet loss due to Rx overflow,
1409 * based on a test based heuristic that barrier should be open for at least
1410 * 3 time as long as it is closed (with an upper bound of 1ms because by that
1411 * point it is probably too late to make a difference)
1414 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1415 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1418 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1419 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1423 vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm)
1426 f64 now = vlib_time_now (vm);
1427 u32 count = vec_len (vlib_mains) - 1;
1429 /* No worker threads? */
1433 deadline = now + BARRIER_SYNC_TIMEOUT;
1434 *vlib_worker_threads->wait_at_barrier = 1;
1435 while (*vlib_worker_threads->workers_at_barrier != count)
1437 if ((now = vlib_time_now (vm)) > deadline)
1439 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1444 *vlib_worker_threads->wait_at_barrier = 0;
1448 * Return true if the wroker thread barrier is held
1451 vlib_worker_thread_barrier_held (void)
1453 if (vec_len (vlib_mains) < 2)
1456 return (*vlib_worker_threads->wait_at_barrier == 1);
1460 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm, const char *func_name)
1467 f64 max_vector_rate;
1471 if (vec_len (vlib_mains) < 2)
1474 ASSERT (vlib_get_thread_index () == 0);
1476 vlib_worker_threads[0].barrier_caller = func_name;
1477 count = vec_len (vlib_mains) - 1;
1479 /* Record entry relative to last close */
1480 now = vlib_time_now (vm);
1481 t_entry = now - vm->barrier_epoch;
1483 /* Tolerate recursive calls */
1484 if (++vlib_worker_threads[0].recursion_level > 1)
1486 barrier_trace_sync_rec (t_entry);
1490 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1491 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1492 vm->clib_time.last_cpu_time, 0 /* enter */ );
1495 * Need data to decide if we're working hard enough to honor
1496 * the barrier hold-down timer.
1498 max_vector_rate = 0.0;
1499 for (i = 1; i < vec_len (vlib_mains); i++)
1501 clib_max (max_vector_rate,
1502 (f64) vlib_last_vectors_per_main_loop (vlib_mains[i]));
1504 vlib_worker_threads[0].barrier_sync_count++;
1506 /* Enforce minimum barrier open time to minimize packet loss */
1507 ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1510 * If any worker thread seems busy, which we define
1511 * as a vector rate above 10, we enforce the barrier hold-down timer
1513 if (max_vector_rate > 10.0)
1517 now = vlib_time_now (vm);
1518 /* Barrier hold-down timer expired? */
1519 if (now >= vm->barrier_no_close_before)
1521 if ((vm->barrier_no_close_before - now)
1522 > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1525 ("clock change: would have waited for %.4f seconds",
1526 (vm->barrier_no_close_before - now));
1531 /* Record time of closure */
1532 t_open = now - vm->barrier_epoch;
1533 vm->barrier_epoch = now;
1535 deadline = now + BARRIER_SYNC_TIMEOUT;
1537 *vlib_worker_threads->wait_at_barrier = 1;
1538 while (*vlib_worker_threads->workers_at_barrier != count)
1540 if ((now = vlib_time_now (vm)) > deadline)
1542 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1547 t_closed = now - vm->barrier_epoch;
1549 barrier_trace_sync (t_entry, t_open, t_closed);
1554 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1561 f64 t_update_main = 0.0;
1562 int refork_needed = 0;
1564 if (vec_len (vlib_mains) < 2)
1567 ASSERT (vlib_get_thread_index () == 0);
1570 now = vlib_time_now (vm);
1571 t_entry = now - vm->barrier_epoch;
1573 if (--vlib_worker_threads[0].recursion_level > 0)
1575 barrier_trace_release_rec (t_entry);
1579 /* Update (all) node runtimes before releasing the barrier, if needed */
1580 if (vm->need_vlib_worker_thread_node_runtime_update)
1583 * Lock stat segment here, so we's safe when
1584 * rebuilding the stat segment node clones from the
1587 vlib_stat_segment_lock ();
1589 /* Do stats elements on main thread */
1590 worker_thread_node_runtime_update_internal ();
1591 vm->need_vlib_worker_thread_node_runtime_update = 0;
1593 /* Do per thread rebuilds in parallel */
1595 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1596 (vec_len (vlib_mains) - 1));
1597 now = vlib_time_now (vm);
1598 t_update_main = now - vm->barrier_epoch;
1601 deadline = now + BARRIER_SYNC_TIMEOUT;
1604 * Note when we let go of the barrier.
1605 * Workers can use this to derive a reasonably accurate
1606 * time offset. See vlib_time_now(...)
1608 vm->time_last_barrier_release = vlib_time_now (vm);
1609 CLIB_MEMORY_STORE_BARRIER ();
1611 *vlib_worker_threads->wait_at_barrier = 0;
1613 while (*vlib_worker_threads->workers_at_barrier > 0)
1615 if ((now = vlib_time_now (vm)) > deadline)
1617 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1622 /* Wait for reforks before continuing */
1625 now = vlib_time_now (vm);
1627 deadline = now + BARRIER_SYNC_TIMEOUT;
1629 while (*vlib_worker_threads->node_reforks_required > 0)
1631 if ((now = vlib_time_now (vm)) > deadline)
1633 fformat (stderr, "%s: worker thread refork deadlock\n",
1638 vlib_stat_segment_unlock ();
1641 t_closed_total = now - vm->barrier_epoch;
1643 minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1645 if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1647 minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1650 vm->barrier_no_close_before = now + minimum_open;
1652 /* Record barrier epoch (used to enforce minimum open time) */
1653 vm->barrier_epoch = now;
1655 barrier_trace_release (t_entry, t_closed_total, t_update_main);
1657 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1658 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1659 vm->clib_time.last_cpu_time, 1 /* leave */ );
1663 * Wait until each of the workers has been once around the track
1666 vlib_worker_wait_one_loop (void)
1668 ASSERT (vlib_get_thread_index () == 0);
1670 if (vec_len (vlib_mains) < 2)
1673 if (vlib_worker_thread_barrier_held ())
1679 vec_validate (counts, vec_len (vlib_mains) - 1);
1681 /* record the current loop counts */
1682 vec_foreach_index (ii, vlib_mains)
1683 counts[ii] = vlib_mains[ii]->main_loop_count;
1685 /* spin until each changes, apart from the main thread, or we'd be
1687 for (ii = 1; ii < vec_len (counts); ii++)
1689 while (counts[ii] == vlib_mains[ii]->main_loop_count)
1698 * Check the frame queue to see if any frames are available.
1699 * If so, pull the packets off the frames and put them to
1703 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm)
1705 u32 thread_id = vm->thread_index;
1706 vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1707 vlib_frame_queue_elt_t *elt;
1716 ASSERT (vm == vlib_mains[thread_id]);
1718 if (PREDICT_FALSE (fqm->node_index == ~0))
1721 * Gather trace data for frame queues
1723 if (PREDICT_FALSE (fq->trace))
1725 frame_queue_trace_t *fqt;
1726 frame_queue_nelt_counter_t *fqh;
1729 fqt = &fqm->frame_queue_traces[thread_id];
1731 fqt->nelts = fq->nelts;
1732 fqt->head = fq->head;
1733 fqt->head_hint = fq->head_hint;
1734 fqt->tail = fq->tail;
1735 fqt->threshold = fq->vector_threshold;
1736 fqt->n_in_use = fqt->tail - fqt->head;
1737 if (fqt->n_in_use >= fqt->nelts)
1739 // if beyond max then use max
1740 fqt->n_in_use = fqt->nelts - 1;
1743 /* Record the number of elements in use in the histogram */
1744 fqh = &fqm->frame_queue_histogram[thread_id];
1745 fqh->count[fqt->n_in_use]++;
1747 /* Record a snapshot of the elements in use */
1748 for (elix = 0; elix < fqt->nelts; elix++)
1750 elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1751 if (1 || elt->valid)
1753 fqt->n_vectors[elix] = elt->n_vectors;
1762 if (fq->head == fq->tail)
1764 fq->head_hint = fq->head;
1768 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1772 fq->head_hint = fq->head;
1776 from = elt->buffer_index;
1777 msg_type = elt->msg_type;
1779 ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1780 ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1782 f = vlib_get_frame_to_node (vm, fqm->node_index);
1784 /* If the first vector is traced, set the frame trace flag */
1785 b = vlib_get_buffer (vm, from[0]);
1786 if (b->flags & VLIB_BUFFER_IS_TRACED)
1787 f->frame_flags |= VLIB_NODE_FLAG_TRACE;
1789 to = vlib_frame_vector_args (f);
1791 n_left_to_node = elt->n_vectors;
1793 while (n_left_to_node >= 4)
1801 n_left_to_node -= 4;
1804 while (n_left_to_node > 0)
1812 vectors += elt->n_vectors;
1813 f->n_vectors = elt->n_vectors;
1814 vlib_put_frame_to_node (vm, fqm->node_index, f);
1818 elt->msg_type = 0xfefefefe;
1819 CLIB_MEMORY_BARRIER ();
1824 * Limit the number of packets pushed into the graph
1826 if (vectors >= fq->vector_threshold)
1828 fq->head_hint = fq->head;
1837 vlib_worker_thread_fn (void *arg)
1839 vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1840 vlib_thread_main_t *tm = vlib_get_thread_main ();
1841 vlib_main_t *vm = vlib_get_main ();
1844 vlib_process_finish_switch_stack (vm);
1846 ASSERT (vm->thread_index == vlib_get_thread_index ());
1848 vlib_worker_thread_init (w);
1849 clib_time_init (&vm->clib_time);
1850 clib_mem_set_heap (w->thread_mheap);
1852 e = vlib_call_init_exit_functions_no_sort
1853 (vm, &vm->worker_init_function_registrations, 1 /* call_once */ );
1855 clib_error_report (e);
1857 /* Wait until the dpdk init sequence is complete */
1858 while (tm->extern_thread_mgmt && tm->worker_thread_release == 0)
1859 vlib_worker_thread_barrier_check ();
1861 vlib_worker_loop (vm);
1865 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1868 .function = vlib_worker_thread_fn,
1873 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1875 vlib_thread_main_t *tm = vlib_get_thread_main ();
1876 vlib_frame_queue_main_t *fqm;
1877 vlib_frame_queue_t *fq;
1881 if (frame_queue_nelts == 0)
1882 frame_queue_nelts = FRAME_QUEUE_MAX_NELTS;
1884 num_threads = 1 /* main thread */ + tm->n_threads;
1885 ASSERT (frame_queue_nelts >= 8 + num_threads);
1887 vec_add2 (tm->frame_queue_mains, fqm, 1);
1889 fqm->node_index = node_index;
1890 fqm->frame_queue_nelts = frame_queue_nelts;
1891 fqm->queue_hi_thresh = frame_queue_nelts - num_threads;
1893 vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1894 vec_validate (fqm->per_thread_data, tm->n_vlib_mains - 1);
1895 _vec_len (fqm->vlib_frame_queues) = 0;
1896 for (i = 0; i < tm->n_vlib_mains; i++)
1898 vlib_frame_queue_per_thread_data_t *ptd;
1899 fq = vlib_frame_queue_alloc (frame_queue_nelts);
1900 vec_add1 (fqm->vlib_frame_queues, fq);
1902 ptd = vec_elt_at_index (fqm->per_thread_data, i);
1903 vec_validate (ptd->handoff_queue_elt_by_thread_index,
1904 tm->n_vlib_mains - 1);
1905 vec_validate_init_empty (ptd->congested_handoff_queue_by_thread_index,
1906 tm->n_vlib_mains - 1,
1907 (vlib_frame_queue_t *) (~0));
1910 return (fqm - tm->frame_queue_mains);
1914 vlib_thread_cb_register (struct vlib_main_t *vm, vlib_thread_callbacks_t * cb)
1916 vlib_thread_main_t *tm = vlib_get_thread_main ();
1918 if (tm->extern_thread_mgmt)
1921 tm->cb.vlib_launch_thread_cb = cb->vlib_launch_thread_cb;
1922 tm->extern_thread_mgmt = 1;
1927 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1930 ASSERT (vlib_get_thread_index () == 0);
1931 vlib_process_signal_event (vlib_get_main (), args->node_index,
1932 args->type_opaque, args->data);
1935 void *rpc_call_main_thread_cb_fn;
1938 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1940 if (rpc_call_main_thread_cb_fn)
1942 void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1943 (*fp) (callback, args, arg_size);
1946 clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1950 threads_init (vlib_main_t * vm)
1955 VLIB_INIT_FUNCTION (threads_init);
1958 static clib_error_t *
1959 show_clock_command_fn (vlib_main_t * vm,
1960 unformat_input_t * input, vlib_cli_command_t * cmd)
1964 clib_timebase_t _tb, *tb = &_tb;
1966 (void) unformat (input, "verbose %=", &verbose, 1);
1968 clib_timebase_init (tb, 0 /* GMT */ , CLIB_TIMEBASE_DAYLIGHT_NONE,
1971 vlib_cli_output (vm, "%U, %U GMT", format_clib_time, &vm->clib_time,
1972 verbose, format_clib_timebase_time,
1973 clib_timebase_now (tb));
1975 if (vec_len (vlib_mains) == 1)
1978 vlib_cli_output (vm, "Time last barrier release %.9f",
1979 vm->time_last_barrier_release);
1981 for (i = 1; i < vec_len (vlib_mains); i++)
1983 if (vlib_mains[i] == 0)
1986 vlib_cli_output (vm, "%d: %U", i, format_clib_time,
1987 &vlib_mains[i]->clib_time, verbose);
1989 vlib_cli_output (vm, "Thread %d offset %.9f error %.9f", i,
1990 vlib_mains[i]->time_offset,
1991 vm->time_last_barrier_release -
1992 vlib_mains[i]->time_last_barrier_release);
1998 VLIB_CLI_COMMAND (f_command, static) =
2000 .path = "show clock",
2001 .short_help = "show clock",
2002 .function = show_clock_command_fn,
2007 * fd.io coding-style-patch-verification: ON
2010 * eval: (c-set-style "gnu")