Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file stat_item.c |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 2 | * utility routines for keeping statistical values */ |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 3 | /* |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 4 | * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 5 | * (C) 2015 by sysmocom - s.f.m.c. GmbH |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 6 | * |
| 7 | * All Rights Reserved |
| 8 | * |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 9 | * SPDX-License-Identifier: GPL-2.0+ |
| 10 | * |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 11 | * This program is free software; you can redistribute it and/or modify |
| 12 | * it under the terms of the GNU General Public License as published by |
| 13 | * the Free Software Foundation; either version 2 of the License, or |
| 14 | * (at your option) any later version. |
| 15 | * |
| 16 | * This program is distributed in the hope that it will be useful, |
| 17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 19 | * GNU General Public License for more details. |
| 20 | * |
| 21 | * You should have received a copy of the GNU General Public License along |
| 22 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 23 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 24 | * |
| 25 | */ |
| 26 | |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 27 | /*! \addtogroup osmo_stat_item |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 28 | * @{ |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 29 | * |
| 30 | * This osmo_stat_item module adds instrumentation capabilities to |
| 31 | * gather measurement and statistical values in a similar fashion to |
| 32 | * what we have as \ref osmo_counter_group. |
| 33 | * |
| 34 | * As opposed to counters, osmo_stat_item do not increment but consist |
| 35 | * of a configurable-sized FIFO, which can store not only the current |
| 36 | * (most recent) value, but also historic values. |
| 37 | * |
| 38 | * The only supported value type is an int32_t. |
| 39 | * |
Oliver Smith | 6140194 | 2021-03-26 10:18:37 +0100 | [diff] [blame] | 40 | * Getting values from osmo_stat_item is usually done at a high level |
| 41 | * through the stats API (stats.c). It uses item->stats_next_id to |
| 42 | * store what has been sent to all enabled reporters. It is also |
| 43 | * possible to read from osmo_stat_item directly, without modifying |
| 44 | * its state, by storing next_id outside of osmo_stat_item. |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 45 | * |
| 46 | * Each value stored in the FIFO of an osmo_stat_item has an associated |
Oliver Smith | 6140194 | 2021-03-26 10:18:37 +0100 | [diff] [blame] | 47 | * value_id. The value_id is increased with each value, so (until the |
| 48 | * counter wraps) more recent values will have higher values. |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 49 | * |
| 50 | * When a new value is set, the oldest value in the FIFO gets silently |
| 51 | * overwritten. Lost values are skipped when getting values from the |
| 52 | * item. |
| 53 | * |
| 54 | */ |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 55 | |
Oliver Smith | 43686da | 2021-03-26 14:33:21 +0100 | [diff] [blame] | 56 | /* Struct overview: |
| 57 | * Each osmo_stat_item is attached to an osmo_stat_item_group, which is |
| 58 | * attached to the global osmo_stat_item_groups list. |
| 59 | * |
| 60 | * osmo_stat_item_groups |
| 61 | * / \ |
| 62 | * group1 group2 |
| 63 | * / \ |
| 64 | * item1 item2 |
| 65 | * | |
| 66 | * values |
| 67 | * / \ |
| 68 | * 1 2 |
| 69 | * |-id |-id |
| 70 | * '-value '-value |
| 71 | */ |
| 72 | |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 73 | #include <stdint.h> |
| 74 | #include <string.h> |
| 75 | |
| 76 | #include <osmocom/core/utils.h> |
| 77 | #include <osmocom/core/linuxlist.h> |
Oliver Smith | 6140194 | 2021-03-26 10:18:37 +0100 | [diff] [blame] | 78 | #include <osmocom/core/logging.h> |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 79 | #include <osmocom/core/talloc.h> |
| 80 | #include <osmocom/core/timer.h> |
| 81 | #include <osmocom/core/stat_item.h> |
| 82 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 83 | /*! global list of stat_item groups */ |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 84 | static LLIST_HEAD(osmo_stat_item_groups); |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 85 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 86 | /*! talloc context from which we allocate */ |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 87 | static void *tall_stat_item_ctx; |
| 88 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 89 | /*! Allocate a new group of counters according to description. |
| 90 | * Allocate a group of stat items described in \a desc from talloc context \a ctx, |
| 91 | * giving the new group the index \a idx. |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 92 | * \param[in] ctx \ref talloc context |
| 93 | * \param[in] desc Statistics item group description |
| 94 | * \param[in] idx Index of new stat item group |
| 95 | */ |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 96 | struct osmo_stat_item_group *osmo_stat_item_group_alloc(void *ctx, |
| 97 | const struct osmo_stat_item_group_desc *desc, |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 98 | unsigned int idx) |
| 99 | { |
| 100 | unsigned int group_size; |
Harald Welte | b32a194 | 2015-11-20 10:22:14 +0100 | [diff] [blame] | 101 | unsigned long items_size = 0; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 102 | unsigned int item_idx; |
| 103 | void *items; |
| 104 | |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 105 | struct osmo_stat_item_group *group; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 106 | |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 107 | group_size = sizeof(struct osmo_stat_item_group) + |
| 108 | desc->num_items * sizeof(struct osmo_stat_item *); |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 109 | |
| 110 | if (!ctx) |
| 111 | ctx = tall_stat_item_ctx; |
| 112 | |
| 113 | group = talloc_zero_size(ctx, group_size); |
| 114 | if (!group) |
| 115 | return NULL; |
| 116 | |
| 117 | group->desc = desc; |
| 118 | group->idx = idx; |
| 119 | |
| 120 | /* Get combined size of all items */ |
| 121 | for (item_idx = 0; item_idx < desc->num_items; item_idx++) { |
| 122 | unsigned int size; |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 123 | size = sizeof(struct osmo_stat_item) + |
| 124 | sizeof(struct osmo_stat_item_value) * |
Jacob Erlbeck | b27b352 | 2015-10-12 18:47:09 +0200 | [diff] [blame] | 125 | desc->item_desc[item_idx].num_values; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 126 | /* Align to pointer size */ |
| 127 | size = (size + sizeof(void *) - 1) & ~(sizeof(void *) - 1); |
| 128 | |
| 129 | /* Store offsets into the item array */ |
| 130 | group->items[item_idx] = (void *)items_size; |
| 131 | |
| 132 | items_size += size; |
| 133 | } |
| 134 | |
| 135 | items = talloc_zero_size(group, items_size); |
| 136 | if (!items) { |
| 137 | talloc_free(group); |
| 138 | return NULL; |
| 139 | } |
| 140 | |
| 141 | /* Update item pointers */ |
| 142 | for (item_idx = 0; item_idx < desc->num_items; item_idx++) { |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 143 | struct osmo_stat_item *item = (struct osmo_stat_item *) |
Harald Welte | b32a194 | 2015-11-20 10:22:14 +0100 | [diff] [blame] | 144 | ((uint8_t *)items + (unsigned long)group->items[item_idx]); |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 145 | unsigned int i; |
| 146 | |
| 147 | group->items[item_idx] = item; |
| 148 | item->last_offs = desc->item_desc[item_idx].num_values - 1; |
Oliver Smith | 6140194 | 2021-03-26 10:18:37 +0100 | [diff] [blame] | 149 | item->stats_next_id = 1; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 150 | item->desc = &desc->item_desc[item_idx]; |
| 151 | |
Jacob Erlbeck | b27b352 | 2015-10-12 18:47:09 +0200 | [diff] [blame] | 152 | for (i = 0; i <= item->last_offs; i++) { |
| 153 | item->values[i].value = desc->item_desc[item_idx].default_value; |
Jacob Erlbeck | ac4ed17 | 2015-12-08 10:29:16 +0100 | [diff] [blame] | 154 | item->values[i].id = OSMO_STAT_ITEM_NOVALUE_ID; |
Jacob Erlbeck | b27b352 | 2015-10-12 18:47:09 +0200 | [diff] [blame] | 155 | } |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 156 | } |
| 157 | |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 158 | llist_add(&group->list, &osmo_stat_item_groups); |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 159 | |
| 160 | return group; |
| 161 | } |
| 162 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 163 | /*! Free the memory for the specified group of stat items */ |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 164 | void osmo_stat_item_group_free(struct osmo_stat_item_group *grp) |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 165 | { |
| 166 | llist_del(&grp->list); |
| 167 | talloc_free(grp); |
| 168 | } |
| 169 | |
Pau Espin Pedrol | 5fe3de5 | 2021-05-31 13:39:07 +0200 | [diff] [blame] | 170 | /*! Get statistics item from group, identified by index idx |
| 171 | * \param[in] grp Rate counter group |
| 172 | * \param[in] idx Index of the counter to retrieve |
| 173 | * \returns rate counter requested |
| 174 | */ |
| 175 | struct osmo_stat_item *osmo_stat_item_group_get_item(struct osmo_stat_item_group *grp, unsigned int idx) |
| 176 | { |
| 177 | return grp->items[idx]; |
| 178 | } |
| 179 | |
Alexander Couzens | cc72cc4 | 2019-04-27 23:19:55 +0200 | [diff] [blame] | 180 | /*! Increase the stat_item to the given value. |
| 181 | * This function adds a new value for the given stat_item at the end of |
| 182 | * the FIFO. |
| 183 | * \param[in] item The stat_item whose \a value we want to set |
| 184 | * \param[in] value The numeric value we want to store at end of FIFO |
| 185 | */ |
| 186 | void osmo_stat_item_inc(struct osmo_stat_item *item, int32_t value) |
| 187 | { |
| 188 | int32_t oldvalue = item->values[item->last_offs].value; |
| 189 | osmo_stat_item_set(item, oldvalue + value); |
| 190 | } |
| 191 | |
| 192 | /*! Descrease the stat_item to the given value. |
| 193 | * This function adds a new value for the given stat_item at the end of |
| 194 | * the FIFO. |
| 195 | * \param[in] item The stat_item whose \a value we want to set |
| 196 | * \param[in] value The numeric value we want to store at end of FIFO |
| 197 | */ |
| 198 | void osmo_stat_item_dec(struct osmo_stat_item *item, int32_t value) |
| 199 | { |
| 200 | int32_t oldvalue = item->values[item->last_offs].value; |
| 201 | osmo_stat_item_set(item, oldvalue - value); |
| 202 | } |
| 203 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 204 | /*! Set the a given stat_item to the given value. |
| 205 | * This function adds a new value for the given stat_item at the end of |
| 206 | * the FIFO. |
| 207 | * \param[in] item The stat_item whose \a value we want to set |
| 208 | * \param[in] value The numeric value we want to store at end of FIFO |
| 209 | */ |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 210 | void osmo_stat_item_set(struct osmo_stat_item *item, int32_t value) |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 211 | { |
Oliver Smith | 6140194 | 2021-03-26 10:18:37 +0100 | [diff] [blame] | 212 | int32_t id = item->values[item->last_offs].id + 1; |
| 213 | if (id == OSMO_STAT_ITEM_NOVALUE_ID) |
| 214 | id++; |
| 215 | |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 216 | item->last_offs += 1; |
| 217 | if (item->last_offs >= item->desc->num_values) |
| 218 | item->last_offs = 0; |
| 219 | |
Jacob Erlbeck | b27b352 | 2015-10-12 18:47:09 +0200 | [diff] [blame] | 220 | item->values[item->last_offs].value = value; |
Oliver Smith | 6140194 | 2021-03-26 10:18:37 +0100 | [diff] [blame] | 221 | item->values[item->last_offs].id = id; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 222 | } |
| 223 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 224 | /*! Retrieve the next value from the osmo_stat_item object. |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 225 | * If a new value has been set, it is returned. The next_id is used to decide |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 226 | * which value to return. |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 227 | * On success, *next_id is updated to refer to the next unread value. If |
| 228 | * values have been missed due to FIFO overflow, *next_id is incremented by |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 229 | * (1 + num_lost). |
| 230 | * This way, the osmo_stat_item object can be kept stateless from the reader's |
| 231 | * perspective and therefore be used by several backends simultaneously. |
| 232 | * |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 233 | * \param val the osmo_stat_item object |
| 234 | * \param next_id identifies the next value to be read |
| 235 | * \param value a pointer to store the value |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 236 | * \returns the increment of the index (0: no value has been read, |
| 237 | * 1: one value has been taken, |
| 238 | * (1+n): n values have been skipped, one has been taken) |
| 239 | */ |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 240 | int osmo_stat_item_get_next(const struct osmo_stat_item *item, int32_t *next_id, |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 241 | int32_t *value) |
| 242 | { |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 243 | const struct osmo_stat_item_value *next_value; |
| 244 | const struct osmo_stat_item_value *item_value = NULL; |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 245 | int id_delta; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 246 | int next_offs; |
| 247 | |
Jacob Erlbeck | b27b352 | 2015-10-12 18:47:09 +0200 | [diff] [blame] | 248 | next_offs = item->last_offs; |
| 249 | next_value = &item->values[next_offs]; |
| 250 | |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 251 | while (next_value->id - *next_id >= 0 && |
Jacob Erlbeck | ac4ed17 | 2015-12-08 10:29:16 +0100 | [diff] [blame] | 252 | next_value->id != OSMO_STAT_ITEM_NOVALUE_ID) |
Jacob Erlbeck | b27b352 | 2015-10-12 18:47:09 +0200 | [diff] [blame] | 253 | { |
| 254 | item_value = next_value; |
| 255 | |
| 256 | next_offs -= 1; |
| 257 | if (next_offs < 0) |
| 258 | next_offs = item->desc->num_values - 1; |
| 259 | if (next_offs == item->last_offs) |
| 260 | break; |
| 261 | next_value = &item->values[next_offs]; |
| 262 | } |
| 263 | |
| 264 | if (!item_value) |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 265 | /* All items have been read */ |
| 266 | return 0; |
| 267 | |
Jacob Erlbeck | b27b352 | 2015-10-12 18:47:09 +0200 | [diff] [blame] | 268 | *value = item_value->value; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 269 | |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 270 | id_delta = item_value->id + 1 - *next_id; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 271 | |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 272 | *next_id = item_value->id + 1; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 273 | |
Oliver Smith | 2623fca | 2021-03-26 10:42:09 +0100 | [diff] [blame] | 274 | if (id_delta > 1) { |
| 275 | LOGP(DLSTATS, LOGL_ERROR, "%s: %d stats values skipped\n", item->desc->name, id_delta - 1); |
| 276 | } |
| 277 | |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 278 | return id_delta; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 279 | } |
| 280 | |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 281 | /*! Skip/discard all values of this item and update \a next_id accordingly */ |
| 282 | int osmo_stat_item_discard(const struct osmo_stat_item *item, int32_t *next_id) |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 283 | { |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 284 | int discarded = item->values[item->last_offs].id + 1 - *next_id; |
| 285 | *next_id = item->values[item->last_offs].id + 1; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 286 | |
| 287 | return discarded; |
| 288 | } |
| 289 | |
Oliver Smith | d3490bc | 2021-03-26 11:34:34 +0100 | [diff] [blame] | 290 | /*! Skip all values of all items and update \a next_id accordingly */ |
| 291 | int osmo_stat_item_discard_all(int32_t *next_id) |
Jacob Erlbeck | b27b352 | 2015-10-12 18:47:09 +0200 | [diff] [blame] | 292 | { |
Oliver Smith | 6140194 | 2021-03-26 10:18:37 +0100 | [diff] [blame] | 293 | LOGP(DLSTATS, LOGL_ERROR, "osmo_stat_item_discard_all is deprecated (no-op)\n"); |
| 294 | return 0; |
Jacob Erlbeck | b27b352 | 2015-10-12 18:47:09 +0200 | [diff] [blame] | 295 | } |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 296 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 297 | /*! Initialize the stat item module. Call this once from your program. |
| 298 | * \param[in] tall_ctx Talloc context from which this module allocates */ |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 299 | int osmo_stat_item_init(void *tall_ctx) |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 300 | { |
| 301 | tall_stat_item_ctx = tall_ctx; |
| 302 | |
| 303 | return 0; |
| 304 | } |
| 305 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 306 | /*! Search for item group based on group name and index |
| 307 | * \param[in] name Name of stats_item_group we want to find |
| 308 | * \param[in] idx Index of the group we want to find |
| 309 | * \returns pointer to group, if found; NULL otherwise */ |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 310 | struct osmo_stat_item_group *osmo_stat_item_get_group_by_name_idx( |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 311 | const char *name, const unsigned int idx) |
| 312 | { |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 313 | struct osmo_stat_item_group *statg; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 314 | |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 315 | llist_for_each_entry(statg, &osmo_stat_item_groups, list) { |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 316 | if (!statg->desc) |
| 317 | continue; |
| 318 | |
| 319 | if (!strcmp(statg->desc->group_name_prefix, name) && |
| 320 | statg->idx == idx) |
| 321 | return statg; |
| 322 | } |
| 323 | return NULL; |
| 324 | } |
| 325 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 326 | /*! Search for item based on group + item name |
| 327 | * \param[in] statg group in which to search for the item |
| 328 | * \param[in] name name of item to search within \a statg |
| 329 | * \returns pointer to item, if found; NULL otherwise */ |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 330 | const struct osmo_stat_item *osmo_stat_item_get_by_name( |
| 331 | const struct osmo_stat_item_group *statg, const char *name) |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 332 | { |
| 333 | int i; |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 334 | const struct osmo_stat_item_desc *item_desc; |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 335 | |
| 336 | if (!statg->desc) |
| 337 | return NULL; |
| 338 | |
| 339 | for (i = 0; i < statg->desc->num_items; i++) { |
| 340 | item_desc = &statg->desc->item_desc[i]; |
| 341 | |
| 342 | if (!strcmp(item_desc->name, name)) { |
| 343 | return statg->items[i]; |
| 344 | } |
| 345 | } |
| 346 | return NULL; |
| 347 | } |
| 348 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 349 | /*! Iterate over all items in group, call user-supplied function on each |
| 350 | * \param[in] statg stat_item group over whose items to iterate |
| 351 | * \param[in] handle_item Call-back function, aborts if rc < 0 |
| 352 | * \param[in] data Private data handed through to \a handle_item |
| 353 | */ |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 354 | int osmo_stat_item_for_each_item(struct osmo_stat_item_group *statg, |
| 355 | osmo_stat_item_handler_t handle_item, void *data) |
Jacob Erlbeck | c6a7108 | 2015-10-19 14:04:38 +0200 | [diff] [blame] | 356 | { |
| 357 | int rc = 0; |
| 358 | int i; |
| 359 | |
| 360 | for (i = 0; i < statg->desc->num_items; i++) { |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 361 | struct osmo_stat_item *item = statg->items[i]; |
Jacob Erlbeck | c6a7108 | 2015-10-19 14:04:38 +0200 | [diff] [blame] | 362 | rc = handle_item(statg, item, data); |
| 363 | if (rc < 0) |
| 364 | return rc; |
| 365 | } |
| 366 | |
| 367 | return rc; |
| 368 | } |
| 369 | |
Harald Welte | 781951b | 2017-10-15 19:24:57 +0200 | [diff] [blame] | 370 | /*! Iterate over all stat_item groups in system, call user-supplied function on each |
| 371 | * \param[in] handle_group Call-back function, aborts if rc < 0 |
| 372 | * \param[in] data Private data handed through to \a handle_group |
| 373 | */ |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 374 | int osmo_stat_item_for_each_group(osmo_stat_item_group_handler_t handle_group, void *data) |
Jacob Erlbeck | c6a7108 | 2015-10-19 14:04:38 +0200 | [diff] [blame] | 375 | { |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 376 | struct osmo_stat_item_group *statg; |
Jacob Erlbeck | c6a7108 | 2015-10-19 14:04:38 +0200 | [diff] [blame] | 377 | int rc = 0; |
| 378 | |
Jacob Erlbeck | fc9533d | 2015-10-29 00:55:58 +0100 | [diff] [blame] | 379 | llist_for_each_entry(statg, &osmo_stat_item_groups, list) { |
Jacob Erlbeck | c6a7108 | 2015-10-19 14:04:38 +0200 | [diff] [blame] | 380 | rc = handle_group(statg, data); |
| 381 | if (rc < 0) |
| 382 | return rc; |
| 383 | } |
| 384 | |
| 385 | return rc; |
| 386 | } |
| 387 | |
Daniel Willmann | ea71b43 | 2020-07-14 18:10:20 +0200 | [diff] [blame] | 388 | |
| 389 | /*! Remove all values of a stat item |
| 390 | * \param[in] item stat item to reset |
| 391 | */ |
| 392 | void osmo_stat_item_reset(struct osmo_stat_item *item) |
| 393 | { |
| 394 | unsigned int i; |
| 395 | |
| 396 | item->last_offs = item->desc->num_values - 1; |
Oliver Smith | 6140194 | 2021-03-26 10:18:37 +0100 | [diff] [blame] | 397 | item->stats_next_id = 1; |
Daniel Willmann | ea71b43 | 2020-07-14 18:10:20 +0200 | [diff] [blame] | 398 | |
| 399 | for (i = 0; i <= item->last_offs; i++) { |
| 400 | item->values[i].value = item->desc->default_value; |
| 401 | item->values[i].id = OSMO_STAT_ITEM_NOVALUE_ID; |
| 402 | } |
| 403 | } |
| 404 | |
| 405 | /*! Reset all osmo stat items in a group |
| 406 | * \param[in] statg stat item group to reset |
| 407 | */ |
| 408 | void osmo_stat_item_group_reset(struct osmo_stat_item_group *statg) |
| 409 | { |
| 410 | int i; |
| 411 | |
| 412 | for (i = 0; i < statg->desc->num_items; i++) { |
| 413 | struct osmo_stat_item *item = statg->items[i]; |
| 414 | osmo_stat_item_reset(item); |
| 415 | } |
| 416 | } |
Jacob Erlbeck | 9732cb4 | 2015-10-01 20:43:53 +0200 | [diff] [blame] | 417 | /*! @} */ |