GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/cache_ram.cc
Date: 2026-06-21 02:37:04
Exec Total Coverage
Lines: 191 229 83.4%
Branches: 100 208 48.1%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "cache_ram.h"
6
7 #include <errno.h>
8
9 #include <algorithm>
10 #include <cassert>
11 #include <cstring>
12 #include <new>
13
14 #include "kvstore.h"
15 #include "util/logging.h"
16 #include "util/posix.h"
17 #include "util/string.h"
18
19 using namespace std; // NOLINT
20
21 const shash::Any RamCacheManager::kInvalidHandle;
22
23 ✗ string RamCacheManager::Describe() {
24 return "Internal in-memory cache manager (size "
25 ✗ + StringifyInt(max_size_ / (1024 * 1024)) + "MB)\n";
26 }
27
28
29 392 RamCacheManager::RamCacheManager(uint64_t max_size,
30 unsigned max_entries,
31 MemoryKvStore::MemoryAllocator alloc,
32 392 perf::StatisticsTemplate statistics)
33 392 : max_size_(max_size)
34
1/2
✓ Branch 1 taken 392 times.
✗ Branch 2 not taken.
 392 , fd_table_(max_entries, ReadOnlyHandle())
35 // TODO(jblomer): the number of slots in the kv-stores should _not_ be the
36 // number of open files.
37
1/2
✓ Branch 1 taken 392 times.
✗ Branch 2 not taken.
 392 , regular_entries_(max_entries,
38 alloc,
39 max_size,
40
2/4
✓ Branch 2 taken 392 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 392 times.
✗ Branch 6 not taken.
 784 perf::StatisticsTemplate("kv.regular", statistics))
41
1/2
✓ Branch 1 taken 392 times.
✗ Branch 2 not taken.
 392 , volatile_entries_(max_entries,
42 alloc,
43 max_size,
44
2/4
✓ Branch 2 taken 392 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 392 times.
✗ Branch 6 not taken.
 784 perf::StatisticsTemplate("kv.volatile", statistics))
45
2/4
✓ Branch 3 taken 392 times.
✗ Branch 4 not taken.
✓ Branch 6 taken 392 times.
✗ Branch 7 not taken.
 784 , counters_(statistics) {
46 392 const int retval = pthread_rwlock_init(&rwlock_, NULL);
47
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 392 times.
 392 assert(retval == 0);
48
1/2
✓ Branch 1 taken 392 times.
✗ Branch 2 not taken.
 392 LogCvmfs(kLogCache, kLogDebug, "max %lu B, %u entries", max_size,
49 max_entries);
50
1/2
✓ Branch 1 taken 392 times.
✗ Branch 2 not taken.
 392 LogCvmfs(kLogCache, kLogDebug | kLogSyslogWarn,
51 "DEPRECATION WARNING: The RAM cache manager is depcreated and "
52 "will be removed from future releases.");
53 392 }
54
55
56 1088 RamCacheManager::~RamCacheManager() { pthread_rwlock_destroy(&rwlock_); }
57
58
59 220727 int RamCacheManager::AddFd(const ReadOnlyHandle &handle) {
60 220727 const int result = fd_table_.OpenFd(handle);
61
2/2
✓ Branch 0 taken 20 times.
✓ Branch 1 taken 220707 times.
 220727 if (result == -ENFILE) {
62 20 LogCvmfs(kLogCache, kLogDebug, "too many open files");
63 20 perf::Inc(counters_.n_enfile);
64 }
65 220727 return result;
66 }
67
68
69 144 bool RamCacheManager::AcquireQuotaManager(QuotaManager *quota_mgr) {
70
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 144 times.
 144 assert(quota_mgr != NULL);
71 144 quota_mgr_ = quota_mgr;
72 144 LogCvmfs(kLogCache, kLogDebug, "set quota manager");
73 144 return true;
74 }
75
76
77 156 int RamCacheManager::Open(const LabeledObject &object) {
78 156 const WriteLockGuard guard(rwlock_);
79
1/2
✓ Branch 1 taken 156 times.
✗ Branch 2 not taken.
 312 return DoOpen(object.id);
80 156 }
81
82
83 317 int RamCacheManager::DoOpen(const shash::Any &id) {
84 bool ok;
85 bool is_volatile;
86
1/2
✓ Branch 1 taken 317 times.
✗ Branch 2 not taken.
 317 const MemoryBuffer buf;
87
88
3/4
✓ Branch 1 taken 317 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 225 times.
✓ Branch 4 taken 92 times.
 317 if (regular_entries_.Contains(id)) {
89 225 is_volatile = false;
90
3/4
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 90 times.
 92 } else if (volatile_entries_.Contains(id)) {
91 2 is_volatile = true;
92 } else {
93
2/4
✓ Branch 1 taken 90 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 90 times.
✗ Branch 6 not taken.
 90 LogCvmfs(kLogCache, kLogDebug, "miss for %s", id.ToString().c_str());
94 90 perf::Inc(counters_.n_openmiss);
95 90 return -ENOENT;
96 }
97 227 const ReadOnlyHandle generic_handle(id, is_volatile);
98
1/2
✓ Branch 1 taken 227 times.
✗ Branch 2 not taken.
 227 const int fd = AddFd(generic_handle);
99
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 227 times.
 227 if (fd < 0) {
100 ✗ LogCvmfs(kLogCache, kLogDebug, "error while opening %s: %s",
101 ✗ id.ToString().c_str(), strerror(-fd));
102 ✗ return fd;
103 }
104
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 225 times.
 227 if (is_volatile) {
105
1/2
✓ Branch 2 taken 2 times.
✗ Branch 3 not taken.
 2 LogCvmfs(kLogCache, kLogDebug, "hit in volatile entries for %s",
106
1/2
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
 4 id.ToString().c_str());
107 2 perf::Inc(counters_.n_openvolatile);
108 } else {
109
1/2
✓ Branch 2 taken 225 times.
✗ Branch 3 not taken.
 225 LogCvmfs(kLogCache, kLogDebug, "hit in regular entries for %s",
110
1/2
✓ Branch 1 taken 225 times.
✗ Branch 2 not taken.
 450 id.ToString().c_str());
111 225 perf::Inc(counters_.n_openregular);
112 }
113
1/2
✓ Branch 2 taken 227 times.
✗ Branch 3 not taken.
 227 ok = GetStore(generic_handle)->IncRef(id);
114
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 227 times.
 227 assert(ok);
115 227 return fd;
116 }
117
118
119 63 int64_t RamCacheManager::GetSize(int fd) {
120 63 const ReadLockGuard guard(rwlock_);
121
1/2
✓ Branch 1 taken 63 times.
✗ Branch 2 not taken.
 63 const ReadOnlyHandle generic_handle = fd_table_.GetHandle(fd);
122
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 63 times.
 63 if (generic_handle.handle == kInvalidHandle) {
123 ✗ LogCvmfs(kLogCache, kLogDebug, "bad fd %d on GetSize", fd);
124 ✗ return -EBADF;
125 }
126 63 perf::Inc(counters_.n_getsize);
127
1/2
✓ Branch 2 taken 63 times.
✗ Branch 3 not taken.
 63 return GetStore(generic_handle)->GetSize(generic_handle.handle);
128 63 }
129
130
131 220587 int RamCacheManager::Close(int fd) {
132 bool rc;
133
134 220587 const WriteLockGuard guard(rwlock_);
135
1/2
✓ Branch 1 taken 220587 times.
✗ Branch 2 not taken.
 220587 const ReadOnlyHandle generic_handle = fd_table_.GetHandle(fd);
136
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 220587 times.
 220587 if (generic_handle.handle == kInvalidHandle) {
137 ✗ LogCvmfs(kLogCache, kLogDebug, "bad fd %d on Close", fd);
138 ✗ return -EBADF;
139 }
140
1/2
✓ Branch 2 taken 220587 times.
✗ Branch 3 not taken.
 220587 rc = GetStore(generic_handle)->Unref(generic_handle.handle);
141
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 220587 times.
 220587 assert(rc);
142
143
1/2
✓ Branch 1 taken 220587 times.
✗ Branch 2 not taken.
 220587 const int rc_int = fd_table_.CloseFd(fd);
144
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 220587 times.
 220587 assert(rc_int == 0);
145
1/2
✓ Branch 1 taken 220587 times.
✗ Branch 2 not taken.
 220587 LogCvmfs(kLogCache, kLogDebug, "closed fd %d", fd);
146 220587 perf::Inc(counters_.n_close);
147 220587 return 0;
148 220587 }
149
150
151 23 int64_t RamCacheManager::Pread(int fd,
152 void *buf,
153 uint64_t size,
154 uint64_t offset) {
155 23 const ReadLockGuard guard(rwlock_);
156
1/2
✓ Branch 1 taken 23 times.
✗ Branch 2 not taken.
 23 const ReadOnlyHandle generic_handle = fd_table_.GetHandle(fd);
157
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 23 times.
 23 if (generic_handle.handle == kInvalidHandle) {
158 ✗ LogCvmfs(kLogCache, kLogDebug, "bad fd %d on Pread", fd);
159 ✗ return -EBADF;
160 }
161 23 perf::Inc(counters_.n_pread);
162 return GetStore(generic_handle)
163
1/2
✓ Branch 2 taken 23 times.
✗ Branch 3 not taken.
 23 ->Read(generic_handle.handle, buf, size, offset);
164 23 }
165
166
167 220520 int RamCacheManager::Dup(int fd) {
168 bool ok;
169 int rc;
170 220520 const WriteLockGuard guard(rwlock_);
171
1/2
✓ Branch 1 taken 220520 times.
✗ Branch 2 not taken.
 220520 const ReadOnlyHandle generic_handle = fd_table_.GetHandle(fd);
172
2/2
✓ Branch 1 taken 20 times.
✓ Branch 2 taken 220500 times.
 220520 if (generic_handle.handle == kInvalidHandle) {
173
1/2
✓ Branch 1 taken 20 times.
✗ Branch 2 not taken.
 20 LogCvmfs(kLogCache, kLogDebug, "bad fd %d on Dup", fd);
174 20 return -EBADF;
175 }
176
1/2
✓ Branch 1 taken 220500 times.
✗ Branch 2 not taken.
 220500 rc = AddFd(generic_handle);
177
2/2
✓ Branch 0 taken 20 times.
✓ Branch 1 taken 220480 times.
 220500 if (rc < 0)
178 20 return rc;
179
1/2
✓ Branch 2 taken 220480 times.
✗ Branch 3 not taken.
 220480 ok = GetStore(generic_handle)->IncRef(generic_handle.handle);
180
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 220480 times.
 220480 assert(ok);
181
1/2
✓ Branch 1 taken 220480 times.
✗ Branch 2 not taken.
 220480 LogCvmfs(kLogCache, kLogDebug, "dup fd %d", fd);
182 220480 perf::Inc(counters_.n_dup);
183 220480 return rc;
184 220520 }
185
186
187 /**
188 * For a RAM cache, read-ahead is a no-op.
189 */
190 ✗ int RamCacheManager::Readahead(int fd) {
191 ✗ const ReadLockGuard guard(rwlock_);
192 ✗ const ReadOnlyHandle generic_handle = fd_table_.GetHandle(fd);
193 ✗ if (generic_handle.handle == kInvalidHandle) {
194 ✗ LogCvmfs(kLogCache, kLogDebug, "bad fd %d on Readahead", fd);
195 ✗ return -EBADF;
196 }
197 ✗ LogCvmfs(kLogCache, kLogDebug, "readahead (no-op) on %d", fd);
198 ✗ perf::Inc(counters_.n_readahead);
199 ✗ return 0;
200 }
201
202
203 607 int RamCacheManager::StartTxn(const shash::Any &id, uint64_t size, void *txn) {
204
1/2
✓ Branch 2 taken 607 times.
✗ Branch 3 not taken.
 607 LogCvmfs(kLogCache, kLogDebug, "new transaction with id %s",
205 1214 id.ToString().c_str());
206 607 Transaction *transaction = new (txn) Transaction();
207 607 transaction->buffer.id = id;
208 607 transaction->pos = 0;
209 607 transaction->expected_size = size;
210
1/2
✓ Branch 0 taken 607 times.
✗ Branch 1 not taken.
 607 transaction->buffer.size = (size == kSizeUnknown) ? kPageSize : size;
211 607 transaction->buffer.address = malloc(transaction->buffer.size);
212
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 607 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 607 if (!transaction->buffer.address && size > 0) {
213 ✗ LogCvmfs(kLogCache, kLogDebug, "failed to allocate %lu B for %s", size,
214 ✗ id.ToString().c_str());
215 ✗ return -errno;
216 }
217 607 perf::Inc(counters_.n_starttxn);
218 607 return 0;
219 }
220
221
222 46 void RamCacheManager::CtrlTxn(const Label &label, const int /* flags */,
223 void *txn) {
224 46 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
225 46 transaction->description = label.GetDescription();
226 46 transaction->buffer.object_flags = label.flags;
227
1/2
✓ Branch 2 taken 46 times.
✗ Branch 3 not taken.
 46 LogCvmfs(kLogCache, kLogDebug, "modified transaction %s",
228 92 transaction->buffer.id.ToString().c_str());
229 46 }
230
231
232 646 int64_t RamCacheManager::Write(const void *buf, uint64_t size, void *txn) {
233 646 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
234
235
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 646 times.
 646 assert(transaction->pos <= transaction->buffer.size);
236
2/2
✓ Branch 0 taken 20 times.
✓ Branch 1 taken 626 times.
 646 if (transaction->pos + size > transaction->buffer.size) {
237
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 20 times.
 20 if (transaction->expected_size == kSizeUnknown) {
238 ✗ perf::Inc(counters_.n_realloc);
239 ✗ const size_t new_size = max(2 * transaction->buffer.size,
240 ✗ static_cast<size_t>(size + transaction->pos));
241 ✗ LogCvmfs(kLogCache, kLogDebug, "reallocate transaction for %s to %lu B",
242 ✗ transaction->buffer.id.ToString().c_str(),
243 transaction->buffer.size);
244 ✗ void *new_ptr = realloc(transaction->buffer.address, new_size);
245 ✗ if (!new_ptr) {
246 ✗ LogCvmfs(kLogCache, kLogDebug, "failed to allocate %lu B for %s",
247 ✗ new_size, transaction->buffer.id.ToString().c_str());
248 ✗ return -EIO;
249 }
250 ✗ transaction->buffer.address = new_ptr;
251 ✗ transaction->buffer.size = new_size;
252 } else {
253 20 LogCvmfs(kLogCache, kLogDebug,
254 "attempted to write more than requested (%lu>%zu)", size,
255 transaction->buffer.size);
256 20 return -EFBIG;
257 }
258 }
259
260
2/4
✓ Branch 0 taken 626 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 626 times.
✗ Branch 3 not taken.
 626 if (transaction->buffer.address && buf) {
261 // LogCvmfs(kLogCache, kLogDebug, "copy %u bytes of transaction %s",
262 // size, transaction->id.ToString().c_str());
263 626 memcpy(static_cast<char *>(transaction->buffer.address) + transaction->pos,
264 buf, size);
265 }
266 626 transaction->pos += size;
267 626 perf::Inc(counters_.n_write);
268 626 return size;
269 }
270
271
272 21 int RamCacheManager::Reset(void *txn) {
273 21 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
274 21 transaction->pos = 0;
275
1/2
✓ Branch 2 taken 21 times.
✗ Branch 3 not taken.
 21 LogCvmfs(kLogCache, kLogDebug, "reset transaction %s",
276 42 transaction->buffer.id.ToString().c_str());
277 21 perf::Inc(counters_.n_reset);
278 21 return 0;
279 }
280
281
282 181 int RamCacheManager::OpenFromTxn(void *txn) {
283 181 const WriteLockGuard guard(rwlock_);
284 181 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
285
1/2
✓ Branch 1 taken 181 times.
✗ Branch 2 not taken.
 181 const int64_t retval = CommitToKvStore(transaction);
286
2/2
✓ Branch 0 taken 20 times.
✓ Branch 1 taken 161 times.
 181 if (retval < 0) {
287
1/2
✓ Branch 3 taken 20 times.
✗ Branch 4 not taken.
 40 LogCvmfs(kLogCache, kLogDebug,
288 "error while committing transaction on %s: %s",
289
1/2
✓ Branch 1 taken 20 times.
✗ Branch 2 not taken.
 40 transaction->buffer.id.ToString().c_str(), strerror(-retval));
290 20 return retval;
291 }
292
1/2
✓ Branch 2 taken 161 times.
✗ Branch 3 not taken.
 161 LogCvmfs(kLogCache, kLogDebug, "open pending transaction for %s",
293
1/2
✓ Branch 1 taken 161 times.
✗ Branch 2 not taken.
 322 transaction->buffer.id.ToString().c_str());
294 161 perf::Inc(counters_.n_committxn);
295
1/2
✓ Branch 1 taken 161 times.
✗ Branch 2 not taken.
 161 return DoOpen(transaction->buffer.id);
296 181 }
297
298
299 21 int RamCacheManager::AbortTxn(void *txn) {
300 21 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
301 21 free(transaction->buffer.address);
302
1/2
✓ Branch 2 taken 21 times.
✗ Branch 3 not taken.
 21 LogCvmfs(kLogCache, kLogDebug, "abort transaction %s",
303 42 transaction->buffer.id.ToString().c_str());
304 21 perf::Inc(counters_.n_aborttxn);
305 21 return 0;
306 }
307
308
309 466 int RamCacheManager::CommitTxn(void *txn) {
310 466 const WriteLockGuard guard(rwlock_);
311 466 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
312 466 perf::Inc(counters_.n_committxn);
313
1/2
✓ Branch 1 taken 466 times.
✗ Branch 2 not taken.
 466 const int64_t rc = CommitToKvStore(transaction);
314
2/2
✓ Branch 0 taken 20 times.
✓ Branch 1 taken 446 times.
 466 if (rc < 0)
315 20 return rc;
316 446 free(transaction->buffer.address);
317 446 return rc;
318 466 }
319
320
321 647 int64_t RamCacheManager::CommitToKvStore(Transaction *transaction) {
322 MemoryKvStore *store;
323
324
2/2
✓ Branch 0 taken 22 times.
✓ Branch 1 taken 625 times.
 647 if (transaction->buffer.object_flags & CacheManager::kLabelVolatile) {
325 22 store = &volatile_entries_;
326 } else {
327 625 store = &regular_entries_;
328 }
329
2/2
✓ Branch 0 taken 627 times.
✓ Branch 1 taken 20 times.
 647 if ((transaction->buffer.object_flags & CacheManager::kLabelPinned)
330
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 627 times.
 627 || (transaction->buffer.object_flags & CacheManager::kLabelCatalog)) {
331 20 transaction->buffer.refcount = 1;
332 } else {
333 627 transaction->buffer.refcount = 0;
334 }
335
336 647 const int64_t regular_size = regular_entries_.GetUsed();
337 647 const int64_t volatile_size = volatile_entries_.GetUsed();
338 647 int64_t overrun = regular_size + volatile_size + transaction->buffer.size
339 647 - max_size_;
340
341
2/2
✓ Branch 0 taken 120 times.
✓ Branch 1 taken 527 times.
 647 if (overrun > 0) {
342 // if we're going to clean the cache, try to remove at least 25%
343 120 overrun = max(overrun, (int64_t)max_size_ >> 2);
344 120 perf::Inc(counters_.n_overrun);
345
1/2
✓ Branch 2 taken 120 times.
✗ Branch 3 not taken.
 120 volatile_entries_.ShrinkTo(max((int64_t)0, volatile_size - overrun));
346 }
347 647 overrun -= volatile_size - volatile_entries_.GetUsed();
348
2/2
✓ Branch 0 taken 100 times.
✓ Branch 1 taken 547 times.
 647 if (overrun > 0) {
349
1/2
✓ Branch 2 taken 100 times.
✗ Branch 3 not taken.
 100 regular_entries_.ShrinkTo(max((int64_t)0, regular_size - overrun));
350 }
351 647 overrun -= regular_size - regular_entries_.GetUsed();
352
2/2
✓ Branch 0 taken 40 times.
✓ Branch 1 taken 607 times.
 647 if (overrun > 0) {
353
1/2
✓ Branch 2 taken 40 times.
✗ Branch 3 not taken.
 40 LogCvmfs(kLogCache, kLogDebug,
354 "transaction for %s would overrun the cache limit by %ld",
355
1/2
✓ Branch 1 taken 40 times.
✗ Branch 2 not taken.
 80 transaction->buffer.id.ToString().c_str(), overrun);
356 40 perf::Inc(counters_.n_full);
357 40 return -ENOSPC;
358 }
359
360
1/2
✓ Branch 1 taken 607 times.
✗ Branch 2 not taken.
 607 const int rc = store->Commit(transaction->buffer);
361
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 607 times.
 607 if (rc < 0) {
362 ✗ LogCvmfs(kLogCache, kLogDebug, "commit on %s failed",
363 ✗ transaction->buffer.id.ToString().c_str());
364 ✗ return rc;
365 }
366
1/2
✓ Branch 2 taken 607 times.
✗ Branch 3 not taken.
 607 LogCvmfs(kLogCache, kLogDebug, "committed %s to cache",
367
1/2
✓ Branch 1 taken 607 times.
✗ Branch 2 not taken.
 1214 transaction->buffer.id.ToString().c_str());
368 607 return 0;
369 }
370