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 * Called from main heap
155 vlib_stats_delete_cm (void *cm_arg)
157 vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
158 stat_segment_main_t *sm = &stat_segment_main;
159 stat_segment_directory_entry_t *e;
160 stat_segment_shared_header_t *shared_header = sm->shared_header;
162 /* Not all counters have names / hash-table entries */
163 if (!cm->name && !cm->stat_segment_name)
167 vlib_stat_segment_lock ();
169 /* Lookup hash-table is on the main heap */
170 char *stat_segment_name =
171 cm->stat_segment_name ? cm->stat_segment_name : cm->name;
172 u32 index = lookup_hash_index ((u8 *) stat_segment_name);
174 e = &sm->directory_vector[index];
175 hash_unset (sm->directory_vector_by_name, &e->name);
177 u64 *offset_vector = stat_segment_pointer (shared_header, e->offset_vector);
179 void *oldheap = clib_mem_set_heap (sm->heap); /* Enter stats segment */
180 vec_free (offset_vector);
181 clib_mem_set_heap (oldheap); /* Exit stats segment */
183 memset (e, 0, sizeof (*e));
184 e->type = STAT_DIR_TYPE_EMPTY;
186 vlib_stat_segment_unlock ();
190 vlib_stats_pop_heap (void *cm_arg, void *oldheap, u32 cindex,
191 stat_directory_type_t type)
193 vlib_simple_counter_main_t *cm = (vlib_simple_counter_main_t *) cm_arg;
194 stat_segment_main_t *sm = &stat_segment_main;
195 stat_segment_shared_header_t *shared_header = sm->shared_header;
196 char *stat_segment_name;
197 stat_segment_directory_entry_t e = { 0 };
199 /* Not all counters have names / hash-table entries */
200 if (!cm->name && !cm->stat_segment_name)
202 clib_mem_set_heap (oldheap);
206 ASSERT (shared_header);
208 vlib_stat_segment_lock ();
210 /* Lookup hash-table is on the main heap */
212 cm->stat_segment_name ? cm->stat_segment_name : cm->name;
214 clib_mem_set_heap (oldheap); /* Exit stats segment */
215 u32 vector_index = lookup_hash_index ((u8 *) stat_segment_name);
216 /* Back to stats segment */
217 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
220 /* Update the vector */
221 if (vector_index == STAT_SEGMENT_INDEX_INVALID)
223 strncpy (e.name, stat_segment_name, 128 - 1);
225 vector_index = vlib_stats_create_counter (&e, oldheap);
228 stat_segment_directory_entry_t *ep = &sm->directory_vector[vector_index];
229 ep->offset = stat_segment_offset (shared_header, cm->counters); /* Vector of threads of vectors of counters */
231 ep->offset_vector ? stat_segment_pointer (shared_header,
232 ep->offset_vector) : 0;
234 /* Update the 2nd dimension offset vector */
236 vec_validate (offset_vector, vec_len (cm->counters) - 1);
238 if (sm->last != offset_vector)
240 for (i = 0; i < vec_len (cm->counters); i++)
242 stat_segment_offset (shared_header, cm->counters[i]);
245 offset_vector[cindex] =
246 stat_segment_offset (shared_header, cm->counters[cindex]);
248 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
249 sm->directory_vector[vector_index].offset =
250 stat_segment_offset (shared_header, cm->counters);
252 /* Reset the client hash table pointer, since it WILL change! */
253 shared_header->directory_offset =
254 stat_segment_offset (shared_header, sm->directory_vector);
256 vlib_stat_segment_unlock ();
257 clib_mem_set_heap (oldheap);
261 vlib_stats_register_error_index (void *oldheap, u8 * name, u64 * em_vec,
264 stat_segment_main_t *sm = &stat_segment_main;
265 stat_segment_shared_header_t *shared_header = sm->shared_header;
266 stat_segment_directory_entry_t e;
268 ASSERT (shared_header);
270 vlib_stat_segment_lock ();
271 clib_mem_set_heap (oldheap); /* Exit stats segment */
272 u32 vector_index = lookup_hash_index (name);
273 /* Back to stats segment */
274 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */
276 if (vector_index == STAT_SEGMENT_INDEX_INVALID)
278 memcpy (e.name, name, vec_len (name));
279 e.name[vec_len (name)] = '\0';
280 e.type = STAT_DIR_TYPE_ERROR_INDEX;
283 vector_index = vlib_stats_create_counter (&e, oldheap);
285 /* Warn clients to refresh any pointers they might be holding */
286 shared_header->directory_offset =
287 stat_segment_offset (shared_header, sm->directory_vector);
290 vlib_stat_segment_unlock ();
294 stat_validate_counter_vector (stat_segment_directory_entry_t * ep, u32 max)
296 stat_segment_main_t *sm = &stat_segment_main;
297 stat_segment_shared_header_t *shared_header = sm->shared_header;
298 counter_t **counters =
299 ep->offset ? stat_segment_pointer (shared_header, ep->offset) : 0;
300 vlib_thread_main_t *tm = vlib_get_thread_main ();
302 u64 *offset_vector = 0;
304 vec_validate_aligned (counters, tm->n_vlib_mains - 1,
305 CLIB_CACHE_LINE_BYTES);
306 ep->offset = stat_segment_offset (shared_header, counters);
308 for (i = 0; i < tm->n_vlib_mains; i++)
310 vec_validate_aligned (counters[i], max, CLIB_CACHE_LINE_BYTES);
311 vec_add1 (offset_vector,
312 stat_segment_offset (shared_header, counters[i]));
315 if (ep->offset_vector)
317 u64 *p = stat_segment_pointer (sm->shared_header, ep->offset_vector);
320 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
324 stat_set_simple_counter (stat_segment_directory_entry_t * ep,
325 u32 thread_index, u32 index, u64 value)
327 stat_segment_main_t *sm = &stat_segment_main;
328 stat_segment_shared_header_t *shared_header = sm->shared_header;
330 ASSERT (shared_header);
331 counter_t *offset_vector =
332 stat_segment_pointer (sm->shared_header, ep->offset_vector);
334 stat_segment_pointer (sm->shared_header, offset_vector[thread_index]);
339 vlib_stats_pop_heap2 (u64 * error_vector, u32 thread_index, void *oldheap,
342 stat_segment_main_t *sm = &stat_segment_main;
343 stat_segment_shared_header_t *shared_header = sm->shared_header;
345 ASSERT (shared_header);
348 vlib_stat_segment_lock ();
350 /* Reset the client hash table pointer, since it WILL change! */
351 vec_validate (sm->error_vector, thread_index);
352 sm->error_vector[thread_index] =
353 stat_segment_offset (shared_header, error_vector);
355 shared_header->error_offset =
356 stat_segment_offset (shared_header, sm->error_vector);
357 shared_header->directory_offset =
358 stat_segment_offset (shared_header, sm->directory_vector);
361 vlib_stat_segment_unlock ();
362 clib_mem_set_heap (oldheap);
366 vlib_map_stat_segment_init (void)
368 stat_segment_main_t *sm = &stat_segment_main;
369 stat_segment_shared_header_t *shared_header;
373 char *mem_name = "stat_segment_test";
376 memory_size = sm->memory_size;
377 if (memory_size == 0)
378 memory_size = STAT_SEGMENT_DEFAULT_SIZE;
380 /* Create shared memory segment */
381 if ((mfd = memfd_create (mem_name, 0)) < 0)
382 return clib_error_return (0, "stat segment memfd_create failure");
385 if ((ftruncate (mfd, memory_size)) == -1)
386 return clib_error_return (0, "stat segment ftruncate failure");
389 mmap (NULL, memory_size, PROT_READ | PROT_WRITE, MAP_SHARED, mfd,
391 return clib_error_return (0, "stat segment mmap failure");
395 create_mspace_with_base (((u8 *) memaddr) + getpagesize (),
396 memory_size - getpagesize (), 1 /* locked */ );
397 mspace_disable_expand (heap);
401 sm->directory_vector_by_name = hash_create_string (0, sizeof (uword));
402 sm->shared_header = shared_header = memaddr;
404 shared_header->version = STAT_SEGMENT_VERSION;
406 sm->stat_segment_lockp = clib_mem_alloc (sizeof (clib_spinlock_t));
407 clib_spinlock_init (sm->stat_segment_lockp);
409 oldheap = clib_mem_set_heap (sm->heap);
411 /* Set up the name to counter-vector hash table */
412 sm->directory_vector = 0;
414 shared_header->epoch = 1;
416 /* Scalar stats and node counters */
417 vec_validate (sm->directory_vector, STAT_COUNTERS - 1);
419 strcpy(sm->directory_vector[STAT_COUNTER_##E].name, #p "/" #n); \
420 sm->directory_vector[STAT_COUNTER_##E].type = STAT_DIR_TYPE_##t;
421 foreach_stat_segment_counter_name
423 /* Save the vector offset in the shared segment, for clients */
424 shared_header->directory_offset =
425 stat_segment_offset (shared_header, sm->directory_vector);
427 clib_mem_set_heap (oldheap);
429 /* Total shared memory size */
430 clib_mem_usage_t usage;
431 mheap_usage (sm->heap, &usage);
432 sm->directory_vector[STAT_COUNTER_MEM_STATSEG_TOTAL].value =
439 name_sort_cmp (void *a1, void *a2)
441 stat_segment_directory_entry_t *n1 = a1;
442 stat_segment_directory_entry_t *n2 = a2;
444 return strcmp ((char *) n1->name, (char *) n2->name);
448 format_stat_dir_entry (u8 * s, va_list * args)
450 stat_segment_directory_entry_t *ep =
451 va_arg (*args, stat_segment_directory_entry_t *);
455 format_string = "%-74s %-10s %10lld";
459 case STAT_DIR_TYPE_SCALAR_INDEX:
460 type_name = "ScalarPtr";
463 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
464 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
465 type_name = "CMainPtr";
468 case STAT_DIR_TYPE_ERROR_INDEX:
469 type_name = "ErrIndex";
472 case STAT_DIR_TYPE_NAME_VECTOR:
473 type_name = "NameVector";
476 case STAT_DIR_TYPE_EMPTY:
481 type_name = "illegal!";
485 return format (s, format_string, ep->name, type_name, ep->offset);
488 static clib_error_t *
489 show_stat_segment_command_fn (vlib_main_t * vm,
490 unformat_input_t * input,
491 vlib_cli_command_t * cmd)
493 stat_segment_main_t *sm = &stat_segment_main;
494 stat_segment_directory_entry_t *show_data;
499 if (unformat (input, "verbose"))
502 /* Lock even as reader, as this command doesn't handle epoch changes */
503 vlib_stat_segment_lock ();
504 show_data = vec_dup (sm->directory_vector);
505 vlib_stat_segment_unlock ();
507 vec_sort_with_function (show_data, name_sort_cmp);
509 vlib_cli_output (vm, "%-74s %10s %10s", "Name", "Type", "Value");
511 for (i = 0; i < vec_len (show_data); i++)
513 stat_segment_directory_entry_t *ep = vec_elt_at_index (show_data, i);
515 if (ep->type == STAT_DIR_TYPE_EMPTY)
518 vlib_cli_output (vm, "%-100U", format_stat_dir_entry,
519 vec_elt_at_index (show_data, i));
525 vlib_cli_output (vm, "%U", format_mheap, sm->heap, 0 /* verbose */ );
532 VLIB_CLI_COMMAND (show_stat_segment_command, static) =
534 .path = "show statistics segment",
535 .short_help = "show statistics segment [verbose]",
536 .function = show_stat_segment_command_fn,
541 * Node performance counters:
542 * total_calls [threads][node-index]
549 update_node_counters (stat_segment_main_t * sm)
551 vlib_main_t **stat_vms = 0;
552 vlib_node_t ***node_dups = 0;
554 stat_segment_shared_header_t *shared_header = sm->shared_header;
555 static u32 no_max_nodes = 0;
557 vlib_node_get_nodes (0 /* vm, for barrier sync */ ,
558 (u32) ~ 0 /* all threads */ ,
559 1 /* include stats */ ,
560 0 /* barrier sync */ ,
561 &node_dups, &stat_vms);
563 u32 l = vec_len (node_dups[0]);
566 * Extend performance nodes if necessary
568 if (l > no_max_nodes)
570 void *oldheap = clib_mem_set_heap (sm->heap);
571 vlib_stat_segment_lock ();
573 stat_validate_counter_vector (&sm->directory_vector
574 [STAT_COUNTER_NODE_CLOCKS], l - 1);
575 stat_validate_counter_vector (&sm->directory_vector
576 [STAT_COUNTER_NODE_VECTORS], l - 1);
577 stat_validate_counter_vector (&sm->directory_vector
578 [STAT_COUNTER_NODE_CALLS], l - 1);
579 stat_validate_counter_vector (&sm->directory_vector
580 [STAT_COUNTER_NODE_SUSPENDS], l - 1);
582 vec_validate (sm->nodes, l - 1);
583 stat_segment_directory_entry_t *ep;
584 ep = &sm->directory_vector[STAT_COUNTER_NODE_NAMES];
585 ep->offset = stat_segment_offset (shared_header, sm->nodes);
589 ep->offset_vector ? stat_segment_pointer (shared_header,
590 ep->offset_vector) : 0;
591 /* Update names dictionary */
592 vec_validate (offset_vector, l - 1);
593 vlib_node_t **nodes = node_dups[0];
595 for (i = 0; i < vec_len (nodes); i++)
597 vlib_node_t *n = nodes[i];
599 s = format (s, "%v%c", n->name, 0);
600 if (sm->nodes[n->index])
601 vec_free (sm->nodes[n->index]);
602 sm->nodes[n->index] = s;
604 sm->nodes[i] ? stat_segment_offset (shared_header,
608 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
610 vlib_stat_segment_unlock ();
611 clib_mem_set_heap (oldheap);
615 for (j = 0; j < vec_len (node_dups); j++)
617 vlib_node_t **nodes = node_dups[j];
619 for (i = 0; i < vec_len (nodes); i++)
621 counter_t **counters;
623 vlib_node_t *n = nodes[i];
626 stat_segment_pointer (shared_header,
628 [STAT_COUNTER_NODE_CLOCKS].offset);
630 c[n->index] = n->stats_total.clocks - n->stats_last_clear.clocks;
633 stat_segment_pointer (shared_header,
635 [STAT_COUNTER_NODE_VECTORS].offset);
637 c[n->index] = n->stats_total.vectors - n->stats_last_clear.vectors;
640 stat_segment_pointer (shared_header,
642 [STAT_COUNTER_NODE_CALLS].offset);
644 c[n->index] = n->stats_total.calls - n->stats_last_clear.calls;
647 stat_segment_pointer (shared_header,
649 [STAT_COUNTER_NODE_SUSPENDS].offset);
652 n->stats_total.suspends - n->stats_last_clear.suspends;
654 vec_free (node_dups[j]);
656 vec_free (node_dups);
661 do_stat_segment_updates (stat_segment_main_t * sm)
663 vlib_main_t *vm = vlib_mains[0];
667 vlib_main_t *this_vlib_main;
669 static int num_worker_threads_set;
672 * Set once at the beginning of time.
673 * Can't do this from the init routine, which happens before
674 * start_workers sets up vlib_mains...
676 if (PREDICT_FALSE (num_worker_threads_set == 0))
678 void *oldheap = clib_mem_set_heap (sm->heap);
679 vlib_stat_segment_lock ();
681 stat_validate_counter_vector (&sm->directory_vector
682 [STAT_COUNTER_VECTOR_RATE_PER_WORKER], 0);
683 num_worker_threads_set = 1;
684 vlib_stat_segment_unlock ();
685 clib_mem_set_heap (oldheap);
689 * Compute per-worker vector rates, and the average vector rate
694 for (i = 0; i < vec_len (vlib_mains); i++)
697 f64 this_vector_rate;
699 this_vlib_main = vlib_mains[i];
701 this_vector_rate = vlib_internal_node_vector_rate (this_vlib_main);
702 vlib_clear_internal_node_vector_rate (this_vlib_main);
704 vector_rate += this_vector_rate;
706 /* Set the per-worker rate */
707 stat_set_simple_counter (&sm->directory_vector
708 [STAT_COUNTER_VECTOR_RATE_PER_WORKER], i, 0,
712 /* And set the system average rate */
713 vector_rate /= (f64) (i > 1 ? i - 1 : 1);
715 sm->directory_vector[STAT_COUNTER_VECTOR_RATE].value = vector_rate;
718 * Compute the aggregate input rate
720 now = vlib_time_now (vm);
721 dt = now - sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value;
722 input_packets = vnet_get_aggregate_rx_packets ();
723 sm->directory_vector[STAT_COUNTER_INPUT_RATE].value =
724 (f64) (input_packets - sm->last_input_packets) / dt;
725 sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value = now;
726 sm->last_input_packets = input_packets;
727 sm->directory_vector[STAT_COUNTER_LAST_STATS_CLEAR].value =
728 vm->node_main.time_last_runtime_stats_clear;
730 /* Stats segment memory heap counter */
731 clib_mem_usage_t usage;
732 mheap_usage (sm->heap, &usage);
733 sm->directory_vector[STAT_COUNTER_MEM_STATSEG_USED].value =
736 if (sm->node_counters_enabled)
737 update_node_counters (sm);
740 stat_segment_gauges_pool_t *g;
741 pool_foreach(g, sm->gauges,
743 g->fn(&sm->directory_vector[g->directory_index], g->caller_index);
747 /* Heartbeat, so clients detect we're still here */
748 sm->directory_vector[STAT_COUNTER_HEARTBEAT].value++;
752 * Accept connection on the socket and exchange the fd for the shared
755 static clib_error_t *
756 stats_socket_accept_ready (clib_file_t * uf)
758 stat_segment_main_t *sm = &stat_segment_main;
760 clib_socket_t client = { 0 };
762 err = clib_socket_accept (sm->socket, &client);
765 clib_error_report (err);
769 /* Send the fd across and close */
770 err = clib_socket_sendmsg (&client, 0, 0, &sm->memfd, 1);
772 clib_error_report (err);
773 clib_socket_close (&client);
778 static clib_error_t *
779 stats_segment_socket_init (void)
781 stat_segment_main_t *sm = &stat_segment_main;
783 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
785 memset (s, 0, sizeof (clib_socket_t));
786 s->config = (char *) sm->socket_name;
787 s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
788 CLIB_SOCKET_F_ALLOW_GROUP_WRITE | CLIB_SOCKET_F_PASSCRED;
790 if ((error = clib_socket_init (s)))
793 clib_file_t template = { 0 };
794 template.read_function = stats_socket_accept_ready;
795 template.file_descriptor = s->fd;
796 template.description = format (0, "stats segment listener %s", s->config);
797 clib_file_add (&file_main, &template);
804 static clib_error_t *
805 stats_segment_socket_exit (vlib_main_t * vm)
808 * cleanup the listener socket on exit.
810 stat_segment_main_t *sm = &stat_segment_main;
811 unlink ((char *) sm->socket_name);
815 VLIB_MAIN_LOOP_EXIT_FUNCTION (stats_segment_socket_exit);
817 /* Overrides weak reference in vlib:node_cli.c */
819 vlib_get_stat_segment_update_rate (void)
821 return stat_segment_main.update_interval;
825 stat_segment_collector_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
828 stat_segment_main_t *sm = &stat_segment_main;
832 do_stat_segment_updates (sm);
833 vlib_process_suspend (vm, sm->update_interval);
835 return 0; /* or not */
838 static clib_error_t *
839 statseg_init (vlib_main_t * vm)
841 stat_segment_main_t *sm = &stat_segment_main;
843 /* set default socket file name when statseg config stanza is empty. */
844 if (!vec_len (sm->socket_name))
845 sm->socket_name = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
846 STAT_SEGMENT_SOCKET_FILENAME, 0);
847 return stats_segment_socket_init ();
851 VLIB_INIT_FUNCTION (statseg_init) =
853 .runs_after = VLIB_INITS("unix_input_init"),
858 stat_segment_register_gauge (u8 * name, stat_segment_update_fn update_fn,
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;
865 stat_segment_gauges_pool_t *gauge;
867 ASSERT (shared_header);
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 ();
880 vector_index = vlib_stats_create_counter (&e, oldheap);
882 shared_header->directory_offset =
883 stat_segment_offset (shared_header, sm->directory_vector);
885 vlib_stat_segment_unlock ();
886 clib_mem_set_heap (oldheap);
888 /* Back on our own heap */
889 pool_get (sm->gauges, gauge);
890 gauge->fn = update_fn;
891 gauge->caller_index = caller_index;
892 gauge->directory_index = vector_index;
898 stat_segment_register_state_counter (u8 * name, u32 * index)
900 stat_segment_main_t *sm = &stat_segment_main;
901 stat_segment_shared_header_t *shared_header = sm->shared_header;
903 stat_segment_directory_entry_t e;
905 ASSERT (shared_header);
906 ASSERT (vlib_get_thread_index () == 0);
908 u32 vector_index = lookup_hash_index (name);
910 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
911 return clib_error_return (0, "%v is already registered", name);
913 memset (&e, 0, sizeof (e));
914 e.type = STAT_DIR_TYPE_SCALAR_INDEX;
915 memcpy (e.name, name, vec_len (name));
917 oldheap = vlib_stats_push_heap (NULL);
918 vlib_stat_segment_lock ();
920 vector_index = vlib_stats_create_counter (&e, oldheap);
922 shared_header->directory_offset =
923 stat_segment_offset (shared_header, sm->directory_vector);
925 vlib_stat_segment_unlock ();
926 clib_mem_set_heap (oldheap);
928 *index = vector_index;
933 stat_segment_deregister_state_counter (u32 index)
935 stat_segment_main_t *sm = &stat_segment_main;
936 stat_segment_shared_header_t *shared_header = sm->shared_header;
937 stat_segment_directory_entry_t *e;
940 ASSERT (shared_header);
942 if (index > vec_len (sm->directory_vector))
943 return clib_error_return (0, "%u index does not exist", index);
945 e = &sm->directory_vector[index];
946 if (e->type != STAT_DIR_TYPE_SCALAR_INDEX)
947 return clib_error_return (0, "%u index cannot be deleted", index);
949 oldheap = vlib_stats_push_heap (NULL);
950 vlib_stat_segment_lock ();
952 vlib_stats_delete_counter (index, oldheap);
954 vlib_stat_segment_unlock ();
955 clib_mem_set_heap (oldheap);
961 stat_segment_set_state_counter (u32 index, u64 value)
963 stat_segment_main_t *sm = &stat_segment_main;
965 ASSERT (index < vec_len (sm->directory_vector));
966 sm->directory_vector[index].index = value;
969 static clib_error_t *
970 statseg_config (vlib_main_t * vm, unformat_input_t * input)
972 stat_segment_main_t *sm = &stat_segment_main;
973 sm->update_interval = 10.0;
975 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
977 if (unformat (input, "socket-name %s", &sm->socket_name))
979 /* DEPRECATE: default (does nothing) */
980 else if (unformat (input, "default"))
982 else if (unformat (input, "size %U",
983 unformat_memory_size, &sm->memory_size))
985 else if (unformat (input, "per-node-counters on"))
986 sm->node_counters_enabled = 1;
987 else if (unformat (input, "per-node-counters off"))
988 sm->node_counters_enabled = 0;
989 else if (unformat (input, "update-interval %f", &sm->update_interval))
992 return clib_error_return (0, "unknown input `%U'",
993 format_unformat_error, input);
997 * NULL-terminate socket name string
998 * clib_socket_init()->socket_config() use C str*
1000 if (vec_len (sm->socket_name))
1001 vec_terminate_c_string (sm->socket_name);
1006 VLIB_EARLY_CONFIG_FUNCTION (statseg_config, "statseg");
1008 static clib_error_t *
1009 statseg_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
1011 stat_segment_main_t *sm = &stat_segment_main;
1012 stat_segment_shared_header_t *shared_header = sm->shared_header;
1014 void *oldheap = vlib_stats_push_heap (sm->interfaces);
1015 vlib_stat_segment_lock ();
1017 vec_validate (sm->interfaces, sw_if_index);
1020 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1021 vnet_sw_interface_t *si_sup =
1022 vnet_get_sup_sw_interface (vnm, si->sw_if_index);
1023 vnet_hw_interface_t *hi_sup;
1025 ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
1026 hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
1029 s = format (s, "%v", hi_sup->name);
1030 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1031 s = format (s, ".%d", si->sub.id);
1032 s = format (s, "%c", 0);
1033 sm->interfaces[sw_if_index] = s;
1037 vec_free (sm->interfaces[sw_if_index]);
1038 sm->interfaces[sw_if_index] = 0;
1041 stat_segment_directory_entry_t *ep;
1042 ep = &sm->directory_vector[STAT_COUNTER_INTERFACE_NAMES];
1043 ep->offset = stat_segment_offset (shared_header, sm->interfaces);
1046 u64 *offset_vector =
1047 ep->offset_vector ? stat_segment_pointer (shared_header,
1048 ep->offset_vector) : 0;
1050 vec_validate (offset_vector, vec_len (sm->interfaces) - 1);
1052 if (sm->last != sm->interfaces)
1054 /* the interface vector moved, so need to recalulate the offset array */
1055 for (i = 0; i < vec_len (sm->interfaces); i++)
1058 sm->interfaces[i] ? stat_segment_offset (shared_header,
1059 sm->interfaces[i]) : 0;
1064 offset_vector[sw_if_index] =
1065 sm->interfaces[sw_if_index] ?
1066 stat_segment_offset (shared_header, sm->interfaces[sw_if_index]) : 0;
1068 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
1070 vlib_stat_segment_unlock ();
1071 clib_mem_set_heap (oldheap);
1076 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (statseg_sw_interface_add_del);
1079 VLIB_REGISTER_NODE (stat_segment_collector, static) =
1081 .function = stat_segment_collector_process,
1082 .name = "statseg-collector-process",
1083 .type = VLIB_NODE_TYPE_PROCESS,
1089 * fd.io coding-style-patch-verification: ON
1092 * eval: (c-set-style "gnu")