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