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 ();
110 if (sm->dir_vector_first_free_elt != CLIB_U32_MAX)
112 index = sm->dir_vector_first_free_elt;
113 sm->dir_vector_first_free_elt = sm->directory_vector[index].index;
117 index = vec_len (sm->directory_vector);
118 vec_validate (sm->directory_vector, index);
121 sm->directory_vector[index] = *e;
123 hash_set_str_key_alloc (&sm->directory_vector_by_name, e->name, index);
129 vlib_stats_remove_entry (u32 entry_index)
131 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
132 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
138 if (entry_index >= vec_len (sm->directory_vector))
141 vlib_stats_segment_lock ();
145 case STAT_DIR_TYPE_NAME_VECTOR:
146 for (i = 0; i < vec_len (e->string_vector); i++)
147 vec_free (e->string_vector[i]);
148 vec_free (e->string_vector);
151 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
154 oldheap = clib_mem_set_heap (sm->heap);
155 for (i = 0; i < vec_len (c); i++)
158 clib_mem_set_heap (oldheap);
161 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
164 oldheap = clib_mem_set_heap (sm->heap);
165 for (i = 0; i < vec_len (vc); i++)
168 clib_mem_set_heap (oldheap);
171 case STAT_DIR_TYPE_SCALAR_INDEX:
172 case STAT_DIR_TYPE_SYMLINK:
178 vlib_stats_segment_unlock ();
180 hash_unset_str_key_free (&sm->directory_vector_by_name, e->name);
182 memset (e, 0, sizeof (*e));
183 e->type = STAT_DIR_TYPE_EMPTY;
185 e->value = sm->dir_vector_first_free_elt;
186 sm->dir_vector_first_free_elt = entry_index;
190 vlib_stats_set_entry_name (vlib_stats_entry_t *e, char *s)
192 u32 i, len = VLIB_STATS_MAX_NAME_SZ - 1;
194 for (i = 0; i < len; i++)
200 ASSERT (i < VLIB_STATS_MAX_NAME_SZ - 1);
205 vlib_stats_new_entry_internal (stat_directory_type_t t, u8 *name)
207 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
208 vlib_stats_shared_header_t *shared_header = sm->shared_header;
209 vlib_stats_entry_t e = { .type = t };
211 ASSERT (shared_header);
213 u32 vector_index = vlib_stats_find_entry_index ("%v", name);
214 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
221 vlib_stats_set_entry_name (&e, (char *) name);
223 vlib_stats_segment_lock ();
224 vector_index = vlib_stats_create_counter (&e);
226 shared_header->directory_vector = sm->directory_vector;
228 vlib_stats_segment_unlock ();
236 vlib_stats_add_gauge (char *fmt, ...)
242 name = va_format (0, fmt, &va);
244 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_SCALAR_INDEX, name);
248 vlib_stats_set_gauge (u32 index, u64 value)
250 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
252 ASSERT (index < vec_len (sm->directory_vector));
253 sm->directory_vector[index].value = value;
257 vlib_stats_add_timestamp (char *fmt, ...)
263 name = va_format (0, fmt, &va);
265 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_SCALAR_INDEX, name);
269 vlib_stats_set_timestamp (u32 entry_index, f64 value)
271 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
273 ASSERT (entry_index < vec_len (sm->directory_vector));
274 sm->directory_vector[entry_index].value = value;
277 vlib_stats_string_vector_t
278 vlib_stats_add_string_vector (char *fmt, ...)
280 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
282 vlib_stats_header_t *sh;
283 vlib_stats_string_vector_t sv;
288 name = va_format (0, fmt, &va);
291 index = vlib_stats_new_entry_internal (STAT_DIR_TYPE_NAME_VECTOR, name);
292 if (index == CLIB_U32_MAX)
295 sv = vec_new_generic (vlib_stats_string_vector_t, 0,
296 sizeof (vlib_stats_header_t), 0, sm->heap);
297 sh = vec_header (sv);
298 sh->entry_index = index;
299 sm->directory_vector[index].string_vector = sv;
304 vlib_stats_set_string_vector (vlib_stats_string_vector_t *svp,
305 u32 vector_index, char *fmt, ...)
307 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
308 vlib_stats_header_t *sh = vec_header (*svp);
309 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, sh->entry_index);
315 if (vec_len (e->string_vector) <= vector_index)
318 if (e->string_vector[vector_index] == 0)
321 vlib_stats_segment_lock ();
322 vec_free (e->string_vector[vector_index]);
323 vlib_stats_segment_unlock ();
327 vlib_stats_segment_lock ();
329 ASSERT (e->string_vector);
331 vec_validate (e->string_vector, vector_index);
332 svp[0] = e->string_vector;
334 s = e->string_vector[vector_index];
337 s = vec_new_heap (u8 *, 0, sm->heap);
339 vec_reset_length (s);
342 s = va_format (s, fmt, &va);
346 e->string_vector[vector_index] = s;
348 vlib_stats_segment_unlock ();
352 vlib_stats_free_string_vector (vlib_stats_string_vector_t *sv)
354 vlib_stats_header_t *sh = vec_header (*sv);
355 vlib_stats_remove_entry (sh->entry_index);
359 vlib_stats_add_counter_vector (char *fmt, ...)
365 name = va_format (0, fmt, &va);
367 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE,
372 vlib_stats_add_counter_pair_vector (char *fmt, ...)
378 name = va_format (0, fmt, &va);
380 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED,
385 vlib_stats_validate_will_expand_internal (u32 entry_index, va_list *va)
387 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
388 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
392 oldheap = clib_mem_set_heap (sm->heap);
393 if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE)
395 u32 idx0 = va_arg (*va, u32);
396 u32 idx1 = va_arg (*va, u32);
397 u64 **data = e->data;
399 if (idx0 >= vec_len (data))
402 for (u32 i = 0; i <= idx0; i++)
403 if (idx1 >= vec_max_len (data[i]))
406 else if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED)
408 u32 idx0 = va_arg (*va, u32);
409 u32 idx1 = va_arg (*va, u32);
410 vlib_counter_t **data = e->data;
414 if (idx0 >= vec_len (data))
417 for (u32 i = 0; i <= idx0; i++)
418 if (idx1 >= vec_max_len (data[i]))
426 clib_mem_set_heap (oldheap);
431 vlib_stats_validate_will_expand (u32 entry_index, ...)
436 va_start (va, entry_index);
437 rv = vlib_stats_validate_will_expand_internal (entry_index, &va);
443 vlib_stats_validate (u32 entry_index, ...)
445 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
446 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
451 va_start (va, entry_index);
452 will_expand = vlib_stats_validate_will_expand_internal (entry_index, &va);
456 vlib_stats_segment_lock ();
458 oldheap = clib_mem_set_heap (sm->heap);
460 va_start (va, entry_index);
462 if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE)
464 u32 idx0 = va_arg (va, u32);
465 u32 idx1 = va_arg (va, u32);
466 u64 **data = e->data;
468 vec_validate_aligned (data, idx0, CLIB_CACHE_LINE_BYTES);
470 for (u32 i = 0; i <= idx0; i++)
471 vec_validate_aligned (data[i], idx1, CLIB_CACHE_LINE_BYTES);
474 else if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED)
476 u32 idx0 = va_arg (va, u32);
477 u32 idx1 = va_arg (va, u32);
478 vlib_counter_t **data = e->data;
480 vec_validate_aligned (data, idx0, CLIB_CACHE_LINE_BYTES);
482 for (u32 i = 0; i <= idx0; i++)
483 vec_validate_aligned (data[i], idx1, CLIB_CACHE_LINE_BYTES);
491 clib_mem_set_heap (oldheap);
494 vlib_stats_segment_unlock ();
498 vlib_stats_add_symlink (u32 entry_index, u32 vector_index, char *fmt, ...)
500 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
501 vlib_stats_shared_header_t *shared_header = sm->shared_header;
502 vlib_stats_entry_t e;
506 ASSERT (shared_header);
507 ASSERT (entry_index < vec_len (sm->directory_vector));
510 name = va_format (0, fmt, &va);
513 if (vlib_stats_find_entry_index ("%v", name) == STAT_SEGMENT_INDEX_INVALID)
516 vlib_stats_set_entry_name (&e, (char *) name);
517 e.type = STAT_DIR_TYPE_SYMLINK;
518 e.index1 = entry_index;
519 e.index2 = vector_index;
520 vector_index = vlib_stats_create_counter (&e);
522 /* Warn clients to refresh any pointers they might be holding */
523 shared_header->directory_vector = sm->directory_vector;
533 vlib_stats_rename_symlink (u64 entry_index, char *fmt, ...)
535 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
536 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
540 hash_unset_str_key_free (&sm->directory_vector_by_name, e->name);
543 new_name = va_format (0, fmt, &va);
546 vec_add1 (new_name, 0);
547 vlib_stats_set_entry_name (e, (char *) new_name);
548 hash_set_str_key_alloc (&sm->directory_vector_by_name, e->name, entry_index);
553 vlib_stats_get_segment_update_rate (void)
555 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
556 return sm->update_interval;
560 vlib_stats_register_collector_fn (vlib_stats_collector_reg_t *reg)
562 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
563 vlib_stats_collector_t *c;
565 ASSERT (reg->entry_index != ~0);
567 pool_get_zero (sm->collectors, c);
568 c->fn = reg->collect_fn;
569 c->entry_index = reg->entry_index;
570 c->vector_index = reg->vector_index;
571 c->private_data = reg->private_data;