blob: 2678526ad69a7c97b42502fce0c11bf4ea4dd616 [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**
danielk1977bc739712009-03-23 04:33:32 +000015** $Id: malloc.c,v 1.59 2009/03/23 04:33:33 danielk1977 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 }
drh9ac3fe92008-06-18 18:12:04 +000046 sqlite3_initialize();
drhb21c8cd2007-08-21 19:33:56 +000047 if( iLimit>0 ){
shane4a27a282008-09-04 04:32:49 +000048 sqlite3MemoryAlarm(softHeapLimitEnforcer, 0, iLimit);
drhb21c8cd2007-08-21 19:33:56 +000049 }else{
shane4a27a282008-09-04 04:32:49 +000050 sqlite3MemoryAlarm(0, 0, 0);
drhb21c8cd2007-08-21 19:33:56 +000051 }
drh1bd10f82008-12-10 21:19:56 +000052 overage = (int)(sqlite3_memory_used() - (i64)n);
drhb21c8cd2007-08-21 19:33:56 +000053 if( overage>0 ){
54 sqlite3_release_memory(overage);
55 }
drha3152892007-05-05 11:48:52 +000056}
57
58/*
danielk197784680242008-06-23 11:11:35 +000059** Attempt to release up to n bytes of non-essential memory currently
60** held by SQLite. An example of non-essential memory is memory used to
61** cache database pages that are not currently in use.
drha3152892007-05-05 11:48:52 +000062*/
63int sqlite3_release_memory(int n){
drh86f8c192007-08-22 00:39:19 +000064#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197767e3da72008-08-21 12:19:44 +000065 int nRet = 0;
66#if 0
67 nRet += sqlite3VdbeReleaseMemory(n);
68#endif
69 nRet += sqlite3PcacheReleaseMemory(n-nRet);
danielk1977dfb316d2008-03-26 18:34:43 +000070 return nRet;
danielk19771e536952007-08-16 10:09:01 +000071#else
danielk197762c14b32008-11-19 09:05:26 +000072 UNUSED_PARAMETER(n);
danielk19771e536952007-08-16 10:09:01 +000073 return SQLITE_OK;
74#endif
drha3152892007-05-05 11:48:52 +000075}
drha3152892007-05-05 11:48:52 +000076
drhfec00ea2008-06-14 16:56:21 +000077/*
78** State information local to the memory allocation subsystem.
79*/
danielk19775c8f8582008-09-02 10:22:00 +000080static SQLITE_WSD struct Mem0Global {
danielk197723bf0f42008-09-02 17:52:51 +000081 /* Number of free pages for scratch and page-cache memory */
82 u32 nScratchFree;
83 u32 nPageFree;
84
drhfec00ea2008-06-14 16:56:21 +000085 sqlite3_mutex *mutex; /* Mutex to serialize access */
86
87 /*
88 ** The alarm callback and its arguments. The mem0.mutex lock will
89 ** be held while the callback is running. Recursive calls into
90 ** the memory subsystem are allowed, but no new callbacks will be
91 ** issued. The alarmBusy variable is set to prevent recursive
92 ** callbacks.
93 */
94 sqlite3_int64 alarmThreshold;
95 void (*alarmCallback)(void*, sqlite3_int64,int);
96 void *alarmArg;
97 int alarmBusy;
98
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;
danielk1977cdcfe952008-11-18 07:27:24 +0000106} mem0 = { 62560955, 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;
223 if( mem0.alarmCallback==0 || mem0.alarmBusy ) return;
224 mem0.alarmBusy = 1;
225 xCallback = mem0.alarmCallback;
drhf7141992008-06-19 00:16:08 +0000226 nowUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
drhfec00ea2008-06-14 16:56:21 +0000227 pArg = mem0.alarmArg;
228 sqlite3_mutex_leave(mem0.mutex);
229 xCallback(pArg, nowUsed, nByte);
230 sqlite3_mutex_enter(mem0.mutex);
231 mem0.alarmBusy = 0;
232}
233
drhf7141992008-06-19 00:16:08 +0000234/*
235** Do a memory allocation with statistics and alarms. Assume the
236** lock is already held.
237*/
238static int mallocWithAlarm(int n, void **pp){
239 int nFull;
240 void *p;
241 assert( sqlite3_mutex_held(mem0.mutex) );
danielk1977075c23a2008-09-01 18:34:20 +0000242 nFull = sqlite3GlobalConfig.m.xRoundup(n);
drhf7141992008-06-19 00:16:08 +0000243 sqlite3StatusSet(SQLITE_STATUS_MALLOC_SIZE, n);
244 if( mem0.alarmCallback!=0 ){
245 int nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
246 if( nUsed+nFull >= mem0.alarmThreshold ){
247 sqlite3MallocAlarm(nFull);
248 }
249 }
danielk1977075c23a2008-09-01 18:34:20 +0000250 p = sqlite3GlobalConfig.m.xMalloc(nFull);
danielk1977d09414c2008-06-19 18:17:49 +0000251 if( p==0 && mem0.alarmCallback ){
252 sqlite3MallocAlarm(nFull);
danielk1977075c23a2008-09-01 18:34:20 +0000253 p = sqlite3GlobalConfig.m.xMalloc(nFull);
drhf7141992008-06-19 00:16:08 +0000254 }
drhc702c7c2008-07-18 18:56:16 +0000255 if( p ){
256 nFull = sqlite3MallocSize(p);
257 sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, nFull);
258 }
drhf7141992008-06-19 00:16:08 +0000259 *pp = p;
260 return nFull;
261}
drhfec00ea2008-06-14 16:56:21 +0000262
263/*
264** Allocate memory. This routine is like sqlite3_malloc() except that it
265** assumes the memory subsystem has already been initialized.
266*/
267void *sqlite3Malloc(int n){
268 void *p;
drh50b65682009-02-17 18:37:28 +0000269 if( n<=0 || NEVER(n>=0x7fffff00) ){
270 /* The NEVER(n>=0x7fffff00) term is added out of paranoia. We want to make
271 ** absolutely sure that there is nothing within SQLite that can cause a
272 ** memory allocation of a number of bytes which is near the maximum signed
273 ** integer value and thus cause an integer overflow inside of the xMalloc()
274 ** implementation. The n>=0x7fffff00 gives us 255 bytes of headroom. The
275 ** test should never be true because SQLITE_MAX_LENGTH should be much
276 ** less than 0x7fffff00 and it should catch large memory allocations
277 ** before they reach this point. */
drhf7141992008-06-19 00:16:08 +0000278 p = 0;
danielk1977075c23a2008-09-01 18:34:20 +0000279 }else if( sqlite3GlobalConfig.bMemstat ){
drhfec00ea2008-06-14 16:56:21 +0000280 sqlite3_mutex_enter(mem0.mutex);
drhf7141992008-06-19 00:16:08 +0000281 mallocWithAlarm(n, &p);
drhfec00ea2008-06-14 16:56:21 +0000282 sqlite3_mutex_leave(mem0.mutex);
283 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000284 p = sqlite3GlobalConfig.m.xMalloc(n);
drhfec00ea2008-06-14 16:56:21 +0000285 }
286 return p;
287}
288
289/*
290** This version of the memory allocation is for use by the application.
291** First make sure the memory subsystem is initialized, then do the
292** allocation.
293*/
294void *sqlite3_malloc(int n){
295#ifndef SQLITE_OMIT_AUTOINIT
296 if( sqlite3_initialize() ) return 0;
297#endif
298 return sqlite3Malloc(n);
299}
300
301/*
drhe5ae5732008-06-15 02:51:47 +0000302** Each thread may only have a single outstanding allocation from
drhfacf0302008-06-17 15:12:00 +0000303** xScratchMalloc(). We verify this constraint in the single-threaded
304** case by setting scratchAllocOut to 1 when an allocation
drhe5ae5732008-06-15 02:51:47 +0000305** is outstanding clearing it when the allocation is freed.
306*/
307#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
drhfacf0302008-06-17 15:12:00 +0000308static int scratchAllocOut = 0;
drhe5ae5732008-06-15 02:51:47 +0000309#endif
310
311
312/*
313** Allocate memory that is to be used and released right away.
314** This routine is similar to alloca() in that it is not intended
315** for situations where the memory might be held long-term. This
316** routine is intended to get memory to old large transient data
317** structures that would not normally fit on the stack of an
318** embedded processor.
319*/
drhfacf0302008-06-17 15:12:00 +0000320void *sqlite3ScratchMalloc(int n){
drhe5ae5732008-06-15 02:51:47 +0000321 void *p;
322 assert( n>0 );
drh9ac3fe92008-06-18 18:12:04 +0000323
drhe5ae5732008-06-15 02:51:47 +0000324#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
drh9ac3fe92008-06-18 18:12:04 +0000325 /* Verify that no more than one scratch allocation per thread
326 ** is outstanding at one time. (This is only checked in the
327 ** single-threaded case since checking in the multi-threaded case
328 ** would be much more complicated.) */
drhfacf0302008-06-17 15:12:00 +0000329 assert( scratchAllocOut==0 );
drhe5ae5732008-06-15 02:51:47 +0000330#endif
drh9ac3fe92008-06-18 18:12:04 +0000331
danielk1977075c23a2008-09-01 18:34:20 +0000332 if( sqlite3GlobalConfig.szScratch<n ){
drhf7141992008-06-19 00:16:08 +0000333 goto scratch_overflow;
334 }else{
335 sqlite3_mutex_enter(mem0.mutex);
336 if( mem0.nScratchFree==0 ){
337 sqlite3_mutex_leave(mem0.mutex);
338 goto scratch_overflow;
339 }else{
340 int i;
341 i = mem0.aScratchFree[--mem0.nScratchFree];
danielk1977075c23a2008-09-01 18:34:20 +0000342 i *= sqlite3GlobalConfig.szScratch;
drhf7141992008-06-19 00:16:08 +0000343 sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_USED, 1);
drhe50135e2008-08-05 17:53:22 +0000344 sqlite3StatusSet(SQLITE_STATUS_SCRATCH_SIZE, n);
danielk19778183e332008-08-29 17:56:12 +0000345 sqlite3_mutex_leave(mem0.mutex);
danielk1977075c23a2008-09-01 18:34:20 +0000346 p = (void*)&((char*)sqlite3GlobalConfig.pScratch)[i];
shane15301592008-12-16 17:20:38 +0000347 assert( (((u8*)p - (u8*)0) & 7)==0 );
drhf7141992008-06-19 00:16:08 +0000348 }
drhe5ae5732008-06-15 02:51:47 +0000349 }
drhf7141992008-06-19 00:16:08 +0000350#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
351 scratchAllocOut = p!=0;
352#endif
353
drhe5ae5732008-06-15 02:51:47 +0000354 return p;
drhf7141992008-06-19 00:16:08 +0000355
356scratch_overflow:
danielk1977075c23a2008-09-01 18:34:20 +0000357 if( sqlite3GlobalConfig.bMemstat ){
drhf7141992008-06-19 00:16:08 +0000358 sqlite3_mutex_enter(mem0.mutex);
drhe50135e2008-08-05 17:53:22 +0000359 sqlite3StatusSet(SQLITE_STATUS_SCRATCH_SIZE, n);
drhf7141992008-06-19 00:16:08 +0000360 n = mallocWithAlarm(n, &p);
361 if( p ) sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_OVERFLOW, n);
362 sqlite3_mutex_leave(mem0.mutex);
363 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000364 p = sqlite3GlobalConfig.m.xMalloc(n);
drhf7141992008-06-19 00:16:08 +0000365 }
366#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
367 scratchAllocOut = p!=0;
368#endif
369 return p;
drhe5ae5732008-06-15 02:51:47 +0000370}
drhfacf0302008-06-17 15:12:00 +0000371void sqlite3ScratchFree(void *p){
drhe5ae5732008-06-15 02:51:47 +0000372 if( p ){
drh9ac3fe92008-06-18 18:12:04 +0000373
drhe5ae5732008-06-15 02:51:47 +0000374#if SQLITE_THREADSAFE==0 && !defined(NDEBUG)
drh9ac3fe92008-06-18 18:12:04 +0000375 /* Verify that no more than one scratch allocation per thread
376 ** is outstanding at one time. (This is only checked in the
377 ** single-threaded case since checking in the multi-threaded case
378 ** would be much more complicated.) */
drhfacf0302008-06-17 15:12:00 +0000379 assert( scratchAllocOut==1 );
380 scratchAllocOut = 0;
drhe5ae5732008-06-15 02:51:47 +0000381#endif
drh9ac3fe92008-06-18 18:12:04 +0000382
danielk1977075c23a2008-09-01 18:34:20 +0000383 if( sqlite3GlobalConfig.pScratch==0
384 || p<sqlite3GlobalConfig.pScratch
drhf7141992008-06-19 00:16:08 +0000385 || p>=(void*)mem0.aScratchFree ){
danielk1977075c23a2008-09-01 18:34:20 +0000386 if( sqlite3GlobalConfig.bMemstat ){
drhf7141992008-06-19 00:16:08 +0000387 int iSize = sqlite3MallocSize(p);
388 sqlite3_mutex_enter(mem0.mutex);
389 sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_OVERFLOW, -iSize);
390 sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, -iSize);
danielk1977075c23a2008-09-01 18:34:20 +0000391 sqlite3GlobalConfig.m.xFree(p);
drhf7141992008-06-19 00:16:08 +0000392 sqlite3_mutex_leave(mem0.mutex);
393 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000394 sqlite3GlobalConfig.m.xFree(p);
drhf7141992008-06-19 00:16:08 +0000395 }
drh9ac3fe92008-06-18 18:12:04 +0000396 }else{
397 int i;
drh1bd10f82008-12-10 21:19:56 +0000398 i = (int)((u8*)p - (u8*)sqlite3GlobalConfig.pScratch);
danielk1977075c23a2008-09-01 18:34:20 +0000399 i /= sqlite3GlobalConfig.szScratch;
400 assert( i>=0 && i<sqlite3GlobalConfig.nScratch );
drhf7141992008-06-19 00:16:08 +0000401 sqlite3_mutex_enter(mem0.mutex);
danielk197700e13612008-11-17 19:18:54 +0000402 assert( mem0.nScratchFree<(u32)sqlite3GlobalConfig.nScratch );
drh9ac3fe92008-06-18 18:12:04 +0000403 mem0.aScratchFree[mem0.nScratchFree++] = i;
drhf7141992008-06-19 00:16:08 +0000404 sqlite3StatusAdd(SQLITE_STATUS_SCRATCH_USED, -1);
drh9ac3fe92008-06-18 18:12:04 +0000405 sqlite3_mutex_leave(mem0.mutex);
406 }
drhe5ae5732008-06-15 02:51:47 +0000407 }
408}
409
410/*
drh633e6d52008-07-28 19:34:53 +0000411** TRUE if p is a lookaside memory allocation from db
412*/
drh4150ebf2008-10-11 15:38:29 +0000413#ifndef SQLITE_OMIT_LOOKASIDE
drh633e6d52008-07-28 19:34:53 +0000414static int isLookaside(sqlite3 *db, void *p){
415 return db && p && p>=db->lookaside.pStart && p<db->lookaside.pEnd;
416}
drh4150ebf2008-10-11 15:38:29 +0000417#else
418#define isLookaside(A,B) 0
419#endif
drh633e6d52008-07-28 19:34:53 +0000420
421/*
drhfec00ea2008-06-14 16:56:21 +0000422** Return the size of a memory allocation previously obtained from
423** sqlite3Malloc() or sqlite3_malloc().
424*/
425int sqlite3MallocSize(void *p){
danielk1977075c23a2008-09-01 18:34:20 +0000426 return sqlite3GlobalConfig.m.xSize(p);
drhfec00ea2008-06-14 16:56:21 +0000427}
drh633e6d52008-07-28 19:34:53 +0000428int sqlite3DbMallocSize(sqlite3 *db, void *p){
drh6a1e0712008-12-05 15:24:15 +0000429 if( p==0 ){
430 return 0;
431 }else if( isLookaside(db, p) ){
drh633e6d52008-07-28 19:34:53 +0000432 return db->lookaside.sz;
433 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000434 return sqlite3GlobalConfig.m.xSize(p);
drh633e6d52008-07-28 19:34:53 +0000435 }
436}
drhfec00ea2008-06-14 16:56:21 +0000437
438/*
439** Free memory previously obtained from sqlite3Malloc().
440*/
441void sqlite3_free(void *p){
442 if( p==0 ) return;
danielk1977075c23a2008-09-01 18:34:20 +0000443 if( sqlite3GlobalConfig.bMemstat ){
drhfec00ea2008-06-14 16:56:21 +0000444 sqlite3_mutex_enter(mem0.mutex);
drhf7141992008-06-19 00:16:08 +0000445 sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, -sqlite3MallocSize(p));
danielk1977075c23a2008-09-01 18:34:20 +0000446 sqlite3GlobalConfig.m.xFree(p);
drhfec00ea2008-06-14 16:56:21 +0000447 sqlite3_mutex_leave(mem0.mutex);
448 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000449 sqlite3GlobalConfig.m.xFree(p);
drhfec00ea2008-06-14 16:56:21 +0000450 }
451}
452
453/*
drh633e6d52008-07-28 19:34:53 +0000454** Free memory that might be associated with a particular database
455** connection.
456*/
457void sqlite3DbFree(sqlite3 *db, void *p){
458 if( isLookaside(db, p) ){
459 LookasideSlot *pBuf = (LookasideSlot*)p;
460 pBuf->pNext = db->lookaside.pFree;
461 db->lookaside.pFree = pBuf;
462 db->lookaside.nOut--;
463 }else{
464 sqlite3_free(p);
465 }
466}
467
468/*
drhfec00ea2008-06-14 16:56:21 +0000469** Change the size of an existing memory allocation
470*/
471void *sqlite3Realloc(void *pOld, int nBytes){
472 int nOld, nNew;
473 void *pNew;
474 if( pOld==0 ){
475 return sqlite3Malloc(nBytes);
476 }
drh50b65682009-02-17 18:37:28 +0000477 if( nBytes<=0 || NEVER(nBytes>=0x7fffff00) ){
478 /* The NEVER(...) term is explained in comments on sqlite3Malloc() */
drhfec00ea2008-06-14 16:56:21 +0000479 sqlite3_free(pOld);
480 return 0;
481 }
482 nOld = sqlite3MallocSize(pOld);
danielk1977075c23a2008-09-01 18:34:20 +0000483 if( sqlite3GlobalConfig.bMemstat ){
drhfec00ea2008-06-14 16:56:21 +0000484 sqlite3_mutex_enter(mem0.mutex);
drhf7141992008-06-19 00:16:08 +0000485 sqlite3StatusSet(SQLITE_STATUS_MALLOC_SIZE, nBytes);
danielk1977075c23a2008-09-01 18:34:20 +0000486 nNew = sqlite3GlobalConfig.m.xRoundup(nBytes);
drhfec00ea2008-06-14 16:56:21 +0000487 if( nOld==nNew ){
488 pNew = pOld;
489 }else{
drhf7141992008-06-19 00:16:08 +0000490 if( sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED)+nNew-nOld >=
491 mem0.alarmThreshold ){
drhfec00ea2008-06-14 16:56:21 +0000492 sqlite3MallocAlarm(nNew-nOld);
493 }
danielk1977075c23a2008-09-01 18:34:20 +0000494 pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
danielk1977d09414c2008-06-19 18:17:49 +0000495 if( pNew==0 && mem0.alarmCallback ){
496 sqlite3MallocAlarm(nBytes);
danielk1977075c23a2008-09-01 18:34:20 +0000497 pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
drhfec00ea2008-06-14 16:56:21 +0000498 }
499 if( pNew ){
drhc702c7c2008-07-18 18:56:16 +0000500 nNew = sqlite3MallocSize(pNew);
drhf7141992008-06-19 00:16:08 +0000501 sqlite3StatusAdd(SQLITE_STATUS_MEMORY_USED, nNew-nOld);
drhfec00ea2008-06-14 16:56:21 +0000502 }
503 }
504 sqlite3_mutex_leave(mem0.mutex);
505 }else{
danielk1977075c23a2008-09-01 18:34:20 +0000506 pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nBytes);
drhfec00ea2008-06-14 16:56:21 +0000507 }
508 return pNew;
509}
510
511/*
512** The public interface to sqlite3Realloc. Make sure that the memory
513** subsystem is initialized prior to invoking sqliteRealloc.
514*/
515void *sqlite3_realloc(void *pOld, int n){
516#ifndef SQLITE_OMIT_AUTOINIT
517 if( sqlite3_initialize() ) return 0;
518#endif
519 return sqlite3Realloc(pOld, n);
520}
521
drha3152892007-05-05 11:48:52 +0000522
523/*
drh17435752007-08-16 04:30:38 +0000524** Allocate and zero memory.
drha3152892007-05-05 11:48:52 +0000525*/
drhfec00ea2008-06-14 16:56:21 +0000526void *sqlite3MallocZero(int n){
527 void *p = sqlite3Malloc(n);
drha3152892007-05-05 11:48:52 +0000528 if( p ){
529 memset(p, 0, n);
530 }
531 return p;
532}
drh17435752007-08-16 04:30:38 +0000533
534/*
535** Allocate and zero memory. If the allocation fails, make
536** the mallocFailed flag in the connection pointer.
537*/
drhfec00ea2008-06-14 16:56:21 +0000538void *sqlite3DbMallocZero(sqlite3 *db, int n){
danielk1977a1644fd2007-08-29 12:31:25 +0000539 void *p = sqlite3DbMallocRaw(db, n);
drh17435752007-08-16 04:30:38 +0000540 if( p ){
541 memset(p, 0, n);
drh17435752007-08-16 04:30:38 +0000542 }
543 return p;
544}
545
546/*
547** Allocate and zero memory. If the allocation fails, make
548** the mallocFailed flag in the connection pointer.
drhddecae72008-10-11 17:35:16 +0000549**
550** If db!=0 and db->mallocFailed is true (indicating a prior malloc
551** failure on the same database connection) then always return 0.
552** Hence for a particular database connection, once malloc starts
553** failing, it fails consistently until mallocFailed is reset.
554** This is an important assumption. There are many places in the
555** code that do things like this:
556**
557** int *a = (int*)sqlite3DbMallocRaw(db, 100);
558** int *b = (int*)sqlite3DbMallocRaw(db, 200);
559** if( b ) a[10] = 9;
560**
561** In other words, if a subsequent malloc (ex: "b") worked, it is assumed
562** that all prior mallocs (ex: "a") worked too.
drh17435752007-08-16 04:30:38 +0000563*/
drhfec00ea2008-06-14 16:56:21 +0000564void *sqlite3DbMallocRaw(sqlite3 *db, int n){
drh633e6d52008-07-28 19:34:53 +0000565 void *p;
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;
600 if( db->mallocFailed==0 ){
drh633e6d52008-07-28 19:34:53 +0000601 if( p==0 ){
602 return sqlite3DbMallocRaw(db, n);
603 }
604 if( isLookaside(db, p) ){
605 if( n<=db->lookaside.sz ){
606 return p;
607 }
608 pNew = sqlite3DbMallocRaw(db, n);
609 if( pNew ){
610 memcpy(pNew, p, db->lookaside.sz);
611 sqlite3DbFree(db, p);
612 }
613 }else{
614 pNew = sqlite3_realloc(p, n);
615 if( !pNew ){
616 db->mallocFailed = 1;
617 }
danielk1977a1644fd2007-08-29 12:31:25 +0000618 }
619 }
620 return pNew;
621}
622
drh17435752007-08-16 04:30:38 +0000623/*
624** Attempt to reallocate p. If the reallocation fails, then free p
625** and set the mallocFailed flag in the database connection.
626*/
627void *sqlite3DbReallocOrFree(sqlite3 *db, void *p, int n){
drha3152892007-05-05 11:48:52 +0000628 void *pNew;
danielk1977a1644fd2007-08-29 12:31:25 +0000629 pNew = sqlite3DbRealloc(db, p, n);
drha3152892007-05-05 11:48:52 +0000630 if( !pNew ){
drh633e6d52008-07-28 19:34:53 +0000631 sqlite3DbFree(db, p);
drha3152892007-05-05 11:48:52 +0000632 }
633 return pNew;
634}
635
drha3152892007-05-05 11:48:52 +0000636/*
637** Make a copy of a string in memory obtained from sqliteMalloc(). These
638** functions call sqlite3MallocRaw() directly instead of sqliteMalloc(). This
639** is because when memory debugging is turned on, these two functions are
640** called via macros that record the current file and line number in the
641** ThreadData structure.
642*/
drh633e6d52008-07-28 19:34:53 +0000643char *sqlite3DbStrDup(sqlite3 *db, const char *z){
drha3152892007-05-05 11:48:52 +0000644 char *zNew;
drh633e6d52008-07-28 19:34:53 +0000645 size_t n;
646 if( z==0 ){
647 return 0;
648 }
drhea678832008-12-10 19:26:22 +0000649 n = (db ? sqlite3Strlen(db, z) : sqlite3Strlen30(z))+1;
drh633e6d52008-07-28 19:34:53 +0000650 assert( (n&0x7fffffff)==n );
651 zNew = sqlite3DbMallocRaw(db, (int)n);
drha3152892007-05-05 11:48:52 +0000652 if( zNew ){
653 memcpy(zNew, z, n);
danielk19771e536952007-08-16 10:09:01 +0000654 }
655 return zNew;
656}
657char *sqlite3DbStrNDup(sqlite3 *db, const char *z, int n){
drh633e6d52008-07-28 19:34:53 +0000658 char *zNew;
659 if( z==0 ){
660 return 0;
661 }
662 assert( (n&0x7fffffff)==n );
663 zNew = sqlite3DbMallocRaw(db, n+1);
664 if( zNew ){
665 memcpy(zNew, z, n);
666 zNew[n] = 0;
danielk19771e536952007-08-16 10:09:01 +0000667 }
668 return zNew;
669}
670
drha3152892007-05-05 11:48:52 +0000671/*
drhf089aa42008-07-08 19:34:06 +0000672** Create a string from the zFromat argument and the va_list that follows.
673** Store the string in memory obtained from sqliteMalloc() and make *pz
674** point to that string.
drha3152892007-05-05 11:48:52 +0000675*/
drhf089aa42008-07-08 19:34:06 +0000676void sqlite3SetString(char **pz, sqlite3 *db, const char *zFormat, ...){
drha3152892007-05-05 11:48:52 +0000677 va_list ap;
drhf089aa42008-07-08 19:34:06 +0000678 char *z;
drha3152892007-05-05 11:48:52 +0000679
drhf089aa42008-07-08 19:34:06 +0000680 va_start(ap, zFormat);
681 z = sqlite3VMPrintf(db, zFormat, ap);
drha3152892007-05-05 11:48:52 +0000682 va_end(ap);
drh633e6d52008-07-28 19:34:53 +0000683 sqlite3DbFree(db, *pz);
drhf089aa42008-07-08 19:34:06 +0000684 *pz = z;
drha3152892007-05-05 11:48:52 +0000685}
686
687
688/*
689** This function must be called before exiting any API function (i.e.
drh17435752007-08-16 04:30:38 +0000690** returning control to the user) that has called sqlite3_malloc or
691** sqlite3_realloc.
drha3152892007-05-05 11:48:52 +0000692**
693** The returned value is normally a copy of the second argument to this
shanebe217792009-03-05 04:20:31 +0000694** function. However, if a malloc() failure has occurred since the previous
drha3152892007-05-05 11:48:52 +0000695** invocation SQLITE_NOMEM is returned instead.
696**
shanebe217792009-03-05 04:20:31 +0000697** If the first argument, db, is not NULL and a malloc() error has occurred,
drha3152892007-05-05 11:48:52 +0000698** then the connection error-code (the value returned by sqlite3_errcode())
699** is set to SQLITE_NOMEM.
700*/
drha3152892007-05-05 11:48:52 +0000701int sqlite3ApiExit(sqlite3* db, int rc){
danielk1977a1644fd2007-08-29 12:31:25 +0000702 /* If the db handle is not NULL, then we must hold the connection handle
703 ** mutex here. Otherwise the read (and possible write) of db->mallocFailed
704 ** is unsafe, as is the call to sqlite3Error().
705 */
706 assert( !db || sqlite3_mutex_held(db->mutex) );
danielk197798c21902008-09-23 16:41:29 +0000707 if( db && (db->mallocFailed || rc==SQLITE_IOERR_NOMEM) ){
drha3152892007-05-05 11:48:52 +0000708 sqlite3Error(db, SQLITE_NOMEM, 0);
drh17435752007-08-16 04:30:38 +0000709 db->mallocFailed = 0;
drha3152892007-05-05 11:48:52 +0000710 rc = SQLITE_NOMEM;
711 }
712 return rc & (db ? db->errMask : 0xff);
713}