GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/kvstore.cc
Date: 2026-10-04 02:40:33
Exec Total Coverage
Lines: 193 249 77.5%
Branches: 112 258 43.4%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #include "kvstore.h"
6
7 #include <assert.h>
8 #include <errno.h>
9 #include <limits.h>
10 #include <string.h>
11 #include <unistd.h>
12
13 #include <algorithm>
14
15 #include "util/logging.h"
16
17 using namespace std; // NOLINT
18
19 namespace {
20
21 327986 static inline uint32_t hasher_any(const shash::Any &key) {
22 // We'll just do the same thing as hasher_md5, since every hash is at
23 // least as large.
24 return static_cast<uint32_t>(
25 327986 *(reinterpret_cast<const uint32_t *>(key.digest) + 1));
26 }
27
28 } // anonymous namespace
29
30 const double MemoryKvStore::kCompactThreshold = 0.8;
31
32
33 364 MemoryKvStore::MemoryKvStore(unsigned int cache_entries,
34 MemoryAllocator alloc,
35 unsigned alloc_size,
36 364 perf::StatisticsTemplate statistics)
37 364 : allocator_(alloc)
38 364 , used_bytes_(0)
39 364 , entry_count_(0)
40 364 , max_entries_(cache_entries)
41
2/4
✓ Branch 1 taken 364 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 364 times.
✗ Branch 5 not taken.
 364 , entries_(cache_entries, shash::Any(), hasher_any,
42
2/4
✓ Branch 2 taken 364 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 364 times.
✗ Branch 6 not taken.
 728 perf::StatisticsTemplate("lru", statistics))
43 364 , heap_(NULL)
44
2/4
✓ Branch 2 taken 364 times.
✗ Branch 3 not taken.
✓ Branch 5 taken 364 times.
✗ Branch 6 not taken.
 728 , counters_(statistics) {
45 364 const int retval = pthread_rwlock_init(&rwlock_, NULL);
46
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 364 times.
 364 assert(retval == 0);
47
2/2
✓ Branch 0 taken 64 times.
✓ Branch 1 taken 300 times.
 364 switch (alloc) {
48 64 case kMallocHeap:
49 64 heap_ = new MallocHeap(
50
3/6
✓ Branch 1 taken 64 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 64 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 64 times.
✗ Branch 8 not taken.
 64 alloc_size, this->MakeCallback(&MemoryKvStore::OnBlockMove, this));
51 64 break;
52 300 default:
53 300 break;
54 }
55 364 }
56
57
58 364 MemoryKvStore::~MemoryKvStore() {
59
2/2
✓ Branch 0 taken 64 times.
✓ Branch 1 taken 300 times.
 364 delete heap_;
60 364 pthread_rwlock_destroy(&rwlock_);
61 364 }
62
63
64 ✗ void MemoryKvStore::OnBlockMove(const MallocHeap::BlockPtr &ptr) {
65 bool ok;
66 ✗ struct AllocHeader a;
67 ✗ MemoryBuffer buf;
68
69 // must be locked by caller
70 ✗ assert(ptr.pointer);
71 ✗ memcpy(&a, ptr.pointer, sizeof(a));
72 ✗ LogCvmfs(kLogKvStore, kLogDebug, "compaction moved %s to %p",
73 ✗ a.id.ToString().c_str(), ptr.pointer);
74 ✗ assert(a.version == 0);
75 ✗ const bool update_lru = false;
76 ✗ ok = entries_.Lookup(a.id, &buf, update_lru);
77 ✗ assert(ok);
78 ✗ buf.address = static_cast<char *>(ptr.pointer) + sizeof(a);
79 ✗ ok = entries_.UpdateValue(buf.id, buf);
80 ✗ assert(ok);
81 }
82
83
84 154 bool MemoryKvStore::Contains(const shash::Any &id) {
85
1/2
✓ Branch 1 taken 154 times.
✗ Branch 2 not taken.
 154 MemoryBuffer buf;
86 // LogCvmfs(kLogKvStore, kLogDebug, "check buffer %s", id.ToString().c_str());
87 154 const bool update_lru = false;
88
1/2
✓ Branch 1 taken 154 times.
✗ Branch 2 not taken.
 308 return entries_.Lookup(id, &buf, update_lru);
89 }
90
91
92 3904 int MemoryKvStore::DoMalloc(MemoryBuffer *buf) {
93
1/2
✓ Branch 1 taken 3904 times.
✗ Branch 2 not taken.
 3904 MemoryBuffer tmp;
94
1/2
✓ Branch 1 taken 3904 times.
✗ Branch 2 not taken.
 3904 AllocHeader a;
95
96
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3904 times.
 3904 assert(buf);
97 3904 memcpy(&tmp, buf, sizeof(tmp));
98
99 3904 tmp.address = NULL;
100
1/2
✓ Branch 0 taken 3904 times.
✗ Branch 1 not taken.
 3904 if (tmp.size > 0) {
101
1/3
✓ Branch 0 taken 3904 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
 3904 switch (allocator_) {
102 3904 case kMallocLibc:
103 3904 tmp.address = malloc(tmp.size);
104
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3904 times.
 3904 if (!tmp.address)
105 ✗ return -errno;
106 3904 break;
107 ✗ case kMallocHeap:
108 ✗ assert(heap_);
109 ✗ a.id = tmp.id;
110 ✗ tmp.address = heap_->Allocate(tmp.size + sizeof(a), &a, sizeof(a));
111 ✗ if (!tmp.address)
112 ✗ return -ENOMEM;
113 ✗ tmp.address = static_cast<char *>(tmp.address) + sizeof(a);
114 ✗ break;
115 ✗ default:
116 ✗ abort();
117 }
118 }
119
120 3904 memcpy(buf, &tmp, sizeof(*buf));
121 3904 return 0;
122 }
123
124
125 3760 void MemoryKvStore::DoFree(MemoryBuffer *buf) {
126
1/2
✓ Branch 1 taken 3760 times.
✗ Branch 2 not taken.
 3760 const AllocHeader a;
127
128
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3760 times.
 3760 assert(buf);
129
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3760 times.
 3760 if (!buf->address)
130 ✗ return;
131
1/3
✓ Branch 0 taken 3760 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
 3760 switch (allocator_) {
132 3760 case kMallocLibc:
133 3760 free(buf->address);
134 3760 return;
135 ✗ case kMallocHeap:
136 ✗ heap_->MarkFree(static_cast<char *>(buf->address) - sizeof(a));
137 ✗ return;
138 ✗ default:
139 ✗ abort();
140 }
141 }
142
143
144 3904 bool MemoryKvStore::CompactMemory() {
145 double utilization;
146
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3904 times.
 3904 switch (allocator_) {
147 ✗ case kMallocHeap:
148 ✗ utilization = heap_->utilization();
149 ✗ LogCvmfs(kLogKvStore, kLogDebug, "compact requested (%f)", utilization);
150 ✗ if (utilization < kCompactThreshold) {
151 ✗ LogCvmfs(kLogKvStore, kLogDebug, "compacting heap");
152 ✗ heap_->Compact();
153 ✗ if (heap_->utilization() > utilization)
154 ✗ return true;
155 }
156 ✗ return false;
157 3904 default:
158 // the others can't do any compact, so just ignore
159 3904 LogCvmfs(kLogKvStore, kLogDebug, "compact requested");
160 3904 return false;
161 }
162 }
163
164
165 90 int64_t MemoryKvStore::GetSize(const shash::Any &id) {
166
1/2
✓ Branch 1 taken 90 times.
✗ Branch 2 not taken.
 90 MemoryBuffer mem;
167 90 perf::Inc(counters_.n_getsize);
168 90 const bool update_lru = false;
169
3/4
✓ Branch 1 taken 90 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 54 times.
✓ Branch 4 taken 36 times.
 90 if (entries_.Lookup(id, &mem, update_lru)) {
170 // LogCvmfs(kLogKvStore, kLogDebug, "%s is %u B", id.ToString().c_str(),
171 // mem.size);
172 54 return mem.size;
173 } else {
174
1/2
✓ Branch 2 taken 36 times.
✗ Branch 3 not taken.
 36 LogCvmfs(kLogKvStore, kLogDebug, "miss %s on GetSize",
175
1/2
✓ Branch 1 taken 36 times.
✗ Branch 2 not taken.
 72 id.ToString().c_str());
176 36 return -ENOENT;
177 }
178 }
179
180
181 180 int64_t MemoryKvStore::GetRefcount(const shash::Any &id) {
182
1/2
✓ Branch 1 taken 180 times.
✗ Branch 2 not taken.
 180 MemoryBuffer mem;
183 180 perf::Inc(counters_.n_getrefcount);
184 180 const bool update_lru = false;
185
2/4
✓ Branch 1 taken 180 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 180 times.
✗ Branch 4 not taken.
 180 if (entries_.Lookup(id, &mem, update_lru)) {
186 // LogCvmfs(kLogKvStore, kLogDebug, "%s has refcount %u",
187 // id.ToString().c_str(), mem.refcount);
188 180 return mem.refcount;
189 } else {
190 ✗ LogCvmfs(kLogKvStore, kLogDebug, "miss %s on GetRefcount",
191 ✗ id.ToString().c_str());
192 ✗ return -ENOENT;
193 }
194 }
195
196
197 22242 bool MemoryKvStore::IncRef(const shash::Any &id) {
198 22242 perf::Inc(counters_.n_incref);
199 22242 const WriteLockGuard guard(rwlock_);
200
1/2
✓ Branch 1 taken 22242 times.
✗ Branch 2 not taken.
 22242 MemoryBuffer mem;
201
3/4
✓ Branch 1 taken 22242 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 22206 times.
✓ Branch 4 taken 36 times.
 22242 if (entries_.Lookup(id, &mem)) {
202
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 22206 times.
 22206 assert(mem.refcount < UINT_MAX);
203 22206 ++mem.refcount;
204
1/2
✓ Branch 1 taken 22206 times.
✗ Branch 2 not taken.
 22206 entries_.Insert(id, mem);
205
1/2
✓ Branch 2 taken 22206 times.
✗ Branch 3 not taken.
 22206 LogCvmfs(kLogKvStore, kLogDebug, "increased refcount of %s to %u",
206
1/2
✓ Branch 1 taken 22206 times.
✗ Branch 2 not taken.
 44412 id.ToString().c_str(), mem.refcount);
207 22206 return true;
208 } else {
209
1/2
✓ Branch 2 taken 36 times.
✗ Branch 3 not taken.
 36 LogCvmfs(kLogKvStore, kLogDebug, "miss %s on IncRef",
210
1/2
✓ Branch 1 taken 36 times.
✗ Branch 2 not taken.
 72 id.ToString().c_str());
211 36 return false;
212 }
213 22242 }
214
215
216 22230 bool MemoryKvStore::Unref(const shash::Any &id) {
217 22230 perf::Inc(counters_.n_unref);
218 22230 const WriteLockGuard guard(rwlock_);
219
1/2
✓ Branch 1 taken 22230 times.
✗ Branch 2 not taken.
 22230 MemoryBuffer mem;
220
3/4
✓ Branch 1 taken 22230 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 22194 times.
✓ Branch 4 taken 36 times.
 22230 if (entries_.Lookup(id, &mem)) {
221
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 22194 times.
 22194 assert(mem.refcount > 0);
222 22194 --mem.refcount;
223
1/2
✓ Branch 1 taken 22194 times.
✗ Branch 2 not taken.
 22194 entries_.Insert(id, mem);
224
1/2
✓ Branch 2 taken 22194 times.
✗ Branch 3 not taken.
 22194 LogCvmfs(kLogKvStore, kLogDebug, "decreased refcount of %s to %u",
225
1/2
✓ Branch 1 taken 22194 times.
✗ Branch 2 not taken.
 44388 id.ToString().c_str(), mem.refcount);
226 22194 return true;
227 } else {
228
2/4
✓ Branch 1 taken 36 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 36 times.
✗ Branch 6 not taken.
 36 LogCvmfs(kLogKvStore, kLogDebug, "miss %s on Unref", id.ToString().c_str());
229 36 return false;
230 }
231 22230 }
232
233
234 122 int64_t MemoryKvStore::Read(const shash::Any &id,
235 void *buf,
236 size_t size,
237 size_t offset) {
238
1/2
✓ Branch 1 taken 122 times.
✗ Branch 2 not taken.
 122 MemoryBuffer mem;
239 122 perf::Inc(counters_.n_read);
240 122 const ReadLockGuard guard(rwlock_);
241
2/4
✓ Branch 1 taken 122 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 122 times.
 122 if (!entries_.Lookup(id, &mem)) {
242 ✗ LogCvmfs(kLogKvStore, kLogDebug, "miss %s on Read", id.ToString().c_str());
243 ✗ return -ENOENT;
244 }
245
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 122 times.
 122 if (offset > mem.size) {
246 ✗ LogCvmfs(kLogKvStore, kLogDebug, "out of bounds read (%zu>%zu) on %s",
247 ✗ offset, mem.size, id.ToString().c_str());
248 ✗ return 0;
249 }
250 122 const uint64_t copy_size = std::min(mem.size - offset, size);
251 // LogCvmfs(kLogKvStore, kLogDebug, "copy %u B from offset %u of %s",
252 // copy_size, offset, id.ToString().c_str());
253 122 memcpy(buf, static_cast<char *>(mem.address) + offset, copy_size);
254 122 perf::Xadd(counters_.sz_read, copy_size);
255 122 return copy_size;
256 122 }
257
258
259 3904 int MemoryKvStore::Commit(const MemoryBuffer &buf) {
260 3904 const WriteLockGuard guard(rwlock_);
261
1/2
✓ Branch 1 taken 3904 times.
✗ Branch 2 not taken.
 7808 return DoCommit(buf);
262 3904 }
263
264
265 3904 int MemoryKvStore::DoCommit(const MemoryBuffer &buf) {
266 // we need to be careful about refcounts. If another thread wants to read
267 // a cache entry while it's being written (OpenFromTxn put partial data in
268 // the kvstore, will be committed again later) the refcount in the kvstore
269 // will differ from the refcount in the cache transaction. To avoid leaks,
270 // either the caller needs to fetch the cache entry before every write to
271 // find the current refcount, or the kvstore can ignore the passed-in
272 // refcount if the entry already exists. This implementation does the latter,
273 // and as a result it's not possible to directly modify the refcount
274 // without a race condition. This is a hint that callers should use the
275 // refcount like a lock and not directly modify the numeric value.
276
277
1/2
✓ Branch 1 taken 3904 times.
✗ Branch 2 not taken.
 3904 CompactMemory();
278
279
1/2
✓ Branch 1 taken 3904 times.
✗ Branch 2 not taken.
 3904 MemoryBuffer mem;
280 3904 perf::Inc(counters_.n_commit);
281
2/4
✓ Branch 1 taken 3904 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 3904 times.
✗ Branch 6 not taken.
 3904 LogCvmfs(kLogKvStore, kLogDebug, "commit %s", buf.id.ToString().c_str());
282
3/4
✓ Branch 1 taken 3904 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 42 times.
✓ Branch 4 taken 3862 times.
 3904 if (entries_.Lookup(buf.id, &mem)) {
283
1/2
✓ Branch 1 taken 42 times.
✗ Branch 2 not taken.
 42 LogCvmfs(kLogKvStore, kLogDebug, "commit overwrites existing entry");
284 42 const size_t old_size = mem.size;
285
1/2
✓ Branch 1 taken 42 times.
✗ Branch 2 not taken.
 42 DoFree(&mem);
286 42 used_bytes_ -= old_size;
287 42 counters_.sz_size->Set(used_bytes_);
288 42 --entry_count_;
289 } else {
290 // since this is a new entry, the caller can choose the starting
291 // refcount (starting at 1 for pinning, for example)
292 3862 mem.refcount = buf.refcount;
293 }
294 3904 mem.object_flags = buf.object_flags;
295 3904 mem.id = buf.id;
296 3904 mem.size = buf.size;
297
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3904 times.
 3904 if (entry_count_ == max_entries_) {
298 ✗ LogCvmfs(kLogKvStore, kLogDebug, "too many entries in kvstore");
299 ✗ return -ENFILE;
300 }
301
2/4
✓ Branch 1 taken 3904 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 3904 times.
 3904 if (DoMalloc(&mem) < 0) {
302 ✗ LogCvmfs(kLogKvStore, kLogDebug, "failed to allocate %s",
303 ✗ buf.id.ToString().c_str());
304 ✗ return -EIO;
305 }
306
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3904 times.
 3904 assert(SSIZE_MAX - mem.size > used_bytes_);
307 3904 memcpy(mem.address, buf.address, mem.size);
308
1/2
✓ Branch 1 taken 3904 times.
✗ Branch 2 not taken.
 3904 entries_.Insert(buf.id, mem);
309 3904 ++entry_count_;
310 3904 used_bytes_ += mem.size;
311 3904 counters_.sz_size->Set(used_bytes_);
312 3904 perf::Xadd(counters_.sz_committed, mem.size);
313 3904 return 0;
314 }
315
316
317 216 bool MemoryKvStore::Delete(const shash::Any &id) {
318 216 perf::Inc(counters_.n_delete);
319 216 const WriteLockGuard guard(rwlock_);
320
1/2
✓ Branch 1 taken 216 times.
✗ Branch 2 not taken.
 432 return DoDelete(id);
321 216 }
322
323
324 216 bool MemoryKvStore::DoDelete(const shash::Any &id) {
325
1/2
✓ Branch 1 taken 216 times.
✗ Branch 2 not taken.
 216 MemoryBuffer buf;
326
3/4
✓ Branch 1 taken 216 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 72 times.
✓ Branch 4 taken 144 times.
 216 if (!entries_.Lookup(id, &buf)) {
327
1/2
✓ Branch 2 taken 72 times.
✗ Branch 3 not taken.
 72 LogCvmfs(kLogKvStore, kLogDebug, "miss %s on Delete",
328
1/2
✓ Branch 1 taken 72 times.
✗ Branch 2 not taken.
 144 id.ToString().c_str());
329 72 return false;
330 }
331
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 144 times.
 144 if (buf.refcount > 0) {
332 ✗ LogCvmfs(kLogKvStore, kLogDebug, "can't delete %s, nonzero refcount",
333 ✗ id.ToString().c_str());
334 ✗ return false;
335 }
336
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 144 times.
 144 assert(entry_count_ > 0);
337 144 --entry_count_;
338 144 used_bytes_ -= buf.size;
339 144 counters_.sz_size->Set(used_bytes_);
340 144 perf::Xadd(counters_.sz_deleted, buf.size);
341
1/2
✓ Branch 1 taken 144 times.
✗ Branch 2 not taken.
 144 DoFree(&buf);
342
1/2
✓ Branch 1 taken 144 times.
✗ Branch 2 not taken.
 144 entries_.Forget(id);
343
2/4
✓ Branch 1 taken 144 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 144 times.
✗ Branch 6 not taken.
 144 LogCvmfs(kLogKvStore, kLogDebug, "deleted %s", id.ToString().c_str());
344 144 return true;
345 }
346
347
348 238 bool MemoryKvStore::ShrinkTo(size_t size) {
349 238 perf::Inc(counters_.n_shrinkto);
350 238 const WriteLockGuard guard(rwlock_);
351
1/2
✓ Branch 1 taken 238 times.
✗ Branch 2 not taken.
 238 shash::Any key;
352
1/2
✓ Branch 1 taken 238 times.
✗ Branch 2 not taken.
 238 MemoryBuffer buf;
353
354
2/2
✓ Branch 0 taken 82 times.
✓ Branch 1 taken 156 times.
 238 if (used_bytes_ <= size) {
355
1/2
✓ Branch 1 taken 82 times.
✗ Branch 2 not taken.
 82 LogCvmfs(kLogKvStore, kLogDebug, "no need to shrink");
356 82 return true;
357 }
358
359
1/2
✓ Branch 1 taken 156 times.
✗ Branch 2 not taken.
 156 LogCvmfs(kLogKvStore, kLogDebug, "shrinking to %zu B", size);
360
1/2
✓ Branch 1 taken 156 times.
✗ Branch 2 not taken.
 156 entries_.FilterBegin();
361
3/4
✓ Branch 1 taken 3886 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 3842 times.
✓ Branch 4 taken 44 times.
 3886 while (entries_.FilterNext()) {
362
2/2
✓ Branch 0 taken 112 times.
✓ Branch 1 taken 3730 times.
 3842 if (used_bytes_ <= size)
363 112 break;
364
1/2
✓ Branch 1 taken 3730 times.
✗ Branch 2 not taken.
 3730 entries_.FilterGet(&key, &buf);
365
2/2
✓ Branch 0 taken 156 times.
✓ Branch 1 taken 3574 times.
 3730 if (buf.refcount > 0) {
366
1/2
✓ Branch 2 taken 156 times.
✗ Branch 3 not taken.
 156 LogCvmfs(kLogKvStore, kLogDebug, "skip %s, nonzero refcount",
367
1/2
✓ Branch 1 taken 156 times.
✗ Branch 2 not taken.
 312 key.ToString().c_str());
368 156 continue;
369 }
370
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3574 times.
 3574 assert(entry_count_ > 0);
371 3574 --entry_count_;
372
1/2
✓ Branch 1 taken 3574 times.
✗ Branch 2 not taken.
 3574 entries_.FilterDelete();
373 3574 used_bytes_ -= buf.size;
374 3574 perf::Xadd(counters_.sz_shrunk, buf.size);
375 3574 counters_.sz_size->Set(used_bytes_);
376
1/2
✓ Branch 1 taken 3574 times.
✗ Branch 2 not taken.
 3574 DoFree(&buf);
377
2/4
✓ Branch 1 taken 3574 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 3574 times.
✗ Branch 6 not taken.
 3574 LogCvmfs(kLogKvStore, kLogDebug, "delete %s", key.ToString().c_str());
378 }
379
1/2
✓ Branch 1 taken 156 times.
✗ Branch 2 not taken.
 156 entries_.FilterEnd();
380
1/2
✓ Branch 1 taken 156 times.
✗ Branch 2 not taken.
 156 LogCvmfs(kLogKvStore, kLogDebug, "shrunk to %zu B", used_bytes_);
381 156 return used_bytes_ <= size;
382 238 }
383