2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
19 #include <vppinfra/format.h>
20 #include <vppinfra/time_range.h>
21 #include <vppinfra/interrupt.h>
22 #include <vppinfra/linux/sysfs.h>
23 #include <vlib/vlib.h>
25 #include <vlib/threads.h>
27 #include <vlib/stat_weak_inlines.h>
35 vlib_worker_thread_t *vlib_worker_threads;
36 vlib_thread_main_t vlib_thread_main;
39 * Barrier tracing can be enabled on a normal build to collect information
40 * on barrier use, including timings and call stacks. Deliberately not
41 * keyed off CLIB_DEBUG, because that can add significant overhead which
42 * imapacts observed timings.
46 barrier_trace_sync (f64 t_entry, f64 t_open, f64 t_closed)
48 if (!vlib_worker_threads->barrier_elog_enabled)
52 ELOG_TYPE_DECLARE (e) =
54 .format = "bar-trace-%s-#%d",
55 .format_args = "T4i4",
60 u32 caller, count, t_entry, t_open, t_closed;
63 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
64 ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
65 ed->caller = elog_string (&vlib_global_main.elog_main,
66 (char *) vlib_worker_threads[0].barrier_caller);
67 ed->t_entry = (int) (1000000.0 * t_entry);
68 ed->t_open = (int) (1000000.0 * t_open);
69 ed->t_closed = (int) (1000000.0 * t_closed);
73 barrier_trace_sync_rec (f64 t_entry)
75 if (!vlib_worker_threads->barrier_elog_enabled)
79 ELOG_TYPE_DECLARE (e) =
81 .format = "bar-syncrec-%s-#%d",
82 .format_args = "T4i4",
90 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
91 ed->depth = (int) vlib_worker_threads[0].recursion_level - 1;
92 ed->caller = elog_string (&vlib_global_main.elog_main,
93 (char *) vlib_worker_threads[0].barrier_caller);
97 barrier_trace_release_rec (f64 t_entry)
99 if (!vlib_worker_threads->barrier_elog_enabled)
103 ELOG_TYPE_DECLARE (e) =
105 .format = "bar-relrrec-#%d",
114 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
115 ed->depth = (int) vlib_worker_threads[0].recursion_level;
119 barrier_trace_release (f64 t_entry, f64 t_closed_total, f64 t_update_main)
121 if (!vlib_worker_threads->barrier_elog_enabled)
125 ELOG_TYPE_DECLARE (e) =
127 .format = "bar-rel-#%d-e%d-u%d-t%d",
128 .format_args = "i4i4i4i4",
133 u32 count, t_entry, t_update_main, t_closed_total;
136 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
137 ed->t_entry = (int) (1000000.0 * t_entry);
138 ed->t_update_main = (int) (1000000.0 * t_update_main);
139 ed->t_closed_total = (int) (1000000.0 * t_closed_total);
140 ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
142 /* Reset context for next trace */
143 vlib_worker_threads[0].barrier_context = NULL;
147 os_get_nthreads (void)
149 return vec_len (vlib_thread_stacks);
153 vlib_set_thread_name (char *name)
155 int pthread_setname_np (pthread_t __target_thread, const char *__name);
157 pthread_t thread = pthread_self ();
161 rv = pthread_setname_np (thread, name);
163 clib_warning ("pthread_setname_np returned %d", rv);
168 sort_registrations_by_no_clone (void *a0, void *a1)
170 vlib_thread_registration_t **tr0 = a0;
171 vlib_thread_registration_t **tr1 = a1;
173 return ((i32) ((*tr0)->no_data_structure_clone)
174 - ((i32) ((*tr1)->no_data_structure_clone)));
178 clib_sysfs_list_to_bitmap (char *filename)
183 fp = fopen (filename, "r");
188 vec_validate (buffer, 256 - 1);
189 if (fgets ((char *) buffer, 256, fp))
192 unformat_init_string (&in, (char *) buffer,
193 strlen ((char *) buffer));
194 if (unformat (&in, "%U", unformat_bitmap_list, &r) != 1)
195 clib_warning ("unformat_bitmap_list failed");
205 /* Called early in the init sequence */
208 vlib_thread_init (vlib_main_t * vm)
210 vlib_thread_main_t *tm = &vlib_thread_main;
211 vlib_worker_thread_t *w;
212 vlib_thread_registration_t *tr;
213 u32 n_vlib_mains = 1;
218 /* get bitmaps of active cpu cores and sockets */
219 tm->cpu_core_bitmap =
220 clib_sysfs_list_to_bitmap ("/sys/devices/system/cpu/online");
221 tm->cpu_socket_bitmap =
222 clib_sysfs_list_to_bitmap ("/sys/devices/system/node/online");
224 avail_cpu = clib_bitmap_dup (tm->cpu_core_bitmap);
227 for (i = 0; i < tm->skip_cores; i++)
229 uword c = clib_bitmap_first_set (avail_cpu);
231 return clib_error_return (0, "no available cpus to skip");
233 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
236 /* grab cpu for main thread */
237 if (tm->main_lcore == ~0)
239 /* if main-lcore is not set, we try to use lcore 1 */
240 if (clib_bitmap_get (avail_cpu, 1))
243 tm->main_lcore = clib_bitmap_first_set (avail_cpu);
244 if (tm->main_lcore == (u8) ~ 0)
245 return clib_error_return (0, "no available cpus to be used for the"
250 if (clib_bitmap_get (avail_cpu, tm->main_lcore) == 0)
251 return clib_error_return (0, "cpu %u is not available to be used"
252 " for the main thread", tm->main_lcore);
254 avail_cpu = clib_bitmap_set (avail_cpu, tm->main_lcore, 0);
256 /* assume that there is socket 0 only if there is no data from sysfs */
257 if (!tm->cpu_socket_bitmap)
258 tm->cpu_socket_bitmap = clib_bitmap_set (0, 0, 1);
260 /* pin main thread to main_lcore */
261 if (tm->cb.vlib_thread_set_lcore_cb)
263 tm->cb.vlib_thread_set_lcore_cb (0, tm->main_lcore);
269 CPU_SET (tm->main_lcore, &cpuset);
270 pthread_setaffinity_np (pthread_self (), sizeof (cpu_set_t), &cpuset);
273 /* Set up thread 0 */
274 vec_validate_aligned (vlib_worker_threads, 0, CLIB_CACHE_LINE_BYTES);
275 _vec_len (vlib_worker_threads) = 1;
276 w = vlib_worker_threads;
277 w->thread_mheap = clib_mem_get_heap ();
278 w->thread_stack = vlib_thread_stacks[0];
279 w->cpu_id = tm->main_lcore;
280 w->lwp = syscall (SYS_gettid);
281 w->thread_id = pthread_self ();
282 tm->n_vlib_mains = 1;
284 vlib_get_thread_core_numa (w, w->cpu_id);
286 if (tm->sched_policy != ~0)
288 struct sched_param sched_param;
289 if (!sched_getparam (w->lwp, &sched_param))
291 if (tm->sched_priority != ~0)
292 sched_param.sched_priority = tm->sched_priority;
293 sched_setscheduler (w->lwp, tm->sched_policy, &sched_param);
297 /* assign threads to cores and set n_vlib_mains */
302 vec_add1 (tm->registrations, tr);
306 vec_sort_with_function (tm->registrations, sort_registrations_by_no_clone);
308 for (i = 0; i < vec_len (tm->registrations); i++)
311 tr = tm->registrations[i];
312 tr->first_index = first_index;
313 first_index += tr->count;
314 n_vlib_mains += (tr->no_data_structure_clone == 0) ? tr->count : 0;
316 /* construct coremask */
317 if (tr->use_pthreads || !tr->count)
324 clib_bitmap_foreach (c, tr->coremask) {
325 if (clib_bitmap_get(avail_cpu, c) == 0)
326 return clib_error_return (0, "cpu %u is not available to be used"
327 " for the '%s' thread",c, tr->name);
329 avail_cpu = clib_bitmap_set(avail_cpu, c, 0);
335 for (j = 0; j < tr->count; j++)
337 /* Do not use CPU 0 by default - leave it to the host and IRQs */
338 uword avail_c0 = clib_bitmap_get (avail_cpu, 0);
339 avail_cpu = clib_bitmap_set (avail_cpu, 0, 0);
341 uword c = clib_bitmap_first_set (avail_cpu);
342 /* Use CPU 0 as a last resort */
343 if (c == ~0 && avail_c0)
350 return clib_error_return (0,
351 "no available cpus to be used for"
352 " the '%s' thread", tr->name);
354 avail_cpu = clib_bitmap_set (avail_cpu, 0, avail_c0);
355 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
356 tr->coremask = clib_bitmap_set (tr->coremask, c, 1);
361 clib_bitmap_free (avail_cpu);
363 tm->n_vlib_mains = n_vlib_mains;
366 * Allocate the remaining worker threads, and thread stack vector slots
367 * from now on, calls to os_get_nthreads() will return the correct
370 vec_validate_aligned (vlib_worker_threads, first_index - 1,
371 CLIB_CACHE_LINE_BYTES);
372 vec_validate (vlib_thread_stacks, vec_len (vlib_worker_threads) - 1);
377 vlib_frame_queue_alloc (int nelts)
379 vlib_frame_queue_t *fq;
381 fq = clib_mem_alloc_aligned (sizeof (*fq), CLIB_CACHE_LINE_BYTES);
382 clib_memset (fq, 0, sizeof (*fq));
384 fq->vector_threshold = 128; // packets
385 vec_validate_aligned (fq->elts, nelts - 1, CLIB_CACHE_LINE_BYTES);
389 if (((uword) & fq->tail) & (CLIB_CACHE_LINE_BYTES - 1))
390 fformat (stderr, "WARNING: fq->tail unaligned\n");
391 if (((uword) & fq->head) & (CLIB_CACHE_LINE_BYTES - 1))
392 fformat (stderr, "WARNING: fq->head unaligned\n");
393 if (((uword) fq->elts) & (CLIB_CACHE_LINE_BYTES - 1))
394 fformat (stderr, "WARNING: fq->elts unaligned\n");
396 if (sizeof (fq->elts[0]) % CLIB_CACHE_LINE_BYTES)
397 fformat (stderr, "WARNING: fq->elts[0] size %d\n",
398 sizeof (fq->elts[0]));
399 if (nelts & (nelts - 1))
401 fformat (stderr, "FATAL: nelts MUST be a power of 2\n");
409 void vl_msg_api_handler_no_free (void *) __attribute__ ((weak));
411 vl_msg_api_handler_no_free (void *v)
415 /* Turned off, save as reference material... */
418 vlib_frame_queue_dequeue_internal (int thread_id,
419 vlib_main_t * vm, vlib_node_main_t * nm)
421 vlib_frame_queue_t *fq = vlib_frame_queues[thread_id];
422 vlib_frame_queue_elt_t *elt;
424 vlib_pending_frame_t *p;
425 vlib_node_runtime_t *r;
426 u32 node_runtime_index;
431 ASSERT (vm == vlib_mains[thread_id]);
435 if (fq->head == fq->tail)
438 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
443 before = clib_cpu_time_now ();
446 node_runtime_index = elt->node_runtime_index;
447 msg_type = elt->msg_type;
451 case VLIB_FRAME_QUEUE_ELT_FREE_BUFFERS:
452 vlib_buffer_free (vm, vlib_frame_vector_args (f), f->n_vectors);
453 /* note fallthrough... */
454 case VLIB_FRAME_QUEUE_ELT_FREE_FRAME:
455 r = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
457 vlib_frame_free (vm, r, f);
459 case VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME:
460 vec_add2 (vm->node_main.pending_frames, p, 1);
461 f->flags |= (VLIB_FRAME_PENDING | VLIB_FRAME_FREE_AFTER_DISPATCH);
462 p->node_runtime_index = elt->node_runtime_index;
463 p->frame_index = vlib_frame_index (vm, f);
464 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
465 fq->dequeue_vectors += (u64) f->n_vectors;
467 case VLIB_FRAME_QUEUE_ELT_API_MSG:
468 vl_msg_api_handler_no_free (f);
471 clib_warning ("bogus frame queue message, type %d", msg_type);
476 fq->dequeue_ticks += clib_cpu_time_now () - before;
477 CLIB_MEMORY_BARRIER ();
486 vlib_frame_queue_dequeue (int thread_id,
487 vlib_main_t * vm, vlib_node_main_t * nm)
489 return vlib_frame_queue_dequeue_internal (thread_id, vm, nm);
493 vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
494 u32 frame_queue_index, vlib_frame_t * frame,
495 vlib_frame_queue_msg_type_t type)
497 vlib_frame_queue_t *fq = vlib_frame_queues[frame_queue_index];
498 vlib_frame_queue_elt_t *elt;
501 u64 before = clib_cpu_time_now ();
505 new_tail = clib_atomic_add_fetch (&fq->tail, 1);
507 /* Wait until a ring slot is available */
508 while (new_tail >= fq->head + fq->nelts)
510 f64 b4 = vlib_time_now_ticks (vm, before);
511 vlib_worker_thread_barrier_check (vm, b4);
512 /* Bad idea. Dequeue -> enqueue -> dequeue -> trouble */
513 // vlib_frame_queue_dequeue (vm->thread_index, vm, nm);
516 elt = fq->elts + (new_tail & (fq->nelts - 1));
518 /* this would be very bad... */
523 /* Once we enqueue the frame, frame->n_vectors is owned elsewhere... */
524 save_count = frame->n_vectors;
527 elt->node_runtime_index = node_runtime_index;
528 elt->msg_type = type;
529 CLIB_MEMORY_BARRIER ();
536 /* To be called by vlib worker threads upon startup */
538 vlib_worker_thread_init (vlib_worker_thread_t * w)
540 vlib_thread_main_t *tm = vlib_get_thread_main ();
543 * Note: disabling signals in worker threads as follows
544 * prevents the api post-mortem dump scheme from working
548 * pthread_sigmask (SIG_SETMASK, &s, 0);
552 clib_mem_set_heap (w->thread_mheap);
554 if (vec_len (tm->thread_prefix) && w->registration->short_name)
556 w->name = format (0, "%v_%s_%d%c", tm->thread_prefix,
557 w->registration->short_name, w->instance_id, '\0');
558 vlib_set_thread_name ((char *) w->name);
561 if (!w->registration->use_pthreads)
564 /* Initial barrier sync, for both worker and i/o threads */
565 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
567 while (*vlib_worker_threads->wait_at_barrier)
570 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
575 vlib_worker_thread_bootstrap_fn (void *arg)
578 vlib_worker_thread_t *w = arg;
580 w->lwp = syscall (SYS_gettid);
581 w->thread_id = pthread_self ();
583 __os_thread_index = w - vlib_worker_threads;
585 vlib_process_start_switch_stack (vlib_mains[__os_thread_index], 0);
586 rv = (void *) clib_calljmp
587 ((uword (*)(uword)) w->thread_function,
588 (uword) arg, w->thread_stack + VLIB_THREAD_STACK_SIZE);
589 /* NOTREACHED, we hope */
594 vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id)
596 const char *sys_cpu_path = "/sys/devices/system/cpu/cpu";
597 const char *sys_node_path = "/sys/devices/system/node/node";
598 clib_bitmap_t *nbmp = 0, *cbmp = 0;
601 int core_id = -1, numa_id = -1;
603 p = format (p, "%s%u/topology/core_id%c", sys_cpu_path, cpu_id, 0);
604 clib_sysfs_read ((char *) p, "%d", &core_id);
605 vec_reset_length (p);
608 clib_sysfs_read ("/sys/devices/system/node/online", "%U",
609 unformat_bitmap_list, &nbmp);
610 clib_bitmap_foreach (node, nbmp) {
611 p = format (p, "%s%u/cpulist%c", sys_node_path, node, 0);
612 clib_sysfs_read ((char *) p, "%U", unformat_bitmap_list, &cbmp);
613 if (clib_bitmap_get (cbmp, cpu_id))
615 vec_reset_length (cbmp);
616 vec_reset_length (p);
623 w->core_id = core_id;
624 w->numa_id = numa_id;
627 static clib_error_t *
628 vlib_launch_thread_int (void *fp, vlib_worker_thread_t * w, unsigned cpu_id)
630 clib_mem_main_t *mm = &clib_mem_main;
631 vlib_thread_main_t *tm = &vlib_thread_main;
632 void *(*fp_arg) (void *) = fp;
636 vlib_get_thread_core_numa (w, cpu_id);
638 /* Set up NUMA-bound heap if indicated */
639 if (mm->per_numa_mheaps[w->numa_id] == 0)
641 /* If the user requested a NUMA heap, create it... */
642 if (tm->numa_heap_size)
644 clib_mem_set_numa_affinity (w->numa_id, 1 /* force */ );
645 numa_heap = clib_mem_create_heap (0 /* DIY */ , tm->numa_heap_size,
647 "numa %u heap", w->numa_id);
648 clib_mem_set_default_numa_affinity ();
649 mm->per_numa_mheaps[w->numa_id] = numa_heap;
653 /* Or, use the main heap */
654 mm->per_numa_mheaps[w->numa_id] = w->thread_mheap;
658 if (tm->cb.vlib_launch_thread_cb && !w->registration->use_pthreads)
659 return tm->cb.vlib_launch_thread_cb (fp, (void *) w, cpu_id);
665 CPU_SET (cpu_id, &cpuset);
667 if (pthread_create (&worker, NULL /* attr */ , fp_arg, (void *) w))
668 return clib_error_return_unix (0, "pthread_create");
670 if (pthread_setaffinity_np (worker, sizeof (cpu_set_t), &cpuset))
671 return clib_error_return_unix (0, "pthread_setaffinity_np");
677 static clib_error_t *
678 start_workers (vlib_main_t * vm)
681 vlib_worker_thread_t *w;
682 vlib_main_t *vm_clone;
684 vlib_thread_main_t *tm = &vlib_thread_main;
685 vlib_thread_registration_t *tr;
686 vlib_node_runtime_t *rt;
687 u32 n_vlib_mains = tm->n_vlib_mains;
688 u32 worker_thread_index;
689 clib_mem_heap_t *main_heap = clib_mem_get_per_cpu_heap ();
691 vec_reset_length (vlib_worker_threads);
693 /* Set up the main thread */
694 vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
695 w->elog_track.name = "main thread";
696 elog_track_register (&vm->elog_main, &w->elog_track);
698 if (vec_len (tm->thread_prefix))
700 w->name = format (0, "%v_main%c", tm->thread_prefix, '\0');
701 vlib_set_thread_name ((char *) w->name);
705 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
706 vm->elog_main.lock[0] = 0;
708 clib_callback_data_init (&vm->vlib_node_runtime_perf_callbacks,
709 &vm->worker_thread_main_loop_callback_lock);
711 /* Replace hand-crafted length-1 vector with a real vector */
714 vec_validate_aligned (vlib_mains, n_vlib_mains - 1, CLIB_CACHE_LINE_BYTES);
715 _vec_len (vlib_mains) = 0;
716 vec_add1_aligned (vlib_mains, vm, CLIB_CACHE_LINE_BYTES);
718 if (n_vlib_mains > 1)
720 vlib_worker_threads->wait_at_barrier =
721 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
722 vlib_worker_threads->workers_at_barrier =
723 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
725 vlib_worker_threads->node_reforks_required =
726 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
728 /* We'll need the rpc vector lock... */
729 clib_spinlock_init (&vm->pending_rpc_lock);
731 /* Ask for an initial barrier sync */
732 *vlib_worker_threads->workers_at_barrier = 0;
733 *vlib_worker_threads->wait_at_barrier = 1;
735 /* Without update or refork */
736 *vlib_worker_threads->node_reforks_required = 0;
737 vm->need_vlib_worker_thread_node_runtime_update = 0;
740 vm->barrier_epoch = 0;
741 vm->barrier_no_close_before = 0;
743 worker_thread_index = 1;
744 clib_spinlock_init (&vm->worker_thread_main_loop_callback_lock);
746 for (i = 0; i < vec_len (tm->registrations); i++)
748 vlib_node_main_t *nm, *nm_clone;
751 tr = tm->registrations[i];
756 for (k = 0; k < tr->count; k++)
760 vec_add2 (vlib_worker_threads, w, 1);
761 /* Currently unused, may not really work */
763 w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
768 w->thread_mheap = main_heap;
771 vlib_thread_stack_init (w - vlib_worker_threads);
772 w->thread_function = tr->function;
773 w->thread_function_arg = w;
775 w->registration = tr;
778 (char *) format (0, "%s %d", tr->name, k + 1);
779 vec_add1 (w->elog_track.name, 0);
780 elog_track_register (&vm->elog_main, &w->elog_track);
782 if (tr->no_data_structure_clone)
785 /* Fork vlib_global_main et al. Look for bugs here */
786 oldheap = clib_mem_set_heap (w->thread_mheap);
788 vm_clone = clib_mem_alloc_aligned (sizeof (*vm_clone),
789 CLIB_CACHE_LINE_BYTES);
790 clib_memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
792 vm_clone->thread_index = worker_thread_index;
793 vm_clone->heap_base = w->thread_mheap;
794 vm_clone->heap_aligned_base = (void *)
795 (((uword) w->thread_mheap) & ~(VLIB_FRAME_ALIGN - 1));
796 vm_clone->init_functions_called =
797 hash_create (0, /* value bytes */ 0);
798 vm_clone->pending_rpc_requests = 0;
799 vec_validate (vm_clone->pending_rpc_requests, 0);
800 _vec_len (vm_clone->pending_rpc_requests) = 0;
801 clib_memset (&vm_clone->random_buffer, 0,
802 sizeof (vm_clone->random_buffer));
804 (&vm_clone->worker_thread_main_loop_callback_lock);
805 clib_callback_data_init
806 (&vm_clone->vlib_node_runtime_perf_callbacks,
807 &vm_clone->worker_thread_main_loop_callback_lock);
809 nm = &vlib_mains[0]->node_main;
810 nm_clone = &vm_clone->node_main;
811 /* fork next frames array, preserving node runtime indices */
812 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
813 CLIB_CACHE_LINE_BYTES);
814 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
816 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
817 u32 save_node_runtime_index;
820 save_node_runtime_index = nf->node_runtime_index;
821 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
822 vlib_next_frame_init (nf);
823 nf->node_runtime_index = save_node_runtime_index;
824 nf->flags = save_flags;
827 /* fork the frame dispatch queue */
828 nm_clone->pending_frames = 0;
829 vec_validate (nm_clone->pending_frames, 10);
830 _vec_len (nm_clone->pending_frames) = 0;
835 /* Allocate all nodes in single block for speed */
836 n = clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*n));
838 for (j = 0; j < vec_len (nm->nodes); j++)
840 clib_memcpy (n, nm->nodes[j], sizeof (*n));
841 /* none of the copied nodes have enqueue rights given out */
842 n->owner_node_index = VLIB_INVALID_NODE_INDEX;
843 clib_memset (&n->stats_total, 0, sizeof (n->stats_total));
844 clib_memset (&n->stats_last_clear, 0,
845 sizeof (n->stats_last_clear));
846 vec_add1 (nm_clone->nodes, n);
849 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
850 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
851 CLIB_CACHE_LINE_BYTES);
853 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
855 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
856 rt->thread_index = vm_clone->thread_index;
857 /* copy initial runtime_data from node */
858 if (n->runtime_data && n->runtime_data_bytes > 0)
859 clib_memcpy (rt->runtime_data, n->runtime_data,
860 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
861 n->runtime_data_bytes));
864 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
865 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
866 CLIB_CACHE_LINE_BYTES);
867 clib_interrupt_init (
868 &nm_clone->interrupts,
869 vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
870 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
872 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
873 rt->thread_index = vm_clone->thread_index;
874 /* copy initial runtime_data from node */
875 if (n->runtime_data && n->runtime_data_bytes > 0)
876 clib_memcpy (rt->runtime_data, n->runtime_data,
877 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
878 n->runtime_data_bytes));
881 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
882 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
883 CLIB_CACHE_LINE_BYTES);
885 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
887 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
888 rt->thread_index = vm_clone->thread_index;
889 /* copy initial runtime_data from node */
890 if (n->runtime_data && n->runtime_data_bytes > 0)
891 clib_memcpy (rt->runtime_data, n->runtime_data,
892 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
893 n->runtime_data_bytes));
896 nm_clone->processes = vec_dup_aligned (nm->processes,
897 CLIB_CACHE_LINE_BYTES);
899 /* Create per-thread frame freelist */
900 nm_clone->frame_sizes = vec_new (vlib_frame_size_t, 1);
901 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
902 nm_clone->frame_size_hash = hash_create (0, sizeof (uword));
904 nm_clone->node_by_error = nm->node_by_error;
906 /* Packet trace buffers are guaranteed to be empty, nothing to do here */
908 clib_mem_set_heap (oldheap);
909 vec_add1_aligned (vlib_mains, vm_clone, CLIB_CACHE_LINE_BYTES);
911 /* Switch to the stats segment ... */
912 void *oldheap = vlib_stats_push_heap (0);
913 vm_clone->error_main.counters = vec_dup_aligned
914 (vlib_mains[0]->error_main.counters, CLIB_CACHE_LINE_BYTES);
915 vlib_stats_pop_heap2 (vm_clone->error_main.counters,
916 worker_thread_index, oldheap, 1);
918 vm_clone->error_main.counters_last_clear = vec_dup_aligned
919 (vlib_mains[0]->error_main.counters_last_clear,
920 CLIB_CACHE_LINE_BYTES);
922 worker_thread_index++;
928 /* only have non-data-structure copy threads to create... */
929 for (i = 0; i < vec_len (tm->registrations); i++)
931 tr = tm->registrations[i];
933 for (j = 0; j < tr->count; j++)
935 vec_add2 (vlib_worker_threads, w, 1);
938 w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
944 w->thread_mheap = main_heap;
946 vlib_thread_stack_init (w - vlib_worker_threads);
947 w->thread_function = tr->function;
948 w->thread_function_arg = w;
951 (char *) format (0, "%s %d", tr->name, j + 1);
952 w->registration = tr;
953 vec_add1 (w->elog_track.name, 0);
954 elog_track_register (&vm->elog_main, &w->elog_track);
959 worker_thread_index = 1;
961 for (i = 0; i < vec_len (tm->registrations); i++)
966 tr = tm->registrations[i];
968 if (tr->use_pthreads || tm->use_pthreads)
970 for (j = 0; j < tr->count; j++)
972 w = vlib_worker_threads + worker_thread_index++;
973 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
976 clib_error_report (err);
983 clib_bitmap_foreach (c, tr->coremask) {
984 w = vlib_worker_threads + worker_thread_index++;
985 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
988 clib_error_report (err);
993 vlib_worker_thread_barrier_sync (vm);
994 vlib_worker_thread_barrier_release (vm);
998 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
1002 worker_thread_node_runtime_update_internal (void)
1006 vlib_node_main_t *nm, *nm_clone;
1007 vlib_main_t *vm_clone;
1008 vlib_node_runtime_t *rt;
1010 vlib_node_runtime_sync_stats (vlib_main_t * vm,
1011 vlib_node_runtime_t * r,
1013 uword n_vectors, uword n_clocks);
1015 ASSERT (vlib_get_thread_index () == 0);
1018 nm = &vm->node_main;
1020 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
1023 * Scrape all runtime stats, so we don't lose node runtime(s) with
1024 * pending counts, or throw away worker / io thread counts.
1026 for (j = 0; j < vec_len (nm->nodes); j++)
1030 vlib_node_sync_stats (vm, n);
1033 for (i = 1; i < vec_len (vlib_mains); i++)
1037 vm_clone = vlib_mains[i];
1038 nm_clone = &vm_clone->node_main;
1040 for (j = 0; j < vec_len (nm_clone->nodes); j++)
1042 n = nm_clone->nodes[j];
1044 rt = vlib_node_get_runtime (vm_clone, n->index);
1045 vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
1049 /* Per-worker clone rebuilds are now done on each thread */
1054 vlib_worker_thread_node_refork (void)
1056 vlib_main_t *vm, *vm_clone;
1057 vlib_node_main_t *nm, *nm_clone;
1058 vlib_node_t **old_nodes_clone;
1059 vlib_node_runtime_t *rt, *old_rt;
1061 vlib_node_t *new_n_clone;
1066 nm = &vm->node_main;
1067 vm_clone = vlib_get_main ();
1068 nm_clone = &vm_clone->node_main;
1070 /* Re-clone error heap */
1071 u64 *old_counters = vm_clone->error_main.counters;
1072 u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
1074 clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
1075 sizeof (vm->error_main));
1076 j = vec_len (vm->error_main.counters) - 1;
1078 /* Switch to the stats segment ... */
1079 void *oldheap = vlib_stats_push_heap (0);
1080 vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
1081 vm_clone->error_main.counters = old_counters;
1082 vlib_stats_pop_heap2 (vm_clone->error_main.counters, vm_clone->thread_index,
1085 vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
1086 vm_clone->error_main.counters_last_clear = old_counters_all_clear;
1088 nm_clone = &vm_clone->node_main;
1089 vec_free (nm_clone->next_frames);
1090 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
1091 CLIB_CACHE_LINE_BYTES);
1093 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
1095 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
1096 u32 save_node_runtime_index;
1099 save_node_runtime_index = nf->node_runtime_index;
1100 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
1101 vlib_next_frame_init (nf);
1102 nf->node_runtime_index = save_node_runtime_index;
1103 nf->flags = save_flags;
1106 old_nodes_clone = nm_clone->nodes;
1107 nm_clone->nodes = 0;
1111 /* Allocate all nodes in single block for speed */
1113 clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
1114 for (j = 0; j < vec_len (nm->nodes); j++)
1116 vlib_node_t *new_n = nm->nodes[j];
1118 clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
1119 /* none of the copied nodes have enqueue rights given out */
1120 new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
1122 if (j >= vec_len (old_nodes_clone))
1124 /* new node, set to zero */
1125 clib_memset (&new_n_clone->stats_total, 0,
1126 sizeof (new_n_clone->stats_total));
1127 clib_memset (&new_n_clone->stats_last_clear, 0,
1128 sizeof (new_n_clone->stats_last_clear));
1132 vlib_node_t *old_n_clone = old_nodes_clone[j];
1133 /* Copy stats if the old data is valid */
1134 clib_memcpy_fast (&new_n_clone->stats_total,
1135 &old_n_clone->stats_total,
1136 sizeof (new_n_clone->stats_total));
1137 clib_memcpy_fast (&new_n_clone->stats_last_clear,
1138 &old_n_clone->stats_last_clear,
1139 sizeof (new_n_clone->stats_last_clear));
1141 /* keep previous node state */
1142 new_n_clone->state = old_n_clone->state;
1144 vec_add1 (nm_clone->nodes, new_n_clone);
1147 /* Free the old node clones */
1148 clib_mem_free (old_nodes_clone[0]);
1150 vec_free (old_nodes_clone);
1153 /* re-clone internal nodes */
1154 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
1155 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
1156 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1157 CLIB_CACHE_LINE_BYTES);
1159 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
1161 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1162 rt->thread_index = vm_clone->thread_index;
1163 /* copy runtime_data, will be overwritten later for existing rt */
1164 if (n->runtime_data && n->runtime_data_bytes > 0)
1165 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1166 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1167 n->runtime_data_bytes));
1170 for (j = 0; j < vec_len (old_rt); j++)
1172 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1173 rt->state = old_rt[j].state;
1174 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1175 VLIB_NODE_RUNTIME_DATA_SIZE);
1180 /* re-clone input nodes */
1181 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1182 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1183 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1184 CLIB_CACHE_LINE_BYTES);
1185 clib_interrupt_resize (
1186 &nm_clone->interrupts,
1187 vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
1189 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1191 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1192 rt->thread_index = vm_clone->thread_index;
1193 /* copy runtime_data, will be overwritten later for existing rt */
1194 if (n->runtime_data && n->runtime_data_bytes > 0)
1195 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1196 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1197 n->runtime_data_bytes));
1200 for (j = 0; j < vec_len (old_rt); j++)
1202 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1203 rt->state = old_rt[j].state;
1204 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1205 VLIB_NODE_RUNTIME_DATA_SIZE);
1210 /* re-clone pre-input nodes */
1211 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT];
1212 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
1213 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
1214 CLIB_CACHE_LINE_BYTES);
1216 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1218 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1219 rt->thread_index = vm_clone->thread_index;
1220 /* copy runtime_data, will be overwritten later for existing rt */
1221 if (n->runtime_data && n->runtime_data_bytes > 0)
1222 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1223 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1224 n->runtime_data_bytes));
1227 for (j = 0; j < vec_len (old_rt); j++)
1229 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1230 rt->state = old_rt[j].state;
1231 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1232 VLIB_NODE_RUNTIME_DATA_SIZE);
1237 nm_clone->processes = vec_dup_aligned (nm->processes,
1238 CLIB_CACHE_LINE_BYTES);
1239 nm_clone->node_by_error = nm->node_by_error;
1243 vlib_worker_thread_node_runtime_update (void)
1246 * Make a note that we need to do a node runtime update
1247 * prior to releasing the barrier.
1249 vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1253 unformat_sched_policy (unformat_input_t * input, va_list * args)
1255 u32 *r = va_arg (*args, u32 *);
1258 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1259 foreach_sched_policy
1266 static clib_error_t *
1267 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1269 vlib_thread_registration_t *tr;
1271 vlib_thread_main_t *tm = &vlib_thread_main;
1276 tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1278 tm->n_thread_stacks = 1; /* account for main thread */
1279 tm->sched_policy = ~0;
1280 tm->sched_priority = ~0;
1281 tm->main_lcore = ~0;
1287 hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1291 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1293 if (unformat (input, "use-pthreads"))
1294 tm->use_pthreads = 1;
1295 else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1297 else if (unformat (input, "main-core %u", &tm->main_lcore))
1299 else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1301 else if (unformat (input, "numa-heap-size %U",
1302 unformat_memory_size, &tm->numa_heap_size))
1304 else if (unformat (input, "coremask-%s %U", &name,
1305 unformat_bitmap_mask, &bitmap) ||
1306 unformat (input, "corelist-%s %U", &name,
1307 unformat_bitmap_list, &bitmap))
1309 p = hash_get_mem (tm->thread_registrations_by_name, name);
1311 return clib_error_return (0, "no such thread type '%s'", name);
1313 tr = (vlib_thread_registration_t *) p[0];
1315 if (tr->use_pthreads)
1316 return clib_error_return (0,
1317 "corelist cannot be set for '%s' threads",
1320 return clib_error_return
1321 (0, "core placement of '%s' threads is already configured",
1324 tr->coremask = bitmap;
1325 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1329 (input, "scheduler-policy %U", unformat_sched_policy,
1332 else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1334 else if (unformat (input, "%s %u", &name, &count))
1336 p = hash_get_mem (tm->thread_registrations_by_name, name);
1338 return clib_error_return (0, "no such thread type 3 '%s'", name);
1340 tr = (vlib_thread_registration_t *) p[0];
1342 if (tr->fixed_count)
1343 return clib_error_return
1344 (0, "number of '%s' threads not configurable", name);
1346 return clib_error_return
1347 (0, "number of '%s' threads is already configured", name);
1355 if (tm->sched_priority != ~0)
1357 if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1359 u32 prio_max = sched_get_priority_max (tm->sched_policy);
1360 u32 prio_min = sched_get_priority_min (tm->sched_policy);
1361 if (tm->sched_priority > prio_max)
1362 tm->sched_priority = prio_max;
1363 if (tm->sched_priority < prio_min)
1364 tm->sched_priority = prio_min;
1368 return clib_error_return
1370 "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1371 tm->sched_priority);
1376 if (!tm->thread_prefix)
1377 tm->thread_prefix = format (0, "vpp");
1381 tm->n_thread_stacks += tr->count;
1382 tm->n_pthreads += tr->count * tr->use_pthreads;
1383 tm->n_threads += tr->count * (tr->use_pthreads == 0);
1390 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1392 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1394 vnet_main_fixup (vlib_fork_fixup_t which)
1399 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1401 vlib_main_t *vm = vlib_get_main ();
1403 if (vlib_mains == 0)
1406 ASSERT (vlib_get_thread_index () == 0);
1407 vlib_worker_thread_barrier_sync (vm);
1411 case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1412 vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1418 vlib_worker_thread_barrier_release (vm);
1422 * Enforce minimum open time to minimize packet loss due to Rx overflow,
1423 * based on a test based heuristic that barrier should be open for at least
1424 * 3 time as long as it is closed (with an upper bound of 1ms because by that
1425 * point it is probably too late to make a difference)
1428 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1429 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1432 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1433 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1437 vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm)
1440 f64 now = vlib_time_now (vm);
1441 u32 count = vec_len (vlib_mains) - 1;
1443 /* No worker threads? */
1447 deadline = now + BARRIER_SYNC_TIMEOUT;
1448 *vlib_worker_threads->wait_at_barrier = 1;
1449 while (*vlib_worker_threads->workers_at_barrier != count)
1451 if ((now = vlib_time_now (vm)) > deadline)
1453 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1458 *vlib_worker_threads->wait_at_barrier = 0;
1462 * Return true if the wroker thread barrier is held
1465 vlib_worker_thread_barrier_held (void)
1467 if (vec_len (vlib_mains) < 2)
1470 return (*vlib_worker_threads->wait_at_barrier == 1);
1474 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm, const char *func_name)
1481 f64 max_vector_rate;
1485 if (vec_len (vlib_mains) < 2)
1488 ASSERT (vlib_get_thread_index () == 0);
1490 vlib_worker_threads[0].barrier_caller = func_name;
1491 count = vec_len (vlib_mains) - 1;
1493 /* Record entry relative to last close */
1494 now = vlib_time_now (vm);
1495 t_entry = now - vm->barrier_epoch;
1497 /* Tolerate recursive calls */
1498 if (++vlib_worker_threads[0].recursion_level > 1)
1500 barrier_trace_sync_rec (t_entry);
1504 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1505 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1506 vm->clib_time.last_cpu_time, 0 /* enter */ );
1509 * Need data to decide if we're working hard enough to honor
1510 * the barrier hold-down timer.
1512 max_vector_rate = 0.0;
1513 for (i = 1; i < vec_len (vlib_mains); i++)
1515 clib_max (max_vector_rate,
1516 (f64) vlib_last_vectors_per_main_loop (vlib_mains[i]));
1518 vlib_worker_threads[0].barrier_sync_count++;
1520 /* Enforce minimum barrier open time to minimize packet loss */
1521 ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1524 * If any worker thread seems busy, which we define
1525 * as a vector rate above 10, we enforce the barrier hold-down timer
1527 if (max_vector_rate > 10.0)
1531 now = vlib_time_now (vm);
1532 /* Barrier hold-down timer expired? */
1533 if (now >= vm->barrier_no_close_before)
1535 if ((vm->barrier_no_close_before - now)
1536 > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1539 ("clock change: would have waited for %.4f seconds",
1540 (vm->barrier_no_close_before - now));
1545 /* Record time of closure */
1546 t_open = now - vm->barrier_epoch;
1547 vm->barrier_epoch = now;
1549 deadline = now + BARRIER_SYNC_TIMEOUT;
1551 *vlib_worker_threads->wait_at_barrier = 1;
1552 while (*vlib_worker_threads->workers_at_barrier != count)
1554 if ((now = vlib_time_now (vm)) > deadline)
1556 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1561 t_closed = now - vm->barrier_epoch;
1563 barrier_trace_sync (t_entry, t_open, t_closed);
1568 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1575 f64 t_update_main = 0.0;
1576 int refork_needed = 0;
1578 if (vec_len (vlib_mains) < 2)
1581 ASSERT (vlib_get_thread_index () == 0);
1584 now = vlib_time_now (vm);
1585 t_entry = now - vm->barrier_epoch;
1587 if (--vlib_worker_threads[0].recursion_level > 0)
1589 barrier_trace_release_rec (t_entry);
1593 /* Update (all) node runtimes before releasing the barrier, if needed */
1594 if (vm->need_vlib_worker_thread_node_runtime_update)
1597 * Lock stat segment here, so we's safe when
1598 * rebuilding the stat segment node clones from the
1601 vlib_stat_segment_lock ();
1603 /* Do stats elements on main thread */
1604 worker_thread_node_runtime_update_internal ();
1605 vm->need_vlib_worker_thread_node_runtime_update = 0;
1607 /* Do per thread rebuilds in parallel */
1609 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1610 (vec_len (vlib_mains) - 1));
1611 now = vlib_time_now (vm);
1612 t_update_main = now - vm->barrier_epoch;
1615 deadline = now + BARRIER_SYNC_TIMEOUT;
1618 * Note when we let go of the barrier.
1619 * Workers can use this to derive a reasonably accurate
1620 * time offset. See vlib_time_now(...)
1622 vm->time_last_barrier_release = vlib_time_now (vm);
1623 CLIB_MEMORY_STORE_BARRIER ();
1625 *vlib_worker_threads->wait_at_barrier = 0;
1627 while (*vlib_worker_threads->workers_at_barrier > 0)
1629 if ((now = vlib_time_now (vm)) > deadline)
1631 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1636 /* Wait for reforks before continuing */
1639 now = vlib_time_now (vm);
1641 deadline = now + BARRIER_SYNC_TIMEOUT;
1643 while (*vlib_worker_threads->node_reforks_required > 0)
1645 if ((now = vlib_time_now (vm)) > deadline)
1647 fformat (stderr, "%s: worker thread refork deadlock\n",
1652 vlib_stat_segment_unlock ();
1655 t_closed_total = now - vm->barrier_epoch;
1657 minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1659 if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1661 minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1664 vm->barrier_no_close_before = now + minimum_open;
1666 /* Record barrier epoch (used to enforce minimum open time) */
1667 vm->barrier_epoch = now;
1669 barrier_trace_release (t_entry, t_closed_total, t_update_main);
1671 if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1672 clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1673 vm->clib_time.last_cpu_time, 1 /* leave */ );
1677 * Wait until each of the workers has been once around the track
1680 vlib_worker_wait_one_loop (void)
1682 ASSERT (vlib_get_thread_index () == 0);
1684 if (vec_len (vlib_mains) < 2)
1687 if (vlib_worker_thread_barrier_held ())
1693 vec_validate (counts, vec_len (vlib_mains) - 1);
1695 /* record the current loop counts */
1696 vec_foreach_index (ii, vlib_mains)
1697 counts[ii] = vlib_mains[ii]->main_loop_count;
1699 /* spin until each changes, apart from the main thread, or we'd be
1701 for (ii = 1; ii < vec_len (counts); ii++)
1703 while (counts[ii] == vlib_mains[ii]->main_loop_count)
1712 * Check the frame queue to see if any frames are available.
1713 * If so, pull the packets off the frames and put them to
1717 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm)
1719 u32 thread_id = vm->thread_index;
1720 vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1721 vlib_frame_queue_elt_t *elt;
1730 ASSERT (vm == vlib_mains[thread_id]);
1732 if (PREDICT_FALSE (fqm->node_index == ~0))
1735 * Gather trace data for frame queues
1737 if (PREDICT_FALSE (fq->trace))
1739 frame_queue_trace_t *fqt;
1740 frame_queue_nelt_counter_t *fqh;
1743 fqt = &fqm->frame_queue_traces[thread_id];
1745 fqt->nelts = fq->nelts;
1746 fqt->head = fq->head;
1747 fqt->head_hint = fq->head_hint;
1748 fqt->tail = fq->tail;
1749 fqt->threshold = fq->vector_threshold;
1750 fqt->n_in_use = fqt->tail - fqt->head;
1751 if (fqt->n_in_use >= fqt->nelts)
1753 // if beyond max then use max
1754 fqt->n_in_use = fqt->nelts - 1;
1757 /* Record the number of elements in use in the histogram */
1758 fqh = &fqm->frame_queue_histogram[thread_id];
1759 fqh->count[fqt->n_in_use]++;
1761 /* Record a snapshot of the elements in use */
1762 for (elix = 0; elix < fqt->nelts; elix++)
1764 elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1765 if (1 || elt->valid)
1767 fqt->n_vectors[elix] = elt->n_vectors;
1776 if (fq->head == fq->tail)
1778 fq->head_hint = fq->head;
1782 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1786 fq->head_hint = fq->head;
1790 from = elt->buffer_index;
1791 msg_type = elt->msg_type;
1793 ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1794 ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1796 f = vlib_get_frame_to_node (vm, fqm->node_index);
1798 /* If the first vector is traced, set the frame trace flag */
1799 b = vlib_get_buffer (vm, from[0]);
1800 if (b->flags & VLIB_BUFFER_IS_TRACED)
1801 f->frame_flags |= VLIB_NODE_FLAG_TRACE;
1803 to = vlib_frame_vector_args (f);
1805 n_left_to_node = elt->n_vectors;
1807 while (n_left_to_node >= 4)
1815 n_left_to_node -= 4;
1818 while (n_left_to_node > 0)
1826 vectors += elt->n_vectors;
1827 f->n_vectors = elt->n_vectors;
1828 vlib_put_frame_to_node (vm, fqm->node_index, f);
1832 elt->msg_type = 0xfefefefe;
1833 CLIB_MEMORY_BARRIER ();
1838 * Limit the number of packets pushed into the graph
1840 if (vectors >= fq->vector_threshold)
1842 fq->head_hint = fq->head;
1851 vlib_worker_thread_fn (void *arg)
1853 vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1854 vlib_thread_main_t *tm = vlib_get_thread_main ();
1855 vlib_main_t *vm = vlib_get_main ();
1858 vlib_process_finish_switch_stack (vm);
1860 ASSERT (vm->thread_index == vlib_get_thread_index ());
1862 vlib_worker_thread_init (w);
1863 clib_time_init (&vm->clib_time);
1864 clib_mem_set_heap (w->thread_mheap);
1866 e = vlib_call_init_exit_functions_no_sort
1867 (vm, &vm->worker_init_function_registrations, 1 /* call_once */ );
1869 clib_error_report (e);
1871 /* Wait until the dpdk init sequence is complete */
1872 while (tm->extern_thread_mgmt && tm->worker_thread_release == 0)
1873 vlib_worker_thread_barrier_check ();
1875 vlib_worker_loop (vm);
1879 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1882 .function = vlib_worker_thread_fn,
1887 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1889 vlib_thread_main_t *tm = vlib_get_thread_main ();
1890 vlib_frame_queue_main_t *fqm;
1891 vlib_frame_queue_t *fq;
1895 if (frame_queue_nelts == 0)
1896 frame_queue_nelts = FRAME_QUEUE_MAX_NELTS;
1898 num_threads = 1 /* main thread */ + tm->n_threads;
1899 ASSERT (frame_queue_nelts >= 8 + num_threads);
1901 vec_add2 (tm->frame_queue_mains, fqm, 1);
1903 fqm->node_index = node_index;
1904 fqm->frame_queue_nelts = frame_queue_nelts;
1905 fqm->queue_hi_thresh = frame_queue_nelts - num_threads;
1907 vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1908 vec_validate (fqm->per_thread_data, tm->n_vlib_mains - 1);
1909 _vec_len (fqm->vlib_frame_queues) = 0;
1910 for (i = 0; i < tm->n_vlib_mains; i++)
1912 vlib_frame_queue_per_thread_data_t *ptd;
1913 fq = vlib_frame_queue_alloc (frame_queue_nelts);
1914 vec_add1 (fqm->vlib_frame_queues, fq);
1916 ptd = vec_elt_at_index (fqm->per_thread_data, i);
1917 vec_validate (ptd->handoff_queue_elt_by_thread_index,
1918 tm->n_vlib_mains - 1);
1919 vec_validate_init_empty (ptd->congested_handoff_queue_by_thread_index,
1920 tm->n_vlib_mains - 1,
1921 (vlib_frame_queue_t *) (~0));
1924 return (fqm - tm->frame_queue_mains);
1928 vlib_thread_cb_register (struct vlib_main_t *vm, vlib_thread_callbacks_t * cb)
1930 vlib_thread_main_t *tm = vlib_get_thread_main ();
1932 if (tm->extern_thread_mgmt)
1935 tm->cb.vlib_launch_thread_cb = cb->vlib_launch_thread_cb;
1936 tm->extern_thread_mgmt = 1;
1941 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1944 ASSERT (vlib_get_thread_index () == 0);
1945 vlib_process_signal_event (vlib_get_main (), args->node_index,
1946 args->type_opaque, args->data);
1949 void *rpc_call_main_thread_cb_fn;
1952 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1954 if (rpc_call_main_thread_cb_fn)
1956 void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1957 (*fp) (callback, args, arg_size);
1960 clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1964 threads_init (vlib_main_t * vm)
1969 VLIB_INIT_FUNCTION (threads_init);
1972 static clib_error_t *
1973 show_clock_command_fn (vlib_main_t * vm,
1974 unformat_input_t * input, vlib_cli_command_t * cmd)
1978 clib_timebase_t _tb, *tb = &_tb;
1980 (void) unformat (input, "verbose %=", &verbose, 1);
1982 clib_timebase_init (tb, 0 /* GMT */ , CLIB_TIMEBASE_DAYLIGHT_NONE,
1985 vlib_cli_output (vm, "%U, %U GMT", format_clib_time, &vm->clib_time,
1986 verbose, format_clib_timebase_time,
1987 clib_timebase_now (tb));
1989 if (vec_len (vlib_mains) == 1)
1992 vlib_cli_output (vm, "Time last barrier release %.9f",
1993 vm->time_last_barrier_release);
1995 for (i = 1; i < vec_len (vlib_mains); i++)
1997 if (vlib_mains[i] == 0)
2000 vlib_cli_output (vm, "%d: %U", i, format_clib_time,
2001 &vlib_mains[i]->clib_time, verbose);
2003 vlib_cli_output (vm, "Thread %d offset %.9f error %.9f", i,
2004 vlib_mains[i]->time_offset,
2005 vm->time_last_barrier_release -
2006 vlib_mains[i]->time_last_barrier_release);
2012 VLIB_CLI_COMMAND (f_command, static) =
2014 .path = "show clock",
2015 .short_help = "show clock",
2016 .function = show_clock_command_fn,
2020 vlib_thread_main_t *
2021 vlib_get_thread_main_not_inline (void)
2023 return vlib_get_thread_main ();
2027 * fd.io coding-style-patch-verification: ON
2030 * eval: (c-set-style "gnu")