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