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