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