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