GCC Code Coverage Report

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