src/vpp/stats/stat_segment.c

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