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