libosmocore  1.7.0.61-0d9b6.202211030053
Osmocom core library
rate_ctr.h
Go to the documentation of this file.
1 #pragma once
2 
7 #include <stdint.h>
8 
10 
12 #define RATE_CTR_INTV_NUM 4
13 
20 };
21 
24  uint64_t last;
25  uint64_t rate;
26 };
27 
29 struct rate_ctr {
30  uint64_t current;
31  uint64_t previous;
34 };
35 
37 struct rate_ctr_desc {
38  const char *name;
39  const char *description;
40 };
41 
45  const char *group_name_prefix;
47  const char *group_description;
49  int class_id;
51  unsigned int num_ctr;
53  const struct rate_ctr_desc *ctr_desc;
54 };
55 
59  struct llist_head list;
61  const struct rate_ctr_group_desc *desc;
63  unsigned int idx;
65  char *name;
67  struct rate_ctr ctr[0];
68 };
69 
70 struct rate_ctr_group *rate_ctr_group_alloc(void *ctx,
71  const struct rate_ctr_group_desc *desc,
72  unsigned int idx);
73 
74 static inline void rate_ctr_group_upd_idx(struct rate_ctr_group *grp, unsigned int idx)
75 {
76  grp->idx = idx;
77 }
78 void rate_ctr_group_set_name(struct rate_ctr_group *grp, const char *name);
79 
80 struct rate_ctr *rate_ctr_group_get_ctr(struct rate_ctr_group *grp, unsigned int idx);
81 
82 void rate_ctr_group_free(struct rate_ctr_group *grp);
83 
87 void rate_ctr_add(struct rate_ctr *ctr, int inc);
88 
91 static inline void rate_ctr_inc(struct rate_ctr *ctr)
92 {
93  rate_ctr_add(ctr, 1);
94 }
95 
99 static inline void rate_ctr_inc2(struct rate_ctr_group *ctrg, unsigned int idx)
100 {
102 }
103 
104 
106 int64_t rate_ctr_difference(struct rate_ctr *ctr);
107 
108 int rate_ctr_init(void *tall_ctx);
109 
110 struct rate_ctr_group *rate_ctr_get_group_by_name_idx(const char *name, const unsigned int idx);
111 const struct rate_ctr *rate_ctr_get_by_name(const struct rate_ctr_group *ctrg, const char *name);
112 
113 typedef int (*rate_ctr_handler_t)(
114  struct rate_ctr_group *, struct rate_ctr *,
115  const struct rate_ctr_desc *, void *);
116 typedef int (*rate_ctr_group_handler_t)(struct rate_ctr_group *, void *);
117 
118 
121 
122 int rate_ctr_for_each_group(rate_ctr_group_handler_t handle_group, void *data);
123 
124 void rate_ctr_reset(struct rate_ctr *ctr);
125 void rate_ctr_group_reset(struct rate_ctr_group *ctrg);
126 
const char * name
uint8_t data[0]
void rate_ctr_reset(struct rate_ctr *ctr)
Reset a rate counter back to zero.
Definition: rate_ctr.c:452
struct rate_ctr_group * rate_ctr_group_alloc(void *ctx, const struct rate_ctr_group_desc *desc, unsigned int idx)
Allocate a new group of counters according to description.
Definition: rate_ctr.c:209
const struct rate_ctr * rate_ctr_get_by_name(const struct rate_ctr_group *ctrg, const char *name)
Search for counter based on group + name.
Definition: rate_ctr.c:389
static void rate_ctr_inc2(struct rate_ctr_group *ctrg, unsigned int idx)
Increment the counter by 1.
Definition: rate_ctr.h:99
rate_ctr_intv
Rate counter interval.
Definition: rate_ctr.h:15
void rate_ctr_group_free(struct rate_ctr_group *grp)
Free the memory for the specified group of counters.
Definition: rate_ctr.c:252
struct rate_ctr * rate_ctr_group_get_ctr(struct rate_ctr_group *grp, unsigned int idx)
Get rate counter from group, identified by index idx.
Definition: rate_ctr.c:267
void rate_ctr_group_reset(struct rate_ctr_group *ctrg)
Reset all counters in a group.
Definition: rate_ctr.c:460
void rate_ctr_group_set_name(struct rate_ctr_group *grp, const char *name)
Set a name for the group of counters be used instead of index value at report time.
Definition: rate_ctr.c:277
int(* rate_ctr_group_handler_t)(struct rate_ctr_group *, void *)
Definition: rate_ctr.h:116
int rate_ctr_for_each_group(rate_ctr_group_handler_t handle_group, void *data)
Iterate over all counter groups.
Definition: rate_ctr.c:435
static void rate_ctr_group_upd_idx(struct rate_ctr_group *grp, unsigned int idx)
Definition: rate_ctr.h:74
#define RATE_CTR_INTV_NUM
Number of rate counter intervals.
Definition: rate_ctr.h:12
int(* rate_ctr_handler_t)(struct rate_ctr_group *, struct rate_ctr *, const struct rate_ctr_desc *, void *)
Definition: rate_ctr.h:113
struct rate_ctr_group * rate_ctr_get_group_by_name_idx(const char *name, const unsigned int idx)
Search for counter group based on group name and index.
Definition: rate_ctr.c:368
static void rate_ctr_inc(struct rate_ctr *ctr)
Increment the counter by 1.
Definition: rate_ctr.h:91
int rate_ctr_init(void *tall_ctx)
Initialize the counter module.
Definition: rate_ctr.c:351
int64_t rate_ctr_difference(struct rate_ctr *ctr)
Return the counter difference since the last call to this function.
Definition: rate_ctr.c:289
int rate_ctr_for_each_counter(struct rate_ctr_group *ctrg, rate_ctr_handler_t handle_counter, void *data)
Iterate over each counter in group and call function.
Definition: rate_ctr.c:413
void rate_ctr_add(struct rate_ctr *ctr, int inc)
Increment the counter by inc.
Definition: rate_ctr.c:283
@ RATE_CTR_INTV_DAY
last day
Definition: rate_ctr.h:19
@ RATE_CTR_INTV_SEC
last second
Definition: rate_ctr.h:16
@ RATE_CTR_INTV_MIN
last minute
Definition: rate_ctr.h:17
@ RATE_CTR_INTV_HOUR
last hour
Definition: rate_ctr.h:18
static int handle_counter(struct osmo_counter *counter, void *vctx_)
Simple doubly linked list implementation.
(double) linked list header structure
Definition: linuxlist.h:46
rate counter description
Definition: rate_ctr.h:37
const char * description
description of the counter
Definition: rate_ctr.h:39
const char * name
name of the counter
Definition: rate_ctr.h:38
description of a rate counter group
Definition: rate_ctr.h:43
int class_id
The class to which this group belongs.
Definition: rate_ctr.h:49
const struct rate_ctr_desc * ctr_desc
Pointer to array of counter names.
Definition: rate_ctr.h:53
unsigned int num_ctr
The number of counters in this group.
Definition: rate_ctr.h:51
const char * group_name_prefix
The prefix to the name of all counters in this group.
Definition: rate_ctr.h:45
const char * group_description
The human-readable description of the group.
Definition: rate_ctr.h:47
One instance of a counter group class.
Definition: rate_ctr.h:57
struct llist_head list
Linked list of all counter groups in the system.
Definition: rate_ctr.h:59
struct rate_ctr ctr[0]
Actual counter structures below.
Definition: rate_ctr.h:67
unsigned int idx
The index of this ctr_group within its class.
Definition: rate_ctr.h:63
char * name
Optional string-based identifier to be used instead of index at report time.
Definition: rate_ctr.h:65
const struct rate_ctr_group_desc * desc
Pointer to the counter group class.
Definition: rate_ctr.h:61
data we keep for each of the intervals
Definition: rate_ctr.h:23
uint64_t rate
counter rate
Definition: rate_ctr.h:25
uint64_t last
counter value in last interval
Definition: rate_ctr.h:24
data we keep for each actual value
Definition: rate_ctr.h:29
uint64_t current
current value
Definition: rate_ctr.h:30
struct rate_ctr_per_intv intv[RATE_CTR_INTV_NUM]
per-interval data
Definition: rate_ctr.h:33
uint64_t previous
previous value, used for delta
Definition: rate_ctr.h:31