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