vlib: deprecate i2c and cj
[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   rv = (void *) clib_calljmp
585     ((uword (*)(uword)) w->thread_function,
586      (uword) arg, w->thread_stack + VLIB_THREAD_STACK_SIZE);
587   /* NOTREACHED, we hope */
588   return rv;
589 }
590
591 void
592 vlib_get_thread_core_numa (vlib_worker_thread_t * w, unsigned cpu_id)
593 {
594   const char *sys_cpu_path = "/sys/devices/system/cpu/cpu";
595   const char *sys_node_path = "/sys/devices/system/node/node";
596   clib_bitmap_t *nbmp = 0, *cbmp = 0;
597   u32 node;
598   u8 *p = 0;
599   int core_id = -1, numa_id = -1;
600
601   p = format (p, "%s%u/topology/core_id%c", sys_cpu_path, cpu_id, 0);
602   clib_sysfs_read ((char *) p, "%d", &core_id);
603   vec_reset_length (p);
604
605   /* *INDENT-OFF* */
606   clib_sysfs_read ("/sys/devices/system/node/online", "%U",
607         unformat_bitmap_list, &nbmp);
608   clib_bitmap_foreach (node, nbmp, ({
609     p = format (p, "%s%u/cpulist%c", sys_node_path, node, 0);
610     clib_sysfs_read ((char *) p, "%U", unformat_bitmap_list, &cbmp);
611     if (clib_bitmap_get (cbmp, cpu_id))
612       numa_id = node;
613     vec_reset_length (cbmp);
614     vec_reset_length (p);
615   }));
616   /* *INDENT-ON* */
617   vec_free (nbmp);
618   vec_free (cbmp);
619   vec_free (p);
620
621   w->core_id = core_id;
622   w->numa_id = numa_id;
623 }
624
625 static clib_error_t *
626 vlib_launch_thread_int (void *fp, vlib_worker_thread_t * w, unsigned cpu_id)
627 {
628   vlib_thread_main_t *tm = &vlib_thread_main;
629   void *(*fp_arg) (void *) = fp;
630   void *numa_heap;
631
632   w->cpu_id = cpu_id;
633   vlib_get_thread_core_numa (w, cpu_id);
634
635   /* Set up NUMA-bound heap if indicated */
636   if (clib_per_numa_mheaps[w->numa_id] == 0)
637     {
638       /* If the user requested a NUMA heap, create it... */
639       if (tm->numa_heap_size)
640         {
641           numa_heap = clib_mem_init_thread_safe_numa
642             (0 /* DIY */ , tm->numa_heap_size, w->numa_id);
643           clib_per_numa_mheaps[w->numa_id] = numa_heap;
644         }
645       else
646         {
647           /* Or, use the main heap */
648           clib_per_numa_mheaps[w->numa_id] = w->thread_mheap;
649         }
650     }
651
652   if (tm->cb.vlib_launch_thread_cb && !w->registration->use_pthreads)
653     return tm->cb.vlib_launch_thread_cb (fp, (void *) w, cpu_id);
654   else
655     {
656       pthread_t worker;
657       cpu_set_t cpuset;
658       CPU_ZERO (&cpuset);
659       CPU_SET (cpu_id, &cpuset);
660
661       if (pthread_create (&worker, NULL /* attr */ , fp_arg, (void *) w))
662         return clib_error_return_unix (0, "pthread_create");
663
664       if (pthread_setaffinity_np (worker, sizeof (cpu_set_t), &cpuset))
665         return clib_error_return_unix (0, "pthread_setaffinity_np");
666
667       return 0;
668     }
669 }
670
671 static clib_error_t *
672 start_workers (vlib_main_t * vm)
673 {
674   int i, j;
675   vlib_worker_thread_t *w;
676   vlib_main_t *vm_clone;
677   void *oldheap;
678   vlib_thread_main_t *tm = &vlib_thread_main;
679   vlib_thread_registration_t *tr;
680   vlib_node_runtime_t *rt;
681   u32 n_vlib_mains = tm->n_vlib_mains;
682   u32 worker_thread_index;
683   u8 *main_heap = clib_mem_get_per_cpu_heap ();
684
685   vec_reset_length (vlib_worker_threads);
686
687   /* Set up the main thread */
688   vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
689   w->elog_track.name = "main thread";
690   elog_track_register (&vm->elog_main, &w->elog_track);
691
692   if (vec_len (tm->thread_prefix))
693     {
694       w->name = format (0, "%v_main%c", tm->thread_prefix, '\0');
695       vlib_set_thread_name ((char *) w->name);
696     }
697
698   vm->elog_main.lock =
699     clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
700   vm->elog_main.lock[0] = 0;
701
702   if (n_vlib_mains > 1)
703     {
704       /* Replace hand-crafted length-1 vector with a real vector */
705       vlib_mains = 0;
706
707       vec_validate_aligned (vlib_mains, tm->n_vlib_mains - 1,
708                             CLIB_CACHE_LINE_BYTES);
709       _vec_len (vlib_mains) = 0;
710       vec_add1_aligned (vlib_mains, vm, CLIB_CACHE_LINE_BYTES);
711
712       vlib_worker_threads->wait_at_barrier =
713         clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
714       vlib_worker_threads->workers_at_barrier =
715         clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
716
717       vlib_worker_threads->node_reforks_required =
718         clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
719
720       /* We'll need the rpc vector lock... */
721       clib_spinlock_init (&vm->pending_rpc_lock);
722
723       /* Ask for an initial barrier sync */
724       *vlib_worker_threads->workers_at_barrier = 0;
725       *vlib_worker_threads->wait_at_barrier = 1;
726
727       /* Without update or refork */
728       *vlib_worker_threads->node_reforks_required = 0;
729       vm->need_vlib_worker_thread_node_runtime_update = 0;
730
731       /* init timing */
732       vm->barrier_epoch = 0;
733       vm->barrier_no_close_before = 0;
734
735       worker_thread_index = 1;
736
737       for (i = 0; i < vec_len (tm->registrations); i++)
738         {
739           vlib_node_main_t *nm, *nm_clone;
740           int k;
741
742           tr = tm->registrations[i];
743
744           if (tr->count == 0)
745             continue;
746
747           for (k = 0; k < tr->count; k++)
748             {
749               vlib_node_t *n;
750
751               vec_add2 (vlib_worker_threads, w, 1);
752               /* Currently unused, may not really work */
753               if (tr->mheap_size)
754                 w->thread_mheap = create_mspace (tr->mheap_size,
755                                                  0 /* unlocked */ );
756               else
757                 w->thread_mheap = main_heap;
758
759               w->thread_stack =
760                 vlib_thread_stack_init (w - vlib_worker_threads);
761               w->thread_function = tr->function;
762               w->thread_function_arg = w;
763               w->instance_id = k;
764               w->registration = tr;
765
766               w->elog_track.name =
767                 (char *) format (0, "%s %d", tr->name, k + 1);
768               vec_add1 (w->elog_track.name, 0);
769               elog_track_register (&vm->elog_main, &w->elog_track);
770
771               if (tr->no_data_structure_clone)
772                 continue;
773
774               /* Fork vlib_global_main et al. Look for bugs here */
775               oldheap = clib_mem_set_heap (w->thread_mheap);
776
777               vm_clone = clib_mem_alloc_aligned (sizeof (*vm_clone),
778                                                  CLIB_CACHE_LINE_BYTES);
779               clib_memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
780
781               vm_clone->thread_index = worker_thread_index;
782               vm_clone->heap_base = w->thread_mheap;
783               vm_clone->heap_aligned_base = (void *)
784                 (((uword) w->thread_mheap) & ~(VLIB_FRAME_ALIGN - 1));
785               vm_clone->init_functions_called =
786                 hash_create (0, /* value bytes */ 0);
787               vm_clone->pending_rpc_requests = 0;
788               vec_validate (vm_clone->pending_rpc_requests, 0);
789               _vec_len (vm_clone->pending_rpc_requests) = 0;
790               clib_memset (&vm_clone->random_buffer, 0,
791                            sizeof (vm_clone->random_buffer));
792
793               nm = &vlib_mains[0]->node_main;
794               nm_clone = &vm_clone->node_main;
795               /* fork next frames array, preserving node runtime indices */
796               nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
797                                                        CLIB_CACHE_LINE_BYTES);
798               for (j = 0; j < vec_len (nm_clone->next_frames); j++)
799                 {
800                   vlib_next_frame_t *nf = &nm_clone->next_frames[j];
801                   u32 save_node_runtime_index;
802                   u32 save_flags;
803
804                   save_node_runtime_index = nf->node_runtime_index;
805                   save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
806                   vlib_next_frame_init (nf);
807                   nf->node_runtime_index = save_node_runtime_index;
808                   nf->flags = save_flags;
809                 }
810
811               /* fork the frame dispatch queue */
812               nm_clone->pending_frames = 0;
813               vec_validate (nm_clone->pending_frames, 10);
814               _vec_len (nm_clone->pending_frames) = 0;
815
816               /* fork nodes */
817               nm_clone->nodes = 0;
818
819               /* Allocate all nodes in single block for speed */
820               n = clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*n));
821
822               for (j = 0; j < vec_len (nm->nodes); j++)
823                 {
824                   clib_memcpy (n, nm->nodes[j], sizeof (*n));
825                   /* none of the copied nodes have enqueue rights given out */
826                   n->owner_node_index = VLIB_INVALID_NODE_INDEX;
827                   clib_memset (&n->stats_total, 0, sizeof (n->stats_total));
828                   clib_memset (&n->stats_last_clear, 0,
829                                sizeof (n->stats_last_clear));
830                   vec_add1 (nm_clone->nodes, n);
831                   n++;
832                 }
833               nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
834                 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
835                                  CLIB_CACHE_LINE_BYTES);
836               vec_foreach (rt,
837                            nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
838               {
839                 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
840                 rt->thread_index = vm_clone->thread_index;
841                 /* copy initial runtime_data from node */
842                 if (n->runtime_data && n->runtime_data_bytes > 0)
843                   clib_memcpy (rt->runtime_data, n->runtime_data,
844                                clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
845                                          n->runtime_data_bytes));
846               }
847
848               nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
849                 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
850                                  CLIB_CACHE_LINE_BYTES);
851               vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
852               {
853                 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
854                 rt->thread_index = vm_clone->thread_index;
855                 /* copy initial runtime_data from node */
856                 if (n->runtime_data && n->runtime_data_bytes > 0)
857                   clib_memcpy (rt->runtime_data, n->runtime_data,
858                                clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
859                                          n->runtime_data_bytes));
860               }
861
862               nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
863                 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
864                                  CLIB_CACHE_LINE_BYTES);
865               vec_foreach (rt,
866                            nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
867               {
868                 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
869                 rt->thread_index = vm_clone->thread_index;
870                 /* copy initial runtime_data from node */
871                 if (n->runtime_data && n->runtime_data_bytes > 0)
872                   clib_memcpy (rt->runtime_data, n->runtime_data,
873                                clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
874                                          n->runtime_data_bytes));
875               }
876
877               nm_clone->processes = vec_dup_aligned (nm->processes,
878                                                      CLIB_CACHE_LINE_BYTES);
879
880               /* Create per-thread frame freelist */
881               nm_clone->frame_sizes = vec_new (vlib_frame_size_t, 1);
882 #ifdef VLIB_SUPPORTS_ARBITRARY_SCALAR_SIZES
883               nm_clone->frame_size_hash = hash_create (0, sizeof (uword));
884 #endif
885               nm_clone->node_by_error = nm->node_by_error;
886
887               /* Packet trace buffers are guaranteed to be empty, nothing to do here */
888
889               clib_mem_set_heap (oldheap);
890               vec_add1_aligned (vlib_mains, vm_clone, CLIB_CACHE_LINE_BYTES);
891
892               /* Switch to the stats segment ... */
893               void *oldheap = vlib_stats_push_heap (0);
894               vm_clone->error_main.counters = vec_dup_aligned
895                 (vlib_mains[0]->error_main.counters, CLIB_CACHE_LINE_BYTES);
896               vlib_stats_pop_heap2 (vm_clone->error_main.counters,
897                                     worker_thread_index, oldheap, 1);
898
899               vm_clone->error_main.counters_last_clear = vec_dup_aligned
900                 (vlib_mains[0]->error_main.counters_last_clear,
901                  CLIB_CACHE_LINE_BYTES);
902
903               worker_thread_index++;
904             }
905         }
906     }
907   else
908     {
909       /* only have non-data-structure copy threads to create... */
910       for (i = 0; i < vec_len (tm->registrations); i++)
911         {
912           tr = tm->registrations[i];
913
914           for (j = 0; j < tr->count; j++)
915             {
916               vec_add2 (vlib_worker_threads, w, 1);
917               if (tr->mheap_size)
918                 {
919                   w->thread_mheap =
920                     create_mspace (tr->mheap_size, 0 /* locked */ );
921                 }
922               else
923                 w->thread_mheap = main_heap;
924               w->thread_stack =
925                 vlib_thread_stack_init (w - vlib_worker_threads);
926               w->thread_function = tr->function;
927               w->thread_function_arg = w;
928               w->instance_id = j;
929               w->elog_track.name =
930                 (char *) format (0, "%s %d", tr->name, j + 1);
931               w->registration = tr;
932               vec_add1 (w->elog_track.name, 0);
933               elog_track_register (&vm->elog_main, &w->elog_track);
934             }
935         }
936     }
937
938   worker_thread_index = 1;
939
940   for (i = 0; i < vec_len (tm->registrations); i++)
941     {
942       clib_error_t *err;
943       int j;
944
945       tr = tm->registrations[i];
946
947       if (tr->use_pthreads || tm->use_pthreads)
948         {
949           for (j = 0; j < tr->count; j++)
950             {
951               w = vlib_worker_threads + worker_thread_index++;
952               err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
953                                             w, 0);
954               if (err)
955                 clib_error_report (err);
956             }
957         }
958       else
959         {
960           uword c;
961           /* *INDENT-OFF* */
962           clib_bitmap_foreach (c, tr->coremask, ({
963             w = vlib_worker_threads + worker_thread_index++;
964             err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
965                                           w, c);
966             if (err)
967               clib_error_report (err);
968           }));
969           /* *INDENT-ON* */
970         }
971     }
972   vlib_worker_thread_barrier_sync (vm);
973   vlib_worker_thread_barrier_release (vm);
974   return 0;
975 }
976
977 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
978
979
980 static inline void
981 worker_thread_node_runtime_update_internal (void)
982 {
983   int i, j;
984   vlib_main_t *vm;
985   vlib_node_main_t *nm, *nm_clone;
986   vlib_main_t *vm_clone;
987   vlib_node_runtime_t *rt;
988   never_inline void
989     vlib_node_runtime_sync_stats (vlib_main_t * vm,
990                                   vlib_node_runtime_t * r,
991                                   uword n_calls,
992                                   uword n_vectors, uword n_clocks);
993
994   ASSERT (vlib_get_thread_index () == 0);
995
996   vm = vlib_mains[0];
997   nm = &vm->node_main;
998
999   ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
1000
1001   /*
1002    * Scrape all runtime stats, so we don't lose node runtime(s) with
1003    * pending counts, or throw away worker / io thread counts.
1004    */
1005   for (j = 0; j < vec_len (nm->nodes); j++)
1006     {
1007       vlib_node_t *n;
1008       n = nm->nodes[j];
1009       vlib_node_sync_stats (vm, n);
1010     }
1011
1012   for (i = 1; i < vec_len (vlib_mains); i++)
1013     {
1014       vlib_node_t *n;
1015
1016       vm_clone = vlib_mains[i];
1017       nm_clone = &vm_clone->node_main;
1018
1019       for (j = 0; j < vec_len (nm_clone->nodes); j++)
1020         {
1021           n = nm_clone->nodes[j];
1022
1023           rt = vlib_node_get_runtime (vm_clone, n->index);
1024           vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
1025         }
1026     }
1027
1028   /* Per-worker clone rebuilds are now done on each thread */
1029 }
1030
1031
1032 void
1033 vlib_worker_thread_node_refork (void)
1034 {
1035   vlib_main_t *vm, *vm_clone;
1036   vlib_node_main_t *nm, *nm_clone;
1037   vlib_node_t **old_nodes_clone;
1038   vlib_node_runtime_t *rt, *old_rt;
1039
1040   vlib_node_t *new_n_clone;
1041
1042   int j;
1043
1044   vm = vlib_mains[0];
1045   nm = &vm->node_main;
1046   vm_clone = vlib_get_main ();
1047   nm_clone = &vm_clone->node_main;
1048
1049   /* Re-clone error heap */
1050   u64 *old_counters = vm_clone->error_main.counters;
1051   u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
1052
1053   clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
1054                     sizeof (vm->error_main));
1055   j = vec_len (vm->error_main.counters) - 1;
1056
1057   /* Switch to the stats segment ... */
1058   void *oldheap = vlib_stats_push_heap (0);
1059   vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
1060   vm_clone->error_main.counters = old_counters;
1061   vlib_stats_pop_heap2 (vm_clone->error_main.counters, vm_clone->thread_index,
1062                         oldheap, 0);
1063
1064   vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
1065   vm_clone->error_main.counters_last_clear = old_counters_all_clear;
1066
1067   nm_clone = &vm_clone->node_main;
1068   vec_free (nm_clone->next_frames);
1069   nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
1070                                            CLIB_CACHE_LINE_BYTES);
1071
1072   for (j = 0; j < vec_len (nm_clone->next_frames); j++)
1073     {
1074       vlib_next_frame_t *nf = &nm_clone->next_frames[j];
1075       u32 save_node_runtime_index;
1076       u32 save_flags;
1077
1078       save_node_runtime_index = nf->node_runtime_index;
1079       save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
1080       vlib_next_frame_init (nf);
1081       nf->node_runtime_index = save_node_runtime_index;
1082       nf->flags = save_flags;
1083     }
1084
1085   old_nodes_clone = nm_clone->nodes;
1086   nm_clone->nodes = 0;
1087
1088   /* re-fork nodes */
1089
1090   /* Allocate all nodes in single block for speed */
1091   new_n_clone =
1092     clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
1093   for (j = 0; j < vec_len (nm->nodes); j++)
1094     {
1095       vlib_node_t *new_n = nm->nodes[j];
1096
1097       clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
1098       /* none of the copied nodes have enqueue rights given out */
1099       new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
1100
1101       if (j >= vec_len (old_nodes_clone))
1102         {
1103           /* new node, set to zero */
1104           clib_memset (&new_n_clone->stats_total, 0,
1105                        sizeof (new_n_clone->stats_total));
1106           clib_memset (&new_n_clone->stats_last_clear, 0,
1107                        sizeof (new_n_clone->stats_last_clear));
1108         }
1109       else
1110         {
1111           vlib_node_t *old_n_clone = old_nodes_clone[j];
1112           /* Copy stats if the old data is valid */
1113           clib_memcpy_fast (&new_n_clone->stats_total,
1114                             &old_n_clone->stats_total,
1115                             sizeof (new_n_clone->stats_total));
1116           clib_memcpy_fast (&new_n_clone->stats_last_clear,
1117                             &old_n_clone->stats_last_clear,
1118                             sizeof (new_n_clone->stats_last_clear));
1119
1120           /* keep previous node state */
1121           new_n_clone->state = old_n_clone->state;
1122         }
1123       vec_add1 (nm_clone->nodes, new_n_clone);
1124       new_n_clone++;
1125     }
1126   /* Free the old node clones */
1127   clib_mem_free (old_nodes_clone[0]);
1128
1129   vec_free (old_nodes_clone);
1130
1131
1132   /* re-clone internal nodes */
1133   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
1134   nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
1135     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1136                      CLIB_CACHE_LINE_BYTES);
1137
1138   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
1139   {
1140     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1141     rt->thread_index = vm_clone->thread_index;
1142     /* copy runtime_data, will be overwritten later for existing rt */
1143     if (n->runtime_data && n->runtime_data_bytes > 0)
1144       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1145                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1146                                   n->runtime_data_bytes));
1147   }
1148
1149   for (j = 0; j < vec_len (old_rt); j++)
1150     {
1151       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1152       rt->state = old_rt[j].state;
1153       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1154                         VLIB_NODE_RUNTIME_DATA_SIZE);
1155     }
1156
1157   vec_free (old_rt);
1158
1159   /* re-clone input nodes */
1160   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1161   nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1162     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1163                      CLIB_CACHE_LINE_BYTES);
1164
1165   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1166   {
1167     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1168     rt->thread_index = vm_clone->thread_index;
1169     /* copy runtime_data, will be overwritten later for existing rt */
1170     if (n->runtime_data && n->runtime_data_bytes > 0)
1171       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1172                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1173                                   n->runtime_data_bytes));
1174   }
1175
1176   for (j = 0; j < vec_len (old_rt); j++)
1177     {
1178       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1179       rt->state = old_rt[j].state;
1180       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1181                         VLIB_NODE_RUNTIME_DATA_SIZE);
1182     }
1183
1184   vec_free (old_rt);
1185
1186   /* re-clone pre-input nodes */
1187   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT];
1188   nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
1189     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
1190                      CLIB_CACHE_LINE_BYTES);
1191
1192   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1193   {
1194     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1195     rt->thread_index = vm_clone->thread_index;
1196     /* copy runtime_data, will be overwritten later for existing rt */
1197     if (n->runtime_data && n->runtime_data_bytes > 0)
1198       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1199                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1200                                   n->runtime_data_bytes));
1201   }
1202
1203   for (j = 0; j < vec_len (old_rt); j++)
1204     {
1205       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1206       rt->state = old_rt[j].state;
1207       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1208                         VLIB_NODE_RUNTIME_DATA_SIZE);
1209     }
1210
1211   vec_free (old_rt);
1212
1213   nm_clone->processes = vec_dup_aligned (nm->processes,
1214                                          CLIB_CACHE_LINE_BYTES);
1215   nm_clone->node_by_error = nm->node_by_error;
1216 }
1217
1218 void
1219 vlib_worker_thread_node_runtime_update (void)
1220 {
1221   /*
1222    * Make a note that we need to do a node runtime update
1223    * prior to releasing the barrier.
1224    */
1225   vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1226 }
1227
1228 u32
1229 unformat_sched_policy (unformat_input_t * input, va_list * args)
1230 {
1231   u32 *r = va_arg (*args, u32 *);
1232
1233   if (0);
1234 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1235   foreach_sched_policy
1236 #undef _
1237     else
1238     return 0;
1239   return 1;
1240 }
1241
1242 static clib_error_t *
1243 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1244 {
1245   vlib_thread_registration_t *tr;
1246   uword *p;
1247   vlib_thread_main_t *tm = &vlib_thread_main;
1248   u8 *name;
1249   uword *bitmap;
1250   u32 count;
1251
1252   tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1253
1254   tm->n_thread_stacks = 1;      /* account for main thread */
1255   tm->sched_policy = ~0;
1256   tm->sched_priority = ~0;
1257   tm->main_lcore = ~0;
1258
1259   tr = tm->next;
1260
1261   while (tr)
1262     {
1263       hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1264       tr = tr->next;
1265     }
1266
1267   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1268     {
1269       if (unformat (input, "use-pthreads"))
1270         tm->use_pthreads = 1;
1271       else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1272         ;
1273       else if (unformat (input, "main-core %u", &tm->main_lcore))
1274         ;
1275       else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1276         ;
1277       else if (unformat (input, "numa-heap-size %U",
1278                          unformat_memory_size, &tm->numa_heap_size))
1279         ;
1280       else if (unformat (input, "coremask-%s %U", &name,
1281                          unformat_bitmap_mask, &bitmap) ||
1282                unformat (input, "corelist-%s %U", &name,
1283                          unformat_bitmap_list, &bitmap))
1284         {
1285           p = hash_get_mem (tm->thread_registrations_by_name, name);
1286           if (p == 0)
1287             return clib_error_return (0, "no such thread type '%s'", name);
1288
1289           tr = (vlib_thread_registration_t *) p[0];
1290
1291           if (tr->use_pthreads)
1292             return clib_error_return (0,
1293                                       "corelist cannot be set for '%s' threads",
1294                                       name);
1295           if (tr->count)
1296             return clib_error_return
1297               (0, "core placement of '%s' threads is already configured",
1298                name);
1299
1300           tr->coremask = bitmap;
1301           tr->count = clib_bitmap_count_set_bits (tr->coremask);
1302         }
1303       else
1304         if (unformat
1305             (input, "scheduler-policy %U", unformat_sched_policy,
1306              &tm->sched_policy))
1307         ;
1308       else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1309         ;
1310       else if (unformat (input, "%s %u", &name, &count))
1311         {
1312           p = hash_get_mem (tm->thread_registrations_by_name, name);
1313           if (p == 0)
1314             return clib_error_return (0, "no such thread type 3 '%s'", name);
1315
1316           tr = (vlib_thread_registration_t *) p[0];
1317
1318           if (tr->fixed_count)
1319             return clib_error_return
1320               (0, "number of '%s' threads not configurable", name);
1321           if (tr->count)
1322             return clib_error_return
1323               (0, "number of '%s' threads is already configured", name);
1324
1325           tr->count = count;
1326         }
1327       else
1328         break;
1329     }
1330
1331   if (tm->sched_priority != ~0)
1332     {
1333       if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1334         {
1335           u32 prio_max = sched_get_priority_max (tm->sched_policy);
1336           u32 prio_min = sched_get_priority_min (tm->sched_policy);
1337           if (tm->sched_priority > prio_max)
1338             tm->sched_priority = prio_max;
1339           if (tm->sched_priority < prio_min)
1340             tm->sched_priority = prio_min;
1341         }
1342       else
1343         {
1344           return clib_error_return
1345             (0,
1346              "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1347              tm->sched_priority);
1348         }
1349     }
1350   tr = tm->next;
1351
1352   if (!tm->thread_prefix)
1353     tm->thread_prefix = format (0, "vpp");
1354
1355   while (tr)
1356     {
1357       tm->n_thread_stacks += tr->count;
1358       tm->n_pthreads += tr->count * tr->use_pthreads;
1359       tm->n_threads += tr->count * (tr->use_pthreads == 0);
1360       tr = tr->next;
1361     }
1362
1363   return 0;
1364 }
1365
1366 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1367
1368 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1369 void
1370 vnet_main_fixup (vlib_fork_fixup_t which)
1371 {
1372 }
1373
1374 void
1375 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1376 {
1377   vlib_main_t *vm = vlib_get_main ();
1378
1379   if (vlib_mains == 0)
1380     return;
1381
1382   ASSERT (vlib_get_thread_index () == 0);
1383   vlib_worker_thread_barrier_sync (vm);
1384
1385   switch (which)
1386     {
1387     case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1388       vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1389       break;
1390
1391     default:
1392       ASSERT (0);
1393     }
1394   vlib_worker_thread_barrier_release (vm);
1395 }
1396
1397   /*
1398    * Enforce minimum open time to minimize packet loss due to Rx overflow,
1399    * based on a test based heuristic that barrier should be open for at least
1400    * 3 time as long as it is closed (with an upper bound of 1ms because by that
1401    *  point it is probably too late to make a difference)
1402    */
1403
1404 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1405 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1406 #endif
1407
1408 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1409 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1410 #endif
1411
1412 void
1413 vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm)
1414 {
1415   f64 deadline;
1416   f64 now = vlib_time_now (vm);
1417   u32 count = vec_len (vlib_mains) - 1;
1418
1419   /* No worker threads? */
1420   if (count == 0)
1421     return;
1422
1423   deadline = now + BARRIER_SYNC_TIMEOUT;
1424   *vlib_worker_threads->wait_at_barrier = 1;
1425   while (*vlib_worker_threads->workers_at_barrier != count)
1426     {
1427       if ((now = vlib_time_now (vm)) > deadline)
1428         {
1429           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1430           os_panic ();
1431         }
1432       CLIB_PAUSE ();
1433     }
1434   *vlib_worker_threads->wait_at_barrier = 0;
1435 }
1436
1437 void
1438 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm, const char *func_name)
1439 {
1440   f64 deadline;
1441   f64 now;
1442   f64 t_entry;
1443   f64 t_open;
1444   f64 t_closed;
1445   f64 max_vector_rate;
1446   u32 count;
1447   int i;
1448
1449   if (vec_len (vlib_mains) < 2)
1450     return;
1451
1452   ASSERT (vlib_get_thread_index () == 0);
1453
1454   vlib_worker_threads[0].barrier_caller = func_name;
1455   count = vec_len (vlib_mains) - 1;
1456
1457   /* Record entry relative to last close */
1458   now = vlib_time_now (vm);
1459   t_entry = now - vm->barrier_epoch;
1460
1461   /* Tolerate recursive calls */
1462   if (++vlib_worker_threads[0].recursion_level > 1)
1463     {
1464       barrier_trace_sync_rec (t_entry);
1465       return;
1466     }
1467
1468   /*
1469    * Need data to decide if we're working hard enough to honor
1470    * the barrier hold-down timer.
1471    */
1472   max_vector_rate = 0.0;
1473   for (i = 1; i < vec_len (vlib_mains); i++)
1474     max_vector_rate =
1475       clib_max (max_vector_rate,
1476                 (f64) vlib_last_vectors_per_main_loop (vlib_mains[i]));
1477
1478   vlib_worker_threads[0].barrier_sync_count++;
1479
1480   /* Enforce minimum barrier open time to minimize packet loss */
1481   ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1482
1483   /*
1484    * If any worker thread seems busy, which we define
1485    * as a vector rate above 10, we enforce the barrier hold-down timer
1486    */
1487   if (max_vector_rate > 10.0)
1488     {
1489       while (1)
1490         {
1491           now = vlib_time_now (vm);
1492           /* Barrier hold-down timer expired? */
1493           if (now >= vm->barrier_no_close_before)
1494             break;
1495           if ((vm->barrier_no_close_before - now)
1496               > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1497             {
1498               clib_warning
1499                 ("clock change: would have waited for %.4f seconds",
1500                  (vm->barrier_no_close_before - now));
1501               break;
1502             }
1503         }
1504     }
1505   /* Record time of closure */
1506   t_open = now - vm->barrier_epoch;
1507   vm->barrier_epoch = now;
1508
1509   deadline = now + BARRIER_SYNC_TIMEOUT;
1510
1511   *vlib_worker_threads->wait_at_barrier = 1;
1512   while (*vlib_worker_threads->workers_at_barrier != count)
1513     {
1514       if ((now = vlib_time_now (vm)) > deadline)
1515         {
1516           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1517           os_panic ();
1518         }
1519     }
1520
1521   t_closed = now - vm->barrier_epoch;
1522
1523   barrier_trace_sync (t_entry, t_open, t_closed);
1524
1525 }
1526
1527 void
1528 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1529 {
1530   f64 deadline;
1531   f64 now;
1532   f64 minimum_open;
1533   f64 t_entry;
1534   f64 t_closed_total;
1535   f64 t_update_main = 0.0;
1536   int refork_needed = 0;
1537
1538   if (vec_len (vlib_mains) < 2)
1539     return;
1540
1541   ASSERT (vlib_get_thread_index () == 0);
1542
1543
1544   now = vlib_time_now (vm);
1545   t_entry = now - vm->barrier_epoch;
1546
1547   if (--vlib_worker_threads[0].recursion_level > 0)
1548     {
1549       barrier_trace_release_rec (t_entry);
1550       return;
1551     }
1552
1553   /* Update (all) node runtimes before releasing the barrier, if needed */
1554   if (vm->need_vlib_worker_thread_node_runtime_update)
1555     {
1556       /*
1557        * Lock stat segment here, so we's safe when
1558        * rebuilding the stat segment node clones from the
1559        * stat thread...
1560        */
1561       vlib_stat_segment_lock ();
1562
1563       /* Do stats elements on main thread */
1564       worker_thread_node_runtime_update_internal ();
1565       vm->need_vlib_worker_thread_node_runtime_update = 0;
1566
1567       /* Do per thread rebuilds in parallel */
1568       refork_needed = 1;
1569       clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1570                              (vec_len (vlib_mains) - 1));
1571       now = vlib_time_now (vm);
1572       t_update_main = now - vm->barrier_epoch;
1573     }
1574
1575   deadline = now + BARRIER_SYNC_TIMEOUT;
1576
1577   /*
1578    * Note when we let go of the barrier.
1579    * Workers can use this to derive a reasonably accurate
1580    * time offset. See vlib_time_now(...)
1581    */
1582   vm->time_last_barrier_release = vlib_time_now (vm);
1583   CLIB_MEMORY_STORE_BARRIER ();
1584
1585   *vlib_worker_threads->wait_at_barrier = 0;
1586
1587   while (*vlib_worker_threads->workers_at_barrier > 0)
1588     {
1589       if ((now = vlib_time_now (vm)) > deadline)
1590         {
1591           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1592           os_panic ();
1593         }
1594     }
1595
1596   /* Wait for reforks before continuing */
1597   if (refork_needed)
1598     {
1599       now = vlib_time_now (vm);
1600
1601       deadline = now + BARRIER_SYNC_TIMEOUT;
1602
1603       while (*vlib_worker_threads->node_reforks_required > 0)
1604         {
1605           if ((now = vlib_time_now (vm)) > deadline)
1606             {
1607               fformat (stderr, "%s: worker thread refork deadlock\n",
1608                        __FUNCTION__);
1609               os_panic ();
1610             }
1611         }
1612       vlib_stat_segment_unlock ();
1613     }
1614
1615   t_closed_total = now - vm->barrier_epoch;
1616
1617   minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1618
1619   if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1620     {
1621       minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1622     }
1623
1624   vm->barrier_no_close_before = now + minimum_open;
1625
1626   /* Record barrier epoch (used to enforce minimum open time) */
1627   vm->barrier_epoch = now;
1628
1629   barrier_trace_release (t_entry, t_closed_total, t_update_main);
1630
1631 }
1632
1633 /*
1634  * Check the frame queue to see if any frames are available.
1635  * If so, pull the packets off the frames and put them to
1636  * the handoff node.
1637  */
1638 int
1639 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm)
1640 {
1641   u32 thread_id = vm->thread_index;
1642   vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1643   vlib_frame_queue_elt_t *elt;
1644   u32 *from, *to;
1645   vlib_frame_t *f;
1646   int msg_type;
1647   int processed = 0;
1648   u32 n_left_to_node;
1649   u32 vectors = 0;
1650
1651   ASSERT (fq);
1652   ASSERT (vm == vlib_mains[thread_id]);
1653
1654   if (PREDICT_FALSE (fqm->node_index == ~0))
1655     return 0;
1656   /*
1657    * Gather trace data for frame queues
1658    */
1659   if (PREDICT_FALSE (fq->trace))
1660     {
1661       frame_queue_trace_t *fqt;
1662       frame_queue_nelt_counter_t *fqh;
1663       u32 elix;
1664
1665       fqt = &fqm->frame_queue_traces[thread_id];
1666
1667       fqt->nelts = fq->nelts;
1668       fqt->head = fq->head;
1669       fqt->head_hint = fq->head_hint;
1670       fqt->tail = fq->tail;
1671       fqt->threshold = fq->vector_threshold;
1672       fqt->n_in_use = fqt->tail - fqt->head;
1673       if (fqt->n_in_use >= fqt->nelts)
1674         {
1675           // if beyond max then use max
1676           fqt->n_in_use = fqt->nelts - 1;
1677         }
1678
1679       /* Record the number of elements in use in the histogram */
1680       fqh = &fqm->frame_queue_histogram[thread_id];
1681       fqh->count[fqt->n_in_use]++;
1682
1683       /* Record a snapshot of the elements in use */
1684       for (elix = 0; elix < fqt->nelts; elix++)
1685         {
1686           elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1687           if (1 || elt->valid)
1688             {
1689               fqt->n_vectors[elix] = elt->n_vectors;
1690             }
1691         }
1692       fqt->written = 1;
1693     }
1694
1695   while (1)
1696     {
1697       vlib_buffer_t *b;
1698       if (fq->head == fq->tail)
1699         {
1700           fq->head_hint = fq->head;
1701           return processed;
1702         }
1703
1704       elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1705
1706       if (!elt->valid)
1707         {
1708           fq->head_hint = fq->head;
1709           return processed;
1710         }
1711
1712       from = elt->buffer_index;
1713       msg_type = elt->msg_type;
1714
1715       ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1716       ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1717
1718       f = vlib_get_frame_to_node (vm, fqm->node_index);
1719
1720       /* If the first vector is traced, set the frame trace flag */
1721       b = vlib_get_buffer (vm, from[0]);
1722       if (b->flags & VLIB_BUFFER_IS_TRACED)
1723         f->frame_flags |= VLIB_NODE_FLAG_TRACE;
1724
1725       to = vlib_frame_vector_args (f);
1726
1727       n_left_to_node = elt->n_vectors;
1728
1729       while (n_left_to_node >= 4)
1730         {
1731           to[0] = from[0];
1732           to[1] = from[1];
1733           to[2] = from[2];
1734           to[3] = from[3];
1735           to += 4;
1736           from += 4;
1737           n_left_to_node -= 4;
1738         }
1739
1740       while (n_left_to_node > 0)
1741         {
1742           to[0] = from[0];
1743           to++;
1744           from++;
1745           n_left_to_node--;
1746         }
1747
1748       vectors += elt->n_vectors;
1749       f->n_vectors = elt->n_vectors;
1750       vlib_put_frame_to_node (vm, fqm->node_index, f);
1751
1752       elt->valid = 0;
1753       elt->n_vectors = 0;
1754       elt->msg_type = 0xfefefefe;
1755       CLIB_MEMORY_BARRIER ();
1756       fq->head++;
1757       processed++;
1758
1759       /*
1760        * Limit the number of packets pushed into the graph
1761        */
1762       if (vectors >= fq->vector_threshold)
1763         {
1764           fq->head_hint = fq->head;
1765           return processed;
1766         }
1767     }
1768   ASSERT (0);
1769   return processed;
1770 }
1771
1772 void
1773 vlib_worker_thread_fn (void *arg)
1774 {
1775   vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1776   vlib_thread_main_t *tm = vlib_get_thread_main ();
1777   vlib_main_t *vm = vlib_get_main ();
1778   clib_error_t *e;
1779
1780   ASSERT (vm->thread_index == vlib_get_thread_index ());
1781
1782   vlib_worker_thread_init (w);
1783   clib_time_init (&vm->clib_time);
1784   clib_mem_set_heap (w->thread_mheap);
1785
1786   e = vlib_call_init_exit_functions_no_sort
1787     (vm, &vm->worker_init_function_registrations, 1 /* call_once */ );
1788   if (e)
1789     clib_error_report (e);
1790
1791   /* Wait until the dpdk init sequence is complete */
1792   while (tm->extern_thread_mgmt && tm->worker_thread_release == 0)
1793     vlib_worker_thread_barrier_check ();
1794
1795   vlib_worker_loop (vm);
1796 }
1797
1798 /* *INDENT-OFF* */
1799 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1800   .name = "workers",
1801   .short_name = "wk",
1802   .function = vlib_worker_thread_fn,
1803 };
1804 /* *INDENT-ON* */
1805
1806 u32
1807 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1808 {
1809   vlib_thread_main_t *tm = vlib_get_thread_main ();
1810   vlib_frame_queue_main_t *fqm;
1811   vlib_frame_queue_t *fq;
1812   int i;
1813   u32 num_threads;
1814
1815   if (frame_queue_nelts == 0)
1816     frame_queue_nelts = FRAME_QUEUE_MAX_NELTS;
1817
1818   num_threads = 1 /* main thread */  + tm->n_threads;
1819   ASSERT (frame_queue_nelts >= 8 + num_threads);
1820
1821   vec_add2 (tm->frame_queue_mains, fqm, 1);
1822
1823   fqm->node_index = node_index;
1824   fqm->frame_queue_nelts = frame_queue_nelts;
1825   fqm->queue_hi_thresh = frame_queue_nelts - num_threads;
1826
1827   vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1828   vec_validate (fqm->per_thread_data, tm->n_vlib_mains - 1);
1829   _vec_len (fqm->vlib_frame_queues) = 0;
1830   for (i = 0; i < tm->n_vlib_mains; i++)
1831     {
1832       vlib_frame_queue_per_thread_data_t *ptd;
1833       fq = vlib_frame_queue_alloc (frame_queue_nelts);
1834       vec_add1 (fqm->vlib_frame_queues, fq);
1835
1836       ptd = vec_elt_at_index (fqm->per_thread_data, i);
1837       vec_validate (ptd->handoff_queue_elt_by_thread_index,
1838                     tm->n_vlib_mains - 1);
1839       vec_validate_init_empty (ptd->congested_handoff_queue_by_thread_index,
1840                                tm->n_vlib_mains - 1,
1841                                (vlib_frame_queue_t *) (~0));
1842     }
1843
1844   return (fqm - tm->frame_queue_mains);
1845 }
1846
1847 int
1848 vlib_thread_cb_register (struct vlib_main_t *vm, vlib_thread_callbacks_t * cb)
1849 {
1850   vlib_thread_main_t *tm = vlib_get_thread_main ();
1851
1852   if (tm->extern_thread_mgmt)
1853     return -1;
1854
1855   tm->cb.vlib_launch_thread_cb = cb->vlib_launch_thread_cb;
1856   tm->extern_thread_mgmt = 1;
1857   return 0;
1858 }
1859
1860 void
1861 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1862                                      args)
1863 {
1864   ASSERT (vlib_get_thread_index () == 0);
1865   vlib_process_signal_event (vlib_get_main (), args->node_index,
1866                              args->type_opaque, args->data);
1867 }
1868
1869 void *rpc_call_main_thread_cb_fn;
1870
1871 void
1872 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1873 {
1874   if (rpc_call_main_thread_cb_fn)
1875     {
1876       void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1877       (*fp) (callback, args, arg_size);
1878     }
1879   else
1880     clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1881 }
1882
1883 clib_error_t *
1884 threads_init (vlib_main_t * vm)
1885 {
1886   return 0;
1887 }
1888
1889 VLIB_INIT_FUNCTION (threads_init);
1890
1891
1892 static clib_error_t *
1893 show_clock_command_fn (vlib_main_t * vm,
1894                        unformat_input_t * input, vlib_cli_command_t * cmd)
1895 {
1896   int i;
1897   int verbose = 0;
1898   clib_timebase_t _tb, *tb = &_tb;
1899
1900   (void) unformat (input, "verbose %=", &verbose, 1);
1901
1902   clib_timebase_init (tb, 0 /* GMT */ , CLIB_TIMEBASE_DAYLIGHT_NONE,
1903                       &vm->clib_time);
1904
1905   vlib_cli_output (vm, "%U, %U GMT", format_clib_time, &vm->clib_time,
1906                    verbose, format_clib_timebase_time,
1907                    clib_timebase_now (tb));
1908
1909   if (vec_len (vlib_mains) == 1)
1910     return 0;
1911
1912   vlib_cli_output (vm, "Time last barrier release %.9f",
1913                    vm->time_last_barrier_release);
1914
1915   for (i = 1; i < vec_len (vlib_mains); i++)
1916     {
1917       if (vlib_mains[i] == 0)
1918         continue;
1919
1920       vlib_cli_output (vm, "%d: %U", i, format_clib_time,
1921                        &vlib_mains[i]->clib_time, verbose);
1922
1923       vlib_cli_output (vm, "Thread %d offset %.9f error %.9f", i,
1924                        vlib_mains[i]->time_offset,
1925                        vm->time_last_barrier_release -
1926                        vlib_mains[i]->time_last_barrier_release);
1927     }
1928   return 0;
1929 }
1930
1931 /* *INDENT-OFF* */
1932 VLIB_CLI_COMMAND (f_command, static) =
1933 {
1934   .path = "show clock",
1935   .short_help = "show clock",
1936   .function = show_clock_command_fn,
1937 };
1938 /* *INDENT-ON* */
1939
1940 /*
1941  * fd.io coding-style-patch-verification: ON
1942  *
1943  * Local Variables:
1944  * eval: (c-set-style "gnu")
1945  * End:
1946  */