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