blob: f06e27d8465177013b61c3e82fc5d9e9f306ba6e [file] [log] [blame]
drha3152892007-05-05 11:48:52 +00001/*
2** 2001 September 15
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
10**
11*************************************************************************
drhfec00ea2008-06-14 16:56:21 +000012**
drha3152892007-05-05 11:48:52 +000013** Memory allocation functions used throughout sqlite.
drha3152892007-05-05 11:48:52 +000014*/
15#include "sqliteInt.h"
drha3152892007-05-05 11:48:52 +000016#include <stdarg.h>
drha3152892007-05-05 11:48:52 +000017
18/*
danielk197784680242008-06-23 11:11:35 +000019** Attempt to release up to n bytes of non-essential memory currently
20** held by SQLite. An example of non-essential memory is memory used to
21** cache database pages that are not currently in use.
drha3152892007-05-05 11:48:52 +000022*/
23int sqlite3_release_memory(int n){
drh86f8c192007-08-22 00:39:19 +000024#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh9f129f42010-08-31 15:27:32 +000025 return sqlite3PcacheReleaseMemory(n);
danielk19771e536952007-08-16 10:09:01 +000026#else
drh9f129f42010-08-31 15:27:32 +000027 /* IMPLEMENTATION-OF: R-34391-24921 The sqlite3_release_memory() routine
28 ** is a no-op returning zero if SQLite is not compiled with
29 ** SQLITE_ENABLE_MEMORY_MANAGEMENT. */
danielk197762c14b32008-11-19 09:05:26 +000030 UNUSED_PARAMETER(n);
drh9f129f42010-08-31 15:27:32 +000031 return 0;
danielk19771e536952007-08-16 10:09:01 +000032#endif
drha3152892007-05-05 11:48:52 +000033}
drha3152892007-05-05 11:48:52 +000034
drhfec00ea2008-06-14 16:56:21 +000035/*
drhbadc9802010-08-27 17:16:44 +000036** An instance of the following object records the location of
37** each unused scratch buffer.
38*/
39typedef struct ScratchFreeslot {
40 struct ScratchFreeslot *pNext; /* Next unused scratch buffer */
41} ScratchFreeslot;
42
43/*
drhfec00ea2008-06-14 16:56:21 +000044** State information local to the memory allocation subsystem.
45*/
danielk19775c8f8582008-09-02 10:22:00 +000046static SQLITE_WSD struct Mem0Global {
drhfec00ea2008-06-14 16:56:21 +000047 sqlite3_mutex *mutex; /* Mutex to serialize access */
48
49 /*
50 ** The alarm callback and its arguments. The mem0.mutex lock will
51 ** be held while the callback is running. Recursive calls into
52 ** the memory subsystem are allowed, but no new callbacks will be
drhe64ca7b2009-07-16 18:21:17 +000053 ** issued.
drhfec00ea2008-06-14 16:56:21 +000054 */
55 sqlite3_int64 alarmThreshold;
56 void (*alarmCallback)(void*, sqlite3_int64,int);
57 void *alarmArg;
drhfec00ea2008-06-14 16:56:21 +000058
59 /*
drhbadc9802010-08-27 17:16:44 +000060 ** Pointers to the end of sqlite3GlobalConfig.pScratch memory
61 ** (so that a range test can be used to determine if an allocation
62 ** being freed came from pScratch) and a pointer to the list of
63 ** unused scratch allocations.
drh9ac3fe92008-06-18 18:12:04 +000064 */
drhbadc9802010-08-27 17:16:44 +000065 void *pScratchEnd;
66 ScratchFreeslot *pScratchFree;
67 u32 nScratchFree;
drh50d1b5f2010-08-27 12:21:06 +000068
69 /*
70 ** True if heap is nearly "full" where "full" is defined by the
71 ** sqlite3_soft_heap_limit() setting.
72 */
73 int nearlyFull;
drh6ac78a02010-09-28 14:26:36 +000074} mem0 = { 0, 0, 0, 0, 0, 0, 0, 0 };
danielk19775c8f8582008-09-02 10:22:00 +000075
76#define mem0 GLOBAL(struct Mem0Global, mem0)
drhfec00ea2008-06-14 16:56:21 +000077
78/*
drhaf89fe62015-03-23 17:25:18 +000079** Return the memory allocator mutex. sqlite3_status() needs it.
80*/
81sqlite3_mutex *sqlite3MallocMutex(void){
82 return mem0.mutex;
83}
84
85/*
drhf82ccf62010-09-15 17:54:31 +000086** This routine runs when the memory allocator sees that the
87** total memory allocation is about to exceed the soft heap
88** limit.
89*/
90static void softHeapLimitEnforcer(
91 void *NotUsed,
92 sqlite3_int64 NotUsed2,
93 int allocSize
94){
95 UNUSED_PARAMETER2(NotUsed, NotUsed2);
96 sqlite3_release_memory(allocSize);
97}
98
99/*
100** Change the alarm callback
101*/
102static int sqlite3MemoryAlarm(
103 void(*xCallback)(void *pArg, sqlite3_int64 used,int N),
104 void *pArg,
105 sqlite3_int64 iThreshold
106){
drhaf89fe62015-03-23 17:25:18 +0000107 sqlite3_int64 nUsed;
drhf82ccf62010-09-15 17:54:31 +0000108 sqlite3_mutex_enter(mem0.mutex);
109 mem0.alarmCallback = xCallback;
110 mem0.alarmArg = pArg;
111 mem0.alarmThreshold = iThreshold;
112 nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
113 mem0.nearlyFull = (iThreshold>0 && iThreshold<=nUsed);
114 sqlite3_mutex_leave(mem0.mutex);
115 return SQLITE_OK;
116}
117
118#ifndef SQLITE_OMIT_DEPRECATED
119/*
120** Deprecated external interface. Internal/core SQLite code
121** should call sqlite3MemoryAlarm.
122*/
123int sqlite3_memory_alarm(
124 void(*xCallback)(void *pArg, sqlite3_int64 used,int N),
125 void *pArg,
126 sqlite3_int64 iThreshold
127){
128 return sqlite3MemoryAlarm(xCallback, pArg, iThreshold);
129}
130#endif
131
132/*
133** Set the soft heap-size limit for the library. Passing a zero or
134** negative value indicates no limit.
135*/
136sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 n){
137 sqlite3_int64 priorLimit;
138 sqlite3_int64 excess;
139#ifndef SQLITE_OMIT_AUTOINIT
drhde0f1812011-12-22 17:10:35 +0000140 int rc = sqlite3_initialize();
141 if( rc ) return -1;
drhf82ccf62010-09-15 17:54:31 +0000142#endif
143 sqlite3_mutex_enter(mem0.mutex);
144 priorLimit = mem0.alarmThreshold;
145 sqlite3_mutex_leave(mem0.mutex);
146 if( n<0 ) return priorLimit;
147 if( n>0 ){
148 sqlite3MemoryAlarm(softHeapLimitEnforcer, 0, n);
149 }else{
150 sqlite3MemoryAlarm(0, 0, 0);
151 }
152 excess = sqlite3_memory_used() - n;
shaneh4b03f212010-10-04 14:11:54 +0000153 if( excess>0 ) sqlite3_release_memory((int)(excess & 0x7fffffff));
drhf82ccf62010-09-15 17:54:31 +0000154 return priorLimit;
155}
156void sqlite3_soft_heap_limit(int n){
157 if( n<0 ) n = 0;
158 sqlite3_soft_heap_limit64(n);
159}
160
161/*
drhfec00ea2008-06-14 16:56:21 +0000162** Initialize the memory allocation subsystem.
163*/
164int sqlite3MallocInit(void){
drh592f0cb2015-03-26 17:04:23 +0000165 int rc;
danielk1977075c23a2008-09-01 18:34:20 +0000166 if( sqlite3GlobalConfig.m.xMalloc==0 ){
drhfec00ea2008-06-14 16:56:21 +0000167 sqlite3MemSetDefault();
168 }
169 memset(&mem0, 0, sizeof(mem0));
danielk1977075c23a2008-09-01 18:34:20 +0000170 if( sqlite3GlobalConfig.bCoreMutex ){
danielk197759f8c082008-06-18 17:09:10 +0000171 mem0.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
drhfec00ea2008-06-14 16:56:21 +0000172 }
danielk1977075c23a2008-09-01 18:34:20 +0000173 if( sqlite3GlobalConfig.pScratch && sqlite3GlobalConfig.szScratch>=100
drh7ff27192010-09-02 18:13:00 +0000174 && sqlite3GlobalConfig.nScratch>0 ){
drhbadc9802010-08-27 17:16:44 +0000175 int i, n, sz;
176 ScratchFreeslot *pSlot;
177 sz = ROUNDDOWN8(sqlite3GlobalConfig.szScratch);
178 sqlite3GlobalConfig.szScratch = sz;
179 pSlot = (ScratchFreeslot*)sqlite3GlobalConfig.pScratch;
180 n = sqlite3GlobalConfig.nScratch;
181 mem0.pScratchFree = pSlot;
182 mem0.nScratchFree = n;
183 for(i=0; i<n-1; i++){
184 pSlot->pNext = (ScratchFreeslot*)(sz+(char*)pSlot);
185 pSlot = pSlot->pNext;
186 }
187 pSlot->pNext = 0;
188 mem0.pScratchEnd = (void*)&pSlot[1];
drh9ac3fe92008-06-18 18:12:04 +0000189 }else{
drhbadc9802010-08-27 17:16:44 +0000190 mem0.pScratchEnd = 0;
danielk1977075c23a2008-09-01 18:34:20 +0000191 sqlite3GlobalConfig.pScratch = 0;
192 sqlite3GlobalConfig.szScratch = 0;
drhbadc9802010-08-27 17:16:44 +0000193 sqlite3GlobalConfig.nScratch = 0;
drh9ac3fe92008-06-18 18:12:04 +0000194 }
drh50d1b5f2010-08-27 12:21:06 +0000195 if( sqlite3GlobalConfig.pPage==0 || sqlite3GlobalConfig.szPage<512
196 || sqlite3GlobalConfig.nPage<1 ){
danielk1977075c23a2008-09-01 18:34:20 +0000197 sqlite3GlobalConfig.pPage = 0;
198 sqlite3GlobalConfig.szPage = 0;
drh50d1b5f2010-08-27 12:21:06 +0000199 sqlite3GlobalConfig.nPage = 0;
drh9ac3fe92008-06-18 18:12:04 +0000200 }
drh592f0cb2015-03-26 17:04:23 +0000201 rc = sqlite3GlobalConfig.m.xInit(sqlite3GlobalConfig.m.pAppData);
202 if( rc!=SQLITE_OK ) memset(&mem0, 0, sizeof(mem0));
203 return rc;
drhfec00ea2008-06-14 16:56:21 +0000204}
205
206/*
drh50d1b5f2010-08-27 12:21:06 +0000207** Return true if the heap is currently under memory pressure - in other
208** words if the amount of heap used is close to the limit set by
209** sqlite3_soft_heap_limit().
210*/
211int sqlite3HeapNearlyFull(void){
212 return mem0.nearlyFull;
213}
214
215/*
drhfec00ea2008-06-14 16:56:21 +0000216** Deinitialize the memory allocation subsystem.
217*/
218void sqlite3MallocEnd(void){
danielk19770a549072009-02-17 16:29:10 +0000219 if( sqlite3GlobalConfig.m.xShutdown ){
220 sqlite3GlobalConfig.m.xShutdown(sqlite3GlobalConfig.m.pAppData);
221 }
drh9ac3fe92008-06-18 18:12:04 +0000222 memset(&mem0, 0, sizeof(mem0));
drhfec00ea2008-06-14 16:56:21 +0000223}
224
225/*
226** Return the amount of memory currently checked out.
227*/
228sqlite3_int64 sqlite3_memory_used(void){
drhf7141992008-06-19 00:16:08 +0000229 int n, mx;
drhc376a192008-07-14 12:30:54 +0000230 sqlite3_int64 res;
drhf7141992008-06-19 00:16:08 +0000231 sqlite3_status(SQLITE_STATUS_MEMORY_USED, &n, &mx, 0);
drhc376a192008-07-14 12:30:54 +0000232 res = (sqlite3_int64)n; /* Work around bug in Borland C. Ticket #3216 */
233 return res;
drhfec00ea2008-06-14 16:56:21 +0000234}
235
236/*
237** Return the maximum amount of memory that has ever been
238** checked out since either the beginning of this process
239** or since the most recent reset.
240*/
241sqlite3_int64 sqlite3_memory_highwater(int resetFlag){
drhf7141992008-06-19 00:16:08 +0000242 int n, mx;
drhc376a192008-07-14 12:30:54 +0000243 sqlite3_int64 res;
drhf7141992008-06-19 00:16:08 +0000244 sqlite3_status(SQLITE_STATUS_MEMORY_USED, &n, &mx, resetFlag);
drh7986a712008-07-14 12:38:20 +0000245 res = (sqlite3_int64)mx; /* Work around bug in Borland C. Ticket #3216 */
drhc376a192008-07-14 12:30:54 +0000246 return res;
drhfec00ea2008-06-14 16:56:21 +0000247}
248
249/*
drhfec00ea2008-06-14 16:56:21 +0000250** Trigger the alarm
251*/
252static void sqlite3MallocAlarm(int nByte){
253 void (*xCallback)(void*,sqlite3_int64,int);
254 sqlite3_int64 nowUsed;
255 void *pArg;
drhe64ca7b2009-07-16 18:21:17 +0000256 if( mem0.alarmCallback==0 ) return;
drhfec00ea2008-06-14 16:56:21 +0000257 xCallback = mem0.alarmCallback;
drhf7141992008-06-19 00:16:08 +0000258 nowUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
drhfec00ea2008-06-14 16:56:21 +0000259 pArg = mem0.alarmArg;
drhe64ca7b2009-07-16 18:21:17 +0000260 mem0.alarmCallback = 0;
drhfec00ea2008-06-14 16:56:21 +0000261 sqlite3_mutex_leave(mem0.mutex);
262 xCallback(pArg, nowUsed, nByte);
263 sqlite3_mutex_enter(mem0.mutex);
drhe64ca7b2009-07-16 18:21:17 +0000264 mem0.alarmCallback = xCallback;
265 mem0.alarmArg = pArg;
drhfec00ea2008-06-14 16:56:21 +0000266}
267
drhf7141992008-06-19 00:16:08 +0000268/*
269** Do a memory allocation with statistics and alarms. Assume the
270** lock is already held.
271*/
272static int mallocWithAlarm(int n, void **pp){
273 int nFull;
274 void *p;
275 assert( sqlite3_mutex_held(mem0.mutex) );
danielk1977075c23a2008-09-01 18:34:20 +0000276 nFull = sqlite3GlobalConfig.m.xRoundup(n);
drhf7141992008-06-19 00:16:08 +0000277 sqlite3StatusSet(SQLITE_STATUS_MALLOC_SIZE, n);
278 if( mem0.alarmCallback!=0 ){
drhaf89fe62015-03-23 17:25:18 +0000279 sqlite3_int64 nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
drh8e1bb042011-04-15 16:39:52 +0000280 if( nUsed >= mem0.alarmThreshold - nFull ){
drh50d1b5f2010-08-27 12:21:06 +0000281 mem0.nearlyFull = 1;
drhf7141992008-06-19 00:16:08 +0000282 sqlite3MallocAlarm(nFull);
drh50d1b5f2010-08-27 12:21:06 +0000283 }else{
284 mem0.nearlyFull = 0;
drhf7141992008-06-19 00:16:08 +0000285 }
286 }
danielk1977075c23a2008-09-01 18:34:20 +0000287 p = sqlite3GlobalConfig.m.xMalloc(nFull);
drh50d1b5f2010-08-27 12:21:06 +0000288#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk1977d09414c2008-06-19 18:17:49 +0000289 if( p==0 && mem0.alarmCallback ){
290 sqlite3MallocAlarm(nFull);
danielk1977075c23a2008-09-01 18:34:20 +0000291 p = sqlite3GlobalConfig.m.xMalloc(nFull);
drhf7141992008-06-19 00:16:08 +0000292 }
drh50d1b5f2010-08-27 12:21:06 +0000293#endif
drhc702c7c2008-07-18 18:56:16 +0000294 if( p ){
295 nFull = sqlite3MallocSize(p);
drhaf89fe62015-03-23 17:25:18 +0000296 sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nFull);
297 sqlite3StatusUp(SQLITE_STATUS_MALLOC_COUNT, 1);
drhc702c7c2008-07-18 18:56:16 +0000298 }
drhf7141992008-06-19 00:16:08 +0000299 *pp = p;
300 return nFull;
301}
drhfec00ea2008-06-14 16:56:21 +0000302
303/*
304** Allocate memory. This routine is like sqlite3_malloc() except that it
305** assumes the memory subsystem has already been initialized.
306*/
drhda4ca9d2014-09-09 17:27:35 +0000307void *sqlite3Malloc(u64 n){
drhfec00ea2008-06-14 16:56:21 +0000308 void *p;
drhda4ca9d2014-09-09 17:27:35 +0000309 if( n==0 || n>=0x7fffff00 ){
drhe08ed7e2009-06-26 18:35:16 +0000310 /* A memory allocation of a number of bytes which is near the maximum
311 ** signed integer value might cause an integer overflow inside of the
312 ** xMalloc(). Hence we limit the maximum size to 0x7fffff00, giving
313 ** 255 bytes of overhead. SQLite itself will never use anything near
314 ** this amount. The only way to reach the limit is with sqlite3_malloc() */
drhf7141992008-06-19 00:16:08 +0000315 p = 0;
danielk1977075c23a2008-09-01 18:34:20 +0000316 }else if( sqlite3GlobalConfig.bMemstat ){
drhfec00ea2008-06-14 16:56:21 +0000317 sqlite3_mutex_enter(mem0.mutex);
drh3329a632014-09-18 01:21:43 +0000318 mallocWithAlarm((int)n, &p);
drhfec00ea2008-06-14 16:56:21 +0000319 sqlite3_mutex_leave(mem0.mutex);
320 }else{
drhda4ca9d2014-09-09 17:27:35 +0000321 p = sqlite3GlobalConfig.m.xMalloc((int)n);
drhfec00ea2008-06-14 16:56:21 +0000322 }
drh8da47412014-10-03 14:54:47 +0000323 assert( EIGHT_BYTE_ALIGNMENT(p) ); /* IMP: R-11148-40995 */
drhfec00ea2008-06-14 16:56:21 +0000324 return p;
325}
326
327/*
328** This version of the memory allocation is for use by the application.
329** First make sure the memory subsystem is initialized, then do the
330** allocation.
331*/
332void *sqlite3_malloc(int n){
333#ifndef SQLITE_OMIT_AUTOINIT
334 if( sqlite3_initialize() ) return 0;
335#endif
drhda4ca9d2014-09-09 17:27:35 +0000336 return n<=0 ? 0 : sqlite3Malloc(n);
337}
338void *sqlite3_malloc64(sqlite3_uint64 n){
339#ifndef SQLITE_OMIT_AUTOINIT
340 if( sqlite3_initialize() ) return 0;
341#endif
drhfec00ea2008-06-14 16:56:21 +0000342 return sqlite3Malloc(n);
343}
344
345/*
drhe5ae5732008-06-15 02:51:47 +0000346** Each thread may only have a single outstanding allocation from
drhfacf0302008-06-17 15:12:00 +0000347** xScratchMalloc(). We verify this constraint in the single-threaded
348** case by setting scratchAllocOut to 1 when an allocation
drhe5ae5732008-06-15 02:51:47 +0000349** is outstanding clearing it when the allocation is freed.
350*/
351#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
drhfacf0302008-06-17 15:12:00 +0000352static int scratchAllocOut = 0;
drhe5ae5732008-06-15 02:51:47 +0000353#endif
354
355
356/*
357** Allocate memory that is to be used and released right away.
358** This routine is similar to alloca() in that it is not intended
359** for situations where the memory might be held long-term. This
360** routine is intended to get memory to old large transient data
361** structures that would not normally fit on the stack of an
362** embedded processor.
363*/
drhfacf0302008-06-17 15:12:00 +0000364void *sqlite3ScratchMalloc(int n){
drhe5ae5732008-06-15 02:51:47 +0000365 void *p;
366 assert( n>0 );
drh9ac3fe92008-06-18 18:12:04 +0000367
drhbadc9802010-08-27 17:16:44 +0000368 sqlite3_mutex_enter(mem0.mutex);
drh3ccd5bf2014-08-23 19:04:55 +0000369 sqlite3StatusSet(SQLITE_STATUS_SCRATCH_SIZE, n);
drhbadc9802010-08-27 17:16:44 +0000370 if( mem0.nScratchFree && sqlite3GlobalConfig.szScratch>=n ){
371 p = mem0.pScratchFree;
372 mem0.pScratchFree = mem0.pScratchFree->pNext;
373 mem0.nScratchFree--;
drhaf89fe62015-03-23 17:25:18 +0000374 sqlite3StatusUp(SQLITE_STATUS_SCRATCH_USED, 1);
danb0c6a882010-09-02 10:08:41 +0000375 sqlite3_mutex_leave(mem0.mutex);
drhbadc9802010-08-27 17:16:44 +0000376 }else{
drh3ccd5bf2014-08-23 19:04:55 +0000377 sqlite3_mutex_leave(mem0.mutex);
378 p = sqlite3Malloc(n);
379 if( sqlite3GlobalConfig.bMemstat && p ){
380 sqlite3_mutex_enter(mem0.mutex);
drhaf89fe62015-03-23 17:25:18 +0000381 sqlite3StatusUp(SQLITE_STATUS_SCRATCH_OVERFLOW, sqlite3MallocSize(p));
danb0c6a882010-09-02 10:08:41 +0000382 sqlite3_mutex_leave(mem0.mutex);
drhbadc9802010-08-27 17:16:44 +0000383 }
384 sqlite3MemdebugSetType(p, MEMTYPE_SCRATCH);
385 }
drh1ff6e3a2010-09-02 17:15:19 +0000386 assert( sqlite3_mutex_notheld(mem0.mutex) );
danb0c6a882010-09-02 10:08:41 +0000387
drhbadc9802010-08-27 17:16:44 +0000388
drhe5ae5732008-06-15 02:51:47 +0000389#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
drhcbd55b02014-11-04 14:22:27 +0000390 /* EVIDENCE-OF: R-12970-05880 SQLite will not use more than one scratch
391 ** buffers per thread.
392 **
393 ** This can only be checked in single-threaded mode.
394 */
395 assert( scratchAllocOut==0 );
drhbadc9802010-08-27 17:16:44 +0000396 if( p ) scratchAllocOut++;
drhf7141992008-06-19 00:16:08 +0000397#endif
398
drhe5ae5732008-06-15 02:51:47 +0000399 return p;
400}
drhfacf0302008-06-17 15:12:00 +0000401void sqlite3ScratchFree(void *p){
drhe5ae5732008-06-15 02:51:47 +0000402 if( p ){
drhbadc9802010-08-27 17:16:44 +0000403
404#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
405 /* Verify that no more than two scratch allocation per thread
406 ** is outstanding at one time. (This is only checked in the
407 ** single-threaded case since checking in the multi-threaded case
408 ** would be much more complicated.) */
409 assert( scratchAllocOut>=1 && scratchAllocOut<=2 );
410 scratchAllocOut--;
411#endif
412
413 if( p>=sqlite3GlobalConfig.pScratch && p<mem0.pScratchEnd ){
414 /* Release memory from the SQLITE_CONFIG_SCRATCH allocation */
415 ScratchFreeslot *pSlot;
416 pSlot = (ScratchFreeslot*)p;
417 sqlite3_mutex_enter(mem0.mutex);
418 pSlot->pNext = mem0.pScratchFree;
419 mem0.pScratchFree = pSlot;
420 mem0.nScratchFree++;
drhfcd71b62011-04-05 22:08:24 +0000421 assert( mem0.nScratchFree <= (u32)sqlite3GlobalConfig.nScratch );
drhaf89fe62015-03-23 17:25:18 +0000422 sqlite3StatusDown(SQLITE_STATUS_SCRATCH_USED, 1);
drhbadc9802010-08-27 17:16:44 +0000423 sqlite3_mutex_leave(mem0.mutex);
424 }else{
425 /* Release memory back to the heap */
drh107b56e2010-03-12 16:32:53 +0000426 assert( sqlite3MemdebugHasType(p, MEMTYPE_SCRATCH) );
mistachkind4258642015-03-21 23:38:59 +0000427 assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_SCRATCH) );
drh107b56e2010-03-12 16:32:53 +0000428 sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
danielk1977075c23a2008-09-01 18:34:20 +0000429 if( sqlite3GlobalConfig.bMemstat ){
drhf7141992008-06-19 00:16:08 +0000430 int iSize = sqlite3MallocSize(p);
431 sqlite3_mutex_enter(mem0.mutex);
drhaf89fe62015-03-23 17:25:18 +0000432 sqlite3StatusDown(SQLITE_STATUS_SCRATCH_OVERFLOW, iSize);
433 sqlite3StatusDown(SQLITE_STATUS_MEMORY_USED, iSize);
434 sqlite3StatusDown(SQLITE_STATUS_MALLOC_COUNT, 1);
danielk1977075c23a2008-09-01 18:34:20 +0000435 sqlite3GlobalConfig.m.xFree(p);
drhf7141992008-06-19 00:16:08 +0000436 sqlite3_mutex_leave(mem0.mutex);
437 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000438 sqlite3GlobalConfig.m.xFree(p);
drhf7141992008-06-19 00:16:08 +0000439 }
drh9ac3fe92008-06-18 18:12:04 +0000440 }
drhe5ae5732008-06-15 02:51:47 +0000441 }
442}
443
444/*
drh633e6d52008-07-28 19:34:53 +0000445** TRUE if p is a lookaside memory allocation from db
446*/
drh4150ebf2008-10-11 15:38:29 +0000447#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000448static int isLookaside(sqlite3 *db, void *p){
drhb0e77042013-12-10 19:49:00 +0000449 return p>=db->lookaside.pStart && p<db->lookaside.pEnd;
drh633e6d52008-07-28 19:34:53 +0000450}
drh4150ebf2008-10-11 15:38:29 +0000451#else
452#define isLookaside(A,B) 0
453#endif
drh633e6d52008-07-28 19:34:53 +0000454
455/*
drhfec00ea2008-06-14 16:56:21 +0000456** Return the size of a memory allocation previously obtained from
457** sqlite3Malloc() or sqlite3_malloc().
458*/
459int sqlite3MallocSize(void *p){
drh107b56e2010-03-12 16:32:53 +0000460 assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
danielk1977075c23a2008-09-01 18:34:20 +0000461 return sqlite3GlobalConfig.m.xSize(p);
drhfec00ea2008-06-14 16:56:21 +0000462}
drh633e6d52008-07-28 19:34:53 +0000463int sqlite3DbMallocSize(sqlite3 *db, void *p){
drh17bcb102014-09-18 21:25:33 +0000464 if( db==0 ){
mistachkind4258642015-03-21 23:38:59 +0000465 assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
drhd231aa32014-10-07 15:46:54 +0000466 assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
drh17bcb102014-09-18 21:25:33 +0000467 return sqlite3MallocSize(p);
drh633e6d52008-07-28 19:34:53 +0000468 }else{
drh17bcb102014-09-18 21:25:33 +0000469 assert( sqlite3_mutex_held(db->mutex) );
470 if( isLookaside(db, p) ){
471 return db->lookaside.sz;
472 }else{
drhd231aa32014-10-07 15:46:54 +0000473 assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
mistachkind4258642015-03-21 23:38:59 +0000474 assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
drh17bcb102014-09-18 21:25:33 +0000475 return sqlite3GlobalConfig.m.xSize(p);
476 }
drh633e6d52008-07-28 19:34:53 +0000477 }
478}
drhda4ca9d2014-09-09 17:27:35 +0000479sqlite3_uint64 sqlite3_msize(void *p){
mistachkind4258642015-03-21 23:38:59 +0000480 assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
drhd231aa32014-10-07 15:46:54 +0000481 assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
drhda4ca9d2014-09-09 17:27:35 +0000482 return (sqlite3_uint64)sqlite3GlobalConfig.m.xSize(p);
483}
drhfec00ea2008-06-14 16:56:21 +0000484
485/*
486** Free memory previously obtained from sqlite3Malloc().
487*/
488void sqlite3_free(void *p){
drh71a1a0f2010-09-11 16:15:55 +0000489 if( p==0 ) return; /* IMP: R-49053-54554 */
drh107b56e2010-03-12 16:32:53 +0000490 assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
mistachkind4258642015-03-21 23:38:59 +0000491 assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
danielk1977075c23a2008-09-01 18:34:20 +0000492 if( sqlite3GlobalConfig.bMemstat ){
drhfec00ea2008-06-14 16:56:21 +0000493 sqlite3_mutex_enter(mem0.mutex);
drhaf89fe62015-03-23 17:25:18 +0000494 sqlite3StatusDown(SQLITE_STATUS_MEMORY_USED, sqlite3MallocSize(p));
495 sqlite3StatusDown(SQLITE_STATUS_MALLOC_COUNT, 1);
danielk1977075c23a2008-09-01 18:34:20 +0000496 sqlite3GlobalConfig.m.xFree(p);
drhfec00ea2008-06-14 16:56:21 +0000497 sqlite3_mutex_leave(mem0.mutex);
498 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000499 sqlite3GlobalConfig.m.xFree(p);
drhfec00ea2008-06-14 16:56:21 +0000500 }
501}
502
503/*
drhb4586f12014-08-23 19:42:06 +0000504** Add the size of memory allocation "p" to the count in
505** *db->pnBytesFreed.
506*/
507static SQLITE_NOINLINE void measureAllocationSize(sqlite3 *db, void *p){
508 *db->pnBytesFreed += sqlite3DbMallocSize(db,p);
509}
510
511/*
drh633e6d52008-07-28 19:34:53 +0000512** Free memory that might be associated with a particular database
513** connection.
514*/
515void sqlite3DbFree(sqlite3 *db, void *p){
drh7047e252009-03-23 17:49:14 +0000516 assert( db==0 || sqlite3_mutex_held(db->mutex) );
drh9ccd8652013-09-13 16:36:46 +0000517 if( p==0 ) return;
drh174b9a12010-07-26 11:07:20 +0000518 if( db ){
519 if( db->pnBytesFreed ){
drhb4586f12014-08-23 19:42:06 +0000520 measureAllocationSize(db, p);
drh174b9a12010-07-26 11:07:20 +0000521 return;
dand46def72010-07-24 11:28:28 +0000522 }
drh174b9a12010-07-26 11:07:20 +0000523 if( isLookaside(db, p) ){
524 LookasideSlot *pBuf = (LookasideSlot*)p;
drh3608f172012-05-21 16:59:16 +0000525#if SQLITE_DEBUG
526 /* Trash all content in the buffer being freed */
527 memset(p, 0xaa, db->lookaside.sz);
528#endif
drh174b9a12010-07-26 11:07:20 +0000529 pBuf->pNext = db->lookaside.pFree;
530 db->lookaside.pFree = pBuf;
531 db->lookaside.nOut--;
532 return;
533 }
drh633e6d52008-07-28 19:34:53 +0000534 }
drhd231aa32014-10-07 15:46:54 +0000535 assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
mistachkind4258642015-03-21 23:38:59 +0000536 assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
drh174b9a12010-07-26 11:07:20 +0000537 assert( db!=0 || sqlite3MemdebugNoType(p, MEMTYPE_LOOKASIDE) );
538 sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
539 sqlite3_free(p);
drh633e6d52008-07-28 19:34:53 +0000540}
541
542/*
drhfec00ea2008-06-14 16:56:21 +0000543** Change the size of an existing memory allocation
544*/
drhda4ca9d2014-09-09 17:27:35 +0000545void *sqlite3Realloc(void *pOld, u64 nBytes){
shanehca591fe2011-04-15 19:30:42 +0000546 int nOld, nNew, nDiff;
drhfec00ea2008-06-14 16:56:21 +0000547 void *pNew;
drhd231aa32014-10-07 15:46:54 +0000548 assert( sqlite3MemdebugHasType(pOld, MEMTYPE_HEAP) );
mistachkind4258642015-03-21 23:38:59 +0000549 assert( sqlite3MemdebugNoType(pOld, (u8)~MEMTYPE_HEAP) );
drhfec00ea2008-06-14 16:56:21 +0000550 if( pOld==0 ){
drh8da47412014-10-03 14:54:47 +0000551 return sqlite3Malloc(nBytes); /* IMP: R-04300-56712 */
drhfec00ea2008-06-14 16:56:21 +0000552 }
drhda4ca9d2014-09-09 17:27:35 +0000553 if( nBytes==0 ){
drh8da47412014-10-03 14:54:47 +0000554 sqlite3_free(pOld); /* IMP: R-26507-47431 */
drhfec00ea2008-06-14 16:56:21 +0000555 return 0;
556 }
drhb6063cf2009-06-27 00:48:33 +0000557 if( nBytes>=0x7fffff00 ){
558 /* The 0x7ffff00 limit term is explained in comments on sqlite3Malloc() */
559 return 0;
560 }
drhfec00ea2008-06-14 16:56:21 +0000561 nOld = sqlite3MallocSize(pOld);
drh9f129f42010-08-31 15:27:32 +0000562 /* IMPLEMENTATION-OF: R-46199-30249 SQLite guarantees that the second
563 ** argument to xRealloc is always a value returned by a prior call to
564 ** xRoundup. */
drhda4ca9d2014-09-09 17:27:35 +0000565 nNew = sqlite3GlobalConfig.m.xRoundup((int)nBytes);
drh7c6791c2009-08-18 14:48:53 +0000566 if( nOld==nNew ){
567 pNew = pOld;
568 }else if( sqlite3GlobalConfig.bMemstat ){
drhfec00ea2008-06-14 16:56:21 +0000569 sqlite3_mutex_enter(mem0.mutex);
drh3329a632014-09-18 01:21:43 +0000570 sqlite3StatusSet(SQLITE_STATUS_MALLOC_SIZE, (int)nBytes);
drh8e1bb042011-04-15 16:39:52 +0000571 nDiff = nNew - nOld;
572 if( sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED) >=
573 mem0.alarmThreshold-nDiff ){
drh2e5a4222011-05-05 17:00:51 +0000574 sqlite3MallocAlarm(nDiff);
drh7c6791c2009-08-18 14:48:53 +0000575 }
576 pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
577 if( pNew==0 && mem0.alarmCallback ){
drh3329a632014-09-18 01:21:43 +0000578 sqlite3MallocAlarm((int)nBytes);
danielk1977075c23a2008-09-01 18:34:20 +0000579 pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
drh7c6791c2009-08-18 14:48:53 +0000580 }
581 if( pNew ){
582 nNew = sqlite3MallocSize(pNew);
drhaf89fe62015-03-23 17:25:18 +0000583 sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nNew-nOld);
drhfec00ea2008-06-14 16:56:21 +0000584 }
585 sqlite3_mutex_leave(mem0.mutex);
586 }else{
drh7c6791c2009-08-18 14:48:53 +0000587 pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
drhfec00ea2008-06-14 16:56:21 +0000588 }
drh8da47412014-10-03 14:54:47 +0000589 assert( EIGHT_BYTE_ALIGNMENT(pNew) ); /* IMP: R-11148-40995 */
drhfec00ea2008-06-14 16:56:21 +0000590 return pNew;
591}
592
593/*
594** The public interface to sqlite3Realloc. Make sure that the memory
595** subsystem is initialized prior to invoking sqliteRealloc.
596*/
597void *sqlite3_realloc(void *pOld, int n){
598#ifndef SQLITE_OMIT_AUTOINIT
599 if( sqlite3_initialize() ) return 0;
600#endif
drh8da47412014-10-03 14:54:47 +0000601 if( n<0 ) n = 0; /* IMP: R-26507-47431 */
drhda4ca9d2014-09-09 17:27:35 +0000602 return sqlite3Realloc(pOld, n);
603}
604void *sqlite3_realloc64(void *pOld, sqlite3_uint64 n){
605#ifndef SQLITE_OMIT_AUTOINIT
606 if( sqlite3_initialize() ) return 0;
607#endif
drhfec00ea2008-06-14 16:56:21 +0000608 return sqlite3Realloc(pOld, n);
609}
610
drha3152892007-05-05 11:48:52 +0000611
612/*
drh17435752007-08-16 04:30:38 +0000613** Allocate and zero memory.
drha3152892007-05-05 11:48:52 +0000614*/
drhda4ca9d2014-09-09 17:27:35 +0000615void *sqlite3MallocZero(u64 n){
drhfec00ea2008-06-14 16:56:21 +0000616 void *p = sqlite3Malloc(n);
drha3152892007-05-05 11:48:52 +0000617 if( p ){
drh20f3df02014-09-18 02:20:54 +0000618 memset(p, 0, (size_t)n);
drha3152892007-05-05 11:48:52 +0000619 }
620 return p;
621}
drh17435752007-08-16 04:30:38 +0000622
623/*
624** Allocate and zero memory. If the allocation fails, make
625** the mallocFailed flag in the connection pointer.
626*/
drhda4ca9d2014-09-09 17:27:35 +0000627void *sqlite3DbMallocZero(sqlite3 *db, u64 n){
danielk1977a1644fd2007-08-29 12:31:25 +0000628 void *p = sqlite3DbMallocRaw(db, n);
drh17435752007-08-16 04:30:38 +0000629 if( p ){
drh20f3df02014-09-18 02:20:54 +0000630 memset(p, 0, (size_t)n);
drh17435752007-08-16 04:30:38 +0000631 }
632 return p;
633}
634
635/*
636** Allocate and zero memory. If the allocation fails, make
637** the mallocFailed flag in the connection pointer.
drhddecae72008-10-11 17:35:16 +0000638**
639** If db!=0 and db->mallocFailed is true (indicating a prior malloc
640** failure on the same database connection) then always return 0.
641** Hence for a particular database connection, once malloc starts
642** failing, it fails consistently until mallocFailed is reset.
643** This is an important assumption. There are many places in the
644** code that do things like this:
645**
646** int *a = (int*)sqlite3DbMallocRaw(db, 100);
647** int *b = (int*)sqlite3DbMallocRaw(db, 200);
648** if( b ) a[10] = 9;
649**
650** In other words, if a subsequent malloc (ex: "b") worked, it is assumed
651** that all prior mallocs (ex: "a") worked too.
drh17435752007-08-16 04:30:38 +0000652*/
drhda4ca9d2014-09-09 17:27:35 +0000653void *sqlite3DbMallocRaw(sqlite3 *db, u64 n){
drh633e6d52008-07-28 19:34:53 +0000654 void *p;
drhd9da78a2009-03-24 15:08:09 +0000655 assert( db==0 || sqlite3_mutex_held(db->mutex) );
danccd4ad32010-07-26 14:47:14 +0000656 assert( db==0 || db->pnBytesFreed==0 );
drh4150ebf2008-10-11 15:38:29 +0000657#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000658 if( db ){
659 LookasideSlot *pBuf;
660 if( db->mallocFailed ){
661 return 0;
danielk1977a1644fd2007-08-29 12:31:25 +0000662 }
drh0b12e7f2010-12-20 15:51:58 +0000663 if( db->lookaside.bEnabled ){
664 if( n>db->lookaside.sz ){
665 db->lookaside.anStat[1]++;
666 }else if( (pBuf = db->lookaside.pFree)==0 ){
667 db->lookaside.anStat[2]++;
668 }else{
669 db->lookaside.pFree = pBuf->pNext;
670 db->lookaside.nOut++;
671 db->lookaside.anStat[0]++;
672 if( db->lookaside.nOut>db->lookaside.mxOut ){
673 db->lookaside.mxOut = db->lookaside.nOut;
674 }
675 return (void*)pBuf;
drh633e6d52008-07-28 19:34:53 +0000676 }
drh633e6d52008-07-28 19:34:53 +0000677 }
678 }
drhddecae72008-10-11 17:35:16 +0000679#else
680 if( db && db->mallocFailed ){
681 return 0;
682 }
drh4150ebf2008-10-11 15:38:29 +0000683#endif
drh633e6d52008-07-28 19:34:53 +0000684 p = sqlite3Malloc(n);
685 if( !p && db ){
686 db->mallocFailed = 1;
drh17435752007-08-16 04:30:38 +0000687 }
drhd231aa32014-10-07 15:46:54 +0000688 sqlite3MemdebugSetType(p,
689 (db && db->lookaside.bEnabled) ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP);
drh17435752007-08-16 04:30:38 +0000690 return p;
691}
692
danielk197726783a52007-08-29 14:06:22 +0000693/*
694** Resize the block of memory pointed to by p to n bytes. If the
drh633e6d52008-07-28 19:34:53 +0000695** resize fails, set the mallocFailed flag in the connection object.
danielk197726783a52007-08-29 14:06:22 +0000696*/
drhda4ca9d2014-09-09 17:27:35 +0000697void *sqlite3DbRealloc(sqlite3 *db, void *p, u64 n){
danielk1977a1644fd2007-08-29 12:31:25 +0000698 void *pNew = 0;
drhd9da78a2009-03-24 15:08:09 +0000699 assert( db!=0 );
drh7047e252009-03-23 17:49:14 +0000700 assert( sqlite3_mutex_held(db->mutex) );
danielk1977a1644fd2007-08-29 12:31:25 +0000701 if( db->mallocFailed==0 ){
drh633e6d52008-07-28 19:34:53 +0000702 if( p==0 ){
703 return sqlite3DbMallocRaw(db, n);
704 }
705 if( isLookaside(db, p) ){
706 if( n<=db->lookaside.sz ){
707 return p;
708 }
709 pNew = sqlite3DbMallocRaw(db, n);
710 if( pNew ){
711 memcpy(pNew, p, db->lookaside.sz);
712 sqlite3DbFree(db, p);
713 }
714 }else{
drhd231aa32014-10-07 15:46:54 +0000715 assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
mistachkind4258642015-03-21 23:38:59 +0000716 assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
drh107b56e2010-03-12 16:32:53 +0000717 sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
drh3329a632014-09-18 01:21:43 +0000718 pNew = sqlite3_realloc64(p, n);
drh633e6d52008-07-28 19:34:53 +0000719 if( !pNew ){
720 db->mallocFailed = 1;
721 }
drhd231aa32014-10-07 15:46:54 +0000722 sqlite3MemdebugSetType(pNew,
drh174b9a12010-07-26 11:07:20 +0000723 (db->lookaside.bEnabled ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP));
danielk1977a1644fd2007-08-29 12:31:25 +0000724 }
725 }
726 return pNew;
727}
728
drh17435752007-08-16 04:30:38 +0000729/*
730** Attempt to reallocate p. If the reallocation fails, then free p
731** and set the mallocFailed flag in the database connection.
732*/
drhda4ca9d2014-09-09 17:27:35 +0000733void *sqlite3DbReallocOrFree(sqlite3 *db, void *p, u64 n){
drha3152892007-05-05 11:48:52 +0000734 void *pNew;
danielk1977a1644fd2007-08-29 12:31:25 +0000735 pNew = sqlite3DbRealloc(db, p, n);
drha3152892007-05-05 11:48:52 +0000736 if( !pNew ){
drh633e6d52008-07-28 19:34:53 +0000737 sqlite3DbFree(db, p);
drha3152892007-05-05 11:48:52 +0000738 }
739 return pNew;
740}
741
drha3152892007-05-05 11:48:52 +0000742/*
743** Make a copy of a string in memory obtained from sqliteMalloc(). These
744** functions call sqlite3MallocRaw() directly instead of sqliteMalloc(). This
745** is because when memory debugging is turned on, these two functions are
746** called via macros that record the current file and line number in the
747** ThreadData structure.
748*/
drh633e6d52008-07-28 19:34:53 +0000749char *sqlite3DbStrDup(sqlite3 *db, const char *z){
drha3152892007-05-05 11:48:52 +0000750 char *zNew;
drh633e6d52008-07-28 19:34:53 +0000751 size_t n;
752 if( z==0 ){
753 return 0;
754 }
drhdee0e402009-05-03 20:23:53 +0000755 n = sqlite3Strlen30(z) + 1;
drh633e6d52008-07-28 19:34:53 +0000756 assert( (n&0x7fffffff)==n );
757 zNew = sqlite3DbMallocRaw(db, (int)n);
drha3152892007-05-05 11:48:52 +0000758 if( zNew ){
759 memcpy(zNew, z, n);
danielk19771e536952007-08-16 10:09:01 +0000760 }
761 return zNew;
762}
drhda4ca9d2014-09-09 17:27:35 +0000763char *sqlite3DbStrNDup(sqlite3 *db, const char *z, u64 n){
drh633e6d52008-07-28 19:34:53 +0000764 char *zNew;
765 if( z==0 ){
766 return 0;
767 }
768 assert( (n&0x7fffffff)==n );
769 zNew = sqlite3DbMallocRaw(db, n+1);
770 if( zNew ){
drh20f3df02014-09-18 02:20:54 +0000771 memcpy(zNew, z, (size_t)n);
drh633e6d52008-07-28 19:34:53 +0000772 zNew[n] = 0;
danielk19771e536952007-08-16 10:09:01 +0000773 }
774 return zNew;
775}
776
drha3152892007-05-05 11:48:52 +0000777/*
drhf089aa42008-07-08 19:34:06 +0000778** Create a string from the zFromat argument and the va_list that follows.
779** Store the string in memory obtained from sqliteMalloc() and make *pz
780** point to that string.
drha3152892007-05-05 11:48:52 +0000781*/
drhf089aa42008-07-08 19:34:06 +0000782void sqlite3SetString(char **pz, sqlite3 *db, const char *zFormat, ...){
drha3152892007-05-05 11:48:52 +0000783 va_list ap;
drhf089aa42008-07-08 19:34:06 +0000784 char *z;
drha3152892007-05-05 11:48:52 +0000785
drhf089aa42008-07-08 19:34:06 +0000786 va_start(ap, zFormat);
787 z = sqlite3VMPrintf(db, zFormat, ap);
drha3152892007-05-05 11:48:52 +0000788 va_end(ap);
drh633e6d52008-07-28 19:34:53 +0000789 sqlite3DbFree(db, *pz);
drhf089aa42008-07-08 19:34:06 +0000790 *pz = z;
drha3152892007-05-05 11:48:52 +0000791}
792
drhb50c65d2014-08-23 20:25:53 +0000793/*
794** Take actions at the end of an API call to indicate an OOM error
795*/
796static SQLITE_NOINLINE int apiOomError(sqlite3 *db){
797 db->mallocFailed = 0;
798 sqlite3Error(db, SQLITE_NOMEM);
799 return SQLITE_NOMEM;
800}
drha3152892007-05-05 11:48:52 +0000801
802/*
803** This function must be called before exiting any API function (i.e.
drh17435752007-08-16 04:30:38 +0000804** returning control to the user) that has called sqlite3_malloc or
805** sqlite3_realloc.
drha3152892007-05-05 11:48:52 +0000806**
807** The returned value is normally a copy of the second argument to this
shanebe217792009-03-05 04:20:31 +0000808** function. However, if a malloc() failure has occurred since the previous
drha3152892007-05-05 11:48:52 +0000809** invocation SQLITE_NOMEM is returned instead.
810**
shanebe217792009-03-05 04:20:31 +0000811** If the first argument, db, is not NULL and a malloc() error has occurred,
drha3152892007-05-05 11:48:52 +0000812** then the connection error-code (the value returned by sqlite3_errcode())
813** is set to SQLITE_NOMEM.
814*/
drha3152892007-05-05 11:48:52 +0000815int sqlite3ApiExit(sqlite3* db, int rc){
danielk1977a1644fd2007-08-29 12:31:25 +0000816 /* If the db handle is not NULL, then we must hold the connection handle
817 ** mutex here. Otherwise the read (and possible write) of db->mallocFailed
818 ** is unsafe, as is the call to sqlite3Error().
819 */
820 assert( !db || sqlite3_mutex_held(db->mutex) );
drhb50c65d2014-08-23 20:25:53 +0000821 if( db==0 ) return rc & 0xff;
822 if( db->mallocFailed || rc==SQLITE_IOERR_NOMEM ){
823 return apiOomError(db);
drha3152892007-05-05 11:48:52 +0000824 }
drhb50c65d2014-08-23 20:25:53 +0000825 return rc & db->errMask;
drha3152892007-05-05 11:48:52 +0000826}