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