GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/statistics.cc
Date: 2025-10-19 02:35:28
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 32 std::string Counter::ToString() { return StringifyInt(Get()); }
25 32 std::string Counter::Print() { return StringifyInt(Get()); }
26 32 std::string Counter::PrintK() { return StringifyInt(Get() / 1000); }
27 32 std::string Counter::PrintKi() { return StringifyInt(Get() / 1024); }
28 32 std::string Counter::PrintM() { return StringifyInt(Get() / (1000 * 1000)); }
29 32 std::string Counter::PrintMi() { return StringifyInt(Get() / (1024 * 1024)); }
30 64 std::string Counter::PrintRatio(Counter divider) {
31 64 const double enumerator_value = Get();
32 64 const double divider_value = divider.Get();
33 64 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 1588 Statistics *Statistics::Fork() {
48
1/2
✓ Branch 1 taken 1588 times.
✗ Branch 2 not taken.
 1588 Statistics *child = new Statistics();
49
50 1588 const MutexLockGuard lock_guard(lock_);
51 3176 for (map<string, CounterInfo *>::iterator i = counters_.begin(),
52 1588 iEnd = counters_.end();
53
2/2
✓ Branch 1 taken 62233 times.
✓ Branch 2 taken 1588 times.
 63821 i != iEnd;
54 62233 ++i) {
55 62233 atomic_inc32(&i->second->refcnt);
56 }
57
1/2
✓ Branch 1 taken 1588 times.
✗ Branch 2 not taken.
 1588 child->counters_ = counters_;
58
59 1588 return child;
60 1588 }
61
62
63 945 Counter *Statistics::Lookup(const std::string &name) const {
64 945 const MutexLockGuard lock_guard(lock_);
65
1/2
✓ Branch 1 taken 945 times.
✗ Branch 2 not taken.
 945 const map<string, CounterInfo *>::const_iterator i = counters_.find(name);
66
2/2
✓ Branch 2 taken 603 times.
✓ Branch 3 taken 342 times.
 945 if (i != counters_.end())
67 603 return &i->second->counter;
68 342 return NULL;
69 945 }
70
71
72 32 string Statistics::LookupDesc(const std::string &name) {
73 32 const MutexLockGuard lock_guard(lock_);
74
1/2
✓ Branch 1 taken 32 times.
✗ Branch 2 not taken.
 32 const map<string, CounterInfo *>::const_iterator i = counters_.find(name);
75
1/2
✓ Branch 3 taken 32 times.
✗ Branch 4 not taken.
 32 if (i != counters_.end())
76
1/2
✓ Branch 2 taken 32 times.
✗ Branch 3 not taken.
 32 return i->second->desc;
77 ✗ return "";
78 32 }
79
80 32 string Statistics::PrintList(const PrintOptions print_options) {
81 32 string result;
82
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 32 times.
 32 if (print_options == kPrintHeader)
83 ✗ result += "Name|Value|Description\n";
84
85 32 const MutexLockGuard lock_guard(lock_);
86 32 for (map<string, CounterInfo *>::const_iterator i = counters_.begin(),
87 32 iEnd = counters_.end();
88
2/2
✓ Branch 1 taken 32 times.
✓ Branch 2 taken 32 times.
 64 i != iEnd;
89 32 ++i) {
90
4/8
✓ Branch 1 taken 32 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 32 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 32 times.
✗ Branch 9 not taken.
✓ Branch 11 taken 32 times.
✗ Branch 12 not taken.
 64 result += i->first + "|" + i->second->counter.ToString() + "|"
91
3/6
✓ Branch 3 taken 32 times.
✗ Branch 4 not taken.
✓ Branch 6 taken 32 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 32 times.
✗ Branch 10 not taken.
 64 + i->second->desc + "\n";
92 }
93 64 return result;
94 32 }
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 96 string Statistics::PrintJSON() {
109 96 const MutexLockGuard lock_guard(lock_);
110
111 96 JsonStringGenerator json_statistics;
112
113 // Make use of std::map key ordering and add counters namespace by namespace
114 96 JsonStringGenerator json_statistics_namespace;
115
1/2
✓ Branch 2 taken 96 times.
✗ Branch 3 not taken.
 96 std::string last_namespace = "";
116 96 for (map<string, CounterInfo *>::const_iterator i = counters_.begin(),
117 96 iEnd = counters_.end();
118
2/2
✓ Branch 1 taken 99 times.
✓ Branch 2 taken 96 times.
 195 i != iEnd;
119 99 ++i) {
120
1/2
✓ Branch 2 taken 99 times.
✗ Branch 3 not taken.
 99 std::vector<std::string> tokens = SplitString(i->first, '.');
121
122
2/2
✓ Branch 2 taken 66 times.
✓ Branch 3 taken 33 times.
 99 if (tokens[0] != last_namespace) {
123
3/4
✓ Branch 1 taken 66 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 33 times.
✓ Branch 4 taken 33 times.
 66 if (last_namespace != "") {
124
1/2
✓ Branch 1 taken 33 times.
✗ Branch 2 not taken.
 33 json_statistics.AddJsonObject(
125
1/2
✓ Branch 1 taken 33 times.
✗ Branch 2 not taken.
 66 last_namespace, json_statistics_namespace.GenerateString());
126 }
127 66 json_statistics_namespace.Clear();
128 }
129
130
1/2
✓ Branch 4 taken 99 times.
✗ Branch 5 not taken.
 99 json_statistics_namespace.Add(tokens[1], i->second->counter.Get());
131
132
1/2
✓ Branch 2 taken 99 times.
✗ Branch 3 not taken.
 99 last_namespace = tokens[0];
133 99 }
134
3/4
✓ Branch 1 taken 96 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 33 times.
✓ Branch 4 taken 63 times.
 96 if (last_namespace != "") {
135
1/2
✓ Branch 1 taken 33 times.
✗ Branch 2 not taken.
 33 json_statistics.AddJsonObject(last_namespace,
136
1/2
✓ Branch 1 taken 33 times.
✗ Branch 2 not taken.
 66 json_statistics_namespace.GenerateString());
137 }
138
139
1/2
✓ Branch 1 taken 96 times.
✗ Branch 2 not taken.
 192 return json_statistics.GenerateString();
140 96 }
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 168 void Statistics::SnapshotCounters(std::map<std::string, int64_t> *counters,
151 uint64_t *timestamp_ns) {
152 168 const MutexLockGuard lock_guard(lock_);
153 168 *timestamp_ns = platform_realtime_ns();
154 168 for (map<string, CounterInfo *>::const_iterator i = counters_.begin(),
155 168 iEnd = counters_.end();
156
2/2
✓ Branch 1 taken 504 times.
✓ Branch 2 taken 168 times.
 672 i != iEnd;
157 504 ++i) {
158 // modify or insert
159
1/2
✓ Branch 4 taken 504 times.
✗ Branch 5 not taken.
 504 (*counters)[i->first] = (*i->second).counter.Get();
160 }
161 168 }
162
163 307249 Counter *Statistics::Register(const string &name, const string &desc) {
164 307249 const MutexLockGuard lock_guard(lock_);
165
2/5
✓ Branch 2 taken 307249 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
✓ Branch 6 taken 307249 times.
 307249 assert(counters_.find(name) == counters_.end());
166
2/4
✓ Branch 1 taken 307249 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 307249 times.
✗ Branch 5 not taken.
 307249 CounterInfo *counter_info = new CounterInfo(desc);
167
1/2
✓ Branch 1 taken 307249 times.
✗ Branch 2 not taken.
 307249 counters_[name] = counter_info;
168 307249 return &counter_info->counter;
169 307249 }
170
171
172 10656 Statistics::Statistics() {
173 10656 lock_ = reinterpret_cast<pthread_mutex_t *>(smalloc(sizeof(pthread_mutex_t)));
174 10656 const int retval = pthread_mutex_init(lock_, NULL);
175
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 10656 times.
 10656 assert(retval == 0);
176 10656 }
177
178
179 10646 Statistics::~Statistics() {
180 21292 for (map<string, CounterInfo *>::iterator i = counters_.begin(),
181 10646 iEnd = counters_.end();
182
2/2
✓ Branch 1 taken 369281 times.
✓ Branch 2 taken 10646 times.
 379927 i != iEnd;
183 369281 ++i) {
184 369281 const int32_t old_value = atomic_xadd32(&i->second->refcnt, -1);
185
2/2
✓ Branch 0 taken 307048 times.
✓ Branch 1 taken 62233 times.
 369281 if (old_value == 1)
186
1/2
✓ Branch 1 taken 307048 times.
✗ Branch 2 not taken.
 307048 delete i->second;
187 }
188 10646 pthread_mutex_destroy(lock_);
189 10646 free(lock_);
190 10646 }
191
192
193 //------------------------------------------------------------------------------
194
195
196 /**
197 * If necessary, capacity_s is extended to be a multiple of resolution_s
198 */
199 14719 Recorder::Recorder(uint32_t resolution_s, uint32_t capacity_s)
200 14719 : last_timestamp_(0), capacity_s_(capacity_s), resolution_s_(resolution_s) {
201
2/4
✓ Branch 0 taken 14719 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 14719 times.
✗ Branch 3 not taken.
 14719 assert((resolution_s > 0) && (capacity_s > resolution_s));
202 14719 const bool has_remainder = (capacity_s_ % resolution_s_) != 0;
203
2/2
✓ Branch 0 taken 64 times.
✓ Branch 1 taken 14655 times.
 14719 if (has_remainder) {
204 64 capacity_s_ += resolution_s_ - (capacity_s_ % resolution_s_);
205 }
206 14719 no_bins_ = capacity_s_ / resolution_s_;
207
1/2
✓ Branch 1 taken 14719 times.
✗ Branch 2 not taken.
 14719 bins_.reserve(no_bins_);
208
2/2
✓ Branch 0 taken 1187357 times.
✓ Branch 1 taken 14719 times.
 1202076 for (unsigned i = 0; i < no_bins_; ++i)
209
1/2
✓ Branch 1 taken 1187357 times.
✗ Branch 2 not taken.
 1187357 bins_.push_back(0);
210 14719 }
211
212
213 66 void Recorder::Tick() { TickAt(platform_monotonic_time()); }
214
215
216 4481 void Recorder::TickAt(uint64_t timestamp) {
217 4481 const uint64_t bin_abs = timestamp / resolution_s_;
218 4481 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 66 times.
✓ Branch 1 taken 4415 times.
 4481 if (bin_abs < last_bin_abs) {
222 // Do we still remember this event?
223
2/2
✓ Branch 0 taken 33 times.
✓ Branch 1 taken 33 times.
 66 if ((last_bin_abs - bin_abs) < no_bins_)
224 33 bins_[bin_abs % no_bins_]++;
225 66 return;
226 }
227
228
2/2
✓ Branch 0 taken 1013 times.
✓ Branch 1 taken 3402 times.
 4415 if (last_bin_abs == bin_abs) {
229 1013 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 6804 const unsigned max_bins_clear = std::min(bin_abs,
234 3402 last_bin_abs + no_bins_ + 1);
235
2/2
✓ Branch 0 taken 80685 times.
✓ Branch 1 taken 3402 times.
 84087 for (uint64_t i = last_bin_abs + 1; i < max_bins_clear; ++i)
236 80685 bins_[i % no_bins_] = 0;
237 3402 bins_[bin_abs % no_bins_] = 1;
238 }
239
240 4415 last_timestamp_ = timestamp;
241 }
242
243
244 721 uint64_t Recorder::GetNoTicks(uint32_t retrospect_s) const {
245 721 const uint64_t now = platform_monotonic_time();
246
2/2
✓ Branch 0 taken 330 times.
✓ Branch 1 taken 391 times.
 721 if (retrospect_s > now)
247 330 retrospect_s = now;
248
249 721 const uint64_t last_bin_abs = last_timestamp_ / resolution_s_;
250 721 const uint64_t past_bin_abs = (now - retrospect_s) / resolution_s_;
251 1442 const int64_t min_bin_abs = std::max(
252 past_bin_abs,
253
2/2
✓ Branch 0 taken 436 times.
✓ Branch 1 taken 285 times.
 721 (last_bin_abs < no_bins_) ? 0 : (last_bin_abs - (no_bins_ - 1)));
254 721 uint64_t result = 0;
255
2/2
✓ Branch 0 taken 5410 times.
✓ Branch 1 taken 721 times.
 6131 for (int64_t i = last_bin_abs; i >= min_bin_abs; --i) {
256 5410 result += bins_[i % no_bins_];
257 }
258
259 721 return result;
260 }
261
262
263 //------------------------------------------------------------------------------
264
265
266 14426 void MultiRecorder::AddRecorder(uint32_t resolution_s, uint32_t capacity_s) {
267
1/2
✓ Branch 2 taken 14426 times.
✗ Branch 3 not taken.
 14426 recorders_.push_back(Recorder(resolution_s, capacity_s));
268 14426 }
269
270
271 292 uint64_t MultiRecorder::GetNoTicks(uint32_t retrospect_s) const {
272 292 const unsigned N = recorders_.size();
273
2/2
✓ Branch 0 taken 325 times.
✓ Branch 1 taken 33 times.
 358 for (unsigned i = 0; i < N; ++i) {
274
6/6
✓ Branch 2 taken 132 times.
✓ Branch 3 taken 193 times.
✓ Branch 4 taken 66 times.
✓ Branch 5 taken 66 times.
✓ Branch 6 taken 259 times.
✓ Branch 7 taken 66 times.
 325 if ((recorders_[i].capacity_s() >= retrospect_s) || (i == (N - 1))) {
275 259 return recorders_[i].GetNoTicks(retrospect_s);
276 }
277 }
278 33 return 0;
279 }
280
281
282 386 void MultiRecorder::Tick() {
283 386 const uint64_t now = platform_monotonic_time();
284
2/2
✓ Branch 1 taken 1346 times.
✓ Branch 2 taken 386 times.
 1732 for (unsigned i = 0; i < recorders_.size(); ++i)
285 1346 recorders_[i].TickAt(now);
286 386 }
287
288
289 660 void MultiRecorder::TickAt(uint64_t timestamp) {
290
2/2
✓ Branch 1 taken 1320 times.
✓ Branch 2 taken 660 times.
 1980 for (unsigned i = 0; i < recorders_.size(); ++i)
291 1320 recorders_[i].TickAt(timestamp);
292 660 }
293
294 } // namespace perf
295
296
297 #ifdef CVMFS_NAMESPACE_GUARD
298 } // namespace CVMFS_NAMESPACE_GUARD
299 #endif
300