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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
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;
28 * Used only by VPP writers
31 vlib_stat_segment_lock (void)
33 stat_segment_main_t *sm = &stat_segment_main;
34 clib_spinlock_lock (sm->stat_segment_lockp);
35 sm->shared_header->in_progress = 1;
39 vlib_stat_segment_unlock (void)
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);
48 * Change heap to the stats shared memory segment
51 vlib_stats_push_heap (void)
53 stat_segment_main_t *sm = &stat_segment_main;
55 ASSERT (sm && sm->shared_header);
56 return clib_mem_set_heap (sm->heap);
59 /* Name to vector index hash */
61 lookup_or_create_hash_index (void *oldheap, char *name, u32 next_vector_index)
63 stat_segment_main_t *sm = &stat_segment_main;
67 hp = hash_get_pair (sm->directory_vector_by_name, name);
70 hash_set (sm->directory_vector_by_name, name, next_vector_index);
71 index = next_vector_index;
82 vlib_stats_pop_heap (void *cm_arg, void *oldheap, stat_directory_type_t type)
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 };
90 /* Not all counters have names / hash-table entries */
91 if (!cm->name && !cm->stat_segment_name)
93 clib_mem_set_heap (oldheap);
97 ASSERT (shared_header);
99 vlib_stat_segment_lock ();
101 /* Lookup hash-table is on the main heap */
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,
108 /* Back to stats segment */
109 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
112 /* Update the vector */
113 if (vector_index == next_vector_index)
115 strncpy (e.name, stat_segment_name, 128 - 1);
117 vec_add1 (sm->directory_vector, e);
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 */
123 ep->offset_vector ? stat_segment_pointer (shared_header,
124 ep->offset_vector) : 0;
126 /* Update the 2nd dimension offset vector */
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);
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);
139 vlib_stat_segment_unlock ();
140 clib_mem_set_heap (oldheap);
144 vlib_stats_register_error_index (u8 * name, u64 * em_vec, u64 index)
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;
151 ASSERT (shared_header);
153 vlib_stat_segment_lock ();
155 memcpy (e.name, name, vec_len (name));
156 e.name[vec_len (name)] = '\0';
157 e.type = STAT_DIR_TYPE_ERROR_INDEX;
160 vec_add1 (sm->directory_vector, e);
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);
166 vlib_stat_segment_unlock ();
170 stat_validate_counter_vector (stat_segment_directory_entry_t * ep, u32 max)
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 ();
177 u64 *offset_vector = 0;
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++)
183 vec_validate_aligned (counters[i], max, CLIB_CACHE_LINE_BYTES);
184 vec_add1 (offset_vector,
185 stat_segment_offset (shared_header, counters[i]));
187 ep->offset = stat_segment_offset (shared_header, counters);
188 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
192 vlib_stats_pop_heap2 (u64 * error_vector, u32 thread_index, void *oldheap)
194 stat_segment_main_t *sm = &stat_segment_main;
195 stat_segment_shared_header_t *shared_header = sm->shared_header;
197 ASSERT (shared_header);
199 vlib_stat_segment_lock ();
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);
207 vlib_stat_segment_unlock ();
208 clib_mem_set_heap (oldheap);
212 vlib_map_stat_segment_init (void)
214 stat_segment_main_t *sm = &stat_segment_main;
215 stat_segment_shared_header_t *shared_header;
216 stat_segment_directory_entry_t *ep;
220 char *mem_name = "stat_segment_test";
223 memory_size = sm->memory_size;
224 if (memory_size == 0)
225 memory_size = STAT_SEGMENT_DEFAULT_SIZE;
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");
232 if ((ftruncate (mfd, memory_size)) == -1)
233 return clib_error_return (0, "stat segment ftruncate failure");
236 mmap (NULL, memory_size, PROT_READ | PROT_WRITE, MAP_SHARED, mfd,
238 return clib_error_return (0, "stat segment mmap failure");
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);
248 create_mspace_with_base (((u8 *) memaddr) + getpagesize (),
249 memory_size - getpagesize (), 1 /* locked */ );
250 mspace_disable_expand (heap);
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);
261 oldheap = clib_mem_set_heap (sm->heap);
263 /* Set up the name to counter-vector hash table */
264 sm->directory_vector = 0;
266 shared_header->epoch = 1;
268 /* Scalar stats and node counters */
269 vec_validate (sm->directory_vector, STAT_COUNTERS - 1);
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
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);
279 clib_mem_set_heap (oldheap);
285 name_sort_cmp (void *a1, void *a2)
287 stat_segment_directory_entry_t *n1 = a1;
288 stat_segment_directory_entry_t *n2 = a2;
290 return strcmp ((char *) n1->name, (char *) n2->name);
294 format_stat_dir_entry (u8 * s, va_list * args)
296 stat_segment_directory_entry_t *ep =
297 va_arg (*args, stat_segment_directory_entry_t *);
301 format_string = "%-74s %-10s %10lld";
305 case STAT_DIR_TYPE_SCALAR_INDEX:
306 type_name = "ScalarPtr";
309 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
310 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
311 type_name = "CMainPtr";
314 case STAT_DIR_TYPE_ERROR_INDEX:
315 type_name = "ErrIndex";
319 type_name = "illegal!";
323 return format (s, format_string, ep->name, type_name, ep->offset);
326 static clib_error_t *
327 show_stat_segment_command_fn (vlib_main_t * vm,
328 unformat_input_t * input,
329 vlib_cli_command_t * cmd)
331 stat_segment_main_t *sm = &stat_segment_main;
334 stat_segment_directory_entry_t *show_data, *this;
340 if (unformat (input, "verbose"))
343 /* Lock even as reader, as this command doesn't handle epoch changes */
344 vlib_stat_segment_lock ();
345 show_data = vec_dup (sm->directory_vector);
346 vlib_stat_segment_unlock ();
348 vec_sort_with_function (show_data, name_sort_cmp);
350 vlib_cli_output (vm, "%-74s %10s %10s", "Name", "Type", "Value");
352 for (i = 0; i < vec_len (show_data); i++)
354 vlib_cli_output (vm, "%-100U", format_stat_dir_entry,
355 vec_elt_at_index (show_data, i));
361 vlib_cli_output (vm, "%U", format_mheap, sm->heap, 0 /* verbose */ );
368 VLIB_CLI_COMMAND (show_stat_segment_command, static) =
370 .path = "show statistics segment",
371 .short_help = "show statistics segment [verbose]",
372 .function = show_stat_segment_command_fn,
377 * Node performance counters:
378 * total_calls [threads][node-index]
385 update_node_counters (stat_segment_main_t * sm)
387 vlib_main_t *vm = vlib_mains[0];
388 vlib_main_t **stat_vms = 0;
389 vlib_node_t ***node_dups = 0;
391 stat_segment_shared_header_t *shared_header = sm->shared_header;
392 static u32 no_max_nodes = 0;
394 vlib_node_get_nodes (0 /* vm, for barrier sync */ ,
395 (u32) ~ 0 /* all threads */ ,
396 1 /* include stats */ ,
397 0 /* barrier sync */ ,
398 &node_dups, &stat_vms);
400 u32 l = vec_len (node_dups[0]);
403 * Extend performance nodes if necessary
405 if (l > no_max_nodes)
407 void *oldheap = clib_mem_set_heap (sm->heap);
408 vlib_stat_segment_lock ();
410 stat_validate_counter_vector (&sm->directory_vector
411 [STAT_COUNTER_NODE_CLOCKS], l);
412 stat_validate_counter_vector (&sm->directory_vector
413 [STAT_COUNTER_NODE_VECTORS], l);
414 stat_validate_counter_vector (&sm->directory_vector
415 [STAT_COUNTER_NODE_CALLS], l);
416 stat_validate_counter_vector (&sm->directory_vector
417 [STAT_COUNTER_NODE_SUSPENDS], l);
419 vlib_stat_segment_unlock ();
420 clib_mem_set_heap (oldheap);
424 for (j = 0; j < vec_len (node_dups); j++)
426 vlib_node_t **nodes = node_dups[j];
427 u32 l = vec_len (nodes);
429 for (i = 0; i < vec_len (nodes); i++)
431 counter_t **counters;
433 vlib_node_t *n = nodes[i];
436 stat_segment_pointer (shared_header,
438 [STAT_COUNTER_NODE_CLOCKS].offset);
440 c[n->index] = n->stats_total.clocks - n->stats_last_clear.clocks;
443 stat_segment_pointer (shared_header,
445 [STAT_COUNTER_NODE_VECTORS].offset);
447 c[n->index] = n->stats_total.vectors - n->stats_last_clear.vectors;
450 stat_segment_pointer (shared_header,
452 [STAT_COUNTER_NODE_CALLS].offset);
454 c[n->index] = n->stats_total.calls - n->stats_last_clear.calls;
457 stat_segment_pointer (shared_header,
459 [STAT_COUNTER_NODE_SUSPENDS].offset);
462 n->stats_total.suspends - n->stats_last_clear.suspends;
468 do_stat_segment_updates (stat_segment_main_t * sm)
470 vlib_main_t *vm = vlib_mains[0];
472 u64 input_packets, last_input_packets;
474 vlib_main_t *this_vlib_main;
478 * Compute the average vector rate across all workers
482 start = vec_len (vlib_mains) > 1 ? 1 : 0;
484 for (i = start; i < vec_len (vlib_mains); i++)
486 this_vlib_main = vlib_mains[i];
487 vector_rate += vlib_last_vector_length_per_node (this_vlib_main);
489 vector_rate /= (f64) (i - start);
491 sm->directory_vector[STAT_COUNTER_VECTOR_RATE].value =
492 vector_rate / ((f64) (vec_len (vlib_mains) - start));
495 * Compute the aggregate input rate
497 now = vlib_time_now (vm);
498 dt = now - sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value;
499 input_packets = vnet_get_aggregate_rx_packets ();
500 sm->directory_vector[STAT_COUNTER_INPUT_RATE].value =
501 (f64) (input_packets - sm->last_input_packets) / dt;
502 sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value = now;
503 sm->last_input_packets = input_packets;
504 sm->directory_vector[STAT_COUNTER_LAST_STATS_CLEAR].value =
505 vm->node_main.time_last_runtime_stats_clear;
507 if (sm->node_counters_enabled)
508 update_node_counters (sm);
511 stat_segment_gauges_pool_t *g;
512 pool_foreach(g, sm->gauges,
514 g->fn(&sm->directory_vector[g->directory_index], g->caller_index);
518 /* Heartbeat, so clients detect we're still here */
519 sm->directory_vector[STAT_COUNTER_HEARTBEAT].value++;
523 * Accept connection on the socket and exchange the fd for the shared
526 static clib_error_t *
527 stats_socket_accept_ready (clib_file_t * uf)
529 stat_segment_main_t *sm = &stat_segment_main;
531 clib_socket_t client = { 0 };
533 err = clib_socket_accept (sm->socket, &client);
536 clib_error_report (err);
540 /* Send the fd across and close */
541 err = clib_socket_sendmsg (&client, 0, 0, &sm->memfd, 1);
543 clib_error_report (err);
544 clib_socket_close (&client);
550 stats_segment_socket_init (void)
552 stat_segment_main_t *sm = &stat_segment_main;
554 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
556 memset (s, 0, sizeof (clib_socket_t));
557 s->config = (char *) sm->socket_name;
558 s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
559 CLIB_SOCKET_F_ALLOW_GROUP_WRITE | CLIB_SOCKET_F_PASSCRED;
561 if ((error = clib_socket_init (s)))
563 clib_error_report (error);
567 clib_file_t template = { 0 };
568 template.read_function = stats_socket_accept_ready;
569 template.file_descriptor = s->fd;
570 template.description = format (0, "stats segment listener %s", s->config);
571 clib_file_add (&file_main, &template);
576 static clib_error_t *
577 stats_segment_socket_exit (vlib_main_t * vm)
580 * cleanup the listener socket on exit.
582 stat_segment_main_t *sm = &stat_segment_main;
583 unlink ((char *) sm->socket_name);
587 VLIB_MAIN_LOOP_EXIT_FUNCTION (stats_segment_socket_exit);
590 stat_segment_collector_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
593 stat_segment_main_t *sm = &stat_segment_main;
595 /* Wait for Godot... */
596 f64 sleep_duration = 10;
600 do_stat_segment_updates (sm);
601 vlib_process_suspend (vm, sleep_duration);
603 return 0; /* or not */
606 static clib_error_t *
607 statseg_init (vlib_main_t * vm)
609 stat_segment_main_t *sm = &stat_segment_main;
612 /* dependent on unix_input_init */
613 if ((error = vlib_call_init_function (vm, unix_input_init)))
617 stats_segment_socket_init ();
623 stat_segment_register_gauge (u8 * name, stat_segment_update_fn update_fn,
626 stat_segment_main_t *sm = &stat_segment_main;
627 stat_segment_shared_header_t *shared_header = sm->shared_header;
629 stat_segment_directory_entry_t e;
631 stat_segment_gauges_pool_t *gauge;
633 ASSERT (shared_header);
635 oldheap = vlib_stats_push_heap ();
636 vlib_stat_segment_lock ();
638 memset (&e, 0, sizeof (e));
639 e.type = STAT_DIR_TYPE_SCALAR_INDEX;
641 memcpy (e.name, name, vec_len (name));
642 index = vec_len (sm->directory_vector);
643 vec_add1 (sm->directory_vector, e);
645 shared_header->directory_offset =
646 stat_segment_offset (shared_header, sm->directory_vector);
648 vlib_stat_segment_unlock ();
649 clib_mem_set_heap (oldheap);
651 /* Back on our own heap */
652 pool_get (sm->gauges, gauge);
653 gauge->fn = update_fn;
654 gauge->caller_index = caller_index;
655 gauge->directory_index = index;
660 static clib_error_t *
661 statseg_config (vlib_main_t * vm, unformat_input_t * input)
663 stat_segment_main_t *sm = &stat_segment_main;
665 /* set default socket file name when statseg config stanza is empty. */
666 sm->socket_name = format (0, "%s", STAT_SEGMENT_SOCKET_FILE);
668 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
670 if (unformat (input, "socket-name %s", &sm->socket_name))
672 else if (unformat (input, "default"))
673 sm->socket_name = format (0, "%s", STAT_SEGMENT_SOCKET_FILE);
676 (input, "size %U", unformat_memory_size, &sm->memory_size))
678 else if (unformat (input, "per-node-counters on"))
679 sm->node_counters_enabled = 1;
680 else if (unformat (input, "per-node-counters off"))
681 sm->node_counters_enabled = 0;
683 return clib_error_return (0, "unknown input `%U'",
684 format_unformat_error, input);
689 VLIB_INIT_FUNCTION (statseg_init);
690 VLIB_EARLY_CONFIG_FUNCTION (statseg_config, "statseg");
693 VLIB_REGISTER_NODE (stat_segment_collector, static) =
695 .function = stat_segment_collector_process,
696 .name = "statseg-collector-process",
697 .type = VLIB_NODE_TYPE_PROCESS,
703 * fd.io coding-style-patch-verification: ON
706 * eval: (c-set-style "gnu")