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/linux/sysfs.h>
21 #include <vlib/vlib.h>
23 #include <vlib/threads.h>
24 #include <vlib/unix/cj.h>
26 #include <vlib/stat_weak_inlines.h>
28 DECLARE_CJ_GLOBAL_LOG;
37 vlib_worker_thread_t *vlib_worker_threads;
38 vlib_thread_main_t vlib_thread_main;
41 * Barrier tracing can be enabled on a normal build to collect information
42 * on barrier use, including timings and call stacks. Deliberately not
43 * keyed off CLIB_DEBUG, because that can add significant overhead which
44 * imapacts observed timings.
48 barrier_trace_sync (f64 t_entry, f64 t_open, f64 t_closed)
50 if (!vlib_worker_threads->barrier_elog_enabled)
54 ELOG_TYPE_DECLARE (e) =
56 .format = "bar-trace-%s-#%d",
57 .format_args = "T4i4",
62 u32 caller, count, t_entry, t_open, t_closed;
65 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
66 ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
67 ed->caller = elog_string (&vlib_global_main.elog_main,
68 (char *) vlib_worker_threads[0].barrier_caller);
69 ed->t_entry = (int) (1000000.0 * t_entry);
70 ed->t_open = (int) (1000000.0 * t_open);
71 ed->t_closed = (int) (1000000.0 * t_closed);
75 barrier_trace_sync_rec (f64 t_entry)
77 if (!vlib_worker_threads->barrier_elog_enabled)
81 ELOG_TYPE_DECLARE (e) =
83 .format = "bar-syncrec-%s-#%d",
84 .format_args = "T4i4",
92 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
93 ed->depth = (int) vlib_worker_threads[0].recursion_level - 1;
94 ed->caller = elog_string (&vlib_global_main.elog_main,
95 (char *) vlib_worker_threads[0].barrier_caller);
99 barrier_trace_release_rec (f64 t_entry)
101 if (!vlib_worker_threads->barrier_elog_enabled)
105 ELOG_TYPE_DECLARE (e) =
107 .format = "bar-relrrec-#%d",
116 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
117 ed->depth = (int) vlib_worker_threads[0].recursion_level;
121 barrier_trace_release (f64 t_entry, f64 t_closed_total, f64 t_update_main)
123 if (!vlib_worker_threads->barrier_elog_enabled)
127 ELOG_TYPE_DECLARE (e) =
129 .format = "bar-rel-#%d-e%d-u%d-t%d",
130 .format_args = "i4i4i4i4",
135 u32 count, t_entry, t_update_main, t_closed_total;
138 ed = ELOG_DATA (&vlib_global_main.elog_main, e);
139 ed->t_entry = (int) (1000000.0 * t_entry);
140 ed->t_update_main = (int) (1000000.0 * t_update_main);
141 ed->t_closed_total = (int) (1000000.0 * t_closed_total);
142 ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
144 /* Reset context for next trace */
145 vlib_worker_threads[0].barrier_context = NULL;
149 os_get_nthreads (void)
151 return vec_len (vlib_thread_stacks);
155 vlib_set_thread_name (char *name)
157 int pthread_setname_np (pthread_t __target_thread, const char *__name);
159 pthread_t thread = pthread_self ();
163 rv = pthread_setname_np (thread, name);
165 clib_warning ("pthread_setname_np returned %d", rv);
170 sort_registrations_by_no_clone (void *a0, void *a1)
172 vlib_thread_registration_t **tr0 = a0;
173 vlib_thread_registration_t **tr1 = a1;
175 return ((i32) ((*tr0)->no_data_structure_clone)
176 - ((i32) ((*tr1)->no_data_structure_clone)));
180 clib_sysfs_list_to_bitmap (char *filename)
185 fp = fopen (filename, "r");
190 vec_validate (buffer, 256 - 1);
191 if (fgets ((char *) buffer, 256, fp))
194 unformat_init_string (&in, (char *) buffer,
195 strlen ((char *) buffer));
196 if (unformat (&in, "%U", unformat_bitmap_list, &r) != 1)
197 clib_warning ("unformat_bitmap_list failed");
207 /* Called early in the init sequence */
210 vlib_thread_init (vlib_main_t * vm)
212 vlib_thread_main_t *tm = &vlib_thread_main;
213 vlib_worker_thread_t *w;
214 vlib_thread_registration_t *tr;
215 u32 n_vlib_mains = 1;
220 /* get bitmaps of active cpu cores and sockets */
221 tm->cpu_core_bitmap =
222 clib_sysfs_list_to_bitmap ("/sys/devices/system/cpu/online");
223 tm->cpu_socket_bitmap =
224 clib_sysfs_list_to_bitmap ("/sys/devices/system/node/online");
226 avail_cpu = clib_bitmap_dup (tm->cpu_core_bitmap);
229 for (i = 0; i < tm->skip_cores; i++)
231 uword c = clib_bitmap_first_set (avail_cpu);
233 return clib_error_return (0, "no available cpus to skip");
235 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
238 /* grab cpu for main thread */
239 if (tm->main_lcore == ~0)
241 /* if main-lcore is not set, we try to use lcore 1 */
242 if (clib_bitmap_get (avail_cpu, 1))
245 tm->main_lcore = clib_bitmap_first_set (avail_cpu);
246 if (tm->main_lcore == (u8) ~ 0)
247 return clib_error_return (0, "no available cpus to be used for the"
252 if (clib_bitmap_get (avail_cpu, tm->main_lcore) == 0)
253 return clib_error_return (0, "cpu %u is not available to be used"
254 " for the main thread", tm->main_lcore);
256 avail_cpu = clib_bitmap_set (avail_cpu, tm->main_lcore, 0);
259 * Determine if the number of workers is greater than 0.
260 * If so, mark CPU 0 unavailable so workers will be numbered after main.
263 uword *p = hash_get_mem (tm->thread_registrations_by_name, "workers");
266 vlib_thread_registration_t *tr = (vlib_thread_registration_t *) p[0];
267 int worker_thread_count = tr->count;
268 n_workers = worker_thread_count;
270 if (tm->skip_cores == 0 && n_workers)
271 avail_cpu = clib_bitmap_set (avail_cpu, 0, 0);
273 /* assume that there is socket 0 only if there is no data from sysfs */
274 if (!tm->cpu_socket_bitmap)
275 tm->cpu_socket_bitmap = clib_bitmap_set (0, 0, 1);
277 /* pin main thread to main_lcore */
278 if (tm->cb.vlib_thread_set_lcore_cb)
280 tm->cb.vlib_thread_set_lcore_cb (0, tm->main_lcore);
286 CPU_SET (tm->main_lcore, &cpuset);
287 pthread_setaffinity_np (pthread_self (), sizeof (cpu_set_t), &cpuset);
290 /* Set up thread 0 */
291 vec_validate_aligned (vlib_worker_threads, 0, CLIB_CACHE_LINE_BYTES);
292 _vec_len (vlib_worker_threads) = 1;
293 w = vlib_worker_threads;
294 w->thread_mheap = clib_mem_get_heap ();
295 w->thread_stack = vlib_thread_stacks[0];
296 w->cpu_id = tm->main_lcore;
297 w->lwp = syscall (SYS_gettid);
298 w->thread_id = pthread_self ();
299 tm->n_vlib_mains = 1;
301 vlib_get_thread_core_numa (w, w->cpu_id);
303 if (tm->sched_policy != ~0)
305 struct sched_param sched_param;
306 if (!sched_getparam (w->lwp, &sched_param))
308 if (tm->sched_priority != ~0)
309 sched_param.sched_priority = tm->sched_priority;
310 sched_setscheduler (w->lwp, tm->sched_policy, &sched_param);
314 /* assign threads to cores and set n_vlib_mains */
319 vec_add1 (tm->registrations, tr);
323 vec_sort_with_function (tm->registrations, sort_registrations_by_no_clone);
325 for (i = 0; i < vec_len (tm->registrations); i++)
328 tr = tm->registrations[i];
329 tr->first_index = first_index;
330 first_index += tr->count;
331 n_vlib_mains += (tr->no_data_structure_clone == 0) ? tr->count : 0;
333 /* construct coremask */
334 if (tr->use_pthreads || !tr->count)
341 clib_bitmap_foreach (c, tr->coremask, ({
342 if (clib_bitmap_get(avail_cpu, c) == 0)
343 return clib_error_return (0, "cpu %u is not available to be used"
344 " for the '%s' thread",c, tr->name);
346 avail_cpu = clib_bitmap_set(avail_cpu, c, 0);
352 for (j = 0; j < tr->count; j++)
354 uword c = clib_bitmap_first_set (avail_cpu);
356 return clib_error_return (0,
357 "no available cpus to be used for"
358 " the '%s' thread", tr->name);
360 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
361 tr->coremask = clib_bitmap_set (tr->coremask, c, 1);
366 clib_bitmap_free (avail_cpu);
368 tm->n_vlib_mains = n_vlib_mains;
371 * Allocate the remaining worker threads, and thread stack vector slots
372 * from now on, calls to os_get_nthreads() will return the correct
375 vec_validate_aligned (vlib_worker_threads, first_index - 1,
376 CLIB_CACHE_LINE_BYTES);
377 vec_validate (vlib_thread_stacks, vec_len (vlib_worker_threads) - 1);
382 vlib_frame_queue_alloc (int nelts)
384 vlib_frame_queue_t *fq;
386 fq = clib_mem_alloc_aligned (sizeof (*fq), CLIB_CACHE_LINE_BYTES);
387 clib_memset (fq, 0, sizeof (*fq));
389 fq->vector_threshold = 128; // packets
390 vec_validate_aligned (fq->elts, nelts - 1, CLIB_CACHE_LINE_BYTES);
394 if (((uword) & fq->tail) & (CLIB_CACHE_LINE_BYTES - 1))
395 fformat (stderr, "WARNING: fq->tail unaligned\n");
396 if (((uword) & fq->head) & (CLIB_CACHE_LINE_BYTES - 1))
397 fformat (stderr, "WARNING: fq->head unaligned\n");
398 if (((uword) fq->elts) & (CLIB_CACHE_LINE_BYTES - 1))
399 fformat (stderr, "WARNING: fq->elts unaligned\n");
401 if (sizeof (fq->elts[0]) % CLIB_CACHE_LINE_BYTES)
402 fformat (stderr, "WARNING: fq->elts[0] size %d\n",
403 sizeof (fq->elts[0]));
404 if (nelts & (nelts - 1))
406 fformat (stderr, "FATAL: nelts MUST be a power of 2\n");
414 void vl_msg_api_handler_no_free (void *) __attribute__ ((weak));
416 vl_msg_api_handler_no_free (void *v)
420 /* Turned off, save as reference material... */
423 vlib_frame_queue_dequeue_internal (int thread_id,
424 vlib_main_t * vm, vlib_node_main_t * nm)
426 vlib_frame_queue_t *fq = vlib_frame_queues[thread_id];
427 vlib_frame_queue_elt_t *elt;
429 vlib_pending_frame_t *p;
430 vlib_node_runtime_t *r;
431 u32 node_runtime_index;
436 ASSERT (vm == vlib_mains[thread_id]);
440 if (fq->head == fq->tail)
443 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
448 before = clib_cpu_time_now ();
451 node_runtime_index = elt->node_runtime_index;
452 msg_type = elt->msg_type;
456 case VLIB_FRAME_QUEUE_ELT_FREE_BUFFERS:
457 vlib_buffer_free (vm, vlib_frame_vector_args (f), f->n_vectors);
458 /* note fallthrough... */
459 case VLIB_FRAME_QUEUE_ELT_FREE_FRAME:
460 r = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
462 vlib_frame_free (vm, r, f);
464 case VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME:
465 vec_add2 (vm->node_main.pending_frames, p, 1);
466 f->flags |= (VLIB_FRAME_PENDING | VLIB_FRAME_FREE_AFTER_DISPATCH);
467 p->node_runtime_index = elt->node_runtime_index;
468 p->frame_index = vlib_frame_index (vm, f);
469 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
470 fq->dequeue_vectors += (u64) f->n_vectors;
472 case VLIB_FRAME_QUEUE_ELT_API_MSG:
473 vl_msg_api_handler_no_free (f);
476 clib_warning ("bogus frame queue message, type %d", msg_type);
481 fq->dequeue_ticks += clib_cpu_time_now () - before;
482 CLIB_MEMORY_BARRIER ();
491 vlib_frame_queue_dequeue (int thread_id,
492 vlib_main_t * vm, vlib_node_main_t * nm)
494 return vlib_frame_queue_dequeue_internal (thread_id, vm, nm);
498 vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
499 u32 frame_queue_index, vlib_frame_t * frame,
500 vlib_frame_queue_msg_type_t type)
502 vlib_frame_queue_t *fq = vlib_frame_queues[frame_queue_index];
503 vlib_frame_queue_elt_t *elt;
506 u64 before = clib_cpu_time_now ();
510 new_tail = clib_atomic_add_fetch (&fq->tail, 1);
512 /* Wait until a ring slot is available */
513 while (new_tail >= fq->head + fq->nelts)
515 f64 b4 = vlib_time_now_ticks (vm, before);
516 vlib_worker_thread_barrier_check (vm, b4);
517 /* Bad idea. Dequeue -> enqueue -> dequeue -> trouble */
518 // vlib_frame_queue_dequeue (vm->thread_index, vm, nm);
521 elt = fq->elts + (new_tail & (fq->nelts - 1));
523 /* this would be very bad... */
528 /* Once we enqueue the frame, frame->n_vectors is owned elsewhere... */
529 save_count = frame->n_vectors;
532 elt->node_runtime_index = node_runtime_index;
533 elt->msg_type = type;
534 CLIB_MEMORY_BARRIER ();
541 /* To be called by vlib worker threads upon startup */
543 vlib_worker_thread_init (vlib_worker_thread_t * w)
545 vlib_thread_main_t *tm = vlib_get_thread_main ();
548 * Note: disabling signals in worker threads as follows
549 * prevents the api post-mortem dump scheme from working
553 * pthread_sigmask (SIG_SETMASK, &s, 0);
557 clib_mem_set_heap (w->thread_mheap);
559 if (vec_len (tm->thread_prefix) && w->registration->short_name)
561 w->name = format (0, "%v_%s_%d%c", tm->thread_prefix,
562 w->registration->short_name, w->instance_id, '\0');
563 vlib_set_thread_name ((char *) w->name);
566 if (!w->registration->use_pthreads)
569 /* Initial barrier sync, for both worker and i/o threads */
570 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
572 while (*vlib_worker_threads->wait_at_barrier)
575 clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
580 vlib_worker_thread_bootstrap_fn (void *arg)
583 vlib_worker_thread_t *w = arg;
585 w->lwp = syscall (SYS_gettid);
586 w->thread_id = pthread_self ();
588 __os_thread_index = w - vlib_worker_threads;
590 rv = (void *) clib_calljmp
591 ((uword (*)(uword)) w->thread_function,
592 (uword) arg, w->thread_stack + VLIB_THREAD_STACK_SIZE);
593 /* NOTREACHED, we hope */
598 vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id)
600 const char *sys_cpu_path = "/sys/devices/system/cpu/cpu";
601 const char *sys_node_path = "/sys/devices/system/node/node";
602 clib_bitmap_t *nbmp = 0, *cbmp = 0;
605 int core_id = -1, numa_id = -1;
607 p = format (p, "%s%u/topology/core_id%c", sys_cpu_path, cpu_id, 0);
608 clib_sysfs_read ((char *) p, "%d", &core_id);
609 vec_reset_length (p);
612 clib_sysfs_read ("/sys/devices/system/node/online", "%U",
613 unformat_bitmap_list, &nbmp);
614 clib_bitmap_foreach (node, nbmp, ({
615 p = format (p, "%s%u/cpulist%c", sys_node_path, node, 0);
616 clib_sysfs_read ((char *) p, "%U", unformat_bitmap_list, &cbmp);
617 if (clib_bitmap_get (cbmp, cpu_id))
619 vec_reset_length (cbmp);
620 vec_reset_length (p);
627 w->core_id = core_id;
628 w->numa_id = numa_id;
631 static clib_error_t *
632 vlib_launch_thread_int (void *fp, vlib_worker_thread_t * w, unsigned cpu_id)
634 vlib_thread_main_t *tm = &vlib_thread_main;
635 void *(*fp_arg) (void *) = fp;
639 vlib_get_thread_core_numa (w, cpu_id);
641 /* Set up NUMA-bound heap if indicated */
642 if (clib_per_numa_mheaps[w->numa_id] == 0)
644 /* If the user requested a NUMA heap, create it... */
645 if (tm->numa_heap_size)
647 numa_heap = clib_mem_init_thread_safe_numa
648 (0 /* DIY */ , tm->numa_heap_size, w->numa_id);
649 clib_per_numa_mheaps[w->numa_id] = numa_heap;
653 /* Or, use the main heap */
654 clib_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 u8 *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 if (n_vlib_mains > 1)
710 /* Replace hand-crafted length-1 vector with a real vector */
713 vec_validate_aligned (vlib_mains, tm->n_vlib_mains - 1,
714 CLIB_CACHE_LINE_BYTES);
715 _vec_len (vlib_mains) = 0;
716 vec_add1_aligned (vlib_mains, vm, CLIB_CACHE_LINE_BYTES);
718 vlib_worker_threads->wait_at_barrier =
719 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
720 vlib_worker_threads->workers_at_barrier =
721 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
723 vlib_worker_threads->node_reforks_required =
724 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
726 /* We'll need the rpc vector lock... */
727 clib_spinlock_init (&vm->pending_rpc_lock);
729 /* Ask for an initial barrier sync */
730 *vlib_worker_threads->workers_at_barrier = 0;
731 *vlib_worker_threads->wait_at_barrier = 1;
733 /* Without update or refork */
734 *vlib_worker_threads->node_reforks_required = 0;
735 vm->need_vlib_worker_thread_node_runtime_update = 0;
738 vm->barrier_epoch = 0;
739 vm->barrier_no_close_before = 0;
741 worker_thread_index = 1;
743 for (i = 0; i < vec_len (tm->registrations); i++)
745 vlib_node_main_t *nm, *nm_clone;
748 tr = tm->registrations[i];
753 for (k = 0; k < tr->count; k++)
757 vec_add2 (vlib_worker_threads, w, 1);
758 /* Currently unused, may not really work */
760 w->thread_mheap = create_mspace (tr->mheap_size,
763 w->thread_mheap = main_heap;
766 vlib_thread_stack_init (w - vlib_worker_threads);
767 w->thread_function = tr->function;
768 w->thread_function_arg = w;
770 w->registration = tr;
773 (char *) format (0, "%s %d", tr->name, k + 1);
774 vec_add1 (w->elog_track.name, 0);
775 elog_track_register (&vm->elog_main, &w->elog_track);
777 if (tr->no_data_structure_clone)
780 /* Fork vlib_global_main et al. Look for bugs here */
781 oldheap = clib_mem_set_heap (w->thread_mheap);
783 vm_clone = clib_mem_alloc_aligned (sizeof (*vm_clone),
784 CLIB_CACHE_LINE_BYTES);
785 clib_memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
787 vm_clone->thread_index = worker_thread_index;
788 vm_clone->heap_base = w->thread_mheap;
789 vm_clone->heap_aligned_base = (void *)
790 (((uword) w->thread_mheap) & ~(VLIB_FRAME_ALIGN - 1));
791 vm_clone->init_functions_called =
792 hash_create (0, /* value bytes */ 0);
793 vm_clone->pending_rpc_requests = 0;
794 vec_validate (vm_clone->pending_rpc_requests, 0);
795 _vec_len (vm_clone->pending_rpc_requests) = 0;
796 clib_memset (&vm_clone->random_buffer, 0,
797 sizeof (vm_clone->random_buffer));
799 nm = &vlib_mains[0]->node_main;
800 nm_clone = &vm_clone->node_main;
801 /* fork next frames array, preserving node runtime indices */
802 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
803 CLIB_CACHE_LINE_BYTES);
804 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
806 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
807 u32 save_node_runtime_index;
810 save_node_runtime_index = nf->node_runtime_index;
811 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
812 vlib_next_frame_init (nf);
813 nf->node_runtime_index = save_node_runtime_index;
814 nf->flags = save_flags;
817 /* fork the frame dispatch queue */
818 nm_clone->pending_frames = 0;
819 vec_validate (nm_clone->pending_frames, 10);
820 _vec_len (nm_clone->pending_frames) = 0;
825 /* Allocate all nodes in single block for speed */
826 n = clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*n));
828 for (j = 0; j < vec_len (nm->nodes); j++)
830 clib_memcpy (n, nm->nodes[j], sizeof (*n));
831 /* none of the copied nodes have enqueue rights given out */
832 n->owner_node_index = VLIB_INVALID_NODE_INDEX;
833 clib_memset (&n->stats_total, 0, sizeof (n->stats_total));
834 clib_memset (&n->stats_last_clear, 0,
835 sizeof (n->stats_last_clear));
836 vec_add1 (nm_clone->nodes, n);
839 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
840 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
841 CLIB_CACHE_LINE_BYTES);
843 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
845 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
846 rt->thread_index = vm_clone->thread_index;
847 /* copy initial runtime_data from node */
848 if (n->runtime_data && n->runtime_data_bytes > 0)
849 clib_memcpy (rt->runtime_data, n->runtime_data,
850 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
851 n->runtime_data_bytes));
854 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
855 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
856 CLIB_CACHE_LINE_BYTES);
857 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
859 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
860 rt->thread_index = vm_clone->thread_index;
861 /* copy initial runtime_data from node */
862 if (n->runtime_data && n->runtime_data_bytes > 0)
863 clib_memcpy (rt->runtime_data, n->runtime_data,
864 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
865 n->runtime_data_bytes));
868 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
869 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
870 CLIB_CACHE_LINE_BYTES);
872 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
874 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
875 rt->thread_index = vm_clone->thread_index;
876 /* copy initial runtime_data from node */
877 if (n->runtime_data && n->runtime_data_bytes > 0)
878 clib_memcpy (rt->runtime_data, n->runtime_data,
879 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
880 n->runtime_data_bytes));
883 nm_clone->processes = vec_dup_aligned (nm->processes,
884 CLIB_CACHE_LINE_BYTES);
886 /* Create per-thread frame freelist */
887 nm_clone->frame_sizes = vec_new (vlib_frame_size_t, 1);
888 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
889 nm_clone->frame_size_hash = hash_create (0, sizeof (uword));
891 nm_clone->node_by_error = nm->node_by_error;
893 /* Packet trace buffers are guaranteed to be empty, nothing to do here */
895 clib_mem_set_heap (oldheap);
896 vec_add1_aligned (vlib_mains, vm_clone, CLIB_CACHE_LINE_BYTES);
898 /* Switch to the stats segment ... */
899 void *oldheap = vlib_stats_push_heap (0);
900 vm_clone->error_main.counters = vec_dup_aligned
901 (vlib_mains[0]->error_main.counters, CLIB_CACHE_LINE_BYTES);
902 vlib_stats_pop_heap2 (vm_clone->error_main.counters,
903 worker_thread_index, oldheap, 1);
905 vm_clone->error_main.counters_last_clear = vec_dup_aligned
906 (vlib_mains[0]->error_main.counters_last_clear,
907 CLIB_CACHE_LINE_BYTES);
909 worker_thread_index++;
915 /* only have non-data-structure copy threads to create... */
916 for (i = 0; i < vec_len (tm->registrations); i++)
918 tr = tm->registrations[i];
920 for (j = 0; j < tr->count; j++)
922 vec_add2 (vlib_worker_threads, w, 1);
926 create_mspace (tr->mheap_size, 0 /* locked */ );
929 w->thread_mheap = main_heap;
931 vlib_thread_stack_init (w - vlib_worker_threads);
932 w->thread_function = tr->function;
933 w->thread_function_arg = w;
936 (char *) format (0, "%s %d", tr->name, j + 1);
937 w->registration = tr;
938 vec_add1 (w->elog_track.name, 0);
939 elog_track_register (&vm->elog_main, &w->elog_track);
944 worker_thread_index = 1;
946 for (i = 0; i < vec_len (tm->registrations); i++)
951 tr = tm->registrations[i];
953 if (tr->use_pthreads || tm->use_pthreads)
955 for (j = 0; j < tr->count; j++)
957 w = vlib_worker_threads + worker_thread_index++;
958 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
961 clib_error_report (err);
968 clib_bitmap_foreach (c, tr->coremask, ({
969 w = vlib_worker_threads + worker_thread_index++;
970 err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
973 clib_error_report (err);
978 vlib_worker_thread_barrier_sync (vm);
979 vlib_worker_thread_barrier_release (vm);
983 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
987 worker_thread_node_runtime_update_internal (void)
991 vlib_node_main_t *nm, *nm_clone;
992 vlib_main_t *vm_clone;
993 vlib_node_runtime_t *rt;
995 vlib_node_runtime_sync_stats (vlib_main_t * vm,
996 vlib_node_runtime_t * r,
998 uword n_vectors, uword n_clocks);
1000 ASSERT (vlib_get_thread_index () == 0);
1003 nm = &vm->node_main;
1005 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
1008 * Scrape all runtime stats, so we don't lose node runtime(s) with
1009 * pending counts, or throw away worker / io thread counts.
1011 for (j = 0; j < vec_len (nm->nodes); j++)
1015 vlib_node_sync_stats (vm, n);
1018 for (i = 1; i < vec_len (vlib_mains); i++)
1022 vm_clone = vlib_mains[i];
1023 nm_clone = &vm_clone->node_main;
1025 for (j = 0; j < vec_len (nm_clone->nodes); j++)
1027 n = nm_clone->nodes[j];
1029 rt = vlib_node_get_runtime (vm_clone, n->index);
1030 vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
1034 /* Per-worker clone rebuilds are now done on each thread */
1039 vlib_worker_thread_node_refork (void)
1041 vlib_main_t *vm, *vm_clone;
1042 vlib_node_main_t *nm, *nm_clone;
1043 vlib_node_t **old_nodes_clone;
1044 vlib_node_runtime_t *rt, *old_rt;
1046 vlib_node_t *new_n_clone;
1051 nm = &vm->node_main;
1052 vm_clone = vlib_get_main ();
1053 nm_clone = &vm_clone->node_main;
1055 /* Re-clone error heap */
1056 u64 *old_counters = vm_clone->error_main.counters;
1057 u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
1059 clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
1060 sizeof (vm->error_main));
1061 j = vec_len (vm->error_main.counters) - 1;
1063 /* Switch to the stats segment ... */
1064 void *oldheap = vlib_stats_push_heap (0);
1065 vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
1066 vm_clone->error_main.counters = old_counters;
1067 vlib_stats_pop_heap2 (vm_clone->error_main.counters, vm_clone->thread_index,
1070 vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
1071 vm_clone->error_main.counters_last_clear = old_counters_all_clear;
1073 nm_clone = &vm_clone->node_main;
1074 vec_free (nm_clone->next_frames);
1075 nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
1076 CLIB_CACHE_LINE_BYTES);
1078 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
1080 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
1081 u32 save_node_runtime_index;
1084 save_node_runtime_index = nf->node_runtime_index;
1085 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
1086 vlib_next_frame_init (nf);
1087 nf->node_runtime_index = save_node_runtime_index;
1088 nf->flags = save_flags;
1091 old_nodes_clone = nm_clone->nodes;
1092 nm_clone->nodes = 0;
1096 /* Allocate all nodes in single block for speed */
1098 clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
1099 for (j = 0; j < vec_len (nm->nodes); j++)
1101 vlib_node_t *new_n = nm->nodes[j];
1103 clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
1104 /* none of the copied nodes have enqueue rights given out */
1105 new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
1107 if (j >= vec_len (old_nodes_clone))
1109 /* new node, set to zero */
1110 clib_memset (&new_n_clone->stats_total, 0,
1111 sizeof (new_n_clone->stats_total));
1112 clib_memset (&new_n_clone->stats_last_clear, 0,
1113 sizeof (new_n_clone->stats_last_clear));
1117 vlib_node_t *old_n_clone = old_nodes_clone[j];
1118 /* Copy stats if the old data is valid */
1119 clib_memcpy_fast (&new_n_clone->stats_total,
1120 &old_n_clone->stats_total,
1121 sizeof (new_n_clone->stats_total));
1122 clib_memcpy_fast (&new_n_clone->stats_last_clear,
1123 &old_n_clone->stats_last_clear,
1124 sizeof (new_n_clone->stats_last_clear));
1126 /* keep previous node state */
1127 new_n_clone->state = old_n_clone->state;
1129 vec_add1 (nm_clone->nodes, new_n_clone);
1132 /* Free the old node clones */
1133 clib_mem_free (old_nodes_clone[0]);
1135 vec_free (old_nodes_clone);
1138 /* re-clone internal nodes */
1139 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
1140 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
1141 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1142 CLIB_CACHE_LINE_BYTES);
1144 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
1146 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1147 rt->thread_index = vm_clone->thread_index;
1148 /* copy runtime_data, will be overwritten later for existing rt */
1149 if (n->runtime_data && n->runtime_data_bytes > 0)
1150 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1151 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1152 n->runtime_data_bytes));
1155 for (j = 0; j < vec_len (old_rt); j++)
1157 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1158 rt->state = old_rt[j].state;
1159 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1160 VLIB_NODE_RUNTIME_DATA_SIZE);
1165 /* re-clone input nodes */
1166 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1167 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1168 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1169 CLIB_CACHE_LINE_BYTES);
1171 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1173 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1174 rt->thread_index = vm_clone->thread_index;
1175 /* copy runtime_data, will be overwritten later for existing rt */
1176 if (n->runtime_data && n->runtime_data_bytes > 0)
1177 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1178 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1179 n->runtime_data_bytes));
1182 for (j = 0; j < vec_len (old_rt); j++)
1184 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1185 rt->state = old_rt[j].state;
1186 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1187 VLIB_NODE_RUNTIME_DATA_SIZE);
1192 /* re-clone pre-input nodes */
1193 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT];
1194 nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
1195 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
1196 CLIB_CACHE_LINE_BYTES);
1198 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1200 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1201 rt->thread_index = vm_clone->thread_index;
1202 /* copy runtime_data, will be overwritten later for existing rt */
1203 if (n->runtime_data && n->runtime_data_bytes > 0)
1204 clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1205 clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1206 n->runtime_data_bytes));
1209 for (j = 0; j < vec_len (old_rt); j++)
1211 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1212 rt->state = old_rt[j].state;
1213 clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1214 VLIB_NODE_RUNTIME_DATA_SIZE);
1219 nm_clone->processes = vec_dup_aligned (nm->processes,
1220 CLIB_CACHE_LINE_BYTES);
1221 nm_clone->node_by_error = nm->node_by_error;
1225 vlib_worker_thread_node_runtime_update (void)
1228 * Make a note that we need to do a node runtime update
1229 * prior to releasing the barrier.
1231 vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1235 unformat_sched_policy (unformat_input_t * input, va_list * args)
1237 u32 *r = va_arg (*args, u32 *);
1240 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1241 foreach_sched_policy
1248 static clib_error_t *
1249 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1251 vlib_thread_registration_t *tr;
1253 vlib_thread_main_t *tm = &vlib_thread_main;
1258 tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1260 tm->n_thread_stacks = 1; /* account for main thread */
1261 tm->sched_policy = ~0;
1262 tm->sched_priority = ~0;
1263 tm->main_lcore = ~0;
1269 hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1273 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1275 if (unformat (input, "use-pthreads"))
1276 tm->use_pthreads = 1;
1277 else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1279 else if (unformat (input, "main-core %u", &tm->main_lcore))
1281 else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1283 else if (unformat (input, "numa-heap-size %U",
1284 unformat_memory_size, &tm->numa_heap_size))
1286 else if (unformat (input, "coremask-%s %U", &name,
1287 unformat_bitmap_mask, &bitmap) ||
1288 unformat (input, "corelist-%s %U", &name,
1289 unformat_bitmap_list, &bitmap))
1291 p = hash_get_mem (tm->thread_registrations_by_name, name);
1293 return clib_error_return (0, "no such thread type '%s'", name);
1295 tr = (vlib_thread_registration_t *) p[0];
1297 if (tr->use_pthreads)
1298 return clib_error_return (0,
1299 "corelist cannot be set for '%s' threads",
1302 tr->coremask = bitmap;
1303 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1307 (input, "scheduler-policy %U", unformat_sched_policy,
1310 else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1312 else if (unformat (input, "%s %u", &name, &count))
1314 p = hash_get_mem (tm->thread_registrations_by_name, name);
1316 return clib_error_return (0, "no such thread type 3 '%s'", name);
1318 tr = (vlib_thread_registration_t *) p[0];
1319 if (tr->fixed_count)
1320 return clib_error_return
1321 (0, "number of %s threads not configurable", tr->name);
1328 if (tm->sched_priority != ~0)
1330 if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1332 u32 prio_max = sched_get_priority_max (tm->sched_policy);
1333 u32 prio_min = sched_get_priority_min (tm->sched_policy);
1334 if (tm->sched_priority > prio_max)
1335 tm->sched_priority = prio_max;
1336 if (tm->sched_priority < prio_min)
1337 tm->sched_priority = prio_min;
1341 return clib_error_return
1343 "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1344 tm->sched_priority);
1349 if (!tm->thread_prefix)
1350 tm->thread_prefix = format (0, "vpp");
1354 tm->n_thread_stacks += tr->count;
1355 tm->n_pthreads += tr->count * tr->use_pthreads;
1356 tm->n_threads += tr->count * (tr->use_pthreads == 0);
1363 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1365 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1367 vnet_main_fixup (vlib_fork_fixup_t which)
1372 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1374 vlib_main_t *vm = vlib_get_main ();
1376 if (vlib_mains == 0)
1379 ASSERT (vlib_get_thread_index () == 0);
1380 vlib_worker_thread_barrier_sync (vm);
1384 case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1385 vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1391 vlib_worker_thread_barrier_release (vm);
1395 * Enforce minimum open time to minimize packet loss due to Rx overflow,
1396 * based on a test based heuristic that barrier should be open for at least
1397 * 3 time as long as it is closed (with an upper bound of 1ms because by that
1398 * point it is probably too late to make a difference)
1401 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1402 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1405 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1406 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1410 vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm)
1413 f64 now = vlib_time_now (vm);
1414 u32 count = vec_len (vlib_mains) - 1;
1416 /* No worker threads? */
1420 deadline = now + BARRIER_SYNC_TIMEOUT;
1421 *vlib_worker_threads->wait_at_barrier = 1;
1422 while (*vlib_worker_threads->workers_at_barrier != count)
1424 if ((now = vlib_time_now (vm)) > deadline)
1426 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1431 *vlib_worker_threads->wait_at_barrier = 0;
1435 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm, const char *func_name)
1442 f64 max_vector_rate;
1446 if (vec_len (vlib_mains) < 2)
1449 ASSERT (vlib_get_thread_index () == 0);
1451 vlib_worker_threads[0].barrier_caller = func_name;
1452 count = vec_len (vlib_mains) - 1;
1454 /* Record entry relative to last close */
1455 now = vlib_time_now (vm);
1456 t_entry = now - vm->barrier_epoch;
1458 /* Tolerate recursive calls */
1459 if (++vlib_worker_threads[0].recursion_level > 1)
1461 barrier_trace_sync_rec (t_entry);
1466 * Need data to decide if we're working hard enough to honor
1467 * the barrier hold-down timer.
1469 max_vector_rate = 0.0;
1470 for (i = 1; i < vec_len (vlib_mains); i++)
1472 clib_max (max_vector_rate,
1473 (f64) vlib_last_vectors_per_main_loop (vlib_mains[i]));
1475 vlib_worker_threads[0].barrier_sync_count++;
1477 /* Enforce minimum barrier open time to minimize packet loss */
1478 ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1481 * If any worker thread seems busy, which we define
1482 * as a vector rate above 10, we enforce the barrier hold-down timer
1484 if (max_vector_rate > 10.0)
1488 now = vlib_time_now (vm);
1489 /* Barrier hold-down timer expired? */
1490 if (now >= vm->barrier_no_close_before)
1492 if ((vm->barrier_no_close_before - now)
1493 > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1496 ("clock change: would have waited for %.4f seconds",
1497 (vm->barrier_no_close_before - now));
1502 /* Record time of closure */
1503 t_open = now - vm->barrier_epoch;
1504 vm->barrier_epoch = now;
1506 deadline = now + BARRIER_SYNC_TIMEOUT;
1508 *vlib_worker_threads->wait_at_barrier = 1;
1509 while (*vlib_worker_threads->workers_at_barrier != count)
1511 if ((now = vlib_time_now (vm)) > deadline)
1513 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1518 t_closed = now - vm->barrier_epoch;
1520 barrier_trace_sync (t_entry, t_open, t_closed);
1525 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1532 f64 t_update_main = 0.0;
1533 int refork_needed = 0;
1535 if (vec_len (vlib_mains) < 2)
1538 ASSERT (vlib_get_thread_index () == 0);
1541 now = vlib_time_now (vm);
1542 t_entry = now - vm->barrier_epoch;
1544 if (--vlib_worker_threads[0].recursion_level > 0)
1546 barrier_trace_release_rec (t_entry);
1550 /* Update (all) node runtimes before releasing the barrier, if needed */
1551 if (vm->need_vlib_worker_thread_node_runtime_update)
1554 * Lock stat segment here, so we's safe when
1555 * rebuilding the stat segment node clones from the
1558 vlib_stat_segment_lock ();
1560 /* Do stats elements on main thread */
1561 worker_thread_node_runtime_update_internal ();
1562 vm->need_vlib_worker_thread_node_runtime_update = 0;
1564 /* Do per thread rebuilds in parallel */
1566 clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1567 (vec_len (vlib_mains) - 1));
1568 now = vlib_time_now (vm);
1569 t_update_main = now - vm->barrier_epoch;
1572 deadline = now + BARRIER_SYNC_TIMEOUT;
1575 * Note when we let go of the barrier.
1576 * Workers can use this to derive a reasonably accurate
1577 * time offset. See vlib_time_now(...)
1579 vm->time_last_barrier_release = vlib_time_now (vm);
1580 CLIB_MEMORY_STORE_BARRIER ();
1582 *vlib_worker_threads->wait_at_barrier = 0;
1584 while (*vlib_worker_threads->workers_at_barrier > 0)
1586 if ((now = vlib_time_now (vm)) > deadline)
1588 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1593 /* Wait for reforks before continuing */
1596 now = vlib_time_now (vm);
1598 deadline = now + BARRIER_SYNC_TIMEOUT;
1600 while (*vlib_worker_threads->node_reforks_required > 0)
1602 if ((now = vlib_time_now (vm)) > deadline)
1604 fformat (stderr, "%s: worker thread refork deadlock\n",
1609 vlib_stat_segment_unlock ();
1612 t_closed_total = now - vm->barrier_epoch;
1614 minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1616 if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1618 minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1621 vm->barrier_no_close_before = now + minimum_open;
1623 /* Record barrier epoch (used to enforce minimum open time) */
1624 vm->barrier_epoch = now;
1626 barrier_trace_release (t_entry, t_closed_total, t_update_main);
1631 * Check the frame queue to see if any frames are available.
1632 * If so, pull the packets off the frames and put them to
1636 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm)
1638 u32 thread_id = vm->thread_index;
1639 vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1640 vlib_frame_queue_elt_t *elt;
1649 ASSERT (vm == vlib_mains[thread_id]);
1651 if (PREDICT_FALSE (fqm->node_index == ~0))
1654 * Gather trace data for frame queues
1656 if (PREDICT_FALSE (fq->trace))
1658 frame_queue_trace_t *fqt;
1659 frame_queue_nelt_counter_t *fqh;
1662 fqt = &fqm->frame_queue_traces[thread_id];
1664 fqt->nelts = fq->nelts;
1665 fqt->head = fq->head;
1666 fqt->head_hint = fq->head_hint;
1667 fqt->tail = fq->tail;
1668 fqt->threshold = fq->vector_threshold;
1669 fqt->n_in_use = fqt->tail - fqt->head;
1670 if (fqt->n_in_use >= fqt->nelts)
1672 // if beyond max then use max
1673 fqt->n_in_use = fqt->nelts - 1;
1676 /* Record the number of elements in use in the histogram */
1677 fqh = &fqm->frame_queue_histogram[thread_id];
1678 fqh->count[fqt->n_in_use]++;
1680 /* Record a snapshot of the elements in use */
1681 for (elix = 0; elix < fqt->nelts; elix++)
1683 elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1684 if (1 || elt->valid)
1686 fqt->n_vectors[elix] = elt->n_vectors;
1695 if (fq->head == fq->tail)
1697 fq->head_hint = fq->head;
1701 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1705 fq->head_hint = fq->head;
1709 from = elt->buffer_index;
1710 msg_type = elt->msg_type;
1712 ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1713 ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1715 f = vlib_get_frame_to_node (vm, fqm->node_index);
1717 /* If the first vector is traced, set the frame trace flag */
1718 b = vlib_get_buffer (vm, from[0]);
1719 if (b->flags & VLIB_BUFFER_IS_TRACED)
1720 f->frame_flags |= VLIB_NODE_FLAG_TRACE;
1722 to = vlib_frame_vector_args (f);
1724 n_left_to_node = elt->n_vectors;
1726 while (n_left_to_node >= 4)
1734 n_left_to_node -= 4;
1737 while (n_left_to_node > 0)
1745 vectors += elt->n_vectors;
1746 f->n_vectors = elt->n_vectors;
1747 vlib_put_frame_to_node (vm, fqm->node_index, f);
1751 elt->msg_type = 0xfefefefe;
1752 CLIB_MEMORY_BARRIER ();
1757 * Limit the number of packets pushed into the graph
1759 if (vectors >= fq->vector_threshold)
1761 fq->head_hint = fq->head;
1770 vlib_worker_thread_fn (void *arg)
1772 vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1773 vlib_thread_main_t *tm = vlib_get_thread_main ();
1774 vlib_main_t *vm = vlib_get_main ();
1777 ASSERT (vm->thread_index == vlib_get_thread_index ());
1779 vlib_worker_thread_init (w);
1780 clib_time_init (&vm->clib_time);
1781 clib_mem_set_heap (w->thread_mheap);
1783 e = vlib_call_init_exit_functions_no_sort
1784 (vm, &vm->worker_init_function_registrations, 1 /* call_once */ );
1786 clib_error_report (e);
1788 /* Wait until the dpdk init sequence is complete */
1789 while (tm->extern_thread_mgmt && tm->worker_thread_release == 0)
1790 vlib_worker_thread_barrier_check ();
1792 vlib_worker_loop (vm);
1796 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1799 .function = vlib_worker_thread_fn,
1804 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1806 vlib_thread_main_t *tm = vlib_get_thread_main ();
1807 vlib_frame_queue_main_t *fqm;
1808 vlib_frame_queue_t *fq;
1811 if (frame_queue_nelts == 0)
1812 frame_queue_nelts = FRAME_QUEUE_MAX_NELTS;
1814 ASSERT (frame_queue_nelts >= 8);
1816 vec_add2 (tm->frame_queue_mains, fqm, 1);
1818 fqm->node_index = node_index;
1819 fqm->frame_queue_nelts = frame_queue_nelts;
1820 fqm->queue_hi_thresh = frame_queue_nelts - 2;
1822 vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1823 vec_validate (fqm->per_thread_data, tm->n_vlib_mains - 1);
1824 _vec_len (fqm->vlib_frame_queues) = 0;
1825 for (i = 0; i < tm->n_vlib_mains; i++)
1827 vlib_frame_queue_per_thread_data_t *ptd;
1828 fq = vlib_frame_queue_alloc (frame_queue_nelts);
1829 vec_add1 (fqm->vlib_frame_queues, fq);
1831 ptd = vec_elt_at_index (fqm->per_thread_data, i);
1832 vec_validate (ptd->handoff_queue_elt_by_thread_index,
1833 tm->n_vlib_mains - 1);
1834 vec_validate_init_empty (ptd->congested_handoff_queue_by_thread_index,
1835 tm->n_vlib_mains - 1,
1836 (vlib_frame_queue_t *) (~0));
1839 return (fqm - tm->frame_queue_mains);
1843 vlib_thread_cb_register (struct vlib_main_t *vm, vlib_thread_callbacks_t * cb)
1845 vlib_thread_main_t *tm = vlib_get_thread_main ();
1847 if (tm->extern_thread_mgmt)
1850 tm->cb.vlib_launch_thread_cb = cb->vlib_launch_thread_cb;
1851 tm->extern_thread_mgmt = 1;
1856 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1859 ASSERT (vlib_get_thread_index () == 0);
1860 vlib_process_signal_event (vlib_get_main (), args->node_index,
1861 args->type_opaque, args->data);
1864 void *rpc_call_main_thread_cb_fn;
1867 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1869 if (rpc_call_main_thread_cb_fn)
1871 void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1872 (*fp) (callback, args, arg_size);
1875 clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1879 threads_init (vlib_main_t * vm)
1884 VLIB_INIT_FUNCTION (threads_init);
1887 static clib_error_t *
1888 show_clock_command_fn (vlib_main_t * vm,
1889 unformat_input_t * input, vlib_cli_command_t * cmd)
1894 (void) unformat (input, "verbose %=", &verbose, 1);
1896 vlib_cli_output (vm, "%U", format_clib_time, &vm->clib_time, verbose);
1898 if (vec_len (vlib_mains) == 1)
1901 vlib_cli_output (vm, "Time last barrier release %.9f",
1902 vm->time_last_barrier_release);
1904 for (i = 1; i < vec_len (vlib_mains); i++)
1906 if (vlib_mains[i] == 0)
1909 vlib_cli_output (vm, "%d: %U", i, format_clib_time,
1910 &vlib_mains[i]->clib_time, verbose);
1912 vlib_cli_output (vm, "Thread %d offset %.9f error %.9f", i,
1913 vlib_mains[i]->time_offset,
1914 vm->time_last_barrier_release -
1915 vlib_mains[i]->time_last_barrier_release);
1921 VLIB_CLI_COMMAND (f_command, static) =
1923 .path = "show clock",
1924 .short_help = "show clock",
1925 .function = show_clock_command_fn,
1930 * fd.io coding-style-patch-verification: ON
1933 * eval: (c-set-style "gnu")