xref: /sqlite-3.40.0/src/malloc.c (revision e64ca7ba)
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 **
15*e64ca7baSdrh ** $Id: malloc.c,v 1.65 2009/07/16 18:21:18 drh Exp $
16a3152895Sdrh */
17a3152895Sdrh #include "sqliteInt.h"
18a3152895Sdrh #include <stdarg.h>
19a3152895Sdrh 
20a3152895Sdrh /*
21b21c8cd4Sdrh ** This routine runs when the memory allocator sees that the
22b21c8cd4Sdrh ** total memory allocation is about to exceed the soft heap
23b21c8cd4Sdrh ** limit.
24b21c8cd4Sdrh */
25b21c8cd4Sdrh static void softHeapLimitEnforcer(
26b21c8cd4Sdrh   void *NotUsed,
2762c14b34Sdanielk1977   sqlite3_int64 NotUsed2,
28153c62c4Sdrh   int allocSize
29b21c8cd4Sdrh ){
3062c14b34Sdanielk1977   UNUSED_PARAMETER2(NotUsed, NotUsed2);
31b21c8cd4Sdrh   sqlite3_release_memory(allocSize);
32b21c8cd4Sdrh }
33b21c8cd4Sdrh 
34b21c8cd4Sdrh /*
358468024dSdanielk1977 ** Set the soft heap-size limit for the library. Passing a zero or
368468024dSdanielk1977 ** negative value indicates no limit.
37a3152895Sdrh */
38a3152895Sdrh void sqlite3_soft_heap_limit(int n){
39b21c8cd4Sdrh   sqlite3_uint64 iLimit;
40b21c8cd4Sdrh   int overage;
41b21c8cd4Sdrh   if( n<0 ){
42b21c8cd4Sdrh     iLimit = 0;
43b21c8cd4Sdrh   }else{
44b21c8cd4Sdrh     iLimit = n;
45a3152895Sdrh   }
469ac3fe97Sdrh   sqlite3_initialize();
47b21c8cd4Sdrh   if( iLimit>0 ){
484a27a286Sshane     sqlite3MemoryAlarm(softHeapLimitEnforcer, 0, iLimit);
49b21c8cd4Sdrh   }else{
504a27a286Sshane     sqlite3MemoryAlarm(0, 0, 0);
51b21c8cd4Sdrh   }
521bd10f8aSdrh   overage = (int)(sqlite3_memory_used() - (i64)n);
53b21c8cd4Sdrh   if( overage>0 ){
54b21c8cd4Sdrh     sqlite3_release_memory(overage);
55b21c8cd4Sdrh   }
56a3152895Sdrh }
57a3152895Sdrh 
58a3152895Sdrh /*
598468024dSdanielk1977 ** Attempt to release up to n bytes of non-essential memory currently
608468024dSdanielk1977 ** held by SQLite. An example of non-essential memory is memory used to
618468024dSdanielk1977 ** cache database pages that are not currently in use.
62a3152895Sdrh */
63a3152895Sdrh int sqlite3_release_memory(int n){
6486f8c197Sdrh #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
6567e3da7aSdanielk1977   int nRet = 0;
6667e3da7aSdanielk1977 #if 0
6767e3da7aSdanielk1977   nRet += sqlite3VdbeReleaseMemory(n);
6867e3da7aSdanielk1977 #endif
6967e3da7aSdanielk1977   nRet += sqlite3PcacheReleaseMemory(n-nRet);
70dfb316d4Sdanielk1977   return nRet;
711e536953Sdanielk1977 #else
7262c14b34Sdanielk1977   UNUSED_PARAMETER(n);
731e536953Sdanielk1977   return SQLITE_OK;
741e536953Sdanielk1977 #endif
75a3152895Sdrh }
76a3152895Sdrh 
77fec00eabSdrh /*
78fec00eabSdrh ** State information local to the memory allocation subsystem.
79fec00eabSdrh */
805c8f8587Sdanielk1977 static SQLITE_WSD struct Mem0Global {
8123bf0f41Sdanielk1977   /* Number of free pages for scratch and page-cache memory */
8223bf0f41Sdanielk1977   u32 nScratchFree;
8323bf0f41Sdanielk1977   u32 nPageFree;
8423bf0f41Sdanielk1977 
85fec00eabSdrh   sqlite3_mutex *mutex;         /* Mutex to serialize access */
86fec00eabSdrh 
87fec00eabSdrh   /*
88fec00eabSdrh   ** The alarm callback and its arguments.  The mem0.mutex lock will
89fec00eabSdrh   ** be held while the callback is running.  Recursive calls into
90fec00eabSdrh   ** the memory subsystem are allowed, but no new callbacks will be
91*e64ca7baSdrh   ** issued.
92fec00eabSdrh   */
93fec00eabSdrh   sqlite3_int64 alarmThreshold;
94fec00eabSdrh   void (*alarmCallback)(void*, sqlite3_int64,int);
95fec00eabSdrh   void *alarmArg;
96fec00eabSdrh 
97fec00eabSdrh   /*
98075c23afSdanielk1977   ** Pointers to the end of sqlite3GlobalConfig.pScratch and
99075c23afSdanielk1977   ** sqlite3GlobalConfig.pPage to a block of memory that records
1009ac3fe97Sdrh   ** which pages are available.
1019ac3fe97Sdrh   */
1029ac3fe97Sdrh   u32 *aScratchFree;
1039ac3fe97Sdrh   u32 *aPageFree;
104*e64ca7baSdrh } mem0 = { 0, 0, 0, 0, 0, 0, 0, 0 };
1055c8f8587Sdanielk1977 
1065c8f8587Sdanielk1977 #define mem0 GLOBAL(struct Mem0Global, mem0)
107fec00eabSdrh 
108fec00eabSdrh /*
109fec00eabSdrh ** Initialize the memory allocation subsystem.
110fec00eabSdrh */
111fec00eabSdrh int sqlite3MallocInit(void){
112075c23afSdanielk1977   if( sqlite3GlobalConfig.m.xMalloc==0 ){
113fec00eabSdrh     sqlite3MemSetDefault();
114fec00eabSdrh   }
115fec00eabSdrh   memset(&mem0, 0, sizeof(mem0));
116075c23afSdanielk1977   if( sqlite3GlobalConfig.bCoreMutex ){
11759f8c08eSdanielk1977     mem0.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
118fec00eabSdrh   }
119075c23afSdanielk1977   if( sqlite3GlobalConfig.pScratch && sqlite3GlobalConfig.szScratch>=100
120075c23afSdanielk1977       && sqlite3GlobalConfig.nScratch>=0 ){
1219ac3fe97Sdrh     int i;
122bc73971dSdanielk1977     sqlite3GlobalConfig.szScratch = ROUNDDOWN8(sqlite3GlobalConfig.szScratch-4);
123075c23afSdanielk1977     mem0.aScratchFree = (u32*)&((char*)sqlite3GlobalConfig.pScratch)
124075c23afSdanielk1977                   [sqlite3GlobalConfig.szScratch*sqlite3GlobalConfig.nScratch];
125075c23afSdanielk1977     for(i=0; i<sqlite3GlobalConfig.nScratch; i++){ mem0.aScratchFree[i] = i; }
126075c23afSdanielk1977     mem0.nScratchFree = sqlite3GlobalConfig.nScratch;
1279ac3fe97Sdrh   }else{
128075c23afSdanielk1977     sqlite3GlobalConfig.pScratch = 0;
129075c23afSdanielk1977     sqlite3GlobalConfig.szScratch = 0;
1309ac3fe97Sdrh   }
131075c23afSdanielk1977   if( sqlite3GlobalConfig.pPage && sqlite3GlobalConfig.szPage>=512
132075c23afSdanielk1977       && sqlite3GlobalConfig.nPage>=1 ){
1339ac3fe97Sdrh     int i;
1340a60a384Sdrh     int overhead;
135bc73971dSdanielk1977     int sz = ROUNDDOWN8(sqlite3GlobalConfig.szPage);
136075c23afSdanielk1977     int n = sqlite3GlobalConfig.nPage;
1370a60a384Sdrh     overhead = (4*n + sz - 1)/sz;
138075c23afSdanielk1977     sqlite3GlobalConfig.nPage -= overhead;
139075c23afSdanielk1977     mem0.aPageFree = (u32*)&((char*)sqlite3GlobalConfig.pPage)
140075c23afSdanielk1977                   [sqlite3GlobalConfig.szPage*sqlite3GlobalConfig.nPage];
141075c23afSdanielk1977     for(i=0; i<sqlite3GlobalConfig.nPage; i++){ mem0.aPageFree[i] = i; }
142075c23afSdanielk1977     mem0.nPageFree = sqlite3GlobalConfig.nPage;
1439ac3fe97Sdrh   }else{
144075c23afSdanielk1977     sqlite3GlobalConfig.pPage = 0;
145075c23afSdanielk1977     sqlite3GlobalConfig.szPage = 0;
1469ac3fe97Sdrh   }
147075c23afSdanielk1977   return sqlite3GlobalConfig.m.xInit(sqlite3GlobalConfig.m.pAppData);
148fec00eabSdrh }
149fec00eabSdrh 
150fec00eabSdrh /*
151fec00eabSdrh ** Deinitialize the memory allocation subsystem.
152fec00eabSdrh */
153fec00eabSdrh void sqlite3MallocEnd(void){
1540a549071Sdanielk1977   if( sqlite3GlobalConfig.m.xShutdown ){
155075c23afSdanielk1977     sqlite3GlobalConfig.m.xShutdown(sqlite3GlobalConfig.m.pAppData);
1560a549071Sdanielk1977   }
1579ac3fe97Sdrh   memset(&mem0, 0, sizeof(mem0));
158fec00eabSdrh }
159fec00eabSdrh 
160fec00eabSdrh /*
161fec00eabSdrh ** Return the amount of memory currently checked out.
162fec00eabSdrh */
163fec00eabSdrh sqlite3_int64 sqlite3_memory_used(void){
164f7141990Sdrh   int n, mx;
165c376a198Sdrh   sqlite3_int64 res;
166f7141990Sdrh   sqlite3_status(SQLITE_STATUS_MEMORY_USED, &n, &mx, 0);
167c376a198Sdrh   res = (sqlite3_int64)n;  /* Work around bug in Borland C. Ticket #3216 */
168c376a198Sdrh   return res;
169fec00eabSdrh }
170fec00eabSdrh 
171fec00eabSdrh /*
172fec00eabSdrh ** Return the maximum amount of memory that has ever been
173fec00eabSdrh ** checked out since either the beginning of this process
174fec00eabSdrh ** or since the most recent reset.
175fec00eabSdrh */
176fec00eabSdrh sqlite3_int64 sqlite3_memory_highwater(int resetFlag){
177f7141990Sdrh   int n, mx;
178c376a198Sdrh   sqlite3_int64 res;
179f7141990Sdrh   sqlite3_status(SQLITE_STATUS_MEMORY_USED, &n, &mx, resetFlag);
1807986a71aSdrh   res = (sqlite3_int64)mx;  /* Work around bug in Borland C. Ticket #3216 */
181c376a198Sdrh   return res;
182fec00eabSdrh }
183fec00eabSdrh 
184fec00eabSdrh /*
185fec00eabSdrh ** Change the alarm callback
186fec00eabSdrh */
1874a27a286Sshane int sqlite3MemoryAlarm(
188fec00eabSdrh   void(*xCallback)(void *pArg, sqlite3_int64 used,int N),
189fec00eabSdrh   void *pArg,
190fec00eabSdrh   sqlite3_int64 iThreshold
191fec00eabSdrh ){
192fec00eabSdrh   sqlite3_mutex_enter(mem0.mutex);
193fec00eabSdrh   mem0.alarmCallback = xCallback;
194fec00eabSdrh   mem0.alarmArg = pArg;
195fec00eabSdrh   mem0.alarmThreshold = iThreshold;
196fec00eabSdrh   sqlite3_mutex_leave(mem0.mutex);
197fec00eabSdrh   return SQLITE_OK;
198fec00eabSdrh }
199fec00eabSdrh 
200eec556d3Sshane #ifndef SQLITE_OMIT_DEPRECATED
201fec00eabSdrh /*
2024a27a286Sshane ** Deprecated external interface.  Internal/core SQLite code
2034a27a286Sshane ** should call sqlite3MemoryAlarm.
2044a27a286Sshane */
2054a27a286Sshane int sqlite3_memory_alarm(
2064a27a286Sshane   void(*xCallback)(void *pArg, sqlite3_int64 used,int N),
2074a27a286Sshane   void *pArg,
2084a27a286Sshane   sqlite3_int64 iThreshold
2094a27a286Sshane ){
2104a27a286Sshane   return sqlite3MemoryAlarm(xCallback, pArg, iThreshold);
2114a27a286Sshane }
212eec556d3Sshane #endif
2134a27a286Sshane 
2144a27a286Sshane /*
215fec00eabSdrh ** Trigger the alarm
216fec00eabSdrh */
217fec00eabSdrh static void sqlite3MallocAlarm(int nByte){
218fec00eabSdrh   void (*xCallback)(void*,sqlite3_int64,int);
219fec00eabSdrh   sqlite3_int64 nowUsed;
220fec00eabSdrh   void *pArg;
221*e64ca7baSdrh   if( mem0.alarmCallback==0 ) return;
222fec00eabSdrh   xCallback = mem0.alarmCallback;
223f7141990Sdrh   nowUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
224fec00eabSdrh   pArg = mem0.alarmArg;
225*e64ca7baSdrh   mem0.alarmCallback = 0;
226fec00eabSdrh   sqlite3_mutex_leave(mem0.mutex);
227fec00eabSdrh   xCallback(pArg, nowUsed, nByte);
228fec00eabSdrh   sqlite3_mutex_enter(mem0.mutex);
229*e64ca7baSdrh   mem0.alarmCallback = xCallback;
230*e64ca7baSdrh   mem0.alarmArg = pArg;
231fec00eabSdrh }
232fec00eabSdrh 
233fec00eabSdrh /*
234f7141990Sdrh ** Do a memory allocation with statistics and alarms.  Assume the
235f7141990Sdrh ** lock is already held.
236fec00eabSdrh */
237f7141990Sdrh static int mallocWithAlarm(int n, void **pp){
238fec00eabSdrh   int nFull;
239f7141990Sdrh   void *p;
240f7141990Sdrh   assert( sqlite3_mutex_held(mem0.mutex) );
241075c23afSdanielk1977   nFull = sqlite3GlobalConfig.m.xRoundup(n);
242f7141990Sdrh   sqlite3StatusSet(SQLITE_STATUS_MALLOC_SIZE, n);
243f7141990Sdrh   if( mem0.alarmCallback!=0 ){
244f7141990Sdrh     int nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
245f7141990Sdrh     if( nUsed+nFull >= mem0.alarmThreshold ){
246fec00eabSdrh       sqlite3MallocAlarm(nFull);
247fec00eabSdrh     }
248f7141990Sdrh   }
249075c23afSdanielk1977   p = sqlite3GlobalConfig.m.xMalloc(nFull);
250d09414cdSdanielk1977   if( p==0 && mem0.alarmCallback ){
251fec00eabSdrh     sqlite3MallocAlarm(nFull);
252075c23afSdanielk1977     p = sqlite3GlobalConfig.m.xMalloc(nFull);
253fec00eabSdrh   }
254c702c7ccSdrh   if( p ){
255c702c7ccSdrh     nFull = sqlite3MallocSize(p);
256c702c7ccSdrh     sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, nFull);
257c702c7ccSdrh   }
258f7141990Sdrh   *pp = p;
259f7141990Sdrh   return nFull;
260fec00eabSdrh }
261f7141990Sdrh 
262f7141990Sdrh /*
263f7141990Sdrh ** Allocate memory.  This routine is like sqlite3_malloc() except that it
264f7141990Sdrh ** assumes the memory subsystem has already been initialized.
265f7141990Sdrh */
266f7141990Sdrh void *sqlite3Malloc(int n){
267f7141990Sdrh   void *p;
268e08ed7e7Sdrh   if( n<=0 || n>=0x7fffff00 ){
269e08ed7e7Sdrh     /* A memory allocation of a number of bytes which is near the maximum
270e08ed7e7Sdrh     ** signed integer value might cause an integer overflow inside of the
271e08ed7e7Sdrh     ** xMalloc().  Hence we limit the maximum size to 0x7fffff00, giving
272e08ed7e7Sdrh     ** 255 bytes of overhead.  SQLite itself will never use anything near
273e08ed7e7Sdrh     ** this amount.  The only way to reach the limit is with sqlite3_malloc() */
274f7141990Sdrh     p = 0;
275075c23afSdanielk1977   }else if( sqlite3GlobalConfig.bMemstat ){
276f7141990Sdrh     sqlite3_mutex_enter(mem0.mutex);
277f7141990Sdrh     mallocWithAlarm(n, &p);
278fec00eabSdrh     sqlite3_mutex_leave(mem0.mutex);
279fec00eabSdrh   }else{
280075c23afSdanielk1977     p = sqlite3GlobalConfig.m.xMalloc(n);
281fec00eabSdrh   }
282fec00eabSdrh   return p;
283fec00eabSdrh }
284fec00eabSdrh 
285fec00eabSdrh /*
286fec00eabSdrh ** This version of the memory allocation is for use by the application.
287fec00eabSdrh ** First make sure the memory subsystem is initialized, then do the
288fec00eabSdrh ** allocation.
289fec00eabSdrh */
290fec00eabSdrh void *sqlite3_malloc(int n){
291fec00eabSdrh #ifndef SQLITE_OMIT_AUTOINIT
292fec00eabSdrh   if( sqlite3_initialize() ) return 0;
293fec00eabSdrh #endif
294fec00eabSdrh   return sqlite3Malloc(n);
295fec00eabSdrh }
296fec00eabSdrh 
297fec00eabSdrh /*
298e5ae5735Sdrh ** Each thread may only have a single outstanding allocation from
299facf0307Sdrh ** xScratchMalloc().  We verify this constraint in the single-threaded
300facf0307Sdrh ** case by setting scratchAllocOut to 1 when an allocation
301e5ae5735Sdrh ** is outstanding clearing it when the allocation is freed.
302e5ae5735Sdrh */
303e5ae5735Sdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
304facf0307Sdrh static int scratchAllocOut = 0;
305e5ae5735Sdrh #endif
306e5ae5735Sdrh 
307e5ae5735Sdrh 
308e5ae5735Sdrh /*
309e5ae5735Sdrh ** Allocate memory that is to be used and released right away.
310e5ae5735Sdrh ** This routine is similar to alloca() in that it is not intended
311e5ae5735Sdrh ** for situations where the memory might be held long-term.  This
312e5ae5735Sdrh ** routine is intended to get memory to old large transient data
313e5ae5735Sdrh ** structures that would not normally fit on the stack of an
314e5ae5735Sdrh ** embedded processor.
315e5ae5735Sdrh */
316facf0307Sdrh void *sqlite3ScratchMalloc(int n){
317e5ae5735Sdrh   void *p;
318e5ae5735Sdrh   assert( n>0 );
3199ac3fe97Sdrh 
320e5ae5735Sdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
3219ac3fe97Sdrh   /* Verify that no more than one scratch allocation per thread
3229ac3fe97Sdrh   ** is outstanding at one time.  (This is only checked in the
3239ac3fe97Sdrh   ** single-threaded case since checking in the multi-threaded case
3249ac3fe97Sdrh   ** would be much more complicated.) */
325facf0307Sdrh   assert( scratchAllocOut==0 );
326e5ae5735Sdrh #endif
3279ac3fe97Sdrh 
328075c23afSdanielk1977   if( sqlite3GlobalConfig.szScratch<n ){
329f7141990Sdrh     goto scratch_overflow;
330f7141990Sdrh   }else{
331e5ae5735Sdrh     sqlite3_mutex_enter(mem0.mutex);
332f7141990Sdrh     if( mem0.nScratchFree==0 ){
333f7141990Sdrh       sqlite3_mutex_leave(mem0.mutex);
334f7141990Sdrh       goto scratch_overflow;
335e5ae5735Sdrh     }else{
3369ac3fe97Sdrh       int i;
3379ac3fe97Sdrh       i = mem0.aScratchFree[--mem0.nScratchFree];
338075c23afSdanielk1977       i *= sqlite3GlobalConfig.szScratch;
339f7141990Sdrh       sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_USED, 1);
340e50135e2Sdrh       sqlite3StatusSet(SQLITE_STATUS_SCRATCH_SIZE, n);
3418183e339Sdanielk1977       sqlite3_mutex_leave(mem0.mutex);
342075c23afSdanielk1977       p = (void*)&((char*)sqlite3GlobalConfig.pScratch)[i];
34315301596Sshane       assert(  (((u8*)p - (u8*)0) & 7)==0 );
344e5ae5735Sdrh     }
345f7141990Sdrh   }
346f7141990Sdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
347f7141990Sdrh   scratchAllocOut = p!=0;
348f7141990Sdrh #endif
349f7141990Sdrh 
350f7141990Sdrh   return p;
351f7141990Sdrh 
352f7141990Sdrh scratch_overflow:
353075c23afSdanielk1977   if( sqlite3GlobalConfig.bMemstat ){
354f7141990Sdrh     sqlite3_mutex_enter(mem0.mutex);
355e50135e2Sdrh     sqlite3StatusSet(SQLITE_STATUS_SCRATCH_SIZE, n);
356f7141990Sdrh     n = mallocWithAlarm(n, &p);
357f7141990Sdrh     if( p ) sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_OVERFLOW, n);
3589ac3fe97Sdrh     sqlite3_mutex_leave(mem0.mutex);
359f7141990Sdrh   }else{
360075c23afSdanielk1977     p = sqlite3GlobalConfig.m.xMalloc(n);
361f7141990Sdrh   }
362f7141990Sdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
363f7141990Sdrh   scratchAllocOut = p!=0;
364f7141990Sdrh #endif
365e5ae5735Sdrh   return p;
366e5ae5735Sdrh }
367facf0307Sdrh void sqlite3ScratchFree(void *p){
368e5ae5735Sdrh   if( p ){
3699ac3fe97Sdrh 
370e5ae5735Sdrh #if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
3719ac3fe97Sdrh     /* Verify that no more than one scratch allocation per thread
3729ac3fe97Sdrh     ** is outstanding at one time.  (This is only checked in the
3739ac3fe97Sdrh     ** single-threaded case since checking in the multi-threaded case
3749ac3fe97Sdrh     ** would be much more complicated.) */
375facf0307Sdrh     assert( scratchAllocOut==1 );
376facf0307Sdrh     scratchAllocOut = 0;
377e5ae5735Sdrh #endif
3789ac3fe97Sdrh 
379075c23afSdanielk1977     if( sqlite3GlobalConfig.pScratch==0
380075c23afSdanielk1977            || p<sqlite3GlobalConfig.pScratch
3819ac3fe97Sdrh            || p>=(void*)mem0.aScratchFree ){
382075c23afSdanielk1977       if( sqlite3GlobalConfig.bMemstat ){
383f7141990Sdrh         int iSize = sqlite3MallocSize(p);
384f7141990Sdrh         sqlite3_mutex_enter(mem0.mutex);
385f7141990Sdrh         sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_OVERFLOW, -iSize);
386f7141990Sdrh         sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, -iSize);
387075c23afSdanielk1977         sqlite3GlobalConfig.m.xFree(p);
388f7141990Sdrh         sqlite3_mutex_leave(mem0.mutex);
389f7141990Sdrh       }else{
390075c23afSdanielk1977         sqlite3GlobalConfig.m.xFree(p);
391f7141990Sdrh       }
3929ac3fe97Sdrh     }else{
3939ac3fe97Sdrh       int i;
3941bd10f8aSdrh       i = (int)((u8*)p - (u8*)sqlite3GlobalConfig.pScratch);
395075c23afSdanielk1977       i /= sqlite3GlobalConfig.szScratch;
396075c23afSdanielk1977       assert( i>=0 && i<sqlite3GlobalConfig.nScratch );
397f7141990Sdrh       sqlite3_mutex_enter(mem0.mutex);
39800e13613Sdanielk1977       assert( mem0.nScratchFree<(u32)sqlite3GlobalConfig.nScratch );
3999ac3fe97Sdrh       mem0.aScratchFree[mem0.nScratchFree++] = i;
400f7141990Sdrh       sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_USED, -1);
4019ac3fe97Sdrh       sqlite3_mutex_leave(mem0.mutex);
4029ac3fe97Sdrh     }
403e5ae5735Sdrh   }
404e5ae5735Sdrh }
405e5ae5735Sdrh 
406e5ae5735Sdrh /*
407633e6d57Sdrh ** TRUE if p is a lookaside memory allocation from db
408633e6d57Sdrh */
4094150ebf8Sdrh #ifndef SQLITE_OMIT_LOOKASIDE
410633e6d57Sdrh static int isLookaside(sqlite3 *db, void *p){
411633e6d57Sdrh   return db && p && p>=db->lookaside.pStart && p<db->lookaside.pEnd;
412633e6d57Sdrh }
4134150ebf8Sdrh #else
4144150ebf8Sdrh #define isLookaside(A,B) 0
4154150ebf8Sdrh #endif
416633e6d57Sdrh 
417633e6d57Sdrh /*
418fec00eabSdrh ** Return the size of a memory allocation previously obtained from
419fec00eabSdrh ** sqlite3Malloc() or sqlite3_malloc().
420fec00eabSdrh */
421fec00eabSdrh int sqlite3MallocSize(void *p){
422075c23afSdanielk1977   return sqlite3GlobalConfig.m.xSize(p);
423fec00eabSdrh }
424633e6d57Sdrh int sqlite3DbMallocSize(sqlite3 *db, void *p){
4257047e25cSdrh   assert( db==0 || sqlite3_mutex_held(db->mutex) );
4266a1e071fSdrh   if( p==0 ){
4276a1e071fSdrh     return 0;
4286a1e071fSdrh   }else if( isLookaside(db, p) ){
429633e6d57Sdrh     return db->lookaside.sz;
430633e6d57Sdrh   }else{
431075c23afSdanielk1977     return sqlite3GlobalConfig.m.xSize(p);
432633e6d57Sdrh   }
433633e6d57Sdrh }
434fec00eabSdrh 
435fec00eabSdrh /*
436fec00eabSdrh ** Free memory previously obtained from sqlite3Malloc().
437fec00eabSdrh */
438fec00eabSdrh void sqlite3_free(void *p){
439fec00eabSdrh   if( p==0 ) return;
440075c23afSdanielk1977   if( sqlite3GlobalConfig.bMemstat ){
441fec00eabSdrh     sqlite3_mutex_enter(mem0.mutex);
442f7141990Sdrh     sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, -sqlite3MallocSize(p));
443075c23afSdanielk1977     sqlite3GlobalConfig.m.xFree(p);
444fec00eabSdrh     sqlite3_mutex_leave(mem0.mutex);
445fec00eabSdrh   }else{
446075c23afSdanielk1977     sqlite3GlobalConfig.m.xFree(p);
447fec00eabSdrh   }
448fec00eabSdrh }
449fec00eabSdrh 
450fec00eabSdrh /*
451633e6d57Sdrh ** Free memory that might be associated with a particular database
452633e6d57Sdrh ** connection.
453633e6d57Sdrh */
454633e6d57Sdrh void sqlite3DbFree(sqlite3 *db, void *p){
4557047e25cSdrh   assert( db==0 || sqlite3_mutex_held(db->mutex) );
456633e6d57Sdrh   if( isLookaside(db, p) ){
457633e6d57Sdrh     LookasideSlot *pBuf = (LookasideSlot*)p;
458633e6d57Sdrh     pBuf->pNext = db->lookaside.pFree;
459633e6d57Sdrh     db->lookaside.pFree = pBuf;
460633e6d57Sdrh     db->lookaside.nOut--;
461633e6d57Sdrh   }else{
462633e6d57Sdrh     sqlite3_free(p);
463633e6d57Sdrh   }
464633e6d57Sdrh }
465633e6d57Sdrh 
466633e6d57Sdrh /*
467fec00eabSdrh ** Change the size of an existing memory allocation
468fec00eabSdrh */
469fec00eabSdrh void *sqlite3Realloc(void *pOld, int nBytes){
470fec00eabSdrh   int nOld, nNew;
471fec00eabSdrh   void *pNew;
472fec00eabSdrh   if( pOld==0 ){
473fec00eabSdrh     return sqlite3Malloc(nBytes);
474fec00eabSdrh   }
475b6063cf8Sdrh   if( nBytes<=0 ){
476fec00eabSdrh     sqlite3_free(pOld);
477fec00eabSdrh     return 0;
478fec00eabSdrh   }
479b6063cf8Sdrh   if( nBytes>=0x7fffff00 ){
480b6063cf8Sdrh     /* The 0x7ffff00 limit term is explained in comments on sqlite3Malloc() */
481b6063cf8Sdrh     return 0;
482b6063cf8Sdrh   }
483fec00eabSdrh   nOld = sqlite3MallocSize(pOld);
484075c23afSdanielk1977   if( sqlite3GlobalConfig.bMemstat ){
485fec00eabSdrh     sqlite3_mutex_enter(mem0.mutex);
486f7141990Sdrh     sqlite3StatusSet(SQLITE_STATUS_MALLOC_SIZE, nBytes);
487075c23afSdanielk1977     nNew = sqlite3GlobalConfig.m.xRoundup(nBytes);
488fec00eabSdrh     if( nOld==nNew ){
489fec00eabSdrh       pNew = pOld;
490fec00eabSdrh     }else{
491f7141990Sdrh       if( sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED)+nNew-nOld >=
492f7141990Sdrh             mem0.alarmThreshold ){
493fec00eabSdrh         sqlite3MallocAlarm(nNew-nOld);
494fec00eabSdrh       }
495075c23afSdanielk1977       pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
496d09414cdSdanielk1977       if( pNew==0 && mem0.alarmCallback ){
497fec00eabSdrh         sqlite3MallocAlarm(nBytes);
498075c23afSdanielk1977         pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
499fec00eabSdrh       }
500fec00eabSdrh       if( pNew ){
501c702c7ccSdrh         nNew = sqlite3MallocSize(pNew);
502f7141990Sdrh         sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, nNew-nOld);
503fec00eabSdrh       }
504fec00eabSdrh     }
505fec00eabSdrh     sqlite3_mutex_leave(mem0.mutex);
506fec00eabSdrh   }else{
507075c23afSdanielk1977     pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nBytes);
508fec00eabSdrh   }
509fec00eabSdrh   return pNew;
510fec00eabSdrh }
511fec00eabSdrh 
512fec00eabSdrh /*
513fec00eabSdrh ** The public interface to sqlite3Realloc.  Make sure that the memory
514fec00eabSdrh ** subsystem is initialized prior to invoking sqliteRealloc.
515fec00eabSdrh */
516fec00eabSdrh void *sqlite3_realloc(void *pOld, int n){
517fec00eabSdrh #ifndef SQLITE_OMIT_AUTOINIT
518fec00eabSdrh   if( sqlite3_initialize() ) return 0;
519fec00eabSdrh #endif
520fec00eabSdrh   return sqlite3Realloc(pOld, n);
521fec00eabSdrh }
522fec00eabSdrh 
523a3152895Sdrh 
524a3152895Sdrh /*
52517435752Sdrh ** Allocate and zero memory.
526a3152895Sdrh */
527fec00eabSdrh void *sqlite3MallocZero(int n){
528fec00eabSdrh   void *p = sqlite3Malloc(n);
529a3152895Sdrh   if( p ){
530a3152895Sdrh     memset(p, 0, n);
531a3152895Sdrh   }
532a3152895Sdrh   return p;
533a3152895Sdrh }
53417435752Sdrh 
53517435752Sdrh /*
53617435752Sdrh ** Allocate and zero memory.  If the allocation fails, make
53717435752Sdrh ** the mallocFailed flag in the connection pointer.
53817435752Sdrh */
539fec00eabSdrh void *sqlite3DbMallocZero(sqlite3 *db, int n){
540a1644fd8Sdanielk1977   void *p = sqlite3DbMallocRaw(db, n);
54117435752Sdrh   if( p ){
54217435752Sdrh     memset(p, 0, n);
54317435752Sdrh   }
54417435752Sdrh   return p;
54517435752Sdrh }
54617435752Sdrh 
54717435752Sdrh /*
54817435752Sdrh ** Allocate and zero memory.  If the allocation fails, make
54917435752Sdrh ** the mallocFailed flag in the connection pointer.
550ddecae79Sdrh **
551ddecae79Sdrh ** If db!=0 and db->mallocFailed is true (indicating a prior malloc
552ddecae79Sdrh ** failure on the same database connection) then always return 0.
553ddecae79Sdrh ** Hence for a particular database connection, once malloc starts
554ddecae79Sdrh ** failing, it fails consistently until mallocFailed is reset.
555ddecae79Sdrh ** This is an important assumption.  There are many places in the
556ddecae79Sdrh ** code that do things like this:
557ddecae79Sdrh **
558ddecae79Sdrh **         int *a = (int*)sqlite3DbMallocRaw(db, 100);
559ddecae79Sdrh **         int *b = (int*)sqlite3DbMallocRaw(db, 200);
560ddecae79Sdrh **         if( b ) a[10] = 9;
561ddecae79Sdrh **
562ddecae79Sdrh ** In other words, if a subsequent malloc (ex: "b") worked, it is assumed
563ddecae79Sdrh ** that all prior mallocs (ex: "a") worked too.
56417435752Sdrh */
565fec00eabSdrh void *sqlite3DbMallocRaw(sqlite3 *db, int n){
566633e6d57Sdrh   void *p;
567d9da78a2Sdrh   assert( db==0 || sqlite3_mutex_held(db->mutex) );
5684150ebf8Sdrh #ifndef SQLITE_OMIT_LOOKASIDE
569633e6d57Sdrh   if( db ){
570633e6d57Sdrh     LookasideSlot *pBuf;
571633e6d57Sdrh     if( db->mallocFailed ){
572633e6d57Sdrh       return 0;
573633e6d57Sdrh     }
574633e6d57Sdrh     if( db->lookaside.bEnabled && n<=db->lookaside.sz
575633e6d57Sdrh          && (pBuf = db->lookaside.pFree)!=0 ){
576633e6d57Sdrh       db->lookaside.pFree = pBuf->pNext;
577633e6d57Sdrh       db->lookaside.nOut++;
578633e6d57Sdrh       if( db->lookaside.nOut>db->lookaside.mxOut ){
579633e6d57Sdrh         db->lookaside.mxOut = db->lookaside.nOut;
580633e6d57Sdrh       }
581633e6d57Sdrh       return (void*)pBuf;
582633e6d57Sdrh     }
583633e6d57Sdrh   }
584ddecae79Sdrh #else
585ddecae79Sdrh   if( db && db->mallocFailed ){
586ddecae79Sdrh     return 0;
587ddecae79Sdrh   }
5884150ebf8Sdrh #endif
589fec00eabSdrh   p = sqlite3Malloc(n);
590f3a65f7eSdrh   if( !p && db ){
59117435752Sdrh     db->mallocFailed = 1;
59217435752Sdrh   }
59317435752Sdrh   return p;
59417435752Sdrh }
59517435752Sdrh 
59626783a58Sdanielk1977 /*
59726783a58Sdanielk1977 ** Resize the block of memory pointed to by p to n bytes. If the
59826783a58Sdanielk1977 ** resize fails, set the mallocFailed flag in the connection object.
59926783a58Sdanielk1977 */
600a1644fd8Sdanielk1977 void *sqlite3DbRealloc(sqlite3 *db, void *p, int n){
601a1644fd8Sdanielk1977   void *pNew = 0;
602d9da78a2Sdrh   assert( db!=0 );
6037047e25cSdrh   assert( sqlite3_mutex_held(db->mutex) );
604a1644fd8Sdanielk1977   if( db->mallocFailed==0 ){
605633e6d57Sdrh     if( p==0 ){
606633e6d57Sdrh       return sqlite3DbMallocRaw(db, n);
607633e6d57Sdrh     }
608633e6d57Sdrh     if( isLookaside(db, p) ){
609633e6d57Sdrh       if( n<=db->lookaside.sz ){
610633e6d57Sdrh         return p;
611633e6d57Sdrh       }
612633e6d57Sdrh       pNew = sqlite3DbMallocRaw(db, n);
613633e6d57Sdrh       if( pNew ){
614633e6d57Sdrh         memcpy(pNew, p, db->lookaside.sz);
615633e6d57Sdrh         sqlite3DbFree(db, p);
616633e6d57Sdrh       }
617633e6d57Sdrh     }else{
618a1644fd8Sdanielk1977       pNew = sqlite3_realloc(p, n);
619a1644fd8Sdanielk1977       if( !pNew ){
620a1644fd8Sdanielk1977         db->mallocFailed = 1;
621a1644fd8Sdanielk1977       }
622a1644fd8Sdanielk1977     }
623633e6d57Sdrh   }
624a1644fd8Sdanielk1977   return pNew;
625a1644fd8Sdanielk1977 }
626a1644fd8Sdanielk1977 
62717435752Sdrh /*
62817435752Sdrh ** Attempt to reallocate p.  If the reallocation fails, then free p
62917435752Sdrh ** and set the mallocFailed flag in the database connection.
63017435752Sdrh */
63117435752Sdrh void *sqlite3DbReallocOrFree(sqlite3 *db, void *p, int n){
632a3152895Sdrh   void *pNew;
633a1644fd8Sdanielk1977   pNew = sqlite3DbRealloc(db, p, n);
634a3152895Sdrh   if( !pNew ){
635633e6d57Sdrh     sqlite3DbFree(db, p);
636a3152895Sdrh   }
637a3152895Sdrh   return pNew;
638a3152895Sdrh }
639a3152895Sdrh 
640a3152895Sdrh /*
641a3152895Sdrh ** Make a copy of a string in memory obtained from sqliteMalloc(). These
642a3152895Sdrh ** functions call sqlite3MallocRaw() directly instead of sqliteMalloc(). This
643a3152895Sdrh ** is because when memory debugging is turned on, these two functions are
644a3152895Sdrh ** called via macros that record the current file and line number in the
645a3152895Sdrh ** ThreadData structure.
646a3152895Sdrh */
647633e6d57Sdrh char *sqlite3DbStrDup(sqlite3 *db, const char *z){
648a3152895Sdrh   char *zNew;
649633e6d57Sdrh   size_t n;
650633e6d57Sdrh   if( z==0 ){
651633e6d57Sdrh     return 0;
652a3152895Sdrh   }
653dee0e404Sdrh   n = sqlite3Strlen30(z) + 1;
654633e6d57Sdrh   assert( (n&0x7fffffff)==n );
655633e6d57Sdrh   zNew = sqlite3DbMallocRaw(db, (int)n);
656a3152895Sdrh   if( zNew ){
657a3152895Sdrh     memcpy(zNew, z, n);
6581e536953Sdanielk1977   }
6591e536953Sdanielk1977   return zNew;
6601e536953Sdanielk1977 }
6611e536953Sdanielk1977 char *sqlite3DbStrNDup(sqlite3 *db, const char *z, int n){
662633e6d57Sdrh   char *zNew;
663633e6d57Sdrh   if( z==0 ){
664633e6d57Sdrh     return 0;
665633e6d57Sdrh   }
666633e6d57Sdrh   assert( (n&0x7fffffff)==n );
667633e6d57Sdrh   zNew = sqlite3DbMallocRaw(db, n+1);
668633e6d57Sdrh   if( zNew ){
669633e6d57Sdrh     memcpy(zNew, z, n);
670633e6d57Sdrh     zNew[n] = 0;
6711e536953Sdanielk1977   }
6721e536953Sdanielk1977   return zNew;
6731e536953Sdanielk1977 }
6741e536953Sdanielk1977 
675a3152895Sdrh /*
676f089aa45Sdrh ** Create a string from the zFromat argument and the va_list that follows.
677f089aa45Sdrh ** Store the string in memory obtained from sqliteMalloc() and make *pz
678f089aa45Sdrh ** point to that string.
679a3152895Sdrh */
680f089aa45Sdrh void sqlite3SetString(char **pz, sqlite3 *db, const char *zFormat, ...){
681a3152895Sdrh   va_list ap;
682f089aa45Sdrh   char *z;
683a3152895Sdrh 
684f089aa45Sdrh   va_start(ap, zFormat);
685f089aa45Sdrh   z = sqlite3VMPrintf(db, zFormat, ap);
686a3152895Sdrh   va_end(ap);
687633e6d57Sdrh   sqlite3DbFree(db, *pz);
688f089aa45Sdrh   *pz = z;
689a3152895Sdrh }
690a3152895Sdrh 
691a3152895Sdrh 
692a3152895Sdrh /*
693a3152895Sdrh ** This function must be called before exiting any API function (i.e.
69417435752Sdrh ** returning control to the user) that has called sqlite3_malloc or
69517435752Sdrh ** sqlite3_realloc.
696a3152895Sdrh **
697a3152895Sdrh ** The returned value is normally a copy of the second argument to this
698be217793Sshane ** function. However, if a malloc() failure has occurred since the previous
699a3152895Sdrh ** invocation SQLITE_NOMEM is returned instead.
700a3152895Sdrh **
701be217793Sshane ** If the first argument, db, is not NULL and a malloc() error has occurred,
702a3152895Sdrh ** then the connection error-code (the value returned by sqlite3_errcode())
703a3152895Sdrh ** is set to SQLITE_NOMEM.
704a3152895Sdrh */
705a3152895Sdrh int sqlite3ApiExit(sqlite3* db, int rc){
706a1644fd8Sdanielk1977   /* If the db handle is not NULL, then we must hold the connection handle
707a1644fd8Sdanielk1977   ** mutex here. Otherwise the read (and possible write) of db->mallocFailed
708a1644fd8Sdanielk1977   ** is unsafe, as is the call to sqlite3Error().
709a1644fd8Sdanielk1977   */
710a1644fd8Sdanielk1977   assert( !db || sqlite3_mutex_held(db->mutex) );
71198c21903Sdanielk1977   if( db && (db->mallocFailed || rc==SQLITE_IOERR_NOMEM) ){
712a3152895Sdrh     sqlite3Error(db, SQLITE_NOMEM, 0);
71317435752Sdrh     db->mallocFailed = 0;
714a3152895Sdrh     rc = SQLITE_NOMEM;
715a3152895Sdrh   }
716a3152895Sdrh   return rc & (db ? db->errMask : 0xff);
717a3152895Sdrh }
718