vlib: add VLIB_NUM_WORKERS_CHANGE_FN() handler
[vpp.git] / src / vlib / threads.c
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #define _GNU_SOURCE
16
17 #include <signal.h>
18 #include <math.h>
19 #include <vppinfra/format.h>
20 #include <vppinfra/time_range.h>
21 #include <vppinfra/interrupt.h>
22 #include <vppinfra/linux/sysfs.h>
23 #include <vlib/vlib.h>
24
25 #include <vlib/threads.h>
26
27 #include <vlib/stats/stats.h>
28
29 u32
30 vl (void *p)
31 {
32   return vec_len (p);
33 }
34
35 vlib_worker_thread_t *vlib_worker_threads;
36 vlib_thread_main_t vlib_thread_main;
37
38 /*
39  * Barrier tracing can be enabled on a normal build to collect information
40  * on barrier use, including timings and call stacks.  Deliberately not
41  * keyed off CLIB_DEBUG, because that can add significant overhead which
42  * imapacts observed timings.
43  */
44
45 static inline void
46 barrier_trace_sync (f64 t_entry, f64 t_open, f64 t_closed)
47 {
48   if (!vlib_worker_threads->barrier_elog_enabled)
49     return;
50
51   ELOG_TYPE_DECLARE (e) = {
52     .format = "bar-trace-%s-#%d",
53     .format_args = "T4i4",
54   };
55
56   struct
57   {
58     u32 caller, count, t_entry, t_open, t_closed;
59   } *ed = 0;
60
61   ed = ELOG_DATA (&vlib_global_main.elog_main, e);
62   ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
63   ed->caller = elog_string (&vlib_global_main.elog_main,
64                             (char *) vlib_worker_threads[0].barrier_caller);
65   ed->t_entry = (int) (1000000.0 * t_entry);
66   ed->t_open = (int) (1000000.0 * t_open);
67   ed->t_closed = (int) (1000000.0 * t_closed);
68 }
69
70 static inline void
71 barrier_trace_sync_rec (f64 t_entry)
72 {
73   if (!vlib_worker_threads->barrier_elog_enabled)
74     return;
75
76   ELOG_TYPE_DECLARE (e) = {
77     .format = "bar-syncrec-%s-#%d",
78     .format_args = "T4i4",
79   };
80
81   struct
82   {
83     u32 caller, depth;
84   } *ed = 0;
85
86   ed = ELOG_DATA (&vlib_global_main.elog_main, e);
87   ed->depth = (int) vlib_worker_threads[0].recursion_level - 1;
88   ed->caller = elog_string (&vlib_global_main.elog_main,
89                             (char *) vlib_worker_threads[0].barrier_caller);
90 }
91
92 static inline void
93 barrier_trace_release_rec (f64 t_entry)
94 {
95   if (!vlib_worker_threads->barrier_elog_enabled)
96     return;
97
98   ELOG_TYPE_DECLARE (e) = {
99     .format = "bar-relrrec-#%d",
100     .format_args = "i4",
101   };
102
103   struct
104   {
105     u32 depth;
106   } *ed = 0;
107
108   ed = ELOG_DATA (&vlib_global_main.elog_main, e);
109   ed->depth = (int) vlib_worker_threads[0].recursion_level;
110 }
111
112 static inline void
113 barrier_trace_release (f64 t_entry, f64 t_closed_total, f64 t_update_main)
114 {
115   if (!vlib_worker_threads->barrier_elog_enabled)
116     return;
117
118   ELOG_TYPE_DECLARE (e) = {
119     .format = "bar-rel-#%d-e%d-u%d-t%d",
120     .format_args = "i4i4i4i4",
121   };
122
123   struct
124   {
125     u32 count, t_entry, t_update_main, t_closed_total;
126   } *ed = 0;
127
128   ed = ELOG_DATA (&vlib_global_main.elog_main, e);
129   ed->t_entry = (int) (1000000.0 * t_entry);
130   ed->t_update_main = (int) (1000000.0 * t_update_main);
131   ed->t_closed_total = (int) (1000000.0 * t_closed_total);
132   ed->count = (int) vlib_worker_threads[0].barrier_sync_count;
133
134   /* Reset context for next trace */
135   vlib_worker_threads[0].barrier_context = NULL;
136 }
137
138 uword
139 os_get_nthreads (void)
140 {
141   return vec_len (vlib_thread_stacks);
142 }
143
144 void
145 vlib_set_thread_name (char *name)
146 {
147   int pthread_setname_np (pthread_t __target_thread, const char *__name);
148   int rv;
149   pthread_t thread = pthread_self ();
150
151   if (thread)
152     {
153       rv = pthread_setname_np (thread, name);
154       if (rv)
155         clib_warning ("pthread_setname_np returned %d", rv);
156     }
157 }
158
159 static int
160 sort_registrations_by_no_clone (void *a0, void *a1)
161 {
162   vlib_thread_registration_t **tr0 = a0;
163   vlib_thread_registration_t **tr1 = a1;
164
165   return ((i32) ((*tr0)->no_data_structure_clone)
166           - ((i32) ((*tr1)->no_data_structure_clone)));
167 }
168
169
170 /* Called early in the init sequence */
171
172 clib_error_t *
173 vlib_thread_init (vlib_main_t * vm)
174 {
175   vlib_thread_main_t *tm = &vlib_thread_main;
176   vlib_worker_thread_t *w;
177   vlib_thread_registration_t *tr;
178   u32 n_vlib_mains = 1;
179   u32 first_index = 1;
180   u32 i;
181   uword *avail_cpu;
182   u32 stats_num_worker_threads_dir_index;
183
184   stats_num_worker_threads_dir_index =
185     vlib_stats_add_gauge ("/sys/num_worker_threads");
186   ASSERT (stats_num_worker_threads_dir_index != ~0);
187
188   /* get bitmaps of active cpu cores and sockets */
189   tm->cpu_core_bitmap =
190     clib_sysfs_list_to_bitmap ("/sys/devices/system/cpu/online");
191   tm->cpu_socket_bitmap =
192     clib_sysfs_list_to_bitmap ("/sys/devices/system/node/online");
193
194   avail_cpu = clib_bitmap_dup (tm->cpu_core_bitmap);
195
196   /* skip cores */
197   for (i = 0; i < tm->skip_cores; i++)
198     {
199       uword c = clib_bitmap_first_set (avail_cpu);
200       if (c == ~0)
201         return clib_error_return (0, "no available cpus to skip");
202
203       avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
204     }
205
206   /* grab cpu for main thread */
207   if (tm->main_lcore != ~0)
208     {
209       if (clib_bitmap_get (avail_cpu, tm->main_lcore) == 0)
210         return clib_error_return (0, "cpu %u is not available to be used"
211                                   " for the main thread", tm->main_lcore);
212       avail_cpu = clib_bitmap_set (avail_cpu, tm->main_lcore, 0);
213     }
214
215   /* assume that there is socket 0 only if there is no data from sysfs */
216   if (!tm->cpu_socket_bitmap)
217     tm->cpu_socket_bitmap = clib_bitmap_set (0, 0, 1);
218
219   /* pin main thread to main_lcore  */
220   if (tm->main_lcore != ~0)
221     {
222       cpu_set_t cpuset;
223       CPU_ZERO (&cpuset);
224       CPU_SET (tm->main_lcore, &cpuset);
225       pthread_setaffinity_np (pthread_self (), sizeof (cpu_set_t), &cpuset);
226     }
227
228   /* Set up thread 0 */
229   vec_validate_aligned (vlib_worker_threads, 0, CLIB_CACHE_LINE_BYTES);
230   vec_set_len (vlib_worker_threads, 1);
231   w = vlib_worker_threads;
232   w->thread_mheap = clib_mem_get_heap ();
233   w->thread_stack = vlib_thread_stacks[0];
234   w->cpu_id = tm->main_lcore;
235   w->lwp = syscall (SYS_gettid);
236   w->thread_id = pthread_self ();
237   tm->n_vlib_mains = 1;
238
239   vlib_get_thread_core_numa (w, w->cpu_id);
240
241   if (tm->sched_policy != ~0)
242     {
243       struct sched_param sched_param;
244       if (!sched_getparam (w->lwp, &sched_param))
245         {
246           if (tm->sched_priority != ~0)
247             sched_param.sched_priority = tm->sched_priority;
248           sched_setscheduler (w->lwp, tm->sched_policy, &sched_param);
249         }
250     }
251
252   /* assign threads to cores and set n_vlib_mains */
253   tr = tm->next;
254
255   while (tr)
256     {
257       vec_add1 (tm->registrations, tr);
258       tr = tr->next;
259     }
260
261   vec_sort_with_function (tm->registrations, sort_registrations_by_no_clone);
262
263   for (i = 0; i < vec_len (tm->registrations); i++)
264     {
265       int j;
266       tr = tm->registrations[i];
267       tr->first_index = first_index;
268       first_index += tr->count;
269       n_vlib_mains += (tr->no_data_structure_clone == 0) ? tr->count : 0;
270
271       /* construct coremask */
272       if (tr->use_pthreads || !tr->count)
273         continue;
274
275       if (tr->coremask)
276         {
277           uword c;
278           /* *INDENT-OFF* */
279           clib_bitmap_foreach (c, tr->coremask)  {
280             if (clib_bitmap_get(avail_cpu, c) == 0)
281               return clib_error_return (0, "cpu %u is not available to be used"
282                                         " for the '%s' thread",c, tr->name);
283
284             avail_cpu = clib_bitmap_set(avail_cpu, c, 0);
285           }
286           /* *INDENT-ON* */
287         }
288       else
289         {
290           for (j = 0; j < tr->count; j++)
291             {
292               /* Do not use CPU 0 by default - leave it to the host and IRQs */
293               uword avail_c0 = clib_bitmap_get (avail_cpu, 0);
294               avail_cpu = clib_bitmap_set (avail_cpu, 0, 0);
295
296               uword c = clib_bitmap_first_set (avail_cpu);
297               /* Use CPU 0 as a last resort */
298               if (c == ~0 && avail_c0)
299                 {
300                   c = 0;
301                   avail_c0 = 0;
302                 }
303
304               if (c == ~0)
305                 return clib_error_return (0,
306                                           "no available cpus to be used for"
307                                           " the '%s' thread", tr->name);
308
309               avail_cpu = clib_bitmap_set (avail_cpu, 0, avail_c0);
310               avail_cpu = clib_bitmap_set (avail_cpu, c, 0);
311               tr->coremask = clib_bitmap_set (tr->coremask, c, 1);
312             }
313         }
314     }
315
316   clib_bitmap_free (avail_cpu);
317
318   tm->n_vlib_mains = n_vlib_mains;
319   vlib_stats_set_gauge (stats_num_worker_threads_dir_index, n_vlib_mains - 1);
320
321   /*
322    * Allocate the remaining worker threads, and thread stack vector slots
323    * from now on, calls to os_get_nthreads() will return the correct
324    * answer.
325    */
326   vec_validate_aligned (vlib_worker_threads, first_index - 1,
327                         CLIB_CACHE_LINE_BYTES);
328   vec_validate (vlib_thread_stacks, vec_len (vlib_worker_threads) - 1);
329   return 0;
330 }
331
332 vlib_frame_queue_t *
333 vlib_frame_queue_alloc (int nelts)
334 {
335   vlib_frame_queue_t *fq;
336
337   fq = clib_mem_alloc_aligned (sizeof (*fq), CLIB_CACHE_LINE_BYTES);
338   clib_memset (fq, 0, sizeof (*fq));
339   fq->nelts = nelts;
340   fq->vector_threshold = 2 * VLIB_FRAME_SIZE;
341   vec_validate_aligned (fq->elts, nelts - 1, CLIB_CACHE_LINE_BYTES);
342
343   if (nelts & (nelts - 1))
344     {
345       fformat (stderr, "FATAL: nelts MUST be a power of 2\n");
346       abort ();
347     }
348
349   return (fq);
350 }
351
352 void vl_msg_api_handler_no_free (void *) __attribute__ ((weak));
353 void
354 vl_msg_api_handler_no_free (void *v)
355 {
356 }
357
358 /* To be called by vlib worker threads upon startup */
359 void
360 vlib_worker_thread_init (vlib_worker_thread_t * w)
361 {
362   vlib_thread_main_t *tm = vlib_get_thread_main ();
363
364   /*
365    * Note: disabling signals in worker threads as follows
366    * prevents the api post-mortem dump scheme from working
367    * {
368    *    sigset_t s;
369    *    sigfillset (&s);
370    *    pthread_sigmask (SIG_SETMASK, &s, 0);
371    *  }
372    */
373
374   clib_mem_set_heap (w->thread_mheap);
375
376   if (vec_len (tm->thread_prefix) && w->registration->short_name)
377     {
378       w->name = format (0, "%v_%s_%d%c", tm->thread_prefix,
379                         w->registration->short_name, w->instance_id, '\0');
380       vlib_set_thread_name ((char *) w->name);
381     }
382
383   if (!w->registration->use_pthreads)
384     {
385
386       /* Initial barrier sync, for both worker and i/o threads */
387       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, 1);
388
389       while (*vlib_worker_threads->wait_at_barrier)
390         ;
391
392       clib_atomic_fetch_add (vlib_worker_threads->workers_at_barrier, -1);
393     }
394 }
395
396 void *
397 vlib_worker_thread_bootstrap_fn (void *arg)
398 {
399   vlib_worker_thread_t *w = arg;
400
401   w->lwp = syscall (SYS_gettid);
402   w->thread_id = pthread_self ();
403
404   __os_thread_index = w - vlib_worker_threads;
405
406   if (CLIB_DEBUG > 0)
407     {
408       void *frame_addr = __builtin_frame_address (0);
409       if (frame_addr < (void *) w->thread_stack ||
410           frame_addr > (void *) w->thread_stack + VLIB_THREAD_STACK_SIZE)
411         {
412           /* heap is not set yet */
413           fprintf (stderr, "thread stack is not set properly\n");
414           exit (1);
415         }
416     }
417
418   w->thread_function (arg);
419
420   return 0;
421 }
422
423 void
424 vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id)
425 {
426   const char *sys_cpu_path = "/sys/devices/system/cpu/cpu";
427   const char *sys_node_path = "/sys/devices/system/node/node";
428   clib_bitmap_t *nbmp = 0, *cbmp = 0;
429   u32 node;
430   u8 *p = 0;
431   int core_id = -1, numa_id = -1;
432
433   p = format (p, "%s%u/topology/core_id%c", sys_cpu_path, cpu_id, 0);
434   clib_sysfs_read ((char *) p, "%d", &core_id);
435   vec_reset_length (p);
436
437   /* *INDENT-OFF* */
438   clib_sysfs_read ("/sys/devices/system/node/online", "%U",
439         unformat_bitmap_list, &nbmp);
440   clib_bitmap_foreach (node, nbmp)  {
441     p = format (p, "%s%u/cpulist%c", sys_node_path, node, 0);
442     clib_sysfs_read ((char *) p, "%U", unformat_bitmap_list, &cbmp);
443     if (clib_bitmap_get (cbmp, cpu_id))
444       numa_id = node;
445     vec_reset_length (cbmp);
446     vec_reset_length (p);
447   }
448   /* *INDENT-ON* */
449   vec_free (nbmp);
450   vec_free (cbmp);
451   vec_free (p);
452
453   w->core_id = core_id;
454   w->numa_id = numa_id;
455 }
456
457 static clib_error_t *
458 vlib_launch_thread_int (void *fp, vlib_worker_thread_t * w, unsigned cpu_id)
459 {
460   clib_mem_main_t *mm = &clib_mem_main;
461   vlib_thread_main_t *tm = &vlib_thread_main;
462   pthread_t worker;
463   pthread_attr_t attr;
464   cpu_set_t cpuset;
465   void *(*fp_arg) (void *) = fp;
466   void *numa_heap;
467
468   w->cpu_id = cpu_id;
469   vlib_get_thread_core_numa (w, cpu_id);
470
471   /* Set up NUMA-bound heap if indicated */
472   if (mm->per_numa_mheaps[w->numa_id] == 0)
473     {
474       /* If the user requested a NUMA heap, create it... */
475       if (tm->numa_heap_size)
476         {
477           clib_mem_set_numa_affinity (w->numa_id, 1 /* force */ );
478           numa_heap = clib_mem_create_heap (0 /* DIY */ , tm->numa_heap_size,
479                                             1 /* is_locked */ ,
480                                             "numa %u heap", w->numa_id);
481           clib_mem_set_default_numa_affinity ();
482           mm->per_numa_mheaps[w->numa_id] = numa_heap;
483         }
484       else
485         {
486           /* Or, use the main heap */
487           mm->per_numa_mheaps[w->numa_id] = w->thread_mheap;
488         }
489     }
490
491       CPU_ZERO (&cpuset);
492       CPU_SET (cpu_id, &cpuset);
493
494       if (pthread_attr_init (&attr))
495         return clib_error_return_unix (0, "pthread_attr_init");
496
497       if (pthread_attr_setstack (&attr, w->thread_stack,
498                                  VLIB_THREAD_STACK_SIZE))
499         return clib_error_return_unix (0, "pthread_attr_setstack");
500
501       if (pthread_create (&worker, &attr, fp_arg, (void *) w))
502         return clib_error_return_unix (0, "pthread_create");
503
504       if (pthread_setaffinity_np (worker, sizeof (cpu_set_t), &cpuset))
505         return clib_error_return_unix (0, "pthread_setaffinity_np");
506
507       if (pthread_attr_destroy (&attr))
508         return clib_error_return_unix (0, "pthread_attr_destroy");
509
510       return 0;
511 }
512
513 static clib_error_t *
514 start_workers (vlib_main_t * vm)
515 {
516   vlib_global_main_t *vgm = vlib_get_global_main ();
517   vlib_main_t *fvm = vlib_get_first_main ();
518   int i, j;
519   vlib_worker_thread_t *w;
520   vlib_main_t *vm_clone;
521   void *oldheap;
522   vlib_thread_main_t *tm = &vlib_thread_main;
523   vlib_thread_registration_t *tr;
524   vlib_node_runtime_t *rt;
525   u32 n_vlib_mains = tm->n_vlib_mains;
526   u32 worker_thread_index;
527   u32 stats_err_entry_index = fvm->error_main.stats_err_entry_index;
528   clib_mem_heap_t *main_heap = clib_mem_get_per_cpu_heap ();
529   vlib_stats_register_mem_heap (main_heap);
530
531   vec_reset_length (vlib_worker_threads);
532
533   /* Set up the main thread */
534   vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
535   w->elog_track.name = "main thread";
536   elog_track_register (vlib_get_elog_main (), &w->elog_track);
537
538   if (vec_len (tm->thread_prefix))
539     {
540       w->name = format (0, "%v_main%c", tm->thread_prefix, '\0');
541       vlib_set_thread_name ((char *) w->name);
542     }
543
544   vgm->elog_main.lock =
545     clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
546   vgm->elog_main.lock[0] = 0;
547
548   clib_callback_data_init (&vm->vlib_node_runtime_perf_callbacks,
549                            &vm->worker_thread_main_loop_callback_lock);
550
551   vec_validate_aligned (vgm->vlib_mains, n_vlib_mains - 1,
552                         CLIB_CACHE_LINE_BYTES);
553   vec_set_len (vgm->vlib_mains, 0);
554   vec_add1_aligned (vgm->vlib_mains, vm, CLIB_CACHE_LINE_BYTES);
555
556   if (n_vlib_mains > 1)
557     {
558       vlib_worker_threads->wait_at_barrier =
559         clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
560       vlib_worker_threads->workers_at_barrier =
561         clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
562
563       vlib_worker_threads->node_reforks_required =
564         clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
565
566       /* We'll need the rpc vector lock... */
567       clib_spinlock_init (&vm->pending_rpc_lock);
568
569       /* Ask for an initial barrier sync */
570       *vlib_worker_threads->workers_at_barrier = 0;
571       *vlib_worker_threads->wait_at_barrier = 1;
572
573       /* Without update or refork */
574       *vlib_worker_threads->node_reforks_required = 0;
575       vgm->need_vlib_worker_thread_node_runtime_update = 0;
576
577       /* init timing */
578       vm->barrier_epoch = 0;
579       vm->barrier_no_close_before = 0;
580
581       worker_thread_index = 1;
582       clib_spinlock_init (&vm->worker_thread_main_loop_callback_lock);
583
584       for (i = 0; i < vec_len (tm->registrations); i++)
585         {
586           vlib_node_main_t *nm, *nm_clone;
587           int k;
588
589           tr = tm->registrations[i];
590
591           if (tr->count == 0)
592             continue;
593
594           for (k = 0; k < tr->count; k++)
595             {
596               vlib_node_t *n;
597               u64 **c;
598
599               vec_add2 (vlib_worker_threads, w, 1);
600               /* Currently unused, may not really work */
601               if (tr->mheap_size)
602                 w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
603                                                         /* unlocked */ 0,
604                                                         "%s%d heap",
605                                                         tr->name, k);
606               else
607                 w->thread_mheap = main_heap;
608
609               w->thread_stack =
610                 vlib_thread_stack_init (w - vlib_worker_threads);
611               w->thread_function = tr->function;
612               w->thread_function_arg = w;
613               w->instance_id = k;
614               w->registration = tr;
615
616               w->elog_track.name =
617                 (char *) format (0, "%s %d", tr->name, k + 1);
618               vec_add1 (w->elog_track.name, 0);
619               elog_track_register (vlib_get_elog_main (), &w->elog_track);
620
621               if (tr->no_data_structure_clone)
622                 continue;
623
624               /* Fork vlib_global_main et al. Look for bugs here */
625               oldheap = clib_mem_set_heap (w->thread_mheap);
626
627               vm_clone = clib_mem_alloc_aligned (sizeof (*vm_clone),
628                                                  CLIB_CACHE_LINE_BYTES);
629               clib_memcpy (vm_clone, vlib_get_first_main (),
630                            sizeof (*vm_clone));
631
632               vm_clone->thread_index = worker_thread_index;
633               vm_clone->pending_rpc_requests = 0;
634               vec_validate (vm_clone->pending_rpc_requests, 0);
635               vec_set_len (vm_clone->pending_rpc_requests, 0);
636               clib_memset (&vm_clone->random_buffer, 0,
637                            sizeof (vm_clone->random_buffer));
638               clib_spinlock_init
639                 (&vm_clone->worker_thread_main_loop_callback_lock);
640               clib_callback_data_init
641                 (&vm_clone->vlib_node_runtime_perf_callbacks,
642                  &vm_clone->worker_thread_main_loop_callback_lock);
643
644               nm = &vlib_get_first_main ()->node_main;
645               nm_clone = &vm_clone->node_main;
646               /* fork next frames array, preserving node runtime indices */
647               nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
648                                                        CLIB_CACHE_LINE_BYTES);
649               for (j = 0; j < vec_len (nm_clone->next_frames); j++)
650                 {
651                   vlib_next_frame_t *nf = &nm_clone->next_frames[j];
652                   u32 save_node_runtime_index;
653                   u32 save_flags;
654
655                   save_node_runtime_index = nf->node_runtime_index;
656                   save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
657                   vlib_next_frame_init (nf);
658                   nf->node_runtime_index = save_node_runtime_index;
659                   nf->flags = save_flags;
660                 }
661
662               /* fork the frame dispatch queue */
663               nm_clone->pending_frames = 0;
664               vec_validate (nm_clone->pending_frames, 10);
665               vec_set_len (nm_clone->pending_frames, 0);
666
667               /* fork nodes */
668               nm_clone->nodes = 0;
669
670               /* Allocate all nodes in single block for speed */
671               n = clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*n));
672
673               for (j = 0; j < vec_len (nm->nodes); j++)
674                 {
675                   clib_memcpy (n, nm->nodes[j], sizeof (*n));
676                   /* none of the copied nodes have enqueue rights given out */
677                   n->owner_node_index = VLIB_INVALID_NODE_INDEX;
678                   clib_memset (&n->stats_total, 0, sizeof (n->stats_total));
679                   clib_memset (&n->stats_last_clear, 0,
680                                sizeof (n->stats_last_clear));
681                   vec_add1 (nm_clone->nodes, n);
682                   n++;
683                 }
684               nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
685                 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
686                                  CLIB_CACHE_LINE_BYTES);
687               vec_foreach (rt,
688                            nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
689               {
690                 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
691                 /* copy initial runtime_data from node */
692                 if (n->runtime_data && n->runtime_data_bytes > 0)
693                   clib_memcpy (rt->runtime_data, n->runtime_data,
694                                clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
695                                          n->runtime_data_bytes));
696               }
697
698               nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
699                 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
700                                  CLIB_CACHE_LINE_BYTES);
701               clib_interrupt_init (
702                 &nm_clone->interrupts,
703                 vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
704               vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
705               {
706                 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
707                 /* copy initial runtime_data from node */
708                 if (n->runtime_data && n->runtime_data_bytes > 0)
709                   clib_memcpy (rt->runtime_data, n->runtime_data,
710                                clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
711                                          n->runtime_data_bytes));
712               }
713
714               nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
715                 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
716                                  CLIB_CACHE_LINE_BYTES);
717               vec_foreach (rt,
718                            nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
719               {
720                 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
721                 /* copy initial runtime_data from node */
722                 if (n->runtime_data && n->runtime_data_bytes > 0)
723                   clib_memcpy (rt->runtime_data, n->runtime_data,
724                                clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
725                                          n->runtime_data_bytes));
726               }
727
728               nm_clone->processes = vec_dup_aligned (nm->processes,
729                                                      CLIB_CACHE_LINE_BYTES);
730
731               /* Create per-thread frame freelist */
732               nm_clone->frame_sizes = 0;
733               nm_clone->node_by_error = nm->node_by_error;
734
735               /* Packet trace buffers are guaranteed to be empty, nothing to do here */
736
737               clib_mem_set_heap (oldheap);
738               vec_add1_aligned (vgm->vlib_mains, vm_clone,
739                                 CLIB_CACHE_LINE_BYTES);
740
741               /* Switch to the stats segment ... */
742               vlib_stats_validate (stats_err_entry_index, worker_thread_index,
743                                    vec_len (fvm->error_main.counters) - 1);
744               c = vlib_stats_get_entry_data_pointer (stats_err_entry_index);
745               vm_clone->error_main.counters = c[worker_thread_index];
746
747               vm_clone->error_main.counters_last_clear = vec_dup_aligned (
748                 vlib_get_first_main ()->error_main.counters_last_clear,
749                 CLIB_CACHE_LINE_BYTES);
750
751               worker_thread_index++;
752             }
753         }
754     }
755   else
756     {
757       /* only have non-data-structure copy threads to create... */
758       for (i = 0; i < vec_len (tm->registrations); i++)
759         {
760           tr = tm->registrations[i];
761
762           for (j = 0; j < tr->count; j++)
763             {
764               vec_add2 (vlib_worker_threads, w, 1);
765               if (tr->mheap_size)
766                 {
767                   w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
768                                                           /* locked */ 0,
769                                                           "%s%d heap",
770                                                           tr->name, j);
771                 }
772               else
773                 w->thread_mheap = main_heap;
774               w->thread_stack =
775                 vlib_thread_stack_init (w - vlib_worker_threads);
776               w->thread_function = tr->function;
777               w->thread_function_arg = w;
778               w->instance_id = j;
779               w->elog_track.name =
780                 (char *) format (0, "%s %d", tr->name, j + 1);
781               w->registration = tr;
782               vec_add1 (w->elog_track.name, 0);
783               elog_track_register (vlib_get_elog_main (), &w->elog_track);
784             }
785         }
786     }
787
788   worker_thread_index = 1;
789
790   for (i = 0; i < vec_len (tm->registrations); i++)
791     {
792       clib_error_t *err;
793       int j;
794
795       tr = tm->registrations[i];
796
797       if (tr->use_pthreads || tm->use_pthreads)
798         {
799           for (j = 0; j < tr->count; j++)
800             {
801               w = vlib_worker_threads + worker_thread_index++;
802               err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
803                                             w, 0);
804               if (err)
805                 clib_error_report (err);
806             }
807         }
808       else
809         {
810           uword c;
811           /* *INDENT-OFF* */
812           clib_bitmap_foreach (c, tr->coremask)  {
813             w = vlib_worker_threads + worker_thread_index++;
814             err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
815                                           w, c);
816             if (err)
817               clib_error_report (err);
818           }
819           /* *INDENT-ON* */
820         }
821     }
822   vlib_worker_thread_barrier_sync (vm);
823   {
824     clib_error_t *err;
825     err = vlib_call_init_exit_functions (
826       vm, &vgm->num_workers_change_function_registrations, 1 /* call_once */,
827       1 /* is_global */);
828     if (err)
829       clib_error_report (err);
830   }
831   vlib_worker_thread_barrier_release (vm);
832   return 0;
833 }
834
835 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
836
837
838 static inline void
839 worker_thread_node_runtime_update_internal (void)
840 {
841   int i, j;
842   vlib_main_t *vm;
843   vlib_node_main_t *nm, *nm_clone;
844   vlib_main_t *vm_clone;
845   vlib_node_runtime_t *rt;
846
847   ASSERT (vlib_get_thread_index () == 0);
848
849   vm = vlib_get_first_main ();
850   nm = &vm->node_main;
851
852   ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
853
854   /*
855    * Scrape all runtime stats, so we don't lose node runtime(s) with
856    * pending counts, or throw away worker / io thread counts.
857    */
858   for (j = 0; j < vec_len (nm->nodes); j++)
859     {
860       vlib_node_t *n;
861       n = nm->nodes[j];
862       vlib_node_sync_stats (vm, n);
863     }
864
865   for (i = 1; i < vlib_get_n_threads (); i++)
866     {
867       vlib_node_t *n;
868
869       vm_clone = vlib_get_main_by_index (i);
870       nm_clone = &vm_clone->node_main;
871
872       for (j = 0; j < vec_len (nm_clone->nodes); j++)
873         {
874           n = nm_clone->nodes[j];
875
876           rt = vlib_node_get_runtime (vm_clone, n->index);
877           vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
878         }
879     }
880
881   /* Per-worker clone rebuilds are now done on each thread */
882 }
883
884
885 void
886 vlib_worker_thread_node_refork (void)
887 {
888   vlib_main_t *vm, *vm_clone;
889   vlib_node_main_t *nm, *nm_clone;
890   vlib_node_t **old_nodes_clone;
891   vlib_node_runtime_t *rt, *old_rt;
892   u64 **c;
893
894   vlib_node_t *new_n_clone;
895
896   int j;
897
898   vm = vlib_get_first_main ();
899   nm = &vm->node_main;
900   vm_clone = vlib_get_main ();
901   nm_clone = &vm_clone->node_main;
902
903   /* Re-clone error heap */
904   u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
905
906   clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
907                     sizeof (vm->error_main));
908   j = vec_len (vm->error_main.counters) - 1;
909
910   c = vlib_stats_get_entry_data_pointer (vm->error_main.stats_err_entry_index);
911   vm_clone->error_main.counters = c[vm_clone->thread_index];
912
913   vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
914   vm_clone->error_main.counters_last_clear = old_counters_all_clear;
915
916   vec_free (nm_clone->next_frames);
917   nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
918                                            CLIB_CACHE_LINE_BYTES);
919
920   for (j = 0; j < vec_len (nm_clone->next_frames); j++)
921     {
922       vlib_next_frame_t *nf = &nm_clone->next_frames[j];
923       u32 save_node_runtime_index;
924       u32 save_flags;
925
926       save_node_runtime_index = nf->node_runtime_index;
927       save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
928       vlib_next_frame_init (nf);
929       nf->node_runtime_index = save_node_runtime_index;
930       nf->flags = save_flags;
931     }
932
933   old_nodes_clone = nm_clone->nodes;
934   nm_clone->nodes = 0;
935
936   /* re-fork nodes */
937
938   /* Allocate all nodes in single block for speed */
939   new_n_clone =
940     clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
941   for (j = 0; j < vec_len (nm->nodes); j++)
942     {
943       vlib_node_t *new_n = nm->nodes[j];
944
945       clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
946       /* none of the copied nodes have enqueue rights given out */
947       new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
948
949       if (j >= vec_len (old_nodes_clone))
950         {
951           /* new node, set to zero */
952           clib_memset (&new_n_clone->stats_total, 0,
953                        sizeof (new_n_clone->stats_total));
954           clib_memset (&new_n_clone->stats_last_clear, 0,
955                        sizeof (new_n_clone->stats_last_clear));
956         }
957       else
958         {
959           vlib_node_t *old_n_clone = old_nodes_clone[j];
960           /* Copy stats if the old data is valid */
961           clib_memcpy_fast (&new_n_clone->stats_total,
962                             &old_n_clone->stats_total,
963                             sizeof (new_n_clone->stats_total));
964           clib_memcpy_fast (&new_n_clone->stats_last_clear,
965                             &old_n_clone->stats_last_clear,
966                             sizeof (new_n_clone->stats_last_clear));
967
968           /* keep previous node state */
969           new_n_clone->state = old_n_clone->state;
970           new_n_clone->flags = old_n_clone->flags;
971         }
972       vec_add1 (nm_clone->nodes, new_n_clone);
973       new_n_clone++;
974     }
975   /* Free the old node clones */
976   clib_mem_free (old_nodes_clone[0]);
977
978   vec_free (old_nodes_clone);
979
980
981   /* re-clone internal nodes */
982   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
983   nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
984     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
985                      CLIB_CACHE_LINE_BYTES);
986
987   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
988   {
989     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
990     /* copy runtime_data, will be overwritten later for existing rt */
991     if (n->runtime_data && n->runtime_data_bytes > 0)
992       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
993                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
994                                   n->runtime_data_bytes));
995   }
996
997   for (j = 0; j < vec_len (old_rt); j++)
998     {
999       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1000       rt->state = old_rt[j].state;
1001       rt->flags = old_rt[j].flags;
1002       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1003                         VLIB_NODE_RUNTIME_DATA_SIZE);
1004     }
1005
1006   vec_free (old_rt);
1007
1008   /* re-clone input nodes */
1009   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1010   nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1011     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1012                      CLIB_CACHE_LINE_BYTES);
1013   clib_interrupt_resize (
1014     &nm_clone->interrupts,
1015     vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
1016
1017   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1018   {
1019     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1020     /* copy runtime_data, will be overwritten later for existing rt */
1021     if (n->runtime_data && n->runtime_data_bytes > 0)
1022       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1023                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1024                                   n->runtime_data_bytes));
1025   }
1026
1027   for (j = 0; j < vec_len (old_rt); j++)
1028     {
1029       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1030       rt->state = old_rt[j].state;
1031       rt->flags = old_rt[j].flags;
1032       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1033                         VLIB_NODE_RUNTIME_DATA_SIZE);
1034     }
1035
1036   vec_free (old_rt);
1037
1038   /* re-clone pre-input nodes */
1039   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT];
1040   nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
1041     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
1042                      CLIB_CACHE_LINE_BYTES);
1043
1044   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1045   {
1046     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1047     /* copy runtime_data, will be overwritten later for existing rt */
1048     if (n->runtime_data && n->runtime_data_bytes > 0)
1049       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1050                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1051                                   n->runtime_data_bytes));
1052   }
1053
1054   for (j = 0; j < vec_len (old_rt); j++)
1055     {
1056       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1057       rt->state = old_rt[j].state;
1058       rt->flags = old_rt[j].flags;
1059       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1060                         VLIB_NODE_RUNTIME_DATA_SIZE);
1061     }
1062
1063   vec_free (old_rt);
1064
1065   vec_free (nm_clone->processes);
1066   nm_clone->processes = vec_dup_aligned (nm->processes,
1067                                          CLIB_CACHE_LINE_BYTES);
1068   nm_clone->node_by_error = nm->node_by_error;
1069 }
1070
1071 void
1072 vlib_worker_thread_node_runtime_update (void)
1073 {
1074   /*
1075    * Make a note that we need to do a node runtime update
1076    * prior to releasing the barrier.
1077    */
1078   vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1079 }
1080
1081 u32
1082 unformat_sched_policy (unformat_input_t * input, va_list * args)
1083 {
1084   u32 *r = va_arg (*args, u32 *);
1085
1086   if (0);
1087 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1088   foreach_sched_policy
1089 #undef _
1090     else
1091     return 0;
1092   return 1;
1093 }
1094
1095 static clib_error_t *
1096 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1097 {
1098   vlib_thread_registration_t *tr;
1099   uword *p;
1100   vlib_thread_main_t *tm = &vlib_thread_main;
1101   u8 *name;
1102   uword *bitmap;
1103   u32 count;
1104
1105   tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1106
1107   tm->n_thread_stacks = 1;      /* account for main thread */
1108   tm->sched_policy = ~0;
1109   tm->sched_priority = ~0;
1110   tm->main_lcore = ~0;
1111
1112   tr = tm->next;
1113
1114   while (tr)
1115     {
1116       hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1117       tr = tr->next;
1118     }
1119
1120   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1121     {
1122       if (unformat (input, "use-pthreads"))
1123         tm->use_pthreads = 1;
1124       else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1125         ;
1126       else if (unformat (input, "main-core %u", &tm->main_lcore))
1127         ;
1128       else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1129         ;
1130       else if (unformat (input, "numa-heap-size %U",
1131                          unformat_memory_size, &tm->numa_heap_size))
1132         ;
1133       else if (unformat (input, "coremask-%s %U", &name,
1134                          unformat_bitmap_mask, &bitmap) ||
1135                unformat (input, "corelist-%s %U", &name,
1136                          unformat_bitmap_list, &bitmap))
1137         {
1138           p = hash_get_mem (tm->thread_registrations_by_name, name);
1139           if (p == 0)
1140             return clib_error_return (0, "no such thread type '%s'", name);
1141
1142           tr = (vlib_thread_registration_t *) p[0];
1143
1144           if (tr->use_pthreads)
1145             return clib_error_return (0,
1146                                       "corelist cannot be set for '%s' threads",
1147                                       name);
1148           if (tr->count)
1149             return clib_error_return
1150               (0, "core placement of '%s' threads is already configured",
1151                name);
1152
1153           tr->coremask = bitmap;
1154           tr->count = clib_bitmap_count_set_bits (tr->coremask);
1155         }
1156       else
1157         if (unformat
1158             (input, "scheduler-policy %U", unformat_sched_policy,
1159              &tm->sched_policy))
1160         ;
1161       else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1162         ;
1163       else if (unformat (input, "%s %u", &name, &count))
1164         {
1165           p = hash_get_mem (tm->thread_registrations_by_name, name);
1166           if (p == 0)
1167             return clib_error_return (0, "no such thread type 3 '%s'", name);
1168
1169           tr = (vlib_thread_registration_t *) p[0];
1170
1171           if (tr->fixed_count)
1172             return clib_error_return
1173               (0, "number of '%s' threads not configurable", name);
1174           if (tr->count)
1175             return clib_error_return
1176               (0, "number of '%s' threads is already configured", name);
1177
1178           tr->count = count;
1179         }
1180       else
1181         break;
1182     }
1183
1184   if (tm->sched_priority != ~0)
1185     {
1186       if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1187         {
1188           u32 prio_max = sched_get_priority_max (tm->sched_policy);
1189           u32 prio_min = sched_get_priority_min (tm->sched_policy);
1190           if (tm->sched_priority > prio_max)
1191             tm->sched_priority = prio_max;
1192           if (tm->sched_priority < prio_min)
1193             tm->sched_priority = prio_min;
1194         }
1195       else
1196         {
1197           return clib_error_return
1198             (0,
1199              "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1200              tm->sched_priority);
1201         }
1202     }
1203   tr = tm->next;
1204
1205   if (!tm->thread_prefix)
1206     tm->thread_prefix = format (0, "vpp");
1207
1208   while (tr)
1209     {
1210       tm->n_thread_stacks += tr->count;
1211       tm->n_pthreads += tr->count * tr->use_pthreads;
1212       tm->n_threads += tr->count * (tr->use_pthreads == 0);
1213       tr = tr->next;
1214     }
1215
1216   return 0;
1217 }
1218
1219 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1220
1221   /*
1222    * Enforce minimum open time to minimize packet loss due to Rx overflow,
1223    * based on a test based heuristic that barrier should be open for at least
1224    * 3 time as long as it is closed (with an upper bound of 1ms because by that
1225    *  point it is probably too late to make a difference)
1226    */
1227
1228 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1229 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1230 #endif
1231
1232 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1233 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1234 #endif
1235
1236 void
1237 vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm)
1238 {
1239   f64 deadline;
1240   f64 now = vlib_time_now (vm);
1241   u32 count = vlib_get_n_threads () - 1;
1242
1243   /* No worker threads? */
1244   if (count == 0)
1245     return;
1246
1247   deadline = now + BARRIER_SYNC_TIMEOUT;
1248   *vlib_worker_threads->wait_at_barrier = 1;
1249   while (*vlib_worker_threads->workers_at_barrier != count)
1250     {
1251       if ((now = vlib_time_now (vm)) > deadline)
1252         {
1253           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1254           os_panic ();
1255         }
1256       CLIB_PAUSE ();
1257     }
1258   *vlib_worker_threads->wait_at_barrier = 0;
1259 }
1260
1261 /**
1262  * Return true if the wroker thread barrier is held
1263  */
1264 u8
1265 vlib_worker_thread_barrier_held (void)
1266 {
1267   if (vlib_get_n_threads () < 2)
1268     return (1);
1269
1270   return (*vlib_worker_threads->wait_at_barrier == 1);
1271 }
1272
1273 void
1274 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm, const char *func_name)
1275 {
1276   f64 deadline;
1277   f64 now;
1278   f64 t_entry;
1279   f64 t_open;
1280   f64 t_closed;
1281   f64 max_vector_rate;
1282   u32 count;
1283   int i;
1284
1285   if (vlib_get_n_threads () < 2)
1286     return;
1287
1288   ASSERT (vlib_get_thread_index () == 0);
1289
1290   vlib_worker_threads[0].barrier_caller = func_name;
1291   count = vlib_get_n_threads () - 1;
1292
1293   /* Record entry relative to last close */
1294   now = vlib_time_now (vm);
1295   t_entry = now - vm->barrier_epoch;
1296
1297   /* Tolerate recursive calls */
1298   if (++vlib_worker_threads[0].recursion_level > 1)
1299     {
1300       barrier_trace_sync_rec (t_entry);
1301       return;
1302     }
1303
1304   if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1305     clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1306                          vm->clib_time.last_cpu_time, 0 /* enter */ );
1307
1308   /*
1309    * Need data to decide if we're working hard enough to honor
1310    * the barrier hold-down timer.
1311    */
1312   max_vector_rate = 0.0;
1313   for (i = 1; i < vlib_get_n_threads (); i++)
1314     {
1315       vlib_main_t *ovm = vlib_get_main_by_index (i);
1316       max_vector_rate = clib_max (max_vector_rate,
1317                                   (f64) vlib_last_vectors_per_main_loop (ovm));
1318     }
1319
1320   vlib_worker_threads[0].barrier_sync_count++;
1321
1322   /* Enforce minimum barrier open time to minimize packet loss */
1323   ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1324
1325   /*
1326    * If any worker thread seems busy, which we define
1327    * as a vector rate above 10, we enforce the barrier hold-down timer
1328    */
1329   if (max_vector_rate > 10.0)
1330     {
1331       while (1)
1332         {
1333           now = vlib_time_now (vm);
1334           /* Barrier hold-down timer expired? */
1335           if (now >= vm->barrier_no_close_before)
1336             break;
1337           if ((vm->barrier_no_close_before - now)
1338               > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1339             {
1340               clib_warning
1341                 ("clock change: would have waited for %.4f seconds",
1342                  (vm->barrier_no_close_before - now));
1343               break;
1344             }
1345         }
1346     }
1347   /* Record time of closure */
1348   t_open = now - vm->barrier_epoch;
1349   vm->barrier_epoch = now;
1350
1351   deadline = now + BARRIER_SYNC_TIMEOUT;
1352
1353   *vlib_worker_threads->wait_at_barrier = 1;
1354   while (*vlib_worker_threads->workers_at_barrier != count)
1355     {
1356       if ((now = vlib_time_now (vm)) > deadline)
1357         {
1358           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1359           os_panic ();
1360         }
1361     }
1362
1363   t_closed = now - vm->barrier_epoch;
1364
1365   barrier_trace_sync (t_entry, t_open, t_closed);
1366
1367 }
1368
1369 void
1370 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1371 {
1372   vlib_global_main_t *vgm = vlib_get_global_main ();
1373   f64 deadline;
1374   f64 now;
1375   f64 minimum_open;
1376   f64 t_entry;
1377   f64 t_closed_total;
1378   f64 t_update_main = 0.0;
1379   int refork_needed = 0;
1380
1381   if (vlib_get_n_threads () < 2)
1382     return;
1383
1384   ASSERT (vlib_get_thread_index () == 0);
1385
1386
1387   now = vlib_time_now (vm);
1388   t_entry = now - vm->barrier_epoch;
1389
1390   if (--vlib_worker_threads[0].recursion_level > 0)
1391     {
1392       barrier_trace_release_rec (t_entry);
1393       return;
1394     }
1395
1396   /* Update (all) node runtimes before releasing the barrier, if needed */
1397   if (vgm->need_vlib_worker_thread_node_runtime_update)
1398     {
1399       /*
1400        * Lock stat segment here, so we's safe when
1401        * rebuilding the stat segment node clones from the
1402        * stat thread...
1403        */
1404       vlib_stats_segment_lock ();
1405
1406       /* Do stats elements on main thread */
1407       worker_thread_node_runtime_update_internal ();
1408       vgm->need_vlib_worker_thread_node_runtime_update = 0;
1409
1410       /* Do per thread rebuilds in parallel */
1411       refork_needed = 1;
1412       clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1413                              (vlib_get_n_threads () - 1));
1414       now = vlib_time_now (vm);
1415       t_update_main = now - vm->barrier_epoch;
1416     }
1417
1418   deadline = now + BARRIER_SYNC_TIMEOUT;
1419
1420   /*
1421    * Note when we let go of the barrier.
1422    * Workers can use this to derive a reasonably accurate
1423    * time offset. See vlib_time_now(...)
1424    */
1425   vm->time_last_barrier_release = vlib_time_now (vm);
1426   CLIB_MEMORY_STORE_BARRIER ();
1427
1428   *vlib_worker_threads->wait_at_barrier = 0;
1429
1430   while (*vlib_worker_threads->workers_at_barrier > 0)
1431     {
1432       if ((now = vlib_time_now (vm)) > deadline)
1433         {
1434           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1435           os_panic ();
1436         }
1437     }
1438
1439   /* Wait for reforks before continuing */
1440   if (refork_needed)
1441     {
1442       now = vlib_time_now (vm);
1443
1444       deadline = now + BARRIER_SYNC_TIMEOUT;
1445
1446       while (*vlib_worker_threads->node_reforks_required > 0)
1447         {
1448           if ((now = vlib_time_now (vm)) > deadline)
1449             {
1450               fformat (stderr, "%s: worker thread refork deadlock\n",
1451                        __FUNCTION__);
1452               os_panic ();
1453             }
1454         }
1455       vlib_stats_segment_unlock ();
1456     }
1457
1458   t_closed_total = now - vm->barrier_epoch;
1459
1460   minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1461
1462   if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1463     {
1464       minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1465     }
1466
1467   vm->barrier_no_close_before = now + minimum_open;
1468
1469   /* Record barrier epoch (used to enforce minimum open time) */
1470   vm->barrier_epoch = now;
1471
1472   barrier_trace_release (t_entry, t_closed_total, t_update_main);
1473
1474   if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1475     clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1476                          vm->clib_time.last_cpu_time, 1 /* leave */ );
1477 }
1478
1479 static void
1480 vlib_worker_sync_rpc (void *args)
1481 {
1482   ASSERT (vlib_thread_is_main_w_barrier ());
1483   vlib_worker_threads->wait_before_barrier = 0;
1484 }
1485
1486 void
1487 vlib_workers_sync (void)
1488 {
1489   if (PREDICT_FALSE (!vlib_num_workers ()))
1490     return;
1491
1492   if (!(*vlib_worker_threads->wait_at_barrier) &&
1493       !clib_atomic_swap_rel_n (&vlib_worker_threads->wait_before_barrier, 1))
1494     {
1495       u32 thread_index = vlib_get_thread_index ();
1496       vlib_rpc_call_main_thread (vlib_worker_sync_rpc, (u8 *) &thread_index,
1497                                  sizeof (thread_index));
1498     }
1499
1500   /* Wait until main thread asks for barrier */
1501   while (!(*vlib_worker_threads->wait_at_barrier))
1502     ;
1503
1504   /* Stop before barrier and make sure all threads are either
1505    * at worker barrier or the barrier before it */
1506   clib_atomic_fetch_add (&vlib_worker_threads->workers_before_barrier, 1);
1507   while (vlib_num_workers () > (*vlib_worker_threads->workers_at_barrier +
1508                                 vlib_worker_threads->workers_before_barrier))
1509     ;
1510 }
1511
1512 void
1513 vlib_workers_continue (void)
1514 {
1515   if (PREDICT_FALSE (!vlib_num_workers ()))
1516     return;
1517
1518   clib_atomic_fetch_add (&vlib_worker_threads->done_work_before_barrier, 1);
1519
1520   /* Wait until all workers are done with work before barrier */
1521   while (vlib_worker_threads->done_work_before_barrier <
1522          vlib_worker_threads->workers_before_barrier)
1523     ;
1524
1525   clib_atomic_fetch_add (&vlib_worker_threads->done_work_before_barrier, -1);
1526   clib_atomic_fetch_add (&vlib_worker_threads->workers_before_barrier, -1);
1527 }
1528
1529 /**
1530  * Wait until each of the workers has been once around the track
1531  */
1532 void
1533 vlib_worker_wait_one_loop (void)
1534 {
1535   vlib_global_main_t *vgm = vlib_get_global_main ();
1536   ASSERT (vlib_get_thread_index () == 0);
1537
1538   if (vlib_get_n_threads () < 2)
1539     return;
1540
1541   if (vlib_worker_thread_barrier_held ())
1542     return;
1543
1544   u32 *counts = 0;
1545   u32 ii;
1546
1547   vec_validate (counts, vlib_get_n_threads () - 1);
1548
1549   /* record the current loop counts */
1550   vec_foreach_index (ii, vgm->vlib_mains)
1551     counts[ii] = vgm->vlib_mains[ii]->main_loop_count;
1552
1553   /* spin until each changes, apart from the main thread, or we'd be
1554    * a while */
1555   for (ii = 1; ii < vec_len (counts); ii++)
1556     {
1557       while (counts[ii] == vgm->vlib_mains[ii]->main_loop_count)
1558         CLIB_PAUSE ();
1559     }
1560
1561   vec_free (counts);
1562   return;
1563 }
1564
1565 void
1566 vlib_worker_thread_fn (void *arg)
1567 {
1568   vlib_global_main_t *vgm = vlib_get_global_main ();
1569   vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1570   vlib_main_t *vm = vlib_get_main ();
1571   clib_error_t *e;
1572
1573   ASSERT (vm->thread_index == vlib_get_thread_index ());
1574
1575   vlib_worker_thread_init (w);
1576   clib_time_init (&vm->clib_time);
1577   clib_mem_set_heap (w->thread_mheap);
1578
1579   vm->worker_init_functions_called = hash_create (0, 0);
1580
1581   e = vlib_call_init_exit_functions_no_sort (
1582     vm, &vgm->worker_init_function_registrations, 1 /* call_once */,
1583     0 /* is_global */);
1584   if (e)
1585     clib_error_report (e);
1586
1587   vlib_worker_loop (vm);
1588 }
1589
1590 /* *INDENT-OFF* */
1591 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1592   .name = "workers",
1593   .short_name = "wk",
1594   .function = vlib_worker_thread_fn,
1595 };
1596 /* *INDENT-ON* */
1597
1598 extern clib_march_fn_registration
1599   *vlib_frame_queue_dequeue_with_aux_fn_march_fn_registrations;
1600 extern clib_march_fn_registration
1601   *vlib_frame_queue_dequeue_fn_march_fn_registrations;
1602 u32
1603 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1604 {
1605   vlib_thread_main_t *tm = vlib_get_thread_main ();
1606   vlib_main_t *vm = vlib_get_main ();
1607   vlib_frame_queue_main_t *fqm;
1608   vlib_frame_queue_t *fq;
1609   vlib_node_t *node;
1610   int i;
1611   u32 num_threads;
1612
1613   if (frame_queue_nelts == 0)
1614     frame_queue_nelts = FRAME_QUEUE_MAX_NELTS;
1615
1616   num_threads = 1 /* main thread */  + tm->n_threads;
1617   ASSERT (frame_queue_nelts >= 8 + num_threads);
1618
1619   vec_add2 (tm->frame_queue_mains, fqm, 1);
1620
1621   node = vlib_get_node (vm, fqm->node_index);
1622   ASSERT (node);
1623   if (node->aux_offset)
1624     {
1625       fqm->frame_queue_dequeue_fn =
1626         CLIB_MARCH_FN_VOID_POINTER (vlib_frame_queue_dequeue_with_aux_fn);
1627     }
1628   else
1629     {
1630       fqm->frame_queue_dequeue_fn =
1631         CLIB_MARCH_FN_VOID_POINTER (vlib_frame_queue_dequeue_fn);
1632     }
1633
1634   fqm->node_index = node_index;
1635   fqm->frame_queue_nelts = frame_queue_nelts;
1636
1637   vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1638   vec_set_len (fqm->vlib_frame_queues, 0);
1639   for (i = 0; i < tm->n_vlib_mains; i++)
1640     {
1641       fq = vlib_frame_queue_alloc (frame_queue_nelts);
1642       vec_add1 (fqm->vlib_frame_queues, fq);
1643     }
1644
1645   return (fqm - tm->frame_queue_mains);
1646 }
1647
1648 void
1649 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1650                                      args)
1651 {
1652   ASSERT (vlib_get_thread_index () == 0);
1653   vlib_process_signal_event (vlib_get_main (), args->node_index,
1654                              args->type_opaque, args->data);
1655 }
1656
1657 void *rpc_call_main_thread_cb_fn;
1658
1659 void
1660 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1661 {
1662   if (rpc_call_main_thread_cb_fn)
1663     {
1664       void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1665       (*fp) (callback, args, arg_size);
1666     }
1667   else
1668     clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1669 }
1670
1671 clib_error_t *
1672 threads_init (vlib_main_t * vm)
1673 {
1674   const vlib_thread_main_t *tm = vlib_get_thread_main ();
1675
1676   if (tm->main_lcore == ~0 && tm->n_vlib_mains > 1)
1677     return clib_error_return (0, "Configuration error, a main core must "
1678                                  "be specified when using worker threads");
1679
1680   return 0;
1681 }
1682
1683 VLIB_INIT_FUNCTION (threads_init);
1684
1685 static clib_error_t *
1686 show_clock_command_fn (vlib_main_t * vm,
1687                        unformat_input_t * input, vlib_cli_command_t * cmd)
1688 {
1689   int verbose = 0;
1690   clib_timebase_t _tb, *tb = &_tb;
1691
1692   (void) unformat (input, "verbose %=", &verbose, 1);
1693
1694   clib_timebase_init (tb, 0 /* GMT */ , CLIB_TIMEBASE_DAYLIGHT_NONE,
1695                       &vm->clib_time);
1696
1697   vlib_cli_output (vm, "%U, %U GMT", format_clib_time, &vm->clib_time,
1698                    verbose, format_clib_timebase_time,
1699                    clib_timebase_now (tb));
1700
1701   vlib_cli_output (vm, "Time last barrier release %.9f",
1702                    vm->time_last_barrier_release);
1703
1704   foreach_vlib_main ()
1705     {
1706       vlib_cli_output (vm, "%d: %U", this_vlib_main->thread_index,
1707                        format_clib_time, &this_vlib_main->clib_time, verbose);
1708
1709       vlib_cli_output (vm, "Thread %d offset %.9f error %.9f",
1710                        this_vlib_main->thread_index,
1711                        this_vlib_main->time_offset,
1712                        vm->time_last_barrier_release -
1713                          this_vlib_main->time_last_barrier_release);
1714     }
1715   return 0;
1716 }
1717
1718 /* *INDENT-OFF* */
1719 VLIB_CLI_COMMAND (f_command, static) =
1720 {
1721   .path = "show clock",
1722   .short_help = "show clock",
1723   .function = show_clock_command_fn,
1724 };
1725 /* *INDENT-ON* */
1726
1727 vlib_thread_main_t *
1728 vlib_get_thread_main_not_inline (void)
1729 {
1730   return vlib_get_thread_main ();
1731 }
1732
1733 /*
1734  * fd.io coding-style-patch-verification: ON
1735  *
1736  * Local Variables:
1737  * eval: (c-set-style "gnu")
1738  * End:
1739  */