GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/statistics.cc
Date: 2025-08-31 02:39:21
Exec Total Coverage
Lines: 158 160 98.8%
Branches: 88 131 67.2%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "statistics.h"
6
7 #include <algorithm>
8 #include <cassert>
9
10 #include "json_document_write.h"
11 #include "util/concurrency.h"
12 #include "util/platform.h"
13 #include "util/smalloc.h"
14 #include "util/string.h"
15
16 using namespace std; // NOLINT
17
18 #ifdef CVMFS_NAMESPACE_GUARD
19 namespace CVMFS_NAMESPACE_GUARD {
20 #endif
21
22 namespace perf {
23
24 48 std::string Counter::ToString() { return StringifyInt(Get()); }
25 49 std::string Counter::Print() { return StringifyInt(Get()); }
26 49 std::string Counter::PrintK() { return StringifyInt(Get() / 1000); }
27 49 std::string Counter::PrintKi() { return StringifyInt(Get() / 1024); }
28 49 std::string Counter::PrintM() { return StringifyInt(Get() / (1000 * 1000)); }
29 49 std::string Counter::PrintMi() { return StringifyInt(Get() / (1024 * 1024)); }
30 98 std::string Counter::PrintRatio(Counter divider) {
31 98 const double enumerator_value = Get();
32 98 const double divider_value = divider.Get();
33 98 return StringifyDouble(enumerator_value / divider_value);
34 }
35
36
37 //-----------------------------------------------------------------------------
38
39
40 /**
41 * Creates a new Statistics binder which maintains the same Counters as the
42 * existing one. Changes to those counters are visible in both Statistics
43 * objects. The child can then independently add more counters. CounterInfo
44 * objects are reference counted and deleted when all the statistics objects
45 * dealing with it are destroyed.
46 */
47 538 Statistics *Statistics::Fork() {
48
1/2
✓ Branch 1 taken 538 times.
✗ Branch 2 not taken.
 538 Statistics *child = new Statistics();
49
50 538 const MutexLockGuard lock_guard(lock_);
51 1076 for (map<string, CounterInfo *>::iterator i = counters_.begin(),
52 538 iEnd = counters_.end();
53
2/2
✓ Branch 1 taken 19609 times.
✓ Branch 2 taken 538 times.
 20147 i != iEnd;
54 19609 ++i) {
55 19609 atomic_inc32(&i->second->refcnt);
56 }
57
1/2
✓ Branch 1 taken 538 times.
✗ Branch 2 not taken.
 538 child->counters_ = counters_;
58
59 538 return child;
60 538 }
61
62
63 1342 Counter *Statistics::Lookup(const std::string &name) const {
64 1342 const MutexLockGuard lock_guard(lock_);
65
1/2
✓ Branch 1 taken 1342 times.
✗ Branch 2 not taken.
 1342 const map<string, CounterInfo *>::const_iterator i = counters_.find(name);
66
2/2
✓ Branch 2 taken 814 times.
✓ Branch 3 taken 528 times.
 1342 if (i != counters_.end())
67 814 return &i->second->counter;
68 528 return NULL;
69 1342 }
70
71
72 48 string Statistics::LookupDesc(const std::string &name) {
73 48 const MutexLockGuard lock_guard(lock_);
74
1/2
✓ Branch 1 taken 48 times.
✗ Branch 2 not taken.
 48 const map<string, CounterInfo *>::const_iterator i = counters_.find(name);
75
1/2
✓ Branch 3 taken 48 times.
✗ Branch 4 not taken.
 48 if (i != counters_.end())
76
1/2
✓ Branch 2 taken 48 times.
✗ Branch 3 not taken.
 48 return i->second->desc;
77 ✗ return "";
78 48 }
79
80 48 string Statistics::PrintList(const PrintOptions print_options) {
81 48 string result;
82
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 48 times.
 48 if (print_options == kPrintHeader)
83 ✗ result += "Name|Value|Description\n";
84
85 48 const MutexLockGuard lock_guard(lock_);
86 48 for (map<string, CounterInfo *>::const_iterator i = counters_.begin(),
87 48 iEnd = counters_.end();
88
2/2
✓ Branch 1 taken 48 times.
✓ Branch 2 taken 48 times.
 96 i != iEnd;
89 48 ++i) {
90
4/8
✓ Branch 1 taken 48 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 48 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 48 times.
✗ Branch 9 not taken.
✓ Branch 11 taken 48 times.
✗ Branch 12 not taken.
 96 result += i->first + "|" + i->second->counter.ToString() + "|"
91
3/6
✓ Branch 3 taken 48 times.
✗ Branch 4 not taken.
✓ Branch 6 taken 48 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 48 times.
✗ Branch 10 not taken.
 96 + i->second->desc + "\n";
92 }
93 96 return result;
94 48 }
95
96 /**
97 * Converts statistics counters into JSON string in following format
98 * {
99 * "name_major1": {
100 * "counter1": val1,
101 * "counter2": val2
102 * },
103 * "name_major2": {
104 * "counter3": val3
105 * }
106 * }
107 */
108 112 string Statistics::PrintJSON() {
109 112 const MutexLockGuard lock_guard(lock_);
110
111 112 JsonStringGenerator json_statistics;
112
113 // Make use of std::map key ordering and add counters namespace by namespace
114 112 JsonStringGenerator json_statistics_namespace;
115
1/2
✓ Branch 2 taken 112 times.
✗ Branch 3 not taken.
 112 std::string last_namespace = "";
116 112 for (map<string, CounterInfo *>::const_iterator i = counters_.begin(),
117 112 iEnd = counters_.end();
118
2/2
✓ Branch 1 taken 147 times.
✓ Branch 2 taken 112 times.
 259 i != iEnd;
119 147 ++i) {
120
1/2
✓ Branch 2 taken 147 times.
✗ Branch 3 not taken.
 147 std::vector<std::string> tokens = SplitString(i->first, '.');
121
122
2/2
✓ Branch 2 taken 98 times.
✓ Branch 3 taken 49 times.
 147 if (tokens[0] != last_namespace) {
123
3/4
✓ Branch 1 taken 98 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 49 times.
✓ Branch 4 taken 49 times.
 98 if (last_namespace != "") {
124
1/2
✓ Branch 1 taken 49 times.
✗ Branch 2 not taken.
 49 json_statistics.AddJsonObject(
125
1/2
✓ Branch 1 taken 49 times.
✗ Branch 2 not taken.
 98 last_namespace, json_statistics_namespace.GenerateString());
126 }
127 98 json_statistics_namespace.Clear();
128 }
129
130
1/2
✓ Branch 4 taken 147 times.
✗ Branch 5 not taken.
 147 json_statistics_namespace.Add(tokens[1], i->second->counter.Get());
131
132
1/2
✓ Branch 2 taken 147 times.
✗ Branch 3 not taken.
 147 last_namespace = tokens[0];
133 147 }
134
3/4
✓ Branch 1 taken 112 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 49 times.
✓ Branch 4 taken 63 times.
 112 if (last_namespace != "") {
135
1/2
✓ Branch 1 taken 49 times.
✗ Branch 2 not taken.
 49 json_statistics.AddJsonObject(last_namespace,
136
1/2
✓ Branch 1 taken 49 times.
✗ Branch 2 not taken.
 98 json_statistics_namespace.GenerateString());
137 }
138
139
1/2
✓ Branch 1 taken 112 times.
✗ Branch 2 not taken.
 224 return json_statistics.GenerateString();
140 112 }
141
142 /**
143 * Snapshot current state of the counters.
144 * Elements will either be updated or inserted into the map.
145 *
146 * Note: This function does NOT clear previous elements part of the map.
147 *
148 * Returns map of the updated counters and the timestamp of the snapshot.
149 */
150 344 void Statistics::SnapshotCounters(std::map<std::string, int64_t> *counters,
151 uint64_t *timestamp_ns) {
152 344 const MutexLockGuard lock_guard(lock_);
153 344 *timestamp_ns = platform_realtime_ns();
154 344 for (map<string, CounterInfo *>::const_iterator i = counters_.begin(),
155 344 iEnd = counters_.end();
156
2/2
✓ Branch 1 taken 1032 times.
✓ Branch 2 taken 344 times.
 1376 i != iEnd;
157 1032 ++i) {
158 // modify or insert
159
1/2
✓ Branch 4 taken 1032 times.
✗ Branch 5 not taken.
 1032 (*counters)[i->first] = (*i->second).counter.Get();
160 }
161 344 }
162
163 138569 Counter *Statistics::Register(const string &name, const string &desc) {
164 138569 const MutexLockGuard lock_guard(lock_);
165
2/5
✓ Branch 2 taken 138569 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✓ Branch 6 taken 138569 times.
 138569 assert(counters_.find(name) == counters_.end());
166
2/4
✓ Branch 1 taken 138569 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 138569 times.
✗ Branch 5 not taken.
 138569 CounterInfo *counter_info = new CounterInfo(desc);
167
1/2
✓ Branch 1 taken 138569 times.
✗ Branch 2 not taken.
 138569 counters_[name] = counter_info;
168 138569 return &counter_info->counter;
169 138569 }
170
171
172 7031 Statistics::Statistics() {
173 7031 lock_ = reinterpret_cast<pthread_mutex_t *>(smalloc(sizeof(pthread_mutex_t)));
174 7031 const int retval = pthread_mutex_init(lock_, NULL);
175
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 7031 times.
 7031 assert(retval == 0);
176 7031 }
177
178
179 7021 Statistics::~Statistics() {
180 14042 for (map<string, CounterInfo *>::iterator i = counters_.begin(),
181 7021 iEnd = counters_.end();
182
2/2
✓ Branch 1 taken 157977 times.
✓ Branch 2 taken 7021 times.
 164998 i != iEnd;
183 157977 ++i) {
184 157977 const int32_t old_value = atomic_xadd32(&i->second->refcnt, -1);
185
2/2
✓ Branch 0 taken 138368 times.
✓ Branch 1 taken 19609 times.
 157977 if (old_value == 1)
186
1/2
✓ Branch 1 taken 138368 times.
✗ Branch 2 not taken.
 138368 delete i->second;
187 }
188 7021 pthread_mutex_destroy(lock_);
189 7021 free(lock_);
190 7021 }
191
192
193 //------------------------------------------------------------------------------
194
195
196 /**
197 * If necessary, capacity_s is extended to be a multiple of resolution_s
198 */
199 5355 Recorder::Recorder(uint32_t resolution_s, uint32_t capacity_s)
200 5355 : last_timestamp_(0), capacity_s_(capacity_s), resolution_s_(resolution_s) {
201
2/4
✓ Branch 0 taken 5355 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 5355 times.
✗ Branch 3 not taken.
 5355 assert((resolution_s > 0) && (capacity_s > resolution_s));
202 5355 const bool has_remainder = (capacity_s_ % resolution_s_) != 0;
203
2/2
✓ Branch 0 taken 98 times.
✓ Branch 1 taken 5257 times.
 5355 if (has_remainder) {
204 98 capacity_s_ += resolution_s_ - (capacity_s_ % resolution_s_);
205 }
206 5355 no_bins_ = capacity_s_ / resolution_s_;
207
1/2
✓ Branch 1 taken 5355 times.
✗ Branch 2 not taken.
 5355 bins_.reserve(no_bins_);
208
2/2
✓ Branch 0 taken 401289 times.
✓ Branch 1 taken 5355 times.
 406644 for (unsigned i = 0; i < no_bins_; ++i)
209
1/2
✓ Branch 1 taken 401289 times.
✗ Branch 2 not taken.
 401289 bins_.push_back(0);
210 5355 }
211
212
213 98 void Recorder::Tick() { TickAt(platform_monotonic_time()); }
214
215
216 5329 void Recorder::TickAt(uint64_t timestamp) {
217 5329 const uint64_t bin_abs = timestamp / resolution_s_;
218 5329 const uint64_t last_bin_abs = last_timestamp_ / resolution_s_;
219
220 // timestamp in the past: don't update last_timestamp_
221
2/2
✓ Branch 0 taken 98 times.
✓ Branch 1 taken 5231 times.
 5329 if (bin_abs < last_bin_abs) {
222 // Do we still remember this event?
223
2/2
✓ Branch 0 taken 49 times.
✓ Branch 1 taken 49 times.
 98 if ((last_bin_abs - bin_abs) < no_bins_)
224 49 bins_[bin_abs % no_bins_]++;
225 98 return;
226 }
227
228
2/2
✓ Branch 0 taken 1155 times.
✓ Branch 1 taken 4076 times.
 5231 if (last_bin_abs == bin_abs) {
229 1155 bins_[bin_abs % no_bins_]++;
230 } else {
231 // When clearing bins between last_timestamp_ and now, avoid cycling the
232 // ring buffer multiple times.
233 8152 const unsigned max_bins_clear = std::min(bin_abs,
234 4076 last_bin_abs + no_bins_ + 1);
235
2/2
✓ Branch 0 taken 37845 times.
✓ Branch 1 taken 4076 times.
 41921 for (uint64_t i = last_bin_abs + 1; i < max_bins_clear; ++i)
236 37845 bins_[i % no_bins_] = 0;
237 4076 bins_[bin_abs % no_bins_] = 1;
238 }
239
240 5231 last_timestamp_ = timestamp;
241 }
242
243
244 905 uint64_t Recorder::GetNoTicks(uint32_t retrospect_s) const {
245 905 const uint64_t now = platform_monotonic_time();
246
2/2
✓ Branch 0 taken 490 times.
✓ Branch 1 taken 415 times.
 905 if (retrospect_s > now)
247 490 retrospect_s = now;
248
249 905 const uint64_t last_bin_abs = last_timestamp_ / resolution_s_;
250 905 const uint64_t past_bin_abs = (now - retrospect_s) / resolution_s_;
251 1810 const int64_t min_bin_abs = std::max(
252 past_bin_abs,
253
2/2
✓ Branch 0 taken 606 times.
✓ Branch 1 taken 299 times.
 905 (last_bin_abs < no_bins_) ? 0 : (last_bin_abs - (no_bins_ - 1)));
254 905 uint64_t result = 0;
255
2/2
✓ Branch 0 taken 5508 times.
✓ Branch 1 taken 905 times.
 6413 for (int64_t i = last_bin_abs; i >= min_bin_abs; --i) {
256 5508 result += bins_[i % no_bins_];
257 }
258
259 905 return result;
260 }
261
262
263 //------------------------------------------------------------------------------
264
265
266 4914 void MultiRecorder::AddRecorder(uint32_t resolution_s, uint32_t capacity_s) {
267
1/2
✓ Branch 2 taken 4914 times.
✗ Branch 3 not taken.
 4914 recorders_.push_back(Recorder(resolution_s, capacity_s));
268 4914 }
269
270
271 268 uint64_t MultiRecorder::GetNoTicks(uint32_t retrospect_s) const {
272 268 const unsigned N = recorders_.size();
273
2/2
✓ Branch 0 taken 317 times.
✓ Branch 1 taken 49 times.
 366 for (unsigned i = 0; i < N; ++i) {
274
6/6
✓ Branch 2 taken 196 times.
✓ Branch 3 taken 121 times.
✓ Branch 4 taken 98 times.
✓ Branch 5 taken 98 times.
✓ Branch 6 taken 219 times.
✓ Branch 7 taken 98 times.
 317 if ((recorders_[i].capacity_s() >= retrospect_s) || (i == (N - 1))) {
275 219 return recorders_[i].GetNoTicks(retrospect_s);
276 }
277 }
278 49 return 0;
279 }
280
281
282 242 void MultiRecorder::Tick() {
283 242 const uint64_t now = platform_monotonic_time();
284
2/2
✓ Branch 1 taken 674 times.
✓ Branch 2 taken 242 times.
 916 for (unsigned i = 0; i < recorders_.size(); ++i)
285 674 recorders_[i].TickAt(now);
286 242 }
287
288
289 980 void MultiRecorder::TickAt(uint64_t timestamp) {
290
2/2
✓ Branch 1 taken 1960 times.
✓ Branch 2 taken 980 times.
 2940 for (unsigned i = 0; i < recorders_.size(); ++i)
291 1960 recorders_[i].TickAt(timestamp);
292 980 }
293
294 } // namespace perf
295
296
297 #ifdef CVMFS_NAMESPACE_GUARD
298 } // namespace CVMFS_NAMESPACE_GUARD
299 #endif
300