blob: 8353963010ec186a0e87c7a415f44981d2ff7e8c [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*************************************************************************
danielk19776507ecb2008-03-25 09:56:44 +000012** $Id: btree.c,v 1.445 2008/03/25 09:56:45 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*/
30#if SQLITE_TEST
mlcreech3a00f902008-03-04 17:45:01 +000031int sqlite3BtreeTrace=0; /* True to enable tracing */
drh615ae552005-01-16 23:21:00 +000032#endif
drh615ae552005-01-16 23:21:00 +000033
drh86f8c192007-08-22 00:39:19 +000034
35
drhe53831d2007-08-17 01:14:38 +000036#ifndef SQLITE_OMIT_SHARED_CACHE
37/*
38** A flag to indicate whether or not shared cache is enabled. Also,
39** a list of BtShared objects that are eligible for participation
drhd677b3d2007-08-20 22:48:41 +000040** in shared cache. The variables have file scope during normal builds,
drh86f8c192007-08-22 00:39:19 +000041** but the test harness needs to access these variables so we make them
drhd677b3d2007-08-20 22:48:41 +000042** global for test builds.
drhe53831d2007-08-17 01:14:38 +000043*/
44#ifdef SQLITE_TEST
45BtShared *sqlite3SharedCacheList = 0;
46int sqlite3SharedCacheEnabled = 0;
47#else
48static BtShared *sqlite3SharedCacheList = 0;
49static int sqlite3SharedCacheEnabled = 0;
50#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){
62 sqlite3SharedCacheEnabled = enable;
63 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*/
drh980b1a72006-08-16 16:42:48 +000071static int checkReadLocks(Btree*,Pgno,BtCursor*);
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) );
drhd677b3d2007-08-20 22:48:41 +0000100
danielk1977da184232006-01-05 11:34:32 +0000101 /* This is a no-op if the shared-cache is not enabled */
drhe53831d2007-08-17 01:14:38 +0000102 if( !p->sharable ){
danielk1977da184232006-01-05 11:34:32 +0000103 return SQLITE_OK;
104 }
105
danielk1977641b0f42007-12-21 04:47:25 +0000106 /* If some other connection is holding an exclusive lock, the
107 ** requested lock may not be obtained.
108 */
109 if( pBt->pExclusive && pBt->pExclusive!=p ){
110 return SQLITE_LOCKED;
111 }
112
danielk1977da184232006-01-05 11:34:32 +0000113 /* This (along with lockTable()) is where the ReadUncommitted flag is
114 ** dealt with. If the caller is querying for a read-lock and the flag is
115 ** set, it is unconditionally granted - even if there are write-locks
116 ** on the table. If a write-lock is requested, the ReadUncommitted flag
117 ** is not considered.
118 **
119 ** In function lockTable(), if a read-lock is demanded and the
120 ** ReadUncommitted flag is set, no entry is added to the locks list
121 ** (BtShared.pLock).
122 **
123 ** To summarize: If the ReadUncommitted flag is set, then read cursors do
124 ** not create or respect table locks. The locking procedure for a
125 ** write-cursor does not change.
126 */
127 if(
drhe5fe6902007-12-07 18:55:28 +0000128 !p->db ||
129 0==(p->db->flags&SQLITE_ReadUncommitted) ||
danielk1977da184232006-01-05 11:34:32 +0000130 eLock==WRITE_LOCK ||
drh47ded162006-01-06 01:42:58 +0000131 iTab==MASTER_ROOT
danielk1977da184232006-01-05 11:34:32 +0000132 ){
133 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
134 if( pIter->pBtree!=p && pIter->iTable==iTab &&
135 (pIter->eLock!=eLock || eLock!=READ_LOCK) ){
danielk1977c87d34d2006-01-06 13:00:28 +0000136 return SQLITE_LOCKED;
danielk1977da184232006-01-05 11:34:32 +0000137 }
danielk1977aef0bf62005-12-30 16:28:01 +0000138 }
139 }
140 return SQLITE_OK;
141}
drhe53831d2007-08-17 01:14:38 +0000142#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000143
drhe53831d2007-08-17 01:14:38 +0000144#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000145/*
146** Add a lock on the table with root-page iTable to the shared-btree used
147** by Btree handle p. Parameter eLock must be either READ_LOCK or
148** WRITE_LOCK.
149**
150** SQLITE_OK is returned if the lock is added successfully. SQLITE_BUSY and
151** SQLITE_NOMEM may also be returned.
152*/
153static int lockTable(Btree *p, Pgno iTable, u8 eLock){
154 BtShared *pBt = p->pBt;
155 BtLock *pLock = 0;
156 BtLock *pIter;
157
drh1fee73e2007-08-29 04:00:57 +0000158 assert( sqlite3BtreeHoldsMutex(p) );
drhd677b3d2007-08-20 22:48:41 +0000159
danielk1977da184232006-01-05 11:34:32 +0000160 /* This is a no-op if the shared-cache is not enabled */
drhe53831d2007-08-17 01:14:38 +0000161 if( !p->sharable ){
danielk1977da184232006-01-05 11:34:32 +0000162 return SQLITE_OK;
163 }
164
danielk1977aef0bf62005-12-30 16:28:01 +0000165 assert( SQLITE_OK==queryTableLock(p, iTable, eLock) );
166
danielk1977da184232006-01-05 11:34:32 +0000167 /* If the read-uncommitted flag is set and a read-lock is requested,
168 ** return early without adding an entry to the BtShared.pLock list. See
169 ** comment in function queryTableLock() for more info on handling
170 ** the ReadUncommitted flag.
171 */
172 if(
drhe5fe6902007-12-07 18:55:28 +0000173 (p->db) &&
174 (p->db->flags&SQLITE_ReadUncommitted) &&
danielk1977da184232006-01-05 11:34:32 +0000175 (eLock==READ_LOCK) &&
drh47ded162006-01-06 01:42:58 +0000176 iTable!=MASTER_ROOT
danielk1977da184232006-01-05 11:34:32 +0000177 ){
178 return SQLITE_OK;
179 }
180
danielk1977aef0bf62005-12-30 16:28:01 +0000181 /* First search the list for an existing lock on this table. */
182 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
183 if( pIter->iTable==iTable && pIter->pBtree==p ){
184 pLock = pIter;
185 break;
186 }
187 }
188
189 /* If the above search did not find a BtLock struct associating Btree p
190 ** with table iTable, allocate one and link it into the list.
191 */
192 if( !pLock ){
drh17435752007-08-16 04:30:38 +0000193 pLock = (BtLock *)sqlite3MallocZero(sizeof(BtLock));
danielk1977aef0bf62005-12-30 16:28:01 +0000194 if( !pLock ){
195 return SQLITE_NOMEM;
196 }
197 pLock->iTable = iTable;
198 pLock->pBtree = p;
199 pLock->pNext = pBt->pLock;
200 pBt->pLock = pLock;
201 }
202
203 /* Set the BtLock.eLock variable to the maximum of the current lock
204 ** and the requested lock. This means if a write-lock was already held
205 ** and a read-lock requested, we don't incorrectly downgrade the lock.
206 */
207 assert( WRITE_LOCK>READ_LOCK );
danielk19775118b912005-12-30 16:31:53 +0000208 if( eLock>pLock->eLock ){
209 pLock->eLock = eLock;
210 }
danielk1977aef0bf62005-12-30 16:28:01 +0000211
212 return SQLITE_OK;
213}
drhe53831d2007-08-17 01:14:38 +0000214#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000215
drhe53831d2007-08-17 01:14:38 +0000216#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000217/*
218** Release all the table locks (locks obtained via calls to the lockTable()
219** procedure) held by Btree handle p.
220*/
221static void unlockAllTables(Btree *p){
danielk1977641b0f42007-12-21 04:47:25 +0000222 BtShared *pBt = p->pBt;
223 BtLock **ppIter = &pBt->pLock;
danielk1977da184232006-01-05 11:34:32 +0000224
drh1fee73e2007-08-29 04:00:57 +0000225 assert( sqlite3BtreeHoldsMutex(p) );
drhe53831d2007-08-17 01:14:38 +0000226 assert( p->sharable || 0==*ppIter );
danielk1977da184232006-01-05 11:34:32 +0000227
danielk1977aef0bf62005-12-30 16:28:01 +0000228 while( *ppIter ){
229 BtLock *pLock = *ppIter;
danielk1977641b0f42007-12-21 04:47:25 +0000230 assert( pBt->pExclusive==0 || pBt->pExclusive==pLock->pBtree );
danielk1977aef0bf62005-12-30 16:28:01 +0000231 if( pLock->pBtree==p ){
232 *ppIter = pLock->pNext;
drh17435752007-08-16 04:30:38 +0000233 sqlite3_free(pLock);
danielk1977aef0bf62005-12-30 16:28:01 +0000234 }else{
235 ppIter = &pLock->pNext;
236 }
237 }
danielk1977641b0f42007-12-21 04:47:25 +0000238
239 if( pBt->pExclusive==p ){
240 pBt->pExclusive = 0;
241 }
danielk1977aef0bf62005-12-30 16:28:01 +0000242}
243#endif /* SQLITE_OMIT_SHARED_CACHE */
244
drh980b1a72006-08-16 16:42:48 +0000245static void releasePage(MemPage *pPage); /* Forward reference */
246
drh1fee73e2007-08-29 04:00:57 +0000247/*
248** Verify that the cursor holds a mutex on the BtShared
249*/
250#ifndef NDEBUG
251static int cursorHoldsMutex(BtCursor *p){
drhff0587c2007-08-29 17:43:19 +0000252 return sqlite3_mutex_held(p->pBt->mutex);
drh1fee73e2007-08-29 04:00:57 +0000253}
254#endif
255
256
danielk197792d4d7a2007-05-04 12:05:56 +0000257#ifndef SQLITE_OMIT_INCRBLOB
258/*
259** Invalidate the overflow page-list cache for cursor pCur, if any.
260*/
261static void invalidateOverflowCache(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000262 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000263 sqlite3_free(pCur->aOverflow);
danielk197792d4d7a2007-05-04 12:05:56 +0000264 pCur->aOverflow = 0;
265}
266
267/*
268** Invalidate the overflow page-list cache for all cursors opened
269** on the shared btree structure pBt.
270*/
271static void invalidateAllOverflowCache(BtShared *pBt){
272 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000273 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +0000274 for(p=pBt->pCursor; p; p=p->pNext){
275 invalidateOverflowCache(p);
276 }
277}
278#else
279 #define invalidateOverflowCache(x)
280 #define invalidateAllOverflowCache(x)
281#endif
282
drh980b1a72006-08-16 16:42:48 +0000283/*
284** Save the current cursor position in the variables BtCursor.nKey
285** and BtCursor.pKey. The cursor's state is set to CURSOR_REQUIRESEEK.
286*/
287static int saveCursorPosition(BtCursor *pCur){
288 int rc;
289
290 assert( CURSOR_VALID==pCur->eState );
291 assert( 0==pCur->pKey );
drh1fee73e2007-08-29 04:00:57 +0000292 assert( cursorHoldsMutex(pCur) );
drh980b1a72006-08-16 16:42:48 +0000293
294 rc = sqlite3BtreeKeySize(pCur, &pCur->nKey);
295
296 /* If this is an intKey table, then the above call to BtreeKeySize()
297 ** stores the integer key in pCur->nKey. In this case this value is
298 ** all that is required. Otherwise, if pCur is not open on an intKey
299 ** table, then malloc space for and store the pCur->nKey bytes of key
300 ** data.
301 */
302 if( rc==SQLITE_OK && 0==pCur->pPage->intKey){
drh17435752007-08-16 04:30:38 +0000303 void *pKey = sqlite3_malloc(pCur->nKey);
drh980b1a72006-08-16 16:42:48 +0000304 if( pKey ){
305 rc = sqlite3BtreeKey(pCur, 0, pCur->nKey, pKey);
306 if( rc==SQLITE_OK ){
307 pCur->pKey = pKey;
308 }else{
drh17435752007-08-16 04:30:38 +0000309 sqlite3_free(pKey);
drh980b1a72006-08-16 16:42:48 +0000310 }
311 }else{
312 rc = SQLITE_NOMEM;
313 }
314 }
315 assert( !pCur->pPage->intKey || !pCur->pKey );
316
317 if( rc==SQLITE_OK ){
318 releasePage(pCur->pPage);
319 pCur->pPage = 0;
320 pCur->eState = CURSOR_REQUIRESEEK;
321 }
322
danielk197792d4d7a2007-05-04 12:05:56 +0000323 invalidateOverflowCache(pCur);
drh980b1a72006-08-16 16:42:48 +0000324 return rc;
325}
326
327/*
328** Save the positions of all cursors except pExcept open on the table
329** with root-page iRoot. Usually, this is called just before cursor
330** pExcept is used to modify the table (BtreeDelete() or BtreeInsert()).
331*/
332static int saveAllCursors(BtShared *pBt, Pgno iRoot, BtCursor *pExcept){
333 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000334 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +0000335 assert( pExcept==0 || pExcept->pBt==pBt );
drh980b1a72006-08-16 16:42:48 +0000336 for(p=pBt->pCursor; p; p=p->pNext){
337 if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) &&
338 p->eState==CURSOR_VALID ){
339 int rc = saveCursorPosition(p);
340 if( SQLITE_OK!=rc ){
341 return rc;
342 }
343 }
344 }
345 return SQLITE_OK;
346}
347
348/*
drhbf700f32007-03-31 02:36:44 +0000349** Clear the current cursor position.
350*/
351static void clearCursorPosition(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000352 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000353 sqlite3_free(pCur->pKey);
drhbf700f32007-03-31 02:36:44 +0000354 pCur->pKey = 0;
355 pCur->eState = CURSOR_INVALID;
356}
357
358/*
drh980b1a72006-08-16 16:42:48 +0000359** Restore the cursor to the position it was in (or as close to as possible)
360** when saveCursorPosition() was called. Note that this call deletes the
361** saved position info stored by saveCursorPosition(), so there can be
362** at most one effective restoreOrClearCursorPosition() call after each
363** saveCursorPosition().
364**
365** If the second argument argument - doSeek - is false, then instead of
drh85b623f2007-12-13 21:54:09 +0000366** returning the cursor to its saved position, any saved position is deleted
drh980b1a72006-08-16 16:42:48 +0000367** and the cursor state set to CURSOR_INVALID.
368*/
drh16a9b832007-05-05 18:39:25 +0000369int sqlite3BtreeRestoreOrClearCursorPosition(BtCursor *pCur){
drhbf700f32007-03-31 02:36:44 +0000370 int rc;
drh1fee73e2007-08-29 04:00:57 +0000371 assert( cursorHoldsMutex(pCur) );
drhfb982642007-08-30 01:19:59 +0000372 assert( pCur->eState>=CURSOR_REQUIRESEEK );
373 if( pCur->eState==CURSOR_FAULT ){
374 return pCur->skip;
375 }
danielk197732a0d8b2007-05-04 19:03:02 +0000376#ifndef SQLITE_OMIT_INCRBLOB
danielk1977dcbb5d32007-05-04 18:36:44 +0000377 if( pCur->isIncrblobHandle ){
378 return SQLITE_ABORT;
379 }
danielk197732a0d8b2007-05-04 19:03:02 +0000380#endif
drh980b1a72006-08-16 16:42:48 +0000381 pCur->eState = CURSOR_INVALID;
drhbf700f32007-03-31 02:36:44 +0000382 rc = sqlite3BtreeMoveto(pCur, pCur->pKey, pCur->nKey, 0, &pCur->skip);
drh980b1a72006-08-16 16:42:48 +0000383 if( rc==SQLITE_OK ){
drh17435752007-08-16 04:30:38 +0000384 sqlite3_free(pCur->pKey);
drh980b1a72006-08-16 16:42:48 +0000385 pCur->pKey = 0;
drhbf700f32007-03-31 02:36:44 +0000386 assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_INVALID );
drh980b1a72006-08-16 16:42:48 +0000387 }
388 return rc;
389}
390
drhbf700f32007-03-31 02:36:44 +0000391#define restoreOrClearCursorPosition(p) \
drhfb982642007-08-30 01:19:59 +0000392 (p->eState>=CURSOR_REQUIRESEEK ? \
drh16a9b832007-05-05 18:39:25 +0000393 sqlite3BtreeRestoreOrClearCursorPosition(p) : \
394 SQLITE_OK)
drh980b1a72006-08-16 16:42:48 +0000395
danielk1977599fcba2004-11-08 07:13:13 +0000396#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977afcdd022004-10-31 16:25:42 +0000397/*
drha3152892007-05-05 11:48:52 +0000398** Given a page number of a regular database page, return the page
399** number for the pointer-map page that contains the entry for the
400** input page number.
danielk1977afcdd022004-10-31 16:25:42 +0000401*/
danielk1977266664d2006-02-10 08:24:21 +0000402static Pgno ptrmapPageno(BtShared *pBt, Pgno pgno){
drhd677b3d2007-08-20 22:48:41 +0000403 int nPagesPerMapPage, iPtrMap, ret;
drh1fee73e2007-08-29 04:00:57 +0000404 assert( sqlite3_mutex_held(pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000405 nPagesPerMapPage = (pBt->usableSize/5)+1;
406 iPtrMap = (pgno-2)/nPagesPerMapPage;
407 ret = (iPtrMap*nPagesPerMapPage) + 2;
danielk1977266664d2006-02-10 08:24:21 +0000408 if( ret==PENDING_BYTE_PAGE(pBt) ){
409 ret++;
410 }
411 return ret;
412}
danielk1977a19df672004-11-03 11:37:07 +0000413
danielk1977afcdd022004-10-31 16:25:42 +0000414/*
danielk1977afcdd022004-10-31 16:25:42 +0000415** Write an entry into the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000416**
417** This routine updates the pointer map entry for page number 'key'
418** so that it maps to type 'eType' and parent page number 'pgno'.
419** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +0000420*/
danielk1977aef0bf62005-12-30 16:28:01 +0000421static int ptrmapPut(BtShared *pBt, Pgno key, u8 eType, Pgno parent){
danielk19773b8a05f2007-03-19 17:44:26 +0000422 DbPage *pDbPage; /* The pointer map page */
423 u8 *pPtrmap; /* The pointer map data */
424 Pgno iPtrmap; /* The pointer map page number */
425 int offset; /* Offset in pointer map page */
danielk1977afcdd022004-10-31 16:25:42 +0000426 int rc;
427
drh1fee73e2007-08-29 04:00:57 +0000428 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977266664d2006-02-10 08:24:21 +0000429 /* The master-journal page number must never be used as a pointer map page */
430 assert( 0==PTRMAP_ISPAGE(pBt, PENDING_BYTE_PAGE(pBt)) );
431
danielk1977ac11ee62005-01-15 12:45:51 +0000432 assert( pBt->autoVacuum );
danielk1977fdb7cdb2005-01-17 02:12:18 +0000433 if( key==0 ){
drh49285702005-09-17 15:20:26 +0000434 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +0000435 }
danielk1977266664d2006-02-10 08:24:21 +0000436 iPtrmap = PTRMAP_PAGENO(pBt, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000437 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage);
danielk1977687566d2004-11-02 12:56:41 +0000438 if( rc!=SQLITE_OK ){
danielk1977afcdd022004-10-31 16:25:42 +0000439 return rc;
440 }
danielk1977266664d2006-02-10 08:24:21 +0000441 offset = PTRMAP_PTROFFSET(pBt, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000442 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000443
drh615ae552005-01-16 23:21:00 +0000444 if( eType!=pPtrmap[offset] || get4byte(&pPtrmap[offset+1])!=parent ){
445 TRACE(("PTRMAP_UPDATE: %d->(%d,%d)\n", key, eType, parent));
danielk19773b8a05f2007-03-19 17:44:26 +0000446 rc = sqlite3PagerWrite(pDbPage);
danielk19775558a8a2005-01-17 07:53:44 +0000447 if( rc==SQLITE_OK ){
448 pPtrmap[offset] = eType;
449 put4byte(&pPtrmap[offset+1], parent);
danielk1977afcdd022004-10-31 16:25:42 +0000450 }
danielk1977afcdd022004-10-31 16:25:42 +0000451 }
452
danielk19773b8a05f2007-03-19 17:44:26 +0000453 sqlite3PagerUnref(pDbPage);
danielk19775558a8a2005-01-17 07:53:44 +0000454 return rc;
danielk1977afcdd022004-10-31 16:25:42 +0000455}
456
457/*
458** Read an entry from the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000459**
460** This routine retrieves the pointer map entry for page 'key', writing
461** the type and parent page number to *pEType and *pPgno respectively.
462** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +0000463*/
danielk1977aef0bf62005-12-30 16:28:01 +0000464static int ptrmapGet(BtShared *pBt, Pgno key, u8 *pEType, Pgno *pPgno){
danielk19773b8a05f2007-03-19 17:44:26 +0000465 DbPage *pDbPage; /* The pointer map page */
danielk1977afcdd022004-10-31 16:25:42 +0000466 int iPtrmap; /* Pointer map page index */
467 u8 *pPtrmap; /* Pointer map page data */
468 int offset; /* Offset of entry in pointer map */
469 int rc;
470
drh1fee73e2007-08-29 04:00:57 +0000471 assert( sqlite3_mutex_held(pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000472
danielk1977266664d2006-02-10 08:24:21 +0000473 iPtrmap = PTRMAP_PAGENO(pBt, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000474 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000475 if( rc!=0 ){
476 return rc;
477 }
danielk19773b8a05f2007-03-19 17:44:26 +0000478 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000479
danielk1977266664d2006-02-10 08:24:21 +0000480 offset = PTRMAP_PTROFFSET(pBt, key);
drh43617e92006-03-06 20:55:46 +0000481 assert( pEType!=0 );
482 *pEType = pPtrmap[offset];
danielk1977687566d2004-11-02 12:56:41 +0000483 if( pPgno ) *pPgno = get4byte(&pPtrmap[offset+1]);
danielk1977afcdd022004-10-31 16:25:42 +0000484
danielk19773b8a05f2007-03-19 17:44:26 +0000485 sqlite3PagerUnref(pDbPage);
drh49285702005-09-17 15:20:26 +0000486 if( *pEType<1 || *pEType>5 ) return SQLITE_CORRUPT_BKPT;
danielk1977afcdd022004-10-31 16:25:42 +0000487 return SQLITE_OK;
488}
489
490#endif /* SQLITE_OMIT_AUTOVACUUM */
491
drh0d316a42002-08-11 20:10:47 +0000492/*
drh271efa52004-05-30 19:19:05 +0000493** Given a btree page and a cell index (0 means the first cell on
494** the page, 1 means the second cell, and so forth) return a pointer
495** to the cell content.
496**
497** This routine works only for pages that do not contain overflow cells.
drh3aac2dd2004-04-26 14:10:20 +0000498*/
danielk19771cc5ed82007-05-16 17:28:43 +0000499#define findCell(pPage, iCell) \
500 ((pPage)->aData + get2byte(&(pPage)->aData[(pPage)->cellOffset+2*(iCell)]))
drhe6e4d6b2007-08-05 23:52:05 +0000501#ifdef SQLITE_TEST
drh16a9b832007-05-05 18:39:25 +0000502u8 *sqlite3BtreeFindCell(MemPage *pPage, int iCell){
drh43605152004-05-29 21:46:49 +0000503 assert( iCell>=0 );
drh029f3f82007-06-20 15:14:10 +0000504 assert( iCell<get2byte(&pPage->aData[pPage->hdrOffset+3]) );
danielk19771cc5ed82007-05-16 17:28:43 +0000505 return findCell(pPage, iCell);
drh43605152004-05-29 21:46:49 +0000506}
drhe6e4d6b2007-08-05 23:52:05 +0000507#endif
drh43605152004-05-29 21:46:49 +0000508
509/*
drh16a9b832007-05-05 18:39:25 +0000510** This a more complex version of sqlite3BtreeFindCell() that works for
drh43605152004-05-29 21:46:49 +0000511** pages that do contain overflow cells. See insert
512*/
513static u8 *findOverflowCell(MemPage *pPage, int iCell){
514 int i;
drh1fee73e2007-08-29 04:00:57 +0000515 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh43605152004-05-29 21:46:49 +0000516 for(i=pPage->nOverflow-1; i>=0; i--){
drh6d08b4d2004-07-20 12:45:22 +0000517 int k;
518 struct _OvflCell *pOvfl;
519 pOvfl = &pPage->aOvfl[i];
520 k = pOvfl->idx;
521 if( k<=iCell ){
522 if( k==iCell ){
523 return pOvfl->pCell;
drh43605152004-05-29 21:46:49 +0000524 }
525 iCell--;
526 }
527 }
danielk19771cc5ed82007-05-16 17:28:43 +0000528 return findCell(pPage, iCell);
drh43605152004-05-29 21:46:49 +0000529}
530
531/*
532** Parse a cell content block and fill in the CellInfo structure. There
drh16a9b832007-05-05 18:39:25 +0000533** are two versions of this function. sqlite3BtreeParseCell() takes a
534** cell index as the second argument and sqlite3BtreeParseCellPtr()
535** takes a pointer to the body of the cell as its second argument.
danielk19771cc5ed82007-05-16 17:28:43 +0000536**
537** Within this file, the parseCell() macro can be called instead of
538** sqlite3BtreeParseCellPtr(). Using some compilers, this will be faster.
drh43605152004-05-29 21:46:49 +0000539*/
drh16a9b832007-05-05 18:39:25 +0000540void sqlite3BtreeParseCellPtr(
drh3aac2dd2004-04-26 14:10:20 +0000541 MemPage *pPage, /* Page containing the cell */
drh43605152004-05-29 21:46:49 +0000542 u8 *pCell, /* Pointer to the cell text. */
drh6f11bef2004-05-13 01:12:56 +0000543 CellInfo *pInfo /* Fill in this structure */
drh3aac2dd2004-04-26 14:10:20 +0000544){
drh271efa52004-05-30 19:19:05 +0000545 int n; /* Number bytes in cell content header */
546 u32 nPayload; /* Number of bytes of cell payload */
drh43605152004-05-29 21:46:49 +0000547
drh1fee73e2007-08-29 04:00:57 +0000548 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000549
drh43605152004-05-29 21:46:49 +0000550 pInfo->pCell = pCell;
drhab01f612004-05-22 02:55:23 +0000551 assert( pPage->leaf==0 || pPage->leaf==1 );
drh271efa52004-05-30 19:19:05 +0000552 n = pPage->childPtrSize;
553 assert( n==4-4*pPage->leaf );
drh8b18dd42004-05-12 19:18:15 +0000554 if( pPage->hasData ){
drh271efa52004-05-30 19:19:05 +0000555 n += getVarint32(&pCell[n], &nPayload);
drh8b18dd42004-05-12 19:18:15 +0000556 }else{
drh271efa52004-05-30 19:19:05 +0000557 nPayload = 0;
drh3aac2dd2004-04-26 14:10:20 +0000558 }
drh271efa52004-05-30 19:19:05 +0000559 pInfo->nData = nPayload;
drh504b6982006-01-22 21:52:56 +0000560 if( pPage->intKey ){
561 n += getVarint(&pCell[n], (u64 *)&pInfo->nKey);
562 }else{
563 u32 x;
564 n += getVarint32(&pCell[n], &x);
565 pInfo->nKey = x;
566 nPayload += x;
drh6f11bef2004-05-13 01:12:56 +0000567 }
drh72365832007-03-06 15:53:44 +0000568 pInfo->nPayload = nPayload;
drh504b6982006-01-22 21:52:56 +0000569 pInfo->nHeader = n;
drh271efa52004-05-30 19:19:05 +0000570 if( nPayload<=pPage->maxLocal ){
571 /* This is the (easy) common case where the entire payload fits
572 ** on the local page. No overflow is required.
573 */
574 int nSize; /* Total size of cell content in bytes */
drh6f11bef2004-05-13 01:12:56 +0000575 pInfo->nLocal = nPayload;
576 pInfo->iOverflow = 0;
drh271efa52004-05-30 19:19:05 +0000577 nSize = nPayload + n;
578 if( nSize<4 ){
579 nSize = 4; /* Minimum cell size is 4 */
drh43605152004-05-29 21:46:49 +0000580 }
drh271efa52004-05-30 19:19:05 +0000581 pInfo->nSize = nSize;
drh6f11bef2004-05-13 01:12:56 +0000582 }else{
drh271efa52004-05-30 19:19:05 +0000583 /* If the payload will not fit completely on the local page, we have
584 ** to decide how much to store locally and how much to spill onto
585 ** overflow pages. The strategy is to minimize the amount of unused
586 ** space on overflow pages while keeping the amount of local storage
587 ** in between minLocal and maxLocal.
588 **
589 ** Warning: changing the way overflow payload is distributed in any
590 ** way will result in an incompatible file format.
591 */
592 int minLocal; /* Minimum amount of payload held locally */
593 int maxLocal; /* Maximum amount of payload held locally */
594 int surplus; /* Overflow payload available for local storage */
595
596 minLocal = pPage->minLocal;
597 maxLocal = pPage->maxLocal;
598 surplus = minLocal + (nPayload - minLocal)%(pPage->pBt->usableSize - 4);
drh6f11bef2004-05-13 01:12:56 +0000599 if( surplus <= maxLocal ){
600 pInfo->nLocal = surplus;
601 }else{
602 pInfo->nLocal = minLocal;
603 }
604 pInfo->iOverflow = pInfo->nLocal + n;
605 pInfo->nSize = pInfo->iOverflow + 4;
606 }
drh3aac2dd2004-04-26 14:10:20 +0000607}
danielk19771cc5ed82007-05-16 17:28:43 +0000608#define parseCell(pPage, iCell, pInfo) \
609 sqlite3BtreeParseCellPtr((pPage), findCell((pPage), (iCell)), (pInfo))
drh16a9b832007-05-05 18:39:25 +0000610void sqlite3BtreeParseCell(
drh43605152004-05-29 21:46:49 +0000611 MemPage *pPage, /* Page containing the cell */
612 int iCell, /* The cell index. First cell is 0 */
613 CellInfo *pInfo /* Fill in this structure */
614){
danielk19771cc5ed82007-05-16 17:28:43 +0000615 parseCell(pPage, iCell, pInfo);
drh43605152004-05-29 21:46:49 +0000616}
drh3aac2dd2004-04-26 14:10:20 +0000617
618/*
drh43605152004-05-29 21:46:49 +0000619** Compute the total number of bytes that a Cell needs in the cell
620** data area of the btree-page. The return number includes the cell
621** data header and the local payload, but not any overflow page or
622** the space used by the cell pointer.
drh3b7511c2001-05-26 13:15:44 +0000623*/
danielk1977bc6ada42004-06-30 08:20:16 +0000624#ifndef NDEBUG
drha9121e42008-02-19 14:59:35 +0000625static u16 cellSize(MemPage *pPage, int iCell){
drh6f11bef2004-05-13 01:12:56 +0000626 CellInfo info;
drh16a9b832007-05-05 18:39:25 +0000627 sqlite3BtreeParseCell(pPage, iCell, &info);
drh43605152004-05-29 21:46:49 +0000628 return info.nSize;
629}
danielk1977bc6ada42004-06-30 08:20:16 +0000630#endif
drha9121e42008-02-19 14:59:35 +0000631static u16 cellSizePtr(MemPage *pPage, u8 *pCell){
drh43605152004-05-29 21:46:49 +0000632 CellInfo info;
drh16a9b832007-05-05 18:39:25 +0000633 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +0000634 return info.nSize;
drh3b7511c2001-05-26 13:15:44 +0000635}
636
danielk197779a40da2005-01-16 08:00:01 +0000637#ifndef SQLITE_OMIT_AUTOVACUUM
drh3b7511c2001-05-26 13:15:44 +0000638/*
danielk197726836652005-01-17 01:33:13 +0000639** If the cell pCell, part of page pPage contains a pointer
danielk197779a40da2005-01-16 08:00:01 +0000640** to an overflow page, insert an entry into the pointer-map
641** for the overflow page.
danielk1977ac11ee62005-01-15 12:45:51 +0000642*/
danielk197726836652005-01-17 01:33:13 +0000643static int ptrmapPutOvflPtr(MemPage *pPage, u8 *pCell){
danielk197779a40da2005-01-16 08:00:01 +0000644 if( pCell ){
645 CellInfo info;
drh16a9b832007-05-05 18:39:25 +0000646 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh72365832007-03-06 15:53:44 +0000647 assert( (info.nData+(pPage->intKey?0:info.nKey))==info.nPayload );
danielk197779a40da2005-01-16 08:00:01 +0000648 if( (info.nData+(pPage->intKey?0:info.nKey))>info.nLocal ){
649 Pgno ovfl = get4byte(&pCell[info.iOverflow]);
650 return ptrmapPut(pPage->pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno);
651 }
danielk1977ac11ee62005-01-15 12:45:51 +0000652 }
danielk197779a40da2005-01-16 08:00:01 +0000653 return SQLITE_OK;
danielk1977ac11ee62005-01-15 12:45:51 +0000654}
danielk197726836652005-01-17 01:33:13 +0000655/*
656** If the cell with index iCell on page pPage contains a pointer
657** to an overflow page, insert an entry into the pointer-map
658** for the overflow page.
659*/
660static int ptrmapPutOvfl(MemPage *pPage, int iCell){
661 u8 *pCell;
drh1fee73e2007-08-29 04:00:57 +0000662 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk197726836652005-01-17 01:33:13 +0000663 pCell = findOverflowCell(pPage, iCell);
664 return ptrmapPutOvflPtr(pPage, pCell);
665}
danielk197779a40da2005-01-16 08:00:01 +0000666#endif
667
danielk1977ac11ee62005-01-15 12:45:51 +0000668
drhda200cc2004-05-09 11:51:38 +0000669/*
drh72f82862001-05-24 21:06:34 +0000670** Defragment the page given. All Cells are moved to the
drh3a4a2d42005-11-24 14:24:28 +0000671** end of the page and all free space is collected into one
672** big FreeBlk that occurs in between the header and cell
drh31beae92005-11-24 14:34:36 +0000673** pointer array and the cell content area.
drh365d68f2001-05-11 11:02:46 +0000674*/
drh2e38c322004-09-03 18:38:44 +0000675static int defragmentPage(MemPage *pPage){
drh43605152004-05-29 21:46:49 +0000676 int i; /* Loop counter */
677 int pc; /* Address of a i-th cell */
678 int addr; /* Offset of first byte after cell pointer array */
679 int hdr; /* Offset to the page header */
680 int size; /* Size of a cell */
681 int usableSize; /* Number of usable bytes on a page */
682 int cellOffset; /* Offset to the cell pointer array */
683 int brk; /* Offset to the cell content area */
684 int nCell; /* Number of cells on the page */
drh2e38c322004-09-03 18:38:44 +0000685 unsigned char *data; /* The page data */
686 unsigned char *temp; /* Temp area for cell content */
drh2af926b2001-05-15 00:39:25 +0000687
danielk19773b8a05f2007-03-19 17:44:26 +0000688 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +0000689 assert( pPage->pBt!=0 );
drh90f5ecb2004-07-22 01:19:35 +0000690 assert( pPage->pBt->usableSize <= SQLITE_MAX_PAGE_SIZE );
drh43605152004-05-29 21:46:49 +0000691 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +0000692 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh26b79942007-11-28 16:19:56 +0000693 temp = sqlite3PagerTempSpace(pPage->pBt->pPager);
drh43605152004-05-29 21:46:49 +0000694 data = pPage->aData;
drh9e572e62004-04-23 23:43:10 +0000695 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +0000696 cellOffset = pPage->cellOffset;
697 nCell = pPage->nCell;
698 assert( nCell==get2byte(&data[hdr+3]) );
699 usableSize = pPage->pBt->usableSize;
700 brk = get2byte(&data[hdr+5]);
701 memcpy(&temp[brk], &data[brk], usableSize - brk);
702 brk = usableSize;
703 for(i=0; i<nCell; i++){
704 u8 *pAddr; /* The i-th cell pointer */
705 pAddr = &data[cellOffset + i*2];
706 pc = get2byte(pAddr);
707 assert( pc<pPage->pBt->usableSize );
708 size = cellSizePtr(pPage, &temp[pc]);
709 brk -= size;
710 memcpy(&data[brk], &temp[pc], size);
711 put2byte(pAddr, brk);
drh2af926b2001-05-15 00:39:25 +0000712 }
drh43605152004-05-29 21:46:49 +0000713 assert( brk>=cellOffset+2*nCell );
714 put2byte(&data[hdr+5], brk);
715 data[hdr+1] = 0;
716 data[hdr+2] = 0;
717 data[hdr+7] = 0;
718 addr = cellOffset+2*nCell;
719 memset(&data[addr], 0, brk-addr);
drh2e38c322004-09-03 18:38:44 +0000720 return SQLITE_OK;
drh365d68f2001-05-11 11:02:46 +0000721}
722
drha059ad02001-04-17 20:09:11 +0000723/*
drh43605152004-05-29 21:46:49 +0000724** Allocate nByte bytes of space on a page.
drhbd03cae2001-06-02 02:40:57 +0000725**
drh9e572e62004-04-23 23:43:10 +0000726** Return the index into pPage->aData[] of the first byte of
drhbd03cae2001-06-02 02:40:57 +0000727** the new allocation. Or return 0 if there is not enough free
728** space on the page to satisfy the allocation request.
drh2af926b2001-05-15 00:39:25 +0000729**
drh72f82862001-05-24 21:06:34 +0000730** If the page contains nBytes of free space but does not contain
drh8b2f49b2001-06-08 00:21:52 +0000731** nBytes of contiguous free space, then this routine automatically
732** calls defragementPage() to consolidate all free space before
733** allocating the new chunk.
drh7e3b0a02001-04-28 16:52:40 +0000734*/
drh9e572e62004-04-23 23:43:10 +0000735static int allocateSpace(MemPage *pPage, int nByte){
drh3aac2dd2004-04-26 14:10:20 +0000736 int addr, pc, hdr;
drh9e572e62004-04-23 23:43:10 +0000737 int size;
drh24cd67e2004-05-10 16:18:47 +0000738 int nFrag;
drh43605152004-05-29 21:46:49 +0000739 int top;
740 int nCell;
741 int cellOffset;
drh9e572e62004-04-23 23:43:10 +0000742 unsigned char *data;
drh43605152004-05-29 21:46:49 +0000743
drh9e572e62004-04-23 23:43:10 +0000744 data = pPage->aData;
danielk19773b8a05f2007-03-19 17:44:26 +0000745 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +0000746 assert( pPage->pBt );
drh1fee73e2007-08-29 04:00:57 +0000747 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh9e572e62004-04-23 23:43:10 +0000748 if( nByte<4 ) nByte = 4;
drh43605152004-05-29 21:46:49 +0000749 if( pPage->nFree<nByte || pPage->nOverflow>0 ) return 0;
750 pPage->nFree -= nByte;
drh9e572e62004-04-23 23:43:10 +0000751 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +0000752
753 nFrag = data[hdr+7];
754 if( nFrag<60 ){
755 /* Search the freelist looking for a slot big enough to satisfy the
756 ** space request. */
757 addr = hdr+1;
758 while( (pc = get2byte(&data[addr]))>0 ){
759 size = get2byte(&data[pc+2]);
760 if( size>=nByte ){
761 if( size<nByte+4 ){
762 memcpy(&data[addr], &data[pc], 2);
763 data[hdr+7] = nFrag + size - nByte;
764 return pc;
765 }else{
766 put2byte(&data[pc+2], size-nByte);
767 return pc + size - nByte;
768 }
769 }
770 addr = pc;
drh9e572e62004-04-23 23:43:10 +0000771 }
772 }
drh43605152004-05-29 21:46:49 +0000773
774 /* Allocate memory from the gap in between the cell pointer array
775 ** and the cell content area.
776 */
777 top = get2byte(&data[hdr+5]);
778 nCell = get2byte(&data[hdr+3]);
779 cellOffset = pPage->cellOffset;
780 if( nFrag>=60 || cellOffset + 2*nCell > top - nByte ){
drh2e38c322004-09-03 18:38:44 +0000781 if( defragmentPage(pPage) ) return 0;
drh43605152004-05-29 21:46:49 +0000782 top = get2byte(&data[hdr+5]);
drh2af926b2001-05-15 00:39:25 +0000783 }
drh43605152004-05-29 21:46:49 +0000784 top -= nByte;
785 assert( cellOffset + 2*nCell <= top );
786 put2byte(&data[hdr+5], top);
787 return top;
drh7e3b0a02001-04-28 16:52:40 +0000788}
789
790/*
drh9e572e62004-04-23 23:43:10 +0000791** Return a section of the pPage->aData to the freelist.
792** The first byte of the new free block is pPage->aDisk[start]
793** and the size of the block is "size" bytes.
drh306dc212001-05-21 13:45:10 +0000794**
795** Most of the effort here is involved in coalesing adjacent
796** free blocks into a single big free block.
drh7e3b0a02001-04-28 16:52:40 +0000797*/
drh9e572e62004-04-23 23:43:10 +0000798static void freeSpace(MemPage *pPage, int start, int size){
drh43605152004-05-29 21:46:49 +0000799 int addr, pbegin, hdr;
drh9e572e62004-04-23 23:43:10 +0000800 unsigned char *data = pPage->aData;
drh2af926b2001-05-15 00:39:25 +0000801
drh9e572e62004-04-23 23:43:10 +0000802 assert( pPage->pBt!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +0000803 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +0000804 assert( start>=pPage->hdrOffset+6+(pPage->leaf?0:4) );
danielk1977bc6ada42004-06-30 08:20:16 +0000805 assert( (start + size)<=pPage->pBt->usableSize );
drh1fee73e2007-08-29 04:00:57 +0000806 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh9e572e62004-04-23 23:43:10 +0000807 if( size<4 ) size = 4;
808
drhfcce93f2006-02-22 03:08:32 +0000809#ifdef SQLITE_SECURE_DELETE
810 /* Overwrite deleted information with zeros when the SECURE_DELETE
811 ** option is enabled at compile-time */
812 memset(&data[start], 0, size);
813#endif
814
drh9e572e62004-04-23 23:43:10 +0000815 /* Add the space back into the linked list of freeblocks */
drh43605152004-05-29 21:46:49 +0000816 hdr = pPage->hdrOffset;
817 addr = hdr + 1;
drh3aac2dd2004-04-26 14:10:20 +0000818 while( (pbegin = get2byte(&data[addr]))<start && pbegin>0 ){
drhb6f41482004-05-14 01:58:11 +0000819 assert( pbegin<=pPage->pBt->usableSize-4 );
drh3aac2dd2004-04-26 14:10:20 +0000820 assert( pbegin>addr );
821 addr = pbegin;
drh2af926b2001-05-15 00:39:25 +0000822 }
drhb6f41482004-05-14 01:58:11 +0000823 assert( pbegin<=pPage->pBt->usableSize-4 );
drh3aac2dd2004-04-26 14:10:20 +0000824 assert( pbegin>addr || pbegin==0 );
drha34b6762004-05-07 13:30:42 +0000825 put2byte(&data[addr], start);
826 put2byte(&data[start], pbegin);
827 put2byte(&data[start+2], size);
drh2af926b2001-05-15 00:39:25 +0000828 pPage->nFree += size;
drh9e572e62004-04-23 23:43:10 +0000829
830 /* Coalesce adjacent free blocks */
drh3aac2dd2004-04-26 14:10:20 +0000831 addr = pPage->hdrOffset + 1;
832 while( (pbegin = get2byte(&data[addr]))>0 ){
drh9e572e62004-04-23 23:43:10 +0000833 int pnext, psize;
drh3aac2dd2004-04-26 14:10:20 +0000834 assert( pbegin>addr );
drh43605152004-05-29 21:46:49 +0000835 assert( pbegin<=pPage->pBt->usableSize-4 );
drh9e572e62004-04-23 23:43:10 +0000836 pnext = get2byte(&data[pbegin]);
837 psize = get2byte(&data[pbegin+2]);
838 if( pbegin + psize + 3 >= pnext && pnext>0 ){
839 int frag = pnext - (pbegin+psize);
drh43605152004-05-29 21:46:49 +0000840 assert( frag<=data[pPage->hdrOffset+7] );
841 data[pPage->hdrOffset+7] -= frag;
drh9e572e62004-04-23 23:43:10 +0000842 put2byte(&data[pbegin], get2byte(&data[pnext]));
843 put2byte(&data[pbegin+2], pnext+get2byte(&data[pnext+2])-pbegin);
844 }else{
drh3aac2dd2004-04-26 14:10:20 +0000845 addr = pbegin;
drh9e572e62004-04-23 23:43:10 +0000846 }
847 }
drh7e3b0a02001-04-28 16:52:40 +0000848
drh43605152004-05-29 21:46:49 +0000849 /* If the cell content area begins with a freeblock, remove it. */
850 if( data[hdr+1]==data[hdr+5] && data[hdr+2]==data[hdr+6] ){
851 int top;
852 pbegin = get2byte(&data[hdr+1]);
853 memcpy(&data[hdr+1], &data[pbegin], 2);
854 top = get2byte(&data[hdr+5]);
855 put2byte(&data[hdr+5], top + get2byte(&data[pbegin+2]));
drh4b70f112004-05-02 21:12:19 +0000856 }
drh4b70f112004-05-02 21:12:19 +0000857}
858
859/*
drh271efa52004-05-30 19:19:05 +0000860** Decode the flags byte (the first byte of the header) for a page
861** and initialize fields of the MemPage structure accordingly.
862*/
863static void decodeFlags(MemPage *pPage, int flagByte){
danielk1977aef0bf62005-12-30 16:28:01 +0000864 BtShared *pBt; /* A copy of pPage->pBt */
drh271efa52004-05-30 19:19:05 +0000865
866 assert( pPage->hdrOffset==(pPage->pgno==1 ? 100 : 0) );
drh1fee73e2007-08-29 04:00:57 +0000867 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh271efa52004-05-30 19:19:05 +0000868 pPage->intKey = (flagByte & (PTF_INTKEY|PTF_LEAFDATA))!=0;
869 pPage->zeroData = (flagByte & PTF_ZERODATA)!=0;
870 pPage->leaf = (flagByte & PTF_LEAF)!=0;
871 pPage->childPtrSize = 4*(pPage->leaf==0);
872 pBt = pPage->pBt;
873 if( flagByte & PTF_LEAFDATA ){
874 pPage->leafData = 1;
875 pPage->maxLocal = pBt->maxLeaf;
876 pPage->minLocal = pBt->minLeaf;
877 }else{
878 pPage->leafData = 0;
879 pPage->maxLocal = pBt->maxLocal;
880 pPage->minLocal = pBt->minLocal;
881 }
882 pPage->hasData = !(pPage->zeroData || (!pPage->leaf && pPage->leafData));
883}
884
885/*
drh7e3b0a02001-04-28 16:52:40 +0000886** Initialize the auxiliary information for a disk block.
drh72f82862001-05-24 21:06:34 +0000887**
drhbd03cae2001-06-02 02:40:57 +0000888** The pParent parameter must be a pointer to the MemPage which
drh9e572e62004-04-23 23:43:10 +0000889** is the parent of the page being initialized. The root of a
890** BTree has no parent and so for that page, pParent==NULL.
drh5e2f8b92001-05-28 00:41:15 +0000891**
drh72f82862001-05-24 21:06:34 +0000892** Return SQLITE_OK on success. If we see that the page does
drhda47d772002-12-02 04:25:19 +0000893** not contain a well-formed database page, then return
drh72f82862001-05-24 21:06:34 +0000894** SQLITE_CORRUPT. Note that a return of SQLITE_OK does not
895** guarantee that the page is well-formed. It only shows that
896** we failed to detect any corruption.
drh7e3b0a02001-04-28 16:52:40 +0000897*/
drh16a9b832007-05-05 18:39:25 +0000898int sqlite3BtreeInitPage(
drh3aac2dd2004-04-26 14:10:20 +0000899 MemPage *pPage, /* The page to be initialized */
drh9e572e62004-04-23 23:43:10 +0000900 MemPage *pParent /* The parent. Might be NULL */
901){
drh271efa52004-05-30 19:19:05 +0000902 int pc; /* Address of a freeblock within pPage->aData[] */
drh271efa52004-05-30 19:19:05 +0000903 int hdr; /* Offset to beginning of page header */
904 u8 *data; /* Equal to pPage->aData */
danielk1977aef0bf62005-12-30 16:28:01 +0000905 BtShared *pBt; /* The main btree structure */
drh271efa52004-05-30 19:19:05 +0000906 int usableSize; /* Amount of usable space on each page */
907 int cellOffset; /* Offset from start of page to first cell pointer */
908 int nFree; /* Number of unused bytes on the page */
909 int top; /* First byte of the cell content area */
drh2af926b2001-05-15 00:39:25 +0000910
drh2e38c322004-09-03 18:38:44 +0000911 pBt = pPage->pBt;
912 assert( pBt!=0 );
913 assert( pParent==0 || pParent->pBt==pBt );
drh1fee73e2007-08-29 04:00:57 +0000914 assert( sqlite3_mutex_held(pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +0000915 assert( pPage->pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
drhbf4bca52007-09-06 22:19:14 +0000916 assert( pPage == sqlite3PagerGetExtra(pPage->pDbPage) );
917 assert( pPage->aData == sqlite3PagerGetData(pPage->pDbPage) );
drhee696e22004-08-30 16:52:17 +0000918 if( pPage->pParent!=pParent && (pPage->pParent!=0 || pPage->isInit) ){
919 /* The parent page should never change unless the file is corrupt */
drh49285702005-09-17 15:20:26 +0000920 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000921 }
drh10617cd2004-05-14 15:27:27 +0000922 if( pPage->isInit ) return SQLITE_OK;
drhda200cc2004-05-09 11:51:38 +0000923 if( pPage->pParent==0 && pParent!=0 ){
924 pPage->pParent = pParent;
danielk19773b8a05f2007-03-19 17:44:26 +0000925 sqlite3PagerRef(pParent->pDbPage);
drh5e2f8b92001-05-28 00:41:15 +0000926 }
drhde647132004-05-07 17:57:49 +0000927 hdr = pPage->hdrOffset;
drha34b6762004-05-07 13:30:42 +0000928 data = pPage->aData;
drh271efa52004-05-30 19:19:05 +0000929 decodeFlags(pPage, data[hdr]);
drh43605152004-05-29 21:46:49 +0000930 pPage->nOverflow = 0;
drhc8629a12004-05-08 20:07:40 +0000931 pPage->idxShift = 0;
drh2e38c322004-09-03 18:38:44 +0000932 usableSize = pBt->usableSize;
drh43605152004-05-29 21:46:49 +0000933 pPage->cellOffset = cellOffset = hdr + 12 - 4*pPage->leaf;
934 top = get2byte(&data[hdr+5]);
935 pPage->nCell = get2byte(&data[hdr+3]);
drh2e38c322004-09-03 18:38:44 +0000936 if( pPage->nCell>MX_CELL(pBt) ){
drhee696e22004-08-30 16:52:17 +0000937 /* To many cells for a single page. The page must be corrupt */
drh49285702005-09-17 15:20:26 +0000938 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000939 }
940 if( pPage->nCell==0 && pParent!=0 && pParent->pgno!=1 ){
941 /* All pages must have at least one cell, except for root pages */
drh49285702005-09-17 15:20:26 +0000942 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000943 }
drh9e572e62004-04-23 23:43:10 +0000944
945 /* Compute the total free space on the page */
drh9e572e62004-04-23 23:43:10 +0000946 pc = get2byte(&data[hdr+1]);
drh43605152004-05-29 21:46:49 +0000947 nFree = data[hdr+7] + top - (cellOffset + 2*pPage->nCell);
drh9e572e62004-04-23 23:43:10 +0000948 while( pc>0 ){
949 int next, size;
drhee696e22004-08-30 16:52:17 +0000950 if( pc>usableSize-4 ){
951 /* Free block is off the page */
drh49285702005-09-17 15:20:26 +0000952 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000953 }
drh9e572e62004-04-23 23:43:10 +0000954 next = get2byte(&data[pc]);
955 size = get2byte(&data[pc+2]);
drhee696e22004-08-30 16:52:17 +0000956 if( next>0 && next<=pc+size+3 ){
957 /* Free blocks must be in accending order */
drh49285702005-09-17 15:20:26 +0000958 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000959 }
drh3add3672004-05-15 00:29:24 +0000960 nFree += size;
drh9e572e62004-04-23 23:43:10 +0000961 pc = next;
962 }
drh3add3672004-05-15 00:29:24 +0000963 pPage->nFree = nFree;
drhee696e22004-08-30 16:52:17 +0000964 if( nFree>=usableSize ){
965 /* Free space cannot exceed total page size */
drh49285702005-09-17 15:20:26 +0000966 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +0000967 }
drh9e572e62004-04-23 23:43:10 +0000968
drhde647132004-05-07 17:57:49 +0000969 pPage->isInit = 1;
drh9e572e62004-04-23 23:43:10 +0000970 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +0000971}
972
973/*
drh8b2f49b2001-06-08 00:21:52 +0000974** Set up a raw page so that it looks like a database page holding
975** no entries.
drhbd03cae2001-06-02 02:40:57 +0000976*/
drh9e572e62004-04-23 23:43:10 +0000977static void zeroPage(MemPage *pPage, int flags){
978 unsigned char *data = pPage->aData;
danielk1977aef0bf62005-12-30 16:28:01 +0000979 BtShared *pBt = pPage->pBt;
drh3aac2dd2004-04-26 14:10:20 +0000980 int hdr = pPage->hdrOffset;
drh9e572e62004-04-23 23:43:10 +0000981 int first;
982
danielk19773b8a05f2007-03-19 17:44:26 +0000983 assert( sqlite3PagerPagenumber(pPage->pDbPage)==pPage->pgno );
drhbf4bca52007-09-06 22:19:14 +0000984 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
985 assert( sqlite3PagerGetData(pPage->pDbPage) == data );
danielk19773b8a05f2007-03-19 17:44:26 +0000986 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +0000987 assert( sqlite3_mutex_held(pBt->mutex) );
drhb6f41482004-05-14 01:58:11 +0000988 memset(&data[hdr], 0, pBt->usableSize - hdr);
drh9e572e62004-04-23 23:43:10 +0000989 data[hdr] = flags;
drh43605152004-05-29 21:46:49 +0000990 first = hdr + 8 + 4*((flags&PTF_LEAF)==0);
991 memset(&data[hdr+1], 0, 4);
992 data[hdr+7] = 0;
993 put2byte(&data[hdr+5], pBt->usableSize);
drhb6f41482004-05-14 01:58:11 +0000994 pPage->nFree = pBt->usableSize - first;
drh271efa52004-05-30 19:19:05 +0000995 decodeFlags(pPage, flags);
drh9e572e62004-04-23 23:43:10 +0000996 pPage->hdrOffset = hdr;
drh43605152004-05-29 21:46:49 +0000997 pPage->cellOffset = first;
998 pPage->nOverflow = 0;
drhda200cc2004-05-09 11:51:38 +0000999 pPage->idxShift = 0;
drh43605152004-05-29 21:46:49 +00001000 pPage->nCell = 0;
drhda200cc2004-05-09 11:51:38 +00001001 pPage->isInit = 1;
drhbd03cae2001-06-02 02:40:57 +00001002}
1003
1004/*
drh3aac2dd2004-04-26 14:10:20 +00001005** Get a page from the pager. Initialize the MemPage.pBt and
1006** MemPage.aData elements if needed.
drh538f5702007-04-13 02:14:30 +00001007**
1008** If the noContent flag is set, it means that we do not care about
1009** the content of the page at this time. So do not go to the disk
1010** to fetch the content. Just fill in the content with zeros for now.
1011** If in the future we call sqlite3PagerWrite() on this page, that
1012** means we have started to be concerned about content and the disk
1013** read should occur at that point.
drh3aac2dd2004-04-26 14:10:20 +00001014*/
drh16a9b832007-05-05 18:39:25 +00001015int sqlite3BtreeGetPage(
1016 BtShared *pBt, /* The btree */
1017 Pgno pgno, /* Number of the page to fetch */
1018 MemPage **ppPage, /* Return the page in this parameter */
1019 int noContent /* Do not load page content if true */
1020){
drh3aac2dd2004-04-26 14:10:20 +00001021 int rc;
drh3aac2dd2004-04-26 14:10:20 +00001022 MemPage *pPage;
danielk19773b8a05f2007-03-19 17:44:26 +00001023 DbPage *pDbPage;
1024
drh1fee73e2007-08-29 04:00:57 +00001025 assert( sqlite3_mutex_held(pBt->mutex) );
drh538f5702007-04-13 02:14:30 +00001026 rc = sqlite3PagerAcquire(pBt->pPager, pgno, (DbPage**)&pDbPage, noContent);
drh3aac2dd2004-04-26 14:10:20 +00001027 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00001028 pPage = (MemPage *)sqlite3PagerGetExtra(pDbPage);
1029 pPage->aData = sqlite3PagerGetData(pDbPage);
1030 pPage->pDbPage = pDbPage;
drh3aac2dd2004-04-26 14:10:20 +00001031 pPage->pBt = pBt;
1032 pPage->pgno = pgno;
drhde647132004-05-07 17:57:49 +00001033 pPage->hdrOffset = pPage->pgno==1 ? 100 : 0;
drh3aac2dd2004-04-26 14:10:20 +00001034 *ppPage = pPage;
1035 return SQLITE_OK;
1036}
1037
1038/*
drhde647132004-05-07 17:57:49 +00001039** Get a page from the pager and initialize it. This routine
1040** is just a convenience wrapper around separate calls to
drh16a9b832007-05-05 18:39:25 +00001041** sqlite3BtreeGetPage() and sqlite3BtreeInitPage().
drhde647132004-05-07 17:57:49 +00001042*/
1043static int getAndInitPage(
danielk1977aef0bf62005-12-30 16:28:01 +00001044 BtShared *pBt, /* The database file */
drhde647132004-05-07 17:57:49 +00001045 Pgno pgno, /* Number of the page to get */
1046 MemPage **ppPage, /* Write the page pointer here */
1047 MemPage *pParent /* Parent of the page */
1048){
1049 int rc;
drh1fee73e2007-08-29 04:00:57 +00001050 assert( sqlite3_mutex_held(pBt->mutex) );
drhee696e22004-08-30 16:52:17 +00001051 if( pgno==0 ){
drh49285702005-09-17 15:20:26 +00001052 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +00001053 }
drh16a9b832007-05-05 18:39:25 +00001054 rc = sqlite3BtreeGetPage(pBt, pgno, ppPage, 0);
drh10617cd2004-05-14 15:27:27 +00001055 if( rc==SQLITE_OK && (*ppPage)->isInit==0 ){
drh16a9b832007-05-05 18:39:25 +00001056 rc = sqlite3BtreeInitPage(*ppPage, pParent);
drhde647132004-05-07 17:57:49 +00001057 }
1058 return rc;
1059}
1060
1061/*
drh3aac2dd2004-04-26 14:10:20 +00001062** Release a MemPage. This should be called once for each prior
drh16a9b832007-05-05 18:39:25 +00001063** call to sqlite3BtreeGetPage.
drh3aac2dd2004-04-26 14:10:20 +00001064*/
drh4b70f112004-05-02 21:12:19 +00001065static void releasePage(MemPage *pPage){
drh3aac2dd2004-04-26 14:10:20 +00001066 if( pPage ){
1067 assert( pPage->aData );
1068 assert( pPage->pBt );
drhbf4bca52007-09-06 22:19:14 +00001069 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
1070 assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
drh1fee73e2007-08-29 04:00:57 +00001071 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00001072 sqlite3PagerUnref(pPage->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00001073 }
1074}
1075
1076/*
drh72f82862001-05-24 21:06:34 +00001077** This routine is called when the reference count for a page
1078** reaches zero. We need to unref the pParent pointer when that
1079** happens.
1080*/
danielk19773b8a05f2007-03-19 17:44:26 +00001081static void pageDestructor(DbPage *pData, int pageSize){
drh07d183d2005-05-01 22:52:42 +00001082 MemPage *pPage;
1083 assert( (pageSize & 7)==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00001084 pPage = (MemPage *)sqlite3PagerGetExtra(pData);
drh1fee73e2007-08-29 04:00:57 +00001085 assert( pPage->isInit==0 || sqlite3_mutex_held(pPage->pBt->mutex) );
drh72f82862001-05-24 21:06:34 +00001086 if( pPage->pParent ){
1087 MemPage *pParent = pPage->pParent;
drhd0679ed2007-08-28 22:24:34 +00001088 assert( pParent->pBt==pPage->pBt );
drh72f82862001-05-24 21:06:34 +00001089 pPage->pParent = 0;
drha34b6762004-05-07 13:30:42 +00001090 releasePage(pParent);
drh72f82862001-05-24 21:06:34 +00001091 }
drh3aac2dd2004-04-26 14:10:20 +00001092 pPage->isInit = 0;
drh72f82862001-05-24 21:06:34 +00001093}
1094
1095/*
drha6abd042004-06-09 17:37:22 +00001096** During a rollback, when the pager reloads information into the cache
1097** so that the cache is restored to its original state at the start of
1098** the transaction, for each page restored this routine is called.
1099**
1100** This routine needs to reset the extra data section at the end of the
1101** page to agree with the restored data.
1102*/
danielk19773b8a05f2007-03-19 17:44:26 +00001103static void pageReinit(DbPage *pData, int pageSize){
drh07d183d2005-05-01 22:52:42 +00001104 MemPage *pPage;
1105 assert( (pageSize & 7)==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00001106 pPage = (MemPage *)sqlite3PagerGetExtra(pData);
drha6abd042004-06-09 17:37:22 +00001107 if( pPage->isInit ){
drh1fee73e2007-08-29 04:00:57 +00001108 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drha6abd042004-06-09 17:37:22 +00001109 pPage->isInit = 0;
drh16a9b832007-05-05 18:39:25 +00001110 sqlite3BtreeInitPage(pPage, pPage->pParent);
drha6abd042004-06-09 17:37:22 +00001111 }
1112}
1113
1114/*
drhe5fe6902007-12-07 18:55:28 +00001115** Invoke the busy handler for a btree.
1116*/
1117static int sqlite3BtreeInvokeBusyHandler(void *pArg, int n){
1118 BtShared *pBt = (BtShared*)pArg;
1119 assert( pBt->db );
1120 assert( sqlite3_mutex_held(pBt->db->mutex) );
1121 return sqlite3InvokeBusyHandler(&pBt->db->busyHandler);
1122}
1123
1124/*
drhad3e0102004-09-03 23:32:18 +00001125** Open a database file.
1126**
drh382c0242001-10-06 16:33:02 +00001127** zFilename is the name of the database file. If zFilename is NULL
drh1bee3d72001-10-15 00:44:35 +00001128** a new database with a random name is created. This randomly named
drh23e11ca2004-05-04 17:27:28 +00001129** database file will be deleted when sqlite3BtreeClose() is called.
drhe53831d2007-08-17 01:14:38 +00001130** If zFilename is ":memory:" then an in-memory database is created
1131** that is automatically destroyed when it is closed.
drha059ad02001-04-17 20:09:11 +00001132*/
drh23e11ca2004-05-04 17:27:28 +00001133int sqlite3BtreeOpen(
drh3aac2dd2004-04-26 14:10:20 +00001134 const char *zFilename, /* Name of the file containing the BTree database */
drhe5fe6902007-12-07 18:55:28 +00001135 sqlite3 *db, /* Associated database handle */
drh3aac2dd2004-04-26 14:10:20 +00001136 Btree **ppBtree, /* Pointer to new Btree object written here */
drh33f4e022007-09-03 15:19:34 +00001137 int flags, /* Options */
1138 int vfsFlags /* Flags passed through to sqlite3_vfs.xOpen() */
drh6019e162001-07-02 17:51:45 +00001139){
drhd677b3d2007-08-20 22:48:41 +00001140 sqlite3_vfs *pVfs; /* The VFS to use for this btree */
drhe53831d2007-08-17 01:14:38 +00001141 BtShared *pBt = 0; /* Shared part of btree structure */
danielk1977aef0bf62005-12-30 16:28:01 +00001142 Btree *p; /* Handle to return */
danielk1977dddbcdc2007-04-26 14:42:34 +00001143 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00001144 int nReserve;
1145 unsigned char zDbHeader[100];
danielk1977aef0bf62005-12-30 16:28:01 +00001146
1147 /* Set the variable isMemdb to true for an in-memory database, or
1148 ** false for a file-based database. This symbol is only required if
1149 ** either of the shared-data or autovacuum features are compiled
1150 ** into the library.
1151 */
1152#if !defined(SQLITE_OMIT_SHARED_CACHE) || !defined(SQLITE_OMIT_AUTOVACUUM)
1153 #ifdef SQLITE_OMIT_MEMORYDB
drh980b1a72006-08-16 16:42:48 +00001154 const int isMemdb = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001155 #else
drh980b1a72006-08-16 16:42:48 +00001156 const int isMemdb = zFilename && !strcmp(zFilename, ":memory:");
danielk1977aef0bf62005-12-30 16:28:01 +00001157 #endif
1158#endif
1159
drhe5fe6902007-12-07 18:55:28 +00001160 assert( db!=0 );
1161 assert( sqlite3_mutex_held(db->mutex) );
drh153c62c2007-08-24 03:51:33 +00001162
drhe5fe6902007-12-07 18:55:28 +00001163 pVfs = db->pVfs;
drh17435752007-08-16 04:30:38 +00001164 p = sqlite3MallocZero(sizeof(Btree));
danielk1977aef0bf62005-12-30 16:28:01 +00001165 if( !p ){
1166 return SQLITE_NOMEM;
1167 }
1168 p->inTrans = TRANS_NONE;
drhe5fe6902007-12-07 18:55:28 +00001169 p->db = db;
danielk1977aef0bf62005-12-30 16:28:01 +00001170
drh198bf392006-01-06 21:52:49 +00001171#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00001172 /*
1173 ** If this Btree is a candidate for shared cache, try to find an
1174 ** existing BtShared object that we can share with
1175 */
1176 if( (flags & BTREE_PRIVATE)==0
1177 && isMemdb==0
drhe5fe6902007-12-07 18:55:28 +00001178 && (db->flags & SQLITE_Vtab)==0
drhe53831d2007-08-17 01:14:38 +00001179 && zFilename && zFilename[0]
drhe53831d2007-08-17 01:14:38 +00001180 ){
drhff0587c2007-08-29 17:43:19 +00001181 if( sqlite3SharedCacheEnabled ){
danielk1977adfb9b02007-09-17 07:02:56 +00001182 int nFullPathname = pVfs->mxPathname+1;
1183 char *zFullPathname = (char *)sqlite3_malloc(nFullPathname);
drhff0587c2007-08-29 17:43:19 +00001184 sqlite3_mutex *mutexShared;
1185 p->sharable = 1;
drhe5fe6902007-12-07 18:55:28 +00001186 if( db ){
1187 db->flags |= SQLITE_SharedCache;
danielk1977aef0bf62005-12-30 16:28:01 +00001188 }
drhff0587c2007-08-29 17:43:19 +00001189 if( !zFullPathname ){
1190 sqlite3_free(p);
1191 return SQLITE_NOMEM;
1192 }
danielk1977adfb9b02007-09-17 07:02:56 +00001193 sqlite3OsFullPathname(pVfs, zFilename, nFullPathname, zFullPathname);
drhff0587c2007-08-29 17:43:19 +00001194 mutexShared = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MASTER);
1195 sqlite3_mutex_enter(mutexShared);
1196 for(pBt=sqlite3SharedCacheList; pBt; pBt=pBt->pNext){
1197 assert( pBt->nRef>0 );
1198 if( 0==strcmp(zFullPathname, sqlite3PagerFilename(pBt->pPager))
1199 && sqlite3PagerVfs(pBt->pPager)==pVfs ){
1200 p->pBt = pBt;
1201 pBt->nRef++;
1202 break;
1203 }
1204 }
1205 sqlite3_mutex_leave(mutexShared);
1206 sqlite3_free(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001207 }
drhff0587c2007-08-29 17:43:19 +00001208#ifdef SQLITE_DEBUG
1209 else{
1210 /* In debug mode, we mark all persistent databases as sharable
1211 ** even when they are not. This exercises the locking code and
1212 ** gives more opportunity for asserts(sqlite3_mutex_held())
1213 ** statements to find locking problems.
1214 */
1215 p->sharable = 1;
1216 }
1217#endif
danielk1977aef0bf62005-12-30 16:28:01 +00001218 }
1219#endif
drha059ad02001-04-17 20:09:11 +00001220 if( pBt==0 ){
drhe53831d2007-08-17 01:14:38 +00001221 /*
1222 ** The following asserts make sure that structures used by the btree are
1223 ** the right size. This is to guard against size changes that result
1224 ** when compiling on a different architecture.
danielk197703aded42004-11-22 05:26:27 +00001225 */
drhe53831d2007-08-17 01:14:38 +00001226 assert( sizeof(i64)==8 || sizeof(i64)==4 );
1227 assert( sizeof(u64)==8 || sizeof(u64)==4 );
1228 assert( sizeof(u32)==4 );
1229 assert( sizeof(u16)==2 );
1230 assert( sizeof(Pgno)==4 );
1231
1232 pBt = sqlite3MallocZero( sizeof(*pBt) );
1233 if( pBt==0 ){
1234 rc = SQLITE_NOMEM;
1235 goto btree_open_out;
1236 }
drhe5fe6902007-12-07 18:55:28 +00001237 pBt->busyHdr.xFunc = sqlite3BtreeInvokeBusyHandler;
1238 pBt->busyHdr.pArg = pBt;
drh33f4e022007-09-03 15:19:34 +00001239 rc = sqlite3PagerOpen(pVfs, &pBt->pPager, zFilename,
1240 EXTRA_SIZE, flags, vfsFlags);
drhe53831d2007-08-17 01:14:38 +00001241 if( rc==SQLITE_OK ){
1242 rc = sqlite3PagerReadFileheader(pBt->pPager,sizeof(zDbHeader),zDbHeader);
1243 }
1244 if( rc!=SQLITE_OK ){
1245 goto btree_open_out;
1246 }
drhe5fe6902007-12-07 18:55:28 +00001247 sqlite3PagerSetBusyhandler(pBt->pPager, &pBt->busyHdr);
drhe53831d2007-08-17 01:14:38 +00001248 p->pBt = pBt;
1249
1250 sqlite3PagerSetDestructor(pBt->pPager, pageDestructor);
1251 sqlite3PagerSetReiniter(pBt->pPager, pageReinit);
1252 pBt->pCursor = 0;
1253 pBt->pPage1 = 0;
1254 pBt->readOnly = sqlite3PagerIsreadonly(pBt->pPager);
1255 pBt->pageSize = get2byte(&zDbHeader[16]);
1256 if( pBt->pageSize<512 || pBt->pageSize>SQLITE_MAX_PAGE_SIZE
1257 || ((pBt->pageSize-1)&pBt->pageSize)!=0 ){
danielk1977a1644fd2007-08-29 12:31:25 +00001258 pBt->pageSize = 0;
1259 sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize);
drhe53831d2007-08-17 01:14:38 +00001260 pBt->maxEmbedFrac = 64; /* 25% */
1261 pBt->minEmbedFrac = 32; /* 12.5% */
1262 pBt->minLeafFrac = 32; /* 12.5% */
1263#ifndef SQLITE_OMIT_AUTOVACUUM
1264 /* If the magic name ":memory:" will create an in-memory database, then
1265 ** leave the autoVacuum mode at 0 (do not auto-vacuum), even if
1266 ** SQLITE_DEFAULT_AUTOVACUUM is true. On the other hand, if
1267 ** SQLITE_OMIT_MEMORYDB has been defined, then ":memory:" is just a
1268 ** regular file-name. In this case the auto-vacuum applies as per normal.
1269 */
1270 if( zFilename && !isMemdb ){
1271 pBt->autoVacuum = (SQLITE_DEFAULT_AUTOVACUUM ? 1 : 0);
1272 pBt->incrVacuum = (SQLITE_DEFAULT_AUTOVACUUM==2 ? 1 : 0);
1273 }
1274#endif
1275 nReserve = 0;
1276 }else{
1277 nReserve = zDbHeader[20];
1278 pBt->maxEmbedFrac = zDbHeader[21];
1279 pBt->minEmbedFrac = zDbHeader[22];
1280 pBt->minLeafFrac = zDbHeader[23];
1281 pBt->pageSizeFixed = 1;
1282#ifndef SQLITE_OMIT_AUTOVACUUM
1283 pBt->autoVacuum = (get4byte(&zDbHeader[36 + 4*4])?1:0);
1284 pBt->incrVacuum = (get4byte(&zDbHeader[36 + 7*4])?1:0);
1285#endif
1286 }
1287 pBt->usableSize = pBt->pageSize - nReserve;
1288 assert( (pBt->pageSize & 7)==0 ); /* 8-byte alignment of pageSize */
danielk1977a1644fd2007-08-29 12:31:25 +00001289 sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize);
drhe53831d2007-08-17 01:14:38 +00001290
1291#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
1292 /* Add the new BtShared object to the linked list sharable BtShareds.
1293 */
1294 if( p->sharable ){
1295 sqlite3_mutex *mutexShared;
1296 pBt->nRef = 1;
1297 mutexShared = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MASTER);
drh3285db22007-09-03 22:00:39 +00001298 if( SQLITE_THREADSAFE ){
1299 pBt->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_FAST);
1300 if( pBt->mutex==0 ){
1301 rc = SQLITE_NOMEM;
drhe5fe6902007-12-07 18:55:28 +00001302 db->mallocFailed = 0;
drh3285db22007-09-03 22:00:39 +00001303 goto btree_open_out;
1304 }
drhff0587c2007-08-29 17:43:19 +00001305 }
drhe53831d2007-08-17 01:14:38 +00001306 sqlite3_mutex_enter(mutexShared);
1307 pBt->pNext = sqlite3SharedCacheList;
1308 sqlite3SharedCacheList = pBt;
1309 sqlite3_mutex_leave(mutexShared);
danielk1977951af802004-11-05 15:45:09 +00001310 }
drheee46cf2004-11-06 00:02:48 +00001311#endif
drh90f5ecb2004-07-22 01:19:35 +00001312 }
danielk1977aef0bf62005-12-30 16:28:01 +00001313
drhcfed7bc2006-03-13 14:28:05 +00001314#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00001315 /* If the new Btree uses a sharable pBtShared, then link the new
1316 ** Btree into the list of all sharable Btrees for the same connection.
drhabddb0c2007-08-20 13:14:28 +00001317 ** The list is kept in ascending order by pBt address.
danielk197754f01982006-01-18 15:25:17 +00001318 */
drhe53831d2007-08-17 01:14:38 +00001319 if( p->sharable ){
1320 int i;
1321 Btree *pSib;
drhe5fe6902007-12-07 18:55:28 +00001322 for(i=0; i<db->nDb; i++){
1323 if( (pSib = db->aDb[i].pBt)!=0 && pSib->sharable ){
drhe53831d2007-08-17 01:14:38 +00001324 while( pSib->pPrev ){ pSib = pSib->pPrev; }
1325 if( p->pBt<pSib->pBt ){
1326 p->pNext = pSib;
1327 p->pPrev = 0;
1328 pSib->pPrev = p;
1329 }else{
drhabddb0c2007-08-20 13:14:28 +00001330 while( pSib->pNext && pSib->pNext->pBt<p->pBt ){
drhe53831d2007-08-17 01:14:38 +00001331 pSib = pSib->pNext;
1332 }
1333 p->pNext = pSib->pNext;
1334 p->pPrev = pSib;
1335 if( p->pNext ){
1336 p->pNext->pPrev = p;
1337 }
1338 pSib->pNext = p;
1339 }
1340 break;
1341 }
1342 }
danielk1977aef0bf62005-12-30 16:28:01 +00001343 }
danielk1977aef0bf62005-12-30 16:28:01 +00001344#endif
1345 *ppBtree = p;
danielk1977dddbcdc2007-04-26 14:42:34 +00001346
1347btree_open_out:
1348 if( rc!=SQLITE_OK ){
1349 if( pBt && pBt->pPager ){
1350 sqlite3PagerClose(pBt->pPager);
1351 }
drh17435752007-08-16 04:30:38 +00001352 sqlite3_free(pBt);
1353 sqlite3_free(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00001354 *ppBtree = 0;
1355 }
1356 return rc;
drha059ad02001-04-17 20:09:11 +00001357}
1358
1359/*
drhe53831d2007-08-17 01:14:38 +00001360** Decrement the BtShared.nRef counter. When it reaches zero,
1361** remove the BtShared structure from the sharing list. Return
1362** true if the BtShared.nRef counter reaches zero and return
1363** false if it is still positive.
1364*/
1365static int removeFromSharingList(BtShared *pBt){
1366#ifndef SQLITE_OMIT_SHARED_CACHE
1367 sqlite3_mutex *pMaster;
1368 BtShared *pList;
1369 int removed = 0;
1370
drhd677b3d2007-08-20 22:48:41 +00001371 assert( sqlite3_mutex_notheld(pBt->mutex) );
drhe53831d2007-08-17 01:14:38 +00001372 pMaster = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MASTER);
1373 sqlite3_mutex_enter(pMaster);
1374 pBt->nRef--;
1375 if( pBt->nRef<=0 ){
1376 if( sqlite3SharedCacheList==pBt ){
1377 sqlite3SharedCacheList = pBt->pNext;
1378 }else{
1379 pList = sqlite3SharedCacheList;
1380 while( pList && pList->pNext!=pBt ){
1381 pList=pList->pNext;
1382 }
1383 if( pList ){
1384 pList->pNext = pBt->pNext;
1385 }
1386 }
drh3285db22007-09-03 22:00:39 +00001387 if( SQLITE_THREADSAFE ){
1388 sqlite3_mutex_free(pBt->mutex);
1389 }
drhe53831d2007-08-17 01:14:38 +00001390 removed = 1;
1391 }
1392 sqlite3_mutex_leave(pMaster);
1393 return removed;
1394#else
1395 return 1;
1396#endif
1397}
1398
1399/*
drha059ad02001-04-17 20:09:11 +00001400** Close an open database and invalidate all cursors.
1401*/
danielk1977aef0bf62005-12-30 16:28:01 +00001402int sqlite3BtreeClose(Btree *p){
danielk1977aef0bf62005-12-30 16:28:01 +00001403 BtShared *pBt = p->pBt;
1404 BtCursor *pCur;
1405
danielk1977aef0bf62005-12-30 16:28:01 +00001406 /* Close all cursors opened via this handle. */
drhe5fe6902007-12-07 18:55:28 +00001407 assert( sqlite3_mutex_held(p->db->mutex) );
drhe53831d2007-08-17 01:14:38 +00001408 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00001409 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00001410 pCur = pBt->pCursor;
1411 while( pCur ){
1412 BtCursor *pTmp = pCur;
1413 pCur = pCur->pNext;
1414 if( pTmp->pBtree==p ){
1415 sqlite3BtreeCloseCursor(pTmp);
1416 }
drha059ad02001-04-17 20:09:11 +00001417 }
danielk1977aef0bf62005-12-30 16:28:01 +00001418
danielk19778d34dfd2006-01-24 16:37:57 +00001419 /* Rollback any active transaction and free the handle structure.
1420 ** The call to sqlite3BtreeRollback() drops any table-locks held by
1421 ** this handle.
1422 */
danielk1977b597f742006-01-15 11:39:18 +00001423 sqlite3BtreeRollback(p);
drhe53831d2007-08-17 01:14:38 +00001424 sqlite3BtreeLeave(p);
danielk1977aef0bf62005-12-30 16:28:01 +00001425
danielk1977aef0bf62005-12-30 16:28:01 +00001426 /* If there are still other outstanding references to the shared-btree
1427 ** structure, return now. The remainder of this procedure cleans
1428 ** up the shared-btree.
1429 */
drhe53831d2007-08-17 01:14:38 +00001430 assert( p->wantToLock==0 && p->locked==0 );
1431 if( !p->sharable || removeFromSharingList(pBt) ){
1432 /* The pBt is no longer on the sharing list, so we can access
1433 ** it without having to hold the mutex.
1434 **
1435 ** Clean out and delete the BtShared object.
1436 */
1437 assert( !pBt->pCursor );
drhe53831d2007-08-17 01:14:38 +00001438 sqlite3PagerClose(pBt->pPager);
1439 if( pBt->xFreeSchema && pBt->pSchema ){
1440 pBt->xFreeSchema(pBt->pSchema);
1441 }
1442 sqlite3_free(pBt->pSchema);
1443 sqlite3_free(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00001444 }
1445
drhe53831d2007-08-17 01:14:38 +00001446#ifndef SQLITE_OMIT_SHARED_CACHE
drhcab5ed72007-08-22 11:41:18 +00001447 assert( p->wantToLock==0 );
1448 assert( p->locked==0 );
1449 if( p->pPrev ) p->pPrev->pNext = p->pNext;
1450 if( p->pNext ) p->pNext->pPrev = p->pPrev;
danielk1977aef0bf62005-12-30 16:28:01 +00001451#endif
1452
drhe53831d2007-08-17 01:14:38 +00001453 sqlite3_free(p);
drha059ad02001-04-17 20:09:11 +00001454 return SQLITE_OK;
1455}
1456
1457/*
drhda47d772002-12-02 04:25:19 +00001458** Change the limit on the number of pages allowed in the cache.
drhcd61c282002-03-06 22:01:34 +00001459**
1460** The maximum number of cache pages is set to the absolute
1461** value of mxPage. If mxPage is negative, the pager will
1462** operate asynchronously - it will not stop to do fsync()s
1463** to insure data is written to the disk surface before
1464** continuing. Transactions still work if synchronous is off,
1465** and the database cannot be corrupted if this program
1466** crashes. But if the operating system crashes or there is
1467** an abrupt power failure when synchronous is off, the database
1468** could be left in an inconsistent and unrecoverable state.
1469** Synchronous is on by default so database corruption is not
1470** normally a worry.
drhf57b14a2001-09-14 18:54:08 +00001471*/
danielk1977aef0bf62005-12-30 16:28:01 +00001472int sqlite3BtreeSetCacheSize(Btree *p, int mxPage){
1473 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00001474 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00001475 sqlite3BtreeEnter(p);
danielk19773b8a05f2007-03-19 17:44:26 +00001476 sqlite3PagerSetCachesize(pBt->pPager, mxPage);
drhd677b3d2007-08-20 22:48:41 +00001477 sqlite3BtreeLeave(p);
drhf57b14a2001-09-14 18:54:08 +00001478 return SQLITE_OK;
1479}
1480
1481/*
drh973b6e32003-02-12 14:09:42 +00001482** Change the way data is synced to disk in order to increase or decrease
1483** how well the database resists damage due to OS crashes and power
1484** failures. Level 1 is the same as asynchronous (no syncs() occur and
1485** there is a high probability of damage) Level 2 is the default. There
1486** is a very low but non-zero probability of damage. Level 3 reduces the
1487** probability of damage to near zero but with a write performance reduction.
1488*/
danielk197793758c82005-01-21 08:13:14 +00001489#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drhac530b12006-02-11 01:25:50 +00001490int sqlite3BtreeSetSafetyLevel(Btree *p, int level, int fullSync){
danielk1977aef0bf62005-12-30 16:28:01 +00001491 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00001492 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00001493 sqlite3BtreeEnter(p);
danielk19773b8a05f2007-03-19 17:44:26 +00001494 sqlite3PagerSetSafetyLevel(pBt->pPager, level, fullSync);
drhd677b3d2007-08-20 22:48:41 +00001495 sqlite3BtreeLeave(p);
drh973b6e32003-02-12 14:09:42 +00001496 return SQLITE_OK;
1497}
danielk197793758c82005-01-21 08:13:14 +00001498#endif
drh973b6e32003-02-12 14:09:42 +00001499
drh2c8997b2005-08-27 16:36:48 +00001500/*
1501** Return TRUE if the given btree is set to safety level 1. In other
1502** words, return TRUE if no sync() occurs on the disk files.
1503*/
danielk1977aef0bf62005-12-30 16:28:01 +00001504int sqlite3BtreeSyncDisabled(Btree *p){
1505 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00001506 int rc;
drhe5fe6902007-12-07 18:55:28 +00001507 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00001508 sqlite3BtreeEnter(p);
drhd0679ed2007-08-28 22:24:34 +00001509 assert( pBt && pBt->pPager );
drhd677b3d2007-08-20 22:48:41 +00001510 rc = sqlite3PagerNosync(pBt->pPager);
1511 sqlite3BtreeLeave(p);
1512 return rc;
drh2c8997b2005-08-27 16:36:48 +00001513}
1514
danielk1977576ec6b2005-01-21 11:55:25 +00001515#if !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM)
drh973b6e32003-02-12 14:09:42 +00001516/*
drh90f5ecb2004-07-22 01:19:35 +00001517** Change the default pages size and the number of reserved bytes per page.
drh06f50212004-11-02 14:24:33 +00001518**
1519** The page size must be a power of 2 between 512 and 65536. If the page
1520** size supplied does not meet this constraint then the page size is not
1521** changed.
1522**
1523** Page sizes are constrained to be a power of two so that the region
1524** of the database file used for locking (beginning at PENDING_BYTE,
1525** the first byte past the 1GB boundary, 0x40000000) needs to occur
1526** at the beginning of a page.
danielk197728129562005-01-11 10:25:06 +00001527**
1528** If parameter nReserve is less than zero, then the number of reserved
1529** bytes per page is left unchanged.
drh90f5ecb2004-07-22 01:19:35 +00001530*/
danielk1977aef0bf62005-12-30 16:28:01 +00001531int sqlite3BtreeSetPageSize(Btree *p, int pageSize, int nReserve){
danielk1977a1644fd2007-08-29 12:31:25 +00001532 int rc = SQLITE_OK;
danielk1977aef0bf62005-12-30 16:28:01 +00001533 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00001534 sqlite3BtreeEnter(p);
drh90f5ecb2004-07-22 01:19:35 +00001535 if( pBt->pageSizeFixed ){
drhd677b3d2007-08-20 22:48:41 +00001536 sqlite3BtreeLeave(p);
drh90f5ecb2004-07-22 01:19:35 +00001537 return SQLITE_READONLY;
1538 }
1539 if( nReserve<0 ){
1540 nReserve = pBt->pageSize - pBt->usableSize;
1541 }
drh06f50212004-11-02 14:24:33 +00001542 if( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE &&
1543 ((pageSize-1)&pageSize)==0 ){
drh07d183d2005-05-01 22:52:42 +00001544 assert( (pageSize & 7)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00001545 assert( !pBt->pPage1 && !pBt->pCursor );
danielk1977a1644fd2007-08-29 12:31:25 +00001546 pBt->pageSize = pageSize;
1547 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00001548 }
1549 pBt->usableSize = pBt->pageSize - nReserve;
drhd677b3d2007-08-20 22:48:41 +00001550 sqlite3BtreeLeave(p);
danielk1977a1644fd2007-08-29 12:31:25 +00001551 return rc;
drh90f5ecb2004-07-22 01:19:35 +00001552}
1553
1554/*
1555** Return the currently defined page size
1556*/
danielk1977aef0bf62005-12-30 16:28:01 +00001557int sqlite3BtreeGetPageSize(Btree *p){
1558 return p->pBt->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00001559}
danielk1977aef0bf62005-12-30 16:28:01 +00001560int sqlite3BtreeGetReserve(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00001561 int n;
1562 sqlite3BtreeEnter(p);
1563 n = p->pBt->pageSize - p->pBt->usableSize;
1564 sqlite3BtreeLeave(p);
1565 return n;
drh2011d5f2004-07-22 02:40:37 +00001566}
drhf8e632b2007-05-08 14:51:36 +00001567
1568/*
1569** Set the maximum page count for a database if mxPage is positive.
1570** No changes are made if mxPage is 0 or negative.
1571** Regardless of the value of mxPage, return the maximum page count.
1572*/
1573int sqlite3BtreeMaxPageCount(Btree *p, int mxPage){
drhd677b3d2007-08-20 22:48:41 +00001574 int n;
1575 sqlite3BtreeEnter(p);
1576 n = sqlite3PagerMaxPageCount(p->pBt->pPager, mxPage);
1577 sqlite3BtreeLeave(p);
1578 return n;
drhf8e632b2007-05-08 14:51:36 +00001579}
danielk1977576ec6b2005-01-21 11:55:25 +00001580#endif /* !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM) */
drh90f5ecb2004-07-22 01:19:35 +00001581
1582/*
danielk1977951af802004-11-05 15:45:09 +00001583** Change the 'auto-vacuum' property of the database. If the 'autoVacuum'
1584** parameter is non-zero, then auto-vacuum mode is enabled. If zero, it
1585** is disabled. The default value for the auto-vacuum property is
1586** determined by the SQLITE_DEFAULT_AUTOVACUUM macro.
1587*/
danielk1977aef0bf62005-12-30 16:28:01 +00001588int sqlite3BtreeSetAutoVacuum(Btree *p, int autoVacuum){
danielk1977951af802004-11-05 15:45:09 +00001589#ifdef SQLITE_OMIT_AUTOVACUUM
drheee46cf2004-11-06 00:02:48 +00001590 return SQLITE_READONLY;
danielk1977951af802004-11-05 15:45:09 +00001591#else
danielk1977dddbcdc2007-04-26 14:42:34 +00001592 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00001593 int rc = SQLITE_OK;
danielk1977dddbcdc2007-04-26 14:42:34 +00001594 int av = (autoVacuum?1:0);
drhd677b3d2007-08-20 22:48:41 +00001595
1596 sqlite3BtreeEnter(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00001597 if( pBt->pageSizeFixed && av!=pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00001598 rc = SQLITE_READONLY;
1599 }else{
1600 pBt->autoVacuum = av;
danielk1977951af802004-11-05 15:45:09 +00001601 }
drhd677b3d2007-08-20 22:48:41 +00001602 sqlite3BtreeLeave(p);
1603 return rc;
danielk1977951af802004-11-05 15:45:09 +00001604#endif
1605}
1606
1607/*
1608** Return the value of the 'auto-vacuum' property. If auto-vacuum is
1609** enabled 1 is returned. Otherwise 0.
1610*/
danielk1977aef0bf62005-12-30 16:28:01 +00001611int sqlite3BtreeGetAutoVacuum(Btree *p){
danielk1977951af802004-11-05 15:45:09 +00001612#ifdef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00001613 return BTREE_AUTOVACUUM_NONE;
danielk1977951af802004-11-05 15:45:09 +00001614#else
drhd677b3d2007-08-20 22:48:41 +00001615 int rc;
1616 sqlite3BtreeEnter(p);
1617 rc = (
danielk1977dddbcdc2007-04-26 14:42:34 +00001618 (!p->pBt->autoVacuum)?BTREE_AUTOVACUUM_NONE:
1619 (!p->pBt->incrVacuum)?BTREE_AUTOVACUUM_FULL:
1620 BTREE_AUTOVACUUM_INCR
1621 );
drhd677b3d2007-08-20 22:48:41 +00001622 sqlite3BtreeLeave(p);
1623 return rc;
danielk1977951af802004-11-05 15:45:09 +00001624#endif
1625}
1626
1627
1628/*
drha34b6762004-05-07 13:30:42 +00001629** Get a reference to pPage1 of the database file. This will
drh306dc212001-05-21 13:45:10 +00001630** also acquire a readlock on that file.
1631**
1632** SQLITE_OK is returned on success. If the file is not a
1633** well-formed database file, then SQLITE_CORRUPT is returned.
1634** SQLITE_BUSY is returned if the database is locked. SQLITE_NOMEM
drh4f0ee682007-03-30 20:43:40 +00001635** is returned if we run out of memory.
drh306dc212001-05-21 13:45:10 +00001636*/
danielk1977aef0bf62005-12-30 16:28:01 +00001637static int lockBtree(BtShared *pBt){
danielk1977f653d782008-03-20 11:04:21 +00001638 int rc;
drh3aac2dd2004-04-26 14:10:20 +00001639 MemPage *pPage1;
drhd677b3d2007-08-20 22:48:41 +00001640
drh1fee73e2007-08-29 04:00:57 +00001641 assert( sqlite3_mutex_held(pBt->mutex) );
drha34b6762004-05-07 13:30:42 +00001642 if( pBt->pPage1 ) return SQLITE_OK;
drh16a9b832007-05-05 18:39:25 +00001643 rc = sqlite3BtreeGetPage(pBt, 1, &pPage1, 0);
drh306dc212001-05-21 13:45:10 +00001644 if( rc!=SQLITE_OK ) return rc;
drh306dc212001-05-21 13:45:10 +00001645
1646 /* Do some checking to help insure the file we opened really is
1647 ** a valid database file.
1648 */
drhb6f41482004-05-14 01:58:11 +00001649 rc = SQLITE_NOTADB;
danielk19773b8a05f2007-03-19 17:44:26 +00001650 if( sqlite3PagerPagecount(pBt->pPager)>0 ){
danielk1977f653d782008-03-20 11:04:21 +00001651 int pageSize;
1652 int usableSize;
drhb6f41482004-05-14 01:58:11 +00001653 u8 *page1 = pPage1->aData;
1654 if( memcmp(page1, zMagicHeader, 16)!=0 ){
drh72f82862001-05-24 21:06:34 +00001655 goto page1_init_failed;
drh306dc212001-05-21 13:45:10 +00001656 }
drh309169a2007-04-24 17:27:51 +00001657 if( page1[18]>1 ){
1658 pBt->readOnly = 1;
1659 }
1660 if( page1[19]>1 ){
drhb6f41482004-05-14 01:58:11 +00001661 goto page1_init_failed;
1662 }
drh07d183d2005-05-01 22:52:42 +00001663 pageSize = get2byte(&page1[16]);
drh7dc385e2007-09-06 23:39:36 +00001664 if( ((pageSize-1)&pageSize)!=0 || pageSize<512 ||
1665 (SQLITE_MAX_PAGE_SIZE<32768 && pageSize>SQLITE_MAX_PAGE_SIZE)
1666 ){
drh07d183d2005-05-01 22:52:42 +00001667 goto page1_init_failed;
1668 }
1669 assert( (pageSize & 7)==0 );
danielk1977f653d782008-03-20 11:04:21 +00001670 usableSize = pageSize - page1[20];
1671 if( pageSize!=pBt->pageSize ){
1672 /* After reading the first page of the database assuming a page size
1673 ** of BtShared.pageSize, we have discovered that the page-size is
1674 ** actually pageSize. Unlock the database, leave pBt->pPage1 at
1675 ** zero and return SQLITE_OK. The caller will call this function
1676 ** again with the correct page-size.
1677 */
1678 releasePage(pPage1);
1679 pBt->usableSize = usableSize;
1680 pBt->pageSize = pageSize;
1681 sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize);
1682 return SQLITE_OK;
1683 }
1684 if( usableSize<500 ){
drhb6f41482004-05-14 01:58:11 +00001685 goto page1_init_failed;
1686 }
danielk1977f653d782008-03-20 11:04:21 +00001687 pBt->pageSize = pageSize;
1688 pBt->usableSize = usableSize;
drhb6f41482004-05-14 01:58:11 +00001689 pBt->maxEmbedFrac = page1[21];
1690 pBt->minEmbedFrac = page1[22];
1691 pBt->minLeafFrac = page1[23];
drh057cd3a2005-02-15 16:23:02 +00001692#ifndef SQLITE_OMIT_AUTOVACUUM
1693 pBt->autoVacuum = (get4byte(&page1[36 + 4*4])?1:0);
danielk197727b1f952007-06-25 08:16:58 +00001694 pBt->incrVacuum = (get4byte(&page1[36 + 7*4])?1:0);
drh057cd3a2005-02-15 16:23:02 +00001695#endif
drh306dc212001-05-21 13:45:10 +00001696 }
drhb6f41482004-05-14 01:58:11 +00001697
1698 /* maxLocal is the maximum amount of payload to store locally for
1699 ** a cell. Make sure it is small enough so that at least minFanout
1700 ** cells can will fit on one page. We assume a 10-byte page header.
1701 ** Besides the payload, the cell must store:
drh43605152004-05-29 21:46:49 +00001702 ** 2-byte pointer to the cell
drhb6f41482004-05-14 01:58:11 +00001703 ** 4-byte child pointer
1704 ** 9-byte nKey value
1705 ** 4-byte nData value
1706 ** 4-byte overflow page pointer
drh43605152004-05-29 21:46:49 +00001707 ** So a cell consists of a 2-byte poiner, a header which is as much as
1708 ** 17 bytes long, 0 to N bytes of payload, and an optional 4 byte overflow
1709 ** page pointer.
drhb6f41482004-05-14 01:58:11 +00001710 */
drh43605152004-05-29 21:46:49 +00001711 pBt->maxLocal = (pBt->usableSize-12)*pBt->maxEmbedFrac/255 - 23;
1712 pBt->minLocal = (pBt->usableSize-12)*pBt->minEmbedFrac/255 - 23;
1713 pBt->maxLeaf = pBt->usableSize - 35;
1714 pBt->minLeaf = (pBt->usableSize-12)*pBt->minLeafFrac/255 - 23;
drhb6f41482004-05-14 01:58:11 +00001715 if( pBt->minLocal>pBt->maxLocal || pBt->maxLocal<0 ){
1716 goto page1_init_failed;
1717 }
drh2e38c322004-09-03 18:38:44 +00001718 assert( pBt->maxLeaf + 23 <= MX_CELL_SIZE(pBt) );
drh3aac2dd2004-04-26 14:10:20 +00001719 pBt->pPage1 = pPage1;
drhb6f41482004-05-14 01:58:11 +00001720 return SQLITE_OK;
drh306dc212001-05-21 13:45:10 +00001721
drh72f82862001-05-24 21:06:34 +00001722page1_init_failed:
drh3aac2dd2004-04-26 14:10:20 +00001723 releasePage(pPage1);
1724 pBt->pPage1 = 0;
drh72f82862001-05-24 21:06:34 +00001725 return rc;
drh306dc212001-05-21 13:45:10 +00001726}
1727
1728/*
drhb8ef32c2005-03-14 02:01:49 +00001729** This routine works like lockBtree() except that it also invokes the
1730** busy callback if there is lock contention.
1731*/
danielk1977aef0bf62005-12-30 16:28:01 +00001732static int lockBtreeWithRetry(Btree *pRef){
drhb8ef32c2005-03-14 02:01:49 +00001733 int rc = SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00001734
drh1fee73e2007-08-29 04:00:57 +00001735 assert( sqlite3BtreeHoldsMutex(pRef) );
danielk1977aef0bf62005-12-30 16:28:01 +00001736 if( pRef->inTrans==TRANS_NONE ){
1737 u8 inTransaction = pRef->pBt->inTransaction;
1738 btreeIntegrity(pRef);
1739 rc = sqlite3BtreeBeginTrans(pRef, 0);
1740 pRef->pBt->inTransaction = inTransaction;
1741 pRef->inTrans = TRANS_NONE;
1742 if( rc==SQLITE_OK ){
1743 pRef->pBt->nTransaction--;
1744 }
1745 btreeIntegrity(pRef);
drhb8ef32c2005-03-14 02:01:49 +00001746 }
1747 return rc;
1748}
1749
1750
1751/*
drhb8ca3072001-12-05 00:21:20 +00001752** If there are no outstanding cursors and we are not in the middle
1753** of a transaction but there is a read lock on the database, then
1754** this routine unrefs the first page of the database file which
1755** has the effect of releasing the read lock.
1756**
1757** If there are any outstanding cursors, this routine is a no-op.
1758**
1759** If there is a transaction in progress, this routine is a no-op.
1760*/
danielk1977aef0bf62005-12-30 16:28:01 +00001761static void unlockBtreeIfUnused(BtShared *pBt){
drh1fee73e2007-08-29 04:00:57 +00001762 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977aef0bf62005-12-30 16:28:01 +00001763 if( pBt->inTransaction==TRANS_NONE && pBt->pCursor==0 && pBt->pPage1!=0 ){
danielk19773b8a05f2007-03-19 17:44:26 +00001764 if( sqlite3PagerRefcount(pBt->pPager)>=1 ){
drhde4fcfd2008-01-19 23:50:26 +00001765 assert( pBt->pPage1->aData );
1766#if 0
drh24c9a2e2007-01-05 02:00:47 +00001767 if( pBt->pPage1->aData==0 ){
1768 MemPage *pPage = pBt->pPage1;
drhbf4bca52007-09-06 22:19:14 +00001769 pPage->aData = sqlite3PagerGetData(pPage->pDbPage);
drh24c9a2e2007-01-05 02:00:47 +00001770 pPage->pBt = pBt;
1771 pPage->pgno = 1;
1772 }
drhde4fcfd2008-01-19 23:50:26 +00001773#endif
drh24c9a2e2007-01-05 02:00:47 +00001774 releasePage(pBt->pPage1);
drh51c6d962004-06-06 00:42:25 +00001775 }
drh3aac2dd2004-04-26 14:10:20 +00001776 pBt->pPage1 = 0;
drh3aac2dd2004-04-26 14:10:20 +00001777 pBt->inStmt = 0;
drhb8ca3072001-12-05 00:21:20 +00001778 }
1779}
1780
1781/*
drh9e572e62004-04-23 23:43:10 +00001782** Create a new database by initializing the first page of the
drh8c42ca92001-06-22 19:15:00 +00001783** file.
drh8b2f49b2001-06-08 00:21:52 +00001784*/
danielk1977aef0bf62005-12-30 16:28:01 +00001785static int newDatabase(BtShared *pBt){
drh9e572e62004-04-23 23:43:10 +00001786 MemPage *pP1;
1787 unsigned char *data;
drh8c42ca92001-06-22 19:15:00 +00001788 int rc;
drhd677b3d2007-08-20 22:48:41 +00001789
drh1fee73e2007-08-29 04:00:57 +00001790 assert( sqlite3_mutex_held(pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00001791 if( sqlite3PagerPagecount(pBt->pPager)>0 ) return SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00001792 pP1 = pBt->pPage1;
drh9e572e62004-04-23 23:43:10 +00001793 assert( pP1!=0 );
1794 data = pP1->aData;
danielk19773b8a05f2007-03-19 17:44:26 +00001795 rc = sqlite3PagerWrite(pP1->pDbPage);
drh8b2f49b2001-06-08 00:21:52 +00001796 if( rc ) return rc;
drh9e572e62004-04-23 23:43:10 +00001797 memcpy(data, zMagicHeader, sizeof(zMagicHeader));
1798 assert( sizeof(zMagicHeader)==16 );
drhb6f41482004-05-14 01:58:11 +00001799 put2byte(&data[16], pBt->pageSize);
drh9e572e62004-04-23 23:43:10 +00001800 data[18] = 1;
1801 data[19] = 1;
drhb6f41482004-05-14 01:58:11 +00001802 data[20] = pBt->pageSize - pBt->usableSize;
1803 data[21] = pBt->maxEmbedFrac;
1804 data[22] = pBt->minEmbedFrac;
1805 data[23] = pBt->minLeafFrac;
1806 memset(&data[24], 0, 100-24);
drhe6c43812004-05-14 12:17:46 +00001807 zeroPage(pP1, PTF_INTKEY|PTF_LEAF|PTF_LEAFDATA );
drhf2a611c2004-09-05 00:33:43 +00001808 pBt->pageSizeFixed = 1;
danielk1977003ba062004-11-04 02:57:33 +00001809#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00001810 assert( pBt->autoVacuum==1 || pBt->autoVacuum==0 );
danielk1977418899a2007-06-24 10:14:00 +00001811 assert( pBt->incrVacuum==1 || pBt->incrVacuum==0 );
danielk1977dddbcdc2007-04-26 14:42:34 +00001812 put4byte(&data[36 + 4*4], pBt->autoVacuum);
danielk1977418899a2007-06-24 10:14:00 +00001813 put4byte(&data[36 + 7*4], pBt->incrVacuum);
danielk1977003ba062004-11-04 02:57:33 +00001814#endif
drh8b2f49b2001-06-08 00:21:52 +00001815 return SQLITE_OK;
1816}
1817
1818/*
danielk1977ee5741e2004-05-31 10:01:34 +00001819** Attempt to start a new transaction. A write-transaction
drh684917c2004-10-05 02:41:42 +00001820** is started if the second argument is nonzero, otherwise a read-
1821** transaction. If the second argument is 2 or more and exclusive
1822** transaction is started, meaning that no other process is allowed
1823** to access the database. A preexisting transaction may not be
drhb8ef32c2005-03-14 02:01:49 +00001824** upgraded to exclusive by calling this routine a second time - the
drh684917c2004-10-05 02:41:42 +00001825** exclusivity flag only works for a new transaction.
drh8b2f49b2001-06-08 00:21:52 +00001826**
danielk1977ee5741e2004-05-31 10:01:34 +00001827** A write-transaction must be started before attempting any
1828** changes to the database. None of the following routines
1829** will work unless a transaction is started first:
drh8b2f49b2001-06-08 00:21:52 +00001830**
drh23e11ca2004-05-04 17:27:28 +00001831** sqlite3BtreeCreateTable()
1832** sqlite3BtreeCreateIndex()
1833** sqlite3BtreeClearTable()
1834** sqlite3BtreeDropTable()
1835** sqlite3BtreeInsert()
1836** sqlite3BtreeDelete()
1837** sqlite3BtreeUpdateMeta()
danielk197713adf8a2004-06-03 16:08:41 +00001838**
drhb8ef32c2005-03-14 02:01:49 +00001839** If an initial attempt to acquire the lock fails because of lock contention
1840** and the database was previously unlocked, then invoke the busy handler
1841** if there is one. But if there was previously a read-lock, do not
1842** invoke the busy handler - just return SQLITE_BUSY. SQLITE_BUSY is
1843** returned when there is already a read-lock in order to avoid a deadlock.
1844**
1845** Suppose there are two processes A and B. A has a read lock and B has
1846** a reserved lock. B tries to promote to exclusive but is blocked because
1847** of A's read lock. A tries to promote to reserved but is blocked by B.
1848** One or the other of the two processes must give way or there can be
1849** no progress. By returning SQLITE_BUSY and not invoking the busy callback
1850** when A already has a read lock, we encourage A to give up and let B
1851** proceed.
drha059ad02001-04-17 20:09:11 +00001852*/
danielk1977aef0bf62005-12-30 16:28:01 +00001853int sqlite3BtreeBeginTrans(Btree *p, int wrflag){
1854 BtShared *pBt = p->pBt;
danielk1977ee5741e2004-05-31 10:01:34 +00001855 int rc = SQLITE_OK;
1856
drhd677b3d2007-08-20 22:48:41 +00001857 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00001858 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00001859 btreeIntegrity(p);
1860
danielk1977ee5741e2004-05-31 10:01:34 +00001861 /* If the btree is already in a write-transaction, or it
1862 ** is already in a read-transaction and a read-transaction
1863 ** is requested, this is a no-op.
1864 */
danielk1977aef0bf62005-12-30 16:28:01 +00001865 if( p->inTrans==TRANS_WRITE || (p->inTrans==TRANS_READ && !wrflag) ){
drhd677b3d2007-08-20 22:48:41 +00001866 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00001867 }
drhb8ef32c2005-03-14 02:01:49 +00001868
1869 /* Write transactions are not possible on a read-only database */
danielk1977ee5741e2004-05-31 10:01:34 +00001870 if( pBt->readOnly && wrflag ){
drhd677b3d2007-08-20 22:48:41 +00001871 rc = SQLITE_READONLY;
1872 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00001873 }
1874
danielk1977aef0bf62005-12-30 16:28:01 +00001875 /* If another database handle has already opened a write transaction
1876 ** on this shared-btree structure and a second write transaction is
1877 ** requested, return SQLITE_BUSY.
1878 */
1879 if( pBt->inTransaction==TRANS_WRITE && wrflag ){
drhd677b3d2007-08-20 22:48:41 +00001880 rc = SQLITE_BUSY;
1881 goto trans_begun;
danielk1977aef0bf62005-12-30 16:28:01 +00001882 }
1883
danielk1977641b0f42007-12-21 04:47:25 +00001884#ifndef SQLITE_OMIT_SHARED_CACHE
1885 if( wrflag>1 ){
1886 BtLock *pIter;
1887 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
1888 if( pIter->pBtree!=p ){
1889 rc = SQLITE_BUSY;
1890 goto trans_begun;
1891 }
1892 }
1893 }
1894#endif
1895
drhb8ef32c2005-03-14 02:01:49 +00001896 do {
danielk1977f653d782008-03-20 11:04:21 +00001897 while( rc==SQLITE_OK && pBt->pPage1==0 ){
drhb8ef32c2005-03-14 02:01:49 +00001898 rc = lockBtree(pBt);
drh8c42ca92001-06-22 19:15:00 +00001899 }
drh309169a2007-04-24 17:27:51 +00001900
drhb8ef32c2005-03-14 02:01:49 +00001901 if( rc==SQLITE_OK && wrflag ){
drh309169a2007-04-24 17:27:51 +00001902 if( pBt->readOnly ){
1903 rc = SQLITE_READONLY;
1904 }else{
1905 rc = sqlite3PagerBegin(pBt->pPage1->pDbPage, wrflag>1);
1906 if( rc==SQLITE_OK ){
1907 rc = newDatabase(pBt);
1908 }
drhb8ef32c2005-03-14 02:01:49 +00001909 }
1910 }
1911
1912 if( rc==SQLITE_OK ){
drhb8ef32c2005-03-14 02:01:49 +00001913 if( wrflag ) pBt->inStmt = 0;
1914 }else{
1915 unlockBtreeIfUnused(pBt);
1916 }
danielk1977aef0bf62005-12-30 16:28:01 +00001917 }while( rc==SQLITE_BUSY && pBt->inTransaction==TRANS_NONE &&
drhe5fe6902007-12-07 18:55:28 +00001918 sqlite3BtreeInvokeBusyHandler(pBt, 0) );
danielk1977aef0bf62005-12-30 16:28:01 +00001919
1920 if( rc==SQLITE_OK ){
1921 if( p->inTrans==TRANS_NONE ){
1922 pBt->nTransaction++;
1923 }
1924 p->inTrans = (wrflag?TRANS_WRITE:TRANS_READ);
1925 if( p->inTrans>pBt->inTransaction ){
1926 pBt->inTransaction = p->inTrans;
1927 }
danielk1977641b0f42007-12-21 04:47:25 +00001928#ifndef SQLITE_OMIT_SHARED_CACHE
1929 if( wrflag>1 ){
1930 assert( !pBt->pExclusive );
1931 pBt->pExclusive = p;
1932 }
1933#endif
danielk1977aef0bf62005-12-30 16:28:01 +00001934 }
1935
drhd677b3d2007-08-20 22:48:41 +00001936
1937trans_begun:
danielk1977aef0bf62005-12-30 16:28:01 +00001938 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00001939 sqlite3BtreeLeave(p);
drhb8ca3072001-12-05 00:21:20 +00001940 return rc;
drha059ad02001-04-17 20:09:11 +00001941}
1942
danielk1977687566d2004-11-02 12:56:41 +00001943#ifndef SQLITE_OMIT_AUTOVACUUM
1944
1945/*
1946** Set the pointer-map entries for all children of page pPage. Also, if
1947** pPage contains cells that point to overflow pages, set the pointer
1948** map entries for the overflow pages as well.
1949*/
1950static int setChildPtrmaps(MemPage *pPage){
1951 int i; /* Counter variable */
1952 int nCell; /* Number of cells in page pPage */
danielk19772df71c72007-05-24 07:22:42 +00001953 int rc; /* Return code */
danielk1977aef0bf62005-12-30 16:28:01 +00001954 BtShared *pBt = pPage->pBt;
danielk1977687566d2004-11-02 12:56:41 +00001955 int isInitOrig = pPage->isInit;
1956 Pgno pgno = pPage->pgno;
1957
drh1fee73e2007-08-29 04:00:57 +00001958 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19772df71c72007-05-24 07:22:42 +00001959 rc = sqlite3BtreeInitPage(pPage, pPage->pParent);
1960 if( rc!=SQLITE_OK ){
1961 goto set_child_ptrmaps_out;
1962 }
danielk1977687566d2004-11-02 12:56:41 +00001963 nCell = pPage->nCell;
1964
1965 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00001966 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00001967
danielk197726836652005-01-17 01:33:13 +00001968 rc = ptrmapPutOvflPtr(pPage, pCell);
1969 if( rc!=SQLITE_OK ){
1970 goto set_child_ptrmaps_out;
danielk1977687566d2004-11-02 12:56:41 +00001971 }
danielk197726836652005-01-17 01:33:13 +00001972
danielk1977687566d2004-11-02 12:56:41 +00001973 if( !pPage->leaf ){
1974 Pgno childPgno = get4byte(pCell);
1975 rc = ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno);
1976 if( rc!=SQLITE_OK ) goto set_child_ptrmaps_out;
1977 }
1978 }
1979
1980 if( !pPage->leaf ){
1981 Pgno childPgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
1982 rc = ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno);
1983 }
1984
1985set_child_ptrmaps_out:
1986 pPage->isInit = isInitOrig;
1987 return rc;
1988}
1989
1990/*
1991** Somewhere on pPage, which is guarenteed to be a btree page, not an overflow
1992** page, is a pointer to page iFrom. Modify this pointer so that it points to
1993** iTo. Parameter eType describes the type of pointer to be modified, as
1994** follows:
1995**
1996** PTRMAP_BTREE: pPage is a btree-page. The pointer points at a child
1997** page of pPage.
1998**
1999** PTRMAP_OVERFLOW1: pPage is a btree-page. The pointer points at an overflow
2000** page pointed to by one of the cells on pPage.
2001**
2002** PTRMAP_OVERFLOW2: pPage is an overflow-page. The pointer points at the next
2003** overflow page in the list.
2004*/
danielk1977fdb7cdb2005-01-17 02:12:18 +00002005static int modifyPagePointer(MemPage *pPage, Pgno iFrom, Pgno iTo, u8 eType){
drh1fee73e2007-08-29 04:00:57 +00002006 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk1977687566d2004-11-02 12:56:41 +00002007 if( eType==PTRMAP_OVERFLOW2 ){
danielk1977f78fc082004-11-02 14:40:32 +00002008 /* The pointer is always the first 4 bytes of the page in this case. */
danielk1977fdb7cdb2005-01-17 02:12:18 +00002009 if( get4byte(pPage->aData)!=iFrom ){
drh49285702005-09-17 15:20:26 +00002010 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +00002011 }
danielk1977f78fc082004-11-02 14:40:32 +00002012 put4byte(pPage->aData, iTo);
danielk1977687566d2004-11-02 12:56:41 +00002013 }else{
2014 int isInitOrig = pPage->isInit;
2015 int i;
2016 int nCell;
2017
drh16a9b832007-05-05 18:39:25 +00002018 sqlite3BtreeInitPage(pPage, 0);
danielk1977687566d2004-11-02 12:56:41 +00002019 nCell = pPage->nCell;
2020
danielk1977687566d2004-11-02 12:56:41 +00002021 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00002022 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00002023 if( eType==PTRMAP_OVERFLOW1 ){
2024 CellInfo info;
drh16a9b832007-05-05 18:39:25 +00002025 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
danielk1977687566d2004-11-02 12:56:41 +00002026 if( info.iOverflow ){
2027 if( iFrom==get4byte(&pCell[info.iOverflow]) ){
2028 put4byte(&pCell[info.iOverflow], iTo);
2029 break;
2030 }
2031 }
2032 }else{
2033 if( get4byte(pCell)==iFrom ){
2034 put4byte(pCell, iTo);
2035 break;
2036 }
2037 }
2038 }
2039
2040 if( i==nCell ){
danielk1977fdb7cdb2005-01-17 02:12:18 +00002041 if( eType!=PTRMAP_BTREE ||
2042 get4byte(&pPage->aData[pPage->hdrOffset+8])!=iFrom ){
drh49285702005-09-17 15:20:26 +00002043 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +00002044 }
danielk1977687566d2004-11-02 12:56:41 +00002045 put4byte(&pPage->aData[pPage->hdrOffset+8], iTo);
2046 }
2047
2048 pPage->isInit = isInitOrig;
2049 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00002050 return SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00002051}
2052
danielk1977003ba062004-11-04 02:57:33 +00002053
danielk19777701e812005-01-10 12:59:51 +00002054/*
2055** Move the open database page pDbPage to location iFreePage in the
2056** database. The pDbPage reference remains valid.
2057*/
danielk1977003ba062004-11-04 02:57:33 +00002058static int relocatePage(
danielk1977aef0bf62005-12-30 16:28:01 +00002059 BtShared *pBt, /* Btree */
danielk19777701e812005-01-10 12:59:51 +00002060 MemPage *pDbPage, /* Open page to move */
2061 u8 eType, /* Pointer map 'type' entry for pDbPage */
2062 Pgno iPtrPage, /* Pointer map 'page-no' entry for pDbPage */
2063 Pgno iFreePage /* The location to move pDbPage to */
danielk1977003ba062004-11-04 02:57:33 +00002064){
2065 MemPage *pPtrPage; /* The page that contains a pointer to pDbPage */
2066 Pgno iDbPage = pDbPage->pgno;
2067 Pager *pPager = pBt->pPager;
2068 int rc;
2069
danielk1977a0bf2652004-11-04 14:30:04 +00002070 assert( eType==PTRMAP_OVERFLOW2 || eType==PTRMAP_OVERFLOW1 ||
2071 eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE );
drh1fee73e2007-08-29 04:00:57 +00002072 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +00002073 assert( pDbPage->pBt==pBt );
danielk1977003ba062004-11-04 02:57:33 +00002074
drh85b623f2007-12-13 21:54:09 +00002075 /* Move page iDbPage from its current location to page number iFreePage */
danielk1977003ba062004-11-04 02:57:33 +00002076 TRACE(("AUTOVACUUM: Moving %d to free page %d (ptr page %d type %d)\n",
2077 iDbPage, iFreePage, iPtrPage, eType));
danielk19773b8a05f2007-03-19 17:44:26 +00002078 rc = sqlite3PagerMovepage(pPager, pDbPage->pDbPage, iFreePage);
danielk1977003ba062004-11-04 02:57:33 +00002079 if( rc!=SQLITE_OK ){
2080 return rc;
2081 }
2082 pDbPage->pgno = iFreePage;
2083
2084 /* If pDbPage was a btree-page, then it may have child pages and/or cells
2085 ** that point to overflow pages. The pointer map entries for all these
2086 ** pages need to be changed.
2087 **
2088 ** If pDbPage is an overflow page, then the first 4 bytes may store a
2089 ** pointer to a subsequent overflow page. If this is the case, then
2090 ** the pointer map needs to be updated for the subsequent overflow page.
2091 */
danielk1977a0bf2652004-11-04 14:30:04 +00002092 if( eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00002093 rc = setChildPtrmaps(pDbPage);
2094 if( rc!=SQLITE_OK ){
2095 return rc;
2096 }
2097 }else{
2098 Pgno nextOvfl = get4byte(pDbPage->aData);
2099 if( nextOvfl!=0 ){
danielk1977003ba062004-11-04 02:57:33 +00002100 rc = ptrmapPut(pBt, nextOvfl, PTRMAP_OVERFLOW2, iFreePage);
2101 if( rc!=SQLITE_OK ){
2102 return rc;
2103 }
2104 }
2105 }
2106
2107 /* Fix the database pointer on page iPtrPage that pointed at iDbPage so
2108 ** that it points at iFreePage. Also fix the pointer map entry for
2109 ** iPtrPage.
2110 */
danielk1977a0bf2652004-11-04 14:30:04 +00002111 if( eType!=PTRMAP_ROOTPAGE ){
drh16a9b832007-05-05 18:39:25 +00002112 rc = sqlite3BtreeGetPage(pBt, iPtrPage, &pPtrPage, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00002113 if( rc!=SQLITE_OK ){
2114 return rc;
2115 }
danielk19773b8a05f2007-03-19 17:44:26 +00002116 rc = sqlite3PagerWrite(pPtrPage->pDbPage);
danielk1977a0bf2652004-11-04 14:30:04 +00002117 if( rc!=SQLITE_OK ){
2118 releasePage(pPtrPage);
2119 return rc;
2120 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00002121 rc = modifyPagePointer(pPtrPage, iDbPage, iFreePage, eType);
danielk1977003ba062004-11-04 02:57:33 +00002122 releasePage(pPtrPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00002123 if( rc==SQLITE_OK ){
2124 rc = ptrmapPut(pBt, iFreePage, eType, iPtrPage);
2125 }
danielk1977003ba062004-11-04 02:57:33 +00002126 }
danielk1977003ba062004-11-04 02:57:33 +00002127 return rc;
2128}
2129
danielk1977dddbcdc2007-04-26 14:42:34 +00002130/* Forward declaration required by incrVacuumStep(). */
drh4f0c5872007-03-26 22:05:01 +00002131static int allocateBtreePage(BtShared *, MemPage **, Pgno *, Pgno, u8);
danielk1977687566d2004-11-02 12:56:41 +00002132
2133/*
danielk1977dddbcdc2007-04-26 14:42:34 +00002134** Perform a single step of an incremental-vacuum. If successful,
2135** return SQLITE_OK. If there is no work to do (and therefore no
2136** point in calling this function again), return SQLITE_DONE.
2137**
2138** More specificly, this function attempts to re-organize the
2139** database so that the last page of the file currently in use
2140** is no longer in use.
2141**
2142** If the nFin parameter is non-zero, the implementation assumes
2143** that the caller will keep calling incrVacuumStep() until
2144** it returns SQLITE_DONE or an error, and that nFin is the
2145** number of pages the database file will contain after this
2146** process is complete.
2147*/
2148static int incrVacuumStep(BtShared *pBt, Pgno nFin){
2149 Pgno iLastPg; /* Last page in the database */
2150 Pgno nFreeList; /* Number of pages still on the free-list */
2151
drh1fee73e2007-08-29 04:00:57 +00002152 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977dddbcdc2007-04-26 14:42:34 +00002153 iLastPg = pBt->nTrunc;
2154 if( iLastPg==0 ){
2155 iLastPg = sqlite3PagerPagecount(pBt->pPager);
2156 }
2157
2158 if( !PTRMAP_ISPAGE(pBt, iLastPg) && iLastPg!=PENDING_BYTE_PAGE(pBt) ){
2159 int rc;
2160 u8 eType;
2161 Pgno iPtrPage;
2162
2163 nFreeList = get4byte(&pBt->pPage1->aData[36]);
2164 if( nFreeList==0 || nFin==iLastPg ){
2165 return SQLITE_DONE;
2166 }
2167
2168 rc = ptrmapGet(pBt, iLastPg, &eType, &iPtrPage);
2169 if( rc!=SQLITE_OK ){
2170 return rc;
2171 }
2172 if( eType==PTRMAP_ROOTPAGE ){
2173 return SQLITE_CORRUPT_BKPT;
2174 }
2175
2176 if( eType==PTRMAP_FREEPAGE ){
2177 if( nFin==0 ){
2178 /* Remove the page from the files free-list. This is not required
danielk19774ef24492007-05-23 09:52:41 +00002179 ** if nFin is non-zero. In that case, the free-list will be
danielk1977dddbcdc2007-04-26 14:42:34 +00002180 ** truncated to zero after this function returns, so it doesn't
2181 ** matter if it still contains some garbage entries.
2182 */
2183 Pgno iFreePg;
2184 MemPage *pFreePg;
2185 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iLastPg, 1);
2186 if( rc!=SQLITE_OK ){
2187 return rc;
2188 }
2189 assert( iFreePg==iLastPg );
2190 releasePage(pFreePg);
2191 }
2192 } else {
2193 Pgno iFreePg; /* Index of free page to move pLastPg to */
2194 MemPage *pLastPg;
2195
drh16a9b832007-05-05 18:39:25 +00002196 rc = sqlite3BtreeGetPage(pBt, iLastPg, &pLastPg, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00002197 if( rc!=SQLITE_OK ){
2198 return rc;
2199 }
2200
danielk1977b4626a32007-04-28 15:47:43 +00002201 /* If nFin is zero, this loop runs exactly once and page pLastPg
2202 ** is swapped with the first free page pulled off the free list.
2203 **
2204 ** On the other hand, if nFin is greater than zero, then keep
2205 ** looping until a free-page located within the first nFin pages
2206 ** of the file is found.
2207 */
danielk1977dddbcdc2007-04-26 14:42:34 +00002208 do {
2209 MemPage *pFreePg;
2210 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, 0, 0);
2211 if( rc!=SQLITE_OK ){
2212 releasePage(pLastPg);
2213 return rc;
2214 }
2215 releasePage(pFreePg);
2216 }while( nFin!=0 && iFreePg>nFin );
2217 assert( iFreePg<iLastPg );
danielk1977b4626a32007-04-28 15:47:43 +00002218
2219 rc = sqlite3PagerWrite(pLastPg->pDbPage);
danielk1977662278e2007-11-05 15:30:12 +00002220 if( rc==SQLITE_OK ){
2221 rc = relocatePage(pBt, pLastPg, eType, iPtrPage, iFreePg);
2222 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002223 releasePage(pLastPg);
2224 if( rc!=SQLITE_OK ){
2225 return rc;
danielk1977662278e2007-11-05 15:30:12 +00002226 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002227 }
2228 }
2229
2230 pBt->nTrunc = iLastPg - 1;
2231 while( pBt->nTrunc==PENDING_BYTE_PAGE(pBt)||PTRMAP_ISPAGE(pBt, pBt->nTrunc) ){
2232 pBt->nTrunc--;
2233 }
2234 return SQLITE_OK;
2235}
2236
2237/*
2238** A write-transaction must be opened before calling this function.
2239** It performs a single unit of work towards an incremental vacuum.
2240**
2241** If the incremental vacuum is finished after this function has run,
2242** SQLITE_DONE is returned. If it is not finished, but no error occured,
2243** SQLITE_OK is returned. Otherwise an SQLite error code.
2244*/
2245int sqlite3BtreeIncrVacuum(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00002246 int rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00002247 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002248
2249 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002250 pBt->db = p->db;
danielk1977dddbcdc2007-04-26 14:42:34 +00002251 assert( pBt->inTransaction==TRANS_WRITE && p->inTrans==TRANS_WRITE );
2252 if( !pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00002253 rc = SQLITE_DONE;
2254 }else{
2255 invalidateAllOverflowCache(pBt);
2256 rc = incrVacuumStep(pBt, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00002257 }
drhd677b3d2007-08-20 22:48:41 +00002258 sqlite3BtreeLeave(p);
2259 return rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00002260}
2261
2262/*
danielk19773b8a05f2007-03-19 17:44:26 +00002263** This routine is called prior to sqlite3PagerCommit when a transaction
danielk1977687566d2004-11-02 12:56:41 +00002264** is commited for an auto-vacuum database.
danielk197724168722007-04-02 05:07:47 +00002265**
2266** If SQLITE_OK is returned, then *pnTrunc is set to the number of pages
2267** the database file should be truncated to during the commit process.
2268** i.e. the database has been reorganized so that only the first *pnTrunc
2269** pages are in use.
danielk1977687566d2004-11-02 12:56:41 +00002270*/
danielk197724168722007-04-02 05:07:47 +00002271static int autoVacuumCommit(BtShared *pBt, Pgno *pnTrunc){
danielk1977dddbcdc2007-04-26 14:42:34 +00002272 int rc = SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00002273 Pager *pPager = pBt->pPager;
danielk1977687566d2004-11-02 12:56:41 +00002274#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00002275 int nRef = sqlite3PagerRefcount(pPager);
danielk1977687566d2004-11-02 12:56:41 +00002276#endif
2277
drh1fee73e2007-08-29 04:00:57 +00002278 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +00002279 invalidateAllOverflowCache(pBt);
danielk1977dddbcdc2007-04-26 14:42:34 +00002280 assert(pBt->autoVacuum);
2281 if( !pBt->incrVacuum ){
2282 Pgno nFin = 0;
danielk1977687566d2004-11-02 12:56:41 +00002283
danielk1977dddbcdc2007-04-26 14:42:34 +00002284 if( pBt->nTrunc==0 ){
2285 Pgno nFree;
2286 Pgno nPtrmap;
2287 const int pgsz = pBt->pageSize;
2288 Pgno nOrig = sqlite3PagerPagecount(pBt->pPager);
danielk1977e5321f02007-04-27 07:05:44 +00002289
2290 if( PTRMAP_ISPAGE(pBt, nOrig) ){
2291 return SQLITE_CORRUPT_BKPT;
2292 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002293 if( nOrig==PENDING_BYTE_PAGE(pBt) ){
2294 nOrig--;
danielk1977687566d2004-11-02 12:56:41 +00002295 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002296 nFree = get4byte(&pBt->pPage1->aData[36]);
2297 nPtrmap = (nFree-nOrig+PTRMAP_PAGENO(pBt, nOrig)+pgsz/5)/(pgsz/5);
2298 nFin = nOrig - nFree - nPtrmap;
2299 if( nOrig>PENDING_BYTE_PAGE(pBt) && nFin<=PENDING_BYTE_PAGE(pBt) ){
2300 nFin--;
danielk1977ac11ee62005-01-15 12:45:51 +00002301 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002302 while( PTRMAP_ISPAGE(pBt, nFin) || nFin==PENDING_BYTE_PAGE(pBt) ){
2303 nFin--;
2304 }
2305 }
danielk1977687566d2004-11-02 12:56:41 +00002306
danielk1977dddbcdc2007-04-26 14:42:34 +00002307 while( rc==SQLITE_OK ){
2308 rc = incrVacuumStep(pBt, nFin);
2309 }
2310 if( rc==SQLITE_DONE ){
2311 assert(nFin==0 || pBt->nTrunc==0 || nFin<=pBt->nTrunc);
2312 rc = SQLITE_OK;
2313 if( pBt->nTrunc ){
drh67f80b62007-07-23 19:26:17 +00002314 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
danielk1977dddbcdc2007-04-26 14:42:34 +00002315 put4byte(&pBt->pPage1->aData[32], 0);
2316 put4byte(&pBt->pPage1->aData[36], 0);
2317 pBt->nTrunc = nFin;
2318 }
2319 }
2320 if( rc!=SQLITE_OK ){
2321 sqlite3PagerRollback(pPager);
2322 }
danielk1977687566d2004-11-02 12:56:41 +00002323 }
2324
danielk1977dddbcdc2007-04-26 14:42:34 +00002325 if( rc==SQLITE_OK ){
2326 *pnTrunc = pBt->nTrunc;
2327 pBt->nTrunc = 0;
2328 }
danielk19773b8a05f2007-03-19 17:44:26 +00002329 assert( nRef==sqlite3PagerRefcount(pPager) );
danielk1977687566d2004-11-02 12:56:41 +00002330 return rc;
2331}
danielk1977dddbcdc2007-04-26 14:42:34 +00002332
danielk1977687566d2004-11-02 12:56:41 +00002333#endif
2334
2335/*
drh80e35f42007-03-30 14:06:34 +00002336** This routine does the first phase of a two-phase commit. This routine
2337** causes a rollback journal to be created (if it does not already exist)
2338** and populated with enough information so that if a power loss occurs
2339** the database can be restored to its original state by playing back
2340** the journal. Then the contents of the journal are flushed out to
2341** the disk. After the journal is safely on oxide, the changes to the
2342** database are written into the database file and flushed to oxide.
2343** At the end of this call, the rollback journal still exists on the
2344** disk and we are still holding all locks, so the transaction has not
2345** committed. See sqlite3BtreeCommit() for the second phase of the
2346** commit process.
2347**
2348** This call is a no-op if no write-transaction is currently active on pBt.
2349**
2350** Otherwise, sync the database file for the btree pBt. zMaster points to
2351** the name of a master journal file that should be written into the
2352** individual journal file, or is NULL, indicating no master journal file
2353** (single database transaction).
2354**
2355** When this is called, the master journal should already have been
2356** created, populated with this journal pointer and synced to disk.
2357**
2358** Once this is routine has returned, the only thing required to commit
2359** the write-transaction for this database file is to delete the journal.
2360*/
2361int sqlite3BtreeCommitPhaseOne(Btree *p, const char *zMaster){
2362 int rc = SQLITE_OK;
2363 if( p->inTrans==TRANS_WRITE ){
2364 BtShared *pBt = p->pBt;
2365 Pgno nTrunc = 0;
drhd677b3d2007-08-20 22:48:41 +00002366 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002367 pBt->db = p->db;
drh80e35f42007-03-30 14:06:34 +00002368#ifndef SQLITE_OMIT_AUTOVACUUM
2369 if( pBt->autoVacuum ){
2370 rc = autoVacuumCommit(pBt, &nTrunc);
2371 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00002372 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00002373 return rc;
2374 }
2375 }
2376#endif
danielk1977f653d782008-03-20 11:04:21 +00002377 rc = sqlite3PagerCommitPhaseOne(pBt->pPager, zMaster, nTrunc, 0);
drhd677b3d2007-08-20 22:48:41 +00002378 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00002379 }
2380 return rc;
2381}
2382
2383/*
drh2aa679f2001-06-25 02:11:07 +00002384** Commit the transaction currently in progress.
drh5e00f6c2001-09-13 13:46:56 +00002385**
drh6e345992007-03-30 11:12:08 +00002386** This routine implements the second phase of a 2-phase commit. The
2387** sqlite3BtreeSync() routine does the first phase and should be invoked
2388** prior to calling this routine. The sqlite3BtreeSync() routine did
2389** all the work of writing information out to disk and flushing the
2390** contents so that they are written onto the disk platter. All this
2391** routine has to do is delete or truncate the rollback journal
2392** (which causes the transaction to commit) and drop locks.
2393**
drh5e00f6c2001-09-13 13:46:56 +00002394** This will release the write lock on the database file. If there
2395** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00002396*/
drh80e35f42007-03-30 14:06:34 +00002397int sqlite3BtreeCommitPhaseTwo(Btree *p){
danielk1977aef0bf62005-12-30 16:28:01 +00002398 BtShared *pBt = p->pBt;
2399
drhd677b3d2007-08-20 22:48:41 +00002400 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002401 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00002402 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002403
2404 /* If the handle has a write-transaction open, commit the shared-btrees
2405 ** transaction and set the shared state to TRANS_READ.
2406 */
2407 if( p->inTrans==TRANS_WRITE ){
danielk19777f7bc662006-01-23 13:47:47 +00002408 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002409 assert( pBt->inTransaction==TRANS_WRITE );
2410 assert( pBt->nTransaction>0 );
drh80e35f42007-03-30 14:06:34 +00002411 rc = sqlite3PagerCommitPhaseTwo(pBt->pPager);
danielk19777f7bc662006-01-23 13:47:47 +00002412 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00002413 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00002414 return rc;
2415 }
danielk1977aef0bf62005-12-30 16:28:01 +00002416 pBt->inTransaction = TRANS_READ;
2417 pBt->inStmt = 0;
danielk1977ee5741e2004-05-31 10:01:34 +00002418 }
danielk19777f7bc662006-01-23 13:47:47 +00002419 unlockAllTables(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002420
2421 /* If the handle has any kind of transaction open, decrement the transaction
2422 ** count of the shared btree. If the transaction count reaches 0, set
2423 ** the shared state to TRANS_NONE. The unlockBtreeIfUnused() call below
2424 ** will unlock the pager.
2425 */
2426 if( p->inTrans!=TRANS_NONE ){
2427 pBt->nTransaction--;
2428 if( 0==pBt->nTransaction ){
2429 pBt->inTransaction = TRANS_NONE;
2430 }
2431 }
2432
2433 /* Set the handles current transaction state to TRANS_NONE and unlock
2434 ** the pager if this call closed the only read or write transaction.
2435 */
2436 p->inTrans = TRANS_NONE;
drh5e00f6c2001-09-13 13:46:56 +00002437 unlockBtreeIfUnused(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00002438
2439 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00002440 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00002441 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00002442}
2443
drh80e35f42007-03-30 14:06:34 +00002444/*
2445** Do both phases of a commit.
2446*/
2447int sqlite3BtreeCommit(Btree *p){
2448 int rc;
drhd677b3d2007-08-20 22:48:41 +00002449 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00002450 rc = sqlite3BtreeCommitPhaseOne(p, 0);
2451 if( rc==SQLITE_OK ){
2452 rc = sqlite3BtreeCommitPhaseTwo(p);
2453 }
drhd677b3d2007-08-20 22:48:41 +00002454 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00002455 return rc;
2456}
2457
danielk1977fbcd5852004-06-15 02:44:18 +00002458#ifndef NDEBUG
2459/*
2460** Return the number of write-cursors open on this handle. This is for use
2461** in assert() expressions, so it is only compiled if NDEBUG is not
2462** defined.
drhfb982642007-08-30 01:19:59 +00002463**
2464** For the purposes of this routine, a write-cursor is any cursor that
2465** is capable of writing to the databse. That means the cursor was
2466** originally opened for writing and the cursor has not be disabled
2467** by having its state changed to CURSOR_FAULT.
danielk1977fbcd5852004-06-15 02:44:18 +00002468*/
danielk1977aef0bf62005-12-30 16:28:01 +00002469static int countWriteCursors(BtShared *pBt){
danielk1977fbcd5852004-06-15 02:44:18 +00002470 BtCursor *pCur;
2471 int r = 0;
2472 for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
drhfb982642007-08-30 01:19:59 +00002473 if( pCur->wrFlag && pCur->eState!=CURSOR_FAULT ) r++;
danielk1977fbcd5852004-06-15 02:44:18 +00002474 }
2475 return r;
2476}
2477#endif
2478
drhc39e0002004-05-07 23:50:57 +00002479/*
drhfb982642007-08-30 01:19:59 +00002480** This routine sets the state to CURSOR_FAULT and the error
2481** code to errCode for every cursor on BtShared that pBtree
2482** references.
2483**
2484** Every cursor is tripped, including cursors that belong
2485** to other database connections that happen to be sharing
2486** the cache with pBtree.
2487**
2488** This routine gets called when a rollback occurs.
2489** All cursors using the same cache must be tripped
2490** to prevent them from trying to use the btree after
2491** the rollback. The rollback may have deleted tables
2492** or moved root pages, so it is not sufficient to
2493** save the state of the cursor. The cursor must be
2494** invalidated.
2495*/
2496void sqlite3BtreeTripAllCursors(Btree *pBtree, int errCode){
2497 BtCursor *p;
2498 sqlite3BtreeEnter(pBtree);
2499 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
2500 clearCursorPosition(p);
2501 p->eState = CURSOR_FAULT;
2502 p->skip = errCode;
2503 }
2504 sqlite3BtreeLeave(pBtree);
2505}
2506
2507/*
drhecdc7532001-09-23 02:35:53 +00002508** Rollback the transaction in progress. All cursors will be
2509** invalided by this operation. Any attempt to use a cursor
2510** that was open at the beginning of this operation will result
2511** in an error.
drh5e00f6c2001-09-13 13:46:56 +00002512**
2513** This will release the write lock on the database file. If there
2514** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00002515*/
danielk1977aef0bf62005-12-30 16:28:01 +00002516int sqlite3BtreeRollback(Btree *p){
danielk19778d34dfd2006-01-24 16:37:57 +00002517 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002518 BtShared *pBt = p->pBt;
drh24cd67e2004-05-10 16:18:47 +00002519 MemPage *pPage1;
danielk1977aef0bf62005-12-30 16:28:01 +00002520
drhd677b3d2007-08-20 22:48:41 +00002521 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002522 pBt->db = p->db;
danielk19772b8c13e2006-01-24 14:21:24 +00002523 rc = saveAllCursors(pBt, 0, 0);
danielk19778d34dfd2006-01-24 16:37:57 +00002524#ifndef SQLITE_OMIT_SHARED_CACHE
danielk19772b8c13e2006-01-24 14:21:24 +00002525 if( rc!=SQLITE_OK ){
danielk19778d34dfd2006-01-24 16:37:57 +00002526 /* This is a horrible situation. An IO or malloc() error occured whilst
2527 ** trying to save cursor positions. If this is an automatic rollback (as
2528 ** the result of a constraint, malloc() failure or IO error) then
2529 ** the cache may be internally inconsistent (not contain valid trees) so
2530 ** we cannot simply return the error to the caller. Instead, abort
2531 ** all queries that may be using any of the cursors that failed to save.
2532 */
drhfb982642007-08-30 01:19:59 +00002533 sqlite3BtreeTripAllCursors(p, rc);
danielk19772b8c13e2006-01-24 14:21:24 +00002534 }
danielk19778d34dfd2006-01-24 16:37:57 +00002535#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002536 btreeIntegrity(p);
2537 unlockAllTables(p);
2538
2539 if( p->inTrans==TRANS_WRITE ){
danielk19778d34dfd2006-01-24 16:37:57 +00002540 int rc2;
danielk1977aef0bf62005-12-30 16:28:01 +00002541
danielk1977dddbcdc2007-04-26 14:42:34 +00002542#ifndef SQLITE_OMIT_AUTOVACUUM
2543 pBt->nTrunc = 0;
2544#endif
2545
danielk19778d34dfd2006-01-24 16:37:57 +00002546 assert( TRANS_WRITE==pBt->inTransaction );
danielk19773b8a05f2007-03-19 17:44:26 +00002547 rc2 = sqlite3PagerRollback(pBt->pPager);
danielk19778d34dfd2006-01-24 16:37:57 +00002548 if( rc2!=SQLITE_OK ){
2549 rc = rc2;
2550 }
2551
drh24cd67e2004-05-10 16:18:47 +00002552 /* The rollback may have destroyed the pPage1->aData value. So
drh16a9b832007-05-05 18:39:25 +00002553 ** call sqlite3BtreeGetPage() on page 1 again to make
2554 ** sure pPage1->aData is set correctly. */
2555 if( sqlite3BtreeGetPage(pBt, 1, &pPage1, 0)==SQLITE_OK ){
drh24cd67e2004-05-10 16:18:47 +00002556 releasePage(pPage1);
2557 }
danielk1977fbcd5852004-06-15 02:44:18 +00002558 assert( countWriteCursors(pBt)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00002559 pBt->inTransaction = TRANS_READ;
drh24cd67e2004-05-10 16:18:47 +00002560 }
danielk1977aef0bf62005-12-30 16:28:01 +00002561
2562 if( p->inTrans!=TRANS_NONE ){
2563 assert( pBt->nTransaction>0 );
2564 pBt->nTransaction--;
2565 if( 0==pBt->nTransaction ){
2566 pBt->inTransaction = TRANS_NONE;
2567 }
2568 }
2569
2570 p->inTrans = TRANS_NONE;
danielk1977ee5741e2004-05-31 10:01:34 +00002571 pBt->inStmt = 0;
drh5e00f6c2001-09-13 13:46:56 +00002572 unlockBtreeIfUnused(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00002573
2574 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00002575 sqlite3BtreeLeave(p);
drha059ad02001-04-17 20:09:11 +00002576 return rc;
2577}
2578
2579/*
drhab01f612004-05-22 02:55:23 +00002580** Start a statement subtransaction. The subtransaction can
2581** can be rolled back independently of the main transaction.
2582** You must start a transaction before starting a subtransaction.
2583** The subtransaction is ended automatically if the main transaction
drh663fc632002-02-02 18:49:19 +00002584** commits or rolls back.
2585**
drhab01f612004-05-22 02:55:23 +00002586** Only one subtransaction may be active at a time. It is an error to try
2587** to start a new subtransaction if another subtransaction is already active.
2588**
2589** Statement subtransactions are used around individual SQL statements
2590** that are contained within a BEGIN...COMMIT block. If a constraint
2591** error occurs within the statement, the effect of that one statement
2592** can be rolled back without having to rollback the entire transaction.
drh663fc632002-02-02 18:49:19 +00002593*/
danielk1977aef0bf62005-12-30 16:28:01 +00002594int sqlite3BtreeBeginStmt(Btree *p){
drh663fc632002-02-02 18:49:19 +00002595 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002596 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002597 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002598 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00002599 if( (p->inTrans!=TRANS_WRITE) || pBt->inStmt ){
drhd677b3d2007-08-20 22:48:41 +00002600 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
2601 }else{
2602 assert( pBt->inTransaction==TRANS_WRITE );
2603 rc = pBt->readOnly ? SQLITE_OK : sqlite3PagerStmtBegin(pBt->pPager);
2604 pBt->inStmt = 1;
drh0d65dc02002-02-03 00:56:09 +00002605 }
drhd677b3d2007-08-20 22:48:41 +00002606 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00002607 return rc;
2608}
2609
2610
2611/*
drhab01f612004-05-22 02:55:23 +00002612** Commit the statment subtransaction currently in progress. If no
2613** subtransaction is active, this is a no-op.
drh663fc632002-02-02 18:49:19 +00002614*/
danielk1977aef0bf62005-12-30 16:28:01 +00002615int sqlite3BtreeCommitStmt(Btree *p){
drh663fc632002-02-02 18:49:19 +00002616 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002617 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002618 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002619 pBt->db = p->db;
drh3aac2dd2004-04-26 14:10:20 +00002620 if( pBt->inStmt && !pBt->readOnly ){
danielk19773b8a05f2007-03-19 17:44:26 +00002621 rc = sqlite3PagerStmtCommit(pBt->pPager);
drh663fc632002-02-02 18:49:19 +00002622 }else{
2623 rc = SQLITE_OK;
2624 }
drh3aac2dd2004-04-26 14:10:20 +00002625 pBt->inStmt = 0;
drhd677b3d2007-08-20 22:48:41 +00002626 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00002627 return rc;
2628}
2629
2630/*
drhab01f612004-05-22 02:55:23 +00002631** Rollback the active statement subtransaction. If no subtransaction
2632** is active this routine is a no-op.
drh663fc632002-02-02 18:49:19 +00002633**
drhab01f612004-05-22 02:55:23 +00002634** All cursors will be invalidated by this operation. Any attempt
drh663fc632002-02-02 18:49:19 +00002635** to use a cursor that was open at the beginning of this operation
2636** will result in an error.
2637*/
danielk1977aef0bf62005-12-30 16:28:01 +00002638int sqlite3BtreeRollbackStmt(Btree *p){
danielk197797a227c2006-01-20 16:32:04 +00002639 int rc = SQLITE_OK;
danielk1977aef0bf62005-12-30 16:28:01 +00002640 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002641 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002642 pBt->db = p->db;
danielk197797a227c2006-01-20 16:32:04 +00002643 if( pBt->inStmt && !pBt->readOnly ){
danielk19773b8a05f2007-03-19 17:44:26 +00002644 rc = sqlite3PagerStmtRollback(pBt->pPager);
danielk197797a227c2006-01-20 16:32:04 +00002645 assert( countWriteCursors(pBt)==0 );
2646 pBt->inStmt = 0;
2647 }
drhd677b3d2007-08-20 22:48:41 +00002648 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00002649 return rc;
2650}
2651
2652/*
drh8b2f49b2001-06-08 00:21:52 +00002653** Create a new cursor for the BTree whose root is on the page
2654** iTable. The act of acquiring a cursor gets a read lock on
2655** the database file.
drh1bee3d72001-10-15 00:44:35 +00002656**
2657** If wrFlag==0, then the cursor can only be used for reading.
drhf74b8d92002-09-01 23:20:45 +00002658** If wrFlag==1, then the cursor can be used for reading or for
2659** writing if other conditions for writing are also met. These
2660** are the conditions that must be met in order for writing to
2661** be allowed:
drh6446c4d2001-12-15 14:22:18 +00002662**
drhf74b8d92002-09-01 23:20:45 +00002663** 1: The cursor must have been opened with wrFlag==1
2664**
drhfe5d71d2007-03-19 11:54:10 +00002665** 2: Other database connections that share the same pager cache
2666** but which are not in the READ_UNCOMMITTED state may not have
2667** cursors open with wrFlag==0 on the same table. Otherwise
2668** the changes made by this write cursor would be visible to
2669** the read cursors in the other database connection.
drhf74b8d92002-09-01 23:20:45 +00002670**
2671** 3: The database must be writable (not on read-only media)
2672**
2673** 4: There must be an active transaction.
2674**
drh6446c4d2001-12-15 14:22:18 +00002675** No checking is done to make sure that page iTable really is the
2676** root page of a b-tree. If it is not, then the cursor acquired
2677** will not work correctly.
drha059ad02001-04-17 20:09:11 +00002678*/
drhd677b3d2007-08-20 22:48:41 +00002679static int btreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00002680 Btree *p, /* The btree */
2681 int iTable, /* Root page of table to open */
2682 int wrFlag, /* 1 to write. 0 read-only */
2683 struct KeyInfo *pKeyInfo, /* First arg to comparison function */
2684 BtCursor *pCur /* Space for new cursor */
drh3aac2dd2004-04-26 14:10:20 +00002685){
drha059ad02001-04-17 20:09:11 +00002686 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00002687 BtShared *pBt = p->pBt;
drhecdc7532001-09-23 02:35:53 +00002688
drh1fee73e2007-08-29 04:00:57 +00002689 assert( sqlite3BtreeHoldsMutex(p) );
drh8dcd7ca2004-08-08 19:43:29 +00002690 if( wrFlag ){
drh8dcd7ca2004-08-08 19:43:29 +00002691 if( pBt->readOnly ){
2692 return SQLITE_READONLY;
2693 }
drh980b1a72006-08-16 16:42:48 +00002694 if( checkReadLocks(p, iTable, 0) ){
drh8dcd7ca2004-08-08 19:43:29 +00002695 return SQLITE_LOCKED;
2696 }
drha0c9a112004-03-10 13:42:37 +00002697 }
danielk1977aef0bf62005-12-30 16:28:01 +00002698
drh4b70f112004-05-02 21:12:19 +00002699 if( pBt->pPage1==0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002700 rc = lockBtreeWithRetry(p);
drha059ad02001-04-17 20:09:11 +00002701 if( rc!=SQLITE_OK ){
drha059ad02001-04-17 20:09:11 +00002702 return rc;
2703 }
drh1831f182007-04-24 17:35:59 +00002704 if( pBt->readOnly && wrFlag ){
2705 return SQLITE_READONLY;
2706 }
drha059ad02001-04-17 20:09:11 +00002707 }
drh8b2f49b2001-06-08 00:21:52 +00002708 pCur->pgnoRoot = (Pgno)iTable;
danielk19773b8a05f2007-03-19 17:44:26 +00002709 if( iTable==1 && sqlite3PagerPagecount(pBt->pPager)==0 ){
drh24cd67e2004-05-10 16:18:47 +00002710 rc = SQLITE_EMPTY;
2711 goto create_cursor_exception;
2712 }
drhde647132004-05-07 17:57:49 +00002713 rc = getAndInitPage(pBt, pCur->pgnoRoot, &pCur->pPage, 0);
drhbd03cae2001-06-02 02:40:57 +00002714 if( rc!=SQLITE_OK ){
2715 goto create_cursor_exception;
drha059ad02001-04-17 20:09:11 +00002716 }
danielk1977aef0bf62005-12-30 16:28:01 +00002717
danielk1977aef0bf62005-12-30 16:28:01 +00002718 /* Now that no other errors can occur, finish filling in the BtCursor
2719 ** variables, link the cursor into the BtShared list and set *ppCur (the
2720 ** output argument to this function).
2721 */
drh1e968a02008-03-25 00:22:21 +00002722 pCur->pKeyInfo = pKeyInfo;
danielk1977aef0bf62005-12-30 16:28:01 +00002723 pCur->pBtree = p;
drhd0679ed2007-08-28 22:24:34 +00002724 pCur->pBt = pBt;
drhecdc7532001-09-23 02:35:53 +00002725 pCur->wrFlag = wrFlag;
drha059ad02001-04-17 20:09:11 +00002726 pCur->pNext = pBt->pCursor;
2727 if( pCur->pNext ){
2728 pCur->pNext->pPrev = pCur;
2729 }
2730 pBt->pCursor = pCur;
danielk1977da184232006-01-05 11:34:32 +00002731 pCur->eState = CURSOR_INVALID;
drhbd03cae2001-06-02 02:40:57 +00002732
danielk1977aef0bf62005-12-30 16:28:01 +00002733 return SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00002734
drhbd03cae2001-06-02 02:40:57 +00002735create_cursor_exception:
drhbd03cae2001-06-02 02:40:57 +00002736 if( pCur ){
drh3aac2dd2004-04-26 14:10:20 +00002737 releasePage(pCur->pPage);
drhbd03cae2001-06-02 02:40:57 +00002738 }
drh5e00f6c2001-09-13 13:46:56 +00002739 unlockBtreeIfUnused(pBt);
drhbd03cae2001-06-02 02:40:57 +00002740 return rc;
drha059ad02001-04-17 20:09:11 +00002741}
drhd677b3d2007-08-20 22:48:41 +00002742int sqlite3BtreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00002743 Btree *p, /* The btree */
2744 int iTable, /* Root page of table to open */
2745 int wrFlag, /* 1 to write. 0 read-only */
2746 struct KeyInfo *pKeyInfo, /* First arg to xCompare() */
2747 BtCursor *pCur /* Write new cursor here */
drhd677b3d2007-08-20 22:48:41 +00002748){
2749 int rc;
2750 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00002751 p->pBt->db = p->db;
danielk1977cd3e8f72008-03-25 09:47:35 +00002752 rc = btreeCursor(p, iTable, wrFlag, pKeyInfo, pCur);
drhd677b3d2007-08-20 22:48:41 +00002753 sqlite3BtreeLeave(p);
2754 return rc;
2755}
danielk1977cd3e8f72008-03-25 09:47:35 +00002756int sqlite3BtreeCursorSize(){
2757 return sizeof(BtCursor);
2758}
2759
drhd677b3d2007-08-20 22:48:41 +00002760
drha059ad02001-04-17 20:09:11 +00002761
2762/*
drh5e00f6c2001-09-13 13:46:56 +00002763** Close a cursor. The read lock on the database file is released
drhbd03cae2001-06-02 02:40:57 +00002764** when the last cursor is closed.
drha059ad02001-04-17 20:09:11 +00002765*/
drh3aac2dd2004-04-26 14:10:20 +00002766int sqlite3BtreeCloseCursor(BtCursor *pCur){
drhff0587c2007-08-29 17:43:19 +00002767 Btree *pBtree = pCur->pBtree;
danielk1977cd3e8f72008-03-25 09:47:35 +00002768 if( pBtree ){
2769 BtShared *pBt = pCur->pBt;
2770 sqlite3BtreeEnter(pBtree);
2771 pBt->db = pBtree->db;
2772 clearCursorPosition(pCur);
2773 if( pCur->pPrev ){
2774 pCur->pPrev->pNext = pCur->pNext;
2775 }else{
2776 pBt->pCursor = pCur->pNext;
2777 }
2778 if( pCur->pNext ){
2779 pCur->pNext->pPrev = pCur->pPrev;
2780 }
2781 releasePage(pCur->pPage);
2782 unlockBtreeIfUnused(pBt);
2783 invalidateOverflowCache(pCur);
2784 /* sqlite3_free(pCur); */
2785 sqlite3BtreeLeave(pBtree);
drha059ad02001-04-17 20:09:11 +00002786 }
drh8c42ca92001-06-22 19:15:00 +00002787 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00002788}
2789
drh7e3b0a02001-04-28 16:52:40 +00002790/*
drh5e2f8b92001-05-28 00:41:15 +00002791** Make a temporary cursor by filling in the fields of pTempCur.
2792** The temporary cursor is not on the cursor list for the Btree.
2793*/
drh16a9b832007-05-05 18:39:25 +00002794void sqlite3BtreeGetTempCursor(BtCursor *pCur, BtCursor *pTempCur){
drh1fee73e2007-08-29 04:00:57 +00002795 assert( cursorHoldsMutex(pCur) );
drh5e2f8b92001-05-28 00:41:15 +00002796 memcpy(pTempCur, pCur, sizeof(*pCur));
2797 pTempCur->pNext = 0;
2798 pTempCur->pPrev = 0;
drhecdc7532001-09-23 02:35:53 +00002799 if( pTempCur->pPage ){
danielk19773b8a05f2007-03-19 17:44:26 +00002800 sqlite3PagerRef(pTempCur->pPage->pDbPage);
drhecdc7532001-09-23 02:35:53 +00002801 }
drh5e2f8b92001-05-28 00:41:15 +00002802}
2803
2804/*
drhbd03cae2001-06-02 02:40:57 +00002805** Delete a temporary cursor such as was made by the CreateTemporaryCursor()
drh5e2f8b92001-05-28 00:41:15 +00002806** function above.
2807*/
drh16a9b832007-05-05 18:39:25 +00002808void sqlite3BtreeReleaseTempCursor(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00002809 assert( cursorHoldsMutex(pCur) );
drhecdc7532001-09-23 02:35:53 +00002810 if( pCur->pPage ){
danielk19773b8a05f2007-03-19 17:44:26 +00002811 sqlite3PagerUnref(pCur->pPage->pDbPage);
drhecdc7532001-09-23 02:35:53 +00002812 }
drh5e2f8b92001-05-28 00:41:15 +00002813}
2814
2815/*
drh86057612007-06-26 01:04:48 +00002816** Make sure the BtCursor* given in the argument has a valid
2817** BtCursor.info structure. If it is not already valid, call
danielk19771cc5ed82007-05-16 17:28:43 +00002818** sqlite3BtreeParseCell() to fill it in.
drhab01f612004-05-22 02:55:23 +00002819**
2820** BtCursor.info is a cache of the information in the current cell.
drh16a9b832007-05-05 18:39:25 +00002821** Using this cache reduces the number of calls to sqlite3BtreeParseCell().
drh86057612007-06-26 01:04:48 +00002822**
2823** 2007-06-25: There is a bug in some versions of MSVC that cause the
2824** compiler to crash when getCellInfo() is implemented as a macro.
2825** But there is a measureable speed advantage to using the macro on gcc
2826** (when less compiler optimizations like -Os or -O0 are used and the
2827** compiler is not doing agressive inlining.) So we use a real function
2828** for MSVC and a macro for everything else. Ticket #2457.
drh9188b382004-05-14 21:12:22 +00002829*/
drh9188b382004-05-14 21:12:22 +00002830#ifndef NDEBUG
danielk19771cc5ed82007-05-16 17:28:43 +00002831 static void assertCellInfo(BtCursor *pCur){
drh9188b382004-05-14 21:12:22 +00002832 CellInfo info;
drh51c6d962004-06-06 00:42:25 +00002833 memset(&info, 0, sizeof(info));
drh16a9b832007-05-05 18:39:25 +00002834 sqlite3BtreeParseCell(pCur->pPage, pCur->idx, &info);
drh9188b382004-05-14 21:12:22 +00002835 assert( memcmp(&info, &pCur->info, sizeof(info))==0 );
drh9188b382004-05-14 21:12:22 +00002836 }
danielk19771cc5ed82007-05-16 17:28:43 +00002837#else
2838 #define assertCellInfo(x)
2839#endif
drh86057612007-06-26 01:04:48 +00002840#ifdef _MSC_VER
2841 /* Use a real function in MSVC to work around bugs in that compiler. */
2842 static void getCellInfo(BtCursor *pCur){
2843 if( pCur->info.nSize==0 ){
2844 sqlite3BtreeParseCell(pCur->pPage, pCur->idx, &pCur->info);
2845 }else{
2846 assertCellInfo(pCur);
2847 }
2848 }
2849#else /* if not _MSC_VER */
2850 /* Use a macro in all other compilers so that the function is inlined */
2851#define getCellInfo(pCur) \
2852 if( pCur->info.nSize==0 ){ \
danielk19771cc5ed82007-05-16 17:28:43 +00002853 sqlite3BtreeParseCell(pCur->pPage, pCur->idx, &pCur->info); \
drh86057612007-06-26 01:04:48 +00002854 }else{ \
2855 assertCellInfo(pCur); \
2856 }
2857#endif /* _MSC_VER */
drh9188b382004-05-14 21:12:22 +00002858
2859/*
drh3aac2dd2004-04-26 14:10:20 +00002860** Set *pSize to the size of the buffer needed to hold the value of
2861** the key for the current entry. If the cursor is not pointing
2862** to a valid entry, *pSize is set to 0.
2863**
drh4b70f112004-05-02 21:12:19 +00002864** For a table with the INTKEY flag set, this routine returns the key
drh3aac2dd2004-04-26 14:10:20 +00002865** itself, not the number of bytes in the key.
drh7e3b0a02001-04-28 16:52:40 +00002866*/
drh4a1c3802004-05-12 15:15:47 +00002867int sqlite3BtreeKeySize(BtCursor *pCur, i64 *pSize){
drhd677b3d2007-08-20 22:48:41 +00002868 int rc;
2869
drh1fee73e2007-08-29 04:00:57 +00002870 assert( cursorHoldsMutex(pCur) );
drhd677b3d2007-08-20 22:48:41 +00002871 rc = restoreOrClearCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00002872 if( rc==SQLITE_OK ){
2873 assert( pCur->eState==CURSOR_INVALID || pCur->eState==CURSOR_VALID );
2874 if( pCur->eState==CURSOR_INVALID ){
2875 *pSize = 0;
2876 }else{
drh86057612007-06-26 01:04:48 +00002877 getCellInfo(pCur);
danielk1977da184232006-01-05 11:34:32 +00002878 *pSize = pCur->info.nKey;
2879 }
drh72f82862001-05-24 21:06:34 +00002880 }
danielk1977da184232006-01-05 11:34:32 +00002881 return rc;
drha059ad02001-04-17 20:09:11 +00002882}
drh2af926b2001-05-15 00:39:25 +00002883
drh72f82862001-05-24 21:06:34 +00002884/*
drh0e1c19e2004-05-11 00:58:56 +00002885** Set *pSize to the number of bytes of data in the entry the
2886** cursor currently points to. Always return SQLITE_OK.
2887** Failure is not possible. If the cursor is not currently
2888** pointing to an entry (which can happen, for example, if
2889** the database is empty) then *pSize is set to 0.
2890*/
2891int sqlite3BtreeDataSize(BtCursor *pCur, u32 *pSize){
drhd677b3d2007-08-20 22:48:41 +00002892 int rc;
2893
drh1fee73e2007-08-29 04:00:57 +00002894 assert( cursorHoldsMutex(pCur) );
drhd677b3d2007-08-20 22:48:41 +00002895 rc = restoreOrClearCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00002896 if( rc==SQLITE_OK ){
2897 assert( pCur->eState==CURSOR_INVALID || pCur->eState==CURSOR_VALID );
2898 if( pCur->eState==CURSOR_INVALID ){
2899 /* Not pointing at a valid entry - set *pSize to 0. */
2900 *pSize = 0;
2901 }else{
drh86057612007-06-26 01:04:48 +00002902 getCellInfo(pCur);
danielk1977da184232006-01-05 11:34:32 +00002903 *pSize = pCur->info.nData;
2904 }
drh0e1c19e2004-05-11 00:58:56 +00002905 }
danielk1977da184232006-01-05 11:34:32 +00002906 return rc;
drh0e1c19e2004-05-11 00:58:56 +00002907}
2908
2909/*
danielk1977d04417962007-05-02 13:16:30 +00002910** Given the page number of an overflow page in the database (parameter
2911** ovfl), this function finds the page number of the next page in the
2912** linked list of overflow pages. If possible, it uses the auto-vacuum
2913** pointer-map data instead of reading the content of page ovfl to do so.
2914**
2915** If an error occurs an SQLite error code is returned. Otherwise:
2916**
2917** Unless pPgnoNext is NULL, the page number of the next overflow
2918** page in the linked list is written to *pPgnoNext. If page ovfl
drh85b623f2007-12-13 21:54:09 +00002919** is the last page in its linked list, *pPgnoNext is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00002920**
2921** If ppPage is not NULL, *ppPage is set to the MemPage* handle
2922** for page ovfl. The underlying pager page may have been requested
2923** with the noContent flag set, so the page data accessable via
2924** this handle may not be trusted.
2925*/
2926static int getOverflowPage(
2927 BtShared *pBt,
2928 Pgno ovfl, /* Overflow page */
2929 MemPage **ppPage, /* OUT: MemPage handle */
2930 Pgno *pPgnoNext /* OUT: Next overflow page number */
2931){
2932 Pgno next = 0;
2933 int rc;
2934
drh1fee73e2007-08-29 04:00:57 +00002935 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977d04417962007-05-02 13:16:30 +00002936 /* One of these must not be NULL. Otherwise, why call this function? */
2937 assert(ppPage || pPgnoNext);
2938
2939 /* If pPgnoNext is NULL, then this function is being called to obtain
2940 ** a MemPage* reference only. No page-data is required in this case.
2941 */
2942 if( !pPgnoNext ){
drh16a9b832007-05-05 18:39:25 +00002943 return sqlite3BtreeGetPage(pBt, ovfl, ppPage, 1);
danielk1977d04417962007-05-02 13:16:30 +00002944 }
2945
2946#ifndef SQLITE_OMIT_AUTOVACUUM
2947 /* Try to find the next page in the overflow list using the
2948 ** autovacuum pointer-map pages. Guess that the next page in
2949 ** the overflow list is page number (ovfl+1). If that guess turns
2950 ** out to be wrong, fall back to loading the data of page
2951 ** number ovfl to determine the next page number.
2952 */
2953 if( pBt->autoVacuum ){
2954 Pgno pgno;
2955 Pgno iGuess = ovfl+1;
2956 u8 eType;
2957
2958 while( PTRMAP_ISPAGE(pBt, iGuess) || iGuess==PENDING_BYTE_PAGE(pBt) ){
2959 iGuess++;
2960 }
2961
danielk197720713f32007-05-03 11:43:33 +00002962 if( iGuess<=sqlite3PagerPagecount(pBt->pPager) ){
danielk1977d04417962007-05-02 13:16:30 +00002963 rc = ptrmapGet(pBt, iGuess, &eType, &pgno);
2964 if( rc!=SQLITE_OK ){
2965 return rc;
2966 }
2967 if( eType==PTRMAP_OVERFLOW2 && pgno==ovfl ){
2968 next = iGuess;
2969 }
2970 }
2971 }
2972#endif
2973
2974 if( next==0 || ppPage ){
2975 MemPage *pPage = 0;
2976
drh16a9b832007-05-05 18:39:25 +00002977 rc = sqlite3BtreeGetPage(pBt, ovfl, &pPage, next!=0);
danielk1977d04417962007-05-02 13:16:30 +00002978 assert(rc==SQLITE_OK || pPage==0);
2979 if( next==0 && rc==SQLITE_OK ){
2980 next = get4byte(pPage->aData);
2981 }
2982
2983 if( ppPage ){
2984 *ppPage = pPage;
2985 }else{
2986 releasePage(pPage);
2987 }
2988 }
2989 *pPgnoNext = next;
2990
2991 return rc;
2992}
2993
danielk1977da107192007-05-04 08:32:13 +00002994/*
2995** Copy data from a buffer to a page, or from a page to a buffer.
2996**
2997** pPayload is a pointer to data stored on database page pDbPage.
2998** If argument eOp is false, then nByte bytes of data are copied
2999** from pPayload to the buffer pointed at by pBuf. If eOp is true,
3000** then sqlite3PagerWrite() is called on pDbPage and nByte bytes
3001** of data are copied from the buffer pBuf to pPayload.
3002**
3003** SQLITE_OK is returned on success, otherwise an error code.
3004*/
3005static int copyPayload(
3006 void *pPayload, /* Pointer to page data */
3007 void *pBuf, /* Pointer to buffer */
3008 int nByte, /* Number of bytes to copy */
3009 int eOp, /* 0 -> copy from page, 1 -> copy to page */
3010 DbPage *pDbPage /* Page containing pPayload */
3011){
3012 if( eOp ){
3013 /* Copy data from buffer to page (a write operation) */
3014 int rc = sqlite3PagerWrite(pDbPage);
3015 if( rc!=SQLITE_OK ){
3016 return rc;
3017 }
3018 memcpy(pPayload, pBuf, nByte);
3019 }else{
3020 /* Copy data from page to buffer (a read operation) */
3021 memcpy(pBuf, pPayload, nByte);
3022 }
3023 return SQLITE_OK;
3024}
danielk1977d04417962007-05-02 13:16:30 +00003025
3026/*
danielk19779f8d6402007-05-02 17:48:45 +00003027** This function is used to read or overwrite payload information
3028** for the entry that the pCur cursor is pointing to. If the eOp
3029** parameter is 0, this is a read operation (data copied into
3030** buffer pBuf). If it is non-zero, a write (data copied from
3031** buffer pBuf).
3032**
3033** A total of "amt" bytes are read or written beginning at "offset".
3034** Data is read to or from the buffer pBuf.
drh72f82862001-05-24 21:06:34 +00003035**
3036** This routine does not make a distinction between key and data.
danielk19779f8d6402007-05-02 17:48:45 +00003037** It just reads or writes bytes from the payload area. Data might
3038** appear on the main page or be scattered out on multiple overflow
3039** pages.
danielk1977da107192007-05-04 08:32:13 +00003040**
danielk1977dcbb5d32007-05-04 18:36:44 +00003041** If the BtCursor.isIncrblobHandle flag is set, and the current
danielk1977da107192007-05-04 08:32:13 +00003042** cursor entry uses one or more overflow pages, this function
3043** allocates space for and lazily popluates the overflow page-list
3044** cache array (BtCursor.aOverflow). Subsequent calls use this
3045** cache to make seeking to the supplied offset more efficient.
3046**
3047** Once an overflow page-list cache has been allocated, it may be
3048** invalidated if some other cursor writes to the same table, or if
3049** the cursor is moved to a different row. Additionally, in auto-vacuum
3050** mode, the following events may invalidate an overflow page-list cache.
3051**
3052** * An incremental vacuum,
3053** * A commit in auto_vacuum="full" mode,
3054** * Creating a table (may require moving an overflow page).
drh72f82862001-05-24 21:06:34 +00003055*/
danielk19779f8d6402007-05-02 17:48:45 +00003056static int accessPayload(
drh3aac2dd2004-04-26 14:10:20 +00003057 BtCursor *pCur, /* Cursor pointing to entry to read from */
3058 int offset, /* Begin reading this far into payload */
3059 int amt, /* Read this many bytes */
3060 unsigned char *pBuf, /* Write the bytes into this buffer */
danielk19779f8d6402007-05-02 17:48:45 +00003061 int skipKey, /* offset begins at data if this is true */
3062 int eOp /* zero to read. non-zero to write. */
drh3aac2dd2004-04-26 14:10:20 +00003063){
3064 unsigned char *aPayload;
danielk1977da107192007-05-04 08:32:13 +00003065 int rc = SQLITE_OK;
drhfa1a98a2004-05-14 19:08:17 +00003066 u32 nKey;
danielk19772dec9702007-05-02 16:48:37 +00003067 int iIdx = 0;
drhd0679ed2007-08-28 22:24:34 +00003068 MemPage *pPage = pCur->pPage; /* Btree page of current cursor entry */
drh51f015e2007-10-16 19:45:29 +00003069 BtShared *pBt; /* Btree this cursor belongs to */
drh3aac2dd2004-04-26 14:10:20 +00003070
danielk1977da107192007-05-04 08:32:13 +00003071 assert( pPage );
danielk1977da184232006-01-05 11:34:32 +00003072 assert( pCur->eState==CURSOR_VALID );
drh3aac2dd2004-04-26 14:10:20 +00003073 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
danielk1977da107192007-05-04 08:32:13 +00003074 assert( offset>=0 );
drh1fee73e2007-08-29 04:00:57 +00003075 assert( cursorHoldsMutex(pCur) );
danielk1977da107192007-05-04 08:32:13 +00003076
drh86057612007-06-26 01:04:48 +00003077 getCellInfo(pCur);
drh366fda62006-01-13 02:35:09 +00003078 aPayload = pCur->info.pCell + pCur->info.nHeader;
danielk1977da107192007-05-04 08:32:13 +00003079 nKey = (pPage->intKey ? 0 : pCur->info.nKey);
3080
drh3aac2dd2004-04-26 14:10:20 +00003081 if( skipKey ){
drhfa1a98a2004-05-14 19:08:17 +00003082 offset += nKey;
drh3aac2dd2004-04-26 14:10:20 +00003083 }
drhfa1a98a2004-05-14 19:08:17 +00003084 if( offset+amt > nKey+pCur->info.nData ){
danielk1977da107192007-05-04 08:32:13 +00003085 /* Trying to read or write past the end of the data is an error */
drha34b6762004-05-07 13:30:42 +00003086 return SQLITE_ERROR;
drh3aac2dd2004-04-26 14:10:20 +00003087 }
danielk1977da107192007-05-04 08:32:13 +00003088
3089 /* Check if data must be read/written to/from the btree page itself. */
drhfa1a98a2004-05-14 19:08:17 +00003090 if( offset<pCur->info.nLocal ){
drh2af926b2001-05-15 00:39:25 +00003091 int a = amt;
drhfa1a98a2004-05-14 19:08:17 +00003092 if( a+offset>pCur->info.nLocal ){
3093 a = pCur->info.nLocal - offset;
drh2af926b2001-05-15 00:39:25 +00003094 }
danielk1977da107192007-05-04 08:32:13 +00003095 rc = copyPayload(&aPayload[offset], pBuf, a, eOp, pPage->pDbPage);
drh2aa679f2001-06-25 02:11:07 +00003096 offset = 0;
drha34b6762004-05-07 13:30:42 +00003097 pBuf += a;
drh2af926b2001-05-15 00:39:25 +00003098 amt -= a;
drhdd793422001-06-28 01:54:48 +00003099 }else{
drhfa1a98a2004-05-14 19:08:17 +00003100 offset -= pCur->info.nLocal;
drhbd03cae2001-06-02 02:40:57 +00003101 }
danielk1977da107192007-05-04 08:32:13 +00003102
drh51f015e2007-10-16 19:45:29 +00003103 pBt = pCur->pBt;
danielk1977da107192007-05-04 08:32:13 +00003104 if( rc==SQLITE_OK && amt>0 ){
3105 const int ovflSize = pBt->usableSize - 4; /* Bytes content per ovfl page */
3106 Pgno nextPage;
3107
drhfa1a98a2004-05-14 19:08:17 +00003108 nextPage = get4byte(&aPayload[pCur->info.nLocal]);
danielk1977da107192007-05-04 08:32:13 +00003109
danielk19772dec9702007-05-02 16:48:37 +00003110#ifndef SQLITE_OMIT_INCRBLOB
danielk1977dcbb5d32007-05-04 18:36:44 +00003111 /* If the isIncrblobHandle flag is set and the BtCursor.aOverflow[]
danielk1977da107192007-05-04 08:32:13 +00003112 ** has not been allocated, allocate it now. The array is sized at
3113 ** one entry for each overflow page in the overflow chain. The
3114 ** page number of the first overflow page is stored in aOverflow[0],
3115 ** etc. A value of 0 in the aOverflow[] array means "not yet known"
3116 ** (the cache is lazily populated).
3117 */
danielk1977dcbb5d32007-05-04 18:36:44 +00003118 if( pCur->isIncrblobHandle && !pCur->aOverflow ){
danielk19772dec9702007-05-02 16:48:37 +00003119 int nOvfl = (pCur->info.nPayload-pCur->info.nLocal+ovflSize-1)/ovflSize;
drh17435752007-08-16 04:30:38 +00003120 pCur->aOverflow = (Pgno *)sqlite3MallocZero(sizeof(Pgno)*nOvfl);
danielk19772dec9702007-05-02 16:48:37 +00003121 if( nOvfl && !pCur->aOverflow ){
danielk1977da107192007-05-04 08:32:13 +00003122 rc = SQLITE_NOMEM;
danielk19772dec9702007-05-02 16:48:37 +00003123 }
3124 }
danielk1977da107192007-05-04 08:32:13 +00003125
3126 /* If the overflow page-list cache has been allocated and the
3127 ** entry for the first required overflow page is valid, skip
3128 ** directly to it.
3129 */
danielk19772dec9702007-05-02 16:48:37 +00003130 if( pCur->aOverflow && pCur->aOverflow[offset/ovflSize] ){
3131 iIdx = (offset/ovflSize);
3132 nextPage = pCur->aOverflow[iIdx];
3133 offset = (offset%ovflSize);
3134 }
3135#endif
danielk1977da107192007-05-04 08:32:13 +00003136
3137 for( ; rc==SQLITE_OK && amt>0 && nextPage; iIdx++){
3138
3139#ifndef SQLITE_OMIT_INCRBLOB
3140 /* If required, populate the overflow page-list cache. */
3141 if( pCur->aOverflow ){
3142 assert(!pCur->aOverflow[iIdx] || pCur->aOverflow[iIdx]==nextPage);
3143 pCur->aOverflow[iIdx] = nextPage;
3144 }
3145#endif
3146
danielk1977d04417962007-05-02 13:16:30 +00003147 if( offset>=ovflSize ){
3148 /* The only reason to read this page is to obtain the page
danielk1977da107192007-05-04 08:32:13 +00003149 ** number for the next page in the overflow chain. The page
drhfd131da2007-08-07 17:13:03 +00003150 ** data is not required. So first try to lookup the overflow
3151 ** page-list cache, if any, then fall back to the getOverflowPage()
danielk1977da107192007-05-04 08:32:13 +00003152 ** function.
danielk1977d04417962007-05-02 13:16:30 +00003153 */
danielk19772dec9702007-05-02 16:48:37 +00003154#ifndef SQLITE_OMIT_INCRBLOB
danielk1977da107192007-05-04 08:32:13 +00003155 if( pCur->aOverflow && pCur->aOverflow[iIdx+1] ){
3156 nextPage = pCur->aOverflow[iIdx+1];
3157 } else
danielk19772dec9702007-05-02 16:48:37 +00003158#endif
danielk1977da107192007-05-04 08:32:13 +00003159 rc = getOverflowPage(pBt, nextPage, 0, &nextPage);
danielk1977da107192007-05-04 08:32:13 +00003160 offset -= ovflSize;
danielk1977d04417962007-05-02 13:16:30 +00003161 }else{
danielk19779f8d6402007-05-02 17:48:45 +00003162 /* Need to read this page properly. It contains some of the
3163 ** range of data that is being read (eOp==0) or written (eOp!=0).
danielk1977d04417962007-05-02 13:16:30 +00003164 */
3165 DbPage *pDbPage;
danielk1977cfe9a692004-06-16 12:00:29 +00003166 int a = amt;
danielk1977d04417962007-05-02 13:16:30 +00003167 rc = sqlite3PagerGet(pBt->pPager, nextPage, &pDbPage);
danielk1977da107192007-05-04 08:32:13 +00003168 if( rc==SQLITE_OK ){
3169 aPayload = sqlite3PagerGetData(pDbPage);
3170 nextPage = get4byte(aPayload);
3171 if( a + offset > ovflSize ){
3172 a = ovflSize - offset;
danielk19779f8d6402007-05-02 17:48:45 +00003173 }
danielk1977da107192007-05-04 08:32:13 +00003174 rc = copyPayload(&aPayload[offset+4], pBuf, a, eOp, pDbPage);
3175 sqlite3PagerUnref(pDbPage);
3176 offset = 0;
3177 amt -= a;
3178 pBuf += a;
danielk19779f8d6402007-05-02 17:48:45 +00003179 }
danielk1977cfe9a692004-06-16 12:00:29 +00003180 }
drh2af926b2001-05-15 00:39:25 +00003181 }
drh2af926b2001-05-15 00:39:25 +00003182 }
danielk1977cfe9a692004-06-16 12:00:29 +00003183
danielk1977da107192007-05-04 08:32:13 +00003184 if( rc==SQLITE_OK && amt>0 ){
drh49285702005-09-17 15:20:26 +00003185 return SQLITE_CORRUPT_BKPT;
drha7fcb052001-12-14 15:09:55 +00003186 }
danielk1977da107192007-05-04 08:32:13 +00003187 return rc;
drh2af926b2001-05-15 00:39:25 +00003188}
3189
drh72f82862001-05-24 21:06:34 +00003190/*
drh3aac2dd2004-04-26 14:10:20 +00003191** Read part of the key associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00003192** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00003193** begins at "offset".
drh8c1238a2003-01-02 14:43:55 +00003194**
drh3aac2dd2004-04-26 14:10:20 +00003195** Return SQLITE_OK on success or an error code if anything goes
3196** wrong. An error is returned if "offset+amt" is larger than
3197** the available payload.
drh72f82862001-05-24 21:06:34 +00003198*/
drha34b6762004-05-07 13:30:42 +00003199int sqlite3BtreeKey(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drhd677b3d2007-08-20 22:48:41 +00003200 int rc;
3201
drh1fee73e2007-08-29 04:00:57 +00003202 assert( cursorHoldsMutex(pCur) );
drhd677b3d2007-08-20 22:48:41 +00003203 rc = restoreOrClearCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003204 if( rc==SQLITE_OK ){
3205 assert( pCur->eState==CURSOR_VALID );
3206 assert( pCur->pPage!=0 );
3207 if( pCur->pPage->intKey ){
3208 return SQLITE_CORRUPT_BKPT;
3209 }
3210 assert( pCur->pPage->intKey==0 );
3211 assert( pCur->idx>=0 && pCur->idx<pCur->pPage->nCell );
drh16a9b832007-05-05 18:39:25 +00003212 rc = accessPayload(pCur, offset, amt, (unsigned char*)pBuf, 0, 0);
drh6575a222005-03-10 17:06:34 +00003213 }
danielk1977da184232006-01-05 11:34:32 +00003214 return rc;
drh3aac2dd2004-04-26 14:10:20 +00003215}
3216
3217/*
drh3aac2dd2004-04-26 14:10:20 +00003218** Read part of the data associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00003219** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00003220** begins at "offset".
3221**
3222** Return SQLITE_OK on success or an error code if anything goes
3223** wrong. An error is returned if "offset+amt" is larger than
3224** the available payload.
drh72f82862001-05-24 21:06:34 +00003225*/
drh3aac2dd2004-04-26 14:10:20 +00003226int sqlite3BtreeData(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drhd677b3d2007-08-20 22:48:41 +00003227 int rc;
3228
drh1fee73e2007-08-29 04:00:57 +00003229 assert( cursorHoldsMutex(pCur) );
drhd677b3d2007-08-20 22:48:41 +00003230 rc = restoreOrClearCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003231 if( rc==SQLITE_OK ){
3232 assert( pCur->eState==CURSOR_VALID );
3233 assert( pCur->pPage!=0 );
3234 assert( pCur->idx>=0 && pCur->idx<pCur->pPage->nCell );
drh16a9b832007-05-05 18:39:25 +00003235 rc = accessPayload(pCur, offset, amt, pBuf, 1, 0);
danielk1977da184232006-01-05 11:34:32 +00003236 }
3237 return rc;
drh2af926b2001-05-15 00:39:25 +00003238}
3239
drh72f82862001-05-24 21:06:34 +00003240/*
drh0e1c19e2004-05-11 00:58:56 +00003241** Return a pointer to payload information from the entry that the
3242** pCur cursor is pointing to. The pointer is to the beginning of
3243** the key if skipKey==0 and it points to the beginning of data if
drhe51c44f2004-05-30 20:46:09 +00003244** skipKey==1. The number of bytes of available key/data is written
3245** into *pAmt. If *pAmt==0, then the value returned will not be
3246** a valid pointer.
drh0e1c19e2004-05-11 00:58:56 +00003247**
3248** This routine is an optimization. It is common for the entire key
3249** and data to fit on the local page and for there to be no overflow
3250** pages. When that is so, this routine can be used to access the
3251** key and data without making a copy. If the key and/or data spills
drh16a9b832007-05-05 18:39:25 +00003252** onto overflow pages, then accessPayload() must be used to reassembly
drh0e1c19e2004-05-11 00:58:56 +00003253** the key/data and copy it into a preallocated buffer.
3254**
3255** The pointer returned by this routine looks directly into the cached
3256** page of the database. The data might change or move the next time
3257** any btree routine is called.
3258*/
3259static const unsigned char *fetchPayload(
3260 BtCursor *pCur, /* Cursor pointing to entry to read from */
drhe51c44f2004-05-30 20:46:09 +00003261 int *pAmt, /* Write the number of available bytes here */
drh0e1c19e2004-05-11 00:58:56 +00003262 int skipKey /* read beginning at data if this is true */
3263){
3264 unsigned char *aPayload;
3265 MemPage *pPage;
drhfa1a98a2004-05-14 19:08:17 +00003266 u32 nKey;
3267 int nLocal;
drh0e1c19e2004-05-11 00:58:56 +00003268
3269 assert( pCur!=0 && pCur->pPage!=0 );
danielk1977da184232006-01-05 11:34:32 +00003270 assert( pCur->eState==CURSOR_VALID );
drh1fee73e2007-08-29 04:00:57 +00003271 assert( cursorHoldsMutex(pCur) );
drh0e1c19e2004-05-11 00:58:56 +00003272 pPage = pCur->pPage;
drh0e1c19e2004-05-11 00:58:56 +00003273 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
drh86057612007-06-26 01:04:48 +00003274 getCellInfo(pCur);
drh43605152004-05-29 21:46:49 +00003275 aPayload = pCur->info.pCell;
drhfa1a98a2004-05-14 19:08:17 +00003276 aPayload += pCur->info.nHeader;
drh0e1c19e2004-05-11 00:58:56 +00003277 if( pPage->intKey ){
drhfa1a98a2004-05-14 19:08:17 +00003278 nKey = 0;
3279 }else{
3280 nKey = pCur->info.nKey;
drh0e1c19e2004-05-11 00:58:56 +00003281 }
drh0e1c19e2004-05-11 00:58:56 +00003282 if( skipKey ){
drhfa1a98a2004-05-14 19:08:17 +00003283 aPayload += nKey;
3284 nLocal = pCur->info.nLocal - nKey;
drh0e1c19e2004-05-11 00:58:56 +00003285 }else{
drhfa1a98a2004-05-14 19:08:17 +00003286 nLocal = pCur->info.nLocal;
drhe51c44f2004-05-30 20:46:09 +00003287 if( nLocal>nKey ){
3288 nLocal = nKey;
3289 }
drh0e1c19e2004-05-11 00:58:56 +00003290 }
drhe51c44f2004-05-30 20:46:09 +00003291 *pAmt = nLocal;
drh0e1c19e2004-05-11 00:58:56 +00003292 return aPayload;
3293}
3294
3295
3296/*
drhe51c44f2004-05-30 20:46:09 +00003297** For the entry that cursor pCur is point to, return as
3298** many bytes of the key or data as are available on the local
3299** b-tree page. Write the number of available bytes into *pAmt.
drh0e1c19e2004-05-11 00:58:56 +00003300**
3301** The pointer returned is ephemeral. The key/data may move
drhd677b3d2007-08-20 22:48:41 +00003302** or be destroyed on the next call to any Btree routine,
3303** including calls from other threads against the same cache.
3304** Hence, a mutex on the BtShared should be held prior to calling
3305** this routine.
drh0e1c19e2004-05-11 00:58:56 +00003306**
3307** These routines is used to get quick access to key and data
3308** in the common case where no overflow pages are used.
drh0e1c19e2004-05-11 00:58:56 +00003309*/
drhe51c44f2004-05-30 20:46:09 +00003310const void *sqlite3BtreeKeyFetch(BtCursor *pCur, int *pAmt){
drh1fee73e2007-08-29 04:00:57 +00003311 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003312 if( pCur->eState==CURSOR_VALID ){
3313 return (const void*)fetchPayload(pCur, pAmt, 0);
3314 }
3315 return 0;
drh0e1c19e2004-05-11 00:58:56 +00003316}
drhe51c44f2004-05-30 20:46:09 +00003317const void *sqlite3BtreeDataFetch(BtCursor *pCur, int *pAmt){
drh1fee73e2007-08-29 04:00:57 +00003318 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003319 if( pCur->eState==CURSOR_VALID ){
3320 return (const void*)fetchPayload(pCur, pAmt, 1);
3321 }
3322 return 0;
drh0e1c19e2004-05-11 00:58:56 +00003323}
3324
3325
3326/*
drh8178a752003-01-05 21:41:40 +00003327** Move the cursor down to a new child page. The newPgno argument is the
drhab01f612004-05-22 02:55:23 +00003328** page number of the child page to move to.
drh72f82862001-05-24 21:06:34 +00003329*/
drh3aac2dd2004-04-26 14:10:20 +00003330static int moveToChild(BtCursor *pCur, u32 newPgno){
drh72f82862001-05-24 21:06:34 +00003331 int rc;
3332 MemPage *pNewPage;
drh3aac2dd2004-04-26 14:10:20 +00003333 MemPage *pOldPage;
drhd0679ed2007-08-28 22:24:34 +00003334 BtShared *pBt = pCur->pBt;
drh72f82862001-05-24 21:06:34 +00003335
drh1fee73e2007-08-29 04:00:57 +00003336 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003337 assert( pCur->eState==CURSOR_VALID );
drhde647132004-05-07 17:57:49 +00003338 rc = getAndInitPage(pBt, newPgno, &pNewPage, pCur->pPage);
drh6019e162001-07-02 17:51:45 +00003339 if( rc ) return rc;
drh428ae8c2003-01-04 16:48:09 +00003340 pNewPage->idxParent = pCur->idx;
drh3aac2dd2004-04-26 14:10:20 +00003341 pOldPage = pCur->pPage;
3342 pOldPage->idxShift = 0;
3343 releasePage(pOldPage);
drh72f82862001-05-24 21:06:34 +00003344 pCur->pPage = pNewPage;
3345 pCur->idx = 0;
drh271efa52004-05-30 19:19:05 +00003346 pCur->info.nSize = 0;
drh4be295b2003-12-16 03:44:47 +00003347 if( pNewPage->nCell<1 ){
drh49285702005-09-17 15:20:26 +00003348 return SQLITE_CORRUPT_BKPT;
drh4be295b2003-12-16 03:44:47 +00003349 }
drh72f82862001-05-24 21:06:34 +00003350 return SQLITE_OK;
3351}
3352
3353/*
drh8856d6a2004-04-29 14:42:46 +00003354** Return true if the page is the virtual root of its table.
3355**
3356** The virtual root page is the root page for most tables. But
3357** for the table rooted on page 1, sometime the real root page
3358** is empty except for the right-pointer. In such cases the
3359** virtual root page is the page that the right-pointer of page
3360** 1 is pointing to.
3361*/
drh16a9b832007-05-05 18:39:25 +00003362int sqlite3BtreeIsRootPage(MemPage *pPage){
drhd677b3d2007-08-20 22:48:41 +00003363 MemPage *pParent;
3364
drh1fee73e2007-08-29 04:00:57 +00003365 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00003366 pParent = pPage->pParent;
drhda200cc2004-05-09 11:51:38 +00003367 if( pParent==0 ) return 1;
3368 if( pParent->pgno>1 ) return 0;
3369 if( get2byte(&pParent->aData[pParent->hdrOffset+3])==0 ) return 1;
drh8856d6a2004-04-29 14:42:46 +00003370 return 0;
3371}
3372
3373/*
drh5e2f8b92001-05-28 00:41:15 +00003374** Move the cursor up to the parent page.
3375**
3376** pCur->idx is set to the cell index that contains the pointer
3377** to the page we are coming from. If we are coming from the
3378** right-most child page then pCur->idx is set to one more than
drhbd03cae2001-06-02 02:40:57 +00003379** the largest cell index.
drh72f82862001-05-24 21:06:34 +00003380*/
drh16a9b832007-05-05 18:39:25 +00003381void sqlite3BtreeMoveToParent(BtCursor *pCur){
drh72f82862001-05-24 21:06:34 +00003382 MemPage *pParent;
drh8178a752003-01-05 21:41:40 +00003383 MemPage *pPage;
drh428ae8c2003-01-04 16:48:09 +00003384 int idxParent;
drh3aac2dd2004-04-26 14:10:20 +00003385
drh1fee73e2007-08-29 04:00:57 +00003386 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003387 assert( pCur->eState==CURSOR_VALID );
drh8178a752003-01-05 21:41:40 +00003388 pPage = pCur->pPage;
3389 assert( pPage!=0 );
drh16a9b832007-05-05 18:39:25 +00003390 assert( !sqlite3BtreeIsRootPage(pPage) );
drh8178a752003-01-05 21:41:40 +00003391 pParent = pPage->pParent;
3392 assert( pParent!=0 );
3393 idxParent = pPage->idxParent;
danielk19773b8a05f2007-03-19 17:44:26 +00003394 sqlite3PagerRef(pParent->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00003395 releasePage(pPage);
drh72f82862001-05-24 21:06:34 +00003396 pCur->pPage = pParent;
drh271efa52004-05-30 19:19:05 +00003397 pCur->info.nSize = 0;
drh428ae8c2003-01-04 16:48:09 +00003398 assert( pParent->idxShift==0 );
drh43605152004-05-29 21:46:49 +00003399 pCur->idx = idxParent;
drh72f82862001-05-24 21:06:34 +00003400}
3401
3402/*
3403** Move the cursor to the root page
3404*/
drh5e2f8b92001-05-28 00:41:15 +00003405static int moveToRoot(BtCursor *pCur){
drh3aac2dd2004-04-26 14:10:20 +00003406 MemPage *pRoot;
drh777e4c42006-01-13 04:31:58 +00003407 int rc = SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00003408 Btree *p = pCur->pBtree;
3409 BtShared *pBt = p->pBt;
drhbd03cae2001-06-02 02:40:57 +00003410
drh1fee73e2007-08-29 04:00:57 +00003411 assert( cursorHoldsMutex(pCur) );
drhfb982642007-08-30 01:19:59 +00003412 assert( CURSOR_INVALID < CURSOR_REQUIRESEEK );
3413 assert( CURSOR_VALID < CURSOR_REQUIRESEEK );
3414 assert( CURSOR_FAULT > CURSOR_REQUIRESEEK );
3415 if( pCur->eState>=CURSOR_REQUIRESEEK ){
3416 if( pCur->eState==CURSOR_FAULT ){
3417 return pCur->skip;
3418 }
drhbf700f32007-03-31 02:36:44 +00003419 clearCursorPosition(pCur);
3420 }
drh777e4c42006-01-13 04:31:58 +00003421 pRoot = pCur->pPage;
danielk197797a227c2006-01-20 16:32:04 +00003422 if( pRoot && pRoot->pgno==pCur->pgnoRoot ){
drh777e4c42006-01-13 04:31:58 +00003423 assert( pRoot->isInit );
3424 }else{
3425 if(
3426 SQLITE_OK!=(rc = getAndInitPage(pBt, pCur->pgnoRoot, &pRoot, 0))
3427 ){
3428 pCur->eState = CURSOR_INVALID;
3429 return rc;
3430 }
3431 releasePage(pCur->pPage);
drh777e4c42006-01-13 04:31:58 +00003432 pCur->pPage = pRoot;
drhc39e0002004-05-07 23:50:57 +00003433 }
drh72f82862001-05-24 21:06:34 +00003434 pCur->idx = 0;
drh271efa52004-05-30 19:19:05 +00003435 pCur->info.nSize = 0;
drh8856d6a2004-04-29 14:42:46 +00003436 if( pRoot->nCell==0 && !pRoot->leaf ){
3437 Pgno subpage;
3438 assert( pRoot->pgno==1 );
drh43605152004-05-29 21:46:49 +00003439 subpage = get4byte(&pRoot->aData[pRoot->hdrOffset+8]);
drh8856d6a2004-04-29 14:42:46 +00003440 assert( subpage>0 );
danielk1977da184232006-01-05 11:34:32 +00003441 pCur->eState = CURSOR_VALID;
drh4b70f112004-05-02 21:12:19 +00003442 rc = moveToChild(pCur, subpage);
drh8856d6a2004-04-29 14:42:46 +00003443 }
danielk1977da184232006-01-05 11:34:32 +00003444 pCur->eState = ((pCur->pPage->nCell>0)?CURSOR_VALID:CURSOR_INVALID);
drh8856d6a2004-04-29 14:42:46 +00003445 return rc;
drh72f82862001-05-24 21:06:34 +00003446}
drh2af926b2001-05-15 00:39:25 +00003447
drh5e2f8b92001-05-28 00:41:15 +00003448/*
3449** Move the cursor down to the left-most leaf entry beneath the
3450** entry to which it is currently pointing.
drh777e4c42006-01-13 04:31:58 +00003451**
3452** The left-most leaf is the one with the smallest key - the first
3453** in ascending order.
drh5e2f8b92001-05-28 00:41:15 +00003454*/
3455static int moveToLeftmost(BtCursor *pCur){
3456 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00003457 int rc = SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00003458 MemPage *pPage;
drh5e2f8b92001-05-28 00:41:15 +00003459
drh1fee73e2007-08-29 04:00:57 +00003460 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003461 assert( pCur->eState==CURSOR_VALID );
drhd677b3d2007-08-20 22:48:41 +00003462 while( rc==SQLITE_OK && !(pPage = pCur->pPage)->leaf ){
drha34b6762004-05-07 13:30:42 +00003463 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
danielk19771cc5ed82007-05-16 17:28:43 +00003464 pgno = get4byte(findCell(pPage, pCur->idx));
drh8178a752003-01-05 21:41:40 +00003465 rc = moveToChild(pCur, pgno);
drh5e2f8b92001-05-28 00:41:15 +00003466 }
drhd677b3d2007-08-20 22:48:41 +00003467 return rc;
drh5e2f8b92001-05-28 00:41:15 +00003468}
3469
drh2dcc9aa2002-12-04 13:40:25 +00003470/*
3471** Move the cursor down to the right-most leaf entry beneath the
3472** page to which it is currently pointing. Notice the difference
3473** between moveToLeftmost() and moveToRightmost(). moveToLeftmost()
3474** finds the left-most entry beneath the *entry* whereas moveToRightmost()
3475** finds the right-most entry beneath the *page*.
drh777e4c42006-01-13 04:31:58 +00003476**
3477** The right-most entry is the one with the largest key - the last
3478** key in ascending order.
drh2dcc9aa2002-12-04 13:40:25 +00003479*/
3480static int moveToRightmost(BtCursor *pCur){
3481 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00003482 int rc = SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00003483 MemPage *pPage;
drh2dcc9aa2002-12-04 13:40:25 +00003484
drh1fee73e2007-08-29 04:00:57 +00003485 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003486 assert( pCur->eState==CURSOR_VALID );
drhd677b3d2007-08-20 22:48:41 +00003487 while( rc==SQLITE_OK && !(pPage = pCur->pPage)->leaf ){
drh43605152004-05-29 21:46:49 +00003488 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh3aac2dd2004-04-26 14:10:20 +00003489 pCur->idx = pPage->nCell;
drh8178a752003-01-05 21:41:40 +00003490 rc = moveToChild(pCur, pgno);
drh2dcc9aa2002-12-04 13:40:25 +00003491 }
drhd677b3d2007-08-20 22:48:41 +00003492 if( rc==SQLITE_OK ){
3493 pCur->idx = pPage->nCell - 1;
3494 pCur->info.nSize = 0;
3495 }
drh2dcc9aa2002-12-04 13:40:25 +00003496 return SQLITE_OK;
3497}
3498
drh5e00f6c2001-09-13 13:46:56 +00003499/* Move the cursor to the first entry in the table. Return SQLITE_OK
3500** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00003501** or set *pRes to 1 if the table is empty.
drh5e00f6c2001-09-13 13:46:56 +00003502*/
drh3aac2dd2004-04-26 14:10:20 +00003503int sqlite3BtreeFirst(BtCursor *pCur, int *pRes){
drh5e00f6c2001-09-13 13:46:56 +00003504 int rc;
drhd677b3d2007-08-20 22:48:41 +00003505
drh1fee73e2007-08-29 04:00:57 +00003506 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00003507 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh5e00f6c2001-09-13 13:46:56 +00003508 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00003509 if( rc==SQLITE_OK ){
3510 if( pCur->eState==CURSOR_INVALID ){
3511 assert( pCur->pPage->nCell==0 );
3512 *pRes = 1;
3513 rc = SQLITE_OK;
3514 }else{
3515 assert( pCur->pPage->nCell>0 );
3516 *pRes = 0;
3517 rc = moveToLeftmost(pCur);
3518 }
drh5e00f6c2001-09-13 13:46:56 +00003519 }
drh5e00f6c2001-09-13 13:46:56 +00003520 return rc;
3521}
drh5e2f8b92001-05-28 00:41:15 +00003522
drh9562b552002-02-19 15:00:07 +00003523/* Move the cursor to the last entry in the table. Return SQLITE_OK
3524** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00003525** or set *pRes to 1 if the table is empty.
drh9562b552002-02-19 15:00:07 +00003526*/
drh3aac2dd2004-04-26 14:10:20 +00003527int sqlite3BtreeLast(BtCursor *pCur, int *pRes){
drh9562b552002-02-19 15:00:07 +00003528 int rc;
drhd677b3d2007-08-20 22:48:41 +00003529
drh1fee73e2007-08-29 04:00:57 +00003530 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00003531 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh9562b552002-02-19 15:00:07 +00003532 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00003533 if( rc==SQLITE_OK ){
3534 if( CURSOR_INVALID==pCur->eState ){
3535 assert( pCur->pPage->nCell==0 );
3536 *pRes = 1;
3537 }else{
3538 assert( pCur->eState==CURSOR_VALID );
3539 *pRes = 0;
3540 rc = moveToRightmost(pCur);
3541 }
drh9562b552002-02-19 15:00:07 +00003542 }
drh9562b552002-02-19 15:00:07 +00003543 return rc;
3544}
3545
drh3aac2dd2004-04-26 14:10:20 +00003546/* Move the cursor so that it points to an entry near pKey/nKey.
drh72f82862001-05-24 21:06:34 +00003547** Return a success code.
3548**
drh3aac2dd2004-04-26 14:10:20 +00003549** For INTKEY tables, only the nKey parameter is used. pKey is
3550** ignored. For other tables, nKey is the number of bytes of data
drh1e968a02008-03-25 00:22:21 +00003551** in pKey.
drh3aac2dd2004-04-26 14:10:20 +00003552**
drh5e2f8b92001-05-28 00:41:15 +00003553** If an exact match is not found, then the cursor is always
drhbd03cae2001-06-02 02:40:57 +00003554** left pointing at a leaf page which would hold the entry if it
drh5e2f8b92001-05-28 00:41:15 +00003555** were present. The cursor might point to an entry that comes
3556** before or after the key.
3557**
drhbd03cae2001-06-02 02:40:57 +00003558** The result of comparing the key with the entry to which the
drhab01f612004-05-22 02:55:23 +00003559** cursor is written to *pRes if pRes!=NULL. The meaning of
drhbd03cae2001-06-02 02:40:57 +00003560** this value is as follows:
3561**
3562** *pRes<0 The cursor is left pointing at an entry that
drh1a844c32002-12-04 22:29:28 +00003563** is smaller than pKey or if the table is empty
3564** and the cursor is therefore left point to nothing.
drhbd03cae2001-06-02 02:40:57 +00003565**
3566** *pRes==0 The cursor is left pointing at an entry that
3567** exactly matches pKey.
3568**
3569** *pRes>0 The cursor is left pointing at an entry that
drh7c717f72001-06-24 20:39:41 +00003570** is larger than pKey.
drhd677b3d2007-08-20 22:48:41 +00003571**
drha059ad02001-04-17 20:09:11 +00003572*/
drhe4d90812007-03-29 05:51:49 +00003573int sqlite3BtreeMoveto(
3574 BtCursor *pCur, /* The cursor to be moved */
3575 const void *pKey, /* The key content for indices. Not used by tables */
3576 i64 nKey, /* Size of pKey. Or the key for tables */
3577 int biasRight, /* If true, bias the search to the high end */
3578 int *pRes /* Search result flag */
3579){
drh72f82862001-05-24 21:06:34 +00003580 int rc;
drh1e968a02008-03-25 00:22:21 +00003581 VdbeParsedRecord *pPKey;
3582 char aSpace[200];
drhd677b3d2007-08-20 22:48:41 +00003583
drh1fee73e2007-08-29 04:00:57 +00003584 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00003585 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh5e2f8b92001-05-28 00:41:15 +00003586 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00003587 if( rc ){
3588 return rc;
3589 }
drhc39e0002004-05-07 23:50:57 +00003590 assert( pCur->pPage );
3591 assert( pCur->pPage->isInit );
danielk1977da184232006-01-05 11:34:32 +00003592 if( pCur->eState==CURSOR_INVALID ){
drhf328bc82004-05-10 23:29:49 +00003593 *pRes = -1;
drhc39e0002004-05-07 23:50:57 +00003594 assert( pCur->pPage->nCell==0 );
3595 return SQLITE_OK;
3596 }
drh1e968a02008-03-25 00:22:21 +00003597 if( pCur->pPage->intKey ){
3598 pPKey = 0;
3599 }else{
3600 pPKey = sqlite3VdbeRecordParse(pCur->pKeyInfo, nKey, pKey,
3601 aSpace, sizeof(aSpace));
3602 if( pPKey==0 ) return SQLITE_NOMEM;
3603 }
drh14684382006-11-30 13:05:29 +00003604 for(;;){
drh72f82862001-05-24 21:06:34 +00003605 int lwr, upr;
3606 Pgno chldPg;
3607 MemPage *pPage = pCur->pPage;
drh1a844c32002-12-04 22:29:28 +00003608 int c = -1; /* pRes return if table is empty must be -1 */
drh72f82862001-05-24 21:06:34 +00003609 lwr = 0;
3610 upr = pPage->nCell-1;
drh4eec4c12005-01-21 00:22:37 +00003611 if( !pPage->intKey && pKey==0 ){
drh1e968a02008-03-25 00:22:21 +00003612 rc = SQLITE_CORRUPT_BKPT;
3613 goto moveto_finish;
drh4eec4c12005-01-21 00:22:37 +00003614 }
drhe4d90812007-03-29 05:51:49 +00003615 if( biasRight ){
3616 pCur->idx = upr;
3617 }else{
3618 pCur->idx = (upr+lwr)/2;
3619 }
drhf1d68b32007-03-29 04:43:26 +00003620 if( lwr<=upr ) for(;;){
danielk197713adf8a2004-06-03 16:08:41 +00003621 void *pCellKey;
drh4a1c3802004-05-12 15:15:47 +00003622 i64 nCellKey;
drh366fda62006-01-13 02:35:09 +00003623 pCur->info.nSize = 0;
drh3aac2dd2004-04-26 14:10:20 +00003624 if( pPage->intKey ){
drh777e4c42006-01-13 04:31:58 +00003625 u8 *pCell;
danielk19771cc5ed82007-05-16 17:28:43 +00003626 pCell = findCell(pPage, pCur->idx) + pPage->childPtrSize;
drhd172f862006-01-12 15:01:15 +00003627 if( pPage->hasData ){
danielk1977bab45c62006-01-16 15:14:27 +00003628 u32 dummy;
drhd172f862006-01-12 15:01:15 +00003629 pCell += getVarint32(pCell, &dummy);
3630 }
danielk1977bab45c62006-01-16 15:14:27 +00003631 getVarint(pCell, (u64 *)&nCellKey);
drh3aac2dd2004-04-26 14:10:20 +00003632 if( nCellKey<nKey ){
3633 c = -1;
3634 }else if( nCellKey>nKey ){
3635 c = +1;
3636 }else{
3637 c = 0;
3638 }
drh3aac2dd2004-04-26 14:10:20 +00003639 }else{
drhe51c44f2004-05-30 20:46:09 +00003640 int available;
danielk197713adf8a2004-06-03 16:08:41 +00003641 pCellKey = (void *)fetchPayload(pCur, &available, 0);
drh366fda62006-01-13 02:35:09 +00003642 nCellKey = pCur->info.nKey;
drhe51c44f2004-05-30 20:46:09 +00003643 if( available>=nCellKey ){
drh1e968a02008-03-25 00:22:21 +00003644 c = sqlite3VdbeRecordCompareParsed(nCellKey, pCellKey, pPKey);
drhe51c44f2004-05-30 20:46:09 +00003645 }else{
drh17435752007-08-16 04:30:38 +00003646 pCellKey = sqlite3_malloc( nCellKey );
danielk19776507ecb2008-03-25 09:56:44 +00003647 if( pCellKey==0 ){
3648 rc = SQLITE_NOMEM;
3649 goto moveto_finish;
3650 }
danielk197713adf8a2004-06-03 16:08:41 +00003651 rc = sqlite3BtreeKey(pCur, 0, nCellKey, (void *)pCellKey);
drh1e968a02008-03-25 00:22:21 +00003652 c = sqlite3VdbeRecordCompareParsed(nCellKey, pCellKey, pPKey);
drh17435752007-08-16 04:30:38 +00003653 sqlite3_free(pCellKey);
drh1e968a02008-03-25 00:22:21 +00003654 if( rc ) goto moveto_finish;
drhe51c44f2004-05-30 20:46:09 +00003655 }
drh3aac2dd2004-04-26 14:10:20 +00003656 }
drh72f82862001-05-24 21:06:34 +00003657 if( c==0 ){
drh8b18dd42004-05-12 19:18:15 +00003658 if( pPage->leafData && !pPage->leaf ){
drhfc70e6f2004-05-12 21:11:27 +00003659 lwr = pCur->idx;
3660 upr = lwr - 1;
drh8b18dd42004-05-12 19:18:15 +00003661 break;
3662 }else{
drh8b18dd42004-05-12 19:18:15 +00003663 if( pRes ) *pRes = 0;
drh1e968a02008-03-25 00:22:21 +00003664 rc = SQLITE_OK;
3665 goto moveto_finish;
drh8b18dd42004-05-12 19:18:15 +00003666 }
drh72f82862001-05-24 21:06:34 +00003667 }
3668 if( c<0 ){
3669 lwr = pCur->idx+1;
3670 }else{
3671 upr = pCur->idx-1;
3672 }
drhf1d68b32007-03-29 04:43:26 +00003673 if( lwr>upr ){
3674 break;
3675 }
3676 pCur->idx = (lwr+upr)/2;
drh72f82862001-05-24 21:06:34 +00003677 }
3678 assert( lwr==upr+1 );
drh7aa128d2002-06-21 13:09:16 +00003679 assert( pPage->isInit );
drh3aac2dd2004-04-26 14:10:20 +00003680 if( pPage->leaf ){
drha34b6762004-05-07 13:30:42 +00003681 chldPg = 0;
drh3aac2dd2004-04-26 14:10:20 +00003682 }else if( lwr>=pPage->nCell ){
drh43605152004-05-29 21:46:49 +00003683 chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh72f82862001-05-24 21:06:34 +00003684 }else{
danielk19771cc5ed82007-05-16 17:28:43 +00003685 chldPg = get4byte(findCell(pPage, lwr));
drh72f82862001-05-24 21:06:34 +00003686 }
3687 if( chldPg==0 ){
drhc39e0002004-05-07 23:50:57 +00003688 assert( pCur->idx>=0 && pCur->idx<pCur->pPage->nCell );
drh72f82862001-05-24 21:06:34 +00003689 if( pRes ) *pRes = c;
drh1e968a02008-03-25 00:22:21 +00003690 rc = SQLITE_OK;
3691 goto moveto_finish;
drh72f82862001-05-24 21:06:34 +00003692 }
drh428ae8c2003-01-04 16:48:09 +00003693 pCur->idx = lwr;
drh271efa52004-05-30 19:19:05 +00003694 pCur->info.nSize = 0;
drh8178a752003-01-05 21:41:40 +00003695 rc = moveToChild(pCur, chldPg);
drh1e968a02008-03-25 00:22:21 +00003696 if( rc ) goto moveto_finish;
drh72f82862001-05-24 21:06:34 +00003697 }
drh1e968a02008-03-25 00:22:21 +00003698moveto_finish:
3699 sqlite3VdbeRecordUnparse(pPKey);
3700 return rc;
drh72f82862001-05-24 21:06:34 +00003701}
3702
drhd677b3d2007-08-20 22:48:41 +00003703
drh72f82862001-05-24 21:06:34 +00003704/*
drhc39e0002004-05-07 23:50:57 +00003705** Return TRUE if the cursor is not pointing at an entry of the table.
3706**
3707** TRUE will be returned after a call to sqlite3BtreeNext() moves
3708** past the last entry in the table or sqlite3BtreePrev() moves past
3709** the first entry. TRUE is also returned if the table is empty.
3710*/
3711int sqlite3BtreeEof(BtCursor *pCur){
danielk1977da184232006-01-05 11:34:32 +00003712 /* TODO: What if the cursor is in CURSOR_REQUIRESEEK but all table entries
3713 ** have been deleted? This API will need to change to return an error code
3714 ** as well as the boolean result value.
3715 */
3716 return (CURSOR_VALID!=pCur->eState);
drhc39e0002004-05-07 23:50:57 +00003717}
3718
3719/*
drhb21c8cd2007-08-21 19:33:56 +00003720** Return the database connection handle for a cursor.
3721*/
3722sqlite3 *sqlite3BtreeCursorDb(const BtCursor *pCur){
drhe5fe6902007-12-07 18:55:28 +00003723 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
3724 return pCur->pBtree->db;
drhb21c8cd2007-08-21 19:33:56 +00003725}
3726
3727/*
drhbd03cae2001-06-02 02:40:57 +00003728** Advance the cursor to the next entry in the database. If
drh8c1238a2003-01-02 14:43:55 +00003729** successful then set *pRes=0. If the cursor
drhbd03cae2001-06-02 02:40:57 +00003730** was already pointing to the last entry in the database before
drh8c1238a2003-01-02 14:43:55 +00003731** this routine was called, then set *pRes=1.
drh72f82862001-05-24 21:06:34 +00003732*/
drhd677b3d2007-08-20 22:48:41 +00003733static int btreeNext(BtCursor *pCur, int *pRes){
drh72f82862001-05-24 21:06:34 +00003734 int rc;
danielk197797a227c2006-01-20 16:32:04 +00003735 MemPage *pPage;
drh8b18dd42004-05-12 19:18:15 +00003736
drh1fee73e2007-08-29 04:00:57 +00003737 assert( cursorHoldsMutex(pCur) );
drhbf700f32007-03-31 02:36:44 +00003738 rc = restoreOrClearCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003739 if( rc!=SQLITE_OK ){
3740 return rc;
3741 }
drh8c4d3a62007-04-06 01:03:32 +00003742 assert( pRes!=0 );
3743 pPage = pCur->pPage;
3744 if( CURSOR_INVALID==pCur->eState ){
3745 *pRes = 1;
3746 return SQLITE_OK;
3747 }
danielk1977da184232006-01-05 11:34:32 +00003748 if( pCur->skip>0 ){
3749 pCur->skip = 0;
3750 *pRes = 0;
3751 return SQLITE_OK;
3752 }
3753 pCur->skip = 0;
danielk1977da184232006-01-05 11:34:32 +00003754
drh8178a752003-01-05 21:41:40 +00003755 assert( pPage->isInit );
drh8178a752003-01-05 21:41:40 +00003756 assert( pCur->idx<pPage->nCell );
danielk19776a43f9b2004-11-16 04:57:24 +00003757
drh72f82862001-05-24 21:06:34 +00003758 pCur->idx++;
drh271efa52004-05-30 19:19:05 +00003759 pCur->info.nSize = 0;
drh8178a752003-01-05 21:41:40 +00003760 if( pCur->idx>=pPage->nCell ){
drha34b6762004-05-07 13:30:42 +00003761 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00003762 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
drh5e2f8b92001-05-28 00:41:15 +00003763 if( rc ) return rc;
3764 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00003765 *pRes = 0;
3766 return rc;
drh72f82862001-05-24 21:06:34 +00003767 }
drh5e2f8b92001-05-28 00:41:15 +00003768 do{
drh16a9b832007-05-05 18:39:25 +00003769 if( sqlite3BtreeIsRootPage(pPage) ){
drh8c1238a2003-01-02 14:43:55 +00003770 *pRes = 1;
danielk1977da184232006-01-05 11:34:32 +00003771 pCur->eState = CURSOR_INVALID;
drh5e2f8b92001-05-28 00:41:15 +00003772 return SQLITE_OK;
3773 }
drh16a9b832007-05-05 18:39:25 +00003774 sqlite3BtreeMoveToParent(pCur);
drh8178a752003-01-05 21:41:40 +00003775 pPage = pCur->pPage;
3776 }while( pCur->idx>=pPage->nCell );
drh8c1238a2003-01-02 14:43:55 +00003777 *pRes = 0;
drh8b18dd42004-05-12 19:18:15 +00003778 if( pPage->leafData ){
3779 rc = sqlite3BtreeNext(pCur, pRes);
3780 }else{
3781 rc = SQLITE_OK;
3782 }
3783 return rc;
drh8178a752003-01-05 21:41:40 +00003784 }
3785 *pRes = 0;
drh3aac2dd2004-04-26 14:10:20 +00003786 if( pPage->leaf ){
drh8178a752003-01-05 21:41:40 +00003787 return SQLITE_OK;
drh72f82862001-05-24 21:06:34 +00003788 }
drh5e2f8b92001-05-28 00:41:15 +00003789 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00003790 return rc;
drh72f82862001-05-24 21:06:34 +00003791}
drhd677b3d2007-08-20 22:48:41 +00003792int sqlite3BtreeNext(BtCursor *pCur, int *pRes){
3793 int rc;
drh1fee73e2007-08-29 04:00:57 +00003794 assert( cursorHoldsMutex(pCur) );
drhd677b3d2007-08-20 22:48:41 +00003795 rc = btreeNext(pCur, pRes);
drhd677b3d2007-08-20 22:48:41 +00003796 return rc;
3797}
3798
drh72f82862001-05-24 21:06:34 +00003799
drh3b7511c2001-05-26 13:15:44 +00003800/*
drh2dcc9aa2002-12-04 13:40:25 +00003801** Step the cursor to the back to the previous entry in the database. If
drh8178a752003-01-05 21:41:40 +00003802** successful then set *pRes=0. If the cursor
drh2dcc9aa2002-12-04 13:40:25 +00003803** was already pointing to the first entry in the database before
drh8178a752003-01-05 21:41:40 +00003804** this routine was called, then set *pRes=1.
drh2dcc9aa2002-12-04 13:40:25 +00003805*/
drhd677b3d2007-08-20 22:48:41 +00003806static int btreePrevious(BtCursor *pCur, int *pRes){
drh2dcc9aa2002-12-04 13:40:25 +00003807 int rc;
3808 Pgno pgno;
drh8178a752003-01-05 21:41:40 +00003809 MemPage *pPage;
danielk1977da184232006-01-05 11:34:32 +00003810
drh1fee73e2007-08-29 04:00:57 +00003811 assert( cursorHoldsMutex(pCur) );
drhbf700f32007-03-31 02:36:44 +00003812 rc = restoreOrClearCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003813 if( rc!=SQLITE_OK ){
3814 return rc;
3815 }
drh8c4d3a62007-04-06 01:03:32 +00003816 if( CURSOR_INVALID==pCur->eState ){
3817 *pRes = 1;
3818 return SQLITE_OK;
3819 }
danielk1977da184232006-01-05 11:34:32 +00003820 if( pCur->skip<0 ){
3821 pCur->skip = 0;
3822 *pRes = 0;
3823 return SQLITE_OK;
3824 }
3825 pCur->skip = 0;
danielk1977da184232006-01-05 11:34:32 +00003826
drh8178a752003-01-05 21:41:40 +00003827 pPage = pCur->pPage;
drh8178a752003-01-05 21:41:40 +00003828 assert( pPage->isInit );
drh2dcc9aa2002-12-04 13:40:25 +00003829 assert( pCur->idx>=0 );
drha34b6762004-05-07 13:30:42 +00003830 if( !pPage->leaf ){
danielk19771cc5ed82007-05-16 17:28:43 +00003831 pgno = get4byte( findCell(pPage, pCur->idx) );
drh8178a752003-01-05 21:41:40 +00003832 rc = moveToChild(pCur, pgno);
drhd677b3d2007-08-20 22:48:41 +00003833 if( rc ){
3834 return rc;
3835 }
drh2dcc9aa2002-12-04 13:40:25 +00003836 rc = moveToRightmost(pCur);
3837 }else{
3838 while( pCur->idx==0 ){
drh16a9b832007-05-05 18:39:25 +00003839 if( sqlite3BtreeIsRootPage(pPage) ){
danielk1977da184232006-01-05 11:34:32 +00003840 pCur->eState = CURSOR_INVALID;
drhc39e0002004-05-07 23:50:57 +00003841 *pRes = 1;
drh2dcc9aa2002-12-04 13:40:25 +00003842 return SQLITE_OK;
3843 }
drh16a9b832007-05-05 18:39:25 +00003844 sqlite3BtreeMoveToParent(pCur);
drh8178a752003-01-05 21:41:40 +00003845 pPage = pCur->pPage;
drh2dcc9aa2002-12-04 13:40:25 +00003846 }
3847 pCur->idx--;
drh271efa52004-05-30 19:19:05 +00003848 pCur->info.nSize = 0;
drh8237d452004-11-22 19:07:09 +00003849 if( pPage->leafData && !pPage->leaf ){
drh8b18dd42004-05-12 19:18:15 +00003850 rc = sqlite3BtreePrevious(pCur, pRes);
3851 }else{
3852 rc = SQLITE_OK;
3853 }
drh2dcc9aa2002-12-04 13:40:25 +00003854 }
drh8178a752003-01-05 21:41:40 +00003855 *pRes = 0;
drh2dcc9aa2002-12-04 13:40:25 +00003856 return rc;
3857}
drhd677b3d2007-08-20 22:48:41 +00003858int sqlite3BtreePrevious(BtCursor *pCur, int *pRes){
3859 int rc;
drh1fee73e2007-08-29 04:00:57 +00003860 assert( cursorHoldsMutex(pCur) );
drhd677b3d2007-08-20 22:48:41 +00003861 rc = btreePrevious(pCur, pRes);
drhd677b3d2007-08-20 22:48:41 +00003862 return rc;
3863}
drh2dcc9aa2002-12-04 13:40:25 +00003864
3865/*
drh3b7511c2001-05-26 13:15:44 +00003866** Allocate a new page from the database file.
3867**
danielk19773b8a05f2007-03-19 17:44:26 +00003868** The new page is marked as dirty. (In other words, sqlite3PagerWrite()
drh3b7511c2001-05-26 13:15:44 +00003869** has already been called on the new page.) The new page has also
3870** been referenced and the calling routine is responsible for calling
danielk19773b8a05f2007-03-19 17:44:26 +00003871** sqlite3PagerUnref() on the new page when it is done.
drh3b7511c2001-05-26 13:15:44 +00003872**
3873** SQLITE_OK is returned on success. Any other return value indicates
3874** an error. *ppPage and *pPgno are undefined in the event of an error.
danielk19773b8a05f2007-03-19 17:44:26 +00003875** Do not invoke sqlite3PagerUnref() on *ppPage if an error is returned.
drhbea00b92002-07-08 10:59:50 +00003876**
drh199e3cf2002-07-18 11:01:47 +00003877** If the "nearby" parameter is not 0, then a (feeble) effort is made to
3878** locate a page close to the page number "nearby". This can be used in an
drhbea00b92002-07-08 10:59:50 +00003879** attempt to keep related pages close to each other in the database file,
3880** which in turn can make database access faster.
danielk1977cb1a7eb2004-11-05 12:27:02 +00003881**
3882** If the "exact" parameter is not 0, and the page-number nearby exists
3883** anywhere on the free-list, then it is guarenteed to be returned. This
3884** is only used by auto-vacuum databases when allocating a new table.
drh3b7511c2001-05-26 13:15:44 +00003885*/
drh4f0c5872007-03-26 22:05:01 +00003886static int allocateBtreePage(
danielk1977aef0bf62005-12-30 16:28:01 +00003887 BtShared *pBt,
danielk1977cb1a7eb2004-11-05 12:27:02 +00003888 MemPage **ppPage,
3889 Pgno *pPgno,
3890 Pgno nearby,
3891 u8 exact
3892){
drh3aac2dd2004-04-26 14:10:20 +00003893 MemPage *pPage1;
drh8c42ca92001-06-22 19:15:00 +00003894 int rc;
drh3aac2dd2004-04-26 14:10:20 +00003895 int n; /* Number of pages on the freelist */
3896 int k; /* Number of leaves on the trunk of the freelist */
drhd3627af2006-12-18 18:34:51 +00003897 MemPage *pTrunk = 0;
3898 MemPage *pPrevTrunk = 0;
drh30e58752002-03-02 20:41:57 +00003899
drh1fee73e2007-08-29 04:00:57 +00003900 assert( sqlite3_mutex_held(pBt->mutex) );
drh3aac2dd2004-04-26 14:10:20 +00003901 pPage1 = pBt->pPage1;
3902 n = get4byte(&pPage1->aData[36]);
3903 if( n>0 ){
drh91025292004-05-03 19:49:32 +00003904 /* There are pages on the freelist. Reuse one of those pages. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00003905 Pgno iTrunk;
danielk1977cb1a7eb2004-11-05 12:27:02 +00003906 u8 searchList = 0; /* If the free-list must be searched for 'nearby' */
3907
3908 /* If the 'exact' parameter was true and a query of the pointer-map
3909 ** shows that the page 'nearby' is somewhere on the free-list, then
3910 ** the entire-list will be searched for that page.
3911 */
3912#ifndef SQLITE_OMIT_AUTOVACUUM
danielk19774ef24492007-05-23 09:52:41 +00003913 if( exact && nearby<=sqlite3PagerPagecount(pBt->pPager) ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00003914 u8 eType;
3915 assert( nearby>0 );
3916 assert( pBt->autoVacuum );
3917 rc = ptrmapGet(pBt, nearby, &eType, 0);
3918 if( rc ) return rc;
3919 if( eType==PTRMAP_FREEPAGE ){
3920 searchList = 1;
3921 }
3922 *pPgno = nearby;
3923 }
3924#endif
3925
3926 /* Decrement the free-list count by 1. Set iTrunk to the index of the
3927 ** first free-list trunk page. iPrevTrunk is initially 1.
3928 */
danielk19773b8a05f2007-03-19 17:44:26 +00003929 rc = sqlite3PagerWrite(pPage1->pDbPage);
drh3b7511c2001-05-26 13:15:44 +00003930 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00003931 put4byte(&pPage1->aData[36], n-1);
danielk1977cb1a7eb2004-11-05 12:27:02 +00003932
3933 /* The code within this loop is run only once if the 'searchList' variable
3934 ** is not true. Otherwise, it runs once for each trunk-page on the
3935 ** free-list until the page 'nearby' is located.
3936 */
3937 do {
3938 pPrevTrunk = pTrunk;
3939 if( pPrevTrunk ){
3940 iTrunk = get4byte(&pPrevTrunk->aData[0]);
drhbea00b92002-07-08 10:59:50 +00003941 }else{
danielk1977cb1a7eb2004-11-05 12:27:02 +00003942 iTrunk = get4byte(&pPage1->aData[32]);
drhbea00b92002-07-08 10:59:50 +00003943 }
drh16a9b832007-05-05 18:39:25 +00003944 rc = sqlite3BtreeGetPage(pBt, iTrunk, &pTrunk, 0);
danielk1977cb1a7eb2004-11-05 12:27:02 +00003945 if( rc ){
drhd3627af2006-12-18 18:34:51 +00003946 pTrunk = 0;
3947 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00003948 }
3949
3950 k = get4byte(&pTrunk->aData[4]);
3951 if( k==0 && !searchList ){
3952 /* The trunk has no leaves and the list is not being searched.
3953 ** So extract the trunk page itself and use it as the newly
3954 ** allocated page */
3955 assert( pPrevTrunk==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003956 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00003957 if( rc ){
3958 goto end_allocate_page;
3959 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00003960 *pPgno = iTrunk;
3961 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
3962 *ppPage = pTrunk;
3963 pTrunk = 0;
3964 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
3965 }else if( k>pBt->usableSize/4 - 8 ){
3966 /* Value of k is out of range. Database corruption */
drhd3627af2006-12-18 18:34:51 +00003967 rc = SQLITE_CORRUPT_BKPT;
3968 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00003969#ifndef SQLITE_OMIT_AUTOVACUUM
3970 }else if( searchList && nearby==iTrunk ){
3971 /* The list is being searched and this trunk page is the page
3972 ** to allocate, regardless of whether it has leaves.
3973 */
3974 assert( *pPgno==iTrunk );
3975 *ppPage = pTrunk;
3976 searchList = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003977 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00003978 if( rc ){
3979 goto end_allocate_page;
3980 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00003981 if( k==0 ){
3982 if( !pPrevTrunk ){
3983 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
3984 }else{
3985 memcpy(&pPrevTrunk->aData[0], &pTrunk->aData[0], 4);
3986 }
3987 }else{
3988 /* The trunk page is required by the caller but it contains
3989 ** pointers to free-list leaves. The first leaf becomes a trunk
3990 ** page in this case.
3991 */
3992 MemPage *pNewTrunk;
3993 Pgno iNewTrunk = get4byte(&pTrunk->aData[8]);
drh16a9b832007-05-05 18:39:25 +00003994 rc = sqlite3BtreeGetPage(pBt, iNewTrunk, &pNewTrunk, 0);
danielk1977cb1a7eb2004-11-05 12:27:02 +00003995 if( rc!=SQLITE_OK ){
drhd3627af2006-12-18 18:34:51 +00003996 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00003997 }
danielk19773b8a05f2007-03-19 17:44:26 +00003998 rc = sqlite3PagerWrite(pNewTrunk->pDbPage);
danielk1977cb1a7eb2004-11-05 12:27:02 +00003999 if( rc!=SQLITE_OK ){
4000 releasePage(pNewTrunk);
drhd3627af2006-12-18 18:34:51 +00004001 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004002 }
4003 memcpy(&pNewTrunk->aData[0], &pTrunk->aData[0], 4);
4004 put4byte(&pNewTrunk->aData[4], k-1);
4005 memcpy(&pNewTrunk->aData[8], &pTrunk->aData[12], (k-1)*4);
drhd3627af2006-12-18 18:34:51 +00004006 releasePage(pNewTrunk);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004007 if( !pPrevTrunk ){
4008 put4byte(&pPage1->aData[32], iNewTrunk);
4009 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004010 rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004011 if( rc ){
4012 goto end_allocate_page;
4013 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004014 put4byte(&pPrevTrunk->aData[0], iNewTrunk);
4015 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004016 }
4017 pTrunk = 0;
4018 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
4019#endif
4020 }else{
4021 /* Extract a leaf from the trunk */
4022 int closest;
4023 Pgno iPage;
4024 unsigned char *aData = pTrunk->aData;
danielk19773b8a05f2007-03-19 17:44:26 +00004025 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004026 if( rc ){
4027 goto end_allocate_page;
4028 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004029 if( nearby>0 ){
4030 int i, dist;
4031 closest = 0;
4032 dist = get4byte(&aData[8]) - nearby;
4033 if( dist<0 ) dist = -dist;
4034 for(i=1; i<k; i++){
4035 int d2 = get4byte(&aData[8+i*4]) - nearby;
4036 if( d2<0 ) d2 = -d2;
4037 if( d2<dist ){
4038 closest = i;
4039 dist = d2;
4040 }
4041 }
4042 }else{
4043 closest = 0;
4044 }
4045
4046 iPage = get4byte(&aData[8+closest*4]);
4047 if( !searchList || iPage==nearby ){
4048 *pPgno = iPage;
danielk19773b8a05f2007-03-19 17:44:26 +00004049 if( *pPgno>sqlite3PagerPagecount(pBt->pPager) ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004050 /* Free page off the end of the file */
drh49285702005-09-17 15:20:26 +00004051 return SQLITE_CORRUPT_BKPT;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004052 }
4053 TRACE(("ALLOCATE: %d was leaf %d of %d on trunk %d"
4054 ": %d more free pages\n",
4055 *pPgno, closest+1, k, pTrunk->pgno, n-1));
4056 if( closest<k-1 ){
4057 memcpy(&aData[8+closest*4], &aData[4+k*4], 4);
4058 }
4059 put4byte(&aData[4], k-1);
drh16a9b832007-05-05 18:39:25 +00004060 rc = sqlite3BtreeGetPage(pBt, *pPgno, ppPage, 1);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004061 if( rc==SQLITE_OK ){
drh538f5702007-04-13 02:14:30 +00004062 sqlite3PagerDontRollback((*ppPage)->pDbPage);
danielk19773b8a05f2007-03-19 17:44:26 +00004063 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00004064 if( rc!=SQLITE_OK ){
4065 releasePage(*ppPage);
4066 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004067 }
4068 searchList = 0;
4069 }
drhee696e22004-08-30 16:52:17 +00004070 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004071 releasePage(pPrevTrunk);
drhd3627af2006-12-18 18:34:51 +00004072 pPrevTrunk = 0;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004073 }while( searchList );
drh3b7511c2001-05-26 13:15:44 +00004074 }else{
drh3aac2dd2004-04-26 14:10:20 +00004075 /* There are no pages on the freelist, so create a new page at the
4076 ** end of the file */
danielk19773b8a05f2007-03-19 17:44:26 +00004077 *pPgno = sqlite3PagerPagecount(pBt->pPager) + 1;
danielk1977afcdd022004-10-31 16:25:42 +00004078
4079#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00004080 if( pBt->nTrunc ){
4081 /* An incr-vacuum has already run within this transaction. So the
4082 ** page to allocate is not from the physical end of the file, but
4083 ** at pBt->nTrunc.
4084 */
4085 *pPgno = pBt->nTrunc+1;
4086 if( *pPgno==PENDING_BYTE_PAGE(pBt) ){
4087 (*pPgno)++;
4088 }
4089 }
danielk1977266664d2006-02-10 08:24:21 +00004090 if( pBt->autoVacuum && PTRMAP_ISPAGE(pBt, *pPgno) ){
danielk1977afcdd022004-10-31 16:25:42 +00004091 /* If *pPgno refers to a pointer-map page, allocate two new pages
4092 ** at the end of the file instead of one. The first allocated page
4093 ** becomes a new pointer-map page, the second is used by the caller.
4094 */
4095 TRACE(("ALLOCATE: %d from end of file (pointer-map page)\n", *pPgno));
danielk1977599fcba2004-11-08 07:13:13 +00004096 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
danielk1977afcdd022004-10-31 16:25:42 +00004097 (*pPgno)++;
drh72190432008-01-31 14:54:43 +00004098 if( *pPgno==PENDING_BYTE_PAGE(pBt) ){ (*pPgno)++; }
danielk1977afcdd022004-10-31 16:25:42 +00004099 }
danielk1977dddbcdc2007-04-26 14:42:34 +00004100 if( pBt->nTrunc ){
4101 pBt->nTrunc = *pPgno;
4102 }
danielk1977afcdd022004-10-31 16:25:42 +00004103#endif
4104
danielk1977599fcba2004-11-08 07:13:13 +00004105 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drh16a9b832007-05-05 18:39:25 +00004106 rc = sqlite3BtreeGetPage(pBt, *pPgno, ppPage, 0);
drh3b7511c2001-05-26 13:15:44 +00004107 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004108 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00004109 if( rc!=SQLITE_OK ){
4110 releasePage(*ppPage);
4111 }
drh3a4c1412004-05-09 20:40:11 +00004112 TRACE(("ALLOCATE: %d from end of file\n", *pPgno));
drh3b7511c2001-05-26 13:15:44 +00004113 }
danielk1977599fcba2004-11-08 07:13:13 +00004114
4115 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drhd3627af2006-12-18 18:34:51 +00004116
4117end_allocate_page:
4118 releasePage(pTrunk);
4119 releasePage(pPrevTrunk);
drh3b7511c2001-05-26 13:15:44 +00004120 return rc;
4121}
4122
4123/*
drh3aac2dd2004-04-26 14:10:20 +00004124** Add a page of the database file to the freelist.
drh5e2f8b92001-05-28 00:41:15 +00004125**
danielk19773b8a05f2007-03-19 17:44:26 +00004126** sqlite3PagerUnref() is NOT called for pPage.
drh3b7511c2001-05-26 13:15:44 +00004127*/
drh3aac2dd2004-04-26 14:10:20 +00004128static int freePage(MemPage *pPage){
danielk1977aef0bf62005-12-30 16:28:01 +00004129 BtShared *pBt = pPage->pBt;
drh3aac2dd2004-04-26 14:10:20 +00004130 MemPage *pPage1 = pBt->pPage1;
4131 int rc, n, k;
drh8b2f49b2001-06-08 00:21:52 +00004132
drh3aac2dd2004-04-26 14:10:20 +00004133 /* Prepare the page for freeing */
drh1fee73e2007-08-29 04:00:57 +00004134 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh3aac2dd2004-04-26 14:10:20 +00004135 assert( pPage->pgno>1 );
4136 pPage->isInit = 0;
4137 releasePage(pPage->pParent);
4138 pPage->pParent = 0;
4139
drha34b6762004-05-07 13:30:42 +00004140 /* Increment the free page count on pPage1 */
danielk19773b8a05f2007-03-19 17:44:26 +00004141 rc = sqlite3PagerWrite(pPage1->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00004142 if( rc ) return rc;
4143 n = get4byte(&pPage1->aData[36]);
4144 put4byte(&pPage1->aData[36], n+1);
4145
drhfcce93f2006-02-22 03:08:32 +00004146#ifdef SQLITE_SECURE_DELETE
4147 /* If the SQLITE_SECURE_DELETE compile-time option is enabled, then
4148 ** always fully overwrite deleted information with zeros.
4149 */
danielk19773b8a05f2007-03-19 17:44:26 +00004150 rc = sqlite3PagerWrite(pPage->pDbPage);
drhfcce93f2006-02-22 03:08:32 +00004151 if( rc ) return rc;
4152 memset(pPage->aData, 0, pPage->pBt->pageSize);
4153#endif
4154
danielk1977687566d2004-11-02 12:56:41 +00004155#ifndef SQLITE_OMIT_AUTOVACUUM
4156 /* If the database supports auto-vacuum, write an entry in the pointer-map
danielk1977cb1a7eb2004-11-05 12:27:02 +00004157 ** to indicate that the page is free.
danielk1977687566d2004-11-02 12:56:41 +00004158 */
4159 if( pBt->autoVacuum ){
4160 rc = ptrmapPut(pBt, pPage->pgno, PTRMAP_FREEPAGE, 0);
danielk1977a64a0352004-11-05 01:45:13 +00004161 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00004162 }
4163#endif
4164
drh3aac2dd2004-04-26 14:10:20 +00004165 if( n==0 ){
4166 /* This is the first free page */
danielk19773b8a05f2007-03-19 17:44:26 +00004167 rc = sqlite3PagerWrite(pPage->pDbPage);
drhda200cc2004-05-09 11:51:38 +00004168 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00004169 memset(pPage->aData, 0, 8);
drha34b6762004-05-07 13:30:42 +00004170 put4byte(&pPage1->aData[32], pPage->pgno);
drh3a4c1412004-05-09 20:40:11 +00004171 TRACE(("FREE-PAGE: %d first\n", pPage->pgno));
drh3aac2dd2004-04-26 14:10:20 +00004172 }else{
4173 /* Other free pages already exist. Retrive the first trunk page
4174 ** of the freelist and find out how many leaves it has. */
drha34b6762004-05-07 13:30:42 +00004175 MemPage *pTrunk;
drh16a9b832007-05-05 18:39:25 +00004176 rc = sqlite3BtreeGetPage(pBt, get4byte(&pPage1->aData[32]), &pTrunk, 0);
drh3b7511c2001-05-26 13:15:44 +00004177 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00004178 k = get4byte(&pTrunk->aData[4]);
drhee696e22004-08-30 16:52:17 +00004179 if( k>=pBt->usableSize/4 - 8 ){
drh3aac2dd2004-04-26 14:10:20 +00004180 /* The trunk is full. Turn the page being freed into a new
4181 ** trunk page with no leaves. */
danielk19773b8a05f2007-03-19 17:44:26 +00004182 rc = sqlite3PagerWrite(pPage->pDbPage);
drhb9ee4932007-09-07 14:32:06 +00004183 if( rc==SQLITE_OK ){
4184 put4byte(pPage->aData, pTrunk->pgno);
4185 put4byte(&pPage->aData[4], 0);
4186 put4byte(&pPage1->aData[32], pPage->pgno);
4187 TRACE(("FREE-PAGE: %d new trunk page replacing %d\n",
4188 pPage->pgno, pTrunk->pgno));
4189 }
4190 }else if( k<0 ){
4191 rc = SQLITE_CORRUPT;
drh3aac2dd2004-04-26 14:10:20 +00004192 }else{
4193 /* Add the newly freed page as a leaf on the current trunk */
danielk19773b8a05f2007-03-19 17:44:26 +00004194 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhf5345442007-04-09 12:45:02 +00004195 if( rc==SQLITE_OK ){
4196 put4byte(&pTrunk->aData[4], k+1);
4197 put4byte(&pTrunk->aData[8+k*4], pPage->pgno);
drhfcce93f2006-02-22 03:08:32 +00004198#ifndef SQLITE_SECURE_DELETE
drh538f5702007-04-13 02:14:30 +00004199 sqlite3PagerDontWrite(pPage->pDbPage);
drhfcce93f2006-02-22 03:08:32 +00004200#endif
drhf5345442007-04-09 12:45:02 +00004201 }
drh3a4c1412004-05-09 20:40:11 +00004202 TRACE(("FREE-PAGE: %d leaf on trunk page %d\n",pPage->pgno,pTrunk->pgno));
drh3aac2dd2004-04-26 14:10:20 +00004203 }
4204 releasePage(pTrunk);
drh3b7511c2001-05-26 13:15:44 +00004205 }
drh3b7511c2001-05-26 13:15:44 +00004206 return rc;
4207}
4208
4209/*
drh3aac2dd2004-04-26 14:10:20 +00004210** Free any overflow pages associated with the given Cell.
drh3b7511c2001-05-26 13:15:44 +00004211*/
drh3aac2dd2004-04-26 14:10:20 +00004212static int clearCell(MemPage *pPage, unsigned char *pCell){
danielk1977aef0bf62005-12-30 16:28:01 +00004213 BtShared *pBt = pPage->pBt;
drh6f11bef2004-05-13 01:12:56 +00004214 CellInfo info;
drh3aac2dd2004-04-26 14:10:20 +00004215 Pgno ovflPgno;
drh6f11bef2004-05-13 01:12:56 +00004216 int rc;
drh94440812007-03-06 11:42:19 +00004217 int nOvfl;
4218 int ovflPageSize;
drh3b7511c2001-05-26 13:15:44 +00004219
drh1fee73e2007-08-29 04:00:57 +00004220 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh16a9b832007-05-05 18:39:25 +00004221 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00004222 if( info.iOverflow==0 ){
drha34b6762004-05-07 13:30:42 +00004223 return SQLITE_OK; /* No overflow pages. Return without doing anything */
drh3aac2dd2004-04-26 14:10:20 +00004224 }
drh6f11bef2004-05-13 01:12:56 +00004225 ovflPgno = get4byte(&pCell[info.iOverflow]);
drh94440812007-03-06 11:42:19 +00004226 ovflPageSize = pBt->usableSize - 4;
drh72365832007-03-06 15:53:44 +00004227 nOvfl = (info.nPayload - info.nLocal + ovflPageSize - 1)/ovflPageSize;
4228 assert( ovflPgno==0 || nOvfl>0 );
4229 while( nOvfl-- ){
drh3aac2dd2004-04-26 14:10:20 +00004230 MemPage *pOvfl;
danielk19773b8a05f2007-03-19 17:44:26 +00004231 if( ovflPgno==0 || ovflPgno>sqlite3PagerPagecount(pBt->pPager) ){
drh49285702005-09-17 15:20:26 +00004232 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00004233 }
danielk19778c0a9592007-04-30 16:55:00 +00004234
4235 rc = getOverflowPage(pBt, ovflPgno, &pOvfl, (nOvfl==0)?0:&ovflPgno);
drh3b7511c2001-05-26 13:15:44 +00004236 if( rc ) return rc;
drha34b6762004-05-07 13:30:42 +00004237 rc = freePage(pOvfl);
danielk19773b8a05f2007-03-19 17:44:26 +00004238 sqlite3PagerUnref(pOvfl->pDbPage);
danielk19776b456a22005-03-21 04:04:02 +00004239 if( rc ) return rc;
drh3b7511c2001-05-26 13:15:44 +00004240 }
drh5e2f8b92001-05-28 00:41:15 +00004241 return SQLITE_OK;
drh3b7511c2001-05-26 13:15:44 +00004242}
4243
4244/*
drh91025292004-05-03 19:49:32 +00004245** Create the byte sequence used to represent a cell on page pPage
4246** and write that byte sequence into pCell[]. Overflow pages are
4247** allocated and filled in as necessary. The calling procedure
4248** is responsible for making sure sufficient space has been allocated
4249** for pCell[].
4250**
4251** Note that pCell does not necessary need to point to the pPage->aData
4252** area. pCell might point to some temporary storage. The cell will
4253** be constructed in this temporary area then copied into pPage->aData
4254** later.
drh3b7511c2001-05-26 13:15:44 +00004255*/
4256static int fillInCell(
drh3aac2dd2004-04-26 14:10:20 +00004257 MemPage *pPage, /* The page that contains the cell */
drh4b70f112004-05-02 21:12:19 +00004258 unsigned char *pCell, /* Complete text of the cell */
drh4a1c3802004-05-12 15:15:47 +00004259 const void *pKey, i64 nKey, /* The key */
drh4b70f112004-05-02 21:12:19 +00004260 const void *pData,int nData, /* The data */
drhb026e052007-05-02 01:34:31 +00004261 int nZero, /* Extra zero bytes to append to pData */
drh4b70f112004-05-02 21:12:19 +00004262 int *pnSize /* Write cell size here */
drh3b7511c2001-05-26 13:15:44 +00004263){
drh3b7511c2001-05-26 13:15:44 +00004264 int nPayload;
drh8c6fa9b2004-05-26 00:01:53 +00004265 const u8 *pSrc;
drha34b6762004-05-07 13:30:42 +00004266 int nSrc, n, rc;
drh3aac2dd2004-04-26 14:10:20 +00004267 int spaceLeft;
4268 MemPage *pOvfl = 0;
drh9b171272004-05-08 02:03:22 +00004269 MemPage *pToRelease = 0;
drh3aac2dd2004-04-26 14:10:20 +00004270 unsigned char *pPrior;
4271 unsigned char *pPayload;
danielk1977aef0bf62005-12-30 16:28:01 +00004272 BtShared *pBt = pPage->pBt;
drh3aac2dd2004-04-26 14:10:20 +00004273 Pgno pgnoOvfl = 0;
drh4b70f112004-05-02 21:12:19 +00004274 int nHeader;
drh6f11bef2004-05-13 01:12:56 +00004275 CellInfo info;
drh3b7511c2001-05-26 13:15:44 +00004276
drh1fee73e2007-08-29 04:00:57 +00004277 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00004278
drh91025292004-05-03 19:49:32 +00004279 /* Fill in the header. */
drh43605152004-05-29 21:46:49 +00004280 nHeader = 0;
drh91025292004-05-03 19:49:32 +00004281 if( !pPage->leaf ){
4282 nHeader += 4;
4283 }
drh8b18dd42004-05-12 19:18:15 +00004284 if( pPage->hasData ){
drhb026e052007-05-02 01:34:31 +00004285 nHeader += putVarint(&pCell[nHeader], nData+nZero);
drh6f11bef2004-05-13 01:12:56 +00004286 }else{
drhb026e052007-05-02 01:34:31 +00004287 nData = nZero = 0;
drh91025292004-05-03 19:49:32 +00004288 }
drh6f11bef2004-05-13 01:12:56 +00004289 nHeader += putVarint(&pCell[nHeader], *(u64*)&nKey);
drh16a9b832007-05-05 18:39:25 +00004290 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00004291 assert( info.nHeader==nHeader );
4292 assert( info.nKey==nKey );
drhb026e052007-05-02 01:34:31 +00004293 assert( info.nData==nData+nZero );
drh6f11bef2004-05-13 01:12:56 +00004294
4295 /* Fill in the payload */
drhb026e052007-05-02 01:34:31 +00004296 nPayload = nData + nZero;
drh3aac2dd2004-04-26 14:10:20 +00004297 if( pPage->intKey ){
4298 pSrc = pData;
4299 nSrc = nData;
drh91025292004-05-03 19:49:32 +00004300 nData = 0;
drh3aac2dd2004-04-26 14:10:20 +00004301 }else{
4302 nPayload += nKey;
4303 pSrc = pKey;
4304 nSrc = nKey;
4305 }
drh6f11bef2004-05-13 01:12:56 +00004306 *pnSize = info.nSize;
4307 spaceLeft = info.nLocal;
drh3aac2dd2004-04-26 14:10:20 +00004308 pPayload = &pCell[nHeader];
drh6f11bef2004-05-13 01:12:56 +00004309 pPrior = &pCell[info.iOverflow];
drh3b7511c2001-05-26 13:15:44 +00004310
drh3b7511c2001-05-26 13:15:44 +00004311 while( nPayload>0 ){
4312 if( spaceLeft==0 ){
danielk1977b39f70b2007-05-17 18:28:11 +00004313 int isExact = 0;
danielk1977afcdd022004-10-31 16:25:42 +00004314#ifndef SQLITE_OMIT_AUTOVACUUM
4315 Pgno pgnoPtrmap = pgnoOvfl; /* Overflow page pointer-map entry page */
danielk1977b39f70b2007-05-17 18:28:11 +00004316 if( pBt->autoVacuum ){
4317 do{
4318 pgnoOvfl++;
4319 } while(
4320 PTRMAP_ISPAGE(pBt, pgnoOvfl) || pgnoOvfl==PENDING_BYTE_PAGE(pBt)
4321 );
danielk197789a4be82007-05-23 13:34:32 +00004322 if( pgnoOvfl>1 ){
danielk1977b39f70b2007-05-17 18:28:11 +00004323 /* isExact = 1; */
4324 }
4325 }
danielk1977afcdd022004-10-31 16:25:42 +00004326#endif
danielk1977b39f70b2007-05-17 18:28:11 +00004327 rc = allocateBtreePage(pBt, &pOvfl, &pgnoOvfl, pgnoOvfl, isExact);
danielk1977afcdd022004-10-31 16:25:42 +00004328#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977a19df672004-11-03 11:37:07 +00004329 /* If the database supports auto-vacuum, and the second or subsequent
4330 ** overflow page is being allocated, add an entry to the pointer-map
danielk19774ef24492007-05-23 09:52:41 +00004331 ** for that page now.
4332 **
4333 ** If this is the first overflow page, then write a partial entry
4334 ** to the pointer-map. If we write nothing to this pointer-map slot,
4335 ** then the optimistic overflow chain processing in clearCell()
4336 ** may misinterpret the uninitialised values and delete the
4337 ** wrong pages from the database.
danielk1977afcdd022004-10-31 16:25:42 +00004338 */
danielk19774ef24492007-05-23 09:52:41 +00004339 if( pBt->autoVacuum && rc==SQLITE_OK ){
4340 u8 eType = (pgnoPtrmap?PTRMAP_OVERFLOW2:PTRMAP_OVERFLOW1);
4341 rc = ptrmapPut(pBt, pgnoOvfl, eType, pgnoPtrmap);
danielk197789a4be82007-05-23 13:34:32 +00004342 if( rc ){
4343 releasePage(pOvfl);
4344 }
danielk1977afcdd022004-10-31 16:25:42 +00004345 }
4346#endif
drh3b7511c2001-05-26 13:15:44 +00004347 if( rc ){
drh9b171272004-05-08 02:03:22 +00004348 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00004349 return rc;
4350 }
drh3aac2dd2004-04-26 14:10:20 +00004351 put4byte(pPrior, pgnoOvfl);
drh9b171272004-05-08 02:03:22 +00004352 releasePage(pToRelease);
4353 pToRelease = pOvfl;
drh3aac2dd2004-04-26 14:10:20 +00004354 pPrior = pOvfl->aData;
4355 put4byte(pPrior, 0);
4356 pPayload = &pOvfl->aData[4];
drhb6f41482004-05-14 01:58:11 +00004357 spaceLeft = pBt->usableSize - 4;
drh3b7511c2001-05-26 13:15:44 +00004358 }
4359 n = nPayload;
4360 if( n>spaceLeft ) n = spaceLeft;
drhb026e052007-05-02 01:34:31 +00004361 if( nSrc>0 ){
4362 if( n>nSrc ) n = nSrc;
4363 assert( pSrc );
4364 memcpy(pPayload, pSrc, n);
4365 }else{
4366 memset(pPayload, 0, n);
4367 }
drh3b7511c2001-05-26 13:15:44 +00004368 nPayload -= n;
drhde647132004-05-07 17:57:49 +00004369 pPayload += n;
drh9b171272004-05-08 02:03:22 +00004370 pSrc += n;
drh3aac2dd2004-04-26 14:10:20 +00004371 nSrc -= n;
drh3b7511c2001-05-26 13:15:44 +00004372 spaceLeft -= n;
drh3aac2dd2004-04-26 14:10:20 +00004373 if( nSrc==0 ){
4374 nSrc = nData;
4375 pSrc = pData;
4376 }
drhdd793422001-06-28 01:54:48 +00004377 }
drh9b171272004-05-08 02:03:22 +00004378 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00004379 return SQLITE_OK;
4380}
4381
4382/*
drhbd03cae2001-06-02 02:40:57 +00004383** Change the MemPage.pParent pointer on the page whose number is
drh8b2f49b2001-06-08 00:21:52 +00004384** given in the second argument so that MemPage.pParent holds the
drhbd03cae2001-06-02 02:40:57 +00004385** pointer in the third argument.
4386*/
danielk1977aef0bf62005-12-30 16:28:01 +00004387static int reparentPage(BtShared *pBt, Pgno pgno, MemPage *pNewParent, int idx){
drhbd03cae2001-06-02 02:40:57 +00004388 MemPage *pThis;
danielk19773b8a05f2007-03-19 17:44:26 +00004389 DbPage *pDbPage;
drhbd03cae2001-06-02 02:40:57 +00004390
drh1fee73e2007-08-29 04:00:57 +00004391 assert( sqlite3_mutex_held(pBt->mutex) );
drh43617e92006-03-06 20:55:46 +00004392 assert( pNewParent!=0 );
danielk1977afcdd022004-10-31 16:25:42 +00004393 if( pgno==0 ) return SQLITE_OK;
drh4b70f112004-05-02 21:12:19 +00004394 assert( pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00004395 pDbPage = sqlite3PagerLookup(pBt->pPager, pgno);
4396 if( pDbPage ){
4397 pThis = (MemPage *)sqlite3PagerGetExtra(pDbPage);
drhda200cc2004-05-09 11:51:38 +00004398 if( pThis->isInit ){
drhbf4bca52007-09-06 22:19:14 +00004399 assert( pThis->aData==sqlite3PagerGetData(pDbPage) );
drhda200cc2004-05-09 11:51:38 +00004400 if( pThis->pParent!=pNewParent ){
danielk19773b8a05f2007-03-19 17:44:26 +00004401 if( pThis->pParent ) sqlite3PagerUnref(pThis->pParent->pDbPage);
drhda200cc2004-05-09 11:51:38 +00004402 pThis->pParent = pNewParent;
danielk19773b8a05f2007-03-19 17:44:26 +00004403 sqlite3PagerRef(pNewParent->pDbPage);
drhda200cc2004-05-09 11:51:38 +00004404 }
4405 pThis->idxParent = idx;
drhdd793422001-06-28 01:54:48 +00004406 }
danielk19773b8a05f2007-03-19 17:44:26 +00004407 sqlite3PagerUnref(pDbPage);
drhbd03cae2001-06-02 02:40:57 +00004408 }
danielk1977afcdd022004-10-31 16:25:42 +00004409
4410#ifndef SQLITE_OMIT_AUTOVACUUM
4411 if( pBt->autoVacuum ){
4412 return ptrmapPut(pBt, pgno, PTRMAP_BTREE, pNewParent->pgno);
4413 }
4414#endif
4415 return SQLITE_OK;
drhbd03cae2001-06-02 02:40:57 +00004416}
4417
danielk1977ac11ee62005-01-15 12:45:51 +00004418
4419
drhbd03cae2001-06-02 02:40:57 +00004420/*
drh4b70f112004-05-02 21:12:19 +00004421** Change the pParent pointer of all children of pPage to point back
4422** to pPage.
4423**
drhbd03cae2001-06-02 02:40:57 +00004424** In other words, for every child of pPage, invoke reparentPage()
drh5e00f6c2001-09-13 13:46:56 +00004425** to make sure that each child knows that pPage is its parent.
drhbd03cae2001-06-02 02:40:57 +00004426**
4427** This routine gets called after you memcpy() one page into
4428** another.
4429*/
danielk1977afcdd022004-10-31 16:25:42 +00004430static int reparentChildPages(MemPage *pPage){
drhbd03cae2001-06-02 02:40:57 +00004431 int i;
danielk1977aef0bf62005-12-30 16:28:01 +00004432 BtShared *pBt = pPage->pBt;
danielk1977afcdd022004-10-31 16:25:42 +00004433 int rc = SQLITE_OK;
drh4b70f112004-05-02 21:12:19 +00004434
drh1fee73e2007-08-29 04:00:57 +00004435 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk1977afcdd022004-10-31 16:25:42 +00004436 if( pPage->leaf ) return SQLITE_OK;
danielk1977afcdd022004-10-31 16:25:42 +00004437
drhbd03cae2001-06-02 02:40:57 +00004438 for(i=0; i<pPage->nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00004439 u8 *pCell = findCell(pPage, i);
drhcfc2e7f2008-03-23 00:20:36 +00004440 rc = reparentPage(pBt, get4byte(pCell), pPage, i);
4441 if( rc!=SQLITE_OK ) return rc;
drhbd03cae2001-06-02 02:40:57 +00004442 }
drhcfc2e7f2008-03-23 00:20:36 +00004443 rc = reparentPage(pBt, get4byte(&pPage->aData[pPage->hdrOffset+8]),
4444 pPage, i);
4445 pPage->idxShift = 0;
danielk1977afcdd022004-10-31 16:25:42 +00004446 return rc;
drh14acc042001-06-10 19:56:58 +00004447}
4448
4449/*
4450** Remove the i-th cell from pPage. This routine effects pPage only.
4451** The cell content is not freed or deallocated. It is assumed that
4452** the cell content has been copied someplace else. This routine just
4453** removes the reference to the cell from pPage.
4454**
4455** "sz" must be the number of bytes in the cell.
drh14acc042001-06-10 19:56:58 +00004456*/
drh4b70f112004-05-02 21:12:19 +00004457static void dropCell(MemPage *pPage, int idx, int sz){
drh43605152004-05-29 21:46:49 +00004458 int i; /* Loop counter */
4459 int pc; /* Offset to cell content of cell being deleted */
4460 u8 *data; /* pPage->aData */
4461 u8 *ptr; /* Used to move bytes around within data[] */
4462
drh8c42ca92001-06-22 19:15:00 +00004463 assert( idx>=0 && idx<pPage->nCell );
drh43605152004-05-29 21:46:49 +00004464 assert( sz==cellSize(pPage, idx) );
danielk19773b8a05f2007-03-19 17:44:26 +00004465 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00004466 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhda200cc2004-05-09 11:51:38 +00004467 data = pPage->aData;
drh43605152004-05-29 21:46:49 +00004468 ptr = &data[pPage->cellOffset + 2*idx];
4469 pc = get2byte(ptr);
4470 assert( pc>10 && pc+sz<=pPage->pBt->usableSize );
drhde647132004-05-07 17:57:49 +00004471 freeSpace(pPage, pc, sz);
drh43605152004-05-29 21:46:49 +00004472 for(i=idx+1; i<pPage->nCell; i++, ptr+=2){
4473 ptr[0] = ptr[2];
4474 ptr[1] = ptr[3];
drh14acc042001-06-10 19:56:58 +00004475 }
4476 pPage->nCell--;
drh43605152004-05-29 21:46:49 +00004477 put2byte(&data[pPage->hdrOffset+3], pPage->nCell);
4478 pPage->nFree += 2;
drh428ae8c2003-01-04 16:48:09 +00004479 pPage->idxShift = 1;
drh14acc042001-06-10 19:56:58 +00004480}
4481
4482/*
4483** Insert a new cell on pPage at cell index "i". pCell points to the
4484** content of the cell.
4485**
4486** If the cell content will fit on the page, then put it there. If it
drh43605152004-05-29 21:46:49 +00004487** will not fit, then make a copy of the cell content into pTemp if
4488** pTemp is not null. Regardless of pTemp, allocate a new entry
4489** in pPage->aOvfl[] and make it point to the cell content (either
4490** in pTemp or the original pCell) and also record its index.
4491** Allocating a new entry in pPage->aCell[] implies that
4492** pPage->nOverflow is incremented.
danielk1977a3ad5e72005-01-07 08:56:44 +00004493**
4494** If nSkip is non-zero, then do not copy the first nSkip bytes of the
4495** cell. The caller will overwrite them after this function returns. If
drh4b238df2005-01-08 15:43:18 +00004496** nSkip is non-zero, then pCell may not point to an invalid memory location
danielk1977a3ad5e72005-01-07 08:56:44 +00004497** (but pCell+nSkip is always valid).
drh14acc042001-06-10 19:56:58 +00004498*/
danielk1977e80463b2004-11-03 03:01:16 +00004499static int insertCell(
drh24cd67e2004-05-10 16:18:47 +00004500 MemPage *pPage, /* Page into which we are copying */
drh43605152004-05-29 21:46:49 +00004501 int i, /* New cell becomes the i-th cell of the page */
4502 u8 *pCell, /* Content of the new cell */
4503 int sz, /* Bytes of content in pCell */
danielk1977a3ad5e72005-01-07 08:56:44 +00004504 u8 *pTemp, /* Temp storage space for pCell, if needed */
4505 u8 nSkip /* Do not write the first nSkip bytes of the cell */
drh24cd67e2004-05-10 16:18:47 +00004506){
drh43605152004-05-29 21:46:49 +00004507 int idx; /* Where to write new cell content in data[] */
4508 int j; /* Loop counter */
4509 int top; /* First byte of content for any cell in data[] */
4510 int end; /* First byte past the last cell pointer in data[] */
4511 int ins; /* Index in data[] where new cell pointer is inserted */
4512 int hdr; /* Offset into data[] of the page header */
4513 int cellOffset; /* Address of first cell pointer in data[] */
4514 u8 *data; /* The content of the whole page */
4515 u8 *ptr; /* Used for moving information around in data[] */
4516
4517 assert( i>=0 && i<=pPage->nCell+pPage->nOverflow );
4518 assert( sz==cellSizePtr(pPage, pCell) );
drh1fee73e2007-08-29 04:00:57 +00004519 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh43605152004-05-29 21:46:49 +00004520 if( pPage->nOverflow || sz+2>pPage->nFree ){
drh24cd67e2004-05-10 16:18:47 +00004521 if( pTemp ){
danielk1977a3ad5e72005-01-07 08:56:44 +00004522 memcpy(pTemp+nSkip, pCell+nSkip, sz-nSkip);
drh43605152004-05-29 21:46:49 +00004523 pCell = pTemp;
drh24cd67e2004-05-10 16:18:47 +00004524 }
drh43605152004-05-29 21:46:49 +00004525 j = pPage->nOverflow++;
4526 assert( j<sizeof(pPage->aOvfl)/sizeof(pPage->aOvfl[0]) );
4527 pPage->aOvfl[j].pCell = pCell;
4528 pPage->aOvfl[j].idx = i;
4529 pPage->nFree = 0;
drh14acc042001-06-10 19:56:58 +00004530 }else{
danielk19776e465eb2007-08-21 13:11:00 +00004531 int rc = sqlite3PagerWrite(pPage->pDbPage);
4532 if( rc!=SQLITE_OK ){
4533 return rc;
4534 }
4535 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh43605152004-05-29 21:46:49 +00004536 data = pPage->aData;
4537 hdr = pPage->hdrOffset;
4538 top = get2byte(&data[hdr+5]);
4539 cellOffset = pPage->cellOffset;
4540 end = cellOffset + 2*pPage->nCell + 2;
4541 ins = cellOffset + 2*i;
4542 if( end > top - sz ){
danielk19776e465eb2007-08-21 13:11:00 +00004543 rc = defragmentPage(pPage);
danielk19776b456a22005-03-21 04:04:02 +00004544 if( rc!=SQLITE_OK ) return rc;
drh43605152004-05-29 21:46:49 +00004545 top = get2byte(&data[hdr+5]);
4546 assert( end + sz <= top );
4547 }
4548 idx = allocateSpace(pPage, sz);
4549 assert( idx>0 );
4550 assert( end <= get2byte(&data[hdr+5]) );
4551 pPage->nCell++;
4552 pPage->nFree -= 2;
danielk1977a3ad5e72005-01-07 08:56:44 +00004553 memcpy(&data[idx+nSkip], pCell+nSkip, sz-nSkip);
drh43605152004-05-29 21:46:49 +00004554 for(j=end-2, ptr=&data[j]; j>ins; j-=2, ptr-=2){
4555 ptr[0] = ptr[-2];
4556 ptr[1] = ptr[-1];
drhda200cc2004-05-09 11:51:38 +00004557 }
drh43605152004-05-29 21:46:49 +00004558 put2byte(&data[ins], idx);
4559 put2byte(&data[hdr+3], pPage->nCell);
4560 pPage->idxShift = 1;
danielk1977a19df672004-11-03 11:37:07 +00004561#ifndef SQLITE_OMIT_AUTOVACUUM
4562 if( pPage->pBt->autoVacuum ){
4563 /* The cell may contain a pointer to an overflow page. If so, write
4564 ** the entry for the overflow page into the pointer map.
4565 */
4566 CellInfo info;
drh16a9b832007-05-05 18:39:25 +00004567 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh72365832007-03-06 15:53:44 +00004568 assert( (info.nData+(pPage->intKey?0:info.nKey))==info.nPayload );
danielk1977a19df672004-11-03 11:37:07 +00004569 if( (info.nData+(pPage->intKey?0:info.nKey))>info.nLocal ){
4570 Pgno pgnoOvfl = get4byte(&pCell[info.iOverflow]);
danielk19776e465eb2007-08-21 13:11:00 +00004571 rc = ptrmapPut(pPage->pBt, pgnoOvfl, PTRMAP_OVERFLOW1, pPage->pgno);
danielk1977a19df672004-11-03 11:37:07 +00004572 if( rc!=SQLITE_OK ) return rc;
4573 }
4574 }
4575#endif
drh14acc042001-06-10 19:56:58 +00004576 }
danielk1977e80463b2004-11-03 03:01:16 +00004577
danielk1977e80463b2004-11-03 03:01:16 +00004578 return SQLITE_OK;
drh14acc042001-06-10 19:56:58 +00004579}
4580
4581/*
drhfa1a98a2004-05-14 19:08:17 +00004582** Add a list of cells to a page. The page should be initially empty.
4583** The cells are guaranteed to fit on the page.
4584*/
4585static void assemblePage(
4586 MemPage *pPage, /* The page to be assemblied */
4587 int nCell, /* The number of cells to add to this page */
drh43605152004-05-29 21:46:49 +00004588 u8 **apCell, /* Pointers to cell bodies */
drha9121e42008-02-19 14:59:35 +00004589 u16 *aSize /* Sizes of the cells */
drhfa1a98a2004-05-14 19:08:17 +00004590){
4591 int i; /* Loop counter */
4592 int totalSize; /* Total size of all cells */
4593 int hdr; /* Index of page header */
drh43605152004-05-29 21:46:49 +00004594 int cellptr; /* Address of next cell pointer */
4595 int cellbody; /* Address of next cell body */
drhfa1a98a2004-05-14 19:08:17 +00004596 u8 *data; /* Data for the page */
4597
drh43605152004-05-29 21:46:49 +00004598 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +00004599 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhfa1a98a2004-05-14 19:08:17 +00004600 totalSize = 0;
4601 for(i=0; i<nCell; i++){
4602 totalSize += aSize[i];
4603 }
drh43605152004-05-29 21:46:49 +00004604 assert( totalSize+2*nCell<=pPage->nFree );
drhfa1a98a2004-05-14 19:08:17 +00004605 assert( pPage->nCell==0 );
drh43605152004-05-29 21:46:49 +00004606 cellptr = pPage->cellOffset;
drhfa1a98a2004-05-14 19:08:17 +00004607 data = pPage->aData;
4608 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +00004609 put2byte(&data[hdr+3], nCell);
drh09d0deb2005-08-02 17:13:09 +00004610 if( nCell ){
4611 cellbody = allocateSpace(pPage, totalSize);
4612 assert( cellbody>0 );
4613 assert( pPage->nFree >= 2*nCell );
4614 pPage->nFree -= 2*nCell;
4615 for(i=0; i<nCell; i++){
4616 put2byte(&data[cellptr], cellbody);
4617 memcpy(&data[cellbody], apCell[i], aSize[i]);
4618 cellptr += 2;
4619 cellbody += aSize[i];
4620 }
4621 assert( cellbody==pPage->pBt->usableSize );
drhfa1a98a2004-05-14 19:08:17 +00004622 }
4623 pPage->nCell = nCell;
drhfa1a98a2004-05-14 19:08:17 +00004624}
4625
drh14acc042001-06-10 19:56:58 +00004626/*
drhc3b70572003-01-04 19:44:07 +00004627** The following parameters determine how many adjacent pages get involved
4628** in a balancing operation. NN is the number of neighbors on either side
4629** of the page that participate in the balancing operation. NB is the
4630** total number of pages that participate, including the target page and
4631** NN neighbors on either side.
4632**
4633** The minimum value of NN is 1 (of course). Increasing NN above 1
4634** (to 2 or 3) gives a modest improvement in SELECT and DELETE performance
4635** in exchange for a larger degradation in INSERT and UPDATE performance.
4636** The value of NN appears to give the best results overall.
4637*/
4638#define NN 1 /* Number of neighbors on either side of pPage */
4639#define NB (NN*2+1) /* Total pages involved in the balance */
4640
drh43605152004-05-29 21:46:49 +00004641/* Forward reference */
danielk1977ac245ec2005-01-14 13:50:11 +00004642static int balance(MemPage*, int);
4643
drh615ae552005-01-16 23:21:00 +00004644#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00004645/*
4646** This version of balance() handles the common special case where
4647** a new entry is being inserted on the extreme right-end of the
4648** tree, in other words, when the new entry will become the largest
4649** entry in the tree.
4650**
4651** Instead of trying balance the 3 right-most leaf pages, just add
4652** a new page to the right-hand side and put the one new entry in
4653** that page. This leaves the right side of the tree somewhat
4654** unbalanced. But odds are that we will be inserting new entries
4655** at the end soon afterwards so the nearly empty page will quickly
4656** fill up. On average.
4657**
4658** pPage is the leaf page which is the right-most page in the tree.
4659** pParent is its parent. pPage must have a single overflow entry
4660** which is also the right-most entry on the page.
4661*/
danielk1977ac245ec2005-01-14 13:50:11 +00004662static int balance_quick(MemPage *pPage, MemPage *pParent){
4663 int rc;
4664 MemPage *pNew;
4665 Pgno pgnoNew;
4666 u8 *pCell;
drha9121e42008-02-19 14:59:35 +00004667 u16 szCell;
danielk1977ac245ec2005-01-14 13:50:11 +00004668 CellInfo info;
danielk1977aef0bf62005-12-30 16:28:01 +00004669 BtShared *pBt = pPage->pBt;
danielk197779a40da2005-01-16 08:00:01 +00004670 int parentIdx = pParent->nCell; /* pParent new divider cell index */
4671 int parentSize; /* Size of new divider cell */
4672 u8 parentCell[64]; /* Space for the new divider cell */
danielk1977ac245ec2005-01-14 13:50:11 +00004673
drh1fee73e2007-08-29 04:00:57 +00004674 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00004675
danielk1977ac245ec2005-01-14 13:50:11 +00004676 /* Allocate a new page. Insert the overflow cell from pPage
4677 ** into it. Then remove the overflow cell from pPage.
4678 */
drh4f0c5872007-03-26 22:05:01 +00004679 rc = allocateBtreePage(pBt, &pNew, &pgnoNew, 0, 0);
danielk1977ac245ec2005-01-14 13:50:11 +00004680 if( rc!=SQLITE_OK ){
4681 return rc;
4682 }
4683 pCell = pPage->aOvfl[0].pCell;
4684 szCell = cellSizePtr(pPage, pCell);
4685 zeroPage(pNew, pPage->aData[0]);
4686 assemblePage(pNew, 1, &pCell, &szCell);
4687 pPage->nOverflow = 0;
4688
danielk197779a40da2005-01-16 08:00:01 +00004689 /* Set the parent of the newly allocated page to pParent. */
4690 pNew->pParent = pParent;
danielk19773b8a05f2007-03-19 17:44:26 +00004691 sqlite3PagerRef(pParent->pDbPage);
danielk197779a40da2005-01-16 08:00:01 +00004692
danielk1977ac245ec2005-01-14 13:50:11 +00004693 /* pPage is currently the right-child of pParent. Change this
4694 ** so that the right-child is the new page allocated above and
danielk197779a40da2005-01-16 08:00:01 +00004695 ** pPage is the next-to-right child.
danielk1977ac245ec2005-01-14 13:50:11 +00004696 */
danielk1977ac11ee62005-01-15 12:45:51 +00004697 assert( pPage->nCell>0 );
danielk19771cc5ed82007-05-16 17:28:43 +00004698 pCell = findCell(pPage, pPage->nCell-1);
drh16a9b832007-05-05 18:39:25 +00004699 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drhb026e052007-05-02 01:34:31 +00004700 rc = fillInCell(pParent, parentCell, 0, info.nKey, 0, 0, 0, &parentSize);
danielk1977ac245ec2005-01-14 13:50:11 +00004701 if( rc!=SQLITE_OK ){
danielk197779a40da2005-01-16 08:00:01 +00004702 return rc;
danielk1977ac245ec2005-01-14 13:50:11 +00004703 }
4704 assert( parentSize<64 );
4705 rc = insertCell(pParent, parentIdx, parentCell, parentSize, 0, 4);
4706 if( rc!=SQLITE_OK ){
danielk197779a40da2005-01-16 08:00:01 +00004707 return rc;
danielk1977ac245ec2005-01-14 13:50:11 +00004708 }
4709 put4byte(findOverflowCell(pParent,parentIdx), pPage->pgno);
4710 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew);
4711
danielk197779a40da2005-01-16 08:00:01 +00004712#ifndef SQLITE_OMIT_AUTOVACUUM
4713 /* If this is an auto-vacuum database, update the pointer map
4714 ** with entries for the new page, and any pointer from the
4715 ** cell on the page to an overflow page.
4716 */
danielk1977ac11ee62005-01-15 12:45:51 +00004717 if( pBt->autoVacuum ){
4718 rc = ptrmapPut(pBt, pgnoNew, PTRMAP_BTREE, pParent->pgno);
danielk1977deb403e2007-05-24 09:20:16 +00004719 if( rc==SQLITE_OK ){
4720 rc = ptrmapPutOvfl(pNew, 0);
danielk1977ac11ee62005-01-15 12:45:51 +00004721 }
danielk197779a40da2005-01-16 08:00:01 +00004722 if( rc!=SQLITE_OK ){
danielk1977deb403e2007-05-24 09:20:16 +00004723 releasePage(pNew);
danielk197779a40da2005-01-16 08:00:01 +00004724 return rc;
danielk1977ac11ee62005-01-15 12:45:51 +00004725 }
4726 }
danielk197779a40da2005-01-16 08:00:01 +00004727#endif
danielk1977ac11ee62005-01-15 12:45:51 +00004728
danielk197779a40da2005-01-16 08:00:01 +00004729 /* Release the reference to the new page and balance the parent page,
4730 ** in case the divider cell inserted caused it to become overfull.
4731 */
danielk1977ac245ec2005-01-14 13:50:11 +00004732 releasePage(pNew);
4733 return balance(pParent, 0);
4734}
drh615ae552005-01-16 23:21:00 +00004735#endif /* SQLITE_OMIT_QUICKBALANCE */
drh43605152004-05-29 21:46:49 +00004736
drhc3b70572003-01-04 19:44:07 +00004737/*
drhab01f612004-05-22 02:55:23 +00004738** This routine redistributes Cells on pPage and up to NN*2 siblings
drh8b2f49b2001-06-08 00:21:52 +00004739** of pPage so that all pages have about the same amount of free space.
drh0c6cc4e2004-06-15 02:13:26 +00004740** Usually NN siblings on either side of pPage is used in the balancing,
4741** though more siblings might come from one side if pPage is the first
drhab01f612004-05-22 02:55:23 +00004742** or last child of its parent. If pPage has fewer than 2*NN siblings
drh8b2f49b2001-06-08 00:21:52 +00004743** (something which can only happen if pPage is the root page or a
drh14acc042001-06-10 19:56:58 +00004744** child of root) then all available siblings participate in the balancing.
drh8b2f49b2001-06-08 00:21:52 +00004745**
drh0c6cc4e2004-06-15 02:13:26 +00004746** The number of siblings of pPage might be increased or decreased by one or
4747** two in an effort to keep pages nearly full but not over full. The root page
drhab01f612004-05-22 02:55:23 +00004748** is special and is allowed to be nearly empty. If pPage is
drh8c42ca92001-06-22 19:15:00 +00004749** the root page, then the depth of the tree might be increased
drh8b2f49b2001-06-08 00:21:52 +00004750** or decreased by one, as necessary, to keep the root page from being
drhab01f612004-05-22 02:55:23 +00004751** overfull or completely empty.
drh14acc042001-06-10 19:56:58 +00004752**
drh8b2f49b2001-06-08 00:21:52 +00004753** Note that when this routine is called, some of the Cells on pPage
drh4b70f112004-05-02 21:12:19 +00004754** might not actually be stored in pPage->aData[]. This can happen
drh8b2f49b2001-06-08 00:21:52 +00004755** if the page is overfull. Part of the job of this routine is to
drh4b70f112004-05-02 21:12:19 +00004756** make sure all Cells for pPage once again fit in pPage->aData[].
drh14acc042001-06-10 19:56:58 +00004757**
drh8c42ca92001-06-22 19:15:00 +00004758** In the course of balancing the siblings of pPage, the parent of pPage
4759** might become overfull or underfull. If that happens, then this routine
4760** is called recursively on the parent.
4761**
drh5e00f6c2001-09-13 13:46:56 +00004762** If this routine fails for any reason, it might leave the database
4763** in a corrupted state. So if this routine fails, the database should
4764** be rolled back.
drh8b2f49b2001-06-08 00:21:52 +00004765*/
drh43605152004-05-29 21:46:49 +00004766static int balance_nonroot(MemPage *pPage){
drh8b2f49b2001-06-08 00:21:52 +00004767 MemPage *pParent; /* The parent of pPage */
drh16a9b832007-05-05 18:39:25 +00004768 BtShared *pBt; /* The whole database */
danielk1977634f2982005-03-28 08:44:07 +00004769 int nCell = 0; /* Number of cells in apCell[] */
4770 int nMaxCells = 0; /* Allocated size of apCell, szCell, aFrom. */
drh8b2f49b2001-06-08 00:21:52 +00004771 int nOld; /* Number of pages in apOld[] */
4772 int nNew; /* Number of pages in apNew[] */
drh8b2f49b2001-06-08 00:21:52 +00004773 int nDiv; /* Number of cells in apDiv[] */
drh14acc042001-06-10 19:56:58 +00004774 int i, j, k; /* Loop counters */
drha34b6762004-05-07 13:30:42 +00004775 int idx; /* Index of pPage in pParent->aCell[] */
4776 int nxDiv; /* Next divider slot in pParent->aCell[] */
drh14acc042001-06-10 19:56:58 +00004777 int rc; /* The return code */
drh91025292004-05-03 19:49:32 +00004778 int leafCorrection; /* 4 if pPage is a leaf. 0 if not */
drh8b18dd42004-05-12 19:18:15 +00004779 int leafData; /* True if pPage is a leaf of a LEAFDATA tree */
drh91025292004-05-03 19:49:32 +00004780 int usableSpace; /* Bytes in pPage beyond the header */
4781 int pageFlags; /* Value of pPage->aData[0] */
drh6019e162001-07-02 17:51:45 +00004782 int subtotal; /* Subtotal of bytes in cells on one page */
drhb6f41482004-05-14 01:58:11 +00004783 int iSpace = 0; /* First unused byte of aSpace[] */
drhc3b70572003-01-04 19:44:07 +00004784 MemPage *apOld[NB]; /* pPage and up to two siblings */
4785 Pgno pgnoOld[NB]; /* Page numbers for each page in apOld[] */
drh4b70f112004-05-02 21:12:19 +00004786 MemPage *apCopy[NB]; /* Private copies of apOld[] pages */
drha2fce642004-06-05 00:01:44 +00004787 MemPage *apNew[NB+2]; /* pPage and up to NB siblings after balancing */
4788 Pgno pgnoNew[NB+2]; /* Page numbers for each page in apNew[] */
drh4b70f112004-05-02 21:12:19 +00004789 u8 *apDiv[NB]; /* Divider cells in pParent */
drha2fce642004-06-05 00:01:44 +00004790 int cntNew[NB+2]; /* Index in aCell[] of cell after i-th page */
4791 int szNew[NB+2]; /* Combined size of cells place on i-th page */
danielk197750f059b2005-03-29 02:54:03 +00004792 u8 **apCell = 0; /* All cells begin balanced */
drha9121e42008-02-19 14:59:35 +00004793 u16 *szCell; /* Local size of all cells in apCell[] */
drh2e38c322004-09-03 18:38:44 +00004794 u8 *aCopy[NB]; /* Space for holding data of apCopy[] */
4795 u8 *aSpace; /* Space to hold copies of dividers cells */
danielk19774e17d142005-01-16 09:06:33 +00004796#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977ac11ee62005-01-15 12:45:51 +00004797 u8 *aFrom = 0;
4798#endif
drh8b2f49b2001-06-08 00:21:52 +00004799
drh1fee73e2007-08-29 04:00:57 +00004800 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00004801
drh14acc042001-06-10 19:56:58 +00004802 /*
drh43605152004-05-29 21:46:49 +00004803 ** Find the parent page.
drh8b2f49b2001-06-08 00:21:52 +00004804 */
drh3a4c1412004-05-09 20:40:11 +00004805 assert( pPage->isInit );
danielk19776e465eb2007-08-21 13:11:00 +00004806 assert( sqlite3PagerIswriteable(pPage->pDbPage) || pPage->nOverflow==1 );
drh4b70f112004-05-02 21:12:19 +00004807 pBt = pPage->pBt;
drh14acc042001-06-10 19:56:58 +00004808 pParent = pPage->pParent;
drh43605152004-05-29 21:46:49 +00004809 assert( pParent );
danielk19773b8a05f2007-03-19 17:44:26 +00004810 if( SQLITE_OK!=(rc = sqlite3PagerWrite(pParent->pDbPage)) ){
danielk197707cb5602006-01-20 10:55:05 +00004811 return rc;
4812 }
drh43605152004-05-29 21:46:49 +00004813 TRACE(("BALANCE: begin page %d child of %d\n", pPage->pgno, pParent->pgno));
drh2e38c322004-09-03 18:38:44 +00004814
drh615ae552005-01-16 23:21:00 +00004815#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00004816 /*
4817 ** A special case: If a new entry has just been inserted into a
4818 ** table (that is, a btree with integer keys and all data at the leaves)
drh09d0deb2005-08-02 17:13:09 +00004819 ** and the new entry is the right-most entry in the tree (it has the
drhf222e712005-01-14 22:55:49 +00004820 ** largest key) then use the special balance_quick() routine for
4821 ** balancing. balance_quick() is much faster and results in a tighter
4822 ** packing of data in the common case.
4823 */
danielk1977ac245ec2005-01-14 13:50:11 +00004824 if( pPage->leaf &&
4825 pPage->intKey &&
4826 pPage->leafData &&
4827 pPage->nOverflow==1 &&
4828 pPage->aOvfl[0].idx==pPage->nCell &&
danielk1977ac11ee62005-01-15 12:45:51 +00004829 pPage->pParent->pgno!=1 &&
danielk1977ac245ec2005-01-14 13:50:11 +00004830 get4byte(&pParent->aData[pParent->hdrOffset+8])==pPage->pgno
4831 ){
danielk1977ac11ee62005-01-15 12:45:51 +00004832 /*
4833 ** TODO: Check the siblings to the left of pPage. It may be that
4834 ** they are not full and no new page is required.
4835 */
danielk1977ac245ec2005-01-14 13:50:11 +00004836 return balance_quick(pPage, pParent);
4837 }
4838#endif
4839
danielk19776e465eb2007-08-21 13:11:00 +00004840 if( SQLITE_OK!=(rc = sqlite3PagerWrite(pPage->pDbPage)) ){
4841 return rc;
4842 }
4843
drh2e38c322004-09-03 18:38:44 +00004844 /*
drh4b70f112004-05-02 21:12:19 +00004845 ** Find the cell in the parent page whose left child points back
drh14acc042001-06-10 19:56:58 +00004846 ** to pPage. The "idx" variable is the index of that cell. If pPage
4847 ** is the rightmost child of pParent then set idx to pParent->nCell
drh8b2f49b2001-06-08 00:21:52 +00004848 */
drhbb49aba2003-01-04 18:53:27 +00004849 if( pParent->idxShift ){
drha34b6762004-05-07 13:30:42 +00004850 Pgno pgno;
drh4b70f112004-05-02 21:12:19 +00004851 pgno = pPage->pgno;
danielk19773b8a05f2007-03-19 17:44:26 +00004852 assert( pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
drhbb49aba2003-01-04 18:53:27 +00004853 for(idx=0; idx<pParent->nCell; idx++){
danielk19771cc5ed82007-05-16 17:28:43 +00004854 if( get4byte(findCell(pParent, idx))==pgno ){
drhbb49aba2003-01-04 18:53:27 +00004855 break;
4856 }
drh8b2f49b2001-06-08 00:21:52 +00004857 }
drh4b70f112004-05-02 21:12:19 +00004858 assert( idx<pParent->nCell
drh43605152004-05-29 21:46:49 +00004859 || get4byte(&pParent->aData[pParent->hdrOffset+8])==pgno );
drhbb49aba2003-01-04 18:53:27 +00004860 }else{
4861 idx = pPage->idxParent;
drh8b2f49b2001-06-08 00:21:52 +00004862 }
drh8b2f49b2001-06-08 00:21:52 +00004863
4864 /*
drh14acc042001-06-10 19:56:58 +00004865 ** Initialize variables so that it will be safe to jump
drh5edc3122001-09-13 21:53:09 +00004866 ** directly to balance_cleanup at any moment.
drh8b2f49b2001-06-08 00:21:52 +00004867 */
drh14acc042001-06-10 19:56:58 +00004868 nOld = nNew = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00004869 sqlite3PagerRef(pParent->pDbPage);
drh14acc042001-06-10 19:56:58 +00004870
4871 /*
drh4b70f112004-05-02 21:12:19 +00004872 ** Find sibling pages to pPage and the cells in pParent that divide
drhc3b70572003-01-04 19:44:07 +00004873 ** the siblings. An attempt is made to find NN siblings on either
4874 ** side of pPage. More siblings are taken from one side, however, if
4875 ** pPage there are fewer than NN siblings on the other side. If pParent
4876 ** has NB or fewer children then all children of pParent are taken.
drh14acc042001-06-10 19:56:58 +00004877 */
drhc3b70572003-01-04 19:44:07 +00004878 nxDiv = idx - NN;
4879 if( nxDiv + NB > pParent->nCell ){
4880 nxDiv = pParent->nCell - NB + 1;
drh8b2f49b2001-06-08 00:21:52 +00004881 }
drhc3b70572003-01-04 19:44:07 +00004882 if( nxDiv<0 ){
4883 nxDiv = 0;
4884 }
drh8b2f49b2001-06-08 00:21:52 +00004885 nDiv = 0;
drhc3b70572003-01-04 19:44:07 +00004886 for(i=0, k=nxDiv; i<NB; i++, k++){
drh14acc042001-06-10 19:56:58 +00004887 if( k<pParent->nCell ){
danielk19771cc5ed82007-05-16 17:28:43 +00004888 apDiv[i] = findCell(pParent, k);
drh8b2f49b2001-06-08 00:21:52 +00004889 nDiv++;
drha34b6762004-05-07 13:30:42 +00004890 assert( !pParent->leaf );
drh43605152004-05-29 21:46:49 +00004891 pgnoOld[i] = get4byte(apDiv[i]);
drh14acc042001-06-10 19:56:58 +00004892 }else if( k==pParent->nCell ){
drh43605152004-05-29 21:46:49 +00004893 pgnoOld[i] = get4byte(&pParent->aData[pParent->hdrOffset+8]);
drh14acc042001-06-10 19:56:58 +00004894 }else{
4895 break;
drh8b2f49b2001-06-08 00:21:52 +00004896 }
drhde647132004-05-07 17:57:49 +00004897 rc = getAndInitPage(pBt, pgnoOld[i], &apOld[i], pParent);
drh6019e162001-07-02 17:51:45 +00004898 if( rc ) goto balance_cleanup;
drh428ae8c2003-01-04 16:48:09 +00004899 apOld[i]->idxParent = k;
drh91025292004-05-03 19:49:32 +00004900 apCopy[i] = 0;
4901 assert( i==nOld );
drh14acc042001-06-10 19:56:58 +00004902 nOld++;
danielk1977634f2982005-03-28 08:44:07 +00004903 nMaxCells += 1+apOld[i]->nCell+apOld[i]->nOverflow;
drh8b2f49b2001-06-08 00:21:52 +00004904 }
4905
drha9121e42008-02-19 14:59:35 +00004906 /* Make nMaxCells a multiple of 4 in order to preserve 8-byte
drh8d97f1f2005-05-05 18:14:13 +00004907 ** alignment */
drha9121e42008-02-19 14:59:35 +00004908 nMaxCells = (nMaxCells + 3)&~3;
drh8d97f1f2005-05-05 18:14:13 +00004909
drh8b2f49b2001-06-08 00:21:52 +00004910 /*
danielk1977634f2982005-03-28 08:44:07 +00004911 ** Allocate space for memory structures
4912 */
drh17435752007-08-16 04:30:38 +00004913 apCell = sqlite3_malloc(
drha9121e42008-02-19 14:59:35 +00004914 nMaxCells*sizeof(u8*) /* apCell */
4915 + nMaxCells*sizeof(u16) /* szCell */
4916 + (ROUND8(sizeof(MemPage))+pBt->pageSize)*NB /* aCopy */
4917 + pBt->pageSize*5 /* aSpace */
4918 + (ISAUTOVACUUM ? nMaxCells : 0) /* aFrom */
danielk1977634f2982005-03-28 08:44:07 +00004919 );
4920 if( apCell==0 ){
4921 rc = SQLITE_NOMEM;
4922 goto balance_cleanup;
4923 }
drha9121e42008-02-19 14:59:35 +00004924 szCell = (u16*)&apCell[nMaxCells];
danielk1977634f2982005-03-28 08:44:07 +00004925 aCopy[0] = (u8*)&szCell[nMaxCells];
drhc96d8532005-05-03 12:30:33 +00004926 assert( ((aCopy[0] - (u8*)apCell) & 7)==0 ); /* 8-byte alignment required */
danielk1977634f2982005-03-28 08:44:07 +00004927 for(i=1; i<NB; i++){
drhc96d8532005-05-03 12:30:33 +00004928 aCopy[i] = &aCopy[i-1][pBt->pageSize+ROUND8(sizeof(MemPage))];
4929 assert( ((aCopy[i] - (u8*)apCell) & 7)==0 ); /* 8-byte alignment required */
danielk1977634f2982005-03-28 08:44:07 +00004930 }
drhc96d8532005-05-03 12:30:33 +00004931 aSpace = &aCopy[NB-1][pBt->pageSize+ROUND8(sizeof(MemPage))];
4932 assert( ((aSpace - (u8*)apCell) & 7)==0 ); /* 8-byte alignment required */
danielk1977634f2982005-03-28 08:44:07 +00004933#ifndef SQLITE_OMIT_AUTOVACUUM
4934 if( pBt->autoVacuum ){
drh07d183d2005-05-01 22:52:42 +00004935 aFrom = &aSpace[5*pBt->pageSize];
danielk1977634f2982005-03-28 08:44:07 +00004936 }
4937#endif
4938
4939 /*
drh14acc042001-06-10 19:56:58 +00004940 ** Make copies of the content of pPage and its siblings into aOld[].
4941 ** The rest of this function will use data from the copies rather
4942 ** that the original pages since the original pages will be in the
4943 ** process of being overwritten.
4944 */
4945 for(i=0; i<nOld; i++){
drhbf4bca52007-09-06 22:19:14 +00004946 MemPage *p = apCopy[i] = (MemPage*)aCopy[i];
4947 memcpy(p, apOld[i], sizeof(MemPage));
4948 p->aData = (void*)&p[1];
4949 memcpy(p->aData, apOld[i]->aData, pBt->pageSize);
drh14acc042001-06-10 19:56:58 +00004950 }
4951
4952 /*
4953 ** Load pointers to all cells on sibling pages and the divider cells
4954 ** into the local apCell[] array. Make copies of the divider cells
drhb6f41482004-05-14 01:58:11 +00004955 ** into space obtained form aSpace[] and remove the the divider Cells
4956 ** from pParent.
drh4b70f112004-05-02 21:12:19 +00004957 **
4958 ** If the siblings are on leaf pages, then the child pointers of the
4959 ** divider cells are stripped from the cells before they are copied
drh96f5b762004-05-16 16:24:36 +00004960 ** into aSpace[]. In this way, all cells in apCell[] are without
drh4b70f112004-05-02 21:12:19 +00004961 ** child pointers. If siblings are not leaves, then all cell in
4962 ** apCell[] include child pointers. Either way, all cells in apCell[]
4963 ** are alike.
drh96f5b762004-05-16 16:24:36 +00004964 **
4965 ** leafCorrection: 4 if pPage is a leaf. 0 if pPage is not a leaf.
4966 ** leafData: 1 if pPage holds key+data and pParent holds only keys.
drh8b2f49b2001-06-08 00:21:52 +00004967 */
4968 nCell = 0;
drh4b70f112004-05-02 21:12:19 +00004969 leafCorrection = pPage->leaf*4;
drh8b18dd42004-05-12 19:18:15 +00004970 leafData = pPage->leafData && pPage->leaf;
drh8b2f49b2001-06-08 00:21:52 +00004971 for(i=0; i<nOld; i++){
drh4b70f112004-05-02 21:12:19 +00004972 MemPage *pOld = apCopy[i];
drh43605152004-05-29 21:46:49 +00004973 int limit = pOld->nCell+pOld->nOverflow;
4974 for(j=0; j<limit; j++){
danielk1977634f2982005-03-28 08:44:07 +00004975 assert( nCell<nMaxCells );
drh43605152004-05-29 21:46:49 +00004976 apCell[nCell] = findOverflowCell(pOld, j);
4977 szCell[nCell] = cellSizePtr(pOld, apCell[nCell]);
danielk1977ac11ee62005-01-15 12:45:51 +00004978#ifndef SQLITE_OMIT_AUTOVACUUM
4979 if( pBt->autoVacuum ){
4980 int a;
4981 aFrom[nCell] = i;
4982 for(a=0; a<pOld->nOverflow; a++){
4983 if( pOld->aOvfl[a].pCell==apCell[nCell] ){
4984 aFrom[nCell] = 0xFF;
4985 break;
4986 }
4987 }
4988 }
4989#endif
drh14acc042001-06-10 19:56:58 +00004990 nCell++;
drh8b2f49b2001-06-08 00:21:52 +00004991 }
4992 if( i<nOld-1 ){
drha9121e42008-02-19 14:59:35 +00004993 u16 sz = cellSizePtr(pParent, apDiv[i]);
drh8b18dd42004-05-12 19:18:15 +00004994 if( leafData ){
drh96f5b762004-05-16 16:24:36 +00004995 /* With the LEAFDATA flag, pParent cells hold only INTKEYs that
4996 ** are duplicates of keys on the child pages. We need to remove
4997 ** the divider cells from pParent, but the dividers cells are not
4998 ** added to apCell[] because they are duplicates of child cells.
4999 */
drh8b18dd42004-05-12 19:18:15 +00005000 dropCell(pParent, nxDiv, sz);
drh4b70f112004-05-02 21:12:19 +00005001 }else{
drhb6f41482004-05-14 01:58:11 +00005002 u8 *pTemp;
danielk1977634f2982005-03-28 08:44:07 +00005003 assert( nCell<nMaxCells );
drhb6f41482004-05-14 01:58:11 +00005004 szCell[nCell] = sz;
5005 pTemp = &aSpace[iSpace];
5006 iSpace += sz;
drh07d183d2005-05-01 22:52:42 +00005007 assert( iSpace<=pBt->pageSize*5 );
drhb6f41482004-05-14 01:58:11 +00005008 memcpy(pTemp, apDiv[i], sz);
5009 apCell[nCell] = pTemp+leafCorrection;
danielk1977ac11ee62005-01-15 12:45:51 +00005010#ifndef SQLITE_OMIT_AUTOVACUUM
5011 if( pBt->autoVacuum ){
5012 aFrom[nCell] = 0xFF;
5013 }
5014#endif
drhb6f41482004-05-14 01:58:11 +00005015 dropCell(pParent, nxDiv, sz);
drh8b18dd42004-05-12 19:18:15 +00005016 szCell[nCell] -= leafCorrection;
drh43605152004-05-29 21:46:49 +00005017 assert( get4byte(pTemp)==pgnoOld[i] );
drh8b18dd42004-05-12 19:18:15 +00005018 if( !pOld->leaf ){
5019 assert( leafCorrection==0 );
5020 /* The right pointer of the child page pOld becomes the left
5021 ** pointer of the divider cell */
drh43605152004-05-29 21:46:49 +00005022 memcpy(apCell[nCell], &pOld->aData[pOld->hdrOffset+8], 4);
drh8b18dd42004-05-12 19:18:15 +00005023 }else{
5024 assert( leafCorrection==4 );
danielk197739c96042007-05-12 10:41:47 +00005025 if( szCell[nCell]<4 ){
5026 /* Do not allow any cells smaller than 4 bytes. */
5027 szCell[nCell] = 4;
5028 }
drh8b18dd42004-05-12 19:18:15 +00005029 }
5030 nCell++;
drh4b70f112004-05-02 21:12:19 +00005031 }
drh8b2f49b2001-06-08 00:21:52 +00005032 }
5033 }
5034
5035 /*
drh6019e162001-07-02 17:51:45 +00005036 ** Figure out the number of pages needed to hold all nCell cells.
5037 ** Store this number in "k". Also compute szNew[] which is the total
5038 ** size of all cells on the i-th page and cntNew[] which is the index
drh4b70f112004-05-02 21:12:19 +00005039 ** in apCell[] of the cell that divides page i from page i+1.
drh6019e162001-07-02 17:51:45 +00005040 ** cntNew[k] should equal nCell.
5041 **
drh96f5b762004-05-16 16:24:36 +00005042 ** Values computed by this block:
5043 **
5044 ** k: The total number of sibling pages
5045 ** szNew[i]: Spaced used on the i-th sibling page.
5046 ** cntNew[i]: Index in apCell[] and szCell[] for the first cell to
5047 ** the right of the i-th sibling page.
5048 ** usableSpace: Number of bytes of space available on each sibling.
5049 **
drh8b2f49b2001-06-08 00:21:52 +00005050 */
drh43605152004-05-29 21:46:49 +00005051 usableSpace = pBt->usableSize - 12 + leafCorrection;
drh6019e162001-07-02 17:51:45 +00005052 for(subtotal=k=i=0; i<nCell; i++){
danielk1977634f2982005-03-28 08:44:07 +00005053 assert( i<nMaxCells );
drh43605152004-05-29 21:46:49 +00005054 subtotal += szCell[i] + 2;
drh4b70f112004-05-02 21:12:19 +00005055 if( subtotal > usableSpace ){
drh6019e162001-07-02 17:51:45 +00005056 szNew[k] = subtotal - szCell[i];
5057 cntNew[k] = i;
drh8b18dd42004-05-12 19:18:15 +00005058 if( leafData ){ i--; }
drh6019e162001-07-02 17:51:45 +00005059 subtotal = 0;
5060 k++;
5061 }
5062 }
5063 szNew[k] = subtotal;
5064 cntNew[k] = nCell;
5065 k++;
drh96f5b762004-05-16 16:24:36 +00005066
5067 /*
5068 ** The packing computed by the previous block is biased toward the siblings
5069 ** on the left side. The left siblings are always nearly full, while the
5070 ** right-most sibling might be nearly empty. This block of code attempts
5071 ** to adjust the packing of siblings to get a better balance.
5072 **
5073 ** This adjustment is more than an optimization. The packing above might
5074 ** be so out of balance as to be illegal. For example, the right-most
5075 ** sibling might be completely empty. This adjustment is not optional.
5076 */
drh6019e162001-07-02 17:51:45 +00005077 for(i=k-1; i>0; i--){
drh96f5b762004-05-16 16:24:36 +00005078 int szRight = szNew[i]; /* Size of sibling on the right */
5079 int szLeft = szNew[i-1]; /* Size of sibling on the left */
5080 int r; /* Index of right-most cell in left sibling */
5081 int d; /* Index of first cell to the left of right sibling */
5082
5083 r = cntNew[i-1] - 1;
5084 d = r + 1 - leafData;
danielk1977634f2982005-03-28 08:44:07 +00005085 assert( d<nMaxCells );
5086 assert( r<nMaxCells );
drh43605152004-05-29 21:46:49 +00005087 while( szRight==0 || szRight+szCell[d]+2<=szLeft-(szCell[r]+2) ){
5088 szRight += szCell[d] + 2;
5089 szLeft -= szCell[r] + 2;
drh6019e162001-07-02 17:51:45 +00005090 cntNew[i-1]--;
drh96f5b762004-05-16 16:24:36 +00005091 r = cntNew[i-1] - 1;
5092 d = r + 1 - leafData;
drh6019e162001-07-02 17:51:45 +00005093 }
drh96f5b762004-05-16 16:24:36 +00005094 szNew[i] = szRight;
5095 szNew[i-1] = szLeft;
drh6019e162001-07-02 17:51:45 +00005096 }
drh09d0deb2005-08-02 17:13:09 +00005097
5098 /* Either we found one or more cells (cntnew[0])>0) or we are the
5099 ** a virtual root page. A virtual root page is when the real root
5100 ** page is page 1 and we are the only child of that page.
5101 */
5102 assert( cntNew[0]>0 || (pParent->pgno==1 && pParent->nCell==0) );
drh8b2f49b2001-06-08 00:21:52 +00005103
5104 /*
drh6b308672002-07-08 02:16:37 +00005105 ** Allocate k new pages. Reuse old pages where possible.
drh8b2f49b2001-06-08 00:21:52 +00005106 */
drh4b70f112004-05-02 21:12:19 +00005107 assert( pPage->pgno>1 );
5108 pageFlags = pPage->aData[0];
drh14acc042001-06-10 19:56:58 +00005109 for(i=0; i<k; i++){
drhda200cc2004-05-09 11:51:38 +00005110 MemPage *pNew;
drh6b308672002-07-08 02:16:37 +00005111 if( i<nOld ){
drhda200cc2004-05-09 11:51:38 +00005112 pNew = apNew[i] = apOld[i];
drh6b308672002-07-08 02:16:37 +00005113 pgnoNew[i] = pgnoOld[i];
5114 apOld[i] = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00005115 rc = sqlite3PagerWrite(pNew->pDbPage);
drhf5345442007-04-09 12:45:02 +00005116 nNew++;
danielk197728129562005-01-11 10:25:06 +00005117 if( rc ) goto balance_cleanup;
drh6b308672002-07-08 02:16:37 +00005118 }else{
drh7aa8f852006-03-28 00:24:44 +00005119 assert( i>0 );
drh4f0c5872007-03-26 22:05:01 +00005120 rc = allocateBtreePage(pBt, &pNew, &pgnoNew[i], pgnoNew[i-1], 0);
drh6b308672002-07-08 02:16:37 +00005121 if( rc ) goto balance_cleanup;
drhda200cc2004-05-09 11:51:38 +00005122 apNew[i] = pNew;
drhf5345442007-04-09 12:45:02 +00005123 nNew++;
drh6b308672002-07-08 02:16:37 +00005124 }
drhda200cc2004-05-09 11:51:38 +00005125 zeroPage(pNew, pageFlags);
drh8b2f49b2001-06-08 00:21:52 +00005126 }
5127
danielk1977299b1872004-11-22 10:02:10 +00005128 /* Free any old pages that were not reused as new pages.
5129 */
5130 while( i<nOld ){
5131 rc = freePage(apOld[i]);
5132 if( rc ) goto balance_cleanup;
5133 releasePage(apOld[i]);
5134 apOld[i] = 0;
5135 i++;
5136 }
5137
drh8b2f49b2001-06-08 00:21:52 +00005138 /*
drhf9ffac92002-03-02 19:00:31 +00005139 ** Put the new pages in accending order. This helps to
5140 ** keep entries in the disk file in order so that a scan
5141 ** of the table is a linear scan through the file. That
5142 ** in turn helps the operating system to deliver pages
5143 ** from the disk more rapidly.
5144 **
5145 ** An O(n^2) insertion sort algorithm is used, but since
drhc3b70572003-01-04 19:44:07 +00005146 ** n is never more than NB (a small constant), that should
5147 ** not be a problem.
drhf9ffac92002-03-02 19:00:31 +00005148 **
drhc3b70572003-01-04 19:44:07 +00005149 ** When NB==3, this one optimization makes the database
5150 ** about 25% faster for large insertions and deletions.
drhf9ffac92002-03-02 19:00:31 +00005151 */
5152 for(i=0; i<k-1; i++){
5153 int minV = pgnoNew[i];
5154 int minI = i;
5155 for(j=i+1; j<k; j++){
drh7d02cb72003-06-04 16:24:39 +00005156 if( pgnoNew[j]<(unsigned)minV ){
drhf9ffac92002-03-02 19:00:31 +00005157 minI = j;
5158 minV = pgnoNew[j];
5159 }
5160 }
5161 if( minI>i ){
5162 int t;
5163 MemPage *pT;
5164 t = pgnoNew[i];
5165 pT = apNew[i];
5166 pgnoNew[i] = pgnoNew[minI];
5167 apNew[i] = apNew[minI];
5168 pgnoNew[minI] = t;
5169 apNew[minI] = pT;
5170 }
5171 }
drha2fce642004-06-05 00:01:44 +00005172 TRACE(("BALANCE: old: %d %d %d new: %d(%d) %d(%d) %d(%d) %d(%d) %d(%d)\n",
drh24cd67e2004-05-10 16:18:47 +00005173 pgnoOld[0],
5174 nOld>=2 ? pgnoOld[1] : 0,
5175 nOld>=3 ? pgnoOld[2] : 0,
drh10c0fa62004-05-18 12:50:17 +00005176 pgnoNew[0], szNew[0],
5177 nNew>=2 ? pgnoNew[1] : 0, nNew>=2 ? szNew[1] : 0,
5178 nNew>=3 ? pgnoNew[2] : 0, nNew>=3 ? szNew[2] : 0,
drha2fce642004-06-05 00:01:44 +00005179 nNew>=4 ? pgnoNew[3] : 0, nNew>=4 ? szNew[3] : 0,
5180 nNew>=5 ? pgnoNew[4] : 0, nNew>=5 ? szNew[4] : 0));
drh24cd67e2004-05-10 16:18:47 +00005181
drhf9ffac92002-03-02 19:00:31 +00005182 /*
drh14acc042001-06-10 19:56:58 +00005183 ** Evenly distribute the data in apCell[] across the new pages.
5184 ** Insert divider cells into pParent as necessary.
5185 */
5186 j = 0;
5187 for(i=0; i<nNew; i++){
danielk1977ac11ee62005-01-15 12:45:51 +00005188 /* Assemble the new sibling page. */
drh14acc042001-06-10 19:56:58 +00005189 MemPage *pNew = apNew[i];
drh19642e52005-03-29 13:17:45 +00005190 assert( j<nMaxCells );
drh4b70f112004-05-02 21:12:19 +00005191 assert( pNew->pgno==pgnoNew[i] );
drhfa1a98a2004-05-14 19:08:17 +00005192 assemblePage(pNew, cntNew[i]-j, &apCell[j], &szCell[j]);
drh09d0deb2005-08-02 17:13:09 +00005193 assert( pNew->nCell>0 || (nNew==1 && cntNew[0]==0) );
drh43605152004-05-29 21:46:49 +00005194 assert( pNew->nOverflow==0 );
danielk1977ac11ee62005-01-15 12:45:51 +00005195
5196#ifndef SQLITE_OMIT_AUTOVACUUM
5197 /* If this is an auto-vacuum database, update the pointer map entries
5198 ** that point to the siblings that were rearranged. These can be: left
5199 ** children of cells, the right-child of the page, or overflow pages
5200 ** pointed to by cells.
5201 */
5202 if( pBt->autoVacuum ){
5203 for(k=j; k<cntNew[i]; k++){
danielk1977634f2982005-03-28 08:44:07 +00005204 assert( k<nMaxCells );
danielk1977ac11ee62005-01-15 12:45:51 +00005205 if( aFrom[k]==0xFF || apCopy[aFrom[k]]->pgno!=pNew->pgno ){
danielk197779a40da2005-01-16 08:00:01 +00005206 rc = ptrmapPutOvfl(pNew, k-j);
5207 if( rc!=SQLITE_OK ){
5208 goto balance_cleanup;
danielk1977ac11ee62005-01-15 12:45:51 +00005209 }
5210 }
5211 }
5212 }
5213#endif
5214
5215 j = cntNew[i];
5216
5217 /* If the sibling page assembled above was not the right-most sibling,
5218 ** insert a divider cell into the parent page.
5219 */
drh14acc042001-06-10 19:56:58 +00005220 if( i<nNew-1 && j<nCell ){
drh8b18dd42004-05-12 19:18:15 +00005221 u8 *pCell;
drh24cd67e2004-05-10 16:18:47 +00005222 u8 *pTemp;
drh8b18dd42004-05-12 19:18:15 +00005223 int sz;
danielk1977634f2982005-03-28 08:44:07 +00005224
5225 assert( j<nMaxCells );
drh8b18dd42004-05-12 19:18:15 +00005226 pCell = apCell[j];
5227 sz = szCell[j] + leafCorrection;
drh4b70f112004-05-02 21:12:19 +00005228 if( !pNew->leaf ){
drh43605152004-05-29 21:46:49 +00005229 memcpy(&pNew->aData[8], pCell, 4);
drh24cd67e2004-05-10 16:18:47 +00005230 pTemp = 0;
drh8b18dd42004-05-12 19:18:15 +00005231 }else if( leafData ){
drhfd131da2007-08-07 17:13:03 +00005232 /* If the tree is a leaf-data tree, and the siblings are leaves,
danielk1977ac11ee62005-01-15 12:45:51 +00005233 ** then there is no divider cell in apCell[]. Instead, the divider
5234 ** cell consists of the integer key for the right-most cell of
5235 ** the sibling-page assembled above only.
5236 */
drh6f11bef2004-05-13 01:12:56 +00005237 CellInfo info;
drh8b18dd42004-05-12 19:18:15 +00005238 j--;
drh16a9b832007-05-05 18:39:25 +00005239 sqlite3BtreeParseCellPtr(pNew, apCell[j], &info);
drhb6f41482004-05-14 01:58:11 +00005240 pCell = &aSpace[iSpace];
drhb026e052007-05-02 01:34:31 +00005241 fillInCell(pParent, pCell, 0, info.nKey, 0, 0, 0, &sz);
drhb6f41482004-05-14 01:58:11 +00005242 iSpace += sz;
drh07d183d2005-05-01 22:52:42 +00005243 assert( iSpace<=pBt->pageSize*5 );
drh8b18dd42004-05-12 19:18:15 +00005244 pTemp = 0;
drh4b70f112004-05-02 21:12:19 +00005245 }else{
5246 pCell -= 4;
drhb6f41482004-05-14 01:58:11 +00005247 pTemp = &aSpace[iSpace];
5248 iSpace += sz;
drh07d183d2005-05-01 22:52:42 +00005249 assert( iSpace<=pBt->pageSize*5 );
danielk19774aeff622007-05-12 09:30:47 +00005250 /* Obscure case for non-leaf-data trees: If the cell at pCell was
drh85b623f2007-12-13 21:54:09 +00005251 ** previously stored on a leaf node, and its reported size was 4
danielk19774aeff622007-05-12 09:30:47 +00005252 ** bytes, then it may actually be smaller than this
5253 ** (see sqlite3BtreeParseCellPtr(), 4 bytes is the minimum size of
drh85b623f2007-12-13 21:54:09 +00005254 ** any cell). But it is important to pass the correct size to
danielk19774aeff622007-05-12 09:30:47 +00005255 ** insertCell(), so reparse the cell now.
5256 **
5257 ** Note that this can never happen in an SQLite data file, as all
5258 ** cells are at least 4 bytes. It only happens in b-trees used
5259 ** to evaluate "IN (SELECT ...)" and similar clauses.
5260 */
5261 if( szCell[j]==4 ){
5262 assert(leafCorrection==4);
5263 sz = cellSizePtr(pParent, pCell);
5264 }
drh4b70f112004-05-02 21:12:19 +00005265 }
danielk1977a3ad5e72005-01-07 08:56:44 +00005266 rc = insertCell(pParent, nxDiv, pCell, sz, pTemp, 4);
danielk1977e80463b2004-11-03 03:01:16 +00005267 if( rc!=SQLITE_OK ) goto balance_cleanup;
drh43605152004-05-29 21:46:49 +00005268 put4byte(findOverflowCell(pParent,nxDiv), pNew->pgno);
danielk1977ac11ee62005-01-15 12:45:51 +00005269#ifndef SQLITE_OMIT_AUTOVACUUM
5270 /* If this is an auto-vacuum database, and not a leaf-data tree,
5271 ** then update the pointer map with an entry for the overflow page
5272 ** that the cell just inserted points to (if any).
5273 */
5274 if( pBt->autoVacuum && !leafData ){
danielk197779a40da2005-01-16 08:00:01 +00005275 rc = ptrmapPutOvfl(pParent, nxDiv);
5276 if( rc!=SQLITE_OK ){
5277 goto balance_cleanup;
danielk1977ac11ee62005-01-15 12:45:51 +00005278 }
5279 }
5280#endif
drh14acc042001-06-10 19:56:58 +00005281 j++;
5282 nxDiv++;
5283 }
5284 }
drh6019e162001-07-02 17:51:45 +00005285 assert( j==nCell );
drh7aa8f852006-03-28 00:24:44 +00005286 assert( nOld>0 );
5287 assert( nNew>0 );
drh4b70f112004-05-02 21:12:19 +00005288 if( (pageFlags & PTF_LEAF)==0 ){
drh43605152004-05-29 21:46:49 +00005289 memcpy(&apNew[nNew-1]->aData[8], &apCopy[nOld-1]->aData[8], 4);
drh14acc042001-06-10 19:56:58 +00005290 }
drh43605152004-05-29 21:46:49 +00005291 if( nxDiv==pParent->nCell+pParent->nOverflow ){
drh4b70f112004-05-02 21:12:19 +00005292 /* Right-most sibling is the right-most child of pParent */
drh43605152004-05-29 21:46:49 +00005293 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew[nNew-1]);
drh4b70f112004-05-02 21:12:19 +00005294 }else{
5295 /* Right-most sibling is the left child of the first entry in pParent
5296 ** past the right-most divider entry */
drh43605152004-05-29 21:46:49 +00005297 put4byte(findOverflowCell(pParent, nxDiv), pgnoNew[nNew-1]);
drh14acc042001-06-10 19:56:58 +00005298 }
5299
5300 /*
5301 ** Reparent children of all cells.
drh8b2f49b2001-06-08 00:21:52 +00005302 */
5303 for(i=0; i<nNew; i++){
danielk1977afcdd022004-10-31 16:25:42 +00005304 rc = reparentChildPages(apNew[i]);
5305 if( rc!=SQLITE_OK ) goto balance_cleanup;
drh8b2f49b2001-06-08 00:21:52 +00005306 }
danielk1977afcdd022004-10-31 16:25:42 +00005307 rc = reparentChildPages(pParent);
5308 if( rc!=SQLITE_OK ) goto balance_cleanup;
drh8b2f49b2001-06-08 00:21:52 +00005309
5310 /*
drh3a4c1412004-05-09 20:40:11 +00005311 ** Balance the parent page. Note that the current page (pPage) might
danielk1977ac11ee62005-01-15 12:45:51 +00005312 ** have been added to the freelist so it might no longer be initialized.
drh3a4c1412004-05-09 20:40:11 +00005313 ** But the parent page will always be initialized.
drh8b2f49b2001-06-08 00:21:52 +00005314 */
drhda200cc2004-05-09 11:51:38 +00005315 assert( pParent->isInit );
danielk1977ac245ec2005-01-14 13:50:11 +00005316 rc = balance(pParent, 0);
drhda200cc2004-05-09 11:51:38 +00005317
drh8b2f49b2001-06-08 00:21:52 +00005318 /*
drh14acc042001-06-10 19:56:58 +00005319 ** Cleanup before returning.
drh8b2f49b2001-06-08 00:21:52 +00005320 */
drh14acc042001-06-10 19:56:58 +00005321balance_cleanup:
drh17435752007-08-16 04:30:38 +00005322 sqlite3_free(apCell);
drh8b2f49b2001-06-08 00:21:52 +00005323 for(i=0; i<nOld; i++){
drh91025292004-05-03 19:49:32 +00005324 releasePage(apOld[i]);
drh8b2f49b2001-06-08 00:21:52 +00005325 }
drh14acc042001-06-10 19:56:58 +00005326 for(i=0; i<nNew; i++){
drh91025292004-05-03 19:49:32 +00005327 releasePage(apNew[i]);
drh8b2f49b2001-06-08 00:21:52 +00005328 }
drh91025292004-05-03 19:49:32 +00005329 releasePage(pParent);
drh3a4c1412004-05-09 20:40:11 +00005330 TRACE(("BALANCE: finished with %d: old=%d new=%d cells=%d\n",
5331 pPage->pgno, nOld, nNew, nCell));
drh8b2f49b2001-06-08 00:21:52 +00005332 return rc;
5333}
5334
5335/*
drh43605152004-05-29 21:46:49 +00005336** This routine is called for the root page of a btree when the root
5337** page contains no cells. This is an opportunity to make the tree
5338** shallower by one level.
5339*/
5340static int balance_shallower(MemPage *pPage){
5341 MemPage *pChild; /* The only child page of pPage */
5342 Pgno pgnoChild; /* Page number for pChild */
drh2e38c322004-09-03 18:38:44 +00005343 int rc = SQLITE_OK; /* Return code from subprocedures */
danielk1977aef0bf62005-12-30 16:28:01 +00005344 BtShared *pBt; /* The main BTree structure */
drh2e38c322004-09-03 18:38:44 +00005345 int mxCellPerPage; /* Maximum number of cells per page */
5346 u8 **apCell; /* All cells from pages being balanced */
drha9121e42008-02-19 14:59:35 +00005347 u16 *szCell; /* Local size of all cells */
drh43605152004-05-29 21:46:49 +00005348
5349 assert( pPage->pParent==0 );
5350 assert( pPage->nCell==0 );
drh1fee73e2007-08-29 04:00:57 +00005351 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh2e38c322004-09-03 18:38:44 +00005352 pBt = pPage->pBt;
5353 mxCellPerPage = MX_CELL(pBt);
drha9121e42008-02-19 14:59:35 +00005354 apCell = sqlite3_malloc( mxCellPerPage*(sizeof(u8*)+sizeof(u16)) );
drh2e38c322004-09-03 18:38:44 +00005355 if( apCell==0 ) return SQLITE_NOMEM;
drha9121e42008-02-19 14:59:35 +00005356 szCell = (u16*)&apCell[mxCellPerPage];
drh43605152004-05-29 21:46:49 +00005357 if( pPage->leaf ){
5358 /* The table is completely empty */
5359 TRACE(("BALANCE: empty table %d\n", pPage->pgno));
5360 }else{
5361 /* The root page is empty but has one child. Transfer the
5362 ** information from that one child into the root page if it
5363 ** will fit. This reduces the depth of the tree by one.
5364 **
5365 ** If the root page is page 1, it has less space available than
5366 ** its child (due to the 100 byte header that occurs at the beginning
5367 ** of the database fle), so it might not be able to hold all of the
5368 ** information currently contained in the child. If this is the
5369 ** case, then do not do the transfer. Leave page 1 empty except
5370 ** for the right-pointer to the child page. The child page becomes
5371 ** the virtual root of the tree.
5372 */
5373 pgnoChild = get4byte(&pPage->aData[pPage->hdrOffset+8]);
5374 assert( pgnoChild>0 );
danielk19773b8a05f2007-03-19 17:44:26 +00005375 assert( pgnoChild<=sqlite3PagerPagecount(pPage->pBt->pPager) );
drh16a9b832007-05-05 18:39:25 +00005376 rc = sqlite3BtreeGetPage(pPage->pBt, pgnoChild, &pChild, 0);
drh2e38c322004-09-03 18:38:44 +00005377 if( rc ) goto end_shallow_balance;
drh43605152004-05-29 21:46:49 +00005378 if( pPage->pgno==1 ){
drh16a9b832007-05-05 18:39:25 +00005379 rc = sqlite3BtreeInitPage(pChild, pPage);
drh2e38c322004-09-03 18:38:44 +00005380 if( rc ) goto end_shallow_balance;
drh43605152004-05-29 21:46:49 +00005381 assert( pChild->nOverflow==0 );
5382 if( pChild->nFree>=100 ){
5383 /* The child information will fit on the root page, so do the
5384 ** copy */
5385 int i;
5386 zeroPage(pPage, pChild->aData[0]);
5387 for(i=0; i<pChild->nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00005388 apCell[i] = findCell(pChild,i);
drh43605152004-05-29 21:46:49 +00005389 szCell[i] = cellSizePtr(pChild, apCell[i]);
5390 }
5391 assemblePage(pPage, pChild->nCell, apCell, szCell);
danielk1977ae825582004-11-23 09:06:55 +00005392 /* Copy the right-pointer of the child to the parent. */
5393 put4byte(&pPage->aData[pPage->hdrOffset+8],
5394 get4byte(&pChild->aData[pChild->hdrOffset+8]));
drh43605152004-05-29 21:46:49 +00005395 freePage(pChild);
5396 TRACE(("BALANCE: child %d transfer to page 1\n", pChild->pgno));
5397 }else{
5398 /* The child has more information that will fit on the root.
5399 ** The tree is already balanced. Do nothing. */
5400 TRACE(("BALANCE: child %d will not fit on page 1\n", pChild->pgno));
5401 }
5402 }else{
5403 memcpy(pPage->aData, pChild->aData, pPage->pBt->usableSize);
5404 pPage->isInit = 0;
5405 pPage->pParent = 0;
drh16a9b832007-05-05 18:39:25 +00005406 rc = sqlite3BtreeInitPage(pPage, 0);
drh43605152004-05-29 21:46:49 +00005407 assert( rc==SQLITE_OK );
5408 freePage(pChild);
5409 TRACE(("BALANCE: transfer child %d into root %d\n",
5410 pChild->pgno, pPage->pgno));
5411 }
danielk1977afcdd022004-10-31 16:25:42 +00005412 rc = reparentChildPages(pPage);
danielk1977ac11ee62005-01-15 12:45:51 +00005413 assert( pPage->nOverflow==0 );
5414#ifndef SQLITE_OMIT_AUTOVACUUM
5415 if( pBt->autoVacuum ){
danielk1977aac0a382005-01-16 11:07:06 +00005416 int i;
danielk1977ac11ee62005-01-15 12:45:51 +00005417 for(i=0; i<pPage->nCell; i++){
danielk197779a40da2005-01-16 08:00:01 +00005418 rc = ptrmapPutOvfl(pPage, i);
5419 if( rc!=SQLITE_OK ){
5420 goto end_shallow_balance;
danielk1977ac11ee62005-01-15 12:45:51 +00005421 }
5422 }
5423 }
5424#endif
drh43605152004-05-29 21:46:49 +00005425 releasePage(pChild);
5426 }
drh2e38c322004-09-03 18:38:44 +00005427end_shallow_balance:
drh17435752007-08-16 04:30:38 +00005428 sqlite3_free(apCell);
drh2e38c322004-09-03 18:38:44 +00005429 return rc;
drh43605152004-05-29 21:46:49 +00005430}
5431
5432
5433/*
5434** The root page is overfull
5435**
5436** When this happens, Create a new child page and copy the
5437** contents of the root into the child. Then make the root
5438** page an empty page with rightChild pointing to the new
5439** child. Finally, call balance_internal() on the new child
5440** to cause it to split.
5441*/
5442static int balance_deeper(MemPage *pPage){
5443 int rc; /* Return value from subprocedures */
5444 MemPage *pChild; /* Pointer to a new child page */
5445 Pgno pgnoChild; /* Page number of the new child page */
danielk1977aef0bf62005-12-30 16:28:01 +00005446 BtShared *pBt; /* The BTree */
drh43605152004-05-29 21:46:49 +00005447 int usableSize; /* Total usable size of a page */
5448 u8 *data; /* Content of the parent page */
5449 u8 *cdata; /* Content of the child page */
5450 int hdr; /* Offset to page header in parent */
5451 int brk; /* Offset to content of first cell in parent */
5452
5453 assert( pPage->pParent==0 );
5454 assert( pPage->nOverflow>0 );
5455 pBt = pPage->pBt;
drh1fee73e2007-08-29 04:00:57 +00005456 assert( sqlite3_mutex_held(pBt->mutex) );
drh4f0c5872007-03-26 22:05:01 +00005457 rc = allocateBtreePage(pBt, &pChild, &pgnoChild, pPage->pgno, 0);
drh43605152004-05-29 21:46:49 +00005458 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005459 assert( sqlite3PagerIswriteable(pChild->pDbPage) );
drh43605152004-05-29 21:46:49 +00005460 usableSize = pBt->usableSize;
5461 data = pPage->aData;
5462 hdr = pPage->hdrOffset;
5463 brk = get2byte(&data[hdr+5]);
5464 cdata = pChild->aData;
5465 memcpy(cdata, &data[hdr], pPage->cellOffset+2*pPage->nCell-hdr);
5466 memcpy(&cdata[brk], &data[brk], usableSize-brk);
danielk1977c7dc7532004-11-17 10:22:03 +00005467 assert( pChild->isInit==0 );
drh16a9b832007-05-05 18:39:25 +00005468 rc = sqlite3BtreeInitPage(pChild, pPage);
danielk19776b456a22005-03-21 04:04:02 +00005469 if( rc ) goto balancedeeper_out;
drh43605152004-05-29 21:46:49 +00005470 memcpy(pChild->aOvfl, pPage->aOvfl, pPage->nOverflow*sizeof(pPage->aOvfl[0]));
5471 pChild->nOverflow = pPage->nOverflow;
5472 if( pChild->nOverflow ){
5473 pChild->nFree = 0;
5474 }
5475 assert( pChild->nCell==pPage->nCell );
5476 zeroPage(pPage, pChild->aData[0] & ~PTF_LEAF);
5477 put4byte(&pPage->aData[pPage->hdrOffset+8], pgnoChild);
5478 TRACE(("BALANCE: copy root %d into %d\n", pPage->pgno, pChild->pgno));
danielk19774e17d142005-01-16 09:06:33 +00005479#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977ac11ee62005-01-15 12:45:51 +00005480 if( pBt->autoVacuum ){
5481 int i;
5482 rc = ptrmapPut(pBt, pChild->pgno, PTRMAP_BTREE, pPage->pgno);
danielk19776b456a22005-03-21 04:04:02 +00005483 if( rc ) goto balancedeeper_out;
danielk1977ac11ee62005-01-15 12:45:51 +00005484 for(i=0; i<pChild->nCell; i++){
danielk197779a40da2005-01-16 08:00:01 +00005485 rc = ptrmapPutOvfl(pChild, i);
5486 if( rc!=SQLITE_OK ){
5487 return rc;
danielk1977ac11ee62005-01-15 12:45:51 +00005488 }
5489 }
5490 }
danielk19774e17d142005-01-16 09:06:33 +00005491#endif
drh43605152004-05-29 21:46:49 +00005492 rc = balance_nonroot(pChild);
danielk19776b456a22005-03-21 04:04:02 +00005493
5494balancedeeper_out:
drh43605152004-05-29 21:46:49 +00005495 releasePage(pChild);
5496 return rc;
5497}
5498
5499/*
5500** Decide if the page pPage needs to be balanced. If balancing is
5501** required, call the appropriate balancing routine.
5502*/
danielk1977ac245ec2005-01-14 13:50:11 +00005503static int balance(MemPage *pPage, int insert){
drh43605152004-05-29 21:46:49 +00005504 int rc = SQLITE_OK;
drh1fee73e2007-08-29 04:00:57 +00005505 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh43605152004-05-29 21:46:49 +00005506 if( pPage->pParent==0 ){
danielk19776e465eb2007-08-21 13:11:00 +00005507 rc = sqlite3PagerWrite(pPage->pDbPage);
5508 if( rc==SQLITE_OK && pPage->nOverflow>0 ){
drh43605152004-05-29 21:46:49 +00005509 rc = balance_deeper(pPage);
5510 }
danielk1977687566d2004-11-02 12:56:41 +00005511 if( rc==SQLITE_OK && pPage->nCell==0 ){
drh43605152004-05-29 21:46:49 +00005512 rc = balance_shallower(pPage);
5513 }
5514 }else{
danielk1977ac245ec2005-01-14 13:50:11 +00005515 if( pPage->nOverflow>0 ||
5516 (!insert && pPage->nFree>pPage->pBt->usableSize*2/3) ){
drh43605152004-05-29 21:46:49 +00005517 rc = balance_nonroot(pPage);
5518 }
5519 }
5520 return rc;
5521}
5522
5523/*
drh8dcd7ca2004-08-08 19:43:29 +00005524** This routine checks all cursors that point to table pgnoRoot.
drh980b1a72006-08-16 16:42:48 +00005525** If any of those cursors were opened with wrFlag==0 in a different
5526** database connection (a database connection that shares the pager
5527** cache with the current connection) and that other connection
5528** is not in the ReadUncommmitted state, then this routine returns
5529** SQLITE_LOCKED.
danielk1977299b1872004-11-22 10:02:10 +00005530**
5531** In addition to checking for read-locks (where a read-lock
5532** means a cursor opened with wrFlag==0) this routine also moves
drh16a9b832007-05-05 18:39:25 +00005533** all write cursors so that they are pointing to the
drh980b1a72006-08-16 16:42:48 +00005534** first Cell on the root page. This is necessary because an insert
danielk1977299b1872004-11-22 10:02:10 +00005535** or delete might change the number of cells on a page or delete
5536** a page entirely and we do not want to leave any cursors
5537** pointing to non-existant pages or cells.
drhf74b8d92002-09-01 23:20:45 +00005538*/
drh980b1a72006-08-16 16:42:48 +00005539static int checkReadLocks(Btree *pBtree, Pgno pgnoRoot, BtCursor *pExclude){
danielk1977299b1872004-11-22 10:02:10 +00005540 BtCursor *p;
drh980b1a72006-08-16 16:42:48 +00005541 BtShared *pBt = pBtree->pBt;
drhe5fe6902007-12-07 18:55:28 +00005542 sqlite3 *db = pBtree->db;
drh1fee73e2007-08-29 04:00:57 +00005543 assert( sqlite3BtreeHoldsMutex(pBtree) );
danielk1977299b1872004-11-22 10:02:10 +00005544 for(p=pBt->pCursor; p; p=p->pNext){
drh980b1a72006-08-16 16:42:48 +00005545 if( p==pExclude ) continue;
5546 if( p->eState!=CURSOR_VALID ) continue;
5547 if( p->pgnoRoot!=pgnoRoot ) continue;
5548 if( p->wrFlag==0 ){
drhe5fe6902007-12-07 18:55:28 +00005549 sqlite3 *dbOther = p->pBtree->db;
drh980b1a72006-08-16 16:42:48 +00005550 if( dbOther==0 ||
5551 (dbOther!=db && (dbOther->flags & SQLITE_ReadUncommitted)==0) ){
5552 return SQLITE_LOCKED;
5553 }
5554 }else if( p->pPage->pgno!=p->pgnoRoot ){
danielk1977299b1872004-11-22 10:02:10 +00005555 moveToRoot(p);
5556 }
5557 }
drhf74b8d92002-09-01 23:20:45 +00005558 return SQLITE_OK;
5559}
5560
5561/*
drh3b7511c2001-05-26 13:15:44 +00005562** Insert a new record into the BTree. The key is given by (pKey,nKey)
5563** and the data is given by (pData,nData). The cursor is used only to
drh91025292004-05-03 19:49:32 +00005564** define what table the record should be inserted into. The cursor
drh4b70f112004-05-02 21:12:19 +00005565** is left pointing at a random location.
5566**
5567** For an INTKEY table, only the nKey value of the key is used. pKey is
5568** ignored. For a ZERODATA table, the pData and nData are both ignored.
drh3b7511c2001-05-26 13:15:44 +00005569*/
drh3aac2dd2004-04-26 14:10:20 +00005570int sqlite3BtreeInsert(
drh5c4d9702001-08-20 00:33:58 +00005571 BtCursor *pCur, /* Insert data into the table of this cursor */
drh4a1c3802004-05-12 15:15:47 +00005572 const void *pKey, i64 nKey, /* The key of the new record */
drhe4d90812007-03-29 05:51:49 +00005573 const void *pData, int nData, /* The data of the new record */
drhb026e052007-05-02 01:34:31 +00005574 int nZero, /* Number of extra 0 bytes to append to data */
drhe4d90812007-03-29 05:51:49 +00005575 int appendBias /* True if this is likely an append */
drh3b7511c2001-05-26 13:15:44 +00005576){
drh3b7511c2001-05-26 13:15:44 +00005577 int rc;
5578 int loc;
drh14acc042001-06-10 19:56:58 +00005579 int szNew;
drh3b7511c2001-05-26 13:15:44 +00005580 MemPage *pPage;
drhd677b3d2007-08-20 22:48:41 +00005581 Btree *p = pCur->pBtree;
5582 BtShared *pBt = p->pBt;
drha34b6762004-05-07 13:30:42 +00005583 unsigned char *oldCell;
drh2e38c322004-09-03 18:38:44 +00005584 unsigned char *newCell = 0;
drh3b7511c2001-05-26 13:15:44 +00005585
drh1fee73e2007-08-29 04:00:57 +00005586 assert( cursorHoldsMutex(pCur) );
danielk1977aef0bf62005-12-30 16:28:01 +00005587 if( pBt->inTransaction!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00005588 /* Must start a transaction before doing an insert */
drhd677b3d2007-08-20 22:48:41 +00005589 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drhd677b3d2007-08-20 22:48:41 +00005590 return rc;
drh8b2f49b2001-06-08 00:21:52 +00005591 }
drhf74b8d92002-09-01 23:20:45 +00005592 assert( !pBt->readOnly );
drhecdc7532001-09-23 02:35:53 +00005593 if( !pCur->wrFlag ){
5594 return SQLITE_PERM; /* Cursor not open for writing */
5595 }
drh980b1a72006-08-16 16:42:48 +00005596 if( checkReadLocks(pCur->pBtree, pCur->pgnoRoot, pCur) ){
drhf74b8d92002-09-01 23:20:45 +00005597 return SQLITE_LOCKED; /* The table pCur points to has a read lock */
5598 }
drhfb982642007-08-30 01:19:59 +00005599 if( pCur->eState==CURSOR_FAULT ){
5600 return pCur->skip;
5601 }
danielk1977da184232006-01-05 11:34:32 +00005602
5603 /* Save the positions of any other cursors open on this table */
drhbf700f32007-03-31 02:36:44 +00005604 clearCursorPosition(pCur);
danielk19772e94d4d2006-01-09 05:36:27 +00005605 if(
danielk19772e94d4d2006-01-09 05:36:27 +00005606 SQLITE_OK!=(rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur)) ||
drhe4d90812007-03-29 05:51:49 +00005607 SQLITE_OK!=(rc = sqlite3BtreeMoveto(pCur, pKey, nKey, appendBias, &loc))
danielk19772e94d4d2006-01-09 05:36:27 +00005608 ){
danielk1977da184232006-01-05 11:34:32 +00005609 return rc;
5610 }
5611
drh14acc042001-06-10 19:56:58 +00005612 pPage = pCur->pPage;
drh4a1c3802004-05-12 15:15:47 +00005613 assert( pPage->intKey || nKey>=0 );
drh8b18dd42004-05-12 19:18:15 +00005614 assert( pPage->leaf || !pPage->leafData );
drh3a4c1412004-05-09 20:40:11 +00005615 TRACE(("INSERT: table=%d nkey=%lld ndata=%d page=%d %s\n",
5616 pCur->pgnoRoot, nKey, nData, pPage->pgno,
5617 loc==0 ? "overwrite" : "new entry"));
drh7aa128d2002-06-21 13:09:16 +00005618 assert( pPage->isInit );
drh17435752007-08-16 04:30:38 +00005619 newCell = sqlite3_malloc( MX_CELL_SIZE(pBt) );
drh2e38c322004-09-03 18:38:44 +00005620 if( newCell==0 ) return SQLITE_NOMEM;
drhb026e052007-05-02 01:34:31 +00005621 rc = fillInCell(pPage, newCell, pKey, nKey, pData, nData, nZero, &szNew);
drh2e38c322004-09-03 18:38:44 +00005622 if( rc ) goto end_insert;
drh43605152004-05-29 21:46:49 +00005623 assert( szNew==cellSizePtr(pPage, newCell) );
drh2e38c322004-09-03 18:38:44 +00005624 assert( szNew<=MX_CELL_SIZE(pBt) );
danielk1977da184232006-01-05 11:34:32 +00005625 if( loc==0 && CURSOR_VALID==pCur->eState ){
drha9121e42008-02-19 14:59:35 +00005626 u16 szOld;
drha34b6762004-05-07 13:30:42 +00005627 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
danielk19776e465eb2007-08-21 13:11:00 +00005628 rc = sqlite3PagerWrite(pPage->pDbPage);
5629 if( rc ){
5630 goto end_insert;
5631 }
danielk19771cc5ed82007-05-16 17:28:43 +00005632 oldCell = findCell(pPage, pCur->idx);
drh4b70f112004-05-02 21:12:19 +00005633 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005634 memcpy(newCell, oldCell, 4);
drh4b70f112004-05-02 21:12:19 +00005635 }
drh43605152004-05-29 21:46:49 +00005636 szOld = cellSizePtr(pPage, oldCell);
drh4b70f112004-05-02 21:12:19 +00005637 rc = clearCell(pPage, oldCell);
drh2e38c322004-09-03 18:38:44 +00005638 if( rc ) goto end_insert;
drh4b70f112004-05-02 21:12:19 +00005639 dropCell(pPage, pCur->idx, szOld);
drh7c717f72001-06-24 20:39:41 +00005640 }else if( loc<0 && pPage->nCell>0 ){
drh4b70f112004-05-02 21:12:19 +00005641 assert( pPage->leaf );
drh14acc042001-06-10 19:56:58 +00005642 pCur->idx++;
drh271efa52004-05-30 19:19:05 +00005643 pCur->info.nSize = 0;
drh14acc042001-06-10 19:56:58 +00005644 }else{
drh4b70f112004-05-02 21:12:19 +00005645 assert( pPage->leaf );
drh3b7511c2001-05-26 13:15:44 +00005646 }
danielk1977a3ad5e72005-01-07 08:56:44 +00005647 rc = insertCell(pPage, pCur->idx, newCell, szNew, 0, 0);
danielk1977e80463b2004-11-03 03:01:16 +00005648 if( rc!=SQLITE_OK ) goto end_insert;
danielk1977ac245ec2005-01-14 13:50:11 +00005649 rc = balance(pPage, 1);
drh23e11ca2004-05-04 17:27:28 +00005650 /* sqlite3BtreePageDump(pCur->pBt, pCur->pgnoRoot, 1); */
drh3fc190c2001-09-14 03:24:23 +00005651 /* fflush(stdout); */
danielk1977299b1872004-11-22 10:02:10 +00005652 if( rc==SQLITE_OK ){
5653 moveToRoot(pCur);
5654 }
drh2e38c322004-09-03 18:38:44 +00005655end_insert:
drh17435752007-08-16 04:30:38 +00005656 sqlite3_free(newCell);
drh5e2f8b92001-05-28 00:41:15 +00005657 return rc;
5658}
5659
5660/*
drh4b70f112004-05-02 21:12:19 +00005661** Delete the entry that the cursor is pointing to. The cursor
5662** is left pointing at a random location.
drh3b7511c2001-05-26 13:15:44 +00005663*/
drh3aac2dd2004-04-26 14:10:20 +00005664int sqlite3BtreeDelete(BtCursor *pCur){
drh5e2f8b92001-05-28 00:41:15 +00005665 MemPage *pPage = pCur->pPage;
drh4b70f112004-05-02 21:12:19 +00005666 unsigned char *pCell;
drh5e2f8b92001-05-28 00:41:15 +00005667 int rc;
danielk1977cfe9a692004-06-16 12:00:29 +00005668 Pgno pgnoChild = 0;
drhd677b3d2007-08-20 22:48:41 +00005669 Btree *p = pCur->pBtree;
5670 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00005671
drh1fee73e2007-08-29 04:00:57 +00005672 assert( cursorHoldsMutex(pCur) );
drh7aa128d2002-06-21 13:09:16 +00005673 assert( pPage->isInit );
danielk1977aef0bf62005-12-30 16:28:01 +00005674 if( pBt->inTransaction!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00005675 /* Must start a transaction before doing a delete */
drhd677b3d2007-08-20 22:48:41 +00005676 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drhd677b3d2007-08-20 22:48:41 +00005677 return rc;
drh8b2f49b2001-06-08 00:21:52 +00005678 }
drhf74b8d92002-09-01 23:20:45 +00005679 assert( !pBt->readOnly );
drhfb982642007-08-30 01:19:59 +00005680 if( pCur->eState==CURSOR_FAULT ){
5681 return pCur->skip;
5682 }
drhbd03cae2001-06-02 02:40:57 +00005683 if( pCur->idx >= pPage->nCell ){
5684 return SQLITE_ERROR; /* The cursor is not pointing to anything */
5685 }
drhecdc7532001-09-23 02:35:53 +00005686 if( !pCur->wrFlag ){
5687 return SQLITE_PERM; /* Did not open this cursor for writing */
5688 }
drh980b1a72006-08-16 16:42:48 +00005689 if( checkReadLocks(pCur->pBtree, pCur->pgnoRoot, pCur) ){
drhf74b8d92002-09-01 23:20:45 +00005690 return SQLITE_LOCKED; /* The table pCur points to has a read lock */
5691 }
danielk1977da184232006-01-05 11:34:32 +00005692
5693 /* Restore the current cursor position (a no-op if the cursor is not in
5694 ** CURSOR_REQUIRESEEK state) and save the positions of any other cursors
danielk19773b8a05f2007-03-19 17:44:26 +00005695 ** open on the same table. Then call sqlite3PagerWrite() on the page
danielk1977da184232006-01-05 11:34:32 +00005696 ** that the entry will be deleted from.
5697 */
5698 if(
drhbf700f32007-03-31 02:36:44 +00005699 (rc = restoreOrClearCursorPosition(pCur))!=0 ||
drhd1167392006-01-23 13:00:35 +00005700 (rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur))!=0 ||
danielk19773b8a05f2007-03-19 17:44:26 +00005701 (rc = sqlite3PagerWrite(pPage->pDbPage))!=0
danielk1977da184232006-01-05 11:34:32 +00005702 ){
5703 return rc;
5704 }
danielk1977e6efa742004-11-10 11:55:10 +00005705
drh85b623f2007-12-13 21:54:09 +00005706 /* Locate the cell within its page and leave pCell pointing to the
danielk1977e6efa742004-11-10 11:55:10 +00005707 ** data. The clearCell() call frees any overflow pages associated with the
5708 ** cell. The cell itself is still intact.
5709 */
danielk19771cc5ed82007-05-16 17:28:43 +00005710 pCell = findCell(pPage, pCur->idx);
drh4b70f112004-05-02 21:12:19 +00005711 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005712 pgnoChild = get4byte(pCell);
drh4b70f112004-05-02 21:12:19 +00005713 }
danielk197728129562005-01-11 10:25:06 +00005714 rc = clearCell(pPage, pCell);
drhd677b3d2007-08-20 22:48:41 +00005715 if( rc ){
drhd677b3d2007-08-20 22:48:41 +00005716 return rc;
5717 }
danielk1977e6efa742004-11-10 11:55:10 +00005718
drh4b70f112004-05-02 21:12:19 +00005719 if( !pPage->leaf ){
drh14acc042001-06-10 19:56:58 +00005720 /*
drh5e00f6c2001-09-13 13:46:56 +00005721 ** The entry we are about to delete is not a leaf so if we do not
drh9ca7d3b2001-06-28 11:50:21 +00005722 ** do something we will leave a hole on an internal page.
5723 ** We have to fill the hole by moving in a cell from a leaf. The
5724 ** next Cell after the one to be deleted is guaranteed to exist and
danielk1977299b1872004-11-22 10:02:10 +00005725 ** to be a leaf so we can use it.
drh5e2f8b92001-05-28 00:41:15 +00005726 */
drh14acc042001-06-10 19:56:58 +00005727 BtCursor leafCur;
drh4b70f112004-05-02 21:12:19 +00005728 unsigned char *pNext;
danielk1977299b1872004-11-22 10:02:10 +00005729 int notUsed;
danielk19776b456a22005-03-21 04:04:02 +00005730 unsigned char *tempCell = 0;
drh8b18dd42004-05-12 19:18:15 +00005731 assert( !pPage->leafData );
drh16a9b832007-05-05 18:39:25 +00005732 sqlite3BtreeGetTempCursor(pCur, &leafCur);
danielk1977299b1872004-11-22 10:02:10 +00005733 rc = sqlite3BtreeNext(&leafCur, &notUsed);
danielk19776b456a22005-03-21 04:04:02 +00005734 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00005735 rc = sqlite3PagerWrite(leafCur.pPage->pDbPage);
danielk19776b456a22005-03-21 04:04:02 +00005736 }
5737 if( rc==SQLITE_OK ){
drha9121e42008-02-19 14:59:35 +00005738 u16 szNext;
danielk19776b456a22005-03-21 04:04:02 +00005739 TRACE(("DELETE: table=%d delete internal from %d replace from leaf %d\n",
5740 pCur->pgnoRoot, pPage->pgno, leafCur.pPage->pgno));
5741 dropCell(pPage, pCur->idx, cellSizePtr(pPage, pCell));
danielk19771cc5ed82007-05-16 17:28:43 +00005742 pNext = findCell(leafCur.pPage, leafCur.idx);
danielk19776b456a22005-03-21 04:04:02 +00005743 szNext = cellSizePtr(leafCur.pPage, pNext);
5744 assert( MX_CELL_SIZE(pBt)>=szNext+4 );
drh17435752007-08-16 04:30:38 +00005745 tempCell = sqlite3_malloc( MX_CELL_SIZE(pBt) );
danielk19776b456a22005-03-21 04:04:02 +00005746 if( tempCell==0 ){
5747 rc = SQLITE_NOMEM;
5748 }
danielk19778ea1cfa2008-01-01 06:19:02 +00005749 if( rc==SQLITE_OK ){
5750 rc = insertCell(pPage, pCur->idx, pNext-4, szNext+4, tempCell, 0);
5751 }
5752 if( rc==SQLITE_OK ){
5753 put4byte(findOverflowCell(pPage, pCur->idx), pgnoChild);
5754 rc = balance(pPage, 0);
5755 }
5756 if( rc==SQLITE_OK ){
5757 dropCell(leafCur.pPage, leafCur.idx, szNext);
5758 rc = balance(leafCur.pPage, 0);
5759 }
danielk19776b456a22005-03-21 04:04:02 +00005760 }
drh17435752007-08-16 04:30:38 +00005761 sqlite3_free(tempCell);
drh16a9b832007-05-05 18:39:25 +00005762 sqlite3BtreeReleaseTempCursor(&leafCur);
drh5e2f8b92001-05-28 00:41:15 +00005763 }else{
danielk1977299b1872004-11-22 10:02:10 +00005764 TRACE(("DELETE: table=%d delete from leaf %d\n",
5765 pCur->pgnoRoot, pPage->pgno));
5766 dropCell(pPage, pCur->idx, cellSizePtr(pPage, pCell));
danielk1977ac245ec2005-01-14 13:50:11 +00005767 rc = balance(pPage, 0);
drh5e2f8b92001-05-28 00:41:15 +00005768 }
danielk19776b456a22005-03-21 04:04:02 +00005769 if( rc==SQLITE_OK ){
5770 moveToRoot(pCur);
5771 }
drh5e2f8b92001-05-28 00:41:15 +00005772 return rc;
drh3b7511c2001-05-26 13:15:44 +00005773}
drh8b2f49b2001-06-08 00:21:52 +00005774
5775/*
drhc6b52df2002-01-04 03:09:29 +00005776** Create a new BTree table. Write into *piTable the page
5777** number for the root page of the new table.
5778**
drhab01f612004-05-22 02:55:23 +00005779** The type of type is determined by the flags parameter. Only the
5780** following values of flags are currently in use. Other values for
5781** flags might not work:
5782**
5783** BTREE_INTKEY|BTREE_LEAFDATA Used for SQL tables with rowid keys
5784** BTREE_ZERODATA Used for SQL indices
drh8b2f49b2001-06-08 00:21:52 +00005785*/
drhd677b3d2007-08-20 22:48:41 +00005786static int btreeCreateTable(Btree *p, int *piTable, int flags){
danielk1977aef0bf62005-12-30 16:28:01 +00005787 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00005788 MemPage *pRoot;
5789 Pgno pgnoRoot;
5790 int rc;
drhd677b3d2007-08-20 22:48:41 +00005791
drh1fee73e2007-08-29 04:00:57 +00005792 assert( sqlite3BtreeHoldsMutex(p) );
danielk1977aef0bf62005-12-30 16:28:01 +00005793 if( pBt->inTransaction!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00005794 /* Must start a transaction first */
drhd677b3d2007-08-20 22:48:41 +00005795 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
5796 return rc;
drh8b2f49b2001-06-08 00:21:52 +00005797 }
danielk197728129562005-01-11 10:25:06 +00005798 assert( !pBt->readOnly );
danielk1977e6efa742004-11-10 11:55:10 +00005799
danielk1977003ba062004-11-04 02:57:33 +00005800#ifdef SQLITE_OMIT_AUTOVACUUM
drh4f0c5872007-03-26 22:05:01 +00005801 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
drhd677b3d2007-08-20 22:48:41 +00005802 if( rc ){
5803 return rc;
5804 }
danielk1977003ba062004-11-04 02:57:33 +00005805#else
danielk1977687566d2004-11-02 12:56:41 +00005806 if( pBt->autoVacuum ){
danielk1977003ba062004-11-04 02:57:33 +00005807 Pgno pgnoMove; /* Move a page here to make room for the root-page */
5808 MemPage *pPageMove; /* The page to move to. */
5809
danielk197720713f32007-05-03 11:43:33 +00005810 /* Creating a new table may probably require moving an existing database
5811 ** to make room for the new tables root page. In case this page turns
5812 ** out to be an overflow page, delete all overflow page-map caches
5813 ** held by open cursors.
5814 */
danielk197792d4d7a2007-05-04 12:05:56 +00005815 invalidateAllOverflowCache(pBt);
danielk197720713f32007-05-03 11:43:33 +00005816
danielk1977003ba062004-11-04 02:57:33 +00005817 /* Read the value of meta[3] from the database to determine where the
5818 ** root page of the new table should go. meta[3] is the largest root-page
5819 ** created so far, so the new root-page is (meta[3]+1).
5820 */
danielk1977aef0bf62005-12-30 16:28:01 +00005821 rc = sqlite3BtreeGetMeta(p, 4, &pgnoRoot);
drhd677b3d2007-08-20 22:48:41 +00005822 if( rc!=SQLITE_OK ){
5823 return rc;
5824 }
danielk1977003ba062004-11-04 02:57:33 +00005825 pgnoRoot++;
5826
danielk1977599fcba2004-11-08 07:13:13 +00005827 /* The new root-page may not be allocated on a pointer-map page, or the
5828 ** PENDING_BYTE page.
5829 */
drh72190432008-01-31 14:54:43 +00005830 while( pgnoRoot==PTRMAP_PAGENO(pBt, pgnoRoot) ||
danielk1977599fcba2004-11-08 07:13:13 +00005831 pgnoRoot==PENDING_BYTE_PAGE(pBt) ){
danielk1977003ba062004-11-04 02:57:33 +00005832 pgnoRoot++;
5833 }
5834 assert( pgnoRoot>=3 );
5835
5836 /* Allocate a page. The page that currently resides at pgnoRoot will
5837 ** be moved to the allocated page (unless the allocated page happens
5838 ** to reside at pgnoRoot).
5839 */
drh4f0c5872007-03-26 22:05:01 +00005840 rc = allocateBtreePage(pBt, &pPageMove, &pgnoMove, pgnoRoot, 1);
danielk1977003ba062004-11-04 02:57:33 +00005841 if( rc!=SQLITE_OK ){
danielk1977687566d2004-11-02 12:56:41 +00005842 return rc;
5843 }
danielk1977003ba062004-11-04 02:57:33 +00005844
5845 if( pgnoMove!=pgnoRoot ){
danielk1977f35843b2007-04-07 15:03:17 +00005846 /* pgnoRoot is the page that will be used for the root-page of
5847 ** the new table (assuming an error did not occur). But we were
5848 ** allocated pgnoMove. If required (i.e. if it was not allocated
5849 ** by extending the file), the current page at position pgnoMove
5850 ** is already journaled.
5851 */
danielk1977003ba062004-11-04 02:57:33 +00005852 u8 eType;
5853 Pgno iPtrPage;
5854
5855 releasePage(pPageMove);
danielk1977f35843b2007-04-07 15:03:17 +00005856
5857 /* Move the page currently at pgnoRoot to pgnoMove. */
drh16a9b832007-05-05 18:39:25 +00005858 rc = sqlite3BtreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00005859 if( rc!=SQLITE_OK ){
5860 return rc;
5861 }
5862 rc = ptrmapGet(pBt, pgnoRoot, &eType, &iPtrPage);
drhccae6022005-02-26 17:31:26 +00005863 if( rc!=SQLITE_OK || eType==PTRMAP_ROOTPAGE || eType==PTRMAP_FREEPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00005864 releasePage(pRoot);
5865 return rc;
5866 }
drhccae6022005-02-26 17:31:26 +00005867 assert( eType!=PTRMAP_ROOTPAGE );
5868 assert( eType!=PTRMAP_FREEPAGE );
danielk19773b8a05f2007-03-19 17:44:26 +00005869 rc = sqlite3PagerWrite(pRoot->pDbPage);
danielk19775fd057a2005-03-09 13:09:43 +00005870 if( rc!=SQLITE_OK ){
5871 releasePage(pRoot);
5872 return rc;
5873 }
danielk1977003ba062004-11-04 02:57:33 +00005874 rc = relocatePage(pBt, pRoot, eType, iPtrPage, pgnoMove);
5875 releasePage(pRoot);
danielk1977f35843b2007-04-07 15:03:17 +00005876
5877 /* Obtain the page at pgnoRoot */
danielk1977003ba062004-11-04 02:57:33 +00005878 if( rc!=SQLITE_OK ){
5879 return rc;
5880 }
drh16a9b832007-05-05 18:39:25 +00005881 rc = sqlite3BtreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00005882 if( rc!=SQLITE_OK ){
5883 return rc;
5884 }
danielk19773b8a05f2007-03-19 17:44:26 +00005885 rc = sqlite3PagerWrite(pRoot->pDbPage);
danielk1977003ba062004-11-04 02:57:33 +00005886 if( rc!=SQLITE_OK ){
5887 releasePage(pRoot);
5888 return rc;
5889 }
5890 }else{
5891 pRoot = pPageMove;
5892 }
5893
danielk197742741be2005-01-08 12:42:39 +00005894 /* Update the pointer-map and meta-data with the new root-page number. */
danielk1977003ba062004-11-04 02:57:33 +00005895 rc = ptrmapPut(pBt, pgnoRoot, PTRMAP_ROOTPAGE, 0);
5896 if( rc ){
5897 releasePage(pRoot);
5898 return rc;
5899 }
danielk1977aef0bf62005-12-30 16:28:01 +00005900 rc = sqlite3BtreeUpdateMeta(p, 4, pgnoRoot);
danielk1977003ba062004-11-04 02:57:33 +00005901 if( rc ){
5902 releasePage(pRoot);
5903 return rc;
5904 }
danielk197742741be2005-01-08 12:42:39 +00005905
danielk1977003ba062004-11-04 02:57:33 +00005906 }else{
drh4f0c5872007-03-26 22:05:01 +00005907 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
danielk1977003ba062004-11-04 02:57:33 +00005908 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00005909 }
5910#endif
danielk19773b8a05f2007-03-19 17:44:26 +00005911 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
drhde647132004-05-07 17:57:49 +00005912 zeroPage(pRoot, flags | PTF_LEAF);
danielk19773b8a05f2007-03-19 17:44:26 +00005913 sqlite3PagerUnref(pRoot->pDbPage);
drh8b2f49b2001-06-08 00:21:52 +00005914 *piTable = (int)pgnoRoot;
5915 return SQLITE_OK;
5916}
drhd677b3d2007-08-20 22:48:41 +00005917int sqlite3BtreeCreateTable(Btree *p, int *piTable, int flags){
5918 int rc;
5919 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00005920 p->pBt->db = p->db;
drhd677b3d2007-08-20 22:48:41 +00005921 rc = btreeCreateTable(p, piTable, flags);
5922 sqlite3BtreeLeave(p);
5923 return rc;
5924}
drh8b2f49b2001-06-08 00:21:52 +00005925
5926/*
5927** Erase the given database page and all its children. Return
5928** the page to the freelist.
5929*/
drh4b70f112004-05-02 21:12:19 +00005930static int clearDatabasePage(
danielk1977aef0bf62005-12-30 16:28:01 +00005931 BtShared *pBt, /* The BTree that contains the table */
drh4b70f112004-05-02 21:12:19 +00005932 Pgno pgno, /* Page number to clear */
5933 MemPage *pParent, /* Parent page. NULL for the root */
5934 int freePageFlag /* Deallocate page if true */
5935){
danielk19776b456a22005-03-21 04:04:02 +00005936 MemPage *pPage = 0;
drh8b2f49b2001-06-08 00:21:52 +00005937 int rc;
drh4b70f112004-05-02 21:12:19 +00005938 unsigned char *pCell;
5939 int i;
drh8b2f49b2001-06-08 00:21:52 +00005940
drh1fee73e2007-08-29 04:00:57 +00005941 assert( sqlite3_mutex_held(pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00005942 if( pgno>sqlite3PagerPagecount(pBt->pPager) ){
drh49285702005-09-17 15:20:26 +00005943 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00005944 }
5945
drhde647132004-05-07 17:57:49 +00005946 rc = getAndInitPage(pBt, pgno, &pPage, pParent);
danielk19776b456a22005-03-21 04:04:02 +00005947 if( rc ) goto cleardatabasepage_out;
drh4b70f112004-05-02 21:12:19 +00005948 for(i=0; i<pPage->nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00005949 pCell = findCell(pPage, i);
drh4b70f112004-05-02 21:12:19 +00005950 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005951 rc = clearDatabasePage(pBt, get4byte(pCell), pPage->pParent, 1);
danielk19776b456a22005-03-21 04:04:02 +00005952 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00005953 }
drh4b70f112004-05-02 21:12:19 +00005954 rc = clearCell(pPage, pCell);
danielk19776b456a22005-03-21 04:04:02 +00005955 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00005956 }
drha34b6762004-05-07 13:30:42 +00005957 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005958 rc = clearDatabasePage(pBt, get4byte(&pPage->aData[8]), pPage->pParent, 1);
danielk19776b456a22005-03-21 04:04:02 +00005959 if( rc ) goto cleardatabasepage_out;
drh2aa679f2001-06-25 02:11:07 +00005960 }
5961 if( freePageFlag ){
drh4b70f112004-05-02 21:12:19 +00005962 rc = freePage(pPage);
danielk19773b8a05f2007-03-19 17:44:26 +00005963 }else if( (rc = sqlite3PagerWrite(pPage->pDbPage))==0 ){
drh3a4c1412004-05-09 20:40:11 +00005964 zeroPage(pPage, pPage->aData[0] | PTF_LEAF);
drh2aa679f2001-06-25 02:11:07 +00005965 }
danielk19776b456a22005-03-21 04:04:02 +00005966
5967cleardatabasepage_out:
drh4b70f112004-05-02 21:12:19 +00005968 releasePage(pPage);
drh2aa679f2001-06-25 02:11:07 +00005969 return rc;
drh8b2f49b2001-06-08 00:21:52 +00005970}
5971
5972/*
drhab01f612004-05-22 02:55:23 +00005973** Delete all information from a single table in the database. iTable is
5974** the page number of the root of the table. After this routine returns,
5975** the root page is empty, but still exists.
5976**
5977** This routine will fail with SQLITE_LOCKED if there are any open
5978** read cursors on the table. Open write cursors are moved to the
5979** root of the table.
drh8b2f49b2001-06-08 00:21:52 +00005980*/
danielk1977aef0bf62005-12-30 16:28:01 +00005981int sqlite3BtreeClearTable(Btree *p, int iTable){
drh8b2f49b2001-06-08 00:21:52 +00005982 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00005983 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00005984 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00005985 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00005986 if( p->inTrans!=TRANS_WRITE ){
drhd677b3d2007-08-20 22:48:41 +00005987 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
5988 }else if( (rc = checkReadLocks(p, iTable, 0))!=SQLITE_OK ){
5989 /* nothing to do */
5990 }else if( SQLITE_OK!=(rc = saveAllCursors(pBt, iTable, 0)) ){
5991 /* nothing to do */
5992 }else{
5993 rc = clearDatabasePage(pBt, (Pgno)iTable, 0, 0);
drh8b2f49b2001-06-08 00:21:52 +00005994 }
drhd677b3d2007-08-20 22:48:41 +00005995 sqlite3BtreeLeave(p);
5996 return rc;
drh8b2f49b2001-06-08 00:21:52 +00005997}
5998
5999/*
6000** Erase all information in a table and add the root of the table to
6001** the freelist. Except, the root of the principle table (the one on
drhab01f612004-05-22 02:55:23 +00006002** page 1) is never added to the freelist.
6003**
6004** This routine will fail with SQLITE_LOCKED if there are any open
6005** cursors on the table.
drh205f48e2004-11-05 00:43:11 +00006006**
6007** If AUTOVACUUM is enabled and the page at iTable is not the last
6008** root page in the database file, then the last root page
6009** in the database file is moved into the slot formerly occupied by
6010** iTable and that last slot formerly occupied by the last root page
6011** is added to the freelist instead of iTable. In this say, all
6012** root pages are kept at the beginning of the database file, which
6013** is necessary for AUTOVACUUM to work right. *piMoved is set to the
6014** page number that used to be the last root page in the file before
6015** the move. If no page gets moved, *piMoved is set to 0.
6016** The last root page is recorded in meta[3] and the value of
6017** meta[3] is updated by this procedure.
drh8b2f49b2001-06-08 00:21:52 +00006018*/
drhd677b3d2007-08-20 22:48:41 +00006019static int btreeDropTable(Btree *p, int iTable, int *piMoved){
drh8b2f49b2001-06-08 00:21:52 +00006020 int rc;
danielk1977a0bf2652004-11-04 14:30:04 +00006021 MemPage *pPage = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00006022 BtShared *pBt = p->pBt;
danielk1977a0bf2652004-11-04 14:30:04 +00006023
drh1fee73e2007-08-29 04:00:57 +00006024 assert( sqlite3BtreeHoldsMutex(p) );
danielk1977aef0bf62005-12-30 16:28:01 +00006025 if( p->inTrans!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00006026 return pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drh8b2f49b2001-06-08 00:21:52 +00006027 }
danielk1977a0bf2652004-11-04 14:30:04 +00006028
danielk1977e6efa742004-11-10 11:55:10 +00006029 /* It is illegal to drop a table if any cursors are open on the
6030 ** database. This is because in auto-vacuum mode the backend may
6031 ** need to move another root-page to fill a gap left by the deleted
6032 ** root page. If an open cursor was using this page a problem would
6033 ** occur.
6034 */
6035 if( pBt->pCursor ){
6036 return SQLITE_LOCKED;
drh5df72a52002-06-06 23:16:05 +00006037 }
danielk1977a0bf2652004-11-04 14:30:04 +00006038
drh16a9b832007-05-05 18:39:25 +00006039 rc = sqlite3BtreeGetPage(pBt, (Pgno)iTable, &pPage, 0);
drh2aa679f2001-06-25 02:11:07 +00006040 if( rc ) return rc;
danielk1977aef0bf62005-12-30 16:28:01 +00006041 rc = sqlite3BtreeClearTable(p, iTable);
danielk19776b456a22005-03-21 04:04:02 +00006042 if( rc ){
6043 releasePage(pPage);
6044 return rc;
6045 }
danielk1977a0bf2652004-11-04 14:30:04 +00006046
drh205f48e2004-11-05 00:43:11 +00006047 *piMoved = 0;
danielk1977a0bf2652004-11-04 14:30:04 +00006048
drh4b70f112004-05-02 21:12:19 +00006049 if( iTable>1 ){
danielk1977a0bf2652004-11-04 14:30:04 +00006050#ifdef SQLITE_OMIT_AUTOVACUUM
drha34b6762004-05-07 13:30:42 +00006051 rc = freePage(pPage);
danielk1977a0bf2652004-11-04 14:30:04 +00006052 releasePage(pPage);
6053#else
6054 if( pBt->autoVacuum ){
6055 Pgno maxRootPgno;
danielk1977aef0bf62005-12-30 16:28:01 +00006056 rc = sqlite3BtreeGetMeta(p, 4, &maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00006057 if( rc!=SQLITE_OK ){
6058 releasePage(pPage);
6059 return rc;
6060 }
6061
6062 if( iTable==maxRootPgno ){
6063 /* If the table being dropped is the table with the largest root-page
6064 ** number in the database, put the root page on the free list.
6065 */
6066 rc = freePage(pPage);
6067 releasePage(pPage);
6068 if( rc!=SQLITE_OK ){
6069 return rc;
6070 }
6071 }else{
6072 /* The table being dropped does not have the largest root-page
6073 ** number in the database. So move the page that does into the
6074 ** gap left by the deleted root-page.
6075 */
6076 MemPage *pMove;
6077 releasePage(pPage);
drh16a9b832007-05-05 18:39:25 +00006078 rc = sqlite3BtreeGetPage(pBt, maxRootPgno, &pMove, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00006079 if( rc!=SQLITE_OK ){
6080 return rc;
6081 }
6082 rc = relocatePage(pBt, pMove, PTRMAP_ROOTPAGE, 0, iTable);
6083 releasePage(pMove);
6084 if( rc!=SQLITE_OK ){
6085 return rc;
6086 }
drh16a9b832007-05-05 18:39:25 +00006087 rc = sqlite3BtreeGetPage(pBt, maxRootPgno, &pMove, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00006088 if( rc!=SQLITE_OK ){
6089 return rc;
6090 }
6091 rc = freePage(pMove);
6092 releasePage(pMove);
6093 if( rc!=SQLITE_OK ){
6094 return rc;
6095 }
6096 *piMoved = maxRootPgno;
6097 }
6098
danielk1977599fcba2004-11-08 07:13:13 +00006099 /* Set the new 'max-root-page' value in the database header. This
6100 ** is the old value less one, less one more if that happens to
6101 ** be a root-page number, less one again if that is the
6102 ** PENDING_BYTE_PAGE.
6103 */
danielk197787a6e732004-11-05 12:58:25 +00006104 maxRootPgno--;
danielk1977599fcba2004-11-08 07:13:13 +00006105 if( maxRootPgno==PENDING_BYTE_PAGE(pBt) ){
6106 maxRootPgno--;
6107 }
danielk1977266664d2006-02-10 08:24:21 +00006108 if( maxRootPgno==PTRMAP_PAGENO(pBt, maxRootPgno) ){
danielk197787a6e732004-11-05 12:58:25 +00006109 maxRootPgno--;
6110 }
danielk1977599fcba2004-11-08 07:13:13 +00006111 assert( maxRootPgno!=PENDING_BYTE_PAGE(pBt) );
6112
danielk1977aef0bf62005-12-30 16:28:01 +00006113 rc = sqlite3BtreeUpdateMeta(p, 4, maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00006114 }else{
6115 rc = freePage(pPage);
6116 releasePage(pPage);
6117 }
6118#endif
drh2aa679f2001-06-25 02:11:07 +00006119 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00006120 /* If sqlite3BtreeDropTable was called on page 1. */
drha34b6762004-05-07 13:30:42 +00006121 zeroPage(pPage, PTF_INTKEY|PTF_LEAF );
danielk1977a0bf2652004-11-04 14:30:04 +00006122 releasePage(pPage);
drh8b2f49b2001-06-08 00:21:52 +00006123 }
drh8b2f49b2001-06-08 00:21:52 +00006124 return rc;
6125}
drhd677b3d2007-08-20 22:48:41 +00006126int sqlite3BtreeDropTable(Btree *p, int iTable, int *piMoved){
6127 int rc;
6128 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006129 p->pBt->db = p->db;
drhd677b3d2007-08-20 22:48:41 +00006130 rc = btreeDropTable(p, iTable, piMoved);
6131 sqlite3BtreeLeave(p);
6132 return rc;
6133}
drh8b2f49b2001-06-08 00:21:52 +00006134
drh001bbcb2003-03-19 03:14:00 +00006135
drh8b2f49b2001-06-08 00:21:52 +00006136/*
drh23e11ca2004-05-04 17:27:28 +00006137** Read the meta-information out of a database file. Meta[0]
6138** is the number of free pages currently in the database. Meta[1]
drha3b321d2004-05-11 09:31:31 +00006139** through meta[15] are available for use by higher layers. Meta[0]
6140** is read-only, the others are read/write.
6141**
6142** The schema layer numbers meta values differently. At the schema
6143** layer (and the SetCookie and ReadCookie opcodes) the number of
6144** free pages is not visible. So Cookie[0] is the same as Meta[1].
drh8b2f49b2001-06-08 00:21:52 +00006145*/
danielk1977aef0bf62005-12-30 16:28:01 +00006146int sqlite3BtreeGetMeta(Btree *p, int idx, u32 *pMeta){
danielk19773b8a05f2007-03-19 17:44:26 +00006147 DbPage *pDbPage;
drh8b2f49b2001-06-08 00:21:52 +00006148 int rc;
drh4b70f112004-05-02 21:12:19 +00006149 unsigned char *pP1;
danielk1977aef0bf62005-12-30 16:28:01 +00006150 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00006151
drhd677b3d2007-08-20 22:48:41 +00006152 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006153 pBt->db = p->db;
drhd677b3d2007-08-20 22:48:41 +00006154
danielk1977da184232006-01-05 11:34:32 +00006155 /* Reading a meta-data value requires a read-lock on page 1 (and hence
6156 ** the sqlite_master table. We grab this lock regardless of whether or
6157 ** not the SQLITE_ReadUncommitted flag is set (the table rooted at page
6158 ** 1 is treated as a special case by queryTableLock() and lockTable()).
6159 */
6160 rc = queryTableLock(p, 1, READ_LOCK);
6161 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00006162 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +00006163 return rc;
6164 }
6165
drh23e11ca2004-05-04 17:27:28 +00006166 assert( idx>=0 && idx<=15 );
danielk19773b8a05f2007-03-19 17:44:26 +00006167 rc = sqlite3PagerGet(pBt->pPager, 1, &pDbPage);
drhd677b3d2007-08-20 22:48:41 +00006168 if( rc ){
6169 sqlite3BtreeLeave(p);
6170 return rc;
6171 }
danielk19773b8a05f2007-03-19 17:44:26 +00006172 pP1 = (unsigned char *)sqlite3PagerGetData(pDbPage);
drh23e11ca2004-05-04 17:27:28 +00006173 *pMeta = get4byte(&pP1[36 + idx*4]);
danielk19773b8a05f2007-03-19 17:44:26 +00006174 sqlite3PagerUnref(pDbPage);
drhae157872004-08-14 19:20:09 +00006175
danielk1977599fcba2004-11-08 07:13:13 +00006176 /* If autovacuumed is disabled in this build but we are trying to
6177 ** access an autovacuumed database, then make the database readonly.
6178 */
danielk1977003ba062004-11-04 02:57:33 +00006179#ifdef SQLITE_OMIT_AUTOVACUUM
drhae157872004-08-14 19:20:09 +00006180 if( idx==4 && *pMeta>0 ) pBt->readOnly = 1;
danielk1977003ba062004-11-04 02:57:33 +00006181#endif
drhae157872004-08-14 19:20:09 +00006182
danielk1977da184232006-01-05 11:34:32 +00006183 /* Grab the read-lock on page 1. */
6184 rc = lockTable(p, 1, READ_LOCK);
drhd677b3d2007-08-20 22:48:41 +00006185 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +00006186 return rc;
drh8b2f49b2001-06-08 00:21:52 +00006187}
6188
6189/*
drh23e11ca2004-05-04 17:27:28 +00006190** Write meta-information back into the database. Meta[0] is
6191** read-only and may not be written.
drh8b2f49b2001-06-08 00:21:52 +00006192*/
danielk1977aef0bf62005-12-30 16:28:01 +00006193int sqlite3BtreeUpdateMeta(Btree *p, int idx, u32 iMeta){
6194 BtShared *pBt = p->pBt;
drh4b70f112004-05-02 21:12:19 +00006195 unsigned char *pP1;
drha34b6762004-05-07 13:30:42 +00006196 int rc;
drh23e11ca2004-05-04 17:27:28 +00006197 assert( idx>=1 && idx<=15 );
drhd677b3d2007-08-20 22:48:41 +00006198 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006199 pBt->db = p->db;
danielk1977aef0bf62005-12-30 16:28:01 +00006200 if( p->inTrans!=TRANS_WRITE ){
drhd677b3d2007-08-20 22:48:41 +00006201 rc = pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
6202 }else{
6203 assert( pBt->pPage1!=0 );
6204 pP1 = pBt->pPage1->aData;
6205 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
6206 if( rc==SQLITE_OK ){
6207 put4byte(&pP1[36 + idx*4], iMeta);
danielk19774152e672007-09-12 17:01:45 +00006208#ifndef SQLITE_OMIT_AUTOVACUUM
drhd677b3d2007-08-20 22:48:41 +00006209 if( idx==7 ){
6210 assert( pBt->autoVacuum || iMeta==0 );
6211 assert( iMeta==0 || iMeta==1 );
6212 pBt->incrVacuum = iMeta;
6213 }
danielk19774152e672007-09-12 17:01:45 +00006214#endif
drhd677b3d2007-08-20 22:48:41 +00006215 }
drh5df72a52002-06-06 23:16:05 +00006216 }
drhd677b3d2007-08-20 22:48:41 +00006217 sqlite3BtreeLeave(p);
6218 return rc;
drh8b2f49b2001-06-08 00:21:52 +00006219}
drh8c42ca92001-06-22 19:15:00 +00006220
drhf328bc82004-05-10 23:29:49 +00006221/*
6222** Return the flag byte at the beginning of the page that the cursor
6223** is currently pointing to.
6224*/
6225int sqlite3BtreeFlags(BtCursor *pCur){
danielk1977da184232006-01-05 11:34:32 +00006226 /* TODO: What about CURSOR_REQUIRESEEK state? Probably need to call
drh777e4c42006-01-13 04:31:58 +00006227 ** restoreOrClearCursorPosition() here.
danielk1977da184232006-01-05 11:34:32 +00006228 */
danielk1977e448dc42008-01-02 11:50:51 +00006229 MemPage *pPage;
6230 restoreOrClearCursorPosition(pCur);
6231 pPage = pCur->pPage;
drh1fee73e2007-08-29 04:00:57 +00006232 assert( cursorHoldsMutex(pCur) );
drhd0679ed2007-08-28 22:24:34 +00006233 assert( pPage->pBt==pCur->pBt );
drhf328bc82004-05-10 23:29:49 +00006234 return pPage ? pPage->aData[pPage->hdrOffset] : 0;
6235}
6236
drhdd793422001-06-28 01:54:48 +00006237
drhdd793422001-06-28 01:54:48 +00006238/*
drh5eddca62001-06-30 21:53:53 +00006239** Return the pager associated with a BTree. This routine is used for
6240** testing and debugging only.
drhdd793422001-06-28 01:54:48 +00006241*/
danielk1977aef0bf62005-12-30 16:28:01 +00006242Pager *sqlite3BtreePager(Btree *p){
6243 return p->pBt->pPager;
drhdd793422001-06-28 01:54:48 +00006244}
drh5eddca62001-06-30 21:53:53 +00006245
drhb7f91642004-10-31 02:22:47 +00006246#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00006247/*
6248** Append a message to the error message string.
6249*/
drh2e38c322004-09-03 18:38:44 +00006250static void checkAppendMsg(
6251 IntegrityCk *pCheck,
6252 char *zMsg1,
6253 const char *zFormat,
6254 ...
6255){
6256 va_list ap;
6257 char *zMsg2;
drh1dcdbc02007-01-27 02:24:54 +00006258 if( !pCheck->mxErr ) return;
6259 pCheck->mxErr--;
6260 pCheck->nErr++;
drh2e38c322004-09-03 18:38:44 +00006261 va_start(ap, zFormat);
danielk19771e536952007-08-16 10:09:01 +00006262 zMsg2 = sqlite3VMPrintf(0, zFormat, ap);
drh2e38c322004-09-03 18:38:44 +00006263 va_end(ap);
6264 if( zMsg1==0 ) zMsg1 = "";
drh5eddca62001-06-30 21:53:53 +00006265 if( pCheck->zErrMsg ){
6266 char *zOld = pCheck->zErrMsg;
6267 pCheck->zErrMsg = 0;
danielk19774adee202004-05-08 08:23:19 +00006268 sqlite3SetString(&pCheck->zErrMsg, zOld, "\n", zMsg1, zMsg2, (char*)0);
drh17435752007-08-16 04:30:38 +00006269 sqlite3_free(zOld);
drh5eddca62001-06-30 21:53:53 +00006270 }else{
danielk19774adee202004-05-08 08:23:19 +00006271 sqlite3SetString(&pCheck->zErrMsg, zMsg1, zMsg2, (char*)0);
drh5eddca62001-06-30 21:53:53 +00006272 }
drh17435752007-08-16 04:30:38 +00006273 sqlite3_free(zMsg2);
drh5eddca62001-06-30 21:53:53 +00006274}
drhb7f91642004-10-31 02:22:47 +00006275#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00006276
drhb7f91642004-10-31 02:22:47 +00006277#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00006278/*
6279** Add 1 to the reference count for page iPage. If this is the second
6280** reference to the page, add an error message to pCheck->zErrMsg.
6281** Return 1 if there are 2 ore more references to the page and 0 if
6282** if this is the first reference to the page.
6283**
6284** Also check that the page number is in bounds.
6285*/
drhaaab5722002-02-19 13:39:21 +00006286static int checkRef(IntegrityCk *pCheck, int iPage, char *zContext){
drh5eddca62001-06-30 21:53:53 +00006287 if( iPage==0 ) return 1;
drh0de8c112002-07-06 16:32:14 +00006288 if( iPage>pCheck->nPage || iPage<0 ){
drh2e38c322004-09-03 18:38:44 +00006289 checkAppendMsg(pCheck, zContext, "invalid page number %d", iPage);
drh5eddca62001-06-30 21:53:53 +00006290 return 1;
6291 }
6292 if( pCheck->anRef[iPage]==1 ){
drh2e38c322004-09-03 18:38:44 +00006293 checkAppendMsg(pCheck, zContext, "2nd reference to page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00006294 return 1;
6295 }
6296 return (pCheck->anRef[iPage]++)>1;
6297}
6298
danielk1977afcdd022004-10-31 16:25:42 +00006299#ifndef SQLITE_OMIT_AUTOVACUUM
6300/*
6301** Check that the entry in the pointer-map for page iChild maps to
6302** page iParent, pointer type ptrType. If not, append an error message
6303** to pCheck.
6304*/
6305static void checkPtrmap(
6306 IntegrityCk *pCheck, /* Integrity check context */
6307 Pgno iChild, /* Child page number */
6308 u8 eType, /* Expected pointer map type */
6309 Pgno iParent, /* Expected pointer map parent page number */
6310 char *zContext /* Context description (used for error msg) */
6311){
6312 int rc;
6313 u8 ePtrmapType;
6314 Pgno iPtrmapParent;
6315
6316 rc = ptrmapGet(pCheck->pBt, iChild, &ePtrmapType, &iPtrmapParent);
6317 if( rc!=SQLITE_OK ){
6318 checkAppendMsg(pCheck, zContext, "Failed to read ptrmap key=%d", iChild);
6319 return;
6320 }
6321
6322 if( ePtrmapType!=eType || iPtrmapParent!=iParent ){
6323 checkAppendMsg(pCheck, zContext,
6324 "Bad ptr map entry key=%d expected=(%d,%d) got=(%d,%d)",
6325 iChild, eType, iParent, ePtrmapType, iPtrmapParent);
6326 }
6327}
6328#endif
6329
drh5eddca62001-06-30 21:53:53 +00006330/*
6331** Check the integrity of the freelist or of an overflow page list.
6332** Verify that the number of pages on the list is N.
6333*/
drh30e58752002-03-02 20:41:57 +00006334static void checkList(
6335 IntegrityCk *pCheck, /* Integrity checking context */
6336 int isFreeList, /* True for a freelist. False for overflow page list */
6337 int iPage, /* Page number for first page in the list */
6338 int N, /* Expected number of pages in the list */
6339 char *zContext /* Context for error messages */
6340){
6341 int i;
drh3a4c1412004-05-09 20:40:11 +00006342 int expected = N;
6343 int iFirst = iPage;
drh1dcdbc02007-01-27 02:24:54 +00006344 while( N-- > 0 && pCheck->mxErr ){
danielk19773b8a05f2007-03-19 17:44:26 +00006345 DbPage *pOvflPage;
6346 unsigned char *pOvflData;
drh5eddca62001-06-30 21:53:53 +00006347 if( iPage<1 ){
drh2e38c322004-09-03 18:38:44 +00006348 checkAppendMsg(pCheck, zContext,
6349 "%d of %d pages missing from overflow list starting at %d",
drh3a4c1412004-05-09 20:40:11 +00006350 N+1, expected, iFirst);
drh5eddca62001-06-30 21:53:53 +00006351 break;
6352 }
6353 if( checkRef(pCheck, iPage, zContext) ) break;
danielk19773b8a05f2007-03-19 17:44:26 +00006354 if( sqlite3PagerGet(pCheck->pPager, (Pgno)iPage, &pOvflPage) ){
drh2e38c322004-09-03 18:38:44 +00006355 checkAppendMsg(pCheck, zContext, "failed to get page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00006356 break;
6357 }
danielk19773b8a05f2007-03-19 17:44:26 +00006358 pOvflData = (unsigned char *)sqlite3PagerGetData(pOvflPage);
drh30e58752002-03-02 20:41:57 +00006359 if( isFreeList ){
danielk19773b8a05f2007-03-19 17:44:26 +00006360 int n = get4byte(&pOvflData[4]);
danielk1977687566d2004-11-02 12:56:41 +00006361#ifndef SQLITE_OMIT_AUTOVACUUM
6362 if( pCheck->pBt->autoVacuum ){
6363 checkPtrmap(pCheck, iPage, PTRMAP_FREEPAGE, 0, zContext);
6364 }
6365#endif
drh855eb1c2004-08-31 13:45:11 +00006366 if( n>pCheck->pBt->usableSize/4-8 ){
drh2e38c322004-09-03 18:38:44 +00006367 checkAppendMsg(pCheck, zContext,
6368 "freelist leaf count too big on page %d", iPage);
drhee696e22004-08-30 16:52:17 +00006369 N--;
6370 }else{
6371 for(i=0; i<n; i++){
danielk19773b8a05f2007-03-19 17:44:26 +00006372 Pgno iFreePage = get4byte(&pOvflData[8+i*4]);
danielk1977687566d2004-11-02 12:56:41 +00006373#ifndef SQLITE_OMIT_AUTOVACUUM
6374 if( pCheck->pBt->autoVacuum ){
6375 checkPtrmap(pCheck, iFreePage, PTRMAP_FREEPAGE, 0, zContext);
6376 }
6377#endif
6378 checkRef(pCheck, iFreePage, zContext);
drhee696e22004-08-30 16:52:17 +00006379 }
6380 N -= n;
drh30e58752002-03-02 20:41:57 +00006381 }
drh30e58752002-03-02 20:41:57 +00006382 }
danielk1977afcdd022004-10-31 16:25:42 +00006383#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00006384 else{
6385 /* If this database supports auto-vacuum and iPage is not the last
6386 ** page in this overflow list, check that the pointer-map entry for
6387 ** the following page matches iPage.
6388 */
6389 if( pCheck->pBt->autoVacuum && N>0 ){
danielk19773b8a05f2007-03-19 17:44:26 +00006390 i = get4byte(pOvflData);
danielk1977687566d2004-11-02 12:56:41 +00006391 checkPtrmap(pCheck, i, PTRMAP_OVERFLOW2, iPage, zContext);
6392 }
danielk1977afcdd022004-10-31 16:25:42 +00006393 }
6394#endif
danielk19773b8a05f2007-03-19 17:44:26 +00006395 iPage = get4byte(pOvflData);
6396 sqlite3PagerUnref(pOvflPage);
drh5eddca62001-06-30 21:53:53 +00006397 }
6398}
drhb7f91642004-10-31 02:22:47 +00006399#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00006400
drhb7f91642004-10-31 02:22:47 +00006401#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00006402/*
6403** Do various sanity checks on a single page of a tree. Return
6404** the tree depth. Root pages return 0. Parents of root pages
6405** return 1, and so forth.
6406**
6407** These checks are done:
6408**
6409** 1. Make sure that cells and freeblocks do not overlap
6410** but combine to completely cover the page.
drhda200cc2004-05-09 11:51:38 +00006411** NO 2. Make sure cell keys are in order.
6412** NO 3. Make sure no key is less than or equal to zLowerBound.
6413** NO 4. Make sure no key is greater than or equal to zUpperBound.
drh5eddca62001-06-30 21:53:53 +00006414** 5. Check the integrity of overflow pages.
6415** 6. Recursively call checkTreePage on all children.
6416** 7. Verify that the depth of all children is the same.
drh6019e162001-07-02 17:51:45 +00006417** 8. Make sure this page is at least 33% full or else it is
drh5eddca62001-06-30 21:53:53 +00006418** the root of the tree.
6419*/
6420static int checkTreePage(
drhaaab5722002-02-19 13:39:21 +00006421 IntegrityCk *pCheck, /* Context for the sanity check */
drh5eddca62001-06-30 21:53:53 +00006422 int iPage, /* Page number of the page to check */
6423 MemPage *pParent, /* Parent page */
drh74161702006-02-24 02:53:49 +00006424 char *zParentContext /* Parent context */
drh5eddca62001-06-30 21:53:53 +00006425){
6426 MemPage *pPage;
drhda200cc2004-05-09 11:51:38 +00006427 int i, rc, depth, d2, pgno, cnt;
drh43605152004-05-29 21:46:49 +00006428 int hdr, cellStart;
6429 int nCell;
drhda200cc2004-05-09 11:51:38 +00006430 u8 *data;
danielk1977aef0bf62005-12-30 16:28:01 +00006431 BtShared *pBt;
drh4f26bb62005-09-08 14:17:20 +00006432 int usableSize;
drh5eddca62001-06-30 21:53:53 +00006433 char zContext[100];
drh2e38c322004-09-03 18:38:44 +00006434 char *hit;
drh5eddca62001-06-30 21:53:53 +00006435
drh5bb3eb92007-05-04 13:15:55 +00006436 sqlite3_snprintf(sizeof(zContext), zContext, "Page %d: ", iPage);
danielk1977ef73ee92004-11-06 12:26:07 +00006437
drh5eddca62001-06-30 21:53:53 +00006438 /* Check that the page exists
6439 */
drhd9cb6ac2005-10-20 07:28:17 +00006440 pBt = pCheck->pBt;
drhb6f41482004-05-14 01:58:11 +00006441 usableSize = pBt->usableSize;
drh5eddca62001-06-30 21:53:53 +00006442 if( iPage==0 ) return 0;
6443 if( checkRef(pCheck, iPage, zParentContext) ) return 0;
drh16a9b832007-05-05 18:39:25 +00006444 if( (rc = sqlite3BtreeGetPage(pBt, (Pgno)iPage, &pPage, 0))!=0 ){
drh2e38c322004-09-03 18:38:44 +00006445 checkAppendMsg(pCheck, zContext,
6446 "unable to get the page. error code=%d", rc);
drh5eddca62001-06-30 21:53:53 +00006447 return 0;
6448 }
drh16a9b832007-05-05 18:39:25 +00006449 if( (rc = sqlite3BtreeInitPage(pPage, pParent))!=0 ){
6450 checkAppendMsg(pCheck, zContext,
6451 "sqlite3BtreeInitPage() returns error code %d", rc);
drh91025292004-05-03 19:49:32 +00006452 releasePage(pPage);
drh5eddca62001-06-30 21:53:53 +00006453 return 0;
6454 }
6455
6456 /* Check out all the cells.
6457 */
6458 depth = 0;
drh1dcdbc02007-01-27 02:24:54 +00006459 for(i=0; i<pPage->nCell && pCheck->mxErr; i++){
drh6f11bef2004-05-13 01:12:56 +00006460 u8 *pCell;
6461 int sz;
6462 CellInfo info;
drh5eddca62001-06-30 21:53:53 +00006463
6464 /* Check payload overflow pages
6465 */
drh5bb3eb92007-05-04 13:15:55 +00006466 sqlite3_snprintf(sizeof(zContext), zContext,
6467 "On tree page %d cell %d: ", iPage, i);
danielk19771cc5ed82007-05-16 17:28:43 +00006468 pCell = findCell(pPage,i);
drh16a9b832007-05-05 18:39:25 +00006469 sqlite3BtreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00006470 sz = info.nData;
6471 if( !pPage->intKey ) sz += info.nKey;
drh72365832007-03-06 15:53:44 +00006472 assert( sz==info.nPayload );
drh6f11bef2004-05-13 01:12:56 +00006473 if( sz>info.nLocal ){
drhb6f41482004-05-14 01:58:11 +00006474 int nPage = (sz - info.nLocal + usableSize - 5)/(usableSize - 4);
danielk1977afcdd022004-10-31 16:25:42 +00006475 Pgno pgnoOvfl = get4byte(&pCell[info.iOverflow]);
6476#ifndef SQLITE_OMIT_AUTOVACUUM
6477 if( pBt->autoVacuum ){
danielk1977687566d2004-11-02 12:56:41 +00006478 checkPtrmap(pCheck, pgnoOvfl, PTRMAP_OVERFLOW1, iPage, zContext);
danielk1977afcdd022004-10-31 16:25:42 +00006479 }
6480#endif
6481 checkList(pCheck, 0, pgnoOvfl, nPage, zContext);
drh5eddca62001-06-30 21:53:53 +00006482 }
6483
6484 /* Check sanity of left child page.
6485 */
drhda200cc2004-05-09 11:51:38 +00006486 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00006487 pgno = get4byte(pCell);
danielk1977afcdd022004-10-31 16:25:42 +00006488#ifndef SQLITE_OMIT_AUTOVACUUM
6489 if( pBt->autoVacuum ){
6490 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, zContext);
6491 }
6492#endif
drh74161702006-02-24 02:53:49 +00006493 d2 = checkTreePage(pCheck,pgno,pPage,zContext);
drhda200cc2004-05-09 11:51:38 +00006494 if( i>0 && d2!=depth ){
6495 checkAppendMsg(pCheck, zContext, "Child page depth differs");
6496 }
6497 depth = d2;
drh5eddca62001-06-30 21:53:53 +00006498 }
drh5eddca62001-06-30 21:53:53 +00006499 }
drhda200cc2004-05-09 11:51:38 +00006500 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00006501 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh5bb3eb92007-05-04 13:15:55 +00006502 sqlite3_snprintf(sizeof(zContext), zContext,
6503 "On page %d at right child: ", iPage);
danielk1977afcdd022004-10-31 16:25:42 +00006504#ifndef SQLITE_OMIT_AUTOVACUUM
6505 if( pBt->autoVacuum ){
danielk1977687566d2004-11-02 12:56:41 +00006506 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, 0);
danielk1977afcdd022004-10-31 16:25:42 +00006507 }
6508#endif
drh74161702006-02-24 02:53:49 +00006509 checkTreePage(pCheck, pgno, pPage, zContext);
drhda200cc2004-05-09 11:51:38 +00006510 }
drh5eddca62001-06-30 21:53:53 +00006511
6512 /* Check for complete coverage of the page
6513 */
drhda200cc2004-05-09 11:51:38 +00006514 data = pPage->aData;
6515 hdr = pPage->hdrOffset;
drh17435752007-08-16 04:30:38 +00006516 hit = sqlite3MallocZero( usableSize );
drh2e38c322004-09-03 18:38:44 +00006517 if( hit ){
6518 memset(hit, 1, get2byte(&data[hdr+5]));
6519 nCell = get2byte(&data[hdr+3]);
6520 cellStart = hdr + 12 - 4*pPage->leaf;
6521 for(i=0; i<nCell; i++){
6522 int pc = get2byte(&data[cellStart+i*2]);
drha9121e42008-02-19 14:59:35 +00006523 u16 size = cellSizePtr(pPage, &data[pc]);
drh2e38c322004-09-03 18:38:44 +00006524 int j;
danielk19777701e812005-01-10 12:59:51 +00006525 if( (pc+size-1)>=usableSize || pc<0 ){
6526 checkAppendMsg(pCheck, 0,
6527 "Corruption detected in cell %d on page %d",i,iPage,0);
6528 }else{
6529 for(j=pc+size-1; j>=pc; j--) hit[j]++;
6530 }
drh2e38c322004-09-03 18:38:44 +00006531 }
6532 for(cnt=0, i=get2byte(&data[hdr+1]); i>0 && i<usableSize && cnt<10000;
6533 cnt++){
6534 int size = get2byte(&data[i+2]);
6535 int j;
danielk19777701e812005-01-10 12:59:51 +00006536 if( (i+size-1)>=usableSize || i<0 ){
6537 checkAppendMsg(pCheck, 0,
6538 "Corruption detected in cell %d on page %d",i,iPage,0);
6539 }else{
6540 for(j=i+size-1; j>=i; j--) hit[j]++;
6541 }
drh2e38c322004-09-03 18:38:44 +00006542 i = get2byte(&data[i]);
6543 }
6544 for(i=cnt=0; i<usableSize; i++){
6545 if( hit[i]==0 ){
6546 cnt++;
6547 }else if( hit[i]>1 ){
6548 checkAppendMsg(pCheck, 0,
6549 "Multiple uses for byte %d of page %d", i, iPage);
6550 break;
6551 }
6552 }
6553 if( cnt!=data[hdr+7] ){
6554 checkAppendMsg(pCheck, 0,
6555 "Fragmented space is %d byte reported as %d on page %d",
6556 cnt, data[hdr+7], iPage);
drh5eddca62001-06-30 21:53:53 +00006557 }
6558 }
drh17435752007-08-16 04:30:38 +00006559 sqlite3_free(hit);
drh6019e162001-07-02 17:51:45 +00006560
drh4b70f112004-05-02 21:12:19 +00006561 releasePage(pPage);
drhda200cc2004-05-09 11:51:38 +00006562 return depth+1;
drh5eddca62001-06-30 21:53:53 +00006563}
drhb7f91642004-10-31 02:22:47 +00006564#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00006565
drhb7f91642004-10-31 02:22:47 +00006566#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00006567/*
6568** This routine does a complete check of the given BTree file. aRoot[] is
6569** an array of pages numbers were each page number is the root page of
6570** a table. nRoot is the number of entries in aRoot.
6571**
6572** If everything checks out, this routine returns NULL. If something is
6573** amiss, an error message is written into memory obtained from malloc()
6574** and a pointer to that error message is returned. The calling function
6575** is responsible for freeing the error message when it is done.
6576*/
drh1dcdbc02007-01-27 02:24:54 +00006577char *sqlite3BtreeIntegrityCheck(
6578 Btree *p, /* The btree to be checked */
6579 int *aRoot, /* An array of root pages numbers for individual trees */
6580 int nRoot, /* Number of entries in aRoot[] */
6581 int mxErr, /* Stop reporting errors after this many */
6582 int *pnErr /* Write number of errors seen to this variable */
6583){
drh5eddca62001-06-30 21:53:53 +00006584 int i;
6585 int nRef;
drhaaab5722002-02-19 13:39:21 +00006586 IntegrityCk sCheck;
danielk1977aef0bf62005-12-30 16:28:01 +00006587 BtShared *pBt = p->pBt;
drh5eddca62001-06-30 21:53:53 +00006588
drhd677b3d2007-08-20 22:48:41 +00006589 sqlite3BtreeEnter(p);
drhe5fe6902007-12-07 18:55:28 +00006590 pBt->db = p->db;
danielk19773b8a05f2007-03-19 17:44:26 +00006591 nRef = sqlite3PagerRefcount(pBt->pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00006592 if( lockBtreeWithRetry(p)!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00006593 sqlite3BtreeLeave(p);
drh17435752007-08-16 04:30:38 +00006594 return sqlite3StrDup("Unable to acquire a read lock on the database");
drhefc251d2001-07-01 22:12:01 +00006595 }
drh5eddca62001-06-30 21:53:53 +00006596 sCheck.pBt = pBt;
6597 sCheck.pPager = pBt->pPager;
danielk19773b8a05f2007-03-19 17:44:26 +00006598 sCheck.nPage = sqlite3PagerPagecount(sCheck.pPager);
drh1dcdbc02007-01-27 02:24:54 +00006599 sCheck.mxErr = mxErr;
6600 sCheck.nErr = 0;
6601 *pnErr = 0;
danielk1977e5321f02007-04-27 07:05:44 +00006602#ifndef SQLITE_OMIT_AUTOVACUUM
6603 if( pBt->nTrunc!=0 ){
6604 sCheck.nPage = pBt->nTrunc;
6605 }
6606#endif
drh0de8c112002-07-06 16:32:14 +00006607 if( sCheck.nPage==0 ){
6608 unlockBtreeIfUnused(pBt);
drhd677b3d2007-08-20 22:48:41 +00006609 sqlite3BtreeLeave(p);
drh0de8c112002-07-06 16:32:14 +00006610 return 0;
6611 }
drh17435752007-08-16 04:30:38 +00006612 sCheck.anRef = sqlite3_malloc( (sCheck.nPage+1)*sizeof(sCheck.anRef[0]) );
danielk1977ac245ec2005-01-14 13:50:11 +00006613 if( !sCheck.anRef ){
6614 unlockBtreeIfUnused(pBt);
drh1dcdbc02007-01-27 02:24:54 +00006615 *pnErr = 1;
drhd677b3d2007-08-20 22:48:41 +00006616 sqlite3BtreeLeave(p);
drhe5fe6902007-12-07 18:55:28 +00006617 return sqlite3MPrintf(p->db, "Unable to malloc %d bytes",
danielk1977ac245ec2005-01-14 13:50:11 +00006618 (sCheck.nPage+1)*sizeof(sCheck.anRef[0]));
6619 }
drhda200cc2004-05-09 11:51:38 +00006620 for(i=0; i<=sCheck.nPage; i++){ sCheck.anRef[i] = 0; }
drh42cac6d2004-11-20 20:31:11 +00006621 i = PENDING_BYTE_PAGE(pBt);
drh1f595712004-06-15 01:40:29 +00006622 if( i<=sCheck.nPage ){
6623 sCheck.anRef[i] = 1;
6624 }
drh5eddca62001-06-30 21:53:53 +00006625 sCheck.zErrMsg = 0;
6626
6627 /* Check the integrity of the freelist
6628 */
drha34b6762004-05-07 13:30:42 +00006629 checkList(&sCheck, 1, get4byte(&pBt->pPage1->aData[32]),
6630 get4byte(&pBt->pPage1->aData[36]), "Main freelist: ");
drh5eddca62001-06-30 21:53:53 +00006631
6632 /* Check all the tables.
6633 */
drh1dcdbc02007-01-27 02:24:54 +00006634 for(i=0; i<nRoot && sCheck.mxErr; i++){
drh4ff6dfa2002-03-03 23:06:00 +00006635 if( aRoot[i]==0 ) continue;
danielk1977687566d2004-11-02 12:56:41 +00006636#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00006637 if( pBt->autoVacuum && aRoot[i]>1 ){
6638 checkPtrmap(&sCheck, aRoot[i], PTRMAP_ROOTPAGE, 0, 0);
6639 }
6640#endif
drh74161702006-02-24 02:53:49 +00006641 checkTreePage(&sCheck, aRoot[i], 0, "List of tree roots: ");
drh5eddca62001-06-30 21:53:53 +00006642 }
6643
6644 /* Make sure every page in the file is referenced
6645 */
drh1dcdbc02007-01-27 02:24:54 +00006646 for(i=1; i<=sCheck.nPage && sCheck.mxErr; i++){
danielk1977afcdd022004-10-31 16:25:42 +00006647#ifdef SQLITE_OMIT_AUTOVACUUM
drh5eddca62001-06-30 21:53:53 +00006648 if( sCheck.anRef[i]==0 ){
drh2e38c322004-09-03 18:38:44 +00006649 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
drh5eddca62001-06-30 21:53:53 +00006650 }
danielk1977afcdd022004-10-31 16:25:42 +00006651#else
6652 /* If the database supports auto-vacuum, make sure no tables contain
6653 ** references to pointer-map pages.
6654 */
6655 if( sCheck.anRef[i]==0 &&
danielk1977266664d2006-02-10 08:24:21 +00006656 (PTRMAP_PAGENO(pBt, i)!=i || !pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00006657 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
6658 }
6659 if( sCheck.anRef[i]!=0 &&
danielk1977266664d2006-02-10 08:24:21 +00006660 (PTRMAP_PAGENO(pBt, i)==i && pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00006661 checkAppendMsg(&sCheck, 0, "Pointer map page %d is referenced", i);
6662 }
6663#endif
drh5eddca62001-06-30 21:53:53 +00006664 }
6665
6666 /* Make sure this analysis did not leave any unref() pages
6667 */
drh5e00f6c2001-09-13 13:46:56 +00006668 unlockBtreeIfUnused(pBt);
danielk19773b8a05f2007-03-19 17:44:26 +00006669 if( nRef != sqlite3PagerRefcount(pBt->pPager) ){
drh2e38c322004-09-03 18:38:44 +00006670 checkAppendMsg(&sCheck, 0,
drh5eddca62001-06-30 21:53:53 +00006671 "Outstanding page count goes from %d to %d during this analysis",
danielk19773b8a05f2007-03-19 17:44:26 +00006672 nRef, sqlite3PagerRefcount(pBt->pPager)
drh5eddca62001-06-30 21:53:53 +00006673 );
drh5eddca62001-06-30 21:53:53 +00006674 }
6675
6676 /* Clean up and report errors.
6677 */
drhd677b3d2007-08-20 22:48:41 +00006678 sqlite3BtreeLeave(p);
drh17435752007-08-16 04:30:38 +00006679 sqlite3_free(sCheck.anRef);
drh1dcdbc02007-01-27 02:24:54 +00006680 *pnErr = sCheck.nErr;
drh5eddca62001-06-30 21:53:53 +00006681 return sCheck.zErrMsg;
6682}
drhb7f91642004-10-31 02:22:47 +00006683#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
paulb95a8862003-04-01 21:16:41 +00006684
drh73509ee2003-04-06 20:44:45 +00006685/*
6686** Return the full pathname of the underlying database file.
drhd0679ed2007-08-28 22:24:34 +00006687**
6688** The pager filename is invariant as long as the pager is
6689** open so it is safe to access without the BtShared mutex.
drh73509ee2003-04-06 20:44:45 +00006690*/
danielk1977aef0bf62005-12-30 16:28:01 +00006691const char *sqlite3BtreeGetFilename(Btree *p){
6692 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00006693 return sqlite3PagerFilename(p->pBt->pPager);
drh73509ee2003-04-06 20:44:45 +00006694}
6695
6696/*
danielk19775865e3d2004-06-14 06:03:57 +00006697** Return the pathname of the directory that contains the database file.
drhd0679ed2007-08-28 22:24:34 +00006698**
6699** The pager directory name is invariant as long as the pager is
6700** open so it is safe to access without the BtShared mutex.
danielk19775865e3d2004-06-14 06:03:57 +00006701*/
danielk1977aef0bf62005-12-30 16:28:01 +00006702const char *sqlite3BtreeGetDirname(Btree *p){
6703 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00006704 return sqlite3PagerDirname(p->pBt->pPager);
danielk19775865e3d2004-06-14 06:03:57 +00006705}
6706
6707/*
6708** Return the pathname of the journal file for this database. The return
6709** value of this routine is the same regardless of whether the journal file
6710** has been created or not.
drhd0679ed2007-08-28 22:24:34 +00006711**
6712** The pager journal filename is invariant as long as the pager is
6713** open so it is safe to access without the BtShared mutex.
danielk19775865e3d2004-06-14 06:03:57 +00006714*/
danielk1977aef0bf62005-12-30 16:28:01 +00006715const char *sqlite3BtreeGetJournalname(Btree *p){
6716 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00006717 return sqlite3PagerJournalname(p->pBt->pPager);
danielk19775865e3d2004-06-14 06:03:57 +00006718}
6719
drhb7f91642004-10-31 02:22:47 +00006720#ifndef SQLITE_OMIT_VACUUM
danielk19775865e3d2004-06-14 06:03:57 +00006721/*
drhf7c57532003-04-25 13:22:51 +00006722** Copy the complete content of pBtFrom into pBtTo. A transaction
6723** must be active for both files.
6724**
danielk1977f653d782008-03-20 11:04:21 +00006725** The size of file pTo may be reduced by this operation.
6726** If anything goes wrong, the transaction on pTo is rolled back.
6727**
6728** If successful, CommitPhaseOne() may be called on pTo before returning.
6729** The caller should finish committing the transaction on pTo by calling
6730** sqlite3BtreeCommit().
drh73509ee2003-04-06 20:44:45 +00006731*/
drhd677b3d2007-08-20 22:48:41 +00006732static int btreeCopyFile(Btree *pTo, Btree *pFrom){
drhf7c57532003-04-25 13:22:51 +00006733 int rc = SQLITE_OK;
danielk1977f653d782008-03-20 11:04:21 +00006734 Pgno i;
6735
6736 Pgno nFromPage; /* Number of pages in pFrom */
6737 Pgno nToPage; /* Number of pages in pTo */
6738 Pgno nNewPage; /* Number of pages in pTo after the copy */
6739
6740 Pgno iSkip; /* Pending byte page in pTo */
6741 int nToPageSize; /* Page size of pTo in bytes */
6742 int nFromPageSize; /* Page size of pFrom in bytes */
drhf7c57532003-04-25 13:22:51 +00006743
danielk1977aef0bf62005-12-30 16:28:01 +00006744 BtShared *pBtTo = pTo->pBt;
6745 BtShared *pBtFrom = pFrom->pBt;
drhe5fe6902007-12-07 18:55:28 +00006746 pBtTo->db = pTo->db;
6747 pBtFrom->db = pFrom->db;
danielk1977f653d782008-03-20 11:04:21 +00006748
6749 nToPageSize = pBtTo->pageSize;
6750 nFromPageSize = pBtFrom->pageSize;
danielk1977aef0bf62005-12-30 16:28:01 +00006751
6752 if( pTo->inTrans!=TRANS_WRITE || pFrom->inTrans!=TRANS_WRITE ){
danielk1977ee5741e2004-05-31 10:01:34 +00006753 return SQLITE_ERROR;
6754 }
danielk1977f653d782008-03-20 11:04:21 +00006755 if( pBtTo->pCursor ){
6756 return SQLITE_BUSY;
drhf7c57532003-04-25 13:22:51 +00006757 }
drh538f5702007-04-13 02:14:30 +00006758
danielk1977f653d782008-03-20 11:04:21 +00006759 nToPage = sqlite3PagerPagecount(pBtTo->pPager);
6760 nFromPage = sqlite3PagerPagecount(pBtFrom->pPager);
6761 iSkip = PENDING_BYTE_PAGE(pBtTo);
6762
6763 /* Variable nNewPage is the number of pages required to store the
6764 ** contents of pFrom using the current page-size of pTo.
drh538f5702007-04-13 02:14:30 +00006765 */
danielk1977f653d782008-03-20 11:04:21 +00006766 nNewPage = ((i64)nFromPage * (i64)nFromPageSize + (i64)nToPageSize - 1) /
6767 (i64)nToPageSize;
6768
6769 for(i=1; rc==SQLITE_OK && (i<=nToPage || i<=nNewPage); i++){
6770
6771 /* Journal the original page.
6772 **
6773 ** iSkip is the page number of the locking page (PENDING_BYTE_PAGE)
6774 ** in database *pTo (before the copy). This page is never written
6775 ** into the journal file. Unless i==iSkip or the page was not
6776 ** present in pTo before the copy operation, journal page i from pTo.
6777 */
6778 if( i!=iSkip && i<=nToPage ){
6779 DbPage *pDbPage;
6780 rc = sqlite3PagerGet(pBtTo->pPager, i, &pDbPage);
6781 if( rc ){
6782 break;
6783 }
6784 rc = sqlite3PagerWrite(pDbPage);
6785 if( rc ){
6786 break;
6787 }
6788 if( i>nFromPage ){
6789 /* Yeah. It seems wierd to call DontWrite() right after Write(). But
6790 ** that is because the names of those procedures do not exactly
6791 ** represent what they do. Write() really means "put this page in the
6792 ** rollback journal and mark it as dirty so that it will be written
6793 ** to the database file later." DontWrite() undoes the second part of
6794 ** that and prevents the page from being written to the database. The
6795 ** page is still on the rollback journal, though. And that is the
6796 ** whole point of this block: to put pages on the rollback journal.
6797 */
6798 sqlite3PagerDontWrite(pDbPage);
6799 }
6800 sqlite3PagerUnref(pDbPage);
6801 }
6802
6803 /* Overwrite the data in page i of the target database */
6804 if( rc==SQLITE_OK && i!=iSkip && i<=nNewPage ){
6805
6806 DbPage *pToPage = 0;
6807 sqlite3_int64 iOff;
6808
6809 rc = sqlite3PagerGet(pBtTo->pPager, i, &pToPage);
6810 if( rc==SQLITE_OK ){
6811 rc = sqlite3PagerWrite(pToPage);
6812 }
6813
6814 for(
6815 iOff=(i-1)*nToPageSize;
6816 rc==SQLITE_OK && iOff<i*nToPageSize;
6817 iOff += nFromPageSize
6818 ){
6819 DbPage *pFromPage = 0;
6820 Pgno iFrom = (iOff/nFromPageSize)+1;
6821
6822 if( iFrom==PENDING_BYTE_PAGE(pBtFrom) ){
6823 continue;
6824 }
6825
6826 rc = sqlite3PagerGet(pBtFrom->pPager, iFrom, &pFromPage);
6827 if( rc==SQLITE_OK ){
6828 char *zTo = sqlite3PagerGetData(pToPage);
6829 char *zFrom = sqlite3PagerGetData(pFromPage);
6830 int nCopy;
6831
6832 if( nFromPageSize>=nToPageSize ){
6833 zFrom += ((i-1)*nToPageSize - ((iFrom-1)*nFromPageSize));
6834 nCopy = nToPageSize;
6835 }else{
6836 zTo += (((iFrom-1)*nFromPageSize) - (i-1)*nToPageSize);
6837 nCopy = nFromPageSize;
6838 }
6839
6840 memcpy(zTo, zFrom, nCopy);
6841 sqlite3PagerUnref(pFromPage);
6842 }
6843 }
6844
6845 if( pToPage ) sqlite3PagerUnref(pToPage);
6846 }
drh2e6d11b2003-04-25 15:37:57 +00006847 }
danielk1977f653d782008-03-20 11:04:21 +00006848
6849 /* If things have worked so far, the database file may need to be
6850 ** truncated. The complex part is that it may need to be truncated to
6851 ** a size that is not an integer multiple of nToPageSize - the current
6852 ** page size used by the pager associated with B-Tree pTo.
6853 **
6854 ** For example, say the page-size of pTo is 2048 bytes and the original
6855 ** number of pages is 5 (10 KB file). If pFrom has a page size of 1024
6856 ** bytes and 9 pages, then the file needs to be truncated to 9KB.
6857 */
6858 if( rc==SQLITE_OK ){
6859 if( nFromPageSize!=nToPageSize ){
6860 sqlite3_file *pFile = sqlite3PagerFile(pBtTo->pPager);
6861 i64 iSize = (i64)nFromPageSize * (i64)nFromPage;
6862 i64 iNow = (i64)((nToPage>nNewPage)?nToPage:nNewPage) * (i64)nToPageSize;
6863 i64 iPending = ((i64)PENDING_BYTE_PAGE(pBtTo)-1) *(i64)nToPageSize;
6864
6865 assert( iSize<=iNow );
6866
6867 /* Commit phase one syncs the journal file associated with pTo
6868 ** containing the original data. It does not sync the database file
6869 ** itself. After doing this it is safe to use OsTruncate() and other
6870 ** file APIs on the database file directly.
6871 */
6872 pBtTo->db = pTo->db;
6873 rc = sqlite3PagerCommitPhaseOne(pBtTo->pPager, 0, 0, 1);
6874 if( iSize<iNow && rc==SQLITE_OK ){
6875 rc = sqlite3OsTruncate(pFile, iSize);
6876 }
6877
6878 /* The loop that copied data from database pFrom to pTo did not
6879 ** populate the locking page of database pTo. If the page-size of
6880 ** pFrom is smaller than that of pTo, this means some data will
6881 ** not have been copied.
6882 **
6883 ** This block copies the missing data from database pFrom to pTo
6884 ** using file APIs. This is safe because at this point we know that
6885 ** all of the original data from pTo has been synced into the
6886 ** journal file. At this point it would be safe to do anything at
6887 ** all to the database file except truncate it to zero bytes.
6888 */
6889 if( rc==SQLITE_OK && nFromPageSize<nToPageSize && iSize>iPending){
6890 i64 iOff;
6891 for(
6892 iOff=iPending;
6893 rc==SQLITE_OK && iOff<(iPending+nToPageSize);
6894 iOff += nFromPageSize
6895 ){
6896 DbPage *pFromPage = 0;
6897 Pgno iFrom = (iOff/nFromPageSize)+1;
6898
6899 if( iFrom==PENDING_BYTE_PAGE(pBtFrom) || iFrom>nFromPage ){
6900 continue;
6901 }
6902
6903 rc = sqlite3PagerGet(pBtFrom->pPager, iFrom, &pFromPage);
6904 if( rc==SQLITE_OK ){
6905 char *zFrom = sqlite3PagerGetData(pFromPage);
6906 rc = sqlite3OsWrite(pFile, zFrom, nFromPageSize, iOff);
6907 sqlite3PagerUnref(pFromPage);
6908 }
6909 }
6910 }
6911
6912 /* Sync the database file */
6913 if( rc==SQLITE_OK ){
6914 rc = sqlite3PagerSync(pBtTo->pPager);
6915 }
6916 }else{
6917 rc = sqlite3PagerTruncate(pBtTo->pPager, nNewPage);
6918 }
6919 if( rc==SQLITE_OK ){
6920 pBtTo->pageSizeFixed = 0;
6921 }
drh2e6d11b2003-04-25 15:37:57 +00006922 }
drh538f5702007-04-13 02:14:30 +00006923
drhf7c57532003-04-25 13:22:51 +00006924 if( rc ){
danielk1977aef0bf62005-12-30 16:28:01 +00006925 sqlite3BtreeRollback(pTo);
drhf7c57532003-04-25 13:22:51 +00006926 }
danielk1977f653d782008-03-20 11:04:21 +00006927
drhf7c57532003-04-25 13:22:51 +00006928 return rc;
drh73509ee2003-04-06 20:44:45 +00006929}
drhd677b3d2007-08-20 22:48:41 +00006930int sqlite3BtreeCopyFile(Btree *pTo, Btree *pFrom){
6931 int rc;
6932 sqlite3BtreeEnter(pTo);
6933 sqlite3BtreeEnter(pFrom);
6934 rc = btreeCopyFile(pTo, pFrom);
6935 sqlite3BtreeLeave(pFrom);
6936 sqlite3BtreeLeave(pTo);
6937 return rc;
6938}
6939
drhb7f91642004-10-31 02:22:47 +00006940#endif /* SQLITE_OMIT_VACUUM */
danielk19771d850a72004-05-31 08:26:49 +00006941
6942/*
6943** Return non-zero if a transaction is active.
6944*/
danielk1977aef0bf62005-12-30 16:28:01 +00006945int sqlite3BtreeIsInTrans(Btree *p){
drhe5fe6902007-12-07 18:55:28 +00006946 assert( p==0 || sqlite3_mutex_held(p->db->mutex) );
danielk1977aef0bf62005-12-30 16:28:01 +00006947 return (p && (p->inTrans==TRANS_WRITE));
danielk19771d850a72004-05-31 08:26:49 +00006948}
6949
6950/*
6951** Return non-zero if a statement transaction is active.
6952*/
danielk1977aef0bf62005-12-30 16:28:01 +00006953int sqlite3BtreeIsInStmt(Btree *p){
drh1fee73e2007-08-29 04:00:57 +00006954 assert( sqlite3BtreeHoldsMutex(p) );
danielk1977aef0bf62005-12-30 16:28:01 +00006955 return (p->pBt && p->pBt->inStmt);
danielk19771d850a72004-05-31 08:26:49 +00006956}
danielk197713adf8a2004-06-03 16:08:41 +00006957
6958/*
danielk19772372c2b2006-06-27 16:34:56 +00006959** Return non-zero if a read (or write) transaction is active.
6960*/
6961int sqlite3BtreeIsInReadTrans(Btree *p){
drhe5fe6902007-12-07 18:55:28 +00006962 assert( sqlite3_mutex_held(p->db->mutex) );
danielk19772372c2b2006-06-27 16:34:56 +00006963 return (p && (p->inTrans!=TRANS_NONE));
6964}
6965
6966/*
danielk1977da184232006-01-05 11:34:32 +00006967** This function returns a pointer to a blob of memory associated with
drh85b623f2007-12-13 21:54:09 +00006968** a single shared-btree. The memory is used by client code for its own
danielk1977da184232006-01-05 11:34:32 +00006969** purposes (for example, to store a high-level schema associated with
6970** the shared-btree). The btree layer manages reference counting issues.
6971**
6972** The first time this is called on a shared-btree, nBytes bytes of memory
6973** are allocated, zeroed, and returned to the caller. For each subsequent
6974** call the nBytes parameter is ignored and a pointer to the same blob
6975** of memory returned.
6976**
6977** Just before the shared-btree is closed, the function passed as the
6978** xFree argument when the memory allocation was made is invoked on the
drh17435752007-08-16 04:30:38 +00006979** blob of allocated memory. This function should not call sqlite3_free()
danielk1977da184232006-01-05 11:34:32 +00006980** on the memory, the btree layer does that.
6981*/
6982void *sqlite3BtreeSchema(Btree *p, int nBytes, void(*xFree)(void *)){
6983 BtShared *pBt = p->pBt;
drh27641702007-08-22 02:56:42 +00006984 sqlite3BtreeEnter(p);
danielk1977da184232006-01-05 11:34:32 +00006985 if( !pBt->pSchema ){
drh17435752007-08-16 04:30:38 +00006986 pBt->pSchema = sqlite3MallocZero(nBytes);
danielk1977da184232006-01-05 11:34:32 +00006987 pBt->xFreeSchema = xFree;
6988 }
drh27641702007-08-22 02:56:42 +00006989 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +00006990 return pBt->pSchema;
6991}
6992
danielk1977c87d34d2006-01-06 13:00:28 +00006993/*
6994** Return true if another user of the same shared btree as the argument
6995** handle holds an exclusive lock on the sqlite_master table.
6996*/
6997int sqlite3BtreeSchemaLocked(Btree *p){
drh27641702007-08-22 02:56:42 +00006998 int rc;
drhe5fe6902007-12-07 18:55:28 +00006999 assert( sqlite3_mutex_held(p->db->mutex) );
drh27641702007-08-22 02:56:42 +00007000 sqlite3BtreeEnter(p);
7001 rc = (queryTableLock(p, MASTER_ROOT, READ_LOCK)!=SQLITE_OK);
7002 sqlite3BtreeLeave(p);
7003 return rc;
danielk1977c87d34d2006-01-06 13:00:28 +00007004}
7005
drha154dcd2006-03-22 22:10:07 +00007006
7007#ifndef SQLITE_OMIT_SHARED_CACHE
7008/*
7009** Obtain a lock on the table whose root page is iTab. The
7010** lock is a write lock if isWritelock is true or a read lock
7011** if it is false.
7012*/
danielk1977c00da102006-01-07 13:21:04 +00007013int sqlite3BtreeLockTable(Btree *p, int iTab, u8 isWriteLock){
danielk19772e94d4d2006-01-09 05:36:27 +00007014 int rc = SQLITE_OK;
danielk1977c00da102006-01-07 13:21:04 +00007015 u8 lockType = (isWriteLock?WRITE_LOCK:READ_LOCK);
drhd677b3d2007-08-20 22:48:41 +00007016 sqlite3BtreeEnter(p);
danielk19772e94d4d2006-01-09 05:36:27 +00007017 rc = queryTableLock(p, iTab, lockType);
danielk1977c00da102006-01-07 13:21:04 +00007018 if( rc==SQLITE_OK ){
7019 rc = lockTable(p, iTab, lockType);
7020 }
drhd677b3d2007-08-20 22:48:41 +00007021 sqlite3BtreeLeave(p);
danielk1977c00da102006-01-07 13:21:04 +00007022 return rc;
7023}
drha154dcd2006-03-22 22:10:07 +00007024#endif
danielk1977b82e7ed2006-01-11 14:09:31 +00007025
danielk1977b4e9af92007-05-01 17:49:49 +00007026#ifndef SQLITE_OMIT_INCRBLOB
7027/*
7028** Argument pCsr must be a cursor opened for writing on an
7029** INTKEY table currently pointing at a valid table entry.
7030** This function modifies the data stored as part of that entry.
7031** Only the data content may only be modified, it is not possible
7032** to change the length of the data stored.
7033*/
danielk1977dcbb5d32007-05-04 18:36:44 +00007034int sqlite3BtreePutData(BtCursor *pCsr, u32 offset, u32 amt, void *z){
drh1fee73e2007-08-29 04:00:57 +00007035 assert( cursorHoldsMutex(pCsr) );
drhe5fe6902007-12-07 18:55:28 +00007036 assert( sqlite3_mutex_held(pCsr->pBtree->db->mutex) );
danielk1977dcbb5d32007-05-04 18:36:44 +00007037 assert(pCsr->isIncrblobHandle);
drhfb982642007-08-30 01:19:59 +00007038 if( pCsr->eState>=CURSOR_REQUIRESEEK ){
7039 if( pCsr->eState==CURSOR_FAULT ){
7040 return pCsr->skip;
7041 }else{
7042 return SQLITE_ABORT;
7043 }
danielk1977dcbb5d32007-05-04 18:36:44 +00007044 }
7045
danielk1977d04417962007-05-02 13:16:30 +00007046 /* Check some preconditions:
danielk1977dcbb5d32007-05-04 18:36:44 +00007047 ** (a) the cursor is open for writing,
7048 ** (b) there is no read-lock on the table being modified and
7049 ** (c) the cursor points at a valid row of an intKey table.
danielk1977d04417962007-05-02 13:16:30 +00007050 */
danielk1977d04417962007-05-02 13:16:30 +00007051 if( !pCsr->wrFlag ){
danielk1977dcbb5d32007-05-04 18:36:44 +00007052 return SQLITE_READONLY;
danielk1977d04417962007-05-02 13:16:30 +00007053 }
drhd0679ed2007-08-28 22:24:34 +00007054 assert( !pCsr->pBt->readOnly
7055 && pCsr->pBt->inTransaction==TRANS_WRITE );
danielk1977d04417962007-05-02 13:16:30 +00007056 if( checkReadLocks(pCsr->pBtree, pCsr->pgnoRoot, pCsr) ){
7057 return SQLITE_LOCKED; /* The table pCur points to has a read lock */
7058 }
7059 if( pCsr->eState==CURSOR_INVALID || !pCsr->pPage->intKey ){
7060 return SQLITE_ERROR;
danielk1977b4e9af92007-05-01 17:49:49 +00007061 }
7062
danielk19779f8d6402007-05-02 17:48:45 +00007063 return accessPayload(pCsr, offset, amt, (unsigned char *)z, 0, 1);
danielk1977b4e9af92007-05-01 17:49:49 +00007064}
danielk19772dec9702007-05-02 16:48:37 +00007065
7066/*
7067** Set a flag on this cursor to cache the locations of pages from the
danielk1977da107192007-05-04 08:32:13 +00007068** overflow list for the current row. This is used by cursors opened
7069** for incremental blob IO only.
7070**
7071** This function sets a flag only. The actual page location cache
7072** (stored in BtCursor.aOverflow[]) is allocated and used by function
7073** accessPayload() (the worker function for sqlite3BtreeData() and
7074** sqlite3BtreePutData()).
danielk19772dec9702007-05-02 16:48:37 +00007075*/
7076void sqlite3BtreeCacheOverflow(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00007077 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00007078 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk1977dcbb5d32007-05-04 18:36:44 +00007079 assert(!pCur->isIncrblobHandle);
danielk19772dec9702007-05-02 16:48:37 +00007080 assert(!pCur->aOverflow);
danielk1977dcbb5d32007-05-04 18:36:44 +00007081 pCur->isIncrblobHandle = 1;
danielk19772dec9702007-05-02 16:48:37 +00007082}
danielk1977b4e9af92007-05-01 17:49:49 +00007083#endif