xref: /sqlite-3.40.0/src/malloc.c (revision be7a0cee)
1a3152895Sdrh /*
2a3152895Sdrh ** 2001 September 15
3a3152895Sdrh **
4a3152895Sdrh ** The author disclaims copyright to this source code.  In place of
5a3152895Sdrh ** a legal notice, here is a blessing:
6a3152895Sdrh **
7a3152895Sdrh **    May you do good and not evil.
8a3152895Sdrh **    May you find forgiveness for yourself and forgive others.
9a3152895Sdrh **    May you share freely, never taking more than you give.
10a3152895Sdrh **
11a3152895Sdrh *************************************************************************
12fec00eabSdrh **
13a3152895Sdrh ** Memory allocation functions used throughout sqlite.
14a3152895Sdrh */
15a3152895Sdrh #include "sqliteInt.h"
16a3152895Sdrh #include <stdarg.h>
17a3152895Sdrh 
18a3152895Sdrh /*
198468024dSdanielk1977 ** Attempt to release up to n bytes of non-essential memory currently
208468024dSdanielk1977 ** held by SQLite. An example of non-essential memory is memory used to
218468024dSdanielk1977 ** cache database pages that are not currently in use.
22a3152895Sdrh */
23a3152895Sdrh int sqlite3_release_memory(int n){
2486f8c197Sdrh #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
259f129f46Sdrh   return sqlite3PcacheReleaseMemory(n);
261e536953Sdanielk1977 #else
279f129f46Sdrh   /* IMPLEMENTATION-OF: R-34391-24921 The sqlite3_release_memory() routine
289f129f46Sdrh   ** is a no-op returning zero if SQLite is not compiled with
299f129f46Sdrh   ** SQLITE_ENABLE_MEMORY_MANAGEMENT. */
3062c14b34Sdanielk1977   UNUSED_PARAMETER(n);
319f129f46Sdrh   return 0;
321e536953Sdanielk1977 #endif
33a3152895Sdrh }
34a3152895Sdrh 
35fec00eabSdrh /*
36badc980aSdrh ** An instance of the following object records the location of
37badc980aSdrh ** each unused scratch buffer.
38badc980aSdrh */
39badc980aSdrh typedef struct ScratchFreeslot {
40badc980aSdrh   struct ScratchFreeslot *pNext;   /* Next unused scratch buffer */
41badc980aSdrh } ScratchFreeslot;
42badc980aSdrh 
43badc980aSdrh /*
44fec00eabSdrh ** State information local to the memory allocation subsystem.
45fec00eabSdrh */
465c8f8587Sdanielk1977 static SQLITE_WSD struct Mem0Global {
47fec00eabSdrh   sqlite3_mutex *mutex;         /* Mutex to serialize access */
484ef299a3Sdrh   sqlite3_int64 alarmThreshold; /* The soft heap limit */
49fec00eabSdrh 
50fec00eabSdrh   /*
51badc980aSdrh   ** Pointers to the end of sqlite3GlobalConfig.pScratch memory
52badc980aSdrh   ** (so that a range test can be used to determine if an allocation
53badc980aSdrh   ** being freed came from pScratch) and a pointer to the list of
54badc980aSdrh   ** unused scratch allocations.
559ac3fe97Sdrh   */
56badc980aSdrh   void *pScratchEnd;
57badc980aSdrh   ScratchFreeslot *pScratchFree;
58badc980aSdrh   u32 nScratchFree;
5950d1b5f3Sdrh 
6050d1b5f3Sdrh   /*
6150d1b5f3Sdrh   ** True if heap is nearly "full" where "full" is defined by the
6250d1b5f3Sdrh   ** sqlite3_soft_heap_limit() setting.
6350d1b5f3Sdrh   */
6450d1b5f3Sdrh   int nearlyFull;
654ef299a3Sdrh } mem0 = { 0, 0, 0, 0, 0, 0 };
665c8f8587Sdanielk1977 
675c8f8587Sdanielk1977 #define mem0 GLOBAL(struct Mem0Global, mem0)
68fec00eabSdrh 
69fec00eabSdrh /*
70af89fe66Sdrh ** Return the memory allocator mutex. sqlite3_status() needs it.
71af89fe66Sdrh */
72af89fe66Sdrh sqlite3_mutex *sqlite3MallocMutex(void){
73af89fe66Sdrh   return mem0.mutex;
74af89fe66Sdrh }
75af89fe66Sdrh 
76f82ccf64Sdrh #ifndef SQLITE_OMIT_DEPRECATED
77f82ccf64Sdrh /*
785fb72e5fSdrh ** Deprecated external interface.  It used to set an alarm callback
795fb72e5fSdrh ** that was invoked when memory usage grew too large.  Now it is a
805fb72e5fSdrh ** no-op.
81f82ccf64Sdrh */
82f82ccf64Sdrh int sqlite3_memory_alarm(
83f82ccf64Sdrh   void(*xCallback)(void *pArg, sqlite3_int64 used,int N),
84f82ccf64Sdrh   void *pArg,
85f82ccf64Sdrh   sqlite3_int64 iThreshold
86f82ccf64Sdrh ){
875fb72e5fSdrh   (void)xCallback;
885fb72e5fSdrh   (void)pArg;
895fb72e5fSdrh   (void)iThreshold;
904ef299a3Sdrh   return SQLITE_OK;
91f82ccf64Sdrh }
92f82ccf64Sdrh #endif
93f82ccf64Sdrh 
94f82ccf64Sdrh /*
95f82ccf64Sdrh ** Set the soft heap-size limit for the library. Passing a zero or
96f82ccf64Sdrh ** negative value indicates no limit.
97f82ccf64Sdrh */
98f82ccf64Sdrh sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 n){
99f82ccf64Sdrh   sqlite3_int64 priorLimit;
1005fb72e5fSdrh   sqlite3_int64 excess;
1015fb72e5fSdrh   sqlite3_int64 nUsed;
102f82ccf64Sdrh #ifndef SQLITE_OMIT_AUTOINIT
103de0f1815Sdrh   int rc = sqlite3_initialize();
104de0f1815Sdrh   if( rc ) return -1;
105f82ccf64Sdrh #endif
106f82ccf64Sdrh   sqlite3_mutex_enter(mem0.mutex);
107f82ccf64Sdrh   priorLimit = mem0.alarmThreshold;
1085fb72e5fSdrh   if( n<0 ){
1094ef299a3Sdrh     sqlite3_mutex_leave(mem0.mutex);
110f82ccf64Sdrh     return priorLimit;
111f82ccf64Sdrh   }
1125fb72e5fSdrh   mem0.alarmThreshold = n;
1135fb72e5fSdrh   nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
1145fb72e5fSdrh   mem0.nearlyFull = (n>0 && n<=nUsed);
1155fb72e5fSdrh   sqlite3_mutex_leave(mem0.mutex);
1165fb72e5fSdrh   excess = sqlite3_memory_used() - n;
1175fb72e5fSdrh   if( excess>0 ) sqlite3_release_memory((int)(excess & 0x7fffffff));
1185fb72e5fSdrh   return priorLimit;
1195fb72e5fSdrh }
120f82ccf64Sdrh void sqlite3_soft_heap_limit(int n){
121f82ccf64Sdrh   if( n<0 ) n = 0;
122f82ccf64Sdrh   sqlite3_soft_heap_limit64(n);
123f82ccf64Sdrh }
124f82ccf64Sdrh 
125f82ccf64Sdrh /*
126fec00eabSdrh ** Initialize the memory allocation subsystem.
127fec00eabSdrh */
128fec00eabSdrh int sqlite3MallocInit(void){
129592f0cb1Sdrh   int rc;
130075c23afSdanielk1977   if( sqlite3GlobalConfig.m.xMalloc==0 ){
131fec00eabSdrh     sqlite3MemSetDefault();
132fec00eabSdrh   }
133fec00eabSdrh   memset(&mem0, 0, sizeof(mem0));
13459f8c08eSdanielk1977   mem0.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
135075c23afSdanielk1977   if( sqlite3GlobalConfig.pScratch && sqlite3GlobalConfig.szScratch>=100
1367ff2719eSdrh       && sqlite3GlobalConfig.nScratch>0 ){
137badc980aSdrh     int i, n, sz;
138badc980aSdrh     ScratchFreeslot *pSlot;
139badc980aSdrh     sz = ROUNDDOWN8(sqlite3GlobalConfig.szScratch);
140badc980aSdrh     sqlite3GlobalConfig.szScratch = sz;
141badc980aSdrh     pSlot = (ScratchFreeslot*)sqlite3GlobalConfig.pScratch;
142badc980aSdrh     n = sqlite3GlobalConfig.nScratch;
143badc980aSdrh     mem0.pScratchFree = pSlot;
144badc980aSdrh     mem0.nScratchFree = n;
145badc980aSdrh     for(i=0; i<n-1; i++){
146badc980aSdrh       pSlot->pNext = (ScratchFreeslot*)(sz+(char*)pSlot);
147badc980aSdrh       pSlot = pSlot->pNext;
148badc980aSdrh     }
149badc980aSdrh     pSlot->pNext = 0;
150badc980aSdrh     mem0.pScratchEnd = (void*)&pSlot[1];
1519ac3fe97Sdrh   }else{
152badc980aSdrh     mem0.pScratchEnd = 0;
153075c23afSdanielk1977     sqlite3GlobalConfig.pScratch = 0;
154075c23afSdanielk1977     sqlite3GlobalConfig.szScratch = 0;
155badc980aSdrh     sqlite3GlobalConfig.nScratch = 0;
1569ac3fe97Sdrh   }
15750d1b5f3Sdrh   if( sqlite3GlobalConfig.pPage==0 || sqlite3GlobalConfig.szPage<512
15801c5c00cSdrh       || sqlite3GlobalConfig.nPage<=0 ){
159075c23afSdanielk1977     sqlite3GlobalConfig.pPage = 0;
160075c23afSdanielk1977     sqlite3GlobalConfig.szPage = 0;
1619ac3fe97Sdrh   }
162592f0cb1Sdrh   rc = sqlite3GlobalConfig.m.xInit(sqlite3GlobalConfig.m.pAppData);
163592f0cb1Sdrh   if( rc!=SQLITE_OK ) memset(&mem0, 0, sizeof(mem0));
164592f0cb1Sdrh   return rc;
165fec00eabSdrh }
166fec00eabSdrh 
167fec00eabSdrh /*
16850d1b5f3Sdrh ** Return true if the heap is currently under memory pressure - in other
16950d1b5f3Sdrh ** words if the amount of heap used is close to the limit set by
17050d1b5f3Sdrh ** sqlite3_soft_heap_limit().
17150d1b5f3Sdrh */
17250d1b5f3Sdrh int sqlite3HeapNearlyFull(void){
17350d1b5f3Sdrh   return mem0.nearlyFull;
17450d1b5f3Sdrh }
17550d1b5f3Sdrh 
17650d1b5f3Sdrh /*
177fec00eabSdrh ** Deinitialize the memory allocation subsystem.
178fec00eabSdrh */
179fec00eabSdrh void sqlite3MallocEnd(void){
1800a549071Sdanielk1977   if( sqlite3GlobalConfig.m.xShutdown ){
181075c23afSdanielk1977     sqlite3GlobalConfig.m.xShutdown(sqlite3GlobalConfig.m.pAppData);
1820a549071Sdanielk1977   }
1839ac3fe97Sdrh   memset(&mem0, 0, sizeof(mem0));
184fec00eabSdrh }
185fec00eabSdrh 
186fec00eabSdrh /*
187fec00eabSdrh ** Return the amount of memory currently checked out.
188fec00eabSdrh */
189fec00eabSdrh sqlite3_int64 sqlite3_memory_used(void){
190df5e1a00Sdrh   sqlite3_int64 res, mx;
191df5e1a00Sdrh   sqlite3_status64(SQLITE_STATUS_MEMORY_USED, &res, &mx, 0);
192c376a198Sdrh   return res;
193fec00eabSdrh }
194fec00eabSdrh 
195fec00eabSdrh /*
196fec00eabSdrh ** Return the maximum amount of memory that has ever been
197fec00eabSdrh ** checked out since either the beginning of this process
198fec00eabSdrh ** or since the most recent reset.
199fec00eabSdrh */
200fec00eabSdrh sqlite3_int64 sqlite3_memory_highwater(int resetFlag){
201df5e1a00Sdrh   sqlite3_int64 res, mx;
202df5e1a00Sdrh   sqlite3_status64(SQLITE_STATUS_MEMORY_USED, &res, &mx, resetFlag);
203df5e1a00Sdrh   return mx;
204fec00eabSdrh }
205fec00eabSdrh 
206fec00eabSdrh /*
2075fb72e5fSdrh ** Trigger the alarm
2085fb72e5fSdrh */
2095fb72e5fSdrh static void sqlite3MallocAlarm(int nByte){
2105fb72e5fSdrh   if( mem0.alarmThreshold<=0 ) return;
2115fb72e5fSdrh   sqlite3_mutex_leave(mem0.mutex);
2125fb72e5fSdrh   sqlite3_release_memory(nByte);
2135fb72e5fSdrh   sqlite3_mutex_enter(mem0.mutex);
2145fb72e5fSdrh }
2155fb72e5fSdrh 
2165fb72e5fSdrh /*
217f7141990Sdrh ** Do a memory allocation with statistics and alarms.  Assume the
218f7141990Sdrh ** lock is already held.
219fec00eabSdrh */
2201d21bac8Sdrh static void mallocWithAlarm(int n, void **pp){
221f7141990Sdrh   void *p;
222*be7a0ceeSdrh   int nFull = 0;
223f7141990Sdrh   assert( sqlite3_mutex_held(mem0.mutex) );
224b02392e6Sdrh   sqlite3StatusHighwater(SQLITE_STATUS_MALLOC_SIZE, n);
2255fb72e5fSdrh   if( mem0.alarmThreshold>0 ){
2265fb72e5fSdrh     sqlite3_int64 nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
227*be7a0ceeSdrh     nFull = sqlite3GlobalConfig.m.xRoundup(n);
2285fb72e5fSdrh     if( nUsed >= mem0.alarmThreshold - nFull ){
2295fb72e5fSdrh       mem0.nearlyFull = 1;
2305fb72e5fSdrh       sqlite3MallocAlarm(nFull);
2315fb72e5fSdrh     }else{
2325fb72e5fSdrh       mem0.nearlyFull = 0;
2335fb72e5fSdrh     }
2345fb72e5fSdrh   }
2351d21bac8Sdrh   p = sqlite3GlobalConfig.m.xMalloc(n);
23650d1b5f3Sdrh #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
2375fb72e5fSdrh   if( p==0 && mem0.alarmThreshold>0 ){
2385fb72e5fSdrh     sqlite3MallocAlarm(nFull);
2391d21bac8Sdrh     p = sqlite3GlobalConfig.m.xMalloc(n);
240fec00eabSdrh   }
24150d1b5f3Sdrh #endif
242c702c7ccSdrh   if( p ){
243*be7a0ceeSdrh     nFull = sqlite3MallocSize(p);
244af89fe66Sdrh     sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nFull);
245af89fe66Sdrh     sqlite3StatusUp(SQLITE_STATUS_MALLOC_COUNT, 1);
246c702c7ccSdrh   }
247f7141990Sdrh   *pp = p;
248fec00eabSdrh }
249f7141990Sdrh 
250f7141990Sdrh /*
251f7141990Sdrh ** Allocate memory.  This routine is like sqlite3_malloc() except that it
252f7141990Sdrh ** assumes the memory subsystem has already been initialized.
253f7141990Sdrh */
254da4ca9d1Sdrh void *sqlite3Malloc(u64 n){
255f7141990Sdrh   void *p;
256da4ca9d1Sdrh   if( n==0 || n>=0x7fffff00 ){
257e08ed7e7Sdrh     /* A memory allocation of a number of bytes which is near the maximum
258e08ed7e7Sdrh     ** signed integer value might cause an integer overflow inside of the
259e08ed7e7Sdrh     ** xMalloc().  Hence we limit the maximum size to 0x7fffff00, giving
260e08ed7e7Sdrh     ** 255 bytes of overhead.  SQLite itself will never use anything near
261e08ed7e7Sdrh     ** this amount.  The only way to reach the limit is with sqlite3_malloc() */
262f7141990Sdrh     p = 0;
263075c23afSdanielk1977   }else if( sqlite3GlobalConfig.bMemstat ){
264f7141990Sdrh     sqlite3_mutex_enter(mem0.mutex);
2653329a63aSdrh     mallocWithAlarm((int)n, &p);
266fec00eabSdrh     sqlite3_mutex_leave(mem0.mutex);
267fec00eabSdrh   }else{
268da4ca9d1Sdrh     p = sqlite3GlobalConfig.m.xMalloc((int)n);
269fec00eabSdrh   }
2708da47419Sdrh   assert( EIGHT_BYTE_ALIGNMENT(p) );  /* IMP: R-11148-40995 */
271fec00eabSdrh   return p;
272fec00eabSdrh }
273fec00eabSdrh 
274fec00eabSdrh /*
275fec00eabSdrh ** This version of the memory allocation is for use by the application.
276fec00eabSdrh ** First make sure the memory subsystem is initialized, then do the
277fec00eabSdrh ** allocation.
278fec00eabSdrh */
279fec00eabSdrh void *sqlite3_malloc(int n){
280fec00eabSdrh #ifndef SQLITE_OMIT_AUTOINIT
281fec00eabSdrh   if( sqlite3_initialize() ) return 0;
282fec00eabSdrh #endif
283da4ca9d1Sdrh   return n<=0 ? 0 : sqlite3Malloc(n);
284da4ca9d1Sdrh }
285da4ca9d1Sdrh void *sqlite3_malloc64(sqlite3_uint64 n){
286da4ca9d1Sdrh #ifndef SQLITE_OMIT_AUTOINIT
287da4ca9d1Sdrh   if( sqlite3_initialize() ) return 0;
288da4ca9d1Sdrh #endif
289fec00eabSdrh   return sqlite3Malloc(n);
290fec00eabSdrh }
291fec00eabSdrh 
292fec00eabSdrh /*
293e5ae5735Sdrh ** Each thread may only have a single outstanding allocation from
294facf0307Sdrh ** xScratchMalloc().  We verify this constraint in the single-threaded
295facf0307Sdrh ** case by setting scratchAllocOut to 1 when an allocation
296e5ae5735Sdrh ** is outstanding clearing it when the allocation is freed.
297e5ae5735Sdrh */
298e5ae5735Sdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
299facf0307Sdrh static int scratchAllocOut = 0;
300e5ae5735Sdrh #endif
301e5ae5735Sdrh 
302e5ae5735Sdrh 
303e5ae5735Sdrh /*
304e5ae5735Sdrh ** Allocate memory that is to be used and released right away.
305e5ae5735Sdrh ** This routine is similar to alloca() in that it is not intended
306e5ae5735Sdrh ** for situations where the memory might be held long-term.  This
307e5ae5735Sdrh ** routine is intended to get memory to old large transient data
308e5ae5735Sdrh ** structures that would not normally fit on the stack of an
309e5ae5735Sdrh ** embedded processor.
310e5ae5735Sdrh */
311facf0307Sdrh void *sqlite3ScratchMalloc(int n){
312e5ae5735Sdrh   void *p;
313e5ae5735Sdrh   assert( n>0 );
3149ac3fe97Sdrh 
315badc980aSdrh   sqlite3_mutex_enter(mem0.mutex);
316b02392e6Sdrh   sqlite3StatusHighwater(SQLITE_STATUS_SCRATCH_SIZE, n);
317badc980aSdrh   if( mem0.nScratchFree && sqlite3GlobalConfig.szScratch>=n ){
318badc980aSdrh     p = mem0.pScratchFree;
319badc980aSdrh     mem0.pScratchFree = mem0.pScratchFree->pNext;
320badc980aSdrh     mem0.nScratchFree--;
321af89fe66Sdrh     sqlite3StatusUp(SQLITE_STATUS_SCRATCH_USED, 1);
322b0c6a888Sdan     sqlite3_mutex_leave(mem0.mutex);
323badc980aSdrh   }else{
324b0c6a888Sdan     sqlite3_mutex_leave(mem0.mutex);
3253ccd5bf8Sdrh     p = sqlite3Malloc(n);
3263ccd5bf8Sdrh     if( sqlite3GlobalConfig.bMemstat && p ){
3273ccd5bf8Sdrh       sqlite3_mutex_enter(mem0.mutex);
328af89fe66Sdrh       sqlite3StatusUp(SQLITE_STATUS_SCRATCH_OVERFLOW, sqlite3MallocSize(p));
3293ccd5bf8Sdrh       sqlite3_mutex_leave(mem0.mutex);
330badc980aSdrh     }
331badc980aSdrh     sqlite3MemdebugSetType(p, MEMTYPE_SCRATCH);
332badc980aSdrh   }
3331ff6e3abSdrh   assert( sqlite3_mutex_notheld(mem0.mutex) );
334b0c6a888Sdan 
335badc980aSdrh 
336badc980aSdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
337cbd55b03Sdrh   /* EVIDENCE-OF: R-12970-05880 SQLite will not use more than one scratch
338cbd55b03Sdrh   ** buffers per thread.
339cbd55b03Sdrh   **
340cbd55b03Sdrh   ** This can only be checked in single-threaded mode.
341cbd55b03Sdrh   */
342cbd55b03Sdrh   assert( scratchAllocOut==0 );
343badc980aSdrh   if( p ) scratchAllocOut++;
344badc980aSdrh #endif
345badc980aSdrh 
346badc980aSdrh   return p;
347badc980aSdrh }
348badc980aSdrh void sqlite3ScratchFree(void *p){
349badc980aSdrh   if( p ){
350badc980aSdrh 
351e5ae5735Sdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
35237f99187Sdrh     /* Verify that no more than two scratch allocation per thread
3539ac3fe97Sdrh     ** is outstanding at one time.  (This is only checked in the
3549ac3fe97Sdrh     ** single-threaded case since checking in the multi-threaded case
3559ac3fe97Sdrh     ** would be much more complicated.) */
356badc980aSdrh     assert( scratchAllocOut>=1 && scratchAllocOut<=2 );
357badc980aSdrh     scratchAllocOut--;
358e5ae5735Sdrh #endif
3599ac3fe97Sdrh 
360ac536e61Sdrh     if( SQLITE_WITHIN(p, sqlite3GlobalConfig.pScratch, mem0.pScratchEnd) ){
361badc980aSdrh       /* Release memory from the SQLITE_CONFIG_SCRATCH allocation */
362badc980aSdrh       ScratchFreeslot *pSlot;
363badc980aSdrh       pSlot = (ScratchFreeslot*)p;
364e5ae5735Sdrh       sqlite3_mutex_enter(mem0.mutex);
365badc980aSdrh       pSlot->pNext = mem0.pScratchFree;
366badc980aSdrh       mem0.pScratchFree = pSlot;
367badc980aSdrh       mem0.nScratchFree++;
368fcd71b60Sdrh       assert( mem0.nScratchFree <= (u32)sqlite3GlobalConfig.nScratch );
369af89fe66Sdrh       sqlite3StatusDown(SQLITE_STATUS_SCRATCH_USED, 1);
3709ac3fe97Sdrh       sqlite3_mutex_leave(mem0.mutex);
371f7141990Sdrh     }else{
372badc980aSdrh       /* Release memory back to the heap */
373107b56e8Sdrh       assert( sqlite3MemdebugHasType(p, MEMTYPE_SCRATCH) );
374d425864dSmistachkin       assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_SCRATCH) );
375107b56e8Sdrh       sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
376075c23afSdanielk1977       if( sqlite3GlobalConfig.bMemstat ){
377f7141990Sdrh         int iSize = sqlite3MallocSize(p);
378f7141990Sdrh         sqlite3_mutex_enter(mem0.mutex);
379af89fe66Sdrh         sqlite3StatusDown(SQLITE_STATUS_SCRATCH_OVERFLOW, iSize);
380af89fe66Sdrh         sqlite3StatusDown(SQLITE_STATUS_MEMORY_USED, iSize);
381af89fe66Sdrh         sqlite3StatusDown(SQLITE_STATUS_MALLOC_COUNT, 1);
382075c23afSdanielk1977         sqlite3GlobalConfig.m.xFree(p);
383f7141990Sdrh         sqlite3_mutex_leave(mem0.mutex);
384f7141990Sdrh       }else{
385075c23afSdanielk1977         sqlite3GlobalConfig.m.xFree(p);
386f7141990Sdrh       }
3879ac3fe97Sdrh     }
388e5ae5735Sdrh   }
389e5ae5735Sdrh }
390e5ae5735Sdrh 
391e5ae5735Sdrh /*
392633e6d57Sdrh ** TRUE if p is a lookaside memory allocation from db
393633e6d57Sdrh */
3944150ebf8Sdrh #ifndef SQLITE_OMIT_LOOKASIDE
395633e6d57Sdrh static int isLookaside(sqlite3 *db, void *p){
396ac536e61Sdrh   return SQLITE_WITHIN(p, db->lookaside.pStart, db->lookaside.pEnd);
397633e6d57Sdrh }
3984150ebf8Sdrh #else
3994150ebf8Sdrh #define isLookaside(A,B) 0
4004150ebf8Sdrh #endif
401633e6d57Sdrh 
402633e6d57Sdrh /*
403fec00eabSdrh ** Return the size of a memory allocation previously obtained from
404fec00eabSdrh ** sqlite3Malloc() or sqlite3_malloc().
405fec00eabSdrh */
406fec00eabSdrh int sqlite3MallocSize(void *p){
407107b56e8Sdrh   assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
408075c23afSdanielk1977   return sqlite3GlobalConfig.m.xSize(p);
409fec00eabSdrh }
410633e6d57Sdrh int sqlite3DbMallocSize(sqlite3 *db, void *p){
411039ca6abSdrh   assert( p!=0 );
412054bbabcSdrh   if( db==0 || !isLookaside(db,p) ){
413054bbabcSdrh #if SQLITE_DEBUG
41417bcb102Sdrh     if( db==0 ){
415d425864dSmistachkin       assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
416d231aa3aSdrh       assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
417633e6d57Sdrh     }else{
418d231aa3aSdrh       assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
419d425864dSmistachkin       assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
420633e6d57Sdrh     }
421054bbabcSdrh #endif
422054bbabcSdrh     return sqlite3GlobalConfig.m.xSize(p);
423054bbabcSdrh   }else{
424054bbabcSdrh     assert( sqlite3_mutex_held(db->mutex) );
425054bbabcSdrh     return db->lookaside.sz;
426633e6d57Sdrh   }
42717bcb102Sdrh }
428da4ca9d1Sdrh sqlite3_uint64 sqlite3_msize(void *p){
429d425864dSmistachkin   assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
430d231aa3aSdrh   assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
431039ca6abSdrh   return p ? sqlite3GlobalConfig.m.xSize(p) : 0;
432da4ca9d1Sdrh }
433fec00eabSdrh 
434fec00eabSdrh /*
435fec00eabSdrh ** Free memory previously obtained from sqlite3Malloc().
436fec00eabSdrh */
437fec00eabSdrh void sqlite3_free(void *p){
43871a1a0f4Sdrh   if( p==0 ) return;  /* IMP: R-49053-54554 */
439107b56e8Sdrh   assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
440d425864dSmistachkin   assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
441075c23afSdanielk1977   if( sqlite3GlobalConfig.bMemstat ){
442fec00eabSdrh     sqlite3_mutex_enter(mem0.mutex);
443af89fe66Sdrh     sqlite3StatusDown(SQLITE_STATUS_MEMORY_USED, sqlite3MallocSize(p));
444af89fe66Sdrh     sqlite3StatusDown(SQLITE_STATUS_MALLOC_COUNT, 1);
445075c23afSdanielk1977     sqlite3GlobalConfig.m.xFree(p);
446fec00eabSdrh     sqlite3_mutex_leave(mem0.mutex);
447fec00eabSdrh   }else{
448075c23afSdanielk1977     sqlite3GlobalConfig.m.xFree(p);
449fec00eabSdrh   }
450fec00eabSdrh }
451fec00eabSdrh 
452fec00eabSdrh /*
453b4586f12Sdrh ** Add the size of memory allocation "p" to the count in
454b4586f12Sdrh ** *db->pnBytesFreed.
455b4586f12Sdrh */
456b4586f12Sdrh static SQLITE_NOINLINE void measureAllocationSize(sqlite3 *db, void *p){
45756d90be1Sdrh   *db->pnBytesFreed += sqlite3DbMallocSize(db,p);
458b4586f12Sdrh }
459b4586f12Sdrh 
460b4586f12Sdrh /*
461633e6d57Sdrh ** Free memory that might be associated with a particular database
462633e6d57Sdrh ** connection.
463633e6d57Sdrh */
464633e6d57Sdrh void sqlite3DbFree(sqlite3 *db, void *p){
4657047e25cSdrh   assert( db==0 || sqlite3_mutex_held(db->mutex) );
4669ccd8659Sdrh   if( p==0 ) return;
467174b9a16Sdrh   if( db ){
468174b9a16Sdrh     if( db->pnBytesFreed ){
469b4586f12Sdrh       measureAllocationSize(db, p);
470174b9a16Sdrh       return;
471d46def77Sdan     }
472633e6d57Sdrh     if( isLookaside(db, p) ){
473633e6d57Sdrh       LookasideSlot *pBuf = (LookasideSlot*)p;
4743608f177Sdrh #if SQLITE_DEBUG
4753608f177Sdrh       /* Trash all content in the buffer being freed */
4763608f177Sdrh       memset(p, 0xaa, db->lookaside.sz);
4773608f177Sdrh #endif
478633e6d57Sdrh       pBuf->pNext = db->lookaside.pFree;
479633e6d57Sdrh       db->lookaside.pFree = pBuf;
480633e6d57Sdrh       db->lookaside.nOut--;
481174b9a16Sdrh       return;
482174b9a16Sdrh     }
483174b9a16Sdrh   }
484d231aa3aSdrh   assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
485d425864dSmistachkin   assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
486174b9a16Sdrh   assert( db!=0 || sqlite3MemdebugNoType(p, MEMTYPE_LOOKASIDE) );
487107b56e8Sdrh   sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
488633e6d57Sdrh   sqlite3_free(p);
489633e6d57Sdrh }
490633e6d57Sdrh 
491633e6d57Sdrh /*
492fec00eabSdrh ** Change the size of an existing memory allocation
493fec00eabSdrh */
494da4ca9d1Sdrh void *sqlite3Realloc(void *pOld, u64 nBytes){
495ca591febSshaneh   int nOld, nNew, nDiff;
496fec00eabSdrh   void *pNew;
497d231aa3aSdrh   assert( sqlite3MemdebugHasType(pOld, MEMTYPE_HEAP) );
498d425864dSmistachkin   assert( sqlite3MemdebugNoType(pOld, (u8)~MEMTYPE_HEAP) );
499fec00eabSdrh   if( pOld==0 ){
5008da47419Sdrh     return sqlite3Malloc(nBytes); /* IMP: R-04300-56712 */
501fec00eabSdrh   }
502da4ca9d1Sdrh   if( nBytes==0 ){
5038da47419Sdrh     sqlite3_free(pOld); /* IMP: R-26507-47431 */
504fec00eabSdrh     return 0;
505fec00eabSdrh   }
506b6063cf8Sdrh   if( nBytes>=0x7fffff00 ){
507b6063cf8Sdrh     /* The 0x7ffff00 limit term is explained in comments on sqlite3Malloc() */
508b6063cf8Sdrh     return 0;
509b6063cf8Sdrh   }
510fec00eabSdrh   nOld = sqlite3MallocSize(pOld);
5119f129f46Sdrh   /* IMPLEMENTATION-OF: R-46199-30249 SQLite guarantees that the second
5129f129f46Sdrh   ** argument to xRealloc is always a value returned by a prior call to
5139f129f46Sdrh   ** xRoundup. */
514da4ca9d1Sdrh   nNew = sqlite3GlobalConfig.m.xRoundup((int)nBytes);
515fec00eabSdrh   if( nOld==nNew ){
516fec00eabSdrh     pNew = pOld;
5177c6791c8Sdrh   }else if( sqlite3GlobalConfig.bMemstat ){
5187c6791c8Sdrh     sqlite3_mutex_enter(mem0.mutex);
519b02392e6Sdrh     sqlite3StatusHighwater(SQLITE_STATUS_MALLOC_SIZE, (int)nBytes);
5208e1bb041Sdrh     nDiff = nNew - nOld;
5211aa34695Sdrh     if( nDiff>0 && sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED) >=
5225fb72e5fSdrh           mem0.alarmThreshold-nDiff ){
5235fb72e5fSdrh       sqlite3MallocAlarm(nDiff);
5245fb72e5fSdrh     }
525075c23afSdanielk1977     pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
5265fb72e5fSdrh     if( pNew==0 && mem0.alarmThreshold>0 ){
5275fb72e5fSdrh       sqlite3MallocAlarm((int)nBytes);
528075c23afSdanielk1977       pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
529fec00eabSdrh     }
530fec00eabSdrh     if( pNew ){
531c702c7ccSdrh       nNew = sqlite3MallocSize(pNew);
532af89fe66Sdrh       sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nNew-nOld);
533fec00eabSdrh     }
534fec00eabSdrh     sqlite3_mutex_leave(mem0.mutex);
535fec00eabSdrh   }else{
5367c6791c8Sdrh     pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
537fec00eabSdrh   }
5388da47419Sdrh   assert( EIGHT_BYTE_ALIGNMENT(pNew) ); /* IMP: R-11148-40995 */
539fec00eabSdrh   return pNew;
540fec00eabSdrh }
541fec00eabSdrh 
542fec00eabSdrh /*
543fec00eabSdrh ** The public interface to sqlite3Realloc.  Make sure that the memory
544fec00eabSdrh ** subsystem is initialized prior to invoking sqliteRealloc.
545fec00eabSdrh */
546fec00eabSdrh void *sqlite3_realloc(void *pOld, int n){
547fec00eabSdrh #ifndef SQLITE_OMIT_AUTOINIT
548fec00eabSdrh   if( sqlite3_initialize() ) return 0;
549fec00eabSdrh #endif
5508da47419Sdrh   if( n<0 ) n = 0;  /* IMP: R-26507-47431 */
551da4ca9d1Sdrh   return sqlite3Realloc(pOld, n);
552da4ca9d1Sdrh }
553da4ca9d1Sdrh void *sqlite3_realloc64(void *pOld, sqlite3_uint64 n){
554da4ca9d1Sdrh #ifndef SQLITE_OMIT_AUTOINIT
555da4ca9d1Sdrh   if( sqlite3_initialize() ) return 0;
556da4ca9d1Sdrh #endif
557fec00eabSdrh   return sqlite3Realloc(pOld, n);
558fec00eabSdrh }
559fec00eabSdrh 
560a3152895Sdrh 
561a3152895Sdrh /*
56217435752Sdrh ** Allocate and zero memory.
563a3152895Sdrh */
564da4ca9d1Sdrh void *sqlite3MallocZero(u64 n){
565fec00eabSdrh   void *p = sqlite3Malloc(n);
566a3152895Sdrh   if( p ){
56720f3df04Sdrh     memset(p, 0, (size_t)n);
568a3152895Sdrh   }
569a3152895Sdrh   return p;
570a3152895Sdrh }
57117435752Sdrh 
57217435752Sdrh /*
57317435752Sdrh ** Allocate and zero memory.  If the allocation fails, make
57417435752Sdrh ** the mallocFailed flag in the connection pointer.
57517435752Sdrh */
576da4ca9d1Sdrh void *sqlite3DbMallocZero(sqlite3 *db, u64 n){
577575fad65Sdrh   void *p;
578575fad65Sdrh   testcase( db==0 );
579575fad65Sdrh   p = sqlite3DbMallocRaw(db, n);
580575fad65Sdrh   if( p ) memset(p, 0, (size_t)n);
581575fad65Sdrh   return p;
58217435752Sdrh }
583575fad65Sdrh 
584575fad65Sdrh 
585575fad65Sdrh /* Finish the work of sqlite3DbMallocRawNN for the unusual and
586575fad65Sdrh ** slower case when the allocation cannot be fulfilled using lookaside.
587575fad65Sdrh */
588575fad65Sdrh static SQLITE_NOINLINE void *dbMallocRawFinish(sqlite3 *db, u64 n){
589575fad65Sdrh   void *p;
590575fad65Sdrh   assert( db!=0 );
591575fad65Sdrh   p = sqlite3Malloc(n);
592575fad65Sdrh   if( !p ) sqlite3OomFault(db);
593575fad65Sdrh   sqlite3MemdebugSetType(p,
594575fad65Sdrh          (db->lookaside.bDisable==0) ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP);
59517435752Sdrh   return p;
59617435752Sdrh }
59717435752Sdrh 
59817435752Sdrh /*
5991da26a48Sdrh ** Allocate memory, either lookaside (if possible) or heap.
6001da26a48Sdrh ** If the allocation fails, set the mallocFailed flag in
6011da26a48Sdrh ** the connection pointer.
602ddecae79Sdrh **
603ddecae79Sdrh ** If db!=0 and db->mallocFailed is true (indicating a prior malloc
604ddecae79Sdrh ** failure on the same database connection) then always return 0.
605ddecae79Sdrh ** Hence for a particular database connection, once malloc starts
606ddecae79Sdrh ** failing, it fails consistently until mallocFailed is reset.
607ddecae79Sdrh ** This is an important assumption.  There are many places in the
608ddecae79Sdrh ** code that do things like this:
609ddecae79Sdrh **
610ddecae79Sdrh **         int *a = (int*)sqlite3DbMallocRaw(db, 100);
611ddecae79Sdrh **         int *b = (int*)sqlite3DbMallocRaw(db, 200);
612ddecae79Sdrh **         if( b ) a[10] = 9;
613ddecae79Sdrh **
614ddecae79Sdrh ** In other words, if a subsequent malloc (ex: "b") worked, it is assumed
615ddecae79Sdrh ** that all prior mallocs (ex: "a") worked too.
616575fad65Sdrh **
617575fad65Sdrh ** The sqlite3MallocRawNN() variant guarantees that the "db" parameter is
618575fad65Sdrh ** not a NULL pointer.
61917435752Sdrh */
620da4ca9d1Sdrh void *sqlite3DbMallocRaw(sqlite3 *db, u64 n){
621575fad65Sdrh   void *p;
622575fad65Sdrh   if( db ) return sqlite3DbMallocRawNN(db, n);
623575fad65Sdrh   p = sqlite3Malloc(n);
624575fad65Sdrh   sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
625575fad65Sdrh   return p;
626575fad65Sdrh }
627575fad65Sdrh void *sqlite3DbMallocRawNN(sqlite3 *db, u64 n){
628f5818aa5Sdrh #ifndef SQLITE_OMIT_LOOKASIDE
629f5818aa5Sdrh   LookasideSlot *pBuf;
630575fad65Sdrh   assert( db!=0 );
631575fad65Sdrh   assert( sqlite3_mutex_held(db->mutex) );
632575fad65Sdrh   assert( db->pnBytesFreed==0 );
6334a642b60Sdrh   if( db->lookaside.bDisable==0 ){
6344a642b60Sdrh     assert( db->mallocFailed==0 );
6350b12e7f8Sdrh     if( n>db->lookaside.sz ){
6360b12e7f8Sdrh       db->lookaside.anStat[1]++;
6370b12e7f8Sdrh     }else if( (pBuf = db->lookaside.pFree)==0 ){
6380b12e7f8Sdrh       db->lookaside.anStat[2]++;
6390b12e7f8Sdrh     }else{
640633e6d57Sdrh       db->lookaside.pFree = pBuf->pNext;
641633e6d57Sdrh       db->lookaside.nOut++;
6420b12e7f8Sdrh       db->lookaside.anStat[0]++;
643633e6d57Sdrh       if( db->lookaside.nOut>db->lookaside.mxOut ){
644633e6d57Sdrh         db->lookaside.mxOut = db->lookaside.nOut;
645633e6d57Sdrh       }
646633e6d57Sdrh       return (void*)pBuf;
647633e6d57Sdrh     }
6484a642b60Sdrh   }else if( db->mallocFailed ){
6494a642b60Sdrh     return 0;
650633e6d57Sdrh   }
651ddecae79Sdrh #else
652f5818aa5Sdrh   assert( db!=0 );
653f5818aa5Sdrh   assert( sqlite3_mutex_held(db->mutex) );
654f5818aa5Sdrh   assert( db->pnBytesFreed==0 );
655575fad65Sdrh   if( db->mallocFailed ){
656ddecae79Sdrh     return 0;
657ddecae79Sdrh   }
6584150ebf8Sdrh #endif
6591da26a48Sdrh   return dbMallocRawFinish(db, n);
6601da26a48Sdrh }
66117435752Sdrh 
662b84e574cSdrh /* Forward declaration */
663b84e574cSdrh static SQLITE_NOINLINE void *dbReallocFinish(sqlite3 *db, void *p, u64 n);
664b84e574cSdrh 
66526783a58Sdanielk1977 /*
66626783a58Sdanielk1977 ** Resize the block of memory pointed to by p to n bytes. If the
66726783a58Sdanielk1977 ** resize fails, set the mallocFailed flag in the connection object.
66826783a58Sdanielk1977 */
669da4ca9d1Sdrh void *sqlite3DbRealloc(sqlite3 *db, void *p, u64 n){
670b84e574cSdrh   assert( db!=0 );
671575fad65Sdrh   if( p==0 ) return sqlite3DbMallocRawNN(db, n);
672b84e574cSdrh   assert( sqlite3_mutex_held(db->mutex) );
673b84e574cSdrh   if( isLookaside(db,p) && n<=db->lookaside.sz ) return p;
674b84e574cSdrh   return dbReallocFinish(db, p, n);
675b84e574cSdrh }
676b84e574cSdrh static SQLITE_NOINLINE void *dbReallocFinish(sqlite3 *db, void *p, u64 n){
677a1644fd8Sdanielk1977   void *pNew = 0;
678d9da78a2Sdrh   assert( db!=0 );
679b84e574cSdrh   assert( p!=0 );
680a1644fd8Sdanielk1977   if( db->mallocFailed==0 ){
681633e6d57Sdrh     if( isLookaside(db, p) ){
682575fad65Sdrh       pNew = sqlite3DbMallocRawNN(db, n);
683633e6d57Sdrh       if( pNew ){
684633e6d57Sdrh         memcpy(pNew, p, db->lookaside.sz);
685633e6d57Sdrh         sqlite3DbFree(db, p);
686633e6d57Sdrh       }
687633e6d57Sdrh     }else{
688d231aa3aSdrh       assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
689d425864dSmistachkin       assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
690107b56e8Sdrh       sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
6913329a63aSdrh       pNew = sqlite3_realloc64(p, n);
692a1644fd8Sdanielk1977       if( !pNew ){
6934a642b60Sdrh         sqlite3OomFault(db);
694a1644fd8Sdanielk1977       }
695d231aa3aSdrh       sqlite3MemdebugSetType(pNew,
6964a642b60Sdrh             (db->lookaside.bDisable==0 ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP));
697a1644fd8Sdanielk1977     }
698633e6d57Sdrh   }
699a1644fd8Sdanielk1977   return pNew;
700a1644fd8Sdanielk1977 }
701a1644fd8Sdanielk1977 
70217435752Sdrh /*
70317435752Sdrh ** Attempt to reallocate p.  If the reallocation fails, then free p
70417435752Sdrh ** and set the mallocFailed flag in the database connection.
70517435752Sdrh */
706da4ca9d1Sdrh void *sqlite3DbReallocOrFree(sqlite3 *db, void *p, u64 n){
707a3152895Sdrh   void *pNew;
708a1644fd8Sdanielk1977   pNew = sqlite3DbRealloc(db, p, n);
709a3152895Sdrh   if( !pNew ){
710633e6d57Sdrh     sqlite3DbFree(db, p);
711a3152895Sdrh   }
712a3152895Sdrh   return pNew;
713a3152895Sdrh }
714a3152895Sdrh 
715a3152895Sdrh /*
716a3152895Sdrh ** Make a copy of a string in memory obtained from sqliteMalloc(). These
717a3152895Sdrh ** functions call sqlite3MallocRaw() directly instead of sqliteMalloc(). This
718a3152895Sdrh ** is because when memory debugging is turned on, these two functions are
719a3152895Sdrh ** called via macros that record the current file and line number in the
720a3152895Sdrh ** ThreadData structure.
721a3152895Sdrh */
722633e6d57Sdrh char *sqlite3DbStrDup(sqlite3 *db, const char *z){
723a3152895Sdrh   char *zNew;
724633e6d57Sdrh   size_t n;
725633e6d57Sdrh   if( z==0 ){
726633e6d57Sdrh     return 0;
727a3152895Sdrh   }
728cee11adaSdrh   n = strlen(z) + 1;
729cee11adaSdrh   zNew = sqlite3DbMallocRaw(db, n);
730a3152895Sdrh   if( zNew ){
731a3152895Sdrh     memcpy(zNew, z, n);
7321e536953Sdanielk1977   }
7331e536953Sdanielk1977   return zNew;
7341e536953Sdanielk1977 }
735da4ca9d1Sdrh char *sqlite3DbStrNDup(sqlite3 *db, const char *z, u64 n){
736633e6d57Sdrh   char *zNew;
737575fad65Sdrh   assert( db!=0 );
738633e6d57Sdrh   if( z==0 ){
739633e6d57Sdrh     return 0;
740633e6d57Sdrh   }
741633e6d57Sdrh   assert( (n&0x7fffffff)==n );
742575fad65Sdrh   zNew = sqlite3DbMallocRawNN(db, n+1);
743633e6d57Sdrh   if( zNew ){
74420f3df04Sdrh     memcpy(zNew, z, (size_t)n);
745633e6d57Sdrh     zNew[n] = 0;
7461e536953Sdanielk1977   }
7471e536953Sdanielk1977   return zNew;
7481e536953Sdanielk1977 }
7491e536953Sdanielk1977 
750a3152895Sdrh /*
75122c17b8bSdrh ** Free any prior content in *pz and replace it with a copy of zNew.
752a3152895Sdrh */
75322c17b8bSdrh void sqlite3SetString(char **pz, sqlite3 *db, const char *zNew){
754633e6d57Sdrh   sqlite3DbFree(db, *pz);
75522c17b8bSdrh   *pz = sqlite3DbStrDup(db, zNew);
756a3152895Sdrh }
757a3152895Sdrh 
758b50c65d5Sdrh /*
7594a642b60Sdrh ** Call this routine to record the fact that an OOM (out-of-memory) error
7604a642b60Sdrh ** has happened.  This routine will set db->mallocFailed, and also
7614a642b60Sdrh ** temporarily disable the lookaside memory allocator and interrupt
7624a642b60Sdrh ** any running VDBEs.
7634a642b60Sdrh */
7644a642b60Sdrh void sqlite3OomFault(sqlite3 *db){
7654a642b60Sdrh   if( db->mallocFailed==0 && db->bBenignMalloc==0 ){
7664a642b60Sdrh     db->mallocFailed = 1;
7674a642b60Sdrh     if( db->nVdbeExec>0 ){
7684a642b60Sdrh       db->u1.isInterrupted = 1;
7694a642b60Sdrh     }
7704a642b60Sdrh     db->lookaside.bDisable++;
7714a642b60Sdrh   }
7724a642b60Sdrh }
7734a642b60Sdrh 
7744a642b60Sdrh /*
7754a642b60Sdrh ** This routine reactivates the memory allocator and clears the
7764a642b60Sdrh ** db->mallocFailed flag as necessary.
7774a642b60Sdrh **
7784a642b60Sdrh ** The memory allocator is not restarted if there are running
7794a642b60Sdrh ** VDBEs.
7804a642b60Sdrh */
7814a642b60Sdrh void sqlite3OomClear(sqlite3 *db){
7824a642b60Sdrh   if( db->mallocFailed && db->nVdbeExec==0 ){
7834a642b60Sdrh     db->mallocFailed = 0;
7844a642b60Sdrh     db->u1.isInterrupted = 0;
7854a642b60Sdrh     assert( db->lookaside.bDisable>0 );
7864a642b60Sdrh     db->lookaside.bDisable--;
7874a642b60Sdrh   }
7884a642b60Sdrh }
7894a642b60Sdrh 
7904a642b60Sdrh /*
791b50c65d5Sdrh ** Take actions at the end of an API call to indicate an OOM error
792b50c65d5Sdrh */
793b50c65d5Sdrh static SQLITE_NOINLINE int apiOomError(sqlite3 *db){
7944a642b60Sdrh   sqlite3OomClear(db);
795b50c65d5Sdrh   sqlite3Error(db, SQLITE_NOMEM);
796fad3039cSmistachkin   return SQLITE_NOMEM_BKPT;
797b50c65d5Sdrh }
798a3152895Sdrh 
799a3152895Sdrh /*
800a3152895Sdrh ** This function must be called before exiting any API function (i.e.
80117435752Sdrh ** returning control to the user) that has called sqlite3_malloc or
80217435752Sdrh ** sqlite3_realloc.
803a3152895Sdrh **
804a3152895Sdrh ** The returned value is normally a copy of the second argument to this
805be217793Sshane ** function. However, if a malloc() failure has occurred since the previous
806a3152895Sdrh ** invocation SQLITE_NOMEM is returned instead.
807a3152895Sdrh **
808597d2b64Sdrh ** If an OOM as occurred, then the connection error-code (the value
809597d2b64Sdrh ** returned by sqlite3_errcode()) is set to SQLITE_NOMEM.
810a3152895Sdrh */
811a3152895Sdrh int sqlite3ApiExit(sqlite3* db, int rc){
812597d2b64Sdrh   /* If the db handle must hold the connection handle mutex here.
813597d2b64Sdrh   ** Otherwise the read (and possible write) of db->mallocFailed
814a1644fd8Sdanielk1977   ** is unsafe, as is the call to sqlite3Error().
815a1644fd8Sdanielk1977   */
816597d2b64Sdrh   assert( db!=0 );
817597d2b64Sdrh   assert( sqlite3_mutex_held(db->mutex) );
818b50c65d5Sdrh   if( db->mallocFailed || rc==SQLITE_IOERR_NOMEM ){
819b50c65d5Sdrh     return apiOomError(db);
820a3152895Sdrh   }
821b50c65d5Sdrh   return rc & db->errMask;
822a3152895Sdrh }
823