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