GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/cache_ram.cc
Date: 2026-06-14 02:36:34
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 86 RamCacheManager::RamCacheManager(uint64_t max_size,
30 unsigned max_entries,
31 MemoryKvStore::MemoryAllocator alloc,
32 86 perf::StatisticsTemplate statistics)
33 86 : max_size_(max_size)
34
1/2
✓ Branch 1 taken 86 times.
✗ Branch 2 not taken.
 86 , 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 86 times.
✗ Branch 2 not taken.
 86 , regular_entries_(max_entries,
38 alloc,
39 max_size,
40
2/4
✓ Branch 2 taken 86 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 86 times.
✗ Branch 6 not taken.
 172 perf::StatisticsTemplate("kv.regular", statistics))
41
1/2
✓ Branch 1 taken 86 times.
✗ Branch 2 not taken.
 86 , volatile_entries_(max_entries,
42 alloc,
43 max_size,
44
2/4
✓ Branch 2 taken 86 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 86 times.
✗ Branch 6 not taken.
 172 perf::StatisticsTemplate("kv.volatile", statistics))
45
2/4
✓ Branch 3 taken 86 times.
✗ Branch 4 not taken.
✓ Branch 6 taken 86 times.
✗ Branch 7 not taken.
 172 , counters_(statistics) {
46 86 const int retval = pthread_rwlock_init(&rwlock_, NULL);
47
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 86 times.
 86 assert(retval == 0);
48
1/2
✓ Branch 1 taken 86 times.
✗ Branch 2 not taken.
 86 LogCvmfs(kLogCache, kLogDebug, "max %lu B, %u entries", max_size,
49 max_entries);
50
1/2
✓ Branch 1 taken 86 times.
✗ Branch 2 not taken.
 86 LogCvmfs(kLogCache, kLogDebug | kLogSyslogWarn,
51 "DEPRECATION WARNING: The RAM cache manager is depcreated and "
52 "will be removed from future releases.");
53 86 }
54
55
56 224 RamCacheManager::~RamCacheManager() { pthread_rwlock_destroy(&rwlock_); }
57
58
59 55187 int RamCacheManager::AddFd(const ReadOnlyHandle &handle) {
60 55187 const int result = fd_table_.OpenFd(handle);
61
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 55182 times.
 55187 if (result == -ENFILE) {
62 5 LogCvmfs(kLogCache, kLogDebug, "too many open files");
63 5 perf::Inc(counters_.n_enfile);
64 }
65 55187 return result;
66 }
67
68
69 18 bool RamCacheManager::AcquireQuotaManager(QuotaManager *quota_mgr) {
70
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 18 times.
 18 assert(quota_mgr != NULL);
71 18 quota_mgr_ = quota_mgr;
72 18 LogCvmfs(kLogCache, kLogDebug, "set quota manager");
73 18 return true;
74 }
75
76
77 51 int RamCacheManager::Open(const LabeledObject &object) {
78 51 const WriteLockGuard guard(rwlock_);
79
1/2
✓ Branch 1 taken 51 times.
✗ Branch 2 not taken.
 102 return DoOpen(object.id);
80 51 }
81
82
83 92 int RamCacheManager::DoOpen(const shash::Any &id) {
84 bool ok;
85 bool is_volatile;
86
1/2
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
 92 const MemoryBuffer buf;
87
88
3/4
✓ Branch 1 taken 92 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 60 times.
✓ Branch 4 taken 32 times.
 92 if (regular_entries_.Contains(id)) {
89 60 is_volatile = false;
90
3/4
✓ Branch 1 taken 32 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 30 times.
 32 } else if (volatile_entries_.Contains(id)) {
91 2 is_volatile = true;
92 } else {
93
2/4
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 30 times.
✗ Branch 6 not taken.
 30 LogCvmfs(kLogCache, kLogDebug, "miss for %s", id.ToString().c_str());
94 30 perf::Inc(counters_.n_openmiss);
95 30 return -ENOENT;
96 }
97 62 const ReadOnlyHandle generic_handle(id, is_volatile);
98
1/2
✓ Branch 1 taken 62 times.
✗ Branch 2 not taken.
 62 const int fd = AddFd(generic_handle);
99
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 62 times.
 62 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 60 times.
 62 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 60 times.
✗ Branch 3 not taken.
 60 LogCvmfs(kLogCache, kLogDebug, "hit in regular entries for %s",
110
1/2
✓ Branch 1 taken 60 times.
✗ Branch 2 not taken.
 120 id.ToString().c_str());
111 60 perf::Inc(counters_.n_openregular);
112 }
113
1/2
✓ Branch 2 taken 62 times.
✗ Branch 3 not taken.
 62 ok = GetStore(generic_handle)->IncRef(id);
114
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 62 times.
 62 assert(ok);
115 62 return fd;
116 }
117
118
119 18 int64_t RamCacheManager::GetSize(int fd) {
120 18 const ReadLockGuard guard(rwlock_);
121
1/2
✓ Branch 1 taken 18 times.
✗ Branch 2 not taken.
 18 const ReadOnlyHandle generic_handle = fd_table_.GetHandle(fd);
122
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 18 times.
 18 if (generic_handle.handle == kInvalidHandle) {
123 ✗ LogCvmfs(kLogCache, kLogDebug, "bad fd %d on GetSize", fd);
124 ✗ return -EBADF;
125 }
126 18 perf::Inc(counters_.n_getsize);
127
1/2
✓ Branch 2 taken 18 times.
✗ Branch 3 not taken.
 18 return GetStore(generic_handle)->GetSize(generic_handle.handle);
128 18 }
129
130
131 55152 int RamCacheManager::Close(int fd) {
132 bool rc;
133
134 55152 const WriteLockGuard guard(rwlock_);
135
1/2
✓ Branch 1 taken 55152 times.
✗ Branch 2 not taken.
 55152 const ReadOnlyHandle generic_handle = fd_table_.GetHandle(fd);
136
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 55152 times.
 55152 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 55152 times.
✗ Branch 3 not taken.
 55152 rc = GetStore(generic_handle)->Unref(generic_handle.handle);
141
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 55152 times.
 55152 assert(rc);
142
143
1/2
✓ Branch 1 taken 55152 times.
✗ Branch 2 not taken.
 55152 const int rc_int = fd_table_.CloseFd(fd);
144
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 55152 times.
 55152 assert(rc_int == 0);
145
1/2
✓ Branch 1 taken 55152 times.
✗ Branch 2 not taken.
 55152 LogCvmfs(kLogCache, kLogDebug, "closed fd %d", fd);
146 55152 perf::Inc(counters_.n_close);
147 55152 return 0;
148 55152 }
149
150
151 8 int64_t RamCacheManager::Pread(int fd,
152 void *buf,
153 uint64_t size,
154 uint64_t offset) {
155 8 const ReadLockGuard guard(rwlock_);
156
1/2
✓ Branch 1 taken 8 times.
✗ Branch 2 not taken.
 8 const ReadOnlyHandle generic_handle = fd_table_.GetHandle(fd);
157
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8 times.
 8 if (generic_handle.handle == kInvalidHandle) {
158 ✗ LogCvmfs(kLogCache, kLogDebug, "bad fd %d on Pread", fd);
159 ✗ return -EBADF;
160 }
161 8 perf::Inc(counters_.n_pread);
162 return GetStore(generic_handle)
163
1/2
✓ Branch 2 taken 8 times.
✗ Branch 3 not taken.
 8 ->Read(generic_handle.handle, buf, size, offset);
164 8 }
165
166
167 55130 int RamCacheManager::Dup(int fd) {
168 bool ok;
169 int rc;
170 55130 const WriteLockGuard guard(rwlock_);
171
1/2
✓ Branch 1 taken 55130 times.
✗ Branch 2 not taken.
 55130 const ReadOnlyHandle generic_handle = fd_table_.GetHandle(fd);
172
2/2
✓ Branch 1 taken 5 times.
✓ Branch 2 taken 55125 times.
 55130 if (generic_handle.handle == kInvalidHandle) {
173
1/2
✓ Branch 1 taken 5 times.
✗ Branch 2 not taken.
 5 LogCvmfs(kLogCache, kLogDebug, "bad fd %d on Dup", fd);
174 5 return -EBADF;
175 }
176
1/2
✓ Branch 1 taken 55125 times.
✗ Branch 2 not taken.
 55125 rc = AddFd(generic_handle);
177
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 55120 times.
 55125 if (rc < 0)
178 5 return rc;
179
1/2
✓ Branch 2 taken 55120 times.
✗ Branch 3 not taken.
 55120 ok = GetStore(generic_handle)->IncRef(generic_handle.handle);
180
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 55120 times.
 55120 assert(ok);
181
1/2
✓ Branch 1 taken 55120 times.
✗ Branch 2 not taken.
 55120 LogCvmfs(kLogCache, kLogDebug, "dup fd %d", fd);
182 55120 perf::Inc(counters_.n_dup);
183 55120 return rc;
184 55130 }
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 157 int RamCacheManager::StartTxn(const shash::Any &id, uint64_t size, void *txn) {
204
1/2
✓ Branch 2 taken 157 times.
✗ Branch 3 not taken.
 157 LogCvmfs(kLogCache, kLogDebug, "new transaction with id %s",
205 314 id.ToString().c_str());
206 157 Transaction *transaction = new (txn) Transaction();
207 157 transaction->buffer.id = id;
208 157 transaction->pos = 0;
209 157 transaction->expected_size = size;
210
1/2
✓ Branch 0 taken 157 times.
✗ Branch 1 not taken.
 157 transaction->buffer.size = (size == kSizeUnknown) ? kPageSize : size;
211 157 transaction->buffer.address = malloc(transaction->buffer.size);
212
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 157 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 157 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 157 perf::Inc(counters_.n_starttxn);
218 157 return 0;
219 }
220
221
222 16 void RamCacheManager::CtrlTxn(const Label &label, const int /* flags */,
223 void *txn) {
224 16 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
225 16 transaction->description = label.GetDescription();
226 16 transaction->buffer.object_flags = label.flags;
227
1/2
✓ Branch 2 taken 16 times.
✗ Branch 3 not taken.
 16 LogCvmfs(kLogCache, kLogDebug, "modified transaction %s",
228 32 transaction->buffer.id.ToString().c_str());
229 16 }
230
231
232 166 int64_t RamCacheManager::Write(const void *buf, uint64_t size, void *txn) {
233 166 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
234
235
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 166 times.
 166 assert(transaction->pos <= transaction->buffer.size);
236
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 161 times.
 166 if (transaction->pos + size > transaction->buffer.size) {
237
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5 times.
 5 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 5 LogCvmfs(kLogCache, kLogDebug,
254 "attempted to write more than requested (%lu>%zu)", size,
255 transaction->buffer.size);
256 5 return -EFBIG;
257 }
258 }
259
260
2/4
✓ Branch 0 taken 161 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 161 times.
✗ Branch 3 not taken.
 161 if (transaction->buffer.address && buf) {
261 // LogCvmfs(kLogCache, kLogDebug, "copy %u bytes of transaction %s",
262 // size, transaction->id.ToString().c_str());
263 161 memcpy(static_cast<char *>(transaction->buffer.address) + transaction->pos,
264 buf, size);
265 }
266 161 transaction->pos += size;
267 161 perf::Inc(counters_.n_write);
268 161 return size;
269 }
270
271
272 6 int RamCacheManager::Reset(void *txn) {
273 6 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
274 6 transaction->pos = 0;
275
1/2
✓ Branch 2 taken 6 times.
✗ Branch 3 not taken.
 6 LogCvmfs(kLogCache, kLogDebug, "reset transaction %s",
276 12 transaction->buffer.id.ToString().c_str());
277 6 perf::Inc(counters_.n_reset);
278 6 return 0;
279 }
280
281
282 46 int RamCacheManager::OpenFromTxn(void *txn) {
283 46 const WriteLockGuard guard(rwlock_);
284 46 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
285
1/2
✓ Branch 1 taken 46 times.
✗ Branch 2 not taken.
 46 const int64_t retval = CommitToKvStore(transaction);
286
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 41 times.
 46 if (retval < 0) {
287
1/2
✓ Branch 3 taken 5 times.
✗ Branch 4 not taken.
 10 LogCvmfs(kLogCache, kLogDebug,
288 "error while committing transaction on %s: %s",
289
1/2
✓ Branch 1 taken 5 times.
✗ Branch 2 not taken.
 10 transaction->buffer.id.ToString().c_str(), strerror(-retval));
290 5 return retval;
291 }
292
1/2
✓ Branch 2 taken 41 times.
✗ Branch 3 not taken.
 41 LogCvmfs(kLogCache, kLogDebug, "open pending transaction for %s",
293
1/2
✓ Branch 1 taken 41 times.
✗ Branch 2 not taken.
 82 transaction->buffer.id.ToString().c_str());
294 41 perf::Inc(counters_.n_committxn);
295
1/2
✓ Branch 1 taken 41 times.
✗ Branch 2 not taken.
 41 return DoOpen(transaction->buffer.id);
296 46 }
297
298
299 6 int RamCacheManager::AbortTxn(void *txn) {
300 6 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
301 6 free(transaction->buffer.address);
302
1/2
✓ Branch 2 taken 6 times.
✗ Branch 3 not taken.
 6 LogCvmfs(kLogCache, kLogDebug, "abort transaction %s",
303 12 transaction->buffer.id.ToString().c_str());
304 6 perf::Inc(counters_.n_aborttxn);
305 6 return 0;
306 }
307
308
309 121 int RamCacheManager::CommitTxn(void *txn) {
310 121 const WriteLockGuard guard(rwlock_);
311 121 Transaction *transaction = reinterpret_cast<Transaction *>(txn);
312 121 perf::Inc(counters_.n_committxn);
313
1/2
✓ Branch 1 taken 121 times.
✗ Branch 2 not taken.
 121 const int64_t rc = CommitToKvStore(transaction);
314
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 116 times.
 121 if (rc < 0)
315 5 return rc;
316 116 free(transaction->buffer.address);
317 116 return rc;
318 121 }
319
320
321 167 int64_t RamCacheManager::CommitToKvStore(Transaction *transaction) {
322 MemoryKvStore *store;
323
324
2/2
✓ Branch 0 taken 7 times.
✓ Branch 1 taken 160 times.
 167 if (transaction->buffer.object_flags & CacheManager::kLabelVolatile) {
325 7 store = &volatile_entries_;
326 } else {
327 160 store = &regular_entries_;
328 }
329
2/2
✓ Branch 0 taken 162 times.
✓ Branch 1 taken 5 times.
 167 if ((transaction->buffer.object_flags & CacheManager::kLabelPinned)
330
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 162 times.
 162 || (transaction->buffer.object_flags & CacheManager::kLabelCatalog)) {
331 5 transaction->buffer.refcount = 1;
332 } else {
333 162 transaction->buffer.refcount = 0;
334 }
335
336 167 const int64_t regular_size = regular_entries_.GetUsed();
337 167 const int64_t volatile_size = volatile_entries_.GetUsed();
338 167 int64_t overrun = regular_size + volatile_size + transaction->buffer.size
339 167 - max_size_;
340
341
2/2
✓ Branch 0 taken 30 times.
✓ Branch 1 taken 137 times.
 167 if (overrun > 0) {
342 // if we're going to clean the cache, try to remove at least 25%
343 30 overrun = max(overrun, (int64_t)max_size_ >> 2);
344 30 perf::Inc(counters_.n_overrun);
345
1/2
✓ Branch 2 taken 30 times.
✗ Branch 3 not taken.
 30 volatile_entries_.ShrinkTo(max((int64_t)0, volatile_size - overrun));
346 }
347 167 overrun -= volatile_size - volatile_entries_.GetUsed();
348
2/2
✓ Branch 0 taken 25 times.
✓ Branch 1 taken 142 times.
 167 if (overrun > 0) {
349
1/2
✓ Branch 2 taken 25 times.
✗ Branch 3 not taken.
 25 regular_entries_.ShrinkTo(max((int64_t)0, regular_size - overrun));
350 }
351 167 overrun -= regular_size - regular_entries_.GetUsed();
352
2/2
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 157 times.
 167 if (overrun > 0) {
353
1/2
✓ Branch 2 taken 10 times.
✗ Branch 3 not taken.
 10 LogCvmfs(kLogCache, kLogDebug,
354 "transaction for %s would overrun the cache limit by %ld",
355
1/2
✓ Branch 1 taken 10 times.
✗ Branch 2 not taken.
 20 transaction->buffer.id.ToString().c_str(), overrun);
356 10 perf::Inc(counters_.n_full);
357 10 return -ENOSPC;
358 }
359
360
1/2
✓ Branch 1 taken 157 times.
✗ Branch 2 not taken.
 157 const int rc = store->Commit(transaction->buffer);
361
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 157 times.
 157 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 157 times.
✗ Branch 3 not taken.
 157 LogCvmfs(kLogCache, kLogDebug, "committed %s to cache",
367
1/2
✓ Branch 1 taken 157 times.
✗ Branch 2 not taken.
 314 transaction->buffer.id.ToString().c_str());
368 157 return 0;
369 }
370