libosmocore 0.9.6-23.20170220git32ee5af8.fc42
Osmocom core library
Loading...
Searching...
No Matches
stat_item.h
Go to the documentation of this file.
1#pragma once
2
9#include <stdint.h>
10
12
14
15#define OSMO_STAT_ITEM_NOVALUE_ID 0
16#define OSMO_STAT_ITEM_NO_UNIT NULL
17
19 int32_t id;
20 int32_t value;
21};
22
25 const struct osmo_stat_item_desc *desc;
29 int16_t last_offs;
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;
52 const unsigned int num_items;
55};
56
64 unsigned int idx;
67};
68
70 void *ctx,
71 const struct osmo_stat_item_group_desc *desc,
72 unsigned int idx);
73
74static 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
82void osmo_stat_item_set(struct osmo_stat_item *item, int32_t value);
83
84int 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
108int osmo_stat_item_get_next(const struct osmo_stat_item *item, int32_t *idx, int32_t *value);
109
111static int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item);
112
114int osmo_stat_item_discard(const struct osmo_stat_item *item, int32_t *idx);
115
117int osmo_stat_item_discard_all(int32_t *idx);
118
119typedef int (*osmo_stat_item_handler_t)(
120 struct osmo_stat_item_group *, struct osmo_stat_item *, void *);
121
122typedef int (*osmo_stat_item_group_handler_t)(struct osmo_stat_item_group *, void *);
123
129 osmo_stat_item_handler_t handle_item, void *data);
130
131int osmo_stat_item_for_each_group(osmo_stat_item_group_handler_t handle_group, void *data);
132
133static inline int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item)
134{
135 return item->values[item->last_offs].value;
136}
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
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
static int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item)
Get the last (freshest) value.
Definition stat_item.h:133
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,...
Definition stat_item.c:138
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
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
int osmo_stat_item_discard_all(int32_t *idx)
Skip all values of all items and update idx accordingly.
Definition stat_item.c:185
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
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
int osmo_stat_item_init(void *tall_ctx)
Initialize the stat item module.
Definition stat_item.c:194
Simple doubly linked list implementation.
(double) linked list header structure
Definition linuxlist.h:47
statistics value description
Definition stat_item.h:35
const char * description
description of the item
Definition stat_item.h:37
const char * name
name of the item
Definition stat_item.h:36
unsigned int num_values
number of values to store
Definition stat_item.h:39
const char * unit
unit of a value
Definition stat_item.h:38
description of a statistics value group
Definition stat_item.h:44
const char * group_name_prefix
The prefix to the name of all values in this group.
Definition stat_item.h:46
const struct osmo_stat_item_desc * item_desc
Pointer to array of value names.
Definition stat_item.h:54
const char * group_description
The human-readable description of the group.
Definition stat_item.h:48
int class_id
The class to which this group belongs.
Definition stat_item.h:50
const unsigned int num_items
The number of values in this group.
Definition stat_item.h:52
One instance of a counter group class.
Definition stat_item.h:58
const struct osmo_stat_item_group_desc * desc
Pointer to the counter group class.
Definition stat_item.h:62
struct osmo_stat_item * items[0]
Actual counter structures below.
Definition stat_item.h:66
struct llist_head list
Linked list of all value groups in the system.
Definition stat_item.h:60
unsigned int idx
The index of this value group within its class.
Definition stat_item.h:64
Definition stat_item.h:18
data we keep for each actual value
Definition stat_item.h:24
struct osmo_stat_item_value values[0]
value fifo
Definition stat_item.h:31
int16_t last_offs
offset to the freshest value in the value fifo
Definition stat_item.h:29
int32_t last_value_index
the index of the freshest value
Definition stat_item.h:27