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