libosmocore  1.11.0.28-368d5.202505302026
Osmocom core library
counter.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <osmocom/core/defs.h>
4 
9 struct osmo_counter {
10  struct llist_head list;
11  const char *name;
12  const char *description;
13  unsigned long value;
14  unsigned long previous;
15 };
16 
19 OSMO_DEPRECATED("Implement as osmo_stat_item instead")
20 static inline void osmo_counter_dec(struct osmo_counter *ctr)
21 {
22  ctr->value--;
23 }
24 
27 OSMO_DEPRECATED("Implement as osmo_stat_item instead")
28 static inline void osmo_counter_inc(struct osmo_counter *ctr)
29 {
30  ctr->value++;
31 }
32 
34 OSMO_DEPRECATED_OUTSIDE("Implement as osmo_stat_item instead")
35 static inline unsigned long osmo_counter_get(struct osmo_counter *ctr)
36 {
37  return ctr->value;
38 }
39 
41 OSMO_DEPRECATED("Implement as osmo_stat_item instead")
42 static inline void osmo_counter_reset(struct osmo_counter *ctr)
43 {
44  ctr->value = 0;
45 }
46 
47 struct osmo_counter *osmo_counter_alloc(const char *name)
48  OSMO_DEPRECATED("Implement as osmo_stat_item instead");
49 
50 void osmo_counter_free(struct osmo_counter *ctr)
51  OSMO_DEPRECATED("Implement as osmo_stat_item instead");
52 
53 int osmo_counters_for_each(int (*handle_counter)(struct osmo_counter *, void *), void *data);
54 
55 int osmo_counters_count(void);
56 
57 struct osmo_counter *osmo_counter_get_by_name(const char *name);
58 
int osmo_counters_for_each(int(*handle_counter)(struct osmo_counter *, void *), void *data)
Iterate over all counters; call handle_cunter call-back for each.
Definition: counter.c:61
static void osmo_counter_inc(struct osmo_counter *ctr)
Increment counter by one.
Definition: counter.h:28
struct osmo_counter * osmo_counter_get_by_name(const char *name)
Find a counter by its name.
Definition: counter.c:86
int osmo_counter_difference(struct osmo_counter *ctr)
Compute difference between current and previous counter value.
Definition: counter.c:102
int osmo_counters_count(void)
Counts the registered counter.
Definition: counter.c:78
static void osmo_counter_reset(struct osmo_counter *ctr)
Reset current value of counter to 0.
Definition: counter.h:42
void osmo_counter_free(struct osmo_counter *ctr) OSMO_DEPRECATED("Implement as osmo_stat_item instead")
Release/Destroy a given counter.
Definition: counter.c:51
struct osmo_counter * osmo_counter_alloc(const char *name) OSMO_DEPRECATED("Implement as osmo_stat_item instead")
Allocate a new counter with given name.
Definition: counter.c:36
static unsigned long osmo_counter_get(struct osmo_counter *ctr)
Get current value of counter.
Definition: counter.h:35
static void osmo_counter_dec(struct osmo_counter *ctr)
Decrement given counter by one.
Definition: counter.h:20
General definitions that are meant to be included from header files.
const char * name
uint8_t data[0]
#define inline
Definition: linuxlist.h:22
#define OSMO_DEPRECATED_OUTSIDE(text)
Definition: defs.h:49
#define OSMO_DEPRECATED(text)
Set the deprecated attribute with a message.
Definition: defs.h:41
static int handle_counter(struct osmo_counter *counter, void *vctx_)
(double) linked list header structure
Definition: linuxlist.h:46
Structure representing a single counter.
Definition: counter.h:9
struct llist_head list
internal list head
Definition: counter.h:10
const char * description
humn-readable description
Definition: counter.h:12
const char * name
human-readable name
Definition: counter.h:11
unsigned long value
current value
Definition: counter.h:13
unsigned long previous
previous value
Definition: counter.h:14