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 #include <vppinfra/mheap.h>
27 stat_segment_main_t stat_segment_main;
30 * Used only by VPP writers
33 vlib_stat_segment_lock (void)
35 stat_segment_main_t *sm = &stat_segment_main;
36 clib_spinlock_lock (sm->stat_segment_lockp);
37 sm->shared_header->in_progress = 1;
41 vlib_stat_segment_unlock (void)
43 stat_segment_main_t *sm = &stat_segment_main;
44 sm->shared_header->epoch++;
45 sm->shared_header->in_progress = 0;
46 clib_spinlock_unlock (sm->stat_segment_lockp);
50 * Change heap to the stats shared memory segment
53 vlib_stats_push_heap (void *old)
55 stat_segment_main_t *sm = &stat_segment_main;
58 ASSERT (sm && sm->shared_header);
59 return clib_mem_set_heap (sm->heap);
63 lookup_hash_index (u8 * name)
65 stat_segment_main_t *sm = &stat_segment_main;
66 u32 index = STAT_SEGMENT_INDEX_INVALID;
69 /* Must be called in the context of the main heap */
70 ASSERT (clib_mem_get_heap () != sm->heap);
72 hp = hash_get_pair (sm->directory_vector_by_name, name);
82 create_hash_index (u8 * name, u32 index)
84 stat_segment_main_t *sm = &stat_segment_main;
86 /* Must be called in the context of the main heap */
87 ASSERT (clib_mem_get_heap () != sm->heap);
89 hash_set (sm->directory_vector_by_name, format (0, "%s%c", name, 0), index);
93 vlib_stats_get_next_vector_index ()
95 stat_segment_main_t *sm = &stat_segment_main;
96 u32 next_vector_index = vec_len (sm->directory_vector);
99 vec_foreach_index_backwards (i, sm->directory_vector)
101 if (sm->directory_vector[i].type == STAT_DIR_TYPE_EMPTY)
103 next_vector_index = i;
108 return next_vector_index;
112 vlib_stats_create_counter (stat_segment_directory_entry_t * e, void *oldheap)
114 stat_segment_main_t *sm = &stat_segment_main;
116 ASSERT (clib_mem_get_heap () == sm->heap);
118 u32 index = vlib_stats_get_next_vector_index ();
120 clib_mem_set_heap (oldheap);
121 create_hash_index ((u8 *) e->name, index);
122 clib_mem_set_heap (sm->heap);
124 vec_validate (sm->directory_vector, index);
125 sm->directory_vector[index] = *e;
131 vlib_stats_delete_counter (u32 index, void *oldheap)
133 stat_segment_main_t *sm = &stat_segment_main;
134 stat_segment_directory_entry_t *e;
136 ASSERT (clib_mem_get_heap () == sm->heap);
138 if (index > vec_len (sm->directory_vector))
141 e = &sm->directory_vector[index];
143 clib_mem_set_heap (oldheap);
144 hash_unset (sm->directory_vector_by_name, &e->name);
145 clib_mem_set_heap (sm->heap);
147 memset (e, 0, sizeof (*e));
148 e->type = STAT_DIR_TYPE_EMPTY;
152 vlib_stats_pop_heap (void *cm_arg, void *oldheap, u32 cindex,
153 stat_directory_type_t type)
155 vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
156 stat_segment_main_t *sm = &stat_segment_main;
157 stat_segment_shared_header_t *shared_header = sm->shared_header;
158 char *stat_segment_name;
159 stat_segment_directory_entry_t e = { 0 };
161 /* Not all counters have names / hash-table entries */
162 if (!cm->name && !cm->stat_segment_name)
164 clib_mem_set_heap (oldheap);
168 ASSERT (shared_header);
170 vlib_stat_segment_lock ();
172 /* Lookup hash-table is on the main heap */
174 cm->stat_segment_name ? cm->stat_segment_name : cm->name;
175 clib_mem_set_heap (oldheap); /* Exit stats segment */
176 u32 vector_index = lookup_hash_index ((u8 *) stat_segment_name);
177 /* Back to stats segment */
178 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
181 /* Update the vector */
182 if (vector_index == STAT_SEGMENT_INDEX_INVALID)
184 strncpy (e.name, stat_segment_name, 128 - 1);
186 vector_index = vlib_stats_create_counter (&e, oldheap);
189 stat_segment_directory_entry_t *ep = &sm->directory_vector[vector_index];
190 ep->offset = stat_segment_offset (shared_header, cm->counters); /* Vector of threads of vectors of counters */
192 ep->offset_vector ? stat_segment_pointer (shared_header,
193 ep->offset_vector) : 0;
195 /* Update the 2nd dimension offset vector */
197 vec_validate (offset_vector, vec_len (cm->counters) - 1);
199 if (sm->last != offset_vector)
201 for (i = 0; i < vec_len (cm->counters); i++)
203 stat_segment_offset (shared_header, cm->counters[i]);
206 offset_vector[cindex] =
207 stat_segment_offset (shared_header, cm->counters[cindex]);
209 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
210 sm->directory_vector[vector_index].offset =
211 stat_segment_offset (shared_header, cm->counters);
213 /* Reset the client hash table pointer, since it WILL change! */
214 shared_header->directory_offset =
215 stat_segment_offset (shared_header, sm->directory_vector);
217 vlib_stat_segment_unlock ();
218 clib_mem_set_heap (oldheap);
222 vlib_stats_register_error_index (void *oldheap, u8 * name, u64 * em_vec,
225 stat_segment_main_t *sm = &stat_segment_main;
226 stat_segment_shared_header_t *shared_header = sm->shared_header;
227 stat_segment_directory_entry_t e;
229 ASSERT (shared_header);
231 vlib_stat_segment_lock ();
232 clib_mem_set_heap (oldheap); /* Exit stats segment */
233 u32 vector_index = lookup_hash_index (name);
234 /* Back to stats segment */
235 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
237 if (vector_index == STAT_SEGMENT_INDEX_INVALID)
239 memcpy (e.name, name, vec_len (name));
240 e.name[vec_len (name)] = '\0';
241 e.type = STAT_DIR_TYPE_ERROR_INDEX;
244 vector_index = vlib_stats_create_counter (&e, oldheap);
246 /* Warn clients to refresh any pointers they might be holding */
247 shared_header->directory_offset =
248 stat_segment_offset (shared_header, sm->directory_vector);
251 vlib_stat_segment_unlock ();
255 stat_validate_counter_vector (stat_segment_directory_entry_t * ep, u32 max)
257 stat_segment_main_t *sm = &stat_segment_main;
258 stat_segment_shared_header_t *shared_header = sm->shared_header;
259 counter_t **counters = 0;
260 vlib_thread_main_t *tm = vlib_get_thread_main ();
262 u64 *offset_vector = 0;
264 vec_validate_aligned (counters, tm->n_vlib_mains - 1,
265 CLIB_CACHE_LINE_BYTES);
266 for (i = 0; i < tm->n_vlib_mains; i++)
268 vec_validate_aligned (counters[i], max, CLIB_CACHE_LINE_BYTES);
269 vec_add1 (offset_vector,
270 stat_segment_offset (shared_header, counters[i]));
272 ep->offset = stat_segment_offset (shared_header, counters);
273 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
277 stat_set_simple_counter (stat_segment_directory_entry_t * ep,
278 u32 thread_index, u32 index, u64 value)
280 stat_segment_main_t *sm = &stat_segment_main;
281 stat_segment_shared_header_t *shared_header = sm->shared_header;
283 ASSERT (shared_header);
284 counter_t *offset_vector =
285 stat_segment_pointer (sm->shared_header, ep->offset_vector);
287 stat_segment_pointer (sm->shared_header, offset_vector[thread_index]);
292 vlib_stats_pop_heap2 (u64 * error_vector, u32 thread_index, void *oldheap,
295 stat_segment_main_t *sm = &stat_segment_main;
296 stat_segment_shared_header_t *shared_header = sm->shared_header;
298 ASSERT (shared_header);
301 vlib_stat_segment_lock ();
303 /* Reset the client hash table pointer, since it WILL change! */
304 vec_validate (sm->error_vector, thread_index);
305 sm->error_vector[thread_index] =
306 stat_segment_offset (shared_header, error_vector);
308 shared_header->error_offset =
309 stat_segment_offset (shared_header, sm->error_vector);
310 shared_header->directory_offset =
311 stat_segment_offset (shared_header, sm->directory_vector);
314 vlib_stat_segment_unlock ();
315 clib_mem_set_heap (oldheap);
319 vlib_map_stat_segment_init (void)
321 stat_segment_main_t *sm = &stat_segment_main;
322 stat_segment_shared_header_t *shared_header;
326 char *mem_name = "stat_segment_test";
329 memory_size = sm->memory_size;
330 if (memory_size == 0)
331 memory_size = STAT_SEGMENT_DEFAULT_SIZE;
333 /* Create shared memory segment */
334 if ((mfd = memfd_create (mem_name, 0)) < 0)
335 return clib_error_return (0, "stat segment memfd_create failure");
338 if ((ftruncate (mfd, memory_size)) == -1)
339 return clib_error_return (0, "stat segment ftruncate failure");
342 mmap (NULL, memory_size, PROT_READ | PROT_WRITE, MAP_SHARED, mfd,
344 return clib_error_return (0, "stat segment mmap failure");
347 #if USE_DLMALLOC == 0
348 heap = mheap_alloc_with_flags (((u8 *) memaddr) + getpagesize (),
349 memory_size - getpagesize (),
350 MHEAP_FLAG_DISABLE_VM |
351 MHEAP_FLAG_THREAD_SAFE);
354 create_mspace_with_base (((u8 *) memaddr) + getpagesize (),
355 memory_size - getpagesize (), 1 /* locked */ );
356 mspace_disable_expand (heap);
362 sm->directory_vector_by_name = hash_create_string (0, sizeof (uword));
363 sm->shared_header = shared_header = memaddr;
365 shared_header->version = STAT_SEGMENT_VERSION;
367 sm->stat_segment_lockp = clib_mem_alloc (sizeof (clib_spinlock_t));
368 clib_spinlock_init (sm->stat_segment_lockp);
370 oldheap = clib_mem_set_heap (sm->heap);
372 /* Set up the name to counter-vector hash table */
373 sm->directory_vector = 0;
375 shared_header->epoch = 1;
377 /* Scalar stats and node counters */
378 vec_validate (sm->directory_vector, STAT_COUNTERS - 1);
380 strcpy(sm->directory_vector[STAT_COUNTER_##E].name, #p "/" #n); \
381 sm->directory_vector[STAT_COUNTER_##E].type = STAT_DIR_TYPE_##t;
382 foreach_stat_segment_counter_name
384 /* Save the vector offset in the shared segment, for clients */
385 shared_header->directory_offset =
386 stat_segment_offset (shared_header, sm->directory_vector);
388 clib_mem_set_heap (oldheap);
390 /* Total shared memory size */
391 clib_mem_usage_t usage;
392 mheap_usage (sm->heap, &usage);
393 sm->directory_vector[STAT_COUNTER_MEM_STATSEG_TOTAL].value =
400 name_sort_cmp (void *a1, void *a2)
402 stat_segment_directory_entry_t *n1 = a1;
403 stat_segment_directory_entry_t *n2 = a2;
405 return strcmp ((char *) n1->name, (char *) n2->name);
409 format_stat_dir_entry (u8 * s, va_list * args)
411 stat_segment_directory_entry_t *ep =
412 va_arg (*args, stat_segment_directory_entry_t *);
416 format_string = "%-74s %-10s %10lld";
420 case STAT_DIR_TYPE_SCALAR_INDEX:
421 type_name = "ScalarPtr";
424 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
425 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
426 type_name = "CMainPtr";
429 case STAT_DIR_TYPE_ERROR_INDEX:
430 type_name = "ErrIndex";
433 case STAT_DIR_TYPE_NAME_VECTOR:
434 type_name = "NameVector";
437 case STAT_DIR_TYPE_EMPTY:
442 type_name = "illegal!";
446 return format (s, format_string, ep->name, type_name, ep->offset);
449 static clib_error_t *
450 show_stat_segment_command_fn (vlib_main_t * vm,
451 unformat_input_t * input,
452 vlib_cli_command_t * cmd)
454 stat_segment_main_t *sm = &stat_segment_main;
455 stat_segment_directory_entry_t *show_data;
460 if (unformat (input, "verbose"))
463 /* Lock even as reader, as this command doesn't handle epoch changes */
464 vlib_stat_segment_lock ();
465 show_data = vec_dup (sm->directory_vector);
466 vlib_stat_segment_unlock ();
468 vec_sort_with_function (show_data, name_sort_cmp);
470 vlib_cli_output (vm, "%-74s %10s %10s", "Name", "Type", "Value");
472 for (i = 0; i < vec_len (show_data); i++)
474 stat_segment_directory_entry_t *ep = vec_elt_at_index (show_data, i);
476 if (ep->type == STAT_DIR_TYPE_EMPTY)
479 vlib_cli_output (vm, "%-100U", format_stat_dir_entry,
480 vec_elt_at_index (show_data, i));
486 vlib_cli_output (vm, "%U", format_mheap, sm->heap, 0 /* verbose */ );
493 VLIB_CLI_COMMAND (show_stat_segment_command, static) =
495 .path = "show statistics segment",
496 .short_help = "show statistics segment [verbose]",
497 .function = show_stat_segment_command_fn,
502 * Node performance counters:
503 * total_calls [threads][node-index]
510 update_node_counters (stat_segment_main_t * sm)
512 vlib_main_t **stat_vms = 0;
513 vlib_node_t ***node_dups = 0;
515 stat_segment_shared_header_t *shared_header = sm->shared_header;
516 static u32 no_max_nodes = 0;
518 vlib_node_get_nodes (0 /* vm, for barrier sync */ ,
519 (u32) ~ 0 /* all threads */ ,
520 1 /* include stats */ ,
521 0 /* barrier sync */ ,
522 &node_dups, &stat_vms);
524 u32 l = vec_len (node_dups[0]);
527 * Extend performance nodes if necessary
529 if (l > no_max_nodes)
531 void *oldheap = clib_mem_set_heap (sm->heap);
532 vlib_stat_segment_lock ();
534 stat_validate_counter_vector (&sm->directory_vector
535 [STAT_COUNTER_NODE_CLOCKS], l - 1);
536 stat_validate_counter_vector (&sm->directory_vector
537 [STAT_COUNTER_NODE_VECTORS], l - 1);
538 stat_validate_counter_vector (&sm->directory_vector
539 [STAT_COUNTER_NODE_CALLS], l - 1);
540 stat_validate_counter_vector (&sm->directory_vector
541 [STAT_COUNTER_NODE_SUSPENDS], l - 1);
543 vec_validate (sm->nodes, l - 1);
544 stat_segment_directory_entry_t *ep;
545 ep = &sm->directory_vector[STAT_COUNTER_NODE_NAMES];
546 ep->offset = stat_segment_offset (shared_header, sm->nodes);
550 ep->offset_vector ? stat_segment_pointer (shared_header,
551 ep->offset_vector) : 0;
552 /* Update names dictionary */
553 vec_validate (offset_vector, l - 1);
554 vlib_node_t **nodes = node_dups[0];
556 for (i = 0; i < vec_len (nodes); i++)
558 vlib_node_t *n = nodes[i];
560 s = format (s, "%v%c", n->name, 0);
561 if (sm->nodes[n->index])
562 vec_free (sm->nodes[n->index]);
563 sm->nodes[n->index] = s;
565 sm->nodes[i] ? stat_segment_offset (shared_header,
569 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
571 vlib_stat_segment_unlock ();
572 clib_mem_set_heap (oldheap);
576 for (j = 0; j < vec_len (node_dups); j++)
578 vlib_node_t **nodes = node_dups[j];
580 for (i = 0; i < vec_len (nodes); i++)
582 counter_t **counters;
584 vlib_node_t *n = nodes[i];
587 stat_segment_pointer (shared_header,
589 [STAT_COUNTER_NODE_CLOCKS].offset);
591 c[n->index] = n->stats_total.clocks - n->stats_last_clear.clocks;
594 stat_segment_pointer (shared_header,
596 [STAT_COUNTER_NODE_VECTORS].offset);
598 c[n->index] = n->stats_total.vectors - n->stats_last_clear.vectors;
601 stat_segment_pointer (shared_header,
603 [STAT_COUNTER_NODE_CALLS].offset);
605 c[n->index] = n->stats_total.calls - n->stats_last_clear.calls;
608 stat_segment_pointer (shared_header,
610 [STAT_COUNTER_NODE_SUSPENDS].offset);
613 n->stats_total.suspends - n->stats_last_clear.suspends;
615 vec_free (node_dups[j]);
617 vec_free (node_dups);
622 do_stat_segment_updates (stat_segment_main_t * sm)
624 vlib_main_t *vm = vlib_mains[0];
628 vlib_main_t *this_vlib_main;
630 static int num_worker_threads_set;
633 * Set once at the beginning of time.
634 * Can't do this from the init routine, which happens before
635 * start_workers sets up vlib_mains...
637 if (PREDICT_FALSE (num_worker_threads_set == 0))
639 void *oldheap = clib_mem_set_heap (sm->heap);
640 vlib_stat_segment_lock ();
642 stat_validate_counter_vector (&sm->directory_vector
643 [STAT_COUNTER_VECTOR_RATE_PER_WORKER], 0);
644 num_worker_threads_set = 1;
645 vlib_stat_segment_unlock ();
646 clib_mem_set_heap (oldheap);
650 * Compute per-worker vector rates, and the average vector rate
655 for (i = 0; i < vec_len (vlib_mains); i++)
658 f64 this_vector_rate;
660 this_vlib_main = vlib_mains[i];
662 this_vector_rate = vlib_internal_node_vector_rate (this_vlib_main);
663 vlib_clear_internal_node_vector_rate (this_vlib_main);
665 vector_rate += this_vector_rate;
667 /* Set the per-worker rate */
668 stat_set_simple_counter (&sm->directory_vector
669 [STAT_COUNTER_VECTOR_RATE_PER_WORKER], i, 0,
673 /* And set the system average rate */
674 vector_rate /= (f64) (i > 1 ? i - 1 : 1);
676 sm->directory_vector[STAT_COUNTER_VECTOR_RATE].value = vector_rate;
679 * Compute the aggregate input rate
681 now = vlib_time_now (vm);
682 dt = now - sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value;
683 input_packets = vnet_get_aggregate_rx_packets ();
684 sm->directory_vector[STAT_COUNTER_INPUT_RATE].value =
685 (f64) (input_packets - sm->last_input_packets) / dt;
686 sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value = now;
687 sm->last_input_packets = input_packets;
688 sm->directory_vector[STAT_COUNTER_LAST_STATS_CLEAR].value =
689 vm->node_main.time_last_runtime_stats_clear;
691 /* Stats segment memory heap counter */
692 clib_mem_usage_t usage;
693 mheap_usage (sm->heap, &usage);
694 sm->directory_vector[STAT_COUNTER_MEM_STATSEG_USED].value =
697 if (sm->node_counters_enabled)
698 update_node_counters (sm);
701 stat_segment_gauges_pool_t *g;
702 pool_foreach(g, sm->gauges,
704 g->fn(&sm->directory_vector[g->directory_index], g->caller_index);
708 /* Heartbeat, so clients detect we're still here */
709 sm->directory_vector[STAT_COUNTER_HEARTBEAT].value++;
713 * Accept connection on the socket and exchange the fd for the shared
716 static clib_error_t *
717 stats_socket_accept_ready (clib_file_t * uf)
719 stat_segment_main_t *sm = &stat_segment_main;
721 clib_socket_t client = { 0 };
723 err = clib_socket_accept (sm->socket, &client);
726 clib_error_report (err);
730 /* Send the fd across and close */
731 err = clib_socket_sendmsg (&client, 0, 0, &sm->memfd, 1);
733 clib_error_report (err);
734 clib_socket_close (&client);
739 static clib_error_t *
740 stats_segment_socket_init (void)
742 stat_segment_main_t *sm = &stat_segment_main;
744 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
746 memset (s, 0, sizeof (clib_socket_t));
747 s->config = (char *) sm->socket_name;
748 s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
749 CLIB_SOCKET_F_ALLOW_GROUP_WRITE | CLIB_SOCKET_F_PASSCRED;
751 if ((error = clib_socket_init (s)))
754 clib_file_t template = { 0 };
755 template.read_function = stats_socket_accept_ready;
756 template.file_descriptor = s->fd;
757 template.description = format (0, "stats segment listener %s", s->config);
758 clib_file_add (&file_main, &template);
765 static clib_error_t *
766 stats_segment_socket_exit (vlib_main_t * vm)
769 * cleanup the listener socket on exit.
771 stat_segment_main_t *sm = &stat_segment_main;
772 unlink ((char *) sm->socket_name);
776 VLIB_MAIN_LOOP_EXIT_FUNCTION (stats_segment_socket_exit);
778 /* Overrides weak reference in vlib:node_cli.c */
780 vlib_get_stat_segment_update_rate (void)
782 return stat_segment_main.update_interval;
786 stat_segment_collector_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
789 stat_segment_main_t *sm = &stat_segment_main;
793 do_stat_segment_updates (sm);
794 vlib_process_suspend (vm, sm->update_interval);
796 return 0; /* or not */
799 static clib_error_t *
800 statseg_init (vlib_main_t * vm)
802 stat_segment_main_t *sm = &stat_segment_main;
804 /* set default socket file name when statseg config stanza is empty. */
805 if (!vec_len (sm->socket_name))
806 sm->socket_name = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
807 STAT_SEGMENT_SOCKET_FILENAME, 0);
808 return stats_segment_socket_init ();
812 VLIB_INIT_FUNCTION (statseg_init) =
814 .runs_after = VLIB_INITS("unix_input_init"),
819 stat_segment_register_gauge (u8 * name, stat_segment_update_fn update_fn,
822 stat_segment_main_t *sm = &stat_segment_main;
823 stat_segment_shared_header_t *shared_header = sm->shared_header;
825 stat_segment_directory_entry_t e;
826 stat_segment_gauges_pool_t *gauge;
828 ASSERT (shared_header);
830 u32 vector_index = lookup_hash_index (name);
832 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
833 return clib_error_return (0, "%v is already registered", name);
835 memset (&e, 0, sizeof (e));
836 e.type = STAT_DIR_TYPE_SCALAR_INDEX;
837 memcpy (e.name, name, vec_len (name));
839 oldheap = vlib_stats_push_heap (NULL);
840 vlib_stat_segment_lock ();
841 vector_index = vlib_stats_create_counter (&e, oldheap);
843 shared_header->directory_offset =
844 stat_segment_offset (shared_header, sm->directory_vector);
846 vlib_stat_segment_unlock ();
847 clib_mem_set_heap (oldheap);
849 /* Back on our own heap */
850 pool_get (sm->gauges, gauge);
851 gauge->fn = update_fn;
852 gauge->caller_index = caller_index;
853 gauge->directory_index = vector_index;
859 stat_segment_register_state_counter (u8 * name, u32 * index)
861 stat_segment_main_t *sm = &stat_segment_main;
862 stat_segment_shared_header_t *shared_header = sm->shared_header;
864 stat_segment_directory_entry_t e;
866 ASSERT (shared_header);
867 ASSERT (vlib_get_thread_index () == 0);
869 u32 vector_index = lookup_hash_index (name);
871 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
872 return clib_error_return (0, "%v is already registered", name);
874 memset (&e, 0, sizeof (e));
875 e.type = STAT_DIR_TYPE_SCALAR_INDEX;
876 memcpy (e.name, name, vec_len (name));
878 oldheap = vlib_stats_push_heap (NULL);
879 vlib_stat_segment_lock ();
881 vector_index = vlib_stats_create_counter (&e, oldheap);
883 shared_header->directory_offset =
884 stat_segment_offset (shared_header, sm->directory_vector);
886 vlib_stat_segment_unlock ();
887 clib_mem_set_heap (oldheap);
889 *index = vector_index;
894 stat_segment_deregister_state_counter (u32 index)
896 stat_segment_main_t *sm = &stat_segment_main;
897 stat_segment_shared_header_t *shared_header = sm->shared_header;
898 stat_segment_directory_entry_t *e;
901 ASSERT (shared_header);
903 if (index > vec_len (sm->directory_vector))
904 return clib_error_return (0, "%u index does not exist", index);
906 e = &sm->directory_vector[index];
907 if (e->type != STAT_DIR_TYPE_SCALAR_INDEX)
908 return clib_error_return (0, "%u index cannot be deleted", index);
910 oldheap = vlib_stats_push_heap (NULL);
911 vlib_stat_segment_lock ();
913 vlib_stats_delete_counter (index, oldheap);
915 vlib_stat_segment_unlock ();
916 clib_mem_set_heap (oldheap);
922 stat_segment_set_state_counter (u32 index, u64 value)
924 stat_segment_main_t *sm = &stat_segment_main;
926 ASSERT (index < vec_len (sm->directory_vector));
927 sm->directory_vector[index].index = value;
930 static clib_error_t *
931 statseg_config (vlib_main_t * vm, unformat_input_t * input)
933 stat_segment_main_t *sm = &stat_segment_main;
934 sm->update_interval = 10.0;
936 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
938 if (unformat (input, "socket-name %s", &sm->socket_name))
940 /* DEPRECATE: default (does nothing) */
941 else if (unformat (input, "default"))
943 else if (unformat (input, "size %U",
944 unformat_memory_size, &sm->memory_size))
946 else if (unformat (input, "per-node-counters on"))
947 sm->node_counters_enabled = 1;
948 else if (unformat (input, "per-node-counters off"))
949 sm->node_counters_enabled = 0;
950 else if (unformat (input, "update-interval %f", &sm->update_interval))
953 return clib_error_return (0, "unknown input `%U'",
954 format_unformat_error, input);
958 * NULL-terminate socket name string
959 * clib_socket_init()->socket_config() use C str*
961 if (vec_len (sm->socket_name))
962 vec_terminate_c_string (sm->socket_name);
967 VLIB_EARLY_CONFIG_FUNCTION (statseg_config, "statseg");
969 static clib_error_t *
970 statseg_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
972 stat_segment_main_t *sm = &stat_segment_main;
973 stat_segment_shared_header_t *shared_header = sm->shared_header;
975 void *oldheap = vlib_stats_push_heap (sm->interfaces);
976 vlib_stat_segment_lock ();
978 vec_validate (sm->interfaces, sw_if_index);
981 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
982 vnet_sw_interface_t *si_sup =
983 vnet_get_sup_sw_interface (vnm, si->sw_if_index);
984 vnet_hw_interface_t *hi_sup;
986 ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
987 hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
990 s = format (s, "%v", hi_sup->name);
991 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
992 s = format (s, ".%d", si->sub.id);
993 s = format (s, "%c", 0);
994 sm->interfaces[sw_if_index] = s;
998 vec_free (sm->interfaces[sw_if_index]);
999 sm->interfaces[sw_if_index] = 0;
1002 stat_segment_directory_entry_t *ep;
1003 ep = &sm->directory_vector[STAT_COUNTER_INTERFACE_NAMES];
1004 ep->offset = stat_segment_offset (shared_header, sm->interfaces);
1007 u64 *offset_vector =
1008 ep->offset_vector ? stat_segment_pointer (shared_header,
1009 ep->offset_vector) : 0;
1011 vec_validate (offset_vector, vec_len (sm->interfaces) - 1);
1013 if (sm->last != sm->interfaces)
1015 /* the interface vector moved, so need to recalulate the offset array */
1016 for (i = 0; i < vec_len (sm->interfaces); i++)
1019 sm->interfaces[i] ? stat_segment_offset (shared_header,
1020 sm->interfaces[i]) : 0;
1025 offset_vector[sw_if_index] =
1026 sm->interfaces[sw_if_index] ?
1027 stat_segment_offset (shared_header, sm->interfaces[sw_if_index]) : 0;
1029 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
1031 vlib_stat_segment_unlock ();
1032 clib_mem_set_heap (oldheap);
1037 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (statseg_sw_interface_add_del);
1040 VLIB_REGISTER_NODE (stat_segment_collector, static) =
1042 .function = stat_segment_collector_process,
1043 .name = "statseg-collector-process",
1044 .type = VLIB_NODE_TYPE_PROCESS,
1050 * fd.io coding-style-patch-verification: ON
1053 * eval: (c-set-style "gnu")