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