blob: 6678d56596d085949e43e0f767c16744ee402426 [file] [log] [blame]
drha3152892007-05-05 11:48:52 +00001/*
2** 2001 September 15
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
10**
11*************************************************************************
drhfec00ea2008-06-14 16:56:21 +000012**
drha3152892007-05-05 11:48:52 +000013** Memory allocation functions used throughout sqlite.
14**
drhf18a61d2009-07-17 11:44:07 +000015** $Id: malloc.c,v 1.66 2009/07/17 11:44:07 drh Exp $
drha3152892007-05-05 11:48:52 +000016*/
17#include "sqliteInt.h"
drha3152892007-05-05 11:48:52 +000018#include <stdarg.h>
drha3152892007-05-05 11:48:52 +000019
20/*
drhb21c8cd2007-08-21 19:33:56 +000021** This routine runs when the memory allocator sees that the
22** total memory allocation is about to exceed the soft heap
23** limit.
24*/
25static void softHeapLimitEnforcer(
26 void *NotUsed,
danielk197762c14b32008-11-19 09:05:26 +000027 sqlite3_int64 NotUsed2,
drh153c62c2007-08-24 03:51:33 +000028 int allocSize
drhb21c8cd2007-08-21 19:33:56 +000029){
danielk197762c14b32008-11-19 09:05:26 +000030 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhb21c8cd2007-08-21 19:33:56 +000031 sqlite3_release_memory(allocSize);
32}
33
34/*
danielk197784680242008-06-23 11:11:35 +000035** Set the soft heap-size limit for the library. Passing a zero or
36** negative value indicates no limit.
drha3152892007-05-05 11:48:52 +000037*/
38void sqlite3_soft_heap_limit(int n){
drhb21c8cd2007-08-21 19:33:56 +000039 sqlite3_uint64 iLimit;
40 int overage;
41 if( n<0 ){
42 iLimit = 0;
43 }else{
44 iLimit = n;
drha3152892007-05-05 11:48:52 +000045 }
drh9ac06502009-08-17 13:42:29 +000046#ifndef SQLITE_OMIT_AUTOINIT
drh9ac3fe92008-06-18 18:12:04 +000047 sqlite3_initialize();
drh9ac06502009-08-17 13:42:29 +000048#endif
drhb21c8cd2007-08-21 19:33:56 +000049 if( iLimit>0 ){
shane4a27a282008-09-04 04:32:49 +000050 sqlite3MemoryAlarm(softHeapLimitEnforcer, 0, iLimit);
drhb21c8cd2007-08-21 19:33:56 +000051 }else{
shane4a27a282008-09-04 04:32:49 +000052 sqlite3MemoryAlarm(0, 0, 0);
drhb21c8cd2007-08-21 19:33:56 +000053 }
drh1bd10f82008-12-10 21:19:56 +000054 overage = (int)(sqlite3_memory_used() - (i64)n);
drhb21c8cd2007-08-21 19:33:56 +000055 if( overage>0 ){
56 sqlite3_release_memory(overage);
57 }
drha3152892007-05-05 11:48:52 +000058}
59
60/*
danielk197784680242008-06-23 11:11:35 +000061** Attempt to release up to n bytes of non-essential memory currently
62** held by SQLite. An example of non-essential memory is memory used to
63** cache database pages that are not currently in use.
drha3152892007-05-05 11:48:52 +000064*/
65int sqlite3_release_memory(int n){
drh86f8c192007-08-22 00:39:19 +000066#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197767e3da72008-08-21 12:19:44 +000067 int nRet = 0;
68#if 0
69 nRet += sqlite3VdbeReleaseMemory(n);
70#endif
71 nRet += sqlite3PcacheReleaseMemory(n-nRet);
danielk1977dfb316d2008-03-26 18:34:43 +000072 return nRet;
danielk19771e536952007-08-16 10:09:01 +000073#else
danielk197762c14b32008-11-19 09:05:26 +000074 UNUSED_PARAMETER(n);
danielk19771e536952007-08-16 10:09:01 +000075 return SQLITE_OK;
76#endif
drha3152892007-05-05 11:48:52 +000077}
drha3152892007-05-05 11:48:52 +000078
drhfec00ea2008-06-14 16:56:21 +000079/*
80** State information local to the memory allocation subsystem.
81*/
danielk19775c8f8582008-09-02 10:22:00 +000082static SQLITE_WSD struct Mem0Global {
danielk197723bf0f42008-09-02 17:52:51 +000083 /* Number of free pages for scratch and page-cache memory */
84 u32 nScratchFree;
85 u32 nPageFree;
86
drhfec00ea2008-06-14 16:56:21 +000087 sqlite3_mutex *mutex; /* Mutex to serialize access */
88
89 /*
90 ** The alarm callback and its arguments. The mem0.mutex lock will
91 ** be held while the callback is running. Recursive calls into
92 ** the memory subsystem are allowed, but no new callbacks will be
drhe64ca7b2009-07-16 18:21:17 +000093 ** issued.
drhfec00ea2008-06-14 16:56:21 +000094 */
95 sqlite3_int64 alarmThreshold;
96 void (*alarmCallback)(void*, sqlite3_int64,int);
97 void *alarmArg;
drhfec00ea2008-06-14 16:56:21 +000098
99 /*
danielk1977075c23a2008-09-01 18:34:20 +0000100 ** Pointers to the end of sqlite3GlobalConfig.pScratch and
101 ** sqlite3GlobalConfig.pPage to a block of memory that records
drh9ac3fe92008-06-18 18:12:04 +0000102 ** which pages are available.
103 */
104 u32 *aScratchFree;
105 u32 *aPageFree;
drhe64ca7b2009-07-16 18:21:17 +0000106} mem0 = { 0, 0, 0, 0, 0, 0, 0, 0 };
danielk19775c8f8582008-09-02 10:22:00 +0000107
108#define mem0 GLOBAL(struct Mem0Global, mem0)
drhfec00ea2008-06-14 16:56:21 +0000109
110/*
111** Initialize the memory allocation subsystem.
112*/
113int sqlite3MallocInit(void){
danielk1977075c23a2008-09-01 18:34:20 +0000114 if( sqlite3GlobalConfig.m.xMalloc==0 ){
drhfec00ea2008-06-14 16:56:21 +0000115 sqlite3MemSetDefault();
116 }
117 memset(&mem0, 0, sizeof(mem0));
danielk1977075c23a2008-09-01 18:34:20 +0000118 if( sqlite3GlobalConfig.bCoreMutex ){
danielk197759f8c082008-06-18 17:09:10 +0000119 mem0.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
drhfec00ea2008-06-14 16:56:21 +0000120 }
danielk1977075c23a2008-09-01 18:34:20 +0000121 if( sqlite3GlobalConfig.pScratch && sqlite3GlobalConfig.szScratch>=100
122 && sqlite3GlobalConfig.nScratch>=0 ){
drh9ac3fe92008-06-18 18:12:04 +0000123 int i;
danielk1977bc739712009-03-23 04:33:32 +0000124 sqlite3GlobalConfig.szScratch = ROUNDDOWN8(sqlite3GlobalConfig.szScratch-4);
danielk1977075c23a2008-09-01 18:34:20 +0000125 mem0.aScratchFree = (u32*)&((char*)sqlite3GlobalConfig.pScratch)
126 [sqlite3GlobalConfig.szScratch*sqlite3GlobalConfig.nScratch];
127 for(i=0; i<sqlite3GlobalConfig.nScratch; i++){ mem0.aScratchFree[i] = i; }
128 mem0.nScratchFree = sqlite3GlobalConfig.nScratch;
drh9ac3fe92008-06-18 18:12:04 +0000129 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000130 sqlite3GlobalConfig.pScratch = 0;
131 sqlite3GlobalConfig.szScratch = 0;
drh9ac3fe92008-06-18 18:12:04 +0000132 }
danielk1977075c23a2008-09-01 18:34:20 +0000133 if( sqlite3GlobalConfig.pPage && sqlite3GlobalConfig.szPage>=512
134 && sqlite3GlobalConfig.nPage>=1 ){
drh9ac3fe92008-06-18 18:12:04 +0000135 int i;
drh0a60a382008-07-31 17:16:05 +0000136 int overhead;
danielk1977bc739712009-03-23 04:33:32 +0000137 int sz = ROUNDDOWN8(sqlite3GlobalConfig.szPage);
danielk1977075c23a2008-09-01 18:34:20 +0000138 int n = sqlite3GlobalConfig.nPage;
drh0a60a382008-07-31 17:16:05 +0000139 overhead = (4*n + sz - 1)/sz;
danielk1977075c23a2008-09-01 18:34:20 +0000140 sqlite3GlobalConfig.nPage -= overhead;
141 mem0.aPageFree = (u32*)&((char*)sqlite3GlobalConfig.pPage)
142 [sqlite3GlobalConfig.szPage*sqlite3GlobalConfig.nPage];
143 for(i=0; i<sqlite3GlobalConfig.nPage; i++){ mem0.aPageFree[i] = i; }
144 mem0.nPageFree = sqlite3GlobalConfig.nPage;
drh9ac3fe92008-06-18 18:12:04 +0000145 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000146 sqlite3GlobalConfig.pPage = 0;
147 sqlite3GlobalConfig.szPage = 0;
drh9ac3fe92008-06-18 18:12:04 +0000148 }
danielk1977075c23a2008-09-01 18:34:20 +0000149 return sqlite3GlobalConfig.m.xInit(sqlite3GlobalConfig.m.pAppData);
drhfec00ea2008-06-14 16:56:21 +0000150}
151
152/*
153** Deinitialize the memory allocation subsystem.
154*/
155void sqlite3MallocEnd(void){
danielk19770a549072009-02-17 16:29:10 +0000156 if( sqlite3GlobalConfig.m.xShutdown ){
157 sqlite3GlobalConfig.m.xShutdown(sqlite3GlobalConfig.m.pAppData);
158 }
drh9ac3fe92008-06-18 18:12:04 +0000159 memset(&mem0, 0, sizeof(mem0));
drhfec00ea2008-06-14 16:56:21 +0000160}
161
162/*
163** Return the amount of memory currently checked out.
164*/
165sqlite3_int64 sqlite3_memory_used(void){
drhf7141992008-06-19 00:16:08 +0000166 int n, mx;
drhc376a192008-07-14 12:30:54 +0000167 sqlite3_int64 res;
drhf7141992008-06-19 00:16:08 +0000168 sqlite3_status(SQLITE_STATUS_MEMORY_USED, &n, &mx, 0);
drhc376a192008-07-14 12:30:54 +0000169 res = (sqlite3_int64)n; /* Work around bug in Borland C. Ticket #3216 */
170 return res;
drhfec00ea2008-06-14 16:56:21 +0000171}
172
173/*
174** Return the maximum amount of memory that has ever been
175** checked out since either the beginning of this process
176** or since the most recent reset.
177*/
178sqlite3_int64 sqlite3_memory_highwater(int resetFlag){
drhf7141992008-06-19 00:16:08 +0000179 int n, mx;
drhc376a192008-07-14 12:30:54 +0000180 sqlite3_int64 res;
drhf7141992008-06-19 00:16:08 +0000181 sqlite3_status(SQLITE_STATUS_MEMORY_USED, &n, &mx, resetFlag);
drh7986a712008-07-14 12:38:20 +0000182 res = (sqlite3_int64)mx; /* Work around bug in Borland C. Ticket #3216 */
drhc376a192008-07-14 12:30:54 +0000183 return res;
drhfec00ea2008-06-14 16:56:21 +0000184}
185
186/*
187** Change the alarm callback
188*/
shane4a27a282008-09-04 04:32:49 +0000189int sqlite3MemoryAlarm(
drhfec00ea2008-06-14 16:56:21 +0000190 void(*xCallback)(void *pArg, sqlite3_int64 used,int N),
191 void *pArg,
192 sqlite3_int64 iThreshold
193){
194 sqlite3_mutex_enter(mem0.mutex);
195 mem0.alarmCallback = xCallback;
196 mem0.alarmArg = pArg;
197 mem0.alarmThreshold = iThreshold;
198 sqlite3_mutex_leave(mem0.mutex);
199 return SQLITE_OK;
200}
201
shaneeec556d2008-10-12 00:27:53 +0000202#ifndef SQLITE_OMIT_DEPRECATED
drhfec00ea2008-06-14 16:56:21 +0000203/*
shane4a27a282008-09-04 04:32:49 +0000204** Deprecated external interface. Internal/core SQLite code
205** should call sqlite3MemoryAlarm.
206*/
207int sqlite3_memory_alarm(
208 void(*xCallback)(void *pArg, sqlite3_int64 used,int N),
209 void *pArg,
210 sqlite3_int64 iThreshold
211){
212 return sqlite3MemoryAlarm(xCallback, pArg, iThreshold);
213}
shaneeec556d2008-10-12 00:27:53 +0000214#endif
shane4a27a282008-09-04 04:32:49 +0000215
216/*
drhfec00ea2008-06-14 16:56:21 +0000217** Trigger the alarm
218*/
219static void sqlite3MallocAlarm(int nByte){
220 void (*xCallback)(void*,sqlite3_int64,int);
221 sqlite3_int64 nowUsed;
222 void *pArg;
drhe64ca7b2009-07-16 18:21:17 +0000223 if( mem0.alarmCallback==0 ) return;
drhfec00ea2008-06-14 16:56:21 +0000224 xCallback = mem0.alarmCallback;
drhf7141992008-06-19 00:16:08 +0000225 nowUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
drhfec00ea2008-06-14 16:56:21 +0000226 pArg = mem0.alarmArg;
drhe64ca7b2009-07-16 18:21:17 +0000227 mem0.alarmCallback = 0;
drhfec00ea2008-06-14 16:56:21 +0000228 sqlite3_mutex_leave(mem0.mutex);
229 xCallback(pArg, nowUsed, nByte);
230 sqlite3_mutex_enter(mem0.mutex);
drhe64ca7b2009-07-16 18:21:17 +0000231 mem0.alarmCallback = xCallback;
232 mem0.alarmArg = pArg;
drhfec00ea2008-06-14 16:56:21 +0000233}
234
drhf7141992008-06-19 00:16:08 +0000235/*
236** Do a memory allocation with statistics and alarms. Assume the
237** lock is already held.
238*/
239static int mallocWithAlarm(int n, void **pp){
240 int nFull;
241 void *p;
242 assert( sqlite3_mutex_held(mem0.mutex) );
danielk1977075c23a2008-09-01 18:34:20 +0000243 nFull = sqlite3GlobalConfig.m.xRoundup(n);
drhf7141992008-06-19 00:16:08 +0000244 sqlite3StatusSet(SQLITE_STATUS_MALLOC_SIZE, n);
245 if( mem0.alarmCallback!=0 ){
246 int nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
247 if( nUsed+nFull >= mem0.alarmThreshold ){
248 sqlite3MallocAlarm(nFull);
249 }
250 }
danielk1977075c23a2008-09-01 18:34:20 +0000251 p = sqlite3GlobalConfig.m.xMalloc(nFull);
danielk1977d09414c2008-06-19 18:17:49 +0000252 if( p==0 && mem0.alarmCallback ){
253 sqlite3MallocAlarm(nFull);
danielk1977075c23a2008-09-01 18:34:20 +0000254 p = sqlite3GlobalConfig.m.xMalloc(nFull);
drhf7141992008-06-19 00:16:08 +0000255 }
drhc702c7c2008-07-18 18:56:16 +0000256 if( p ){
257 nFull = sqlite3MallocSize(p);
258 sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, nFull);
259 }
drhf7141992008-06-19 00:16:08 +0000260 *pp = p;
261 return nFull;
262}
drhfec00ea2008-06-14 16:56:21 +0000263
264/*
265** Allocate memory. This routine is like sqlite3_malloc() except that it
266** assumes the memory subsystem has already been initialized.
267*/
268void *sqlite3Malloc(int n){
269 void *p;
drhe08ed7e2009-06-26 18:35:16 +0000270 if( n<=0 || n>=0x7fffff00 ){
271 /* A memory allocation of a number of bytes which is near the maximum
272 ** signed integer value might cause an integer overflow inside of the
273 ** xMalloc(). Hence we limit the maximum size to 0x7fffff00, giving
274 ** 255 bytes of overhead. SQLite itself will never use anything near
275 ** this amount. The only way to reach the limit is with sqlite3_malloc() */
drhf7141992008-06-19 00:16:08 +0000276 p = 0;
danielk1977075c23a2008-09-01 18:34:20 +0000277 }else if( sqlite3GlobalConfig.bMemstat ){
drhfec00ea2008-06-14 16:56:21 +0000278 sqlite3_mutex_enter(mem0.mutex);
drhf7141992008-06-19 00:16:08 +0000279 mallocWithAlarm(n, &p);
drhfec00ea2008-06-14 16:56:21 +0000280 sqlite3_mutex_leave(mem0.mutex);
281 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000282 p = sqlite3GlobalConfig.m.xMalloc(n);
drhfec00ea2008-06-14 16:56:21 +0000283 }
284 return p;
285}
286
287/*
288** This version of the memory allocation is for use by the application.
289** First make sure the memory subsystem is initialized, then do the
290** allocation.
291*/
292void *sqlite3_malloc(int n){
293#ifndef SQLITE_OMIT_AUTOINIT
294 if( sqlite3_initialize() ) return 0;
295#endif
296 return sqlite3Malloc(n);
297}
298
299/*
drhe5ae5732008-06-15 02:51:47 +0000300** Each thread may only have a single outstanding allocation from
drhfacf0302008-06-17 15:12:00 +0000301** xScratchMalloc(). We verify this constraint in the single-threaded
302** case by setting scratchAllocOut to 1 when an allocation
drhe5ae5732008-06-15 02:51:47 +0000303** is outstanding clearing it when the allocation is freed.
304*/
305#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
drhfacf0302008-06-17 15:12:00 +0000306static int scratchAllocOut = 0;
drhe5ae5732008-06-15 02:51:47 +0000307#endif
308
309
310/*
311** Allocate memory that is to be used and released right away.
312** This routine is similar to alloca() in that it is not intended
313** for situations where the memory might be held long-term. This
314** routine is intended to get memory to old large transient data
315** structures that would not normally fit on the stack of an
316** embedded processor.
317*/
drhfacf0302008-06-17 15:12:00 +0000318void *sqlite3ScratchMalloc(int n){
drhe5ae5732008-06-15 02:51:47 +0000319 void *p;
320 assert( n>0 );
drh9ac3fe92008-06-18 18:12:04 +0000321
drhe5ae5732008-06-15 02:51:47 +0000322#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
drh9ac3fe92008-06-18 18:12:04 +0000323 /* Verify that no more than one scratch allocation per thread
324 ** is outstanding at one time. (This is only checked in the
325 ** single-threaded case since checking in the multi-threaded case
326 ** would be much more complicated.) */
drhfacf0302008-06-17 15:12:00 +0000327 assert( scratchAllocOut==0 );
drhe5ae5732008-06-15 02:51:47 +0000328#endif
drh9ac3fe92008-06-18 18:12:04 +0000329
danielk1977075c23a2008-09-01 18:34:20 +0000330 if( sqlite3GlobalConfig.szScratch<n ){
drhf7141992008-06-19 00:16:08 +0000331 goto scratch_overflow;
332 }else{
333 sqlite3_mutex_enter(mem0.mutex);
334 if( mem0.nScratchFree==0 ){
335 sqlite3_mutex_leave(mem0.mutex);
336 goto scratch_overflow;
337 }else{
338 int i;
339 i = mem0.aScratchFree[--mem0.nScratchFree];
danielk1977075c23a2008-09-01 18:34:20 +0000340 i *= sqlite3GlobalConfig.szScratch;
drhf7141992008-06-19 00:16:08 +0000341 sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_USED, 1);
drhe50135e2008-08-05 17:53:22 +0000342 sqlite3StatusSet(SQLITE_STATUS_SCRATCH_SIZE, n);
danielk19778183e332008-08-29 17:56:12 +0000343 sqlite3_mutex_leave(mem0.mutex);
danielk1977075c23a2008-09-01 18:34:20 +0000344 p = (void*)&((char*)sqlite3GlobalConfig.pScratch)[i];
shane15301592008-12-16 17:20:38 +0000345 assert( (((u8*)p - (u8*)0) & 7)==0 );
drhf7141992008-06-19 00:16:08 +0000346 }
drhe5ae5732008-06-15 02:51:47 +0000347 }
drhf7141992008-06-19 00:16:08 +0000348#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
349 scratchAllocOut = p!=0;
350#endif
351
drhe5ae5732008-06-15 02:51:47 +0000352 return p;
drhf7141992008-06-19 00:16:08 +0000353
354scratch_overflow:
danielk1977075c23a2008-09-01 18:34:20 +0000355 if( sqlite3GlobalConfig.bMemstat ){
drhf7141992008-06-19 00:16:08 +0000356 sqlite3_mutex_enter(mem0.mutex);
drhe50135e2008-08-05 17:53:22 +0000357 sqlite3StatusSet(SQLITE_STATUS_SCRATCH_SIZE, n);
drhf7141992008-06-19 00:16:08 +0000358 n = mallocWithAlarm(n, &p);
359 if( p ) sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_OVERFLOW, n);
360 sqlite3_mutex_leave(mem0.mutex);
361 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000362 p = sqlite3GlobalConfig.m.xMalloc(n);
drhf7141992008-06-19 00:16:08 +0000363 }
364#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
365 scratchAllocOut = p!=0;
366#endif
367 return p;
drhe5ae5732008-06-15 02:51:47 +0000368}
drhfacf0302008-06-17 15:12:00 +0000369void sqlite3ScratchFree(void *p){
drhe5ae5732008-06-15 02:51:47 +0000370 if( p ){
drh9ac3fe92008-06-18 18:12:04 +0000371
drhe5ae5732008-06-15 02:51:47 +0000372#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
drh9ac3fe92008-06-18 18:12:04 +0000373 /* Verify that no more than one scratch allocation per thread
374 ** is outstanding at one time. (This is only checked in the
375 ** single-threaded case since checking in the multi-threaded case
376 ** would be much more complicated.) */
drhfacf0302008-06-17 15:12:00 +0000377 assert( scratchAllocOut==1 );
378 scratchAllocOut = 0;
drhe5ae5732008-06-15 02:51:47 +0000379#endif
drh9ac3fe92008-06-18 18:12:04 +0000380
danielk1977075c23a2008-09-01 18:34:20 +0000381 if( sqlite3GlobalConfig.pScratch==0
382 || p<sqlite3GlobalConfig.pScratch
drhf7141992008-06-19 00:16:08 +0000383 || p>=(void*)mem0.aScratchFree ){
danielk1977075c23a2008-09-01 18:34:20 +0000384 if( sqlite3GlobalConfig.bMemstat ){
drhf7141992008-06-19 00:16:08 +0000385 int iSize = sqlite3MallocSize(p);
386 sqlite3_mutex_enter(mem0.mutex);
387 sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_OVERFLOW, -iSize);
388 sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, -iSize);
danielk1977075c23a2008-09-01 18:34:20 +0000389 sqlite3GlobalConfig.m.xFree(p);
drhf7141992008-06-19 00:16:08 +0000390 sqlite3_mutex_leave(mem0.mutex);
391 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000392 sqlite3GlobalConfig.m.xFree(p);
drhf7141992008-06-19 00:16:08 +0000393 }
drh9ac3fe92008-06-18 18:12:04 +0000394 }else{
395 int i;
drh1bd10f82008-12-10 21:19:56 +0000396 i = (int)((u8*)p - (u8*)sqlite3GlobalConfig.pScratch);
danielk1977075c23a2008-09-01 18:34:20 +0000397 i /= sqlite3GlobalConfig.szScratch;
398 assert( i>=0 && i<sqlite3GlobalConfig.nScratch );
drhf7141992008-06-19 00:16:08 +0000399 sqlite3_mutex_enter(mem0.mutex);
danielk197700e13612008-11-17 19:18:54 +0000400 assert( mem0.nScratchFree<(u32)sqlite3GlobalConfig.nScratch );
drh9ac3fe92008-06-18 18:12:04 +0000401 mem0.aScratchFree[mem0.nScratchFree++] = i;
drhf7141992008-06-19 00:16:08 +0000402 sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_USED, -1);
drh9ac3fe92008-06-18 18:12:04 +0000403 sqlite3_mutex_leave(mem0.mutex);
404 }
drhe5ae5732008-06-15 02:51:47 +0000405 }
406}
407
408/*
drh633e6d52008-07-28 19:34:53 +0000409** TRUE if p is a lookaside memory allocation from db
410*/
drh4150ebf2008-10-11 15:38:29 +0000411#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000412static int isLookaside(sqlite3 *db, void *p){
413 return db && p && p>=db->lookaside.pStart && p<db->lookaside.pEnd;
414}
drh4150ebf2008-10-11 15:38:29 +0000415#else
416#define isLookaside(A,B) 0
417#endif
drh633e6d52008-07-28 19:34:53 +0000418
419/*
drhfec00ea2008-06-14 16:56:21 +0000420** Return the size of a memory allocation previously obtained from
421** sqlite3Malloc() or sqlite3_malloc().
422*/
423int sqlite3MallocSize(void *p){
danielk1977075c23a2008-09-01 18:34:20 +0000424 return sqlite3GlobalConfig.m.xSize(p);
drhfec00ea2008-06-14 16:56:21 +0000425}
drh633e6d52008-07-28 19:34:53 +0000426int sqlite3DbMallocSize(sqlite3 *db, void *p){
drh7047e252009-03-23 17:49:14 +0000427 assert( db==0 || sqlite3_mutex_held(db->mutex) );
drhf18a61d2009-07-17 11:44:07 +0000428 if( isLookaside(db, p) ){
drh633e6d52008-07-28 19:34:53 +0000429 return db->lookaside.sz;
430 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000431 return sqlite3GlobalConfig.m.xSize(p);
drh633e6d52008-07-28 19:34:53 +0000432 }
433}
drhfec00ea2008-06-14 16:56:21 +0000434
435/*
436** Free memory previously obtained from sqlite3Malloc().
437*/
438void sqlite3_free(void *p){
439 if( p==0 ) return;
danielk1977075c23a2008-09-01 18:34:20 +0000440 if( sqlite3GlobalConfig.bMemstat ){
drhfec00ea2008-06-14 16:56:21 +0000441 sqlite3_mutex_enter(mem0.mutex);
drhf7141992008-06-19 00:16:08 +0000442 sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, -sqlite3MallocSize(p));
danielk1977075c23a2008-09-01 18:34:20 +0000443 sqlite3GlobalConfig.m.xFree(p);
drhfec00ea2008-06-14 16:56:21 +0000444 sqlite3_mutex_leave(mem0.mutex);
445 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000446 sqlite3GlobalConfig.m.xFree(p);
drhfec00ea2008-06-14 16:56:21 +0000447 }
448}
449
450/*
drh633e6d52008-07-28 19:34:53 +0000451** Free memory that might be associated with a particular database
452** connection.
453*/
454void sqlite3DbFree(sqlite3 *db, void *p){
drh7047e252009-03-23 17:49:14 +0000455 assert( db==0 || sqlite3_mutex_held(db->mutex) );
drh633e6d52008-07-28 19:34:53 +0000456 if( isLookaside(db, p) ){
457 LookasideSlot *pBuf = (LookasideSlot*)p;
458 pBuf->pNext = db->lookaside.pFree;
459 db->lookaside.pFree = pBuf;
460 db->lookaside.nOut--;
461 }else{
462 sqlite3_free(p);
463 }
464}
465
466/*
drhfec00ea2008-06-14 16:56:21 +0000467** Change the size of an existing memory allocation
468*/
469void *sqlite3Realloc(void *pOld, int nBytes){
470 int nOld, nNew;
471 void *pNew;
472 if( pOld==0 ){
473 return sqlite3Malloc(nBytes);
474 }
drhb6063cf2009-06-27 00:48:33 +0000475 if( nBytes<=0 ){
drhfec00ea2008-06-14 16:56:21 +0000476 sqlite3_free(pOld);
477 return 0;
478 }
drhb6063cf2009-06-27 00:48:33 +0000479 if( nBytes>=0x7fffff00 ){
480 /* The 0x7ffff00 limit term is explained in comments on sqlite3Malloc() */
481 return 0;
482 }
drhfec00ea2008-06-14 16:56:21 +0000483 nOld = sqlite3MallocSize(pOld);
drh7c6791c2009-08-18 14:48:53 +0000484 nNew = sqlite3GlobalConfig.m.xRoundup(nBytes);
485 if( nOld==nNew ){
486 pNew = pOld;
487 }else if( sqlite3GlobalConfig.bMemstat ){
drhfec00ea2008-06-14 16:56:21 +0000488 sqlite3_mutex_enter(mem0.mutex);
drhf7141992008-06-19 00:16:08 +0000489 sqlite3StatusSet(SQLITE_STATUS_MALLOC_SIZE, nBytes);
drh7c6791c2009-08-18 14:48:53 +0000490 if( sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED)+nNew-nOld >=
491 mem0.alarmThreshold ){
492 sqlite3MallocAlarm(nNew-nOld);
493 }
494 pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
495 if( pNew==0 && mem0.alarmCallback ){
496 sqlite3MallocAlarm(nBytes);
danielk1977075c23a2008-09-01 18:34:20 +0000497 pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
drh7c6791c2009-08-18 14:48:53 +0000498 }
499 if( pNew ){
500 nNew = sqlite3MallocSize(pNew);
501 sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, nNew-nOld);
drhfec00ea2008-06-14 16:56:21 +0000502 }
503 sqlite3_mutex_leave(mem0.mutex);
504 }else{
drh7c6791c2009-08-18 14:48:53 +0000505 pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
drhfec00ea2008-06-14 16:56:21 +0000506 }
507 return pNew;
508}
509
510/*
511** The public interface to sqlite3Realloc. Make sure that the memory
512** subsystem is initialized prior to invoking sqliteRealloc.
513*/
514void *sqlite3_realloc(void *pOld, int n){
515#ifndef SQLITE_OMIT_AUTOINIT
516 if( sqlite3_initialize() ) return 0;
517#endif
518 return sqlite3Realloc(pOld, n);
519}
520
drha3152892007-05-05 11:48:52 +0000521
522/*
drh17435752007-08-16 04:30:38 +0000523** Allocate and zero memory.
drha3152892007-05-05 11:48:52 +0000524*/
drhfec00ea2008-06-14 16:56:21 +0000525void *sqlite3MallocZero(int n){
526 void *p = sqlite3Malloc(n);
drha3152892007-05-05 11:48:52 +0000527 if( p ){
528 memset(p, 0, n);
529 }
530 return p;
531}
drh17435752007-08-16 04:30:38 +0000532
533/*
534** Allocate and zero memory. If the allocation fails, make
535** the mallocFailed flag in the connection pointer.
536*/
drhfec00ea2008-06-14 16:56:21 +0000537void *sqlite3DbMallocZero(sqlite3 *db, int n){
danielk1977a1644fd2007-08-29 12:31:25 +0000538 void *p = sqlite3DbMallocRaw(db, n);
drh17435752007-08-16 04:30:38 +0000539 if( p ){
540 memset(p, 0, n);
drh17435752007-08-16 04:30:38 +0000541 }
542 return p;
543}
544
545/*
546** Allocate and zero memory. If the allocation fails, make
547** the mallocFailed flag in the connection pointer.
drhddecae72008-10-11 17:35:16 +0000548**
549** If db!=0 and db->mallocFailed is true (indicating a prior malloc
550** failure on the same database connection) then always return 0.
551** Hence for a particular database connection, once malloc starts
552** failing, it fails consistently until mallocFailed is reset.
553** This is an important assumption. There are many places in the
554** code that do things like this:
555**
556** int *a = (int*)sqlite3DbMallocRaw(db, 100);
557** int *b = (int*)sqlite3DbMallocRaw(db, 200);
558** if( b ) a[10] = 9;
559**
560** In other words, if a subsequent malloc (ex: "b") worked, it is assumed
561** that all prior mallocs (ex: "a") worked too.
drh17435752007-08-16 04:30:38 +0000562*/
drhfec00ea2008-06-14 16:56:21 +0000563void *sqlite3DbMallocRaw(sqlite3 *db, int n){
drh633e6d52008-07-28 19:34:53 +0000564 void *p;
drhd9da78a2009-03-24 15:08:09 +0000565 assert( db==0 || sqlite3_mutex_held(db->mutex) );
drh4150ebf2008-10-11 15:38:29 +0000566#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000567 if( db ){
568 LookasideSlot *pBuf;
569 if( db->mallocFailed ){
570 return 0;
danielk1977a1644fd2007-08-29 12:31:25 +0000571 }
drh633e6d52008-07-28 19:34:53 +0000572 if( db->lookaside.bEnabled && n<=db->lookaside.sz
573 && (pBuf = db->lookaside.pFree)!=0 ){
574 db->lookaside.pFree = pBuf->pNext;
575 db->lookaside.nOut++;
576 if( db->lookaside.nOut>db->lookaside.mxOut ){
577 db->lookaside.mxOut = db->lookaside.nOut;
578 }
579 return (void*)pBuf;
580 }
581 }
drhddecae72008-10-11 17:35:16 +0000582#else
583 if( db && db->mallocFailed ){
584 return 0;
585 }
drh4150ebf2008-10-11 15:38:29 +0000586#endif
drh633e6d52008-07-28 19:34:53 +0000587 p = sqlite3Malloc(n);
588 if( !p && db ){
589 db->mallocFailed = 1;
drh17435752007-08-16 04:30:38 +0000590 }
591 return p;
592}
593
danielk197726783a52007-08-29 14:06:22 +0000594/*
595** Resize the block of memory pointed to by p to n bytes. If the
drh633e6d52008-07-28 19:34:53 +0000596** resize fails, set the mallocFailed flag in the connection object.
danielk197726783a52007-08-29 14:06:22 +0000597*/
danielk1977a1644fd2007-08-29 12:31:25 +0000598void *sqlite3DbRealloc(sqlite3 *db, void *p, int n){
599 void *pNew = 0;
drhd9da78a2009-03-24 15:08:09 +0000600 assert( db!=0 );
drh7047e252009-03-23 17:49:14 +0000601 assert( sqlite3_mutex_held(db->mutex) );
danielk1977a1644fd2007-08-29 12:31:25 +0000602 if( db->mallocFailed==0 ){
drh633e6d52008-07-28 19:34:53 +0000603 if( p==0 ){
604 return sqlite3DbMallocRaw(db, n);
605 }
606 if( isLookaside(db, p) ){
607 if( n<=db->lookaside.sz ){
608 return p;
609 }
610 pNew = sqlite3DbMallocRaw(db, n);
611 if( pNew ){
612 memcpy(pNew, p, db->lookaside.sz);
613 sqlite3DbFree(db, p);
614 }
615 }else{
616 pNew = sqlite3_realloc(p, n);
617 if( !pNew ){
618 db->mallocFailed = 1;
619 }
danielk1977a1644fd2007-08-29 12:31:25 +0000620 }
621 }
622 return pNew;
623}
624
drh17435752007-08-16 04:30:38 +0000625/*
626** Attempt to reallocate p. If the reallocation fails, then free p
627** and set the mallocFailed flag in the database connection.
628*/
629void *sqlite3DbReallocOrFree(sqlite3 *db, void *p, int n){
drha3152892007-05-05 11:48:52 +0000630 void *pNew;
danielk1977a1644fd2007-08-29 12:31:25 +0000631 pNew = sqlite3DbRealloc(db, p, n);
drha3152892007-05-05 11:48:52 +0000632 if( !pNew ){
drh633e6d52008-07-28 19:34:53 +0000633 sqlite3DbFree(db, p);
drha3152892007-05-05 11:48:52 +0000634 }
635 return pNew;
636}
637
drha3152892007-05-05 11:48:52 +0000638/*
639** Make a copy of a string in memory obtained from sqliteMalloc(). These
640** functions call sqlite3MallocRaw() directly instead of sqliteMalloc(). This
641** is because when memory debugging is turned on, these two functions are
642** called via macros that record the current file and line number in the
643** ThreadData structure.
644*/
drh633e6d52008-07-28 19:34:53 +0000645char *sqlite3DbStrDup(sqlite3 *db, const char *z){
drha3152892007-05-05 11:48:52 +0000646 char *zNew;
drh633e6d52008-07-28 19:34:53 +0000647 size_t n;
648 if( z==0 ){
649 return 0;
650 }
drhdee0e402009-05-03 20:23:53 +0000651 n = sqlite3Strlen30(z) + 1;
drh633e6d52008-07-28 19:34:53 +0000652 assert( (n&0x7fffffff)==n );
653 zNew = sqlite3DbMallocRaw(db, (int)n);
drha3152892007-05-05 11:48:52 +0000654 if( zNew ){
655 memcpy(zNew, z, n);
danielk19771e536952007-08-16 10:09:01 +0000656 }
657 return zNew;
658}
659char *sqlite3DbStrNDup(sqlite3 *db, const char *z, int n){
drh633e6d52008-07-28 19:34:53 +0000660 char *zNew;
661 if( z==0 ){
662 return 0;
663 }
664 assert( (n&0x7fffffff)==n );
665 zNew = sqlite3DbMallocRaw(db, n+1);
666 if( zNew ){
667 memcpy(zNew, z, n);
668 zNew[n] = 0;
danielk19771e536952007-08-16 10:09:01 +0000669 }
670 return zNew;
671}
672
drha3152892007-05-05 11:48:52 +0000673/*
drhf089aa42008-07-08 19:34:06 +0000674** Create a string from the zFromat argument and the va_list that follows.
675** Store the string in memory obtained from sqliteMalloc() and make *pz
676** point to that string.
drha3152892007-05-05 11:48:52 +0000677*/
drhf089aa42008-07-08 19:34:06 +0000678void sqlite3SetString(char **pz, sqlite3 *db, const char *zFormat, ...){
drha3152892007-05-05 11:48:52 +0000679 va_list ap;
drhf089aa42008-07-08 19:34:06 +0000680 char *z;
drha3152892007-05-05 11:48:52 +0000681
drhf089aa42008-07-08 19:34:06 +0000682 va_start(ap, zFormat);
683 z = sqlite3VMPrintf(db, zFormat, ap);
drha3152892007-05-05 11:48:52 +0000684 va_end(ap);
drh633e6d52008-07-28 19:34:53 +0000685 sqlite3DbFree(db, *pz);
drhf089aa42008-07-08 19:34:06 +0000686 *pz = z;
drha3152892007-05-05 11:48:52 +0000687}
688
689
690/*
691** This function must be called before exiting any API function (i.e.
drh17435752007-08-16 04:30:38 +0000692** returning control to the user) that has called sqlite3_malloc or
693** sqlite3_realloc.
drha3152892007-05-05 11:48:52 +0000694**
695** The returned value is normally a copy of the second argument to this
shanebe217792009-03-05 04:20:31 +0000696** function. However, if a malloc() failure has occurred since the previous
drha3152892007-05-05 11:48:52 +0000697** invocation SQLITE_NOMEM is returned instead.
698**
shanebe217792009-03-05 04:20:31 +0000699** If the first argument, db, is not NULL and a malloc() error has occurred,
drha3152892007-05-05 11:48:52 +0000700** then the connection error-code (the value returned by sqlite3_errcode())
701** is set to SQLITE_NOMEM.
702*/
drha3152892007-05-05 11:48:52 +0000703int sqlite3ApiExit(sqlite3* db, int rc){
danielk1977a1644fd2007-08-29 12:31:25 +0000704 /* If the db handle is not NULL, then we must hold the connection handle
705 ** mutex here. Otherwise the read (and possible write) of db->mallocFailed
706 ** is unsafe, as is the call to sqlite3Error().
707 */
708 assert( !db || sqlite3_mutex_held(db->mutex) );
danielk197798c21902008-09-23 16:41:29 +0000709 if( db && (db->mallocFailed || rc==SQLITE_IOERR_NOMEM) ){
drha3152892007-05-05 11:48:52 +0000710 sqlite3Error(db, SQLITE_NOMEM, 0);
drh17435752007-08-16 04:30:38 +0000711 db->mallocFailed = 0;
drha3152892007-05-05 11:48:52 +0000712 rc = SQLITE_NOMEM;
713 }
714 return rc & (db ? db->errMask : 0xff);
715}