GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/sqlitemem.cc
Date: 2025-10-05 02:35:40
Exec Total Coverage
Lines: 154 159 96.9%
Branches: 80 122 65.6%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #define __STDC_FORMAT_MACROS
6
7
8 #include "sqlitemem.h"
9
10 #include <cassert>
11 #include <cstddef>
12 #include <cstring>
13 #include <new>
14
15 #include "malloc_arena.h"
16 #include "util/concurrency.h"
17 #include "util/exception.h"
18 #include "util/smalloc.h"
19
20 using namespace std; // NOLINT
21
22
23 3928 void *SqliteMemoryManager::LookasideBufferArena::GetBuffer() {
24
2/2
✓ Branch 0 taken 9329 times.
✓ Branch 1 taken 33 times.
 9362 for (unsigned i = 0; i < kNoBitmaps; ++i) {
25 9329 const int bit_set = ffs(freemap_[i]);
26
2/2
✓ Branch 0 taken 3895 times.
✓ Branch 1 taken 5434 times.
 9329 if (bit_set != 0) {
27 3895 freemap_[i] &= ~(1 << (bit_set - 1)); // set bit to zero
28 3895 const int nbuffer = i * sizeof(int) * 8 + bit_set - 1;
29 3895 return reinterpret_cast<char *>(arena_) + nbuffer * kBufferSize;
30 }
31 }
32 33 return NULL;
33 }
34
35
36 1463 bool SqliteMemoryManager::LookasideBufferArena::IsEmpty() {
37
2/2
✓ Branch 0 taken 3707 times.
✓ Branch 1 taken 44 times.
 3751 for (unsigned i = 0; i < kNoBitmaps; ++i) {
38
2/2
✓ Branch 0 taken 1419 times.
✓ Branch 1 taken 2288 times.
 3707 if (~freemap_[i] != 0)
39 1419 return false;
40 }
41 44 return true;
42 }
43
44
45 3928 bool SqliteMemoryManager::LookasideBufferArena::Contains(void *buffer) {
46
3/4
✓ Branch 0 taken 3928 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 11 times.
✓ Branch 3 taken 3917 times.
 3928 if ((buffer == NULL) || (buffer < arena_))
47 11 return false;
48 3917 return (static_cast<uint64_t>((reinterpret_cast<char *>(buffer)
49 3917 - reinterpret_cast<char *>(arena_)))
50 3917 < kArenaSize);
51 }
52
53
54 786 SqliteMemoryManager::LookasideBufferArena::LookasideBufferArena()
55 786 : arena_(sxmmap(kArenaSize)) {
56 // All buffers unused, i.e. all bits set
57 786 memset(freemap_, 0xFF, kNoBitmaps * sizeof(int));
58 786 }
59
60
61 782 SqliteMemoryManager::LookasideBufferArena::~LookasideBufferArena() {
62 782 sxunmap(arena_, kArenaSize);
63 782 }
64
65
66 3895 void SqliteMemoryManager::LookasideBufferArena::PutBuffer(void *buffer) {
67
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3895 times.
 3895 assert(buffer >= arena_);
68 3895 const ptrdiff_t nbuffer = (reinterpret_cast<char *>(buffer)
69 3895 - reinterpret_cast<char *>(arena_))
70 / kBufferSize;
71
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3895 times.
 3895 assert(static_cast<uint64_t>(nbuffer) < kBuffersPerArena);
72 3895 const int nfreemap = nbuffer / (sizeof(int) * 8);
73 3895 freemap_[nfreemap] |= 1 << (nbuffer % (sizeof(int) * 8));
74 3895 }
75
76
77 //------------------------------------------------------------------------------
78
79
80 SqliteMemoryManager *SqliteMemoryManager::instance_ = NULL;
81
82
83 /**
84 * Sqlite ensures that size > 0.
85 */
86 520317 void *SqliteMemoryManager::xMalloc(int size) {
87 520317 return instance_->GetMemory(size);
88 }
89
90
91 /**
92 * Sqlite ensures that ptr != NULL.
93 */
94 520224 void SqliteMemoryManager::xFree(void *ptr) { instance_->PutMemory(ptr); }
95
96
97 /**
98 * Sqlite ensures that ptr != NULL and new_size > 0.
99 */
100 243910 void *SqliteMemoryManager::xRealloc(void *ptr, int new_size) {
101 243910 const int old_size = xSize(ptr);
102
2/2
✓ Branch 0 taken 6117 times.
✓ Branch 1 taken 237793 times.
 243910 if (old_size >= new_size)
103 6117 return ptr;
104
105 237793 void *new_ptr = xMalloc(new_size);
106 237793 memcpy(new_ptr, ptr, old_size);
107 237793 xFree(ptr);
108 237793 return new_ptr;
109 }
110
111
112 /**
113 * Sqlite ensures that ptr != NULL.
114 */
115 871451 int SqliteMemoryManager::xSize(void *ptr) {
116 871451 return instance_->GetMemorySize(ptr);
117 }
118
119
120 306423 int SqliteMemoryManager::xRoundup(int size) { return RoundUp8(size); }
121
122
123 709 int SqliteMemoryManager::xInit(void *app_data __attribute__((unused))) {
124 709 return SQLITE_OK;
125 }
126
127
128 705 void SqliteMemoryManager::xShutdown(void *app_data __attribute__((unused))) { }
129
130
131 709 void SqliteMemoryManager::AssignGlobalArenas() {
132
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 709 times.
 709 if (assigned_)
133 ✗ return;
134 int retval;
135
136 709 retval = sqlite3_config(SQLITE_CONFIG_PAGECACHE, page_cache_memory_,
137 kPageCacheSlotSize, kPageCacheNoSlots);
138
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 709 times.
 709 assert(retval == SQLITE_OK);
139
140 709 retval = sqlite3_config(SQLITE_CONFIG_GETMALLOC, &sqlite3_mem_vanilla_);
141
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 709 times.
 709 assert(retval == SQLITE_OK);
142 709 retval = sqlite3_config(SQLITE_CONFIG_MALLOC, &mem_methods_);
143
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 709 times.
 709 assert(retval == SQLITE_OK);
144
145 709 assigned_ = true;
146 }
147
148
149 /**
150 * Needs to be the first operation on an opened sqlite database. Returns the
151 * location of the buffer.
152 */
153 353 void *SqliteMemoryManager::AssignLookasideBuffer(sqlite3 *db) {
154 353 const MutexLockGuard lock_guard(lock_);
155
156
1/2
✓ Branch 1 taken 353 times.
✗ Branch 2 not taken.
 353 void *buffer = GetLookasideBuffer();
157
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 353 times.
 353 assert(buffer != NULL);
158
1/2
✓ Branch 1 taken 353 times.
✗ Branch 2 not taken.
 353 const int retval = sqlite3_db_config(db, SQLITE_DBCONFIG_LOOKASIDE, buffer,
159 kLookasideSlotSize,
160 kLookasideSlotsPerDb);
161
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 353 times.
 353 assert(retval == SQLITE_OK);
162 353 return buffer;
163 353 }
164
165
166 760 void SqliteMemoryManager::CleanupInstance() {
167
1/2
✓ Branch 0 taken 760 times.
✗ Branch 1 not taken.
 760 delete instance_;
168 760 instance_ = NULL;
169 760 }
170
171
172 /**
173 * Opens a new arena if necessary.
174 */
175 1772 void *SqliteMemoryManager::GetLookasideBuffer() {
176 void *result;
177 vector<LookasideBufferArena *>::reverse_iterator
178 1772 reverse_iter = lookaside_buffer_arenas_.rbegin();
179 const vector<LookasideBufferArena *>::reverse_iterator
180 1772 i_rend = lookaside_buffer_arenas_.rend();
181
3/4
✓ Branch 2 taken 1783 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 1772 times.
✓ Branch 5 taken 11 times.
 1783 for (; reverse_iter != i_rend; ++reverse_iter) {
182 1772 result = (*reverse_iter)->GetBuffer();
183
2/2
✓ Branch 0 taken 1761 times.
✓ Branch 1 taken 11 times.
 1772 if (result != NULL)
184 1761 return result;
185 }
186
187
1/2
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
 11 LookasideBufferArena *new_arena = new LookasideBufferArena();
188
1/2
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
 11 lookaside_buffer_arenas_.push_back(new_arena);
189 11 return new_arena->GetBuffer();
190 }
191
192
193 871495 int SqliteMemoryManager::GetMemorySize(void *ptr) {
194 871495 return MallocArena::GetMallocArena(ptr, kArenaSize)->GetSize(ptr);
195 }
196
197
198 /**
199 * Opens new arenas as necessary.
200 */
201 740383 void *SqliteMemoryManager::GetMemory(int size) {
202
1/2
✓ Branch 2 taken 740383 times.
✗ Branch 3 not taken.
 740383 void *p = malloc_arenas_[idx_last_arena_]->Malloc(size);
203
2/2
✓ Branch 0 taken 740372 times.
✓ Branch 1 taken 11 times.
 740383 if (p != NULL)
204 740372 return p;
205 11 const unsigned N = malloc_arenas_.size();
206
2/2
✓ Branch 0 taken 11 times.
✓ Branch 1 taken 11 times.
 22 for (unsigned i = 0; i < N; ++i) {
207
1/2
✓ Branch 2 taken 11 times.
✗ Branch 3 not taken.
 11 p = malloc_arenas_[i]->Malloc(size);
208
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
 11 if (p != NULL) {
209 ✗ idx_last_arena_ = i;
210 ✗ return p;
211 }
212 }
213 11 idx_last_arena_ = N;
214
2/4
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 11 times.
✗ Branch 5 not taken.
 11 MallocArena *M = new MallocArena(kArenaSize);
215
1/2
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
 11 malloc_arenas_.push_back(M);
216
1/2
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
 11 p = M->Malloc(size);
217
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
 11 assert(p != NULL);
218 11 return p;
219 }
220
221
222 764 SqliteMemoryManager::SqliteMemoryManager()
223 764 : assigned_(false)
224 764 , page_cache_memory_(sxmmap(kPageCacheSize))
225 764 , idx_last_arena_(0) {
226 764 memset(&sqlite3_mem_vanilla_, 0, sizeof(sqlite3_mem_vanilla_));
227 764 const int retval = pthread_mutex_init(&lock_, NULL);
228
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 764 times.
 764 assert(retval == 0);
229
230
2/4
✓ Branch 1 taken 764 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 764 times.
✗ Branch 6 not taken.
 764 lookaside_buffer_arenas_.push_back(new LookasideBufferArena());
231
3/6
✓ Branch 1 taken 764 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 764 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 764 times.
✗ Branch 8 not taken.
 764 malloc_arenas_.push_back(new MallocArena(kArenaSize));
232
233 764 memset(&mem_methods_, 0, sizeof(mem_methods_));
234 764 mem_methods_.xMalloc = xMalloc;
235 764 mem_methods_.xFree = xFree;
236 764 mem_methods_.xRealloc = xRealloc;
237 764 mem_methods_.xSize = xSize;
238 764 mem_methods_.xRoundup = xRoundup;
239 764 mem_methods_.xInit = xInit;
240 764 mem_methods_.xShutdown = xShutdown;
241 764 mem_methods_.pAppData = NULL;
242 764 }
243
244
245 /**
246 * Must be executed only after sqlite3_shutdown.
247 */
248 760 SqliteMemoryManager::~SqliteMemoryManager() {
249
2/2
✓ Branch 0 taken 705 times.
✓ Branch 1 taken 55 times.
 760 if (assigned_) {
250 // Reset sqlite to default values
251 int retval;
252 705 retval = sqlite3_config(SQLITE_CONFIG_PAGECACHE, NULL, 0, 0);
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 705 times.
 705 assert(retval == SQLITE_OK);
254 705 retval = sqlite3_config(SQLITE_CONFIG_MALLOC, &sqlite3_mem_vanilla_);
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 705 times.
 705 assert(retval == SQLITE_OK);
256 }
257
258 760 sxunmap(page_cache_memory_, kPageCacheSize);
259
2/2
✓ Branch 1 taken 760 times.
✓ Branch 2 taken 760 times.
 1520 for (unsigned i = 0; i < lookaside_buffer_arenas_.size(); ++i)
260
1/2
✓ Branch 1 taken 760 times.
✗ Branch 2 not taken.
 760 delete lookaside_buffer_arenas_[i];
261
2/2
✓ Branch 1 taken 760 times.
✓ Branch 2 taken 760 times.
 1520 for (unsigned i = 0; i < malloc_arenas_.size(); ++i)
262
1/2
✓ Branch 1 taken 760 times.
✗ Branch 2 not taken.
 760 delete malloc_arenas_[i];
263 760 pthread_mutex_destroy(&lock_);
264 760 }
265
266
267 /**
268 * Only entirely empty arenas are freed to the system. In cvmfs, catalogs
269 * are gradually opened and sometimes close altogether when a new root catalog
270 * arrives. Hence there is no fragmentation.
271 */
272 1772 void SqliteMemoryManager::PutLookasideBuffer(void *buffer) {
273 1772 const unsigned N = lookaside_buffer_arenas_.size();
274
1/2
✓ Branch 0 taken 1772 times.
✗ Branch 1 not taken.
 1772 for (unsigned i = 0; i < N; ++i) {
275
1/2
✓ Branch 2 taken 1772 times.
✗ Branch 3 not taken.
 1772 if (lookaside_buffer_arenas_[i]->Contains(buffer)) {
276 1772 lookaside_buffer_arenas_[i]->PutBuffer(buffer);
277
6/6
✓ Branch 0 taken 1408 times.
✓ Branch 1 taken 364 times.
✓ Branch 4 taken 11 times.
✓ Branch 5 taken 1397 times.
✓ Branch 6 taken 11 times.
✓ Branch 7 taken 1761 times.
 1772 if ((N > 1) && lookaside_buffer_arenas_[i]->IsEmpty()) {
278
1/2
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
 11 delete lookaside_buffer_arenas_[i];
279
1/2
✓ Branch 4 taken 11 times.
✗ Branch 5 not taken.
 11 lookaside_buffer_arenas_.erase(lookaside_buffer_arenas_.begin() + i);
280 }
281 1772 return;
282 }
283 }
284 ✗ PANIC(NULL);
285 }
286
287
288 /**
289 * Closes empty areas.
290 */
291 520268 void SqliteMemoryManager::PutMemory(void *ptr) {
292 520268 MallocArena *M = MallocArena::GetMallocArena(ptr, kArenaSize);
293 520268 M->Free(ptr);
294 520268 const unsigned N = malloc_arenas_.size();
295
5/6
✓ Branch 0 taken 11 times.
✓ Branch 1 taken 520257 times.
✓ Branch 3 taken 11 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 11 times.
✓ Branch 6 taken 520257 times.
 520268 if ((N > 1) && M->IsEmpty()) {
296
1/2
✓ Branch 0 taken 22 times.
✗ Branch 1 not taken.
 22 for (unsigned i = 0; i < N; ++i) {
297
2/2
✓ Branch 1 taken 11 times.
✓ Branch 2 taken 11 times.
 22 if (malloc_arenas_[i] == M) {
298
1/2
✓ Branch 1 taken 11 times.
✗ Branch 2 not taken.
 11 delete malloc_arenas_[i];
299
1/2
✓ Branch 4 taken 11 times.
✗ Branch 5 not taken.
 11 malloc_arenas_.erase(malloc_arenas_.begin() + i);
300 11 idx_last_arena_ = 0;
301 11 return;
302 }
303 }
304 ✗ PANIC(NULL);
305 }
306 }
307
308
309 /**
310 * To be used after an sqlite database has been closed.
311 */
312 353 void SqliteMemoryManager::ReleaseLookasideBuffer(void *buffer) {
313 353 const MutexLockGuard lock_guard(lock_);
314
1/2
✓ Branch 1 taken 353 times.
✗ Branch 2 not taken.
 353 PutLookasideBuffer(buffer);
315 353 }
316