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->processes = vec_dup_aligned (nm->processes,
 854                                                      CLIB_CACHE_LINE_BYTES);
 855
 856               /* zap the (per worker) frame freelists, etc */
 857               nm_clone->frame_sizes = 0;
 858               nm_clone->frame_size_hash = hash_create (0, sizeof (uword));
 859
 860               /* Packet trace buffers are guaranteed to be empty, nothing to do here */
 861
 862               clib_mem_set_heap (oldheap);
 863               vec_add1_aligned (vlib_mains, vm_clone, CLIB_CACHE_LINE_BYTES);
 864
 865               vm_clone->error_main.counters = vec_dup_aligned
 866                 (vlib_mains[0]->error_main.counters, CLIB_CACHE_LINE_BYTES);
 867               vm_clone->error_main.counters_last_clear = vec_dup_aligned
 868                 (vlib_mains[0]->error_main.counters_last_clear,
 869                  CLIB_CACHE_LINE_BYTES);
 870
 871               /* Fork the vlib_buffer_main_t free lists, etc. */
 872               orig_freelist_pool = vm_clone->buffer_free_list_pool;
 873               vm_clone->buffer_free_list_pool = 0;
 874
 875             /* *INDENT-OFF* */
 876             pool_foreach (fl_orig, orig_freelist_pool,
 877                           ({
 878                             pool_get_aligned (vm_clone->buffer_free_list_pool,
 879                                               fl_clone, CLIB_CACHE_LINE_BYTES);
 880                             ASSERT (fl_orig - orig_freelist_pool
 881                                     == fl_clone - vm_clone->buffer_free_list_pool);
 882
 883                             fl_clone[0] = fl_orig[0];
 884                             fl_clone->buffers = 0;
 885                             fl_clone->n_alloc = 0;
 886                           }));
 887 /* *INDENT-ON* */
 888
 889               worker_thread_index++;
 890             }
 891         }
 892     }
 893   else
 894     {
 895       /* only have non-data-structure copy threads to create... */
 896       for (i = 0; i < vec_len (tm->registrations); i++)
 897         {
 898           tr = tm->registrations[i];
 899
 900           for (j = 0; j < tr->count; j++)
 901             {
 902               vec_add2 (vlib_worker_threads, w, 1);
 903               if (tr->mheap_size)
 904                 {
 905 #if USE_DLMALLOC == 0
 906                   w->thread_mheap =
 907                     mheap_alloc (0 /* use VM */ , tr->mheap_size);
 908 #else
 909                   w->thread_mheap =
 910                     create_mspace (tr->mheap_size, 0 /* locked */ );
 911 #endif
 912                 }
 913               else
 914                 w->thread_mheap = main_heap;
 915               w->thread_stack =
 916                 vlib_thread_stack_init (w - vlib_worker_threads);
 917               w->thread_function = tr->function;
 918               w->thread_function_arg = w;
 919               w->instance_id = j;
 920               w->elog_track.name =
 921                 (char *) format (0, "%s %d", tr->name, j + 1);
 922               w->registration = tr;
 923               vec_add1 (w->elog_track.name, 0);
 924               elog_track_register (&vm->elog_main, &w->elog_track);
 925             }
 926         }
 927     }
 928
 929   worker_thread_index = 1;
 930
 931   for (i = 0; i < vec_len (tm->registrations); i++)
 932     {
 933       clib_error_t *err;
 934       int j;
 935
 936       tr = tm->registrations[i];
 937
 938       if (tr->use_pthreads || tm->use_pthreads)
 939         {
 940           for (j = 0; j < tr->count; j++)
 941             {
 942               w = vlib_worker_threads + worker_thread_index++;
 943               err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
 944                                             w, 0);
 945               if (err)
 946                 clib_error_report (err);
 947             }
 948         }
 949       else
 950         {
 951           uword c;
 952           /* *INDENT-OFF* */
 953           clib_bitmap_foreach (c, tr->coremask, ({
 954             w = vlib_worker_threads + worker_thread_index++;
 955             err = vlib_launch_thread_int (vlib_worker_thread_bootstrap_fn,
 956                                           w, c);
 957             if (err)
 958               clib_error_report (err);
 959           }));
 960           /* *INDENT-ON* */
 961         }
 962     }
 963   vlib_worker_thread_barrier_sync (vm);
 964   vlib_worker_thread_barrier_release (vm);
 965   return 0;
 966 }
 967
 968 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
 969
 970
 971 static inline void
 972 worker_thread_node_runtime_update_internal (void)
 973 {
 974   int i, j;
 975   vlib_main_t *vm;
 976   vlib_node_main_t *nm, *nm_clone;
 977   vlib_main_t *vm_clone;
 978   vlib_node_runtime_t *rt;
 979   never_inline void
 980     vlib_node_runtime_sync_stats (vlib_main_t * vm,
 981                                   vlib_node_runtime_t * r,
 982                                   uword n_calls,
 983                                   uword n_vectors, uword n_clocks);
 984
 985   ASSERT (vlib_get_thread_index () == 0);
 986
 987   vm = vlib_mains[0];
 988   nm = &vm->node_main;
 989
 990   ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
 991
 992   /*
 993    * Scrape all runtime stats, so we don't lose node runtime(s) with
 994    * pending counts, or throw away worker / io thread counts.
 995    */
 996   for (j = 0; j < vec_len (nm->nodes); j++)
 997     {
 998       vlib_node_t *n;
 999       n = nm->nodes[j];
1000       vlib_node_sync_stats (vm, n);
1001     }
1002
1003   for (i = 1; i < vec_len (vlib_mains); i++)
1004     {
1005       vlib_node_t *n;
1006
1007       vm_clone = vlib_mains[i];
1008       nm_clone = &vm_clone->node_main;
1009
1010       for (j = 0; j < vec_len (nm_clone->nodes); j++)
1011         {
1012           n = nm_clone->nodes[j];
1013
1014           rt = vlib_node_get_runtime (vm_clone, n->index);
1015           vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
1016         }
1017     }
1018
1019   /* Per-worker clone rebuilds are now done on each thread */
1020 }
1021
1022
1023 void
1024 vlib_worker_thread_node_refork (void)
1025 {
1026   vlib_main_t *vm, *vm_clone;
1027   vlib_node_main_t *nm, *nm_clone;
1028   vlib_node_t **old_nodes_clone;
1029   vlib_node_runtime_t *rt, *old_rt;
1030
1031   vlib_node_t *new_n_clone;
1032
1033   int j;
1034
1035   vm = vlib_mains[0];
1036   nm = &vm->node_main;
1037   vm_clone = vlib_get_main ();
1038   nm_clone = &vm_clone->node_main;
1039
1040   /* Re-clone error heap */
1041   u64 *old_counters = vm_clone->error_main.counters;
1042   u64 *old_counters_all_clear = vm_clone->error_main.counters_last_clear;
1043
1044   clib_memcpy_fast (&vm_clone->error_main, &vm->error_main,
1045                     sizeof (vm->error_main));
1046   j = vec_len (vm->error_main.counters) - 1;
1047   vec_validate_aligned (old_counters, j, CLIB_CACHE_LINE_BYTES);
1048   vec_validate_aligned (old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
1049   vm_clone->error_main.counters = old_counters;
1050   vm_clone->error_main.counters_last_clear = old_counters_all_clear;
1051
1052   nm_clone = &vm_clone->node_main;
1053   vec_free (nm_clone->next_frames);
1054   nm_clone->next_frames = vec_dup_aligned (nm->next_frames,
1055                                            CLIB_CACHE_LINE_BYTES);
1056
1057   for (j = 0; j < vec_len (nm_clone->next_frames); j++)
1058     {
1059       vlib_next_frame_t *nf = &nm_clone->next_frames[j];
1060       u32 save_node_runtime_index;
1061       u32 save_flags;
1062
1063       save_node_runtime_index = nf->node_runtime_index;
1064       save_flags = nf->flags & VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
1065       vlib_next_frame_init (nf);
1066       nf->node_runtime_index = save_node_runtime_index;
1067       nf->flags = save_flags;
1068     }
1069
1070   old_nodes_clone = nm_clone->nodes;
1071   nm_clone->nodes = 0;
1072
1073   /* re-fork nodes */
1074
1075   /* Allocate all nodes in single block for speed */
1076   new_n_clone =
1077     clib_mem_alloc_no_fail (vec_len (nm->nodes) * sizeof (*new_n_clone));
1078   for (j = 0; j < vec_len (nm->nodes); j++)
1079     {
1080       vlib_node_t *old_n_clone;
1081       vlib_node_t *new_n;
1082
1083       new_n = nm->nodes[j];
1084       old_n_clone = old_nodes_clone[j];
1085
1086       clib_memcpy_fast (new_n_clone, new_n, sizeof (*new_n));
1087       /* none of the copied nodes have enqueue rights given out */
1088       new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
1089
1090       if (j >= vec_len (old_nodes_clone))
1091         {
1092           /* new node, set to zero */
1093           clib_memset (&new_n_clone->stats_total, 0,
1094                        sizeof (new_n_clone->stats_total));
1095           clib_memset (&new_n_clone->stats_last_clear, 0,
1096                        sizeof (new_n_clone->stats_last_clear));
1097         }
1098       else
1099         {
1100           /* Copy stats if the old data is valid */
1101           clib_memcpy_fast (&new_n_clone->stats_total,
1102                             &old_n_clone->stats_total,
1103                             sizeof (new_n_clone->stats_total));
1104           clib_memcpy_fast (&new_n_clone->stats_last_clear,
1105                             &old_n_clone->stats_last_clear,
1106                             sizeof (new_n_clone->stats_last_clear));
1107
1108           /* keep previous node state */
1109           new_n_clone->state = old_n_clone->state;
1110         }
1111       vec_add1 (nm_clone->nodes, new_n_clone);
1112       new_n_clone++;
1113     }
1114   /* Free the old node clones */
1115   clib_mem_free (old_nodes_clone[0]);
1116
1117   vec_free (old_nodes_clone);
1118
1119
1120   /* re-clone internal nodes */
1121   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL];
1122   nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
1123     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
1124                      CLIB_CACHE_LINE_BYTES);
1125
1126   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
1127   {
1128     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1129     rt->thread_index = vm_clone->thread_index;
1130     /* copy runtime_data, will be overwritten later for existing rt */
1131     if (n->runtime_data && n->runtime_data_bytes > 0)
1132       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1133                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1134                                   n->runtime_data_bytes));
1135   }
1136
1137   for (j = 0; j < vec_len (old_rt); j++)
1138     {
1139       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1140       rt->state = old_rt[j].state;
1141       clib_memcpy_fast (rt->runtime_data, old_rt[j].runtime_data,
1142                         VLIB_NODE_RUNTIME_DATA_SIZE);
1143     }
1144
1145   vec_free (old_rt);
1146
1147   /* re-clone input nodes */
1148   old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
1149   nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
1150     vec_dup_aligned (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT],
1151                      CLIB_CACHE_LINE_BYTES);
1152
1153   vec_foreach (rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
1154   {
1155     vlib_node_t *n = vlib_get_node (vm, rt->node_index);
1156     rt->thread_index = vm_clone->thread_index;
1157     /* copy runtime_data, will be overwritten later for existing rt */
1158     if (n->runtime_data && n->runtime_data_bytes > 0)
1159       clib_memcpy_fast (rt->runtime_data, n->runtime_data,
1160                         clib_min (VLIB_NODE_RUNTIME_DATA_SIZE,
1161                                   n->runtime_data_bytes));
1162   }
1163
1164   for (j = 0; j < vec_len (old_rt); j++)
1165     {
1166       rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
1167       rt->state = old_rt[j].state;
1168       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   nm_clone->processes = vec_dup_aligned (nm->processes,
1175                                          CLIB_CACHE_LINE_BYTES);
1176 }
1177
1178 void
1179 vlib_worker_thread_node_runtime_update (void)
1180 {
1181   /*
1182    * Make a note that we need to do a node runtime update
1183    * prior to releasing the barrier.
1184    */
1185   vlib_global_main.need_vlib_worker_thread_node_runtime_update = 1;
1186 }
1187
1188 u32
1189 unformat_sched_policy (unformat_input_t * input, va_list * args)
1190 {
1191   u32 *r = va_arg (*args, u32 *);
1192
1193   if (0);
1194 #define _(v,f,s) else if (unformat (input, s)) *r = SCHED_POLICY_##f;
1195   foreach_sched_policy
1196 #undef _
1197     else
1198     return 0;
1199   return 1;
1200 }
1201
1202 static clib_error_t *
1203 cpu_config (vlib_main_t * vm, unformat_input_t * input)
1204 {
1205   vlib_thread_registration_t *tr;
1206   uword *p;
1207   vlib_thread_main_t *tm = &vlib_thread_main;
1208   u8 *name;
1209   uword *bitmap;
1210   u32 count;
1211
1212   tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
1213
1214   tm->n_thread_stacks = 1;      /* account for main thread */
1215   tm->sched_policy = ~0;
1216   tm->sched_priority = ~0;
1217   tm->main_lcore = ~0;
1218
1219   tr = tm->next;
1220
1221   while (tr)
1222     {
1223       hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword) tr);
1224       tr = tr->next;
1225     }
1226
1227   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1228     {
1229       if (unformat (input, "use-pthreads"))
1230         tm->use_pthreads = 1;
1231       else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
1232         ;
1233       else if (unformat (input, "main-core %u", &tm->main_lcore))
1234         ;
1235       else if (unformat (input, "skip-cores %u", &tm->skip_cores))
1236         ;
1237       else if (unformat (input, "coremask-%s %U", &name,
1238                          unformat_bitmap_mask, &bitmap) ||
1239                unformat (input, "corelist-%s %U", &name,
1240                          unformat_bitmap_list, &bitmap))
1241         {
1242           p = hash_get_mem (tm->thread_registrations_by_name, name);
1243           if (p == 0)
1244             return clib_error_return (0, "no such thread type '%s'", name);
1245
1246           tr = (vlib_thread_registration_t *) p[0];
1247
1248           if (tr->use_pthreads)
1249             return clib_error_return (0,
1250                                       "corelist cannot be set for '%s' threads",
1251                                       name);
1252
1253           tr->coremask = bitmap;
1254           tr->count = clib_bitmap_count_set_bits (tr->coremask);
1255         }
1256       else
1257         if (unformat
1258             (input, "scheduler-policy %U", unformat_sched_policy,
1259              &tm->sched_policy))
1260         ;
1261       else if (unformat (input, "scheduler-priority %u", &tm->sched_priority))
1262         ;
1263       else if (unformat (input, "%s %u", &name, &count))
1264         {
1265           p = hash_get_mem (tm->thread_registrations_by_name, name);
1266           if (p == 0)
1267             return clib_error_return (0, "no such thread type 3 '%s'", name);
1268
1269           tr = (vlib_thread_registration_t *) p[0];
1270           if (tr->fixed_count)
1271             return clib_error_return
1272               (0, "number of %s threads not configurable", tr->name);
1273           tr->count = count;
1274         }
1275       else
1276         break;
1277     }
1278
1279   if (tm->sched_priority != ~0)
1280     {
1281       if (tm->sched_policy == SCHED_FIFO || tm->sched_policy == SCHED_RR)
1282         {
1283           u32 prio_max = sched_get_priority_max (tm->sched_policy);
1284           u32 prio_min = sched_get_priority_min (tm->sched_policy);
1285           if (tm->sched_priority > prio_max)
1286             tm->sched_priority = prio_max;
1287           if (tm->sched_priority < prio_min)
1288             tm->sched_priority = prio_min;
1289         }
1290       else
1291         {
1292           return clib_error_return
1293             (0,
1294              "scheduling priority (%d) is not allowed for `normal` scheduling policy",
1295              tm->sched_priority);
1296         }
1297     }
1298   tr = tm->next;
1299
1300   if (!tm->thread_prefix)
1301     tm->thread_prefix = format (0, "vpp");
1302
1303   while (tr)
1304     {
1305       tm->n_thread_stacks += tr->count;
1306       tm->n_pthreads += tr->count * tr->use_pthreads;
1307       tm->n_threads += tr->count * (tr->use_pthreads == 0);
1308       tr = tr->next;
1309     }
1310
1311   return 0;
1312 }
1313
1314 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1315
1316 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1317 void
1318 vnet_main_fixup (vlib_fork_fixup_t which)
1319 {
1320 }
1321
1322 void
1323 vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1324 {
1325   vlib_main_t *vm = vlib_get_main ();
1326
1327   if (vlib_mains == 0)
1328     return;
1329
1330   ASSERT (vlib_get_thread_index () == 0);
1331   vlib_worker_thread_barrier_sync (vm);
1332
1333   switch (which)
1334     {
1335     case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1336       vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1337       break;
1338
1339     default:
1340       ASSERT (0);
1341     }
1342   vlib_worker_thread_barrier_release (vm);
1343 }
1344
1345   /*
1346    * Enforce minimum open time to minimize packet loss due to Rx overflow,
1347    * based on a test based heuristic that barrier should be open for at least
1348    * 3 time as long as it is closed (with an upper bound of 1ms because by that
1349    *  point it is probably too late to make a difference)
1350    */
1351
1352 #ifndef BARRIER_MINIMUM_OPEN_LIMIT
1353 #define BARRIER_MINIMUM_OPEN_LIMIT 0.001
1354 #endif
1355
1356 #ifndef BARRIER_MINIMUM_OPEN_FACTOR
1357 #define BARRIER_MINIMUM_OPEN_FACTOR 3
1358 #endif
1359
1360 void
1361 vlib_worker_thread_barrier_sync_int (vlib_main_t * vm)
1362 {
1363   f64 deadline;
1364   f64 now;
1365   f64 t_entry;
1366   f64 t_open;
1367   f64 t_closed;
1368   u32 count;
1369
1370   if (vec_len (vlib_mains) < 2)
1371     return;
1372
1373   ASSERT (vlib_get_thread_index () == 0);
1374
1375   count = vec_len (vlib_mains) - 1;
1376
1377   /* Record entry relative to last close */
1378   now = vlib_time_now (vm);
1379   t_entry = now - vm->barrier_epoch;
1380
1381   /* Tolerate recursive calls */
1382   if (++vlib_worker_threads[0].recursion_level > 1)
1383     {
1384       barrier_trace_sync_rec (t_entry);
1385       return;
1386     }
1387
1388   vlib_worker_threads[0].barrier_sync_count++;
1389
1390   /* Enforce minimum barrier open time to minimize packet loss */
1391   ASSERT (vm->barrier_no_close_before <= (now + BARRIER_MINIMUM_OPEN_LIMIT));
1392
1393   while (1)
1394     {
1395       now = vlib_time_now (vm);
1396       /* Barrier hold-down timer expired? */
1397       if (now >= vm->barrier_no_close_before)
1398         break;
1399       if ((vm->barrier_no_close_before - now)
1400           > (2.0 * BARRIER_MINIMUM_OPEN_LIMIT))
1401         {
1402           clib_warning ("clock change: would have waited for %.4f seconds",
1403                         (vm->barrier_no_close_before - now));
1404           break;
1405         }
1406     }
1407   /* Record time of closure */
1408   t_open = now - vm->barrier_epoch;
1409   vm->barrier_epoch = now;
1410
1411   deadline = now + BARRIER_SYNC_TIMEOUT;
1412
1413   *vlib_worker_threads->wait_at_barrier = 1;
1414   while (*vlib_worker_threads->workers_at_barrier != count)
1415     {
1416       if ((now = vlib_time_now (vm)) > deadline)
1417         {
1418           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1419           os_panic ();
1420         }
1421     }
1422
1423   t_closed = now - vm->barrier_epoch;
1424
1425   barrier_trace_sync (t_entry, t_open, t_closed);
1426
1427 }
1428
1429 void vlib_stat_segment_lock (void) __attribute__ ((weak));
1430 void
1431 vlib_stat_segment_lock (void)
1432 {
1433 }
1434
1435 void vlib_stat_segment_unlock (void) __attribute__ ((weak));
1436 void
1437 vlib_stat_segment_unlock (void)
1438 {
1439 }
1440
1441 void
1442 vlib_worker_thread_barrier_release (vlib_main_t * vm)
1443 {
1444   f64 deadline;
1445   f64 now;
1446   f64 minimum_open;
1447   f64 t_entry;
1448   f64 t_closed_total;
1449   f64 t_update_main = 0.0;
1450   int refork_needed = 0;
1451
1452   if (vec_len (vlib_mains) < 2)
1453     return;
1454
1455   ASSERT (vlib_get_thread_index () == 0);
1456
1457
1458   now = vlib_time_now (vm);
1459   t_entry = now - vm->barrier_epoch;
1460
1461   if (--vlib_worker_threads[0].recursion_level > 0)
1462     {
1463       barrier_trace_release_rec (t_entry);
1464       return;
1465     }
1466
1467   /* Update (all) node runtimes before releasing the barrier, if needed */
1468   if (vm->need_vlib_worker_thread_node_runtime_update)
1469     {
1470       /*
1471        * Lock stat segment here, so we's safe when
1472        * rebuilding the stat segment node clones from the
1473        * stat thread...
1474        */
1475       vlib_stat_segment_lock ();
1476
1477       /* Do stats elements on main thread */
1478       worker_thread_node_runtime_update_internal ();
1479       vm->need_vlib_worker_thread_node_runtime_update = 0;
1480
1481       /* Do per thread rebuilds in parallel */
1482       refork_needed = 1;
1483       clib_atomic_fetch_add (vlib_worker_threads->node_reforks_required,
1484                              (vec_len (vlib_mains) - 1));
1485       now = vlib_time_now (vm);
1486       t_update_main = now - vm->barrier_epoch;
1487     }
1488
1489   deadline = now + BARRIER_SYNC_TIMEOUT;
1490
1491   *vlib_worker_threads->wait_at_barrier = 0;
1492
1493   while (*vlib_worker_threads->workers_at_barrier > 0)
1494     {
1495       if ((now = vlib_time_now (vm)) > deadline)
1496         {
1497           fformat (stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1498           os_panic ();
1499         }
1500     }
1501
1502   /* Wait for reforks before continuing */
1503   if (refork_needed)
1504     {
1505       now = vlib_time_now (vm);
1506
1507       deadline = now + BARRIER_SYNC_TIMEOUT;
1508
1509       while (*vlib_worker_threads->node_reforks_required > 0)
1510         {
1511           if ((now = vlib_time_now (vm)) > deadline)
1512             {
1513               fformat (stderr, "%s: worker thread refork deadlock\n",
1514                        __FUNCTION__);
1515               os_panic ();
1516             }
1517         }
1518       vlib_stat_segment_unlock ();
1519     }
1520
1521   t_closed_total = now - vm->barrier_epoch;
1522
1523   minimum_open = t_closed_total * BARRIER_MINIMUM_OPEN_FACTOR;
1524
1525   if (minimum_open > BARRIER_MINIMUM_OPEN_LIMIT)
1526     {
1527       minimum_open = BARRIER_MINIMUM_OPEN_LIMIT;
1528     }
1529
1530   vm->barrier_no_close_before = now + minimum_open;
1531
1532   /* Record barrier epoch (used to enforce minimum open time) */
1533   vm->barrier_epoch = now;
1534
1535   barrier_trace_release (t_entry, t_closed_total, t_update_main);
1536
1537 }
1538
1539 /*
1540  * Check the frame queue to see if any frames are available.
1541  * If so, pull the packets off the frames and put them to
1542  * the handoff node.
1543  */
1544 int
1545 vlib_frame_queue_dequeue (vlib_main_t * vm, vlib_frame_queue_main_t * fqm)
1546 {
1547   u32 thread_id = vm->thread_index;
1548   vlib_frame_queue_t *fq = fqm->vlib_frame_queues[thread_id];
1549   vlib_frame_queue_elt_t *elt;
1550   u32 *from, *to;
1551   vlib_frame_t *f;
1552   int msg_type;
1553   int processed = 0;
1554   u32 n_left_to_node;
1555   u32 vectors = 0;
1556
1557   ASSERT (fq);
1558   ASSERT (vm == vlib_mains[thread_id]);
1559
1560   if (PREDICT_FALSE (fqm->node_index == ~0))
1561     return 0;
1562   /*
1563    * Gather trace data for frame queues
1564    */
1565   if (PREDICT_FALSE (fq->trace))
1566     {
1567       frame_queue_trace_t *fqt;
1568       frame_queue_nelt_counter_t *fqh;
1569       u32 elix;
1570
1571       fqt = &fqm->frame_queue_traces[thread_id];
1572
1573       fqt->nelts = fq->nelts;
1574       fqt->head = fq->head;
1575       fqt->head_hint = fq->head_hint;
1576       fqt->tail = fq->tail;
1577       fqt->threshold = fq->vector_threshold;
1578       fqt->n_in_use = fqt->tail - fqt->head;
1579       if (fqt->n_in_use >= fqt->nelts)
1580         {
1581           // if beyond max then use max
1582           fqt->n_in_use = fqt->nelts - 1;
1583         }
1584
1585       /* Record the number of elements in use in the histogram */
1586       fqh = &fqm->frame_queue_histogram[thread_id];
1587       fqh->count[fqt->n_in_use]++;
1588
1589       /* Record a snapshot of the elements in use */
1590       for (elix = 0; elix < fqt->nelts; elix++)
1591         {
1592           elt = fq->elts + ((fq->head + 1 + elix) & (fq->nelts - 1));
1593           if (1 || elt->valid)
1594             {
1595               fqt->n_vectors[elix] = elt->n_vectors;
1596             }
1597         }
1598       fqt->written = 1;
1599     }
1600
1601   while (1)
1602     {
1603       if (fq->head == fq->tail)
1604         {
1605           fq->head_hint = fq->head;
1606           return processed;
1607         }
1608
1609       elt = fq->elts + ((fq->head + 1) & (fq->nelts - 1));
1610
1611       if (!elt->valid)
1612         {
1613           fq->head_hint = fq->head;
1614           return processed;
1615         }
1616
1617       from = elt->buffer_index;
1618       msg_type = elt->msg_type;
1619
1620       ASSERT (msg_type == VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME);
1621       ASSERT (elt->n_vectors <= VLIB_FRAME_SIZE);
1622
1623       f = vlib_get_frame_to_node (vm, fqm->node_index);
1624
1625       to = vlib_frame_vector_args (f);
1626
1627       n_left_to_node = elt->n_vectors;
1628
1629       while (n_left_to_node >= 4)
1630         {
1631           to[0] = from[0];
1632           to[1] = from[1];
1633           to[2] = from[2];
1634           to[3] = from[3];
1635           to += 4;
1636           from += 4;
1637           n_left_to_node -= 4;
1638         }
1639
1640       while (n_left_to_node > 0)
1641         {
1642           to[0] = from[0];
1643           to++;
1644           from++;
1645           n_left_to_node--;
1646         }
1647
1648       vectors += elt->n_vectors;
1649       f->n_vectors = elt->n_vectors;
1650       vlib_put_frame_to_node (vm, fqm->node_index, f);
1651
1652       elt->valid = 0;
1653       elt->n_vectors = 0;
1654       elt->msg_type = 0xfefefefe;
1655       CLIB_MEMORY_BARRIER ();
1656       fq->head++;
1657       processed++;
1658
1659       /*
1660        * Limit the number of packets pushed into the graph
1661        */
1662       if (vectors >= fq->vector_threshold)
1663         {
1664           fq->head_hint = fq->head;
1665           return processed;
1666         }
1667     }
1668   ASSERT (0);
1669   return processed;
1670 }
1671
1672 void
1673 vlib_worker_thread_fn (void *arg)
1674 {
1675   vlib_worker_thread_t *w = (vlib_worker_thread_t *) arg;
1676   vlib_thread_main_t *tm = vlib_get_thread_main ();
1677   vlib_main_t *vm = vlib_get_main ();
1678   clib_error_t *e;
1679
1680   ASSERT (vm->thread_index == vlib_get_thread_index ());
1681
1682   vlib_worker_thread_init (w);
1683   clib_time_init (&vm->clib_time);
1684   clib_mem_set_heap (w->thread_mheap);
1685
1686   /* Wait until the dpdk init sequence is complete */
1687   while (tm->extern_thread_mgmt && tm->worker_thread_release == 0)
1688     vlib_worker_thread_barrier_check ();
1689
1690   e = vlib_call_init_exit_functions
1691     (vm, vm->worker_init_function_registrations, 1 /* call_once */ );
1692   if (e)
1693     clib_error_report (e);
1694
1695   vlib_worker_loop (vm);
1696 }
1697
1698 /* *INDENT-OFF* */
1699 VLIB_REGISTER_THREAD (worker_thread_reg, static) = {
1700   .name = "workers",
1701   .short_name = "wk",
1702   .function = vlib_worker_thread_fn,
1703 };
1704 /* *INDENT-ON* */
1705
1706 u32
1707 vlib_frame_queue_main_init (u32 node_index, u32 frame_queue_nelts)
1708 {
1709   vlib_thread_main_t *tm = vlib_get_thread_main ();
1710   vlib_frame_queue_main_t *fqm;
1711   vlib_frame_queue_t *fq;
1712   int i;
1713
1714   if (frame_queue_nelts == 0)
1715     frame_queue_nelts = FRAME_QUEUE_NELTS;
1716
1717   ASSERT (frame_queue_nelts >= 8);
1718
1719   vec_add2 (tm->frame_queue_mains, fqm, 1);
1720
1721   fqm->node_index = node_index;
1722   fqm->frame_queue_nelts = frame_queue_nelts;
1723   fqm->queue_hi_thresh = frame_queue_nelts - 2;
1724
1725   vec_validate (fqm->vlib_frame_queues, tm->n_vlib_mains - 1);
1726   vec_validate (fqm->per_thread_data, tm->n_vlib_mains - 1);
1727   _vec_len (fqm->vlib_frame_queues) = 0;
1728   for (i = 0; i < tm->n_vlib_mains; i++)
1729     {
1730       vlib_frame_queue_per_thread_data_t *ptd;
1731       fq = vlib_frame_queue_alloc (frame_queue_nelts);
1732       vec_add1 (fqm->vlib_frame_queues, fq);
1733
1734       ptd = vec_elt_at_index (fqm->per_thread_data, i);
1735       vec_validate (ptd->handoff_queue_elt_by_thread_index,
1736                     tm->n_vlib_mains - 1);
1737       vec_validate_init_empty (ptd->congested_handoff_queue_by_thread_index,
1738                                tm->n_vlib_mains - 1,
1739                                (vlib_frame_queue_t *) (~0));
1740     }
1741
1742   return (fqm - tm->frame_queue_mains);
1743 }
1744
1745 int
1746 vlib_thread_cb_register (struct vlib_main_t *vm, vlib_thread_callbacks_t * cb)
1747 {
1748   vlib_thread_main_t *tm = vlib_get_thread_main ();
1749
1750   if (tm->extern_thread_mgmt)
1751     return -1;
1752
1753   tm->cb.vlib_launch_thread_cb = cb->vlib_launch_thread_cb;
1754   tm->extern_thread_mgmt = 1;
1755   return 0;
1756 }
1757
1758 void
1759 vlib_process_signal_event_mt_helper (vlib_process_signal_event_mt_args_t *
1760                                      args)
1761 {
1762   ASSERT (vlib_get_thread_index () == 0);
1763   vlib_process_signal_event (vlib_get_main (), args->node_index,
1764                              args->type_opaque, args->data);
1765 }
1766
1767 void *rpc_call_main_thread_cb_fn;
1768
1769 void
1770 vlib_rpc_call_main_thread (void *callback, u8 * args, u32 arg_size)
1771 {
1772   if (rpc_call_main_thread_cb_fn)
1773     {
1774       void (*fp) (void *, u8 *, u32) = rpc_call_main_thread_cb_fn;
1775       (*fp) (callback, args, arg_size);
1776     }
1777   else
1778     clib_warning ("BUG: rpc_call_main_thread_cb_fn NULL!");
1779 }
1780
1781 clib_error_t *
1782 threads_init (vlib_main_t * vm)
1783 {
1784   return 0;
1785 }
1786
1787 VLIB_INIT_FUNCTION (threads_init);
1788
1789 /*
1790  * fd.io coding-style-patch-verification: ON
1791  *
1792  * Local Variables:
1793  * eval: (c-set-style "gnu")
1794  * End:
1795  */