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