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");
348 create_mspace_with_base (((u8 *) memaddr) + getpagesize (),
349 memory_size - getpagesize (), 1 /* locked */ );
350 mspace_disable_expand (heap);
354 sm->directory_vector_by_name = hash_create_string (0, sizeof (uword));
355 sm->shared_header = shared_header = memaddr;
357 shared_header->version = STAT_SEGMENT_VERSION;
359 sm->stat_segment_lockp = clib_mem_alloc (sizeof (clib_spinlock_t));
360 clib_spinlock_init (sm->stat_segment_lockp);
362 oldheap = clib_mem_set_heap (sm->heap);
364 /* Set up the name to counter-vector hash table */
365 sm->directory_vector = 0;
367 shared_header->epoch = 1;
369 /* Scalar stats and node counters */
370 vec_validate (sm->directory_vector, STAT_COUNTERS - 1);
372 strcpy(sm->directory_vector[STAT_COUNTER_##E].name, #p "/" #n); \
373 sm->directory_vector[STAT_COUNTER_##E].type = STAT_DIR_TYPE_##t;
374 foreach_stat_segment_counter_name
376 /* Save the vector offset in the shared segment, for clients */
377 shared_header->directory_offset =
378 stat_segment_offset (shared_header, sm->directory_vector);
380 clib_mem_set_heap (oldheap);
382 /* Total shared memory size */
383 clib_mem_usage_t usage;
384 mheap_usage (sm->heap, &usage);
385 sm->directory_vector[STAT_COUNTER_MEM_STATSEG_TOTAL].value =
392 name_sort_cmp (void *a1, void *a2)
394 stat_segment_directory_entry_t *n1 = a1;
395 stat_segment_directory_entry_t *n2 = a2;
397 return strcmp ((char *) n1->name, (char *) n2->name);
401 format_stat_dir_entry (u8 * s, va_list * args)
403 stat_segment_directory_entry_t *ep =
404 va_arg (*args, stat_segment_directory_entry_t *);
408 format_string = "%-74s %-10s %10lld";
412 case STAT_DIR_TYPE_SCALAR_INDEX:
413 type_name = "ScalarPtr";
416 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
417 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
418 type_name = "CMainPtr";
421 case STAT_DIR_TYPE_ERROR_INDEX:
422 type_name = "ErrIndex";
425 case STAT_DIR_TYPE_NAME_VECTOR:
426 type_name = "NameVector";
429 case STAT_DIR_TYPE_EMPTY:
434 type_name = "illegal!";
438 return format (s, format_string, ep->name, type_name, ep->offset);
441 static clib_error_t *
442 show_stat_segment_command_fn (vlib_main_t * vm,
443 unformat_input_t * input,
444 vlib_cli_command_t * cmd)
446 stat_segment_main_t *sm = &stat_segment_main;
447 stat_segment_directory_entry_t *show_data;
452 if (unformat (input, "verbose"))
455 /* Lock even as reader, as this command doesn't handle epoch changes */
456 vlib_stat_segment_lock ();
457 show_data = vec_dup (sm->directory_vector);
458 vlib_stat_segment_unlock ();
460 vec_sort_with_function (show_data, name_sort_cmp);
462 vlib_cli_output (vm, "%-74s %10s %10s", "Name", "Type", "Value");
464 for (i = 0; i < vec_len (show_data); i++)
466 stat_segment_directory_entry_t *ep = vec_elt_at_index (show_data, i);
468 if (ep->type == STAT_DIR_TYPE_EMPTY)
471 vlib_cli_output (vm, "%-100U", format_stat_dir_entry,
472 vec_elt_at_index (show_data, i));
478 vlib_cli_output (vm, "%U", format_mheap, sm->heap, 0 /* verbose */ );
485 VLIB_CLI_COMMAND (show_stat_segment_command, static) =
487 .path = "show statistics segment",
488 .short_help = "show statistics segment [verbose]",
489 .function = show_stat_segment_command_fn,
494 * Node performance counters:
495 * total_calls [threads][node-index]
502 update_node_counters (stat_segment_main_t * sm)
504 vlib_main_t **stat_vms = 0;
505 vlib_node_t ***node_dups = 0;
507 stat_segment_shared_header_t *shared_header = sm->shared_header;
508 static u32 no_max_nodes = 0;
510 vlib_node_get_nodes (0 /* vm, for barrier sync */ ,
511 (u32) ~ 0 /* all threads */ ,
512 1 /* include stats */ ,
513 0 /* barrier sync */ ,
514 &node_dups, &stat_vms);
516 u32 l = vec_len (node_dups[0]);
519 * Extend performance nodes if necessary
521 if (l > no_max_nodes)
523 void *oldheap = clib_mem_set_heap (sm->heap);
524 vlib_stat_segment_lock ();
526 stat_validate_counter_vector (&sm->directory_vector
527 [STAT_COUNTER_NODE_CLOCKS], l - 1);
528 stat_validate_counter_vector (&sm->directory_vector
529 [STAT_COUNTER_NODE_VECTORS], l - 1);
530 stat_validate_counter_vector (&sm->directory_vector
531 [STAT_COUNTER_NODE_CALLS], l - 1);
532 stat_validate_counter_vector (&sm->directory_vector
533 [STAT_COUNTER_NODE_SUSPENDS], l - 1);
535 vec_validate (sm->nodes, l - 1);
536 stat_segment_directory_entry_t *ep;
537 ep = &sm->directory_vector[STAT_COUNTER_NODE_NAMES];
538 ep->offset = stat_segment_offset (shared_header, sm->nodes);
542 ep->offset_vector ? stat_segment_pointer (shared_header,
543 ep->offset_vector) : 0;
544 /* Update names dictionary */
545 vec_validate (offset_vector, l - 1);
546 vlib_node_t **nodes = node_dups[0];
548 for (i = 0; i < vec_len (nodes); i++)
550 vlib_node_t *n = nodes[i];
552 s = format (s, "%v%c", n->name, 0);
553 if (sm->nodes[n->index])
554 vec_free (sm->nodes[n->index]);
555 sm->nodes[n->index] = s;
557 sm->nodes[i] ? stat_segment_offset (shared_header,
561 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
563 vlib_stat_segment_unlock ();
564 clib_mem_set_heap (oldheap);
568 for (j = 0; j < vec_len (node_dups); j++)
570 vlib_node_t **nodes = node_dups[j];
572 for (i = 0; i < vec_len (nodes); i++)
574 counter_t **counters;
576 vlib_node_t *n = nodes[i];
579 stat_segment_pointer (shared_header,
581 [STAT_COUNTER_NODE_CLOCKS].offset);
583 c[n->index] = n->stats_total.clocks - n->stats_last_clear.clocks;
586 stat_segment_pointer (shared_header,
588 [STAT_COUNTER_NODE_VECTORS].offset);
590 c[n->index] = n->stats_total.vectors - n->stats_last_clear.vectors;
593 stat_segment_pointer (shared_header,
595 [STAT_COUNTER_NODE_CALLS].offset);
597 c[n->index] = n->stats_total.calls - n->stats_last_clear.calls;
600 stat_segment_pointer (shared_header,
602 [STAT_COUNTER_NODE_SUSPENDS].offset);
605 n->stats_total.suspends - n->stats_last_clear.suspends;
607 vec_free (node_dups[j]);
609 vec_free (node_dups);
614 do_stat_segment_updates (stat_segment_main_t * sm)
616 vlib_main_t *vm = vlib_mains[0];
620 vlib_main_t *this_vlib_main;
622 static int num_worker_threads_set;
625 * Set once at the beginning of time.
626 * Can't do this from the init routine, which happens before
627 * start_workers sets up vlib_mains...
629 if (PREDICT_FALSE (num_worker_threads_set == 0))
631 void *oldheap = clib_mem_set_heap (sm->heap);
632 vlib_stat_segment_lock ();
634 stat_validate_counter_vector (&sm->directory_vector
635 [STAT_COUNTER_VECTOR_RATE_PER_WORKER], 0);
636 num_worker_threads_set = 1;
637 vlib_stat_segment_unlock ();
638 clib_mem_set_heap (oldheap);
642 * Compute per-worker vector rates, and the average vector rate
647 for (i = 0; i < vec_len (vlib_mains); i++)
650 f64 this_vector_rate;
652 this_vlib_main = vlib_mains[i];
654 this_vector_rate = vlib_internal_node_vector_rate (this_vlib_main);
655 vlib_clear_internal_node_vector_rate (this_vlib_main);
657 vector_rate += this_vector_rate;
659 /* Set the per-worker rate */
660 stat_set_simple_counter (&sm->directory_vector
661 [STAT_COUNTER_VECTOR_RATE_PER_WORKER], i, 0,
665 /* And set the system average rate */
666 vector_rate /= (f64) (i > 1 ? i - 1 : 1);
668 sm->directory_vector[STAT_COUNTER_VECTOR_RATE].value = vector_rate;
671 * Compute the aggregate input rate
673 now = vlib_time_now (vm);
674 dt = now - sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value;
675 input_packets = vnet_get_aggregate_rx_packets ();
676 sm->directory_vector[STAT_COUNTER_INPUT_RATE].value =
677 (f64) (input_packets - sm->last_input_packets) / dt;
678 sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value = now;
679 sm->last_input_packets = input_packets;
680 sm->directory_vector[STAT_COUNTER_LAST_STATS_CLEAR].value =
681 vm->node_main.time_last_runtime_stats_clear;
683 /* Stats segment memory heap counter */
684 clib_mem_usage_t usage;
685 mheap_usage (sm->heap, &usage);
686 sm->directory_vector[STAT_COUNTER_MEM_STATSEG_USED].value =
689 if (sm->node_counters_enabled)
690 update_node_counters (sm);
693 stat_segment_gauges_pool_t *g;
694 pool_foreach(g, sm->gauges,
696 g->fn(&sm->directory_vector[g->directory_index], g->caller_index);
700 /* Heartbeat, so clients detect we're still here */
701 sm->directory_vector[STAT_COUNTER_HEARTBEAT].value++;
705 * Accept connection on the socket and exchange the fd for the shared
708 static clib_error_t *
709 stats_socket_accept_ready (clib_file_t * uf)
711 stat_segment_main_t *sm = &stat_segment_main;
713 clib_socket_t client = { 0 };
715 err = clib_socket_accept (sm->socket, &client);
718 clib_error_report (err);
722 /* Send the fd across and close */
723 err = clib_socket_sendmsg (&client, 0, 0, &sm->memfd, 1);
725 clib_error_report (err);
726 clib_socket_close (&client);
731 static clib_error_t *
732 stats_segment_socket_init (void)
734 stat_segment_main_t *sm = &stat_segment_main;
736 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
738 memset (s, 0, sizeof (clib_socket_t));
739 s->config = (char *) sm->socket_name;
740 s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
741 CLIB_SOCKET_F_ALLOW_GROUP_WRITE | CLIB_SOCKET_F_PASSCRED;
743 if ((error = clib_socket_init (s)))
746 clib_file_t template = { 0 };
747 template.read_function = stats_socket_accept_ready;
748 template.file_descriptor = s->fd;
749 template.description = format (0, "stats segment listener %s", s->config);
750 clib_file_add (&file_main, &template);
757 static clib_error_t *
758 stats_segment_socket_exit (vlib_main_t * vm)
761 * cleanup the listener socket on exit.
763 stat_segment_main_t *sm = &stat_segment_main;
764 unlink ((char *) sm->socket_name);
768 VLIB_MAIN_LOOP_EXIT_FUNCTION (stats_segment_socket_exit);
770 /* Overrides weak reference in vlib:node_cli.c */
772 vlib_get_stat_segment_update_rate (void)
774 return stat_segment_main.update_interval;
778 stat_segment_collector_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
781 stat_segment_main_t *sm = &stat_segment_main;
785 do_stat_segment_updates (sm);
786 vlib_process_suspend (vm, sm->update_interval);
788 return 0; /* or not */
791 static clib_error_t *
792 statseg_init (vlib_main_t * vm)
794 stat_segment_main_t *sm = &stat_segment_main;
796 /* set default socket file name when statseg config stanza is empty. */
797 if (!vec_len (sm->socket_name))
798 sm->socket_name = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
799 STAT_SEGMENT_SOCKET_FILENAME, 0);
800 return stats_segment_socket_init ();
804 VLIB_INIT_FUNCTION (statseg_init) =
806 .runs_after = VLIB_INITS("unix_input_init"),
811 stat_segment_register_gauge (u8 * name, stat_segment_update_fn update_fn,
814 stat_segment_main_t *sm = &stat_segment_main;
815 stat_segment_shared_header_t *shared_header = sm->shared_header;
817 stat_segment_directory_entry_t e;
818 stat_segment_gauges_pool_t *gauge;
820 ASSERT (shared_header);
822 u32 vector_index = lookup_hash_index (name);
824 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
825 return clib_error_return (0, "%v is already registered", name);
827 memset (&e, 0, sizeof (e));
828 e.type = STAT_DIR_TYPE_SCALAR_INDEX;
829 memcpy (e.name, name, vec_len (name));
831 oldheap = vlib_stats_push_heap (NULL);
832 vlib_stat_segment_lock ();
833 vector_index = vlib_stats_create_counter (&e, oldheap);
835 shared_header->directory_offset =
836 stat_segment_offset (shared_header, sm->directory_vector);
838 vlib_stat_segment_unlock ();
839 clib_mem_set_heap (oldheap);
841 /* Back on our own heap */
842 pool_get (sm->gauges, gauge);
843 gauge->fn = update_fn;
844 gauge->caller_index = caller_index;
845 gauge->directory_index = vector_index;
851 stat_segment_register_state_counter (u8 * name, u32 * index)
853 stat_segment_main_t *sm = &stat_segment_main;
854 stat_segment_shared_header_t *shared_header = sm->shared_header;
856 stat_segment_directory_entry_t e;
858 ASSERT (shared_header);
859 ASSERT (vlib_get_thread_index () == 0);
861 u32 vector_index = lookup_hash_index (name);
863 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
864 return clib_error_return (0, "%v is already registered", name);
866 memset (&e, 0, sizeof (e));
867 e.type = STAT_DIR_TYPE_SCALAR_INDEX;
868 memcpy (e.name, name, vec_len (name));
870 oldheap = vlib_stats_push_heap (NULL);
871 vlib_stat_segment_lock ();
873 vector_index = vlib_stats_create_counter (&e, oldheap);
875 shared_header->directory_offset =
876 stat_segment_offset (shared_header, sm->directory_vector);
878 vlib_stat_segment_unlock ();
879 clib_mem_set_heap (oldheap);
881 *index = vector_index;
886 stat_segment_deregister_state_counter (u32 index)
888 stat_segment_main_t *sm = &stat_segment_main;
889 stat_segment_shared_header_t *shared_header = sm->shared_header;
890 stat_segment_directory_entry_t *e;
893 ASSERT (shared_header);
895 if (index > vec_len (sm->directory_vector))
896 return clib_error_return (0, "%u index does not exist", index);
898 e = &sm->directory_vector[index];
899 if (e->type != STAT_DIR_TYPE_SCALAR_INDEX)
900 return clib_error_return (0, "%u index cannot be deleted", index);
902 oldheap = vlib_stats_push_heap (NULL);
903 vlib_stat_segment_lock ();
905 vlib_stats_delete_counter (index, oldheap);
907 vlib_stat_segment_unlock ();
908 clib_mem_set_heap (oldheap);
914 stat_segment_set_state_counter (u32 index, u64 value)
916 stat_segment_main_t *sm = &stat_segment_main;
918 ASSERT (index < vec_len (sm->directory_vector));
919 sm->directory_vector[index].index = value;
922 static clib_error_t *
923 statseg_config (vlib_main_t * vm, unformat_input_t * input)
925 stat_segment_main_t *sm = &stat_segment_main;
926 sm->update_interval = 10.0;
928 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
930 if (unformat (input, "socket-name %s", &sm->socket_name))
932 /* DEPRECATE: default (does nothing) */
933 else if (unformat (input, "default"))
935 else if (unformat (input, "size %U",
936 unformat_memory_size, &sm->memory_size))
938 else if (unformat (input, "per-node-counters on"))
939 sm->node_counters_enabled = 1;
940 else if (unformat (input, "per-node-counters off"))
941 sm->node_counters_enabled = 0;
942 else if (unformat (input, "update-interval %f", &sm->update_interval))
945 return clib_error_return (0, "unknown input `%U'",
946 format_unformat_error, input);
950 * NULL-terminate socket name string
951 * clib_socket_init()->socket_config() use C str*
953 if (vec_len (sm->socket_name))
954 vec_terminate_c_string (sm->socket_name);
959 VLIB_EARLY_CONFIG_FUNCTION (statseg_config, "statseg");
961 static clib_error_t *
962 statseg_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
964 stat_segment_main_t *sm = &stat_segment_main;
965 stat_segment_shared_header_t *shared_header = sm->shared_header;
967 void *oldheap = vlib_stats_push_heap (sm->interfaces);
968 vlib_stat_segment_lock ();
970 vec_validate (sm->interfaces, sw_if_index);
973 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
974 vnet_sw_interface_t *si_sup =
975 vnet_get_sup_sw_interface (vnm, si->sw_if_index);
976 vnet_hw_interface_t *hi_sup;
978 ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
979 hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
982 s = format (s, "%v", hi_sup->name);
983 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
984 s = format (s, ".%d", si->sub.id);
985 s = format (s, "%c", 0);
986 sm->interfaces[sw_if_index] = s;
990 vec_free (sm->interfaces[sw_if_index]);
991 sm->interfaces[sw_if_index] = 0;
994 stat_segment_directory_entry_t *ep;
995 ep = &sm->directory_vector[STAT_COUNTER_INTERFACE_NAMES];
996 ep->offset = stat_segment_offset (shared_header, sm->interfaces);
1000 ep->offset_vector ? stat_segment_pointer (shared_header,
1001 ep->offset_vector) : 0;
1003 vec_validate (offset_vector, vec_len (sm->interfaces) - 1);
1005 if (sm->last != sm->interfaces)
1007 /* the interface vector moved, so need to recalulate the offset array */
1008 for (i = 0; i < vec_len (sm->interfaces); i++)
1011 sm->interfaces[i] ? stat_segment_offset (shared_header,
1012 sm->interfaces[i]) : 0;
1017 offset_vector[sw_if_index] =
1018 sm->interfaces[sw_if_index] ?
1019 stat_segment_offset (shared_header, sm->interfaces[sw_if_index]) : 0;
1021 ep->offset_vector = stat_segment_offset (shared_header, offset_vector);
1023 vlib_stat_segment_unlock ();
1024 clib_mem_set_heap (oldheap);
1029 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (statseg_sw_interface_add_del);
1032 VLIB_REGISTER_NODE (stat_segment_collector, static) =
1034 .function = stat_segment_collector_process,
1035 .name = "statseg-collector-process",
1036 .type = VLIB_NODE_TYPE_PROCESS,
1042 * fd.io coding-style-patch-verification: ON
1045 * eval: (c-set-style "gnu")