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 <vlib/vlib.h>
22 #include <vlib/threads.h>
23 #include <vlib/unix/cj.h>
27 #include <rte_config.h>
28 #include <rte_common.h>
30 #include <rte_launch.h>
31 #include <rte_lcore.h>
33 DECLARE_CJ_GLOBAL_LOG;
35 #define FRAME_QUEUE_NELTS 32
40 * Weak definitions of DPDK symbols used in this file.
41 * Needed for linking test programs without DPDK libs.
43 unsigned __thread __attribute__ ((weak)) RTE_PER_LCORE (_lcore_id);
44 struct lcore_config __attribute__ ((weak)) lcore_config[];
45 unsigned __attribute__ ((weak)) rte_socket_id ();
46 int __attribute__ ((weak)) rte_eal_remote_launch ();
54 vlib_worker_thread_t *vlib_worker_threads;
55 vlib_thread_main_t vlib_thread_main;
58 os_get_cpu_number (void)
64 len = vec_len (vlib_thread_stacks);
68 /* Get any old stack address. */
71 n = ((uword) sp - (uword) vlib_thread_stacks[0])
72 >> VLIB_LOG2_THREAD_STACK_SIZE;
74 /* "processes" have their own stacks, and they always run in thread 0 */
85 len = vec_len (vlib_thread_stacks);
93 vlib_set_thread_name (char *name)
95 int pthread_setname_np (pthread_t __target_thread, const char *__name);
97 pthread_t thread = pthread_self ();
101 rv = pthread_setname_np (thread, name);
103 clib_warning ("pthread_setname_np returned %d", rv);
108 sort_registrations_by_no_clone (void *a0, void *a1)
110 vlib_thread_registration_t **tr0 = a0;
111 vlib_thread_registration_t **tr1 = a1;
113 return ((i32) ((*tr0)->no_data_structure_clone)
114 - ((i32) ((*tr1)->no_data_structure_clone)));
118 vlib_sysfs_list_to_bitmap (char *filename)
123 fp = fopen (filename, "r");
128 vec_validate (buffer, 256 - 1);
129 if (fgets ((char *) buffer, 256, fp))
132 unformat_init_string (&in, (char *) buffer,
133 strlen ((char *) buffer));
134 if (unformat (&in, "%U", unformat_bitmap_list, &r) != 1)
135 clib_warning ("unformat_bitmap_list failed");
145 /* Called early in the init sequence */
148 vlib_thread_init (vlib_main_t * vm)
150 vlib_thread_main_t *tm = &vlib_thread_main;
151 vlib_worker_thread_t *w;
152 vlib_thread_registration_t *tr;
153 u32 n_vlib_mains = 1;
158 /* get bitmaps of active cpu cores and sockets */
159 tm->cpu_core_bitmap =
160 vlib_sysfs_list_to_bitmap ("/sys/devices/system/cpu/online");
161 tm->cpu_socket_bitmap =
162 vlib_sysfs_list_to_bitmap ("/sys/devices/system/node/online");
164 avail_cpu = clib_bitmap_dup (tm->cpu_core_bitmap);
167 for (i = 0; i < tm->skip_cores; i++)
169 uword c = clib_bitmap_first_set (avail_cpu);
171 return clib_error_return (0, "no available cpus to skip");
173 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
176 /* grab cpu for main thread */
179 tm->main_lcore = clib_bitmap_first_set (avail_cpu);
180 if (tm->main_lcore == (u8) ~ 0)
181 return clib_error_return (0, "no available cpus to be used for the"
186 if (clib_bitmap_get (avail_cpu, tm->main_lcore) == 0)
187 return clib_error_return (0, "cpu %u is not available to be used"
188 " for the main thread", tm->main_lcore);
190 avail_cpu = clib_bitmap_set (avail_cpu, tm->main_lcore, 0);
192 /* assume that there is socket 0 only if there is no data from sysfs */
193 if (!tm->cpu_socket_bitmap)
194 tm->cpu_socket_bitmap = clib_bitmap_set (0, 0, 1);
196 /* pin main thread to main_lcore */
201 CPU_SET (tm->main_lcore, &cpuset);
202 pthread_setaffinity_np (pthread_self (), sizeof (cpu_set_t), &cpuset);
206 /* as many threads as stacks... */
207 vec_validate_aligned (vlib_worker_threads, vec_len (vlib_thread_stacks) - 1,
208 CLIB_CACHE_LINE_BYTES);
210 /* Preallocate thread 0 */
211 _vec_len (vlib_worker_threads) = 1;
212 w = vlib_worker_threads;
213 w->thread_mheap = clib_mem_get_heap ();
214 w->thread_stack = vlib_thread_stacks[0];
215 w->lcore_id = tm->main_lcore;
216 w->lwp = syscall (SYS_gettid);
217 w->thread_id = pthread_self ();
218 tm->n_vlib_mains = 1;
220 if (tm->sched_policy != ~0)
222 struct sched_param sched_param;
223 if (!sched_getparam (w->lwp, &sched_param))
225 if (tm->sched_priority != ~0)
226 sched_param.sched_priority = tm->sched_priority;
227 sched_setscheduler (w->lwp, tm->sched_policy, &sched_param);
231 /* assign threads to cores and set n_vlib_mains */
236 vec_add1 (tm->registrations, tr);
240 vec_sort_with_function (tm->registrations, sort_registrations_by_no_clone);
242 for (i = 0; i < vec_len (tm->registrations); i++)
245 tr = tm->registrations[i];
246 tr->first_index = first_index;
247 first_index += tr->count;
248 n_vlib_mains += (tr->no_data_structure_clone == 0) ? tr->count : 0;
250 /* construct coremask */
251 if (tr->use_pthreads || !tr->count)
258 clib_bitmap_foreach (c, tr->coremask, ({
259 if (clib_bitmap_get(avail_cpu, c) == 0)
260 return clib_error_return (0, "cpu %u is not available to be used"
261 " for the '%s' thread",c, tr->name);
263 avail_cpu = clib_bitmap_set(avail_cpu, c, 0);
270 for (j = 0; j < tr->count; j++)
272 uword c = clib_bitmap_first_set (avail_cpu);
274 return clib_error_return (0,
275 "no available cpus to be used for"
276 " the '%s' thread", tr->name);
278 avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
279 tr->coremask = clib_bitmap_set (tr->coremask, c, 1);
284 clib_bitmap_free (avail_cpu);
286 tm->n_vlib_mains = n_vlib_mains;
288 vec_validate_aligned (vlib_worker_threads, first_index - 1,
289 CLIB_CACHE_LINE_BYTES);
294 vlib_worker_thread_t *
295 vlib_alloc_thread (vlib_main_t * vm)
297 vlib_worker_thread_t *w;
299 if (vec_len (vlib_worker_threads) >= vec_len (vlib_thread_stacks))
301 clib_warning ("out of worker threads... Quitting...");
304 vec_add2 (vlib_worker_threads, w, 1);
305 w->thread_stack = vlib_thread_stacks[w - vlib_worker_threads];
310 vlib_frame_queue_alloc (int nelts)
312 vlib_frame_queue_t *fq;
314 fq = clib_mem_alloc_aligned (sizeof (*fq), CLIB_CACHE_LINE_BYTES);
315 memset (fq, 0, sizeof (*fq));
317 fq->vector_threshold = 128; // packets
318 vec_validate_aligned (fq->elts, nelts - 1, CLIB_CACHE_LINE_BYTES);
322 if (((uword) & fq->tail) & (CLIB_CACHE_LINE_BYTES - 1))
323 fformat (stderr, "WARNING: fq->tail unaligned\n");
324 if (((uword) & fq->head) & (CLIB_CACHE_LINE_BYTES - 1))
325 fformat (stderr, "WARNING: fq->head unaligned\n");
326 if (((uword) fq->elts) & (CLIB_CACHE_LINE_BYTES - 1))
327 fformat (stderr, "WARNING: fq->elts unaligned\n");
329 if (sizeof (fq->elts[0]) % CLIB_CACHE_LINE_BYTES)
330 fformat (stderr, "WARNING: fq->elts[0] size %d\n",
331 sizeof (fq->elts[0]));
332 if (nelts & (nelts - 1))
334 fformat (stderr, "FATAL: nelts MUST be a power of 2\n");
342 void vl_msg_api_handler_no_free (void *) __attribute__ ((weak));
344 vl_msg_api_handler_no_free (void *v)
348 /* Turned off, save as reference material... */
351 vlib_frame_queue_dequeue_internal (int thread_id,
352 vlib_main_t * vm, vlib_node_main_t * nm)
354 vlib_frame_queue_t *fq = vlib_frame_queues[thread_id];
355 vlib_frame_queue_elt_t *elt;
357 vlib_pending_frame_t *p;
358 vlib_node_runtime_t *r;
359 u32 node_runtime_index;
364 ASSERT (vm == vlib_mains[thread_id]);
368 if (fq->head == fq->tail)
371 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
376 before = clib_cpu_time_now ();
379 node_runtime_index = elt->node_runtime_index;
380 msg_type = elt->msg_type;
384 case VLIB_FRAME_QUEUE_ELT_FREE_BUFFERS:
385 vlib_buffer_free (vm, vlib_frame_vector_args (f), f->n_vectors);
386 /* note fallthrough... */
387 case VLIB_FRAME_QUEUE_ELT_FREE_FRAME:
388 r = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
390 vlib_frame_free (vm, r, f);
392 case VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME:
393 vec_add2 (vm->node_main.pending_frames, p, 1);
394 f->flags |= (VLIB_FRAME_PENDING | VLIB_FRAME_FREE_AFTER_DISPATCH);
395 p->node_runtime_index = elt->node_runtime_index;
396 p->frame_index = vlib_frame_index (vm, f);
397 p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
398 fq->dequeue_vectors += (u64) f->n_vectors;
400 case VLIB_FRAME_QUEUE_ELT_API_MSG:
401 vl_msg_api_handler_no_free (f);
404 clib_warning ("bogus frame queue message, type %d", msg_type);
409 fq->dequeue_ticks += clib_cpu_time_now () - before;
410 CLIB_MEMORY_BARRIER ();
419 vlib_frame_queue_dequeue (int thread_id,
420 vlib_main_t * vm, vlib_node_main_t * nm)
422 return vlib_frame_queue_dequeue_internal (thread_id, vm, nm);
426 vlib_frame_queue_enqueue (vlib_main_t * vm, u32 node_runtime_index,
427 u32 frame_queue_index, vlib_frame_t * frame,
428 vlib_frame_queue_msg_type_t type)
430 vlib_frame_queue_t *fq = vlib_frame_queues[frame_queue_index];
431 vlib_frame_queue_elt_t *elt;
434 u64 before = clib_cpu_time_now ();
438 new_tail = __sync_add_and_fetch (&fq->tail, 1);
440 /* Wait until a ring slot is available */
441 while (new_tail >= fq->head + fq->nelts)
443 f64 b4 = vlib_time_now_ticks (vm, before);
444 vlib_worker_thread_barrier_check (vm, b4);
445 /* Bad idea. Dequeue -> enqueue -> dequeue -> trouble */
446 // vlib_frame_queue_dequeue (vm->cpu_index, vm, nm);
449 elt = fq->elts + (new_tail & (fq->nelts - 1));
451 /* this would be very bad... */
456 /* Once we enqueue the frame, frame->n_vectors is owned elsewhere... */
457 save_count = frame->n_vectors;
460 elt->node_runtime_index = node_runtime_index;
461 elt->msg_type = type;
462 CLIB_MEMORY_BARRIER ();
469 /* To be called by vlib worker threads upon startup */
471 vlib_worker_thread_init (vlib_worker_thread_t * w)
473 vlib_thread_main_t *tm = vlib_get_thread_main ();
475 /* worker threads wants no signals. */
479 pthread_sigmask (SIG_SETMASK, &s, 0);
482 clib_mem_set_heap (w->thread_mheap);
484 if (vec_len (tm->thread_prefix) && w->registration->short_name)
486 w->name = format (0, "%v_%s_%d%c", tm->thread_prefix,
487 w->registration->short_name, w->instance_id, '\0');
488 vlib_set_thread_name ((char *) w->name);
491 if (!w->registration->use_pthreads)
494 /* Initial barrier sync, for both worker and i/o threads */
495 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
497 while (*vlib_worker_threads->wait_at_barrier)
500 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
505 vlib_worker_thread_bootstrap_fn (void *arg)
508 vlib_worker_thread_t *w = arg;
510 w->lwp = syscall (SYS_gettid);
511 w->thread_id = pthread_self ();
513 rv = (void *) clib_calljmp
514 ((uword (*)(uword)) w->thread_function,
515 (uword) arg, w->thread_stack + VLIB_THREAD_STACK_SIZE);
516 /* NOTREACHED, we hope */
521 vlib_launch_thread (void *fp, vlib_worker_thread_t * w, unsigned lcore_id)
523 void *(*fp_arg) (void *) = fp;
525 w->lcore_id = lcore_id;
527 if (!w->registration->use_pthreads)
528 if (rte_eal_remote_launch) /* do we have dpdk linked */
529 return rte_eal_remote_launch (fp, (void *) w, lcore_id);
539 CPU_SET (lcore_id, &cpuset);
541 ret = pthread_create (&worker, NULL /* attr */ , fp_arg, (void *) w);
543 return pthread_setaffinity_np (worker, sizeof (cpu_set_t), &cpuset);
549 static clib_error_t *
550 start_workers (vlib_main_t * vm)
553 vlib_worker_thread_t *w;
554 vlib_main_t *vm_clone;
556 vlib_thread_main_t *tm = &vlib_thread_main;
557 vlib_thread_registration_t *tr;
558 vlib_node_runtime_t *rt;
559 u32 n_vlib_mains = tm->n_vlib_mains;
560 u32 worker_thread_index;
561 u8 *main_heap = clib_mem_get_per_cpu_heap ();
562 mheap_t *main_heap_header = mheap_header (main_heap);
564 vec_reset_length (vlib_worker_threads);
566 /* Set up the main thread */
567 vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
568 w->elog_track.name = "main thread";
569 elog_track_register (&vm->elog_main, &w->elog_track);
571 if (vec_len (tm->thread_prefix))
573 w->name = format (0, "%v_main%c", tm->thread_prefix, '\0');
574 vlib_set_thread_name ((char *) w->name);
578 * Truth of the matter: we always use at least two
579 * threads. So, make the main heap thread-safe
580 * and make the event log thread-safe.
582 main_heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
584 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
585 vm->elog_main.lock[0] = 0;
587 if (n_vlib_mains > 1)
589 vec_validate (vlib_mains, tm->n_vlib_mains - 1);
590 _vec_len (vlib_mains) = 0;
591 vec_add1 (vlib_mains, vm);
593 vlib_worker_threads->wait_at_barrier =
594 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
595 vlib_worker_threads->workers_at_barrier =
596 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
598 /* Ask for an initial barrier sync */
599 *vlib_worker_threads->workers_at_barrier = 0;
600 *vlib_worker_threads->wait_at_barrier = 1;
602 worker_thread_index = 1;
604 for (i = 0; i < vec_len (tm->registrations); i++)
606 vlib_node_main_t *nm, *nm_clone;
607 vlib_buffer_main_t *bm_clone;
608 vlib_buffer_free_list_t *fl_clone, *fl_orig;
609 vlib_buffer_free_list_t *orig_freelist_pool;
612 tr = tm->registrations[i];
617 for (k = 0; k < tr->count; k++)
619 vec_add2 (vlib_worker_threads, w, 1);
622 mheap_alloc (0 /* use VM */ , tr->mheap_size);
624 w->thread_mheap = main_heap;
625 w->thread_stack = vlib_thread_stacks[w - vlib_worker_threads];
626 w->thread_function = tr->function;
627 w->thread_function_arg = w;
629 w->registration = tr;
632 (char *) format (0, "%s %d", tr->name, k + 1);
633 vec_add1 (w->elog_track.name, 0);
634 elog_track_register (&vm->elog_main, &w->elog_track);
636 if (tr->no_data_structure_clone)
639 /* Fork vlib_global_main et al. Look for bugs here */
640 oldheap = clib_mem_set_heap (w->thread_mheap);
642 vm_clone = clib_mem_alloc (sizeof (*vm_clone));
643 clib_memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
645 vm_clone->cpu_index = worker_thread_index;
646 vm_clone->heap_base = w->thread_mheap;
647 vm_clone->mbuf_alloc_list = 0;
648 memset (&vm_clone->random_buffer, 0,
649 sizeof (vm_clone->random_buffer));
651 nm = &vlib_mains[0]->node_main;
652 nm_clone = &vm_clone->node_main;
653 /* fork next frames array, preserving node runtime indices */
654 nm_clone->next_frames = vec_dup (nm->next_frames);
655 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
657 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
658 u32 save_node_runtime_index;
661 save_node_runtime_index = nf->node_runtime_index;
662 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
663 vlib_next_frame_init (nf);
664 nf->node_runtime_index = save_node_runtime_index;
665 nf->flags = save_flags;
668 /* fork the frame dispatch queue */
669 nm_clone->pending_frames = 0;
670 vec_validate (nm_clone->pending_frames, 10); /* $$$$$?????? */
671 _vec_len (nm_clone->pending_frames) = 0;
675 for (j = 0; j < vec_len (nm->nodes); j++)
678 n = clib_mem_alloc_no_fail (sizeof (*n));
679 clib_memcpy (n, nm->nodes[j], sizeof (*n));
680 /* none of the copied nodes have enqueue rights given out */
681 n->owner_node_index = VLIB_INVALID_NODE_INDEX;
682 memset (&n->stats_total, 0, sizeof (n->stats_total));
683 memset (&n->stats_last_clear, 0,
684 sizeof (n->stats_last_clear));
685 vec_add1 (nm_clone->nodes, n);
687 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
688 vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL]);
690 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
691 vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT]);
692 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
693 rt->cpu_index = vm_clone->cpu_index;
695 nm_clone->processes = vec_dup (nm->processes);
697 /* zap the (per worker) frame freelists, etc */
698 nm_clone->frame_sizes = 0;
699 nm_clone->frame_size_hash = 0;
701 /* Packet trace buffers are guaranteed to be empty, nothing to do here */
703 clib_mem_set_heap (oldheap);
704 vec_add1 (vlib_mains, vm_clone);
706 vm_clone->error_main.counters =
707 vec_dup (vlib_mains[0]->error_main.counters);
708 vm_clone->error_main.counters_last_clear =
709 vec_dup (vlib_mains[0]->error_main.counters_last_clear);
711 /* Fork the vlib_buffer_main_t free lists, etc. */
712 bm_clone = vec_dup (vm_clone->buffer_main);
713 vm_clone->buffer_main = bm_clone;
715 orig_freelist_pool = bm_clone->buffer_free_list_pool;
716 bm_clone->buffer_free_list_pool = 0;
719 pool_foreach (fl_orig, orig_freelist_pool,
721 pool_get_aligned (bm_clone->buffer_free_list_pool,
722 fl_clone, CLIB_CACHE_LINE_BYTES);
723 ASSERT (fl_orig - orig_freelist_pool
724 == fl_clone - bm_clone->buffer_free_list_pool);
726 fl_clone[0] = fl_orig[0];
727 fl_clone->aligned_buffers = 0;
728 fl_clone->unaligned_buffers = 0;
729 fl_clone->n_alloc = 0;
733 worker_thread_index++;
739 /* only have non-data-structure copy threads to create... */
740 for (i = 0; i < vec_len (tm->registrations); i++)
742 tr = tm->registrations[i];
744 for (j = 0; j < tr->count; j++)
746 vec_add2 (vlib_worker_threads, w, 1);
749 mheap_alloc (0 /* use VM */ , tr->mheap_size);
751 w->thread_mheap = main_heap;
752 w->thread_stack = vlib_thread_stacks[w - vlib_worker_threads];
753 w->thread_function = tr->function;
754 w->thread_function_arg = w;
757 (char *) format (0, "%s %d", tr->name, j + 1);
758 w->registration = tr;
759 vec_add1 (w->elog_track.name, 0);
760 elog_track_register (&vm->elog_main, &w->elog_track);
765 worker_thread_index = 1;
767 for (i = 0; i < vec_len (tm->registrations); i++)
771 tr = tm->registrations[i];
773 if (tr->use_pthreads || tm->use_pthreads)
775 for (j = 0; j < tr->count; j++)
777 w = vlib_worker_threads + worker_thread_index++;
778 if (vlib_launch_thread (vlib_worker_thread_bootstrap_fn, w, 0) <
780 clib_warning ("Couldn't start '%s' pthread ", tr->name);
787 clib_bitmap_foreach (c, tr->coremask, ({
788 w = vlib_worker_threads + worker_thread_index++;
789 if (vlib_launch_thread (vlib_worker_thread_bootstrap_fn, w, c) < 0)
790 clib_warning ("Couldn't start DPDK lcore %d", c);
796 vlib_worker_thread_barrier_sync (vm);
797 vlib_worker_thread_barrier_release (vm);
801 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
804 vlib_worker_thread_node_runtime_update (void)
807 vlib_worker_thread_t *w;
809 vlib_node_main_t *nm, *nm_clone;
810 vlib_node_t **old_nodes_clone;
811 vlib_main_t *vm_clone;
812 vlib_node_runtime_t *rt, *old_rt;
815 vlib_node_runtime_sync_stats (vlib_main_t * vm,
816 vlib_node_runtime_t * r,
818 uword n_vectors, uword n_clocks);
820 ASSERT (os_get_cpu_number () == 0);
822 if (vec_len (vlib_mains) == 0)
828 ASSERT (os_get_cpu_number () == 0);
829 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
832 * Scrape all runtime stats, so we don't lose node runtime(s) with
833 * pending counts, or throw away worker / io thread counts.
835 for (j = 0; j < vec_len (nm->nodes); j++)
839 vlib_node_sync_stats (vm, n);
842 for (i = 1; i < vec_len (vlib_mains); i++)
846 vm_clone = vlib_mains[i];
847 nm_clone = &vm_clone->node_main;
849 for (j = 0; j < vec_len (nm_clone->nodes); j++)
851 n = nm_clone->nodes[j];
853 rt = vlib_node_get_runtime (vm_clone, n->index);
854 vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
858 for (i = 1; i < vec_len (vlib_mains); i++)
860 vlib_node_runtime_t *rt;
861 w = vlib_worker_threads + i;
862 oldheap = clib_mem_set_heap (w->thread_mheap);
864 vm_clone = vlib_mains[i];
866 /* Re-clone error heap */
867 u64 *old_counters = vm_clone->error_main.counters;
868 u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
869 clib_memcpy (&vm_clone->error_main, &vm->error_main,
870 sizeof (vm->error_main));
871 j = vec_len (vm->error_main.counters) - 1;
872 vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
873 vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
874 vm_clone->error_main.counters = old_counters;
875 vm_clone->error_main.counters_last_clear = old_counters_all_clear;
877 nm_clone = &vm_clone->node_main;
878 vec_free (nm_clone->next_frames);
879 nm_clone->next_frames = vec_dup (nm->next_frames);
881 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
883 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
884 u32 save_node_runtime_index;
887 save_node_runtime_index = nf->node_runtime_index;
888 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
889 vlib_next_frame_init (nf);
890 nf->node_runtime_index = save_node_runtime_index;
891 nf->flags = save_flags;
894 old_nodes_clone = nm_clone->nodes;
898 for (j = 0; j < vec_len (nm->nodes); j++)
900 vlib_node_t *old_n_clone;
901 vlib_node_t *new_n, *new_n_clone;
903 new_n = nm->nodes[j];
904 old_n_clone = old_nodes_clone[j];
906 new_n_clone = clib_mem_alloc_no_fail (sizeof (*new_n_clone));
907 clib_memcpy (new_n_clone, new_n, sizeof (*new_n));
908 /* none of the copied nodes have enqueue rights given out */
909 new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
911 if (j >= vec_len (old_nodes_clone))
913 /* new node, set to zero */
914 memset (&new_n_clone->stats_total, 0,
915 sizeof (new_n_clone->stats_total));
916 memset (&new_n_clone->stats_last_clear, 0,
917 sizeof (new_n_clone->stats_last_clear));
921 /* Copy stats if the old data is valid */
922 clib_memcpy (&new_n_clone->stats_total,
923 &old_n_clone->stats_total,
924 sizeof (new_n_clone->stats_total));
925 clib_memcpy (&new_n_clone->stats_last_clear,
926 &old_n_clone->stats_last_clear,
927 sizeof (new_n_clone->stats_last_clear));
929 /* keep previous node state */
930 new_n_clone->state = old_n_clone->state;
932 vec_add1 (nm_clone->nodes, new_n_clone);
934 /* Free the old node clone */
935 for (j = 0; j < vec_len (old_nodes_clone); j++)
936 clib_mem_free (old_nodes_clone[j]);
937 vec_free (old_nodes_clone);
939 vec_free (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL]);
941 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
942 vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL]);
944 /* clone input node runtime */
945 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
947 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
948 vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT]);
950 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
952 rt->cpu_index = vm_clone->cpu_index;
955 for (j = 0; j < vec_len (old_rt); j++)
957 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
958 rt->state = old_rt[j].state;
963 nm_clone->processes = vec_dup (nm->processes);
965 clib_mem_set_heap (oldheap);
967 // vnet_main_fork_fixup (i);
972 unformat_sched_policy (unformat_input_t * input, va_list * args)
974 u32 *r = va_arg (*args, u32 *);
977 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
985 static clib_error_t *
986 cpu_config (vlib_main_t * vm, unformat_input_t * input)
988 vlib_thread_registration_t *tr;
990 vlib_thread_main_t *tm = &vlib_thread_main;
996 tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
998 tm->n_thread_stacks = 1; /* account for main thread */
999 tm->sched_policy = ~0;
1000 tm->sched_priority = ~0;
1006 hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1010 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1012 if (unformat (input, "use-pthreads"))
1013 tm->use_pthreads = 1;
1014 else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1016 else if (unformat (input, "main-core %u", &tm->main_lcore))
1018 else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1020 else if (unformat (input, "coremask-%s %llx", &name, &coremask))
1022 p = hash_get_mem (tm->thread_registrations_by_name, name);
1024 return clib_error_return (0, "no such thread type '%s'", name);
1026 tr = (vlib_thread_registration_t *) p[0];
1028 if (tr->use_pthreads)
1029 return clib_error_return (0,
1030 "coremask cannot be set for '%s' threads",
1033 tr->coremask = clib_bitmap_set_multiple
1034 (tr->coremask, 0, coremask, BITS (coremask));
1035 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1037 else if (unformat (input, "corelist-%s %U", &name, unformat_bitmap_list,
1040 p = hash_get_mem (tm->thread_registrations_by_name, name);
1042 return clib_error_return (0, "no such thread type '%s'", name);
1044 tr = (vlib_thread_registration_t *) p[0];
1046 if (tr->use_pthreads)
1047 return clib_error_return (0,
1048 "corelist cannot be set for '%s' threads",
1051 tr->coremask = bitmap;
1052 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1056 (input, "scheduler-policy %U", unformat_sched_policy,
1059 else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1061 else if (unformat (input, "%s %u", &name, &count))
1063 p = hash_get_mem (tm->thread_registrations_by_name, name);
1065 return clib_error_return (0, "no such thread type 3 '%s'", name);
1067 tr = (vlib_thread_registration_t *) p[0];
1068 if (tr->fixed_count)
1069 return clib_error_return
1070 (0, "number of %s threads not configurable", tr->name);
1077 if (tm->sched_priority != ~0)
1079 if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1081 u32 prio_max = sched_get_priority_max (tm->sched_policy);
1082 u32 prio_min = sched_get_priority_min (tm->sched_policy);
1083 if (tm->sched_priority > prio_max)
1084 tm->sched_priority = prio_max;
1085 if (tm->sched_priority < prio_min)
1086 tm->sched_priority = prio_min;
1090 return clib_error_return
1092 "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1093 tm->sched_priority);
1098 if (!tm->thread_prefix)
1099 tm->thread_prefix = format (0, "vpp");
1103 tm->n_thread_stacks += tr->count;
1104 tm->n_pthreads += tr->count * tr->use_pthreads;
1105 tm->n_eal_threads += tr->count * (tr->use_pthreads == 0);
1112 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1114 #if !defined (__x86_64__) && !defined (__aarch64__) && !defined (__powerpc64__) && !defined(__arm__)
1116 __sync_fetch_and_add_8 (void)
1118 fformat (stderr, "%s called\n", __FUNCTION__);
1123 __sync_add_and_fetch_8 (void)
1125 fformat (stderr, "%s called\n", __FUNCTION__);
1130 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1132 vnet_main_fixup (vlib_fork_fixup_t which)
1137 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1139 vlib_main_t *vm = vlib_get_main ();
1141 if (vlib_mains == 0)
1144 ASSERT (os_get_cpu_number () == 0);
1145 vlib_worker_thread_barrier_sync (vm);
1149 case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1150 vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1156 vlib_worker_thread_barrier_release (vm);
1160 vlib_worker_thread_barrier_sync (vlib_main_t * vm)
1168 count = vec_len (vlib_mains) - 1;
1170 /* Tolerate recursive calls */
1171 if (++vlib_worker_threads[0].recursion_level > 1)
1174 vlib_worker_threads[0].barrier_sync_count++;
1176 ASSERT (os_get_cpu_number () == 0);
1178 deadline = vlib_time_now (vm) + BARRIER_SYNC_TIMEOUT;
1180 *vlib_worker_threads->wait_at_barrier = 1;
1181 while (*vlib_worker_threads->workers_at_barrier != count)
1183 if (vlib_time_now (vm) > deadline)
1185 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1192 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1199 if (--vlib_worker_threads[0].recursion_level > 0)
1202 deadline = vlib_time_now (vm) + BARRIER_SYNC_TIMEOUT;
1204 *vlib_worker_threads->wait_at_barrier = 0;
1206 while (*vlib_worker_threads->workers_at_barrier > 0)
1208 if (vlib_time_now (vm) > deadline)
1210 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1217 * Check the frame queue to see if any frames are available.
1218 * If so, pull the packets off the frames and put them to
1222 vlib_frame_queue_dequeue_internal (vlib_main_t * vm,
1223 vlib_frame_queue_main_t * fqm)
1225 u32 thread_id = vm->cpu_index;
1226 vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1227 vlib_frame_queue_elt_t *elt;
1236 ASSERT (vm == vlib_mains[thread_id]);
1238 if (PREDICT_FALSE (fqm->node_index == ~0))
1241 * Gather trace data for frame queues
1243 if (PREDICT_FALSE (fq->trace))
1245 frame_queue_trace_t *fqt;
1246 frame_queue_nelt_counter_t *fqh;
1249 fqt = &fqm->frame_queue_traces[thread_id];
1251 fqt->nelts = fq->nelts;
1252 fqt->head = fq->head;
1253 fqt->head_hint = fq->head_hint;
1254 fqt->tail = fq->tail;
1255 fqt->threshold = fq->vector_threshold;
1256 fqt->n_in_use = fqt->tail - fqt->head;
1257 if (fqt->n_in_use >= fqt->nelts)
1259 // if beyond max then use max
1260 fqt->n_in_use = fqt->nelts - 1;
1263 /* Record the number of elements in use in the histogram */
1264 fqh = &fqm->frame_queue_histogram[thread_id];
1265 fqh->count[fqt->n_in_use]++;
1267 /* Record a snapshot of the elements in use */
1268 for (elix = 0; elix < fqt->nelts; elix++)
1270 elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1271 if (1 || elt->valid)
1273 fqt->n_vectors[elix] = elt->n_vectors;
1281 if (fq->head == fq->tail)
1283 fq->head_hint = fq->head;
1287 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1291 fq->head_hint = fq->head;
1295 from = elt->buffer_index;
1296 msg_type = elt->msg_type;
1298 ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1299 ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1301 f = vlib_get_frame_to_node (vm, fqm->node_index);
1303 to = vlib_frame_vector_args (f);
1305 n_left_to_node = elt->n_vectors;
1307 while (n_left_to_node >= 4)
1315 n_left_to_node -= 4;
1318 while (n_left_to_node > 0)
1326 vectors += elt->n_vectors;
1327 f->n_vectors = elt->n_vectors;
1328 vlib_put_frame_to_node (vm, fqm->node_index, f);
1332 elt->msg_type = 0xfefefefe;
1333 CLIB_MEMORY_BARRIER ();
1338 * Limit the number of packets pushed into the graph
1340 if (vectors >= fq->vector_threshold)
1342 fq->head_hint = fq->head;
1350 static_always_inline void
1351 vlib_worker_thread_internal (vlib_main_t * vm)
1353 vlib_node_main_t *nm = &vm->node_main;
1354 vlib_thread_main_t *tm = vlib_get_thread_main ();
1355 u64 cpu_time_now = clib_cpu_time_now ();
1356 vlib_frame_queue_main_t *fqm;
1358 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1362 vlib_worker_thread_barrier_check ();
1364 vec_foreach (fqm, tm->frame_queue_mains)
1365 vlib_frame_queue_dequeue_internal (vm, fqm);
1367 vlib_node_runtime_t *n;
1368 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1370 cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1371 VLIB_NODE_STATE_POLLING, /* frame */ 0,
1375 /* Next handle interrupts. */
1377 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1381 _vec_len (nm->pending_interrupt_node_runtime_indices) = 0;
1382 for (i = 0; i < l; i++)
1384 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1386 pending_interrupt_node_runtime_indices
1389 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1390 VLIB_NODE_STATE_INTERRUPT,
1397 if (_vec_len (nm->pending_frames))
1400 cpu_time_now = clib_cpu_time_now ();
1401 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1403 vlib_pending_frame_t *p;
1405 p = nm->pending_frames + i;
1407 cpu_time_now = dispatch_pending_node (vm, p, cpu_time_now);
1409 _vec_len (nm->pending_frames) = 0;
1411 vlib_increment_main_loop_counter (vm);
1413 /* Record time stamp in case there are no enabled nodes and above
1414 calls do not update time stamp. */
1415 cpu_time_now = clib_cpu_time_now ();
1420 vlib_worker_thread_fn (void *arg)
1422 vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1423 vlib_main_t *vm = vlib_get_main ();
1425 ASSERT (vm->cpu_index == os_get_cpu_number ());
1427 vlib_worker_thread_init (w);
1428 clib_time_init (&vm->clib_time);
1429 clib_mem_set_heap (w->thread_mheap);
1432 /* Wait until the dpdk init sequence is complete */
1433 vlib_thread_main_t *tm = vlib_get_thread_main ();
1434 while (tm->worker_thread_release == 0)
1435 vlib_worker_thread_barrier_check ();
1438 vlib_worker_thread_internal (vm);
1442 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1445 .function = vlib_worker_thread_fn,
1450 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1452 vlib_thread_main_t *tm = vlib_get_thread_main ();
1453 vlib_frame_queue_main_t *fqm;
1454 vlib_frame_queue_t *fq;
1457 if (frame_queue_nelts == 0)
1458 frame_queue_nelts = FRAME_QUEUE_NELTS;
1460 vec_add2 (tm->frame_queue_mains, fqm, 1);
1462 fqm->node_index = node_index;
1464 vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1465 _vec_len (fqm->vlib_frame_queues) = 0;
1466 for (i = 0; i < tm->n_vlib_mains; i++)
1468 fq = vlib_frame_queue_alloc (frame_queue_nelts);
1469 vec_add1 (fqm->vlib_frame_queues, fq);
1472 return (fqm - tm->frame_queue_mains);
1476 threads_init (vlib_main_t * vm)
1481 VLIB_INIT_FUNCTION (threads_init);
1484 * fd.io coding-style-patch-verification: ON
1487 * eval: (c-set-style "gnu")