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