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