GCC Code Coverage Report

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