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 /*
 337  * Creates a two dimensional vector with the maximum valid index specified in
 338  * both dimensions as arguments.
 339  * Must be called on the stat segment heap.
 340  */
 341 static void
 342 stat_validate_counter_vector2 (stat_segment_directory_entry_t *ep, u32 max1,
 343                                u32 max2)
 344 {
 345   counter_t **counters = ep->data;
 346   int i;
 347   vec_validate_aligned (counters, max1, CLIB_CACHE_LINE_BYTES);
 348   for (i = 0; i <= max1; i++)
 349     vec_validate_aligned (counters[i], max2, CLIB_CACHE_LINE_BYTES);
 350
 351   ep->data = counters;
 352 }
 353
 354 static void
 355 stat_validate_counter_vector (stat_segment_directory_entry_t *ep, u32 max)
 356 {
 357   vlib_thread_main_t *tm = vlib_get_thread_main ();
 358   ASSERT (tm->n_vlib_mains > 0);
 359   stat_validate_counter_vector2 (ep, tm->n_vlib_mains, max);
 360 }
 361
 362 void
 363 vlib_stats_pop_heap2 (u64 * error_vector, u32 thread_index, void *oldheap,
 364                       int lock)
 365 {
 366   stat_segment_main_t *sm = &stat_segment_main;
 367   stat_segment_shared_header_t *shared_header = sm->shared_header;
 368
 369   ASSERT (shared_header);
 370
 371   if (lock)
 372     vlib_stat_segment_lock ();
 373
 374   /* Reset the client hash table pointer, since it WILL change! */
 375   vec_validate (sm->error_vector, thread_index);
 376   sm->error_vector[thread_index] = error_vector;
 377
 378   shared_header->error_vector = sm->error_vector;
 379   shared_header->directory_vector = sm->directory_vector;
 380
 381   if (lock)
 382     vlib_stat_segment_unlock ();
 383   clib_mem_set_heap (oldheap);
 384 }
 385
 386 /*
 387  * Create a new entry and add name to directory hash.
 388  * Returns ~0 if name exists.
 389  * Called from main heap.
 390  * The name is either C-string or nul-terminated vector
 391  */
 392 u32
 393 stat_segment_new_entry (u8 *name, stat_directory_type_t t)
 394 {
 395   stat_segment_main_t *sm = &stat_segment_main;
 396   stat_segment_shared_header_t *shared_header = sm->shared_header;
 397   void *oldheap;
 398   stat_segment_directory_entry_t e;
 399
 400   ASSERT (shared_header);
 401
 402   u32 vector_index = lookup_hash_index (name);
 403   if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
 404     return ~0;
 405
 406   memset (&e, 0, sizeof (e));
 407   e.type = t;
 408   strcpy_s (e.name, sizeof (e.name), (char *) name);
 409
 410   oldheap = vlib_stats_push_heap (NULL);
 411   vlib_stat_segment_lock ();
 412   vector_index = vlib_stats_create_counter (&e, oldheap);
 413
 414   shared_header->directory_vector = sm->directory_vector;
 415
 416   vlib_stat_segment_unlock ();
 417   clib_mem_set_heap (oldheap);
 418
 419   return vector_index;
 420 }
 421
 422 clib_error_t *
 423 vlib_map_stat_segment_init (void)
 424 {
 425   stat_segment_main_t *sm = &stat_segment_main;
 426   stat_segment_shared_header_t *shared_header;
 427   void *oldheap;
 428   uword memory_size, sys_page_sz;
 429   int mfd;
 430   char *mem_name = "stat segment";
 431   void *heap, *memaddr;
 432
 433   memory_size = sm->memory_size;
 434   if (memory_size == 0)
 435     memory_size = STAT_SEGMENT_DEFAULT_SIZE;
 436
 437   if (sm->log2_page_sz == CLIB_MEM_PAGE_SZ_UNKNOWN)
 438     sm->log2_page_sz = CLIB_MEM_PAGE_SZ_DEFAULT;
 439
 440   mfd = clib_mem_vm_create_fd (sm->log2_page_sz, mem_name);
 441
 442   if (mfd == -1)
 443     return clib_error_return (0, "stat segment memory fd failure: %U",
 444                               format_clib_error, clib_mem_get_last_error ());
 445   /* Set size */
 446   if ((ftruncate (mfd, memory_size)) == -1)
 447     {
 448       close (mfd);
 449       return clib_error_return (0, "stat segment ftruncate failure");
 450     }
 451
 452   memaddr = clib_mem_vm_map_shared (0, memory_size, mfd, 0, mem_name);
 453
 454   if (memaddr == CLIB_MEM_VM_MAP_FAILED)
 455     return clib_error_return (0, "stat segment mmap failure");
 456
 457   sys_page_sz = clib_mem_get_page_size ();
 458
 459   heap =
 460     clib_mem_create_heap (((u8 *) memaddr) + sys_page_sz,
 461                           memory_size - sys_page_sz, 1 /* locked */, mem_name);
 462   sm->heap = heap;
 463   sm->memfd = mfd;
 464
 465   sm->directory_vector_by_name = hash_create_string (0, sizeof (uword));
 466   sm->shared_header = shared_header = memaddr;
 467
 468   shared_header->version = STAT_SEGMENT_VERSION;
 469   shared_header->base = memaddr;
 470
 471   sm->stat_segment_lockp = clib_mem_alloc (sizeof (clib_spinlock_t));
 472   clib_spinlock_init (sm->stat_segment_lockp);
 473
 474   oldheap = clib_mem_set_heap (sm->heap);
 475
 476   /* Set up the name to counter-vector hash table */
 477   sm->directory_vector = 0;
 478
 479   shared_header->epoch = 1;
 480
 481   /* Scalar stats and node counters */
 482   vec_validate (sm->directory_vector, STAT_COUNTERS - 1);
 483 #define _(E,t,n,p)                                                      \
 484   strcpy(sm->directory_vector[STAT_COUNTER_##E].name,  #p "/" #n); \
 485   sm->directory_vector[STAT_COUNTER_##E].type = STAT_DIR_TYPE_##t;
 486   foreach_stat_segment_counter_name
 487 #undef _
 488     /* Save the vector in the shared segment, for clients */
 489     shared_header->directory_vector = sm->directory_vector;
 490
 491   clib_mem_set_heap (oldheap);
 492
 493   vlib_stats_register_mem_heap (heap);
 494
 495   return 0;
 496 }
 497
 498 static int
 499 name_sort_cmp (void *a1, void *a2)
 500 {
 501   stat_segment_directory_entry_t *n1 = a1;
 502   stat_segment_directory_entry_t *n2 = a2;
 503
 504   return strcmp ((char *) n1->name, (char *) n2->name);
 505 }
 506
 507 static u8 *
 508 format_stat_dir_entry (u8 * s, va_list * args)
 509 {
 510   stat_segment_directory_entry_t *ep =
 511     va_arg (*args, stat_segment_directory_entry_t *);
 512   char *type_name;
 513   char *format_string;
 514
 515   format_string = "%-74s %-10s %10lld";
 516
 517   switch (ep->type)
 518     {
 519     case STAT_DIR_TYPE_SCALAR_INDEX:
 520       type_name = "ScalarPtr";
 521       break;
 522
 523     case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
 524     case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
 525       type_name = "CMainPtr";
 526       break;
 527
 528     case STAT_DIR_TYPE_ERROR_INDEX:
 529       type_name = "ErrIndex";
 530       break;
 531
 532     case STAT_DIR_TYPE_NAME_VECTOR:
 533       type_name = "NameVector";
 534       break;
 535
 536     case STAT_DIR_TYPE_EMPTY:
 537       type_name = "empty";
 538       break;
 539
 540     case STAT_DIR_TYPE_SYMLINK:
 541       type_name = "Symlink";
 542       break;
 543
 544     default:
 545       type_name = "illegal!";
 546       break;
 547     }
 548
 549   return format (s, format_string, ep->name, type_name, 0);
 550 }
 551
 552 static clib_error_t *
 553 show_stat_segment_command_fn (vlib_main_t * vm,
 554                               unformat_input_t * input,
 555                               vlib_cli_command_t * cmd)
 556 {
 557   stat_segment_main_t *sm = &stat_segment_main;
 558   stat_segment_directory_entry_t *show_data;
 559   int i;
 560
 561   int verbose = 0;
 562
 563   if (unformat (input, "verbose"))
 564     verbose = 1;
 565
 566   /* Lock even as reader, as this command doesn't handle epoch changes */
 567   vlib_stat_segment_lock ();
 568   show_data = vec_dup (sm->directory_vector);
 569   vlib_stat_segment_unlock ();
 570
 571   vec_sort_with_function (show_data, name_sort_cmp);
 572
 573   vlib_cli_output (vm, "%-74s %10s %10s", "Name", "Type", "Value");
 574
 575   for (i = 0; i < vec_len (show_data); i++)
 576     {
 577       stat_segment_directory_entry_t *ep = vec_elt_at_index (show_data, i);
 578
 579       if (ep->type == STAT_DIR_TYPE_EMPTY)
 580         continue;
 581
 582       vlib_cli_output (vm, "%-100U", format_stat_dir_entry,
 583                        vec_elt_at_index (show_data, i));
 584     }
 585
 586   if (verbose)
 587     {
 588       ASSERT (sm->heap);
 589       vlib_cli_output (vm, "%U", format_clib_mem_heap, sm->heap,
 590                        0 /* verbose */ );
 591     }
 592
 593   return 0;
 594 }
 595
 596 /* *INDENT-OFF* */
 597 VLIB_CLI_COMMAND (show_stat_segment_command, static) =
 598 {
 599   .path = "show statistics segment",
 600   .short_help = "show statistics segment [verbose]",
 601   .function = show_stat_segment_command_fn,
 602 };
 603 /* *INDENT-ON* */
 604
 605 /*
 606  * Node performance counters:
 607  * total_calls [threads][node-index]
 608  * total_vectors
 609  * total_calls
 610  * total suspends
 611  */
 612
 613 static inline void
 614 update_node_counters (stat_segment_main_t * sm)
 615 {
 616   vlib_main_t **stat_vms = 0;
 617   vlib_node_t ***node_dups = 0;
 618   int i, j;
 619   static u32 no_max_nodes = 0;
 620
 621   vlib_node_get_nodes (0 /* vm, for barrier sync */,
 622                        (u32) ~0 /* all threads */, 1 /* include stats */,
 623                        0 /* barrier sync */, &node_dups, &stat_vms);
 624
 625   u32 l = vec_len (node_dups[0]);
 626   u8 *symlink_name = 0;
 627
 628   /*
 629    * Extend performance nodes if necessary
 630    */
 631   if (l > no_max_nodes)
 632     {
 633       void *oldheap = clib_mem_set_heap (sm->heap);
 634       vlib_stat_segment_lock ();
 635
 636       stat_validate_counter_vector (
 637         &sm->directory_vector[STAT_COUNTER_NODE_CLOCKS], l - 1);
 638       stat_validate_counter_vector (
 639         &sm->directory_vector[STAT_COUNTER_NODE_VECTORS], l - 1);
 640       stat_validate_counter_vector (
 641         &sm->directory_vector[STAT_COUNTER_NODE_CALLS], l - 1);
 642       stat_validate_counter_vector (
 643         &sm->directory_vector[STAT_COUNTER_NODE_SUSPENDS], l - 1);
 644
 645       vec_validate (sm->nodes, l - 1);
 646       stat_segment_directory_entry_t *ep;
 647       ep = &sm->directory_vector[STAT_COUNTER_NODE_NAMES];
 648       ep->data = sm->nodes;
 649
 650       /* Update names dictionary */
 651       vlib_node_t **nodes = node_dups[0];
 652       int i;
 653       for (i = 0; i < vec_len (nodes); i++)
 654         {
 655           vlib_node_t *n = nodes[i];
 656           u8 *s = 0;
 657           s = format (s, "%v%c", n->name, 0);
 658           if (sm->nodes[n->index])
 659             vec_free (sm->nodes[n->index]);
 660           sm->nodes[n->index] = s;
 661
 662 #define _(E, t, name, p)                                                      \
 663   vec_reset_length (symlink_name);                                            \
 664   symlink_name = format (symlink_name, "/nodes/%U/" #name "%c",               \
 665                          format_vlib_stats_symlink, s, 0);                    \
 666   vlib_stats_register_symlink (oldheap, symlink_name, STAT_COUNTER_##E,       \
 667                                n->index, 0 /* don't lock */);
 668           foreach_stat_segment_node_counter_name
 669 #undef _
 670         }
 671       vec_free (symlink_name);
 672       vlib_stat_segment_unlock ();
 673       clib_mem_set_heap (oldheap);
 674       no_max_nodes = l;
 675     }
 676
 677   for (j = 0; j < vec_len (node_dups); j++)
 678     {
 679       vlib_node_t **nodes = node_dups[j];
 680
 681       for (i = 0; i < vec_len (nodes); i++)
 682         {
 683           counter_t **counters;
 684           counter_t *c;
 685           vlib_node_t *n = nodes[i];
 686
 687           if (j == 0)
 688             {
 689               if (strncmp ((char *) sm->nodes[n->index], (char *) n->name,
 690                            strlen ((char *) sm->nodes[n->index])))
 691                 {
 692                   u8 *s = 0;
 693                   u32 vector_index;
 694                   u8 *symlink_new_name = 0;
 695                   void *oldheap = clib_mem_set_heap (sm->heap);
 696                   vlib_stat_segment_lock ();
 697                   s = format (s, "%v%c", n->name, 0);
 698 #define _(E, t, name, p)                                                      \
 699   vec_reset_length (symlink_name);                                            \
 700   symlink_name = format (symlink_name, "/nodes/%U/" #name "%c",               \
 701                          format_vlib_stats_symlink, sm->nodes[n->index], 0);  \
 702   clib_mem_set_heap (oldheap); /* Exit stats segment */                       \
 703   vector_index = lookup_hash_index ((u8 *) symlink_name);                     \
 704   clib_mem_set_heap (sm->heap); /* Re-enter stat segment */                   \
 705   vec_reset_length (symlink_new_name);                                        \
 706   symlink_new_name = format (symlink_new_name, "/nodes/%U/" #name "%c",       \
 707                              format_vlib_stats_symlink, s, 0);                \
 708   vlib_stats_rename_symlink (oldheap, vector_index, symlink_new_name);
 709                   foreach_stat_segment_node_counter_name
 710 #undef _
 711                     vec_free (symlink_name);
 712                   vec_free (symlink_new_name);
 713                   vec_free (sm->nodes[n->index]);
 714                   sm->nodes[n->index] = s;
 715                   vlib_stat_segment_unlock ();
 716                   clib_mem_set_heap (oldheap);
 717                 }
 718             }
 719
 720           counters = sm->directory_vector[STAT_COUNTER_NODE_CLOCKS].data;
 721           c = counters[j];
 722           c[n->index] = n->stats_total.clocks - n->stats_last_clear.clocks;
 723
 724           counters = sm->directory_vector[STAT_COUNTER_NODE_VECTORS].data;
 725           c = counters[j];
 726           c[n->index] = n->stats_total.vectors - n->stats_last_clear.vectors;
 727
 728           counters = sm->directory_vector[STAT_COUNTER_NODE_CALLS].data;
 729           c = counters[j];
 730           c[n->index] = n->stats_total.calls - n->stats_last_clear.calls;
 731
 732           counters = sm->directory_vector[STAT_COUNTER_NODE_SUSPENDS].data;
 733           c = counters[j];
 734           c[n->index] = n->stats_total.suspends - n->stats_last_clear.suspends;
 735         }
 736       vec_free (node_dups[j]);
 737     }
 738   vec_free (node_dups);
 739   vec_free (stat_vms);
 740 }
 741
 742 static void
 743 do_stat_segment_updates (vlib_main_t *vm, stat_segment_main_t *sm)
 744 {
 745   u64 input_packets;
 746   f64 dt, now;
 747   static int num_worker_threads_set;
 748
 749   /*
 750    * Set once at the beginning of time.
 751    * Can't do this from the init routine, which happens before
 752    * start_workers sets up vlib_mains...
 753    */
 754   if (PREDICT_FALSE (num_worker_threads_set == 0))
 755     {
 756       vlib_thread_main_t *tm = vlib_get_thread_main ();
 757       ASSERT (tm->n_vlib_mains > 0);
 758       stat_provider_register_vector_rate (tm->n_vlib_mains - 1);
 759       sm->directory_vector[STAT_COUNTER_NUM_WORKER_THREADS].value =
 760         tm->n_vlib_mains - 1;
 761       num_worker_threads_set = 1;
 762     }
 763
 764   /*
 765    * Compute the aggregate input rate
 766    */
 767   now = vlib_time_now (vm);
 768   dt = now - sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value;
 769   input_packets = vnet_get_aggregate_rx_packets ();
 770   sm->directory_vector[STAT_COUNTER_INPUT_RATE].value =
 771     (f64) (input_packets - sm->last_input_packets) / dt;
 772   sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value = now;
 773   sm->last_input_packets = input_packets;
 774   sm->directory_vector[STAT_COUNTER_LAST_STATS_CLEAR].value =
 775     vm->node_main.time_last_runtime_stats_clear;
 776
 777   if (sm->node_counters_enabled)
 778     update_node_counters (sm);
 779
 780   /* *INDENT-OFF* */
 781   stat_segment_gauges_pool_t *g;
 782   pool_foreach (g, sm->gauges)
 783     {
 784       if (g->enabled)
 785         g->fn (&sm->directory_vector[g->directory_index], g->caller_index);
 786     }
 787   /* *INDENT-ON* */
 788
 789   /* Heartbeat, so clients detect we're still here */
 790   sm->directory_vector[STAT_COUNTER_HEARTBEAT].value++;
 791 }
 792
 793 /*
 794  * Accept connection on the socket and exchange the fd for the shared
 795  * memory segment.
 796  */
 797 static clib_error_t *
 798 stats_socket_accept_ready (clib_file_t * uf)
 799 {
 800   stat_segment_main_t *sm = &stat_segment_main;
 801   clib_error_t *err;
 802   clib_socket_t client = { 0 };
 803
 804   err = clib_socket_accept (sm->socket, &client);
 805   if (err)
 806     {
 807       clib_error_report (err);
 808       return err;
 809     }
 810
 811   /* Send the fd across and close */
 812   err = clib_socket_sendmsg (&client, 0, 0, &sm->memfd, 1);
 813   if (err)
 814     clib_error_report (err);
 815   clib_socket_close (&client);
 816
 817   return 0;
 818 }
 819
 820 static clib_error_t *
 821 stats_segment_socket_init (void)
 822 {
 823   stat_segment_main_t *sm = &stat_segment_main;
 824   clib_error_t *error;
 825   clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
 826
 827   memset (s, 0, sizeof (clib_socket_t));
 828   s->config = (char *) sm->socket_name;
 829   s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
 830     CLIB_SOCKET_F_ALLOW_GROUP_WRITE | CLIB_SOCKET_F_PASSCRED;
 831
 832   if ((error = clib_socket_init (s)))
 833     return error;
 834
 835   clib_file_t template = { 0 };
 836   template.read_function = stats_socket_accept_ready;
 837   template.file_descriptor = s->fd;
 838   template.description = format (0, "stats segment listener %s", s->config);
 839   clib_file_add (&file_main, &template);
 840
 841   sm->socket = s;
 842
 843   return 0;
 844 }
 845
 846 static clib_error_t *
 847 stats_segment_socket_exit (vlib_main_t * vm)
 848 {
 849   /*
 850    * cleanup the listener socket on exit.
 851    */
 852   stat_segment_main_t *sm = &stat_segment_main;
 853   unlink ((char *) sm->socket_name);
 854   return 0;
 855 }
 856
 857 VLIB_MAIN_LOOP_EXIT_FUNCTION (stats_segment_socket_exit);
 858
 859 /* Overrides weak reference in vlib:node_cli.c */
 860 f64
 861 vlib_get_stat_segment_update_rate (void)
 862 {
 863   return stat_segment_main.update_interval;
 864 }
 865
 866 static uword
 867 stat_segment_collector_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
 868                                 vlib_frame_t * f)
 869 {
 870   stat_segment_main_t *sm = &stat_segment_main;
 871
 872   while (1)
 873     {
 874       do_stat_segment_updates (vm, sm);
 875       vlib_process_suspend (vm, sm->update_interval);
 876     }
 877   return 0;                     /* or not */
 878 }
 879
 880 /*
 881  * Add a data provider (via callback) for a given stats entry.
 882  * TODO: Add support for per-provider interval.
 883  */
 884 uword
 885 stat_segment_poll_add (u32 vector_index, stat_segment_update_fn update_fn,
 886                        u32 caller_index, u32 interval, u8 enabled)
 887 {
 888   stat_segment_main_t *sm = &stat_segment_main;
 889   stat_segment_gauges_pool_t *gauge;
 890
 891   pool_get (sm->gauges, gauge);
 892   gauge->fn = update_fn;
 893   gauge->caller_index = caller_index;
 894   gauge->directory_index = vector_index;
 895   gauge->enabled = enabled;
 896
 897   return pool_elts (sm->gauges) - 1;
 898 }
 899
 900 /*
 901  * Enable (or disable) a callback for a stats entry
 902  */
 903 void
 904 stat_segment_poll_state (uword index, u8 enabled)
 905 {
 906   stat_segment_main_t *sm = &stat_segment_main;
 907   stat_segment_gauges_pool_t *gauge = pool_elt_at_index (sm->gauges, index);
 908
 909   ASSERT (gauge);
 910
 911   gauge->enabled = enabled;
 912 }
 913
 914 /*
 915  * Create an scalar entry with a data provider.
 916  * Deprecated, replace with stat_segment_new_entry + stat_segment_pool_add
 917  */
 918 clib_error_t *
 919 stat_segment_register_gauge (u8 *name, stat_segment_update_fn update_fn,
 920                              u32 caller_index)
 921 {
 922   u32 vector_index = stat_segment_new_entry (name, STAT_DIR_TYPE_SCALAR_INDEX);
 923   if (vector_index == ~0) /* Already registered */
 924     return clib_error_return (0, "%v is already registered", name);
 925
 926   stat_segment_poll_add (vector_index, update_fn, caller_index, -1, true);
 927
 928   return NULL;
 929 }
 930
 931 clib_error_t *
 932 stat_segment_register_state_counter (u8 * name, u32 * index)
 933 {
 934   ASSERT (vlib_get_thread_index () == 0);
 935
 936   u32 vector_index = stat_segment_new_entry (name, STAT_DIR_TYPE_SCALAR_INDEX);
 937   if (vector_index == ~0) /* Already registered */
 938     return clib_error_return (0, "%v is already registered", name);
 939   *index = vector_index;
 940   return 0;
 941 }
 942
 943 clib_error_t *
 944 stat_segment_deregister_state_counter (u32 index)
 945 {
 946   stat_segment_main_t *sm = &stat_segment_main;
 947   stat_segment_shared_header_t *shared_header = sm->shared_header;
 948   stat_segment_directory_entry_t *e;
 949   void *oldheap;
 950
 951   ASSERT (shared_header);
 952
 953   if (index > vec_len (sm->directory_vector))
 954     return clib_error_return (0, "%u index does not exist", index);
 955
 956   e = &sm->directory_vector[index];
 957   if (e->type != STAT_DIR_TYPE_SCALAR_INDEX)
 958     return clib_error_return (0, "%u index cannot be deleted", index);
 959
 960   oldheap = vlib_stats_push_heap (NULL);
 961   vlib_stat_segment_lock ();
 962
 963   vlib_stats_delete_counter (index, oldheap);
 964
 965   vlib_stat_segment_unlock ();
 966   clib_mem_set_heap (oldheap);
 967
 968   return 0;
 969 }
 970
 971 void
 972 stat_segment_set_state_counter (u32 index, u64 value)
 973 {
 974   stat_segment_main_t *sm = &stat_segment_main;
 975
 976   ASSERT (index < vec_len (sm->directory_vector));
 977   sm->directory_vector[index].index = value;
 978 }
 979
 980 static clib_error_t *
 981 statseg_config (vlib_main_t * vm, unformat_input_t * input)
 982 {
 983   stat_segment_main_t *sm = &stat_segment_main;
 984   sm->update_interval = 10.0;
 985
 986   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 987     {
 988       if (unformat (input, "socket-name %s", &sm->socket_name))
 989         ;
 990       /* DEPRECATE: default (does nothing) */
 991       else if (unformat (input, "default"))
 992         ;
 993       else if (unformat (input, "size %U",
 994                          unformat_memory_size, &sm->memory_size))
 995         ;
 996       else if (unformat (input, "page-size %U",
 997                          unformat_log2_page_size, &sm->log2_page_sz))
 998         ;
 999       else if (unformat (input, "per-node-counters on"))
1000         sm->node_counters_enabled = 1;
1001       else if (unformat (input, "per-node-counters off"))
1002         sm->node_counters_enabled = 0;
1003       else if (unformat (input, "update-interval %f", &sm->update_interval))
1004         ;
1005       else
1006         return clib_error_return (0, "unknown input `%U'",
1007                                   format_unformat_error, input);
1008     }
1009
1010   /*
1011    * NULL-terminate socket name string
1012    * clib_socket_init()->socket_config() use C str*
1013    */
1014   if (vec_len (sm->socket_name))
1015     vec_terminate_c_string (sm->socket_name);
1016
1017   return 0;
1018 }
1019
1020 VLIB_EARLY_CONFIG_FUNCTION (statseg_config, "statseg");
1021
1022 static clib_error_t *
1023 statseg_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
1024 {
1025   stat_segment_main_t *sm = &stat_segment_main;
1026   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1027   vnet_sw_interface_t *si_sup =
1028     vnet_get_sup_sw_interface (vnm, si->sw_if_index);
1029   vnet_hw_interface_t *hi_sup;
1030   u8 *s = 0;
1031   u8 *symlink_name = 0;
1032   u32 vector_index;
1033
1034   void *oldheap = vlib_stats_push_heap (sm->interfaces);
1035   vlib_stat_segment_lock ();
1036
1037   vec_validate (sm->interfaces, sw_if_index);
1038
1039   ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
1040   hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
1041
1042   s = format (s, "%v", hi_sup->name);
1043   if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1044     s = format (s, ".%d", si->sub.id);
1045   s = format (s, "%c", 0);
1046
1047   if (is_add)
1048     {
1049       sm->interfaces[sw_if_index] = s;
1050 #define _(E, n, p)                                                            \
1051   clib_mem_set_heap (oldheap); /* Exit stats segment */                       \
1052   vector_index = lookup_hash_index ((u8 *) "/" #p "/" #n);                    \
1053   clib_mem_set_heap (sm->heap); /* Re-enter stat segment */                   \
1054   vec_reset_length (symlink_name);                                            \
1055   symlink_name = format (symlink_name, "/interfaces/%U/" #n "%c",             \
1056                          format_vlib_stats_symlink, s, 0);                    \
1057   vlib_stats_register_symlink (oldheap, symlink_name, vector_index,           \
1058                                sw_if_index, 0 /* don't lock */);
1059       foreach_simple_interface_counter_name
1060         foreach_combined_interface_counter_name
1061 #undef _
1062
1063           vec_free (symlink_name);
1064     }
1065   else
1066     {
1067       vec_free (sm->interfaces[sw_if_index]);
1068       sm->interfaces[sw_if_index] = 0;
1069 #define _(E, n, p)                                                            \
1070   vec_reset_length (symlink_name);                                            \
1071   symlink_name = format (symlink_name, "/interfaces/%U/" #n "%c",             \
1072                          format_vlib_stats_symlink, s, 0);                    \
1073   clib_mem_set_heap (oldheap); /* Exit stats segment */                       \
1074   vector_index = lookup_hash_index ((u8 *) symlink_name);                     \
1075   clib_mem_set_heap (sm->heap); /* Re-enter stat segment */                   \
1076   vlib_stats_delete_counter (vector_index, oldheap);
1077       foreach_simple_interface_counter_name
1078         foreach_combined_interface_counter_name
1079 #undef _
1080
1081           vec_free (symlink_name);
1082     }
1083
1084   stat_segment_directory_entry_t *ep;
1085   ep = &sm->directory_vector[STAT_COUNTER_INTERFACE_NAMES];
1086   ep->data = sm->interfaces;
1087
1088   vlib_stat_segment_unlock ();
1089   clib_mem_set_heap (oldheap);
1090
1091   return 0;
1092 }
1093
1094 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (statseg_sw_interface_add_del);
1095
1096 VLIB_REGISTER_NODE (stat_segment_collector, static) =
1097 {
1098 .function = stat_segment_collector_process,
1099 .name = "statseg-collector-process",
1100 .type = VLIB_NODE_TYPE_PROCESS,
1101 };
1102
1103 static clib_error_t *
1104 statseg_init (vlib_main_t *vm)
1105 {
1106   stat_segment_main_t *sm = &stat_segment_main;
1107
1108   /* set default socket file name when statseg config stanza is empty. */
1109   if (!vec_len (sm->socket_name))
1110     sm->socket_name = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
1111                               STAT_SEGMENT_SOCKET_FILENAME, 0);
1112   return stats_segment_socket_init ();
1113 }
1114
1115 VLIB_INIT_FUNCTION (statseg_init) = {
1116   .runs_after = VLIB_INITS ("unix_input_init"),
1117 };
1118
1119 /*
1120  * fd.io coding-style-patch-verification: ON
1121  *
1122  * Local Variables:
1123  * eval: (c-set-style "gnu")
1124  * End:
1125  */