GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/sqlitemem.cc
Date: 2026-04-12 02:41:08
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 1755 void *SqliteMemoryManager::LookasideBufferArena::GetBuffer() {
24
2/2
✓ Branch 0 taken 2245 times.
✓ Branch 1 taken 3 times.
 2248 for (unsigned i = 0; i < kNoBitmaps; ++i) {
25 2245 const int bit_set = ffs(freemap_[i]);
26
2/2
✓ Branch 0 taken 1752 times.
✓ Branch 1 taken 493 times.
 2245 if (bit_set != 0) {
27 1752 freemap_[i] &= ~(1 << (bit_set - 1)); // set bit to zero
28 1752 const int nbuffer = i * sizeof(int) * 8 + bit_set - 1;
29 1752 return reinterpret_cast<char *>(arena_) + nbuffer * kBufferSize;
30 }
31 }
32 3 return NULL;
33 }
34
35
36 133 bool SqliteMemoryManager::LookasideBufferArena::IsEmpty() {
37
2/2
✓ Branch 0 taken 337 times.
✓ Branch 1 taken 4 times.
 341 for (unsigned i = 0; i < kNoBitmaps; ++i) {
38
2/2
✓ Branch 0 taken 129 times.
✓ Branch 1 taken 208 times.
 337 if (~freemap_[i] != 0)
39 129 return false;
40 }
41 4 return true;
42 }
43
44
45 1755 bool SqliteMemoryManager::LookasideBufferArena::Contains(void *buffer) {
46
3/4
✓ Branch 0 taken 1755 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 1 times.
✓ Branch 3 taken 1754 times.
 1755 if ((buffer == NULL) || (buffer < arena_))
47 1 return false;
48 1754 return (static_cast<uint64_t>((reinterpret_cast<char *>(buffer)
49 1754 - reinterpret_cast<char *>(arena_)))
50 1754 < kArenaSize);
51 }
52
53
54 3282 SqliteMemoryManager::LookasideBufferArena::LookasideBufferArena()
55 3282 : arena_(sxmmap(kArenaSize)) {
56 // All buffers unused, i.e. all bits set
57 3282 memset(freemap_, 0xFF, kNoBitmaps * sizeof(int));
58 3282 }
59
60
61 3278 SqliteMemoryManager::LookasideBufferArena::~LookasideBufferArena() {
62 3278 sxunmap(arena_, kArenaSize);
63 3278 }
64
65
66 1752 void SqliteMemoryManager::LookasideBufferArena::PutBuffer(void *buffer) {
67
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1752 times.
 1752 assert(buffer >= arena_);
68 1752 const ptrdiff_t nbuffer = (reinterpret_cast<char *>(buffer)
69 1752 - reinterpret_cast<char *>(arena_))
70 / kBufferSize;
71
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1752 times.
 1752 assert(static_cast<uint64_t>(nbuffer) < kBuffersPerArena);
72 1752 const int nfreemap = nbuffer / (sizeof(int) * 8);
73 1752 freemap_[nfreemap] |= 1 << (nbuffer % (sizeof(int) * 8));
74 1752 }
75
76
77 //------------------------------------------------------------------------------
78
79
80 SqliteMemoryManager *SqliteMemoryManager::instance_ = NULL;
81
82
83 /**
84 * Sqlite ensures that size > 0.
85 */
86 1348841 void *SqliteMemoryManager::xMalloc(int size) {
87 1348841 return instance_->GetMemory(size);
88 }
89
90
91 /**
92 * Sqlite ensures that ptr != NULL.
93 */
94 1348748 void SqliteMemoryManager::xFree(void *ptr) { instance_->PutMemory(ptr); }
95
96
97 /**
98 * Sqlite ensures that ptr != NULL and new_size > 0.
99 */
100 125879 void *SqliteMemoryManager::xRealloc(void *ptr, int new_size) {
101 125879 const int old_size = xSize(ptr);
102
2/2
✓ Branch 0 taken 3719 times.
✓ Branch 1 taken 122160 times.
 125879 if (old_size >= new_size)
103 3719 return ptr;
104
105 122160 void *new_ptr = xMalloc(new_size);
106 122160 memcpy(new_ptr, ptr, old_size);
107 122160 xFree(ptr);
108 122160 return new_ptr;
109 }
110
111
112 /**
113 * Sqlite ensures that ptr != NULL.
114 */
115 2855828 int SqliteMemoryManager::xSize(void *ptr) {
116 2855828 return instance_->GetMemorySize(ptr);
117 }
118
119
120 1332559 int SqliteMemoryManager::xRoundup(int size) { return RoundUp8(size); }
121
122
123 3275 int SqliteMemoryManager::xInit(void *app_data __attribute__((unused))) {
124 3275 return SQLITE_OK;
125 }
126
127
128 3271 void SqliteMemoryManager::xShutdown(void *app_data __attribute__((unused))) { }
129
130
131 3275 void SqliteMemoryManager::AssignGlobalArenas() {
132
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3275 times.
 3275 if (assigned_)
133 ✗ return;
134 int retval;
135
136 3275 retval = sqlite3_config(SQLITE_CONFIG_PAGECACHE, page_cache_memory_,
137 kPageCacheSlotSize, kPageCacheNoSlots);
138
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3275 times.
 3275 assert(retval == SQLITE_OK);
139
140 3275 retval = sqlite3_config(SQLITE_CONFIG_GETMALLOC, &sqlite3_mem_vanilla_);
141
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3275 times.
 3275 assert(retval == SQLITE_OK);
142 3275 retval = sqlite3_config(SQLITE_CONFIG_MALLOC, &mem_methods_);
143
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3275 times.
 3275 assert(retval == SQLITE_OK);
144
145 3275 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 1430 void *SqliteMemoryManager::AssignLookasideBuffer(sqlite3 *db) {
154 1430 const MutexLockGuard lock_guard(lock_);
155
156
1/2
✓ Branch 1 taken 1430 times.
✗ Branch 2 not taken.
 1430 void *buffer = GetLookasideBuffer();
157
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1430 times.
 1430 assert(buffer != NULL);
158
1/2
✓ Branch 1 taken 1430 times.
✗ Branch 2 not taken.
 1430 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 1430 times.
 1430 assert(retval == SQLITE_OK);
162 1430 return buffer;
163 1430 }
164
165
166 3276 void SqliteMemoryManager::CleanupInstance() {
167
1/2
✓ Branch 0 taken 3276 times.
✗ Branch 1 not taken.
 3276 delete instance_;
168 3276 instance_ = NULL;
169 3276 }
170
171
172 /**
173 * Opens a new arena if necessary.
174 */
175 1559 void *SqliteMemoryManager::GetLookasideBuffer() {
176 void *result;
177 vector<LookasideBufferArena *>::reverse_iterator
178 1559 reverse_iter = lookaside_buffer_arenas_.rbegin();
179 const vector<LookasideBufferArena *>::reverse_iterator
180 1559 i_rend = lookaside_buffer_arenas_.rend();
181
3/4
✓ Branch 2 taken 1560 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 1559 times.
✓ Branch 5 taken 1 times.
 1560 for (; reverse_iter != i_rend; ++reverse_iter) {
182 1559 result = (*reverse_iter)->GetBuffer();
183
2/2
✓ Branch 0 taken 1558 times.
✓ Branch 1 taken 1 times.
 1559 if (result != NULL)
184 1558 return result;
185 }
186
187
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 LookasideBufferArena *new_arena = new LookasideBufferArena();
188
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 lookaside_buffer_arenas_.push_back(new_arena);
189 1 return new_arena->GetBuffer();
190 }
191
192
193 2855832 int SqliteMemoryManager::GetMemorySize(void *ptr) {
194 2855832 return MallocArena::GetMallocArena(ptr, kArenaSize)->GetSize(ptr);
195 }
196
197
198 /**
199 * Opens new arenas as necessary.
200 */
201 1368847 void *SqliteMemoryManager::GetMemory(int size) {
202
1/2
✓ Branch 2 taken 1368847 times.
✗ Branch 3 not taken.
 1368847 void *p = malloc_arenas_[idx_last_arena_]->Malloc(size);
203
2/2
✓ Branch 0 taken 1368846 times.
✓ Branch 1 taken 1 times.
 1368847 if (p != NULL)
204 1368846 return p;
205 1 const unsigned N = malloc_arenas_.size();
206
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1 times.
 2 for (unsigned i = 0; i < N; ++i) {
207
1/2
✓ Branch 2 taken 1 times.
✗ Branch 3 not taken.
 1 p = malloc_arenas_[i]->Malloc(size);
208
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 if (p != NULL) {
209 ✗ idx_last_arena_ = i;
210 ✗ return p;
211 }
212 }
213 1 idx_last_arena_ = N;
214
2/4
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 1 times.
✗ Branch 5 not taken.
 1 MallocArena *M = new MallocArena(kArenaSize);
215
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 malloc_arenas_.push_back(M);
216
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 p = M->Malloc(size);
217
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 assert(p != NULL);
218 1 return p;
219 }
220
221
222 3280 SqliteMemoryManager::SqliteMemoryManager()
223 3280 : assigned_(false)
224 3280 , page_cache_memory_(sxmmap(kPageCacheSize))
225 3280 , idx_last_arena_(0) {
226 3280 memset(&sqlite3_mem_vanilla_, 0, sizeof(sqlite3_mem_vanilla_));
227 3280 const int retval = pthread_mutex_init(&lock_, NULL);
228
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3280 times.
 3280 assert(retval == 0);
229
230
2/4
✓ Branch 1 taken 3280 times.
✗ Branch 2 not taken.
✓ Branch 5 taken 3280 times.
✗ Branch 6 not taken.
 3280 lookaside_buffer_arenas_.push_back(new LookasideBufferArena());
231
3/6
✓ Branch 1 taken 3280 times.
✗ Branch 2 not taken.
✓ Branch 4 taken 3280 times.
✗ Branch 5 not taken.
✓ Branch 7 taken 3280 times.
✗ Branch 8 not taken.
 3280 malloc_arenas_.push_back(new MallocArena(kArenaSize));
232
233 3280 memset(&mem_methods_, 0, sizeof(mem_methods_));
234 3280 mem_methods_.xMalloc = xMalloc;
235 3280 mem_methods_.xFree = xFree;
236 3280 mem_methods_.xRealloc = xRealloc;
237 3280 mem_methods_.xSize = xSize;
238 3280 mem_methods_.xRoundup = xRoundup;
239 3280 mem_methods_.xInit = xInit;
240 3280 mem_methods_.xShutdown = xShutdown;
241 3280 mem_methods_.pAppData = NULL;
242 3280 }
243
244
245 /**
246 * Must be executed only after sqlite3_shutdown.
247 */
248 3276 SqliteMemoryManager::~SqliteMemoryManager() {
249
2/2
✓ Branch 0 taken 3271 times.
✓ Branch 1 taken 5 times.
 3276 if (assigned_) {
250 // Reset sqlite to default values
251 int retval;
252 3271 retval = sqlite3_config(SQLITE_CONFIG_PAGECACHE, NULL, 0, 0);
253
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3271 times.
 3271 assert(retval == SQLITE_OK);
254 3271 retval = sqlite3_config(SQLITE_CONFIG_MALLOC, &sqlite3_mem_vanilla_);
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3271 times.
 3271 assert(retval == SQLITE_OK);
256 }
257
258 3276 sxunmap(page_cache_memory_, kPageCacheSize);
259
2/2
✓ Branch 1 taken 3276 times.
✓ Branch 2 taken 3276 times.
 6552 for (unsigned i = 0; i < lookaside_buffer_arenas_.size(); ++i)
260
1/2
✓ Branch 1 taken 3276 times.
✗ Branch 2 not taken.
 3276 delete lookaside_buffer_arenas_[i];
261
2/2
✓ Branch 1 taken 3276 times.
✓ Branch 2 taken 3276 times.
 6552 for (unsigned i = 0; i < malloc_arenas_.size(); ++i)
262
1/2
✓ Branch 1 taken 3276 times.
✗ Branch 2 not taken.
 3276 delete malloc_arenas_[i];
263 3276 pthread_mutex_destroy(&lock_);
264 3276 }
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 1559 void SqliteMemoryManager::PutLookasideBuffer(void *buffer) {
273 1559 const unsigned N = lookaside_buffer_arenas_.size();
274
1/2
✓ Branch 0 taken 1559 times.
✗ Branch 1 not taken.
 1559 for (unsigned i = 0; i < N; ++i) {
275
1/2
✓ Branch 2 taken 1559 times.
✗ Branch 3 not taken.
 1559 if (lookaside_buffer_arenas_[i]->Contains(buffer)) {
276 1559 lookaside_buffer_arenas_[i]->PutBuffer(buffer);
277
6/6
✓ Branch 0 taken 128 times.
✓ Branch 1 taken 1431 times.
✓ Branch 4 taken 1 times.
✓ Branch 5 taken 127 times.
✓ Branch 6 taken 1 times.
✓ Branch 7 taken 1558 times.
 1559 if ((N > 1) && lookaside_buffer_arenas_[i]->IsEmpty()) {
278
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 delete lookaside_buffer_arenas_[i];
279
1/2
✓ Branch 4 taken 1 times.
✗ Branch 5 not taken.
 1 lookaside_buffer_arenas_.erase(lookaside_buffer_arenas_.begin() + i);
280 }
281 1559 return;
282 }
283 }
284 ✗ PANIC(NULL);
285 }
286
287
288 /**
289 * Closes empty areas.
290 */
291 1348752 void SqliteMemoryManager::PutMemory(void *ptr) {
292 1348752 MallocArena *M = MallocArena::GetMallocArena(ptr, kArenaSize);
293 1348752 M->Free(ptr);
294 1348752 const unsigned N = malloc_arenas_.size();
295
5/6
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1348751 times.
✓ Branch 3 taken 1 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 1 times.
✓ Branch 6 taken 1348751 times.
 1348752 if ((N > 1) && M->IsEmpty()) {
296
1/2
✓ Branch 0 taken 2 times.
✗ Branch 1 not taken.
 2 for (unsigned i = 0; i < N; ++i) {
297
2/2
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 1 times.
 2 if (malloc_arenas_[i] == M) {
298
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 delete malloc_arenas_[i];
299
1/2
✓ Branch 4 taken 1 times.
✗ Branch 5 not taken.
 1 malloc_arenas_.erase(malloc_arenas_.begin() + i);
300 1 idx_last_arena_ = 0;
301 1 return;
302 }
303 }
304 ✗ PANIC(NULL);
305 }
306 }
307
308
309 /**
310 * To be used after an sqlite database has been closed.
311 */
312 1430 void SqliteMemoryManager::ReleaseLookasideBuffer(void *buffer) {
313 1430 const MutexLockGuard lock_guard(lock_);
314
1/2
✓ Branch 1 taken 1430 times.
✗ Branch 2 not taken.
 1430 PutLookasideBuffer(buffer);
315 1430 }
316