blob: 44259af3ca18649d8bce47a004b18a03acff0545 [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*************************************************************************
danielk1977171fff32009-07-11 05:06:51 +000012** $Id: btree.c,v 1.675 2009/07/11 05:06:52 danielk1977 Exp $
drh8b2f49b2001-06-08 00:21:52 +000013**
14** This file implements a external (disk-based) database using BTrees.
drha3152892007-05-05 11:48:52 +000015** See the header comment on "btreeInt.h" for additional information.
16** Including a description of file format and an overview of operation.
drha059ad02001-04-17 20:09:11 +000017*/
drha3152892007-05-05 11:48:52 +000018#include "btreeInt.h"
paulb95a8862003-04-01 21:16:41 +000019
drh8c42ca92001-06-22 19:15:00 +000020/*
drha3152892007-05-05 11:48:52 +000021** The header string that appears at the beginning of every
22** SQLite database.
drh556b2a22005-06-14 16:04:05 +000023*/
drh556b2a22005-06-14 16:04:05 +000024static const char zMagicHeader[] = SQLITE_FILE_HEADER;
drh08ed44e2001-04-29 23:32:55 +000025
drh8c42ca92001-06-22 19:15:00 +000026/*
drha3152892007-05-05 11:48:52 +000027** Set this global variable to 1 to enable tracing using the TRACE
28** macro.
drh615ae552005-01-16 23:21:00 +000029*/
drhe8f52c52008-07-12 14:52:20 +000030#if 0
danielk1977a50d9aa2009-06-08 14:49:45 +000031int sqlite3BtreeTrace=1; /* True to enable tracing */
drhe8f52c52008-07-12 14:52:20 +000032# define TRACE(X) if(sqlite3BtreeTrace){printf X;fflush(stdout);}
33#else
34# define TRACE(X)
drh615ae552005-01-16 23:21:00 +000035#endif
drh615ae552005-01-16 23:21:00 +000036
drh86f8c192007-08-22 00:39:19 +000037
38
drhe53831d2007-08-17 01:14:38 +000039#ifndef SQLITE_OMIT_SHARED_CACHE
40/*
danielk1977502b4e02008-09-02 14:07:24 +000041** A list of BtShared objects that are eligible for participation
42** in shared cache. This variable has file scope during normal builds,
43** but the test harness needs to access it so we make it global for
44** test builds.
drh7555d8e2009-03-20 13:15:30 +000045**
46** Access to this variable is protected by SQLITE_MUTEX_STATIC_MASTER.
drhe53831d2007-08-17 01:14:38 +000047*/
48#ifdef SQLITE_TEST
drh78f82d12008-09-02 00:52:52 +000049BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
drhe53831d2007-08-17 01:14:38 +000050#else
drh78f82d12008-09-02 00:52:52 +000051static BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
drhe53831d2007-08-17 01:14:38 +000052#endif
drhe53831d2007-08-17 01:14:38 +000053#endif /* SQLITE_OMIT_SHARED_CACHE */
54
55#ifndef SQLITE_OMIT_SHARED_CACHE
56/*
57** Enable or disable the shared pager and schema features.
58**
59** This routine has no effect on existing database connections.
60** The shared cache setting effects only future calls to
61** sqlite3_open(), sqlite3_open16(), or sqlite3_open_v2().
62*/
63int sqlite3_enable_shared_cache(int enable){
danielk1977502b4e02008-09-02 14:07:24 +000064 sqlite3GlobalConfig.sharedCacheEnabled = enable;
drhe53831d2007-08-17 01:14:38 +000065 return SQLITE_OK;
66}
67#endif
68
drhd677b3d2007-08-20 22:48:41 +000069
danielk1977aef0bf62005-12-30 16:28:01 +000070
71#ifdef SQLITE_OMIT_SHARED_CACHE
72 /*
drhc25eabe2009-02-24 18:57:31 +000073 ** The functions querySharedCacheTableLock(), setSharedCacheTableLock(),
74 ** and clearAllSharedCacheTableLocks()
danielk1977aef0bf62005-12-30 16:28:01 +000075 ** manipulate entries in the BtShared.pLock linked list used to store
76 ** shared-cache table level locks. If the library is compiled with the
77 ** shared-cache feature disabled, then there is only ever one user
danielk1977da184232006-01-05 11:34:32 +000078 ** of each BtShared structure and so this locking is not necessary.
79 ** So define the lock related functions as no-ops.
danielk1977aef0bf62005-12-30 16:28:01 +000080 */
drhc25eabe2009-02-24 18:57:31 +000081 #define querySharedCacheTableLock(a,b,c) SQLITE_OK
82 #define setSharedCacheTableLock(a,b,c) SQLITE_OK
83 #define clearAllSharedCacheTableLocks(a)
danielk197794b30732009-07-02 17:21:57 +000084 #define downgradeAllSharedCacheTableLocks(a)
danielk197796d48e92009-06-29 06:00:37 +000085 #define hasSharedCacheTableLock(a,b,c,d) 1
86 #define hasReadConflicts(a, b) 0
drhe53831d2007-08-17 01:14:38 +000087#endif
danielk1977aef0bf62005-12-30 16:28:01 +000088
drhe53831d2007-08-17 01:14:38 +000089#ifndef SQLITE_OMIT_SHARED_CACHE
danielk197796d48e92009-06-29 06:00:37 +000090
91#ifdef SQLITE_DEBUG
92/*
93** This function is only used as part of an assert() statement. It checks
94** that connection p holds the required locks to read or write to the
95** b-tree with root page iRoot. If so, true is returned. Otherwise, false.
96** For example, when writing to a table b-tree with root-page iRoot via
97** Btree connection pBtree:
98**
99** assert( hasSharedCacheTableLock(pBtree, iRoot, 0, WRITE_LOCK) );
100**
101** When writing to an index b-tree that resides in a sharable database, the
102** caller should have first obtained a lock specifying the root page of
103** the corresponding table b-tree. This makes things a bit more complicated,
104** as this module treats each b-tree as a separate structure. To determine
105** the table b-tree corresponding to the index b-tree being written, this
106** function has to search through the database schema.
107**
108** Instead of a lock on the b-tree rooted at page iRoot, the caller may
109** hold a write-lock on the schema table (root page 1). This is also
110** acceptable.
111*/
112static int hasSharedCacheTableLock(
113 Btree *pBtree, /* Handle that must hold lock */
114 Pgno iRoot, /* Root page of b-tree */
115 int isIndex, /* True if iRoot is the root of an index b-tree */
116 int eLockType /* Required lock type (READ_LOCK or WRITE_LOCK) */
117){
118 Schema *pSchema = (Schema *)pBtree->pBt->pSchema;
119 Pgno iTab = 0;
120 BtLock *pLock;
121
122 /* If this b-tree database is not shareable, or if the client is reading
123 ** and has the read-uncommitted flag set, then no lock is required.
124 ** In these cases return true immediately. If the client is reading
125 ** or writing an index b-tree, but the schema is not loaded, then return
126 ** true also. In this case the lock is required, but it is too difficult
127 ** to check if the client actually holds it. This doesn't happen very
128 ** often. */
129 if( (pBtree->sharable==0)
130 || (eLockType==READ_LOCK && (pBtree->db->flags & SQLITE_ReadUncommitted))
131 || (isIndex && (!pSchema || (pSchema->flags&DB_SchemaLoaded)==0 ))
132 ){
133 return 1;
134 }
135
136 /* Figure out the root-page that the lock should be held on. For table
137 ** b-trees, this is just the root page of the b-tree being read or
138 ** written. For index b-trees, it is the root page of the associated
139 ** table. */
140 if( isIndex ){
141 HashElem *p;
142 for(p=sqliteHashFirst(&pSchema->idxHash); p; p=sqliteHashNext(p)){
143 Index *pIdx = (Index *)sqliteHashData(p);
144 if( pIdx->tnum==iRoot ){
145 iTab = pIdx->pTable->tnum;
146 }
147 }
148 }else{
149 iTab = iRoot;
150 }
151
152 /* Search for the required lock. Either a write-lock on root-page iTab, a
153 ** write-lock on the schema table, or (if the client is reading) a
154 ** read-lock on iTab will suffice. Return 1 if any of these are found. */
155 for(pLock=pBtree->pBt->pLock; pLock; pLock=pLock->pNext){
156 if( pLock->pBtree==pBtree
157 && (pLock->iTable==iTab || (pLock->eLock==WRITE_LOCK && pLock->iTable==1))
158 && pLock->eLock>=eLockType
159 ){
160 return 1;
161 }
162 }
163
164 /* Failed to find the required lock. */
165 return 0;
166}
167
168/*
169** This function is also used as part of assert() statements only. It
170** returns true if there exist one or more cursors open on the table
171** with root page iRoot that do not belong to either connection pBtree
172** or some other connection that has the read-uncommitted flag set.
173**
174** For example, before writing to page iRoot:
175**
176** assert( !hasReadConflicts(pBtree, iRoot) );
177*/
178static int hasReadConflicts(Btree *pBtree, Pgno iRoot){
179 BtCursor *p;
180 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
181 if( p->pgnoRoot==iRoot
182 && p->pBtree!=pBtree
183 && 0==(p->pBtree->db->flags & SQLITE_ReadUncommitted)
184 ){
185 return 1;
186 }
187 }
188 return 0;
189}
190#endif /* #ifdef SQLITE_DEBUG */
191
danielk1977da184232006-01-05 11:34:32 +0000192/*
danielk1977aef0bf62005-12-30 16:28:01 +0000193** Query to see if btree handle p may obtain a lock of type eLock
194** (READ_LOCK or WRITE_LOCK) on the table with root-page iTab. Return
drhc25eabe2009-02-24 18:57:31 +0000195** SQLITE_OK if the lock may be obtained (by calling
196** setSharedCacheTableLock()), or SQLITE_LOCKED if not.
danielk1977aef0bf62005-12-30 16:28:01 +0000197*/
drhc25eabe2009-02-24 18:57:31 +0000198static int querySharedCacheTableLock(Btree *p, Pgno iTab, u8 eLock){
danielk1977aef0bf62005-12-30 16:28:01 +0000199 BtShared *pBt = p->pBt;
200 BtLock *pIter;
201
drh1fee73e2007-08-29 04:00:57 +0000202 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000203 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
204 assert( p->db!=0 );
danielk1977e0d9e6f2009-07-03 16:25:06 +0000205 assert( !(p->db->flags&SQLITE_ReadUncommitted)||eLock==WRITE_LOCK||iTab==1 );
drhd677b3d2007-08-20 22:48:41 +0000206
danielk19775b413d72009-04-01 09:41:54 +0000207 /* If requesting a write-lock, then the Btree must have an open write
208 ** transaction on this file. And, obviously, for this to be so there
209 ** must be an open write transaction on the file itself.
210 */
211 assert( eLock==READ_LOCK || (p==pBt->pWriter && p->inTrans==TRANS_WRITE) );
212 assert( eLock==READ_LOCK || pBt->inTransaction==TRANS_WRITE );
213
danielk1977da184232006-01-05 11:34:32 +0000214 /* This is a no-op if the shared-cache is not enabled */
drhe53831d2007-08-17 01:14:38 +0000215 if( !p->sharable ){
danielk1977da184232006-01-05 11:34:32 +0000216 return SQLITE_OK;
217 }
218
danielk1977641b0f42007-12-21 04:47:25 +0000219 /* If some other connection is holding an exclusive lock, the
220 ** requested lock may not be obtained.
221 */
danielk1977404ca072009-03-16 13:19:36 +0000222 if( pBt->pWriter!=p && pBt->isExclusive ){
223 sqlite3ConnectionBlocked(p->db, pBt->pWriter->db);
224 return SQLITE_LOCKED_SHAREDCACHE;
danielk1977641b0f42007-12-21 04:47:25 +0000225 }
226
danielk1977e0d9e6f2009-07-03 16:25:06 +0000227 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
228 /* The condition (pIter->eLock!=eLock) in the following if(...)
229 ** statement is a simplification of:
230 **
231 ** (eLock==WRITE_LOCK || pIter->eLock==WRITE_LOCK)
232 **
233 ** since we know that if eLock==WRITE_LOCK, then no other connection
234 ** may hold a WRITE_LOCK on any table in this file (since there can
235 ** only be a single writer).
236 */
237 assert( pIter->eLock==READ_LOCK || pIter->eLock==WRITE_LOCK );
238 assert( eLock==READ_LOCK || pIter->pBtree==p || pIter->eLock==READ_LOCK);
239 if( pIter->pBtree!=p && pIter->iTable==iTab && pIter->eLock!=eLock ){
240 sqlite3ConnectionBlocked(p->db, pIter->pBtree->db);
241 if( eLock==WRITE_LOCK ){
242 assert( p==pBt->pWriter );
243 pBt->isPending = 1;
danielk1977da184232006-01-05 11:34:32 +0000244 }
danielk1977e0d9e6f2009-07-03 16:25:06 +0000245 return SQLITE_LOCKED_SHAREDCACHE;
danielk1977aef0bf62005-12-30 16:28:01 +0000246 }
247 }
248 return SQLITE_OK;
249}
drhe53831d2007-08-17 01:14:38 +0000250#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000251
drhe53831d2007-08-17 01:14:38 +0000252#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000253/*
254** Add a lock on the table with root-page iTable to the shared-btree used
255** by Btree handle p. Parameter eLock must be either READ_LOCK or
256** WRITE_LOCK.
257**
danielk19779d104862009-07-09 08:27:14 +0000258** This function assumes the following:
259**
260** (a) The specified b-tree connection handle is connected to a sharable
261** b-tree database (one with the BtShared.sharable) flag set, and
262**
263** (b) No other b-tree connection handle holds a lock that conflicts
264** with the requested lock (i.e. querySharedCacheTableLock() has
265** already been called and returned SQLITE_OK).
266**
267** SQLITE_OK is returned if the lock is added successfully. SQLITE_NOMEM
268** is returned if a malloc attempt fails.
danielk1977aef0bf62005-12-30 16:28:01 +0000269*/
drhc25eabe2009-02-24 18:57:31 +0000270static int setSharedCacheTableLock(Btree *p, Pgno iTable, u8 eLock){
danielk1977aef0bf62005-12-30 16:28:01 +0000271 BtShared *pBt = p->pBt;
272 BtLock *pLock = 0;
273 BtLock *pIter;
274
drh1fee73e2007-08-29 04:00:57 +0000275 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000276 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
277 assert( p->db!=0 );
drhd677b3d2007-08-20 22:48:41 +0000278
danielk1977e0d9e6f2009-07-03 16:25:06 +0000279 /* A connection with the read-uncommitted flag set will never try to
280 ** obtain a read-lock using this function. The only read-lock obtained
281 ** by a connection in read-uncommitted mode is on the sqlite_master
282 ** table, and that lock is obtained in BtreeBeginTrans(). */
283 assert( 0==(p->db->flags&SQLITE_ReadUncommitted) || eLock==WRITE_LOCK );
284
danielk19779d104862009-07-09 08:27:14 +0000285 /* This function should only be called on a sharable b-tree after it
286 ** has been determined that no other b-tree holds a conflicting lock. */
287 assert( p->sharable );
drhc25eabe2009-02-24 18:57:31 +0000288 assert( SQLITE_OK==querySharedCacheTableLock(p, iTable, eLock) );
danielk1977aef0bf62005-12-30 16:28:01 +0000289
290 /* First search the list for an existing lock on this table. */
291 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
292 if( pIter->iTable==iTable && pIter->pBtree==p ){
293 pLock = pIter;
294 break;
295 }
296 }
297
298 /* If the above search did not find a BtLock struct associating Btree p
299 ** with table iTable, allocate one and link it into the list.
300 */
301 if( !pLock ){
drh17435752007-08-16 04:30:38 +0000302 pLock = (BtLock *)sqlite3MallocZero(sizeof(BtLock));
danielk1977aef0bf62005-12-30 16:28:01 +0000303 if( !pLock ){
304 return SQLITE_NOMEM;
305 }
306 pLock->iTable = iTable;
307 pLock->pBtree = p;
308 pLock->pNext = pBt->pLock;
309 pBt->pLock = pLock;
310 }
311
312 /* Set the BtLock.eLock variable to the maximum of the current lock
313 ** and the requested lock. This means if a write-lock was already held
314 ** and a read-lock requested, we don't incorrectly downgrade the lock.
315 */
316 assert( WRITE_LOCK>READ_LOCK );
danielk19775118b912005-12-30 16:31:53 +0000317 if( eLock>pLock->eLock ){
318 pLock->eLock = eLock;
319 }
danielk1977aef0bf62005-12-30 16:28:01 +0000320
321 return SQLITE_OK;
322}
drhe53831d2007-08-17 01:14:38 +0000323#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000324
drhe53831d2007-08-17 01:14:38 +0000325#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000326/*
drhc25eabe2009-02-24 18:57:31 +0000327** Release all the table locks (locks obtained via calls to
328** the setSharedCacheTableLock() procedure) held by Btree handle p.
danielk1977fa542f12009-04-02 18:28:08 +0000329**
330** This function assumes that handle p has an open read or write
331** transaction. If it does not, then the BtShared.isPending variable
332** may be incorrectly cleared.
danielk1977aef0bf62005-12-30 16:28:01 +0000333*/
drhc25eabe2009-02-24 18:57:31 +0000334static void clearAllSharedCacheTableLocks(Btree *p){
danielk1977641b0f42007-12-21 04:47:25 +0000335 BtShared *pBt = p->pBt;
336 BtLock **ppIter = &pBt->pLock;
danielk1977da184232006-01-05 11:34:32 +0000337
drh1fee73e2007-08-29 04:00:57 +0000338 assert( sqlite3BtreeHoldsMutex(p) );
drhe53831d2007-08-17 01:14:38 +0000339 assert( p->sharable || 0==*ppIter );
danielk1977fa542f12009-04-02 18:28:08 +0000340 assert( p->inTrans>0 );
danielk1977da184232006-01-05 11:34:32 +0000341
danielk1977aef0bf62005-12-30 16:28:01 +0000342 while( *ppIter ){
343 BtLock *pLock = *ppIter;
danielk1977404ca072009-03-16 13:19:36 +0000344 assert( pBt->isExclusive==0 || pBt->pWriter==pLock->pBtree );
danielk1977fa542f12009-04-02 18:28:08 +0000345 assert( pLock->pBtree->inTrans>=pLock->eLock );
danielk1977aef0bf62005-12-30 16:28:01 +0000346 if( pLock->pBtree==p ){
347 *ppIter = pLock->pNext;
danielk1977602b4662009-07-02 07:47:33 +0000348 assert( pLock->iTable!=1 || pLock==&p->lock );
349 if( pLock->iTable!=1 ){
350 sqlite3_free(pLock);
351 }
danielk1977aef0bf62005-12-30 16:28:01 +0000352 }else{
353 ppIter = &pLock->pNext;
354 }
355 }
danielk1977641b0f42007-12-21 04:47:25 +0000356
danielk1977404ca072009-03-16 13:19:36 +0000357 assert( pBt->isPending==0 || pBt->pWriter );
358 if( pBt->pWriter==p ){
359 pBt->pWriter = 0;
360 pBt->isExclusive = 0;
361 pBt->isPending = 0;
362 }else if( pBt->nTransaction==2 ){
363 /* This function is called when connection p is concluding its
364 ** transaction. If there currently exists a writer, and p is not
365 ** that writer, then the number of locks held by connections other
366 ** than the writer must be about to drop to zero. In this case
367 ** set the isPending flag to 0.
368 **
369 ** If there is not currently a writer, then BtShared.isPending must
370 ** be zero already. So this next line is harmless in that case.
371 */
372 pBt->isPending = 0;
danielk1977641b0f42007-12-21 04:47:25 +0000373 }
danielk1977aef0bf62005-12-30 16:28:01 +0000374}
danielk197794b30732009-07-02 17:21:57 +0000375
danielk1977e0d9e6f2009-07-03 16:25:06 +0000376/*
377** This function changes all write-locks held by connection p to read-locks.
378*/
danielk197794b30732009-07-02 17:21:57 +0000379static void downgradeAllSharedCacheTableLocks(Btree *p){
380 BtShared *pBt = p->pBt;
381 if( pBt->pWriter==p ){
382 BtLock *pLock;
383 pBt->pWriter = 0;
384 pBt->isExclusive = 0;
385 pBt->isPending = 0;
386 for(pLock=pBt->pLock; pLock; pLock=pLock->pNext){
387 assert( pLock->eLock==READ_LOCK || pLock->pBtree==p );
388 pLock->eLock = READ_LOCK;
389 }
390 }
391}
392
danielk1977aef0bf62005-12-30 16:28:01 +0000393#endif /* SQLITE_OMIT_SHARED_CACHE */
394
drh980b1a72006-08-16 16:42:48 +0000395static void releasePage(MemPage *pPage); /* Forward reference */
396
drh1fee73e2007-08-29 04:00:57 +0000397/*
398** Verify that the cursor holds a mutex on the BtShared
399*/
400#ifndef NDEBUG
401static int cursorHoldsMutex(BtCursor *p){
drhff0587c2007-08-29 17:43:19 +0000402 return sqlite3_mutex_held(p->pBt->mutex);
drh1fee73e2007-08-29 04:00:57 +0000403}
404#endif
405
406
danielk197792d4d7a2007-05-04 12:05:56 +0000407#ifndef SQLITE_OMIT_INCRBLOB
408/*
409** Invalidate the overflow page-list cache for cursor pCur, if any.
410*/
411static void invalidateOverflowCache(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000412 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000413 sqlite3_free(pCur->aOverflow);
danielk197792d4d7a2007-05-04 12:05:56 +0000414 pCur->aOverflow = 0;
415}
416
417/*
418** Invalidate the overflow page-list cache for all cursors opened
419** on the shared btree structure pBt.
420*/
421static void invalidateAllOverflowCache(BtShared *pBt){
422 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000423 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +0000424 for(p=pBt->pCursor; p; p=p->pNext){
425 invalidateOverflowCache(p);
426 }
427}
danielk197796d48e92009-06-29 06:00:37 +0000428
429/*
430** This function is called before modifying the contents of a table
431** b-tree to invalidate any incrblob cursors that are open on the
432** row or one of the rows being modified. Argument pgnoRoot is the
433** root-page of the table b-tree.
434**
435** If argument isClearTable is true, then the entire contents of the
436** table is about to be deleted. In this case invalidate all incrblob
437** cursors open on any row within the table with root-page pgnoRoot.
438**
439** Otherwise, if argument isClearTable is false, then the row with
440** rowid iRow is being replaced or deleted. In this case invalidate
441** only those incrblob cursors open on this specific row.
442*/
443static void invalidateIncrblobCursors(
444 Btree *pBtree, /* The database file to check */
445 Pgno pgnoRoot, /* Look for read cursors on this btree */
446 i64 iRow, /* The rowid that might be changing */
447 int isClearTable /* True if all rows are being deleted */
448){
449 BtCursor *p;
450 BtShared *pBt = pBtree->pBt;
451 assert( sqlite3BtreeHoldsMutex(pBtree) );
452 for(p=pBt->pCursor; p; p=p->pNext){
453 if( p->isIncrblobHandle && (isClearTable || p->info.nKey==iRow) ){
454 p->eState = CURSOR_INVALID;
455 }
456 }
457}
458
danielk197792d4d7a2007-05-04 12:05:56 +0000459#else
460 #define invalidateOverflowCache(x)
461 #define invalidateAllOverflowCache(x)
danielk197796d48e92009-06-29 06:00:37 +0000462 #define invalidateIncrblobCursors(w,x,y,z)
danielk197792d4d7a2007-05-04 12:05:56 +0000463#endif
464
drh980b1a72006-08-16 16:42:48 +0000465/*
danielk1977bea2a942009-01-20 17:06:27 +0000466** Set bit pgno of the BtShared.pHasContent bitvec. This is called
467** when a page that previously contained data becomes a free-list leaf
468** page.
469**
470** The BtShared.pHasContent bitvec exists to work around an obscure
471** bug caused by the interaction of two useful IO optimizations surrounding
472** free-list leaf pages:
473**
474** 1) When all data is deleted from a page and the page becomes
475** a free-list leaf page, the page is not written to the database
476** (as free-list leaf pages contain no meaningful data). Sometimes
477** such a page is not even journalled (as it will not be modified,
478** why bother journalling it?).
479**
480** 2) When a free-list leaf page is reused, its content is not read
481** from the database or written to the journal file (why should it
482** be, if it is not at all meaningful?).
483**
484** By themselves, these optimizations work fine and provide a handy
485** performance boost to bulk delete or insert operations. However, if
486** a page is moved to the free-list and then reused within the same
487** transaction, a problem comes up. If the page is not journalled when
488** it is moved to the free-list and it is also not journalled when it
489** is extracted from the free-list and reused, then the original data
490** may be lost. In the event of a rollback, it may not be possible
491** to restore the database to its original configuration.
492**
493** The solution is the BtShared.pHasContent bitvec. Whenever a page is
494** moved to become a free-list leaf page, the corresponding bit is
495** set in the bitvec. Whenever a leaf page is extracted from the free-list,
496** optimization 2 above is ommitted if the corresponding bit is already
497** set in BtShared.pHasContent. The contents of the bitvec are cleared
498** at the end of every transaction.
499*/
500static int btreeSetHasContent(BtShared *pBt, Pgno pgno){
501 int rc = SQLITE_OK;
502 if( !pBt->pHasContent ){
503 int nPage;
504 rc = sqlite3PagerPagecount(pBt->pPager, &nPage);
505 if( rc==SQLITE_OK ){
506 pBt->pHasContent = sqlite3BitvecCreate((u32)nPage);
507 if( !pBt->pHasContent ){
508 rc = SQLITE_NOMEM;
509 }
510 }
511 }
512 if( rc==SQLITE_OK && pgno<=sqlite3BitvecSize(pBt->pHasContent) ){
513 rc = sqlite3BitvecSet(pBt->pHasContent, pgno);
514 }
515 return rc;
516}
517
518/*
519** Query the BtShared.pHasContent vector.
520**
521** This function is called when a free-list leaf page is removed from the
522** free-list for reuse. It returns false if it is safe to retrieve the
523** page from the pager layer with the 'no-content' flag set. True otherwise.
524*/
525static int btreeGetHasContent(BtShared *pBt, Pgno pgno){
526 Bitvec *p = pBt->pHasContent;
527 return (p && (pgno>sqlite3BitvecSize(p) || sqlite3BitvecTest(p, pgno)));
528}
529
530/*
531** Clear (destroy) the BtShared.pHasContent bitvec. This should be
532** invoked at the conclusion of each write-transaction.
533*/
534static void btreeClearHasContent(BtShared *pBt){
535 sqlite3BitvecDestroy(pBt->pHasContent);
536 pBt->pHasContent = 0;
537}
538
539/*
drh980b1a72006-08-16 16:42:48 +0000540** Save the current cursor position in the variables BtCursor.nKey
541** and BtCursor.pKey. The cursor's state is set to CURSOR_REQUIRESEEK.
542*/
543static int saveCursorPosition(BtCursor *pCur){
544 int rc;
545
546 assert( CURSOR_VALID==pCur->eState );
547 assert( 0==pCur->pKey );
drh1fee73e2007-08-29 04:00:57 +0000548 assert( cursorHoldsMutex(pCur) );
drh980b1a72006-08-16 16:42:48 +0000549
550 rc = sqlite3BtreeKeySize(pCur, &pCur->nKey);
551
552 /* If this is an intKey table, then the above call to BtreeKeySize()
553 ** stores the integer key in pCur->nKey. In this case this value is
554 ** all that is required. Otherwise, if pCur is not open on an intKey
555 ** table, then malloc space for and store the pCur->nKey bytes of key
556 ** data.
557 */
danielk197771d5d2c2008-09-29 11:49:47 +0000558 if( rc==SQLITE_OK && 0==pCur->apPage[0]->intKey){
drhf49661a2008-12-10 16:45:50 +0000559 void *pKey = sqlite3Malloc( (int)pCur->nKey );
drh980b1a72006-08-16 16:42:48 +0000560 if( pKey ){
drhf49661a2008-12-10 16:45:50 +0000561 rc = sqlite3BtreeKey(pCur, 0, (int)pCur->nKey, pKey);
drh980b1a72006-08-16 16:42:48 +0000562 if( rc==SQLITE_OK ){
563 pCur->pKey = pKey;
564 }else{
drh17435752007-08-16 04:30:38 +0000565 sqlite3_free(pKey);
drh980b1a72006-08-16 16:42:48 +0000566 }
567 }else{
568 rc = SQLITE_NOMEM;
569 }
570 }
danielk197771d5d2c2008-09-29 11:49:47 +0000571 assert( !pCur->apPage[0]->intKey || !pCur->pKey );
drh980b1a72006-08-16 16:42:48 +0000572
573 if( rc==SQLITE_OK ){
danielk197771d5d2c2008-09-29 11:49:47 +0000574 int i;
575 for(i=0; i<=pCur->iPage; i++){
576 releasePage(pCur->apPage[i]);
577 pCur->apPage[i] = 0;
578 }
579 pCur->iPage = -1;
drh980b1a72006-08-16 16:42:48 +0000580 pCur->eState = CURSOR_REQUIRESEEK;
581 }
582
danielk197792d4d7a2007-05-04 12:05:56 +0000583 invalidateOverflowCache(pCur);
drh980b1a72006-08-16 16:42:48 +0000584 return rc;
585}
586
587/*
588** Save the positions of all cursors except pExcept open on the table
589** with root-page iRoot. Usually, this is called just before cursor
590** pExcept is used to modify the table (BtreeDelete() or BtreeInsert()).
591*/
592static int saveAllCursors(BtShared *pBt, Pgno iRoot, BtCursor *pExcept){
593 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000594 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +0000595 assert( pExcept==0 || pExcept->pBt==pBt );
drh980b1a72006-08-16 16:42:48 +0000596 for(p=pBt->pCursor; p; p=p->pNext){
597 if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) &&
598 p->eState==CURSOR_VALID ){
599 int rc = saveCursorPosition(p);
600 if( SQLITE_OK!=rc ){
601 return rc;
602 }
603 }
604 }
605 return SQLITE_OK;
606}
607
608/*
drhbf700f32007-03-31 02:36:44 +0000609** Clear the current cursor position.
610*/
danielk1977be51a652008-10-08 17:58:48 +0000611void sqlite3BtreeClearCursor(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000612 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000613 sqlite3_free(pCur->pKey);
drhbf700f32007-03-31 02:36:44 +0000614 pCur->pKey = 0;
615 pCur->eState = CURSOR_INVALID;
616}
617
618/*
danielk19773509a652009-07-06 18:56:13 +0000619** In this version of BtreeMoveto, pKey is a packed index record
620** such as is generated by the OP_MakeRecord opcode. Unpack the
621** record and then call BtreeMovetoUnpacked() to do the work.
622*/
623static int btreeMoveto(
624 BtCursor *pCur, /* Cursor open on the btree to be searched */
625 const void *pKey, /* Packed key if the btree is an index */
626 i64 nKey, /* Integer key for tables. Size of pKey for indices */
627 int bias, /* Bias search to the high end */
628 int *pRes /* Write search results here */
629){
630 int rc; /* Status code */
631 UnpackedRecord *pIdxKey; /* Unpacked index key */
632 char aSpace[150]; /* Temp space for pIdxKey - to avoid a malloc */
633
634 if( pKey ){
635 assert( nKey==(i64)(int)nKey );
636 pIdxKey = sqlite3VdbeRecordUnpack(pCur->pKeyInfo, (int)nKey, pKey,
637 aSpace, sizeof(aSpace));
638 if( pIdxKey==0 ) return SQLITE_NOMEM;
639 }else{
640 pIdxKey = 0;
641 }
642 rc = sqlite3BtreeMovetoUnpacked(pCur, pIdxKey, nKey, bias, pRes);
643 if( pKey ){
644 sqlite3VdbeDeleteUnpackedRecord(pIdxKey);
645 }
646 return rc;
647}
648
649/*
drh980b1a72006-08-16 16:42:48 +0000650** Restore the cursor to the position it was in (or as close to as possible)
651** when saveCursorPosition() was called. Note that this call deletes the
652** saved position info stored by saveCursorPosition(), so there can be
drha3460582008-07-11 21:02:53 +0000653** at most one effective restoreCursorPosition() call after each
drh980b1a72006-08-16 16:42:48 +0000654** saveCursorPosition().
drh980b1a72006-08-16 16:42:48 +0000655*/
danielk197730548662009-07-09 05:07:37 +0000656static int btreeRestoreCursorPosition(BtCursor *pCur){
drhbf700f32007-03-31 02:36:44 +0000657 int rc;
drh1fee73e2007-08-29 04:00:57 +0000658 assert( cursorHoldsMutex(pCur) );
drhfb982642007-08-30 01:19:59 +0000659 assert( pCur->eState>=CURSOR_REQUIRESEEK );
660 if( pCur->eState==CURSOR_FAULT ){
661 return pCur->skip;
662 }
drh980b1a72006-08-16 16:42:48 +0000663 pCur->eState = CURSOR_INVALID;
danielk19773509a652009-07-06 18:56:13 +0000664 rc = btreeMoveto(pCur, pCur->pKey, pCur->nKey, 0, &pCur->skip);
drh980b1a72006-08-16 16:42:48 +0000665 if( rc==SQLITE_OK ){
drh17435752007-08-16 04:30:38 +0000666 sqlite3_free(pCur->pKey);
drh980b1a72006-08-16 16:42:48 +0000667 pCur->pKey = 0;
drhbf700f32007-03-31 02:36:44 +0000668 assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_INVALID );
drh980b1a72006-08-16 16:42:48 +0000669 }
670 return rc;
671}
672
drha3460582008-07-11 21:02:53 +0000673#define restoreCursorPosition(p) \
drhfb982642007-08-30 01:19:59 +0000674 (p->eState>=CURSOR_REQUIRESEEK ? \
danielk197730548662009-07-09 05:07:37 +0000675 btreeRestoreCursorPosition(p) : \
drh16a9b832007-05-05 18:39:25 +0000676 SQLITE_OK)
drh980b1a72006-08-16 16:42:48 +0000677
drha3460582008-07-11 21:02:53 +0000678/*
679** Determine whether or not a cursor has moved from the position it
drhdfe88ec2008-11-03 20:55:06 +0000680** was last placed at. Cursors can move when the row they are pointing
drha3460582008-07-11 21:02:53 +0000681** at is deleted out from under them.
682**
683** This routine returns an error code if something goes wrong. The
684** integer *pHasMoved is set to one if the cursor has moved and 0 if not.
685*/
686int sqlite3BtreeCursorHasMoved(BtCursor *pCur, int *pHasMoved){
687 int rc;
688
689 rc = restoreCursorPosition(pCur);
690 if( rc ){
691 *pHasMoved = 1;
692 return rc;
693 }
694 if( pCur->eState!=CURSOR_VALID || pCur->skip!=0 ){
695 *pHasMoved = 1;
696 }else{
697 *pHasMoved = 0;
698 }
699 return SQLITE_OK;
700}
701
danielk1977599fcba2004-11-08 07:13:13 +0000702#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977afcdd022004-10-31 16:25:42 +0000703/*
drha3152892007-05-05 11:48:52 +0000704** Given a page number of a regular database page, return the page
705** number for the pointer-map page that contains the entry for the
706** input page number.
danielk1977afcdd022004-10-31 16:25:42 +0000707*/
danielk1977266664d2006-02-10 08:24:21 +0000708static Pgno ptrmapPageno(BtShared *pBt, Pgno pgno){
danielk197789d40042008-11-17 14:20:56 +0000709 int nPagesPerMapPage;
710 Pgno iPtrMap, ret;
drh1fee73e2007-08-29 04:00:57 +0000711 assert( sqlite3_mutex_held(pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000712 nPagesPerMapPage = (pBt->usableSize/5)+1;
713 iPtrMap = (pgno-2)/nPagesPerMapPage;
714 ret = (iPtrMap*nPagesPerMapPage) + 2;
danielk1977266664d2006-02-10 08:24:21 +0000715 if( ret==PENDING_BYTE_PAGE(pBt) ){
716 ret++;
717 }
718 return ret;
719}
danielk1977a19df672004-11-03 11:37:07 +0000720
danielk1977afcdd022004-10-31 16:25:42 +0000721/*
danielk1977afcdd022004-10-31 16:25:42 +0000722** Write an entry into the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000723**
724** This routine updates the pointer map entry for page number 'key'
725** so that it maps to type 'eType' and parent page number 'pgno'.
726** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +0000727*/
danielk1977aef0bf62005-12-30 16:28:01 +0000728static int ptrmapPut(BtShared *pBt, Pgno key, u8 eType, Pgno parent){
danielk19773b8a05f2007-03-19 17:44:26 +0000729 DbPage *pDbPage; /* The pointer map page */
730 u8 *pPtrmap; /* The pointer map data */
731 Pgno iPtrmap; /* The pointer map page number */
732 int offset; /* Offset in pointer map page */
danielk1977afcdd022004-10-31 16:25:42 +0000733 int rc;
734
drh1fee73e2007-08-29 04:00:57 +0000735 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977266664d2006-02-10 08:24:21 +0000736 /* The master-journal page number must never be used as a pointer map page */
737 assert( 0==PTRMAP_ISPAGE(pBt, PENDING_BYTE_PAGE(pBt)) );
738
danielk1977ac11ee62005-01-15 12:45:51 +0000739 assert( pBt->autoVacuum );
danielk1977fdb7cdb2005-01-17 02:12:18 +0000740 if( key==0 ){
drh49285702005-09-17 15:20:26 +0000741 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +0000742 }
danielk1977266664d2006-02-10 08:24:21 +0000743 iPtrmap = PTRMAP_PAGENO(pBt, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000744 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage);
danielk1977687566d2004-11-02 12:56:41 +0000745 if( rc!=SQLITE_OK ){
danielk1977afcdd022004-10-31 16:25:42 +0000746 return rc;
747 }
danielk19778c666b12008-07-18 09:34:57 +0000748 offset = PTRMAP_PTROFFSET(iPtrmap, key);
drhacfc72b2009-06-05 18:44:15 +0000749 if( offset<0 ){
drh4925a552009-07-07 11:39:58 +0000750 rc = SQLITE_CORRUPT_BKPT;
751 goto ptrmap_exit;
drhacfc72b2009-06-05 18:44:15 +0000752 }
danielk19773b8a05f2007-03-19 17:44:26 +0000753 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000754
drh615ae552005-01-16 23:21:00 +0000755 if( eType!=pPtrmap[offset] || get4byte(&pPtrmap[offset+1])!=parent ){
756 TRACE(("PTRMAP_UPDATE: %d->(%d,%d)\n", key, eType, parent));
danielk19773b8a05f2007-03-19 17:44:26 +0000757 rc = sqlite3PagerWrite(pDbPage);
danielk19775558a8a2005-01-17 07:53:44 +0000758 if( rc==SQLITE_OK ){
759 pPtrmap[offset] = eType;
760 put4byte(&pPtrmap[offset+1], parent);
danielk1977afcdd022004-10-31 16:25:42 +0000761 }
danielk1977afcdd022004-10-31 16:25:42 +0000762 }
763
drh4925a552009-07-07 11:39:58 +0000764ptrmap_exit:
danielk19773b8a05f2007-03-19 17:44:26 +0000765 sqlite3PagerUnref(pDbPage);
danielk19775558a8a2005-01-17 07:53:44 +0000766 return rc;
danielk1977afcdd022004-10-31 16:25:42 +0000767}
768
769/*
770** Read an entry from the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000771**
772** This routine retrieves the pointer map entry for page 'key', writing
773** the type and parent page number to *pEType and *pPgno respectively.
774** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +0000775*/
danielk1977aef0bf62005-12-30 16:28:01 +0000776static int ptrmapGet(BtShared *pBt, Pgno key, u8 *pEType, Pgno *pPgno){
danielk19773b8a05f2007-03-19 17:44:26 +0000777 DbPage *pDbPage; /* The pointer map page */
danielk1977afcdd022004-10-31 16:25:42 +0000778 int iPtrmap; /* Pointer map page index */
779 u8 *pPtrmap; /* Pointer map page data */
780 int offset; /* Offset of entry in pointer map */
781 int rc;
782
drh1fee73e2007-08-29 04:00:57 +0000783 assert( sqlite3_mutex_held(pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000784
danielk1977266664d2006-02-10 08:24:21 +0000785 iPtrmap = PTRMAP_PAGENO(pBt, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000786 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000787 if( rc!=0 ){
788 return rc;
789 }
danielk19773b8a05f2007-03-19 17:44:26 +0000790 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000791
danielk19778c666b12008-07-18 09:34:57 +0000792 offset = PTRMAP_PTROFFSET(iPtrmap, key);
drh43617e92006-03-06 20:55:46 +0000793 assert( pEType!=0 );
794 *pEType = pPtrmap[offset];
danielk1977687566d2004-11-02 12:56:41 +0000795 if( pPgno ) *pPgno = get4byte(&pPtrmap[offset+1]);
danielk1977afcdd022004-10-31 16:25:42 +0000796
danielk19773b8a05f2007-03-19 17:44:26 +0000797 sqlite3PagerUnref(pDbPage);
drh49285702005-09-17 15:20:26 +0000798 if( *pEType<1 || *pEType>5 ) return SQLITE_CORRUPT_BKPT;
danielk1977afcdd022004-10-31 16:25:42 +0000799 return SQLITE_OK;
800}
801
danielk197785d90ca2008-07-19 14:25:15 +0000802#else /* if defined SQLITE_OMIT_AUTOVACUUM */
803 #define ptrmapPut(w,x,y,z) SQLITE_OK
804 #define ptrmapGet(w,x,y,z) SQLITE_OK
danielk1977325ccfa2009-07-02 05:23:25 +0000805 #define ptrmapPutOvflPtr(x, y) SQLITE_OK
danielk197785d90ca2008-07-19 14:25:15 +0000806#endif
danielk1977afcdd022004-10-31 16:25:42 +0000807
drh0d316a42002-08-11 20:10:47 +0000808/*
drh271efa52004-05-30 19:19:05 +0000809** Given a btree page and a cell index (0 means the first cell on
810** the page, 1 means the second cell, and so forth) return a pointer
811** to the cell content.
812**
813** This routine works only for pages that do not contain overflow cells.
drh3aac2dd2004-04-26 14:10:20 +0000814*/
drh1688c862008-07-18 02:44:17 +0000815#define findCell(P,I) \
816 ((P)->aData + ((P)->maskPage & get2byte(&(P)->aData[(P)->cellOffset+2*(I)])))
drh43605152004-05-29 21:46:49 +0000817
818/*
drh93a960a2008-07-10 00:32:42 +0000819** This a more complex version of findCell() that works for
drh0a45c272009-07-08 01:49:11 +0000820** pages that do contain overflow cells.
drh43605152004-05-29 21:46:49 +0000821*/
822static u8 *findOverflowCell(MemPage *pPage, int iCell){
823 int i;
drh1fee73e2007-08-29 04:00:57 +0000824 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh43605152004-05-29 21:46:49 +0000825 for(i=pPage->nOverflow-1; i>=0; i--){
drh6d08b4d2004-07-20 12:45:22 +0000826 int k;
827 struct _OvflCell *pOvfl;
828 pOvfl = &pPage->aOvfl[i];
829 k = pOvfl->idx;
830 if( k<=iCell ){
831 if( k==iCell ){
832 return pOvfl->pCell;
drh43605152004-05-29 21:46:49 +0000833 }
834 iCell--;
835 }
836 }
danielk19771cc5ed82007-05-16 17:28:43 +0000837 return findCell(pPage, iCell);
drh43605152004-05-29 21:46:49 +0000838}
839
840/*
841** Parse a cell content block and fill in the CellInfo structure. There
danielk197730548662009-07-09 05:07:37 +0000842** are two versions of this function. btreeParseCell() takes a
843** cell index as the second argument and btreeParseCellPtr()
drh16a9b832007-05-05 18:39:25 +0000844** takes a pointer to the body of the cell as its second argument.
danielk19771cc5ed82007-05-16 17:28:43 +0000845**
846** Within this file, the parseCell() macro can be called instead of
danielk197730548662009-07-09 05:07:37 +0000847** btreeParseCellPtr(). Using some compilers, this will be faster.
drh43605152004-05-29 21:46:49 +0000848*/
danielk197730548662009-07-09 05:07:37 +0000849static void btreeParseCellPtr(
drh3aac2dd2004-04-26 14:10:20 +0000850 MemPage *pPage, /* Page containing the cell */
drh43605152004-05-29 21:46:49 +0000851 u8 *pCell, /* Pointer to the cell text. */
drh6f11bef2004-05-13 01:12:56 +0000852 CellInfo *pInfo /* Fill in this structure */
drh3aac2dd2004-04-26 14:10:20 +0000853){
drhf49661a2008-12-10 16:45:50 +0000854 u16 n; /* Number bytes in cell content header */
drh271efa52004-05-30 19:19:05 +0000855 u32 nPayload; /* Number of bytes of cell payload */
drh43605152004-05-29 21:46:49 +0000856
drh1fee73e2007-08-29 04:00:57 +0000857 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000858
drh43605152004-05-29 21:46:49 +0000859 pInfo->pCell = pCell;
drhab01f612004-05-22 02:55:23 +0000860 assert( pPage->leaf==0 || pPage->leaf==1 );
drh271efa52004-05-30 19:19:05 +0000861 n = pPage->childPtrSize;
862 assert( n==4-4*pPage->leaf );
drh504b6982006-01-22 21:52:56 +0000863 if( pPage->intKey ){
drh79df1f42008-07-18 00:57:33 +0000864 if( pPage->hasData ){
865 n += getVarint32(&pCell[n], nPayload);
866 }else{
867 nPayload = 0;
868 }
drh1bd10f82008-12-10 21:19:56 +0000869 n += getVarint(&pCell[n], (u64*)&pInfo->nKey);
drh79df1f42008-07-18 00:57:33 +0000870 pInfo->nData = nPayload;
drh504b6982006-01-22 21:52:56 +0000871 }else{
drh79df1f42008-07-18 00:57:33 +0000872 pInfo->nData = 0;
873 n += getVarint32(&pCell[n], nPayload);
874 pInfo->nKey = nPayload;
drh6f11bef2004-05-13 01:12:56 +0000875 }
drh72365832007-03-06 15:53:44 +0000876 pInfo->nPayload = nPayload;
drh504b6982006-01-22 21:52:56 +0000877 pInfo->nHeader = n;
drh0a45c272009-07-08 01:49:11 +0000878 testcase( nPayload==pPage->maxLocal );
879 testcase( nPayload==pPage->maxLocal+1 );
drh79df1f42008-07-18 00:57:33 +0000880 if( likely(nPayload<=pPage->maxLocal) ){
drh271efa52004-05-30 19:19:05 +0000881 /* This is the (easy) common case where the entire payload fits
882 ** on the local page. No overflow is required.
883 */
884 int nSize; /* Total size of cell content in bytes */
drh79df1f42008-07-18 00:57:33 +0000885 nSize = nPayload + n;
drhf49661a2008-12-10 16:45:50 +0000886 pInfo->nLocal = (u16)nPayload;
drh6f11bef2004-05-13 01:12:56 +0000887 pInfo->iOverflow = 0;
drh79df1f42008-07-18 00:57:33 +0000888 if( (nSize & ~3)==0 ){
drh271efa52004-05-30 19:19:05 +0000889 nSize = 4; /* Minimum cell size is 4 */
drh43605152004-05-29 21:46:49 +0000890 }
drh1bd10f82008-12-10 21:19:56 +0000891 pInfo->nSize = (u16)nSize;
drh6f11bef2004-05-13 01:12:56 +0000892 }else{
drh271efa52004-05-30 19:19:05 +0000893 /* If the payload will not fit completely on the local page, we have
894 ** to decide how much to store locally and how much to spill onto
895 ** overflow pages. The strategy is to minimize the amount of unused
896 ** space on overflow pages while keeping the amount of local storage
897 ** in between minLocal and maxLocal.
898 **
899 ** Warning: changing the way overflow payload is distributed in any
900 ** way will result in an incompatible file format.
901 */
902 int minLocal; /* Minimum amount of payload held locally */
903 int maxLocal; /* Maximum amount of payload held locally */
904 int surplus; /* Overflow payload available for local storage */
905
906 minLocal = pPage->minLocal;
907 maxLocal = pPage->maxLocal;
908 surplus = minLocal + (nPayload - minLocal)%(pPage->pBt->usableSize - 4);
drh0a45c272009-07-08 01:49:11 +0000909 testcase( surplus==maxLocal );
910 testcase( surplus==maxLocal+1 );
drh6f11bef2004-05-13 01:12:56 +0000911 if( surplus <= maxLocal ){
drhf49661a2008-12-10 16:45:50 +0000912 pInfo->nLocal = (u16)surplus;
drh6f11bef2004-05-13 01:12:56 +0000913 }else{
drhf49661a2008-12-10 16:45:50 +0000914 pInfo->nLocal = (u16)minLocal;
drh6f11bef2004-05-13 01:12:56 +0000915 }
drhf49661a2008-12-10 16:45:50 +0000916 pInfo->iOverflow = (u16)(pInfo->nLocal + n);
drh6f11bef2004-05-13 01:12:56 +0000917 pInfo->nSize = pInfo->iOverflow + 4;
918 }
drh3aac2dd2004-04-26 14:10:20 +0000919}
danielk19771cc5ed82007-05-16 17:28:43 +0000920#define parseCell(pPage, iCell, pInfo) \
danielk197730548662009-07-09 05:07:37 +0000921 btreeParseCellPtr((pPage), findCell((pPage), (iCell)), (pInfo))
922static void btreeParseCell(
drh43605152004-05-29 21:46:49 +0000923 MemPage *pPage, /* Page containing the cell */
924 int iCell, /* The cell index. First cell is 0 */
925 CellInfo *pInfo /* Fill in this structure */
926){
danielk19771cc5ed82007-05-16 17:28:43 +0000927 parseCell(pPage, iCell, pInfo);
drh43605152004-05-29 21:46:49 +0000928}
drh3aac2dd2004-04-26 14:10:20 +0000929
930/*
drh43605152004-05-29 21:46:49 +0000931** Compute the total number of bytes that a Cell needs in the cell
932** data area of the btree-page. The return number includes the cell
933** data header and the local payload, but not any overflow page or
934** the space used by the cell pointer.
drh3b7511c2001-05-26 13:15:44 +0000935*/
danielk1977ae5558b2009-04-29 11:31:47 +0000936static u16 cellSizePtr(MemPage *pPage, u8 *pCell){
937 u8 *pIter = &pCell[pPage->childPtrSize];
938 u32 nSize;
939
940#ifdef SQLITE_DEBUG
941 /* The value returned by this function should always be the same as
942 ** the (CellInfo.nSize) value found by doing a full parse of the
943 ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
944 ** this function verifies that this invariant is not violated. */
945 CellInfo debuginfo;
danielk197730548662009-07-09 05:07:37 +0000946 btreeParseCellPtr(pPage, pCell, &debuginfo);
danielk1977ae5558b2009-04-29 11:31:47 +0000947#endif
948
949 if( pPage->intKey ){
950 u8 *pEnd;
951 if( pPage->hasData ){
952 pIter += getVarint32(pIter, nSize);
953 }else{
954 nSize = 0;
955 }
956
957 /* pIter now points at the 64-bit integer key value, a variable length
958 ** integer. The following block moves pIter to point at the first byte
959 ** past the end of the key value. */
960 pEnd = &pIter[9];
961 while( (*pIter++)&0x80 && pIter<pEnd );
962 }else{
963 pIter += getVarint32(pIter, nSize);
964 }
965
drh0a45c272009-07-08 01:49:11 +0000966 testcase( nSize==pPage->maxLocal );
967 testcase( nSize==pPage->maxLocal+1 );
danielk1977ae5558b2009-04-29 11:31:47 +0000968 if( nSize>pPage->maxLocal ){
969 int minLocal = pPage->minLocal;
970 nSize = minLocal + (nSize - minLocal) % (pPage->pBt->usableSize - 4);
drh0a45c272009-07-08 01:49:11 +0000971 testcase( nSize==pPage->maxLocal );
972 testcase( nSize==pPage->maxLocal+1 );
danielk1977ae5558b2009-04-29 11:31:47 +0000973 if( nSize>pPage->maxLocal ){
974 nSize = minLocal;
975 }
976 nSize += 4;
977 }
shane75ac1de2009-06-09 18:58:52 +0000978 nSize += (u32)(pIter - pCell);
danielk1977ae5558b2009-04-29 11:31:47 +0000979
980 /* The minimum size of any cell is 4 bytes. */
981 if( nSize<4 ){
982 nSize = 4;
983 }
984
985 assert( nSize==debuginfo.nSize );
shane60a4b532009-05-06 18:57:09 +0000986 return (u16)nSize;
danielk1977ae5558b2009-04-29 11:31:47 +0000987}
danielk1977bc6ada42004-06-30 08:20:16 +0000988#ifndef NDEBUG
drha9121e42008-02-19 14:59:35 +0000989static u16 cellSize(MemPage *pPage, int iCell){
danielk1977ae5558b2009-04-29 11:31:47 +0000990 return cellSizePtr(pPage, findCell(pPage, iCell));
drh43605152004-05-29 21:46:49 +0000991}
danielk1977bc6ada42004-06-30 08:20:16 +0000992#endif
drh3b7511c2001-05-26 13:15:44 +0000993
danielk197779a40da2005-01-16 08:00:01 +0000994#ifndef SQLITE_OMIT_AUTOVACUUM
drh3b7511c2001-05-26 13:15:44 +0000995/*
danielk197726836652005-01-17 01:33:13 +0000996** If the cell pCell, part of page pPage contains a pointer
danielk197779a40da2005-01-16 08:00:01 +0000997** to an overflow page, insert an entry into the pointer-map
998** for the overflow page.
danielk1977ac11ee62005-01-15 12:45:51 +0000999*/
danielk197726836652005-01-17 01:33:13 +00001000static int ptrmapPutOvflPtr(MemPage *pPage, u8 *pCell){
drhfa67c3c2008-07-11 02:21:40 +00001001 CellInfo info;
1002 assert( pCell!=0 );
danielk197730548662009-07-09 05:07:37 +00001003 btreeParseCellPtr(pPage, pCell, &info);
drhfa67c3c2008-07-11 02:21:40 +00001004 assert( (info.nData+(pPage->intKey?0:info.nKey))==info.nPayload );
danielk19774dbaa892009-06-16 16:50:22 +00001005 if( info.iOverflow ){
drhfa67c3c2008-07-11 02:21:40 +00001006 Pgno ovfl = get4byte(&pCell[info.iOverflow]);
1007 return ptrmapPut(pPage->pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno);
danielk1977ac11ee62005-01-15 12:45:51 +00001008 }
danielk197779a40da2005-01-16 08:00:01 +00001009 return SQLITE_OK;
danielk1977ac11ee62005-01-15 12:45:51 +00001010}
danielk197779a40da2005-01-16 08:00:01 +00001011#endif
1012
danielk1977ac11ee62005-01-15 12:45:51 +00001013
drhda200cc2004-05-09 11:51:38 +00001014/*
drh72f82862001-05-24 21:06:34 +00001015** Defragment the page given. All Cells are moved to the
drh3a4a2d42005-11-24 14:24:28 +00001016** end of the page and all free space is collected into one
1017** big FreeBlk that occurs in between the header and cell
drh31beae92005-11-24 14:34:36 +00001018** pointer array and the cell content area.
drh365d68f2001-05-11 11:02:46 +00001019*/
shane0af3f892008-11-12 04:55:34 +00001020static int defragmentPage(MemPage *pPage){
drh43605152004-05-29 21:46:49 +00001021 int i; /* Loop counter */
1022 int pc; /* Address of a i-th cell */
drh43605152004-05-29 21:46:49 +00001023 int hdr; /* Offset to the page header */
1024 int size; /* Size of a cell */
1025 int usableSize; /* Number of usable bytes on a page */
1026 int cellOffset; /* Offset to the cell pointer array */
drh281b21d2008-08-22 12:57:08 +00001027 int cbrk; /* Offset to the cell content area */
drh43605152004-05-29 21:46:49 +00001028 int nCell; /* Number of cells on the page */
drh2e38c322004-09-03 18:38:44 +00001029 unsigned char *data; /* The page data */
1030 unsigned char *temp; /* Temp area for cell content */
drh17146622009-07-07 17:38:38 +00001031 int iCellFirst; /* First allowable cell index */
1032 int iCellLast; /* Last possible cell index */
1033
drh2af926b2001-05-15 00:39:25 +00001034
danielk19773b8a05f2007-03-19 17:44:26 +00001035 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +00001036 assert( pPage->pBt!=0 );
drh90f5ecb2004-07-22 01:19:35 +00001037 assert( pPage->pBt->usableSize <= SQLITE_MAX_PAGE_SIZE );
drh43605152004-05-29 21:46:49 +00001038 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +00001039 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh26b79942007-11-28 16:19:56 +00001040 temp = sqlite3PagerTempSpace(pPage->pBt->pPager);
drh43605152004-05-29 21:46:49 +00001041 data = pPage->aData;
drh9e572e62004-04-23 23:43:10 +00001042 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +00001043 cellOffset = pPage->cellOffset;
1044 nCell = pPage->nCell;
1045 assert( nCell==get2byte(&data[hdr+3]) );
1046 usableSize = pPage->pBt->usableSize;
drh281b21d2008-08-22 12:57:08 +00001047 cbrk = get2byte(&data[hdr+5]);
1048 memcpy(&temp[cbrk], &data[cbrk], usableSize - cbrk);
1049 cbrk = usableSize;
drh17146622009-07-07 17:38:38 +00001050 iCellFirst = cellOffset + 2*nCell;
1051 iCellLast = usableSize - 4;
drh43605152004-05-29 21:46:49 +00001052 for(i=0; i<nCell; i++){
1053 u8 *pAddr; /* The i-th cell pointer */
1054 pAddr = &data[cellOffset + i*2];
1055 pc = get2byte(pAddr);
drh0a45c272009-07-08 01:49:11 +00001056 testcase( pc==iCellFirst );
1057 testcase( pc==iCellLast );
drh17146622009-07-07 17:38:38 +00001058#if !defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
danielk197730548662009-07-09 05:07:37 +00001059 /* These conditions have already been verified in btreeInitPage()
drh17146622009-07-07 17:38:38 +00001060 ** if SQLITE_ENABLE_OVERSIZE_CELL_CHECK is defined
1061 */
1062 if( pc<iCellFirst || pc>iCellLast ){
shane0af3f892008-11-12 04:55:34 +00001063 return SQLITE_CORRUPT_BKPT;
1064 }
drh17146622009-07-07 17:38:38 +00001065#endif
1066 assert( pc>=iCellFirst && pc<=iCellLast );
drh43605152004-05-29 21:46:49 +00001067 size = cellSizePtr(pPage, &temp[pc]);
drh281b21d2008-08-22 12:57:08 +00001068 cbrk -= size;
drh17146622009-07-07 17:38:38 +00001069#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
1070 if( cbrk<iCellFirst ){
shane0af3f892008-11-12 04:55:34 +00001071 return SQLITE_CORRUPT_BKPT;
1072 }
drh17146622009-07-07 17:38:38 +00001073#else
1074 if( cbrk<iCellFirst || pc+size>usableSize ){
1075 return SQLITE_CORRUPT_BKPT;
1076 }
1077#endif
drh7157e1d2009-07-09 13:25:32 +00001078 assert( cbrk+size<=usableSize && cbrk>=iCellFirst );
drh0a45c272009-07-08 01:49:11 +00001079 testcase( cbrk+size==usableSize );
drh0a45c272009-07-08 01:49:11 +00001080 testcase( pc+size==usableSize );
drh281b21d2008-08-22 12:57:08 +00001081 memcpy(&data[cbrk], &temp[pc], size);
1082 put2byte(pAddr, cbrk);
drh2af926b2001-05-15 00:39:25 +00001083 }
drh17146622009-07-07 17:38:38 +00001084 assert( cbrk>=iCellFirst );
drh281b21d2008-08-22 12:57:08 +00001085 put2byte(&data[hdr+5], cbrk);
drh43605152004-05-29 21:46:49 +00001086 data[hdr+1] = 0;
1087 data[hdr+2] = 0;
1088 data[hdr+7] = 0;
drh17146622009-07-07 17:38:38 +00001089 memset(&data[iCellFirst], 0, cbrk-iCellFirst);
drhc5053fb2008-11-27 02:22:10 +00001090 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh17146622009-07-07 17:38:38 +00001091 if( cbrk-iCellFirst!=pPage->nFree ){
danielk1977360e6342008-11-12 08:49:51 +00001092 return SQLITE_CORRUPT_BKPT;
1093 }
shane0af3f892008-11-12 04:55:34 +00001094 return SQLITE_OK;
drh365d68f2001-05-11 11:02:46 +00001095}
1096
drha059ad02001-04-17 20:09:11 +00001097/*
danielk19776011a752009-04-01 16:25:32 +00001098** Allocate nByte bytes of space from within the B-Tree page passed
drh0a45c272009-07-08 01:49:11 +00001099** as the first argument. Write into *pIdx the index into pPage->aData[]
1100** of the first byte of allocated space. Return either SQLITE_OK or
1101** an error code (usually SQLITE_CORRUPT).
drhbd03cae2001-06-02 02:40:57 +00001102**
drh0a45c272009-07-08 01:49:11 +00001103** The caller guarantees that there is sufficient space to make the
1104** allocation. This routine might need to defragment in order to bring
1105** all the space together, however. This routine will avoid using
1106** the first two bytes past the cell pointer area since presumably this
1107** allocation is being made in order to insert a new cell, so we will
1108** also end up needing a new cell pointer.
drh7e3b0a02001-04-28 16:52:40 +00001109*/
drh0a45c272009-07-08 01:49:11 +00001110static int allocateSpace(MemPage *pPage, int nByte, int *pIdx){
danielk19776011a752009-04-01 16:25:32 +00001111 const int hdr = pPage->hdrOffset; /* Local cache of pPage->hdrOffset */
1112 u8 * const data = pPage->aData; /* Local cache of pPage->aData */
1113 int nFrag; /* Number of fragmented bytes on pPage */
drh0a45c272009-07-08 01:49:11 +00001114 int top; /* First byte of cell content area */
1115 int gap; /* First byte of gap between cell pointers and cell content */
1116 int rc; /* Integer return code */
drh43605152004-05-29 21:46:49 +00001117
danielk19773b8a05f2007-03-19 17:44:26 +00001118 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +00001119 assert( pPage->pBt );
drh1fee73e2007-08-29 04:00:57 +00001120 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhfa67c3c2008-07-11 02:21:40 +00001121 assert( nByte>=0 ); /* Minimum cell size is 4 */
1122 assert( pPage->nFree>=nByte );
1123 assert( pPage->nOverflow==0 );
drh43605152004-05-29 21:46:49 +00001124
1125 nFrag = data[hdr+7];
drh0a45c272009-07-08 01:49:11 +00001126 assert( pPage->cellOffset == hdr + 12 - 4*pPage->leaf );
1127 gap = pPage->cellOffset + 2*pPage->nCell;
1128 top = get2byte(&data[hdr+5]);
drh7157e1d2009-07-09 13:25:32 +00001129 if( gap>top ) return SQLITE_CORRUPT_BKPT;
drh0a45c272009-07-08 01:49:11 +00001130 testcase( gap+2==top );
1131 testcase( gap+1==top );
1132 testcase( gap==top );
1133
danielk19776011a752009-04-01 16:25:32 +00001134 if( nFrag>=60 ){
drh0a45c272009-07-08 01:49:11 +00001135 /* Always defragment highly fragmented pages */
1136 rc = defragmentPage(pPage);
1137 if( rc ) return rc;
1138 top = get2byte(&data[hdr+5]);
1139 }else if( gap+2<=top ){
danielk19776011a752009-04-01 16:25:32 +00001140 /* Search the freelist looking for a free slot big enough to satisfy
1141 ** the request. The allocation is made from the first free slot in
1142 ** the list that is large enough to accomadate it.
1143 */
1144 int pc, addr;
1145 for(addr=hdr+1; (pc = get2byte(&data[addr]))>0; addr=pc){
1146 int size = get2byte(&data[pc+2]); /* Size of free slot */
drh43605152004-05-29 21:46:49 +00001147 if( size>=nByte ){
drhf49661a2008-12-10 16:45:50 +00001148 int x = size - nByte;
drh0a45c272009-07-08 01:49:11 +00001149 testcase( x==4 );
1150 testcase( x==3 );
danielk19776011a752009-04-01 16:25:32 +00001151 if( x<4 ){
danielk1977fad91942009-04-29 17:49:59 +00001152 /* Remove the slot from the free-list. Update the number of
1153 ** fragmented bytes within the page. */
drh43605152004-05-29 21:46:49 +00001154 memcpy(&data[addr], &data[pc], 2);
drhf49661a2008-12-10 16:45:50 +00001155 data[hdr+7] = (u8)(nFrag + x);
drh43605152004-05-29 21:46:49 +00001156 }else{
danielk1977fad91942009-04-29 17:49:59 +00001157 /* The slot remains on the free-list. Reduce its size to account
1158 ** for the portion used by the new allocation. */
drhf49661a2008-12-10 16:45:50 +00001159 put2byte(&data[pc+2], x);
drh43605152004-05-29 21:46:49 +00001160 }
drh0a45c272009-07-08 01:49:11 +00001161 *pIdx = pc + x;
1162 return SQLITE_OK;
drh43605152004-05-29 21:46:49 +00001163 }
drh9e572e62004-04-23 23:43:10 +00001164 }
1165 }
drh43605152004-05-29 21:46:49 +00001166
drh0a45c272009-07-08 01:49:11 +00001167 /* Check to make sure there is enough space in the gap to satisfy
1168 ** the allocation. If not, defragment.
1169 */
1170 testcase( gap+2+nByte==top );
1171 if( gap+2+nByte>top ){
1172 rc = defragmentPage(pPage);
1173 if( rc ) return rc;
1174 top = get2byte(&data[hdr+5]);
1175 assert( gap+nByte<=top );
1176 }
1177
1178
drh43605152004-05-29 21:46:49 +00001179 /* Allocate memory from the gap in between the cell pointer array
1180 ** and the cell content area.
1181 */
drh0a45c272009-07-08 01:49:11 +00001182 top -= nByte;
drh43605152004-05-29 21:46:49 +00001183 put2byte(&data[hdr+5], top);
drh0a45c272009-07-08 01:49:11 +00001184 *pIdx = top;
1185 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001186}
1187
1188/*
drh9e572e62004-04-23 23:43:10 +00001189** Return a section of the pPage->aData to the freelist.
1190** The first byte of the new free block is pPage->aDisk[start]
1191** and the size of the block is "size" bytes.
drh306dc212001-05-21 13:45:10 +00001192**
1193** Most of the effort here is involved in coalesing adjacent
1194** free blocks into a single big free block.
drh7e3b0a02001-04-28 16:52:40 +00001195*/
shanedcc50b72008-11-13 18:29:50 +00001196static int freeSpace(MemPage *pPage, int start, int size){
drh43605152004-05-29 21:46:49 +00001197 int addr, pbegin, hdr;
drh0a45c272009-07-08 01:49:11 +00001198 int iLast; /* Largest possible freeblock offset */
drh9e572e62004-04-23 23:43:10 +00001199 unsigned char *data = pPage->aData;
drh2af926b2001-05-15 00:39:25 +00001200
drh9e572e62004-04-23 23:43:10 +00001201 assert( pPage->pBt!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00001202 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +00001203 assert( start>=pPage->hdrOffset+6+(pPage->leaf?0:4) );
danielk1977bc6ada42004-06-30 08:20:16 +00001204 assert( (start + size)<=pPage->pBt->usableSize );
drh1fee73e2007-08-29 04:00:57 +00001205 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh34004ce2008-07-11 16:15:17 +00001206 assert( size>=0 ); /* Minimum cell size is 4 */
drh9e572e62004-04-23 23:43:10 +00001207
drhfcce93f2006-02-22 03:08:32 +00001208#ifdef SQLITE_SECURE_DELETE
1209 /* Overwrite deleted information with zeros when the SECURE_DELETE
1210 ** option is enabled at compile-time */
1211 memset(&data[start], 0, size);
1212#endif
1213
drh0a45c272009-07-08 01:49:11 +00001214 /* Add the space back into the linked list of freeblocks. Note that
danielk197730548662009-07-09 05:07:37 +00001215 ** even though the freeblock list was checked by btreeInitPage(),
1216 ** btreeInitPage() did not detect overlapping cells or
drhb908d762009-07-08 16:54:40 +00001217 ** freeblocks that overlapped cells. Nor does it detect when the
1218 ** cell content area exceeds the value in the page header. If these
1219 ** situations arise, then subsequent insert operations might corrupt
1220 ** the freelist. So we do need to check for corruption while scanning
1221 ** the freelist.
drh0a45c272009-07-08 01:49:11 +00001222 */
drh43605152004-05-29 21:46:49 +00001223 hdr = pPage->hdrOffset;
1224 addr = hdr + 1;
drh0a45c272009-07-08 01:49:11 +00001225 iLast = pPage->pBt->usableSize - 4;
drh35a25da2009-07-08 15:14:50 +00001226 assert( start<=iLast );
drh3aac2dd2004-04-26 14:10:20 +00001227 while( (pbegin = get2byte(&data[addr]))<start && pbegin>0 ){
drh35a25da2009-07-08 15:14:50 +00001228 if( pbegin<addr+4 ){
shanedcc50b72008-11-13 18:29:50 +00001229 return SQLITE_CORRUPT_BKPT;
1230 }
drh3aac2dd2004-04-26 14:10:20 +00001231 addr = pbegin;
drh2af926b2001-05-15 00:39:25 +00001232 }
drh0a45c272009-07-08 01:49:11 +00001233 if( pbegin>iLast ){
shanedcc50b72008-11-13 18:29:50 +00001234 return SQLITE_CORRUPT_BKPT;
1235 }
drh3aac2dd2004-04-26 14:10:20 +00001236 assert( pbegin>addr || pbegin==0 );
drha34b6762004-05-07 13:30:42 +00001237 put2byte(&data[addr], start);
1238 put2byte(&data[start], pbegin);
1239 put2byte(&data[start+2], size);
shane36840fd2009-06-26 16:32:13 +00001240 pPage->nFree = pPage->nFree + (u16)size;
drh9e572e62004-04-23 23:43:10 +00001241
1242 /* Coalesce adjacent free blocks */
drh0a45c272009-07-08 01:49:11 +00001243 addr = hdr + 1;
drh3aac2dd2004-04-26 14:10:20 +00001244 while( (pbegin = get2byte(&data[addr]))>0 ){
drhf49661a2008-12-10 16:45:50 +00001245 int pnext, psize, x;
drh3aac2dd2004-04-26 14:10:20 +00001246 assert( pbegin>addr );
drh43605152004-05-29 21:46:49 +00001247 assert( pbegin<=pPage->pBt->usableSize-4 );
drh9e572e62004-04-23 23:43:10 +00001248 pnext = get2byte(&data[pbegin]);
1249 psize = get2byte(&data[pbegin+2]);
1250 if( pbegin + psize + 3 >= pnext && pnext>0 ){
1251 int frag = pnext - (pbegin+psize);
drh0a45c272009-07-08 01:49:11 +00001252 if( (frag<0) || (frag>(int)data[hdr+7]) ){
shanedcc50b72008-11-13 18:29:50 +00001253 return SQLITE_CORRUPT_BKPT;
1254 }
drh0a45c272009-07-08 01:49:11 +00001255 data[hdr+7] -= (u8)frag;
drhf49661a2008-12-10 16:45:50 +00001256 x = get2byte(&data[pnext]);
1257 put2byte(&data[pbegin], x);
1258 x = pnext + get2byte(&data[pnext+2]) - pbegin;
1259 put2byte(&data[pbegin+2], x);
drh9e572e62004-04-23 23:43:10 +00001260 }else{
drh3aac2dd2004-04-26 14:10:20 +00001261 addr = pbegin;
drh9e572e62004-04-23 23:43:10 +00001262 }
1263 }
drh7e3b0a02001-04-28 16:52:40 +00001264
drh43605152004-05-29 21:46:49 +00001265 /* If the cell content area begins with a freeblock, remove it. */
1266 if( data[hdr+1]==data[hdr+5] && data[hdr+2]==data[hdr+6] ){
1267 int top;
1268 pbegin = get2byte(&data[hdr+1]);
1269 memcpy(&data[hdr+1], &data[pbegin], 2);
drhf49661a2008-12-10 16:45:50 +00001270 top = get2byte(&data[hdr+5]) + get2byte(&data[pbegin+2]);
1271 put2byte(&data[hdr+5], top);
drh4b70f112004-05-02 21:12:19 +00001272 }
drhc5053fb2008-11-27 02:22:10 +00001273 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
shanedcc50b72008-11-13 18:29:50 +00001274 return SQLITE_OK;
drh4b70f112004-05-02 21:12:19 +00001275}
1276
1277/*
drh271efa52004-05-30 19:19:05 +00001278** Decode the flags byte (the first byte of the header) for a page
1279** and initialize fields of the MemPage structure accordingly.
drh44845222008-07-17 18:39:57 +00001280**
1281** Only the following combinations are supported. Anything different
1282** indicates a corrupt database files:
1283**
1284** PTF_ZERODATA
1285** PTF_ZERODATA | PTF_LEAF
1286** PTF_LEAFDATA | PTF_INTKEY
1287** PTF_LEAFDATA | PTF_INTKEY | PTF_LEAF
drh271efa52004-05-30 19:19:05 +00001288*/
drh44845222008-07-17 18:39:57 +00001289static int decodeFlags(MemPage *pPage, int flagByte){
danielk1977aef0bf62005-12-30 16:28:01 +00001290 BtShared *pBt; /* A copy of pPage->pBt */
drh271efa52004-05-30 19:19:05 +00001291
1292 assert( pPage->hdrOffset==(pPage->pgno==1 ? 100 : 0) );
drh1fee73e2007-08-29 04:00:57 +00001293 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhf49661a2008-12-10 16:45:50 +00001294 pPage->leaf = (u8)(flagByte>>3); assert( PTF_LEAF == 1<<3 );
drh44845222008-07-17 18:39:57 +00001295 flagByte &= ~PTF_LEAF;
1296 pPage->childPtrSize = 4-4*pPage->leaf;
drh271efa52004-05-30 19:19:05 +00001297 pBt = pPage->pBt;
drh44845222008-07-17 18:39:57 +00001298 if( flagByte==(PTF_LEAFDATA | PTF_INTKEY) ){
1299 pPage->intKey = 1;
1300 pPage->hasData = pPage->leaf;
drh271efa52004-05-30 19:19:05 +00001301 pPage->maxLocal = pBt->maxLeaf;
1302 pPage->minLocal = pBt->minLeaf;
drh44845222008-07-17 18:39:57 +00001303 }else if( flagByte==PTF_ZERODATA ){
1304 pPage->intKey = 0;
1305 pPage->hasData = 0;
drh271efa52004-05-30 19:19:05 +00001306 pPage->maxLocal = pBt->maxLocal;
1307 pPage->minLocal = pBt->minLocal;
drh44845222008-07-17 18:39:57 +00001308 }else{
1309 return SQLITE_CORRUPT_BKPT;
drh271efa52004-05-30 19:19:05 +00001310 }
drh44845222008-07-17 18:39:57 +00001311 return SQLITE_OK;
drh271efa52004-05-30 19:19:05 +00001312}
1313
1314/*
drh7e3b0a02001-04-28 16:52:40 +00001315** Initialize the auxiliary information for a disk block.
drh72f82862001-05-24 21:06:34 +00001316**
1317** Return SQLITE_OK on success. If we see that the page does
drhda47d772002-12-02 04:25:19 +00001318** not contain a well-formed database page, then return
drh72f82862001-05-24 21:06:34 +00001319** SQLITE_CORRUPT. Note that a return of SQLITE_OK does not
1320** guarantee that the page is well-formed. It only shows that
1321** we failed to detect any corruption.
drh7e3b0a02001-04-28 16:52:40 +00001322*/
danielk197730548662009-07-09 05:07:37 +00001323static int btreeInitPage(MemPage *pPage){
drh2af926b2001-05-15 00:39:25 +00001324
danielk197771d5d2c2008-09-29 11:49:47 +00001325 assert( pPage->pBt!=0 );
1326 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00001327 assert( pPage->pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
drhbf4bca52007-09-06 22:19:14 +00001328 assert( pPage == sqlite3PagerGetExtra(pPage->pDbPage) );
1329 assert( pPage->aData == sqlite3PagerGetData(pPage->pDbPage) );
danielk197771d5d2c2008-09-29 11:49:47 +00001330
1331 if( !pPage->isInit ){
drhf49661a2008-12-10 16:45:50 +00001332 u16 pc; /* Address of a freeblock within pPage->aData[] */
1333 u8 hdr; /* Offset to beginning of page header */
danielk197771d5d2c2008-09-29 11:49:47 +00001334 u8 *data; /* Equal to pPage->aData */
1335 BtShared *pBt; /* The main btree structure */
drhf49661a2008-12-10 16:45:50 +00001336 u16 usableSize; /* Amount of usable space on each page */
1337 u16 cellOffset; /* Offset from start of page to first cell pointer */
1338 u16 nFree; /* Number of unused bytes on the page */
1339 u16 top; /* First byte of the cell content area */
drh0a45c272009-07-08 01:49:11 +00001340 int iCellFirst; /* First allowable cell or freeblock offset */
1341 int iCellLast; /* Last possible cell or freeblock offset */
danielk197771d5d2c2008-09-29 11:49:47 +00001342
1343 pBt = pPage->pBt;
1344
danielk1977eaa06f62008-09-18 17:34:44 +00001345 hdr = pPage->hdrOffset;
1346 data = pPage->aData;
1347 if( decodeFlags(pPage, data[hdr]) ) return SQLITE_CORRUPT_BKPT;
1348 assert( pBt->pageSize>=512 && pBt->pageSize<=32768 );
1349 pPage->maskPage = pBt->pageSize - 1;
1350 pPage->nOverflow = 0;
danielk1977eaa06f62008-09-18 17:34:44 +00001351 usableSize = pBt->usableSize;
1352 pPage->cellOffset = cellOffset = hdr + 12 - 4*pPage->leaf;
1353 top = get2byte(&data[hdr+5]);
1354 pPage->nCell = get2byte(&data[hdr+3]);
1355 if( pPage->nCell>MX_CELL(pBt) ){
1356 /* To many cells for a single page. The page must be corrupt */
1357 return SQLITE_CORRUPT_BKPT;
1358 }
drhb908d762009-07-08 16:54:40 +00001359 testcase( pPage->nCell==MX_CELL(pBt) );
drh69e931e2009-06-03 21:04:35 +00001360
1361 /* A malformed database page might cause use to read past the end
1362 ** of page when parsing a cell.
1363 **
1364 ** The following block of code checks early to see if a cell extends
1365 ** past the end of a page boundary and causes SQLITE_CORRUPT to be
1366 ** returned if it does.
1367 */
drh0a45c272009-07-08 01:49:11 +00001368 iCellFirst = cellOffset + 2*pPage->nCell;
1369 iCellLast = usableSize - 4;
drh3b2a3fa2009-06-09 13:42:24 +00001370#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
drh69e931e2009-06-03 21:04:35 +00001371 {
drh69e931e2009-06-03 21:04:35 +00001372 int i; /* Index into the cell pointer array */
1373 int sz; /* Size of a cell */
1374
drh69e931e2009-06-03 21:04:35 +00001375 if( !pPage->leaf ) iCellLast--;
1376 for(i=0; i<pPage->nCell; i++){
1377 pc = get2byte(&data[cellOffset+i*2]);
drh0a45c272009-07-08 01:49:11 +00001378 testcase( pc==iCellFirst );
1379 testcase( pc==iCellLast );
drh69e931e2009-06-03 21:04:35 +00001380 if( pc<iCellFirst || pc>iCellLast ){
1381 return SQLITE_CORRUPT_BKPT;
1382 }
1383 sz = cellSizePtr(pPage, &data[pc]);
drh0a45c272009-07-08 01:49:11 +00001384 testcase( pc+sz==usableSize );
drh69e931e2009-06-03 21:04:35 +00001385 if( pc+sz>usableSize ){
1386 return SQLITE_CORRUPT_BKPT;
1387 }
1388 }
drh0a45c272009-07-08 01:49:11 +00001389 if( !pPage->leaf ) iCellLast++;
drh69e931e2009-06-03 21:04:35 +00001390 }
1391#endif
1392
danielk1977eaa06f62008-09-18 17:34:44 +00001393 /* Compute the total free space on the page */
1394 pc = get2byte(&data[hdr+1]);
danielk197793c829c2009-06-03 17:26:17 +00001395 nFree = data[hdr+7] + top;
danielk1977eaa06f62008-09-18 17:34:44 +00001396 while( pc>0 ){
drh1bd10f82008-12-10 21:19:56 +00001397 u16 next, size;
drh0a45c272009-07-08 01:49:11 +00001398 if( pc<iCellFirst || pc>iCellLast ){
danielk1977eaa06f62008-09-18 17:34:44 +00001399 /* Free block is off the page */
1400 return SQLITE_CORRUPT_BKPT;
1401 }
1402 next = get2byte(&data[pc]);
1403 size = get2byte(&data[pc+2]);
1404 if( next>0 && next<=pc+size+3 ){
drh0a45c272009-07-08 01:49:11 +00001405 /* Free blocks must be in ascending order */
danielk1977eaa06f62008-09-18 17:34:44 +00001406 return SQLITE_CORRUPT_BKPT;
1407 }
shane85095702009-06-15 16:27:08 +00001408 nFree = nFree + size;
danielk1977eaa06f62008-09-18 17:34:44 +00001409 pc = next;
1410 }
danielk197793c829c2009-06-03 17:26:17 +00001411
1412 /* At this point, nFree contains the sum of the offset to the start
1413 ** of the cell-content area plus the number of free bytes within
1414 ** the cell-content area. If this is greater than the usable-size
1415 ** of the page, then the page must be corrupted. This check also
1416 ** serves to verify that the offset to the start of the cell-content
1417 ** area, according to the page header, lies within the page.
1418 */
1419 if( nFree>usableSize ){
drh49285702005-09-17 15:20:26 +00001420 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +00001421 }
drh0a45c272009-07-08 01:49:11 +00001422 pPage->nFree = nFree - iCellFirst;
danielk197771d5d2c2008-09-29 11:49:47 +00001423 pPage->isInit = 1;
1424 }
drh9e572e62004-04-23 23:43:10 +00001425 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001426}
1427
1428/*
drh8b2f49b2001-06-08 00:21:52 +00001429** Set up a raw page so that it looks like a database page holding
1430** no entries.
drhbd03cae2001-06-02 02:40:57 +00001431*/
drh9e572e62004-04-23 23:43:10 +00001432static void zeroPage(MemPage *pPage, int flags){
1433 unsigned char *data = pPage->aData;
danielk1977aef0bf62005-12-30 16:28:01 +00001434 BtShared *pBt = pPage->pBt;
drhf49661a2008-12-10 16:45:50 +00001435 u8 hdr = pPage->hdrOffset;
1436 u16 first;
drh9e572e62004-04-23 23:43:10 +00001437
danielk19773b8a05f2007-03-19 17:44:26 +00001438 assert( sqlite3PagerPagenumber(pPage->pDbPage)==pPage->pgno );
drhbf4bca52007-09-06 22:19:14 +00001439 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
1440 assert( sqlite3PagerGetData(pPage->pDbPage) == data );
danielk19773b8a05f2007-03-19 17:44:26 +00001441 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00001442 assert( sqlite3_mutex_held(pBt->mutex) );
drh1af4a6e2008-07-18 03:32:51 +00001443 /*memset(&data[hdr], 0, pBt->usableSize - hdr);*/
drh1bd10f82008-12-10 21:19:56 +00001444 data[hdr] = (char)flags;
1445 first = hdr + 8 + 4*((flags&PTF_LEAF)==0 ?1:0);
drh43605152004-05-29 21:46:49 +00001446 memset(&data[hdr+1], 0, 4);
1447 data[hdr+7] = 0;
1448 put2byte(&data[hdr+5], pBt->usableSize);
drhb6f41482004-05-14 01:58:11 +00001449 pPage->nFree = pBt->usableSize - first;
drh271efa52004-05-30 19:19:05 +00001450 decodeFlags(pPage, flags);
drh9e572e62004-04-23 23:43:10 +00001451 pPage->hdrOffset = hdr;
drh43605152004-05-29 21:46:49 +00001452 pPage->cellOffset = first;
1453 pPage->nOverflow = 0;
drh1688c862008-07-18 02:44:17 +00001454 assert( pBt->pageSize>=512 && pBt->pageSize<=32768 );
1455 pPage->maskPage = pBt->pageSize - 1;
drh43605152004-05-29 21:46:49 +00001456 pPage->nCell = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00001457 pPage->isInit = 1;
drhbd03cae2001-06-02 02:40:57 +00001458}
1459
drh897a8202008-09-18 01:08:15 +00001460
1461/*
1462** Convert a DbPage obtained from the pager into a MemPage used by
1463** the btree layer.
1464*/
1465static MemPage *btreePageFromDbPage(DbPage *pDbPage, Pgno pgno, BtShared *pBt){
1466 MemPage *pPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
1467 pPage->aData = sqlite3PagerGetData(pDbPage);
1468 pPage->pDbPage = pDbPage;
1469 pPage->pBt = pBt;
1470 pPage->pgno = pgno;
1471 pPage->hdrOffset = pPage->pgno==1 ? 100 : 0;
1472 return pPage;
1473}
1474
drhbd03cae2001-06-02 02:40:57 +00001475/*
drh3aac2dd2004-04-26 14:10:20 +00001476** Get a page from the pager. Initialize the MemPage.pBt and
1477** MemPage.aData elements if needed.
drh538f5702007-04-13 02:14:30 +00001478**
1479** If the noContent flag is set, it means that we do not care about
1480** the content of the page at this time. So do not go to the disk
1481** to fetch the content. Just fill in the content with zeros for now.
1482** If in the future we call sqlite3PagerWrite() on this page, that
1483** means we have started to be concerned about content and the disk
1484** read should occur at that point.
drh3aac2dd2004-04-26 14:10:20 +00001485*/
danielk197730548662009-07-09 05:07:37 +00001486static int btreeGetPage(
drh16a9b832007-05-05 18:39:25 +00001487 BtShared *pBt, /* The btree */
1488 Pgno pgno, /* Number of the page to fetch */
1489 MemPage **ppPage, /* Return the page in this parameter */
1490 int noContent /* Do not load page content if true */
1491){
drh3aac2dd2004-04-26 14:10:20 +00001492 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00001493 DbPage *pDbPage;
1494
drh1fee73e2007-08-29 04:00:57 +00001495 assert( sqlite3_mutex_held(pBt->mutex) );
drh538f5702007-04-13 02:14:30 +00001496 rc = sqlite3PagerAcquire(pBt->pPager, pgno, (DbPage**)&pDbPage, noContent);
drh3aac2dd2004-04-26 14:10:20 +00001497 if( rc ) return rc;
drh897a8202008-09-18 01:08:15 +00001498 *ppPage = btreePageFromDbPage(pDbPage, pgno, pBt);
drh3aac2dd2004-04-26 14:10:20 +00001499 return SQLITE_OK;
1500}
1501
1502/*
danielk1977bea2a942009-01-20 17:06:27 +00001503** Retrieve a page from the pager cache. If the requested page is not
1504** already in the pager cache return NULL. Initialize the MemPage.pBt and
1505** MemPage.aData elements if needed.
1506*/
1507static MemPage *btreePageLookup(BtShared *pBt, Pgno pgno){
1508 DbPage *pDbPage;
1509 assert( sqlite3_mutex_held(pBt->mutex) );
1510 pDbPage = sqlite3PagerLookup(pBt->pPager, pgno);
1511 if( pDbPage ){
1512 return btreePageFromDbPage(pDbPage, pgno, pBt);
1513 }
1514 return 0;
1515}
1516
1517/*
danielk197789d40042008-11-17 14:20:56 +00001518** Return the size of the database file in pages. If there is any kind of
1519** error, return ((unsigned int)-1).
danielk197767fd7a92008-09-10 17:53:35 +00001520*/
danielk197789d40042008-11-17 14:20:56 +00001521static Pgno pagerPagecount(BtShared *pBt){
1522 int nPage = -1;
danielk197767fd7a92008-09-10 17:53:35 +00001523 int rc;
danielk197789d40042008-11-17 14:20:56 +00001524 assert( pBt->pPage1 );
1525 rc = sqlite3PagerPagecount(pBt->pPager, &nPage);
1526 assert( rc==SQLITE_OK || nPage==-1 );
1527 return (Pgno)nPage;
danielk197767fd7a92008-09-10 17:53:35 +00001528}
1529
1530/*
drhde647132004-05-07 17:57:49 +00001531** Get a page from the pager and initialize it. This routine
1532** is just a convenience wrapper around separate calls to
danielk197730548662009-07-09 05:07:37 +00001533** btreeGetPage() and btreeInitPage().
drhde647132004-05-07 17:57:49 +00001534*/
1535static int getAndInitPage(
danielk1977aef0bf62005-12-30 16:28:01 +00001536 BtShared *pBt, /* The database file */
drhde647132004-05-07 17:57:49 +00001537 Pgno pgno, /* Number of the page to get */
danielk197771d5d2c2008-09-29 11:49:47 +00001538 MemPage **ppPage /* Write the page pointer here */
drhde647132004-05-07 17:57:49 +00001539){
1540 int rc;
drh897a8202008-09-18 01:08:15 +00001541 MemPage *pPage;
1542
drh1fee73e2007-08-29 04:00:57 +00001543 assert( sqlite3_mutex_held(pBt->mutex) );
drh897a8202008-09-18 01:08:15 +00001544 if( pgno==0 ){
drh49285702005-09-17 15:20:26 +00001545 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +00001546 }
danielk19779f580ad2008-09-10 14:45:57 +00001547
drh897a8202008-09-18 01:08:15 +00001548 /* It is often the case that the page we want is already in cache.
1549 ** If so, get it directly. This saves us from having to call
1550 ** pagerPagecount() to make sure pgno is within limits, which results
1551 ** in a measureable performance improvements.
1552 */
danielk1977bea2a942009-01-20 17:06:27 +00001553 *ppPage = pPage = btreePageLookup(pBt, pgno);
1554 if( pPage ){
drh897a8202008-09-18 01:08:15 +00001555 /* Page is already in cache */
drh897a8202008-09-18 01:08:15 +00001556 rc = SQLITE_OK;
1557 }else{
1558 /* Page not in cache. Acquire it. */
drhf3aed592009-07-08 18:12:49 +00001559 testcase( pgno==pagerPagecount(pBt) );
danielk197789d40042008-11-17 14:20:56 +00001560 if( pgno>pagerPagecount(pBt) ){
drh897a8202008-09-18 01:08:15 +00001561 return SQLITE_CORRUPT_BKPT;
1562 }
danielk197730548662009-07-09 05:07:37 +00001563 rc = btreeGetPage(pBt, pgno, ppPage, 0);
drh897a8202008-09-18 01:08:15 +00001564 if( rc ) return rc;
1565 pPage = *ppPage;
1566 }
danielk197771d5d2c2008-09-29 11:49:47 +00001567 if( !pPage->isInit ){
danielk197730548662009-07-09 05:07:37 +00001568 rc = btreeInitPage(pPage);
drh897a8202008-09-18 01:08:15 +00001569 }
1570 if( rc!=SQLITE_OK ){
1571 releasePage(pPage);
1572 *ppPage = 0;
1573 }
drhde647132004-05-07 17:57:49 +00001574 return rc;
1575}
1576
1577/*
drh3aac2dd2004-04-26 14:10:20 +00001578** Release a MemPage. This should be called once for each prior
danielk197730548662009-07-09 05:07:37 +00001579** call to btreeGetPage.
drh3aac2dd2004-04-26 14:10:20 +00001580*/
drh4b70f112004-05-02 21:12:19 +00001581static void releasePage(MemPage *pPage){
drh3aac2dd2004-04-26 14:10:20 +00001582 if( pPage ){
drh30df0092008-12-23 15:58:06 +00001583 assert( pPage->nOverflow==0 || sqlite3PagerPageRefcount(pPage->pDbPage)>1 );
drh3aac2dd2004-04-26 14:10:20 +00001584 assert( pPage->aData );
1585 assert( pPage->pBt );
drhbf4bca52007-09-06 22:19:14 +00001586 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
1587 assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
drh1fee73e2007-08-29 04:00:57 +00001588 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00001589 sqlite3PagerUnref(pPage->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00001590 }
1591}
1592
1593/*
drha6abd042004-06-09 17:37:22 +00001594** During a rollback, when the pager reloads information into the cache
1595** so that the cache is restored to its original state at the start of
1596** the transaction, for each page restored this routine is called.
1597**
1598** This routine needs to reset the extra data section at the end of the
1599** page to agree with the restored data.
1600*/
danielk1977eaa06f62008-09-18 17:34:44 +00001601static void pageReinit(DbPage *pData){
drh07d183d2005-05-01 22:52:42 +00001602 MemPage *pPage;
danielk19773b8a05f2007-03-19 17:44:26 +00001603 pPage = (MemPage *)sqlite3PagerGetExtra(pData);
danielk1977d217e6f2009-04-01 17:13:51 +00001604 assert( sqlite3PagerPageRefcount(pData)>0 );
danielk197771d5d2c2008-09-29 11:49:47 +00001605 if( pPage->isInit ){
drh1fee73e2007-08-29 04:00:57 +00001606 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drha6abd042004-06-09 17:37:22 +00001607 pPage->isInit = 0;
danielk1977d217e6f2009-04-01 17:13:51 +00001608 if( sqlite3PagerPageRefcount(pData)>1 ){
drh5e8d8872009-03-30 17:19:48 +00001609 /* pPage might not be a btree page; it might be an overflow page
1610 ** or ptrmap page or a free page. In those cases, the following
danielk197730548662009-07-09 05:07:37 +00001611 ** call to btreeInitPage() will likely return SQLITE_CORRUPT.
drh5e8d8872009-03-30 17:19:48 +00001612 ** But no harm is done by this. And it is very important that
danielk197730548662009-07-09 05:07:37 +00001613 ** btreeInitPage() be called on every btree page so we make
drh5e8d8872009-03-30 17:19:48 +00001614 ** the call for every page that comes in for re-initing. */
danielk197730548662009-07-09 05:07:37 +00001615 btreeInitPage(pPage);
danielk197771d5d2c2008-09-29 11:49:47 +00001616 }
drha6abd042004-06-09 17:37:22 +00001617 }
1618}
1619
1620/*
drhe5fe6902007-12-07 18:55:28 +00001621** Invoke the busy handler for a btree.
1622*/
danielk19771ceedd32008-11-19 10:22:33 +00001623static int btreeInvokeBusyHandler(void *pArg){
drhe5fe6902007-12-07 18:55:28 +00001624 BtShared *pBt = (BtShared*)pArg;
1625 assert( pBt->db );
1626 assert( sqlite3_mutex_held(pBt->db->mutex) );
1627 return sqlite3InvokeBusyHandler(&pBt->db->busyHandler);
1628}
1629
1630/*
drhad3e0102004-09-03 23:32:18 +00001631** Open a database file.
1632**
drh382c0242001-10-06 16:33:02 +00001633** zFilename is the name of the database file. If zFilename is NULL
drh1bee3d72001-10-15 00:44:35 +00001634** a new database with a random name is created. This randomly named
drh23e11ca2004-05-04 17:27:28 +00001635** database file will be deleted when sqlite3BtreeClose() is called.
drhe53831d2007-08-17 01:14:38 +00001636** If zFilename is ":memory:" then an in-memory database is created
1637** that is automatically destroyed when it is closed.
drhc47fd8e2009-04-30 13:30:32 +00001638**
1639** If the database is already opened in the same database connection
1640** and we are in shared cache mode, then the open will fail with an
1641** SQLITE_CONSTRAINT error. We cannot allow two or more BtShared
1642** objects in the same database connection since doing so will lead
1643** to problems with locking.
drha059ad02001-04-17 20:09:11 +00001644*/
drh23e11ca2004-05-04 17:27:28 +00001645int sqlite3BtreeOpen(
drh3aac2dd2004-04-26 14:10:20 +00001646 const char *zFilename, /* Name of the file containing the BTree database */
drhe5fe6902007-12-07 18:55:28 +00001647 sqlite3 *db, /* Associated database handle */
drh3aac2dd2004-04-26 14:10:20 +00001648 Btree **ppBtree, /* Pointer to new Btree object written here */
drh33f4e022007-09-03 15:19:34 +00001649 int flags, /* Options */
1650 int vfsFlags /* Flags passed through to sqlite3_vfs.xOpen() */
drh6019e162001-07-02 17:51:45 +00001651){
drh7555d8e2009-03-20 13:15:30 +00001652 sqlite3_vfs *pVfs; /* The VFS to use for this btree */
1653 BtShared *pBt = 0; /* Shared part of btree structure */
1654 Btree *p; /* Handle to return */
1655 sqlite3_mutex *mutexOpen = 0; /* Prevents a race condition. Ticket #3537 */
1656 int rc = SQLITE_OK; /* Result code from this function */
1657 u8 nReserve; /* Byte of unused space on each page */
1658 unsigned char zDbHeader[100]; /* Database header content */
danielk1977aef0bf62005-12-30 16:28:01 +00001659
1660 /* Set the variable isMemdb to true for an in-memory database, or
1661 ** false for a file-based database. This symbol is only required if
1662 ** either of the shared-data or autovacuum features are compiled
1663 ** into the library.
1664 */
1665#if !defined(SQLITE_OMIT_SHARED_CACHE) || !defined(SQLITE_OMIT_AUTOVACUUM)
1666 #ifdef SQLITE_OMIT_MEMORYDB
drh980b1a72006-08-16 16:42:48 +00001667 const int isMemdb = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001668 #else
drh980b1a72006-08-16 16:42:48 +00001669 const int isMemdb = zFilename && !strcmp(zFilename, ":memory:");
danielk1977aef0bf62005-12-30 16:28:01 +00001670 #endif
1671#endif
1672
drhe5fe6902007-12-07 18:55:28 +00001673 assert( db!=0 );
1674 assert( sqlite3_mutex_held(db->mutex) );
drh153c62c2007-08-24 03:51:33 +00001675
drhe5fe6902007-12-07 18:55:28 +00001676 pVfs = db->pVfs;
drh17435752007-08-16 04:30:38 +00001677 p = sqlite3MallocZero(sizeof(Btree));
danielk1977aef0bf62005-12-30 16:28:01 +00001678 if( !p ){
1679 return SQLITE_NOMEM;
1680 }
1681 p->inTrans = TRANS_NONE;
drhe5fe6902007-12-07 18:55:28 +00001682 p->db = db;
danielk1977602b4662009-07-02 07:47:33 +00001683#ifndef SQLITE_OMIT_SHARED_CACHE
1684 p->lock.pBtree = p;
1685 p->lock.iTable = 1;
1686#endif
danielk1977aef0bf62005-12-30 16:28:01 +00001687
drh198bf392006-01-06 21:52:49 +00001688#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00001689 /*
1690 ** If this Btree is a candidate for shared cache, try to find an
1691 ** existing BtShared object that we can share with
1692 */
danielk197720c6cc22009-04-01 18:03:00 +00001693 if( isMemdb==0 && zFilename && zFilename[0] ){
danielk1977502b4e02008-09-02 14:07:24 +00001694 if( sqlite3GlobalConfig.sharedCacheEnabled ){
danielk1977adfb9b02007-09-17 07:02:56 +00001695 int nFullPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001696 char *zFullPathname = sqlite3Malloc(nFullPathname);
drhff0587c2007-08-29 17:43:19 +00001697 sqlite3_mutex *mutexShared;
1698 p->sharable = 1;
drh34004ce2008-07-11 16:15:17 +00001699 db->flags |= SQLITE_SharedCache;
drhff0587c2007-08-29 17:43:19 +00001700 if( !zFullPathname ){
1701 sqlite3_free(p);
1702 return SQLITE_NOMEM;
1703 }
danielk1977adfb9b02007-09-17 07:02:56 +00001704 sqlite3OsFullPathname(pVfs, zFilename, nFullPathname, zFullPathname);
drh7555d8e2009-03-20 13:15:30 +00001705 mutexOpen = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_OPEN);
1706 sqlite3_mutex_enter(mutexOpen);
danielk197759f8c082008-06-18 17:09:10 +00001707 mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhff0587c2007-08-29 17:43:19 +00001708 sqlite3_mutex_enter(mutexShared);
drh78f82d12008-09-02 00:52:52 +00001709 for(pBt=GLOBAL(BtShared*,sqlite3SharedCacheList); pBt; pBt=pBt->pNext){
drhff0587c2007-08-29 17:43:19 +00001710 assert( pBt->nRef>0 );
1711 if( 0==strcmp(zFullPathname, sqlite3PagerFilename(pBt->pPager))
1712 && sqlite3PagerVfs(pBt->pPager)==pVfs ){
drhc47fd8e2009-04-30 13:30:32 +00001713 int iDb;
1714 for(iDb=db->nDb-1; iDb>=0; iDb--){
1715 Btree *pExisting = db->aDb[iDb].pBt;
1716 if( pExisting && pExisting->pBt==pBt ){
1717 sqlite3_mutex_leave(mutexShared);
1718 sqlite3_mutex_leave(mutexOpen);
1719 sqlite3_free(zFullPathname);
1720 sqlite3_free(p);
1721 return SQLITE_CONSTRAINT;
1722 }
1723 }
drhff0587c2007-08-29 17:43:19 +00001724 p->pBt = pBt;
1725 pBt->nRef++;
1726 break;
1727 }
1728 }
1729 sqlite3_mutex_leave(mutexShared);
1730 sqlite3_free(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001731 }
drhff0587c2007-08-29 17:43:19 +00001732#ifdef SQLITE_DEBUG
1733 else{
1734 /* In debug mode, we mark all persistent databases as sharable
1735 ** even when they are not. This exercises the locking code and
1736 ** gives more opportunity for asserts(sqlite3_mutex_held())
1737 ** statements to find locking problems.
1738 */
1739 p->sharable = 1;
1740 }
1741#endif
danielk1977aef0bf62005-12-30 16:28:01 +00001742 }
1743#endif
drha059ad02001-04-17 20:09:11 +00001744 if( pBt==0 ){
drhe53831d2007-08-17 01:14:38 +00001745 /*
1746 ** The following asserts make sure that structures used by the btree are
1747 ** the right size. This is to guard against size changes that result
1748 ** when compiling on a different architecture.
danielk197703aded42004-11-22 05:26:27 +00001749 */
drhe53831d2007-08-17 01:14:38 +00001750 assert( sizeof(i64)==8 || sizeof(i64)==4 );
1751 assert( sizeof(u64)==8 || sizeof(u64)==4 );
1752 assert( sizeof(u32)==4 );
1753 assert( sizeof(u16)==2 );
1754 assert( sizeof(Pgno)==4 );
1755
1756 pBt = sqlite3MallocZero( sizeof(*pBt) );
1757 if( pBt==0 ){
1758 rc = SQLITE_NOMEM;
1759 goto btree_open_out;
1760 }
danielk197771d5d2c2008-09-29 11:49:47 +00001761 rc = sqlite3PagerOpen(pVfs, &pBt->pPager, zFilename,
drh33f4e022007-09-03 15:19:34 +00001762 EXTRA_SIZE, flags, vfsFlags);
drhe53831d2007-08-17 01:14:38 +00001763 if( rc==SQLITE_OK ){
1764 rc = sqlite3PagerReadFileheader(pBt->pPager,sizeof(zDbHeader),zDbHeader);
1765 }
1766 if( rc!=SQLITE_OK ){
1767 goto btree_open_out;
1768 }
danielk19772a50ff02009-04-10 09:47:06 +00001769 pBt->db = db;
danielk19771ceedd32008-11-19 10:22:33 +00001770 sqlite3PagerSetBusyhandler(pBt->pPager, btreeInvokeBusyHandler, pBt);
drhe53831d2007-08-17 01:14:38 +00001771 p->pBt = pBt;
1772
drhe53831d2007-08-17 01:14:38 +00001773 sqlite3PagerSetReiniter(pBt->pPager, pageReinit);
1774 pBt->pCursor = 0;
1775 pBt->pPage1 = 0;
1776 pBt->readOnly = sqlite3PagerIsreadonly(pBt->pPager);
1777 pBt->pageSize = get2byte(&zDbHeader[16]);
1778 if( pBt->pageSize<512 || pBt->pageSize>SQLITE_MAX_PAGE_SIZE
1779 || ((pBt->pageSize-1)&pBt->pageSize)!=0 ){
danielk1977a1644fd2007-08-29 12:31:25 +00001780 pBt->pageSize = 0;
drhe53831d2007-08-17 01:14:38 +00001781#ifndef SQLITE_OMIT_AUTOVACUUM
1782 /* If the magic name ":memory:" will create an in-memory database, then
1783 ** leave the autoVacuum mode at 0 (do not auto-vacuum), even if
1784 ** SQLITE_DEFAULT_AUTOVACUUM is true. On the other hand, if
1785 ** SQLITE_OMIT_MEMORYDB has been defined, then ":memory:" is just a
1786 ** regular file-name. In this case the auto-vacuum applies as per normal.
1787 */
1788 if( zFilename && !isMemdb ){
1789 pBt->autoVacuum = (SQLITE_DEFAULT_AUTOVACUUM ? 1 : 0);
1790 pBt->incrVacuum = (SQLITE_DEFAULT_AUTOVACUUM==2 ? 1 : 0);
1791 }
1792#endif
1793 nReserve = 0;
1794 }else{
1795 nReserve = zDbHeader[20];
drhe53831d2007-08-17 01:14:38 +00001796 pBt->pageSizeFixed = 1;
1797#ifndef SQLITE_OMIT_AUTOVACUUM
1798 pBt->autoVacuum = (get4byte(&zDbHeader[36 + 4*4])?1:0);
1799 pBt->incrVacuum = (get4byte(&zDbHeader[36 + 7*4])?1:0);
1800#endif
1801 }
drhfa9601a2009-06-18 17:22:39 +00001802 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
drhc0b61812009-04-30 01:22:41 +00001803 if( rc ) goto btree_open_out;
drhe53831d2007-08-17 01:14:38 +00001804 pBt->usableSize = pBt->pageSize - nReserve;
1805 assert( (pBt->pageSize & 7)==0 ); /* 8-byte alignment of pageSize */
drhe53831d2007-08-17 01:14:38 +00001806
1807#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
1808 /* Add the new BtShared object to the linked list sharable BtShareds.
1809 */
1810 if( p->sharable ){
1811 sqlite3_mutex *mutexShared;
1812 pBt->nRef = 1;
danielk197759f8c082008-06-18 17:09:10 +00001813 mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
danielk1977075c23a2008-09-01 18:34:20 +00001814 if( SQLITE_THREADSAFE && sqlite3GlobalConfig.bCoreMutex ){
danielk197759f8c082008-06-18 17:09:10 +00001815 pBt->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_FAST);
drh3285db22007-09-03 22:00:39 +00001816 if( pBt->mutex==0 ){
1817 rc = SQLITE_NOMEM;
drhe5fe6902007-12-07 18:55:28 +00001818 db->mallocFailed = 0;
drh3285db22007-09-03 22:00:39 +00001819 goto btree_open_out;
1820 }
drhff0587c2007-08-29 17:43:19 +00001821 }
drhe53831d2007-08-17 01:14:38 +00001822 sqlite3_mutex_enter(mutexShared);
drh78f82d12008-09-02 00:52:52 +00001823 pBt->pNext = GLOBAL(BtShared*,sqlite3SharedCacheList);
1824 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt;
drhe53831d2007-08-17 01:14:38 +00001825 sqlite3_mutex_leave(mutexShared);
danielk1977951af802004-11-05 15:45:09 +00001826 }
drheee46cf2004-11-06 00:02:48 +00001827#endif
drh90f5ecb2004-07-22 01:19:35 +00001828 }
danielk1977aef0bf62005-12-30 16:28:01 +00001829
drhcfed7bc2006-03-13 14:28:05 +00001830#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00001831 /* If the new Btree uses a sharable pBtShared, then link the new
1832 ** Btree into the list of all sharable Btrees for the same connection.
drhabddb0c2007-08-20 13:14:28 +00001833 ** The list is kept in ascending order by pBt address.
danielk197754f01982006-01-18 15:25:17 +00001834 */
drhe53831d2007-08-17 01:14:38 +00001835 if( p->sharable ){
1836 int i;
1837 Btree *pSib;
drhe5fe6902007-12-07 18:55:28 +00001838 for(i=0; i<db->nDb; i++){
1839 if( (pSib = db->aDb[i].pBt)!=0 && pSib->sharable ){
drhe53831d2007-08-17 01:14:38 +00001840 while( pSib->pPrev ){ pSib = pSib->pPrev; }
1841 if( p->pBt<pSib->pBt ){
1842 p->pNext = pSib;
1843 p->pPrev = 0;
1844 pSib->pPrev = p;
1845 }else{
drhabddb0c2007-08-20 13:14:28 +00001846 while( pSib->pNext && pSib->pNext->pBt<p->pBt ){
drhe53831d2007-08-17 01:14:38 +00001847 pSib = pSib->pNext;
1848 }
1849 p->pNext = pSib->pNext;
1850 p->pPrev = pSib;
1851 if( p->pNext ){
1852 p->pNext->pPrev = p;
1853 }
1854 pSib->pNext = p;
1855 }
1856 break;
1857 }
1858 }
danielk1977aef0bf62005-12-30 16:28:01 +00001859 }
danielk1977aef0bf62005-12-30 16:28:01 +00001860#endif
1861 *ppBtree = p;
danielk1977dddbcdc2007-04-26 14:42:34 +00001862
1863btree_open_out:
1864 if( rc!=SQLITE_OK ){
1865 if( pBt && pBt->pPager ){
1866 sqlite3PagerClose(pBt->pPager);
1867 }
drh17435752007-08-16 04:30:38 +00001868 sqlite3_free(pBt);
1869 sqlite3_free(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00001870 *ppBtree = 0;
1871 }
drh7555d8e2009-03-20 13:15:30 +00001872 if( mutexOpen ){
1873 assert( sqlite3_mutex_held(mutexOpen) );
1874 sqlite3_mutex_leave(mutexOpen);
1875 }
danielk1977dddbcdc2007-04-26 14:42:34 +00001876 return rc;
drha059ad02001-04-17 20:09:11 +00001877}
1878
1879/*
drhe53831d2007-08-17 01:14:38 +00001880** Decrement the BtShared.nRef counter. When it reaches zero,
1881** remove the BtShared structure from the sharing list. Return
1882** true if the BtShared.nRef counter reaches zero and return
1883** false if it is still positive.
1884*/
1885static int removeFromSharingList(BtShared *pBt){
1886#ifndef SQLITE_OMIT_SHARED_CACHE
1887 sqlite3_mutex *pMaster;
1888 BtShared *pList;
1889 int removed = 0;
1890
drhd677b3d2007-08-20 22:48:41 +00001891 assert( sqlite3_mutex_notheld(pBt->mutex) );
danielk197759f8c082008-06-18 17:09:10 +00001892 pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhe53831d2007-08-17 01:14:38 +00001893 sqlite3_mutex_enter(pMaster);
1894 pBt->nRef--;
1895 if( pBt->nRef<=0 ){
drh78f82d12008-09-02 00:52:52 +00001896 if( GLOBAL(BtShared*,sqlite3SharedCacheList)==pBt ){
1897 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt->pNext;
drhe53831d2007-08-17 01:14:38 +00001898 }else{
drh78f82d12008-09-02 00:52:52 +00001899 pList = GLOBAL(BtShared*,sqlite3SharedCacheList);
drh34004ce2008-07-11 16:15:17 +00001900 while( ALWAYS(pList) && pList->pNext!=pBt ){
drhe53831d2007-08-17 01:14:38 +00001901 pList=pList->pNext;
1902 }
drh34004ce2008-07-11 16:15:17 +00001903 if( ALWAYS(pList) ){
drhe53831d2007-08-17 01:14:38 +00001904 pList->pNext = pBt->pNext;
1905 }
1906 }
drh3285db22007-09-03 22:00:39 +00001907 if( SQLITE_THREADSAFE ){
1908 sqlite3_mutex_free(pBt->mutex);
1909 }
drhe53831d2007-08-17 01:14:38 +00001910 removed = 1;
1911 }
1912 sqlite3_mutex_leave(pMaster);
1913 return removed;
1914#else
1915 return 1;
1916#endif
1917}
1918
1919/*
drhf7141992008-06-19 00:16:08 +00001920** Make sure pBt->pTmpSpace points to an allocation of
1921** MX_CELL_SIZE(pBt) bytes.
1922*/
1923static void allocateTempSpace(BtShared *pBt){
1924 if( !pBt->pTmpSpace ){
1925 pBt->pTmpSpace = sqlite3PageMalloc( pBt->pageSize );
1926 }
1927}
1928
1929/*
1930** Free the pBt->pTmpSpace allocation
1931*/
1932static void freeTempSpace(BtShared *pBt){
1933 sqlite3PageFree( pBt->pTmpSpace);
1934 pBt->pTmpSpace = 0;
1935}
1936
1937/*
drha059ad02001-04-17 20:09:11 +00001938** Close an open database and invalidate all cursors.
1939*/
danielk1977aef0bf62005-12-30 16:28:01 +00001940int sqlite3BtreeClose(Btree *p){
danielk1977aef0bf62005-12-30 16:28:01 +00001941 BtShared *pBt = p->pBt;
1942 BtCursor *pCur;
1943
danielk1977aef0bf62005-12-30 16:28:01 +00001944 /* Close all cursors opened via this handle. */
drhe5fe6902007-12-07 18:55:28 +00001945 assert( sqlite3_mutex_held(p->db->mutex) );
drhe53831d2007-08-17 01:14:38 +00001946 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00001947 pCur = pBt->pCursor;
1948 while( pCur ){
1949 BtCursor *pTmp = pCur;
1950 pCur = pCur->pNext;
1951 if( pTmp->pBtree==p ){
1952 sqlite3BtreeCloseCursor(pTmp);
1953 }
drha059ad02001-04-17 20:09:11 +00001954 }
danielk1977aef0bf62005-12-30 16:28:01 +00001955
danielk19778d34dfd2006-01-24 16:37:57 +00001956 /* Rollback any active transaction and free the handle structure.
1957 ** The call to sqlite3BtreeRollback() drops any table-locks held by
1958 ** this handle.
1959 */
danielk1977b597f742006-01-15 11:39:18 +00001960 sqlite3BtreeRollback(p);
drhe53831d2007-08-17 01:14:38 +00001961 sqlite3BtreeLeave(p);
danielk1977aef0bf62005-12-30 16:28:01 +00001962
danielk1977aef0bf62005-12-30 16:28:01 +00001963 /* If there are still other outstanding references to the shared-btree
1964 ** structure, return now. The remainder of this procedure cleans
1965 ** up the shared-btree.
1966 */
drhe53831d2007-08-17 01:14:38 +00001967 assert( p->wantToLock==0 && p->locked==0 );
1968 if( !p->sharable || removeFromSharingList(pBt) ){
1969 /* The pBt is no longer on the sharing list, so we can access
1970 ** it without having to hold the mutex.
1971 **
1972 ** Clean out and delete the BtShared object.
1973 */
1974 assert( !pBt->pCursor );
drhe53831d2007-08-17 01:14:38 +00001975 sqlite3PagerClose(pBt->pPager);
1976 if( pBt->xFreeSchema && pBt->pSchema ){
1977 pBt->xFreeSchema(pBt->pSchema);
1978 }
1979 sqlite3_free(pBt->pSchema);
drhf7141992008-06-19 00:16:08 +00001980 freeTempSpace(pBt);
drh65bbf292008-06-19 01:03:17 +00001981 sqlite3_free(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00001982 }
1983
drhe53831d2007-08-17 01:14:38 +00001984#ifndef SQLITE_OMIT_SHARED_CACHE
drhcab5ed72007-08-22 11:41:18 +00001985 assert( p->wantToLock==0 );
1986 assert( p->locked==0 );
1987 if( p->pPrev ) p->pPrev->pNext = p->pNext;
1988 if( p->pNext ) p->pNext->pPrev = p->pPrev;
danielk1977aef0bf62005-12-30 16:28:01 +00001989#endif
1990
drhe53831d2007-08-17 01:14:38 +00001991 sqlite3_free(p);
drha059ad02001-04-17 20:09:11 +00001992 return SQLITE_OK;
1993}
1994
1995/*
drhda47d772002-12-02 04:25:19 +00001996** Change the limit on the number of pages allowed in the cache.
drhcd61c282002-03-06 22:01:34 +00001997**
1998** The maximum number of cache pages is set to the absolute
1999** value of mxPage. If mxPage is negative, the pager will
2000** operate asynchronously - it will not stop to do fsync()s
2001** to insure data is written to the disk surface before
2002** continuing. Transactions still work if synchronous is off,
2003** and the database cannot be corrupted if this program
2004** crashes. But if the operating system crashes or there is
2005** an abrupt power failure when synchronous is off, the database
2006** could be left in an inconsistent and unrecoverable state.
2007** Synchronous is on by default so database corruption is not
2008** normally a worry.
drhf57b14a2001-09-14 18:54:08 +00002009*/
danielk1977aef0bf62005-12-30 16:28:01 +00002010int sqlite3BtreeSetCacheSize(Btree *p, int mxPage){
2011 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00002012 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00002013 sqlite3BtreeEnter(p);
danielk19773b8a05f2007-03-19 17:44:26 +00002014 sqlite3PagerSetCachesize(pBt->pPager, mxPage);
drhd677b3d2007-08-20 22:48:41 +00002015 sqlite3BtreeLeave(p);
drhf57b14a2001-09-14 18:54:08 +00002016 return SQLITE_OK;
2017}
2018
2019/*
drh973b6e32003-02-12 14:09:42 +00002020** Change the way data is synced to disk in order to increase or decrease
2021** how well the database resists damage due to OS crashes and power
2022** failures. Level 1 is the same as asynchronous (no syncs() occur and
2023** there is a high probability of damage) Level 2 is the default. There
2024** is a very low but non-zero probability of damage. Level 3 reduces the
2025** probability of damage to near zero but with a write performance reduction.
2026*/
danielk197793758c82005-01-21 08:13:14 +00002027#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drhac530b12006-02-11 01:25:50 +00002028int sqlite3BtreeSetSafetyLevel(Btree *p, int level, int fullSync){
danielk1977aef0bf62005-12-30 16:28:01 +00002029 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00002030 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00002031 sqlite3BtreeEnter(p);
danielk19773b8a05f2007-03-19 17:44:26 +00002032 sqlite3PagerSetSafetyLevel(pBt->pPager, level, fullSync);
drhd677b3d2007-08-20 22:48:41 +00002033 sqlite3BtreeLeave(p);
drh973b6e32003-02-12 14:09:42 +00002034 return SQLITE_OK;
2035}
danielk197793758c82005-01-21 08:13:14 +00002036#endif
drh973b6e32003-02-12 14:09:42 +00002037
drh2c8997b2005-08-27 16:36:48 +00002038/*
2039** Return TRUE if the given btree is set to safety level 1. In other
2040** words, return TRUE if no sync() occurs on the disk files.
2041*/
danielk1977aef0bf62005-12-30 16:28:01 +00002042int sqlite3BtreeSyncDisabled(Btree *p){
2043 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002044 int rc;
drhe5fe6902007-12-07 18:55:28 +00002045 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00002046 sqlite3BtreeEnter(p);
drhd0679ed2007-08-28 22:24:34 +00002047 assert( pBt && pBt->pPager );
drhd677b3d2007-08-20 22:48:41 +00002048 rc = sqlite3PagerNosync(pBt->pPager);
2049 sqlite3BtreeLeave(p);
2050 return rc;
drh2c8997b2005-08-27 16:36:48 +00002051}
2052
danielk1977576ec6b2005-01-21 11:55:25 +00002053#if !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM)
drh973b6e32003-02-12 14:09:42 +00002054/*
drh90f5ecb2004-07-22 01:19:35 +00002055** Change the default pages size and the number of reserved bytes per page.
drhce4869f2009-04-02 20:16:58 +00002056** Or, if the page size has already been fixed, return SQLITE_READONLY
2057** without changing anything.
drh06f50212004-11-02 14:24:33 +00002058**
2059** The page size must be a power of 2 between 512 and 65536. If the page
2060** size supplied does not meet this constraint then the page size is not
2061** changed.
2062**
2063** Page sizes are constrained to be a power of two so that the region
2064** of the database file used for locking (beginning at PENDING_BYTE,
2065** the first byte past the 1GB boundary, 0x40000000) needs to occur
2066** at the beginning of a page.
danielk197728129562005-01-11 10:25:06 +00002067**
2068** If parameter nReserve is less than zero, then the number of reserved
2069** bytes per page is left unchanged.
drhce4869f2009-04-02 20:16:58 +00002070**
2071** If the iFix!=0 then the pageSizeFixed flag is set so that the page size
2072** and autovacuum mode can no longer be changed.
drh90f5ecb2004-07-22 01:19:35 +00002073*/
drhce4869f2009-04-02 20:16:58 +00002074int sqlite3BtreeSetPageSize(Btree *p, int pageSize, int nReserve, int iFix){
danielk1977a1644fd2007-08-29 12:31:25 +00002075 int rc = SQLITE_OK;
danielk1977aef0bf62005-12-30 16:28:01 +00002076 BtShared *pBt = p->pBt;
drhf49661a2008-12-10 16:45:50 +00002077 assert( nReserve>=-1 && nReserve<=255 );
drhd677b3d2007-08-20 22:48:41 +00002078 sqlite3BtreeEnter(p);
drh90f5ecb2004-07-22 01:19:35 +00002079 if( pBt->pageSizeFixed ){
drhd677b3d2007-08-20 22:48:41 +00002080 sqlite3BtreeLeave(p);
drh90f5ecb2004-07-22 01:19:35 +00002081 return SQLITE_READONLY;
2082 }
2083 if( nReserve<0 ){
2084 nReserve = pBt->pageSize - pBt->usableSize;
2085 }
drhf49661a2008-12-10 16:45:50 +00002086 assert( nReserve>=0 && nReserve<=255 );
drh06f50212004-11-02 14:24:33 +00002087 if( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE &&
2088 ((pageSize-1)&pageSize)==0 ){
drh07d183d2005-05-01 22:52:42 +00002089 assert( (pageSize & 7)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00002090 assert( !pBt->pPage1 && !pBt->pCursor );
drh1bd10f82008-12-10 21:19:56 +00002091 pBt->pageSize = (u16)pageSize;
drhf7141992008-06-19 00:16:08 +00002092 freeTempSpace(pBt);
drh90f5ecb2004-07-22 01:19:35 +00002093 }
drhfa9601a2009-06-18 17:22:39 +00002094 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
drhf49661a2008-12-10 16:45:50 +00002095 pBt->usableSize = pBt->pageSize - (u16)nReserve;
drhce4869f2009-04-02 20:16:58 +00002096 if( iFix ) pBt->pageSizeFixed = 1;
drhd677b3d2007-08-20 22:48:41 +00002097 sqlite3BtreeLeave(p);
danielk1977a1644fd2007-08-29 12:31:25 +00002098 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002099}
2100
2101/*
2102** Return the currently defined page size
2103*/
danielk1977aef0bf62005-12-30 16:28:01 +00002104int sqlite3BtreeGetPageSize(Btree *p){
2105 return p->pBt->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00002106}
drh7f751222009-03-17 22:33:00 +00002107
2108/*
2109** Return the number of bytes of space at the end of every page that
2110** are intentually left unused. This is the "reserved" space that is
2111** sometimes used by extensions.
2112*/
danielk1977aef0bf62005-12-30 16:28:01 +00002113int sqlite3BtreeGetReserve(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00002114 int n;
2115 sqlite3BtreeEnter(p);
2116 n = p->pBt->pageSize - p->pBt->usableSize;
2117 sqlite3BtreeLeave(p);
2118 return n;
drh2011d5f2004-07-22 02:40:37 +00002119}
drhf8e632b2007-05-08 14:51:36 +00002120
2121/*
2122** Set the maximum page count for a database if mxPage is positive.
2123** No changes are made if mxPage is 0 or negative.
2124** Regardless of the value of mxPage, return the maximum page count.
2125*/
2126int sqlite3BtreeMaxPageCount(Btree *p, int mxPage){
drhd677b3d2007-08-20 22:48:41 +00002127 int n;
2128 sqlite3BtreeEnter(p);
2129 n = sqlite3PagerMaxPageCount(p->pBt->pPager, mxPage);
2130 sqlite3BtreeLeave(p);
2131 return n;
drhf8e632b2007-05-08 14:51:36 +00002132}
danielk1977576ec6b2005-01-21 11:55:25 +00002133#endif /* !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM) */
drh90f5ecb2004-07-22 01:19:35 +00002134
2135/*
danielk1977951af802004-11-05 15:45:09 +00002136** Change the 'auto-vacuum' property of the database. If the 'autoVacuum'
2137** parameter is non-zero, then auto-vacuum mode is enabled. If zero, it
2138** is disabled. The default value for the auto-vacuum property is
2139** determined by the SQLITE_DEFAULT_AUTOVACUUM macro.
2140*/
danielk1977aef0bf62005-12-30 16:28:01 +00002141int sqlite3BtreeSetAutoVacuum(Btree *p, int autoVacuum){
danielk1977951af802004-11-05 15:45:09 +00002142#ifdef SQLITE_OMIT_AUTOVACUUM
drheee46cf2004-11-06 00:02:48 +00002143 return SQLITE_READONLY;
danielk1977951af802004-11-05 15:45:09 +00002144#else
danielk1977dddbcdc2007-04-26 14:42:34 +00002145 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002146 int rc = SQLITE_OK;
drh076d4662009-02-18 20:31:18 +00002147 u8 av = (u8)autoVacuum;
drhd677b3d2007-08-20 22:48:41 +00002148
2149 sqlite3BtreeEnter(p);
drh076d4662009-02-18 20:31:18 +00002150 if( pBt->pageSizeFixed && (av ?1:0)!=pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00002151 rc = SQLITE_READONLY;
2152 }else{
drh076d4662009-02-18 20:31:18 +00002153 pBt->autoVacuum = av ?1:0;
2154 pBt->incrVacuum = av==2 ?1:0;
danielk1977951af802004-11-05 15:45:09 +00002155 }
drhd677b3d2007-08-20 22:48:41 +00002156 sqlite3BtreeLeave(p);
2157 return rc;
danielk1977951af802004-11-05 15:45:09 +00002158#endif
2159}
2160
2161/*
2162** Return the value of the 'auto-vacuum' property. If auto-vacuum is
2163** enabled 1 is returned. Otherwise 0.
2164*/
danielk1977aef0bf62005-12-30 16:28:01 +00002165int sqlite3BtreeGetAutoVacuum(Btree *p){
danielk1977951af802004-11-05 15:45:09 +00002166#ifdef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00002167 return BTREE_AUTOVACUUM_NONE;
danielk1977951af802004-11-05 15:45:09 +00002168#else
drhd677b3d2007-08-20 22:48:41 +00002169 int rc;
2170 sqlite3BtreeEnter(p);
2171 rc = (
danielk1977dddbcdc2007-04-26 14:42:34 +00002172 (!p->pBt->autoVacuum)?BTREE_AUTOVACUUM_NONE:
2173 (!p->pBt->incrVacuum)?BTREE_AUTOVACUUM_FULL:
2174 BTREE_AUTOVACUUM_INCR
2175 );
drhd677b3d2007-08-20 22:48:41 +00002176 sqlite3BtreeLeave(p);
2177 return rc;
danielk1977951af802004-11-05 15:45:09 +00002178#endif
2179}
2180
2181
2182/*
drha34b6762004-05-07 13:30:42 +00002183** Get a reference to pPage1 of the database file. This will
drh306dc212001-05-21 13:45:10 +00002184** also acquire a readlock on that file.
2185**
2186** SQLITE_OK is returned on success. If the file is not a
2187** well-formed database file, then SQLITE_CORRUPT is returned.
2188** SQLITE_BUSY is returned if the database is locked. SQLITE_NOMEM
drh4f0ee682007-03-30 20:43:40 +00002189** is returned if we run out of memory.
drh306dc212001-05-21 13:45:10 +00002190*/
danielk1977aef0bf62005-12-30 16:28:01 +00002191static int lockBtree(BtShared *pBt){
danielk1977f653d782008-03-20 11:04:21 +00002192 int rc;
drh3aac2dd2004-04-26 14:10:20 +00002193 MemPage *pPage1;
danielk197793f7af92008-05-09 16:57:50 +00002194 int nPage;
drhd677b3d2007-08-20 22:48:41 +00002195
drh1fee73e2007-08-29 04:00:57 +00002196 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977295dc102009-04-01 19:07:03 +00002197 assert( pBt->pPage1==0 );
danielk197730548662009-07-09 05:07:37 +00002198 rc = btreeGetPage(pBt, 1, &pPage1, 0);
drh306dc212001-05-21 13:45:10 +00002199 if( rc!=SQLITE_OK ) return rc;
drh306dc212001-05-21 13:45:10 +00002200
2201 /* Do some checking to help insure the file we opened really is
2202 ** a valid database file.
2203 */
danielk1977ad0132d2008-06-07 08:58:22 +00002204 rc = sqlite3PagerPagecount(pBt->pPager, &nPage);
2205 if( rc!=SQLITE_OK ){
danielk197793f7af92008-05-09 16:57:50 +00002206 goto page1_init_failed;
2207 }else if( nPage>0 ){
danielk1977f653d782008-03-20 11:04:21 +00002208 int pageSize;
2209 int usableSize;
drhb6f41482004-05-14 01:58:11 +00002210 u8 *page1 = pPage1->aData;
danielk1977ad0132d2008-06-07 08:58:22 +00002211 rc = SQLITE_NOTADB;
drhb6f41482004-05-14 01:58:11 +00002212 if( memcmp(page1, zMagicHeader, 16)!=0 ){
drh72f82862001-05-24 21:06:34 +00002213 goto page1_init_failed;
drh306dc212001-05-21 13:45:10 +00002214 }
drh309169a2007-04-24 17:27:51 +00002215 if( page1[18]>1 ){
2216 pBt->readOnly = 1;
2217 }
2218 if( page1[19]>1 ){
drhb6f41482004-05-14 01:58:11 +00002219 goto page1_init_failed;
2220 }
drhe5ae5732008-06-15 02:51:47 +00002221
2222 /* The maximum embedded fraction must be exactly 25%. And the minimum
2223 ** embedded fraction must be 12.5% for both leaf-data and non-leaf-data.
2224 ** The original design allowed these amounts to vary, but as of
2225 ** version 3.6.0, we require them to be fixed.
2226 */
2227 if( memcmp(&page1[21], "\100\040\040",3)!=0 ){
2228 goto page1_init_failed;
2229 }
drh07d183d2005-05-01 22:52:42 +00002230 pageSize = get2byte(&page1[16]);
drh7dc385e2007-09-06 23:39:36 +00002231 if( ((pageSize-1)&pageSize)!=0 || pageSize<512 ||
2232 (SQLITE_MAX_PAGE_SIZE<32768 && pageSize>SQLITE_MAX_PAGE_SIZE)
2233 ){
drh07d183d2005-05-01 22:52:42 +00002234 goto page1_init_failed;
2235 }
2236 assert( (pageSize & 7)==0 );
danielk1977f653d782008-03-20 11:04:21 +00002237 usableSize = pageSize - page1[20];
2238 if( pageSize!=pBt->pageSize ){
2239 /* After reading the first page of the database assuming a page size
2240 ** of BtShared.pageSize, we have discovered that the page-size is
2241 ** actually pageSize. Unlock the database, leave pBt->pPage1 at
2242 ** zero and return SQLITE_OK. The caller will call this function
2243 ** again with the correct page-size.
2244 */
2245 releasePage(pPage1);
drhf49661a2008-12-10 16:45:50 +00002246 pBt->usableSize = (u16)usableSize;
2247 pBt->pageSize = (u16)pageSize;
drhf7141992008-06-19 00:16:08 +00002248 freeTempSpace(pBt);
drhfa9601a2009-06-18 17:22:39 +00002249 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize,
2250 pageSize-usableSize);
drh5e483932009-07-10 16:51:30 +00002251 return rc;
danielk1977f653d782008-03-20 11:04:21 +00002252 }
drhb33e1b92009-06-18 11:29:20 +00002253 if( usableSize<480 ){
drhb6f41482004-05-14 01:58:11 +00002254 goto page1_init_failed;
2255 }
drh1bd10f82008-12-10 21:19:56 +00002256 pBt->pageSize = (u16)pageSize;
2257 pBt->usableSize = (u16)usableSize;
drh057cd3a2005-02-15 16:23:02 +00002258#ifndef SQLITE_OMIT_AUTOVACUUM
2259 pBt->autoVacuum = (get4byte(&page1[36 + 4*4])?1:0);
danielk197727b1f952007-06-25 08:16:58 +00002260 pBt->incrVacuum = (get4byte(&page1[36 + 7*4])?1:0);
drh057cd3a2005-02-15 16:23:02 +00002261#endif
drh306dc212001-05-21 13:45:10 +00002262 }
drhb6f41482004-05-14 01:58:11 +00002263
2264 /* maxLocal is the maximum amount of payload to store locally for
2265 ** a cell. Make sure it is small enough so that at least minFanout
2266 ** cells can will fit on one page. We assume a 10-byte page header.
2267 ** Besides the payload, the cell must store:
drh43605152004-05-29 21:46:49 +00002268 ** 2-byte pointer to the cell
drhb6f41482004-05-14 01:58:11 +00002269 ** 4-byte child pointer
2270 ** 9-byte nKey value
2271 ** 4-byte nData value
2272 ** 4-byte overflow page pointer
drh43605152004-05-29 21:46:49 +00002273 ** So a cell consists of a 2-byte poiner, a header which is as much as
2274 ** 17 bytes long, 0 to N bytes of payload, and an optional 4 byte overflow
2275 ** page pointer.
drhb6f41482004-05-14 01:58:11 +00002276 */
drhe5ae5732008-06-15 02:51:47 +00002277 pBt->maxLocal = (pBt->usableSize-12)*64/255 - 23;
2278 pBt->minLocal = (pBt->usableSize-12)*32/255 - 23;
drh43605152004-05-29 21:46:49 +00002279 pBt->maxLeaf = pBt->usableSize - 35;
drhe5ae5732008-06-15 02:51:47 +00002280 pBt->minLeaf = (pBt->usableSize-12)*32/255 - 23;
drh2e38c322004-09-03 18:38:44 +00002281 assert( pBt->maxLeaf + 23 <= MX_CELL_SIZE(pBt) );
drh3aac2dd2004-04-26 14:10:20 +00002282 pBt->pPage1 = pPage1;
drhb6f41482004-05-14 01:58:11 +00002283 return SQLITE_OK;
drh306dc212001-05-21 13:45:10 +00002284
drh72f82862001-05-24 21:06:34 +00002285page1_init_failed:
drh3aac2dd2004-04-26 14:10:20 +00002286 releasePage(pPage1);
2287 pBt->pPage1 = 0;
drh72f82862001-05-24 21:06:34 +00002288 return rc;
drh306dc212001-05-21 13:45:10 +00002289}
2290
2291/*
drhb8ca3072001-12-05 00:21:20 +00002292** If there are no outstanding cursors and we are not in the middle
2293** of a transaction but there is a read lock on the database, then
2294** this routine unrefs the first page of the database file which
2295** has the effect of releasing the read lock.
2296**
drhb8ca3072001-12-05 00:21:20 +00002297** If there is a transaction in progress, this routine is a no-op.
2298*/
danielk1977aef0bf62005-12-30 16:28:01 +00002299static void unlockBtreeIfUnused(BtShared *pBt){
drh1fee73e2007-08-29 04:00:57 +00002300 assert( sqlite3_mutex_held(pBt->mutex) );
danielk19771bc9ee92009-07-04 15:41:02 +00002301 assert( pBt->pCursor==0 || pBt->inTransaction>TRANS_NONE );
2302 if( pBt->inTransaction==TRANS_NONE && pBt->pPage1!=0 ){
danielk1977c1761e82009-06-25 09:40:03 +00002303 assert( pBt->pPage1->aData );
2304 assert( sqlite3PagerRefcount(pBt->pPager)==1 );
2305 assert( pBt->pPage1->aData );
2306 releasePage(pBt->pPage1);
drh3aac2dd2004-04-26 14:10:20 +00002307 pBt->pPage1 = 0;
drhb8ca3072001-12-05 00:21:20 +00002308 }
2309}
2310
2311/*
drh9e572e62004-04-23 23:43:10 +00002312** Create a new database by initializing the first page of the
drh8c42ca92001-06-22 19:15:00 +00002313** file.
drh8b2f49b2001-06-08 00:21:52 +00002314*/
danielk1977aef0bf62005-12-30 16:28:01 +00002315static int newDatabase(BtShared *pBt){
drh9e572e62004-04-23 23:43:10 +00002316 MemPage *pP1;
2317 unsigned char *data;
drh8c42ca92001-06-22 19:15:00 +00002318 int rc;
danielk1977ad0132d2008-06-07 08:58:22 +00002319 int nPage;
drhd677b3d2007-08-20 22:48:41 +00002320
drh1fee73e2007-08-29 04:00:57 +00002321 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977ad0132d2008-06-07 08:58:22 +00002322 rc = sqlite3PagerPagecount(pBt->pPager, &nPage);
2323 if( rc!=SQLITE_OK || nPage>0 ){
2324 return rc;
2325 }
drh3aac2dd2004-04-26 14:10:20 +00002326 pP1 = pBt->pPage1;
drh9e572e62004-04-23 23:43:10 +00002327 assert( pP1!=0 );
2328 data = pP1->aData;
danielk19773b8a05f2007-03-19 17:44:26 +00002329 rc = sqlite3PagerWrite(pP1->pDbPage);
drh8b2f49b2001-06-08 00:21:52 +00002330 if( rc ) return rc;
drh9e572e62004-04-23 23:43:10 +00002331 memcpy(data, zMagicHeader, sizeof(zMagicHeader));
2332 assert( sizeof(zMagicHeader)==16 );
drhb6f41482004-05-14 01:58:11 +00002333 put2byte(&data[16], pBt->pageSize);
drh9e572e62004-04-23 23:43:10 +00002334 data[18] = 1;
2335 data[19] = 1;
drhf49661a2008-12-10 16:45:50 +00002336 assert( pBt->usableSize<=pBt->pageSize && pBt->usableSize+255>=pBt->pageSize);
2337 data[20] = (u8)(pBt->pageSize - pBt->usableSize);
drhe5ae5732008-06-15 02:51:47 +00002338 data[21] = 64;
2339 data[22] = 32;
2340 data[23] = 32;
drhb6f41482004-05-14 01:58:11 +00002341 memset(&data[24], 0, 100-24);
drhe6c43812004-05-14 12:17:46 +00002342 zeroPage(pP1, PTF_INTKEY|PTF_LEAF|PTF_LEAFDATA );
drhf2a611c2004-09-05 00:33:43 +00002343 pBt->pageSizeFixed = 1;
danielk1977003ba062004-11-04 02:57:33 +00002344#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00002345 assert( pBt->autoVacuum==1 || pBt->autoVacuum==0 );
danielk1977418899a2007-06-24 10:14:00 +00002346 assert( pBt->incrVacuum==1 || pBt->incrVacuum==0 );
danielk1977dddbcdc2007-04-26 14:42:34 +00002347 put4byte(&data[36 + 4*4], pBt->autoVacuum);
danielk1977418899a2007-06-24 10:14:00 +00002348 put4byte(&data[36 + 7*4], pBt->incrVacuum);
danielk1977003ba062004-11-04 02:57:33 +00002349#endif
drh8b2f49b2001-06-08 00:21:52 +00002350 return SQLITE_OK;
2351}
2352
2353/*
danielk1977ee5741e2004-05-31 10:01:34 +00002354** Attempt to start a new transaction. A write-transaction
drh684917c2004-10-05 02:41:42 +00002355** is started if the second argument is nonzero, otherwise a read-
2356** transaction. If the second argument is 2 or more and exclusive
2357** transaction is started, meaning that no other process is allowed
2358** to access the database. A preexisting transaction may not be
drhb8ef32c2005-03-14 02:01:49 +00002359** upgraded to exclusive by calling this routine a second time - the
drh684917c2004-10-05 02:41:42 +00002360** exclusivity flag only works for a new transaction.
drh8b2f49b2001-06-08 00:21:52 +00002361**
danielk1977ee5741e2004-05-31 10:01:34 +00002362** A write-transaction must be started before attempting any
2363** changes to the database. None of the following routines
2364** will work unless a transaction is started first:
drh8b2f49b2001-06-08 00:21:52 +00002365**
drh23e11ca2004-05-04 17:27:28 +00002366** sqlite3BtreeCreateTable()
2367** sqlite3BtreeCreateIndex()
2368** sqlite3BtreeClearTable()
2369** sqlite3BtreeDropTable()
2370** sqlite3BtreeInsert()
2371** sqlite3BtreeDelete()
2372** sqlite3BtreeUpdateMeta()
danielk197713adf8a2004-06-03 16:08:41 +00002373**
drhb8ef32c2005-03-14 02:01:49 +00002374** If an initial attempt to acquire the lock fails because of lock contention
2375** and the database was previously unlocked, then invoke the busy handler
2376** if there is one. But if there was previously a read-lock, do not
2377** invoke the busy handler - just return SQLITE_BUSY. SQLITE_BUSY is
2378** returned when there is already a read-lock in order to avoid a deadlock.
2379**
2380** Suppose there are two processes A and B. A has a read lock and B has
2381** a reserved lock. B tries to promote to exclusive but is blocked because
2382** of A's read lock. A tries to promote to reserved but is blocked by B.
2383** One or the other of the two processes must give way or there can be
2384** no progress. By returning SQLITE_BUSY and not invoking the busy callback
2385** when A already has a read lock, we encourage A to give up and let B
2386** proceed.
drha059ad02001-04-17 20:09:11 +00002387*/
danielk1977aef0bf62005-12-30 16:28:01 +00002388int sqlite3BtreeBeginTrans(Btree *p, int wrflag){
danielk1977404ca072009-03-16 13:19:36 +00002389 sqlite3 *pBlock = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002390 BtShared *pBt = p->pBt;
danielk1977ee5741e2004-05-31 10:01:34 +00002391 int rc = SQLITE_OK;
2392
drhd677b3d2007-08-20 22:48:41 +00002393 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002394 btreeIntegrity(p);
2395
danielk1977ee5741e2004-05-31 10:01:34 +00002396 /* If the btree is already in a write-transaction, or it
2397 ** is already in a read-transaction and a read-transaction
2398 ** is requested, this is a no-op.
2399 */
danielk1977aef0bf62005-12-30 16:28:01 +00002400 if( p->inTrans==TRANS_WRITE || (p->inTrans==TRANS_READ && !wrflag) ){
drhd677b3d2007-08-20 22:48:41 +00002401 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00002402 }
drhb8ef32c2005-03-14 02:01:49 +00002403
2404 /* Write transactions are not possible on a read-only database */
danielk1977ee5741e2004-05-31 10:01:34 +00002405 if( pBt->readOnly && wrflag ){
drhd677b3d2007-08-20 22:48:41 +00002406 rc = SQLITE_READONLY;
2407 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00002408 }
2409
danielk1977404ca072009-03-16 13:19:36 +00002410#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +00002411 /* If another database handle has already opened a write transaction
2412 ** on this shared-btree structure and a second write transaction is
danielk1977404ca072009-03-16 13:19:36 +00002413 ** requested, return SQLITE_LOCKED.
danielk1977aef0bf62005-12-30 16:28:01 +00002414 */
danielk1977404ca072009-03-16 13:19:36 +00002415 if( (wrflag && pBt->inTransaction==TRANS_WRITE) || pBt->isPending ){
2416 pBlock = pBt->pWriter->db;
2417 }else if( wrflag>1 ){
danielk1977641b0f42007-12-21 04:47:25 +00002418 BtLock *pIter;
2419 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
2420 if( pIter->pBtree!=p ){
danielk1977404ca072009-03-16 13:19:36 +00002421 pBlock = pIter->pBtree->db;
2422 break;
danielk1977641b0f42007-12-21 04:47:25 +00002423 }
2424 }
2425 }
danielk1977404ca072009-03-16 13:19:36 +00002426 if( pBlock ){
2427 sqlite3ConnectionBlocked(p->db, pBlock);
2428 rc = SQLITE_LOCKED_SHAREDCACHE;
2429 goto trans_begun;
2430 }
danielk1977641b0f42007-12-21 04:47:25 +00002431#endif
2432
danielk1977602b4662009-07-02 07:47:33 +00002433 /* Any read-only or read-write transaction implies a read-lock on
2434 ** page 1. So if some other shared-cache client already has a write-lock
2435 ** on page 1, the transaction cannot be opened. */
2436 if( SQLITE_OK!=(rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK)) ){
2437 goto trans_begun;
2438 }
2439
drhb8ef32c2005-03-14 02:01:49 +00002440 do {
danielk1977295dc102009-04-01 19:07:03 +00002441 /* Call lockBtree() until either pBt->pPage1 is populated or
2442 ** lockBtree() returns something other than SQLITE_OK. lockBtree()
2443 ** may return SQLITE_OK but leave pBt->pPage1 set to 0 if after
2444 ** reading page 1 it discovers that the page-size of the database
2445 ** file is not pBt->pageSize. In this case lockBtree() will update
2446 ** pBt->pageSize to the page-size of the file on disk.
2447 */
2448 while( pBt->pPage1==0 && SQLITE_OK==(rc = lockBtree(pBt)) );
drh309169a2007-04-24 17:27:51 +00002449
drhb8ef32c2005-03-14 02:01:49 +00002450 if( rc==SQLITE_OK && wrflag ){
drh309169a2007-04-24 17:27:51 +00002451 if( pBt->readOnly ){
2452 rc = SQLITE_READONLY;
2453 }else{
danielk1977d8293352009-04-30 09:10:37 +00002454 rc = sqlite3PagerBegin(pBt->pPager,wrflag>1,sqlite3TempInMemory(p->db));
drh309169a2007-04-24 17:27:51 +00002455 if( rc==SQLITE_OK ){
2456 rc = newDatabase(pBt);
2457 }
drhb8ef32c2005-03-14 02:01:49 +00002458 }
2459 }
2460
danielk1977bd434552009-03-18 10:33:00 +00002461 if( rc!=SQLITE_OK ){
drhb8ef32c2005-03-14 02:01:49 +00002462 unlockBtreeIfUnused(pBt);
2463 }
danielk1977aef0bf62005-12-30 16:28:01 +00002464 }while( rc==SQLITE_BUSY && pBt->inTransaction==TRANS_NONE &&
danielk19771ceedd32008-11-19 10:22:33 +00002465 btreeInvokeBusyHandler(pBt) );
danielk1977aef0bf62005-12-30 16:28:01 +00002466
2467 if( rc==SQLITE_OK ){
2468 if( p->inTrans==TRANS_NONE ){
2469 pBt->nTransaction++;
danielk1977602b4662009-07-02 07:47:33 +00002470#ifndef SQLITE_OMIT_SHARED_CACHE
2471 if( p->sharable ){
2472 assert( p->lock.pBtree==p && p->lock.iTable==1 );
2473 p->lock.eLock = READ_LOCK;
2474 p->lock.pNext = pBt->pLock;
2475 pBt->pLock = &p->lock;
2476 }
2477#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002478 }
2479 p->inTrans = (wrflag?TRANS_WRITE:TRANS_READ);
2480 if( p->inTrans>pBt->inTransaction ){
2481 pBt->inTransaction = p->inTrans;
2482 }
danielk1977641b0f42007-12-21 04:47:25 +00002483#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977404ca072009-03-16 13:19:36 +00002484 if( wrflag ){
2485 assert( !pBt->pWriter );
2486 pBt->pWriter = p;
shaneca18d202009-03-23 02:34:32 +00002487 pBt->isExclusive = (u8)(wrflag>1);
danielk1977641b0f42007-12-21 04:47:25 +00002488 }
2489#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002490 }
2491
drhd677b3d2007-08-20 22:48:41 +00002492
2493trans_begun:
danielk1977fd7f0452008-12-17 17:30:26 +00002494 if( rc==SQLITE_OK && wrflag ){
danielk197712dd5492008-12-18 15:45:07 +00002495 /* This call makes sure that the pager has the correct number of
2496 ** open savepoints. If the second parameter is greater than 0 and
2497 ** the sub-journal is not already open, then it will be opened here.
2498 */
danielk1977fd7f0452008-12-17 17:30:26 +00002499 rc = sqlite3PagerOpenSavepoint(pBt->pPager, p->db->nSavepoint);
2500 }
danielk197712dd5492008-12-18 15:45:07 +00002501
danielk1977aef0bf62005-12-30 16:28:01 +00002502 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00002503 sqlite3BtreeLeave(p);
drhb8ca3072001-12-05 00:21:20 +00002504 return rc;
drha059ad02001-04-17 20:09:11 +00002505}
2506
danielk1977687566d2004-11-02 12:56:41 +00002507#ifndef SQLITE_OMIT_AUTOVACUUM
2508
2509/*
2510** Set the pointer-map entries for all children of page pPage. Also, if
2511** pPage contains cells that point to overflow pages, set the pointer
2512** map entries for the overflow pages as well.
2513*/
2514static int setChildPtrmaps(MemPage *pPage){
2515 int i; /* Counter variable */
2516 int nCell; /* Number of cells in page pPage */
danielk19772df71c72007-05-24 07:22:42 +00002517 int rc; /* Return code */
danielk1977aef0bf62005-12-30 16:28:01 +00002518 BtShared *pBt = pPage->pBt;
drhf49661a2008-12-10 16:45:50 +00002519 u8 isInitOrig = pPage->isInit;
danielk1977687566d2004-11-02 12:56:41 +00002520 Pgno pgno = pPage->pgno;
2521
drh1fee73e2007-08-29 04:00:57 +00002522 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk197730548662009-07-09 05:07:37 +00002523 rc = btreeInitPage(pPage);
danielk19772df71c72007-05-24 07:22:42 +00002524 if( rc!=SQLITE_OK ){
2525 goto set_child_ptrmaps_out;
2526 }
danielk1977687566d2004-11-02 12:56:41 +00002527 nCell = pPage->nCell;
2528
2529 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00002530 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00002531
danielk197726836652005-01-17 01:33:13 +00002532 rc = ptrmapPutOvflPtr(pPage, pCell);
2533 if( rc!=SQLITE_OK ){
2534 goto set_child_ptrmaps_out;
danielk1977687566d2004-11-02 12:56:41 +00002535 }
danielk197726836652005-01-17 01:33:13 +00002536
danielk1977687566d2004-11-02 12:56:41 +00002537 if( !pPage->leaf ){
2538 Pgno childPgno = get4byte(pCell);
2539 rc = ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno);
danielk197700a696d2008-09-29 16:41:31 +00002540 if( rc!=SQLITE_OK ) goto set_child_ptrmaps_out;
danielk1977687566d2004-11-02 12:56:41 +00002541 }
2542 }
2543
2544 if( !pPage->leaf ){
2545 Pgno childPgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
2546 rc = ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno);
2547 }
2548
2549set_child_ptrmaps_out:
2550 pPage->isInit = isInitOrig;
2551 return rc;
2552}
2553
2554/*
drhf3aed592009-07-08 18:12:49 +00002555** Somewhere on pPage is a pointer to page iFrom. Modify this pointer so
2556** that it points to iTo. Parameter eType describes the type of pointer to
2557** be modified, as follows:
danielk1977687566d2004-11-02 12:56:41 +00002558**
2559** PTRMAP_BTREE: pPage is a btree-page. The pointer points at a child
2560** page of pPage.
2561**
2562** PTRMAP_OVERFLOW1: pPage is a btree-page. The pointer points at an overflow
2563** page pointed to by one of the cells on pPage.
2564**
2565** PTRMAP_OVERFLOW2: pPage is an overflow-page. The pointer points at the next
2566** overflow page in the list.
2567*/
danielk1977fdb7cdb2005-01-17 02:12:18 +00002568static int modifyPagePointer(MemPage *pPage, Pgno iFrom, Pgno iTo, u8 eType){
drh1fee73e2007-08-29 04:00:57 +00002569 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhc5053fb2008-11-27 02:22:10 +00002570 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
danielk1977687566d2004-11-02 12:56:41 +00002571 if( eType==PTRMAP_OVERFLOW2 ){
danielk1977f78fc082004-11-02 14:40:32 +00002572 /* The pointer is always the first 4 bytes of the page in this case. */
danielk1977fdb7cdb2005-01-17 02:12:18 +00002573 if( get4byte(pPage->aData)!=iFrom ){
drh49285702005-09-17 15:20:26 +00002574 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +00002575 }
danielk1977f78fc082004-11-02 14:40:32 +00002576 put4byte(pPage->aData, iTo);
danielk1977687566d2004-11-02 12:56:41 +00002577 }else{
drhf49661a2008-12-10 16:45:50 +00002578 u8 isInitOrig = pPage->isInit;
danielk1977687566d2004-11-02 12:56:41 +00002579 int i;
2580 int nCell;
2581
danielk197730548662009-07-09 05:07:37 +00002582 btreeInitPage(pPage);
danielk1977687566d2004-11-02 12:56:41 +00002583 nCell = pPage->nCell;
2584
danielk1977687566d2004-11-02 12:56:41 +00002585 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00002586 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00002587 if( eType==PTRMAP_OVERFLOW1 ){
2588 CellInfo info;
danielk197730548662009-07-09 05:07:37 +00002589 btreeParseCellPtr(pPage, pCell, &info);
danielk1977687566d2004-11-02 12:56:41 +00002590 if( info.iOverflow ){
2591 if( iFrom==get4byte(&pCell[info.iOverflow]) ){
2592 put4byte(&pCell[info.iOverflow], iTo);
2593 break;
2594 }
2595 }
2596 }else{
2597 if( get4byte(pCell)==iFrom ){
2598 put4byte(pCell, iTo);
2599 break;
2600 }
2601 }
2602 }
2603
2604 if( i==nCell ){
danielk1977fdb7cdb2005-01-17 02:12:18 +00002605 if( eType!=PTRMAP_BTREE ||
2606 get4byte(&pPage->aData[pPage->hdrOffset+8])!=iFrom ){
drh49285702005-09-17 15:20:26 +00002607 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +00002608 }
danielk1977687566d2004-11-02 12:56:41 +00002609 put4byte(&pPage->aData[pPage->hdrOffset+8], iTo);
2610 }
2611
2612 pPage->isInit = isInitOrig;
2613 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00002614 return SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00002615}
2616
danielk1977003ba062004-11-04 02:57:33 +00002617
danielk19777701e812005-01-10 12:59:51 +00002618/*
2619** Move the open database page pDbPage to location iFreePage in the
2620** database. The pDbPage reference remains valid.
2621*/
danielk1977003ba062004-11-04 02:57:33 +00002622static int relocatePage(
danielk1977aef0bf62005-12-30 16:28:01 +00002623 BtShared *pBt, /* Btree */
danielk19777701e812005-01-10 12:59:51 +00002624 MemPage *pDbPage, /* Open page to move */
2625 u8 eType, /* Pointer map 'type' entry for pDbPage */
2626 Pgno iPtrPage, /* Pointer map 'page-no' entry for pDbPage */
danielk19774c999992008-07-16 18:17:55 +00002627 Pgno iFreePage, /* The location to move pDbPage to */
2628 int isCommit
danielk1977003ba062004-11-04 02:57:33 +00002629){
2630 MemPage *pPtrPage; /* The page that contains a pointer to pDbPage */
2631 Pgno iDbPage = pDbPage->pgno;
2632 Pager *pPager = pBt->pPager;
2633 int rc;
2634
danielk1977a0bf2652004-11-04 14:30:04 +00002635 assert( eType==PTRMAP_OVERFLOW2 || eType==PTRMAP_OVERFLOW1 ||
2636 eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE );
drh1fee73e2007-08-29 04:00:57 +00002637 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +00002638 assert( pDbPage->pBt==pBt );
danielk1977003ba062004-11-04 02:57:33 +00002639
drh85b623f2007-12-13 21:54:09 +00002640 /* Move page iDbPage from its current location to page number iFreePage */
danielk1977003ba062004-11-04 02:57:33 +00002641 TRACE(("AUTOVACUUM: Moving %d to free page %d (ptr page %d type %d)\n",
2642 iDbPage, iFreePage, iPtrPage, eType));
danielk19774c999992008-07-16 18:17:55 +00002643 rc = sqlite3PagerMovepage(pPager, pDbPage->pDbPage, iFreePage, isCommit);
danielk1977003ba062004-11-04 02:57:33 +00002644 if( rc!=SQLITE_OK ){
2645 return rc;
2646 }
2647 pDbPage->pgno = iFreePage;
2648
2649 /* If pDbPage was a btree-page, then it may have child pages and/or cells
2650 ** that point to overflow pages. The pointer map entries for all these
2651 ** pages need to be changed.
2652 **
2653 ** If pDbPage is an overflow page, then the first 4 bytes may store a
2654 ** pointer to a subsequent overflow page. If this is the case, then
2655 ** the pointer map needs to be updated for the subsequent overflow page.
2656 */
danielk1977a0bf2652004-11-04 14:30:04 +00002657 if( eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00002658 rc = setChildPtrmaps(pDbPage);
2659 if( rc!=SQLITE_OK ){
2660 return rc;
2661 }
2662 }else{
2663 Pgno nextOvfl = get4byte(pDbPage->aData);
2664 if( nextOvfl!=0 ){
danielk1977003ba062004-11-04 02:57:33 +00002665 rc = ptrmapPut(pBt, nextOvfl, PTRMAP_OVERFLOW2, iFreePage);
2666 if( rc!=SQLITE_OK ){
2667 return rc;
2668 }
2669 }
2670 }
2671
2672 /* Fix the database pointer on page iPtrPage that pointed at iDbPage so
2673 ** that it points at iFreePage. Also fix the pointer map entry for
2674 ** iPtrPage.
2675 */
danielk1977a0bf2652004-11-04 14:30:04 +00002676 if( eType!=PTRMAP_ROOTPAGE ){
danielk197730548662009-07-09 05:07:37 +00002677 rc = btreeGetPage(pBt, iPtrPage, &pPtrPage, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00002678 if( rc!=SQLITE_OK ){
2679 return rc;
2680 }
danielk19773b8a05f2007-03-19 17:44:26 +00002681 rc = sqlite3PagerWrite(pPtrPage->pDbPage);
danielk1977a0bf2652004-11-04 14:30:04 +00002682 if( rc!=SQLITE_OK ){
2683 releasePage(pPtrPage);
2684 return rc;
2685 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00002686 rc = modifyPagePointer(pPtrPage, iDbPage, iFreePage, eType);
danielk1977003ba062004-11-04 02:57:33 +00002687 releasePage(pPtrPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00002688 if( rc==SQLITE_OK ){
2689 rc = ptrmapPut(pBt, iFreePage, eType, iPtrPage);
2690 }
danielk1977003ba062004-11-04 02:57:33 +00002691 }
danielk1977003ba062004-11-04 02:57:33 +00002692 return rc;
2693}
2694
danielk1977dddbcdc2007-04-26 14:42:34 +00002695/* Forward declaration required by incrVacuumStep(). */
drh4f0c5872007-03-26 22:05:01 +00002696static int allocateBtreePage(BtShared *, MemPage **, Pgno *, Pgno, u8);
danielk1977687566d2004-11-02 12:56:41 +00002697
2698/*
danielk1977dddbcdc2007-04-26 14:42:34 +00002699** Perform a single step of an incremental-vacuum. If successful,
2700** return SQLITE_OK. If there is no work to do (and therefore no
2701** point in calling this function again), return SQLITE_DONE.
2702**
2703** More specificly, this function attempts to re-organize the
2704** database so that the last page of the file currently in use
2705** is no longer in use.
2706**
2707** If the nFin parameter is non-zero, the implementation assumes
2708** that the caller will keep calling incrVacuumStep() until
2709** it returns SQLITE_DONE or an error, and that nFin is the
2710** number of pages the database file will contain after this
2711** process is complete.
2712*/
danielk19773460d192008-12-27 15:23:13 +00002713static int incrVacuumStep(BtShared *pBt, Pgno nFin, Pgno iLastPg){
danielk1977dddbcdc2007-04-26 14:42:34 +00002714 Pgno nFreeList; /* Number of pages still on the free-list */
2715
drh1fee73e2007-08-29 04:00:57 +00002716 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977fa542f12009-04-02 18:28:08 +00002717 assert( iLastPg>nFin );
danielk1977dddbcdc2007-04-26 14:42:34 +00002718
2719 if( !PTRMAP_ISPAGE(pBt, iLastPg) && iLastPg!=PENDING_BYTE_PAGE(pBt) ){
2720 int rc;
2721 u8 eType;
2722 Pgno iPtrPage;
2723
2724 nFreeList = get4byte(&pBt->pPage1->aData[36]);
danielk1977fa542f12009-04-02 18:28:08 +00002725 if( nFreeList==0 ){
danielk1977dddbcdc2007-04-26 14:42:34 +00002726 return SQLITE_DONE;
2727 }
2728
2729 rc = ptrmapGet(pBt, iLastPg, &eType, &iPtrPage);
2730 if( rc!=SQLITE_OK ){
2731 return rc;
2732 }
2733 if( eType==PTRMAP_ROOTPAGE ){
2734 return SQLITE_CORRUPT_BKPT;
2735 }
2736
2737 if( eType==PTRMAP_FREEPAGE ){
2738 if( nFin==0 ){
2739 /* Remove the page from the files free-list. This is not required
danielk19774ef24492007-05-23 09:52:41 +00002740 ** if nFin is non-zero. In that case, the free-list will be
danielk1977dddbcdc2007-04-26 14:42:34 +00002741 ** truncated to zero after this function returns, so it doesn't
2742 ** matter if it still contains some garbage entries.
2743 */
2744 Pgno iFreePg;
2745 MemPage *pFreePg;
2746 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iLastPg, 1);
2747 if( rc!=SQLITE_OK ){
2748 return rc;
2749 }
2750 assert( iFreePg==iLastPg );
2751 releasePage(pFreePg);
2752 }
2753 } else {
2754 Pgno iFreePg; /* Index of free page to move pLastPg to */
2755 MemPage *pLastPg;
2756
danielk197730548662009-07-09 05:07:37 +00002757 rc = btreeGetPage(pBt, iLastPg, &pLastPg, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00002758 if( rc!=SQLITE_OK ){
2759 return rc;
2760 }
2761
danielk1977b4626a32007-04-28 15:47:43 +00002762 /* If nFin is zero, this loop runs exactly once and page pLastPg
2763 ** is swapped with the first free page pulled off the free list.
2764 **
2765 ** On the other hand, if nFin is greater than zero, then keep
2766 ** looping until a free-page located within the first nFin pages
2767 ** of the file is found.
2768 */
danielk1977dddbcdc2007-04-26 14:42:34 +00002769 do {
2770 MemPage *pFreePg;
2771 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, 0, 0);
2772 if( rc!=SQLITE_OK ){
2773 releasePage(pLastPg);
2774 return rc;
2775 }
2776 releasePage(pFreePg);
2777 }while( nFin!=0 && iFreePg>nFin );
2778 assert( iFreePg<iLastPg );
danielk1977b4626a32007-04-28 15:47:43 +00002779
2780 rc = sqlite3PagerWrite(pLastPg->pDbPage);
danielk1977662278e2007-11-05 15:30:12 +00002781 if( rc==SQLITE_OK ){
danielk19774c999992008-07-16 18:17:55 +00002782 rc = relocatePage(pBt, pLastPg, eType, iPtrPage, iFreePg, nFin!=0);
danielk1977662278e2007-11-05 15:30:12 +00002783 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002784 releasePage(pLastPg);
2785 if( rc!=SQLITE_OK ){
2786 return rc;
danielk1977662278e2007-11-05 15:30:12 +00002787 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002788 }
2789 }
2790
danielk19773460d192008-12-27 15:23:13 +00002791 if( nFin==0 ){
2792 iLastPg--;
2793 while( iLastPg==PENDING_BYTE_PAGE(pBt)||PTRMAP_ISPAGE(pBt, iLastPg) ){
danielk1977f4027782009-03-30 18:50:04 +00002794 if( PTRMAP_ISPAGE(pBt, iLastPg) ){
2795 MemPage *pPg;
danielk197730548662009-07-09 05:07:37 +00002796 int rc = btreeGetPage(pBt, iLastPg, &pPg, 0);
danielk1977f4027782009-03-30 18:50:04 +00002797 if( rc!=SQLITE_OK ){
2798 return rc;
2799 }
2800 rc = sqlite3PagerWrite(pPg->pDbPage);
2801 releasePage(pPg);
2802 if( rc!=SQLITE_OK ){
2803 return rc;
2804 }
2805 }
danielk19773460d192008-12-27 15:23:13 +00002806 iLastPg--;
2807 }
2808 sqlite3PagerTruncateImage(pBt->pPager, iLastPg);
danielk1977dddbcdc2007-04-26 14:42:34 +00002809 }
2810 return SQLITE_OK;
2811}
2812
2813/*
2814** A write-transaction must be opened before calling this function.
2815** It performs a single unit of work towards an incremental vacuum.
2816**
2817** If the incremental vacuum is finished after this function has run,
shanebe217792009-03-05 04:20:31 +00002818** SQLITE_DONE is returned. If it is not finished, but no error occurred,
danielk1977dddbcdc2007-04-26 14:42:34 +00002819** SQLITE_OK is returned. Otherwise an SQLite error code.
2820*/
2821int sqlite3BtreeIncrVacuum(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00002822 int rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00002823 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002824
2825 sqlite3BtreeEnter(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00002826 assert( pBt->inTransaction==TRANS_WRITE && p->inTrans==TRANS_WRITE );
2827 if( !pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00002828 rc = SQLITE_DONE;
2829 }else{
2830 invalidateAllOverflowCache(pBt);
danielk1977bea2a942009-01-20 17:06:27 +00002831 rc = incrVacuumStep(pBt, 0, pagerPagecount(pBt));
danielk1977dddbcdc2007-04-26 14:42:34 +00002832 }
drhd677b3d2007-08-20 22:48:41 +00002833 sqlite3BtreeLeave(p);
2834 return rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00002835}
2836
2837/*
danielk19773b8a05f2007-03-19 17:44:26 +00002838** This routine is called prior to sqlite3PagerCommit when a transaction
danielk1977687566d2004-11-02 12:56:41 +00002839** is commited for an auto-vacuum database.
danielk197724168722007-04-02 05:07:47 +00002840**
2841** If SQLITE_OK is returned, then *pnTrunc is set to the number of pages
2842** the database file should be truncated to during the commit process.
2843** i.e. the database has been reorganized so that only the first *pnTrunc
2844** pages are in use.
danielk1977687566d2004-11-02 12:56:41 +00002845*/
danielk19773460d192008-12-27 15:23:13 +00002846static int autoVacuumCommit(BtShared *pBt){
danielk1977dddbcdc2007-04-26 14:42:34 +00002847 int rc = SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00002848 Pager *pPager = pBt->pPager;
drhf94a1732008-09-30 17:18:17 +00002849 VVA_ONLY( int nRef = sqlite3PagerRefcount(pPager) );
danielk1977687566d2004-11-02 12:56:41 +00002850
drh1fee73e2007-08-29 04:00:57 +00002851 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +00002852 invalidateAllOverflowCache(pBt);
danielk1977dddbcdc2007-04-26 14:42:34 +00002853 assert(pBt->autoVacuum);
2854 if( !pBt->incrVacuum ){
danielk19773460d192008-12-27 15:23:13 +00002855 Pgno nFin;
2856 Pgno nFree;
2857 Pgno nPtrmap;
2858 Pgno iFree;
2859 const int pgsz = pBt->pageSize;
2860 Pgno nOrig = pagerPagecount(pBt);
danielk1977687566d2004-11-02 12:56:41 +00002861
danielk1977ef165ce2009-04-06 17:50:03 +00002862 if( PTRMAP_ISPAGE(pBt, nOrig) || nOrig==PENDING_BYTE_PAGE(pBt) ){
2863 /* It is not possible to create a database for which the final page
2864 ** is either a pointer-map page or the pending-byte page. If one
2865 ** is encountered, this indicates corruption.
2866 */
danielk19773460d192008-12-27 15:23:13 +00002867 return SQLITE_CORRUPT_BKPT;
2868 }
danielk1977ef165ce2009-04-06 17:50:03 +00002869
danielk19773460d192008-12-27 15:23:13 +00002870 nFree = get4byte(&pBt->pPage1->aData[36]);
2871 nPtrmap = (nFree-nOrig+PTRMAP_PAGENO(pBt, nOrig)+pgsz/5)/(pgsz/5);
2872 nFin = nOrig - nFree - nPtrmap;
danielk1977ef165ce2009-04-06 17:50:03 +00002873 if( nOrig>PENDING_BYTE_PAGE(pBt) && nFin<PENDING_BYTE_PAGE(pBt) ){
danielk19773460d192008-12-27 15:23:13 +00002874 nFin--;
2875 }
2876 while( PTRMAP_ISPAGE(pBt, nFin) || nFin==PENDING_BYTE_PAGE(pBt) ){
2877 nFin--;
danielk1977dddbcdc2007-04-26 14:42:34 +00002878 }
drhc5e47ac2009-06-04 00:11:56 +00002879 if( nFin>nOrig ) return SQLITE_CORRUPT_BKPT;
danielk1977687566d2004-11-02 12:56:41 +00002880
danielk19773460d192008-12-27 15:23:13 +00002881 for(iFree=nOrig; iFree>nFin && rc==SQLITE_OK; iFree--){
2882 rc = incrVacuumStep(pBt, nFin, iFree);
danielk1977dddbcdc2007-04-26 14:42:34 +00002883 }
danielk19773460d192008-12-27 15:23:13 +00002884 if( (rc==SQLITE_DONE || rc==SQLITE_OK) && nFree>0 ){
danielk1977dddbcdc2007-04-26 14:42:34 +00002885 rc = SQLITE_OK;
danielk19773460d192008-12-27 15:23:13 +00002886 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
2887 put4byte(&pBt->pPage1->aData[32], 0);
2888 put4byte(&pBt->pPage1->aData[36], 0);
2889 sqlite3PagerTruncateImage(pBt->pPager, nFin);
danielk1977dddbcdc2007-04-26 14:42:34 +00002890 }
2891 if( rc!=SQLITE_OK ){
2892 sqlite3PagerRollback(pPager);
2893 }
danielk1977687566d2004-11-02 12:56:41 +00002894 }
2895
danielk19773b8a05f2007-03-19 17:44:26 +00002896 assert( nRef==sqlite3PagerRefcount(pPager) );
danielk1977687566d2004-11-02 12:56:41 +00002897 return rc;
2898}
danielk1977dddbcdc2007-04-26 14:42:34 +00002899
danielk1977a50d9aa2009-06-08 14:49:45 +00002900#else /* ifndef SQLITE_OMIT_AUTOVACUUM */
2901# define setChildPtrmaps(x) SQLITE_OK
2902#endif
danielk1977687566d2004-11-02 12:56:41 +00002903
2904/*
drh80e35f42007-03-30 14:06:34 +00002905** This routine does the first phase of a two-phase commit. This routine
2906** causes a rollback journal to be created (if it does not already exist)
2907** and populated with enough information so that if a power loss occurs
2908** the database can be restored to its original state by playing back
2909** the journal. Then the contents of the journal are flushed out to
2910** the disk. After the journal is safely on oxide, the changes to the
2911** database are written into the database file and flushed to oxide.
2912** At the end of this call, the rollback journal still exists on the
2913** disk and we are still holding all locks, so the transaction has not
drh51898cf2009-04-19 20:51:06 +00002914** committed. See sqlite3BtreeCommitPhaseTwo() for the second phase of the
drh80e35f42007-03-30 14:06:34 +00002915** commit process.
2916**
2917** This call is a no-op if no write-transaction is currently active on pBt.
2918**
2919** Otherwise, sync the database file for the btree pBt. zMaster points to
2920** the name of a master journal file that should be written into the
2921** individual journal file, or is NULL, indicating no master journal file
2922** (single database transaction).
2923**
2924** When this is called, the master journal should already have been
2925** created, populated with this journal pointer and synced to disk.
2926**
2927** Once this is routine has returned, the only thing required to commit
2928** the write-transaction for this database file is to delete the journal.
2929*/
2930int sqlite3BtreeCommitPhaseOne(Btree *p, const char *zMaster){
2931 int rc = SQLITE_OK;
2932 if( p->inTrans==TRANS_WRITE ){
2933 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002934 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00002935#ifndef SQLITE_OMIT_AUTOVACUUM
2936 if( pBt->autoVacuum ){
danielk19773460d192008-12-27 15:23:13 +00002937 rc = autoVacuumCommit(pBt);
drh80e35f42007-03-30 14:06:34 +00002938 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00002939 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00002940 return rc;
2941 }
2942 }
2943#endif
drh49b9d332009-01-02 18:10:42 +00002944 rc = sqlite3PagerCommitPhaseOne(pBt->pPager, zMaster, 0);
drhd677b3d2007-08-20 22:48:41 +00002945 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00002946 }
2947 return rc;
2948}
2949
2950/*
danielk197794b30732009-07-02 17:21:57 +00002951** This function is called from both BtreeCommitPhaseTwo() and BtreeRollback()
2952** at the conclusion of a transaction.
2953*/
2954static void btreeEndTransaction(Btree *p){
2955 BtShared *pBt = p->pBt;
2956 BtCursor *pCsr;
2957 assert( sqlite3BtreeHoldsMutex(p) );
2958
2959 /* Search for a cursor held open by this b-tree connection. If one exists,
2960 ** then the transaction will be downgraded to a read-only transaction
2961 ** instead of actually concluded. A subsequent call to CommitPhaseTwo()
2962 ** or Rollback() will finish the transaction and unlock the database. */
2963 for(pCsr=pBt->pCursor; pCsr && pCsr->pBtree!=p; pCsr=pCsr->pNext);
2964 assert( pCsr==0 || p->inTrans>TRANS_NONE );
2965
2966 btreeClearHasContent(pBt);
2967 if( pCsr ){
2968 downgradeAllSharedCacheTableLocks(p);
2969 p->inTrans = TRANS_READ;
2970 }else{
2971 /* If the handle had any kind of transaction open, decrement the
2972 ** transaction count of the shared btree. If the transaction count
2973 ** reaches 0, set the shared state to TRANS_NONE. The unlockBtreeIfUnused()
2974 ** call below will unlock the pager. */
2975 if( p->inTrans!=TRANS_NONE ){
2976 clearAllSharedCacheTableLocks(p);
2977 pBt->nTransaction--;
2978 if( 0==pBt->nTransaction ){
2979 pBt->inTransaction = TRANS_NONE;
2980 }
2981 }
2982
2983 /* Set the current transaction state to TRANS_NONE and unlock the
2984 ** pager if this call closed the only read or write transaction. */
2985 p->inTrans = TRANS_NONE;
2986 unlockBtreeIfUnused(pBt);
2987 }
2988
2989 btreeIntegrity(p);
2990}
2991
2992/*
drh2aa679f2001-06-25 02:11:07 +00002993** Commit the transaction currently in progress.
drh5e00f6c2001-09-13 13:46:56 +00002994**
drh6e345992007-03-30 11:12:08 +00002995** This routine implements the second phase of a 2-phase commit. The
drh51898cf2009-04-19 20:51:06 +00002996** sqlite3BtreeCommitPhaseOne() routine does the first phase and should
2997** be invoked prior to calling this routine. The sqlite3BtreeCommitPhaseOne()
2998** routine did all the work of writing information out to disk and flushing the
drh6e345992007-03-30 11:12:08 +00002999** contents so that they are written onto the disk platter. All this
drh51898cf2009-04-19 20:51:06 +00003000** routine has to do is delete or truncate or zero the header in the
3001** the rollback journal (which causes the transaction to commit) and
3002** drop locks.
drh6e345992007-03-30 11:12:08 +00003003**
drh5e00f6c2001-09-13 13:46:56 +00003004** This will release the write lock on the database file. If there
3005** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00003006*/
drh80e35f42007-03-30 14:06:34 +00003007int sqlite3BtreeCommitPhaseTwo(Btree *p){
danielk1977aef0bf62005-12-30 16:28:01 +00003008 BtShared *pBt = p->pBt;
3009
drhd677b3d2007-08-20 22:48:41 +00003010 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00003011 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00003012
3013 /* If the handle has a write-transaction open, commit the shared-btrees
3014 ** transaction and set the shared state to TRANS_READ.
3015 */
3016 if( p->inTrans==TRANS_WRITE ){
danielk19777f7bc662006-01-23 13:47:47 +00003017 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00003018 assert( pBt->inTransaction==TRANS_WRITE );
3019 assert( pBt->nTransaction>0 );
drh80e35f42007-03-30 14:06:34 +00003020 rc = sqlite3PagerCommitPhaseTwo(pBt->pPager);
danielk19777f7bc662006-01-23 13:47:47 +00003021 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00003022 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00003023 return rc;
3024 }
danielk1977aef0bf62005-12-30 16:28:01 +00003025 pBt->inTransaction = TRANS_READ;
danielk1977ee5741e2004-05-31 10:01:34 +00003026 }
danielk1977aef0bf62005-12-30 16:28:01 +00003027
danielk197794b30732009-07-02 17:21:57 +00003028 btreeEndTransaction(p);
drhd677b3d2007-08-20 22:48:41 +00003029 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00003030 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00003031}
3032
drh80e35f42007-03-30 14:06:34 +00003033/*
3034** Do both phases of a commit.
3035*/
3036int sqlite3BtreeCommit(Btree *p){
3037 int rc;
drhd677b3d2007-08-20 22:48:41 +00003038 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00003039 rc = sqlite3BtreeCommitPhaseOne(p, 0);
3040 if( rc==SQLITE_OK ){
3041 rc = sqlite3BtreeCommitPhaseTwo(p);
3042 }
drhd677b3d2007-08-20 22:48:41 +00003043 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00003044 return rc;
3045}
3046
danielk1977fbcd5852004-06-15 02:44:18 +00003047#ifndef NDEBUG
3048/*
3049** Return the number of write-cursors open on this handle. This is for use
3050** in assert() expressions, so it is only compiled if NDEBUG is not
3051** defined.
drhfb982642007-08-30 01:19:59 +00003052**
3053** For the purposes of this routine, a write-cursor is any cursor that
3054** is capable of writing to the databse. That means the cursor was
3055** originally opened for writing and the cursor has not be disabled
3056** by having its state changed to CURSOR_FAULT.
danielk1977fbcd5852004-06-15 02:44:18 +00003057*/
danielk1977aef0bf62005-12-30 16:28:01 +00003058static int countWriteCursors(BtShared *pBt){
danielk1977fbcd5852004-06-15 02:44:18 +00003059 BtCursor *pCur;
3060 int r = 0;
3061 for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
drhfb982642007-08-30 01:19:59 +00003062 if( pCur->wrFlag && pCur->eState!=CURSOR_FAULT ) r++;
danielk1977fbcd5852004-06-15 02:44:18 +00003063 }
3064 return r;
3065}
3066#endif
3067
drhc39e0002004-05-07 23:50:57 +00003068/*
drhfb982642007-08-30 01:19:59 +00003069** This routine sets the state to CURSOR_FAULT and the error
3070** code to errCode for every cursor on BtShared that pBtree
3071** references.
3072**
3073** Every cursor is tripped, including cursors that belong
3074** to other database connections that happen to be sharing
3075** the cache with pBtree.
3076**
3077** This routine gets called when a rollback occurs.
3078** All cursors using the same cache must be tripped
3079** to prevent them from trying to use the btree after
3080** the rollback. The rollback may have deleted tables
3081** or moved root pages, so it is not sufficient to
3082** save the state of the cursor. The cursor must be
3083** invalidated.
3084*/
3085void sqlite3BtreeTripAllCursors(Btree *pBtree, int errCode){
3086 BtCursor *p;
3087 sqlite3BtreeEnter(pBtree);
3088 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
danielk1977bc2ca9e2008-11-13 14:28:28 +00003089 int i;
danielk1977be51a652008-10-08 17:58:48 +00003090 sqlite3BtreeClearCursor(p);
drhfb982642007-08-30 01:19:59 +00003091 p->eState = CURSOR_FAULT;
3092 p->skip = errCode;
danielk1977bc2ca9e2008-11-13 14:28:28 +00003093 for(i=0; i<=p->iPage; i++){
3094 releasePage(p->apPage[i]);
3095 p->apPage[i] = 0;
3096 }
drhfb982642007-08-30 01:19:59 +00003097 }
3098 sqlite3BtreeLeave(pBtree);
3099}
3100
3101/*
drhecdc7532001-09-23 02:35:53 +00003102** Rollback the transaction in progress. All cursors will be
3103** invalided by this operation. Any attempt to use a cursor
3104** that was open at the beginning of this operation will result
3105** in an error.
drh5e00f6c2001-09-13 13:46:56 +00003106**
3107** This will release the write lock on the database file. If there
3108** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00003109*/
danielk1977aef0bf62005-12-30 16:28:01 +00003110int sqlite3BtreeRollback(Btree *p){
danielk19778d34dfd2006-01-24 16:37:57 +00003111 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00003112 BtShared *pBt = p->pBt;
drh24cd67e2004-05-10 16:18:47 +00003113 MemPage *pPage1;
danielk1977aef0bf62005-12-30 16:28:01 +00003114
drhd677b3d2007-08-20 22:48:41 +00003115 sqlite3BtreeEnter(p);
danielk19772b8c13e2006-01-24 14:21:24 +00003116 rc = saveAllCursors(pBt, 0, 0);
danielk19778d34dfd2006-01-24 16:37:57 +00003117#ifndef SQLITE_OMIT_SHARED_CACHE
danielk19772b8c13e2006-01-24 14:21:24 +00003118 if( rc!=SQLITE_OK ){
shanebe217792009-03-05 04:20:31 +00003119 /* This is a horrible situation. An IO or malloc() error occurred whilst
danielk19778d34dfd2006-01-24 16:37:57 +00003120 ** trying to save cursor positions. If this is an automatic rollback (as
3121 ** the result of a constraint, malloc() failure or IO error) then
3122 ** the cache may be internally inconsistent (not contain valid trees) so
3123 ** we cannot simply return the error to the caller. Instead, abort
3124 ** all queries that may be using any of the cursors that failed to save.
3125 */
drhfb982642007-08-30 01:19:59 +00003126 sqlite3BtreeTripAllCursors(p, rc);
danielk19772b8c13e2006-01-24 14:21:24 +00003127 }
danielk19778d34dfd2006-01-24 16:37:57 +00003128#endif
danielk1977aef0bf62005-12-30 16:28:01 +00003129 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00003130
3131 if( p->inTrans==TRANS_WRITE ){
danielk19778d34dfd2006-01-24 16:37:57 +00003132 int rc2;
danielk1977aef0bf62005-12-30 16:28:01 +00003133
danielk19778d34dfd2006-01-24 16:37:57 +00003134 assert( TRANS_WRITE==pBt->inTransaction );
danielk19773b8a05f2007-03-19 17:44:26 +00003135 rc2 = sqlite3PagerRollback(pBt->pPager);
danielk19778d34dfd2006-01-24 16:37:57 +00003136 if( rc2!=SQLITE_OK ){
3137 rc = rc2;
3138 }
3139
drh24cd67e2004-05-10 16:18:47 +00003140 /* The rollback may have destroyed the pPage1->aData value. So
danielk197730548662009-07-09 05:07:37 +00003141 ** call btreeGetPage() on page 1 again to make
drh16a9b832007-05-05 18:39:25 +00003142 ** sure pPage1->aData is set correctly. */
danielk197730548662009-07-09 05:07:37 +00003143 if( btreeGetPage(pBt, 1, &pPage1, 0)==SQLITE_OK ){
drh24cd67e2004-05-10 16:18:47 +00003144 releasePage(pPage1);
3145 }
danielk1977fbcd5852004-06-15 02:44:18 +00003146 assert( countWriteCursors(pBt)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00003147 pBt->inTransaction = TRANS_READ;
drh24cd67e2004-05-10 16:18:47 +00003148 }
danielk1977aef0bf62005-12-30 16:28:01 +00003149
danielk197794b30732009-07-02 17:21:57 +00003150 btreeEndTransaction(p);
drhd677b3d2007-08-20 22:48:41 +00003151 sqlite3BtreeLeave(p);
drha059ad02001-04-17 20:09:11 +00003152 return rc;
3153}
3154
3155/*
danielk1977bd434552009-03-18 10:33:00 +00003156** Start a statement subtransaction. The subtransaction can can be rolled
3157** back independently of the main transaction. You must start a transaction
3158** before starting a subtransaction. The subtransaction is ended automatically
3159** if the main transaction commits or rolls back.
drhab01f612004-05-22 02:55:23 +00003160**
3161** Statement subtransactions are used around individual SQL statements
3162** that are contained within a BEGIN...COMMIT block. If a constraint
3163** error occurs within the statement, the effect of that one statement
3164** can be rolled back without having to rollback the entire transaction.
danielk1977bd434552009-03-18 10:33:00 +00003165**
3166** A statement sub-transaction is implemented as an anonymous savepoint. The
3167** value passed as the second parameter is the total number of savepoints,
3168** including the new anonymous savepoint, open on the B-Tree. i.e. if there
3169** are no active savepoints and no other statement-transactions open,
3170** iStatement is 1. This anonymous savepoint can be released or rolled back
3171** using the sqlite3BtreeSavepoint() function.
drh663fc632002-02-02 18:49:19 +00003172*/
danielk1977bd434552009-03-18 10:33:00 +00003173int sqlite3BtreeBeginStmt(Btree *p, int iStatement){
drh663fc632002-02-02 18:49:19 +00003174 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00003175 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00003176 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00003177 assert( p->inTrans==TRANS_WRITE );
drh64022502009-01-09 14:11:04 +00003178 assert( pBt->readOnly==0 );
danielk1977bd434552009-03-18 10:33:00 +00003179 assert( iStatement>0 );
3180 assert( iStatement>p->db->nSavepoint );
3181 if( NEVER(p->inTrans!=TRANS_WRITE || pBt->readOnly) ){
drh64022502009-01-09 14:11:04 +00003182 rc = SQLITE_INTERNAL;
drhd677b3d2007-08-20 22:48:41 +00003183 }else{
3184 assert( pBt->inTransaction==TRANS_WRITE );
drh64022502009-01-09 14:11:04 +00003185 /* At the pager level, a statement transaction is a savepoint with
3186 ** an index greater than all savepoints created explicitly using
3187 ** SQL statements. It is illegal to open, release or rollback any
3188 ** such savepoints while the statement transaction savepoint is active.
3189 */
danielk1977bd434552009-03-18 10:33:00 +00003190 rc = sqlite3PagerOpenSavepoint(pBt->pPager, iStatement);
danielk197797a227c2006-01-20 16:32:04 +00003191 }
drhd677b3d2007-08-20 22:48:41 +00003192 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00003193 return rc;
3194}
3195
3196/*
danielk1977fd7f0452008-12-17 17:30:26 +00003197** The second argument to this function, op, is always SAVEPOINT_ROLLBACK
3198** or SAVEPOINT_RELEASE. This function either releases or rolls back the
danielk197712dd5492008-12-18 15:45:07 +00003199** savepoint identified by parameter iSavepoint, depending on the value
3200** of op.
3201**
3202** Normally, iSavepoint is greater than or equal to zero. However, if op is
3203** SAVEPOINT_ROLLBACK, then iSavepoint may also be -1. In this case the
3204** contents of the entire transaction are rolled back. This is different
3205** from a normal transaction rollback, as no locks are released and the
3206** transaction remains open.
danielk1977fd7f0452008-12-17 17:30:26 +00003207*/
3208int sqlite3BtreeSavepoint(Btree *p, int op, int iSavepoint){
3209 int rc = SQLITE_OK;
3210 if( p && p->inTrans==TRANS_WRITE ){
3211 BtShared *pBt = p->pBt;
danielk1977fd7f0452008-12-17 17:30:26 +00003212 assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
3213 assert( iSavepoint>=0 || (iSavepoint==-1 && op==SAVEPOINT_ROLLBACK) );
3214 sqlite3BtreeEnter(p);
danielk1977fd7f0452008-12-17 17:30:26 +00003215 rc = sqlite3PagerSavepoint(pBt->pPager, op, iSavepoint);
drh9f0bbf92009-01-02 21:08:09 +00003216 if( rc==SQLITE_OK ){
3217 rc = newDatabase(pBt);
3218 }
danielk1977fd7f0452008-12-17 17:30:26 +00003219 sqlite3BtreeLeave(p);
3220 }
3221 return rc;
3222}
3223
3224/*
drh8b2f49b2001-06-08 00:21:52 +00003225** Create a new cursor for the BTree whose root is on the page
danielk19773e8add92009-07-04 17:16:00 +00003226** iTable. If a read-only cursor is requested, it is assumed that
3227** the caller already has at least a read-only transaction open
3228** on the database already. If a write-cursor is requested, then
3229** the caller is assumed to have an open write transaction.
drh1bee3d72001-10-15 00:44:35 +00003230**
3231** If wrFlag==0, then the cursor can only be used for reading.
drhf74b8d92002-09-01 23:20:45 +00003232** If wrFlag==1, then the cursor can be used for reading or for
3233** writing if other conditions for writing are also met. These
3234** are the conditions that must be met in order for writing to
3235** be allowed:
drh6446c4d2001-12-15 14:22:18 +00003236**
drhf74b8d92002-09-01 23:20:45 +00003237** 1: The cursor must have been opened with wrFlag==1
3238**
drhfe5d71d2007-03-19 11:54:10 +00003239** 2: Other database connections that share the same pager cache
3240** but which are not in the READ_UNCOMMITTED state may not have
3241** cursors open with wrFlag==0 on the same table. Otherwise
3242** the changes made by this write cursor would be visible to
3243** the read cursors in the other database connection.
drhf74b8d92002-09-01 23:20:45 +00003244**
3245** 3: The database must be writable (not on read-only media)
3246**
3247** 4: There must be an active transaction.
3248**
drh6446c4d2001-12-15 14:22:18 +00003249** No checking is done to make sure that page iTable really is the
3250** root page of a b-tree. If it is not, then the cursor acquired
3251** will not work correctly.
danielk197771d5d2c2008-09-29 11:49:47 +00003252**
3253** It is assumed that the sqlite3BtreeCursorSize() bytes of memory
3254** pointed to by pCur have been zeroed by the caller.
drha059ad02001-04-17 20:09:11 +00003255*/
drhd677b3d2007-08-20 22:48:41 +00003256static int btreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00003257 Btree *p, /* The btree */
3258 int iTable, /* Root page of table to open */
3259 int wrFlag, /* 1 to write. 0 read-only */
3260 struct KeyInfo *pKeyInfo, /* First arg to comparison function */
3261 BtCursor *pCur /* Space for new cursor */
drh3aac2dd2004-04-26 14:10:20 +00003262){
danielk19773e8add92009-07-04 17:16:00 +00003263 BtShared *pBt = p->pBt; /* Shared b-tree handle */
drhecdc7532001-09-23 02:35:53 +00003264
drh1fee73e2007-08-29 04:00:57 +00003265 assert( sqlite3BtreeHoldsMutex(p) );
drhf49661a2008-12-10 16:45:50 +00003266 assert( wrFlag==0 || wrFlag==1 );
danielk197796d48e92009-06-29 06:00:37 +00003267
danielk1977602b4662009-07-02 07:47:33 +00003268 /* The following assert statements verify that if this is a sharable
3269 ** b-tree database, the connection is holding the required table locks,
3270 ** and that no other connection has any open cursor that conflicts with
3271 ** this lock. */
3272 assert( hasSharedCacheTableLock(p, iTable, pKeyInfo!=0, wrFlag+1) );
danielk197796d48e92009-06-29 06:00:37 +00003273 assert( wrFlag==0 || !hasReadConflicts(p, iTable) );
3274
danielk19773e8add92009-07-04 17:16:00 +00003275 /* Assert that the caller has opened the required transaction. */
3276 assert( p->inTrans>TRANS_NONE );
3277 assert( wrFlag==0 || p->inTrans==TRANS_WRITE );
3278 assert( pBt->pPage1 && pBt->pPage1->aData );
3279
danielk197796d48e92009-06-29 06:00:37 +00003280 if( NEVER(wrFlag && pBt->readOnly) ){
3281 return SQLITE_READONLY;
drha0c9a112004-03-10 13:42:37 +00003282 }
danielk19773e8add92009-07-04 17:16:00 +00003283 if( iTable==1 && pagerPagecount(pBt)==0 ){
3284 return SQLITE_EMPTY;
3285 }
danielk1977aef0bf62005-12-30 16:28:01 +00003286
danielk1977aef0bf62005-12-30 16:28:01 +00003287 /* Now that no other errors can occur, finish filling in the BtCursor
danielk19773e8add92009-07-04 17:16:00 +00003288 ** variables and link the cursor into the BtShared list. */
danielk1977172114a2009-07-07 15:47:12 +00003289 pCur->pgnoRoot = (Pgno)iTable;
3290 pCur->iPage = -1;
drh1e968a02008-03-25 00:22:21 +00003291 pCur->pKeyInfo = pKeyInfo;
danielk1977aef0bf62005-12-30 16:28:01 +00003292 pCur->pBtree = p;
drhd0679ed2007-08-28 22:24:34 +00003293 pCur->pBt = pBt;
drhf49661a2008-12-10 16:45:50 +00003294 pCur->wrFlag = (u8)wrFlag;
drha059ad02001-04-17 20:09:11 +00003295 pCur->pNext = pBt->pCursor;
3296 if( pCur->pNext ){
3297 pCur->pNext->pPrev = pCur;
3298 }
3299 pBt->pCursor = pCur;
danielk1977da184232006-01-05 11:34:32 +00003300 pCur->eState = CURSOR_INVALID;
drh7f751222009-03-17 22:33:00 +00003301 pCur->cachedRowid = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00003302 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00003303}
drhd677b3d2007-08-20 22:48:41 +00003304int sqlite3BtreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00003305 Btree *p, /* The btree */
3306 int iTable, /* Root page of table to open */
3307 int wrFlag, /* 1 to write. 0 read-only */
3308 struct KeyInfo *pKeyInfo, /* First arg to xCompare() */
3309 BtCursor *pCur /* Write new cursor here */
drhd677b3d2007-08-20 22:48:41 +00003310){
3311 int rc;
3312 sqlite3BtreeEnter(p);
danielk1977cd3e8f72008-03-25 09:47:35 +00003313 rc = btreeCursor(p, iTable, wrFlag, pKeyInfo, pCur);
drhd677b3d2007-08-20 22:48:41 +00003314 sqlite3BtreeLeave(p);
3315 return rc;
3316}
drh7f751222009-03-17 22:33:00 +00003317
3318/*
3319** Return the size of a BtCursor object in bytes.
3320**
3321** This interfaces is needed so that users of cursors can preallocate
3322** sufficient storage to hold a cursor. The BtCursor object is opaque
3323** to users so they cannot do the sizeof() themselves - they must call
3324** this routine.
3325*/
3326int sqlite3BtreeCursorSize(void){
danielk1977cd3e8f72008-03-25 09:47:35 +00003327 return sizeof(BtCursor);
3328}
3329
drh7f751222009-03-17 22:33:00 +00003330/*
3331** Set the cached rowid value of every cursor in the same database file
3332** as pCur and having the same root page number as pCur. The value is
3333** set to iRowid.
3334**
3335** Only positive rowid values are considered valid for this cache.
3336** The cache is initialized to zero, indicating an invalid cache.
3337** A btree will work fine with zero or negative rowids. We just cannot
3338** cache zero or negative rowids, which means tables that use zero or
3339** negative rowids might run a little slower. But in practice, zero
3340** or negative rowids are very uncommon so this should not be a problem.
3341*/
3342void sqlite3BtreeSetCachedRowid(BtCursor *pCur, sqlite3_int64 iRowid){
3343 BtCursor *p;
3344 for(p=pCur->pBt->pCursor; p; p=p->pNext){
3345 if( p->pgnoRoot==pCur->pgnoRoot ) p->cachedRowid = iRowid;
3346 }
3347 assert( pCur->cachedRowid==iRowid );
3348}
drhd677b3d2007-08-20 22:48:41 +00003349
drh7f751222009-03-17 22:33:00 +00003350/*
3351** Return the cached rowid for the given cursor. A negative or zero
3352** return value indicates that the rowid cache is invalid and should be
3353** ignored. If the rowid cache has never before been set, then a
3354** zero is returned.
3355*/
3356sqlite3_int64 sqlite3BtreeGetCachedRowid(BtCursor *pCur){
3357 return pCur->cachedRowid;
3358}
drha059ad02001-04-17 20:09:11 +00003359
3360/*
drh5e00f6c2001-09-13 13:46:56 +00003361** Close a cursor. The read lock on the database file is released
drhbd03cae2001-06-02 02:40:57 +00003362** when the last cursor is closed.
drha059ad02001-04-17 20:09:11 +00003363*/
drh3aac2dd2004-04-26 14:10:20 +00003364int sqlite3BtreeCloseCursor(BtCursor *pCur){
drhff0587c2007-08-29 17:43:19 +00003365 Btree *pBtree = pCur->pBtree;
danielk1977cd3e8f72008-03-25 09:47:35 +00003366 if( pBtree ){
danielk197771d5d2c2008-09-29 11:49:47 +00003367 int i;
danielk1977cd3e8f72008-03-25 09:47:35 +00003368 BtShared *pBt = pCur->pBt;
3369 sqlite3BtreeEnter(pBtree);
danielk1977be51a652008-10-08 17:58:48 +00003370 sqlite3BtreeClearCursor(pCur);
danielk1977cd3e8f72008-03-25 09:47:35 +00003371 if( pCur->pPrev ){
3372 pCur->pPrev->pNext = pCur->pNext;
3373 }else{
3374 pBt->pCursor = pCur->pNext;
3375 }
3376 if( pCur->pNext ){
3377 pCur->pNext->pPrev = pCur->pPrev;
3378 }
danielk197771d5d2c2008-09-29 11:49:47 +00003379 for(i=0; i<=pCur->iPage; i++){
3380 releasePage(pCur->apPage[i]);
3381 }
danielk1977cd3e8f72008-03-25 09:47:35 +00003382 unlockBtreeIfUnused(pBt);
3383 invalidateOverflowCache(pCur);
3384 /* sqlite3_free(pCur); */
3385 sqlite3BtreeLeave(pBtree);
drha059ad02001-04-17 20:09:11 +00003386 }
drh8c42ca92001-06-22 19:15:00 +00003387 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00003388}
3389
drh5e2f8b92001-05-28 00:41:15 +00003390/*
drh86057612007-06-26 01:04:48 +00003391** Make sure the BtCursor* given in the argument has a valid
3392** BtCursor.info structure. If it is not already valid, call
danielk197730548662009-07-09 05:07:37 +00003393** btreeParseCell() to fill it in.
drhab01f612004-05-22 02:55:23 +00003394**
3395** BtCursor.info is a cache of the information in the current cell.
danielk197730548662009-07-09 05:07:37 +00003396** Using this cache reduces the number of calls to btreeParseCell().
drh86057612007-06-26 01:04:48 +00003397**
3398** 2007-06-25: There is a bug in some versions of MSVC that cause the
3399** compiler to crash when getCellInfo() is implemented as a macro.
3400** But there is a measureable speed advantage to using the macro on gcc
3401** (when less compiler optimizations like -Os or -O0 are used and the
3402** compiler is not doing agressive inlining.) So we use a real function
3403** for MSVC and a macro for everything else. Ticket #2457.
drh9188b382004-05-14 21:12:22 +00003404*/
drh9188b382004-05-14 21:12:22 +00003405#ifndef NDEBUG
danielk19771cc5ed82007-05-16 17:28:43 +00003406 static void assertCellInfo(BtCursor *pCur){
drh9188b382004-05-14 21:12:22 +00003407 CellInfo info;
danielk197771d5d2c2008-09-29 11:49:47 +00003408 int iPage = pCur->iPage;
drh51c6d962004-06-06 00:42:25 +00003409 memset(&info, 0, sizeof(info));
danielk197730548662009-07-09 05:07:37 +00003410 btreeParseCell(pCur->apPage[iPage], pCur->aiIdx[iPage], &info);
drh9188b382004-05-14 21:12:22 +00003411 assert( memcmp(&info, &pCur->info, sizeof(info))==0 );
drh9188b382004-05-14 21:12:22 +00003412 }
danielk19771cc5ed82007-05-16 17:28:43 +00003413#else
3414 #define assertCellInfo(x)
3415#endif
drh86057612007-06-26 01:04:48 +00003416#ifdef _MSC_VER
3417 /* Use a real function in MSVC to work around bugs in that compiler. */
3418 static void getCellInfo(BtCursor *pCur){
3419 if( pCur->info.nSize==0 ){
danielk197771d5d2c2008-09-29 11:49:47 +00003420 int iPage = pCur->iPage;
danielk197730548662009-07-09 05:07:37 +00003421 btreeParseCell(pCur->apPage[iPage],pCur->aiIdx[iPage],&pCur->info);
drha2c20e42008-03-29 16:01:04 +00003422 pCur->validNKey = 1;
drh86057612007-06-26 01:04:48 +00003423 }else{
3424 assertCellInfo(pCur);
3425 }
3426 }
3427#else /* if not _MSC_VER */
3428 /* Use a macro in all other compilers so that the function is inlined */
danielk197771d5d2c2008-09-29 11:49:47 +00003429#define getCellInfo(pCur) \
3430 if( pCur->info.nSize==0 ){ \
3431 int iPage = pCur->iPage; \
danielk197730548662009-07-09 05:07:37 +00003432 btreeParseCell(pCur->apPage[iPage],pCur->aiIdx[iPage],&pCur->info); \
danielk197771d5d2c2008-09-29 11:49:47 +00003433 pCur->validNKey = 1; \
3434 }else{ \
3435 assertCellInfo(pCur); \
drh86057612007-06-26 01:04:48 +00003436 }
3437#endif /* _MSC_VER */
drh9188b382004-05-14 21:12:22 +00003438
3439/*
drh3aac2dd2004-04-26 14:10:20 +00003440** Set *pSize to the size of the buffer needed to hold the value of
3441** the key for the current entry. If the cursor is not pointing
3442** to a valid entry, *pSize is set to 0.
3443**
drh4b70f112004-05-02 21:12:19 +00003444** For a table with the INTKEY flag set, this routine returns the key
drh3aac2dd2004-04-26 14:10:20 +00003445** itself, not the number of bytes in the key.
drh7e3b0a02001-04-28 16:52:40 +00003446*/
drh4a1c3802004-05-12 15:15:47 +00003447int sqlite3BtreeKeySize(BtCursor *pCur, i64 *pSize){
drhd677b3d2007-08-20 22:48:41 +00003448 int rc;
3449
drh1fee73e2007-08-29 04:00:57 +00003450 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00003451 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003452 if( rc==SQLITE_OK ){
3453 assert( pCur->eState==CURSOR_INVALID || pCur->eState==CURSOR_VALID );
3454 if( pCur->eState==CURSOR_INVALID ){
3455 *pSize = 0;
3456 }else{
drh86057612007-06-26 01:04:48 +00003457 getCellInfo(pCur);
danielk1977da184232006-01-05 11:34:32 +00003458 *pSize = pCur->info.nKey;
3459 }
drh72f82862001-05-24 21:06:34 +00003460 }
danielk1977da184232006-01-05 11:34:32 +00003461 return rc;
drha059ad02001-04-17 20:09:11 +00003462}
drh2af926b2001-05-15 00:39:25 +00003463
drh72f82862001-05-24 21:06:34 +00003464/*
drh0e1c19e2004-05-11 00:58:56 +00003465** Set *pSize to the number of bytes of data in the entry the
3466** cursor currently points to. Always return SQLITE_OK.
3467** Failure is not possible. If the cursor is not currently
3468** pointing to an entry (which can happen, for example, if
3469** the database is empty) then *pSize is set to 0.
3470*/
3471int sqlite3BtreeDataSize(BtCursor *pCur, u32 *pSize){
drhd677b3d2007-08-20 22:48:41 +00003472 int rc;
3473
drh1fee73e2007-08-29 04:00:57 +00003474 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00003475 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003476 if( rc==SQLITE_OK ){
3477 assert( pCur->eState==CURSOR_INVALID || pCur->eState==CURSOR_VALID );
3478 if( pCur->eState==CURSOR_INVALID ){
3479 /* Not pointing at a valid entry - set *pSize to 0. */
3480 *pSize = 0;
3481 }else{
drh86057612007-06-26 01:04:48 +00003482 getCellInfo(pCur);
danielk1977da184232006-01-05 11:34:32 +00003483 *pSize = pCur->info.nData;
3484 }
drh0e1c19e2004-05-11 00:58:56 +00003485 }
danielk1977da184232006-01-05 11:34:32 +00003486 return rc;
drh0e1c19e2004-05-11 00:58:56 +00003487}
3488
3489/*
danielk1977d04417962007-05-02 13:16:30 +00003490** Given the page number of an overflow page in the database (parameter
3491** ovfl), this function finds the page number of the next page in the
3492** linked list of overflow pages. If possible, it uses the auto-vacuum
3493** pointer-map data instead of reading the content of page ovfl to do so.
3494**
3495** If an error occurs an SQLite error code is returned. Otherwise:
3496**
danielk1977bea2a942009-01-20 17:06:27 +00003497** The page number of the next overflow page in the linked list is
3498** written to *pPgnoNext. If page ovfl is the last page in its linked
3499** list, *pPgnoNext is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00003500**
danielk1977bea2a942009-01-20 17:06:27 +00003501** If ppPage is not NULL, and a reference to the MemPage object corresponding
3502** to page number pOvfl was obtained, then *ppPage is set to point to that
3503** reference. It is the responsibility of the caller to call releasePage()
3504** on *ppPage to free the reference. In no reference was obtained (because
3505** the pointer-map was used to obtain the value for *pPgnoNext), then
3506** *ppPage is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00003507*/
3508static int getOverflowPage(
drhfa3be902009-07-07 02:44:07 +00003509 BtShared *pBt, /* The database file */
3510 Pgno ovfl, /* Current overflow page number */
danielk1977bea2a942009-01-20 17:06:27 +00003511 MemPage **ppPage, /* OUT: MemPage handle (may be NULL) */
danielk1977d04417962007-05-02 13:16:30 +00003512 Pgno *pPgnoNext /* OUT: Next overflow page number */
3513){
3514 Pgno next = 0;
danielk1977bea2a942009-01-20 17:06:27 +00003515 MemPage *pPage = 0;
drh1bd10f82008-12-10 21:19:56 +00003516 int rc = SQLITE_OK;
danielk1977d04417962007-05-02 13:16:30 +00003517
drh1fee73e2007-08-29 04:00:57 +00003518 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977bea2a942009-01-20 17:06:27 +00003519 assert(pPgnoNext);
danielk1977d04417962007-05-02 13:16:30 +00003520
3521#ifndef SQLITE_OMIT_AUTOVACUUM
3522 /* Try to find the next page in the overflow list using the
3523 ** autovacuum pointer-map pages. Guess that the next page in
3524 ** the overflow list is page number (ovfl+1). If that guess turns
3525 ** out to be wrong, fall back to loading the data of page
3526 ** number ovfl to determine the next page number.
3527 */
3528 if( pBt->autoVacuum ){
3529 Pgno pgno;
3530 Pgno iGuess = ovfl+1;
3531 u8 eType;
3532
3533 while( PTRMAP_ISPAGE(pBt, iGuess) || iGuess==PENDING_BYTE_PAGE(pBt) ){
3534 iGuess++;
3535 }
3536
danielk197789d40042008-11-17 14:20:56 +00003537 if( iGuess<=pagerPagecount(pBt) ){
danielk1977d04417962007-05-02 13:16:30 +00003538 rc = ptrmapGet(pBt, iGuess, &eType, &pgno);
danielk1977bea2a942009-01-20 17:06:27 +00003539 if( rc==SQLITE_OK && eType==PTRMAP_OVERFLOW2 && pgno==ovfl ){
danielk1977d04417962007-05-02 13:16:30 +00003540 next = iGuess;
danielk1977bea2a942009-01-20 17:06:27 +00003541 rc = SQLITE_DONE;
danielk1977d04417962007-05-02 13:16:30 +00003542 }
3543 }
3544 }
3545#endif
3546
danielk1977bea2a942009-01-20 17:06:27 +00003547 if( rc==SQLITE_OK ){
danielk197730548662009-07-09 05:07:37 +00003548 rc = btreeGetPage(pBt, ovfl, &pPage, 0);
danielk1977d04417962007-05-02 13:16:30 +00003549 assert(rc==SQLITE_OK || pPage==0);
3550 if( next==0 && rc==SQLITE_OK ){
3551 next = get4byte(pPage->aData);
3552 }
danielk1977443c0592009-01-16 15:21:05 +00003553 }
danielk197745d68822009-01-16 16:23:38 +00003554
danielk1977bea2a942009-01-20 17:06:27 +00003555 *pPgnoNext = next;
3556 if( ppPage ){
3557 *ppPage = pPage;
3558 }else{
3559 releasePage(pPage);
3560 }
3561 return (rc==SQLITE_DONE ? SQLITE_OK : rc);
danielk1977d04417962007-05-02 13:16:30 +00003562}
3563
danielk1977da107192007-05-04 08:32:13 +00003564/*
3565** Copy data from a buffer to a page, or from a page to a buffer.
3566**
3567** pPayload is a pointer to data stored on database page pDbPage.
3568** If argument eOp is false, then nByte bytes of data are copied
3569** from pPayload to the buffer pointed at by pBuf. If eOp is true,
3570** then sqlite3PagerWrite() is called on pDbPage and nByte bytes
3571** of data are copied from the buffer pBuf to pPayload.
3572**
3573** SQLITE_OK is returned on success, otherwise an error code.
3574*/
3575static int copyPayload(
3576 void *pPayload, /* Pointer to page data */
3577 void *pBuf, /* Pointer to buffer */
3578 int nByte, /* Number of bytes to copy */
3579 int eOp, /* 0 -> copy from page, 1 -> copy to page */
3580 DbPage *pDbPage /* Page containing pPayload */
3581){
3582 if( eOp ){
3583 /* Copy data from buffer to page (a write operation) */
3584 int rc = sqlite3PagerWrite(pDbPage);
3585 if( rc!=SQLITE_OK ){
3586 return rc;
3587 }
3588 memcpy(pPayload, pBuf, nByte);
3589 }else{
3590 /* Copy data from page to buffer (a read operation) */
3591 memcpy(pBuf, pPayload, nByte);
3592 }
3593 return SQLITE_OK;
3594}
danielk1977d04417962007-05-02 13:16:30 +00003595
3596/*
danielk19779f8d6402007-05-02 17:48:45 +00003597** This function is used to read or overwrite payload information
3598** for the entry that the pCur cursor is pointing to. If the eOp
3599** parameter is 0, this is a read operation (data copied into
3600** buffer pBuf). If it is non-zero, a write (data copied from
3601** buffer pBuf).
3602**
3603** A total of "amt" bytes are read or written beginning at "offset".
3604** Data is read to or from the buffer pBuf.
drh72f82862001-05-24 21:06:34 +00003605**
3606** This routine does not make a distinction between key and data.
danielk19779f8d6402007-05-02 17:48:45 +00003607** It just reads or writes bytes from the payload area. Data might
3608** appear on the main page or be scattered out on multiple overflow
3609** pages.
danielk1977da107192007-05-04 08:32:13 +00003610**
danielk1977dcbb5d32007-05-04 18:36:44 +00003611** If the BtCursor.isIncrblobHandle flag is set, and the current
danielk1977da107192007-05-04 08:32:13 +00003612** cursor entry uses one or more overflow pages, this function
3613** allocates space for and lazily popluates the overflow page-list
3614** cache array (BtCursor.aOverflow). Subsequent calls use this
3615** cache to make seeking to the supplied offset more efficient.
3616**
3617** Once an overflow page-list cache has been allocated, it may be
3618** invalidated if some other cursor writes to the same table, or if
3619** the cursor is moved to a different row. Additionally, in auto-vacuum
3620** mode, the following events may invalidate an overflow page-list cache.
3621**
3622** * An incremental vacuum,
3623** * A commit in auto_vacuum="full" mode,
3624** * Creating a table (may require moving an overflow page).
drh72f82862001-05-24 21:06:34 +00003625*/
danielk19779f8d6402007-05-02 17:48:45 +00003626static int accessPayload(
drh3aac2dd2004-04-26 14:10:20 +00003627 BtCursor *pCur, /* Cursor pointing to entry to read from */
danielk197789d40042008-11-17 14:20:56 +00003628 u32 offset, /* Begin reading this far into payload */
3629 u32 amt, /* Read this many bytes */
drh3aac2dd2004-04-26 14:10:20 +00003630 unsigned char *pBuf, /* Write the bytes into this buffer */
danielk19779f8d6402007-05-02 17:48:45 +00003631 int skipKey, /* offset begins at data if this is true */
3632 int eOp /* zero to read. non-zero to write. */
drh3aac2dd2004-04-26 14:10:20 +00003633){
3634 unsigned char *aPayload;
danielk1977da107192007-05-04 08:32:13 +00003635 int rc = SQLITE_OK;
drhfa1a98a2004-05-14 19:08:17 +00003636 u32 nKey;
danielk19772dec9702007-05-02 16:48:37 +00003637 int iIdx = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00003638 MemPage *pPage = pCur->apPage[pCur->iPage]; /* Btree page of current entry */
danielk19770d065412008-11-12 18:21:36 +00003639 BtShared *pBt = pCur->pBt; /* Btree this cursor belongs to */
drh3aac2dd2004-04-26 14:10:20 +00003640
danielk1977da107192007-05-04 08:32:13 +00003641 assert( pPage );
danielk1977da184232006-01-05 11:34:32 +00003642 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00003643 assert( pCur->aiIdx[pCur->iPage]<pPage->nCell );
drh1fee73e2007-08-29 04:00:57 +00003644 assert( cursorHoldsMutex(pCur) );
danielk1977da107192007-05-04 08:32:13 +00003645
drh86057612007-06-26 01:04:48 +00003646 getCellInfo(pCur);
drh366fda62006-01-13 02:35:09 +00003647 aPayload = pCur->info.pCell + pCur->info.nHeader;
drhf49661a2008-12-10 16:45:50 +00003648 nKey = (pPage->intKey ? 0 : (int)pCur->info.nKey);
danielk1977da107192007-05-04 08:32:13 +00003649
drh3aac2dd2004-04-26 14:10:20 +00003650 if( skipKey ){
drhfa1a98a2004-05-14 19:08:17 +00003651 offset += nKey;
drh3aac2dd2004-04-26 14:10:20 +00003652 }
danielk19770d065412008-11-12 18:21:36 +00003653 if( offset+amt > nKey+pCur->info.nData
3654 || &aPayload[pCur->info.nLocal] > &pPage->aData[pBt->usableSize]
3655 ){
danielk1977da107192007-05-04 08:32:13 +00003656 /* Trying to read or write past the end of the data is an error */
danielk197767fd7a92008-09-10 17:53:35 +00003657 return SQLITE_CORRUPT_BKPT;
drh3aac2dd2004-04-26 14:10:20 +00003658 }
danielk1977da107192007-05-04 08:32:13 +00003659
3660 /* Check if data must be read/written to/from the btree page itself. */
drhfa1a98a2004-05-14 19:08:17 +00003661 if( offset<pCur->info.nLocal ){
drh2af926b2001-05-15 00:39:25 +00003662 int a = amt;
drhfa1a98a2004-05-14 19:08:17 +00003663 if( a+offset>pCur->info.nLocal ){
3664 a = pCur->info.nLocal - offset;
drh2af926b2001-05-15 00:39:25 +00003665 }
danielk1977da107192007-05-04 08:32:13 +00003666 rc = copyPayload(&aPayload[offset], pBuf, a, eOp, pPage->pDbPage);
drh2aa679f2001-06-25 02:11:07 +00003667 offset = 0;
drha34b6762004-05-07 13:30:42 +00003668 pBuf += a;
drh2af926b2001-05-15 00:39:25 +00003669 amt -= a;
drhdd793422001-06-28 01:54:48 +00003670 }else{
drhfa1a98a2004-05-14 19:08:17 +00003671 offset -= pCur->info.nLocal;
drhbd03cae2001-06-02 02:40:57 +00003672 }
danielk1977da107192007-05-04 08:32:13 +00003673
3674 if( rc==SQLITE_OK && amt>0 ){
danielk197789d40042008-11-17 14:20:56 +00003675 const u32 ovflSize = pBt->usableSize - 4; /* Bytes content per ovfl page */
danielk1977da107192007-05-04 08:32:13 +00003676 Pgno nextPage;
3677
drhfa1a98a2004-05-14 19:08:17 +00003678 nextPage = get4byte(&aPayload[pCur->info.nLocal]);
danielk1977da107192007-05-04 08:32:13 +00003679
danielk19772dec9702007-05-02 16:48:37 +00003680#ifndef SQLITE_OMIT_INCRBLOB
danielk1977dcbb5d32007-05-04 18:36:44 +00003681 /* If the isIncrblobHandle flag is set and the BtCursor.aOverflow[]
danielk1977da107192007-05-04 08:32:13 +00003682 ** has not been allocated, allocate it now. The array is sized at
3683 ** one entry for each overflow page in the overflow chain. The
3684 ** page number of the first overflow page is stored in aOverflow[0],
3685 ** etc. A value of 0 in the aOverflow[] array means "not yet known"
3686 ** (the cache is lazily populated).
3687 */
danielk1977dcbb5d32007-05-04 18:36:44 +00003688 if( pCur->isIncrblobHandle && !pCur->aOverflow ){
danielk19772dec9702007-05-02 16:48:37 +00003689 int nOvfl = (pCur->info.nPayload-pCur->info.nLocal+ovflSize-1)/ovflSize;
drh17435752007-08-16 04:30:38 +00003690 pCur->aOverflow = (Pgno *)sqlite3MallocZero(sizeof(Pgno)*nOvfl);
danielk19772dec9702007-05-02 16:48:37 +00003691 if( nOvfl && !pCur->aOverflow ){
danielk1977da107192007-05-04 08:32:13 +00003692 rc = SQLITE_NOMEM;
danielk19772dec9702007-05-02 16:48:37 +00003693 }
3694 }
danielk1977da107192007-05-04 08:32:13 +00003695
3696 /* If the overflow page-list cache has been allocated and the
3697 ** entry for the first required overflow page is valid, skip
3698 ** directly to it.
3699 */
danielk19772dec9702007-05-02 16:48:37 +00003700 if( pCur->aOverflow && pCur->aOverflow[offset/ovflSize] ){
3701 iIdx = (offset/ovflSize);
3702 nextPage = pCur->aOverflow[iIdx];
3703 offset = (offset%ovflSize);
3704 }
3705#endif
danielk1977da107192007-05-04 08:32:13 +00003706
3707 for( ; rc==SQLITE_OK && amt>0 && nextPage; iIdx++){
3708
3709#ifndef SQLITE_OMIT_INCRBLOB
3710 /* If required, populate the overflow page-list cache. */
3711 if( pCur->aOverflow ){
3712 assert(!pCur->aOverflow[iIdx] || pCur->aOverflow[iIdx]==nextPage);
3713 pCur->aOverflow[iIdx] = nextPage;
3714 }
3715#endif
3716
danielk1977d04417962007-05-02 13:16:30 +00003717 if( offset>=ovflSize ){
3718 /* The only reason to read this page is to obtain the page
danielk1977da107192007-05-04 08:32:13 +00003719 ** number for the next page in the overflow chain. The page
drhfd131da2007-08-07 17:13:03 +00003720 ** data is not required. So first try to lookup the overflow
3721 ** page-list cache, if any, then fall back to the getOverflowPage()
danielk1977da107192007-05-04 08:32:13 +00003722 ** function.
danielk1977d04417962007-05-02 13:16:30 +00003723 */
danielk19772dec9702007-05-02 16:48:37 +00003724#ifndef SQLITE_OMIT_INCRBLOB
danielk1977da107192007-05-04 08:32:13 +00003725 if( pCur->aOverflow && pCur->aOverflow[iIdx+1] ){
3726 nextPage = pCur->aOverflow[iIdx+1];
3727 } else
danielk19772dec9702007-05-02 16:48:37 +00003728#endif
danielk1977da107192007-05-04 08:32:13 +00003729 rc = getOverflowPage(pBt, nextPage, 0, &nextPage);
danielk1977da107192007-05-04 08:32:13 +00003730 offset -= ovflSize;
danielk1977d04417962007-05-02 13:16:30 +00003731 }else{
danielk19779f8d6402007-05-02 17:48:45 +00003732 /* Need to read this page properly. It contains some of the
3733 ** range of data that is being read (eOp==0) or written (eOp!=0).
danielk1977d04417962007-05-02 13:16:30 +00003734 */
3735 DbPage *pDbPage;
danielk1977cfe9a692004-06-16 12:00:29 +00003736 int a = amt;
danielk1977d04417962007-05-02 13:16:30 +00003737 rc = sqlite3PagerGet(pBt->pPager, nextPage, &pDbPage);
danielk1977da107192007-05-04 08:32:13 +00003738 if( rc==SQLITE_OK ){
3739 aPayload = sqlite3PagerGetData(pDbPage);
3740 nextPage = get4byte(aPayload);
3741 if( a + offset > ovflSize ){
3742 a = ovflSize - offset;
danielk19779f8d6402007-05-02 17:48:45 +00003743 }
danielk1977da107192007-05-04 08:32:13 +00003744 rc = copyPayload(&aPayload[offset+4], pBuf, a, eOp, pDbPage);
3745 sqlite3PagerUnref(pDbPage);
3746 offset = 0;
3747 amt -= a;
3748 pBuf += a;
danielk19779f8d6402007-05-02 17:48:45 +00003749 }
danielk1977cfe9a692004-06-16 12:00:29 +00003750 }
drh2af926b2001-05-15 00:39:25 +00003751 }
drh2af926b2001-05-15 00:39:25 +00003752 }
danielk1977cfe9a692004-06-16 12:00:29 +00003753
danielk1977da107192007-05-04 08:32:13 +00003754 if( rc==SQLITE_OK && amt>0 ){
drh49285702005-09-17 15:20:26 +00003755 return SQLITE_CORRUPT_BKPT;
drha7fcb052001-12-14 15:09:55 +00003756 }
danielk1977da107192007-05-04 08:32:13 +00003757 return rc;
drh2af926b2001-05-15 00:39:25 +00003758}
3759
drh72f82862001-05-24 21:06:34 +00003760/*
drh3aac2dd2004-04-26 14:10:20 +00003761** Read part of the key associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00003762** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00003763** begins at "offset".
drh8c1238a2003-01-02 14:43:55 +00003764**
drh3aac2dd2004-04-26 14:10:20 +00003765** Return SQLITE_OK on success or an error code if anything goes
3766** wrong. An error is returned if "offset+amt" is larger than
3767** the available payload.
drh72f82862001-05-24 21:06:34 +00003768*/
drha34b6762004-05-07 13:30:42 +00003769int sqlite3BtreeKey(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drhd677b3d2007-08-20 22:48:41 +00003770 int rc;
3771
drh1fee73e2007-08-29 04:00:57 +00003772 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00003773 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003774 if( rc==SQLITE_OK ){
3775 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00003776 assert( pCur->iPage>=0 && pCur->apPage[pCur->iPage] );
3777 if( pCur->apPage[0]->intKey ){
danielk1977da184232006-01-05 11:34:32 +00003778 return SQLITE_CORRUPT_BKPT;
3779 }
danielk197771d5d2c2008-09-29 11:49:47 +00003780 assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
drh16a9b832007-05-05 18:39:25 +00003781 rc = accessPayload(pCur, offset, amt, (unsigned char*)pBuf, 0, 0);
drh6575a222005-03-10 17:06:34 +00003782 }
danielk1977da184232006-01-05 11:34:32 +00003783 return rc;
drh3aac2dd2004-04-26 14:10:20 +00003784}
3785
3786/*
drh3aac2dd2004-04-26 14:10:20 +00003787** Read part of the data associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00003788** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00003789** begins at "offset".
3790**
3791** Return SQLITE_OK on success or an error code if anything goes
3792** wrong. An error is returned if "offset+amt" is larger than
3793** the available payload.
drh72f82862001-05-24 21:06:34 +00003794*/
drh3aac2dd2004-04-26 14:10:20 +00003795int sqlite3BtreeData(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drhd677b3d2007-08-20 22:48:41 +00003796 int rc;
3797
danielk19773588ceb2008-06-10 17:30:26 +00003798#ifndef SQLITE_OMIT_INCRBLOB
3799 if ( pCur->eState==CURSOR_INVALID ){
3800 return SQLITE_ABORT;
3801 }
3802#endif
3803
drh1fee73e2007-08-29 04:00:57 +00003804 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00003805 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00003806 if( rc==SQLITE_OK ){
3807 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00003808 assert( pCur->iPage>=0 && pCur->apPage[pCur->iPage] );
3809 assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
drh16a9b832007-05-05 18:39:25 +00003810 rc = accessPayload(pCur, offset, amt, pBuf, 1, 0);
danielk1977da184232006-01-05 11:34:32 +00003811 }
3812 return rc;
drh2af926b2001-05-15 00:39:25 +00003813}
3814
drh72f82862001-05-24 21:06:34 +00003815/*
drh0e1c19e2004-05-11 00:58:56 +00003816** Return a pointer to payload information from the entry that the
3817** pCur cursor is pointing to. The pointer is to the beginning of
3818** the key if skipKey==0 and it points to the beginning of data if
drhe51c44f2004-05-30 20:46:09 +00003819** skipKey==1. The number of bytes of available key/data is written
3820** into *pAmt. If *pAmt==0, then the value returned will not be
3821** a valid pointer.
drh0e1c19e2004-05-11 00:58:56 +00003822**
3823** This routine is an optimization. It is common for the entire key
3824** and data to fit on the local page and for there to be no overflow
3825** pages. When that is so, this routine can be used to access the
3826** key and data without making a copy. If the key and/or data spills
drh7f751222009-03-17 22:33:00 +00003827** onto overflow pages, then accessPayload() must be used to reassemble
drh0e1c19e2004-05-11 00:58:56 +00003828** the key/data and copy it into a preallocated buffer.
3829**
3830** The pointer returned by this routine looks directly into the cached
3831** page of the database. The data might change or move the next time
3832** any btree routine is called.
3833*/
3834static const unsigned char *fetchPayload(
3835 BtCursor *pCur, /* Cursor pointing to entry to read from */
drhe51c44f2004-05-30 20:46:09 +00003836 int *pAmt, /* Write the number of available bytes here */
drh0e1c19e2004-05-11 00:58:56 +00003837 int skipKey /* read beginning at data if this is true */
3838){
3839 unsigned char *aPayload;
3840 MemPage *pPage;
drhfa1a98a2004-05-14 19:08:17 +00003841 u32 nKey;
danielk197789d40042008-11-17 14:20:56 +00003842 u32 nLocal;
drh0e1c19e2004-05-11 00:58:56 +00003843
danielk197771d5d2c2008-09-29 11:49:47 +00003844 assert( pCur!=0 && pCur->iPage>=0 && pCur->apPage[pCur->iPage]);
danielk1977da184232006-01-05 11:34:32 +00003845 assert( pCur->eState==CURSOR_VALID );
drh1fee73e2007-08-29 04:00:57 +00003846 assert( cursorHoldsMutex(pCur) );
danielk197771d5d2c2008-09-29 11:49:47 +00003847 pPage = pCur->apPage[pCur->iPage];
3848 assert( pCur->aiIdx[pCur->iPage]<pPage->nCell );
drh86057612007-06-26 01:04:48 +00003849 getCellInfo(pCur);
drh43605152004-05-29 21:46:49 +00003850 aPayload = pCur->info.pCell;
drhfa1a98a2004-05-14 19:08:17 +00003851 aPayload += pCur->info.nHeader;
drh0e1c19e2004-05-11 00:58:56 +00003852 if( pPage->intKey ){
drhfa1a98a2004-05-14 19:08:17 +00003853 nKey = 0;
3854 }else{
drhf49661a2008-12-10 16:45:50 +00003855 nKey = (int)pCur->info.nKey;
drh0e1c19e2004-05-11 00:58:56 +00003856 }
drh0e1c19e2004-05-11 00:58:56 +00003857 if( skipKey ){
drhfa1a98a2004-05-14 19:08:17 +00003858 aPayload += nKey;
3859 nLocal = pCur->info.nLocal - nKey;
drh0e1c19e2004-05-11 00:58:56 +00003860 }else{
drhfa1a98a2004-05-14 19:08:17 +00003861 nLocal = pCur->info.nLocal;
drhe51c44f2004-05-30 20:46:09 +00003862 if( nLocal>nKey ){
3863 nLocal = nKey;
3864 }
drh0e1c19e2004-05-11 00:58:56 +00003865 }
drhe51c44f2004-05-30 20:46:09 +00003866 *pAmt = nLocal;
drh0e1c19e2004-05-11 00:58:56 +00003867 return aPayload;
3868}
3869
3870
3871/*
drhe51c44f2004-05-30 20:46:09 +00003872** For the entry that cursor pCur is point to, return as
3873** many bytes of the key or data as are available on the local
3874** b-tree page. Write the number of available bytes into *pAmt.
drh0e1c19e2004-05-11 00:58:56 +00003875**
3876** The pointer returned is ephemeral. The key/data may move
drhd677b3d2007-08-20 22:48:41 +00003877** or be destroyed on the next call to any Btree routine,
3878** including calls from other threads against the same cache.
3879** Hence, a mutex on the BtShared should be held prior to calling
3880** this routine.
drh0e1c19e2004-05-11 00:58:56 +00003881**
3882** These routines is used to get quick access to key and data
3883** in the common case where no overflow pages are used.
drh0e1c19e2004-05-11 00:58:56 +00003884*/
drhe51c44f2004-05-30 20:46:09 +00003885const void *sqlite3BtreeKeyFetch(BtCursor *pCur, int *pAmt){
danielk19774b0aa4c2009-05-28 11:05:57 +00003886 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh1fee73e2007-08-29 04:00:57 +00003887 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003888 if( pCur->eState==CURSOR_VALID ){
3889 return (const void*)fetchPayload(pCur, pAmt, 0);
3890 }
3891 return 0;
drh0e1c19e2004-05-11 00:58:56 +00003892}
drhe51c44f2004-05-30 20:46:09 +00003893const void *sqlite3BtreeDataFetch(BtCursor *pCur, int *pAmt){
danielk19774b0aa4c2009-05-28 11:05:57 +00003894 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh1fee73e2007-08-29 04:00:57 +00003895 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003896 if( pCur->eState==CURSOR_VALID ){
3897 return (const void*)fetchPayload(pCur, pAmt, 1);
3898 }
3899 return 0;
drh0e1c19e2004-05-11 00:58:56 +00003900}
3901
3902
3903/*
drh8178a752003-01-05 21:41:40 +00003904** Move the cursor down to a new child page. The newPgno argument is the
drhab01f612004-05-22 02:55:23 +00003905** page number of the child page to move to.
drh72f82862001-05-24 21:06:34 +00003906*/
drh3aac2dd2004-04-26 14:10:20 +00003907static int moveToChild(BtCursor *pCur, u32 newPgno){
drh72f82862001-05-24 21:06:34 +00003908 int rc;
danielk197771d5d2c2008-09-29 11:49:47 +00003909 int i = pCur->iPage;
drh72f82862001-05-24 21:06:34 +00003910 MemPage *pNewPage;
drhd0679ed2007-08-28 22:24:34 +00003911 BtShared *pBt = pCur->pBt;
drh72f82862001-05-24 21:06:34 +00003912
drh1fee73e2007-08-29 04:00:57 +00003913 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003914 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00003915 assert( pCur->iPage<BTCURSOR_MAX_DEPTH );
3916 if( pCur->iPage>=(BTCURSOR_MAX_DEPTH-1) ){
3917 return SQLITE_CORRUPT_BKPT;
3918 }
3919 rc = getAndInitPage(pBt, newPgno, &pNewPage);
drh6019e162001-07-02 17:51:45 +00003920 if( rc ) return rc;
danielk197771d5d2c2008-09-29 11:49:47 +00003921 pCur->apPage[i+1] = pNewPage;
3922 pCur->aiIdx[i+1] = 0;
3923 pCur->iPage++;
3924
drh271efa52004-05-30 19:19:05 +00003925 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003926 pCur->validNKey = 0;
drh4be295b2003-12-16 03:44:47 +00003927 if( pNewPage->nCell<1 ){
drh49285702005-09-17 15:20:26 +00003928 return SQLITE_CORRUPT_BKPT;
drh4be295b2003-12-16 03:44:47 +00003929 }
drh72f82862001-05-24 21:06:34 +00003930 return SQLITE_OK;
3931}
3932
danielk1977bf93c562008-09-29 15:53:25 +00003933#ifndef NDEBUG
3934/*
3935** Page pParent is an internal (non-leaf) tree page. This function
3936** asserts that page number iChild is the left-child if the iIdx'th
3937** cell in page pParent. Or, if iIdx is equal to the total number of
3938** cells in pParent, that page number iChild is the right-child of
3939** the page.
3940*/
3941static void assertParentIndex(MemPage *pParent, int iIdx, Pgno iChild){
3942 assert( iIdx<=pParent->nCell );
3943 if( iIdx==pParent->nCell ){
3944 assert( get4byte(&pParent->aData[pParent->hdrOffset+8])==iChild );
3945 }else{
3946 assert( get4byte(findCell(pParent, iIdx))==iChild );
3947 }
3948}
3949#else
3950# define assertParentIndex(x,y,z)
3951#endif
3952
drh72f82862001-05-24 21:06:34 +00003953/*
drh5e2f8b92001-05-28 00:41:15 +00003954** Move the cursor up to the parent page.
3955**
3956** pCur->idx is set to the cell index that contains the pointer
3957** to the page we are coming from. If we are coming from the
3958** right-most child page then pCur->idx is set to one more than
drhbd03cae2001-06-02 02:40:57 +00003959** the largest cell index.
drh72f82862001-05-24 21:06:34 +00003960*/
danielk197730548662009-07-09 05:07:37 +00003961static void moveToParent(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00003962 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00003963 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00003964 assert( pCur->iPage>0 );
3965 assert( pCur->apPage[pCur->iPage] );
danielk1977bf93c562008-09-29 15:53:25 +00003966 assertParentIndex(
3967 pCur->apPage[pCur->iPage-1],
3968 pCur->aiIdx[pCur->iPage-1],
3969 pCur->apPage[pCur->iPage]->pgno
3970 );
danielk197771d5d2c2008-09-29 11:49:47 +00003971 releasePage(pCur->apPage[pCur->iPage]);
3972 pCur->iPage--;
drh271efa52004-05-30 19:19:05 +00003973 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00003974 pCur->validNKey = 0;
drh72f82862001-05-24 21:06:34 +00003975}
3976
3977/*
3978** Move the cursor to the root page
3979*/
drh5e2f8b92001-05-28 00:41:15 +00003980static int moveToRoot(BtCursor *pCur){
drh3aac2dd2004-04-26 14:10:20 +00003981 MemPage *pRoot;
drh777e4c42006-01-13 04:31:58 +00003982 int rc = SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00003983 Btree *p = pCur->pBtree;
3984 BtShared *pBt = p->pBt;
drhbd03cae2001-06-02 02:40:57 +00003985
drh1fee73e2007-08-29 04:00:57 +00003986 assert( cursorHoldsMutex(pCur) );
drhfb982642007-08-30 01:19:59 +00003987 assert( CURSOR_INVALID < CURSOR_REQUIRESEEK );
3988 assert( CURSOR_VALID < CURSOR_REQUIRESEEK );
3989 assert( CURSOR_FAULT > CURSOR_REQUIRESEEK );
3990 if( pCur->eState>=CURSOR_REQUIRESEEK ){
3991 if( pCur->eState==CURSOR_FAULT ){
3992 return pCur->skip;
3993 }
danielk1977be51a652008-10-08 17:58:48 +00003994 sqlite3BtreeClearCursor(pCur);
drhbf700f32007-03-31 02:36:44 +00003995 }
danielk197771d5d2c2008-09-29 11:49:47 +00003996
3997 if( pCur->iPage>=0 ){
3998 int i;
3999 for(i=1; i<=pCur->iPage; i++){
4000 releasePage(pCur->apPage[i]);
danielk1977d9f6c532008-09-19 16:39:38 +00004001 }
danielk1977172114a2009-07-07 15:47:12 +00004002 pCur->iPage = 0;
drh777e4c42006-01-13 04:31:58 +00004003 }else{
4004 if(
danielk197771d5d2c2008-09-29 11:49:47 +00004005 SQLITE_OK!=(rc = getAndInitPage(pBt, pCur->pgnoRoot, &pCur->apPage[0]))
drh777e4c42006-01-13 04:31:58 +00004006 ){
4007 pCur->eState = CURSOR_INVALID;
4008 return rc;
4009 }
danielk1977172114a2009-07-07 15:47:12 +00004010 pCur->iPage = 0;
4011
4012 /* If pCur->pKeyInfo is not NULL, then the caller that opened this cursor
4013 ** expected to open it on an index b-tree. Otherwise, if pKeyInfo is
4014 ** NULL, the caller expects a table b-tree. If this is not the case,
4015 ** return an SQLITE_CORRUPT error. */
4016 assert( pCur->apPage[0]->intKey==1 || pCur->apPage[0]->intKey==0 );
4017 if( (pCur->pKeyInfo==0)!=pCur->apPage[0]->intKey ){
4018 return SQLITE_CORRUPT_BKPT;
4019 }
drhc39e0002004-05-07 23:50:57 +00004020 }
danielk197771d5d2c2008-09-29 11:49:47 +00004021
4022 pRoot = pCur->apPage[0];
4023 assert( pRoot->pgno==pCur->pgnoRoot );
danielk197771d5d2c2008-09-29 11:49:47 +00004024 pCur->aiIdx[0] = 0;
drh271efa52004-05-30 19:19:05 +00004025 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004026 pCur->atLast = 0;
4027 pCur->validNKey = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00004028
drh8856d6a2004-04-29 14:42:46 +00004029 if( pRoot->nCell==0 && !pRoot->leaf ){
4030 Pgno subpage;
drhc85240d2009-06-04 16:14:33 +00004031 if( pRoot->pgno!=1 ) return SQLITE_CORRUPT_BKPT;
drh8856d6a2004-04-29 14:42:46 +00004032 assert( pRoot->pgno==1 );
drh43605152004-05-29 21:46:49 +00004033 subpage = get4byte(&pRoot->aData[pRoot->hdrOffset+8]);
drh8856d6a2004-04-29 14:42:46 +00004034 assert( subpage>0 );
danielk1977da184232006-01-05 11:34:32 +00004035 pCur->eState = CURSOR_VALID;
drh4b70f112004-05-02 21:12:19 +00004036 rc = moveToChild(pCur, subpage);
danielk197771d5d2c2008-09-29 11:49:47 +00004037 }else{
4038 pCur->eState = ((pRoot->nCell>0)?CURSOR_VALID:CURSOR_INVALID);
drh8856d6a2004-04-29 14:42:46 +00004039 }
4040 return rc;
drh72f82862001-05-24 21:06:34 +00004041}
drh2af926b2001-05-15 00:39:25 +00004042
drh5e2f8b92001-05-28 00:41:15 +00004043/*
4044** Move the cursor down to the left-most leaf entry beneath the
4045** entry to which it is currently pointing.
drh777e4c42006-01-13 04:31:58 +00004046**
4047** The left-most leaf is the one with the smallest key - the first
4048** in ascending order.
drh5e2f8b92001-05-28 00:41:15 +00004049*/
4050static int moveToLeftmost(BtCursor *pCur){
4051 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00004052 int rc = SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00004053 MemPage *pPage;
drh5e2f8b92001-05-28 00:41:15 +00004054
drh1fee73e2007-08-29 04:00:57 +00004055 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00004056 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00004057 while( rc==SQLITE_OK && !(pPage = pCur->apPage[pCur->iPage])->leaf ){
4058 assert( pCur->aiIdx[pCur->iPage]<pPage->nCell );
4059 pgno = get4byte(findCell(pPage, pCur->aiIdx[pCur->iPage]));
drh8178a752003-01-05 21:41:40 +00004060 rc = moveToChild(pCur, pgno);
drh5e2f8b92001-05-28 00:41:15 +00004061 }
drhd677b3d2007-08-20 22:48:41 +00004062 return rc;
drh5e2f8b92001-05-28 00:41:15 +00004063}
4064
drh2dcc9aa2002-12-04 13:40:25 +00004065/*
4066** Move the cursor down to the right-most leaf entry beneath the
4067** page to which it is currently pointing. Notice the difference
4068** between moveToLeftmost() and moveToRightmost(). moveToLeftmost()
4069** finds the left-most entry beneath the *entry* whereas moveToRightmost()
4070** finds the right-most entry beneath the *page*.
drh777e4c42006-01-13 04:31:58 +00004071**
4072** The right-most entry is the one with the largest key - the last
4073** key in ascending order.
drh2dcc9aa2002-12-04 13:40:25 +00004074*/
4075static int moveToRightmost(BtCursor *pCur){
4076 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00004077 int rc = SQLITE_OK;
drh1bd10f82008-12-10 21:19:56 +00004078 MemPage *pPage = 0;
drh2dcc9aa2002-12-04 13:40:25 +00004079
drh1fee73e2007-08-29 04:00:57 +00004080 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00004081 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00004082 while( rc==SQLITE_OK && !(pPage = pCur->apPage[pCur->iPage])->leaf ){
drh43605152004-05-29 21:46:49 +00004083 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
danielk197771d5d2c2008-09-29 11:49:47 +00004084 pCur->aiIdx[pCur->iPage] = pPage->nCell;
drh8178a752003-01-05 21:41:40 +00004085 rc = moveToChild(pCur, pgno);
drh2dcc9aa2002-12-04 13:40:25 +00004086 }
drhd677b3d2007-08-20 22:48:41 +00004087 if( rc==SQLITE_OK ){
danielk197771d5d2c2008-09-29 11:49:47 +00004088 pCur->aiIdx[pCur->iPage] = pPage->nCell-1;
drhd677b3d2007-08-20 22:48:41 +00004089 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004090 pCur->validNKey = 0;
drhd677b3d2007-08-20 22:48:41 +00004091 }
danielk1977518002e2008-09-05 05:02:46 +00004092 return rc;
drh2dcc9aa2002-12-04 13:40:25 +00004093}
4094
drh5e00f6c2001-09-13 13:46:56 +00004095/* Move the cursor to the first entry in the table. Return SQLITE_OK
4096** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00004097** or set *pRes to 1 if the table is empty.
drh5e00f6c2001-09-13 13:46:56 +00004098*/
drh3aac2dd2004-04-26 14:10:20 +00004099int sqlite3BtreeFirst(BtCursor *pCur, int *pRes){
drh5e00f6c2001-09-13 13:46:56 +00004100 int rc;
drhd677b3d2007-08-20 22:48:41 +00004101
drh1fee73e2007-08-29 04:00:57 +00004102 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00004103 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh5e00f6c2001-09-13 13:46:56 +00004104 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00004105 if( rc==SQLITE_OK ){
4106 if( pCur->eState==CURSOR_INVALID ){
danielk197771d5d2c2008-09-29 11:49:47 +00004107 assert( pCur->apPage[pCur->iPage]->nCell==0 );
drhd677b3d2007-08-20 22:48:41 +00004108 *pRes = 1;
4109 rc = SQLITE_OK;
4110 }else{
danielk197771d5d2c2008-09-29 11:49:47 +00004111 assert( pCur->apPage[pCur->iPage]->nCell>0 );
drhd677b3d2007-08-20 22:48:41 +00004112 *pRes = 0;
4113 rc = moveToLeftmost(pCur);
4114 }
drh5e00f6c2001-09-13 13:46:56 +00004115 }
drh5e00f6c2001-09-13 13:46:56 +00004116 return rc;
4117}
drh5e2f8b92001-05-28 00:41:15 +00004118
drh9562b552002-02-19 15:00:07 +00004119/* Move the cursor to the last entry in the table. Return SQLITE_OK
4120** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00004121** or set *pRes to 1 if the table is empty.
drh9562b552002-02-19 15:00:07 +00004122*/
drh3aac2dd2004-04-26 14:10:20 +00004123int sqlite3BtreeLast(BtCursor *pCur, int *pRes){
drh9562b552002-02-19 15:00:07 +00004124 int rc;
drhd677b3d2007-08-20 22:48:41 +00004125
drh1fee73e2007-08-29 04:00:57 +00004126 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00004127 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk19773f632d52009-05-02 10:03:09 +00004128
4129 /* If the cursor already points to the last entry, this is a no-op. */
4130 if( CURSOR_VALID==pCur->eState && pCur->atLast ){
4131#ifdef SQLITE_DEBUG
4132 /* This block serves to assert() that the cursor really does point
4133 ** to the last entry in the b-tree. */
4134 int ii;
4135 for(ii=0; ii<pCur->iPage; ii++){
4136 assert( pCur->aiIdx[ii]==pCur->apPage[ii]->nCell );
4137 }
4138 assert( pCur->aiIdx[pCur->iPage]==pCur->apPage[pCur->iPage]->nCell-1 );
4139 assert( pCur->apPage[pCur->iPage]->leaf );
4140#endif
4141 return SQLITE_OK;
4142 }
4143
drh9562b552002-02-19 15:00:07 +00004144 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00004145 if( rc==SQLITE_OK ){
4146 if( CURSOR_INVALID==pCur->eState ){
danielk197771d5d2c2008-09-29 11:49:47 +00004147 assert( pCur->apPage[pCur->iPage]->nCell==0 );
drhd677b3d2007-08-20 22:48:41 +00004148 *pRes = 1;
4149 }else{
4150 assert( pCur->eState==CURSOR_VALID );
4151 *pRes = 0;
4152 rc = moveToRightmost(pCur);
drhf49661a2008-12-10 16:45:50 +00004153 pCur->atLast = rc==SQLITE_OK ?1:0;
drhd677b3d2007-08-20 22:48:41 +00004154 }
drh9562b552002-02-19 15:00:07 +00004155 }
drh9562b552002-02-19 15:00:07 +00004156 return rc;
4157}
4158
drhe14006d2008-03-25 17:23:32 +00004159/* Move the cursor so that it points to an entry near the key
drhe63d9992008-08-13 19:11:48 +00004160** specified by pIdxKey or intKey. Return a success code.
drh72f82862001-05-24 21:06:34 +00004161**
drhe63d9992008-08-13 19:11:48 +00004162** For INTKEY tables, the intKey parameter is used. pIdxKey
4163** must be NULL. For index tables, pIdxKey is used and intKey
4164** is ignored.
drh3aac2dd2004-04-26 14:10:20 +00004165**
drh5e2f8b92001-05-28 00:41:15 +00004166** If an exact match is not found, then the cursor is always
drhbd03cae2001-06-02 02:40:57 +00004167** left pointing at a leaf page which would hold the entry if it
drh5e2f8b92001-05-28 00:41:15 +00004168** were present. The cursor might point to an entry that comes
4169** before or after the key.
4170**
drh64022502009-01-09 14:11:04 +00004171** An integer is written into *pRes which is the result of
4172** comparing the key with the entry to which the cursor is
4173** pointing. The meaning of the integer written into
4174** *pRes is as follows:
drhbd03cae2001-06-02 02:40:57 +00004175**
4176** *pRes<0 The cursor is left pointing at an entry that
drh64022502009-01-09 14:11:04 +00004177** is smaller than intKey/pIdxKey or if the table is empty
drh1a844c32002-12-04 22:29:28 +00004178** and the cursor is therefore left point to nothing.
drhbd03cae2001-06-02 02:40:57 +00004179**
4180** *pRes==0 The cursor is left pointing at an entry that
drh64022502009-01-09 14:11:04 +00004181** exactly matches intKey/pIdxKey.
drhbd03cae2001-06-02 02:40:57 +00004182**
4183** *pRes>0 The cursor is left pointing at an entry that
drh64022502009-01-09 14:11:04 +00004184** is larger than intKey/pIdxKey.
drhd677b3d2007-08-20 22:48:41 +00004185**
drha059ad02001-04-17 20:09:11 +00004186*/
drhe63d9992008-08-13 19:11:48 +00004187int sqlite3BtreeMovetoUnpacked(
4188 BtCursor *pCur, /* The cursor to be moved */
4189 UnpackedRecord *pIdxKey, /* Unpacked index key */
4190 i64 intKey, /* The table key */
4191 int biasRight, /* If true, bias the search to the high end */
4192 int *pRes /* Write search results here */
drhe4d90812007-03-29 05:51:49 +00004193){
drh72f82862001-05-24 21:06:34 +00004194 int rc;
drhd677b3d2007-08-20 22:48:41 +00004195
drh1fee73e2007-08-29 04:00:57 +00004196 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00004197 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk19775cb09632009-07-09 11:36:01 +00004198 assert( pRes );
drha2c20e42008-03-29 16:01:04 +00004199
4200 /* If the cursor is already positioned at the point we are trying
4201 ** to move to, then just return without doing any work */
danielk197771d5d2c2008-09-29 11:49:47 +00004202 if( pCur->eState==CURSOR_VALID && pCur->validNKey
4203 && pCur->apPage[0]->intKey
4204 ){
drhe63d9992008-08-13 19:11:48 +00004205 if( pCur->info.nKey==intKey ){
drha2c20e42008-03-29 16:01:04 +00004206 *pRes = 0;
4207 return SQLITE_OK;
4208 }
drhe63d9992008-08-13 19:11:48 +00004209 if( pCur->atLast && pCur->info.nKey<intKey ){
drha2c20e42008-03-29 16:01:04 +00004210 *pRes = -1;
4211 return SQLITE_OK;
4212 }
4213 }
4214
drh5e2f8b92001-05-28 00:41:15 +00004215 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00004216 if( rc ){
4217 return rc;
4218 }
danielk197771d5d2c2008-09-29 11:49:47 +00004219 assert( pCur->apPage[pCur->iPage] );
4220 assert( pCur->apPage[pCur->iPage]->isInit );
danielk1977171fff32009-07-11 05:06:51 +00004221 assert( pCur->apPage[pCur->iPage]->nCell>0 || pCur->eState==CURSOR_INVALID );
danielk1977da184232006-01-05 11:34:32 +00004222 if( pCur->eState==CURSOR_INVALID ){
drhf328bc82004-05-10 23:29:49 +00004223 *pRes = -1;
danielk197771d5d2c2008-09-29 11:49:47 +00004224 assert( pCur->apPage[pCur->iPage]->nCell==0 );
drhc39e0002004-05-07 23:50:57 +00004225 return SQLITE_OK;
4226 }
danielk197771d5d2c2008-09-29 11:49:47 +00004227 assert( pCur->apPage[0]->intKey || pIdxKey );
drh14684382006-11-30 13:05:29 +00004228 for(;;){
drh72f82862001-05-24 21:06:34 +00004229 int lwr, upr;
4230 Pgno chldPg;
danielk197771d5d2c2008-09-29 11:49:47 +00004231 MemPage *pPage = pCur->apPage[pCur->iPage];
danielk1977171fff32009-07-11 05:06:51 +00004232 int c;
4233
4234 /* pPage->nCell must be greater than zero. If this is the root-page
4235 ** the cursor would have been INVALID above and this for(;;) loop
4236 ** not run. If this is not the root-page, then the moveToChild() routine
4237 ** would have already detected db corruption. */
4238 assert( pPage->nCell>0 );
drh72f82862001-05-24 21:06:34 +00004239 lwr = 0;
4240 upr = pPage->nCell-1;
danielk1977171fff32009-07-11 05:06:51 +00004241 if( (!pPage->intKey && pIdxKey==0) ){
drh1e968a02008-03-25 00:22:21 +00004242 rc = SQLITE_CORRUPT_BKPT;
4243 goto moveto_finish;
drh4eec4c12005-01-21 00:22:37 +00004244 }
drhe4d90812007-03-29 05:51:49 +00004245 if( biasRight ){
drhf49661a2008-12-10 16:45:50 +00004246 pCur->aiIdx[pCur->iPage] = (u16)upr;
drhe4d90812007-03-29 05:51:49 +00004247 }else{
drhf49661a2008-12-10 16:45:50 +00004248 pCur->aiIdx[pCur->iPage] = (u16)((upr+lwr)/2);
drhe4d90812007-03-29 05:51:49 +00004249 }
drh64022502009-01-09 14:11:04 +00004250 for(;;){
danielk197711c327a2009-05-04 19:01:26 +00004251 int idx = pCur->aiIdx[pCur->iPage]; /* Index of current cell in pPage */
4252 u8 *pCell; /* Pointer to current cell in pPage */
4253
drh366fda62006-01-13 02:35:09 +00004254 pCur->info.nSize = 0;
danielk197711c327a2009-05-04 19:01:26 +00004255 pCell = findCell(pPage, idx) + pPage->childPtrSize;
drh3aac2dd2004-04-26 14:10:20 +00004256 if( pPage->intKey ){
danielk197711c327a2009-05-04 19:01:26 +00004257 i64 nCellKey;
drhd172f862006-01-12 15:01:15 +00004258 if( pPage->hasData ){
danielk1977bab45c62006-01-16 15:14:27 +00004259 u32 dummy;
shane3f8d5cf2008-04-24 19:15:09 +00004260 pCell += getVarint32(pCell, dummy);
drhd172f862006-01-12 15:01:15 +00004261 }
drha2c20e42008-03-29 16:01:04 +00004262 getVarint(pCell, (u64*)&nCellKey);
drhe63d9992008-08-13 19:11:48 +00004263 if( nCellKey==intKey ){
drh3aac2dd2004-04-26 14:10:20 +00004264 c = 0;
drhe63d9992008-08-13 19:11:48 +00004265 }else if( nCellKey<intKey ){
drh41eb9e92008-04-02 18:33:07 +00004266 c = -1;
4267 }else{
drhe63d9992008-08-13 19:11:48 +00004268 assert( nCellKey>intKey );
drh41eb9e92008-04-02 18:33:07 +00004269 c = +1;
drh3aac2dd2004-04-26 14:10:20 +00004270 }
danielk197711c327a2009-05-04 19:01:26 +00004271 pCur->validNKey = 1;
4272 pCur->info.nKey = nCellKey;
drh3aac2dd2004-04-26 14:10:20 +00004273 }else{
danielk197711c327a2009-05-04 19:01:26 +00004274 /* The maximum supported page-size is 32768 bytes. This means that
4275 ** the maximum number of record bytes stored on an index B-Tree
4276 ** page is at most 8198 bytes, which may be stored as a 2-byte
4277 ** varint. This information is used to attempt to avoid parsing
4278 ** the entire cell by checking for the cases where the record is
4279 ** stored entirely within the b-tree page by inspecting the first
4280 ** 2 bytes of the cell.
4281 */
4282 int nCell = pCell[0];
4283 if( !(nCell & 0x80) && nCell<=pPage->maxLocal ){
4284 /* This branch runs if the record-size field of the cell is a
4285 ** single byte varint and the record fits entirely on the main
4286 ** b-tree page. */
4287 c = sqlite3VdbeRecordCompare(nCell, (void*)&pCell[1], pIdxKey);
4288 }else if( !(pCell[1] & 0x80)
4289 && (nCell = ((nCell&0x7f)<<7) + pCell[1])<=pPage->maxLocal
4290 ){
4291 /* The record-size field is a 2 byte varint and the record
4292 ** fits entirely on the main b-tree page. */
4293 c = sqlite3VdbeRecordCompare(nCell, (void*)&pCell[2], pIdxKey);
drhe51c44f2004-05-30 20:46:09 +00004294 }else{
danielk197711c327a2009-05-04 19:01:26 +00004295 /* The record flows over onto one or more overflow pages. In
4296 ** this case the whole cell needs to be parsed, a buffer allocated
4297 ** and accessPayload() used to retrieve the record into the
4298 ** buffer before VdbeRecordCompare() can be called. */
4299 void *pCellKey;
4300 u8 * const pCellBody = pCell - pPage->childPtrSize;
danielk197730548662009-07-09 05:07:37 +00004301 btreeParseCellPtr(pPage, pCellBody, &pCur->info);
shane60a4b532009-05-06 18:57:09 +00004302 nCell = (int)pCur->info.nKey;
danielk197711c327a2009-05-04 19:01:26 +00004303 pCellKey = sqlite3Malloc( nCell );
danielk19776507ecb2008-03-25 09:56:44 +00004304 if( pCellKey==0 ){
4305 rc = SQLITE_NOMEM;
4306 goto moveto_finish;
4307 }
danielk197711c327a2009-05-04 19:01:26 +00004308 rc = accessPayload(pCur, 0, nCell, (unsigned char*)pCellKey, 0, 0);
4309 c = sqlite3VdbeRecordCompare(nCell, pCellKey, pIdxKey);
drhfacf0302008-06-17 15:12:00 +00004310 sqlite3_free(pCellKey);
drh1e968a02008-03-25 00:22:21 +00004311 if( rc ) goto moveto_finish;
drhe51c44f2004-05-30 20:46:09 +00004312 }
drh3aac2dd2004-04-26 14:10:20 +00004313 }
drh72f82862001-05-24 21:06:34 +00004314 if( c==0 ){
drh44845222008-07-17 18:39:57 +00004315 if( pPage->intKey && !pPage->leaf ){
danielk197771d5d2c2008-09-29 11:49:47 +00004316 lwr = idx;
drhfc70e6f2004-05-12 21:11:27 +00004317 upr = lwr - 1;
drh8b18dd42004-05-12 19:18:15 +00004318 break;
4319 }else{
drh64022502009-01-09 14:11:04 +00004320 *pRes = 0;
drh1e968a02008-03-25 00:22:21 +00004321 rc = SQLITE_OK;
4322 goto moveto_finish;
drh8b18dd42004-05-12 19:18:15 +00004323 }
drh72f82862001-05-24 21:06:34 +00004324 }
4325 if( c<0 ){
danielk197771d5d2c2008-09-29 11:49:47 +00004326 lwr = idx+1;
drh72f82862001-05-24 21:06:34 +00004327 }else{
danielk197771d5d2c2008-09-29 11:49:47 +00004328 upr = idx-1;
drh72f82862001-05-24 21:06:34 +00004329 }
drhf1d68b32007-03-29 04:43:26 +00004330 if( lwr>upr ){
4331 break;
4332 }
drhf49661a2008-12-10 16:45:50 +00004333 pCur->aiIdx[pCur->iPage] = (u16)((lwr+upr)/2);
drh72f82862001-05-24 21:06:34 +00004334 }
4335 assert( lwr==upr+1 );
danielk197771d5d2c2008-09-29 11:49:47 +00004336 assert( pPage->isInit );
drh3aac2dd2004-04-26 14:10:20 +00004337 if( pPage->leaf ){
drha34b6762004-05-07 13:30:42 +00004338 chldPg = 0;
drh3aac2dd2004-04-26 14:10:20 +00004339 }else if( lwr>=pPage->nCell ){
drh43605152004-05-29 21:46:49 +00004340 chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh72f82862001-05-24 21:06:34 +00004341 }else{
danielk19771cc5ed82007-05-16 17:28:43 +00004342 chldPg = get4byte(findCell(pPage, lwr));
drh72f82862001-05-24 21:06:34 +00004343 }
4344 if( chldPg==0 ){
danielk197771d5d2c2008-09-29 11:49:47 +00004345 assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
danielk19775cb09632009-07-09 11:36:01 +00004346 *pRes = c;
drh1e968a02008-03-25 00:22:21 +00004347 rc = SQLITE_OK;
4348 goto moveto_finish;
drh72f82862001-05-24 21:06:34 +00004349 }
drhf49661a2008-12-10 16:45:50 +00004350 pCur->aiIdx[pCur->iPage] = (u16)lwr;
drh271efa52004-05-30 19:19:05 +00004351 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004352 pCur->validNKey = 0;
drh8178a752003-01-05 21:41:40 +00004353 rc = moveToChild(pCur, chldPg);
drh1e968a02008-03-25 00:22:21 +00004354 if( rc ) goto moveto_finish;
drh72f82862001-05-24 21:06:34 +00004355 }
drh1e968a02008-03-25 00:22:21 +00004356moveto_finish:
drhe63d9992008-08-13 19:11:48 +00004357 return rc;
4358}
4359
drhd677b3d2007-08-20 22:48:41 +00004360
drh72f82862001-05-24 21:06:34 +00004361/*
drhc39e0002004-05-07 23:50:57 +00004362** Return TRUE if the cursor is not pointing at an entry of the table.
4363**
4364** TRUE will be returned after a call to sqlite3BtreeNext() moves
4365** past the last entry in the table or sqlite3BtreePrev() moves past
4366** the first entry. TRUE is also returned if the table is empty.
4367*/
4368int sqlite3BtreeEof(BtCursor *pCur){
danielk1977da184232006-01-05 11:34:32 +00004369 /* TODO: What if the cursor is in CURSOR_REQUIRESEEK but all table entries
4370 ** have been deleted? This API will need to change to return an error code
4371 ** as well as the boolean result value.
4372 */
4373 return (CURSOR_VALID!=pCur->eState);
drhc39e0002004-05-07 23:50:57 +00004374}
4375
4376/*
drhbd03cae2001-06-02 02:40:57 +00004377** Advance the cursor to the next entry in the database. If
drh8c1238a2003-01-02 14:43:55 +00004378** successful then set *pRes=0. If the cursor
drhbd03cae2001-06-02 02:40:57 +00004379** was already pointing to the last entry in the database before
drh8c1238a2003-01-02 14:43:55 +00004380** this routine was called, then set *pRes=1.
drh72f82862001-05-24 21:06:34 +00004381*/
drhd094db12008-04-03 21:46:57 +00004382int sqlite3BtreeNext(BtCursor *pCur, int *pRes){
drh72f82862001-05-24 21:06:34 +00004383 int rc;
danielk197771d5d2c2008-09-29 11:49:47 +00004384 int idx;
danielk197797a227c2006-01-20 16:32:04 +00004385 MemPage *pPage;
drh8b18dd42004-05-12 19:18:15 +00004386
drh1fee73e2007-08-29 04:00:57 +00004387 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00004388 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00004389 if( rc!=SQLITE_OK ){
4390 return rc;
4391 }
drh8c4d3a62007-04-06 01:03:32 +00004392 assert( pRes!=0 );
drh8c4d3a62007-04-06 01:03:32 +00004393 if( CURSOR_INVALID==pCur->eState ){
4394 *pRes = 1;
4395 return SQLITE_OK;
4396 }
danielk1977da184232006-01-05 11:34:32 +00004397 if( pCur->skip>0 ){
4398 pCur->skip = 0;
4399 *pRes = 0;
4400 return SQLITE_OK;
4401 }
4402 pCur->skip = 0;
danielk1977da184232006-01-05 11:34:32 +00004403
danielk197771d5d2c2008-09-29 11:49:47 +00004404 pPage = pCur->apPage[pCur->iPage];
4405 idx = ++pCur->aiIdx[pCur->iPage];
4406 assert( pPage->isInit );
4407 assert( idx<=pPage->nCell );
danielk19776a43f9b2004-11-16 04:57:24 +00004408
drh271efa52004-05-30 19:19:05 +00004409 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004410 pCur->validNKey = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00004411 if( idx>=pPage->nCell ){
drha34b6762004-05-07 13:30:42 +00004412 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00004413 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
drh5e2f8b92001-05-28 00:41:15 +00004414 if( rc ) return rc;
4415 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00004416 *pRes = 0;
4417 return rc;
drh72f82862001-05-24 21:06:34 +00004418 }
drh5e2f8b92001-05-28 00:41:15 +00004419 do{
danielk197771d5d2c2008-09-29 11:49:47 +00004420 if( pCur->iPage==0 ){
drh8c1238a2003-01-02 14:43:55 +00004421 *pRes = 1;
danielk1977da184232006-01-05 11:34:32 +00004422 pCur->eState = CURSOR_INVALID;
drh5e2f8b92001-05-28 00:41:15 +00004423 return SQLITE_OK;
4424 }
danielk197730548662009-07-09 05:07:37 +00004425 moveToParent(pCur);
danielk197771d5d2c2008-09-29 11:49:47 +00004426 pPage = pCur->apPage[pCur->iPage];
4427 }while( pCur->aiIdx[pCur->iPage]>=pPage->nCell );
drh8c1238a2003-01-02 14:43:55 +00004428 *pRes = 0;
drh44845222008-07-17 18:39:57 +00004429 if( pPage->intKey ){
drh8b18dd42004-05-12 19:18:15 +00004430 rc = sqlite3BtreeNext(pCur, pRes);
4431 }else{
4432 rc = SQLITE_OK;
4433 }
4434 return rc;
drh8178a752003-01-05 21:41:40 +00004435 }
4436 *pRes = 0;
drh3aac2dd2004-04-26 14:10:20 +00004437 if( pPage->leaf ){
drh8178a752003-01-05 21:41:40 +00004438 return SQLITE_OK;
drh72f82862001-05-24 21:06:34 +00004439 }
drh5e2f8b92001-05-28 00:41:15 +00004440 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00004441 return rc;
drh72f82862001-05-24 21:06:34 +00004442}
drhd677b3d2007-08-20 22:48:41 +00004443
drh72f82862001-05-24 21:06:34 +00004444
drh3b7511c2001-05-26 13:15:44 +00004445/*
drh2dcc9aa2002-12-04 13:40:25 +00004446** Step the cursor to the back to the previous entry in the database. If
drh8178a752003-01-05 21:41:40 +00004447** successful then set *pRes=0. If the cursor
drh2dcc9aa2002-12-04 13:40:25 +00004448** was already pointing to the first entry in the database before
drh8178a752003-01-05 21:41:40 +00004449** this routine was called, then set *pRes=1.
drh2dcc9aa2002-12-04 13:40:25 +00004450*/
drhd094db12008-04-03 21:46:57 +00004451int sqlite3BtreePrevious(BtCursor *pCur, int *pRes){
drh2dcc9aa2002-12-04 13:40:25 +00004452 int rc;
drh8178a752003-01-05 21:41:40 +00004453 MemPage *pPage;
danielk1977da184232006-01-05 11:34:32 +00004454
drh1fee73e2007-08-29 04:00:57 +00004455 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00004456 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00004457 if( rc!=SQLITE_OK ){
4458 return rc;
4459 }
drha2c20e42008-03-29 16:01:04 +00004460 pCur->atLast = 0;
drh8c4d3a62007-04-06 01:03:32 +00004461 if( CURSOR_INVALID==pCur->eState ){
4462 *pRes = 1;
4463 return SQLITE_OK;
4464 }
danielk1977da184232006-01-05 11:34:32 +00004465 if( pCur->skip<0 ){
4466 pCur->skip = 0;
4467 *pRes = 0;
4468 return SQLITE_OK;
4469 }
4470 pCur->skip = 0;
danielk1977da184232006-01-05 11:34:32 +00004471
danielk197771d5d2c2008-09-29 11:49:47 +00004472 pPage = pCur->apPage[pCur->iPage];
4473 assert( pPage->isInit );
drha34b6762004-05-07 13:30:42 +00004474 if( !pPage->leaf ){
danielk197771d5d2c2008-09-29 11:49:47 +00004475 int idx = pCur->aiIdx[pCur->iPage];
4476 rc = moveToChild(pCur, get4byte(findCell(pPage, idx)));
drhd677b3d2007-08-20 22:48:41 +00004477 if( rc ){
4478 return rc;
4479 }
drh2dcc9aa2002-12-04 13:40:25 +00004480 rc = moveToRightmost(pCur);
4481 }else{
danielk197771d5d2c2008-09-29 11:49:47 +00004482 while( pCur->aiIdx[pCur->iPage]==0 ){
4483 if( pCur->iPage==0 ){
danielk1977da184232006-01-05 11:34:32 +00004484 pCur->eState = CURSOR_INVALID;
drhc39e0002004-05-07 23:50:57 +00004485 *pRes = 1;
drh2dcc9aa2002-12-04 13:40:25 +00004486 return SQLITE_OK;
4487 }
danielk197730548662009-07-09 05:07:37 +00004488 moveToParent(pCur);
drh2dcc9aa2002-12-04 13:40:25 +00004489 }
drh271efa52004-05-30 19:19:05 +00004490 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004491 pCur->validNKey = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00004492
4493 pCur->aiIdx[pCur->iPage]--;
4494 pPage = pCur->apPage[pCur->iPage];
drh44845222008-07-17 18:39:57 +00004495 if( pPage->intKey && !pPage->leaf ){
drh8b18dd42004-05-12 19:18:15 +00004496 rc = sqlite3BtreePrevious(pCur, pRes);
4497 }else{
4498 rc = SQLITE_OK;
4499 }
drh2dcc9aa2002-12-04 13:40:25 +00004500 }
drh8178a752003-01-05 21:41:40 +00004501 *pRes = 0;
drh2dcc9aa2002-12-04 13:40:25 +00004502 return rc;
4503}
4504
4505/*
drh3b7511c2001-05-26 13:15:44 +00004506** Allocate a new page from the database file.
4507**
danielk19773b8a05f2007-03-19 17:44:26 +00004508** The new page is marked as dirty. (In other words, sqlite3PagerWrite()
drh3b7511c2001-05-26 13:15:44 +00004509** has already been called on the new page.) The new page has also
4510** been referenced and the calling routine is responsible for calling
danielk19773b8a05f2007-03-19 17:44:26 +00004511** sqlite3PagerUnref() on the new page when it is done.
drh3b7511c2001-05-26 13:15:44 +00004512**
4513** SQLITE_OK is returned on success. Any other return value indicates
4514** an error. *ppPage and *pPgno are undefined in the event of an error.
danielk19773b8a05f2007-03-19 17:44:26 +00004515** Do not invoke sqlite3PagerUnref() on *ppPage if an error is returned.
drhbea00b92002-07-08 10:59:50 +00004516**
drh199e3cf2002-07-18 11:01:47 +00004517** If the "nearby" parameter is not 0, then a (feeble) effort is made to
4518** locate a page close to the page number "nearby". This can be used in an
drhbea00b92002-07-08 10:59:50 +00004519** attempt to keep related pages close to each other in the database file,
4520** which in turn can make database access faster.
danielk1977cb1a7eb2004-11-05 12:27:02 +00004521**
4522** If the "exact" parameter is not 0, and the page-number nearby exists
4523** anywhere on the free-list, then it is guarenteed to be returned. This
4524** is only used by auto-vacuum databases when allocating a new table.
drh3b7511c2001-05-26 13:15:44 +00004525*/
drh4f0c5872007-03-26 22:05:01 +00004526static int allocateBtreePage(
danielk1977aef0bf62005-12-30 16:28:01 +00004527 BtShared *pBt,
danielk1977cb1a7eb2004-11-05 12:27:02 +00004528 MemPage **ppPage,
4529 Pgno *pPgno,
4530 Pgno nearby,
4531 u8 exact
4532){
drh3aac2dd2004-04-26 14:10:20 +00004533 MemPage *pPage1;
drh8c42ca92001-06-22 19:15:00 +00004534 int rc;
drh35cd6432009-06-05 14:17:21 +00004535 u32 n; /* Number of pages on the freelist */
drh042d6a12009-06-17 13:57:16 +00004536 u32 k; /* Number of leaves on the trunk of the freelist */
drhd3627af2006-12-18 18:34:51 +00004537 MemPage *pTrunk = 0;
4538 MemPage *pPrevTrunk = 0;
drh1662b5a2009-06-04 19:06:09 +00004539 Pgno mxPage; /* Total size of the database file */
drh30e58752002-03-02 20:41:57 +00004540
drh1fee73e2007-08-29 04:00:57 +00004541 assert( sqlite3_mutex_held(pBt->mutex) );
drh3aac2dd2004-04-26 14:10:20 +00004542 pPage1 = pBt->pPage1;
drh1662b5a2009-06-04 19:06:09 +00004543 mxPage = pagerPagecount(pBt);
drh3aac2dd2004-04-26 14:10:20 +00004544 n = get4byte(&pPage1->aData[36]);
drhdf35a082009-07-09 02:24:35 +00004545 testcase( n==mxPage-1 );
4546 if( n>=mxPage ){
drh1662b5a2009-06-04 19:06:09 +00004547 return SQLITE_CORRUPT_BKPT;
4548 }
drh3aac2dd2004-04-26 14:10:20 +00004549 if( n>0 ){
drh91025292004-05-03 19:49:32 +00004550 /* There are pages on the freelist. Reuse one of those pages. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00004551 Pgno iTrunk;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004552 u8 searchList = 0; /* If the free-list must be searched for 'nearby' */
4553
4554 /* If the 'exact' parameter was true and a query of the pointer-map
4555 ** shows that the page 'nearby' is somewhere on the free-list, then
4556 ** the entire-list will be searched for that page.
4557 */
4558#ifndef SQLITE_OMIT_AUTOVACUUM
drh1662b5a2009-06-04 19:06:09 +00004559 if( exact && nearby<=mxPage ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004560 u8 eType;
4561 assert( nearby>0 );
4562 assert( pBt->autoVacuum );
4563 rc = ptrmapGet(pBt, nearby, &eType, 0);
4564 if( rc ) return rc;
4565 if( eType==PTRMAP_FREEPAGE ){
4566 searchList = 1;
4567 }
4568 *pPgno = nearby;
4569 }
4570#endif
4571
4572 /* Decrement the free-list count by 1. Set iTrunk to the index of the
4573 ** first free-list trunk page. iPrevTrunk is initially 1.
4574 */
danielk19773b8a05f2007-03-19 17:44:26 +00004575 rc = sqlite3PagerWrite(pPage1->pDbPage);
drh3b7511c2001-05-26 13:15:44 +00004576 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00004577 put4byte(&pPage1->aData[36], n-1);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004578
4579 /* The code within this loop is run only once if the 'searchList' variable
4580 ** is not true. Otherwise, it runs once for each trunk-page on the
4581 ** free-list until the page 'nearby' is located.
4582 */
4583 do {
4584 pPrevTrunk = pTrunk;
4585 if( pPrevTrunk ){
4586 iTrunk = get4byte(&pPrevTrunk->aData[0]);
drhbea00b92002-07-08 10:59:50 +00004587 }else{
danielk1977cb1a7eb2004-11-05 12:27:02 +00004588 iTrunk = get4byte(&pPage1->aData[32]);
drhbea00b92002-07-08 10:59:50 +00004589 }
drhdf35a082009-07-09 02:24:35 +00004590 testcase( iTrunk==mxPage );
drh1662b5a2009-06-04 19:06:09 +00004591 if( iTrunk>mxPage ){
4592 rc = SQLITE_CORRUPT_BKPT;
4593 }else{
danielk197730548662009-07-09 05:07:37 +00004594 rc = btreeGetPage(pBt, iTrunk, &pTrunk, 0);
drh1662b5a2009-06-04 19:06:09 +00004595 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004596 if( rc ){
drhd3627af2006-12-18 18:34:51 +00004597 pTrunk = 0;
4598 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004599 }
4600
4601 k = get4byte(&pTrunk->aData[4]);
drhdf35a082009-07-09 02:24:35 +00004602 testcase( k==(u32)(pBt->usableSize/4 - 2) );
danielk1977cb1a7eb2004-11-05 12:27:02 +00004603 if( k==0 && !searchList ){
4604 /* The trunk has no leaves and the list is not being searched.
4605 ** So extract the trunk page itself and use it as the newly
4606 ** allocated page */
4607 assert( pPrevTrunk==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00004608 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004609 if( rc ){
4610 goto end_allocate_page;
4611 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004612 *pPgno = iTrunk;
4613 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
4614 *ppPage = pTrunk;
4615 pTrunk = 0;
4616 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
drh042d6a12009-06-17 13:57:16 +00004617 }else if( k>(u32)(pBt->usableSize/4 - 2) ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004618 /* Value of k is out of range. Database corruption */
drhd3627af2006-12-18 18:34:51 +00004619 rc = SQLITE_CORRUPT_BKPT;
4620 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004621#ifndef SQLITE_OMIT_AUTOVACUUM
4622 }else if( searchList && nearby==iTrunk ){
4623 /* The list is being searched and this trunk page is the page
4624 ** to allocate, regardless of whether it has leaves.
4625 */
4626 assert( *pPgno==iTrunk );
4627 *ppPage = pTrunk;
4628 searchList = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00004629 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004630 if( rc ){
4631 goto end_allocate_page;
4632 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004633 if( k==0 ){
4634 if( !pPrevTrunk ){
4635 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
4636 }else{
4637 memcpy(&pPrevTrunk->aData[0], &pTrunk->aData[0], 4);
4638 }
4639 }else{
4640 /* The trunk page is required by the caller but it contains
4641 ** pointers to free-list leaves. The first leaf becomes a trunk
4642 ** page in this case.
4643 */
4644 MemPage *pNewTrunk;
4645 Pgno iNewTrunk = get4byte(&pTrunk->aData[8]);
drh1662b5a2009-06-04 19:06:09 +00004646 if( iNewTrunk>mxPage ){
4647 rc = SQLITE_CORRUPT_BKPT;
4648 goto end_allocate_page;
4649 }
drhdf35a082009-07-09 02:24:35 +00004650 testcase( iNewTrunk==mxPage );
danielk197730548662009-07-09 05:07:37 +00004651 rc = btreeGetPage(pBt, iNewTrunk, &pNewTrunk, 0);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004652 if( rc!=SQLITE_OK ){
drhd3627af2006-12-18 18:34:51 +00004653 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004654 }
danielk19773b8a05f2007-03-19 17:44:26 +00004655 rc = sqlite3PagerWrite(pNewTrunk->pDbPage);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004656 if( rc!=SQLITE_OK ){
4657 releasePage(pNewTrunk);
drhd3627af2006-12-18 18:34:51 +00004658 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004659 }
4660 memcpy(&pNewTrunk->aData[0], &pTrunk->aData[0], 4);
4661 put4byte(&pNewTrunk->aData[4], k-1);
4662 memcpy(&pNewTrunk->aData[8], &pTrunk->aData[12], (k-1)*4);
drhd3627af2006-12-18 18:34:51 +00004663 releasePage(pNewTrunk);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004664 if( !pPrevTrunk ){
drhc5053fb2008-11-27 02:22:10 +00004665 assert( sqlite3PagerIswriteable(pPage1->pDbPage) );
danielk1977cb1a7eb2004-11-05 12:27:02 +00004666 put4byte(&pPage1->aData[32], iNewTrunk);
4667 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004668 rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004669 if( rc ){
4670 goto end_allocate_page;
4671 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004672 put4byte(&pPrevTrunk->aData[0], iNewTrunk);
4673 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004674 }
4675 pTrunk = 0;
4676 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
4677#endif
danielk1977e5765212009-06-17 11:13:28 +00004678 }else if( k>0 ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004679 /* Extract a leaf from the trunk */
drh042d6a12009-06-17 13:57:16 +00004680 u32 closest;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004681 Pgno iPage;
4682 unsigned char *aData = pTrunk->aData;
danielk19773b8a05f2007-03-19 17:44:26 +00004683 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004684 if( rc ){
4685 goto end_allocate_page;
4686 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004687 if( nearby>0 ){
drh042d6a12009-06-17 13:57:16 +00004688 u32 i;
4689 int dist;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004690 closest = 0;
4691 dist = get4byte(&aData[8]) - nearby;
4692 if( dist<0 ) dist = -dist;
4693 for(i=1; i<k; i++){
4694 int d2 = get4byte(&aData[8+i*4]) - nearby;
4695 if( d2<0 ) d2 = -d2;
4696 if( d2<dist ){
4697 closest = i;
4698 dist = d2;
4699 }
4700 }
4701 }else{
4702 closest = 0;
4703 }
4704
4705 iPage = get4byte(&aData[8+closest*4]);
drhdf35a082009-07-09 02:24:35 +00004706 testcase( iPage==mxPage );
drh1662b5a2009-06-04 19:06:09 +00004707 if( iPage>mxPage ){
4708 rc = SQLITE_CORRUPT_BKPT;
4709 goto end_allocate_page;
4710 }
drhdf35a082009-07-09 02:24:35 +00004711 testcase( iPage==mxPage );
danielk1977cb1a7eb2004-11-05 12:27:02 +00004712 if( !searchList || iPage==nearby ){
danielk1977bea2a942009-01-20 17:06:27 +00004713 int noContent;
shane1f9e6aa2008-06-09 19:27:11 +00004714 *pPgno = iPage;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004715 TRACE(("ALLOCATE: %d was leaf %d of %d on trunk %d"
4716 ": %d more free pages\n",
4717 *pPgno, closest+1, k, pTrunk->pgno, n-1));
4718 if( closest<k-1 ){
4719 memcpy(&aData[8+closest*4], &aData[4+k*4], 4);
4720 }
4721 put4byte(&aData[4], k-1);
drhc5053fb2008-11-27 02:22:10 +00004722 assert( sqlite3PagerIswriteable(pTrunk->pDbPage) );
danielk1977bea2a942009-01-20 17:06:27 +00004723 noContent = !btreeGetHasContent(pBt, *pPgno);
danielk197730548662009-07-09 05:07:37 +00004724 rc = btreeGetPage(pBt, *pPgno, ppPage, noContent);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004725 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004726 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00004727 if( rc!=SQLITE_OK ){
4728 releasePage(*ppPage);
4729 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004730 }
4731 searchList = 0;
4732 }
drhee696e22004-08-30 16:52:17 +00004733 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004734 releasePage(pPrevTrunk);
drhd3627af2006-12-18 18:34:51 +00004735 pPrevTrunk = 0;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004736 }while( searchList );
drh3b7511c2001-05-26 13:15:44 +00004737 }else{
drh3aac2dd2004-04-26 14:10:20 +00004738 /* There are no pages on the freelist, so create a new page at the
4739 ** end of the file */
danielk197789d40042008-11-17 14:20:56 +00004740 int nPage = pagerPagecount(pBt);
danielk1977ad0132d2008-06-07 08:58:22 +00004741 *pPgno = nPage + 1;
danielk1977afcdd022004-10-31 16:25:42 +00004742
danielk1977bea2a942009-01-20 17:06:27 +00004743 if( *pPgno==PENDING_BYTE_PAGE(pBt) ){
4744 (*pPgno)++;
4745 }
4746
danielk1977afcdd022004-10-31 16:25:42 +00004747#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977266664d2006-02-10 08:24:21 +00004748 if( pBt->autoVacuum && PTRMAP_ISPAGE(pBt, *pPgno) ){
danielk1977afcdd022004-10-31 16:25:42 +00004749 /* If *pPgno refers to a pointer-map page, allocate two new pages
4750 ** at the end of the file instead of one. The first allocated page
4751 ** becomes a new pointer-map page, the second is used by the caller.
4752 */
danielk1977ac861692009-03-28 10:54:22 +00004753 MemPage *pPg = 0;
danielk1977afcdd022004-10-31 16:25:42 +00004754 TRACE(("ALLOCATE: %d from end of file (pointer-map page)\n", *pPgno));
danielk1977599fcba2004-11-08 07:13:13 +00004755 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
danielk197730548662009-07-09 05:07:37 +00004756 rc = btreeGetPage(pBt, *pPgno, &pPg, 0);
danielk1977ac861692009-03-28 10:54:22 +00004757 if( rc==SQLITE_OK ){
4758 rc = sqlite3PagerWrite(pPg->pDbPage);
4759 releasePage(pPg);
4760 }
4761 if( rc ) return rc;
danielk1977afcdd022004-10-31 16:25:42 +00004762 (*pPgno)++;
drh72190432008-01-31 14:54:43 +00004763 if( *pPgno==PENDING_BYTE_PAGE(pBt) ){ (*pPgno)++; }
danielk1977afcdd022004-10-31 16:25:42 +00004764 }
4765#endif
4766
danielk1977599fcba2004-11-08 07:13:13 +00004767 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
danielk197730548662009-07-09 05:07:37 +00004768 rc = btreeGetPage(pBt, *pPgno, ppPage, 0);
drh3b7511c2001-05-26 13:15:44 +00004769 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004770 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00004771 if( rc!=SQLITE_OK ){
4772 releasePage(*ppPage);
4773 }
drh3a4c1412004-05-09 20:40:11 +00004774 TRACE(("ALLOCATE: %d from end of file\n", *pPgno));
drh3b7511c2001-05-26 13:15:44 +00004775 }
danielk1977599fcba2004-11-08 07:13:13 +00004776
4777 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drhd3627af2006-12-18 18:34:51 +00004778
4779end_allocate_page:
4780 releasePage(pTrunk);
4781 releasePage(pPrevTrunk);
danielk1977b247c212008-11-21 09:09:01 +00004782 if( rc==SQLITE_OK ){
4783 if( sqlite3PagerPageRefcount((*ppPage)->pDbPage)>1 ){
4784 releasePage(*ppPage);
4785 return SQLITE_CORRUPT_BKPT;
4786 }
4787 (*ppPage)->isInit = 0;
danielk1977a50d9aa2009-06-08 14:49:45 +00004788 }else{
4789 *ppPage = 0;
danielk1977eaa06f62008-09-18 17:34:44 +00004790 }
drh3b7511c2001-05-26 13:15:44 +00004791 return rc;
4792}
4793
4794/*
danielk1977bea2a942009-01-20 17:06:27 +00004795** This function is used to add page iPage to the database file free-list.
4796** It is assumed that the page is not already a part of the free-list.
drh5e2f8b92001-05-28 00:41:15 +00004797**
danielk1977bea2a942009-01-20 17:06:27 +00004798** The value passed as the second argument to this function is optional.
4799** If the caller happens to have a pointer to the MemPage object
4800** corresponding to page iPage handy, it may pass it as the second value.
4801** Otherwise, it may pass NULL.
4802**
4803** If a pointer to a MemPage object is passed as the second argument,
4804** its reference count is not altered by this function.
drh3b7511c2001-05-26 13:15:44 +00004805*/
danielk1977bea2a942009-01-20 17:06:27 +00004806static int freePage2(BtShared *pBt, MemPage *pMemPage, Pgno iPage){
4807 MemPage *pTrunk = 0; /* Free-list trunk page */
4808 Pgno iTrunk = 0; /* Page number of free-list trunk page */
4809 MemPage *pPage1 = pBt->pPage1; /* Local reference to page 1 */
4810 MemPage *pPage; /* Page being freed. May be NULL. */
4811 int rc; /* Return Code */
4812 int nFree; /* Initial number of pages on free-list */
drh8b2f49b2001-06-08 00:21:52 +00004813
danielk1977bea2a942009-01-20 17:06:27 +00004814 assert( sqlite3_mutex_held(pBt->mutex) );
4815 assert( iPage>1 );
4816 assert( !pMemPage || pMemPage->pgno==iPage );
4817
4818 if( pMemPage ){
4819 pPage = pMemPage;
4820 sqlite3PagerRef(pPage->pDbPage);
4821 }else{
4822 pPage = btreePageLookup(pBt, iPage);
4823 }
drh3aac2dd2004-04-26 14:10:20 +00004824
drha34b6762004-05-07 13:30:42 +00004825 /* Increment the free page count on pPage1 */
danielk19773b8a05f2007-03-19 17:44:26 +00004826 rc = sqlite3PagerWrite(pPage1->pDbPage);
danielk1977bea2a942009-01-20 17:06:27 +00004827 if( rc ) goto freepage_out;
4828 nFree = get4byte(&pPage1->aData[36]);
4829 put4byte(&pPage1->aData[36], nFree+1);
drh3aac2dd2004-04-26 14:10:20 +00004830
drhfcce93f2006-02-22 03:08:32 +00004831#ifdef SQLITE_SECURE_DELETE
4832 /* If the SQLITE_SECURE_DELETE compile-time option is enabled, then
4833 ** always fully overwrite deleted information with zeros.
4834 */
danielk197730548662009-07-09 05:07:37 +00004835 if( (!pPage && (rc = btreeGetPage(pBt, iPage, &pPage, 0)))
danielk1977bea2a942009-01-20 17:06:27 +00004836 || (rc = sqlite3PagerWrite(pPage->pDbPage))
4837 ){
4838 goto freepage_out;
4839 }
drhfcce93f2006-02-22 03:08:32 +00004840 memset(pPage->aData, 0, pPage->pBt->pageSize);
4841#endif
4842
danielk1977687566d2004-11-02 12:56:41 +00004843 /* If the database supports auto-vacuum, write an entry in the pointer-map
danielk1977cb1a7eb2004-11-05 12:27:02 +00004844 ** to indicate that the page is free.
danielk1977687566d2004-11-02 12:56:41 +00004845 */
danielk197785d90ca2008-07-19 14:25:15 +00004846 if( ISAUTOVACUUM ){
danielk1977bea2a942009-01-20 17:06:27 +00004847 rc = ptrmapPut(pBt, iPage, PTRMAP_FREEPAGE, 0);
4848 if( rc ) goto freepage_out;
danielk1977687566d2004-11-02 12:56:41 +00004849 }
danielk1977687566d2004-11-02 12:56:41 +00004850
danielk1977bea2a942009-01-20 17:06:27 +00004851 /* Now manipulate the actual database free-list structure. There are two
4852 ** possibilities. If the free-list is currently empty, or if the first
4853 ** trunk page in the free-list is full, then this page will become a
4854 ** new free-list trunk page. Otherwise, it will become a leaf of the
4855 ** first trunk page in the current free-list. This block tests if it
4856 ** is possible to add the page as a new free-list leaf.
4857 */
4858 if( nFree!=0 ){
4859 int nLeaf; /* Initial number of leaf cells on trunk page */
4860
4861 iTrunk = get4byte(&pPage1->aData[32]);
danielk197730548662009-07-09 05:07:37 +00004862 rc = btreeGetPage(pBt, iTrunk, &pTrunk, 0);
danielk1977bea2a942009-01-20 17:06:27 +00004863 if( rc!=SQLITE_OK ){
4864 goto freepage_out;
4865 }
4866
4867 nLeaf = get4byte(&pTrunk->aData[4]);
4868 if( nLeaf<0 ){
4869 rc = SQLITE_CORRUPT_BKPT;
4870 goto freepage_out;
4871 }
4872 if( nLeaf<pBt->usableSize/4 - 8 ){
4873 /* In this case there is room on the trunk page to insert the page
4874 ** being freed as a new leaf.
drh45b1fac2008-07-04 17:52:42 +00004875 **
4876 ** Note that the trunk page is not really full until it contains
4877 ** usableSize/4 - 2 entries, not usableSize/4 - 8 entries as we have
4878 ** coded. But due to a coding error in versions of SQLite prior to
4879 ** 3.6.0, databases with freelist trunk pages holding more than
4880 ** usableSize/4 - 8 entries will be reported as corrupt. In order
4881 ** to maintain backwards compatibility with older versions of SQLite,
4882 ** we will contain to restrict the number of entries to usableSize/4 - 8
4883 ** for now. At some point in the future (once everyone has upgraded
4884 ** to 3.6.0 or later) we should consider fixing the conditional above
4885 ** to read "usableSize/4-2" instead of "usableSize/4-8".
4886 */
danielk19773b8a05f2007-03-19 17:44:26 +00004887 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhf5345442007-04-09 12:45:02 +00004888 if( rc==SQLITE_OK ){
danielk1977bea2a942009-01-20 17:06:27 +00004889 put4byte(&pTrunk->aData[4], nLeaf+1);
4890 put4byte(&pTrunk->aData[8+nLeaf*4], iPage);
drhfcce93f2006-02-22 03:08:32 +00004891#ifndef SQLITE_SECURE_DELETE
danielk1977bea2a942009-01-20 17:06:27 +00004892 if( pPage ){
4893 sqlite3PagerDontWrite(pPage->pDbPage);
4894 }
drhfcce93f2006-02-22 03:08:32 +00004895#endif
danielk1977bea2a942009-01-20 17:06:27 +00004896 rc = btreeSetHasContent(pBt, iPage);
drhf5345442007-04-09 12:45:02 +00004897 }
drh3a4c1412004-05-09 20:40:11 +00004898 TRACE(("FREE-PAGE: %d leaf on trunk page %d\n",pPage->pgno,pTrunk->pgno));
danielk1977bea2a942009-01-20 17:06:27 +00004899 goto freepage_out;
drh3aac2dd2004-04-26 14:10:20 +00004900 }
drh3b7511c2001-05-26 13:15:44 +00004901 }
danielk1977bea2a942009-01-20 17:06:27 +00004902
4903 /* If control flows to this point, then it was not possible to add the
4904 ** the page being freed as a leaf page of the first trunk in the free-list.
4905 ** Possibly because the free-list is empty, or possibly because the
4906 ** first trunk in the free-list is full. Either way, the page being freed
4907 ** will become the new first trunk page in the free-list.
4908 */
danielk197730548662009-07-09 05:07:37 +00004909 if( ((!pPage) && (0 != (rc = btreeGetPage(pBt, iPage, &pPage, 0))))
shane63207ab2009-02-04 01:49:30 +00004910 || (0 != (rc = sqlite3PagerWrite(pPage->pDbPage)))
danielk1977bea2a942009-01-20 17:06:27 +00004911 ){
4912 goto freepage_out;
4913 }
4914 put4byte(pPage->aData, iTrunk);
4915 put4byte(&pPage->aData[4], 0);
4916 put4byte(&pPage1->aData[32], iPage);
4917 TRACE(("FREE-PAGE: %d new trunk page replacing %d\n", pPage->pgno, iTrunk));
4918
4919freepage_out:
4920 if( pPage ){
4921 pPage->isInit = 0;
4922 }
4923 releasePage(pPage);
4924 releasePage(pTrunk);
drh3b7511c2001-05-26 13:15:44 +00004925 return rc;
4926}
danielk1977bea2a942009-01-20 17:06:27 +00004927static int freePage(MemPage *pPage){
4928 return freePage2(pPage->pBt, pPage, pPage->pgno);
4929}
drh3b7511c2001-05-26 13:15:44 +00004930
4931/*
drh3aac2dd2004-04-26 14:10:20 +00004932** Free any overflow pages associated with the given Cell.
drh3b7511c2001-05-26 13:15:44 +00004933*/
drh3aac2dd2004-04-26 14:10:20 +00004934static int clearCell(MemPage *pPage, unsigned char *pCell){
danielk1977aef0bf62005-12-30 16:28:01 +00004935 BtShared *pBt = pPage->pBt;
drh6f11bef2004-05-13 01:12:56 +00004936 CellInfo info;
drh3aac2dd2004-04-26 14:10:20 +00004937 Pgno ovflPgno;
drh6f11bef2004-05-13 01:12:56 +00004938 int rc;
drh94440812007-03-06 11:42:19 +00004939 int nOvfl;
shane63207ab2009-02-04 01:49:30 +00004940 u16 ovflPageSize;
drh3b7511c2001-05-26 13:15:44 +00004941
drh1fee73e2007-08-29 04:00:57 +00004942 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk197730548662009-07-09 05:07:37 +00004943 btreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00004944 if( info.iOverflow==0 ){
drha34b6762004-05-07 13:30:42 +00004945 return SQLITE_OK; /* No overflow pages. Return without doing anything */
drh3aac2dd2004-04-26 14:10:20 +00004946 }
drh6f11bef2004-05-13 01:12:56 +00004947 ovflPgno = get4byte(&pCell[info.iOverflow]);
shane63207ab2009-02-04 01:49:30 +00004948 assert( pBt->usableSize > 4 );
drh94440812007-03-06 11:42:19 +00004949 ovflPageSize = pBt->usableSize - 4;
drh72365832007-03-06 15:53:44 +00004950 nOvfl = (info.nPayload - info.nLocal + ovflPageSize - 1)/ovflPageSize;
4951 assert( ovflPgno==0 || nOvfl>0 );
4952 while( nOvfl-- ){
shane63207ab2009-02-04 01:49:30 +00004953 Pgno iNext = 0;
danielk1977bea2a942009-01-20 17:06:27 +00004954 MemPage *pOvfl = 0;
danielk1977e589a672009-04-11 16:06:15 +00004955 if( ovflPgno<2 || ovflPgno>pagerPagecount(pBt) ){
4956 /* 0 is not a legal page number and page 1 cannot be an
4957 ** overflow page. Therefore if ovflPgno<2 or past the end of the
4958 ** file the database must be corrupt. */
drh49285702005-09-17 15:20:26 +00004959 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00004960 }
danielk1977bea2a942009-01-20 17:06:27 +00004961 if( nOvfl ){
4962 rc = getOverflowPage(pBt, ovflPgno, &pOvfl, &iNext);
4963 if( rc ) return rc;
4964 }
4965 rc = freePage2(pBt, pOvfl, ovflPgno);
4966 if( pOvfl ){
4967 sqlite3PagerUnref(pOvfl->pDbPage);
4968 }
drh3b7511c2001-05-26 13:15:44 +00004969 if( rc ) return rc;
danielk1977bea2a942009-01-20 17:06:27 +00004970 ovflPgno = iNext;
drh3b7511c2001-05-26 13:15:44 +00004971 }
drh5e2f8b92001-05-28 00:41:15 +00004972 return SQLITE_OK;
drh3b7511c2001-05-26 13:15:44 +00004973}
4974
4975/*
drh91025292004-05-03 19:49:32 +00004976** Create the byte sequence used to represent a cell on page pPage
4977** and write that byte sequence into pCell[]. Overflow pages are
4978** allocated and filled in as necessary. The calling procedure
4979** is responsible for making sure sufficient space has been allocated
4980** for pCell[].
4981**
4982** Note that pCell does not necessary need to point to the pPage->aData
4983** area. pCell might point to some temporary storage. The cell will
4984** be constructed in this temporary area then copied into pPage->aData
4985** later.
drh3b7511c2001-05-26 13:15:44 +00004986*/
4987static int fillInCell(
drh3aac2dd2004-04-26 14:10:20 +00004988 MemPage *pPage, /* The page that contains the cell */
drh4b70f112004-05-02 21:12:19 +00004989 unsigned char *pCell, /* Complete text of the cell */
drh4a1c3802004-05-12 15:15:47 +00004990 const void *pKey, i64 nKey, /* The key */
drh4b70f112004-05-02 21:12:19 +00004991 const void *pData,int nData, /* The data */
drhb026e052007-05-02 01:34:31 +00004992 int nZero, /* Extra zero bytes to append to pData */
drh4b70f112004-05-02 21:12:19 +00004993 int *pnSize /* Write cell size here */
drh3b7511c2001-05-26 13:15:44 +00004994){
drh3b7511c2001-05-26 13:15:44 +00004995 int nPayload;
drh8c6fa9b2004-05-26 00:01:53 +00004996 const u8 *pSrc;
drha34b6762004-05-07 13:30:42 +00004997 int nSrc, n, rc;
drh3aac2dd2004-04-26 14:10:20 +00004998 int spaceLeft;
4999 MemPage *pOvfl = 0;
drh9b171272004-05-08 02:03:22 +00005000 MemPage *pToRelease = 0;
drh3aac2dd2004-04-26 14:10:20 +00005001 unsigned char *pPrior;
5002 unsigned char *pPayload;
danielk1977aef0bf62005-12-30 16:28:01 +00005003 BtShared *pBt = pPage->pBt;
drh3aac2dd2004-04-26 14:10:20 +00005004 Pgno pgnoOvfl = 0;
drh4b70f112004-05-02 21:12:19 +00005005 int nHeader;
drh6f11bef2004-05-13 01:12:56 +00005006 CellInfo info;
drh3b7511c2001-05-26 13:15:44 +00005007
drh1fee73e2007-08-29 04:00:57 +00005008 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00005009
drhc5053fb2008-11-27 02:22:10 +00005010 /* pPage is not necessarily writeable since pCell might be auxiliary
5011 ** buffer space that is separate from the pPage buffer area */
5012 assert( pCell<pPage->aData || pCell>=&pPage->aData[pBt->pageSize]
5013 || sqlite3PagerIswriteable(pPage->pDbPage) );
5014
drh91025292004-05-03 19:49:32 +00005015 /* Fill in the header. */
drh43605152004-05-29 21:46:49 +00005016 nHeader = 0;
drh91025292004-05-03 19:49:32 +00005017 if( !pPage->leaf ){
5018 nHeader += 4;
5019 }
drh8b18dd42004-05-12 19:18:15 +00005020 if( pPage->hasData ){
drhb026e052007-05-02 01:34:31 +00005021 nHeader += putVarint(&pCell[nHeader], nData+nZero);
drh6f11bef2004-05-13 01:12:56 +00005022 }else{
drhb026e052007-05-02 01:34:31 +00005023 nData = nZero = 0;
drh91025292004-05-03 19:49:32 +00005024 }
drh6f11bef2004-05-13 01:12:56 +00005025 nHeader += putVarint(&pCell[nHeader], *(u64*)&nKey);
danielk197730548662009-07-09 05:07:37 +00005026 btreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00005027 assert( info.nHeader==nHeader );
5028 assert( info.nKey==nKey );
danielk197789d40042008-11-17 14:20:56 +00005029 assert( info.nData==(u32)(nData+nZero) );
drh6f11bef2004-05-13 01:12:56 +00005030
5031 /* Fill in the payload */
drhb026e052007-05-02 01:34:31 +00005032 nPayload = nData + nZero;
drh3aac2dd2004-04-26 14:10:20 +00005033 if( pPage->intKey ){
5034 pSrc = pData;
5035 nSrc = nData;
drh91025292004-05-03 19:49:32 +00005036 nData = 0;
drhf49661a2008-12-10 16:45:50 +00005037 }else{
drh20abac22009-01-28 20:21:17 +00005038 if( nKey>0x7fffffff || pKey==0 ){
5039 return SQLITE_CORRUPT;
5040 }
drhf49661a2008-12-10 16:45:50 +00005041 nPayload += (int)nKey;
drh3aac2dd2004-04-26 14:10:20 +00005042 pSrc = pKey;
drhf49661a2008-12-10 16:45:50 +00005043 nSrc = (int)nKey;
drh3aac2dd2004-04-26 14:10:20 +00005044 }
drh6f11bef2004-05-13 01:12:56 +00005045 *pnSize = info.nSize;
5046 spaceLeft = info.nLocal;
drh3aac2dd2004-04-26 14:10:20 +00005047 pPayload = &pCell[nHeader];
drh6f11bef2004-05-13 01:12:56 +00005048 pPrior = &pCell[info.iOverflow];
drh3b7511c2001-05-26 13:15:44 +00005049
drh3b7511c2001-05-26 13:15:44 +00005050 while( nPayload>0 ){
5051 if( spaceLeft==0 ){
danielk1977afcdd022004-10-31 16:25:42 +00005052#ifndef SQLITE_OMIT_AUTOVACUUM
5053 Pgno pgnoPtrmap = pgnoOvfl; /* Overflow page pointer-map entry page */
danielk1977b39f70b2007-05-17 18:28:11 +00005054 if( pBt->autoVacuum ){
5055 do{
5056 pgnoOvfl++;
5057 } while(
5058 PTRMAP_ISPAGE(pBt, pgnoOvfl) || pgnoOvfl==PENDING_BYTE_PAGE(pBt)
5059 );
danielk1977b39f70b2007-05-17 18:28:11 +00005060 }
danielk1977afcdd022004-10-31 16:25:42 +00005061#endif
drhf49661a2008-12-10 16:45:50 +00005062 rc = allocateBtreePage(pBt, &pOvfl, &pgnoOvfl, pgnoOvfl, 0);
danielk1977afcdd022004-10-31 16:25:42 +00005063#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977a19df672004-11-03 11:37:07 +00005064 /* If the database supports auto-vacuum, and the second or subsequent
5065 ** overflow page is being allocated, add an entry to the pointer-map
danielk19774ef24492007-05-23 09:52:41 +00005066 ** for that page now.
5067 **
5068 ** If this is the first overflow page, then write a partial entry
5069 ** to the pointer-map. If we write nothing to this pointer-map slot,
5070 ** then the optimistic overflow chain processing in clearCell()
5071 ** may misinterpret the uninitialised values and delete the
5072 ** wrong pages from the database.
danielk1977afcdd022004-10-31 16:25:42 +00005073 */
danielk19774ef24492007-05-23 09:52:41 +00005074 if( pBt->autoVacuum && rc==SQLITE_OK ){
5075 u8 eType = (pgnoPtrmap?PTRMAP_OVERFLOW2:PTRMAP_OVERFLOW1);
5076 rc = ptrmapPut(pBt, pgnoOvfl, eType, pgnoPtrmap);
danielk197789a4be82007-05-23 13:34:32 +00005077 if( rc ){
5078 releasePage(pOvfl);
5079 }
danielk1977afcdd022004-10-31 16:25:42 +00005080 }
5081#endif
drh3b7511c2001-05-26 13:15:44 +00005082 if( rc ){
drh9b171272004-05-08 02:03:22 +00005083 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00005084 return rc;
5085 }
drhc5053fb2008-11-27 02:22:10 +00005086
5087 /* If pToRelease is not zero than pPrior points into the data area
5088 ** of pToRelease. Make sure pToRelease is still writeable. */
5089 assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
5090
5091 /* If pPrior is part of the data area of pPage, then make sure pPage
5092 ** is still writeable */
5093 assert( pPrior<pPage->aData || pPrior>=&pPage->aData[pBt->pageSize]
5094 || sqlite3PagerIswriteable(pPage->pDbPage) );
5095
drh3aac2dd2004-04-26 14:10:20 +00005096 put4byte(pPrior, pgnoOvfl);
drh9b171272004-05-08 02:03:22 +00005097 releasePage(pToRelease);
5098 pToRelease = pOvfl;
drh3aac2dd2004-04-26 14:10:20 +00005099 pPrior = pOvfl->aData;
5100 put4byte(pPrior, 0);
5101 pPayload = &pOvfl->aData[4];
drhb6f41482004-05-14 01:58:11 +00005102 spaceLeft = pBt->usableSize - 4;
drh3b7511c2001-05-26 13:15:44 +00005103 }
5104 n = nPayload;
5105 if( n>spaceLeft ) n = spaceLeft;
drhc5053fb2008-11-27 02:22:10 +00005106
5107 /* If pToRelease is not zero than pPayload points into the data area
5108 ** of pToRelease. Make sure pToRelease is still writeable. */
5109 assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
5110
5111 /* If pPayload is part of the data area of pPage, then make sure pPage
5112 ** is still writeable */
5113 assert( pPayload<pPage->aData || pPayload>=&pPage->aData[pBt->pageSize]
5114 || sqlite3PagerIswriteable(pPage->pDbPage) );
5115
drhb026e052007-05-02 01:34:31 +00005116 if( nSrc>0 ){
5117 if( n>nSrc ) n = nSrc;
5118 assert( pSrc );
5119 memcpy(pPayload, pSrc, n);
5120 }else{
5121 memset(pPayload, 0, n);
5122 }
drh3b7511c2001-05-26 13:15:44 +00005123 nPayload -= n;
drhde647132004-05-07 17:57:49 +00005124 pPayload += n;
drh9b171272004-05-08 02:03:22 +00005125 pSrc += n;
drh3aac2dd2004-04-26 14:10:20 +00005126 nSrc -= n;
drh3b7511c2001-05-26 13:15:44 +00005127 spaceLeft -= n;
drh3aac2dd2004-04-26 14:10:20 +00005128 if( nSrc==0 ){
5129 nSrc = nData;
5130 pSrc = pData;
5131 }
drhdd793422001-06-28 01:54:48 +00005132 }
drh9b171272004-05-08 02:03:22 +00005133 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00005134 return SQLITE_OK;
5135}
5136
drh14acc042001-06-10 19:56:58 +00005137/*
5138** Remove the i-th cell from pPage. This routine effects pPage only.
5139** The cell content is not freed or deallocated. It is assumed that
5140** the cell content has been copied someplace else. This routine just
5141** removes the reference to the cell from pPage.
5142**
5143** "sz" must be the number of bytes in the cell.
drh14acc042001-06-10 19:56:58 +00005144*/
shane0af3f892008-11-12 04:55:34 +00005145static int dropCell(MemPage *pPage, int idx, int sz){
drh43605152004-05-29 21:46:49 +00005146 int i; /* Loop counter */
5147 int pc; /* Offset to cell content of cell being deleted */
5148 u8 *data; /* pPage->aData */
5149 u8 *ptr; /* Used to move bytes around within data[] */
shanedcc50b72008-11-13 18:29:50 +00005150 int rc; /* The return code */
drh43605152004-05-29 21:46:49 +00005151
drh8c42ca92001-06-22 19:15:00 +00005152 assert( idx>=0 && idx<pPage->nCell );
drh43605152004-05-29 21:46:49 +00005153 assert( sz==cellSize(pPage, idx) );
danielk19773b8a05f2007-03-19 17:44:26 +00005154 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00005155 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhda200cc2004-05-09 11:51:38 +00005156 data = pPage->aData;
drh43605152004-05-29 21:46:49 +00005157 ptr = &data[pPage->cellOffset + 2*idx];
shane0af3f892008-11-12 04:55:34 +00005158 pc = get2byte(ptr);
drhc5053fb2008-11-27 02:22:10 +00005159 if( (pc<pPage->hdrOffset+6+(pPage->leaf?0:4))
5160 || (pc+sz>pPage->pBt->usableSize) ){
shane0af3f892008-11-12 04:55:34 +00005161 return SQLITE_CORRUPT_BKPT;
5162 }
shanedcc50b72008-11-13 18:29:50 +00005163 rc = freeSpace(pPage, pc, sz);
5164 if( rc!=SQLITE_OK ){
5165 return rc;
5166 }
drh43605152004-05-29 21:46:49 +00005167 for(i=idx+1; i<pPage->nCell; i++, ptr+=2){
5168 ptr[0] = ptr[2];
5169 ptr[1] = ptr[3];
drh14acc042001-06-10 19:56:58 +00005170 }
5171 pPage->nCell--;
drh43605152004-05-29 21:46:49 +00005172 put2byte(&data[pPage->hdrOffset+3], pPage->nCell);
5173 pPage->nFree += 2;
shane0af3f892008-11-12 04:55:34 +00005174 return SQLITE_OK;
drh14acc042001-06-10 19:56:58 +00005175}
5176
5177/*
5178** Insert a new cell on pPage at cell index "i". pCell points to the
5179** content of the cell.
5180**
5181** If the cell content will fit on the page, then put it there. If it
drh43605152004-05-29 21:46:49 +00005182** will not fit, then make a copy of the cell content into pTemp if
5183** pTemp is not null. Regardless of pTemp, allocate a new entry
5184** in pPage->aOvfl[] and make it point to the cell content (either
5185** in pTemp or the original pCell) and also record its index.
5186** Allocating a new entry in pPage->aCell[] implies that
5187** pPage->nOverflow is incremented.
danielk1977a3ad5e72005-01-07 08:56:44 +00005188**
5189** If nSkip is non-zero, then do not copy the first nSkip bytes of the
5190** cell. The caller will overwrite them after this function returns. If
drh4b238df2005-01-08 15:43:18 +00005191** nSkip is non-zero, then pCell may not point to an invalid memory location
danielk1977a3ad5e72005-01-07 08:56:44 +00005192** (but pCell+nSkip is always valid).
drh14acc042001-06-10 19:56:58 +00005193*/
danielk1977e80463b2004-11-03 03:01:16 +00005194static int insertCell(
drh24cd67e2004-05-10 16:18:47 +00005195 MemPage *pPage, /* Page into which we are copying */
drh43605152004-05-29 21:46:49 +00005196 int i, /* New cell becomes the i-th cell of the page */
5197 u8 *pCell, /* Content of the new cell */
5198 int sz, /* Bytes of content in pCell */
danielk1977a3ad5e72005-01-07 08:56:44 +00005199 u8 *pTemp, /* Temp storage space for pCell, if needed */
danielk19774dbaa892009-06-16 16:50:22 +00005200 Pgno iChild /* If non-zero, replace first 4 bytes with this value */
drh24cd67e2004-05-10 16:18:47 +00005201){
drh43605152004-05-29 21:46:49 +00005202 int idx; /* Where to write new cell content in data[] */
5203 int j; /* Loop counter */
drh43605152004-05-29 21:46:49 +00005204 int end; /* First byte past the last cell pointer in data[] */
5205 int ins; /* Index in data[] where new cell pointer is inserted */
drh43605152004-05-29 21:46:49 +00005206 int cellOffset; /* Address of first cell pointer in data[] */
5207 u8 *data; /* The content of the whole page */
5208 u8 *ptr; /* Used for moving information around in data[] */
5209
danielk19774dbaa892009-06-16 16:50:22 +00005210 int nSkip = (iChild ? 4 : 0);
5211
drh43605152004-05-29 21:46:49 +00005212 assert( i>=0 && i<=pPage->nCell+pPage->nOverflow );
drhf49661a2008-12-10 16:45:50 +00005213 assert( pPage->nCell<=MX_CELL(pPage->pBt) && MX_CELL(pPage->pBt)<=5460 );
5214 assert( pPage->nOverflow<=ArraySize(pPage->aOvfl) );
drh43605152004-05-29 21:46:49 +00005215 assert( sz==cellSizePtr(pPage, pCell) );
drh1fee73e2007-08-29 04:00:57 +00005216 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh43605152004-05-29 21:46:49 +00005217 if( pPage->nOverflow || sz+2>pPage->nFree ){
drh24cd67e2004-05-10 16:18:47 +00005218 if( pTemp ){
danielk1977a3ad5e72005-01-07 08:56:44 +00005219 memcpy(pTemp+nSkip, pCell+nSkip, sz-nSkip);
drh43605152004-05-29 21:46:49 +00005220 pCell = pTemp;
drh24cd67e2004-05-10 16:18:47 +00005221 }
danielk19774dbaa892009-06-16 16:50:22 +00005222 if( iChild ){
5223 put4byte(pCell, iChild);
5224 }
drh43605152004-05-29 21:46:49 +00005225 j = pPage->nOverflow++;
danielk197789d40042008-11-17 14:20:56 +00005226 assert( j<(int)(sizeof(pPage->aOvfl)/sizeof(pPage->aOvfl[0])) );
drh43605152004-05-29 21:46:49 +00005227 pPage->aOvfl[j].pCell = pCell;
drhf49661a2008-12-10 16:45:50 +00005228 pPage->aOvfl[j].idx = (u16)i;
drh14acc042001-06-10 19:56:58 +00005229 }else{
danielk19776e465eb2007-08-21 13:11:00 +00005230 int rc = sqlite3PagerWrite(pPage->pDbPage);
5231 if( rc!=SQLITE_OK ){
5232 return rc;
5233 }
5234 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh43605152004-05-29 21:46:49 +00005235 data = pPage->aData;
drh43605152004-05-29 21:46:49 +00005236 cellOffset = pPage->cellOffset;
drh0a45c272009-07-08 01:49:11 +00005237 end = cellOffset + 2*pPage->nCell;
drh43605152004-05-29 21:46:49 +00005238 ins = cellOffset + 2*i;
drh0a45c272009-07-08 01:49:11 +00005239 rc = allocateSpace(pPage, sz, &idx);
5240 if( rc ) return rc;
5241 assert( idx>=end+2 );
5242 if( idx+sz > pPage->pBt->usableSize ){
shane34ac18d2008-11-11 22:18:20 +00005243 return SQLITE_CORRUPT_BKPT;
shane0af3f892008-11-12 04:55:34 +00005244 }
drh43605152004-05-29 21:46:49 +00005245 pPage->nCell++;
drh0a45c272009-07-08 01:49:11 +00005246 pPage->nFree -= (u16)(2 + sz);
danielk1977a3ad5e72005-01-07 08:56:44 +00005247 memcpy(&data[idx+nSkip], pCell+nSkip, sz-nSkip);
danielk19774dbaa892009-06-16 16:50:22 +00005248 if( iChild ){
5249 put4byte(&data[idx], iChild);
5250 }
drh0a45c272009-07-08 01:49:11 +00005251 for(j=end, ptr=&data[j]; j>ins; j-=2, ptr-=2){
drh43605152004-05-29 21:46:49 +00005252 ptr[0] = ptr[-2];
5253 ptr[1] = ptr[-1];
drhda200cc2004-05-09 11:51:38 +00005254 }
drh43605152004-05-29 21:46:49 +00005255 put2byte(&data[ins], idx);
drh0a45c272009-07-08 01:49:11 +00005256 put2byte(&data[pPage->hdrOffset+3], pPage->nCell);
danielk1977a19df672004-11-03 11:37:07 +00005257#ifndef SQLITE_OMIT_AUTOVACUUM
5258 if( pPage->pBt->autoVacuum ){
5259 /* The cell may contain a pointer to an overflow page. If so, write
5260 ** the entry for the overflow page into the pointer map.
5261 */
danielk197746aa38f2009-06-25 16:11:05 +00005262 return ptrmapPutOvflPtr(pPage, pCell);
danielk1977a19df672004-11-03 11:37:07 +00005263 }
5264#endif
drh14acc042001-06-10 19:56:58 +00005265 }
danielk1977e80463b2004-11-03 03:01:16 +00005266
danielk1977e80463b2004-11-03 03:01:16 +00005267 return SQLITE_OK;
drh14acc042001-06-10 19:56:58 +00005268}
5269
5270/*
drhfa1a98a2004-05-14 19:08:17 +00005271** Add a list of cells to a page. The page should be initially empty.
5272** The cells are guaranteed to fit on the page.
5273*/
5274static void assemblePage(
5275 MemPage *pPage, /* The page to be assemblied */
5276 int nCell, /* The number of cells to add to this page */
drh43605152004-05-29 21:46:49 +00005277 u8 **apCell, /* Pointers to cell bodies */
drha9121e42008-02-19 14:59:35 +00005278 u16 *aSize /* Sizes of the cells */
drhfa1a98a2004-05-14 19:08:17 +00005279){
5280 int i; /* Loop counter */
danielk1977fad91942009-04-29 17:49:59 +00005281 u8 *pCellptr; /* Address of next cell pointer */
drh43605152004-05-29 21:46:49 +00005282 int cellbody; /* Address of next cell body */
danielk1977fad91942009-04-29 17:49:59 +00005283 u8 * const data = pPage->aData; /* Pointer to data for pPage */
5284 const int hdr = pPage->hdrOffset; /* Offset of header on pPage */
5285 const int nUsable = pPage->pBt->usableSize; /* Usable size of page */
drhfa1a98a2004-05-14 19:08:17 +00005286
drh43605152004-05-29 21:46:49 +00005287 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +00005288 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhf49661a2008-12-10 16:45:50 +00005289 assert( nCell>=0 && nCell<=MX_CELL(pPage->pBt) && MX_CELL(pPage->pBt)<=5460 );
drhc5053fb2008-11-27 02:22:10 +00005290 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
danielk1977fad91942009-04-29 17:49:59 +00005291
5292 /* Check that the page has just been zeroed by zeroPage() */
5293 assert( pPage->nCell==0 );
5294 assert( get2byte(&data[hdr+5])==nUsable );
5295
5296 pCellptr = &data[pPage->cellOffset + nCell*2];
5297 cellbody = nUsable;
5298 for(i=nCell-1; i>=0; i--){
5299 pCellptr -= 2;
5300 cellbody -= aSize[i];
5301 put2byte(pCellptr, cellbody);
5302 memcpy(&data[cellbody], apCell[i], aSize[i]);
drhfa1a98a2004-05-14 19:08:17 +00005303 }
danielk1977fad91942009-04-29 17:49:59 +00005304 put2byte(&data[hdr+3], nCell);
5305 put2byte(&data[hdr+5], cellbody);
5306 pPage->nFree -= (nCell*2 + nUsable - cellbody);
drhf49661a2008-12-10 16:45:50 +00005307 pPage->nCell = (u16)nCell;
drhfa1a98a2004-05-14 19:08:17 +00005308}
5309
drh14acc042001-06-10 19:56:58 +00005310/*
drhc3b70572003-01-04 19:44:07 +00005311** The following parameters determine how many adjacent pages get involved
5312** in a balancing operation. NN is the number of neighbors on either side
5313** of the page that participate in the balancing operation. NB is the
5314** total number of pages that participate, including the target page and
5315** NN neighbors on either side.
5316**
5317** The minimum value of NN is 1 (of course). Increasing NN above 1
5318** (to 2 or 3) gives a modest improvement in SELECT and DELETE performance
5319** in exchange for a larger degradation in INSERT and UPDATE performance.
5320** The value of NN appears to give the best results overall.
5321*/
5322#define NN 1 /* Number of neighbors on either side of pPage */
5323#define NB (NN*2+1) /* Total pages involved in the balance */
5324
danielk1977ac245ec2005-01-14 13:50:11 +00005325
drh615ae552005-01-16 23:21:00 +00005326#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00005327/*
5328** This version of balance() handles the common special case where
5329** a new entry is being inserted on the extreme right-end of the
5330** tree, in other words, when the new entry will become the largest
5331** entry in the tree.
5332**
5333** Instead of trying balance the 3 right-most leaf pages, just add
5334** a new page to the right-hand side and put the one new entry in
5335** that page. This leaves the right side of the tree somewhat
5336** unbalanced. But odds are that we will be inserting new entries
5337** at the end soon afterwards so the nearly empty page will quickly
5338** fill up. On average.
5339**
5340** pPage is the leaf page which is the right-most page in the tree.
5341** pParent is its parent. pPage must have a single overflow entry
5342** which is also the right-most entry on the page.
danielk1977a50d9aa2009-06-08 14:49:45 +00005343**
5344** The pSpace buffer is used to store a temporary copy of the divider
5345** cell that will be inserted into pParent. Such a cell consists of a 4
5346** byte page number followed by a variable length integer. In other
5347** words, at most 13 bytes. Hence the pSpace buffer must be at
5348** least 13 bytes in size.
drhf222e712005-01-14 22:55:49 +00005349*/
danielk1977a50d9aa2009-06-08 14:49:45 +00005350static int balance_quick(MemPage *pParent, MemPage *pPage, u8 *pSpace){
5351 BtShared *const pBt = pPage->pBt; /* B-Tree Database */
danielk19774dbaa892009-06-16 16:50:22 +00005352 MemPage *pNew; /* Newly allocated page */
danielk19776f235cc2009-06-04 14:46:08 +00005353 int rc; /* Return Code */
5354 Pgno pgnoNew; /* Page number of pNew */
danielk1977ac245ec2005-01-14 13:50:11 +00005355
drh1fee73e2007-08-29 04:00:57 +00005356 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk1977a50d9aa2009-06-08 14:49:45 +00005357 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk1977e56b60e2009-06-10 09:11:06 +00005358 assert( pPage->nOverflow==1 );
5359
drhd46b6c22009-06-04 17:02:51 +00005360 if( pPage->nCell<=0 ) return SQLITE_CORRUPT_BKPT;
drhd677b3d2007-08-20 22:48:41 +00005361
danielk1977a50d9aa2009-06-08 14:49:45 +00005362 /* Allocate a new page. This page will become the right-sibling of
5363 ** pPage. Make the parent page writable, so that the new divider cell
5364 ** may be inserted. If both these operations are successful, proceed.
5365 */
drh4f0c5872007-03-26 22:05:01 +00005366 rc = allocateBtreePage(pBt, &pNew, &pgnoNew, 0, 0);
danielk19774dbaa892009-06-16 16:50:22 +00005367
danielk1977eaa06f62008-09-18 17:34:44 +00005368 if( rc==SQLITE_OK ){
danielk1977a50d9aa2009-06-08 14:49:45 +00005369
5370 u8 *pOut = &pSpace[4];
danielk19776f235cc2009-06-04 14:46:08 +00005371 u8 *pCell = pPage->aOvfl[0].pCell;
5372 u16 szCell = cellSizePtr(pPage, pCell);
5373 u8 *pStop;
5374
drhc5053fb2008-11-27 02:22:10 +00005375 assert( sqlite3PagerIswriteable(pNew->pDbPage) );
danielk1977e56b60e2009-06-10 09:11:06 +00005376 assert( pPage->aData[0]==(PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF) );
5377 zeroPage(pNew, PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF);
danielk1977eaa06f62008-09-18 17:34:44 +00005378 assemblePage(pNew, 1, &pCell, &szCell);
danielk19774dbaa892009-06-16 16:50:22 +00005379
5380 /* If this is an auto-vacuum database, update the pointer map
5381 ** with entries for the new page, and any pointer from the
5382 ** cell on the page to an overflow page. If either of these
5383 ** operations fails, the return code is set, but the contents
5384 ** of the parent page are still manipulated by thh code below.
5385 ** That is Ok, at this point the parent page is guaranteed to
5386 ** be marked as dirty. Returning an error code will cause a
5387 ** rollback, undoing any changes made to the parent page.
5388 */
5389 if( ISAUTOVACUUM ){
5390 rc = ptrmapPut(pBt, pgnoNew, PTRMAP_BTREE, pParent->pgno);
5391 if( szCell>pNew->minLocal && rc==SQLITE_OK ){
5392 rc = ptrmapPutOvflPtr(pNew, pCell);
5393 }
5394 }
danielk1977eaa06f62008-09-18 17:34:44 +00005395
danielk19776f235cc2009-06-04 14:46:08 +00005396 /* Create a divider cell to insert into pParent. The divider cell
5397 ** consists of a 4-byte page number (the page number of pPage) and
5398 ** a variable length key value (which must be the same value as the
5399 ** largest key on pPage).
danielk1977eaa06f62008-09-18 17:34:44 +00005400 **
danielk19776f235cc2009-06-04 14:46:08 +00005401 ** To find the largest key value on pPage, first find the right-most
5402 ** cell on pPage. The first two fields of this cell are the
5403 ** record-length (a variable length integer at most 32-bits in size)
5404 ** and the key value (a variable length integer, may have any value).
5405 ** The first of the while(...) loops below skips over the record-length
5406 ** field. The second while(...) loop copies the key value from the
danielk1977a50d9aa2009-06-08 14:49:45 +00005407 ** cell on pPage into the pSpace buffer.
danielk1977eaa06f62008-09-18 17:34:44 +00005408 */
danielk1977eaa06f62008-09-18 17:34:44 +00005409 pCell = findCell(pPage, pPage->nCell-1);
danielk19776f235cc2009-06-04 14:46:08 +00005410 pStop = &pCell[9];
5411 while( (*(pCell++)&0x80) && pCell<pStop );
5412 pStop = &pCell[9];
5413 while( ((*(pOut++) = *(pCell++))&0x80) && pCell<pStop );
5414
danielk19774dbaa892009-06-16 16:50:22 +00005415 /* Insert the new divider cell into pParent. */
5416 insertCell(pParent,pParent->nCell,pSpace,(int)(pOut-pSpace),0,pPage->pgno);
danielk19776f235cc2009-06-04 14:46:08 +00005417
5418 /* Set the right-child pointer of pParent to point to the new page. */
danielk1977eaa06f62008-09-18 17:34:44 +00005419 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew);
5420
danielk1977e08a3c42008-09-18 18:17:03 +00005421 /* Release the reference to the new page. */
5422 releasePage(pNew);
danielk1977ac11ee62005-01-15 12:45:51 +00005423 }
5424
danielk1977eaa06f62008-09-18 17:34:44 +00005425 return rc;
danielk1977ac245ec2005-01-14 13:50:11 +00005426}
drh615ae552005-01-16 23:21:00 +00005427#endif /* SQLITE_OMIT_QUICKBALANCE */
drh43605152004-05-29 21:46:49 +00005428
danielk19774dbaa892009-06-16 16:50:22 +00005429#if 0
drhc3b70572003-01-04 19:44:07 +00005430/*
danielk19774dbaa892009-06-16 16:50:22 +00005431** This function does not contribute anything to the operation of SQLite.
5432** it is sometimes activated temporarily while debugging code responsible
5433** for setting pointer-map entries.
5434*/
5435static int ptrmapCheckPages(MemPage **apPage, int nPage){
5436 int i, j;
5437 for(i=0; i<nPage; i++){
5438 Pgno n;
5439 u8 e;
5440 MemPage *pPage = apPage[i];
5441 BtShared *pBt = pPage->pBt;
5442 assert( pPage->isInit );
5443
5444 for(j=0; j<pPage->nCell; j++){
5445 CellInfo info;
5446 u8 *z;
5447
5448 z = findCell(pPage, j);
danielk197730548662009-07-09 05:07:37 +00005449 btreeParseCellPtr(pPage, z, &info);
danielk19774dbaa892009-06-16 16:50:22 +00005450 if( info.iOverflow ){
5451 Pgno ovfl = get4byte(&z[info.iOverflow]);
5452 ptrmapGet(pBt, ovfl, &e, &n);
5453 assert( n==pPage->pgno && e==PTRMAP_OVERFLOW1 );
5454 }
5455 if( !pPage->leaf ){
5456 Pgno child = get4byte(z);
5457 ptrmapGet(pBt, child, &e, &n);
5458 assert( n==pPage->pgno && e==PTRMAP_BTREE );
5459 }
5460 }
5461 if( !pPage->leaf ){
5462 Pgno child = get4byte(&pPage->aData[pPage->hdrOffset+8]);
5463 ptrmapGet(pBt, child, &e, &n);
5464 assert( n==pPage->pgno && e==PTRMAP_BTREE );
5465 }
5466 }
5467 return 1;
5468}
5469#endif
5470
danielk1977cd581a72009-06-23 15:43:39 +00005471/*
5472** This function is used to copy the contents of the b-tree node stored
5473** on page pFrom to page pTo. If page pFrom was not a leaf page, then
5474** the pointer-map entries for each child page are updated so that the
5475** parent page stored in the pointer map is page pTo. If pFrom contained
5476** any cells with overflow page pointers, then the corresponding pointer
5477** map entries are also updated so that the parent page is page pTo.
5478**
5479** If pFrom is currently carrying any overflow cells (entries in the
5480** MemPage.aOvfl[] array), they are not copied to pTo.
5481**
danielk197730548662009-07-09 05:07:37 +00005482** Before returning, page pTo is reinitialized using btreeInitPage().
danielk1977cd581a72009-06-23 15:43:39 +00005483**
5484** The performance of this function is not critical. It is only used by
5485** the balance_shallower() and balance_deeper() procedures, neither of
5486** which are called often under normal circumstances.
5487*/
5488static int copyNodeContent(MemPage *pFrom, MemPage *pTo){
5489 BtShared * const pBt = pFrom->pBt;
5490 u8 * const aFrom = pFrom->aData;
5491 u8 * const aTo = pTo->aData;
5492 int const iFromHdr = pFrom->hdrOffset;
5493 int const iToHdr = ((pTo->pgno==1) ? 100 : 0);
5494 int rc = SQLITE_OK;
5495 int iData;
5496
5497 assert( pFrom->isInit );
5498 assert( pFrom->nFree>=iToHdr );
5499 assert( get2byte(&aFrom[iFromHdr+5])<=pBt->usableSize );
5500
5501 /* Copy the b-tree node content from page pFrom to page pTo. */
5502 iData = get2byte(&aFrom[iFromHdr+5]);
5503 memcpy(&aTo[iData], &aFrom[iData], pBt->usableSize-iData);
5504 memcpy(&aTo[iToHdr], &aFrom[iFromHdr], pFrom->cellOffset + 2*pFrom->nCell);
5505
5506 /* Reinitialize page pTo so that the contents of the MemPage structure
5507 ** match the new data. The initialization of pTo "cannot" fail, as the
5508 ** data copied from pFrom is known to be valid. */
5509 pTo->isInit = 0;
danielk197730548662009-07-09 05:07:37 +00005510 TESTONLY(rc = ) btreeInitPage(pTo);
danielk1977cd581a72009-06-23 15:43:39 +00005511 assert( rc==SQLITE_OK );
5512
5513 /* If this is an auto-vacuum database, update the pointer-map entries
5514 ** for any b-tree or overflow pages that pTo now contains the pointers to. */
5515 if( ISAUTOVACUUM ){
5516 rc = setChildPtrmaps(pTo);
5517 }
5518 return rc;
5519}
5520
5521/*
danielk19774dbaa892009-06-16 16:50:22 +00005522** This routine redistributes cells on the iParentIdx'th child of pParent
5523** (hereafter "the page") and up to 2 siblings so that all pages have about the
5524** same amount of free space. Usually a single sibling on either side of the
5525** page are used in the balancing, though both siblings might come from one
5526** side if the page is the first or last child of its parent. If the page
5527** has fewer than 2 siblings (something which can only happen if the page
5528** is a root page or a child of a root page) then all available siblings
5529** participate in the balancing.
drh8b2f49b2001-06-08 00:21:52 +00005530**
danielk19774dbaa892009-06-16 16:50:22 +00005531** The number of siblings of the page might be increased or decreased by
5532** one or two in an effort to keep pages nearly full but not over full.
drh14acc042001-06-10 19:56:58 +00005533**
danielk19774dbaa892009-06-16 16:50:22 +00005534** Note that when this routine is called, some of the cells on the page
5535** might not actually be stored in MemPage.aData[]. This can happen
5536** if the page is overfull. This routine ensures that all cells allocated
5537** to the page and its siblings fit into MemPage.aData[] before returning.
drh14acc042001-06-10 19:56:58 +00005538**
danielk19774dbaa892009-06-16 16:50:22 +00005539** In the course of balancing the page and its siblings, cells may be
5540** inserted into or removed from the parent page (pParent). Doing so
5541** may cause the parent page to become overfull or underfull. If this
5542** happens, it is the responsibility of the caller to invoke the correct
5543** balancing routine to fix this problem (see the balance() routine).
drh8c42ca92001-06-22 19:15:00 +00005544**
drh5e00f6c2001-09-13 13:46:56 +00005545** If this routine fails for any reason, it might leave the database
danielk19776067a9b2009-06-09 09:41:00 +00005546** in a corrupted state. So if this routine fails, the database should
drh5e00f6c2001-09-13 13:46:56 +00005547** be rolled back.
danielk19774dbaa892009-06-16 16:50:22 +00005548**
5549** The third argument to this function, aOvflSpace, is a pointer to a
5550** buffer page-size bytes in size. If, in inserting cells into the parent
5551** page (pParent), the parent page becomes overfull, this buffer is
5552** used to store the parents overflow cells. Because this function inserts
5553** a maximum of four divider cells into the parent page, and the maximum
5554** size of a cell stored within an internal node is always less than 1/4
5555** of the page-size, the aOvflSpace[] buffer is guaranteed to be large
5556** enough for all overflow cells.
5557**
5558** If aOvflSpace is set to a null pointer, this function returns
5559** SQLITE_NOMEM.
drh8b2f49b2001-06-08 00:21:52 +00005560*/
danielk19774dbaa892009-06-16 16:50:22 +00005561static int balance_nonroot(
5562 MemPage *pParent, /* Parent page of siblings being balanced */
5563 int iParentIdx, /* Index of "the page" in pParent */
danielk1977cd581a72009-06-23 15:43:39 +00005564 u8 *aOvflSpace, /* page-size bytes of space for parent ovfl */
5565 int isRoot /* True if pParent is a root-page */
danielk19774dbaa892009-06-16 16:50:22 +00005566){
drh16a9b832007-05-05 18:39:25 +00005567 BtShared *pBt; /* The whole database */
danielk1977634f2982005-03-28 08:44:07 +00005568 int nCell = 0; /* Number of cells in apCell[] */
5569 int nMaxCells = 0; /* Allocated size of apCell, szCell, aFrom. */
danielk1977a4124bd2008-12-23 10:37:47 +00005570 int nNew = 0; /* Number of pages in apNew[] */
danielk19774dbaa892009-06-16 16:50:22 +00005571 int nOld; /* Number of pages in apOld[] */
drh14acc042001-06-10 19:56:58 +00005572 int i, j, k; /* Loop counters */
drha34b6762004-05-07 13:30:42 +00005573 int nxDiv; /* Next divider slot in pParent->aCell[] */
shane85095702009-06-15 16:27:08 +00005574 int rc = SQLITE_OK; /* The return code */
shane36840fd2009-06-26 16:32:13 +00005575 u16 leafCorrection; /* 4 if pPage is a leaf. 0 if not */
drh8b18dd42004-05-12 19:18:15 +00005576 int leafData; /* True if pPage is a leaf of a LEAFDATA tree */
drh91025292004-05-03 19:49:32 +00005577 int usableSpace; /* Bytes in pPage beyond the header */
5578 int pageFlags; /* Value of pPage->aData[0] */
drh6019e162001-07-02 17:51:45 +00005579 int subtotal; /* Subtotal of bytes in cells on one page */
drhe5ae5732008-06-15 02:51:47 +00005580 int iSpace1 = 0; /* First unused byte of aSpace1[] */
danielk19776067a9b2009-06-09 09:41:00 +00005581 int iOvflSpace = 0; /* First unused byte of aOvflSpace[] */
drhfacf0302008-06-17 15:12:00 +00005582 int szScratch; /* Size of scratch memory requested */
drhc3b70572003-01-04 19:44:07 +00005583 MemPage *apOld[NB]; /* pPage and up to two siblings */
drh4b70f112004-05-02 21:12:19 +00005584 MemPage *apCopy[NB]; /* Private copies of apOld[] pages */
drha2fce642004-06-05 00:01:44 +00005585 MemPage *apNew[NB+2]; /* pPage and up to NB siblings after balancing */
danielk19774dbaa892009-06-16 16:50:22 +00005586 u8 *pRight; /* Location in parent of right-sibling pointer */
5587 u8 *apDiv[NB-1]; /* Divider cells in pParent */
drha2fce642004-06-05 00:01:44 +00005588 int cntNew[NB+2]; /* Index in aCell[] of cell after i-th page */
5589 int szNew[NB+2]; /* Combined size of cells place on i-th page */
danielk197750f059b2005-03-29 02:54:03 +00005590 u8 **apCell = 0; /* All cells begin balanced */
drha9121e42008-02-19 14:59:35 +00005591 u16 *szCell; /* Local size of all cells in apCell[] */
danielk19774dbaa892009-06-16 16:50:22 +00005592 u8 *aSpace1; /* Space for copies of dividers cells */
5593 Pgno pgno; /* Temp var to store a page number in */
drh8b2f49b2001-06-08 00:21:52 +00005594
danielk1977a50d9aa2009-06-08 14:49:45 +00005595 pBt = pParent->pBt;
5596 assert( sqlite3_mutex_held(pBt->mutex) );
5597 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk1977474b7cc2008-07-09 11:49:46 +00005598
danielk1977e5765212009-06-17 11:13:28 +00005599#if 0
drh43605152004-05-29 21:46:49 +00005600 TRACE(("BALANCE: begin page %d child of %d\n", pPage->pgno, pParent->pgno));
danielk1977e5765212009-06-17 11:13:28 +00005601#endif
drh2e38c322004-09-03 18:38:44 +00005602
danielk19774dbaa892009-06-16 16:50:22 +00005603 /* At this point pParent may have at most one overflow cell. And if
5604 ** this overflow cell is present, it must be the cell with
5605 ** index iParentIdx. This scenario comes about when this function
5606 ** is called (indirectly) from sqlite3BtreeDelete(). */
5607 assert( pParent->nOverflow==0 || pParent->nOverflow==1 );
5608 assert( pParent->nOverflow==0 || pParent->aOvfl[0].idx==iParentIdx );
5609
danielk197711a8a862009-06-17 11:49:52 +00005610 if( !aOvflSpace ){
5611 return SQLITE_NOMEM;
5612 }
5613
danielk1977a50d9aa2009-06-08 14:49:45 +00005614 /* Find the sibling pages to balance. Also locate the cells in pParent
5615 ** that divide the siblings. An attempt is made to find NN siblings on
5616 ** either side of pPage. More siblings are taken from one side, however,
5617 ** if there are fewer than NN siblings on the other side. If pParent
danielk19774dbaa892009-06-16 16:50:22 +00005618 ** has NB or fewer children then all children of pParent are taken.
5619 **
5620 ** This loop also drops the divider cells from the parent page. This
5621 ** way, the remainder of the function does not have to deal with any
5622 ** overflow cells in the parent page, as if one existed it has already
5623 ** been removed. */
5624 i = pParent->nOverflow + pParent->nCell;
5625 if( i<2 ){
drhc3b70572003-01-04 19:44:07 +00005626 nxDiv = 0;
danielk19774dbaa892009-06-16 16:50:22 +00005627 nOld = i+1;
5628 }else{
5629 nOld = 3;
5630 if( iParentIdx==0 ){
5631 nxDiv = 0;
5632 }else if( iParentIdx==i ){
5633 nxDiv = i-2;
drh14acc042001-06-10 19:56:58 +00005634 }else{
danielk19774dbaa892009-06-16 16:50:22 +00005635 nxDiv = iParentIdx-1;
drh8b2f49b2001-06-08 00:21:52 +00005636 }
danielk19774dbaa892009-06-16 16:50:22 +00005637 i = 2;
5638 }
5639 if( (i+nxDiv-pParent->nOverflow)==pParent->nCell ){
5640 pRight = &pParent->aData[pParent->hdrOffset+8];
5641 }else{
5642 pRight = findCell(pParent, i+nxDiv-pParent->nOverflow);
5643 }
5644 pgno = get4byte(pRight);
5645 while( 1 ){
5646 rc = getAndInitPage(pBt, pgno, &apOld[i]);
5647 if( rc ){
5648 memset(apOld, 0, i*sizeof(MemPage*));
5649 goto balance_cleanup;
5650 }
danielk1977634f2982005-03-28 08:44:07 +00005651 nMaxCells += 1+apOld[i]->nCell+apOld[i]->nOverflow;
danielk19774dbaa892009-06-16 16:50:22 +00005652 if( (i--)==0 ) break;
5653
5654 if( pParent->nOverflow && i+nxDiv==pParent->aOvfl[0].idx ){
5655 apDiv[i] = pParent->aOvfl[0].pCell;
5656 pgno = get4byte(apDiv[i]);
5657 szNew[i] = cellSizePtr(pParent, apDiv[i]);
5658 pParent->nOverflow = 0;
5659 }else{
5660 apDiv[i] = findCell(pParent, i+nxDiv-pParent->nOverflow);
5661 pgno = get4byte(apDiv[i]);
5662 szNew[i] = cellSizePtr(pParent, apDiv[i]);
5663
5664 /* Drop the cell from the parent page. apDiv[i] still points to
5665 ** the cell within the parent, even though it has been dropped.
5666 ** This is safe because dropping a cell only overwrites the first
5667 ** four bytes of it, and this function does not need the first
5668 ** four bytes of the divider cell. So the pointer is safe to use
danielk197711a8a862009-06-17 11:49:52 +00005669 ** later on.
5670 **
5671 ** Unless SQLite is compiled in secure-delete mode. In this case,
5672 ** the dropCell() routine will overwrite the entire cell with zeroes.
5673 ** In this case, temporarily copy the cell into the aOvflSpace[]
5674 ** buffer. It will be copied out again as soon as the aSpace[] buffer
5675 ** is allocated. */
5676#ifdef SQLITE_SECURE_DELETE
5677 memcpy(&aOvflSpace[apDiv[i]-pParent->aData], apDiv[i], szNew[i]);
5678 apDiv[i] = &aOvflSpace[apDiv[i]-pParent->aData];
5679#endif
danielk19774dbaa892009-06-16 16:50:22 +00005680 dropCell(pParent, i+nxDiv-pParent->nOverflow, szNew[i]);
5681 }
drh8b2f49b2001-06-08 00:21:52 +00005682 }
5683
drha9121e42008-02-19 14:59:35 +00005684 /* Make nMaxCells a multiple of 4 in order to preserve 8-byte
drh8d97f1f2005-05-05 18:14:13 +00005685 ** alignment */
drha9121e42008-02-19 14:59:35 +00005686 nMaxCells = (nMaxCells + 3)&~3;
drh8d97f1f2005-05-05 18:14:13 +00005687
drh8b2f49b2001-06-08 00:21:52 +00005688 /*
danielk1977634f2982005-03-28 08:44:07 +00005689 ** Allocate space for memory structures
5690 */
danielk19774dbaa892009-06-16 16:50:22 +00005691 k = pBt->pageSize + ROUND8(sizeof(MemPage));
drhfacf0302008-06-17 15:12:00 +00005692 szScratch =
drha9121e42008-02-19 14:59:35 +00005693 nMaxCells*sizeof(u8*) /* apCell */
5694 + nMaxCells*sizeof(u16) /* szCell */
drhe5ae5732008-06-15 02:51:47 +00005695 + pBt->pageSize /* aSpace1 */
danielk19774dbaa892009-06-16 16:50:22 +00005696 + k*nOld; /* Page copies (apCopy) */
drhfacf0302008-06-17 15:12:00 +00005697 apCell = sqlite3ScratchMalloc( szScratch );
danielk197711a8a862009-06-17 11:49:52 +00005698 if( apCell==0 ){
danielk1977634f2982005-03-28 08:44:07 +00005699 rc = SQLITE_NOMEM;
5700 goto balance_cleanup;
5701 }
drha9121e42008-02-19 14:59:35 +00005702 szCell = (u16*)&apCell[nMaxCells];
danielk19774dbaa892009-06-16 16:50:22 +00005703 aSpace1 = (u8*)&szCell[nMaxCells];
drhea598cb2009-04-05 12:22:08 +00005704 assert( EIGHT_BYTE_ALIGNMENT(aSpace1) );
drh14acc042001-06-10 19:56:58 +00005705
5706 /*
5707 ** Load pointers to all cells on sibling pages and the divider cells
5708 ** into the local apCell[] array. Make copies of the divider cells
danielk19774dbaa892009-06-16 16:50:22 +00005709 ** into space obtained from aSpace1[] and remove the the divider Cells
drhb6f41482004-05-14 01:58:11 +00005710 ** from pParent.
drh4b70f112004-05-02 21:12:19 +00005711 **
5712 ** If the siblings are on leaf pages, then the child pointers of the
5713 ** divider cells are stripped from the cells before they are copied
drhe5ae5732008-06-15 02:51:47 +00005714 ** into aSpace1[]. In this way, all cells in apCell[] are without
drh4b70f112004-05-02 21:12:19 +00005715 ** child pointers. If siblings are not leaves, then all cell in
5716 ** apCell[] include child pointers. Either way, all cells in apCell[]
5717 ** are alike.
drh96f5b762004-05-16 16:24:36 +00005718 **
5719 ** leafCorrection: 4 if pPage is a leaf. 0 if pPage is not a leaf.
5720 ** leafData: 1 if pPage holds key+data and pParent holds only keys.
drh8b2f49b2001-06-08 00:21:52 +00005721 */
danielk1977a50d9aa2009-06-08 14:49:45 +00005722 leafCorrection = apOld[0]->leaf*4;
5723 leafData = apOld[0]->hasData;
drh8b2f49b2001-06-08 00:21:52 +00005724 for(i=0; i<nOld; i++){
danielk19774dbaa892009-06-16 16:50:22 +00005725 int limit;
5726
5727 /* Before doing anything else, take a copy of the i'th original sibling
5728 ** The rest of this function will use data from the copies rather
5729 ** that the original pages since the original pages will be in the
5730 ** process of being overwritten. */
5731 MemPage *pOld = apCopy[i] = (MemPage*)&aSpace1[pBt->pageSize + k*i];
5732 memcpy(pOld, apOld[i], sizeof(MemPage));
5733 pOld->aData = (void*)&pOld[1];
5734 memcpy(pOld->aData, apOld[i]->aData, pBt->pageSize);
5735
5736 limit = pOld->nCell+pOld->nOverflow;
drh43605152004-05-29 21:46:49 +00005737 for(j=0; j<limit; j++){
danielk1977634f2982005-03-28 08:44:07 +00005738 assert( nCell<nMaxCells );
drh43605152004-05-29 21:46:49 +00005739 apCell[nCell] = findOverflowCell(pOld, j);
5740 szCell[nCell] = cellSizePtr(pOld, apCell[nCell]);
danielk19774dbaa892009-06-16 16:50:22 +00005741 nCell++;
5742 }
5743 if( i<nOld-1 && !leafData){
shane36840fd2009-06-26 16:32:13 +00005744 u16 sz = (u16)szNew[i];
danielk19774dbaa892009-06-16 16:50:22 +00005745 u8 *pTemp;
5746 assert( nCell<nMaxCells );
5747 szCell[nCell] = sz;
5748 pTemp = &aSpace1[iSpace1];
5749 iSpace1 += sz;
5750 assert( sz<=pBt->pageSize/4 );
5751 assert( iSpace1<=pBt->pageSize );
5752 memcpy(pTemp, apDiv[i], sz);
5753 apCell[nCell] = pTemp+leafCorrection;
5754 assert( leafCorrection==0 || leafCorrection==4 );
shane36840fd2009-06-26 16:32:13 +00005755 szCell[nCell] = szCell[nCell] - leafCorrection;
danielk19774dbaa892009-06-16 16:50:22 +00005756 if( !pOld->leaf ){
5757 assert( leafCorrection==0 );
5758 assert( pOld->hdrOffset==0 );
5759 /* The right pointer of the child page pOld becomes the left
5760 ** pointer of the divider cell */
5761 memcpy(apCell[nCell], &pOld->aData[8], 4);
5762 }else{
5763 assert( leafCorrection==4 );
5764 if( szCell[nCell]<4 ){
5765 /* Do not allow any cells smaller than 4 bytes. */
5766 szCell[nCell] = 4;
danielk1977ac11ee62005-01-15 12:45:51 +00005767 }
5768 }
drh14acc042001-06-10 19:56:58 +00005769 nCell++;
drh8b2f49b2001-06-08 00:21:52 +00005770 }
drh8b2f49b2001-06-08 00:21:52 +00005771 }
5772
5773 /*
drh6019e162001-07-02 17:51:45 +00005774 ** Figure out the number of pages needed to hold all nCell cells.
5775 ** Store this number in "k". Also compute szNew[] which is the total
5776 ** size of all cells on the i-th page and cntNew[] which is the index
drh4b70f112004-05-02 21:12:19 +00005777 ** in apCell[] of the cell that divides page i from page i+1.
drh6019e162001-07-02 17:51:45 +00005778 ** cntNew[k] should equal nCell.
5779 **
drh96f5b762004-05-16 16:24:36 +00005780 ** Values computed by this block:
5781 **
5782 ** k: The total number of sibling pages
5783 ** szNew[i]: Spaced used on the i-th sibling page.
5784 ** cntNew[i]: Index in apCell[] and szCell[] for the first cell to
5785 ** the right of the i-th sibling page.
5786 ** usableSpace: Number of bytes of space available on each sibling.
5787 **
drh8b2f49b2001-06-08 00:21:52 +00005788 */
drh43605152004-05-29 21:46:49 +00005789 usableSpace = pBt->usableSize - 12 + leafCorrection;
drh6019e162001-07-02 17:51:45 +00005790 for(subtotal=k=i=0; i<nCell; i++){
danielk1977634f2982005-03-28 08:44:07 +00005791 assert( i<nMaxCells );
drh43605152004-05-29 21:46:49 +00005792 subtotal += szCell[i] + 2;
drh4b70f112004-05-02 21:12:19 +00005793 if( subtotal > usableSpace ){
drh6019e162001-07-02 17:51:45 +00005794 szNew[k] = subtotal - szCell[i];
5795 cntNew[k] = i;
drh8b18dd42004-05-12 19:18:15 +00005796 if( leafData ){ i--; }
drh6019e162001-07-02 17:51:45 +00005797 subtotal = 0;
5798 k++;
drheac74422009-06-14 12:47:11 +00005799 if( k>NB+1 ){ rc = SQLITE_CORRUPT; goto balance_cleanup; }
drh6019e162001-07-02 17:51:45 +00005800 }
5801 }
5802 szNew[k] = subtotal;
5803 cntNew[k] = nCell;
5804 k++;
drh96f5b762004-05-16 16:24:36 +00005805
5806 /*
5807 ** The packing computed by the previous block is biased toward the siblings
5808 ** on the left side. The left siblings are always nearly full, while the
5809 ** right-most sibling might be nearly empty. This block of code attempts
5810 ** to adjust the packing of siblings to get a better balance.
5811 **
5812 ** This adjustment is more than an optimization. The packing above might
5813 ** be so out of balance as to be illegal. For example, the right-most
5814 ** sibling might be completely empty. This adjustment is not optional.
5815 */
drh6019e162001-07-02 17:51:45 +00005816 for(i=k-1; i>0; i--){
drh96f5b762004-05-16 16:24:36 +00005817 int szRight = szNew[i]; /* Size of sibling on the right */
5818 int szLeft = szNew[i-1]; /* Size of sibling on the left */
5819 int r; /* Index of right-most cell in left sibling */
5820 int d; /* Index of first cell to the left of right sibling */
5821
5822 r = cntNew[i-1] - 1;
5823 d = r + 1 - leafData;
danielk1977634f2982005-03-28 08:44:07 +00005824 assert( d<nMaxCells );
5825 assert( r<nMaxCells );
drh43605152004-05-29 21:46:49 +00005826 while( szRight==0 || szRight+szCell[d]+2<=szLeft-(szCell[r]+2) ){
5827 szRight += szCell[d] + 2;
5828 szLeft -= szCell[r] + 2;
drh6019e162001-07-02 17:51:45 +00005829 cntNew[i-1]--;
drh96f5b762004-05-16 16:24:36 +00005830 r = cntNew[i-1] - 1;
5831 d = r + 1 - leafData;
drh6019e162001-07-02 17:51:45 +00005832 }
drh96f5b762004-05-16 16:24:36 +00005833 szNew[i] = szRight;
5834 szNew[i-1] = szLeft;
drh6019e162001-07-02 17:51:45 +00005835 }
drh09d0deb2005-08-02 17:13:09 +00005836
danielk19776f235cc2009-06-04 14:46:08 +00005837 /* Either we found one or more cells (cntnew[0])>0) or pPage is
drh09d0deb2005-08-02 17:13:09 +00005838 ** a virtual root page. A virtual root page is when the real root
5839 ** page is page 1 and we are the only child of that page.
5840 */
5841 assert( cntNew[0]>0 || (pParent->pgno==1 && pParent->nCell==0) );
drh8b2f49b2001-06-08 00:21:52 +00005842
danielk1977e5765212009-06-17 11:13:28 +00005843 TRACE(("BALANCE: old: %d %d %d ",
5844 apOld[0]->pgno,
5845 nOld>=2 ? apOld[1]->pgno : 0,
5846 nOld>=3 ? apOld[2]->pgno : 0
5847 ));
5848
drh8b2f49b2001-06-08 00:21:52 +00005849 /*
drh6b308672002-07-08 02:16:37 +00005850 ** Allocate k new pages. Reuse old pages where possible.
drh8b2f49b2001-06-08 00:21:52 +00005851 */
drheac74422009-06-14 12:47:11 +00005852 if( apOld[0]->pgno<=1 ){
5853 rc = SQLITE_CORRUPT;
5854 goto balance_cleanup;
5855 }
danielk1977a50d9aa2009-06-08 14:49:45 +00005856 pageFlags = apOld[0]->aData[0];
drh14acc042001-06-10 19:56:58 +00005857 for(i=0; i<k; i++){
drhda200cc2004-05-09 11:51:38 +00005858 MemPage *pNew;
drh6b308672002-07-08 02:16:37 +00005859 if( i<nOld ){
drhda200cc2004-05-09 11:51:38 +00005860 pNew = apNew[i] = apOld[i];
drh6b308672002-07-08 02:16:37 +00005861 apOld[i] = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00005862 rc = sqlite3PagerWrite(pNew->pDbPage);
drhf5345442007-04-09 12:45:02 +00005863 nNew++;
danielk197728129562005-01-11 10:25:06 +00005864 if( rc ) goto balance_cleanup;
drh6b308672002-07-08 02:16:37 +00005865 }else{
drh7aa8f852006-03-28 00:24:44 +00005866 assert( i>0 );
danielk19774dbaa892009-06-16 16:50:22 +00005867 rc = allocateBtreePage(pBt, &pNew, &pgno, pgno, 0);
drh6b308672002-07-08 02:16:37 +00005868 if( rc ) goto balance_cleanup;
drhda200cc2004-05-09 11:51:38 +00005869 apNew[i] = pNew;
drhf5345442007-04-09 12:45:02 +00005870 nNew++;
danielk19774dbaa892009-06-16 16:50:22 +00005871
5872 /* Set the pointer-map entry for the new sibling page. */
5873 if( ISAUTOVACUUM ){
5874 rc = ptrmapPut(pBt, pNew->pgno, PTRMAP_BTREE, pParent->pgno);
5875 if( rc!=SQLITE_OK ){
5876 goto balance_cleanup;
5877 }
5878 }
drh6b308672002-07-08 02:16:37 +00005879 }
drh8b2f49b2001-06-08 00:21:52 +00005880 }
5881
danielk1977299b1872004-11-22 10:02:10 +00005882 /* Free any old pages that were not reused as new pages.
5883 */
5884 while( i<nOld ){
5885 rc = freePage(apOld[i]);
5886 if( rc ) goto balance_cleanup;
5887 releasePage(apOld[i]);
5888 apOld[i] = 0;
5889 i++;
5890 }
5891
drh8b2f49b2001-06-08 00:21:52 +00005892 /*
drhf9ffac92002-03-02 19:00:31 +00005893 ** Put the new pages in accending order. This helps to
5894 ** keep entries in the disk file in order so that a scan
5895 ** of the table is a linear scan through the file. That
5896 ** in turn helps the operating system to deliver pages
5897 ** from the disk more rapidly.
5898 **
5899 ** An O(n^2) insertion sort algorithm is used, but since
drhc3b70572003-01-04 19:44:07 +00005900 ** n is never more than NB (a small constant), that should
5901 ** not be a problem.
drhf9ffac92002-03-02 19:00:31 +00005902 **
drhc3b70572003-01-04 19:44:07 +00005903 ** When NB==3, this one optimization makes the database
5904 ** about 25% faster for large insertions and deletions.
drhf9ffac92002-03-02 19:00:31 +00005905 */
5906 for(i=0; i<k-1; i++){
danielk19774dbaa892009-06-16 16:50:22 +00005907 int minV = apNew[i]->pgno;
drhf9ffac92002-03-02 19:00:31 +00005908 int minI = i;
5909 for(j=i+1; j<k; j++){
danielk19774dbaa892009-06-16 16:50:22 +00005910 if( apNew[j]->pgno<(unsigned)minV ){
drhf9ffac92002-03-02 19:00:31 +00005911 minI = j;
danielk19774dbaa892009-06-16 16:50:22 +00005912 minV = apNew[j]->pgno;
drhf9ffac92002-03-02 19:00:31 +00005913 }
5914 }
5915 if( minI>i ){
5916 int t;
5917 MemPage *pT;
danielk19774dbaa892009-06-16 16:50:22 +00005918 t = apNew[i]->pgno;
drhf9ffac92002-03-02 19:00:31 +00005919 pT = apNew[i];
drhf9ffac92002-03-02 19:00:31 +00005920 apNew[i] = apNew[minI];
drhf9ffac92002-03-02 19:00:31 +00005921 apNew[minI] = pT;
5922 }
5923 }
danielk1977e5765212009-06-17 11:13:28 +00005924 TRACE(("new: %d(%d) %d(%d) %d(%d) %d(%d) %d(%d)\n",
danielk19774dbaa892009-06-16 16:50:22 +00005925 apNew[0]->pgno, szNew[0],
5926 nNew>=2 ? apNew[1]->pgno : 0, nNew>=2 ? szNew[1] : 0,
5927 nNew>=3 ? apNew[2]->pgno : 0, nNew>=3 ? szNew[2] : 0,
5928 nNew>=4 ? apNew[3]->pgno : 0, nNew>=4 ? szNew[3] : 0,
5929 nNew>=5 ? apNew[4]->pgno : 0, nNew>=5 ? szNew[4] : 0));
5930
5931 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
5932 put4byte(pRight, apNew[nNew-1]->pgno);
drh24cd67e2004-05-10 16:18:47 +00005933
drhf9ffac92002-03-02 19:00:31 +00005934 /*
drh14acc042001-06-10 19:56:58 +00005935 ** Evenly distribute the data in apCell[] across the new pages.
5936 ** Insert divider cells into pParent as necessary.
5937 */
5938 j = 0;
5939 for(i=0; i<nNew; i++){
danielk1977ac11ee62005-01-15 12:45:51 +00005940 /* Assemble the new sibling page. */
drh14acc042001-06-10 19:56:58 +00005941 MemPage *pNew = apNew[i];
drh19642e52005-03-29 13:17:45 +00005942 assert( j<nMaxCells );
drh10131482008-07-11 03:34:09 +00005943 zeroPage(pNew, pageFlags);
drhfa1a98a2004-05-14 19:08:17 +00005944 assemblePage(pNew, cntNew[i]-j, &apCell[j], &szCell[j]);
drh09d0deb2005-08-02 17:13:09 +00005945 assert( pNew->nCell>0 || (nNew==1 && cntNew[0]==0) );
drh43605152004-05-29 21:46:49 +00005946 assert( pNew->nOverflow==0 );
danielk1977ac11ee62005-01-15 12:45:51 +00005947
danielk1977ac11ee62005-01-15 12:45:51 +00005948 j = cntNew[i];
5949
5950 /* If the sibling page assembled above was not the right-most sibling,
5951 ** insert a divider cell into the parent page.
5952 */
danielk19771c3d2bf2009-06-23 16:40:17 +00005953 assert( i<nNew-1 || j==nCell );
5954 if( j<nCell ){
drh8b18dd42004-05-12 19:18:15 +00005955 u8 *pCell;
drh24cd67e2004-05-10 16:18:47 +00005956 u8 *pTemp;
drh8b18dd42004-05-12 19:18:15 +00005957 int sz;
danielk1977634f2982005-03-28 08:44:07 +00005958
5959 assert( j<nMaxCells );
drh8b18dd42004-05-12 19:18:15 +00005960 pCell = apCell[j];
5961 sz = szCell[j] + leafCorrection;
danielk19776067a9b2009-06-09 09:41:00 +00005962 pTemp = &aOvflSpace[iOvflSpace];
drh4b70f112004-05-02 21:12:19 +00005963 if( !pNew->leaf ){
drh43605152004-05-29 21:46:49 +00005964 memcpy(&pNew->aData[8], pCell, 4);
drh8b18dd42004-05-12 19:18:15 +00005965 }else if( leafData ){
drhfd131da2007-08-07 17:13:03 +00005966 /* If the tree is a leaf-data tree, and the siblings are leaves,
danielk1977ac11ee62005-01-15 12:45:51 +00005967 ** then there is no divider cell in apCell[]. Instead, the divider
5968 ** cell consists of the integer key for the right-most cell of
5969 ** the sibling-page assembled above only.
5970 */
drh6f11bef2004-05-13 01:12:56 +00005971 CellInfo info;
drh8b18dd42004-05-12 19:18:15 +00005972 j--;
danielk197730548662009-07-09 05:07:37 +00005973 btreeParseCellPtr(pNew, apCell[j], &info);
drhe5ae5732008-06-15 02:51:47 +00005974 pCell = pTemp;
danielk19774dbaa892009-06-16 16:50:22 +00005975 sz = 4 + putVarint(&pCell[4], info.nKey);
drh8b18dd42004-05-12 19:18:15 +00005976 pTemp = 0;
drh4b70f112004-05-02 21:12:19 +00005977 }else{
5978 pCell -= 4;
danielk19774aeff622007-05-12 09:30:47 +00005979 /* Obscure case for non-leaf-data trees: If the cell at pCell was
drh85b623f2007-12-13 21:54:09 +00005980 ** previously stored on a leaf node, and its reported size was 4
danielk19774aeff622007-05-12 09:30:47 +00005981 ** bytes, then it may actually be smaller than this
danielk197730548662009-07-09 05:07:37 +00005982 ** (see btreeParseCellPtr(), 4 bytes is the minimum size of
drh85b623f2007-12-13 21:54:09 +00005983 ** any cell). But it is important to pass the correct size to
danielk19774aeff622007-05-12 09:30:47 +00005984 ** insertCell(), so reparse the cell now.
5985 **
5986 ** Note that this can never happen in an SQLite data file, as all
5987 ** cells are at least 4 bytes. It only happens in b-trees used
5988 ** to evaluate "IN (SELECT ...)" and similar clauses.
5989 */
5990 if( szCell[j]==4 ){
5991 assert(leafCorrection==4);
5992 sz = cellSizePtr(pParent, pCell);
5993 }
drh4b70f112004-05-02 21:12:19 +00005994 }
danielk19776067a9b2009-06-09 09:41:00 +00005995 iOvflSpace += sz;
drhe5ae5732008-06-15 02:51:47 +00005996 assert( sz<=pBt->pageSize/4 );
danielk19776067a9b2009-06-09 09:41:00 +00005997 assert( iOvflSpace<=pBt->pageSize );
danielk19774dbaa892009-06-16 16:50:22 +00005998 rc = insertCell(pParent, nxDiv, pCell, sz, pTemp, pNew->pgno);
danielk1977e80463b2004-11-03 03:01:16 +00005999 if( rc!=SQLITE_OK ) goto balance_cleanup;
drhc5053fb2008-11-27 02:22:10 +00006000 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk197785d90ca2008-07-19 14:25:15 +00006001
drh14acc042001-06-10 19:56:58 +00006002 j++;
6003 nxDiv++;
6004 }
6005 }
drh6019e162001-07-02 17:51:45 +00006006 assert( j==nCell );
drh7aa8f852006-03-28 00:24:44 +00006007 assert( nOld>0 );
6008 assert( nNew>0 );
drh4b70f112004-05-02 21:12:19 +00006009 if( (pageFlags & PTF_LEAF)==0 ){
danielk197787c52b52008-07-19 11:49:07 +00006010 u8 *zChild = &apCopy[nOld-1]->aData[8];
6011 memcpy(&apNew[nNew-1]->aData[8], zChild, 4);
drh14acc042001-06-10 19:56:58 +00006012 }
6013
danielk197713bd99f2009-06-24 05:40:34 +00006014 if( isRoot && pParent->nCell==0 && pParent->hdrOffset<=apNew[0]->nFree ){
6015 /* The root page of the b-tree now contains no cells. The only sibling
6016 ** page is the right-child of the parent. Copy the contents of the
6017 ** child page into the parent, decreasing the overall height of the
6018 ** b-tree structure by one. This is described as the "balance-shallower"
6019 ** sub-algorithm in some documentation.
6020 **
6021 ** If this is an auto-vacuum database, the call to copyNodeContent()
6022 ** sets all pointer-map entries corresponding to database image pages
6023 ** for which the pointer is stored within the content being copied.
6024 **
6025 ** The second assert below verifies that the child page is defragmented
6026 ** (it must be, as it was just reconstructed using assemblePage()). This
6027 ** is important if the parent page happens to be page 1 of the database
6028 ** image. */
6029 assert( nNew==1 );
6030 assert( apNew[0]->nFree ==
6031 (get2byte(&apNew[0]->aData[5])-apNew[0]->cellOffset-apNew[0]->nCell*2)
6032 );
6033 if( SQLITE_OK==(rc = copyNodeContent(apNew[0], pParent)) ){
6034 rc = freePage(apNew[0]);
6035 }
6036 }else if( ISAUTOVACUUM ){
6037 /* Fix the pointer-map entries for all the cells that were shifted around.
6038 ** There are several different types of pointer-map entries that need to
6039 ** be dealt with by this routine. Some of these have been set already, but
6040 ** many have not. The following is a summary:
6041 **
6042 ** 1) The entries associated with new sibling pages that were not
6043 ** siblings when this function was called. These have already
6044 ** been set. We don't need to worry about old siblings that were
6045 ** moved to the free-list - the freePage() code has taken care
6046 ** of those.
6047 **
6048 ** 2) The pointer-map entries associated with the first overflow
6049 ** page in any overflow chains used by new divider cells. These
6050 ** have also already been taken care of by the insertCell() code.
6051 **
6052 ** 3) If the sibling pages are not leaves, then the child pages of
6053 ** cells stored on the sibling pages may need to be updated.
6054 **
6055 ** 4) If the sibling pages are not internal intkey nodes, then any
6056 ** overflow pages used by these cells may need to be updated
6057 ** (internal intkey nodes never contain pointers to overflow pages).
6058 **
6059 ** 5) If the sibling pages are not leaves, then the pointer-map
6060 ** entries for the right-child pages of each sibling may need
6061 ** to be updated.
6062 **
6063 ** Cases 1 and 2 are dealt with above by other code. The next
6064 ** block deals with cases 3 and 4 and the one after that, case 5. Since
6065 ** setting a pointer map entry is a relatively expensive operation, this
6066 ** code only sets pointer map entries for child or overflow pages that have
6067 ** actually moved between pages. */
danielk19774dbaa892009-06-16 16:50:22 +00006068 MemPage *pNew = apNew[0];
6069 MemPage *pOld = apCopy[0];
6070 int nOverflow = pOld->nOverflow;
6071 int iNextOld = pOld->nCell + nOverflow;
6072 int iOverflow = (nOverflow ? pOld->aOvfl[0].idx : -1);
6073 j = 0; /* Current 'old' sibling page */
6074 k = 0; /* Current 'new' sibling page */
6075 for(i=0; i<nCell && rc==SQLITE_OK; i++){
6076 int isDivider = 0;
6077 while( i==iNextOld ){
6078 /* Cell i is the cell immediately following the last cell on old
6079 ** sibling page j. If the siblings are not leaf pages of an
6080 ** intkey b-tree, then cell i was a divider cell. */
6081 pOld = apCopy[++j];
6082 iNextOld = i + !leafData + pOld->nCell + pOld->nOverflow;
6083 if( pOld->nOverflow ){
6084 nOverflow = pOld->nOverflow;
6085 iOverflow = i + !leafData + pOld->aOvfl[0].idx;
6086 }
6087 isDivider = !leafData;
6088 }
6089
6090 assert(nOverflow>0 || iOverflow<i );
6091 assert(nOverflow<2 || pOld->aOvfl[0].idx==pOld->aOvfl[1].idx-1);
6092 assert(nOverflow<3 || pOld->aOvfl[1].idx==pOld->aOvfl[2].idx-1);
6093 if( i==iOverflow ){
6094 isDivider = 1;
6095 if( (--nOverflow)>0 ){
6096 iOverflow++;
6097 }
6098 }
6099
6100 if( i==cntNew[k] ){
6101 /* Cell i is the cell immediately following the last cell on new
6102 ** sibling page k. If the siblings are not leaf pages of an
6103 ** intkey b-tree, then cell i is a divider cell. */
6104 pNew = apNew[++k];
6105 if( !leafData ) continue;
6106 }
6107 assert( rc==SQLITE_OK );
6108 assert( j<nOld );
6109 assert( k<nNew );
6110
6111 /* If the cell was originally divider cell (and is not now) or
6112 ** an overflow cell, or if the cell was located on a different sibling
6113 ** page before the balancing, then the pointer map entries associated
6114 ** with any child or overflow pages need to be updated. */
6115 if( isDivider || pOld->pgno!=pNew->pgno ){
6116 if( !leafCorrection ){
6117 rc = ptrmapPut(pBt, get4byte(apCell[i]), PTRMAP_BTREE, pNew->pgno);
6118 }
6119 if( szCell[i]>pNew->minLocal && rc==SQLITE_OK ){
6120 rc = ptrmapPutOvflPtr(pNew, apCell[i]);
6121 }
6122 }
6123 }
6124
6125 if( !leafCorrection ){
6126 for(i=0; rc==SQLITE_OK && i<nNew; i++){
6127 rc = ptrmapPut(
6128 pBt, get4byte(&apNew[i]->aData[8]), PTRMAP_BTREE, apNew[i]->pgno);
6129 }
6130 }
6131
6132#if 0
6133 /* The ptrmapCheckPages() contains assert() statements that verify that
6134 ** all pointer map pages are set correctly. This is helpful while
6135 ** debugging. This is usually disabled because a corrupt database may
6136 ** cause an assert() statement to fail. */
6137 ptrmapCheckPages(apNew, nNew);
6138 ptrmapCheckPages(&pParent, 1);
6139#endif
6140 }
6141
danielk197771d5d2c2008-09-29 11:49:47 +00006142 assert( pParent->isInit );
danielk1977e5765212009-06-17 11:13:28 +00006143 TRACE(("BALANCE: finished: old=%d new=%d cells=%d\n",
6144 nOld, nNew, nCell));
danielk1977cd581a72009-06-23 15:43:39 +00006145
drh8b2f49b2001-06-08 00:21:52 +00006146 /*
drh14acc042001-06-10 19:56:58 +00006147 ** Cleanup before returning.
drh8b2f49b2001-06-08 00:21:52 +00006148 */
drh14acc042001-06-10 19:56:58 +00006149balance_cleanup:
drhfacf0302008-06-17 15:12:00 +00006150 sqlite3ScratchFree(apCell);
drh8b2f49b2001-06-08 00:21:52 +00006151 for(i=0; i<nOld; i++){
drh91025292004-05-03 19:49:32 +00006152 releasePage(apOld[i]);
drh8b2f49b2001-06-08 00:21:52 +00006153 }
drh14acc042001-06-10 19:56:58 +00006154 for(i=0; i<nNew; i++){
drh91025292004-05-03 19:49:32 +00006155 releasePage(apNew[i]);
drh8b2f49b2001-06-08 00:21:52 +00006156 }
danielk1977eaa06f62008-09-18 17:34:44 +00006157
drh8b2f49b2001-06-08 00:21:52 +00006158 return rc;
6159}
6160
drh43605152004-05-29 21:46:49 +00006161
6162/*
danielk1977a50d9aa2009-06-08 14:49:45 +00006163** This function is called when the root page of a b-tree structure is
6164** overfull (has one or more overflow pages).
drh43605152004-05-29 21:46:49 +00006165**
danielk1977a50d9aa2009-06-08 14:49:45 +00006166** A new child page is allocated and the contents of the current root
6167** page, including overflow cells, are copied into the child. The root
6168** page is then overwritten to make it an empty page with the right-child
6169** pointer pointing to the new page.
6170**
6171** Before returning, all pointer-map entries corresponding to pages
6172** that the new child-page now contains pointers to are updated. The
6173** entry corresponding to the new right-child pointer of the root
6174** page is also updated.
6175**
6176** If successful, *ppChild is set to contain a reference to the child
6177** page and SQLITE_OK is returned. In this case the caller is required
6178** to call releasePage() on *ppChild exactly once. If an error occurs,
6179** an error code is returned and *ppChild is set to 0.
drh43605152004-05-29 21:46:49 +00006180*/
danielk1977a50d9aa2009-06-08 14:49:45 +00006181static int balance_deeper(MemPage *pRoot, MemPage **ppChild){
6182 int rc; /* Return value from subprocedures */
6183 MemPage *pChild = 0; /* Pointer to a new child page */
6184 Pgno pgnoChild; /* Page number of the new child page */
6185 BtShared *pBt = pRoot->pBt; /* The BTree */
drh43605152004-05-29 21:46:49 +00006186
danielk1977a50d9aa2009-06-08 14:49:45 +00006187 assert( pRoot->nOverflow>0 );
drh1fee73e2007-08-29 04:00:57 +00006188 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977bc2ca9e2008-11-13 14:28:28 +00006189
danielk1977a50d9aa2009-06-08 14:49:45 +00006190 /* Make pRoot, the root page of the b-tree, writable. Allocate a new
6191 ** page that will become the new right-child of pPage. Copy the contents
6192 ** of the node stored on pRoot into the new child page.
6193 */
6194 if( SQLITE_OK!=(rc = sqlite3PagerWrite(pRoot->pDbPage))
6195 || SQLITE_OK!=(rc = allocateBtreePage(pBt,&pChild,&pgnoChild,pRoot->pgno,0))
6196 || SQLITE_OK!=(rc = copyNodeContent(pRoot, pChild))
6197 || (ISAUTOVACUUM &&
6198 SQLITE_OK!=(rc = ptrmapPut(pBt, pgnoChild, PTRMAP_BTREE, pRoot->pgno)))
6199 ){
6200 *ppChild = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00006201 releasePage(pChild);
danielk1977a50d9aa2009-06-08 14:49:45 +00006202 return rc;
danielk197771d5d2c2008-09-29 11:49:47 +00006203 }
danielk1977a50d9aa2009-06-08 14:49:45 +00006204 assert( sqlite3PagerIswriteable(pChild->pDbPage) );
6205 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
6206 assert( pChild->nCell==pRoot->nCell );
danielk197771d5d2c2008-09-29 11:49:47 +00006207
danielk1977a50d9aa2009-06-08 14:49:45 +00006208 TRACE(("BALANCE: copy root %d into %d\n", pRoot->pgno, pChild->pgno));
6209
6210 /* Copy the overflow cells from pRoot to pChild */
6211 memcpy(pChild->aOvfl, pRoot->aOvfl, pRoot->nOverflow*sizeof(pRoot->aOvfl[0]));
6212 pChild->nOverflow = pRoot->nOverflow;
danielk1977a50d9aa2009-06-08 14:49:45 +00006213
6214 /* Zero the contents of pRoot. Then install pChild as the right-child. */
6215 zeroPage(pRoot, pChild->aData[0] & ~PTF_LEAF);
6216 put4byte(&pRoot->aData[pRoot->hdrOffset+8], pgnoChild);
6217
6218 *ppChild = pChild;
6219 return SQLITE_OK;
drh43605152004-05-29 21:46:49 +00006220}
6221
6222/*
danielk197771d5d2c2008-09-29 11:49:47 +00006223** The page that pCur currently points to has just been modified in
6224** some way. This function figures out if this modification means the
6225** tree needs to be balanced, and if so calls the appropriate balancing
danielk1977a50d9aa2009-06-08 14:49:45 +00006226** routine. Balancing routines are:
6227**
6228** balance_quick()
danielk1977a50d9aa2009-06-08 14:49:45 +00006229** balance_deeper()
6230** balance_nonroot()
drh43605152004-05-29 21:46:49 +00006231*/
danielk1977a50d9aa2009-06-08 14:49:45 +00006232static int balance(BtCursor *pCur){
drh43605152004-05-29 21:46:49 +00006233 int rc = SQLITE_OK;
danielk1977a50d9aa2009-06-08 14:49:45 +00006234 const int nMin = pCur->pBt->usableSize * 2 / 3;
6235 u8 aBalanceQuickSpace[13];
6236 u8 *pFree = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00006237
shane75ac1de2009-06-09 18:58:52 +00006238 TESTONLY( int balance_quick_called = 0 );
6239 TESTONLY( int balance_deeper_called = 0 );
danielk1977a50d9aa2009-06-08 14:49:45 +00006240
6241 do {
6242 int iPage = pCur->iPage;
6243 MemPage *pPage = pCur->apPage[iPage];
6244
6245 if( iPage==0 ){
6246 if( pPage->nOverflow ){
6247 /* The root page of the b-tree is overfull. In this case call the
6248 ** balance_deeper() function to create a new child for the root-page
6249 ** and copy the current contents of the root-page to it. The
6250 ** next iteration of the do-loop will balance the child page.
6251 */
6252 assert( (balance_deeper_called++)==0 );
6253 rc = balance_deeper(pPage, &pCur->apPage[1]);
6254 if( rc==SQLITE_OK ){
6255 pCur->iPage = 1;
6256 pCur->aiIdx[0] = 0;
6257 pCur->aiIdx[1] = 0;
6258 assert( pCur->apPage[1]->nOverflow );
6259 }
danielk1977a50d9aa2009-06-08 14:49:45 +00006260 }else{
danielk1977a50d9aa2009-06-08 14:49:45 +00006261 break;
6262 }
6263 }else if( pPage->nOverflow==0 && pPage->nFree<=nMin ){
6264 break;
6265 }else{
6266 MemPage * const pParent = pCur->apPage[iPage-1];
6267 int const iIdx = pCur->aiIdx[iPage-1];
6268
6269 rc = sqlite3PagerWrite(pParent->pDbPage);
6270 if( rc==SQLITE_OK ){
6271#ifndef SQLITE_OMIT_QUICKBALANCE
6272 if( pPage->hasData
6273 && pPage->nOverflow==1
6274 && pPage->aOvfl[0].idx==pPage->nCell
6275 && pParent->pgno!=1
6276 && pParent->nCell==iIdx
6277 ){
6278 /* Call balance_quick() to create a new sibling of pPage on which
6279 ** to store the overflow cell. balance_quick() inserts a new cell
6280 ** into pParent, which may cause pParent overflow. If this
6281 ** happens, the next interation of the do-loop will balance pParent
6282 ** use either balance_nonroot() or balance_deeper(). Until this
6283 ** happens, the overflow cell is stored in the aBalanceQuickSpace[]
6284 ** buffer.
6285 **
6286 ** The purpose of the following assert() is to check that only a
6287 ** single call to balance_quick() is made for each call to this
6288 ** function. If this were not verified, a subtle bug involving reuse
6289 ** of the aBalanceQuickSpace[] might sneak in.
6290 */
6291 assert( (balance_quick_called++)==0 );
6292 rc = balance_quick(pParent, pPage, aBalanceQuickSpace);
6293 }else
6294#endif
6295 {
6296 /* In this case, call balance_nonroot() to redistribute cells
6297 ** between pPage and up to 2 of its sibling pages. This involves
6298 ** modifying the contents of pParent, which may cause pParent to
6299 ** become overfull or underfull. The next iteration of the do-loop
6300 ** will balance the parent page to correct this.
6301 **
6302 ** If the parent page becomes overfull, the overflow cell or cells
6303 ** are stored in the pSpace buffer allocated immediately below.
6304 ** A subsequent iteration of the do-loop will deal with this by
6305 ** calling balance_nonroot() (balance_deeper() may be called first,
6306 ** but it doesn't deal with overflow cells - just moves them to a
6307 ** different page). Once this subsequent call to balance_nonroot()
6308 ** has completed, it is safe to release the pSpace buffer used by
6309 ** the previous call, as the overflow cell data will have been
6310 ** copied either into the body of a database page or into the new
6311 ** pSpace buffer passed to the latter call to balance_nonroot().
6312 */
6313 u8 *pSpace = sqlite3PageMalloc(pCur->pBt->pageSize);
danielk1977cd581a72009-06-23 15:43:39 +00006314 rc = balance_nonroot(pParent, iIdx, pSpace, iPage==1);
danielk1977a50d9aa2009-06-08 14:49:45 +00006315 if( pFree ){
6316 /* If pFree is not NULL, it points to the pSpace buffer used
6317 ** by a previous call to balance_nonroot(). Its contents are
6318 ** now stored either on real database pages or within the
6319 ** new pSpace buffer, so it may be safely freed here. */
6320 sqlite3PageFree(pFree);
6321 }
6322
danielk19774dbaa892009-06-16 16:50:22 +00006323 /* The pSpace buffer will be freed after the next call to
6324 ** balance_nonroot(), or just before this function returns, whichever
6325 ** comes first. */
danielk1977a50d9aa2009-06-08 14:49:45 +00006326 pFree = pSpace;
danielk1977a50d9aa2009-06-08 14:49:45 +00006327 }
6328 }
6329
6330 pPage->nOverflow = 0;
6331
6332 /* The next iteration of the do-loop balances the parent page. */
6333 releasePage(pPage);
6334 pCur->iPage--;
drh43605152004-05-29 21:46:49 +00006335 }
danielk1977a50d9aa2009-06-08 14:49:45 +00006336 }while( rc==SQLITE_OK );
6337
6338 if( pFree ){
6339 sqlite3PageFree(pFree);
drh43605152004-05-29 21:46:49 +00006340 }
6341 return rc;
6342}
6343
drhf74b8d92002-09-01 23:20:45 +00006344
6345/*
drh3b7511c2001-05-26 13:15:44 +00006346** Insert a new record into the BTree. The key is given by (pKey,nKey)
6347** and the data is given by (pData,nData). The cursor is used only to
drh91025292004-05-03 19:49:32 +00006348** define what table the record should be inserted into. The cursor
drh4b70f112004-05-02 21:12:19 +00006349** is left pointing at a random location.
6350**
6351** For an INTKEY table, only the nKey value of the key is used. pKey is
6352** ignored. For a ZERODATA table, the pData and nData are both ignored.
danielk1977de630352009-05-04 11:42:29 +00006353**
6354** If the seekResult parameter is non-zero, then a successful call to
danielk19773509a652009-07-06 18:56:13 +00006355** MovetoUnpacked() to seek cursor pCur to (pKey, nKey) has already
danielk1977de630352009-05-04 11:42:29 +00006356** been performed. seekResult is the search result returned (a negative
6357** number if pCur points at an entry that is smaller than (pKey, nKey), or
6358** a positive value if pCur points at an etry that is larger than
6359** (pKey, nKey)).
6360**
6361** If the seekResult parameter is 0, then cursor pCur may point to any
6362** entry or to no entry at all. In this case this function has to seek
6363** the cursor before the new key can be inserted.
drh3b7511c2001-05-26 13:15:44 +00006364*/
drh3aac2dd2004-04-26 14:10:20 +00006365int sqlite3BtreeInsert(
drh5c4d9702001-08-20 00:33:58 +00006366 BtCursor *pCur, /* Insert data into the table of this cursor */
drh4a1c3802004-05-12 15:15:47 +00006367 const void *pKey, i64 nKey, /* The key of the new record */
drhe4d90812007-03-29 05:51:49 +00006368 const void *pData, int nData, /* The data of the new record */
drhb026e052007-05-02 01:34:31 +00006369 int nZero, /* Number of extra 0 bytes to append to data */
danielk1977de630352009-05-04 11:42:29 +00006370 int appendBias, /* True if this is likely an append */
danielk19773509a652009-07-06 18:56:13 +00006371 int seekResult /* Result of prior MovetoUnpacked() call */
drh3b7511c2001-05-26 13:15:44 +00006372){
drh3b7511c2001-05-26 13:15:44 +00006373 int rc;
danielk1977de630352009-05-04 11:42:29 +00006374 int loc = seekResult;
drh14acc042001-06-10 19:56:58 +00006375 int szNew;
danielk197771d5d2c2008-09-29 11:49:47 +00006376 int idx;
drh3b7511c2001-05-26 13:15:44 +00006377 MemPage *pPage;
drhd677b3d2007-08-20 22:48:41 +00006378 Btree *p = pCur->pBtree;
6379 BtShared *pBt = p->pBt;
drha34b6762004-05-07 13:30:42 +00006380 unsigned char *oldCell;
drh2e38c322004-09-03 18:38:44 +00006381 unsigned char *newCell = 0;
drh3b7511c2001-05-26 13:15:44 +00006382
drh1fee73e2007-08-29 04:00:57 +00006383 assert( cursorHoldsMutex(pCur) );
drh64022502009-01-09 14:11:04 +00006384 assert( pBt->inTransaction==TRANS_WRITE );
drhf74b8d92002-09-01 23:20:45 +00006385 assert( !pBt->readOnly );
drh64022502009-01-09 14:11:04 +00006386 assert( pCur->wrFlag );
danielk197796d48e92009-06-29 06:00:37 +00006387 assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
6388
6389 /* If this is an insert into a table b-tree, invalidate any incrblob
6390 ** cursors open on the row being replaced (assuming this is a replace
6391 ** operation - if it is not, the following is a no-op). */
6392 if( pCur->pKeyInfo==0 ){
6393 invalidateIncrblobCursors(p, pCur->pgnoRoot, nKey, 0);
drhf74b8d92002-09-01 23:20:45 +00006394 }
danielk197796d48e92009-06-29 06:00:37 +00006395
drhfb982642007-08-30 01:19:59 +00006396 if( pCur->eState==CURSOR_FAULT ){
6397 return pCur->skip;
6398 }
danielk1977da184232006-01-05 11:34:32 +00006399
danielk19779c3acf32009-05-02 07:36:49 +00006400 /* Save the positions of any other cursors open on this table.
6401 **
danielk19773509a652009-07-06 18:56:13 +00006402 ** In some cases, the call to btreeMoveto() below is a no-op. For
danielk19779c3acf32009-05-02 07:36:49 +00006403 ** example, when inserting data into a table with auto-generated integer
6404 ** keys, the VDBE layer invokes sqlite3BtreeLast() to figure out the
6405 ** integer key to use. It then calls this function to actually insert the
danielk19773509a652009-07-06 18:56:13 +00006406 ** data into the intkey B-Tree. In this case btreeMoveto() recognizes
danielk19779c3acf32009-05-02 07:36:49 +00006407 ** that the cursor is already where it needs to be and returns without
6408 ** doing any work. To avoid thwarting these optimizations, it is important
6409 ** not to clear the cursor here.
6410 */
danielk1977de630352009-05-04 11:42:29 +00006411 if(
6412 SQLITE_OK!=(rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur)) || (!loc &&
danielk19773509a652009-07-06 18:56:13 +00006413 SQLITE_OK!=(rc = btreeMoveto(pCur, pKey, nKey, appendBias, &loc))
danielk1977de630352009-05-04 11:42:29 +00006414 )){
danielk1977da184232006-01-05 11:34:32 +00006415 return rc;
6416 }
danielk1977b980d2212009-06-22 18:03:51 +00006417 assert( pCur->eState==CURSOR_VALID || (pCur->eState==CURSOR_INVALID && loc) );
danielk1977da184232006-01-05 11:34:32 +00006418
danielk197771d5d2c2008-09-29 11:49:47 +00006419 pPage = pCur->apPage[pCur->iPage];
drh4a1c3802004-05-12 15:15:47 +00006420 assert( pPage->intKey || nKey>=0 );
drh44845222008-07-17 18:39:57 +00006421 assert( pPage->leaf || !pPage->intKey );
drh3a4c1412004-05-09 20:40:11 +00006422 TRACE(("INSERT: table=%d nkey=%lld ndata=%d page=%d %s\n",
6423 pCur->pgnoRoot, nKey, nData, pPage->pgno,
6424 loc==0 ? "overwrite" : "new entry"));
danielk197771d5d2c2008-09-29 11:49:47 +00006425 assert( pPage->isInit );
danielk197752ae7242008-03-25 14:24:56 +00006426 allocateTempSpace(pBt);
6427 newCell = pBt->pTmpSpace;
drh2e38c322004-09-03 18:38:44 +00006428 if( newCell==0 ) return SQLITE_NOMEM;
drhb026e052007-05-02 01:34:31 +00006429 rc = fillInCell(pPage, newCell, pKey, nKey, pData, nData, nZero, &szNew);
drh2e38c322004-09-03 18:38:44 +00006430 if( rc ) goto end_insert;
drh43605152004-05-29 21:46:49 +00006431 assert( szNew==cellSizePtr(pPage, newCell) );
drh2e38c322004-09-03 18:38:44 +00006432 assert( szNew<=MX_CELL_SIZE(pBt) );
danielk197771d5d2c2008-09-29 11:49:47 +00006433 idx = pCur->aiIdx[pCur->iPage];
danielk1977b980d2212009-06-22 18:03:51 +00006434 if( loc==0 ){
drha9121e42008-02-19 14:59:35 +00006435 u16 szOld;
danielk197771d5d2c2008-09-29 11:49:47 +00006436 assert( idx<pPage->nCell );
danielk19776e465eb2007-08-21 13:11:00 +00006437 rc = sqlite3PagerWrite(pPage->pDbPage);
6438 if( rc ){
6439 goto end_insert;
6440 }
danielk197771d5d2c2008-09-29 11:49:47 +00006441 oldCell = findCell(pPage, idx);
drh4b70f112004-05-02 21:12:19 +00006442 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00006443 memcpy(newCell, oldCell, 4);
drh4b70f112004-05-02 21:12:19 +00006444 }
drh43605152004-05-29 21:46:49 +00006445 szOld = cellSizePtr(pPage, oldCell);
drh4b70f112004-05-02 21:12:19 +00006446 rc = clearCell(pPage, oldCell);
drh2e38c322004-09-03 18:38:44 +00006447 if( rc ) goto end_insert;
shane0af3f892008-11-12 04:55:34 +00006448 rc = dropCell(pPage, idx, szOld);
6449 if( rc!=SQLITE_OK ) {
6450 goto end_insert;
6451 }
drh7c717f72001-06-24 20:39:41 +00006452 }else if( loc<0 && pPage->nCell>0 ){
drh4b70f112004-05-02 21:12:19 +00006453 assert( pPage->leaf );
danielk197771d5d2c2008-09-29 11:49:47 +00006454 idx = ++pCur->aiIdx[pCur->iPage];
drh14acc042001-06-10 19:56:58 +00006455 }else{
drh4b70f112004-05-02 21:12:19 +00006456 assert( pPage->leaf );
drh3b7511c2001-05-26 13:15:44 +00006457 }
danielk197771d5d2c2008-09-29 11:49:47 +00006458 rc = insertCell(pPage, idx, newCell, szNew, 0, 0);
danielk19773f632d52009-05-02 10:03:09 +00006459 assert( rc!=SQLITE_OK || pPage->nCell>0 || pPage->nOverflow>0 );
drh9bf9e9c2008-12-05 20:01:43 +00006460
danielk1977a50d9aa2009-06-08 14:49:45 +00006461 /* If no error has occured and pPage has an overflow cell, call balance()
6462 ** to redistribute the cells within the tree. Since balance() may move
6463 ** the cursor, zero the BtCursor.info.nSize and BtCursor.validNKey
6464 ** variables.
danielk19773f632d52009-05-02 10:03:09 +00006465 **
danielk1977a50d9aa2009-06-08 14:49:45 +00006466 ** Previous versions of SQLite called moveToRoot() to move the cursor
6467 ** back to the root page as balance() used to invalidate the contents
danielk197754109bb2009-06-23 11:22:29 +00006468 ** of BtCursor.apPage[] and BtCursor.aiIdx[]. Instead of doing that,
6469 ** set the cursor state to "invalid". This makes common insert operations
6470 ** slightly faster.
danielk19773f632d52009-05-02 10:03:09 +00006471 **
danielk1977a50d9aa2009-06-08 14:49:45 +00006472 ** There is a subtle but important optimization here too. When inserting
6473 ** multiple records into an intkey b-tree using a single cursor (as can
6474 ** happen while processing an "INSERT INTO ... SELECT" statement), it
6475 ** is advantageous to leave the cursor pointing to the last entry in
6476 ** the b-tree if possible. If the cursor is left pointing to the last
6477 ** entry in the table, and the next row inserted has an integer key
6478 ** larger than the largest existing key, it is possible to insert the
6479 ** row without seeking the cursor. This can be a big performance boost.
danielk19773f632d52009-05-02 10:03:09 +00006480 */
danielk1977a50d9aa2009-06-08 14:49:45 +00006481 pCur->info.nSize = 0;
6482 pCur->validNKey = 0;
6483 if( rc==SQLITE_OK && pPage->nOverflow ){
danielk1977a50d9aa2009-06-08 14:49:45 +00006484 rc = balance(pCur);
6485
6486 /* Must make sure nOverflow is reset to zero even if the balance()
danielk197754109bb2009-06-23 11:22:29 +00006487 ** fails. Internal data structure corruption will result otherwise.
6488 ** Also, set the cursor state to invalid. This stops saveCursorPosition()
6489 ** from trying to save the current position of the cursor. */
danielk1977a50d9aa2009-06-08 14:49:45 +00006490 pCur->apPage[pCur->iPage]->nOverflow = 0;
danielk197754109bb2009-06-23 11:22:29 +00006491 pCur->eState = CURSOR_INVALID;
danielk19773f632d52009-05-02 10:03:09 +00006492 }
danielk1977a50d9aa2009-06-08 14:49:45 +00006493 assert( pCur->apPage[pCur->iPage]->nOverflow==0 );
drh9bf9e9c2008-12-05 20:01:43 +00006494
drh2e38c322004-09-03 18:38:44 +00006495end_insert:
drh5e2f8b92001-05-28 00:41:15 +00006496 return rc;
6497}
6498
6499/*
drh4b70f112004-05-02 21:12:19 +00006500** Delete the entry that the cursor is pointing to. The cursor
drhf94a1732008-09-30 17:18:17 +00006501** is left pointing at a arbitrary location.
drh3b7511c2001-05-26 13:15:44 +00006502*/
drh3aac2dd2004-04-26 14:10:20 +00006503int sqlite3BtreeDelete(BtCursor *pCur){
drhd677b3d2007-08-20 22:48:41 +00006504 Btree *p = pCur->pBtree;
danielk19774dbaa892009-06-16 16:50:22 +00006505 BtShared *pBt = p->pBt;
6506 int rc; /* Return code */
6507 MemPage *pPage; /* Page to delete cell from */
6508 unsigned char *pCell; /* Pointer to cell to delete */
6509 int iCellIdx; /* Index of cell to delete */
6510 int iCellDepth; /* Depth of node containing pCell */
drh8b2f49b2001-06-08 00:21:52 +00006511
drh1fee73e2007-08-29 04:00:57 +00006512 assert( cursorHoldsMutex(pCur) );
drh64022502009-01-09 14:11:04 +00006513 assert( pBt->inTransaction==TRANS_WRITE );
drhf74b8d92002-09-01 23:20:45 +00006514 assert( !pBt->readOnly );
drh64022502009-01-09 14:11:04 +00006515 assert( pCur->wrFlag );
danielk197796d48e92009-06-29 06:00:37 +00006516 assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
6517 assert( !hasReadConflicts(p, pCur->pgnoRoot) );
6518
danielk19774dbaa892009-06-16 16:50:22 +00006519 if( NEVER(pCur->aiIdx[pCur->iPage]>=pCur->apPage[pCur->iPage]->nCell)
6520 || NEVER(pCur->eState!=CURSOR_VALID)
6521 ){
6522 return SQLITE_ERROR; /* Something has gone awry. */
drhf74b8d92002-09-01 23:20:45 +00006523 }
danielk1977da184232006-01-05 11:34:32 +00006524
danielk197796d48e92009-06-29 06:00:37 +00006525 /* If this is a delete operation to remove a row from a table b-tree,
6526 ** invalidate any incrblob cursors open on the row being deleted. */
6527 if( pCur->pKeyInfo==0 ){
6528 invalidateIncrblobCursors(p, pCur->pgnoRoot, pCur->info.nKey, 0);
danielk19774dbaa892009-06-16 16:50:22 +00006529 }
6530
6531 iCellDepth = pCur->iPage;
6532 iCellIdx = pCur->aiIdx[iCellDepth];
6533 pPage = pCur->apPage[iCellDepth];
6534 pCell = findCell(pPage, iCellIdx);
6535
6536 /* If the page containing the entry to delete is not a leaf page, move
6537 ** the cursor to the largest entry in the tree that is smaller than
6538 ** the entry being deleted. This cell will replace the cell being deleted
6539 ** from the internal node. The 'previous' entry is used for this instead
6540 ** of the 'next' entry, as the previous entry is always a part of the
6541 ** sub-tree headed by the child page of the cell being deleted. This makes
6542 ** balancing the tree following the delete operation easier. */
6543 if( !pPage->leaf ){
6544 int notUsed;
6545 if( SQLITE_OK!=(rc = sqlite3BtreePrevious(pCur, &notUsed)) ){
6546 return rc;
6547 }
6548 }
6549
6550 /* Save the positions of any other cursors open on this table before
6551 ** making any modifications. Make the page containing the entry to be
6552 ** deleted writable. Then free any overflow pages associated with the
6553 ** entry and finally remove the cell itself from within the page. */
6554 if( SQLITE_OK!=(rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur))
6555 || SQLITE_OK!=(rc = sqlite3PagerWrite(pPage->pDbPage))
6556 || SQLITE_OK!=(rc = clearCell(pPage, pCell))
6557 || SQLITE_OK!=(rc = dropCell(pPage, iCellIdx, cellSizePtr(pPage, pCell)))
danielk1977da184232006-01-05 11:34:32 +00006558 ){
6559 return rc;
6560 }
danielk1977e6efa742004-11-10 11:55:10 +00006561
danielk19774dbaa892009-06-16 16:50:22 +00006562 /* If the cell deleted was not located on a leaf page, then the cursor
6563 ** is currently pointing to the largest entry in the sub-tree headed
6564 ** by the child-page of the cell that was just deleted from an internal
6565 ** node. The cell from the leaf node needs to be moved to the internal
6566 ** node to replace the deleted cell. */
drh4b70f112004-05-02 21:12:19 +00006567 if( !pPage->leaf ){
danielk19774dbaa892009-06-16 16:50:22 +00006568 MemPage *pLeaf = pCur->apPage[pCur->iPage];
6569 int nCell;
6570 Pgno n = pCur->apPage[iCellDepth+1]->pgno;
6571 unsigned char *pTmp;
danielk1977e6efa742004-11-10 11:55:10 +00006572
danielk19774dbaa892009-06-16 16:50:22 +00006573 pCell = findCell(pLeaf, pLeaf->nCell-1);
6574 nCell = cellSizePtr(pLeaf, pCell);
6575 assert( MX_CELL_SIZE(pBt)>=nCell );
danielk197771d5d2c2008-09-29 11:49:47 +00006576
danielk19774dbaa892009-06-16 16:50:22 +00006577 allocateTempSpace(pBt);
6578 pTmp = pBt->pTmpSpace;
danielk19772f78fc62008-09-30 09:31:45 +00006579
danielk19774dbaa892009-06-16 16:50:22 +00006580 if( SQLITE_OK!=(rc = sqlite3PagerWrite(pLeaf->pDbPage))
6581 || SQLITE_OK!=(rc = insertCell(pPage, iCellIdx, pCell-4, nCell+4, pTmp, n))
6582 || SQLITE_OK!=(rc = dropCell(pLeaf, pLeaf->nCell-1, nCell))
6583 ){
6584 return rc;
shanedcc50b72008-11-13 18:29:50 +00006585 }
drh5e2f8b92001-05-28 00:41:15 +00006586 }
danielk19774dbaa892009-06-16 16:50:22 +00006587
6588 /* Balance the tree. If the entry deleted was located on a leaf page,
6589 ** then the cursor still points to that page. In this case the first
6590 ** call to balance() repairs the tree, and the if(...) condition is
6591 ** never true.
6592 **
6593 ** Otherwise, if the entry deleted was on an internal node page, then
6594 ** pCur is pointing to the leaf page from which a cell was removed to
6595 ** replace the cell deleted from the internal node. This is slightly
6596 ** tricky as the leaf node may be underfull, and the internal node may
6597 ** be either under or overfull. In this case run the balancing algorithm
6598 ** on the leaf node first. If the balance proceeds far enough up the
6599 ** tree that we can be sure that any problem in the internal node has
6600 ** been corrected, so be it. Otherwise, after balancing the leaf node,
6601 ** walk the cursor up the tree to the internal node and balance it as
6602 ** well. */
6603 rc = balance(pCur);
6604 if( rc==SQLITE_OK && pCur->iPage>iCellDepth ){
6605 while( pCur->iPage>iCellDepth ){
6606 releasePage(pCur->apPage[pCur->iPage--]);
6607 }
6608 rc = balance(pCur);
6609 }
6610
danielk19776b456a22005-03-21 04:04:02 +00006611 if( rc==SQLITE_OK ){
6612 moveToRoot(pCur);
6613 }
drh5e2f8b92001-05-28 00:41:15 +00006614 return rc;
drh3b7511c2001-05-26 13:15:44 +00006615}
drh8b2f49b2001-06-08 00:21:52 +00006616
6617/*
drhc6b52df2002-01-04 03:09:29 +00006618** Create a new BTree table. Write into *piTable the page
6619** number for the root page of the new table.
6620**
drhab01f612004-05-22 02:55:23 +00006621** The type of type is determined by the flags parameter. Only the
6622** following values of flags are currently in use. Other values for
6623** flags might not work:
6624**
6625** BTREE_INTKEY|BTREE_LEAFDATA Used for SQL tables with rowid keys
6626** BTREE_ZERODATA Used for SQL indices
drh8b2f49b2001-06-08 00:21:52 +00006627*/
drhd677b3d2007-08-20 22:48:41 +00006628static int btreeCreateTable(Btree *p, int *piTable, int flags){
danielk1977aef0bf62005-12-30 16:28:01 +00006629 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00006630 MemPage *pRoot;
6631 Pgno pgnoRoot;
6632 int rc;
drhd677b3d2007-08-20 22:48:41 +00006633
drh1fee73e2007-08-29 04:00:57 +00006634 assert( sqlite3BtreeHoldsMutex(p) );
drh64022502009-01-09 14:11:04 +00006635 assert( pBt->inTransaction==TRANS_WRITE );
danielk197728129562005-01-11 10:25:06 +00006636 assert( !pBt->readOnly );
danielk1977e6efa742004-11-10 11:55:10 +00006637
danielk1977003ba062004-11-04 02:57:33 +00006638#ifdef SQLITE_OMIT_AUTOVACUUM
drh4f0c5872007-03-26 22:05:01 +00006639 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
drhd677b3d2007-08-20 22:48:41 +00006640 if( rc ){
6641 return rc;
6642 }
danielk1977003ba062004-11-04 02:57:33 +00006643#else
danielk1977687566d2004-11-02 12:56:41 +00006644 if( pBt->autoVacuum ){
danielk1977003ba062004-11-04 02:57:33 +00006645 Pgno pgnoMove; /* Move a page here to make room for the root-page */
6646 MemPage *pPageMove; /* The page to move to. */
6647
danielk197720713f32007-05-03 11:43:33 +00006648 /* Creating a new table may probably require moving an existing database
6649 ** to make room for the new tables root page. In case this page turns
6650 ** out to be an overflow page, delete all overflow page-map caches
6651 ** held by open cursors.
6652 */
danielk197792d4d7a2007-05-04 12:05:56 +00006653 invalidateAllOverflowCache(pBt);
danielk197720713f32007-05-03 11:43:33 +00006654
danielk1977003ba062004-11-04 02:57:33 +00006655 /* Read the value of meta[3] from the database to determine where the
6656 ** root page of the new table should go. meta[3] is the largest root-page
6657 ** created so far, so the new root-page is (meta[3]+1).
6658 */
danielk1977602b4662009-07-02 07:47:33 +00006659 sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &pgnoRoot);
danielk1977003ba062004-11-04 02:57:33 +00006660 pgnoRoot++;
6661
danielk1977599fcba2004-11-08 07:13:13 +00006662 /* The new root-page may not be allocated on a pointer-map page, or the
6663 ** PENDING_BYTE page.
6664 */
drh72190432008-01-31 14:54:43 +00006665 while( pgnoRoot==PTRMAP_PAGENO(pBt, pgnoRoot) ||
danielk1977599fcba2004-11-08 07:13:13 +00006666 pgnoRoot==PENDING_BYTE_PAGE(pBt) ){
danielk1977003ba062004-11-04 02:57:33 +00006667 pgnoRoot++;
6668 }
6669 assert( pgnoRoot>=3 );
6670
6671 /* Allocate a page. The page that currently resides at pgnoRoot will
6672 ** be moved to the allocated page (unless the allocated page happens
6673 ** to reside at pgnoRoot).
6674 */
drh4f0c5872007-03-26 22:05:01 +00006675 rc = allocateBtreePage(pBt, &pPageMove, &pgnoMove, pgnoRoot, 1);
danielk1977003ba062004-11-04 02:57:33 +00006676 if( rc!=SQLITE_OK ){
danielk1977687566d2004-11-02 12:56:41 +00006677 return rc;
6678 }
danielk1977003ba062004-11-04 02:57:33 +00006679
6680 if( pgnoMove!=pgnoRoot ){
danielk1977f35843b2007-04-07 15:03:17 +00006681 /* pgnoRoot is the page that will be used for the root-page of
6682 ** the new table (assuming an error did not occur). But we were
6683 ** allocated pgnoMove. If required (i.e. if it was not allocated
6684 ** by extending the file), the current page at position pgnoMove
6685 ** is already journaled.
6686 */
danielk1977003ba062004-11-04 02:57:33 +00006687 u8 eType;
6688 Pgno iPtrPage;
6689
6690 releasePage(pPageMove);
danielk1977f35843b2007-04-07 15:03:17 +00006691
6692 /* Move the page currently at pgnoRoot to pgnoMove. */
danielk197730548662009-07-09 05:07:37 +00006693 rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00006694 if( rc!=SQLITE_OK ){
6695 return rc;
6696 }
6697 rc = ptrmapGet(pBt, pgnoRoot, &eType, &iPtrPage);
drh27731d72009-06-22 12:05:10 +00006698 if( eType==PTRMAP_ROOTPAGE || eType==PTRMAP_FREEPAGE ){
6699 rc = SQLITE_CORRUPT_BKPT;
6700 }
6701 if( rc!=SQLITE_OK ){
danielk1977003ba062004-11-04 02:57:33 +00006702 releasePage(pRoot);
6703 return rc;
6704 }
drhccae6022005-02-26 17:31:26 +00006705 assert( eType!=PTRMAP_ROOTPAGE );
6706 assert( eType!=PTRMAP_FREEPAGE );
danielk19774c999992008-07-16 18:17:55 +00006707 rc = relocatePage(pBt, pRoot, eType, iPtrPage, pgnoMove, 0);
danielk1977003ba062004-11-04 02:57:33 +00006708 releasePage(pRoot);
danielk1977f35843b2007-04-07 15:03:17 +00006709
6710 /* Obtain the page at pgnoRoot */
danielk1977003ba062004-11-04 02:57:33 +00006711 if( rc!=SQLITE_OK ){
6712 return rc;
6713 }
danielk197730548662009-07-09 05:07:37 +00006714 rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00006715 if( rc!=SQLITE_OK ){
6716 return rc;
6717 }
danielk19773b8a05f2007-03-19 17:44:26 +00006718 rc = sqlite3PagerWrite(pRoot->pDbPage);
danielk1977003ba062004-11-04 02:57:33 +00006719 if( rc!=SQLITE_OK ){
6720 releasePage(pRoot);
6721 return rc;
6722 }
6723 }else{
6724 pRoot = pPageMove;
6725 }
6726
danielk197742741be2005-01-08 12:42:39 +00006727 /* Update the pointer-map and meta-data with the new root-page number. */
danielk1977003ba062004-11-04 02:57:33 +00006728 rc = ptrmapPut(pBt, pgnoRoot, PTRMAP_ROOTPAGE, 0);
6729 if( rc ){
6730 releasePage(pRoot);
6731 return rc;
6732 }
danielk1977aef0bf62005-12-30 16:28:01 +00006733 rc = sqlite3BtreeUpdateMeta(p, 4, pgnoRoot);
danielk1977003ba062004-11-04 02:57:33 +00006734 if( rc ){
6735 releasePage(pRoot);
6736 return rc;
6737 }
danielk197742741be2005-01-08 12:42:39 +00006738
danielk1977003ba062004-11-04 02:57:33 +00006739 }else{
drh4f0c5872007-03-26 22:05:01 +00006740 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
danielk1977003ba062004-11-04 02:57:33 +00006741 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00006742 }
6743#endif
danielk19773b8a05f2007-03-19 17:44:26 +00006744 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
drhde647132004-05-07 17:57:49 +00006745 zeroPage(pRoot, flags | PTF_LEAF);
danielk19773b8a05f2007-03-19 17:44:26 +00006746 sqlite3PagerUnref(pRoot->pDbPage);
drh8b2f49b2001-06-08 00:21:52 +00006747 *piTable = (int)pgnoRoot;
6748 return SQLITE_OK;
6749}
drhd677b3d2007-08-20 22:48:41 +00006750int sqlite3BtreeCreateTable(Btree *p, int *piTable, int flags){
6751 int rc;
6752 sqlite3BtreeEnter(p);
6753 rc = btreeCreateTable(p, piTable, flags);
6754 sqlite3BtreeLeave(p);
6755 return rc;
6756}
drh8b2f49b2001-06-08 00:21:52 +00006757
6758/*
6759** Erase the given database page and all its children. Return
6760** the page to the freelist.
6761*/
drh4b70f112004-05-02 21:12:19 +00006762static int clearDatabasePage(
danielk1977aef0bf62005-12-30 16:28:01 +00006763 BtShared *pBt, /* The BTree that contains the table */
drh4b70f112004-05-02 21:12:19 +00006764 Pgno pgno, /* Page number to clear */
danielk1977c7af4842008-10-27 13:59:33 +00006765 int freePageFlag, /* Deallocate page if true */
6766 int *pnChange
drh4b70f112004-05-02 21:12:19 +00006767){
danielk19776b456a22005-03-21 04:04:02 +00006768 MemPage *pPage = 0;
drh8b2f49b2001-06-08 00:21:52 +00006769 int rc;
drh4b70f112004-05-02 21:12:19 +00006770 unsigned char *pCell;
6771 int i;
drh8b2f49b2001-06-08 00:21:52 +00006772
drh1fee73e2007-08-29 04:00:57 +00006773 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197789d40042008-11-17 14:20:56 +00006774 if( pgno>pagerPagecount(pBt) ){
drh49285702005-09-17 15:20:26 +00006775 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00006776 }
6777
danielk197771d5d2c2008-09-29 11:49:47 +00006778 rc = getAndInitPage(pBt, pgno, &pPage);
danielk19776b456a22005-03-21 04:04:02 +00006779 if( rc ) goto cleardatabasepage_out;
drh4b70f112004-05-02 21:12:19 +00006780 for(i=0; i<pPage->nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00006781 pCell = findCell(pPage, i);
drh4b70f112004-05-02 21:12:19 +00006782 if( !pPage->leaf ){
danielk197762c14b32008-11-19 09:05:26 +00006783 rc = clearDatabasePage(pBt, get4byte(pCell), 1, pnChange);
danielk19776b456a22005-03-21 04:04:02 +00006784 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00006785 }
drh4b70f112004-05-02 21:12:19 +00006786 rc = clearCell(pPage, pCell);
danielk19776b456a22005-03-21 04:04:02 +00006787 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00006788 }
drha34b6762004-05-07 13:30:42 +00006789 if( !pPage->leaf ){
danielk197762c14b32008-11-19 09:05:26 +00006790 rc = clearDatabasePage(pBt, get4byte(&pPage->aData[8]), 1, pnChange);
danielk19776b456a22005-03-21 04:04:02 +00006791 if( rc ) goto cleardatabasepage_out;
danielk1977c7af4842008-10-27 13:59:33 +00006792 }else if( pnChange ){
6793 assert( pPage->intKey );
6794 *pnChange += pPage->nCell;
drh2aa679f2001-06-25 02:11:07 +00006795 }
6796 if( freePageFlag ){
drh4b70f112004-05-02 21:12:19 +00006797 rc = freePage(pPage);
danielk19773b8a05f2007-03-19 17:44:26 +00006798 }else if( (rc = sqlite3PagerWrite(pPage->pDbPage))==0 ){
drh3a4c1412004-05-09 20:40:11 +00006799 zeroPage(pPage, pPage->aData[0] | PTF_LEAF);
drh2aa679f2001-06-25 02:11:07 +00006800 }
danielk19776b456a22005-03-21 04:04:02 +00006801
6802cleardatabasepage_out:
drh4b70f112004-05-02 21:12:19 +00006803 releasePage(pPage);
drh2aa679f2001-06-25 02:11:07 +00006804 return rc;
drh8b2f49b2001-06-08 00:21:52 +00006805}
6806
6807/*
drhab01f612004-05-22 02:55:23 +00006808** Delete all information from a single table in the database. iTable is
6809** the page number of the root of the table. After this routine returns,
6810** the root page is empty, but still exists.
6811**
6812** This routine will fail with SQLITE_LOCKED if there are any open
6813** read cursors on the table. Open write cursors are moved to the
6814** root of the table.
danielk1977c7af4842008-10-27 13:59:33 +00006815**
6816** If pnChange is not NULL, then table iTable must be an intkey table. The
6817** integer value pointed to by pnChange is incremented by the number of
6818** entries in the table.
drh8b2f49b2001-06-08 00:21:52 +00006819*/
danielk1977c7af4842008-10-27 13:59:33 +00006820int sqlite3BtreeClearTable(Btree *p, int iTable, int *pnChange){
drh8b2f49b2001-06-08 00:21:52 +00006821 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00006822 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00006823 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00006824 assert( p->inTrans==TRANS_WRITE );
danielk197796d48e92009-06-29 06:00:37 +00006825
6826 /* Invalidate all incrblob cursors open on table iTable (assuming iTable
6827 ** is the root of a table b-tree - if it is not, the following call is
6828 ** a no-op). */
6829 invalidateIncrblobCursors(p, iTable, 0, 1);
6830
6831 if( SQLITE_OK==(rc = saveAllCursors(pBt, (Pgno)iTable, 0)) ){
danielk197762c14b32008-11-19 09:05:26 +00006832 rc = clearDatabasePage(pBt, (Pgno)iTable, 0, pnChange);
drh8b2f49b2001-06-08 00:21:52 +00006833 }
drhd677b3d2007-08-20 22:48:41 +00006834 sqlite3BtreeLeave(p);
6835 return rc;
drh8b2f49b2001-06-08 00:21:52 +00006836}
6837
6838/*
6839** Erase all information in a table and add the root of the table to
6840** the freelist. Except, the root of the principle table (the one on
drhab01f612004-05-22 02:55:23 +00006841** page 1) is never added to the freelist.
6842**
6843** This routine will fail with SQLITE_LOCKED if there are any open
6844** cursors on the table.
drh205f48e2004-11-05 00:43:11 +00006845**
6846** If AUTOVACUUM is enabled and the page at iTable is not the last
6847** root page in the database file, then the last root page
6848** in the database file is moved into the slot formerly occupied by
6849** iTable and that last slot formerly occupied by the last root page
6850** is added to the freelist instead of iTable. In this say, all
6851** root pages are kept at the beginning of the database file, which
6852** is necessary for AUTOVACUUM to work right. *piMoved is set to the
6853** page number that used to be the last root page in the file before
6854** the move. If no page gets moved, *piMoved is set to 0.
6855** The last root page is recorded in meta[3] and the value of
6856** meta[3] is updated by this procedure.
drh8b2f49b2001-06-08 00:21:52 +00006857*/
danielk197789d40042008-11-17 14:20:56 +00006858static int btreeDropTable(Btree *p, Pgno iTable, int *piMoved){
drh8b2f49b2001-06-08 00:21:52 +00006859 int rc;
danielk1977a0bf2652004-11-04 14:30:04 +00006860 MemPage *pPage = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00006861 BtShared *pBt = p->pBt;
danielk1977a0bf2652004-11-04 14:30:04 +00006862
drh1fee73e2007-08-29 04:00:57 +00006863 assert( sqlite3BtreeHoldsMutex(p) );
drh64022502009-01-09 14:11:04 +00006864 assert( p->inTrans==TRANS_WRITE );
danielk1977a0bf2652004-11-04 14:30:04 +00006865
danielk1977e6efa742004-11-10 11:55:10 +00006866 /* It is illegal to drop a table if any cursors are open on the
6867 ** database. This is because in auto-vacuum mode the backend may
6868 ** need to move another root-page to fill a gap left by the deleted
6869 ** root page. If an open cursor was using this page a problem would
6870 ** occur.
6871 */
6872 if( pBt->pCursor ){
danielk1977404ca072009-03-16 13:19:36 +00006873 sqlite3ConnectionBlocked(p->db, pBt->pCursor->pBtree->db);
6874 return SQLITE_LOCKED_SHAREDCACHE;
drh5df72a52002-06-06 23:16:05 +00006875 }
danielk1977a0bf2652004-11-04 14:30:04 +00006876
danielk197730548662009-07-09 05:07:37 +00006877 rc = btreeGetPage(pBt, (Pgno)iTable, &pPage, 0);
drh2aa679f2001-06-25 02:11:07 +00006878 if( rc ) return rc;
danielk1977c7af4842008-10-27 13:59:33 +00006879 rc = sqlite3BtreeClearTable(p, iTable, 0);
danielk19776b456a22005-03-21 04:04:02 +00006880 if( rc ){
6881 releasePage(pPage);
6882 return rc;
6883 }
danielk1977a0bf2652004-11-04 14:30:04 +00006884
drh205f48e2004-11-05 00:43:11 +00006885 *piMoved = 0;
danielk1977a0bf2652004-11-04 14:30:04 +00006886
drh4b70f112004-05-02 21:12:19 +00006887 if( iTable>1 ){
danielk1977a0bf2652004-11-04 14:30:04 +00006888#ifdef SQLITE_OMIT_AUTOVACUUM
drha34b6762004-05-07 13:30:42 +00006889 rc = freePage(pPage);
danielk1977a0bf2652004-11-04 14:30:04 +00006890 releasePage(pPage);
6891#else
6892 if( pBt->autoVacuum ){
6893 Pgno maxRootPgno;
danielk1977602b4662009-07-02 07:47:33 +00006894 sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00006895
6896 if( iTable==maxRootPgno ){
6897 /* If the table being dropped is the table with the largest root-page
6898 ** number in the database, put the root page on the free list.
6899 */
6900 rc = freePage(pPage);
6901 releasePage(pPage);
6902 if( rc!=SQLITE_OK ){
6903 return rc;
6904 }
6905 }else{
6906 /* The table being dropped does not have the largest root-page
6907 ** number in the database. So move the page that does into the
6908 ** gap left by the deleted root-page.
6909 */
6910 MemPage *pMove;
6911 releasePage(pPage);
danielk197730548662009-07-09 05:07:37 +00006912 rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00006913 if( rc!=SQLITE_OK ){
6914 return rc;
6915 }
danielk19774c999992008-07-16 18:17:55 +00006916 rc = relocatePage(pBt, pMove, PTRMAP_ROOTPAGE, 0, iTable, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00006917 releasePage(pMove);
6918 if( rc!=SQLITE_OK ){
6919 return rc;
6920 }
danielk197730548662009-07-09 05:07:37 +00006921 rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00006922 if( rc!=SQLITE_OK ){
6923 return rc;
6924 }
6925 rc = freePage(pMove);
6926 releasePage(pMove);
6927 if( rc!=SQLITE_OK ){
6928 return rc;
6929 }
6930 *piMoved = maxRootPgno;
6931 }
6932
danielk1977599fcba2004-11-08 07:13:13 +00006933 /* Set the new 'max-root-page' value in the database header. This
6934 ** is the old value less one, less one more if that happens to
6935 ** be a root-page number, less one again if that is the
6936 ** PENDING_BYTE_PAGE.
6937 */
danielk197787a6e732004-11-05 12:58:25 +00006938 maxRootPgno--;
danielk1977599fcba2004-11-08 07:13:13 +00006939 if( maxRootPgno==PENDING_BYTE_PAGE(pBt) ){
6940 maxRootPgno--;
6941 }
danielk1977266664d2006-02-10 08:24:21 +00006942 if( maxRootPgno==PTRMAP_PAGENO(pBt, maxRootPgno) ){
danielk197787a6e732004-11-05 12:58:25 +00006943 maxRootPgno--;
6944 }
danielk1977599fcba2004-11-08 07:13:13 +00006945 assert( maxRootPgno!=PENDING_BYTE_PAGE(pBt) );
6946
danielk1977aef0bf62005-12-30 16:28:01 +00006947 rc = sqlite3BtreeUpdateMeta(p, 4, maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00006948 }else{
6949 rc = freePage(pPage);
6950 releasePage(pPage);
6951 }
6952#endif
drh2aa679f2001-06-25 02:11:07 +00006953 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00006954 /* If sqlite3BtreeDropTable was called on page 1. */
drha34b6762004-05-07 13:30:42 +00006955 zeroPage(pPage, PTF_INTKEY|PTF_LEAF );
danielk1977a0bf2652004-11-04 14:30:04 +00006956 releasePage(pPage);
drh8b2f49b2001-06-08 00:21:52 +00006957 }
drh8b2f49b2001-06-08 00:21:52 +00006958 return rc;
6959}
drhd677b3d2007-08-20 22:48:41 +00006960int sqlite3BtreeDropTable(Btree *p, int iTable, int *piMoved){
6961 int rc;
6962 sqlite3BtreeEnter(p);
6963 rc = btreeDropTable(p, iTable, piMoved);
6964 sqlite3BtreeLeave(p);
6965 return rc;
6966}
drh8b2f49b2001-06-08 00:21:52 +00006967
drh001bbcb2003-03-19 03:14:00 +00006968
drh8b2f49b2001-06-08 00:21:52 +00006969/*
danielk1977602b4662009-07-02 07:47:33 +00006970** This function may only be called if the b-tree connection already
6971** has a read or write transaction open on the database.
6972**
drh23e11ca2004-05-04 17:27:28 +00006973** Read the meta-information out of a database file. Meta[0]
6974** is the number of free pages currently in the database. Meta[1]
drha3b321d2004-05-11 09:31:31 +00006975** through meta[15] are available for use by higher layers. Meta[0]
6976** is read-only, the others are read/write.
6977**
6978** The schema layer numbers meta values differently. At the schema
6979** layer (and the SetCookie and ReadCookie opcodes) the number of
6980** free pages is not visible. So Cookie[0] is the same as Meta[1].
drh8b2f49b2001-06-08 00:21:52 +00006981*/
danielk1977602b4662009-07-02 07:47:33 +00006982void sqlite3BtreeGetMeta(Btree *p, int idx, u32 *pMeta){
danielk1977aef0bf62005-12-30 16:28:01 +00006983 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00006984
drhd677b3d2007-08-20 22:48:41 +00006985 sqlite3BtreeEnter(p);
danielk1977602b4662009-07-02 07:47:33 +00006986 assert( p->inTrans>TRANS_NONE );
danielk1977e0d9e6f2009-07-03 16:25:06 +00006987 assert( SQLITE_OK==querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK) );
danielk1977602b4662009-07-02 07:47:33 +00006988 assert( pBt->pPage1 );
drh23e11ca2004-05-04 17:27:28 +00006989 assert( idx>=0 && idx<=15 );
danielk1977ea897302008-09-19 15:10:58 +00006990
danielk1977602b4662009-07-02 07:47:33 +00006991 *pMeta = get4byte(&pBt->pPage1->aData[36 + idx*4]);
drhae157872004-08-14 19:20:09 +00006992
danielk1977602b4662009-07-02 07:47:33 +00006993 /* If auto-vacuum is disabled in this build and this is an auto-vacuum
6994 ** database, mark the database as read-only. */
danielk1977003ba062004-11-04 02:57:33 +00006995#ifdef SQLITE_OMIT_AUTOVACUUM
danielk19770d19f7a2009-06-03 11:25:07 +00006996 if( idx==BTREE_LARGEST_ROOT_PAGE && *pMeta>0 ) pBt->readOnly = 1;
danielk1977003ba062004-11-04 02:57:33 +00006997#endif
drhae157872004-08-14 19:20:09 +00006998
drhd677b3d2007-08-20 22:48:41 +00006999 sqlite3BtreeLeave(p);
drh8b2f49b2001-06-08 00:21:52 +00007000}
7001
7002/*
drh23e11ca2004-05-04 17:27:28 +00007003** Write meta-information back into the database. Meta[0] is
7004** read-only and may not be written.
drh8b2f49b2001-06-08 00:21:52 +00007005*/
danielk1977aef0bf62005-12-30 16:28:01 +00007006int sqlite3BtreeUpdateMeta(Btree *p, int idx, u32 iMeta){
7007 BtShared *pBt = p->pBt;
drh4b70f112004-05-02 21:12:19 +00007008 unsigned char *pP1;
drha34b6762004-05-07 13:30:42 +00007009 int rc;
drh23e11ca2004-05-04 17:27:28 +00007010 assert( idx>=1 && idx<=15 );
drhd677b3d2007-08-20 22:48:41 +00007011 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00007012 assert( p->inTrans==TRANS_WRITE );
7013 assert( pBt->pPage1!=0 );
7014 pP1 = pBt->pPage1->aData;
7015 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
7016 if( rc==SQLITE_OK ){
7017 put4byte(&pP1[36 + idx*4], iMeta);
danielk19774152e672007-09-12 17:01:45 +00007018#ifndef SQLITE_OMIT_AUTOVACUUM
danielk19770d19f7a2009-06-03 11:25:07 +00007019 if( idx==BTREE_INCR_VACUUM ){
drh64022502009-01-09 14:11:04 +00007020 assert( pBt->autoVacuum || iMeta==0 );
7021 assert( iMeta==0 || iMeta==1 );
7022 pBt->incrVacuum = (u8)iMeta;
drhd677b3d2007-08-20 22:48:41 +00007023 }
drh64022502009-01-09 14:11:04 +00007024#endif
drh5df72a52002-06-06 23:16:05 +00007025 }
drhd677b3d2007-08-20 22:48:41 +00007026 sqlite3BtreeLeave(p);
7027 return rc;
drh8b2f49b2001-06-08 00:21:52 +00007028}
drh8c42ca92001-06-22 19:15:00 +00007029
danielk1977a5533162009-02-24 10:01:51 +00007030#ifndef SQLITE_OMIT_BTREECOUNT
7031/*
7032** The first argument, pCur, is a cursor opened on some b-tree. Count the
7033** number of entries in the b-tree and write the result to *pnEntry.
7034**
7035** SQLITE_OK is returned if the operation is successfully executed.
7036** Otherwise, if an error is encountered (i.e. an IO error or database
7037** corruption) an SQLite error code is returned.
7038*/
7039int sqlite3BtreeCount(BtCursor *pCur, i64 *pnEntry){
7040 i64 nEntry = 0; /* Value to return in *pnEntry */
7041 int rc; /* Return code */
7042 rc = moveToRoot(pCur);
7043
7044 /* Unless an error occurs, the following loop runs one iteration for each
7045 ** page in the B-Tree structure (not including overflow pages).
7046 */
7047 while( rc==SQLITE_OK ){
7048 int iIdx; /* Index of child node in parent */
7049 MemPage *pPage; /* Current page of the b-tree */
7050
7051 /* If this is a leaf page or the tree is not an int-key tree, then
7052 ** this page contains countable entries. Increment the entry counter
7053 ** accordingly.
7054 */
7055 pPage = pCur->apPage[pCur->iPage];
7056 if( pPage->leaf || !pPage->intKey ){
7057 nEntry += pPage->nCell;
7058 }
7059
7060 /* pPage is a leaf node. This loop navigates the cursor so that it
7061 ** points to the first interior cell that it points to the parent of
7062 ** the next page in the tree that has not yet been visited. The
7063 ** pCur->aiIdx[pCur->iPage] value is set to the index of the parent cell
7064 ** of the page, or to the number of cells in the page if the next page
7065 ** to visit is the right-child of its parent.
7066 **
7067 ** If all pages in the tree have been visited, return SQLITE_OK to the
7068 ** caller.
7069 */
7070 if( pPage->leaf ){
7071 do {
7072 if( pCur->iPage==0 ){
7073 /* All pages of the b-tree have been visited. Return successfully. */
7074 *pnEntry = nEntry;
7075 return SQLITE_OK;
7076 }
danielk197730548662009-07-09 05:07:37 +00007077 moveToParent(pCur);
danielk1977a5533162009-02-24 10:01:51 +00007078 }while ( pCur->aiIdx[pCur->iPage]>=pCur->apPage[pCur->iPage]->nCell );
7079
7080 pCur->aiIdx[pCur->iPage]++;
7081 pPage = pCur->apPage[pCur->iPage];
7082 }
7083
7084 /* Descend to the child node of the cell that the cursor currently
7085 ** points at. This is the right-child if (iIdx==pPage->nCell).
7086 */
7087 iIdx = pCur->aiIdx[pCur->iPage];
7088 if( iIdx==pPage->nCell ){
7089 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
7090 }else{
7091 rc = moveToChild(pCur, get4byte(findCell(pPage, iIdx)));
7092 }
7093 }
7094
shanebe217792009-03-05 04:20:31 +00007095 /* An error has occurred. Return an error code. */
danielk1977a5533162009-02-24 10:01:51 +00007096 return rc;
7097}
7098#endif
drhdd793422001-06-28 01:54:48 +00007099
drhdd793422001-06-28 01:54:48 +00007100/*
drh5eddca62001-06-30 21:53:53 +00007101** Return the pager associated with a BTree. This routine is used for
7102** testing and debugging only.
drhdd793422001-06-28 01:54:48 +00007103*/
danielk1977aef0bf62005-12-30 16:28:01 +00007104Pager *sqlite3BtreePager(Btree *p){
7105 return p->pBt->pPager;
drhdd793422001-06-28 01:54:48 +00007106}
drh5eddca62001-06-30 21:53:53 +00007107
drhb7f91642004-10-31 02:22:47 +00007108#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00007109/*
7110** Append a message to the error message string.
7111*/
drh2e38c322004-09-03 18:38:44 +00007112static void checkAppendMsg(
7113 IntegrityCk *pCheck,
7114 char *zMsg1,
7115 const char *zFormat,
7116 ...
7117){
7118 va_list ap;
drh1dcdbc02007-01-27 02:24:54 +00007119 if( !pCheck->mxErr ) return;
7120 pCheck->mxErr--;
7121 pCheck->nErr++;
drh2e38c322004-09-03 18:38:44 +00007122 va_start(ap, zFormat);
drhf089aa42008-07-08 19:34:06 +00007123 if( pCheck->errMsg.nChar ){
7124 sqlite3StrAccumAppend(&pCheck->errMsg, "\n", 1);
drh5eddca62001-06-30 21:53:53 +00007125 }
drhf089aa42008-07-08 19:34:06 +00007126 if( zMsg1 ){
7127 sqlite3StrAccumAppend(&pCheck->errMsg, zMsg1, -1);
7128 }
7129 sqlite3VXPrintf(&pCheck->errMsg, 1, zFormat, ap);
7130 va_end(ap);
drhc890fec2008-08-01 20:10:08 +00007131 if( pCheck->errMsg.mallocFailed ){
7132 pCheck->mallocFailed = 1;
7133 }
drh5eddca62001-06-30 21:53:53 +00007134}
drhb7f91642004-10-31 02:22:47 +00007135#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00007136
drhb7f91642004-10-31 02:22:47 +00007137#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00007138/*
7139** Add 1 to the reference count for page iPage. If this is the second
7140** reference to the page, add an error message to pCheck->zErrMsg.
7141** Return 1 if there are 2 ore more references to the page and 0 if
7142** if this is the first reference to the page.
7143**
7144** Also check that the page number is in bounds.
7145*/
danielk197789d40042008-11-17 14:20:56 +00007146static int checkRef(IntegrityCk *pCheck, Pgno iPage, char *zContext){
drh5eddca62001-06-30 21:53:53 +00007147 if( iPage==0 ) return 1;
danielk197789d40042008-11-17 14:20:56 +00007148 if( iPage>pCheck->nPage ){
drh2e38c322004-09-03 18:38:44 +00007149 checkAppendMsg(pCheck, zContext, "invalid page number %d", iPage);
drh5eddca62001-06-30 21:53:53 +00007150 return 1;
7151 }
7152 if( pCheck->anRef[iPage]==1 ){
drh2e38c322004-09-03 18:38:44 +00007153 checkAppendMsg(pCheck, zContext, "2nd reference to page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00007154 return 1;
7155 }
7156 return (pCheck->anRef[iPage]++)>1;
7157}
7158
danielk1977afcdd022004-10-31 16:25:42 +00007159#ifndef SQLITE_OMIT_AUTOVACUUM
7160/*
7161** Check that the entry in the pointer-map for page iChild maps to
7162** page iParent, pointer type ptrType. If not, append an error message
7163** to pCheck.
7164*/
7165static void checkPtrmap(
7166 IntegrityCk *pCheck, /* Integrity check context */
7167 Pgno iChild, /* Child page number */
7168 u8 eType, /* Expected pointer map type */
7169 Pgno iParent, /* Expected pointer map parent page number */
7170 char *zContext /* Context description (used for error msg) */
7171){
7172 int rc;
7173 u8 ePtrmapType;
7174 Pgno iPtrmapParent;
7175
7176 rc = ptrmapGet(pCheck->pBt, iChild, &ePtrmapType, &iPtrmapParent);
7177 if( rc!=SQLITE_OK ){
drhb56cd552009-05-01 13:16:54 +00007178 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ) pCheck->mallocFailed = 1;
danielk1977afcdd022004-10-31 16:25:42 +00007179 checkAppendMsg(pCheck, zContext, "Failed to read ptrmap key=%d", iChild);
7180 return;
7181 }
7182
7183 if( ePtrmapType!=eType || iPtrmapParent!=iParent ){
7184 checkAppendMsg(pCheck, zContext,
7185 "Bad ptr map entry key=%d expected=(%d,%d) got=(%d,%d)",
7186 iChild, eType, iParent, ePtrmapType, iPtrmapParent);
7187 }
7188}
7189#endif
7190
drh5eddca62001-06-30 21:53:53 +00007191/*
7192** Check the integrity of the freelist or of an overflow page list.
7193** Verify that the number of pages on the list is N.
7194*/
drh30e58752002-03-02 20:41:57 +00007195static void checkList(
7196 IntegrityCk *pCheck, /* Integrity checking context */
7197 int isFreeList, /* True for a freelist. False for overflow page list */
7198 int iPage, /* Page number for first page in the list */
7199 int N, /* Expected number of pages in the list */
7200 char *zContext /* Context for error messages */
7201){
7202 int i;
drh3a4c1412004-05-09 20:40:11 +00007203 int expected = N;
7204 int iFirst = iPage;
drh1dcdbc02007-01-27 02:24:54 +00007205 while( N-- > 0 && pCheck->mxErr ){
danielk19773b8a05f2007-03-19 17:44:26 +00007206 DbPage *pOvflPage;
7207 unsigned char *pOvflData;
drh5eddca62001-06-30 21:53:53 +00007208 if( iPage<1 ){
drh2e38c322004-09-03 18:38:44 +00007209 checkAppendMsg(pCheck, zContext,
7210 "%d of %d pages missing from overflow list starting at %d",
drh3a4c1412004-05-09 20:40:11 +00007211 N+1, expected, iFirst);
drh5eddca62001-06-30 21:53:53 +00007212 break;
7213 }
7214 if( checkRef(pCheck, iPage, zContext) ) break;
danielk19773b8a05f2007-03-19 17:44:26 +00007215 if( sqlite3PagerGet(pCheck->pPager, (Pgno)iPage, &pOvflPage) ){
drh2e38c322004-09-03 18:38:44 +00007216 checkAppendMsg(pCheck, zContext, "failed to get page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00007217 break;
7218 }
danielk19773b8a05f2007-03-19 17:44:26 +00007219 pOvflData = (unsigned char *)sqlite3PagerGetData(pOvflPage);
drh30e58752002-03-02 20:41:57 +00007220 if( isFreeList ){
danielk19773b8a05f2007-03-19 17:44:26 +00007221 int n = get4byte(&pOvflData[4]);
danielk1977687566d2004-11-02 12:56:41 +00007222#ifndef SQLITE_OMIT_AUTOVACUUM
7223 if( pCheck->pBt->autoVacuum ){
7224 checkPtrmap(pCheck, iPage, PTRMAP_FREEPAGE, 0, zContext);
7225 }
7226#endif
drh45b1fac2008-07-04 17:52:42 +00007227 if( n>pCheck->pBt->usableSize/4-2 ){
drh2e38c322004-09-03 18:38:44 +00007228 checkAppendMsg(pCheck, zContext,
7229 "freelist leaf count too big on page %d", iPage);
drhee696e22004-08-30 16:52:17 +00007230 N--;
7231 }else{
7232 for(i=0; i<n; i++){
danielk19773b8a05f2007-03-19 17:44:26 +00007233 Pgno iFreePage = get4byte(&pOvflData[8+i*4]);
danielk1977687566d2004-11-02 12:56:41 +00007234#ifndef SQLITE_OMIT_AUTOVACUUM
7235 if( pCheck->pBt->autoVacuum ){
7236 checkPtrmap(pCheck, iFreePage, PTRMAP_FREEPAGE, 0, zContext);
7237 }
7238#endif
7239 checkRef(pCheck, iFreePage, zContext);
drhee696e22004-08-30 16:52:17 +00007240 }
7241 N -= n;
drh30e58752002-03-02 20:41:57 +00007242 }
drh30e58752002-03-02 20:41:57 +00007243 }
danielk1977afcdd022004-10-31 16:25:42 +00007244#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00007245 else{
7246 /* If this database supports auto-vacuum and iPage is not the last
7247 ** page in this overflow list, check that the pointer-map entry for
7248 ** the following page matches iPage.
7249 */
7250 if( pCheck->pBt->autoVacuum && N>0 ){
danielk19773b8a05f2007-03-19 17:44:26 +00007251 i = get4byte(pOvflData);
danielk1977687566d2004-11-02 12:56:41 +00007252 checkPtrmap(pCheck, i, PTRMAP_OVERFLOW2, iPage, zContext);
7253 }
danielk1977afcdd022004-10-31 16:25:42 +00007254 }
7255#endif
danielk19773b8a05f2007-03-19 17:44:26 +00007256 iPage = get4byte(pOvflData);
7257 sqlite3PagerUnref(pOvflPage);
drh5eddca62001-06-30 21:53:53 +00007258 }
7259}
drhb7f91642004-10-31 02:22:47 +00007260#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00007261
drhb7f91642004-10-31 02:22:47 +00007262#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00007263/*
7264** Do various sanity checks on a single page of a tree. Return
7265** the tree depth. Root pages return 0. Parents of root pages
7266** return 1, and so forth.
7267**
7268** These checks are done:
7269**
7270** 1. Make sure that cells and freeblocks do not overlap
7271** but combine to completely cover the page.
drhda200cc2004-05-09 11:51:38 +00007272** NO 2. Make sure cell keys are in order.
7273** NO 3. Make sure no key is less than or equal to zLowerBound.
7274** NO 4. Make sure no key is greater than or equal to zUpperBound.
drh5eddca62001-06-30 21:53:53 +00007275** 5. Check the integrity of overflow pages.
7276** 6. Recursively call checkTreePage on all children.
7277** 7. Verify that the depth of all children is the same.
drh6019e162001-07-02 17:51:45 +00007278** 8. Make sure this page is at least 33% full or else it is
drh5eddca62001-06-30 21:53:53 +00007279** the root of the tree.
7280*/
7281static int checkTreePage(
drhaaab5722002-02-19 13:39:21 +00007282 IntegrityCk *pCheck, /* Context for the sanity check */
drh5eddca62001-06-30 21:53:53 +00007283 int iPage, /* Page number of the page to check */
drh74161702006-02-24 02:53:49 +00007284 char *zParentContext /* Parent context */
drh5eddca62001-06-30 21:53:53 +00007285){
7286 MemPage *pPage;
drhda200cc2004-05-09 11:51:38 +00007287 int i, rc, depth, d2, pgno, cnt;
drh43605152004-05-29 21:46:49 +00007288 int hdr, cellStart;
7289 int nCell;
drhda200cc2004-05-09 11:51:38 +00007290 u8 *data;
danielk1977aef0bf62005-12-30 16:28:01 +00007291 BtShared *pBt;
drh4f26bb62005-09-08 14:17:20 +00007292 int usableSize;
drh5eddca62001-06-30 21:53:53 +00007293 char zContext[100];
shane0af3f892008-11-12 04:55:34 +00007294 char *hit = 0;
drh5eddca62001-06-30 21:53:53 +00007295
drh5bb3eb92007-05-04 13:15:55 +00007296 sqlite3_snprintf(sizeof(zContext), zContext, "Page %d: ", iPage);
danielk1977ef73ee92004-11-06 12:26:07 +00007297
drh5eddca62001-06-30 21:53:53 +00007298 /* Check that the page exists
7299 */
drhd9cb6ac2005-10-20 07:28:17 +00007300 pBt = pCheck->pBt;
drhb6f41482004-05-14 01:58:11 +00007301 usableSize = pBt->usableSize;
drh5eddca62001-06-30 21:53:53 +00007302 if( iPage==0 ) return 0;
7303 if( checkRef(pCheck, iPage, zParentContext) ) return 0;
danielk197730548662009-07-09 05:07:37 +00007304 if( (rc = btreeGetPage(pBt, (Pgno)iPage, &pPage, 0))!=0 ){
drhb56cd552009-05-01 13:16:54 +00007305 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ) pCheck->mallocFailed = 1;
drh2e38c322004-09-03 18:38:44 +00007306 checkAppendMsg(pCheck, zContext,
7307 "unable to get the page. error code=%d", rc);
drh5eddca62001-06-30 21:53:53 +00007308 return 0;
7309 }
danielk197730548662009-07-09 05:07:37 +00007310 if( (rc = btreeInitPage(pPage))!=0 ){
drh64022502009-01-09 14:11:04 +00007311 assert( rc==SQLITE_CORRUPT ); /* The only possible error from InitPage */
drh16a9b832007-05-05 18:39:25 +00007312 checkAppendMsg(pCheck, zContext,
danielk197730548662009-07-09 05:07:37 +00007313 "btreeInitPage() returns error code %d", rc);
drh91025292004-05-03 19:49:32 +00007314 releasePage(pPage);
drh5eddca62001-06-30 21:53:53 +00007315 return 0;
7316 }
7317
7318 /* Check out all the cells.
7319 */
7320 depth = 0;
drh1dcdbc02007-01-27 02:24:54 +00007321 for(i=0; i<pPage->nCell && pCheck->mxErr; i++){
drh6f11bef2004-05-13 01:12:56 +00007322 u8 *pCell;
danielk197789d40042008-11-17 14:20:56 +00007323 u32 sz;
drh6f11bef2004-05-13 01:12:56 +00007324 CellInfo info;
drh5eddca62001-06-30 21:53:53 +00007325
7326 /* Check payload overflow pages
7327 */
drh5bb3eb92007-05-04 13:15:55 +00007328 sqlite3_snprintf(sizeof(zContext), zContext,
7329 "On tree page %d cell %d: ", iPage, i);
danielk19771cc5ed82007-05-16 17:28:43 +00007330 pCell = findCell(pPage,i);
danielk197730548662009-07-09 05:07:37 +00007331 btreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00007332 sz = info.nData;
drhf49661a2008-12-10 16:45:50 +00007333 if( !pPage->intKey ) sz += (int)info.nKey;
drh72365832007-03-06 15:53:44 +00007334 assert( sz==info.nPayload );
danielk19775be31f52009-03-30 13:53:43 +00007335 if( (sz>info.nLocal)
7336 && (&pCell[info.iOverflow]<=&pPage->aData[pBt->usableSize])
7337 ){
drhb6f41482004-05-14 01:58:11 +00007338 int nPage = (sz - info.nLocal + usableSize - 5)/(usableSize - 4);
danielk1977afcdd022004-10-31 16:25:42 +00007339 Pgno pgnoOvfl = get4byte(&pCell[info.iOverflow]);
7340#ifndef SQLITE_OMIT_AUTOVACUUM
7341 if( pBt->autoVacuum ){
danielk1977687566d2004-11-02 12:56:41 +00007342 checkPtrmap(pCheck, pgnoOvfl, PTRMAP_OVERFLOW1, iPage, zContext);
danielk1977afcdd022004-10-31 16:25:42 +00007343 }
7344#endif
7345 checkList(pCheck, 0, pgnoOvfl, nPage, zContext);
drh5eddca62001-06-30 21:53:53 +00007346 }
7347
7348 /* Check sanity of left child page.
7349 */
drhda200cc2004-05-09 11:51:38 +00007350 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00007351 pgno = get4byte(pCell);
danielk1977afcdd022004-10-31 16:25:42 +00007352#ifndef SQLITE_OMIT_AUTOVACUUM
7353 if( pBt->autoVacuum ){
7354 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, zContext);
7355 }
7356#endif
danielk197762c14b32008-11-19 09:05:26 +00007357 d2 = checkTreePage(pCheck, pgno, zContext);
drhda200cc2004-05-09 11:51:38 +00007358 if( i>0 && d2!=depth ){
7359 checkAppendMsg(pCheck, zContext, "Child page depth differs");
7360 }
7361 depth = d2;
drh5eddca62001-06-30 21:53:53 +00007362 }
drh5eddca62001-06-30 21:53:53 +00007363 }
drhda200cc2004-05-09 11:51:38 +00007364 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00007365 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh5bb3eb92007-05-04 13:15:55 +00007366 sqlite3_snprintf(sizeof(zContext), zContext,
7367 "On page %d at right child: ", iPage);
danielk1977afcdd022004-10-31 16:25:42 +00007368#ifndef SQLITE_OMIT_AUTOVACUUM
7369 if( pBt->autoVacuum ){
danielk1977687566d2004-11-02 12:56:41 +00007370 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, 0);
danielk1977afcdd022004-10-31 16:25:42 +00007371 }
7372#endif
danielk197762c14b32008-11-19 09:05:26 +00007373 checkTreePage(pCheck, pgno, zContext);
drhda200cc2004-05-09 11:51:38 +00007374 }
drh5eddca62001-06-30 21:53:53 +00007375
7376 /* Check for complete coverage of the page
7377 */
drhda200cc2004-05-09 11:51:38 +00007378 data = pPage->aData;
7379 hdr = pPage->hdrOffset;
drhf7141992008-06-19 00:16:08 +00007380 hit = sqlite3PageMalloc( pBt->pageSize );
drhc890fec2008-08-01 20:10:08 +00007381 if( hit==0 ){
7382 pCheck->mallocFailed = 1;
7383 }else{
shane5780ebd2008-11-11 17:36:30 +00007384 u16 contentOffset = get2byte(&data[hdr+5]);
7385 if (contentOffset > usableSize) {
7386 checkAppendMsg(pCheck, 0,
7387 "Corruption detected in header on page %d",iPage,0);
shane0af3f892008-11-12 04:55:34 +00007388 goto check_page_abort;
shane5780ebd2008-11-11 17:36:30 +00007389 }
7390 memset(hit+contentOffset, 0, usableSize-contentOffset);
7391 memset(hit, 1, contentOffset);
drh2e38c322004-09-03 18:38:44 +00007392 nCell = get2byte(&data[hdr+3]);
7393 cellStart = hdr + 12 - 4*pPage->leaf;
7394 for(i=0; i<nCell; i++){
7395 int pc = get2byte(&data[cellStart+i*2]);
danielk1977daca5432008-08-25 11:57:16 +00007396 u16 size = 1024;
drh2e38c322004-09-03 18:38:44 +00007397 int j;
drh8c2bbb62009-07-10 02:52:20 +00007398 if( pc<=usableSize-4 ){
danielk1977daca5432008-08-25 11:57:16 +00007399 size = cellSizePtr(pPage, &data[pc]);
7400 }
danielk19777701e812005-01-10 12:59:51 +00007401 if( (pc+size-1)>=usableSize || pc<0 ){
7402 checkAppendMsg(pCheck, 0,
7403 "Corruption detected in cell %d on page %d",i,iPage,0);
7404 }else{
7405 for(j=pc+size-1; j>=pc; j--) hit[j]++;
7406 }
drh2e38c322004-09-03 18:38:44 +00007407 }
drh8c2bbb62009-07-10 02:52:20 +00007408 i = get2byte(&data[hdr+1]);
7409 while( i>0 ){
7410 int size, j;
7411 assert( i<=usableSize-4 ); /* Enforced by btreeInitPage() */
7412 size = get2byte(&data[i+2]);
7413 assert( i+size<=usableSize ); /* Enforced by btreeInitPage() */
7414 for(j=i+size-1; j>=i; j--) hit[j]++;
7415 j = get2byte(&data[i]);
7416 assert( j==0 || j>i+size ); /* Enforced by btreeInitPage() */
7417 assert( j<=usableSize-4 ); /* Enforced by btreeInitPage() */
7418 i = j;
drh2e38c322004-09-03 18:38:44 +00007419 }
7420 for(i=cnt=0; i<usableSize; i++){
7421 if( hit[i]==0 ){
7422 cnt++;
7423 }else if( hit[i]>1 ){
7424 checkAppendMsg(pCheck, 0,
7425 "Multiple uses for byte %d of page %d", i, iPage);
7426 break;
7427 }
7428 }
7429 if( cnt!=data[hdr+7] ){
7430 checkAppendMsg(pCheck, 0,
drh8c2bbb62009-07-10 02:52:20 +00007431 "Fragmentation of %d bytes reported as %d on page %d",
drh2e38c322004-09-03 18:38:44 +00007432 cnt, data[hdr+7], iPage);
drh5eddca62001-06-30 21:53:53 +00007433 }
7434 }
shane0af3f892008-11-12 04:55:34 +00007435check_page_abort:
drh8c2bbb62009-07-10 02:52:20 +00007436 sqlite3PageFree(hit);
drh4b70f112004-05-02 21:12:19 +00007437 releasePage(pPage);
drhda200cc2004-05-09 11:51:38 +00007438 return depth+1;
drh5eddca62001-06-30 21:53:53 +00007439}
drhb7f91642004-10-31 02:22:47 +00007440#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00007441
drhb7f91642004-10-31 02:22:47 +00007442#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00007443/*
7444** This routine does a complete check of the given BTree file. aRoot[] is
7445** an array of pages numbers were each page number is the root page of
7446** a table. nRoot is the number of entries in aRoot.
7447**
danielk19773509a652009-07-06 18:56:13 +00007448** A read-only or read-write transaction must be opened before calling
7449** this function.
7450**
drhc890fec2008-08-01 20:10:08 +00007451** Write the number of error seen in *pnErr. Except for some memory
drhe43ba702008-12-05 22:40:08 +00007452** allocation errors, an error message held in memory obtained from
drhc890fec2008-08-01 20:10:08 +00007453** malloc is returned if *pnErr is non-zero. If *pnErr==0 then NULL is
drhe43ba702008-12-05 22:40:08 +00007454** returned. If a memory allocation error occurs, NULL is returned.
drh5eddca62001-06-30 21:53:53 +00007455*/
drh1dcdbc02007-01-27 02:24:54 +00007456char *sqlite3BtreeIntegrityCheck(
7457 Btree *p, /* The btree to be checked */
7458 int *aRoot, /* An array of root pages numbers for individual trees */
7459 int nRoot, /* Number of entries in aRoot[] */
7460 int mxErr, /* Stop reporting errors after this many */
7461 int *pnErr /* Write number of errors seen to this variable */
7462){
danielk197789d40042008-11-17 14:20:56 +00007463 Pgno i;
drh5eddca62001-06-30 21:53:53 +00007464 int nRef;
drhaaab5722002-02-19 13:39:21 +00007465 IntegrityCk sCheck;
danielk1977aef0bf62005-12-30 16:28:01 +00007466 BtShared *pBt = p->pBt;
drhf089aa42008-07-08 19:34:06 +00007467 char zErr[100];
drh5eddca62001-06-30 21:53:53 +00007468
drhd677b3d2007-08-20 22:48:41 +00007469 sqlite3BtreeEnter(p);
danielk19773509a652009-07-06 18:56:13 +00007470 assert( p->inTrans>TRANS_NONE && pBt->inTransaction>TRANS_NONE );
danielk19773b8a05f2007-03-19 17:44:26 +00007471 nRef = sqlite3PagerRefcount(pBt->pPager);
drh5eddca62001-06-30 21:53:53 +00007472 sCheck.pBt = pBt;
7473 sCheck.pPager = pBt->pPager;
danielk197789d40042008-11-17 14:20:56 +00007474 sCheck.nPage = pagerPagecount(sCheck.pBt);
drh1dcdbc02007-01-27 02:24:54 +00007475 sCheck.mxErr = mxErr;
7476 sCheck.nErr = 0;
drhc890fec2008-08-01 20:10:08 +00007477 sCheck.mallocFailed = 0;
drh1dcdbc02007-01-27 02:24:54 +00007478 *pnErr = 0;
drh0de8c112002-07-06 16:32:14 +00007479 if( sCheck.nPage==0 ){
drhd677b3d2007-08-20 22:48:41 +00007480 sqlite3BtreeLeave(p);
drh0de8c112002-07-06 16:32:14 +00007481 return 0;
7482 }
drhe5ae5732008-06-15 02:51:47 +00007483 sCheck.anRef = sqlite3Malloc( (sCheck.nPage+1)*sizeof(sCheck.anRef[0]) );
danielk1977ac245ec2005-01-14 13:50:11 +00007484 if( !sCheck.anRef ){
drh1dcdbc02007-01-27 02:24:54 +00007485 *pnErr = 1;
drhd677b3d2007-08-20 22:48:41 +00007486 sqlite3BtreeLeave(p);
drhc890fec2008-08-01 20:10:08 +00007487 return 0;
danielk1977ac245ec2005-01-14 13:50:11 +00007488 }
drhda200cc2004-05-09 11:51:38 +00007489 for(i=0; i<=sCheck.nPage; i++){ sCheck.anRef[i] = 0; }
drh42cac6d2004-11-20 20:31:11 +00007490 i = PENDING_BYTE_PAGE(pBt);
drh1f595712004-06-15 01:40:29 +00007491 if( i<=sCheck.nPage ){
7492 sCheck.anRef[i] = 1;
7493 }
drhf089aa42008-07-08 19:34:06 +00007494 sqlite3StrAccumInit(&sCheck.errMsg, zErr, sizeof(zErr), 20000);
drh5eddca62001-06-30 21:53:53 +00007495
7496 /* Check the integrity of the freelist
7497 */
drha34b6762004-05-07 13:30:42 +00007498 checkList(&sCheck, 1, get4byte(&pBt->pPage1->aData[32]),
7499 get4byte(&pBt->pPage1->aData[36]), "Main freelist: ");
drh5eddca62001-06-30 21:53:53 +00007500
7501 /* Check all the tables.
7502 */
danielk197789d40042008-11-17 14:20:56 +00007503 for(i=0; (int)i<nRoot && sCheck.mxErr; i++){
drh4ff6dfa2002-03-03 23:06:00 +00007504 if( aRoot[i]==0 ) continue;
danielk1977687566d2004-11-02 12:56:41 +00007505#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00007506 if( pBt->autoVacuum && aRoot[i]>1 ){
7507 checkPtrmap(&sCheck, aRoot[i], PTRMAP_ROOTPAGE, 0, 0);
7508 }
7509#endif
danielk197762c14b32008-11-19 09:05:26 +00007510 checkTreePage(&sCheck, aRoot[i], "List of tree roots: ");
drh5eddca62001-06-30 21:53:53 +00007511 }
7512
7513 /* Make sure every page in the file is referenced
7514 */
drh1dcdbc02007-01-27 02:24:54 +00007515 for(i=1; i<=sCheck.nPage && sCheck.mxErr; i++){
danielk1977afcdd022004-10-31 16:25:42 +00007516#ifdef SQLITE_OMIT_AUTOVACUUM
drh5eddca62001-06-30 21:53:53 +00007517 if( sCheck.anRef[i]==0 ){
drh2e38c322004-09-03 18:38:44 +00007518 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
drh5eddca62001-06-30 21:53:53 +00007519 }
danielk1977afcdd022004-10-31 16:25:42 +00007520#else
7521 /* If the database supports auto-vacuum, make sure no tables contain
7522 ** references to pointer-map pages.
7523 */
7524 if( sCheck.anRef[i]==0 &&
danielk1977266664d2006-02-10 08:24:21 +00007525 (PTRMAP_PAGENO(pBt, i)!=i || !pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00007526 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
7527 }
7528 if( sCheck.anRef[i]!=0 &&
danielk1977266664d2006-02-10 08:24:21 +00007529 (PTRMAP_PAGENO(pBt, i)==i && pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00007530 checkAppendMsg(&sCheck, 0, "Pointer map page %d is referenced", i);
7531 }
7532#endif
drh5eddca62001-06-30 21:53:53 +00007533 }
7534
drh64022502009-01-09 14:11:04 +00007535 /* Make sure this analysis did not leave any unref() pages.
7536 ** This is an internal consistency check; an integrity check
7537 ** of the integrity check.
drh5eddca62001-06-30 21:53:53 +00007538 */
drh64022502009-01-09 14:11:04 +00007539 if( NEVER(nRef != sqlite3PagerRefcount(pBt->pPager)) ){
drh2e38c322004-09-03 18:38:44 +00007540 checkAppendMsg(&sCheck, 0,
drh5eddca62001-06-30 21:53:53 +00007541 "Outstanding page count goes from %d to %d during this analysis",
danielk19773b8a05f2007-03-19 17:44:26 +00007542 nRef, sqlite3PagerRefcount(pBt->pPager)
drh5eddca62001-06-30 21:53:53 +00007543 );
drh5eddca62001-06-30 21:53:53 +00007544 }
7545
7546 /* Clean up and report errors.
7547 */
drhd677b3d2007-08-20 22:48:41 +00007548 sqlite3BtreeLeave(p);
drh17435752007-08-16 04:30:38 +00007549 sqlite3_free(sCheck.anRef);
drhc890fec2008-08-01 20:10:08 +00007550 if( sCheck.mallocFailed ){
7551 sqlite3StrAccumReset(&sCheck.errMsg);
7552 *pnErr = sCheck.nErr+1;
7553 return 0;
7554 }
drh1dcdbc02007-01-27 02:24:54 +00007555 *pnErr = sCheck.nErr;
drhf089aa42008-07-08 19:34:06 +00007556 if( sCheck.nErr==0 ) sqlite3StrAccumReset(&sCheck.errMsg);
7557 return sqlite3StrAccumFinish(&sCheck.errMsg);
drh5eddca62001-06-30 21:53:53 +00007558}
drhb7f91642004-10-31 02:22:47 +00007559#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
paulb95a8862003-04-01 21:16:41 +00007560
drh73509ee2003-04-06 20:44:45 +00007561/*
7562** Return the full pathname of the underlying database file.
drhd0679ed2007-08-28 22:24:34 +00007563**
7564** The pager filename is invariant as long as the pager is
7565** open so it is safe to access without the BtShared mutex.
drh73509ee2003-04-06 20:44:45 +00007566*/
danielk1977aef0bf62005-12-30 16:28:01 +00007567const char *sqlite3BtreeGetFilename(Btree *p){
7568 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00007569 return sqlite3PagerFilename(p->pBt->pPager);
drh73509ee2003-04-06 20:44:45 +00007570}
7571
7572/*
danielk19775865e3d2004-06-14 06:03:57 +00007573** Return the pathname of the journal file for this database. The return
7574** value of this routine is the same regardless of whether the journal file
7575** has been created or not.
drhd0679ed2007-08-28 22:24:34 +00007576**
7577** The pager journal filename is invariant as long as the pager is
7578** open so it is safe to access without the BtShared mutex.
danielk19775865e3d2004-06-14 06:03:57 +00007579*/
danielk1977aef0bf62005-12-30 16:28:01 +00007580const char *sqlite3BtreeGetJournalname(Btree *p){
7581 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00007582 return sqlite3PagerJournalname(p->pBt->pPager);
danielk19775865e3d2004-06-14 06:03:57 +00007583}
7584
danielk19771d850a72004-05-31 08:26:49 +00007585/*
7586** Return non-zero if a transaction is active.
7587*/
danielk1977aef0bf62005-12-30 16:28:01 +00007588int sqlite3BtreeIsInTrans(Btree *p){
drhe5fe6902007-12-07 18:55:28 +00007589 assert( p==0 || sqlite3_mutex_held(p->db->mutex) );
danielk1977aef0bf62005-12-30 16:28:01 +00007590 return (p && (p->inTrans==TRANS_WRITE));
danielk19771d850a72004-05-31 08:26:49 +00007591}
7592
7593/*
danielk19772372c2b2006-06-27 16:34:56 +00007594** Return non-zero if a read (or write) transaction is active.
7595*/
7596int sqlite3BtreeIsInReadTrans(Btree *p){
drh64022502009-01-09 14:11:04 +00007597 assert( p );
drhe5fe6902007-12-07 18:55:28 +00007598 assert( sqlite3_mutex_held(p->db->mutex) );
drh64022502009-01-09 14:11:04 +00007599 return p->inTrans!=TRANS_NONE;
danielk19772372c2b2006-06-27 16:34:56 +00007600}
7601
danielk197704103022009-02-03 16:51:24 +00007602int sqlite3BtreeIsInBackup(Btree *p){
7603 assert( p );
7604 assert( sqlite3_mutex_held(p->db->mutex) );
7605 return p->nBackup!=0;
7606}
7607
danielk19772372c2b2006-06-27 16:34:56 +00007608/*
danielk1977da184232006-01-05 11:34:32 +00007609** This function returns a pointer to a blob of memory associated with
drh85b623f2007-12-13 21:54:09 +00007610** a single shared-btree. The memory is used by client code for its own
danielk1977da184232006-01-05 11:34:32 +00007611** purposes (for example, to store a high-level schema associated with
7612** the shared-btree). The btree layer manages reference counting issues.
7613**
7614** The first time this is called on a shared-btree, nBytes bytes of memory
7615** are allocated, zeroed, and returned to the caller. For each subsequent
7616** call the nBytes parameter is ignored and a pointer to the same blob
7617** of memory returned.
7618**
danielk1977171bfed2008-06-23 09:50:50 +00007619** If the nBytes parameter is 0 and the blob of memory has not yet been
7620** allocated, a null pointer is returned. If the blob has already been
7621** allocated, it is returned as normal.
7622**
danielk1977da184232006-01-05 11:34:32 +00007623** Just before the shared-btree is closed, the function passed as the
7624** xFree argument when the memory allocation was made is invoked on the
drh17435752007-08-16 04:30:38 +00007625** blob of allocated memory. This function should not call sqlite3_free()
danielk1977da184232006-01-05 11:34:32 +00007626** on the memory, the btree layer does that.
7627*/
7628void *sqlite3BtreeSchema(Btree *p, int nBytes, void(*xFree)(void *)){
7629 BtShared *pBt = p->pBt;
drh27641702007-08-22 02:56:42 +00007630 sqlite3BtreeEnter(p);
danielk1977171bfed2008-06-23 09:50:50 +00007631 if( !pBt->pSchema && nBytes ){
drh17435752007-08-16 04:30:38 +00007632 pBt->pSchema = sqlite3MallocZero(nBytes);
danielk1977da184232006-01-05 11:34:32 +00007633 pBt->xFreeSchema = xFree;
7634 }
drh27641702007-08-22 02:56:42 +00007635 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +00007636 return pBt->pSchema;
7637}
7638
danielk1977c87d34d2006-01-06 13:00:28 +00007639/*
danielk1977404ca072009-03-16 13:19:36 +00007640** Return SQLITE_LOCKED_SHAREDCACHE if another user of the same shared
7641** btree as the argument handle holds an exclusive lock on the
7642** sqlite_master table. Otherwise SQLITE_OK.
danielk1977c87d34d2006-01-06 13:00:28 +00007643*/
7644int sqlite3BtreeSchemaLocked(Btree *p){
drh27641702007-08-22 02:56:42 +00007645 int rc;
drhe5fe6902007-12-07 18:55:28 +00007646 assert( sqlite3_mutex_held(p->db->mutex) );
drh27641702007-08-22 02:56:42 +00007647 sqlite3BtreeEnter(p);
danielk1977404ca072009-03-16 13:19:36 +00007648 rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK);
7649 assert( rc==SQLITE_OK || rc==SQLITE_LOCKED_SHAREDCACHE );
drh27641702007-08-22 02:56:42 +00007650 sqlite3BtreeLeave(p);
7651 return rc;
danielk1977c87d34d2006-01-06 13:00:28 +00007652}
7653
drha154dcd2006-03-22 22:10:07 +00007654
7655#ifndef SQLITE_OMIT_SHARED_CACHE
7656/*
7657** Obtain a lock on the table whose root page is iTab. The
7658** lock is a write lock if isWritelock is true or a read lock
7659** if it is false.
7660*/
danielk1977c00da102006-01-07 13:21:04 +00007661int sqlite3BtreeLockTable(Btree *p, int iTab, u8 isWriteLock){
danielk19772e94d4d2006-01-09 05:36:27 +00007662 int rc = SQLITE_OK;
danielk1977602b4662009-07-02 07:47:33 +00007663 assert( p->inTrans!=TRANS_NONE );
drh6a9ad3d2008-04-02 16:29:30 +00007664 if( p->sharable ){
7665 u8 lockType = READ_LOCK + isWriteLock;
7666 assert( READ_LOCK+1==WRITE_LOCK );
7667 assert( isWriteLock==0 || isWriteLock==1 );
danielk1977602b4662009-07-02 07:47:33 +00007668
drh6a9ad3d2008-04-02 16:29:30 +00007669 sqlite3BtreeEnter(p);
drhc25eabe2009-02-24 18:57:31 +00007670 rc = querySharedCacheTableLock(p, iTab, lockType);
drh6a9ad3d2008-04-02 16:29:30 +00007671 if( rc==SQLITE_OK ){
drhc25eabe2009-02-24 18:57:31 +00007672 rc = setSharedCacheTableLock(p, iTab, lockType);
drh6a9ad3d2008-04-02 16:29:30 +00007673 }
7674 sqlite3BtreeLeave(p);
danielk1977c00da102006-01-07 13:21:04 +00007675 }
7676 return rc;
7677}
drha154dcd2006-03-22 22:10:07 +00007678#endif
danielk1977b82e7ed2006-01-11 14:09:31 +00007679
danielk1977b4e9af92007-05-01 17:49:49 +00007680#ifndef SQLITE_OMIT_INCRBLOB
7681/*
7682** Argument pCsr must be a cursor opened for writing on an
7683** INTKEY table currently pointing at a valid table entry.
7684** This function modifies the data stored as part of that entry.
danielk1977ecaecf92009-07-08 08:05:35 +00007685**
7686** Only the data content may only be modified, it is not possible to
7687** change the length of the data stored. If this function is called with
7688** parameters that attempt to write past the end of the existing data,
7689** no modifications are made and SQLITE_CORRUPT is returned.
danielk1977b4e9af92007-05-01 17:49:49 +00007690*/
danielk1977dcbb5d32007-05-04 18:36:44 +00007691int sqlite3BtreePutData(BtCursor *pCsr, u32 offset, u32 amt, void *z){
danielk1977c9000e62009-07-08 13:55:28 +00007692 int rc;
drh1fee73e2007-08-29 04:00:57 +00007693 assert( cursorHoldsMutex(pCsr) );
drhe5fe6902007-12-07 18:55:28 +00007694 assert( sqlite3_mutex_held(pCsr->pBtree->db->mutex) );
danielk197796d48e92009-06-29 06:00:37 +00007695 assert( pCsr->isIncrblobHandle );
danielk19773588ceb2008-06-10 17:30:26 +00007696
danielk1977c9000e62009-07-08 13:55:28 +00007697 rc = restoreCursorPosition(pCsr);
7698 if( rc!=SQLITE_OK ){
7699 return rc;
7700 }
danielk19773588ceb2008-06-10 17:30:26 +00007701 assert( pCsr->eState!=CURSOR_REQUIRESEEK );
7702 if( pCsr->eState!=CURSOR_VALID ){
7703 return SQLITE_ABORT;
danielk1977dcbb5d32007-05-04 18:36:44 +00007704 }
7705
danielk1977c9000e62009-07-08 13:55:28 +00007706 /* Check some assumptions:
danielk1977dcbb5d32007-05-04 18:36:44 +00007707 ** (a) the cursor is open for writing,
danielk1977c9000e62009-07-08 13:55:28 +00007708 ** (b) there is a read/write transaction open,
7709 ** (c) the connection holds a write-lock on the table (if required),
7710 ** (d) there are no conflicting read-locks, and
7711 ** (e) the cursor points at a valid row of an intKey table.
danielk1977d04417962007-05-02 13:16:30 +00007712 */
danielk19774f029602009-07-08 18:45:37 +00007713 if( !pCsr->wrFlag ){
7714 return SQLITE_READONLY;
7715 }
danielk197796d48e92009-06-29 06:00:37 +00007716 assert( !pCsr->pBt->readOnly && pCsr->pBt->inTransaction==TRANS_WRITE );
7717 assert( hasSharedCacheTableLock(pCsr->pBtree, pCsr->pgnoRoot, 0, 2) );
7718 assert( !hasReadConflicts(pCsr->pBtree, pCsr->pgnoRoot) );
danielk1977c9000e62009-07-08 13:55:28 +00007719 assert( pCsr->apPage[pCsr->iPage]->intKey );
danielk1977b4e9af92007-05-01 17:49:49 +00007720
danielk19779f8d6402007-05-02 17:48:45 +00007721 return accessPayload(pCsr, offset, amt, (unsigned char *)z, 0, 1);
danielk1977b4e9af92007-05-01 17:49:49 +00007722}
danielk19772dec9702007-05-02 16:48:37 +00007723
7724/*
7725** Set a flag on this cursor to cache the locations of pages from the
danielk1977da107192007-05-04 08:32:13 +00007726** overflow list for the current row. This is used by cursors opened
7727** for incremental blob IO only.
7728**
7729** This function sets a flag only. The actual page location cache
7730** (stored in BtCursor.aOverflow[]) is allocated and used by function
7731** accessPayload() (the worker function for sqlite3BtreeData() and
7732** sqlite3BtreePutData()).
danielk19772dec9702007-05-02 16:48:37 +00007733*/
7734void sqlite3BtreeCacheOverflow(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00007735 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00007736 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk1977dcbb5d32007-05-04 18:36:44 +00007737 assert(!pCur->isIncrblobHandle);
danielk19772dec9702007-05-02 16:48:37 +00007738 assert(!pCur->aOverflow);
danielk1977dcbb5d32007-05-04 18:36:44 +00007739 pCur->isIncrblobHandle = 1;
danielk19772dec9702007-05-02 16:48:37 +00007740}
danielk1977b4e9af92007-05-01 17:49:49 +00007741#endif