stats: add buffer gauges
[vpp.git] / 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 stat_segment_main_t stat_segment_main;
26
27 /*
28  *  Used only by VPP writers
29  */
30 void
31 vlib_stat_segment_lock (void)
32 {
33   stat_segment_main_t *sm = &stat_segment_main;
34   clib_spinlock_lock (sm->stat_segment_lockp);
35   sm->shared_header->in_progress = 1;
36 }
37
38 void
39 vlib_stat_segment_unlock (void)
40 {
41   stat_segment_main_t *sm = &stat_segment_main;
42   sm->shared_header->epoch++;
43   sm->shared_header->in_progress = 0;
44   clib_spinlock_unlock (sm->stat_segment_lockp);
45 }
46
47 /*
48  * Change heap to the stats shared memory segment
49  */
50 void *
51 vlib_stats_push_heap (void)
52 {
53   stat_segment_main_t *sm = &stat_segment_main;
54
55   ASSERT (sm && sm->shared_header);
56   return clib_mem_set_heap (sm->heap);
57 }
58
59 /* Name to vector index hash */
60 static u32
61 lookup_or_create_hash_index (void *oldheap, char *name, u32 next_vector_index)
62 {
63   stat_segment_main_t *sm = &stat_segment_main;
64   u32 index;
65   hash_pair_t *hp;
66
67   hp = hash_get_pair (sm->directory_vector_by_name, name);
68   if (!hp)
69     {
70       hash_set (sm->directory_vector_by_name, name, next_vector_index);
71       index = next_vector_index;
72     }
73   else
74     {
75       index = hp->value[0];
76     }
77
78   return index;
79 }
80
81 void
82 vlib_stats_pop_heap (void *cm_arg, void *oldheap, stat_directory_type_t type)
83 {
84   vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
85   stat_segment_main_t *sm = &stat_segment_main;
86   stat_segment_shared_header_t *shared_header = sm->shared_header;
87   char *stat_segment_name;
88   stat_segment_directory_entry_t e = { 0 };
89
90   /* Not all counters have names / hash-table entries */
91   if (!cm->name && !cm->stat_segment_name)
92     {
93       clib_mem_set_heap (oldheap);
94       return;
95     }
96
97   ASSERT (shared_header);
98
99   vlib_stat_segment_lock ();
100
101   /* Lookup hash-table is on the main heap */
102   stat_segment_name =
103     cm->stat_segment_name ? cm->stat_segment_name : cm->name;
104   u32 next_vector_index = vec_len (sm->directory_vector);
105   clib_mem_set_heap (oldheap);  /* Exit stats segment */
106   u32 vector_index = lookup_or_create_hash_index (oldheap, stat_segment_name,
107                                                   next_vector_index);
108   /* Back to stats segment */
109   clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
110
111
112   /* Update the vector */
113   if (vector_index == next_vector_index)
114     {                           /* New */
115       strncpy (e.name, stat_segment_name, 128 - 1);
116       e.type = type;
117       vec_add1 (sm->directory_vector, e);
118     }
119
120   stat_segment_directory_entry_t *ep = &sm->directory_vector[vector_index];
121   ep->offset = stat_segment_offset (shared_header, cm->counters);       /* Vector of threads of vectors of counters */
122   u64 *offset_vector =
123     ep->offset_vector ? stat_segment_pointer (shared_header,
124                                               ep->offset_vector) : 0;
125
126   /* Update the 2nd dimension offset vector */
127   int i;
128   vec_validate (offset_vector, vec_len (cm->counters) - 1);
129   for (i = 0; i < vec_len (cm->counters); i++)
130     offset_vector[i] = stat_segment_offset (shared_header, cm->counters[i]);
131   ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
132   sm->directory_vector[vector_index].offset =
133     stat_segment_offset (shared_header, cm->counters);
134
135   /* Reset the client hash table pointer, since it WILL change! */
136   shared_header->directory_offset =
137     stat_segment_offset (shared_header, sm->directory_vector);
138
139   vlib_stat_segment_unlock ();
140   clib_mem_set_heap (oldheap);
141 }
142
143 void
144 vlib_stats_register_error_index (u8 * name, u64 * em_vec, u64 index)
145 {
146   stat_segment_main_t *sm = &stat_segment_main;
147   stat_segment_shared_header_t *shared_header = sm->shared_header;
148   stat_segment_directory_entry_t e;
149   hash_pair_t *hp;
150
151   ASSERT (shared_header);
152
153   vlib_stat_segment_lock ();
154
155   memcpy (e.name, name, vec_len (name));
156   e.name[vec_len (name)] = '\0';
157   e.type = STAT_DIR_TYPE_ERROR_INDEX;
158   e.offset = index;
159   e.offset_vector = 0;
160   vec_add1 (sm->directory_vector, e);
161
162   /* Warn clients to refresh any pointers they might be holding */
163   shared_header->directory_offset =
164     stat_segment_offset (shared_header, sm->directory_vector);
165
166   vlib_stat_segment_unlock ();
167 }
168
169 static void
170 stat_validate_counter_vector (stat_segment_directory_entry_t * ep, u32 max)
171 {
172   stat_segment_main_t *sm = &stat_segment_main;
173   stat_segment_shared_header_t *shared_header = sm->shared_header;
174   counter_t **counters = 0;
175   vlib_thread_main_t *tm = vlib_get_thread_main ();
176   int i;
177   u64 *offset_vector = 0;
178
179   vec_validate_aligned (counters, tm->n_vlib_mains - 1,
180                         CLIB_CACHE_LINE_BYTES);
181   for (i = 0; i < tm->n_vlib_mains; i++)
182     {
183       vec_validate_aligned (counters[i], max, CLIB_CACHE_LINE_BYTES);
184       vec_add1 (offset_vector,
185                 stat_segment_offset (shared_header, counters[i]));
186     }
187   ep->offset = stat_segment_offset (shared_header, counters);
188   ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
189 }
190
191 void
192 vlib_stats_pop_heap2 (u64 * error_vector, u32 thread_index, void *oldheap)
193 {
194   stat_segment_main_t *sm = &stat_segment_main;
195   stat_segment_shared_header_t *shared_header = sm->shared_header;
196
197   ASSERT (shared_header);
198
199   vlib_stat_segment_lock ();
200
201   /* Reset the client hash table pointer, since it WILL change! */
202   shared_header->error_offset =
203     stat_segment_offset (shared_header, error_vector);
204   shared_header->directory_offset =
205     stat_segment_offset (shared_header, sm->directory_vector);
206
207   vlib_stat_segment_unlock ();
208   clib_mem_set_heap (oldheap);
209 }
210
211 clib_error_t *
212 vlib_map_stat_segment_init (void)
213 {
214   stat_segment_main_t *sm = &stat_segment_main;
215   stat_segment_shared_header_t *shared_header;
216   stat_segment_directory_entry_t *ep;
217   void *oldheap;
218   ssize_t memory_size;
219   int mfd;
220   char *mem_name = "stat_segment_test";
221   void *memaddr;
222
223   memory_size = sm->memory_size;
224   if (memory_size == 0)
225     memory_size = STAT_SEGMENT_DEFAULT_SIZE;
226
227   /* Create shared memory segment */
228   if ((mfd = memfd_create (mem_name, 0)) < 0)
229     return clib_error_return (0, "stat segment memfd_create failure");
230
231   /* Set size */
232   if ((ftruncate (mfd, memory_size)) == -1)
233     return clib_error_return (0, "stat segment ftruncate failure");
234
235   if ((memaddr =
236        mmap (NULL, memory_size, PROT_READ | PROT_WRITE, MAP_SHARED, mfd,
237              0)) == MAP_FAILED)
238     return clib_error_return (0, "stat segment mmap failure");
239
240   void *heap;
241 #if USE_DLMALLOC == 0
242   heap = mheap_alloc_with_flags (((u8 *) memaddr) + getpagesize (),
243                                  memory_size - getpagesize (),
244                                  MHEAP_FLAG_DISABLE_VM |
245                                  MHEAP_FLAG_THREAD_SAFE);
246 #else
247   heap =
248     create_mspace_with_base (((u8 *) memaddr) + getpagesize (),
249                              memory_size - getpagesize (), 1 /* locked */ );
250   mspace_disable_expand (heap);
251 #endif
252
253   sm->heap = heap;
254   sm->memfd = mfd;
255
256   sm->directory_vector_by_name = hash_create_string (0, sizeof (uword));
257   sm->shared_header = shared_header = memaddr;
258   sm->stat_segment_lockp = clib_mem_alloc (sizeof (clib_spinlock_t));
259   clib_spinlock_init (sm->stat_segment_lockp);
260
261   oldheap = clib_mem_set_heap (sm->heap);
262
263   /* Set up the name to counter-vector hash table */
264   sm->directory_vector = 0;
265
266   shared_header->epoch = 1;
267
268   /* Scalar stats and node counters */
269   vec_validate (sm->directory_vector, STAT_COUNTERS - 1);
270 #define _(E,t,n,p)                                                      \
271   strcpy(sm->directory_vector[STAT_COUNTER_##E].name,  "/sys" #p "/" #n); \
272   sm->directory_vector[STAT_COUNTER_##E].type = STAT_DIR_TYPE_##t;
273   foreach_stat_segment_counter_name
274 #undef _
275     /* Save the vector offset in the shared segment, for clients */
276     shared_header->directory_offset =
277     stat_segment_offset (shared_header, sm->directory_vector);
278   sm->gauges_fns = 0;
279
280   clib_mem_set_heap (oldheap);
281
282   return 0;
283 }
284
285 static int
286 name_sort_cmp (void *a1, void *a2)
287 {
288   stat_segment_directory_entry_t *n1 = a1;
289   stat_segment_directory_entry_t *n2 = a2;
290
291   return strcmp ((char *) n1->name, (char *) n2->name);
292 }
293
294 static u8 *
295 format_stat_dir_entry (u8 * s, va_list * args)
296 {
297   stat_segment_directory_entry_t *ep =
298     va_arg (*args, stat_segment_directory_entry_t *);
299   char *type_name;
300   char *format_string;
301
302   format_string = "%-74s %-10s %10lld";
303
304   switch (ep->type)
305     {
306     case STAT_DIR_TYPE_SCALAR_INDEX:
307       type_name = "ScalarPtr";
308       break;
309
310     case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
311     case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
312       type_name = "CMainPtr";
313       break;
314
315     case STAT_DIR_TYPE_ERROR_INDEX:
316       type_name = "ErrIndex";
317       break;
318
319     default:
320       type_name = "illegal!";
321       break;
322     }
323
324   return format (s, format_string, ep->name, type_name, ep->offset);
325 }
326
327 static clib_error_t *
328 show_stat_segment_command_fn (vlib_main_t * vm,
329                               unformat_input_t * input,
330                               vlib_cli_command_t * cmd)
331 {
332   stat_segment_main_t *sm = &stat_segment_main;
333   counter_t *counter;
334   hash_pair_t *p;
335   stat_segment_directory_entry_t *show_data, *this;
336   int i, j;
337
338   int verbose = 0;
339   u8 *s;
340
341   if (unformat (input, "verbose"))
342     verbose = 1;
343
344   /* Lock even as reader, as this command doesn't handle epoch changes */
345   vlib_stat_segment_lock ();
346   show_data = vec_dup (sm->directory_vector);
347   vlib_stat_segment_unlock ();
348
349   vec_sort_with_function (show_data, name_sort_cmp);
350
351   vlib_cli_output (vm, "%-74s %10s %10s", "Name", "Type", "Value");
352
353   for (i = 0; i < vec_len (show_data); i++)
354     {
355       vlib_cli_output (vm, "%-100U", format_stat_dir_entry,
356                        vec_elt_at_index (show_data, i));
357     }
358
359   if (verbose)
360     {
361       ASSERT (sm->heap);
362       vlib_cli_output (vm, "%U", format_mheap, sm->heap, 0 /* verbose */ );
363     }
364
365   return 0;
366 }
367
368 /* *INDENT-OFF* */
369 VLIB_CLI_COMMAND (show_stat_segment_command, static) =
370 {
371   .path = "show statistics segment",
372   .short_help = "show statistics segment [verbose]",
373   .function = show_stat_segment_command_fn,
374 };
375 /* *INDENT-ON* */
376
377 /*
378  * Node performance counters:
379  * total_calls [threads][node-index]
380  * total_vectors
381  * total_calls
382  * total suspends
383  */
384
385 static inline void
386 update_node_counters (stat_segment_main_t * sm)
387 {
388   vlib_main_t *vm = vlib_mains[0];
389   vlib_main_t **stat_vms = 0;
390   vlib_node_t ***node_dups = 0;
391   int i, j;
392   stat_segment_shared_header_t *shared_header = sm->shared_header;
393   static u32 no_max_nodes = 0;
394
395   vlib_node_get_nodes (0 /* vm, for barrier sync */ ,
396                        (u32) ~ 0 /* all threads */ ,
397                        1 /* include stats */ ,
398                        0 /* barrier sync */ ,
399                        &node_dups, &stat_vms);
400
401   u32 l = vec_len (node_dups[0]);
402
403   /*
404    * Extend performance nodes if necessary
405    */
406   if (l > no_max_nodes)
407     {
408       void *oldheap = clib_mem_set_heap (sm->heap);
409       vlib_stat_segment_lock ();
410
411       stat_validate_counter_vector (&sm->directory_vector
412                                     [STAT_COUNTER_NODE_CLOCKS], l);
413       stat_validate_counter_vector (&sm->directory_vector
414                                     [STAT_COUNTER_NODE_VECTORS], l);
415       stat_validate_counter_vector (&sm->directory_vector
416                                     [STAT_COUNTER_NODE_CALLS], l);
417       stat_validate_counter_vector (&sm->directory_vector
418                                     [STAT_COUNTER_NODE_SUSPENDS], l);
419
420       vlib_stat_segment_unlock ();
421       clib_mem_set_heap (oldheap);
422       no_max_nodes = l;
423     }
424
425   for (j = 0; j < vec_len (node_dups); j++)
426     {
427       vlib_node_t **nodes = node_dups[j];
428       u32 l = vec_len (nodes);
429
430       for (i = 0; i < vec_len (nodes); i++)
431         {
432           counter_t **counters;
433           counter_t *c;
434           vlib_node_t *n = nodes[i];
435
436           counters =
437             stat_segment_pointer (shared_header,
438                                   sm->directory_vector
439                                   [STAT_COUNTER_NODE_CLOCKS].offset);
440           c = counters[j];
441           c[n->index] = n->stats_total.clocks - n->stats_last_clear.clocks;
442
443           counters =
444             stat_segment_pointer (shared_header,
445                                   sm->directory_vector
446                                   [STAT_COUNTER_NODE_VECTORS].offset);
447           c = counters[j];
448           c[n->index] = n->stats_total.vectors - n->stats_last_clear.vectors;
449
450           counters =
451             stat_segment_pointer (shared_header,
452                                   sm->directory_vector
453                                   [STAT_COUNTER_NODE_CALLS].offset);
454           c = counters[j];
455           c[n->index] = n->stats_total.calls - n->stats_last_clear.calls;
456
457           counters =
458             stat_segment_pointer (shared_header,
459                                   sm->directory_vector
460                                   [STAT_COUNTER_NODE_SUSPENDS].offset);
461           c = counters[j];
462           c[n->index] =
463             n->stats_total.suspends - n->stats_last_clear.suspends;
464         }
465     }
466 }
467
468 static void
469 do_stat_segment_updates (stat_segment_main_t * sm)
470 {
471   vlib_main_t *vm = vlib_mains[0];
472   f64 vector_rate;
473   u64 input_packets, last_input_packets;
474   f64 dt, now;
475   vlib_main_t *this_vlib_main;
476   int i, start;
477
478   /*
479    * Compute the average vector rate across all workers
480    */
481   vector_rate = 0.0;
482
483   start = vec_len (vlib_mains) > 1 ? 1 : 0;
484
485   for (i = start; i < vec_len (vlib_mains); i++)
486     {
487       this_vlib_main = vlib_mains[i];
488       vector_rate += vlib_last_vector_length_per_node (this_vlib_main);
489     }
490   vector_rate /= (f64) (i - start);
491
492   sm->directory_vector[STAT_COUNTER_VECTOR_RATE].value =
493     vector_rate / ((f64) (vec_len (vlib_mains) - start));
494
495   /*
496    * Compute the aggregate input rate
497    */
498   now = vlib_time_now (vm);
499   dt = now - sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value;
500   input_packets = vnet_get_aggregate_rx_packets ();
501   sm->directory_vector[STAT_COUNTER_INPUT_RATE].value =
502     (f64) (input_packets - sm->last_input_packets) / dt;
503   sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value = now;
504   sm->last_input_packets = input_packets;
505   sm->directory_vector[STAT_COUNTER_LAST_STATS_CLEAR].value =
506     vm->node_main.time_last_runtime_stats_clear;
507
508   if (sm->node_counters_enabled)
509     update_node_counters (sm);
510
511   for (i = 0; i < vec_len (sm->gauges_fns); i++)
512     {
513       if (sm->gauges_fns[i])
514         sm->gauges_fns[i] (&sm->directory_vector[i]);
515     }
516
517   /* Heartbeat, so clients detect we're still here */
518   sm->directory_vector[STAT_COUNTER_HEARTBEAT].value++;
519 }
520
521 /*
522  * Accept connection on the socket and exchange the fd for the shared
523  * memory segment.
524  */
525 static clib_error_t *
526 stats_socket_accept_ready (clib_file_t * uf)
527 {
528   stat_segment_main_t *sm = &stat_segment_main;
529   clib_error_t *err;
530   clib_socket_t client = { 0 };
531
532   err = clib_socket_accept (sm->socket, &client);
533   if (err)
534     {
535       clib_error_report (err);
536       return err;
537     }
538
539   /* Send the fd across and close */
540   err = clib_socket_sendmsg (&client, 0, 0, &sm->memfd, 1);
541   if (err)
542     clib_error_report (err);
543   clib_socket_close (&client);
544
545   return 0;
546 }
547
548 static void
549 stats_segment_socket_init (void)
550 {
551   stat_segment_main_t *sm = &stat_segment_main;
552   clib_error_t *error;
553   clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
554
555   memset (s, 0, sizeof (clib_socket_t));
556   s->config = (char *) sm->socket_name;
557   s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
558     CLIB_SOCKET_F_ALLOW_GROUP_WRITE | CLIB_SOCKET_F_PASSCRED;
559
560   if ((error = clib_socket_init (s)))
561     {
562       clib_error_report (error);
563       return;
564     }
565
566   clib_file_t template = { 0 };
567   template.read_function = stats_socket_accept_ready;
568   template.file_descriptor = s->fd;
569   template.description = format (0, "stats segment listener %s", s->config);
570   clib_file_add (&file_main, &template);
571
572   sm->socket = s;
573 }
574
575 static clib_error_t *
576 stats_segment_socket_exit (vlib_main_t * vm)
577 {
578   /*
579    * cleanup the listener socket on exit.
580    */
581   stat_segment_main_t *sm = &stat_segment_main;
582   unlink ((char *) sm->socket_name);
583   return 0;
584 }
585
586 VLIB_MAIN_LOOP_EXIT_FUNCTION (stats_segment_socket_exit);
587
588 static uword
589 stat_segment_collector_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
590                                 vlib_frame_t * f)
591 {
592   stat_segment_main_t *sm = &stat_segment_main;
593
594   /* Wait for Godot... */
595   f64 sleep_duration = 10;
596
597   while (1)
598     {
599       do_stat_segment_updates (sm);
600       vlib_process_suspend (vm, sleep_duration);
601     }
602   return 0;                     /* or not */
603 }
604
605 static clib_error_t *
606 statseg_init (vlib_main_t * vm)
607 {
608   stat_segment_main_t *sm = &stat_segment_main;
609   clib_error_t *error;
610
611   /* dependent on unix_input_init */
612   if ((error = vlib_call_init_function (vm, unix_input_init)))
613     return error;
614
615   if (sm->socket_name)
616     stats_segment_socket_init ();
617
618   return 0;
619 }
620
621 clib_error_t *
622 stat_segment_register_gauge (u8 * name, stat_segment_update_fn update_fn)
623 {
624   stat_segment_main_t *sm = &stat_segment_main;
625   stat_segment_shared_header_t *shared_header = sm->shared_header;
626   void *oldheap;
627   stat_segment_directory_entry_t e;
628   u32 index;
629
630   ASSERT (shared_header);
631
632   oldheap = vlib_stats_push_heap ();
633   vlib_stat_segment_lock ();
634
635   memset (&e, 0, sizeof (e));
636   e.type = STAT_DIR_TYPE_SCALAR_INDEX;
637
638   memcpy (e.name, name, vec_len (name));
639   index = vec_len (sm->directory_vector);
640   vec_add1 (sm->directory_vector, e);
641
642   shared_header->directory_offset =
643     stat_segment_offset (shared_header, sm->directory_vector);
644
645   vlib_stat_segment_unlock ();
646   clib_mem_set_heap (oldheap);
647
648   vec_validate (sm->gauges_fns, index);
649   sm->gauges_fns[index] = update_fn;
650
651   return NULL;
652 }
653
654 static clib_error_t *
655 statseg_config (vlib_main_t * vm, unformat_input_t * input)
656 {
657   stat_segment_main_t *sm = &stat_segment_main;
658
659   /* set default socket file name when statseg config stanza is empty. */
660   sm->socket_name = format (0, "%s", STAT_SEGMENT_SOCKET_FILE);
661
662   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
663     {
664       if (unformat (input, "socket-name %s", &sm->socket_name))
665         ;
666       else if (unformat (input, "default"))
667         sm->socket_name = format (0, "%s", STAT_SEGMENT_SOCKET_FILE);
668       else
669         if (unformat
670             (input, "size %U", unformat_memory_size, &sm->memory_size))
671         ;
672       else if (unformat (input, "per-node-counters on"))
673         sm->node_counters_enabled = 1;
674       else if (unformat (input, "per-node-counters off"))
675         sm->node_counters_enabled = 0;
676       else
677         return clib_error_return (0, "unknown input `%U'",
678                                   format_unformat_error, input);
679     }
680   return 0;
681 }
682
683 VLIB_INIT_FUNCTION (statseg_init);
684 VLIB_EARLY_CONFIG_FUNCTION (statseg_config, "statseg");
685
686 /* *INDENT-OFF* */
687 VLIB_REGISTER_NODE (stat_segment_collector, static) =
688 {
689 .function = stat_segment_collector_process,
690 .name = "statseg-collector-process",
691 .type = VLIB_NODE_TYPE_PROCESS,
692 };
693
694 /* *INDENT-ON* */
695
696 /*
697  * fd.io coding-style-patch-verification: ON
698  *
699  * Local Variables:
700  * eval: (c-set-style "gnu")
701  * End:
702  */