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