vlib/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 #include <signal.h>
  16 #include <math.h>
  17 #include <vppinfra/format.h>
  18 #include <vlib/vlib.h>
  19
  20 #include <vlib/threads.h>
  21 #include <vlib/unix/physmem.h>
  22
  23 #include <vlib/unix/cj.h>
  24
  25 #if DPDK==1
  26 #include <rte_config.h>
  27 #include <rte_common.h>
  28 #include <rte_eal.h>
  29 #include <rte_launch.h>
  30 #include <rte_lcore.h>
  31 #endif
  32 DECLARE_CJ_GLOBAL_LOG;
  33
  34 #define FRAME_QUEUE_NELTS 32
  35
  36
  37 #if DPDK==1
  38 /*
  39  *  Weak definitions of DPDK symbols used in this file.
  40  *  Needed for linking test programs without DPDK libs.
  41  */
  42 unsigned __thread      __attribute__((weak)) RTE_PER_LCORE(_lcore_id);
  43 struct lcore_config    __attribute__((weak)) lcore_config[];
  44 unsigned               __attribute__((weak)) rte_socket_id();
  45 int                    __attribute__((weak)) rte_eal_remote_launch();
  46 #endif
  47 u32 vl(void *p)
  48 {
  49   return vec_len (p);
  50 }
  51
  52 void debug_hex_bytes (u8 *s, u32 n)
  53 {
  54     fformat (stderr, "%U\n", format_hex_bytes, s, n);
  55 }
  56
  57 vlib_thread_main_t vlib_thread_main;
  58
  59 uword
  60 os_get_cpu_number (void)
  61 {
  62   void * sp;
  63   uword n;
  64   u32 len;
  65
  66   len = vec_len (vlib_thread_stacks);
  67   if (len == 0)
  68     return 0;
  69
  70   /* Get any old stack address. */
  71   sp = &sp;
  72
  73   n = ((uword)sp - (uword)vlib_thread_stacks[0])
  74       >> VLIB_LOG2_THREAD_STACK_SIZE;
  75
  76   /* "processes" have their own stacks, and they always run in thread 0 */
  77   n = n >= len ? 0 : n;
  78
  79   return n;
  80 }
  81
  82 void
  83 vlib_set_thread_name (char *name)
  84 {
  85   int pthread_setname_np (pthread_t __target_thread, const char *__name);
  86   pthread_t thread = pthread_self();
  87
  88   if (thread)
  89     pthread_setname_np(thread, name);
  90 }
  91
  92 static int sort_registrations_by_no_clone  (void *a0, void * a1)
  93 {
  94   vlib_thread_registration_t ** tr0 = a0;
  95   vlib_thread_registration_t ** tr1 = a1;
  96
  97   return ((i32)((*tr0)->no_data_structure_clone)
  98           - ((i32)((*tr1)->no_data_structure_clone)));
  99 }
 100
 101 static uword *
 102 vlib_sysfs_list_to_bitmap(char * filename)
 103 {
 104   FILE *fp;
 105   uword *r = 0;
 106
 107   fp = fopen (filename, "r");
 108
 109   if (fp != NULL)
 110     {
 111       u8 * buffer = 0;
 112       vec_validate (buffer, 256-1);
 113       if (fgets ((char *)buffer, 256, fp))
 114         {
 115           unformat_input_t in;
 116           unformat_init_string (&in, (char *) buffer, strlen ((char *) buffer));
 117           unformat(&in, "%U", unformat_bitmap_list, &r);
 118           unformat_free (&in);
 119         }
 120       vec_free(buffer);
 121       fclose(fp);
 122     }
 123   return r;
 124 }
 125
 126
 127 /* Called early in the init sequence */
 128
 129 clib_error_t *
 130 vlib_thread_init (vlib_main_t * vm)
 131 {
 132   vlib_thread_main_t * tm = &vlib_thread_main;
 133   vlib_worker_thread_t * w;
 134   vlib_thread_registration_t * tr;
 135   u32 n_vlib_mains = 1;
 136   u32 first_index = 1;
 137   u32 i;
 138   uword * avail_cpu;
 139
 140   /* get bitmaps of active cpu cores and sockets */
 141   tm->cpu_core_bitmap =
 142     vlib_sysfs_list_to_bitmap("/sys/devices/system/cpu/online");
 143   tm->cpu_socket_bitmap =
 144     vlib_sysfs_list_to_bitmap("/sys/devices/system/node/online");
 145
 146   avail_cpu = clib_bitmap_dup(tm->cpu_core_bitmap);
 147
 148   /* skip cores */
 149   for (i=0; i < tm->skip_cores; i++)
 150     {
 151       uword c = clib_bitmap_first_set(avail_cpu);
 152       if (c == ~0)
 153         return clib_error_return (0, "no available cpus to skip");
 154
 155       avail_cpu = clib_bitmap_set(avail_cpu, c, 0);
 156     }
 157
 158   /* grab cpu for main thread */
 159   if (!tm->main_lcore)
 160     {
 161       tm->main_lcore = clib_bitmap_first_set(avail_cpu);
 162       if (tm->main_lcore == (u8) ~0)
 163         return clib_error_return (0, "no available cpus to be used for the"
 164                                   " main thread");
 165     }
 166   else
 167     {
 168       if (clib_bitmap_get(avail_cpu, tm->main_lcore) == 0)
 169         return clib_error_return (0, "cpu %u is not available to be used"
 170                                   " for the main thread", tm->main_lcore);
 171     }
 172   avail_cpu = clib_bitmap_set(avail_cpu, tm->main_lcore, 0);
 173
 174   /* assume that there is socket 0 only if there is no data from sysfs */
 175   if (!tm->cpu_socket_bitmap)
 176     tm->cpu_socket_bitmap = clib_bitmap_set(0, 0, 1);
 177
 178   /* as many threads as stacks... */
 179   vec_validate_aligned (vlib_worker_threads, vec_len(vlib_thread_stacks)-1,
 180                         CLIB_CACHE_LINE_BYTES);
 181
 182   /* Preallocate thread 0 */
 183   _vec_len(vlib_worker_threads) = 1;
 184   w = vlib_worker_threads;
 185   w->thread_mheap = clib_mem_get_heap();
 186   w->thread_stack = vlib_thread_stacks[0];
 187   w->dpdk_lcore_id = -1;
 188   w->lwp = syscall(SYS_gettid);
 189   tm->n_vlib_mains = 1;
 190
 191   /* assign threads to cores and set n_vlib_mains */
 192   tr = tm->next;
 193
 194   while (tr)
 195     {
 196       vec_add1 (tm->registrations, tr);
 197       tr = tr->next;
 198     }
 199
 200   vec_sort_with_function
 201     (tm->registrations, sort_registrations_by_no_clone);
 202
 203   for (i = 0; i < vec_len (tm->registrations); i++)
 204     {
 205       int j;
 206       tr = tm->registrations[i];
 207       tr->first_index = first_index;
 208       first_index += tr->count;
 209       n_vlib_mains += (tr->no_data_structure_clone == 0) ? tr->count : 0;
 210
 211       /* construct coremask */
 212       if (tr->use_pthreads || !tr->count)
 213         continue;
 214
 215       if (tr->coremask)
 216         {
 217           uword c;
 218           clib_bitmap_foreach (c, tr->coremask, ({
 219             if (clib_bitmap_get(avail_cpu, c) == 0)
 220               return clib_error_return (0, "cpu %u is not available to be used"
 221                                         " for the '%s' thread",c, tr->name);
 222
 223             avail_cpu = clib_bitmap_set(avail_cpu, c, 0);
 224           }));
 225
 226         }
 227       else
 228         {
 229           for (j=0; j < tr->count; j++)
 230             {
 231               uword c = clib_bitmap_first_set(avail_cpu);
 232               if (c == ~0)
 233               return clib_error_return (0, "no available cpus to be used for"
 234                                         " the '%s' thread", tr->name);
 235
 236               avail_cpu = clib_bitmap_set(avail_cpu, c, 0);
 237               tr->coremask = clib_bitmap_set(tr->coremask, c, 1);
 238             }
 239         }
 240     }
 241
 242   clib_bitmap_free(avail_cpu);
 243
 244   tm->n_vlib_mains = n_vlib_mains;
 245
 246   vec_validate_aligned (vlib_worker_threads, first_index-1,
 247                         CLIB_CACHE_LINE_BYTES);
 248
 249
 250   tm->efd.enabled = VLIB_EFD_DISABLED;
 251   tm->efd.queue_hi_thresh = ((VLIB_EFD_DEF_WORKER_HI_THRESH_PCT *
 252                               FRAME_QUEUE_NELTS)/100);
 253   return 0;
 254 }
 255
 256 vlib_worker_thread_t *
 257 vlib_alloc_thread (vlib_main_t * vm)
 258 {
 259   vlib_worker_thread_t * w;
 260
 261   if (vec_len(vlib_worker_threads) >= vec_len (vlib_thread_stacks))
 262     {
 263       clib_warning ("out of worker threads... Quitting...");
 264       exit(1);
 265     }
 266   vec_add2 (vlib_worker_threads, w, 1);
 267   w->thread_stack = vlib_thread_stacks[w - vlib_worker_threads];
 268   return w;
 269 }
 270
 271 vlib_frame_queue_t * vlib_frame_queue_alloc (int nelts)
 272 {
 273   vlib_frame_queue_t * fq;
 274
 275   fq = clib_mem_alloc_aligned(sizeof (*fq), CLIB_CACHE_LINE_BYTES);
 276   memset (fq, 0, sizeof (*fq));
 277   fq->nelts = nelts;
 278   fq->vector_threshold = 128; // packets
 279   vec_validate_aligned (fq->elts, nelts-1, CLIB_CACHE_LINE_BYTES);
 280
 281   if (1)
 282   {
 283     if (((uword)&fq->tail) & (CLIB_CACHE_LINE_BYTES - 1))
 284       fformat(stderr, "WARNING: fq->tail unaligned\n");
 285     if (((uword)&fq->head) & (CLIB_CACHE_LINE_BYTES - 1))
 286       fformat(stderr, "WARNING: fq->head unaligned\n");
 287     if (((uword)fq->elts) & (CLIB_CACHE_LINE_BYTES - 1))
 288       fformat(stderr, "WARNING: fq->elts unaligned\n");
 289
 290     if (sizeof (fq->elts[0]) % CLIB_CACHE_LINE_BYTES)
 291       fformat(stderr, "WARNING: fq->elts[0] size %d\n",
 292               sizeof (fq->elts[0]));
 293     if (nelts & (nelts -1))
 294       {
 295         fformat (stderr, "FATAL: nelts MUST be a power of 2\n");
 296         abort();
 297       }
 298   }
 299
 300   return (fq);
 301 }
 302
 303 void vl_msg_api_handler_no_free (void *) __attribute__ ((weak));
 304 void vl_msg_api_handler_no_free (void *v) { }
 305
 306 /* Turned off, save as reference material... */
 307 #if 0
 308 static inline int vlib_frame_queue_dequeue_internal (int thread_id,
 309                                                       vlib_main_t *vm,
 310                                                       vlib_node_main_t *nm)
 311 {
 312   vlib_frame_queue_t *fq = vlib_frame_queues[thread_id];
 313   vlib_frame_queue_elt_t *elt;
 314   vlib_frame_t *f;
 315   vlib_pending_frame_t *p;
 316   vlib_node_runtime_t *r;
 317   u32 node_runtime_index;
 318   int msg_type;
 319   u64 before;
 320   int processed = 0;
 321
 322   ASSERT(vm == vlib_mains[thread_id]);
 323
 324   while (1)
 325     {
 326       if (fq->head == fq->tail)
 327         return processed;
 328
 329       elt = fq->elts + ((fq->head+1) & (fq->nelts-1));
 330
 331       if (!elt->valid)
 332         return processed;
 333
 334       before = clib_cpu_time_now();
 335
 336       f = elt->frame;
 337       node_runtime_index = elt->node_runtime_index;
 338       msg_type = elt->msg_type;
 339
 340       switch (msg_type)
 341         {
 342         case VLIB_FRAME_QUEUE_ELT_FREE_BUFFERS:
 343           vlib_buffer_free (vm, vlib_frame_vector_args (f), f->n_vectors);
 344           /* note fallthrough... */
 345         case VLIB_FRAME_QUEUE_ELT_FREE_FRAME:
 346           r = vec_elt_at_index (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL],
 347                                 node_runtime_index);
 348           vlib_frame_free (vm, r, f);
 349           break;
 350         case VLIB_FRAME_QUEUE_ELT_DISPATCH_FRAME:
 351           vec_add2 (vm->node_main.pending_frames, p, 1);
 352           f->flags |= (VLIB_FRAME_PENDING | VLIB_FRAME_FREE_AFTER_DISPATCH);
 353           p->node_runtime_index = elt->node_runtime_index;
 354           p->frame_index = vlib_frame_index (vm, f);
 355           p->next_frame_index = VLIB_PENDING_FRAME_NO_NEXT_FRAME;
 356           fq->dequeue_vectors += (u64) f->n_vectors;
 357           break;
 358         case VLIB_FRAME_QUEUE_ELT_API_MSG:
 359           vl_msg_api_handler_no_free (f);
 360           break;
 361         default:
 362           clib_warning ("bogus frame queue message, type %d", msg_type);
 363           break;
 364         }
 365       elt->valid = 0;
 366       fq->dequeues++;
 367       fq->dequeue_ticks += clib_cpu_time_now() - before;
 368       CLIB_MEMORY_BARRIER();
 369       fq->head++;
 370       processed++;
 371     }
 372   ASSERT(0);
 373   return processed;
 374 }
 375
 376 int vlib_frame_queue_dequeue (int thread_id,
 377                                vlib_main_t *vm,
 378                                vlib_node_main_t *nm)
 379 {
 380   return vlib_frame_queue_dequeue_internal (thread_id, vm, nm);
 381 }
 382
 383 int vlib_frame_queue_enqueue (vlib_main_t *vm, u32 node_runtime_index,
 384                               u32 frame_queue_index, vlib_frame_t *frame,
 385                               vlib_frame_queue_msg_type_t type)
 386 {
 387   vlib_frame_queue_t *fq = vlib_frame_queues[frame_queue_index];
 388   vlib_frame_queue_elt_t *elt;
 389   u32 save_count;
 390   u64 new_tail;
 391   u64 before = clib_cpu_time_now();
 392
 393   ASSERT (fq);
 394
 395   new_tail = __sync_add_and_fetch (&fq->tail, 1);
 396
 397   /* Wait until a ring slot is available */
 398   while (new_tail >= fq->head + fq->nelts)
 399     {
 400       f64 b4 = vlib_time_now_ticks (vm, before);
 401       vlib_worker_thread_barrier_check (vm, b4);
 402       /* Bad idea. Dequeue -> enqueue -> dequeue -> trouble */
 403       // vlib_frame_queue_dequeue (vm->cpu_index, vm, nm);
 404     }
 405
 406   elt = fq->elts + (new_tail & (fq->nelts-1));
 407
 408   /* this would be very bad... */
 409   while (elt->valid)
 410     {
 411     }
 412
 413   /* Once we enqueue the frame, frame->n_vectors is owned elsewhere... */
 414   save_count = frame->n_vectors;
 415
 416   elt->frame = frame;
 417   elt->node_runtime_index = node_runtime_index;
 418   elt->msg_type = type;
 419   CLIB_MEMORY_BARRIER();
 420   elt->valid = 1;
 421
 422   return save_count;
 423 }
 424 #endif /* 0 */
 425
 426 /* To be called by vlib worker threads upon startup */
 427 void vlib_worker_thread_init (vlib_worker_thread_t * w)
 428 {
 429   vlib_thread_main_t *tm = vlib_get_thread_main();
 430
 431   /* worker threads wants no signals. */
 432   {
 433     sigset_t s;
 434     sigfillset (&s);
 435     pthread_sigmask (SIG_SETMASK, &s, 0);
 436   }
 437
 438   clib_mem_set_heap (w->thread_mheap);
 439
 440   if (vec_len(tm->thread_prefix) && w->registration->short_name)
 441     {
 442       w->name = format(0, "%v_%s_%d%c", tm->thread_prefix,
 443                                         w->registration->short_name,
 444                                         w->instance_id,
 445                                         '\0');
 446       vlib_set_thread_name((char *)w->name);
 447     }
 448
 449   if (!w->registration->use_pthreads)
 450     {
 451
 452       /* Initial barrier sync, for both worker and i/o threads */
 453       clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, 1);
 454
 455       while (*vlib_worker_threads->wait_at_barrier)
 456           ;
 457
 458       clib_smp_atomic_add (vlib_worker_threads->workers_at_barrier, -1);
 459     }
 460 }
 461
 462 void *vlib_worker_thread_bootstrap_fn (void *arg)
 463 {
 464   void *rv;
 465   vlib_worker_thread_t *w = arg;
 466
 467   w->lwp = syscall(SYS_gettid);
 468   w->dpdk_lcore_id = -1;
 469 #if DPDK==1
 470   if (w->registration && !w->registration->use_pthreads &&
 471       rte_socket_id) /* do we really have dpdk linked */
 472     {
 473       unsigned lcore = rte_lcore_id();
 474       lcore = lcore < RTE_MAX_LCORE ? lcore : -1;
 475       w->dpdk_lcore_id = lcore;
 476     }
 477 #endif
 478
 479   rv = (void *) clib_calljmp
 480       ((uword (*)(uword)) w->thread_function,
 481        (uword) arg, w->thread_stack + VLIB_THREAD_STACK_SIZE);
 482   /* NOTREACHED, we hope */
 483   return rv;
 484 }
 485
 486 static int
 487 vlib_launch_thread (void *fp, vlib_worker_thread_t *w, unsigned lcore_id)
 488 {
 489   pthread_t dummy;
 490   void *(*fp_arg)(void *) = fp;
 491
 492 #if DPDK==1
 493   if (!w->registration->use_pthreads)
 494     if (rte_eal_remote_launch) /* do we have dpdk linked */
 495       return rte_eal_remote_launch (fp, (void *)w, lcore_id);
 496     else
 497       return -1;
 498   else
 499 #endif
 500     return pthread_create (&dummy, NULL /* attr */, fp_arg, (void *)w);
 501 }
 502
 503 static clib_error_t * start_workers (vlib_main_t * vm)
 504 {
 505   int i, j;
 506   vlib_worker_thread_t *w;
 507   vlib_main_t *vm_clone;
 508   void *oldheap;
 509   vlib_frame_queue_t *fq;
 510   vlib_thread_main_t * tm = &vlib_thread_main;
 511   vlib_thread_registration_t * tr;
 512   vlib_node_runtime_t * rt;
 513   u32 n_vlib_mains = tm->n_vlib_mains;
 514   u32 worker_thread_index;
 515
 516   vec_reset_length (vlib_worker_threads);
 517
 518   /* Set up the main thread */
 519   vec_add2_aligned (vlib_worker_threads, w, 1, CLIB_CACHE_LINE_BYTES);
 520   w->elog_track.name = "thread 0";
 521   elog_track_register (&vm->elog_main, &w->elog_track);
 522
 523   if (vec_len(tm->thread_prefix))
 524     {
 525       w->name = format(0, "%v_main%c", tm->thread_prefix, '\0');
 526       vlib_set_thread_name((char *)w->name);
 527     }
 528
 529 #if DPDK==1
 530   w->dpdk_lcore_id = -1;
 531   if (rte_socket_id) /* do we really have dpdk linked */
 532     {
 533       unsigned lcore = rte_lcore_id();
 534       w->dpdk_lcore_id = lcore < RTE_MAX_LCORE ? lcore : -1;;
 535     }
 536 #endif
 537
 538   if (n_vlib_mains > 1)
 539     {
 540       u8 * heap = clib_mem_get_per_cpu_heap();
 541       mheap_t * h = mheap_header (heap);
 542
 543       /* make the main heap thread-safe */
 544       h->flags |= MHEAP_FLAG_THREAD_SAFE;
 545
 546       /* Make the event-log MP-safe */
 547       vm->elog_main.lock =
 548         clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
 549                                 CLIB_CACHE_LINE_BYTES);
 550
 551       vm->elog_main.lock[0] = 0;
 552
 553       vec_validate (vlib_mains, tm->n_vlib_mains - 1);
 554       _vec_len (vlib_mains) = 0;
 555       vec_add1 (vlib_mains, vm);
 556
 557       vec_validate (vlib_frame_queues, tm->n_vlib_mains - 1);
 558       _vec_len (vlib_frame_queues) = 0;
 559       fq = vlib_frame_queue_alloc (FRAME_QUEUE_NELTS);
 560       vec_add1 (vlib_frame_queues, fq);
 561
 562       vlib_worker_threads->wait_at_barrier =
 563         clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
 564       vlib_worker_threads->workers_at_barrier =
 565         clib_mem_alloc_aligned (sizeof (u32), CLIB_CACHE_LINE_BYTES);
 566
 567       /* Ask for an initial barrier sync */
 568       *vlib_worker_threads->workers_at_barrier = 0;
 569       *vlib_worker_threads->wait_at_barrier = 1;
 570
 571       worker_thread_index = 1;
 572
 573       for (i = 0; i < vec_len(tm->registrations); i++)
 574         {
 575           vlib_node_main_t *nm, *nm_clone;
 576           vlib_buffer_main_t *bm_clone;
 577           vlib_buffer_free_list_t *fl_clone, *fl_orig;
 578           vlib_buffer_free_list_t *orig_freelist_pool;
 579           int k;
 580
 581           tr = tm->registrations[i];
 582
 583           if (tr->count == 0)
 584             continue;
 585
 586           for (k = 0; k < tr->count; k++)
 587           {
 588             vec_add2 (vlib_worker_threads, w, 1);
 589             /*
 590              * Share the main heap which is now thread-safe.
 591              *
 592              * To allocate separate heaps, code:
 593              * mheap_alloc (0 / * use VM * /, tr->mheap_size);
 594              */
 595             w->thread_mheap = heap;
 596             w->thread_stack = vlib_thread_stacks[w - vlib_worker_threads];
 597             w->thread_function = tr->function;
 598             w->thread_function_arg = w;
 599             w->instance_id = k;
 600             w->registration = tr;
 601
 602             w->elog_track.name = (char *) format (0, "thread %d", i+1);
 603             vec_add1 (w->elog_track.name, 0);
 604             elog_track_register (&vm->elog_main, &w->elog_track);
 605
 606             if (tr->no_data_structure_clone)
 607               continue;
 608
 609             /* Allocate "to-worker-N" frame queue */
 610             fq = vlib_frame_queue_alloc (FRAME_QUEUE_NELTS);
 611             vec_validate (vlib_frame_queues, worker_thread_index);
 612             vlib_frame_queues[worker_thread_index] = fq;
 613
 614             /* Fork vlib_global_main et al. Look for bugs here */
 615             oldheap = clib_mem_set_heap (w->thread_mheap);
 616
 617             vm_clone = clib_mem_alloc (sizeof (*vm_clone));
 618             memcpy (vm_clone, vlib_mains[0], sizeof (*vm_clone));
 619
 620             vm_clone->cpu_index = worker_thread_index;
 621             vm_clone->heap_base = w->thread_mheap;
 622             vm_clone->mbuf_alloc_list = 0;
 623             memset (&vm_clone->random_buffer, 0, sizeof (vm_clone->random_buffer));
 624
 625             nm = &vlib_mains[0]->node_main;
 626             nm_clone = &vm_clone->node_main;
 627             /* fork next frames array, preserving node runtime indices */
 628             nm_clone->next_frames = vec_dup (nm->next_frames);
 629             for (j = 0; j < vec_len (nm_clone->next_frames); j++)
 630               {
 631                 vlib_next_frame_t *nf = &nm_clone->next_frames[j];
 632                 u32 save_node_runtime_index;
 633
 634                 save_node_runtime_index = nf->node_runtime_index;
 635                 vlib_next_frame_init (nf);
 636                 nf->node_runtime_index = save_node_runtime_index;
 637               }
 638
 639             /* fork the frame dispatch queue */
 640             nm_clone->pending_frames = 0;
 641             vec_validate (nm_clone->pending_frames, 10); /* $$$$$?????? */
 642             _vec_len (nm_clone->pending_frames) = 0;
 643
 644             /* fork nodes */
 645             nm_clone->nodes = 0;
 646             for (j = 0; j < vec_len (nm->nodes); j++)
 647               {
 648                 vlib_node_t *n;
 649                 n = clib_mem_alloc_no_fail (sizeof(*n));
 650                 memcpy (n, nm->nodes[j], sizeof (*n));
 651                 /* none of the copied nodes have enqueue rights given out */
 652                 n->owner_node_index = VLIB_INVALID_NODE_INDEX;
 653                 memset (&n->stats_total, 0, sizeof (n->stats_total));
 654                 memset (&n->stats_last_clear, 0, sizeof (n->stats_last_clear));
 655                 vec_add1 (nm_clone->nodes, n);
 656               }
 657             nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
 658               vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL]);
 659
 660             nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
 661               vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT]);
 662             vec_foreach(rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
 663               rt->cpu_index = vm_clone->cpu_index;
 664
 665             nm_clone->processes = vec_dup (nm->processes);
 666
 667             /* zap the (per worker) frame freelists, etc */
 668             nm_clone->frame_sizes = 0;
 669             nm_clone->frame_size_hash = 0;
 670
 671             /* Packet trace buffers are guaranteed to be empty, nothing to do here */
 672
 673             clib_mem_set_heap (oldheap);
 674             vec_add1 (vlib_mains, vm_clone);
 675
 676             unix_physmem_init (vm_clone, 0 /* physmem not required */);
 677
 678             vm_clone->error_main.counters =
 679               vec_dup(vlib_mains[0]->error_main.counters);
 680             vm_clone->error_main.counters_last_clear =
 681               vec_dup(vlib_mains[0]->error_main.counters_last_clear);
 682
 683             /* Fork the vlib_buffer_main_t free lists, etc. */
 684             bm_clone = vec_dup (vm_clone->buffer_main);
 685             vm_clone->buffer_main = bm_clone;
 686
 687             orig_freelist_pool = bm_clone->buffer_free_list_pool;
 688             bm_clone->buffer_free_list_pool = 0;
 689
 690             pool_foreach (fl_orig, orig_freelist_pool,
 691                           ({
 692                             pool_get_aligned (bm_clone->buffer_free_list_pool,
 693                                               fl_clone, CLIB_CACHE_LINE_BYTES);
 694                             ASSERT (fl_orig - orig_freelist_pool
 695                                     == fl_clone - bm_clone->buffer_free_list_pool);
 696
 697                             fl_clone[0] = fl_orig[0];
 698                             fl_clone->aligned_buffers = 0;
 699                             fl_clone->unaligned_buffers = 0;
 700                             fl_clone->n_alloc = 0;
 701                           }));
 702
 703             worker_thread_index++;
 704           }
 705         }
 706     }
 707   else
 708     {
 709       /* only have non-data-structure copy threads to create... */
 710       for (i = 0; i < vec_len(tm->registrations); i++)
 711         {
 712           tr = tm->registrations[i];
 713
 714           for (j = 0; j < tr->count; j++)
 715             {
 716               vec_add2 (vlib_worker_threads, w, 1);
 717               w->thread_mheap = mheap_alloc (0 /* use VM */, tr->mheap_size);
 718               w->thread_stack = vlib_thread_stacks[w - vlib_worker_threads];
 719               w->thread_function = tr->function;
 720               w->thread_function_arg = w;
 721               w->instance_id = j;
 722               w->elog_track.name = (char *) format (0, "thread %d", i+1);
 723               w->registration = tr;
 724               vec_add1 (w->elog_track.name, 0);
 725               elog_track_register (&vm->elog_main, &w->elog_track);
 726             }
 727         }
 728     }
 729
 730   worker_thread_index = 1;
 731
 732   for (i = 0; i < vec_len (tm->registrations); i++)
 733     {
 734       int j;
 735
 736       tr = tm->registrations[i];
 737
 738       if (tr->use_pthreads || tm->use_pthreads)
 739         {
 740           for (j = 0; j < tr->count; j++)
 741             {
 742               w = vlib_worker_threads + worker_thread_index++;
 743               if (vlib_launch_thread (vlib_worker_thread_bootstrap_fn, w, 0) < 0)
 744                 clib_warning ("Couldn't start '%s' pthread ", tr->name);
 745             }
 746         }
 747       else
 748         {
 749             uword c;
 750             clib_bitmap_foreach (c, tr->coremask, ({
 751               w = vlib_worker_threads + worker_thread_index++;
 752               if (vlib_launch_thread (vlib_worker_thread_bootstrap_fn, w, c) < 0)
 753                 clib_warning ("Couldn't start DPDK lcore %d", c);
 754
 755             }));
 756         }
 757     }
 758   vlib_worker_thread_barrier_sync(vm);
 759   vlib_worker_thread_barrier_release(vm);
 760   return 0;
 761 }
 762
 763 VLIB_MAIN_LOOP_ENTER_FUNCTION (start_workers);
 764
 765 void vlib_worker_thread_node_runtime_update(void)
 766 {
 767   int i, j;
 768   vlib_worker_thread_t *w;
 769   vlib_main_t *vm;
 770   vlib_node_main_t *nm, *nm_clone;
 771   vlib_node_t ** old_nodes_clone;
 772   vlib_main_t *vm_clone;
 773   vlib_node_runtime_t * rt, * old_rt;
 774   void *oldheap;
 775   never_inline void
 776     vlib_node_runtime_sync_stats (vlib_main_t * vm,
 777                                   vlib_node_runtime_t * r,
 778                                   uword n_calls,
 779                                   uword n_vectors,
 780                                   uword n_clocks);
 781
 782   ASSERT (os_get_cpu_number() == 0);
 783
 784   if (vec_len (vlib_mains) == 0)
 785     return;
 786
 787   vm = vlib_mains[0];
 788   nm = &vm->node_main;
 789
 790   ASSERT (os_get_cpu_number() == 0);
 791   ASSERT (*vlib_worker_threads->wait_at_barrier == 1);
 792
 793   /*
 794    * Scrape all runtime stats, so we don't lose node runtime(s) with
 795    * pending counts, or throw away worker / io thread counts.
 796    */
 797   for (j = 0; j < vec_len (nm->nodes); j++)
 798     {
 799       vlib_node_t * n;
 800       n = nm->nodes[j];
 801       vlib_node_sync_stats (vm, n);
 802     }
 803
 804   for (i = 1; i < vec_len (vlib_mains); i++)
 805     {
 806       vlib_node_t * n;
 807
 808       vm_clone = vlib_mains[i];
 809       nm_clone = &vm_clone->node_main;
 810
 811       for (j = 0; j < vec_len (nm_clone->nodes); j++)
 812         {
 813           n = nm_clone->nodes[j];
 814
 815           rt = vlib_node_get_runtime (vm_clone, n->index);
 816           vlib_node_runtime_sync_stats (vm_clone, rt, 0, 0, 0);
 817         }
 818     }
 819
 820   for (i = 1; i < vec_len (vlib_mains); i++)
 821     {
 822       vlib_node_runtime_t * rt;
 823       w = vlib_worker_threads + i;
 824       oldheap = clib_mem_set_heap (w->thread_mheap);
 825
 826       vm_clone = vlib_mains[i];
 827
 828       /* Re-clone error heap */
 829       u64 * old_counters = vm_clone->error_main.counters;
 830       u64 * old_counters_all_clear = vm_clone->error_main.counters_last_clear;
 831       memcpy (&vm_clone->error_main, &vm->error_main, sizeof (vm->error_main));
 832       j = vec_len(vm->error_main.counters) - 1;
 833       vec_validate_aligned(old_counters, j, CLIB_CACHE_LINE_BYTES);
 834       vec_validate_aligned(old_counters_all_clear, j, CLIB_CACHE_LINE_BYTES);
 835       vm_clone->error_main.counters = old_counters;
 836       vm_clone->error_main.counters_last_clear = old_counters_all_clear;
 837
 838       nm_clone = &vm_clone->node_main;
 839       vec_free (nm_clone->next_frames);
 840       nm_clone->next_frames = vec_dup (nm->next_frames);
 841
 842       for (j = 0; j < vec_len (nm_clone->next_frames); j++)
 843         {
 844           vlib_next_frame_t *nf = &nm_clone->next_frames[j];
 845           u32 save_node_runtime_index;
 846
 847           save_node_runtime_index = nf->node_runtime_index;
 848           vlib_next_frame_init (nf);
 849           nf->node_runtime_index = save_node_runtime_index;
 850         }
 851
 852       old_nodes_clone = nm_clone->nodes;
 853       nm_clone->nodes = 0;
 854
 855       /* re-fork nodes */
 856       for (j = 0; j < vec_len (nm->nodes); j++) {
 857         vlib_node_t *old_n_clone;
 858         vlib_node_t *new_n, *new_n_clone;
 859
 860         new_n = nm->nodes[j];
 861         old_n_clone = old_nodes_clone[j];
 862
 863         new_n_clone = clib_mem_alloc_no_fail (sizeof(*new_n_clone));
 864         memcpy (new_n_clone, new_n, sizeof (*new_n));
 865         /* none of the copied nodes have enqueue rights given out */
 866         new_n_clone->owner_node_index = VLIB_INVALID_NODE_INDEX;
 867
 868         if (j >= vec_len (old_nodes_clone))
 869           {
 870             /* new node, set to zero */
 871             memset (&new_n_clone->stats_total, 0,
 872                     sizeof (new_n_clone->stats_total));
 873             memset (&new_n_clone->stats_last_clear, 0,
 874                     sizeof (new_n_clone->stats_last_clear));
 875           }
 876         else
 877           {
 878             /* Copy stats if the old data is valid */
 879             memcpy (&new_n_clone->stats_total,
 880                     &old_n_clone->stats_total,
 881                     sizeof (new_n_clone->stats_total));
 882             memcpy (&new_n_clone->stats_last_clear,
 883                     &old_n_clone->stats_last_clear,
 884                     sizeof (new_n_clone->stats_last_clear));
 885
 886             /* keep previous node state */
 887             new_n_clone->state = old_n_clone->state;
 888           }
 889         vec_add1 (nm_clone->nodes, new_n_clone);
 890       }
 891       /* Free the old node clone */
 892       for (j = 0; j < vec_len(old_nodes_clone); j++)
 893         clib_mem_free (old_nodes_clone[j]);
 894       vec_free (old_nodes_clone);
 895
 896       vec_free (nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL]);
 897
 898       nm_clone->nodes_by_type[VLIB_NODE_TYPE_INTERNAL] =
 899           vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL]);
 900
 901       /* clone input node runtime */
 902       old_rt = nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT];
 903
 904       nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT] =
 905         vec_dup (nm->nodes_by_type[VLIB_NODE_TYPE_INPUT]);
 906
 907       vec_foreach(rt, nm_clone->nodes_by_type[VLIB_NODE_TYPE_INPUT])
 908         {
 909           rt->cpu_index = vm_clone->cpu_index;
 910         }
 911
 912       for (j=0; j < vec_len(old_rt); j++)
 913         {
 914           rt = vlib_node_get_runtime (vm_clone, old_rt[j].node_index);
 915           rt->state = old_rt[j].state;
 916         }
 917
 918       vec_free(old_rt);
 919
 920       nm_clone->processes = vec_dup (nm->processes);
 921
 922       clib_mem_set_heap (oldheap);
 923
 924       // vnet_main_fork_fixup (i);
 925     }
 926 }
 927
 928 static clib_error_t *
 929 cpu_config (vlib_main_t * vm, unformat_input_t * input)
 930 {
 931   vlib_thread_registration_t *tr;
 932   uword * p;
 933   vlib_thread_main_t * tm = &vlib_thread_main;
 934   u8 * name;
 935   u64 coremask;
 936   uword * bitmap;
 937   u32 count;
 938
 939   tm->thread_registrations_by_name = hash_create_string (0, sizeof (uword));
 940   tm->n_thread_stacks = 1;      /* account for main thread */
 941
 942   tr = tm->next;
 943
 944   while (tr)
 945     {
 946       hash_set_mem (tm->thread_registrations_by_name, tr->name, (uword)tr);
 947       tr = tr->next;
 948     }
 949
 950   while (unformat_check_input(input) != UNFORMAT_END_OF_INPUT)
 951     {
 952       if (unformat (input, "main-thread-io"))
 953         tm->main_thread_is_io_node = 1;
 954       else if (unformat (input, "use-pthreads"))
 955         tm->use_pthreads = 1;
 956       else if (unformat (input, "thread-prefix %v", &tm->thread_prefix))
 957           ;
 958       else if (unformat (input, "main-core %u", &tm->main_lcore))
 959           ;
 960       else if (unformat (input, "skip-cores %u", &tm->skip_cores))
 961           ;
 962       else if (unformat (input, "coremask-%s %llx", &name, &coremask))
 963         {
 964           p = hash_get_mem (tm->thread_registrations_by_name, name);
 965           if (p == 0)
 966             return clib_error_return (0, "no such thread type '%s'", name);
 967
 968           tr = (vlib_thread_registration_t *)p[0];
 969
 970           if  (tr->use_pthreads)
 971             return clib_error_return (0, "coremask cannot be set for '%s' threads",
 972                                       name);
 973
 974           tr->coremask = clib_bitmap_set_multiple
 975             (tr->coremask, 0, coremask, BITS(coremask));
 976           tr->count = clib_bitmap_count_set_bits (tr->coremask);
 977         }
 978       else if (unformat (input, "corelist-%s %U", &name, unformat_bitmap_list,
 979                &bitmap))
 980         {
 981           p = hash_get_mem (tm->thread_registrations_by_name, name);
 982           if (p == 0)
 983             return clib_error_return (0, "no such thread type '%s'", name);
 984
 985           tr = (vlib_thread_registration_t *)p[0];
 986
 987           if  (tr->use_pthreads)
 988             return clib_error_return (0, "corelist cannot be set for '%s' threads",
 989                                       name);
 990
 991           tr->coremask = bitmap;
 992           tr->count = clib_bitmap_count_set_bits (tr->coremask);
 993         }
 994       else if (unformat (input, "%s %u", &name, &count))
 995         {
 996           p = hash_get_mem (tm->thread_registrations_by_name, name);
 997           if (p == 0)
 998               return clib_error_return (0, "no such thread type '%s'", name);
 999
1000           tr = (vlib_thread_registration_t *)p[0];
1001           if (tr->fixed_count)
1002             return clib_error_return
1003               (0, "number of %s threads not configurable", tr->name);
1004           tr->count = count;
1005         }
1006       else
1007         break;
1008     }
1009
1010   tr = tm->next;
1011
1012   if (!tm->thread_prefix)
1013     tm->thread_prefix = format(0, "vpp");
1014
1015   while (tr)
1016     {
1017       tm->n_thread_stacks += tr->count;
1018       tm->n_pthreads += tr->count * tr->use_pthreads;
1019       tm->n_eal_threads += tr->count * (tr->use_pthreads == 0);
1020       tr = tr->next;
1021     }
1022
1023   return 0;
1024 }
1025
1026 VLIB_EARLY_CONFIG_FUNCTION (cpu_config, "cpu");
1027
1028 #if !defined (__x86_64__) && !defined (__aarch64__) && !defined (__powerpc64__)
1029 void __sync_fetch_and_add_8 (void)
1030 {
1031   fformat(stderr, "%s called\n", __FUNCTION__);
1032   abort();
1033 }
1034 void __sync_add_and_fetch_8 (void)
1035 {
1036   fformat(stderr, "%s called\n", __FUNCTION__);
1037   abort();
1038 }
1039 #endif
1040
1041 void vnet_main_fixup (vlib_fork_fixup_t which) __attribute__ ((weak));
1042 void vnet_main_fixup (vlib_fork_fixup_t which) { }
1043
1044 void vlib_worker_thread_fork_fixup (vlib_fork_fixup_t which)
1045 {
1046   vlib_main_t * vm = vlib_get_main();
1047
1048   if (vlib_mains == 0)
1049     return;
1050
1051   ASSERT(os_get_cpu_number() == 0);
1052   vlib_worker_thread_barrier_sync(vm);
1053
1054   switch (which)
1055     {
1056     case VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX:
1057       vnet_main_fixup (VLIB_WORKER_THREAD_FORK_FIXUP_NEW_SW_IF_INDEX);
1058       break;
1059
1060     default:
1061       ASSERT(0);
1062     }
1063   vlib_worker_thread_barrier_release(vm);
1064 }
1065
1066 void vlib_worker_thread_barrier_sync(vlib_main_t *vm)
1067 {
1068   f64 deadline;
1069   u32 count;
1070
1071   if (!vlib_mains)
1072       return;
1073
1074   count = vec_len (vlib_mains) - 1;
1075
1076   /* Tolerate recursive calls */
1077   if (++vlib_worker_threads[0].recursion_level > 1)
1078       return;
1079
1080   ASSERT (os_get_cpu_number() == 0);
1081
1082   deadline = vlib_time_now (vm) + BARRIER_SYNC_TIMEOUT;
1083
1084   *vlib_worker_threads->wait_at_barrier = 1;
1085   while (*vlib_worker_threads->workers_at_barrier != count)
1086     {
1087       if (vlib_time_now(vm) > deadline)
1088         {
1089           fformat(stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1090           os_panic();
1091         }
1092     }
1093 }
1094
1095 void vlib_worker_thread_barrier_release(vlib_main_t * vm)
1096 {
1097   f64 deadline;
1098
1099   if (!vlib_mains)
1100       return;
1101
1102   if (--vlib_worker_threads[0].recursion_level > 0)
1103     return;
1104
1105   deadline = vlib_time_now (vm) + BARRIER_SYNC_TIMEOUT;
1106
1107   *vlib_worker_threads->wait_at_barrier = 0;
1108
1109   while (*vlib_worker_threads->workers_at_barrier > 0)
1110     {
1111       if (vlib_time_now(vm) > deadline)
1112         {
1113           fformat(stderr, "%s: worker thread deadlock\n", __FUNCTION__);
1114           os_panic();
1115         }
1116     }
1117 }
1118
1119 static clib_error_t *
1120 show_threads_fn (vlib_main_t * vm,
1121        unformat_input_t * input,
1122        vlib_cli_command_t * cmd)
1123 {
1124   vlib_worker_thread_t * w;
1125   int i;
1126
1127   vlib_cli_output (vm, "%-7s%-20s%-12s%-8s%-7s%-7s%-7s%-10s",
1128                    "ID", "Name", "Type", "LWP",
1129                    "lcore", "Core", "Socket", "State");
1130
1131 #if !defined(__powerpc64__)
1132   for (i = 0; i < vec_len(vlib_worker_threads); i++)
1133     {
1134       w = vlib_worker_threads + i;
1135       u8 * line = NULL;
1136
1137       line = format(line, "%-7d%-20s%-12s%-8d",
1138                     i,
1139                     w->name ? w->name : (u8 *) "",
1140                     w->registration ? w->registration->name : "",
1141                     w->lwp);
1142
1143       int lcore = w->dpdk_lcore_id;
1144       if (lcore > -1)
1145         {
1146           line = format(line, "%-7u%-7u%-7u",
1147                         lcore,
1148                         lcore_config[lcore].core_id,
1149                         lcore_config[lcore].socket_id);
1150
1151           switch(lcore_config[lcore].state)
1152             {
1153               case WAIT:
1154                 line = format(line, "wait");
1155                 break;
1156               case RUNNING:
1157                 line = format(line, "running");
1158                 break;
1159               case FINISHED:
1160                 line = format(line, "finished");
1161                 break;
1162               default:
1163                 line = format(line, "unknown");
1164             }
1165         }
1166
1167       vlib_cli_output(vm, "%v", line);
1168       vec_free(line);
1169     }
1170 #endif
1171
1172   return 0;
1173 }
1174
1175
1176 VLIB_CLI_COMMAND (show_threads_command, static) = {
1177   .path = "show threads",
1178   .short_help = "Show threads",
1179   .function = show_threads_fn,
1180 };