src/vlib/threads.c

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