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