GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/glue_buffer.cc
Date: 2026-05-19 11:45:12
Exec Total Coverage
Lines: 201 273 73.6%
Branches: 75 180 41.7%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "glue_buffer.h"
6
7 #include <errno.h>
8 #include <poll.h>
9 #include <unistd.h>
10
11 #include <cassert>
12 #include <cstdlib>
13 #include <cstring>
14 #include <string>
15
16 #include "util/exception.h"
17 #include "util/logging.h"
18 #include "util/mutex.h"
19 #include "util/posix.h"
20 #include "util/smalloc.h"
21
22 using namespace std; // NOLINT
23
24 namespace glue {
25
26 ✗ PathStore &PathStore::operator=(const PathStore &other) {
27 ✗ if (&other == this)
28 ✗ return *this;
29
30 ✗ delete string_heap_;
31 ✗ CopyFrom(other);
32 ✗ return *this;
33 }
34
35
36 ✗ PathStore::PathStore(const PathStore &other) { CopyFrom(other); }
37
38
39 ✗ void PathStore::CopyFrom(const PathStore &other) {
40 ✗ map_ = other.map_;
41
42 ✗ string_heap_ = new StringHeap(other.string_heap_->used());
43 ✗ const shash::Md5 empty_path = map_.empty_key();
44 ✗ for (unsigned i = 0; i < map_.capacity(); ++i) {
45 ✗ if (map_.keys()[i] != empty_path) {
46 ✗ (map_.values() + i)->name = string_heap_->AddString(
47 ✗ map_.values()[i].name.length(), map_.values()[i].name.data());
48 }
49 }
50 }
51
52
53 //------------------------------------------------------------------------------
54
55
56 358 void InodeTracker::InitLock() {
57 358 lock_ = reinterpret_cast<pthread_mutex_t *>(smalloc(sizeof(pthread_mutex_t)));
58 358 const int retval = pthread_mutex_init(lock_, NULL);
59
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 358 times.
 358 assert(retval == 0);
60 358 }
61
62
63 ✗ void InodeTracker::CopyFrom(const InodeTracker &other) {
64 ✗ assert(other.version_ == kVersion);
65 ✗ version_ = kVersion;
66 ✗ path_map_ = other.path_map_;
67 ✗ inode_ex_map_ = other.inode_ex_map_;
68 ✗ inode_references_ = other.inode_references_;
69 ✗ statistics_ = other.statistics_;
70 }
71
72
73
2/4
✓ Branch 2 taken 358 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 358 times.
✗ Branch 6 not taken.
 358 InodeTracker::InodeTracker() {
74 358 version_ = kVersion;
75 358 InitLock();
76 358 }
77
78
79 ✗ InodeTracker::InodeTracker(const InodeTracker &other) {
80 ✗ CopyFrom(other);
81 ✗ InitLock();
82 }
83
84
85 ✗ InodeTracker &InodeTracker::operator=(const InodeTracker &other) {
86 ✗ if (&other == this)
87 ✗ return *this;
88
89 ✗ CopyFrom(other);
90 ✗ return *this;
91 }
92
93
94 356 InodeTracker::~InodeTracker() {
95 356 pthread_mutex_destroy(lock_);
96 356 free(lock_);
97 356 }
98
99
100 //------------------------------------------------------------------------------
101
102 324 DentryTracker::DentryTracker() : version_(kVersion), is_active_(true) {
103 324 pipe_terminate_[0] = pipe_terminate_[1] = -1;
104 324 cleaning_interval_ms_ = -1;
105 324 InitLock();
106 324 }
107
108
109 423 DentryTracker::~DentryTracker() {
110
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 419 times.
 423 if (pipe_terminate_[1] >= 0) {
111 4 char t = 'T';
112 4 WritePipe(pipe_terminate_[1], &t, 1);
113 4 pthread_join(thread_cleaner_, NULL);
114 4 ClosePipe(pipe_terminate_);
115 }
116 423 pthread_mutex_destroy(lock_);
117 423 free(lock_);
118 423 }
119
120
121 103 DentryTracker::DentryTracker(const DentryTracker &other) {
122
1/2
✓ Branch 1 taken 103 times.
✗ Branch 2 not taken.
 103 CopyFrom(other);
123 103 pipe_terminate_[0] = pipe_terminate_[1] = -1;
124 103 cleaning_interval_ms_ = -1;
125 103 InitLock();
126 103 }
127
128
129 ✗ DentryTracker &DentryTracker::operator=(const DentryTracker &other) {
130 ✗ if (&other == this)
131 ✗ return *this;
132
133 ✗ Lock();
134 ✗ CopyFrom(other);
135 ✗ Unlock();
136 ✗ return *this;
137 }
138
139
140 103 void DentryTracker::CopyFrom(const DentryTracker &other) {
141
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 103 times.
 103 assert(other.version_ == kVersion);
142
143 103 version_ = kVersion;
144 103 statistics_ = other.statistics_;
145 103 is_active_ = other.is_active_;
146 103 entries_ = other.entries_;
147 103 }
148
149
150 103 DentryTracker *DentryTracker::Move() {
151 103 Lock();
152
1/2
✓ Branch 2 taken 103 times.
✗ Branch 3 not taken.
 103 DentryTracker *new_tracker = new DentryTracker(*this);
153 103 statistics_.num_remove += entries_.size();
154 103 entries_.Clear();
155 103 Unlock();
156 103 return new_tracker;
157 }
158
159
160 4 void DentryTracker::SpawnCleaner(unsigned interval_s) {
161
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 assert(pipe_terminate_[0] == -1);
162 4 cleaning_interval_ms_ = interval_s * 1000;
163
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (cleaning_interval_ms_ == 0)
164 ✗ cleaning_interval_ms_ = -1;
165 4 MakePipe(pipe_terminate_);
166 4 const int retval = pthread_create(&thread_cleaner_, NULL, MainCleaner, this);
167
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 assert(retval == 0);
168 4 }
169
170
171 4 void *DentryTracker::MainCleaner(void *data) {
172 4 DentryTracker *tracker = reinterpret_cast<DentryTracker *>(data);
173
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 LogCvmfs(kLogCvmfs, kLogDebug, "starting negative entry cache cleaner");
174
175 struct pollfd watch_term;
176 4 watch_term.fd = tracker->pipe_terminate_[0];
177 4 watch_term.events = POLLIN | POLLPRI;
178 4 int timeout_ms = tracker->cleaning_interval_ms_;
179 ;
180 4 uint64_t deadline = platform_monotonic_time() + timeout_ms / 1000;
181 while (true) {
182 16 watch_term.revents = 0;
183
1/2
✓ Branch 1 taken 16 times.
✗ Branch 2 not taken.
 16 const int retval = poll(&watch_term, 1, timeout_ms);
184
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 16 times.
 16 if (retval < 0) {
185 ✗ if (errno == EINTR) {
186 ✗ if (timeout_ms >= 0) {
187 ✗ const uint64_t now = platform_monotonic_time();
188 ✗ timeout_ms = (now > deadline) ? 0 : (deadline - now) * 1000;
189 }
190 12 continue;
191 }
192 ✗ abort();
193 }
194 16 timeout_ms = tracker->cleaning_interval_ms_;
195 16 deadline = platform_monotonic_time() + timeout_ms / 1000;
196
197
2/2
✓ Branch 0 taken 12 times.
✓ Branch 1 taken 4 times.
 16 if (retval == 0) {
198
1/2
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
 12 LogCvmfs(kLogCvmfs, kLogDebug, "negative entry cleaner: pruning");
199
1/2
✓ Branch 1 taken 12 times.
✗ Branch 2 not taken.
 12 tracker->Prune();
200 12 continue;
201 }
202
203
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 assert(watch_term.revents != 0);
204
205 4 char c = 0;
206
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 ReadPipe(tracker->pipe_terminate_[0], &c, 1);
207
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 assert(c == 'T');
208 4 break;
209 12 }
210
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 LogCvmfs(kLogCvmfs, kLogDebug, "stopping negative entry cache cleaner");
211 4 return NULL;
212 }
213
214
215 427 void DentryTracker::InitLock() {
216 427 lock_ = reinterpret_cast<pthread_mutex_t *>(smalloc(sizeof(pthread_mutex_t)));
217 427 const int retval = pthread_mutex_init(lock_, NULL);
218
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 427 times.
 427 assert(retval == 0);
219 427 }
220
221
222 115 void DentryTracker::Prune() {
223 115 Lock();
224 115 DoPrune(platform_monotonic_time());
225 115 Unlock();
226 115 }
227
228
229 135 DentryTracker::Cursor DentryTracker::BeginEnumerate() {
230 135 Entry *head = NULL;
231 135 Lock();
232
1/2
✓ Branch 1 taken 135 times.
✗ Branch 2 not taken.
 135 entries_.Peek(&head);
233 135 return Cursor(head);
234 }
235
236
237 42358 bool DentryTracker::NextEntry(Cursor *cursor, uint64_t *inode_parent,
238 NameString *name) {
239
2/2
✓ Branch 0 taken 59 times.
✓ Branch 1 taken 42299 times.
 42358 if (cursor->head == NULL)
240 59 return false;
241
2/2
✓ Branch 1 taken 43 times.
✓ Branch 2 taken 42256 times.
 42299 if (cursor->pos >= entries_.size())
242 43 return false;
243 42256 Entry *e = cursor->head + cursor->pos;
244 42256 *inode_parent = e->inode_parent;
245 42256 *name = e->name;
246 42256 cursor->pos++;
247 42256 return true;
248 }
249
250
251 135 void DentryTracker::EndEnumerate(Cursor * /* cursor */) { Unlock(); }
252
253
254 //------------------------------------------------------------------------------
255
256
257
1/2
✓ Branch 3 taken 225 times.
✗ Branch 4 not taken.
 225 PageCacheTracker::PageCacheTracker() : version_(kVersion), is_active_(true) {
258
1/2
✓ Branch 1 taken 225 times.
✗ Branch 2 not taken.
 225 map_.Init(16, 0, hasher_inode);
259 225 InitLock();
260 225 }
261
262
263 223 PageCacheTracker::~PageCacheTracker() {
264 223 pthread_mutex_destroy(lock_);
265 223 free(lock_);
266 223 }
267
268
269 ✗ PageCacheTracker::PageCacheTracker(const PageCacheTracker &other) {
270 ✗ CopyFrom(other);
271 ✗ InitLock();
272 }
273
274
275 ✗ PageCacheTracker &PageCacheTracker::operator=(const PageCacheTracker &other) {
276 ✗ if (&other == this)
277 ✗ return *this;
278
279 ✗ const MutexLockGuard guard(lock_);
280 ✗ CopyFrom(other);
281 ✗ return *this;
282 }
283
284
285 ✗ void PageCacheTracker::CopyFrom(const PageCacheTracker &other) {
286 ✗ assert(other.version_ == kVersion);
287
288 ✗ version_ = kVersion;
289 ✗ is_active_ = other.is_active_;
290 ✗ statistics_ = other.statistics_;
291
292 ✗ map_.Init(16, 0, hasher_inode);
293 ✗ map_ = other.map_;
294 ✗ stat_store_ = other.stat_store_;
295 }
296
297
298 225 void PageCacheTracker::InitLock() {
299 225 lock_ = reinterpret_cast<pthread_mutex_t *>(smalloc(sizeof(pthread_mutex_t)));
300 225 const int retval = pthread_mutex_init(lock_, NULL);
301
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 225 times.
 225 assert(retval == 0);
302 225 }
303
304 46 PageCacheTracker::OpenDirectives PageCacheTracker::Open(
305 uint64_t inode, const shash::Any &hash, const struct stat &info)
306 {
307 46 OpenDirectives open_directives;
308 // Old behavior: always flush page cache on open
309
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 42 times.
 46 if (!is_active_)
310 4 return open_directives;
311
312
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 42 times.
 42 if (inode != info.st_ino) {
313 ✗ PANIC(kLogStderr | kLogDebug,
314 "invalid entry on open: %" PRIu64 " with st_ino=%" PRIu64,
315 " hash=%s size=%" PRIu64, inode, info.st_ino, hash.ToString().c_str(),
316 info.st_size);
317 }
318
319 42 const MutexLockGuard guard(lock_);
320
321
1/2
✓ Branch 1 taken 42 times.
✗ Branch 2 not taken.
 42 Entry entry;
322
1/2
✓ Branch 1 taken 42 times.
✗ Branch 2 not taken.
 42 const bool retval = map_.Lookup(inode, &entry);
323
2/2
✓ Branch 0 taken 14 times.
✓ Branch 1 taken 28 times.
 42 if (!retval) {
324 14 open_directives.keep_cache = true;
325 14 open_directives.direct_io = false;
326 14 statistics_.n_insert++;
327 14 statistics_.n_open_cached++;
328
329 14 entry.nopen = 1;
330
1/2
✓ Branch 1 taken 14 times.
✗ Branch 2 not taken.
 14 entry.idx_stat = stat_store_.Add(info);
331 14 entry.hash = hash;
332
1/2
✓ Branch 1 taken 14 times.
✗ Branch 2 not taken.
 14 map_.Insert(inode, entry);
333 14 return open_directives;
334 }
335
336
2/2
✓ Branch 1 taken 18 times.
✓ Branch 2 taken 10 times.
 28 if (entry.hash == hash) {
337 18 open_directives.direct_io = false;
338
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 14 times.
 18 if (entry.nopen < 0) {
339 // The page cache is still in the transition phase and may contain old
340 // content. So trigger a flush of the cache in any case.
341 4 open_directives.keep_cache = false;
342 4 statistics_.n_open_flush++;
343 4 entry.nopen--;
344
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 map_.Insert(inode, entry);
345 4 return open_directives;
346 } else {
347 14 open_directives.keep_cache = true;
348 14 statistics_.n_open_cached++;
349
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 14 times.
 14 if (entry.nopen++ == 0)
350 ✗ entry.idx_stat = stat_store_.Add(info);
351
1/2
✓ Branch 1 taken 14 times.
✗ Branch 2 not taken.
 14 map_.Insert(inode, entry);
352 14 return open_directives;
353 }
354 }
355
356 // Page cache mismatch and old data has still open file attached to it,
357 // circumvent the page cache entirely and use direct I/O. In this case,
358 // cvmfs_close() will _not_ call Close().
359
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 4 times.
 10 if (entry.nopen != 0) {
360 6 open_directives.keep_cache = true;
361 6 open_directives.direct_io = true;
362 6 statistics_.n_open_direct++;
363 6 return open_directives;
364 }
365
366 // Stale data in the page cache, start the transition phase in which newly
367 // opened files flush the page cache and re-populate it with the new hash.
368 // The first file to reach Close() will finish the transition phase and
369 // mark the new hash as committed.
370 4 open_directives.direct_io = false;
371 4 open_directives.keep_cache = false;
372 4 statistics_.n_open_flush++;
373 4 entry.hash = hash;
374
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 entry.idx_stat = stat_store_.Add(info);
375 4 entry.nopen = -1;
376
1/2
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
 4 map_.Insert(inode, entry);
377 4 return open_directives;
378 42 }
379
380 ✗ PageCacheTracker::OpenDirectives PageCacheTracker::OpenDirect() {
381 ✗ OpenDirectives open_directives(true, true);
382 // Old behavior: always flush page cache on open
383 ✗ if (!is_active_)
384 ✗ return open_directives;
385
386 ✗ const MutexLockGuard guard(lock_);
387 ✗ statistics_.n_open_direct++;
388 ✗ return open_directives;
389 }
390
391 34 void PageCacheTracker::Close(uint64_t inode) {
392
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 30 times.
 34 if (!is_active_)
393 4 return;
394
395 30 const MutexLockGuard guard(lock_);
396
1/2
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
 30 Entry entry;
397
1/2
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
 30 bool retval = map_.Lookup(inode, &entry);
398
399 30 if (!AssertOrLog(retval, kLogCvmfs, kLogSyslogWarn | kLogDebug,
400 "PageCacheTracker::Close Race condition? "
401 "Did not find inode %lu",
402 inode)
403
3/6
✓ Branch 0 taken 30 times.
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 30 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 30 times.
 30 || !AssertOrLog(entry.nopen != 0, kLogCvmfs, kLogSyslogWarn | kLogDebug,
404 "PageCacheTracker::Close Race condition? "
405 "Inode %lu has no open entries",
406 inode)) {
407 ✗ return;
408 }
409
410 30 const int32_t old_open = entry.nopen;
411
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 26 times.
 30 if (entry.nopen < 0) {
412 // At this point we know that any stale data has been flushed from the
413 // cache and only data related to the currently booked content hash
414 // can be present. So clear the transition bit (sign bit).
415 4 entry.nopen = -entry.nopen;
416 }
417 30 entry.nopen--;
418
2/2
✓ Branch 0 taken 13 times.
✓ Branch 1 taken 17 times.
 30 if (entry.nopen == 0) {
419 // File closed, remove struct stat information
420
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13 times.
 13 if (entry.idx_stat < 0) {
421 ✗ PANIC(kLogSyslogErr | kLogDebug,
422 "page cache tracker: missing stat entry! Entry info: inode %" PRIu64
423 " - open counter %d - hash %s",
424 inode, old_open, entry.hash.ToString().c_str());
425 }
426
1/2
✓ Branch 1 taken 13 times.
✗ Branch 2 not taken.
 13 const uint64_t inode_update = stat_store_.Erase(entry.idx_stat);
427
1/2
✓ Branch 1 taken 13 times.
✗ Branch 2 not taken.
 13 Entry entry_update;
428
1/2
✓ Branch 1 taken 13 times.
✗ Branch 2 not taken.
 13 retval = map_.Lookup(inode_update, &entry_update);
429
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13 times.
 13 if (!retval) {
430 ✗ PANIC(kLogSyslogErr | kLogDebug,
431 "invalid inode in page cache tracker: inode %" PRIu64
432 ", replacing %" PRIu64,
433 inode_update, inode);
434 }
435 13 entry_update.idx_stat = entry.idx_stat;
436
1/2
✓ Branch 1 taken 13 times.
✗ Branch 2 not taken.
 13 map_.Insert(inode_update, entry_update);
437 13 entry.idx_stat = -1;
438 }
439
1/2
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
 30 map_.Insert(inode, entry);
440
1/2
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
 30 }
441
442 8 PageCacheTracker::EvictRaii::EvictRaii(PageCacheTracker *t) : tracker_(t) {
443 8 const int retval = pthread_mutex_lock(tracker_->lock_);
444
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8 times.
 8 assert(retval == 0);
445 8 }
446
447 8 PageCacheTracker::EvictRaii::~EvictRaii() {
448 8 const int retval = pthread_mutex_unlock(tracker_->lock_);
449
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8 times.
 8 assert(retval == 0);
450 8 }
451
452 8 void PageCacheTracker::EvictRaii::Evict(uint64_t inode) {
453
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 4 times.
 8 if (!tracker_->is_active_)
454 4 return;
455
456 4 const bool contained_inode = tracker_->map_.Erase(inode);
457
1/2
✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
 4 if (contained_inode)
458 4 tracker_->statistics_.n_remove++;
459 }
460
461 } // namespace glue
462