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