xref: /sqlite-3.40.0/src/malloc.c (revision e43d6aee)
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 */
220*e43d6aeeSdrh static void *mallocWithAlarm(int n){
221f7141990Sdrh   void *p;
222087a29c7Sdrh   int nFull;
223f7141990Sdrh   assert( sqlite3_mutex_held(mem0.mutex) );
224087a29c7Sdrh   assert( n>0 );
225087a29c7Sdrh 
22640b84365Smistachkin   /* In Firefox (circa 2017-02-08), xRoundup() is remapped to an internal
227087a29c7Sdrh   ** implementation of malloc_good_size(), which must be called in debug
228087a29c7Sdrh   ** mode and specifically when the DMD "Dark Matter Detector" is enabled
22940b84365Smistachkin   ** or else a crash results.  Hence, do not attempt to optimize out the
23040b84365Smistachkin   ** following xRoundup() call. */
231087a29c7Sdrh   nFull = sqlite3GlobalConfig.m.xRoundup(n);
232087a29c7Sdrh 
233*e43d6aeeSdrh #ifdef SQLITE_MAX_MEMORY
234*e43d6aeeSdrh   if( sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED)+nFull>SQLITE_MAX_MEMORY ){
235*e43d6aeeSdrh     return 0;
236*e43d6aeeSdrh   }
237*e43d6aeeSdrh #endif
238*e43d6aeeSdrh 
239b02392e6Sdrh   sqlite3StatusHighwater(SQLITE_STATUS_MALLOC_SIZE, n);
2405fb72e5fSdrh   if( mem0.alarmThreshold>0 ){
2415fb72e5fSdrh     sqlite3_int64 nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
2425fb72e5fSdrh     if( nUsed >= mem0.alarmThreshold - nFull ){
2435fb72e5fSdrh       mem0.nearlyFull = 1;
2445fb72e5fSdrh       sqlite3MallocAlarm(nFull);
2455fb72e5fSdrh     }else{
2465fb72e5fSdrh       mem0.nearlyFull = 0;
2475fb72e5fSdrh     }
2485fb72e5fSdrh   }
249087a29c7Sdrh   p = sqlite3GlobalConfig.m.xMalloc(nFull);
25050d1b5f3Sdrh #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
2515fb72e5fSdrh   if( p==0 && mem0.alarmThreshold>0 ){
2525fb72e5fSdrh     sqlite3MallocAlarm(nFull);
253087a29c7Sdrh     p = sqlite3GlobalConfig.m.xMalloc(nFull);
254fec00eabSdrh   }
25550d1b5f3Sdrh #endif
256c702c7ccSdrh   if( p ){
257be7a0ceeSdrh     nFull = sqlite3MallocSize(p);
258af89fe66Sdrh     sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nFull);
259af89fe66Sdrh     sqlite3StatusUp(SQLITE_STATUS_MALLOC_COUNT, 1);
260c702c7ccSdrh   }
261*e43d6aeeSdrh   return p;
262fec00eabSdrh }
263f7141990Sdrh 
264f7141990Sdrh /*
265f7141990Sdrh ** Allocate memory.  This routine is like sqlite3_malloc() except that it
266f7141990Sdrh ** assumes the memory subsystem has already been initialized.
267f7141990Sdrh */
268da4ca9d1Sdrh void *sqlite3Malloc(u64 n){
269f7141990Sdrh   void *p;
270da4ca9d1Sdrh   if( n==0 || n>=0x7fffff00 ){
271e08ed7e7Sdrh     /* A memory allocation of a number of bytes which is near the maximum
272e08ed7e7Sdrh     ** signed integer value might cause an integer overflow inside of the
273e08ed7e7Sdrh     ** xMalloc().  Hence we limit the maximum size to 0x7fffff00, giving
274e08ed7e7Sdrh     ** 255 bytes of overhead.  SQLite itself will never use anything near
275e08ed7e7Sdrh     ** this amount.  The only way to reach the limit is with sqlite3_malloc() */
276f7141990Sdrh     p = 0;
277075c23afSdanielk1977   }else if( sqlite3GlobalConfig.bMemstat ){
278f7141990Sdrh     sqlite3_mutex_enter(mem0.mutex);
279*e43d6aeeSdrh     p = mallocWithAlarm((int)n);
280fec00eabSdrh     sqlite3_mutex_leave(mem0.mutex);
281fec00eabSdrh   }else{
282da4ca9d1Sdrh     p = sqlite3GlobalConfig.m.xMalloc((int)n);
283fec00eabSdrh   }
2848da47419Sdrh   assert( EIGHT_BYTE_ALIGNMENT(p) );  /* IMP: R-11148-40995 */
285fec00eabSdrh   return p;
286fec00eabSdrh }
287fec00eabSdrh 
288fec00eabSdrh /*
289fec00eabSdrh ** This version of the memory allocation is for use by the application.
290fec00eabSdrh ** First make sure the memory subsystem is initialized, then do the
291fec00eabSdrh ** allocation.
292fec00eabSdrh */
293fec00eabSdrh void *sqlite3_malloc(int n){
294fec00eabSdrh #ifndef SQLITE_OMIT_AUTOINIT
295fec00eabSdrh   if( sqlite3_initialize() ) return 0;
296fec00eabSdrh #endif
297da4ca9d1Sdrh   return n<=0 ? 0 : sqlite3Malloc(n);
298da4ca9d1Sdrh }
299da4ca9d1Sdrh void *sqlite3_malloc64(sqlite3_uint64 n){
300da4ca9d1Sdrh #ifndef SQLITE_OMIT_AUTOINIT
301da4ca9d1Sdrh   if( sqlite3_initialize() ) return 0;
302da4ca9d1Sdrh #endif
303fec00eabSdrh   return sqlite3Malloc(n);
304fec00eabSdrh }
305fec00eabSdrh 
306fec00eabSdrh /*
307e5ae5735Sdrh ** Each thread may only have a single outstanding allocation from
308facf0307Sdrh ** xScratchMalloc().  We verify this constraint in the single-threaded
309facf0307Sdrh ** case by setting scratchAllocOut to 1 when an allocation
310e5ae5735Sdrh ** is outstanding clearing it when the allocation is freed.
311e5ae5735Sdrh */
312e5ae5735Sdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
313facf0307Sdrh static int scratchAllocOut = 0;
314e5ae5735Sdrh #endif
315e5ae5735Sdrh 
316e5ae5735Sdrh 
317e5ae5735Sdrh /*
318e5ae5735Sdrh ** Allocate memory that is to be used and released right away.
319e5ae5735Sdrh ** This routine is similar to alloca() in that it is not intended
320e5ae5735Sdrh ** for situations where the memory might be held long-term.  This
321e5ae5735Sdrh ** routine is intended to get memory to old large transient data
322e5ae5735Sdrh ** structures that would not normally fit on the stack of an
323e5ae5735Sdrh ** embedded processor.
324e5ae5735Sdrh */
325facf0307Sdrh void *sqlite3ScratchMalloc(int n){
326e5ae5735Sdrh   void *p;
327e5ae5735Sdrh   assert( n>0 );
3289ac3fe97Sdrh 
329badc980aSdrh   sqlite3_mutex_enter(mem0.mutex);
330b02392e6Sdrh   sqlite3StatusHighwater(SQLITE_STATUS_SCRATCH_SIZE, n);
331badc980aSdrh   if( mem0.nScratchFree && sqlite3GlobalConfig.szScratch>=n ){
332badc980aSdrh     p = mem0.pScratchFree;
333badc980aSdrh     mem0.pScratchFree = mem0.pScratchFree->pNext;
334badc980aSdrh     mem0.nScratchFree--;
335af89fe66Sdrh     sqlite3StatusUp(SQLITE_STATUS_SCRATCH_USED, 1);
336b0c6a888Sdan     sqlite3_mutex_leave(mem0.mutex);
337badc980aSdrh   }else{
338b0c6a888Sdan     sqlite3_mutex_leave(mem0.mutex);
3393ccd5bf8Sdrh     p = sqlite3Malloc(n);
3403ccd5bf8Sdrh     if( sqlite3GlobalConfig.bMemstat && p ){
3413ccd5bf8Sdrh       sqlite3_mutex_enter(mem0.mutex);
342af89fe66Sdrh       sqlite3StatusUp(SQLITE_STATUS_SCRATCH_OVERFLOW, sqlite3MallocSize(p));
3433ccd5bf8Sdrh       sqlite3_mutex_leave(mem0.mutex);
344badc980aSdrh     }
345badc980aSdrh     sqlite3MemdebugSetType(p, MEMTYPE_SCRATCH);
346badc980aSdrh   }
3471ff6e3abSdrh   assert( sqlite3_mutex_notheld(mem0.mutex) );
348b0c6a888Sdan 
349badc980aSdrh 
350badc980aSdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
351cbd55b03Sdrh   /* EVIDENCE-OF: R-12970-05880 SQLite will not use more than one scratch
352cbd55b03Sdrh   ** buffers per thread.
353cbd55b03Sdrh   **
354cbd55b03Sdrh   ** This can only be checked in single-threaded mode.
355cbd55b03Sdrh   */
356cbd55b03Sdrh   assert( scratchAllocOut==0 );
357badc980aSdrh   if( p ) scratchAllocOut++;
358badc980aSdrh #endif
359badc980aSdrh 
360badc980aSdrh   return p;
361badc980aSdrh }
362badc980aSdrh void sqlite3ScratchFree(void *p){
363badc980aSdrh   if( p ){
364badc980aSdrh 
365e5ae5735Sdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
36637f99187Sdrh     /* Verify that no more than two scratch allocation per thread
3679ac3fe97Sdrh     ** is outstanding at one time.  (This is only checked in the
3689ac3fe97Sdrh     ** single-threaded case since checking in the multi-threaded case
3699ac3fe97Sdrh     ** would be much more complicated.) */
370badc980aSdrh     assert( scratchAllocOut>=1 && scratchAllocOut<=2 );
371badc980aSdrh     scratchAllocOut--;
372e5ae5735Sdrh #endif
3739ac3fe97Sdrh 
374ac536e61Sdrh     if( SQLITE_WITHIN(p, sqlite3GlobalConfig.pScratch, mem0.pScratchEnd) ){
375badc980aSdrh       /* Release memory from the SQLITE_CONFIG_SCRATCH allocation */
376badc980aSdrh       ScratchFreeslot *pSlot;
377badc980aSdrh       pSlot = (ScratchFreeslot*)p;
378e5ae5735Sdrh       sqlite3_mutex_enter(mem0.mutex);
379badc980aSdrh       pSlot->pNext = mem0.pScratchFree;
380badc980aSdrh       mem0.pScratchFree = pSlot;
381badc980aSdrh       mem0.nScratchFree++;
382fcd71b60Sdrh       assert( mem0.nScratchFree <= (u32)sqlite3GlobalConfig.nScratch );
383af89fe66Sdrh       sqlite3StatusDown(SQLITE_STATUS_SCRATCH_USED, 1);
3849ac3fe97Sdrh       sqlite3_mutex_leave(mem0.mutex);
385f7141990Sdrh     }else{
386badc980aSdrh       /* Release memory back to the heap */
387107b56e8Sdrh       assert( sqlite3MemdebugHasType(p, MEMTYPE_SCRATCH) );
388d425864dSmistachkin       assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_SCRATCH) );
389107b56e8Sdrh       sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
390075c23afSdanielk1977       if( sqlite3GlobalConfig.bMemstat ){
391f7141990Sdrh         int iSize = sqlite3MallocSize(p);
392f7141990Sdrh         sqlite3_mutex_enter(mem0.mutex);
393af89fe66Sdrh         sqlite3StatusDown(SQLITE_STATUS_SCRATCH_OVERFLOW, iSize);
394af89fe66Sdrh         sqlite3StatusDown(SQLITE_STATUS_MEMORY_USED, iSize);
395af89fe66Sdrh         sqlite3StatusDown(SQLITE_STATUS_MALLOC_COUNT, 1);
396075c23afSdanielk1977         sqlite3GlobalConfig.m.xFree(p);
397f7141990Sdrh         sqlite3_mutex_leave(mem0.mutex);
398f7141990Sdrh       }else{
399075c23afSdanielk1977         sqlite3GlobalConfig.m.xFree(p);
400f7141990Sdrh       }
4019ac3fe97Sdrh     }
402e5ae5735Sdrh   }
403e5ae5735Sdrh }
404e5ae5735Sdrh 
405e5ae5735Sdrh /*
406633e6d57Sdrh ** TRUE if p is a lookaside memory allocation from db
407633e6d57Sdrh */
4084150ebf8Sdrh #ifndef SQLITE_OMIT_LOOKASIDE
409633e6d57Sdrh static int isLookaside(sqlite3 *db, void *p){
410ac536e61Sdrh   return SQLITE_WITHIN(p, db->lookaside.pStart, db->lookaside.pEnd);
411633e6d57Sdrh }
4124150ebf8Sdrh #else
4134150ebf8Sdrh #define isLookaside(A,B) 0
4144150ebf8Sdrh #endif
415633e6d57Sdrh 
416633e6d57Sdrh /*
417fec00eabSdrh ** Return the size of a memory allocation previously obtained from
418fec00eabSdrh ** sqlite3Malloc() or sqlite3_malloc().
419fec00eabSdrh */
420fec00eabSdrh int sqlite3MallocSize(void *p){
421107b56e8Sdrh   assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
422075c23afSdanielk1977   return sqlite3GlobalConfig.m.xSize(p);
423fec00eabSdrh }
424633e6d57Sdrh int sqlite3DbMallocSize(sqlite3 *db, void *p){
425039ca6abSdrh   assert( p!=0 );
426054bbabcSdrh   if( db==0 || !isLookaside(db,p) ){
427d879e3ebSdrh #ifdef SQLITE_DEBUG
42817bcb102Sdrh     if( db==0 ){
429d425864dSmistachkin       assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
430d231aa3aSdrh       assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
431633e6d57Sdrh     }else{
432d231aa3aSdrh       assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
433d425864dSmistachkin       assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
434633e6d57Sdrh     }
435054bbabcSdrh #endif
436054bbabcSdrh     return sqlite3GlobalConfig.m.xSize(p);
437054bbabcSdrh   }else{
438054bbabcSdrh     assert( sqlite3_mutex_held(db->mutex) );
439054bbabcSdrh     return db->lookaside.sz;
440633e6d57Sdrh   }
44117bcb102Sdrh }
442da4ca9d1Sdrh sqlite3_uint64 sqlite3_msize(void *p){
443d425864dSmistachkin   assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
444d231aa3aSdrh   assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
445039ca6abSdrh   return p ? sqlite3GlobalConfig.m.xSize(p) : 0;
446da4ca9d1Sdrh }
447fec00eabSdrh 
448fec00eabSdrh /*
449fec00eabSdrh ** Free memory previously obtained from sqlite3Malloc().
450fec00eabSdrh */
451fec00eabSdrh void sqlite3_free(void *p){
45271a1a0f4Sdrh   if( p==0 ) return;  /* IMP: R-49053-54554 */
453107b56e8Sdrh   assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
454d425864dSmistachkin   assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
455075c23afSdanielk1977   if( sqlite3GlobalConfig.bMemstat ){
456fec00eabSdrh     sqlite3_mutex_enter(mem0.mutex);
457af89fe66Sdrh     sqlite3StatusDown(SQLITE_STATUS_MEMORY_USED, sqlite3MallocSize(p));
458af89fe66Sdrh     sqlite3StatusDown(SQLITE_STATUS_MALLOC_COUNT, 1);
459075c23afSdanielk1977     sqlite3GlobalConfig.m.xFree(p);
460fec00eabSdrh     sqlite3_mutex_leave(mem0.mutex);
461fec00eabSdrh   }else{
462075c23afSdanielk1977     sqlite3GlobalConfig.m.xFree(p);
463fec00eabSdrh   }
464fec00eabSdrh }
465fec00eabSdrh 
466fec00eabSdrh /*
467b4586f12Sdrh ** Add the size of memory allocation "p" to the count in
468b4586f12Sdrh ** *db->pnBytesFreed.
469b4586f12Sdrh */
470b4586f12Sdrh static SQLITE_NOINLINE void measureAllocationSize(sqlite3 *db, void *p){
47156d90be1Sdrh   *db->pnBytesFreed += sqlite3DbMallocSize(db,p);
472b4586f12Sdrh }
473b4586f12Sdrh 
474b4586f12Sdrh /*
475633e6d57Sdrh ** Free memory that might be associated with a particular database
476633e6d57Sdrh ** connection.
477633e6d57Sdrh */
478633e6d57Sdrh void sqlite3DbFree(sqlite3 *db, void *p){
4797047e25cSdrh   assert( db==0 || sqlite3_mutex_held(db->mutex) );
4809ccd8659Sdrh   if( p==0 ) return;
481174b9a16Sdrh   if( db ){
482174b9a16Sdrh     if( db->pnBytesFreed ){
483b4586f12Sdrh       measureAllocationSize(db, p);
484174b9a16Sdrh       return;
485d46def77Sdan     }
486633e6d57Sdrh     if( isLookaside(db, p) ){
487633e6d57Sdrh       LookasideSlot *pBuf = (LookasideSlot*)p;
488d879e3ebSdrh #ifdef SQLITE_DEBUG
4893608f177Sdrh       /* Trash all content in the buffer being freed */
4903608f177Sdrh       memset(p, 0xaa, db->lookaside.sz);
4913608f177Sdrh #endif
492633e6d57Sdrh       pBuf->pNext = db->lookaside.pFree;
493633e6d57Sdrh       db->lookaside.pFree = pBuf;
494633e6d57Sdrh       db->lookaside.nOut--;
495174b9a16Sdrh       return;
496174b9a16Sdrh     }
497174b9a16Sdrh   }
498d231aa3aSdrh   assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
499d425864dSmistachkin   assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
500174b9a16Sdrh   assert( db!=0 || sqlite3MemdebugNoType(p, MEMTYPE_LOOKASIDE) );
501107b56e8Sdrh   sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
502633e6d57Sdrh   sqlite3_free(p);
503633e6d57Sdrh }
504633e6d57Sdrh 
505633e6d57Sdrh /*
506fec00eabSdrh ** Change the size of an existing memory allocation
507fec00eabSdrh */
508da4ca9d1Sdrh void *sqlite3Realloc(void *pOld, u64 nBytes){
509ca591febSshaneh   int nOld, nNew, nDiff;
510fec00eabSdrh   void *pNew;
511d231aa3aSdrh   assert( sqlite3MemdebugHasType(pOld, MEMTYPE_HEAP) );
512d425864dSmistachkin   assert( sqlite3MemdebugNoType(pOld, (u8)~MEMTYPE_HEAP) );
513fec00eabSdrh   if( pOld==0 ){
5148da47419Sdrh     return sqlite3Malloc(nBytes); /* IMP: R-04300-56712 */
515fec00eabSdrh   }
516da4ca9d1Sdrh   if( nBytes==0 ){
5178da47419Sdrh     sqlite3_free(pOld); /* IMP: R-26507-47431 */
518fec00eabSdrh     return 0;
519fec00eabSdrh   }
520b6063cf8Sdrh   if( nBytes>=0x7fffff00 ){
521b6063cf8Sdrh     /* The 0x7ffff00 limit term is explained in comments on sqlite3Malloc() */
522b6063cf8Sdrh     return 0;
523b6063cf8Sdrh   }
524fec00eabSdrh   nOld = sqlite3MallocSize(pOld);
5259f129f46Sdrh   /* IMPLEMENTATION-OF: R-46199-30249 SQLite guarantees that the second
5269f129f46Sdrh   ** argument to xRealloc is always a value returned by a prior call to
5279f129f46Sdrh   ** xRoundup. */
528da4ca9d1Sdrh   nNew = sqlite3GlobalConfig.m.xRoundup((int)nBytes);
529fec00eabSdrh   if( nOld==nNew ){
530fec00eabSdrh     pNew = pOld;
5317c6791c8Sdrh   }else if( sqlite3GlobalConfig.bMemstat ){
5327c6791c8Sdrh     sqlite3_mutex_enter(mem0.mutex);
533b02392e6Sdrh     sqlite3StatusHighwater(SQLITE_STATUS_MALLOC_SIZE, (int)nBytes);
5348e1bb041Sdrh     nDiff = nNew - nOld;
5351aa34695Sdrh     if( nDiff>0 && sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED) >=
5365fb72e5fSdrh           mem0.alarmThreshold-nDiff ){
5375fb72e5fSdrh       sqlite3MallocAlarm(nDiff);
5385fb72e5fSdrh     }
539075c23afSdanielk1977     pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
5405fb72e5fSdrh     if( pNew==0 && mem0.alarmThreshold>0 ){
5415fb72e5fSdrh       sqlite3MallocAlarm((int)nBytes);
542075c23afSdanielk1977       pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
543fec00eabSdrh     }
544fec00eabSdrh     if( pNew ){
545c702c7ccSdrh       nNew = sqlite3MallocSize(pNew);
546af89fe66Sdrh       sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nNew-nOld);
547fec00eabSdrh     }
548fec00eabSdrh     sqlite3_mutex_leave(mem0.mutex);
549fec00eabSdrh   }else{
5507c6791c8Sdrh     pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
551fec00eabSdrh   }
5528da47419Sdrh   assert( EIGHT_BYTE_ALIGNMENT(pNew) ); /* IMP: R-11148-40995 */
553fec00eabSdrh   return pNew;
554fec00eabSdrh }
555fec00eabSdrh 
556fec00eabSdrh /*
557fec00eabSdrh ** The public interface to sqlite3Realloc.  Make sure that the memory
558fec00eabSdrh ** subsystem is initialized prior to invoking sqliteRealloc.
559fec00eabSdrh */
560fec00eabSdrh void *sqlite3_realloc(void *pOld, int n){
561fec00eabSdrh #ifndef SQLITE_OMIT_AUTOINIT
562fec00eabSdrh   if( sqlite3_initialize() ) return 0;
563fec00eabSdrh #endif
5648da47419Sdrh   if( n<0 ) n = 0;  /* IMP: R-26507-47431 */
565da4ca9d1Sdrh   return sqlite3Realloc(pOld, n);
566da4ca9d1Sdrh }
567da4ca9d1Sdrh void *sqlite3_realloc64(void *pOld, sqlite3_uint64 n){
568da4ca9d1Sdrh #ifndef SQLITE_OMIT_AUTOINIT
569da4ca9d1Sdrh   if( sqlite3_initialize() ) return 0;
570da4ca9d1Sdrh #endif
571fec00eabSdrh   return sqlite3Realloc(pOld, n);
572fec00eabSdrh }
573fec00eabSdrh 
574a3152895Sdrh 
575a3152895Sdrh /*
57617435752Sdrh ** Allocate and zero memory.
577a3152895Sdrh */
578da4ca9d1Sdrh void *sqlite3MallocZero(u64 n){
579fec00eabSdrh   void *p = sqlite3Malloc(n);
580a3152895Sdrh   if( p ){
58120f3df04Sdrh     memset(p, 0, (size_t)n);
582a3152895Sdrh   }
583a3152895Sdrh   return p;
584a3152895Sdrh }
58517435752Sdrh 
58617435752Sdrh /*
58717435752Sdrh ** Allocate and zero memory.  If the allocation fails, make
58817435752Sdrh ** the mallocFailed flag in the connection pointer.
58917435752Sdrh */
590da4ca9d1Sdrh void *sqlite3DbMallocZero(sqlite3 *db, u64 n){
591575fad65Sdrh   void *p;
592575fad65Sdrh   testcase( db==0 );
593575fad65Sdrh   p = sqlite3DbMallocRaw(db, n);
594575fad65Sdrh   if( p ) memset(p, 0, (size_t)n);
595575fad65Sdrh   return p;
59617435752Sdrh }
597575fad65Sdrh 
598575fad65Sdrh 
599575fad65Sdrh /* Finish the work of sqlite3DbMallocRawNN for the unusual and
600575fad65Sdrh ** slower case when the allocation cannot be fulfilled using lookaside.
601575fad65Sdrh */
602575fad65Sdrh static SQLITE_NOINLINE void *dbMallocRawFinish(sqlite3 *db, u64 n){
603575fad65Sdrh   void *p;
604575fad65Sdrh   assert( db!=0 );
605575fad65Sdrh   p = sqlite3Malloc(n);
606575fad65Sdrh   if( !p ) sqlite3OomFault(db);
607575fad65Sdrh   sqlite3MemdebugSetType(p,
608575fad65Sdrh          (db->lookaside.bDisable==0) ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP);
60917435752Sdrh   return p;
61017435752Sdrh }
61117435752Sdrh 
61217435752Sdrh /*
6131da26a48Sdrh ** Allocate memory, either lookaside (if possible) or heap.
6141da26a48Sdrh ** If the allocation fails, set the mallocFailed flag in
6151da26a48Sdrh ** the connection pointer.
616ddecae79Sdrh **
617ddecae79Sdrh ** If db!=0 and db->mallocFailed is true (indicating a prior malloc
618ddecae79Sdrh ** failure on the same database connection) then always return 0.
619ddecae79Sdrh ** Hence for a particular database connection, once malloc starts
620ddecae79Sdrh ** failing, it fails consistently until mallocFailed is reset.
621ddecae79Sdrh ** This is an important assumption.  There are many places in the
622ddecae79Sdrh ** code that do things like this:
623ddecae79Sdrh **
624ddecae79Sdrh **         int *a = (int*)sqlite3DbMallocRaw(db, 100);
625ddecae79Sdrh **         int *b = (int*)sqlite3DbMallocRaw(db, 200);
626ddecae79Sdrh **         if( b ) a[10] = 9;
627ddecae79Sdrh **
628ddecae79Sdrh ** In other words, if a subsequent malloc (ex: "b") worked, it is assumed
629ddecae79Sdrh ** that all prior mallocs (ex: "a") worked too.
630575fad65Sdrh **
631575fad65Sdrh ** The sqlite3MallocRawNN() variant guarantees that the "db" parameter is
632575fad65Sdrh ** not a NULL pointer.
63317435752Sdrh */
634da4ca9d1Sdrh void *sqlite3DbMallocRaw(sqlite3 *db, u64 n){
635575fad65Sdrh   void *p;
636575fad65Sdrh   if( db ) return sqlite3DbMallocRawNN(db, n);
637575fad65Sdrh   p = sqlite3Malloc(n);
638575fad65Sdrh   sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
639575fad65Sdrh   return p;
640575fad65Sdrh }
641575fad65Sdrh void *sqlite3DbMallocRawNN(sqlite3 *db, u64 n){
642f5818aa5Sdrh #ifndef SQLITE_OMIT_LOOKASIDE
643f5818aa5Sdrh   LookasideSlot *pBuf;
644575fad65Sdrh   assert( db!=0 );
645575fad65Sdrh   assert( sqlite3_mutex_held(db->mutex) );
646575fad65Sdrh   assert( db->pnBytesFreed==0 );
6474a642b60Sdrh   if( db->lookaside.bDisable==0 ){
6484a642b60Sdrh     assert( db->mallocFailed==0 );
6490b12e7f8Sdrh     if( n>db->lookaside.sz ){
6500b12e7f8Sdrh       db->lookaside.anStat[1]++;
6510b12e7f8Sdrh     }else if( (pBuf = db->lookaside.pFree)==0 ){
6520b12e7f8Sdrh       db->lookaside.anStat[2]++;
6530b12e7f8Sdrh     }else{
654633e6d57Sdrh       db->lookaside.pFree = pBuf->pNext;
655633e6d57Sdrh       db->lookaside.nOut++;
6560b12e7f8Sdrh       db->lookaside.anStat[0]++;
657633e6d57Sdrh       if( db->lookaside.nOut>db->lookaside.mxOut ){
658633e6d57Sdrh         db->lookaside.mxOut = db->lookaside.nOut;
659633e6d57Sdrh       }
660633e6d57Sdrh       return (void*)pBuf;
661633e6d57Sdrh     }
6624a642b60Sdrh   }else if( db->mallocFailed ){
6634a642b60Sdrh     return 0;
664633e6d57Sdrh   }
665ddecae79Sdrh #else
666f5818aa5Sdrh   assert( db!=0 );
667f5818aa5Sdrh   assert( sqlite3_mutex_held(db->mutex) );
668f5818aa5Sdrh   assert( db->pnBytesFreed==0 );
669575fad65Sdrh   if( db->mallocFailed ){
670ddecae79Sdrh     return 0;
671ddecae79Sdrh   }
6724150ebf8Sdrh #endif
6731da26a48Sdrh   return dbMallocRawFinish(db, n);
6741da26a48Sdrh }
67517435752Sdrh 
676b84e574cSdrh /* Forward declaration */
677b84e574cSdrh static SQLITE_NOINLINE void *dbReallocFinish(sqlite3 *db, void *p, u64 n);
678b84e574cSdrh 
67926783a58Sdanielk1977 /*
68026783a58Sdanielk1977 ** Resize the block of memory pointed to by p to n bytes. If the
68126783a58Sdanielk1977 ** resize fails, set the mallocFailed flag in the connection object.
68226783a58Sdanielk1977 */
683da4ca9d1Sdrh void *sqlite3DbRealloc(sqlite3 *db, void *p, u64 n){
684b84e574cSdrh   assert( db!=0 );
685575fad65Sdrh   if( p==0 ) return sqlite3DbMallocRawNN(db, n);
686b84e574cSdrh   assert( sqlite3_mutex_held(db->mutex) );
687b84e574cSdrh   if( isLookaside(db,p) && n<=db->lookaside.sz ) return p;
688b84e574cSdrh   return dbReallocFinish(db, p, n);
689b84e574cSdrh }
690b84e574cSdrh static SQLITE_NOINLINE void *dbReallocFinish(sqlite3 *db, void *p, u64 n){
691a1644fd8Sdanielk1977   void *pNew = 0;
692d9da78a2Sdrh   assert( db!=0 );
693b84e574cSdrh   assert( p!=0 );
694a1644fd8Sdanielk1977   if( db->mallocFailed==0 ){
695633e6d57Sdrh     if( isLookaside(db, p) ){
696575fad65Sdrh       pNew = sqlite3DbMallocRawNN(db, n);
697633e6d57Sdrh       if( pNew ){
698633e6d57Sdrh         memcpy(pNew, p, db->lookaside.sz);
699633e6d57Sdrh         sqlite3DbFree(db, p);
700633e6d57Sdrh       }
701633e6d57Sdrh     }else{
702d231aa3aSdrh       assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
703d425864dSmistachkin       assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
704107b56e8Sdrh       sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
7053329a63aSdrh       pNew = sqlite3_realloc64(p, n);
706a1644fd8Sdanielk1977       if( !pNew ){
7074a642b60Sdrh         sqlite3OomFault(db);
708a1644fd8Sdanielk1977       }
709d231aa3aSdrh       sqlite3MemdebugSetType(pNew,
7104a642b60Sdrh             (db->lookaside.bDisable==0 ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP));
711a1644fd8Sdanielk1977     }
712633e6d57Sdrh   }
713a1644fd8Sdanielk1977   return pNew;
714a1644fd8Sdanielk1977 }
715a1644fd8Sdanielk1977 
71617435752Sdrh /*
71717435752Sdrh ** Attempt to reallocate p.  If the reallocation fails, then free p
71817435752Sdrh ** and set the mallocFailed flag in the database connection.
71917435752Sdrh */
720da4ca9d1Sdrh void *sqlite3DbReallocOrFree(sqlite3 *db, void *p, u64 n){
721a3152895Sdrh   void *pNew;
722a1644fd8Sdanielk1977   pNew = sqlite3DbRealloc(db, p, n);
723a3152895Sdrh   if( !pNew ){
724633e6d57Sdrh     sqlite3DbFree(db, p);
725a3152895Sdrh   }
726a3152895Sdrh   return pNew;
727a3152895Sdrh }
728a3152895Sdrh 
729a3152895Sdrh /*
730a3152895Sdrh ** Make a copy of a string in memory obtained from sqliteMalloc(). These
731a3152895Sdrh ** functions call sqlite3MallocRaw() directly instead of sqliteMalloc(). This
732a3152895Sdrh ** is because when memory debugging is turned on, these two functions are
733a3152895Sdrh ** called via macros that record the current file and line number in the
734a3152895Sdrh ** ThreadData structure.
735a3152895Sdrh */
736633e6d57Sdrh char *sqlite3DbStrDup(sqlite3 *db, const char *z){
737a3152895Sdrh   char *zNew;
738633e6d57Sdrh   size_t n;
739633e6d57Sdrh   if( z==0 ){
740633e6d57Sdrh     return 0;
741a3152895Sdrh   }
742cee11adaSdrh   n = strlen(z) + 1;
743cee11adaSdrh   zNew = sqlite3DbMallocRaw(db, n);
744a3152895Sdrh   if( zNew ){
745a3152895Sdrh     memcpy(zNew, z, n);
7461e536953Sdanielk1977   }
7471e536953Sdanielk1977   return zNew;
7481e536953Sdanielk1977 }
749da4ca9d1Sdrh char *sqlite3DbStrNDup(sqlite3 *db, const char *z, u64 n){
750633e6d57Sdrh   char *zNew;
751575fad65Sdrh   assert( db!=0 );
752633e6d57Sdrh   if( z==0 ){
753633e6d57Sdrh     return 0;
754633e6d57Sdrh   }
755633e6d57Sdrh   assert( (n&0x7fffffff)==n );
756575fad65Sdrh   zNew = sqlite3DbMallocRawNN(db, n+1);
757633e6d57Sdrh   if( zNew ){
75820f3df04Sdrh     memcpy(zNew, z, (size_t)n);
759633e6d57Sdrh     zNew[n] = 0;
7601e536953Sdanielk1977   }
7611e536953Sdanielk1977   return zNew;
7621e536953Sdanielk1977 }
7631e536953Sdanielk1977 
764a3152895Sdrh /*
76522c17b8bSdrh ** Free any prior content in *pz and replace it with a copy of zNew.
766a3152895Sdrh */
76722c17b8bSdrh void sqlite3SetString(char **pz, sqlite3 *db, const char *zNew){
768633e6d57Sdrh   sqlite3DbFree(db, *pz);
76922c17b8bSdrh   *pz = sqlite3DbStrDup(db, zNew);
770a3152895Sdrh }
771a3152895Sdrh 
772b50c65d5Sdrh /*
7734a642b60Sdrh ** Call this routine to record the fact that an OOM (out-of-memory) error
7744a642b60Sdrh ** has happened.  This routine will set db->mallocFailed, and also
7754a642b60Sdrh ** temporarily disable the lookaside memory allocator and interrupt
7764a642b60Sdrh ** any running VDBEs.
7774a642b60Sdrh */
7784a642b60Sdrh void sqlite3OomFault(sqlite3 *db){
7794a642b60Sdrh   if( db->mallocFailed==0 && db->bBenignMalloc==0 ){
7804a642b60Sdrh     db->mallocFailed = 1;
7814a642b60Sdrh     if( db->nVdbeExec>0 ){
7824a642b60Sdrh       db->u1.isInterrupted = 1;
7834a642b60Sdrh     }
7844a642b60Sdrh     db->lookaside.bDisable++;
7854a642b60Sdrh   }
7864a642b60Sdrh }
7874a642b60Sdrh 
7884a642b60Sdrh /*
7894a642b60Sdrh ** This routine reactivates the memory allocator and clears the
7904a642b60Sdrh ** db->mallocFailed flag as necessary.
7914a642b60Sdrh **
7924a642b60Sdrh ** The memory allocator is not restarted if there are running
7934a642b60Sdrh ** VDBEs.
7944a642b60Sdrh */
7954a642b60Sdrh void sqlite3OomClear(sqlite3 *db){
7964a642b60Sdrh   if( db->mallocFailed && db->nVdbeExec==0 ){
7974a642b60Sdrh     db->mallocFailed = 0;
7984a642b60Sdrh     db->u1.isInterrupted = 0;
7994a642b60Sdrh     assert( db->lookaside.bDisable>0 );
8004a642b60Sdrh     db->lookaside.bDisable--;
8014a642b60Sdrh   }
8024a642b60Sdrh }
8034a642b60Sdrh 
8044a642b60Sdrh /*
805b50c65d5Sdrh ** Take actions at the end of an API call to indicate an OOM error
806b50c65d5Sdrh */
807b50c65d5Sdrh static SQLITE_NOINLINE int apiOomError(sqlite3 *db){
8084a642b60Sdrh   sqlite3OomClear(db);
809b50c65d5Sdrh   sqlite3Error(db, SQLITE_NOMEM);
810fad3039cSmistachkin   return SQLITE_NOMEM_BKPT;
811b50c65d5Sdrh }
812a3152895Sdrh 
813a3152895Sdrh /*
814a3152895Sdrh ** This function must be called before exiting any API function (i.e.
81517435752Sdrh ** returning control to the user) that has called sqlite3_malloc or
81617435752Sdrh ** sqlite3_realloc.
817a3152895Sdrh **
818a3152895Sdrh ** The returned value is normally a copy of the second argument to this
819be217793Sshane ** function. However, if a malloc() failure has occurred since the previous
820a3152895Sdrh ** invocation SQLITE_NOMEM is returned instead.
821a3152895Sdrh **
822597d2b64Sdrh ** If an OOM as occurred, then the connection error-code (the value
823597d2b64Sdrh ** returned by sqlite3_errcode()) is set to SQLITE_NOMEM.
824a3152895Sdrh */
825a3152895Sdrh int sqlite3ApiExit(sqlite3* db, int rc){
826597d2b64Sdrh   /* If the db handle must hold the connection handle mutex here.
827597d2b64Sdrh   ** Otherwise the read (and possible write) of db->mallocFailed
828a1644fd8Sdanielk1977   ** is unsafe, as is the call to sqlite3Error().
829a1644fd8Sdanielk1977   */
830597d2b64Sdrh   assert( db!=0 );
831597d2b64Sdrh   assert( sqlite3_mutex_held(db->mutex) );
832b50c65d5Sdrh   if( db->mallocFailed || rc==SQLITE_IOERR_NOMEM ){
833b50c65d5Sdrh     return apiOomError(db);
834a3152895Sdrh   }
835b50c65d5Sdrh   return rc & db->errMask;
836a3152895Sdrh }
837