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 ();
476 * Note: disabling signals in worker threads as follows
477 * prevents the api post-mortem dump scheme from working
481 * pthread_sigmask (SIG_SETMASK, &s, 0);
485 clib_mem_set_heap (w->thread_mheap);
487 if (vec_len (tm->thread_prefix) && w->registration->short_name)
489 w->name = format (0, "%v_%s_%d%c", tm->thread_prefix,
490 w->registration->short_name, w->instance_id, '\0');
491 vlib_set_thread_name ((char *) w->name);
494 if (!w->registration->use_pthreads)
497 /* Initial barrier sync, for both worker and i/o threads */
498 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
500 while (*vlib_worker_threads->wait_at_barrier)
503 clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
508 vlib_worker_thread_bootstrap_fn (void *arg)
511 vlib_worker_thread_t *w = arg;
513 w->lwp = syscall (SYS_gettid);
514 w->thread_id = pthread_self ();
516 rv = (void *) clib_calljmp
517 ((uword (*)(uword)) w->thread_function,
518 (uword) arg, w->thread_stack + VLIB_THREAD_STACK_SIZE);
519 /* NOTREACHED, we hope */
524 vlib_launch_thread (void *fp, vlib_worker_thread_t * w, unsigned lcore_id)
526 void *(*fp_arg) (void *) = fp;
528 w->lcore_id = lcore_id;
530 if (!w->registration->use_pthreads)
531 if (rte_eal_remote_launch) /* do we have dpdk linked */
532 return rte_eal_remote_launch (fp, (void *) w, lcore_id);
542 CPU_SET (lcore_id, &cpuset);
544 ret = pthread_create (&worker, NULL /* attr */ , fp_arg, (void *) w);
546 return pthread_setaffinity_np (worker, sizeof (cpu_set_t), &cpuset);
552 static clib_error_t *
553 start_workers (vlib_main_t * vm)
556 vlib_worker_thread_t *w;
557 vlib_main_t *vm_clone;
559 vlib_thread_main_t *tm = &vlib_thread_main;
560 vlib_thread_registration_t *tr;
561 vlib_node_runtime_t *rt;
562 u32 n_vlib_mains = tm->n_vlib_mains;
563 u32 worker_thread_index;
564 u8 *main_heap = clib_mem_get_per_cpu_heap ();
565 mheap_t *main_heap_header = mheap_header (main_heap);
567 vec_reset_length (vlib_worker_threads);
569 /* Set up the main thread */
570 vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
571 w->elog_track.name = "main thread";
572 elog_track_register (&vm->elog_main, &w->elog_track);
574 if (vec_len (tm->thread_prefix))
576 w->name = format (0, "%v_main%c", tm->thread_prefix, '\0');
577 vlib_set_thread_name ((char *) w->name);
581 * Truth of the matter: we always use at least two
582 * threads. So, make the main heap thread-safe
583 * and make the event log thread-safe.
585 main_heap_header->flags |= MHEAP_FLAG_THREAD_SAFE;
587 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
588 vm->elog_main.lock[0] = 0;
590 if (n_vlib_mains > 1)
592 vec_validate (vlib_mains, tm->n_vlib_mains - 1);
593 _vec_len (vlib_mains) = 0;
594 vec_add1 (vlib_mains, vm);
596 vlib_worker_threads->wait_at_barrier =
597 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
598 vlib_worker_threads->workers_at_barrier =
599 clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
601 /* Ask for an initial barrier sync */
602 *vlib_worker_threads->workers_at_barrier = 0;
603 *vlib_worker_threads->wait_at_barrier = 1;
605 worker_thread_index = 1;
607 for (i = 0; i < vec_len (tm->registrations); i++)
609 vlib_node_main_t *nm, *nm_clone;
610 vlib_buffer_main_t *bm_clone;
611 vlib_buffer_free_list_t *fl_clone, *fl_orig;
612 vlib_buffer_free_list_t *orig_freelist_pool;
615 tr = tm->registrations[i];
620 for (k = 0; k < tr->count; k++)
622 vec_add2 (vlib_worker_threads, w, 1);
625 mheap_alloc (0 /* use VM */ , tr->mheap_size);
627 w->thread_mheap = main_heap;
628 w->thread_stack = vlib_thread_stacks[w - vlib_worker_threads];
629 w->thread_function = tr->function;
630 w->thread_function_arg = w;
632 w->registration = tr;
635 (char *) format (0, "%s %d", tr->name, k + 1);
636 vec_add1 (w->elog_track.name, 0);
637 elog_track_register (&vm->elog_main, &w->elog_track);
639 if (tr->no_data_structure_clone)
642 /* Fork vlib_global_main et al. Look for bugs here */
643 oldheap = clib_mem_set_heap (w->thread_mheap);
645 vm_clone = clib_mem_alloc (sizeof (*vm_clone));
646 clib_memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
648 vm_clone->cpu_index = worker_thread_index;
649 vm_clone->heap_base = w->thread_mheap;
650 vm_clone->mbuf_alloc_list = 0;
651 memset (&vm_clone->random_buffer, 0,
652 sizeof (vm_clone->random_buffer));
654 nm = &vlib_mains[0]->node_main;
655 nm_clone = &vm_clone->node_main;
656 /* fork next frames array, preserving node runtime indices */
657 nm_clone->next_frames = vec_dup (nm->next_frames);
658 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
660 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
661 u32 save_node_runtime_index;
664 save_node_runtime_index = nf->node_runtime_index;
665 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
666 vlib_next_frame_init (nf);
667 nf->node_runtime_index = save_node_runtime_index;
668 nf->flags = save_flags;
671 /* fork the frame dispatch queue */
672 nm_clone->pending_frames = 0;
673 vec_validate (nm_clone->pending_frames, 10); /* $$$$$?????? */
674 _vec_len (nm_clone->pending_frames) = 0;
678 for (j = 0; j < vec_len (nm->nodes); j++)
681 n = clib_mem_alloc_no_fail (sizeof (*n));
682 clib_memcpy (n, nm->nodes[j], sizeof (*n));
683 /* none of the copied nodes have enqueue rights given out */
684 n->owner_node_index = VLIB_INVALID_NODE_INDEX;
685 memset (&n->stats_total, 0, sizeof (n->stats_total));
686 memset (&n->stats_last_clear, 0,
687 sizeof (n->stats_last_clear));
688 vec_add1 (nm_clone->nodes, n);
690 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
691 vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL]);
693 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
694 vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT]);
695 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
696 rt->cpu_index = vm_clone->cpu_index;
698 nm_clone->processes = vec_dup (nm->processes);
700 /* zap the (per worker) frame freelists, etc */
701 nm_clone->frame_sizes = 0;
702 nm_clone->frame_size_hash = 0;
704 /* Packet trace buffers are guaranteed to be empty, nothing to do here */
706 clib_mem_set_heap (oldheap);
707 vec_add1 (vlib_mains, vm_clone);
709 vm_clone->error_main.counters =
710 vec_dup (vlib_mains[0]->error_main.counters);
711 vm_clone->error_main.counters_last_clear =
712 vec_dup (vlib_mains[0]->error_main.counters_last_clear);
714 /* Fork the vlib_buffer_main_t free lists, etc. */
715 bm_clone = vec_dup (vm_clone->buffer_main);
716 vm_clone->buffer_main = bm_clone;
718 orig_freelist_pool = bm_clone->buffer_free_list_pool;
719 bm_clone->buffer_free_list_pool = 0;
722 pool_foreach (fl_orig, orig_freelist_pool,
724 pool_get_aligned (bm_clone->buffer_free_list_pool,
725 fl_clone, CLIB_CACHE_LINE_BYTES);
726 ASSERT (fl_orig - orig_freelist_pool
727 == fl_clone - bm_clone->buffer_free_list_pool);
729 fl_clone[0] = fl_orig[0];
730 fl_clone->aligned_buffers = 0;
731 fl_clone->unaligned_buffers = 0;
732 fl_clone->n_alloc = 0;
736 worker_thread_index++;
742 /* only have non-data-structure copy threads to create... */
743 for (i = 0; i < vec_len (tm->registrations); i++)
745 tr = tm->registrations[i];
747 for (j = 0; j < tr->count; j++)
749 vec_add2 (vlib_worker_threads, w, 1);
752 mheap_alloc (0 /* use VM */ , tr->mheap_size);
754 w->thread_mheap = main_heap;
755 w->thread_stack = vlib_thread_stacks[w - vlib_worker_threads];
756 w->thread_function = tr->function;
757 w->thread_function_arg = w;
760 (char *) format (0, "%s %d", tr->name, j + 1);
761 w->registration = tr;
762 vec_add1 (w->elog_track.name, 0);
763 elog_track_register (&vm->elog_main, &w->elog_track);
768 worker_thread_index = 1;
770 for (i = 0; i < vec_len (tm->registrations); i++)
774 tr = tm->registrations[i];
776 if (tr->use_pthreads || tm->use_pthreads)
778 for (j = 0; j < tr->count; j++)
780 w = vlib_worker_threads + worker_thread_index++;
781 if (vlib_launch_thread (vlib_worker_thread_bootstrap_fn, w, 0) <
783 clib_warning ("Couldn't start '%s' pthread ", tr->name);
790 clib_bitmap_foreach (c, tr->coremask, ({
791 w = vlib_worker_threads + worker_thread_index++;
792 if (vlib_launch_thread (vlib_worker_thread_bootstrap_fn, w, c) < 0)
793 clib_warning ("Couldn't start DPDK lcore %d", c);
799 vlib_worker_thread_barrier_sync (vm);
800 vlib_worker_thread_barrier_release (vm);
804 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
807 vlib_worker_thread_node_runtime_update (void)
810 vlib_worker_thread_t *w;
812 vlib_node_main_t *nm, *nm_clone;
813 vlib_node_t **old_nodes_clone;
814 vlib_main_t *vm_clone;
815 vlib_node_runtime_t *rt, *old_rt;
818 vlib_node_runtime_sync_stats (vlib_main_t * vm,
819 vlib_node_runtime_t * r,
821 uword n_vectors, uword n_clocks);
823 ASSERT (os_get_cpu_number () == 0);
825 if (vec_len (vlib_mains) == 0)
831 ASSERT (os_get_cpu_number () == 0);
832 ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
835 * Scrape all runtime stats, so we don't lose node runtime(s) with
836 * pending counts, or throw away worker / io thread counts.
838 for (j = 0; j < vec_len (nm->nodes); j++)
842 vlib_node_sync_stats (vm, n);
845 for (i = 1; i < vec_len (vlib_mains); i++)
849 vm_clone = vlib_mains[i];
850 nm_clone = &vm_clone->node_main;
852 for (j = 0; j < vec_len (nm_clone->nodes); j++)
854 n = nm_clone->nodes[j];
856 rt = vlib_node_get_runtime (vm_clone, n->index);
857 vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
861 for (i = 1; i < vec_len (vlib_mains); i++)
863 vlib_node_runtime_t *rt;
864 w = vlib_worker_threads + i;
865 oldheap = clib_mem_set_heap (w->thread_mheap);
867 vm_clone = vlib_mains[i];
869 /* Re-clone error heap */
870 u64 *old_counters = vm_clone->error_main.counters;
871 u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
872 clib_memcpy (&vm_clone->error_main, &vm->error_main,
873 sizeof (vm->error_main));
874 j = vec_len (vm->error_main.counters) - 1;
875 vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
876 vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
877 vm_clone->error_main.counters = old_counters;
878 vm_clone->error_main.counters_last_clear = old_counters_all_clear;
880 nm_clone = &vm_clone->node_main;
881 vec_free (nm_clone->next_frames);
882 nm_clone->next_frames = vec_dup (nm->next_frames);
884 for (j = 0; j < vec_len (nm_clone->next_frames); j++)
886 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
887 u32 save_node_runtime_index;
890 save_node_runtime_index = nf->node_runtime_index;
891 save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
892 vlib_next_frame_init (nf);
893 nf->node_runtime_index = save_node_runtime_index;
894 nf->flags = save_flags;
897 old_nodes_clone = nm_clone->nodes;
901 for (j = 0; j < vec_len (nm->nodes); j++)
903 vlib_node_t *old_n_clone;
904 vlib_node_t *new_n, *new_n_clone;
906 new_n = nm->nodes[j];
907 old_n_clone = old_nodes_clone[j];
909 new_n_clone = clib_mem_alloc_no_fail (sizeof (*new_n_clone));
910 clib_memcpy (new_n_clone, new_n, sizeof (*new_n));
911 /* none of the copied nodes have enqueue rights given out */
912 new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
914 if (j >= vec_len (old_nodes_clone))
916 /* new node, set to zero */
917 memset (&new_n_clone->stats_total, 0,
918 sizeof (new_n_clone->stats_total));
919 memset (&new_n_clone->stats_last_clear, 0,
920 sizeof (new_n_clone->stats_last_clear));
924 /* Copy stats if the old data is valid */
925 clib_memcpy (&new_n_clone->stats_total,
926 &old_n_clone->stats_total,
927 sizeof (new_n_clone->stats_total));
928 clib_memcpy (&new_n_clone->stats_last_clear,
929 &old_n_clone->stats_last_clear,
930 sizeof (new_n_clone->stats_last_clear));
932 /* keep previous node state */
933 new_n_clone->state = old_n_clone->state;
935 vec_add1 (nm_clone->nodes, new_n_clone);
937 /* Free the old node clone */
938 for (j = 0; j < vec_len (old_nodes_clone); j++)
939 clib_mem_free (old_nodes_clone[j]);
940 vec_free (old_nodes_clone);
942 vec_free (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL]);
944 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
945 vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL]);
947 /* clone input node runtime */
948 old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
950 nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
951 vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT]);
953 vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
955 rt->cpu_index = vm_clone->cpu_index;
958 for (j = 0; j < vec_len (old_rt); j++)
960 rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
961 rt->state = old_rt[j].state;
966 nm_clone->processes = vec_dup (nm->processes);
968 clib_mem_set_heap (oldheap);
970 // vnet_main_fork_fixup (i);
975 unformat_sched_policy (unformat_input_t * input, va_list * args)
977 u32 *r = va_arg (*args, u32 *);
980 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
988 static clib_error_t *
989 cpu_config (vlib_main_t * vm, unformat_input_t * input)
991 vlib_thread_registration_t *tr;
993 vlib_thread_main_t *tm = &vlib_thread_main;
999 tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1001 tm->n_thread_stacks = 1; /* account for main thread */
1002 tm->sched_policy = ~0;
1003 tm->sched_priority = ~0;
1009 hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1013 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1015 if (unformat (input, "use-pthreads"))
1016 tm->use_pthreads = 1;
1017 else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1019 else if (unformat (input, "main-core %u", &tm->main_lcore))
1021 else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1023 else if (unformat (input, "coremask-%s %llx", &name, &coremask))
1025 p = hash_get_mem (tm->thread_registrations_by_name, name);
1027 return clib_error_return (0, "no such thread type '%s'", name);
1029 tr = (vlib_thread_registration_t *) p[0];
1031 if (tr->use_pthreads)
1032 return clib_error_return (0,
1033 "coremask cannot be set for '%s' threads",
1036 tr->coremask = clib_bitmap_set_multiple
1037 (tr->coremask, 0, coremask, BITS (coremask));
1038 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1040 else if (unformat (input, "corelist-%s %U", &name, unformat_bitmap_list,
1043 p = hash_get_mem (tm->thread_registrations_by_name, name);
1045 return clib_error_return (0, "no such thread type '%s'", name);
1047 tr = (vlib_thread_registration_t *) p[0];
1049 if (tr->use_pthreads)
1050 return clib_error_return (0,
1051 "corelist cannot be set for '%s' threads",
1054 tr->coremask = bitmap;
1055 tr->count = clib_bitmap_count_set_bits (tr->coremask);
1059 (input, "scheduler-policy %U", unformat_sched_policy,
1062 else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1064 else if (unformat (input, "%s %u", &name, &count))
1066 p = hash_get_mem (tm->thread_registrations_by_name, name);
1068 return clib_error_return (0, "no such thread type 3 '%s'", name);
1070 tr = (vlib_thread_registration_t *) p[0];
1071 if (tr->fixed_count)
1072 return clib_error_return
1073 (0, "number of %s threads not configurable", tr->name);
1080 if (tm->sched_priority != ~0)
1082 if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1084 u32 prio_max = sched_get_priority_max (tm->sched_policy);
1085 u32 prio_min = sched_get_priority_min (tm->sched_policy);
1086 if (tm->sched_priority > prio_max)
1087 tm->sched_priority = prio_max;
1088 if (tm->sched_priority < prio_min)
1089 tm->sched_priority = prio_min;
1093 return clib_error_return
1095 "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1096 tm->sched_priority);
1101 if (!tm->thread_prefix)
1102 tm->thread_prefix = format (0, "vpp");
1106 tm->n_thread_stacks += tr->count;
1107 tm->n_pthreads += tr->count * tr->use_pthreads;
1108 tm->n_eal_threads += tr->count * (tr->use_pthreads == 0);
1115 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1117 #if !defined (__x86_64__) && !defined (__aarch64__) && !defined (__powerpc64__) && !defined(__arm__)
1119 __sync_fetch_and_add_8 (void)
1121 fformat (stderr, "%s called\n", __FUNCTION__);
1126 __sync_add_and_fetch_8 (void)
1128 fformat (stderr, "%s called\n", __FUNCTION__);
1133 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1135 vnet_main_fixup (vlib_fork_fixup_t which)
1140 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1142 vlib_main_t *vm = vlib_get_main ();
1144 if (vlib_mains == 0)
1147 ASSERT (os_get_cpu_number () == 0);
1148 vlib_worker_thread_barrier_sync (vm);
1152 case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1153 vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1159 vlib_worker_thread_barrier_release (vm);
1163 vlib_worker_thread_barrier_sync (vlib_main_t * vm)
1171 count = vec_len (vlib_mains) - 1;
1173 /* Tolerate recursive calls */
1174 if (++vlib_worker_threads[0].recursion_level > 1)
1177 vlib_worker_threads[0].barrier_sync_count++;
1179 ASSERT (os_get_cpu_number () == 0);
1181 deadline = vlib_time_now (vm) + BARRIER_SYNC_TIMEOUT;
1183 *vlib_worker_threads->wait_at_barrier = 1;
1184 while (*vlib_worker_threads->workers_at_barrier != count)
1186 if (vlib_time_now (vm) > deadline)
1188 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1195 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1202 if (--vlib_worker_threads[0].recursion_level > 0)
1205 deadline = vlib_time_now (vm) + BARRIER_SYNC_TIMEOUT;
1207 *vlib_worker_threads->wait_at_barrier = 0;
1209 while (*vlib_worker_threads->workers_at_barrier > 0)
1211 if (vlib_time_now (vm) > deadline)
1213 fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1220 * Check the frame queue to see if any frames are available.
1221 * If so, pull the packets off the frames and put them to
1225 vlib_frame_queue_dequeue_internal (vlib_main_t * vm,
1226 vlib_frame_queue_main_t * fqm)
1228 u32 thread_id = vm->cpu_index;
1229 vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1230 vlib_frame_queue_elt_t *elt;
1239 ASSERT (vm == vlib_mains[thread_id]);
1241 if (PREDICT_FALSE (fqm->node_index == ~0))
1244 * Gather trace data for frame queues
1246 if (PREDICT_FALSE (fq->trace))
1248 frame_queue_trace_t *fqt;
1249 frame_queue_nelt_counter_t *fqh;
1252 fqt = &fqm->frame_queue_traces[thread_id];
1254 fqt->nelts = fq->nelts;
1255 fqt->head = fq->head;
1256 fqt->head_hint = fq->head_hint;
1257 fqt->tail = fq->tail;
1258 fqt->threshold = fq->vector_threshold;
1259 fqt->n_in_use = fqt->tail - fqt->head;
1260 if (fqt->n_in_use >= fqt->nelts)
1262 // if beyond max then use max
1263 fqt->n_in_use = fqt->nelts - 1;
1266 /* Record the number of elements in use in the histogram */
1267 fqh = &fqm->frame_queue_histogram[thread_id];
1268 fqh->count[fqt->n_in_use]++;
1270 /* Record a snapshot of the elements in use */
1271 for (elix = 0; elix < fqt->nelts; elix++)
1273 elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1274 if (1 || elt->valid)
1276 fqt->n_vectors[elix] = elt->n_vectors;
1284 if (fq->head == fq->tail)
1286 fq->head_hint = fq->head;
1290 elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1294 fq->head_hint = fq->head;
1298 from = elt->buffer_index;
1299 msg_type = elt->msg_type;
1301 ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1302 ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1304 f = vlib_get_frame_to_node (vm, fqm->node_index);
1306 to = vlib_frame_vector_args (f);
1308 n_left_to_node = elt->n_vectors;
1310 while (n_left_to_node >= 4)
1318 n_left_to_node -= 4;
1321 while (n_left_to_node > 0)
1329 vectors += elt->n_vectors;
1330 f->n_vectors = elt->n_vectors;
1331 vlib_put_frame_to_node (vm, fqm->node_index, f);
1335 elt->msg_type = 0xfefefefe;
1336 CLIB_MEMORY_BARRIER ();
1341 * Limit the number of packets pushed into the graph
1343 if (vectors >= fq->vector_threshold)
1345 fq->head_hint = fq->head;
1353 static_always_inline void
1354 vlib_worker_thread_internal (vlib_main_t * vm)
1356 vlib_node_main_t *nm = &vm->node_main;
1357 vlib_thread_main_t *tm = vlib_get_thread_main ();
1358 u64 cpu_time_now = clib_cpu_time_now ();
1359 vlib_frame_queue_main_t *fqm;
1361 vec_alloc (nm->pending_interrupt_node_runtime_indices, 32);
1365 vlib_worker_thread_barrier_check ();
1367 vec_foreach (fqm, tm->frame_queue_mains)
1368 vlib_frame_queue_dequeue_internal (vm, fqm);
1370 vlib_node_runtime_t *n;
1371 vec_foreach (n, nm->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1373 cpu_time_now = dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1374 VLIB_NODE_STATE_POLLING, /* frame */ 0,
1378 /* Next handle interrupts. */
1380 uword l = _vec_len (nm->pending_interrupt_node_runtime_indices);
1384 _vec_len (nm->pending_interrupt_node_runtime_indices) = 0;
1385 for (i = 0; i < l; i++)
1387 n = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1389 pending_interrupt_node_runtime_indices
1392 dispatch_node (vm, n, VLIB_NODE_TYPE_INPUT,
1393 VLIB_NODE_STATE_INTERRUPT,
1400 if (_vec_len (nm->pending_frames))
1403 cpu_time_now = clib_cpu_time_now ();
1404 for (i = 0; i < _vec_len (nm->pending_frames); i++)
1406 vlib_pending_frame_t *p;
1408 p = nm->pending_frames + i;
1410 cpu_time_now = dispatch_pending_node (vm, p, cpu_time_now);
1412 _vec_len (nm->pending_frames) = 0;
1414 vlib_increment_main_loop_counter (vm);
1416 /* Record time stamp in case there are no enabled nodes and above
1417 calls do not update time stamp. */
1418 cpu_time_now = clib_cpu_time_now ();
1423 vlib_worker_thread_fn (void *arg)
1425 vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1426 vlib_main_t *vm = vlib_get_main ();
1428 ASSERT (vm->cpu_index == os_get_cpu_number ());
1430 vlib_worker_thread_init (w);
1431 clib_time_init (&vm->clib_time);
1432 clib_mem_set_heap (w->thread_mheap);
1435 /* Wait until the dpdk init sequence is complete */
1436 vlib_thread_main_t *tm = vlib_get_thread_main ();
1437 while (tm->worker_thread_release == 0)
1438 vlib_worker_thread_barrier_check ();
1441 vlib_worker_thread_internal (vm);
1445 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1448 .function = vlib_worker_thread_fn,
1453 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1455 vlib_thread_main_t *tm = vlib_get_thread_main ();
1456 vlib_frame_queue_main_t *fqm;
1457 vlib_frame_queue_t *fq;
1460 if (frame_queue_nelts == 0)
1461 frame_queue_nelts = FRAME_QUEUE_NELTS;
1463 vec_add2 (tm->frame_queue_mains, fqm, 1);
1465 fqm->node_index = node_index;
1467 vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1468 _vec_len (fqm->vlib_frame_queues) = 0;
1469 for (i = 0; i < tm->n_vlib_mains; i++)
1471 fq = vlib_frame_queue_alloc (frame_queue_nelts);
1472 vec_add1 (fqm->vlib_frame_queues, fq);
1475 return (fqm - tm->frame_queue_mains);
1479 threads_init (vlib_main_t * vm)
1484 VLIB_INIT_FUNCTION (threads_init);
1487 * fd.io coding-style-patch-verification: ON
1490 * eval: (c-set-style "gnu")