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