1 /* SPDX-License-Identifier: Apache-2.0
2 * Copyright(c) 2022 Cisco Systems, Inc.
5 #ifndef included_stats_stats_h
6 #define included_stats_stats_h
8 #include <vppinfra/socket.h>
9 #include <vppinfra/lock.h>
10 #include <vlib/stats/shared.h>
12 /* Default stat segment 32m */
13 #define STAT_SEGMENT_DEFAULT_SIZE (32 << 20)
15 /* Shared segment memory layout version */
16 #define STAT_SEGMENT_VERSION 2
18 #define STAT_SEGMENT_INDEX_INVALID UINT32_MAX
22 STAT_COUNTER_HEARTBEAT = 0,
23 STAT_COUNTER_LAST_STATS_CLEAR,
24 STAT_COUNTER_NODE_CLOCKS,
25 STAT_COUNTER_NODE_VECTORS,
26 STAT_COUNTER_NODE_CALLS,
27 STAT_COUNTER_NODE_SUSPENDS,
28 STAT_COUNTER_NODE_NAMES,
30 } stat_segment_counter_t;
32 #define foreach_stat_segment_node_counter_name \
33 _ (NODE_CLOCKS, COUNTER_VECTOR_SIMPLE, clocks, "/sys/node") \
34 _ (NODE_VECTORS, COUNTER_VECTOR_SIMPLE, vectors, "/sys/node") \
35 _ (NODE_CALLS, COUNTER_VECTOR_SIMPLE, calls, "/sys/node") \
36 _ (NODE_SUSPENDS, COUNTER_VECTOR_SIMPLE, suspends, "/sys/node")
38 #define foreach_stat_segment_counter_name \
39 _ (LAST_STATS_CLEAR, SCALAR_INDEX, last_stats_clear, "/sys") \
40 _ (HEARTBEAT, SCALAR_INDEX, heartbeat, "/sys") \
41 _ (NODE_NAMES, NAME_VECTOR, names, "/sys/node") \
42 foreach_stat_segment_node_counter_name
49 vlib_stats_entry_t *entry;
50 } vlib_stats_collector_data_t;
52 typedef void (*vlib_stats_collector_fn_t) (vlib_stats_collector_data_t *);
56 vlib_stats_collector_fn_t collect_fn;
60 } vlib_stats_collector_reg_t;
64 vlib_stats_collector_fn_t fn;
68 } vlib_stats_collector_t;
72 /* internal, does not point to shared memory */
73 vlib_stats_collector_t *collectors;
75 /* statistics segment */
76 uword *directory_vector_by_name;
77 vlib_stats_entry_t *directory_vector;
83 clib_spinlock_t *stat_segment_lockp;
84 u32 locking_thread_index;
86 clib_socket_t *socket;
89 clib_mem_page_sz_t log2_page_sz;
90 u8 node_counters_enabled;
92 vlib_stats_shared_header_t
93 *shared_header; /* pointer to shared memory segment */
96 } vlib_stats_segment_t;
100 vlib_stats_segment_t segment;
103 extern vlib_stats_main_t vlib_stats_main;
105 static_always_inline vlib_stats_segment_t *
106 vlib_stats_get_segment ()
108 return &vlib_stats_main.segment;
111 static_always_inline vlib_stats_entry_t *
112 vlib_stats_get_entry (vlib_stats_segment_t *sm, u32 entry_index)
114 vlib_stats_entry_t *e;
115 ASSERT (entry_index < vec_len (sm->directory_vector));
116 e = sm->directory_vector + entry_index;
117 ASSERT (e->type != STAT_DIR_TYPE_EMPTY && e->type != STAT_DIR_TYPE_ILLEGAL);
121 static_always_inline void *
122 vlib_stats_get_entry_data_pointer (u32 entry_index)
124 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
125 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
129 clib_error_t *vlib_stats_init (vlib_main_t *vm);
130 void *vlib_stats_set_heap ();
131 void vlib_stats_segment_lock (void);
132 void vlib_stats_segment_unlock (void);
133 void vlib_stats_register_mem_heap (clib_mem_heap_t *);
134 f64 vlib_stats_get_segment_update_rate (void);
137 u32 vlib_stats_add_gauge (char *fmt, ...);
138 void vlib_stats_set_gauge (u32 entry_index, u64 value);
141 u32 vlib_stats_add_timestamp (char *fmt, ...);
142 void vlib_stats_set_timestamp (u32 entry_index, f64 value);
145 u32 vlib_stats_add_counter_vector (char *fmt, ...);
147 /* counter pair vector */
148 u32 vlib_stats_add_counter_pair_vector (char *fmt, ...);
151 u32 vlib_stats_add_string_vector (char *fmt, ...);
152 void vlib_stats_set_string_vector (u32 entry_index, u32 vector_index,
156 u32 vlib_stats_add_symlink (u32 entry_index, u32 vector_index, char *fmt, ...);
157 void vlib_stats_rename_symlink (u64 entry_index, char *fmt, ...);
159 /* common to all types */
160 void vlib_stats_validate (u32 entry_index, ...);
161 int vlib_stats_validate_will_expand (u32 entry_index, ...);
162 void vlib_stats_remove_entry (u32 entry_index);
163 u32 vlib_stats_find_entry_index (char *fmt, ...);
164 void vlib_stats_register_collector_fn (vlib_stats_collector_reg_t *r);
166 format_function_t format_vlib_stats_symlink;