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