src/vpp/stats/stat_segment.c

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <vppinfra/mem.h>
  17 #include <vlib/vlib.h>
  18 #include <vlib/unix/unix.h>
  19 #include "stat_segment.h"
  20 #include <vnet/vnet.h>
  21 #include <vnet/devices/devices.h>       /* vnet_get_aggregate_rx_packets */
  22 #include <vpp-api/client/stat_client.h>
  23
  24 stat_segment_main_t stat_segment_main;
  25
  26 /*
  27  *  Used only by VPP writers
  28  */
  29 void
  30 vlib_stat_segment_lock (void)
  31 {
  32   stat_segment_main_t *sm = &stat_segment_main;
  33   clib_spinlock_lock (sm->stat_segment_lockp);
  34   sm->shared_header->in_progress = 1;
  35 }
  36
  37 void
  38 vlib_stat_segment_unlock (void)
  39 {
  40   stat_segment_main_t *sm = &stat_segment_main;
  41   sm->shared_header->epoch++;
  42   sm->shared_header->in_progress = 0;
  43   clib_spinlock_unlock (sm->stat_segment_lockp);
  44 }
  45
  46 /*
  47  * Change heap to the stats shared memory segment
  48  */
  49 void *
  50 vlib_stats_push_heap (void *old)
  51 {
  52   stat_segment_main_t *sm = &stat_segment_main;
  53
  54   sm->last = old;
  55   ASSERT (sm && sm->shared_header);
  56   return clib_mem_set_heap (sm->heap);
  57 }
  58
  59 static u32
  60 lookup_hash_index (u8 * name)
  61 {
  62   stat_segment_main_t *sm = &stat_segment_main;
  63   u32 index = STAT_SEGMENT_INDEX_INVALID;
  64   hash_pair_t *hp;
  65
  66   /* Must be called in the context of the main heap */
  67   ASSERT (clib_mem_get_heap () != sm->heap);
  68
  69   hp = hash_get_pair (sm->directory_vector_by_name, name);
  70   if (hp)
  71     {
  72       index = hp->value[0];
  73     }
  74
  75   return index;
  76 }
  77
  78 static void
  79 create_hash_index (u8 * name, u32 index)
  80 {
  81   stat_segment_main_t *sm = &stat_segment_main;
  82
  83   /* Must be called in the context of the main heap */
  84   ASSERT (clib_mem_get_heap () != sm->heap);
  85
  86   hash_set (sm->directory_vector_by_name, format (0, "%s%c", name, 0), index);
  87 }
  88
  89 static u32
  90 vlib_stats_get_next_vector_index ()
  91 {
  92   stat_segment_main_t *sm = &stat_segment_main;
  93   u32 next_vector_index = vec_len (sm->directory_vector);
  94
  95   ssize_t i;
  96   vec_foreach_index_backwards (i, sm->directory_vector)
  97   {
  98     if (sm->directory_vector[i].type == STAT_DIR_TYPE_EMPTY)
  99       {
 100         next_vector_index = i;
 101         break;
 102       }
 103   }
 104
 105   return next_vector_index;
 106 }
 107
 108 static u32
 109 vlib_stats_create_counter (stat_segment_directory_entry_t * e, void *oldheap)
 110 {
 111   stat_segment_main_t *sm = &stat_segment_main;
 112
 113   ASSERT (clib_mem_get_heap () == sm->heap);
 114
 115   u32 index = vlib_stats_get_next_vector_index ();
 116
 117   clib_mem_set_heap (oldheap);
 118   create_hash_index ((u8 *) e->name, index);
 119   clib_mem_set_heap (sm->heap);
 120
 121   vec_validate (sm->directory_vector, index);
 122   sm->directory_vector[index] = *e;
 123
 124   return index;
 125 }
 126
 127 static void
 128 vlib_stats_delete_counter (u32 index, void *oldheap)
 129 {
 130   stat_segment_main_t *sm = &stat_segment_main;
 131   stat_segment_directory_entry_t *e;
 132
 133   ASSERT (clib_mem_get_heap () == sm->heap);
 134
 135   if (index > vec_len (sm->directory_vector))
 136     return;
 137
 138   e = &sm->directory_vector[index];
 139
 140   clib_mem_set_heap (oldheap);
 141   hash_unset (sm->directory_vector_by_name, &e->name);
 142   clib_mem_set_heap (sm->heap);
 143
 144   memset (e, 0, sizeof (*e));
 145   e->type = STAT_DIR_TYPE_EMPTY;
 146 }
 147
 148 /*
 149  * Called from main heap
 150  */
 151 void
 152 vlib_stats_delete_cm (void *cm_arg)
 153 {
 154   vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
 155   stat_segment_main_t *sm = &stat_segment_main;
 156   stat_segment_directory_entry_t *e;
 157
 158   /* Not all counters have names / hash-table entries */
 159   if (!cm->name && !cm->stat_segment_name)
 160     {
 161       return;
 162     }
 163   vlib_stat_segment_lock ();
 164
 165   /* Lookup hash-table is on the main heap */
 166   char *stat_segment_name =
 167     cm->stat_segment_name ? cm->stat_segment_name : cm->name;
 168   u32 index = lookup_hash_index ((u8 *) stat_segment_name);
 169
 170   e = &sm->directory_vector[index];
 171   hash_unset (sm->directory_vector_by_name, &e->name);
 172
 173   void *oldheap = clib_mem_set_heap (sm->heap); /* Enter stats segment */
 174   clib_mem_set_heap (oldheap);  /* Exit stats segment */
 175
 176   memset (e, 0, sizeof (*e));
 177   e->type = STAT_DIR_TYPE_EMPTY;
 178
 179   vlib_stat_segment_unlock ();
 180 }
 181
 182 void
 183 vlib_stats_pop_heap (void *cm_arg, void *oldheap, u32 cindex,
 184                      stat_directory_type_t type)
 185 {
 186   vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
 187   stat_segment_main_t *sm = &stat_segment_main;
 188   stat_segment_shared_header_t *shared_header = sm->shared_header;
 189   char *stat_segment_name;
 190   stat_segment_directory_entry_t e = { 0 };
 191
 192   /* Not all counters have names / hash-table entries */
 193   if (!cm->name && !cm->stat_segment_name)
 194     {
 195       clib_mem_set_heap (oldheap);
 196       return;
 197     }
 198
 199   ASSERT (shared_header);
 200
 201   vlib_stat_segment_lock ();
 202
 203   /* Lookup hash-table is on the main heap */
 204   stat_segment_name =
 205     cm->stat_segment_name ? cm->stat_segment_name : cm->name;
 206
 207   clib_mem_set_heap (oldheap);  /* Exit stats segment */
 208   u32 vector_index = lookup_hash_index ((u8 *) stat_segment_name);
 209   /* Back to stats segment */
 210   clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
 211
 212
 213   /* Update the vector */
 214   if (vector_index == STAT_SEGMENT_INDEX_INVALID)
 215     {                           /* New */
 216       strncpy (e.name, stat_segment_name, 128 - 1);
 217       e.type = type;
 218       vector_index = vlib_stats_create_counter (&e, oldheap);
 219     }
 220
 221   stat_segment_directory_entry_t *ep = &sm->directory_vector[vector_index];
 222   ep->data = cm->counters;
 223
 224   /* Reset the client hash table pointer, since it WILL change! */
 225   shared_header->directory_vector = sm->directory_vector;
 226
 227   vlib_stat_segment_unlock ();
 228   clib_mem_set_heap (oldheap);
 229 }
 230
 231 void
 232 vlib_stats_register_error_index (void *oldheap, u8 * name, u64 * em_vec,
 233                                  u64 index)
 234 {
 235   stat_segment_main_t *sm = &stat_segment_main;
 236   stat_segment_shared_header_t *shared_header = sm->shared_header;
 237   stat_segment_directory_entry_t e;
 238
 239   ASSERT (shared_header);
 240
 241   vlib_stat_segment_lock ();
 242   clib_mem_set_heap (oldheap);  /* Exit stats segment */
 243   u32 vector_index = lookup_hash_index (name);
 244   /* Back to stats segment */
 245   clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
 246
 247   if (vector_index == STAT_SEGMENT_INDEX_INVALID)
 248     {
 249       memcpy (e.name, name, vec_len (name));
 250       e.name[vec_len (name)] = '\0';
 251       e.type = STAT_DIR_TYPE_ERROR_INDEX;
 252       e.index = index;
 253       vector_index = vlib_stats_create_counter (&e, oldheap);
 254
 255       /* Warn clients to refresh any pointers they might be holding */
 256       shared_header->directory_vector = sm->directory_vector;
 257     }
 258
 259   vlib_stat_segment_unlock ();
 260 }
 261
 262 static void
 263 stat_validate_counter_vector (stat_segment_directory_entry_t * ep, u32 max)
 264 {
 265   counter_t **counters = ep->data;
 266   vlib_thread_main_t *tm = vlib_get_thread_main ();
 267   int i;
 268
 269   vec_validate_aligned (counters, tm->n_vlib_mains - 1,
 270                         CLIB_CACHE_LINE_BYTES);
 271   for (i = 0; i < tm->n_vlib_mains; i++)
 272     vec_validate_aligned (counters[i], max, CLIB_CACHE_LINE_BYTES);
 273
 274   ep->data = counters;
 275 }
 276
 277 always_inline void
 278 stat_set_simple_counter (stat_segment_directory_entry_t * ep,
 279                          u32 thread_index, u32 index, u64 value)
 280 {
 281   ASSERT (ep->data);
 282   counter_t **counters = ep->data;
 283   counter_t *cb = counters[thread_index];
 284   cb[index] = value;
 285 }
 286
 287 void
 288 vlib_stats_pop_heap2 (u64 * error_vector, u32 thread_index, void *oldheap,
 289                       int lock)
 290 {
 291   stat_segment_main_t *sm = &stat_segment_main;
 292   stat_segment_shared_header_t *shared_header = sm->shared_header;
 293
 294   ASSERT (shared_header);
 295
 296   if (lock)
 297     vlib_stat_segment_lock ();
 298
 299   /* Reset the client hash table pointer, since it WILL change! */
 300   vec_validate (sm->error_vector, thread_index);
 301   sm->error_vector[thread_index] = error_vector;
 302
 303   shared_header->error_vector = sm->error_vector;
 304   shared_header->directory_vector = sm->directory_vector;
 305
 306   if (lock)
 307     vlib_stat_segment_unlock ();
 308   clib_mem_set_heap (oldheap);
 309 }
 310
 311 clib_error_t *
 312 vlib_map_stat_segment_init (void)
 313 {
 314   stat_segment_main_t *sm = &stat_segment_main;
 315   stat_segment_shared_header_t *shared_header;
 316   void *oldheap;
 317   uword memory_size, sys_page_sz;
 318   int mfd;
 319   char *mem_name = "stat segment";
 320   void *heap, *memaddr;
 321
 322   memory_size = sm->memory_size;
 323   if (memory_size == 0)
 324     memory_size = STAT_SEGMENT_DEFAULT_SIZE;
 325
 326   if (sm->log2_page_sz == CLIB_MEM_PAGE_SZ_UNKNOWN)
 327     sm->log2_page_sz = CLIB_MEM_PAGE_SZ_DEFAULT;
 328
 329   mfd = clib_mem_vm_create_fd (sm->log2_page_sz, mem_name);
 330
 331   if (mfd == -1)
 332     return clib_error_return (0, "stat segment memory fd failure: %U",
 333                               format_clib_error, clib_mem_get_last_error ());
 334   /* Set size */
 335   if ((ftruncate (mfd, memory_size)) == -1)
 336     {
 337       close (mfd);
 338       return clib_error_return (0, "stat segment ftruncate failure");
 339     }
 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 (vlib_main_t *vm, stat_segment_main_t *sm)
 592 {
 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 < vlib_get_n_threads (); i++)
 624     {
 625
 626       f64 this_vector_rate;
 627
 628       this_vlib_main = vlib_get_main_by_index (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 (vm, 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  */