GCC Code Coverage Report

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