1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
//
// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This software is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt). A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//
#ifndef CORE_STATS_H
#define CORE_STATS_H
#include "core/defs.h"
#include "core/list.h"
#include "core/platform.h"
// Statistics support. This is inspired in part by the Solaris
// kernel stats framework, but we've simplified and tuned it for our use.
//
// Collection of the stats will be done in two steps. First we
// will walk the list of stats, with the chain held, allocating
// a user local copy of the stat and pointers.
//
// In phase 2, we run the update, and copy the values. We conditionally
// acquire the lock on the stat first though.
typedef struct nni_stat_item nni_stat_item;
typedef struct nni_stat_info nni_stat_info;
typedef void (*nni_stat_update)(nni_stat_item *);
typedef enum nng_stat_type_enum nni_stat_type;
typedef enum nng_unit_enum nni_stat_unit;
// nni_stat_item is used by providers. Providers should avoid accessing
// this directly, but use accessors below. It is important that we offer
// this structure so that providers can declare them inline, in order to
// avoid having to spend dereference costs or (worse) to have to include
// extra conditionals on hot code paths.
struct nni_stat_item {
#ifdef NNG_ENABLE_STATS
nni_list_node si_node; // list node, framework use only
nni_list si_children; // children, framework use only
const nni_stat_info *si_info; // statistic description
nni_mtx *si_mtx; // protects, if flag in info
union {
uint64_t sv_number;
nni_atomic_u64 sv_atomic;
char *sv_string;
bool sv_bool;
int sv_id;
} si_u;
#endif
};
struct nni_stat_info {
const char *si_name; // name of statistic
const char *si_desc; // description of statistic (English)
nni_stat_type si_type; // statistic type, e.g. NNG_STAT_LEVEL
nni_stat_unit si_unit; // statistic unit, e.g. NNG_UNIT_MILLIS
bool si_atomic : 1; // stat is atomic
bool si_alloc : 1; // stat string is allocated
bool si_lock : 1; // stat protected by lock (si_mtx)
};
#ifdef NNG_ENABLE_STATS
#define NNI_STAT_FIELDS(var, ...) \
static const nni_stat_info var = { __VA_ARGS__ }
#else
#define NNI_STAT_FIELDS(var, ...) static const nni_stat_info var
#endif
#define NNI_STAT_INFO(var, name, desc, type, unit) \
NNI_STAT_FIELDS(var, .si_name = name, .si_desc = desc, \
.si_type = type, .si_unit = unit)
#define NNI_STAT_ATOMIC(var, name, desc, type, unit) \
NNI_STAT_FIELDS(var, .si_name = name, .si_desc = desc, \
.si_type = type, .si_unit = unit, .si_atomic = true)
#define NNI_STAT_LOCK(var, name, desc, type, unit) \
NNI_STAT_FIELDS(var, .si_name = name, .si_desc = desc, \
.si_type = type, .si_unit = unit, .si_lock = true)
// nni_stat_add adds a statistic, but the operation is unlocked, and the
// add is to an unregistered stats tree.
void nni_stat_add(nni_stat_item *, nni_stat_item *);
// nni_stat_register registers a statistic tree into the global tree.
// The tree is rooted at the root. This is a locked operation.
void nni_stat_register(nni_stat_item *);
// nni_stat_unregister removes the entire tree. This is a locked operation.
void nni_stat_unregister(nni_stat_item *);
void nni_stat_set_value(nni_stat_item *, uint64_t);
void nni_stat_set_id(nni_stat_item *, int);
void nni_stat_set_bool(nni_stat_item *, bool);
void nni_stat_set_string(nni_stat_item *, const char *);
void nni_stat_init(nni_stat_item *, const nni_stat_info *);
void nni_stat_init_lock(nni_stat_item *, const nni_stat_info *, nni_mtx *);
void nni_stat_inc(nni_stat_item *, uint64_t);
void nni_stat_dec(nni_stat_item *, uint64_t);
#endif // CORE_STATS_H
|
