GCC Code Coverage Report

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