blob: 68345144a8dd1a7cc1ab009ec35a1b4c10a5a90a [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*************************************************************************
drh8b2f49b2001-06-08 00:21:52 +000012** This file implements a external (disk-based) database using BTrees.
drha3152892007-05-05 11:48:52 +000013** See the header comment on "btreeInt.h" for additional information.
14** Including a description of file format and an overview of operation.
drha059ad02001-04-17 20:09:11 +000015*/
drha3152892007-05-05 11:48:52 +000016#include "btreeInt.h"
paulb95a8862003-04-01 21:16:41 +000017
drh8c42ca92001-06-22 19:15:00 +000018/*
drha3152892007-05-05 11:48:52 +000019** The header string that appears at the beginning of every
20** SQLite database.
drh556b2a22005-06-14 16:04:05 +000021*/
drh556b2a22005-06-14 16:04:05 +000022static const char zMagicHeader[] = SQLITE_FILE_HEADER;
drh08ed44e2001-04-29 23:32:55 +000023
drh8c42ca92001-06-22 19:15:00 +000024/*
drha3152892007-05-05 11:48:52 +000025** Set this global variable to 1 to enable tracing using the TRACE
26** macro.
drh615ae552005-01-16 23:21:00 +000027*/
drhe8f52c52008-07-12 14:52:20 +000028#if 0
danielk1977a50d9aa2009-06-08 14:49:45 +000029int sqlite3BtreeTrace=1; /* True to enable tracing */
drhe8f52c52008-07-12 14:52:20 +000030# define TRACE(X) if(sqlite3BtreeTrace){printf X;fflush(stdout);}
31#else
32# define TRACE(X)
drh615ae552005-01-16 23:21:00 +000033#endif
drh615ae552005-01-16 23:21:00 +000034
drh5d433ce2010-08-14 16:02:52 +000035/*
36** Extract a 2-byte big-endian integer from an array of unsigned bytes.
37** But if the value is zero, make it 65536.
38**
39** This routine is used to extract the "offset to cell content area" value
40** from the header of a btree page. If the page size is 65536 and the page
41** is empty, the offset should be 65536, but the 2-byte value stores zero.
42** This routine makes the necessary adjustment to 65536.
43*/
44#define get2byteNotZero(X) (((((int)get2byte(X))-1)&0xffff)+1)
drh86f8c192007-08-22 00:39:19 +000045
drhe53831d2007-08-17 01:14:38 +000046#ifndef SQLITE_OMIT_SHARED_CACHE
47/*
danielk1977502b4e02008-09-02 14:07:24 +000048** A list of BtShared objects that are eligible for participation
49** in shared cache. This variable has file scope during normal builds,
50** but the test harness needs to access it so we make it global for
51** test builds.
drh7555d8e2009-03-20 13:15:30 +000052**
53** Access to this variable is protected by SQLITE_MUTEX_STATIC_MASTER.
drhe53831d2007-08-17 01:14:38 +000054*/
55#ifdef SQLITE_TEST
drh78f82d12008-09-02 00:52:52 +000056BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
drhe53831d2007-08-17 01:14:38 +000057#else
drh78f82d12008-09-02 00:52:52 +000058static BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
drhe53831d2007-08-17 01:14:38 +000059#endif
drhe53831d2007-08-17 01:14:38 +000060#endif /* SQLITE_OMIT_SHARED_CACHE */
61
62#ifndef SQLITE_OMIT_SHARED_CACHE
63/*
64** Enable or disable the shared pager and schema features.
65**
66** This routine has no effect on existing database connections.
67** The shared cache setting effects only future calls to
68** sqlite3_open(), sqlite3_open16(), or sqlite3_open_v2().
69*/
70int sqlite3_enable_shared_cache(int enable){
danielk1977502b4e02008-09-02 14:07:24 +000071 sqlite3GlobalConfig.sharedCacheEnabled = enable;
drhe53831d2007-08-17 01:14:38 +000072 return SQLITE_OK;
73}
74#endif
75
drhd677b3d2007-08-20 22:48:41 +000076
danielk1977aef0bf62005-12-30 16:28:01 +000077
78#ifdef SQLITE_OMIT_SHARED_CACHE
79 /*
drhc25eabe2009-02-24 18:57:31 +000080 ** The functions querySharedCacheTableLock(), setSharedCacheTableLock(),
81 ** and clearAllSharedCacheTableLocks()
danielk1977aef0bf62005-12-30 16:28:01 +000082 ** manipulate entries in the BtShared.pLock linked list used to store
83 ** shared-cache table level locks. If the library is compiled with the
84 ** shared-cache feature disabled, then there is only ever one user
danielk1977da184232006-01-05 11:34:32 +000085 ** of each BtShared structure and so this locking is not necessary.
86 ** So define the lock related functions as no-ops.
danielk1977aef0bf62005-12-30 16:28:01 +000087 */
drhc25eabe2009-02-24 18:57:31 +000088 #define querySharedCacheTableLock(a,b,c) SQLITE_OK
89 #define setSharedCacheTableLock(a,b,c) SQLITE_OK
90 #define clearAllSharedCacheTableLocks(a)
danielk197794b30732009-07-02 17:21:57 +000091 #define downgradeAllSharedCacheTableLocks(a)
danielk197796d48e92009-06-29 06:00:37 +000092 #define hasSharedCacheTableLock(a,b,c,d) 1
93 #define hasReadConflicts(a, b) 0
drhe53831d2007-08-17 01:14:38 +000094#endif
danielk1977aef0bf62005-12-30 16:28:01 +000095
drhe53831d2007-08-17 01:14:38 +000096#ifndef SQLITE_OMIT_SHARED_CACHE
danielk197796d48e92009-06-29 06:00:37 +000097
98#ifdef SQLITE_DEBUG
99/*
drh0ee3dbe2009-10-16 15:05:18 +0000100**** This function is only used as part of an assert() statement. ***
101**
102** Check to see if pBtree holds the required locks to read or write to the
103** table with root page iRoot. Return 1 if it does and 0 if not.
104**
105** For example, when writing to a table with root-page iRoot via
danielk197796d48e92009-06-29 06:00:37 +0000106** Btree connection pBtree:
107**
108** assert( hasSharedCacheTableLock(pBtree, iRoot, 0, WRITE_LOCK) );
109**
drh0ee3dbe2009-10-16 15:05:18 +0000110** When writing to an index that resides in a sharable database, the
danielk197796d48e92009-06-29 06:00:37 +0000111** caller should have first obtained a lock specifying the root page of
drh0ee3dbe2009-10-16 15:05:18 +0000112** the corresponding table. This makes things a bit more complicated,
113** as this module treats each table as a separate structure. To determine
114** the table corresponding to the index being written, this
danielk197796d48e92009-06-29 06:00:37 +0000115** function has to search through the database schema.
116**
drh0ee3dbe2009-10-16 15:05:18 +0000117** Instead of a lock on the table/index rooted at page iRoot, the caller may
danielk197796d48e92009-06-29 06:00:37 +0000118** hold a write-lock on the schema table (root page 1). This is also
119** acceptable.
120*/
121static int hasSharedCacheTableLock(
122 Btree *pBtree, /* Handle that must hold lock */
123 Pgno iRoot, /* Root page of b-tree */
124 int isIndex, /* True if iRoot is the root of an index b-tree */
125 int eLockType /* Required lock type (READ_LOCK or WRITE_LOCK) */
126){
127 Schema *pSchema = (Schema *)pBtree->pBt->pSchema;
128 Pgno iTab = 0;
129 BtLock *pLock;
130
drh0ee3dbe2009-10-16 15:05:18 +0000131 /* If this database is not shareable, or if the client is reading
danielk197796d48e92009-06-29 06:00:37 +0000132 ** and has the read-uncommitted flag set, then no lock is required.
drh0ee3dbe2009-10-16 15:05:18 +0000133 ** Return true immediately.
134 */
danielk197796d48e92009-06-29 06:00:37 +0000135 if( (pBtree->sharable==0)
136 || (eLockType==READ_LOCK && (pBtree->db->flags & SQLITE_ReadUncommitted))
danielk197796d48e92009-06-29 06:00:37 +0000137 ){
138 return 1;
139 }
140
drh0ee3dbe2009-10-16 15:05:18 +0000141 /* If the client is reading or writing an index and the schema is
142 ** not loaded, then it is too difficult to actually check to see if
143 ** the correct locks are held. So do not bother - just return true.
144 ** This case does not come up very often anyhow.
145 */
146 if( isIndex && (!pSchema || (pSchema->flags&DB_SchemaLoaded)==0) ){
147 return 1;
148 }
149
danielk197796d48e92009-06-29 06:00:37 +0000150 /* Figure out the root-page that the lock should be held on. For table
151 ** b-trees, this is just the root page of the b-tree being read or
152 ** written. For index b-trees, it is the root page of the associated
153 ** table. */
154 if( isIndex ){
155 HashElem *p;
156 for(p=sqliteHashFirst(&pSchema->idxHash); p; p=sqliteHashNext(p)){
157 Index *pIdx = (Index *)sqliteHashData(p);
shane5eff7cf2009-08-10 03:57:58 +0000158 if( pIdx->tnum==(int)iRoot ){
159 iTab = pIdx->pTable->tnum;
danielk197796d48e92009-06-29 06:00:37 +0000160 }
161 }
162 }else{
163 iTab = iRoot;
164 }
165
166 /* Search for the required lock. Either a write-lock on root-page iTab, a
167 ** write-lock on the schema table, or (if the client is reading) a
168 ** read-lock on iTab will suffice. Return 1 if any of these are found. */
169 for(pLock=pBtree->pBt->pLock; pLock; pLock=pLock->pNext){
170 if( pLock->pBtree==pBtree
171 && (pLock->iTable==iTab || (pLock->eLock==WRITE_LOCK && pLock->iTable==1))
172 && pLock->eLock>=eLockType
173 ){
174 return 1;
175 }
176 }
177
178 /* Failed to find the required lock. */
179 return 0;
180}
drh0ee3dbe2009-10-16 15:05:18 +0000181#endif /* SQLITE_DEBUG */
danielk197796d48e92009-06-29 06:00:37 +0000182
drh0ee3dbe2009-10-16 15:05:18 +0000183#ifdef SQLITE_DEBUG
danielk197796d48e92009-06-29 06:00:37 +0000184/*
drh0ee3dbe2009-10-16 15:05:18 +0000185**** This function may be used as part of assert() statements only. ****
danielk197796d48e92009-06-29 06:00:37 +0000186**
drh0ee3dbe2009-10-16 15:05:18 +0000187** Return true if it would be illegal for pBtree to write into the
188** table or index rooted at iRoot because other shared connections are
189** simultaneously reading that same table or index.
190**
191** It is illegal for pBtree to write if some other Btree object that
192** shares the same BtShared object is currently reading or writing
193** the iRoot table. Except, if the other Btree object has the
194** read-uncommitted flag set, then it is OK for the other object to
195** have a read cursor.
196**
197** For example, before writing to any part of the table or index
198** rooted at page iRoot, one should call:
danielk197796d48e92009-06-29 06:00:37 +0000199**
200** assert( !hasReadConflicts(pBtree, iRoot) );
201*/
202static int hasReadConflicts(Btree *pBtree, Pgno iRoot){
203 BtCursor *p;
204 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
205 if( p->pgnoRoot==iRoot
206 && p->pBtree!=pBtree
207 && 0==(p->pBtree->db->flags & SQLITE_ReadUncommitted)
208 ){
209 return 1;
210 }
211 }
212 return 0;
213}
214#endif /* #ifdef SQLITE_DEBUG */
215
danielk1977da184232006-01-05 11:34:32 +0000216/*
drh0ee3dbe2009-10-16 15:05:18 +0000217** Query to see if Btree handle p may obtain a lock of type eLock
danielk1977aef0bf62005-12-30 16:28:01 +0000218** (READ_LOCK or WRITE_LOCK) on the table with root-page iTab. Return
drhc25eabe2009-02-24 18:57:31 +0000219** SQLITE_OK if the lock may be obtained (by calling
220** setSharedCacheTableLock()), or SQLITE_LOCKED if not.
danielk1977aef0bf62005-12-30 16:28:01 +0000221*/
drhc25eabe2009-02-24 18:57:31 +0000222static int querySharedCacheTableLock(Btree *p, Pgno iTab, u8 eLock){
danielk1977aef0bf62005-12-30 16:28:01 +0000223 BtShared *pBt = p->pBt;
224 BtLock *pIter;
225
drh1fee73e2007-08-29 04:00:57 +0000226 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000227 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
228 assert( p->db!=0 );
danielk1977e0d9e6f2009-07-03 16:25:06 +0000229 assert( !(p->db->flags&SQLITE_ReadUncommitted)||eLock==WRITE_LOCK||iTab==1 );
drhd677b3d2007-08-20 22:48:41 +0000230
danielk19775b413d72009-04-01 09:41:54 +0000231 /* If requesting a write-lock, then the Btree must have an open write
232 ** transaction on this file. And, obviously, for this to be so there
233 ** must be an open write transaction on the file itself.
234 */
235 assert( eLock==READ_LOCK || (p==pBt->pWriter && p->inTrans==TRANS_WRITE) );
236 assert( eLock==READ_LOCK || pBt->inTransaction==TRANS_WRITE );
237
drh0ee3dbe2009-10-16 15:05:18 +0000238 /* This routine is a no-op if the shared-cache is not enabled */
drhe53831d2007-08-17 01:14:38 +0000239 if( !p->sharable ){
danielk1977da184232006-01-05 11:34:32 +0000240 return SQLITE_OK;
241 }
242
danielk1977641b0f42007-12-21 04:47:25 +0000243 /* If some other connection is holding an exclusive lock, the
244 ** requested lock may not be obtained.
245 */
drhc9166342012-01-05 23:32:06 +0000246 if( pBt->pWriter!=p && (pBt->btsFlags & BTS_EXCLUSIVE)!=0 ){
danielk1977404ca072009-03-16 13:19:36 +0000247 sqlite3ConnectionBlocked(p->db, pBt->pWriter->db);
248 return SQLITE_LOCKED_SHAREDCACHE;
danielk1977641b0f42007-12-21 04:47:25 +0000249 }
250
danielk1977e0d9e6f2009-07-03 16:25:06 +0000251 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
252 /* The condition (pIter->eLock!=eLock) in the following if(...)
253 ** statement is a simplification of:
254 **
255 ** (eLock==WRITE_LOCK || pIter->eLock==WRITE_LOCK)
256 **
257 ** since we know that if eLock==WRITE_LOCK, then no other connection
258 ** may hold a WRITE_LOCK on any table in this file (since there can
259 ** only be a single writer).
260 */
261 assert( pIter->eLock==READ_LOCK || pIter->eLock==WRITE_LOCK );
262 assert( eLock==READ_LOCK || pIter->pBtree==p || pIter->eLock==READ_LOCK);
263 if( pIter->pBtree!=p && pIter->iTable==iTab && pIter->eLock!=eLock ){
264 sqlite3ConnectionBlocked(p->db, pIter->pBtree->db);
265 if( eLock==WRITE_LOCK ){
266 assert( p==pBt->pWriter );
drhc9166342012-01-05 23:32:06 +0000267 pBt->btsFlags |= BTS_PENDING;
danielk1977da184232006-01-05 11:34:32 +0000268 }
danielk1977e0d9e6f2009-07-03 16:25:06 +0000269 return SQLITE_LOCKED_SHAREDCACHE;
danielk1977aef0bf62005-12-30 16:28:01 +0000270 }
271 }
272 return SQLITE_OK;
273}
drhe53831d2007-08-17 01:14:38 +0000274#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000275
drhe53831d2007-08-17 01:14:38 +0000276#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000277/*
278** Add a lock on the table with root-page iTable to the shared-btree used
279** by Btree handle p. Parameter eLock must be either READ_LOCK or
280** WRITE_LOCK.
281**
danielk19779d104862009-07-09 08:27:14 +0000282** This function assumes the following:
283**
drh0ee3dbe2009-10-16 15:05:18 +0000284** (a) The specified Btree object p is connected to a sharable
285** database (one with the BtShared.sharable flag set), and
danielk19779d104862009-07-09 08:27:14 +0000286**
drh0ee3dbe2009-10-16 15:05:18 +0000287** (b) No other Btree objects hold a lock that conflicts
danielk19779d104862009-07-09 08:27:14 +0000288** with the requested lock (i.e. querySharedCacheTableLock() has
289** already been called and returned SQLITE_OK).
290**
291** SQLITE_OK is returned if the lock is added successfully. SQLITE_NOMEM
292** is returned if a malloc attempt fails.
danielk1977aef0bf62005-12-30 16:28:01 +0000293*/
drhc25eabe2009-02-24 18:57:31 +0000294static int setSharedCacheTableLock(Btree *p, Pgno iTable, u8 eLock){
danielk1977aef0bf62005-12-30 16:28:01 +0000295 BtShared *pBt = p->pBt;
296 BtLock *pLock = 0;
297 BtLock *pIter;
298
drh1fee73e2007-08-29 04:00:57 +0000299 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000300 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
301 assert( p->db!=0 );
drhd677b3d2007-08-20 22:48:41 +0000302
danielk1977e0d9e6f2009-07-03 16:25:06 +0000303 /* A connection with the read-uncommitted flag set will never try to
304 ** obtain a read-lock using this function. The only read-lock obtained
305 ** by a connection in read-uncommitted mode is on the sqlite_master
306 ** table, and that lock is obtained in BtreeBeginTrans(). */
307 assert( 0==(p->db->flags&SQLITE_ReadUncommitted) || eLock==WRITE_LOCK );
308
danielk19779d104862009-07-09 08:27:14 +0000309 /* This function should only be called on a sharable b-tree after it
310 ** has been determined that no other b-tree holds a conflicting lock. */
311 assert( p->sharable );
drhc25eabe2009-02-24 18:57:31 +0000312 assert( SQLITE_OK==querySharedCacheTableLock(p, iTable, eLock) );
danielk1977aef0bf62005-12-30 16:28:01 +0000313
314 /* First search the list for an existing lock on this table. */
315 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
316 if( pIter->iTable==iTable && pIter->pBtree==p ){
317 pLock = pIter;
318 break;
319 }
320 }
321
322 /* If the above search did not find a BtLock struct associating Btree p
323 ** with table iTable, allocate one and link it into the list.
324 */
325 if( !pLock ){
drh17435752007-08-16 04:30:38 +0000326 pLock = (BtLock *)sqlite3MallocZero(sizeof(BtLock));
danielk1977aef0bf62005-12-30 16:28:01 +0000327 if( !pLock ){
328 return SQLITE_NOMEM;
329 }
330 pLock->iTable = iTable;
331 pLock->pBtree = p;
332 pLock->pNext = pBt->pLock;
333 pBt->pLock = pLock;
334 }
335
336 /* Set the BtLock.eLock variable to the maximum of the current lock
337 ** and the requested lock. This means if a write-lock was already held
338 ** and a read-lock requested, we don't incorrectly downgrade the lock.
339 */
340 assert( WRITE_LOCK>READ_LOCK );
danielk19775118b912005-12-30 16:31:53 +0000341 if( eLock>pLock->eLock ){
342 pLock->eLock = eLock;
343 }
danielk1977aef0bf62005-12-30 16:28:01 +0000344
345 return SQLITE_OK;
346}
drhe53831d2007-08-17 01:14:38 +0000347#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000348
drhe53831d2007-08-17 01:14:38 +0000349#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000350/*
drhc25eabe2009-02-24 18:57:31 +0000351** Release all the table locks (locks obtained via calls to
drh0ee3dbe2009-10-16 15:05:18 +0000352** the setSharedCacheTableLock() procedure) held by Btree object p.
danielk1977fa542f12009-04-02 18:28:08 +0000353**
drh0ee3dbe2009-10-16 15:05:18 +0000354** This function assumes that Btree p has an open read or write
drhc9166342012-01-05 23:32:06 +0000355** transaction. If it does not, then the BTS_PENDING flag
danielk1977fa542f12009-04-02 18:28:08 +0000356** may be incorrectly cleared.
danielk1977aef0bf62005-12-30 16:28:01 +0000357*/
drhc25eabe2009-02-24 18:57:31 +0000358static void clearAllSharedCacheTableLocks(Btree *p){
danielk1977641b0f42007-12-21 04:47:25 +0000359 BtShared *pBt = p->pBt;
360 BtLock **ppIter = &pBt->pLock;
danielk1977da184232006-01-05 11:34:32 +0000361
drh1fee73e2007-08-29 04:00:57 +0000362 assert( sqlite3BtreeHoldsMutex(p) );
drhe53831d2007-08-17 01:14:38 +0000363 assert( p->sharable || 0==*ppIter );
danielk1977fa542f12009-04-02 18:28:08 +0000364 assert( p->inTrans>0 );
danielk1977da184232006-01-05 11:34:32 +0000365
danielk1977aef0bf62005-12-30 16:28:01 +0000366 while( *ppIter ){
367 BtLock *pLock = *ppIter;
drhc9166342012-01-05 23:32:06 +0000368 assert( (pBt->btsFlags & BTS_EXCLUSIVE)==0 || pBt->pWriter==pLock->pBtree );
danielk1977fa542f12009-04-02 18:28:08 +0000369 assert( pLock->pBtree->inTrans>=pLock->eLock );
danielk1977aef0bf62005-12-30 16:28:01 +0000370 if( pLock->pBtree==p ){
371 *ppIter = pLock->pNext;
danielk1977602b4662009-07-02 07:47:33 +0000372 assert( pLock->iTable!=1 || pLock==&p->lock );
373 if( pLock->iTable!=1 ){
374 sqlite3_free(pLock);
375 }
danielk1977aef0bf62005-12-30 16:28:01 +0000376 }else{
377 ppIter = &pLock->pNext;
378 }
379 }
danielk1977641b0f42007-12-21 04:47:25 +0000380
drhc9166342012-01-05 23:32:06 +0000381 assert( (pBt->btsFlags & BTS_PENDING)==0 || pBt->pWriter );
danielk1977404ca072009-03-16 13:19:36 +0000382 if( pBt->pWriter==p ){
383 pBt->pWriter = 0;
drhc9166342012-01-05 23:32:06 +0000384 pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
danielk1977404ca072009-03-16 13:19:36 +0000385 }else if( pBt->nTransaction==2 ){
drh0ee3dbe2009-10-16 15:05:18 +0000386 /* This function is called when Btree p is concluding its
danielk1977404ca072009-03-16 13:19:36 +0000387 ** transaction. If there currently exists a writer, and p is not
388 ** that writer, then the number of locks held by connections other
389 ** than the writer must be about to drop to zero. In this case
drhc9166342012-01-05 23:32:06 +0000390 ** set the BTS_PENDING flag to 0.
danielk1977404ca072009-03-16 13:19:36 +0000391 **
drhc9166342012-01-05 23:32:06 +0000392 ** If there is not currently a writer, then BTS_PENDING must
danielk1977404ca072009-03-16 13:19:36 +0000393 ** be zero already. So this next line is harmless in that case.
394 */
drhc9166342012-01-05 23:32:06 +0000395 pBt->btsFlags &= ~BTS_PENDING;
danielk1977641b0f42007-12-21 04:47:25 +0000396 }
danielk1977aef0bf62005-12-30 16:28:01 +0000397}
danielk197794b30732009-07-02 17:21:57 +0000398
danielk1977e0d9e6f2009-07-03 16:25:06 +0000399/*
drh0ee3dbe2009-10-16 15:05:18 +0000400** This function changes all write-locks held by Btree p into read-locks.
danielk1977e0d9e6f2009-07-03 16:25:06 +0000401*/
danielk197794b30732009-07-02 17:21:57 +0000402static void downgradeAllSharedCacheTableLocks(Btree *p){
403 BtShared *pBt = p->pBt;
404 if( pBt->pWriter==p ){
405 BtLock *pLock;
406 pBt->pWriter = 0;
drhc9166342012-01-05 23:32:06 +0000407 pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
danielk197794b30732009-07-02 17:21:57 +0000408 for(pLock=pBt->pLock; pLock; pLock=pLock->pNext){
409 assert( pLock->eLock==READ_LOCK || pLock->pBtree==p );
410 pLock->eLock = READ_LOCK;
411 }
412 }
413}
414
danielk1977aef0bf62005-12-30 16:28:01 +0000415#endif /* SQLITE_OMIT_SHARED_CACHE */
416
drh980b1a72006-08-16 16:42:48 +0000417static void releasePage(MemPage *pPage); /* Forward reference */
418
drh1fee73e2007-08-29 04:00:57 +0000419/*
drh0ee3dbe2009-10-16 15:05:18 +0000420***** This routine is used inside of assert() only ****
421**
422** Verify that the cursor holds the mutex on its BtShared
drh1fee73e2007-08-29 04:00:57 +0000423*/
drh0ee3dbe2009-10-16 15:05:18 +0000424#ifdef SQLITE_DEBUG
drh1fee73e2007-08-29 04:00:57 +0000425static int cursorHoldsMutex(BtCursor *p){
drhff0587c2007-08-29 17:43:19 +0000426 return sqlite3_mutex_held(p->pBt->mutex);
drh1fee73e2007-08-29 04:00:57 +0000427}
428#endif
429
430
danielk197792d4d7a2007-05-04 12:05:56 +0000431#ifndef SQLITE_OMIT_INCRBLOB
432/*
433** Invalidate the overflow page-list cache for cursor pCur, if any.
434*/
435static void invalidateOverflowCache(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000436 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000437 sqlite3_free(pCur->aOverflow);
danielk197792d4d7a2007-05-04 12:05:56 +0000438 pCur->aOverflow = 0;
439}
440
441/*
442** Invalidate the overflow page-list cache for all cursors opened
443** on the shared btree structure pBt.
444*/
445static void invalidateAllOverflowCache(BtShared *pBt){
446 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000447 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +0000448 for(p=pBt->pCursor; p; p=p->pNext){
449 invalidateOverflowCache(p);
450 }
451}
danielk197796d48e92009-06-29 06:00:37 +0000452
453/*
454** This function is called before modifying the contents of a table
drh0ee3dbe2009-10-16 15:05:18 +0000455** to invalidate any incrblob cursors that are open on the
drheeb844a2009-08-08 18:01:07 +0000456** row or one of the rows being modified.
danielk197796d48e92009-06-29 06:00:37 +0000457**
458** If argument isClearTable is true, then the entire contents of the
459** table is about to be deleted. In this case invalidate all incrblob
460** cursors open on any row within the table with root-page pgnoRoot.
461**
462** Otherwise, if argument isClearTable is false, then the row with
463** rowid iRow is being replaced or deleted. In this case invalidate
drh0ee3dbe2009-10-16 15:05:18 +0000464** only those incrblob cursors open on that specific row.
danielk197796d48e92009-06-29 06:00:37 +0000465*/
466static void invalidateIncrblobCursors(
467 Btree *pBtree, /* The database file to check */
danielk197796d48e92009-06-29 06:00:37 +0000468 i64 iRow, /* The rowid that might be changing */
469 int isClearTable /* True if all rows are being deleted */
470){
471 BtCursor *p;
472 BtShared *pBt = pBtree->pBt;
473 assert( sqlite3BtreeHoldsMutex(pBtree) );
474 for(p=pBt->pCursor; p; p=p->pNext){
475 if( p->isIncrblobHandle && (isClearTable || p->info.nKey==iRow) ){
476 p->eState = CURSOR_INVALID;
477 }
478 }
479}
480
danielk197792d4d7a2007-05-04 12:05:56 +0000481#else
drh0ee3dbe2009-10-16 15:05:18 +0000482 /* Stub functions when INCRBLOB is omitted */
danielk197792d4d7a2007-05-04 12:05:56 +0000483 #define invalidateOverflowCache(x)
484 #define invalidateAllOverflowCache(x)
drheeb844a2009-08-08 18:01:07 +0000485 #define invalidateIncrblobCursors(x,y,z)
drh0ee3dbe2009-10-16 15:05:18 +0000486#endif /* SQLITE_OMIT_INCRBLOB */
danielk197792d4d7a2007-05-04 12:05:56 +0000487
drh980b1a72006-08-16 16:42:48 +0000488/*
danielk1977bea2a942009-01-20 17:06:27 +0000489** Set bit pgno of the BtShared.pHasContent bitvec. This is called
490** when a page that previously contained data becomes a free-list leaf
491** page.
492**
493** The BtShared.pHasContent bitvec exists to work around an obscure
494** bug caused by the interaction of two useful IO optimizations surrounding
495** free-list leaf pages:
496**
497** 1) When all data is deleted from a page and the page becomes
498** a free-list leaf page, the page is not written to the database
499** (as free-list leaf pages contain no meaningful data). Sometimes
500** such a page is not even journalled (as it will not be modified,
501** why bother journalling it?).
502**
503** 2) When a free-list leaf page is reused, its content is not read
504** from the database or written to the journal file (why should it
505** be, if it is not at all meaningful?).
506**
507** By themselves, these optimizations work fine and provide a handy
508** performance boost to bulk delete or insert operations. However, if
509** a page is moved to the free-list and then reused within the same
510** transaction, a problem comes up. If the page is not journalled when
511** it is moved to the free-list and it is also not journalled when it
512** is extracted from the free-list and reused, then the original data
513** may be lost. In the event of a rollback, it may not be possible
514** to restore the database to its original configuration.
515**
516** The solution is the BtShared.pHasContent bitvec. Whenever a page is
517** moved to become a free-list leaf page, the corresponding bit is
518** set in the bitvec. Whenever a leaf page is extracted from the free-list,
drh0ee3dbe2009-10-16 15:05:18 +0000519** optimization 2 above is omitted if the corresponding bit is already
danielk1977bea2a942009-01-20 17:06:27 +0000520** set in BtShared.pHasContent. The contents of the bitvec are cleared
521** at the end of every transaction.
522*/
523static int btreeSetHasContent(BtShared *pBt, Pgno pgno){
524 int rc = SQLITE_OK;
525 if( !pBt->pHasContent ){
drhdd3cd972010-03-27 17:12:36 +0000526 assert( pgno<=pBt->nPage );
527 pBt->pHasContent = sqlite3BitvecCreate(pBt->nPage);
drh4c301aa2009-07-15 17:25:45 +0000528 if( !pBt->pHasContent ){
529 rc = SQLITE_NOMEM;
danielk1977bea2a942009-01-20 17:06:27 +0000530 }
531 }
532 if( rc==SQLITE_OK && pgno<=sqlite3BitvecSize(pBt->pHasContent) ){
533 rc = sqlite3BitvecSet(pBt->pHasContent, pgno);
534 }
535 return rc;
536}
537
538/*
539** Query the BtShared.pHasContent vector.
540**
541** This function is called when a free-list leaf page is removed from the
542** free-list for reuse. It returns false if it is safe to retrieve the
543** page from the pager layer with the 'no-content' flag set. True otherwise.
544*/
545static int btreeGetHasContent(BtShared *pBt, Pgno pgno){
546 Bitvec *p = pBt->pHasContent;
547 return (p && (pgno>sqlite3BitvecSize(p) || sqlite3BitvecTest(p, pgno)));
548}
549
550/*
551** Clear (destroy) the BtShared.pHasContent bitvec. This should be
552** invoked at the conclusion of each write-transaction.
553*/
554static void btreeClearHasContent(BtShared *pBt){
555 sqlite3BitvecDestroy(pBt->pHasContent);
556 pBt->pHasContent = 0;
557}
558
559/*
drh980b1a72006-08-16 16:42:48 +0000560** Save the current cursor position in the variables BtCursor.nKey
561** and BtCursor.pKey. The cursor's state is set to CURSOR_REQUIRESEEK.
drhea8ffdf2009-07-22 00:35:23 +0000562**
563** The caller must ensure that the cursor is valid (has eState==CURSOR_VALID)
564** prior to calling this routine.
drh980b1a72006-08-16 16:42:48 +0000565*/
566static int saveCursorPosition(BtCursor *pCur){
567 int rc;
568
569 assert( CURSOR_VALID==pCur->eState );
570 assert( 0==pCur->pKey );
drh1fee73e2007-08-29 04:00:57 +0000571 assert( cursorHoldsMutex(pCur) );
drh980b1a72006-08-16 16:42:48 +0000572
573 rc = sqlite3BtreeKeySize(pCur, &pCur->nKey);
drhea8ffdf2009-07-22 00:35:23 +0000574 assert( rc==SQLITE_OK ); /* KeySize() cannot fail */
drh980b1a72006-08-16 16:42:48 +0000575
576 /* If this is an intKey table, then the above call to BtreeKeySize()
577 ** stores the integer key in pCur->nKey. In this case this value is
578 ** all that is required. Otherwise, if pCur is not open on an intKey
579 ** table, then malloc space for and store the pCur->nKey bytes of key
580 ** data.
581 */
drh4c301aa2009-07-15 17:25:45 +0000582 if( 0==pCur->apPage[0]->intKey ){
drhf49661a2008-12-10 16:45:50 +0000583 void *pKey = sqlite3Malloc( (int)pCur->nKey );
drh980b1a72006-08-16 16:42:48 +0000584 if( pKey ){
drhf49661a2008-12-10 16:45:50 +0000585 rc = sqlite3BtreeKey(pCur, 0, (int)pCur->nKey, pKey);
drh980b1a72006-08-16 16:42:48 +0000586 if( rc==SQLITE_OK ){
587 pCur->pKey = pKey;
588 }else{
drh17435752007-08-16 04:30:38 +0000589 sqlite3_free(pKey);
drh980b1a72006-08-16 16:42:48 +0000590 }
591 }else{
592 rc = SQLITE_NOMEM;
593 }
594 }
danielk197771d5d2c2008-09-29 11:49:47 +0000595 assert( !pCur->apPage[0]->intKey || !pCur->pKey );
drh980b1a72006-08-16 16:42:48 +0000596
597 if( rc==SQLITE_OK ){
danielk197771d5d2c2008-09-29 11:49:47 +0000598 int i;
599 for(i=0; i<=pCur->iPage; i++){
600 releasePage(pCur->apPage[i]);
601 pCur->apPage[i] = 0;
602 }
603 pCur->iPage = -1;
drh980b1a72006-08-16 16:42:48 +0000604 pCur->eState = CURSOR_REQUIRESEEK;
605 }
606
danielk197792d4d7a2007-05-04 12:05:56 +0000607 invalidateOverflowCache(pCur);
drh980b1a72006-08-16 16:42:48 +0000608 return rc;
609}
610
611/*
drh0ee3dbe2009-10-16 15:05:18 +0000612** Save the positions of all cursors (except pExcept) that are open on
613** the table with root-page iRoot. Usually, this is called just before cursor
drh980b1a72006-08-16 16:42:48 +0000614** pExcept is used to modify the table (BtreeDelete() or BtreeInsert()).
615*/
616static int saveAllCursors(BtShared *pBt, Pgno iRoot, BtCursor *pExcept){
617 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000618 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +0000619 assert( pExcept==0 || pExcept->pBt==pBt );
drh980b1a72006-08-16 16:42:48 +0000620 for(p=pBt->pCursor; p; p=p->pNext){
621 if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) &&
622 p->eState==CURSOR_VALID ){
623 int rc = saveCursorPosition(p);
624 if( SQLITE_OK!=rc ){
625 return rc;
626 }
627 }
628 }
629 return SQLITE_OK;
630}
631
632/*
drhbf700f32007-03-31 02:36:44 +0000633** Clear the current cursor position.
634*/
danielk1977be51a652008-10-08 17:58:48 +0000635void sqlite3BtreeClearCursor(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000636 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000637 sqlite3_free(pCur->pKey);
drhbf700f32007-03-31 02:36:44 +0000638 pCur->pKey = 0;
639 pCur->eState = CURSOR_INVALID;
640}
641
642/*
danielk19773509a652009-07-06 18:56:13 +0000643** In this version of BtreeMoveto, pKey is a packed index record
644** such as is generated by the OP_MakeRecord opcode. Unpack the
645** record and then call BtreeMovetoUnpacked() to do the work.
646*/
647static int btreeMoveto(
648 BtCursor *pCur, /* Cursor open on the btree to be searched */
649 const void *pKey, /* Packed key if the btree is an index */
650 i64 nKey, /* Integer key for tables. Size of pKey for indices */
651 int bias, /* Bias search to the high end */
652 int *pRes /* Write search results here */
653){
654 int rc; /* Status code */
655 UnpackedRecord *pIdxKey; /* Unpacked index key */
656 char aSpace[150]; /* Temp space for pIdxKey - to avoid a malloc */
dan03e9cfc2011-09-05 14:20:27 +0000657 char *pFree = 0;
danielk19773509a652009-07-06 18:56:13 +0000658
659 if( pKey ){
660 assert( nKey==(i64)(int)nKey );
dan03e9cfc2011-09-05 14:20:27 +0000661 pIdxKey = sqlite3VdbeAllocUnpackedRecord(
662 pCur->pKeyInfo, aSpace, sizeof(aSpace), &pFree
663 );
danielk19773509a652009-07-06 18:56:13 +0000664 if( pIdxKey==0 ) return SQLITE_NOMEM;
mistachkin0fe5f952011-09-14 18:19:08 +0000665 sqlite3VdbeRecordUnpack(pCur->pKeyInfo, (int)nKey, pKey, pIdxKey);
danielk19773509a652009-07-06 18:56:13 +0000666 }else{
667 pIdxKey = 0;
668 }
669 rc = sqlite3BtreeMovetoUnpacked(pCur, pIdxKey, nKey, bias, pRes);
dan42acb3e2011-09-05 20:16:38 +0000670 if( pFree ){
dan03e9cfc2011-09-05 14:20:27 +0000671 sqlite3DbFree(pCur->pKeyInfo->db, pFree);
danielk19773509a652009-07-06 18:56:13 +0000672 }
673 return rc;
674}
675
676/*
drh980b1a72006-08-16 16:42:48 +0000677** Restore the cursor to the position it was in (or as close to as possible)
678** when saveCursorPosition() was called. Note that this call deletes the
679** saved position info stored by saveCursorPosition(), so there can be
drha3460582008-07-11 21:02:53 +0000680** at most one effective restoreCursorPosition() call after each
drh980b1a72006-08-16 16:42:48 +0000681** saveCursorPosition().
drh980b1a72006-08-16 16:42:48 +0000682*/
danielk197730548662009-07-09 05:07:37 +0000683static int btreeRestoreCursorPosition(BtCursor *pCur){
drhbf700f32007-03-31 02:36:44 +0000684 int rc;
drh1fee73e2007-08-29 04:00:57 +0000685 assert( cursorHoldsMutex(pCur) );
drhfb982642007-08-30 01:19:59 +0000686 assert( pCur->eState>=CURSOR_REQUIRESEEK );
687 if( pCur->eState==CURSOR_FAULT ){
drh4c301aa2009-07-15 17:25:45 +0000688 return pCur->skipNext;
drhfb982642007-08-30 01:19:59 +0000689 }
drh980b1a72006-08-16 16:42:48 +0000690 pCur->eState = CURSOR_INVALID;
drh4c301aa2009-07-15 17:25:45 +0000691 rc = btreeMoveto(pCur, pCur->pKey, pCur->nKey, 0, &pCur->skipNext);
drh980b1a72006-08-16 16:42:48 +0000692 if( rc==SQLITE_OK ){
drh17435752007-08-16 04:30:38 +0000693 sqlite3_free(pCur->pKey);
drh980b1a72006-08-16 16:42:48 +0000694 pCur->pKey = 0;
drhbf700f32007-03-31 02:36:44 +0000695 assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_INVALID );
drh980b1a72006-08-16 16:42:48 +0000696 }
697 return rc;
698}
699
drha3460582008-07-11 21:02:53 +0000700#define restoreCursorPosition(p) \
drhfb982642007-08-30 01:19:59 +0000701 (p->eState>=CURSOR_REQUIRESEEK ? \
danielk197730548662009-07-09 05:07:37 +0000702 btreeRestoreCursorPosition(p) : \
drh16a9b832007-05-05 18:39:25 +0000703 SQLITE_OK)
drh980b1a72006-08-16 16:42:48 +0000704
drha3460582008-07-11 21:02:53 +0000705/*
706** Determine whether or not a cursor has moved from the position it
drhdfe88ec2008-11-03 20:55:06 +0000707** was last placed at. Cursors can move when the row they are pointing
drha3460582008-07-11 21:02:53 +0000708** at is deleted out from under them.
709**
710** This routine returns an error code if something goes wrong. The
711** integer *pHasMoved is set to one if the cursor has moved and 0 if not.
712*/
713int sqlite3BtreeCursorHasMoved(BtCursor *pCur, int *pHasMoved){
714 int rc;
715
716 rc = restoreCursorPosition(pCur);
717 if( rc ){
718 *pHasMoved = 1;
719 return rc;
720 }
drh4c301aa2009-07-15 17:25:45 +0000721 if( pCur->eState!=CURSOR_VALID || pCur->skipNext!=0 ){
drha3460582008-07-11 21:02:53 +0000722 *pHasMoved = 1;
723 }else{
724 *pHasMoved = 0;
725 }
726 return SQLITE_OK;
727}
728
danielk1977599fcba2004-11-08 07:13:13 +0000729#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977afcdd022004-10-31 16:25:42 +0000730/*
drha3152892007-05-05 11:48:52 +0000731** Given a page number of a regular database page, return the page
732** number for the pointer-map page that contains the entry for the
733** input page number.
drh5f77b2e2010-08-21 15:09:37 +0000734**
735** Return 0 (not a valid page) for pgno==1 since there is
736** no pointer map associated with page 1. The integrity_check logic
737** requires that ptrmapPageno(*,1)!=1.
danielk1977afcdd022004-10-31 16:25:42 +0000738*/
danielk1977266664d2006-02-10 08:24:21 +0000739static Pgno ptrmapPageno(BtShared *pBt, Pgno pgno){
danielk197789d40042008-11-17 14:20:56 +0000740 int nPagesPerMapPage;
741 Pgno iPtrMap, ret;
drh1fee73e2007-08-29 04:00:57 +0000742 assert( sqlite3_mutex_held(pBt->mutex) );
drh5f77b2e2010-08-21 15:09:37 +0000743 if( pgno<2 ) return 0;
drhd677b3d2007-08-20 22:48:41 +0000744 nPagesPerMapPage = (pBt->usableSize/5)+1;
745 iPtrMap = (pgno-2)/nPagesPerMapPage;
746 ret = (iPtrMap*nPagesPerMapPage) + 2;
danielk1977266664d2006-02-10 08:24:21 +0000747 if( ret==PENDING_BYTE_PAGE(pBt) ){
748 ret++;
749 }
750 return ret;
751}
danielk1977a19df672004-11-03 11:37:07 +0000752
danielk1977afcdd022004-10-31 16:25:42 +0000753/*
danielk1977afcdd022004-10-31 16:25:42 +0000754** Write an entry into the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000755**
756** This routine updates the pointer map entry for page number 'key'
757** so that it maps to type 'eType' and parent page number 'pgno'.
drh98add2e2009-07-20 17:11:49 +0000758**
759** If *pRC is initially non-zero (non-SQLITE_OK) then this routine is
760** a no-op. If an error occurs, the appropriate error code is written
761** into *pRC.
danielk1977afcdd022004-10-31 16:25:42 +0000762*/
drh98add2e2009-07-20 17:11:49 +0000763static void ptrmapPut(BtShared *pBt, Pgno key, u8 eType, Pgno parent, int *pRC){
danielk19773b8a05f2007-03-19 17:44:26 +0000764 DbPage *pDbPage; /* The pointer map page */
765 u8 *pPtrmap; /* The pointer map data */
766 Pgno iPtrmap; /* The pointer map page number */
767 int offset; /* Offset in pointer map page */
drh98add2e2009-07-20 17:11:49 +0000768 int rc; /* Return code from subfunctions */
769
770 if( *pRC ) return;
danielk1977afcdd022004-10-31 16:25:42 +0000771
drh1fee73e2007-08-29 04:00:57 +0000772 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977266664d2006-02-10 08:24:21 +0000773 /* The master-journal page number must never be used as a pointer map page */
774 assert( 0==PTRMAP_ISPAGE(pBt, PENDING_BYTE_PAGE(pBt)) );
775
danielk1977ac11ee62005-01-15 12:45:51 +0000776 assert( pBt->autoVacuum );
danielk1977fdb7cdb2005-01-17 02:12:18 +0000777 if( key==0 ){
drh98add2e2009-07-20 17:11:49 +0000778 *pRC = SQLITE_CORRUPT_BKPT;
779 return;
danielk1977fdb7cdb2005-01-17 02:12:18 +0000780 }
danielk1977266664d2006-02-10 08:24:21 +0000781 iPtrmap = PTRMAP_PAGENO(pBt, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000782 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage);
danielk1977687566d2004-11-02 12:56:41 +0000783 if( rc!=SQLITE_OK ){
drh98add2e2009-07-20 17:11:49 +0000784 *pRC = rc;
785 return;
danielk1977afcdd022004-10-31 16:25:42 +0000786 }
danielk19778c666b12008-07-18 09:34:57 +0000787 offset = PTRMAP_PTROFFSET(iPtrmap, key);
drhacfc72b2009-06-05 18:44:15 +0000788 if( offset<0 ){
drh98add2e2009-07-20 17:11:49 +0000789 *pRC = SQLITE_CORRUPT_BKPT;
drh4925a552009-07-07 11:39:58 +0000790 goto ptrmap_exit;
drhacfc72b2009-06-05 18:44:15 +0000791 }
drhfc243732011-05-17 15:21:56 +0000792 assert( offset <= (int)pBt->usableSize-5 );
danielk19773b8a05f2007-03-19 17:44:26 +0000793 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000794
drh615ae552005-01-16 23:21:00 +0000795 if( eType!=pPtrmap[offset] || get4byte(&pPtrmap[offset+1])!=parent ){
796 TRACE(("PTRMAP_UPDATE: %d->(%d,%d)\n", key, eType, parent));
drh98add2e2009-07-20 17:11:49 +0000797 *pRC= rc = sqlite3PagerWrite(pDbPage);
danielk19775558a8a2005-01-17 07:53:44 +0000798 if( rc==SQLITE_OK ){
799 pPtrmap[offset] = eType;
800 put4byte(&pPtrmap[offset+1], parent);
danielk1977afcdd022004-10-31 16:25:42 +0000801 }
danielk1977afcdd022004-10-31 16:25:42 +0000802 }
803
drh4925a552009-07-07 11:39:58 +0000804ptrmap_exit:
danielk19773b8a05f2007-03-19 17:44:26 +0000805 sqlite3PagerUnref(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000806}
807
808/*
809** Read an entry from the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000810**
811** This routine retrieves the pointer map entry for page 'key', writing
812** the type and parent page number to *pEType and *pPgno respectively.
813** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +0000814*/
danielk1977aef0bf62005-12-30 16:28:01 +0000815static int ptrmapGet(BtShared *pBt, Pgno key, u8 *pEType, Pgno *pPgno){
danielk19773b8a05f2007-03-19 17:44:26 +0000816 DbPage *pDbPage; /* The pointer map page */
danielk1977afcdd022004-10-31 16:25:42 +0000817 int iPtrmap; /* Pointer map page index */
818 u8 *pPtrmap; /* Pointer map page data */
819 int offset; /* Offset of entry in pointer map */
820 int rc;
821
drh1fee73e2007-08-29 04:00:57 +0000822 assert( sqlite3_mutex_held(pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000823
danielk1977266664d2006-02-10 08:24:21 +0000824 iPtrmap = PTRMAP_PAGENO(pBt, key);
danielk19773b8a05f2007-03-19 17:44:26 +0000825 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000826 if( rc!=0 ){
827 return rc;
828 }
danielk19773b8a05f2007-03-19 17:44:26 +0000829 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +0000830
danielk19778c666b12008-07-18 09:34:57 +0000831 offset = PTRMAP_PTROFFSET(iPtrmap, key);
drhfc243732011-05-17 15:21:56 +0000832 if( offset<0 ){
833 sqlite3PagerUnref(pDbPage);
834 return SQLITE_CORRUPT_BKPT;
835 }
836 assert( offset <= (int)pBt->usableSize-5 );
drh43617e92006-03-06 20:55:46 +0000837 assert( pEType!=0 );
838 *pEType = pPtrmap[offset];
danielk1977687566d2004-11-02 12:56:41 +0000839 if( pPgno ) *pPgno = get4byte(&pPtrmap[offset+1]);
danielk1977afcdd022004-10-31 16:25:42 +0000840
danielk19773b8a05f2007-03-19 17:44:26 +0000841 sqlite3PagerUnref(pDbPage);
drh49285702005-09-17 15:20:26 +0000842 if( *pEType<1 || *pEType>5 ) return SQLITE_CORRUPT_BKPT;
danielk1977afcdd022004-10-31 16:25:42 +0000843 return SQLITE_OK;
844}
845
danielk197785d90ca2008-07-19 14:25:15 +0000846#else /* if defined SQLITE_OMIT_AUTOVACUUM */
drh98add2e2009-07-20 17:11:49 +0000847 #define ptrmapPut(w,x,y,z,rc)
danielk197785d90ca2008-07-19 14:25:15 +0000848 #define ptrmapGet(w,x,y,z) SQLITE_OK
drh98add2e2009-07-20 17:11:49 +0000849 #define ptrmapPutOvflPtr(x, y, rc)
danielk197785d90ca2008-07-19 14:25:15 +0000850#endif
danielk1977afcdd022004-10-31 16:25:42 +0000851
drh0d316a42002-08-11 20:10:47 +0000852/*
drh271efa52004-05-30 19:19:05 +0000853** Given a btree page and a cell index (0 means the first cell on
854** the page, 1 means the second cell, and so forth) return a pointer
855** to the cell content.
856**
857** This routine works only for pages that do not contain overflow cells.
drh3aac2dd2004-04-26 14:10:20 +0000858*/
drh1688c862008-07-18 02:44:17 +0000859#define findCell(P,I) \
drh3def2352011-11-11 00:27:15 +0000860 ((P)->aData + ((P)->maskPage & get2byte(&(P)->aCellIdx[2*(I)])))
drh68f2a572011-06-03 17:50:49 +0000861#define findCellv2(D,M,O,I) (D+(M&get2byte(D+(O+2*(I)))))
862
drh43605152004-05-29 21:46:49 +0000863
864/*
drh93a960a2008-07-10 00:32:42 +0000865** This a more complex version of findCell() that works for
drh0a45c272009-07-08 01:49:11 +0000866** pages that do contain overflow cells.
drh43605152004-05-29 21:46:49 +0000867*/
868static u8 *findOverflowCell(MemPage *pPage, int iCell){
869 int i;
drh1fee73e2007-08-29 04:00:57 +0000870 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh43605152004-05-29 21:46:49 +0000871 for(i=pPage->nOverflow-1; i>=0; i--){
drh6d08b4d2004-07-20 12:45:22 +0000872 int k;
drh2cbd78b2012-02-02 19:37:18 +0000873 k = pPage->aiOvfl[i];
drh6d08b4d2004-07-20 12:45:22 +0000874 if( k<=iCell ){
875 if( k==iCell ){
drh2cbd78b2012-02-02 19:37:18 +0000876 return pPage->apOvfl[i];
drh43605152004-05-29 21:46:49 +0000877 }
878 iCell--;
879 }
880 }
danielk19771cc5ed82007-05-16 17:28:43 +0000881 return findCell(pPage, iCell);
drh43605152004-05-29 21:46:49 +0000882}
883
884/*
885** Parse a cell content block and fill in the CellInfo structure. There
danielk197730548662009-07-09 05:07:37 +0000886** are two versions of this function. btreeParseCell() takes a
887** cell index as the second argument and btreeParseCellPtr()
drh16a9b832007-05-05 18:39:25 +0000888** takes a pointer to the body of the cell as its second argument.
danielk19771cc5ed82007-05-16 17:28:43 +0000889**
890** Within this file, the parseCell() macro can be called instead of
danielk197730548662009-07-09 05:07:37 +0000891** btreeParseCellPtr(). Using some compilers, this will be faster.
drh43605152004-05-29 21:46:49 +0000892*/
danielk197730548662009-07-09 05:07:37 +0000893static void btreeParseCellPtr(
drh3aac2dd2004-04-26 14:10:20 +0000894 MemPage *pPage, /* Page containing the cell */
drh43605152004-05-29 21:46:49 +0000895 u8 *pCell, /* Pointer to the cell text. */
drh6f11bef2004-05-13 01:12:56 +0000896 CellInfo *pInfo /* Fill in this structure */
drh3aac2dd2004-04-26 14:10:20 +0000897){
drhf49661a2008-12-10 16:45:50 +0000898 u16 n; /* Number bytes in cell content header */
drh271efa52004-05-30 19:19:05 +0000899 u32 nPayload; /* Number of bytes of cell payload */
drh43605152004-05-29 21:46:49 +0000900
drh1fee73e2007-08-29 04:00:57 +0000901 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +0000902
drh43605152004-05-29 21:46:49 +0000903 pInfo->pCell = pCell;
drhab01f612004-05-22 02:55:23 +0000904 assert( pPage->leaf==0 || pPage->leaf==1 );
drh271efa52004-05-30 19:19:05 +0000905 n = pPage->childPtrSize;
906 assert( n==4-4*pPage->leaf );
drh504b6982006-01-22 21:52:56 +0000907 if( pPage->intKey ){
drh79df1f42008-07-18 00:57:33 +0000908 if( pPage->hasData ){
909 n += getVarint32(&pCell[n], nPayload);
910 }else{
911 nPayload = 0;
912 }
drh1bd10f82008-12-10 21:19:56 +0000913 n += getVarint(&pCell[n], (u64*)&pInfo->nKey);
drh79df1f42008-07-18 00:57:33 +0000914 pInfo->nData = nPayload;
drh504b6982006-01-22 21:52:56 +0000915 }else{
drh79df1f42008-07-18 00:57:33 +0000916 pInfo->nData = 0;
917 n += getVarint32(&pCell[n], nPayload);
918 pInfo->nKey = nPayload;
drh6f11bef2004-05-13 01:12:56 +0000919 }
drh72365832007-03-06 15:53:44 +0000920 pInfo->nPayload = nPayload;
drh504b6982006-01-22 21:52:56 +0000921 pInfo->nHeader = n;
drh0a45c272009-07-08 01:49:11 +0000922 testcase( nPayload==pPage->maxLocal );
923 testcase( nPayload==pPage->maxLocal+1 );
drh79df1f42008-07-18 00:57:33 +0000924 if( likely(nPayload<=pPage->maxLocal) ){
drh271efa52004-05-30 19:19:05 +0000925 /* This is the (easy) common case where the entire payload fits
926 ** on the local page. No overflow is required.
927 */
drh41692e92011-01-25 04:34:51 +0000928 if( (pInfo->nSize = (u16)(n+nPayload))<4 ) pInfo->nSize = 4;
drhf49661a2008-12-10 16:45:50 +0000929 pInfo->nLocal = (u16)nPayload;
drh6f11bef2004-05-13 01:12:56 +0000930 pInfo->iOverflow = 0;
drh6f11bef2004-05-13 01:12:56 +0000931 }else{
drh271efa52004-05-30 19:19:05 +0000932 /* If the payload will not fit completely on the local page, we have
933 ** to decide how much to store locally and how much to spill onto
934 ** overflow pages. The strategy is to minimize the amount of unused
935 ** space on overflow pages while keeping the amount of local storage
936 ** in between minLocal and maxLocal.
937 **
938 ** Warning: changing the way overflow payload is distributed in any
939 ** way will result in an incompatible file format.
940 */
941 int minLocal; /* Minimum amount of payload held locally */
942 int maxLocal; /* Maximum amount of payload held locally */
943 int surplus; /* Overflow payload available for local storage */
944
945 minLocal = pPage->minLocal;
946 maxLocal = pPage->maxLocal;
947 surplus = minLocal + (nPayload - minLocal)%(pPage->pBt->usableSize - 4);
drh0a45c272009-07-08 01:49:11 +0000948 testcase( surplus==maxLocal );
949 testcase( surplus==maxLocal+1 );
drh6f11bef2004-05-13 01:12:56 +0000950 if( surplus <= maxLocal ){
drhf49661a2008-12-10 16:45:50 +0000951 pInfo->nLocal = (u16)surplus;
drh6f11bef2004-05-13 01:12:56 +0000952 }else{
drhf49661a2008-12-10 16:45:50 +0000953 pInfo->nLocal = (u16)minLocal;
drh6f11bef2004-05-13 01:12:56 +0000954 }
drhf49661a2008-12-10 16:45:50 +0000955 pInfo->iOverflow = (u16)(pInfo->nLocal + n);
drh6f11bef2004-05-13 01:12:56 +0000956 pInfo->nSize = pInfo->iOverflow + 4;
957 }
drh3aac2dd2004-04-26 14:10:20 +0000958}
danielk19771cc5ed82007-05-16 17:28:43 +0000959#define parseCell(pPage, iCell, pInfo) \
danielk197730548662009-07-09 05:07:37 +0000960 btreeParseCellPtr((pPage), findCell((pPage), (iCell)), (pInfo))
961static void btreeParseCell(
drh43605152004-05-29 21:46:49 +0000962 MemPage *pPage, /* Page containing the cell */
963 int iCell, /* The cell index. First cell is 0 */
964 CellInfo *pInfo /* Fill in this structure */
965){
danielk19771cc5ed82007-05-16 17:28:43 +0000966 parseCell(pPage, iCell, pInfo);
drh43605152004-05-29 21:46:49 +0000967}
drh3aac2dd2004-04-26 14:10:20 +0000968
969/*
drh43605152004-05-29 21:46:49 +0000970** Compute the total number of bytes that a Cell needs in the cell
971** data area of the btree-page. The return number includes the cell
972** data header and the local payload, but not any overflow page or
973** the space used by the cell pointer.
drh3b7511c2001-05-26 13:15:44 +0000974*/
danielk1977ae5558b2009-04-29 11:31:47 +0000975static u16 cellSizePtr(MemPage *pPage, u8 *pCell){
976 u8 *pIter = &pCell[pPage->childPtrSize];
977 u32 nSize;
978
979#ifdef SQLITE_DEBUG
980 /* The value returned by this function should always be the same as
981 ** the (CellInfo.nSize) value found by doing a full parse of the
982 ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
983 ** this function verifies that this invariant is not violated. */
984 CellInfo debuginfo;
danielk197730548662009-07-09 05:07:37 +0000985 btreeParseCellPtr(pPage, pCell, &debuginfo);
danielk1977ae5558b2009-04-29 11:31:47 +0000986#endif
987
988 if( pPage->intKey ){
989 u8 *pEnd;
990 if( pPage->hasData ){
991 pIter += getVarint32(pIter, nSize);
992 }else{
993 nSize = 0;
994 }
995
996 /* pIter now points at the 64-bit integer key value, a variable length
997 ** integer. The following block moves pIter to point at the first byte
998 ** past the end of the key value. */
999 pEnd = &pIter[9];
1000 while( (*pIter++)&0x80 && pIter<pEnd );
1001 }else{
1002 pIter += getVarint32(pIter, nSize);
1003 }
1004
drh0a45c272009-07-08 01:49:11 +00001005 testcase( nSize==pPage->maxLocal );
1006 testcase( nSize==pPage->maxLocal+1 );
danielk1977ae5558b2009-04-29 11:31:47 +00001007 if( nSize>pPage->maxLocal ){
1008 int minLocal = pPage->minLocal;
1009 nSize = minLocal + (nSize - minLocal) % (pPage->pBt->usableSize - 4);
drh0a45c272009-07-08 01:49:11 +00001010 testcase( nSize==pPage->maxLocal );
1011 testcase( nSize==pPage->maxLocal+1 );
danielk1977ae5558b2009-04-29 11:31:47 +00001012 if( nSize>pPage->maxLocal ){
1013 nSize = minLocal;
1014 }
1015 nSize += 4;
1016 }
shane75ac1de2009-06-09 18:58:52 +00001017 nSize += (u32)(pIter - pCell);
danielk1977ae5558b2009-04-29 11:31:47 +00001018
1019 /* The minimum size of any cell is 4 bytes. */
1020 if( nSize<4 ){
1021 nSize = 4;
1022 }
1023
1024 assert( nSize==debuginfo.nSize );
shane60a4b532009-05-06 18:57:09 +00001025 return (u16)nSize;
danielk1977ae5558b2009-04-29 11:31:47 +00001026}
drh0ee3dbe2009-10-16 15:05:18 +00001027
1028#ifdef SQLITE_DEBUG
1029/* This variation on cellSizePtr() is used inside of assert() statements
1030** only. */
drha9121e42008-02-19 14:59:35 +00001031static u16 cellSize(MemPage *pPage, int iCell){
danielk1977ae5558b2009-04-29 11:31:47 +00001032 return cellSizePtr(pPage, findCell(pPage, iCell));
drh43605152004-05-29 21:46:49 +00001033}
danielk1977bc6ada42004-06-30 08:20:16 +00001034#endif
drh3b7511c2001-05-26 13:15:44 +00001035
danielk197779a40da2005-01-16 08:00:01 +00001036#ifndef SQLITE_OMIT_AUTOVACUUM
drh3b7511c2001-05-26 13:15:44 +00001037/*
danielk197726836652005-01-17 01:33:13 +00001038** If the cell pCell, part of page pPage contains a pointer
danielk197779a40da2005-01-16 08:00:01 +00001039** to an overflow page, insert an entry into the pointer-map
1040** for the overflow page.
danielk1977ac11ee62005-01-15 12:45:51 +00001041*/
drh98add2e2009-07-20 17:11:49 +00001042static void ptrmapPutOvflPtr(MemPage *pPage, u8 *pCell, int *pRC){
drhfa67c3c2008-07-11 02:21:40 +00001043 CellInfo info;
drh98add2e2009-07-20 17:11:49 +00001044 if( *pRC ) return;
drhfa67c3c2008-07-11 02:21:40 +00001045 assert( pCell!=0 );
danielk197730548662009-07-09 05:07:37 +00001046 btreeParseCellPtr(pPage, pCell, &info);
drhfa67c3c2008-07-11 02:21:40 +00001047 assert( (info.nData+(pPage->intKey?0:info.nKey))==info.nPayload );
danielk19774dbaa892009-06-16 16:50:22 +00001048 if( info.iOverflow ){
drhfa67c3c2008-07-11 02:21:40 +00001049 Pgno ovfl = get4byte(&pCell[info.iOverflow]);
drh98add2e2009-07-20 17:11:49 +00001050 ptrmapPut(pPage->pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno, pRC);
danielk1977ac11ee62005-01-15 12:45:51 +00001051 }
danielk1977ac11ee62005-01-15 12:45:51 +00001052}
danielk197779a40da2005-01-16 08:00:01 +00001053#endif
1054
danielk1977ac11ee62005-01-15 12:45:51 +00001055
drhda200cc2004-05-09 11:51:38 +00001056/*
drh72f82862001-05-24 21:06:34 +00001057** Defragment the page given. All Cells are moved to the
drh3a4a2d42005-11-24 14:24:28 +00001058** end of the page and all free space is collected into one
1059** big FreeBlk that occurs in between the header and cell
drh31beae92005-11-24 14:34:36 +00001060** pointer array and the cell content area.
drh365d68f2001-05-11 11:02:46 +00001061*/
shane0af3f892008-11-12 04:55:34 +00001062static int defragmentPage(MemPage *pPage){
drh43605152004-05-29 21:46:49 +00001063 int i; /* Loop counter */
1064 int pc; /* Address of a i-th cell */
drh43605152004-05-29 21:46:49 +00001065 int hdr; /* Offset to the page header */
1066 int size; /* Size of a cell */
1067 int usableSize; /* Number of usable bytes on a page */
1068 int cellOffset; /* Offset to the cell pointer array */
drh281b21d2008-08-22 12:57:08 +00001069 int cbrk; /* Offset to the cell content area */
drh43605152004-05-29 21:46:49 +00001070 int nCell; /* Number of cells on the page */
drh2e38c322004-09-03 18:38:44 +00001071 unsigned char *data; /* The page data */
1072 unsigned char *temp; /* Temp area for cell content */
drh17146622009-07-07 17:38:38 +00001073 int iCellFirst; /* First allowable cell index */
1074 int iCellLast; /* Last possible cell index */
1075
drh2af926b2001-05-15 00:39:25 +00001076
danielk19773b8a05f2007-03-19 17:44:26 +00001077 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +00001078 assert( pPage->pBt!=0 );
drh90f5ecb2004-07-22 01:19:35 +00001079 assert( pPage->pBt->usableSize <= SQLITE_MAX_PAGE_SIZE );
drh43605152004-05-29 21:46:49 +00001080 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +00001081 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh26b79942007-11-28 16:19:56 +00001082 temp = sqlite3PagerTempSpace(pPage->pBt->pPager);
drh43605152004-05-29 21:46:49 +00001083 data = pPage->aData;
drh9e572e62004-04-23 23:43:10 +00001084 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +00001085 cellOffset = pPage->cellOffset;
1086 nCell = pPage->nCell;
1087 assert( nCell==get2byte(&data[hdr+3]) );
1088 usableSize = pPage->pBt->usableSize;
drh281b21d2008-08-22 12:57:08 +00001089 cbrk = get2byte(&data[hdr+5]);
1090 memcpy(&temp[cbrk], &data[cbrk], usableSize - cbrk);
1091 cbrk = usableSize;
drh17146622009-07-07 17:38:38 +00001092 iCellFirst = cellOffset + 2*nCell;
1093 iCellLast = usableSize - 4;
drh43605152004-05-29 21:46:49 +00001094 for(i=0; i<nCell; i++){
1095 u8 *pAddr; /* The i-th cell pointer */
1096 pAddr = &data[cellOffset + i*2];
1097 pc = get2byte(pAddr);
drh0a45c272009-07-08 01:49:11 +00001098 testcase( pc==iCellFirst );
1099 testcase( pc==iCellLast );
drh17146622009-07-07 17:38:38 +00001100#if !defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
danielk197730548662009-07-09 05:07:37 +00001101 /* These conditions have already been verified in btreeInitPage()
drh17146622009-07-07 17:38:38 +00001102 ** if SQLITE_ENABLE_OVERSIZE_CELL_CHECK is defined
1103 */
1104 if( pc<iCellFirst || pc>iCellLast ){
shane0af3f892008-11-12 04:55:34 +00001105 return SQLITE_CORRUPT_BKPT;
1106 }
drh17146622009-07-07 17:38:38 +00001107#endif
1108 assert( pc>=iCellFirst && pc<=iCellLast );
drh43605152004-05-29 21:46:49 +00001109 size = cellSizePtr(pPage, &temp[pc]);
drh281b21d2008-08-22 12:57:08 +00001110 cbrk -= size;
drh17146622009-07-07 17:38:38 +00001111#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
1112 if( cbrk<iCellFirst ){
shane0af3f892008-11-12 04:55:34 +00001113 return SQLITE_CORRUPT_BKPT;
1114 }
drh17146622009-07-07 17:38:38 +00001115#else
1116 if( cbrk<iCellFirst || pc+size>usableSize ){
1117 return SQLITE_CORRUPT_BKPT;
1118 }
1119#endif
drh7157e1d2009-07-09 13:25:32 +00001120 assert( cbrk+size<=usableSize && cbrk>=iCellFirst );
drh0a45c272009-07-08 01:49:11 +00001121 testcase( cbrk+size==usableSize );
drh0a45c272009-07-08 01:49:11 +00001122 testcase( pc+size==usableSize );
drh281b21d2008-08-22 12:57:08 +00001123 memcpy(&data[cbrk], &temp[pc], size);
1124 put2byte(pAddr, cbrk);
drh2af926b2001-05-15 00:39:25 +00001125 }
drh17146622009-07-07 17:38:38 +00001126 assert( cbrk>=iCellFirst );
drh281b21d2008-08-22 12:57:08 +00001127 put2byte(&data[hdr+5], cbrk);
drh43605152004-05-29 21:46:49 +00001128 data[hdr+1] = 0;
1129 data[hdr+2] = 0;
1130 data[hdr+7] = 0;
drh17146622009-07-07 17:38:38 +00001131 memset(&data[iCellFirst], 0, cbrk-iCellFirst);
drhc5053fb2008-11-27 02:22:10 +00001132 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh17146622009-07-07 17:38:38 +00001133 if( cbrk-iCellFirst!=pPage->nFree ){
danielk1977360e6342008-11-12 08:49:51 +00001134 return SQLITE_CORRUPT_BKPT;
1135 }
shane0af3f892008-11-12 04:55:34 +00001136 return SQLITE_OK;
drh365d68f2001-05-11 11:02:46 +00001137}
1138
drha059ad02001-04-17 20:09:11 +00001139/*
danielk19776011a752009-04-01 16:25:32 +00001140** Allocate nByte bytes of space from within the B-Tree page passed
drh0a45c272009-07-08 01:49:11 +00001141** as the first argument. Write into *pIdx the index into pPage->aData[]
1142** of the first byte of allocated space. Return either SQLITE_OK or
1143** an error code (usually SQLITE_CORRUPT).
drhbd03cae2001-06-02 02:40:57 +00001144**
drh0a45c272009-07-08 01:49:11 +00001145** The caller guarantees that there is sufficient space to make the
1146** allocation. This routine might need to defragment in order to bring
1147** all the space together, however. This routine will avoid using
1148** the first two bytes past the cell pointer area since presumably this
1149** allocation is being made in order to insert a new cell, so we will
1150** also end up needing a new cell pointer.
drh7e3b0a02001-04-28 16:52:40 +00001151*/
drh0a45c272009-07-08 01:49:11 +00001152static int allocateSpace(MemPage *pPage, int nByte, int *pIdx){
danielk19776011a752009-04-01 16:25:32 +00001153 const int hdr = pPage->hdrOffset; /* Local cache of pPage->hdrOffset */
1154 u8 * const data = pPage->aData; /* Local cache of pPage->aData */
1155 int nFrag; /* Number of fragmented bytes on pPage */
drh0a45c272009-07-08 01:49:11 +00001156 int top; /* First byte of cell content area */
1157 int gap; /* First byte of gap between cell pointers and cell content */
1158 int rc; /* Integer return code */
drh00ce3942009-12-06 03:35:51 +00001159 int usableSize; /* Usable size of the page */
drh43605152004-05-29 21:46:49 +00001160
danielk19773b8a05f2007-03-19 17:44:26 +00001161 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +00001162 assert( pPage->pBt );
drh1fee73e2007-08-29 04:00:57 +00001163 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhfa67c3c2008-07-11 02:21:40 +00001164 assert( nByte>=0 ); /* Minimum cell size is 4 */
1165 assert( pPage->nFree>=nByte );
1166 assert( pPage->nOverflow==0 );
drh00ce3942009-12-06 03:35:51 +00001167 usableSize = pPage->pBt->usableSize;
1168 assert( nByte < usableSize-8 );
drh43605152004-05-29 21:46:49 +00001169
1170 nFrag = data[hdr+7];
drh0a45c272009-07-08 01:49:11 +00001171 assert( pPage->cellOffset == hdr + 12 - 4*pPage->leaf );
1172 gap = pPage->cellOffset + 2*pPage->nCell;
drh5d433ce2010-08-14 16:02:52 +00001173 top = get2byteNotZero(&data[hdr+5]);
drh7157e1d2009-07-09 13:25:32 +00001174 if( gap>top ) return SQLITE_CORRUPT_BKPT;
drh0a45c272009-07-08 01:49:11 +00001175 testcase( gap+2==top );
1176 testcase( gap+1==top );
1177 testcase( gap==top );
1178
danielk19776011a752009-04-01 16:25:32 +00001179 if( nFrag>=60 ){
drh0a45c272009-07-08 01:49:11 +00001180 /* Always defragment highly fragmented pages */
1181 rc = defragmentPage(pPage);
1182 if( rc ) return rc;
drh5d433ce2010-08-14 16:02:52 +00001183 top = get2byteNotZero(&data[hdr+5]);
drh0a45c272009-07-08 01:49:11 +00001184 }else if( gap+2<=top ){
danielk19776011a752009-04-01 16:25:32 +00001185 /* Search the freelist looking for a free slot big enough to satisfy
1186 ** the request. The allocation is made from the first free slot in
1187 ** the list that is large enough to accomadate it.
1188 */
1189 int pc, addr;
1190 for(addr=hdr+1; (pc = get2byte(&data[addr]))>0; addr=pc){
drh00ce3942009-12-06 03:35:51 +00001191 int size; /* Size of the free slot */
1192 if( pc>usableSize-4 || pc<addr+4 ){
1193 return SQLITE_CORRUPT_BKPT;
1194 }
1195 size = get2byte(&data[pc+2]);
drh43605152004-05-29 21:46:49 +00001196 if( size>=nByte ){
drhf49661a2008-12-10 16:45:50 +00001197 int x = size - nByte;
drh0a45c272009-07-08 01:49:11 +00001198 testcase( x==4 );
1199 testcase( x==3 );
danielk19776011a752009-04-01 16:25:32 +00001200 if( x<4 ){
danielk1977fad91942009-04-29 17:49:59 +00001201 /* Remove the slot from the free-list. Update the number of
1202 ** fragmented bytes within the page. */
drh43605152004-05-29 21:46:49 +00001203 memcpy(&data[addr], &data[pc], 2);
drhf49661a2008-12-10 16:45:50 +00001204 data[hdr+7] = (u8)(nFrag + x);
drh00ce3942009-12-06 03:35:51 +00001205 }else if( size+pc > usableSize ){
1206 return SQLITE_CORRUPT_BKPT;
drh43605152004-05-29 21:46:49 +00001207 }else{
danielk1977fad91942009-04-29 17:49:59 +00001208 /* The slot remains on the free-list. Reduce its size to account
1209 ** for the portion used by the new allocation. */
drhf49661a2008-12-10 16:45:50 +00001210 put2byte(&data[pc+2], x);
drh43605152004-05-29 21:46:49 +00001211 }
drh0a45c272009-07-08 01:49:11 +00001212 *pIdx = pc + x;
1213 return SQLITE_OK;
drh43605152004-05-29 21:46:49 +00001214 }
drh9e572e62004-04-23 23:43:10 +00001215 }
1216 }
drh43605152004-05-29 21:46:49 +00001217
drh0a45c272009-07-08 01:49:11 +00001218 /* Check to make sure there is enough space in the gap to satisfy
1219 ** the allocation. If not, defragment.
1220 */
1221 testcase( gap+2+nByte==top );
1222 if( gap+2+nByte>top ){
1223 rc = defragmentPage(pPage);
1224 if( rc ) return rc;
drh5d433ce2010-08-14 16:02:52 +00001225 top = get2byteNotZero(&data[hdr+5]);
drh0a45c272009-07-08 01:49:11 +00001226 assert( gap+nByte<=top );
1227 }
1228
1229
drh43605152004-05-29 21:46:49 +00001230 /* Allocate memory from the gap in between the cell pointer array
drhc314dc72009-07-21 11:52:34 +00001231 ** and the cell content area. The btreeInitPage() call has already
1232 ** validated the freelist. Given that the freelist is valid, there
1233 ** is no way that the allocation can extend off the end of the page.
1234 ** The assert() below verifies the previous sentence.
drh43605152004-05-29 21:46:49 +00001235 */
drh0a45c272009-07-08 01:49:11 +00001236 top -= nByte;
drh43605152004-05-29 21:46:49 +00001237 put2byte(&data[hdr+5], top);
drhfcd71b62011-04-05 22:08:24 +00001238 assert( top+nByte <= (int)pPage->pBt->usableSize );
drh0a45c272009-07-08 01:49:11 +00001239 *pIdx = top;
1240 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001241}
1242
1243/*
drh9e572e62004-04-23 23:43:10 +00001244** Return a section of the pPage->aData to the freelist.
1245** The first byte of the new free block is pPage->aDisk[start]
1246** and the size of the block is "size" bytes.
drh306dc212001-05-21 13:45:10 +00001247**
1248** Most of the effort here is involved in coalesing adjacent
1249** free blocks into a single big free block.
drh7e3b0a02001-04-28 16:52:40 +00001250*/
shanedcc50b72008-11-13 18:29:50 +00001251static int freeSpace(MemPage *pPage, int start, int size){
drh43605152004-05-29 21:46:49 +00001252 int addr, pbegin, hdr;
drh0a45c272009-07-08 01:49:11 +00001253 int iLast; /* Largest possible freeblock offset */
drh9e572e62004-04-23 23:43:10 +00001254 unsigned char *data = pPage->aData;
drh2af926b2001-05-15 00:39:25 +00001255
drh9e572e62004-04-23 23:43:10 +00001256 assert( pPage->pBt!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00001257 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drhc046e3e2009-07-15 11:26:44 +00001258 assert( start>=pPage->hdrOffset+6+pPage->childPtrSize );
drhfcd71b62011-04-05 22:08:24 +00001259 assert( (start + size) <= (int)pPage->pBt->usableSize );
drh1fee73e2007-08-29 04:00:57 +00001260 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh34004ce2008-07-11 16:15:17 +00001261 assert( size>=0 ); /* Minimum cell size is 4 */
drh9e572e62004-04-23 23:43:10 +00001262
drhc9166342012-01-05 23:32:06 +00001263 if( pPage->pBt->btsFlags & BTS_SECURE_DELETE ){
drh5b47efa2010-02-12 18:18:39 +00001264 /* Overwrite deleted information with zeros when the secure_delete
1265 ** option is enabled */
1266 memset(&data[start], 0, size);
1267 }
drhfcce93f2006-02-22 03:08:32 +00001268
drh0a45c272009-07-08 01:49:11 +00001269 /* Add the space back into the linked list of freeblocks. Note that
danielk197730548662009-07-09 05:07:37 +00001270 ** even though the freeblock list was checked by btreeInitPage(),
1271 ** btreeInitPage() did not detect overlapping cells or
drhb908d762009-07-08 16:54:40 +00001272 ** freeblocks that overlapped cells. Nor does it detect when the
1273 ** cell content area exceeds the value in the page header. If these
1274 ** situations arise, then subsequent insert operations might corrupt
1275 ** the freelist. So we do need to check for corruption while scanning
1276 ** the freelist.
drh0a45c272009-07-08 01:49:11 +00001277 */
drh43605152004-05-29 21:46:49 +00001278 hdr = pPage->hdrOffset;
1279 addr = hdr + 1;
drh0a45c272009-07-08 01:49:11 +00001280 iLast = pPage->pBt->usableSize - 4;
drh35a25da2009-07-08 15:14:50 +00001281 assert( start<=iLast );
drh3aac2dd2004-04-26 14:10:20 +00001282 while( (pbegin = get2byte(&data[addr]))<start && pbegin>0 ){
drh35a25da2009-07-08 15:14:50 +00001283 if( pbegin<addr+4 ){
shanedcc50b72008-11-13 18:29:50 +00001284 return SQLITE_CORRUPT_BKPT;
1285 }
drh3aac2dd2004-04-26 14:10:20 +00001286 addr = pbegin;
drh2af926b2001-05-15 00:39:25 +00001287 }
drh0a45c272009-07-08 01:49:11 +00001288 if( pbegin>iLast ){
shanedcc50b72008-11-13 18:29:50 +00001289 return SQLITE_CORRUPT_BKPT;
1290 }
drh3aac2dd2004-04-26 14:10:20 +00001291 assert( pbegin>addr || pbegin==0 );
drha34b6762004-05-07 13:30:42 +00001292 put2byte(&data[addr], start);
1293 put2byte(&data[start], pbegin);
1294 put2byte(&data[start+2], size);
shane36840fd2009-06-26 16:32:13 +00001295 pPage->nFree = pPage->nFree + (u16)size;
drh9e572e62004-04-23 23:43:10 +00001296
1297 /* Coalesce adjacent free blocks */
drh0a45c272009-07-08 01:49:11 +00001298 addr = hdr + 1;
drh3aac2dd2004-04-26 14:10:20 +00001299 while( (pbegin = get2byte(&data[addr]))>0 ){
drhf49661a2008-12-10 16:45:50 +00001300 int pnext, psize, x;
drh3aac2dd2004-04-26 14:10:20 +00001301 assert( pbegin>addr );
drhfcd71b62011-04-05 22:08:24 +00001302 assert( pbegin <= (int)pPage->pBt->usableSize-4 );
drh9e572e62004-04-23 23:43:10 +00001303 pnext = get2byte(&data[pbegin]);
1304 psize = get2byte(&data[pbegin+2]);
1305 if( pbegin + psize + 3 >= pnext && pnext>0 ){
1306 int frag = pnext - (pbegin+psize);
drh0a45c272009-07-08 01:49:11 +00001307 if( (frag<0) || (frag>(int)data[hdr+7]) ){
shanedcc50b72008-11-13 18:29:50 +00001308 return SQLITE_CORRUPT_BKPT;
1309 }
drh0a45c272009-07-08 01:49:11 +00001310 data[hdr+7] -= (u8)frag;
drhf49661a2008-12-10 16:45:50 +00001311 x = get2byte(&data[pnext]);
1312 put2byte(&data[pbegin], x);
1313 x = pnext + get2byte(&data[pnext+2]) - pbegin;
1314 put2byte(&data[pbegin+2], x);
drh9e572e62004-04-23 23:43:10 +00001315 }else{
drh3aac2dd2004-04-26 14:10:20 +00001316 addr = pbegin;
drh9e572e62004-04-23 23:43:10 +00001317 }
1318 }
drh7e3b0a02001-04-28 16:52:40 +00001319
drh43605152004-05-29 21:46:49 +00001320 /* If the cell content area begins with a freeblock, remove it. */
1321 if( data[hdr+1]==data[hdr+5] && data[hdr+2]==data[hdr+6] ){
1322 int top;
1323 pbegin = get2byte(&data[hdr+1]);
1324 memcpy(&data[hdr+1], &data[pbegin], 2);
drhf49661a2008-12-10 16:45:50 +00001325 top = get2byte(&data[hdr+5]) + get2byte(&data[pbegin+2]);
1326 put2byte(&data[hdr+5], top);
drh4b70f112004-05-02 21:12:19 +00001327 }
drhc5053fb2008-11-27 02:22:10 +00001328 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
shanedcc50b72008-11-13 18:29:50 +00001329 return SQLITE_OK;
drh4b70f112004-05-02 21:12:19 +00001330}
1331
1332/*
drh271efa52004-05-30 19:19:05 +00001333** Decode the flags byte (the first byte of the header) for a page
1334** and initialize fields of the MemPage structure accordingly.
drh44845222008-07-17 18:39:57 +00001335**
1336** Only the following combinations are supported. Anything different
1337** indicates a corrupt database files:
1338**
1339** PTF_ZERODATA
1340** PTF_ZERODATA | PTF_LEAF
1341** PTF_LEAFDATA | PTF_INTKEY
1342** PTF_LEAFDATA | PTF_INTKEY | PTF_LEAF
drh271efa52004-05-30 19:19:05 +00001343*/
drh44845222008-07-17 18:39:57 +00001344static int decodeFlags(MemPage *pPage, int flagByte){
danielk1977aef0bf62005-12-30 16:28:01 +00001345 BtShared *pBt; /* A copy of pPage->pBt */
drh271efa52004-05-30 19:19:05 +00001346
1347 assert( pPage->hdrOffset==(pPage->pgno==1 ? 100 : 0) );
drh1fee73e2007-08-29 04:00:57 +00001348 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhf49661a2008-12-10 16:45:50 +00001349 pPage->leaf = (u8)(flagByte>>3); assert( PTF_LEAF == 1<<3 );
drh44845222008-07-17 18:39:57 +00001350 flagByte &= ~PTF_LEAF;
1351 pPage->childPtrSize = 4-4*pPage->leaf;
drh271efa52004-05-30 19:19:05 +00001352 pBt = pPage->pBt;
drh44845222008-07-17 18:39:57 +00001353 if( flagByte==(PTF_LEAFDATA | PTF_INTKEY) ){
1354 pPage->intKey = 1;
1355 pPage->hasData = pPage->leaf;
drh271efa52004-05-30 19:19:05 +00001356 pPage->maxLocal = pBt->maxLeaf;
1357 pPage->minLocal = pBt->minLeaf;
drh44845222008-07-17 18:39:57 +00001358 }else if( flagByte==PTF_ZERODATA ){
1359 pPage->intKey = 0;
1360 pPage->hasData = 0;
drh271efa52004-05-30 19:19:05 +00001361 pPage->maxLocal = pBt->maxLocal;
1362 pPage->minLocal = pBt->minLocal;
drh44845222008-07-17 18:39:57 +00001363 }else{
1364 return SQLITE_CORRUPT_BKPT;
drh271efa52004-05-30 19:19:05 +00001365 }
drhc9166342012-01-05 23:32:06 +00001366 pPage->max1bytePayload = pBt->max1bytePayload;
drh44845222008-07-17 18:39:57 +00001367 return SQLITE_OK;
drh271efa52004-05-30 19:19:05 +00001368}
1369
1370/*
drh7e3b0a02001-04-28 16:52:40 +00001371** Initialize the auxiliary information for a disk block.
drh72f82862001-05-24 21:06:34 +00001372**
1373** Return SQLITE_OK on success. If we see that the page does
drhda47d772002-12-02 04:25:19 +00001374** not contain a well-formed database page, then return
drh72f82862001-05-24 21:06:34 +00001375** SQLITE_CORRUPT. Note that a return of SQLITE_OK does not
1376** guarantee that the page is well-formed. It only shows that
1377** we failed to detect any corruption.
drh7e3b0a02001-04-28 16:52:40 +00001378*/
danielk197730548662009-07-09 05:07:37 +00001379static int btreeInitPage(MemPage *pPage){
drh2af926b2001-05-15 00:39:25 +00001380
danielk197771d5d2c2008-09-29 11:49:47 +00001381 assert( pPage->pBt!=0 );
1382 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00001383 assert( pPage->pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
drhbf4bca52007-09-06 22:19:14 +00001384 assert( pPage == sqlite3PagerGetExtra(pPage->pDbPage) );
1385 assert( pPage->aData == sqlite3PagerGetData(pPage->pDbPage) );
danielk197771d5d2c2008-09-29 11:49:47 +00001386
1387 if( !pPage->isInit ){
drhf49661a2008-12-10 16:45:50 +00001388 u16 pc; /* Address of a freeblock within pPage->aData[] */
1389 u8 hdr; /* Offset to beginning of page header */
danielk197771d5d2c2008-09-29 11:49:47 +00001390 u8 *data; /* Equal to pPage->aData */
1391 BtShared *pBt; /* The main btree structure */
drhb2eced52010-08-12 02:41:12 +00001392 int usableSize; /* Amount of usable space on each page */
shaneh1df2db72010-08-18 02:28:48 +00001393 u16 cellOffset; /* Offset from start of page to first cell pointer */
drhb2eced52010-08-12 02:41:12 +00001394 int nFree; /* Number of unused bytes on the page */
1395 int top; /* First byte of the cell content area */
drh0a45c272009-07-08 01:49:11 +00001396 int iCellFirst; /* First allowable cell or freeblock offset */
1397 int iCellLast; /* Last possible cell or freeblock offset */
danielk197771d5d2c2008-09-29 11:49:47 +00001398
1399 pBt = pPage->pBt;
1400
danielk1977eaa06f62008-09-18 17:34:44 +00001401 hdr = pPage->hdrOffset;
1402 data = pPage->aData;
1403 if( decodeFlags(pPage, data[hdr]) ) return SQLITE_CORRUPT_BKPT;
drhb2eced52010-08-12 02:41:12 +00001404 assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
1405 pPage->maskPage = (u16)(pBt->pageSize - 1);
danielk1977eaa06f62008-09-18 17:34:44 +00001406 pPage->nOverflow = 0;
danielk1977eaa06f62008-09-18 17:34:44 +00001407 usableSize = pBt->usableSize;
1408 pPage->cellOffset = cellOffset = hdr + 12 - 4*pPage->leaf;
drh3def2352011-11-11 00:27:15 +00001409 pPage->aDataEnd = &data[usableSize];
1410 pPage->aCellIdx = &data[cellOffset];
drh5d433ce2010-08-14 16:02:52 +00001411 top = get2byteNotZero(&data[hdr+5]);
danielk1977eaa06f62008-09-18 17:34:44 +00001412 pPage->nCell = get2byte(&data[hdr+3]);
1413 if( pPage->nCell>MX_CELL(pBt) ){
1414 /* To many cells for a single page. The page must be corrupt */
1415 return SQLITE_CORRUPT_BKPT;
1416 }
drhb908d762009-07-08 16:54:40 +00001417 testcase( pPage->nCell==MX_CELL(pBt) );
drh69e931e2009-06-03 21:04:35 +00001418
shane5eff7cf2009-08-10 03:57:58 +00001419 /* A malformed database page might cause us to read past the end
drh69e931e2009-06-03 21:04:35 +00001420 ** of page when parsing a cell.
1421 **
1422 ** The following block of code checks early to see if a cell extends
1423 ** past the end of a page boundary and causes SQLITE_CORRUPT to be
1424 ** returned if it does.
1425 */
drh0a45c272009-07-08 01:49:11 +00001426 iCellFirst = cellOffset + 2*pPage->nCell;
1427 iCellLast = usableSize - 4;
drh3b2a3fa2009-06-09 13:42:24 +00001428#if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
drh69e931e2009-06-03 21:04:35 +00001429 {
drh69e931e2009-06-03 21:04:35 +00001430 int i; /* Index into the cell pointer array */
1431 int sz; /* Size of a cell */
1432
drh69e931e2009-06-03 21:04:35 +00001433 if( !pPage->leaf ) iCellLast--;
1434 for(i=0; i<pPage->nCell; i++){
1435 pc = get2byte(&data[cellOffset+i*2]);
drh0a45c272009-07-08 01:49:11 +00001436 testcase( pc==iCellFirst );
1437 testcase( pc==iCellLast );
drh69e931e2009-06-03 21:04:35 +00001438 if( pc<iCellFirst || pc>iCellLast ){
1439 return SQLITE_CORRUPT_BKPT;
1440 }
1441 sz = cellSizePtr(pPage, &data[pc]);
drh0a45c272009-07-08 01:49:11 +00001442 testcase( pc+sz==usableSize );
drh69e931e2009-06-03 21:04:35 +00001443 if( pc+sz>usableSize ){
1444 return SQLITE_CORRUPT_BKPT;
1445 }
1446 }
drh0a45c272009-07-08 01:49:11 +00001447 if( !pPage->leaf ) iCellLast++;
drh69e931e2009-06-03 21:04:35 +00001448 }
1449#endif
1450
danielk1977eaa06f62008-09-18 17:34:44 +00001451 /* Compute the total free space on the page */
1452 pc = get2byte(&data[hdr+1]);
danielk197793c829c2009-06-03 17:26:17 +00001453 nFree = data[hdr+7] + top;
danielk1977eaa06f62008-09-18 17:34:44 +00001454 while( pc>0 ){
drh1bd10f82008-12-10 21:19:56 +00001455 u16 next, size;
drh0a45c272009-07-08 01:49:11 +00001456 if( pc<iCellFirst || pc>iCellLast ){
dan4361e792009-08-14 17:01:22 +00001457 /* Start of free block is off the page */
danielk1977eaa06f62008-09-18 17:34:44 +00001458 return SQLITE_CORRUPT_BKPT;
1459 }
1460 next = get2byte(&data[pc]);
1461 size = get2byte(&data[pc+2]);
dan4361e792009-08-14 17:01:22 +00001462 if( (next>0 && next<=pc+size+3) || pc+size>usableSize ){
1463 /* Free blocks must be in ascending order. And the last byte of
1464 ** the free-block must lie on the database page. */
danielk1977eaa06f62008-09-18 17:34:44 +00001465 return SQLITE_CORRUPT_BKPT;
1466 }
shane85095702009-06-15 16:27:08 +00001467 nFree = nFree + size;
danielk1977eaa06f62008-09-18 17:34:44 +00001468 pc = next;
1469 }
danielk197793c829c2009-06-03 17:26:17 +00001470
1471 /* At this point, nFree contains the sum of the offset to the start
1472 ** of the cell-content area plus the number of free bytes within
1473 ** the cell-content area. If this is greater than the usable-size
1474 ** of the page, then the page must be corrupted. This check also
1475 ** serves to verify that the offset to the start of the cell-content
1476 ** area, according to the page header, lies within the page.
1477 */
1478 if( nFree>usableSize ){
drh49285702005-09-17 15:20:26 +00001479 return SQLITE_CORRUPT_BKPT;
drhee696e22004-08-30 16:52:17 +00001480 }
shane5eff7cf2009-08-10 03:57:58 +00001481 pPage->nFree = (u16)(nFree - iCellFirst);
danielk197771d5d2c2008-09-29 11:49:47 +00001482 pPage->isInit = 1;
1483 }
drh9e572e62004-04-23 23:43:10 +00001484 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001485}
1486
1487/*
drh8b2f49b2001-06-08 00:21:52 +00001488** Set up a raw page so that it looks like a database page holding
1489** no entries.
drhbd03cae2001-06-02 02:40:57 +00001490*/
drh9e572e62004-04-23 23:43:10 +00001491static void zeroPage(MemPage *pPage, int flags){
1492 unsigned char *data = pPage->aData;
danielk1977aef0bf62005-12-30 16:28:01 +00001493 BtShared *pBt = pPage->pBt;
drhf49661a2008-12-10 16:45:50 +00001494 u8 hdr = pPage->hdrOffset;
1495 u16 first;
drh9e572e62004-04-23 23:43:10 +00001496
danielk19773b8a05f2007-03-19 17:44:26 +00001497 assert( sqlite3PagerPagenumber(pPage->pDbPage)==pPage->pgno );
drhbf4bca52007-09-06 22:19:14 +00001498 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
1499 assert( sqlite3PagerGetData(pPage->pDbPage) == data );
danielk19773b8a05f2007-03-19 17:44:26 +00001500 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00001501 assert( sqlite3_mutex_held(pBt->mutex) );
drhc9166342012-01-05 23:32:06 +00001502 if( pBt->btsFlags & BTS_SECURE_DELETE ){
drh5b47efa2010-02-12 18:18:39 +00001503 memset(&data[hdr], 0, pBt->usableSize - hdr);
1504 }
drh1bd10f82008-12-10 21:19:56 +00001505 data[hdr] = (char)flags;
1506 first = hdr + 8 + 4*((flags&PTF_LEAF)==0 ?1:0);
drh43605152004-05-29 21:46:49 +00001507 memset(&data[hdr+1], 0, 4);
1508 data[hdr+7] = 0;
1509 put2byte(&data[hdr+5], pBt->usableSize);
shaneh1df2db72010-08-18 02:28:48 +00001510 pPage->nFree = (u16)(pBt->usableSize - first);
drh271efa52004-05-30 19:19:05 +00001511 decodeFlags(pPage, flags);
drh9e572e62004-04-23 23:43:10 +00001512 pPage->hdrOffset = hdr;
drh43605152004-05-29 21:46:49 +00001513 pPage->cellOffset = first;
drh3def2352011-11-11 00:27:15 +00001514 pPage->aDataEnd = &data[pBt->usableSize];
1515 pPage->aCellIdx = &data[first];
drh43605152004-05-29 21:46:49 +00001516 pPage->nOverflow = 0;
drhb2eced52010-08-12 02:41:12 +00001517 assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
1518 pPage->maskPage = (u16)(pBt->pageSize - 1);
drh43605152004-05-29 21:46:49 +00001519 pPage->nCell = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00001520 pPage->isInit = 1;
drhbd03cae2001-06-02 02:40:57 +00001521}
1522
drh897a8202008-09-18 01:08:15 +00001523
1524/*
1525** Convert a DbPage obtained from the pager into a MemPage used by
1526** the btree layer.
1527*/
1528static MemPage *btreePageFromDbPage(DbPage *pDbPage, Pgno pgno, BtShared *pBt){
1529 MemPage *pPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
1530 pPage->aData = sqlite3PagerGetData(pDbPage);
1531 pPage->pDbPage = pDbPage;
1532 pPage->pBt = pBt;
1533 pPage->pgno = pgno;
1534 pPage->hdrOffset = pPage->pgno==1 ? 100 : 0;
1535 return pPage;
1536}
1537
drhbd03cae2001-06-02 02:40:57 +00001538/*
drh3aac2dd2004-04-26 14:10:20 +00001539** Get a page from the pager. Initialize the MemPage.pBt and
1540** MemPage.aData elements if needed.
drh538f5702007-04-13 02:14:30 +00001541**
1542** If the noContent flag is set, it means that we do not care about
1543** the content of the page at this time. So do not go to the disk
1544** to fetch the content. Just fill in the content with zeros for now.
1545** If in the future we call sqlite3PagerWrite() on this page, that
1546** means we have started to be concerned about content and the disk
1547** read should occur at that point.
drh3aac2dd2004-04-26 14:10:20 +00001548*/
danielk197730548662009-07-09 05:07:37 +00001549static int btreeGetPage(
drh16a9b832007-05-05 18:39:25 +00001550 BtShared *pBt, /* The btree */
1551 Pgno pgno, /* Number of the page to fetch */
1552 MemPage **ppPage, /* Return the page in this parameter */
1553 int noContent /* Do not load page content if true */
1554){
drh3aac2dd2004-04-26 14:10:20 +00001555 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00001556 DbPage *pDbPage;
1557
drh1fee73e2007-08-29 04:00:57 +00001558 assert( sqlite3_mutex_held(pBt->mutex) );
drh538f5702007-04-13 02:14:30 +00001559 rc = sqlite3PagerAcquire(pBt->pPager, pgno, (DbPage**)&pDbPage, noContent);
drh3aac2dd2004-04-26 14:10:20 +00001560 if( rc ) return rc;
drh897a8202008-09-18 01:08:15 +00001561 *ppPage = btreePageFromDbPage(pDbPage, pgno, pBt);
drh3aac2dd2004-04-26 14:10:20 +00001562 return SQLITE_OK;
1563}
1564
1565/*
danielk1977bea2a942009-01-20 17:06:27 +00001566** Retrieve a page from the pager cache. If the requested page is not
1567** already in the pager cache return NULL. Initialize the MemPage.pBt and
1568** MemPage.aData elements if needed.
1569*/
1570static MemPage *btreePageLookup(BtShared *pBt, Pgno pgno){
1571 DbPage *pDbPage;
1572 assert( sqlite3_mutex_held(pBt->mutex) );
1573 pDbPage = sqlite3PagerLookup(pBt->pPager, pgno);
1574 if( pDbPage ){
1575 return btreePageFromDbPage(pDbPage, pgno, pBt);
1576 }
1577 return 0;
1578}
1579
1580/*
danielk197789d40042008-11-17 14:20:56 +00001581** Return the size of the database file in pages. If there is any kind of
1582** error, return ((unsigned int)-1).
danielk197767fd7a92008-09-10 17:53:35 +00001583*/
drhb1299152010-03-30 22:58:33 +00001584static Pgno btreePagecount(BtShared *pBt){
1585 return pBt->nPage;
1586}
1587u32 sqlite3BtreeLastPage(Btree *p){
1588 assert( sqlite3BtreeHoldsMutex(p) );
1589 assert( ((p->pBt->nPage)&0x8000000)==0 );
1590 return (int)btreePagecount(p->pBt);
danielk197767fd7a92008-09-10 17:53:35 +00001591}
1592
1593/*
danielk197789bc4bc2009-07-21 19:25:24 +00001594** Get a page from the pager and initialize it. This routine is just a
1595** convenience wrapper around separate calls to btreeGetPage() and
1596** btreeInitPage().
1597**
1598** If an error occurs, then the value *ppPage is set to is undefined. It
1599** may remain unchanged, or it may be set to an invalid value.
drhde647132004-05-07 17:57:49 +00001600*/
1601static int getAndInitPage(
danielk1977aef0bf62005-12-30 16:28:01 +00001602 BtShared *pBt, /* The database file */
drhde647132004-05-07 17:57:49 +00001603 Pgno pgno, /* Number of the page to get */
danielk197771d5d2c2008-09-29 11:49:47 +00001604 MemPage **ppPage /* Write the page pointer here */
drhde647132004-05-07 17:57:49 +00001605){
1606 int rc;
drh1fee73e2007-08-29 04:00:57 +00001607 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197789bc4bc2009-07-21 19:25:24 +00001608
danba3cbf32010-06-30 04:29:03 +00001609 if( pgno>btreePagecount(pBt) ){
1610 rc = SQLITE_CORRUPT_BKPT;
1611 }else{
1612 rc = btreeGetPage(pBt, pgno, ppPage, 0);
1613 if( rc==SQLITE_OK ){
1614 rc = btreeInitPage(*ppPage);
1615 if( rc!=SQLITE_OK ){
1616 releasePage(*ppPage);
1617 }
danielk197789bc4bc2009-07-21 19:25:24 +00001618 }
drhee696e22004-08-30 16:52:17 +00001619 }
danba3cbf32010-06-30 04:29:03 +00001620
1621 testcase( pgno==0 );
1622 assert( pgno!=0 || rc==SQLITE_CORRUPT );
drhde647132004-05-07 17:57:49 +00001623 return rc;
1624}
1625
1626/*
drh3aac2dd2004-04-26 14:10:20 +00001627** Release a MemPage. This should be called once for each prior
danielk197730548662009-07-09 05:07:37 +00001628** call to btreeGetPage.
drh3aac2dd2004-04-26 14:10:20 +00001629*/
drh4b70f112004-05-02 21:12:19 +00001630static void releasePage(MemPage *pPage){
drh3aac2dd2004-04-26 14:10:20 +00001631 if( pPage ){
1632 assert( pPage->aData );
1633 assert( pPage->pBt );
drhbf4bca52007-09-06 22:19:14 +00001634 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
1635 assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
drh1fee73e2007-08-29 04:00:57 +00001636 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00001637 sqlite3PagerUnref(pPage->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00001638 }
1639}
1640
1641/*
drha6abd042004-06-09 17:37:22 +00001642** During a rollback, when the pager reloads information into the cache
1643** so that the cache is restored to its original state at the start of
1644** the transaction, for each page restored this routine is called.
1645**
1646** This routine needs to reset the extra data section at the end of the
1647** page to agree with the restored data.
1648*/
danielk1977eaa06f62008-09-18 17:34:44 +00001649static void pageReinit(DbPage *pData){
drh07d183d2005-05-01 22:52:42 +00001650 MemPage *pPage;
danielk19773b8a05f2007-03-19 17:44:26 +00001651 pPage = (MemPage *)sqlite3PagerGetExtra(pData);
danielk1977d217e6f2009-04-01 17:13:51 +00001652 assert( sqlite3PagerPageRefcount(pData)>0 );
danielk197771d5d2c2008-09-29 11:49:47 +00001653 if( pPage->isInit ){
drh1fee73e2007-08-29 04:00:57 +00001654 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drha6abd042004-06-09 17:37:22 +00001655 pPage->isInit = 0;
danielk1977d217e6f2009-04-01 17:13:51 +00001656 if( sqlite3PagerPageRefcount(pData)>1 ){
drh5e8d8872009-03-30 17:19:48 +00001657 /* pPage might not be a btree page; it might be an overflow page
1658 ** or ptrmap page or a free page. In those cases, the following
danielk197730548662009-07-09 05:07:37 +00001659 ** call to btreeInitPage() will likely return SQLITE_CORRUPT.
drh5e8d8872009-03-30 17:19:48 +00001660 ** But no harm is done by this. And it is very important that
danielk197730548662009-07-09 05:07:37 +00001661 ** btreeInitPage() be called on every btree page so we make
drh5e8d8872009-03-30 17:19:48 +00001662 ** the call for every page that comes in for re-initing. */
danielk197730548662009-07-09 05:07:37 +00001663 btreeInitPage(pPage);
danielk197771d5d2c2008-09-29 11:49:47 +00001664 }
drha6abd042004-06-09 17:37:22 +00001665 }
1666}
1667
1668/*
drhe5fe6902007-12-07 18:55:28 +00001669** Invoke the busy handler for a btree.
1670*/
danielk19771ceedd32008-11-19 10:22:33 +00001671static int btreeInvokeBusyHandler(void *pArg){
drhe5fe6902007-12-07 18:55:28 +00001672 BtShared *pBt = (BtShared*)pArg;
1673 assert( pBt->db );
1674 assert( sqlite3_mutex_held(pBt->db->mutex) );
1675 return sqlite3InvokeBusyHandler(&pBt->db->busyHandler);
1676}
1677
1678/*
drhad3e0102004-09-03 23:32:18 +00001679** Open a database file.
1680**
drh382c0242001-10-06 16:33:02 +00001681** zFilename is the name of the database file. If zFilename is NULL
drh75c014c2010-08-30 15:02:28 +00001682** then an ephemeral database is created. The ephemeral database might
1683** be exclusively in memory, or it might use a disk-based memory cache.
1684** Either way, the ephemeral database will be automatically deleted
1685** when sqlite3BtreeClose() is called.
1686**
drhe53831d2007-08-17 01:14:38 +00001687** If zFilename is ":memory:" then an in-memory database is created
1688** that is automatically destroyed when it is closed.
drhc47fd8e2009-04-30 13:30:32 +00001689**
drh33f111d2012-01-17 15:29:14 +00001690** The "flags" parameter is a bitmask that might contain bits like
1691** BTREE_OMIT_JOURNAL and/or BTREE_MEMORY.
drh75c014c2010-08-30 15:02:28 +00001692**
drhc47fd8e2009-04-30 13:30:32 +00001693** If the database is already opened in the same database connection
1694** and we are in shared cache mode, then the open will fail with an
1695** SQLITE_CONSTRAINT error. We cannot allow two or more BtShared
1696** objects in the same database connection since doing so will lead
1697** to problems with locking.
drha059ad02001-04-17 20:09:11 +00001698*/
drh23e11ca2004-05-04 17:27:28 +00001699int sqlite3BtreeOpen(
dan3a6d8ae2011-04-23 15:54:54 +00001700 sqlite3_vfs *pVfs, /* VFS to use for this b-tree */
drh3aac2dd2004-04-26 14:10:20 +00001701 const char *zFilename, /* Name of the file containing the BTree database */
drhe5fe6902007-12-07 18:55:28 +00001702 sqlite3 *db, /* Associated database handle */
drh3aac2dd2004-04-26 14:10:20 +00001703 Btree **ppBtree, /* Pointer to new Btree object written here */
drh33f4e022007-09-03 15:19:34 +00001704 int flags, /* Options */
1705 int vfsFlags /* Flags passed through to sqlite3_vfs.xOpen() */
drh6019e162001-07-02 17:51:45 +00001706){
drh7555d8e2009-03-20 13:15:30 +00001707 BtShared *pBt = 0; /* Shared part of btree structure */
1708 Btree *p; /* Handle to return */
1709 sqlite3_mutex *mutexOpen = 0; /* Prevents a race condition. Ticket #3537 */
1710 int rc = SQLITE_OK; /* Result code from this function */
1711 u8 nReserve; /* Byte of unused space on each page */
1712 unsigned char zDbHeader[100]; /* Database header content */
danielk1977aef0bf62005-12-30 16:28:01 +00001713
drh75c014c2010-08-30 15:02:28 +00001714 /* True if opening an ephemeral, temporary database */
1715 const int isTempDb = zFilename==0 || zFilename[0]==0;
1716
danielk1977aef0bf62005-12-30 16:28:01 +00001717 /* Set the variable isMemdb to true for an in-memory database, or
drhb0a7c9c2010-12-06 21:09:59 +00001718 ** false for a file-based database.
danielk1977aef0bf62005-12-30 16:28:01 +00001719 */
drhb0a7c9c2010-12-06 21:09:59 +00001720#ifdef SQLITE_OMIT_MEMORYDB
1721 const int isMemdb = 0;
1722#else
1723 const int isMemdb = (zFilename && strcmp(zFilename, ":memory:")==0)
1724 || (isTempDb && sqlite3TempInMemory(db));
danielk1977aef0bf62005-12-30 16:28:01 +00001725#endif
1726
drhe5fe6902007-12-07 18:55:28 +00001727 assert( db!=0 );
dan3a6d8ae2011-04-23 15:54:54 +00001728 assert( pVfs!=0 );
drhe5fe6902007-12-07 18:55:28 +00001729 assert( sqlite3_mutex_held(db->mutex) );
drhd4187c72010-08-30 22:15:45 +00001730 assert( (flags&0xff)==flags ); /* flags fit in 8 bits */
1731
1732 /* Only a BTREE_SINGLE database can be BTREE_UNORDERED */
1733 assert( (flags & BTREE_UNORDERED)==0 || (flags & BTREE_SINGLE)!=0 );
1734
1735 /* A BTREE_SINGLE database is always a temporary and/or ephemeral */
1736 assert( (flags & BTREE_SINGLE)==0 || isTempDb );
drh153c62c2007-08-24 03:51:33 +00001737
drh75c014c2010-08-30 15:02:28 +00001738 if( isMemdb ){
1739 flags |= BTREE_MEMORY;
1740 }
1741 if( (vfsFlags & SQLITE_OPEN_MAIN_DB)!=0 && (isMemdb || isTempDb) ){
1742 vfsFlags = (vfsFlags & ~SQLITE_OPEN_MAIN_DB) | SQLITE_OPEN_TEMP_DB;
1743 }
drh17435752007-08-16 04:30:38 +00001744 p = sqlite3MallocZero(sizeof(Btree));
danielk1977aef0bf62005-12-30 16:28:01 +00001745 if( !p ){
1746 return SQLITE_NOMEM;
1747 }
1748 p->inTrans = TRANS_NONE;
drhe5fe6902007-12-07 18:55:28 +00001749 p->db = db;
danielk1977602b4662009-07-02 07:47:33 +00001750#ifndef SQLITE_OMIT_SHARED_CACHE
1751 p->lock.pBtree = p;
1752 p->lock.iTable = 1;
1753#endif
danielk1977aef0bf62005-12-30 16:28:01 +00001754
drh198bf392006-01-06 21:52:49 +00001755#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00001756 /*
1757 ** If this Btree is a candidate for shared cache, try to find an
1758 ** existing BtShared object that we can share with
1759 */
drh75c014c2010-08-30 15:02:28 +00001760 if( isMemdb==0 && isTempDb==0 ){
drhf1f12682009-09-09 14:17:52 +00001761 if( vfsFlags & SQLITE_OPEN_SHAREDCACHE ){
danielk1977adfb9b02007-09-17 07:02:56 +00001762 int nFullPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001763 char *zFullPathname = sqlite3Malloc(nFullPathname);
drh30ddce62011-10-15 00:16:30 +00001764 MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
drhff0587c2007-08-29 17:43:19 +00001765 p->sharable = 1;
drhff0587c2007-08-29 17:43:19 +00001766 if( !zFullPathname ){
1767 sqlite3_free(p);
1768 return SQLITE_NOMEM;
1769 }
drh070ad6b2011-11-17 11:43:19 +00001770 rc = sqlite3OsFullPathname(pVfs, zFilename, nFullPathname, zFullPathname);
1771 if( rc ){
1772 sqlite3_free(zFullPathname);
1773 sqlite3_free(p);
1774 return rc;
1775 }
drh30ddce62011-10-15 00:16:30 +00001776#if SQLITE_THREADSAFE
drh7555d8e2009-03-20 13:15:30 +00001777 mutexOpen = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_OPEN);
1778 sqlite3_mutex_enter(mutexOpen);
danielk197759f8c082008-06-18 17:09:10 +00001779 mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhff0587c2007-08-29 17:43:19 +00001780 sqlite3_mutex_enter(mutexShared);
drh30ddce62011-10-15 00:16:30 +00001781#endif
drh78f82d12008-09-02 00:52:52 +00001782 for(pBt=GLOBAL(BtShared*,sqlite3SharedCacheList); pBt; pBt=pBt->pNext){
drhff0587c2007-08-29 17:43:19 +00001783 assert( pBt->nRef>0 );
1784 if( 0==strcmp(zFullPathname, sqlite3PagerFilename(pBt->pPager))
1785 && sqlite3PagerVfs(pBt->pPager)==pVfs ){
drhc47fd8e2009-04-30 13:30:32 +00001786 int iDb;
1787 for(iDb=db->nDb-1; iDb>=0; iDb--){
1788 Btree *pExisting = db->aDb[iDb].pBt;
1789 if( pExisting && pExisting->pBt==pBt ){
1790 sqlite3_mutex_leave(mutexShared);
1791 sqlite3_mutex_leave(mutexOpen);
1792 sqlite3_free(zFullPathname);
1793 sqlite3_free(p);
1794 return SQLITE_CONSTRAINT;
1795 }
1796 }
drhff0587c2007-08-29 17:43:19 +00001797 p->pBt = pBt;
1798 pBt->nRef++;
1799 break;
1800 }
1801 }
1802 sqlite3_mutex_leave(mutexShared);
1803 sqlite3_free(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001804 }
drhff0587c2007-08-29 17:43:19 +00001805#ifdef SQLITE_DEBUG
1806 else{
1807 /* In debug mode, we mark all persistent databases as sharable
1808 ** even when they are not. This exercises the locking code and
1809 ** gives more opportunity for asserts(sqlite3_mutex_held())
1810 ** statements to find locking problems.
1811 */
1812 p->sharable = 1;
1813 }
1814#endif
danielk1977aef0bf62005-12-30 16:28:01 +00001815 }
1816#endif
drha059ad02001-04-17 20:09:11 +00001817 if( pBt==0 ){
drhe53831d2007-08-17 01:14:38 +00001818 /*
1819 ** The following asserts make sure that structures used by the btree are
1820 ** the right size. This is to guard against size changes that result
1821 ** when compiling on a different architecture.
danielk197703aded42004-11-22 05:26:27 +00001822 */
drhe53831d2007-08-17 01:14:38 +00001823 assert( sizeof(i64)==8 || sizeof(i64)==4 );
1824 assert( sizeof(u64)==8 || sizeof(u64)==4 );
1825 assert( sizeof(u32)==4 );
1826 assert( sizeof(u16)==2 );
1827 assert( sizeof(Pgno)==4 );
1828
1829 pBt = sqlite3MallocZero( sizeof(*pBt) );
1830 if( pBt==0 ){
1831 rc = SQLITE_NOMEM;
1832 goto btree_open_out;
1833 }
danielk197771d5d2c2008-09-29 11:49:47 +00001834 rc = sqlite3PagerOpen(pVfs, &pBt->pPager, zFilename,
drh4775ecd2009-07-24 19:01:19 +00001835 EXTRA_SIZE, flags, vfsFlags, pageReinit);
drhe53831d2007-08-17 01:14:38 +00001836 if( rc==SQLITE_OK ){
1837 rc = sqlite3PagerReadFileheader(pBt->pPager,sizeof(zDbHeader),zDbHeader);
1838 }
1839 if( rc!=SQLITE_OK ){
1840 goto btree_open_out;
1841 }
shanehbd2aaf92010-09-01 02:38:21 +00001842 pBt->openFlags = (u8)flags;
danielk19772a50ff02009-04-10 09:47:06 +00001843 pBt->db = db;
danielk19771ceedd32008-11-19 10:22:33 +00001844 sqlite3PagerSetBusyhandler(pBt->pPager, btreeInvokeBusyHandler, pBt);
drhe53831d2007-08-17 01:14:38 +00001845 p->pBt = pBt;
1846
drhe53831d2007-08-17 01:14:38 +00001847 pBt->pCursor = 0;
1848 pBt->pPage1 = 0;
drhc9166342012-01-05 23:32:06 +00001849 if( sqlite3PagerIsreadonly(pBt->pPager) ) pBt->btsFlags |= BTS_READ_ONLY;
drh5b47efa2010-02-12 18:18:39 +00001850#ifdef SQLITE_SECURE_DELETE
drhc9166342012-01-05 23:32:06 +00001851 pBt->btsFlags |= BTS_SECURE_DELETE;
drh5b47efa2010-02-12 18:18:39 +00001852#endif
drhb2eced52010-08-12 02:41:12 +00001853 pBt->pageSize = (zDbHeader[16]<<8) | (zDbHeader[17]<<16);
drhe53831d2007-08-17 01:14:38 +00001854 if( pBt->pageSize<512 || pBt->pageSize>SQLITE_MAX_PAGE_SIZE
1855 || ((pBt->pageSize-1)&pBt->pageSize)!=0 ){
danielk1977a1644fd2007-08-29 12:31:25 +00001856 pBt->pageSize = 0;
drhe53831d2007-08-17 01:14:38 +00001857#ifndef SQLITE_OMIT_AUTOVACUUM
1858 /* If the magic name ":memory:" will create an in-memory database, then
1859 ** leave the autoVacuum mode at 0 (do not auto-vacuum), even if
1860 ** SQLITE_DEFAULT_AUTOVACUUM is true. On the other hand, if
1861 ** SQLITE_OMIT_MEMORYDB has been defined, then ":memory:" is just a
1862 ** regular file-name. In this case the auto-vacuum applies as per normal.
1863 */
1864 if( zFilename && !isMemdb ){
1865 pBt->autoVacuum = (SQLITE_DEFAULT_AUTOVACUUM ? 1 : 0);
1866 pBt->incrVacuum = (SQLITE_DEFAULT_AUTOVACUUM==2 ? 1 : 0);
1867 }
1868#endif
1869 nReserve = 0;
1870 }else{
1871 nReserve = zDbHeader[20];
drhc9166342012-01-05 23:32:06 +00001872 pBt->btsFlags |= BTS_PAGESIZE_FIXED;
drhe53831d2007-08-17 01:14:38 +00001873#ifndef SQLITE_OMIT_AUTOVACUUM
1874 pBt->autoVacuum = (get4byte(&zDbHeader[36 + 4*4])?1:0);
1875 pBt->incrVacuum = (get4byte(&zDbHeader[36 + 7*4])?1:0);
1876#endif
1877 }
drhfa9601a2009-06-18 17:22:39 +00001878 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
drhc0b61812009-04-30 01:22:41 +00001879 if( rc ) goto btree_open_out;
drhe53831d2007-08-17 01:14:38 +00001880 pBt->usableSize = pBt->pageSize - nReserve;
1881 assert( (pBt->pageSize & 7)==0 ); /* 8-byte alignment of pageSize */
drhe53831d2007-08-17 01:14:38 +00001882
1883#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
1884 /* Add the new BtShared object to the linked list sharable BtShareds.
1885 */
1886 if( p->sharable ){
drh30ddce62011-10-15 00:16:30 +00001887 MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
drhe53831d2007-08-17 01:14:38 +00001888 pBt->nRef = 1;
drh30ddce62011-10-15 00:16:30 +00001889 MUTEX_LOGIC( mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);)
danielk1977075c23a2008-09-01 18:34:20 +00001890 if( SQLITE_THREADSAFE && sqlite3GlobalConfig.bCoreMutex ){
danielk197759f8c082008-06-18 17:09:10 +00001891 pBt->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_FAST);
drh3285db22007-09-03 22:00:39 +00001892 if( pBt->mutex==0 ){
1893 rc = SQLITE_NOMEM;
drhe5fe6902007-12-07 18:55:28 +00001894 db->mallocFailed = 0;
drh3285db22007-09-03 22:00:39 +00001895 goto btree_open_out;
1896 }
drhff0587c2007-08-29 17:43:19 +00001897 }
drhe53831d2007-08-17 01:14:38 +00001898 sqlite3_mutex_enter(mutexShared);
drh78f82d12008-09-02 00:52:52 +00001899 pBt->pNext = GLOBAL(BtShared*,sqlite3SharedCacheList);
1900 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt;
drhe53831d2007-08-17 01:14:38 +00001901 sqlite3_mutex_leave(mutexShared);
danielk1977951af802004-11-05 15:45:09 +00001902 }
drheee46cf2004-11-06 00:02:48 +00001903#endif
drh90f5ecb2004-07-22 01:19:35 +00001904 }
danielk1977aef0bf62005-12-30 16:28:01 +00001905
drhcfed7bc2006-03-13 14:28:05 +00001906#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00001907 /* If the new Btree uses a sharable pBtShared, then link the new
1908 ** Btree into the list of all sharable Btrees for the same connection.
drhabddb0c2007-08-20 13:14:28 +00001909 ** The list is kept in ascending order by pBt address.
danielk197754f01982006-01-18 15:25:17 +00001910 */
drhe53831d2007-08-17 01:14:38 +00001911 if( p->sharable ){
1912 int i;
1913 Btree *pSib;
drhe5fe6902007-12-07 18:55:28 +00001914 for(i=0; i<db->nDb; i++){
1915 if( (pSib = db->aDb[i].pBt)!=0 && pSib->sharable ){
drhe53831d2007-08-17 01:14:38 +00001916 while( pSib->pPrev ){ pSib = pSib->pPrev; }
1917 if( p->pBt<pSib->pBt ){
1918 p->pNext = pSib;
1919 p->pPrev = 0;
1920 pSib->pPrev = p;
1921 }else{
drhabddb0c2007-08-20 13:14:28 +00001922 while( pSib->pNext && pSib->pNext->pBt<p->pBt ){
drhe53831d2007-08-17 01:14:38 +00001923 pSib = pSib->pNext;
1924 }
1925 p->pNext = pSib->pNext;
1926 p->pPrev = pSib;
1927 if( p->pNext ){
1928 p->pNext->pPrev = p;
1929 }
1930 pSib->pNext = p;
1931 }
1932 break;
1933 }
1934 }
danielk1977aef0bf62005-12-30 16:28:01 +00001935 }
danielk1977aef0bf62005-12-30 16:28:01 +00001936#endif
1937 *ppBtree = p;
danielk1977dddbcdc2007-04-26 14:42:34 +00001938
1939btree_open_out:
1940 if( rc!=SQLITE_OK ){
1941 if( pBt && pBt->pPager ){
1942 sqlite3PagerClose(pBt->pPager);
1943 }
drh17435752007-08-16 04:30:38 +00001944 sqlite3_free(pBt);
1945 sqlite3_free(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00001946 *ppBtree = 0;
drh75c014c2010-08-30 15:02:28 +00001947 }else{
1948 /* If the B-Tree was successfully opened, set the pager-cache size to the
1949 ** default value. Except, when opening on an existing shared pager-cache,
1950 ** do not change the pager-cache size.
1951 */
1952 if( sqlite3BtreeSchema(p, 0, 0)==0 ){
1953 sqlite3PagerSetCachesize(p->pBt->pPager, SQLITE_DEFAULT_CACHE_SIZE);
1954 }
danielk1977dddbcdc2007-04-26 14:42:34 +00001955 }
drh7555d8e2009-03-20 13:15:30 +00001956 if( mutexOpen ){
1957 assert( sqlite3_mutex_held(mutexOpen) );
1958 sqlite3_mutex_leave(mutexOpen);
1959 }
danielk1977dddbcdc2007-04-26 14:42:34 +00001960 return rc;
drha059ad02001-04-17 20:09:11 +00001961}
1962
1963/*
drhe53831d2007-08-17 01:14:38 +00001964** Decrement the BtShared.nRef counter. When it reaches zero,
1965** remove the BtShared structure from the sharing list. Return
1966** true if the BtShared.nRef counter reaches zero and return
1967** false if it is still positive.
1968*/
1969static int removeFromSharingList(BtShared *pBt){
1970#ifndef SQLITE_OMIT_SHARED_CACHE
drh30ddce62011-10-15 00:16:30 +00001971 MUTEX_LOGIC( sqlite3_mutex *pMaster; )
drhe53831d2007-08-17 01:14:38 +00001972 BtShared *pList;
1973 int removed = 0;
1974
drhd677b3d2007-08-20 22:48:41 +00001975 assert( sqlite3_mutex_notheld(pBt->mutex) );
drh30ddce62011-10-15 00:16:30 +00001976 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drhe53831d2007-08-17 01:14:38 +00001977 sqlite3_mutex_enter(pMaster);
1978 pBt->nRef--;
1979 if( pBt->nRef<=0 ){
drh78f82d12008-09-02 00:52:52 +00001980 if( GLOBAL(BtShared*,sqlite3SharedCacheList)==pBt ){
1981 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt->pNext;
drhe53831d2007-08-17 01:14:38 +00001982 }else{
drh78f82d12008-09-02 00:52:52 +00001983 pList = GLOBAL(BtShared*,sqlite3SharedCacheList);
drh34004ce2008-07-11 16:15:17 +00001984 while( ALWAYS(pList) && pList->pNext!=pBt ){
drhe53831d2007-08-17 01:14:38 +00001985 pList=pList->pNext;
1986 }
drh34004ce2008-07-11 16:15:17 +00001987 if( ALWAYS(pList) ){
drhe53831d2007-08-17 01:14:38 +00001988 pList->pNext = pBt->pNext;
1989 }
1990 }
drh3285db22007-09-03 22:00:39 +00001991 if( SQLITE_THREADSAFE ){
1992 sqlite3_mutex_free(pBt->mutex);
1993 }
drhe53831d2007-08-17 01:14:38 +00001994 removed = 1;
1995 }
1996 sqlite3_mutex_leave(pMaster);
1997 return removed;
1998#else
1999 return 1;
2000#endif
2001}
2002
2003/*
drhf7141992008-06-19 00:16:08 +00002004** Make sure pBt->pTmpSpace points to an allocation of
2005** MX_CELL_SIZE(pBt) bytes.
2006*/
2007static void allocateTempSpace(BtShared *pBt){
2008 if( !pBt->pTmpSpace ){
2009 pBt->pTmpSpace = sqlite3PageMalloc( pBt->pageSize );
2010 }
2011}
2012
2013/*
2014** Free the pBt->pTmpSpace allocation
2015*/
2016static void freeTempSpace(BtShared *pBt){
2017 sqlite3PageFree( pBt->pTmpSpace);
2018 pBt->pTmpSpace = 0;
2019}
2020
2021/*
drha059ad02001-04-17 20:09:11 +00002022** Close an open database and invalidate all cursors.
2023*/
danielk1977aef0bf62005-12-30 16:28:01 +00002024int sqlite3BtreeClose(Btree *p){
danielk1977aef0bf62005-12-30 16:28:01 +00002025 BtShared *pBt = p->pBt;
2026 BtCursor *pCur;
2027
danielk1977aef0bf62005-12-30 16:28:01 +00002028 /* Close all cursors opened via this handle. */
drhe5fe6902007-12-07 18:55:28 +00002029 assert( sqlite3_mutex_held(p->db->mutex) );
drhe53831d2007-08-17 01:14:38 +00002030 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002031 pCur = pBt->pCursor;
2032 while( pCur ){
2033 BtCursor *pTmp = pCur;
2034 pCur = pCur->pNext;
2035 if( pTmp->pBtree==p ){
2036 sqlite3BtreeCloseCursor(pTmp);
2037 }
drha059ad02001-04-17 20:09:11 +00002038 }
danielk1977aef0bf62005-12-30 16:28:01 +00002039
danielk19778d34dfd2006-01-24 16:37:57 +00002040 /* Rollback any active transaction and free the handle structure.
2041 ** The call to sqlite3BtreeRollback() drops any table-locks held by
2042 ** this handle.
2043 */
drh0f198a72012-02-13 16:43:16 +00002044 sqlite3BtreeRollback(p, SQLITE_OK);
drhe53831d2007-08-17 01:14:38 +00002045 sqlite3BtreeLeave(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002046
danielk1977aef0bf62005-12-30 16:28:01 +00002047 /* If there are still other outstanding references to the shared-btree
2048 ** structure, return now. The remainder of this procedure cleans
2049 ** up the shared-btree.
2050 */
drhe53831d2007-08-17 01:14:38 +00002051 assert( p->wantToLock==0 && p->locked==0 );
2052 if( !p->sharable || removeFromSharingList(pBt) ){
2053 /* The pBt is no longer on the sharing list, so we can access
2054 ** it without having to hold the mutex.
2055 **
2056 ** Clean out and delete the BtShared object.
2057 */
2058 assert( !pBt->pCursor );
drhe53831d2007-08-17 01:14:38 +00002059 sqlite3PagerClose(pBt->pPager);
2060 if( pBt->xFreeSchema && pBt->pSchema ){
2061 pBt->xFreeSchema(pBt->pSchema);
2062 }
drhb9755982010-07-24 16:34:37 +00002063 sqlite3DbFree(0, pBt->pSchema);
drhf7141992008-06-19 00:16:08 +00002064 freeTempSpace(pBt);
drh65bbf292008-06-19 01:03:17 +00002065 sqlite3_free(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00002066 }
2067
drhe53831d2007-08-17 01:14:38 +00002068#ifndef SQLITE_OMIT_SHARED_CACHE
drhcab5ed72007-08-22 11:41:18 +00002069 assert( p->wantToLock==0 );
2070 assert( p->locked==0 );
2071 if( p->pPrev ) p->pPrev->pNext = p->pNext;
2072 if( p->pNext ) p->pNext->pPrev = p->pPrev;
danielk1977aef0bf62005-12-30 16:28:01 +00002073#endif
2074
drhe53831d2007-08-17 01:14:38 +00002075 sqlite3_free(p);
drha059ad02001-04-17 20:09:11 +00002076 return SQLITE_OK;
2077}
2078
2079/*
drhda47d772002-12-02 04:25:19 +00002080** Change the limit on the number of pages allowed in the cache.
drhcd61c282002-03-06 22:01:34 +00002081**
2082** The maximum number of cache pages is set to the absolute
2083** value of mxPage. If mxPage is negative, the pager will
2084** operate asynchronously - it will not stop to do fsync()s
2085** to insure data is written to the disk surface before
2086** continuing. Transactions still work if synchronous is off,
2087** and the database cannot be corrupted if this program
2088** crashes. But if the operating system crashes or there is
2089** an abrupt power failure when synchronous is off, the database
2090** could be left in an inconsistent and unrecoverable state.
2091** Synchronous is on by default so database corruption is not
2092** normally a worry.
drhf57b14a2001-09-14 18:54:08 +00002093*/
danielk1977aef0bf62005-12-30 16:28:01 +00002094int sqlite3BtreeSetCacheSize(Btree *p, int mxPage){
2095 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00002096 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00002097 sqlite3BtreeEnter(p);
danielk19773b8a05f2007-03-19 17:44:26 +00002098 sqlite3PagerSetCachesize(pBt->pPager, mxPage);
drhd677b3d2007-08-20 22:48:41 +00002099 sqlite3BtreeLeave(p);
drhf57b14a2001-09-14 18:54:08 +00002100 return SQLITE_OK;
2101}
2102
2103/*
drh973b6e32003-02-12 14:09:42 +00002104** Change the way data is synced to disk in order to increase or decrease
2105** how well the database resists damage due to OS crashes and power
2106** failures. Level 1 is the same as asynchronous (no syncs() occur and
2107** there is a high probability of damage) Level 2 is the default. There
2108** is a very low but non-zero probability of damage. Level 3 reduces the
2109** probability of damage to near zero but with a write performance reduction.
2110*/
danielk197793758c82005-01-21 08:13:14 +00002111#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drhc97d8462010-11-19 18:23:35 +00002112int sqlite3BtreeSetSafetyLevel(
2113 Btree *p, /* The btree to set the safety level on */
2114 int level, /* PRAGMA synchronous. 1=OFF, 2=NORMAL, 3=FULL */
2115 int fullSync, /* PRAGMA fullfsync. */
2116 int ckptFullSync /* PRAGMA checkpoint_fullfync */
2117){
danielk1977aef0bf62005-12-30 16:28:01 +00002118 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00002119 assert( sqlite3_mutex_held(p->db->mutex) );
drhc97d8462010-11-19 18:23:35 +00002120 assert( level>=1 && level<=3 );
drhd677b3d2007-08-20 22:48:41 +00002121 sqlite3BtreeEnter(p);
drhc97d8462010-11-19 18:23:35 +00002122 sqlite3PagerSetSafetyLevel(pBt->pPager, level, fullSync, ckptFullSync);
drhd677b3d2007-08-20 22:48:41 +00002123 sqlite3BtreeLeave(p);
drh973b6e32003-02-12 14:09:42 +00002124 return SQLITE_OK;
2125}
danielk197793758c82005-01-21 08:13:14 +00002126#endif
drh973b6e32003-02-12 14:09:42 +00002127
drh2c8997b2005-08-27 16:36:48 +00002128/*
2129** Return TRUE if the given btree is set to safety level 1. In other
2130** words, return TRUE if no sync() occurs on the disk files.
2131*/
danielk1977aef0bf62005-12-30 16:28:01 +00002132int sqlite3BtreeSyncDisabled(Btree *p){
2133 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002134 int rc;
drhe5fe6902007-12-07 18:55:28 +00002135 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00002136 sqlite3BtreeEnter(p);
drhd0679ed2007-08-28 22:24:34 +00002137 assert( pBt && pBt->pPager );
drhd677b3d2007-08-20 22:48:41 +00002138 rc = sqlite3PagerNosync(pBt->pPager);
2139 sqlite3BtreeLeave(p);
2140 return rc;
drh2c8997b2005-08-27 16:36:48 +00002141}
2142
drh973b6e32003-02-12 14:09:42 +00002143/*
drh90f5ecb2004-07-22 01:19:35 +00002144** Change the default pages size and the number of reserved bytes per page.
drhce4869f2009-04-02 20:16:58 +00002145** Or, if the page size has already been fixed, return SQLITE_READONLY
2146** without changing anything.
drh06f50212004-11-02 14:24:33 +00002147**
2148** The page size must be a power of 2 between 512 and 65536. If the page
2149** size supplied does not meet this constraint then the page size is not
2150** changed.
2151**
2152** Page sizes are constrained to be a power of two so that the region
2153** of the database file used for locking (beginning at PENDING_BYTE,
2154** the first byte past the 1GB boundary, 0x40000000) needs to occur
2155** at the beginning of a page.
danielk197728129562005-01-11 10:25:06 +00002156**
2157** If parameter nReserve is less than zero, then the number of reserved
2158** bytes per page is left unchanged.
drhce4869f2009-04-02 20:16:58 +00002159**
drhc9166342012-01-05 23:32:06 +00002160** If the iFix!=0 then the BTS_PAGESIZE_FIXED flag is set so that the page size
drhce4869f2009-04-02 20:16:58 +00002161** and autovacuum mode can no longer be changed.
drh90f5ecb2004-07-22 01:19:35 +00002162*/
drhce4869f2009-04-02 20:16:58 +00002163int sqlite3BtreeSetPageSize(Btree *p, int pageSize, int nReserve, int iFix){
danielk1977a1644fd2007-08-29 12:31:25 +00002164 int rc = SQLITE_OK;
danielk1977aef0bf62005-12-30 16:28:01 +00002165 BtShared *pBt = p->pBt;
drhf49661a2008-12-10 16:45:50 +00002166 assert( nReserve>=-1 && nReserve<=255 );
drhd677b3d2007-08-20 22:48:41 +00002167 sqlite3BtreeEnter(p);
drhc9166342012-01-05 23:32:06 +00002168 if( pBt->btsFlags & BTS_PAGESIZE_FIXED ){
drhd677b3d2007-08-20 22:48:41 +00002169 sqlite3BtreeLeave(p);
drh90f5ecb2004-07-22 01:19:35 +00002170 return SQLITE_READONLY;
2171 }
2172 if( nReserve<0 ){
2173 nReserve = pBt->pageSize - pBt->usableSize;
2174 }
drhf49661a2008-12-10 16:45:50 +00002175 assert( nReserve>=0 && nReserve<=255 );
drh06f50212004-11-02 14:24:33 +00002176 if( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE &&
2177 ((pageSize-1)&pageSize)==0 ){
drh07d183d2005-05-01 22:52:42 +00002178 assert( (pageSize & 7)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00002179 assert( !pBt->pPage1 && !pBt->pCursor );
drhb2eced52010-08-12 02:41:12 +00002180 pBt->pageSize = (u32)pageSize;
drhf7141992008-06-19 00:16:08 +00002181 freeTempSpace(pBt);
drh90f5ecb2004-07-22 01:19:35 +00002182 }
drhfa9601a2009-06-18 17:22:39 +00002183 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
drhf49661a2008-12-10 16:45:50 +00002184 pBt->usableSize = pBt->pageSize - (u16)nReserve;
drhc9166342012-01-05 23:32:06 +00002185 if( iFix ) pBt->btsFlags |= BTS_PAGESIZE_FIXED;
drhd677b3d2007-08-20 22:48:41 +00002186 sqlite3BtreeLeave(p);
danielk1977a1644fd2007-08-29 12:31:25 +00002187 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002188}
2189
2190/*
2191** Return the currently defined page size
2192*/
danielk1977aef0bf62005-12-30 16:28:01 +00002193int sqlite3BtreeGetPageSize(Btree *p){
2194 return p->pBt->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00002195}
drh7f751222009-03-17 22:33:00 +00002196
danbb2b4412011-04-06 17:54:31 +00002197#if !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM)
drh7f751222009-03-17 22:33:00 +00002198/*
2199** Return the number of bytes of space at the end of every page that
2200** are intentually left unused. This is the "reserved" space that is
2201** sometimes used by extensions.
2202*/
danielk1977aef0bf62005-12-30 16:28:01 +00002203int sqlite3BtreeGetReserve(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00002204 int n;
2205 sqlite3BtreeEnter(p);
2206 n = p->pBt->pageSize - p->pBt->usableSize;
2207 sqlite3BtreeLeave(p);
2208 return n;
drh2011d5f2004-07-22 02:40:37 +00002209}
drhf8e632b2007-05-08 14:51:36 +00002210
2211/*
2212** Set the maximum page count for a database if mxPage is positive.
2213** No changes are made if mxPage is 0 or negative.
2214** Regardless of the value of mxPage, return the maximum page count.
2215*/
2216int sqlite3BtreeMaxPageCount(Btree *p, int mxPage){
drhd677b3d2007-08-20 22:48:41 +00002217 int n;
2218 sqlite3BtreeEnter(p);
2219 n = sqlite3PagerMaxPageCount(p->pBt->pPager, mxPage);
2220 sqlite3BtreeLeave(p);
2221 return n;
drhf8e632b2007-05-08 14:51:36 +00002222}
drh5b47efa2010-02-12 18:18:39 +00002223
2224/*
drhc9166342012-01-05 23:32:06 +00002225** Set the BTS_SECURE_DELETE flag if newFlag is 0 or 1. If newFlag is -1,
2226** then make no changes. Always return the value of the BTS_SECURE_DELETE
drh5b47efa2010-02-12 18:18:39 +00002227** setting after the change.
2228*/
2229int sqlite3BtreeSecureDelete(Btree *p, int newFlag){
2230 int b;
drhaf034ed2010-02-12 19:46:26 +00002231 if( p==0 ) return 0;
drh5b47efa2010-02-12 18:18:39 +00002232 sqlite3BtreeEnter(p);
2233 if( newFlag>=0 ){
drhc9166342012-01-05 23:32:06 +00002234 p->pBt->btsFlags &= ~BTS_SECURE_DELETE;
2235 if( newFlag ) p->pBt->btsFlags |= BTS_SECURE_DELETE;
drh5b47efa2010-02-12 18:18:39 +00002236 }
drhc9166342012-01-05 23:32:06 +00002237 b = (p->pBt->btsFlags & BTS_SECURE_DELETE)!=0;
drh5b47efa2010-02-12 18:18:39 +00002238 sqlite3BtreeLeave(p);
2239 return b;
2240}
danielk1977576ec6b2005-01-21 11:55:25 +00002241#endif /* !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM) */
drh90f5ecb2004-07-22 01:19:35 +00002242
2243/*
danielk1977951af802004-11-05 15:45:09 +00002244** Change the 'auto-vacuum' property of the database. If the 'autoVacuum'
2245** parameter is non-zero, then auto-vacuum mode is enabled. If zero, it
2246** is disabled. The default value for the auto-vacuum property is
2247** determined by the SQLITE_DEFAULT_AUTOVACUUM macro.
2248*/
danielk1977aef0bf62005-12-30 16:28:01 +00002249int sqlite3BtreeSetAutoVacuum(Btree *p, int autoVacuum){
danielk1977951af802004-11-05 15:45:09 +00002250#ifdef SQLITE_OMIT_AUTOVACUUM
drheee46cf2004-11-06 00:02:48 +00002251 return SQLITE_READONLY;
danielk1977951af802004-11-05 15:45:09 +00002252#else
danielk1977dddbcdc2007-04-26 14:42:34 +00002253 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002254 int rc = SQLITE_OK;
drh076d4662009-02-18 20:31:18 +00002255 u8 av = (u8)autoVacuum;
drhd677b3d2007-08-20 22:48:41 +00002256
2257 sqlite3BtreeEnter(p);
drhc9166342012-01-05 23:32:06 +00002258 if( (pBt->btsFlags & BTS_PAGESIZE_FIXED)!=0 && (av ?1:0)!=pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00002259 rc = SQLITE_READONLY;
2260 }else{
drh076d4662009-02-18 20:31:18 +00002261 pBt->autoVacuum = av ?1:0;
2262 pBt->incrVacuum = av==2 ?1:0;
danielk1977951af802004-11-05 15:45:09 +00002263 }
drhd677b3d2007-08-20 22:48:41 +00002264 sqlite3BtreeLeave(p);
2265 return rc;
danielk1977951af802004-11-05 15:45:09 +00002266#endif
2267}
2268
2269/*
2270** Return the value of the 'auto-vacuum' property. If auto-vacuum is
2271** enabled 1 is returned. Otherwise 0.
2272*/
danielk1977aef0bf62005-12-30 16:28:01 +00002273int sqlite3BtreeGetAutoVacuum(Btree *p){
danielk1977951af802004-11-05 15:45:09 +00002274#ifdef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00002275 return BTREE_AUTOVACUUM_NONE;
danielk1977951af802004-11-05 15:45:09 +00002276#else
drhd677b3d2007-08-20 22:48:41 +00002277 int rc;
2278 sqlite3BtreeEnter(p);
2279 rc = (
danielk1977dddbcdc2007-04-26 14:42:34 +00002280 (!p->pBt->autoVacuum)?BTREE_AUTOVACUUM_NONE:
2281 (!p->pBt->incrVacuum)?BTREE_AUTOVACUUM_FULL:
2282 BTREE_AUTOVACUUM_INCR
2283 );
drhd677b3d2007-08-20 22:48:41 +00002284 sqlite3BtreeLeave(p);
2285 return rc;
danielk1977951af802004-11-05 15:45:09 +00002286#endif
2287}
2288
2289
2290/*
drha34b6762004-05-07 13:30:42 +00002291** Get a reference to pPage1 of the database file. This will
drh306dc212001-05-21 13:45:10 +00002292** also acquire a readlock on that file.
2293**
2294** SQLITE_OK is returned on success. If the file is not a
2295** well-formed database file, then SQLITE_CORRUPT is returned.
2296** SQLITE_BUSY is returned if the database is locked. SQLITE_NOMEM
drh4f0ee682007-03-30 20:43:40 +00002297** is returned if we run out of memory.
drh306dc212001-05-21 13:45:10 +00002298*/
danielk1977aef0bf62005-12-30 16:28:01 +00002299static int lockBtree(BtShared *pBt){
drhc2a4bab2010-04-02 12:46:45 +00002300 int rc; /* Result code from subfunctions */
2301 MemPage *pPage1; /* Page 1 of the database file */
2302 int nPage; /* Number of pages in the database */
2303 int nPageFile = 0; /* Number of pages in the database file */
2304 int nPageHeader; /* Number of pages in the database according to hdr */
drhd677b3d2007-08-20 22:48:41 +00002305
drh1fee73e2007-08-29 04:00:57 +00002306 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977295dc102009-04-01 19:07:03 +00002307 assert( pBt->pPage1==0 );
danielk197789bc4bc2009-07-21 19:25:24 +00002308 rc = sqlite3PagerSharedLock(pBt->pPager);
2309 if( rc!=SQLITE_OK ) return rc;
danielk197730548662009-07-09 05:07:37 +00002310 rc = btreeGetPage(pBt, 1, &pPage1, 0);
drh306dc212001-05-21 13:45:10 +00002311 if( rc!=SQLITE_OK ) return rc;
drh306dc212001-05-21 13:45:10 +00002312
2313 /* Do some checking to help insure the file we opened really is
2314 ** a valid database file.
2315 */
drhc2a4bab2010-04-02 12:46:45 +00002316 nPage = nPageHeader = get4byte(28+(u8*)pPage1->aData);
drh8fb8b532010-08-14 17:12:04 +00002317 sqlite3PagerPagecount(pBt->pPager, &nPageFile);
drhb28e59b2010-06-17 02:13:39 +00002318 if( nPage==0 || memcmp(24+(u8*)pPage1->aData, 92+(u8*)pPage1->aData,4)!=0 ){
drhc2a4bab2010-04-02 12:46:45 +00002319 nPage = nPageFile;
drh97b59a52010-03-31 02:31:33 +00002320 }
2321 if( nPage>0 ){
drh43b18e12010-08-17 19:40:08 +00002322 u32 pageSize;
2323 u32 usableSize;
drhb6f41482004-05-14 01:58:11 +00002324 u8 *page1 = pPage1->aData;
danielk1977ad0132d2008-06-07 08:58:22 +00002325 rc = SQLITE_NOTADB;
drhb6f41482004-05-14 01:58:11 +00002326 if( memcmp(page1, zMagicHeader, 16)!=0 ){
drh72f82862001-05-24 21:06:34 +00002327 goto page1_init_failed;
drh306dc212001-05-21 13:45:10 +00002328 }
dan5cf53532010-05-01 16:40:20 +00002329
2330#ifdef SQLITE_OMIT_WAL
2331 if( page1[18]>1 ){
drhc9166342012-01-05 23:32:06 +00002332 pBt->btsFlags |= BTS_READ_ONLY;
dan5cf53532010-05-01 16:40:20 +00002333 }
2334 if( page1[19]>1 ){
2335 goto page1_init_failed;
2336 }
2337#else
dane04dc882010-04-20 18:53:15 +00002338 if( page1[18]>2 ){
drhc9166342012-01-05 23:32:06 +00002339 pBt->btsFlags |= BTS_READ_ONLY;
drh309169a2007-04-24 17:27:51 +00002340 }
dane04dc882010-04-20 18:53:15 +00002341 if( page1[19]>2 ){
drhb6f41482004-05-14 01:58:11 +00002342 goto page1_init_failed;
2343 }
drhe5ae5732008-06-15 02:51:47 +00002344
dana470aeb2010-04-21 11:43:38 +00002345 /* If the write version is set to 2, this database should be accessed
2346 ** in WAL mode. If the log is not already open, open it now. Then
2347 ** return SQLITE_OK and return without populating BtShared.pPage1.
2348 ** The caller detects this and calls this function again. This is
2349 ** required as the version of page 1 currently in the page1 buffer
2350 ** may not be the latest version - there may be a newer one in the log
2351 ** file.
2352 */
drhc9166342012-01-05 23:32:06 +00002353 if( page1[19]==2 && (pBt->btsFlags & BTS_NO_WAL)==0 ){
dane04dc882010-04-20 18:53:15 +00002354 int isOpen = 0;
drh7ed91f22010-04-29 22:34:07 +00002355 rc = sqlite3PagerOpenWal(pBt->pPager, &isOpen);
dane04dc882010-04-20 18:53:15 +00002356 if( rc!=SQLITE_OK ){
2357 goto page1_init_failed;
2358 }else if( isOpen==0 ){
2359 releasePage(pPage1);
2360 return SQLITE_OK;
2361 }
dan8b5444b2010-04-27 14:37:47 +00002362 rc = SQLITE_NOTADB;
dane04dc882010-04-20 18:53:15 +00002363 }
dan5cf53532010-05-01 16:40:20 +00002364#endif
dane04dc882010-04-20 18:53:15 +00002365
drhe5ae5732008-06-15 02:51:47 +00002366 /* The maximum embedded fraction must be exactly 25%. And the minimum
2367 ** embedded fraction must be 12.5% for both leaf-data and non-leaf-data.
2368 ** The original design allowed these amounts to vary, but as of
2369 ** version 3.6.0, we require them to be fixed.
2370 */
2371 if( memcmp(&page1[21], "\100\040\040",3)!=0 ){
2372 goto page1_init_failed;
2373 }
drhb2eced52010-08-12 02:41:12 +00002374 pageSize = (page1[16]<<8) | (page1[17]<<16);
2375 if( ((pageSize-1)&pageSize)!=0
2376 || pageSize>SQLITE_MAX_PAGE_SIZE
2377 || pageSize<=256
drh7dc385e2007-09-06 23:39:36 +00002378 ){
drh07d183d2005-05-01 22:52:42 +00002379 goto page1_init_failed;
2380 }
2381 assert( (pageSize & 7)==0 );
danielk1977f653d782008-03-20 11:04:21 +00002382 usableSize = pageSize - page1[20];
shaneh1df2db72010-08-18 02:28:48 +00002383 if( (u32)pageSize!=pBt->pageSize ){
danielk1977f653d782008-03-20 11:04:21 +00002384 /* After reading the first page of the database assuming a page size
2385 ** of BtShared.pageSize, we have discovered that the page-size is
2386 ** actually pageSize. Unlock the database, leave pBt->pPage1 at
2387 ** zero and return SQLITE_OK. The caller will call this function
2388 ** again with the correct page-size.
2389 */
2390 releasePage(pPage1);
drh43b18e12010-08-17 19:40:08 +00002391 pBt->usableSize = usableSize;
2392 pBt->pageSize = pageSize;
drhf7141992008-06-19 00:16:08 +00002393 freeTempSpace(pBt);
drhfa9601a2009-06-18 17:22:39 +00002394 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize,
2395 pageSize-usableSize);
drh5e483932009-07-10 16:51:30 +00002396 return rc;
danielk1977f653d782008-03-20 11:04:21 +00002397 }
danecac6702011-02-09 18:19:20 +00002398 if( (pBt->db->flags & SQLITE_RecoveryMode)==0 && nPage>nPageFile ){
drhc2a4bab2010-04-02 12:46:45 +00002399 rc = SQLITE_CORRUPT_BKPT;
2400 goto page1_init_failed;
2401 }
drhb33e1b92009-06-18 11:29:20 +00002402 if( usableSize<480 ){
drhb6f41482004-05-14 01:58:11 +00002403 goto page1_init_failed;
2404 }
drh43b18e12010-08-17 19:40:08 +00002405 pBt->pageSize = pageSize;
2406 pBt->usableSize = usableSize;
drh057cd3a2005-02-15 16:23:02 +00002407#ifndef SQLITE_OMIT_AUTOVACUUM
2408 pBt->autoVacuum = (get4byte(&page1[36 + 4*4])?1:0);
danielk197727b1f952007-06-25 08:16:58 +00002409 pBt->incrVacuum = (get4byte(&page1[36 + 7*4])?1:0);
drh057cd3a2005-02-15 16:23:02 +00002410#endif
drh306dc212001-05-21 13:45:10 +00002411 }
drhb6f41482004-05-14 01:58:11 +00002412
2413 /* maxLocal is the maximum amount of payload to store locally for
2414 ** a cell. Make sure it is small enough so that at least minFanout
2415 ** cells can will fit on one page. We assume a 10-byte page header.
2416 ** Besides the payload, the cell must store:
drh43605152004-05-29 21:46:49 +00002417 ** 2-byte pointer to the cell
drhb6f41482004-05-14 01:58:11 +00002418 ** 4-byte child pointer
2419 ** 9-byte nKey value
2420 ** 4-byte nData value
2421 ** 4-byte overflow page pointer
drhe22e03e2010-08-18 21:19:03 +00002422 ** So a cell consists of a 2-byte pointer, a header which is as much as
drh43605152004-05-29 21:46:49 +00002423 ** 17 bytes long, 0 to N bytes of payload, and an optional 4 byte overflow
2424 ** page pointer.
drhb6f41482004-05-14 01:58:11 +00002425 */
shaneh1df2db72010-08-18 02:28:48 +00002426 pBt->maxLocal = (u16)((pBt->usableSize-12)*64/255 - 23);
2427 pBt->minLocal = (u16)((pBt->usableSize-12)*32/255 - 23);
2428 pBt->maxLeaf = (u16)(pBt->usableSize - 35);
2429 pBt->minLeaf = (u16)((pBt->usableSize-12)*32/255 - 23);
drhc9166342012-01-05 23:32:06 +00002430 if( pBt->maxLocal>127 ){
2431 pBt->max1bytePayload = 127;
2432 }else{
mistachkin0547e2f2012-01-08 00:54:02 +00002433 pBt->max1bytePayload = (u8)pBt->maxLocal;
drhc9166342012-01-05 23:32:06 +00002434 }
drh2e38c322004-09-03 18:38:44 +00002435 assert( pBt->maxLeaf + 23 <= MX_CELL_SIZE(pBt) );
drh3aac2dd2004-04-26 14:10:20 +00002436 pBt->pPage1 = pPage1;
drhdd3cd972010-03-27 17:12:36 +00002437 pBt->nPage = nPage;
drhb6f41482004-05-14 01:58:11 +00002438 return SQLITE_OK;
drh306dc212001-05-21 13:45:10 +00002439
drh72f82862001-05-24 21:06:34 +00002440page1_init_failed:
drh3aac2dd2004-04-26 14:10:20 +00002441 releasePage(pPage1);
2442 pBt->pPage1 = 0;
drh72f82862001-05-24 21:06:34 +00002443 return rc;
drh306dc212001-05-21 13:45:10 +00002444}
2445
2446/*
drhb8ca3072001-12-05 00:21:20 +00002447** If there are no outstanding cursors and we are not in the middle
2448** of a transaction but there is a read lock on the database, then
2449** this routine unrefs the first page of the database file which
2450** has the effect of releasing the read lock.
2451**
drhb8ca3072001-12-05 00:21:20 +00002452** If there is a transaction in progress, this routine is a no-op.
2453*/
danielk1977aef0bf62005-12-30 16:28:01 +00002454static void unlockBtreeIfUnused(BtShared *pBt){
drh1fee73e2007-08-29 04:00:57 +00002455 assert( sqlite3_mutex_held(pBt->mutex) );
danielk19771bc9ee92009-07-04 15:41:02 +00002456 assert( pBt->pCursor==0 || pBt->inTransaction>TRANS_NONE );
2457 if( pBt->inTransaction==TRANS_NONE && pBt->pPage1!=0 ){
danielk1977c1761e82009-06-25 09:40:03 +00002458 assert( pBt->pPage1->aData );
2459 assert( sqlite3PagerRefcount(pBt->pPager)==1 );
2460 assert( pBt->pPage1->aData );
2461 releasePage(pBt->pPage1);
drh3aac2dd2004-04-26 14:10:20 +00002462 pBt->pPage1 = 0;
drhb8ca3072001-12-05 00:21:20 +00002463 }
2464}
2465
2466/*
drhe39f2f92009-07-23 01:43:59 +00002467** If pBt points to an empty file then convert that empty file
2468** into a new empty database by initializing the first page of
2469** the database.
drh8b2f49b2001-06-08 00:21:52 +00002470*/
danielk1977aef0bf62005-12-30 16:28:01 +00002471static int newDatabase(BtShared *pBt){
drh9e572e62004-04-23 23:43:10 +00002472 MemPage *pP1;
2473 unsigned char *data;
drh8c42ca92001-06-22 19:15:00 +00002474 int rc;
drhd677b3d2007-08-20 22:48:41 +00002475
drh1fee73e2007-08-29 04:00:57 +00002476 assert( sqlite3_mutex_held(pBt->mutex) );
drhdd3cd972010-03-27 17:12:36 +00002477 if( pBt->nPage>0 ){
2478 return SQLITE_OK;
danielk1977ad0132d2008-06-07 08:58:22 +00002479 }
drh3aac2dd2004-04-26 14:10:20 +00002480 pP1 = pBt->pPage1;
drh9e572e62004-04-23 23:43:10 +00002481 assert( pP1!=0 );
2482 data = pP1->aData;
danielk19773b8a05f2007-03-19 17:44:26 +00002483 rc = sqlite3PagerWrite(pP1->pDbPage);
drh8b2f49b2001-06-08 00:21:52 +00002484 if( rc ) return rc;
drh9e572e62004-04-23 23:43:10 +00002485 memcpy(data, zMagicHeader, sizeof(zMagicHeader));
2486 assert( sizeof(zMagicHeader)==16 );
shaneh1df2db72010-08-18 02:28:48 +00002487 data[16] = (u8)((pBt->pageSize>>8)&0xff);
2488 data[17] = (u8)((pBt->pageSize>>16)&0xff);
drh9e572e62004-04-23 23:43:10 +00002489 data[18] = 1;
2490 data[19] = 1;
drhf49661a2008-12-10 16:45:50 +00002491 assert( pBt->usableSize<=pBt->pageSize && pBt->usableSize+255>=pBt->pageSize);
2492 data[20] = (u8)(pBt->pageSize - pBt->usableSize);
drhe5ae5732008-06-15 02:51:47 +00002493 data[21] = 64;
2494 data[22] = 32;
2495 data[23] = 32;
drhb6f41482004-05-14 01:58:11 +00002496 memset(&data[24], 0, 100-24);
drhe6c43812004-05-14 12:17:46 +00002497 zeroPage(pP1, PTF_INTKEY|PTF_LEAF|PTF_LEAFDATA );
drhc9166342012-01-05 23:32:06 +00002498 pBt->btsFlags |= BTS_PAGESIZE_FIXED;
danielk1977003ba062004-11-04 02:57:33 +00002499#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00002500 assert( pBt->autoVacuum==1 || pBt->autoVacuum==0 );
danielk1977418899a2007-06-24 10:14:00 +00002501 assert( pBt->incrVacuum==1 || pBt->incrVacuum==0 );
danielk1977dddbcdc2007-04-26 14:42:34 +00002502 put4byte(&data[36 + 4*4], pBt->autoVacuum);
danielk1977418899a2007-06-24 10:14:00 +00002503 put4byte(&data[36 + 7*4], pBt->incrVacuum);
danielk1977003ba062004-11-04 02:57:33 +00002504#endif
drhdd3cd972010-03-27 17:12:36 +00002505 pBt->nPage = 1;
2506 data[31] = 1;
drh8b2f49b2001-06-08 00:21:52 +00002507 return SQLITE_OK;
2508}
2509
2510/*
danielk1977ee5741e2004-05-31 10:01:34 +00002511** Attempt to start a new transaction. A write-transaction
drh684917c2004-10-05 02:41:42 +00002512** is started if the second argument is nonzero, otherwise a read-
2513** transaction. If the second argument is 2 or more and exclusive
2514** transaction is started, meaning that no other process is allowed
2515** to access the database. A preexisting transaction may not be
drhb8ef32c2005-03-14 02:01:49 +00002516** upgraded to exclusive by calling this routine a second time - the
drh684917c2004-10-05 02:41:42 +00002517** exclusivity flag only works for a new transaction.
drh8b2f49b2001-06-08 00:21:52 +00002518**
danielk1977ee5741e2004-05-31 10:01:34 +00002519** A write-transaction must be started before attempting any
2520** changes to the database. None of the following routines
2521** will work unless a transaction is started first:
drh8b2f49b2001-06-08 00:21:52 +00002522**
drh23e11ca2004-05-04 17:27:28 +00002523** sqlite3BtreeCreateTable()
2524** sqlite3BtreeCreateIndex()
2525** sqlite3BtreeClearTable()
2526** sqlite3BtreeDropTable()
2527** sqlite3BtreeInsert()
2528** sqlite3BtreeDelete()
2529** sqlite3BtreeUpdateMeta()
danielk197713adf8a2004-06-03 16:08:41 +00002530**
drhb8ef32c2005-03-14 02:01:49 +00002531** If an initial attempt to acquire the lock fails because of lock contention
2532** and the database was previously unlocked, then invoke the busy handler
2533** if there is one. But if there was previously a read-lock, do not
2534** invoke the busy handler - just return SQLITE_BUSY. SQLITE_BUSY is
2535** returned when there is already a read-lock in order to avoid a deadlock.
2536**
2537** Suppose there are two processes A and B. A has a read lock and B has
2538** a reserved lock. B tries to promote to exclusive but is blocked because
2539** of A's read lock. A tries to promote to reserved but is blocked by B.
2540** One or the other of the two processes must give way or there can be
2541** no progress. By returning SQLITE_BUSY and not invoking the busy callback
2542** when A already has a read lock, we encourage A to give up and let B
2543** proceed.
drha059ad02001-04-17 20:09:11 +00002544*/
danielk1977aef0bf62005-12-30 16:28:01 +00002545int sqlite3BtreeBeginTrans(Btree *p, int wrflag){
danielk1977404ca072009-03-16 13:19:36 +00002546 sqlite3 *pBlock = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002547 BtShared *pBt = p->pBt;
danielk1977ee5741e2004-05-31 10:01:34 +00002548 int rc = SQLITE_OK;
2549
drhd677b3d2007-08-20 22:48:41 +00002550 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002551 btreeIntegrity(p);
2552
danielk1977ee5741e2004-05-31 10:01:34 +00002553 /* If the btree is already in a write-transaction, or it
2554 ** is already in a read-transaction and a read-transaction
2555 ** is requested, this is a no-op.
2556 */
danielk1977aef0bf62005-12-30 16:28:01 +00002557 if( p->inTrans==TRANS_WRITE || (p->inTrans==TRANS_READ && !wrflag) ){
drhd677b3d2007-08-20 22:48:41 +00002558 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00002559 }
drhb8ef32c2005-03-14 02:01:49 +00002560
2561 /* Write transactions are not possible on a read-only database */
drhc9166342012-01-05 23:32:06 +00002562 if( (pBt->btsFlags & BTS_READ_ONLY)!=0 && wrflag ){
drhd677b3d2007-08-20 22:48:41 +00002563 rc = SQLITE_READONLY;
2564 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00002565 }
2566
danielk1977404ca072009-03-16 13:19:36 +00002567#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +00002568 /* If another database handle has already opened a write transaction
2569 ** on this shared-btree structure and a second write transaction is
danielk1977404ca072009-03-16 13:19:36 +00002570 ** requested, return SQLITE_LOCKED.
danielk1977aef0bf62005-12-30 16:28:01 +00002571 */
drhc9166342012-01-05 23:32:06 +00002572 if( (wrflag && pBt->inTransaction==TRANS_WRITE)
2573 || (pBt->btsFlags & BTS_PENDING)!=0
2574 ){
danielk1977404ca072009-03-16 13:19:36 +00002575 pBlock = pBt->pWriter->db;
2576 }else if( wrflag>1 ){
danielk1977641b0f42007-12-21 04:47:25 +00002577 BtLock *pIter;
2578 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
2579 if( pIter->pBtree!=p ){
danielk1977404ca072009-03-16 13:19:36 +00002580 pBlock = pIter->pBtree->db;
2581 break;
danielk1977641b0f42007-12-21 04:47:25 +00002582 }
2583 }
2584 }
danielk1977404ca072009-03-16 13:19:36 +00002585 if( pBlock ){
2586 sqlite3ConnectionBlocked(p->db, pBlock);
2587 rc = SQLITE_LOCKED_SHAREDCACHE;
2588 goto trans_begun;
2589 }
danielk1977641b0f42007-12-21 04:47:25 +00002590#endif
2591
danielk1977602b4662009-07-02 07:47:33 +00002592 /* Any read-only or read-write transaction implies a read-lock on
2593 ** page 1. So if some other shared-cache client already has a write-lock
2594 ** on page 1, the transaction cannot be opened. */
drh4c301aa2009-07-15 17:25:45 +00002595 rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK);
2596 if( SQLITE_OK!=rc ) goto trans_begun;
danielk1977602b4662009-07-02 07:47:33 +00002597
drhc9166342012-01-05 23:32:06 +00002598 pBt->btsFlags &= ~BTS_INITIALLY_EMPTY;
2599 if( pBt->nPage==0 ) pBt->btsFlags |= BTS_INITIALLY_EMPTY;
drhb8ef32c2005-03-14 02:01:49 +00002600 do {
danielk1977295dc102009-04-01 19:07:03 +00002601 /* Call lockBtree() until either pBt->pPage1 is populated or
2602 ** lockBtree() returns something other than SQLITE_OK. lockBtree()
2603 ** may return SQLITE_OK but leave pBt->pPage1 set to 0 if after
2604 ** reading page 1 it discovers that the page-size of the database
2605 ** file is not pBt->pageSize. In this case lockBtree() will update
2606 ** pBt->pageSize to the page-size of the file on disk.
2607 */
2608 while( pBt->pPage1==0 && SQLITE_OK==(rc = lockBtree(pBt)) );
drh309169a2007-04-24 17:27:51 +00002609
drhb8ef32c2005-03-14 02:01:49 +00002610 if( rc==SQLITE_OK && wrflag ){
drhc9166342012-01-05 23:32:06 +00002611 if( (pBt->btsFlags & BTS_READ_ONLY)!=0 ){
drh309169a2007-04-24 17:27:51 +00002612 rc = SQLITE_READONLY;
2613 }else{
danielk1977d8293352009-04-30 09:10:37 +00002614 rc = sqlite3PagerBegin(pBt->pPager,wrflag>1,sqlite3TempInMemory(p->db));
drh309169a2007-04-24 17:27:51 +00002615 if( rc==SQLITE_OK ){
2616 rc = newDatabase(pBt);
2617 }
drhb8ef32c2005-03-14 02:01:49 +00002618 }
2619 }
2620
danielk1977bd434552009-03-18 10:33:00 +00002621 if( rc!=SQLITE_OK ){
drhb8ef32c2005-03-14 02:01:49 +00002622 unlockBtreeIfUnused(pBt);
2623 }
danf9b76712010-06-01 14:12:45 +00002624 }while( (rc&0xFF)==SQLITE_BUSY && pBt->inTransaction==TRANS_NONE &&
danielk19771ceedd32008-11-19 10:22:33 +00002625 btreeInvokeBusyHandler(pBt) );
danielk1977aef0bf62005-12-30 16:28:01 +00002626
2627 if( rc==SQLITE_OK ){
2628 if( p->inTrans==TRANS_NONE ){
2629 pBt->nTransaction++;
danielk1977602b4662009-07-02 07:47:33 +00002630#ifndef SQLITE_OMIT_SHARED_CACHE
2631 if( p->sharable ){
2632 assert( p->lock.pBtree==p && p->lock.iTable==1 );
2633 p->lock.eLock = READ_LOCK;
2634 p->lock.pNext = pBt->pLock;
2635 pBt->pLock = &p->lock;
2636 }
2637#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002638 }
2639 p->inTrans = (wrflag?TRANS_WRITE:TRANS_READ);
2640 if( p->inTrans>pBt->inTransaction ){
2641 pBt->inTransaction = p->inTrans;
2642 }
danielk1977404ca072009-03-16 13:19:36 +00002643 if( wrflag ){
dan59257dc2010-08-04 11:34:31 +00002644 MemPage *pPage1 = pBt->pPage1;
2645#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977404ca072009-03-16 13:19:36 +00002646 assert( !pBt->pWriter );
2647 pBt->pWriter = p;
drhc9166342012-01-05 23:32:06 +00002648 pBt->btsFlags &= ~BTS_EXCLUSIVE;
2649 if( wrflag>1 ) pBt->btsFlags |= BTS_EXCLUSIVE;
danielk1977641b0f42007-12-21 04:47:25 +00002650#endif
dan59257dc2010-08-04 11:34:31 +00002651
2652 /* If the db-size header field is incorrect (as it may be if an old
2653 ** client has been writing the database file), update it now. Doing
2654 ** this sooner rather than later means the database size can safely
2655 ** re-read the database size from page 1 if a savepoint or transaction
2656 ** rollback occurs within the transaction.
2657 */
2658 if( pBt->nPage!=get4byte(&pPage1->aData[28]) ){
2659 rc = sqlite3PagerWrite(pPage1->pDbPage);
2660 if( rc==SQLITE_OK ){
2661 put4byte(&pPage1->aData[28], pBt->nPage);
2662 }
2663 }
2664 }
danielk1977aef0bf62005-12-30 16:28:01 +00002665 }
2666
drhd677b3d2007-08-20 22:48:41 +00002667
2668trans_begun:
danielk1977fd7f0452008-12-17 17:30:26 +00002669 if( rc==SQLITE_OK && wrflag ){
danielk197712dd5492008-12-18 15:45:07 +00002670 /* This call makes sure that the pager has the correct number of
2671 ** open savepoints. If the second parameter is greater than 0 and
2672 ** the sub-journal is not already open, then it will be opened here.
2673 */
danielk1977fd7f0452008-12-17 17:30:26 +00002674 rc = sqlite3PagerOpenSavepoint(pBt->pPager, p->db->nSavepoint);
2675 }
danielk197712dd5492008-12-18 15:45:07 +00002676
danielk1977aef0bf62005-12-30 16:28:01 +00002677 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00002678 sqlite3BtreeLeave(p);
drhb8ca3072001-12-05 00:21:20 +00002679 return rc;
drha059ad02001-04-17 20:09:11 +00002680}
2681
danielk1977687566d2004-11-02 12:56:41 +00002682#ifndef SQLITE_OMIT_AUTOVACUUM
2683
2684/*
2685** Set the pointer-map entries for all children of page pPage. Also, if
2686** pPage contains cells that point to overflow pages, set the pointer
2687** map entries for the overflow pages as well.
2688*/
2689static int setChildPtrmaps(MemPage *pPage){
2690 int i; /* Counter variable */
2691 int nCell; /* Number of cells in page pPage */
danielk19772df71c72007-05-24 07:22:42 +00002692 int rc; /* Return code */
danielk1977aef0bf62005-12-30 16:28:01 +00002693 BtShared *pBt = pPage->pBt;
drhf49661a2008-12-10 16:45:50 +00002694 u8 isInitOrig = pPage->isInit;
danielk1977687566d2004-11-02 12:56:41 +00002695 Pgno pgno = pPage->pgno;
2696
drh1fee73e2007-08-29 04:00:57 +00002697 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk197730548662009-07-09 05:07:37 +00002698 rc = btreeInitPage(pPage);
danielk19772df71c72007-05-24 07:22:42 +00002699 if( rc!=SQLITE_OK ){
2700 goto set_child_ptrmaps_out;
2701 }
danielk1977687566d2004-11-02 12:56:41 +00002702 nCell = pPage->nCell;
2703
2704 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00002705 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00002706
drh98add2e2009-07-20 17:11:49 +00002707 ptrmapPutOvflPtr(pPage, pCell, &rc);
danielk197726836652005-01-17 01:33:13 +00002708
danielk1977687566d2004-11-02 12:56:41 +00002709 if( !pPage->leaf ){
2710 Pgno childPgno = get4byte(pCell);
drh98add2e2009-07-20 17:11:49 +00002711 ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
danielk1977687566d2004-11-02 12:56:41 +00002712 }
2713 }
2714
2715 if( !pPage->leaf ){
2716 Pgno childPgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh98add2e2009-07-20 17:11:49 +00002717 ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
danielk1977687566d2004-11-02 12:56:41 +00002718 }
2719
2720set_child_ptrmaps_out:
2721 pPage->isInit = isInitOrig;
2722 return rc;
2723}
2724
2725/*
drhf3aed592009-07-08 18:12:49 +00002726** Somewhere on pPage is a pointer to page iFrom. Modify this pointer so
2727** that it points to iTo. Parameter eType describes the type of pointer to
2728** be modified, as follows:
danielk1977687566d2004-11-02 12:56:41 +00002729**
2730** PTRMAP_BTREE: pPage is a btree-page. The pointer points at a child
2731** page of pPage.
2732**
2733** PTRMAP_OVERFLOW1: pPage is a btree-page. The pointer points at an overflow
2734** page pointed to by one of the cells on pPage.
2735**
2736** PTRMAP_OVERFLOW2: pPage is an overflow-page. The pointer points at the next
2737** overflow page in the list.
2738*/
danielk1977fdb7cdb2005-01-17 02:12:18 +00002739static int modifyPagePointer(MemPage *pPage, Pgno iFrom, Pgno iTo, u8 eType){
drh1fee73e2007-08-29 04:00:57 +00002740 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhc5053fb2008-11-27 02:22:10 +00002741 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
danielk1977687566d2004-11-02 12:56:41 +00002742 if( eType==PTRMAP_OVERFLOW2 ){
danielk1977f78fc082004-11-02 14:40:32 +00002743 /* The pointer is always the first 4 bytes of the page in this case. */
danielk1977fdb7cdb2005-01-17 02:12:18 +00002744 if( get4byte(pPage->aData)!=iFrom ){
drh49285702005-09-17 15:20:26 +00002745 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +00002746 }
danielk1977f78fc082004-11-02 14:40:32 +00002747 put4byte(pPage->aData, iTo);
danielk1977687566d2004-11-02 12:56:41 +00002748 }else{
drhf49661a2008-12-10 16:45:50 +00002749 u8 isInitOrig = pPage->isInit;
danielk1977687566d2004-11-02 12:56:41 +00002750 int i;
2751 int nCell;
2752
danielk197730548662009-07-09 05:07:37 +00002753 btreeInitPage(pPage);
danielk1977687566d2004-11-02 12:56:41 +00002754 nCell = pPage->nCell;
2755
danielk1977687566d2004-11-02 12:56:41 +00002756 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00002757 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00002758 if( eType==PTRMAP_OVERFLOW1 ){
2759 CellInfo info;
danielk197730548662009-07-09 05:07:37 +00002760 btreeParseCellPtr(pPage, pCell, &info);
drhe42a9b42011-08-31 13:27:19 +00002761 if( info.iOverflow
2762 && pCell+info.iOverflow+3<=pPage->aData+pPage->maskPage
2763 && iFrom==get4byte(&pCell[info.iOverflow])
2764 ){
2765 put4byte(&pCell[info.iOverflow], iTo);
2766 break;
danielk1977687566d2004-11-02 12:56:41 +00002767 }
2768 }else{
2769 if( get4byte(pCell)==iFrom ){
2770 put4byte(pCell, iTo);
2771 break;
2772 }
2773 }
2774 }
2775
2776 if( i==nCell ){
danielk1977fdb7cdb2005-01-17 02:12:18 +00002777 if( eType!=PTRMAP_BTREE ||
2778 get4byte(&pPage->aData[pPage->hdrOffset+8])!=iFrom ){
drh49285702005-09-17 15:20:26 +00002779 return SQLITE_CORRUPT_BKPT;
danielk1977fdb7cdb2005-01-17 02:12:18 +00002780 }
danielk1977687566d2004-11-02 12:56:41 +00002781 put4byte(&pPage->aData[pPage->hdrOffset+8], iTo);
2782 }
2783
2784 pPage->isInit = isInitOrig;
2785 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00002786 return SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00002787}
2788
danielk1977003ba062004-11-04 02:57:33 +00002789
danielk19777701e812005-01-10 12:59:51 +00002790/*
2791** Move the open database page pDbPage to location iFreePage in the
2792** database. The pDbPage reference remains valid.
drhe64ca7b2009-07-16 18:21:17 +00002793**
2794** The isCommit flag indicates that there is no need to remember that
2795** the journal needs to be sync()ed before database page pDbPage->pgno
2796** can be written to. The caller has already promised not to write to that
2797** page.
danielk19777701e812005-01-10 12:59:51 +00002798*/
danielk1977003ba062004-11-04 02:57:33 +00002799static int relocatePage(
danielk1977aef0bf62005-12-30 16:28:01 +00002800 BtShared *pBt, /* Btree */
danielk19777701e812005-01-10 12:59:51 +00002801 MemPage *pDbPage, /* Open page to move */
2802 u8 eType, /* Pointer map 'type' entry for pDbPage */
2803 Pgno iPtrPage, /* Pointer map 'page-no' entry for pDbPage */
danielk19774c999992008-07-16 18:17:55 +00002804 Pgno iFreePage, /* The location to move pDbPage to */
drhe64ca7b2009-07-16 18:21:17 +00002805 int isCommit /* isCommit flag passed to sqlite3PagerMovepage */
danielk1977003ba062004-11-04 02:57:33 +00002806){
2807 MemPage *pPtrPage; /* The page that contains a pointer to pDbPage */
2808 Pgno iDbPage = pDbPage->pgno;
2809 Pager *pPager = pBt->pPager;
2810 int rc;
2811
danielk1977a0bf2652004-11-04 14:30:04 +00002812 assert( eType==PTRMAP_OVERFLOW2 || eType==PTRMAP_OVERFLOW1 ||
2813 eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE );
drh1fee73e2007-08-29 04:00:57 +00002814 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +00002815 assert( pDbPage->pBt==pBt );
danielk1977003ba062004-11-04 02:57:33 +00002816
drh85b623f2007-12-13 21:54:09 +00002817 /* Move page iDbPage from its current location to page number iFreePage */
danielk1977003ba062004-11-04 02:57:33 +00002818 TRACE(("AUTOVACUUM: Moving %d to free page %d (ptr page %d type %d)\n",
2819 iDbPage, iFreePage, iPtrPage, eType));
danielk19774c999992008-07-16 18:17:55 +00002820 rc = sqlite3PagerMovepage(pPager, pDbPage->pDbPage, iFreePage, isCommit);
danielk1977003ba062004-11-04 02:57:33 +00002821 if( rc!=SQLITE_OK ){
2822 return rc;
2823 }
2824 pDbPage->pgno = iFreePage;
2825
2826 /* If pDbPage was a btree-page, then it may have child pages and/or cells
2827 ** that point to overflow pages. The pointer map entries for all these
2828 ** pages need to be changed.
2829 **
2830 ** If pDbPage is an overflow page, then the first 4 bytes may store a
2831 ** pointer to a subsequent overflow page. If this is the case, then
2832 ** the pointer map needs to be updated for the subsequent overflow page.
2833 */
danielk1977a0bf2652004-11-04 14:30:04 +00002834 if( eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00002835 rc = setChildPtrmaps(pDbPage);
2836 if( rc!=SQLITE_OK ){
2837 return rc;
2838 }
2839 }else{
2840 Pgno nextOvfl = get4byte(pDbPage->aData);
2841 if( nextOvfl!=0 ){
drh98add2e2009-07-20 17:11:49 +00002842 ptrmapPut(pBt, nextOvfl, PTRMAP_OVERFLOW2, iFreePage, &rc);
danielk1977003ba062004-11-04 02:57:33 +00002843 if( rc!=SQLITE_OK ){
2844 return rc;
2845 }
2846 }
2847 }
2848
2849 /* Fix the database pointer on page iPtrPage that pointed at iDbPage so
2850 ** that it points at iFreePage. Also fix the pointer map entry for
2851 ** iPtrPage.
2852 */
danielk1977a0bf2652004-11-04 14:30:04 +00002853 if( eType!=PTRMAP_ROOTPAGE ){
danielk197730548662009-07-09 05:07:37 +00002854 rc = btreeGetPage(pBt, iPtrPage, &pPtrPage, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00002855 if( rc!=SQLITE_OK ){
2856 return rc;
2857 }
danielk19773b8a05f2007-03-19 17:44:26 +00002858 rc = sqlite3PagerWrite(pPtrPage->pDbPage);
danielk1977a0bf2652004-11-04 14:30:04 +00002859 if( rc!=SQLITE_OK ){
2860 releasePage(pPtrPage);
2861 return rc;
2862 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00002863 rc = modifyPagePointer(pPtrPage, iDbPage, iFreePage, eType);
danielk1977003ba062004-11-04 02:57:33 +00002864 releasePage(pPtrPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00002865 if( rc==SQLITE_OK ){
drh98add2e2009-07-20 17:11:49 +00002866 ptrmapPut(pBt, iFreePage, eType, iPtrPage, &rc);
danielk1977fdb7cdb2005-01-17 02:12:18 +00002867 }
danielk1977003ba062004-11-04 02:57:33 +00002868 }
danielk1977003ba062004-11-04 02:57:33 +00002869 return rc;
2870}
2871
danielk1977dddbcdc2007-04-26 14:42:34 +00002872/* Forward declaration required by incrVacuumStep(). */
drh4f0c5872007-03-26 22:05:01 +00002873static int allocateBtreePage(BtShared *, MemPage **, Pgno *, Pgno, u8);
danielk1977687566d2004-11-02 12:56:41 +00002874
2875/*
danielk1977dddbcdc2007-04-26 14:42:34 +00002876** Perform a single step of an incremental-vacuum. If successful,
2877** return SQLITE_OK. If there is no work to do (and therefore no
2878** point in calling this function again), return SQLITE_DONE.
2879**
2880** More specificly, this function attempts to re-organize the
2881** database so that the last page of the file currently in use
2882** is no longer in use.
2883**
drhea8ffdf2009-07-22 00:35:23 +00002884** If the nFin parameter is non-zero, this function assumes
danielk1977dddbcdc2007-04-26 14:42:34 +00002885** that the caller will keep calling incrVacuumStep() until
2886** it returns SQLITE_DONE or an error, and that nFin is the
2887** number of pages the database file will contain after this
drhea8ffdf2009-07-22 00:35:23 +00002888** process is complete. If nFin is zero, it is assumed that
2889** incrVacuumStep() will be called a finite amount of times
2890** which may or may not empty the freelist. A full autovacuum
2891** has nFin>0. A "PRAGMA incremental_vacuum" has nFin==0.
danielk1977dddbcdc2007-04-26 14:42:34 +00002892*/
danielk19773460d192008-12-27 15:23:13 +00002893static int incrVacuumStep(BtShared *pBt, Pgno nFin, Pgno iLastPg){
danielk1977dddbcdc2007-04-26 14:42:34 +00002894 Pgno nFreeList; /* Number of pages still on the free-list */
drhdd3cd972010-03-27 17:12:36 +00002895 int rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00002896
drh1fee73e2007-08-29 04:00:57 +00002897 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977fa542f12009-04-02 18:28:08 +00002898 assert( iLastPg>nFin );
danielk1977dddbcdc2007-04-26 14:42:34 +00002899
2900 if( !PTRMAP_ISPAGE(pBt, iLastPg) && iLastPg!=PENDING_BYTE_PAGE(pBt) ){
danielk1977dddbcdc2007-04-26 14:42:34 +00002901 u8 eType;
2902 Pgno iPtrPage;
2903
2904 nFreeList = get4byte(&pBt->pPage1->aData[36]);
danielk1977fa542f12009-04-02 18:28:08 +00002905 if( nFreeList==0 ){
danielk1977dddbcdc2007-04-26 14:42:34 +00002906 return SQLITE_DONE;
2907 }
2908
2909 rc = ptrmapGet(pBt, iLastPg, &eType, &iPtrPage);
2910 if( rc!=SQLITE_OK ){
2911 return rc;
2912 }
2913 if( eType==PTRMAP_ROOTPAGE ){
2914 return SQLITE_CORRUPT_BKPT;
2915 }
2916
2917 if( eType==PTRMAP_FREEPAGE ){
2918 if( nFin==0 ){
2919 /* Remove the page from the files free-list. This is not required
danielk19774ef24492007-05-23 09:52:41 +00002920 ** if nFin is non-zero. In that case, the free-list will be
danielk1977dddbcdc2007-04-26 14:42:34 +00002921 ** truncated to zero after this function returns, so it doesn't
2922 ** matter if it still contains some garbage entries.
2923 */
2924 Pgno iFreePg;
2925 MemPage *pFreePg;
2926 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iLastPg, 1);
2927 if( rc!=SQLITE_OK ){
2928 return rc;
2929 }
2930 assert( iFreePg==iLastPg );
2931 releasePage(pFreePg);
2932 }
2933 } else {
2934 Pgno iFreePg; /* Index of free page to move pLastPg to */
2935 MemPage *pLastPg;
2936
danielk197730548662009-07-09 05:07:37 +00002937 rc = btreeGetPage(pBt, iLastPg, &pLastPg, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00002938 if( rc!=SQLITE_OK ){
2939 return rc;
2940 }
2941
danielk1977b4626a32007-04-28 15:47:43 +00002942 /* If nFin is zero, this loop runs exactly once and page pLastPg
2943 ** is swapped with the first free page pulled off the free list.
2944 **
2945 ** On the other hand, if nFin is greater than zero, then keep
2946 ** looping until a free-page located within the first nFin pages
2947 ** of the file is found.
2948 */
danielk1977dddbcdc2007-04-26 14:42:34 +00002949 do {
2950 MemPage *pFreePg;
2951 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, 0, 0);
2952 if( rc!=SQLITE_OK ){
2953 releasePage(pLastPg);
2954 return rc;
2955 }
2956 releasePage(pFreePg);
2957 }while( nFin!=0 && iFreePg>nFin );
2958 assert( iFreePg<iLastPg );
danielk1977b4626a32007-04-28 15:47:43 +00002959
2960 rc = sqlite3PagerWrite(pLastPg->pDbPage);
danielk1977662278e2007-11-05 15:30:12 +00002961 if( rc==SQLITE_OK ){
danielk19774c999992008-07-16 18:17:55 +00002962 rc = relocatePage(pBt, pLastPg, eType, iPtrPage, iFreePg, nFin!=0);
danielk1977662278e2007-11-05 15:30:12 +00002963 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002964 releasePage(pLastPg);
2965 if( rc!=SQLITE_OK ){
2966 return rc;
danielk1977662278e2007-11-05 15:30:12 +00002967 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002968 }
2969 }
2970
danielk19773460d192008-12-27 15:23:13 +00002971 if( nFin==0 ){
2972 iLastPg--;
2973 while( iLastPg==PENDING_BYTE_PAGE(pBt)||PTRMAP_ISPAGE(pBt, iLastPg) ){
danielk1977f4027782009-03-30 18:50:04 +00002974 if( PTRMAP_ISPAGE(pBt, iLastPg) ){
2975 MemPage *pPg;
drhdd3cd972010-03-27 17:12:36 +00002976 rc = btreeGetPage(pBt, iLastPg, &pPg, 0);
danielk1977f4027782009-03-30 18:50:04 +00002977 if( rc!=SQLITE_OK ){
2978 return rc;
2979 }
2980 rc = sqlite3PagerWrite(pPg->pDbPage);
2981 releasePage(pPg);
2982 if( rc!=SQLITE_OK ){
2983 return rc;
2984 }
2985 }
danielk19773460d192008-12-27 15:23:13 +00002986 iLastPg--;
2987 }
2988 sqlite3PagerTruncateImage(pBt->pPager, iLastPg);
drhdd3cd972010-03-27 17:12:36 +00002989 pBt->nPage = iLastPg;
danielk1977dddbcdc2007-04-26 14:42:34 +00002990 }
2991 return SQLITE_OK;
2992}
2993
2994/*
2995** A write-transaction must be opened before calling this function.
2996** It performs a single unit of work towards an incremental vacuum.
2997**
2998** If the incremental vacuum is finished after this function has run,
shanebe217792009-03-05 04:20:31 +00002999** SQLITE_DONE is returned. If it is not finished, but no error occurred,
danielk1977dddbcdc2007-04-26 14:42:34 +00003000** SQLITE_OK is returned. Otherwise an SQLite error code.
3001*/
3002int sqlite3BtreeIncrVacuum(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00003003 int rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00003004 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00003005
3006 sqlite3BtreeEnter(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00003007 assert( pBt->inTransaction==TRANS_WRITE && p->inTrans==TRANS_WRITE );
3008 if( !pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00003009 rc = SQLITE_DONE;
3010 }else{
3011 invalidateAllOverflowCache(pBt);
drhb1299152010-03-30 22:58:33 +00003012 rc = incrVacuumStep(pBt, 0, btreePagecount(pBt));
drhdd3cd972010-03-27 17:12:36 +00003013 if( rc==SQLITE_OK ){
3014 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
3015 put4byte(&pBt->pPage1->aData[28], pBt->nPage);
3016 }
danielk1977dddbcdc2007-04-26 14:42:34 +00003017 }
drhd677b3d2007-08-20 22:48:41 +00003018 sqlite3BtreeLeave(p);
3019 return rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00003020}
3021
3022/*
danielk19773b8a05f2007-03-19 17:44:26 +00003023** This routine is called prior to sqlite3PagerCommit when a transaction
danielk1977687566d2004-11-02 12:56:41 +00003024** is commited for an auto-vacuum database.
danielk197724168722007-04-02 05:07:47 +00003025**
3026** If SQLITE_OK is returned, then *pnTrunc is set to the number of pages
3027** the database file should be truncated to during the commit process.
3028** i.e. the database has been reorganized so that only the first *pnTrunc
3029** pages are in use.
danielk1977687566d2004-11-02 12:56:41 +00003030*/
danielk19773460d192008-12-27 15:23:13 +00003031static int autoVacuumCommit(BtShared *pBt){
danielk1977dddbcdc2007-04-26 14:42:34 +00003032 int rc = SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00003033 Pager *pPager = pBt->pPager;
drhf94a1732008-09-30 17:18:17 +00003034 VVA_ONLY( int nRef = sqlite3PagerRefcount(pPager) );
danielk1977687566d2004-11-02 12:56:41 +00003035
drh1fee73e2007-08-29 04:00:57 +00003036 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +00003037 invalidateAllOverflowCache(pBt);
danielk1977dddbcdc2007-04-26 14:42:34 +00003038 assert(pBt->autoVacuum);
3039 if( !pBt->incrVacuum ){
drhea8ffdf2009-07-22 00:35:23 +00003040 Pgno nFin; /* Number of pages in database after autovacuuming */
3041 Pgno nFree; /* Number of pages on the freelist initially */
drh41d628c2009-07-11 17:04:08 +00003042 Pgno nPtrmap; /* Number of PtrMap pages to be freed */
3043 Pgno iFree; /* The next page to be freed */
3044 int nEntry; /* Number of entries on one ptrmap page */
3045 Pgno nOrig; /* Database size before freeing */
danielk1977687566d2004-11-02 12:56:41 +00003046
drhb1299152010-03-30 22:58:33 +00003047 nOrig = btreePagecount(pBt);
danielk1977ef165ce2009-04-06 17:50:03 +00003048 if( PTRMAP_ISPAGE(pBt, nOrig) || nOrig==PENDING_BYTE_PAGE(pBt) ){
3049 /* It is not possible to create a database for which the final page
3050 ** is either a pointer-map page or the pending-byte page. If one
3051 ** is encountered, this indicates corruption.
3052 */
danielk19773460d192008-12-27 15:23:13 +00003053 return SQLITE_CORRUPT_BKPT;
3054 }
danielk1977ef165ce2009-04-06 17:50:03 +00003055
danielk19773460d192008-12-27 15:23:13 +00003056 nFree = get4byte(&pBt->pPage1->aData[36]);
drh41d628c2009-07-11 17:04:08 +00003057 nEntry = pBt->usableSize/5;
3058 nPtrmap = (nFree-nOrig+PTRMAP_PAGENO(pBt, nOrig)+nEntry)/nEntry;
danielk19773460d192008-12-27 15:23:13 +00003059 nFin = nOrig - nFree - nPtrmap;
danielk1977ef165ce2009-04-06 17:50:03 +00003060 if( nOrig>PENDING_BYTE_PAGE(pBt) && nFin<PENDING_BYTE_PAGE(pBt) ){
danielk19773460d192008-12-27 15:23:13 +00003061 nFin--;
3062 }
3063 while( PTRMAP_ISPAGE(pBt, nFin) || nFin==PENDING_BYTE_PAGE(pBt) ){
3064 nFin--;
danielk1977dddbcdc2007-04-26 14:42:34 +00003065 }
drhc5e47ac2009-06-04 00:11:56 +00003066 if( nFin>nOrig ) return SQLITE_CORRUPT_BKPT;
danielk1977687566d2004-11-02 12:56:41 +00003067
danielk19773460d192008-12-27 15:23:13 +00003068 for(iFree=nOrig; iFree>nFin && rc==SQLITE_OK; iFree--){
3069 rc = incrVacuumStep(pBt, nFin, iFree);
danielk1977dddbcdc2007-04-26 14:42:34 +00003070 }
danielk19773460d192008-12-27 15:23:13 +00003071 if( (rc==SQLITE_DONE || rc==SQLITE_OK) && nFree>0 ){
danielk19773460d192008-12-27 15:23:13 +00003072 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
3073 put4byte(&pBt->pPage1->aData[32], 0);
3074 put4byte(&pBt->pPage1->aData[36], 0);
drhdd3cd972010-03-27 17:12:36 +00003075 put4byte(&pBt->pPage1->aData[28], nFin);
danielk19773460d192008-12-27 15:23:13 +00003076 sqlite3PagerTruncateImage(pBt->pPager, nFin);
drhdd3cd972010-03-27 17:12:36 +00003077 pBt->nPage = nFin;
danielk1977dddbcdc2007-04-26 14:42:34 +00003078 }
3079 if( rc!=SQLITE_OK ){
3080 sqlite3PagerRollback(pPager);
3081 }
danielk1977687566d2004-11-02 12:56:41 +00003082 }
3083
danielk19773b8a05f2007-03-19 17:44:26 +00003084 assert( nRef==sqlite3PagerRefcount(pPager) );
danielk1977687566d2004-11-02 12:56:41 +00003085 return rc;
3086}
danielk1977dddbcdc2007-04-26 14:42:34 +00003087
danielk1977a50d9aa2009-06-08 14:49:45 +00003088#else /* ifndef SQLITE_OMIT_AUTOVACUUM */
3089# define setChildPtrmaps(x) SQLITE_OK
3090#endif
danielk1977687566d2004-11-02 12:56:41 +00003091
3092/*
drh80e35f42007-03-30 14:06:34 +00003093** This routine does the first phase of a two-phase commit. This routine
3094** causes a rollback journal to be created (if it does not already exist)
3095** and populated with enough information so that if a power loss occurs
3096** the database can be restored to its original state by playing back
3097** the journal. Then the contents of the journal are flushed out to
3098** the disk. After the journal is safely on oxide, the changes to the
3099** database are written into the database file and flushed to oxide.
3100** At the end of this call, the rollback journal still exists on the
3101** disk and we are still holding all locks, so the transaction has not
drh51898cf2009-04-19 20:51:06 +00003102** committed. See sqlite3BtreeCommitPhaseTwo() for the second phase of the
drh80e35f42007-03-30 14:06:34 +00003103** commit process.
3104**
3105** This call is a no-op if no write-transaction is currently active on pBt.
3106**
3107** Otherwise, sync the database file for the btree pBt. zMaster points to
3108** the name of a master journal file that should be written into the
3109** individual journal file, or is NULL, indicating no master journal file
3110** (single database transaction).
3111**
3112** When this is called, the master journal should already have been
3113** created, populated with this journal pointer and synced to disk.
3114**
3115** Once this is routine has returned, the only thing required to commit
3116** the write-transaction for this database file is to delete the journal.
3117*/
3118int sqlite3BtreeCommitPhaseOne(Btree *p, const char *zMaster){
3119 int rc = SQLITE_OK;
3120 if( p->inTrans==TRANS_WRITE ){
3121 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00003122 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00003123#ifndef SQLITE_OMIT_AUTOVACUUM
3124 if( pBt->autoVacuum ){
danielk19773460d192008-12-27 15:23:13 +00003125 rc = autoVacuumCommit(pBt);
drh80e35f42007-03-30 14:06:34 +00003126 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00003127 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00003128 return rc;
3129 }
3130 }
3131#endif
drh49b9d332009-01-02 18:10:42 +00003132 rc = sqlite3PagerCommitPhaseOne(pBt->pPager, zMaster, 0);
drhd677b3d2007-08-20 22:48:41 +00003133 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00003134 }
3135 return rc;
3136}
3137
3138/*
danielk197794b30732009-07-02 17:21:57 +00003139** This function is called from both BtreeCommitPhaseTwo() and BtreeRollback()
3140** at the conclusion of a transaction.
3141*/
3142static void btreeEndTransaction(Btree *p){
3143 BtShared *pBt = p->pBt;
danielk197794b30732009-07-02 17:21:57 +00003144 assert( sqlite3BtreeHoldsMutex(p) );
3145
danielk197794b30732009-07-02 17:21:57 +00003146 btreeClearHasContent(pBt);
danfa401de2009-10-16 14:55:03 +00003147 if( p->inTrans>TRANS_NONE && p->db->activeVdbeCnt>1 ){
3148 /* If there are other active statements that belong to this database
3149 ** handle, downgrade to a read-only transaction. The other statements
3150 ** may still be reading from the database. */
danielk197794b30732009-07-02 17:21:57 +00003151 downgradeAllSharedCacheTableLocks(p);
3152 p->inTrans = TRANS_READ;
3153 }else{
3154 /* If the handle had any kind of transaction open, decrement the
3155 ** transaction count of the shared btree. If the transaction count
3156 ** reaches 0, set the shared state to TRANS_NONE. The unlockBtreeIfUnused()
3157 ** call below will unlock the pager. */
3158 if( p->inTrans!=TRANS_NONE ){
3159 clearAllSharedCacheTableLocks(p);
3160 pBt->nTransaction--;
3161 if( 0==pBt->nTransaction ){
3162 pBt->inTransaction = TRANS_NONE;
3163 }
3164 }
3165
3166 /* Set the current transaction state to TRANS_NONE and unlock the
3167 ** pager if this call closed the only read or write transaction. */
3168 p->inTrans = TRANS_NONE;
3169 unlockBtreeIfUnused(pBt);
3170 }
3171
3172 btreeIntegrity(p);
3173}
3174
3175/*
drh2aa679f2001-06-25 02:11:07 +00003176** Commit the transaction currently in progress.
drh5e00f6c2001-09-13 13:46:56 +00003177**
drh6e345992007-03-30 11:12:08 +00003178** This routine implements the second phase of a 2-phase commit. The
drh51898cf2009-04-19 20:51:06 +00003179** sqlite3BtreeCommitPhaseOne() routine does the first phase and should
3180** be invoked prior to calling this routine. The sqlite3BtreeCommitPhaseOne()
3181** routine did all the work of writing information out to disk and flushing the
drh6e345992007-03-30 11:12:08 +00003182** contents so that they are written onto the disk platter. All this
drh51898cf2009-04-19 20:51:06 +00003183** routine has to do is delete or truncate or zero the header in the
3184** the rollback journal (which causes the transaction to commit) and
3185** drop locks.
drh6e345992007-03-30 11:12:08 +00003186**
dan60939d02011-03-29 15:40:55 +00003187** Normally, if an error occurs while the pager layer is attempting to
3188** finalize the underlying journal file, this function returns an error and
3189** the upper layer will attempt a rollback. However, if the second argument
3190** is non-zero then this b-tree transaction is part of a multi-file
3191** transaction. In this case, the transaction has already been committed
3192** (by deleting a master journal file) and the caller will ignore this
3193** functions return code. So, even if an error occurs in the pager layer,
3194** reset the b-tree objects internal state to indicate that the write
3195** transaction has been closed. This is quite safe, as the pager will have
3196** transitioned to the error state.
3197**
drh5e00f6c2001-09-13 13:46:56 +00003198** This will release the write lock on the database file. If there
3199** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00003200*/
dan60939d02011-03-29 15:40:55 +00003201int sqlite3BtreeCommitPhaseTwo(Btree *p, int bCleanup){
danielk1977aef0bf62005-12-30 16:28:01 +00003202
drh075ed302010-10-14 01:17:30 +00003203 if( p->inTrans==TRANS_NONE ) return SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00003204 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00003205 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00003206
3207 /* If the handle has a write-transaction open, commit the shared-btrees
3208 ** transaction and set the shared state to TRANS_READ.
3209 */
3210 if( p->inTrans==TRANS_WRITE ){
danielk19777f7bc662006-01-23 13:47:47 +00003211 int rc;
drh075ed302010-10-14 01:17:30 +00003212 BtShared *pBt = p->pBt;
danielk1977aef0bf62005-12-30 16:28:01 +00003213 assert( pBt->inTransaction==TRANS_WRITE );
3214 assert( pBt->nTransaction>0 );
drh80e35f42007-03-30 14:06:34 +00003215 rc = sqlite3PagerCommitPhaseTwo(pBt->pPager);
dan60939d02011-03-29 15:40:55 +00003216 if( rc!=SQLITE_OK && bCleanup==0 ){
drhd677b3d2007-08-20 22:48:41 +00003217 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00003218 return rc;
3219 }
danielk1977aef0bf62005-12-30 16:28:01 +00003220 pBt->inTransaction = TRANS_READ;
danielk1977ee5741e2004-05-31 10:01:34 +00003221 }
danielk1977aef0bf62005-12-30 16:28:01 +00003222
danielk197794b30732009-07-02 17:21:57 +00003223 btreeEndTransaction(p);
drhd677b3d2007-08-20 22:48:41 +00003224 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00003225 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00003226}
3227
drh80e35f42007-03-30 14:06:34 +00003228/*
3229** Do both phases of a commit.
3230*/
3231int sqlite3BtreeCommit(Btree *p){
3232 int rc;
drhd677b3d2007-08-20 22:48:41 +00003233 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00003234 rc = sqlite3BtreeCommitPhaseOne(p, 0);
3235 if( rc==SQLITE_OK ){
dan60939d02011-03-29 15:40:55 +00003236 rc = sqlite3BtreeCommitPhaseTwo(p, 0);
drh80e35f42007-03-30 14:06:34 +00003237 }
drhd677b3d2007-08-20 22:48:41 +00003238 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00003239 return rc;
3240}
3241
danielk1977fbcd5852004-06-15 02:44:18 +00003242#ifndef NDEBUG
3243/*
3244** Return the number of write-cursors open on this handle. This is for use
3245** in assert() expressions, so it is only compiled if NDEBUG is not
3246** defined.
drhfb982642007-08-30 01:19:59 +00003247**
3248** For the purposes of this routine, a write-cursor is any cursor that
3249** is capable of writing to the databse. That means the cursor was
3250** originally opened for writing and the cursor has not be disabled
3251** by having its state changed to CURSOR_FAULT.
danielk1977fbcd5852004-06-15 02:44:18 +00003252*/
danielk1977aef0bf62005-12-30 16:28:01 +00003253static int countWriteCursors(BtShared *pBt){
danielk1977fbcd5852004-06-15 02:44:18 +00003254 BtCursor *pCur;
3255 int r = 0;
3256 for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
drhfb982642007-08-30 01:19:59 +00003257 if( pCur->wrFlag && pCur->eState!=CURSOR_FAULT ) r++;
danielk1977fbcd5852004-06-15 02:44:18 +00003258 }
3259 return r;
3260}
3261#endif
3262
drhc39e0002004-05-07 23:50:57 +00003263/*
drhfb982642007-08-30 01:19:59 +00003264** This routine sets the state to CURSOR_FAULT and the error
3265** code to errCode for every cursor on BtShared that pBtree
3266** references.
3267**
3268** Every cursor is tripped, including cursors that belong
3269** to other database connections that happen to be sharing
3270** the cache with pBtree.
3271**
3272** This routine gets called when a rollback occurs.
3273** All cursors using the same cache must be tripped
3274** to prevent them from trying to use the btree after
3275** the rollback. The rollback may have deleted tables
3276** or moved root pages, so it is not sufficient to
3277** save the state of the cursor. The cursor must be
3278** invalidated.
3279*/
3280void sqlite3BtreeTripAllCursors(Btree *pBtree, int errCode){
3281 BtCursor *p;
drh0f198a72012-02-13 16:43:16 +00003282 if( pBtree==0 ) return;
drhfb982642007-08-30 01:19:59 +00003283 sqlite3BtreeEnter(pBtree);
3284 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
danielk1977bc2ca9e2008-11-13 14:28:28 +00003285 int i;
danielk1977be51a652008-10-08 17:58:48 +00003286 sqlite3BtreeClearCursor(p);
drhfb982642007-08-30 01:19:59 +00003287 p->eState = CURSOR_FAULT;
drh4c301aa2009-07-15 17:25:45 +00003288 p->skipNext = errCode;
danielk1977bc2ca9e2008-11-13 14:28:28 +00003289 for(i=0; i<=p->iPage; i++){
3290 releasePage(p->apPage[i]);
3291 p->apPage[i] = 0;
3292 }
drhfb982642007-08-30 01:19:59 +00003293 }
3294 sqlite3BtreeLeave(pBtree);
3295}
3296
3297/*
drhecdc7532001-09-23 02:35:53 +00003298** Rollback the transaction in progress. All cursors will be
3299** invalided by this operation. Any attempt to use a cursor
3300** that was open at the beginning of this operation will result
3301** in an error.
drh5e00f6c2001-09-13 13:46:56 +00003302**
3303** This will release the write lock on the database file. If there
3304** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00003305*/
drh0f198a72012-02-13 16:43:16 +00003306int sqlite3BtreeRollback(Btree *p, int tripCode){
danielk19778d34dfd2006-01-24 16:37:57 +00003307 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00003308 BtShared *pBt = p->pBt;
drh24cd67e2004-05-10 16:18:47 +00003309 MemPage *pPage1;
danielk1977aef0bf62005-12-30 16:28:01 +00003310
drhd677b3d2007-08-20 22:48:41 +00003311 sqlite3BtreeEnter(p);
drh0f198a72012-02-13 16:43:16 +00003312 if( tripCode==SQLITE_OK ){
3313 rc = tripCode = saveAllCursors(pBt, 0, 0);
3314 }else{
3315 rc = SQLITE_OK;
danielk19772b8c13e2006-01-24 14:21:24 +00003316 }
drh0f198a72012-02-13 16:43:16 +00003317 if( tripCode ){
3318 sqlite3BtreeTripAllCursors(p, tripCode);
3319 }
danielk1977aef0bf62005-12-30 16:28:01 +00003320 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00003321
3322 if( p->inTrans==TRANS_WRITE ){
danielk19778d34dfd2006-01-24 16:37:57 +00003323 int rc2;
danielk1977aef0bf62005-12-30 16:28:01 +00003324
danielk19778d34dfd2006-01-24 16:37:57 +00003325 assert( TRANS_WRITE==pBt->inTransaction );
danielk19773b8a05f2007-03-19 17:44:26 +00003326 rc2 = sqlite3PagerRollback(pBt->pPager);
danielk19778d34dfd2006-01-24 16:37:57 +00003327 if( rc2!=SQLITE_OK ){
3328 rc = rc2;
3329 }
3330
drh24cd67e2004-05-10 16:18:47 +00003331 /* The rollback may have destroyed the pPage1->aData value. So
danielk197730548662009-07-09 05:07:37 +00003332 ** call btreeGetPage() on page 1 again to make
drh16a9b832007-05-05 18:39:25 +00003333 ** sure pPage1->aData is set correctly. */
danielk197730548662009-07-09 05:07:37 +00003334 if( btreeGetPage(pBt, 1, &pPage1, 0)==SQLITE_OK ){
drh1f5b4672010-04-01 02:22:19 +00003335 int nPage = get4byte(28+(u8*)pPage1->aData);
3336 testcase( nPage==0 );
3337 if( nPage==0 ) sqlite3PagerPagecount(pBt->pPager, &nPage);
3338 testcase( pBt->nPage!=nPage );
3339 pBt->nPage = nPage;
drh24cd67e2004-05-10 16:18:47 +00003340 releasePage(pPage1);
3341 }
danielk1977fbcd5852004-06-15 02:44:18 +00003342 assert( countWriteCursors(pBt)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00003343 pBt->inTransaction = TRANS_READ;
drh24cd67e2004-05-10 16:18:47 +00003344 }
danielk1977aef0bf62005-12-30 16:28:01 +00003345
danielk197794b30732009-07-02 17:21:57 +00003346 btreeEndTransaction(p);
drhd677b3d2007-08-20 22:48:41 +00003347 sqlite3BtreeLeave(p);
drha059ad02001-04-17 20:09:11 +00003348 return rc;
3349}
3350
3351/*
danielk1977bd434552009-03-18 10:33:00 +00003352** Start a statement subtransaction. The subtransaction can can be rolled
3353** back independently of the main transaction. You must start a transaction
3354** before starting a subtransaction. The subtransaction is ended automatically
3355** if the main transaction commits or rolls back.
drhab01f612004-05-22 02:55:23 +00003356**
3357** Statement subtransactions are used around individual SQL statements
3358** that are contained within a BEGIN...COMMIT block. If a constraint
3359** error occurs within the statement, the effect of that one statement
3360** can be rolled back without having to rollback the entire transaction.
danielk1977bd434552009-03-18 10:33:00 +00003361**
3362** A statement sub-transaction is implemented as an anonymous savepoint. The
3363** value passed as the second parameter is the total number of savepoints,
3364** including the new anonymous savepoint, open on the B-Tree. i.e. if there
3365** are no active savepoints and no other statement-transactions open,
3366** iStatement is 1. This anonymous savepoint can be released or rolled back
3367** using the sqlite3BtreeSavepoint() function.
drh663fc632002-02-02 18:49:19 +00003368*/
danielk1977bd434552009-03-18 10:33:00 +00003369int sqlite3BtreeBeginStmt(Btree *p, int iStatement){
drh663fc632002-02-02 18:49:19 +00003370 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00003371 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00003372 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00003373 assert( p->inTrans==TRANS_WRITE );
drhc9166342012-01-05 23:32:06 +00003374 assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk1977bd434552009-03-18 10:33:00 +00003375 assert( iStatement>0 );
3376 assert( iStatement>p->db->nSavepoint );
drh5e0ccc22010-03-29 19:36:52 +00003377 assert( pBt->inTransaction==TRANS_WRITE );
3378 /* At the pager level, a statement transaction is a savepoint with
3379 ** an index greater than all savepoints created explicitly using
3380 ** SQL statements. It is illegal to open, release or rollback any
3381 ** such savepoints while the statement transaction savepoint is active.
3382 */
3383 rc = sqlite3PagerOpenSavepoint(pBt->pPager, iStatement);
drhd677b3d2007-08-20 22:48:41 +00003384 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00003385 return rc;
3386}
3387
3388/*
danielk1977fd7f0452008-12-17 17:30:26 +00003389** The second argument to this function, op, is always SAVEPOINT_ROLLBACK
3390** or SAVEPOINT_RELEASE. This function either releases or rolls back the
danielk197712dd5492008-12-18 15:45:07 +00003391** savepoint identified by parameter iSavepoint, depending on the value
3392** of op.
3393**
3394** Normally, iSavepoint is greater than or equal to zero. However, if op is
3395** SAVEPOINT_ROLLBACK, then iSavepoint may also be -1. In this case the
3396** contents of the entire transaction are rolled back. This is different
3397** from a normal transaction rollback, as no locks are released and the
3398** transaction remains open.
danielk1977fd7f0452008-12-17 17:30:26 +00003399*/
3400int sqlite3BtreeSavepoint(Btree *p, int op, int iSavepoint){
3401 int rc = SQLITE_OK;
3402 if( p && p->inTrans==TRANS_WRITE ){
3403 BtShared *pBt = p->pBt;
danielk1977fd7f0452008-12-17 17:30:26 +00003404 assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
3405 assert( iSavepoint>=0 || (iSavepoint==-1 && op==SAVEPOINT_ROLLBACK) );
3406 sqlite3BtreeEnter(p);
danielk1977fd7f0452008-12-17 17:30:26 +00003407 rc = sqlite3PagerSavepoint(pBt->pPager, op, iSavepoint);
drh9f0bbf92009-01-02 21:08:09 +00003408 if( rc==SQLITE_OK ){
drhc9166342012-01-05 23:32:06 +00003409 if( iSavepoint<0 && (pBt->btsFlags & BTS_INITIALLY_EMPTY)!=0 ){
3410 pBt->nPage = 0;
3411 }
drh9f0bbf92009-01-02 21:08:09 +00003412 rc = newDatabase(pBt);
drhdd3cd972010-03-27 17:12:36 +00003413 pBt->nPage = get4byte(28 + pBt->pPage1->aData);
drhb9b49bf2010-08-05 03:21:39 +00003414
3415 /* The database size was written into the offset 28 of the header
3416 ** when the transaction started, so we know that the value at offset
3417 ** 28 is nonzero. */
3418 assert( pBt->nPage>0 );
drh9f0bbf92009-01-02 21:08:09 +00003419 }
danielk1977fd7f0452008-12-17 17:30:26 +00003420 sqlite3BtreeLeave(p);
3421 }
3422 return rc;
3423}
3424
3425/*
drh8b2f49b2001-06-08 00:21:52 +00003426** Create a new cursor for the BTree whose root is on the page
danielk19773e8add92009-07-04 17:16:00 +00003427** iTable. If a read-only cursor is requested, it is assumed that
3428** the caller already has at least a read-only transaction open
3429** on the database already. If a write-cursor is requested, then
3430** the caller is assumed to have an open write transaction.
drh1bee3d72001-10-15 00:44:35 +00003431**
3432** If wrFlag==0, then the cursor can only be used for reading.
drhf74b8d92002-09-01 23:20:45 +00003433** If wrFlag==1, then the cursor can be used for reading or for
3434** writing if other conditions for writing are also met. These
3435** are the conditions that must be met in order for writing to
3436** be allowed:
drh6446c4d2001-12-15 14:22:18 +00003437**
drhf74b8d92002-09-01 23:20:45 +00003438** 1: The cursor must have been opened with wrFlag==1
3439**
drhfe5d71d2007-03-19 11:54:10 +00003440** 2: Other database connections that share the same pager cache
3441** but which are not in the READ_UNCOMMITTED state may not have
3442** cursors open with wrFlag==0 on the same table. Otherwise
3443** the changes made by this write cursor would be visible to
3444** the read cursors in the other database connection.
drhf74b8d92002-09-01 23:20:45 +00003445**
3446** 3: The database must be writable (not on read-only media)
3447**
3448** 4: There must be an active transaction.
3449**
drh6446c4d2001-12-15 14:22:18 +00003450** No checking is done to make sure that page iTable really is the
3451** root page of a b-tree. If it is not, then the cursor acquired
3452** will not work correctly.
danielk197771d5d2c2008-09-29 11:49:47 +00003453**
drhf25a5072009-11-18 23:01:25 +00003454** It is assumed that the sqlite3BtreeCursorZero() has been called
3455** on pCur to initialize the memory space prior to invoking this routine.
drha059ad02001-04-17 20:09:11 +00003456*/
drhd677b3d2007-08-20 22:48:41 +00003457static int btreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00003458 Btree *p, /* The btree */
3459 int iTable, /* Root page of table to open */
3460 int wrFlag, /* 1 to write. 0 read-only */
3461 struct KeyInfo *pKeyInfo, /* First arg to comparison function */
3462 BtCursor *pCur /* Space for new cursor */
drh3aac2dd2004-04-26 14:10:20 +00003463){
danielk19773e8add92009-07-04 17:16:00 +00003464 BtShared *pBt = p->pBt; /* Shared b-tree handle */
drhecdc7532001-09-23 02:35:53 +00003465
drh1fee73e2007-08-29 04:00:57 +00003466 assert( sqlite3BtreeHoldsMutex(p) );
drhf49661a2008-12-10 16:45:50 +00003467 assert( wrFlag==0 || wrFlag==1 );
danielk197796d48e92009-06-29 06:00:37 +00003468
danielk1977602b4662009-07-02 07:47:33 +00003469 /* The following assert statements verify that if this is a sharable
3470 ** b-tree database, the connection is holding the required table locks,
3471 ** and that no other connection has any open cursor that conflicts with
3472 ** this lock. */
3473 assert( hasSharedCacheTableLock(p, iTable, pKeyInfo!=0, wrFlag+1) );
danielk197796d48e92009-06-29 06:00:37 +00003474 assert( wrFlag==0 || !hasReadConflicts(p, iTable) );
3475
danielk19773e8add92009-07-04 17:16:00 +00003476 /* Assert that the caller has opened the required transaction. */
3477 assert( p->inTrans>TRANS_NONE );
3478 assert( wrFlag==0 || p->inTrans==TRANS_WRITE );
3479 assert( pBt->pPage1 && pBt->pPage1->aData );
3480
drhc9166342012-01-05 23:32:06 +00003481 if( NEVER(wrFlag && (pBt->btsFlags & BTS_READ_ONLY)!=0) ){
danielk197796d48e92009-06-29 06:00:37 +00003482 return SQLITE_READONLY;
drha0c9a112004-03-10 13:42:37 +00003483 }
drhb1299152010-03-30 22:58:33 +00003484 if( iTable==1 && btreePagecount(pBt)==0 ){
dana205a482011-08-27 18:48:57 +00003485 assert( wrFlag==0 );
3486 iTable = 0;
danielk19773e8add92009-07-04 17:16:00 +00003487 }
danielk1977aef0bf62005-12-30 16:28:01 +00003488
danielk1977aef0bf62005-12-30 16:28:01 +00003489 /* Now that no other errors can occur, finish filling in the BtCursor
danielk19773e8add92009-07-04 17:16:00 +00003490 ** variables and link the cursor into the BtShared list. */
danielk1977172114a2009-07-07 15:47:12 +00003491 pCur->pgnoRoot = (Pgno)iTable;
3492 pCur->iPage = -1;
drh1e968a02008-03-25 00:22:21 +00003493 pCur->pKeyInfo = pKeyInfo;
danielk1977aef0bf62005-12-30 16:28:01 +00003494 pCur->pBtree = p;
drhd0679ed2007-08-28 22:24:34 +00003495 pCur->pBt = pBt;
drhf49661a2008-12-10 16:45:50 +00003496 pCur->wrFlag = (u8)wrFlag;
drha059ad02001-04-17 20:09:11 +00003497 pCur->pNext = pBt->pCursor;
3498 if( pCur->pNext ){
3499 pCur->pNext->pPrev = pCur;
3500 }
3501 pBt->pCursor = pCur;
danielk1977da184232006-01-05 11:34:32 +00003502 pCur->eState = CURSOR_INVALID;
drh7f751222009-03-17 22:33:00 +00003503 pCur->cachedRowid = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00003504 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00003505}
drhd677b3d2007-08-20 22:48:41 +00003506int sqlite3BtreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00003507 Btree *p, /* The btree */
3508 int iTable, /* Root page of table to open */
3509 int wrFlag, /* 1 to write. 0 read-only */
3510 struct KeyInfo *pKeyInfo, /* First arg to xCompare() */
3511 BtCursor *pCur /* Write new cursor here */
drhd677b3d2007-08-20 22:48:41 +00003512){
3513 int rc;
3514 sqlite3BtreeEnter(p);
danielk1977cd3e8f72008-03-25 09:47:35 +00003515 rc = btreeCursor(p, iTable, wrFlag, pKeyInfo, pCur);
drhd677b3d2007-08-20 22:48:41 +00003516 sqlite3BtreeLeave(p);
3517 return rc;
3518}
drh7f751222009-03-17 22:33:00 +00003519
3520/*
3521** Return the size of a BtCursor object in bytes.
3522**
3523** This interfaces is needed so that users of cursors can preallocate
3524** sufficient storage to hold a cursor. The BtCursor object is opaque
3525** to users so they cannot do the sizeof() themselves - they must call
3526** this routine.
3527*/
3528int sqlite3BtreeCursorSize(void){
drhc54055b2009-11-13 17:05:53 +00003529 return ROUND8(sizeof(BtCursor));
danielk1977cd3e8f72008-03-25 09:47:35 +00003530}
3531
drh7f751222009-03-17 22:33:00 +00003532/*
drhf25a5072009-11-18 23:01:25 +00003533** Initialize memory that will be converted into a BtCursor object.
3534**
3535** The simple approach here would be to memset() the entire object
3536** to zero. But it turns out that the apPage[] and aiIdx[] arrays
3537** do not need to be zeroed and they are large, so we can save a lot
3538** of run-time by skipping the initialization of those elements.
3539*/
3540void sqlite3BtreeCursorZero(BtCursor *p){
3541 memset(p, 0, offsetof(BtCursor, iPage));
3542}
3543
3544/*
drh7f751222009-03-17 22:33:00 +00003545** Set the cached rowid value of every cursor in the same database file
3546** as pCur and having the same root page number as pCur. The value is
3547** set to iRowid.
3548**
3549** Only positive rowid values are considered valid for this cache.
3550** The cache is initialized to zero, indicating an invalid cache.
3551** A btree will work fine with zero or negative rowids. We just cannot
3552** cache zero or negative rowids, which means tables that use zero or
3553** negative rowids might run a little slower. But in practice, zero
3554** or negative rowids are very uncommon so this should not be a problem.
3555*/
3556void sqlite3BtreeSetCachedRowid(BtCursor *pCur, sqlite3_int64 iRowid){
3557 BtCursor *p;
3558 for(p=pCur->pBt->pCursor; p; p=p->pNext){
3559 if( p->pgnoRoot==pCur->pgnoRoot ) p->cachedRowid = iRowid;
3560 }
3561 assert( pCur->cachedRowid==iRowid );
3562}
drhd677b3d2007-08-20 22:48:41 +00003563
drh7f751222009-03-17 22:33:00 +00003564/*
3565** Return the cached rowid for the given cursor. A negative or zero
3566** return value indicates that the rowid cache is invalid and should be
3567** ignored. If the rowid cache has never before been set, then a
3568** zero is returned.
3569*/
3570sqlite3_int64 sqlite3BtreeGetCachedRowid(BtCursor *pCur){
3571 return pCur->cachedRowid;
3572}
drha059ad02001-04-17 20:09:11 +00003573
3574/*
drh5e00f6c2001-09-13 13:46:56 +00003575** Close a cursor. The read lock on the database file is released
drhbd03cae2001-06-02 02:40:57 +00003576** when the last cursor is closed.
drha059ad02001-04-17 20:09:11 +00003577*/
drh3aac2dd2004-04-26 14:10:20 +00003578int sqlite3BtreeCloseCursor(BtCursor *pCur){
drhff0587c2007-08-29 17:43:19 +00003579 Btree *pBtree = pCur->pBtree;
danielk1977cd3e8f72008-03-25 09:47:35 +00003580 if( pBtree ){
danielk197771d5d2c2008-09-29 11:49:47 +00003581 int i;
danielk1977cd3e8f72008-03-25 09:47:35 +00003582 BtShared *pBt = pCur->pBt;
3583 sqlite3BtreeEnter(pBtree);
danielk1977be51a652008-10-08 17:58:48 +00003584 sqlite3BtreeClearCursor(pCur);
danielk1977cd3e8f72008-03-25 09:47:35 +00003585 if( pCur->pPrev ){
3586 pCur->pPrev->pNext = pCur->pNext;
3587 }else{
3588 pBt->pCursor = pCur->pNext;
3589 }
3590 if( pCur->pNext ){
3591 pCur->pNext->pPrev = pCur->pPrev;
3592 }
danielk197771d5d2c2008-09-29 11:49:47 +00003593 for(i=0; i<=pCur->iPage; i++){
3594 releasePage(pCur->apPage[i]);
3595 }
danielk1977cd3e8f72008-03-25 09:47:35 +00003596 unlockBtreeIfUnused(pBt);
3597 invalidateOverflowCache(pCur);
3598 /* sqlite3_free(pCur); */
3599 sqlite3BtreeLeave(pBtree);
drha059ad02001-04-17 20:09:11 +00003600 }
drh8c42ca92001-06-22 19:15:00 +00003601 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00003602}
3603
drh5e2f8b92001-05-28 00:41:15 +00003604/*
drh86057612007-06-26 01:04:48 +00003605** Make sure the BtCursor* given in the argument has a valid
3606** BtCursor.info structure. If it is not already valid, call
danielk197730548662009-07-09 05:07:37 +00003607** btreeParseCell() to fill it in.
drhab01f612004-05-22 02:55:23 +00003608**
3609** BtCursor.info is a cache of the information in the current cell.
danielk197730548662009-07-09 05:07:37 +00003610** Using this cache reduces the number of calls to btreeParseCell().
drh86057612007-06-26 01:04:48 +00003611**
3612** 2007-06-25: There is a bug in some versions of MSVC that cause the
3613** compiler to crash when getCellInfo() is implemented as a macro.
3614** But there is a measureable speed advantage to using the macro on gcc
3615** (when less compiler optimizations like -Os or -O0 are used and the
3616** compiler is not doing agressive inlining.) So we use a real function
3617** for MSVC and a macro for everything else. Ticket #2457.
drh9188b382004-05-14 21:12:22 +00003618*/
drh9188b382004-05-14 21:12:22 +00003619#ifndef NDEBUG
danielk19771cc5ed82007-05-16 17:28:43 +00003620 static void assertCellInfo(BtCursor *pCur){
drh9188b382004-05-14 21:12:22 +00003621 CellInfo info;
danielk197771d5d2c2008-09-29 11:49:47 +00003622 int iPage = pCur->iPage;
drh51c6d962004-06-06 00:42:25 +00003623 memset(&info, 0, sizeof(info));
danielk197730548662009-07-09 05:07:37 +00003624 btreeParseCell(pCur->apPage[iPage], pCur->aiIdx[iPage], &info);
drh9188b382004-05-14 21:12:22 +00003625 assert( memcmp(&info, &pCur->info, sizeof(info))==0 );
drh9188b382004-05-14 21:12:22 +00003626 }
danielk19771cc5ed82007-05-16 17:28:43 +00003627#else
3628 #define assertCellInfo(x)
3629#endif
drh86057612007-06-26 01:04:48 +00003630#ifdef _MSC_VER
3631 /* Use a real function in MSVC to work around bugs in that compiler. */
3632 static void getCellInfo(BtCursor *pCur){
3633 if( pCur->info.nSize==0 ){
danielk197771d5d2c2008-09-29 11:49:47 +00003634 int iPage = pCur->iPage;
danielk197730548662009-07-09 05:07:37 +00003635 btreeParseCell(pCur->apPage[iPage],pCur->aiIdx[iPage],&pCur->info);
drha2c20e42008-03-29 16:01:04 +00003636 pCur->validNKey = 1;
drh86057612007-06-26 01:04:48 +00003637 }else{
3638 assertCellInfo(pCur);
3639 }
3640 }
3641#else /* if not _MSC_VER */
3642 /* Use a macro in all other compilers so that the function is inlined */
danielk197771d5d2c2008-09-29 11:49:47 +00003643#define getCellInfo(pCur) \
3644 if( pCur->info.nSize==0 ){ \
3645 int iPage = pCur->iPage; \
danielk197730548662009-07-09 05:07:37 +00003646 btreeParseCell(pCur->apPage[iPage],pCur->aiIdx[iPage],&pCur->info); \
danielk197771d5d2c2008-09-29 11:49:47 +00003647 pCur->validNKey = 1; \
3648 }else{ \
3649 assertCellInfo(pCur); \
drh86057612007-06-26 01:04:48 +00003650 }
3651#endif /* _MSC_VER */
drh9188b382004-05-14 21:12:22 +00003652
drhea8ffdf2009-07-22 00:35:23 +00003653#ifndef NDEBUG /* The next routine used only within assert() statements */
3654/*
3655** Return true if the given BtCursor is valid. A valid cursor is one
3656** that is currently pointing to a row in a (non-empty) table.
3657** This is a verification routine is used only within assert() statements.
3658*/
3659int sqlite3BtreeCursorIsValid(BtCursor *pCur){
3660 return pCur && pCur->eState==CURSOR_VALID;
3661}
3662#endif /* NDEBUG */
3663
drh9188b382004-05-14 21:12:22 +00003664/*
drh3aac2dd2004-04-26 14:10:20 +00003665** Set *pSize to the size of the buffer needed to hold the value of
3666** the key for the current entry. If the cursor is not pointing
3667** to a valid entry, *pSize is set to 0.
3668**
drh4b70f112004-05-02 21:12:19 +00003669** For a table with the INTKEY flag set, this routine returns the key
drh3aac2dd2004-04-26 14:10:20 +00003670** itself, not the number of bytes in the key.
drhea8ffdf2009-07-22 00:35:23 +00003671**
3672** The caller must position the cursor prior to invoking this routine.
3673**
3674** This routine cannot fail. It always returns SQLITE_OK.
drh7e3b0a02001-04-28 16:52:40 +00003675*/
drh4a1c3802004-05-12 15:15:47 +00003676int sqlite3BtreeKeySize(BtCursor *pCur, i64 *pSize){
drh1fee73e2007-08-29 04:00:57 +00003677 assert( cursorHoldsMutex(pCur) );
drhea8ffdf2009-07-22 00:35:23 +00003678 assert( pCur->eState==CURSOR_INVALID || pCur->eState==CURSOR_VALID );
3679 if( pCur->eState!=CURSOR_VALID ){
3680 *pSize = 0;
3681 }else{
3682 getCellInfo(pCur);
3683 *pSize = pCur->info.nKey;
drh72f82862001-05-24 21:06:34 +00003684 }
drhea8ffdf2009-07-22 00:35:23 +00003685 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00003686}
drh2af926b2001-05-15 00:39:25 +00003687
drh72f82862001-05-24 21:06:34 +00003688/*
drh0e1c19e2004-05-11 00:58:56 +00003689** Set *pSize to the number of bytes of data in the entry the
drhea8ffdf2009-07-22 00:35:23 +00003690** cursor currently points to.
3691**
3692** The caller must guarantee that the cursor is pointing to a non-NULL
3693** valid entry. In other words, the calling procedure must guarantee
3694** that the cursor has Cursor.eState==CURSOR_VALID.
3695**
3696** Failure is not possible. This function always returns SQLITE_OK.
3697** It might just as well be a procedure (returning void) but we continue
3698** to return an integer result code for historical reasons.
drh0e1c19e2004-05-11 00:58:56 +00003699*/
3700int sqlite3BtreeDataSize(BtCursor *pCur, u32 *pSize){
drh1fee73e2007-08-29 04:00:57 +00003701 assert( cursorHoldsMutex(pCur) );
drhea8ffdf2009-07-22 00:35:23 +00003702 assert( pCur->eState==CURSOR_VALID );
3703 getCellInfo(pCur);
3704 *pSize = pCur->info.nData;
3705 return SQLITE_OK;
drh0e1c19e2004-05-11 00:58:56 +00003706}
3707
3708/*
danielk1977d04417962007-05-02 13:16:30 +00003709** Given the page number of an overflow page in the database (parameter
3710** ovfl), this function finds the page number of the next page in the
3711** linked list of overflow pages. If possible, it uses the auto-vacuum
3712** pointer-map data instead of reading the content of page ovfl to do so.
3713**
3714** If an error occurs an SQLite error code is returned. Otherwise:
3715**
danielk1977bea2a942009-01-20 17:06:27 +00003716** The page number of the next overflow page in the linked list is
3717** written to *pPgnoNext. If page ovfl is the last page in its linked
3718** list, *pPgnoNext is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00003719**
danielk1977bea2a942009-01-20 17:06:27 +00003720** If ppPage is not NULL, and a reference to the MemPage object corresponding
3721** to page number pOvfl was obtained, then *ppPage is set to point to that
3722** reference. It is the responsibility of the caller to call releasePage()
3723** on *ppPage to free the reference. In no reference was obtained (because
3724** the pointer-map was used to obtain the value for *pPgnoNext), then
3725** *ppPage is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00003726*/
3727static int getOverflowPage(
drhfa3be902009-07-07 02:44:07 +00003728 BtShared *pBt, /* The database file */
3729 Pgno ovfl, /* Current overflow page number */
danielk1977bea2a942009-01-20 17:06:27 +00003730 MemPage **ppPage, /* OUT: MemPage handle (may be NULL) */
danielk1977d04417962007-05-02 13:16:30 +00003731 Pgno *pPgnoNext /* OUT: Next overflow page number */
3732){
3733 Pgno next = 0;
danielk1977bea2a942009-01-20 17:06:27 +00003734 MemPage *pPage = 0;
drh1bd10f82008-12-10 21:19:56 +00003735 int rc = SQLITE_OK;
danielk1977d04417962007-05-02 13:16:30 +00003736
drh1fee73e2007-08-29 04:00:57 +00003737 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977bea2a942009-01-20 17:06:27 +00003738 assert(pPgnoNext);
danielk1977d04417962007-05-02 13:16:30 +00003739
3740#ifndef SQLITE_OMIT_AUTOVACUUM
3741 /* Try to find the next page in the overflow list using the
3742 ** autovacuum pointer-map pages. Guess that the next page in
3743 ** the overflow list is page number (ovfl+1). If that guess turns
3744 ** out to be wrong, fall back to loading the data of page
3745 ** number ovfl to determine the next page number.
3746 */
3747 if( pBt->autoVacuum ){
3748 Pgno pgno;
3749 Pgno iGuess = ovfl+1;
3750 u8 eType;
3751
3752 while( PTRMAP_ISPAGE(pBt, iGuess) || iGuess==PENDING_BYTE_PAGE(pBt) ){
3753 iGuess++;
3754 }
3755
drhb1299152010-03-30 22:58:33 +00003756 if( iGuess<=btreePagecount(pBt) ){
danielk1977d04417962007-05-02 13:16:30 +00003757 rc = ptrmapGet(pBt, iGuess, &eType, &pgno);
danielk1977bea2a942009-01-20 17:06:27 +00003758 if( rc==SQLITE_OK && eType==PTRMAP_OVERFLOW2 && pgno==ovfl ){
danielk1977d04417962007-05-02 13:16:30 +00003759 next = iGuess;
danielk1977bea2a942009-01-20 17:06:27 +00003760 rc = SQLITE_DONE;
danielk1977d04417962007-05-02 13:16:30 +00003761 }
3762 }
3763 }
3764#endif
3765
danielk1977d8a3f3d2009-07-11 11:45:23 +00003766 assert( next==0 || rc==SQLITE_DONE );
danielk1977bea2a942009-01-20 17:06:27 +00003767 if( rc==SQLITE_OK ){
danielk197730548662009-07-09 05:07:37 +00003768 rc = btreeGetPage(pBt, ovfl, &pPage, 0);
danielk1977d8a3f3d2009-07-11 11:45:23 +00003769 assert( rc==SQLITE_OK || pPage==0 );
3770 if( rc==SQLITE_OK ){
danielk1977d04417962007-05-02 13:16:30 +00003771 next = get4byte(pPage->aData);
3772 }
danielk1977443c0592009-01-16 15:21:05 +00003773 }
danielk197745d68822009-01-16 16:23:38 +00003774
danielk1977bea2a942009-01-20 17:06:27 +00003775 *pPgnoNext = next;
3776 if( ppPage ){
3777 *ppPage = pPage;
3778 }else{
3779 releasePage(pPage);
3780 }
3781 return (rc==SQLITE_DONE ? SQLITE_OK : rc);
danielk1977d04417962007-05-02 13:16:30 +00003782}
3783
danielk1977da107192007-05-04 08:32:13 +00003784/*
3785** Copy data from a buffer to a page, or from a page to a buffer.
3786**
3787** pPayload is a pointer to data stored on database page pDbPage.
3788** If argument eOp is false, then nByte bytes of data are copied
3789** from pPayload to the buffer pointed at by pBuf. If eOp is true,
3790** then sqlite3PagerWrite() is called on pDbPage and nByte bytes
3791** of data are copied from the buffer pBuf to pPayload.
3792**
3793** SQLITE_OK is returned on success, otherwise an error code.
3794*/
3795static int copyPayload(
3796 void *pPayload, /* Pointer to page data */
3797 void *pBuf, /* Pointer to buffer */
3798 int nByte, /* Number of bytes to copy */
3799 int eOp, /* 0 -> copy from page, 1 -> copy to page */
3800 DbPage *pDbPage /* Page containing pPayload */
3801){
3802 if( eOp ){
3803 /* Copy data from buffer to page (a write operation) */
3804 int rc = sqlite3PagerWrite(pDbPage);
3805 if( rc!=SQLITE_OK ){
3806 return rc;
3807 }
3808 memcpy(pPayload, pBuf, nByte);
3809 }else{
3810 /* Copy data from page to buffer (a read operation) */
3811 memcpy(pBuf, pPayload, nByte);
3812 }
3813 return SQLITE_OK;
3814}
danielk1977d04417962007-05-02 13:16:30 +00003815
3816/*
danielk19779f8d6402007-05-02 17:48:45 +00003817** This function is used to read or overwrite payload information
3818** for the entry that the pCur cursor is pointing to. If the eOp
3819** parameter is 0, this is a read operation (data copied into
3820** buffer pBuf). If it is non-zero, a write (data copied from
3821** buffer pBuf).
3822**
3823** A total of "amt" bytes are read or written beginning at "offset".
3824** Data is read to or from the buffer pBuf.
drh72f82862001-05-24 21:06:34 +00003825**
drh3bcdfd22009-07-12 02:32:21 +00003826** The content being read or written might appear on the main page
3827** or be scattered out on multiple overflow pages.
danielk1977da107192007-05-04 08:32:13 +00003828**
danielk1977dcbb5d32007-05-04 18:36:44 +00003829** If the BtCursor.isIncrblobHandle flag is set, and the current
danielk1977da107192007-05-04 08:32:13 +00003830** cursor entry uses one or more overflow pages, this function
3831** allocates space for and lazily popluates the overflow page-list
3832** cache array (BtCursor.aOverflow). Subsequent calls use this
3833** cache to make seeking to the supplied offset more efficient.
3834**
3835** Once an overflow page-list cache has been allocated, it may be
3836** invalidated if some other cursor writes to the same table, or if
3837** the cursor is moved to a different row. Additionally, in auto-vacuum
3838** mode, the following events may invalidate an overflow page-list cache.
3839**
3840** * An incremental vacuum,
3841** * A commit in auto_vacuum="full" mode,
3842** * Creating a table (may require moving an overflow page).
drh72f82862001-05-24 21:06:34 +00003843*/
danielk19779f8d6402007-05-02 17:48:45 +00003844static int accessPayload(
drh3aac2dd2004-04-26 14:10:20 +00003845 BtCursor *pCur, /* Cursor pointing to entry to read from */
danielk197789d40042008-11-17 14:20:56 +00003846 u32 offset, /* Begin reading this far into payload */
3847 u32 amt, /* Read this many bytes */
drh3aac2dd2004-04-26 14:10:20 +00003848 unsigned char *pBuf, /* Write the bytes into this buffer */
danielk19779f8d6402007-05-02 17:48:45 +00003849 int eOp /* zero to read. non-zero to write. */
drh3aac2dd2004-04-26 14:10:20 +00003850){
3851 unsigned char *aPayload;
danielk1977da107192007-05-04 08:32:13 +00003852 int rc = SQLITE_OK;
drhfa1a98a2004-05-14 19:08:17 +00003853 u32 nKey;
danielk19772dec9702007-05-02 16:48:37 +00003854 int iIdx = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00003855 MemPage *pPage = pCur->apPage[pCur->iPage]; /* Btree page of current entry */
danielk19770d065412008-11-12 18:21:36 +00003856 BtShared *pBt = pCur->pBt; /* Btree this cursor belongs to */
drh3aac2dd2004-04-26 14:10:20 +00003857
danielk1977da107192007-05-04 08:32:13 +00003858 assert( pPage );
danielk1977da184232006-01-05 11:34:32 +00003859 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00003860 assert( pCur->aiIdx[pCur->iPage]<pPage->nCell );
drh1fee73e2007-08-29 04:00:57 +00003861 assert( cursorHoldsMutex(pCur) );
danielk1977da107192007-05-04 08:32:13 +00003862
drh86057612007-06-26 01:04:48 +00003863 getCellInfo(pCur);
drh366fda62006-01-13 02:35:09 +00003864 aPayload = pCur->info.pCell + pCur->info.nHeader;
drhf49661a2008-12-10 16:45:50 +00003865 nKey = (pPage->intKey ? 0 : (int)pCur->info.nKey);
danielk1977da107192007-05-04 08:32:13 +00003866
drh3bcdfd22009-07-12 02:32:21 +00003867 if( NEVER(offset+amt > nKey+pCur->info.nData)
danielk19770d065412008-11-12 18:21:36 +00003868 || &aPayload[pCur->info.nLocal] > &pPage->aData[pBt->usableSize]
3869 ){
danielk1977da107192007-05-04 08:32:13 +00003870 /* Trying to read or write past the end of the data is an error */
danielk197767fd7a92008-09-10 17:53:35 +00003871 return SQLITE_CORRUPT_BKPT;
drh3aac2dd2004-04-26 14:10:20 +00003872 }
danielk1977da107192007-05-04 08:32:13 +00003873
3874 /* Check if data must be read/written to/from the btree page itself. */
drhfa1a98a2004-05-14 19:08:17 +00003875 if( offset<pCur->info.nLocal ){
drh2af926b2001-05-15 00:39:25 +00003876 int a = amt;
drhfa1a98a2004-05-14 19:08:17 +00003877 if( a+offset>pCur->info.nLocal ){
3878 a = pCur->info.nLocal - offset;
drh2af926b2001-05-15 00:39:25 +00003879 }
danielk1977da107192007-05-04 08:32:13 +00003880 rc = copyPayload(&aPayload[offset], pBuf, a, eOp, pPage->pDbPage);
drh2aa679f2001-06-25 02:11:07 +00003881 offset = 0;
drha34b6762004-05-07 13:30:42 +00003882 pBuf += a;
drh2af926b2001-05-15 00:39:25 +00003883 amt -= a;
drhdd793422001-06-28 01:54:48 +00003884 }else{
drhfa1a98a2004-05-14 19:08:17 +00003885 offset -= pCur->info.nLocal;
drhbd03cae2001-06-02 02:40:57 +00003886 }
danielk1977da107192007-05-04 08:32:13 +00003887
3888 if( rc==SQLITE_OK && amt>0 ){
danielk197789d40042008-11-17 14:20:56 +00003889 const u32 ovflSize = pBt->usableSize - 4; /* Bytes content per ovfl page */
danielk1977da107192007-05-04 08:32:13 +00003890 Pgno nextPage;
3891
drhfa1a98a2004-05-14 19:08:17 +00003892 nextPage = get4byte(&aPayload[pCur->info.nLocal]);
danielk1977da107192007-05-04 08:32:13 +00003893
danielk19772dec9702007-05-02 16:48:37 +00003894#ifndef SQLITE_OMIT_INCRBLOB
danielk1977dcbb5d32007-05-04 18:36:44 +00003895 /* If the isIncrblobHandle flag is set and the BtCursor.aOverflow[]
danielk1977da107192007-05-04 08:32:13 +00003896 ** has not been allocated, allocate it now. The array is sized at
3897 ** one entry for each overflow page in the overflow chain. The
3898 ** page number of the first overflow page is stored in aOverflow[0],
3899 ** etc. A value of 0 in the aOverflow[] array means "not yet known"
3900 ** (the cache is lazily populated).
3901 */
danielk1977dcbb5d32007-05-04 18:36:44 +00003902 if( pCur->isIncrblobHandle && !pCur->aOverflow ){
danielk19772dec9702007-05-02 16:48:37 +00003903 int nOvfl = (pCur->info.nPayload-pCur->info.nLocal+ovflSize-1)/ovflSize;
drh17435752007-08-16 04:30:38 +00003904 pCur->aOverflow = (Pgno *)sqlite3MallocZero(sizeof(Pgno)*nOvfl);
drh3bcdfd22009-07-12 02:32:21 +00003905 /* nOvfl is always positive. If it were zero, fetchPayload would have
3906 ** been used instead of this routine. */
3907 if( ALWAYS(nOvfl) && !pCur->aOverflow ){
danielk1977da107192007-05-04 08:32:13 +00003908 rc = SQLITE_NOMEM;
danielk19772dec9702007-05-02 16:48:37 +00003909 }
3910 }
danielk1977da107192007-05-04 08:32:13 +00003911
3912 /* If the overflow page-list cache has been allocated and the
3913 ** entry for the first required overflow page is valid, skip
3914 ** directly to it.
3915 */
danielk19772dec9702007-05-02 16:48:37 +00003916 if( pCur->aOverflow && pCur->aOverflow[offset/ovflSize] ){
3917 iIdx = (offset/ovflSize);
3918 nextPage = pCur->aOverflow[iIdx];
3919 offset = (offset%ovflSize);
3920 }
3921#endif
danielk1977da107192007-05-04 08:32:13 +00003922
3923 for( ; rc==SQLITE_OK && amt>0 && nextPage; iIdx++){
3924
3925#ifndef SQLITE_OMIT_INCRBLOB
3926 /* If required, populate the overflow page-list cache. */
3927 if( pCur->aOverflow ){
3928 assert(!pCur->aOverflow[iIdx] || pCur->aOverflow[iIdx]==nextPage);
3929 pCur->aOverflow[iIdx] = nextPage;
3930 }
3931#endif
3932
danielk1977d04417962007-05-02 13:16:30 +00003933 if( offset>=ovflSize ){
3934 /* The only reason to read this page is to obtain the page
danielk1977da107192007-05-04 08:32:13 +00003935 ** number for the next page in the overflow chain. The page
drhfd131da2007-08-07 17:13:03 +00003936 ** data is not required. So first try to lookup the overflow
3937 ** page-list cache, if any, then fall back to the getOverflowPage()
danielk1977da107192007-05-04 08:32:13 +00003938 ** function.
danielk1977d04417962007-05-02 13:16:30 +00003939 */
danielk19772dec9702007-05-02 16:48:37 +00003940#ifndef SQLITE_OMIT_INCRBLOB
danielk1977da107192007-05-04 08:32:13 +00003941 if( pCur->aOverflow && pCur->aOverflow[iIdx+1] ){
3942 nextPage = pCur->aOverflow[iIdx+1];
3943 } else
danielk19772dec9702007-05-02 16:48:37 +00003944#endif
danielk1977da107192007-05-04 08:32:13 +00003945 rc = getOverflowPage(pBt, nextPage, 0, &nextPage);
danielk1977da107192007-05-04 08:32:13 +00003946 offset -= ovflSize;
danielk1977d04417962007-05-02 13:16:30 +00003947 }else{
danielk19779f8d6402007-05-02 17:48:45 +00003948 /* Need to read this page properly. It contains some of the
3949 ** range of data that is being read (eOp==0) or written (eOp!=0).
danielk1977d04417962007-05-02 13:16:30 +00003950 */
danf4ba1092011-10-08 14:57:07 +00003951#ifdef SQLITE_DIRECT_OVERFLOW_READ
3952 sqlite3_file *fd;
3953#endif
danielk1977cfe9a692004-06-16 12:00:29 +00003954 int a = amt;
danf4ba1092011-10-08 14:57:07 +00003955 if( a + offset > ovflSize ){
3956 a = ovflSize - offset;
danielk19779f8d6402007-05-02 17:48:45 +00003957 }
danf4ba1092011-10-08 14:57:07 +00003958
3959#ifdef SQLITE_DIRECT_OVERFLOW_READ
3960 /* If all the following are true:
3961 **
3962 ** 1) this is a read operation, and
3963 ** 2) data is required from the start of this overflow page, and
3964 ** 3) the database is file-backed, and
3965 ** 4) there is no open write-transaction, and
3966 ** 5) the database is not a WAL database,
3967 **
3968 ** then data can be read directly from the database file into the
3969 ** output buffer, bypassing the page-cache altogether. This speeds
3970 ** up loading large records that span many overflow pages.
3971 */
3972 if( eOp==0 /* (1) */
3973 && offset==0 /* (2) */
3974 && pBt->inTransaction==TRANS_READ /* (4) */
3975 && (fd = sqlite3PagerFile(pBt->pPager))->pMethods /* (3) */
3976 && pBt->pPage1->aData[19]==0x01 /* (5) */
3977 ){
3978 u8 aSave[4];
3979 u8 *aWrite = &pBuf[-4];
3980 memcpy(aSave, aWrite, 4);
dan27d47fb2011-12-21 17:00:16 +00003981 rc = sqlite3OsRead(fd, aWrite, a+4, (i64)pBt->pageSize*(nextPage-1));
danf4ba1092011-10-08 14:57:07 +00003982 nextPage = get4byte(aWrite);
3983 memcpy(aWrite, aSave, 4);
3984 }else
3985#endif
3986
3987 {
3988 DbPage *pDbPage;
3989 rc = sqlite3PagerGet(pBt->pPager, nextPage, &pDbPage);
3990 if( rc==SQLITE_OK ){
3991 aPayload = sqlite3PagerGetData(pDbPage);
3992 nextPage = get4byte(aPayload);
3993 rc = copyPayload(&aPayload[offset+4], pBuf, a, eOp, pDbPage);
3994 sqlite3PagerUnref(pDbPage);
3995 offset = 0;
3996 }
3997 }
3998 amt -= a;
3999 pBuf += a;
danielk1977cfe9a692004-06-16 12:00:29 +00004000 }
drh2af926b2001-05-15 00:39:25 +00004001 }
drh2af926b2001-05-15 00:39:25 +00004002 }
danielk1977cfe9a692004-06-16 12:00:29 +00004003
danielk1977da107192007-05-04 08:32:13 +00004004 if( rc==SQLITE_OK && amt>0 ){
drh49285702005-09-17 15:20:26 +00004005 return SQLITE_CORRUPT_BKPT;
drha7fcb052001-12-14 15:09:55 +00004006 }
danielk1977da107192007-05-04 08:32:13 +00004007 return rc;
drh2af926b2001-05-15 00:39:25 +00004008}
4009
drh72f82862001-05-24 21:06:34 +00004010/*
drh3aac2dd2004-04-26 14:10:20 +00004011** Read part of the key associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00004012** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00004013** begins at "offset".
drh8c1238a2003-01-02 14:43:55 +00004014**
drh5d1a8722009-07-22 18:07:40 +00004015** The caller must ensure that pCur is pointing to a valid row
4016** in the table.
4017**
drh3aac2dd2004-04-26 14:10:20 +00004018** Return SQLITE_OK on success or an error code if anything goes
4019** wrong. An error is returned if "offset+amt" is larger than
4020** the available payload.
drh72f82862001-05-24 21:06:34 +00004021*/
drha34b6762004-05-07 13:30:42 +00004022int sqlite3BtreeKey(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drh1fee73e2007-08-29 04:00:57 +00004023 assert( cursorHoldsMutex(pCur) );
drh5d1a8722009-07-22 18:07:40 +00004024 assert( pCur->eState==CURSOR_VALID );
4025 assert( pCur->iPage>=0 && pCur->apPage[pCur->iPage] );
4026 assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
4027 return accessPayload(pCur, offset, amt, (unsigned char*)pBuf, 0);
drh3aac2dd2004-04-26 14:10:20 +00004028}
4029
4030/*
drh3aac2dd2004-04-26 14:10:20 +00004031** Read part of the data associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00004032** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00004033** begins at "offset".
4034**
4035** Return SQLITE_OK on success or an error code if anything goes
4036** wrong. An error is returned if "offset+amt" is larger than
4037** the available payload.
drh72f82862001-05-24 21:06:34 +00004038*/
drh3aac2dd2004-04-26 14:10:20 +00004039int sqlite3BtreeData(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drhd677b3d2007-08-20 22:48:41 +00004040 int rc;
4041
danielk19773588ceb2008-06-10 17:30:26 +00004042#ifndef SQLITE_OMIT_INCRBLOB
4043 if ( pCur->eState==CURSOR_INVALID ){
4044 return SQLITE_ABORT;
4045 }
4046#endif
4047
drh1fee73e2007-08-29 04:00:57 +00004048 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00004049 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00004050 if( rc==SQLITE_OK ){
4051 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00004052 assert( pCur->iPage>=0 && pCur->apPage[pCur->iPage] );
4053 assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
drhfb192682009-07-11 18:26:28 +00004054 rc = accessPayload(pCur, offset, amt, pBuf, 0);
danielk1977da184232006-01-05 11:34:32 +00004055 }
4056 return rc;
drh2af926b2001-05-15 00:39:25 +00004057}
4058
drh72f82862001-05-24 21:06:34 +00004059/*
drh0e1c19e2004-05-11 00:58:56 +00004060** Return a pointer to payload information from the entry that the
4061** pCur cursor is pointing to. The pointer is to the beginning of
4062** the key if skipKey==0 and it points to the beginning of data if
drhe51c44f2004-05-30 20:46:09 +00004063** skipKey==1. The number of bytes of available key/data is written
4064** into *pAmt. If *pAmt==0, then the value returned will not be
4065** a valid pointer.
drh0e1c19e2004-05-11 00:58:56 +00004066**
4067** This routine is an optimization. It is common for the entire key
4068** and data to fit on the local page and for there to be no overflow
4069** pages. When that is so, this routine can be used to access the
4070** key and data without making a copy. If the key and/or data spills
drh7f751222009-03-17 22:33:00 +00004071** onto overflow pages, then accessPayload() must be used to reassemble
drh0e1c19e2004-05-11 00:58:56 +00004072** the key/data and copy it into a preallocated buffer.
4073**
4074** The pointer returned by this routine looks directly into the cached
4075** page of the database. The data might change or move the next time
4076** any btree routine is called.
4077*/
4078static const unsigned char *fetchPayload(
4079 BtCursor *pCur, /* Cursor pointing to entry to read from */
drhe51c44f2004-05-30 20:46:09 +00004080 int *pAmt, /* Write the number of available bytes here */
drh0e1c19e2004-05-11 00:58:56 +00004081 int skipKey /* read beginning at data if this is true */
4082){
4083 unsigned char *aPayload;
4084 MemPage *pPage;
drhfa1a98a2004-05-14 19:08:17 +00004085 u32 nKey;
danielk197789d40042008-11-17 14:20:56 +00004086 u32 nLocal;
drh0e1c19e2004-05-11 00:58:56 +00004087
danielk197771d5d2c2008-09-29 11:49:47 +00004088 assert( pCur!=0 && pCur->iPage>=0 && pCur->apPage[pCur->iPage]);
danielk1977da184232006-01-05 11:34:32 +00004089 assert( pCur->eState==CURSOR_VALID );
drh1fee73e2007-08-29 04:00:57 +00004090 assert( cursorHoldsMutex(pCur) );
danielk197771d5d2c2008-09-29 11:49:47 +00004091 pPage = pCur->apPage[pCur->iPage];
4092 assert( pCur->aiIdx[pCur->iPage]<pPage->nCell );
drhfe3313f2009-07-21 19:02:20 +00004093 if( NEVER(pCur->info.nSize==0) ){
4094 btreeParseCell(pCur->apPage[pCur->iPage], pCur->aiIdx[pCur->iPage],
4095 &pCur->info);
4096 }
drh43605152004-05-29 21:46:49 +00004097 aPayload = pCur->info.pCell;
drhfa1a98a2004-05-14 19:08:17 +00004098 aPayload += pCur->info.nHeader;
drh0e1c19e2004-05-11 00:58:56 +00004099 if( pPage->intKey ){
drhfa1a98a2004-05-14 19:08:17 +00004100 nKey = 0;
4101 }else{
drhf49661a2008-12-10 16:45:50 +00004102 nKey = (int)pCur->info.nKey;
drh0e1c19e2004-05-11 00:58:56 +00004103 }
drh0e1c19e2004-05-11 00:58:56 +00004104 if( skipKey ){
drhfa1a98a2004-05-14 19:08:17 +00004105 aPayload += nKey;
4106 nLocal = pCur->info.nLocal - nKey;
drh0e1c19e2004-05-11 00:58:56 +00004107 }else{
drhfa1a98a2004-05-14 19:08:17 +00004108 nLocal = pCur->info.nLocal;
drhfe3313f2009-07-21 19:02:20 +00004109 assert( nLocal<=nKey );
drh0e1c19e2004-05-11 00:58:56 +00004110 }
drhe51c44f2004-05-30 20:46:09 +00004111 *pAmt = nLocal;
drh0e1c19e2004-05-11 00:58:56 +00004112 return aPayload;
4113}
4114
4115
4116/*
drhe51c44f2004-05-30 20:46:09 +00004117** For the entry that cursor pCur is point to, return as
4118** many bytes of the key or data as are available on the local
4119** b-tree page. Write the number of available bytes into *pAmt.
drh0e1c19e2004-05-11 00:58:56 +00004120**
4121** The pointer returned is ephemeral. The key/data may move
drhd677b3d2007-08-20 22:48:41 +00004122** or be destroyed on the next call to any Btree routine,
4123** including calls from other threads against the same cache.
4124** Hence, a mutex on the BtShared should be held prior to calling
4125** this routine.
drh0e1c19e2004-05-11 00:58:56 +00004126**
4127** These routines is used to get quick access to key and data
4128** in the common case where no overflow pages are used.
drh0e1c19e2004-05-11 00:58:56 +00004129*/
drhe51c44f2004-05-30 20:46:09 +00004130const void *sqlite3BtreeKeyFetch(BtCursor *pCur, int *pAmt){
drhfe3313f2009-07-21 19:02:20 +00004131 const void *p = 0;
danielk19774b0aa4c2009-05-28 11:05:57 +00004132 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh1fee73e2007-08-29 04:00:57 +00004133 assert( cursorHoldsMutex(pCur) );
drhfe3313f2009-07-21 19:02:20 +00004134 if( ALWAYS(pCur->eState==CURSOR_VALID) ){
4135 p = (const void*)fetchPayload(pCur, pAmt, 0);
danielk1977da184232006-01-05 11:34:32 +00004136 }
drhfe3313f2009-07-21 19:02:20 +00004137 return p;
drh0e1c19e2004-05-11 00:58:56 +00004138}
drhe51c44f2004-05-30 20:46:09 +00004139const void *sqlite3BtreeDataFetch(BtCursor *pCur, int *pAmt){
drhfe3313f2009-07-21 19:02:20 +00004140 const void *p = 0;
danielk19774b0aa4c2009-05-28 11:05:57 +00004141 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh1fee73e2007-08-29 04:00:57 +00004142 assert( cursorHoldsMutex(pCur) );
drhfe3313f2009-07-21 19:02:20 +00004143 if( ALWAYS(pCur->eState==CURSOR_VALID) ){
4144 p = (const void*)fetchPayload(pCur, pAmt, 1);
danielk1977da184232006-01-05 11:34:32 +00004145 }
drhfe3313f2009-07-21 19:02:20 +00004146 return p;
drh0e1c19e2004-05-11 00:58:56 +00004147}
4148
4149
4150/*
drh8178a752003-01-05 21:41:40 +00004151** Move the cursor down to a new child page. The newPgno argument is the
drhab01f612004-05-22 02:55:23 +00004152** page number of the child page to move to.
danielk1977a299d612009-07-13 11:22:10 +00004153**
4154** This function returns SQLITE_CORRUPT if the page-header flags field of
4155** the new child page does not match the flags field of the parent (i.e.
4156** if an intkey page appears to be the parent of a non-intkey page, or
4157** vice-versa).
drh72f82862001-05-24 21:06:34 +00004158*/
drh3aac2dd2004-04-26 14:10:20 +00004159static int moveToChild(BtCursor *pCur, u32 newPgno){
drh72f82862001-05-24 21:06:34 +00004160 int rc;
danielk197771d5d2c2008-09-29 11:49:47 +00004161 int i = pCur->iPage;
drh72f82862001-05-24 21:06:34 +00004162 MemPage *pNewPage;
drhd0679ed2007-08-28 22:24:34 +00004163 BtShared *pBt = pCur->pBt;
drh72f82862001-05-24 21:06:34 +00004164
drh1fee73e2007-08-29 04:00:57 +00004165 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00004166 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00004167 assert( pCur->iPage<BTCURSOR_MAX_DEPTH );
4168 if( pCur->iPage>=(BTCURSOR_MAX_DEPTH-1) ){
4169 return SQLITE_CORRUPT_BKPT;
4170 }
4171 rc = getAndInitPage(pBt, newPgno, &pNewPage);
drh6019e162001-07-02 17:51:45 +00004172 if( rc ) return rc;
danielk197771d5d2c2008-09-29 11:49:47 +00004173 pCur->apPage[i+1] = pNewPage;
4174 pCur->aiIdx[i+1] = 0;
4175 pCur->iPage++;
4176
drh271efa52004-05-30 19:19:05 +00004177 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004178 pCur->validNKey = 0;
danielk1977bd5969a2009-07-11 17:39:42 +00004179 if( pNewPage->nCell<1 || pNewPage->intKey!=pCur->apPage[i]->intKey ){
drh49285702005-09-17 15:20:26 +00004180 return SQLITE_CORRUPT_BKPT;
drh4be295b2003-12-16 03:44:47 +00004181 }
drh72f82862001-05-24 21:06:34 +00004182 return SQLITE_OK;
4183}
4184
danbb246c42012-01-12 14:25:55 +00004185#if 0
danielk1977bf93c562008-09-29 15:53:25 +00004186/*
4187** Page pParent is an internal (non-leaf) tree page. This function
4188** asserts that page number iChild is the left-child if the iIdx'th
4189** cell in page pParent. Or, if iIdx is equal to the total number of
4190** cells in pParent, that page number iChild is the right-child of
4191** the page.
4192*/
4193static void assertParentIndex(MemPage *pParent, int iIdx, Pgno iChild){
4194 assert( iIdx<=pParent->nCell );
4195 if( iIdx==pParent->nCell ){
4196 assert( get4byte(&pParent->aData[pParent->hdrOffset+8])==iChild );
4197 }else{
4198 assert( get4byte(findCell(pParent, iIdx))==iChild );
4199 }
4200}
4201#else
4202# define assertParentIndex(x,y,z)
4203#endif
4204
drh72f82862001-05-24 21:06:34 +00004205/*
drh5e2f8b92001-05-28 00:41:15 +00004206** Move the cursor up to the parent page.
4207**
4208** pCur->idx is set to the cell index that contains the pointer
4209** to the page we are coming from. If we are coming from the
4210** right-most child page then pCur->idx is set to one more than
drhbd03cae2001-06-02 02:40:57 +00004211** the largest cell index.
drh72f82862001-05-24 21:06:34 +00004212*/
danielk197730548662009-07-09 05:07:37 +00004213static void moveToParent(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00004214 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00004215 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00004216 assert( pCur->iPage>0 );
4217 assert( pCur->apPage[pCur->iPage] );
danbb246c42012-01-12 14:25:55 +00004218
4219 /* UPDATE: It is actually possible for the condition tested by the assert
4220 ** below to be untrue if the database file is corrupt. This can occur if
4221 ** one cursor has modified page pParent while a reference to it is held
4222 ** by a second cursor. Which can only happen if a single page is linked
4223 ** into more than one b-tree structure in a corrupt database. */
4224#if 0
danielk1977bf93c562008-09-29 15:53:25 +00004225 assertParentIndex(
4226 pCur->apPage[pCur->iPage-1],
4227 pCur->aiIdx[pCur->iPage-1],
4228 pCur->apPage[pCur->iPage]->pgno
4229 );
danbb246c42012-01-12 14:25:55 +00004230#endif
dan6c2688c2012-01-12 15:05:03 +00004231 testcase( pCur->aiIdx[pCur->iPage-1] > pCur->apPage[pCur->iPage-1]->nCell );
danbb246c42012-01-12 14:25:55 +00004232
danielk197771d5d2c2008-09-29 11:49:47 +00004233 releasePage(pCur->apPage[pCur->iPage]);
4234 pCur->iPage--;
drh271efa52004-05-30 19:19:05 +00004235 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004236 pCur->validNKey = 0;
drh72f82862001-05-24 21:06:34 +00004237}
4238
4239/*
danielk19778f880a82009-07-13 09:41:45 +00004240** Move the cursor to point to the root page of its b-tree structure.
4241**
4242** If the table has a virtual root page, then the cursor is moved to point
4243** to the virtual root page instead of the actual root page. A table has a
4244** virtual root page when the actual root page contains no cells and a
4245** single child page. This can only happen with the table rooted at page 1.
4246**
4247** If the b-tree structure is empty, the cursor state is set to
4248** CURSOR_INVALID. Otherwise, the cursor is set to point to the first
4249** cell located on the root (or virtual root) page and the cursor state
4250** is set to CURSOR_VALID.
4251**
4252** If this function returns successfully, it may be assumed that the
4253** page-header flags indicate that the [virtual] root-page is the expected
4254** kind of b-tree page (i.e. if when opening the cursor the caller did not
4255** specify a KeyInfo structure the flags byte is set to 0x05 or 0x0D,
4256** indicating a table b-tree, or if the caller did specify a KeyInfo
4257** structure the flags byte is set to 0x02 or 0x0A, indicating an index
4258** b-tree).
drh72f82862001-05-24 21:06:34 +00004259*/
drh5e2f8b92001-05-28 00:41:15 +00004260static int moveToRoot(BtCursor *pCur){
drh3aac2dd2004-04-26 14:10:20 +00004261 MemPage *pRoot;
drh777e4c42006-01-13 04:31:58 +00004262 int rc = SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00004263 Btree *p = pCur->pBtree;
4264 BtShared *pBt = p->pBt;
drhbd03cae2001-06-02 02:40:57 +00004265
drh1fee73e2007-08-29 04:00:57 +00004266 assert( cursorHoldsMutex(pCur) );
drhfb982642007-08-30 01:19:59 +00004267 assert( CURSOR_INVALID < CURSOR_REQUIRESEEK );
4268 assert( CURSOR_VALID < CURSOR_REQUIRESEEK );
4269 assert( CURSOR_FAULT > CURSOR_REQUIRESEEK );
4270 if( pCur->eState>=CURSOR_REQUIRESEEK ){
4271 if( pCur->eState==CURSOR_FAULT ){
drh4c301aa2009-07-15 17:25:45 +00004272 assert( pCur->skipNext!=SQLITE_OK );
4273 return pCur->skipNext;
drhfb982642007-08-30 01:19:59 +00004274 }
danielk1977be51a652008-10-08 17:58:48 +00004275 sqlite3BtreeClearCursor(pCur);
drhbf700f32007-03-31 02:36:44 +00004276 }
danielk197771d5d2c2008-09-29 11:49:47 +00004277
4278 if( pCur->iPage>=0 ){
4279 int i;
4280 for(i=1; i<=pCur->iPage; i++){
4281 releasePage(pCur->apPage[i]);
danielk1977d9f6c532008-09-19 16:39:38 +00004282 }
danielk1977172114a2009-07-07 15:47:12 +00004283 pCur->iPage = 0;
dana205a482011-08-27 18:48:57 +00004284 }else if( pCur->pgnoRoot==0 ){
4285 pCur->eState = CURSOR_INVALID;
4286 return SQLITE_OK;
drh777e4c42006-01-13 04:31:58 +00004287 }else{
drh4c301aa2009-07-15 17:25:45 +00004288 rc = getAndInitPage(pBt, pCur->pgnoRoot, &pCur->apPage[0]);
4289 if( rc!=SQLITE_OK ){
drh777e4c42006-01-13 04:31:58 +00004290 pCur->eState = CURSOR_INVALID;
4291 return rc;
4292 }
danielk1977172114a2009-07-07 15:47:12 +00004293 pCur->iPage = 0;
4294
4295 /* If pCur->pKeyInfo is not NULL, then the caller that opened this cursor
4296 ** expected to open it on an index b-tree. Otherwise, if pKeyInfo is
4297 ** NULL, the caller expects a table b-tree. If this is not the case,
4298 ** return an SQLITE_CORRUPT error. */
4299 assert( pCur->apPage[0]->intKey==1 || pCur->apPage[0]->intKey==0 );
4300 if( (pCur->pKeyInfo==0)!=pCur->apPage[0]->intKey ){
4301 return SQLITE_CORRUPT_BKPT;
4302 }
drhc39e0002004-05-07 23:50:57 +00004303 }
danielk197771d5d2c2008-09-29 11:49:47 +00004304
danielk19778f880a82009-07-13 09:41:45 +00004305 /* Assert that the root page is of the correct type. This must be the
4306 ** case as the call to this function that loaded the root-page (either
4307 ** this call or a previous invocation) would have detected corruption
4308 ** if the assumption were not true, and it is not possible for the flags
4309 ** byte to have been modified while this cursor is holding a reference
4310 ** to the page. */
danielk197771d5d2c2008-09-29 11:49:47 +00004311 pRoot = pCur->apPage[0];
4312 assert( pRoot->pgno==pCur->pgnoRoot );
danielk19778f880a82009-07-13 09:41:45 +00004313 assert( pRoot->isInit && (pCur->pKeyInfo==0)==pRoot->intKey );
4314
danielk197771d5d2c2008-09-29 11:49:47 +00004315 pCur->aiIdx[0] = 0;
drh271efa52004-05-30 19:19:05 +00004316 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004317 pCur->atLast = 0;
4318 pCur->validNKey = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00004319
drh8856d6a2004-04-29 14:42:46 +00004320 if( pRoot->nCell==0 && !pRoot->leaf ){
4321 Pgno subpage;
drhc85240d2009-06-04 16:14:33 +00004322 if( pRoot->pgno!=1 ) return SQLITE_CORRUPT_BKPT;
drh43605152004-05-29 21:46:49 +00004323 subpage = get4byte(&pRoot->aData[pRoot->hdrOffset+8]);
danielk1977da184232006-01-05 11:34:32 +00004324 pCur->eState = CURSOR_VALID;
drh4b70f112004-05-02 21:12:19 +00004325 rc = moveToChild(pCur, subpage);
danielk197771d5d2c2008-09-29 11:49:47 +00004326 }else{
4327 pCur->eState = ((pRoot->nCell>0)?CURSOR_VALID:CURSOR_INVALID);
drh8856d6a2004-04-29 14:42:46 +00004328 }
4329 return rc;
drh72f82862001-05-24 21:06:34 +00004330}
drh2af926b2001-05-15 00:39:25 +00004331
drh5e2f8b92001-05-28 00:41:15 +00004332/*
4333** Move the cursor down to the left-most leaf entry beneath the
4334** entry to which it is currently pointing.
drh777e4c42006-01-13 04:31:58 +00004335**
4336** The left-most leaf is the one with the smallest key - the first
4337** in ascending order.
drh5e2f8b92001-05-28 00:41:15 +00004338*/
4339static int moveToLeftmost(BtCursor *pCur){
4340 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00004341 int rc = SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00004342 MemPage *pPage;
drh5e2f8b92001-05-28 00:41:15 +00004343
drh1fee73e2007-08-29 04:00:57 +00004344 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00004345 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00004346 while( rc==SQLITE_OK && !(pPage = pCur->apPage[pCur->iPage])->leaf ){
4347 assert( pCur->aiIdx[pCur->iPage]<pPage->nCell );
4348 pgno = get4byte(findCell(pPage, pCur->aiIdx[pCur->iPage]));
drh8178a752003-01-05 21:41:40 +00004349 rc = moveToChild(pCur, pgno);
drh5e2f8b92001-05-28 00:41:15 +00004350 }
drhd677b3d2007-08-20 22:48:41 +00004351 return rc;
drh5e2f8b92001-05-28 00:41:15 +00004352}
4353
drh2dcc9aa2002-12-04 13:40:25 +00004354/*
4355** Move the cursor down to the right-most leaf entry beneath the
4356** page to which it is currently pointing. Notice the difference
4357** between moveToLeftmost() and moveToRightmost(). moveToLeftmost()
4358** finds the left-most entry beneath the *entry* whereas moveToRightmost()
4359** finds the right-most entry beneath the *page*.
drh777e4c42006-01-13 04:31:58 +00004360**
4361** The right-most entry is the one with the largest key - the last
4362** key in ascending order.
drh2dcc9aa2002-12-04 13:40:25 +00004363*/
4364static int moveToRightmost(BtCursor *pCur){
4365 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00004366 int rc = SQLITE_OK;
drh1bd10f82008-12-10 21:19:56 +00004367 MemPage *pPage = 0;
drh2dcc9aa2002-12-04 13:40:25 +00004368
drh1fee73e2007-08-29 04:00:57 +00004369 assert( cursorHoldsMutex(pCur) );
danielk1977da184232006-01-05 11:34:32 +00004370 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00004371 while( rc==SQLITE_OK && !(pPage = pCur->apPage[pCur->iPage])->leaf ){
drh43605152004-05-29 21:46:49 +00004372 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
danielk197771d5d2c2008-09-29 11:49:47 +00004373 pCur->aiIdx[pCur->iPage] = pPage->nCell;
drh8178a752003-01-05 21:41:40 +00004374 rc = moveToChild(pCur, pgno);
drh2dcc9aa2002-12-04 13:40:25 +00004375 }
drhd677b3d2007-08-20 22:48:41 +00004376 if( rc==SQLITE_OK ){
danielk197771d5d2c2008-09-29 11:49:47 +00004377 pCur->aiIdx[pCur->iPage] = pPage->nCell-1;
drhd677b3d2007-08-20 22:48:41 +00004378 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004379 pCur->validNKey = 0;
drhd677b3d2007-08-20 22:48:41 +00004380 }
danielk1977518002e2008-09-05 05:02:46 +00004381 return rc;
drh2dcc9aa2002-12-04 13:40:25 +00004382}
4383
drh5e00f6c2001-09-13 13:46:56 +00004384/* Move the cursor to the first entry in the table. Return SQLITE_OK
4385** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00004386** or set *pRes to 1 if the table is empty.
drh5e00f6c2001-09-13 13:46:56 +00004387*/
drh3aac2dd2004-04-26 14:10:20 +00004388int sqlite3BtreeFirst(BtCursor *pCur, int *pRes){
drh5e00f6c2001-09-13 13:46:56 +00004389 int rc;
drhd677b3d2007-08-20 22:48:41 +00004390
drh1fee73e2007-08-29 04:00:57 +00004391 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00004392 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh5e00f6c2001-09-13 13:46:56 +00004393 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00004394 if( rc==SQLITE_OK ){
4395 if( pCur->eState==CURSOR_INVALID ){
dana205a482011-08-27 18:48:57 +00004396 assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage]->nCell==0 );
drhd677b3d2007-08-20 22:48:41 +00004397 *pRes = 1;
drhd677b3d2007-08-20 22:48:41 +00004398 }else{
danielk197771d5d2c2008-09-29 11:49:47 +00004399 assert( pCur->apPage[pCur->iPage]->nCell>0 );
drhd677b3d2007-08-20 22:48:41 +00004400 *pRes = 0;
4401 rc = moveToLeftmost(pCur);
4402 }
drh5e00f6c2001-09-13 13:46:56 +00004403 }
drh5e00f6c2001-09-13 13:46:56 +00004404 return rc;
4405}
drh5e2f8b92001-05-28 00:41:15 +00004406
drh9562b552002-02-19 15:00:07 +00004407/* Move the cursor to the last entry in the table. Return SQLITE_OK
4408** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00004409** or set *pRes to 1 if the table is empty.
drh9562b552002-02-19 15:00:07 +00004410*/
drh3aac2dd2004-04-26 14:10:20 +00004411int sqlite3BtreeLast(BtCursor *pCur, int *pRes){
drh9562b552002-02-19 15:00:07 +00004412 int rc;
drhd677b3d2007-08-20 22:48:41 +00004413
drh1fee73e2007-08-29 04:00:57 +00004414 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00004415 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk19773f632d52009-05-02 10:03:09 +00004416
4417 /* If the cursor already points to the last entry, this is a no-op. */
4418 if( CURSOR_VALID==pCur->eState && pCur->atLast ){
4419#ifdef SQLITE_DEBUG
4420 /* This block serves to assert() that the cursor really does point
4421 ** to the last entry in the b-tree. */
4422 int ii;
4423 for(ii=0; ii<pCur->iPage; ii++){
4424 assert( pCur->aiIdx[ii]==pCur->apPage[ii]->nCell );
4425 }
4426 assert( pCur->aiIdx[pCur->iPage]==pCur->apPage[pCur->iPage]->nCell-1 );
4427 assert( pCur->apPage[pCur->iPage]->leaf );
4428#endif
4429 return SQLITE_OK;
4430 }
4431
drh9562b552002-02-19 15:00:07 +00004432 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00004433 if( rc==SQLITE_OK ){
4434 if( CURSOR_INVALID==pCur->eState ){
dana205a482011-08-27 18:48:57 +00004435 assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage]->nCell==0 );
drhd677b3d2007-08-20 22:48:41 +00004436 *pRes = 1;
4437 }else{
4438 assert( pCur->eState==CURSOR_VALID );
4439 *pRes = 0;
4440 rc = moveToRightmost(pCur);
drhf49661a2008-12-10 16:45:50 +00004441 pCur->atLast = rc==SQLITE_OK ?1:0;
drhd677b3d2007-08-20 22:48:41 +00004442 }
drh9562b552002-02-19 15:00:07 +00004443 }
drh9562b552002-02-19 15:00:07 +00004444 return rc;
4445}
4446
drhe14006d2008-03-25 17:23:32 +00004447/* Move the cursor so that it points to an entry near the key
drhe63d9992008-08-13 19:11:48 +00004448** specified by pIdxKey or intKey. Return a success code.
drh72f82862001-05-24 21:06:34 +00004449**
drhe63d9992008-08-13 19:11:48 +00004450** For INTKEY tables, the intKey parameter is used. pIdxKey
4451** must be NULL. For index tables, pIdxKey is used and intKey
4452** is ignored.
drh3aac2dd2004-04-26 14:10:20 +00004453**
drh5e2f8b92001-05-28 00:41:15 +00004454** If an exact match is not found, then the cursor is always
drhbd03cae2001-06-02 02:40:57 +00004455** left pointing at a leaf page which would hold the entry if it
drh5e2f8b92001-05-28 00:41:15 +00004456** were present. The cursor might point to an entry that comes
4457** before or after the key.
4458**
drh64022502009-01-09 14:11:04 +00004459** An integer is written into *pRes which is the result of
4460** comparing the key with the entry to which the cursor is
4461** pointing. The meaning of the integer written into
4462** *pRes is as follows:
drhbd03cae2001-06-02 02:40:57 +00004463**
4464** *pRes<0 The cursor is left pointing at an entry that
drh64022502009-01-09 14:11:04 +00004465** is smaller than intKey/pIdxKey or if the table is empty
drh1a844c32002-12-04 22:29:28 +00004466** and the cursor is therefore left point to nothing.
drhbd03cae2001-06-02 02:40:57 +00004467**
4468** *pRes==0 The cursor is left pointing at an entry that
drh64022502009-01-09 14:11:04 +00004469** exactly matches intKey/pIdxKey.
drhbd03cae2001-06-02 02:40:57 +00004470**
4471** *pRes>0 The cursor is left pointing at an entry that
drh64022502009-01-09 14:11:04 +00004472** is larger than intKey/pIdxKey.
drhd677b3d2007-08-20 22:48:41 +00004473**
drha059ad02001-04-17 20:09:11 +00004474*/
drhe63d9992008-08-13 19:11:48 +00004475int sqlite3BtreeMovetoUnpacked(
4476 BtCursor *pCur, /* The cursor to be moved */
4477 UnpackedRecord *pIdxKey, /* Unpacked index key */
4478 i64 intKey, /* The table key */
4479 int biasRight, /* If true, bias the search to the high end */
4480 int *pRes /* Write search results here */
drhe4d90812007-03-29 05:51:49 +00004481){
drh72f82862001-05-24 21:06:34 +00004482 int rc;
drhd677b3d2007-08-20 22:48:41 +00004483
drh1fee73e2007-08-29 04:00:57 +00004484 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00004485 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk19775cb09632009-07-09 11:36:01 +00004486 assert( pRes );
danielk19773fd7cf52009-07-13 07:30:52 +00004487 assert( (pIdxKey==0)==(pCur->pKeyInfo==0) );
drha2c20e42008-03-29 16:01:04 +00004488
4489 /* If the cursor is already positioned at the point we are trying
4490 ** to move to, then just return without doing any work */
danielk197771d5d2c2008-09-29 11:49:47 +00004491 if( pCur->eState==CURSOR_VALID && pCur->validNKey
4492 && pCur->apPage[0]->intKey
4493 ){
drhe63d9992008-08-13 19:11:48 +00004494 if( pCur->info.nKey==intKey ){
drha2c20e42008-03-29 16:01:04 +00004495 *pRes = 0;
4496 return SQLITE_OK;
4497 }
drhe63d9992008-08-13 19:11:48 +00004498 if( pCur->atLast && pCur->info.nKey<intKey ){
drha2c20e42008-03-29 16:01:04 +00004499 *pRes = -1;
4500 return SQLITE_OK;
4501 }
4502 }
4503
drh5e2f8b92001-05-28 00:41:15 +00004504 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00004505 if( rc ){
4506 return rc;
4507 }
dana205a482011-08-27 18:48:57 +00004508 assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage] );
4509 assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage]->isInit );
4510 assert( pCur->eState==CURSOR_INVALID || pCur->apPage[pCur->iPage]->nCell>0 );
danielk1977da184232006-01-05 11:34:32 +00004511 if( pCur->eState==CURSOR_INVALID ){
drhf328bc82004-05-10 23:29:49 +00004512 *pRes = -1;
dana205a482011-08-27 18:48:57 +00004513 assert( pCur->pgnoRoot==0 || pCur->apPage[pCur->iPage]->nCell==0 );
drhc39e0002004-05-07 23:50:57 +00004514 return SQLITE_OK;
4515 }
danielk197771d5d2c2008-09-29 11:49:47 +00004516 assert( pCur->apPage[0]->intKey || pIdxKey );
drh14684382006-11-30 13:05:29 +00004517 for(;;){
drhafb98172011-06-04 01:43:53 +00004518 int lwr, upr, idx;
drh72f82862001-05-24 21:06:34 +00004519 Pgno chldPg;
danielk197771d5d2c2008-09-29 11:49:47 +00004520 MemPage *pPage = pCur->apPage[pCur->iPage];
danielk1977171fff32009-07-11 05:06:51 +00004521 int c;
4522
4523 /* pPage->nCell must be greater than zero. If this is the root-page
4524 ** the cursor would have been INVALID above and this for(;;) loop
4525 ** not run. If this is not the root-page, then the moveToChild() routine
danielk19773fd7cf52009-07-13 07:30:52 +00004526 ** would have already detected db corruption. Similarly, pPage must
4527 ** be the right kind (index or table) of b-tree page. Otherwise
4528 ** a moveToChild() or moveToRoot() call would have detected corruption. */
danielk1977171fff32009-07-11 05:06:51 +00004529 assert( pPage->nCell>0 );
danielk19773fd7cf52009-07-13 07:30:52 +00004530 assert( pPage->intKey==(pIdxKey==0) );
drh72f82862001-05-24 21:06:34 +00004531 lwr = 0;
4532 upr = pPage->nCell-1;
drhe4d90812007-03-29 05:51:49 +00004533 if( biasRight ){
drhafb98172011-06-04 01:43:53 +00004534 pCur->aiIdx[pCur->iPage] = (u16)(idx = upr);
drhe4d90812007-03-29 05:51:49 +00004535 }else{
drhafb98172011-06-04 01:43:53 +00004536 pCur->aiIdx[pCur->iPage] = (u16)(idx = (upr+lwr)/2);
drhe4d90812007-03-29 05:51:49 +00004537 }
drh64022502009-01-09 14:11:04 +00004538 for(;;){
danielk197711c327a2009-05-04 19:01:26 +00004539 u8 *pCell; /* Pointer to current cell in pPage */
4540
drhafb98172011-06-04 01:43:53 +00004541 assert( idx==pCur->aiIdx[pCur->iPage] );
drh366fda62006-01-13 02:35:09 +00004542 pCur->info.nSize = 0;
danielk197711c327a2009-05-04 19:01:26 +00004543 pCell = findCell(pPage, idx) + pPage->childPtrSize;
drh3aac2dd2004-04-26 14:10:20 +00004544 if( pPage->intKey ){
danielk197711c327a2009-05-04 19:01:26 +00004545 i64 nCellKey;
drhd172f862006-01-12 15:01:15 +00004546 if( pPage->hasData ){
danielk1977bab45c62006-01-16 15:14:27 +00004547 u32 dummy;
shane3f8d5cf2008-04-24 19:15:09 +00004548 pCell += getVarint32(pCell, dummy);
drhd172f862006-01-12 15:01:15 +00004549 }
drha2c20e42008-03-29 16:01:04 +00004550 getVarint(pCell, (u64*)&nCellKey);
drhe63d9992008-08-13 19:11:48 +00004551 if( nCellKey==intKey ){
drh3aac2dd2004-04-26 14:10:20 +00004552 c = 0;
drhe63d9992008-08-13 19:11:48 +00004553 }else if( nCellKey<intKey ){
drh41eb9e92008-04-02 18:33:07 +00004554 c = -1;
4555 }else{
drhe63d9992008-08-13 19:11:48 +00004556 assert( nCellKey>intKey );
drh41eb9e92008-04-02 18:33:07 +00004557 c = +1;
drh3aac2dd2004-04-26 14:10:20 +00004558 }
danielk197711c327a2009-05-04 19:01:26 +00004559 pCur->validNKey = 1;
4560 pCur->info.nKey = nCellKey;
drh3aac2dd2004-04-26 14:10:20 +00004561 }else{
drhb2eced52010-08-12 02:41:12 +00004562 /* The maximum supported page-size is 65536 bytes. This means that
danielk197711c327a2009-05-04 19:01:26 +00004563 ** the maximum number of record bytes stored on an index B-Tree
drhb2eced52010-08-12 02:41:12 +00004564 ** page is less than 16384 bytes and may be stored as a 2-byte
danielk197711c327a2009-05-04 19:01:26 +00004565 ** varint. This information is used to attempt to avoid parsing
4566 ** the entire cell by checking for the cases where the record is
4567 ** stored entirely within the b-tree page by inspecting the first
4568 ** 2 bytes of the cell.
4569 */
4570 int nCell = pCell[0];
drhc9166342012-01-05 23:32:06 +00004571 if( nCell<=pPage->max1bytePayload
4572 /* && (pCell+nCell)<pPage->aDataEnd */
drh3def2352011-11-11 00:27:15 +00004573 ){
danielk197711c327a2009-05-04 19:01:26 +00004574 /* This branch runs if the record-size field of the cell is a
4575 ** single byte varint and the record fits entirely on the main
4576 ** b-tree page. */
drh3def2352011-11-11 00:27:15 +00004577 testcase( pCell+nCell+1==pPage->aDataEnd );
danielk197711c327a2009-05-04 19:01:26 +00004578 c = sqlite3VdbeRecordCompare(nCell, (void*)&pCell[1], pIdxKey);
4579 }else if( !(pCell[1] & 0x80)
4580 && (nCell = ((nCell&0x7f)<<7) + pCell[1])<=pPage->maxLocal
drhc9166342012-01-05 23:32:06 +00004581 /* && (pCell+nCell+2)<=pPage->aDataEnd */
danielk197711c327a2009-05-04 19:01:26 +00004582 ){
4583 /* The record-size field is a 2 byte varint and the record
4584 ** fits entirely on the main b-tree page. */
drh3def2352011-11-11 00:27:15 +00004585 testcase( pCell+nCell+2==pPage->aDataEnd );
danielk197711c327a2009-05-04 19:01:26 +00004586 c = sqlite3VdbeRecordCompare(nCell, (void*)&pCell[2], pIdxKey);
drhe51c44f2004-05-30 20:46:09 +00004587 }else{
danielk197711c327a2009-05-04 19:01:26 +00004588 /* The record flows over onto one or more overflow pages. In
4589 ** this case the whole cell needs to be parsed, a buffer allocated
4590 ** and accessPayload() used to retrieve the record into the
4591 ** buffer before VdbeRecordCompare() can be called. */
4592 void *pCellKey;
4593 u8 * const pCellBody = pCell - pPage->childPtrSize;
danielk197730548662009-07-09 05:07:37 +00004594 btreeParseCellPtr(pPage, pCellBody, &pCur->info);
shane60a4b532009-05-06 18:57:09 +00004595 nCell = (int)pCur->info.nKey;
danielk197711c327a2009-05-04 19:01:26 +00004596 pCellKey = sqlite3Malloc( nCell );
danielk19776507ecb2008-03-25 09:56:44 +00004597 if( pCellKey==0 ){
4598 rc = SQLITE_NOMEM;
4599 goto moveto_finish;
4600 }
drhfb192682009-07-11 18:26:28 +00004601 rc = accessPayload(pCur, 0, nCell, (unsigned char*)pCellKey, 0);
drhec9b31f2009-08-25 13:53:49 +00004602 if( rc ){
4603 sqlite3_free(pCellKey);
4604 goto moveto_finish;
4605 }
danielk197711c327a2009-05-04 19:01:26 +00004606 c = sqlite3VdbeRecordCompare(nCell, pCellKey, pIdxKey);
drhfacf0302008-06-17 15:12:00 +00004607 sqlite3_free(pCellKey);
drhe51c44f2004-05-30 20:46:09 +00004608 }
drh3aac2dd2004-04-26 14:10:20 +00004609 }
drh72f82862001-05-24 21:06:34 +00004610 if( c==0 ){
drh44845222008-07-17 18:39:57 +00004611 if( pPage->intKey && !pPage->leaf ){
danielk197771d5d2c2008-09-29 11:49:47 +00004612 lwr = idx;
drh8b18dd42004-05-12 19:18:15 +00004613 break;
4614 }else{
drh64022502009-01-09 14:11:04 +00004615 *pRes = 0;
drh1e968a02008-03-25 00:22:21 +00004616 rc = SQLITE_OK;
4617 goto moveto_finish;
drh8b18dd42004-05-12 19:18:15 +00004618 }
drh72f82862001-05-24 21:06:34 +00004619 }
4620 if( c<0 ){
danielk197771d5d2c2008-09-29 11:49:47 +00004621 lwr = idx+1;
drh72f82862001-05-24 21:06:34 +00004622 }else{
danielk197771d5d2c2008-09-29 11:49:47 +00004623 upr = idx-1;
drh72f82862001-05-24 21:06:34 +00004624 }
drhf1d68b32007-03-29 04:43:26 +00004625 if( lwr>upr ){
4626 break;
4627 }
drhafb98172011-06-04 01:43:53 +00004628 pCur->aiIdx[pCur->iPage] = (u16)(idx = (lwr+upr)/2);
drh72f82862001-05-24 21:06:34 +00004629 }
drhb07028f2011-10-14 21:49:18 +00004630 assert( lwr==upr+1 || (pPage->intKey && !pPage->leaf) );
danielk197771d5d2c2008-09-29 11:49:47 +00004631 assert( pPage->isInit );
drh3aac2dd2004-04-26 14:10:20 +00004632 if( pPage->leaf ){
drha34b6762004-05-07 13:30:42 +00004633 chldPg = 0;
drh3aac2dd2004-04-26 14:10:20 +00004634 }else if( lwr>=pPage->nCell ){
drh43605152004-05-29 21:46:49 +00004635 chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh72f82862001-05-24 21:06:34 +00004636 }else{
danielk19771cc5ed82007-05-16 17:28:43 +00004637 chldPg = get4byte(findCell(pPage, lwr));
drh72f82862001-05-24 21:06:34 +00004638 }
4639 if( chldPg==0 ){
danielk197771d5d2c2008-09-29 11:49:47 +00004640 assert( pCur->aiIdx[pCur->iPage]<pCur->apPage[pCur->iPage]->nCell );
danielk19775cb09632009-07-09 11:36:01 +00004641 *pRes = c;
drh1e968a02008-03-25 00:22:21 +00004642 rc = SQLITE_OK;
4643 goto moveto_finish;
drh72f82862001-05-24 21:06:34 +00004644 }
drhf49661a2008-12-10 16:45:50 +00004645 pCur->aiIdx[pCur->iPage] = (u16)lwr;
drh271efa52004-05-30 19:19:05 +00004646 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004647 pCur->validNKey = 0;
drh8178a752003-01-05 21:41:40 +00004648 rc = moveToChild(pCur, chldPg);
drh1e968a02008-03-25 00:22:21 +00004649 if( rc ) goto moveto_finish;
drh72f82862001-05-24 21:06:34 +00004650 }
drh1e968a02008-03-25 00:22:21 +00004651moveto_finish:
drhe63d9992008-08-13 19:11:48 +00004652 return rc;
4653}
4654
drhd677b3d2007-08-20 22:48:41 +00004655
drh72f82862001-05-24 21:06:34 +00004656/*
drhc39e0002004-05-07 23:50:57 +00004657** Return TRUE if the cursor is not pointing at an entry of the table.
4658**
4659** TRUE will be returned after a call to sqlite3BtreeNext() moves
4660** past the last entry in the table or sqlite3BtreePrev() moves past
4661** the first entry. TRUE is also returned if the table is empty.
4662*/
4663int sqlite3BtreeEof(BtCursor *pCur){
danielk1977da184232006-01-05 11:34:32 +00004664 /* TODO: What if the cursor is in CURSOR_REQUIRESEEK but all table entries
4665 ** have been deleted? This API will need to change to return an error code
4666 ** as well as the boolean result value.
4667 */
4668 return (CURSOR_VALID!=pCur->eState);
drhc39e0002004-05-07 23:50:57 +00004669}
4670
4671/*
drhbd03cae2001-06-02 02:40:57 +00004672** Advance the cursor to the next entry in the database. If
drh8c1238a2003-01-02 14:43:55 +00004673** successful then set *pRes=0. If the cursor
drhbd03cae2001-06-02 02:40:57 +00004674** was already pointing to the last entry in the database before
drh8c1238a2003-01-02 14:43:55 +00004675** this routine was called, then set *pRes=1.
drh72f82862001-05-24 21:06:34 +00004676*/
drhd094db12008-04-03 21:46:57 +00004677int sqlite3BtreeNext(BtCursor *pCur, int *pRes){
drh72f82862001-05-24 21:06:34 +00004678 int rc;
danielk197771d5d2c2008-09-29 11:49:47 +00004679 int idx;
danielk197797a227c2006-01-20 16:32:04 +00004680 MemPage *pPage;
drh8b18dd42004-05-12 19:18:15 +00004681
drh1fee73e2007-08-29 04:00:57 +00004682 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00004683 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00004684 if( rc!=SQLITE_OK ){
4685 return rc;
4686 }
drh8c4d3a62007-04-06 01:03:32 +00004687 assert( pRes!=0 );
drh8c4d3a62007-04-06 01:03:32 +00004688 if( CURSOR_INVALID==pCur->eState ){
4689 *pRes = 1;
4690 return SQLITE_OK;
4691 }
drh4c301aa2009-07-15 17:25:45 +00004692 if( pCur->skipNext>0 ){
4693 pCur->skipNext = 0;
danielk1977da184232006-01-05 11:34:32 +00004694 *pRes = 0;
4695 return SQLITE_OK;
4696 }
drh4c301aa2009-07-15 17:25:45 +00004697 pCur->skipNext = 0;
danielk1977da184232006-01-05 11:34:32 +00004698
danielk197771d5d2c2008-09-29 11:49:47 +00004699 pPage = pCur->apPage[pCur->iPage];
4700 idx = ++pCur->aiIdx[pCur->iPage];
4701 assert( pPage->isInit );
danbb246c42012-01-12 14:25:55 +00004702
4703 /* If the database file is corrupt, it is possible for the value of idx
4704 ** to be invalid here. This can only occur if a second cursor modifies
4705 ** the page while cursor pCur is holding a reference to it. Which can
4706 ** only happen if the database is corrupt in such a way as to link the
4707 ** page into more than one b-tree structure. */
4708 testcase( idx>pPage->nCell );
danielk19776a43f9b2004-11-16 04:57:24 +00004709
drh271efa52004-05-30 19:19:05 +00004710 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004711 pCur->validNKey = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00004712 if( idx>=pPage->nCell ){
drha34b6762004-05-07 13:30:42 +00004713 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00004714 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
drh5e2f8b92001-05-28 00:41:15 +00004715 if( rc ) return rc;
4716 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00004717 *pRes = 0;
4718 return rc;
drh72f82862001-05-24 21:06:34 +00004719 }
drh5e2f8b92001-05-28 00:41:15 +00004720 do{
danielk197771d5d2c2008-09-29 11:49:47 +00004721 if( pCur->iPage==0 ){
drh8c1238a2003-01-02 14:43:55 +00004722 *pRes = 1;
danielk1977da184232006-01-05 11:34:32 +00004723 pCur->eState = CURSOR_INVALID;
drh5e2f8b92001-05-28 00:41:15 +00004724 return SQLITE_OK;
4725 }
danielk197730548662009-07-09 05:07:37 +00004726 moveToParent(pCur);
danielk197771d5d2c2008-09-29 11:49:47 +00004727 pPage = pCur->apPage[pCur->iPage];
4728 }while( pCur->aiIdx[pCur->iPage]>=pPage->nCell );
drh8c1238a2003-01-02 14:43:55 +00004729 *pRes = 0;
drh44845222008-07-17 18:39:57 +00004730 if( pPage->intKey ){
drh8b18dd42004-05-12 19:18:15 +00004731 rc = sqlite3BtreeNext(pCur, pRes);
4732 }else{
4733 rc = SQLITE_OK;
4734 }
4735 return rc;
drh8178a752003-01-05 21:41:40 +00004736 }
4737 *pRes = 0;
drh3aac2dd2004-04-26 14:10:20 +00004738 if( pPage->leaf ){
drh8178a752003-01-05 21:41:40 +00004739 return SQLITE_OK;
drh72f82862001-05-24 21:06:34 +00004740 }
drh5e2f8b92001-05-28 00:41:15 +00004741 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00004742 return rc;
drh72f82862001-05-24 21:06:34 +00004743}
drhd677b3d2007-08-20 22:48:41 +00004744
drh72f82862001-05-24 21:06:34 +00004745
drh3b7511c2001-05-26 13:15:44 +00004746/*
drh2dcc9aa2002-12-04 13:40:25 +00004747** Step the cursor to the back to the previous entry in the database. If
drh8178a752003-01-05 21:41:40 +00004748** successful then set *pRes=0. If the cursor
drh2dcc9aa2002-12-04 13:40:25 +00004749** was already pointing to the first entry in the database before
drh8178a752003-01-05 21:41:40 +00004750** this routine was called, then set *pRes=1.
drh2dcc9aa2002-12-04 13:40:25 +00004751*/
drhd094db12008-04-03 21:46:57 +00004752int sqlite3BtreePrevious(BtCursor *pCur, int *pRes){
drh2dcc9aa2002-12-04 13:40:25 +00004753 int rc;
drh8178a752003-01-05 21:41:40 +00004754 MemPage *pPage;
danielk1977da184232006-01-05 11:34:32 +00004755
drh1fee73e2007-08-29 04:00:57 +00004756 assert( cursorHoldsMutex(pCur) );
drha3460582008-07-11 21:02:53 +00004757 rc = restoreCursorPosition(pCur);
danielk1977da184232006-01-05 11:34:32 +00004758 if( rc!=SQLITE_OK ){
4759 return rc;
4760 }
drha2c20e42008-03-29 16:01:04 +00004761 pCur->atLast = 0;
drh8c4d3a62007-04-06 01:03:32 +00004762 if( CURSOR_INVALID==pCur->eState ){
4763 *pRes = 1;
4764 return SQLITE_OK;
4765 }
drh4c301aa2009-07-15 17:25:45 +00004766 if( pCur->skipNext<0 ){
4767 pCur->skipNext = 0;
danielk1977da184232006-01-05 11:34:32 +00004768 *pRes = 0;
4769 return SQLITE_OK;
4770 }
drh4c301aa2009-07-15 17:25:45 +00004771 pCur->skipNext = 0;
danielk1977da184232006-01-05 11:34:32 +00004772
danielk197771d5d2c2008-09-29 11:49:47 +00004773 pPage = pCur->apPage[pCur->iPage];
4774 assert( pPage->isInit );
drha34b6762004-05-07 13:30:42 +00004775 if( !pPage->leaf ){
danielk197771d5d2c2008-09-29 11:49:47 +00004776 int idx = pCur->aiIdx[pCur->iPage];
4777 rc = moveToChild(pCur, get4byte(findCell(pPage, idx)));
drhd677b3d2007-08-20 22:48:41 +00004778 if( rc ){
4779 return rc;
4780 }
drh2dcc9aa2002-12-04 13:40:25 +00004781 rc = moveToRightmost(pCur);
4782 }else{
danielk197771d5d2c2008-09-29 11:49:47 +00004783 while( pCur->aiIdx[pCur->iPage]==0 ){
4784 if( pCur->iPage==0 ){
danielk1977da184232006-01-05 11:34:32 +00004785 pCur->eState = CURSOR_INVALID;
drhc39e0002004-05-07 23:50:57 +00004786 *pRes = 1;
drh2dcc9aa2002-12-04 13:40:25 +00004787 return SQLITE_OK;
4788 }
danielk197730548662009-07-09 05:07:37 +00004789 moveToParent(pCur);
drh2dcc9aa2002-12-04 13:40:25 +00004790 }
drh271efa52004-05-30 19:19:05 +00004791 pCur->info.nSize = 0;
drha2c20e42008-03-29 16:01:04 +00004792 pCur->validNKey = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00004793
4794 pCur->aiIdx[pCur->iPage]--;
4795 pPage = pCur->apPage[pCur->iPage];
drh44845222008-07-17 18:39:57 +00004796 if( pPage->intKey && !pPage->leaf ){
drh8b18dd42004-05-12 19:18:15 +00004797 rc = sqlite3BtreePrevious(pCur, pRes);
4798 }else{
4799 rc = SQLITE_OK;
4800 }
drh2dcc9aa2002-12-04 13:40:25 +00004801 }
drh8178a752003-01-05 21:41:40 +00004802 *pRes = 0;
drh2dcc9aa2002-12-04 13:40:25 +00004803 return rc;
4804}
4805
4806/*
drh3b7511c2001-05-26 13:15:44 +00004807** Allocate a new page from the database file.
4808**
danielk19773b8a05f2007-03-19 17:44:26 +00004809** The new page is marked as dirty. (In other words, sqlite3PagerWrite()
drh3b7511c2001-05-26 13:15:44 +00004810** has already been called on the new page.) The new page has also
4811** been referenced and the calling routine is responsible for calling
danielk19773b8a05f2007-03-19 17:44:26 +00004812** sqlite3PagerUnref() on the new page when it is done.
drh3b7511c2001-05-26 13:15:44 +00004813**
4814** SQLITE_OK is returned on success. Any other return value indicates
4815** an error. *ppPage and *pPgno are undefined in the event of an error.
danielk19773b8a05f2007-03-19 17:44:26 +00004816** Do not invoke sqlite3PagerUnref() on *ppPage if an error is returned.
drhbea00b92002-07-08 10:59:50 +00004817**
drh199e3cf2002-07-18 11:01:47 +00004818** If the "nearby" parameter is not 0, then a (feeble) effort is made to
4819** locate a page close to the page number "nearby". This can be used in an
drhbea00b92002-07-08 10:59:50 +00004820** attempt to keep related pages close to each other in the database file,
4821** which in turn can make database access faster.
danielk1977cb1a7eb2004-11-05 12:27:02 +00004822**
4823** If the "exact" parameter is not 0, and the page-number nearby exists
4824** anywhere on the free-list, then it is guarenteed to be returned. This
4825** is only used by auto-vacuum databases when allocating a new table.
drh3b7511c2001-05-26 13:15:44 +00004826*/
drh4f0c5872007-03-26 22:05:01 +00004827static int allocateBtreePage(
danielk1977aef0bf62005-12-30 16:28:01 +00004828 BtShared *pBt,
danielk1977cb1a7eb2004-11-05 12:27:02 +00004829 MemPage **ppPage,
4830 Pgno *pPgno,
4831 Pgno nearby,
4832 u8 exact
4833){
drh3aac2dd2004-04-26 14:10:20 +00004834 MemPage *pPage1;
drh8c42ca92001-06-22 19:15:00 +00004835 int rc;
drh35cd6432009-06-05 14:17:21 +00004836 u32 n; /* Number of pages on the freelist */
drh042d6a12009-06-17 13:57:16 +00004837 u32 k; /* Number of leaves on the trunk of the freelist */
drhd3627af2006-12-18 18:34:51 +00004838 MemPage *pTrunk = 0;
4839 MemPage *pPrevTrunk = 0;
drh1662b5a2009-06-04 19:06:09 +00004840 Pgno mxPage; /* Total size of the database file */
drh30e58752002-03-02 20:41:57 +00004841
drh1fee73e2007-08-29 04:00:57 +00004842 assert( sqlite3_mutex_held(pBt->mutex) );
drh3aac2dd2004-04-26 14:10:20 +00004843 pPage1 = pBt->pPage1;
drhb1299152010-03-30 22:58:33 +00004844 mxPage = btreePagecount(pBt);
drh3aac2dd2004-04-26 14:10:20 +00004845 n = get4byte(&pPage1->aData[36]);
drhdf35a082009-07-09 02:24:35 +00004846 testcase( n==mxPage-1 );
4847 if( n>=mxPage ){
drh1662b5a2009-06-04 19:06:09 +00004848 return SQLITE_CORRUPT_BKPT;
4849 }
drh3aac2dd2004-04-26 14:10:20 +00004850 if( n>0 ){
drh91025292004-05-03 19:49:32 +00004851 /* There are pages on the freelist. Reuse one of those pages. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00004852 Pgno iTrunk;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004853 u8 searchList = 0; /* If the free-list must be searched for 'nearby' */
4854
4855 /* If the 'exact' parameter was true and a query of the pointer-map
4856 ** shows that the page 'nearby' is somewhere on the free-list, then
4857 ** the entire-list will be searched for that page.
4858 */
4859#ifndef SQLITE_OMIT_AUTOVACUUM
drh1662b5a2009-06-04 19:06:09 +00004860 if( exact && nearby<=mxPage ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004861 u8 eType;
4862 assert( nearby>0 );
4863 assert( pBt->autoVacuum );
4864 rc = ptrmapGet(pBt, nearby, &eType, 0);
4865 if( rc ) return rc;
4866 if( eType==PTRMAP_FREEPAGE ){
4867 searchList = 1;
4868 }
4869 *pPgno = nearby;
4870 }
4871#endif
4872
4873 /* Decrement the free-list count by 1. Set iTrunk to the index of the
4874 ** first free-list trunk page. iPrevTrunk is initially 1.
4875 */
danielk19773b8a05f2007-03-19 17:44:26 +00004876 rc = sqlite3PagerWrite(pPage1->pDbPage);
drh3b7511c2001-05-26 13:15:44 +00004877 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00004878 put4byte(&pPage1->aData[36], n-1);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004879
4880 /* The code within this loop is run only once if the 'searchList' variable
4881 ** is not true. Otherwise, it runs once for each trunk-page on the
4882 ** free-list until the page 'nearby' is located.
4883 */
4884 do {
4885 pPrevTrunk = pTrunk;
4886 if( pPrevTrunk ){
4887 iTrunk = get4byte(&pPrevTrunk->aData[0]);
drhbea00b92002-07-08 10:59:50 +00004888 }else{
danielk1977cb1a7eb2004-11-05 12:27:02 +00004889 iTrunk = get4byte(&pPage1->aData[32]);
drhbea00b92002-07-08 10:59:50 +00004890 }
drhdf35a082009-07-09 02:24:35 +00004891 testcase( iTrunk==mxPage );
drh1662b5a2009-06-04 19:06:09 +00004892 if( iTrunk>mxPage ){
4893 rc = SQLITE_CORRUPT_BKPT;
4894 }else{
danielk197730548662009-07-09 05:07:37 +00004895 rc = btreeGetPage(pBt, iTrunk, &pTrunk, 0);
drh1662b5a2009-06-04 19:06:09 +00004896 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004897 if( rc ){
drhd3627af2006-12-18 18:34:51 +00004898 pTrunk = 0;
4899 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004900 }
drhb07028f2011-10-14 21:49:18 +00004901 assert( pTrunk!=0 );
4902 assert( pTrunk->aData!=0 );
danielk1977cb1a7eb2004-11-05 12:27:02 +00004903
drh93b4fc72011-04-07 14:47:01 +00004904 k = get4byte(&pTrunk->aData[4]); /* # of leaves on this trunk page */
danielk1977cb1a7eb2004-11-05 12:27:02 +00004905 if( k==0 && !searchList ){
4906 /* The trunk has no leaves and the list is not being searched.
4907 ** So extract the trunk page itself and use it as the newly
4908 ** allocated page */
4909 assert( pPrevTrunk==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00004910 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004911 if( rc ){
4912 goto end_allocate_page;
4913 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004914 *pPgno = iTrunk;
4915 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
4916 *ppPage = pTrunk;
4917 pTrunk = 0;
4918 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
drh042d6a12009-06-17 13:57:16 +00004919 }else if( k>(u32)(pBt->usableSize/4 - 2) ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004920 /* Value of k is out of range. Database corruption */
drhd3627af2006-12-18 18:34:51 +00004921 rc = SQLITE_CORRUPT_BKPT;
4922 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004923#ifndef SQLITE_OMIT_AUTOVACUUM
4924 }else if( searchList && nearby==iTrunk ){
4925 /* The list is being searched and this trunk page is the page
4926 ** to allocate, regardless of whether it has leaves.
4927 */
4928 assert( *pPgno==iTrunk );
4929 *ppPage = pTrunk;
4930 searchList = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00004931 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004932 if( rc ){
4933 goto end_allocate_page;
4934 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004935 if( k==0 ){
4936 if( !pPrevTrunk ){
4937 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
4938 }else{
danf48c3552010-08-23 15:41:24 +00004939 rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
4940 if( rc!=SQLITE_OK ){
4941 goto end_allocate_page;
4942 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004943 memcpy(&pPrevTrunk->aData[0], &pTrunk->aData[0], 4);
4944 }
4945 }else{
4946 /* The trunk page is required by the caller but it contains
4947 ** pointers to free-list leaves. The first leaf becomes a trunk
4948 ** page in this case.
4949 */
4950 MemPage *pNewTrunk;
4951 Pgno iNewTrunk = get4byte(&pTrunk->aData[8]);
drh1662b5a2009-06-04 19:06:09 +00004952 if( iNewTrunk>mxPage ){
4953 rc = SQLITE_CORRUPT_BKPT;
4954 goto end_allocate_page;
4955 }
drhdf35a082009-07-09 02:24:35 +00004956 testcase( iNewTrunk==mxPage );
danielk197730548662009-07-09 05:07:37 +00004957 rc = btreeGetPage(pBt, iNewTrunk, &pNewTrunk, 0);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004958 if( rc!=SQLITE_OK ){
drhd3627af2006-12-18 18:34:51 +00004959 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004960 }
danielk19773b8a05f2007-03-19 17:44:26 +00004961 rc = sqlite3PagerWrite(pNewTrunk->pDbPage);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004962 if( rc!=SQLITE_OK ){
4963 releasePage(pNewTrunk);
drhd3627af2006-12-18 18:34:51 +00004964 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004965 }
4966 memcpy(&pNewTrunk->aData[0], &pTrunk->aData[0], 4);
4967 put4byte(&pNewTrunk->aData[4], k-1);
4968 memcpy(&pNewTrunk->aData[8], &pTrunk->aData[12], (k-1)*4);
drhd3627af2006-12-18 18:34:51 +00004969 releasePage(pNewTrunk);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004970 if( !pPrevTrunk ){
drhc5053fb2008-11-27 02:22:10 +00004971 assert( sqlite3PagerIswriteable(pPage1->pDbPage) );
danielk1977cb1a7eb2004-11-05 12:27:02 +00004972 put4byte(&pPage1->aData[32], iNewTrunk);
4973 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004974 rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00004975 if( rc ){
4976 goto end_allocate_page;
4977 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004978 put4byte(&pPrevTrunk->aData[0], iNewTrunk);
4979 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00004980 }
4981 pTrunk = 0;
4982 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
4983#endif
danielk1977e5765212009-06-17 11:13:28 +00004984 }else if( k>0 ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00004985 /* Extract a leaf from the trunk */
drh042d6a12009-06-17 13:57:16 +00004986 u32 closest;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004987 Pgno iPage;
4988 unsigned char *aData = pTrunk->aData;
4989 if( nearby>0 ){
drh042d6a12009-06-17 13:57:16 +00004990 u32 i;
4991 int dist;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004992 closest = 0;
drhd50ffc42011-03-08 02:38:28 +00004993 dist = sqlite3AbsInt32(get4byte(&aData[8]) - nearby);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004994 for(i=1; i<k; i++){
drhd50ffc42011-03-08 02:38:28 +00004995 int d2 = sqlite3AbsInt32(get4byte(&aData[8+i*4]) - nearby);
danielk1977cb1a7eb2004-11-05 12:27:02 +00004996 if( d2<dist ){
4997 closest = i;
4998 dist = d2;
4999 }
5000 }
5001 }else{
5002 closest = 0;
5003 }
5004
5005 iPage = get4byte(&aData[8+closest*4]);
drhdf35a082009-07-09 02:24:35 +00005006 testcase( iPage==mxPage );
drh1662b5a2009-06-04 19:06:09 +00005007 if( iPage>mxPage ){
5008 rc = SQLITE_CORRUPT_BKPT;
5009 goto end_allocate_page;
5010 }
drhdf35a082009-07-09 02:24:35 +00005011 testcase( iPage==mxPage );
danielk1977cb1a7eb2004-11-05 12:27:02 +00005012 if( !searchList || iPage==nearby ){
danielk1977bea2a942009-01-20 17:06:27 +00005013 int noContent;
shane1f9e6aa2008-06-09 19:27:11 +00005014 *pPgno = iPage;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005015 TRACE(("ALLOCATE: %d was leaf %d of %d on trunk %d"
5016 ": %d more free pages\n",
5017 *pPgno, closest+1, k, pTrunk->pgno, n-1));
drh93b4fc72011-04-07 14:47:01 +00005018 rc = sqlite3PagerWrite(pTrunk->pDbPage);
5019 if( rc ) goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005020 if( closest<k-1 ){
5021 memcpy(&aData[8+closest*4], &aData[4+k*4], 4);
5022 }
5023 put4byte(&aData[4], k-1);
danielk1977bea2a942009-01-20 17:06:27 +00005024 noContent = !btreeGetHasContent(pBt, *pPgno);
danielk197730548662009-07-09 05:07:37 +00005025 rc = btreeGetPage(pBt, *pPgno, ppPage, noContent);
danielk1977cb1a7eb2004-11-05 12:27:02 +00005026 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00005027 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00005028 if( rc!=SQLITE_OK ){
5029 releasePage(*ppPage);
5030 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00005031 }
5032 searchList = 0;
5033 }
drhee696e22004-08-30 16:52:17 +00005034 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00005035 releasePage(pPrevTrunk);
drhd3627af2006-12-18 18:34:51 +00005036 pPrevTrunk = 0;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005037 }while( searchList );
drh3b7511c2001-05-26 13:15:44 +00005038 }else{
drh3aac2dd2004-04-26 14:10:20 +00005039 /* There are no pages on the freelist, so create a new page at the
5040 ** end of the file */
drhdd3cd972010-03-27 17:12:36 +00005041 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
5042 if( rc ) return rc;
5043 pBt->nPage++;
5044 if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ) pBt->nPage++;
danielk1977bea2a942009-01-20 17:06:27 +00005045
danielk1977afcdd022004-10-31 16:25:42 +00005046#ifndef SQLITE_OMIT_AUTOVACUUM
drhdd3cd972010-03-27 17:12:36 +00005047 if( pBt->autoVacuum && PTRMAP_ISPAGE(pBt, pBt->nPage) ){
danielk1977afcdd022004-10-31 16:25:42 +00005048 /* If *pPgno refers to a pointer-map page, allocate two new pages
5049 ** at the end of the file instead of one. The first allocated page
5050 ** becomes a new pointer-map page, the second is used by the caller.
5051 */
danielk1977ac861692009-03-28 10:54:22 +00005052 MemPage *pPg = 0;
drhdd3cd972010-03-27 17:12:36 +00005053 TRACE(("ALLOCATE: %d from end of file (pointer-map page)\n", pBt->nPage));
5054 assert( pBt->nPage!=PENDING_BYTE_PAGE(pBt) );
drh5e0ccc22010-03-29 19:36:52 +00005055 rc = btreeGetPage(pBt, pBt->nPage, &pPg, 1);
danielk1977ac861692009-03-28 10:54:22 +00005056 if( rc==SQLITE_OK ){
5057 rc = sqlite3PagerWrite(pPg->pDbPage);
5058 releasePage(pPg);
5059 }
5060 if( rc ) return rc;
drhdd3cd972010-03-27 17:12:36 +00005061 pBt->nPage++;
5062 if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ){ pBt->nPage++; }
danielk1977afcdd022004-10-31 16:25:42 +00005063 }
5064#endif
drhdd3cd972010-03-27 17:12:36 +00005065 put4byte(28 + (u8*)pBt->pPage1->aData, pBt->nPage);
5066 *pPgno = pBt->nPage;
danielk1977afcdd022004-10-31 16:25:42 +00005067
danielk1977599fcba2004-11-08 07:13:13 +00005068 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drh5e0ccc22010-03-29 19:36:52 +00005069 rc = btreeGetPage(pBt, *pPgno, ppPage, 1);
drh3b7511c2001-05-26 13:15:44 +00005070 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005071 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00005072 if( rc!=SQLITE_OK ){
5073 releasePage(*ppPage);
5074 }
drh3a4c1412004-05-09 20:40:11 +00005075 TRACE(("ALLOCATE: %d from end of file\n", *pPgno));
drh3b7511c2001-05-26 13:15:44 +00005076 }
danielk1977599fcba2004-11-08 07:13:13 +00005077
5078 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drhd3627af2006-12-18 18:34:51 +00005079
5080end_allocate_page:
5081 releasePage(pTrunk);
5082 releasePage(pPrevTrunk);
danielk1977b247c212008-11-21 09:09:01 +00005083 if( rc==SQLITE_OK ){
5084 if( sqlite3PagerPageRefcount((*ppPage)->pDbPage)>1 ){
5085 releasePage(*ppPage);
5086 return SQLITE_CORRUPT_BKPT;
5087 }
5088 (*ppPage)->isInit = 0;
danielk1977a50d9aa2009-06-08 14:49:45 +00005089 }else{
5090 *ppPage = 0;
danielk1977eaa06f62008-09-18 17:34:44 +00005091 }
drh93b4fc72011-04-07 14:47:01 +00005092 assert( rc!=SQLITE_OK || sqlite3PagerIswriteable((*ppPage)->pDbPage) );
drh3b7511c2001-05-26 13:15:44 +00005093 return rc;
5094}
5095
5096/*
danielk1977bea2a942009-01-20 17:06:27 +00005097** This function is used to add page iPage to the database file free-list.
5098** It is assumed that the page is not already a part of the free-list.
drh5e2f8b92001-05-28 00:41:15 +00005099**
danielk1977bea2a942009-01-20 17:06:27 +00005100** The value passed as the second argument to this function is optional.
5101** If the caller happens to have a pointer to the MemPage object
5102** corresponding to page iPage handy, it may pass it as the second value.
5103** Otherwise, it may pass NULL.
5104**
5105** If a pointer to a MemPage object is passed as the second argument,
5106** its reference count is not altered by this function.
drh3b7511c2001-05-26 13:15:44 +00005107*/
danielk1977bea2a942009-01-20 17:06:27 +00005108static int freePage2(BtShared *pBt, MemPage *pMemPage, Pgno iPage){
5109 MemPage *pTrunk = 0; /* Free-list trunk page */
5110 Pgno iTrunk = 0; /* Page number of free-list trunk page */
5111 MemPage *pPage1 = pBt->pPage1; /* Local reference to page 1 */
5112 MemPage *pPage; /* Page being freed. May be NULL. */
5113 int rc; /* Return Code */
5114 int nFree; /* Initial number of pages on free-list */
drh8b2f49b2001-06-08 00:21:52 +00005115
danielk1977bea2a942009-01-20 17:06:27 +00005116 assert( sqlite3_mutex_held(pBt->mutex) );
5117 assert( iPage>1 );
5118 assert( !pMemPage || pMemPage->pgno==iPage );
5119
5120 if( pMemPage ){
5121 pPage = pMemPage;
5122 sqlite3PagerRef(pPage->pDbPage);
5123 }else{
5124 pPage = btreePageLookup(pBt, iPage);
5125 }
drh3aac2dd2004-04-26 14:10:20 +00005126
drha34b6762004-05-07 13:30:42 +00005127 /* Increment the free page count on pPage1 */
danielk19773b8a05f2007-03-19 17:44:26 +00005128 rc = sqlite3PagerWrite(pPage1->pDbPage);
danielk1977bea2a942009-01-20 17:06:27 +00005129 if( rc ) goto freepage_out;
5130 nFree = get4byte(&pPage1->aData[36]);
5131 put4byte(&pPage1->aData[36], nFree+1);
drh3aac2dd2004-04-26 14:10:20 +00005132
drhc9166342012-01-05 23:32:06 +00005133 if( pBt->btsFlags & BTS_SECURE_DELETE ){
drh5b47efa2010-02-12 18:18:39 +00005134 /* If the secure_delete option is enabled, then
5135 ** always fully overwrite deleted information with zeros.
5136 */
shaneh84f4b2f2010-02-26 01:46:54 +00005137 if( (!pPage && ((rc = btreeGetPage(pBt, iPage, &pPage, 0))!=0) )
5138 || ((rc = sqlite3PagerWrite(pPage->pDbPage))!=0)
drh5b47efa2010-02-12 18:18:39 +00005139 ){
5140 goto freepage_out;
5141 }
5142 memset(pPage->aData, 0, pPage->pBt->pageSize);
danielk1977bea2a942009-01-20 17:06:27 +00005143 }
drhfcce93f2006-02-22 03:08:32 +00005144
danielk1977687566d2004-11-02 12:56:41 +00005145 /* If the database supports auto-vacuum, write an entry in the pointer-map
danielk1977cb1a7eb2004-11-05 12:27:02 +00005146 ** to indicate that the page is free.
danielk1977687566d2004-11-02 12:56:41 +00005147 */
danielk197785d90ca2008-07-19 14:25:15 +00005148 if( ISAUTOVACUUM ){
drh98add2e2009-07-20 17:11:49 +00005149 ptrmapPut(pBt, iPage, PTRMAP_FREEPAGE, 0, &rc);
danielk1977bea2a942009-01-20 17:06:27 +00005150 if( rc ) goto freepage_out;
danielk1977687566d2004-11-02 12:56:41 +00005151 }
danielk1977687566d2004-11-02 12:56:41 +00005152
danielk1977bea2a942009-01-20 17:06:27 +00005153 /* Now manipulate the actual database free-list structure. There are two
5154 ** possibilities. If the free-list is currently empty, or if the first
5155 ** trunk page in the free-list is full, then this page will become a
5156 ** new free-list trunk page. Otherwise, it will become a leaf of the
5157 ** first trunk page in the current free-list. This block tests if it
5158 ** is possible to add the page as a new free-list leaf.
5159 */
5160 if( nFree!=0 ){
drhc046e3e2009-07-15 11:26:44 +00005161 u32 nLeaf; /* Initial number of leaf cells on trunk page */
danielk1977bea2a942009-01-20 17:06:27 +00005162
5163 iTrunk = get4byte(&pPage1->aData[32]);
danielk197730548662009-07-09 05:07:37 +00005164 rc = btreeGetPage(pBt, iTrunk, &pTrunk, 0);
danielk1977bea2a942009-01-20 17:06:27 +00005165 if( rc!=SQLITE_OK ){
5166 goto freepage_out;
5167 }
5168
5169 nLeaf = get4byte(&pTrunk->aData[4]);
drheeb844a2009-08-08 18:01:07 +00005170 assert( pBt->usableSize>32 );
5171 if( nLeaf > (u32)pBt->usableSize/4 - 2 ){
danielk1977bea2a942009-01-20 17:06:27 +00005172 rc = SQLITE_CORRUPT_BKPT;
5173 goto freepage_out;
5174 }
drheeb844a2009-08-08 18:01:07 +00005175 if( nLeaf < (u32)pBt->usableSize/4 - 8 ){
danielk1977bea2a942009-01-20 17:06:27 +00005176 /* In this case there is room on the trunk page to insert the page
5177 ** being freed as a new leaf.
drh45b1fac2008-07-04 17:52:42 +00005178 **
5179 ** Note that the trunk page is not really full until it contains
5180 ** usableSize/4 - 2 entries, not usableSize/4 - 8 entries as we have
5181 ** coded. But due to a coding error in versions of SQLite prior to
5182 ** 3.6.0, databases with freelist trunk pages holding more than
5183 ** usableSize/4 - 8 entries will be reported as corrupt. In order
5184 ** to maintain backwards compatibility with older versions of SQLite,
drhc046e3e2009-07-15 11:26:44 +00005185 ** we will continue to restrict the number of entries to usableSize/4 - 8
drh45b1fac2008-07-04 17:52:42 +00005186 ** for now. At some point in the future (once everyone has upgraded
5187 ** to 3.6.0 or later) we should consider fixing the conditional above
5188 ** to read "usableSize/4-2" instead of "usableSize/4-8".
5189 */
danielk19773b8a05f2007-03-19 17:44:26 +00005190 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhf5345442007-04-09 12:45:02 +00005191 if( rc==SQLITE_OK ){
danielk1977bea2a942009-01-20 17:06:27 +00005192 put4byte(&pTrunk->aData[4], nLeaf+1);
5193 put4byte(&pTrunk->aData[8+nLeaf*4], iPage);
drhc9166342012-01-05 23:32:06 +00005194 if( pPage && (pBt->btsFlags & BTS_SECURE_DELETE)==0 ){
danielk1977bea2a942009-01-20 17:06:27 +00005195 sqlite3PagerDontWrite(pPage->pDbPage);
5196 }
danielk1977bea2a942009-01-20 17:06:27 +00005197 rc = btreeSetHasContent(pBt, iPage);
drhf5345442007-04-09 12:45:02 +00005198 }
drh3a4c1412004-05-09 20:40:11 +00005199 TRACE(("FREE-PAGE: %d leaf on trunk page %d\n",pPage->pgno,pTrunk->pgno));
danielk1977bea2a942009-01-20 17:06:27 +00005200 goto freepage_out;
drh3aac2dd2004-04-26 14:10:20 +00005201 }
drh3b7511c2001-05-26 13:15:44 +00005202 }
danielk1977bea2a942009-01-20 17:06:27 +00005203
5204 /* If control flows to this point, then it was not possible to add the
5205 ** the page being freed as a leaf page of the first trunk in the free-list.
5206 ** Possibly because the free-list is empty, or possibly because the
5207 ** first trunk in the free-list is full. Either way, the page being freed
5208 ** will become the new first trunk page in the free-list.
5209 */
drhc046e3e2009-07-15 11:26:44 +00005210 if( pPage==0 && SQLITE_OK!=(rc = btreeGetPage(pBt, iPage, &pPage, 0)) ){
5211 goto freepage_out;
5212 }
5213 rc = sqlite3PagerWrite(pPage->pDbPage);
5214 if( rc!=SQLITE_OK ){
danielk1977bea2a942009-01-20 17:06:27 +00005215 goto freepage_out;
5216 }
5217 put4byte(pPage->aData, iTrunk);
5218 put4byte(&pPage->aData[4], 0);
5219 put4byte(&pPage1->aData[32], iPage);
5220 TRACE(("FREE-PAGE: %d new trunk page replacing %d\n", pPage->pgno, iTrunk));
5221
5222freepage_out:
5223 if( pPage ){
5224 pPage->isInit = 0;
5225 }
5226 releasePage(pPage);
5227 releasePage(pTrunk);
drh3b7511c2001-05-26 13:15:44 +00005228 return rc;
5229}
drhc314dc72009-07-21 11:52:34 +00005230static void freePage(MemPage *pPage, int *pRC){
5231 if( (*pRC)==SQLITE_OK ){
5232 *pRC = freePage2(pPage->pBt, pPage, pPage->pgno);
5233 }
danielk1977bea2a942009-01-20 17:06:27 +00005234}
drh3b7511c2001-05-26 13:15:44 +00005235
5236/*
drh3aac2dd2004-04-26 14:10:20 +00005237** Free any overflow pages associated with the given Cell.
drh3b7511c2001-05-26 13:15:44 +00005238*/
drh3aac2dd2004-04-26 14:10:20 +00005239static int clearCell(MemPage *pPage, unsigned char *pCell){
danielk1977aef0bf62005-12-30 16:28:01 +00005240 BtShared *pBt = pPage->pBt;
drh6f11bef2004-05-13 01:12:56 +00005241 CellInfo info;
drh3aac2dd2004-04-26 14:10:20 +00005242 Pgno ovflPgno;
drh6f11bef2004-05-13 01:12:56 +00005243 int rc;
drh94440812007-03-06 11:42:19 +00005244 int nOvfl;
shaneh1df2db72010-08-18 02:28:48 +00005245 u32 ovflPageSize;
drh3b7511c2001-05-26 13:15:44 +00005246
drh1fee73e2007-08-29 04:00:57 +00005247 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk197730548662009-07-09 05:07:37 +00005248 btreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00005249 if( info.iOverflow==0 ){
drha34b6762004-05-07 13:30:42 +00005250 return SQLITE_OK; /* No overflow pages. Return without doing anything */
drh3aac2dd2004-04-26 14:10:20 +00005251 }
drhe42a9b42011-08-31 13:27:19 +00005252 if( pCell+info.iOverflow+3 > pPage->aData+pPage->maskPage ){
5253 return SQLITE_CORRUPT; /* Cell extends past end of page */
5254 }
drh6f11bef2004-05-13 01:12:56 +00005255 ovflPgno = get4byte(&pCell[info.iOverflow]);
shane63207ab2009-02-04 01:49:30 +00005256 assert( pBt->usableSize > 4 );
drh94440812007-03-06 11:42:19 +00005257 ovflPageSize = pBt->usableSize - 4;
drh72365832007-03-06 15:53:44 +00005258 nOvfl = (info.nPayload - info.nLocal + ovflPageSize - 1)/ovflPageSize;
5259 assert( ovflPgno==0 || nOvfl>0 );
5260 while( nOvfl-- ){
shane63207ab2009-02-04 01:49:30 +00005261 Pgno iNext = 0;
danielk1977bea2a942009-01-20 17:06:27 +00005262 MemPage *pOvfl = 0;
drhb1299152010-03-30 22:58:33 +00005263 if( ovflPgno<2 || ovflPgno>btreePagecount(pBt) ){
danielk1977e589a672009-04-11 16:06:15 +00005264 /* 0 is not a legal page number and page 1 cannot be an
5265 ** overflow page. Therefore if ovflPgno<2 or past the end of the
5266 ** file the database must be corrupt. */
drh49285702005-09-17 15:20:26 +00005267 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00005268 }
danielk1977bea2a942009-01-20 17:06:27 +00005269 if( nOvfl ){
5270 rc = getOverflowPage(pBt, ovflPgno, &pOvfl, &iNext);
5271 if( rc ) return rc;
5272 }
dan887d4b22010-02-25 12:09:16 +00005273
shaneh1da207e2010-03-09 14:41:12 +00005274 if( ( pOvfl || ((pOvfl = btreePageLookup(pBt, ovflPgno))!=0) )
dan887d4b22010-02-25 12:09:16 +00005275 && sqlite3PagerPageRefcount(pOvfl->pDbPage)!=1
5276 ){
5277 /* There is no reason any cursor should have an outstanding reference
5278 ** to an overflow page belonging to a cell that is being deleted/updated.
5279 ** So if there exists more than one reference to this page, then it
5280 ** must not really be an overflow page and the database must be corrupt.
5281 ** It is helpful to detect this before calling freePage2(), as
5282 ** freePage2() may zero the page contents if secure-delete mode is
5283 ** enabled. If this 'overflow' page happens to be a page that the
5284 ** caller is iterating through or using in some other way, this
5285 ** can be problematic.
5286 */
5287 rc = SQLITE_CORRUPT_BKPT;
5288 }else{
5289 rc = freePage2(pBt, pOvfl, ovflPgno);
5290 }
5291
danielk1977bea2a942009-01-20 17:06:27 +00005292 if( pOvfl ){
5293 sqlite3PagerUnref(pOvfl->pDbPage);
5294 }
drh3b7511c2001-05-26 13:15:44 +00005295 if( rc ) return rc;
danielk1977bea2a942009-01-20 17:06:27 +00005296 ovflPgno = iNext;
drh3b7511c2001-05-26 13:15:44 +00005297 }
drh5e2f8b92001-05-28 00:41:15 +00005298 return SQLITE_OK;
drh3b7511c2001-05-26 13:15:44 +00005299}
5300
5301/*
drh91025292004-05-03 19:49:32 +00005302** Create the byte sequence used to represent a cell on page pPage
5303** and write that byte sequence into pCell[]. Overflow pages are
5304** allocated and filled in as necessary. The calling procedure
5305** is responsible for making sure sufficient space has been allocated
5306** for pCell[].
5307**
5308** Note that pCell does not necessary need to point to the pPage->aData
5309** area. pCell might point to some temporary storage. The cell will
5310** be constructed in this temporary area then copied into pPage->aData
5311** later.
drh3b7511c2001-05-26 13:15:44 +00005312*/
5313static int fillInCell(
drh3aac2dd2004-04-26 14:10:20 +00005314 MemPage *pPage, /* The page that contains the cell */
drh4b70f112004-05-02 21:12:19 +00005315 unsigned char *pCell, /* Complete text of the cell */
drh4a1c3802004-05-12 15:15:47 +00005316 const void *pKey, i64 nKey, /* The key */
drh4b70f112004-05-02 21:12:19 +00005317 const void *pData,int nData, /* The data */
drhb026e052007-05-02 01:34:31 +00005318 int nZero, /* Extra zero bytes to append to pData */
drh4b70f112004-05-02 21:12:19 +00005319 int *pnSize /* Write cell size here */
drh3b7511c2001-05-26 13:15:44 +00005320){
drh3b7511c2001-05-26 13:15:44 +00005321 int nPayload;
drh8c6fa9b2004-05-26 00:01:53 +00005322 const u8 *pSrc;
drha34b6762004-05-07 13:30:42 +00005323 int nSrc, n, rc;
drh3aac2dd2004-04-26 14:10:20 +00005324 int spaceLeft;
5325 MemPage *pOvfl = 0;
drh9b171272004-05-08 02:03:22 +00005326 MemPage *pToRelease = 0;
drh3aac2dd2004-04-26 14:10:20 +00005327 unsigned char *pPrior;
5328 unsigned char *pPayload;
danielk1977aef0bf62005-12-30 16:28:01 +00005329 BtShared *pBt = pPage->pBt;
drh3aac2dd2004-04-26 14:10:20 +00005330 Pgno pgnoOvfl = 0;
drh4b70f112004-05-02 21:12:19 +00005331 int nHeader;
drh6f11bef2004-05-13 01:12:56 +00005332 CellInfo info;
drh3b7511c2001-05-26 13:15:44 +00005333
drh1fee73e2007-08-29 04:00:57 +00005334 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00005335
drhc5053fb2008-11-27 02:22:10 +00005336 /* pPage is not necessarily writeable since pCell might be auxiliary
5337 ** buffer space that is separate from the pPage buffer area */
5338 assert( pCell<pPage->aData || pCell>=&pPage->aData[pBt->pageSize]
5339 || sqlite3PagerIswriteable(pPage->pDbPage) );
5340
drh91025292004-05-03 19:49:32 +00005341 /* Fill in the header. */
drh43605152004-05-29 21:46:49 +00005342 nHeader = 0;
drh91025292004-05-03 19:49:32 +00005343 if( !pPage->leaf ){
5344 nHeader += 4;
5345 }
drh8b18dd42004-05-12 19:18:15 +00005346 if( pPage->hasData ){
drhb026e052007-05-02 01:34:31 +00005347 nHeader += putVarint(&pCell[nHeader], nData+nZero);
drh6f11bef2004-05-13 01:12:56 +00005348 }else{
drhb026e052007-05-02 01:34:31 +00005349 nData = nZero = 0;
drh91025292004-05-03 19:49:32 +00005350 }
drh6f11bef2004-05-13 01:12:56 +00005351 nHeader += putVarint(&pCell[nHeader], *(u64*)&nKey);
danielk197730548662009-07-09 05:07:37 +00005352 btreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00005353 assert( info.nHeader==nHeader );
5354 assert( info.nKey==nKey );
danielk197789d40042008-11-17 14:20:56 +00005355 assert( info.nData==(u32)(nData+nZero) );
drh6f11bef2004-05-13 01:12:56 +00005356
5357 /* Fill in the payload */
drhb026e052007-05-02 01:34:31 +00005358 nPayload = nData + nZero;
drh3aac2dd2004-04-26 14:10:20 +00005359 if( pPage->intKey ){
5360 pSrc = pData;
5361 nSrc = nData;
drh91025292004-05-03 19:49:32 +00005362 nData = 0;
drhf49661a2008-12-10 16:45:50 +00005363 }else{
danielk197731d31b82009-07-13 13:18:07 +00005364 if( NEVER(nKey>0x7fffffff || pKey==0) ){
5365 return SQLITE_CORRUPT_BKPT;
drh20abac22009-01-28 20:21:17 +00005366 }
drhf49661a2008-12-10 16:45:50 +00005367 nPayload += (int)nKey;
drh3aac2dd2004-04-26 14:10:20 +00005368 pSrc = pKey;
drhf49661a2008-12-10 16:45:50 +00005369 nSrc = (int)nKey;
drh3aac2dd2004-04-26 14:10:20 +00005370 }
drh6f11bef2004-05-13 01:12:56 +00005371 *pnSize = info.nSize;
5372 spaceLeft = info.nLocal;
drh3aac2dd2004-04-26 14:10:20 +00005373 pPayload = &pCell[nHeader];
drh6f11bef2004-05-13 01:12:56 +00005374 pPrior = &pCell[info.iOverflow];
drh3b7511c2001-05-26 13:15:44 +00005375
drh3b7511c2001-05-26 13:15:44 +00005376 while( nPayload>0 ){
5377 if( spaceLeft==0 ){
danielk1977afcdd022004-10-31 16:25:42 +00005378#ifndef SQLITE_OMIT_AUTOVACUUM
5379 Pgno pgnoPtrmap = pgnoOvfl; /* Overflow page pointer-map entry page */
danielk1977b39f70b2007-05-17 18:28:11 +00005380 if( pBt->autoVacuum ){
5381 do{
5382 pgnoOvfl++;
5383 } while(
5384 PTRMAP_ISPAGE(pBt, pgnoOvfl) || pgnoOvfl==PENDING_BYTE_PAGE(pBt)
5385 );
danielk1977b39f70b2007-05-17 18:28:11 +00005386 }
danielk1977afcdd022004-10-31 16:25:42 +00005387#endif
drhf49661a2008-12-10 16:45:50 +00005388 rc = allocateBtreePage(pBt, &pOvfl, &pgnoOvfl, pgnoOvfl, 0);
danielk1977afcdd022004-10-31 16:25:42 +00005389#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977a19df672004-11-03 11:37:07 +00005390 /* If the database supports auto-vacuum, and the second or subsequent
5391 ** overflow page is being allocated, add an entry to the pointer-map
danielk19774ef24492007-05-23 09:52:41 +00005392 ** for that page now.
5393 **
5394 ** If this is the first overflow page, then write a partial entry
5395 ** to the pointer-map. If we write nothing to this pointer-map slot,
5396 ** then the optimistic overflow chain processing in clearCell()
5397 ** may misinterpret the uninitialised values and delete the
5398 ** wrong pages from the database.
danielk1977afcdd022004-10-31 16:25:42 +00005399 */
danielk19774ef24492007-05-23 09:52:41 +00005400 if( pBt->autoVacuum && rc==SQLITE_OK ){
5401 u8 eType = (pgnoPtrmap?PTRMAP_OVERFLOW2:PTRMAP_OVERFLOW1);
drh98add2e2009-07-20 17:11:49 +00005402 ptrmapPut(pBt, pgnoOvfl, eType, pgnoPtrmap, &rc);
danielk197789a4be82007-05-23 13:34:32 +00005403 if( rc ){
5404 releasePage(pOvfl);
5405 }
danielk1977afcdd022004-10-31 16:25:42 +00005406 }
5407#endif
drh3b7511c2001-05-26 13:15:44 +00005408 if( rc ){
drh9b171272004-05-08 02:03:22 +00005409 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00005410 return rc;
5411 }
drhc5053fb2008-11-27 02:22:10 +00005412
5413 /* If pToRelease is not zero than pPrior points into the data area
5414 ** of pToRelease. Make sure pToRelease is still writeable. */
5415 assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
5416
5417 /* If pPrior is part of the data area of pPage, then make sure pPage
5418 ** is still writeable */
5419 assert( pPrior<pPage->aData || pPrior>=&pPage->aData[pBt->pageSize]
5420 || sqlite3PagerIswriteable(pPage->pDbPage) );
5421
drh3aac2dd2004-04-26 14:10:20 +00005422 put4byte(pPrior, pgnoOvfl);
drh9b171272004-05-08 02:03:22 +00005423 releasePage(pToRelease);
5424 pToRelease = pOvfl;
drh3aac2dd2004-04-26 14:10:20 +00005425 pPrior = pOvfl->aData;
5426 put4byte(pPrior, 0);
5427 pPayload = &pOvfl->aData[4];
drhb6f41482004-05-14 01:58:11 +00005428 spaceLeft = pBt->usableSize - 4;
drh3b7511c2001-05-26 13:15:44 +00005429 }
5430 n = nPayload;
5431 if( n>spaceLeft ) n = spaceLeft;
drhc5053fb2008-11-27 02:22:10 +00005432
5433 /* If pToRelease is not zero than pPayload points into the data area
5434 ** of pToRelease. Make sure pToRelease is still writeable. */
5435 assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
5436
5437 /* If pPayload is part of the data area of pPage, then make sure pPage
5438 ** is still writeable */
5439 assert( pPayload<pPage->aData || pPayload>=&pPage->aData[pBt->pageSize]
5440 || sqlite3PagerIswriteable(pPage->pDbPage) );
5441
drhb026e052007-05-02 01:34:31 +00005442 if( nSrc>0 ){
5443 if( n>nSrc ) n = nSrc;
5444 assert( pSrc );
5445 memcpy(pPayload, pSrc, n);
5446 }else{
5447 memset(pPayload, 0, n);
5448 }
drh3b7511c2001-05-26 13:15:44 +00005449 nPayload -= n;
drhde647132004-05-07 17:57:49 +00005450 pPayload += n;
drh9b171272004-05-08 02:03:22 +00005451 pSrc += n;
drh3aac2dd2004-04-26 14:10:20 +00005452 nSrc -= n;
drh3b7511c2001-05-26 13:15:44 +00005453 spaceLeft -= n;
drh3aac2dd2004-04-26 14:10:20 +00005454 if( nSrc==0 ){
5455 nSrc = nData;
5456 pSrc = pData;
5457 }
drhdd793422001-06-28 01:54:48 +00005458 }
drh9b171272004-05-08 02:03:22 +00005459 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00005460 return SQLITE_OK;
5461}
5462
drh14acc042001-06-10 19:56:58 +00005463/*
5464** Remove the i-th cell from pPage. This routine effects pPage only.
5465** The cell content is not freed or deallocated. It is assumed that
5466** the cell content has been copied someplace else. This routine just
5467** removes the reference to the cell from pPage.
5468**
5469** "sz" must be the number of bytes in the cell.
drh14acc042001-06-10 19:56:58 +00005470*/
drh98add2e2009-07-20 17:11:49 +00005471static void dropCell(MemPage *pPage, int idx, int sz, int *pRC){
drh43b18e12010-08-17 19:40:08 +00005472 u32 pc; /* Offset to cell content of cell being deleted */
drh43605152004-05-29 21:46:49 +00005473 u8 *data; /* pPage->aData */
5474 u8 *ptr; /* Used to move bytes around within data[] */
drhc3f1d5f2011-05-30 23:42:16 +00005475 u8 *endPtr; /* End of loop */
shanedcc50b72008-11-13 18:29:50 +00005476 int rc; /* The return code */
drhc314dc72009-07-21 11:52:34 +00005477 int hdr; /* Beginning of the header. 0 most pages. 100 page 1 */
drh43605152004-05-29 21:46:49 +00005478
drh98add2e2009-07-20 17:11:49 +00005479 if( *pRC ) return;
5480
drh8c42ca92001-06-22 19:15:00 +00005481 assert( idx>=0 && idx<pPage->nCell );
drh43605152004-05-29 21:46:49 +00005482 assert( sz==cellSize(pPage, idx) );
danielk19773b8a05f2007-03-19 17:44:26 +00005483 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00005484 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhda200cc2004-05-09 11:51:38 +00005485 data = pPage->aData;
drh3def2352011-11-11 00:27:15 +00005486 ptr = &pPage->aCellIdx[2*idx];
shane0af3f892008-11-12 04:55:34 +00005487 pc = get2byte(ptr);
drhc314dc72009-07-21 11:52:34 +00005488 hdr = pPage->hdrOffset;
5489 testcase( pc==get2byte(&data[hdr+5]) );
5490 testcase( pc+sz==pPage->pBt->usableSize );
drh43b18e12010-08-17 19:40:08 +00005491 if( pc < (u32)get2byte(&data[hdr+5]) || pc+sz > pPage->pBt->usableSize ){
drh98add2e2009-07-20 17:11:49 +00005492 *pRC = SQLITE_CORRUPT_BKPT;
5493 return;
shane0af3f892008-11-12 04:55:34 +00005494 }
shanedcc50b72008-11-13 18:29:50 +00005495 rc = freeSpace(pPage, pc, sz);
drh98add2e2009-07-20 17:11:49 +00005496 if( rc ){
5497 *pRC = rc;
5498 return;
shanedcc50b72008-11-13 18:29:50 +00005499 }
drh3def2352011-11-11 00:27:15 +00005500 endPtr = &pPage->aCellIdx[2*pPage->nCell - 2];
drh2ce71b42011-06-06 13:38:11 +00005501 assert( (SQLITE_PTR_TO_INT(ptr)&1)==0 ); /* ptr is always 2-byte aligned */
drhc3f1d5f2011-05-30 23:42:16 +00005502 while( ptr<endPtr ){
drh61d2fe92011-06-03 23:28:33 +00005503 *(u16*)ptr = *(u16*)&ptr[2];
drhc3f1d5f2011-05-30 23:42:16 +00005504 ptr += 2;
drh14acc042001-06-10 19:56:58 +00005505 }
5506 pPage->nCell--;
drhc314dc72009-07-21 11:52:34 +00005507 put2byte(&data[hdr+3], pPage->nCell);
drh43605152004-05-29 21:46:49 +00005508 pPage->nFree += 2;
drh14acc042001-06-10 19:56:58 +00005509}
5510
5511/*
5512** Insert a new cell on pPage at cell index "i". pCell points to the
5513** content of the cell.
5514**
5515** If the cell content will fit on the page, then put it there. If it
drh43605152004-05-29 21:46:49 +00005516** will not fit, then make a copy of the cell content into pTemp if
5517** pTemp is not null. Regardless of pTemp, allocate a new entry
drh2cbd78b2012-02-02 19:37:18 +00005518** in pPage->apOvfl[] and make it point to the cell content (either
drh43605152004-05-29 21:46:49 +00005519** in pTemp or the original pCell) and also record its index.
5520** Allocating a new entry in pPage->aCell[] implies that
5521** pPage->nOverflow is incremented.
danielk1977a3ad5e72005-01-07 08:56:44 +00005522**
5523** If nSkip is non-zero, then do not copy the first nSkip bytes of the
5524** cell. The caller will overwrite them after this function returns. If
drh4b238df2005-01-08 15:43:18 +00005525** nSkip is non-zero, then pCell may not point to an invalid memory location
danielk1977a3ad5e72005-01-07 08:56:44 +00005526** (but pCell+nSkip is always valid).
drh14acc042001-06-10 19:56:58 +00005527*/
drh98add2e2009-07-20 17:11:49 +00005528static void insertCell(
drh24cd67e2004-05-10 16:18:47 +00005529 MemPage *pPage, /* Page into which we are copying */
drh43605152004-05-29 21:46:49 +00005530 int i, /* New cell becomes the i-th cell of the page */
5531 u8 *pCell, /* Content of the new cell */
5532 int sz, /* Bytes of content in pCell */
danielk1977a3ad5e72005-01-07 08:56:44 +00005533 u8 *pTemp, /* Temp storage space for pCell, if needed */
drh98add2e2009-07-20 17:11:49 +00005534 Pgno iChild, /* If non-zero, replace first 4 bytes with this value */
5535 int *pRC /* Read and write return code from here */
drh24cd67e2004-05-10 16:18:47 +00005536){
drh383d30f2010-02-26 13:07:37 +00005537 int idx = 0; /* Where to write new cell content in data[] */
drh43605152004-05-29 21:46:49 +00005538 int j; /* Loop counter */
drh43605152004-05-29 21:46:49 +00005539 int end; /* First byte past the last cell pointer in data[] */
5540 int ins; /* Index in data[] where new cell pointer is inserted */
drh43605152004-05-29 21:46:49 +00005541 int cellOffset; /* Address of first cell pointer in data[] */
5542 u8 *data; /* The content of the whole page */
5543 u8 *ptr; /* Used for moving information around in data[] */
drh61d2fe92011-06-03 23:28:33 +00005544 u8 *endPtr; /* End of the loop */
drh43605152004-05-29 21:46:49 +00005545
danielk19774dbaa892009-06-16 16:50:22 +00005546 int nSkip = (iChild ? 4 : 0);
5547
drh98add2e2009-07-20 17:11:49 +00005548 if( *pRC ) return;
5549
drh43605152004-05-29 21:46:49 +00005550 assert( i>=0 && i<=pPage->nCell+pPage->nOverflow );
drhb2eced52010-08-12 02:41:12 +00005551 assert( pPage->nCell<=MX_CELL(pPage->pBt) && MX_CELL(pPage->pBt)<=10921 );
drh2cbd78b2012-02-02 19:37:18 +00005552 assert( pPage->nOverflow<=ArraySize(pPage->apOvfl) );
5553 assert( ArraySize(pPage->apOvfl)==ArraySize(pPage->aiOvfl) );
drh1fee73e2007-08-29 04:00:57 +00005554 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhc9b9b8a2009-12-03 21:26:52 +00005555 /* The cell should normally be sized correctly. However, when moving a
5556 ** malformed cell from a leaf page to an interior page, if the cell size
5557 ** wanted to be less than 4 but got rounded up to 4 on the leaf, then size
5558 ** might be less than 8 (leaf-size + pointer) on the interior node. Hence
5559 ** the term after the || in the following assert(). */
5560 assert( sz==cellSizePtr(pPage, pCell) || (sz==8 && iChild>0) );
drh43605152004-05-29 21:46:49 +00005561 if( pPage->nOverflow || sz+2>pPage->nFree ){
drh24cd67e2004-05-10 16:18:47 +00005562 if( pTemp ){
danielk1977a3ad5e72005-01-07 08:56:44 +00005563 memcpy(pTemp+nSkip, pCell+nSkip, sz-nSkip);
drh43605152004-05-29 21:46:49 +00005564 pCell = pTemp;
drh24cd67e2004-05-10 16:18:47 +00005565 }
danielk19774dbaa892009-06-16 16:50:22 +00005566 if( iChild ){
5567 put4byte(pCell, iChild);
5568 }
drh43605152004-05-29 21:46:49 +00005569 j = pPage->nOverflow++;
drh2cbd78b2012-02-02 19:37:18 +00005570 assert( j<(int)(sizeof(pPage->apOvfl)/sizeof(pPage->apOvfl[0])) );
5571 pPage->apOvfl[j] = pCell;
5572 pPage->aiOvfl[j] = (u16)i;
drh14acc042001-06-10 19:56:58 +00005573 }else{
danielk19776e465eb2007-08-21 13:11:00 +00005574 int rc = sqlite3PagerWrite(pPage->pDbPage);
5575 if( rc!=SQLITE_OK ){
drh98add2e2009-07-20 17:11:49 +00005576 *pRC = rc;
5577 return;
danielk19776e465eb2007-08-21 13:11:00 +00005578 }
5579 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh43605152004-05-29 21:46:49 +00005580 data = pPage->aData;
drh43605152004-05-29 21:46:49 +00005581 cellOffset = pPage->cellOffset;
drh0a45c272009-07-08 01:49:11 +00005582 end = cellOffset + 2*pPage->nCell;
drh43605152004-05-29 21:46:49 +00005583 ins = cellOffset + 2*i;
drh0a45c272009-07-08 01:49:11 +00005584 rc = allocateSpace(pPage, sz, &idx);
drh98add2e2009-07-20 17:11:49 +00005585 if( rc ){ *pRC = rc; return; }
drhc314dc72009-07-21 11:52:34 +00005586 /* The allocateSpace() routine guarantees the following two properties
5587 ** if it returns success */
5588 assert( idx >= end+2 );
drhfcd71b62011-04-05 22:08:24 +00005589 assert( idx+sz <= (int)pPage->pBt->usableSize );
drh43605152004-05-29 21:46:49 +00005590 pPage->nCell++;
drh0a45c272009-07-08 01:49:11 +00005591 pPage->nFree -= (u16)(2 + sz);
danielk1977a3ad5e72005-01-07 08:56:44 +00005592 memcpy(&data[idx+nSkip], pCell+nSkip, sz-nSkip);
danielk19774dbaa892009-06-16 16:50:22 +00005593 if( iChild ){
5594 put4byte(&data[idx], iChild);
5595 }
drh61d2fe92011-06-03 23:28:33 +00005596 ptr = &data[end];
5597 endPtr = &data[ins];
drh2ce71b42011-06-06 13:38:11 +00005598 assert( (SQLITE_PTR_TO_INT(ptr)&1)==0 ); /* ptr is always 2-byte aligned */
drh61d2fe92011-06-03 23:28:33 +00005599 while( ptr>endPtr ){
5600 *(u16*)ptr = *(u16*)&ptr[-2];
5601 ptr -= 2;
drhda200cc2004-05-09 11:51:38 +00005602 }
drh43605152004-05-29 21:46:49 +00005603 put2byte(&data[ins], idx);
drh0a45c272009-07-08 01:49:11 +00005604 put2byte(&data[pPage->hdrOffset+3], pPage->nCell);
danielk1977a19df672004-11-03 11:37:07 +00005605#ifndef SQLITE_OMIT_AUTOVACUUM
5606 if( pPage->pBt->autoVacuum ){
5607 /* The cell may contain a pointer to an overflow page. If so, write
5608 ** the entry for the overflow page into the pointer map.
5609 */
drh98add2e2009-07-20 17:11:49 +00005610 ptrmapPutOvflPtr(pPage, pCell, pRC);
danielk1977a19df672004-11-03 11:37:07 +00005611 }
5612#endif
drh14acc042001-06-10 19:56:58 +00005613 }
5614}
5615
5616/*
drhfa1a98a2004-05-14 19:08:17 +00005617** Add a list of cells to a page. The page should be initially empty.
5618** The cells are guaranteed to fit on the page.
5619*/
5620static void assemblePage(
5621 MemPage *pPage, /* The page to be assemblied */
5622 int nCell, /* The number of cells to add to this page */
drh43605152004-05-29 21:46:49 +00005623 u8 **apCell, /* Pointers to cell bodies */
drha9121e42008-02-19 14:59:35 +00005624 u16 *aSize /* Sizes of the cells */
drhfa1a98a2004-05-14 19:08:17 +00005625){
5626 int i; /* Loop counter */
danielk1977fad91942009-04-29 17:49:59 +00005627 u8 *pCellptr; /* Address of next cell pointer */
drh43605152004-05-29 21:46:49 +00005628 int cellbody; /* Address of next cell body */
danielk1977fad91942009-04-29 17:49:59 +00005629 u8 * const data = pPage->aData; /* Pointer to data for pPage */
5630 const int hdr = pPage->hdrOffset; /* Offset of header on pPage */
5631 const int nUsable = pPage->pBt->usableSize; /* Usable size of page */
drhfa1a98a2004-05-14 19:08:17 +00005632
drh43605152004-05-29 21:46:49 +00005633 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +00005634 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhfcd71b62011-04-05 22:08:24 +00005635 assert( nCell>=0 && nCell<=(int)MX_CELL(pPage->pBt)
5636 && (int)MX_CELL(pPage->pBt)<=10921);
drhc5053fb2008-11-27 02:22:10 +00005637 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
danielk1977fad91942009-04-29 17:49:59 +00005638
5639 /* Check that the page has just been zeroed by zeroPage() */
5640 assert( pPage->nCell==0 );
drh5d433ce2010-08-14 16:02:52 +00005641 assert( get2byteNotZero(&data[hdr+5])==nUsable );
danielk1977fad91942009-04-29 17:49:59 +00005642
drh3def2352011-11-11 00:27:15 +00005643 pCellptr = &pPage->aCellIdx[nCell*2];
danielk1977fad91942009-04-29 17:49:59 +00005644 cellbody = nUsable;
5645 for(i=nCell-1; i>=0; i--){
drh61d2fe92011-06-03 23:28:33 +00005646 u16 sz = aSize[i];
danielk1977fad91942009-04-29 17:49:59 +00005647 pCellptr -= 2;
drh61d2fe92011-06-03 23:28:33 +00005648 cellbody -= sz;
danielk1977fad91942009-04-29 17:49:59 +00005649 put2byte(pCellptr, cellbody);
drh61d2fe92011-06-03 23:28:33 +00005650 memcpy(&data[cellbody], apCell[i], sz);
drhfa1a98a2004-05-14 19:08:17 +00005651 }
danielk1977fad91942009-04-29 17:49:59 +00005652 put2byte(&data[hdr+3], nCell);
5653 put2byte(&data[hdr+5], cellbody);
5654 pPage->nFree -= (nCell*2 + nUsable - cellbody);
drhf49661a2008-12-10 16:45:50 +00005655 pPage->nCell = (u16)nCell;
drhfa1a98a2004-05-14 19:08:17 +00005656}
5657
drh14acc042001-06-10 19:56:58 +00005658/*
drhc3b70572003-01-04 19:44:07 +00005659** The following parameters determine how many adjacent pages get involved
5660** in a balancing operation. NN is the number of neighbors on either side
5661** of the page that participate in the balancing operation. NB is the
5662** total number of pages that participate, including the target page and
5663** NN neighbors on either side.
5664**
5665** The minimum value of NN is 1 (of course). Increasing NN above 1
5666** (to 2 or 3) gives a modest improvement in SELECT and DELETE performance
5667** in exchange for a larger degradation in INSERT and UPDATE performance.
5668** The value of NN appears to give the best results overall.
5669*/
5670#define NN 1 /* Number of neighbors on either side of pPage */
5671#define NB (NN*2+1) /* Total pages involved in the balance */
5672
danielk1977ac245ec2005-01-14 13:50:11 +00005673
drh615ae552005-01-16 23:21:00 +00005674#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00005675/*
5676** This version of balance() handles the common special case where
5677** a new entry is being inserted on the extreme right-end of the
5678** tree, in other words, when the new entry will become the largest
5679** entry in the tree.
5680**
drhc314dc72009-07-21 11:52:34 +00005681** Instead of trying to balance the 3 right-most leaf pages, just add
drhf222e712005-01-14 22:55:49 +00005682** a new page to the right-hand side and put the one new entry in
5683** that page. This leaves the right side of the tree somewhat
5684** unbalanced. But odds are that we will be inserting new entries
5685** at the end soon afterwards so the nearly empty page will quickly
5686** fill up. On average.
5687**
5688** pPage is the leaf page which is the right-most page in the tree.
5689** pParent is its parent. pPage must have a single overflow entry
5690** which is also the right-most entry on the page.
danielk1977a50d9aa2009-06-08 14:49:45 +00005691**
5692** The pSpace buffer is used to store a temporary copy of the divider
5693** cell that will be inserted into pParent. Such a cell consists of a 4
5694** byte page number followed by a variable length integer. In other
5695** words, at most 13 bytes. Hence the pSpace buffer must be at
5696** least 13 bytes in size.
drhf222e712005-01-14 22:55:49 +00005697*/
danielk1977a50d9aa2009-06-08 14:49:45 +00005698static int balance_quick(MemPage *pParent, MemPage *pPage, u8 *pSpace){
5699 BtShared *const pBt = pPage->pBt; /* B-Tree Database */
danielk19774dbaa892009-06-16 16:50:22 +00005700 MemPage *pNew; /* Newly allocated page */
danielk19776f235cc2009-06-04 14:46:08 +00005701 int rc; /* Return Code */
5702 Pgno pgnoNew; /* Page number of pNew */
danielk1977ac245ec2005-01-14 13:50:11 +00005703
drh1fee73e2007-08-29 04:00:57 +00005704 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk1977a50d9aa2009-06-08 14:49:45 +00005705 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk1977e56b60e2009-06-10 09:11:06 +00005706 assert( pPage->nOverflow==1 );
5707
drh5d433ce2010-08-14 16:02:52 +00005708 /* This error condition is now caught prior to reaching this function */
drh6b47fca2010-08-19 14:22:42 +00005709 if( pPage->nCell<=0 ) return SQLITE_CORRUPT_BKPT;
drhd677b3d2007-08-20 22:48:41 +00005710
danielk1977a50d9aa2009-06-08 14:49:45 +00005711 /* Allocate a new page. This page will become the right-sibling of
5712 ** pPage. Make the parent page writable, so that the new divider cell
5713 ** may be inserted. If both these operations are successful, proceed.
5714 */
drh4f0c5872007-03-26 22:05:01 +00005715 rc = allocateBtreePage(pBt, &pNew, &pgnoNew, 0, 0);
danielk19774dbaa892009-06-16 16:50:22 +00005716
danielk1977eaa06f62008-09-18 17:34:44 +00005717 if( rc==SQLITE_OK ){
danielk1977a50d9aa2009-06-08 14:49:45 +00005718
5719 u8 *pOut = &pSpace[4];
drh2cbd78b2012-02-02 19:37:18 +00005720 u8 *pCell = pPage->apOvfl[0];
danielk19776f235cc2009-06-04 14:46:08 +00005721 u16 szCell = cellSizePtr(pPage, pCell);
5722 u8 *pStop;
5723
drhc5053fb2008-11-27 02:22:10 +00005724 assert( sqlite3PagerIswriteable(pNew->pDbPage) );
danielk1977e56b60e2009-06-10 09:11:06 +00005725 assert( pPage->aData[0]==(PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF) );
5726 zeroPage(pNew, PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF);
danielk1977eaa06f62008-09-18 17:34:44 +00005727 assemblePage(pNew, 1, &pCell, &szCell);
danielk19774dbaa892009-06-16 16:50:22 +00005728
5729 /* If this is an auto-vacuum database, update the pointer map
5730 ** with entries for the new page, and any pointer from the
5731 ** cell on the page to an overflow page. If either of these
5732 ** operations fails, the return code is set, but the contents
5733 ** of the parent page are still manipulated by thh code below.
5734 ** That is Ok, at this point the parent page is guaranteed to
5735 ** be marked as dirty. Returning an error code will cause a
5736 ** rollback, undoing any changes made to the parent page.
5737 */
5738 if( ISAUTOVACUUM ){
drh98add2e2009-07-20 17:11:49 +00005739 ptrmapPut(pBt, pgnoNew, PTRMAP_BTREE, pParent->pgno, &rc);
5740 if( szCell>pNew->minLocal ){
5741 ptrmapPutOvflPtr(pNew, pCell, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00005742 }
5743 }
danielk1977eaa06f62008-09-18 17:34:44 +00005744
danielk19776f235cc2009-06-04 14:46:08 +00005745 /* Create a divider cell to insert into pParent. The divider cell
5746 ** consists of a 4-byte page number (the page number of pPage) and
5747 ** a variable length key value (which must be the same value as the
5748 ** largest key on pPage).
danielk1977eaa06f62008-09-18 17:34:44 +00005749 **
danielk19776f235cc2009-06-04 14:46:08 +00005750 ** To find the largest key value on pPage, first find the right-most
5751 ** cell on pPage. The first two fields of this cell are the
5752 ** record-length (a variable length integer at most 32-bits in size)
5753 ** and the key value (a variable length integer, may have any value).
5754 ** The first of the while(...) loops below skips over the record-length
5755 ** field. The second while(...) loop copies the key value from the
danielk1977a50d9aa2009-06-08 14:49:45 +00005756 ** cell on pPage into the pSpace buffer.
danielk1977eaa06f62008-09-18 17:34:44 +00005757 */
danielk1977eaa06f62008-09-18 17:34:44 +00005758 pCell = findCell(pPage, pPage->nCell-1);
danielk19776f235cc2009-06-04 14:46:08 +00005759 pStop = &pCell[9];
5760 while( (*(pCell++)&0x80) && pCell<pStop );
5761 pStop = &pCell[9];
5762 while( ((*(pOut++) = *(pCell++))&0x80) && pCell<pStop );
5763
danielk19774dbaa892009-06-16 16:50:22 +00005764 /* Insert the new divider cell into pParent. */
drh98add2e2009-07-20 17:11:49 +00005765 insertCell(pParent, pParent->nCell, pSpace, (int)(pOut-pSpace),
5766 0, pPage->pgno, &rc);
danielk19776f235cc2009-06-04 14:46:08 +00005767
5768 /* Set the right-child pointer of pParent to point to the new page. */
danielk1977eaa06f62008-09-18 17:34:44 +00005769 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew);
5770
danielk1977e08a3c42008-09-18 18:17:03 +00005771 /* Release the reference to the new page. */
5772 releasePage(pNew);
danielk1977ac11ee62005-01-15 12:45:51 +00005773 }
5774
danielk1977eaa06f62008-09-18 17:34:44 +00005775 return rc;
danielk1977ac245ec2005-01-14 13:50:11 +00005776}
drh615ae552005-01-16 23:21:00 +00005777#endif /* SQLITE_OMIT_QUICKBALANCE */
drh43605152004-05-29 21:46:49 +00005778
danielk19774dbaa892009-06-16 16:50:22 +00005779#if 0
drhc3b70572003-01-04 19:44:07 +00005780/*
danielk19774dbaa892009-06-16 16:50:22 +00005781** This function does not contribute anything to the operation of SQLite.
5782** it is sometimes activated temporarily while debugging code responsible
5783** for setting pointer-map entries.
5784*/
5785static int ptrmapCheckPages(MemPage **apPage, int nPage){
5786 int i, j;
5787 for(i=0; i<nPage; i++){
5788 Pgno n;
5789 u8 e;
5790 MemPage *pPage = apPage[i];
5791 BtShared *pBt = pPage->pBt;
5792 assert( pPage->isInit );
5793
5794 for(j=0; j<pPage->nCell; j++){
5795 CellInfo info;
5796 u8 *z;
5797
5798 z = findCell(pPage, j);
danielk197730548662009-07-09 05:07:37 +00005799 btreeParseCellPtr(pPage, z, &info);
danielk19774dbaa892009-06-16 16:50:22 +00005800 if( info.iOverflow ){
5801 Pgno ovfl = get4byte(&z[info.iOverflow]);
5802 ptrmapGet(pBt, ovfl, &e, &n);
5803 assert( n==pPage->pgno && e==PTRMAP_OVERFLOW1 );
5804 }
5805 if( !pPage->leaf ){
5806 Pgno child = get4byte(z);
5807 ptrmapGet(pBt, child, &e, &n);
5808 assert( n==pPage->pgno && e==PTRMAP_BTREE );
5809 }
5810 }
5811 if( !pPage->leaf ){
5812 Pgno child = get4byte(&pPage->aData[pPage->hdrOffset+8]);
5813 ptrmapGet(pBt, child, &e, &n);
5814 assert( n==pPage->pgno && e==PTRMAP_BTREE );
5815 }
5816 }
5817 return 1;
5818}
5819#endif
5820
danielk1977cd581a72009-06-23 15:43:39 +00005821/*
5822** This function is used to copy the contents of the b-tree node stored
5823** on page pFrom to page pTo. If page pFrom was not a leaf page, then
5824** the pointer-map entries for each child page are updated so that the
5825** parent page stored in the pointer map is page pTo. If pFrom contained
5826** any cells with overflow page pointers, then the corresponding pointer
5827** map entries are also updated so that the parent page is page pTo.
5828**
5829** If pFrom is currently carrying any overflow cells (entries in the
drh2cbd78b2012-02-02 19:37:18 +00005830** MemPage.apOvfl[] array), they are not copied to pTo.
danielk1977cd581a72009-06-23 15:43:39 +00005831**
danielk197730548662009-07-09 05:07:37 +00005832** Before returning, page pTo is reinitialized using btreeInitPage().
danielk1977cd581a72009-06-23 15:43:39 +00005833**
5834** The performance of this function is not critical. It is only used by
5835** the balance_shallower() and balance_deeper() procedures, neither of
5836** which are called often under normal circumstances.
5837*/
drhc314dc72009-07-21 11:52:34 +00005838static void copyNodeContent(MemPage *pFrom, MemPage *pTo, int *pRC){
5839 if( (*pRC)==SQLITE_OK ){
5840 BtShared * const pBt = pFrom->pBt;
5841 u8 * const aFrom = pFrom->aData;
5842 u8 * const aTo = pTo->aData;
5843 int const iFromHdr = pFrom->hdrOffset;
5844 int const iToHdr = ((pTo->pgno==1) ? 100 : 0);
drhdc9b5f82009-12-05 18:34:08 +00005845 int rc;
drhc314dc72009-07-21 11:52:34 +00005846 int iData;
5847
5848
5849 assert( pFrom->isInit );
5850 assert( pFrom->nFree>=iToHdr );
drhfcd71b62011-04-05 22:08:24 +00005851 assert( get2byte(&aFrom[iFromHdr+5]) <= (int)pBt->usableSize );
drhc314dc72009-07-21 11:52:34 +00005852
5853 /* Copy the b-tree node content from page pFrom to page pTo. */
5854 iData = get2byte(&aFrom[iFromHdr+5]);
5855 memcpy(&aTo[iData], &aFrom[iData], pBt->usableSize-iData);
5856 memcpy(&aTo[iToHdr], &aFrom[iFromHdr], pFrom->cellOffset + 2*pFrom->nCell);
5857
5858 /* Reinitialize page pTo so that the contents of the MemPage structure
dan89e060e2009-12-05 18:03:50 +00005859 ** match the new data. The initialization of pTo can actually fail under
5860 ** fairly obscure circumstances, even though it is a copy of initialized
5861 ** page pFrom.
5862 */
drhc314dc72009-07-21 11:52:34 +00005863 pTo->isInit = 0;
dan89e060e2009-12-05 18:03:50 +00005864 rc = btreeInitPage(pTo);
5865 if( rc!=SQLITE_OK ){
5866 *pRC = rc;
5867 return;
5868 }
drhc314dc72009-07-21 11:52:34 +00005869
5870 /* If this is an auto-vacuum database, update the pointer-map entries
5871 ** for any b-tree or overflow pages that pTo now contains the pointers to.
5872 */
5873 if( ISAUTOVACUUM ){
5874 *pRC = setChildPtrmaps(pTo);
5875 }
danielk1977cd581a72009-06-23 15:43:39 +00005876 }
danielk1977cd581a72009-06-23 15:43:39 +00005877}
5878
5879/*
danielk19774dbaa892009-06-16 16:50:22 +00005880** This routine redistributes cells on the iParentIdx'th child of pParent
5881** (hereafter "the page") and up to 2 siblings so that all pages have about the
5882** same amount of free space. Usually a single sibling on either side of the
5883** page are used in the balancing, though both siblings might come from one
5884** side if the page is the first or last child of its parent. If the page
5885** has fewer than 2 siblings (something which can only happen if the page
5886** is a root page or a child of a root page) then all available siblings
5887** participate in the balancing.
drh8b2f49b2001-06-08 00:21:52 +00005888**
danielk19774dbaa892009-06-16 16:50:22 +00005889** The number of siblings of the page might be increased or decreased by
5890** one or two in an effort to keep pages nearly full but not over full.
drh14acc042001-06-10 19:56:58 +00005891**
danielk19774dbaa892009-06-16 16:50:22 +00005892** Note that when this routine is called, some of the cells on the page
5893** might not actually be stored in MemPage.aData[]. This can happen
5894** if the page is overfull. This routine ensures that all cells allocated
5895** to the page and its siblings fit into MemPage.aData[] before returning.
drh14acc042001-06-10 19:56:58 +00005896**
danielk19774dbaa892009-06-16 16:50:22 +00005897** In the course of balancing the page and its siblings, cells may be
5898** inserted into or removed from the parent page (pParent). Doing so
5899** may cause the parent page to become overfull or underfull. If this
5900** happens, it is the responsibility of the caller to invoke the correct
5901** balancing routine to fix this problem (see the balance() routine).
drh8c42ca92001-06-22 19:15:00 +00005902**
drh5e00f6c2001-09-13 13:46:56 +00005903** If this routine fails for any reason, it might leave the database
danielk19776067a9b2009-06-09 09:41:00 +00005904** in a corrupted state. So if this routine fails, the database should
drh5e00f6c2001-09-13 13:46:56 +00005905** be rolled back.
danielk19774dbaa892009-06-16 16:50:22 +00005906**
5907** The third argument to this function, aOvflSpace, is a pointer to a
drhcd09c532009-07-20 19:30:00 +00005908** buffer big enough to hold one page. If while inserting cells into the parent
5909** page (pParent) the parent page becomes overfull, this buffer is
5910** used to store the parent's overflow cells. Because this function inserts
danielk19774dbaa892009-06-16 16:50:22 +00005911** a maximum of four divider cells into the parent page, and the maximum
5912** size of a cell stored within an internal node is always less than 1/4
5913** of the page-size, the aOvflSpace[] buffer is guaranteed to be large
5914** enough for all overflow cells.
5915**
5916** If aOvflSpace is set to a null pointer, this function returns
5917** SQLITE_NOMEM.
drh8b2f49b2001-06-08 00:21:52 +00005918*/
danielk19774dbaa892009-06-16 16:50:22 +00005919static int balance_nonroot(
5920 MemPage *pParent, /* Parent page of siblings being balanced */
5921 int iParentIdx, /* Index of "the page" in pParent */
danielk1977cd581a72009-06-23 15:43:39 +00005922 u8 *aOvflSpace, /* page-size bytes of space for parent ovfl */
5923 int isRoot /* True if pParent is a root-page */
danielk19774dbaa892009-06-16 16:50:22 +00005924){
drh16a9b832007-05-05 18:39:25 +00005925 BtShared *pBt; /* The whole database */
danielk1977634f2982005-03-28 08:44:07 +00005926 int nCell = 0; /* Number of cells in apCell[] */
5927 int nMaxCells = 0; /* Allocated size of apCell, szCell, aFrom. */
danielk1977a4124bd2008-12-23 10:37:47 +00005928 int nNew = 0; /* Number of pages in apNew[] */
danielk19774dbaa892009-06-16 16:50:22 +00005929 int nOld; /* Number of pages in apOld[] */
drh14acc042001-06-10 19:56:58 +00005930 int i, j, k; /* Loop counters */
drha34b6762004-05-07 13:30:42 +00005931 int nxDiv; /* Next divider slot in pParent->aCell[] */
shane85095702009-06-15 16:27:08 +00005932 int rc = SQLITE_OK; /* The return code */
shane36840fd2009-06-26 16:32:13 +00005933 u16 leafCorrection; /* 4 if pPage is a leaf. 0 if not */
drh8b18dd42004-05-12 19:18:15 +00005934 int leafData; /* True if pPage is a leaf of a LEAFDATA tree */
drh91025292004-05-03 19:49:32 +00005935 int usableSpace; /* Bytes in pPage beyond the header */
5936 int pageFlags; /* Value of pPage->aData[0] */
drh6019e162001-07-02 17:51:45 +00005937 int subtotal; /* Subtotal of bytes in cells on one page */
drhe5ae5732008-06-15 02:51:47 +00005938 int iSpace1 = 0; /* First unused byte of aSpace1[] */
danielk19776067a9b2009-06-09 09:41:00 +00005939 int iOvflSpace = 0; /* First unused byte of aOvflSpace[] */
drhfacf0302008-06-17 15:12:00 +00005940 int szScratch; /* Size of scratch memory requested */
drhc3b70572003-01-04 19:44:07 +00005941 MemPage *apOld[NB]; /* pPage and up to two siblings */
drh4b70f112004-05-02 21:12:19 +00005942 MemPage *apCopy[NB]; /* Private copies of apOld[] pages */
drha2fce642004-06-05 00:01:44 +00005943 MemPage *apNew[NB+2]; /* pPage and up to NB siblings after balancing */
danielk19774dbaa892009-06-16 16:50:22 +00005944 u8 *pRight; /* Location in parent of right-sibling pointer */
5945 u8 *apDiv[NB-1]; /* Divider cells in pParent */
drha2fce642004-06-05 00:01:44 +00005946 int cntNew[NB+2]; /* Index in aCell[] of cell after i-th page */
5947 int szNew[NB+2]; /* Combined size of cells place on i-th page */
danielk197750f059b2005-03-29 02:54:03 +00005948 u8 **apCell = 0; /* All cells begin balanced */
drha9121e42008-02-19 14:59:35 +00005949 u16 *szCell; /* Local size of all cells in apCell[] */
danielk19774dbaa892009-06-16 16:50:22 +00005950 u8 *aSpace1; /* Space for copies of dividers cells */
5951 Pgno pgno; /* Temp var to store a page number in */
drh8b2f49b2001-06-08 00:21:52 +00005952
danielk1977a50d9aa2009-06-08 14:49:45 +00005953 pBt = pParent->pBt;
5954 assert( sqlite3_mutex_held(pBt->mutex) );
5955 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk1977474b7cc2008-07-09 11:49:46 +00005956
danielk1977e5765212009-06-17 11:13:28 +00005957#if 0
drh43605152004-05-29 21:46:49 +00005958 TRACE(("BALANCE: begin page %d child of %d\n", pPage->pgno, pParent->pgno));
danielk1977e5765212009-06-17 11:13:28 +00005959#endif
drh2e38c322004-09-03 18:38:44 +00005960
danielk19774dbaa892009-06-16 16:50:22 +00005961 /* At this point pParent may have at most one overflow cell. And if
5962 ** this overflow cell is present, it must be the cell with
5963 ** index iParentIdx. This scenario comes about when this function
drhcd09c532009-07-20 19:30:00 +00005964 ** is called (indirectly) from sqlite3BtreeDelete().
5965 */
danielk19774dbaa892009-06-16 16:50:22 +00005966 assert( pParent->nOverflow==0 || pParent->nOverflow==1 );
drh2cbd78b2012-02-02 19:37:18 +00005967 assert( pParent->nOverflow==0 || pParent->aiOvfl[0]==iParentIdx );
danielk19774dbaa892009-06-16 16:50:22 +00005968
danielk197711a8a862009-06-17 11:49:52 +00005969 if( !aOvflSpace ){
5970 return SQLITE_NOMEM;
5971 }
5972
danielk1977a50d9aa2009-06-08 14:49:45 +00005973 /* Find the sibling pages to balance. Also locate the cells in pParent
5974 ** that divide the siblings. An attempt is made to find NN siblings on
5975 ** either side of pPage. More siblings are taken from one side, however,
5976 ** if there are fewer than NN siblings on the other side. If pParent
danielk19774dbaa892009-06-16 16:50:22 +00005977 ** has NB or fewer children then all children of pParent are taken.
5978 **
5979 ** This loop also drops the divider cells from the parent page. This
5980 ** way, the remainder of the function does not have to deal with any
drhcd09c532009-07-20 19:30:00 +00005981 ** overflow cells in the parent page, since if any existed they will
5982 ** have already been removed.
5983 */
danielk19774dbaa892009-06-16 16:50:22 +00005984 i = pParent->nOverflow + pParent->nCell;
5985 if( i<2 ){
drhc3b70572003-01-04 19:44:07 +00005986 nxDiv = 0;
danielk19774dbaa892009-06-16 16:50:22 +00005987 nOld = i+1;
5988 }else{
5989 nOld = 3;
5990 if( iParentIdx==0 ){
5991 nxDiv = 0;
5992 }else if( iParentIdx==i ){
5993 nxDiv = i-2;
drh14acc042001-06-10 19:56:58 +00005994 }else{
danielk19774dbaa892009-06-16 16:50:22 +00005995 nxDiv = iParentIdx-1;
drh8b2f49b2001-06-08 00:21:52 +00005996 }
danielk19774dbaa892009-06-16 16:50:22 +00005997 i = 2;
5998 }
5999 if( (i+nxDiv-pParent->nOverflow)==pParent->nCell ){
6000 pRight = &pParent->aData[pParent->hdrOffset+8];
6001 }else{
6002 pRight = findCell(pParent, i+nxDiv-pParent->nOverflow);
6003 }
6004 pgno = get4byte(pRight);
6005 while( 1 ){
6006 rc = getAndInitPage(pBt, pgno, &apOld[i]);
6007 if( rc ){
danielk197789bc4bc2009-07-21 19:25:24 +00006008 memset(apOld, 0, (i+1)*sizeof(MemPage*));
danielk19774dbaa892009-06-16 16:50:22 +00006009 goto balance_cleanup;
6010 }
danielk1977634f2982005-03-28 08:44:07 +00006011 nMaxCells += 1+apOld[i]->nCell+apOld[i]->nOverflow;
danielk19774dbaa892009-06-16 16:50:22 +00006012 if( (i--)==0 ) break;
6013
drh2cbd78b2012-02-02 19:37:18 +00006014 if( i+nxDiv==pParent->aiOvfl[0] && pParent->nOverflow ){
6015 apDiv[i] = pParent->apOvfl[0];
danielk19774dbaa892009-06-16 16:50:22 +00006016 pgno = get4byte(apDiv[i]);
6017 szNew[i] = cellSizePtr(pParent, apDiv[i]);
6018 pParent->nOverflow = 0;
6019 }else{
6020 apDiv[i] = findCell(pParent, i+nxDiv-pParent->nOverflow);
6021 pgno = get4byte(apDiv[i]);
6022 szNew[i] = cellSizePtr(pParent, apDiv[i]);
6023
6024 /* Drop the cell from the parent page. apDiv[i] still points to
6025 ** the cell within the parent, even though it has been dropped.
6026 ** This is safe because dropping a cell only overwrites the first
6027 ** four bytes of it, and this function does not need the first
6028 ** four bytes of the divider cell. So the pointer is safe to use
danielk197711a8a862009-06-17 11:49:52 +00006029 ** later on.
6030 **
drh8a575d92011-10-12 17:00:28 +00006031 ** But not if we are in secure-delete mode. In secure-delete mode,
danielk197711a8a862009-06-17 11:49:52 +00006032 ** the dropCell() routine will overwrite the entire cell with zeroes.
6033 ** In this case, temporarily copy the cell into the aOvflSpace[]
6034 ** buffer. It will be copied out again as soon as the aSpace[] buffer
6035 ** is allocated. */
drhc9166342012-01-05 23:32:06 +00006036 if( pBt->btsFlags & BTS_SECURE_DELETE ){
drh8a575d92011-10-12 17:00:28 +00006037 int iOff;
6038
6039 iOff = SQLITE_PTR_TO_INT(apDiv[i]) - SQLITE_PTR_TO_INT(pParent->aData);
drh43b18e12010-08-17 19:40:08 +00006040 if( (iOff+szNew[i])>(int)pBt->usableSize ){
dan2ed11e72010-02-26 15:09:19 +00006041 rc = SQLITE_CORRUPT_BKPT;
6042 memset(apOld, 0, (i+1)*sizeof(MemPage*));
6043 goto balance_cleanup;
6044 }else{
6045 memcpy(&aOvflSpace[iOff], apDiv[i], szNew[i]);
6046 apDiv[i] = &aOvflSpace[apDiv[i]-pParent->aData];
6047 }
drh5b47efa2010-02-12 18:18:39 +00006048 }
drh98add2e2009-07-20 17:11:49 +00006049 dropCell(pParent, i+nxDiv-pParent->nOverflow, szNew[i], &rc);
danielk19774dbaa892009-06-16 16:50:22 +00006050 }
drh8b2f49b2001-06-08 00:21:52 +00006051 }
6052
drha9121e42008-02-19 14:59:35 +00006053 /* Make nMaxCells a multiple of 4 in order to preserve 8-byte
drh8d97f1f2005-05-05 18:14:13 +00006054 ** alignment */
drha9121e42008-02-19 14:59:35 +00006055 nMaxCells = (nMaxCells + 3)&~3;
drh8d97f1f2005-05-05 18:14:13 +00006056
drh8b2f49b2001-06-08 00:21:52 +00006057 /*
danielk1977634f2982005-03-28 08:44:07 +00006058 ** Allocate space for memory structures
6059 */
danielk19774dbaa892009-06-16 16:50:22 +00006060 k = pBt->pageSize + ROUND8(sizeof(MemPage));
drhfacf0302008-06-17 15:12:00 +00006061 szScratch =
drha9121e42008-02-19 14:59:35 +00006062 nMaxCells*sizeof(u8*) /* apCell */
6063 + nMaxCells*sizeof(u16) /* szCell */
drhe5ae5732008-06-15 02:51:47 +00006064 + pBt->pageSize /* aSpace1 */
danielk19774dbaa892009-06-16 16:50:22 +00006065 + k*nOld; /* Page copies (apCopy) */
drhfacf0302008-06-17 15:12:00 +00006066 apCell = sqlite3ScratchMalloc( szScratch );
danielk197711a8a862009-06-17 11:49:52 +00006067 if( apCell==0 ){
danielk1977634f2982005-03-28 08:44:07 +00006068 rc = SQLITE_NOMEM;
6069 goto balance_cleanup;
6070 }
drha9121e42008-02-19 14:59:35 +00006071 szCell = (u16*)&apCell[nMaxCells];
danielk19774dbaa892009-06-16 16:50:22 +00006072 aSpace1 = (u8*)&szCell[nMaxCells];
drhea598cb2009-04-05 12:22:08 +00006073 assert( EIGHT_BYTE_ALIGNMENT(aSpace1) );
drh14acc042001-06-10 19:56:58 +00006074
6075 /*
6076 ** Load pointers to all cells on sibling pages and the divider cells
6077 ** into the local apCell[] array. Make copies of the divider cells
danielk19774dbaa892009-06-16 16:50:22 +00006078 ** into space obtained from aSpace1[] and remove the the divider Cells
drhb6f41482004-05-14 01:58:11 +00006079 ** from pParent.
drh4b70f112004-05-02 21:12:19 +00006080 **
6081 ** If the siblings are on leaf pages, then the child pointers of the
6082 ** divider cells are stripped from the cells before they are copied
drhe5ae5732008-06-15 02:51:47 +00006083 ** into aSpace1[]. In this way, all cells in apCell[] are without
drh4b70f112004-05-02 21:12:19 +00006084 ** child pointers. If siblings are not leaves, then all cell in
6085 ** apCell[] include child pointers. Either way, all cells in apCell[]
6086 ** are alike.
drh96f5b762004-05-16 16:24:36 +00006087 **
6088 ** leafCorrection: 4 if pPage is a leaf. 0 if pPage is not a leaf.
6089 ** leafData: 1 if pPage holds key+data and pParent holds only keys.
drh8b2f49b2001-06-08 00:21:52 +00006090 */
danielk1977a50d9aa2009-06-08 14:49:45 +00006091 leafCorrection = apOld[0]->leaf*4;
6092 leafData = apOld[0]->hasData;
drh8b2f49b2001-06-08 00:21:52 +00006093 for(i=0; i<nOld; i++){
danielk19774dbaa892009-06-16 16:50:22 +00006094 int limit;
6095
6096 /* Before doing anything else, take a copy of the i'th original sibling
6097 ** The rest of this function will use data from the copies rather
6098 ** that the original pages since the original pages will be in the
6099 ** process of being overwritten. */
6100 MemPage *pOld = apCopy[i] = (MemPage*)&aSpace1[pBt->pageSize + k*i];
6101 memcpy(pOld, apOld[i], sizeof(MemPage));
6102 pOld->aData = (void*)&pOld[1];
6103 memcpy(pOld->aData, apOld[i]->aData, pBt->pageSize);
6104
6105 limit = pOld->nCell+pOld->nOverflow;
drh68f2a572011-06-03 17:50:49 +00006106 if( pOld->nOverflow>0 ){
6107 for(j=0; j<limit; j++){
6108 assert( nCell<nMaxCells );
6109 apCell[nCell] = findOverflowCell(pOld, j);
6110 szCell[nCell] = cellSizePtr(pOld, apCell[nCell]);
6111 nCell++;
6112 }
6113 }else{
6114 u8 *aData = pOld->aData;
6115 u16 maskPage = pOld->maskPage;
6116 u16 cellOffset = pOld->cellOffset;
6117 for(j=0; j<limit; j++){
6118 assert( nCell<nMaxCells );
6119 apCell[nCell] = findCellv2(aData, maskPage, cellOffset, j);
6120 szCell[nCell] = cellSizePtr(pOld, apCell[nCell]);
6121 nCell++;
6122 }
6123 }
danielk19774dbaa892009-06-16 16:50:22 +00006124 if( i<nOld-1 && !leafData){
shane36840fd2009-06-26 16:32:13 +00006125 u16 sz = (u16)szNew[i];
danielk19774dbaa892009-06-16 16:50:22 +00006126 u8 *pTemp;
6127 assert( nCell<nMaxCells );
6128 szCell[nCell] = sz;
6129 pTemp = &aSpace1[iSpace1];
6130 iSpace1 += sz;
drhe22e03e2010-08-18 21:19:03 +00006131 assert( sz<=pBt->maxLocal+23 );
drhfcd71b62011-04-05 22:08:24 +00006132 assert( iSpace1 <= (int)pBt->pageSize );
danielk19774dbaa892009-06-16 16:50:22 +00006133 memcpy(pTemp, apDiv[i], sz);
6134 apCell[nCell] = pTemp+leafCorrection;
6135 assert( leafCorrection==0 || leafCorrection==4 );
shane36840fd2009-06-26 16:32:13 +00006136 szCell[nCell] = szCell[nCell] - leafCorrection;
danielk19774dbaa892009-06-16 16:50:22 +00006137 if( !pOld->leaf ){
6138 assert( leafCorrection==0 );
6139 assert( pOld->hdrOffset==0 );
6140 /* The right pointer of the child page pOld becomes the left
6141 ** pointer of the divider cell */
6142 memcpy(apCell[nCell], &pOld->aData[8], 4);
6143 }else{
6144 assert( leafCorrection==4 );
6145 if( szCell[nCell]<4 ){
6146 /* Do not allow any cells smaller than 4 bytes. */
6147 szCell[nCell] = 4;
danielk1977ac11ee62005-01-15 12:45:51 +00006148 }
6149 }
drh14acc042001-06-10 19:56:58 +00006150 nCell++;
drh8b2f49b2001-06-08 00:21:52 +00006151 }
drh8b2f49b2001-06-08 00:21:52 +00006152 }
6153
6154 /*
drh6019e162001-07-02 17:51:45 +00006155 ** Figure out the number of pages needed to hold all nCell cells.
6156 ** Store this number in "k". Also compute szNew[] which is the total
6157 ** size of all cells on the i-th page and cntNew[] which is the index
drh4b70f112004-05-02 21:12:19 +00006158 ** in apCell[] of the cell that divides page i from page i+1.
drh6019e162001-07-02 17:51:45 +00006159 ** cntNew[k] should equal nCell.
6160 **
drh96f5b762004-05-16 16:24:36 +00006161 ** Values computed by this block:
6162 **
6163 ** k: The total number of sibling pages
6164 ** szNew[i]: Spaced used on the i-th sibling page.
6165 ** cntNew[i]: Index in apCell[] and szCell[] for the first cell to
6166 ** the right of the i-th sibling page.
6167 ** usableSpace: Number of bytes of space available on each sibling.
6168 **
drh8b2f49b2001-06-08 00:21:52 +00006169 */
drh43605152004-05-29 21:46:49 +00006170 usableSpace = pBt->usableSize - 12 + leafCorrection;
drh6019e162001-07-02 17:51:45 +00006171 for(subtotal=k=i=0; i<nCell; i++){
danielk1977634f2982005-03-28 08:44:07 +00006172 assert( i<nMaxCells );
drh43605152004-05-29 21:46:49 +00006173 subtotal += szCell[i] + 2;
drh4b70f112004-05-02 21:12:19 +00006174 if( subtotal > usableSpace ){
drh6019e162001-07-02 17:51:45 +00006175 szNew[k] = subtotal - szCell[i];
6176 cntNew[k] = i;
drh8b18dd42004-05-12 19:18:15 +00006177 if( leafData ){ i--; }
drh6019e162001-07-02 17:51:45 +00006178 subtotal = 0;
6179 k++;
drh9978c972010-02-23 17:36:32 +00006180 if( k>NB+1 ){ rc = SQLITE_CORRUPT_BKPT; goto balance_cleanup; }
drh6019e162001-07-02 17:51:45 +00006181 }
6182 }
6183 szNew[k] = subtotal;
6184 cntNew[k] = nCell;
6185 k++;
drh96f5b762004-05-16 16:24:36 +00006186
6187 /*
6188 ** The packing computed by the previous block is biased toward the siblings
6189 ** on the left side. The left siblings are always nearly full, while the
6190 ** right-most sibling might be nearly empty. This block of code attempts
6191 ** to adjust the packing of siblings to get a better balance.
6192 **
6193 ** This adjustment is more than an optimization. The packing above might
6194 ** be so out of balance as to be illegal. For example, the right-most
6195 ** sibling might be completely empty. This adjustment is not optional.
6196 */
drh6019e162001-07-02 17:51:45 +00006197 for(i=k-1; i>0; i--){
drh96f5b762004-05-16 16:24:36 +00006198 int szRight = szNew[i]; /* Size of sibling on the right */
6199 int szLeft = szNew[i-1]; /* Size of sibling on the left */
6200 int r; /* Index of right-most cell in left sibling */
6201 int d; /* Index of first cell to the left of right sibling */
6202
6203 r = cntNew[i-1] - 1;
6204 d = r + 1 - leafData;
danielk1977634f2982005-03-28 08:44:07 +00006205 assert( d<nMaxCells );
6206 assert( r<nMaxCells );
drh43605152004-05-29 21:46:49 +00006207 while( szRight==0 || szRight+szCell[d]+2<=szLeft-(szCell[r]+2) ){
6208 szRight += szCell[d] + 2;
6209 szLeft -= szCell[r] + 2;
drh6019e162001-07-02 17:51:45 +00006210 cntNew[i-1]--;
drh96f5b762004-05-16 16:24:36 +00006211 r = cntNew[i-1] - 1;
6212 d = r + 1 - leafData;
drh6019e162001-07-02 17:51:45 +00006213 }
drh96f5b762004-05-16 16:24:36 +00006214 szNew[i] = szRight;
6215 szNew[i-1] = szLeft;
drh6019e162001-07-02 17:51:45 +00006216 }
drh09d0deb2005-08-02 17:13:09 +00006217
danielk19776f235cc2009-06-04 14:46:08 +00006218 /* Either we found one or more cells (cntnew[0])>0) or pPage is
drh09d0deb2005-08-02 17:13:09 +00006219 ** a virtual root page. A virtual root page is when the real root
6220 ** page is page 1 and we are the only child of that page.
drh2f32fba2012-01-02 16:38:57 +00006221 **
6222 ** UPDATE: The assert() below is not necessarily true if the database
6223 ** file is corrupt. The corruption will be detected and reported later
6224 ** in this procedure so there is no need to act upon it now.
drh09d0deb2005-08-02 17:13:09 +00006225 */
drh2f32fba2012-01-02 16:38:57 +00006226#if 0
drh09d0deb2005-08-02 17:13:09 +00006227 assert( cntNew[0]>0 || (pParent->pgno==1 && pParent->nCell==0) );
drh2f32fba2012-01-02 16:38:57 +00006228#endif
drh8b2f49b2001-06-08 00:21:52 +00006229
danielk1977e5765212009-06-17 11:13:28 +00006230 TRACE(("BALANCE: old: %d %d %d ",
6231 apOld[0]->pgno,
6232 nOld>=2 ? apOld[1]->pgno : 0,
6233 nOld>=3 ? apOld[2]->pgno : 0
6234 ));
6235
drh8b2f49b2001-06-08 00:21:52 +00006236 /*
drh6b308672002-07-08 02:16:37 +00006237 ** Allocate k new pages. Reuse old pages where possible.
drh8b2f49b2001-06-08 00:21:52 +00006238 */
drheac74422009-06-14 12:47:11 +00006239 if( apOld[0]->pgno<=1 ){
drh9978c972010-02-23 17:36:32 +00006240 rc = SQLITE_CORRUPT_BKPT;
drheac74422009-06-14 12:47:11 +00006241 goto balance_cleanup;
6242 }
danielk1977a50d9aa2009-06-08 14:49:45 +00006243 pageFlags = apOld[0]->aData[0];
drh14acc042001-06-10 19:56:58 +00006244 for(i=0; i<k; i++){
drhda200cc2004-05-09 11:51:38 +00006245 MemPage *pNew;
drh6b308672002-07-08 02:16:37 +00006246 if( i<nOld ){
drhda200cc2004-05-09 11:51:38 +00006247 pNew = apNew[i] = apOld[i];
drh6b308672002-07-08 02:16:37 +00006248 apOld[i] = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00006249 rc = sqlite3PagerWrite(pNew->pDbPage);
drhf5345442007-04-09 12:45:02 +00006250 nNew++;
danielk197728129562005-01-11 10:25:06 +00006251 if( rc ) goto balance_cleanup;
drh6b308672002-07-08 02:16:37 +00006252 }else{
drh7aa8f852006-03-28 00:24:44 +00006253 assert( i>0 );
danielk19774dbaa892009-06-16 16:50:22 +00006254 rc = allocateBtreePage(pBt, &pNew, &pgno, pgno, 0);
drh6b308672002-07-08 02:16:37 +00006255 if( rc ) goto balance_cleanup;
drhda200cc2004-05-09 11:51:38 +00006256 apNew[i] = pNew;
drhf5345442007-04-09 12:45:02 +00006257 nNew++;
danielk19774dbaa892009-06-16 16:50:22 +00006258
6259 /* Set the pointer-map entry for the new sibling page. */
6260 if( ISAUTOVACUUM ){
drh98add2e2009-07-20 17:11:49 +00006261 ptrmapPut(pBt, pNew->pgno, PTRMAP_BTREE, pParent->pgno, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00006262 if( rc!=SQLITE_OK ){
6263 goto balance_cleanup;
6264 }
6265 }
drh6b308672002-07-08 02:16:37 +00006266 }
drh8b2f49b2001-06-08 00:21:52 +00006267 }
6268
danielk1977299b1872004-11-22 10:02:10 +00006269 /* Free any old pages that were not reused as new pages.
6270 */
6271 while( i<nOld ){
drhc314dc72009-07-21 11:52:34 +00006272 freePage(apOld[i], &rc);
danielk1977299b1872004-11-22 10:02:10 +00006273 if( rc ) goto balance_cleanup;
6274 releasePage(apOld[i]);
6275 apOld[i] = 0;
6276 i++;
6277 }
6278
drh8b2f49b2001-06-08 00:21:52 +00006279 /*
drhf9ffac92002-03-02 19:00:31 +00006280 ** Put the new pages in accending order. This helps to
6281 ** keep entries in the disk file in order so that a scan
6282 ** of the table is a linear scan through the file. That
6283 ** in turn helps the operating system to deliver pages
6284 ** from the disk more rapidly.
6285 **
6286 ** An O(n^2) insertion sort algorithm is used, but since
drhc3b70572003-01-04 19:44:07 +00006287 ** n is never more than NB (a small constant), that should
6288 ** not be a problem.
drhf9ffac92002-03-02 19:00:31 +00006289 **
drhc3b70572003-01-04 19:44:07 +00006290 ** When NB==3, this one optimization makes the database
6291 ** about 25% faster for large insertions and deletions.
drhf9ffac92002-03-02 19:00:31 +00006292 */
6293 for(i=0; i<k-1; i++){
danielk19774dbaa892009-06-16 16:50:22 +00006294 int minV = apNew[i]->pgno;
drhf9ffac92002-03-02 19:00:31 +00006295 int minI = i;
6296 for(j=i+1; j<k; j++){
danielk19774dbaa892009-06-16 16:50:22 +00006297 if( apNew[j]->pgno<(unsigned)minV ){
drhf9ffac92002-03-02 19:00:31 +00006298 minI = j;
danielk19774dbaa892009-06-16 16:50:22 +00006299 minV = apNew[j]->pgno;
drhf9ffac92002-03-02 19:00:31 +00006300 }
6301 }
6302 if( minI>i ){
drhf9ffac92002-03-02 19:00:31 +00006303 MemPage *pT;
drhf9ffac92002-03-02 19:00:31 +00006304 pT = apNew[i];
drhf9ffac92002-03-02 19:00:31 +00006305 apNew[i] = apNew[minI];
drhf9ffac92002-03-02 19:00:31 +00006306 apNew[minI] = pT;
6307 }
6308 }
danielk1977e5765212009-06-17 11:13:28 +00006309 TRACE(("new: %d(%d) %d(%d) %d(%d) %d(%d) %d(%d)\n",
danielk19774dbaa892009-06-16 16:50:22 +00006310 apNew[0]->pgno, szNew[0],
6311 nNew>=2 ? apNew[1]->pgno : 0, nNew>=2 ? szNew[1] : 0,
6312 nNew>=3 ? apNew[2]->pgno : 0, nNew>=3 ? szNew[2] : 0,
6313 nNew>=4 ? apNew[3]->pgno : 0, nNew>=4 ? szNew[3] : 0,
6314 nNew>=5 ? apNew[4]->pgno : 0, nNew>=5 ? szNew[4] : 0));
6315
6316 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
6317 put4byte(pRight, apNew[nNew-1]->pgno);
drh24cd67e2004-05-10 16:18:47 +00006318
drhf9ffac92002-03-02 19:00:31 +00006319 /*
drh14acc042001-06-10 19:56:58 +00006320 ** Evenly distribute the data in apCell[] across the new pages.
6321 ** Insert divider cells into pParent as necessary.
6322 */
6323 j = 0;
6324 for(i=0; i<nNew; i++){
danielk1977ac11ee62005-01-15 12:45:51 +00006325 /* Assemble the new sibling page. */
drh14acc042001-06-10 19:56:58 +00006326 MemPage *pNew = apNew[i];
drh19642e52005-03-29 13:17:45 +00006327 assert( j<nMaxCells );
drh10131482008-07-11 03:34:09 +00006328 zeroPage(pNew, pageFlags);
drhfa1a98a2004-05-14 19:08:17 +00006329 assemblePage(pNew, cntNew[i]-j, &apCell[j], &szCell[j]);
drh09d0deb2005-08-02 17:13:09 +00006330 assert( pNew->nCell>0 || (nNew==1 && cntNew[0]==0) );
drh43605152004-05-29 21:46:49 +00006331 assert( pNew->nOverflow==0 );
danielk1977ac11ee62005-01-15 12:45:51 +00006332
danielk1977ac11ee62005-01-15 12:45:51 +00006333 j = cntNew[i];
6334
6335 /* If the sibling page assembled above was not the right-most sibling,
6336 ** insert a divider cell into the parent page.
6337 */
danielk19771c3d2bf2009-06-23 16:40:17 +00006338 assert( i<nNew-1 || j==nCell );
6339 if( j<nCell ){
drh8b18dd42004-05-12 19:18:15 +00006340 u8 *pCell;
drh24cd67e2004-05-10 16:18:47 +00006341 u8 *pTemp;
drh8b18dd42004-05-12 19:18:15 +00006342 int sz;
danielk1977634f2982005-03-28 08:44:07 +00006343
6344 assert( j<nMaxCells );
drh8b18dd42004-05-12 19:18:15 +00006345 pCell = apCell[j];
6346 sz = szCell[j] + leafCorrection;
danielk19776067a9b2009-06-09 09:41:00 +00006347 pTemp = &aOvflSpace[iOvflSpace];
drh4b70f112004-05-02 21:12:19 +00006348 if( !pNew->leaf ){
drh43605152004-05-29 21:46:49 +00006349 memcpy(&pNew->aData[8], pCell, 4);
drh8b18dd42004-05-12 19:18:15 +00006350 }else if( leafData ){
drhfd131da2007-08-07 17:13:03 +00006351 /* If the tree is a leaf-data tree, and the siblings are leaves,
danielk1977ac11ee62005-01-15 12:45:51 +00006352 ** then there is no divider cell in apCell[]. Instead, the divider
6353 ** cell consists of the integer key for the right-most cell of
6354 ** the sibling-page assembled above only.
6355 */
drh6f11bef2004-05-13 01:12:56 +00006356 CellInfo info;
drh8b18dd42004-05-12 19:18:15 +00006357 j--;
danielk197730548662009-07-09 05:07:37 +00006358 btreeParseCellPtr(pNew, apCell[j], &info);
drhe5ae5732008-06-15 02:51:47 +00006359 pCell = pTemp;
danielk19774dbaa892009-06-16 16:50:22 +00006360 sz = 4 + putVarint(&pCell[4], info.nKey);
drh8b18dd42004-05-12 19:18:15 +00006361 pTemp = 0;
drh4b70f112004-05-02 21:12:19 +00006362 }else{
6363 pCell -= 4;
danielk19774aeff622007-05-12 09:30:47 +00006364 /* Obscure case for non-leaf-data trees: If the cell at pCell was
drh85b623f2007-12-13 21:54:09 +00006365 ** previously stored on a leaf node, and its reported size was 4
danielk19774aeff622007-05-12 09:30:47 +00006366 ** bytes, then it may actually be smaller than this
danielk197730548662009-07-09 05:07:37 +00006367 ** (see btreeParseCellPtr(), 4 bytes is the minimum size of
drh85b623f2007-12-13 21:54:09 +00006368 ** any cell). But it is important to pass the correct size to
danielk19774aeff622007-05-12 09:30:47 +00006369 ** insertCell(), so reparse the cell now.
6370 **
6371 ** Note that this can never happen in an SQLite data file, as all
6372 ** cells are at least 4 bytes. It only happens in b-trees used
6373 ** to evaluate "IN (SELECT ...)" and similar clauses.
6374 */
6375 if( szCell[j]==4 ){
6376 assert(leafCorrection==4);
6377 sz = cellSizePtr(pParent, pCell);
6378 }
drh4b70f112004-05-02 21:12:19 +00006379 }
danielk19776067a9b2009-06-09 09:41:00 +00006380 iOvflSpace += sz;
drhe22e03e2010-08-18 21:19:03 +00006381 assert( sz<=pBt->maxLocal+23 );
drhfcd71b62011-04-05 22:08:24 +00006382 assert( iOvflSpace <= (int)pBt->pageSize );
drh98add2e2009-07-20 17:11:49 +00006383 insertCell(pParent, nxDiv, pCell, sz, pTemp, pNew->pgno, &rc);
danielk1977e80463b2004-11-03 03:01:16 +00006384 if( rc!=SQLITE_OK ) goto balance_cleanup;
drhc5053fb2008-11-27 02:22:10 +00006385 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk197785d90ca2008-07-19 14:25:15 +00006386
drh14acc042001-06-10 19:56:58 +00006387 j++;
6388 nxDiv++;
6389 }
6390 }
drh6019e162001-07-02 17:51:45 +00006391 assert( j==nCell );
drh7aa8f852006-03-28 00:24:44 +00006392 assert( nOld>0 );
6393 assert( nNew>0 );
drh4b70f112004-05-02 21:12:19 +00006394 if( (pageFlags & PTF_LEAF)==0 ){
danielk197787c52b52008-07-19 11:49:07 +00006395 u8 *zChild = &apCopy[nOld-1]->aData[8];
6396 memcpy(&apNew[nNew-1]->aData[8], zChild, 4);
drh14acc042001-06-10 19:56:58 +00006397 }
6398
danielk197713bd99f2009-06-24 05:40:34 +00006399 if( isRoot && pParent->nCell==0 && pParent->hdrOffset<=apNew[0]->nFree ){
6400 /* The root page of the b-tree now contains no cells. The only sibling
6401 ** page is the right-child of the parent. Copy the contents of the
6402 ** child page into the parent, decreasing the overall height of the
6403 ** b-tree structure by one. This is described as the "balance-shallower"
6404 ** sub-algorithm in some documentation.
6405 **
6406 ** If this is an auto-vacuum database, the call to copyNodeContent()
6407 ** sets all pointer-map entries corresponding to database image pages
6408 ** for which the pointer is stored within the content being copied.
6409 **
6410 ** The second assert below verifies that the child page is defragmented
6411 ** (it must be, as it was just reconstructed using assemblePage()). This
6412 ** is important if the parent page happens to be page 1 of the database
6413 ** image. */
6414 assert( nNew==1 );
6415 assert( apNew[0]->nFree ==
6416 (get2byte(&apNew[0]->aData[5])-apNew[0]->cellOffset-apNew[0]->nCell*2)
6417 );
drhc314dc72009-07-21 11:52:34 +00006418 copyNodeContent(apNew[0], pParent, &rc);
6419 freePage(apNew[0], &rc);
danielk197713bd99f2009-06-24 05:40:34 +00006420 }else if( ISAUTOVACUUM ){
6421 /* Fix the pointer-map entries for all the cells that were shifted around.
6422 ** There are several different types of pointer-map entries that need to
6423 ** be dealt with by this routine. Some of these have been set already, but
6424 ** many have not. The following is a summary:
6425 **
6426 ** 1) The entries associated with new sibling pages that were not
6427 ** siblings when this function was called. These have already
6428 ** been set. We don't need to worry about old siblings that were
6429 ** moved to the free-list - the freePage() code has taken care
6430 ** of those.
6431 **
6432 ** 2) The pointer-map entries associated with the first overflow
6433 ** page in any overflow chains used by new divider cells. These
6434 ** have also already been taken care of by the insertCell() code.
6435 **
6436 ** 3) If the sibling pages are not leaves, then the child pages of
6437 ** cells stored on the sibling pages may need to be updated.
6438 **
6439 ** 4) If the sibling pages are not internal intkey nodes, then any
6440 ** overflow pages used by these cells may need to be updated
6441 ** (internal intkey nodes never contain pointers to overflow pages).
6442 **
6443 ** 5) If the sibling pages are not leaves, then the pointer-map
6444 ** entries for the right-child pages of each sibling may need
6445 ** to be updated.
6446 **
6447 ** Cases 1 and 2 are dealt with above by other code. The next
6448 ** block deals with cases 3 and 4 and the one after that, case 5. Since
6449 ** setting a pointer map entry is a relatively expensive operation, this
6450 ** code only sets pointer map entries for child or overflow pages that have
6451 ** actually moved between pages. */
danielk19774dbaa892009-06-16 16:50:22 +00006452 MemPage *pNew = apNew[0];
6453 MemPage *pOld = apCopy[0];
6454 int nOverflow = pOld->nOverflow;
6455 int iNextOld = pOld->nCell + nOverflow;
drh2cbd78b2012-02-02 19:37:18 +00006456 int iOverflow = (nOverflow ? pOld->aiOvfl[0] : -1);
danielk19774dbaa892009-06-16 16:50:22 +00006457 j = 0; /* Current 'old' sibling page */
6458 k = 0; /* Current 'new' sibling page */
drhc314dc72009-07-21 11:52:34 +00006459 for(i=0; i<nCell; i++){
danielk19774dbaa892009-06-16 16:50:22 +00006460 int isDivider = 0;
6461 while( i==iNextOld ){
6462 /* Cell i is the cell immediately following the last cell on old
6463 ** sibling page j. If the siblings are not leaf pages of an
6464 ** intkey b-tree, then cell i was a divider cell. */
drhb07028f2011-10-14 21:49:18 +00006465 assert( j+1 < ArraySize(apCopy) );
danielk19774dbaa892009-06-16 16:50:22 +00006466 pOld = apCopy[++j];
6467 iNextOld = i + !leafData + pOld->nCell + pOld->nOverflow;
6468 if( pOld->nOverflow ){
6469 nOverflow = pOld->nOverflow;
drh2cbd78b2012-02-02 19:37:18 +00006470 iOverflow = i + !leafData + pOld->aiOvfl[0];
danielk19774dbaa892009-06-16 16:50:22 +00006471 }
6472 isDivider = !leafData;
6473 }
6474
6475 assert(nOverflow>0 || iOverflow<i );
drh2cbd78b2012-02-02 19:37:18 +00006476 assert(nOverflow<2 || pOld->aiOvfl[0]==pOld->aiOvfl[1]-1);
6477 assert(nOverflow<3 || pOld->aiOvfl[1]==pOld->aiOvfl[2]-1);
danielk19774dbaa892009-06-16 16:50:22 +00006478 if( i==iOverflow ){
6479 isDivider = 1;
6480 if( (--nOverflow)>0 ){
6481 iOverflow++;
6482 }
6483 }
6484
6485 if( i==cntNew[k] ){
6486 /* Cell i is the cell immediately following the last cell on new
6487 ** sibling page k. If the siblings are not leaf pages of an
6488 ** intkey b-tree, then cell i is a divider cell. */
6489 pNew = apNew[++k];
6490 if( !leafData ) continue;
6491 }
danielk19774dbaa892009-06-16 16:50:22 +00006492 assert( j<nOld );
6493 assert( k<nNew );
6494
6495 /* If the cell was originally divider cell (and is not now) or
6496 ** an overflow cell, or if the cell was located on a different sibling
6497 ** page before the balancing, then the pointer map entries associated
6498 ** with any child or overflow pages need to be updated. */
6499 if( isDivider || pOld->pgno!=pNew->pgno ){
6500 if( !leafCorrection ){
drh98add2e2009-07-20 17:11:49 +00006501 ptrmapPut(pBt, get4byte(apCell[i]), PTRMAP_BTREE, pNew->pgno, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00006502 }
drh98add2e2009-07-20 17:11:49 +00006503 if( szCell[i]>pNew->minLocal ){
6504 ptrmapPutOvflPtr(pNew, apCell[i], &rc);
danielk19774dbaa892009-06-16 16:50:22 +00006505 }
6506 }
6507 }
6508
6509 if( !leafCorrection ){
drh98add2e2009-07-20 17:11:49 +00006510 for(i=0; i<nNew; i++){
6511 u32 key = get4byte(&apNew[i]->aData[8]);
6512 ptrmapPut(pBt, key, PTRMAP_BTREE, apNew[i]->pgno, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00006513 }
6514 }
6515
6516#if 0
6517 /* The ptrmapCheckPages() contains assert() statements that verify that
6518 ** all pointer map pages are set correctly. This is helpful while
6519 ** debugging. This is usually disabled because a corrupt database may
6520 ** cause an assert() statement to fail. */
6521 ptrmapCheckPages(apNew, nNew);
6522 ptrmapCheckPages(&pParent, 1);
6523#endif
6524 }
6525
danielk197771d5d2c2008-09-29 11:49:47 +00006526 assert( pParent->isInit );
danielk1977e5765212009-06-17 11:13:28 +00006527 TRACE(("BALANCE: finished: old=%d new=%d cells=%d\n",
6528 nOld, nNew, nCell));
danielk1977cd581a72009-06-23 15:43:39 +00006529
drh8b2f49b2001-06-08 00:21:52 +00006530 /*
drh14acc042001-06-10 19:56:58 +00006531 ** Cleanup before returning.
drh8b2f49b2001-06-08 00:21:52 +00006532 */
drh14acc042001-06-10 19:56:58 +00006533balance_cleanup:
drhfacf0302008-06-17 15:12:00 +00006534 sqlite3ScratchFree(apCell);
drh8b2f49b2001-06-08 00:21:52 +00006535 for(i=0; i<nOld; i++){
drh91025292004-05-03 19:49:32 +00006536 releasePage(apOld[i]);
drh8b2f49b2001-06-08 00:21:52 +00006537 }
drh14acc042001-06-10 19:56:58 +00006538 for(i=0; i<nNew; i++){
drh91025292004-05-03 19:49:32 +00006539 releasePage(apNew[i]);
drh8b2f49b2001-06-08 00:21:52 +00006540 }
danielk1977eaa06f62008-09-18 17:34:44 +00006541
drh8b2f49b2001-06-08 00:21:52 +00006542 return rc;
6543}
6544
drh43605152004-05-29 21:46:49 +00006545
6546/*
danielk1977a50d9aa2009-06-08 14:49:45 +00006547** This function is called when the root page of a b-tree structure is
6548** overfull (has one or more overflow pages).
drh43605152004-05-29 21:46:49 +00006549**
danielk1977a50d9aa2009-06-08 14:49:45 +00006550** A new child page is allocated and the contents of the current root
6551** page, including overflow cells, are copied into the child. The root
6552** page is then overwritten to make it an empty page with the right-child
6553** pointer pointing to the new page.
6554**
6555** Before returning, all pointer-map entries corresponding to pages
6556** that the new child-page now contains pointers to are updated. The
6557** entry corresponding to the new right-child pointer of the root
6558** page is also updated.
6559**
6560** If successful, *ppChild is set to contain a reference to the child
6561** page and SQLITE_OK is returned. In this case the caller is required
6562** to call releasePage() on *ppChild exactly once. If an error occurs,
6563** an error code is returned and *ppChild is set to 0.
drh43605152004-05-29 21:46:49 +00006564*/
danielk1977a50d9aa2009-06-08 14:49:45 +00006565static int balance_deeper(MemPage *pRoot, MemPage **ppChild){
6566 int rc; /* Return value from subprocedures */
6567 MemPage *pChild = 0; /* Pointer to a new child page */
shane5eff7cf2009-08-10 03:57:58 +00006568 Pgno pgnoChild = 0; /* Page number of the new child page */
danielk1977a50d9aa2009-06-08 14:49:45 +00006569 BtShared *pBt = pRoot->pBt; /* The BTree */
drh43605152004-05-29 21:46:49 +00006570
danielk1977a50d9aa2009-06-08 14:49:45 +00006571 assert( pRoot->nOverflow>0 );
drh1fee73e2007-08-29 04:00:57 +00006572 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977bc2ca9e2008-11-13 14:28:28 +00006573
danielk1977a50d9aa2009-06-08 14:49:45 +00006574 /* Make pRoot, the root page of the b-tree, writable. Allocate a new
6575 ** page that will become the new right-child of pPage. Copy the contents
6576 ** of the node stored on pRoot into the new child page.
6577 */
drh98add2e2009-07-20 17:11:49 +00006578 rc = sqlite3PagerWrite(pRoot->pDbPage);
6579 if( rc==SQLITE_OK ){
6580 rc = allocateBtreePage(pBt,&pChild,&pgnoChild,pRoot->pgno,0);
drhc314dc72009-07-21 11:52:34 +00006581 copyNodeContent(pRoot, pChild, &rc);
6582 if( ISAUTOVACUUM ){
6583 ptrmapPut(pBt, pgnoChild, PTRMAP_BTREE, pRoot->pgno, &rc);
drh98add2e2009-07-20 17:11:49 +00006584 }
6585 }
6586 if( rc ){
danielk1977a50d9aa2009-06-08 14:49:45 +00006587 *ppChild = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00006588 releasePage(pChild);
danielk1977a50d9aa2009-06-08 14:49:45 +00006589 return rc;
danielk197771d5d2c2008-09-29 11:49:47 +00006590 }
danielk1977a50d9aa2009-06-08 14:49:45 +00006591 assert( sqlite3PagerIswriteable(pChild->pDbPage) );
6592 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
6593 assert( pChild->nCell==pRoot->nCell );
danielk197771d5d2c2008-09-29 11:49:47 +00006594
danielk1977a50d9aa2009-06-08 14:49:45 +00006595 TRACE(("BALANCE: copy root %d into %d\n", pRoot->pgno, pChild->pgno));
6596
6597 /* Copy the overflow cells from pRoot to pChild */
drh2cbd78b2012-02-02 19:37:18 +00006598 memcpy(pChild->aiOvfl, pRoot->aiOvfl,
6599 pRoot->nOverflow*sizeof(pRoot->aiOvfl[0]));
6600 memcpy(pChild->apOvfl, pRoot->apOvfl,
6601 pRoot->nOverflow*sizeof(pRoot->apOvfl[0]));
danielk1977a50d9aa2009-06-08 14:49:45 +00006602 pChild->nOverflow = pRoot->nOverflow;
danielk1977a50d9aa2009-06-08 14:49:45 +00006603
6604 /* Zero the contents of pRoot. Then install pChild as the right-child. */
6605 zeroPage(pRoot, pChild->aData[0] & ~PTF_LEAF);
6606 put4byte(&pRoot->aData[pRoot->hdrOffset+8], pgnoChild);
6607
6608 *ppChild = pChild;
6609 return SQLITE_OK;
drh43605152004-05-29 21:46:49 +00006610}
6611
6612/*
danielk197771d5d2c2008-09-29 11:49:47 +00006613** The page that pCur currently points to has just been modified in
6614** some way. This function figures out if this modification means the
6615** tree needs to be balanced, and if so calls the appropriate balancing
danielk1977a50d9aa2009-06-08 14:49:45 +00006616** routine. Balancing routines are:
6617**
6618** balance_quick()
danielk1977a50d9aa2009-06-08 14:49:45 +00006619** balance_deeper()
6620** balance_nonroot()
drh43605152004-05-29 21:46:49 +00006621*/
danielk1977a50d9aa2009-06-08 14:49:45 +00006622static int balance(BtCursor *pCur){
drh43605152004-05-29 21:46:49 +00006623 int rc = SQLITE_OK;
danielk1977a50d9aa2009-06-08 14:49:45 +00006624 const int nMin = pCur->pBt->usableSize * 2 / 3;
6625 u8 aBalanceQuickSpace[13];
6626 u8 *pFree = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00006627
shane75ac1de2009-06-09 18:58:52 +00006628 TESTONLY( int balance_quick_called = 0 );
6629 TESTONLY( int balance_deeper_called = 0 );
danielk1977a50d9aa2009-06-08 14:49:45 +00006630
6631 do {
6632 int iPage = pCur->iPage;
6633 MemPage *pPage = pCur->apPage[iPage];
6634
6635 if( iPage==0 ){
6636 if( pPage->nOverflow ){
6637 /* The root page of the b-tree is overfull. In this case call the
6638 ** balance_deeper() function to create a new child for the root-page
6639 ** and copy the current contents of the root-page to it. The
6640 ** next iteration of the do-loop will balance the child page.
6641 */
6642 assert( (balance_deeper_called++)==0 );
6643 rc = balance_deeper(pPage, &pCur->apPage[1]);
6644 if( rc==SQLITE_OK ){
6645 pCur->iPage = 1;
6646 pCur->aiIdx[0] = 0;
6647 pCur->aiIdx[1] = 0;
6648 assert( pCur->apPage[1]->nOverflow );
6649 }
danielk1977a50d9aa2009-06-08 14:49:45 +00006650 }else{
danielk1977a50d9aa2009-06-08 14:49:45 +00006651 break;
6652 }
6653 }else if( pPage->nOverflow==0 && pPage->nFree<=nMin ){
6654 break;
6655 }else{
6656 MemPage * const pParent = pCur->apPage[iPage-1];
6657 int const iIdx = pCur->aiIdx[iPage-1];
6658
6659 rc = sqlite3PagerWrite(pParent->pDbPage);
6660 if( rc==SQLITE_OK ){
6661#ifndef SQLITE_OMIT_QUICKBALANCE
6662 if( pPage->hasData
6663 && pPage->nOverflow==1
drh2cbd78b2012-02-02 19:37:18 +00006664 && pPage->aiOvfl[0]==pPage->nCell
danielk1977a50d9aa2009-06-08 14:49:45 +00006665 && pParent->pgno!=1
6666 && pParent->nCell==iIdx
6667 ){
6668 /* Call balance_quick() to create a new sibling of pPage on which
6669 ** to store the overflow cell. balance_quick() inserts a new cell
6670 ** into pParent, which may cause pParent overflow. If this
6671 ** happens, the next interation of the do-loop will balance pParent
6672 ** use either balance_nonroot() or balance_deeper(). Until this
6673 ** happens, the overflow cell is stored in the aBalanceQuickSpace[]
6674 ** buffer.
6675 **
6676 ** The purpose of the following assert() is to check that only a
6677 ** single call to balance_quick() is made for each call to this
6678 ** function. If this were not verified, a subtle bug involving reuse
6679 ** of the aBalanceQuickSpace[] might sneak in.
6680 */
6681 assert( (balance_quick_called++)==0 );
6682 rc = balance_quick(pParent, pPage, aBalanceQuickSpace);
6683 }else
6684#endif
6685 {
6686 /* In this case, call balance_nonroot() to redistribute cells
6687 ** between pPage and up to 2 of its sibling pages. This involves
6688 ** modifying the contents of pParent, which may cause pParent to
6689 ** become overfull or underfull. The next iteration of the do-loop
6690 ** will balance the parent page to correct this.
6691 **
6692 ** If the parent page becomes overfull, the overflow cell or cells
6693 ** are stored in the pSpace buffer allocated immediately below.
6694 ** A subsequent iteration of the do-loop will deal with this by
6695 ** calling balance_nonroot() (balance_deeper() may be called first,
6696 ** but it doesn't deal with overflow cells - just moves them to a
6697 ** different page). Once this subsequent call to balance_nonroot()
6698 ** has completed, it is safe to release the pSpace buffer used by
6699 ** the previous call, as the overflow cell data will have been
6700 ** copied either into the body of a database page or into the new
6701 ** pSpace buffer passed to the latter call to balance_nonroot().
6702 */
6703 u8 *pSpace = sqlite3PageMalloc(pCur->pBt->pageSize);
danielk1977cd581a72009-06-23 15:43:39 +00006704 rc = balance_nonroot(pParent, iIdx, pSpace, iPage==1);
danielk1977a50d9aa2009-06-08 14:49:45 +00006705 if( pFree ){
6706 /* If pFree is not NULL, it points to the pSpace buffer used
6707 ** by a previous call to balance_nonroot(). Its contents are
6708 ** now stored either on real database pages or within the
6709 ** new pSpace buffer, so it may be safely freed here. */
6710 sqlite3PageFree(pFree);
6711 }
6712
danielk19774dbaa892009-06-16 16:50:22 +00006713 /* The pSpace buffer will be freed after the next call to
6714 ** balance_nonroot(), or just before this function returns, whichever
6715 ** comes first. */
danielk1977a50d9aa2009-06-08 14:49:45 +00006716 pFree = pSpace;
danielk1977a50d9aa2009-06-08 14:49:45 +00006717 }
6718 }
6719
6720 pPage->nOverflow = 0;
6721
6722 /* The next iteration of the do-loop balances the parent page. */
6723 releasePage(pPage);
6724 pCur->iPage--;
drh43605152004-05-29 21:46:49 +00006725 }
danielk1977a50d9aa2009-06-08 14:49:45 +00006726 }while( rc==SQLITE_OK );
6727
6728 if( pFree ){
6729 sqlite3PageFree(pFree);
drh43605152004-05-29 21:46:49 +00006730 }
6731 return rc;
6732}
6733
drhf74b8d92002-09-01 23:20:45 +00006734
6735/*
drh3b7511c2001-05-26 13:15:44 +00006736** Insert a new record into the BTree. The key is given by (pKey,nKey)
6737** and the data is given by (pData,nData). The cursor is used only to
drh91025292004-05-03 19:49:32 +00006738** define what table the record should be inserted into. The cursor
drh4b70f112004-05-02 21:12:19 +00006739** is left pointing at a random location.
6740**
6741** For an INTKEY table, only the nKey value of the key is used. pKey is
6742** ignored. For a ZERODATA table, the pData and nData are both ignored.
danielk1977de630352009-05-04 11:42:29 +00006743**
6744** If the seekResult parameter is non-zero, then a successful call to
danielk19773509a652009-07-06 18:56:13 +00006745** MovetoUnpacked() to seek cursor pCur to (pKey, nKey) has already
danielk1977de630352009-05-04 11:42:29 +00006746** been performed. seekResult is the search result returned (a negative
6747** number if pCur points at an entry that is smaller than (pKey, nKey), or
6748** a positive value if pCur points at an etry that is larger than
6749** (pKey, nKey)).
6750**
drh3e9ca092009-09-08 01:14:48 +00006751** If the seekResult parameter is non-zero, then the caller guarantees that
6752** cursor pCur is pointing at the existing copy of a row that is to be
6753** overwritten. If the seekResult parameter is 0, then cursor pCur may
6754** point to any entry or to no entry at all and so this function has to seek
danielk1977de630352009-05-04 11:42:29 +00006755** the cursor before the new key can be inserted.
drh3b7511c2001-05-26 13:15:44 +00006756*/
drh3aac2dd2004-04-26 14:10:20 +00006757int sqlite3BtreeInsert(
drh5c4d9702001-08-20 00:33:58 +00006758 BtCursor *pCur, /* Insert data into the table of this cursor */
drh4a1c3802004-05-12 15:15:47 +00006759 const void *pKey, i64 nKey, /* The key of the new record */
drhe4d90812007-03-29 05:51:49 +00006760 const void *pData, int nData, /* The data of the new record */
drhb026e052007-05-02 01:34:31 +00006761 int nZero, /* Number of extra 0 bytes to append to data */
danielk1977de630352009-05-04 11:42:29 +00006762 int appendBias, /* True if this is likely an append */
danielk19773509a652009-07-06 18:56:13 +00006763 int seekResult /* Result of prior MovetoUnpacked() call */
drh3b7511c2001-05-26 13:15:44 +00006764){
drh3b7511c2001-05-26 13:15:44 +00006765 int rc;
drh3e9ca092009-09-08 01:14:48 +00006766 int loc = seekResult; /* -1: before desired location +1: after */
drh1d452e12009-11-01 19:26:59 +00006767 int szNew = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00006768 int idx;
drh3b7511c2001-05-26 13:15:44 +00006769 MemPage *pPage;
drhd677b3d2007-08-20 22:48:41 +00006770 Btree *p = pCur->pBtree;
6771 BtShared *pBt = p->pBt;
drha34b6762004-05-07 13:30:42 +00006772 unsigned char *oldCell;
drh2e38c322004-09-03 18:38:44 +00006773 unsigned char *newCell = 0;
drh3b7511c2001-05-26 13:15:44 +00006774
drh98add2e2009-07-20 17:11:49 +00006775 if( pCur->eState==CURSOR_FAULT ){
6776 assert( pCur->skipNext!=SQLITE_OK );
6777 return pCur->skipNext;
6778 }
6779
drh1fee73e2007-08-29 04:00:57 +00006780 assert( cursorHoldsMutex(pCur) );
drhc9166342012-01-05 23:32:06 +00006781 assert( pCur->wrFlag && pBt->inTransaction==TRANS_WRITE
6782 && (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk197796d48e92009-06-29 06:00:37 +00006783 assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
6784
danielk197731d31b82009-07-13 13:18:07 +00006785 /* Assert that the caller has been consistent. If this cursor was opened
6786 ** expecting an index b-tree, then the caller should be inserting blob
6787 ** keys with no associated data. If the cursor was opened expecting an
6788 ** intkey table, the caller should be inserting integer keys with a
6789 ** blob of associated data. */
6790 assert( (pKey==0)==(pCur->pKeyInfo==0) );
6791
danielk197796d48e92009-06-29 06:00:37 +00006792 /* If this is an insert into a table b-tree, invalidate any incrblob
6793 ** cursors open on the row being replaced (assuming this is a replace
6794 ** operation - if it is not, the following is a no-op). */
6795 if( pCur->pKeyInfo==0 ){
drheeb844a2009-08-08 18:01:07 +00006796 invalidateIncrblobCursors(p, nKey, 0);
drhf74b8d92002-09-01 23:20:45 +00006797 }
danielk197796d48e92009-06-29 06:00:37 +00006798
danielk19779c3acf32009-05-02 07:36:49 +00006799 /* Save the positions of any other cursors open on this table.
6800 **
danielk19773509a652009-07-06 18:56:13 +00006801 ** In some cases, the call to btreeMoveto() below is a no-op. For
danielk19779c3acf32009-05-02 07:36:49 +00006802 ** example, when inserting data into a table with auto-generated integer
6803 ** keys, the VDBE layer invokes sqlite3BtreeLast() to figure out the
6804 ** integer key to use. It then calls this function to actually insert the
danielk19773509a652009-07-06 18:56:13 +00006805 ** data into the intkey B-Tree. In this case btreeMoveto() recognizes
danielk19779c3acf32009-05-02 07:36:49 +00006806 ** that the cursor is already where it needs to be and returns without
6807 ** doing any work. To avoid thwarting these optimizations, it is important
6808 ** not to clear the cursor here.
6809 */
drh4c301aa2009-07-15 17:25:45 +00006810 rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
6811 if( rc ) return rc;
6812 if( !loc ){
6813 rc = btreeMoveto(pCur, pKey, nKey, appendBias, &loc);
6814 if( rc ) return rc;
danielk1977da184232006-01-05 11:34:32 +00006815 }
danielk1977b980d2212009-06-22 18:03:51 +00006816 assert( pCur->eState==CURSOR_VALID || (pCur->eState==CURSOR_INVALID && loc) );
danielk1977da184232006-01-05 11:34:32 +00006817
danielk197771d5d2c2008-09-29 11:49:47 +00006818 pPage = pCur->apPage[pCur->iPage];
drh4a1c3802004-05-12 15:15:47 +00006819 assert( pPage->intKey || nKey>=0 );
drh44845222008-07-17 18:39:57 +00006820 assert( pPage->leaf || !pPage->intKey );
danielk19778f880a82009-07-13 09:41:45 +00006821
drh3a4c1412004-05-09 20:40:11 +00006822 TRACE(("INSERT: table=%d nkey=%lld ndata=%d page=%d %s\n",
6823 pCur->pgnoRoot, nKey, nData, pPage->pgno,
6824 loc==0 ? "overwrite" : "new entry"));
danielk197771d5d2c2008-09-29 11:49:47 +00006825 assert( pPage->isInit );
danielk197752ae7242008-03-25 14:24:56 +00006826 allocateTempSpace(pBt);
6827 newCell = pBt->pTmpSpace;
drh2e38c322004-09-03 18:38:44 +00006828 if( newCell==0 ) return SQLITE_NOMEM;
drhb026e052007-05-02 01:34:31 +00006829 rc = fillInCell(pPage, newCell, pKey, nKey, pData, nData, nZero, &szNew);
drh2e38c322004-09-03 18:38:44 +00006830 if( rc ) goto end_insert;
drh43605152004-05-29 21:46:49 +00006831 assert( szNew==cellSizePtr(pPage, newCell) );
drhfcd71b62011-04-05 22:08:24 +00006832 assert( szNew <= MX_CELL_SIZE(pBt) );
danielk197771d5d2c2008-09-29 11:49:47 +00006833 idx = pCur->aiIdx[pCur->iPage];
danielk1977b980d2212009-06-22 18:03:51 +00006834 if( loc==0 ){
drha9121e42008-02-19 14:59:35 +00006835 u16 szOld;
danielk197771d5d2c2008-09-29 11:49:47 +00006836 assert( idx<pPage->nCell );
danielk19776e465eb2007-08-21 13:11:00 +00006837 rc = sqlite3PagerWrite(pPage->pDbPage);
6838 if( rc ){
6839 goto end_insert;
6840 }
danielk197771d5d2c2008-09-29 11:49:47 +00006841 oldCell = findCell(pPage, idx);
drh4b70f112004-05-02 21:12:19 +00006842 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00006843 memcpy(newCell, oldCell, 4);
drh4b70f112004-05-02 21:12:19 +00006844 }
drh43605152004-05-29 21:46:49 +00006845 szOld = cellSizePtr(pPage, oldCell);
drh4b70f112004-05-02 21:12:19 +00006846 rc = clearCell(pPage, oldCell);
drh98add2e2009-07-20 17:11:49 +00006847 dropCell(pPage, idx, szOld, &rc);
drh2e38c322004-09-03 18:38:44 +00006848 if( rc ) goto end_insert;
drh7c717f72001-06-24 20:39:41 +00006849 }else if( loc<0 && pPage->nCell>0 ){
drh4b70f112004-05-02 21:12:19 +00006850 assert( pPage->leaf );
danielk197771d5d2c2008-09-29 11:49:47 +00006851 idx = ++pCur->aiIdx[pCur->iPage];
drh14acc042001-06-10 19:56:58 +00006852 }else{
drh4b70f112004-05-02 21:12:19 +00006853 assert( pPage->leaf );
drh3b7511c2001-05-26 13:15:44 +00006854 }
drh98add2e2009-07-20 17:11:49 +00006855 insertCell(pPage, idx, newCell, szNew, 0, 0, &rc);
danielk19773f632d52009-05-02 10:03:09 +00006856 assert( rc!=SQLITE_OK || pPage->nCell>0 || pPage->nOverflow>0 );
drh9bf9e9c2008-12-05 20:01:43 +00006857
danielk1977a50d9aa2009-06-08 14:49:45 +00006858 /* If no error has occured and pPage has an overflow cell, call balance()
6859 ** to redistribute the cells within the tree. Since balance() may move
6860 ** the cursor, zero the BtCursor.info.nSize and BtCursor.validNKey
6861 ** variables.
danielk19773f632d52009-05-02 10:03:09 +00006862 **
danielk1977a50d9aa2009-06-08 14:49:45 +00006863 ** Previous versions of SQLite called moveToRoot() to move the cursor
6864 ** back to the root page as balance() used to invalidate the contents
danielk197754109bb2009-06-23 11:22:29 +00006865 ** of BtCursor.apPage[] and BtCursor.aiIdx[]. Instead of doing that,
6866 ** set the cursor state to "invalid". This makes common insert operations
6867 ** slightly faster.
danielk19773f632d52009-05-02 10:03:09 +00006868 **
danielk1977a50d9aa2009-06-08 14:49:45 +00006869 ** There is a subtle but important optimization here too. When inserting
6870 ** multiple records into an intkey b-tree using a single cursor (as can
6871 ** happen while processing an "INSERT INTO ... SELECT" statement), it
6872 ** is advantageous to leave the cursor pointing to the last entry in
6873 ** the b-tree if possible. If the cursor is left pointing to the last
6874 ** entry in the table, and the next row inserted has an integer key
6875 ** larger than the largest existing key, it is possible to insert the
6876 ** row without seeking the cursor. This can be a big performance boost.
danielk19773f632d52009-05-02 10:03:09 +00006877 */
danielk1977a50d9aa2009-06-08 14:49:45 +00006878 pCur->info.nSize = 0;
6879 pCur->validNKey = 0;
6880 if( rc==SQLITE_OK && pPage->nOverflow ){
danielk1977a50d9aa2009-06-08 14:49:45 +00006881 rc = balance(pCur);
6882
6883 /* Must make sure nOverflow is reset to zero even if the balance()
danielk197754109bb2009-06-23 11:22:29 +00006884 ** fails. Internal data structure corruption will result otherwise.
6885 ** Also, set the cursor state to invalid. This stops saveCursorPosition()
6886 ** from trying to save the current position of the cursor. */
danielk1977a50d9aa2009-06-08 14:49:45 +00006887 pCur->apPage[pCur->iPage]->nOverflow = 0;
danielk197754109bb2009-06-23 11:22:29 +00006888 pCur->eState = CURSOR_INVALID;
danielk19773f632d52009-05-02 10:03:09 +00006889 }
danielk1977a50d9aa2009-06-08 14:49:45 +00006890 assert( pCur->apPage[pCur->iPage]->nOverflow==0 );
drh9bf9e9c2008-12-05 20:01:43 +00006891
drh2e38c322004-09-03 18:38:44 +00006892end_insert:
drh5e2f8b92001-05-28 00:41:15 +00006893 return rc;
6894}
6895
6896/*
drh4b70f112004-05-02 21:12:19 +00006897** Delete the entry that the cursor is pointing to. The cursor
drhf94a1732008-09-30 17:18:17 +00006898** is left pointing at a arbitrary location.
drh3b7511c2001-05-26 13:15:44 +00006899*/
drh3aac2dd2004-04-26 14:10:20 +00006900int sqlite3BtreeDelete(BtCursor *pCur){
drhd677b3d2007-08-20 22:48:41 +00006901 Btree *p = pCur->pBtree;
danielk19774dbaa892009-06-16 16:50:22 +00006902 BtShared *pBt = p->pBt;
6903 int rc; /* Return code */
6904 MemPage *pPage; /* Page to delete cell from */
6905 unsigned char *pCell; /* Pointer to cell to delete */
6906 int iCellIdx; /* Index of cell to delete */
6907 int iCellDepth; /* Depth of node containing pCell */
drh8b2f49b2001-06-08 00:21:52 +00006908
drh1fee73e2007-08-29 04:00:57 +00006909 assert( cursorHoldsMutex(pCur) );
drh64022502009-01-09 14:11:04 +00006910 assert( pBt->inTransaction==TRANS_WRITE );
drhc9166342012-01-05 23:32:06 +00006911 assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
drh64022502009-01-09 14:11:04 +00006912 assert( pCur->wrFlag );
danielk197796d48e92009-06-29 06:00:37 +00006913 assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
6914 assert( !hasReadConflicts(p, pCur->pgnoRoot) );
6915
danielk19774dbaa892009-06-16 16:50:22 +00006916 if( NEVER(pCur->aiIdx[pCur->iPage]>=pCur->apPage[pCur->iPage]->nCell)
6917 || NEVER(pCur->eState!=CURSOR_VALID)
6918 ){
6919 return SQLITE_ERROR; /* Something has gone awry. */
drhf74b8d92002-09-01 23:20:45 +00006920 }
danielk1977da184232006-01-05 11:34:32 +00006921
danielk197796d48e92009-06-29 06:00:37 +00006922 /* If this is a delete operation to remove a row from a table b-tree,
6923 ** invalidate any incrblob cursors open on the row being deleted. */
6924 if( pCur->pKeyInfo==0 ){
drheeb844a2009-08-08 18:01:07 +00006925 invalidateIncrblobCursors(p, pCur->info.nKey, 0);
danielk19774dbaa892009-06-16 16:50:22 +00006926 }
6927
6928 iCellDepth = pCur->iPage;
6929 iCellIdx = pCur->aiIdx[iCellDepth];
6930 pPage = pCur->apPage[iCellDepth];
6931 pCell = findCell(pPage, iCellIdx);
6932
6933 /* If the page containing the entry to delete is not a leaf page, move
6934 ** the cursor to the largest entry in the tree that is smaller than
6935 ** the entry being deleted. This cell will replace the cell being deleted
6936 ** from the internal node. The 'previous' entry is used for this instead
6937 ** of the 'next' entry, as the previous entry is always a part of the
6938 ** sub-tree headed by the child page of the cell being deleted. This makes
6939 ** balancing the tree following the delete operation easier. */
6940 if( !pPage->leaf ){
6941 int notUsed;
drh4c301aa2009-07-15 17:25:45 +00006942 rc = sqlite3BtreePrevious(pCur, &notUsed);
6943 if( rc ) return rc;
danielk19774dbaa892009-06-16 16:50:22 +00006944 }
6945
6946 /* Save the positions of any other cursors open on this table before
6947 ** making any modifications. Make the page containing the entry to be
6948 ** deleted writable. Then free any overflow pages associated with the
drha4ec1d42009-07-11 13:13:11 +00006949 ** entry and finally remove the cell itself from within the page.
6950 */
6951 rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
6952 if( rc ) return rc;
6953 rc = sqlite3PagerWrite(pPage->pDbPage);
6954 if( rc ) return rc;
6955 rc = clearCell(pPage, pCell);
drh98add2e2009-07-20 17:11:49 +00006956 dropCell(pPage, iCellIdx, cellSizePtr(pPage, pCell), &rc);
drha4ec1d42009-07-11 13:13:11 +00006957 if( rc ) return rc;
danielk1977e6efa742004-11-10 11:55:10 +00006958
danielk19774dbaa892009-06-16 16:50:22 +00006959 /* If the cell deleted was not located on a leaf page, then the cursor
6960 ** is currently pointing to the largest entry in the sub-tree headed
6961 ** by the child-page of the cell that was just deleted from an internal
6962 ** node. The cell from the leaf node needs to be moved to the internal
6963 ** node to replace the deleted cell. */
drh4b70f112004-05-02 21:12:19 +00006964 if( !pPage->leaf ){
danielk19774dbaa892009-06-16 16:50:22 +00006965 MemPage *pLeaf = pCur->apPage[pCur->iPage];
6966 int nCell;
6967 Pgno n = pCur->apPage[iCellDepth+1]->pgno;
6968 unsigned char *pTmp;
danielk1977e6efa742004-11-10 11:55:10 +00006969
danielk19774dbaa892009-06-16 16:50:22 +00006970 pCell = findCell(pLeaf, pLeaf->nCell-1);
6971 nCell = cellSizePtr(pLeaf, pCell);
drhfcd71b62011-04-05 22:08:24 +00006972 assert( MX_CELL_SIZE(pBt) >= nCell );
danielk197771d5d2c2008-09-29 11:49:47 +00006973
danielk19774dbaa892009-06-16 16:50:22 +00006974 allocateTempSpace(pBt);
6975 pTmp = pBt->pTmpSpace;
danielk19772f78fc62008-09-30 09:31:45 +00006976
drha4ec1d42009-07-11 13:13:11 +00006977 rc = sqlite3PagerWrite(pLeaf->pDbPage);
drh98add2e2009-07-20 17:11:49 +00006978 insertCell(pPage, iCellIdx, pCell-4, nCell+4, pTmp, n, &rc);
6979 dropCell(pLeaf, pLeaf->nCell-1, nCell, &rc);
drha4ec1d42009-07-11 13:13:11 +00006980 if( rc ) return rc;
drh5e2f8b92001-05-28 00:41:15 +00006981 }
danielk19774dbaa892009-06-16 16:50:22 +00006982
6983 /* Balance the tree. If the entry deleted was located on a leaf page,
6984 ** then the cursor still points to that page. In this case the first
6985 ** call to balance() repairs the tree, and the if(...) condition is
6986 ** never true.
6987 **
6988 ** Otherwise, if the entry deleted was on an internal node page, then
6989 ** pCur is pointing to the leaf page from which a cell was removed to
6990 ** replace the cell deleted from the internal node. This is slightly
6991 ** tricky as the leaf node may be underfull, and the internal node may
6992 ** be either under or overfull. In this case run the balancing algorithm
6993 ** on the leaf node first. If the balance proceeds far enough up the
6994 ** tree that we can be sure that any problem in the internal node has
6995 ** been corrected, so be it. Otherwise, after balancing the leaf node,
6996 ** walk the cursor up the tree to the internal node and balance it as
6997 ** well. */
6998 rc = balance(pCur);
6999 if( rc==SQLITE_OK && pCur->iPage>iCellDepth ){
7000 while( pCur->iPage>iCellDepth ){
7001 releasePage(pCur->apPage[pCur->iPage--]);
7002 }
7003 rc = balance(pCur);
7004 }
7005
danielk19776b456a22005-03-21 04:04:02 +00007006 if( rc==SQLITE_OK ){
7007 moveToRoot(pCur);
7008 }
drh5e2f8b92001-05-28 00:41:15 +00007009 return rc;
drh3b7511c2001-05-26 13:15:44 +00007010}
drh8b2f49b2001-06-08 00:21:52 +00007011
7012/*
drhc6b52df2002-01-04 03:09:29 +00007013** Create a new BTree table. Write into *piTable the page
7014** number for the root page of the new table.
7015**
drhab01f612004-05-22 02:55:23 +00007016** The type of type is determined by the flags parameter. Only the
7017** following values of flags are currently in use. Other values for
7018** flags might not work:
7019**
7020** BTREE_INTKEY|BTREE_LEAFDATA Used for SQL tables with rowid keys
7021** BTREE_ZERODATA Used for SQL indices
drh8b2f49b2001-06-08 00:21:52 +00007022*/
drhd4187c72010-08-30 22:15:45 +00007023static int btreeCreateTable(Btree *p, int *piTable, int createTabFlags){
danielk1977aef0bf62005-12-30 16:28:01 +00007024 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00007025 MemPage *pRoot;
7026 Pgno pgnoRoot;
7027 int rc;
drhd4187c72010-08-30 22:15:45 +00007028 int ptfFlags; /* Page-type flage for the root page of new table */
drhd677b3d2007-08-20 22:48:41 +00007029
drh1fee73e2007-08-29 04:00:57 +00007030 assert( sqlite3BtreeHoldsMutex(p) );
drh64022502009-01-09 14:11:04 +00007031 assert( pBt->inTransaction==TRANS_WRITE );
drhc9166342012-01-05 23:32:06 +00007032 assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk1977e6efa742004-11-10 11:55:10 +00007033
danielk1977003ba062004-11-04 02:57:33 +00007034#ifdef SQLITE_OMIT_AUTOVACUUM
drh4f0c5872007-03-26 22:05:01 +00007035 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
drhd677b3d2007-08-20 22:48:41 +00007036 if( rc ){
7037 return rc;
7038 }
danielk1977003ba062004-11-04 02:57:33 +00007039#else
danielk1977687566d2004-11-02 12:56:41 +00007040 if( pBt->autoVacuum ){
danielk1977003ba062004-11-04 02:57:33 +00007041 Pgno pgnoMove; /* Move a page here to make room for the root-page */
7042 MemPage *pPageMove; /* The page to move to. */
7043
danielk197720713f32007-05-03 11:43:33 +00007044 /* Creating a new table may probably require moving an existing database
7045 ** to make room for the new tables root page. In case this page turns
7046 ** out to be an overflow page, delete all overflow page-map caches
7047 ** held by open cursors.
7048 */
danielk197792d4d7a2007-05-04 12:05:56 +00007049 invalidateAllOverflowCache(pBt);
danielk197720713f32007-05-03 11:43:33 +00007050
danielk1977003ba062004-11-04 02:57:33 +00007051 /* Read the value of meta[3] from the database to determine where the
7052 ** root page of the new table should go. meta[3] is the largest root-page
7053 ** created so far, so the new root-page is (meta[3]+1).
7054 */
danielk1977602b4662009-07-02 07:47:33 +00007055 sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &pgnoRoot);
danielk1977003ba062004-11-04 02:57:33 +00007056 pgnoRoot++;
7057
danielk1977599fcba2004-11-08 07:13:13 +00007058 /* The new root-page may not be allocated on a pointer-map page, or the
7059 ** PENDING_BYTE page.
7060 */
drh72190432008-01-31 14:54:43 +00007061 while( pgnoRoot==PTRMAP_PAGENO(pBt, pgnoRoot) ||
danielk1977599fcba2004-11-08 07:13:13 +00007062 pgnoRoot==PENDING_BYTE_PAGE(pBt) ){
danielk1977003ba062004-11-04 02:57:33 +00007063 pgnoRoot++;
7064 }
7065 assert( pgnoRoot>=3 );
7066
7067 /* Allocate a page. The page that currently resides at pgnoRoot will
7068 ** be moved to the allocated page (unless the allocated page happens
7069 ** to reside at pgnoRoot).
7070 */
drh4f0c5872007-03-26 22:05:01 +00007071 rc = allocateBtreePage(pBt, &pPageMove, &pgnoMove, pgnoRoot, 1);
danielk1977003ba062004-11-04 02:57:33 +00007072 if( rc!=SQLITE_OK ){
danielk1977687566d2004-11-02 12:56:41 +00007073 return rc;
7074 }
danielk1977003ba062004-11-04 02:57:33 +00007075
7076 if( pgnoMove!=pgnoRoot ){
danielk1977f35843b2007-04-07 15:03:17 +00007077 /* pgnoRoot is the page that will be used for the root-page of
7078 ** the new table (assuming an error did not occur). But we were
7079 ** allocated pgnoMove. If required (i.e. if it was not allocated
7080 ** by extending the file), the current page at position pgnoMove
7081 ** is already journaled.
7082 */
drheeb844a2009-08-08 18:01:07 +00007083 u8 eType = 0;
7084 Pgno iPtrPage = 0;
danielk1977003ba062004-11-04 02:57:33 +00007085
7086 releasePage(pPageMove);
danielk1977f35843b2007-04-07 15:03:17 +00007087
7088 /* Move the page currently at pgnoRoot to pgnoMove. */
danielk197730548662009-07-09 05:07:37 +00007089 rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00007090 if( rc!=SQLITE_OK ){
7091 return rc;
7092 }
7093 rc = ptrmapGet(pBt, pgnoRoot, &eType, &iPtrPage);
drh27731d72009-06-22 12:05:10 +00007094 if( eType==PTRMAP_ROOTPAGE || eType==PTRMAP_FREEPAGE ){
7095 rc = SQLITE_CORRUPT_BKPT;
7096 }
7097 if( rc!=SQLITE_OK ){
danielk1977003ba062004-11-04 02:57:33 +00007098 releasePage(pRoot);
7099 return rc;
7100 }
drhccae6022005-02-26 17:31:26 +00007101 assert( eType!=PTRMAP_ROOTPAGE );
7102 assert( eType!=PTRMAP_FREEPAGE );
danielk19774c999992008-07-16 18:17:55 +00007103 rc = relocatePage(pBt, pRoot, eType, iPtrPage, pgnoMove, 0);
danielk1977003ba062004-11-04 02:57:33 +00007104 releasePage(pRoot);
danielk1977f35843b2007-04-07 15:03:17 +00007105
7106 /* Obtain the page at pgnoRoot */
danielk1977003ba062004-11-04 02:57:33 +00007107 if( rc!=SQLITE_OK ){
7108 return rc;
7109 }
danielk197730548662009-07-09 05:07:37 +00007110 rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00007111 if( rc!=SQLITE_OK ){
7112 return rc;
7113 }
danielk19773b8a05f2007-03-19 17:44:26 +00007114 rc = sqlite3PagerWrite(pRoot->pDbPage);
danielk1977003ba062004-11-04 02:57:33 +00007115 if( rc!=SQLITE_OK ){
7116 releasePage(pRoot);
7117 return rc;
7118 }
7119 }else{
7120 pRoot = pPageMove;
7121 }
7122
danielk197742741be2005-01-08 12:42:39 +00007123 /* Update the pointer-map and meta-data with the new root-page number. */
drh98add2e2009-07-20 17:11:49 +00007124 ptrmapPut(pBt, pgnoRoot, PTRMAP_ROOTPAGE, 0, &rc);
danielk1977003ba062004-11-04 02:57:33 +00007125 if( rc ){
7126 releasePage(pRoot);
7127 return rc;
7128 }
drhbf592832010-03-30 15:51:12 +00007129
7130 /* When the new root page was allocated, page 1 was made writable in
7131 ** order either to increase the database filesize, or to decrement the
7132 ** freelist count. Hence, the sqlite3BtreeUpdateMeta() call cannot fail.
7133 */
7134 assert( sqlite3PagerIswriteable(pBt->pPage1->pDbPage) );
danielk1977aef0bf62005-12-30 16:28:01 +00007135 rc = sqlite3BtreeUpdateMeta(p, 4, pgnoRoot);
drhbf592832010-03-30 15:51:12 +00007136 if( NEVER(rc) ){
danielk1977003ba062004-11-04 02:57:33 +00007137 releasePage(pRoot);
7138 return rc;
7139 }
danielk197742741be2005-01-08 12:42:39 +00007140
danielk1977003ba062004-11-04 02:57:33 +00007141 }else{
drh4f0c5872007-03-26 22:05:01 +00007142 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
danielk1977003ba062004-11-04 02:57:33 +00007143 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00007144 }
7145#endif
danielk19773b8a05f2007-03-19 17:44:26 +00007146 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
drhd4187c72010-08-30 22:15:45 +00007147 if( createTabFlags & BTREE_INTKEY ){
7148 ptfFlags = PTF_INTKEY | PTF_LEAFDATA | PTF_LEAF;
7149 }else{
7150 ptfFlags = PTF_ZERODATA | PTF_LEAF;
7151 }
7152 zeroPage(pRoot, ptfFlags);
danielk19773b8a05f2007-03-19 17:44:26 +00007153 sqlite3PagerUnref(pRoot->pDbPage);
drhd4187c72010-08-30 22:15:45 +00007154 assert( (pBt->openFlags & BTREE_SINGLE)==0 || pgnoRoot==2 );
drh8b2f49b2001-06-08 00:21:52 +00007155 *piTable = (int)pgnoRoot;
7156 return SQLITE_OK;
7157}
drhd677b3d2007-08-20 22:48:41 +00007158int sqlite3BtreeCreateTable(Btree *p, int *piTable, int flags){
7159 int rc;
7160 sqlite3BtreeEnter(p);
7161 rc = btreeCreateTable(p, piTable, flags);
7162 sqlite3BtreeLeave(p);
7163 return rc;
7164}
drh8b2f49b2001-06-08 00:21:52 +00007165
7166/*
7167** Erase the given database page and all its children. Return
7168** the page to the freelist.
7169*/
drh4b70f112004-05-02 21:12:19 +00007170static int clearDatabasePage(
danielk1977aef0bf62005-12-30 16:28:01 +00007171 BtShared *pBt, /* The BTree that contains the table */
drh7ab641f2009-11-24 02:37:02 +00007172 Pgno pgno, /* Page number to clear */
7173 int freePageFlag, /* Deallocate page if true */
7174 int *pnChange /* Add number of Cells freed to this counter */
drh4b70f112004-05-02 21:12:19 +00007175){
danielk1977146ba992009-07-22 14:08:13 +00007176 MemPage *pPage;
drh8b2f49b2001-06-08 00:21:52 +00007177 int rc;
drh4b70f112004-05-02 21:12:19 +00007178 unsigned char *pCell;
7179 int i;
drh8b2f49b2001-06-08 00:21:52 +00007180
drh1fee73e2007-08-29 04:00:57 +00007181 assert( sqlite3_mutex_held(pBt->mutex) );
drhb1299152010-03-30 22:58:33 +00007182 if( pgno>btreePagecount(pBt) ){
drh49285702005-09-17 15:20:26 +00007183 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00007184 }
7185
danielk197771d5d2c2008-09-29 11:49:47 +00007186 rc = getAndInitPage(pBt, pgno, &pPage);
danielk1977146ba992009-07-22 14:08:13 +00007187 if( rc ) return rc;
drh4b70f112004-05-02 21:12:19 +00007188 for(i=0; i<pPage->nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00007189 pCell = findCell(pPage, i);
drh4b70f112004-05-02 21:12:19 +00007190 if( !pPage->leaf ){
danielk197762c14b32008-11-19 09:05:26 +00007191 rc = clearDatabasePage(pBt, get4byte(pCell), 1, pnChange);
danielk19776b456a22005-03-21 04:04:02 +00007192 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00007193 }
drh4b70f112004-05-02 21:12:19 +00007194 rc = clearCell(pPage, pCell);
danielk19776b456a22005-03-21 04:04:02 +00007195 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00007196 }
drha34b6762004-05-07 13:30:42 +00007197 if( !pPage->leaf ){
danielk197762c14b32008-11-19 09:05:26 +00007198 rc = clearDatabasePage(pBt, get4byte(&pPage->aData[8]), 1, pnChange);
danielk19776b456a22005-03-21 04:04:02 +00007199 if( rc ) goto cleardatabasepage_out;
danielk1977c7af4842008-10-27 13:59:33 +00007200 }else if( pnChange ){
7201 assert( pPage->intKey );
7202 *pnChange += pPage->nCell;
drh2aa679f2001-06-25 02:11:07 +00007203 }
7204 if( freePageFlag ){
drhc314dc72009-07-21 11:52:34 +00007205 freePage(pPage, &rc);
danielk19773b8a05f2007-03-19 17:44:26 +00007206 }else if( (rc = sqlite3PagerWrite(pPage->pDbPage))==0 ){
drh3a4c1412004-05-09 20:40:11 +00007207 zeroPage(pPage, pPage->aData[0] | PTF_LEAF);
drh2aa679f2001-06-25 02:11:07 +00007208 }
danielk19776b456a22005-03-21 04:04:02 +00007209
7210cleardatabasepage_out:
drh4b70f112004-05-02 21:12:19 +00007211 releasePage(pPage);
drh2aa679f2001-06-25 02:11:07 +00007212 return rc;
drh8b2f49b2001-06-08 00:21:52 +00007213}
7214
7215/*
drhab01f612004-05-22 02:55:23 +00007216** Delete all information from a single table in the database. iTable is
7217** the page number of the root of the table. After this routine returns,
7218** the root page is empty, but still exists.
7219**
7220** This routine will fail with SQLITE_LOCKED if there are any open
7221** read cursors on the table. Open write cursors are moved to the
7222** root of the table.
danielk1977c7af4842008-10-27 13:59:33 +00007223**
7224** If pnChange is not NULL, then table iTable must be an intkey table. The
7225** integer value pointed to by pnChange is incremented by the number of
7226** entries in the table.
drh8b2f49b2001-06-08 00:21:52 +00007227*/
danielk1977c7af4842008-10-27 13:59:33 +00007228int sqlite3BtreeClearTable(Btree *p, int iTable, int *pnChange){
drh8b2f49b2001-06-08 00:21:52 +00007229 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00007230 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00007231 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00007232 assert( p->inTrans==TRANS_WRITE );
danielk197796d48e92009-06-29 06:00:37 +00007233
7234 /* Invalidate all incrblob cursors open on table iTable (assuming iTable
7235 ** is the root of a table b-tree - if it is not, the following call is
7236 ** a no-op). */
drheeb844a2009-08-08 18:01:07 +00007237 invalidateIncrblobCursors(p, 0, 1);
danielk197796d48e92009-06-29 06:00:37 +00007238
drhc046e3e2009-07-15 11:26:44 +00007239 rc = saveAllCursors(pBt, (Pgno)iTable, 0);
7240 if( SQLITE_OK==rc ){
danielk197762c14b32008-11-19 09:05:26 +00007241 rc = clearDatabasePage(pBt, (Pgno)iTable, 0, pnChange);
drh8b2f49b2001-06-08 00:21:52 +00007242 }
drhd677b3d2007-08-20 22:48:41 +00007243 sqlite3BtreeLeave(p);
7244 return rc;
drh8b2f49b2001-06-08 00:21:52 +00007245}
7246
7247/*
7248** Erase all information in a table and add the root of the table to
7249** the freelist. Except, the root of the principle table (the one on
drhab01f612004-05-22 02:55:23 +00007250** page 1) is never added to the freelist.
7251**
7252** This routine will fail with SQLITE_LOCKED if there are any open
7253** cursors on the table.
drh205f48e2004-11-05 00:43:11 +00007254**
7255** If AUTOVACUUM is enabled and the page at iTable is not the last
7256** root page in the database file, then the last root page
7257** in the database file is moved into the slot formerly occupied by
7258** iTable and that last slot formerly occupied by the last root page
7259** is added to the freelist instead of iTable. In this say, all
7260** root pages are kept at the beginning of the database file, which
7261** is necessary for AUTOVACUUM to work right. *piMoved is set to the
7262** page number that used to be the last root page in the file before
7263** the move. If no page gets moved, *piMoved is set to 0.
7264** The last root page is recorded in meta[3] and the value of
7265** meta[3] is updated by this procedure.
drh8b2f49b2001-06-08 00:21:52 +00007266*/
danielk197789d40042008-11-17 14:20:56 +00007267static int btreeDropTable(Btree *p, Pgno iTable, int *piMoved){
drh8b2f49b2001-06-08 00:21:52 +00007268 int rc;
danielk1977a0bf2652004-11-04 14:30:04 +00007269 MemPage *pPage = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00007270 BtShared *pBt = p->pBt;
danielk1977a0bf2652004-11-04 14:30:04 +00007271
drh1fee73e2007-08-29 04:00:57 +00007272 assert( sqlite3BtreeHoldsMutex(p) );
drh64022502009-01-09 14:11:04 +00007273 assert( p->inTrans==TRANS_WRITE );
danielk1977a0bf2652004-11-04 14:30:04 +00007274
danielk1977e6efa742004-11-10 11:55:10 +00007275 /* It is illegal to drop a table if any cursors are open on the
7276 ** database. This is because in auto-vacuum mode the backend may
7277 ** need to move another root-page to fill a gap left by the deleted
7278 ** root page. If an open cursor was using this page a problem would
7279 ** occur.
drhc046e3e2009-07-15 11:26:44 +00007280 **
7281 ** This error is caught long before control reaches this point.
danielk1977e6efa742004-11-10 11:55:10 +00007282 */
drhc046e3e2009-07-15 11:26:44 +00007283 if( NEVER(pBt->pCursor) ){
danielk1977404ca072009-03-16 13:19:36 +00007284 sqlite3ConnectionBlocked(p->db, pBt->pCursor->pBtree->db);
7285 return SQLITE_LOCKED_SHAREDCACHE;
drh5df72a52002-06-06 23:16:05 +00007286 }
danielk1977a0bf2652004-11-04 14:30:04 +00007287
danielk197730548662009-07-09 05:07:37 +00007288 rc = btreeGetPage(pBt, (Pgno)iTable, &pPage, 0);
drh2aa679f2001-06-25 02:11:07 +00007289 if( rc ) return rc;
danielk1977c7af4842008-10-27 13:59:33 +00007290 rc = sqlite3BtreeClearTable(p, iTable, 0);
danielk19776b456a22005-03-21 04:04:02 +00007291 if( rc ){
7292 releasePage(pPage);
7293 return rc;
7294 }
danielk1977a0bf2652004-11-04 14:30:04 +00007295
drh205f48e2004-11-05 00:43:11 +00007296 *piMoved = 0;
danielk1977a0bf2652004-11-04 14:30:04 +00007297
drh4b70f112004-05-02 21:12:19 +00007298 if( iTable>1 ){
danielk1977a0bf2652004-11-04 14:30:04 +00007299#ifdef SQLITE_OMIT_AUTOVACUUM
drhc314dc72009-07-21 11:52:34 +00007300 freePage(pPage, &rc);
danielk1977a0bf2652004-11-04 14:30:04 +00007301 releasePage(pPage);
7302#else
7303 if( pBt->autoVacuum ){
7304 Pgno maxRootPgno;
danielk1977602b4662009-07-02 07:47:33 +00007305 sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00007306
7307 if( iTable==maxRootPgno ){
7308 /* If the table being dropped is the table with the largest root-page
7309 ** number in the database, put the root page on the free list.
7310 */
drhc314dc72009-07-21 11:52:34 +00007311 freePage(pPage, &rc);
danielk1977a0bf2652004-11-04 14:30:04 +00007312 releasePage(pPage);
7313 if( rc!=SQLITE_OK ){
7314 return rc;
7315 }
7316 }else{
7317 /* The table being dropped does not have the largest root-page
7318 ** number in the database. So move the page that does into the
7319 ** gap left by the deleted root-page.
7320 */
7321 MemPage *pMove;
7322 releasePage(pPage);
danielk197730548662009-07-09 05:07:37 +00007323 rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00007324 if( rc!=SQLITE_OK ){
7325 return rc;
7326 }
danielk19774c999992008-07-16 18:17:55 +00007327 rc = relocatePage(pBt, pMove, PTRMAP_ROOTPAGE, 0, iTable, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00007328 releasePage(pMove);
7329 if( rc!=SQLITE_OK ){
7330 return rc;
7331 }
drhfe3313f2009-07-21 19:02:20 +00007332 pMove = 0;
danielk197730548662009-07-09 05:07:37 +00007333 rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
drhc314dc72009-07-21 11:52:34 +00007334 freePage(pMove, &rc);
danielk1977a0bf2652004-11-04 14:30:04 +00007335 releasePage(pMove);
7336 if( rc!=SQLITE_OK ){
7337 return rc;
7338 }
7339 *piMoved = maxRootPgno;
7340 }
7341
danielk1977599fcba2004-11-08 07:13:13 +00007342 /* Set the new 'max-root-page' value in the database header. This
7343 ** is the old value less one, less one more if that happens to
7344 ** be a root-page number, less one again if that is the
7345 ** PENDING_BYTE_PAGE.
7346 */
danielk197787a6e732004-11-05 12:58:25 +00007347 maxRootPgno--;
drhe1849652009-07-15 18:15:22 +00007348 while( maxRootPgno==PENDING_BYTE_PAGE(pBt)
7349 || PTRMAP_ISPAGE(pBt, maxRootPgno) ){
danielk197787a6e732004-11-05 12:58:25 +00007350 maxRootPgno--;
7351 }
danielk1977599fcba2004-11-08 07:13:13 +00007352 assert( maxRootPgno!=PENDING_BYTE_PAGE(pBt) );
7353
danielk1977aef0bf62005-12-30 16:28:01 +00007354 rc = sqlite3BtreeUpdateMeta(p, 4, maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00007355 }else{
drhc314dc72009-07-21 11:52:34 +00007356 freePage(pPage, &rc);
danielk1977a0bf2652004-11-04 14:30:04 +00007357 releasePage(pPage);
7358 }
7359#endif
drh2aa679f2001-06-25 02:11:07 +00007360 }else{
drhc046e3e2009-07-15 11:26:44 +00007361 /* If sqlite3BtreeDropTable was called on page 1.
7362 ** This really never should happen except in a corrupt
7363 ** database.
7364 */
drha34b6762004-05-07 13:30:42 +00007365 zeroPage(pPage, PTF_INTKEY|PTF_LEAF );
danielk1977a0bf2652004-11-04 14:30:04 +00007366 releasePage(pPage);
drh8b2f49b2001-06-08 00:21:52 +00007367 }
drh8b2f49b2001-06-08 00:21:52 +00007368 return rc;
7369}
drhd677b3d2007-08-20 22:48:41 +00007370int sqlite3BtreeDropTable(Btree *p, int iTable, int *piMoved){
7371 int rc;
7372 sqlite3BtreeEnter(p);
dan7733a4d2011-09-02 18:03:16 +00007373 rc = btreeDropTable(p, iTable, piMoved);
drhd677b3d2007-08-20 22:48:41 +00007374 sqlite3BtreeLeave(p);
7375 return rc;
7376}
drh8b2f49b2001-06-08 00:21:52 +00007377
drh001bbcb2003-03-19 03:14:00 +00007378
drh8b2f49b2001-06-08 00:21:52 +00007379/*
danielk1977602b4662009-07-02 07:47:33 +00007380** This function may only be called if the b-tree connection already
7381** has a read or write transaction open on the database.
7382**
drh23e11ca2004-05-04 17:27:28 +00007383** Read the meta-information out of a database file. Meta[0]
7384** is the number of free pages currently in the database. Meta[1]
drha3b321d2004-05-11 09:31:31 +00007385** through meta[15] are available for use by higher layers. Meta[0]
7386** is read-only, the others are read/write.
7387**
7388** The schema layer numbers meta values differently. At the schema
7389** layer (and the SetCookie and ReadCookie opcodes) the number of
7390** free pages is not visible. So Cookie[0] is the same as Meta[1].
drh8b2f49b2001-06-08 00:21:52 +00007391*/
danielk1977602b4662009-07-02 07:47:33 +00007392void sqlite3BtreeGetMeta(Btree *p, int idx, u32 *pMeta){
danielk1977aef0bf62005-12-30 16:28:01 +00007393 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00007394
drhd677b3d2007-08-20 22:48:41 +00007395 sqlite3BtreeEnter(p);
danielk1977602b4662009-07-02 07:47:33 +00007396 assert( p->inTrans>TRANS_NONE );
danielk1977e0d9e6f2009-07-03 16:25:06 +00007397 assert( SQLITE_OK==querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK) );
danielk1977602b4662009-07-02 07:47:33 +00007398 assert( pBt->pPage1 );
drh23e11ca2004-05-04 17:27:28 +00007399 assert( idx>=0 && idx<=15 );
danielk1977ea897302008-09-19 15:10:58 +00007400
danielk1977602b4662009-07-02 07:47:33 +00007401 *pMeta = get4byte(&pBt->pPage1->aData[36 + idx*4]);
drhae157872004-08-14 19:20:09 +00007402
danielk1977602b4662009-07-02 07:47:33 +00007403 /* If auto-vacuum is disabled in this build and this is an auto-vacuum
7404 ** database, mark the database as read-only. */
danielk1977003ba062004-11-04 02:57:33 +00007405#ifdef SQLITE_OMIT_AUTOVACUUM
drhc9166342012-01-05 23:32:06 +00007406 if( idx==BTREE_LARGEST_ROOT_PAGE && *pMeta>0 ){
7407 pBt->btsFlags |= BTS_READ_ONLY;
7408 }
danielk1977003ba062004-11-04 02:57:33 +00007409#endif
drhae157872004-08-14 19:20:09 +00007410
drhd677b3d2007-08-20 22:48:41 +00007411 sqlite3BtreeLeave(p);
drh8b2f49b2001-06-08 00:21:52 +00007412}
7413
7414/*
drh23e11ca2004-05-04 17:27:28 +00007415** Write meta-information back into the database. Meta[0] is
7416** read-only and may not be written.
drh8b2f49b2001-06-08 00:21:52 +00007417*/
danielk1977aef0bf62005-12-30 16:28:01 +00007418int sqlite3BtreeUpdateMeta(Btree *p, int idx, u32 iMeta){
7419 BtShared *pBt = p->pBt;
drh4b70f112004-05-02 21:12:19 +00007420 unsigned char *pP1;
drha34b6762004-05-07 13:30:42 +00007421 int rc;
drh23e11ca2004-05-04 17:27:28 +00007422 assert( idx>=1 && idx<=15 );
drhd677b3d2007-08-20 22:48:41 +00007423 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00007424 assert( p->inTrans==TRANS_WRITE );
7425 assert( pBt->pPage1!=0 );
7426 pP1 = pBt->pPage1->aData;
7427 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
7428 if( rc==SQLITE_OK ){
7429 put4byte(&pP1[36 + idx*4], iMeta);
danielk19774152e672007-09-12 17:01:45 +00007430#ifndef SQLITE_OMIT_AUTOVACUUM
danielk19770d19f7a2009-06-03 11:25:07 +00007431 if( idx==BTREE_INCR_VACUUM ){
drh64022502009-01-09 14:11:04 +00007432 assert( pBt->autoVacuum || iMeta==0 );
7433 assert( iMeta==0 || iMeta==1 );
7434 pBt->incrVacuum = (u8)iMeta;
drhd677b3d2007-08-20 22:48:41 +00007435 }
drh64022502009-01-09 14:11:04 +00007436#endif
drh5df72a52002-06-06 23:16:05 +00007437 }
drhd677b3d2007-08-20 22:48:41 +00007438 sqlite3BtreeLeave(p);
7439 return rc;
drh8b2f49b2001-06-08 00:21:52 +00007440}
drh8c42ca92001-06-22 19:15:00 +00007441
danielk1977a5533162009-02-24 10:01:51 +00007442#ifndef SQLITE_OMIT_BTREECOUNT
7443/*
7444** The first argument, pCur, is a cursor opened on some b-tree. Count the
7445** number of entries in the b-tree and write the result to *pnEntry.
7446**
7447** SQLITE_OK is returned if the operation is successfully executed.
7448** Otherwise, if an error is encountered (i.e. an IO error or database
7449** corruption) an SQLite error code is returned.
7450*/
7451int sqlite3BtreeCount(BtCursor *pCur, i64 *pnEntry){
7452 i64 nEntry = 0; /* Value to return in *pnEntry */
7453 int rc; /* Return code */
dana205a482011-08-27 18:48:57 +00007454
7455 if( pCur->pgnoRoot==0 ){
7456 *pnEntry = 0;
7457 return SQLITE_OK;
7458 }
danielk1977a5533162009-02-24 10:01:51 +00007459 rc = moveToRoot(pCur);
7460
7461 /* Unless an error occurs, the following loop runs one iteration for each
7462 ** page in the B-Tree structure (not including overflow pages).
7463 */
7464 while( rc==SQLITE_OK ){
7465 int iIdx; /* Index of child node in parent */
7466 MemPage *pPage; /* Current page of the b-tree */
7467
7468 /* If this is a leaf page or the tree is not an int-key tree, then
7469 ** this page contains countable entries. Increment the entry counter
7470 ** accordingly.
7471 */
7472 pPage = pCur->apPage[pCur->iPage];
7473 if( pPage->leaf || !pPage->intKey ){
7474 nEntry += pPage->nCell;
7475 }
7476
7477 /* pPage is a leaf node. This loop navigates the cursor so that it
7478 ** points to the first interior cell that it points to the parent of
7479 ** the next page in the tree that has not yet been visited. The
7480 ** pCur->aiIdx[pCur->iPage] value is set to the index of the parent cell
7481 ** of the page, or to the number of cells in the page if the next page
7482 ** to visit is the right-child of its parent.
7483 **
7484 ** If all pages in the tree have been visited, return SQLITE_OK to the
7485 ** caller.
7486 */
7487 if( pPage->leaf ){
7488 do {
7489 if( pCur->iPage==0 ){
7490 /* All pages of the b-tree have been visited. Return successfully. */
7491 *pnEntry = nEntry;
7492 return SQLITE_OK;
7493 }
danielk197730548662009-07-09 05:07:37 +00007494 moveToParent(pCur);
danielk1977a5533162009-02-24 10:01:51 +00007495 }while ( pCur->aiIdx[pCur->iPage]>=pCur->apPage[pCur->iPage]->nCell );
7496
7497 pCur->aiIdx[pCur->iPage]++;
7498 pPage = pCur->apPage[pCur->iPage];
7499 }
7500
7501 /* Descend to the child node of the cell that the cursor currently
7502 ** points at. This is the right-child if (iIdx==pPage->nCell).
7503 */
7504 iIdx = pCur->aiIdx[pCur->iPage];
7505 if( iIdx==pPage->nCell ){
7506 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
7507 }else{
7508 rc = moveToChild(pCur, get4byte(findCell(pPage, iIdx)));
7509 }
7510 }
7511
shanebe217792009-03-05 04:20:31 +00007512 /* An error has occurred. Return an error code. */
danielk1977a5533162009-02-24 10:01:51 +00007513 return rc;
7514}
7515#endif
drhdd793422001-06-28 01:54:48 +00007516
drhdd793422001-06-28 01:54:48 +00007517/*
drh5eddca62001-06-30 21:53:53 +00007518** Return the pager associated with a BTree. This routine is used for
7519** testing and debugging only.
drhdd793422001-06-28 01:54:48 +00007520*/
danielk1977aef0bf62005-12-30 16:28:01 +00007521Pager *sqlite3BtreePager(Btree *p){
7522 return p->pBt->pPager;
drhdd793422001-06-28 01:54:48 +00007523}
drh5eddca62001-06-30 21:53:53 +00007524
drhb7f91642004-10-31 02:22:47 +00007525#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00007526/*
7527** Append a message to the error message string.
7528*/
drh2e38c322004-09-03 18:38:44 +00007529static void checkAppendMsg(
7530 IntegrityCk *pCheck,
7531 char *zMsg1,
7532 const char *zFormat,
7533 ...
7534){
7535 va_list ap;
drh1dcdbc02007-01-27 02:24:54 +00007536 if( !pCheck->mxErr ) return;
7537 pCheck->mxErr--;
7538 pCheck->nErr++;
drh2e38c322004-09-03 18:38:44 +00007539 va_start(ap, zFormat);
drhf089aa42008-07-08 19:34:06 +00007540 if( pCheck->errMsg.nChar ){
7541 sqlite3StrAccumAppend(&pCheck->errMsg, "\n", 1);
drh5eddca62001-06-30 21:53:53 +00007542 }
drhf089aa42008-07-08 19:34:06 +00007543 if( zMsg1 ){
7544 sqlite3StrAccumAppend(&pCheck->errMsg, zMsg1, -1);
7545 }
7546 sqlite3VXPrintf(&pCheck->errMsg, 1, zFormat, ap);
7547 va_end(ap);
drhc890fec2008-08-01 20:10:08 +00007548 if( pCheck->errMsg.mallocFailed ){
7549 pCheck->mallocFailed = 1;
7550 }
drh5eddca62001-06-30 21:53:53 +00007551}
drhb7f91642004-10-31 02:22:47 +00007552#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00007553
drhb7f91642004-10-31 02:22:47 +00007554#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00007555/*
7556** Add 1 to the reference count for page iPage. If this is the second
7557** reference to the page, add an error message to pCheck->zErrMsg.
7558** Return 1 if there are 2 ore more references to the page and 0 if
7559** if this is the first reference to the page.
7560**
7561** Also check that the page number is in bounds.
7562*/
danielk197789d40042008-11-17 14:20:56 +00007563static int checkRef(IntegrityCk *pCheck, Pgno iPage, char *zContext){
drh5eddca62001-06-30 21:53:53 +00007564 if( iPage==0 ) return 1;
danielk197789d40042008-11-17 14:20:56 +00007565 if( iPage>pCheck->nPage ){
drh2e38c322004-09-03 18:38:44 +00007566 checkAppendMsg(pCheck, zContext, "invalid page number %d", iPage);
drh5eddca62001-06-30 21:53:53 +00007567 return 1;
7568 }
7569 if( pCheck->anRef[iPage]==1 ){
drh2e38c322004-09-03 18:38:44 +00007570 checkAppendMsg(pCheck, zContext, "2nd reference to page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00007571 return 1;
7572 }
7573 return (pCheck->anRef[iPage]++)>1;
7574}
7575
danielk1977afcdd022004-10-31 16:25:42 +00007576#ifndef SQLITE_OMIT_AUTOVACUUM
7577/*
7578** Check that the entry in the pointer-map for page iChild maps to
7579** page iParent, pointer type ptrType. If not, append an error message
7580** to pCheck.
7581*/
7582static void checkPtrmap(
7583 IntegrityCk *pCheck, /* Integrity check context */
7584 Pgno iChild, /* Child page number */
7585 u8 eType, /* Expected pointer map type */
7586 Pgno iParent, /* Expected pointer map parent page number */
7587 char *zContext /* Context description (used for error msg) */
7588){
7589 int rc;
7590 u8 ePtrmapType;
7591 Pgno iPtrmapParent;
7592
7593 rc = ptrmapGet(pCheck->pBt, iChild, &ePtrmapType, &iPtrmapParent);
7594 if( rc!=SQLITE_OK ){
drhb56cd552009-05-01 13:16:54 +00007595 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ) pCheck->mallocFailed = 1;
danielk1977afcdd022004-10-31 16:25:42 +00007596 checkAppendMsg(pCheck, zContext, "Failed to read ptrmap key=%d", iChild);
7597 return;
7598 }
7599
7600 if( ePtrmapType!=eType || iPtrmapParent!=iParent ){
7601 checkAppendMsg(pCheck, zContext,
7602 "Bad ptr map entry key=%d expected=(%d,%d) got=(%d,%d)",
7603 iChild, eType, iParent, ePtrmapType, iPtrmapParent);
7604 }
7605}
7606#endif
7607
drh5eddca62001-06-30 21:53:53 +00007608/*
7609** Check the integrity of the freelist or of an overflow page list.
7610** Verify that the number of pages on the list is N.
7611*/
drh30e58752002-03-02 20:41:57 +00007612static void checkList(
7613 IntegrityCk *pCheck, /* Integrity checking context */
7614 int isFreeList, /* True for a freelist. False for overflow page list */
7615 int iPage, /* Page number for first page in the list */
7616 int N, /* Expected number of pages in the list */
7617 char *zContext /* Context for error messages */
7618){
7619 int i;
drh3a4c1412004-05-09 20:40:11 +00007620 int expected = N;
7621 int iFirst = iPage;
drh1dcdbc02007-01-27 02:24:54 +00007622 while( N-- > 0 && pCheck->mxErr ){
danielk19773b8a05f2007-03-19 17:44:26 +00007623 DbPage *pOvflPage;
7624 unsigned char *pOvflData;
drh5eddca62001-06-30 21:53:53 +00007625 if( iPage<1 ){
drh2e38c322004-09-03 18:38:44 +00007626 checkAppendMsg(pCheck, zContext,
7627 "%d of %d pages missing from overflow list starting at %d",
drh3a4c1412004-05-09 20:40:11 +00007628 N+1, expected, iFirst);
drh5eddca62001-06-30 21:53:53 +00007629 break;
7630 }
7631 if( checkRef(pCheck, iPage, zContext) ) break;
danielk19773b8a05f2007-03-19 17:44:26 +00007632 if( sqlite3PagerGet(pCheck->pPager, (Pgno)iPage, &pOvflPage) ){
drh2e38c322004-09-03 18:38:44 +00007633 checkAppendMsg(pCheck, zContext, "failed to get page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00007634 break;
7635 }
danielk19773b8a05f2007-03-19 17:44:26 +00007636 pOvflData = (unsigned char *)sqlite3PagerGetData(pOvflPage);
drh30e58752002-03-02 20:41:57 +00007637 if( isFreeList ){
danielk19773b8a05f2007-03-19 17:44:26 +00007638 int n = get4byte(&pOvflData[4]);
danielk1977687566d2004-11-02 12:56:41 +00007639#ifndef SQLITE_OMIT_AUTOVACUUM
7640 if( pCheck->pBt->autoVacuum ){
7641 checkPtrmap(pCheck, iPage, PTRMAP_FREEPAGE, 0, zContext);
7642 }
7643#endif
drh43b18e12010-08-17 19:40:08 +00007644 if( n>(int)pCheck->pBt->usableSize/4-2 ){
drh2e38c322004-09-03 18:38:44 +00007645 checkAppendMsg(pCheck, zContext,
7646 "freelist leaf count too big on page %d", iPage);
drhee696e22004-08-30 16:52:17 +00007647 N--;
7648 }else{
7649 for(i=0; i<n; i++){
danielk19773b8a05f2007-03-19 17:44:26 +00007650 Pgno iFreePage = get4byte(&pOvflData[8+i*4]);
danielk1977687566d2004-11-02 12:56:41 +00007651#ifndef SQLITE_OMIT_AUTOVACUUM
7652 if( pCheck->pBt->autoVacuum ){
7653 checkPtrmap(pCheck, iFreePage, PTRMAP_FREEPAGE, 0, zContext);
7654 }
7655#endif
7656 checkRef(pCheck, iFreePage, zContext);
drhee696e22004-08-30 16:52:17 +00007657 }
7658 N -= n;
drh30e58752002-03-02 20:41:57 +00007659 }
drh30e58752002-03-02 20:41:57 +00007660 }
danielk1977afcdd022004-10-31 16:25:42 +00007661#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00007662 else{
7663 /* If this database supports auto-vacuum and iPage is not the last
7664 ** page in this overflow list, check that the pointer-map entry for
7665 ** the following page matches iPage.
7666 */
7667 if( pCheck->pBt->autoVacuum && N>0 ){
danielk19773b8a05f2007-03-19 17:44:26 +00007668 i = get4byte(pOvflData);
danielk1977687566d2004-11-02 12:56:41 +00007669 checkPtrmap(pCheck, i, PTRMAP_OVERFLOW2, iPage, zContext);
7670 }
danielk1977afcdd022004-10-31 16:25:42 +00007671 }
7672#endif
danielk19773b8a05f2007-03-19 17:44:26 +00007673 iPage = get4byte(pOvflData);
7674 sqlite3PagerUnref(pOvflPage);
drh5eddca62001-06-30 21:53:53 +00007675 }
7676}
drhb7f91642004-10-31 02:22:47 +00007677#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00007678
drhb7f91642004-10-31 02:22:47 +00007679#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00007680/*
7681** Do various sanity checks on a single page of a tree. Return
7682** the tree depth. Root pages return 0. Parents of root pages
7683** return 1, and so forth.
7684**
7685** These checks are done:
7686**
7687** 1. Make sure that cells and freeblocks do not overlap
7688** but combine to completely cover the page.
drhda200cc2004-05-09 11:51:38 +00007689** NO 2. Make sure cell keys are in order.
7690** NO 3. Make sure no key is less than or equal to zLowerBound.
7691** NO 4. Make sure no key is greater than or equal to zUpperBound.
drh5eddca62001-06-30 21:53:53 +00007692** 5. Check the integrity of overflow pages.
7693** 6. Recursively call checkTreePage on all children.
7694** 7. Verify that the depth of all children is the same.
drh6019e162001-07-02 17:51:45 +00007695** 8. Make sure this page is at least 33% full or else it is
drh5eddca62001-06-30 21:53:53 +00007696** the root of the tree.
7697*/
7698static int checkTreePage(
drhaaab5722002-02-19 13:39:21 +00007699 IntegrityCk *pCheck, /* Context for the sanity check */
drh5eddca62001-06-30 21:53:53 +00007700 int iPage, /* Page number of the page to check */
shaneh195475d2010-02-19 04:28:08 +00007701 char *zParentContext, /* Parent context */
7702 i64 *pnParentMinKey,
7703 i64 *pnParentMaxKey
drh5eddca62001-06-30 21:53:53 +00007704){
7705 MemPage *pPage;
drhda200cc2004-05-09 11:51:38 +00007706 int i, rc, depth, d2, pgno, cnt;
drh43605152004-05-29 21:46:49 +00007707 int hdr, cellStart;
7708 int nCell;
drhda200cc2004-05-09 11:51:38 +00007709 u8 *data;
danielk1977aef0bf62005-12-30 16:28:01 +00007710 BtShared *pBt;
drh4f26bb62005-09-08 14:17:20 +00007711 int usableSize;
drh5eddca62001-06-30 21:53:53 +00007712 char zContext[100];
shane0af3f892008-11-12 04:55:34 +00007713 char *hit = 0;
shaneh195475d2010-02-19 04:28:08 +00007714 i64 nMinKey = 0;
7715 i64 nMaxKey = 0;
drh5eddca62001-06-30 21:53:53 +00007716
drh5bb3eb92007-05-04 13:15:55 +00007717 sqlite3_snprintf(sizeof(zContext), zContext, "Page %d: ", iPage);
danielk1977ef73ee92004-11-06 12:26:07 +00007718
drh5eddca62001-06-30 21:53:53 +00007719 /* Check that the page exists
7720 */
drhd9cb6ac2005-10-20 07:28:17 +00007721 pBt = pCheck->pBt;
drhb6f41482004-05-14 01:58:11 +00007722 usableSize = pBt->usableSize;
drh5eddca62001-06-30 21:53:53 +00007723 if( iPage==0 ) return 0;
7724 if( checkRef(pCheck, iPage, zParentContext) ) return 0;
danielk197730548662009-07-09 05:07:37 +00007725 if( (rc = btreeGetPage(pBt, (Pgno)iPage, &pPage, 0))!=0 ){
drh2e38c322004-09-03 18:38:44 +00007726 checkAppendMsg(pCheck, zContext,
7727 "unable to get the page. error code=%d", rc);
drh5eddca62001-06-30 21:53:53 +00007728 return 0;
7729 }
danielk197793caf5a2009-07-11 06:55:33 +00007730
7731 /* Clear MemPage.isInit to make sure the corruption detection code in
7732 ** btreeInitPage() is executed. */
7733 pPage->isInit = 0;
danielk197730548662009-07-09 05:07:37 +00007734 if( (rc = btreeInitPage(pPage))!=0 ){
drh64022502009-01-09 14:11:04 +00007735 assert( rc==SQLITE_CORRUPT ); /* The only possible error from InitPage */
drh16a9b832007-05-05 18:39:25 +00007736 checkAppendMsg(pCheck, zContext,
danielk197730548662009-07-09 05:07:37 +00007737 "btreeInitPage() returns error code %d", rc);
drh91025292004-05-03 19:49:32 +00007738 releasePage(pPage);
drh5eddca62001-06-30 21:53:53 +00007739 return 0;
7740 }
7741
7742 /* Check out all the cells.
7743 */
7744 depth = 0;
drh1dcdbc02007-01-27 02:24:54 +00007745 for(i=0; i<pPage->nCell && pCheck->mxErr; i++){
drh6f11bef2004-05-13 01:12:56 +00007746 u8 *pCell;
danielk197789d40042008-11-17 14:20:56 +00007747 u32 sz;
drh6f11bef2004-05-13 01:12:56 +00007748 CellInfo info;
drh5eddca62001-06-30 21:53:53 +00007749
7750 /* Check payload overflow pages
7751 */
drh5bb3eb92007-05-04 13:15:55 +00007752 sqlite3_snprintf(sizeof(zContext), zContext,
7753 "On tree page %d cell %d: ", iPage, i);
danielk19771cc5ed82007-05-16 17:28:43 +00007754 pCell = findCell(pPage,i);
danielk197730548662009-07-09 05:07:37 +00007755 btreeParseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00007756 sz = info.nData;
drhf49661a2008-12-10 16:45:50 +00007757 if( !pPage->intKey ) sz += (int)info.nKey;
shaneh195475d2010-02-19 04:28:08 +00007758 /* For intKey pages, check that the keys are in order.
7759 */
7760 else if( i==0 ) nMinKey = nMaxKey = info.nKey;
7761 else{
7762 if( info.nKey <= nMaxKey ){
7763 checkAppendMsg(pCheck, zContext,
7764 "Rowid %lld out of order (previous was %lld)", info.nKey, nMaxKey);
7765 }
7766 nMaxKey = info.nKey;
7767 }
drh72365832007-03-06 15:53:44 +00007768 assert( sz==info.nPayload );
danielk19775be31f52009-03-30 13:53:43 +00007769 if( (sz>info.nLocal)
7770 && (&pCell[info.iOverflow]<=&pPage->aData[pBt->usableSize])
7771 ){
drhb6f41482004-05-14 01:58:11 +00007772 int nPage = (sz - info.nLocal + usableSize - 5)/(usableSize - 4);
danielk1977afcdd022004-10-31 16:25:42 +00007773 Pgno pgnoOvfl = get4byte(&pCell[info.iOverflow]);
7774#ifndef SQLITE_OMIT_AUTOVACUUM
7775 if( pBt->autoVacuum ){
danielk1977687566d2004-11-02 12:56:41 +00007776 checkPtrmap(pCheck, pgnoOvfl, PTRMAP_OVERFLOW1, iPage, zContext);
danielk1977afcdd022004-10-31 16:25:42 +00007777 }
7778#endif
7779 checkList(pCheck, 0, pgnoOvfl, nPage, zContext);
drh5eddca62001-06-30 21:53:53 +00007780 }
7781
7782 /* Check sanity of left child page.
7783 */
drhda200cc2004-05-09 11:51:38 +00007784 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00007785 pgno = get4byte(pCell);
danielk1977afcdd022004-10-31 16:25:42 +00007786#ifndef SQLITE_OMIT_AUTOVACUUM
7787 if( pBt->autoVacuum ){
7788 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, zContext);
7789 }
7790#endif
shaneh195475d2010-02-19 04:28:08 +00007791 d2 = checkTreePage(pCheck, pgno, zContext, &nMinKey, i==0 ? NULL : &nMaxKey);
drhda200cc2004-05-09 11:51:38 +00007792 if( i>0 && d2!=depth ){
7793 checkAppendMsg(pCheck, zContext, "Child page depth differs");
7794 }
7795 depth = d2;
drh5eddca62001-06-30 21:53:53 +00007796 }
drh5eddca62001-06-30 21:53:53 +00007797 }
shaneh195475d2010-02-19 04:28:08 +00007798
drhda200cc2004-05-09 11:51:38 +00007799 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00007800 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh5bb3eb92007-05-04 13:15:55 +00007801 sqlite3_snprintf(sizeof(zContext), zContext,
7802 "On page %d at right child: ", iPage);
danielk1977afcdd022004-10-31 16:25:42 +00007803#ifndef SQLITE_OMIT_AUTOVACUUM
7804 if( pBt->autoVacuum ){
shaneh195475d2010-02-19 04:28:08 +00007805 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, zContext);
danielk1977afcdd022004-10-31 16:25:42 +00007806 }
7807#endif
shaneh195475d2010-02-19 04:28:08 +00007808 checkTreePage(pCheck, pgno, zContext, NULL, !pPage->nCell ? NULL : &nMaxKey);
drhda200cc2004-05-09 11:51:38 +00007809 }
drh5eddca62001-06-30 21:53:53 +00007810
shaneh195475d2010-02-19 04:28:08 +00007811 /* For intKey leaf pages, check that the min/max keys are in order
7812 ** with any left/parent/right pages.
7813 */
7814 if( pPage->leaf && pPage->intKey ){
7815 /* if we are a left child page */
7816 if( pnParentMinKey ){
7817 /* if we are the left most child page */
7818 if( !pnParentMaxKey ){
7819 if( nMaxKey > *pnParentMinKey ){
7820 checkAppendMsg(pCheck, zContext,
7821 "Rowid %lld out of order (max larger than parent min of %lld)",
7822 nMaxKey, *pnParentMinKey);
7823 }
7824 }else{
7825 if( nMinKey <= *pnParentMinKey ){
7826 checkAppendMsg(pCheck, zContext,
7827 "Rowid %lld out of order (min less than parent min of %lld)",
7828 nMinKey, *pnParentMinKey);
7829 }
7830 if( nMaxKey > *pnParentMaxKey ){
7831 checkAppendMsg(pCheck, zContext,
7832 "Rowid %lld out of order (max larger than parent max of %lld)",
7833 nMaxKey, *pnParentMaxKey);
7834 }
7835 *pnParentMinKey = nMaxKey;
7836 }
7837 /* else if we're a right child page */
7838 } else if( pnParentMaxKey ){
7839 if( nMinKey <= *pnParentMaxKey ){
7840 checkAppendMsg(pCheck, zContext,
7841 "Rowid %lld out of order (min less than parent max of %lld)",
7842 nMinKey, *pnParentMaxKey);
7843 }
7844 }
7845 }
7846
drh5eddca62001-06-30 21:53:53 +00007847 /* Check for complete coverage of the page
7848 */
drhda200cc2004-05-09 11:51:38 +00007849 data = pPage->aData;
7850 hdr = pPage->hdrOffset;
drhf7141992008-06-19 00:16:08 +00007851 hit = sqlite3PageMalloc( pBt->pageSize );
drhc890fec2008-08-01 20:10:08 +00007852 if( hit==0 ){
7853 pCheck->mallocFailed = 1;
7854 }else{
drh5d433ce2010-08-14 16:02:52 +00007855 int contentOffset = get2byteNotZero(&data[hdr+5]);
drhd7c7ecd2009-07-14 17:48:06 +00007856 assert( contentOffset<=usableSize ); /* Enforced by btreeInitPage() */
shane5780ebd2008-11-11 17:36:30 +00007857 memset(hit+contentOffset, 0, usableSize-contentOffset);
7858 memset(hit, 1, contentOffset);
drh2e38c322004-09-03 18:38:44 +00007859 nCell = get2byte(&data[hdr+3]);
7860 cellStart = hdr + 12 - 4*pPage->leaf;
7861 for(i=0; i<nCell; i++){
7862 int pc = get2byte(&data[cellStart+i*2]);
drh9b78f792010-08-14 21:21:24 +00007863 u32 size = 65536;
drh2e38c322004-09-03 18:38:44 +00007864 int j;
drh8c2bbb62009-07-10 02:52:20 +00007865 if( pc<=usableSize-4 ){
danielk1977daca5432008-08-25 11:57:16 +00007866 size = cellSizePtr(pPage, &data[pc]);
7867 }
drh43b18e12010-08-17 19:40:08 +00007868 if( (int)(pc+size-1)>=usableSize ){
danielk19777701e812005-01-10 12:59:51 +00007869 checkAppendMsg(pCheck, 0,
shaneh195475d2010-02-19 04:28:08 +00007870 "Corruption detected in cell %d on page %d",i,iPage);
danielk19777701e812005-01-10 12:59:51 +00007871 }else{
7872 for(j=pc+size-1; j>=pc; j--) hit[j]++;
7873 }
drh2e38c322004-09-03 18:38:44 +00007874 }
drh8c2bbb62009-07-10 02:52:20 +00007875 i = get2byte(&data[hdr+1]);
7876 while( i>0 ){
7877 int size, j;
7878 assert( i<=usableSize-4 ); /* Enforced by btreeInitPage() */
7879 size = get2byte(&data[i+2]);
7880 assert( i+size<=usableSize ); /* Enforced by btreeInitPage() */
7881 for(j=i+size-1; j>=i; j--) hit[j]++;
7882 j = get2byte(&data[i]);
7883 assert( j==0 || j>i+size ); /* Enforced by btreeInitPage() */
7884 assert( j<=usableSize-4 ); /* Enforced by btreeInitPage() */
7885 i = j;
drh2e38c322004-09-03 18:38:44 +00007886 }
7887 for(i=cnt=0; i<usableSize; i++){
7888 if( hit[i]==0 ){
7889 cnt++;
7890 }else if( hit[i]>1 ){
7891 checkAppendMsg(pCheck, 0,
7892 "Multiple uses for byte %d of page %d", i, iPage);
7893 break;
7894 }
7895 }
7896 if( cnt!=data[hdr+7] ){
7897 checkAppendMsg(pCheck, 0,
drh8c2bbb62009-07-10 02:52:20 +00007898 "Fragmentation of %d bytes reported as %d on page %d",
drh2e38c322004-09-03 18:38:44 +00007899 cnt, data[hdr+7], iPage);
drh5eddca62001-06-30 21:53:53 +00007900 }
7901 }
drh8c2bbb62009-07-10 02:52:20 +00007902 sqlite3PageFree(hit);
drh4b70f112004-05-02 21:12:19 +00007903 releasePage(pPage);
drhda200cc2004-05-09 11:51:38 +00007904 return depth+1;
drh5eddca62001-06-30 21:53:53 +00007905}
drhb7f91642004-10-31 02:22:47 +00007906#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00007907
drhb7f91642004-10-31 02:22:47 +00007908#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00007909/*
7910** This routine does a complete check of the given BTree file. aRoot[] is
7911** an array of pages numbers were each page number is the root page of
7912** a table. nRoot is the number of entries in aRoot.
7913**
danielk19773509a652009-07-06 18:56:13 +00007914** A read-only or read-write transaction must be opened before calling
7915** this function.
7916**
drhc890fec2008-08-01 20:10:08 +00007917** Write the number of error seen in *pnErr. Except for some memory
drhe43ba702008-12-05 22:40:08 +00007918** allocation errors, an error message held in memory obtained from
drhc890fec2008-08-01 20:10:08 +00007919** malloc is returned if *pnErr is non-zero. If *pnErr==0 then NULL is
drhe43ba702008-12-05 22:40:08 +00007920** returned. If a memory allocation error occurs, NULL is returned.
drh5eddca62001-06-30 21:53:53 +00007921*/
drh1dcdbc02007-01-27 02:24:54 +00007922char *sqlite3BtreeIntegrityCheck(
7923 Btree *p, /* The btree to be checked */
7924 int *aRoot, /* An array of root pages numbers for individual trees */
7925 int nRoot, /* Number of entries in aRoot[] */
7926 int mxErr, /* Stop reporting errors after this many */
7927 int *pnErr /* Write number of errors seen to this variable */
7928){
danielk197789d40042008-11-17 14:20:56 +00007929 Pgno i;
drh5eddca62001-06-30 21:53:53 +00007930 int nRef;
drhaaab5722002-02-19 13:39:21 +00007931 IntegrityCk sCheck;
danielk1977aef0bf62005-12-30 16:28:01 +00007932 BtShared *pBt = p->pBt;
drhf089aa42008-07-08 19:34:06 +00007933 char zErr[100];
drh5eddca62001-06-30 21:53:53 +00007934
drhd677b3d2007-08-20 22:48:41 +00007935 sqlite3BtreeEnter(p);
danielk19773509a652009-07-06 18:56:13 +00007936 assert( p->inTrans>TRANS_NONE && pBt->inTransaction>TRANS_NONE );
danielk19773b8a05f2007-03-19 17:44:26 +00007937 nRef = sqlite3PagerRefcount(pBt->pPager);
drh5eddca62001-06-30 21:53:53 +00007938 sCheck.pBt = pBt;
7939 sCheck.pPager = pBt->pPager;
drhb1299152010-03-30 22:58:33 +00007940 sCheck.nPage = btreePagecount(sCheck.pBt);
drh1dcdbc02007-01-27 02:24:54 +00007941 sCheck.mxErr = mxErr;
7942 sCheck.nErr = 0;
drhc890fec2008-08-01 20:10:08 +00007943 sCheck.mallocFailed = 0;
drh1dcdbc02007-01-27 02:24:54 +00007944 *pnErr = 0;
drh0de8c112002-07-06 16:32:14 +00007945 if( sCheck.nPage==0 ){
drhd677b3d2007-08-20 22:48:41 +00007946 sqlite3BtreeLeave(p);
drh0de8c112002-07-06 16:32:14 +00007947 return 0;
7948 }
drhe5ae5732008-06-15 02:51:47 +00007949 sCheck.anRef = sqlite3Malloc( (sCheck.nPage+1)*sizeof(sCheck.anRef[0]) );
danielk1977ac245ec2005-01-14 13:50:11 +00007950 if( !sCheck.anRef ){
drh1dcdbc02007-01-27 02:24:54 +00007951 *pnErr = 1;
drhd677b3d2007-08-20 22:48:41 +00007952 sqlite3BtreeLeave(p);
drhc890fec2008-08-01 20:10:08 +00007953 return 0;
danielk1977ac245ec2005-01-14 13:50:11 +00007954 }
drhda200cc2004-05-09 11:51:38 +00007955 for(i=0; i<=sCheck.nPage; i++){ sCheck.anRef[i] = 0; }
drh42cac6d2004-11-20 20:31:11 +00007956 i = PENDING_BYTE_PAGE(pBt);
drh1f595712004-06-15 01:40:29 +00007957 if( i<=sCheck.nPage ){
7958 sCheck.anRef[i] = 1;
7959 }
drhf089aa42008-07-08 19:34:06 +00007960 sqlite3StrAccumInit(&sCheck.errMsg, zErr, sizeof(zErr), 20000);
drhb9755982010-07-24 16:34:37 +00007961 sCheck.errMsg.useMalloc = 2;
drh5eddca62001-06-30 21:53:53 +00007962
7963 /* Check the integrity of the freelist
7964 */
drha34b6762004-05-07 13:30:42 +00007965 checkList(&sCheck, 1, get4byte(&pBt->pPage1->aData[32]),
7966 get4byte(&pBt->pPage1->aData[36]), "Main freelist: ");
drh5eddca62001-06-30 21:53:53 +00007967
7968 /* Check all the tables.
7969 */
danielk197789d40042008-11-17 14:20:56 +00007970 for(i=0; (int)i<nRoot && sCheck.mxErr; i++){
drh4ff6dfa2002-03-03 23:06:00 +00007971 if( aRoot[i]==0 ) continue;
danielk1977687566d2004-11-02 12:56:41 +00007972#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00007973 if( pBt->autoVacuum && aRoot[i]>1 ){
7974 checkPtrmap(&sCheck, aRoot[i], PTRMAP_ROOTPAGE, 0, 0);
7975 }
7976#endif
shaneh195475d2010-02-19 04:28:08 +00007977 checkTreePage(&sCheck, aRoot[i], "List of tree roots: ", NULL, NULL);
drh5eddca62001-06-30 21:53:53 +00007978 }
7979
7980 /* Make sure every page in the file is referenced
7981 */
drh1dcdbc02007-01-27 02:24:54 +00007982 for(i=1; i<=sCheck.nPage && sCheck.mxErr; i++){
danielk1977afcdd022004-10-31 16:25:42 +00007983#ifdef SQLITE_OMIT_AUTOVACUUM
drh5eddca62001-06-30 21:53:53 +00007984 if( sCheck.anRef[i]==0 ){
drh2e38c322004-09-03 18:38:44 +00007985 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
drh5eddca62001-06-30 21:53:53 +00007986 }
danielk1977afcdd022004-10-31 16:25:42 +00007987#else
7988 /* If the database supports auto-vacuum, make sure no tables contain
7989 ** references to pointer-map pages.
7990 */
7991 if( sCheck.anRef[i]==0 &&
danielk1977266664d2006-02-10 08:24:21 +00007992 (PTRMAP_PAGENO(pBt, i)!=i || !pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00007993 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
7994 }
7995 if( sCheck.anRef[i]!=0 &&
danielk1977266664d2006-02-10 08:24:21 +00007996 (PTRMAP_PAGENO(pBt, i)==i && pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00007997 checkAppendMsg(&sCheck, 0, "Pointer map page %d is referenced", i);
7998 }
7999#endif
drh5eddca62001-06-30 21:53:53 +00008000 }
8001
drh64022502009-01-09 14:11:04 +00008002 /* Make sure this analysis did not leave any unref() pages.
8003 ** This is an internal consistency check; an integrity check
8004 ** of the integrity check.
drh5eddca62001-06-30 21:53:53 +00008005 */
drh64022502009-01-09 14:11:04 +00008006 if( NEVER(nRef != sqlite3PagerRefcount(pBt->pPager)) ){
drh2e38c322004-09-03 18:38:44 +00008007 checkAppendMsg(&sCheck, 0,
drh5eddca62001-06-30 21:53:53 +00008008 "Outstanding page count goes from %d to %d during this analysis",
danielk19773b8a05f2007-03-19 17:44:26 +00008009 nRef, sqlite3PagerRefcount(pBt->pPager)
drh5eddca62001-06-30 21:53:53 +00008010 );
drh5eddca62001-06-30 21:53:53 +00008011 }
8012
8013 /* Clean up and report errors.
8014 */
drhd677b3d2007-08-20 22:48:41 +00008015 sqlite3BtreeLeave(p);
drh17435752007-08-16 04:30:38 +00008016 sqlite3_free(sCheck.anRef);
drhc890fec2008-08-01 20:10:08 +00008017 if( sCheck.mallocFailed ){
8018 sqlite3StrAccumReset(&sCheck.errMsg);
8019 *pnErr = sCheck.nErr+1;
8020 return 0;
8021 }
drh1dcdbc02007-01-27 02:24:54 +00008022 *pnErr = sCheck.nErr;
drhf089aa42008-07-08 19:34:06 +00008023 if( sCheck.nErr==0 ) sqlite3StrAccumReset(&sCheck.errMsg);
8024 return sqlite3StrAccumFinish(&sCheck.errMsg);
drh5eddca62001-06-30 21:53:53 +00008025}
drhb7f91642004-10-31 02:22:47 +00008026#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
paulb95a8862003-04-01 21:16:41 +00008027
drh73509ee2003-04-06 20:44:45 +00008028/*
8029** Return the full pathname of the underlying database file.
drhd0679ed2007-08-28 22:24:34 +00008030**
8031** The pager filename is invariant as long as the pager is
8032** open so it is safe to access without the BtShared mutex.
drh73509ee2003-04-06 20:44:45 +00008033*/
danielk1977aef0bf62005-12-30 16:28:01 +00008034const char *sqlite3BtreeGetFilename(Btree *p){
8035 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00008036 return sqlite3PagerFilename(p->pBt->pPager);
drh73509ee2003-04-06 20:44:45 +00008037}
8038
8039/*
danielk19775865e3d2004-06-14 06:03:57 +00008040** Return the pathname of the journal file for this database. The return
8041** value of this routine is the same regardless of whether the journal file
8042** has been created or not.
drhd0679ed2007-08-28 22:24:34 +00008043**
8044** The pager journal filename is invariant as long as the pager is
8045** open so it is safe to access without the BtShared mutex.
danielk19775865e3d2004-06-14 06:03:57 +00008046*/
danielk1977aef0bf62005-12-30 16:28:01 +00008047const char *sqlite3BtreeGetJournalname(Btree *p){
8048 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00008049 return sqlite3PagerJournalname(p->pBt->pPager);
danielk19775865e3d2004-06-14 06:03:57 +00008050}
8051
danielk19771d850a72004-05-31 08:26:49 +00008052/*
8053** Return non-zero if a transaction is active.
8054*/
danielk1977aef0bf62005-12-30 16:28:01 +00008055int sqlite3BtreeIsInTrans(Btree *p){
drhe5fe6902007-12-07 18:55:28 +00008056 assert( p==0 || sqlite3_mutex_held(p->db->mutex) );
danielk1977aef0bf62005-12-30 16:28:01 +00008057 return (p && (p->inTrans==TRANS_WRITE));
danielk19771d850a72004-05-31 08:26:49 +00008058}
8059
dana550f2d2010-08-02 10:47:05 +00008060#ifndef SQLITE_OMIT_WAL
8061/*
8062** Run a checkpoint on the Btree passed as the first argument.
8063**
8064** Return SQLITE_LOCKED if this or any other connection has an open
8065** transaction on the shared-cache the argument Btree is connected to.
dana58f26f2010-11-16 18:56:51 +00008066**
dancdc1f042010-11-18 12:11:05 +00008067** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dana550f2d2010-08-02 10:47:05 +00008068*/
dancdc1f042010-11-18 12:11:05 +00008069int sqlite3BtreeCheckpoint(Btree *p, int eMode, int *pnLog, int *pnCkpt){
dana550f2d2010-08-02 10:47:05 +00008070 int rc = SQLITE_OK;
8071 if( p ){
8072 BtShared *pBt = p->pBt;
8073 sqlite3BtreeEnter(p);
8074 if( pBt->inTransaction!=TRANS_NONE ){
8075 rc = SQLITE_LOCKED;
8076 }else{
dancdc1f042010-11-18 12:11:05 +00008077 rc = sqlite3PagerCheckpoint(pBt->pPager, eMode, pnLog, pnCkpt);
dana550f2d2010-08-02 10:47:05 +00008078 }
8079 sqlite3BtreeLeave(p);
8080 }
8081 return rc;
8082}
8083#endif
8084
danielk19771d850a72004-05-31 08:26:49 +00008085/*
danielk19772372c2b2006-06-27 16:34:56 +00008086** Return non-zero if a read (or write) transaction is active.
8087*/
8088int sqlite3BtreeIsInReadTrans(Btree *p){
drh64022502009-01-09 14:11:04 +00008089 assert( p );
drhe5fe6902007-12-07 18:55:28 +00008090 assert( sqlite3_mutex_held(p->db->mutex) );
drh64022502009-01-09 14:11:04 +00008091 return p->inTrans!=TRANS_NONE;
danielk19772372c2b2006-06-27 16:34:56 +00008092}
8093
danielk197704103022009-02-03 16:51:24 +00008094int sqlite3BtreeIsInBackup(Btree *p){
8095 assert( p );
8096 assert( sqlite3_mutex_held(p->db->mutex) );
8097 return p->nBackup!=0;
8098}
8099
danielk19772372c2b2006-06-27 16:34:56 +00008100/*
danielk1977da184232006-01-05 11:34:32 +00008101** This function returns a pointer to a blob of memory associated with
drh85b623f2007-12-13 21:54:09 +00008102** a single shared-btree. The memory is used by client code for its own
danielk1977da184232006-01-05 11:34:32 +00008103** purposes (for example, to store a high-level schema associated with
8104** the shared-btree). The btree layer manages reference counting issues.
8105**
8106** The first time this is called on a shared-btree, nBytes bytes of memory
8107** are allocated, zeroed, and returned to the caller. For each subsequent
8108** call the nBytes parameter is ignored and a pointer to the same blob
8109** of memory returned.
8110**
danielk1977171bfed2008-06-23 09:50:50 +00008111** If the nBytes parameter is 0 and the blob of memory has not yet been
8112** allocated, a null pointer is returned. If the blob has already been
8113** allocated, it is returned as normal.
8114**
danielk1977da184232006-01-05 11:34:32 +00008115** Just before the shared-btree is closed, the function passed as the
8116** xFree argument when the memory allocation was made is invoked on the
drh4fa7d7c2011-04-03 02:41:00 +00008117** blob of allocated memory. The xFree function should not call sqlite3_free()
danielk1977da184232006-01-05 11:34:32 +00008118** on the memory, the btree layer does that.
8119*/
8120void *sqlite3BtreeSchema(Btree *p, int nBytes, void(*xFree)(void *)){
8121 BtShared *pBt = p->pBt;
drh27641702007-08-22 02:56:42 +00008122 sqlite3BtreeEnter(p);
danielk1977171bfed2008-06-23 09:50:50 +00008123 if( !pBt->pSchema && nBytes ){
drhb9755982010-07-24 16:34:37 +00008124 pBt->pSchema = sqlite3DbMallocZero(0, nBytes);
danielk1977da184232006-01-05 11:34:32 +00008125 pBt->xFreeSchema = xFree;
8126 }
drh27641702007-08-22 02:56:42 +00008127 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +00008128 return pBt->pSchema;
8129}
8130
danielk1977c87d34d2006-01-06 13:00:28 +00008131/*
danielk1977404ca072009-03-16 13:19:36 +00008132** Return SQLITE_LOCKED_SHAREDCACHE if another user of the same shared
8133** btree as the argument handle holds an exclusive lock on the
8134** sqlite_master table. Otherwise SQLITE_OK.
danielk1977c87d34d2006-01-06 13:00:28 +00008135*/
8136int sqlite3BtreeSchemaLocked(Btree *p){
drh27641702007-08-22 02:56:42 +00008137 int rc;
drhe5fe6902007-12-07 18:55:28 +00008138 assert( sqlite3_mutex_held(p->db->mutex) );
drh27641702007-08-22 02:56:42 +00008139 sqlite3BtreeEnter(p);
danielk1977404ca072009-03-16 13:19:36 +00008140 rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK);
8141 assert( rc==SQLITE_OK || rc==SQLITE_LOCKED_SHAREDCACHE );
drh27641702007-08-22 02:56:42 +00008142 sqlite3BtreeLeave(p);
8143 return rc;
danielk1977c87d34d2006-01-06 13:00:28 +00008144}
8145
drha154dcd2006-03-22 22:10:07 +00008146
8147#ifndef SQLITE_OMIT_SHARED_CACHE
8148/*
8149** Obtain a lock on the table whose root page is iTab. The
8150** lock is a write lock if isWritelock is true or a read lock
8151** if it is false.
8152*/
danielk1977c00da102006-01-07 13:21:04 +00008153int sqlite3BtreeLockTable(Btree *p, int iTab, u8 isWriteLock){
danielk19772e94d4d2006-01-09 05:36:27 +00008154 int rc = SQLITE_OK;
danielk1977602b4662009-07-02 07:47:33 +00008155 assert( p->inTrans!=TRANS_NONE );
drh6a9ad3d2008-04-02 16:29:30 +00008156 if( p->sharable ){
8157 u8 lockType = READ_LOCK + isWriteLock;
8158 assert( READ_LOCK+1==WRITE_LOCK );
8159 assert( isWriteLock==0 || isWriteLock==1 );
danielk1977602b4662009-07-02 07:47:33 +00008160
drh6a9ad3d2008-04-02 16:29:30 +00008161 sqlite3BtreeEnter(p);
drhc25eabe2009-02-24 18:57:31 +00008162 rc = querySharedCacheTableLock(p, iTab, lockType);
drh6a9ad3d2008-04-02 16:29:30 +00008163 if( rc==SQLITE_OK ){
drhc25eabe2009-02-24 18:57:31 +00008164 rc = setSharedCacheTableLock(p, iTab, lockType);
drh6a9ad3d2008-04-02 16:29:30 +00008165 }
8166 sqlite3BtreeLeave(p);
danielk1977c00da102006-01-07 13:21:04 +00008167 }
8168 return rc;
8169}
drha154dcd2006-03-22 22:10:07 +00008170#endif
danielk1977b82e7ed2006-01-11 14:09:31 +00008171
danielk1977b4e9af92007-05-01 17:49:49 +00008172#ifndef SQLITE_OMIT_INCRBLOB
8173/*
8174** Argument pCsr must be a cursor opened for writing on an
8175** INTKEY table currently pointing at a valid table entry.
8176** This function modifies the data stored as part of that entry.
danielk1977ecaecf92009-07-08 08:05:35 +00008177**
8178** Only the data content may only be modified, it is not possible to
8179** change the length of the data stored. If this function is called with
8180** parameters that attempt to write past the end of the existing data,
8181** no modifications are made and SQLITE_CORRUPT is returned.
danielk1977b4e9af92007-05-01 17:49:49 +00008182*/
danielk1977dcbb5d32007-05-04 18:36:44 +00008183int sqlite3BtreePutData(BtCursor *pCsr, u32 offset, u32 amt, void *z){
danielk1977c9000e62009-07-08 13:55:28 +00008184 int rc;
drh1fee73e2007-08-29 04:00:57 +00008185 assert( cursorHoldsMutex(pCsr) );
drhe5fe6902007-12-07 18:55:28 +00008186 assert( sqlite3_mutex_held(pCsr->pBtree->db->mutex) );
danielk197796d48e92009-06-29 06:00:37 +00008187 assert( pCsr->isIncrblobHandle );
danielk19773588ceb2008-06-10 17:30:26 +00008188
danielk1977c9000e62009-07-08 13:55:28 +00008189 rc = restoreCursorPosition(pCsr);
8190 if( rc!=SQLITE_OK ){
8191 return rc;
8192 }
danielk19773588ceb2008-06-10 17:30:26 +00008193 assert( pCsr->eState!=CURSOR_REQUIRESEEK );
8194 if( pCsr->eState!=CURSOR_VALID ){
8195 return SQLITE_ABORT;
danielk1977dcbb5d32007-05-04 18:36:44 +00008196 }
8197
danielk1977c9000e62009-07-08 13:55:28 +00008198 /* Check some assumptions:
danielk1977dcbb5d32007-05-04 18:36:44 +00008199 ** (a) the cursor is open for writing,
danielk1977c9000e62009-07-08 13:55:28 +00008200 ** (b) there is a read/write transaction open,
8201 ** (c) the connection holds a write-lock on the table (if required),
8202 ** (d) there are no conflicting read-locks, and
8203 ** (e) the cursor points at a valid row of an intKey table.
danielk1977d04417962007-05-02 13:16:30 +00008204 */
danielk19774f029602009-07-08 18:45:37 +00008205 if( !pCsr->wrFlag ){
8206 return SQLITE_READONLY;
8207 }
drhc9166342012-01-05 23:32:06 +00008208 assert( (pCsr->pBt->btsFlags & BTS_READ_ONLY)==0
8209 && pCsr->pBt->inTransaction==TRANS_WRITE );
danielk197796d48e92009-06-29 06:00:37 +00008210 assert( hasSharedCacheTableLock(pCsr->pBtree, pCsr->pgnoRoot, 0, 2) );
8211 assert( !hasReadConflicts(pCsr->pBtree, pCsr->pgnoRoot) );
danielk1977c9000e62009-07-08 13:55:28 +00008212 assert( pCsr->apPage[pCsr->iPage]->intKey );
danielk1977b4e9af92007-05-01 17:49:49 +00008213
drhfb192682009-07-11 18:26:28 +00008214 return accessPayload(pCsr, offset, amt, (unsigned char *)z, 1);
danielk1977b4e9af92007-05-01 17:49:49 +00008215}
danielk19772dec9702007-05-02 16:48:37 +00008216
8217/*
8218** Set a flag on this cursor to cache the locations of pages from the
danielk1977da107192007-05-04 08:32:13 +00008219** overflow list for the current row. This is used by cursors opened
8220** for incremental blob IO only.
8221**
8222** This function sets a flag only. The actual page location cache
8223** (stored in BtCursor.aOverflow[]) is allocated and used by function
8224** accessPayload() (the worker function for sqlite3BtreeData() and
8225** sqlite3BtreePutData()).
danielk19772dec9702007-05-02 16:48:37 +00008226*/
8227void sqlite3BtreeCacheOverflow(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00008228 assert( cursorHoldsMutex(pCur) );
drhe5fe6902007-12-07 18:55:28 +00008229 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
dan4e76cc32010-10-20 18:56:04 +00008230 invalidateOverflowCache(pCur);
danielk1977dcbb5d32007-05-04 18:36:44 +00008231 pCur->isIncrblobHandle = 1;
danielk19772dec9702007-05-02 16:48:37 +00008232}
danielk1977b4e9af92007-05-01 17:49:49 +00008233#endif
dane04dc882010-04-20 18:53:15 +00008234
8235/*
8236** Set both the "read version" (single byte at byte offset 18) and
8237** "write version" (single byte at byte offset 19) fields in the database
8238** header to iVersion.
8239*/
8240int sqlite3BtreeSetVersion(Btree *pBtree, int iVersion){
8241 BtShared *pBt = pBtree->pBt;
8242 int rc; /* Return code */
8243
dane04dc882010-04-20 18:53:15 +00008244 assert( iVersion==1 || iVersion==2 );
8245
danb9780022010-04-21 18:37:57 +00008246 /* If setting the version fields to 1, do not automatically open the
8247 ** WAL connection, even if the version fields are currently set to 2.
8248 */
drhc9166342012-01-05 23:32:06 +00008249 pBt->btsFlags &= ~BTS_NO_WAL;
8250 if( iVersion==1 ) pBt->btsFlags |= BTS_NO_WAL;
danb9780022010-04-21 18:37:57 +00008251
8252 rc = sqlite3BtreeBeginTrans(pBtree, 0);
dane04dc882010-04-20 18:53:15 +00008253 if( rc==SQLITE_OK ){
8254 u8 *aData = pBt->pPage1->aData;
danb9780022010-04-21 18:37:57 +00008255 if( aData[18]!=(u8)iVersion || aData[19]!=(u8)iVersion ){
danede6eb82010-04-22 06:27:04 +00008256 rc = sqlite3BtreeBeginTrans(pBtree, 2);
danb9780022010-04-21 18:37:57 +00008257 if( rc==SQLITE_OK ){
8258 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
8259 if( rc==SQLITE_OK ){
8260 aData[18] = (u8)iVersion;
8261 aData[19] = (u8)iVersion;
8262 }
8263 }
8264 }
dane04dc882010-04-20 18:53:15 +00008265 }
8266
drhc9166342012-01-05 23:32:06 +00008267 pBt->btsFlags &= ~BTS_NO_WAL;
dane04dc882010-04-20 18:53:15 +00008268 return rc;
8269}