GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/tracer.cc
Date: 2026-10-25 02:40:14
Exec Total Coverage
Lines: 160 166 96.4%
Branches: 105 164 64.0%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5
6 #include "tracer.h"
7
8 #include <pthread.h>
9
10 #include <atomic>
11 #include <cassert>
12 #include <cerrno>
13 #include <cstdio>
14 #include <cstdlib>
15 #include <cstring>
16 #include <string>
17
18 #include "util/concurrency.h"
19 #include "util/posix.h"
20 #include "util/string.h"
21
22 using namespace std; // NOLINT
23
24
25 42 void Tracer::Activate(const int buffer_size,
26 const int flush_threshold,
27 const string &trace_file) {
28 42 trace_file_ = trace_file;
29 42 buffer_size_ = buffer_size;
30 42 flush_threshold_ = flush_threshold;
31
3/6
✓ Branch 0 taken 42 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 42 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 42 times.
✗ Branch 5 not taken.
 42 assert(buffer_size_ > 1 && flush_threshold_ >= 0
32 && flush_threshold_ < buffer_size_);
33
34
4/8
✓ Branch 0 taken 42 times.
✗ Branch 1 not taken.
✓ Branch 4 taken 12582 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 12582 times.
✓ Branch 7 taken 42 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
 12624 ring_buffer_ = new BufferEntry[buffer_size_];
35
3/4
✓ Branch 0 taken 42 times.
✗ Branch 1 not taken.
✓ Branch 4 taken 12582 times.
✓ Branch 5 taken 42 times.
 12624 commit_buffer_ = new std::atomic<int32_t>[buffer_size_];
36
2/2
✓ Branch 0 taken 12582 times.
✓ Branch 1 taken 42 times.
 12624 for (int i = 0; i < buffer_size_; i++)
37 12582 commit_buffer_[i].store(0);
38
39 int retval;
40 42 retval = pthread_cond_init(&sig_continue_trace_, NULL);
41 42 retval |= pthread_mutex_init(&sig_continue_trace_mutex_, NULL);
42 42 retval |= pthread_cond_init(&sig_flush_, NULL);
43 42 retval |= pthread_mutex_init(&sig_flush_mutex_, NULL);
44
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 42 times.
 42 assert(retval == 0);
45
46 42 active_ = true;
47 42 }
48
49
50 /**
51 * Trace a message. This is usually a lock-free procedure that just
52 * requires two fetch_and_add operations and a gettimeofday syscall.
53 * There are two exceptions:
54 * -# If the ring buffer is full, the function blocks until the flush
55 * thread made some space. Avoid that by carefully choosing size
56 * and threshold.
57 * -# If this message reaches the threshold, the flush thread gets
58 * signaled.
59 *
60 * \param[in] event Arbitrary code, for consistency applications should use one
61 * of the TraceEvents constants. Negative codes are reserved
62 * for internal use.
63 * \param[in] id Arbitrary id, for example file name or module name which is
64 * doing the trace.
65 * \return The sequence number which was used to trace the record
66 */
67 1036320 int32_t Tracer::DoTrace(const int event,
68 const PathString &path,
69 const string &msg) {
70 1036320 const int32_t my_seq_no = seq_no_.fetch_add(1);
71 timeval now;
72 1036320 gettimeofday(&now, NULL);
73 1071705 const int pos = my_seq_no % buffer_size_;
74
75
2/2
✓ Branch 1 taken 323283 times.
✓ Branch 2 taken 1051968 times.
 2785074 while (my_seq_no - flushed_.load() >= buffer_size_) {
76 timespec timeout;
77 int retval;
78 323283 GetTimespecRel(25, &timeout);
79 319233 retval = pthread_mutex_lock(&sig_continue_trace_mutex_);
80
1/2
✓ Branch 1 taken 348717 times.
✗ Branch 2 not taken.
 348717 retval |= pthread_cond_timedwait(&sig_continue_trace_,
81 &sig_continue_trace_mutex_, &timeout);
82 348717 retval |= pthread_mutex_unlock(&sig_continue_trace_mutex_);
83
2/4
✓ Branch 0 taken 338733 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 338733 times.
 338118 assert(retval == ETIMEDOUT || retval == 0);
84 }
85
86 1051968 ring_buffer_[pos].time_stamp = now;
87 1051968 ring_buffer_[pos].code = event;
88
1/2
✓ Branch 1 taken 1033299 times.
✗ Branch 2 not taken.
 1051968 ring_buffer_[pos].path = path;
89
1/2
✓ Branch 1 taken 1043646 times.
✗ Branch 2 not taken.
 1033299 ring_buffer_[pos].msg = msg;
90 1043646 commit_buffer_[pos].fetch_add(1);
91
92
2/2
✓ Branch 1 taken 116895 times.
✓ Branch 2 taken 943866 times.
 2104407 if (my_seq_no - flushed_.load() == flush_threshold_) {
93 116895 const MutexLockGuard m(&sig_flush_mutex_);
94 const int err_code
95 116898 __attribute__((unused)) = pthread_cond_signal(&sig_flush_);
96
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 116898 times.
 116898 assert(err_code == 0 && "Could not signal flush thread");
97 116898 }
98
99 1060620 return my_seq_no;
100 }
101
102
103 4377 void Tracer::Flush() {
104
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4377 times.
 4377 if (!active_)
105 ✗ return;
106
107
3/6
✓ Branch 2 taken 4356 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 4398 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 4428 times.
✗ Branch 9 not taken.
 4377 const int32_t save_seq_no = DoTrace(kEventFlush, PathString("Tracer", 6),
108 "flushed ring buffer");
109
2/2
✓ Branch 1 taken 3945 times.
✓ Branch 2 taken 4332 times.
 16689 while (flushed_.load() <= save_seq_no) {
110 timespec timeout;
111 int retval;
112
113 3945 int32_t expected_val = 0;
114 3945 flush_immediately_.compare_exchange_strong(expected_val, 1);
115 {
116 3936 const MutexLockGuard m(&sig_flush_mutex_);
117 4029 retval = pthread_cond_signal(&sig_flush_);
118
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4029 times.
 4029 assert(retval == 0);
119 4029 }
120
121 4017 GetTimespecRel(250, &timeout);
122 4011 retval = pthread_mutex_lock(&sig_continue_trace_mutex_);
123
1/2
✓ Branch 1 taken 4029 times.
✗ Branch 2 not taken.
 4029 retval |= pthread_cond_timedwait(&sig_continue_trace_,
124 &sig_continue_trace_mutex_, &timeout);
125 4029 retval |= pthread_mutex_unlock(&sig_continue_trace_mutex_);
126
3/4
✓ Branch 0 taken 3696 times.
✓ Branch 1 taken 270 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 3696 times.
 3966 assert(retval == ETIMEDOUT || retval == 0);
127 }
128 }
129
130
131 416466 void Tracer::GetTimespecRel(const int64_t ms, timespec *ts) {
132 timeval now;
133 416466 gettimeofday(&now, NULL);
134 414375 int64_t nsecs = now.tv_usec * 1000 + (ms % 1000) * 1000 * 1000;
135 414375 int carry = 0;
136
2/2
✓ Branch 0 taken 18138 times.
✓ Branch 1 taken 396237 times.
 414375 if (nsecs >= 1000 * 1000 * 1000) {
137 18138 carry = 1;
138 18138 nsecs -= 1000 * 1000 * 1000;
139 }
140 414375 ts->tv_sec = now.tv_sec + ms / 1000 + carry;
141 414375 ts->tv_nsec = nsecs;
142 414375 }
143
144
145 42 void *Tracer::MainFlush(void *data) {
146 42 Tracer *tracer = reinterpret_cast<Tracer *>(data);
147 int retval;
148 42 const MutexLockGuard m(&tracer->sig_flush_mutex_);
149
1/2
✓ Branch 2 taken 42 times.
✗ Branch 3 not taken.
 42 FILE *f = fopen(tracer->trace_file_.c_str(), "a");
150
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 42 times.
 42 assert(f != NULL && "Could not open trace file");
151 struct timespec timeout;
152
153 do {
154 421272 while ((tracer->terminate_flush_thread_.load() == 0)
155
2/2
✓ Branch 1 taken 419958 times.
✓ Branch 2 taken 1272 times.
 842460 && (tracer->flush_immediately_.load() == 0)
156
4/4
✓ Branch 0 taken 421230 times.
✓ Branch 1 taken 42 times.
✓ Branch 4 taken 96438 times.
✓ Branch 5 taken 324834 times.
 1682418 && ((tracer->seq_no_).load() - (tracer->flushed_).load()
157
2/2
✓ Branch 0 taken 96438 times.
✓ Branch 1 taken 323520 times.
 419958 <= tracer->flush_threshold_)) {
158 96438 tracer->GetTimespecRel(2000, &timeout);
159
1/2
✓ Branch 1 taken 96438 times.
✗ Branch 2 not taken.
 96438 retval = pthread_cond_timedwait(&tracer->sig_flush_,
160 &tracer->sig_flush_mutex_, &timeout);
161
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 96438 times.
 96438 assert(retval != EINVAL);
162 }
163
164 324834 const int base = tracer->flushed_.load() % tracer->buffer_size_;
165 324834 int pos, i = 0;
166 324834 while (
167 1442721 (i <= tracer->flush_threshold_)
168
4/4
✓ Branch 0 taken 1277679 times.
✓ Branch 1 taken 165042 times.
✓ Branch 2 taken 1117887 times.
✓ Branch 3 taken 324834 times.
 2720400 && ((tracer->commit_buffer_[pos = ((base + i) % tracer->buffer_size_)])
169
2/2
✓ Branch 1 taken 1117887 times.
✓ Branch 2 taken 159792 times.
 2555358 .load()
170 == 1)) {
171 1117887 string tmp;
172
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 1117887 tmp = StringifyTimeval(tracer->ring_buffer_[pos].time_stamp);
173
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 1117887 retval = tracer->WriteCsvFile(f, tmp);
174
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 1117887 retval |= fputc(',', f) - ',';
175
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 1117887 tmp = StringifyInt(tracer->ring_buffer_[pos].code);
176
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 1117887 retval = tracer->WriteCsvFile(f, tmp);
177
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 1117887 retval |= fputc(',', f) - ',';
178
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 1117887 retval |= tracer->WriteCsvFile(f,
179
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 2235774 tracer->ring_buffer_[pos].path.ToString());
180
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 1117887 retval |= fputc(',', f) - ',';
181
1/2
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
 1117887 retval |= tracer->WriteCsvFile(f, tracer->ring_buffer_[pos].msg);
182
2/4
✓ Branch 1 taken 1117887 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 1117887 times.
✗ Branch 5 not taken.
 1117887 retval |= (fputc(13, f) - 13) | (fputc(10, f) - 10);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1117887 times.
 1117887 assert(retval == 0);
184
185 1117887 tracer->commit_buffer_[pos].fetch_sub(1);
186 1117887 ++i;
187 1117887 }
188
1/2
✓ Branch 1 taken 324834 times.
✗ Branch 2 not taken.
 324834 retval = fflush(f);
189
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 324834 times.
 324834 assert(retval == 0);
190 324834 tracer->flushed_.fetch_add(i);
191 324834 int32_t expected_val = 1;
192 324834 tracer->flush_immediately_.compare_exchange_strong(expected_val, 0);
193
194 {
195 324834 const MutexLockGuard l(&tracer->sig_continue_trace_mutex_);
196 324834 retval = pthread_cond_broadcast(&tracer->sig_continue_trace_);
197
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 324834 times.
 324834 assert(retval == 0);
198 324834 }
199 324834 } while ((tracer->terminate_flush_thread_.load() == 0)
200
6/6
✓ Branch 0 taken 48 times.
✓ Branch 1 taken 324786 times.
✓ Branch 4 taken 6 times.
✓ Branch 5 taken 42 times.
✓ Branch 6 taken 324792 times.
✓ Branch 7 taken 42 times.
 324930 || ((tracer->flushed_).load() < (tracer->seq_no_).load()));
201
202
1/2
✓ Branch 1 taken 42 times.
✗ Branch 2 not taken.
 42 retval = fclose(f);
203
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 42 times.
 42 assert(retval == 0);
204 42 return NULL;
205 42 }
206
207
208 45 void Tracer::Spawn() {
209
2/2
✓ Branch 0 taken 42 times.
✓ Branch 1 taken 3 times.
 45 if (active_) {
210 42 const int retval = pthread_create(&thread_flush_, NULL, MainFlush, this);
211
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 42 times.
 42 assert(retval == 0);
212
213 42 spawned_ = true;
214
3/6
✓ Branch 2 taken 42 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 42 times.
✗ Branch 6 not taken.
✓ Branch 8 taken 42 times.
✗ Branch 9 not taken.
 42 DoTrace(kEventStart, PathString("Tracer", 6), "Trace buffer created");
215 }
216 45 }
217
218
219 869 Tracer::Tracer()
220 869 : active_(false)
221 869 , spawned_(false)
222 869 , buffer_size_(0)
223 869 , flush_threshold_(0)
224 869 , ring_buffer_(NULL)
225 869 , commit_buffer_(NULL) {
226 869 memset(&thread_flush_, 0, sizeof(thread_flush_));
227 869 seq_no_.store(0);
228 869 flushed_.store(0);
229 869 terminate_flush_thread_.store(0);
230 869 flush_immediately_.store(0);
231 869 }
232
233
234 911 Tracer::~Tracer() {
235
2/2
✓ Branch 0 taken 827 times.
✓ Branch 1 taken 42 times.
 869 if (!active_)
236 827 return;
237 int retval;
238
239
1/2
✓ Branch 0 taken 42 times.
✗ Branch 1 not taken.
 42 if (spawned_) {
240 42 DoTrace(kEventStop, PathString("Tracer", 6), "Destroying trace buffer...");
241
242 // Trigger flushing and wait for it
243 42 terminate_flush_thread_.fetch_add(1);
244 {
245 42 const MutexLockGuard m(&sig_flush_mutex_);
246 42 retval = pthread_cond_signal(&sig_flush_);
247
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 42 times.
 42 assert(retval == 0);
248 42 }
249 42 retval = pthread_join(thread_flush_, NULL);
250
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 42 times.
 42 assert(retval == 0);
251 }
252
253 42 retval = pthread_cond_destroy(&sig_continue_trace_);
254 42 retval |= pthread_mutex_destroy(&sig_continue_trace_mutex_);
255 42 retval |= pthread_cond_destroy(&sig_flush_);
256 42 retval |= pthread_mutex_destroy(&sig_flush_mutex_);
257
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 42 times.
 42 assert(retval == 0);
258
259
3/4
✓ Branch 0 taken 42 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 12582 times.
✓ Branch 3 taken 42 times.
 12624 delete[] ring_buffer_;
260
1/2
✓ Branch 0 taken 42 times.
✗ Branch 1 not taken.
 42 delete[] commit_buffer_;
261
2/2
✓ Branch 1 taken 42 times.
✓ Branch 2 taken 827 times.
 869 }
262
263
264 4471548 int Tracer::WriteCsvFile(FILE *fp, const string &field) {
265
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4471548 times.
 4471548 if (fp == NULL)
266 ✗ return 0;
267
268 int retval;
269
270
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4471548 times.
 4471548 if ((retval = fputc('"', fp)) != '"')
271 ✗ return retval;
272
273
2/2
✓ Branch 1 taken 64468464 times.
✓ Branch 2 taken 4471548 times.
 68940012 for (unsigned i = 0, l = field.length(); i < l; ++i) {
274
2/2
✓ Branch 1 taken 783000 times.
✓ Branch 2 taken 63685464 times.
 64468464 if (field[i] == '"') {
275
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 783000 times.
 783000 if ((retval = fputc('"', fp)) != '"')
276 ✗ return retval;
277 }
278
1/2
✗ Branch 3 not taken.
✓ Branch 4 taken 64468464 times.
 64468464 if ((retval = fputc(field[i], fp)) != field[i])
279 ✗ return retval;
280 }
281
282
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4471548 times.
 4471548 if ((retval = fputc('"', fp)) != '"')
283 ✗ return retval;
284
285 4471548 return 0;
286 }
287
288