src/vlib/threads.c

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