libosmocore  0.12.1
Osmocom core library
stat_item.h
Go to the documentation of this file.
1 #pragma once
2 
7 #include <stdint.h>
8 
10 
11 struct osmo_stat_item_desc;
12 
13 #define OSMO_STAT_ITEM_NOVALUE_ID 0
14 #define OSMO_STAT_ITEM_NO_UNIT NULL
15 
18  int32_t id;
19  int32_t value;
20 };
21 
25  const struct osmo_stat_item_desc *desc;
29  int16_t last_offs;
31  struct osmo_stat_item_value values[0];
32 };
33 
36  const char *name;
37  const char *description;
38  const char *unit;
39  unsigned int num_values;
40  int32_t default_value;
41 };
42 
46  const char *group_name_prefix;
48  const char *group_description;
50  int class_id;
52  const unsigned int num_items;
55 };
56 
60  struct llist_head list;
64  unsigned int idx;
66  struct osmo_stat_item *items[0];
67 };
68 
70  void *ctx,
71  const struct osmo_stat_item_group_desc *desc,
72  unsigned int idx);
73 
74 static inline void osmo_stat_item_group_udp_idx(
75  struct osmo_stat_item_group *grp, unsigned int idx)
76 {
77  grp->idx = idx;
78 }
79 
81 
82 void osmo_stat_item_set(struct osmo_stat_item *item, int32_t value);
83 
84 int osmo_stat_item_init(void *tall_ctx);
85 
87  const char *name, const unsigned int idx);
88 
90  const struct osmo_stat_item_group *statg, const char *name);
91 
92 int osmo_stat_item_get_next(const struct osmo_stat_item *item, int32_t *idx, int32_t *value);
93 
95 static int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item);
96 
97 int osmo_stat_item_discard(const struct osmo_stat_item *item, int32_t *idx);
98 
99 int osmo_stat_item_discard_all(int32_t *idx);
100 
102  struct osmo_stat_item_group *, struct osmo_stat_item *, void *);
103 
104 typedef int (*osmo_stat_item_group_handler_t)(struct osmo_stat_item_group *, void *);
105 
107  osmo_stat_item_handler_t handle_item, void *data);
108 
110 
111 static inline int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item)
112 {
113  return item->values[item->last_offs].value;
114 }
Description of a statistics item group.
Definition: stat_item.h:44
int osmo_stat_item_get_next(const struct osmo_stat_item *item, int32_t *idx, int32_t *value)
Retrieve the next value from the osmo_stat_item object.
Definition: stat_item.c:189
void osmo_stat_item_set(struct osmo_stat_item *item, int32_t value)
Set the a given stat_item to the given value.
Definition: stat_item.c:159
const struct osmo_stat_item_group_desc * desc
Pointer to the counter group class.
Definition: stat_item.h:62
int osmo_stat_item_discard(const struct osmo_stat_item *item, int32_t *idx)
Skip/discard all values of this item and update idx accordingly.
Definition: stat_item.c:227
int class_id
The class to which this group belongs.
Definition: stat_item.h:50
const char * group_description
The human-readable description of the group.
Definition: stat_item.h:48
struct osmo_stat_item_group * osmo_stat_item_group_alloc(void *ctx, const struct osmo_stat_item_group_desc *desc, unsigned int idx)
Allocate a new group of counters according to description.
Definition: stat_item.c:79
unsigned int num_values
number of values to store in FIFO
Definition: stat_item.h:39
int32_t default_value
default value
Definition: stat_item.h:40
int32_t value
actual value
Definition: stat_item.h:19
struct osmo_stat_item_value values[0]
value FIFO
Definition: stat_item.h:31
const char * description
description of the item
Definition: stat_item.h:37
char name[32]
source file name
Definition: gsmtap.h:124
int osmo_stat_item_init(void *tall_ctx)
Initialize the stat item module.
Definition: stat_item.c:246
const char * unit
unit of a value
Definition: stat_item.h:38
const unsigned int num_items
The number of values in this group (size of item_desc)
Definition: stat_item.h:52
unsigned int idx
The index of this value group within its class.
Definition: stat_item.h:64
int32_t id
identifier of value
Definition: stat_item.h:18
int32_t last_value_index
the index of the freshest value
Definition: stat_item.h:27
const struct osmo_stat_item_desc * desc
back-reference to the item description
Definition: stat_item.h:25
struct osmo_stat_item_group * osmo_stat_item_get_group_by_name_idx(const char *name, const unsigned int idx)
Search for item group based on group name and index.
Definition: stat_item.c:257
const char * group_name_prefix
The prefix to the name of all values in this group.
Definition: stat_item.h:46
Simple doubly linked list implementation.
int(* osmo_stat_item_group_handler_t)(struct osmo_stat_item_group *, void *)
Definition: stat_item.h:104
int osmo_stat_item_for_each_group(osmo_stat_item_group_handler_t handle_group, void *data)
Iterate over all stat_item groups in system, call user-supplied function on each. ...
Definition: stat_item.c:321
(double) linked list header structure
Definition: linuxlist.h:46
int16_t last_offs
offset to the freshest value in the value FIFO
Definition: stat_item.h:29
int(* osmo_stat_item_handler_t)(struct osmo_stat_item_group *, struct osmo_stat_item *, void *)
Definition: stat_item.h:101
One instance of a counter group class.
Definition: stat_item.h:58
const struct osmo_stat_item * osmo_stat_item_get_by_name(const struct osmo_stat_item_group *statg, const char *name)
Search for item based on group + item name.
Definition: stat_item.c:277
const char * name
name of the item
Definition: stat_item.h:36
data we keep for each actual item
Definition: stat_item.h:23
const struct osmo_stat_item_desc * item_desc
Pointer to array of value names, length as per num_items.
Definition: stat_item.h:54
static int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item)
Get the last (freshest) value.
Definition: stat_item.h:111
Individual entry in value FIFO.
Definition: stat_item.h:17
static void osmo_stat_item_group_udp_idx(struct osmo_stat_item_group *grp, unsigned int idx)
Definition: stat_item.h:74
int osmo_stat_item_for_each_item(struct osmo_stat_item_group *statg, osmo_stat_item_handler_t handle_item, void *data)
Iterate over all items in group, call user-supplied function on each.
Definition: stat_item.c:301
void osmo_stat_item_group_free(struct osmo_stat_item_group *statg)
Free the memory for the specified group of stat items.
Definition: stat_item.c:147
Statistics item description.
Definition: stat_item.h:35
int osmo_stat_item_discard_all(int32_t *idx)
Skip all values of all items and update idx accordingly.
Definition: stat_item.c:236