GCC Code Coverage Report

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