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