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 ();
112 oldheap = clib_mem_set_heap (sm->heap);
113 vec_foreach_index_backwards (i, sm->directory_vector)
114 if (sm->directory_vector[i].type == STAT_DIR_TYPE_EMPTY)
120 index = index == ~0 ? vec_len (sm->directory_vector) : index;
122 vec_validate (sm->directory_vector, index);
123 sm->directory_vector[index] = *e;
125 clib_mem_set_heap (oldheap);
126 hash_set_str_key_alloc (&sm->directory_vector_by_name, e->name, index);
132 vlib_stats_remove_entry (u32 entry_index)
134 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
135 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
141 if (entry_index >= vec_len (sm->directory_vector))
144 oldheap = clib_mem_set_heap (sm->heap);
146 vlib_stats_segment_lock ();
150 case STAT_DIR_TYPE_NAME_VECTOR:
151 for (i = 0; i < vec_len (e->string_vector); i++)
152 vec_free (e->string_vector[i]);
153 vec_free (e->string_vector);
156 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
159 for (i = 0; i < vec_len (c); i++)
164 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
167 for (i = 0; i < vec_len (vc); i++)
172 case STAT_DIR_TYPE_SCALAR_INDEX:
173 case STAT_DIR_TYPE_SYMLINK:
179 vlib_stats_segment_unlock ();
181 clib_mem_set_heap (oldheap);
182 hash_unset_str_key_free (&sm->directory_vector_by_name, e->name);
184 memset (e, 0, sizeof (*e));
185 e->type = STAT_DIR_TYPE_EMPTY;
189 vlib_stats_set_entry_name (vlib_stats_entry_t *e, char *s)
191 u32 i, len = VLIB_STATS_MAX_NAME_SZ - 1;
193 for (i = 0; i < len; i++)
199 ASSERT (i < VLIB_STATS_MAX_NAME_SZ - 1);
204 vlib_stats_new_entry_internal (stat_directory_type_t t, u8 *name)
206 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
207 vlib_stats_shared_header_t *shared_header = sm->shared_header;
208 vlib_stats_entry_t e = { .type = t };
210 ASSERT (shared_header);
212 u32 vector_index = vlib_stats_find_entry_index ("%v", name);
213 if (vector_index != STAT_SEGMENT_INDEX_INVALID) /* Already registered */
220 vlib_stats_set_entry_name (&e, (char *) name);
222 vlib_stats_segment_lock ();
223 vector_index = vlib_stats_create_counter (&e);
225 shared_header->directory_vector = sm->directory_vector;
227 vlib_stats_segment_unlock ();
235 vlib_stats_add_gauge (char *fmt, ...)
241 name = va_format (0, fmt, &va);
243 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_SCALAR_INDEX, name);
247 vlib_stats_set_gauge (u32 index, u64 value)
249 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
251 ASSERT (index < vec_len (sm->directory_vector));
252 sm->directory_vector[index].value = value;
256 vlib_stats_add_timestamp (char *fmt, ...)
262 name = va_format (0, fmt, &va);
264 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_SCALAR_INDEX, name);
268 vlib_stats_set_timestamp (u32 entry_index, f64 value)
270 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
272 ASSERT (entry_index < vec_len (sm->directory_vector));
273 sm->directory_vector[entry_index].value = value;
277 vlib_stats_add_string_vector (char *fmt, ...)
283 name = va_format (0, fmt, &va);
285 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_NAME_VECTOR, name);
289 vlib_stats_set_string_vector (u32 entry_index, u32 vector_index, char *fmt,
292 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
293 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
297 oldheap = clib_mem_set_heap (sm->heap);
298 vlib_stats_segment_lock ();
300 vec_validate (e->string_vector, vector_index);
301 vec_reset_length (e->string_vector[vector_index]);
304 e->string_vector[vector_index] =
305 va_format (e->string_vector[vector_index], fmt, &va);
308 vlib_stats_segment_unlock ();
309 clib_mem_set_heap (oldheap);
313 vlib_stats_add_counter_vector (char *fmt, ...)
319 name = va_format (0, fmt, &va);
321 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE,
326 vlib_stats_add_counter_pair_vector (char *fmt, ...)
332 name = va_format (0, fmt, &va);
334 return vlib_stats_new_entry_internal (STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED,
339 vlib_stats_validate_will_expand_internal (u32 entry_index, va_list *va)
341 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
342 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
346 oldheap = clib_mem_set_heap (sm->heap);
347 if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE)
349 u32 idx0 = va_arg (*va, u32);
350 u32 idx1 = va_arg (*va, u32);
351 u64 **data = e->data;
353 if (idx0 >= vec_max_len (data))
356 for (u32 i = 0; i <= idx0; i++)
357 if (idx1 >= vec_max_len (data[i]))
360 else if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED)
362 u32 idx0 = va_arg (*va, u32);
363 u32 idx1 = va_arg (*va, u32);
364 vlib_counter_t **data = e->data;
368 if (idx0 >= vec_max_len (data))
371 for (u32 i = 0; i <= idx0; i++)
372 if (idx1 >= vec_max_len (data[i]))
380 clib_mem_set_heap (oldheap);
385 vlib_stats_validate_will_expand (u32 entry_index, ...)
390 va_start (va, entry_index);
391 rv = vlib_stats_validate_will_expand_internal (entry_index, &va);
397 vlib_stats_validate (u32 entry_index, ...)
399 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
400 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
405 va_start (va, entry_index);
406 will_expand = vlib_stats_validate_will_expand_internal (entry_index, &va);
410 vlib_stats_segment_lock ();
412 oldheap = clib_mem_set_heap (sm->heap);
414 va_start (va, entry_index);
416 if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE)
418 u32 idx0 = va_arg (va, u32);
419 u32 idx1 = va_arg (va, u32);
420 u64 **data = e->data;
422 vec_validate_aligned (data, idx0, CLIB_CACHE_LINE_BYTES);
424 for (u32 i = 0; i <= idx0; i++)
425 vec_validate_aligned (data[i], idx1, CLIB_CACHE_LINE_BYTES);
428 else if (e->type == STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED)
430 u32 idx0 = va_arg (va, u32);
431 u32 idx1 = va_arg (va, u32);
432 vlib_counter_t **data = e->data;
434 vec_validate_aligned (data, idx0, CLIB_CACHE_LINE_BYTES);
436 for (u32 i = 0; i <= idx0; i++)
437 vec_validate_aligned (data[i], idx1, CLIB_CACHE_LINE_BYTES);
445 clib_mem_set_heap (oldheap);
448 vlib_stats_segment_unlock ();
452 vlib_stats_add_symlink (u32 entry_index, u32 vector_index, char *fmt, ...)
454 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
455 vlib_stats_shared_header_t *shared_header = sm->shared_header;
456 vlib_stats_entry_t e;
460 ASSERT (shared_header);
461 ASSERT (entry_index < vec_len (sm->directory_vector));
464 name = va_format (0, fmt, &va);
467 if (vlib_stats_find_entry_index ("%v", name) == STAT_SEGMENT_INDEX_INVALID)
470 vlib_stats_set_entry_name (&e, (char *) name);
471 e.type = STAT_DIR_TYPE_SYMLINK;
472 e.index1 = entry_index;
473 e.index2 = vector_index;
474 vector_index = vlib_stats_create_counter (&e);
476 /* Warn clients to refresh any pointers they might be holding */
477 shared_header->directory_vector = sm->directory_vector;
487 vlib_stats_rename_symlink (u64 entry_index, char *fmt, ...)
489 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
490 vlib_stats_entry_t *e = vlib_stats_get_entry (sm, entry_index);
494 hash_unset_str_key_free (&sm->directory_vector_by_name, e->name);
497 new_name = va_format (0, fmt, &va);
500 vec_add1 (new_name, 0);
501 vlib_stats_set_entry_name (e, (char *) new_name);
502 hash_set_str_key_alloc (&sm->directory_vector_by_name, e->name, entry_index);
507 vlib_stats_get_segment_update_rate (void)
509 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
510 return sm->update_interval;
514 vlib_stats_register_collector_fn (vlib_stats_collector_reg_t *reg)
516 vlib_stats_segment_t *sm = vlib_stats_get_segment ();
517 vlib_stats_collector_t *c;
519 ASSERT (reg->entry_index != ~0);
521 pool_get_zero (sm->collectors, c);
522 c->fn = reg->collect_fn;
523 c->entry_index = reg->entry_index;
524 c->vector_index = reg->vector_index;
525 c->private_data = reg->private_data;