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 vlib_stats_pop_heap2 (u64 * error_vector, u32 thread_index, void *oldheap,
366 stat_segment_main_t *sm = &stat_segment_main;
367 stat_segment_shared_header_t *shared_header = sm->shared_header;
369 ASSERT (shared_header);
372 vlib_stat_segment_lock ();
374 /* Reset the client hash table pointer, since it WILL change! */
375 vec_validate (sm->error_vector, thread_index);
376 sm->error_vector[thread_index] = error_vector;
378 shared_header->error_vector = sm->error_vector;
379 shared_header->directory_vector = sm->directory_vector;
382 vlib_stat_segment_unlock ();
383 clib_mem_set_heap (oldheap);
387 * Create a new entry and add name to directory hash.
388 * Returns ~0 if name exists.
389 * Called from main heap.
392 stat_segment_new_entry (u8 *name, stat_directory_type_t t)
394 stat_segment_main_t *sm = &stat_segment_main;
395 stat_segment_shared_header_t *shared_header = sm->shared_header;
397 stat_segment_directory_entry_t e;
399 ASSERT (shared_header);
401 u32 vector_index = lookup_hash_index (name);
402 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
405 memset (&e, 0, sizeof (e));
407 memcpy (e.name, name, vec_len (name));
409 oldheap = vlib_stats_push_heap (NULL);
410 vlib_stat_segment_lock ();
411 vector_index = vlib_stats_create_counter (&e, oldheap);
413 shared_header->directory_vector = sm->directory_vector;
415 vlib_stat_segment_unlock ();
416 clib_mem_set_heap (oldheap);
422 vlib_map_stat_segment_init (void)
424 stat_segment_main_t *sm = &stat_segment_main;
425 stat_segment_shared_header_t *shared_header;
427 uword memory_size, sys_page_sz;
429 char *mem_name = "stat segment";
430 void *heap, *memaddr;
432 memory_size = sm->memory_size;
433 if (memory_size == 0)
434 memory_size = STAT_SEGMENT_DEFAULT_SIZE;
436 if (sm->log2_page_sz == CLIB_MEM_PAGE_SZ_UNKNOWN)
437 sm->log2_page_sz = CLIB_MEM_PAGE_SZ_DEFAULT;
439 mfd = clib_mem_vm_create_fd (sm->log2_page_sz, mem_name);
442 return clib_error_return (0, "stat segment memory fd failure: %U",
443 format_clib_error, clib_mem_get_last_error ());
445 if ((ftruncate (mfd, memory_size)) == -1)
448 return clib_error_return (0, "stat segment ftruncate failure");
451 memaddr = clib_mem_vm_map_shared (0, memory_size, mfd, 0, mem_name);
453 if (memaddr == CLIB_MEM_VM_MAP_FAILED)
454 return clib_error_return (0, "stat segment mmap failure");
456 sys_page_sz = clib_mem_get_page_size ();
459 clib_mem_create_heap (((u8 *) memaddr) + sys_page_sz,
460 memory_size - sys_page_sz, 1 /* locked */, mem_name);
464 sm->directory_vector_by_name = hash_create_string (0, sizeof (uword));
465 sm->shared_header = shared_header = memaddr;
467 shared_header->version = STAT_SEGMENT_VERSION;
468 shared_header->base = memaddr;
470 sm->stat_segment_lockp = clib_mem_alloc (sizeof (clib_spinlock_t));
471 clib_spinlock_init (sm->stat_segment_lockp);
473 oldheap = clib_mem_set_heap (sm->heap);
475 /* Set up the name to counter-vector hash table */
476 sm->directory_vector = 0;
478 shared_header->epoch = 1;
480 /* Scalar stats and node counters */
481 vec_validate (sm->directory_vector, STAT_COUNTERS - 1);
483 strcpy(sm->directory_vector[STAT_COUNTER_##E].name, #p "/" #n); \
484 sm->directory_vector[STAT_COUNTER_##E].type = STAT_DIR_TYPE_##t;
485 foreach_stat_segment_counter_name
487 /* Save the vector in the shared segment, for clients */
488 shared_header->directory_vector = sm->directory_vector;
490 clib_mem_set_heap (oldheap);
492 vlib_stats_register_mem_heap (heap);
498 name_sort_cmp (void *a1, void *a2)
500 stat_segment_directory_entry_t *n1 = a1;
501 stat_segment_directory_entry_t *n2 = a2;
503 return strcmp ((char *) n1->name, (char *) n2->name);
507 format_stat_dir_entry (u8 * s, va_list * args)
509 stat_segment_directory_entry_t *ep =
510 va_arg (*args, stat_segment_directory_entry_t *);
514 format_string = "%-74s %-10s %10lld";
518 case STAT_DIR_TYPE_SCALAR_INDEX:
519 type_name = "ScalarPtr";
522 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
523 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
524 type_name = "CMainPtr";
527 case STAT_DIR_TYPE_ERROR_INDEX:
528 type_name = "ErrIndex";
531 case STAT_DIR_TYPE_NAME_VECTOR:
532 type_name = "NameVector";
535 case STAT_DIR_TYPE_EMPTY:
539 case STAT_DIR_TYPE_SYMLINK:
540 type_name = "Symlink";
544 type_name = "illegal!";
548 return format (s, format_string, ep->name, type_name, 0);
551 static clib_error_t *
552 show_stat_segment_command_fn (vlib_main_t * vm,
553 unformat_input_t * input,
554 vlib_cli_command_t * cmd)
556 stat_segment_main_t *sm = &stat_segment_main;
557 stat_segment_directory_entry_t *show_data;
562 if (unformat (input, "verbose"))
565 /* Lock even as reader, as this command doesn't handle epoch changes */
566 vlib_stat_segment_lock ();
567 show_data = vec_dup (sm->directory_vector);
568 vlib_stat_segment_unlock ();
570 vec_sort_with_function (show_data, name_sort_cmp);
572 vlib_cli_output (vm, "%-74s %10s %10s", "Name", "Type", "Value");
574 for (i = 0; i < vec_len (show_data); i++)
576 stat_segment_directory_entry_t *ep = vec_elt_at_index (show_data, i);
578 if (ep->type == STAT_DIR_TYPE_EMPTY)
581 vlib_cli_output (vm, "%-100U", format_stat_dir_entry,
582 vec_elt_at_index (show_data, i));
588 vlib_cli_output (vm, "%U", format_clib_mem_heap, sm->heap,
596 VLIB_CLI_COMMAND (show_stat_segment_command, static) =
598 .path = "show statistics segment",
599 .short_help = "show statistics segment [verbose]",
600 .function = show_stat_segment_command_fn,
605 * Node performance counters:
606 * total_calls [threads][node-index]
613 update_node_counters (stat_segment_main_t * sm)
615 vlib_main_t **stat_vms = 0;
616 vlib_node_t ***node_dups = 0;
618 static u32 no_max_nodes = 0;
620 vlib_node_get_nodes (0 /* vm, for barrier sync */,
621 (u32) ~0 /* all threads */, 1 /* include stats */,
622 0 /* barrier sync */, &node_dups, &stat_vms);
624 u32 l = vec_len (node_dups[0]);
625 u8 *symlink_name = 0;
628 * Extend performance nodes if necessary
630 if (l > no_max_nodes)
632 void *oldheap = clib_mem_set_heap (sm->heap);
633 vlib_stat_segment_lock ();
635 stat_validate_counter_vector (
636 &sm->directory_vector[STAT_COUNTER_NODE_CLOCKS], l - 1);
637 stat_validate_counter_vector (
638 &sm->directory_vector[STAT_COUNTER_NODE_VECTORS], l - 1);
639 stat_validate_counter_vector (
640 &sm->directory_vector[STAT_COUNTER_NODE_CALLS], l - 1);
641 stat_validate_counter_vector (
642 &sm->directory_vector[STAT_COUNTER_NODE_SUSPENDS], l - 1);
644 vec_validate (sm->nodes, l - 1);
645 stat_segment_directory_entry_t *ep;
646 ep = &sm->directory_vector[STAT_COUNTER_NODE_NAMES];
647 ep->data = sm->nodes;
649 /* Update names dictionary */
650 vlib_node_t **nodes = node_dups[0];
652 for (i = 0; i < vec_len (nodes); i++)
654 vlib_node_t *n = nodes[i];
656 s = format (s, "%v%c", n->name, 0);
657 if (sm->nodes[n->index])
658 vec_free (sm->nodes[n->index]);
659 sm->nodes[n->index] = s;
661 #define _(E, t, name, p) \
662 vec_reset_length (symlink_name); \
663 symlink_name = format (symlink_name, "/nodes/%U/" #name "%c", \
664 format_vlib_stats_symlink, s, 0); \
665 vlib_stats_register_symlink (oldheap, symlink_name, STAT_COUNTER_##E, \
666 n->index, 0 /* don't lock */);
667 foreach_stat_segment_node_counter_name
670 vec_free (symlink_name);
671 vlib_stat_segment_unlock ();
672 clib_mem_set_heap (oldheap);
676 for (j = 0; j < vec_len (node_dups); j++)
678 vlib_node_t **nodes = node_dups[j];
680 for (i = 0; i < vec_len (nodes); i++)
682 counter_t **counters;
684 vlib_node_t *n = nodes[i];
688 if (strncmp ((char *) sm->nodes[n->index], (char *) n->name,
689 strlen ((char *) sm->nodes[n->index])))
693 u8 *symlink_new_name = 0;
694 void *oldheap = clib_mem_set_heap (sm->heap);
695 vlib_stat_segment_lock ();
696 s = format (s, "%v%c", n->name, 0);
697 #define _(E, t, name, p) \
698 vec_reset_length (symlink_name); \
699 symlink_name = format (symlink_name, "/nodes/%U/" #name "%c", \
700 format_vlib_stats_symlink, sm->nodes[n->index], 0); \
701 clib_mem_set_heap (oldheap); /* Exit stats segment */ \
702 vector_index = lookup_hash_index ((u8 *) symlink_name); \
703 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */ \
704 vec_reset_length (symlink_new_name); \
705 symlink_new_name = format (symlink_new_name, "/nodes/%U/" #name "%c", \
706 format_vlib_stats_symlink, s, 0); \
707 vlib_stats_rename_symlink (oldheap, vector_index, symlink_new_name);
708 foreach_stat_segment_node_counter_name
710 vec_free (symlink_name);
711 vec_free (symlink_new_name);
712 vec_free (sm->nodes[n->index]);
713 sm->nodes[n->index] = s;
714 vlib_stat_segment_unlock ();
715 clib_mem_set_heap (oldheap);
719 counters = sm->directory_vector[STAT_COUNTER_NODE_CLOCKS].data;
721 c[n->index] = n->stats_total.clocks - n->stats_last_clear.clocks;
723 counters = sm->directory_vector[STAT_COUNTER_NODE_VECTORS].data;
725 c[n->index] = n->stats_total.vectors - n->stats_last_clear.vectors;
727 counters = sm->directory_vector[STAT_COUNTER_NODE_CALLS].data;
729 c[n->index] = n->stats_total.calls - n->stats_last_clear.calls;
731 counters = sm->directory_vector[STAT_COUNTER_NODE_SUSPENDS].data;
733 c[n->index] = n->stats_total.suspends - n->stats_last_clear.suspends;
735 vec_free (node_dups[j]);
737 vec_free (node_dups);
742 do_stat_segment_updates (vlib_main_t *vm, stat_segment_main_t *sm)
746 static int num_worker_threads_set;
749 * Set once at the beginning of time.
750 * Can't do this from the init routine, which happens before
751 * start_workers sets up vlib_mains...
753 if (PREDICT_FALSE (num_worker_threads_set == 0))
755 vlib_thread_main_t *tm = vlib_get_thread_main ();
756 ASSERT (tm->n_vlib_mains > 0);
757 stat_provider_register_vector_rate (tm->n_vlib_mains - 1);
758 sm->directory_vector[STAT_COUNTER_NUM_WORKER_THREADS].value =
759 tm->n_vlib_mains - 1;
760 num_worker_threads_set = 1;
764 * Compute the aggregate input rate
766 now = vlib_time_now (vm);
767 dt = now - sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value;
768 input_packets = vnet_get_aggregate_rx_packets ();
769 sm->directory_vector[STAT_COUNTER_INPUT_RATE].value =
770 (f64) (input_packets - sm->last_input_packets) / dt;
771 sm->directory_vector[STAT_COUNTER_LAST_UPDATE].value = now;
772 sm->last_input_packets = input_packets;
773 sm->directory_vector[STAT_COUNTER_LAST_STATS_CLEAR].value =
774 vm->node_main.time_last_runtime_stats_clear;
776 if (sm->node_counters_enabled)
777 update_node_counters (sm);
780 stat_segment_gauges_pool_t *g;
781 pool_foreach (g, sm->gauges)
783 g->fn(&sm->directory_vector[g->directory_index], g->caller_index);
787 /* Heartbeat, so clients detect we're still here */
788 sm->directory_vector[STAT_COUNTER_HEARTBEAT].value++;
792 * Accept connection on the socket and exchange the fd for the shared
795 static clib_error_t *
796 stats_socket_accept_ready (clib_file_t * uf)
798 stat_segment_main_t *sm = &stat_segment_main;
800 clib_socket_t client = { 0 };
802 err = clib_socket_accept (sm->socket, &client);
805 clib_error_report (err);
809 /* Send the fd across and close */
810 err = clib_socket_sendmsg (&client, 0, 0, &sm->memfd, 1);
812 clib_error_report (err);
813 clib_socket_close (&client);
818 static clib_error_t *
819 stats_segment_socket_init (void)
821 stat_segment_main_t *sm = &stat_segment_main;
823 clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
825 memset (s, 0, sizeof (clib_socket_t));
826 s->config = (char *) sm->socket_name;
827 s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
828 CLIB_SOCKET_F_ALLOW_GROUP_WRITE | CLIB_SOCKET_F_PASSCRED;
830 if ((error = clib_socket_init (s)))
833 clib_file_t template = { 0 };
834 template.read_function = stats_socket_accept_ready;
835 template.file_descriptor = s->fd;
836 template.description = format (0, "stats segment listener %s", s->config);
837 clib_file_add (&file_main, &template);
844 static clib_error_t *
845 stats_segment_socket_exit (vlib_main_t * vm)
848 * cleanup the listener socket on exit.
850 stat_segment_main_t *sm = &stat_segment_main;
851 unlink ((char *) sm->socket_name);
855 VLIB_MAIN_LOOP_EXIT_FUNCTION (stats_segment_socket_exit);
857 /* Overrides weak reference in vlib:node_cli.c */
859 vlib_get_stat_segment_update_rate (void)
861 return stat_segment_main.update_interval;
865 stat_segment_collector_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
868 stat_segment_main_t *sm = &stat_segment_main;
872 do_stat_segment_updates (vm, sm);
873 vlib_process_suspend (vm, sm->update_interval);
875 return 0; /* or not */
879 * Add a data provider (via callback) for a given stats entry.
880 * TODO: Add support for per-provider interval.
883 stat_segment_poll_add (u32 vector_index, stat_segment_update_fn update_fn,
884 u32 caller_index, u32 interval)
886 stat_segment_main_t *sm = &stat_segment_main;
887 stat_segment_gauges_pool_t *gauge;
889 pool_get (sm->gauges, gauge);
890 gauge->fn = update_fn;
891 gauge->caller_index = caller_index;
892 gauge->directory_index = vector_index;
898 * Create an scalar entry with a data provider.
899 * Deprecated, replace with stat_segment_new_entry + stat_segment_pool_add
902 stat_segment_register_gauge (u8 * name, stat_segment_update_fn update_fn,
905 stat_segment_main_t *sm = &stat_segment_main;
906 stat_segment_gauges_pool_t *gauge;
908 u32 vector_index = stat_segment_new_entry (name, STAT_DIR_TYPE_SCALAR_INDEX);
909 if (vector_index == ~0) /* Already registered */
910 return clib_error_return (0, "%v is already registered", name);
912 pool_get (sm->gauges, gauge);
913 gauge->fn = update_fn;
914 gauge->caller_index = caller_index;
915 gauge->directory_index = vector_index;
921 stat_segment_register_state_counter (u8 * name, u32 * index)
923 ASSERT (vlib_get_thread_index () == 0);
925 u32 vector_index = stat_segment_new_entry (name, STAT_DIR_TYPE_SCALAR_INDEX);
926 if (vector_index == ~0) /* Already registered */
927 return clib_error_return (0, "%v is already registered", name);
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, "page-size %U",
986 unformat_log2_page_size, &sm->log2_page_sz))
988 else if (unformat (input, "per-node-counters on"))
989 sm->node_counters_enabled = 1;
990 else if (unformat (input, "per-node-counters off"))
991 sm->node_counters_enabled = 0;
992 else if (unformat (input, "update-interval %f", &sm->update_interval))
995 return clib_error_return (0, "unknown input `%U'",
996 format_unformat_error, input);
1000 * NULL-terminate socket name string
1001 * clib_socket_init()->socket_config() use C str*
1003 if (vec_len (sm->socket_name))
1004 vec_terminate_c_string (sm->socket_name);
1009 VLIB_EARLY_CONFIG_FUNCTION (statseg_config, "statseg");
1011 static clib_error_t *
1012 statseg_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
1014 stat_segment_main_t *sm = &stat_segment_main;
1015 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
1016 vnet_sw_interface_t *si_sup =
1017 vnet_get_sup_sw_interface (vnm, si->sw_if_index);
1018 vnet_hw_interface_t *hi_sup;
1020 u8 *symlink_name = 0;
1023 void *oldheap = vlib_stats_push_heap (sm->interfaces);
1024 vlib_stat_segment_lock ();
1026 vec_validate (sm->interfaces, sw_if_index);
1028 ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
1029 hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
1031 s = format (s, "%v", hi_sup->name);
1032 if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
1033 s = format (s, ".%d", si->sub.id);
1034 s = format (s, "%c", 0);
1038 sm->interfaces[sw_if_index] = s;
1039 #define _(E, n, p) \
1040 clib_mem_set_heap (oldheap); /* Exit stats segment */ \
1041 vector_index = lookup_hash_index ((u8 *) "/" #p "/" #n); \
1042 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */ \
1043 vec_reset_length (symlink_name); \
1044 symlink_name = format (symlink_name, "/interfaces/%U/" #n "%c", \
1045 format_vlib_stats_symlink, s, 0); \
1046 vlib_stats_register_symlink (oldheap, symlink_name, vector_index, \
1047 sw_if_index, 0 /* don't lock */);
1048 foreach_simple_interface_counter_name
1049 foreach_combined_interface_counter_name
1052 vec_free (symlink_name);
1056 vec_free (sm->interfaces[sw_if_index]);
1057 sm->interfaces[sw_if_index] = 0;
1058 #define _(E, n, p) \
1059 vec_reset_length (symlink_name); \
1060 symlink_name = format (symlink_name, "/interfaces/%U/" #n "%c", \
1061 format_vlib_stats_symlink, s, 0); \
1062 clib_mem_set_heap (oldheap); /* Exit stats segment */ \
1063 vector_index = lookup_hash_index ((u8 *) symlink_name); \
1064 clib_mem_set_heap (sm->heap); /* Re-enter stat segment */ \
1065 vlib_stats_delete_counter (vector_index, oldheap);
1066 foreach_simple_interface_counter_name
1067 foreach_combined_interface_counter_name
1070 vec_free (symlink_name);
1073 stat_segment_directory_entry_t *ep;
1074 ep = &sm->directory_vector[STAT_COUNTER_INTERFACE_NAMES];
1075 ep->data = sm->interfaces;
1077 vlib_stat_segment_unlock ();
1078 clib_mem_set_heap (oldheap);
1083 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (statseg_sw_interface_add_del);
1085 VLIB_REGISTER_NODE (stat_segment_collector, static) =
1087 .function = stat_segment_collector_process,
1088 .name = "statseg-collector-process",
1089 .type = VLIB_NODE_TYPE_PROCESS,
1092 static clib_error_t *
1093 statseg_init (vlib_main_t *vm)
1095 stat_segment_main_t *sm = &stat_segment_main;
1097 /* set default socket file name when statseg config stanza is empty. */
1098 if (!vec_len (sm->socket_name))
1099 sm->socket_name = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
1100 STAT_SEGMENT_SOCKET_FILENAME, 0);
1101 return stats_segment_socket_init ();
1104 VLIB_INIT_FUNCTION (statseg_init) = {
1105 .runs_after = VLIB_INITS ("unix_input_init"),
1109 * fd.io coding-style-patch-verification: ON
1112 * eval: (c-set-style "gnu")