1 /* SPDX-License-Identifier: Apache-2.0
2 * Copyright(c) 2022 Cisco Systems, Inc.
6 #include <vlib/stats/stats.h>
8 vlib_stats_main_t vlib_stats_main;
11 vlib_stats_segment_lock (void)
13 vlib_main_t *vm = vlib_get_main ();
14 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
16 /* already locked by us */
17 if (sm->shared_header->in_progress &&
18 vm->thread_index == sm->locking_thread_index)
21 ASSERT (sm->locking_thread_index == ~0);
22 ASSERT (sm->shared_header->in_progress == 0);
23 ASSERT (sm->n_locks == 0);
25 clib_spinlock_lock (sm->stat_segment_lockp);
27 sm->shared_header->in_progress = 1;
28 sm->locking_thread_index = vm->thread_index;
34 vlib_stats_segment_unlock (void)
36 vlib_main_t *vm = vlib_get_main ();
37 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
39 ASSERT (sm->shared_header->in_progress == 1);
40 ASSERT (sm->locking_thread_index == vm->thread_index);
41 ASSERT (sm->n_locks > 0);
48 sm->shared_header->epoch++;
49 __atomic_store_n (&sm->shared_header->in_progress, 0, __ATOMIC_RELEASE);
50 sm->locking_thread_index = ~0;
51 clib_spinlock_unlock (sm->stat_segment_lockp);
55 * Change heap to the stats shared memory segment
58 vlib_stats_set_heap ()
60 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
62 ASSERT (sm && sm->shared_header);
63 return clib_mem_set_heap (sm->heap);
67 vlib_stats_find_entry_index (char *fmt, ...)
73 name = va_format (0, fmt, &va);
77 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
78 hash_pair_t *hp = hash_get_pair (sm->directory_vector_by_name, name);
80 return hp ? hp->value[0] : STAT_SEGMENT_INDEX_INVALID;
84 hash_set_str_key_alloc (uword **h, const char *key, uword v)
86 int size = strlen (key) + 1;
87 void *copy = clib_mem_alloc (size);
88 clib_memcpy_fast (copy, key, size);
89 hash_set_mem (*h, copy, v);
93 hash_unset_str_key_free (uword **h, const char *key)
95 hash_pair_t *hp = hash_get_pair_mem (*h, key);
98 void *_k = uword_to_pointer (hp->key, void *);
99 hash_unset_mem (*h, _k);
105 vlib_stats_create_counter (vlib_stats_entry_t *e)
107 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
111 oldheap = clib_mem_set_heap (sm->heap);
113 if (sm->dir_vector_first_free_elt != CLIB_U32_MAX)
115 index = sm->dir_vector_first_free_elt;
116 sm->dir_vector_first_free_elt = sm->directory_vector[index].index;
120 index = vec_len (sm->directory_vector);
121 vec_validate (sm->directory_vector, index);
124 sm->directory_vector[index] = *e;
126 clib_mem_set_heap (oldheap);
127 hash_set_str_key_alloc (&sm->directory_vector_by_name, e->name, index);
133 vlib_stats_remove_entry (u32 entry_index)
135 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
136 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
142 if (entry_index >= vec_len (sm->directory_vector))
145 oldheap = clib_mem_set_heap (sm->heap);
147 vlib_stats_segment_lock ();
151 case STAT_DIR_TYPE_NAME_VECTOR:
152 for (i = 0; i < vec_len (e->string_vector); i++)
153 vec_free (e->string_vector[i]);
154 vec_free (e->string_vector);
157 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
160 for (i = 0; i < vec_len (c); i++)
165 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
168 for (i = 0; i < vec_len (vc); i++)
173 case STAT_DIR_TYPE_SCALAR_INDEX:
174 case STAT_DIR_TYPE_SYMLINK:
180 vlib_stats_segment_unlock ();
182 clib_mem_set_heap (oldheap);
183 hash_unset_str_key_free (&sm->directory_vector_by_name, e->name);
185 memset (e, 0, sizeof (*e));
186 e->type = STAT_DIR_TYPE_EMPTY;
188 e->value = sm->dir_vector_first_free_elt;
189 sm->dir_vector_first_free_elt = entry_index;
193 vlib_stats_set_entry_name (vlib_stats_entry_t *e, char *s)
195 u32 i, len = VLIB_STATS_MAX_NAME_SZ - 1;
197 for (i = 0; i < len; i++)
203 ASSERT (i < VLIB_STATS_MAX_NAME_SZ - 1);
208 vlib_stats_new_entry_internal (stat_directory_type_t t, u8 *name)
210 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
211 vlib_stats_shared_header_t *shared_header = sm->shared_header;
212 vlib_stats_entry_t e = { .type = t };
214 ASSERT (shared_header);
216 u32 vector_index = vlib_stats_find_entry_index ("%v", name);
217 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
224 vlib_stats_set_entry_name (&e, (char *) name);
226 vlib_stats_segment_lock ();
227 vector_index = vlib_stats_create_counter (&e);
229 shared_header->directory_vector = sm->directory_vector;
231 vlib_stats_segment_unlock ();
239 vlib_stats_add_gauge (char *fmt, ...)
245 name = va_format (0, fmt, &va);
247 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_SCALAR_INDEX, name);
251 vlib_stats_set_gauge (u32 index, u64 value)
253 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
255 ASSERT (index < vec_len (sm->directory_vector));
256 sm->directory_vector[index].value = value;
260 vlib_stats_add_timestamp (char *fmt, ...)
266 name = va_format (0, fmt, &va);
268 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_SCALAR_INDEX, name);
272 vlib_stats_set_timestamp (u32 entry_index, f64 value)
274 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
276 ASSERT (entry_index < vec_len (sm->directory_vector));
277 sm->directory_vector[entry_index].value = value;
281 vlib_stats_add_string_vector (char *fmt, ...)
287 name = va_format (0, fmt, &va);
289 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_NAME_VECTOR, name);
293 vlib_stats_set_string_vector (u32 entry_index, u32 vector_index, char *fmt,
296 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
297 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
301 oldheap = clib_mem_set_heap (sm->heap);
302 vlib_stats_segment_lock ();
304 vec_validate (e->string_vector, vector_index);
305 vec_reset_length (e->string_vector[vector_index]);
308 e->string_vector[vector_index] =
309 va_format (e->string_vector[vector_index], fmt, &va);
312 vlib_stats_segment_unlock ();
313 clib_mem_set_heap (oldheap);
317 vlib_stats_add_counter_vector (char *fmt, ...)
323 name = va_format (0, fmt, &va);
325 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE,
330 vlib_stats_add_counter_pair_vector (char *fmt, ...)
336 name = va_format (0, fmt, &va);
338 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED,
343 vlib_stats_validate_will_expand_internal (u32 entry_index, va_list *va)
345 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
346 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
350 oldheap = clib_mem_set_heap (sm->heap);
351 if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE)
353 u32 idx0 = va_arg (*va, u32);
354 u32 idx1 = va_arg (*va, u32);
355 u64 **data = e->data;
357 if (idx0 >= vec_max_len (data))
360 for (u32 i = 0; i <= idx0; i++)
361 if (idx1 >= vec_max_len (data[i]))
364 else if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED)
366 u32 idx0 = va_arg (*va, u32);
367 u32 idx1 = va_arg (*va, u32);
368 vlib_counter_t **data = e->data;
372 if (idx0 >= vec_max_len (data))
375 for (u32 i = 0; i <= idx0; i++)
376 if (idx1 >= vec_max_len (data[i]))
384 clib_mem_set_heap (oldheap);
389 vlib_stats_validate_will_expand (u32 entry_index, ...)
394 va_start (va, entry_index);
395 rv = vlib_stats_validate_will_expand_internal (entry_index, &va);
401 vlib_stats_validate (u32 entry_index, ...)
403 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
404 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
409 va_start (va, entry_index);
410 will_expand = vlib_stats_validate_will_expand_internal (entry_index, &va);
414 vlib_stats_segment_lock ();
416 oldheap = clib_mem_set_heap (sm->heap);
418 va_start (va, entry_index);
420 if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE)
422 u32 idx0 = va_arg (va, u32);
423 u32 idx1 = va_arg (va, u32);
424 u64 **data = e->data;
426 vec_validate_aligned (data, idx0, CLIB_CACHE_LINE_BYTES);
428 for (u32 i = 0; i <= idx0; i++)
429 vec_validate_aligned (data[i], idx1, CLIB_CACHE_LINE_BYTES);
432 else if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED)
434 u32 idx0 = va_arg (va, u32);
435 u32 idx1 = va_arg (va, u32);
436 vlib_counter_t **data = e->data;
438 vec_validate_aligned (data, idx0, CLIB_CACHE_LINE_BYTES);
440 for (u32 i = 0; i <= idx0; i++)
441 vec_validate_aligned (data[i], idx1, CLIB_CACHE_LINE_BYTES);
449 clib_mem_set_heap (oldheap);
452 vlib_stats_segment_unlock ();
456 vlib_stats_add_symlink (u32 entry_index, u32 vector_index, char *fmt, ...)
458 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
459 vlib_stats_shared_header_t *shared_header = sm->shared_header;
460 vlib_stats_entry_t e;
464 ASSERT (shared_header);
465 ASSERT (entry_index < vec_len (sm->directory_vector));
468 name = va_format (0, fmt, &va);
471 if (vlib_stats_find_entry_index ("%v", name) == STAT_SEGMENT_INDEX_INVALID)
474 vlib_stats_set_entry_name (&e, (char *) name);
475 e.type = STAT_DIR_TYPE_SYMLINK;
476 e.index1 = entry_index;
477 e.index2 = vector_index;
478 vector_index = vlib_stats_create_counter (&e);
480 /* Warn clients to refresh any pointers they might be holding */
481 shared_header->directory_vector = sm->directory_vector;
491 vlib_stats_rename_symlink (u64 entry_index, char *fmt, ...)
493 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
494 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
498 hash_unset_str_key_free (&sm->directory_vector_by_name, e->name);
501 new_name = va_format (0, fmt, &va);
504 vec_add1 (new_name, 0);
505 vlib_stats_set_entry_name (e, (char *) new_name);
506 hash_set_str_key_alloc (&sm->directory_vector_by_name, e->name, entry_index);
511 vlib_stats_get_segment_update_rate (void)
513 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
514 return sm->update_interval;
518 vlib_stats_register_collector_fn (vlib_stats_collector_reg_t *reg)
520 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
521 vlib_stats_collector_t *c;
523 ASSERT (reg->entry_index != ~0);
525 pool_get_zero (sm->collectors, c);
526 c->fn = reg->collect_fn;
527 c->entry_index = reg->entry_index;
528 c->vector_index = reg->vector_index;
529 c->private_data = reg->private_data;