1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
8 #include <rte_common.h>
9 #include <rte_string_fns.h>
10 #include <rte_malloc.h>
11 #include <rte_metrics.h>
12 #include <rte_lcore.h>
13 #include <rte_memzone.h>
14 #include <rte_spinlock.h>
16 #define RTE_METRICS_MAX_METRICS 256
17 #define RTE_METRICS_MEMZONE_NAME "RTE_METRICS"
20 * Internal stats metadata and value entry.
24 struct rte_metrics_meta_s {
26 char name[RTE_METRICS_MAX_NAME_LEN];
27 /** Current value for metric */
28 uint64_t value[RTE_MAX_ETHPORTS];
29 /** Used for global metrics */
30 uint64_t global_value;
31 /** Index of next root element (zero for none) */
32 uint16_t idx_next_set;
33 /** Index of next metric in set (zero for none) */
34 uint16_t idx_next_stat;
38 * Internal stats info structure.
41 * Offsets into metadata are used instead of pointers because ASLR
42 * means that having the same physical addresses in different
43 * processes is not guaranteed.
45 struct rte_metrics_data_s {
46 /** Index of last metadata entry with valid data.
47 * This value is not valid if cnt_stats is zero.
49 uint16_t idx_last_set;
50 /** Number of metrics. */
52 /** Metric data memory block. */
53 struct rte_metrics_meta_s metadata[RTE_METRICS_MAX_METRICS];
54 /** Metric data access lock */
59 rte_metrics_init(int socket_id)
61 struct rte_metrics_data_s *stats;
62 const struct rte_memzone *memzone;
64 if (rte_eal_process_type() != RTE_PROC_PRIMARY)
67 memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
70 memzone = rte_memzone_reserve(RTE_METRICS_MEMZONE_NAME,
71 sizeof(struct rte_metrics_data_s), socket_id, 0);
73 rte_exit(EXIT_FAILURE, "Unable to allocate stats memzone\n");
74 stats = memzone->addr;
75 memset(stats, 0, sizeof(struct rte_metrics_data_s));
76 rte_spinlock_init(&stats->lock);
80 rte_metrics_deinit(void)
82 struct rte_metrics_data_s *stats;
83 const struct rte_memzone *memzone;
85 if (rte_eal_process_type() != RTE_PROC_PRIMARY)
88 memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
92 stats = memzone->addr;
93 memset(stats, 0, sizeof(struct rte_metrics_data_s));
95 return rte_memzone_free(memzone);
100 rte_metrics_reg_name(const char *name)
102 const char * const list_names[] = {name};
104 return rte_metrics_reg_names(list_names, 1);
108 rte_metrics_reg_names(const char * const *names, uint16_t cnt_names)
110 struct rte_metrics_meta_s *entry = NULL;
111 struct rte_metrics_data_s *stats;
112 const struct rte_memzone *memzone;
116 /* Some sanity checks */
117 if (cnt_names < 1 || names == NULL)
119 for (idx_name = 0; idx_name < cnt_names; idx_name++)
120 if (names[idx_name] == NULL)
123 memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
126 stats = memzone->addr;
128 if (stats->cnt_stats + cnt_names >= RTE_METRICS_MAX_METRICS)
131 rte_spinlock_lock(&stats->lock);
133 /* Overwritten later if this is actually first set.. */
134 stats->metadata[stats->idx_last_set].idx_next_set = stats->cnt_stats;
136 stats->idx_last_set = idx_base = stats->cnt_stats;
138 for (idx_name = 0; idx_name < cnt_names; idx_name++) {
139 entry = &stats->metadata[idx_name + stats->cnt_stats];
140 strlcpy(entry->name, names[idx_name], RTE_METRICS_MAX_NAME_LEN);
141 memset(entry->value, 0, sizeof(entry->value));
142 entry->idx_next_stat = idx_name + stats->cnt_stats + 1;
144 entry->idx_next_stat = 0;
145 entry->idx_next_set = 0;
146 stats->cnt_stats += cnt_names;
148 rte_spinlock_unlock(&stats->lock);
154 rte_metrics_update_value(int port_id, uint16_t key, const uint64_t value)
156 return rte_metrics_update_values(port_id, key, &value, 1);
160 rte_metrics_update_values(int port_id,
162 const uint64_t *values,
165 struct rte_metrics_meta_s *entry;
166 struct rte_metrics_data_s *stats;
167 const struct rte_memzone *memzone;
170 uint16_t cnt_setsize;
172 if (port_id != RTE_METRICS_GLOBAL &&
173 (port_id < 0 || port_id >= RTE_MAX_ETHPORTS))
179 memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
182 stats = memzone->addr;
184 rte_spinlock_lock(&stats->lock);
186 if (key >= stats->cnt_stats) {
187 rte_spinlock_unlock(&stats->lock);
192 while (idx_metric < stats->cnt_stats) {
193 entry = &stats->metadata[idx_metric];
194 if (entry->idx_next_stat == 0)
199 /* Check update does not cross set border */
200 if (count > cnt_setsize) {
201 rte_spinlock_unlock(&stats->lock);
205 if (port_id == RTE_METRICS_GLOBAL)
206 for (idx_value = 0; idx_value < count; idx_value++) {
207 idx_metric = key + idx_value;
208 stats->metadata[idx_metric].global_value =
212 for (idx_value = 0; idx_value < count; idx_value++) {
213 idx_metric = key + idx_value;
214 stats->metadata[idx_metric].value[port_id] =
217 rte_spinlock_unlock(&stats->lock);
222 rte_metrics_get_names(struct rte_metric_name *names,
225 struct rte_metrics_data_s *stats;
226 const struct rte_memzone *memzone;
230 memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
234 stats = memzone->addr;
235 rte_spinlock_lock(&stats->lock);
237 if (capacity < stats->cnt_stats) {
238 return_value = stats->cnt_stats;
239 rte_spinlock_unlock(&stats->lock);
242 for (idx_name = 0; idx_name < stats->cnt_stats; idx_name++)
243 strlcpy(names[idx_name].name,
244 stats->metadata[idx_name].name,
245 RTE_METRICS_MAX_NAME_LEN);
247 return_value = stats->cnt_stats;
248 rte_spinlock_unlock(&stats->lock);
253 rte_metrics_get_values(int port_id,
254 struct rte_metric_value *values,
257 struct rte_metrics_meta_s *entry;
258 struct rte_metrics_data_s *stats;
259 const struct rte_memzone *memzone;
263 if (port_id != RTE_METRICS_GLOBAL &&
264 (port_id < 0 || port_id >= RTE_MAX_ETHPORTS))
267 memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
271 stats = memzone->addr;
272 rte_spinlock_lock(&stats->lock);
274 if (values != NULL) {
275 if (capacity < stats->cnt_stats) {
276 return_value = stats->cnt_stats;
277 rte_spinlock_unlock(&stats->lock);
280 if (port_id == RTE_METRICS_GLOBAL)
282 idx_name < stats->cnt_stats;
284 entry = &stats->metadata[idx_name];
285 values[idx_name].key = idx_name;
286 values[idx_name].value = entry->global_value;
290 idx_name < stats->cnt_stats;
292 entry = &stats->metadata[idx_name];
293 values[idx_name].key = idx_name;
294 values[idx_name].value = entry->value[port_id];
297 return_value = stats->cnt_stats;
298 rte_spinlock_unlock(&stats->lock);