src/vpp/stats/stat_segment.c

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