libosmocore  0.9.0
Osmocom core library
stat_item.h
Go to the documentation of this file.
1 #pragma once
2 
9 #include <stdint.h>
10 
11 #include <osmocom/core/linuxlist.h>
12 
13 struct osmo_stat_item_desc;
14 
15 #define STAT_ITEM_NOVALUE_ID 0
16 
18  int32_t id;
19  int32_t value;
20 };
21 
24  const struct osmo_stat_item_desc *desc;
28  int16_t last_offs;
31 };
32 
35  const char *name;
36  const char *description;
37  const char *unit;
38  unsigned int num_values;
39  int32_t default_value;
40 };
41 
45  const char *group_name_prefix;
47  const char *group_description;
49  int class_id;
51  const unsigned int num_items;
54 };
55 
59  struct llist_head list;
63  unsigned int idx;
65  struct osmo_stat_item *items[0];
66 };
67 
69  void *ctx,
70  const struct osmo_stat_item_group_desc *desc,
71  unsigned int idx);
72 
74 
75 void osmo_stat_item_set(struct osmo_stat_item *item, int32_t value);
76 
77 int osmo_stat_item_init(void *tall_ctx);
78 
80  const char *name, const unsigned int idx);
81 
83  const struct osmo_stat_item_group *statg, const char *name);
84 
101 int osmo_stat_item_get_next(const struct osmo_stat_item *item, int32_t *idx, int32_t *value);
102 
104 static int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item);
105 
107 int osmo_stat_item_discard(const struct osmo_stat_item *item, int32_t *idx);
108 
110 int osmo_stat_item_discard_all(int32_t *idx);
111 
112 typedef int (*osmo_stat_item_handler_t)(
113  struct osmo_stat_item_group *, struct osmo_stat_item *, void *);
114 
115 typedef int (*osmo_stat_item_group_handler_t)(struct osmo_stat_item_group *, void *);
116 
122  osmo_stat_item_handler_t handle_item, void *data);
123 
124 int osmo_stat_item_for_each_group(osmo_stat_item_group_handler_t handle_group, void *data);
125 
126 static inline int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item)
127 {
128  return item->values[item->last_offs].value;
129 }
description of a statistics value group
Definition: stat_item.h:43
const struct osmo_stat_item_group_desc * desc
Pointer to the counter group class.
Definition: stat_item.h:61
int osmo_stat_item_discard(const struct osmo_stat_item *item, int32_t *idx)
Skip all values of the item and update idx accordingly.
Definition: stat_item.c:176
int class_id
The class to which this group belongs.
Definition: stat_item.h:49
const char * group_description
The human-readable description of the group.
Definition: stat_item.h:47
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:50
unsigned int num_values
number of values to store
Definition: stat_item.h:38
struct osmo_stat_item_value values[0]
value fifo
Definition: stat_item.h:30
const char * description
description of the item
Definition: stat_item.h:36
int osmo_stat_item_init(void *tall_ctx)
Initialize the stat item module.
Definition: stat_item.c:194
const char * unit
unit of a value
Definition: stat_item.h:37
const unsigned int num_items
The number of values in this group.
Definition: stat_item.h:51
unsigned int idx
The index of this value group within its class.
Definition: stat_item.h:63
int32_t last_value_index
the index of the freshest value
Definition: stat_item.h:26
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. If a new value has been set, it is returned. The idx is used to decide which value to return. On success, *idx is updated to refer to the next unread value. If values have been missed due to FIFO overflow, *idx is incremented by (1 + num_lost). This way, the osmo_stat_item object can be kept stateless from the reader's perspective and therefore be used by several backends simultaneously.
Definition: stat_item.c:138
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:202
struct llist_head list
Linked list of all value groups in the system.
Definition: stat_item.h:59
const char * group_name_prefix
The prefix to the name of all values in this group.
Definition: stat_item.h:45
struct osmo_stat_item * items[0]
Actual counter structures below.
Definition: stat_item.h:65
Definition: linuxlist.h:42
int16_t last_offs
offset to the freshest value in the value fifo
Definition: stat_item.h:28
One instance of a counter group class.
Definition: stat_item.h:57
const struct osmo_stat_item * osmo_stat_item_get_by_name(const struct osmo_stat_item_group *statg, const char *name)
Search for item group based on group name.
Definition: stat_item.c:219
const char * name
name of the item
Definition: stat_item.h:35
data we keep for each actual value
Definition: stat_item.h:23
const struct osmo_stat_item_desc * item_desc
Pointer to array of value names.
Definition: stat_item.h:53
static int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item)
Get the last (freshest) value.
Definition: stat_item.h:126
Definition: stat_item.h:17
int osmo_stat_item_for_each_item(struct osmo_stat_item_group *statg, osmo_stat_item_handler_t handle_item, void *data)
Iteate over all items.
Definition: stat_item.c:238
void osmo_stat_item_group_free(struct osmo_stat_item_group *statg)
Free the memory for the specified group of counters.
Definition: stat_item.c:118
statistics value description
Definition: stat_item.h:34
int osmo_stat_item_discard_all(int32_t *idx)
Skip all values of all items and update idx accordingly.
Definition: stat_item.c:185