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 #include <vpp-api/client/stat_client.h>
24 stat_segment_main_t stat_segment_main;
27 * Used only by VPP writers
30 vlib_stat_segment_lock (void)
32 stat_segment_main_t *sm = &stat_segment_main;
33 clib_spinlock_lock (sm->stat_segment_lockp);
34 sm->shared_header->in_progress = 1;
38 vlib_stat_segment_unlock (void)
40 stat_segment_main_t *sm = &stat_segment_main;
41 sm->shared_header->epoch++;
42 sm->shared_header->in_progress = 0;
43 clib_spinlock_unlock (sm->stat_segment_lockp);
47 * Change heap to the stats shared memory segment
50 vlib_stats_push_heap (void *old)
52 stat_segment_main_t *sm = &stat_segment_main;
55 ASSERT (sm && sm->shared_header);
56 return clib_mem_set_heap (sm->heap);
60 lookup_hash_index (u8 * name)
62 stat_segment_main_t *sm = &stat_segment_main;
63 u32 index = STAT_SEGMENT_INDEX_INVALID;
66 /* Must be called in the context of the main heap */
67 ASSERT (clib_mem_get_heap () != sm->heap);
69 hp = hash_get_pair (sm->directory_vector_by_name, name);
79 create_hash_index (u8 * name, u32 index)
81 stat_segment_main_t *sm = &stat_segment_main;
83 /* Must be called in the context of the main heap */
84 ASSERT (clib_mem_get_heap () != sm->heap);
86 hash_set (sm->directory_vector_by_name, format (0, "%s%c", name, 0), index);
90 vlib_stats_get_next_vector_index ()
92 stat_segment_main_t *sm = &stat_segment_main;
93 u32 next_vector_index = vec_len (sm->directory_vector);
96 vec_foreach_index_backwards (i, sm->directory_vector)
98 if (sm->directory_vector[i].type == STAT_DIR_TYPE_EMPTY)
100 next_vector_index = i;
105 return next_vector_index;
109 vlib_stats_create_counter (stat_segment_directory_entry_t * e, void *oldheap)
111 stat_segment_main_t *sm = &stat_segment_main;
113 ASSERT (clib_mem_get_heap () == sm->heap);
115 u32 index = vlib_stats_get_next_vector_index ();
117 clib_mem_set_heap (oldheap);
118 create_hash_index ((u8 *) e->name, index);
119 clib_mem_set_heap (sm->heap);
121 vec_validate (sm->directory_vector, index);
122 sm->directory_vector[index] = *e;
128 vlib_stats_delete_counter (u32 index, void *oldheap)
130 stat_segment_main_t *sm = &stat_segment_main;
131 stat_segment_directory_entry_t *e;
133 ASSERT (clib_mem_get_heap () == sm->heap);
135 if (index > vec_len (sm->directory_vector))
138 e = &sm->directory_vector[index];
140 clib_mem_set_heap (oldheap);
141 hash_unset (sm->directory_vector_by_name, &e->name);
142 clib_mem_set_heap (sm->heap);
144 memset (e, 0, sizeof (*e));
145 e->type = STAT_DIR_TYPE_EMPTY;
149 * Called from main heap
152 vlib_stats_delete_cm (void *cm_arg)
154 vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
155 stat_segment_main_t *sm = &stat_segment_main;
156 stat_segment_directory_entry_t *e;
158 /* Not all counters have names / hash-table entries */
159 if (!cm->name && !cm->stat_segment_name)
163 vlib_stat_segment_lock ();
165 /* Lookup hash-table is on the main heap */
166 char *stat_segment_name =
167 cm->stat_segment_name ? cm->stat_segment_name : cm->name;
168 u32 index = lookup_hash_index ((u8 *) stat_segment_name);
170 e = &sm->directory_vector[index];
171 hash_unset (sm->directory_vector_by_name, &e->name);
173 void *oldheap = clib_mem_set_heap (sm->heap); /* Enter stats segment */
174 clib_mem_set_heap (oldheap); /* Exit stats segment */
176 memset (e, 0, sizeof (*e));
177 e->type = STAT_DIR_TYPE_EMPTY;
179 vlib_stat_segment_unlock ();
183 vlib_stats_pop_heap (void *cm_arg, void *oldheap, u32 cindex,
184 stat_directory_type_t type)
186 vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
187 stat_segment_main_t *sm = &stat_segment_main;
188 stat_segment_shared_header_t *shared_header = sm->shared_header;
189 char *stat_segment_name;
190 stat_segment_directory_entry_t e = { 0 };
192 /* Not all counters have names / hash-table entries */
193 if (!cm->name && !cm->stat_segment_name)
195 clib_mem_set_heap (oldheap);
199 ASSERT (shared_header);
201 vlib_stat_segment_lock ();
203 /* Lookup hash-table is on the main heap */
205 cm->stat_segment_name ? cm->stat_segment_name : cm->name;
207 clib_mem_set_heap (oldheap); /* Exit stats segment */
208 u32 vector_index = lookup_hash_index ((u8 *) stat_segment_name);
209 /* Back to stats segment */
210 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
213 /* Update the vector */
214 if (vector_index == STAT_SEGMENT_INDEX_INVALID)
216 strncpy (e.name, stat_segment_name, 128 - 1);
218 vector_index = vlib_stats_create_counter (&e, oldheap);
221 stat_segment_directory_entry_t *ep = &sm->directory_vector[vector_index];
222 ep->data = cm->counters;
224 /* Reset the client hash table pointer, since it WILL change! */
225 shared_header->directory_vector = sm->directory_vector;
227 vlib_stat_segment_unlock ();
228 clib_mem_set_heap (oldheap);
232 format_vlib_stats_symlink (u8 *s, va_list *args)
234 char *input = va_arg (*args, char *);
235 char *modified_input = vec_dup (input);
239 for (i = 0; i < strlen (modified_input); i++)
240 if (modified_input[i] == '/')
241 modified_input[i] = '_';
243 result = format (s, "%s", modified_input);
244 vec_free (modified_input);
249 vlib_stats_register_symlink (void *oldheap, u8 *name, u32 index1, u32 index2,
252 stat_segment_main_t *sm = &stat_segment_main;
253 stat_segment_shared_header_t *shared_header = sm->shared_header;
254 stat_segment_directory_entry_t e;
256 ASSERT (shared_header);
259 vlib_stat_segment_lock ();
260 clib_mem_set_heap (oldheap); /* Exit stats segment */
261 u32 vector_index = lookup_hash_index (name);
262 /* Back to stats segment */
263 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
265 if (vector_index == STAT_SEGMENT_INDEX_INVALID)
267 memcpy (e.name, name, vec_len (name));
268 e.name[vec_len (name)] = '\0';
269 e.type = STAT_DIR_TYPE_SYMLINK;
272 vector_index = vlib_stats_create_counter (&e, oldheap);
274 /* Warn clients to refresh any pointers they might be holding */
275 shared_header->directory_vector = sm->directory_vector;
279 vlib_stat_segment_unlock ();
283 vlib_stats_rename_symlink (void *oldheap, u64 index, u8 *new_name)
285 stat_segment_main_t *sm = &stat_segment_main;
286 stat_segment_directory_entry_t *e;
288 ASSERT (clib_mem_get_heap () == sm->heap);
290 if (index > vec_len (sm->directory_vector))
293 e = &sm->directory_vector[index];
295 clib_mem_set_heap (oldheap);
296 hash_unset (sm->directory_vector_by_name, &e->name);
297 clib_mem_set_heap (sm->heap);
299 strncpy (e->name, (char *) new_name, 128 - 1);
300 clib_mem_set_heap (oldheap);
301 hash_set (sm->directory_vector_by_name, &e->name, index);
302 clib_mem_set_heap (sm->heap);
306 vlib_stats_register_error_index (void *oldheap, u8 * name, u64 * em_vec,
309 stat_segment_main_t *sm = &stat_segment_main;
310 stat_segment_shared_header_t *shared_header = sm->shared_header;
311 stat_segment_directory_entry_t e;
313 ASSERT (shared_header);
315 vlib_stat_segment_lock ();
316 clib_mem_set_heap (oldheap); /* Exit stats segment */
317 u32 vector_index = lookup_hash_index (name);
318 /* Back to stats segment */
319 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
321 if (vector_index == STAT_SEGMENT_INDEX_INVALID)
323 memcpy (e.name, name, vec_len (name));
324 e.name[vec_len (name)] = '\0';
325 e.type = STAT_DIR_TYPE_ERROR_INDEX;
327 vector_index = vlib_stats_create_counter (&e, oldheap);
329 /* Warn clients to refresh any pointers they might be holding */
330 shared_header->directory_vector = sm->directory_vector;
333 vlib_stat_segment_unlock ();
337 * Creates a two dimensional vector with the maximum valid index specified in
338 * both dimensions as arguments.
339 * Must be called on the stat segment heap.
342 stat_validate_counter_vector2 (stat_segment_directory_entry_t *ep, u32 max1,
345 counter_t **counters = ep->data;
347 vec_validate_aligned (counters, max1, CLIB_CACHE_LINE_BYTES);
348 for (i = 0; i <= max1; i++)
349 vec_validate_aligned (counters[i], max2, CLIB_CACHE_LINE_BYTES);
355 stat_validate_counter_vector (stat_segment_directory_entry_t *ep, u32 max)
357 vlib_thread_main_t *tm = vlib_get_thread_main ();
358 ASSERT (tm->n_vlib_mains > 0);
359 stat_validate_counter_vector2 (ep, tm->n_vlib_mains, max);
363 stat_set_simple_counter (stat_segment_directory_entry_t * ep,
364 u32 thread_index, u32 index, u64 value)
367 counter_t **counters = ep->data;
368 counter_t *cb = counters[thread_index];
373 vlib_stats_pop_heap2 (u64 * error_vector, u32 thread_index, void *oldheap,
376 stat_segment_main_t *sm = &stat_segment_main;
377 stat_segment_shared_header_t *shared_header = sm->shared_header;
379 ASSERT (shared_header);
382 vlib_stat_segment_lock ();
384 /* Reset the client hash table pointer, since it WILL change! */
385 vec_validate (sm->error_vector, thread_index);
386 sm->error_vector[thread_index] = error_vector;
388 shared_header->error_vector = sm->error_vector;
389 shared_header->directory_vector = sm->directory_vector;
392 vlib_stat_segment_unlock ();
393 clib_mem_set_heap (oldheap);
397 * Create a new entry and add name to directory hash.
398 * Returns ~0 if name exists.
399 * Called from main heap.
402 stat_segment_new_entry (u8 *name, stat_directory_type_t t)
404 stat_segment_main_t *sm = &stat_segment_main;
405 stat_segment_shared_header_t *shared_header = sm->shared_header;
407 stat_segment_directory_entry_t e;
409 ASSERT (shared_header);
411 u32 vector_index = lookup_hash_index (name);
412 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
415 memset (&e, 0, sizeof (e));
417 memcpy (e.name, name, vec_len (name));
419 oldheap = vlib_stats_push_heap (NULL);
420 vlib_stat_segment_lock ();
421 vector_index = vlib_stats_create_counter (&e, oldheap);
423 shared_header->directory_vector = sm->directory_vector;
425 vlib_stat_segment_unlock ();
426 clib_mem_set_heap (oldheap);
432 vlib_map_stat_segment_init (void)
434 stat_segment_main_t *sm = &stat_segment_main;
435 stat_segment_shared_header_t *shared_header;
437 uword memory_size, sys_page_sz;
439 char *mem_name = "stat segment";
440 void *heap, *memaddr;
442 memory_size = sm->memory_size;
443 if (memory_size == 0)
444 memory_size = STAT_SEGMENT_DEFAULT_SIZE;
446 if (sm->log2_page_sz == CLIB_MEM_PAGE_SZ_UNKNOWN)
447 sm->log2_page_sz = CLIB_MEM_PAGE_SZ_DEFAULT;
449 mfd = clib_mem_vm_create_fd (sm->log2_page_sz, mem_name);
452 return clib_error_return (0, "stat segment memory fd failure: %U",
453 format_clib_error, clib_mem_get_last_error ());
455 if ((ftruncate (mfd, memory_size)) == -1)
458 return clib_error_return (0, "stat segment ftruncate failure");
461 memaddr = clib_mem_vm_map_shared (0, memory_size, mfd, 0, mem_name);
463 if (memaddr == CLIB_MEM_VM_MAP_FAILED)
464 return clib_error_return (0, "stat segment mmap failure");
466 sys_page_sz = clib_mem_get_page_size ();
469 clib_mem_create_heap (((u8 *) memaddr) + sys_page_sz,
470 memory_size - sys_page_sz, 1 /* locked */, mem_name);
474 sm->directory_vector_by_name = hash_create_string (0, sizeof (uword));
475 sm->shared_header = shared_header = memaddr;
477 shared_header->version = STAT_SEGMENT_VERSION;
478 shared_header->base = memaddr;
480 sm->stat_segment_lockp = clib_mem_alloc (sizeof (clib_spinlock_t));
481 clib_spinlock_init (sm->stat_segment_lockp);
483 oldheap = clib_mem_set_heap (sm->heap);
485 /* Set up the name to counter-vector hash table */
486 sm->directory_vector = 0;
488 shared_header->epoch = 1;
490 /* Scalar stats and node counters */
491 vec_validate (sm->directory_vector, STAT_COUNTERS - 1);
493 strcpy(sm->directory_vector[STAT_COUNTER_##E].name, #p "/" #n); \
494 sm->directory_vector[STAT_COUNTER_##E].type = STAT_DIR_TYPE_##t;
495 foreach_stat_segment_counter_name
497 /* Save the vector in the shared segment, for clients */
498 shared_header->directory_vector = sm->directory_vector;
500 clib_mem_set_heap (oldheap);
502 vlib_stats_register_mem_heap (heap);
508 name_sort_cmp (void *a1, void *a2)
510 stat_segment_directory_entry_t *n1 = a1;
511 stat_segment_directory_entry_t *n2 = a2;
513 return strcmp ((char *) n1->name, (char *) n2->name);
517 format_stat_dir_entry (u8 * s, va_list * args)
519 stat_segment_directory_entry_t *ep =
520 va_arg (*args, stat_segment_directory_entry_t *);
524 format_string = "%-74s %-10s %10lld";
528 case STAT_DIR_TYPE_SCALAR_INDEX:
529 type_name = "ScalarPtr";
532 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
533 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
534 type_name = "CMainPtr";
537 case STAT_DIR_TYPE_ERROR_INDEX:
538 type_name = "ErrIndex";
541 case STAT_DIR_TYPE_NAME_VECTOR:
542 type_name = "NameVector";
545 case STAT_DIR_TYPE_EMPTY:
549 case STAT_DIR_TYPE_SYMLINK:
550 type_name = "Symlink";
554 type_name = "illegal!";
558 return format (s, format_string, ep->name, type_name, 0);
561 static clib_error_t *
562 show_stat_segment_command_fn (vlib_main_t * vm,
563 unformat_input_t * input,
564 vlib_cli_command_t * cmd)
566 stat_segment_main_t *sm = &stat_segment_main;
567 stat_segment_directory_entry_t *show_data;
572 if (unformat (input, "verbose"))
575 /* Lock even as reader, as this command doesn't handle epoch changes */
576 vlib_stat_segment_lock ();
577 show_data = vec_dup (sm->directory_vector);
578 vlib_stat_segment_unlock ();
580 vec_sort_with_function (show_data, name_sort_cmp);
582 vlib_cli_output (vm, "%-74s %10s %10s", "Name", "Type", "Value");
584 for (i = 0; i < vec_len (show_data); i++)
586 stat_segment_directory_entry_t *ep = vec_elt_at_index (show_data, i);
588 if (ep->type == STAT_DIR_TYPE_EMPTY)
591 vlib_cli_output (vm, "%-100U", format_stat_dir_entry,
592 vec_elt_at_index (show_data, i));
598 vlib_cli_output (vm, "%U", format_clib_mem_heap, sm->heap,
606 VLIB_CLI_COMMAND (show_stat_segment_command, static) =
608 .path = "show statistics segment",
609 .short_help = "show statistics segment [verbose]",
610 .function = show_stat_segment_command_fn,
615 * Node performance counters:
616 * total_calls [threads][node-index]
623 update_node_counters (stat_segment_main_t * sm)
625 vlib_main_t **stat_vms = 0;
626 vlib_node_t ***node_dups = 0;
628 static u32 no_max_nodes = 0;
630 vlib_node_get_nodes (0 /* vm, for barrier sync */,
631 (u32) ~0 /* all threads */, 1 /* include stats */,
632 0 /* barrier sync */, &node_dups, &stat_vms);
634 u32 l = vec_len (node_dups[0]);
635 u8 *symlink_name = 0;
638 * Extend performance nodes if necessary
640 if (l > no_max_nodes)
642 void *oldheap = clib_mem_set_heap (sm->heap);
643 vlib_stat_segment_lock ();
645 stat_validate_counter_vector (
646 &sm->directory_vector[STAT_COUNTER_NODE_CLOCKS], l - 1);
647 stat_validate_counter_vector (
648 &sm->directory_vector[STAT_COUNTER_NODE_VECTORS], l - 1);
649 stat_validate_counter_vector (
650 &sm->directory_vector[STAT_COUNTER_NODE_CALLS], l - 1);
651 stat_validate_counter_vector (
652 &sm->directory_vector[STAT_COUNTER_NODE_SUSPENDS], l - 1);
654 vec_validate (sm->nodes, l - 1);
655 stat_segment_directory_entry_t *ep;
656 ep = &sm->directory_vector[STAT_COUNTER_NODE_NAMES];
657 ep->data = sm->nodes;
659 /* Update names dictionary */
660 vlib_node_t **nodes = node_dups[0];
662 for (i = 0; i < vec_len (nodes); i++)
664 vlib_node_t *n = nodes[i];
666 s = format (s, "%v%c", n->name, 0);
667 if (sm->nodes[n->index])
668 vec_free (sm->nodes[n->index]);
669 sm->nodes[n->index] = s;
671 #define _(E, t, name, p) \
672 vec_reset_length (symlink_name); \
673 symlink_name = format (symlink_name, "/nodes/%U/" #name "%c", \
674 format_vlib_stats_symlink, s, 0); \
675 vlib_stats_register_symlink (oldheap, symlink_name, STAT_COUNTER_##E, \
676 n->index, 0 /* don't lock */);
677 foreach_stat_segment_node_counter_name
680 vec_free (symlink_name);
681 vlib_stat_segment_unlock ();
682 clib_mem_set_heap (oldheap);
686 for (j = 0; j < vec_len (node_dups); j++)
688 vlib_node_t **nodes = node_dups[j];
690 for (i = 0; i < vec_len (nodes); i++)
692 counter_t **counters;
694 vlib_node_t *n = nodes[i];
698 if (strncmp ((char *) sm->nodes[n->index], (char *) n->name,
699 strlen ((char *) sm->nodes[n->index])))
703 u8 *symlink_new_name = 0;
704 void *oldheap = clib_mem_set_heap (sm->heap);
705 vlib_stat_segment_lock ();
706 s = format (s, "%v%c", n->name, 0);
707 #define _(E, t, name, p) \
708 vec_reset_length (symlink_name); \
709 symlink_name = format (symlink_name, "/nodes/%U/" #name "%c", \
710 format_vlib_stats_symlink, sm->nodes[n->index], 0); \
711 clib_mem_set_heap (oldheap); /* Exit stats segment */ \
712 vector_index = lookup_hash_index ((u8 *) symlink_name); \
713 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */ \
714 vec_reset_length (symlink_new_name); \
715 symlink_new_name = format (symlink_new_name, "/nodes/%U/" #name "%c", \
716 format_vlib_stats_symlink, s, 0); \
717 vlib_stats_rename_symlink (oldheap, vector_index, symlink_new_name);
718 foreach_stat_segment_node_counter_name
720 vec_free (symlink_name);
721 vec_free (symlink_new_name);
722 vec_free (sm->nodes[n->index]);
723 sm->nodes[n->index] = s;
724 vlib_stat_segment_unlock ();
725 clib_mem_set_heap (oldheap);
729 counters = sm->directory_vector[STAT_COUNTER_NODE_CLOCKS].data;
731 c[n->index] = n->stats_total.clocks - n->stats_last_clear.clocks;
733 counters = sm->directory_vector[STAT_COUNTER_NODE_VECTORS].data;
735 c[n->index] = n->stats_total.vectors - n->stats_last_clear.vectors;
737 counters = sm->directory_vector[STAT_COUNTER_NODE_CALLS].data;
739 c[n->index] = n->stats_total.calls - n->stats_last_clear.calls;
741 counters = sm->directory_vector[STAT_COUNTER_NODE_SUSPENDS].data;
743 c[n->index] = n->stats_total.suspends - n->stats_last_clear.suspends;
745 vec_free (node_dups[j]);
747 vec_free (node_dups);
752 do_stat_segment_updates (vlib_main_t *vm, stat_segment_main_t *sm)
757 vlib_main_t *this_vlib_main;
759 static int num_worker_threads_set;
762 * Set once at the beginning of time.
763 * Can't do this from the init routine, which happens before
764 * start_workers sets up vlib_mains...
766 if (PREDICT_FALSE (num_worker_threads_set == 0))
768 void *oldheap = clib_mem_set_heap (sm->heap);
769 vlib_stat_segment_lock ();
771 stat_validate_counter_vector (&sm->directory_vector
772 [STAT_COUNTER_VECTOR_RATE_PER_WORKER], 0);
773 num_worker_threads_set = 1;
774 vlib_stat_segment_unlock ();
775 clib_mem_set_heap (oldheap);
779 * Compute per-worker vector rates, and the average vector rate
784 for (i = 0; i < vlib_get_n_threads (); i++)
787 f64 this_vector_rate;
789 this_vlib_main = vlib_get_main_by_index (i);
791 this_vector_rate = vlib_internal_node_vector_rate (this_vlib_main);
792 vlib_clear_internal_node_vector_rate (this_vlib_main);
794 vector_rate += this_vector_rate;
796 /* Set the per-worker rate */
797 stat_set_simple_counter (&sm->directory_vector
798 [STAT_COUNTER_VECTOR_RATE_PER_WORKER], i, 0,
802 /* And set the system average rate */
803 vector_rate /= (f64) (i > 1 ? i - 1 : 1);
805 sm->directory_vector[STAT_COUNTER_VECTOR_RATE].value = vector_rate;
808 * Compute the aggregate input rate
810 now = vlib_time_now (vm);
811 dt = now - sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value;
812 input_packets = vnet_get_aggregate_rx_packets ();
813 sm->directory_vector[STAT_COUNTER_INPUT_RATE].value =
814 (f64) (input_packets - sm->last_input_packets) / dt;
815 sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value = now;
816 sm->last_input_packets = input_packets;
817 sm->directory_vector[STAT_COUNTER_LAST_STATS_CLEAR].value =
818 vm->node_main.time_last_runtime_stats_clear;
820 if (sm->node_counters_enabled)
821 update_node_counters (sm);
824 stat_segment_gauges_pool_t *g;
825 pool_foreach (g, sm->gauges)
827 g->fn(&sm->directory_vector[g->directory_index], g->caller_index);
831 /* Heartbeat, so clients detect we're still here */
832 sm->directory_vector[STAT_COUNTER_HEARTBEAT].value++;
836 * Accept connection on the socket and exchange the fd for the shared
839 static clib_error_t *
840 stats_socket_accept_ready (clib_file_t * uf)
842 stat_segment_main_t *sm = &stat_segment_main;
844 clib_socket_t client = { 0 };
846 err = clib_socket_accept (sm->socket, &client);
849 clib_error_report (err);
853 /* Send the fd across and close */
854 err = clib_socket_sendmsg (&client, 0, 0, &sm->memfd, 1);
856 clib_error_report (err);
857 clib_socket_close (&client);
862 static clib_error_t *
863 stats_segment_socket_init (void)
865 stat_segment_main_t *sm = &stat_segment_main;
867 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
869 memset (s, 0, sizeof (clib_socket_t));
870 s->config = (char *) sm->socket_name;
871 s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
872 CLIB_SOCKET_F_ALLOW_GROUP_WRITE | CLIB_SOCKET_F_PASSCRED;
874 if ((error = clib_socket_init (s)))
877 clib_file_t template = { 0 };
878 template.read_function = stats_socket_accept_ready;
879 template.file_descriptor = s->fd;
880 template.description = format (0, "stats segment listener %s", s->config);
881 clib_file_add (&file_main, &template);
888 static clib_error_t *
889 stats_segment_socket_exit (vlib_main_t * vm)
892 * cleanup the listener socket on exit.
894 stat_segment_main_t *sm = &stat_segment_main;
895 unlink ((char *) sm->socket_name);
899 VLIB_MAIN_LOOP_EXIT_FUNCTION (stats_segment_socket_exit);
901 /* Overrides weak reference in vlib:node_cli.c */
903 vlib_get_stat_segment_update_rate (void)
905 return stat_segment_main.update_interval;
909 stat_segment_collector_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
912 stat_segment_main_t *sm = &stat_segment_main;
916 do_stat_segment_updates (vm, sm);
917 vlib_process_suspend (vm, sm->update_interval);
919 return 0; /* or not */
923 * Add a data provider (via callback) for a given stats entry.
924 * TODO: Add support for per-provider interval.
927 stat_segment_poll_add (u32 vector_index, stat_segment_update_fn update_fn,
928 u32 caller_index, u32 interval)
930 stat_segment_main_t *sm = &stat_segment_main;
931 stat_segment_gauges_pool_t *gauge;
933 pool_get (sm->gauges, gauge);
934 gauge->fn = update_fn;
935 gauge->caller_index = caller_index;
936 gauge->directory_index = vector_index;
942 * Create an scalar entry with a data provider.
943 * Deprecated, replace with stat_segment_new_entry + stat_segment_pool_add
946 stat_segment_register_gauge (u8 * name, stat_segment_update_fn update_fn,
949 stat_segment_main_t *sm = &stat_segment_main;
950 stat_segment_gauges_pool_t *gauge;
952 u32 vector_index = stat_segment_new_entry (name, STAT_DIR_TYPE_SCALAR_INDEX);
953 if (vector_index == ~0) /* Already registered */
954 return clib_error_return (0, "%v is already registered", name);
956 pool_get (sm->gauges, gauge);
957 gauge->fn = update_fn;
958 gauge->caller_index = caller_index;
959 gauge->directory_index = vector_index;
965 stat_segment_register_state_counter (u8 * name, u32 * index)
967 ASSERT (vlib_get_thread_index () == 0);
969 u32 vector_index = stat_segment_new_entry (name, STAT_DIR_TYPE_SCALAR_INDEX);
970 if (vector_index == ~0) /* Already registered */
971 return clib_error_return (0, "%v is already registered", name);
972 *index = vector_index;
977 stat_segment_deregister_state_counter (u32 index)
979 stat_segment_main_t *sm = &stat_segment_main;
980 stat_segment_shared_header_t *shared_header = sm->shared_header;
981 stat_segment_directory_entry_t *e;
984 ASSERT (shared_header);
986 if (index > vec_len (sm->directory_vector))
987 return clib_error_return (0, "%u index does not exist", index);
989 e = &sm->directory_vector[index];
990 if (e->type != STAT_DIR_TYPE_SCALAR_INDEX)
991 return clib_error_return (0, "%u index cannot be deleted", index);
993 oldheap = vlib_stats_push_heap (NULL);
994 vlib_stat_segment_lock ();
996 vlib_stats_delete_counter (index, oldheap);
998 vlib_stat_segment_unlock ();
999 clib_mem_set_heap (oldheap);
1005 stat_segment_set_state_counter (u32 index, u64 value)
1007 stat_segment_main_t *sm = &stat_segment_main;
1009 ASSERT (index < vec_len (sm->directory_vector));
1010 sm->directory_vector[index].index = value;
1013 static clib_error_t *
1014 statseg_config (vlib_main_t * vm, unformat_input_t * input)
1016 stat_segment_main_t *sm = &stat_segment_main;
1017 sm->update_interval = 10.0;
1019 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1021 if (unformat (input, "socket-name %s", &sm->socket_name))
1023 /* DEPRECATE: default (does nothing) */
1024 else if (unformat (input, "default"))
1026 else if (unformat (input, "size %U",
1027 unformat_memory_size, &sm->memory_size))
1029 else if (unformat (input, "page-size %U",
1030 unformat_log2_page_size, &sm->log2_page_sz))
1032 else if (unformat (input, "per-node-counters on"))
1033 sm->node_counters_enabled = 1;
1034 else if (unformat (input, "per-node-counters off"))
1035 sm->node_counters_enabled = 0;
1036 else if (unformat (input, "update-interval %f", &sm->update_interval))
1039 return clib_error_return (0, "unknown input `%U'",
1040 format_unformat_error, input);
1044 * NULL-terminate socket name string
1045 * clib_socket_init()->socket_config() use C str*
1047 if (vec_len (sm->socket_name))
1048 vec_terminate_c_string (sm->socket_name);
1053 VLIB_EARLY_CONFIG_FUNCTION (statseg_config, "statseg");
1055 static clib_error_t *
1056 statseg_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
1058 stat_segment_main_t *sm = &stat_segment_main;
1059 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1060 vnet_sw_interface_t *si_sup =
1061 vnet_get_sup_sw_interface (vnm, si->sw_if_index);
1062 vnet_hw_interface_t *hi_sup;
1064 u8 *symlink_name = 0;
1067 void *oldheap = vlib_stats_push_heap (sm->interfaces);
1068 vlib_stat_segment_lock ();
1070 vec_validate (sm->interfaces, sw_if_index);
1072 ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
1073 hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
1075 s = format (s, "%v", hi_sup->name);
1076 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1077 s = format (s, ".%d", si->sub.id);
1078 s = format (s, "%c", 0);
1082 sm->interfaces[sw_if_index] = s;
1083 #define _(E, n, p) \
1084 clib_mem_set_heap (oldheap); /* Exit stats segment */ \
1085 vector_index = lookup_hash_index ((u8 *) "/" #p "/" #n); \
1086 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */ \
1087 vec_reset_length (symlink_name); \
1088 symlink_name = format (symlink_name, "/interfaces/%U/" #n "%c", \
1089 format_vlib_stats_symlink, s, 0); \
1090 vlib_stats_register_symlink (oldheap, symlink_name, vector_index, \
1091 sw_if_index, 0 /* don't lock */);
1092 foreach_simple_interface_counter_name
1093 foreach_combined_interface_counter_name
1096 vec_free (symlink_name);
1100 vec_free (sm->interfaces[sw_if_index]);
1101 sm->interfaces[sw_if_index] = 0;
1102 #define _(E, n, p) \
1103 vec_reset_length (symlink_name); \
1104 symlink_name = format (symlink_name, "/interfaces/%U/" #n "%c", \
1105 format_vlib_stats_symlink, s, 0); \
1106 clib_mem_set_heap (oldheap); /* Exit stats segment */ \
1107 vector_index = lookup_hash_index ((u8 *) symlink_name); \
1108 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */ \
1109 vlib_stats_delete_counter (vector_index, oldheap);
1110 foreach_simple_interface_counter_name
1111 foreach_combined_interface_counter_name
1114 vec_free (symlink_name);
1117 stat_segment_directory_entry_t *ep;
1118 ep = &sm->directory_vector[STAT_COUNTER_INTERFACE_NAMES];
1119 ep->data = sm->interfaces;
1121 vlib_stat_segment_unlock ();
1122 clib_mem_set_heap (oldheap);
1127 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (statseg_sw_interface_add_del);
1129 VLIB_REGISTER_NODE (stat_segment_collector, static) =
1131 .function = stat_segment_collector_process,
1132 .name = "statseg-collector-process",
1133 .type = VLIB_NODE_TYPE_PROCESS,
1136 static clib_error_t *
1137 statseg_init (vlib_main_t *vm)
1139 stat_segment_main_t *sm = &stat_segment_main;
1141 /* set default socket file name when statseg config stanza is empty. */
1142 if (!vec_len (sm->socket_name))
1143 sm->socket_name = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
1144 STAT_SEGMENT_SOCKET_FILENAME, 0);
1145 return stats_segment_socket_init ();
1148 VLIB_INIT_FUNCTION (statseg_init) = {
1149 .runs_after = VLIB_INITS ("unix_input_init"),
1153 * fd.io coding-style-patch-verification: ON
1156 * eval: (c-set-style "gnu")