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                 /* copy initial runtime_data from node */
 685                 if (n->runtime_data && n->runtime_data_bytes > 0)
 686                   clib_memcpy (rt->runtime_data, n->runtime_data,
 687                                clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
 688                                          n->runtime_data_bytes));
 689               }
 690
 691               nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
 692                 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
 693                                  CLIB_CACHE_LINE_BYTES);
 694               clib_interrupt_init (
 695                 &nm_clone->interrupts,
 696                 vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
 697               vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
 698               {
 699                 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
 700                 /* copy initial runtime_data from node */
 701                 if (n->runtime_data && n->runtime_data_bytes > 0)
 702                   clib_memcpy (rt->runtime_data, n->runtime_data,
 703                                clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
 704                                          n->runtime_data_bytes));
 705               }
 706
 707               nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
 708                 vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
 709                                  CLIB_CACHE_LINE_BYTES);
 710               vec_foreach (rt,
 711                            nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
 712               {
 713                 vlib_node_t *n = vlib_get_node (vm, rt->node_index);
 714                 /* copy initial runtime_data from node */
 715                 if (n->runtime_data && n->runtime_data_bytes > 0)
 716                   clib_memcpy (rt->runtime_data, n->runtime_data,
 717                                clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
 718                                          n->runtime_data_bytes));
 719               }
 720
 721               nm_clone->processes = vec_dup_aligned (nm->processes,
 722                                                      CLIB_CACHE_LINE_BYTES);
 723
 724               /* Create per-thread frame freelist */
 725               nm_clone->frame_sizes = 0;
 726               nm_clone->node_by_error = nm->node_by_error;
 727
 728               /* Packet trace buffers are guaranteed to be empty, nothing to do here */
 729
 730               clib_mem_set_heap (oldheap);
 731               vec_add1_aligned (vgm->vlib_mains, vm_clone,
 732                                 CLIB_CACHE_LINE_BYTES);
 733
 734               /* Switch to the stats segment ... */
 735               void *oldheap = vlib_stats_set_heap ();
 736               vm_clone->error_main.counters =
 737                 vec_dup_aligned (vlib_get_first_main ()->error_main.counters,
 738                                  CLIB_CACHE_LINE_BYTES);
 739               clib_mem_set_heap (oldheap);
 740               vlib_stats_update_error_vector (vm_clone->error_main.counters,
 741                                               worker_thread_index, 1);
 742
 743               vm_clone->error_main.counters_last_clear = vec_dup_aligned (
 744                 vlib_get_first_main ()->error_main.counters_last_clear,
 745                 CLIB_CACHE_LINE_BYTES);
 746
 747               worker_thread_index++;
 748             }
 749         }
 750     }
 751   else
 752     {
 753       /* only have non-data-structure copy threads to create... */
 754       for (i = 0; i < vec_len (tm->registrations); i++)
 755         {
 756           tr = tm->registrations[i];
 757
 758           for (j = 0; j < tr->count; j++)
 759             {
 760               vec_add2 (vlib_worker_threads, w, 1);
 761               if (tr->mheap_size)
 762                 {
 763                   w->thread_mheap = clib_mem_create_heap (0, tr->mheap_size,
 764                                                           /* locked */ 0,
 765                                                           "%s%d heap",
 766                                                           tr->name, j);
 767                 }
 768               else
 769                 w->thread_mheap = main_heap;
 770               w->thread_stack =
 771                 vlib_thread_stack_init (w - vlib_worker_threads);
 772               w->thread_function = tr->function;
 773               w->thread_function_arg = w;
 774               w->instance_id = j;
 775               w->elog_track.name =
 776                 (char *) format (0, "%s %d", tr->name, j + 1);
 777               w->registration = tr;
 778               vec_add1 (w->elog_track.name, 0);
 779               elog_track_register (vlib_get_elog_main (), &w->elog_track);
 780             }
 781         }
 782     }
 783
 784   worker_thread_index = 1;
 785
 786   for (i = 0; i < vec_len (tm->registrations); i++)
 787     {
 788       clib_error_t *err;
 789       int j;
 790
 791       tr = tm->registrations[i];
 792
 793       if (tr->use_pthreads || tm->use_pthreads)
 794         {
 795           for (j = 0; j < tr->count; j++)
 796             {
 797               w = vlib_worker_threads + worker_thread_index++;
 798               err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
 799                                             w, 0);
 800               if (err)
 801                 clib_error_report (err);
 802             }
 803         }
 804       else
 805         {
 806           uword c;
 807           /* *INDENT-OFF* */
 808           clib_bitmap_foreach (c, tr->coremask)  {
 809             w = vlib_worker_threads + worker_thread_index++;
 810             err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
 811                                           w, c);
 812             if (err)
 813               clib_error_report (err);
 814           }
 815           /* *INDENT-ON* */
 816         }
 817     }
 818   vlib_worker_thread_barrier_sync (vm);
 819   vlib_worker_thread_barrier_release (vm);
 820   return 0;
 821 }
 822
 823 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
 824
 825
 826 static inline void
 827 worker_thread_node_runtime_update_internal (void)
 828 {
 829   int i, j;
 830   vlib_main_t *vm;
 831   vlib_node_main_t *nm, *nm_clone;
 832   vlib_main_t *vm_clone;
 833   vlib_node_runtime_t *rt;
 834
 835   ASSERT (vlib_get_thread_index () == 0);
 836
 837   vm = vlib_get_first_main ();
 838   nm = &vm->node_main;
 839
 840   ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
 841
 842   /*
 843    * Scrape all runtime stats, so we don't lose node runtime(s) with
 844    * pending counts, or throw away worker / io thread counts.
 845    */
 846   for (j = 0; j < vec_len (nm->nodes); j++)
 847     {
 848       vlib_node_t *n;
 849       n = nm->nodes[j];
 850       vlib_node_sync_stats (vm, n);
 851     }
 852
 853   for (i = 1; i < vlib_get_n_threads (); i++)
 854     {
 855       vlib_node_t *n;
 856
 857       vm_clone = vlib_get_main_by_index (i);
 858       nm_clone = &vm_clone->node_main;
 859
 860       for (j = 0; j < vec_len (nm_clone->nodes); j++)
 861         {
 862           n = nm_clone->nodes[j];
 863
 864           rt = vlib_node_get_runtime (vm_clone, n->index);
 865           vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
 866         }
 867     }
 868
 869   /* Per-worker clone rebuilds are now done on each thread */
 870 }
 871
 872
 873 void
 874 vlib_worker_thread_node_refork (void)
 875 {
 876   vlib_main_t *vm, *vm_clone;
 877   vlib_node_main_t *nm, *nm_clone;
 878   vlib_node_t **old_nodes_clone;
 879   vlib_node_runtime_t *rt, *old_rt;
 880
 881   vlib_node_t *new_n_clone;
 882
 883   int j;
 884
 885   vm = vlib_get_first_main ();
 886   nm = &vm->node_main;
 887   vm_clone = vlib_get_main ();
 888   nm_clone = &vm_clone->node_main;
 889
 890   /* Re-clone error heap */
 891   u64 *old_counters = vm_clone->error_main.counters;
 892   u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
 893
 894   clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
 895                     sizeof (vm->error_main));
 896   j = vec_len (vm->error_main.counters) - 1;
 897
 898   /* Switch to the stats segment ... */
 899   void *oldheap = vlib_stats_set_heap ();
 900   vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
 901   clib_mem_set_heap (oldheap);
 902   vm_clone->error_main.counters = old_counters;
 903   vlib_stats_update_error_vector (vm_clone->error_main.counters,
 904                                   vm_clone->thread_index, 0);
 905
 906   vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
 907   vm_clone->error_main.counters_last_clear = old_counters_all_clear;
 908
 909   nm_clone = &vm_clone->node_main;
 910   vec_free (nm_clone->next_frames);
 911   nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
 912                                            CLIB_CACHE_LINE_BYTES);
 913
 914   for (j = 0; j < vec_len (nm_clone->next_frames); j++)
 915     {
 916       vlib_next_frame_t *nf = &nm_clone->next_frames[j];
 917       u32 save_node_runtime_index;
 918       u32 save_flags;
 919
 920       save_node_runtime_index = nf->node_runtime_index;
 921       save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
 922       vlib_next_frame_init (nf);
 923       nf->node_runtime_index = save_node_runtime_index;
 924       nf->flags = save_flags;
 925     }
 926
 927   old_nodes_clone = nm_clone->nodes;
 928   nm_clone->nodes = 0;
 929
 930   /* re-fork nodes */
 931
 932   /* Allocate all nodes in single block for speed */
 933   new_n_clone =
 934     clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
 935   for (j = 0; j < vec_len (nm->nodes); j++)
 936     {
 937       vlib_node_t *new_n = nm->nodes[j];
 938
 939       clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
 940       /* none of the copied nodes have enqueue rights given out */
 941       new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
 942
 943       if (j >= vec_len (old_nodes_clone))
 944         {
 945           /* new node, set to zero */
 946           clib_memset (&new_n_clone->stats_total, 0,
 947                        sizeof (new_n_clone->stats_total));
 948           clib_memset (&new_n_clone->stats_last_clear, 0,
 949                        sizeof (new_n_clone->stats_last_clear));
 950         }
 951       else
 952         {
 953           vlib_node_t *old_n_clone = old_nodes_clone[j];
 954           /* Copy stats if the old data is valid */
 955           clib_memcpy_fast (&new_n_clone->stats_total,
 956                             &old_n_clone->stats_total,
 957                             sizeof (new_n_clone->stats_total));
 958           clib_memcpy_fast (&new_n_clone->stats_last_clear,
 959                             &old_n_clone->stats_last_clear,
 960                             sizeof (new_n_clone->stats_last_clear));
 961
 962           /* keep previous node state */
 963           new_n_clone->state = old_n_clone->state;
 964           new_n_clone->flags = old_n_clone->flags;
 965         }
 966       vec_add1 (nm_clone->nodes, new_n_clone);
 967       new_n_clone++;
 968     }
 969   /* Free the old node clones */
 970   clib_mem_free (old_nodes_clone[0]);
 971
 972   vec_free (old_nodes_clone);
 973
 974
 975   /* re-clone internal nodes */
 976   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
 977   nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
 978     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
 979                      CLIB_CACHE_LINE_BYTES);
 980
 981   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
 982   {
 983     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
 984     /* copy runtime_data, will be overwritten later for existing rt */
 985     if (n->runtime_data && n->runtime_data_bytes > 0)
 986       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
 987                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
 988                                   n->runtime_data_bytes));
 989   }
 990
 991   for (j = 0; j < vec_len (old_rt); j++)
 992     {
 993       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
 994       rt->state = old_rt[j].state;
 995       rt->flags = old_rt[j].flags;
 996       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
 997                         VLIB_NODE_RUNTIME_DATA_SIZE);
 998     }
 999
1000   vec_free (old_rt);
1001
1002   /* re-clone input nodes */
1003   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1004   nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1005     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1006                      CLIB_CACHE_LINE_BYTES);
1007   clib_interrupt_resize (
1008     &nm_clone->interrupts,
1009     vec_len (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT]));
1010
1011   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1012   {
1013     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1014     /* copy runtime_data, will be overwritten later for existing rt */
1015     if (n->runtime_data && n->runtime_data_bytes > 0)
1016       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1017                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1018                                   n->runtime_data_bytes));
1019   }
1020
1021   for (j = 0; j < vec_len (old_rt); j++)
1022     {
1023       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1024       rt->state = old_rt[j].state;
1025       rt->flags = old_rt[j].flags;
1026       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1027                         VLIB_NODE_RUNTIME_DATA_SIZE);
1028     }
1029
1030   vec_free (old_rt);
1031
1032   /* re-clone pre-input nodes */
1033   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT];
1034   nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT] =
1035     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT],
1036                      CLIB_CACHE_LINE_BYTES);
1037
1038   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_PRE_INPUT])
1039   {
1040     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1041     /* copy runtime_data, will be overwritten later for existing rt */
1042     if (n->runtime_data && n->runtime_data_bytes > 0)
1043       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1044                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1045                                   n->runtime_data_bytes));
1046   }
1047
1048   for (j = 0; j < vec_len (old_rt); j++)
1049     {
1050       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1051       rt->state = old_rt[j].state;
1052       rt->flags = old_rt[j].flags;
1053       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1054                         VLIB_NODE_RUNTIME_DATA_SIZE);
1055     }
1056
1057   vec_free (old_rt);
1058
1059   vec_free (nm_clone->processes);
1060   nm_clone->processes = vec_dup_aligned (nm->processes,
1061                                          CLIB_CACHE_LINE_BYTES);
1062   nm_clone->node_by_error = nm->node_by_error;
1063 }
1064
1065 void
1066 vlib_worker_thread_node_runtime_update (void)
1067 {
1068   /*
1069    * Make a note that we need to do a node runtime update
1070    * prior to releasing the barrier.
1071    */
1072   vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1073 }
1074
1075 u32
1076 unformat_sched_policy (unformat_input_t * input, va_list * args)
1077 {
1078   u32 *r = va_arg (*args, u32 *);
1079
1080   if (0);
1081 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1082   foreach_sched_policy
1083 #undef _
1084     else
1085     return 0;
1086   return 1;
1087 }
1088
1089 static clib_error_t *
1090 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1091 {
1092   vlib_thread_registration_t *tr;
1093   uword *p;
1094   vlib_thread_main_t *tm = &vlib_thread_main;
1095   u8 *name;
1096   uword *bitmap;
1097   u32 count;
1098
1099   tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1100
1101   tm->n_thread_stacks = 1;      /* account for main thread */
1102   tm->sched_policy = ~0;
1103   tm->sched_priority = ~0;
1104   tm->main_lcore = ~0;
1105
1106   tr = tm->next;
1107
1108   while (tr)
1109     {
1110       hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1111       tr = tr->next;
1112     }
1113
1114   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1115     {
1116       if (unformat (input, "use-pthreads"))
1117         tm->use_pthreads = 1;
1118       else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1119         ;
1120       else if (unformat (input, "main-core %u", &tm->main_lcore))
1121         ;
1122       else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1123         ;
1124       else if (unformat (input, "numa-heap-size %U",
1125                          unformat_memory_size, &tm->numa_heap_size))
1126         ;
1127       else if (unformat (input, "coremask-%s %U", &name,
1128                          unformat_bitmap_mask, &bitmap) ||
1129                unformat (input, "corelist-%s %U", &name,
1130                          unformat_bitmap_list, &bitmap))
1131         {
1132           p = hash_get_mem (tm->thread_registrations_by_name, name);
1133           if (p == 0)
1134             return clib_error_return (0, "no such thread type '%s'", name);
1135
1136           tr = (vlib_thread_registration_t *) p[0];
1137
1138           if (tr->use_pthreads)
1139             return clib_error_return (0,
1140                                       "corelist cannot be set for '%s' threads",
1141                                       name);
1142           if (tr->count)
1143             return clib_error_return
1144               (0, "core placement of '%s' threads is already configured",
1145                name);
1146
1147           tr->coremask = bitmap;
1148           tr->count = clib_bitmap_count_set_bits (tr->coremask);
1149         }
1150       else
1151         if (unformat
1152             (input, "scheduler-policy %U", unformat_sched_policy,
1153              &tm->sched_policy))
1154         ;
1155       else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1156         ;
1157       else if (unformat (input, "%s %u", &name, &count))
1158         {
1159           p = hash_get_mem (tm->thread_registrations_by_name, name);
1160           if (p == 0)
1161             return clib_error_return (0, "no such thread type 3 '%s'", name);
1162
1163           tr = (vlib_thread_registration_t *) p[0];
1164
1165           if (tr->fixed_count)
1166             return clib_error_return
1167               (0, "number of '%s' threads not configurable", name);
1168           if (tr->count)
1169             return clib_error_return
1170               (0, "number of '%s' threads is already configured", name);
1171
1172           tr->count = count;
1173         }
1174       else
1175         break;
1176     }
1177
1178   if (tm->sched_priority != ~0)
1179     {
1180       if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1181         {
1182           u32 prio_max = sched_get_priority_max (tm->sched_policy);
1183           u32 prio_min = sched_get_priority_min (tm->sched_policy);
1184           if (tm->sched_priority > prio_max)
1185             tm->sched_priority = prio_max;
1186           if (tm->sched_priority < prio_min)
1187             tm->sched_priority = prio_min;
1188         }
1189       else
1190         {
1191           return clib_error_return
1192             (0,
1193              "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1194              tm->sched_priority);
1195         }
1196     }
1197   tr = tm->next;
1198
1199   if (!tm->thread_prefix)
1200     tm->thread_prefix = format (0, "vpp");
1201
1202   while (tr)
1203     {
1204       tm->n_thread_stacks += tr->count;
1205       tm->n_pthreads += tr->count * tr->use_pthreads;
1206       tm->n_threads += tr->count * (tr->use_pthreads == 0);
1207       tr = tr->next;
1208     }
1209
1210   return 0;
1211 }
1212
1213 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1214
1215   /*
1216    * Enforce minimum open time to minimize packet loss due to Rx overflow,
1217    * based on a test based heuristic that barrier should be open for at least
1218    * 3 time as long as it is closed (with an upper bound of 1ms because by that
1219    *  point it is probably too late to make a difference)
1220    */
1221
1222 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1223 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1224 #endif
1225
1226 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1227 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1228 #endif
1229
1230 void
1231 vlib_worker_thread_initial_barrier_sync_and_release (vlib_main_t * vm)
1232 {
1233   f64 deadline;
1234   f64 now = vlib_time_now (vm);
1235   u32 count = vlib_get_n_threads () - 1;
1236
1237   /* No worker threads? */
1238   if (count == 0)
1239     return;
1240
1241   deadline = now + BARRIER_SYNC_TIMEOUT;
1242   *vlib_worker_threads->wait_at_barrier = 1;
1243   while (*vlib_worker_threads->workers_at_barrier != count)
1244     {
1245       if ((now = vlib_time_now (vm)) > deadline)
1246         {
1247           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1248           os_panic ();
1249         }
1250       CLIB_PAUSE ();
1251     }
1252   *vlib_worker_threads->wait_at_barrier = 0;
1253 }
1254
1255 /**
1256  * Return true if the wroker thread barrier is held
1257  */
1258 u8
1259 vlib_worker_thread_barrier_held (void)
1260 {
1261   if (vlib_get_n_threads () < 2)
1262     return (1);
1263
1264   return (*vlib_worker_threads->wait_at_barrier == 1);
1265 }
1266
1267 void
1268 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm, const char *func_name)
1269 {
1270   f64 deadline;
1271   f64 now;
1272   f64 t_entry;
1273   f64 t_open;
1274   f64 t_closed;
1275   f64 max_vector_rate;
1276   u32 count;
1277   int i;
1278
1279   if (vlib_get_n_threads () < 2)
1280     return;
1281
1282   ASSERT (vlib_get_thread_index () == 0);
1283
1284   vlib_worker_threads[0].barrier_caller = func_name;
1285   count = vlib_get_n_threads () - 1;
1286
1287   /* Record entry relative to last close */
1288   now = vlib_time_now (vm);
1289   t_entry = now - vm->barrier_epoch;
1290
1291   /* Tolerate recursive calls */
1292   if (++vlib_worker_threads[0].recursion_level > 1)
1293     {
1294       barrier_trace_sync_rec (t_entry);
1295       return;
1296     }
1297
1298   if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1299     clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1300                          vm->clib_time.last_cpu_time, 0 /* enter */ );
1301
1302   /*
1303    * Need data to decide if we're working hard enough to honor
1304    * the barrier hold-down timer.
1305    */
1306   max_vector_rate = 0.0;
1307   for (i = 1; i < vlib_get_n_threads (); i++)
1308     {
1309       vlib_main_t *ovm = vlib_get_main_by_index (i);
1310       max_vector_rate = clib_max (max_vector_rate,
1311                                   (f64) vlib_last_vectors_per_main_loop (ovm));
1312     }
1313
1314   vlib_worker_threads[0].barrier_sync_count++;
1315
1316   /* Enforce minimum barrier open time to minimize packet loss */
1317   ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1318
1319   /*
1320    * If any worker thread seems busy, which we define
1321    * as a vector rate above 10, we enforce the barrier hold-down timer
1322    */
1323   if (max_vector_rate > 10.0)
1324     {
1325       while (1)
1326         {
1327           now = vlib_time_now (vm);
1328           /* Barrier hold-down timer expired? */
1329           if (now >= vm->barrier_no_close_before)
1330             break;
1331           if ((vm->barrier_no_close_before - now)
1332               > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1333             {
1334               clib_warning
1335                 ("clock change: would have waited for %.4f seconds",
1336                  (vm->barrier_no_close_before - now));
1337               break;
1338             }
1339         }
1340     }
1341   /* Record time of closure */
1342   t_open = now - vm->barrier_epoch;
1343   vm->barrier_epoch = now;
1344
1345   deadline = now + BARRIER_SYNC_TIMEOUT;
1346
1347   *vlib_worker_threads->wait_at_barrier = 1;
1348   while (*vlib_worker_threads->workers_at_barrier != count)
1349     {
1350       if ((now = vlib_time_now (vm)) > deadline)
1351         {
1352           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1353           os_panic ();
1354         }
1355     }
1356
1357   t_closed = now - vm->barrier_epoch;
1358
1359   barrier_trace_sync (t_entry, t_open, t_closed);
1360
1361 }
1362
1363 void
1364 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1365 {
1366   vlib_global_main_t *vgm = vlib_get_global_main ();
1367   f64 deadline;
1368   f64 now;
1369   f64 minimum_open;
1370   f64 t_entry;
1371   f64 t_closed_total;
1372   f64 t_update_main = 0.0;
1373   int refork_needed = 0;
1374
1375   if (vlib_get_n_threads () < 2)
1376     return;
1377
1378   ASSERT (vlib_get_thread_index () == 0);
1379
1380
1381   now = vlib_time_now (vm);
1382   t_entry = now - vm->barrier_epoch;
1383
1384   if (--vlib_worker_threads[0].recursion_level > 0)
1385     {
1386       barrier_trace_release_rec (t_entry);
1387       return;
1388     }
1389
1390   /* Update (all) node runtimes before releasing the barrier, if needed */
1391   if (vgm->need_vlib_worker_thread_node_runtime_update)
1392     {
1393       /*
1394        * Lock stat segment here, so we's safe when
1395        * rebuilding the stat segment node clones from the
1396        * stat thread...
1397        */
1398       vlib_stats_segment_lock ();
1399
1400       /* Do stats elements on main thread */
1401       worker_thread_node_runtime_update_internal ();
1402       vgm->need_vlib_worker_thread_node_runtime_update = 0;
1403
1404       /* Do per thread rebuilds in parallel */
1405       refork_needed = 1;
1406       clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1407                              (vlib_get_n_threads () - 1));
1408       now = vlib_time_now (vm);
1409       t_update_main = now - vm->barrier_epoch;
1410     }
1411
1412   deadline = now + BARRIER_SYNC_TIMEOUT;
1413
1414   /*
1415    * Note when we let go of the barrier.
1416    * Workers can use this to derive a reasonably accurate
1417    * time offset. See vlib_time_now(...)
1418    */
1419   vm->time_last_barrier_release = vlib_time_now (vm);
1420   CLIB_MEMORY_STORE_BARRIER ();
1421
1422   *vlib_worker_threads->wait_at_barrier = 0;
1423
1424   while (*vlib_worker_threads->workers_at_barrier > 0)
1425     {
1426       if ((now = vlib_time_now (vm)) > deadline)
1427         {
1428           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1429           os_panic ();
1430         }
1431     }
1432
1433   /* Wait for reforks before continuing */
1434   if (refork_needed)
1435     {
1436       now = vlib_time_now (vm);
1437
1438       deadline = now + BARRIER_SYNC_TIMEOUT;
1439
1440       while (*vlib_worker_threads->node_reforks_required > 0)
1441         {
1442           if ((now = vlib_time_now (vm)) > deadline)
1443             {
1444               fformat (stderr, "%s: worker thread refork deadlock\n",
1445                        __FUNCTION__);
1446               os_panic ();
1447             }
1448         }
1449       vlib_stats_segment_unlock ();
1450     }
1451
1452   t_closed_total = now - vm->barrier_epoch;
1453
1454   minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1455
1456   if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1457     {
1458       minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1459     }
1460
1461   vm->barrier_no_close_before = now + minimum_open;
1462
1463   /* Record barrier epoch (used to enforce minimum open time) */
1464   vm->barrier_epoch = now;
1465
1466   barrier_trace_release (t_entry, t_closed_total, t_update_main);
1467
1468   if (PREDICT_FALSE (vec_len (vm->barrier_perf_callbacks) != 0))
1469     clib_call_callbacks (vm->barrier_perf_callbacks, vm,
1470                          vm->clib_time.last_cpu_time, 1 /* leave */ );
1471 }
1472
1473 /**
1474  * Wait until each of the workers has been once around the track
1475  */
1476 void
1477 vlib_worker_wait_one_loop (void)
1478 {
1479   vlib_global_main_t *vgm = vlib_get_global_main ();
1480   ASSERT (vlib_get_thread_index () == 0);
1481
1482   if (vlib_get_n_threads () < 2)
1483     return;
1484
1485   if (vlib_worker_thread_barrier_held ())
1486     return;
1487
1488   u32 *counts = 0;
1489   u32 ii;
1490
1491   vec_validate (counts, vlib_get_n_threads () - 1);
1492
1493   /* record the current loop counts */
1494   vec_foreach_index (ii, vgm->vlib_mains)
1495     counts[ii] = vgm->vlib_mains[ii]->main_loop_count;
1496
1497   /* spin until each changes, apart from the main thread, or we'd be
1498    * a while */
1499   for (ii = 1; ii < vec_len (counts); ii++)
1500     {
1501       while (counts[ii] == vgm->vlib_mains[ii]->main_loop_count)
1502         CLIB_PAUSE ();
1503     }
1504
1505   vec_free (counts);
1506   return;
1507 }
1508
1509 void
1510 vlib_worker_thread_fn (void *arg)
1511 {
1512   vlib_global_main_t *vgm = vlib_get_global_main ();
1513   vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1514   vlib_main_t *vm = vlib_get_main ();
1515   clib_error_t *e;
1516
1517   vlib_process_finish_switch_stack (vm);
1518
1519   ASSERT (vm->thread_index == vlib_get_thread_index ());
1520
1521   vlib_worker_thread_init (w);
1522   clib_time_init (&vm->clib_time);
1523   clib_mem_set_heap (w->thread_mheap);
1524
1525   vm->worker_init_functions_called = hash_create (0, 0);
1526
1527   e = vlib_call_init_exit_functions_no_sort (
1528     vm, &vgm->worker_init_function_registrations, 1 /* call_once */,
1529     0 /* is_global */);
1530   if (e)
1531     clib_error_report (e);
1532
1533   vlib_worker_loop (vm);
1534 }
1535
1536 /* *INDENT-OFF* */
1537 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1538   .name = "workers",
1539   .short_name = "wk",
1540   .function = vlib_worker_thread_fn,
1541 };
1542 /* *INDENT-ON* */
1543
1544 u32
1545 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1546 {
1547   vlib_thread_main_t *tm = vlib_get_thread_main ();
1548   vlib_frame_queue_main_t *fqm;
1549   vlib_frame_queue_t *fq;
1550   int i;
1551   u32 num_threads;
1552
1553   if (frame_queue_nelts == 0)
1554     frame_queue_nelts = FRAME_QUEUE_MAX_NELTS;
1555
1556   num_threads = 1 /* main thread */  + tm->n_threads;
1557   ASSERT (frame_queue_nelts >= 8 + num_threads);
1558
1559   vec_add2 (tm->frame_queue_mains, fqm, 1);
1560
1561   fqm->node_index = node_index;
1562   fqm->frame_queue_nelts = frame_queue_nelts;
1563
1564   vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1565   _vec_len (fqm->vlib_frame_queues) = 0;
1566   for (i = 0; i < tm->n_vlib_mains; i++)
1567     {
1568       fq = vlib_frame_queue_alloc (frame_queue_nelts);
1569       vec_add1 (fqm->vlib_frame_queues, fq);
1570     }
1571
1572   return (fqm - tm->frame_queue_mains);
1573 }
1574
1575 void
1576 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1577                                      args)
1578 {
1579   ASSERT (vlib_get_thread_index () == 0);
1580   vlib_process_signal_event (vlib_get_main (), args->node_index,
1581                              args->type_opaque, args->data);
1582 }
1583
1584 void *rpc_call_main_thread_cb_fn;
1585
1586 void
1587 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1588 {
1589   if (rpc_call_main_thread_cb_fn)
1590     {
1591       void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1592       (*fp) (callback, args, arg_size);
1593     }
1594   else
1595     clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1596 }
1597
1598 clib_error_t *
1599 threads_init (vlib_main_t * vm)
1600 {
1601   return 0;
1602 }
1603
1604 VLIB_INIT_FUNCTION (threads_init);
1605
1606
1607 static clib_error_t *
1608 show_clock_command_fn (vlib_main_t * vm,
1609                        unformat_input_t * input, vlib_cli_command_t * cmd)
1610 {
1611   int verbose = 0;
1612   clib_timebase_t _tb, *tb = &_tb;
1613
1614   (void) unformat (input, "verbose %=", &verbose, 1);
1615
1616   clib_timebase_init (tb, 0 /* GMT */ , CLIB_TIMEBASE_DAYLIGHT_NONE,
1617                       &vm->clib_time);
1618
1619   vlib_cli_output (vm, "%U, %U GMT", format_clib_time, &vm->clib_time,
1620                    verbose, format_clib_timebase_time,
1621                    clib_timebase_now (tb));
1622
1623   vlib_cli_output (vm, "Time last barrier release %.9f",
1624                    vm->time_last_barrier_release);
1625
1626   foreach_vlib_main ()
1627     {
1628       vlib_cli_output (vm, "%d: %U", this_vlib_main->thread_index,
1629                        format_clib_time, &this_vlib_main->clib_time, verbose);
1630
1631       vlib_cli_output (vm, "Thread %d offset %.9f error %.9f",
1632                        this_vlib_main->thread_index,
1633                        this_vlib_main->time_offset,
1634                        vm->time_last_barrier_release -
1635                          this_vlib_main->time_last_barrier_release);
1636     }
1637   return 0;
1638 }
1639
1640 /* *INDENT-OFF* */
1641 VLIB_CLI_COMMAND (f_command, static) =
1642 {
1643   .path = "show clock",
1644   .short_help = "show clock",
1645   .function = show_clock_command_fn,
1646 };
1647 /* *INDENT-ON* */
1648
1649 vlib_thread_main_t *
1650 vlib_get_thread_main_not_inline (void)
1651 {
1652   return vlib_get_thread_main ();
1653 }
1654
1655 /*
1656  * fd.io coding-style-patch-verification: ON
1657  *
1658  * Local Variables:
1659  * eval: (c-set-style "gnu")
1660  * End:
1661  */