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