lib/librte_metrics/rte_metrics.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #include <string.h>
   6 #include <sys/queue.h>
   7
   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>
  15
  16 #define RTE_METRICS_MAX_METRICS 256
  17 #define RTE_METRICS_MEMZONE_NAME "RTE_METRICS"
  18
  19 /**
  20  * Internal stats metadata and value entry.
  21  *
  22  * @internal
  23  */
  24 struct rte_metrics_meta_s {
  25         /** Name of metric */
  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;
  35 };
  36
  37 /**
  38  * Internal stats info structure.
  39  *
  40  * @internal
  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.
  44  */
  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.
  48          */
  49         uint16_t idx_last_set;
  50         /**   Number of metrics. */
  51         uint16_t cnt_stats;
  52         /** Metric data memory block. */
  53         struct rte_metrics_meta_s metadata[RTE_METRICS_MAX_METRICS];
  54         /** Metric data access lock */
  55         rte_spinlock_t lock;
  56 };
  57
  58 void
  59 rte_metrics_init(int socket_id)
  60 {
  61         struct rte_metrics_data_s *stats;
  62         const struct rte_memzone *memzone;
  63
  64         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
  65                 return;
  66
  67         memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
  68         if (memzone != NULL)
  69                 return;
  70         memzone = rte_memzone_reserve(RTE_METRICS_MEMZONE_NAME,
  71                 sizeof(struct rte_metrics_data_s), socket_id, 0);
  72         if (memzone == NULL)
  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);
  77 }
  78
  79 int
  80 rte_metrics_reg_name(const char *name)
  81 {
  82         const char * const list_names[] = {name};
  83
  84         return rte_metrics_reg_names(list_names, 1);
  85 }
  86
  87 int
  88 rte_metrics_reg_names(const char * const *names, uint16_t cnt_names)
  89 {
  90         struct rte_metrics_meta_s *entry = NULL;
  91         struct rte_metrics_data_s *stats;
  92         const struct rte_memzone *memzone;
  93         uint16_t idx_name;
  94         uint16_t idx_base;
  95
  96         /* Some sanity checks */
  97         if (cnt_names < 1 || names == NULL)
  98                 return -EINVAL;
  99
 100         memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
 101         if (memzone == NULL)
 102                 return -EIO;
 103         stats = memzone->addr;
 104
 105         if (stats->cnt_stats + cnt_names >= RTE_METRICS_MAX_METRICS)
 106                 return -ENOMEM;
 107
 108         rte_spinlock_lock(&stats->lock);
 109
 110         /* Overwritten later if this is actually first set.. */
 111         stats->metadata[stats->idx_last_set].idx_next_set = stats->cnt_stats;
 112
 113         stats->idx_last_set = idx_base = stats->cnt_stats;
 114
 115         for (idx_name = 0; idx_name < cnt_names; idx_name++) {
 116                 entry = &stats->metadata[idx_name + stats->cnt_stats];
 117                 strlcpy(entry->name, names[idx_name], RTE_METRICS_MAX_NAME_LEN);
 118                 memset(entry->value, 0, sizeof(entry->value));
 119                 entry->idx_next_stat = idx_name + stats->cnt_stats + 1;
 120         }
 121         entry->idx_next_stat = 0;
 122         entry->idx_next_set = 0;
 123         stats->cnt_stats += cnt_names;
 124
 125         rte_spinlock_unlock(&stats->lock);
 126
 127         return idx_base;
 128 }
 129
 130 int
 131 rte_metrics_update_value(int port_id, uint16_t key, const uint64_t value)
 132 {
 133         return rte_metrics_update_values(port_id, key, &value, 1);
 134 }
 135
 136 int
 137 rte_metrics_update_values(int port_id,
 138         uint16_t key,
 139         const uint64_t *values,
 140         uint32_t count)
 141 {
 142         struct rte_metrics_meta_s *entry;
 143         struct rte_metrics_data_s *stats;
 144         const struct rte_memzone *memzone;
 145         uint16_t idx_metric;
 146         uint16_t idx_value;
 147         uint16_t cnt_setsize;
 148
 149         if (port_id != RTE_METRICS_GLOBAL &&
 150                         (port_id < 0 || port_id >= RTE_MAX_ETHPORTS))
 151                 return -EINVAL;
 152
 153         if (values == NULL)
 154                 return -EINVAL;
 155
 156         memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
 157         if (memzone == NULL)
 158                 return -EIO;
 159         stats = memzone->addr;
 160
 161         rte_spinlock_lock(&stats->lock);
 162
 163         if (key >= stats->cnt_stats) {
 164                 rte_spinlock_unlock(&stats->lock);
 165                 return -EINVAL;
 166         }
 167         idx_metric = key;
 168         cnt_setsize = 1;
 169         while (idx_metric < stats->cnt_stats) {
 170                 entry = &stats->metadata[idx_metric];
 171                 if (entry->idx_next_stat == 0)
 172                         break;
 173                 cnt_setsize++;
 174                 idx_metric++;
 175         }
 176         /* Check update does not cross set border */
 177         if (count > cnt_setsize) {
 178                 rte_spinlock_unlock(&stats->lock);
 179                 return -ERANGE;
 180         }
 181
 182         if (port_id == RTE_METRICS_GLOBAL)
 183                 for (idx_value = 0; idx_value < count; idx_value++) {
 184                         idx_metric = key + idx_value;
 185                         stats->metadata[idx_metric].global_value =
 186                                 values[idx_value];
 187                 }
 188         else
 189                 for (idx_value = 0; idx_value < count; idx_value++) {
 190                         idx_metric = key + idx_value;
 191                         stats->metadata[idx_metric].value[port_id] =
 192                                 values[idx_value];
 193                 }
 194         rte_spinlock_unlock(&stats->lock);
 195         return 0;
 196 }
 197
 198 int
 199 rte_metrics_get_names(struct rte_metric_name *names,
 200         uint16_t capacity)
 201 {
 202         struct rte_metrics_data_s *stats;
 203         const struct rte_memzone *memzone;
 204         uint16_t idx_name;
 205         int return_value;
 206
 207         memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
 208         if (memzone == NULL)
 209                 return -EIO;
 210
 211         stats = memzone->addr;
 212         rte_spinlock_lock(&stats->lock);
 213         if (names != NULL) {
 214                 if (capacity < stats->cnt_stats) {
 215                         return_value = stats->cnt_stats;
 216                         rte_spinlock_unlock(&stats->lock);
 217                         return return_value;
 218                 }
 219                 for (idx_name = 0; idx_name < stats->cnt_stats; idx_name++)
 220                         strlcpy(names[idx_name].name,
 221                                 stats->metadata[idx_name].name,
 222                                 RTE_METRICS_MAX_NAME_LEN);
 223         }
 224         return_value = stats->cnt_stats;
 225         rte_spinlock_unlock(&stats->lock);
 226         return return_value;
 227 }
 228
 229 int
 230 rte_metrics_get_values(int port_id,
 231         struct rte_metric_value *values,
 232         uint16_t capacity)
 233 {
 234         struct rte_metrics_meta_s *entry;
 235         struct rte_metrics_data_s *stats;
 236         const struct rte_memzone *memzone;
 237         uint16_t idx_name;
 238         int return_value;
 239
 240         if (port_id != RTE_METRICS_GLOBAL &&
 241                         (port_id < 0 || port_id >= RTE_MAX_ETHPORTS))
 242                 return -EINVAL;
 243
 244         memzone = rte_memzone_lookup(RTE_METRICS_MEMZONE_NAME);
 245         if (memzone == NULL)
 246                 return -EIO;
 247
 248         stats = memzone->addr;
 249         rte_spinlock_lock(&stats->lock);
 250
 251         if (values != NULL) {
 252                 if (capacity < stats->cnt_stats) {
 253                         return_value = stats->cnt_stats;
 254                         rte_spinlock_unlock(&stats->lock);
 255                         return return_value;
 256                 }
 257                 if (port_id == RTE_METRICS_GLOBAL)
 258                         for (idx_name = 0;
 259                                         idx_name < stats->cnt_stats;
 260                                         idx_name++) {
 261                                 entry = &stats->metadata[idx_name];
 262                                 values[idx_name].key = idx_name;
 263                                 values[idx_name].value = entry->global_value;
 264                         }
 265                 else
 266                         for (idx_name = 0;
 267                                         idx_name < stats->cnt_stats;
 268                                         idx_name++) {
 269                                 entry = &stats->metadata[idx_name];
 270                                 values[idx_name].key = idx_name;
 271                                 values[idx_name].value = entry->value[port_id];
 272                         }
 273         }
 274         return_value = stats->cnt_stats;
 275         rte_spinlock_unlock(&stats->lock);
 276         return return_value;
 277 }