src/vpp/stats/stat_segment.c

   1 /*
   2  * Copyright (c) 2018 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
  16 #include <vppinfra/mem.h>
  17 #include <vlib/vlib.h>
  18 #include <vlib/unix/unix.h>
  19 #include "stat_segment.h"
  20 #include <vnet/vnet.h>
  21 #include <vnet/devices/devices.h>       /* vnet_get_aggregate_rx_packets */
  22 #undef HAVE_MEMFD_CREATE
  23 #include <vppinfra/linux/syscall.h>
  24 #include <vpp-api/client/stat_client.h>
  25 #include <vppinfra/mheap.h>
  26
  27 stat_segment_main_t stat_segment_main;
  28
  29 /*
  30  *  Used only by VPP writers
  31  */
  32 void
  33 vlib_stat_segment_lock (void)
  34 {
  35   stat_segment_main_t *sm = &stat_segment_main;
  36   clib_spinlock_lock (sm->stat_segment_lockp);
  37   sm->shared_header->in_progress = 1;
  38 }
  39
  40 void
  41 vlib_stat_segment_unlock (void)
  42 {
  43   stat_segment_main_t *sm = &stat_segment_main;
  44   sm->shared_header->epoch++;
  45   sm->shared_header->in_progress = 0;
  46   clib_spinlock_unlock (sm->stat_segment_lockp);
  47 }
  48
  49 /*
  50  * Change heap to the stats shared memory segment
  51  */
  52 void *
  53 vlib_stats_push_heap (void *old)
  54 {
  55   stat_segment_main_t *sm = &stat_segment_main;
  56
  57   sm->last = old;
  58   ASSERT (sm && sm->shared_header);
  59   return clib_mem_set_heap (sm->heap);
  60 }
  61
  62 static u32
  63 lookup_hash_index (u8 * name)
  64 {
  65   stat_segment_main_t *sm = &stat_segment_main;
  66   u32 index = STAT_SEGMENT_INDEX_INVALID;
  67   hash_pair_t *hp;
  68
  69   /* Must be called in the context of the main heap */
  70   ASSERT (clib_mem_get_heap () != sm->heap);
  71
  72   hp = hash_get_pair (sm->directory_vector_by_name, name);
  73   if (hp)
  74     {
  75       index = hp->value[0];
  76     }
  77
  78   return index;
  79 }
  80
  81 static void
  82 create_hash_index (u8 * name, u32 index)
  83 {
  84   stat_segment_main_t *sm = &stat_segment_main;
  85
  86   /* Must be called in the context of the main heap */
  87   ASSERT (clib_mem_get_heap () != sm->heap);
  88
  89   hash_set (sm->directory_vector_by_name, format (0, "%s%c", name, 0), index);
  90 }
  91
  92 static u32
  93 vlib_stats_get_next_vector_index ()
  94 {
  95   stat_segment_main_t *sm = &stat_segment_main;
  96   u32 next_vector_index = vec_len (sm->directory_vector);
  97
  98   ssize_t i;
  99   vec_foreach_index_backwards (i, sm->directory_vector)
 100   {
 101     if (sm->directory_vector[i].type == STAT_DIR_TYPE_EMPTY)
 102       {
 103         next_vector_index = i;
 104         break;
 105       }
 106   }
 107
 108   return next_vector_index;
 109 }
 110
 111 static u32
 112 vlib_stats_create_counter (stat_segment_directory_entry_t * e, void *oldheap)
 113 {
 114   stat_segment_main_t *sm = &stat_segment_main;
 115
 116   ASSERT (clib_mem_get_heap () == sm->heap);
 117
 118   u32 index = vlib_stats_get_next_vector_index ();
 119
 120   clib_mem_set_heap (oldheap);
 121   create_hash_index ((u8 *) e->name, index);
 122   clib_mem_set_heap (sm->heap);
 123
 124   vec_validate (sm->directory_vector, index);
 125   sm->directory_vector[index] = *e;
 126
 127   return index;
 128 }
 129
 130 static void
 131 vlib_stats_delete_counter (u32 index, void *oldheap)
 132 {
 133   stat_segment_main_t *sm = &stat_segment_main;
 134   stat_segment_directory_entry_t *e;
 135
 136   ASSERT (clib_mem_get_heap () == sm->heap);
 137
 138   if (index > vec_len (sm->directory_vector))
 139     return;
 140
 141   e = &sm->directory_vector[index];
 142
 143   clib_mem_set_heap (oldheap);
 144   hash_unset (sm->directory_vector_by_name, &e->name);
 145   clib_mem_set_heap (sm->heap);
 146
 147   memset (e, 0, sizeof (*e));
 148   e->type = STAT_DIR_TYPE_EMPTY;
 149 }
 150
 151 /*
 152  * Called from main heap
 153  */
 154 void
 155 vlib_stats_delete_cm (void *cm_arg)
 156 {
 157   vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
 158   stat_segment_main_t *sm = &stat_segment_main;
 159   stat_segment_directory_entry_t *e;
 160   stat_segment_shared_header_t *shared_header = sm->shared_header;
 161
 162   /* Not all counters have names / hash-table entries */
 163   if (!cm->name && !cm->stat_segment_name)
 164     {
 165       return;
 166     }
 167   vlib_stat_segment_lock ();
 168
 169   /* Lookup hash-table is on the main heap */
 170   char *stat_segment_name =
 171     cm->stat_segment_name ? cm->stat_segment_name : cm->name;
 172   u32 index = lookup_hash_index ((u8 *) stat_segment_name);
 173
 174   e = &sm->directory_vector[index];
 175   hash_unset (sm->directory_vector_by_name, &e->name);
 176
 177   u64 *offset_vector = stat_segment_pointer (shared_header, e->offset_vector);
 178
 179   void *oldheap = clib_mem_set_heap (sm->heap); /* Enter stats segment */
 180   vec_free (offset_vector);
 181   clib_mem_set_heap (oldheap);  /* Exit stats segment */
 182
 183   memset (e, 0, sizeof (*e));
 184   e->type = STAT_DIR_TYPE_EMPTY;
 185
 186   vlib_stat_segment_unlock ();
 187 }
 188
 189 void
 190 vlib_stats_pop_heap (void *cm_arg, void *oldheap, u32 cindex,
 191                      stat_directory_type_t type)
 192 {
 193   vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
 194   stat_segment_main_t *sm = &stat_segment_main;
 195   stat_segment_shared_header_t *shared_header = sm->shared_header;
 196   char *stat_segment_name;
 197   stat_segment_directory_entry_t e = { 0 };
 198
 199   /* Not all counters have names / hash-table entries */
 200   if (!cm->name && !cm->stat_segment_name)
 201     {
 202       clib_mem_set_heap (oldheap);
 203       return;
 204     }
 205
 206   ASSERT (shared_header);
 207
 208   vlib_stat_segment_lock ();
 209
 210   /* Lookup hash-table is on the main heap */
 211   stat_segment_name =
 212     cm->stat_segment_name ? cm->stat_segment_name : cm->name;
 213
 214   clib_mem_set_heap (oldheap);  /* Exit stats segment */
 215   u32 vector_index = lookup_hash_index ((u8 *) stat_segment_name);
 216   /* Back to stats segment */
 217   clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
 218
 219
 220   /* Update the vector */
 221   if (vector_index == STAT_SEGMENT_INDEX_INVALID)
 222     {                           /* New */
 223       strncpy (e.name, stat_segment_name, 128 - 1);
 224       e.type = type;
 225       vector_index = vlib_stats_create_counter (&e, oldheap);
 226     }
 227
 228   stat_segment_directory_entry_t *ep = &sm->directory_vector[vector_index];
 229   ep->offset = stat_segment_offset (shared_header, cm->counters);       /* Vector of threads of vectors of counters */
 230   u64 *offset_vector =
 231     ep->offset_vector ? stat_segment_pointer (shared_header,
 232                                               ep->offset_vector) : 0;
 233
 234   /* Update the 2nd dimension offset vector */
 235   int i;
 236   vec_validate (offset_vector, vec_len (cm->counters) - 1);
 237
 238   if (sm->last != offset_vector)
 239     {
 240       for (i = 0; i < vec_len (cm->counters); i++)
 241         offset_vector[i] =
 242           stat_segment_offset (shared_header, cm->counters[i]);
 243     }
 244   else
 245     offset_vector[cindex] =
 246       stat_segment_offset (shared_header, cm->counters[cindex]);
 247
 248   ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
 249   sm->directory_vector[vector_index].offset =
 250     stat_segment_offset (shared_header, cm->counters);
 251
 252   /* Reset the client hash table pointer, since it WILL change! */
 253   shared_header->directory_offset =
 254     stat_segment_offset (shared_header, sm->directory_vector);
 255
 256   vlib_stat_segment_unlock ();
 257   clib_mem_set_heap (oldheap);
 258 }
 259
 260 void
 261 vlib_stats_register_error_index (void *oldheap, u8 * name, u64 * em_vec,
 262                                  u64 index)
 263 {
 264   stat_segment_main_t *sm = &stat_segment_main;
 265   stat_segment_shared_header_t *shared_header = sm->shared_header;
 266   stat_segment_directory_entry_t e;
 267
 268   ASSERT (shared_header);
 269
 270   vlib_stat_segment_lock ();
 271   clib_mem_set_heap (oldheap);  /* Exit stats segment */
 272   u32 vector_index = lookup_hash_index (name);
 273   /* Back to stats segment */
 274   clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
 275
 276   if (vector_index == STAT_SEGMENT_INDEX_INVALID)
 277     {
 278       memcpy (e.name, name, vec_len (name));
 279       e.name[vec_len (name)] = '\0';
 280       e.type = STAT_DIR_TYPE_ERROR_INDEX;
 281       e.offset = index;
 282       e.offset_vector = 0;
 283       vector_index = vlib_stats_create_counter (&e, oldheap);
 284
 285       /* Warn clients to refresh any pointers they might be holding */
 286       shared_header->directory_offset =
 287         stat_segment_offset (shared_header, sm->directory_vector);
 288     }
 289
 290   vlib_stat_segment_unlock ();
 291 }
 292
 293 static void
 294 stat_validate_counter_vector (stat_segment_directory_entry_t * ep, u32 max)
 295 {
 296   stat_segment_main_t *sm = &stat_segment_main;
 297   stat_segment_shared_header_t *shared_header = sm->shared_header;
 298   counter_t **counters =
 299     ep->offset ? stat_segment_pointer (shared_header, ep->offset) : 0;
 300   vlib_thread_main_t *tm = vlib_get_thread_main ();
 301   int i;
 302   u64 *offset_vector = 0;
 303
 304   vec_validate_aligned (counters, tm->n_vlib_mains - 1,
 305                         CLIB_CACHE_LINE_BYTES);
 306   ep->offset = stat_segment_offset (shared_header, counters);
 307
 308   for (i = 0; i < tm->n_vlib_mains; i++)
 309     {
 310       vec_validate_aligned (counters[i], max, CLIB_CACHE_LINE_BYTES);
 311       vec_add1 (offset_vector,
 312                 stat_segment_offset (shared_header, counters[i]));
 313     }
 314
 315   if (ep->offset_vector)
 316     {
 317       u64 *p = stat_segment_pointer (sm->shared_header, ep->offset_vector);
 318       vec_free (p);
 319     }
 320   ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
 321 }
 322
 323 always_inline void
 324 stat_set_simple_counter (stat_segment_directory_entry_t * ep,
 325                          u32 thread_index, u32 index, u64 value)
 326 {
 327   stat_segment_main_t *sm = &stat_segment_main;
 328   stat_segment_shared_header_t *shared_header = sm->shared_header;
 329
 330   ASSERT (shared_header);
 331   counter_t *offset_vector =
 332     stat_segment_pointer (sm->shared_header, ep->offset_vector);
 333   counter_t *cb =
 334     stat_segment_pointer (sm->shared_header, offset_vector[thread_index]);
 335   cb[index] = value;
 336 }
 337
 338 void
 339 vlib_stats_pop_heap2 (u64 * error_vector, u32 thread_index, void *oldheap,
 340                       int lock)
 341 {
 342   stat_segment_main_t *sm = &stat_segment_main;
 343   stat_segment_shared_header_t *shared_header = sm->shared_header;
 344
 345   ASSERT (shared_header);
 346
 347   if (lock)
 348     vlib_stat_segment_lock ();
 349
 350   /* Reset the client hash table pointer, since it WILL change! */
 351   vec_validate (sm->error_vector, thread_index);
 352   sm->error_vector[thread_index] =
 353     stat_segment_offset (shared_header, error_vector);
 354
 355   shared_header->error_offset =
 356     stat_segment_offset (shared_header, sm->error_vector);
 357   shared_header->directory_offset =
 358     stat_segment_offset (shared_header, sm->directory_vector);
 359
 360   if (lock)
 361     vlib_stat_segment_unlock ();
 362   clib_mem_set_heap (oldheap);
 363 }
 364
 365 clib_error_t *
 366 vlib_map_stat_segment_init (void)
 367 {
 368   stat_segment_main_t *sm = &stat_segment_main;
 369   stat_segment_shared_header_t *shared_header;
 370   void *oldheap;
 371   ssize_t memory_size;
 372   int mfd;
 373   char *mem_name = "stat_segment_test";
 374   void *memaddr;
 375
 376   memory_size = sm->memory_size;
 377   if (memory_size == 0)
 378     memory_size = STAT_SEGMENT_DEFAULT_SIZE;
 379
 380   /* Create shared memory segment */
 381   if ((mfd = memfd_create (mem_name, 0)) < 0)
 382     return clib_error_return (0, "stat segment memfd_create failure");
 383
 384   /* Set size */
 385   if ((ftruncate (mfd, memory_size)) == -1)
 386     return clib_error_return (0, "stat segment ftruncate failure");
 387
 388   if ((memaddr =
 389        mmap (NULL, memory_size, PROT_READ | PROT_WRITE, MAP_SHARED, mfd,
 390              0)) == MAP_FAILED)
 391     return clib_error_return (0, "stat segment mmap failure");
 392
 393   void *heap;
 394   heap =
 395     create_mspace_with_base (((u8 *) memaddr) + getpagesize (),
 396                              memory_size - getpagesize (), 1 /* locked */ );
 397   mspace_disable_expand (heap);
 398   sm->heap = heap;
 399   sm->memfd = mfd;
 400
 401   sm->directory_vector_by_name = hash_create_string (0, sizeof (uword));
 402   sm->shared_header = shared_header = memaddr;
 403
 404   shared_header->version = STAT_SEGMENT_VERSION;
 405
 406   sm->stat_segment_lockp = clib_mem_alloc (sizeof (clib_spinlock_t));
 407   clib_spinlock_init (sm->stat_segment_lockp);
 408
 409   oldheap = clib_mem_set_heap (sm->heap);
 410
 411   /* Set up the name to counter-vector hash table */
 412   sm->directory_vector = 0;
 413
 414   shared_header->epoch = 1;
 415
 416   /* Scalar stats and node counters */
 417   vec_validate (sm->directory_vector, STAT_COUNTERS - 1);
 418 #define _(E,t,n,p)                                                      \
 419   strcpy(sm->directory_vector[STAT_COUNTER_##E].name,  #p "/" #n); \
 420   sm->directory_vector[STAT_COUNTER_##E].type = STAT_DIR_TYPE_##t;
 421   foreach_stat_segment_counter_name
 422 #undef _
 423     /* Save the vector offset in the shared segment, for clients */
 424     shared_header->directory_offset =
 425     stat_segment_offset (shared_header, sm->directory_vector);
 426
 427   clib_mem_set_heap (oldheap);
 428
 429   /* Total shared memory size */
 430   clib_mem_usage_t usage;
 431   mheap_usage (sm->heap, &usage);
 432   sm->directory_vector[STAT_COUNTER_MEM_STATSEG_TOTAL].value =
 433     usage.bytes_total;
 434
 435   return 0;
 436 }
 437
 438 static int
 439 name_sort_cmp (void *a1, void *a2)
 440 {
 441   stat_segment_directory_entry_t *n1 = a1;
 442   stat_segment_directory_entry_t *n2 = a2;
 443
 444   return strcmp ((char *) n1->name, (char *) n2->name);
 445 }
 446
 447 static u8 *
 448 format_stat_dir_entry (u8 * s, va_list * args)
 449 {
 450   stat_segment_directory_entry_t *ep =
 451     va_arg (*args, stat_segment_directory_entry_t *);
 452   char *type_name;
 453   char *format_string;
 454
 455   format_string = "%-74s %-10s %10lld";
 456
 457   switch (ep->type)
 458     {
 459     case STAT_DIR_TYPE_SCALAR_INDEX:
 460       type_name = "ScalarPtr";
 461       break;
 462
 463     case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
 464     case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
 465       type_name = "CMainPtr";
 466       break;
 467
 468     case STAT_DIR_TYPE_ERROR_INDEX:
 469       type_name = "ErrIndex";
 470       break;
 471
 472     case STAT_DIR_TYPE_NAME_VECTOR:
 473       type_name = "NameVector";
 474       break;
 475
 476     case STAT_DIR_TYPE_EMPTY:
 477       type_name = "empty";
 478       break;
 479
 480     default:
 481       type_name = "illegal!";
 482       break;
 483     }
 484
 485   return format (s, format_string, ep->name, type_name, ep->offset);
 486 }
 487
 488 static clib_error_t *
 489 show_stat_segment_command_fn (vlib_main_t * vm,
 490                               unformat_input_t * input,
 491                               vlib_cli_command_t * cmd)
 492 {
 493   stat_segment_main_t *sm = &stat_segment_main;
 494   stat_segment_directory_entry_t *show_data;
 495   int i;
 496
 497   int verbose = 0;
 498
 499   if (unformat (input, "verbose"))
 500     verbose = 1;
 501
 502   /* Lock even as reader, as this command doesn't handle epoch changes */
 503   vlib_stat_segment_lock ();
 504   show_data = vec_dup (sm->directory_vector);
 505   vlib_stat_segment_unlock ();
 506
 507   vec_sort_with_function (show_data, name_sort_cmp);
 508
 509   vlib_cli_output (vm, "%-74s %10s %10s", "Name", "Type", "Value");
 510
 511   for (i = 0; i < vec_len (show_data); i++)
 512     {
 513       stat_segment_directory_entry_t *ep = vec_elt_at_index (show_data, i);
 514
 515       if (ep->type == STAT_DIR_TYPE_EMPTY)
 516         continue;
 517
 518       vlib_cli_output (vm, "%-100U", format_stat_dir_entry,
 519                        vec_elt_at_index (show_data, i));
 520     }
 521
 522   if (verbose)
 523     {
 524       ASSERT (sm->heap);
 525       vlib_cli_output (vm, "%U", format_mheap, sm->heap, 0 /* verbose */ );
 526     }
 527
 528   return 0;
 529 }
 530
 531 /* *INDENT-OFF* */
 532 VLIB_CLI_COMMAND (show_stat_segment_command, static) =
 533 {
 534   .path = "show statistics segment",
 535   .short_help = "show statistics segment [verbose]",
 536   .function = show_stat_segment_command_fn,
 537 };
 538 /* *INDENT-ON* */
 539
 540 /*
 541  * Node performance counters:
 542  * total_calls [threads][node-index]
 543  * total_vectors
 544  * total_calls
 545  * total suspends
 546  */
 547
 548 static inline void
 549 update_node_counters (stat_segment_main_t * sm)
 550 {
 551   vlib_main_t **stat_vms = 0;
 552   vlib_node_t ***node_dups = 0;
 553   int i, j;
 554   stat_segment_shared_header_t *shared_header = sm->shared_header;
 555   static u32 no_max_nodes = 0;
 556
 557   vlib_node_get_nodes (0 /* vm, for barrier sync */ ,
 558                        (u32) ~ 0 /* all threads */ ,
 559                        1 /* include stats */ ,
 560                        0 /* barrier sync */ ,
 561                        &node_dups, &stat_vms);
 562
 563   u32 l = vec_len (node_dups[0]);
 564
 565   /*
 566    * Extend performance nodes if necessary
 567    */
 568   if (l > no_max_nodes)
 569     {
 570       void *oldheap = clib_mem_set_heap (sm->heap);
 571       vlib_stat_segment_lock ();
 572
 573       stat_validate_counter_vector (&sm->directory_vector
 574                                     [STAT_COUNTER_NODE_CLOCKS], l - 1);
 575       stat_validate_counter_vector (&sm->directory_vector
 576                                     [STAT_COUNTER_NODE_VECTORS], l - 1);
 577       stat_validate_counter_vector (&sm->directory_vector
 578                                     [STAT_COUNTER_NODE_CALLS], l - 1);
 579       stat_validate_counter_vector (&sm->directory_vector
 580                                     [STAT_COUNTER_NODE_SUSPENDS], l - 1);
 581
 582       vec_validate (sm->nodes, l - 1);
 583       stat_segment_directory_entry_t *ep;
 584       ep = &sm->directory_vector[STAT_COUNTER_NODE_NAMES];
 585       ep->offset = stat_segment_offset (shared_header, sm->nodes);
 586
 587       int i;
 588       u64 *offset_vector =
 589         ep->offset_vector ? stat_segment_pointer (shared_header,
 590                                                   ep->offset_vector) : 0;
 591       /* Update names dictionary */
 592       vec_validate (offset_vector, l - 1);
 593       vlib_node_t **nodes = node_dups[0];
 594
 595       for (i = 0; i < vec_len (nodes); i++)
 596         {
 597           vlib_node_t *n = nodes[i];
 598           u8 *s = 0;
 599           s = format (s, "%v%c", n->name, 0);
 600           if (sm->nodes[n->index])
 601             vec_free (sm->nodes[n->index]);
 602           sm->nodes[n->index] = s;
 603           offset_vector[i] =
 604             sm->nodes[i] ? stat_segment_offset (shared_header,
 605                                                 sm->nodes[i]) : 0;
 606
 607         }
 608       ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
 609
 610       vlib_stat_segment_unlock ();
 611       clib_mem_set_heap (oldheap);
 612       no_max_nodes = l;
 613     }
 614
 615   for (j = 0; j < vec_len (node_dups); j++)
 616     {
 617       vlib_node_t **nodes = node_dups[j];
 618
 619       for (i = 0; i < vec_len (nodes); i++)
 620         {
 621           counter_t **counters;
 622           counter_t *c;
 623           vlib_node_t *n = nodes[i];
 624
 625           counters =
 626             stat_segment_pointer (shared_header,
 627                                   sm->directory_vector
 628                                   [STAT_COUNTER_NODE_CLOCKS].offset);
 629           c = counters[j];
 630           c[n->index] = n->stats_total.clocks - n->stats_last_clear.clocks;
 631
 632           counters =
 633             stat_segment_pointer (shared_header,
 634                                   sm->directory_vector
 635                                   [STAT_COUNTER_NODE_VECTORS].offset);
 636           c = counters[j];
 637           c[n->index] = n->stats_total.vectors - n->stats_last_clear.vectors;
 638
 639           counters =
 640             stat_segment_pointer (shared_header,
 641                                   sm->directory_vector
 642                                   [STAT_COUNTER_NODE_CALLS].offset);
 643           c = counters[j];
 644           c[n->index] = n->stats_total.calls - n->stats_last_clear.calls;
 645
 646           counters =
 647             stat_segment_pointer (shared_header,
 648                                   sm->directory_vector
 649                                   [STAT_COUNTER_NODE_SUSPENDS].offset);
 650           c = counters[j];
 651           c[n->index] =
 652             n->stats_total.suspends - n->stats_last_clear.suspends;
 653         }
 654       vec_free (node_dups[j]);
 655     }
 656   vec_free (node_dups);
 657   vec_free (stat_vms);
 658 }
 659
 660 static void
 661 do_stat_segment_updates (stat_segment_main_t * sm)
 662 {
 663   vlib_main_t *vm = vlib_mains[0];
 664   f64 vector_rate;
 665   u64 input_packets;
 666   f64 dt, now;
 667   vlib_main_t *this_vlib_main;
 668   int i;
 669   static int num_worker_threads_set;
 670
 671   /*
 672    * Set once at the beginning of time.
 673    * Can't do this from the init routine, which happens before
 674    * start_workers sets up vlib_mains...
 675    */
 676   if (PREDICT_FALSE (num_worker_threads_set == 0))
 677     {
 678       void *oldheap = clib_mem_set_heap (sm->heap);
 679       vlib_stat_segment_lock ();
 680
 681       stat_validate_counter_vector (&sm->directory_vector
 682                                     [STAT_COUNTER_VECTOR_RATE_PER_WORKER], 0);
 683       num_worker_threads_set = 1;
 684       vlib_stat_segment_unlock ();
 685       clib_mem_set_heap (oldheap);
 686     }
 687
 688   /*
 689    * Compute per-worker vector rates, and the average vector rate
 690    * across all workers
 691    */
 692   vector_rate = 0.0;
 693
 694   for (i = 0; i < vec_len (vlib_mains); i++)
 695     {
 696
 697       f64 this_vector_rate;
 698
 699       this_vlib_main = vlib_mains[i];
 700
 701       this_vector_rate = vlib_internal_node_vector_rate (this_vlib_main);
 702       vlib_clear_internal_node_vector_rate (this_vlib_main);
 703
 704       vector_rate += this_vector_rate;
 705
 706       /* Set the per-worker rate */
 707       stat_set_simple_counter (&sm->directory_vector
 708                                [STAT_COUNTER_VECTOR_RATE_PER_WORKER], i, 0,
 709                                this_vector_rate);
 710     }
 711
 712   /* And set the system average rate */
 713   vector_rate /= (f64) (i > 1 ? i - 1 : 1);
 714
 715   sm->directory_vector[STAT_COUNTER_VECTOR_RATE].value = vector_rate;
 716
 717   /*
 718    * Compute the aggregate input rate
 719    */
 720   now = vlib_time_now (vm);
 721   dt = now - sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value;
 722   input_packets = vnet_get_aggregate_rx_packets ();
 723   sm->directory_vector[STAT_COUNTER_INPUT_RATE].value =
 724     (f64) (input_packets - sm->last_input_packets) / dt;
 725   sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value = now;
 726   sm->last_input_packets = input_packets;
 727   sm->directory_vector[STAT_COUNTER_LAST_STATS_CLEAR].value =
 728     vm->node_main.time_last_runtime_stats_clear;
 729
 730   /* Stats segment memory heap counter */
 731   clib_mem_usage_t usage;
 732   mheap_usage (sm->heap, &usage);
 733   sm->directory_vector[STAT_COUNTER_MEM_STATSEG_USED].value =
 734     usage.bytes_used;
 735
 736   if (sm->node_counters_enabled)
 737     update_node_counters (sm);
 738
 739   /* *INDENT-OFF* */
 740   stat_segment_gauges_pool_t *g;
 741   pool_foreach(g, sm->gauges,
 742   ({
 743     g->fn(&sm->directory_vector[g->directory_index], g->caller_index);
 744   }));
 745   /* *INDENT-ON* */
 746
 747   /* Heartbeat, so clients detect we're still here */
 748   sm->directory_vector[STAT_COUNTER_HEARTBEAT].value++;
 749 }
 750
 751 /*
 752  * Accept connection on the socket and exchange the fd for the shared
 753  * memory segment.
 754  */
 755 static clib_error_t *
 756 stats_socket_accept_ready (clib_file_t * uf)
 757 {
 758   stat_segment_main_t *sm = &stat_segment_main;
 759   clib_error_t *err;
 760   clib_socket_t client = { 0 };
 761
 762   err = clib_socket_accept (sm->socket, &client);
 763   if (err)
 764     {
 765       clib_error_report (err);
 766       return err;
 767     }
 768
 769   /* Send the fd across and close */
 770   err = clib_socket_sendmsg (&client, 0, 0, &sm->memfd, 1);
 771   if (err)
 772     clib_error_report (err);
 773   clib_socket_close (&client);
 774
 775   return 0;
 776 }
 777
 778 static clib_error_t *
 779 stats_segment_socket_init (void)
 780 {
 781   stat_segment_main_t *sm = &stat_segment_main;
 782   clib_error_t *error;
 783   clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
 784
 785   memset (s, 0, sizeof (clib_socket_t));
 786   s->config = (char *) sm->socket_name;
 787   s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
 788     CLIB_SOCKET_F_ALLOW_GROUP_WRITE | CLIB_SOCKET_F_PASSCRED;
 789
 790   if ((error = clib_socket_init (s)))
 791     return error;
 792
 793   clib_file_t template = { 0 };
 794   template.read_function = stats_socket_accept_ready;
 795   template.file_descriptor = s->fd;
 796   template.description = format (0, "stats segment listener %s", s->config);
 797   clib_file_add (&file_main, &template);
 798
 799   sm->socket = s;
 800
 801   return 0;
 802 }
 803
 804 static clib_error_t *
 805 stats_segment_socket_exit (vlib_main_t * vm)
 806 {
 807   /*
 808    * cleanup the listener socket on exit.
 809    */
 810   stat_segment_main_t *sm = &stat_segment_main;
 811   unlink ((char *) sm->socket_name);
 812   return 0;
 813 }
 814
 815 VLIB_MAIN_LOOP_EXIT_FUNCTION (stats_segment_socket_exit);
 816
 817 /* Overrides weak reference in vlib:node_cli.c */
 818 f64
 819 vlib_get_stat_segment_update_rate (void)
 820 {
 821   return stat_segment_main.update_interval;
 822 }
 823
 824 static uword
 825 stat_segment_collector_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
 826                                 vlib_frame_t * f)
 827 {
 828   stat_segment_main_t *sm = &stat_segment_main;
 829
 830   while (1)
 831     {
 832       do_stat_segment_updates (sm);
 833       vlib_process_suspend (vm, sm->update_interval);
 834     }
 835   return 0;                     /* or not */
 836 }
 837
 838 static clib_error_t *
 839 statseg_init (vlib_main_t * vm)
 840 {
 841   stat_segment_main_t *sm = &stat_segment_main;
 842
 843   /* set default socket file name when statseg config stanza is empty. */
 844   if (!vec_len (sm->socket_name))
 845     sm->socket_name = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
 846                               STAT_SEGMENT_SOCKET_FILENAME, 0);
 847   return stats_segment_socket_init ();
 848 }
 849
 850 /* *INDENT-OFF* */
 851 VLIB_INIT_FUNCTION (statseg_init) =
 852 {
 853   .runs_after = VLIB_INITS("unix_input_init"),
 854 };
 855 /* *INDENT-ON* */
 856
 857 clib_error_t *
 858 stat_segment_register_gauge (u8 * name, stat_segment_update_fn update_fn,
 859                              u32 caller_index)
 860 {
 861   stat_segment_main_t *sm = &stat_segment_main;
 862   stat_segment_shared_header_t *shared_header = sm->shared_header;
 863   void *oldheap;
 864   stat_segment_directory_entry_t e;
 865   stat_segment_gauges_pool_t *gauge;
 866
 867   ASSERT (shared_header);
 868
 869   u32 vector_index = lookup_hash_index (name);
 870
 871   if (vector_index != STAT_SEGMENT_INDEX_INVALID)       /* Already registered */
 872     return clib_error_return (0, "%v is already registered", name);
 873
 874   memset (&e, 0, sizeof (e));
 875   e.type = STAT_DIR_TYPE_SCALAR_INDEX;
 876   memcpy (e.name, name, vec_len (name));
 877
 878   oldheap = vlib_stats_push_heap (NULL);
 879   vlib_stat_segment_lock ();
 880   vector_index = vlib_stats_create_counter (&e, oldheap);
 881
 882   shared_header->directory_offset =
 883     stat_segment_offset (shared_header, sm->directory_vector);
 884
 885   vlib_stat_segment_unlock ();
 886   clib_mem_set_heap (oldheap);
 887
 888   /* Back on our own heap */
 889   pool_get (sm->gauges, gauge);
 890   gauge->fn = update_fn;
 891   gauge->caller_index = caller_index;
 892   gauge->directory_index = vector_index;
 893
 894   return NULL;
 895 }
 896
 897 clib_error_t *
 898 stat_segment_register_state_counter (u8 * name, u32 * index)
 899 {
 900   stat_segment_main_t *sm = &stat_segment_main;
 901   stat_segment_shared_header_t *shared_header = sm->shared_header;
 902   void *oldheap;
 903   stat_segment_directory_entry_t e;
 904
 905   ASSERT (shared_header);
 906   ASSERT (vlib_get_thread_index () == 0);
 907
 908   u32 vector_index = lookup_hash_index (name);
 909
 910   if (vector_index != STAT_SEGMENT_INDEX_INVALID)       /* Already registered */
 911     return clib_error_return (0, "%v is already registered", name);
 912
 913   memset (&e, 0, sizeof (e));
 914   e.type = STAT_DIR_TYPE_SCALAR_INDEX;
 915   memcpy (e.name, name, vec_len (name));
 916
 917   oldheap = vlib_stats_push_heap (NULL);
 918   vlib_stat_segment_lock ();
 919
 920   vector_index = vlib_stats_create_counter (&e, oldheap);
 921
 922   shared_header->directory_offset =
 923     stat_segment_offset (shared_header, sm->directory_vector);
 924
 925   vlib_stat_segment_unlock ();
 926   clib_mem_set_heap (oldheap);
 927
 928   *index = vector_index;
 929   return 0;
 930 }
 931
 932 clib_error_t *
 933 stat_segment_deregister_state_counter (u32 index)
 934 {
 935   stat_segment_main_t *sm = &stat_segment_main;
 936   stat_segment_shared_header_t *shared_header = sm->shared_header;
 937   stat_segment_directory_entry_t *e;
 938   void *oldheap;
 939
 940   ASSERT (shared_header);
 941
 942   if (index > vec_len (sm->directory_vector))
 943     return clib_error_return (0, "%u index does not exist", index);
 944
 945   e = &sm->directory_vector[index];
 946   if (e->type != STAT_DIR_TYPE_SCALAR_INDEX)
 947     return clib_error_return (0, "%u index cannot be deleted", index);
 948
 949   oldheap = vlib_stats_push_heap (NULL);
 950   vlib_stat_segment_lock ();
 951
 952   vlib_stats_delete_counter (index, oldheap);
 953
 954   vlib_stat_segment_unlock ();
 955   clib_mem_set_heap (oldheap);
 956
 957   return 0;
 958 }
 959
 960 void
 961 stat_segment_set_state_counter (u32 index, u64 value)
 962 {
 963   stat_segment_main_t *sm = &stat_segment_main;
 964
 965   ASSERT (index < vec_len (sm->directory_vector));
 966   sm->directory_vector[index].index = value;
 967 }
 968
 969 static clib_error_t *
 970 statseg_config (vlib_main_t * vm, unformat_input_t * input)
 971 {
 972   stat_segment_main_t *sm = &stat_segment_main;
 973   sm->update_interval = 10.0;
 974
 975   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 976     {
 977       if (unformat (input, "socket-name %s", &sm->socket_name))
 978         ;
 979       /* DEPRECATE: default (does nothing) */
 980       else if (unformat (input, "default"))
 981         ;
 982       else if (unformat (input, "size %U",
 983                          unformat_memory_size, &sm->memory_size))
 984         ;
 985       else if (unformat (input, "per-node-counters on"))
 986         sm->node_counters_enabled = 1;
 987       else if (unformat (input, "per-node-counters off"))
 988         sm->node_counters_enabled = 0;
 989       else if (unformat (input, "update-interval %f", &sm->update_interval))
 990         ;
 991       else
 992         return clib_error_return (0, "unknown input `%U'",
 993                                   format_unformat_error, input);
 994     }
 995
 996   /*
 997    * NULL-terminate socket name string
 998    * clib_socket_init()->socket_config() use C str*
 999    */
1000   if (vec_len (sm->socket_name))
1001     vec_terminate_c_string (sm->socket_name);
1002
1003   return 0;
1004 }
1005
1006 VLIB_EARLY_CONFIG_FUNCTION (statseg_config, "statseg");
1007
1008 static clib_error_t *
1009 statseg_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
1010 {
1011   stat_segment_main_t *sm = &stat_segment_main;
1012   stat_segment_shared_header_t *shared_header = sm->shared_header;
1013
1014   void *oldheap = vlib_stats_push_heap (sm->interfaces);
1015   vlib_stat_segment_lock ();
1016
1017   vec_validate (sm->interfaces, sw_if_index);
1018   if (is_add)
1019     {
1020       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1021       vnet_sw_interface_t *si_sup =
1022         vnet_get_sup_sw_interface (vnm, si->sw_if_index);
1023       vnet_hw_interface_t *hi_sup;
1024
1025       ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
1026       hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
1027
1028       u8 *s = 0;
1029       s = format (s, "%v", hi_sup->name);
1030       if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1031         s = format (s, ".%d", si->sub.id);
1032       s = format (s, "%c", 0);
1033       sm->interfaces[sw_if_index] = s;
1034     }
1035   else
1036     {
1037       vec_free (sm->interfaces[sw_if_index]);
1038       sm->interfaces[sw_if_index] = 0;
1039     }
1040
1041   stat_segment_directory_entry_t *ep;
1042   ep = &sm->directory_vector[STAT_COUNTER_INTERFACE_NAMES];
1043   ep->offset = stat_segment_offset (shared_header, sm->interfaces);
1044
1045   int i;
1046   u64 *offset_vector =
1047     ep->offset_vector ? stat_segment_pointer (shared_header,
1048                                               ep->offset_vector) : 0;
1049
1050   vec_validate (offset_vector, vec_len (sm->interfaces) - 1);
1051
1052   if (sm->last != sm->interfaces)
1053     {
1054       /* the interface vector moved, so need to recalulate the offset array */
1055       for (i = 0; i < vec_len (sm->interfaces); i++)
1056         {
1057           offset_vector[i] =
1058             sm->interfaces[i] ? stat_segment_offset (shared_header,
1059                                                      sm->interfaces[i]) : 0;
1060         }
1061     }
1062   else
1063     {
1064       offset_vector[sw_if_index] =
1065         sm->interfaces[sw_if_index] ?
1066         stat_segment_offset (shared_header, sm->interfaces[sw_if_index]) : 0;
1067     }
1068   ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
1069
1070   vlib_stat_segment_unlock ();
1071   clib_mem_set_heap (oldheap);
1072
1073   return 0;
1074 }
1075
1076 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (statseg_sw_interface_add_del);
1077
1078 /* *INDENT-OFF* */
1079 VLIB_REGISTER_NODE (stat_segment_collector, static) =
1080 {
1081 .function = stat_segment_collector_process,
1082 .name = "statseg-collector-process",
1083 .type = VLIB_NODE_TYPE_PROCESS,
1084 };
1085
1086 /* *INDENT-ON* */
1087
1088 /*
1089  * fd.io coding-style-patch-verification: ON
1090  *
1091  * Local Variables:
1092  * eval: (c-set-style "gnu")
1093  * End:
1094  */