src/vlib/threads.c

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