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