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