blob: 54ba36315071096131a0e054ce46fbd0159dc7e1 [file] [log] [blame]
drha059ad02001-04-17 20:09:11 +00001/*
drh9e572e62004-04-23 23:43:10 +00002** 2004 April 6
drha059ad02001-04-17 20:09:11 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drha059ad02001-04-17 20:09:11 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drha059ad02001-04-17 20:09:11 +000010**
11*************************************************************************
danielk1977518002e2008-09-05 05:02:46 +000012** $Id: btree.c,v 1.509 2008/09/05 05:02:47 danielk1977 Exp $
drh8b2f49b2001-06-08 00:21:52 +000013**
14** This file implements a external (disk-based) database using BTrees.
drha3152892007-05-05 11:48:52 +000015** See the header comment on "btreeInt.h" for additional information.
16** Including a description of file format and an overview of operation.
drha059ad02001-04-17 20:09:11 +000017*/
drha3152892007-05-05 11:48:52 +000018#include "btreeInt.h"
paulb95a8862003-04-01 21:16:41 +000019
drh8c42ca92001-06-22 19:15:00 +000020/*
drha3152892007-05-05 11:48:52 +000021** The header string that appears at the beginning of every
22** SQLite database.
drh556b2a22005-06-14 16:04:05 +000023*/
drh556b2a22005-06-14 16:04:05 +000024static const char zMagicHeader[] = SQLITE_FILE_HEADER;
drh08ed44e2001-04-29 23:32:55 +000025
drh8c42ca92001-06-22 19:15:00 +000026/*
drha3152892007-05-05 11:48:52 +000027** Set this global variable to 1 to enable tracing using the TRACE
28** macro.
drh615ae552005-01-16 23:21:00 +000029*/
drhe8f52c52008-07-12 14:52:20 +000030#if 0
mlcreech3a00f902008-03-04 17:45:01 +000031int sqlite3BtreeTrace=0; /* True to enable tracing */
drhe8f52c52008-07-12 14:52:20 +000032# define TRACE(X) if(sqlite3BtreeTrace){printf X;fflush(stdout);}
33#else
34# define TRACE(X)
drh615ae552005-01-16 23:21:00 +000035#endif
drh615ae552005-01-16 23:21:00 +000036
drh86f8c192007-08-22 00:39:19 +000037
38
drhe53831d2007-08-17 01:14:38 +000039#ifndef SQLITE_OMIT_SHARED_CACHE
40/*
danielk1977502b4e02008-09-02 14:07:24 +000041** A list of BtShared objects that are eligible for participation
42** in shared cache. This variable has file scope during normal builds,
43** but the test harness needs to access it so we make it global for
44** test builds.
drhe53831d2007-08-17 01:14:38 +000045*/
46#ifdef SQLITE_TEST
drh78f82d12008-09-02 00:52:52 +000047BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
drhe53831d2007-08-17 01:14:38 +000048#else
drh78f82d12008-09-02 00:52:52 +000049static BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
drhe53831d2007-08-17 01:14:38 +000050#endif
drhe53831d2007-08-17 01:14:38 +000051#endif /* SQLITE_OMIT_SHARED_CACHE */
52
53#ifndef SQLITE_OMIT_SHARED_CACHE
54/*
55** Enable or disable the shared pager and schema features.
56**
57** This routine has no effect on existing database connections.
58** The shared cache setting effects only future calls to
59** sqlite3_open(), sqlite3_open16(), or sqlite3_open_v2().
60*/
61int sqlite3_enable_shared_cache(int enable){
danielk1977502b4e02008-09-02 14:07:24 +000062 sqlite3GlobalConfig.sharedCacheEnabled = enable;
drhe53831d2007-08-17 01:14:38 +000063 return SQLITE_OK;
64}
65#endif
66
drhd677b3d2007-08-20 22:48:41 +000067
drh615ae552005-01-16 23:21:00 +000068/*
drh66cbd152004-09-01 16:12:25 +000069** Forward declaration
70*/
danielk19773588ceb2008-06-10 17:30:26 +000071static int checkReadLocks(Btree*, Pgno, BtCursor*, i64);
drh66cbd152004-09-01 16:12:25 +000072
danielk1977aef0bf62005-12-30 16:28:01 +000073
74#ifdef SQLITE_OMIT_SHARED_CACHE
75 /*
76 ** The functions queryTableLock(), lockTable() and unlockAllTables()
77 ** manipulate entries in the BtShared.pLock linked list used to store
78 ** shared-cache table level locks. If the library is compiled with the
79 ** shared-cache feature disabled, then there is only ever one user
danielk1977da184232006-01-05 11:34:32 +000080 ** of each BtShared structure and so this locking is not necessary.
81 ** So define the lock related functions as no-ops.
danielk1977aef0bf62005-12-30 16:28:01 +000082 */
83 #define queryTableLock(a,b,c) SQLITE_OK
84 #define lockTable(a,b,c) SQLITE_OK
danielk1977da184232006-01-05 11:34:32 +000085 #define unlockAllTables(a)
drhe53831d2007-08-17 01:14:38 +000086#endif
danielk1977aef0bf62005-12-30 16:28:01 +000087
drhe53831d2007-08-17 01:14:38 +000088#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977da184232006-01-05 11:34:32 +000089/*
danielk1977aef0bf62005-12-30 16:28:01 +000090** Query to see if btree handle p may obtain a lock of type eLock
91** (READ_LOCK or WRITE_LOCK) on the table with root-page iTab. Return
92** SQLITE_OK if the lock may be obtained (by calling lockTable()), or
danielk1977c87d34d2006-01-06 13:00:28 +000093** SQLITE_LOCKED if not.
danielk1977aef0bf62005-12-30 16:28:01 +000094*/
95static int queryTableLock(Btree *p, Pgno iTab, u8 eLock){
96 BtShared *pBt = p->pBt;
97 BtLock *pIter;
98
drh1fee73e2007-08-29 04:00:57 +000099 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000100 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
101 assert( p->db!=0 );
drhd677b3d2007-08-20 22:48:41 +0000102
danielk1977da184232006-01-05 11:34:32 +0000103 /* This is a no-op if the shared-cache is not enabled */
drhe53831d2007-08-17 01:14:38 +0000104 if( !p->sharable ){
danielk1977da184232006-01-05 11:34:32 +0000105 return SQLITE_OK;
106 }
107
danielk1977641b0f42007-12-21 04:47:25 +0000108 /* If some other connection is holding an exclusive lock, the
109 ** requested lock may not be obtained.
110 */
111 if( pBt->pExclusive && pBt->pExclusive!=p ){
112 return SQLITE_LOCKED;
113 }
114
danielk1977da184232006-01-05 11:34:32 +0000115 /* This (along with lockTable()) is where the ReadUncommitted flag is
116 ** dealt with. If the caller is querying for a read-lock and the flag is
117 ** set, it is unconditionally granted - even if there are write-locks
118 ** on the table. If a write-lock is requested, the ReadUncommitted flag
119 ** is not considered.
120 **
121 ** In function lockTable(), if a read-lock is demanded and the
122 ** ReadUncommitted flag is set, no entry is added to the locks list
123 ** (BtShared.pLock).
124 **
125 ** To summarize: If the ReadUncommitted flag is set, then read cursors do
126 ** not create or respect table locks. The locking procedure for a
127 ** write-cursor does not change.
128 */
129 if(
drhe5fe6902007-12-07 18:55:28 +0000130 0==(p->db->flags&SQLITE_ReadUncommitted) ||
danielk1977da184232006-01-05 11:34:32 +0000131 eLock==WRITE_LOCK ||
drh47ded162006-01-06 01:42:58 +0000132 iTab==MASTER_ROOT
danielk1977da184232006-01-05 11:34:32 +0000133 ){
134 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
135 if( pIter->pBtree!=p && pIter->iTable==iTab &&
136 (pIter->eLock!=eLock || eLock!=READ_LOCK) ){
danielk1977c87d34d2006-01-06 13:00:28 +0000137 return SQLITE_LOCKED;
danielk1977da184232006-01-05 11:34:32 +0000138 }
danielk1977aef0bf62005-12-30 16:28:01 +0000139 }
140 }
141 return SQLITE_OK;
142}
drhe53831d2007-08-17 01:14:38 +0000143#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000144
drhe53831d2007-08-17 01:14:38 +0000145#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000146/*
147** Add a lock on the table with root-page iTable to the shared-btree used
148** by Btree handle p. Parameter eLock must be either READ_LOCK or
149** WRITE_LOCK.
150**
151** SQLITE_OK is returned if the lock is added successfully. SQLITE_BUSY and
152** SQLITE_NOMEM may also be returned.
153*/
154static int lockTable(Btree *p, Pgno iTable, u8 eLock){
155 BtShared *pBt = p->pBt;
156 BtLock *pLock = 0;
157 BtLock *pIter;
158
drh1fee73e2007-08-29 04:00:57 +0000159 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000160 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
161 assert( p->db!=0 );
drhd677b3d2007-08-20 22:48:41 +0000162
danielk1977da184232006-01-05 11:34:32 +0000163 /* This is a no-op if the shared-cache is not enabled */
drhe53831d2007-08-17 01:14:38 +0000164 if( !p->sharable ){
danielk1977da184232006-01-05 11:34:32 +0000165 return SQLITE_OK;
166 }
167
danielk1977aef0bf62005-12-30 16:28:01 +0000168 assert( SQLITE_OK==queryTableLock(p, iTable, eLock) );
169
danielk1977da184232006-01-05 11:34:32 +0000170 /* If the read-uncommitted flag is set and a read-lock is requested,
171 ** return early without adding an entry to the BtShared.pLock list. See
172 ** comment in function queryTableLock() for more info on handling
173 ** the ReadUncommitted flag.
174 */
175 if(
drhe5fe6902007-12-07 18:55:28 +0000176 (p->db->flags&SQLITE_ReadUncommitted) &&
danielk1977da184232006-01-05 11:34:32 +0000177 (eLock==READ_LOCK) &&
drh47ded162006-01-06 01:42:58 +0000178 iTable!=MASTER_ROOT
danielk1977da184232006-01-05 11:34:32 +0000179 ){
180 return SQLITE_OK;
181 }
182
danielk1977aef0bf62005-12-30 16:28:01 +0000183 /* First search the list for an existing lock on this table. */
184 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
185 if( pIter->iTable==iTable && pIter->pBtree==p ){
186 pLock = pIter;
187 break;
188 }
189 }
190
191 /* If the above search did not find a BtLock struct associating Btree p
192 ** with table iTable, allocate one and link it into the list.
193 */
194 if( !pLock ){
drh17435752007-08-16 04:30:38 +0000195 pLock = (BtLock *)sqlite3MallocZero(sizeof(BtLock));
danielk1977aef0bf62005-12-30 16:28:01 +0000196 if( !pLock ){
197 return SQLITE_NOMEM;
198 }
199 pLock->iTable = iTable;
200 pLock->pBtree = p;
201 pLock->pNext = pBt->pLock;
202 pBt->pLock = pLock;
203 }
204
205 /* Set the BtLock.eLock variable to the maximum of the current lock
206 ** and the requested lock. This means if a write-lock was already held
207 ** and a read-lock requested, we don't incorrectly downgrade the lock.
208 */
209 assert( WRITE_LOCK>READ_LOCK );
danielk19775118b912005-12-30 16:31:53 +0000210 if( eLock>pLock->eLock ){
211 pLock->eLock = eLock;
212 }
danielk1977aef0bf62005-12-30 16:28:01 +0000213
214 return SQLITE_OK;
215}
drhe53831d2007-08-17 01:14:38 +0000216#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000217
drhe53831d2007-08-17 01:14:38 +0000218#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000219/*
220** Release all the table locks (locks obtained via calls to the lockTable()
221** procedure) held by Btree handle p.
222*/
223static void unlockAllTables(Btree *p){
danielk1977641b0f42007-12-21 04:47:25 +0000224 BtShared *pBt = p->pBt;
225 BtLock **ppIter = &pBt->pLock;
danielk1977da184232006-01-05 11:34:32 +0000226
drh1fee73e2007-08-29 04:00:57 +0000227 assert( sqlite3BtreeHoldsMutex(p) );
drhe53831d2007-08-17 01:14:38 +0000228 assert( p->sharable || 0==*ppIter );
danielk1977da184232006-01-05 11:34:32 +0000229
danielk1977aef0bf62005-12-30 16:28:01 +0000230 while( *ppIter ){
231 BtLock *pLock = *ppIter;
danielk1977641b0f42007-12-21 04:47:25 +0000232 assert( pBt->pExclusive==0 || pBt->pExclusive==pLock->pBtree );
danielk1977aef0bf62005-12-30 16:28:01 +0000233 if( pLock->pBtree==p ){
234 *ppIter = pLock->pNext;
drh17435752007-08-16 04:30:38 +0000235 sqlite3_free(pLock);
danielk1977aef0bf62005-12-30 16:28:01 +0000236 }else{
237 ppIter = &pLock->pNext;
238 }
239 }
danielk1977641b0f42007-12-21 04:47:25 +0000240
241 if( pBt->pExclusive==p ){
242 pBt->pExclusive = 0;
243 }
danielk1977aef0bf62005-12-30 16:28:01 +0000244}
245#endif /* SQLITE_OMIT_SHARED_CACHE */
246
drh980b1a72006-08-16 16:42:48 +0000247static void releasePage(MemPage *pPage); /* Forward reference */
248
drh1fee73e2007-08-29 04:00:57 +0000249/*
250** Verify that the cursor holds a mutex on the BtShared
251*/
252#ifndef NDEBUG
253static int cursorHoldsMutex(BtCursor *p){
drhff0587c2007-08-29 17:43:19 +0000254 return sqlite3_mutex_held(p->pBt->mutex);
drh1fee73e2007-08-29 04:00:57 +0000255}
256#endif
257
258
danielk197792d4d7a2007-05-04 12:05:56 +0000259#ifndef SQLITE_OMIT_INCRBLOB
260/*
261** Invalidate the overflow page-list cache for cursor pCur, if any.
262*/
263static void invalidateOverflowCache(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000264 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000265 sqlite3_free(pCur->aOverflow);
danielk197792d4d7a2007-05-04 12:05:56 +0000266 pCur->aOverflow = 0;
267}
268
269/*
270** Invalidate the overflow page-list cache for all cursors opened
271** on the shared btree structure pBt.
272*/
273static void invalidateAllOverflowCache(BtShared *pBt){
274 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000275 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +0000276 for(p=pBt->pCursor; p; p=p->pNext){
277 invalidateOverflowCache(p);
278 }
279}
280#else
281 #define invalidateOverflowCache(x)
282 #define invalidateAllOverflowCache(x)
283#endif
284
drh980b1a72006-08-16 16:42:48 +0000285/*
286** Save the current cursor position in the variables BtCursor.nKey
287** and BtCursor.pKey. The cursor's state is set to CURSOR_REQUIRESEEK.
288*/
289static int saveCursorPosition(BtCursor *pCur){
290 int rc;
291
292 assert( CURSOR_VALID==pCur->eState );
293 assert( 0==pCur->pKey );
drh1fee73e2007-08-29 04:00:57 +0000294 assert( cursorHoldsMutex(pCur) );
drh980b1a72006-08-16 16:42:48 +0000295
296 rc = sqlite3BtreeKeySize(pCur, &pCur->nKey);
297
298 /* If this is an intKey table, then the above call to BtreeKeySize()
299 ** stores the integer key in pCur->nKey. In this case this value is
300 ** all that is required. Otherwise, if pCur is not open on an intKey
301 ** table, then malloc space for and store the pCur->nKey bytes of key
302 ** data.
303 */
304 if( rc==SQLITE_OK && 0==pCur->pPage->intKey){
drhe5ae5732008-06-15 02:51:47 +0000305 void *pKey = sqlite3Malloc(pCur->nKey);
drh980b1a72006-08-16 16:42:48 +0000306 if( pKey ){
307 rc = sqlite3BtreeKey(pCur, 0, pCur->nKey, pKey);
308 if( rc==SQLITE_OK ){
309 pCur->pKey = pKey;
310 }else{
drh17435752007-08-16 04:30:38 +0000311 sqlite3_free(pKey);
drh980b1a72006-08-16 16:42:48 +0000312 }
313 }else{
314 rc = SQLITE_NOMEM;
315 }
316 }
317 assert( !pCur->pPage->intKey || !pCur->pKey );
318
319 if( rc==SQLITE_OK ){
320 releasePage(pCur->pPage);
321 pCur->pPage = 0;
322 pCur->eState = CURSOR_REQUIRESEEK;
323 }
324
danielk197792d4d7a2007-05-04 12:05:56 +0000325 invalidateOverflowCache(pCur);
drh980b1a72006-08-16 16:42:48 +0000326 return rc;
327}
328
329/*
330** Save the positions of all cursors except pExcept open on the table
331** with root-page iRoot. Usually, this is called just before cursor
332** pExcept is used to modify the table (BtreeDelete() or BtreeInsert()).
333*/
334static int saveAllCursors(BtShared *pBt, Pgno iRoot, BtCursor *pExcept){
335 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000336 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +0000337 assert( pExcept==0 || pExcept->pBt==pBt );
drh980b1a72006-08-16 16:42:48 +0000338 for(p=pBt->pCursor; p; p=p->pNext){
339 if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) &&
340 p->eState==CURSOR_VALID ){
341 int rc = saveCursorPosition(p);
342 if( SQLITE_OK!=rc ){
343 return rc;
344 }
345 }
346 }
347 return SQLITE_OK;
348}
349
350/*
drhbf700f32007-03-31 02:36:44 +0000351** Clear the current cursor position.
352*/
353static void clearCursorPosition(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000354 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000355 sqlite3_free(pCur->pKey);
drhbf700f32007-03-31 02:36:44 +0000356 pCur->pKey = 0;
357 pCur->eState = CURSOR_INVALID;
358}
359
360/*
drh980b1a72006-08-16 16:42:48 +0000361** Restore the cursor to the position it was in (or as close to as possible)
362** when saveCursorPosition() was called. Note that this call deletes the
363** saved position info stored by saveCursorPosition(), so there can be
drha3460582008-07-11 21:02:53 +0000364** at most one effective restoreCursorPosition() call after each
drh980b1a72006-08-16 16:42:48 +0000365** saveCursorPosition().
drh980b1a72006-08-16 16:42:48 +0000366*/
drha3460582008-07-11 21:02:53 +0000367int sqlite3BtreeRestoreCursorPosition(BtCursor *pCur){
drhbf700f32007-03-31 02:36:44 +0000368 int rc;
drh1fee73e2007-08-29 04:00:57 +0000369 assert( cursorHoldsMutex(pCur) );
drhfb982642007-08-30 01:19:59 +0000370 assert( pCur->eState>=CURSOR_REQUIRESEEK );
371 if( pCur->eState==CURSOR_FAULT ){
372 return pCur->skip;
373 }
drh980b1a72006-08-16 16:42:48 +0000374 pCur->eState = CURSOR_INVALID;
drhe63d9992008-08-13 19:11:48 +0000375 rc = sqlite3BtreeMoveto(pCur, pCur->pKey, pCur->nKey, 0, &pCur->skip);
drh980b1a72006-08-16 16:42:48 +0000376 if( rc==SQLITE_OK ){
drh17435752007-08-16 04:30:38 +0000377 sqlite3_free(pCur->pKey);
drh980b1a72006-08-16 16:42:48 +0000378 pCur->pKey = 0;
drhbf700f32007-03-31 02:36:44 +0000379 assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_INVALID );
drh980b1a72006-08-16 16:42:48 +0000380 }
381 return rc;
382}
383
drha3460582008-07-11 21:02:53 +0000384#define restoreCursorPosition(p) \
drhfb982642007-08-30 01:19:59 +0000385 (p->eState>=CURSOR_REQUIRESEEK ? \
drha3460582008-07-11 21:02:53 +0000386 sqlite3BtreeRestoreCursorPosition(p) : \
drh16a9b832007-05-05 18:39:25 +0000387 SQLITE_OK)
drh980b1a72006-08-16 16:42:48 +0000388
drha3460582008-07-11 21:02:53 +0000389/*
390** Determine whether or not a cursor has moved from the position it
391** was last placed at. Cursor can move when the row they are pointing
392** at is deleted out from under them.
393**
394** This routine returns an error code if something goes wrong. The
395** integer *pHasMoved is set to one if the cursor has moved and 0 if not.
396*/
397int sqlite3BtreeCursorHasMoved(BtCursor *pCur, int *pHasMoved){
398 int rc;
399
400 rc = restoreCursorPosition(pCur);
401 if( rc ){
402 *pHasMoved = 1;
403 return rc;
404 }
405 if( pCur->eState!=CURSOR_VALID || pCur->skip!=0 ){
406 *pHasMoved = 1;
407 }else{
408 *pHasMoved = 0;
409 }
410 return SQLITE_OK;
411}
412
danielk1977599fcba2004-11-08 07:13:13 +0000413#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977afcdd022004-10-31 16:25:42 +0000414/*
drha3152892007-05-05 11:48:52 +0000415** Given a page number of a regular database page, return the page
416** number for the pointer-map page that contains the entry for the
417** input page number.
danielk1977afcdd022004-10-31 16:25:42 +0000418*/
danielk1977266664d2006-02-10 08:24:21 +0000419static Pgno ptrmapPageno(BtShared *pBt, Pgno pgno){
drhd677b3d2007-08-20 22:48:41 +0000420 int nPagesPerMapPage, iPtrMap, ret;
drh1fee73e2007-08-29 04:00:57 +0000421 assert( sqlite3_mutex_held(pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000422 nPagesPerMapPage = (pBt->usableSize/5)+1;
423 iPtrMap = (pgno-2)/nPagesPerMapPage;
424 ret = (iPtrMap*nPagesPerMapPage) + 2;
danielk1977266664d2006-02-10 08:24:21 +0000425 if( ret==PENDING_BYTE_PAGE(pBt) ){
426 ret++;
427 }
428 return ret;
429}
danielk1977a19df672004-11-03 11:37:07 +0000430
danielk1977afcdd022004-10-31 16:25:42 +0000431/*
danielk1977afcdd022004-10-31 16:25:42 +0000432** Write an entry into the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000433**
434** This routine updates the pointer map entry for page number 'key'
435** so that it maps to type 'eType' and parent page number 'pgno'.
436** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +0000437*/
danielk1977aef0bf62005-12-30 16:28:01 +0000438static int ptrmapPut(BtShared *pBt, Pgno key, u8 eType, Pgno parent){
danielk19773b8a05f2007-03-19 17:44:26 +0000439 DbPage *pDbPage; /* The pointer map page */
440 u8 *pPtrmap; /* The pointer map data */
441 Pgno iPtrmap; /* The pointer map page number */
442 int offset; /* Offset in pointer map page */
danielk1977afcdd022004-10-31 16:25:42 +0000443 int rc;
444
drh1fee73e2007-08-29 04:00:57 +0000445 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977266664d2006-02-10 08:24:21 +0000446 /* The master-journal page number must never be used as a pointer map page */
447 assert( 0==PTRMAP_ISPAGE(pBt, PENDING_BYTE_PAGE(pBt)) );
448
danielk1977ac11ee62005-01-15 12:45:51 +0000449 assert( pBt->autoVacuum );
danielk1977fdb7cdb2005-01-17 02:12:18 +0000450 if( key==0 ){
drh49285702005-09-17 15:20:26 +0000451 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +0000452 }
danielk1977266664d2006-02-10 08:24:21 +0000453 iPtrmap = PTRMAP_PAGENO(pBt, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000454 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage);
danielk1977687566d2004-11-02 12:56:41 +0000455 if( rc!=SQLITE_OK ){
danielk1977afcdd022004-10-31 16:25:42 +0000456 return rc;
457 }
danielk19778c666b12008-07-18 09:34:57 +0000458 offset = PTRMAP_PTROFFSET(iPtrmap, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000459 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000460
drh615ae552005-01-16 23:21:00 +0000461 if( eType!=pPtrmap[offset] || get4byte(&pPtrmap[offset+1])!=parent ){
462 TRACE(("PTRMAP_UPDATE: %d->(%d,%d)\n", key, eType, parent));
danielk19773b8a05f2007-03-19 17:44:26 +0000463 rc = sqlite3PagerWrite(pDbPage);
danielk19775558a8a2005-01-17 07:53:44 +0000464 if( rc==SQLITE_OK ){
465 pPtrmap[offset] = eType;
466 put4byte(&pPtrmap[offset+1], parent);
danielk1977afcdd022004-10-31 16:25:42 +0000467 }
danielk1977afcdd022004-10-31 16:25:42 +0000468 }
469
danielk19773b8a05f2007-03-19 17:44:26 +0000470 sqlite3PagerUnref(pDbPage);
danielk19775558a8a2005-01-17 07:53:44 +0000471 return rc;
danielk1977afcdd022004-10-31 16:25:42 +0000472}
473
474/*
475** Read an entry from the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000476**
477** This routine retrieves the pointer map entry for page 'key', writing
478** the type and parent page number to *pEType and *pPgno respectively.
479** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +0000480*/
danielk1977aef0bf62005-12-30 16:28:01 +0000481static int ptrmapGet(BtShared *pBt, Pgno key, u8 *pEType, Pgno *pPgno){
danielk19773b8a05f2007-03-19 17:44:26 +0000482 DbPage *pDbPage; /* The pointer map page */
danielk1977afcdd022004-10-31 16:25:42 +0000483 int iPtrmap; /* Pointer map page index */
484 u8 *pPtrmap; /* Pointer map page data */
485 int offset; /* Offset of entry in pointer map */
486 int rc;
487
drh1fee73e2007-08-29 04:00:57 +0000488 assert( sqlite3_mutex_held(pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000489
danielk1977266664d2006-02-10 08:24:21 +0000490 iPtrmap = PTRMAP_PAGENO(pBt, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000491 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000492 if( rc!=0 ){
493 return rc;
494 }
danielk19773b8a05f2007-03-19 17:44:26 +0000495 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000496
danielk19778c666b12008-07-18 09:34:57 +0000497 offset = PTRMAP_PTROFFSET(iPtrmap, key);
drh43617e92006-03-06 20:55:46 +0000498 assert( pEType!=0 );
499 *pEType = pPtrmap[offset];
danielk1977687566d2004-11-02 12:56:41 +0000500 if( pPgno ) *pPgno = get4byte(&pPtrmap[offset+1]);
danielk1977afcdd022004-10-31 16:25:42 +0000501
danielk19773b8a05f2007-03-19 17:44:26 +0000502 sqlite3PagerUnref(pDbPage);
drh49285702005-09-17 15:20:26 +0000503 if( *pEType<1 || *pEType>5 ) return SQLITE_CORRUPT_BKPT;
danielk1977afcdd022004-10-31 16:25:42 +0000504 return SQLITE_OK;
505}
506
danielk197785d90ca2008-07-19 14:25:15 +0000507#else /* if defined SQLITE_OMIT_AUTOVACUUM */
508 #define ptrmapPut(w,x,y,z) SQLITE_OK
509 #define ptrmapGet(w,x,y,z) SQLITE_OK
510 #define ptrmapPutOvfl(y,z) SQLITE_OK
511#endif
danielk1977afcdd022004-10-31 16:25:42 +0000512
drh0d316a42002-08-11 20:10:47 +0000513/*
drh271efa52004-05-30 19:19:05 +0000514** Given a btree page and a cell index (0 means the first cell on
515** the page, 1 means the second cell, and so forth) return a pointer
516** to the cell content.
517**
518** This routine works only for pages that do not contain overflow cells.
drh3aac2dd2004-04-26 14:10:20 +0000519*/
drh1688c862008-07-18 02:44:17 +0000520#define findCell(P,I) \
521 ((P)->aData + ((P)->maskPage & get2byte(&(P)->aData[(P)->cellOffset+2*(I)])))
drh43605152004-05-29 21:46:49 +0000522
523/*
drh93a960a2008-07-10 00:32:42 +0000524** This a more complex version of findCell() that works for
drh43605152004-05-29 21:46:49 +0000525** pages that do contain overflow cells. See insert
526*/
527static u8 *findOverflowCell(MemPage *pPage, int iCell){
528 int i;
drh1fee73e2007-08-29 04:00:57 +0000529 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh43605152004-05-29 21:46:49 +0000530 for(i=pPage->nOverflow-1; i>=0; i--){
drh6d08b4d2004-07-20 12:45:22 +0000531 int k;
532 struct _OvflCell *pOvfl;
533 pOvfl = &pPage->aOvfl[i];
534 k = pOvfl->idx;
535 if( k<=iCell ){
536 if( k==iCell ){
537 return pOvfl->pCell;
drh43605152004-05-29 21:46:49 +0000538 }
539 iCell--;
540 }
541 }
danielk19771cc5ed82007-05-16 17:28:43 +0000542 return findCell(pPage, iCell);
drh43605152004-05-29 21:46:49 +0000543}
544
545/*
546** Parse a cell content block and fill in the CellInfo structure. There
drh16a9b832007-05-05 18:39:25 +0000547** are two versions of this function. sqlite3BtreeParseCell() takes a
548** cell index as the second argument and sqlite3BtreeParseCellPtr()
549** takes a pointer to the body of the cell as its second argument.
danielk19771cc5ed82007-05-16 17:28:43 +0000550**
551** Within this file, the parseCell() macro can be called instead of
552** sqlite3BtreeParseCellPtr(). Using some compilers, this will be faster.
drh43605152004-05-29 21:46:49 +0000553*/
drh16a9b832007-05-05 18:39:25 +0000554void sqlite3BtreeParseCellPtr(
drh3aac2dd2004-04-26 14:10:20 +0000555 MemPage *pPage, /* Page containing the cell */
drh43605152004-05-29 21:46:49 +0000556 u8 *pCell, /* Pointer to the cell text. */
drh6f11bef2004-05-13 01:12:56 +0000557 CellInfo *pInfo /* Fill in this structure */
drh3aac2dd2004-04-26 14:10:20 +0000558){
drh271efa52004-05-30 19:19:05 +0000559 int n; /* Number bytes in cell content header */
560 u32 nPayload; /* Number of bytes of cell payload */
drh43605152004-05-29 21:46:49 +0000561
drh1fee73e2007-08-29 04:00:57 +0000562 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000563
drh43605152004-05-29 21:46:49 +0000564 pInfo->pCell = pCell;
drhab01f612004-05-22 02:55:23 +0000565 assert( pPage->leaf==0 || pPage->leaf==1 );
drh271efa52004-05-30 19:19:05 +0000566 n = pPage->childPtrSize;
567 assert( n==4-4*pPage->leaf );
drh504b6982006-01-22 21:52:56 +0000568 if( pPage->intKey ){
drh79df1f42008-07-18 00:57:33 +0000569 if( pPage->hasData ){
570 n += getVarint32(&pCell[n], nPayload);
571 }else{
572 nPayload = 0;
573 }
574 n += getVarint(&pCell[n], (u64*)&pInfo->nKey);
575 pInfo->nData = nPayload;
drh504b6982006-01-22 21:52:56 +0000576 }else{
drh79df1f42008-07-18 00:57:33 +0000577 pInfo->nData = 0;
578 n += getVarint32(&pCell[n], nPayload);
579 pInfo->nKey = nPayload;
drh6f11bef2004-05-13 01:12:56 +0000580 }
drh72365832007-03-06 15:53:44 +0000581 pInfo->nPayload = nPayload;
drh504b6982006-01-22 21:52:56 +0000582 pInfo->nHeader = n;
drh79df1f42008-07-18 00:57:33 +0000583 if( likely(nPayload<=pPage->maxLocal) ){
drh271efa52004-05-30 19:19:05 +0000584 /* This is the (easy) common case where the entire payload fits
585 ** on the local page. No overflow is required.
586 */
587 int nSize; /* Total size of cell content in bytes */
drh79df1f42008-07-18 00:57:33 +0000588 nSize = nPayload + n;
drh6f11bef2004-05-13 01:12:56 +0000589 pInfo->nLocal = nPayload;
590 pInfo->iOverflow = 0;
drh79df1f42008-07-18 00:57:33 +0000591 if( (nSize & ~3)==0 ){
drh271efa52004-05-30 19:19:05 +0000592 nSize = 4; /* Minimum cell size is 4 */
drh43605152004-05-29 21:46:49 +0000593 }
drh271efa52004-05-30 19:19:05 +0000594 pInfo->nSize = nSize;
drh6f11bef2004-05-13 01:12:56 +0000595 }else{
drh271efa52004-05-30 19:19:05 +0000596 /* If the payload will not fit completely on the local page, we have
597 ** to decide how much to store locally and how much to spill onto
598 ** overflow pages. The strategy is to minimize the amount of unused
599 ** space on overflow pages while keeping the amount of local storage
600 ** in between minLocal and maxLocal.
601 **
602 ** Warning: changing the way overflow payload is distributed in any
603 ** way will result in an incompatible file format.
604 */
605 int minLocal; /* Minimum amount of payload held locally */
606 int maxLocal; /* Maximum amount of payload held locally */
607 int surplus; /* Overflow payload available for local storage */
608
609 minLocal = pPage->minLocal;
610 maxLocal = pPage->maxLocal;
611 surplus = minLocal + (nPayload - minLocal)%(pPage->pBt->usableSize - 4);
drh6f11bef2004-05-13 01:12:56 +0000612 if( surplus <= maxLocal ){
613 pInfo->nLocal = surplus;
614 }else{
615 pInfo->nLocal = minLocal;
616 }
617 pInfo->iOverflow = pInfo->nLocal + n;
618 pInfo->nSize = pInfo->iOverflow + 4;
619 }
drh3aac2dd2004-04-26 14:10:20 +0000620}
danielk19771cc5ed82007-05-16 17:28:43 +0000621#define parseCell(pPage, iCell, pInfo) \
622 sqlite3BtreeParseCellPtr((pPage), findCell((pPage), (iCell)), (pInfo))
drh16a9b832007-05-05 18:39:25 +0000623void sqlite3BtreeParseCell(
drh43605152004-05-29 21:46:49 +0000624 MemPage *pPage, /* Page containing the cell */
625 int iCell, /* The cell index. First cell is 0 */
626 CellInfo *pInfo /* Fill in this structure */
627){
danielk19771cc5ed82007-05-16 17:28:43 +0000628 parseCell(pPage, iCell, pInfo);
drh43605152004-05-29 21:46:49 +0000629}
drh3aac2dd2004-04-26 14:10:20 +0000630
631/*
drh43605152004-05-29 21:46:49 +0000632** Compute the total number of bytes that a Cell needs in the cell
633** data area of the btree-page. The return number includes the cell
634** data header and the local payload, but not any overflow page or
635** the space used by the cell pointer.
drh3b7511c2001-05-26 13:15:44 +0000636*/
danielk1977bc6ada42004-06-30 08:20:16 +0000637#ifndef NDEBUG
drha9121e42008-02-19 14:59:35 +0000638static u16 cellSize(MemPage *pPage, int iCell){
drh6f11bef2004-05-13 01:12:56 +0000639 CellInfo info;
drh16a9b832007-05-05 18:39:25 +0000640 sqlite3BtreeParseCell(pPage, iCell, &info);
drh43605152004-05-29 21:46:49 +0000641 return info.nSize;
642}
danielk1977bc6ada42004-06-30 08:20:16 +0000643#endif
drha9121e42008-02-19 14:59:35 +0000644static u16 cellSizePtr(MemPage *pPage, u8 *pCell){
drh43605152004-05-29 21:46:49 +0000645 CellInfo info;
drh16a9b832007-05-05 18:39:25 +0000646 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +0000647 return info.nSize;
drh3b7511c2001-05-26 13:15:44 +0000648}
649
danielk197779a40da2005-01-16 08:00:01 +0000650#ifndef SQLITE_OMIT_AUTOVACUUM
drh3b7511c2001-05-26 13:15:44 +0000651/*
danielk197726836652005-01-17 01:33:13 +0000652** If the cell pCell, part of page pPage contains a pointer
danielk197779a40da2005-01-16 08:00:01 +0000653** to an overflow page, insert an entry into the pointer-map
654** for the overflow page.
danielk1977ac11ee62005-01-15 12:45:51 +0000655*/
danielk197726836652005-01-17 01:33:13 +0000656static int ptrmapPutOvflPtr(MemPage *pPage, u8 *pCell){
drhfa67c3c2008-07-11 02:21:40 +0000657 CellInfo info;
658 assert( pCell!=0 );
659 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
660 assert( (info.nData+(pPage->intKey?0:info.nKey))==info.nPayload );
661 if( (info.nData+(pPage->intKey?0:info.nKey))>info.nLocal ){
662 Pgno ovfl = get4byte(&pCell[info.iOverflow]);
663 return ptrmapPut(pPage->pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno);
danielk1977ac11ee62005-01-15 12:45:51 +0000664 }
danielk197779a40da2005-01-16 08:00:01 +0000665 return SQLITE_OK;
danielk1977ac11ee62005-01-15 12:45:51 +0000666}
danielk197726836652005-01-17 01:33:13 +0000667/*
668** If the cell with index iCell on page pPage contains a pointer
669** to an overflow page, insert an entry into the pointer-map
670** for the overflow page.
671*/
672static int ptrmapPutOvfl(MemPage *pPage, int iCell){
673 u8 *pCell;
drh1fee73e2007-08-29 04:00:57 +0000674 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk197726836652005-01-17 01:33:13 +0000675 pCell = findOverflowCell(pPage, iCell);
676 return ptrmapPutOvflPtr(pPage, pCell);
677}
danielk197779a40da2005-01-16 08:00:01 +0000678#endif
679
danielk1977ac11ee62005-01-15 12:45:51 +0000680
drhda200cc2004-05-09 11:51:38 +0000681/*
drh72f82862001-05-24 21:06:34 +0000682** Defragment the page given. All Cells are moved to the
drh3a4a2d42005-11-24 14:24:28 +0000683** end of the page and all free space is collected into one
684** big FreeBlk that occurs in between the header and cell
drh31beae92005-11-24 14:34:36 +0000685** pointer array and the cell content area.
drh365d68f2001-05-11 11:02:46 +0000686*/
danielk1977474b7cc2008-07-09 11:49:46 +0000687static void defragmentPage(MemPage *pPage){
drh43605152004-05-29 21:46:49 +0000688 int i; /* Loop counter */
689 int pc; /* Address of a i-th cell */
690 int addr; /* Offset of first byte after cell pointer array */
691 int hdr; /* Offset to the page header */
692 int size; /* Size of a cell */
693 int usableSize; /* Number of usable bytes on a page */
694 int cellOffset; /* Offset to the cell pointer array */
drh281b21d2008-08-22 12:57:08 +0000695 int cbrk; /* Offset to the cell content area */
drh43605152004-05-29 21:46:49 +0000696 int nCell; /* Number of cells on the page */
drh2e38c322004-09-03 18:38:44 +0000697 unsigned char *data; /* The page data */
698 unsigned char *temp; /* Temp area for cell content */
drh2af926b2001-05-15 00:39:25 +0000699
danielk19773b8a05f2007-03-19 17:44:26 +0000700 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +0000701 assert( pPage->pBt!=0 );
drh90f5ecb2004-07-22 01:19:35 +0000702 assert( pPage->pBt->usableSize <= SQLITE_MAX_PAGE_SIZE );
drh43605152004-05-29 21:46:49 +0000703 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +0000704 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh26b79942007-11-28 16:19:56 +0000705 temp = sqlite3PagerTempSpace(pPage->pBt->pPager);
drh43605152004-05-29 21:46:49 +0000706 data = pPage->aData;
drh9e572e62004-04-23 23:43:10 +0000707 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +0000708 cellOffset = pPage->cellOffset;
709 nCell = pPage->nCell;
710 assert( nCell==get2byte(&data[hdr+3]) );
711 usableSize = pPage->pBt->usableSize;
drh281b21d2008-08-22 12:57:08 +0000712 cbrk = get2byte(&data[hdr+5]);
713 memcpy(&temp[cbrk], &data[cbrk], usableSize - cbrk);
714 cbrk = usableSize;
drh43605152004-05-29 21:46:49 +0000715 for(i=0; i<nCell; i++){
716 u8 *pAddr; /* The i-th cell pointer */
717 pAddr = &data[cellOffset + i*2];
718 pc = get2byte(pAddr);
719 assert( pc<pPage->pBt->usableSize );
720 size = cellSizePtr(pPage, &temp[pc]);
drh281b21d2008-08-22 12:57:08 +0000721 cbrk -= size;
722 memcpy(&data[cbrk], &temp[pc], size);
723 put2byte(pAddr, cbrk);
drh2af926b2001-05-15 00:39:25 +0000724 }
drh281b21d2008-08-22 12:57:08 +0000725 assert( cbrk>=cellOffset+2*nCell );
726 put2byte(&data[hdr+5], cbrk);
drh43605152004-05-29 21:46:49 +0000727 data[hdr+1] = 0;
728 data[hdr+2] = 0;
729 data[hdr+7] = 0;
730 addr = cellOffset+2*nCell;
drh281b21d2008-08-22 12:57:08 +0000731 memset(&data[addr], 0, cbrk-addr);
drh365d68f2001-05-11 11:02:46 +0000732}
733
drha059ad02001-04-17 20:09:11 +0000734/*
drh43605152004-05-29 21:46:49 +0000735** Allocate nByte bytes of space on a page.
drhbd03cae2001-06-02 02:40:57 +0000736**
drh9e572e62004-04-23 23:43:10 +0000737** Return the index into pPage->aData[] of the first byte of
drhfa67c3c2008-07-11 02:21:40 +0000738** the new allocation. The caller guarantees that there is enough
739** space. This routine will never fail.
drh2af926b2001-05-15 00:39:25 +0000740**
drh72f82862001-05-24 21:06:34 +0000741** If the page contains nBytes of free space but does not contain
drh8b2f49b2001-06-08 00:21:52 +0000742** nBytes of contiguous free space, then this routine automatically
743** calls defragementPage() to consolidate all free space before
744** allocating the new chunk.
drh7e3b0a02001-04-28 16:52:40 +0000745*/
drh9e572e62004-04-23 23:43:10 +0000746static int allocateSpace(MemPage *pPage, int nByte){
drh3aac2dd2004-04-26 14:10:20 +0000747 int addr, pc, hdr;
drh9e572e62004-04-23 23:43:10 +0000748 int size;
drh24cd67e2004-05-10 16:18:47 +0000749 int nFrag;
drh43605152004-05-29 21:46:49 +0000750 int top;
751 int nCell;
752 int cellOffset;
drh9e572e62004-04-23 23:43:10 +0000753 unsigned char *data;
drh43605152004-05-29 21:46:49 +0000754
drh9e572e62004-04-23 23:43:10 +0000755 data = pPage->aData;
danielk19773b8a05f2007-03-19 17:44:26 +0000756 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +0000757 assert( pPage->pBt );
drh1fee73e2007-08-29 04:00:57 +0000758 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhfa67c3c2008-07-11 02:21:40 +0000759 assert( nByte>=0 ); /* Minimum cell size is 4 */
760 assert( pPage->nFree>=nByte );
761 assert( pPage->nOverflow==0 );
drh43605152004-05-29 21:46:49 +0000762 pPage->nFree -= nByte;
drh9e572e62004-04-23 23:43:10 +0000763 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +0000764
765 nFrag = data[hdr+7];
766 if( nFrag<60 ){
767 /* Search the freelist looking for a slot big enough to satisfy the
768 ** space request. */
769 addr = hdr+1;
770 while( (pc = get2byte(&data[addr]))>0 ){
771 size = get2byte(&data[pc+2]);
772 if( size>=nByte ){
773 if( size<nByte+4 ){
774 memcpy(&data[addr], &data[pc], 2);
775 data[hdr+7] = nFrag + size - nByte;
776 return pc;
777 }else{
778 put2byte(&data[pc+2], size-nByte);
779 return pc + size - nByte;
780 }
781 }
782 addr = pc;
drh9e572e62004-04-23 23:43:10 +0000783 }
784 }
drh43605152004-05-29 21:46:49 +0000785
786 /* Allocate memory from the gap in between the cell pointer array
787 ** and the cell content area.
788 */
789 top = get2byte(&data[hdr+5]);
790 nCell = get2byte(&data[hdr+3]);
791 cellOffset = pPage->cellOffset;
792 if( nFrag>=60 || cellOffset + 2*nCell > top - nByte ){
danielk1977474b7cc2008-07-09 11:49:46 +0000793 defragmentPage(pPage);
drh43605152004-05-29 21:46:49 +0000794 top = get2byte(&data[hdr+5]);
drh2af926b2001-05-15 00:39:25 +0000795 }
drh43605152004-05-29 21:46:49 +0000796 top -= nByte;
797 assert( cellOffset + 2*nCell <= top );
798 put2byte(&data[hdr+5], top);
799 return top;
drh7e3b0a02001-04-28 16:52:40 +0000800}
801
802/*
drh9e572e62004-04-23 23:43:10 +0000803** Return a section of the pPage->aData to the freelist.
804** The first byte of the new free block is pPage->aDisk[start]
805** and the size of the block is "size" bytes.
drh306dc212001-05-21 13:45:10 +0000806**
807** Most of the effort here is involved in coalesing adjacent
808** free blocks into a single big free block.
drh7e3b0a02001-04-28 16:52:40 +0000809*/
drh9e572e62004-04-23 23:43:10 +0000810static void freeSpace(MemPage *pPage, int start, int size){
drh43605152004-05-29 21:46:49 +0000811 int addr, pbegin, hdr;
drh9e572e62004-04-23 23:43:10 +0000812 unsigned char *data = pPage->aData;
drh2af926b2001-05-15 00:39:25 +0000813
drh9e572e62004-04-23 23:43:10 +0000814 assert( pPage->pBt!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +0000815 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +0000816 assert( start>=pPage->hdrOffset+6+(pPage->leaf?0:4) );
danielk1977bc6ada42004-06-30 08:20:16 +0000817 assert( (start + size)<=pPage->pBt->usableSize );
drh1fee73e2007-08-29 04:00:57 +0000818 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh34004ce2008-07-11 16:15:17 +0000819 assert( size>=0 ); /* Minimum cell size is 4 */
drh9e572e62004-04-23 23:43:10 +0000820
drhfcce93f2006-02-22 03:08:32 +0000821#ifdef SQLITE_SECURE_DELETE
822 /* Overwrite deleted information with zeros when the SECURE_DELETE
823 ** option is enabled at compile-time */
824 memset(&data[start], 0, size);
825#endif
826
drh9e572e62004-04-23 23:43:10 +0000827 /* Add the space back into the linked list of freeblocks */
drh43605152004-05-29 21:46:49 +0000828 hdr = pPage->hdrOffset;
829 addr = hdr + 1;
drh3aac2dd2004-04-26 14:10:20 +0000830 while( (pbegin = get2byte(&data[addr]))<start && pbegin>0 ){
drhb6f41482004-05-14 01:58:11 +0000831 assert( pbegin<=pPage->pBt->usableSize-4 );
drh3aac2dd2004-04-26 14:10:20 +0000832 assert( pbegin>addr );
833 addr = pbegin;
drh2af926b2001-05-15 00:39:25 +0000834 }
drhb6f41482004-05-14 01:58:11 +0000835 assert( pbegin<=pPage->pBt->usableSize-4 );
drh3aac2dd2004-04-26 14:10:20 +0000836 assert( pbegin>addr || pbegin==0 );
drha34b6762004-05-07 13:30:42 +0000837 put2byte(&data[addr], start);
838 put2byte(&data[start], pbegin);
839 put2byte(&data[start+2], size);
drh2af926b2001-05-15 00:39:25 +0000840 pPage->nFree += size;
drh9e572e62004-04-23 23:43:10 +0000841
842 /* Coalesce adjacent free blocks */
drh3aac2dd2004-04-26 14:10:20 +0000843 addr = pPage->hdrOffset + 1;
844 while( (pbegin = get2byte(&data[addr]))>0 ){
drh9e572e62004-04-23 23:43:10 +0000845 int pnext, psize;
drh3aac2dd2004-04-26 14:10:20 +0000846 assert( pbegin>addr );
drh43605152004-05-29 21:46:49 +0000847 assert( pbegin<=pPage->pBt->usableSize-4 );
drh9e572e62004-04-23 23:43:10 +0000848 pnext = get2byte(&data[pbegin]);
849 psize = get2byte(&data[pbegin+2]);
850 if( pbegin + psize + 3 >= pnext && pnext>0 ){
851 int frag = pnext - (pbegin+psize);
drh43605152004-05-29 21:46:49 +0000852 assert( frag<=data[pPage->hdrOffset+7] );
853 data[pPage->hdrOffset+7] -= frag;
drh9e572e62004-04-23 23:43:10 +0000854 put2byte(&data[pbegin], get2byte(&data[pnext]));
855 put2byte(&data[pbegin+2], pnext+get2byte(&data[pnext+2])-pbegin);
856 }else{
drh3aac2dd2004-04-26 14:10:20 +0000857 addr = pbegin;
drh9e572e62004-04-23 23:43:10 +0000858 }
859 }
drh7e3b0a02001-04-28 16:52:40 +0000860
drh43605152004-05-29 21:46:49 +0000861 /* If the cell content area begins with a freeblock, remove it. */
862 if( data[hdr+1]==data[hdr+5] && data[hdr+2]==data[hdr+6] ){
863 int top;
864 pbegin = get2byte(&data[hdr+1]);
865 memcpy(&data[hdr+1], &data[pbegin], 2);
866 top = get2byte(&data[hdr+5]);
867 put2byte(&data[hdr+5], top + get2byte(&data[pbegin+2]));
drh4b70f112004-05-02 21:12:19 +0000868 }
drh4b70f112004-05-02 21:12:19 +0000869}
870
871/*
drh271efa52004-05-30 19:19:05 +0000872** Decode the flags byte (the first byte of the header) for a page
873** and initialize fields of the MemPage structure accordingly.
drh44845222008-07-17 18:39:57 +0000874**
875** Only the following combinations are supported. Anything different
876** indicates a corrupt database files:
877**
878** PTF_ZERODATA
879** PTF_ZERODATA | PTF_LEAF
880** PTF_LEAFDATA | PTF_INTKEY
881** PTF_LEAFDATA | PTF_INTKEY | PTF_LEAF
drh271efa52004-05-30 19:19:05 +0000882*/
drh44845222008-07-17 18:39:57 +0000883static int decodeFlags(MemPage *pPage, int flagByte){
danielk1977aef0bf62005-12-30 16:28:01 +0000884 BtShared *pBt; /* A copy of pPage->pBt */
drh271efa52004-05-30 19:19:05 +0000885
886 assert( pPage->hdrOffset==(pPage->pgno==1 ? 100 : 0) );
drh1fee73e2007-08-29 04:00:57 +0000887 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh44845222008-07-17 18:39:57 +0000888 pPage->leaf = flagByte>>3; assert( PTF_LEAF == 1<<3 );
889 flagByte &= ~PTF_LEAF;
890 pPage->childPtrSize = 4-4*pPage->leaf;
drh271efa52004-05-30 19:19:05 +0000891 pBt = pPage->pBt;
drh44845222008-07-17 18:39:57 +0000892 if( flagByte==(PTF_LEAFDATA | PTF_INTKEY) ){
893 pPage->intKey = 1;
894 pPage->hasData = pPage->leaf;
drh271efa52004-05-30 19:19:05 +0000895 pPage->maxLocal = pBt->maxLeaf;
896 pPage->minLocal = pBt->minLeaf;
drh44845222008-07-17 18:39:57 +0000897 }else if( flagByte==PTF_ZERODATA ){
898 pPage->intKey = 0;
899 pPage->hasData = 0;
drh271efa52004-05-30 19:19:05 +0000900 pPage->maxLocal = pBt->maxLocal;
901 pPage->minLocal = pBt->minLocal;
drh44845222008-07-17 18:39:57 +0000902 }else{
903 return SQLITE_CORRUPT_BKPT;
drh271efa52004-05-30 19:19:05 +0000904 }
drh44845222008-07-17 18:39:57 +0000905 return SQLITE_OK;
drh271efa52004-05-30 19:19:05 +0000906}
907
908/*
drh7e3b0a02001-04-28 16:52:40 +0000909** Initialize the auxiliary information for a disk block.
drh72f82862001-05-24 21:06:34 +0000910**
drhbd03cae2001-06-02 02:40:57 +0000911** The pParent parameter must be a pointer to the MemPage which
drh9e572e62004-04-23 23:43:10 +0000912** is the parent of the page being initialized. The root of a
913** BTree has no parent and so for that page, pParent==NULL.
drh5e2f8b92001-05-28 00:41:15 +0000914**
drh72f82862001-05-24 21:06:34 +0000915** Return SQLITE_OK on success. If we see that the page does
drhda47d772002-12-02 04:25:19 +0000916** not contain a well-formed database page, then return
drh72f82862001-05-24 21:06:34 +0000917** SQLITE_CORRUPT. Note that a return of SQLITE_OK does not
918** guarantee that the page is well-formed. It only shows that
919** we failed to detect any corruption.
drh7e3b0a02001-04-28 16:52:40 +0000920*/
drh16a9b832007-05-05 18:39:25 +0000921int sqlite3BtreeInitPage(
drh3aac2dd2004-04-26 14:10:20 +0000922 MemPage *pPage, /* The page to be initialized */
drh9e572e62004-04-23 23:43:10 +0000923 MemPage *pParent /* The parent. Might be NULL */
924){
drh271efa52004-05-30 19:19:05 +0000925 int pc; /* Address of a freeblock within pPage->aData[] */
drh271efa52004-05-30 19:19:05 +0000926 int hdr; /* Offset to beginning of page header */
927 u8 *data; /* Equal to pPage->aData */
danielk1977aef0bf62005-12-30 16:28:01 +0000928 BtShared *pBt; /* The main btree structure */
drh271efa52004-05-30 19:19:05 +0000929 int usableSize; /* Amount of usable space on each page */
930 int cellOffset; /* Offset from start of page to first cell pointer */
931 int nFree; /* Number of unused bytes on the page */
932 int top; /* First byte of the cell content area */
drh2af926b2001-05-15 00:39:25 +0000933
drh2e38c322004-09-03 18:38:44 +0000934 pBt = pPage->pBt;
935 assert( pBt!=0 );
936 assert( pParent==0 || pParent->pBt==pBt );
drh1fee73e2007-08-29 04:00:57 +0000937 assert( sqlite3_mutex_held(pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +0000938 assert( pPage->pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
drhbf4bca52007-09-06 22:19:14 +0000939 assert( pPage == sqlite3PagerGetExtra(pPage->pDbPage) );
940 assert( pPage->aData == sqlite3PagerGetData(pPage->pDbPage) );
drhee696e22004-08-30 16:52:17 +0000941 if( pPage->pParent!=pParent && (pPage->pParent!=0 || pPage->isInit) ){
942 /* The parent page should never change unless the file is corrupt */
drh49285702005-09-17 15:20:26 +0000943 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000944 }
drh10617cd2004-05-14 15:27:27 +0000945 if( pPage->isInit ) return SQLITE_OK;
drhda200cc2004-05-09 11:51:38 +0000946 if( pPage->pParent==0 && pParent!=0 ){
947 pPage->pParent = pParent;
danielk19773b8a05f2007-03-19 17:44:26 +0000948 sqlite3PagerRef(pParent->pDbPage);
drh5e2f8b92001-05-28 00:41:15 +0000949 }
drhde647132004-05-07 17:57:49 +0000950 hdr = pPage->hdrOffset;
drha34b6762004-05-07 13:30:42 +0000951 data = pPage->aData;
drh44845222008-07-17 18:39:57 +0000952 if( decodeFlags(pPage, data[hdr]) ) return SQLITE_CORRUPT_BKPT;
drh1688c862008-07-18 02:44:17 +0000953 assert( pBt->pageSize>=512 && pBt->pageSize<=32768 );
954 pPage->maskPage = pBt->pageSize - 1;
drh43605152004-05-29 21:46:49 +0000955 pPage->nOverflow = 0;
drhc8629a12004-05-08 20:07:40 +0000956 pPage->idxShift = 0;
drh2e38c322004-09-03 18:38:44 +0000957 usableSize = pBt->usableSize;
drh43605152004-05-29 21:46:49 +0000958 pPage->cellOffset = cellOffset = hdr + 12 - 4*pPage->leaf;
959 top = get2byte(&data[hdr+5]);
960 pPage->nCell = get2byte(&data[hdr+3]);
drh2e38c322004-09-03 18:38:44 +0000961 if( pPage->nCell>MX_CELL(pBt) ){
drhee696e22004-08-30 16:52:17 +0000962 /* To many cells for a single page. The page must be corrupt */
drh49285702005-09-17 15:20:26 +0000963 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000964 }
965 if( pPage->nCell==0 && pParent!=0 && pParent->pgno!=1 ){
966 /* All pages must have at least one cell, except for root pages */
drh49285702005-09-17 15:20:26 +0000967 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000968 }
drh9e572e62004-04-23 23:43:10 +0000969
970 /* Compute the total free space on the page */
drh9e572e62004-04-23 23:43:10 +0000971 pc = get2byte(&data[hdr+1]);
drh43605152004-05-29 21:46:49 +0000972 nFree = data[hdr+7] + top - (cellOffset + 2*pPage->nCell);
drh9e572e62004-04-23 23:43:10 +0000973 while( pc>0 ){
974 int next, size;
drhee696e22004-08-30 16:52:17 +0000975 if( pc>usableSize-4 ){
976 /* Free block is off the page */
drh49285702005-09-17 15:20:26 +0000977 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000978 }
drh9e572e62004-04-23 23:43:10 +0000979 next = get2byte(&data[pc]);
980 size = get2byte(&data[pc+2]);
drhee696e22004-08-30 16:52:17 +0000981 if( next>0 && next<=pc+size+3 ){
982 /* Free blocks must be in accending order */
drh49285702005-09-17 15:20:26 +0000983 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000984 }
drh3add3672004-05-15 00:29:24 +0000985 nFree += size;
drh9e572e62004-04-23 23:43:10 +0000986 pc = next;
987 }
drh3add3672004-05-15 00:29:24 +0000988 pPage->nFree = nFree;
drhee696e22004-08-30 16:52:17 +0000989 if( nFree>=usableSize ){
990 /* Free space cannot exceed total page size */
drh49285702005-09-17 15:20:26 +0000991 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000992 }
drh9e572e62004-04-23 23:43:10 +0000993
drh1688c862008-07-18 02:44:17 +0000994#if 0
995 /* Check that all the offsets in the cell offset array are within range.
996 **
997 ** Omitting this consistency check and using the pPage->maskPage mask
998 ** to prevent overrunning the page buffer in findCell() results in a
999 ** 2.5% performance gain.
1000 */
1001 {
1002 u8 *pOff; /* Iterator used to check all cell offsets are in range */
1003 u8 *pEnd; /* Pointer to end of cell offset array */
1004 u8 mask; /* Mask of bits that must be zero in MSB of cell offsets */
1005 mask = ~(((u8)(pBt->pageSize>>8))-1);
1006 pEnd = &data[cellOffset + pPage->nCell*2];
1007 for(pOff=&data[cellOffset]; pOff!=pEnd && !((*pOff)&mask); pOff+=2);
1008 if( pOff!=pEnd ){
1009 return SQLITE_CORRUPT_BKPT;
1010 }
danielk1977e16535f2008-06-11 18:15:29 +00001011 }
drh1688c862008-07-18 02:44:17 +00001012#endif
danielk1977e16535f2008-06-11 18:15:29 +00001013
drhde647132004-05-07 17:57:49 +00001014 pPage->isInit = 1;
drh9e572e62004-04-23 23:43:10 +00001015 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001016}
1017
1018/*
drh8b2f49b2001-06-08 00:21:52 +00001019** Set up a raw page so that it looks like a database page holding
1020** no entries.
drhbd03cae2001-06-02 02:40:57 +00001021*/
drh9e572e62004-04-23 23:43:10 +00001022static void zeroPage(MemPage *pPage, int flags){
1023 unsigned char *data = pPage->aData;
danielk1977aef0bf62005-12-30 16:28:01 +00001024 BtShared *pBt = pPage->pBt;
drh3aac2dd2004-04-26 14:10:20 +00001025 int hdr = pPage->hdrOffset;
drh9e572e62004-04-23 23:43:10 +00001026 int first;
1027
danielk19773b8a05f2007-03-19 17:44:26 +00001028 assert( sqlite3PagerPagenumber(pPage->pDbPage)==pPage->pgno );
drhbf4bca52007-09-06 22:19:14 +00001029 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
1030 assert( sqlite3PagerGetData(pPage->pDbPage) == data );
danielk19773b8a05f2007-03-19 17:44:26 +00001031 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00001032 assert( sqlite3_mutex_held(pBt->mutex) );
drh1af4a6e2008-07-18 03:32:51 +00001033 /*memset(&data[hdr], 0, pBt->usableSize - hdr);*/
drh9e572e62004-04-23 23:43:10 +00001034 data[hdr] = flags;
drh43605152004-05-29 21:46:49 +00001035 first = hdr + 8 + 4*((flags&PTF_LEAF)==0);
1036 memset(&data[hdr+1], 0, 4);
1037 data[hdr+7] = 0;
1038 put2byte(&data[hdr+5], pBt->usableSize);
drhb6f41482004-05-14 01:58:11 +00001039 pPage->nFree = pBt->usableSize - first;
drh271efa52004-05-30 19:19:05 +00001040 decodeFlags(pPage, flags);
drh9e572e62004-04-23 23:43:10 +00001041 pPage->hdrOffset = hdr;
drh43605152004-05-29 21:46:49 +00001042 pPage->cellOffset = first;
1043 pPage->nOverflow = 0;
drh1688c862008-07-18 02:44:17 +00001044 assert( pBt->pageSize>=512 && pBt->pageSize<=32768 );
1045 pPage->maskPage = pBt->pageSize - 1;
drhda200cc2004-05-09 11:51:38 +00001046 pPage->idxShift = 0;
drh43605152004-05-29 21:46:49 +00001047 pPage->nCell = 0;
drhda200cc2004-05-09 11:51:38 +00001048 pPage->isInit = 1;
drhbd03cae2001-06-02 02:40:57 +00001049}
1050
1051/*
drh3aac2dd2004-04-26 14:10:20 +00001052** Get a page from the pager. Initialize the MemPage.pBt and
1053** MemPage.aData elements if needed.
drh538f5702007-04-13 02:14:30 +00001054**
1055** If the noContent flag is set, it means that we do not care about
1056** the content of the page at this time. So do not go to the disk
1057** to fetch the content. Just fill in the content with zeros for now.
1058** If in the future we call sqlite3PagerWrite() on this page, that
1059** means we have started to be concerned about content and the disk
1060** read should occur at that point.
drh3aac2dd2004-04-26 14:10:20 +00001061*/
drh16a9b832007-05-05 18:39:25 +00001062int sqlite3BtreeGetPage(
1063 BtShared *pBt, /* The btree */
1064 Pgno pgno, /* Number of the page to fetch */
1065 MemPage **ppPage, /* Return the page in this parameter */
1066 int noContent /* Do not load page content if true */
1067){
drh3aac2dd2004-04-26 14:10:20 +00001068 int rc;
drh3aac2dd2004-04-26 14:10:20 +00001069 MemPage *pPage;
danielk19773b8a05f2007-03-19 17:44:26 +00001070 DbPage *pDbPage;
1071
drh1fee73e2007-08-29 04:00:57 +00001072 assert( sqlite3_mutex_held(pBt->mutex) );
drh538f5702007-04-13 02:14:30 +00001073 rc = sqlite3PagerAcquire(pBt->pPager, pgno, (DbPage**)&pDbPage, noContent);
drh3aac2dd2004-04-26 14:10:20 +00001074 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00001075 pPage = (MemPage *)sqlite3PagerGetExtra(pDbPage);
1076 pPage->aData = sqlite3PagerGetData(pDbPage);
1077 pPage->pDbPage = pDbPage;
drh3aac2dd2004-04-26 14:10:20 +00001078 pPage->pBt = pBt;
1079 pPage->pgno = pgno;
drhde647132004-05-07 17:57:49 +00001080 pPage->hdrOffset = pPage->pgno==1 ? 100 : 0;
drh3aac2dd2004-04-26 14:10:20 +00001081 *ppPage = pPage;
1082 return SQLITE_OK;
1083}
1084
1085/*
drhde647132004-05-07 17:57:49 +00001086** Get a page from the pager and initialize it. This routine
1087** is just a convenience wrapper around separate calls to
drh16a9b832007-05-05 18:39:25 +00001088** sqlite3BtreeGetPage() and sqlite3BtreeInitPage().
drhde647132004-05-07 17:57:49 +00001089*/
1090static int getAndInitPage(
danielk1977aef0bf62005-12-30 16:28:01 +00001091 BtShared *pBt, /* The database file */
drhde647132004-05-07 17:57:49 +00001092 Pgno pgno, /* Number of the page to get */
1093 MemPage **ppPage, /* Write the page pointer here */
1094 MemPage *pParent /* Parent of the page */
1095){
1096 int rc;
drh1fee73e2007-08-29 04:00:57 +00001097 assert( sqlite3_mutex_held(pBt->mutex) );
drhee696e22004-08-30 16:52:17 +00001098 if( pgno==0 ){
drh49285702005-09-17 15:20:26 +00001099 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +00001100 }
drh16a9b832007-05-05 18:39:25 +00001101 rc = sqlite3BtreeGetPage(pBt, pgno, ppPage, 0);
drh10617cd2004-05-14 15:27:27 +00001102 if( rc==SQLITE_OK && (*ppPage)->isInit==0 ){
drh16a9b832007-05-05 18:39:25 +00001103 rc = sqlite3BtreeInitPage(*ppPage, pParent);
danielk197743e377a2008-05-05 12:09:32 +00001104 if( rc!=SQLITE_OK ){
1105 releasePage(*ppPage);
1106 *ppPage = 0;
1107 }
drhde647132004-05-07 17:57:49 +00001108 }
1109 return rc;
1110}
1111
1112/*
drh3aac2dd2004-04-26 14:10:20 +00001113** Release a MemPage. This should be called once for each prior
drh16a9b832007-05-05 18:39:25 +00001114** call to sqlite3BtreeGetPage.
drh3aac2dd2004-04-26 14:10:20 +00001115*/
drh4b70f112004-05-02 21:12:19 +00001116static void releasePage(MemPage *pPage){
drh3aac2dd2004-04-26 14:10:20 +00001117 if( pPage ){
1118 assert( pPage->aData );
1119 assert( pPage->pBt );
drhbf4bca52007-09-06 22:19:14 +00001120 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
1121 assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
drh1fee73e2007-08-29 04:00:57 +00001122 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00001123 sqlite3PagerUnref(pPage->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00001124 }
1125}
1126
1127/*
drh72f82862001-05-24 21:06:34 +00001128** This routine is called when the reference count for a page
1129** reaches zero. We need to unref the pParent pointer when that
1130** happens.
1131*/
danielk19778c0a7912008-08-20 14:49:23 +00001132static void pageDestructor(DbPage *pData){
drh07d183d2005-05-01 22:52:42 +00001133 MemPage *pPage;
danielk19773b8a05f2007-03-19 17:44:26 +00001134 pPage = (MemPage *)sqlite3PagerGetExtra(pData);
danielk19778c0a7912008-08-20 14:49:23 +00001135 if( pPage ){
1136 assert( pPage->isInit==0 || sqlite3_mutex_held(pPage->pBt->mutex) );
1137 if( pPage->pParent ){
1138 MemPage *pParent = pPage->pParent;
1139 assert( pParent->pBt==pPage->pBt );
1140 pPage->pParent = 0;
1141 releasePage(pParent);
1142 }
1143 pPage->isInit = 0;
drh72f82862001-05-24 21:06:34 +00001144 }
1145}
1146
1147/*
drha6abd042004-06-09 17:37:22 +00001148** During a rollback, when the pager reloads information into the cache
1149** so that the cache is restored to its original state at the start of
1150** the transaction, for each page restored this routine is called.
1151**
1152** This routine needs to reset the extra data section at the end of the
1153** page to agree with the restored data.
1154*/
danielk19773b8a05f2007-03-19 17:44:26 +00001155static void pageReinit(DbPage *pData, int pageSize){
drh07d183d2005-05-01 22:52:42 +00001156 MemPage *pPage;
1157 assert( (pageSize & 7)==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00001158 pPage = (MemPage *)sqlite3PagerGetExtra(pData);
drha6abd042004-06-09 17:37:22 +00001159 if( pPage->isInit ){
drh1fee73e2007-08-29 04:00:57 +00001160 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drha6abd042004-06-09 17:37:22 +00001161 pPage->isInit = 0;
drh16a9b832007-05-05 18:39:25 +00001162 sqlite3BtreeInitPage(pPage, pPage->pParent);
drha6abd042004-06-09 17:37:22 +00001163 }
1164}
1165
1166/*
drhe5fe6902007-12-07 18:55:28 +00001167** Invoke the busy handler for a btree.
1168*/
1169static int sqlite3BtreeInvokeBusyHandler(void *pArg, int n){
1170 BtShared *pBt = (BtShared*)pArg;
1171 assert( pBt->db );
1172 assert( sqlite3_mutex_held(pBt->db->mutex) );
1173 return sqlite3InvokeBusyHandler(&pBt->db->busyHandler);
1174}
1175
1176/*
drhad3e0102004-09-03 23:32:18 +00001177** Open a database file.
1178**
drh382c0242001-10-06 16:33:02 +00001179** zFilename is the name of the database file. If zFilename is NULL
drh1bee3d72001-10-15 00:44:35 +00001180** a new database with a random name is created. This randomly named
drh23e11ca2004-05-04 17:27:28 +00001181** database file will be deleted when sqlite3BtreeClose() is called.
drhe53831d2007-08-17 01:14:38 +00001182** If zFilename is ":memory:" then an in-memory database is created
1183** that is automatically destroyed when it is closed.
drha059ad02001-04-17 20:09:11 +00001184*/
drh23e11ca2004-05-04 17:27:28 +00001185int sqlite3BtreeOpen(
drh3aac2dd2004-04-26 14:10:20 +00001186 const char *zFilename, /* Name of the file containing the BTree database */
drhe5fe6902007-12-07 18:55:28 +00001187 sqlite3 *db, /* Associated database handle */
drh3aac2dd2004-04-26 14:10:20 +00001188 Btree **ppBtree, /* Pointer to new Btree object written here */
drh33f4e022007-09-03 15:19:34 +00001189 int flags, /* Options */
1190 int vfsFlags /* Flags passed through to sqlite3_vfs.xOpen() */
drh6019e162001-07-02 17:51:45 +00001191){
drhd677b3d2007-08-20 22:48:41 +00001192 sqlite3_vfs *pVfs; /* The VFS to use for this btree */
drhe53831d2007-08-17 01:14:38 +00001193 BtShared *pBt = 0; /* Shared part of btree structure */
danielk1977aef0bf62005-12-30 16:28:01 +00001194 Btree *p; /* Handle to return */
danielk1977dddbcdc2007-04-26 14:42:34 +00001195 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00001196 int nReserve;
1197 unsigned char zDbHeader[100];
danielk1977aef0bf62005-12-30 16:28:01 +00001198
1199 /* Set the variable isMemdb to true for an in-memory database, or
1200 ** false for a file-based database. This symbol is only required if
1201 ** either of the shared-data or autovacuum features are compiled
1202 ** into the library.
1203 */
1204#if !defined(SQLITE_OMIT_SHARED_CACHE) || !defined(SQLITE_OMIT_AUTOVACUUM)
1205 #ifdef SQLITE_OMIT_MEMORYDB
drh980b1a72006-08-16 16:42:48 +00001206 const int isMemdb = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001207 #else
drh980b1a72006-08-16 16:42:48 +00001208 const int isMemdb = zFilename && !strcmp(zFilename, ":memory:");
danielk1977aef0bf62005-12-30 16:28:01 +00001209 #endif
1210#endif
1211
drhe5fe6902007-12-07 18:55:28 +00001212 assert( db!=0 );
1213 assert( sqlite3_mutex_held(db->mutex) );
drh153c62c2007-08-24 03:51:33 +00001214
drhe5fe6902007-12-07 18:55:28 +00001215 pVfs = db->pVfs;
drh17435752007-08-16 04:30:38 +00001216 p = sqlite3MallocZero(sizeof(Btree));
danielk1977aef0bf62005-12-30 16:28:01 +00001217 if( !p ){
1218 return SQLITE_NOMEM;
1219 }
1220 p->inTrans = TRANS_NONE;
drhe5fe6902007-12-07 18:55:28 +00001221 p->db = db;
danielk1977aef0bf62005-12-30 16:28:01 +00001222
drh198bf392006-01-06 21:52:49 +00001223#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00001224 /*
1225 ** If this Btree is a candidate for shared cache, try to find an
1226 ** existing BtShared object that we can share with
1227 */
drh34004ce2008-07-11 16:15:17 +00001228 if( isMemdb==0
drhe5fe6902007-12-07 18:55:28 +00001229 && (db->flags & SQLITE_Vtab)==0
drhe53831d2007-08-17 01:14:38 +00001230 && zFilename && zFilename[0]
drhe53831d2007-08-17 01:14:38 +00001231 ){
danielk1977502b4e02008-09-02 14:07:24 +00001232 if( sqlite3GlobalConfig.sharedCacheEnabled ){
danielk1977adfb9b02007-09-17 07:02:56 +00001233 int nFullPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001234 char *zFullPathname = sqlite3Malloc(nFullPathname);
drhff0587c2007-08-29 17:43:19 +00001235 sqlite3_mutex *mutexShared;
1236 p->sharable = 1;
drh34004ce2008-07-11 16:15:17 +00001237 db->flags |= SQLITE_SharedCache;
drhff0587c2007-08-29 17:43:19 +00001238 if( !zFullPathname ){
1239 sqlite3_free(p);
1240 return SQLITE_NOMEM;
1241 }
danielk1977adfb9b02007-09-17 07:02:56 +00001242 sqlite3OsFullPathname(pVfs, zFilename, nFullPathname, zFullPathname);
danielk197759f8c082008-06-18 17:09:10 +00001243 mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhff0587c2007-08-29 17:43:19 +00001244 sqlite3_mutex_enter(mutexShared);
drh78f82d12008-09-02 00:52:52 +00001245 for(pBt=GLOBAL(BtShared*,sqlite3SharedCacheList); pBt; pBt=pBt->pNext){
drhff0587c2007-08-29 17:43:19 +00001246 assert( pBt->nRef>0 );
1247 if( 0==strcmp(zFullPathname, sqlite3PagerFilename(pBt->pPager))
1248 && sqlite3PagerVfs(pBt->pPager)==pVfs ){
1249 p->pBt = pBt;
1250 pBt->nRef++;
1251 break;
1252 }
1253 }
1254 sqlite3_mutex_leave(mutexShared);
1255 sqlite3_free(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001256 }
drhff0587c2007-08-29 17:43:19 +00001257#ifdef SQLITE_DEBUG
1258 else{
1259 /* In debug mode, we mark all persistent databases as sharable
1260 ** even when they are not. This exercises the locking code and
1261 ** gives more opportunity for asserts(sqlite3_mutex_held())
1262 ** statements to find locking problems.
1263 */
1264 p->sharable = 1;
1265 }
1266#endif
danielk1977aef0bf62005-12-30 16:28:01 +00001267 }
1268#endif
drha059ad02001-04-17 20:09:11 +00001269 if( pBt==0 ){
drhe53831d2007-08-17 01:14:38 +00001270 /*
1271 ** The following asserts make sure that structures used by the btree are
1272 ** the right size. This is to guard against size changes that result
1273 ** when compiling on a different architecture.
danielk197703aded42004-11-22 05:26:27 +00001274 */
drhe53831d2007-08-17 01:14:38 +00001275 assert( sizeof(i64)==8 || sizeof(i64)==4 );
1276 assert( sizeof(u64)==8 || sizeof(u64)==4 );
1277 assert( sizeof(u32)==4 );
1278 assert( sizeof(u16)==2 );
1279 assert( sizeof(Pgno)==4 );
1280
1281 pBt = sqlite3MallocZero( sizeof(*pBt) );
1282 if( pBt==0 ){
1283 rc = SQLITE_NOMEM;
1284 goto btree_open_out;
1285 }
drhe5fe6902007-12-07 18:55:28 +00001286 pBt->busyHdr.xFunc = sqlite3BtreeInvokeBusyHandler;
1287 pBt->busyHdr.pArg = pBt;
danielk19778c0a7912008-08-20 14:49:23 +00001288 rc = sqlite3PagerOpen(pVfs, &pBt->pPager, zFilename, pageDestructor,
drh33f4e022007-09-03 15:19:34 +00001289 EXTRA_SIZE, flags, vfsFlags);
drhe53831d2007-08-17 01:14:38 +00001290 if( rc==SQLITE_OK ){
1291 rc = sqlite3PagerReadFileheader(pBt->pPager,sizeof(zDbHeader),zDbHeader);
1292 }
1293 if( rc!=SQLITE_OK ){
1294 goto btree_open_out;
1295 }
drhe5fe6902007-12-07 18:55:28 +00001296 sqlite3PagerSetBusyhandler(pBt->pPager, &pBt->busyHdr);
drhe53831d2007-08-17 01:14:38 +00001297 p->pBt = pBt;
1298
drhe53831d2007-08-17 01:14:38 +00001299 sqlite3PagerSetReiniter(pBt->pPager, pageReinit);
1300 pBt->pCursor = 0;
1301 pBt->pPage1 = 0;
1302 pBt->readOnly = sqlite3PagerIsreadonly(pBt->pPager);
1303 pBt->pageSize = get2byte(&zDbHeader[16]);
1304 if( pBt->pageSize<512 || pBt->pageSize>SQLITE_MAX_PAGE_SIZE
1305 || ((pBt->pageSize-1)&pBt->pageSize)!=0 ){
danielk1977a1644fd2007-08-29 12:31:25 +00001306 pBt->pageSize = 0;
1307 sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize);
drhe53831d2007-08-17 01:14:38 +00001308#ifndef SQLITE_OMIT_AUTOVACUUM
1309 /* If the magic name ":memory:" will create an in-memory database, then
1310 ** leave the autoVacuum mode at 0 (do not auto-vacuum), even if
1311 ** SQLITE_DEFAULT_AUTOVACUUM is true. On the other hand, if
1312 ** SQLITE_OMIT_MEMORYDB has been defined, then ":memory:" is just a
1313 ** regular file-name. In this case the auto-vacuum applies as per normal.
1314 */
1315 if( zFilename && !isMemdb ){
1316 pBt->autoVacuum = (SQLITE_DEFAULT_AUTOVACUUM ? 1 : 0);
1317 pBt->incrVacuum = (SQLITE_DEFAULT_AUTOVACUUM==2 ? 1 : 0);
1318 }
1319#endif
1320 nReserve = 0;
1321 }else{
1322 nReserve = zDbHeader[20];
drhe53831d2007-08-17 01:14:38 +00001323 pBt->pageSizeFixed = 1;
1324#ifndef SQLITE_OMIT_AUTOVACUUM
1325 pBt->autoVacuum = (get4byte(&zDbHeader[36 + 4*4])?1:0);
1326 pBt->incrVacuum = (get4byte(&zDbHeader[36 + 7*4])?1:0);
1327#endif
1328 }
1329 pBt->usableSize = pBt->pageSize - nReserve;
1330 assert( (pBt->pageSize & 7)==0 ); /* 8-byte alignment of pageSize */
danielk1977a1644fd2007-08-29 12:31:25 +00001331 sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize);
drhe53831d2007-08-17 01:14:38 +00001332
1333#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
1334 /* Add the new BtShared object to the linked list sharable BtShareds.
1335 */
1336 if( p->sharable ){
1337 sqlite3_mutex *mutexShared;
1338 pBt->nRef = 1;
danielk197759f8c082008-06-18 17:09:10 +00001339 mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
danielk1977075c23a2008-09-01 18:34:20 +00001340 if( SQLITE_THREADSAFE && sqlite3GlobalConfig.bCoreMutex ){
danielk197759f8c082008-06-18 17:09:10 +00001341 pBt->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_FAST);
drh3285db22007-09-03 22:00:39 +00001342 if( pBt->mutex==0 ){
1343 rc = SQLITE_NOMEM;
drhe5fe6902007-12-07 18:55:28 +00001344 db->mallocFailed = 0;
drh3285db22007-09-03 22:00:39 +00001345 goto btree_open_out;
1346 }
drhff0587c2007-08-29 17:43:19 +00001347 }
drhe53831d2007-08-17 01:14:38 +00001348 sqlite3_mutex_enter(mutexShared);
drh78f82d12008-09-02 00:52:52 +00001349 pBt->pNext = GLOBAL(BtShared*,sqlite3SharedCacheList);
1350 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt;
drhe53831d2007-08-17 01:14:38 +00001351 sqlite3_mutex_leave(mutexShared);
danielk1977951af802004-11-05 15:45:09 +00001352 }
drheee46cf2004-11-06 00:02:48 +00001353#endif
drh90f5ecb2004-07-22 01:19:35 +00001354 }
danielk1977aef0bf62005-12-30 16:28:01 +00001355
drhcfed7bc2006-03-13 14:28:05 +00001356#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00001357 /* If the new Btree uses a sharable pBtShared, then link the new
1358 ** Btree into the list of all sharable Btrees for the same connection.
drhabddb0c2007-08-20 13:14:28 +00001359 ** The list is kept in ascending order by pBt address.
danielk197754f01982006-01-18 15:25:17 +00001360 */
drhe53831d2007-08-17 01:14:38 +00001361 if( p->sharable ){
1362 int i;
1363 Btree *pSib;
drhe5fe6902007-12-07 18:55:28 +00001364 for(i=0; i<db->nDb; i++){
1365 if( (pSib = db->aDb[i].pBt)!=0 && pSib->sharable ){
drhe53831d2007-08-17 01:14:38 +00001366 while( pSib->pPrev ){ pSib = pSib->pPrev; }
1367 if( p->pBt<pSib->pBt ){
1368 p->pNext = pSib;
1369 p->pPrev = 0;
1370 pSib->pPrev = p;
1371 }else{
drhabddb0c2007-08-20 13:14:28 +00001372 while( pSib->pNext && pSib->pNext->pBt<p->pBt ){
drhe53831d2007-08-17 01:14:38 +00001373 pSib = pSib->pNext;
1374 }
1375 p->pNext = pSib->pNext;
1376 p->pPrev = pSib;
1377 if( p->pNext ){
1378 p->pNext->pPrev = p;
1379 }
1380 pSib->pNext = p;
1381 }
1382 break;
1383 }
1384 }
danielk1977aef0bf62005-12-30 16:28:01 +00001385 }
danielk1977aef0bf62005-12-30 16:28:01 +00001386#endif
1387 *ppBtree = p;
danielk1977dddbcdc2007-04-26 14:42:34 +00001388
1389btree_open_out:
1390 if( rc!=SQLITE_OK ){
1391 if( pBt && pBt->pPager ){
1392 sqlite3PagerClose(pBt->pPager);
1393 }
drh17435752007-08-16 04:30:38 +00001394 sqlite3_free(pBt);
1395 sqlite3_free(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00001396 *ppBtree = 0;
1397 }
1398 return rc;
drha059ad02001-04-17 20:09:11 +00001399}
1400
1401/*
drhe53831d2007-08-17 01:14:38 +00001402** Decrement the BtShared.nRef counter. When it reaches zero,
1403** remove the BtShared structure from the sharing list. Return
1404** true if the BtShared.nRef counter reaches zero and return
1405** false if it is still positive.
1406*/
1407static int removeFromSharingList(BtShared *pBt){
1408#ifndef SQLITE_OMIT_SHARED_CACHE
1409 sqlite3_mutex *pMaster;
1410 BtShared *pList;
1411 int removed = 0;
1412
drhd677b3d2007-08-20 22:48:41 +00001413 assert( sqlite3_mutex_notheld(pBt->mutex) );
danielk197759f8c082008-06-18 17:09:10 +00001414 pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhe53831d2007-08-17 01:14:38 +00001415 sqlite3_mutex_enter(pMaster);
1416 pBt->nRef--;
1417 if( pBt->nRef<=0 ){
drh78f82d12008-09-02 00:52:52 +00001418 if( GLOBAL(BtShared*,sqlite3SharedCacheList)==pBt ){
1419 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt->pNext;
drhe53831d2007-08-17 01:14:38 +00001420 }else{
drh78f82d12008-09-02 00:52:52 +00001421 pList = GLOBAL(BtShared*,sqlite3SharedCacheList);
drh34004ce2008-07-11 16:15:17 +00001422 while( ALWAYS(pList) && pList->pNext!=pBt ){
drhe53831d2007-08-17 01:14:38 +00001423 pList=pList->pNext;
1424 }
drh34004ce2008-07-11 16:15:17 +00001425 if( ALWAYS(pList) ){
drhe53831d2007-08-17 01:14:38 +00001426 pList->pNext = pBt->pNext;
1427 }
1428 }
drh3285db22007-09-03 22:00:39 +00001429 if( SQLITE_THREADSAFE ){
1430 sqlite3_mutex_free(pBt->mutex);
1431 }
drhe53831d2007-08-17 01:14:38 +00001432 removed = 1;
1433 }
1434 sqlite3_mutex_leave(pMaster);
1435 return removed;
1436#else
1437 return 1;
1438#endif
1439}
1440
1441/*
drhf7141992008-06-19 00:16:08 +00001442** Make sure pBt->pTmpSpace points to an allocation of
1443** MX_CELL_SIZE(pBt) bytes.
1444*/
1445static void allocateTempSpace(BtShared *pBt){
1446 if( !pBt->pTmpSpace ){
1447 pBt->pTmpSpace = sqlite3PageMalloc( pBt->pageSize );
1448 }
1449}
1450
1451/*
1452** Free the pBt->pTmpSpace allocation
1453*/
1454static void freeTempSpace(BtShared *pBt){
1455 sqlite3PageFree( pBt->pTmpSpace);
1456 pBt->pTmpSpace = 0;
1457}
1458
1459/*
drha059ad02001-04-17 20:09:11 +00001460** Close an open database and invalidate all cursors.
1461*/
danielk1977aef0bf62005-12-30 16:28:01 +00001462int sqlite3BtreeClose(Btree *p){
danielk1977aef0bf62005-12-30 16:28:01 +00001463 BtShared *pBt = p->pBt;
1464 BtCursor *pCur;
1465
danielk1977aef0bf62005-12-30 16:28:01 +00001466 /* Close all cursors opened via this handle. */
drhe5fe6902007-12-07 18:55:28 +00001467 assert( sqlite3_mutex_held(p->db->mutex) );
drhe53831d2007-08-17 01:14:38 +00001468 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00001469 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00001470 pCur = pBt->pCursor;
1471 while( pCur ){
1472 BtCursor *pTmp = pCur;
1473 pCur = pCur->pNext;
1474 if( pTmp->pBtree==p ){
1475 sqlite3BtreeCloseCursor(pTmp);
1476 }
drha059ad02001-04-17 20:09:11 +00001477 }
danielk1977aef0bf62005-12-30 16:28:01 +00001478
danielk19778d34dfd2006-01-24 16:37:57 +00001479 /* Rollback any active transaction and free the handle structure.
1480 ** The call to sqlite3BtreeRollback() drops any table-locks held by
1481 ** this handle.
1482 */
danielk1977b597f742006-01-15 11:39:18 +00001483 sqlite3BtreeRollback(p);
drhe53831d2007-08-17 01:14:38 +00001484 sqlite3BtreeLeave(p);
danielk1977aef0bf62005-12-30 16:28:01 +00001485
danielk1977aef0bf62005-12-30 16:28:01 +00001486 /* If there are still other outstanding references to the shared-btree
1487 ** structure, return now. The remainder of this procedure cleans
1488 ** up the shared-btree.
1489 */
drhe53831d2007-08-17 01:14:38 +00001490 assert( p->wantToLock==0 && p->locked==0 );
1491 if( !p->sharable || removeFromSharingList(pBt) ){
1492 /* The pBt is no longer on the sharing list, so we can access
1493 ** it without having to hold the mutex.
1494 **
1495 ** Clean out and delete the BtShared object.
1496 */
1497 assert( !pBt->pCursor );
drhe53831d2007-08-17 01:14:38 +00001498 sqlite3PagerClose(pBt->pPager);
1499 if( pBt->xFreeSchema && pBt->pSchema ){
1500 pBt->xFreeSchema(pBt->pSchema);
1501 }
1502 sqlite3_free(pBt->pSchema);
drhf7141992008-06-19 00:16:08 +00001503 freeTempSpace(pBt);
drh65bbf292008-06-19 01:03:17 +00001504 sqlite3_free(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00001505 }
1506
drhe53831d2007-08-17 01:14:38 +00001507#ifndef SQLITE_OMIT_SHARED_CACHE
drhcab5ed72007-08-22 11:41:18 +00001508 assert( p->wantToLock==0 );
1509 assert( p->locked==0 );
1510 if( p->pPrev ) p->pPrev->pNext = p->pNext;
1511 if( p->pNext ) p->pNext->pPrev = p->pPrev;
danielk1977aef0bf62005-12-30 16:28:01 +00001512#endif
1513
drhe53831d2007-08-17 01:14:38 +00001514 sqlite3_free(p);
drha059ad02001-04-17 20:09:11 +00001515 return SQLITE_OK;
1516}
1517
1518/*
drhda47d772002-12-02 04:25:19 +00001519** Change the limit on the number of pages allowed in the cache.
drhcd61c282002-03-06 22:01:34 +00001520**
1521** The maximum number of cache pages is set to the absolute
1522** value of mxPage. If mxPage is negative, the pager will
1523** operate asynchronously - it will not stop to do fsync()s
1524** to insure data is written to the disk surface before
1525** continuing. Transactions still work if synchronous is off,
1526** and the database cannot be corrupted if this program
1527** crashes. But if the operating system crashes or there is
1528** an abrupt power failure when synchronous is off, the database
1529** could be left in an inconsistent and unrecoverable state.
1530** Synchronous is on by default so database corruption is not
1531** normally a worry.
drhf57b14a2001-09-14 18:54:08 +00001532*/
danielk1977aef0bf62005-12-30 16:28:01 +00001533int sqlite3BtreeSetCacheSize(Btree *p, int mxPage){
1534 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00001535 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00001536 sqlite3BtreeEnter(p);
danielk19773b8a05f2007-03-19 17:44:26 +00001537 sqlite3PagerSetCachesize(pBt->pPager, mxPage);
drhd677b3d2007-08-20 22:48:41 +00001538 sqlite3BtreeLeave(p);
drhf57b14a2001-09-14 18:54:08 +00001539 return SQLITE_OK;
1540}
1541
1542/*
drh973b6e32003-02-12 14:09:42 +00001543** Change the way data is synced to disk in order to increase or decrease
1544** how well the database resists damage due to OS crashes and power
1545** failures. Level 1 is the same as asynchronous (no syncs() occur and
1546** there is a high probability of damage) Level 2 is the default. There
1547** is a very low but non-zero probability of damage. Level 3 reduces the
1548** probability of damage to near zero but with a write performance reduction.
1549*/
danielk197793758c82005-01-21 08:13:14 +00001550#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drhac530b12006-02-11 01:25:50 +00001551int sqlite3BtreeSetSafetyLevel(Btree *p, int level, int fullSync){
danielk1977aef0bf62005-12-30 16:28:01 +00001552 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00001553 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00001554 sqlite3BtreeEnter(p);
danielk19773b8a05f2007-03-19 17:44:26 +00001555 sqlite3PagerSetSafetyLevel(pBt->pPager, level, fullSync);
drhd677b3d2007-08-20 22:48:41 +00001556 sqlite3BtreeLeave(p);
drh973b6e32003-02-12 14:09:42 +00001557 return SQLITE_OK;
1558}
danielk197793758c82005-01-21 08:13:14 +00001559#endif
drh973b6e32003-02-12 14:09:42 +00001560
drh2c8997b2005-08-27 16:36:48 +00001561/*
1562** Return TRUE if the given btree is set to safety level 1. In other
1563** words, return TRUE if no sync() occurs on the disk files.
1564*/
danielk1977aef0bf62005-12-30 16:28:01 +00001565int sqlite3BtreeSyncDisabled(Btree *p){
1566 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00001567 int rc;
drhe5fe6902007-12-07 18:55:28 +00001568 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00001569 sqlite3BtreeEnter(p);
drhd0679ed2007-08-28 22:24:34 +00001570 assert( pBt && pBt->pPager );
drhd677b3d2007-08-20 22:48:41 +00001571 rc = sqlite3PagerNosync(pBt->pPager);
1572 sqlite3BtreeLeave(p);
1573 return rc;
drh2c8997b2005-08-27 16:36:48 +00001574}
1575
danielk1977576ec6b2005-01-21 11:55:25 +00001576#if !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM)
drh973b6e32003-02-12 14:09:42 +00001577/*
drh90f5ecb2004-07-22 01:19:35 +00001578** Change the default pages size and the number of reserved bytes per page.
drh06f50212004-11-02 14:24:33 +00001579**
1580** The page size must be a power of 2 between 512 and 65536. If the page
1581** size supplied does not meet this constraint then the page size is not
1582** changed.
1583**
1584** Page sizes are constrained to be a power of two so that the region
1585** of the database file used for locking (beginning at PENDING_BYTE,
1586** the first byte past the 1GB boundary, 0x40000000) needs to occur
1587** at the beginning of a page.
danielk197728129562005-01-11 10:25:06 +00001588**
1589** If parameter nReserve is less than zero, then the number of reserved
1590** bytes per page is left unchanged.
drh90f5ecb2004-07-22 01:19:35 +00001591*/
danielk1977aef0bf62005-12-30 16:28:01 +00001592int sqlite3BtreeSetPageSize(Btree *p, int pageSize, int nReserve){
danielk1977a1644fd2007-08-29 12:31:25 +00001593 int rc = SQLITE_OK;
danielk1977aef0bf62005-12-30 16:28:01 +00001594 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00001595 sqlite3BtreeEnter(p);
drh90f5ecb2004-07-22 01:19:35 +00001596 if( pBt->pageSizeFixed ){
drhd677b3d2007-08-20 22:48:41 +00001597 sqlite3BtreeLeave(p);
drh90f5ecb2004-07-22 01:19:35 +00001598 return SQLITE_READONLY;
1599 }
1600 if( nReserve<0 ){
1601 nReserve = pBt->pageSize - pBt->usableSize;
1602 }
drh06f50212004-11-02 14:24:33 +00001603 if( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE &&
1604 ((pageSize-1)&pageSize)==0 ){
drh07d183d2005-05-01 22:52:42 +00001605 assert( (pageSize & 7)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00001606 assert( !pBt->pPage1 && !pBt->pCursor );
danielk1977a1644fd2007-08-29 12:31:25 +00001607 pBt->pageSize = pageSize;
drhf7141992008-06-19 00:16:08 +00001608 freeTempSpace(pBt);
danielk1977a1644fd2007-08-29 12:31:25 +00001609 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00001610 }
1611 pBt->usableSize = pBt->pageSize - nReserve;
drhd677b3d2007-08-20 22:48:41 +00001612 sqlite3BtreeLeave(p);
danielk1977a1644fd2007-08-29 12:31:25 +00001613 return rc;
drh90f5ecb2004-07-22 01:19:35 +00001614}
1615
1616/*
1617** Return the currently defined page size
1618*/
danielk1977aef0bf62005-12-30 16:28:01 +00001619int sqlite3BtreeGetPageSize(Btree *p){
1620 return p->pBt->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00001621}
danielk1977aef0bf62005-12-30 16:28:01 +00001622int sqlite3BtreeGetReserve(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00001623 int n;
1624 sqlite3BtreeEnter(p);
1625 n = p->pBt->pageSize - p->pBt->usableSize;
1626 sqlite3BtreeLeave(p);
1627 return n;
drh2011d5f2004-07-22 02:40:37 +00001628}
drhf8e632b2007-05-08 14:51:36 +00001629
1630/*
1631** Set the maximum page count for a database if mxPage is positive.
1632** No changes are made if mxPage is 0 or negative.
1633** Regardless of the value of mxPage, return the maximum page count.
1634*/
1635int sqlite3BtreeMaxPageCount(Btree *p, int mxPage){
drhd677b3d2007-08-20 22:48:41 +00001636 int n;
1637 sqlite3BtreeEnter(p);
1638 n = sqlite3PagerMaxPageCount(p->pBt->pPager, mxPage);
1639 sqlite3BtreeLeave(p);
1640 return n;
drhf8e632b2007-05-08 14:51:36 +00001641}
danielk1977576ec6b2005-01-21 11:55:25 +00001642#endif /* !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM) */
drh90f5ecb2004-07-22 01:19:35 +00001643
1644/*
danielk1977951af802004-11-05 15:45:09 +00001645** Change the 'auto-vacuum' property of the database. If the 'autoVacuum'
1646** parameter is non-zero, then auto-vacuum mode is enabled. If zero, it
1647** is disabled. The default value for the auto-vacuum property is
1648** determined by the SQLITE_DEFAULT_AUTOVACUUM macro.
1649*/
danielk1977aef0bf62005-12-30 16:28:01 +00001650int sqlite3BtreeSetAutoVacuum(Btree *p, int autoVacuum){
danielk1977951af802004-11-05 15:45:09 +00001651#ifdef SQLITE_OMIT_AUTOVACUUM
drheee46cf2004-11-06 00:02:48 +00001652 return SQLITE_READONLY;
danielk1977951af802004-11-05 15:45:09 +00001653#else
danielk1977dddbcdc2007-04-26 14:42:34 +00001654 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00001655 int rc = SQLITE_OK;
danielk1977dddbcdc2007-04-26 14:42:34 +00001656 int av = (autoVacuum?1:0);
drhd677b3d2007-08-20 22:48:41 +00001657
1658 sqlite3BtreeEnter(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00001659 if( pBt->pageSizeFixed && av!=pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00001660 rc = SQLITE_READONLY;
1661 }else{
1662 pBt->autoVacuum = av;
danielk1977951af802004-11-05 15:45:09 +00001663 }
drhd677b3d2007-08-20 22:48:41 +00001664 sqlite3BtreeLeave(p);
1665 return rc;
danielk1977951af802004-11-05 15:45:09 +00001666#endif
1667}
1668
1669/*
1670** Return the value of the 'auto-vacuum' property. If auto-vacuum is
1671** enabled 1 is returned. Otherwise 0.
1672*/
danielk1977aef0bf62005-12-30 16:28:01 +00001673int sqlite3BtreeGetAutoVacuum(Btree *p){
danielk1977951af802004-11-05 15:45:09 +00001674#ifdef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00001675 return BTREE_AUTOVACUUM_NONE;
danielk1977951af802004-11-05 15:45:09 +00001676#else
drhd677b3d2007-08-20 22:48:41 +00001677 int rc;
1678 sqlite3BtreeEnter(p);
1679 rc = (
danielk1977dddbcdc2007-04-26 14:42:34 +00001680 (!p->pBt->autoVacuum)?BTREE_AUTOVACUUM_NONE:
1681 (!p->pBt->incrVacuum)?BTREE_AUTOVACUUM_FULL:
1682 BTREE_AUTOVACUUM_INCR
1683 );
drhd677b3d2007-08-20 22:48:41 +00001684 sqlite3BtreeLeave(p);
1685 return rc;
danielk1977951af802004-11-05 15:45:09 +00001686#endif
1687}
1688
1689
1690/*
drha34b6762004-05-07 13:30:42 +00001691** Get a reference to pPage1 of the database file. This will
drh306dc212001-05-21 13:45:10 +00001692** also acquire a readlock on that file.
1693**
1694** SQLITE_OK is returned on success. If the file is not a
1695** well-formed database file, then SQLITE_CORRUPT is returned.
1696** SQLITE_BUSY is returned if the database is locked. SQLITE_NOMEM
drh4f0ee682007-03-30 20:43:40 +00001697** is returned if we run out of memory.
drh306dc212001-05-21 13:45:10 +00001698*/
danielk1977aef0bf62005-12-30 16:28:01 +00001699static int lockBtree(BtShared *pBt){
danielk1977f653d782008-03-20 11:04:21 +00001700 int rc;
drh3aac2dd2004-04-26 14:10:20 +00001701 MemPage *pPage1;
danielk197793f7af92008-05-09 16:57:50 +00001702 int nPage;
drhd677b3d2007-08-20 22:48:41 +00001703
drh1fee73e2007-08-29 04:00:57 +00001704 assert( sqlite3_mutex_held(pBt->mutex) );
drha34b6762004-05-07 13:30:42 +00001705 if( pBt->pPage1 ) return SQLITE_OK;
drh16a9b832007-05-05 18:39:25 +00001706 rc = sqlite3BtreeGetPage(pBt, 1, &pPage1, 0);
drh306dc212001-05-21 13:45:10 +00001707 if( rc!=SQLITE_OK ) return rc;
drh306dc212001-05-21 13:45:10 +00001708
1709 /* Do some checking to help insure the file we opened really is
1710 ** a valid database file.
1711 */
danielk1977ad0132d2008-06-07 08:58:22 +00001712 rc = sqlite3PagerPagecount(pBt->pPager, &nPage);
1713 if( rc!=SQLITE_OK ){
danielk197793f7af92008-05-09 16:57:50 +00001714 goto page1_init_failed;
1715 }else if( nPage>0 ){
danielk1977f653d782008-03-20 11:04:21 +00001716 int pageSize;
1717 int usableSize;
drhb6f41482004-05-14 01:58:11 +00001718 u8 *page1 = pPage1->aData;
danielk1977ad0132d2008-06-07 08:58:22 +00001719 rc = SQLITE_NOTADB;
drhb6f41482004-05-14 01:58:11 +00001720 if( memcmp(page1, zMagicHeader, 16)!=0 ){
drh72f82862001-05-24 21:06:34 +00001721 goto page1_init_failed;
drh306dc212001-05-21 13:45:10 +00001722 }
drh309169a2007-04-24 17:27:51 +00001723 if( page1[18]>1 ){
1724 pBt->readOnly = 1;
1725 }
1726 if( page1[19]>1 ){
drhb6f41482004-05-14 01:58:11 +00001727 goto page1_init_failed;
1728 }
drhe5ae5732008-06-15 02:51:47 +00001729
1730 /* The maximum embedded fraction must be exactly 25%. And the minimum
1731 ** embedded fraction must be 12.5% for both leaf-data and non-leaf-data.
1732 ** The original design allowed these amounts to vary, but as of
1733 ** version 3.6.0, we require them to be fixed.
1734 */
1735 if( memcmp(&page1[21], "\100\040\040",3)!=0 ){
1736 goto page1_init_failed;
1737 }
drh07d183d2005-05-01 22:52:42 +00001738 pageSize = get2byte(&page1[16]);
drh7dc385e2007-09-06 23:39:36 +00001739 if( ((pageSize-1)&pageSize)!=0 || pageSize<512 ||
1740 (SQLITE_MAX_PAGE_SIZE<32768 && pageSize>SQLITE_MAX_PAGE_SIZE)
1741 ){
drh07d183d2005-05-01 22:52:42 +00001742 goto page1_init_failed;
1743 }
1744 assert( (pageSize & 7)==0 );
danielk1977f653d782008-03-20 11:04:21 +00001745 usableSize = pageSize - page1[20];
1746 if( pageSize!=pBt->pageSize ){
1747 /* After reading the first page of the database assuming a page size
1748 ** of BtShared.pageSize, we have discovered that the page-size is
1749 ** actually pageSize. Unlock the database, leave pBt->pPage1 at
1750 ** zero and return SQLITE_OK. The caller will call this function
1751 ** again with the correct page-size.
1752 */
1753 releasePage(pPage1);
1754 pBt->usableSize = usableSize;
1755 pBt->pageSize = pageSize;
drhf7141992008-06-19 00:16:08 +00001756 freeTempSpace(pBt);
danielk1977f653d782008-03-20 11:04:21 +00001757 sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize);
1758 return SQLITE_OK;
1759 }
1760 if( usableSize<500 ){
drhb6f41482004-05-14 01:58:11 +00001761 goto page1_init_failed;
1762 }
danielk1977f653d782008-03-20 11:04:21 +00001763 pBt->pageSize = pageSize;
1764 pBt->usableSize = usableSize;
drh057cd3a2005-02-15 16:23:02 +00001765#ifndef SQLITE_OMIT_AUTOVACUUM
1766 pBt->autoVacuum = (get4byte(&page1[36 + 4*4])?1:0);
danielk197727b1f952007-06-25 08:16:58 +00001767 pBt->incrVacuum = (get4byte(&page1[36 + 7*4])?1:0);
drh057cd3a2005-02-15 16:23:02 +00001768#endif
drh306dc212001-05-21 13:45:10 +00001769 }
drhb6f41482004-05-14 01:58:11 +00001770
1771 /* maxLocal is the maximum amount of payload to store locally for
1772 ** a cell. Make sure it is small enough so that at least minFanout
1773 ** cells can will fit on one page. We assume a 10-byte page header.
1774 ** Besides the payload, the cell must store:
drh43605152004-05-29 21:46:49 +00001775 ** 2-byte pointer to the cell
drhb6f41482004-05-14 01:58:11 +00001776 ** 4-byte child pointer
1777 ** 9-byte nKey value
1778 ** 4-byte nData value
1779 ** 4-byte overflow page pointer
drh43605152004-05-29 21:46:49 +00001780 ** So a cell consists of a 2-byte poiner, a header which is as much as
1781 ** 17 bytes long, 0 to N bytes of payload, and an optional 4 byte overflow
1782 ** page pointer.
drhb6f41482004-05-14 01:58:11 +00001783 */
drhe5ae5732008-06-15 02:51:47 +00001784 pBt->maxLocal = (pBt->usableSize-12)*64/255 - 23;
1785 pBt->minLocal = (pBt->usableSize-12)*32/255 - 23;
drh43605152004-05-29 21:46:49 +00001786 pBt->maxLeaf = pBt->usableSize - 35;
drhe5ae5732008-06-15 02:51:47 +00001787 pBt->minLeaf = (pBt->usableSize-12)*32/255 - 23;
drh2e38c322004-09-03 18:38:44 +00001788 assert( pBt->maxLeaf + 23 <= MX_CELL_SIZE(pBt) );
drh3aac2dd2004-04-26 14:10:20 +00001789 pBt->pPage1 = pPage1;
drhb6f41482004-05-14 01:58:11 +00001790 return SQLITE_OK;
drh306dc212001-05-21 13:45:10 +00001791
drh72f82862001-05-24 21:06:34 +00001792page1_init_failed:
drh3aac2dd2004-04-26 14:10:20 +00001793 releasePage(pPage1);
1794 pBt->pPage1 = 0;
drh72f82862001-05-24 21:06:34 +00001795 return rc;
drh306dc212001-05-21 13:45:10 +00001796}
1797
1798/*
drhb8ef32c2005-03-14 02:01:49 +00001799** This routine works like lockBtree() except that it also invokes the
1800** busy callback if there is lock contention.
1801*/
danielk1977aef0bf62005-12-30 16:28:01 +00001802static int lockBtreeWithRetry(Btree *pRef){
drhb8ef32c2005-03-14 02:01:49 +00001803 int rc = SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00001804
drh1fee73e2007-08-29 04:00:57 +00001805 assert( sqlite3BtreeHoldsMutex(pRef) );
danielk1977aef0bf62005-12-30 16:28:01 +00001806 if( pRef->inTrans==TRANS_NONE ){
1807 u8 inTransaction = pRef->pBt->inTransaction;
1808 btreeIntegrity(pRef);
1809 rc = sqlite3BtreeBeginTrans(pRef, 0);
1810 pRef->pBt->inTransaction = inTransaction;
1811 pRef->inTrans = TRANS_NONE;
1812 if( rc==SQLITE_OK ){
1813 pRef->pBt->nTransaction--;
1814 }
1815 btreeIntegrity(pRef);
drhb8ef32c2005-03-14 02:01:49 +00001816 }
1817 return rc;
1818}
1819
1820
1821/*
drhb8ca3072001-12-05 00:21:20 +00001822** If there are no outstanding cursors and we are not in the middle
1823** of a transaction but there is a read lock on the database, then
1824** this routine unrefs the first page of the database file which
1825** has the effect of releasing the read lock.
1826**
1827** If there are any outstanding cursors, this routine is a no-op.
1828**
1829** If there is a transaction in progress, this routine is a no-op.
1830*/
danielk1977aef0bf62005-12-30 16:28:01 +00001831static void unlockBtreeIfUnused(BtShared *pBt){
drh1fee73e2007-08-29 04:00:57 +00001832 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977aef0bf62005-12-30 16:28:01 +00001833 if( pBt->inTransaction==TRANS_NONE && pBt->pCursor==0 && pBt->pPage1!=0 ){
danielk19773b8a05f2007-03-19 17:44:26 +00001834 if( sqlite3PagerRefcount(pBt->pPager)>=1 ){
drhde4fcfd2008-01-19 23:50:26 +00001835 assert( pBt->pPage1->aData );
1836#if 0
drh24c9a2e2007-01-05 02:00:47 +00001837 if( pBt->pPage1->aData==0 ){
1838 MemPage *pPage = pBt->pPage1;
drhbf4bca52007-09-06 22:19:14 +00001839 pPage->aData = sqlite3PagerGetData(pPage->pDbPage);
drh24c9a2e2007-01-05 02:00:47 +00001840 pPage->pBt = pBt;
1841 pPage->pgno = 1;
1842 }
drhde4fcfd2008-01-19 23:50:26 +00001843#endif
drh24c9a2e2007-01-05 02:00:47 +00001844 releasePage(pBt->pPage1);
drh51c6d962004-06-06 00:42:25 +00001845 }
drh3aac2dd2004-04-26 14:10:20 +00001846 pBt->pPage1 = 0;
drh3aac2dd2004-04-26 14:10:20 +00001847 pBt->inStmt = 0;
drhb8ca3072001-12-05 00:21:20 +00001848 }
1849}
1850
1851/*
drh9e572e62004-04-23 23:43:10 +00001852** Create a new database by initializing the first page of the
drh8c42ca92001-06-22 19:15:00 +00001853** file.
drh8b2f49b2001-06-08 00:21:52 +00001854*/
danielk1977aef0bf62005-12-30 16:28:01 +00001855static int newDatabase(BtShared *pBt){
drh9e572e62004-04-23 23:43:10 +00001856 MemPage *pP1;
1857 unsigned char *data;
drh8c42ca92001-06-22 19:15:00 +00001858 int rc;
danielk1977ad0132d2008-06-07 08:58:22 +00001859 int nPage;
drhd677b3d2007-08-20 22:48:41 +00001860
drh1fee73e2007-08-29 04:00:57 +00001861 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977ad0132d2008-06-07 08:58:22 +00001862 rc = sqlite3PagerPagecount(pBt->pPager, &nPage);
1863 if( rc!=SQLITE_OK || nPage>0 ){
1864 return rc;
1865 }
drh3aac2dd2004-04-26 14:10:20 +00001866 pP1 = pBt->pPage1;
drh9e572e62004-04-23 23:43:10 +00001867 assert( pP1!=0 );
1868 data = pP1->aData;
danielk19773b8a05f2007-03-19 17:44:26 +00001869 rc = sqlite3PagerWrite(pP1->pDbPage);
drh8b2f49b2001-06-08 00:21:52 +00001870 if( rc ) return rc;
drh9e572e62004-04-23 23:43:10 +00001871 memcpy(data, zMagicHeader, sizeof(zMagicHeader));
1872 assert( sizeof(zMagicHeader)==16 );
drhb6f41482004-05-14 01:58:11 +00001873 put2byte(&data[16], pBt->pageSize);
drh9e572e62004-04-23 23:43:10 +00001874 data[18] = 1;
1875 data[19] = 1;
drhb6f41482004-05-14 01:58:11 +00001876 data[20] = pBt->pageSize - pBt->usableSize;
drhe5ae5732008-06-15 02:51:47 +00001877 data[21] = 64;
1878 data[22] = 32;
1879 data[23] = 32;
drhb6f41482004-05-14 01:58:11 +00001880 memset(&data[24], 0, 100-24);
drhe6c43812004-05-14 12:17:46 +00001881 zeroPage(pP1, PTF_INTKEY|PTF_LEAF|PTF_LEAFDATA );
drhf2a611c2004-09-05 00:33:43 +00001882 pBt->pageSizeFixed = 1;
danielk1977003ba062004-11-04 02:57:33 +00001883#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00001884 assert( pBt->autoVacuum==1 || pBt->autoVacuum==0 );
danielk1977418899a2007-06-24 10:14:00 +00001885 assert( pBt->incrVacuum==1 || pBt->incrVacuum==0 );
danielk1977dddbcdc2007-04-26 14:42:34 +00001886 put4byte(&data[36 + 4*4], pBt->autoVacuum);
danielk1977418899a2007-06-24 10:14:00 +00001887 put4byte(&data[36 + 7*4], pBt->incrVacuum);
danielk1977003ba062004-11-04 02:57:33 +00001888#endif
drh8b2f49b2001-06-08 00:21:52 +00001889 return SQLITE_OK;
1890}
1891
1892/*
danielk1977ee5741e2004-05-31 10:01:34 +00001893** Attempt to start a new transaction. A write-transaction
drh684917c2004-10-05 02:41:42 +00001894** is started if the second argument is nonzero, otherwise a read-
1895** transaction. If the second argument is 2 or more and exclusive
1896** transaction is started, meaning that no other process is allowed
1897** to access the database. A preexisting transaction may not be
drhb8ef32c2005-03-14 02:01:49 +00001898** upgraded to exclusive by calling this routine a second time - the
drh684917c2004-10-05 02:41:42 +00001899** exclusivity flag only works for a new transaction.
drh8b2f49b2001-06-08 00:21:52 +00001900**
danielk1977ee5741e2004-05-31 10:01:34 +00001901** A write-transaction must be started before attempting any
1902** changes to the database. None of the following routines
1903** will work unless a transaction is started first:
drh8b2f49b2001-06-08 00:21:52 +00001904**
drh23e11ca2004-05-04 17:27:28 +00001905** sqlite3BtreeCreateTable()
1906** sqlite3BtreeCreateIndex()
1907** sqlite3BtreeClearTable()
1908** sqlite3BtreeDropTable()
1909** sqlite3BtreeInsert()
1910** sqlite3BtreeDelete()
1911** sqlite3BtreeUpdateMeta()
danielk197713adf8a2004-06-03 16:08:41 +00001912**
drhb8ef32c2005-03-14 02:01:49 +00001913** If an initial attempt to acquire the lock fails because of lock contention
1914** and the database was previously unlocked, then invoke the busy handler
1915** if there is one. But if there was previously a read-lock, do not
1916** invoke the busy handler - just return SQLITE_BUSY. SQLITE_BUSY is
1917** returned when there is already a read-lock in order to avoid a deadlock.
1918**
1919** Suppose there are two processes A and B. A has a read lock and B has
1920** a reserved lock. B tries to promote to exclusive but is blocked because
1921** of A's read lock. A tries to promote to reserved but is blocked by B.
1922** One or the other of the two processes must give way or there can be
1923** no progress. By returning SQLITE_BUSY and not invoking the busy callback
1924** when A already has a read lock, we encourage A to give up and let B
1925** proceed.
drha059ad02001-04-17 20:09:11 +00001926*/
danielk1977aef0bf62005-12-30 16:28:01 +00001927int sqlite3BtreeBeginTrans(Btree *p, int wrflag){
1928 BtShared *pBt = p->pBt;
danielk1977ee5741e2004-05-31 10:01:34 +00001929 int rc = SQLITE_OK;
1930
drhd677b3d2007-08-20 22:48:41 +00001931 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00001932 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00001933 btreeIntegrity(p);
1934
danielk1977ee5741e2004-05-31 10:01:34 +00001935 /* If the btree is already in a write-transaction, or it
1936 ** is already in a read-transaction and a read-transaction
1937 ** is requested, this is a no-op.
1938 */
danielk1977aef0bf62005-12-30 16:28:01 +00001939 if( p->inTrans==TRANS_WRITE || (p->inTrans==TRANS_READ && !wrflag) ){
drhd677b3d2007-08-20 22:48:41 +00001940 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00001941 }
drhb8ef32c2005-03-14 02:01:49 +00001942
1943 /* Write transactions are not possible on a read-only database */
danielk1977ee5741e2004-05-31 10:01:34 +00001944 if( pBt->readOnly && wrflag ){
drhd677b3d2007-08-20 22:48:41 +00001945 rc = SQLITE_READONLY;
1946 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00001947 }
1948
danielk1977aef0bf62005-12-30 16:28:01 +00001949 /* If another database handle has already opened a write transaction
1950 ** on this shared-btree structure and a second write transaction is
1951 ** requested, return SQLITE_BUSY.
1952 */
1953 if( pBt->inTransaction==TRANS_WRITE && wrflag ){
drhd677b3d2007-08-20 22:48:41 +00001954 rc = SQLITE_BUSY;
1955 goto trans_begun;
danielk1977aef0bf62005-12-30 16:28:01 +00001956 }
1957
danielk1977641b0f42007-12-21 04:47:25 +00001958#ifndef SQLITE_OMIT_SHARED_CACHE
1959 if( wrflag>1 ){
1960 BtLock *pIter;
1961 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
1962 if( pIter->pBtree!=p ){
1963 rc = SQLITE_BUSY;
1964 goto trans_begun;
1965 }
1966 }
1967 }
1968#endif
1969
drhb8ef32c2005-03-14 02:01:49 +00001970 do {
drh8a9c17f2008-05-02 14:23:54 +00001971 if( pBt->pPage1==0 ){
1972 do{
1973 rc = lockBtree(pBt);
1974 }while( pBt->pPage1==0 && rc==SQLITE_OK );
drh8c42ca92001-06-22 19:15:00 +00001975 }
drh309169a2007-04-24 17:27:51 +00001976
drhb8ef32c2005-03-14 02:01:49 +00001977 if( rc==SQLITE_OK && wrflag ){
drh309169a2007-04-24 17:27:51 +00001978 if( pBt->readOnly ){
1979 rc = SQLITE_READONLY;
1980 }else{
1981 rc = sqlite3PagerBegin(pBt->pPage1->pDbPage, wrflag>1);
1982 if( rc==SQLITE_OK ){
1983 rc = newDatabase(pBt);
1984 }
drhb8ef32c2005-03-14 02:01:49 +00001985 }
1986 }
1987
1988 if( rc==SQLITE_OK ){
drhb8ef32c2005-03-14 02:01:49 +00001989 if( wrflag ) pBt->inStmt = 0;
1990 }else{
1991 unlockBtreeIfUnused(pBt);
1992 }
danielk1977aef0bf62005-12-30 16:28:01 +00001993 }while( rc==SQLITE_BUSY && pBt->inTransaction==TRANS_NONE &&
drhe5fe6902007-12-07 18:55:28 +00001994 sqlite3BtreeInvokeBusyHandler(pBt, 0) );
danielk1977aef0bf62005-12-30 16:28:01 +00001995
1996 if( rc==SQLITE_OK ){
1997 if( p->inTrans==TRANS_NONE ){
1998 pBt->nTransaction++;
1999 }
2000 p->inTrans = (wrflag?TRANS_WRITE:TRANS_READ);
2001 if( p->inTrans>pBt->inTransaction ){
2002 pBt->inTransaction = p->inTrans;
2003 }
danielk1977641b0f42007-12-21 04:47:25 +00002004#ifndef SQLITE_OMIT_SHARED_CACHE
2005 if( wrflag>1 ){
2006 assert( !pBt->pExclusive );
2007 pBt->pExclusive = p;
2008 }
2009#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002010 }
2011
drhd677b3d2007-08-20 22:48:41 +00002012
2013trans_begun:
danielk1977aef0bf62005-12-30 16:28:01 +00002014 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00002015 sqlite3BtreeLeave(p);
drhb8ca3072001-12-05 00:21:20 +00002016 return rc;
drha059ad02001-04-17 20:09:11 +00002017}
2018
drh4a0611d2008-07-18 17:16:26 +00002019/*
2020** Return the size of the database file in pages. Or return -1 if
2021** there is any kind of error.
2022*/
2023static int pagerPagecount(Pager *pPager){
2024 int rc;
2025 int nPage;
2026 rc = sqlite3PagerPagecount(pPager, &nPage);
2027 return (rc==SQLITE_OK?nPage:-1);
2028}
2029
2030
danielk1977687566d2004-11-02 12:56:41 +00002031#ifndef SQLITE_OMIT_AUTOVACUUM
2032
2033/*
2034** Set the pointer-map entries for all children of page pPage. Also, if
2035** pPage contains cells that point to overflow pages, set the pointer
2036** map entries for the overflow pages as well.
2037*/
2038static int setChildPtrmaps(MemPage *pPage){
2039 int i; /* Counter variable */
2040 int nCell; /* Number of cells in page pPage */
danielk19772df71c72007-05-24 07:22:42 +00002041 int rc; /* Return code */
danielk1977aef0bf62005-12-30 16:28:01 +00002042 BtShared *pBt = pPage->pBt;
danielk1977687566d2004-11-02 12:56:41 +00002043 int isInitOrig = pPage->isInit;
2044 Pgno pgno = pPage->pgno;
2045
drh1fee73e2007-08-29 04:00:57 +00002046 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19772df71c72007-05-24 07:22:42 +00002047 rc = sqlite3BtreeInitPage(pPage, pPage->pParent);
2048 if( rc!=SQLITE_OK ){
2049 goto set_child_ptrmaps_out;
2050 }
danielk1977687566d2004-11-02 12:56:41 +00002051 nCell = pPage->nCell;
2052
2053 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00002054 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00002055
danielk197726836652005-01-17 01:33:13 +00002056 rc = ptrmapPutOvflPtr(pPage, pCell);
2057 if( rc!=SQLITE_OK ){
2058 goto set_child_ptrmaps_out;
danielk1977687566d2004-11-02 12:56:41 +00002059 }
danielk197726836652005-01-17 01:33:13 +00002060
danielk1977687566d2004-11-02 12:56:41 +00002061 if( !pPage->leaf ){
2062 Pgno childPgno = get4byte(pCell);
2063 rc = ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno);
danielk19771bc71592008-07-08 17:13:59 +00002064 if( rc!=SQLITE_OK ) goto set_child_ptrmaps_out;
danielk1977687566d2004-11-02 12:56:41 +00002065 }
2066 }
2067
2068 if( !pPage->leaf ){
2069 Pgno childPgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
2070 rc = ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno);
2071 }
2072
2073set_child_ptrmaps_out:
2074 pPage->isInit = isInitOrig;
2075 return rc;
2076}
2077
2078/*
2079** Somewhere on pPage, which is guarenteed to be a btree page, not an overflow
2080** page, is a pointer to page iFrom. Modify this pointer so that it points to
2081** iTo. Parameter eType describes the type of pointer to be modified, as
2082** follows:
2083**
2084** PTRMAP_BTREE: pPage is a btree-page. The pointer points at a child
2085** page of pPage.
2086**
2087** PTRMAP_OVERFLOW1: pPage is a btree-page. The pointer points at an overflow
2088** page pointed to by one of the cells on pPage.
2089**
2090** PTRMAP_OVERFLOW2: pPage is an overflow-page. The pointer points at the next
2091** overflow page in the list.
2092*/
danielk1977fdb7cdb2005-01-17 02:12:18 +00002093static int modifyPagePointer(MemPage *pPage, Pgno iFrom, Pgno iTo, u8 eType){
drh1fee73e2007-08-29 04:00:57 +00002094 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk1977687566d2004-11-02 12:56:41 +00002095 if( eType==PTRMAP_OVERFLOW2 ){
danielk1977f78fc082004-11-02 14:40:32 +00002096 /* The pointer is always the first 4 bytes of the page in this case. */
danielk1977fdb7cdb2005-01-17 02:12:18 +00002097 if( get4byte(pPage->aData)!=iFrom ){
drh49285702005-09-17 15:20:26 +00002098 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +00002099 }
danielk1977f78fc082004-11-02 14:40:32 +00002100 put4byte(pPage->aData, iTo);
danielk1977687566d2004-11-02 12:56:41 +00002101 }else{
2102 int isInitOrig = pPage->isInit;
2103 int i;
2104 int nCell;
2105
drh16a9b832007-05-05 18:39:25 +00002106 sqlite3BtreeInitPage(pPage, 0);
danielk1977687566d2004-11-02 12:56:41 +00002107 nCell = pPage->nCell;
2108
danielk1977687566d2004-11-02 12:56:41 +00002109 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00002110 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00002111 if( eType==PTRMAP_OVERFLOW1 ){
2112 CellInfo info;
drh16a9b832007-05-05 18:39:25 +00002113 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
danielk1977687566d2004-11-02 12:56:41 +00002114 if( info.iOverflow ){
2115 if( iFrom==get4byte(&pCell[info.iOverflow]) ){
2116 put4byte(&pCell[info.iOverflow], iTo);
2117 break;
2118 }
2119 }
2120 }else{
2121 if( get4byte(pCell)==iFrom ){
2122 put4byte(pCell, iTo);
2123 break;
2124 }
2125 }
2126 }
2127
2128 if( i==nCell ){
danielk1977fdb7cdb2005-01-17 02:12:18 +00002129 if( eType!=PTRMAP_BTREE ||
2130 get4byte(&pPage->aData[pPage->hdrOffset+8])!=iFrom ){
drh49285702005-09-17 15:20:26 +00002131 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +00002132 }
danielk1977687566d2004-11-02 12:56:41 +00002133 put4byte(&pPage->aData[pPage->hdrOffset+8], iTo);
2134 }
2135
2136 pPage->isInit = isInitOrig;
2137 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00002138 return SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00002139}
2140
danielk1977003ba062004-11-04 02:57:33 +00002141
danielk19777701e812005-01-10 12:59:51 +00002142/*
2143** Move the open database page pDbPage to location iFreePage in the
2144** database. The pDbPage reference remains valid.
2145*/
danielk1977003ba062004-11-04 02:57:33 +00002146static int relocatePage(
danielk1977aef0bf62005-12-30 16:28:01 +00002147 BtShared *pBt, /* Btree */
danielk19777701e812005-01-10 12:59:51 +00002148 MemPage *pDbPage, /* Open page to move */
2149 u8 eType, /* Pointer map 'type' entry for pDbPage */
2150 Pgno iPtrPage, /* Pointer map 'page-no' entry for pDbPage */
danielk19774c999992008-07-16 18:17:55 +00002151 Pgno iFreePage, /* The location to move pDbPage to */
2152 int isCommit
danielk1977003ba062004-11-04 02:57:33 +00002153){
2154 MemPage *pPtrPage; /* The page that contains a pointer to pDbPage */
2155 Pgno iDbPage = pDbPage->pgno;
2156 Pager *pPager = pBt->pPager;
2157 int rc;
2158
danielk1977a0bf2652004-11-04 14:30:04 +00002159 assert( eType==PTRMAP_OVERFLOW2 || eType==PTRMAP_OVERFLOW1 ||
2160 eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE );
drh1fee73e2007-08-29 04:00:57 +00002161 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +00002162 assert( pDbPage->pBt==pBt );
danielk1977003ba062004-11-04 02:57:33 +00002163
drh85b623f2007-12-13 21:54:09 +00002164 /* Move page iDbPage from its current location to page number iFreePage */
danielk1977003ba062004-11-04 02:57:33 +00002165 TRACE(("AUTOVACUUM: Moving %d to free page %d (ptr page %d type %d)\n",
2166 iDbPage, iFreePage, iPtrPage, eType));
danielk19774c999992008-07-16 18:17:55 +00002167 rc = sqlite3PagerMovepage(pPager, pDbPage->pDbPage, iFreePage, isCommit);
danielk1977003ba062004-11-04 02:57:33 +00002168 if( rc!=SQLITE_OK ){
2169 return rc;
2170 }
2171 pDbPage->pgno = iFreePage;
2172
2173 /* If pDbPage was a btree-page, then it may have child pages and/or cells
2174 ** that point to overflow pages. The pointer map entries for all these
2175 ** pages need to be changed.
2176 **
2177 ** If pDbPage is an overflow page, then the first 4 bytes may store a
2178 ** pointer to a subsequent overflow page. If this is the case, then
2179 ** the pointer map needs to be updated for the subsequent overflow page.
2180 */
danielk1977a0bf2652004-11-04 14:30:04 +00002181 if( eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00002182 rc = setChildPtrmaps(pDbPage);
2183 if( rc!=SQLITE_OK ){
2184 return rc;
2185 }
2186 }else{
2187 Pgno nextOvfl = get4byte(pDbPage->aData);
2188 if( nextOvfl!=0 ){
danielk1977003ba062004-11-04 02:57:33 +00002189 rc = ptrmapPut(pBt, nextOvfl, PTRMAP_OVERFLOW2, iFreePage);
2190 if( rc!=SQLITE_OK ){
2191 return rc;
2192 }
2193 }
2194 }
2195
2196 /* Fix the database pointer on page iPtrPage that pointed at iDbPage so
2197 ** that it points at iFreePage. Also fix the pointer map entry for
2198 ** iPtrPage.
2199 */
danielk1977a0bf2652004-11-04 14:30:04 +00002200 if( eType!=PTRMAP_ROOTPAGE ){
drh16a9b832007-05-05 18:39:25 +00002201 rc = sqlite3BtreeGetPage(pBt, iPtrPage, &pPtrPage, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00002202 if( rc!=SQLITE_OK ){
2203 return rc;
2204 }
danielk19773b8a05f2007-03-19 17:44:26 +00002205 rc = sqlite3PagerWrite(pPtrPage->pDbPage);
danielk1977a0bf2652004-11-04 14:30:04 +00002206 if( rc!=SQLITE_OK ){
2207 releasePage(pPtrPage);
2208 return rc;
2209 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00002210 rc = modifyPagePointer(pPtrPage, iDbPage, iFreePage, eType);
danielk1977003ba062004-11-04 02:57:33 +00002211 releasePage(pPtrPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00002212 if( rc==SQLITE_OK ){
2213 rc = ptrmapPut(pBt, iFreePage, eType, iPtrPage);
2214 }
danielk1977003ba062004-11-04 02:57:33 +00002215 }
danielk1977003ba062004-11-04 02:57:33 +00002216 return rc;
2217}
2218
danielk1977dddbcdc2007-04-26 14:42:34 +00002219/* Forward declaration required by incrVacuumStep(). */
drh4f0c5872007-03-26 22:05:01 +00002220static int allocateBtreePage(BtShared *, MemPage **, Pgno *, Pgno, u8);
danielk1977687566d2004-11-02 12:56:41 +00002221
2222/*
danielk1977dddbcdc2007-04-26 14:42:34 +00002223** Perform a single step of an incremental-vacuum. If successful,
2224** return SQLITE_OK. If there is no work to do (and therefore no
2225** point in calling this function again), return SQLITE_DONE.
2226**
2227** More specificly, this function attempts to re-organize the
2228** database so that the last page of the file currently in use
2229** is no longer in use.
2230**
2231** If the nFin parameter is non-zero, the implementation assumes
2232** that the caller will keep calling incrVacuumStep() until
2233** it returns SQLITE_DONE or an error, and that nFin is the
2234** number of pages the database file will contain after this
2235** process is complete.
2236*/
2237static int incrVacuumStep(BtShared *pBt, Pgno nFin){
2238 Pgno iLastPg; /* Last page in the database */
2239 Pgno nFreeList; /* Number of pages still on the free-list */
2240
drh1fee73e2007-08-29 04:00:57 +00002241 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977dddbcdc2007-04-26 14:42:34 +00002242 iLastPg = pBt->nTrunc;
2243 if( iLastPg==0 ){
danielk1977ad0132d2008-06-07 08:58:22 +00002244 iLastPg = pagerPagecount(pBt->pPager);
danielk1977dddbcdc2007-04-26 14:42:34 +00002245 }
2246
2247 if( !PTRMAP_ISPAGE(pBt, iLastPg) && iLastPg!=PENDING_BYTE_PAGE(pBt) ){
2248 int rc;
2249 u8 eType;
2250 Pgno iPtrPage;
2251
2252 nFreeList = get4byte(&pBt->pPage1->aData[36]);
2253 if( nFreeList==0 || nFin==iLastPg ){
2254 return SQLITE_DONE;
2255 }
2256
2257 rc = ptrmapGet(pBt, iLastPg, &eType, &iPtrPage);
2258 if( rc!=SQLITE_OK ){
2259 return rc;
2260 }
2261 if( eType==PTRMAP_ROOTPAGE ){
2262 return SQLITE_CORRUPT_BKPT;
2263 }
2264
2265 if( eType==PTRMAP_FREEPAGE ){
2266 if( nFin==0 ){
2267 /* Remove the page from the files free-list. This is not required
danielk19774ef24492007-05-23 09:52:41 +00002268 ** if nFin is non-zero. In that case, the free-list will be
danielk1977dddbcdc2007-04-26 14:42:34 +00002269 ** truncated to zero after this function returns, so it doesn't
2270 ** matter if it still contains some garbage entries.
2271 */
2272 Pgno iFreePg;
2273 MemPage *pFreePg;
2274 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iLastPg, 1);
2275 if( rc!=SQLITE_OK ){
2276 return rc;
2277 }
2278 assert( iFreePg==iLastPg );
2279 releasePage(pFreePg);
2280 }
2281 } else {
2282 Pgno iFreePg; /* Index of free page to move pLastPg to */
2283 MemPage *pLastPg;
2284
drh16a9b832007-05-05 18:39:25 +00002285 rc = sqlite3BtreeGetPage(pBt, iLastPg, &pLastPg, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00002286 if( rc!=SQLITE_OK ){
2287 return rc;
2288 }
2289
danielk1977b4626a32007-04-28 15:47:43 +00002290 /* If nFin is zero, this loop runs exactly once and page pLastPg
2291 ** is swapped with the first free page pulled off the free list.
2292 **
2293 ** On the other hand, if nFin is greater than zero, then keep
2294 ** looping until a free-page located within the first nFin pages
2295 ** of the file is found.
2296 */
danielk1977dddbcdc2007-04-26 14:42:34 +00002297 do {
2298 MemPage *pFreePg;
2299 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, 0, 0);
2300 if( rc!=SQLITE_OK ){
2301 releasePage(pLastPg);
2302 return rc;
2303 }
2304 releasePage(pFreePg);
2305 }while( nFin!=0 && iFreePg>nFin );
2306 assert( iFreePg<iLastPg );
danielk1977b4626a32007-04-28 15:47:43 +00002307
2308 rc = sqlite3PagerWrite(pLastPg->pDbPage);
danielk1977662278e2007-11-05 15:30:12 +00002309 if( rc==SQLITE_OK ){
danielk19774c999992008-07-16 18:17:55 +00002310 rc = relocatePage(pBt, pLastPg, eType, iPtrPage, iFreePg, nFin!=0);
danielk1977662278e2007-11-05 15:30:12 +00002311 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002312 releasePage(pLastPg);
2313 if( rc!=SQLITE_OK ){
2314 return rc;
danielk1977662278e2007-11-05 15:30:12 +00002315 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002316 }
2317 }
2318
2319 pBt->nTrunc = iLastPg - 1;
2320 while( pBt->nTrunc==PENDING_BYTE_PAGE(pBt)||PTRMAP_ISPAGE(pBt, pBt->nTrunc) ){
2321 pBt->nTrunc--;
2322 }
2323 return SQLITE_OK;
2324}
2325
2326/*
2327** A write-transaction must be opened before calling this function.
2328** It performs a single unit of work towards an incremental vacuum.
2329**
2330** If the incremental vacuum is finished after this function has run,
2331** SQLITE_DONE is returned. If it is not finished, but no error occured,
2332** SQLITE_OK is returned. Otherwise an SQLite error code.
2333*/
2334int sqlite3BtreeIncrVacuum(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00002335 int rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00002336 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002337
2338 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002339 pBt->db = p->db;
danielk1977dddbcdc2007-04-26 14:42:34 +00002340 assert( pBt->inTransaction==TRANS_WRITE && p->inTrans==TRANS_WRITE );
2341 if( !pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00002342 rc = SQLITE_DONE;
2343 }else{
2344 invalidateAllOverflowCache(pBt);
2345 rc = incrVacuumStep(pBt, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00002346 }
drhd677b3d2007-08-20 22:48:41 +00002347 sqlite3BtreeLeave(p);
2348 return rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00002349}
2350
2351/*
danielk19773b8a05f2007-03-19 17:44:26 +00002352** This routine is called prior to sqlite3PagerCommit when a transaction
danielk1977687566d2004-11-02 12:56:41 +00002353** is commited for an auto-vacuum database.
danielk197724168722007-04-02 05:07:47 +00002354**
2355** If SQLITE_OK is returned, then *pnTrunc is set to the number of pages
2356** the database file should be truncated to during the commit process.
2357** i.e. the database has been reorganized so that only the first *pnTrunc
2358** pages are in use.
danielk1977687566d2004-11-02 12:56:41 +00002359*/
danielk197724168722007-04-02 05:07:47 +00002360static int autoVacuumCommit(BtShared *pBt, Pgno *pnTrunc){
danielk1977dddbcdc2007-04-26 14:42:34 +00002361 int rc = SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00002362 Pager *pPager = pBt->pPager;
danielk1977687566d2004-11-02 12:56:41 +00002363#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00002364 int nRef = sqlite3PagerRefcount(pPager);
danielk1977687566d2004-11-02 12:56:41 +00002365#endif
2366
drh1fee73e2007-08-29 04:00:57 +00002367 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +00002368 invalidateAllOverflowCache(pBt);
danielk1977dddbcdc2007-04-26 14:42:34 +00002369 assert(pBt->autoVacuum);
2370 if( !pBt->incrVacuum ){
2371 Pgno nFin = 0;
danielk1977687566d2004-11-02 12:56:41 +00002372
danielk1977dddbcdc2007-04-26 14:42:34 +00002373 if( pBt->nTrunc==0 ){
2374 Pgno nFree;
2375 Pgno nPtrmap;
2376 const int pgsz = pBt->pageSize;
danielk1977ad0132d2008-06-07 08:58:22 +00002377 int nOrig = pagerPagecount(pBt->pPager);
danielk1977e5321f02007-04-27 07:05:44 +00002378
2379 if( PTRMAP_ISPAGE(pBt, nOrig) ){
2380 return SQLITE_CORRUPT_BKPT;
2381 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002382 if( nOrig==PENDING_BYTE_PAGE(pBt) ){
2383 nOrig--;
danielk1977687566d2004-11-02 12:56:41 +00002384 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002385 nFree = get4byte(&pBt->pPage1->aData[36]);
2386 nPtrmap = (nFree-nOrig+PTRMAP_PAGENO(pBt, nOrig)+pgsz/5)/(pgsz/5);
2387 nFin = nOrig - nFree - nPtrmap;
2388 if( nOrig>PENDING_BYTE_PAGE(pBt) && nFin<=PENDING_BYTE_PAGE(pBt) ){
2389 nFin--;
danielk1977ac11ee62005-01-15 12:45:51 +00002390 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002391 while( PTRMAP_ISPAGE(pBt, nFin) || nFin==PENDING_BYTE_PAGE(pBt) ){
2392 nFin--;
2393 }
2394 }
danielk1977687566d2004-11-02 12:56:41 +00002395
danielk1977dddbcdc2007-04-26 14:42:34 +00002396 while( rc==SQLITE_OK ){
2397 rc = incrVacuumStep(pBt, nFin);
2398 }
2399 if( rc==SQLITE_DONE ){
2400 assert(nFin==0 || pBt->nTrunc==0 || nFin<=pBt->nTrunc);
2401 rc = SQLITE_OK;
danielk19770ba32df2008-05-07 07:13:16 +00002402 if( pBt->nTrunc && nFin ){
drh67f80b62007-07-23 19:26:17 +00002403 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
danielk1977dddbcdc2007-04-26 14:42:34 +00002404 put4byte(&pBt->pPage1->aData[32], 0);
2405 put4byte(&pBt->pPage1->aData[36], 0);
2406 pBt->nTrunc = nFin;
2407 }
2408 }
2409 if( rc!=SQLITE_OK ){
2410 sqlite3PagerRollback(pPager);
2411 }
danielk1977687566d2004-11-02 12:56:41 +00002412 }
2413
danielk1977dddbcdc2007-04-26 14:42:34 +00002414 if( rc==SQLITE_OK ){
2415 *pnTrunc = pBt->nTrunc;
2416 pBt->nTrunc = 0;
2417 }
danielk19773b8a05f2007-03-19 17:44:26 +00002418 assert( nRef==sqlite3PagerRefcount(pPager) );
danielk1977687566d2004-11-02 12:56:41 +00002419 return rc;
2420}
danielk1977dddbcdc2007-04-26 14:42:34 +00002421
danielk1977687566d2004-11-02 12:56:41 +00002422#endif
2423
2424/*
drh80e35f42007-03-30 14:06:34 +00002425** This routine does the first phase of a two-phase commit. This routine
2426** causes a rollback journal to be created (if it does not already exist)
2427** and populated with enough information so that if a power loss occurs
2428** the database can be restored to its original state by playing back
2429** the journal. Then the contents of the journal are flushed out to
2430** the disk. After the journal is safely on oxide, the changes to the
2431** database are written into the database file and flushed to oxide.
2432** At the end of this call, the rollback journal still exists on the
2433** disk and we are still holding all locks, so the transaction has not
2434** committed. See sqlite3BtreeCommit() for the second phase of the
2435** commit process.
2436**
2437** This call is a no-op if no write-transaction is currently active on pBt.
2438**
2439** Otherwise, sync the database file for the btree pBt. zMaster points to
2440** the name of a master journal file that should be written into the
2441** individual journal file, or is NULL, indicating no master journal file
2442** (single database transaction).
2443**
2444** When this is called, the master journal should already have been
2445** created, populated with this journal pointer and synced to disk.
2446**
2447** Once this is routine has returned, the only thing required to commit
2448** the write-transaction for this database file is to delete the journal.
2449*/
2450int sqlite3BtreeCommitPhaseOne(Btree *p, const char *zMaster){
2451 int rc = SQLITE_OK;
2452 if( p->inTrans==TRANS_WRITE ){
2453 BtShared *pBt = p->pBt;
2454 Pgno nTrunc = 0;
drhd677b3d2007-08-20 22:48:41 +00002455 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002456 pBt->db = p->db;
drh80e35f42007-03-30 14:06:34 +00002457#ifndef SQLITE_OMIT_AUTOVACUUM
2458 if( pBt->autoVacuum ){
2459 rc = autoVacuumCommit(pBt, &nTrunc);
2460 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00002461 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00002462 return rc;
2463 }
2464 }
2465#endif
danielk1977f653d782008-03-20 11:04:21 +00002466 rc = sqlite3PagerCommitPhaseOne(pBt->pPager, zMaster, nTrunc, 0);
drhd677b3d2007-08-20 22:48:41 +00002467 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00002468 }
2469 return rc;
2470}
2471
2472/*
drh2aa679f2001-06-25 02:11:07 +00002473** Commit the transaction currently in progress.
drh5e00f6c2001-09-13 13:46:56 +00002474**
drh6e345992007-03-30 11:12:08 +00002475** This routine implements the second phase of a 2-phase commit. The
2476** sqlite3BtreeSync() routine does the first phase and should be invoked
2477** prior to calling this routine. The sqlite3BtreeSync() routine did
2478** all the work of writing information out to disk and flushing the
2479** contents so that they are written onto the disk platter. All this
2480** routine has to do is delete or truncate the rollback journal
2481** (which causes the transaction to commit) and drop locks.
2482**
drh5e00f6c2001-09-13 13:46:56 +00002483** This will release the write lock on the database file. If there
2484** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00002485*/
drh80e35f42007-03-30 14:06:34 +00002486int sqlite3BtreeCommitPhaseTwo(Btree *p){
danielk1977aef0bf62005-12-30 16:28:01 +00002487 BtShared *pBt = p->pBt;
2488
drhd677b3d2007-08-20 22:48:41 +00002489 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002490 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00002491 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002492
2493 /* If the handle has a write-transaction open, commit the shared-btrees
2494 ** transaction and set the shared state to TRANS_READ.
2495 */
2496 if( p->inTrans==TRANS_WRITE ){
danielk19777f7bc662006-01-23 13:47:47 +00002497 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002498 assert( pBt->inTransaction==TRANS_WRITE );
2499 assert( pBt->nTransaction>0 );
drh80e35f42007-03-30 14:06:34 +00002500 rc = sqlite3PagerCommitPhaseTwo(pBt->pPager);
danielk19777f7bc662006-01-23 13:47:47 +00002501 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00002502 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00002503 return rc;
2504 }
danielk1977aef0bf62005-12-30 16:28:01 +00002505 pBt->inTransaction = TRANS_READ;
2506 pBt->inStmt = 0;
danielk1977ee5741e2004-05-31 10:01:34 +00002507 }
danielk19777f7bc662006-01-23 13:47:47 +00002508 unlockAllTables(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002509
2510 /* If the handle has any kind of transaction open, decrement the transaction
2511 ** count of the shared btree. If the transaction count reaches 0, set
2512 ** the shared state to TRANS_NONE. The unlockBtreeIfUnused() call below
2513 ** will unlock the pager.
2514 */
2515 if( p->inTrans!=TRANS_NONE ){
2516 pBt->nTransaction--;
2517 if( 0==pBt->nTransaction ){
2518 pBt->inTransaction = TRANS_NONE;
2519 }
2520 }
2521
2522 /* Set the handles current transaction state to TRANS_NONE and unlock
2523 ** the pager if this call closed the only read or write transaction.
2524 */
2525 p->inTrans = TRANS_NONE;
drh5e00f6c2001-09-13 13:46:56 +00002526 unlockBtreeIfUnused(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00002527
2528 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00002529 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00002530 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00002531}
2532
drh80e35f42007-03-30 14:06:34 +00002533/*
2534** Do both phases of a commit.
2535*/
2536int sqlite3BtreeCommit(Btree *p){
2537 int rc;
drhd677b3d2007-08-20 22:48:41 +00002538 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00002539 rc = sqlite3BtreeCommitPhaseOne(p, 0);
2540 if( rc==SQLITE_OK ){
2541 rc = sqlite3BtreeCommitPhaseTwo(p);
2542 }
drhd677b3d2007-08-20 22:48:41 +00002543 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00002544 return rc;
2545}
2546
danielk1977fbcd5852004-06-15 02:44:18 +00002547#ifndef NDEBUG
2548/*
2549** Return the number of write-cursors open on this handle. This is for use
2550** in assert() expressions, so it is only compiled if NDEBUG is not
2551** defined.
drhfb982642007-08-30 01:19:59 +00002552**
2553** For the purposes of this routine, a write-cursor is any cursor that
2554** is capable of writing to the databse. That means the cursor was
2555** originally opened for writing and the cursor has not be disabled
2556** by having its state changed to CURSOR_FAULT.
danielk1977fbcd5852004-06-15 02:44:18 +00002557*/
danielk1977aef0bf62005-12-30 16:28:01 +00002558static int countWriteCursors(BtShared *pBt){
danielk1977fbcd5852004-06-15 02:44:18 +00002559 BtCursor *pCur;
2560 int r = 0;
2561 for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
drhfb982642007-08-30 01:19:59 +00002562 if( pCur->wrFlag && pCur->eState!=CURSOR_FAULT ) r++;
danielk1977fbcd5852004-06-15 02:44:18 +00002563 }
2564 return r;
2565}
2566#endif
2567
drhc39e0002004-05-07 23:50:57 +00002568/*
drhfb982642007-08-30 01:19:59 +00002569** This routine sets the state to CURSOR_FAULT and the error
2570** code to errCode for every cursor on BtShared that pBtree
2571** references.
2572**
2573** Every cursor is tripped, including cursors that belong
2574** to other database connections that happen to be sharing
2575** the cache with pBtree.
2576**
2577** This routine gets called when a rollback occurs.
2578** All cursors using the same cache must be tripped
2579** to prevent them from trying to use the btree after
2580** the rollback. The rollback may have deleted tables
2581** or moved root pages, so it is not sufficient to
2582** save the state of the cursor. The cursor must be
2583** invalidated.
2584*/
2585void sqlite3BtreeTripAllCursors(Btree *pBtree, int errCode){
2586 BtCursor *p;
2587 sqlite3BtreeEnter(pBtree);
2588 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
2589 clearCursorPosition(p);
2590 p->eState = CURSOR_FAULT;
2591 p->skip = errCode;
2592 }
2593 sqlite3BtreeLeave(pBtree);
2594}
2595
2596/*
drhecdc7532001-09-23 02:35:53 +00002597** Rollback the transaction in progress. All cursors will be
2598** invalided by this operation. Any attempt to use a cursor
2599** that was open at the beginning of this operation will result
2600** in an error.
drh5e00f6c2001-09-13 13:46:56 +00002601**
2602** This will release the write lock on the database file. If there
2603** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00002604*/
danielk1977aef0bf62005-12-30 16:28:01 +00002605int sqlite3BtreeRollback(Btree *p){
danielk19778d34dfd2006-01-24 16:37:57 +00002606 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002607 BtShared *pBt = p->pBt;
drh24cd67e2004-05-10 16:18:47 +00002608 MemPage *pPage1;
danielk1977aef0bf62005-12-30 16:28:01 +00002609
drhd677b3d2007-08-20 22:48:41 +00002610 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002611 pBt->db = p->db;
danielk19772b8c13e2006-01-24 14:21:24 +00002612 rc = saveAllCursors(pBt, 0, 0);
danielk19778d34dfd2006-01-24 16:37:57 +00002613#ifndef SQLITE_OMIT_SHARED_CACHE
danielk19772b8c13e2006-01-24 14:21:24 +00002614 if( rc!=SQLITE_OK ){
danielk19778d34dfd2006-01-24 16:37:57 +00002615 /* This is a horrible situation. An IO or malloc() error occured whilst
2616 ** trying to save cursor positions. If this is an automatic rollback (as
2617 ** the result of a constraint, malloc() failure or IO error) then
2618 ** the cache may be internally inconsistent (not contain valid trees) so
2619 ** we cannot simply return the error to the caller. Instead, abort
2620 ** all queries that may be using any of the cursors that failed to save.
2621 */
drhfb982642007-08-30 01:19:59 +00002622 sqlite3BtreeTripAllCursors(p, rc);
danielk19772b8c13e2006-01-24 14:21:24 +00002623 }
danielk19778d34dfd2006-01-24 16:37:57 +00002624#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002625 btreeIntegrity(p);
2626 unlockAllTables(p);
2627
2628 if( p->inTrans==TRANS_WRITE ){
danielk19778d34dfd2006-01-24 16:37:57 +00002629 int rc2;
danielk1977aef0bf62005-12-30 16:28:01 +00002630
danielk1977dddbcdc2007-04-26 14:42:34 +00002631#ifndef SQLITE_OMIT_AUTOVACUUM
2632 pBt->nTrunc = 0;
2633#endif
2634
danielk19778d34dfd2006-01-24 16:37:57 +00002635 assert( TRANS_WRITE==pBt->inTransaction );
danielk19773b8a05f2007-03-19 17:44:26 +00002636 rc2 = sqlite3PagerRollback(pBt->pPager);
danielk19778d34dfd2006-01-24 16:37:57 +00002637 if( rc2!=SQLITE_OK ){
2638 rc = rc2;
2639 }
2640
drh24cd67e2004-05-10 16:18:47 +00002641 /* The rollback may have destroyed the pPage1->aData value. So
drh16a9b832007-05-05 18:39:25 +00002642 ** call sqlite3BtreeGetPage() on page 1 again to make
2643 ** sure pPage1->aData is set correctly. */
2644 if( sqlite3BtreeGetPage(pBt, 1, &pPage1, 0)==SQLITE_OK ){
drh24cd67e2004-05-10 16:18:47 +00002645 releasePage(pPage1);
2646 }
danielk1977fbcd5852004-06-15 02:44:18 +00002647 assert( countWriteCursors(pBt)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00002648 pBt->inTransaction = TRANS_READ;
drh24cd67e2004-05-10 16:18:47 +00002649 }
danielk1977aef0bf62005-12-30 16:28:01 +00002650
2651 if( p->inTrans!=TRANS_NONE ){
2652 assert( pBt->nTransaction>0 );
2653 pBt->nTransaction--;
2654 if( 0==pBt->nTransaction ){
2655 pBt->inTransaction = TRANS_NONE;
2656 }
2657 }
2658
2659 p->inTrans = TRANS_NONE;
danielk1977ee5741e2004-05-31 10:01:34 +00002660 pBt->inStmt = 0;
drh5e00f6c2001-09-13 13:46:56 +00002661 unlockBtreeIfUnused(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00002662
2663 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00002664 sqlite3BtreeLeave(p);
drha059ad02001-04-17 20:09:11 +00002665 return rc;
2666}
2667
2668/*
drhab01f612004-05-22 02:55:23 +00002669** Start a statement subtransaction. The subtransaction can
2670** can be rolled back independently of the main transaction.
2671** You must start a transaction before starting a subtransaction.
2672** The subtransaction is ended automatically if the main transaction
drh663fc632002-02-02 18:49:19 +00002673** commits or rolls back.
2674**
drhab01f612004-05-22 02:55:23 +00002675** Only one subtransaction may be active at a time. It is an error to try
2676** to start a new subtransaction if another subtransaction is already active.
2677**
2678** Statement subtransactions are used around individual SQL statements
2679** that are contained within a BEGIN...COMMIT block. If a constraint
2680** error occurs within the statement, the effect of that one statement
2681** can be rolled back without having to rollback the entire transaction.
drh663fc632002-02-02 18:49:19 +00002682*/
danielk1977aef0bf62005-12-30 16:28:01 +00002683int sqlite3BtreeBeginStmt(Btree *p){
drh663fc632002-02-02 18:49:19 +00002684 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002685 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002686 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002687 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00002688 if( (p->inTrans!=TRANS_WRITE) || pBt->inStmt ){
drhd677b3d2007-08-20 22:48:41 +00002689 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
2690 }else{
2691 assert( pBt->inTransaction==TRANS_WRITE );
2692 rc = pBt->readOnly ? SQLITE_OK : sqlite3PagerStmtBegin(pBt->pPager);
2693 pBt->inStmt = 1;
drh0d65dc02002-02-03 00:56:09 +00002694 }
drhd677b3d2007-08-20 22:48:41 +00002695 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00002696 return rc;
2697}
2698
2699
2700/*
drhab01f612004-05-22 02:55:23 +00002701** Commit the statment subtransaction currently in progress. If no
2702** subtransaction is active, this is a no-op.
drh663fc632002-02-02 18:49:19 +00002703*/
danielk1977aef0bf62005-12-30 16:28:01 +00002704int sqlite3BtreeCommitStmt(Btree *p){
drh663fc632002-02-02 18:49:19 +00002705 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002706 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002707 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002708 pBt->db = p->db;
drh3aac2dd2004-04-26 14:10:20 +00002709 if( pBt->inStmt && !pBt->readOnly ){
danielk19773b8a05f2007-03-19 17:44:26 +00002710 rc = sqlite3PagerStmtCommit(pBt->pPager);
drh663fc632002-02-02 18:49:19 +00002711 }else{
2712 rc = SQLITE_OK;
2713 }
drh3aac2dd2004-04-26 14:10:20 +00002714 pBt->inStmt = 0;
drhd677b3d2007-08-20 22:48:41 +00002715 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00002716 return rc;
2717}
2718
2719/*
drhab01f612004-05-22 02:55:23 +00002720** Rollback the active statement subtransaction. If no subtransaction
2721** is active this routine is a no-op.
drh663fc632002-02-02 18:49:19 +00002722**
drhab01f612004-05-22 02:55:23 +00002723** All cursors will be invalidated by this operation. Any attempt
drh663fc632002-02-02 18:49:19 +00002724** to use a cursor that was open at the beginning of this operation
2725** will result in an error.
2726*/
danielk1977aef0bf62005-12-30 16:28:01 +00002727int sqlite3BtreeRollbackStmt(Btree *p){
danielk197797a227c2006-01-20 16:32:04 +00002728 int rc = SQLITE_OK;
danielk1977aef0bf62005-12-30 16:28:01 +00002729 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002730 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002731 pBt->db = p->db;
danielk197797a227c2006-01-20 16:32:04 +00002732 if( pBt->inStmt && !pBt->readOnly ){
danielk19773b8a05f2007-03-19 17:44:26 +00002733 rc = sqlite3PagerStmtRollback(pBt->pPager);
danielk197797a227c2006-01-20 16:32:04 +00002734 pBt->inStmt = 0;
2735 }
drhd677b3d2007-08-20 22:48:41 +00002736 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00002737 return rc;
2738}
2739
2740/*
drh8b2f49b2001-06-08 00:21:52 +00002741** Create a new cursor for the BTree whose root is on the page
2742** iTable. The act of acquiring a cursor gets a read lock on
2743** the database file.
drh1bee3d72001-10-15 00:44:35 +00002744**
2745** If wrFlag==0, then the cursor can only be used for reading.
drhf74b8d92002-09-01 23:20:45 +00002746** If wrFlag==1, then the cursor can be used for reading or for
2747** writing if other conditions for writing are also met. These
2748** are the conditions that must be met in order for writing to
2749** be allowed:
drh6446c4d2001-12-15 14:22:18 +00002750**
drhf74b8d92002-09-01 23:20:45 +00002751** 1: The cursor must have been opened with wrFlag==1
2752**
drhfe5d71d2007-03-19 11:54:10 +00002753** 2: Other database connections that share the same pager cache
2754** but which are not in the READ_UNCOMMITTED state may not have
2755** cursors open with wrFlag==0 on the same table. Otherwise
2756** the changes made by this write cursor would be visible to
2757** the read cursors in the other database connection.
drhf74b8d92002-09-01 23:20:45 +00002758**
2759** 3: The database must be writable (not on read-only media)
2760**
2761** 4: There must be an active transaction.
2762**
drh6446c4d2001-12-15 14:22:18 +00002763** No checking is done to make sure that page iTable really is the
2764** root page of a b-tree. If it is not, then the cursor acquired
2765** will not work correctly.
drha059ad02001-04-17 20:09:11 +00002766*/
drhd677b3d2007-08-20 22:48:41 +00002767static int btreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00002768 Btree *p, /* The btree */
2769 int iTable, /* Root page of table to open */
2770 int wrFlag, /* 1 to write. 0 read-only */
2771 struct KeyInfo *pKeyInfo, /* First arg to comparison function */
2772 BtCursor *pCur /* Space for new cursor */
drh3aac2dd2004-04-26 14:10:20 +00002773){
drha059ad02001-04-17 20:09:11 +00002774 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002775 BtShared *pBt = p->pBt;
drhecdc7532001-09-23 02:35:53 +00002776
drh1fee73e2007-08-29 04:00:57 +00002777 assert( sqlite3BtreeHoldsMutex(p) );
drh8dcd7ca2004-08-08 19:43:29 +00002778 if( wrFlag ){
drh8dcd7ca2004-08-08 19:43:29 +00002779 if( pBt->readOnly ){
2780 return SQLITE_READONLY;
2781 }
danielk19773588ceb2008-06-10 17:30:26 +00002782 if( checkReadLocks(p, iTable, 0, 0) ){
drh8dcd7ca2004-08-08 19:43:29 +00002783 return SQLITE_LOCKED;
2784 }
drha0c9a112004-03-10 13:42:37 +00002785 }
danielk1977aef0bf62005-12-30 16:28:01 +00002786
drh4b70f112004-05-02 21:12:19 +00002787 if( pBt->pPage1==0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002788 rc = lockBtreeWithRetry(p);
drha059ad02001-04-17 20:09:11 +00002789 if( rc!=SQLITE_OK ){
drha059ad02001-04-17 20:09:11 +00002790 return rc;
2791 }
drh1831f182007-04-24 17:35:59 +00002792 if( pBt->readOnly && wrFlag ){
2793 return SQLITE_READONLY;
2794 }
drha059ad02001-04-17 20:09:11 +00002795 }
drh8b2f49b2001-06-08 00:21:52 +00002796 pCur->pgnoRoot = (Pgno)iTable;
danielk1977ad0132d2008-06-07 08:58:22 +00002797 if( iTable==1 && pagerPagecount(pBt->pPager)==0 ){
drh24cd67e2004-05-10 16:18:47 +00002798 rc = SQLITE_EMPTY;
2799 goto create_cursor_exception;
2800 }
drhde647132004-05-07 17:57:49 +00002801 rc = getAndInitPage(pBt, pCur->pgnoRoot, &pCur->pPage, 0);
drhbd03cae2001-06-02 02:40:57 +00002802 if( rc!=SQLITE_OK ){
2803 goto create_cursor_exception;
drha059ad02001-04-17 20:09:11 +00002804 }
danielk1977aef0bf62005-12-30 16:28:01 +00002805
danielk1977aef0bf62005-12-30 16:28:01 +00002806 /* Now that no other errors can occur, finish filling in the BtCursor
2807 ** variables, link the cursor into the BtShared list and set *ppCur (the
2808 ** output argument to this function).
2809 */
drh1e968a02008-03-25 00:22:21 +00002810 pCur->pKeyInfo = pKeyInfo;
danielk1977aef0bf62005-12-30 16:28:01 +00002811 pCur->pBtree = p;
drhd0679ed2007-08-28 22:24:34 +00002812 pCur->pBt = pBt;
drhecdc7532001-09-23 02:35:53 +00002813 pCur->wrFlag = wrFlag;
drha059ad02001-04-17 20:09:11 +00002814 pCur->pNext = pBt->pCursor;
2815 if( pCur->pNext ){
2816 pCur->pNext->pPrev = pCur;
2817 }
2818 pBt->pCursor = pCur;
danielk1977da184232006-01-05 11:34:32 +00002819 pCur->eState = CURSOR_INVALID;
drhbd03cae2001-06-02 02:40:57 +00002820
danielk1977aef0bf62005-12-30 16:28:01 +00002821 return SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00002822
drhbd03cae2001-06-02 02:40:57 +00002823create_cursor_exception:
drha3460582008-07-11 21:02:53 +00002824 releasePage(pCur->pPage);
drh5e00f6c2001-09-13 13:46:56 +00002825 unlockBtreeIfUnused(pBt);
drhbd03cae2001-06-02 02:40:57 +00002826 return rc;
drha059ad02001-04-17 20:09:11 +00002827}
drhd677b3d2007-08-20 22:48:41 +00002828int sqlite3BtreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00002829 Btree *p, /* The btree */
2830 int iTable, /* Root page of table to open */
2831 int wrFlag, /* 1 to write. 0 read-only */
2832 struct KeyInfo *pKeyInfo, /* First arg to xCompare() */
2833 BtCursor *pCur /* Write new cursor here */
drhd677b3d2007-08-20 22:48:41 +00002834){
2835 int rc;
2836 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002837 p->pBt->db = p->db;
danielk1977cd3e8f72008-03-25 09:47:35 +00002838 rc = btreeCursor(p, iTable, wrFlag, pKeyInfo, pCur);
drhd677b3d2007-08-20 22:48:41 +00002839 sqlite3BtreeLeave(p);
2840 return rc;
2841}
danielk1977cd3e8f72008-03-25 09:47:35 +00002842int sqlite3BtreeCursorSize(){
2843 return sizeof(BtCursor);
2844}
2845
drhd677b3d2007-08-20 22:48:41 +00002846
drha059ad02001-04-17 20:09:11 +00002847
2848/*
drh5e00f6c2001-09-13 13:46:56 +00002849** Close a cursor. The read lock on the database file is released
drhbd03cae2001-06-02 02:40:57 +00002850** when the last cursor is closed.
drha059ad02001-04-17 20:09:11 +00002851*/
drh3aac2dd2004-04-26 14:10:20 +00002852int sqlite3BtreeCloseCursor(BtCursor *pCur){
drhff0587c2007-08-29 17:43:19 +00002853 Btree *pBtree = pCur->pBtree;
danielk1977cd3e8f72008-03-25 09:47:35 +00002854 if( pBtree ){
2855 BtShared *pBt = pCur->pBt;
2856 sqlite3BtreeEnter(pBtree);
2857 pBt->db = pBtree->db;
2858 clearCursorPosition(pCur);
2859 if( pCur->pPrev ){
2860 pCur->pPrev->pNext = pCur->pNext;
2861 }else{
2862 pBt->pCursor = pCur->pNext;
2863 }
2864 if( pCur->pNext ){
2865 pCur->pNext->pPrev = pCur->pPrev;
2866 }
2867 releasePage(pCur->pPage);
2868 unlockBtreeIfUnused(pBt);
2869 invalidateOverflowCache(pCur);
2870 /* sqlite3_free(pCur); */
2871 sqlite3BtreeLeave(pBtree);
drha059ad02001-04-17 20:09:11 +00002872 }
drh8c42ca92001-06-22 19:15:00 +00002873 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00002874}
2875
drh7e3b0a02001-04-28 16:52:40 +00002876/*
drh5e2f8b92001-05-28 00:41:15 +00002877** Make a temporary cursor by filling in the fields of pTempCur.
2878** The temporary cursor is not on the cursor list for the Btree.
2879*/
drh16a9b832007-05-05 18:39:25 +00002880void sqlite3BtreeGetTempCursor(BtCursor *pCur, BtCursor *pTempCur){
drh1fee73e2007-08-29 04:00:57 +00002881 assert( cursorHoldsMutex(pCur) );
drh5e2f8b92001-05-28 00:41:15 +00002882 memcpy(pTempCur, pCur, sizeof(*pCur));
2883 pTempCur->pNext = 0;
2884 pTempCur->pPrev = 0;
drhecdc7532001-09-23 02:35:53 +00002885 if( pTempCur->pPage ){
danielk19773b8a05f2007-03-19 17:44:26 +00002886 sqlite3PagerRef(pTempCur->pPage->pDbPage);
drhecdc7532001-09-23 02:35:53 +00002887 }
drh5e2f8b92001-05-28 00:41:15 +00002888}
2889
2890/*
drhbd03cae2001-06-02 02:40:57 +00002891** Delete a temporary cursor such as was made by the CreateTemporaryCursor()
drh5e2f8b92001-05-28 00:41:15 +00002892** function above.
2893*/
drh16a9b832007-05-05 18:39:25 +00002894void sqlite3BtreeReleaseTempCursor(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00002895 assert( cursorHoldsMutex(pCur) );
drhecdc7532001-09-23 02:35:53 +00002896 if( pCur->pPage ){
danielk19773b8a05f2007-03-19 17:44:26 +00002897 sqlite3PagerUnref(pCur->pPage->pDbPage);
drhecdc7532001-09-23 02:35:53 +00002898 }
drh5e2f8b92001-05-28 00:41:15 +00002899}
2900
2901/*
drh86057612007-06-26 01:04:48 +00002902** Make sure the BtCursor* given in the argument has a valid
2903** BtCursor.info structure. If it is not already valid, call
danielk19771cc5ed82007-05-16 17:28:43 +00002904** sqlite3BtreeParseCell() to fill it in.
drhab01f612004-05-22 02:55:23 +00002905**
2906** BtCursor.info is a cache of the information in the current cell.
drh16a9b832007-05-05 18:39:25 +00002907** Using this cache reduces the number of calls to sqlite3BtreeParseCell().
drh86057612007-06-26 01:04:48 +00002908**
2909** 2007-06-25: There is a bug in some versions of MSVC that cause the
2910** compiler to crash when getCellInfo() is implemented as a macro.
2911** But there is a measureable speed advantage to using the macro on gcc
2912** (when less compiler optimizations like -Os or -O0 are used and the
2913** compiler is not doing agressive inlining.) So we use a real function
2914** for MSVC and a macro for everything else. Ticket #2457.
drh9188b382004-05-14 21:12:22 +00002915*/
drh9188b382004-05-14 21:12:22 +00002916#ifndef NDEBUG
danielk19771cc5ed82007-05-16 17:28:43 +00002917 static void assertCellInfo(BtCursor *pCur){
drh9188b382004-05-14 21:12:22 +00002918 CellInfo info;
drh51c6d962004-06-06 00:42:25 +00002919 memset(&info, 0, sizeof(info));
drh16a9b832007-05-05 18:39:25 +00002920 sqlite3BtreeParseCell(pCur->pPage, pCur->idx, &info);
drh9188b382004-05-14 21:12:22 +00002921 assert( memcmp(&info, &pCur->info, sizeof(info))==0 );
drh9188b382004-05-14 21:12:22 +00002922 }
danielk19771cc5ed82007-05-16 17:28:43 +00002923#else
2924 #define assertCellInfo(x)
2925#endif
drh86057612007-06-26 01:04:48 +00002926#ifdef _MSC_VER
2927 /* Use a real function in MSVC to work around bugs in that compiler. */
2928 static void getCellInfo(BtCursor *pCur){
2929 if( pCur->info.nSize==0 ){
2930 sqlite3BtreeParseCell(pCur->pPage, pCur->idx, &pCur->info);
drha2c20e42008-03-29 16:01:04 +00002931 pCur->validNKey = 1;
drh86057612007-06-26 01:04:48 +00002932 }else{
2933 assertCellInfo(pCur);
2934 }
2935 }
2936#else /* if not _MSC_VER */
2937 /* Use a macro in all other compilers so that the function is inlined */
2938#define getCellInfo(pCur) \
2939 if( pCur->info.nSize==0 ){ \
danielk19771cc5ed82007-05-16 17:28:43 +00002940 sqlite3BtreeParseCell(pCur->pPage, pCur->idx, &pCur->info); \
drha2c20e42008-03-29 16:01:04 +00002941 pCur->validNKey = 1; \
drh86057612007-06-26 01:04:48 +00002942 }else{ \
2943 assertCellInfo(pCur); \
2944 }
2945#endif /* _MSC_VER */
drh9188b382004-05-14 21:12:22 +00002946
2947/*
drh3aac2dd2004-04-26 14:10:20 +00002948** Set *pSize to the size of the buffer needed to hold the value of
2949** the key for the current entry. If the cursor is not pointing
2950** to a valid entry, *pSize is set to 0.
2951**
drh4b70f112004-05-02 21:12:19 +00002952** For a table with the INTKEY flag set, this routine returns the key
drh3aac2dd2004-04-26 14:10:20 +00002953** itself, not the number of bytes in the key.
drh7e3b0a02001-04-28 16:52:40 +00002954*/
drh4a1c3802004-05-12 15:15:47 +00002955int sqlite3BtreeKeySize(BtCursor *pCur, i64 *pSize){
drhd677b3d2007-08-20 22:48:41 +00002956 int rc;
2957
drh1fee73e2007-08-29 04:00:57 +00002958 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00002959 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00002960 if( rc==SQLITE_OK ){
2961 assert( pCur->eState==CURSOR_INVALID || pCur->eState==CURSOR_VALID );
2962 if( pCur->eState==CURSOR_INVALID ){
2963 *pSize = 0;
2964 }else{
drh86057612007-06-26 01:04:48 +00002965 getCellInfo(pCur);
danielk1977da184232006-01-05 11:34:32 +00002966 *pSize = pCur->info.nKey;
2967 }
drh72f82862001-05-24 21:06:34 +00002968 }
danielk1977da184232006-01-05 11:34:32 +00002969 return rc;
drha059ad02001-04-17 20:09:11 +00002970}
drh2af926b2001-05-15 00:39:25 +00002971
drh72f82862001-05-24 21:06:34 +00002972/*
drh0e1c19e2004-05-11 00:58:56 +00002973** Set *pSize to the number of bytes of data in the entry the
2974** cursor currently points to. Always return SQLITE_OK.
2975** Failure is not possible. If the cursor is not currently
2976** pointing to an entry (which can happen, for example, if
2977** the database is empty) then *pSize is set to 0.
2978*/
2979int sqlite3BtreeDataSize(BtCursor *pCur, u32 *pSize){
drhd677b3d2007-08-20 22:48:41 +00002980 int rc;
2981
drh1fee73e2007-08-29 04:00:57 +00002982 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00002983 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00002984 if( rc==SQLITE_OK ){
2985 assert( pCur->eState==CURSOR_INVALID || pCur->eState==CURSOR_VALID );
2986 if( pCur->eState==CURSOR_INVALID ){
2987 /* Not pointing at a valid entry - set *pSize to 0. */
2988 *pSize = 0;
2989 }else{
drh86057612007-06-26 01:04:48 +00002990 getCellInfo(pCur);
danielk1977da184232006-01-05 11:34:32 +00002991 *pSize = pCur->info.nData;
2992 }
drh0e1c19e2004-05-11 00:58:56 +00002993 }
danielk1977da184232006-01-05 11:34:32 +00002994 return rc;
drh0e1c19e2004-05-11 00:58:56 +00002995}
2996
2997/*
danielk1977d04417962007-05-02 13:16:30 +00002998** Given the page number of an overflow page in the database (parameter
2999** ovfl), this function finds the page number of the next page in the
3000** linked list of overflow pages. If possible, it uses the auto-vacuum
3001** pointer-map data instead of reading the content of page ovfl to do so.
3002**
3003** If an error occurs an SQLite error code is returned. Otherwise:
3004**
3005** Unless pPgnoNext is NULL, the page number of the next overflow
3006** page in the linked list is written to *pPgnoNext. If page ovfl
drh85b623f2007-12-13 21:54:09 +00003007** is the last page in its linked list, *pPgnoNext is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00003008**
3009** If ppPage is not NULL, *ppPage is set to the MemPage* handle
3010** for page ovfl. The underlying pager page may have been requested
3011** with the noContent flag set, so the page data accessable via
3012** this handle may not be trusted.
3013*/
3014static int getOverflowPage(
3015 BtShared *pBt,
3016 Pgno ovfl, /* Overflow page */
3017 MemPage **ppPage, /* OUT: MemPage handle */
3018 Pgno *pPgnoNext /* OUT: Next overflow page number */
3019){
3020 Pgno next = 0;
3021 int rc;
3022
drh1fee73e2007-08-29 04:00:57 +00003023 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977d04417962007-05-02 13:16:30 +00003024 /* One of these must not be NULL. Otherwise, why call this function? */
3025 assert(ppPage || pPgnoNext);
3026
3027 /* If pPgnoNext is NULL, then this function is being called to obtain
3028 ** a MemPage* reference only. No page-data is required in this case.
3029 */
3030 if( !pPgnoNext ){
drh16a9b832007-05-05 18:39:25 +00003031 return sqlite3BtreeGetPage(pBt, ovfl, ppPage, 1);
danielk1977d04417962007-05-02 13:16:30 +00003032 }
3033
3034#ifndef SQLITE_OMIT_AUTOVACUUM
3035 /* Try to find the next page in the overflow list using the
3036 ** autovacuum pointer-map pages. Guess that the next page in
3037 ** the overflow list is page number (ovfl+1). If that guess turns
3038 ** out to be wrong, fall back to loading the data of page
3039 ** number ovfl to determine the next page number.
3040 */
3041 if( pBt->autoVacuum ){
3042 Pgno pgno;
3043 Pgno iGuess = ovfl+1;
3044 u8 eType;
3045
3046 while( PTRMAP_ISPAGE(pBt, iGuess) || iGuess==PENDING_BYTE_PAGE(pBt) ){
3047 iGuess++;
3048 }
3049
danielk1977ad0132d2008-06-07 08:58:22 +00003050 if( iGuess<=pagerPagecount(pBt->pPager) ){
danielk1977d04417962007-05-02 13:16:30 +00003051 rc = ptrmapGet(pBt, iGuess, &eType, &pgno);
3052 if( rc!=SQLITE_OK ){
3053 return rc;
3054 }
3055 if( eType==PTRMAP_OVERFLOW2 && pgno==ovfl ){
3056 next = iGuess;
3057 }
3058 }
3059 }
3060#endif
3061
3062 if( next==0 || ppPage ){
3063 MemPage *pPage = 0;
3064
drh16a9b832007-05-05 18:39:25 +00003065 rc = sqlite3BtreeGetPage(pBt, ovfl, &pPage, next!=0);
danielk1977d04417962007-05-02 13:16:30 +00003066 assert(rc==SQLITE_OK || pPage==0);
3067 if( next==0 && rc==SQLITE_OK ){
3068 next = get4byte(pPage->aData);
3069 }
3070
3071 if( ppPage ){
3072 *ppPage = pPage;
3073 }else{
3074 releasePage(pPage);
3075 }
3076 }
3077 *pPgnoNext = next;
3078
3079 return rc;
3080}
3081
danielk1977da107192007-05-04 08:32:13 +00003082/*
3083** Copy data from a buffer to a page, or from a page to a buffer.
3084**
3085** pPayload is a pointer to data stored on database page pDbPage.
3086** If argument eOp is false, then nByte bytes of data are copied
3087** from pPayload to the buffer pointed at by pBuf. If eOp is true,
3088** then sqlite3PagerWrite() is called on pDbPage and nByte bytes
3089** of data are copied from the buffer pBuf to pPayload.
3090**
3091** SQLITE_OK is returned on success, otherwise an error code.
3092*/
3093static int copyPayload(
3094 void *pPayload, /* Pointer to page data */
3095 void *pBuf, /* Pointer to buffer */
3096 int nByte, /* Number of bytes to copy */
3097 int eOp, /* 0 -> copy from page, 1 -> copy to page */
3098 DbPage *pDbPage /* Page containing pPayload */
3099){
3100 if( eOp ){
3101 /* Copy data from buffer to page (a write operation) */
3102 int rc = sqlite3PagerWrite(pDbPage);
3103 if( rc!=SQLITE_OK ){
3104 return rc;
3105 }
3106 memcpy(pPayload, pBuf, nByte);
3107 }else{
3108 /* Copy data from page to buffer (a read operation) */
3109 memcpy(pBuf, pPayload, nByte);
3110 }
3111 return SQLITE_OK;
3112}
danielk1977d04417962007-05-02 13:16:30 +00003113
3114/*
danielk19779f8d6402007-05-02 17:48:45 +00003115** This function is used to read or overwrite payload information
3116** for the entry that the pCur cursor is pointing to. If the eOp
3117** parameter is 0, this is a read operation (data copied into
3118** buffer pBuf). If it is non-zero, a write (data copied from
3119** buffer pBuf).
3120**
3121** A total of "amt" bytes are read or written beginning at "offset".
3122** Data is read to or from the buffer pBuf.
drh72f82862001-05-24 21:06:34 +00003123**
3124** This routine does not make a distinction between key and data.
danielk19779f8d6402007-05-02 17:48:45 +00003125** It just reads or writes bytes from the payload area. Data might
3126** appear on the main page or be scattered out on multiple overflow
3127** pages.
danielk1977da107192007-05-04 08:32:13 +00003128**
danielk1977dcbb5d32007-05-04 18:36:44 +00003129** If the BtCursor.isIncrblobHandle flag is set, and the current
danielk1977da107192007-05-04 08:32:13 +00003130** cursor entry uses one or more overflow pages, this function
3131** allocates space for and lazily popluates the overflow page-list
3132** cache array (BtCursor.aOverflow). Subsequent calls use this
3133** cache to make seeking to the supplied offset more efficient.
3134**
3135** Once an overflow page-list cache has been allocated, it may be
3136** invalidated if some other cursor writes to the same table, or if
3137** the cursor is moved to a different row. Additionally, in auto-vacuum
3138** mode, the following events may invalidate an overflow page-list cache.
3139**
3140** * An incremental vacuum,
3141** * A commit in auto_vacuum="full" mode,
3142** * Creating a table (may require moving an overflow page).
drh72f82862001-05-24 21:06:34 +00003143*/
danielk19779f8d6402007-05-02 17:48:45 +00003144static int accessPayload(
drh3aac2dd2004-04-26 14:10:20 +00003145 BtCursor *pCur, /* Cursor pointing to entry to read from */
3146 int offset, /* Begin reading this far into payload */
3147 int amt, /* Read this many bytes */
3148 unsigned char *pBuf, /* Write the bytes into this buffer */
danielk19779f8d6402007-05-02 17:48:45 +00003149 int skipKey, /* offset begins at data if this is true */
3150 int eOp /* zero to read. non-zero to write. */
drh3aac2dd2004-04-26 14:10:20 +00003151){
3152 unsigned char *aPayload;
danielk1977da107192007-05-04 08:32:13 +00003153 int rc = SQLITE_OK;
drhfa1a98a2004-05-14 19:08:17 +00003154 u32 nKey;
danielk19772dec9702007-05-02 16:48:37 +00003155 int iIdx = 0;
drhd0679ed2007-08-28 22:24:34 +00003156 MemPage *pPage = pCur->pPage; /* Btree page of current cursor entry */
drh51f015e2007-10-16 19:45:29 +00003157 BtShared *pBt; /* Btree this cursor belongs to */
drh3aac2dd2004-04-26 14:10:20 +00003158
danielk1977da107192007-05-04 08:32:13 +00003159 assert( pPage );
danielk1977da184232006-01-05 11:34:32 +00003160 assert( pCur->eState==CURSOR_VALID );
drh3aac2dd2004-04-26 14:10:20 +00003161 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
danielk1977da107192007-05-04 08:32:13 +00003162 assert( offset>=0 );
drh1fee73e2007-08-29 04:00:57 +00003163 assert( cursorHoldsMutex(pCur) );
danielk1977da107192007-05-04 08:32:13 +00003164
drh86057612007-06-26 01:04:48 +00003165 getCellInfo(pCur);
drh366fda62006-01-13 02:35:09 +00003166 aPayload = pCur->info.pCell + pCur->info.nHeader;
danielk1977da107192007-05-04 08:32:13 +00003167 nKey = (pPage->intKey ? 0 : pCur->info.nKey);
3168
drh3aac2dd2004-04-26 14:10:20 +00003169 if( skipKey ){
drhfa1a98a2004-05-14 19:08:17 +00003170 offset += nKey;
drh3aac2dd2004-04-26 14:10:20 +00003171 }
drhfa1a98a2004-05-14 19:08:17 +00003172 if( offset+amt > nKey+pCur->info.nData ){
danielk1977da107192007-05-04 08:32:13 +00003173 /* Trying to read or write past the end of the data is an error */
drha34b6762004-05-07 13:30:42 +00003174 return SQLITE_ERROR;
drh3aac2dd2004-04-26 14:10:20 +00003175 }
danielk1977da107192007-05-04 08:32:13 +00003176
3177 /* Check if data must be read/written to/from the btree page itself. */
drhfa1a98a2004-05-14 19:08:17 +00003178 if( offset<pCur->info.nLocal ){
drh2af926b2001-05-15 00:39:25 +00003179 int a = amt;
drhfa1a98a2004-05-14 19:08:17 +00003180 if( a+offset>pCur->info.nLocal ){
3181 a = pCur->info.nLocal - offset;
drh2af926b2001-05-15 00:39:25 +00003182 }
danielk1977da107192007-05-04 08:32:13 +00003183 rc = copyPayload(&aPayload[offset], pBuf, a, eOp, pPage->pDbPage);
drh2aa679f2001-06-25 02:11:07 +00003184 offset = 0;
drha34b6762004-05-07 13:30:42 +00003185 pBuf += a;
drh2af926b2001-05-15 00:39:25 +00003186 amt -= a;
drhdd793422001-06-28 01:54:48 +00003187 }else{
drhfa1a98a2004-05-14 19:08:17 +00003188 offset -= pCur->info.nLocal;
drhbd03cae2001-06-02 02:40:57 +00003189 }
danielk1977da107192007-05-04 08:32:13 +00003190
drh51f015e2007-10-16 19:45:29 +00003191 pBt = pCur->pBt;
danielk1977da107192007-05-04 08:32:13 +00003192 if( rc==SQLITE_OK && amt>0 ){
3193 const int ovflSize = pBt->usableSize - 4; /* Bytes content per ovfl page */
3194 Pgno nextPage;
3195
drhfa1a98a2004-05-14 19:08:17 +00003196 nextPage = get4byte(&aPayload[pCur->info.nLocal]);
danielk1977da107192007-05-04 08:32:13 +00003197
danielk19772dec9702007-05-02 16:48:37 +00003198#ifndef SQLITE_OMIT_INCRBLOB
danielk1977dcbb5d32007-05-04 18:36:44 +00003199 /* If the isIncrblobHandle flag is set and the BtCursor.aOverflow[]
danielk1977da107192007-05-04 08:32:13 +00003200 ** has not been allocated, allocate it now. The array is sized at
3201 ** one entry for each overflow page in the overflow chain. The
3202 ** page number of the first overflow page is stored in aOverflow[0],
3203 ** etc. A value of 0 in the aOverflow[] array means "not yet known"
3204 ** (the cache is lazily populated).
3205 */
danielk1977dcbb5d32007-05-04 18:36:44 +00003206 if( pCur->isIncrblobHandle && !pCur->aOverflow ){
danielk19772dec9702007-05-02 16:48:37 +00003207 int nOvfl = (pCur->info.nPayload-pCur->info.nLocal+ovflSize-1)/ovflSize;
drh17435752007-08-16 04:30:38 +00003208 pCur->aOverflow = (Pgno *)sqlite3MallocZero(sizeof(Pgno)*nOvfl);
danielk19772dec9702007-05-02 16:48:37 +00003209 if( nOvfl && !pCur->aOverflow ){
danielk1977da107192007-05-04 08:32:13 +00003210 rc = SQLITE_NOMEM;
danielk19772dec9702007-05-02 16:48:37 +00003211 }
3212 }
danielk1977da107192007-05-04 08:32:13 +00003213
3214 /* If the overflow page-list cache has been allocated and the
3215 ** entry for the first required overflow page is valid, skip
3216 ** directly to it.
3217 */
danielk19772dec9702007-05-02 16:48:37 +00003218 if( pCur->aOverflow && pCur->aOverflow[offset/ovflSize] ){
3219 iIdx = (offset/ovflSize);
3220 nextPage = pCur->aOverflow[iIdx];
3221 offset = (offset%ovflSize);
3222 }
3223#endif
danielk1977da107192007-05-04 08:32:13 +00003224
3225 for( ; rc==SQLITE_OK && amt>0 && nextPage; iIdx++){
3226
3227#ifndef SQLITE_OMIT_INCRBLOB
3228 /* If required, populate the overflow page-list cache. */
3229 if( pCur->aOverflow ){
3230 assert(!pCur->aOverflow[iIdx] || pCur->aOverflow[iIdx]==nextPage);
3231 pCur->aOverflow[iIdx] = nextPage;
3232 }
3233#endif
3234
danielk1977d04417962007-05-02 13:16:30 +00003235 if( offset>=ovflSize ){
3236 /* The only reason to read this page is to obtain the page
danielk1977da107192007-05-04 08:32:13 +00003237 ** number for the next page in the overflow chain. The page
drhfd131da2007-08-07 17:13:03 +00003238 ** data is not required. So first try to lookup the overflow
3239 ** page-list cache, if any, then fall back to the getOverflowPage()
danielk1977da107192007-05-04 08:32:13 +00003240 ** function.
danielk1977d04417962007-05-02 13:16:30 +00003241 */
danielk19772dec9702007-05-02 16:48:37 +00003242#ifndef SQLITE_OMIT_INCRBLOB
danielk1977da107192007-05-04 08:32:13 +00003243 if( pCur->aOverflow && pCur->aOverflow[iIdx+1] ){
3244 nextPage = pCur->aOverflow[iIdx+1];
3245 } else
danielk19772dec9702007-05-02 16:48:37 +00003246#endif
danielk1977da107192007-05-04 08:32:13 +00003247 rc = getOverflowPage(pBt, nextPage, 0, &nextPage);
danielk1977da107192007-05-04 08:32:13 +00003248 offset -= ovflSize;
danielk1977d04417962007-05-02 13:16:30 +00003249 }else{
danielk19779f8d6402007-05-02 17:48:45 +00003250 /* Need to read this page properly. It contains some of the
3251 ** range of data that is being read (eOp==0) or written (eOp!=0).
danielk1977d04417962007-05-02 13:16:30 +00003252 */
3253 DbPage *pDbPage;
danielk1977cfe9a692004-06-16 12:00:29 +00003254 int a = amt;
danielk1977d04417962007-05-02 13:16:30 +00003255 rc = sqlite3PagerGet(pBt->pPager, nextPage, &pDbPage);
danielk1977da107192007-05-04 08:32:13 +00003256 if( rc==SQLITE_OK ){
3257 aPayload = sqlite3PagerGetData(pDbPage);
3258 nextPage = get4byte(aPayload);
3259 if( a + offset > ovflSize ){
3260 a = ovflSize - offset;
danielk19779f8d6402007-05-02 17:48:45 +00003261 }
danielk1977da107192007-05-04 08:32:13 +00003262 rc = copyPayload(&aPayload[offset+4], pBuf, a, eOp, pDbPage);
3263 sqlite3PagerUnref(pDbPage);
3264 offset = 0;
3265 amt -= a;
3266 pBuf += a;
danielk19779f8d6402007-05-02 17:48:45 +00003267 }
danielk1977cfe9a692004-06-16 12:00:29 +00003268 }
drh2af926b2001-05-15 00:39:25 +00003269 }
drh2af926b2001-05-15 00:39:25 +00003270 }
danielk1977cfe9a692004-06-16 12:00:29 +00003271
danielk1977da107192007-05-04 08:32:13 +00003272 if( rc==SQLITE_OK && amt>0 ){
drh49285702005-09-17 15:20:26 +00003273 return SQLITE_CORRUPT_BKPT;
drha7fcb052001-12-14 15:09:55 +00003274 }
danielk1977da107192007-05-04 08:32:13 +00003275 return rc;
drh2af926b2001-05-15 00:39:25 +00003276}
3277
drh72f82862001-05-24 21:06:34 +00003278/*
drh3aac2dd2004-04-26 14:10:20 +00003279** Read part of the key associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00003280** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00003281** begins at "offset".
drh8c1238a2003-01-02 14:43:55 +00003282**
drh3aac2dd2004-04-26 14:10:20 +00003283** Return SQLITE_OK on success or an error code if anything goes
3284** wrong. An error is returned if "offset+amt" is larger than
3285** the available payload.
drh72f82862001-05-24 21:06:34 +00003286*/
drha34b6762004-05-07 13:30:42 +00003287int sqlite3BtreeKey(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drhd677b3d2007-08-20 22:48:41 +00003288 int rc;
3289
drh1fee73e2007-08-29 04:00:57 +00003290 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00003291 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003292 if( rc==SQLITE_OK ){
3293 assert( pCur->eState==CURSOR_VALID );
3294 assert( pCur->pPage!=0 );
3295 if( pCur->pPage->intKey ){
3296 return SQLITE_CORRUPT_BKPT;
3297 }
3298 assert( pCur->pPage->intKey==0 );
3299 assert( pCur->idx>=0 && pCur->idx<pCur->pPage->nCell );
drh16a9b832007-05-05 18:39:25 +00003300 rc = accessPayload(pCur, offset, amt, (unsigned char*)pBuf, 0, 0);
drh6575a222005-03-10 17:06:34 +00003301 }
danielk1977da184232006-01-05 11:34:32 +00003302 return rc;
drh3aac2dd2004-04-26 14:10:20 +00003303}
3304
3305/*
drh3aac2dd2004-04-26 14:10:20 +00003306** Read part of the data associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00003307** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00003308** begins at "offset".
3309**
3310** Return SQLITE_OK on success or an error code if anything goes
3311** wrong. An error is returned if "offset+amt" is larger than
3312** the available payload.
drh72f82862001-05-24 21:06:34 +00003313*/
drh3aac2dd2004-04-26 14:10:20 +00003314int sqlite3BtreeData(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drhd677b3d2007-08-20 22:48:41 +00003315 int rc;
3316
danielk19773588ceb2008-06-10 17:30:26 +00003317#ifndef SQLITE_OMIT_INCRBLOB
3318 if ( pCur->eState==CURSOR_INVALID ){
3319 return SQLITE_ABORT;
3320 }
3321#endif
3322
drh1fee73e2007-08-29 04:00:57 +00003323 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00003324 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003325 if( rc==SQLITE_OK ){
3326 assert( pCur->eState==CURSOR_VALID );
3327 assert( pCur->pPage!=0 );
3328 assert( pCur->idx>=0 && pCur->idx<pCur->pPage->nCell );
drh16a9b832007-05-05 18:39:25 +00003329 rc = accessPayload(pCur, offset, amt, pBuf, 1, 0);
danielk1977da184232006-01-05 11:34:32 +00003330 }
3331 return rc;
drh2af926b2001-05-15 00:39:25 +00003332}
3333
drh72f82862001-05-24 21:06:34 +00003334/*
drh0e1c19e2004-05-11 00:58:56 +00003335** Return a pointer to payload information from the entry that the
3336** pCur cursor is pointing to. The pointer is to the beginning of
3337** the key if skipKey==0 and it points to the beginning of data if
drhe51c44f2004-05-30 20:46:09 +00003338** skipKey==1. The number of bytes of available key/data is written
3339** into *pAmt. If *pAmt==0, then the value returned will not be
3340** a valid pointer.
drh0e1c19e2004-05-11 00:58:56 +00003341**
3342** This routine is an optimization. It is common for the entire key
3343** and data to fit on the local page and for there to be no overflow
3344** pages. When that is so, this routine can be used to access the
3345** key and data without making a copy. If the key and/or data spills
drh16a9b832007-05-05 18:39:25 +00003346** onto overflow pages, then accessPayload() must be used to reassembly
drh0e1c19e2004-05-11 00:58:56 +00003347** the key/data and copy it into a preallocated buffer.
3348**
3349** The pointer returned by this routine looks directly into the cached
3350** page of the database. The data might change or move the next time
3351** any btree routine is called.
3352*/
3353static const unsigned char *fetchPayload(
3354 BtCursor *pCur, /* Cursor pointing to entry to read from */
drhe51c44f2004-05-30 20:46:09 +00003355 int *pAmt, /* Write the number of available bytes here */
drh0e1c19e2004-05-11 00:58:56 +00003356 int skipKey /* read beginning at data if this is true */
3357){
3358 unsigned char *aPayload;
3359 MemPage *pPage;
drhfa1a98a2004-05-14 19:08:17 +00003360 u32 nKey;
3361 int nLocal;
drh0e1c19e2004-05-11 00:58:56 +00003362
3363 assert( pCur!=0 && pCur->pPage!=0 );
danielk1977da184232006-01-05 11:34:32 +00003364 assert( pCur->eState==CURSOR_VALID );
drh1fee73e2007-08-29 04:00:57 +00003365 assert( cursorHoldsMutex(pCur) );
drh0e1c19e2004-05-11 00:58:56 +00003366 pPage = pCur->pPage;
drh0e1c19e2004-05-11 00:58:56 +00003367 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
drh86057612007-06-26 01:04:48 +00003368 getCellInfo(pCur);
drh43605152004-05-29 21:46:49 +00003369 aPayload = pCur->info.pCell;
drhfa1a98a2004-05-14 19:08:17 +00003370 aPayload += pCur->info.nHeader;
drh0e1c19e2004-05-11 00:58:56 +00003371 if( pPage->intKey ){
drhfa1a98a2004-05-14 19:08:17 +00003372 nKey = 0;
3373 }else{
3374 nKey = pCur->info.nKey;
drh0e1c19e2004-05-11 00:58:56 +00003375 }
drh0e1c19e2004-05-11 00:58:56 +00003376 if( skipKey ){
drhfa1a98a2004-05-14 19:08:17 +00003377 aPayload += nKey;
3378 nLocal = pCur->info.nLocal - nKey;
drh0e1c19e2004-05-11 00:58:56 +00003379 }else{
drhfa1a98a2004-05-14 19:08:17 +00003380 nLocal = pCur->info.nLocal;
drhe51c44f2004-05-30 20:46:09 +00003381 if( nLocal>nKey ){
3382 nLocal = nKey;
3383 }
drh0e1c19e2004-05-11 00:58:56 +00003384 }
drhe51c44f2004-05-30 20:46:09 +00003385 *pAmt = nLocal;
drh0e1c19e2004-05-11 00:58:56 +00003386 return aPayload;
3387}
3388
3389
3390/*
drhe51c44f2004-05-30 20:46:09 +00003391** For the entry that cursor pCur is point to, return as
3392** many bytes of the key or data as are available on the local
3393** b-tree page. Write the number of available bytes into *pAmt.
drh0e1c19e2004-05-11 00:58:56 +00003394**
3395** The pointer returned is ephemeral. The key/data may move
drhd677b3d2007-08-20 22:48:41 +00003396** or be destroyed on the next call to any Btree routine,
3397** including calls from other threads against the same cache.
3398** Hence, a mutex on the BtShared should be held prior to calling
3399** this routine.
drh0e1c19e2004-05-11 00:58:56 +00003400**
3401** These routines is used to get quick access to key and data
3402** in the common case where no overflow pages are used.
drh0e1c19e2004-05-11 00:58:56 +00003403*/
drhe51c44f2004-05-30 20:46:09 +00003404const void *sqlite3BtreeKeyFetch(BtCursor *pCur, int *pAmt){
drh1fee73e2007-08-29 04:00:57 +00003405 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003406 if( pCur->eState==CURSOR_VALID ){
3407 return (const void*)fetchPayload(pCur, pAmt, 0);
3408 }
3409 return 0;
drh0e1c19e2004-05-11 00:58:56 +00003410}
drhe51c44f2004-05-30 20:46:09 +00003411const void *sqlite3BtreeDataFetch(BtCursor *pCur, int *pAmt){
drh1fee73e2007-08-29 04:00:57 +00003412 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003413 if( pCur->eState==CURSOR_VALID ){
3414 return (const void*)fetchPayload(pCur, pAmt, 1);
3415 }
3416 return 0;
drh0e1c19e2004-05-11 00:58:56 +00003417}
3418
3419
3420/*
drh8178a752003-01-05 21:41:40 +00003421** Move the cursor down to a new child page. The newPgno argument is the
drhab01f612004-05-22 02:55:23 +00003422** page number of the child page to move to.
drh72f82862001-05-24 21:06:34 +00003423*/
drh3aac2dd2004-04-26 14:10:20 +00003424static int moveToChild(BtCursor *pCur, u32 newPgno){
drh72f82862001-05-24 21:06:34 +00003425 int rc;
3426 MemPage *pNewPage;
drh3aac2dd2004-04-26 14:10:20 +00003427 MemPage *pOldPage;
drhd0679ed2007-08-28 22:24:34 +00003428 BtShared *pBt = pCur->pBt;
drh72f82862001-05-24 21:06:34 +00003429
drh1fee73e2007-08-29 04:00:57 +00003430 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003431 assert( pCur->eState==CURSOR_VALID );
drhde647132004-05-07 17:57:49 +00003432 rc = getAndInitPage(pBt, newPgno, &pNewPage, pCur->pPage);
drh6019e162001-07-02 17:51:45 +00003433 if( rc ) return rc;
drh428ae8c2003-01-04 16:48:09 +00003434 pNewPage->idxParent = pCur->idx;
drh3aac2dd2004-04-26 14:10:20 +00003435 pOldPage = pCur->pPage;
3436 pOldPage->idxShift = 0;
3437 releasePage(pOldPage);
drh72f82862001-05-24 21:06:34 +00003438 pCur->pPage = pNewPage;
3439 pCur->idx = 0;
drh271efa52004-05-30 19:19:05 +00003440 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003441 pCur->validNKey = 0;
drh4be295b2003-12-16 03:44:47 +00003442 if( pNewPage->nCell<1 ){
drh49285702005-09-17 15:20:26 +00003443 return SQLITE_CORRUPT_BKPT;
drh4be295b2003-12-16 03:44:47 +00003444 }
drh72f82862001-05-24 21:06:34 +00003445 return SQLITE_OK;
3446}
3447
3448/*
drh8856d6a2004-04-29 14:42:46 +00003449** Return true if the page is the virtual root of its table.
3450**
3451** The virtual root page is the root page for most tables. But
3452** for the table rooted on page 1, sometime the real root page
3453** is empty except for the right-pointer. In such cases the
3454** virtual root page is the page that the right-pointer of page
3455** 1 is pointing to.
3456*/
drh16a9b832007-05-05 18:39:25 +00003457int sqlite3BtreeIsRootPage(MemPage *pPage){
drhd677b3d2007-08-20 22:48:41 +00003458 MemPage *pParent;
3459
drh1fee73e2007-08-29 04:00:57 +00003460 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00003461 pParent = pPage->pParent;
drhda200cc2004-05-09 11:51:38 +00003462 if( pParent==0 ) return 1;
3463 if( pParent->pgno>1 ) return 0;
3464 if( get2byte(&pParent->aData[pParent->hdrOffset+3])==0 ) return 1;
drh8856d6a2004-04-29 14:42:46 +00003465 return 0;
3466}
3467
3468/*
drh5e2f8b92001-05-28 00:41:15 +00003469** Move the cursor up to the parent page.
3470**
3471** pCur->idx is set to the cell index that contains the pointer
3472** to the page we are coming from. If we are coming from the
3473** right-most child page then pCur->idx is set to one more than
drhbd03cae2001-06-02 02:40:57 +00003474** the largest cell index.
drh72f82862001-05-24 21:06:34 +00003475*/
drh16a9b832007-05-05 18:39:25 +00003476void sqlite3BtreeMoveToParent(BtCursor *pCur){
drh72f82862001-05-24 21:06:34 +00003477 MemPage *pParent;
drh8178a752003-01-05 21:41:40 +00003478 MemPage *pPage;
drh428ae8c2003-01-04 16:48:09 +00003479 int idxParent;
drh3aac2dd2004-04-26 14:10:20 +00003480
drh1fee73e2007-08-29 04:00:57 +00003481 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003482 assert( pCur->eState==CURSOR_VALID );
drh8178a752003-01-05 21:41:40 +00003483 pPage = pCur->pPage;
3484 assert( pPage!=0 );
drh16a9b832007-05-05 18:39:25 +00003485 assert( !sqlite3BtreeIsRootPage(pPage) );
drh8178a752003-01-05 21:41:40 +00003486 pParent = pPage->pParent;
3487 assert( pParent!=0 );
danielk19778c0a7912008-08-20 14:49:23 +00003488 assert( pPage->pDbPage->nRef>0 );
drh8178a752003-01-05 21:41:40 +00003489 idxParent = pPage->idxParent;
danielk19773b8a05f2007-03-19 17:44:26 +00003490 sqlite3PagerRef(pParent->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00003491 releasePage(pPage);
drh72f82862001-05-24 21:06:34 +00003492 pCur->pPage = pParent;
drh271efa52004-05-30 19:19:05 +00003493 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003494 pCur->validNKey = 0;
drh428ae8c2003-01-04 16:48:09 +00003495 assert( pParent->idxShift==0 );
drh43605152004-05-29 21:46:49 +00003496 pCur->idx = idxParent;
drh72f82862001-05-24 21:06:34 +00003497}
3498
3499/*
3500** Move the cursor to the root page
3501*/
drh5e2f8b92001-05-28 00:41:15 +00003502static int moveToRoot(BtCursor *pCur){
drh3aac2dd2004-04-26 14:10:20 +00003503 MemPage *pRoot;
drh777e4c42006-01-13 04:31:58 +00003504 int rc = SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00003505 Btree *p = pCur->pBtree;
3506 BtShared *pBt = p->pBt;
drhbd03cae2001-06-02 02:40:57 +00003507
drh1fee73e2007-08-29 04:00:57 +00003508 assert( cursorHoldsMutex(pCur) );
drhfb982642007-08-30 01:19:59 +00003509 assert( CURSOR_INVALID < CURSOR_REQUIRESEEK );
3510 assert( CURSOR_VALID < CURSOR_REQUIRESEEK );
3511 assert( CURSOR_FAULT > CURSOR_REQUIRESEEK );
3512 if( pCur->eState>=CURSOR_REQUIRESEEK ){
3513 if( pCur->eState==CURSOR_FAULT ){
3514 return pCur->skip;
3515 }
drhbf700f32007-03-31 02:36:44 +00003516 clearCursorPosition(pCur);
3517 }
drh777e4c42006-01-13 04:31:58 +00003518 pRoot = pCur->pPage;
danielk197797a227c2006-01-20 16:32:04 +00003519 if( pRoot && pRoot->pgno==pCur->pgnoRoot ){
drh777e4c42006-01-13 04:31:58 +00003520 assert( pRoot->isInit );
3521 }else{
3522 if(
3523 SQLITE_OK!=(rc = getAndInitPage(pBt, pCur->pgnoRoot, &pRoot, 0))
3524 ){
3525 pCur->eState = CURSOR_INVALID;
3526 return rc;
3527 }
3528 releasePage(pCur->pPage);
drh777e4c42006-01-13 04:31:58 +00003529 pCur->pPage = pRoot;
drhc39e0002004-05-07 23:50:57 +00003530 }
drh72f82862001-05-24 21:06:34 +00003531 pCur->idx = 0;
drh271efa52004-05-30 19:19:05 +00003532 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003533 pCur->atLast = 0;
3534 pCur->validNKey = 0;
drh8856d6a2004-04-29 14:42:46 +00003535 if( pRoot->nCell==0 && !pRoot->leaf ){
3536 Pgno subpage;
3537 assert( pRoot->pgno==1 );
drh43605152004-05-29 21:46:49 +00003538 subpage = get4byte(&pRoot->aData[pRoot->hdrOffset+8]);
drh8856d6a2004-04-29 14:42:46 +00003539 assert( subpage>0 );
danielk1977da184232006-01-05 11:34:32 +00003540 pCur->eState = CURSOR_VALID;
drh4b70f112004-05-02 21:12:19 +00003541 rc = moveToChild(pCur, subpage);
drh8856d6a2004-04-29 14:42:46 +00003542 }
danielk1977da184232006-01-05 11:34:32 +00003543 pCur->eState = ((pCur->pPage->nCell>0)?CURSOR_VALID:CURSOR_INVALID);
drh8856d6a2004-04-29 14:42:46 +00003544 return rc;
drh72f82862001-05-24 21:06:34 +00003545}
drh2af926b2001-05-15 00:39:25 +00003546
drh5e2f8b92001-05-28 00:41:15 +00003547/*
3548** Move the cursor down to the left-most leaf entry beneath the
3549** entry to which it is currently pointing.
drh777e4c42006-01-13 04:31:58 +00003550**
3551** The left-most leaf is the one with the smallest key - the first
3552** in ascending order.
drh5e2f8b92001-05-28 00:41:15 +00003553*/
3554static int moveToLeftmost(BtCursor *pCur){
3555 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00003556 int rc = SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00003557 MemPage *pPage;
drh5e2f8b92001-05-28 00:41:15 +00003558
drh1fee73e2007-08-29 04:00:57 +00003559 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003560 assert( pCur->eState==CURSOR_VALID );
drhd677b3d2007-08-20 22:48:41 +00003561 while( rc==SQLITE_OK && !(pPage = pCur->pPage)->leaf ){
drha34b6762004-05-07 13:30:42 +00003562 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
danielk19771cc5ed82007-05-16 17:28:43 +00003563 pgno = get4byte(findCell(pPage, pCur->idx));
drh8178a752003-01-05 21:41:40 +00003564 rc = moveToChild(pCur, pgno);
drh5e2f8b92001-05-28 00:41:15 +00003565 }
drhd677b3d2007-08-20 22:48:41 +00003566 return rc;
drh5e2f8b92001-05-28 00:41:15 +00003567}
3568
drh2dcc9aa2002-12-04 13:40:25 +00003569/*
3570** Move the cursor down to the right-most leaf entry beneath the
3571** page to which it is currently pointing. Notice the difference
3572** between moveToLeftmost() and moveToRightmost(). moveToLeftmost()
3573** finds the left-most entry beneath the *entry* whereas moveToRightmost()
3574** finds the right-most entry beneath the *page*.
drh777e4c42006-01-13 04:31:58 +00003575**
3576** The right-most entry is the one with the largest key - the last
3577** key in ascending order.
drh2dcc9aa2002-12-04 13:40:25 +00003578*/
3579static int moveToRightmost(BtCursor *pCur){
3580 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00003581 int rc = SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00003582 MemPage *pPage;
drh2dcc9aa2002-12-04 13:40:25 +00003583
drh1fee73e2007-08-29 04:00:57 +00003584 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003585 assert( pCur->eState==CURSOR_VALID );
drhd677b3d2007-08-20 22:48:41 +00003586 while( rc==SQLITE_OK && !(pPage = pCur->pPage)->leaf ){
drh43605152004-05-29 21:46:49 +00003587 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh3aac2dd2004-04-26 14:10:20 +00003588 pCur->idx = pPage->nCell;
drh8178a752003-01-05 21:41:40 +00003589 rc = moveToChild(pCur, pgno);
drh2dcc9aa2002-12-04 13:40:25 +00003590 }
drhd677b3d2007-08-20 22:48:41 +00003591 if( rc==SQLITE_OK ){
3592 pCur->idx = pPage->nCell - 1;
3593 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003594 pCur->validNKey = 0;
drhd677b3d2007-08-20 22:48:41 +00003595 }
danielk1977518002e2008-09-05 05:02:46 +00003596 return rc;
drh2dcc9aa2002-12-04 13:40:25 +00003597}
3598
drh5e00f6c2001-09-13 13:46:56 +00003599/* Move the cursor to the first entry in the table. Return SQLITE_OK
3600** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00003601** or set *pRes to 1 if the table is empty.
drh5e00f6c2001-09-13 13:46:56 +00003602*/
drh3aac2dd2004-04-26 14:10:20 +00003603int sqlite3BtreeFirst(BtCursor *pCur, int *pRes){
drh5e00f6c2001-09-13 13:46:56 +00003604 int rc;
drhd677b3d2007-08-20 22:48:41 +00003605
drh1fee73e2007-08-29 04:00:57 +00003606 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00003607 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh5e00f6c2001-09-13 13:46:56 +00003608 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00003609 if( rc==SQLITE_OK ){
3610 if( pCur->eState==CURSOR_INVALID ){
3611 assert( pCur->pPage->nCell==0 );
3612 *pRes = 1;
3613 rc = SQLITE_OK;
3614 }else{
3615 assert( pCur->pPage->nCell>0 );
3616 *pRes = 0;
3617 rc = moveToLeftmost(pCur);
3618 }
drh5e00f6c2001-09-13 13:46:56 +00003619 }
drh5e00f6c2001-09-13 13:46:56 +00003620 return rc;
3621}
drh5e2f8b92001-05-28 00:41:15 +00003622
drh9562b552002-02-19 15:00:07 +00003623/* Move the cursor to the last entry in the table. Return SQLITE_OK
3624** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00003625** or set *pRes to 1 if the table is empty.
drh9562b552002-02-19 15:00:07 +00003626*/
drh3aac2dd2004-04-26 14:10:20 +00003627int sqlite3BtreeLast(BtCursor *pCur, int *pRes){
drh9562b552002-02-19 15:00:07 +00003628 int rc;
drhd677b3d2007-08-20 22:48:41 +00003629
drh1fee73e2007-08-29 04:00:57 +00003630 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00003631 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh9562b552002-02-19 15:00:07 +00003632 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00003633 if( rc==SQLITE_OK ){
3634 if( CURSOR_INVALID==pCur->eState ){
3635 assert( pCur->pPage->nCell==0 );
3636 *pRes = 1;
3637 }else{
3638 assert( pCur->eState==CURSOR_VALID );
3639 *pRes = 0;
3640 rc = moveToRightmost(pCur);
drha2c20e42008-03-29 16:01:04 +00003641 getCellInfo(pCur);
3642 pCur->atLast = rc==SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00003643 }
drh9562b552002-02-19 15:00:07 +00003644 }
drh9562b552002-02-19 15:00:07 +00003645 return rc;
3646}
3647
drhe14006d2008-03-25 17:23:32 +00003648/* Move the cursor so that it points to an entry near the key
drhe63d9992008-08-13 19:11:48 +00003649** specified by pIdxKey or intKey. Return a success code.
drh72f82862001-05-24 21:06:34 +00003650**
drhe63d9992008-08-13 19:11:48 +00003651** For INTKEY tables, the intKey parameter is used. pIdxKey
3652** must be NULL. For index tables, pIdxKey is used and intKey
3653** is ignored.
drh3aac2dd2004-04-26 14:10:20 +00003654**
drh5e2f8b92001-05-28 00:41:15 +00003655** If an exact match is not found, then the cursor is always
drhbd03cae2001-06-02 02:40:57 +00003656** left pointing at a leaf page which would hold the entry if it
drh5e2f8b92001-05-28 00:41:15 +00003657** were present. The cursor might point to an entry that comes
3658** before or after the key.
3659**
drhbd03cae2001-06-02 02:40:57 +00003660** The result of comparing the key with the entry to which the
drhab01f612004-05-22 02:55:23 +00003661** cursor is written to *pRes if pRes!=NULL. The meaning of
drhbd03cae2001-06-02 02:40:57 +00003662** this value is as follows:
3663**
3664** *pRes<0 The cursor is left pointing at an entry that
drh1a844c32002-12-04 22:29:28 +00003665** is smaller than pKey or if the table is empty
3666** and the cursor is therefore left point to nothing.
drhbd03cae2001-06-02 02:40:57 +00003667**
3668** *pRes==0 The cursor is left pointing at an entry that
3669** exactly matches pKey.
3670**
3671** *pRes>0 The cursor is left pointing at an entry that
drh7c717f72001-06-24 20:39:41 +00003672** is larger than pKey.
drhd677b3d2007-08-20 22:48:41 +00003673**
drha059ad02001-04-17 20:09:11 +00003674*/
drhe63d9992008-08-13 19:11:48 +00003675int sqlite3BtreeMovetoUnpacked(
3676 BtCursor *pCur, /* The cursor to be moved */
3677 UnpackedRecord *pIdxKey, /* Unpacked index key */
3678 i64 intKey, /* The table key */
3679 int biasRight, /* If true, bias the search to the high end */
3680 int *pRes /* Write search results here */
drhe4d90812007-03-29 05:51:49 +00003681){
drh72f82862001-05-24 21:06:34 +00003682 int rc;
drhd677b3d2007-08-20 22:48:41 +00003683
drh1fee73e2007-08-29 04:00:57 +00003684 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00003685 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drha2c20e42008-03-29 16:01:04 +00003686
3687 /* If the cursor is already positioned at the point we are trying
3688 ** to move to, then just return without doing any work */
3689 if( pCur->eState==CURSOR_VALID && pCur->validNKey && pCur->pPage->intKey ){
drhe63d9992008-08-13 19:11:48 +00003690 if( pCur->info.nKey==intKey ){
drha2c20e42008-03-29 16:01:04 +00003691 *pRes = 0;
3692 return SQLITE_OK;
3693 }
drhe63d9992008-08-13 19:11:48 +00003694 if( pCur->atLast && pCur->info.nKey<intKey ){
drha2c20e42008-03-29 16:01:04 +00003695 *pRes = -1;
3696 return SQLITE_OK;
3697 }
3698 }
3699
3700
drh5e2f8b92001-05-28 00:41:15 +00003701 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00003702 if( rc ){
3703 return rc;
3704 }
drhc39e0002004-05-07 23:50:57 +00003705 assert( pCur->pPage );
3706 assert( pCur->pPage->isInit );
danielk1977da184232006-01-05 11:34:32 +00003707 if( pCur->eState==CURSOR_INVALID ){
drhf328bc82004-05-10 23:29:49 +00003708 *pRes = -1;
drhc39e0002004-05-07 23:50:57 +00003709 assert( pCur->pPage->nCell==0 );
3710 return SQLITE_OK;
3711 }
drhe63d9992008-08-13 19:11:48 +00003712 assert( pCur->pPage->intKey || pIdxKey );
drh14684382006-11-30 13:05:29 +00003713 for(;;){
drh72f82862001-05-24 21:06:34 +00003714 int lwr, upr;
3715 Pgno chldPg;
3716 MemPage *pPage = pCur->pPage;
drh1a844c32002-12-04 22:29:28 +00003717 int c = -1; /* pRes return if table is empty must be -1 */
drh72f82862001-05-24 21:06:34 +00003718 lwr = 0;
3719 upr = pPage->nCell-1;
drhe63d9992008-08-13 19:11:48 +00003720 if( !pPage->intKey && pIdxKey==0 ){
drh1e968a02008-03-25 00:22:21 +00003721 rc = SQLITE_CORRUPT_BKPT;
3722 goto moveto_finish;
drh4eec4c12005-01-21 00:22:37 +00003723 }
drhe4d90812007-03-29 05:51:49 +00003724 if( biasRight ){
3725 pCur->idx = upr;
3726 }else{
3727 pCur->idx = (upr+lwr)/2;
3728 }
drhf1d68b32007-03-29 04:43:26 +00003729 if( lwr<=upr ) for(;;){
danielk197713adf8a2004-06-03 16:08:41 +00003730 void *pCellKey;
drh4a1c3802004-05-12 15:15:47 +00003731 i64 nCellKey;
drh366fda62006-01-13 02:35:09 +00003732 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003733 pCur->validNKey = 1;
drh3aac2dd2004-04-26 14:10:20 +00003734 if( pPage->intKey ){
drh777e4c42006-01-13 04:31:58 +00003735 u8 *pCell;
danielk19771cc5ed82007-05-16 17:28:43 +00003736 pCell = findCell(pPage, pCur->idx) + pPage->childPtrSize;
drhd172f862006-01-12 15:01:15 +00003737 if( pPage->hasData ){
danielk1977bab45c62006-01-16 15:14:27 +00003738 u32 dummy;
shane3f8d5cf2008-04-24 19:15:09 +00003739 pCell += getVarint32(pCell, dummy);
drhd172f862006-01-12 15:01:15 +00003740 }
drha2c20e42008-03-29 16:01:04 +00003741 getVarint(pCell, (u64*)&nCellKey);
drhe63d9992008-08-13 19:11:48 +00003742 if( nCellKey==intKey ){
drh3aac2dd2004-04-26 14:10:20 +00003743 c = 0;
drhe63d9992008-08-13 19:11:48 +00003744 }else if( nCellKey<intKey ){
drh41eb9e92008-04-02 18:33:07 +00003745 c = -1;
3746 }else{
drhe63d9992008-08-13 19:11:48 +00003747 assert( nCellKey>intKey );
drh41eb9e92008-04-02 18:33:07 +00003748 c = +1;
drh3aac2dd2004-04-26 14:10:20 +00003749 }
drh3aac2dd2004-04-26 14:10:20 +00003750 }else{
drhe51c44f2004-05-30 20:46:09 +00003751 int available;
danielk197713adf8a2004-06-03 16:08:41 +00003752 pCellKey = (void *)fetchPayload(pCur, &available, 0);
drh366fda62006-01-13 02:35:09 +00003753 nCellKey = pCur->info.nKey;
drhe51c44f2004-05-30 20:46:09 +00003754 if( available>=nCellKey ){
drhe63d9992008-08-13 19:11:48 +00003755 c = sqlite3VdbeRecordCompare(nCellKey, pCellKey, pIdxKey);
drhe51c44f2004-05-30 20:46:09 +00003756 }else{
drhfacf0302008-06-17 15:12:00 +00003757 pCellKey = sqlite3Malloc( nCellKey );
danielk19776507ecb2008-03-25 09:56:44 +00003758 if( pCellKey==0 ){
3759 rc = SQLITE_NOMEM;
3760 goto moveto_finish;
3761 }
danielk197713adf8a2004-06-03 16:08:41 +00003762 rc = sqlite3BtreeKey(pCur, 0, nCellKey, (void *)pCellKey);
drhe63d9992008-08-13 19:11:48 +00003763 c = sqlite3VdbeRecordCompare(nCellKey, pCellKey, pIdxKey);
drhfacf0302008-06-17 15:12:00 +00003764 sqlite3_free(pCellKey);
drh1e968a02008-03-25 00:22:21 +00003765 if( rc ) goto moveto_finish;
drhe51c44f2004-05-30 20:46:09 +00003766 }
drh3aac2dd2004-04-26 14:10:20 +00003767 }
drh72f82862001-05-24 21:06:34 +00003768 if( c==0 ){
drha2c20e42008-03-29 16:01:04 +00003769 pCur->info.nKey = nCellKey;
drh44845222008-07-17 18:39:57 +00003770 if( pPage->intKey && !pPage->leaf ){
drhfc70e6f2004-05-12 21:11:27 +00003771 lwr = pCur->idx;
3772 upr = lwr - 1;
drh8b18dd42004-05-12 19:18:15 +00003773 break;
3774 }else{
drh8b18dd42004-05-12 19:18:15 +00003775 if( pRes ) *pRes = 0;
drh1e968a02008-03-25 00:22:21 +00003776 rc = SQLITE_OK;
3777 goto moveto_finish;
drh8b18dd42004-05-12 19:18:15 +00003778 }
drh72f82862001-05-24 21:06:34 +00003779 }
3780 if( c<0 ){
3781 lwr = pCur->idx+1;
3782 }else{
3783 upr = pCur->idx-1;
3784 }
drhf1d68b32007-03-29 04:43:26 +00003785 if( lwr>upr ){
drha2c20e42008-03-29 16:01:04 +00003786 pCur->info.nKey = nCellKey;
drhf1d68b32007-03-29 04:43:26 +00003787 break;
3788 }
3789 pCur->idx = (lwr+upr)/2;
drh72f82862001-05-24 21:06:34 +00003790 }
3791 assert( lwr==upr+1 );
drh7aa128d2002-06-21 13:09:16 +00003792 assert( pPage->isInit );
drh3aac2dd2004-04-26 14:10:20 +00003793 if( pPage->leaf ){
drha34b6762004-05-07 13:30:42 +00003794 chldPg = 0;
drh3aac2dd2004-04-26 14:10:20 +00003795 }else if( lwr>=pPage->nCell ){
drh43605152004-05-29 21:46:49 +00003796 chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh72f82862001-05-24 21:06:34 +00003797 }else{
danielk19771cc5ed82007-05-16 17:28:43 +00003798 chldPg = get4byte(findCell(pPage, lwr));
drh72f82862001-05-24 21:06:34 +00003799 }
3800 if( chldPg==0 ){
drhc39e0002004-05-07 23:50:57 +00003801 assert( pCur->idx>=0 && pCur->idx<pCur->pPage->nCell );
drh72f82862001-05-24 21:06:34 +00003802 if( pRes ) *pRes = c;
drh1e968a02008-03-25 00:22:21 +00003803 rc = SQLITE_OK;
3804 goto moveto_finish;
drh72f82862001-05-24 21:06:34 +00003805 }
drh428ae8c2003-01-04 16:48:09 +00003806 pCur->idx = lwr;
drh271efa52004-05-30 19:19:05 +00003807 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003808 pCur->validNKey = 0;
drh8178a752003-01-05 21:41:40 +00003809 rc = moveToChild(pCur, chldPg);
drh1e968a02008-03-25 00:22:21 +00003810 if( rc ) goto moveto_finish;
drh72f82862001-05-24 21:06:34 +00003811 }
drh1e968a02008-03-25 00:22:21 +00003812moveto_finish:
drhe63d9992008-08-13 19:11:48 +00003813 return rc;
3814}
3815
3816/*
3817** In this version of BtreeMoveto, pKey is a packed index record
3818** such as is generated by the OP_MakeRecord opcode. Unpack the
3819** record and then call BtreeMovetoUnpacked() to do the work.
3820*/
3821int sqlite3BtreeMoveto(
3822 BtCursor *pCur, /* Cursor open on the btree to be searched */
3823 const void *pKey, /* Packed key if the btree is an index */
3824 i64 nKey, /* Integer key for tables. Size of pKey for indices */
3825 int bias, /* Bias search to the high end */
3826 int *pRes /* Write search results here */
3827){
3828 int rc; /* Status code */
3829 UnpackedRecord *pIdxKey; /* Unpacked index key */
drh23f79d02008-08-20 22:06:47 +00003830 UnpackedRecord aSpace[16]; /* Temp space for pIdxKey - to avoid a malloc */
drhe63d9992008-08-13 19:11:48 +00003831
drhe14006d2008-03-25 17:23:32 +00003832 if( pKey ){
drhe63d9992008-08-13 19:11:48 +00003833 pIdxKey = sqlite3VdbeRecordUnpack(pCur->pKeyInfo, nKey, pKey,
drh23f79d02008-08-20 22:06:47 +00003834 aSpace, sizeof(aSpace));
drhe63d9992008-08-13 19:11:48 +00003835 if( pIdxKey==0 ) return SQLITE_NOMEM;
3836 }else{
3837 pIdxKey = 0;
3838 }
3839 rc = sqlite3BtreeMovetoUnpacked(pCur, pIdxKey, nKey, bias, pRes);
3840 if( pKey ){
3841 sqlite3VdbeDeleteUnpackedRecord(pIdxKey);
drhe14006d2008-03-25 17:23:32 +00003842 }
drh1e968a02008-03-25 00:22:21 +00003843 return rc;
drh72f82862001-05-24 21:06:34 +00003844}
3845
drhd677b3d2007-08-20 22:48:41 +00003846
drh72f82862001-05-24 21:06:34 +00003847/*
drhc39e0002004-05-07 23:50:57 +00003848** Return TRUE if the cursor is not pointing at an entry of the table.
3849**
3850** TRUE will be returned after a call to sqlite3BtreeNext() moves
3851** past the last entry in the table or sqlite3BtreePrev() moves past
3852** the first entry. TRUE is also returned if the table is empty.
3853*/
3854int sqlite3BtreeEof(BtCursor *pCur){
danielk1977da184232006-01-05 11:34:32 +00003855 /* TODO: What if the cursor is in CURSOR_REQUIRESEEK but all table entries
3856 ** have been deleted? This API will need to change to return an error code
3857 ** as well as the boolean result value.
3858 */
3859 return (CURSOR_VALID!=pCur->eState);
drhc39e0002004-05-07 23:50:57 +00003860}
3861
3862/*
drhb21c8cd2007-08-21 19:33:56 +00003863** Return the database connection handle for a cursor.
3864*/
3865sqlite3 *sqlite3BtreeCursorDb(const BtCursor *pCur){
drhe5fe6902007-12-07 18:55:28 +00003866 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
3867 return pCur->pBtree->db;
drhb21c8cd2007-08-21 19:33:56 +00003868}
3869
3870/*
drhbd03cae2001-06-02 02:40:57 +00003871** Advance the cursor to the next entry in the database. If
drh8c1238a2003-01-02 14:43:55 +00003872** successful then set *pRes=0. If the cursor
drhbd03cae2001-06-02 02:40:57 +00003873** was already pointing to the last entry in the database before
drh8c1238a2003-01-02 14:43:55 +00003874** this routine was called, then set *pRes=1.
drh72f82862001-05-24 21:06:34 +00003875*/
drhd094db12008-04-03 21:46:57 +00003876int sqlite3BtreeNext(BtCursor *pCur, int *pRes){
drh72f82862001-05-24 21:06:34 +00003877 int rc;
danielk197797a227c2006-01-20 16:32:04 +00003878 MemPage *pPage;
drh8b18dd42004-05-12 19:18:15 +00003879
drh1fee73e2007-08-29 04:00:57 +00003880 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00003881 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003882 if( rc!=SQLITE_OK ){
3883 return rc;
3884 }
drh8c4d3a62007-04-06 01:03:32 +00003885 assert( pRes!=0 );
3886 pPage = pCur->pPage;
3887 if( CURSOR_INVALID==pCur->eState ){
3888 *pRes = 1;
3889 return SQLITE_OK;
3890 }
danielk1977da184232006-01-05 11:34:32 +00003891 if( pCur->skip>0 ){
3892 pCur->skip = 0;
3893 *pRes = 0;
3894 return SQLITE_OK;
3895 }
3896 pCur->skip = 0;
danielk1977da184232006-01-05 11:34:32 +00003897
drh8178a752003-01-05 21:41:40 +00003898 assert( pPage->isInit );
drh8178a752003-01-05 21:41:40 +00003899 assert( pCur->idx<pPage->nCell );
danielk19776a43f9b2004-11-16 04:57:24 +00003900
drh72f82862001-05-24 21:06:34 +00003901 pCur->idx++;
drh271efa52004-05-30 19:19:05 +00003902 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003903 pCur->validNKey = 0;
drh8178a752003-01-05 21:41:40 +00003904 if( pCur->idx>=pPage->nCell ){
drha34b6762004-05-07 13:30:42 +00003905 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00003906 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
drh5e2f8b92001-05-28 00:41:15 +00003907 if( rc ) return rc;
3908 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00003909 *pRes = 0;
3910 return rc;
drh72f82862001-05-24 21:06:34 +00003911 }
drh5e2f8b92001-05-28 00:41:15 +00003912 do{
drh16a9b832007-05-05 18:39:25 +00003913 if( sqlite3BtreeIsRootPage(pPage) ){
drh8c1238a2003-01-02 14:43:55 +00003914 *pRes = 1;
danielk1977da184232006-01-05 11:34:32 +00003915 pCur->eState = CURSOR_INVALID;
drh5e2f8b92001-05-28 00:41:15 +00003916 return SQLITE_OK;
3917 }
drh16a9b832007-05-05 18:39:25 +00003918 sqlite3BtreeMoveToParent(pCur);
drh8178a752003-01-05 21:41:40 +00003919 pPage = pCur->pPage;
3920 }while( pCur->idx>=pPage->nCell );
drh8c1238a2003-01-02 14:43:55 +00003921 *pRes = 0;
drh44845222008-07-17 18:39:57 +00003922 if( pPage->intKey ){
drh8b18dd42004-05-12 19:18:15 +00003923 rc = sqlite3BtreeNext(pCur, pRes);
3924 }else{
3925 rc = SQLITE_OK;
3926 }
3927 return rc;
drh8178a752003-01-05 21:41:40 +00003928 }
3929 *pRes = 0;
drh3aac2dd2004-04-26 14:10:20 +00003930 if( pPage->leaf ){
drh8178a752003-01-05 21:41:40 +00003931 return SQLITE_OK;
drh72f82862001-05-24 21:06:34 +00003932 }
drh5e2f8b92001-05-28 00:41:15 +00003933 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00003934 return rc;
drh72f82862001-05-24 21:06:34 +00003935}
drhd677b3d2007-08-20 22:48:41 +00003936
drh72f82862001-05-24 21:06:34 +00003937
drh3b7511c2001-05-26 13:15:44 +00003938/*
drh2dcc9aa2002-12-04 13:40:25 +00003939** Step the cursor to the back to the previous entry in the database. If
drh8178a752003-01-05 21:41:40 +00003940** successful then set *pRes=0. If the cursor
drh2dcc9aa2002-12-04 13:40:25 +00003941** was already pointing to the first entry in the database before
drh8178a752003-01-05 21:41:40 +00003942** this routine was called, then set *pRes=1.
drh2dcc9aa2002-12-04 13:40:25 +00003943*/
drhd094db12008-04-03 21:46:57 +00003944int sqlite3BtreePrevious(BtCursor *pCur, int *pRes){
drh2dcc9aa2002-12-04 13:40:25 +00003945 int rc;
3946 Pgno pgno;
drh8178a752003-01-05 21:41:40 +00003947 MemPage *pPage;
danielk1977da184232006-01-05 11:34:32 +00003948
drh1fee73e2007-08-29 04:00:57 +00003949 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00003950 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003951 if( rc!=SQLITE_OK ){
3952 return rc;
3953 }
drha2c20e42008-03-29 16:01:04 +00003954 pCur->atLast = 0;
drh8c4d3a62007-04-06 01:03:32 +00003955 if( CURSOR_INVALID==pCur->eState ){
3956 *pRes = 1;
3957 return SQLITE_OK;
3958 }
danielk1977da184232006-01-05 11:34:32 +00003959 if( pCur->skip<0 ){
3960 pCur->skip = 0;
3961 *pRes = 0;
3962 return SQLITE_OK;
3963 }
3964 pCur->skip = 0;
danielk1977da184232006-01-05 11:34:32 +00003965
drh8178a752003-01-05 21:41:40 +00003966 pPage = pCur->pPage;
drh8178a752003-01-05 21:41:40 +00003967 assert( pPage->isInit );
drh2dcc9aa2002-12-04 13:40:25 +00003968 assert( pCur->idx>=0 );
drha34b6762004-05-07 13:30:42 +00003969 if( !pPage->leaf ){
danielk19771cc5ed82007-05-16 17:28:43 +00003970 pgno = get4byte( findCell(pPage, pCur->idx) );
drh8178a752003-01-05 21:41:40 +00003971 rc = moveToChild(pCur, pgno);
drhd677b3d2007-08-20 22:48:41 +00003972 if( rc ){
3973 return rc;
3974 }
drh2dcc9aa2002-12-04 13:40:25 +00003975 rc = moveToRightmost(pCur);
3976 }else{
3977 while( pCur->idx==0 ){
drh16a9b832007-05-05 18:39:25 +00003978 if( sqlite3BtreeIsRootPage(pPage) ){
danielk1977da184232006-01-05 11:34:32 +00003979 pCur->eState = CURSOR_INVALID;
drhc39e0002004-05-07 23:50:57 +00003980 *pRes = 1;
drh2dcc9aa2002-12-04 13:40:25 +00003981 return SQLITE_OK;
3982 }
drh16a9b832007-05-05 18:39:25 +00003983 sqlite3BtreeMoveToParent(pCur);
drh8178a752003-01-05 21:41:40 +00003984 pPage = pCur->pPage;
drh2dcc9aa2002-12-04 13:40:25 +00003985 }
3986 pCur->idx--;
drh271efa52004-05-30 19:19:05 +00003987 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003988 pCur->validNKey = 0;
drh44845222008-07-17 18:39:57 +00003989 if( pPage->intKey && !pPage->leaf ){
drh8b18dd42004-05-12 19:18:15 +00003990 rc = sqlite3BtreePrevious(pCur, pRes);
3991 }else{
3992 rc = SQLITE_OK;
3993 }
drh2dcc9aa2002-12-04 13:40:25 +00003994 }
drh8178a752003-01-05 21:41:40 +00003995 *pRes = 0;
drh2dcc9aa2002-12-04 13:40:25 +00003996 return rc;
3997}
3998
3999/*
drh3b7511c2001-05-26 13:15:44 +00004000** Allocate a new page from the database file.
4001**
danielk19773b8a05f2007-03-19 17:44:26 +00004002** The new page is marked as dirty. (In other words, sqlite3PagerWrite()
drh3b7511c2001-05-26 13:15:44 +00004003** has already been called on the new page.) The new page has also
4004** been referenced and the calling routine is responsible for calling
danielk19773b8a05f2007-03-19 17:44:26 +00004005** sqlite3PagerUnref() on the new page when it is done.
drh3b7511c2001-05-26 13:15:44 +00004006**
4007** SQLITE_OK is returned on success. Any other return value indicates
4008** an error. *ppPage and *pPgno are undefined in the event of an error.
danielk19773b8a05f2007-03-19 17:44:26 +00004009** Do not invoke sqlite3PagerUnref() on *ppPage if an error is returned.
drhbea00b92002-07-08 10:59:50 +00004010**
drh199e3cf2002-07-18 11:01:47 +00004011** If the "nearby" parameter is not 0, then a (feeble) effort is made to
4012** locate a page close to the page number "nearby". This can be used in an
drhbea00b92002-07-08 10:59:50 +00004013** attempt to keep related pages close to each other in the database file,
4014** which in turn can make database access faster.
danielk1977cb1a7eb2004-11-05 12:27:02 +00004015**
4016** If the "exact" parameter is not 0, and the page-number nearby exists
4017** anywhere on the free-list, then it is guarenteed to be returned. This
4018** is only used by auto-vacuum databases when allocating a new table.
drh3b7511c2001-05-26 13:15:44 +00004019*/
drh4f0c5872007-03-26 22:05:01 +00004020static int allocateBtreePage(
danielk1977aef0bf62005-12-30 16:28:01 +00004021 BtShared *pBt,
danielk1977cb1a7eb2004-11-05 12:27:02 +00004022 MemPage **ppPage,
4023 Pgno *pPgno,
4024 Pgno nearby,
4025 u8 exact
4026){
drh3aac2dd2004-04-26 14:10:20 +00004027 MemPage *pPage1;
drh8c42ca92001-06-22 19:15:00 +00004028 int rc;
drh3aac2dd2004-04-26 14:10:20 +00004029 int n; /* Number of pages on the freelist */
4030 int k; /* Number of leaves on the trunk of the freelist */
drhd3627af2006-12-18 18:34:51 +00004031 MemPage *pTrunk = 0;
4032 MemPage *pPrevTrunk = 0;
drh30e58752002-03-02 20:41:57 +00004033
drh1fee73e2007-08-29 04:00:57 +00004034 assert( sqlite3_mutex_held(pBt->mutex) );
drh3aac2dd2004-04-26 14:10:20 +00004035 pPage1 = pBt->pPage1;
4036 n = get4byte(&pPage1->aData[36]);
4037 if( n>0 ){
drh91025292004-05-03 19:49:32 +00004038 /* There are pages on the freelist. Reuse one of those pages. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00004039 Pgno iTrunk;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004040 u8 searchList = 0; /* If the free-list must be searched for 'nearby' */
4041
4042 /* If the 'exact' parameter was true and a query of the pointer-map
4043 ** shows that the page 'nearby' is somewhere on the free-list, then
4044 ** the entire-list will be searched for that page.
4045 */
4046#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977ad0132d2008-06-07 08:58:22 +00004047 if( exact && nearby<=pagerPagecount(pBt->pPager) ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004048 u8 eType;
4049 assert( nearby>0 );
4050 assert( pBt->autoVacuum );
4051 rc = ptrmapGet(pBt, nearby, &eType, 0);
4052 if( rc ) return rc;
4053 if( eType==PTRMAP_FREEPAGE ){
4054 searchList = 1;
4055 }
4056 *pPgno = nearby;
4057 }
4058#endif
4059
4060 /* Decrement the free-list count by 1. Set iTrunk to the index of the
4061 ** first free-list trunk page. iPrevTrunk is initially 1.
4062 */
danielk19773b8a05f2007-03-19 17:44:26 +00004063 rc = sqlite3PagerWrite(pPage1->pDbPage);
drh3b7511c2001-05-26 13:15:44 +00004064 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00004065 put4byte(&pPage1->aData[36], n-1);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004066
4067 /* The code within this loop is run only once if the 'searchList' variable
4068 ** is not true. Otherwise, it runs once for each trunk-page on the
4069 ** free-list until the page 'nearby' is located.
4070 */
4071 do {
4072 pPrevTrunk = pTrunk;
4073 if( pPrevTrunk ){
4074 iTrunk = get4byte(&pPrevTrunk->aData[0]);
drhbea00b92002-07-08 10:59:50 +00004075 }else{
danielk1977cb1a7eb2004-11-05 12:27:02 +00004076 iTrunk = get4byte(&pPage1->aData[32]);
drhbea00b92002-07-08 10:59:50 +00004077 }
drh16a9b832007-05-05 18:39:25 +00004078 rc = sqlite3BtreeGetPage(pBt, iTrunk, &pTrunk, 0);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004079 if( rc ){
drhd3627af2006-12-18 18:34:51 +00004080 pTrunk = 0;
4081 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004082 }
4083
4084 k = get4byte(&pTrunk->aData[4]);
4085 if( k==0 && !searchList ){
4086 /* The trunk has no leaves and the list is not being searched.
4087 ** So extract the trunk page itself and use it as the newly
4088 ** allocated page */
4089 assert( pPrevTrunk==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00004090 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004091 if( rc ){
4092 goto end_allocate_page;
4093 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004094 *pPgno = iTrunk;
4095 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
4096 *ppPage = pTrunk;
4097 pTrunk = 0;
4098 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
drh45b1fac2008-07-04 17:52:42 +00004099 }else if( k>pBt->usableSize/4 - 2 ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004100 /* Value of k is out of range. Database corruption */
drhd3627af2006-12-18 18:34:51 +00004101 rc = SQLITE_CORRUPT_BKPT;
4102 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004103#ifndef SQLITE_OMIT_AUTOVACUUM
4104 }else if( searchList && nearby==iTrunk ){
4105 /* The list is being searched and this trunk page is the page
4106 ** to allocate, regardless of whether it has leaves.
4107 */
4108 assert( *pPgno==iTrunk );
4109 *ppPage = pTrunk;
4110 searchList = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00004111 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004112 if( rc ){
4113 goto end_allocate_page;
4114 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004115 if( k==0 ){
4116 if( !pPrevTrunk ){
4117 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
4118 }else{
4119 memcpy(&pPrevTrunk->aData[0], &pTrunk->aData[0], 4);
4120 }
4121 }else{
4122 /* The trunk page is required by the caller but it contains
4123 ** pointers to free-list leaves. The first leaf becomes a trunk
4124 ** page in this case.
4125 */
4126 MemPage *pNewTrunk;
4127 Pgno iNewTrunk = get4byte(&pTrunk->aData[8]);
drh16a9b832007-05-05 18:39:25 +00004128 rc = sqlite3BtreeGetPage(pBt, iNewTrunk, &pNewTrunk, 0);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004129 if( rc!=SQLITE_OK ){
drhd3627af2006-12-18 18:34:51 +00004130 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004131 }
danielk19773b8a05f2007-03-19 17:44:26 +00004132 rc = sqlite3PagerWrite(pNewTrunk->pDbPage);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004133 if( rc!=SQLITE_OK ){
4134 releasePage(pNewTrunk);
drhd3627af2006-12-18 18:34:51 +00004135 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004136 }
4137 memcpy(&pNewTrunk->aData[0], &pTrunk->aData[0], 4);
4138 put4byte(&pNewTrunk->aData[4], k-1);
4139 memcpy(&pNewTrunk->aData[8], &pTrunk->aData[12], (k-1)*4);
drhd3627af2006-12-18 18:34:51 +00004140 releasePage(pNewTrunk);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004141 if( !pPrevTrunk ){
4142 put4byte(&pPage1->aData[32], iNewTrunk);
4143 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004144 rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004145 if( rc ){
4146 goto end_allocate_page;
4147 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004148 put4byte(&pPrevTrunk->aData[0], iNewTrunk);
4149 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004150 }
4151 pTrunk = 0;
4152 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
4153#endif
4154 }else{
4155 /* Extract a leaf from the trunk */
4156 int closest;
4157 Pgno iPage;
4158 unsigned char *aData = pTrunk->aData;
danielk19773b8a05f2007-03-19 17:44:26 +00004159 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004160 if( rc ){
4161 goto end_allocate_page;
4162 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004163 if( nearby>0 ){
4164 int i, dist;
4165 closest = 0;
4166 dist = get4byte(&aData[8]) - nearby;
4167 if( dist<0 ) dist = -dist;
4168 for(i=1; i<k; i++){
4169 int d2 = get4byte(&aData[8+i*4]) - nearby;
4170 if( d2<0 ) d2 = -d2;
4171 if( d2<dist ){
4172 closest = i;
4173 dist = d2;
4174 }
4175 }
4176 }else{
4177 closest = 0;
4178 }
4179
4180 iPage = get4byte(&aData[8+closest*4]);
4181 if( !searchList || iPage==nearby ){
danielk1977ad0132d2008-06-07 08:58:22 +00004182 int nPage;
shane1f9e6aa2008-06-09 19:27:11 +00004183 *pPgno = iPage;
danielk1977ad0132d2008-06-07 08:58:22 +00004184 nPage = pagerPagecount(pBt->pPager);
4185 if( *pPgno>nPage ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004186 /* Free page off the end of the file */
danielk197743e377a2008-05-05 12:09:32 +00004187 rc = SQLITE_CORRUPT_BKPT;
4188 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004189 }
4190 TRACE(("ALLOCATE: %d was leaf %d of %d on trunk %d"
4191 ": %d more free pages\n",
4192 *pPgno, closest+1, k, pTrunk->pgno, n-1));
4193 if( closest<k-1 ){
4194 memcpy(&aData[8+closest*4], &aData[4+k*4], 4);
4195 }
4196 put4byte(&aData[4], k-1);
drh16a9b832007-05-05 18:39:25 +00004197 rc = sqlite3BtreeGetPage(pBt, *pPgno, ppPage, 1);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004198 if( rc==SQLITE_OK ){
drh538f5702007-04-13 02:14:30 +00004199 sqlite3PagerDontRollback((*ppPage)->pDbPage);
danielk19773b8a05f2007-03-19 17:44:26 +00004200 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00004201 if( rc!=SQLITE_OK ){
4202 releasePage(*ppPage);
4203 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004204 }
4205 searchList = 0;
4206 }
drhee696e22004-08-30 16:52:17 +00004207 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004208 releasePage(pPrevTrunk);
drhd3627af2006-12-18 18:34:51 +00004209 pPrevTrunk = 0;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004210 }while( searchList );
drh3b7511c2001-05-26 13:15:44 +00004211 }else{
drh3aac2dd2004-04-26 14:10:20 +00004212 /* There are no pages on the freelist, so create a new page at the
4213 ** end of the file */
danielk1977ad0132d2008-06-07 08:58:22 +00004214 int nPage = pagerPagecount(pBt->pPager);
4215 *pPgno = nPage + 1;
danielk1977afcdd022004-10-31 16:25:42 +00004216
4217#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00004218 if( pBt->nTrunc ){
4219 /* An incr-vacuum has already run within this transaction. So the
4220 ** page to allocate is not from the physical end of the file, but
4221 ** at pBt->nTrunc.
4222 */
4223 *pPgno = pBt->nTrunc+1;
4224 if( *pPgno==PENDING_BYTE_PAGE(pBt) ){
4225 (*pPgno)++;
4226 }
4227 }
danielk1977266664d2006-02-10 08:24:21 +00004228 if( pBt->autoVacuum && PTRMAP_ISPAGE(pBt, *pPgno) ){
danielk1977afcdd022004-10-31 16:25:42 +00004229 /* If *pPgno refers to a pointer-map page, allocate two new pages
4230 ** at the end of the file instead of one. The first allocated page
4231 ** becomes a new pointer-map page, the second is used by the caller.
4232 */
4233 TRACE(("ALLOCATE: %d from end of file (pointer-map page)\n", *pPgno));
danielk1977599fcba2004-11-08 07:13:13 +00004234 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
danielk1977afcdd022004-10-31 16:25:42 +00004235 (*pPgno)++;
drh72190432008-01-31 14:54:43 +00004236 if( *pPgno==PENDING_BYTE_PAGE(pBt) ){ (*pPgno)++; }
danielk1977afcdd022004-10-31 16:25:42 +00004237 }
danielk1977dddbcdc2007-04-26 14:42:34 +00004238 if( pBt->nTrunc ){
4239 pBt->nTrunc = *pPgno;
4240 }
danielk1977afcdd022004-10-31 16:25:42 +00004241#endif
4242
danielk1977599fcba2004-11-08 07:13:13 +00004243 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drh16a9b832007-05-05 18:39:25 +00004244 rc = sqlite3BtreeGetPage(pBt, *pPgno, ppPage, 0);
drh3b7511c2001-05-26 13:15:44 +00004245 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004246 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00004247 if( rc!=SQLITE_OK ){
4248 releasePage(*ppPage);
4249 }
drh3a4c1412004-05-09 20:40:11 +00004250 TRACE(("ALLOCATE: %d from end of file\n", *pPgno));
drh3b7511c2001-05-26 13:15:44 +00004251 }
danielk1977599fcba2004-11-08 07:13:13 +00004252
4253 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drhd3627af2006-12-18 18:34:51 +00004254
4255end_allocate_page:
4256 releasePage(pTrunk);
4257 releasePage(pPrevTrunk);
drh3b7511c2001-05-26 13:15:44 +00004258 return rc;
4259}
4260
4261/*
drh3aac2dd2004-04-26 14:10:20 +00004262** Add a page of the database file to the freelist.
drh5e2f8b92001-05-28 00:41:15 +00004263**
danielk19773b8a05f2007-03-19 17:44:26 +00004264** sqlite3PagerUnref() is NOT called for pPage.
drh3b7511c2001-05-26 13:15:44 +00004265*/
drh3aac2dd2004-04-26 14:10:20 +00004266static int freePage(MemPage *pPage){
danielk1977aef0bf62005-12-30 16:28:01 +00004267 BtShared *pBt = pPage->pBt;
drh3aac2dd2004-04-26 14:10:20 +00004268 MemPage *pPage1 = pBt->pPage1;
4269 int rc, n, k;
drh8b2f49b2001-06-08 00:21:52 +00004270
drh3aac2dd2004-04-26 14:10:20 +00004271 /* Prepare the page for freeing */
drh1fee73e2007-08-29 04:00:57 +00004272 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh3aac2dd2004-04-26 14:10:20 +00004273 assert( pPage->pgno>1 );
4274 pPage->isInit = 0;
4275 releasePage(pPage->pParent);
4276 pPage->pParent = 0;
4277
drha34b6762004-05-07 13:30:42 +00004278 /* Increment the free page count on pPage1 */
danielk19773b8a05f2007-03-19 17:44:26 +00004279 rc = sqlite3PagerWrite(pPage1->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00004280 if( rc ) return rc;
4281 n = get4byte(&pPage1->aData[36]);
4282 put4byte(&pPage1->aData[36], n+1);
4283
drhfcce93f2006-02-22 03:08:32 +00004284#ifdef SQLITE_SECURE_DELETE
4285 /* If the SQLITE_SECURE_DELETE compile-time option is enabled, then
4286 ** always fully overwrite deleted information with zeros.
4287 */
danielk19773b8a05f2007-03-19 17:44:26 +00004288 rc = sqlite3PagerWrite(pPage->pDbPage);
drhfcce93f2006-02-22 03:08:32 +00004289 if( rc ) return rc;
4290 memset(pPage->aData, 0, pPage->pBt->pageSize);
4291#endif
4292
danielk1977687566d2004-11-02 12:56:41 +00004293 /* If the database supports auto-vacuum, write an entry in the pointer-map
danielk1977cb1a7eb2004-11-05 12:27:02 +00004294 ** to indicate that the page is free.
danielk1977687566d2004-11-02 12:56:41 +00004295 */
danielk197785d90ca2008-07-19 14:25:15 +00004296 if( ISAUTOVACUUM ){
danielk1977687566d2004-11-02 12:56:41 +00004297 rc = ptrmapPut(pBt, pPage->pgno, PTRMAP_FREEPAGE, 0);
danielk1977a64a0352004-11-05 01:45:13 +00004298 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00004299 }
danielk1977687566d2004-11-02 12:56:41 +00004300
drh3aac2dd2004-04-26 14:10:20 +00004301 if( n==0 ){
4302 /* This is the first free page */
danielk19773b8a05f2007-03-19 17:44:26 +00004303 rc = sqlite3PagerWrite(pPage->pDbPage);
drhda200cc2004-05-09 11:51:38 +00004304 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00004305 memset(pPage->aData, 0, 8);
drha34b6762004-05-07 13:30:42 +00004306 put4byte(&pPage1->aData[32], pPage->pgno);
drh3a4c1412004-05-09 20:40:11 +00004307 TRACE(("FREE-PAGE: %d first\n", pPage->pgno));
drh3aac2dd2004-04-26 14:10:20 +00004308 }else{
4309 /* Other free pages already exist. Retrive the first trunk page
4310 ** of the freelist and find out how many leaves it has. */
drha34b6762004-05-07 13:30:42 +00004311 MemPage *pTrunk;
drh16a9b832007-05-05 18:39:25 +00004312 rc = sqlite3BtreeGetPage(pBt, get4byte(&pPage1->aData[32]), &pTrunk, 0);
drh3b7511c2001-05-26 13:15:44 +00004313 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00004314 k = get4byte(&pTrunk->aData[4]);
drhee696e22004-08-30 16:52:17 +00004315 if( k>=pBt->usableSize/4 - 8 ){
drh3aac2dd2004-04-26 14:10:20 +00004316 /* The trunk is full. Turn the page being freed into a new
drh45b1fac2008-07-04 17:52:42 +00004317 ** trunk page with no leaves.
4318 **
4319 ** Note that the trunk page is not really full until it contains
4320 ** usableSize/4 - 2 entries, not usableSize/4 - 8 entries as we have
4321 ** coded. But due to a coding error in versions of SQLite prior to
4322 ** 3.6.0, databases with freelist trunk pages holding more than
4323 ** usableSize/4 - 8 entries will be reported as corrupt. In order
4324 ** to maintain backwards compatibility with older versions of SQLite,
4325 ** we will contain to restrict the number of entries to usableSize/4 - 8
4326 ** for now. At some point in the future (once everyone has upgraded
4327 ** to 3.6.0 or later) we should consider fixing the conditional above
4328 ** to read "usableSize/4-2" instead of "usableSize/4-8".
4329 */
danielk19773b8a05f2007-03-19 17:44:26 +00004330 rc = sqlite3PagerWrite(pPage->pDbPage);
drhb9ee4932007-09-07 14:32:06 +00004331 if( rc==SQLITE_OK ){
4332 put4byte(pPage->aData, pTrunk->pgno);
4333 put4byte(&pPage->aData[4], 0);
4334 put4byte(&pPage1->aData[32], pPage->pgno);
4335 TRACE(("FREE-PAGE: %d new trunk page replacing %d\n",
4336 pPage->pgno, pTrunk->pgno));
4337 }
4338 }else if( k<0 ){
4339 rc = SQLITE_CORRUPT;
drh3aac2dd2004-04-26 14:10:20 +00004340 }else{
4341 /* Add the newly freed page as a leaf on the current trunk */
danielk19773b8a05f2007-03-19 17:44:26 +00004342 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhf5345442007-04-09 12:45:02 +00004343 if( rc==SQLITE_OK ){
4344 put4byte(&pTrunk->aData[4], k+1);
4345 put4byte(&pTrunk->aData[8+k*4], pPage->pgno);
drhfcce93f2006-02-22 03:08:32 +00004346#ifndef SQLITE_SECURE_DELETE
danielk1977a1fa00d2008-08-27 15:16:33 +00004347 rc = sqlite3PagerDontWrite(pPage->pDbPage);
drhfcce93f2006-02-22 03:08:32 +00004348#endif
drhf5345442007-04-09 12:45:02 +00004349 }
drh3a4c1412004-05-09 20:40:11 +00004350 TRACE(("FREE-PAGE: %d leaf on trunk page %d\n",pPage->pgno,pTrunk->pgno));
drh3aac2dd2004-04-26 14:10:20 +00004351 }
4352 releasePage(pTrunk);
drh3b7511c2001-05-26 13:15:44 +00004353 }
drh3b7511c2001-05-26 13:15:44 +00004354 return rc;
4355}
4356
4357/*
drh3aac2dd2004-04-26 14:10:20 +00004358** Free any overflow pages associated with the given Cell.
drh3b7511c2001-05-26 13:15:44 +00004359*/
drh3aac2dd2004-04-26 14:10:20 +00004360static int clearCell(MemPage *pPage, unsigned char *pCell){
danielk1977aef0bf62005-12-30 16:28:01 +00004361 BtShared *pBt = pPage->pBt;
drh6f11bef2004-05-13 01:12:56 +00004362 CellInfo info;
drh3aac2dd2004-04-26 14:10:20 +00004363 Pgno ovflPgno;
drh6f11bef2004-05-13 01:12:56 +00004364 int rc;
drh94440812007-03-06 11:42:19 +00004365 int nOvfl;
4366 int ovflPageSize;
drh3b7511c2001-05-26 13:15:44 +00004367
drh1fee73e2007-08-29 04:00:57 +00004368 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh16a9b832007-05-05 18:39:25 +00004369 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00004370 if( info.iOverflow==0 ){
drha34b6762004-05-07 13:30:42 +00004371 return SQLITE_OK; /* No overflow pages. Return without doing anything */
drh3aac2dd2004-04-26 14:10:20 +00004372 }
drh6f11bef2004-05-13 01:12:56 +00004373 ovflPgno = get4byte(&pCell[info.iOverflow]);
drh94440812007-03-06 11:42:19 +00004374 ovflPageSize = pBt->usableSize - 4;
drh72365832007-03-06 15:53:44 +00004375 nOvfl = (info.nPayload - info.nLocal + ovflPageSize - 1)/ovflPageSize;
4376 assert( ovflPgno==0 || nOvfl>0 );
4377 while( nOvfl-- ){
drh3aac2dd2004-04-26 14:10:20 +00004378 MemPage *pOvfl;
danielk1977ad0132d2008-06-07 08:58:22 +00004379 if( ovflPgno==0 || ovflPgno>pagerPagecount(pBt->pPager) ){
drh49285702005-09-17 15:20:26 +00004380 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00004381 }
danielk19778c0a9592007-04-30 16:55:00 +00004382
4383 rc = getOverflowPage(pBt, ovflPgno, &pOvfl, (nOvfl==0)?0:&ovflPgno);
drh3b7511c2001-05-26 13:15:44 +00004384 if( rc ) return rc;
drha34b6762004-05-07 13:30:42 +00004385 rc = freePage(pOvfl);
danielk19773b8a05f2007-03-19 17:44:26 +00004386 sqlite3PagerUnref(pOvfl->pDbPage);
danielk19776b456a22005-03-21 04:04:02 +00004387 if( rc ) return rc;
drh3b7511c2001-05-26 13:15:44 +00004388 }
drh5e2f8b92001-05-28 00:41:15 +00004389 return SQLITE_OK;
drh3b7511c2001-05-26 13:15:44 +00004390}
4391
4392/*
drh91025292004-05-03 19:49:32 +00004393** Create the byte sequence used to represent a cell on page pPage
4394** and write that byte sequence into pCell[]. Overflow pages are
4395** allocated and filled in as necessary. The calling procedure
4396** is responsible for making sure sufficient space has been allocated
4397** for pCell[].
4398**
4399** Note that pCell does not necessary need to point to the pPage->aData
4400** area. pCell might point to some temporary storage. The cell will
4401** be constructed in this temporary area then copied into pPage->aData
4402** later.
drh3b7511c2001-05-26 13:15:44 +00004403*/
4404static int fillInCell(
drh3aac2dd2004-04-26 14:10:20 +00004405 MemPage *pPage, /* The page that contains the cell */
drh4b70f112004-05-02 21:12:19 +00004406 unsigned char *pCell, /* Complete text of the cell */
drh4a1c3802004-05-12 15:15:47 +00004407 const void *pKey, i64 nKey, /* The key */
drh4b70f112004-05-02 21:12:19 +00004408 const void *pData,int nData, /* The data */
drhb026e052007-05-02 01:34:31 +00004409 int nZero, /* Extra zero bytes to append to pData */
drh4b70f112004-05-02 21:12:19 +00004410 int *pnSize /* Write cell size here */
drh3b7511c2001-05-26 13:15:44 +00004411){
drh3b7511c2001-05-26 13:15:44 +00004412 int nPayload;
drh8c6fa9b2004-05-26 00:01:53 +00004413 const u8 *pSrc;
drha34b6762004-05-07 13:30:42 +00004414 int nSrc, n, rc;
drh3aac2dd2004-04-26 14:10:20 +00004415 int spaceLeft;
4416 MemPage *pOvfl = 0;
drh9b171272004-05-08 02:03:22 +00004417 MemPage *pToRelease = 0;
drh3aac2dd2004-04-26 14:10:20 +00004418 unsigned char *pPrior;
4419 unsigned char *pPayload;
danielk1977aef0bf62005-12-30 16:28:01 +00004420 BtShared *pBt = pPage->pBt;
drh3aac2dd2004-04-26 14:10:20 +00004421 Pgno pgnoOvfl = 0;
drh4b70f112004-05-02 21:12:19 +00004422 int nHeader;
drh6f11bef2004-05-13 01:12:56 +00004423 CellInfo info;
drh3b7511c2001-05-26 13:15:44 +00004424
drh1fee73e2007-08-29 04:00:57 +00004425 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00004426
drh91025292004-05-03 19:49:32 +00004427 /* Fill in the header. */
drh43605152004-05-29 21:46:49 +00004428 nHeader = 0;
drh91025292004-05-03 19:49:32 +00004429 if( !pPage->leaf ){
4430 nHeader += 4;
4431 }
drh8b18dd42004-05-12 19:18:15 +00004432 if( pPage->hasData ){
drhb026e052007-05-02 01:34:31 +00004433 nHeader += putVarint(&pCell[nHeader], nData+nZero);
drh6f11bef2004-05-13 01:12:56 +00004434 }else{
drhb026e052007-05-02 01:34:31 +00004435 nData = nZero = 0;
drh91025292004-05-03 19:49:32 +00004436 }
drh6f11bef2004-05-13 01:12:56 +00004437 nHeader += putVarint(&pCell[nHeader], *(u64*)&nKey);
drh16a9b832007-05-05 18:39:25 +00004438 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00004439 assert( info.nHeader==nHeader );
4440 assert( info.nKey==nKey );
drhb026e052007-05-02 01:34:31 +00004441 assert( info.nData==nData+nZero );
drh6f11bef2004-05-13 01:12:56 +00004442
4443 /* Fill in the payload */
drhb026e052007-05-02 01:34:31 +00004444 nPayload = nData + nZero;
drh3aac2dd2004-04-26 14:10:20 +00004445 if( pPage->intKey ){
4446 pSrc = pData;
4447 nSrc = nData;
drh91025292004-05-03 19:49:32 +00004448 nData = 0;
drh3aac2dd2004-04-26 14:10:20 +00004449 }else{
4450 nPayload += nKey;
4451 pSrc = pKey;
4452 nSrc = nKey;
4453 }
drh6f11bef2004-05-13 01:12:56 +00004454 *pnSize = info.nSize;
4455 spaceLeft = info.nLocal;
drh3aac2dd2004-04-26 14:10:20 +00004456 pPayload = &pCell[nHeader];
drh6f11bef2004-05-13 01:12:56 +00004457 pPrior = &pCell[info.iOverflow];
drh3b7511c2001-05-26 13:15:44 +00004458
drh3b7511c2001-05-26 13:15:44 +00004459 while( nPayload>0 ){
4460 if( spaceLeft==0 ){
danielk1977b39f70b2007-05-17 18:28:11 +00004461 int isExact = 0;
danielk1977afcdd022004-10-31 16:25:42 +00004462#ifndef SQLITE_OMIT_AUTOVACUUM
4463 Pgno pgnoPtrmap = pgnoOvfl; /* Overflow page pointer-map entry page */
danielk1977b39f70b2007-05-17 18:28:11 +00004464 if( pBt->autoVacuum ){
4465 do{
4466 pgnoOvfl++;
4467 } while(
4468 PTRMAP_ISPAGE(pBt, pgnoOvfl) || pgnoOvfl==PENDING_BYTE_PAGE(pBt)
4469 );
danielk197789a4be82007-05-23 13:34:32 +00004470 if( pgnoOvfl>1 ){
danielk1977b39f70b2007-05-17 18:28:11 +00004471 /* isExact = 1; */
4472 }
4473 }
danielk1977afcdd022004-10-31 16:25:42 +00004474#endif
danielk1977b39f70b2007-05-17 18:28:11 +00004475 rc = allocateBtreePage(pBt, &pOvfl, &pgnoOvfl, pgnoOvfl, isExact);
danielk1977afcdd022004-10-31 16:25:42 +00004476#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977a19df672004-11-03 11:37:07 +00004477 /* If the database supports auto-vacuum, and the second or subsequent
4478 ** overflow page is being allocated, add an entry to the pointer-map
danielk19774ef24492007-05-23 09:52:41 +00004479 ** for that page now.
4480 **
4481 ** If this is the first overflow page, then write a partial entry
4482 ** to the pointer-map. If we write nothing to this pointer-map slot,
4483 ** then the optimistic overflow chain processing in clearCell()
4484 ** may misinterpret the uninitialised values and delete the
4485 ** wrong pages from the database.
danielk1977afcdd022004-10-31 16:25:42 +00004486 */
danielk19774ef24492007-05-23 09:52:41 +00004487 if( pBt->autoVacuum && rc==SQLITE_OK ){
4488 u8 eType = (pgnoPtrmap?PTRMAP_OVERFLOW2:PTRMAP_OVERFLOW1);
4489 rc = ptrmapPut(pBt, pgnoOvfl, eType, pgnoPtrmap);
danielk197789a4be82007-05-23 13:34:32 +00004490 if( rc ){
4491 releasePage(pOvfl);
4492 }
danielk1977afcdd022004-10-31 16:25:42 +00004493 }
4494#endif
drh3b7511c2001-05-26 13:15:44 +00004495 if( rc ){
drh9b171272004-05-08 02:03:22 +00004496 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00004497 return rc;
4498 }
drh3aac2dd2004-04-26 14:10:20 +00004499 put4byte(pPrior, pgnoOvfl);
drh9b171272004-05-08 02:03:22 +00004500 releasePage(pToRelease);
4501 pToRelease = pOvfl;
drh3aac2dd2004-04-26 14:10:20 +00004502 pPrior = pOvfl->aData;
4503 put4byte(pPrior, 0);
4504 pPayload = &pOvfl->aData[4];
drhb6f41482004-05-14 01:58:11 +00004505 spaceLeft = pBt->usableSize - 4;
drh3b7511c2001-05-26 13:15:44 +00004506 }
4507 n = nPayload;
4508 if( n>spaceLeft ) n = spaceLeft;
drhb026e052007-05-02 01:34:31 +00004509 if( nSrc>0 ){
4510 if( n>nSrc ) n = nSrc;
4511 assert( pSrc );
4512 memcpy(pPayload, pSrc, n);
4513 }else{
4514 memset(pPayload, 0, n);
4515 }
drh3b7511c2001-05-26 13:15:44 +00004516 nPayload -= n;
drhde647132004-05-07 17:57:49 +00004517 pPayload += n;
drh9b171272004-05-08 02:03:22 +00004518 pSrc += n;
drh3aac2dd2004-04-26 14:10:20 +00004519 nSrc -= n;
drh3b7511c2001-05-26 13:15:44 +00004520 spaceLeft -= n;
drh3aac2dd2004-04-26 14:10:20 +00004521 if( nSrc==0 ){
4522 nSrc = nData;
4523 pSrc = pData;
4524 }
drhdd793422001-06-28 01:54:48 +00004525 }
drh9b171272004-05-08 02:03:22 +00004526 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00004527 return SQLITE_OK;
4528}
4529
danielk1977f328bea2008-08-02 17:03:31 +00004530
drh3b7511c2001-05-26 13:15:44 +00004531/*
drhbd03cae2001-06-02 02:40:57 +00004532** Change the MemPage.pParent pointer on the page whose number is
drh8b2f49b2001-06-08 00:21:52 +00004533** given in the second argument so that MemPage.pParent holds the
drhbd03cae2001-06-02 02:40:57 +00004534** pointer in the third argument.
danielk197787c52b52008-07-19 11:49:07 +00004535**
4536** If the final argument, updatePtrmap, is non-zero and the database
4537** is an auto-vacuum database, then the pointer-map entry for pgno
4538** is updated.
drhbd03cae2001-06-02 02:40:57 +00004539*/
danielk197787c52b52008-07-19 11:49:07 +00004540static int reparentPage(
4541 BtShared *pBt, /* B-Tree structure */
4542 Pgno pgno, /* Page number of child being adopted */
4543 MemPage *pNewParent, /* New parent of pgno */
4544 int idx, /* Index of child page pgno in pNewParent */
4545 int updatePtrmap /* If true, update pointer-map for pgno */
4546){
drhbd03cae2001-06-02 02:40:57 +00004547 MemPage *pThis;
danielk19773b8a05f2007-03-19 17:44:26 +00004548 DbPage *pDbPage;
drhbd03cae2001-06-02 02:40:57 +00004549
drh1fee73e2007-08-29 04:00:57 +00004550 assert( sqlite3_mutex_held(pBt->mutex) );
drh43617e92006-03-06 20:55:46 +00004551 assert( pNewParent!=0 );
danielk1977afcdd022004-10-31 16:25:42 +00004552 if( pgno==0 ) return SQLITE_OK;
drh4b70f112004-05-02 21:12:19 +00004553 assert( pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00004554 pDbPage = sqlite3PagerLookup(pBt->pPager, pgno);
4555 if( pDbPage ){
4556 pThis = (MemPage *)sqlite3PagerGetExtra(pDbPage);
drhda200cc2004-05-09 11:51:38 +00004557 if( pThis->isInit ){
drhbf4bca52007-09-06 22:19:14 +00004558 assert( pThis->aData==sqlite3PagerGetData(pDbPage) );
drhda200cc2004-05-09 11:51:38 +00004559 if( pThis->pParent!=pNewParent ){
danielk19773b8a05f2007-03-19 17:44:26 +00004560 if( pThis->pParent ) sqlite3PagerUnref(pThis->pParent->pDbPage);
drhda200cc2004-05-09 11:51:38 +00004561 pThis->pParent = pNewParent;
danielk19773b8a05f2007-03-19 17:44:26 +00004562 sqlite3PagerRef(pNewParent->pDbPage);
drhda200cc2004-05-09 11:51:38 +00004563 }
4564 pThis->idxParent = idx;
drhdd793422001-06-28 01:54:48 +00004565 }
danielk19773b8a05f2007-03-19 17:44:26 +00004566 sqlite3PagerUnref(pDbPage);
drhbd03cae2001-06-02 02:40:57 +00004567 }
danielk1977afcdd022004-10-31 16:25:42 +00004568
danielk197785d90ca2008-07-19 14:25:15 +00004569 if( ISAUTOVACUUM && updatePtrmap ){
danielk1977afcdd022004-10-31 16:25:42 +00004570 return ptrmapPut(pBt, pgno, PTRMAP_BTREE, pNewParent->pgno);
4571 }
danielk197787c52b52008-07-19 11:49:07 +00004572
4573#ifndef NDEBUG
4574 /* If the updatePtrmap flag was clear, assert that the entry in the
4575 ** pointer-map is already correct.
4576 */
danielk1977a68468f2008-08-02 17:36:45 +00004577 if( ISAUTOVACUUM ){
4578 pDbPage = sqlite3PagerLookup(pBt->pPager,PTRMAP_PAGENO(pBt,pgno));
4579 if( pDbPage ){
4580 u8 eType;
4581 Pgno ii;
4582 int rc = ptrmapGet(pBt, pgno, &eType, &ii);
4583 assert( rc==SQLITE_OK && ii==pNewParent->pgno && eType==PTRMAP_BTREE );
4584 sqlite3PagerUnref(pDbPage);
4585 }
danielk197787c52b52008-07-19 11:49:07 +00004586 }
4587#endif
4588
danielk1977afcdd022004-10-31 16:25:42 +00004589 return SQLITE_OK;
drhbd03cae2001-06-02 02:40:57 +00004590}
4591
danielk1977ac11ee62005-01-15 12:45:51 +00004592
4593
drhbd03cae2001-06-02 02:40:57 +00004594/*
drh4b70f112004-05-02 21:12:19 +00004595** Change the pParent pointer of all children of pPage to point back
4596** to pPage.
4597**
drhbd03cae2001-06-02 02:40:57 +00004598** In other words, for every child of pPage, invoke reparentPage()
drh5e00f6c2001-09-13 13:46:56 +00004599** to make sure that each child knows that pPage is its parent.
drhbd03cae2001-06-02 02:40:57 +00004600**
4601** This routine gets called after you memcpy() one page into
4602** another.
danielk197787c52b52008-07-19 11:49:07 +00004603**
4604** If updatePtrmap is true, then the pointer-map entries for all child
4605** pages of pPage are updated.
drhbd03cae2001-06-02 02:40:57 +00004606*/
danielk197787c52b52008-07-19 11:49:07 +00004607static int reparentChildPages(MemPage *pPage, int updatePtrmap){
danielk1977afcdd022004-10-31 16:25:42 +00004608 int rc = SQLITE_OK;
drh1fee73e2007-08-29 04:00:57 +00004609 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk197787c52b52008-07-19 11:49:07 +00004610 if( !pPage->leaf ){
4611 int i;
4612 BtShared *pBt = pPage->pBt;
4613 Pgno iRight = get4byte(&pPage->aData[pPage->hdrOffset+8]);
danielk1977afcdd022004-10-31 16:25:42 +00004614
danielk197787c52b52008-07-19 11:49:07 +00004615 for(i=0; i<pPage->nCell; i++){
4616 u8 *pCell = findCell(pPage, i);
4617 rc = reparentPage(pBt, get4byte(pCell), pPage, i, updatePtrmap);
4618 if( rc!=SQLITE_OK ) return rc;
4619 }
4620 rc = reparentPage(pBt, iRight, pPage, i, updatePtrmap);
4621 pPage->idxShift = 0;
drhbd03cae2001-06-02 02:40:57 +00004622 }
danielk1977afcdd022004-10-31 16:25:42 +00004623 return rc;
drh14acc042001-06-10 19:56:58 +00004624}
4625
4626/*
4627** Remove the i-th cell from pPage. This routine effects pPage only.
4628** The cell content is not freed or deallocated. It is assumed that
4629** the cell content has been copied someplace else. This routine just
4630** removes the reference to the cell from pPage.
4631**
4632** "sz" must be the number of bytes in the cell.
drh14acc042001-06-10 19:56:58 +00004633*/
drh4b70f112004-05-02 21:12:19 +00004634static void dropCell(MemPage *pPage, int idx, int sz){
drh43605152004-05-29 21:46:49 +00004635 int i; /* Loop counter */
4636 int pc; /* Offset to cell content of cell being deleted */
4637 u8 *data; /* pPage->aData */
4638 u8 *ptr; /* Used to move bytes around within data[] */
4639
drh8c42ca92001-06-22 19:15:00 +00004640 assert( idx>=0 && idx<pPage->nCell );
drh43605152004-05-29 21:46:49 +00004641 assert( sz==cellSize(pPage, idx) );
danielk19773b8a05f2007-03-19 17:44:26 +00004642 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00004643 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhda200cc2004-05-09 11:51:38 +00004644 data = pPage->aData;
drh43605152004-05-29 21:46:49 +00004645 ptr = &data[pPage->cellOffset + 2*idx];
4646 pc = get2byte(ptr);
4647 assert( pc>10 && pc+sz<=pPage->pBt->usableSize );
drhde647132004-05-07 17:57:49 +00004648 freeSpace(pPage, pc, sz);
drh43605152004-05-29 21:46:49 +00004649 for(i=idx+1; i<pPage->nCell; i++, ptr+=2){
4650 ptr[0] = ptr[2];
4651 ptr[1] = ptr[3];
drh14acc042001-06-10 19:56:58 +00004652 }
4653 pPage->nCell--;
drh43605152004-05-29 21:46:49 +00004654 put2byte(&data[pPage->hdrOffset+3], pPage->nCell);
4655 pPage->nFree += 2;
drh428ae8c2003-01-04 16:48:09 +00004656 pPage->idxShift = 1;
drh14acc042001-06-10 19:56:58 +00004657}
4658
4659/*
4660** Insert a new cell on pPage at cell index "i". pCell points to the
4661** content of the cell.
4662**
4663** If the cell content will fit on the page, then put it there. If it
drh43605152004-05-29 21:46:49 +00004664** will not fit, then make a copy of the cell content into pTemp if
4665** pTemp is not null. Regardless of pTemp, allocate a new entry
4666** in pPage->aOvfl[] and make it point to the cell content (either
4667** in pTemp or the original pCell) and also record its index.
4668** Allocating a new entry in pPage->aCell[] implies that
4669** pPage->nOverflow is incremented.
danielk1977a3ad5e72005-01-07 08:56:44 +00004670**
4671** If nSkip is non-zero, then do not copy the first nSkip bytes of the
4672** cell. The caller will overwrite them after this function returns. If
drh4b238df2005-01-08 15:43:18 +00004673** nSkip is non-zero, then pCell may not point to an invalid memory location
danielk1977a3ad5e72005-01-07 08:56:44 +00004674** (but pCell+nSkip is always valid).
drh14acc042001-06-10 19:56:58 +00004675*/
danielk1977e80463b2004-11-03 03:01:16 +00004676static int insertCell(
drh24cd67e2004-05-10 16:18:47 +00004677 MemPage *pPage, /* Page into which we are copying */
drh43605152004-05-29 21:46:49 +00004678 int i, /* New cell becomes the i-th cell of the page */
4679 u8 *pCell, /* Content of the new cell */
4680 int sz, /* Bytes of content in pCell */
danielk1977a3ad5e72005-01-07 08:56:44 +00004681 u8 *pTemp, /* Temp storage space for pCell, if needed */
4682 u8 nSkip /* Do not write the first nSkip bytes of the cell */
drh24cd67e2004-05-10 16:18:47 +00004683){
drh43605152004-05-29 21:46:49 +00004684 int idx; /* Where to write new cell content in data[] */
4685 int j; /* Loop counter */
4686 int top; /* First byte of content for any cell in data[] */
4687 int end; /* First byte past the last cell pointer in data[] */
4688 int ins; /* Index in data[] where new cell pointer is inserted */
4689 int hdr; /* Offset into data[] of the page header */
4690 int cellOffset; /* Address of first cell pointer in data[] */
4691 u8 *data; /* The content of the whole page */
4692 u8 *ptr; /* Used for moving information around in data[] */
4693
4694 assert( i>=0 && i<=pPage->nCell+pPage->nOverflow );
4695 assert( sz==cellSizePtr(pPage, pCell) );
drh1fee73e2007-08-29 04:00:57 +00004696 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh43605152004-05-29 21:46:49 +00004697 if( pPage->nOverflow || sz+2>pPage->nFree ){
drh24cd67e2004-05-10 16:18:47 +00004698 if( pTemp ){
danielk1977a3ad5e72005-01-07 08:56:44 +00004699 memcpy(pTemp+nSkip, pCell+nSkip, sz-nSkip);
drh43605152004-05-29 21:46:49 +00004700 pCell = pTemp;
drh24cd67e2004-05-10 16:18:47 +00004701 }
drh43605152004-05-29 21:46:49 +00004702 j = pPage->nOverflow++;
4703 assert( j<sizeof(pPage->aOvfl)/sizeof(pPage->aOvfl[0]) );
4704 pPage->aOvfl[j].pCell = pCell;
4705 pPage->aOvfl[j].idx = i;
4706 pPage->nFree = 0;
drh14acc042001-06-10 19:56:58 +00004707 }else{
danielk19776e465eb2007-08-21 13:11:00 +00004708 int rc = sqlite3PagerWrite(pPage->pDbPage);
4709 if( rc!=SQLITE_OK ){
4710 return rc;
4711 }
4712 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh43605152004-05-29 21:46:49 +00004713 data = pPage->aData;
4714 hdr = pPage->hdrOffset;
4715 top = get2byte(&data[hdr+5]);
4716 cellOffset = pPage->cellOffset;
4717 end = cellOffset + 2*pPage->nCell + 2;
4718 ins = cellOffset + 2*i;
4719 if( end > top - sz ){
danielk1977474b7cc2008-07-09 11:49:46 +00004720 defragmentPage(pPage);
drh43605152004-05-29 21:46:49 +00004721 top = get2byte(&data[hdr+5]);
4722 assert( end + sz <= top );
4723 }
4724 idx = allocateSpace(pPage, sz);
4725 assert( idx>0 );
4726 assert( end <= get2byte(&data[hdr+5]) );
4727 pPage->nCell++;
4728 pPage->nFree -= 2;
danielk1977a3ad5e72005-01-07 08:56:44 +00004729 memcpy(&data[idx+nSkip], pCell+nSkip, sz-nSkip);
drh43605152004-05-29 21:46:49 +00004730 for(j=end-2, ptr=&data[j]; j>ins; j-=2, ptr-=2){
4731 ptr[0] = ptr[-2];
4732 ptr[1] = ptr[-1];
drhda200cc2004-05-09 11:51:38 +00004733 }
drh43605152004-05-29 21:46:49 +00004734 put2byte(&data[ins], idx);
4735 put2byte(&data[hdr+3], pPage->nCell);
4736 pPage->idxShift = 1;
danielk1977a19df672004-11-03 11:37:07 +00004737#ifndef SQLITE_OMIT_AUTOVACUUM
4738 if( pPage->pBt->autoVacuum ){
4739 /* The cell may contain a pointer to an overflow page. If so, write
4740 ** the entry for the overflow page into the pointer map.
4741 */
4742 CellInfo info;
drh16a9b832007-05-05 18:39:25 +00004743 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh72365832007-03-06 15:53:44 +00004744 assert( (info.nData+(pPage->intKey?0:info.nKey))==info.nPayload );
danielk1977a19df672004-11-03 11:37:07 +00004745 if( (info.nData+(pPage->intKey?0:info.nKey))>info.nLocal ){
4746 Pgno pgnoOvfl = get4byte(&pCell[info.iOverflow]);
danielk19776e465eb2007-08-21 13:11:00 +00004747 rc = ptrmapPut(pPage->pBt, pgnoOvfl, PTRMAP_OVERFLOW1, pPage->pgno);
danielk1977a19df672004-11-03 11:37:07 +00004748 if( rc!=SQLITE_OK ) return rc;
4749 }
4750 }
4751#endif
drh14acc042001-06-10 19:56:58 +00004752 }
danielk1977e80463b2004-11-03 03:01:16 +00004753
danielk1977e80463b2004-11-03 03:01:16 +00004754 return SQLITE_OK;
drh14acc042001-06-10 19:56:58 +00004755}
4756
4757/*
drhfa1a98a2004-05-14 19:08:17 +00004758** Add a list of cells to a page. The page should be initially empty.
4759** The cells are guaranteed to fit on the page.
4760*/
4761static void assemblePage(
4762 MemPage *pPage, /* The page to be assemblied */
4763 int nCell, /* The number of cells to add to this page */
drh43605152004-05-29 21:46:49 +00004764 u8 **apCell, /* Pointers to cell bodies */
drha9121e42008-02-19 14:59:35 +00004765 u16 *aSize /* Sizes of the cells */
drhfa1a98a2004-05-14 19:08:17 +00004766){
4767 int i; /* Loop counter */
4768 int totalSize; /* Total size of all cells */
4769 int hdr; /* Index of page header */
drh43605152004-05-29 21:46:49 +00004770 int cellptr; /* Address of next cell pointer */
4771 int cellbody; /* Address of next cell body */
drhfa1a98a2004-05-14 19:08:17 +00004772 u8 *data; /* Data for the page */
4773
drh43605152004-05-29 21:46:49 +00004774 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +00004775 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhfa1a98a2004-05-14 19:08:17 +00004776 totalSize = 0;
4777 for(i=0; i<nCell; i++){
4778 totalSize += aSize[i];
4779 }
drh43605152004-05-29 21:46:49 +00004780 assert( totalSize+2*nCell<=pPage->nFree );
drhfa1a98a2004-05-14 19:08:17 +00004781 assert( pPage->nCell==0 );
drh43605152004-05-29 21:46:49 +00004782 cellptr = pPage->cellOffset;
drhfa1a98a2004-05-14 19:08:17 +00004783 data = pPage->aData;
4784 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +00004785 put2byte(&data[hdr+3], nCell);
drh09d0deb2005-08-02 17:13:09 +00004786 if( nCell ){
4787 cellbody = allocateSpace(pPage, totalSize);
4788 assert( cellbody>0 );
4789 assert( pPage->nFree >= 2*nCell );
4790 pPage->nFree -= 2*nCell;
4791 for(i=0; i<nCell; i++){
4792 put2byte(&data[cellptr], cellbody);
4793 memcpy(&data[cellbody], apCell[i], aSize[i]);
4794 cellptr += 2;
4795 cellbody += aSize[i];
4796 }
4797 assert( cellbody==pPage->pBt->usableSize );
drhfa1a98a2004-05-14 19:08:17 +00004798 }
4799 pPage->nCell = nCell;
drhfa1a98a2004-05-14 19:08:17 +00004800}
4801
drh14acc042001-06-10 19:56:58 +00004802/*
drhc3b70572003-01-04 19:44:07 +00004803** The following parameters determine how many adjacent pages get involved
4804** in a balancing operation. NN is the number of neighbors on either side
4805** of the page that participate in the balancing operation. NB is the
4806** total number of pages that participate, including the target page and
4807** NN neighbors on either side.
4808**
4809** The minimum value of NN is 1 (of course). Increasing NN above 1
4810** (to 2 or 3) gives a modest improvement in SELECT and DELETE performance
4811** in exchange for a larger degradation in INSERT and UPDATE performance.
4812** The value of NN appears to give the best results overall.
4813*/
4814#define NN 1 /* Number of neighbors on either side of pPage */
4815#define NB (NN*2+1) /* Total pages involved in the balance */
4816
drh43605152004-05-29 21:46:49 +00004817/* Forward reference */
danielk1977ac245ec2005-01-14 13:50:11 +00004818static int balance(MemPage*, int);
4819
drh615ae552005-01-16 23:21:00 +00004820#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00004821/*
4822** This version of balance() handles the common special case where
4823** a new entry is being inserted on the extreme right-end of the
4824** tree, in other words, when the new entry will become the largest
4825** entry in the tree.
4826**
4827** Instead of trying balance the 3 right-most leaf pages, just add
4828** a new page to the right-hand side and put the one new entry in
4829** that page. This leaves the right side of the tree somewhat
4830** unbalanced. But odds are that we will be inserting new entries
4831** at the end soon afterwards so the nearly empty page will quickly
4832** fill up. On average.
4833**
4834** pPage is the leaf page which is the right-most page in the tree.
4835** pParent is its parent. pPage must have a single overflow entry
4836** which is also the right-most entry on the page.
4837*/
danielk1977ac245ec2005-01-14 13:50:11 +00004838static int balance_quick(MemPage *pPage, MemPage *pParent){
4839 int rc;
4840 MemPage *pNew;
4841 Pgno pgnoNew;
4842 u8 *pCell;
drha9121e42008-02-19 14:59:35 +00004843 u16 szCell;
danielk1977ac245ec2005-01-14 13:50:11 +00004844 CellInfo info;
danielk1977aef0bf62005-12-30 16:28:01 +00004845 BtShared *pBt = pPage->pBt;
danielk197779a40da2005-01-16 08:00:01 +00004846 int parentIdx = pParent->nCell; /* pParent new divider cell index */
4847 int parentSize; /* Size of new divider cell */
4848 u8 parentCell[64]; /* Space for the new divider cell */
danielk1977ac245ec2005-01-14 13:50:11 +00004849
drh1fee73e2007-08-29 04:00:57 +00004850 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00004851
danielk1977ac245ec2005-01-14 13:50:11 +00004852 /* Allocate a new page. Insert the overflow cell from pPage
4853 ** into it. Then remove the overflow cell from pPage.
4854 */
drh4f0c5872007-03-26 22:05:01 +00004855 rc = allocateBtreePage(pBt, &pNew, &pgnoNew, 0, 0);
danielk1977ac245ec2005-01-14 13:50:11 +00004856 if( rc!=SQLITE_OK ){
4857 return rc;
4858 }
4859 pCell = pPage->aOvfl[0].pCell;
4860 szCell = cellSizePtr(pPage, pCell);
4861 zeroPage(pNew, pPage->aData[0]);
4862 assemblePage(pNew, 1, &pCell, &szCell);
4863 pPage->nOverflow = 0;
4864
danielk197779a40da2005-01-16 08:00:01 +00004865 /* Set the parent of the newly allocated page to pParent. */
4866 pNew->pParent = pParent;
danielk19773b8a05f2007-03-19 17:44:26 +00004867 sqlite3PagerRef(pParent->pDbPage);
danielk197779a40da2005-01-16 08:00:01 +00004868
danielk1977ac245ec2005-01-14 13:50:11 +00004869 /* pPage is currently the right-child of pParent. Change this
4870 ** so that the right-child is the new page allocated above and
danielk197779a40da2005-01-16 08:00:01 +00004871 ** pPage is the next-to-right child.
danielk1977474b7cc2008-07-09 11:49:46 +00004872 **
4873 ** Ignore the return value of the call to fillInCell(). fillInCell()
4874 ** may only return other than SQLITE_OK if it is required to allocate
4875 ** one or more overflow pages. Since an internal table B-Tree cell
4876 ** may never spill over onto an overflow page (it is a maximum of
4877 ** 13 bytes in size), it is not neccessary to check the return code.
4878 **
4879 ** Similarly, the insertCell() function cannot fail if the page
4880 ** being inserted into is already writable and the cell does not
4881 ** contain an overflow pointer. So ignore this return code too.
danielk1977ac245ec2005-01-14 13:50:11 +00004882 */
danielk1977ac11ee62005-01-15 12:45:51 +00004883 assert( pPage->nCell>0 );
danielk19771cc5ed82007-05-16 17:28:43 +00004884 pCell = findCell(pPage, pPage->nCell-1);
drh16a9b832007-05-05 18:39:25 +00004885 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
danielk1977474b7cc2008-07-09 11:49:46 +00004886 fillInCell(pParent, parentCell, 0, info.nKey, 0, 0, 0, &parentSize);
danielk1977ac245ec2005-01-14 13:50:11 +00004887 assert( parentSize<64 );
danielk1977474b7cc2008-07-09 11:49:46 +00004888 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
4889 insertCell(pParent, parentIdx, parentCell, parentSize, 0, 4);
danielk1977ac245ec2005-01-14 13:50:11 +00004890 put4byte(findOverflowCell(pParent,parentIdx), pPage->pgno);
4891 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew);
4892
danielk197779a40da2005-01-16 08:00:01 +00004893 /* If this is an auto-vacuum database, update the pointer map
4894 ** with entries for the new page, and any pointer from the
4895 ** cell on the page to an overflow page.
4896 */
danielk197785d90ca2008-07-19 14:25:15 +00004897 if( ISAUTOVACUUM ){
danielk1977ac11ee62005-01-15 12:45:51 +00004898 rc = ptrmapPut(pBt, pgnoNew, PTRMAP_BTREE, pParent->pgno);
danielk1977deb403e2007-05-24 09:20:16 +00004899 if( rc==SQLITE_OK ){
4900 rc = ptrmapPutOvfl(pNew, 0);
danielk1977ac11ee62005-01-15 12:45:51 +00004901 }
danielk197779a40da2005-01-16 08:00:01 +00004902 if( rc!=SQLITE_OK ){
danielk1977deb403e2007-05-24 09:20:16 +00004903 releasePage(pNew);
danielk197779a40da2005-01-16 08:00:01 +00004904 return rc;
danielk1977ac11ee62005-01-15 12:45:51 +00004905 }
4906 }
4907
danielk197779a40da2005-01-16 08:00:01 +00004908 /* Release the reference to the new page and balance the parent page,
4909 ** in case the divider cell inserted caused it to become overfull.
4910 */
danielk1977ac245ec2005-01-14 13:50:11 +00004911 releasePage(pNew);
4912 return balance(pParent, 0);
4913}
drh615ae552005-01-16 23:21:00 +00004914#endif /* SQLITE_OMIT_QUICKBALANCE */
drh43605152004-05-29 21:46:49 +00004915
drhc3b70572003-01-04 19:44:07 +00004916/*
drhab01f612004-05-22 02:55:23 +00004917** This routine redistributes Cells on pPage and up to NN*2 siblings
drh8b2f49b2001-06-08 00:21:52 +00004918** of pPage so that all pages have about the same amount of free space.
drh0c6cc4e2004-06-15 02:13:26 +00004919** Usually NN siblings on either side of pPage is used in the balancing,
4920** though more siblings might come from one side if pPage is the first
drhab01f612004-05-22 02:55:23 +00004921** or last child of its parent. If pPage has fewer than 2*NN siblings
drh8b2f49b2001-06-08 00:21:52 +00004922** (something which can only happen if pPage is the root page or a
drh14acc042001-06-10 19:56:58 +00004923** child of root) then all available siblings participate in the balancing.
drh8b2f49b2001-06-08 00:21:52 +00004924**
drh0c6cc4e2004-06-15 02:13:26 +00004925** The number of siblings of pPage might be increased or decreased by one or
4926** two in an effort to keep pages nearly full but not over full. The root page
drhab01f612004-05-22 02:55:23 +00004927** is special and is allowed to be nearly empty. If pPage is
drh8c42ca92001-06-22 19:15:00 +00004928** the root page, then the depth of the tree might be increased
drh8b2f49b2001-06-08 00:21:52 +00004929** or decreased by one, as necessary, to keep the root page from being
drhab01f612004-05-22 02:55:23 +00004930** overfull or completely empty.
drh14acc042001-06-10 19:56:58 +00004931**
drh8b2f49b2001-06-08 00:21:52 +00004932** Note that when this routine is called, some of the Cells on pPage
drh4b70f112004-05-02 21:12:19 +00004933** might not actually be stored in pPage->aData[]. This can happen
drh8b2f49b2001-06-08 00:21:52 +00004934** if the page is overfull. Part of the job of this routine is to
drh4b70f112004-05-02 21:12:19 +00004935** make sure all Cells for pPage once again fit in pPage->aData[].
drh14acc042001-06-10 19:56:58 +00004936**
drh8c42ca92001-06-22 19:15:00 +00004937** In the course of balancing the siblings of pPage, the parent of pPage
4938** might become overfull or underfull. If that happens, then this routine
4939** is called recursively on the parent.
4940**
drh5e00f6c2001-09-13 13:46:56 +00004941** If this routine fails for any reason, it might leave the database
4942** in a corrupted state. So if this routine fails, the database should
4943** be rolled back.
drh8b2f49b2001-06-08 00:21:52 +00004944*/
drh43605152004-05-29 21:46:49 +00004945static int balance_nonroot(MemPage *pPage){
drh8b2f49b2001-06-08 00:21:52 +00004946 MemPage *pParent; /* The parent of pPage */
drh16a9b832007-05-05 18:39:25 +00004947 BtShared *pBt; /* The whole database */
danielk1977634f2982005-03-28 08:44:07 +00004948 int nCell = 0; /* Number of cells in apCell[] */
4949 int nMaxCells = 0; /* Allocated size of apCell, szCell, aFrom. */
drh8b2f49b2001-06-08 00:21:52 +00004950 int nOld; /* Number of pages in apOld[] */
4951 int nNew; /* Number of pages in apNew[] */
drh8b2f49b2001-06-08 00:21:52 +00004952 int nDiv; /* Number of cells in apDiv[] */
drh14acc042001-06-10 19:56:58 +00004953 int i, j, k; /* Loop counters */
drha34b6762004-05-07 13:30:42 +00004954 int idx; /* Index of pPage in pParent->aCell[] */
4955 int nxDiv; /* Next divider slot in pParent->aCell[] */
drh14acc042001-06-10 19:56:58 +00004956 int rc; /* The return code */
drh91025292004-05-03 19:49:32 +00004957 int leafCorrection; /* 4 if pPage is a leaf. 0 if not */
drh8b18dd42004-05-12 19:18:15 +00004958 int leafData; /* True if pPage is a leaf of a LEAFDATA tree */
drh91025292004-05-03 19:49:32 +00004959 int usableSpace; /* Bytes in pPage beyond the header */
4960 int pageFlags; /* Value of pPage->aData[0] */
drh6019e162001-07-02 17:51:45 +00004961 int subtotal; /* Subtotal of bytes in cells on one page */
drhe5ae5732008-06-15 02:51:47 +00004962 int iSpace1 = 0; /* First unused byte of aSpace1[] */
4963 int iSpace2 = 0; /* First unused byte of aSpace2[] */
drhfacf0302008-06-17 15:12:00 +00004964 int szScratch; /* Size of scratch memory requested */
drhc3b70572003-01-04 19:44:07 +00004965 MemPage *apOld[NB]; /* pPage and up to two siblings */
4966 Pgno pgnoOld[NB]; /* Page numbers for each page in apOld[] */
drh4b70f112004-05-02 21:12:19 +00004967 MemPage *apCopy[NB]; /* Private copies of apOld[] pages */
drha2fce642004-06-05 00:01:44 +00004968 MemPage *apNew[NB+2]; /* pPage and up to NB siblings after balancing */
4969 Pgno pgnoNew[NB+2]; /* Page numbers for each page in apNew[] */
drh4b70f112004-05-02 21:12:19 +00004970 u8 *apDiv[NB]; /* Divider cells in pParent */
drha2fce642004-06-05 00:01:44 +00004971 int cntNew[NB+2]; /* Index in aCell[] of cell after i-th page */
4972 int szNew[NB+2]; /* Combined size of cells place on i-th page */
danielk197750f059b2005-03-29 02:54:03 +00004973 u8 **apCell = 0; /* All cells begin balanced */
drha9121e42008-02-19 14:59:35 +00004974 u16 *szCell; /* Local size of all cells in apCell[] */
drhe5ae5732008-06-15 02:51:47 +00004975 u8 *aCopy[NB]; /* Space for holding data of apCopy[] */
4976 u8 *aSpace1; /* Space for copies of dividers cells before balance */
4977 u8 *aSpace2 = 0; /* Space for overflow dividers cells after balance */
danielk1977ac11ee62005-01-15 12:45:51 +00004978 u8 *aFrom = 0;
drh8b2f49b2001-06-08 00:21:52 +00004979
drh1fee73e2007-08-29 04:00:57 +00004980 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00004981
drh14acc042001-06-10 19:56:58 +00004982 /*
drh43605152004-05-29 21:46:49 +00004983 ** Find the parent page.
drh8b2f49b2001-06-08 00:21:52 +00004984 */
drh3a4c1412004-05-09 20:40:11 +00004985 assert( pPage->isInit );
danielk19776e465eb2007-08-21 13:11:00 +00004986 assert( sqlite3PagerIswriteable(pPage->pDbPage) || pPage->nOverflow==1 );
drh4b70f112004-05-02 21:12:19 +00004987 pBt = pPage->pBt;
drh14acc042001-06-10 19:56:58 +00004988 pParent = pPage->pParent;
drh43605152004-05-29 21:46:49 +00004989 assert( pParent );
danielk19773b8a05f2007-03-19 17:44:26 +00004990 if( SQLITE_OK!=(rc = sqlite3PagerWrite(pParent->pDbPage)) ){
danielk197707cb5602006-01-20 10:55:05 +00004991 return rc;
4992 }
danielk1977474b7cc2008-07-09 11:49:46 +00004993
drh43605152004-05-29 21:46:49 +00004994 TRACE(("BALANCE: begin page %d child of %d\n", pPage->pgno, pParent->pgno));
drh2e38c322004-09-03 18:38:44 +00004995
drh615ae552005-01-16 23:21:00 +00004996#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00004997 /*
4998 ** A special case: If a new entry has just been inserted into a
4999 ** table (that is, a btree with integer keys and all data at the leaves)
drh09d0deb2005-08-02 17:13:09 +00005000 ** and the new entry is the right-most entry in the tree (it has the
drhf222e712005-01-14 22:55:49 +00005001 ** largest key) then use the special balance_quick() routine for
5002 ** balancing. balance_quick() is much faster and results in a tighter
5003 ** packing of data in the common case.
5004 */
danielk1977ac245ec2005-01-14 13:50:11 +00005005 if( pPage->leaf &&
5006 pPage->intKey &&
danielk1977ac245ec2005-01-14 13:50:11 +00005007 pPage->nOverflow==1 &&
5008 pPage->aOvfl[0].idx==pPage->nCell &&
danielk1977ac11ee62005-01-15 12:45:51 +00005009 pPage->pParent->pgno!=1 &&
danielk1977ac245ec2005-01-14 13:50:11 +00005010 get4byte(&pParent->aData[pParent->hdrOffset+8])==pPage->pgno
5011 ){
drh44845222008-07-17 18:39:57 +00005012 assert( pPage->intKey );
danielk1977ac11ee62005-01-15 12:45:51 +00005013 /*
5014 ** TODO: Check the siblings to the left of pPage. It may be that
5015 ** they are not full and no new page is required.
5016 */
danielk1977ac245ec2005-01-14 13:50:11 +00005017 return balance_quick(pPage, pParent);
5018 }
5019#endif
5020
danielk19776e465eb2007-08-21 13:11:00 +00005021 if( SQLITE_OK!=(rc = sqlite3PagerWrite(pPage->pDbPage)) ){
5022 return rc;
5023 }
5024
drh2e38c322004-09-03 18:38:44 +00005025 /*
drh4b70f112004-05-02 21:12:19 +00005026 ** Find the cell in the parent page whose left child points back
drh14acc042001-06-10 19:56:58 +00005027 ** to pPage. The "idx" variable is the index of that cell. If pPage
5028 ** is the rightmost child of pParent then set idx to pParent->nCell
drh8b2f49b2001-06-08 00:21:52 +00005029 */
drhbb49aba2003-01-04 18:53:27 +00005030 if( pParent->idxShift ){
drha34b6762004-05-07 13:30:42 +00005031 Pgno pgno;
drh4b70f112004-05-02 21:12:19 +00005032 pgno = pPage->pgno;
danielk19773b8a05f2007-03-19 17:44:26 +00005033 assert( pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
drhbb49aba2003-01-04 18:53:27 +00005034 for(idx=0; idx<pParent->nCell; idx++){
danielk19771cc5ed82007-05-16 17:28:43 +00005035 if( get4byte(findCell(pParent, idx))==pgno ){
drhbb49aba2003-01-04 18:53:27 +00005036 break;
5037 }
drh8b2f49b2001-06-08 00:21:52 +00005038 }
drh4b70f112004-05-02 21:12:19 +00005039 assert( idx<pParent->nCell
drh43605152004-05-29 21:46:49 +00005040 || get4byte(&pParent->aData[pParent->hdrOffset+8])==pgno );
drhbb49aba2003-01-04 18:53:27 +00005041 }else{
5042 idx = pPage->idxParent;
drh8b2f49b2001-06-08 00:21:52 +00005043 }
drh8b2f49b2001-06-08 00:21:52 +00005044
5045 /*
drh14acc042001-06-10 19:56:58 +00005046 ** Initialize variables so that it will be safe to jump
drh5edc3122001-09-13 21:53:09 +00005047 ** directly to balance_cleanup at any moment.
drh8b2f49b2001-06-08 00:21:52 +00005048 */
drh14acc042001-06-10 19:56:58 +00005049 nOld = nNew = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00005050 sqlite3PagerRef(pParent->pDbPage);
drh14acc042001-06-10 19:56:58 +00005051
5052 /*
drh4b70f112004-05-02 21:12:19 +00005053 ** Find sibling pages to pPage and the cells in pParent that divide
drhc3b70572003-01-04 19:44:07 +00005054 ** the siblings. An attempt is made to find NN siblings on either
5055 ** side of pPage. More siblings are taken from one side, however, if
5056 ** pPage there are fewer than NN siblings on the other side. If pParent
5057 ** has NB or fewer children then all children of pParent are taken.
drh14acc042001-06-10 19:56:58 +00005058 */
drhc3b70572003-01-04 19:44:07 +00005059 nxDiv = idx - NN;
5060 if( nxDiv + NB > pParent->nCell ){
5061 nxDiv = pParent->nCell - NB + 1;
drh8b2f49b2001-06-08 00:21:52 +00005062 }
drhc3b70572003-01-04 19:44:07 +00005063 if( nxDiv<0 ){
5064 nxDiv = 0;
5065 }
drh8b2f49b2001-06-08 00:21:52 +00005066 nDiv = 0;
drhc3b70572003-01-04 19:44:07 +00005067 for(i=0, k=nxDiv; i<NB; i++, k++){
drh14acc042001-06-10 19:56:58 +00005068 if( k<pParent->nCell ){
danielk19771cc5ed82007-05-16 17:28:43 +00005069 apDiv[i] = findCell(pParent, k);
drh8b2f49b2001-06-08 00:21:52 +00005070 nDiv++;
drha34b6762004-05-07 13:30:42 +00005071 assert( !pParent->leaf );
drh43605152004-05-29 21:46:49 +00005072 pgnoOld[i] = get4byte(apDiv[i]);
drh14acc042001-06-10 19:56:58 +00005073 }else if( k==pParent->nCell ){
drh43605152004-05-29 21:46:49 +00005074 pgnoOld[i] = get4byte(&pParent->aData[pParent->hdrOffset+8]);
drh14acc042001-06-10 19:56:58 +00005075 }else{
5076 break;
drh8b2f49b2001-06-08 00:21:52 +00005077 }
drhde647132004-05-07 17:57:49 +00005078 rc = getAndInitPage(pBt, pgnoOld[i], &apOld[i], pParent);
drh6019e162001-07-02 17:51:45 +00005079 if( rc ) goto balance_cleanup;
drh428ae8c2003-01-04 16:48:09 +00005080 apOld[i]->idxParent = k;
drh91025292004-05-03 19:49:32 +00005081 apCopy[i] = 0;
5082 assert( i==nOld );
drh14acc042001-06-10 19:56:58 +00005083 nOld++;
danielk1977634f2982005-03-28 08:44:07 +00005084 nMaxCells += 1+apOld[i]->nCell+apOld[i]->nOverflow;
drh8b2f49b2001-06-08 00:21:52 +00005085 }
5086
drha9121e42008-02-19 14:59:35 +00005087 /* Make nMaxCells a multiple of 4 in order to preserve 8-byte
drh8d97f1f2005-05-05 18:14:13 +00005088 ** alignment */
drha9121e42008-02-19 14:59:35 +00005089 nMaxCells = (nMaxCells + 3)&~3;
drh8d97f1f2005-05-05 18:14:13 +00005090
drh8b2f49b2001-06-08 00:21:52 +00005091 /*
danielk1977634f2982005-03-28 08:44:07 +00005092 ** Allocate space for memory structures
5093 */
drhfacf0302008-06-17 15:12:00 +00005094 szScratch =
drha9121e42008-02-19 14:59:35 +00005095 nMaxCells*sizeof(u8*) /* apCell */
5096 + nMaxCells*sizeof(u16) /* szCell */
5097 + (ROUND8(sizeof(MemPage))+pBt->pageSize)*NB /* aCopy */
drhe5ae5732008-06-15 02:51:47 +00005098 + pBt->pageSize /* aSpace1 */
drhfacf0302008-06-17 15:12:00 +00005099 + (ISAUTOVACUUM ? nMaxCells : 0); /* aFrom */
5100 apCell = sqlite3ScratchMalloc( szScratch );
danielk1977634f2982005-03-28 08:44:07 +00005101 if( apCell==0 ){
5102 rc = SQLITE_NOMEM;
5103 goto balance_cleanup;
5104 }
drha9121e42008-02-19 14:59:35 +00005105 szCell = (u16*)&apCell[nMaxCells];
danielk1977634f2982005-03-28 08:44:07 +00005106 aCopy[0] = (u8*)&szCell[nMaxCells];
drhc96d8532005-05-03 12:30:33 +00005107 assert( ((aCopy[0] - (u8*)apCell) & 7)==0 ); /* 8-byte alignment required */
danielk1977634f2982005-03-28 08:44:07 +00005108 for(i=1; i<NB; i++){
drhc96d8532005-05-03 12:30:33 +00005109 aCopy[i] = &aCopy[i-1][pBt->pageSize+ROUND8(sizeof(MemPage))];
5110 assert( ((aCopy[i] - (u8*)apCell) & 7)==0 ); /* 8-byte alignment required */
danielk1977634f2982005-03-28 08:44:07 +00005111 }
drhe5ae5732008-06-15 02:51:47 +00005112 aSpace1 = &aCopy[NB-1][pBt->pageSize+ROUND8(sizeof(MemPage))];
5113 assert( ((aSpace1 - (u8*)apCell) & 7)==0 ); /* 8-byte alignment required */
danielk197785d90ca2008-07-19 14:25:15 +00005114 if( ISAUTOVACUUM ){
drhe5ae5732008-06-15 02:51:47 +00005115 aFrom = &aSpace1[pBt->pageSize];
danielk1977634f2982005-03-28 08:44:07 +00005116 }
drhfacf0302008-06-17 15:12:00 +00005117 aSpace2 = sqlite3PageMalloc(pBt->pageSize);
drhe5ae5732008-06-15 02:51:47 +00005118 if( aSpace2==0 ){
5119 rc = SQLITE_NOMEM;
5120 goto balance_cleanup;
5121 }
danielk1977634f2982005-03-28 08:44:07 +00005122
5123 /*
drh14acc042001-06-10 19:56:58 +00005124 ** Make copies of the content of pPage and its siblings into aOld[].
5125 ** The rest of this function will use data from the copies rather
5126 ** that the original pages since the original pages will be in the
5127 ** process of being overwritten.
5128 */
5129 for(i=0; i<nOld; i++){
drhbf4bca52007-09-06 22:19:14 +00005130 MemPage *p = apCopy[i] = (MemPage*)aCopy[i];
5131 memcpy(p, apOld[i], sizeof(MemPage));
5132 p->aData = (void*)&p[1];
5133 memcpy(p->aData, apOld[i]->aData, pBt->pageSize);
drh14acc042001-06-10 19:56:58 +00005134 }
5135
5136 /*
5137 ** Load pointers to all cells on sibling pages and the divider cells
5138 ** into the local apCell[] array. Make copies of the divider cells
drhe5ae5732008-06-15 02:51:47 +00005139 ** into space obtained form aSpace1[] and remove the the divider Cells
drhb6f41482004-05-14 01:58:11 +00005140 ** from pParent.
drh4b70f112004-05-02 21:12:19 +00005141 **
5142 ** If the siblings are on leaf pages, then the child pointers of the
5143 ** divider cells are stripped from the cells before they are copied
drhe5ae5732008-06-15 02:51:47 +00005144 ** into aSpace1[]. In this way, all cells in apCell[] are without
drh4b70f112004-05-02 21:12:19 +00005145 ** child pointers. If siblings are not leaves, then all cell in
5146 ** apCell[] include child pointers. Either way, all cells in apCell[]
5147 ** are alike.
drh96f5b762004-05-16 16:24:36 +00005148 **
5149 ** leafCorrection: 4 if pPage is a leaf. 0 if pPage is not a leaf.
5150 ** leafData: 1 if pPage holds key+data and pParent holds only keys.
drh8b2f49b2001-06-08 00:21:52 +00005151 */
5152 nCell = 0;
drh4b70f112004-05-02 21:12:19 +00005153 leafCorrection = pPage->leaf*4;
drh44845222008-07-17 18:39:57 +00005154 leafData = pPage->hasData;
drh8b2f49b2001-06-08 00:21:52 +00005155 for(i=0; i<nOld; i++){
drh4b70f112004-05-02 21:12:19 +00005156 MemPage *pOld = apCopy[i];
drh43605152004-05-29 21:46:49 +00005157 int limit = pOld->nCell+pOld->nOverflow;
5158 for(j=0; j<limit; j++){
danielk1977634f2982005-03-28 08:44:07 +00005159 assert( nCell<nMaxCells );
drh43605152004-05-29 21:46:49 +00005160 apCell[nCell] = findOverflowCell(pOld, j);
5161 szCell[nCell] = cellSizePtr(pOld, apCell[nCell]);
danielk197785d90ca2008-07-19 14:25:15 +00005162 if( ISAUTOVACUUM ){
danielk1977ac11ee62005-01-15 12:45:51 +00005163 int a;
5164 aFrom[nCell] = i;
5165 for(a=0; a<pOld->nOverflow; a++){
5166 if( pOld->aOvfl[a].pCell==apCell[nCell] ){
5167 aFrom[nCell] = 0xFF;
5168 break;
5169 }
5170 }
5171 }
drh14acc042001-06-10 19:56:58 +00005172 nCell++;
drh8b2f49b2001-06-08 00:21:52 +00005173 }
5174 if( i<nOld-1 ){
drha9121e42008-02-19 14:59:35 +00005175 u16 sz = cellSizePtr(pParent, apDiv[i]);
drh8b18dd42004-05-12 19:18:15 +00005176 if( leafData ){
drh96f5b762004-05-16 16:24:36 +00005177 /* With the LEAFDATA flag, pParent cells hold only INTKEYs that
5178 ** are duplicates of keys on the child pages. We need to remove
5179 ** the divider cells from pParent, but the dividers cells are not
5180 ** added to apCell[] because they are duplicates of child cells.
5181 */
drh8b18dd42004-05-12 19:18:15 +00005182 dropCell(pParent, nxDiv, sz);
drh4b70f112004-05-02 21:12:19 +00005183 }else{
drhb6f41482004-05-14 01:58:11 +00005184 u8 *pTemp;
danielk1977634f2982005-03-28 08:44:07 +00005185 assert( nCell<nMaxCells );
drhb6f41482004-05-14 01:58:11 +00005186 szCell[nCell] = sz;
drhe5ae5732008-06-15 02:51:47 +00005187 pTemp = &aSpace1[iSpace1];
5188 iSpace1 += sz;
5189 assert( sz<=pBt->pageSize/4 );
5190 assert( iSpace1<=pBt->pageSize );
drhb6f41482004-05-14 01:58:11 +00005191 memcpy(pTemp, apDiv[i], sz);
5192 apCell[nCell] = pTemp+leafCorrection;
danielk197785d90ca2008-07-19 14:25:15 +00005193 if( ISAUTOVACUUM ){
danielk1977ac11ee62005-01-15 12:45:51 +00005194 aFrom[nCell] = 0xFF;
5195 }
drhb6f41482004-05-14 01:58:11 +00005196 dropCell(pParent, nxDiv, sz);
drh8b18dd42004-05-12 19:18:15 +00005197 szCell[nCell] -= leafCorrection;
drh43605152004-05-29 21:46:49 +00005198 assert( get4byte(pTemp)==pgnoOld[i] );
drh8b18dd42004-05-12 19:18:15 +00005199 if( !pOld->leaf ){
5200 assert( leafCorrection==0 );
5201 /* The right pointer of the child page pOld becomes the left
5202 ** pointer of the divider cell */
drh43605152004-05-29 21:46:49 +00005203 memcpy(apCell[nCell], &pOld->aData[pOld->hdrOffset+8], 4);
drh8b18dd42004-05-12 19:18:15 +00005204 }else{
5205 assert( leafCorrection==4 );
danielk197739c96042007-05-12 10:41:47 +00005206 if( szCell[nCell]<4 ){
5207 /* Do not allow any cells smaller than 4 bytes. */
5208 szCell[nCell] = 4;
5209 }
drh8b18dd42004-05-12 19:18:15 +00005210 }
5211 nCell++;
drh4b70f112004-05-02 21:12:19 +00005212 }
drh8b2f49b2001-06-08 00:21:52 +00005213 }
5214 }
5215
5216 /*
drh6019e162001-07-02 17:51:45 +00005217 ** Figure out the number of pages needed to hold all nCell cells.
5218 ** Store this number in "k". Also compute szNew[] which is the total
5219 ** size of all cells on the i-th page and cntNew[] which is the index
drh4b70f112004-05-02 21:12:19 +00005220 ** in apCell[] of the cell that divides page i from page i+1.
drh6019e162001-07-02 17:51:45 +00005221 ** cntNew[k] should equal nCell.
5222 **
drh96f5b762004-05-16 16:24:36 +00005223 ** Values computed by this block:
5224 **
5225 ** k: The total number of sibling pages
5226 ** szNew[i]: Spaced used on the i-th sibling page.
5227 ** cntNew[i]: Index in apCell[] and szCell[] for the first cell to
5228 ** the right of the i-th sibling page.
5229 ** usableSpace: Number of bytes of space available on each sibling.
5230 **
drh8b2f49b2001-06-08 00:21:52 +00005231 */
drh43605152004-05-29 21:46:49 +00005232 usableSpace = pBt->usableSize - 12 + leafCorrection;
drh6019e162001-07-02 17:51:45 +00005233 for(subtotal=k=i=0; i<nCell; i++){
danielk1977634f2982005-03-28 08:44:07 +00005234 assert( i<nMaxCells );
drh43605152004-05-29 21:46:49 +00005235 subtotal += szCell[i] + 2;
drh4b70f112004-05-02 21:12:19 +00005236 if( subtotal > usableSpace ){
drh6019e162001-07-02 17:51:45 +00005237 szNew[k] = subtotal - szCell[i];
5238 cntNew[k] = i;
drh8b18dd42004-05-12 19:18:15 +00005239 if( leafData ){ i--; }
drh6019e162001-07-02 17:51:45 +00005240 subtotal = 0;
5241 k++;
5242 }
5243 }
5244 szNew[k] = subtotal;
5245 cntNew[k] = nCell;
5246 k++;
drh96f5b762004-05-16 16:24:36 +00005247
5248 /*
5249 ** The packing computed by the previous block is biased toward the siblings
5250 ** on the left side. The left siblings are always nearly full, while the
5251 ** right-most sibling might be nearly empty. This block of code attempts
5252 ** to adjust the packing of siblings to get a better balance.
5253 **
5254 ** This adjustment is more than an optimization. The packing above might
5255 ** be so out of balance as to be illegal. For example, the right-most
5256 ** sibling might be completely empty. This adjustment is not optional.
5257 */
drh6019e162001-07-02 17:51:45 +00005258 for(i=k-1; i>0; i--){
drh96f5b762004-05-16 16:24:36 +00005259 int szRight = szNew[i]; /* Size of sibling on the right */
5260 int szLeft = szNew[i-1]; /* Size of sibling on the left */
5261 int r; /* Index of right-most cell in left sibling */
5262 int d; /* Index of first cell to the left of right sibling */
5263
5264 r = cntNew[i-1] - 1;
5265 d = r + 1 - leafData;
danielk1977634f2982005-03-28 08:44:07 +00005266 assert( d<nMaxCells );
5267 assert( r<nMaxCells );
drh43605152004-05-29 21:46:49 +00005268 while( szRight==0 || szRight+szCell[d]+2<=szLeft-(szCell[r]+2) ){
5269 szRight += szCell[d] + 2;
5270 szLeft -= szCell[r] + 2;
drh6019e162001-07-02 17:51:45 +00005271 cntNew[i-1]--;
drh96f5b762004-05-16 16:24:36 +00005272 r = cntNew[i-1] - 1;
5273 d = r + 1 - leafData;
drh6019e162001-07-02 17:51:45 +00005274 }
drh96f5b762004-05-16 16:24:36 +00005275 szNew[i] = szRight;
5276 szNew[i-1] = szLeft;
drh6019e162001-07-02 17:51:45 +00005277 }
drh09d0deb2005-08-02 17:13:09 +00005278
5279 /* Either we found one or more cells (cntnew[0])>0) or we are the
5280 ** a virtual root page. A virtual root page is when the real root
5281 ** page is page 1 and we are the only child of that page.
5282 */
5283 assert( cntNew[0]>0 || (pParent->pgno==1 && pParent->nCell==0) );
drh8b2f49b2001-06-08 00:21:52 +00005284
5285 /*
drh6b308672002-07-08 02:16:37 +00005286 ** Allocate k new pages. Reuse old pages where possible.
drh8b2f49b2001-06-08 00:21:52 +00005287 */
drh4b70f112004-05-02 21:12:19 +00005288 assert( pPage->pgno>1 );
5289 pageFlags = pPage->aData[0];
drh14acc042001-06-10 19:56:58 +00005290 for(i=0; i<k; i++){
drhda200cc2004-05-09 11:51:38 +00005291 MemPage *pNew;
drh6b308672002-07-08 02:16:37 +00005292 if( i<nOld ){
drhda200cc2004-05-09 11:51:38 +00005293 pNew = apNew[i] = apOld[i];
drh6b308672002-07-08 02:16:37 +00005294 pgnoNew[i] = pgnoOld[i];
5295 apOld[i] = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00005296 rc = sqlite3PagerWrite(pNew->pDbPage);
drhf5345442007-04-09 12:45:02 +00005297 nNew++;
danielk197728129562005-01-11 10:25:06 +00005298 if( rc ) goto balance_cleanup;
drh6b308672002-07-08 02:16:37 +00005299 }else{
drh7aa8f852006-03-28 00:24:44 +00005300 assert( i>0 );
drh4f0c5872007-03-26 22:05:01 +00005301 rc = allocateBtreePage(pBt, &pNew, &pgnoNew[i], pgnoNew[i-1], 0);
drh6b308672002-07-08 02:16:37 +00005302 if( rc ) goto balance_cleanup;
drhda200cc2004-05-09 11:51:38 +00005303 apNew[i] = pNew;
drhf5345442007-04-09 12:45:02 +00005304 nNew++;
drh6b308672002-07-08 02:16:37 +00005305 }
drh8b2f49b2001-06-08 00:21:52 +00005306 }
5307
danielk1977299b1872004-11-22 10:02:10 +00005308 /* Free any old pages that were not reused as new pages.
5309 */
5310 while( i<nOld ){
5311 rc = freePage(apOld[i]);
5312 if( rc ) goto balance_cleanup;
5313 releasePage(apOld[i]);
5314 apOld[i] = 0;
5315 i++;
5316 }
5317
drh8b2f49b2001-06-08 00:21:52 +00005318 /*
drhf9ffac92002-03-02 19:00:31 +00005319 ** Put the new pages in accending order. This helps to
5320 ** keep entries in the disk file in order so that a scan
5321 ** of the table is a linear scan through the file. That
5322 ** in turn helps the operating system to deliver pages
5323 ** from the disk more rapidly.
5324 **
5325 ** An O(n^2) insertion sort algorithm is used, but since
drhc3b70572003-01-04 19:44:07 +00005326 ** n is never more than NB (a small constant), that should
5327 ** not be a problem.
drhf9ffac92002-03-02 19:00:31 +00005328 **
drhc3b70572003-01-04 19:44:07 +00005329 ** When NB==3, this one optimization makes the database
5330 ** about 25% faster for large insertions and deletions.
drhf9ffac92002-03-02 19:00:31 +00005331 */
5332 for(i=0; i<k-1; i++){
5333 int minV = pgnoNew[i];
5334 int minI = i;
5335 for(j=i+1; j<k; j++){
drh7d02cb72003-06-04 16:24:39 +00005336 if( pgnoNew[j]<(unsigned)minV ){
drhf9ffac92002-03-02 19:00:31 +00005337 minI = j;
5338 minV = pgnoNew[j];
5339 }
5340 }
5341 if( minI>i ){
5342 int t;
5343 MemPage *pT;
5344 t = pgnoNew[i];
5345 pT = apNew[i];
5346 pgnoNew[i] = pgnoNew[minI];
5347 apNew[i] = apNew[minI];
5348 pgnoNew[minI] = t;
5349 apNew[minI] = pT;
5350 }
5351 }
drha2fce642004-06-05 00:01:44 +00005352 TRACE(("BALANCE: old: %d %d %d new: %d(%d) %d(%d) %d(%d) %d(%d) %d(%d)\n",
drh24cd67e2004-05-10 16:18:47 +00005353 pgnoOld[0],
5354 nOld>=2 ? pgnoOld[1] : 0,
5355 nOld>=3 ? pgnoOld[2] : 0,
drh10c0fa62004-05-18 12:50:17 +00005356 pgnoNew[0], szNew[0],
5357 nNew>=2 ? pgnoNew[1] : 0, nNew>=2 ? szNew[1] : 0,
5358 nNew>=3 ? pgnoNew[2] : 0, nNew>=3 ? szNew[2] : 0,
drha2fce642004-06-05 00:01:44 +00005359 nNew>=4 ? pgnoNew[3] : 0, nNew>=4 ? szNew[3] : 0,
5360 nNew>=5 ? pgnoNew[4] : 0, nNew>=5 ? szNew[4] : 0));
drh24cd67e2004-05-10 16:18:47 +00005361
drhf9ffac92002-03-02 19:00:31 +00005362 /*
drh14acc042001-06-10 19:56:58 +00005363 ** Evenly distribute the data in apCell[] across the new pages.
5364 ** Insert divider cells into pParent as necessary.
5365 */
5366 j = 0;
5367 for(i=0; i<nNew; i++){
danielk1977ac11ee62005-01-15 12:45:51 +00005368 /* Assemble the new sibling page. */
drh14acc042001-06-10 19:56:58 +00005369 MemPage *pNew = apNew[i];
drh19642e52005-03-29 13:17:45 +00005370 assert( j<nMaxCells );
drh4b70f112004-05-02 21:12:19 +00005371 assert( pNew->pgno==pgnoNew[i] );
drh10131482008-07-11 03:34:09 +00005372 zeroPage(pNew, pageFlags);
drhfa1a98a2004-05-14 19:08:17 +00005373 assemblePage(pNew, cntNew[i]-j, &apCell[j], &szCell[j]);
drh09d0deb2005-08-02 17:13:09 +00005374 assert( pNew->nCell>0 || (nNew==1 && cntNew[0]==0) );
drh43605152004-05-29 21:46:49 +00005375 assert( pNew->nOverflow==0 );
danielk1977ac11ee62005-01-15 12:45:51 +00005376
danielk1977ac11ee62005-01-15 12:45:51 +00005377 /* If this is an auto-vacuum database, update the pointer map entries
5378 ** that point to the siblings that were rearranged. These can be: left
5379 ** children of cells, the right-child of the page, or overflow pages
5380 ** pointed to by cells.
5381 */
danielk197785d90ca2008-07-19 14:25:15 +00005382 if( ISAUTOVACUUM ){
danielk1977ac11ee62005-01-15 12:45:51 +00005383 for(k=j; k<cntNew[i]; k++){
danielk1977634f2982005-03-28 08:44:07 +00005384 assert( k<nMaxCells );
danielk1977ac11ee62005-01-15 12:45:51 +00005385 if( aFrom[k]==0xFF || apCopy[aFrom[k]]->pgno!=pNew->pgno ){
danielk197779a40da2005-01-16 08:00:01 +00005386 rc = ptrmapPutOvfl(pNew, k-j);
danielk197787c52b52008-07-19 11:49:07 +00005387 if( rc==SQLITE_OK && leafCorrection==0 ){
5388 rc = ptrmapPut(pBt, get4byte(apCell[k]), PTRMAP_BTREE, pNew->pgno);
5389 }
danielk197779a40da2005-01-16 08:00:01 +00005390 if( rc!=SQLITE_OK ){
5391 goto balance_cleanup;
danielk1977ac11ee62005-01-15 12:45:51 +00005392 }
5393 }
5394 }
5395 }
danielk1977ac11ee62005-01-15 12:45:51 +00005396
5397 j = cntNew[i];
5398
5399 /* If the sibling page assembled above was not the right-most sibling,
5400 ** insert a divider cell into the parent page.
5401 */
drh14acc042001-06-10 19:56:58 +00005402 if( i<nNew-1 && j<nCell ){
drh8b18dd42004-05-12 19:18:15 +00005403 u8 *pCell;
drh24cd67e2004-05-10 16:18:47 +00005404 u8 *pTemp;
drh8b18dd42004-05-12 19:18:15 +00005405 int sz;
danielk1977634f2982005-03-28 08:44:07 +00005406
5407 assert( j<nMaxCells );
drh8b18dd42004-05-12 19:18:15 +00005408 pCell = apCell[j];
5409 sz = szCell[j] + leafCorrection;
drhe5ae5732008-06-15 02:51:47 +00005410 pTemp = &aSpace2[iSpace2];
drh4b70f112004-05-02 21:12:19 +00005411 if( !pNew->leaf ){
drh43605152004-05-29 21:46:49 +00005412 memcpy(&pNew->aData[8], pCell, 4);
danielk197785d90ca2008-07-19 14:25:15 +00005413 if( ISAUTOVACUUM
danielk197787c52b52008-07-19 11:49:07 +00005414 && (aFrom[j]==0xFF || apCopy[aFrom[j]]->pgno!=pNew->pgno)
5415 ){
5416 rc = ptrmapPut(pBt, get4byte(pCell), PTRMAP_BTREE, pNew->pgno);
5417 if( rc!=SQLITE_OK ){
5418 goto balance_cleanup;
5419 }
5420 }
drh8b18dd42004-05-12 19:18:15 +00005421 }else if( leafData ){
drhfd131da2007-08-07 17:13:03 +00005422 /* If the tree is a leaf-data tree, and the siblings are leaves,
danielk1977ac11ee62005-01-15 12:45:51 +00005423 ** then there is no divider cell in apCell[]. Instead, the divider
5424 ** cell consists of the integer key for the right-most cell of
5425 ** the sibling-page assembled above only.
5426 */
drh6f11bef2004-05-13 01:12:56 +00005427 CellInfo info;
drh8b18dd42004-05-12 19:18:15 +00005428 j--;
drh16a9b832007-05-05 18:39:25 +00005429 sqlite3BtreeParseCellPtr(pNew, apCell[j], &info);
drhe5ae5732008-06-15 02:51:47 +00005430 pCell = pTemp;
drhb026e052007-05-02 01:34:31 +00005431 fillInCell(pParent, pCell, 0, info.nKey, 0, 0, 0, &sz);
drh8b18dd42004-05-12 19:18:15 +00005432 pTemp = 0;
drh4b70f112004-05-02 21:12:19 +00005433 }else{
5434 pCell -= 4;
danielk19774aeff622007-05-12 09:30:47 +00005435 /* Obscure case for non-leaf-data trees: If the cell at pCell was
drh85b623f2007-12-13 21:54:09 +00005436 ** previously stored on a leaf node, and its reported size was 4
danielk19774aeff622007-05-12 09:30:47 +00005437 ** bytes, then it may actually be smaller than this
5438 ** (see sqlite3BtreeParseCellPtr(), 4 bytes is the minimum size of
drh85b623f2007-12-13 21:54:09 +00005439 ** any cell). But it is important to pass the correct size to
danielk19774aeff622007-05-12 09:30:47 +00005440 ** insertCell(), so reparse the cell now.
5441 **
5442 ** Note that this can never happen in an SQLite data file, as all
5443 ** cells are at least 4 bytes. It only happens in b-trees used
5444 ** to evaluate "IN (SELECT ...)" and similar clauses.
5445 */
5446 if( szCell[j]==4 ){
5447 assert(leafCorrection==4);
5448 sz = cellSizePtr(pParent, pCell);
5449 }
drh4b70f112004-05-02 21:12:19 +00005450 }
drhe5ae5732008-06-15 02:51:47 +00005451 iSpace2 += sz;
5452 assert( sz<=pBt->pageSize/4 );
5453 assert( iSpace2<=pBt->pageSize );
danielk1977a3ad5e72005-01-07 08:56:44 +00005454 rc = insertCell(pParent, nxDiv, pCell, sz, pTemp, 4);
danielk1977e80463b2004-11-03 03:01:16 +00005455 if( rc!=SQLITE_OK ) goto balance_cleanup;
drh43605152004-05-29 21:46:49 +00005456 put4byte(findOverflowCell(pParent,nxDiv), pNew->pgno);
danielk197785d90ca2008-07-19 14:25:15 +00005457
danielk1977ac11ee62005-01-15 12:45:51 +00005458 /* If this is an auto-vacuum database, and not a leaf-data tree,
5459 ** then update the pointer map with an entry for the overflow page
5460 ** that the cell just inserted points to (if any).
5461 */
danielk197785d90ca2008-07-19 14:25:15 +00005462 if( ISAUTOVACUUM && !leafData ){
danielk197779a40da2005-01-16 08:00:01 +00005463 rc = ptrmapPutOvfl(pParent, nxDiv);
5464 if( rc!=SQLITE_OK ){
5465 goto balance_cleanup;
danielk1977ac11ee62005-01-15 12:45:51 +00005466 }
5467 }
drh14acc042001-06-10 19:56:58 +00005468 j++;
5469 nxDiv++;
5470 }
danielk197787c52b52008-07-19 11:49:07 +00005471
danielk197787c52b52008-07-19 11:49:07 +00005472 /* Set the pointer-map entry for the new sibling page. */
danielk197785d90ca2008-07-19 14:25:15 +00005473 if( ISAUTOVACUUM ){
danielk197787c52b52008-07-19 11:49:07 +00005474 rc = ptrmapPut(pBt, pNew->pgno, PTRMAP_BTREE, pParent->pgno);
5475 if( rc!=SQLITE_OK ){
5476 goto balance_cleanup;
5477 }
5478 }
drh14acc042001-06-10 19:56:58 +00005479 }
drh6019e162001-07-02 17:51:45 +00005480 assert( j==nCell );
drh7aa8f852006-03-28 00:24:44 +00005481 assert( nOld>0 );
5482 assert( nNew>0 );
drh4b70f112004-05-02 21:12:19 +00005483 if( (pageFlags & PTF_LEAF)==0 ){
danielk197787c52b52008-07-19 11:49:07 +00005484 u8 *zChild = &apCopy[nOld-1]->aData[8];
5485 memcpy(&apNew[nNew-1]->aData[8], zChild, 4);
danielk197785d90ca2008-07-19 14:25:15 +00005486 if( ISAUTOVACUUM ){
danielk197787c52b52008-07-19 11:49:07 +00005487 rc = ptrmapPut(pBt, get4byte(zChild), PTRMAP_BTREE, apNew[nNew-1]->pgno);
5488 if( rc!=SQLITE_OK ){
5489 goto balance_cleanup;
5490 }
5491 }
drh14acc042001-06-10 19:56:58 +00005492 }
drh43605152004-05-29 21:46:49 +00005493 if( nxDiv==pParent->nCell+pParent->nOverflow ){
drh4b70f112004-05-02 21:12:19 +00005494 /* Right-most sibling is the right-most child of pParent */
drh43605152004-05-29 21:46:49 +00005495 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew[nNew-1]);
drh4b70f112004-05-02 21:12:19 +00005496 }else{
5497 /* Right-most sibling is the left child of the first entry in pParent
5498 ** past the right-most divider entry */
drh43605152004-05-29 21:46:49 +00005499 put4byte(findOverflowCell(pParent, nxDiv), pgnoNew[nNew-1]);
drh14acc042001-06-10 19:56:58 +00005500 }
5501
5502 /*
5503 ** Reparent children of all cells.
drh8b2f49b2001-06-08 00:21:52 +00005504 */
5505 for(i=0; i<nNew; i++){
danielk197787c52b52008-07-19 11:49:07 +00005506 rc = reparentChildPages(apNew[i], 0);
danielk1977afcdd022004-10-31 16:25:42 +00005507 if( rc!=SQLITE_OK ) goto balance_cleanup;
drh8b2f49b2001-06-08 00:21:52 +00005508 }
danielk197787c52b52008-07-19 11:49:07 +00005509 rc = reparentChildPages(pParent, 0);
danielk1977afcdd022004-10-31 16:25:42 +00005510 if( rc!=SQLITE_OK ) goto balance_cleanup;
drh8b2f49b2001-06-08 00:21:52 +00005511
5512 /*
drh3a4c1412004-05-09 20:40:11 +00005513 ** Balance the parent page. Note that the current page (pPage) might
danielk1977ac11ee62005-01-15 12:45:51 +00005514 ** have been added to the freelist so it might no longer be initialized.
drh3a4c1412004-05-09 20:40:11 +00005515 ** But the parent page will always be initialized.
drh8b2f49b2001-06-08 00:21:52 +00005516 */
drhda200cc2004-05-09 11:51:38 +00005517 assert( pParent->isInit );
drhfacf0302008-06-17 15:12:00 +00005518 sqlite3ScratchFree(apCell);
drhe5ae5732008-06-15 02:51:47 +00005519 apCell = 0;
danielk1977ac245ec2005-01-14 13:50:11 +00005520 rc = balance(pParent, 0);
drhda200cc2004-05-09 11:51:38 +00005521
drh8b2f49b2001-06-08 00:21:52 +00005522 /*
drh14acc042001-06-10 19:56:58 +00005523 ** Cleanup before returning.
drh8b2f49b2001-06-08 00:21:52 +00005524 */
drh14acc042001-06-10 19:56:58 +00005525balance_cleanup:
drhfacf0302008-06-17 15:12:00 +00005526 sqlite3PageFree(aSpace2);
5527 sqlite3ScratchFree(apCell);
drh8b2f49b2001-06-08 00:21:52 +00005528 for(i=0; i<nOld; i++){
drh91025292004-05-03 19:49:32 +00005529 releasePage(apOld[i]);
drh8b2f49b2001-06-08 00:21:52 +00005530 }
drh14acc042001-06-10 19:56:58 +00005531 for(i=0; i<nNew; i++){
drh91025292004-05-03 19:49:32 +00005532 releasePage(apNew[i]);
drh8b2f49b2001-06-08 00:21:52 +00005533 }
drh91025292004-05-03 19:49:32 +00005534 releasePage(pParent);
drh3a4c1412004-05-09 20:40:11 +00005535 TRACE(("BALANCE: finished with %d: old=%d new=%d cells=%d\n",
5536 pPage->pgno, nOld, nNew, nCell));
drh8b2f49b2001-06-08 00:21:52 +00005537 return rc;
5538}
5539
5540/*
drh43605152004-05-29 21:46:49 +00005541** This routine is called for the root page of a btree when the root
5542** page contains no cells. This is an opportunity to make the tree
5543** shallower by one level.
5544*/
5545static int balance_shallower(MemPage *pPage){
5546 MemPage *pChild; /* The only child page of pPage */
5547 Pgno pgnoChild; /* Page number for pChild */
drh2e38c322004-09-03 18:38:44 +00005548 int rc = SQLITE_OK; /* Return code from subprocedures */
danielk1977aef0bf62005-12-30 16:28:01 +00005549 BtShared *pBt; /* The main BTree structure */
drh2e38c322004-09-03 18:38:44 +00005550 int mxCellPerPage; /* Maximum number of cells per page */
5551 u8 **apCell; /* All cells from pages being balanced */
drha9121e42008-02-19 14:59:35 +00005552 u16 *szCell; /* Local size of all cells */
drh43605152004-05-29 21:46:49 +00005553
5554 assert( pPage->pParent==0 );
5555 assert( pPage->nCell==0 );
drh1fee73e2007-08-29 04:00:57 +00005556 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh2e38c322004-09-03 18:38:44 +00005557 pBt = pPage->pBt;
5558 mxCellPerPage = MX_CELL(pBt);
drhe5ae5732008-06-15 02:51:47 +00005559 apCell = sqlite3Malloc( mxCellPerPage*(sizeof(u8*)+sizeof(u16)) );
drh2e38c322004-09-03 18:38:44 +00005560 if( apCell==0 ) return SQLITE_NOMEM;
drha9121e42008-02-19 14:59:35 +00005561 szCell = (u16*)&apCell[mxCellPerPage];
drh43605152004-05-29 21:46:49 +00005562 if( pPage->leaf ){
5563 /* The table is completely empty */
5564 TRACE(("BALANCE: empty table %d\n", pPage->pgno));
5565 }else{
5566 /* The root page is empty but has one child. Transfer the
5567 ** information from that one child into the root page if it
5568 ** will fit. This reduces the depth of the tree by one.
5569 **
5570 ** If the root page is page 1, it has less space available than
5571 ** its child (due to the 100 byte header that occurs at the beginning
5572 ** of the database fle), so it might not be able to hold all of the
5573 ** information currently contained in the child. If this is the
5574 ** case, then do not do the transfer. Leave page 1 empty except
5575 ** for the right-pointer to the child page. The child page becomes
5576 ** the virtual root of the tree.
5577 */
5578 pgnoChild = get4byte(&pPage->aData[pPage->hdrOffset+8]);
5579 assert( pgnoChild>0 );
danielk1977ad0132d2008-06-07 08:58:22 +00005580 assert( pgnoChild<=pagerPagecount(pPage->pBt->pPager) );
drh16a9b832007-05-05 18:39:25 +00005581 rc = sqlite3BtreeGetPage(pPage->pBt, pgnoChild, &pChild, 0);
drh2e38c322004-09-03 18:38:44 +00005582 if( rc ) goto end_shallow_balance;
drh43605152004-05-29 21:46:49 +00005583 if( pPage->pgno==1 ){
drh16a9b832007-05-05 18:39:25 +00005584 rc = sqlite3BtreeInitPage(pChild, pPage);
drh2e38c322004-09-03 18:38:44 +00005585 if( rc ) goto end_shallow_balance;
drh43605152004-05-29 21:46:49 +00005586 assert( pChild->nOverflow==0 );
5587 if( pChild->nFree>=100 ){
5588 /* The child information will fit on the root page, so do the
5589 ** copy */
5590 int i;
5591 zeroPage(pPage, pChild->aData[0]);
5592 for(i=0; i<pChild->nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00005593 apCell[i] = findCell(pChild,i);
drh43605152004-05-29 21:46:49 +00005594 szCell[i] = cellSizePtr(pChild, apCell[i]);
5595 }
5596 assemblePage(pPage, pChild->nCell, apCell, szCell);
danielk1977ae825582004-11-23 09:06:55 +00005597 /* Copy the right-pointer of the child to the parent. */
5598 put4byte(&pPage->aData[pPage->hdrOffset+8],
5599 get4byte(&pChild->aData[pChild->hdrOffset+8]));
drh43605152004-05-29 21:46:49 +00005600 freePage(pChild);
5601 TRACE(("BALANCE: child %d transfer to page 1\n", pChild->pgno));
5602 }else{
5603 /* The child has more information that will fit on the root.
5604 ** The tree is already balanced. Do nothing. */
5605 TRACE(("BALANCE: child %d will not fit on page 1\n", pChild->pgno));
5606 }
5607 }else{
5608 memcpy(pPage->aData, pChild->aData, pPage->pBt->usableSize);
5609 pPage->isInit = 0;
5610 pPage->pParent = 0;
drh16a9b832007-05-05 18:39:25 +00005611 rc = sqlite3BtreeInitPage(pPage, 0);
drh43605152004-05-29 21:46:49 +00005612 assert( rc==SQLITE_OK );
5613 freePage(pChild);
5614 TRACE(("BALANCE: transfer child %d into root %d\n",
5615 pChild->pgno, pPage->pgno));
5616 }
danielk197787c52b52008-07-19 11:49:07 +00005617 rc = reparentChildPages(pPage, 1);
danielk1977ac11ee62005-01-15 12:45:51 +00005618 assert( pPage->nOverflow==0 );
danielk197785d90ca2008-07-19 14:25:15 +00005619 if( ISAUTOVACUUM ){
danielk1977aac0a382005-01-16 11:07:06 +00005620 int i;
danielk1977ac11ee62005-01-15 12:45:51 +00005621 for(i=0; i<pPage->nCell; i++){
danielk197779a40da2005-01-16 08:00:01 +00005622 rc = ptrmapPutOvfl(pPage, i);
5623 if( rc!=SQLITE_OK ){
5624 goto end_shallow_balance;
danielk1977ac11ee62005-01-15 12:45:51 +00005625 }
5626 }
5627 }
drh43605152004-05-29 21:46:49 +00005628 releasePage(pChild);
5629 }
drh2e38c322004-09-03 18:38:44 +00005630end_shallow_balance:
drh17435752007-08-16 04:30:38 +00005631 sqlite3_free(apCell);
drh2e38c322004-09-03 18:38:44 +00005632 return rc;
drh43605152004-05-29 21:46:49 +00005633}
5634
5635
5636/*
5637** The root page is overfull
5638**
5639** When this happens, Create a new child page and copy the
5640** contents of the root into the child. Then make the root
5641** page an empty page with rightChild pointing to the new
5642** child. Finally, call balance_internal() on the new child
5643** to cause it to split.
5644*/
5645static int balance_deeper(MemPage *pPage){
5646 int rc; /* Return value from subprocedures */
5647 MemPage *pChild; /* Pointer to a new child page */
5648 Pgno pgnoChild; /* Page number of the new child page */
danielk1977aef0bf62005-12-30 16:28:01 +00005649 BtShared *pBt; /* The BTree */
drh43605152004-05-29 21:46:49 +00005650 int usableSize; /* Total usable size of a page */
5651 u8 *data; /* Content of the parent page */
5652 u8 *cdata; /* Content of the child page */
5653 int hdr; /* Offset to page header in parent */
drh281b21d2008-08-22 12:57:08 +00005654 int cbrk; /* Offset to content of first cell in parent */
drh43605152004-05-29 21:46:49 +00005655
5656 assert( pPage->pParent==0 );
5657 assert( pPage->nOverflow>0 );
5658 pBt = pPage->pBt;
drh1fee73e2007-08-29 04:00:57 +00005659 assert( sqlite3_mutex_held(pBt->mutex) );
drh4f0c5872007-03-26 22:05:01 +00005660 rc = allocateBtreePage(pBt, &pChild, &pgnoChild, pPage->pgno, 0);
drh43605152004-05-29 21:46:49 +00005661 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005662 assert( sqlite3PagerIswriteable(pChild->pDbPage) );
drh43605152004-05-29 21:46:49 +00005663 usableSize = pBt->usableSize;
5664 data = pPage->aData;
5665 hdr = pPage->hdrOffset;
drh281b21d2008-08-22 12:57:08 +00005666 cbrk = get2byte(&data[hdr+5]);
drh43605152004-05-29 21:46:49 +00005667 cdata = pChild->aData;
5668 memcpy(cdata, &data[hdr], pPage->cellOffset+2*pPage->nCell-hdr);
drh281b21d2008-08-22 12:57:08 +00005669 memcpy(&cdata[cbrk], &data[cbrk], usableSize-cbrk);
drh10131482008-07-11 03:34:09 +00005670 if( pChild->isInit ) return SQLITE_CORRUPT;
drh16a9b832007-05-05 18:39:25 +00005671 rc = sqlite3BtreeInitPage(pChild, pPage);
danielk19776b456a22005-03-21 04:04:02 +00005672 if( rc ) goto balancedeeper_out;
drh43605152004-05-29 21:46:49 +00005673 memcpy(pChild->aOvfl, pPage->aOvfl, pPage->nOverflow*sizeof(pPage->aOvfl[0]));
5674 pChild->nOverflow = pPage->nOverflow;
5675 if( pChild->nOverflow ){
5676 pChild->nFree = 0;
5677 }
5678 assert( pChild->nCell==pPage->nCell );
5679 zeroPage(pPage, pChild->aData[0] & ~PTF_LEAF);
5680 put4byte(&pPage->aData[pPage->hdrOffset+8], pgnoChild);
5681 TRACE(("BALANCE: copy root %d into %d\n", pPage->pgno, pChild->pgno));
danielk197785d90ca2008-07-19 14:25:15 +00005682 if( ISAUTOVACUUM ){
danielk1977ac11ee62005-01-15 12:45:51 +00005683 int i;
5684 rc = ptrmapPut(pBt, pChild->pgno, PTRMAP_BTREE, pPage->pgno);
danielk19776b456a22005-03-21 04:04:02 +00005685 if( rc ) goto balancedeeper_out;
danielk1977ac11ee62005-01-15 12:45:51 +00005686 for(i=0; i<pChild->nCell; i++){
danielk197779a40da2005-01-16 08:00:01 +00005687 rc = ptrmapPutOvfl(pChild, i);
5688 if( rc!=SQLITE_OK ){
danielk1977474b7cc2008-07-09 11:49:46 +00005689 goto balancedeeper_out;
danielk1977ac11ee62005-01-15 12:45:51 +00005690 }
5691 }
danielk197787c52b52008-07-19 11:49:07 +00005692 rc = reparentChildPages(pChild, 1);
danielk1977ac11ee62005-01-15 12:45:51 +00005693 }
danielk197787c52b52008-07-19 11:49:07 +00005694 if( rc==SQLITE_OK ){
5695 rc = balance_nonroot(pChild);
5696 }
danielk19776b456a22005-03-21 04:04:02 +00005697
5698balancedeeper_out:
drh43605152004-05-29 21:46:49 +00005699 releasePage(pChild);
5700 return rc;
5701}
5702
5703/*
5704** Decide if the page pPage needs to be balanced. If balancing is
5705** required, call the appropriate balancing routine.
5706*/
danielk1977ac245ec2005-01-14 13:50:11 +00005707static int balance(MemPage *pPage, int insert){
drh43605152004-05-29 21:46:49 +00005708 int rc = SQLITE_OK;
drh1fee73e2007-08-29 04:00:57 +00005709 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh43605152004-05-29 21:46:49 +00005710 if( pPage->pParent==0 ){
danielk19776e465eb2007-08-21 13:11:00 +00005711 rc = sqlite3PagerWrite(pPage->pDbPage);
5712 if( rc==SQLITE_OK && pPage->nOverflow>0 ){
drh43605152004-05-29 21:46:49 +00005713 rc = balance_deeper(pPage);
5714 }
danielk1977687566d2004-11-02 12:56:41 +00005715 if( rc==SQLITE_OK && pPage->nCell==0 ){
drh43605152004-05-29 21:46:49 +00005716 rc = balance_shallower(pPage);
5717 }
5718 }else{
danielk1977ac245ec2005-01-14 13:50:11 +00005719 if( pPage->nOverflow>0 ||
5720 (!insert && pPage->nFree>pPage->pBt->usableSize*2/3) ){
drh43605152004-05-29 21:46:49 +00005721 rc = balance_nonroot(pPage);
5722 }
5723 }
5724 return rc;
5725}
5726
5727/*
drh8dcd7ca2004-08-08 19:43:29 +00005728** This routine checks all cursors that point to table pgnoRoot.
drh980b1a72006-08-16 16:42:48 +00005729** If any of those cursors were opened with wrFlag==0 in a different
5730** database connection (a database connection that shares the pager
5731** cache with the current connection) and that other connection
5732** is not in the ReadUncommmitted state, then this routine returns
5733** SQLITE_LOCKED.
danielk1977299b1872004-11-22 10:02:10 +00005734**
danielk19773588ceb2008-06-10 17:30:26 +00005735** As well as cursors with wrFlag==0, cursors with wrFlag==1 and
5736** isIncrblobHandle==1 are also considered 'read' cursors. Incremental
5737** blob cursors are used for both reading and writing.
5738**
5739** When pgnoRoot is the root page of an intkey table, this function is also
5740** responsible for invalidating incremental blob cursors when the table row
5741** on which they are opened is deleted or modified. Cursors are invalidated
5742** according to the following rules:
5743**
5744** 1) When BtreeClearTable() is called to completely delete the contents
5745** of a B-Tree table, pExclude is set to zero and parameter iRow is
5746** set to non-zero. In this case all incremental blob cursors open
5747** on the table rooted at pgnoRoot are invalidated.
5748**
5749** 2) When BtreeInsert(), BtreeDelete() or BtreePutData() is called to
5750** modify a table row via an SQL statement, pExclude is set to the
5751** write cursor used to do the modification and parameter iRow is set
5752** to the integer row id of the B-Tree entry being modified. Unless
5753** pExclude is itself an incremental blob cursor, then all incremental
5754** blob cursors open on row iRow of the B-Tree are invalidated.
5755**
5756** 3) If both pExclude and iRow are set to zero, no incremental blob
5757** cursors are invalidated.
drhf74b8d92002-09-01 23:20:45 +00005758*/
danielk19773588ceb2008-06-10 17:30:26 +00005759static int checkReadLocks(
5760 Btree *pBtree,
5761 Pgno pgnoRoot,
5762 BtCursor *pExclude,
5763 i64 iRow
5764){
danielk1977299b1872004-11-22 10:02:10 +00005765 BtCursor *p;
drh980b1a72006-08-16 16:42:48 +00005766 BtShared *pBt = pBtree->pBt;
drhe5fe6902007-12-07 18:55:28 +00005767 sqlite3 *db = pBtree->db;
drh1fee73e2007-08-29 04:00:57 +00005768 assert( sqlite3BtreeHoldsMutex(pBtree) );
danielk1977299b1872004-11-22 10:02:10 +00005769 for(p=pBt->pCursor; p; p=p->pNext){
drh980b1a72006-08-16 16:42:48 +00005770 if( p==pExclude ) continue;
drh980b1a72006-08-16 16:42:48 +00005771 if( p->pgnoRoot!=pgnoRoot ) continue;
danielk19773588ceb2008-06-10 17:30:26 +00005772#ifndef SQLITE_OMIT_INCRBLOB
5773 if( p->isIncrblobHandle && (
5774 (!pExclude && iRow)
5775 || (pExclude && !pExclude->isIncrblobHandle && p->info.nKey==iRow)
5776 )){
5777 p->eState = CURSOR_INVALID;
5778 }
5779#endif
5780 if( p->eState!=CURSOR_VALID ) continue;
5781 if( p->wrFlag==0
5782#ifndef SQLITE_OMIT_INCRBLOB
5783 || p->isIncrblobHandle
5784#endif
5785 ){
drhe5fe6902007-12-07 18:55:28 +00005786 sqlite3 *dbOther = p->pBtree->db;
drh980b1a72006-08-16 16:42:48 +00005787 if( dbOther==0 ||
5788 (dbOther!=db && (dbOther->flags & SQLITE_ReadUncommitted)==0) ){
5789 return SQLITE_LOCKED;
5790 }
danielk1977299b1872004-11-22 10:02:10 +00005791 }
5792 }
drhf74b8d92002-09-01 23:20:45 +00005793 return SQLITE_OK;
5794}
5795
5796/*
drh3b7511c2001-05-26 13:15:44 +00005797** Insert a new record into the BTree. The key is given by (pKey,nKey)
5798** and the data is given by (pData,nData). The cursor is used only to
drh91025292004-05-03 19:49:32 +00005799** define what table the record should be inserted into. The cursor
drh4b70f112004-05-02 21:12:19 +00005800** is left pointing at a random location.
5801**
5802** For an INTKEY table, only the nKey value of the key is used. pKey is
5803** ignored. For a ZERODATA table, the pData and nData are both ignored.
drh3b7511c2001-05-26 13:15:44 +00005804*/
drh3aac2dd2004-04-26 14:10:20 +00005805int sqlite3BtreeInsert(
drh5c4d9702001-08-20 00:33:58 +00005806 BtCursor *pCur, /* Insert data into the table of this cursor */
drh4a1c3802004-05-12 15:15:47 +00005807 const void *pKey, i64 nKey, /* The key of the new record */
drhe4d90812007-03-29 05:51:49 +00005808 const void *pData, int nData, /* The data of the new record */
drhb026e052007-05-02 01:34:31 +00005809 int nZero, /* Number of extra 0 bytes to append to data */
drhe4d90812007-03-29 05:51:49 +00005810 int appendBias /* True if this is likely an append */
drh3b7511c2001-05-26 13:15:44 +00005811){
drh3b7511c2001-05-26 13:15:44 +00005812 int rc;
5813 int loc;
drh14acc042001-06-10 19:56:58 +00005814 int szNew;
drh3b7511c2001-05-26 13:15:44 +00005815 MemPage *pPage;
drhd677b3d2007-08-20 22:48:41 +00005816 Btree *p = pCur->pBtree;
5817 BtShared *pBt = p->pBt;
drha34b6762004-05-07 13:30:42 +00005818 unsigned char *oldCell;
drh2e38c322004-09-03 18:38:44 +00005819 unsigned char *newCell = 0;
drh3b7511c2001-05-26 13:15:44 +00005820
drh1fee73e2007-08-29 04:00:57 +00005821 assert( cursorHoldsMutex(pCur) );
danielk1977aef0bf62005-12-30 16:28:01 +00005822 if( pBt->inTransaction!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00005823 /* Must start a transaction before doing an insert */
drhd677b3d2007-08-20 22:48:41 +00005824 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drhd677b3d2007-08-20 22:48:41 +00005825 return rc;
drh8b2f49b2001-06-08 00:21:52 +00005826 }
drhf74b8d92002-09-01 23:20:45 +00005827 assert( !pBt->readOnly );
drhecdc7532001-09-23 02:35:53 +00005828 if( !pCur->wrFlag ){
5829 return SQLITE_PERM; /* Cursor not open for writing */
5830 }
danielk19773588ceb2008-06-10 17:30:26 +00005831 if( checkReadLocks(pCur->pBtree, pCur->pgnoRoot, pCur, nKey) ){
drhf74b8d92002-09-01 23:20:45 +00005832 return SQLITE_LOCKED; /* The table pCur points to has a read lock */
5833 }
drhfb982642007-08-30 01:19:59 +00005834 if( pCur->eState==CURSOR_FAULT ){
5835 return pCur->skip;
5836 }
danielk1977da184232006-01-05 11:34:32 +00005837
5838 /* Save the positions of any other cursors open on this table */
drhbf700f32007-03-31 02:36:44 +00005839 clearCursorPosition(pCur);
danielk19772e94d4d2006-01-09 05:36:27 +00005840 if(
danielk19772e94d4d2006-01-09 05:36:27 +00005841 SQLITE_OK!=(rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur)) ||
drhe63d9992008-08-13 19:11:48 +00005842 SQLITE_OK!=(rc = sqlite3BtreeMoveto(pCur, pKey, nKey, appendBias, &loc))
danielk19772e94d4d2006-01-09 05:36:27 +00005843 ){
danielk1977da184232006-01-05 11:34:32 +00005844 return rc;
5845 }
5846
drh14acc042001-06-10 19:56:58 +00005847 pPage = pCur->pPage;
drh4a1c3802004-05-12 15:15:47 +00005848 assert( pPage->intKey || nKey>=0 );
drh44845222008-07-17 18:39:57 +00005849 assert( pPage->leaf || !pPage->intKey );
drh3a4c1412004-05-09 20:40:11 +00005850 TRACE(("INSERT: table=%d nkey=%lld ndata=%d page=%d %s\n",
5851 pCur->pgnoRoot, nKey, nData, pPage->pgno,
5852 loc==0 ? "overwrite" : "new entry"));
drh7aa128d2002-06-21 13:09:16 +00005853 assert( pPage->isInit );
danielk197752ae7242008-03-25 14:24:56 +00005854 allocateTempSpace(pBt);
5855 newCell = pBt->pTmpSpace;
drh2e38c322004-09-03 18:38:44 +00005856 if( newCell==0 ) return SQLITE_NOMEM;
drhb026e052007-05-02 01:34:31 +00005857 rc = fillInCell(pPage, newCell, pKey, nKey, pData, nData, nZero, &szNew);
drh2e38c322004-09-03 18:38:44 +00005858 if( rc ) goto end_insert;
drh43605152004-05-29 21:46:49 +00005859 assert( szNew==cellSizePtr(pPage, newCell) );
drh2e38c322004-09-03 18:38:44 +00005860 assert( szNew<=MX_CELL_SIZE(pBt) );
danielk1977da184232006-01-05 11:34:32 +00005861 if( loc==0 && CURSOR_VALID==pCur->eState ){
drha9121e42008-02-19 14:59:35 +00005862 u16 szOld;
drha34b6762004-05-07 13:30:42 +00005863 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
danielk19776e465eb2007-08-21 13:11:00 +00005864 rc = sqlite3PagerWrite(pPage->pDbPage);
5865 if( rc ){
5866 goto end_insert;
5867 }
danielk19771cc5ed82007-05-16 17:28:43 +00005868 oldCell = findCell(pPage, pCur->idx);
drh4b70f112004-05-02 21:12:19 +00005869 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005870 memcpy(newCell, oldCell, 4);
drh4b70f112004-05-02 21:12:19 +00005871 }
drh43605152004-05-29 21:46:49 +00005872 szOld = cellSizePtr(pPage, oldCell);
drh4b70f112004-05-02 21:12:19 +00005873 rc = clearCell(pPage, oldCell);
drh2e38c322004-09-03 18:38:44 +00005874 if( rc ) goto end_insert;
drh4b70f112004-05-02 21:12:19 +00005875 dropCell(pPage, pCur->idx, szOld);
drh7c717f72001-06-24 20:39:41 +00005876 }else if( loc<0 && pPage->nCell>0 ){
drh4b70f112004-05-02 21:12:19 +00005877 assert( pPage->leaf );
drh14acc042001-06-10 19:56:58 +00005878 pCur->idx++;
drh271efa52004-05-30 19:19:05 +00005879 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00005880 pCur->validNKey = 0;
drh14acc042001-06-10 19:56:58 +00005881 }else{
drh4b70f112004-05-02 21:12:19 +00005882 assert( pPage->leaf );
drh3b7511c2001-05-26 13:15:44 +00005883 }
danielk1977a3ad5e72005-01-07 08:56:44 +00005884 rc = insertCell(pPage, pCur->idx, newCell, szNew, 0, 0);
danielk1977e80463b2004-11-03 03:01:16 +00005885 if( rc!=SQLITE_OK ) goto end_insert;
danielk1977ac245ec2005-01-14 13:50:11 +00005886 rc = balance(pPage, 1);
danielk1977299b1872004-11-22 10:02:10 +00005887 if( rc==SQLITE_OK ){
5888 moveToRoot(pCur);
5889 }
drh2e38c322004-09-03 18:38:44 +00005890end_insert:
drh5e2f8b92001-05-28 00:41:15 +00005891 return rc;
5892}
5893
5894/*
drh4b70f112004-05-02 21:12:19 +00005895** Delete the entry that the cursor is pointing to. The cursor
5896** is left pointing at a random location.
drh3b7511c2001-05-26 13:15:44 +00005897*/
drh3aac2dd2004-04-26 14:10:20 +00005898int sqlite3BtreeDelete(BtCursor *pCur){
drh5e2f8b92001-05-28 00:41:15 +00005899 MemPage *pPage = pCur->pPage;
drh4b70f112004-05-02 21:12:19 +00005900 unsigned char *pCell;
drh5e2f8b92001-05-28 00:41:15 +00005901 int rc;
danielk1977cfe9a692004-06-16 12:00:29 +00005902 Pgno pgnoChild = 0;
drhd677b3d2007-08-20 22:48:41 +00005903 Btree *p = pCur->pBtree;
5904 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00005905
drh1fee73e2007-08-29 04:00:57 +00005906 assert( cursorHoldsMutex(pCur) );
drh7aa128d2002-06-21 13:09:16 +00005907 assert( pPage->isInit );
danielk1977aef0bf62005-12-30 16:28:01 +00005908 if( pBt->inTransaction!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00005909 /* Must start a transaction before doing a delete */
drhd677b3d2007-08-20 22:48:41 +00005910 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drhd677b3d2007-08-20 22:48:41 +00005911 return rc;
drh8b2f49b2001-06-08 00:21:52 +00005912 }
drhf74b8d92002-09-01 23:20:45 +00005913 assert( !pBt->readOnly );
drhfb982642007-08-30 01:19:59 +00005914 if( pCur->eState==CURSOR_FAULT ){
5915 return pCur->skip;
5916 }
drhbd03cae2001-06-02 02:40:57 +00005917 if( pCur->idx >= pPage->nCell ){
5918 return SQLITE_ERROR; /* The cursor is not pointing to anything */
5919 }
drhecdc7532001-09-23 02:35:53 +00005920 if( !pCur->wrFlag ){
5921 return SQLITE_PERM; /* Did not open this cursor for writing */
5922 }
danielk19773588ceb2008-06-10 17:30:26 +00005923 if( checkReadLocks(pCur->pBtree, pCur->pgnoRoot, pCur, pCur->info.nKey) ){
drhf74b8d92002-09-01 23:20:45 +00005924 return SQLITE_LOCKED; /* The table pCur points to has a read lock */
5925 }
danielk1977da184232006-01-05 11:34:32 +00005926
5927 /* Restore the current cursor position (a no-op if the cursor is not in
5928 ** CURSOR_REQUIRESEEK state) and save the positions of any other cursors
danielk19773b8a05f2007-03-19 17:44:26 +00005929 ** open on the same table. Then call sqlite3PagerWrite() on the page
danielk1977da184232006-01-05 11:34:32 +00005930 ** that the entry will be deleted from.
5931 */
5932 if(
drha3460582008-07-11 21:02:53 +00005933 (rc = restoreCursorPosition(pCur))!=0 ||
drhd1167392006-01-23 13:00:35 +00005934 (rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur))!=0 ||
danielk19773b8a05f2007-03-19 17:44:26 +00005935 (rc = sqlite3PagerWrite(pPage->pDbPage))!=0
danielk1977da184232006-01-05 11:34:32 +00005936 ){
5937 return rc;
5938 }
danielk1977e6efa742004-11-10 11:55:10 +00005939
drh85b623f2007-12-13 21:54:09 +00005940 /* Locate the cell within its page and leave pCell pointing to the
danielk1977e6efa742004-11-10 11:55:10 +00005941 ** data. The clearCell() call frees any overflow pages associated with the
5942 ** cell. The cell itself is still intact.
5943 */
danielk19771cc5ed82007-05-16 17:28:43 +00005944 pCell = findCell(pPage, pCur->idx);
drh4b70f112004-05-02 21:12:19 +00005945 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005946 pgnoChild = get4byte(pCell);
drh4b70f112004-05-02 21:12:19 +00005947 }
danielk197728129562005-01-11 10:25:06 +00005948 rc = clearCell(pPage, pCell);
drhd677b3d2007-08-20 22:48:41 +00005949 if( rc ){
drhd677b3d2007-08-20 22:48:41 +00005950 return rc;
5951 }
danielk1977e6efa742004-11-10 11:55:10 +00005952
drh4b70f112004-05-02 21:12:19 +00005953 if( !pPage->leaf ){
drh14acc042001-06-10 19:56:58 +00005954 /*
drh5e00f6c2001-09-13 13:46:56 +00005955 ** The entry we are about to delete is not a leaf so if we do not
drh9ca7d3b2001-06-28 11:50:21 +00005956 ** do something we will leave a hole on an internal page.
5957 ** We have to fill the hole by moving in a cell from a leaf. The
5958 ** next Cell after the one to be deleted is guaranteed to exist and
danielk1977299b1872004-11-22 10:02:10 +00005959 ** to be a leaf so we can use it.
drh5e2f8b92001-05-28 00:41:15 +00005960 */
drh14acc042001-06-10 19:56:58 +00005961 BtCursor leafCur;
drh4b70f112004-05-02 21:12:19 +00005962 unsigned char *pNext;
danielk1977299b1872004-11-22 10:02:10 +00005963 int notUsed;
danielk19776b456a22005-03-21 04:04:02 +00005964 unsigned char *tempCell = 0;
drh44845222008-07-17 18:39:57 +00005965 assert( !pPage->intKey );
drh16a9b832007-05-05 18:39:25 +00005966 sqlite3BtreeGetTempCursor(pCur, &leafCur);
danielk1977299b1872004-11-22 10:02:10 +00005967 rc = sqlite3BtreeNext(&leafCur, &notUsed);
danielk19776b456a22005-03-21 04:04:02 +00005968 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00005969 rc = sqlite3PagerWrite(leafCur.pPage->pDbPage);
danielk19776b456a22005-03-21 04:04:02 +00005970 }
5971 if( rc==SQLITE_OK ){
drha9121e42008-02-19 14:59:35 +00005972 u16 szNext;
danielk19776b456a22005-03-21 04:04:02 +00005973 TRACE(("DELETE: table=%d delete internal from %d replace from leaf %d\n",
5974 pCur->pgnoRoot, pPage->pgno, leafCur.pPage->pgno));
5975 dropCell(pPage, pCur->idx, cellSizePtr(pPage, pCell));
danielk19771cc5ed82007-05-16 17:28:43 +00005976 pNext = findCell(leafCur.pPage, leafCur.idx);
danielk19776b456a22005-03-21 04:04:02 +00005977 szNext = cellSizePtr(leafCur.pPage, pNext);
5978 assert( MX_CELL_SIZE(pBt)>=szNext+4 );
danielk197752ae7242008-03-25 14:24:56 +00005979 allocateTempSpace(pBt);
5980 tempCell = pBt->pTmpSpace;
danielk19776b456a22005-03-21 04:04:02 +00005981 if( tempCell==0 ){
5982 rc = SQLITE_NOMEM;
5983 }
danielk19778ea1cfa2008-01-01 06:19:02 +00005984 if( rc==SQLITE_OK ){
5985 rc = insertCell(pPage, pCur->idx, pNext-4, szNext+4, tempCell, 0);
5986 }
5987 if( rc==SQLITE_OK ){
5988 put4byte(findOverflowCell(pPage, pCur->idx), pgnoChild);
5989 rc = balance(pPage, 0);
5990 }
5991 if( rc==SQLITE_OK ){
5992 dropCell(leafCur.pPage, leafCur.idx, szNext);
5993 rc = balance(leafCur.pPage, 0);
5994 }
danielk19776b456a22005-03-21 04:04:02 +00005995 }
drh16a9b832007-05-05 18:39:25 +00005996 sqlite3BtreeReleaseTempCursor(&leafCur);
drh5e2f8b92001-05-28 00:41:15 +00005997 }else{
danielk1977299b1872004-11-22 10:02:10 +00005998 TRACE(("DELETE: table=%d delete from leaf %d\n",
5999 pCur->pgnoRoot, pPage->pgno));
6000 dropCell(pPage, pCur->idx, cellSizePtr(pPage, pCell));
danielk1977ac245ec2005-01-14 13:50:11 +00006001 rc = balance(pPage, 0);
drh5e2f8b92001-05-28 00:41:15 +00006002 }
danielk19776b456a22005-03-21 04:04:02 +00006003 if( rc==SQLITE_OK ){
6004 moveToRoot(pCur);
6005 }
drh5e2f8b92001-05-28 00:41:15 +00006006 return rc;
drh3b7511c2001-05-26 13:15:44 +00006007}
drh8b2f49b2001-06-08 00:21:52 +00006008
6009/*
drhc6b52df2002-01-04 03:09:29 +00006010** Create a new BTree table. Write into *piTable the page
6011** number for the root page of the new table.
6012**
drhab01f612004-05-22 02:55:23 +00006013** The type of type is determined by the flags parameter. Only the
6014** following values of flags are currently in use. Other values for
6015** flags might not work:
6016**
6017** BTREE_INTKEY|BTREE_LEAFDATA Used for SQL tables with rowid keys
6018** BTREE_ZERODATA Used for SQL indices
drh8b2f49b2001-06-08 00:21:52 +00006019*/
drhd677b3d2007-08-20 22:48:41 +00006020static int btreeCreateTable(Btree *p, int *piTable, int flags){
danielk1977aef0bf62005-12-30 16:28:01 +00006021 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00006022 MemPage *pRoot;
6023 Pgno pgnoRoot;
6024 int rc;
drhd677b3d2007-08-20 22:48:41 +00006025
drh1fee73e2007-08-29 04:00:57 +00006026 assert( sqlite3BtreeHoldsMutex(p) );
danielk1977aef0bf62005-12-30 16:28:01 +00006027 if( pBt->inTransaction!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00006028 /* Must start a transaction first */
drhd677b3d2007-08-20 22:48:41 +00006029 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
6030 return rc;
drh8b2f49b2001-06-08 00:21:52 +00006031 }
danielk197728129562005-01-11 10:25:06 +00006032 assert( !pBt->readOnly );
danielk1977e6efa742004-11-10 11:55:10 +00006033
danielk1977003ba062004-11-04 02:57:33 +00006034#ifdef SQLITE_OMIT_AUTOVACUUM
drh4f0c5872007-03-26 22:05:01 +00006035 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
drhd677b3d2007-08-20 22:48:41 +00006036 if( rc ){
6037 return rc;
6038 }
danielk1977003ba062004-11-04 02:57:33 +00006039#else
danielk1977687566d2004-11-02 12:56:41 +00006040 if( pBt->autoVacuum ){
danielk1977003ba062004-11-04 02:57:33 +00006041 Pgno pgnoMove; /* Move a page here to make room for the root-page */
6042 MemPage *pPageMove; /* The page to move to. */
6043
danielk197720713f32007-05-03 11:43:33 +00006044 /* Creating a new table may probably require moving an existing database
6045 ** to make room for the new tables root page. In case this page turns
6046 ** out to be an overflow page, delete all overflow page-map caches
6047 ** held by open cursors.
6048 */
danielk197792d4d7a2007-05-04 12:05:56 +00006049 invalidateAllOverflowCache(pBt);
danielk197720713f32007-05-03 11:43:33 +00006050
danielk1977003ba062004-11-04 02:57:33 +00006051 /* Read the value of meta[3] from the database to determine where the
6052 ** root page of the new table should go. meta[3] is the largest root-page
6053 ** created so far, so the new root-page is (meta[3]+1).
6054 */
danielk1977aef0bf62005-12-30 16:28:01 +00006055 rc = sqlite3BtreeGetMeta(p, 4, &pgnoRoot);
drhd677b3d2007-08-20 22:48:41 +00006056 if( rc!=SQLITE_OK ){
6057 return rc;
6058 }
danielk1977003ba062004-11-04 02:57:33 +00006059 pgnoRoot++;
6060
danielk1977599fcba2004-11-08 07:13:13 +00006061 /* The new root-page may not be allocated on a pointer-map page, or the
6062 ** PENDING_BYTE page.
6063 */
drh72190432008-01-31 14:54:43 +00006064 while( pgnoRoot==PTRMAP_PAGENO(pBt, pgnoRoot) ||
danielk1977599fcba2004-11-08 07:13:13 +00006065 pgnoRoot==PENDING_BYTE_PAGE(pBt) ){
danielk1977003ba062004-11-04 02:57:33 +00006066 pgnoRoot++;
6067 }
6068 assert( pgnoRoot>=3 );
6069
6070 /* Allocate a page. The page that currently resides at pgnoRoot will
6071 ** be moved to the allocated page (unless the allocated page happens
6072 ** to reside at pgnoRoot).
6073 */
drh4f0c5872007-03-26 22:05:01 +00006074 rc = allocateBtreePage(pBt, &pPageMove, &pgnoMove, pgnoRoot, 1);
danielk1977003ba062004-11-04 02:57:33 +00006075 if( rc!=SQLITE_OK ){
danielk1977687566d2004-11-02 12:56:41 +00006076 return rc;
6077 }
danielk1977003ba062004-11-04 02:57:33 +00006078
6079 if( pgnoMove!=pgnoRoot ){
danielk1977f35843b2007-04-07 15:03:17 +00006080 /* pgnoRoot is the page that will be used for the root-page of
6081 ** the new table (assuming an error did not occur). But we were
6082 ** allocated pgnoMove. If required (i.e. if it was not allocated
6083 ** by extending the file), the current page at position pgnoMove
6084 ** is already journaled.
6085 */
danielk1977003ba062004-11-04 02:57:33 +00006086 u8 eType;
6087 Pgno iPtrPage;
6088
6089 releasePage(pPageMove);
danielk1977f35843b2007-04-07 15:03:17 +00006090
6091 /* Move the page currently at pgnoRoot to pgnoMove. */
drh16a9b832007-05-05 18:39:25 +00006092 rc = sqlite3BtreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00006093 if( rc!=SQLITE_OK ){
6094 return rc;
6095 }
6096 rc = ptrmapGet(pBt, pgnoRoot, &eType, &iPtrPage);
drhccae6022005-02-26 17:31:26 +00006097 if( rc!=SQLITE_OK || eType==PTRMAP_ROOTPAGE || eType==PTRMAP_FREEPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00006098 releasePage(pRoot);
6099 return rc;
6100 }
drhccae6022005-02-26 17:31:26 +00006101 assert( eType!=PTRMAP_ROOTPAGE );
6102 assert( eType!=PTRMAP_FREEPAGE );
danielk19773b8a05f2007-03-19 17:44:26 +00006103 rc = sqlite3PagerWrite(pRoot->pDbPage);
danielk19775fd057a2005-03-09 13:09:43 +00006104 if( rc!=SQLITE_OK ){
6105 releasePage(pRoot);
6106 return rc;
6107 }
danielk19774c999992008-07-16 18:17:55 +00006108 rc = relocatePage(pBt, pRoot, eType, iPtrPage, pgnoMove, 0);
danielk1977003ba062004-11-04 02:57:33 +00006109 releasePage(pRoot);
danielk1977f35843b2007-04-07 15:03:17 +00006110
6111 /* Obtain the page at pgnoRoot */
danielk1977003ba062004-11-04 02:57:33 +00006112 if( rc!=SQLITE_OK ){
6113 return rc;
6114 }
drh16a9b832007-05-05 18:39:25 +00006115 rc = sqlite3BtreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00006116 if( rc!=SQLITE_OK ){
6117 return rc;
6118 }
danielk19773b8a05f2007-03-19 17:44:26 +00006119 rc = sqlite3PagerWrite(pRoot->pDbPage);
danielk1977003ba062004-11-04 02:57:33 +00006120 if( rc!=SQLITE_OK ){
6121 releasePage(pRoot);
6122 return rc;
6123 }
6124 }else{
6125 pRoot = pPageMove;
6126 }
6127
danielk197742741be2005-01-08 12:42:39 +00006128 /* Update the pointer-map and meta-data with the new root-page number. */
danielk1977003ba062004-11-04 02:57:33 +00006129 rc = ptrmapPut(pBt, pgnoRoot, PTRMAP_ROOTPAGE, 0);
6130 if( rc ){
6131 releasePage(pRoot);
6132 return rc;
6133 }
danielk1977aef0bf62005-12-30 16:28:01 +00006134 rc = sqlite3BtreeUpdateMeta(p, 4, pgnoRoot);
danielk1977003ba062004-11-04 02:57:33 +00006135 if( rc ){
6136 releasePage(pRoot);
6137 return rc;
6138 }
danielk197742741be2005-01-08 12:42:39 +00006139
danielk1977003ba062004-11-04 02:57:33 +00006140 }else{
drh4f0c5872007-03-26 22:05:01 +00006141 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
danielk1977003ba062004-11-04 02:57:33 +00006142 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00006143 }
6144#endif
danielk19773b8a05f2007-03-19 17:44:26 +00006145 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
drhde647132004-05-07 17:57:49 +00006146 zeroPage(pRoot, flags | PTF_LEAF);
danielk19773b8a05f2007-03-19 17:44:26 +00006147 sqlite3PagerUnref(pRoot->pDbPage);
drh8b2f49b2001-06-08 00:21:52 +00006148 *piTable = (int)pgnoRoot;
6149 return SQLITE_OK;
6150}
drhd677b3d2007-08-20 22:48:41 +00006151int sqlite3BtreeCreateTable(Btree *p, int *piTable, int flags){
6152 int rc;
6153 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006154 p->pBt->db = p->db;
drhd677b3d2007-08-20 22:48:41 +00006155 rc = btreeCreateTable(p, piTable, flags);
6156 sqlite3BtreeLeave(p);
6157 return rc;
6158}
drh8b2f49b2001-06-08 00:21:52 +00006159
6160/*
6161** Erase the given database page and all its children. Return
6162** the page to the freelist.
6163*/
drh4b70f112004-05-02 21:12:19 +00006164static int clearDatabasePage(
danielk1977aef0bf62005-12-30 16:28:01 +00006165 BtShared *pBt, /* The BTree that contains the table */
drh4b70f112004-05-02 21:12:19 +00006166 Pgno pgno, /* Page number to clear */
6167 MemPage *pParent, /* Parent page. NULL for the root */
6168 int freePageFlag /* Deallocate page if true */
6169){
danielk19776b456a22005-03-21 04:04:02 +00006170 MemPage *pPage = 0;
drh8b2f49b2001-06-08 00:21:52 +00006171 int rc;
drh4b70f112004-05-02 21:12:19 +00006172 unsigned char *pCell;
6173 int i;
drh8b2f49b2001-06-08 00:21:52 +00006174
drh1fee73e2007-08-29 04:00:57 +00006175 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977ad0132d2008-06-07 08:58:22 +00006176 if( pgno>pagerPagecount(pBt->pPager) ){
drh49285702005-09-17 15:20:26 +00006177 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00006178 }
6179
drhde647132004-05-07 17:57:49 +00006180 rc = getAndInitPage(pBt, pgno, &pPage, pParent);
danielk19776b456a22005-03-21 04:04:02 +00006181 if( rc ) goto cleardatabasepage_out;
drh4b70f112004-05-02 21:12:19 +00006182 for(i=0; i<pPage->nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00006183 pCell = findCell(pPage, i);
drh4b70f112004-05-02 21:12:19 +00006184 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00006185 rc = clearDatabasePage(pBt, get4byte(pCell), pPage->pParent, 1);
danielk19776b456a22005-03-21 04:04:02 +00006186 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00006187 }
drh4b70f112004-05-02 21:12:19 +00006188 rc = clearCell(pPage, pCell);
danielk19776b456a22005-03-21 04:04:02 +00006189 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00006190 }
drha34b6762004-05-07 13:30:42 +00006191 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00006192 rc = clearDatabasePage(pBt, get4byte(&pPage->aData[8]), pPage->pParent, 1);
danielk19776b456a22005-03-21 04:04:02 +00006193 if( rc ) goto cleardatabasepage_out;
drh2aa679f2001-06-25 02:11:07 +00006194 }
6195 if( freePageFlag ){
drh4b70f112004-05-02 21:12:19 +00006196 rc = freePage(pPage);
danielk19773b8a05f2007-03-19 17:44:26 +00006197 }else if( (rc = sqlite3PagerWrite(pPage->pDbPage))==0 ){
drh3a4c1412004-05-09 20:40:11 +00006198 zeroPage(pPage, pPage->aData[0] | PTF_LEAF);
drh2aa679f2001-06-25 02:11:07 +00006199 }
danielk19776b456a22005-03-21 04:04:02 +00006200
6201cleardatabasepage_out:
drh4b70f112004-05-02 21:12:19 +00006202 releasePage(pPage);
drh2aa679f2001-06-25 02:11:07 +00006203 return rc;
drh8b2f49b2001-06-08 00:21:52 +00006204}
6205
6206/*
drhab01f612004-05-22 02:55:23 +00006207** Delete all information from a single table in the database. iTable is
6208** the page number of the root of the table. After this routine returns,
6209** the root page is empty, but still exists.
6210**
6211** This routine will fail with SQLITE_LOCKED if there are any open
6212** read cursors on the table. Open write cursors are moved to the
6213** root of the table.
drh8b2f49b2001-06-08 00:21:52 +00006214*/
danielk1977aef0bf62005-12-30 16:28:01 +00006215int sqlite3BtreeClearTable(Btree *p, int iTable){
drh8b2f49b2001-06-08 00:21:52 +00006216 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00006217 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00006218 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006219 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00006220 if( p->inTrans!=TRANS_WRITE ){
drhd677b3d2007-08-20 22:48:41 +00006221 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
danielk19773588ceb2008-06-10 17:30:26 +00006222 }else if( (rc = checkReadLocks(p, iTable, 0, 1))!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00006223 /* nothing to do */
6224 }else if( SQLITE_OK!=(rc = saveAllCursors(pBt, iTable, 0)) ){
6225 /* nothing to do */
6226 }else{
6227 rc = clearDatabasePage(pBt, (Pgno)iTable, 0, 0);
drh8b2f49b2001-06-08 00:21:52 +00006228 }
drhd677b3d2007-08-20 22:48:41 +00006229 sqlite3BtreeLeave(p);
6230 return rc;
drh8b2f49b2001-06-08 00:21:52 +00006231}
6232
6233/*
6234** Erase all information in a table and add the root of the table to
6235** the freelist. Except, the root of the principle table (the one on
drhab01f612004-05-22 02:55:23 +00006236** page 1) is never added to the freelist.
6237**
6238** This routine will fail with SQLITE_LOCKED if there are any open
6239** cursors on the table.
drh205f48e2004-11-05 00:43:11 +00006240**
6241** If AUTOVACUUM is enabled and the page at iTable is not the last
6242** root page in the database file, then the last root page
6243** in the database file is moved into the slot formerly occupied by
6244** iTable and that last slot formerly occupied by the last root page
6245** is added to the freelist instead of iTable. In this say, all
6246** root pages are kept at the beginning of the database file, which
6247** is necessary for AUTOVACUUM to work right. *piMoved is set to the
6248** page number that used to be the last root page in the file before
6249** the move. If no page gets moved, *piMoved is set to 0.
6250** The last root page is recorded in meta[3] and the value of
6251** meta[3] is updated by this procedure.
drh8b2f49b2001-06-08 00:21:52 +00006252*/
drhd677b3d2007-08-20 22:48:41 +00006253static int btreeDropTable(Btree *p, int iTable, int *piMoved){
drh8b2f49b2001-06-08 00:21:52 +00006254 int rc;
danielk1977a0bf2652004-11-04 14:30:04 +00006255 MemPage *pPage = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00006256 BtShared *pBt = p->pBt;
danielk1977a0bf2652004-11-04 14:30:04 +00006257
drh1fee73e2007-08-29 04:00:57 +00006258 assert( sqlite3BtreeHoldsMutex(p) );
danielk1977aef0bf62005-12-30 16:28:01 +00006259 if( p->inTrans!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00006260 return pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drh8b2f49b2001-06-08 00:21:52 +00006261 }
danielk1977a0bf2652004-11-04 14:30:04 +00006262
danielk1977e6efa742004-11-10 11:55:10 +00006263 /* It is illegal to drop a table if any cursors are open on the
6264 ** database. This is because in auto-vacuum mode the backend may
6265 ** need to move another root-page to fill a gap left by the deleted
6266 ** root page. If an open cursor was using this page a problem would
6267 ** occur.
6268 */
6269 if( pBt->pCursor ){
6270 return SQLITE_LOCKED;
drh5df72a52002-06-06 23:16:05 +00006271 }
danielk1977a0bf2652004-11-04 14:30:04 +00006272
drh16a9b832007-05-05 18:39:25 +00006273 rc = sqlite3BtreeGetPage(pBt, (Pgno)iTable, &pPage, 0);
drh2aa679f2001-06-25 02:11:07 +00006274 if( rc ) return rc;
danielk1977aef0bf62005-12-30 16:28:01 +00006275 rc = sqlite3BtreeClearTable(p, iTable);
danielk19776b456a22005-03-21 04:04:02 +00006276 if( rc ){
6277 releasePage(pPage);
6278 return rc;
6279 }
danielk1977a0bf2652004-11-04 14:30:04 +00006280
drh205f48e2004-11-05 00:43:11 +00006281 *piMoved = 0;
danielk1977a0bf2652004-11-04 14:30:04 +00006282
drh4b70f112004-05-02 21:12:19 +00006283 if( iTable>1 ){
danielk1977a0bf2652004-11-04 14:30:04 +00006284#ifdef SQLITE_OMIT_AUTOVACUUM
drha34b6762004-05-07 13:30:42 +00006285 rc = freePage(pPage);
danielk1977a0bf2652004-11-04 14:30:04 +00006286 releasePage(pPage);
6287#else
6288 if( pBt->autoVacuum ){
6289 Pgno maxRootPgno;
danielk1977aef0bf62005-12-30 16:28:01 +00006290 rc = sqlite3BtreeGetMeta(p, 4, &maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00006291 if( rc!=SQLITE_OK ){
6292 releasePage(pPage);
6293 return rc;
6294 }
6295
6296 if( iTable==maxRootPgno ){
6297 /* If the table being dropped is the table with the largest root-page
6298 ** number in the database, put the root page on the free list.
6299 */
6300 rc = freePage(pPage);
6301 releasePage(pPage);
6302 if( rc!=SQLITE_OK ){
6303 return rc;
6304 }
6305 }else{
6306 /* The table being dropped does not have the largest root-page
6307 ** number in the database. So move the page that does into the
6308 ** gap left by the deleted root-page.
6309 */
6310 MemPage *pMove;
6311 releasePage(pPage);
drh16a9b832007-05-05 18:39:25 +00006312 rc = sqlite3BtreeGetPage(pBt, maxRootPgno, &pMove, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00006313 if( rc!=SQLITE_OK ){
6314 return rc;
6315 }
danielk19774c999992008-07-16 18:17:55 +00006316 rc = relocatePage(pBt, pMove, PTRMAP_ROOTPAGE, 0, iTable, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00006317 releasePage(pMove);
6318 if( rc!=SQLITE_OK ){
6319 return rc;
6320 }
drh16a9b832007-05-05 18:39:25 +00006321 rc = sqlite3BtreeGetPage(pBt, maxRootPgno, &pMove, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00006322 if( rc!=SQLITE_OK ){
6323 return rc;
6324 }
6325 rc = freePage(pMove);
6326 releasePage(pMove);
6327 if( rc!=SQLITE_OK ){
6328 return rc;
6329 }
6330 *piMoved = maxRootPgno;
6331 }
6332
danielk1977599fcba2004-11-08 07:13:13 +00006333 /* Set the new 'max-root-page' value in the database header. This
6334 ** is the old value less one, less one more if that happens to
6335 ** be a root-page number, less one again if that is the
6336 ** PENDING_BYTE_PAGE.
6337 */
danielk197787a6e732004-11-05 12:58:25 +00006338 maxRootPgno--;
danielk1977599fcba2004-11-08 07:13:13 +00006339 if( maxRootPgno==PENDING_BYTE_PAGE(pBt) ){
6340 maxRootPgno--;
6341 }
danielk1977266664d2006-02-10 08:24:21 +00006342 if( maxRootPgno==PTRMAP_PAGENO(pBt, maxRootPgno) ){
danielk197787a6e732004-11-05 12:58:25 +00006343 maxRootPgno--;
6344 }
danielk1977599fcba2004-11-08 07:13:13 +00006345 assert( maxRootPgno!=PENDING_BYTE_PAGE(pBt) );
6346
danielk1977aef0bf62005-12-30 16:28:01 +00006347 rc = sqlite3BtreeUpdateMeta(p, 4, maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00006348 }else{
6349 rc = freePage(pPage);
6350 releasePage(pPage);
6351 }
6352#endif
drh2aa679f2001-06-25 02:11:07 +00006353 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00006354 /* If sqlite3BtreeDropTable was called on page 1. */
drha34b6762004-05-07 13:30:42 +00006355 zeroPage(pPage, PTF_INTKEY|PTF_LEAF );
danielk1977a0bf2652004-11-04 14:30:04 +00006356 releasePage(pPage);
drh8b2f49b2001-06-08 00:21:52 +00006357 }
drh8b2f49b2001-06-08 00:21:52 +00006358 return rc;
6359}
drhd677b3d2007-08-20 22:48:41 +00006360int sqlite3BtreeDropTable(Btree *p, int iTable, int *piMoved){
6361 int rc;
6362 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006363 p->pBt->db = p->db;
drhd677b3d2007-08-20 22:48:41 +00006364 rc = btreeDropTable(p, iTable, piMoved);
6365 sqlite3BtreeLeave(p);
6366 return rc;
6367}
drh8b2f49b2001-06-08 00:21:52 +00006368
drh001bbcb2003-03-19 03:14:00 +00006369
drh8b2f49b2001-06-08 00:21:52 +00006370/*
drh23e11ca2004-05-04 17:27:28 +00006371** Read the meta-information out of a database file. Meta[0]
6372** is the number of free pages currently in the database. Meta[1]
drha3b321d2004-05-11 09:31:31 +00006373** through meta[15] are available for use by higher layers. Meta[0]
6374** is read-only, the others are read/write.
6375**
6376** The schema layer numbers meta values differently. At the schema
6377** layer (and the SetCookie and ReadCookie opcodes) the number of
6378** free pages is not visible. So Cookie[0] is the same as Meta[1].
drh8b2f49b2001-06-08 00:21:52 +00006379*/
danielk1977aef0bf62005-12-30 16:28:01 +00006380int sqlite3BtreeGetMeta(Btree *p, int idx, u32 *pMeta){
danielk19773b8a05f2007-03-19 17:44:26 +00006381 DbPage *pDbPage;
drh8b2f49b2001-06-08 00:21:52 +00006382 int rc;
drh4b70f112004-05-02 21:12:19 +00006383 unsigned char *pP1;
danielk1977aef0bf62005-12-30 16:28:01 +00006384 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00006385
drhd677b3d2007-08-20 22:48:41 +00006386 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006387 pBt->db = p->db;
drhd677b3d2007-08-20 22:48:41 +00006388
danielk1977da184232006-01-05 11:34:32 +00006389 /* Reading a meta-data value requires a read-lock on page 1 (and hence
6390 ** the sqlite_master table. We grab this lock regardless of whether or
6391 ** not the SQLITE_ReadUncommitted flag is set (the table rooted at page
6392 ** 1 is treated as a special case by queryTableLock() and lockTable()).
6393 */
6394 rc = queryTableLock(p, 1, READ_LOCK);
6395 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00006396 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +00006397 return rc;
6398 }
6399
drh23e11ca2004-05-04 17:27:28 +00006400 assert( idx>=0 && idx<=15 );
danielk19773b8a05f2007-03-19 17:44:26 +00006401 rc = sqlite3PagerGet(pBt->pPager, 1, &pDbPage);
drhd677b3d2007-08-20 22:48:41 +00006402 if( rc ){
6403 sqlite3BtreeLeave(p);
6404 return rc;
6405 }
danielk19773b8a05f2007-03-19 17:44:26 +00006406 pP1 = (unsigned char *)sqlite3PagerGetData(pDbPage);
drh23e11ca2004-05-04 17:27:28 +00006407 *pMeta = get4byte(&pP1[36 + idx*4]);
danielk19773b8a05f2007-03-19 17:44:26 +00006408 sqlite3PagerUnref(pDbPage);
drhae157872004-08-14 19:20:09 +00006409
danielk1977599fcba2004-11-08 07:13:13 +00006410 /* If autovacuumed is disabled in this build but we are trying to
6411 ** access an autovacuumed database, then make the database readonly.
6412 */
danielk1977003ba062004-11-04 02:57:33 +00006413#ifdef SQLITE_OMIT_AUTOVACUUM
drhae157872004-08-14 19:20:09 +00006414 if( idx==4 && *pMeta>0 ) pBt->readOnly = 1;
danielk1977003ba062004-11-04 02:57:33 +00006415#endif
drhae157872004-08-14 19:20:09 +00006416
danielk1977da184232006-01-05 11:34:32 +00006417 /* Grab the read-lock on page 1. */
6418 rc = lockTable(p, 1, READ_LOCK);
drhd677b3d2007-08-20 22:48:41 +00006419 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +00006420 return rc;
drh8b2f49b2001-06-08 00:21:52 +00006421}
6422
6423/*
drh23e11ca2004-05-04 17:27:28 +00006424** Write meta-information back into the database. Meta[0] is
6425** read-only and may not be written.
drh8b2f49b2001-06-08 00:21:52 +00006426*/
danielk1977aef0bf62005-12-30 16:28:01 +00006427int sqlite3BtreeUpdateMeta(Btree *p, int idx, u32 iMeta){
6428 BtShared *pBt = p->pBt;
drh4b70f112004-05-02 21:12:19 +00006429 unsigned char *pP1;
drha34b6762004-05-07 13:30:42 +00006430 int rc;
drh23e11ca2004-05-04 17:27:28 +00006431 assert( idx>=1 && idx<=15 );
drhd677b3d2007-08-20 22:48:41 +00006432 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006433 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00006434 if( p->inTrans!=TRANS_WRITE ){
drhd677b3d2007-08-20 22:48:41 +00006435 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
6436 }else{
6437 assert( pBt->pPage1!=0 );
6438 pP1 = pBt->pPage1->aData;
6439 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
6440 if( rc==SQLITE_OK ){
6441 put4byte(&pP1[36 + idx*4], iMeta);
danielk19774152e672007-09-12 17:01:45 +00006442#ifndef SQLITE_OMIT_AUTOVACUUM
drhd677b3d2007-08-20 22:48:41 +00006443 if( idx==7 ){
6444 assert( pBt->autoVacuum || iMeta==0 );
6445 assert( iMeta==0 || iMeta==1 );
6446 pBt->incrVacuum = iMeta;
6447 }
danielk19774152e672007-09-12 17:01:45 +00006448#endif
drhd677b3d2007-08-20 22:48:41 +00006449 }
drh5df72a52002-06-06 23:16:05 +00006450 }
drhd677b3d2007-08-20 22:48:41 +00006451 sqlite3BtreeLeave(p);
6452 return rc;
drh8b2f49b2001-06-08 00:21:52 +00006453}
drh8c42ca92001-06-22 19:15:00 +00006454
drhf328bc82004-05-10 23:29:49 +00006455/*
6456** Return the flag byte at the beginning of the page that the cursor
6457** is currently pointing to.
6458*/
6459int sqlite3BtreeFlags(BtCursor *pCur){
danielk1977da184232006-01-05 11:34:32 +00006460 /* TODO: What about CURSOR_REQUIRESEEK state? Probably need to call
drha3460582008-07-11 21:02:53 +00006461 ** restoreCursorPosition() here.
danielk1977da184232006-01-05 11:34:32 +00006462 */
danielk1977e448dc42008-01-02 11:50:51 +00006463 MemPage *pPage;
drha3460582008-07-11 21:02:53 +00006464 restoreCursorPosition(pCur);
danielk1977e448dc42008-01-02 11:50:51 +00006465 pPage = pCur->pPage;
drh1fee73e2007-08-29 04:00:57 +00006466 assert( cursorHoldsMutex(pCur) );
drhd0679ed2007-08-28 22:24:34 +00006467 assert( pPage->pBt==pCur->pBt );
drhf328bc82004-05-10 23:29:49 +00006468 return pPage ? pPage->aData[pPage->hdrOffset] : 0;
6469}
6470
drhdd793422001-06-28 01:54:48 +00006471
drhdd793422001-06-28 01:54:48 +00006472/*
drh5eddca62001-06-30 21:53:53 +00006473** Return the pager associated with a BTree. This routine is used for
6474** testing and debugging only.
drhdd793422001-06-28 01:54:48 +00006475*/
danielk1977aef0bf62005-12-30 16:28:01 +00006476Pager *sqlite3BtreePager(Btree *p){
6477 return p->pBt->pPager;
drhdd793422001-06-28 01:54:48 +00006478}
drh5eddca62001-06-30 21:53:53 +00006479
drhb7f91642004-10-31 02:22:47 +00006480#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00006481/*
6482** Append a message to the error message string.
6483*/
drh2e38c322004-09-03 18:38:44 +00006484static void checkAppendMsg(
6485 IntegrityCk *pCheck,
6486 char *zMsg1,
6487 const char *zFormat,
6488 ...
6489){
6490 va_list ap;
drh1dcdbc02007-01-27 02:24:54 +00006491 if( !pCheck->mxErr ) return;
6492 pCheck->mxErr--;
6493 pCheck->nErr++;
drh2e38c322004-09-03 18:38:44 +00006494 va_start(ap, zFormat);
drhf089aa42008-07-08 19:34:06 +00006495 if( pCheck->errMsg.nChar ){
6496 sqlite3StrAccumAppend(&pCheck->errMsg, "\n", 1);
drh5eddca62001-06-30 21:53:53 +00006497 }
drhf089aa42008-07-08 19:34:06 +00006498 if( zMsg1 ){
6499 sqlite3StrAccumAppend(&pCheck->errMsg, zMsg1, -1);
6500 }
6501 sqlite3VXPrintf(&pCheck->errMsg, 1, zFormat, ap);
6502 va_end(ap);
drhc890fec2008-08-01 20:10:08 +00006503 if( pCheck->errMsg.mallocFailed ){
6504 pCheck->mallocFailed = 1;
6505 }
drh5eddca62001-06-30 21:53:53 +00006506}
drhb7f91642004-10-31 02:22:47 +00006507#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00006508
drhb7f91642004-10-31 02:22:47 +00006509#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00006510/*
6511** Add 1 to the reference count for page iPage. If this is the second
6512** reference to the page, add an error message to pCheck->zErrMsg.
6513** Return 1 if there are 2 ore more references to the page and 0 if
6514** if this is the first reference to the page.
6515**
6516** Also check that the page number is in bounds.
6517*/
drhaaab5722002-02-19 13:39:21 +00006518static int checkRef(IntegrityCk *pCheck, int iPage, char *zContext){
drh5eddca62001-06-30 21:53:53 +00006519 if( iPage==0 ) return 1;
drh0de8c112002-07-06 16:32:14 +00006520 if( iPage>pCheck->nPage || iPage<0 ){
drh2e38c322004-09-03 18:38:44 +00006521 checkAppendMsg(pCheck, zContext, "invalid page number %d", iPage);
drh5eddca62001-06-30 21:53:53 +00006522 return 1;
6523 }
6524 if( pCheck->anRef[iPage]==1 ){
drh2e38c322004-09-03 18:38:44 +00006525 checkAppendMsg(pCheck, zContext, "2nd reference to page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00006526 return 1;
6527 }
6528 return (pCheck->anRef[iPage]++)>1;
6529}
6530
danielk1977afcdd022004-10-31 16:25:42 +00006531#ifndef SQLITE_OMIT_AUTOVACUUM
6532/*
6533** Check that the entry in the pointer-map for page iChild maps to
6534** page iParent, pointer type ptrType. If not, append an error message
6535** to pCheck.
6536*/
6537static void checkPtrmap(
6538 IntegrityCk *pCheck, /* Integrity check context */
6539 Pgno iChild, /* Child page number */
6540 u8 eType, /* Expected pointer map type */
6541 Pgno iParent, /* Expected pointer map parent page number */
6542 char *zContext /* Context description (used for error msg) */
6543){
6544 int rc;
6545 u8 ePtrmapType;
6546 Pgno iPtrmapParent;
6547
6548 rc = ptrmapGet(pCheck->pBt, iChild, &ePtrmapType, &iPtrmapParent);
6549 if( rc!=SQLITE_OK ){
6550 checkAppendMsg(pCheck, zContext, "Failed to read ptrmap key=%d", iChild);
6551 return;
6552 }
6553
6554 if( ePtrmapType!=eType || iPtrmapParent!=iParent ){
6555 checkAppendMsg(pCheck, zContext,
6556 "Bad ptr map entry key=%d expected=(%d,%d) got=(%d,%d)",
6557 iChild, eType, iParent, ePtrmapType, iPtrmapParent);
6558 }
6559}
6560#endif
6561
drh5eddca62001-06-30 21:53:53 +00006562/*
6563** Check the integrity of the freelist or of an overflow page list.
6564** Verify that the number of pages on the list is N.
6565*/
drh30e58752002-03-02 20:41:57 +00006566static void checkList(
6567 IntegrityCk *pCheck, /* Integrity checking context */
6568 int isFreeList, /* True for a freelist. False for overflow page list */
6569 int iPage, /* Page number for first page in the list */
6570 int N, /* Expected number of pages in the list */
6571 char *zContext /* Context for error messages */
6572){
6573 int i;
drh3a4c1412004-05-09 20:40:11 +00006574 int expected = N;
6575 int iFirst = iPage;
drh1dcdbc02007-01-27 02:24:54 +00006576 while( N-- > 0 && pCheck->mxErr ){
danielk19773b8a05f2007-03-19 17:44:26 +00006577 DbPage *pOvflPage;
6578 unsigned char *pOvflData;
drh5eddca62001-06-30 21:53:53 +00006579 if( iPage<1 ){
drh2e38c322004-09-03 18:38:44 +00006580 checkAppendMsg(pCheck, zContext,
6581 "%d of %d pages missing from overflow list starting at %d",
drh3a4c1412004-05-09 20:40:11 +00006582 N+1, expected, iFirst);
drh5eddca62001-06-30 21:53:53 +00006583 break;
6584 }
6585 if( checkRef(pCheck, iPage, zContext) ) break;
danielk19773b8a05f2007-03-19 17:44:26 +00006586 if( sqlite3PagerGet(pCheck->pPager, (Pgno)iPage, &pOvflPage) ){
drh2e38c322004-09-03 18:38:44 +00006587 checkAppendMsg(pCheck, zContext, "failed to get page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00006588 break;
6589 }
danielk19773b8a05f2007-03-19 17:44:26 +00006590 pOvflData = (unsigned char *)sqlite3PagerGetData(pOvflPage);
drh30e58752002-03-02 20:41:57 +00006591 if( isFreeList ){
danielk19773b8a05f2007-03-19 17:44:26 +00006592 int n = get4byte(&pOvflData[4]);
danielk1977687566d2004-11-02 12:56:41 +00006593#ifndef SQLITE_OMIT_AUTOVACUUM
6594 if( pCheck->pBt->autoVacuum ){
6595 checkPtrmap(pCheck, iPage, PTRMAP_FREEPAGE, 0, zContext);
6596 }
6597#endif
drh45b1fac2008-07-04 17:52:42 +00006598 if( n>pCheck->pBt->usableSize/4-2 ){
drh2e38c322004-09-03 18:38:44 +00006599 checkAppendMsg(pCheck, zContext,
6600 "freelist leaf count too big on page %d", iPage);
drhee696e22004-08-30 16:52:17 +00006601 N--;
6602 }else{
6603 for(i=0; i<n; i++){
danielk19773b8a05f2007-03-19 17:44:26 +00006604 Pgno iFreePage = get4byte(&pOvflData[8+i*4]);
danielk1977687566d2004-11-02 12:56:41 +00006605#ifndef SQLITE_OMIT_AUTOVACUUM
6606 if( pCheck->pBt->autoVacuum ){
6607 checkPtrmap(pCheck, iFreePage, PTRMAP_FREEPAGE, 0, zContext);
6608 }
6609#endif
6610 checkRef(pCheck, iFreePage, zContext);
drhee696e22004-08-30 16:52:17 +00006611 }
6612 N -= n;
drh30e58752002-03-02 20:41:57 +00006613 }
drh30e58752002-03-02 20:41:57 +00006614 }
danielk1977afcdd022004-10-31 16:25:42 +00006615#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00006616 else{
6617 /* If this database supports auto-vacuum and iPage is not the last
6618 ** page in this overflow list, check that the pointer-map entry for
6619 ** the following page matches iPage.
6620 */
6621 if( pCheck->pBt->autoVacuum && N>0 ){
danielk19773b8a05f2007-03-19 17:44:26 +00006622 i = get4byte(pOvflData);
danielk1977687566d2004-11-02 12:56:41 +00006623 checkPtrmap(pCheck, i, PTRMAP_OVERFLOW2, iPage, zContext);
6624 }
danielk1977afcdd022004-10-31 16:25:42 +00006625 }
6626#endif
danielk19773b8a05f2007-03-19 17:44:26 +00006627 iPage = get4byte(pOvflData);
6628 sqlite3PagerUnref(pOvflPage);
drh5eddca62001-06-30 21:53:53 +00006629 }
6630}
drhb7f91642004-10-31 02:22:47 +00006631#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00006632
drhb7f91642004-10-31 02:22:47 +00006633#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00006634/*
6635** Do various sanity checks on a single page of a tree. Return
6636** the tree depth. Root pages return 0. Parents of root pages
6637** return 1, and so forth.
6638**
6639** These checks are done:
6640**
6641** 1. Make sure that cells and freeblocks do not overlap
6642** but combine to completely cover the page.
drhda200cc2004-05-09 11:51:38 +00006643** NO 2. Make sure cell keys are in order.
6644** NO 3. Make sure no key is less than or equal to zLowerBound.
6645** NO 4. Make sure no key is greater than or equal to zUpperBound.
drh5eddca62001-06-30 21:53:53 +00006646** 5. Check the integrity of overflow pages.
6647** 6. Recursively call checkTreePage on all children.
6648** 7. Verify that the depth of all children is the same.
drh6019e162001-07-02 17:51:45 +00006649** 8. Make sure this page is at least 33% full or else it is
drh5eddca62001-06-30 21:53:53 +00006650** the root of the tree.
6651*/
6652static int checkTreePage(
drhaaab5722002-02-19 13:39:21 +00006653 IntegrityCk *pCheck, /* Context for the sanity check */
drh5eddca62001-06-30 21:53:53 +00006654 int iPage, /* Page number of the page to check */
6655 MemPage *pParent, /* Parent page */
drh74161702006-02-24 02:53:49 +00006656 char *zParentContext /* Parent context */
drh5eddca62001-06-30 21:53:53 +00006657){
6658 MemPage *pPage;
drhda200cc2004-05-09 11:51:38 +00006659 int i, rc, depth, d2, pgno, cnt;
drh43605152004-05-29 21:46:49 +00006660 int hdr, cellStart;
6661 int nCell;
drhda200cc2004-05-09 11:51:38 +00006662 u8 *data;
danielk1977aef0bf62005-12-30 16:28:01 +00006663 BtShared *pBt;
drh4f26bb62005-09-08 14:17:20 +00006664 int usableSize;
drh5eddca62001-06-30 21:53:53 +00006665 char zContext[100];
drh2e38c322004-09-03 18:38:44 +00006666 char *hit;
drh5eddca62001-06-30 21:53:53 +00006667
drh5bb3eb92007-05-04 13:15:55 +00006668 sqlite3_snprintf(sizeof(zContext), zContext, "Page %d: ", iPage);
danielk1977ef73ee92004-11-06 12:26:07 +00006669
drh5eddca62001-06-30 21:53:53 +00006670 /* Check that the page exists
6671 */
drhd9cb6ac2005-10-20 07:28:17 +00006672 pBt = pCheck->pBt;
drhb6f41482004-05-14 01:58:11 +00006673 usableSize = pBt->usableSize;
drh5eddca62001-06-30 21:53:53 +00006674 if( iPage==0 ) return 0;
6675 if( checkRef(pCheck, iPage, zParentContext) ) return 0;
drh16a9b832007-05-05 18:39:25 +00006676 if( (rc = sqlite3BtreeGetPage(pBt, (Pgno)iPage, &pPage, 0))!=0 ){
drh2e38c322004-09-03 18:38:44 +00006677 checkAppendMsg(pCheck, zContext,
6678 "unable to get the page. error code=%d", rc);
drh5eddca62001-06-30 21:53:53 +00006679 return 0;
6680 }
drh16a9b832007-05-05 18:39:25 +00006681 if( (rc = sqlite3BtreeInitPage(pPage, pParent))!=0 ){
6682 checkAppendMsg(pCheck, zContext,
6683 "sqlite3BtreeInitPage() returns error code %d", rc);
drh91025292004-05-03 19:49:32 +00006684 releasePage(pPage);
drh5eddca62001-06-30 21:53:53 +00006685 return 0;
6686 }
6687
6688 /* Check out all the cells.
6689 */
6690 depth = 0;
drh1dcdbc02007-01-27 02:24:54 +00006691 for(i=0; i<pPage->nCell && pCheck->mxErr; i++){
drh6f11bef2004-05-13 01:12:56 +00006692 u8 *pCell;
6693 int sz;
6694 CellInfo info;
drh5eddca62001-06-30 21:53:53 +00006695
6696 /* Check payload overflow pages
6697 */
drh5bb3eb92007-05-04 13:15:55 +00006698 sqlite3_snprintf(sizeof(zContext), zContext,
6699 "On tree page %d cell %d: ", iPage, i);
danielk19771cc5ed82007-05-16 17:28:43 +00006700 pCell = findCell(pPage,i);
drh16a9b832007-05-05 18:39:25 +00006701 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00006702 sz = info.nData;
6703 if( !pPage->intKey ) sz += info.nKey;
drh72365832007-03-06 15:53:44 +00006704 assert( sz==info.nPayload );
drh6f11bef2004-05-13 01:12:56 +00006705 if( sz>info.nLocal ){
drhb6f41482004-05-14 01:58:11 +00006706 int nPage = (sz - info.nLocal + usableSize - 5)/(usableSize - 4);
danielk1977afcdd022004-10-31 16:25:42 +00006707 Pgno pgnoOvfl = get4byte(&pCell[info.iOverflow]);
6708#ifndef SQLITE_OMIT_AUTOVACUUM
6709 if( pBt->autoVacuum ){
danielk1977687566d2004-11-02 12:56:41 +00006710 checkPtrmap(pCheck, pgnoOvfl, PTRMAP_OVERFLOW1, iPage, zContext);
danielk1977afcdd022004-10-31 16:25:42 +00006711 }
6712#endif
6713 checkList(pCheck, 0, pgnoOvfl, nPage, zContext);
drh5eddca62001-06-30 21:53:53 +00006714 }
6715
6716 /* Check sanity of left child page.
6717 */
drhda200cc2004-05-09 11:51:38 +00006718 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00006719 pgno = get4byte(pCell);
danielk1977afcdd022004-10-31 16:25:42 +00006720#ifndef SQLITE_OMIT_AUTOVACUUM
6721 if( pBt->autoVacuum ){
6722 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, zContext);
6723 }
6724#endif
drh74161702006-02-24 02:53:49 +00006725 d2 = checkTreePage(pCheck,pgno,pPage,zContext);
drhda200cc2004-05-09 11:51:38 +00006726 if( i>0 && d2!=depth ){
6727 checkAppendMsg(pCheck, zContext, "Child page depth differs");
6728 }
6729 depth = d2;
drh5eddca62001-06-30 21:53:53 +00006730 }
drh5eddca62001-06-30 21:53:53 +00006731 }
drhda200cc2004-05-09 11:51:38 +00006732 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00006733 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh5bb3eb92007-05-04 13:15:55 +00006734 sqlite3_snprintf(sizeof(zContext), zContext,
6735 "On page %d at right child: ", iPage);
danielk1977afcdd022004-10-31 16:25:42 +00006736#ifndef SQLITE_OMIT_AUTOVACUUM
6737 if( pBt->autoVacuum ){
danielk1977687566d2004-11-02 12:56:41 +00006738 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, 0);
danielk1977afcdd022004-10-31 16:25:42 +00006739 }
6740#endif
drh74161702006-02-24 02:53:49 +00006741 checkTreePage(pCheck, pgno, pPage, zContext);
drhda200cc2004-05-09 11:51:38 +00006742 }
drh5eddca62001-06-30 21:53:53 +00006743
6744 /* Check for complete coverage of the page
6745 */
drhda200cc2004-05-09 11:51:38 +00006746 data = pPage->aData;
6747 hdr = pPage->hdrOffset;
drhf7141992008-06-19 00:16:08 +00006748 hit = sqlite3PageMalloc( pBt->pageSize );
drhc890fec2008-08-01 20:10:08 +00006749 if( hit==0 ){
6750 pCheck->mallocFailed = 1;
6751 }else{
drhf7141992008-06-19 00:16:08 +00006752 memset(hit, 0, usableSize );
drh2e38c322004-09-03 18:38:44 +00006753 memset(hit, 1, get2byte(&data[hdr+5]));
6754 nCell = get2byte(&data[hdr+3]);
6755 cellStart = hdr + 12 - 4*pPage->leaf;
6756 for(i=0; i<nCell; i++){
6757 int pc = get2byte(&data[cellStart+i*2]);
danielk1977daca5432008-08-25 11:57:16 +00006758 u16 size = 1024;
drh2e38c322004-09-03 18:38:44 +00006759 int j;
danielk1977daca5432008-08-25 11:57:16 +00006760 if( pc<=usableSize ){
6761 size = cellSizePtr(pPage, &data[pc]);
6762 }
danielk19777701e812005-01-10 12:59:51 +00006763 if( (pc+size-1)>=usableSize || pc<0 ){
6764 checkAppendMsg(pCheck, 0,
6765 "Corruption detected in cell %d on page %d",i,iPage,0);
6766 }else{
6767 for(j=pc+size-1; j>=pc; j--) hit[j]++;
6768 }
drh2e38c322004-09-03 18:38:44 +00006769 }
6770 for(cnt=0, i=get2byte(&data[hdr+1]); i>0 && i<usableSize && cnt<10000;
6771 cnt++){
6772 int size = get2byte(&data[i+2]);
6773 int j;
danielk19777701e812005-01-10 12:59:51 +00006774 if( (i+size-1)>=usableSize || i<0 ){
6775 checkAppendMsg(pCheck, 0,
6776 "Corruption detected in cell %d on page %d",i,iPage,0);
6777 }else{
6778 for(j=i+size-1; j>=i; j--) hit[j]++;
6779 }
drh2e38c322004-09-03 18:38:44 +00006780 i = get2byte(&data[i]);
6781 }
6782 for(i=cnt=0; i<usableSize; i++){
6783 if( hit[i]==0 ){
6784 cnt++;
6785 }else if( hit[i]>1 ){
6786 checkAppendMsg(pCheck, 0,
6787 "Multiple uses for byte %d of page %d", i, iPage);
6788 break;
6789 }
6790 }
6791 if( cnt!=data[hdr+7] ){
6792 checkAppendMsg(pCheck, 0,
6793 "Fragmented space is %d byte reported as %d on page %d",
6794 cnt, data[hdr+7], iPage);
drh5eddca62001-06-30 21:53:53 +00006795 }
6796 }
drhf7141992008-06-19 00:16:08 +00006797 sqlite3PageFree(hit);
drh6019e162001-07-02 17:51:45 +00006798
drh4b70f112004-05-02 21:12:19 +00006799 releasePage(pPage);
drhda200cc2004-05-09 11:51:38 +00006800 return depth+1;
drh5eddca62001-06-30 21:53:53 +00006801}
drhb7f91642004-10-31 02:22:47 +00006802#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00006803
drhb7f91642004-10-31 02:22:47 +00006804#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00006805/*
6806** This routine does a complete check of the given BTree file. aRoot[] is
6807** an array of pages numbers were each page number is the root page of
6808** a table. nRoot is the number of entries in aRoot.
6809**
drhc890fec2008-08-01 20:10:08 +00006810** Write the number of error seen in *pnErr. Except for some memory
6811** allocation errors, nn error message is held in memory obtained from
6812** malloc is returned if *pnErr is non-zero. If *pnErr==0 then NULL is
6813** returned.
drh5eddca62001-06-30 21:53:53 +00006814*/
drh1dcdbc02007-01-27 02:24:54 +00006815char *sqlite3BtreeIntegrityCheck(
6816 Btree *p, /* The btree to be checked */
6817 int *aRoot, /* An array of root pages numbers for individual trees */
6818 int nRoot, /* Number of entries in aRoot[] */
6819 int mxErr, /* Stop reporting errors after this many */
6820 int *pnErr /* Write number of errors seen to this variable */
6821){
drh5eddca62001-06-30 21:53:53 +00006822 int i;
6823 int nRef;
drhaaab5722002-02-19 13:39:21 +00006824 IntegrityCk sCheck;
danielk1977aef0bf62005-12-30 16:28:01 +00006825 BtShared *pBt = p->pBt;
drhf089aa42008-07-08 19:34:06 +00006826 char zErr[100];
drh5eddca62001-06-30 21:53:53 +00006827
drhd677b3d2007-08-20 22:48:41 +00006828 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006829 pBt->db = p->db;
danielk19773b8a05f2007-03-19 17:44:26 +00006830 nRef = sqlite3PagerRefcount(pBt->pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00006831 if( lockBtreeWithRetry(p)!=SQLITE_OK ){
drhc890fec2008-08-01 20:10:08 +00006832 *pnErr = 1;
drhd677b3d2007-08-20 22:48:41 +00006833 sqlite3BtreeLeave(p);
drhc890fec2008-08-01 20:10:08 +00006834 return sqlite3DbStrDup(0, "cannot acquire a read lock on the database");
drhefc251d2001-07-01 22:12:01 +00006835 }
drh5eddca62001-06-30 21:53:53 +00006836 sCheck.pBt = pBt;
6837 sCheck.pPager = pBt->pPager;
danielk1977ad0132d2008-06-07 08:58:22 +00006838 sCheck.nPage = pagerPagecount(sCheck.pPager);
drh1dcdbc02007-01-27 02:24:54 +00006839 sCheck.mxErr = mxErr;
6840 sCheck.nErr = 0;
drhc890fec2008-08-01 20:10:08 +00006841 sCheck.mallocFailed = 0;
drh1dcdbc02007-01-27 02:24:54 +00006842 *pnErr = 0;
danielk1977e5321f02007-04-27 07:05:44 +00006843#ifndef SQLITE_OMIT_AUTOVACUUM
6844 if( pBt->nTrunc!=0 ){
6845 sCheck.nPage = pBt->nTrunc;
6846 }
6847#endif
drh0de8c112002-07-06 16:32:14 +00006848 if( sCheck.nPage==0 ){
6849 unlockBtreeIfUnused(pBt);
drhd677b3d2007-08-20 22:48:41 +00006850 sqlite3BtreeLeave(p);
drh0de8c112002-07-06 16:32:14 +00006851 return 0;
6852 }
drhe5ae5732008-06-15 02:51:47 +00006853 sCheck.anRef = sqlite3Malloc( (sCheck.nPage+1)*sizeof(sCheck.anRef[0]) );
danielk1977ac245ec2005-01-14 13:50:11 +00006854 if( !sCheck.anRef ){
6855 unlockBtreeIfUnused(pBt);
drh1dcdbc02007-01-27 02:24:54 +00006856 *pnErr = 1;
drhd677b3d2007-08-20 22:48:41 +00006857 sqlite3BtreeLeave(p);
drhc890fec2008-08-01 20:10:08 +00006858 return 0;
danielk1977ac245ec2005-01-14 13:50:11 +00006859 }
drhda200cc2004-05-09 11:51:38 +00006860 for(i=0; i<=sCheck.nPage; i++){ sCheck.anRef[i] = 0; }
drh42cac6d2004-11-20 20:31:11 +00006861 i = PENDING_BYTE_PAGE(pBt);
drh1f595712004-06-15 01:40:29 +00006862 if( i<=sCheck.nPage ){
6863 sCheck.anRef[i] = 1;
6864 }
drhf089aa42008-07-08 19:34:06 +00006865 sqlite3StrAccumInit(&sCheck.errMsg, zErr, sizeof(zErr), 20000);
drh5eddca62001-06-30 21:53:53 +00006866
6867 /* Check the integrity of the freelist
6868 */
drha34b6762004-05-07 13:30:42 +00006869 checkList(&sCheck, 1, get4byte(&pBt->pPage1->aData[32]),
6870 get4byte(&pBt->pPage1->aData[36]), "Main freelist: ");
drh5eddca62001-06-30 21:53:53 +00006871
6872 /* Check all the tables.
6873 */
drh1dcdbc02007-01-27 02:24:54 +00006874 for(i=0; i<nRoot && sCheck.mxErr; i++){
drh4ff6dfa2002-03-03 23:06:00 +00006875 if( aRoot[i]==0 ) continue;
danielk1977687566d2004-11-02 12:56:41 +00006876#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00006877 if( pBt->autoVacuum && aRoot[i]>1 ){
6878 checkPtrmap(&sCheck, aRoot[i], PTRMAP_ROOTPAGE, 0, 0);
6879 }
6880#endif
drh74161702006-02-24 02:53:49 +00006881 checkTreePage(&sCheck, aRoot[i], 0, "List of tree roots: ");
drh5eddca62001-06-30 21:53:53 +00006882 }
6883
6884 /* Make sure every page in the file is referenced
6885 */
drh1dcdbc02007-01-27 02:24:54 +00006886 for(i=1; i<=sCheck.nPage && sCheck.mxErr; i++){
danielk1977afcdd022004-10-31 16:25:42 +00006887#ifdef SQLITE_OMIT_AUTOVACUUM
drh5eddca62001-06-30 21:53:53 +00006888 if( sCheck.anRef[i]==0 ){
drh2e38c322004-09-03 18:38:44 +00006889 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
drh5eddca62001-06-30 21:53:53 +00006890 }
danielk1977afcdd022004-10-31 16:25:42 +00006891#else
6892 /* If the database supports auto-vacuum, make sure no tables contain
6893 ** references to pointer-map pages.
6894 */
6895 if( sCheck.anRef[i]==0 &&
danielk1977266664d2006-02-10 08:24:21 +00006896 (PTRMAP_PAGENO(pBt, i)!=i || !pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00006897 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
6898 }
6899 if( sCheck.anRef[i]!=0 &&
danielk1977266664d2006-02-10 08:24:21 +00006900 (PTRMAP_PAGENO(pBt, i)==i && pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00006901 checkAppendMsg(&sCheck, 0, "Pointer map page %d is referenced", i);
6902 }
6903#endif
drh5eddca62001-06-30 21:53:53 +00006904 }
6905
6906 /* Make sure this analysis did not leave any unref() pages
6907 */
drh5e00f6c2001-09-13 13:46:56 +00006908 unlockBtreeIfUnused(pBt);
danielk19773b8a05f2007-03-19 17:44:26 +00006909 if( nRef != sqlite3PagerRefcount(pBt->pPager) ){
drh2e38c322004-09-03 18:38:44 +00006910 checkAppendMsg(&sCheck, 0,
drh5eddca62001-06-30 21:53:53 +00006911 "Outstanding page count goes from %d to %d during this analysis",
danielk19773b8a05f2007-03-19 17:44:26 +00006912 nRef, sqlite3PagerRefcount(pBt->pPager)
drh5eddca62001-06-30 21:53:53 +00006913 );
drh5eddca62001-06-30 21:53:53 +00006914 }
6915
6916 /* Clean up and report errors.
6917 */
drhd677b3d2007-08-20 22:48:41 +00006918 sqlite3BtreeLeave(p);
drh17435752007-08-16 04:30:38 +00006919 sqlite3_free(sCheck.anRef);
drhc890fec2008-08-01 20:10:08 +00006920 if( sCheck.mallocFailed ){
6921 sqlite3StrAccumReset(&sCheck.errMsg);
6922 *pnErr = sCheck.nErr+1;
6923 return 0;
6924 }
drh1dcdbc02007-01-27 02:24:54 +00006925 *pnErr = sCheck.nErr;
drhf089aa42008-07-08 19:34:06 +00006926 if( sCheck.nErr==0 ) sqlite3StrAccumReset(&sCheck.errMsg);
6927 return sqlite3StrAccumFinish(&sCheck.errMsg);
drh5eddca62001-06-30 21:53:53 +00006928}
drhb7f91642004-10-31 02:22:47 +00006929#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
paulb95a8862003-04-01 21:16:41 +00006930
drh73509ee2003-04-06 20:44:45 +00006931/*
6932** Return the full pathname of the underlying database file.
drhd0679ed2007-08-28 22:24:34 +00006933**
6934** The pager filename is invariant as long as the pager is
6935** open so it is safe to access without the BtShared mutex.
drh73509ee2003-04-06 20:44:45 +00006936*/
danielk1977aef0bf62005-12-30 16:28:01 +00006937const char *sqlite3BtreeGetFilename(Btree *p){
6938 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00006939 return sqlite3PagerFilename(p->pBt->pPager);
drh73509ee2003-04-06 20:44:45 +00006940}
6941
6942/*
danielk19775865e3d2004-06-14 06:03:57 +00006943** Return the pathname of the directory that contains the database file.
drhd0679ed2007-08-28 22:24:34 +00006944**
6945** The pager directory name is invariant as long as the pager is
6946** open so it is safe to access without the BtShared mutex.
danielk19775865e3d2004-06-14 06:03:57 +00006947*/
danielk1977aef0bf62005-12-30 16:28:01 +00006948const char *sqlite3BtreeGetDirname(Btree *p){
6949 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00006950 return sqlite3PagerDirname(p->pBt->pPager);
danielk19775865e3d2004-06-14 06:03:57 +00006951}
6952
6953/*
6954** Return the pathname of the journal file for this database. The return
6955** value of this routine is the same regardless of whether the journal file
6956** has been created or not.
drhd0679ed2007-08-28 22:24:34 +00006957**
6958** The pager journal filename is invariant as long as the pager is
6959** open so it is safe to access without the BtShared mutex.
danielk19775865e3d2004-06-14 06:03:57 +00006960*/
danielk1977aef0bf62005-12-30 16:28:01 +00006961const char *sqlite3BtreeGetJournalname(Btree *p){
6962 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00006963 return sqlite3PagerJournalname(p->pBt->pPager);
danielk19775865e3d2004-06-14 06:03:57 +00006964}
6965
drhb7f91642004-10-31 02:22:47 +00006966#ifndef SQLITE_OMIT_VACUUM
danielk19775865e3d2004-06-14 06:03:57 +00006967/*
drhf7c57532003-04-25 13:22:51 +00006968** Copy the complete content of pBtFrom into pBtTo. A transaction
6969** must be active for both files.
6970**
danielk1977f653d782008-03-20 11:04:21 +00006971** The size of file pTo may be reduced by this operation.
6972** If anything goes wrong, the transaction on pTo is rolled back.
6973**
6974** If successful, CommitPhaseOne() may be called on pTo before returning.
6975** The caller should finish committing the transaction on pTo by calling
6976** sqlite3BtreeCommit().
drh73509ee2003-04-06 20:44:45 +00006977*/
drhd677b3d2007-08-20 22:48:41 +00006978static int btreeCopyFile(Btree *pTo, Btree *pFrom){
drhf7c57532003-04-25 13:22:51 +00006979 int rc = SQLITE_OK;
danielk1977f653d782008-03-20 11:04:21 +00006980 Pgno i;
6981
6982 Pgno nFromPage; /* Number of pages in pFrom */
6983 Pgno nToPage; /* Number of pages in pTo */
6984 Pgno nNewPage; /* Number of pages in pTo after the copy */
6985
6986 Pgno iSkip; /* Pending byte page in pTo */
6987 int nToPageSize; /* Page size of pTo in bytes */
6988 int nFromPageSize; /* Page size of pFrom in bytes */
drhf7c57532003-04-25 13:22:51 +00006989
danielk1977aef0bf62005-12-30 16:28:01 +00006990 BtShared *pBtTo = pTo->pBt;
6991 BtShared *pBtFrom = pFrom->pBt;
drhe5fe6902007-12-07 18:55:28 +00006992 pBtTo->db = pTo->db;
6993 pBtFrom->db = pFrom->db;
danielk1977f653d782008-03-20 11:04:21 +00006994
6995 nToPageSize = pBtTo->pageSize;
6996 nFromPageSize = pBtFrom->pageSize;
danielk1977aef0bf62005-12-30 16:28:01 +00006997
6998 if( pTo->inTrans!=TRANS_WRITE || pFrom->inTrans!=TRANS_WRITE ){
danielk1977ee5741e2004-05-31 10:01:34 +00006999 return SQLITE_ERROR;
7000 }
danielk1977f653d782008-03-20 11:04:21 +00007001 if( pBtTo->pCursor ){
7002 return SQLITE_BUSY;
drhf7c57532003-04-25 13:22:51 +00007003 }
drh538f5702007-04-13 02:14:30 +00007004
danielk1977ad0132d2008-06-07 08:58:22 +00007005 nToPage = pagerPagecount(pBtTo->pPager);
7006 nFromPage = pagerPagecount(pBtFrom->pPager);
danielk1977f653d782008-03-20 11:04:21 +00007007 iSkip = PENDING_BYTE_PAGE(pBtTo);
7008
7009 /* Variable nNewPage is the number of pages required to store the
7010 ** contents of pFrom using the current page-size of pTo.
drh538f5702007-04-13 02:14:30 +00007011 */
danielk1977f653d782008-03-20 11:04:21 +00007012 nNewPage = ((i64)nFromPage * (i64)nFromPageSize + (i64)nToPageSize - 1) /
7013 (i64)nToPageSize;
7014
7015 for(i=1; rc==SQLITE_OK && (i<=nToPage || i<=nNewPage); i++){
7016
7017 /* Journal the original page.
7018 **
7019 ** iSkip is the page number of the locking page (PENDING_BYTE_PAGE)
7020 ** in database *pTo (before the copy). This page is never written
7021 ** into the journal file. Unless i==iSkip or the page was not
7022 ** present in pTo before the copy operation, journal page i from pTo.
7023 */
7024 if( i!=iSkip && i<=nToPage ){
danielk19774abd5442008-05-05 15:26:50 +00007025 DbPage *pDbPage = 0;
danielk1977f653d782008-03-20 11:04:21 +00007026 rc = sqlite3PagerGet(pBtTo->pPager, i, &pDbPage);
danielk19774abd5442008-05-05 15:26:50 +00007027 if( rc==SQLITE_OK ){
7028 rc = sqlite3PagerWrite(pDbPage);
danielk1977df2566a2008-05-07 19:11:03 +00007029 if( rc==SQLITE_OK && i>nFromPage ){
7030 /* Yeah. It seems wierd to call DontWrite() right after Write(). But
7031 ** that is because the names of those procedures do not exactly
7032 ** represent what they do. Write() really means "put this page in the
7033 ** rollback journal and mark it as dirty so that it will be written
7034 ** to the database file later." DontWrite() undoes the second part of
7035 ** that and prevents the page from being written to the database. The
7036 ** page is still on the rollback journal, though. And that is the
7037 ** whole point of this block: to put pages on the rollback journal.
7038 */
danielk1977a1fa00d2008-08-27 15:16:33 +00007039 rc = sqlite3PagerDontWrite(pDbPage);
danielk1977df2566a2008-05-07 19:11:03 +00007040 }
7041 sqlite3PagerUnref(pDbPage);
danielk1977f653d782008-03-20 11:04:21 +00007042 }
danielk1977f653d782008-03-20 11:04:21 +00007043 }
7044
7045 /* Overwrite the data in page i of the target database */
7046 if( rc==SQLITE_OK && i!=iSkip && i<=nNewPage ){
7047
7048 DbPage *pToPage = 0;
7049 sqlite3_int64 iOff;
7050
7051 rc = sqlite3PagerGet(pBtTo->pPager, i, &pToPage);
7052 if( rc==SQLITE_OK ){
7053 rc = sqlite3PagerWrite(pToPage);
7054 }
7055
7056 for(
7057 iOff=(i-1)*nToPageSize;
7058 rc==SQLITE_OK && iOff<i*nToPageSize;
7059 iOff += nFromPageSize
7060 ){
7061 DbPage *pFromPage = 0;
7062 Pgno iFrom = (iOff/nFromPageSize)+1;
7063
7064 if( iFrom==PENDING_BYTE_PAGE(pBtFrom) ){
7065 continue;
7066 }
7067
7068 rc = sqlite3PagerGet(pBtFrom->pPager, iFrom, &pFromPage);
7069 if( rc==SQLITE_OK ){
7070 char *zTo = sqlite3PagerGetData(pToPage);
7071 char *zFrom = sqlite3PagerGetData(pFromPage);
7072 int nCopy;
7073
7074 if( nFromPageSize>=nToPageSize ){
7075 zFrom += ((i-1)*nToPageSize - ((iFrom-1)*nFromPageSize));
7076 nCopy = nToPageSize;
7077 }else{
7078 zTo += (((iFrom-1)*nFromPageSize) - (i-1)*nToPageSize);
7079 nCopy = nFromPageSize;
7080 }
7081
7082 memcpy(zTo, zFrom, nCopy);
7083 sqlite3PagerUnref(pFromPage);
7084 }
7085 }
7086
7087 if( pToPage ) sqlite3PagerUnref(pToPage);
7088 }
drh2e6d11b2003-04-25 15:37:57 +00007089 }
danielk1977f653d782008-03-20 11:04:21 +00007090
7091 /* If things have worked so far, the database file may need to be
7092 ** truncated. The complex part is that it may need to be truncated to
7093 ** a size that is not an integer multiple of nToPageSize - the current
7094 ** page size used by the pager associated with B-Tree pTo.
7095 **
7096 ** For example, say the page-size of pTo is 2048 bytes and the original
7097 ** number of pages is 5 (10 KB file). If pFrom has a page size of 1024
7098 ** bytes and 9 pages, then the file needs to be truncated to 9KB.
7099 */
7100 if( rc==SQLITE_OK ){
7101 if( nFromPageSize!=nToPageSize ){
7102 sqlite3_file *pFile = sqlite3PagerFile(pBtTo->pPager);
7103 i64 iSize = (i64)nFromPageSize * (i64)nFromPage;
7104 i64 iNow = (i64)((nToPage>nNewPage)?nToPage:nNewPage) * (i64)nToPageSize;
7105 i64 iPending = ((i64)PENDING_BYTE_PAGE(pBtTo)-1) *(i64)nToPageSize;
7106
7107 assert( iSize<=iNow );
7108
7109 /* Commit phase one syncs the journal file associated with pTo
7110 ** containing the original data. It does not sync the database file
7111 ** itself. After doing this it is safe to use OsTruncate() and other
7112 ** file APIs on the database file directly.
7113 */
7114 pBtTo->db = pTo->db;
7115 rc = sqlite3PagerCommitPhaseOne(pBtTo->pPager, 0, 0, 1);
7116 if( iSize<iNow && rc==SQLITE_OK ){
7117 rc = sqlite3OsTruncate(pFile, iSize);
7118 }
7119
7120 /* The loop that copied data from database pFrom to pTo did not
7121 ** populate the locking page of database pTo. If the page-size of
7122 ** pFrom is smaller than that of pTo, this means some data will
7123 ** not have been copied.
7124 **
7125 ** This block copies the missing data from database pFrom to pTo
7126 ** using file APIs. This is safe because at this point we know that
7127 ** all of the original data from pTo has been synced into the
7128 ** journal file. At this point it would be safe to do anything at
7129 ** all to the database file except truncate it to zero bytes.
7130 */
7131 if( rc==SQLITE_OK && nFromPageSize<nToPageSize && iSize>iPending){
7132 i64 iOff;
7133 for(
7134 iOff=iPending;
7135 rc==SQLITE_OK && iOff<(iPending+nToPageSize);
7136 iOff += nFromPageSize
7137 ){
7138 DbPage *pFromPage = 0;
7139 Pgno iFrom = (iOff/nFromPageSize)+1;
7140
7141 if( iFrom==PENDING_BYTE_PAGE(pBtFrom) || iFrom>nFromPage ){
7142 continue;
7143 }
7144
7145 rc = sqlite3PagerGet(pBtFrom->pPager, iFrom, &pFromPage);
7146 if( rc==SQLITE_OK ){
7147 char *zFrom = sqlite3PagerGetData(pFromPage);
danielk197706249db2008-08-23 16:17:55 +00007148 rc = sqlite3OsWrite(pFile, zFrom, nFromPageSize, iOff);
danielk1977f653d782008-03-20 11:04:21 +00007149 sqlite3PagerUnref(pFromPage);
7150 }
7151 }
7152 }
7153
7154 /* Sync the database file */
7155 if( rc==SQLITE_OK ){
7156 rc = sqlite3PagerSync(pBtTo->pPager);
7157 }
7158 }else{
7159 rc = sqlite3PagerTruncate(pBtTo->pPager, nNewPage);
7160 }
7161 if( rc==SQLITE_OK ){
7162 pBtTo->pageSizeFixed = 0;
7163 }
drh2e6d11b2003-04-25 15:37:57 +00007164 }
drh538f5702007-04-13 02:14:30 +00007165
drhf7c57532003-04-25 13:22:51 +00007166 if( rc ){
danielk1977aef0bf62005-12-30 16:28:01 +00007167 sqlite3BtreeRollback(pTo);
drhf7c57532003-04-25 13:22:51 +00007168 }
danielk1977f653d782008-03-20 11:04:21 +00007169
drhf7c57532003-04-25 13:22:51 +00007170 return rc;
drh73509ee2003-04-06 20:44:45 +00007171}
drhd677b3d2007-08-20 22:48:41 +00007172int sqlite3BtreeCopyFile(Btree *pTo, Btree *pFrom){
7173 int rc;
7174 sqlite3BtreeEnter(pTo);
7175 sqlite3BtreeEnter(pFrom);
7176 rc = btreeCopyFile(pTo, pFrom);
7177 sqlite3BtreeLeave(pFrom);
7178 sqlite3BtreeLeave(pTo);
7179 return rc;
7180}
7181
drhb7f91642004-10-31 02:22:47 +00007182#endif /* SQLITE_OMIT_VACUUM */
danielk19771d850a72004-05-31 08:26:49 +00007183
7184/*
7185** Return non-zero if a transaction is active.
7186*/
danielk1977aef0bf62005-12-30 16:28:01 +00007187int sqlite3BtreeIsInTrans(Btree *p){
drhe5fe6902007-12-07 18:55:28 +00007188 assert( p==0 || sqlite3_mutex_held(p->db->mutex) );
danielk1977aef0bf62005-12-30 16:28:01 +00007189 return (p && (p->inTrans==TRANS_WRITE));
danielk19771d850a72004-05-31 08:26:49 +00007190}
7191
7192/*
7193** Return non-zero if a statement transaction is active.
7194*/
danielk1977aef0bf62005-12-30 16:28:01 +00007195int sqlite3BtreeIsInStmt(Btree *p){
drh1fee73e2007-08-29 04:00:57 +00007196 assert( sqlite3BtreeHoldsMutex(p) );
danielk1977aef0bf62005-12-30 16:28:01 +00007197 return (p->pBt && p->pBt->inStmt);
danielk19771d850a72004-05-31 08:26:49 +00007198}
danielk197713adf8a2004-06-03 16:08:41 +00007199
7200/*
danielk19772372c2b2006-06-27 16:34:56 +00007201** Return non-zero if a read (or write) transaction is active.
7202*/
7203int sqlite3BtreeIsInReadTrans(Btree *p){
drhe5fe6902007-12-07 18:55:28 +00007204 assert( sqlite3_mutex_held(p->db->mutex) );
danielk19772372c2b2006-06-27 16:34:56 +00007205 return (p && (p->inTrans!=TRANS_NONE));
7206}
7207
7208/*
danielk1977da184232006-01-05 11:34:32 +00007209** This function returns a pointer to a blob of memory associated with
drh85b623f2007-12-13 21:54:09 +00007210** a single shared-btree. The memory is used by client code for its own
danielk1977da184232006-01-05 11:34:32 +00007211** purposes (for example, to store a high-level schema associated with
7212** the shared-btree). The btree layer manages reference counting issues.
7213**
7214** The first time this is called on a shared-btree, nBytes bytes of memory
7215** are allocated, zeroed, and returned to the caller. For each subsequent
7216** call the nBytes parameter is ignored and a pointer to the same blob
7217** of memory returned.
7218**
danielk1977171bfed2008-06-23 09:50:50 +00007219** If the nBytes parameter is 0 and the blob of memory has not yet been
7220** allocated, a null pointer is returned. If the blob has already been
7221** allocated, it is returned as normal.
7222**
danielk1977da184232006-01-05 11:34:32 +00007223** Just before the shared-btree is closed, the function passed as the
7224** xFree argument when the memory allocation was made is invoked on the
drh17435752007-08-16 04:30:38 +00007225** blob of allocated memory. This function should not call sqlite3_free()
danielk1977da184232006-01-05 11:34:32 +00007226** on the memory, the btree layer does that.
7227*/
7228void *sqlite3BtreeSchema(Btree *p, int nBytes, void(*xFree)(void *)){
7229 BtShared *pBt = p->pBt;
drh27641702007-08-22 02:56:42 +00007230 sqlite3BtreeEnter(p);
danielk1977171bfed2008-06-23 09:50:50 +00007231 if( !pBt->pSchema && nBytes ){
drh17435752007-08-16 04:30:38 +00007232 pBt->pSchema = sqlite3MallocZero(nBytes);
danielk1977da184232006-01-05 11:34:32 +00007233 pBt->xFreeSchema = xFree;
7234 }
drh27641702007-08-22 02:56:42 +00007235 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +00007236 return pBt->pSchema;
7237}
7238
danielk1977c87d34d2006-01-06 13:00:28 +00007239/*
7240** Return true if another user of the same shared btree as the argument
7241** handle holds an exclusive lock on the sqlite_master table.
7242*/
7243int sqlite3BtreeSchemaLocked(Btree *p){
drh27641702007-08-22 02:56:42 +00007244 int rc;
drhe5fe6902007-12-07 18:55:28 +00007245 assert( sqlite3_mutex_held(p->db->mutex) );
drh27641702007-08-22 02:56:42 +00007246 sqlite3BtreeEnter(p);
7247 rc = (queryTableLock(p, MASTER_ROOT, READ_LOCK)!=SQLITE_OK);
7248 sqlite3BtreeLeave(p);
7249 return rc;
danielk1977c87d34d2006-01-06 13:00:28 +00007250}
7251
drha154dcd2006-03-22 22:10:07 +00007252
7253#ifndef SQLITE_OMIT_SHARED_CACHE
7254/*
7255** Obtain a lock on the table whose root page is iTab. The
7256** lock is a write lock if isWritelock is true or a read lock
7257** if it is false.
7258*/
danielk1977c00da102006-01-07 13:21:04 +00007259int sqlite3BtreeLockTable(Btree *p, int iTab, u8 isWriteLock){
danielk19772e94d4d2006-01-09 05:36:27 +00007260 int rc = SQLITE_OK;
drh6a9ad3d2008-04-02 16:29:30 +00007261 if( p->sharable ){
7262 u8 lockType = READ_LOCK + isWriteLock;
7263 assert( READ_LOCK+1==WRITE_LOCK );
7264 assert( isWriteLock==0 || isWriteLock==1 );
7265 sqlite3BtreeEnter(p);
7266 rc = queryTableLock(p, iTab, lockType);
7267 if( rc==SQLITE_OK ){
7268 rc = lockTable(p, iTab, lockType);
7269 }
7270 sqlite3BtreeLeave(p);
danielk1977c00da102006-01-07 13:21:04 +00007271 }
7272 return rc;
7273}
drha154dcd2006-03-22 22:10:07 +00007274#endif
danielk1977b82e7ed2006-01-11 14:09:31 +00007275
danielk1977b4e9af92007-05-01 17:49:49 +00007276#ifndef SQLITE_OMIT_INCRBLOB
7277/*
7278** Argument pCsr must be a cursor opened for writing on an
7279** INTKEY table currently pointing at a valid table entry.
7280** This function modifies the data stored as part of that entry.
7281** Only the data content may only be modified, it is not possible
7282** to change the length of the data stored.
7283*/
danielk1977dcbb5d32007-05-04 18:36:44 +00007284int sqlite3BtreePutData(BtCursor *pCsr, u32 offset, u32 amt, void *z){
drh1fee73e2007-08-29 04:00:57 +00007285 assert( cursorHoldsMutex(pCsr) );
drhe5fe6902007-12-07 18:55:28 +00007286 assert( sqlite3_mutex_held(pCsr->pBtree->db->mutex) );
danielk1977dcbb5d32007-05-04 18:36:44 +00007287 assert(pCsr->isIncrblobHandle);
danielk19773588ceb2008-06-10 17:30:26 +00007288
drha3460582008-07-11 21:02:53 +00007289 restoreCursorPosition(pCsr);
danielk19773588ceb2008-06-10 17:30:26 +00007290 assert( pCsr->eState!=CURSOR_REQUIRESEEK );
7291 if( pCsr->eState!=CURSOR_VALID ){
7292 return SQLITE_ABORT;
danielk1977dcbb5d32007-05-04 18:36:44 +00007293 }
7294
danielk1977d04417962007-05-02 13:16:30 +00007295 /* Check some preconditions:
danielk1977dcbb5d32007-05-04 18:36:44 +00007296 ** (a) the cursor is open for writing,
7297 ** (b) there is no read-lock on the table being modified and
7298 ** (c) the cursor points at a valid row of an intKey table.
danielk1977d04417962007-05-02 13:16:30 +00007299 */
danielk1977d04417962007-05-02 13:16:30 +00007300 if( !pCsr->wrFlag ){
danielk1977dcbb5d32007-05-04 18:36:44 +00007301 return SQLITE_READONLY;
danielk1977d04417962007-05-02 13:16:30 +00007302 }
drhd0679ed2007-08-28 22:24:34 +00007303 assert( !pCsr->pBt->readOnly
7304 && pCsr->pBt->inTransaction==TRANS_WRITE );
danielk19773588ceb2008-06-10 17:30:26 +00007305 if( checkReadLocks(pCsr->pBtree, pCsr->pgnoRoot, pCsr, 0) ){
danielk1977d04417962007-05-02 13:16:30 +00007306 return SQLITE_LOCKED; /* The table pCur points to has a read lock */
7307 }
7308 if( pCsr->eState==CURSOR_INVALID || !pCsr->pPage->intKey ){
7309 return SQLITE_ERROR;
danielk1977b4e9af92007-05-01 17:49:49 +00007310 }
7311
danielk19779f8d6402007-05-02 17:48:45 +00007312 return accessPayload(pCsr, offset, amt, (unsigned char *)z, 0, 1);
danielk1977b4e9af92007-05-01 17:49:49 +00007313}
danielk19772dec9702007-05-02 16:48:37 +00007314
7315/*
7316** Set a flag on this cursor to cache the locations of pages from the
danielk1977da107192007-05-04 08:32:13 +00007317** overflow list for the current row. This is used by cursors opened
7318** for incremental blob IO only.
7319**
7320** This function sets a flag only. The actual page location cache
7321** (stored in BtCursor.aOverflow[]) is allocated and used by function
7322** accessPayload() (the worker function for sqlite3BtreeData() and
7323** sqlite3BtreePutData()).
danielk19772dec9702007-05-02 16:48:37 +00007324*/
7325void sqlite3BtreeCacheOverflow(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00007326 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00007327 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk1977dcbb5d32007-05-04 18:36:44 +00007328 assert(!pCur->isIncrblobHandle);
danielk19772dec9702007-05-02 16:48:37 +00007329 assert(!pCur->aOverflow);
danielk1977dcbb5d32007-05-04 18:36:44 +00007330 pCur->isIncrblobHandle = 1;
danielk19772dec9702007-05-02 16:48:37 +00007331}
danielk1977b4e9af92007-05-01 17:49:49 +00007332#endif