blob: b6c0a410400f8e6fb94d7f2fc3c6ad10ab5ab2ae [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*************************************************************************
peter.d.reid60ec9142014-09-06 16:39:46 +000012** This file implements an 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
dan09ff9e12013-03-11 11:49:03 +000046/*
47** Values passed as the 5th argument to allocateBtreePage()
48*/
49#define BTALLOC_ANY 0 /* Allocate any page */
50#define BTALLOC_EXACT 1 /* Allocate exact page if possible */
51#define BTALLOC_LE 2 /* Allocate any page <= the parameter */
52
53/*
54** Macro IfNotOmitAV(x) returns (x) if SQLITE_OMIT_AUTOVACUUM is not
55** defined, or 0 if it is. For example:
56**
57** bIncrVacuum = IfNotOmitAV(pBtShared->incrVacuum);
58*/
59#ifndef SQLITE_OMIT_AUTOVACUUM
60#define IfNotOmitAV(expr) (expr)
61#else
62#define IfNotOmitAV(expr) 0
63#endif
64
drhe53831d2007-08-17 01:14:38 +000065#ifndef SQLITE_OMIT_SHARED_CACHE
66/*
danielk1977502b4e02008-09-02 14:07:24 +000067** A list of BtShared objects that are eligible for participation
68** in shared cache. This variable has file scope during normal builds,
69** but the test harness needs to access it so we make it global for
70** test builds.
drh7555d8e2009-03-20 13:15:30 +000071**
72** Access to this variable is protected by SQLITE_MUTEX_STATIC_MASTER.
drhe53831d2007-08-17 01:14:38 +000073*/
74#ifdef SQLITE_TEST
drh78f82d12008-09-02 00:52:52 +000075BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
drhe53831d2007-08-17 01:14:38 +000076#else
drh78f82d12008-09-02 00:52:52 +000077static BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
drhe53831d2007-08-17 01:14:38 +000078#endif
drhe53831d2007-08-17 01:14:38 +000079#endif /* SQLITE_OMIT_SHARED_CACHE */
80
81#ifndef SQLITE_OMIT_SHARED_CACHE
82/*
83** Enable or disable the shared pager and schema features.
84**
85** This routine has no effect on existing database connections.
86** The shared cache setting effects only future calls to
87** sqlite3_open(), sqlite3_open16(), or sqlite3_open_v2().
88*/
89int sqlite3_enable_shared_cache(int enable){
danielk1977502b4e02008-09-02 14:07:24 +000090 sqlite3GlobalConfig.sharedCacheEnabled = enable;
drhe53831d2007-08-17 01:14:38 +000091 return SQLITE_OK;
92}
93#endif
94
drhd677b3d2007-08-20 22:48:41 +000095
danielk1977aef0bf62005-12-30 16:28:01 +000096
97#ifdef SQLITE_OMIT_SHARED_CACHE
98 /*
drhc25eabe2009-02-24 18:57:31 +000099 ** The functions querySharedCacheTableLock(), setSharedCacheTableLock(),
100 ** and clearAllSharedCacheTableLocks()
danielk1977aef0bf62005-12-30 16:28:01 +0000101 ** manipulate entries in the BtShared.pLock linked list used to store
102 ** shared-cache table level locks. If the library is compiled with the
103 ** shared-cache feature disabled, then there is only ever one user
danielk1977da184232006-01-05 11:34:32 +0000104 ** of each BtShared structure and so this locking is not necessary.
105 ** So define the lock related functions as no-ops.
danielk1977aef0bf62005-12-30 16:28:01 +0000106 */
drhc25eabe2009-02-24 18:57:31 +0000107 #define querySharedCacheTableLock(a,b,c) SQLITE_OK
108 #define setSharedCacheTableLock(a,b,c) SQLITE_OK
109 #define clearAllSharedCacheTableLocks(a)
danielk197794b30732009-07-02 17:21:57 +0000110 #define downgradeAllSharedCacheTableLocks(a)
danielk197796d48e92009-06-29 06:00:37 +0000111 #define hasSharedCacheTableLock(a,b,c,d) 1
112 #define hasReadConflicts(a, b) 0
drhe53831d2007-08-17 01:14:38 +0000113#endif
danielk1977aef0bf62005-12-30 16:28:01 +0000114
daneebf2f52017-11-18 17:30:08 +0000115/*
116** Implementation of the SQLITE_CORRUPT_PAGE() macro. Takes a single
117** (MemPage*) as an argument. The (MemPage*) must not be NULL.
118**
119** If SQLITE_DEBUG is not defined, then this macro is equivalent to
120** SQLITE_CORRUPT_BKPT. Or, if SQLITE_DEBUG is set, then the log message
121** normally produced as a side-effect of SQLITE_CORRUPT_BKPT is augmented
122** with the page number and filename associated with the (MemPage*).
123*/
124#ifdef SQLITE_DEBUG
125int corruptPageError(int lineno, MemPage *p){
drh8bfe66a2018-01-22 15:45:12 +0000126 char *zMsg;
127 sqlite3BeginBenignMalloc();
128 zMsg = sqlite3_mprintf("database corruption page %d of %s",
daneebf2f52017-11-18 17:30:08 +0000129 (int)p->pgno, sqlite3PagerFilename(p->pBt->pPager, 0)
130 );
drh8bfe66a2018-01-22 15:45:12 +0000131 sqlite3EndBenignMalloc();
daneebf2f52017-11-18 17:30:08 +0000132 if( zMsg ){
133 sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
134 }
135 sqlite3_free(zMsg);
136 return SQLITE_CORRUPT_BKPT;
137}
138# define SQLITE_CORRUPT_PAGE(pMemPage) corruptPageError(__LINE__, pMemPage)
139#else
140# define SQLITE_CORRUPT_PAGE(pMemPage) SQLITE_CORRUPT_PGNO(pMemPage->pgno)
141#endif
142
drhe53831d2007-08-17 01:14:38 +0000143#ifndef SQLITE_OMIT_SHARED_CACHE
danielk197796d48e92009-06-29 06:00:37 +0000144
145#ifdef SQLITE_DEBUG
146/*
drh0ee3dbe2009-10-16 15:05:18 +0000147**** This function is only used as part of an assert() statement. ***
148**
149** Check to see if pBtree holds the required locks to read or write to the
150** table with root page iRoot. Return 1 if it does and 0 if not.
151**
152** For example, when writing to a table with root-page iRoot via
danielk197796d48e92009-06-29 06:00:37 +0000153** Btree connection pBtree:
154**
155** assert( hasSharedCacheTableLock(pBtree, iRoot, 0, WRITE_LOCK) );
156**
drh0ee3dbe2009-10-16 15:05:18 +0000157** When writing to an index that resides in a sharable database, the
danielk197796d48e92009-06-29 06:00:37 +0000158** caller should have first obtained a lock specifying the root page of
drh0ee3dbe2009-10-16 15:05:18 +0000159** the corresponding table. This makes things a bit more complicated,
160** as this module treats each table as a separate structure. To determine
161** the table corresponding to the index being written, this
danielk197796d48e92009-06-29 06:00:37 +0000162** function has to search through the database schema.
163**
drh0ee3dbe2009-10-16 15:05:18 +0000164** Instead of a lock on the table/index rooted at page iRoot, the caller may
danielk197796d48e92009-06-29 06:00:37 +0000165** hold a write-lock on the schema table (root page 1). This is also
166** acceptable.
167*/
168static int hasSharedCacheTableLock(
169 Btree *pBtree, /* Handle that must hold lock */
170 Pgno iRoot, /* Root page of b-tree */
171 int isIndex, /* True if iRoot is the root of an index b-tree */
172 int eLockType /* Required lock type (READ_LOCK or WRITE_LOCK) */
173){
174 Schema *pSchema = (Schema *)pBtree->pBt->pSchema;
175 Pgno iTab = 0;
176 BtLock *pLock;
177
drh0ee3dbe2009-10-16 15:05:18 +0000178 /* If this database is not shareable, or if the client is reading
danielk197796d48e92009-06-29 06:00:37 +0000179 ** and has the read-uncommitted flag set, then no lock is required.
drh0ee3dbe2009-10-16 15:05:18 +0000180 ** Return true immediately.
181 */
danielk197796d48e92009-06-29 06:00:37 +0000182 if( (pBtree->sharable==0)
drh169dd922017-06-26 13:57:49 +0000183 || (eLockType==READ_LOCK && (pBtree->db->flags & SQLITE_ReadUncommit))
danielk197796d48e92009-06-29 06:00:37 +0000184 ){
185 return 1;
186 }
187
drh0ee3dbe2009-10-16 15:05:18 +0000188 /* If the client is reading or writing an index and the schema is
189 ** not loaded, then it is too difficult to actually check to see if
190 ** the correct locks are held. So do not bother - just return true.
191 ** This case does not come up very often anyhow.
192 */
drh2c5e35f2014-08-05 11:04:21 +0000193 if( isIndex && (!pSchema || (pSchema->schemaFlags&DB_SchemaLoaded)==0) ){
drh0ee3dbe2009-10-16 15:05:18 +0000194 return 1;
195 }
196
danielk197796d48e92009-06-29 06:00:37 +0000197 /* Figure out the root-page that the lock should be held on. For table
198 ** b-trees, this is just the root page of the b-tree being read or
199 ** written. For index b-trees, it is the root page of the associated
200 ** table. */
201 if( isIndex ){
202 HashElem *p;
203 for(p=sqliteHashFirst(&pSchema->idxHash); p; p=sqliteHashNext(p)){
204 Index *pIdx = (Index *)sqliteHashData(p);
shane5eff7cf2009-08-10 03:57:58 +0000205 if( pIdx->tnum==(int)iRoot ){
drh1ffede82015-01-30 20:59:27 +0000206 if( iTab ){
207 /* Two or more indexes share the same root page. There must
208 ** be imposter tables. So just return true. The assert is not
209 ** useful in that case. */
210 return 1;
211 }
shane5eff7cf2009-08-10 03:57:58 +0000212 iTab = pIdx->pTable->tnum;
danielk197796d48e92009-06-29 06:00:37 +0000213 }
214 }
215 }else{
216 iTab = iRoot;
217 }
218
219 /* Search for the required lock. Either a write-lock on root-page iTab, a
220 ** write-lock on the schema table, or (if the client is reading) a
221 ** read-lock on iTab will suffice. Return 1 if any of these are found. */
222 for(pLock=pBtree->pBt->pLock; pLock; pLock=pLock->pNext){
223 if( pLock->pBtree==pBtree
224 && (pLock->iTable==iTab || (pLock->eLock==WRITE_LOCK && pLock->iTable==1))
225 && pLock->eLock>=eLockType
226 ){
227 return 1;
228 }
229 }
230
231 /* Failed to find the required lock. */
232 return 0;
233}
drh0ee3dbe2009-10-16 15:05:18 +0000234#endif /* SQLITE_DEBUG */
danielk197796d48e92009-06-29 06:00:37 +0000235
drh0ee3dbe2009-10-16 15:05:18 +0000236#ifdef SQLITE_DEBUG
danielk197796d48e92009-06-29 06:00:37 +0000237/*
drh0ee3dbe2009-10-16 15:05:18 +0000238**** This function may be used as part of assert() statements only. ****
danielk197796d48e92009-06-29 06:00:37 +0000239**
drh0ee3dbe2009-10-16 15:05:18 +0000240** Return true if it would be illegal for pBtree to write into the
241** table or index rooted at iRoot because other shared connections are
242** simultaneously reading that same table or index.
243**
244** It is illegal for pBtree to write if some other Btree object that
245** shares the same BtShared object is currently reading or writing
246** the iRoot table. Except, if the other Btree object has the
247** read-uncommitted flag set, then it is OK for the other object to
248** have a read cursor.
249**
250** For example, before writing to any part of the table or index
251** rooted at page iRoot, one should call:
danielk197796d48e92009-06-29 06:00:37 +0000252**
253** assert( !hasReadConflicts(pBtree, iRoot) );
254*/
255static int hasReadConflicts(Btree *pBtree, Pgno iRoot){
256 BtCursor *p;
257 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
258 if( p->pgnoRoot==iRoot
259 && p->pBtree!=pBtree
drh169dd922017-06-26 13:57:49 +0000260 && 0==(p->pBtree->db->flags & SQLITE_ReadUncommit)
danielk197796d48e92009-06-29 06:00:37 +0000261 ){
262 return 1;
263 }
264 }
265 return 0;
266}
267#endif /* #ifdef SQLITE_DEBUG */
268
danielk1977da184232006-01-05 11:34:32 +0000269/*
drh0ee3dbe2009-10-16 15:05:18 +0000270** Query to see if Btree handle p may obtain a lock of type eLock
danielk1977aef0bf62005-12-30 16:28:01 +0000271** (READ_LOCK or WRITE_LOCK) on the table with root-page iTab. Return
drhc25eabe2009-02-24 18:57:31 +0000272** SQLITE_OK if the lock may be obtained (by calling
273** setSharedCacheTableLock()), or SQLITE_LOCKED if not.
danielk1977aef0bf62005-12-30 16:28:01 +0000274*/
drhc25eabe2009-02-24 18:57:31 +0000275static int querySharedCacheTableLock(Btree *p, Pgno iTab, u8 eLock){
danielk1977aef0bf62005-12-30 16:28:01 +0000276 BtShared *pBt = p->pBt;
277 BtLock *pIter;
278
drh1fee73e2007-08-29 04:00:57 +0000279 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000280 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
281 assert( p->db!=0 );
drh169dd922017-06-26 13:57:49 +0000282 assert( !(p->db->flags&SQLITE_ReadUncommit)||eLock==WRITE_LOCK||iTab==1 );
drhd677b3d2007-08-20 22:48:41 +0000283
danielk19775b413d72009-04-01 09:41:54 +0000284 /* If requesting a write-lock, then the Btree must have an open write
285 ** transaction on this file. And, obviously, for this to be so there
286 ** must be an open write transaction on the file itself.
287 */
288 assert( eLock==READ_LOCK || (p==pBt->pWriter && p->inTrans==TRANS_WRITE) );
289 assert( eLock==READ_LOCK || pBt->inTransaction==TRANS_WRITE );
290
drh0ee3dbe2009-10-16 15:05:18 +0000291 /* This routine is a no-op if the shared-cache is not enabled */
drhe53831d2007-08-17 01:14:38 +0000292 if( !p->sharable ){
danielk1977da184232006-01-05 11:34:32 +0000293 return SQLITE_OK;
294 }
295
danielk1977641b0f42007-12-21 04:47:25 +0000296 /* If some other connection is holding an exclusive lock, the
297 ** requested lock may not be obtained.
298 */
drhc9166342012-01-05 23:32:06 +0000299 if( pBt->pWriter!=p && (pBt->btsFlags & BTS_EXCLUSIVE)!=0 ){
danielk1977404ca072009-03-16 13:19:36 +0000300 sqlite3ConnectionBlocked(p->db, pBt->pWriter->db);
301 return SQLITE_LOCKED_SHAREDCACHE;
danielk1977641b0f42007-12-21 04:47:25 +0000302 }
303
danielk1977e0d9e6f2009-07-03 16:25:06 +0000304 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
305 /* The condition (pIter->eLock!=eLock) in the following if(...)
306 ** statement is a simplification of:
307 **
308 ** (eLock==WRITE_LOCK || pIter->eLock==WRITE_LOCK)
309 **
310 ** since we know that if eLock==WRITE_LOCK, then no other connection
311 ** may hold a WRITE_LOCK on any table in this file (since there can
312 ** only be a single writer).
313 */
314 assert( pIter->eLock==READ_LOCK || pIter->eLock==WRITE_LOCK );
315 assert( eLock==READ_LOCK || pIter->pBtree==p || pIter->eLock==READ_LOCK);
316 if( pIter->pBtree!=p && pIter->iTable==iTab && pIter->eLock!=eLock ){
317 sqlite3ConnectionBlocked(p->db, pIter->pBtree->db);
318 if( eLock==WRITE_LOCK ){
319 assert( p==pBt->pWriter );
drhc9166342012-01-05 23:32:06 +0000320 pBt->btsFlags |= BTS_PENDING;
danielk1977da184232006-01-05 11:34:32 +0000321 }
danielk1977e0d9e6f2009-07-03 16:25:06 +0000322 return SQLITE_LOCKED_SHAREDCACHE;
danielk1977aef0bf62005-12-30 16:28:01 +0000323 }
324 }
325 return SQLITE_OK;
326}
drhe53831d2007-08-17 01:14:38 +0000327#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000328
drhe53831d2007-08-17 01:14:38 +0000329#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000330/*
331** Add a lock on the table with root-page iTable to the shared-btree used
332** by Btree handle p. Parameter eLock must be either READ_LOCK or
333** WRITE_LOCK.
334**
danielk19779d104862009-07-09 08:27:14 +0000335** This function assumes the following:
336**
drh0ee3dbe2009-10-16 15:05:18 +0000337** (a) The specified Btree object p is connected to a sharable
338** database (one with the BtShared.sharable flag set), and
danielk19779d104862009-07-09 08:27:14 +0000339**
drh0ee3dbe2009-10-16 15:05:18 +0000340** (b) No other Btree objects hold a lock that conflicts
danielk19779d104862009-07-09 08:27:14 +0000341** with the requested lock (i.e. querySharedCacheTableLock() has
342** already been called and returned SQLITE_OK).
343**
344** SQLITE_OK is returned if the lock is added successfully. SQLITE_NOMEM
345** is returned if a malloc attempt fails.
danielk1977aef0bf62005-12-30 16:28:01 +0000346*/
drhc25eabe2009-02-24 18:57:31 +0000347static int setSharedCacheTableLock(Btree *p, Pgno iTable, u8 eLock){
danielk1977aef0bf62005-12-30 16:28:01 +0000348 BtShared *pBt = p->pBt;
349 BtLock *pLock = 0;
350 BtLock *pIter;
351
drh1fee73e2007-08-29 04:00:57 +0000352 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000353 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
354 assert( p->db!=0 );
drhd677b3d2007-08-20 22:48:41 +0000355
danielk1977e0d9e6f2009-07-03 16:25:06 +0000356 /* A connection with the read-uncommitted flag set will never try to
357 ** obtain a read-lock using this function. The only read-lock obtained
358 ** by a connection in read-uncommitted mode is on the sqlite_master
359 ** table, and that lock is obtained in BtreeBeginTrans(). */
drh169dd922017-06-26 13:57:49 +0000360 assert( 0==(p->db->flags&SQLITE_ReadUncommit) || eLock==WRITE_LOCK );
danielk1977e0d9e6f2009-07-03 16:25:06 +0000361
danielk19779d104862009-07-09 08:27:14 +0000362 /* This function should only be called on a sharable b-tree after it
363 ** has been determined that no other b-tree holds a conflicting lock. */
364 assert( p->sharable );
drhc25eabe2009-02-24 18:57:31 +0000365 assert( SQLITE_OK==querySharedCacheTableLock(p, iTable, eLock) );
danielk1977aef0bf62005-12-30 16:28:01 +0000366
367 /* First search the list for an existing lock on this table. */
368 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
369 if( pIter->iTable==iTable && pIter->pBtree==p ){
370 pLock = pIter;
371 break;
372 }
373 }
374
375 /* If the above search did not find a BtLock struct associating Btree p
376 ** with table iTable, allocate one and link it into the list.
377 */
378 if( !pLock ){
drh17435752007-08-16 04:30:38 +0000379 pLock = (BtLock *)sqlite3MallocZero(sizeof(BtLock));
danielk1977aef0bf62005-12-30 16:28:01 +0000380 if( !pLock ){
mistachkinfad30392016-02-13 23:43:46 +0000381 return SQLITE_NOMEM_BKPT;
danielk1977aef0bf62005-12-30 16:28:01 +0000382 }
383 pLock->iTable = iTable;
384 pLock->pBtree = p;
385 pLock->pNext = pBt->pLock;
386 pBt->pLock = pLock;
387 }
388
389 /* Set the BtLock.eLock variable to the maximum of the current lock
390 ** and the requested lock. This means if a write-lock was already held
391 ** and a read-lock requested, we don't incorrectly downgrade the lock.
392 */
393 assert( WRITE_LOCK>READ_LOCK );
danielk19775118b912005-12-30 16:31:53 +0000394 if( eLock>pLock->eLock ){
395 pLock->eLock = eLock;
396 }
danielk1977aef0bf62005-12-30 16:28:01 +0000397
398 return SQLITE_OK;
399}
drhe53831d2007-08-17 01:14:38 +0000400#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000401
drhe53831d2007-08-17 01:14:38 +0000402#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000403/*
drhc25eabe2009-02-24 18:57:31 +0000404** Release all the table locks (locks obtained via calls to
drh0ee3dbe2009-10-16 15:05:18 +0000405** the setSharedCacheTableLock() procedure) held by Btree object p.
danielk1977fa542f12009-04-02 18:28:08 +0000406**
drh0ee3dbe2009-10-16 15:05:18 +0000407** This function assumes that Btree p has an open read or write
drhc9166342012-01-05 23:32:06 +0000408** transaction. If it does not, then the BTS_PENDING flag
danielk1977fa542f12009-04-02 18:28:08 +0000409** may be incorrectly cleared.
danielk1977aef0bf62005-12-30 16:28:01 +0000410*/
drhc25eabe2009-02-24 18:57:31 +0000411static void clearAllSharedCacheTableLocks(Btree *p){
danielk1977641b0f42007-12-21 04:47:25 +0000412 BtShared *pBt = p->pBt;
413 BtLock **ppIter = &pBt->pLock;
danielk1977da184232006-01-05 11:34:32 +0000414
drh1fee73e2007-08-29 04:00:57 +0000415 assert( sqlite3BtreeHoldsMutex(p) );
drhe53831d2007-08-17 01:14:38 +0000416 assert( p->sharable || 0==*ppIter );
danielk1977fa542f12009-04-02 18:28:08 +0000417 assert( p->inTrans>0 );
danielk1977da184232006-01-05 11:34:32 +0000418
danielk1977aef0bf62005-12-30 16:28:01 +0000419 while( *ppIter ){
420 BtLock *pLock = *ppIter;
drhc9166342012-01-05 23:32:06 +0000421 assert( (pBt->btsFlags & BTS_EXCLUSIVE)==0 || pBt->pWriter==pLock->pBtree );
danielk1977fa542f12009-04-02 18:28:08 +0000422 assert( pLock->pBtree->inTrans>=pLock->eLock );
danielk1977aef0bf62005-12-30 16:28:01 +0000423 if( pLock->pBtree==p ){
424 *ppIter = pLock->pNext;
danielk1977602b4662009-07-02 07:47:33 +0000425 assert( pLock->iTable!=1 || pLock==&p->lock );
426 if( pLock->iTable!=1 ){
427 sqlite3_free(pLock);
428 }
danielk1977aef0bf62005-12-30 16:28:01 +0000429 }else{
430 ppIter = &pLock->pNext;
431 }
432 }
danielk1977641b0f42007-12-21 04:47:25 +0000433
drhc9166342012-01-05 23:32:06 +0000434 assert( (pBt->btsFlags & BTS_PENDING)==0 || pBt->pWriter );
danielk1977404ca072009-03-16 13:19:36 +0000435 if( pBt->pWriter==p ){
436 pBt->pWriter = 0;
drhc9166342012-01-05 23:32:06 +0000437 pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
danielk1977404ca072009-03-16 13:19:36 +0000438 }else if( pBt->nTransaction==2 ){
drh0ee3dbe2009-10-16 15:05:18 +0000439 /* This function is called when Btree p is concluding its
danielk1977404ca072009-03-16 13:19:36 +0000440 ** transaction. If there currently exists a writer, and p is not
441 ** that writer, then the number of locks held by connections other
442 ** than the writer must be about to drop to zero. In this case
drhc9166342012-01-05 23:32:06 +0000443 ** set the BTS_PENDING flag to 0.
danielk1977404ca072009-03-16 13:19:36 +0000444 **
drhc9166342012-01-05 23:32:06 +0000445 ** If there is not currently a writer, then BTS_PENDING must
danielk1977404ca072009-03-16 13:19:36 +0000446 ** be zero already. So this next line is harmless in that case.
447 */
drhc9166342012-01-05 23:32:06 +0000448 pBt->btsFlags &= ~BTS_PENDING;
danielk1977641b0f42007-12-21 04:47:25 +0000449 }
danielk1977aef0bf62005-12-30 16:28:01 +0000450}
danielk197794b30732009-07-02 17:21:57 +0000451
danielk1977e0d9e6f2009-07-03 16:25:06 +0000452/*
drh0ee3dbe2009-10-16 15:05:18 +0000453** This function changes all write-locks held by Btree p into read-locks.
danielk1977e0d9e6f2009-07-03 16:25:06 +0000454*/
danielk197794b30732009-07-02 17:21:57 +0000455static void downgradeAllSharedCacheTableLocks(Btree *p){
456 BtShared *pBt = p->pBt;
457 if( pBt->pWriter==p ){
458 BtLock *pLock;
459 pBt->pWriter = 0;
drhc9166342012-01-05 23:32:06 +0000460 pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
danielk197794b30732009-07-02 17:21:57 +0000461 for(pLock=pBt->pLock; pLock; pLock=pLock->pNext){
462 assert( pLock->eLock==READ_LOCK || pLock->pBtree==p );
463 pLock->eLock = READ_LOCK;
464 }
465 }
466}
467
danielk1977aef0bf62005-12-30 16:28:01 +0000468#endif /* SQLITE_OMIT_SHARED_CACHE */
469
drh3908fe92017-09-01 14:50:19 +0000470static void releasePage(MemPage *pPage); /* Forward reference */
471static void releasePageOne(MemPage *pPage); /* Forward reference */
drh352a35a2017-08-15 03:46:47 +0000472static void releasePageNotNull(MemPage *pPage); /* Forward reference */
drh980b1a72006-08-16 16:42:48 +0000473
drh1fee73e2007-08-29 04:00:57 +0000474/*
drh0ee3dbe2009-10-16 15:05:18 +0000475***** This routine is used inside of assert() only ****
476**
477** Verify that the cursor holds the mutex on its BtShared
drh1fee73e2007-08-29 04:00:57 +0000478*/
drh0ee3dbe2009-10-16 15:05:18 +0000479#ifdef SQLITE_DEBUG
drh1fee73e2007-08-29 04:00:57 +0000480static int cursorHoldsMutex(BtCursor *p){
drhff0587c2007-08-29 17:43:19 +0000481 return sqlite3_mutex_held(p->pBt->mutex);
drh1fee73e2007-08-29 04:00:57 +0000482}
drh5e08d0f2016-06-04 21:05:54 +0000483
484/* Verify that the cursor and the BtShared agree about what is the current
485** database connetion. This is important in shared-cache mode. If the database
486** connection pointers get out-of-sync, it is possible for routines like
487** btreeInitPage() to reference an stale connection pointer that references a
488** a connection that has already closed. This routine is used inside assert()
489** statements only and for the purpose of double-checking that the btree code
490** does keep the database connection pointers up-to-date.
491*/
dan7a2347e2016-01-07 16:43:54 +0000492static int cursorOwnsBtShared(BtCursor *p){
493 assert( cursorHoldsMutex(p) );
494 return (p->pBtree->db==p->pBt->db);
495}
drh1fee73e2007-08-29 04:00:57 +0000496#endif
497
danielk197792d4d7a2007-05-04 12:05:56 +0000498/*
dan5a500af2014-03-11 20:33:04 +0000499** Invalidate the overflow cache of the cursor passed as the first argument.
500** on the shared btree structure pBt.
danielk197792d4d7a2007-05-04 12:05:56 +0000501*/
drh036dbec2014-03-11 23:40:44 +0000502#define invalidateOverflowCache(pCur) (pCur->curFlags &= ~BTCF_ValidOvfl)
danielk197792d4d7a2007-05-04 12:05:56 +0000503
504/*
505** Invalidate the overflow page-list cache for all cursors opened
506** on the shared btree structure pBt.
507*/
508static void invalidateAllOverflowCache(BtShared *pBt){
509 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000510 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +0000511 for(p=pBt->pCursor; p; p=p->pNext){
512 invalidateOverflowCache(p);
513 }
514}
danielk197796d48e92009-06-29 06:00:37 +0000515
dan5a500af2014-03-11 20:33:04 +0000516#ifndef SQLITE_OMIT_INCRBLOB
danielk197796d48e92009-06-29 06:00:37 +0000517/*
518** This function is called before modifying the contents of a table
drh0ee3dbe2009-10-16 15:05:18 +0000519** to invalidate any incrblob cursors that are open on the
drheeb844a2009-08-08 18:01:07 +0000520** row or one of the rows being modified.
danielk197796d48e92009-06-29 06:00:37 +0000521**
522** If argument isClearTable is true, then the entire contents of the
523** table is about to be deleted. In this case invalidate all incrblob
524** cursors open on any row within the table with root-page pgnoRoot.
525**
526** Otherwise, if argument isClearTable is false, then the row with
527** rowid iRow is being replaced or deleted. In this case invalidate
drh0ee3dbe2009-10-16 15:05:18 +0000528** only those incrblob cursors open on that specific row.
danielk197796d48e92009-06-29 06:00:37 +0000529*/
530static void invalidateIncrblobCursors(
531 Btree *pBtree, /* The database file to check */
drh9ca431a2017-03-29 18:03:50 +0000532 Pgno pgnoRoot, /* The table that might be changing */
danielk197796d48e92009-06-29 06:00:37 +0000533 i64 iRow, /* The rowid that might be changing */
534 int isClearTable /* True if all rows are being deleted */
535){
536 BtCursor *p;
drh69180952015-06-25 13:03:10 +0000537 if( pBtree->hasIncrblobCur==0 ) return;
danielk197796d48e92009-06-29 06:00:37 +0000538 assert( sqlite3BtreeHoldsMutex(pBtree) );
drh69180952015-06-25 13:03:10 +0000539 pBtree->hasIncrblobCur = 0;
540 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
541 if( (p->curFlags & BTCF_Incrblob)!=0 ){
542 pBtree->hasIncrblobCur = 1;
drh9ca431a2017-03-29 18:03:50 +0000543 if( p->pgnoRoot==pgnoRoot && (isClearTable || p->info.nKey==iRow) ){
drh69180952015-06-25 13:03:10 +0000544 p->eState = CURSOR_INVALID;
545 }
danielk197796d48e92009-06-29 06:00:37 +0000546 }
547 }
548}
549
danielk197792d4d7a2007-05-04 12:05:56 +0000550#else
dan5a500af2014-03-11 20:33:04 +0000551 /* Stub function when INCRBLOB is omitted */
drh9ca431a2017-03-29 18:03:50 +0000552 #define invalidateIncrblobCursors(w,x,y,z)
drh0ee3dbe2009-10-16 15:05:18 +0000553#endif /* SQLITE_OMIT_INCRBLOB */
danielk197792d4d7a2007-05-04 12:05:56 +0000554
drh980b1a72006-08-16 16:42:48 +0000555/*
danielk1977bea2a942009-01-20 17:06:27 +0000556** Set bit pgno of the BtShared.pHasContent bitvec. This is called
557** when a page that previously contained data becomes a free-list leaf
558** page.
559**
560** The BtShared.pHasContent bitvec exists to work around an obscure
561** bug caused by the interaction of two useful IO optimizations surrounding
562** free-list leaf pages:
563**
564** 1) When all data is deleted from a page and the page becomes
565** a free-list leaf page, the page is not written to the database
566** (as free-list leaf pages contain no meaningful data). Sometimes
567** such a page is not even journalled (as it will not be modified,
568** why bother journalling it?).
569**
570** 2) When a free-list leaf page is reused, its content is not read
571** from the database or written to the journal file (why should it
572** be, if it is not at all meaningful?).
573**
574** By themselves, these optimizations work fine and provide a handy
575** performance boost to bulk delete or insert operations. However, if
576** a page is moved to the free-list and then reused within the same
577** transaction, a problem comes up. If the page is not journalled when
578** it is moved to the free-list and it is also not journalled when it
579** is extracted from the free-list and reused, then the original data
580** may be lost. In the event of a rollback, it may not be possible
581** to restore the database to its original configuration.
582**
583** The solution is the BtShared.pHasContent bitvec. Whenever a page is
584** moved to become a free-list leaf page, the corresponding bit is
585** set in the bitvec. Whenever a leaf page is extracted from the free-list,
drh0ee3dbe2009-10-16 15:05:18 +0000586** optimization 2 above is omitted if the corresponding bit is already
danielk1977bea2a942009-01-20 17:06:27 +0000587** set in BtShared.pHasContent. The contents of the bitvec are cleared
588** at the end of every transaction.
589*/
590static int btreeSetHasContent(BtShared *pBt, Pgno pgno){
591 int rc = SQLITE_OK;
592 if( !pBt->pHasContent ){
drhdd3cd972010-03-27 17:12:36 +0000593 assert( pgno<=pBt->nPage );
594 pBt->pHasContent = sqlite3BitvecCreate(pBt->nPage);
drh4c301aa2009-07-15 17:25:45 +0000595 if( !pBt->pHasContent ){
mistachkinfad30392016-02-13 23:43:46 +0000596 rc = SQLITE_NOMEM_BKPT;
danielk1977bea2a942009-01-20 17:06:27 +0000597 }
598 }
599 if( rc==SQLITE_OK && pgno<=sqlite3BitvecSize(pBt->pHasContent) ){
600 rc = sqlite3BitvecSet(pBt->pHasContent, pgno);
601 }
602 return rc;
603}
604
605/*
606** Query the BtShared.pHasContent vector.
607**
608** This function is called when a free-list leaf page is removed from the
609** free-list for reuse. It returns false if it is safe to retrieve the
610** page from the pager layer with the 'no-content' flag set. True otherwise.
611*/
612static int btreeGetHasContent(BtShared *pBt, Pgno pgno){
613 Bitvec *p = pBt->pHasContent;
614 return (p && (pgno>sqlite3BitvecSize(p) || sqlite3BitvecTest(p, pgno)));
615}
616
617/*
618** Clear (destroy) the BtShared.pHasContent bitvec. This should be
619** invoked at the conclusion of each write-transaction.
620*/
621static void btreeClearHasContent(BtShared *pBt){
622 sqlite3BitvecDestroy(pBt->pHasContent);
623 pBt->pHasContent = 0;
624}
625
626/*
drh138eeeb2013-03-27 03:15:23 +0000627** Release all of the apPage[] pages for a cursor.
628*/
629static void btreeReleaseAllCursorPages(BtCursor *pCur){
630 int i;
drh352a35a2017-08-15 03:46:47 +0000631 if( pCur->iPage>=0 ){
632 for(i=0; i<pCur->iPage; i++){
633 releasePageNotNull(pCur->apPage[i]);
634 }
635 releasePageNotNull(pCur->pPage);
636 pCur->iPage = -1;
drh138eeeb2013-03-27 03:15:23 +0000637 }
drh138eeeb2013-03-27 03:15:23 +0000638}
639
danf0ee1d32015-09-12 19:26:11 +0000640/*
641** The cursor passed as the only argument must point to a valid entry
642** when this function is called (i.e. have eState==CURSOR_VALID). This
643** function saves the current cursor key in variables pCur->nKey and
644** pCur->pKey. SQLITE_OK is returned if successful or an SQLite error
645** code otherwise.
646**
647** If the cursor is open on an intkey table, then the integer key
648** (the rowid) is stored in pCur->nKey and pCur->pKey is left set to
649** NULL. If the cursor is open on a non-intkey table, then pCur->pKey is
650** set to point to a malloced buffer pCur->nKey bytes in size containing
651** the key.
652*/
653static int saveCursorKey(BtCursor *pCur){
drha7c90c42016-06-04 20:37:10 +0000654 int rc = SQLITE_OK;
danf0ee1d32015-09-12 19:26:11 +0000655 assert( CURSOR_VALID==pCur->eState );
656 assert( 0==pCur->pKey );
657 assert( cursorHoldsMutex(pCur) );
658
drha7c90c42016-06-04 20:37:10 +0000659 if( pCur->curIntKey ){
660 /* Only the rowid is required for a table btree */
661 pCur->nKey = sqlite3BtreeIntegerKey(pCur);
662 }else{
danfffaf232018-12-14 13:18:35 +0000663 /* For an index btree, save the complete key content. It is possible
664 ** that the current key is corrupt. In that case, it is possible that
665 ** the sqlite3VdbeRecordUnpack() function may overread the buffer by
666 ** up to the size of 1 varint plus 1 8-byte value when the cursor
667 ** position is restored. Hence the 17 bytes of padding allocated
668 ** below. */
drhd66c4f82016-06-04 20:58:35 +0000669 void *pKey;
drha7c90c42016-06-04 20:37:10 +0000670 pCur->nKey = sqlite3BtreePayloadSize(pCur);
danfffaf232018-12-14 13:18:35 +0000671 pKey = sqlite3Malloc( pCur->nKey + 9 + 8 );
danf0ee1d32015-09-12 19:26:11 +0000672 if( pKey ){
drhcb3cabd2016-11-25 19:18:28 +0000673 rc = sqlite3BtreePayload(pCur, 0, (int)pCur->nKey, pKey);
danf0ee1d32015-09-12 19:26:11 +0000674 if( rc==SQLITE_OK ){
675 pCur->pKey = pKey;
676 }else{
677 sqlite3_free(pKey);
678 }
679 }else{
mistachkinfad30392016-02-13 23:43:46 +0000680 rc = SQLITE_NOMEM_BKPT;
danf0ee1d32015-09-12 19:26:11 +0000681 }
682 }
683 assert( !pCur->curIntKey || !pCur->pKey );
684 return rc;
685}
drh138eeeb2013-03-27 03:15:23 +0000686
687/*
drh980b1a72006-08-16 16:42:48 +0000688** Save the current cursor position in the variables BtCursor.nKey
689** and BtCursor.pKey. The cursor's state is set to CURSOR_REQUIRESEEK.
drhea8ffdf2009-07-22 00:35:23 +0000690**
691** The caller must ensure that the cursor is valid (has eState==CURSOR_VALID)
692** prior to calling this routine.
drh980b1a72006-08-16 16:42:48 +0000693*/
694static int saveCursorPosition(BtCursor *pCur){
695 int rc;
696
drhd2f83132015-03-25 17:35:01 +0000697 assert( CURSOR_VALID==pCur->eState || CURSOR_SKIPNEXT==pCur->eState );
drh980b1a72006-08-16 16:42:48 +0000698 assert( 0==pCur->pKey );
drh1fee73e2007-08-29 04:00:57 +0000699 assert( cursorHoldsMutex(pCur) );
drh980b1a72006-08-16 16:42:48 +0000700
drhd2f83132015-03-25 17:35:01 +0000701 if( pCur->eState==CURSOR_SKIPNEXT ){
702 pCur->eState = CURSOR_VALID;
703 }else{
704 pCur->skipNext = 0;
705 }
drh980b1a72006-08-16 16:42:48 +0000706
danf0ee1d32015-09-12 19:26:11 +0000707 rc = saveCursorKey(pCur);
drh980b1a72006-08-16 16:42:48 +0000708 if( rc==SQLITE_OK ){
drh138eeeb2013-03-27 03:15:23 +0000709 btreeReleaseAllCursorPages(pCur);
drh980b1a72006-08-16 16:42:48 +0000710 pCur->eState = CURSOR_REQUIRESEEK;
711 }
712
dane755e102015-09-30 12:59:12 +0000713 pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl|BTCF_AtLast);
drh980b1a72006-08-16 16:42:48 +0000714 return rc;
715}
716
drh637f3d82014-08-22 22:26:07 +0000717/* Forward reference */
718static int SQLITE_NOINLINE saveCursorsOnList(BtCursor*,Pgno,BtCursor*);
719
drh980b1a72006-08-16 16:42:48 +0000720/*
drh0ee3dbe2009-10-16 15:05:18 +0000721** Save the positions of all cursors (except pExcept) that are open on
drh637f3d82014-08-22 22:26:07 +0000722** the table with root-page iRoot. "Saving the cursor position" means that
723** the location in the btree is remembered in such a way that it can be
724** moved back to the same spot after the btree has been modified. This
725** routine is called just before cursor pExcept is used to modify the
726** table, for example in BtreeDelete() or BtreeInsert().
727**
drh27fb7462015-06-30 02:47:36 +0000728** If there are two or more cursors on the same btree, then all such
729** cursors should have their BTCF_Multiple flag set. The btreeCursor()
730** routine enforces that rule. This routine only needs to be called in
731** the uncommon case when pExpect has the BTCF_Multiple flag set.
732**
733** If pExpect!=NULL and if no other cursors are found on the same root-page,
734** then the BTCF_Multiple flag on pExpect is cleared, to avoid another
735** pointless call to this routine.
736**
drh637f3d82014-08-22 22:26:07 +0000737** Implementation note: This routine merely checks to see if any cursors
738** need to be saved. It calls out to saveCursorsOnList() in the (unusual)
739** event that cursors are in need to being saved.
drh980b1a72006-08-16 16:42:48 +0000740*/
741static int saveAllCursors(BtShared *pBt, Pgno iRoot, BtCursor *pExcept){
742 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000743 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +0000744 assert( pExcept==0 || pExcept->pBt==pBt );
drh980b1a72006-08-16 16:42:48 +0000745 for(p=pBt->pCursor; p; p=p->pNext){
drh637f3d82014-08-22 22:26:07 +0000746 if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) ) break;
747 }
drh27fb7462015-06-30 02:47:36 +0000748 if( p ) return saveCursorsOnList(p, iRoot, pExcept);
749 if( pExcept ) pExcept->curFlags &= ~BTCF_Multiple;
750 return SQLITE_OK;
drh637f3d82014-08-22 22:26:07 +0000751}
752
753/* This helper routine to saveAllCursors does the actual work of saving
754** the cursors if and when a cursor is found that actually requires saving.
755** The common case is that no cursors need to be saved, so this routine is
756** broken out from its caller to avoid unnecessary stack pointer movement.
757*/
758static int SQLITE_NOINLINE saveCursorsOnList(
drh3f387402014-09-24 01:23:00 +0000759 BtCursor *p, /* The first cursor that needs saving */
760 Pgno iRoot, /* Only save cursor with this iRoot. Save all if zero */
761 BtCursor *pExcept /* Do not save this cursor */
drh637f3d82014-08-22 22:26:07 +0000762){
763 do{
drh138eeeb2013-03-27 03:15:23 +0000764 if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) ){
drhd2f83132015-03-25 17:35:01 +0000765 if( p->eState==CURSOR_VALID || p->eState==CURSOR_SKIPNEXT ){
drh138eeeb2013-03-27 03:15:23 +0000766 int rc = saveCursorPosition(p);
767 if( SQLITE_OK!=rc ){
768 return rc;
769 }
770 }else{
drh85ef6302017-08-02 15:50:09 +0000771 testcase( p->iPage>=0 );
drh138eeeb2013-03-27 03:15:23 +0000772 btreeReleaseAllCursorPages(p);
drh980b1a72006-08-16 16:42:48 +0000773 }
774 }
drh637f3d82014-08-22 22:26:07 +0000775 p = p->pNext;
776 }while( p );
drh980b1a72006-08-16 16:42:48 +0000777 return SQLITE_OK;
778}
779
780/*
drhbf700f32007-03-31 02:36:44 +0000781** Clear the current cursor position.
782*/
danielk1977be51a652008-10-08 17:58:48 +0000783void sqlite3BtreeClearCursor(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000784 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000785 sqlite3_free(pCur->pKey);
drhbf700f32007-03-31 02:36:44 +0000786 pCur->pKey = 0;
787 pCur->eState = CURSOR_INVALID;
788}
789
790/*
danielk19773509a652009-07-06 18:56:13 +0000791** In this version of BtreeMoveto, pKey is a packed index record
792** such as is generated by the OP_MakeRecord opcode. Unpack the
793** record and then call BtreeMovetoUnpacked() to do the work.
794*/
795static int btreeMoveto(
796 BtCursor *pCur, /* Cursor open on the btree to be searched */
797 const void *pKey, /* Packed key if the btree is an index */
798 i64 nKey, /* Integer key for tables. Size of pKey for indices */
799 int bias, /* Bias search to the high end */
800 int *pRes /* Write search results here */
801){
802 int rc; /* Status code */
803 UnpackedRecord *pIdxKey; /* Unpacked index key */
danielk19773509a652009-07-06 18:56:13 +0000804
805 if( pKey ){
806 assert( nKey==(i64)(int)nKey );
drha582b012016-12-21 19:45:54 +0000807 pIdxKey = sqlite3VdbeAllocUnpackedRecord(pCur->pKeyInfo);
mistachkinfad30392016-02-13 23:43:46 +0000808 if( pIdxKey==0 ) return SQLITE_NOMEM_BKPT;
mistachkin0fe5f952011-09-14 18:19:08 +0000809 sqlite3VdbeRecordUnpack(pCur->pKeyInfo, (int)nKey, pKey, pIdxKey);
drh094b7582013-11-30 12:49:28 +0000810 if( pIdxKey->nField==0 ){
mistachkin88a79732017-09-04 19:31:54 +0000811 rc = SQLITE_CORRUPT_BKPT;
drha582b012016-12-21 19:45:54 +0000812 goto moveto_done;
drh094b7582013-11-30 12:49:28 +0000813 }
danielk19773509a652009-07-06 18:56:13 +0000814 }else{
815 pIdxKey = 0;
816 }
817 rc = sqlite3BtreeMovetoUnpacked(pCur, pIdxKey, nKey, bias, pRes);
drha582b012016-12-21 19:45:54 +0000818moveto_done:
819 if( pIdxKey ){
820 sqlite3DbFree(pCur->pKeyInfo->db, pIdxKey);
danielk19773509a652009-07-06 18:56:13 +0000821 }
822 return rc;
823}
824
825/*
drh980b1a72006-08-16 16:42:48 +0000826** Restore the cursor to the position it was in (or as close to as possible)
827** when saveCursorPosition() was called. Note that this call deletes the
828** saved position info stored by saveCursorPosition(), so there can be
drha3460582008-07-11 21:02:53 +0000829** at most one effective restoreCursorPosition() call after each
drh980b1a72006-08-16 16:42:48 +0000830** saveCursorPosition().
drh980b1a72006-08-16 16:42:48 +0000831*/
danielk197730548662009-07-09 05:07:37 +0000832static int btreeRestoreCursorPosition(BtCursor *pCur){
drhbf700f32007-03-31 02:36:44 +0000833 int rc;
drhd2f83132015-03-25 17:35:01 +0000834 int skipNext;
dan7a2347e2016-01-07 16:43:54 +0000835 assert( cursorOwnsBtShared(pCur) );
drhfb982642007-08-30 01:19:59 +0000836 assert( pCur->eState>=CURSOR_REQUIRESEEK );
837 if( pCur->eState==CURSOR_FAULT ){
drh4c301aa2009-07-15 17:25:45 +0000838 return pCur->skipNext;
drhfb982642007-08-30 01:19:59 +0000839 }
drh980b1a72006-08-16 16:42:48 +0000840 pCur->eState = CURSOR_INVALID;
drhd2f83132015-03-25 17:35:01 +0000841 rc = btreeMoveto(pCur, pCur->pKey, pCur->nKey, 0, &skipNext);
drh980b1a72006-08-16 16:42:48 +0000842 if( rc==SQLITE_OK ){
drh17435752007-08-16 04:30:38 +0000843 sqlite3_free(pCur->pKey);
drh980b1a72006-08-16 16:42:48 +0000844 pCur->pKey = 0;
drhbf700f32007-03-31 02:36:44 +0000845 assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_INVALID );
drhd2f83132015-03-25 17:35:01 +0000846 pCur->skipNext |= skipNext;
drh9b47ee32013-08-20 03:13:51 +0000847 if( pCur->skipNext && pCur->eState==CURSOR_VALID ){
848 pCur->eState = CURSOR_SKIPNEXT;
849 }
drh980b1a72006-08-16 16:42:48 +0000850 }
851 return rc;
852}
853
drha3460582008-07-11 21:02:53 +0000854#define restoreCursorPosition(p) \
drhfb982642007-08-30 01:19:59 +0000855 (p->eState>=CURSOR_REQUIRESEEK ? \
danielk197730548662009-07-09 05:07:37 +0000856 btreeRestoreCursorPosition(p) : \
drh16a9b832007-05-05 18:39:25 +0000857 SQLITE_OK)
drh980b1a72006-08-16 16:42:48 +0000858
drha3460582008-07-11 21:02:53 +0000859/*
drh6848dad2014-08-22 23:33:03 +0000860** Determine whether or not a cursor has moved from the position where
861** it was last placed, or has been invalidated for any other reason.
862** Cursors can move when the row they are pointing at is deleted out
863** from under them, for example. Cursor might also move if a btree
864** is rebalanced.
drha3460582008-07-11 21:02:53 +0000865**
drh6848dad2014-08-22 23:33:03 +0000866** Calling this routine with a NULL cursor pointer returns false.
drh86dd3712014-03-25 11:00:21 +0000867**
drh6848dad2014-08-22 23:33:03 +0000868** Use the separate sqlite3BtreeCursorRestore() routine to restore a cursor
869** back to where it ought to be if this routine returns true.
drha3460582008-07-11 21:02:53 +0000870*/
drh6848dad2014-08-22 23:33:03 +0000871int sqlite3BtreeCursorHasMoved(BtCursor *pCur){
drh5ba5f5b2018-06-02 16:32:04 +0000872 assert( EIGHT_BYTE_ALIGNMENT(pCur)
873 || pCur==sqlite3BtreeFakeValidCursor() );
874 assert( offsetof(BtCursor, eState)==0 );
875 assert( sizeof(pCur->eState)==1 );
876 return CURSOR_VALID != *(u8*)pCur;
drh6848dad2014-08-22 23:33:03 +0000877}
878
879/*
drhfe0cf7a2017-08-16 19:20:20 +0000880** Return a pointer to a fake BtCursor object that will always answer
881** false to the sqlite3BtreeCursorHasMoved() routine above. The fake
882** cursor returned must not be used with any other Btree interface.
883*/
884BtCursor *sqlite3BtreeFakeValidCursor(void){
885 static u8 fakeCursor = CURSOR_VALID;
886 assert( offsetof(BtCursor, eState)==0 );
887 return (BtCursor*)&fakeCursor;
888}
889
890/*
drh6848dad2014-08-22 23:33:03 +0000891** This routine restores a cursor back to its original position after it
892** has been moved by some outside activity (such as a btree rebalance or
893** a row having been deleted out from under the cursor).
894**
895** On success, the *pDifferentRow parameter is false if the cursor is left
896** pointing at exactly the same row. *pDifferntRow is the row the cursor
897** was pointing to has been deleted, forcing the cursor to point to some
898** nearby row.
899**
900** This routine should only be called for a cursor that just returned
901** TRUE from sqlite3BtreeCursorHasMoved().
902*/
903int sqlite3BtreeCursorRestore(BtCursor *pCur, int *pDifferentRow){
drha3460582008-07-11 21:02:53 +0000904 int rc;
905
drh6848dad2014-08-22 23:33:03 +0000906 assert( pCur!=0 );
907 assert( pCur->eState!=CURSOR_VALID );
drha3460582008-07-11 21:02:53 +0000908 rc = restoreCursorPosition(pCur);
909 if( rc ){
drh6848dad2014-08-22 23:33:03 +0000910 *pDifferentRow = 1;
drha3460582008-07-11 21:02:53 +0000911 return rc;
912 }
drh606a3572015-03-25 18:29:10 +0000913 if( pCur->eState!=CURSOR_VALID ){
drh6848dad2014-08-22 23:33:03 +0000914 *pDifferentRow = 1;
drha3460582008-07-11 21:02:53 +0000915 }else{
drh606a3572015-03-25 18:29:10 +0000916 assert( pCur->skipNext==0 );
drh6848dad2014-08-22 23:33:03 +0000917 *pDifferentRow = 0;
drha3460582008-07-11 21:02:53 +0000918 }
919 return SQLITE_OK;
920}
921
drhf7854c72015-10-27 13:24:37 +0000922#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh28935362013-12-07 20:39:19 +0000923/*
drh0df57012015-08-14 15:05:55 +0000924** Provide hints to the cursor. The particular hint given (and the type
925** and number of the varargs parameters) is determined by the eHintType
926** parameter. See the definitions of the BTREE_HINT_* macros for details.
drh28935362013-12-07 20:39:19 +0000927*/
drh0df57012015-08-14 15:05:55 +0000928void sqlite3BtreeCursorHint(BtCursor *pCur, int eHintType, ...){
drhf7854c72015-10-27 13:24:37 +0000929 /* Used only by system that substitute their own storage engine */
drh28935362013-12-07 20:39:19 +0000930}
drhf7854c72015-10-27 13:24:37 +0000931#endif
932
933/*
934** Provide flag hints to the cursor.
935*/
936void sqlite3BtreeCursorHintFlags(BtCursor *pCur, unsigned x){
937 assert( x==BTREE_SEEK_EQ || x==BTREE_BULKLOAD || x==0 );
938 pCur->hints = x;
939}
940
drh28935362013-12-07 20:39:19 +0000941
danielk1977599fcba2004-11-08 07:13:13 +0000942#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977afcdd022004-10-31 16:25:42 +0000943/*
drha3152892007-05-05 11:48:52 +0000944** Given a page number of a regular database page, return the page
945** number for the pointer-map page that contains the entry for the
946** input page number.
drh5f77b2e2010-08-21 15:09:37 +0000947**
948** Return 0 (not a valid page) for pgno==1 since there is
949** no pointer map associated with page 1. The integrity_check logic
950** requires that ptrmapPageno(*,1)!=1.
danielk1977afcdd022004-10-31 16:25:42 +0000951*/
danielk1977266664d2006-02-10 08:24:21 +0000952static Pgno ptrmapPageno(BtShared *pBt, Pgno pgno){
danielk197789d40042008-11-17 14:20:56 +0000953 int nPagesPerMapPage;
954 Pgno iPtrMap, ret;
drh1fee73e2007-08-29 04:00:57 +0000955 assert( sqlite3_mutex_held(pBt->mutex) );
drh5f77b2e2010-08-21 15:09:37 +0000956 if( pgno<2 ) return 0;
drhd677b3d2007-08-20 22:48:41 +0000957 nPagesPerMapPage = (pBt->usableSize/5)+1;
958 iPtrMap = (pgno-2)/nPagesPerMapPage;
959 ret = (iPtrMap*nPagesPerMapPage) + 2;
danielk1977266664d2006-02-10 08:24:21 +0000960 if( ret==PENDING_BYTE_PAGE(pBt) ){
961 ret++;
962 }
963 return ret;
964}
danielk1977a19df672004-11-03 11:37:07 +0000965
danielk1977afcdd022004-10-31 16:25:42 +0000966/*
danielk1977afcdd022004-10-31 16:25:42 +0000967** Write an entry into the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000968**
969** This routine updates the pointer map entry for page number 'key'
970** so that it maps to type 'eType' and parent page number 'pgno'.
drh98add2e2009-07-20 17:11:49 +0000971**
972** If *pRC is initially non-zero (non-SQLITE_OK) then this routine is
973** a no-op. If an error occurs, the appropriate error code is written
974** into *pRC.
danielk1977afcdd022004-10-31 16:25:42 +0000975*/
drh98add2e2009-07-20 17:11:49 +0000976static void ptrmapPut(BtShared *pBt, Pgno key, u8 eType, Pgno parent, int *pRC){
danielk19773b8a05f2007-03-19 17:44:26 +0000977 DbPage *pDbPage; /* The pointer map page */
978 u8 *pPtrmap; /* The pointer map data */
979 Pgno iPtrmap; /* The pointer map page number */
980 int offset; /* Offset in pointer map page */
drh98add2e2009-07-20 17:11:49 +0000981 int rc; /* Return code from subfunctions */
982
983 if( *pRC ) return;
danielk1977afcdd022004-10-31 16:25:42 +0000984
drh1fee73e2007-08-29 04:00:57 +0000985 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977266664d2006-02-10 08:24:21 +0000986 /* The master-journal page number must never be used as a pointer map page */
987 assert( 0==PTRMAP_ISPAGE(pBt, PENDING_BYTE_PAGE(pBt)) );
988
danielk1977ac11ee62005-01-15 12:45:51 +0000989 assert( pBt->autoVacuum );
danielk1977fdb7cdb2005-01-17 02:12:18 +0000990 if( key==0 ){
drh98add2e2009-07-20 17:11:49 +0000991 *pRC = SQLITE_CORRUPT_BKPT;
992 return;
danielk1977fdb7cdb2005-01-17 02:12:18 +0000993 }
danielk1977266664d2006-02-10 08:24:21 +0000994 iPtrmap = PTRMAP_PAGENO(pBt, key);
drh9584f582015-11-04 20:22:37 +0000995 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage, 0);
danielk1977687566d2004-11-02 12:56:41 +0000996 if( rc!=SQLITE_OK ){
drh98add2e2009-07-20 17:11:49 +0000997 *pRC = rc;
998 return;
danielk1977afcdd022004-10-31 16:25:42 +0000999 }
drh203b1ea2018-12-14 03:14:18 +00001000 if( ((char*)sqlite3PagerGetExtra(pDbPage))[0]!=0 ){
1001 /* The first byte of the extra data is the MemPage.isInit byte.
1002 ** If that byte is set, it means this page is also being used
1003 ** as a btree page. */
1004 *pRC = SQLITE_CORRUPT_BKPT;
1005 goto ptrmap_exit;
1006 }
danielk19778c666b12008-07-18 09:34:57 +00001007 offset = PTRMAP_PTROFFSET(iPtrmap, key);
drhacfc72b2009-06-05 18:44:15 +00001008 if( offset<0 ){
drh98add2e2009-07-20 17:11:49 +00001009 *pRC = SQLITE_CORRUPT_BKPT;
drh4925a552009-07-07 11:39:58 +00001010 goto ptrmap_exit;
drhacfc72b2009-06-05 18:44:15 +00001011 }
drhfc243732011-05-17 15:21:56 +00001012 assert( offset <= (int)pBt->usableSize-5 );
danielk19773b8a05f2007-03-19 17:44:26 +00001013 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +00001014
drh615ae552005-01-16 23:21:00 +00001015 if( eType!=pPtrmap[offset] || get4byte(&pPtrmap[offset+1])!=parent ){
1016 TRACE(("PTRMAP_UPDATE: %d->(%d,%d)\n", key, eType, parent));
drh98add2e2009-07-20 17:11:49 +00001017 *pRC= rc = sqlite3PagerWrite(pDbPage);
danielk19775558a8a2005-01-17 07:53:44 +00001018 if( rc==SQLITE_OK ){
1019 pPtrmap[offset] = eType;
1020 put4byte(&pPtrmap[offset+1], parent);
danielk1977afcdd022004-10-31 16:25:42 +00001021 }
danielk1977afcdd022004-10-31 16:25:42 +00001022 }
1023
drh4925a552009-07-07 11:39:58 +00001024ptrmap_exit:
danielk19773b8a05f2007-03-19 17:44:26 +00001025 sqlite3PagerUnref(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +00001026}
1027
1028/*
1029** Read an entry from the pointer map.
danielk1977687566d2004-11-02 12:56:41 +00001030**
1031** This routine retrieves the pointer map entry for page 'key', writing
1032** the type and parent page number to *pEType and *pPgno respectively.
1033** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +00001034*/
danielk1977aef0bf62005-12-30 16:28:01 +00001035static int ptrmapGet(BtShared *pBt, Pgno key, u8 *pEType, Pgno *pPgno){
danielk19773b8a05f2007-03-19 17:44:26 +00001036 DbPage *pDbPage; /* The pointer map page */
danielk1977afcdd022004-10-31 16:25:42 +00001037 int iPtrmap; /* Pointer map page index */
1038 u8 *pPtrmap; /* Pointer map page data */
1039 int offset; /* Offset of entry in pointer map */
1040 int rc;
1041
drh1fee73e2007-08-29 04:00:57 +00001042 assert( sqlite3_mutex_held(pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00001043
danielk1977266664d2006-02-10 08:24:21 +00001044 iPtrmap = PTRMAP_PAGENO(pBt, key);
drh9584f582015-11-04 20:22:37 +00001045 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage, 0);
danielk1977afcdd022004-10-31 16:25:42 +00001046 if( rc!=0 ){
1047 return rc;
1048 }
danielk19773b8a05f2007-03-19 17:44:26 +00001049 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +00001050
danielk19778c666b12008-07-18 09:34:57 +00001051 offset = PTRMAP_PTROFFSET(iPtrmap, key);
drhfc243732011-05-17 15:21:56 +00001052 if( offset<0 ){
1053 sqlite3PagerUnref(pDbPage);
1054 return SQLITE_CORRUPT_BKPT;
1055 }
1056 assert( offset <= (int)pBt->usableSize-5 );
drh43617e92006-03-06 20:55:46 +00001057 assert( pEType!=0 );
1058 *pEType = pPtrmap[offset];
danielk1977687566d2004-11-02 12:56:41 +00001059 if( pPgno ) *pPgno = get4byte(&pPtrmap[offset+1]);
danielk1977afcdd022004-10-31 16:25:42 +00001060
danielk19773b8a05f2007-03-19 17:44:26 +00001061 sqlite3PagerUnref(pDbPage);
drhcc97ca42017-06-07 22:32:59 +00001062 if( *pEType<1 || *pEType>5 ) return SQLITE_CORRUPT_PGNO(iPtrmap);
danielk1977afcdd022004-10-31 16:25:42 +00001063 return SQLITE_OK;
1064}
1065
danielk197785d90ca2008-07-19 14:25:15 +00001066#else /* if defined SQLITE_OMIT_AUTOVACUUM */
drh98add2e2009-07-20 17:11:49 +00001067 #define ptrmapPut(w,x,y,z,rc)
danielk197785d90ca2008-07-19 14:25:15 +00001068 #define ptrmapGet(w,x,y,z) SQLITE_OK
drh98add2e2009-07-20 17:11:49 +00001069 #define ptrmapPutOvflPtr(x, y, rc)
danielk197785d90ca2008-07-19 14:25:15 +00001070#endif
danielk1977afcdd022004-10-31 16:25:42 +00001071
drh0d316a42002-08-11 20:10:47 +00001072/*
drh271efa52004-05-30 19:19:05 +00001073** Given a btree page and a cell index (0 means the first cell on
1074** the page, 1 means the second cell, and so forth) return a pointer
1075** to the cell content.
1076**
drhf44890a2015-06-27 03:58:15 +00001077** findCellPastPtr() does the same except it skips past the initial
1078** 4-byte child pointer found on interior pages, if there is one.
1079**
drh271efa52004-05-30 19:19:05 +00001080** This routine works only for pages that do not contain overflow cells.
drh3aac2dd2004-04-26 14:10:20 +00001081*/
drh1688c862008-07-18 02:44:17 +00001082#define findCell(P,I) \
drh329428e2015-06-30 13:28:18 +00001083 ((P)->aData + ((P)->maskPage & get2byteAligned(&(P)->aCellIdx[2*(I)])))
drhf44890a2015-06-27 03:58:15 +00001084#define findCellPastPtr(P,I) \
drh329428e2015-06-30 13:28:18 +00001085 ((P)->aDataOfst + ((P)->maskPage & get2byteAligned(&(P)->aCellIdx[2*(I)])))
drh68f2a572011-06-03 17:50:49 +00001086
drh43605152004-05-29 21:46:49 +00001087
1088/*
drh5fa60512015-06-19 17:19:34 +00001089** This is common tail processing for btreeParseCellPtr() and
1090** btreeParseCellPtrIndex() for the case when the cell does not fit entirely
1091** on a single B-tree page. Make necessary adjustments to the CellInfo
1092** structure.
drh43605152004-05-29 21:46:49 +00001093*/
drh5fa60512015-06-19 17:19:34 +00001094static SQLITE_NOINLINE void btreeParseCellAdjustSizeForOverflow(
1095 MemPage *pPage, /* Page containing the cell */
1096 u8 *pCell, /* Pointer to the cell text. */
1097 CellInfo *pInfo /* Fill in this structure */
1098){
1099 /* If the payload will not fit completely on the local page, we have
1100 ** to decide how much to store locally and how much to spill onto
1101 ** overflow pages. The strategy is to minimize the amount of unused
1102 ** space on overflow pages while keeping the amount of local storage
1103 ** in between minLocal and maxLocal.
1104 **
1105 ** Warning: changing the way overflow payload is distributed in any
1106 ** way will result in an incompatible file format.
1107 */
1108 int minLocal; /* Minimum amount of payload held locally */
1109 int maxLocal; /* Maximum amount of payload held locally */
1110 int surplus; /* Overflow payload available for local storage */
1111
1112 minLocal = pPage->minLocal;
1113 maxLocal = pPage->maxLocal;
1114 surplus = minLocal + (pInfo->nPayload - minLocal)%(pPage->pBt->usableSize-4);
1115 testcase( surplus==maxLocal );
1116 testcase( surplus==maxLocal+1 );
1117 if( surplus <= maxLocal ){
1118 pInfo->nLocal = (u16)surplus;
1119 }else{
1120 pInfo->nLocal = (u16)minLocal;
drh43605152004-05-29 21:46:49 +00001121 }
drh45ac1c72015-12-18 03:59:16 +00001122 pInfo->nSize = (u16)(&pInfo->pPayload[pInfo->nLocal] - pCell) + 4;
drh43605152004-05-29 21:46:49 +00001123}
1124
1125/*
drh5fa60512015-06-19 17:19:34 +00001126** The following routines are implementations of the MemPage.xParseCell()
1127** method.
danielk19771cc5ed82007-05-16 17:28:43 +00001128**
drh5fa60512015-06-19 17:19:34 +00001129** Parse a cell content block and fill in the CellInfo structure.
1130**
1131** btreeParseCellPtr() => table btree leaf nodes
1132** btreeParseCellNoPayload() => table btree internal nodes
1133** btreeParseCellPtrIndex() => index btree nodes
1134**
1135** There is also a wrapper function btreeParseCell() that works for
1136** all MemPage types and that references the cell by index rather than
1137** by pointer.
drh43605152004-05-29 21:46:49 +00001138*/
drh5fa60512015-06-19 17:19:34 +00001139static void btreeParseCellPtrNoPayload(
1140 MemPage *pPage, /* Page containing the cell */
1141 u8 *pCell, /* Pointer to the cell text. */
1142 CellInfo *pInfo /* Fill in this structure */
1143){
1144 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
1145 assert( pPage->leaf==0 );
drh5fa60512015-06-19 17:19:34 +00001146 assert( pPage->childPtrSize==4 );
drh94a31152015-07-01 04:08:40 +00001147#ifndef SQLITE_DEBUG
1148 UNUSED_PARAMETER(pPage);
1149#endif
drh5fa60512015-06-19 17:19:34 +00001150 pInfo->nSize = 4 + getVarint(&pCell[4], (u64*)&pInfo->nKey);
1151 pInfo->nPayload = 0;
1152 pInfo->nLocal = 0;
drh5fa60512015-06-19 17:19:34 +00001153 pInfo->pPayload = 0;
1154 return;
1155}
danielk197730548662009-07-09 05:07:37 +00001156static void btreeParseCellPtr(
drh3aac2dd2004-04-26 14:10:20 +00001157 MemPage *pPage, /* Page containing the cell */
drh43605152004-05-29 21:46:49 +00001158 u8 *pCell, /* Pointer to the cell text. */
drh6f11bef2004-05-13 01:12:56 +00001159 CellInfo *pInfo /* Fill in this structure */
drh3aac2dd2004-04-26 14:10:20 +00001160){
drh3e28ff52014-09-24 00:59:08 +00001161 u8 *pIter; /* For scanning through pCell */
drh271efa52004-05-30 19:19:05 +00001162 u32 nPayload; /* Number of bytes of cell payload */
drh56cb04e2015-06-19 18:24:37 +00001163 u64 iKey; /* Extracted Key value */
drh43605152004-05-29 21:46:49 +00001164
drh1fee73e2007-08-29 04:00:57 +00001165 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhab01f612004-05-22 02:55:23 +00001166 assert( pPage->leaf==0 || pPage->leaf==1 );
drh5fa60512015-06-19 17:19:34 +00001167 assert( pPage->intKeyLeaf );
1168 assert( pPage->childPtrSize==0 );
drh56cb04e2015-06-19 18:24:37 +00001169 pIter = pCell;
1170
1171 /* The next block of code is equivalent to:
1172 **
1173 ** pIter += getVarint32(pIter, nPayload);
1174 **
1175 ** The code is inlined to avoid a function call.
1176 */
1177 nPayload = *pIter;
1178 if( nPayload>=0x80 ){
drheeab2c62015-06-19 20:08:39 +00001179 u8 *pEnd = &pIter[8];
drh56cb04e2015-06-19 18:24:37 +00001180 nPayload &= 0x7f;
1181 do{
1182 nPayload = (nPayload<<7) | (*++pIter & 0x7f);
1183 }while( (*pIter)>=0x80 && pIter<pEnd );
drh6f11bef2004-05-13 01:12:56 +00001184 }
drh56cb04e2015-06-19 18:24:37 +00001185 pIter++;
1186
1187 /* The next block of code is equivalent to:
1188 **
1189 ** pIter += getVarint(pIter, (u64*)&pInfo->nKey);
1190 **
1191 ** The code is inlined to avoid a function call.
1192 */
1193 iKey = *pIter;
1194 if( iKey>=0x80 ){
1195 u8 *pEnd = &pIter[7];
1196 iKey &= 0x7f;
1197 while(1){
1198 iKey = (iKey<<7) | (*++pIter & 0x7f);
1199 if( (*pIter)<0x80 ) break;
1200 if( pIter>=pEnd ){
1201 iKey = (iKey<<8) | *++pIter;
1202 break;
1203 }
1204 }
1205 }
1206 pIter++;
1207
1208 pInfo->nKey = *(i64*)&iKey;
drh72365832007-03-06 15:53:44 +00001209 pInfo->nPayload = nPayload;
drhab1cc582014-09-23 21:25:19 +00001210 pInfo->pPayload = pIter;
drh0a45c272009-07-08 01:49:11 +00001211 testcase( nPayload==pPage->maxLocal );
1212 testcase( nPayload==pPage->maxLocal+1 );
drhab1cc582014-09-23 21:25:19 +00001213 if( nPayload<=pPage->maxLocal ){
drh271efa52004-05-30 19:19:05 +00001214 /* This is the (easy) common case where the entire payload fits
1215 ** on the local page. No overflow is required.
1216 */
drhab1cc582014-09-23 21:25:19 +00001217 pInfo->nSize = nPayload + (u16)(pIter - pCell);
1218 if( pInfo->nSize<4 ) pInfo->nSize = 4;
drhf49661a2008-12-10 16:45:50 +00001219 pInfo->nLocal = (u16)nPayload;
drh6f11bef2004-05-13 01:12:56 +00001220 }else{
drh5fa60512015-06-19 17:19:34 +00001221 btreeParseCellAdjustSizeForOverflow(pPage, pCell, pInfo);
drh6f11bef2004-05-13 01:12:56 +00001222 }
drh3aac2dd2004-04-26 14:10:20 +00001223}
drh5fa60512015-06-19 17:19:34 +00001224static void btreeParseCellPtrIndex(
1225 MemPage *pPage, /* Page containing the cell */
1226 u8 *pCell, /* Pointer to the cell text. */
1227 CellInfo *pInfo /* Fill in this structure */
1228){
1229 u8 *pIter; /* For scanning through pCell */
1230 u32 nPayload; /* Number of bytes of cell payload */
drh3aac2dd2004-04-26 14:10:20 +00001231
drh5fa60512015-06-19 17:19:34 +00001232 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
1233 assert( pPage->leaf==0 || pPage->leaf==1 );
1234 assert( pPage->intKeyLeaf==0 );
drh5fa60512015-06-19 17:19:34 +00001235 pIter = pCell + pPage->childPtrSize;
1236 nPayload = *pIter;
1237 if( nPayload>=0x80 ){
drheeab2c62015-06-19 20:08:39 +00001238 u8 *pEnd = &pIter[8];
drh5fa60512015-06-19 17:19:34 +00001239 nPayload &= 0x7f;
1240 do{
1241 nPayload = (nPayload<<7) | (*++pIter & 0x7f);
1242 }while( *(pIter)>=0x80 && pIter<pEnd );
1243 }
1244 pIter++;
1245 pInfo->nKey = nPayload;
1246 pInfo->nPayload = nPayload;
1247 pInfo->pPayload = pIter;
1248 testcase( nPayload==pPage->maxLocal );
1249 testcase( nPayload==pPage->maxLocal+1 );
1250 if( nPayload<=pPage->maxLocal ){
1251 /* This is the (easy) common case where the entire payload fits
1252 ** on the local page. No overflow is required.
1253 */
1254 pInfo->nSize = nPayload + (u16)(pIter - pCell);
1255 if( pInfo->nSize<4 ) pInfo->nSize = 4;
1256 pInfo->nLocal = (u16)nPayload;
drh5fa60512015-06-19 17:19:34 +00001257 }else{
1258 btreeParseCellAdjustSizeForOverflow(pPage, pCell, pInfo);
drh3aac2dd2004-04-26 14:10:20 +00001259 }
1260}
danielk197730548662009-07-09 05:07:37 +00001261static void btreeParseCell(
drh43605152004-05-29 21:46:49 +00001262 MemPage *pPage, /* Page containing the cell */
1263 int iCell, /* The cell index. First cell is 0 */
1264 CellInfo *pInfo /* Fill in this structure */
1265){
drh5fa60512015-06-19 17:19:34 +00001266 pPage->xParseCell(pPage, findCell(pPage, iCell), pInfo);
drh43605152004-05-29 21:46:49 +00001267}
drh3aac2dd2004-04-26 14:10:20 +00001268
1269/*
drh5fa60512015-06-19 17:19:34 +00001270** The following routines are implementations of the MemPage.xCellSize
1271** method.
1272**
drh43605152004-05-29 21:46:49 +00001273** Compute the total number of bytes that a Cell needs in the cell
1274** data area of the btree-page. The return number includes the cell
1275** data header and the local payload, but not any overflow page or
1276** the space used by the cell pointer.
drh25ada072015-06-19 15:07:14 +00001277**
drh5fa60512015-06-19 17:19:34 +00001278** cellSizePtrNoPayload() => table internal nodes
1279** cellSizePtr() => all index nodes & table leaf nodes
drh3b7511c2001-05-26 13:15:44 +00001280*/
danielk1977ae5558b2009-04-29 11:31:47 +00001281static u16 cellSizePtr(MemPage *pPage, u8 *pCell){
drh3f387402014-09-24 01:23:00 +00001282 u8 *pIter = pCell + pPage->childPtrSize; /* For looping over bytes of pCell */
1283 u8 *pEnd; /* End mark for a varint */
1284 u32 nSize; /* Size value to return */
danielk1977ae5558b2009-04-29 11:31:47 +00001285
1286#ifdef SQLITE_DEBUG
1287 /* The value returned by this function should always be the same as
1288 ** the (CellInfo.nSize) value found by doing a full parse of the
1289 ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
1290 ** this function verifies that this invariant is not violated. */
1291 CellInfo debuginfo;
drh5fa60512015-06-19 17:19:34 +00001292 pPage->xParseCell(pPage, pCell, &debuginfo);
danielk1977ae5558b2009-04-29 11:31:47 +00001293#endif
1294
drh3e28ff52014-09-24 00:59:08 +00001295 nSize = *pIter;
1296 if( nSize>=0x80 ){
drheeab2c62015-06-19 20:08:39 +00001297 pEnd = &pIter[8];
drh3e28ff52014-09-24 00:59:08 +00001298 nSize &= 0x7f;
1299 do{
1300 nSize = (nSize<<7) | (*++pIter & 0x7f);
1301 }while( *(pIter)>=0x80 && pIter<pEnd );
1302 }
1303 pIter++;
danielk1977ae5558b2009-04-29 11:31:47 +00001304 if( pPage->intKey ){
danielk1977ae5558b2009-04-29 11:31:47 +00001305 /* pIter now points at the 64-bit integer key value, a variable length
1306 ** integer. The following block moves pIter to point at the first byte
1307 ** past the end of the key value. */
1308 pEnd = &pIter[9];
1309 while( (*pIter++)&0x80 && pIter<pEnd );
danielk1977ae5558b2009-04-29 11:31:47 +00001310 }
drh0a45c272009-07-08 01:49:11 +00001311 testcase( nSize==pPage->maxLocal );
1312 testcase( nSize==pPage->maxLocal+1 );
drh3e28ff52014-09-24 00:59:08 +00001313 if( nSize<=pPage->maxLocal ){
1314 nSize += (u32)(pIter - pCell);
1315 if( nSize<4 ) nSize = 4;
1316 }else{
danielk1977ae5558b2009-04-29 11:31:47 +00001317 int minLocal = pPage->minLocal;
1318 nSize = minLocal + (nSize - minLocal) % (pPage->pBt->usableSize - 4);
drh0a45c272009-07-08 01:49:11 +00001319 testcase( nSize==pPage->maxLocal );
1320 testcase( nSize==pPage->maxLocal+1 );
danielk1977ae5558b2009-04-29 11:31:47 +00001321 if( nSize>pPage->maxLocal ){
1322 nSize = minLocal;
1323 }
drh3e28ff52014-09-24 00:59:08 +00001324 nSize += 4 + (u16)(pIter - pCell);
danielk1977ae5558b2009-04-29 11:31:47 +00001325 }
drhdc41d602014-09-22 19:51:35 +00001326 assert( nSize==debuginfo.nSize || CORRUPT_DB );
shane60a4b532009-05-06 18:57:09 +00001327 return (u16)nSize;
danielk1977ae5558b2009-04-29 11:31:47 +00001328}
drh25ada072015-06-19 15:07:14 +00001329static u16 cellSizePtrNoPayload(MemPage *pPage, u8 *pCell){
1330 u8 *pIter = pCell + 4; /* For looping over bytes of pCell */
1331 u8 *pEnd; /* End mark for a varint */
1332
1333#ifdef SQLITE_DEBUG
1334 /* The value returned by this function should always be the same as
1335 ** the (CellInfo.nSize) value found by doing a full parse of the
1336 ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
1337 ** this function verifies that this invariant is not violated. */
1338 CellInfo debuginfo;
drh5fa60512015-06-19 17:19:34 +00001339 pPage->xParseCell(pPage, pCell, &debuginfo);
drh94a31152015-07-01 04:08:40 +00001340#else
1341 UNUSED_PARAMETER(pPage);
drh25ada072015-06-19 15:07:14 +00001342#endif
1343
1344 assert( pPage->childPtrSize==4 );
1345 pEnd = pIter + 9;
1346 while( (*pIter++)&0x80 && pIter<pEnd );
1347 assert( debuginfo.nSize==(u16)(pIter - pCell) || CORRUPT_DB );
1348 return (u16)(pIter - pCell);
1349}
1350
drh0ee3dbe2009-10-16 15:05:18 +00001351
1352#ifdef SQLITE_DEBUG
1353/* This variation on cellSizePtr() is used inside of assert() statements
1354** only. */
drha9121e42008-02-19 14:59:35 +00001355static u16 cellSize(MemPage *pPage, int iCell){
drh25ada072015-06-19 15:07:14 +00001356 return pPage->xCellSize(pPage, findCell(pPage, iCell));
drh43605152004-05-29 21:46:49 +00001357}
danielk1977bc6ada42004-06-30 08:20:16 +00001358#endif
drh3b7511c2001-05-26 13:15:44 +00001359
danielk197779a40da2005-01-16 08:00:01 +00001360#ifndef SQLITE_OMIT_AUTOVACUUM
drh3b7511c2001-05-26 13:15:44 +00001361/*
danielk197726836652005-01-17 01:33:13 +00001362** If the cell pCell, part of page pPage contains a pointer
danielk197779a40da2005-01-16 08:00:01 +00001363** to an overflow page, insert an entry into the pointer-map
1364** for the overflow page.
danielk1977ac11ee62005-01-15 12:45:51 +00001365*/
drh98add2e2009-07-20 17:11:49 +00001366static void ptrmapPutOvflPtr(MemPage *pPage, u8 *pCell, int *pRC){
drhfa67c3c2008-07-11 02:21:40 +00001367 CellInfo info;
drh98add2e2009-07-20 17:11:49 +00001368 if( *pRC ) return;
drhfa67c3c2008-07-11 02:21:40 +00001369 assert( pCell!=0 );
drh5fa60512015-06-19 17:19:34 +00001370 pPage->xParseCell(pPage, pCell, &info);
drh45ac1c72015-12-18 03:59:16 +00001371 if( info.nLocal<info.nPayload ){
drhe7acce62018-12-14 16:00:38 +00001372 Pgno ovfl;
1373 if( SQLITE_WITHIN(pPage->aDataEnd, pCell, pCell+info.nLocal) ){
1374 *pRC = SQLITE_CORRUPT_BKPT;
1375 return;
1376 }
1377 ovfl = get4byte(&pCell[info.nSize-4]);
drh98add2e2009-07-20 17:11:49 +00001378 ptrmapPut(pPage->pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno, pRC);
danielk1977ac11ee62005-01-15 12:45:51 +00001379 }
danielk1977ac11ee62005-01-15 12:45:51 +00001380}
danielk197779a40da2005-01-16 08:00:01 +00001381#endif
1382
danielk1977ac11ee62005-01-15 12:45:51 +00001383
drhda200cc2004-05-09 11:51:38 +00001384/*
dane6d065a2017-02-24 19:58:22 +00001385** Defragment the page given. This routine reorganizes cells within the
1386** page so that there are no free-blocks on the free-block list.
1387**
1388** Parameter nMaxFrag is the maximum amount of fragmented space that may be
1389** present in the page after this routine returns.
drhfdab0262014-11-20 15:30:50 +00001390**
1391** EVIDENCE-OF: R-44582-60138 SQLite may from time to time reorganize a
1392** b-tree page so that there are no freeblocks or fragment bytes, all
1393** unused bytes are contained in the unallocated space region, and all
1394** cells are packed tightly at the end of the page.
drh365d68f2001-05-11 11:02:46 +00001395*/
dane6d065a2017-02-24 19:58:22 +00001396static int defragmentPage(MemPage *pPage, int nMaxFrag){
drh43605152004-05-29 21:46:49 +00001397 int i; /* Loop counter */
peter.d.reid60ec9142014-09-06 16:39:46 +00001398 int pc; /* Address of the i-th cell */
drh43605152004-05-29 21:46:49 +00001399 int hdr; /* Offset to the page header */
1400 int size; /* Size of a cell */
1401 int usableSize; /* Number of usable bytes on a page */
1402 int cellOffset; /* Offset to the cell pointer array */
drh281b21d2008-08-22 12:57:08 +00001403 int cbrk; /* Offset to the cell content area */
drh43605152004-05-29 21:46:49 +00001404 int nCell; /* Number of cells on the page */
drh2e38c322004-09-03 18:38:44 +00001405 unsigned char *data; /* The page data */
1406 unsigned char *temp; /* Temp area for cell content */
drh588400b2014-09-27 05:00:25 +00001407 unsigned char *src; /* Source of content */
drh17146622009-07-07 17:38:38 +00001408 int iCellFirst; /* First allowable cell index */
1409 int iCellLast; /* Last possible cell index */
1410
danielk19773b8a05f2007-03-19 17:44:26 +00001411 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +00001412 assert( pPage->pBt!=0 );
drh90f5ecb2004-07-22 01:19:35 +00001413 assert( pPage->pBt->usableSize <= SQLITE_MAX_PAGE_SIZE );
drh43605152004-05-29 21:46:49 +00001414 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +00001415 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh588400b2014-09-27 05:00:25 +00001416 temp = 0;
1417 src = data = pPage->aData;
drh9e572e62004-04-23 23:43:10 +00001418 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +00001419 cellOffset = pPage->cellOffset;
1420 nCell = pPage->nCell;
1421 assert( nCell==get2byte(&data[hdr+3]) );
dane6d065a2017-02-24 19:58:22 +00001422 iCellFirst = cellOffset + 2*nCell;
dan30741eb2017-03-03 20:02:53 +00001423 usableSize = pPage->pBt->usableSize;
dane6d065a2017-02-24 19:58:22 +00001424
1425 /* This block handles pages with two or fewer free blocks and nMaxFrag
1426 ** or fewer fragmented bytes. In this case it is faster to move the
1427 ** two (or one) blocks of cells using memmove() and add the required
1428 ** offsets to each pointer in the cell-pointer array than it is to
1429 ** reconstruct the entire page. */
1430 if( (int)data[hdr+7]<=nMaxFrag ){
1431 int iFree = get2byte(&data[hdr+1]);
drh5881dfe2018-12-13 03:36:13 +00001432
1433 /* If the initial freeblock offset were out of bounds, that would
1434 ** have been detected by btreeInitPage() when it was computing the
1435 ** number of free bytes on the page. */
1436 assert( iFree<=usableSize-4 );
dane6d065a2017-02-24 19:58:22 +00001437 if( iFree ){
1438 int iFree2 = get2byte(&data[iFree]);
drh5881dfe2018-12-13 03:36:13 +00001439 if( iFree2>usableSize-4 ) return SQLITE_CORRUPT_PAGE(pPage);
dane6d065a2017-02-24 19:58:22 +00001440 if( 0==iFree2 || (data[iFree2]==0 && data[iFree2+1]==0) ){
1441 u8 *pEnd = &data[cellOffset + nCell*2];
1442 u8 *pAddr;
1443 int sz2 = 0;
1444 int sz = get2byte(&data[iFree+2]);
1445 int top = get2byte(&data[hdr+5]);
drh4e6cec12017-09-28 13:47:35 +00001446 if( top>=iFree ){
daneebf2f52017-11-18 17:30:08 +00001447 return SQLITE_CORRUPT_PAGE(pPage);
drh4e6cec12017-09-28 13:47:35 +00001448 }
dane6d065a2017-02-24 19:58:22 +00001449 if( iFree2 ){
drh5881dfe2018-12-13 03:36:13 +00001450 if( iFree+sz>iFree2 ) return SQLITE_CORRUPT_PAGE(pPage);
dane6d065a2017-02-24 19:58:22 +00001451 sz2 = get2byte(&data[iFree2+2]);
drh5881dfe2018-12-13 03:36:13 +00001452 if( iFree2+sz2 > usableSize ) return SQLITE_CORRUPT_PAGE(pPage);
dane6d065a2017-02-24 19:58:22 +00001453 memmove(&data[iFree+sz+sz2], &data[iFree+sz], iFree2-(iFree+sz));
1454 sz += sz2;
1455 }
1456 cbrk = top+sz;
dan30741eb2017-03-03 20:02:53 +00001457 assert( cbrk+(iFree-top) <= usableSize );
dane6d065a2017-02-24 19:58:22 +00001458 memmove(&data[cbrk], &data[top], iFree-top);
1459 for(pAddr=&data[cellOffset]; pAddr<pEnd; pAddr+=2){
1460 pc = get2byte(pAddr);
1461 if( pc<iFree ){ put2byte(pAddr, pc+sz); }
1462 else if( pc<iFree2 ){ put2byte(pAddr, pc+sz2); }
1463 }
1464 goto defragment_out;
1465 }
1466 }
1467 }
1468
drh281b21d2008-08-22 12:57:08 +00001469 cbrk = usableSize;
drh17146622009-07-07 17:38:38 +00001470 iCellLast = usableSize - 4;
drh43605152004-05-29 21:46:49 +00001471 for(i=0; i<nCell; i++){
1472 u8 *pAddr; /* The i-th cell pointer */
1473 pAddr = &data[cellOffset + i*2];
1474 pc = get2byte(pAddr);
drh0a45c272009-07-08 01:49:11 +00001475 testcase( pc==iCellFirst );
1476 testcase( pc==iCellLast );
danielk197730548662009-07-09 05:07:37 +00001477 /* These conditions have already been verified in btreeInitPage()
drh1421d982015-05-27 03:46:18 +00001478 ** if PRAGMA cell_size_check=ON.
drh17146622009-07-07 17:38:38 +00001479 */
1480 if( pc<iCellFirst || pc>iCellLast ){
daneebf2f52017-11-18 17:30:08 +00001481 return SQLITE_CORRUPT_PAGE(pPage);
shane0af3f892008-11-12 04:55:34 +00001482 }
drh17146622009-07-07 17:38:38 +00001483 assert( pc>=iCellFirst && pc<=iCellLast );
drh25ada072015-06-19 15:07:14 +00001484 size = pPage->xCellSize(pPage, &src[pc]);
drh281b21d2008-08-22 12:57:08 +00001485 cbrk -= size;
drh17146622009-07-07 17:38:38 +00001486 if( cbrk<iCellFirst || pc+size>usableSize ){
daneebf2f52017-11-18 17:30:08 +00001487 return SQLITE_CORRUPT_PAGE(pPage);
drh17146622009-07-07 17:38:38 +00001488 }
drh7157e1d2009-07-09 13:25:32 +00001489 assert( cbrk+size<=usableSize && cbrk>=iCellFirst );
drh0a45c272009-07-08 01:49:11 +00001490 testcase( cbrk+size==usableSize );
drh0a45c272009-07-08 01:49:11 +00001491 testcase( pc+size==usableSize );
drh281b21d2008-08-22 12:57:08 +00001492 put2byte(pAddr, cbrk);
drh588400b2014-09-27 05:00:25 +00001493 if( temp==0 ){
1494 int x;
1495 if( cbrk==pc ) continue;
1496 temp = sqlite3PagerTempSpace(pPage->pBt->pPager);
1497 x = get2byte(&data[hdr+5]);
1498 memcpy(&temp[x], &data[x], (cbrk+size) - x);
1499 src = temp;
1500 }
1501 memcpy(&data[cbrk], &src[pc], size);
drh2af926b2001-05-15 00:39:25 +00001502 }
dane6d065a2017-02-24 19:58:22 +00001503 data[hdr+7] = 0;
dane6d065a2017-02-24 19:58:22 +00001504
1505 defragment_out:
dan3b2ede12017-02-25 16:24:02 +00001506 if( data[hdr+7]+cbrk-iCellFirst!=pPage->nFree ){
daneebf2f52017-11-18 17:30:08 +00001507 return SQLITE_CORRUPT_PAGE(pPage);
dan3b2ede12017-02-25 16:24:02 +00001508 }
drh17146622009-07-07 17:38:38 +00001509 assert( cbrk>=iCellFirst );
drh281b21d2008-08-22 12:57:08 +00001510 put2byte(&data[hdr+5], cbrk);
drh43605152004-05-29 21:46:49 +00001511 data[hdr+1] = 0;
1512 data[hdr+2] = 0;
drh17146622009-07-07 17:38:38 +00001513 memset(&data[iCellFirst], 0, cbrk-iCellFirst);
drhc5053fb2008-11-27 02:22:10 +00001514 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
shane0af3f892008-11-12 04:55:34 +00001515 return SQLITE_OK;
drh365d68f2001-05-11 11:02:46 +00001516}
1517
drha059ad02001-04-17 20:09:11 +00001518/*
dan8e9ba0c2014-10-14 17:27:04 +00001519** Search the free-list on page pPg for space to store a cell nByte bytes in
1520** size. If one can be found, return a pointer to the space and remove it
1521** from the free-list.
1522**
1523** If no suitable space can be found on the free-list, return NULL.
1524**
drhba0f9992014-10-30 20:48:44 +00001525** This function may detect corruption within pPg. If corruption is
1526** detected then *pRc is set to SQLITE_CORRUPT and NULL is returned.
dan61e94c92014-10-27 08:02:16 +00001527**
drhb7580e82015-06-25 18:36:13 +00001528** Slots on the free list that are between 1 and 3 bytes larger than nByte
1529** will be ignored if adding the extra space to the fragmentation count
1530** causes the fragmentation count to exceed 60.
dan8e9ba0c2014-10-14 17:27:04 +00001531*/
drhb7580e82015-06-25 18:36:13 +00001532static u8 *pageFindSlot(MemPage *pPg, int nByte, int *pRc){
dan8e9ba0c2014-10-14 17:27:04 +00001533 const int hdr = pPg->hdrOffset;
1534 u8 * const aData = pPg->aData;
drhb7580e82015-06-25 18:36:13 +00001535 int iAddr = hdr + 1;
1536 int pc = get2byte(&aData[iAddr]);
1537 int x;
dan8e9ba0c2014-10-14 17:27:04 +00001538 int usableSize = pPg->pBt->usableSize;
drh87d63c92017-08-23 23:09:03 +00001539 int size; /* Size of the free slot */
dan8e9ba0c2014-10-14 17:27:04 +00001540
drhb7580e82015-06-25 18:36:13 +00001541 assert( pc>0 );
drh87d63c92017-08-23 23:09:03 +00001542 while( pc<=usableSize-4 ){
drh113762a2014-11-19 16:36:25 +00001543 /* EVIDENCE-OF: R-22710-53328 The third and fourth bytes of each
1544 ** freeblock form a big-endian integer which is the size of the freeblock
1545 ** in bytes, including the 4-byte header. */
dan8e9ba0c2014-10-14 17:27:04 +00001546 size = get2byte(&aData[pc+2]);
drhb7580e82015-06-25 18:36:13 +00001547 if( (x = size - nByte)>=0 ){
dan8e9ba0c2014-10-14 17:27:04 +00001548 testcase( x==4 );
1549 testcase( x==3 );
drh5e398e42017-08-23 20:36:06 +00001550 if( size+pc > usableSize ){
daneebf2f52017-11-18 17:30:08 +00001551 *pRc = SQLITE_CORRUPT_PAGE(pPg);
drh24dee9d2015-06-02 19:36:29 +00001552 return 0;
1553 }else if( x<4 ){
drhfdab0262014-11-20 15:30:50 +00001554 /* EVIDENCE-OF: R-11498-58022 In a well-formed b-tree page, the total
1555 ** number of bytes in fragments may not exceed 60. */
drhb7580e82015-06-25 18:36:13 +00001556 if( aData[hdr+7]>57 ) return 0;
1557
dan8e9ba0c2014-10-14 17:27:04 +00001558 /* Remove the slot from the free-list. Update the number of
1559 ** fragmented bytes within the page. */
1560 memcpy(&aData[iAddr], &aData[pc], 2);
1561 aData[hdr+7] += (u8)x;
dan8e9ba0c2014-10-14 17:27:04 +00001562 }else{
1563 /* The slot remains on the free-list. Reduce its size to account
1564 ** for the portion used by the new allocation. */
1565 put2byte(&aData[pc+2], x);
1566 }
1567 return &aData[pc + x];
1568 }
drhb7580e82015-06-25 18:36:13 +00001569 iAddr = pc;
1570 pc = get2byte(&aData[pc]);
drh87d63c92017-08-23 23:09:03 +00001571 if( pc<iAddr+size ) break;
1572 }
1573 if( pc ){
daneebf2f52017-11-18 17:30:08 +00001574 *pRc = SQLITE_CORRUPT_PAGE(pPg);
drh87d63c92017-08-23 23:09:03 +00001575 }
dan8e9ba0c2014-10-14 17:27:04 +00001576
1577 return 0;
1578}
1579
1580/*
danielk19776011a752009-04-01 16:25:32 +00001581** Allocate nByte bytes of space from within the B-Tree page passed
drh0a45c272009-07-08 01:49:11 +00001582** as the first argument. Write into *pIdx the index into pPage->aData[]
1583** of the first byte of allocated space. Return either SQLITE_OK or
1584** an error code (usually SQLITE_CORRUPT).
drhbd03cae2001-06-02 02:40:57 +00001585**
drh0a45c272009-07-08 01:49:11 +00001586** The caller guarantees that there is sufficient space to make the
1587** allocation. This routine might need to defragment in order to bring
1588** all the space together, however. This routine will avoid using
1589** the first two bytes past the cell pointer area since presumably this
1590** allocation is being made in order to insert a new cell, so we will
1591** also end up needing a new cell pointer.
drh7e3b0a02001-04-28 16:52:40 +00001592*/
drh0a45c272009-07-08 01:49:11 +00001593static int allocateSpace(MemPage *pPage, int nByte, int *pIdx){
danielk19776011a752009-04-01 16:25:32 +00001594 const int hdr = pPage->hdrOffset; /* Local cache of pPage->hdrOffset */
1595 u8 * const data = pPage->aData; /* Local cache of pPage->aData */
drh0a45c272009-07-08 01:49:11 +00001596 int top; /* First byte of cell content area */
drhfefa0942014-11-05 21:21:08 +00001597 int rc = SQLITE_OK; /* Integer return code */
drh0a45c272009-07-08 01:49:11 +00001598 int gap; /* First byte of gap between cell pointers and cell content */
drh43605152004-05-29 21:46:49 +00001599
danielk19773b8a05f2007-03-19 17:44:26 +00001600 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +00001601 assert( pPage->pBt );
drh1fee73e2007-08-29 04:00:57 +00001602 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhfa67c3c2008-07-11 02:21:40 +00001603 assert( nByte>=0 ); /* Minimum cell size is 4 */
1604 assert( pPage->nFree>=nByte );
1605 assert( pPage->nOverflow==0 );
mistachkina95d8ca2014-10-27 19:42:02 +00001606 assert( nByte < (int)(pPage->pBt->usableSize-8) );
drh43605152004-05-29 21:46:49 +00001607
drh0a45c272009-07-08 01:49:11 +00001608 assert( pPage->cellOffset == hdr + 12 - 4*pPage->leaf );
1609 gap = pPage->cellOffset + 2*pPage->nCell;
drh75b31dc2014-08-20 00:54:46 +00001610 assert( gap<=65536 );
drhfdab0262014-11-20 15:30:50 +00001611 /* EVIDENCE-OF: R-29356-02391 If the database uses a 65536-byte page size
1612 ** and the reserved space is zero (the usual value for reserved space)
1613 ** then the cell content offset of an empty page wants to be 65536.
1614 ** However, that integer is too large to be stored in a 2-byte unsigned
1615 ** integer, so a value of 0 is used in its place. */
drhded340e2015-06-25 15:04:56 +00001616 top = get2byte(&data[hdr+5]);
mistachkin68cdd0e2015-06-26 03:12:27 +00001617 assert( top<=(int)pPage->pBt->usableSize ); /* Prevent by getAndInitPage() */
drhded340e2015-06-25 15:04:56 +00001618 if( gap>top ){
1619 if( top==0 && pPage->pBt->usableSize==65536 ){
1620 top = 65536;
1621 }else{
daneebf2f52017-11-18 17:30:08 +00001622 return SQLITE_CORRUPT_PAGE(pPage);
drh9e572e62004-04-23 23:43:10 +00001623 }
1624 }
drh43605152004-05-29 21:46:49 +00001625
drh4c04f3c2014-08-20 11:56:14 +00001626 /* If there is enough space between gap and top for one more cell pointer
1627 ** array entry offset, and if the freelist is not empty, then search the
1628 ** freelist looking for a free slot big enough to satisfy the request.
1629 */
drh5e2f8b92001-05-28 00:41:15 +00001630 testcase( gap+2==top );
drh7aa128d2002-06-21 13:09:16 +00001631 testcase( gap+1==top );
drh14acc042001-06-10 19:56:58 +00001632 testcase( gap==top );
drhe674bf12015-06-25 16:01:44 +00001633 if( (data[hdr+2] || data[hdr+1]) && gap+2<=top ){
drhb7580e82015-06-25 18:36:13 +00001634 u8 *pSpace = pageFindSlot(pPage, nByte, &rc);
dan8e9ba0c2014-10-14 17:27:04 +00001635 if( pSpace ){
drhfefa0942014-11-05 21:21:08 +00001636 assert( pSpace>=data && (pSpace - data)<65536 );
1637 *pIdx = (int)(pSpace - data);
dan8e9ba0c2014-10-14 17:27:04 +00001638 return SQLITE_OK;
drhb7580e82015-06-25 18:36:13 +00001639 }else if( rc ){
1640 return rc;
drh9e572e62004-04-23 23:43:10 +00001641 }
1642 }
drh43605152004-05-29 21:46:49 +00001643
drh4c04f3c2014-08-20 11:56:14 +00001644 /* The request could not be fulfilled using a freelist slot. Check
1645 ** to see if defragmentation is necessary.
drh0a45c272009-07-08 01:49:11 +00001646 */
1647 testcase( gap+2+nByte==top );
1648 if( gap+2+nByte>top ){
drh1fd2d7d2014-12-02 16:16:47 +00001649 assert( pPage->nCell>0 || CORRUPT_DB );
dane6d065a2017-02-24 19:58:22 +00001650 rc = defragmentPage(pPage, MIN(4, pPage->nFree - (2+nByte)));
drh0a45c272009-07-08 01:49:11 +00001651 if( rc ) return rc;
drh5d433ce2010-08-14 16:02:52 +00001652 top = get2byteNotZero(&data[hdr+5]);
dan3b2ede12017-02-25 16:24:02 +00001653 assert( gap+2+nByte<=top );
drh0a45c272009-07-08 01:49:11 +00001654 }
1655
1656
drh43605152004-05-29 21:46:49 +00001657 /* Allocate memory from the gap in between the cell pointer array
drhc314dc72009-07-21 11:52:34 +00001658 ** and the cell content area. The btreeInitPage() call has already
1659 ** validated the freelist. Given that the freelist is valid, there
1660 ** is no way that the allocation can extend off the end of the page.
1661 ** The assert() below verifies the previous sentence.
drh43605152004-05-29 21:46:49 +00001662 */
drh0a45c272009-07-08 01:49:11 +00001663 top -= nByte;
drh43605152004-05-29 21:46:49 +00001664 put2byte(&data[hdr+5], top);
drhfcd71b62011-04-05 22:08:24 +00001665 assert( top+nByte <= (int)pPage->pBt->usableSize );
drh0a45c272009-07-08 01:49:11 +00001666 *pIdx = top;
1667 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001668}
1669
1670/*
drh9e572e62004-04-23 23:43:10 +00001671** Return a section of the pPage->aData to the freelist.
drh7fb91642014-08-20 14:37:09 +00001672** The first byte of the new free block is pPage->aData[iStart]
1673** and the size of the block is iSize bytes.
drh306dc212001-05-21 13:45:10 +00001674**
drh5f5c7532014-08-20 17:56:27 +00001675** Adjacent freeblocks are coalesced.
1676**
1677** Note that even though the freeblock list was checked by btreeInitPage(),
1678** that routine will not detect overlap between cells or freeblocks. Nor
1679** does it detect cells or freeblocks that encrouch into the reserved bytes
1680** at the end of the page. So do additional corruption checks inside this
1681** routine and return SQLITE_CORRUPT if any problems are found.
drh7e3b0a02001-04-28 16:52:40 +00001682*/
drh5f5c7532014-08-20 17:56:27 +00001683static int freeSpace(MemPage *pPage, u16 iStart, u16 iSize){
drh3f387402014-09-24 01:23:00 +00001684 u16 iPtr; /* Address of ptr to next freeblock */
drh5f5c7532014-08-20 17:56:27 +00001685 u16 iFreeBlk; /* Address of the next freeblock */
1686 u8 hdr; /* Page header size. 0 or 100 */
1687 u8 nFrag = 0; /* Reduction in fragmentation */
1688 u16 iOrigSize = iSize; /* Original value of iSize */
drh5e398e42017-08-23 20:36:06 +00001689 u16 x; /* Offset to cell content area */
drh5f5c7532014-08-20 17:56:27 +00001690 u32 iEnd = iStart + iSize; /* First byte past the iStart buffer */
drh7fb91642014-08-20 14:37:09 +00001691 unsigned char *data = pPage->aData; /* Page content */
drh2af926b2001-05-15 00:39:25 +00001692
drh9e572e62004-04-23 23:43:10 +00001693 assert( pPage->pBt!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00001694 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
dancf3d17c2015-05-25 15:03:49 +00001695 assert( CORRUPT_DB || iStart>=pPage->hdrOffset+6+pPage->childPtrSize );
dan23eba452014-10-24 18:43:57 +00001696 assert( CORRUPT_DB || iEnd <= pPage->pBt->usableSize );
drh1fee73e2007-08-29 04:00:57 +00001697 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh7fb91642014-08-20 14:37:09 +00001698 assert( iSize>=4 ); /* Minimum cell size is 4 */
drh5e398e42017-08-23 20:36:06 +00001699 assert( iStart<=pPage->pBt->usableSize-4 );
drhfcce93f2006-02-22 03:08:32 +00001700
drh5f5c7532014-08-20 17:56:27 +00001701 /* The list of freeblocks must be in ascending order. Find the
1702 ** spot on the list where iStart should be inserted.
drh0a45c272009-07-08 01:49:11 +00001703 */
drh43605152004-05-29 21:46:49 +00001704 hdr = pPage->hdrOffset;
drh7fb91642014-08-20 14:37:09 +00001705 iPtr = hdr + 1;
drh7bc4c452014-08-20 18:43:44 +00001706 if( data[iPtr+1]==0 && data[iPtr]==0 ){
1707 iFreeBlk = 0; /* Shortcut for the case when the freelist is empty */
1708 }else{
drh85f071b2016-09-17 19:34:32 +00001709 while( (iFreeBlk = get2byte(&data[iPtr]))<iStart ){
1710 if( iFreeBlk<iPtr+4 ){
1711 if( iFreeBlk==0 ) break;
daneebf2f52017-11-18 17:30:08 +00001712 return SQLITE_CORRUPT_PAGE(pPage);
drh85f071b2016-09-17 19:34:32 +00001713 }
drh7bc4c452014-08-20 18:43:44 +00001714 iPtr = iFreeBlk;
shanedcc50b72008-11-13 18:29:50 +00001715 }
drh5e398e42017-08-23 20:36:06 +00001716 if( iFreeBlk>pPage->pBt->usableSize-4 ){
daneebf2f52017-11-18 17:30:08 +00001717 return SQLITE_CORRUPT_PAGE(pPage);
drh5e398e42017-08-23 20:36:06 +00001718 }
drh7bc4c452014-08-20 18:43:44 +00001719 assert( iFreeBlk>iPtr || iFreeBlk==0 );
1720
1721 /* At this point:
1722 ** iFreeBlk: First freeblock after iStart, or zero if none
drh3e24a342015-06-15 16:09:35 +00001723 ** iPtr: The address of a pointer to iFreeBlk
drh7bc4c452014-08-20 18:43:44 +00001724 **
1725 ** Check to see if iFreeBlk should be coalesced onto the end of iStart.
1726 */
1727 if( iFreeBlk && iEnd+3>=iFreeBlk ){
1728 nFrag = iFreeBlk - iEnd;
daneebf2f52017-11-18 17:30:08 +00001729 if( iEnd>iFreeBlk ) return SQLITE_CORRUPT_PAGE(pPage);
drh7bc4c452014-08-20 18:43:44 +00001730 iEnd = iFreeBlk + get2byte(&data[iFreeBlk+2]);
drhcc97ca42017-06-07 22:32:59 +00001731 if( iEnd > pPage->pBt->usableSize ){
daneebf2f52017-11-18 17:30:08 +00001732 return SQLITE_CORRUPT_PAGE(pPage);
drhcc97ca42017-06-07 22:32:59 +00001733 }
drh7bc4c452014-08-20 18:43:44 +00001734 iSize = iEnd - iStart;
1735 iFreeBlk = get2byte(&data[iFreeBlk]);
1736 }
1737
drh3f387402014-09-24 01:23:00 +00001738 /* If iPtr is another freeblock (that is, if iPtr is not the freelist
1739 ** pointer in the page header) then check to see if iStart should be
1740 ** coalesced onto the end of iPtr.
drh7bc4c452014-08-20 18:43:44 +00001741 */
1742 if( iPtr>hdr+1 ){
1743 int iPtrEnd = iPtr + get2byte(&data[iPtr+2]);
1744 if( iPtrEnd+3>=iStart ){
daneebf2f52017-11-18 17:30:08 +00001745 if( iPtrEnd>iStart ) return SQLITE_CORRUPT_PAGE(pPage);
drh7bc4c452014-08-20 18:43:44 +00001746 nFrag += iStart - iPtrEnd;
1747 iSize = iEnd - iPtr;
1748 iStart = iPtr;
shanedcc50b72008-11-13 18:29:50 +00001749 }
drh9e572e62004-04-23 23:43:10 +00001750 }
daneebf2f52017-11-18 17:30:08 +00001751 if( nFrag>data[hdr+7] ) return SQLITE_CORRUPT_PAGE(pPage);
drh7bc4c452014-08-20 18:43:44 +00001752 data[hdr+7] -= nFrag;
drh9e572e62004-04-23 23:43:10 +00001753 }
drh5e398e42017-08-23 20:36:06 +00001754 x = get2byte(&data[hdr+5]);
1755 if( iStart<=x ){
drh5f5c7532014-08-20 17:56:27 +00001756 /* The new freeblock is at the beginning of the cell content area,
1757 ** so just extend the cell content area rather than create another
1758 ** freelist entry */
daneebf2f52017-11-18 17:30:08 +00001759 if( iStart<x || iPtr!=hdr+1 ) return SQLITE_CORRUPT_PAGE(pPage);
drh5f5c7532014-08-20 17:56:27 +00001760 put2byte(&data[hdr+1], iFreeBlk);
1761 put2byte(&data[hdr+5], iEnd);
1762 }else{
1763 /* Insert the new freeblock into the freelist */
1764 put2byte(&data[iPtr], iStart);
drh4b70f112004-05-02 21:12:19 +00001765 }
drh5e398e42017-08-23 20:36:06 +00001766 if( pPage->pBt->btsFlags & BTS_FAST_SECURE ){
1767 /* Overwrite deleted information with zeros when the secure_delete
1768 ** option is enabled */
1769 memset(&data[iStart], 0, iSize);
1770 }
1771 put2byte(&data[iStart], iFreeBlk);
1772 put2byte(&data[iStart+2], iSize);
drh5f5c7532014-08-20 17:56:27 +00001773 pPage->nFree += iOrigSize;
shanedcc50b72008-11-13 18:29:50 +00001774 return SQLITE_OK;
drh4b70f112004-05-02 21:12:19 +00001775}
1776
1777/*
drh271efa52004-05-30 19:19:05 +00001778** Decode the flags byte (the first byte of the header) for a page
1779** and initialize fields of the MemPage structure accordingly.
drh44845222008-07-17 18:39:57 +00001780**
1781** Only the following combinations are supported. Anything different
1782** indicates a corrupt database files:
1783**
1784** PTF_ZERODATA
1785** PTF_ZERODATA | PTF_LEAF
1786** PTF_LEAFDATA | PTF_INTKEY
1787** PTF_LEAFDATA | PTF_INTKEY | PTF_LEAF
drh271efa52004-05-30 19:19:05 +00001788*/
drh44845222008-07-17 18:39:57 +00001789static int decodeFlags(MemPage *pPage, int flagByte){
danielk1977aef0bf62005-12-30 16:28:01 +00001790 BtShared *pBt; /* A copy of pPage->pBt */
drh271efa52004-05-30 19:19:05 +00001791
1792 assert( pPage->hdrOffset==(pPage->pgno==1 ? 100 : 0) );
drh1fee73e2007-08-29 04:00:57 +00001793 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhf49661a2008-12-10 16:45:50 +00001794 pPage->leaf = (u8)(flagByte>>3); assert( PTF_LEAF == 1<<3 );
drh44845222008-07-17 18:39:57 +00001795 flagByte &= ~PTF_LEAF;
1796 pPage->childPtrSize = 4-4*pPage->leaf;
drh25ada072015-06-19 15:07:14 +00001797 pPage->xCellSize = cellSizePtr;
drh271efa52004-05-30 19:19:05 +00001798 pBt = pPage->pBt;
drh44845222008-07-17 18:39:57 +00001799 if( flagByte==(PTF_LEAFDATA | PTF_INTKEY) ){
drh3791c9c2016-05-09 23:11:47 +00001800 /* EVIDENCE-OF: R-07291-35328 A value of 5 (0x05) means the page is an
1801 ** interior table b-tree page. */
drhfdab0262014-11-20 15:30:50 +00001802 assert( (PTF_LEAFDATA|PTF_INTKEY)==5 );
drh3791c9c2016-05-09 23:11:47 +00001803 /* EVIDENCE-OF: R-26900-09176 A value of 13 (0x0d) means the page is a
1804 ** leaf table b-tree page. */
drhfdab0262014-11-20 15:30:50 +00001805 assert( (PTF_LEAFDATA|PTF_INTKEY|PTF_LEAF)==13 );
drh44845222008-07-17 18:39:57 +00001806 pPage->intKey = 1;
drh25ada072015-06-19 15:07:14 +00001807 if( pPage->leaf ){
1808 pPage->intKeyLeaf = 1;
drh5fa60512015-06-19 17:19:34 +00001809 pPage->xParseCell = btreeParseCellPtr;
drh25ada072015-06-19 15:07:14 +00001810 }else{
1811 pPage->intKeyLeaf = 0;
drh25ada072015-06-19 15:07:14 +00001812 pPage->xCellSize = cellSizePtrNoPayload;
drh5fa60512015-06-19 17:19:34 +00001813 pPage->xParseCell = btreeParseCellPtrNoPayload;
drh25ada072015-06-19 15:07:14 +00001814 }
drh271efa52004-05-30 19:19:05 +00001815 pPage->maxLocal = pBt->maxLeaf;
1816 pPage->minLocal = pBt->minLeaf;
drh44845222008-07-17 18:39:57 +00001817 }else if( flagByte==PTF_ZERODATA ){
drh3791c9c2016-05-09 23:11:47 +00001818 /* EVIDENCE-OF: R-43316-37308 A value of 2 (0x02) means the page is an
1819 ** interior index b-tree page. */
drhfdab0262014-11-20 15:30:50 +00001820 assert( (PTF_ZERODATA)==2 );
drh3791c9c2016-05-09 23:11:47 +00001821 /* EVIDENCE-OF: R-59615-42828 A value of 10 (0x0a) means the page is a
1822 ** leaf index b-tree page. */
drhfdab0262014-11-20 15:30:50 +00001823 assert( (PTF_ZERODATA|PTF_LEAF)==10 );
drh44845222008-07-17 18:39:57 +00001824 pPage->intKey = 0;
drh3e28ff52014-09-24 00:59:08 +00001825 pPage->intKeyLeaf = 0;
drh5fa60512015-06-19 17:19:34 +00001826 pPage->xParseCell = btreeParseCellPtrIndex;
drh271efa52004-05-30 19:19:05 +00001827 pPage->maxLocal = pBt->maxLocal;
1828 pPage->minLocal = pBt->minLocal;
drh44845222008-07-17 18:39:57 +00001829 }else{
drhfdab0262014-11-20 15:30:50 +00001830 /* EVIDENCE-OF: R-47608-56469 Any other value for the b-tree page type is
1831 ** an error. */
daneebf2f52017-11-18 17:30:08 +00001832 return SQLITE_CORRUPT_PAGE(pPage);
drh271efa52004-05-30 19:19:05 +00001833 }
drhc9166342012-01-05 23:32:06 +00001834 pPage->max1bytePayload = pBt->max1bytePayload;
drh44845222008-07-17 18:39:57 +00001835 return SQLITE_OK;
drh271efa52004-05-30 19:19:05 +00001836}
1837
1838/*
drh7e3b0a02001-04-28 16:52:40 +00001839** Initialize the auxiliary information for a disk block.
drh72f82862001-05-24 21:06:34 +00001840**
1841** Return SQLITE_OK on success. If we see that the page does
drhda47d772002-12-02 04:25:19 +00001842** not contain a well-formed database page, then return
drh72f82862001-05-24 21:06:34 +00001843** SQLITE_CORRUPT. Note that a return of SQLITE_OK does not
1844** guarantee that the page is well-formed. It only shows that
1845** we failed to detect any corruption.
drh7e3b0a02001-04-28 16:52:40 +00001846*/
danielk197730548662009-07-09 05:07:37 +00001847static int btreeInitPage(MemPage *pPage){
drh14e845a2017-05-25 21:35:56 +00001848 int pc; /* Address of a freeblock within pPage->aData[] */
1849 u8 hdr; /* Offset to beginning of page header */
1850 u8 *data; /* Equal to pPage->aData */
1851 BtShared *pBt; /* The main btree structure */
1852 int usableSize; /* Amount of usable space on each page */
1853 u16 cellOffset; /* Offset from start of page to first cell pointer */
1854 int nFree; /* Number of unused bytes on the page */
1855 int top; /* First byte of the cell content area */
1856 int iCellFirst; /* First allowable cell or freeblock offset */
1857 int iCellLast; /* Last possible cell or freeblock offset */
drh2af926b2001-05-15 00:39:25 +00001858
danielk197771d5d2c2008-09-29 11:49:47 +00001859 assert( pPage->pBt!=0 );
drh1421d982015-05-27 03:46:18 +00001860 assert( pPage->pBt->db!=0 );
danielk197771d5d2c2008-09-29 11:49:47 +00001861 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00001862 assert( pPage->pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
drhbf4bca52007-09-06 22:19:14 +00001863 assert( pPage == sqlite3PagerGetExtra(pPage->pDbPage) );
1864 assert( pPage->aData == sqlite3PagerGetData(pPage->pDbPage) );
drh14e845a2017-05-25 21:35:56 +00001865 assert( pPage->isInit==0 );
danielk197771d5d2c2008-09-29 11:49:47 +00001866
drh14e845a2017-05-25 21:35:56 +00001867 pBt = pPage->pBt;
1868 hdr = pPage->hdrOffset;
1869 data = pPage->aData;
1870 /* EVIDENCE-OF: R-28594-02890 The one-byte flag at offset 0 indicating
1871 ** the b-tree page type. */
drhcc97ca42017-06-07 22:32:59 +00001872 if( decodeFlags(pPage, data[hdr]) ){
daneebf2f52017-11-18 17:30:08 +00001873 return SQLITE_CORRUPT_PAGE(pPage);
drhcc97ca42017-06-07 22:32:59 +00001874 }
drh14e845a2017-05-25 21:35:56 +00001875 assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
1876 pPage->maskPage = (u16)(pBt->pageSize - 1);
1877 pPage->nOverflow = 0;
1878 usableSize = pBt->usableSize;
1879 pPage->cellOffset = cellOffset = hdr + 8 + pPage->childPtrSize;
1880 pPage->aDataEnd = &data[usableSize];
1881 pPage->aCellIdx = &data[cellOffset];
1882 pPage->aDataOfst = &data[pPage->childPtrSize];
1883 /* EVIDENCE-OF: R-58015-48175 The two-byte integer at offset 5 designates
1884 ** the start of the cell content area. A zero value for this integer is
1885 ** interpreted as 65536. */
1886 top = get2byteNotZero(&data[hdr+5]);
1887 /* EVIDENCE-OF: R-37002-32774 The two-byte integer at offset 3 gives the
1888 ** number of cells on the page. */
1889 pPage->nCell = get2byte(&data[hdr+3]);
1890 if( pPage->nCell>MX_CELL(pBt) ){
1891 /* To many cells for a single page. The page must be corrupt */
daneebf2f52017-11-18 17:30:08 +00001892 return SQLITE_CORRUPT_PAGE(pPage);
drh14e845a2017-05-25 21:35:56 +00001893 }
1894 testcase( pPage->nCell==MX_CELL(pBt) );
1895 /* EVIDENCE-OF: R-24089-57979 If a page contains no cells (which is only
1896 ** possible for a root page of a table that contains no rows) then the
1897 ** offset to the cell content area will equal the page size minus the
1898 ** bytes of reserved space. */
1899 assert( pPage->nCell>0 || top==usableSize || CORRUPT_DB );
danielk197771d5d2c2008-09-29 11:49:47 +00001900
drh14e845a2017-05-25 21:35:56 +00001901 /* A malformed database page might cause us to read past the end
1902 ** of page when parsing a cell.
1903 **
1904 ** The following block of code checks early to see if a cell extends
1905 ** past the end of a page boundary and causes SQLITE_CORRUPT to be
1906 ** returned if it does.
1907 */
1908 iCellFirst = cellOffset + 2*pPage->nCell;
1909 iCellLast = usableSize - 4;
1910 if( pBt->db->flags & SQLITE_CellSizeCk ){
1911 int i; /* Index into the cell pointer array */
1912 int sz; /* Size of a cell */
danielk197771d5d2c2008-09-29 11:49:47 +00001913
drh14e845a2017-05-25 21:35:56 +00001914 if( !pPage->leaf ) iCellLast--;
1915 for(i=0; i<pPage->nCell; i++){
1916 pc = get2byteAligned(&data[cellOffset+i*2]);
1917 testcase( pc==iCellFirst );
1918 testcase( pc==iCellLast );
1919 if( pc<iCellFirst || pc>iCellLast ){
daneebf2f52017-11-18 17:30:08 +00001920 return SQLITE_CORRUPT_PAGE(pPage);
drh69e931e2009-06-03 21:04:35 +00001921 }
drh14e845a2017-05-25 21:35:56 +00001922 sz = pPage->xCellSize(pPage, &data[pc]);
1923 testcase( pc+sz==usableSize );
1924 if( pc+sz>usableSize ){
daneebf2f52017-11-18 17:30:08 +00001925 return SQLITE_CORRUPT_PAGE(pPage);
drh77dc0ed2016-12-12 01:30:01 +00001926 }
danielk1977eaa06f62008-09-18 17:34:44 +00001927 }
drh14e845a2017-05-25 21:35:56 +00001928 if( !pPage->leaf ) iCellLast++;
1929 }
danielk197793c829c2009-06-03 17:26:17 +00001930
drh14e845a2017-05-25 21:35:56 +00001931 /* Compute the total free space on the page
1932 ** EVIDENCE-OF: R-23588-34450 The two-byte integer at offset 1 gives the
1933 ** start of the first freeblock on the page, or is zero if there are no
1934 ** freeblocks. */
1935 pc = get2byte(&data[hdr+1]);
1936 nFree = data[hdr+7] + top; /* Init nFree to non-freeblock free space */
1937 if( pc>0 ){
1938 u32 next, size;
1939 if( pc<iCellFirst ){
1940 /* EVIDENCE-OF: R-55530-52930 In a well-formed b-tree page, there will
1941 ** always be at least one cell before the first freeblock.
1942 */
daneebf2f52017-11-18 17:30:08 +00001943 return SQLITE_CORRUPT_PAGE(pPage);
drhee696e22004-08-30 16:52:17 +00001944 }
drh14e845a2017-05-25 21:35:56 +00001945 while( 1 ){
1946 if( pc>iCellLast ){
drhcc97ca42017-06-07 22:32:59 +00001947 /* Freeblock off the end of the page */
daneebf2f52017-11-18 17:30:08 +00001948 return SQLITE_CORRUPT_PAGE(pPage);
drh14e845a2017-05-25 21:35:56 +00001949 }
1950 next = get2byte(&data[pc]);
1951 size = get2byte(&data[pc+2]);
1952 nFree = nFree + size;
1953 if( next<=pc+size+3 ) break;
1954 pc = next;
1955 }
1956 if( next>0 ){
drhcc97ca42017-06-07 22:32:59 +00001957 /* Freeblock not in ascending order */
daneebf2f52017-11-18 17:30:08 +00001958 return SQLITE_CORRUPT_PAGE(pPage);
drh14e845a2017-05-25 21:35:56 +00001959 }
1960 if( pc+size>(unsigned int)usableSize ){
drhcc97ca42017-06-07 22:32:59 +00001961 /* Last freeblock extends past page end */
daneebf2f52017-11-18 17:30:08 +00001962 return SQLITE_CORRUPT_PAGE(pPage);
drh14e845a2017-05-25 21:35:56 +00001963 }
danielk197771d5d2c2008-09-29 11:49:47 +00001964 }
drh14e845a2017-05-25 21:35:56 +00001965
1966 /* At this point, nFree contains the sum of the offset to the start
1967 ** of the cell-content area plus the number of free bytes within
1968 ** the cell-content area. If this is greater than the usable-size
1969 ** of the page, then the page must be corrupted. This check also
1970 ** serves to verify that the offset to the start of the cell-content
1971 ** area, according to the page header, lies within the page.
1972 */
1973 if( nFree>usableSize ){
daneebf2f52017-11-18 17:30:08 +00001974 return SQLITE_CORRUPT_PAGE(pPage);
drh14e845a2017-05-25 21:35:56 +00001975 }
1976 pPage->nFree = (u16)(nFree - iCellFirst);
1977 pPage->isInit = 1;
drh9e572e62004-04-23 23:43:10 +00001978 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001979}
1980
1981/*
drh8b2f49b2001-06-08 00:21:52 +00001982** Set up a raw page so that it looks like a database page holding
1983** no entries.
drhbd03cae2001-06-02 02:40:57 +00001984*/
drh9e572e62004-04-23 23:43:10 +00001985static void zeroPage(MemPage *pPage, int flags){
1986 unsigned char *data = pPage->aData;
danielk1977aef0bf62005-12-30 16:28:01 +00001987 BtShared *pBt = pPage->pBt;
drhf49661a2008-12-10 16:45:50 +00001988 u8 hdr = pPage->hdrOffset;
1989 u16 first;
drh9e572e62004-04-23 23:43:10 +00001990
danielk19773b8a05f2007-03-19 17:44:26 +00001991 assert( sqlite3PagerPagenumber(pPage->pDbPage)==pPage->pgno );
drhbf4bca52007-09-06 22:19:14 +00001992 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
1993 assert( sqlite3PagerGetData(pPage->pDbPage) == data );
danielk19773b8a05f2007-03-19 17:44:26 +00001994 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00001995 assert( sqlite3_mutex_held(pBt->mutex) );
drha5907a82017-06-19 11:44:22 +00001996 if( pBt->btsFlags & BTS_FAST_SECURE ){
drh5b47efa2010-02-12 18:18:39 +00001997 memset(&data[hdr], 0, pBt->usableSize - hdr);
1998 }
drh1bd10f82008-12-10 21:19:56 +00001999 data[hdr] = (char)flags;
drhfe485992014-02-12 23:52:16 +00002000 first = hdr + ((flags&PTF_LEAF)==0 ? 12 : 8);
drh43605152004-05-29 21:46:49 +00002001 memset(&data[hdr+1], 0, 4);
2002 data[hdr+7] = 0;
2003 put2byte(&data[hdr+5], pBt->usableSize);
shaneh1df2db72010-08-18 02:28:48 +00002004 pPage->nFree = (u16)(pBt->usableSize - first);
drh271efa52004-05-30 19:19:05 +00002005 decodeFlags(pPage, flags);
drh43605152004-05-29 21:46:49 +00002006 pPage->cellOffset = first;
drh3def2352011-11-11 00:27:15 +00002007 pPage->aDataEnd = &data[pBt->usableSize];
2008 pPage->aCellIdx = &data[first];
drhf44890a2015-06-27 03:58:15 +00002009 pPage->aDataOfst = &data[pPage->childPtrSize];
drh43605152004-05-29 21:46:49 +00002010 pPage->nOverflow = 0;
drhb2eced52010-08-12 02:41:12 +00002011 assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
2012 pPage->maskPage = (u16)(pBt->pageSize - 1);
drh43605152004-05-29 21:46:49 +00002013 pPage->nCell = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00002014 pPage->isInit = 1;
drhbd03cae2001-06-02 02:40:57 +00002015}
2016
drh897a8202008-09-18 01:08:15 +00002017
2018/*
2019** Convert a DbPage obtained from the pager into a MemPage used by
2020** the btree layer.
2021*/
2022static MemPage *btreePageFromDbPage(DbPage *pDbPage, Pgno pgno, BtShared *pBt){
2023 MemPage *pPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
drh8dd1c252015-11-04 22:31:02 +00002024 if( pgno!=pPage->pgno ){
2025 pPage->aData = sqlite3PagerGetData(pDbPage);
2026 pPage->pDbPage = pDbPage;
2027 pPage->pBt = pBt;
2028 pPage->pgno = pgno;
2029 pPage->hdrOffset = pgno==1 ? 100 : 0;
2030 }
2031 assert( pPage->aData==sqlite3PagerGetData(pDbPage) );
drh897a8202008-09-18 01:08:15 +00002032 return pPage;
2033}
2034
drhbd03cae2001-06-02 02:40:57 +00002035/*
drh3aac2dd2004-04-26 14:10:20 +00002036** Get a page from the pager. Initialize the MemPage.pBt and
drh7e8c6f12015-05-28 03:28:27 +00002037** MemPage.aData elements if needed. See also: btreeGetUnusedPage().
drh538f5702007-04-13 02:14:30 +00002038**
drh7e8c6f12015-05-28 03:28:27 +00002039** If the PAGER_GET_NOCONTENT flag is set, it means that we do not care
2040** about the content of the page at this time. So do not go to the disk
drh538f5702007-04-13 02:14:30 +00002041** to fetch the content. Just fill in the content with zeros for now.
2042** If in the future we call sqlite3PagerWrite() on this page, that
2043** means we have started to be concerned about content and the disk
2044** read should occur at that point.
drh3aac2dd2004-04-26 14:10:20 +00002045*/
danielk197730548662009-07-09 05:07:37 +00002046static int btreeGetPage(
drh16a9b832007-05-05 18:39:25 +00002047 BtShared *pBt, /* The btree */
2048 Pgno pgno, /* Number of the page to fetch */
2049 MemPage **ppPage, /* Return the page in this parameter */
drhb00fc3b2013-08-21 23:42:32 +00002050 int flags /* PAGER_GET_NOCONTENT or PAGER_GET_READONLY */
drh16a9b832007-05-05 18:39:25 +00002051){
drh3aac2dd2004-04-26 14:10:20 +00002052 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00002053 DbPage *pDbPage;
2054
drhb00fc3b2013-08-21 23:42:32 +00002055 assert( flags==0 || flags==PAGER_GET_NOCONTENT || flags==PAGER_GET_READONLY );
drh1fee73e2007-08-29 04:00:57 +00002056 assert( sqlite3_mutex_held(pBt->mutex) );
drh9584f582015-11-04 20:22:37 +00002057 rc = sqlite3PagerGet(pBt->pPager, pgno, (DbPage**)&pDbPage, flags);
drh3aac2dd2004-04-26 14:10:20 +00002058 if( rc ) return rc;
drh897a8202008-09-18 01:08:15 +00002059 *ppPage = btreePageFromDbPage(pDbPage, pgno, pBt);
drh3aac2dd2004-04-26 14:10:20 +00002060 return SQLITE_OK;
2061}
2062
2063/*
danielk1977bea2a942009-01-20 17:06:27 +00002064** Retrieve a page from the pager cache. If the requested page is not
2065** already in the pager cache return NULL. Initialize the MemPage.pBt and
2066** MemPage.aData elements if needed.
2067*/
2068static MemPage *btreePageLookup(BtShared *pBt, Pgno pgno){
2069 DbPage *pDbPage;
2070 assert( sqlite3_mutex_held(pBt->mutex) );
2071 pDbPage = sqlite3PagerLookup(pBt->pPager, pgno);
2072 if( pDbPage ){
2073 return btreePageFromDbPage(pDbPage, pgno, pBt);
2074 }
2075 return 0;
2076}
2077
2078/*
danielk197789d40042008-11-17 14:20:56 +00002079** Return the size of the database file in pages. If there is any kind of
2080** error, return ((unsigned int)-1).
danielk197767fd7a92008-09-10 17:53:35 +00002081*/
drhb1299152010-03-30 22:58:33 +00002082static Pgno btreePagecount(BtShared *pBt){
2083 return pBt->nPage;
2084}
2085u32 sqlite3BtreeLastPage(Btree *p){
2086 assert( sqlite3BtreeHoldsMutex(p) );
drh8a181002017-10-12 01:19:06 +00002087 assert( ((p->pBt->nPage)&0x80000000)==0 );
drheac5bd72014-07-25 21:35:39 +00002088 return btreePagecount(p->pBt);
danielk197767fd7a92008-09-10 17:53:35 +00002089}
2090
2091/*
drh28f58dd2015-06-27 19:45:03 +00002092** Get a page from the pager and initialize it.
danielk197789bc4bc2009-07-21 19:25:24 +00002093**
drh15a00212015-06-27 20:55:00 +00002094** If pCur!=0 then the page is being fetched as part of a moveToChild()
2095** call. Do additional sanity checking on the page in this case.
2096** And if the fetch fails, this routine must decrement pCur->iPage.
drh28f58dd2015-06-27 19:45:03 +00002097**
2098** The page is fetched as read-write unless pCur is not NULL and is
2099** a read-only cursor.
2100**
2101** If an error occurs, then *ppPage is undefined. It
danielk197789bc4bc2009-07-21 19:25:24 +00002102** may remain unchanged, or it may be set to an invalid value.
drhde647132004-05-07 17:57:49 +00002103*/
2104static int getAndInitPage(
dan11dcd112013-03-15 18:29:18 +00002105 BtShared *pBt, /* The database file */
2106 Pgno pgno, /* Number of the page to get */
2107 MemPage **ppPage, /* Write the page pointer here */
drh28f58dd2015-06-27 19:45:03 +00002108 BtCursor *pCur, /* Cursor to receive the page, or NULL */
2109 int bReadOnly /* True for a read-only page */
drhde647132004-05-07 17:57:49 +00002110){
2111 int rc;
drh28f58dd2015-06-27 19:45:03 +00002112 DbPage *pDbPage;
drh1fee73e2007-08-29 04:00:57 +00002113 assert( sqlite3_mutex_held(pBt->mutex) );
drh352a35a2017-08-15 03:46:47 +00002114 assert( pCur==0 || ppPage==&pCur->pPage );
drh28f58dd2015-06-27 19:45:03 +00002115 assert( pCur==0 || bReadOnly==pCur->curPagerFlags );
drh15a00212015-06-27 20:55:00 +00002116 assert( pCur==0 || pCur->iPage>0 );
danielk197789bc4bc2009-07-21 19:25:24 +00002117
danba3cbf32010-06-30 04:29:03 +00002118 if( pgno>btreePagecount(pBt) ){
2119 rc = SQLITE_CORRUPT_BKPT;
drh28f58dd2015-06-27 19:45:03 +00002120 goto getAndInitPage_error;
2121 }
drh9584f582015-11-04 20:22:37 +00002122 rc = sqlite3PagerGet(pBt->pPager, pgno, (DbPage**)&pDbPage, bReadOnly);
drh28f58dd2015-06-27 19:45:03 +00002123 if( rc ){
2124 goto getAndInitPage_error;
2125 }
drh8dd1c252015-11-04 22:31:02 +00002126 *ppPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
drh28f58dd2015-06-27 19:45:03 +00002127 if( (*ppPage)->isInit==0 ){
drh8dd1c252015-11-04 22:31:02 +00002128 btreePageFromDbPage(pDbPage, pgno, pBt);
drh28f58dd2015-06-27 19:45:03 +00002129 rc = btreeInitPage(*ppPage);
2130 if( rc!=SQLITE_OK ){
2131 releasePage(*ppPage);
2132 goto getAndInitPage_error;
danielk197789bc4bc2009-07-21 19:25:24 +00002133 }
drhee696e22004-08-30 16:52:17 +00002134 }
drh8dd1c252015-11-04 22:31:02 +00002135 assert( (*ppPage)->pgno==pgno );
2136 assert( (*ppPage)->aData==sqlite3PagerGetData(pDbPage) );
danba3cbf32010-06-30 04:29:03 +00002137
drh15a00212015-06-27 20:55:00 +00002138 /* If obtaining a child page for a cursor, we must verify that the page is
2139 ** compatible with the root page. */
drh8dd1c252015-11-04 22:31:02 +00002140 if( pCur && ((*ppPage)->nCell<1 || (*ppPage)->intKey!=pCur->curIntKey) ){
drhcc97ca42017-06-07 22:32:59 +00002141 rc = SQLITE_CORRUPT_PGNO(pgno);
drh28f58dd2015-06-27 19:45:03 +00002142 releasePage(*ppPage);
2143 goto getAndInitPage_error;
2144 }
drh28f58dd2015-06-27 19:45:03 +00002145 return SQLITE_OK;
2146
2147getAndInitPage_error:
drh352a35a2017-08-15 03:46:47 +00002148 if( pCur ){
2149 pCur->iPage--;
2150 pCur->pPage = pCur->apPage[pCur->iPage];
2151 }
danba3cbf32010-06-30 04:29:03 +00002152 testcase( pgno==0 );
2153 assert( pgno!=0 || rc==SQLITE_CORRUPT );
drhde647132004-05-07 17:57:49 +00002154 return rc;
2155}
2156
2157/*
drh3aac2dd2004-04-26 14:10:20 +00002158** Release a MemPage. This should be called once for each prior
danielk197730548662009-07-09 05:07:37 +00002159** call to btreeGetPage.
drh3908fe92017-09-01 14:50:19 +00002160**
2161** Page1 is a special case and must be released using releasePageOne().
drh3aac2dd2004-04-26 14:10:20 +00002162*/
drhbbf0f862015-06-27 14:59:26 +00002163static void releasePageNotNull(MemPage *pPage){
2164 assert( pPage->aData );
2165 assert( pPage->pBt );
2166 assert( pPage->pDbPage!=0 );
2167 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
2168 assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
2169 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
2170 sqlite3PagerUnrefNotNull(pPage->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00002171}
drh3aac2dd2004-04-26 14:10:20 +00002172static void releasePage(MemPage *pPage){
drhbbf0f862015-06-27 14:59:26 +00002173 if( pPage ) releasePageNotNull(pPage);
drh3aac2dd2004-04-26 14:10:20 +00002174}
drh3908fe92017-09-01 14:50:19 +00002175static void releasePageOne(MemPage *pPage){
2176 assert( pPage!=0 );
2177 assert( pPage->aData );
2178 assert( pPage->pBt );
2179 assert( pPage->pDbPage!=0 );
2180 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
2181 assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
2182 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
2183 sqlite3PagerUnrefPageOne(pPage->pDbPage);
2184}
drh3aac2dd2004-04-26 14:10:20 +00002185
2186/*
drh7e8c6f12015-05-28 03:28:27 +00002187** Get an unused page.
2188**
2189** This works just like btreeGetPage() with the addition:
2190**
2191** * If the page is already in use for some other purpose, immediately
2192** release it and return an SQLITE_CURRUPT error.
2193** * Make sure the isInit flag is clear
2194*/
2195static int btreeGetUnusedPage(
2196 BtShared *pBt, /* The btree */
2197 Pgno pgno, /* Number of the page to fetch */
2198 MemPage **ppPage, /* Return the page in this parameter */
2199 int flags /* PAGER_GET_NOCONTENT or PAGER_GET_READONLY */
2200){
2201 int rc = btreeGetPage(pBt, pgno, ppPage, flags);
2202 if( rc==SQLITE_OK ){
2203 if( sqlite3PagerPageRefcount((*ppPage)->pDbPage)>1 ){
2204 releasePage(*ppPage);
2205 *ppPage = 0;
2206 return SQLITE_CORRUPT_BKPT;
2207 }
2208 (*ppPage)->isInit = 0;
2209 }else{
2210 *ppPage = 0;
2211 }
2212 return rc;
2213}
2214
drha059ad02001-04-17 20:09:11 +00002215
2216/*
drha6abd042004-06-09 17:37:22 +00002217** During a rollback, when the pager reloads information into the cache
2218** so that the cache is restored to its original state at the start of
2219** the transaction, for each page restored this routine is called.
2220**
2221** This routine needs to reset the extra data section at the end of the
2222** page to agree with the restored data.
2223*/
danielk1977eaa06f62008-09-18 17:34:44 +00002224static void pageReinit(DbPage *pData){
drh07d183d2005-05-01 22:52:42 +00002225 MemPage *pPage;
danielk19773b8a05f2007-03-19 17:44:26 +00002226 pPage = (MemPage *)sqlite3PagerGetExtra(pData);
danielk1977d217e6f2009-04-01 17:13:51 +00002227 assert( sqlite3PagerPageRefcount(pData)>0 );
danielk197771d5d2c2008-09-29 11:49:47 +00002228 if( pPage->isInit ){
drh1fee73e2007-08-29 04:00:57 +00002229 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drha6abd042004-06-09 17:37:22 +00002230 pPage->isInit = 0;
danielk1977d217e6f2009-04-01 17:13:51 +00002231 if( sqlite3PagerPageRefcount(pData)>1 ){
drh5e8d8872009-03-30 17:19:48 +00002232 /* pPage might not be a btree page; it might be an overflow page
2233 ** or ptrmap page or a free page. In those cases, the following
danielk197730548662009-07-09 05:07:37 +00002234 ** call to btreeInitPage() will likely return SQLITE_CORRUPT.
drh5e8d8872009-03-30 17:19:48 +00002235 ** But no harm is done by this. And it is very important that
danielk197730548662009-07-09 05:07:37 +00002236 ** btreeInitPage() be called on every btree page so we make
drh5e8d8872009-03-30 17:19:48 +00002237 ** the call for every page that comes in for re-initing. */
danielk197730548662009-07-09 05:07:37 +00002238 btreeInitPage(pPage);
danielk197771d5d2c2008-09-29 11:49:47 +00002239 }
drha6abd042004-06-09 17:37:22 +00002240 }
2241}
2242
2243/*
drhe5fe6902007-12-07 18:55:28 +00002244** Invoke the busy handler for a btree.
2245*/
danielk19771ceedd32008-11-19 10:22:33 +00002246static int btreeInvokeBusyHandler(void *pArg){
drhe5fe6902007-12-07 18:55:28 +00002247 BtShared *pBt = (BtShared*)pArg;
2248 assert( pBt->db );
2249 assert( sqlite3_mutex_held(pBt->db->mutex) );
drhf0119b22018-03-26 17:40:53 +00002250 return sqlite3InvokeBusyHandler(&pBt->db->busyHandler,
2251 sqlite3PagerFile(pBt->pPager));
drhe5fe6902007-12-07 18:55:28 +00002252}
2253
2254/*
drhad3e0102004-09-03 23:32:18 +00002255** Open a database file.
2256**
drh382c0242001-10-06 16:33:02 +00002257** zFilename is the name of the database file. If zFilename is NULL
drh75c014c2010-08-30 15:02:28 +00002258** then an ephemeral database is created. The ephemeral database might
2259** be exclusively in memory, or it might use a disk-based memory cache.
2260** Either way, the ephemeral database will be automatically deleted
2261** when sqlite3BtreeClose() is called.
2262**
drhe53831d2007-08-17 01:14:38 +00002263** If zFilename is ":memory:" then an in-memory database is created
2264** that is automatically destroyed when it is closed.
drhc47fd8e2009-04-30 13:30:32 +00002265**
drh33f111d2012-01-17 15:29:14 +00002266** The "flags" parameter is a bitmask that might contain bits like
2267** BTREE_OMIT_JOURNAL and/or BTREE_MEMORY.
drh75c014c2010-08-30 15:02:28 +00002268**
drhc47fd8e2009-04-30 13:30:32 +00002269** If the database is already opened in the same database connection
2270** and we are in shared cache mode, then the open will fail with an
2271** SQLITE_CONSTRAINT error. We cannot allow two or more BtShared
2272** objects in the same database connection since doing so will lead
2273** to problems with locking.
drha059ad02001-04-17 20:09:11 +00002274*/
drh23e11ca2004-05-04 17:27:28 +00002275int sqlite3BtreeOpen(
dan3a6d8ae2011-04-23 15:54:54 +00002276 sqlite3_vfs *pVfs, /* VFS to use for this b-tree */
drh3aac2dd2004-04-26 14:10:20 +00002277 const char *zFilename, /* Name of the file containing the BTree database */
drhe5fe6902007-12-07 18:55:28 +00002278 sqlite3 *db, /* Associated database handle */
drh3aac2dd2004-04-26 14:10:20 +00002279 Btree **ppBtree, /* Pointer to new Btree object written here */
drh33f4e022007-09-03 15:19:34 +00002280 int flags, /* Options */
2281 int vfsFlags /* Flags passed through to sqlite3_vfs.xOpen() */
drh6019e162001-07-02 17:51:45 +00002282){
drh7555d8e2009-03-20 13:15:30 +00002283 BtShared *pBt = 0; /* Shared part of btree structure */
2284 Btree *p; /* Handle to return */
2285 sqlite3_mutex *mutexOpen = 0; /* Prevents a race condition. Ticket #3537 */
2286 int rc = SQLITE_OK; /* Result code from this function */
2287 u8 nReserve; /* Byte of unused space on each page */
2288 unsigned char zDbHeader[100]; /* Database header content */
danielk1977aef0bf62005-12-30 16:28:01 +00002289
drh75c014c2010-08-30 15:02:28 +00002290 /* True if opening an ephemeral, temporary database */
2291 const int isTempDb = zFilename==0 || zFilename[0]==0;
2292
danielk1977aef0bf62005-12-30 16:28:01 +00002293 /* Set the variable isMemdb to true for an in-memory database, or
drhb0a7c9c2010-12-06 21:09:59 +00002294 ** false for a file-based database.
danielk1977aef0bf62005-12-30 16:28:01 +00002295 */
drhb0a7c9c2010-12-06 21:09:59 +00002296#ifdef SQLITE_OMIT_MEMORYDB
2297 const int isMemdb = 0;
2298#else
2299 const int isMemdb = (zFilename && strcmp(zFilename, ":memory:")==0)
drh9c67b2a2012-05-28 13:58:00 +00002300 || (isTempDb && sqlite3TempInMemory(db))
2301 || (vfsFlags & SQLITE_OPEN_MEMORY)!=0;
danielk1977aef0bf62005-12-30 16:28:01 +00002302#endif
2303
drhe5fe6902007-12-07 18:55:28 +00002304 assert( db!=0 );
dan3a6d8ae2011-04-23 15:54:54 +00002305 assert( pVfs!=0 );
drhe5fe6902007-12-07 18:55:28 +00002306 assert( sqlite3_mutex_held(db->mutex) );
drhd4187c72010-08-30 22:15:45 +00002307 assert( (flags&0xff)==flags ); /* flags fit in 8 bits */
2308
2309 /* Only a BTREE_SINGLE database can be BTREE_UNORDERED */
2310 assert( (flags & BTREE_UNORDERED)==0 || (flags & BTREE_SINGLE)!=0 );
2311
2312 /* A BTREE_SINGLE database is always a temporary and/or ephemeral */
2313 assert( (flags & BTREE_SINGLE)==0 || isTempDb );
drh153c62c2007-08-24 03:51:33 +00002314
drh75c014c2010-08-30 15:02:28 +00002315 if( isMemdb ){
2316 flags |= BTREE_MEMORY;
2317 }
2318 if( (vfsFlags & SQLITE_OPEN_MAIN_DB)!=0 && (isMemdb || isTempDb) ){
2319 vfsFlags = (vfsFlags & ~SQLITE_OPEN_MAIN_DB) | SQLITE_OPEN_TEMP_DB;
2320 }
drh17435752007-08-16 04:30:38 +00002321 p = sqlite3MallocZero(sizeof(Btree));
danielk1977aef0bf62005-12-30 16:28:01 +00002322 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00002323 return SQLITE_NOMEM_BKPT;
danielk1977aef0bf62005-12-30 16:28:01 +00002324 }
2325 p->inTrans = TRANS_NONE;
drhe5fe6902007-12-07 18:55:28 +00002326 p->db = db;
danielk1977602b4662009-07-02 07:47:33 +00002327#ifndef SQLITE_OMIT_SHARED_CACHE
2328 p->lock.pBtree = p;
2329 p->lock.iTable = 1;
2330#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002331
drh198bf392006-01-06 21:52:49 +00002332#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00002333 /*
2334 ** If this Btree is a candidate for shared cache, try to find an
2335 ** existing BtShared object that we can share with
2336 */
drh4ab9d252012-05-26 20:08:49 +00002337 if( isTempDb==0 && (isMemdb==0 || (vfsFlags&SQLITE_OPEN_URI)!=0) ){
drhf1f12682009-09-09 14:17:52 +00002338 if( vfsFlags & SQLITE_OPEN_SHAREDCACHE ){
drh6b5f0eb2015-03-31 16:33:08 +00002339 int nFilename = sqlite3Strlen30(zFilename)+1;
danielk1977adfb9b02007-09-17 07:02:56 +00002340 int nFullPathname = pVfs->mxPathname+1;
drh6b5f0eb2015-03-31 16:33:08 +00002341 char *zFullPathname = sqlite3Malloc(MAX(nFullPathname,nFilename));
drh30ddce62011-10-15 00:16:30 +00002342 MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
drh6b5f0eb2015-03-31 16:33:08 +00002343
drhff0587c2007-08-29 17:43:19 +00002344 p->sharable = 1;
drhff0587c2007-08-29 17:43:19 +00002345 if( !zFullPathname ){
2346 sqlite3_free(p);
mistachkinfad30392016-02-13 23:43:46 +00002347 return SQLITE_NOMEM_BKPT;
drhff0587c2007-08-29 17:43:19 +00002348 }
drhafc8b7f2012-05-26 18:06:38 +00002349 if( isMemdb ){
drh6b5f0eb2015-03-31 16:33:08 +00002350 memcpy(zFullPathname, zFilename, nFilename);
drhafc8b7f2012-05-26 18:06:38 +00002351 }else{
2352 rc = sqlite3OsFullPathname(pVfs, zFilename,
2353 nFullPathname, zFullPathname);
2354 if( rc ){
2355 sqlite3_free(zFullPathname);
2356 sqlite3_free(p);
2357 return rc;
2358 }
drh070ad6b2011-11-17 11:43:19 +00002359 }
drh30ddce62011-10-15 00:16:30 +00002360#if SQLITE_THREADSAFE
drh7555d8e2009-03-20 13:15:30 +00002361 mutexOpen = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_OPEN);
2362 sqlite3_mutex_enter(mutexOpen);
danielk197759f8c082008-06-18 17:09:10 +00002363 mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhff0587c2007-08-29 17:43:19 +00002364 sqlite3_mutex_enter(mutexShared);
drh30ddce62011-10-15 00:16:30 +00002365#endif
drh78f82d12008-09-02 00:52:52 +00002366 for(pBt=GLOBAL(BtShared*,sqlite3SharedCacheList); pBt; pBt=pBt->pNext){
drhff0587c2007-08-29 17:43:19 +00002367 assert( pBt->nRef>0 );
drhd4e0bb02012-05-27 01:19:04 +00002368 if( 0==strcmp(zFullPathname, sqlite3PagerFilename(pBt->pPager, 0))
drhff0587c2007-08-29 17:43:19 +00002369 && sqlite3PagerVfs(pBt->pPager)==pVfs ){
drhc47fd8e2009-04-30 13:30:32 +00002370 int iDb;
2371 for(iDb=db->nDb-1; iDb>=0; iDb--){
2372 Btree *pExisting = db->aDb[iDb].pBt;
2373 if( pExisting && pExisting->pBt==pBt ){
2374 sqlite3_mutex_leave(mutexShared);
2375 sqlite3_mutex_leave(mutexOpen);
2376 sqlite3_free(zFullPathname);
2377 sqlite3_free(p);
2378 return SQLITE_CONSTRAINT;
2379 }
2380 }
drhff0587c2007-08-29 17:43:19 +00002381 p->pBt = pBt;
2382 pBt->nRef++;
2383 break;
2384 }
2385 }
2386 sqlite3_mutex_leave(mutexShared);
2387 sqlite3_free(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00002388 }
drhff0587c2007-08-29 17:43:19 +00002389#ifdef SQLITE_DEBUG
2390 else{
2391 /* In debug mode, we mark all persistent databases as sharable
2392 ** even when they are not. This exercises the locking code and
2393 ** gives more opportunity for asserts(sqlite3_mutex_held())
2394 ** statements to find locking problems.
2395 */
2396 p->sharable = 1;
2397 }
2398#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002399 }
2400#endif
drha059ad02001-04-17 20:09:11 +00002401 if( pBt==0 ){
drhe53831d2007-08-17 01:14:38 +00002402 /*
2403 ** The following asserts make sure that structures used by the btree are
2404 ** the right size. This is to guard against size changes that result
2405 ** when compiling on a different architecture.
danielk197703aded42004-11-22 05:26:27 +00002406 */
drh062cf272015-03-23 19:03:51 +00002407 assert( sizeof(i64)==8 );
2408 assert( sizeof(u64)==8 );
drhe53831d2007-08-17 01:14:38 +00002409 assert( sizeof(u32)==4 );
2410 assert( sizeof(u16)==2 );
2411 assert( sizeof(Pgno)==4 );
2412
2413 pBt = sqlite3MallocZero( sizeof(*pBt) );
2414 if( pBt==0 ){
mistachkinfad30392016-02-13 23:43:46 +00002415 rc = SQLITE_NOMEM_BKPT;
drhe53831d2007-08-17 01:14:38 +00002416 goto btree_open_out;
2417 }
danielk197771d5d2c2008-09-29 11:49:47 +00002418 rc = sqlite3PagerOpen(pVfs, &pBt->pPager, zFilename,
drha2ee5892016-12-09 16:02:00 +00002419 sizeof(MemPage), flags, vfsFlags, pageReinit);
drhe53831d2007-08-17 01:14:38 +00002420 if( rc==SQLITE_OK ){
drh9b4c59f2013-04-15 17:03:42 +00002421 sqlite3PagerSetMmapLimit(pBt->pPager, db->szMmap);
drhe53831d2007-08-17 01:14:38 +00002422 rc = sqlite3PagerReadFileheader(pBt->pPager,sizeof(zDbHeader),zDbHeader);
2423 }
2424 if( rc!=SQLITE_OK ){
2425 goto btree_open_out;
2426 }
shanehbd2aaf92010-09-01 02:38:21 +00002427 pBt->openFlags = (u8)flags;
danielk19772a50ff02009-04-10 09:47:06 +00002428 pBt->db = db;
drh80262892018-03-26 16:37:53 +00002429 sqlite3PagerSetBusyHandler(pBt->pPager, btreeInvokeBusyHandler, pBt);
drhe53831d2007-08-17 01:14:38 +00002430 p->pBt = pBt;
2431
drhe53831d2007-08-17 01:14:38 +00002432 pBt->pCursor = 0;
2433 pBt->pPage1 = 0;
drhc9166342012-01-05 23:32:06 +00002434 if( sqlite3PagerIsreadonly(pBt->pPager) ) pBt->btsFlags |= BTS_READ_ONLY;
drha5907a82017-06-19 11:44:22 +00002435#if defined(SQLITE_SECURE_DELETE)
drhc9166342012-01-05 23:32:06 +00002436 pBt->btsFlags |= BTS_SECURE_DELETE;
drha5907a82017-06-19 11:44:22 +00002437#elif defined(SQLITE_FAST_SECURE_DELETE)
2438 pBt->btsFlags |= BTS_OVERWRITE;
drh5b47efa2010-02-12 18:18:39 +00002439#endif
drh113762a2014-11-19 16:36:25 +00002440 /* EVIDENCE-OF: R-51873-39618 The page size for a database file is
2441 ** determined by the 2-byte integer located at an offset of 16 bytes from
2442 ** the beginning of the database file. */
drhb2eced52010-08-12 02:41:12 +00002443 pBt->pageSize = (zDbHeader[16]<<8) | (zDbHeader[17]<<16);
drhe53831d2007-08-17 01:14:38 +00002444 if( pBt->pageSize<512 || pBt->pageSize>SQLITE_MAX_PAGE_SIZE
2445 || ((pBt->pageSize-1)&pBt->pageSize)!=0 ){
danielk1977a1644fd2007-08-29 12:31:25 +00002446 pBt->pageSize = 0;
drhe53831d2007-08-17 01:14:38 +00002447#ifndef SQLITE_OMIT_AUTOVACUUM
2448 /* If the magic name ":memory:" will create an in-memory database, then
2449 ** leave the autoVacuum mode at 0 (do not auto-vacuum), even if
2450 ** SQLITE_DEFAULT_AUTOVACUUM is true. On the other hand, if
2451 ** SQLITE_OMIT_MEMORYDB has been defined, then ":memory:" is just a
2452 ** regular file-name. In this case the auto-vacuum applies as per normal.
2453 */
2454 if( zFilename && !isMemdb ){
2455 pBt->autoVacuum = (SQLITE_DEFAULT_AUTOVACUUM ? 1 : 0);
2456 pBt->incrVacuum = (SQLITE_DEFAULT_AUTOVACUUM==2 ? 1 : 0);
2457 }
2458#endif
2459 nReserve = 0;
2460 }else{
drh113762a2014-11-19 16:36:25 +00002461 /* EVIDENCE-OF: R-37497-42412 The size of the reserved region is
2462 ** determined by the one-byte unsigned integer found at an offset of 20
2463 ** into the database file header. */
drhe53831d2007-08-17 01:14:38 +00002464 nReserve = zDbHeader[20];
drhc9166342012-01-05 23:32:06 +00002465 pBt->btsFlags |= BTS_PAGESIZE_FIXED;
drhe53831d2007-08-17 01:14:38 +00002466#ifndef SQLITE_OMIT_AUTOVACUUM
2467 pBt->autoVacuum = (get4byte(&zDbHeader[36 + 4*4])?1:0);
2468 pBt->incrVacuum = (get4byte(&zDbHeader[36 + 7*4])?1:0);
2469#endif
2470 }
drhfa9601a2009-06-18 17:22:39 +00002471 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
drhc0b61812009-04-30 01:22:41 +00002472 if( rc ) goto btree_open_out;
drhe53831d2007-08-17 01:14:38 +00002473 pBt->usableSize = pBt->pageSize - nReserve;
2474 assert( (pBt->pageSize & 7)==0 ); /* 8-byte alignment of pageSize */
drhe53831d2007-08-17 01:14:38 +00002475
2476#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
2477 /* Add the new BtShared object to the linked list sharable BtShareds.
2478 */
dan272989b2016-07-06 10:12:02 +00002479 pBt->nRef = 1;
drhe53831d2007-08-17 01:14:38 +00002480 if( p->sharable ){
drh30ddce62011-10-15 00:16:30 +00002481 MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
drh30ddce62011-10-15 00:16:30 +00002482 MUTEX_LOGIC( mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);)
danielk1977075c23a2008-09-01 18:34:20 +00002483 if( SQLITE_THREADSAFE && sqlite3GlobalConfig.bCoreMutex ){
danielk197759f8c082008-06-18 17:09:10 +00002484 pBt->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_FAST);
drh3285db22007-09-03 22:00:39 +00002485 if( pBt->mutex==0 ){
mistachkinfad30392016-02-13 23:43:46 +00002486 rc = SQLITE_NOMEM_BKPT;
drh3285db22007-09-03 22:00:39 +00002487 goto btree_open_out;
2488 }
drhff0587c2007-08-29 17:43:19 +00002489 }
drhe53831d2007-08-17 01:14:38 +00002490 sqlite3_mutex_enter(mutexShared);
drh78f82d12008-09-02 00:52:52 +00002491 pBt->pNext = GLOBAL(BtShared*,sqlite3SharedCacheList);
2492 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt;
drhe53831d2007-08-17 01:14:38 +00002493 sqlite3_mutex_leave(mutexShared);
danielk1977951af802004-11-05 15:45:09 +00002494 }
drheee46cf2004-11-06 00:02:48 +00002495#endif
drh90f5ecb2004-07-22 01:19:35 +00002496 }
danielk1977aef0bf62005-12-30 16:28:01 +00002497
drhcfed7bc2006-03-13 14:28:05 +00002498#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00002499 /* If the new Btree uses a sharable pBtShared, then link the new
2500 ** Btree into the list of all sharable Btrees for the same connection.
drhabddb0c2007-08-20 13:14:28 +00002501 ** The list is kept in ascending order by pBt address.
danielk197754f01982006-01-18 15:25:17 +00002502 */
drhe53831d2007-08-17 01:14:38 +00002503 if( p->sharable ){
2504 int i;
2505 Btree *pSib;
drhe5fe6902007-12-07 18:55:28 +00002506 for(i=0; i<db->nDb; i++){
2507 if( (pSib = db->aDb[i].pBt)!=0 && pSib->sharable ){
drhe53831d2007-08-17 01:14:38 +00002508 while( pSib->pPrev ){ pSib = pSib->pPrev; }
drh3bfa7e82016-03-22 14:37:59 +00002509 if( (uptr)p->pBt<(uptr)pSib->pBt ){
drhe53831d2007-08-17 01:14:38 +00002510 p->pNext = pSib;
2511 p->pPrev = 0;
2512 pSib->pPrev = p;
2513 }else{
drh3bfa7e82016-03-22 14:37:59 +00002514 while( pSib->pNext && (uptr)pSib->pNext->pBt<(uptr)p->pBt ){
drhe53831d2007-08-17 01:14:38 +00002515 pSib = pSib->pNext;
2516 }
2517 p->pNext = pSib->pNext;
2518 p->pPrev = pSib;
2519 if( p->pNext ){
2520 p->pNext->pPrev = p;
2521 }
2522 pSib->pNext = p;
2523 }
2524 break;
2525 }
2526 }
danielk1977aef0bf62005-12-30 16:28:01 +00002527 }
danielk1977aef0bf62005-12-30 16:28:01 +00002528#endif
2529 *ppBtree = p;
danielk1977dddbcdc2007-04-26 14:42:34 +00002530
2531btree_open_out:
2532 if( rc!=SQLITE_OK ){
2533 if( pBt && pBt->pPager ){
dan7fb89902016-08-12 16:21:15 +00002534 sqlite3PagerClose(pBt->pPager, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00002535 }
drh17435752007-08-16 04:30:38 +00002536 sqlite3_free(pBt);
2537 sqlite3_free(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00002538 *ppBtree = 0;
drh75c014c2010-08-30 15:02:28 +00002539 }else{
dan0f5a1862016-08-13 14:30:23 +00002540 sqlite3_file *pFile;
2541
drh75c014c2010-08-30 15:02:28 +00002542 /* If the B-Tree was successfully opened, set the pager-cache size to the
2543 ** default value. Except, when opening on an existing shared pager-cache,
2544 ** do not change the pager-cache size.
2545 */
2546 if( sqlite3BtreeSchema(p, 0, 0)==0 ){
2547 sqlite3PagerSetCachesize(p->pBt->pPager, SQLITE_DEFAULT_CACHE_SIZE);
2548 }
dan0f5a1862016-08-13 14:30:23 +00002549
2550 pFile = sqlite3PagerFile(pBt->pPager);
2551 if( pFile->pMethods ){
2552 sqlite3OsFileControlHint(pFile, SQLITE_FCNTL_PDB, (void*)&pBt->db);
2553 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002554 }
drh7555d8e2009-03-20 13:15:30 +00002555 if( mutexOpen ){
2556 assert( sqlite3_mutex_held(mutexOpen) );
2557 sqlite3_mutex_leave(mutexOpen);
2558 }
dan272989b2016-07-06 10:12:02 +00002559 assert( rc!=SQLITE_OK || sqlite3BtreeConnectionCount(*ppBtree)>0 );
danielk1977dddbcdc2007-04-26 14:42:34 +00002560 return rc;
drha059ad02001-04-17 20:09:11 +00002561}
2562
2563/*
drhe53831d2007-08-17 01:14:38 +00002564** Decrement the BtShared.nRef counter. When it reaches zero,
2565** remove the BtShared structure from the sharing list. Return
2566** true if the BtShared.nRef counter reaches zero and return
2567** false if it is still positive.
2568*/
2569static int removeFromSharingList(BtShared *pBt){
2570#ifndef SQLITE_OMIT_SHARED_CACHE
drh30ddce62011-10-15 00:16:30 +00002571 MUTEX_LOGIC( sqlite3_mutex *pMaster; )
drhe53831d2007-08-17 01:14:38 +00002572 BtShared *pList;
2573 int removed = 0;
2574
drhd677b3d2007-08-20 22:48:41 +00002575 assert( sqlite3_mutex_notheld(pBt->mutex) );
drh30ddce62011-10-15 00:16:30 +00002576 MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
drhe53831d2007-08-17 01:14:38 +00002577 sqlite3_mutex_enter(pMaster);
2578 pBt->nRef--;
2579 if( pBt->nRef<=0 ){
drh78f82d12008-09-02 00:52:52 +00002580 if( GLOBAL(BtShared*,sqlite3SharedCacheList)==pBt ){
2581 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt->pNext;
drhe53831d2007-08-17 01:14:38 +00002582 }else{
drh78f82d12008-09-02 00:52:52 +00002583 pList = GLOBAL(BtShared*,sqlite3SharedCacheList);
drh34004ce2008-07-11 16:15:17 +00002584 while( ALWAYS(pList) && pList->pNext!=pBt ){
drhe53831d2007-08-17 01:14:38 +00002585 pList=pList->pNext;
2586 }
drh34004ce2008-07-11 16:15:17 +00002587 if( ALWAYS(pList) ){
drhe53831d2007-08-17 01:14:38 +00002588 pList->pNext = pBt->pNext;
2589 }
2590 }
drh3285db22007-09-03 22:00:39 +00002591 if( SQLITE_THREADSAFE ){
2592 sqlite3_mutex_free(pBt->mutex);
2593 }
drhe53831d2007-08-17 01:14:38 +00002594 removed = 1;
2595 }
2596 sqlite3_mutex_leave(pMaster);
2597 return removed;
2598#else
2599 return 1;
2600#endif
2601}
2602
2603/*
drhf7141992008-06-19 00:16:08 +00002604** Make sure pBt->pTmpSpace points to an allocation of
drh92787cf2014-10-15 11:55:51 +00002605** MX_CELL_SIZE(pBt) bytes with a 4-byte prefix for a left-child
2606** pointer.
drhf7141992008-06-19 00:16:08 +00002607*/
2608static void allocateTempSpace(BtShared *pBt){
2609 if( !pBt->pTmpSpace ){
2610 pBt->pTmpSpace = sqlite3PageMalloc( pBt->pageSize );
dan14285b72013-10-16 11:39:07 +00002611
2612 /* One of the uses of pBt->pTmpSpace is to format cells before
2613 ** inserting them into a leaf page (function fillInCell()). If
2614 ** a cell is less than 4 bytes in size, it is rounded up to 4 bytes
2615 ** by the various routines that manipulate binary cells. Which
2616 ** can mean that fillInCell() only initializes the first 2 or 3
2617 ** bytes of pTmpSpace, but that the first 4 bytes are copied from
2618 ** it into a database page. This is not actually a problem, but it
2619 ** does cause a valgrind error when the 1 or 2 bytes of unitialized
2620 ** data is passed to system call write(). So to avoid this error,
drh92787cf2014-10-15 11:55:51 +00002621 ** zero the first 4 bytes of temp space here.
2622 **
2623 ** Also: Provide four bytes of initialized space before the
2624 ** beginning of pTmpSpace as an area available to prepend the
2625 ** left-child pointer to the beginning of a cell.
2626 */
2627 if( pBt->pTmpSpace ){
2628 memset(pBt->pTmpSpace, 0, 8);
2629 pBt->pTmpSpace += 4;
2630 }
drhf7141992008-06-19 00:16:08 +00002631 }
2632}
2633
2634/*
2635** Free the pBt->pTmpSpace allocation
2636*/
2637static void freeTempSpace(BtShared *pBt){
drh92787cf2014-10-15 11:55:51 +00002638 if( pBt->pTmpSpace ){
2639 pBt->pTmpSpace -= 4;
2640 sqlite3PageFree(pBt->pTmpSpace);
2641 pBt->pTmpSpace = 0;
2642 }
drhf7141992008-06-19 00:16:08 +00002643}
2644
2645/*
drha059ad02001-04-17 20:09:11 +00002646** Close an open database and invalidate all cursors.
2647*/
danielk1977aef0bf62005-12-30 16:28:01 +00002648int sqlite3BtreeClose(Btree *p){
danielk1977aef0bf62005-12-30 16:28:01 +00002649 BtShared *pBt = p->pBt;
2650 BtCursor *pCur;
2651
danielk1977aef0bf62005-12-30 16:28:01 +00002652 /* Close all cursors opened via this handle. */
drhe5fe6902007-12-07 18:55:28 +00002653 assert( sqlite3_mutex_held(p->db->mutex) );
drhe53831d2007-08-17 01:14:38 +00002654 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002655 pCur = pBt->pCursor;
2656 while( pCur ){
2657 BtCursor *pTmp = pCur;
2658 pCur = pCur->pNext;
2659 if( pTmp->pBtree==p ){
2660 sqlite3BtreeCloseCursor(pTmp);
2661 }
drha059ad02001-04-17 20:09:11 +00002662 }
danielk1977aef0bf62005-12-30 16:28:01 +00002663
danielk19778d34dfd2006-01-24 16:37:57 +00002664 /* Rollback any active transaction and free the handle structure.
2665 ** The call to sqlite3BtreeRollback() drops any table-locks held by
2666 ** this handle.
2667 */
drh47b7fc72014-11-11 01:33:57 +00002668 sqlite3BtreeRollback(p, SQLITE_OK, 0);
drhe53831d2007-08-17 01:14:38 +00002669 sqlite3BtreeLeave(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002670
danielk1977aef0bf62005-12-30 16:28:01 +00002671 /* If there are still other outstanding references to the shared-btree
2672 ** structure, return now. The remainder of this procedure cleans
2673 ** up the shared-btree.
2674 */
drhe53831d2007-08-17 01:14:38 +00002675 assert( p->wantToLock==0 && p->locked==0 );
2676 if( !p->sharable || removeFromSharingList(pBt) ){
2677 /* The pBt is no longer on the sharing list, so we can access
2678 ** it without having to hold the mutex.
2679 **
2680 ** Clean out and delete the BtShared object.
2681 */
2682 assert( !pBt->pCursor );
dan7fb89902016-08-12 16:21:15 +00002683 sqlite3PagerClose(pBt->pPager, p->db);
drhe53831d2007-08-17 01:14:38 +00002684 if( pBt->xFreeSchema && pBt->pSchema ){
2685 pBt->xFreeSchema(pBt->pSchema);
2686 }
drhb9755982010-07-24 16:34:37 +00002687 sqlite3DbFree(0, pBt->pSchema);
drhf7141992008-06-19 00:16:08 +00002688 freeTempSpace(pBt);
drh65bbf292008-06-19 01:03:17 +00002689 sqlite3_free(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00002690 }
2691
drhe53831d2007-08-17 01:14:38 +00002692#ifndef SQLITE_OMIT_SHARED_CACHE
drhcab5ed72007-08-22 11:41:18 +00002693 assert( p->wantToLock==0 );
2694 assert( p->locked==0 );
2695 if( p->pPrev ) p->pPrev->pNext = p->pNext;
2696 if( p->pNext ) p->pNext->pPrev = p->pPrev;
danielk1977aef0bf62005-12-30 16:28:01 +00002697#endif
2698
drhe53831d2007-08-17 01:14:38 +00002699 sqlite3_free(p);
drha059ad02001-04-17 20:09:11 +00002700 return SQLITE_OK;
2701}
2702
2703/*
drh9b0cf342015-11-12 14:57:19 +00002704** Change the "soft" limit on the number of pages in the cache.
2705** Unused and unmodified pages will be recycled when the number of
2706** pages in the cache exceeds this soft limit. But the size of the
2707** cache is allowed to grow larger than this limit if it contains
2708** dirty pages or pages still in active use.
drhf57b14a2001-09-14 18:54:08 +00002709*/
danielk1977aef0bf62005-12-30 16:28:01 +00002710int sqlite3BtreeSetCacheSize(Btree *p, int mxPage){
2711 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00002712 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00002713 sqlite3BtreeEnter(p);
danielk19773b8a05f2007-03-19 17:44:26 +00002714 sqlite3PagerSetCachesize(pBt->pPager, mxPage);
drhd677b3d2007-08-20 22:48:41 +00002715 sqlite3BtreeLeave(p);
drhf57b14a2001-09-14 18:54:08 +00002716 return SQLITE_OK;
2717}
2718
drh9b0cf342015-11-12 14:57:19 +00002719/*
2720** Change the "spill" limit on the number of pages in the cache.
2721** If the number of pages exceeds this limit during a write transaction,
2722** the pager might attempt to "spill" pages to the journal early in
2723** order to free up memory.
2724**
2725** The value returned is the current spill size. If zero is passed
2726** as an argument, no changes are made to the spill size setting, so
2727** using mxPage of 0 is a way to query the current spill size.
2728*/
2729int sqlite3BtreeSetSpillSize(Btree *p, int mxPage){
2730 BtShared *pBt = p->pBt;
2731 int res;
2732 assert( sqlite3_mutex_held(p->db->mutex) );
2733 sqlite3BtreeEnter(p);
2734 res = sqlite3PagerSetSpillsize(pBt->pPager, mxPage);
2735 sqlite3BtreeLeave(p);
2736 return res;
2737}
2738
drh18c7e402014-03-14 11:46:10 +00002739#if SQLITE_MAX_MMAP_SIZE>0
drhf57b14a2001-09-14 18:54:08 +00002740/*
dan5d8a1372013-03-19 19:28:06 +00002741** Change the limit on the amount of the database file that may be
2742** memory mapped.
2743*/
drh9b4c59f2013-04-15 17:03:42 +00002744int sqlite3BtreeSetMmapLimit(Btree *p, sqlite3_int64 szMmap){
dan5d8a1372013-03-19 19:28:06 +00002745 BtShared *pBt = p->pBt;
2746 assert( sqlite3_mutex_held(p->db->mutex) );
2747 sqlite3BtreeEnter(p);
drh9b4c59f2013-04-15 17:03:42 +00002748 sqlite3PagerSetMmapLimit(pBt->pPager, szMmap);
dan5d8a1372013-03-19 19:28:06 +00002749 sqlite3BtreeLeave(p);
2750 return SQLITE_OK;
2751}
drh18c7e402014-03-14 11:46:10 +00002752#endif /* SQLITE_MAX_MMAP_SIZE>0 */
dan5d8a1372013-03-19 19:28:06 +00002753
2754/*
drh973b6e32003-02-12 14:09:42 +00002755** Change the way data is synced to disk in order to increase or decrease
2756** how well the database resists damage due to OS crashes and power
2757** failures. Level 1 is the same as asynchronous (no syncs() occur and
2758** there is a high probability of damage) Level 2 is the default. There
2759** is a very low but non-zero probability of damage. Level 3 reduces the
2760** probability of damage to near zero but with a write performance reduction.
2761*/
danielk197793758c82005-01-21 08:13:14 +00002762#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh40c39412013-08-16 20:42:20 +00002763int sqlite3BtreeSetPagerFlags(
drhc97d8462010-11-19 18:23:35 +00002764 Btree *p, /* The btree to set the safety level on */
drh40c39412013-08-16 20:42:20 +00002765 unsigned pgFlags /* Various PAGER_* flags */
drhc97d8462010-11-19 18:23:35 +00002766){
danielk1977aef0bf62005-12-30 16:28:01 +00002767 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00002768 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00002769 sqlite3BtreeEnter(p);
drh40c39412013-08-16 20:42:20 +00002770 sqlite3PagerSetFlags(pBt->pPager, pgFlags);
drhd677b3d2007-08-20 22:48:41 +00002771 sqlite3BtreeLeave(p);
drh973b6e32003-02-12 14:09:42 +00002772 return SQLITE_OK;
2773}
danielk197793758c82005-01-21 08:13:14 +00002774#endif
drh973b6e32003-02-12 14:09:42 +00002775
drh2c8997b2005-08-27 16:36:48 +00002776/*
drh90f5ecb2004-07-22 01:19:35 +00002777** Change the default pages size and the number of reserved bytes per page.
drhce4869f2009-04-02 20:16:58 +00002778** Or, if the page size has already been fixed, return SQLITE_READONLY
2779** without changing anything.
drh06f50212004-11-02 14:24:33 +00002780**
2781** The page size must be a power of 2 between 512 and 65536. If the page
2782** size supplied does not meet this constraint then the page size is not
2783** changed.
2784**
2785** Page sizes are constrained to be a power of two so that the region
2786** of the database file used for locking (beginning at PENDING_BYTE,
2787** the first byte past the 1GB boundary, 0x40000000) needs to occur
2788** at the beginning of a page.
danielk197728129562005-01-11 10:25:06 +00002789**
2790** If parameter nReserve is less than zero, then the number of reserved
2791** bytes per page is left unchanged.
drhce4869f2009-04-02 20:16:58 +00002792**
drhc9166342012-01-05 23:32:06 +00002793** If the iFix!=0 then the BTS_PAGESIZE_FIXED flag is set so that the page size
drhce4869f2009-04-02 20:16:58 +00002794** and autovacuum mode can no longer be changed.
drh90f5ecb2004-07-22 01:19:35 +00002795*/
drhce4869f2009-04-02 20:16:58 +00002796int sqlite3BtreeSetPageSize(Btree *p, int pageSize, int nReserve, int iFix){
danielk1977a1644fd2007-08-29 12:31:25 +00002797 int rc = SQLITE_OK;
danielk1977aef0bf62005-12-30 16:28:01 +00002798 BtShared *pBt = p->pBt;
drhf49661a2008-12-10 16:45:50 +00002799 assert( nReserve>=-1 && nReserve<=255 );
drhd677b3d2007-08-20 22:48:41 +00002800 sqlite3BtreeEnter(p);
drhad0961b2015-02-21 00:19:25 +00002801#if SQLITE_HAS_CODEC
2802 if( nReserve>pBt->optimalReserve ) pBt->optimalReserve = (u8)nReserve;
2803#endif
drhc9166342012-01-05 23:32:06 +00002804 if( pBt->btsFlags & BTS_PAGESIZE_FIXED ){
drhd677b3d2007-08-20 22:48:41 +00002805 sqlite3BtreeLeave(p);
drh90f5ecb2004-07-22 01:19:35 +00002806 return SQLITE_READONLY;
2807 }
2808 if( nReserve<0 ){
2809 nReserve = pBt->pageSize - pBt->usableSize;
2810 }
drhf49661a2008-12-10 16:45:50 +00002811 assert( nReserve>=0 && nReserve<=255 );
drh06f50212004-11-02 14:24:33 +00002812 if( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE &&
2813 ((pageSize-1)&pageSize)==0 ){
drh07d183d2005-05-01 22:52:42 +00002814 assert( (pageSize & 7)==0 );
dandd14ecb2015-05-05 10:03:08 +00002815 assert( !pBt->pCursor );
drhb2eced52010-08-12 02:41:12 +00002816 pBt->pageSize = (u32)pageSize;
drhf7141992008-06-19 00:16:08 +00002817 freeTempSpace(pBt);
drh90f5ecb2004-07-22 01:19:35 +00002818 }
drhfa9601a2009-06-18 17:22:39 +00002819 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
drhf49661a2008-12-10 16:45:50 +00002820 pBt->usableSize = pBt->pageSize - (u16)nReserve;
drhc9166342012-01-05 23:32:06 +00002821 if( iFix ) pBt->btsFlags |= BTS_PAGESIZE_FIXED;
drhd677b3d2007-08-20 22:48:41 +00002822 sqlite3BtreeLeave(p);
danielk1977a1644fd2007-08-29 12:31:25 +00002823 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002824}
2825
2826/*
2827** Return the currently defined page size
2828*/
danielk1977aef0bf62005-12-30 16:28:01 +00002829int sqlite3BtreeGetPageSize(Btree *p){
2830 return p->pBt->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00002831}
drh7f751222009-03-17 22:33:00 +00002832
dan0094f372012-09-28 20:23:42 +00002833/*
2834** This function is similar to sqlite3BtreeGetReserve(), except that it
2835** may only be called if it is guaranteed that the b-tree mutex is already
2836** held.
2837**
2838** This is useful in one special case in the backup API code where it is
2839** known that the shared b-tree mutex is held, but the mutex on the
2840** database handle that owns *p is not. In this case if sqlite3BtreeEnter()
2841** were to be called, it might collide with some other operation on the
mistachkin48864df2013-03-21 21:20:32 +00002842** database handle that owns *p, causing undefined behavior.
dan0094f372012-09-28 20:23:42 +00002843*/
2844int sqlite3BtreeGetReserveNoMutex(Btree *p){
drhad0961b2015-02-21 00:19:25 +00002845 int n;
dan0094f372012-09-28 20:23:42 +00002846 assert( sqlite3_mutex_held(p->pBt->mutex) );
drhad0961b2015-02-21 00:19:25 +00002847 n = p->pBt->pageSize - p->pBt->usableSize;
2848 return n;
dan0094f372012-09-28 20:23:42 +00002849}
2850
drh7f751222009-03-17 22:33:00 +00002851/*
2852** Return the number of bytes of space at the end of every page that
2853** are intentually left unused. This is the "reserved" space that is
2854** sometimes used by extensions.
drhad0961b2015-02-21 00:19:25 +00002855**
2856** If SQLITE_HAS_MUTEX is defined then the number returned is the
2857** greater of the current reserved space and the maximum requested
2858** reserve space.
drh7f751222009-03-17 22:33:00 +00002859*/
drhad0961b2015-02-21 00:19:25 +00002860int sqlite3BtreeGetOptimalReserve(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00002861 int n;
2862 sqlite3BtreeEnter(p);
drhad0961b2015-02-21 00:19:25 +00002863 n = sqlite3BtreeGetReserveNoMutex(p);
2864#ifdef SQLITE_HAS_CODEC
2865 if( n<p->pBt->optimalReserve ) n = p->pBt->optimalReserve;
2866#endif
drhd677b3d2007-08-20 22:48:41 +00002867 sqlite3BtreeLeave(p);
2868 return n;
drh2011d5f2004-07-22 02:40:37 +00002869}
drhf8e632b2007-05-08 14:51:36 +00002870
drhad0961b2015-02-21 00:19:25 +00002871
drhf8e632b2007-05-08 14:51:36 +00002872/*
2873** Set the maximum page count for a database if mxPage is positive.
2874** No changes are made if mxPage is 0 or negative.
2875** Regardless of the value of mxPage, return the maximum page count.
2876*/
2877int sqlite3BtreeMaxPageCount(Btree *p, int mxPage){
drhd677b3d2007-08-20 22:48:41 +00002878 int n;
2879 sqlite3BtreeEnter(p);
2880 n = sqlite3PagerMaxPageCount(p->pBt->pPager, mxPage);
2881 sqlite3BtreeLeave(p);
2882 return n;
drhf8e632b2007-05-08 14:51:36 +00002883}
drh5b47efa2010-02-12 18:18:39 +00002884
2885/*
drha5907a82017-06-19 11:44:22 +00002886** Change the values for the BTS_SECURE_DELETE and BTS_OVERWRITE flags:
2887**
2888** newFlag==0 Both BTS_SECURE_DELETE and BTS_OVERWRITE are cleared
2889** newFlag==1 BTS_SECURE_DELETE set and BTS_OVERWRITE is cleared
2890** newFlag==2 BTS_SECURE_DELETE cleared and BTS_OVERWRITE is set
2891** newFlag==(-1) No changes
2892**
2893** This routine acts as a query if newFlag is less than zero
2894**
2895** With BTS_OVERWRITE set, deleted content is overwritten by zeros, but
2896** freelist leaf pages are not written back to the database. Thus in-page
2897** deleted content is cleared, but freelist deleted content is not.
2898**
2899** With BTS_SECURE_DELETE, operation is like BTS_OVERWRITE with the addition
2900** that freelist leaf pages are written back into the database, increasing
2901** the amount of disk I/O.
drh5b47efa2010-02-12 18:18:39 +00002902*/
2903int sqlite3BtreeSecureDelete(Btree *p, int newFlag){
2904 int b;
drhaf034ed2010-02-12 19:46:26 +00002905 if( p==0 ) return 0;
drh5b47efa2010-02-12 18:18:39 +00002906 sqlite3BtreeEnter(p);
drha5907a82017-06-19 11:44:22 +00002907 assert( BTS_OVERWRITE==BTS_SECURE_DELETE*2 );
2908 assert( BTS_FAST_SECURE==(BTS_OVERWRITE|BTS_SECURE_DELETE) );
drh5b47efa2010-02-12 18:18:39 +00002909 if( newFlag>=0 ){
drha5907a82017-06-19 11:44:22 +00002910 p->pBt->btsFlags &= ~BTS_FAST_SECURE;
2911 p->pBt->btsFlags |= BTS_SECURE_DELETE*newFlag;
2912 }
2913 b = (p->pBt->btsFlags & BTS_FAST_SECURE)/BTS_SECURE_DELETE;
drh5b47efa2010-02-12 18:18:39 +00002914 sqlite3BtreeLeave(p);
2915 return b;
2916}
drh90f5ecb2004-07-22 01:19:35 +00002917
2918/*
danielk1977951af802004-11-05 15:45:09 +00002919** Change the 'auto-vacuum' property of the database. If the 'autoVacuum'
2920** parameter is non-zero, then auto-vacuum mode is enabled. If zero, it
2921** is disabled. The default value for the auto-vacuum property is
2922** determined by the SQLITE_DEFAULT_AUTOVACUUM macro.
2923*/
danielk1977aef0bf62005-12-30 16:28:01 +00002924int sqlite3BtreeSetAutoVacuum(Btree *p, int autoVacuum){
danielk1977951af802004-11-05 15:45:09 +00002925#ifdef SQLITE_OMIT_AUTOVACUUM
drheee46cf2004-11-06 00:02:48 +00002926 return SQLITE_READONLY;
danielk1977951af802004-11-05 15:45:09 +00002927#else
danielk1977dddbcdc2007-04-26 14:42:34 +00002928 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00002929 int rc = SQLITE_OK;
drh076d4662009-02-18 20:31:18 +00002930 u8 av = (u8)autoVacuum;
drhd677b3d2007-08-20 22:48:41 +00002931
2932 sqlite3BtreeEnter(p);
drhc9166342012-01-05 23:32:06 +00002933 if( (pBt->btsFlags & BTS_PAGESIZE_FIXED)!=0 && (av ?1:0)!=pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00002934 rc = SQLITE_READONLY;
2935 }else{
drh076d4662009-02-18 20:31:18 +00002936 pBt->autoVacuum = av ?1:0;
2937 pBt->incrVacuum = av==2 ?1:0;
danielk1977951af802004-11-05 15:45:09 +00002938 }
drhd677b3d2007-08-20 22:48:41 +00002939 sqlite3BtreeLeave(p);
2940 return rc;
danielk1977951af802004-11-05 15:45:09 +00002941#endif
2942}
2943
2944/*
2945** Return the value of the 'auto-vacuum' property. If auto-vacuum is
2946** enabled 1 is returned. Otherwise 0.
2947*/
danielk1977aef0bf62005-12-30 16:28:01 +00002948int sqlite3BtreeGetAutoVacuum(Btree *p){
danielk1977951af802004-11-05 15:45:09 +00002949#ifdef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00002950 return BTREE_AUTOVACUUM_NONE;
danielk1977951af802004-11-05 15:45:09 +00002951#else
drhd677b3d2007-08-20 22:48:41 +00002952 int rc;
2953 sqlite3BtreeEnter(p);
2954 rc = (
danielk1977dddbcdc2007-04-26 14:42:34 +00002955 (!p->pBt->autoVacuum)?BTREE_AUTOVACUUM_NONE:
2956 (!p->pBt->incrVacuum)?BTREE_AUTOVACUUM_FULL:
2957 BTREE_AUTOVACUUM_INCR
2958 );
drhd677b3d2007-08-20 22:48:41 +00002959 sqlite3BtreeLeave(p);
2960 return rc;
danielk1977951af802004-11-05 15:45:09 +00002961#endif
2962}
2963
danf5da7db2017-03-16 18:14:39 +00002964/*
2965** If the user has not set the safety-level for this database connection
2966** using "PRAGMA synchronous", and if the safety-level is not already
2967** set to the value passed to this function as the second parameter,
2968** set it so.
2969*/
drh2ed57372017-10-05 20:57:38 +00002970#if SQLITE_DEFAULT_SYNCHRONOUS!=SQLITE_DEFAULT_WAL_SYNCHRONOUS \
2971 && !defined(SQLITE_OMIT_WAL)
danf5da7db2017-03-16 18:14:39 +00002972static void setDefaultSyncFlag(BtShared *pBt, u8 safety_level){
2973 sqlite3 *db;
2974 Db *pDb;
2975 if( (db=pBt->db)!=0 && (pDb=db->aDb)!=0 ){
2976 while( pDb->pBt==0 || pDb->pBt->pBt!=pBt ){ pDb++; }
2977 if( pDb->bSyncSet==0
2978 && pDb->safety_level!=safety_level
2979 && pDb!=&db->aDb[1]
2980 ){
2981 pDb->safety_level = safety_level;
2982 sqlite3PagerSetFlags(pBt->pPager,
2983 pDb->safety_level | (db->flags & PAGER_FLAGS_MASK));
2984 }
2985 }
2986}
2987#else
danfc8f4b62017-03-16 18:54:42 +00002988# define setDefaultSyncFlag(pBt,safety_level)
danf5da7db2017-03-16 18:14:39 +00002989#endif
danielk1977951af802004-11-05 15:45:09 +00002990
drh0314cf32018-04-28 01:27:09 +00002991/* Forward declaration */
2992static int newDatabase(BtShared*);
2993
2994
danielk1977951af802004-11-05 15:45:09 +00002995/*
drha34b6762004-05-07 13:30:42 +00002996** Get a reference to pPage1 of the database file. This will
drh306dc212001-05-21 13:45:10 +00002997** also acquire a readlock on that file.
2998**
2999** SQLITE_OK is returned on success. If the file is not a
3000** well-formed database file, then SQLITE_CORRUPT is returned.
3001** SQLITE_BUSY is returned if the database is locked. SQLITE_NOMEM
drh4f0ee682007-03-30 20:43:40 +00003002** is returned if we run out of memory.
drh306dc212001-05-21 13:45:10 +00003003*/
danielk1977aef0bf62005-12-30 16:28:01 +00003004static int lockBtree(BtShared *pBt){
drhc2a4bab2010-04-02 12:46:45 +00003005 int rc; /* Result code from subfunctions */
3006 MemPage *pPage1; /* Page 1 of the database file */
3007 int nPage; /* Number of pages in the database */
3008 int nPageFile = 0; /* Number of pages in the database file */
3009 int nPageHeader; /* Number of pages in the database according to hdr */
drhd677b3d2007-08-20 22:48:41 +00003010
drh1fee73e2007-08-29 04:00:57 +00003011 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977295dc102009-04-01 19:07:03 +00003012 assert( pBt->pPage1==0 );
danielk197789bc4bc2009-07-21 19:25:24 +00003013 rc = sqlite3PagerSharedLock(pBt->pPager);
3014 if( rc!=SQLITE_OK ) return rc;
drhb00fc3b2013-08-21 23:42:32 +00003015 rc = btreeGetPage(pBt, 1, &pPage1, 0);
drh306dc212001-05-21 13:45:10 +00003016 if( rc!=SQLITE_OK ) return rc;
drh306dc212001-05-21 13:45:10 +00003017
3018 /* Do some checking to help insure the file we opened really is
3019 ** a valid database file.
3020 */
drhc2a4bab2010-04-02 12:46:45 +00003021 nPage = nPageHeader = get4byte(28+(u8*)pPage1->aData);
drh8fb8b532010-08-14 17:12:04 +00003022 sqlite3PagerPagecount(pBt->pPager, &nPageFile);
drhb28e59b2010-06-17 02:13:39 +00003023 if( nPage==0 || memcmp(24+(u8*)pPage1->aData, 92+(u8*)pPage1->aData,4)!=0 ){
drhc2a4bab2010-04-02 12:46:45 +00003024 nPage = nPageFile;
drh97b59a52010-03-31 02:31:33 +00003025 }
drh0314cf32018-04-28 01:27:09 +00003026 if( (pBt->db->flags & SQLITE_ResetDatabase)!=0 ){
3027 nPage = 0;
3028 }
drh97b59a52010-03-31 02:31:33 +00003029 if( nPage>0 ){
drh43b18e12010-08-17 19:40:08 +00003030 u32 pageSize;
3031 u32 usableSize;
drhb6f41482004-05-14 01:58:11 +00003032 u8 *page1 = pPage1->aData;
danielk1977ad0132d2008-06-07 08:58:22 +00003033 rc = SQLITE_NOTADB;
drh113762a2014-11-19 16:36:25 +00003034 /* EVIDENCE-OF: R-43737-39999 Every valid SQLite database file begins
3035 ** with the following 16 bytes (in hex): 53 51 4c 69 74 65 20 66 6f 72 6d
3036 ** 61 74 20 33 00. */
drhb6f41482004-05-14 01:58:11 +00003037 if( memcmp(page1, zMagicHeader, 16)!=0 ){
drh72f82862001-05-24 21:06:34 +00003038 goto page1_init_failed;
drh306dc212001-05-21 13:45:10 +00003039 }
dan5cf53532010-05-01 16:40:20 +00003040
3041#ifdef SQLITE_OMIT_WAL
3042 if( page1[18]>1 ){
drhc9166342012-01-05 23:32:06 +00003043 pBt->btsFlags |= BTS_READ_ONLY;
dan5cf53532010-05-01 16:40:20 +00003044 }
3045 if( page1[19]>1 ){
3046 goto page1_init_failed;
3047 }
3048#else
dane04dc882010-04-20 18:53:15 +00003049 if( page1[18]>2 ){
drhc9166342012-01-05 23:32:06 +00003050 pBt->btsFlags |= BTS_READ_ONLY;
drh309169a2007-04-24 17:27:51 +00003051 }
dane04dc882010-04-20 18:53:15 +00003052 if( page1[19]>2 ){
drhb6f41482004-05-14 01:58:11 +00003053 goto page1_init_failed;
3054 }
drhe5ae5732008-06-15 02:51:47 +00003055
dana470aeb2010-04-21 11:43:38 +00003056 /* If the write version is set to 2, this database should be accessed
3057 ** in WAL mode. If the log is not already open, open it now. Then
3058 ** return SQLITE_OK and return without populating BtShared.pPage1.
3059 ** The caller detects this and calls this function again. This is
3060 ** required as the version of page 1 currently in the page1 buffer
3061 ** may not be the latest version - there may be a newer one in the log
3062 ** file.
3063 */
drhc9166342012-01-05 23:32:06 +00003064 if( page1[19]==2 && (pBt->btsFlags & BTS_NO_WAL)==0 ){
dane04dc882010-04-20 18:53:15 +00003065 int isOpen = 0;
drh7ed91f22010-04-29 22:34:07 +00003066 rc = sqlite3PagerOpenWal(pBt->pPager, &isOpen);
dane04dc882010-04-20 18:53:15 +00003067 if( rc!=SQLITE_OK ){
3068 goto page1_init_failed;
drhe243de52016-03-08 15:14:26 +00003069 }else{
danf5da7db2017-03-16 18:14:39 +00003070 setDefaultSyncFlag(pBt, SQLITE_DEFAULT_WAL_SYNCHRONOUS+1);
drhe243de52016-03-08 15:14:26 +00003071 if( isOpen==0 ){
drh3908fe92017-09-01 14:50:19 +00003072 releasePageOne(pPage1);
drhe243de52016-03-08 15:14:26 +00003073 return SQLITE_OK;
3074 }
dane04dc882010-04-20 18:53:15 +00003075 }
dan8b5444b2010-04-27 14:37:47 +00003076 rc = SQLITE_NOTADB;
danf5da7db2017-03-16 18:14:39 +00003077 }else{
3078 setDefaultSyncFlag(pBt, SQLITE_DEFAULT_SYNCHRONOUS+1);
dane04dc882010-04-20 18:53:15 +00003079 }
dan5cf53532010-05-01 16:40:20 +00003080#endif
dane04dc882010-04-20 18:53:15 +00003081
drh113762a2014-11-19 16:36:25 +00003082 /* EVIDENCE-OF: R-15465-20813 The maximum and minimum embedded payload
3083 ** fractions and the leaf payload fraction values must be 64, 32, and 32.
3084 **
drhe5ae5732008-06-15 02:51:47 +00003085 ** The original design allowed these amounts to vary, but as of
3086 ** version 3.6.0, we require them to be fixed.
3087 */
3088 if( memcmp(&page1[21], "\100\040\040",3)!=0 ){
3089 goto page1_init_failed;
3090 }
drh113762a2014-11-19 16:36:25 +00003091 /* EVIDENCE-OF: R-51873-39618 The page size for a database file is
3092 ** determined by the 2-byte integer located at an offset of 16 bytes from
3093 ** the beginning of the database file. */
drhb2eced52010-08-12 02:41:12 +00003094 pageSize = (page1[16]<<8) | (page1[17]<<16);
drh113762a2014-11-19 16:36:25 +00003095 /* EVIDENCE-OF: R-25008-21688 The size of a page is a power of two
3096 ** between 512 and 65536 inclusive. */
drhb2eced52010-08-12 02:41:12 +00003097 if( ((pageSize-1)&pageSize)!=0
3098 || pageSize>SQLITE_MAX_PAGE_SIZE
3099 || pageSize<=256
drh7dc385e2007-09-06 23:39:36 +00003100 ){
drh07d183d2005-05-01 22:52:42 +00003101 goto page1_init_failed;
3102 }
3103 assert( (pageSize & 7)==0 );
drh113762a2014-11-19 16:36:25 +00003104 /* EVIDENCE-OF: R-59310-51205 The "reserved space" size in the 1-byte
3105 ** integer at offset 20 is the number of bytes of space at the end of
3106 ** each page to reserve for extensions.
3107 **
3108 ** EVIDENCE-OF: R-37497-42412 The size of the reserved region is
3109 ** determined by the one-byte unsigned integer found at an offset of 20
3110 ** into the database file header. */
danielk1977f653d782008-03-20 11:04:21 +00003111 usableSize = pageSize - page1[20];
shaneh1df2db72010-08-18 02:28:48 +00003112 if( (u32)pageSize!=pBt->pageSize ){
danielk1977f653d782008-03-20 11:04:21 +00003113 /* After reading the first page of the database assuming a page size
3114 ** of BtShared.pageSize, we have discovered that the page-size is
3115 ** actually pageSize. Unlock the database, leave pBt->pPage1 at
3116 ** zero and return SQLITE_OK. The caller will call this function
3117 ** again with the correct page-size.
3118 */
drh3908fe92017-09-01 14:50:19 +00003119 releasePageOne(pPage1);
drh43b18e12010-08-17 19:40:08 +00003120 pBt->usableSize = usableSize;
3121 pBt->pageSize = pageSize;
drhf7141992008-06-19 00:16:08 +00003122 freeTempSpace(pBt);
drhfa9601a2009-06-18 17:22:39 +00003123 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize,
3124 pageSize-usableSize);
drh5e483932009-07-10 16:51:30 +00003125 return rc;
danielk1977f653d782008-03-20 11:04:21 +00003126 }
drh0f1c2eb2018-11-03 17:31:48 +00003127 if( sqlite3WritableSchema(pBt->db)==0 && nPage>nPageFile ){
drhc2a4bab2010-04-02 12:46:45 +00003128 rc = SQLITE_CORRUPT_BKPT;
3129 goto page1_init_failed;
3130 }
drh113762a2014-11-19 16:36:25 +00003131 /* EVIDENCE-OF: R-28312-64704 However, the usable size is not allowed to
3132 ** be less than 480. In other words, if the page size is 512, then the
3133 ** reserved space size cannot exceed 32. */
drhb33e1b92009-06-18 11:29:20 +00003134 if( usableSize<480 ){
drhb6f41482004-05-14 01:58:11 +00003135 goto page1_init_failed;
3136 }
drh43b18e12010-08-17 19:40:08 +00003137 pBt->pageSize = pageSize;
3138 pBt->usableSize = usableSize;
drh057cd3a2005-02-15 16:23:02 +00003139#ifndef SQLITE_OMIT_AUTOVACUUM
3140 pBt->autoVacuum = (get4byte(&page1[36 + 4*4])?1:0);
danielk197727b1f952007-06-25 08:16:58 +00003141 pBt->incrVacuum = (get4byte(&page1[36 + 7*4])?1:0);
drh057cd3a2005-02-15 16:23:02 +00003142#endif
drh306dc212001-05-21 13:45:10 +00003143 }
drhb6f41482004-05-14 01:58:11 +00003144
3145 /* maxLocal is the maximum amount of payload to store locally for
3146 ** a cell. Make sure it is small enough so that at least minFanout
3147 ** cells can will fit on one page. We assume a 10-byte page header.
3148 ** Besides the payload, the cell must store:
drh43605152004-05-29 21:46:49 +00003149 ** 2-byte pointer to the cell
drhb6f41482004-05-14 01:58:11 +00003150 ** 4-byte child pointer
3151 ** 9-byte nKey value
3152 ** 4-byte nData value
3153 ** 4-byte overflow page pointer
drhe22e03e2010-08-18 21:19:03 +00003154 ** So a cell consists of a 2-byte pointer, a header which is as much as
drh43605152004-05-29 21:46:49 +00003155 ** 17 bytes long, 0 to N bytes of payload, and an optional 4 byte overflow
3156 ** page pointer.
drhb6f41482004-05-14 01:58:11 +00003157 */
shaneh1df2db72010-08-18 02:28:48 +00003158 pBt->maxLocal = (u16)((pBt->usableSize-12)*64/255 - 23);
3159 pBt->minLocal = (u16)((pBt->usableSize-12)*32/255 - 23);
3160 pBt->maxLeaf = (u16)(pBt->usableSize - 35);
3161 pBt->minLeaf = (u16)((pBt->usableSize-12)*32/255 - 23);
drhc9166342012-01-05 23:32:06 +00003162 if( pBt->maxLocal>127 ){
3163 pBt->max1bytePayload = 127;
3164 }else{
mistachkin0547e2f2012-01-08 00:54:02 +00003165 pBt->max1bytePayload = (u8)pBt->maxLocal;
drhc9166342012-01-05 23:32:06 +00003166 }
drh2e38c322004-09-03 18:38:44 +00003167 assert( pBt->maxLeaf + 23 <= MX_CELL_SIZE(pBt) );
drh3aac2dd2004-04-26 14:10:20 +00003168 pBt->pPage1 = pPage1;
drhdd3cd972010-03-27 17:12:36 +00003169 pBt->nPage = nPage;
drhb6f41482004-05-14 01:58:11 +00003170 return SQLITE_OK;
drh306dc212001-05-21 13:45:10 +00003171
drh72f82862001-05-24 21:06:34 +00003172page1_init_failed:
drh3908fe92017-09-01 14:50:19 +00003173 releasePageOne(pPage1);
drh3aac2dd2004-04-26 14:10:20 +00003174 pBt->pPage1 = 0;
drh72f82862001-05-24 21:06:34 +00003175 return rc;
drh306dc212001-05-21 13:45:10 +00003176}
3177
drh85ec3b62013-05-14 23:12:06 +00003178#ifndef NDEBUG
3179/*
3180** Return the number of cursors open on pBt. This is for use
3181** in assert() expressions, so it is only compiled if NDEBUG is not
3182** defined.
3183**
3184** Only write cursors are counted if wrOnly is true. If wrOnly is
3185** false then all cursors are counted.
3186**
3187** For the purposes of this routine, a cursor is any cursor that
peter.d.reid60ec9142014-09-06 16:39:46 +00003188** is capable of reading or writing to the database. Cursors that
drh85ec3b62013-05-14 23:12:06 +00003189** have been tripped into the CURSOR_FAULT state are not counted.
3190*/
3191static int countValidCursors(BtShared *pBt, int wrOnly){
3192 BtCursor *pCur;
3193 int r = 0;
3194 for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
drh036dbec2014-03-11 23:40:44 +00003195 if( (wrOnly==0 || (pCur->curFlags & BTCF_WriteFlag)!=0)
3196 && pCur->eState!=CURSOR_FAULT ) r++;
drh85ec3b62013-05-14 23:12:06 +00003197 }
3198 return r;
3199}
3200#endif
3201
drh306dc212001-05-21 13:45:10 +00003202/*
drhb8ca3072001-12-05 00:21:20 +00003203** If there are no outstanding cursors and we are not in the middle
3204** of a transaction but there is a read lock on the database, then
3205** this routine unrefs the first page of the database file which
3206** has the effect of releasing the read lock.
3207**
drhb8ca3072001-12-05 00:21:20 +00003208** If there is a transaction in progress, this routine is a no-op.
3209*/
danielk1977aef0bf62005-12-30 16:28:01 +00003210static void unlockBtreeIfUnused(BtShared *pBt){
drh1fee73e2007-08-29 04:00:57 +00003211 assert( sqlite3_mutex_held(pBt->mutex) );
drh85ec3b62013-05-14 23:12:06 +00003212 assert( countValidCursors(pBt,0)==0 || pBt->inTransaction>TRANS_NONE );
danielk19771bc9ee92009-07-04 15:41:02 +00003213 if( pBt->inTransaction==TRANS_NONE && pBt->pPage1!=0 ){
drhb2325b72014-09-24 18:31:07 +00003214 MemPage *pPage1 = pBt->pPage1;
3215 assert( pPage1->aData );
danielk1977c1761e82009-06-25 09:40:03 +00003216 assert( sqlite3PagerRefcount(pBt->pPager)==1 );
drh3aac2dd2004-04-26 14:10:20 +00003217 pBt->pPage1 = 0;
drh3908fe92017-09-01 14:50:19 +00003218 releasePageOne(pPage1);
drhb8ca3072001-12-05 00:21:20 +00003219 }
3220}
3221
3222/*
drhe39f2f92009-07-23 01:43:59 +00003223** If pBt points to an empty file then convert that empty file
3224** into a new empty database by initializing the first page of
3225** the database.
drh8b2f49b2001-06-08 00:21:52 +00003226*/
danielk1977aef0bf62005-12-30 16:28:01 +00003227static int newDatabase(BtShared *pBt){
drh9e572e62004-04-23 23:43:10 +00003228 MemPage *pP1;
3229 unsigned char *data;
drh8c42ca92001-06-22 19:15:00 +00003230 int rc;
drhd677b3d2007-08-20 22:48:41 +00003231
drh1fee73e2007-08-29 04:00:57 +00003232 assert( sqlite3_mutex_held(pBt->mutex) );
drhdd3cd972010-03-27 17:12:36 +00003233 if( pBt->nPage>0 ){
3234 return SQLITE_OK;
danielk1977ad0132d2008-06-07 08:58:22 +00003235 }
drh3aac2dd2004-04-26 14:10:20 +00003236 pP1 = pBt->pPage1;
drh9e572e62004-04-23 23:43:10 +00003237 assert( pP1!=0 );
3238 data = pP1->aData;
danielk19773b8a05f2007-03-19 17:44:26 +00003239 rc = sqlite3PagerWrite(pP1->pDbPage);
drh8b2f49b2001-06-08 00:21:52 +00003240 if( rc ) return rc;
drh9e572e62004-04-23 23:43:10 +00003241 memcpy(data, zMagicHeader, sizeof(zMagicHeader));
3242 assert( sizeof(zMagicHeader)==16 );
shaneh1df2db72010-08-18 02:28:48 +00003243 data[16] = (u8)((pBt->pageSize>>8)&0xff);
3244 data[17] = (u8)((pBt->pageSize>>16)&0xff);
drh9e572e62004-04-23 23:43:10 +00003245 data[18] = 1;
3246 data[19] = 1;
drhf49661a2008-12-10 16:45:50 +00003247 assert( pBt->usableSize<=pBt->pageSize && pBt->usableSize+255>=pBt->pageSize);
3248 data[20] = (u8)(pBt->pageSize - pBt->usableSize);
drhe5ae5732008-06-15 02:51:47 +00003249 data[21] = 64;
3250 data[22] = 32;
3251 data[23] = 32;
drhb6f41482004-05-14 01:58:11 +00003252 memset(&data[24], 0, 100-24);
drhe6c43812004-05-14 12:17:46 +00003253 zeroPage(pP1, PTF_INTKEY|PTF_LEAF|PTF_LEAFDATA );
drhc9166342012-01-05 23:32:06 +00003254 pBt->btsFlags |= BTS_PAGESIZE_FIXED;
danielk1977003ba062004-11-04 02:57:33 +00003255#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00003256 assert( pBt->autoVacuum==1 || pBt->autoVacuum==0 );
danielk1977418899a2007-06-24 10:14:00 +00003257 assert( pBt->incrVacuum==1 || pBt->incrVacuum==0 );
danielk1977dddbcdc2007-04-26 14:42:34 +00003258 put4byte(&data[36 + 4*4], pBt->autoVacuum);
danielk1977418899a2007-06-24 10:14:00 +00003259 put4byte(&data[36 + 7*4], pBt->incrVacuum);
danielk1977003ba062004-11-04 02:57:33 +00003260#endif
drhdd3cd972010-03-27 17:12:36 +00003261 pBt->nPage = 1;
3262 data[31] = 1;
drh8b2f49b2001-06-08 00:21:52 +00003263 return SQLITE_OK;
3264}
3265
3266/*
danb483eba2012-10-13 19:58:11 +00003267** Initialize the first page of the database file (creating a database
3268** consisting of a single page and no schema objects). Return SQLITE_OK
3269** if successful, or an SQLite error code otherwise.
3270*/
3271int sqlite3BtreeNewDb(Btree *p){
3272 int rc;
3273 sqlite3BtreeEnter(p);
3274 p->pBt->nPage = 0;
3275 rc = newDatabase(p->pBt);
3276 sqlite3BtreeLeave(p);
3277 return rc;
3278}
3279
3280/*
danielk1977ee5741e2004-05-31 10:01:34 +00003281** Attempt to start a new transaction. A write-transaction
drh684917c2004-10-05 02:41:42 +00003282** is started if the second argument is nonzero, otherwise a read-
3283** transaction. If the second argument is 2 or more and exclusive
3284** transaction is started, meaning that no other process is allowed
3285** to access the database. A preexisting transaction may not be
drhb8ef32c2005-03-14 02:01:49 +00003286** upgraded to exclusive by calling this routine a second time - the
drh684917c2004-10-05 02:41:42 +00003287** exclusivity flag only works for a new transaction.
drh8b2f49b2001-06-08 00:21:52 +00003288**
danielk1977ee5741e2004-05-31 10:01:34 +00003289** A write-transaction must be started before attempting any
3290** changes to the database. None of the following routines
3291** will work unless a transaction is started first:
drh8b2f49b2001-06-08 00:21:52 +00003292**
drh23e11ca2004-05-04 17:27:28 +00003293** sqlite3BtreeCreateTable()
3294** sqlite3BtreeCreateIndex()
3295** sqlite3BtreeClearTable()
3296** sqlite3BtreeDropTable()
3297** sqlite3BtreeInsert()
3298** sqlite3BtreeDelete()
3299** sqlite3BtreeUpdateMeta()
danielk197713adf8a2004-06-03 16:08:41 +00003300**
drhb8ef32c2005-03-14 02:01:49 +00003301** If an initial attempt to acquire the lock fails because of lock contention
3302** and the database was previously unlocked, then invoke the busy handler
3303** if there is one. But if there was previously a read-lock, do not
3304** invoke the busy handler - just return SQLITE_BUSY. SQLITE_BUSY is
3305** returned when there is already a read-lock in order to avoid a deadlock.
3306**
3307** Suppose there are two processes A and B. A has a read lock and B has
3308** a reserved lock. B tries to promote to exclusive but is blocked because
3309** of A's read lock. A tries to promote to reserved but is blocked by B.
3310** One or the other of the two processes must give way or there can be
3311** no progress. By returning SQLITE_BUSY and not invoking the busy callback
3312** when A already has a read lock, we encourage A to give up and let B
3313** proceed.
drha059ad02001-04-17 20:09:11 +00003314*/
drhbb2d9b12018-06-06 16:28:40 +00003315int sqlite3BtreeBeginTrans(Btree *p, int wrflag, int *pSchemaVersion){
danielk1977aef0bf62005-12-30 16:28:01 +00003316 BtShared *pBt = p->pBt;
danielk1977ee5741e2004-05-31 10:01:34 +00003317 int rc = SQLITE_OK;
3318
drhd677b3d2007-08-20 22:48:41 +00003319 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00003320 btreeIntegrity(p);
3321
danielk1977ee5741e2004-05-31 10:01:34 +00003322 /* If the btree is already in a write-transaction, or it
3323 ** is already in a read-transaction and a read-transaction
3324 ** is requested, this is a no-op.
3325 */
danielk1977aef0bf62005-12-30 16:28:01 +00003326 if( p->inTrans==TRANS_WRITE || (p->inTrans==TRANS_READ && !wrflag) ){
drhd677b3d2007-08-20 22:48:41 +00003327 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00003328 }
dan56c517a2013-09-26 11:04:33 +00003329 assert( pBt->inTransaction==TRANS_WRITE || IfNotOmitAV(pBt->bDoTruncate)==0 );
drhb8ef32c2005-03-14 02:01:49 +00003330
danea933f02018-07-19 11:44:02 +00003331 if( (p->db->flags & SQLITE_ResetDatabase)
3332 && sqlite3PagerIsreadonly(pBt->pPager)==0
3333 ){
3334 pBt->btsFlags &= ~BTS_READ_ONLY;
3335 }
3336
drhb8ef32c2005-03-14 02:01:49 +00003337 /* Write transactions are not possible on a read-only database */
drhc9166342012-01-05 23:32:06 +00003338 if( (pBt->btsFlags & BTS_READ_ONLY)!=0 && wrflag ){
drhd677b3d2007-08-20 22:48:41 +00003339 rc = SQLITE_READONLY;
3340 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00003341 }
3342
danielk1977404ca072009-03-16 13:19:36 +00003343#ifndef SQLITE_OMIT_SHARED_CACHE
drh5a1fb182016-01-08 19:34:39 +00003344 {
3345 sqlite3 *pBlock = 0;
3346 /* If another database handle has already opened a write transaction
3347 ** on this shared-btree structure and a second write transaction is
3348 ** requested, return SQLITE_LOCKED.
3349 */
3350 if( (wrflag && pBt->inTransaction==TRANS_WRITE)
3351 || (pBt->btsFlags & BTS_PENDING)!=0
3352 ){
3353 pBlock = pBt->pWriter->db;
3354 }else if( wrflag>1 ){
3355 BtLock *pIter;
3356 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
3357 if( pIter->pBtree!=p ){
3358 pBlock = pIter->pBtree->db;
3359 break;
3360 }
danielk1977641b0f42007-12-21 04:47:25 +00003361 }
3362 }
drh5a1fb182016-01-08 19:34:39 +00003363 if( pBlock ){
3364 sqlite3ConnectionBlocked(p->db, pBlock);
3365 rc = SQLITE_LOCKED_SHAREDCACHE;
3366 goto trans_begun;
3367 }
danielk1977404ca072009-03-16 13:19:36 +00003368 }
danielk1977641b0f42007-12-21 04:47:25 +00003369#endif
3370
danielk1977602b4662009-07-02 07:47:33 +00003371 /* Any read-only or read-write transaction implies a read-lock on
3372 ** page 1. So if some other shared-cache client already has a write-lock
3373 ** on page 1, the transaction cannot be opened. */
drh4c301aa2009-07-15 17:25:45 +00003374 rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK);
3375 if( SQLITE_OK!=rc ) goto trans_begun;
danielk1977602b4662009-07-02 07:47:33 +00003376
drhc9166342012-01-05 23:32:06 +00003377 pBt->btsFlags &= ~BTS_INITIALLY_EMPTY;
3378 if( pBt->nPage==0 ) pBt->btsFlags |= BTS_INITIALLY_EMPTY;
drhb8ef32c2005-03-14 02:01:49 +00003379 do {
danielk1977295dc102009-04-01 19:07:03 +00003380 /* Call lockBtree() until either pBt->pPage1 is populated or
3381 ** lockBtree() returns something other than SQLITE_OK. lockBtree()
3382 ** may return SQLITE_OK but leave pBt->pPage1 set to 0 if after
3383 ** reading page 1 it discovers that the page-size of the database
3384 ** file is not pBt->pageSize. In this case lockBtree() will update
3385 ** pBt->pageSize to the page-size of the file on disk.
3386 */
3387 while( pBt->pPage1==0 && SQLITE_OK==(rc = lockBtree(pBt)) );
drh309169a2007-04-24 17:27:51 +00003388
drhb8ef32c2005-03-14 02:01:49 +00003389 if( rc==SQLITE_OK && wrflag ){
drhc9166342012-01-05 23:32:06 +00003390 if( (pBt->btsFlags & BTS_READ_ONLY)!=0 ){
drh309169a2007-04-24 17:27:51 +00003391 rc = SQLITE_READONLY;
3392 }else{
danielk1977d8293352009-04-30 09:10:37 +00003393 rc = sqlite3PagerBegin(pBt->pPager,wrflag>1,sqlite3TempInMemory(p->db));
drh309169a2007-04-24 17:27:51 +00003394 if( rc==SQLITE_OK ){
3395 rc = newDatabase(pBt);
dan8bf6d702018-07-05 17:16:55 +00003396 }else if( rc==SQLITE_BUSY_SNAPSHOT && pBt->inTransaction==TRANS_NONE ){
3397 /* if there was no transaction opened when this function was
3398 ** called and SQLITE_BUSY_SNAPSHOT is returned, change the error
3399 ** code to SQLITE_BUSY. */
3400 rc = SQLITE_BUSY;
drh309169a2007-04-24 17:27:51 +00003401 }
drhb8ef32c2005-03-14 02:01:49 +00003402 }
3403 }
3404
danielk1977bd434552009-03-18 10:33:00 +00003405 if( rc!=SQLITE_OK ){
drhb8ef32c2005-03-14 02:01:49 +00003406 unlockBtreeIfUnused(pBt);
3407 }
danf9b76712010-06-01 14:12:45 +00003408 }while( (rc&0xFF)==SQLITE_BUSY && pBt->inTransaction==TRANS_NONE &&
danielk19771ceedd32008-11-19 10:22:33 +00003409 btreeInvokeBusyHandler(pBt) );
drhfd725632018-03-26 20:43:05 +00003410 sqlite3PagerResetLockTimeout(pBt->pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00003411
3412 if( rc==SQLITE_OK ){
3413 if( p->inTrans==TRANS_NONE ){
3414 pBt->nTransaction++;
danielk1977602b4662009-07-02 07:47:33 +00003415#ifndef SQLITE_OMIT_SHARED_CACHE
3416 if( p->sharable ){
drhf2f105d2012-08-20 15:53:54 +00003417 assert( p->lock.pBtree==p && p->lock.iTable==1 );
danielk1977602b4662009-07-02 07:47:33 +00003418 p->lock.eLock = READ_LOCK;
3419 p->lock.pNext = pBt->pLock;
3420 pBt->pLock = &p->lock;
3421 }
3422#endif
danielk1977aef0bf62005-12-30 16:28:01 +00003423 }
3424 p->inTrans = (wrflag?TRANS_WRITE:TRANS_READ);
3425 if( p->inTrans>pBt->inTransaction ){
3426 pBt->inTransaction = p->inTrans;
3427 }
danielk1977404ca072009-03-16 13:19:36 +00003428 if( wrflag ){
dan59257dc2010-08-04 11:34:31 +00003429 MemPage *pPage1 = pBt->pPage1;
3430#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977404ca072009-03-16 13:19:36 +00003431 assert( !pBt->pWriter );
3432 pBt->pWriter = p;
drhc9166342012-01-05 23:32:06 +00003433 pBt->btsFlags &= ~BTS_EXCLUSIVE;
3434 if( wrflag>1 ) pBt->btsFlags |= BTS_EXCLUSIVE;
danielk1977641b0f42007-12-21 04:47:25 +00003435#endif
dan59257dc2010-08-04 11:34:31 +00003436
3437 /* If the db-size header field is incorrect (as it may be if an old
3438 ** client has been writing the database file), update it now. Doing
3439 ** this sooner rather than later means the database size can safely
3440 ** re-read the database size from page 1 if a savepoint or transaction
3441 ** rollback occurs within the transaction.
3442 */
3443 if( pBt->nPage!=get4byte(&pPage1->aData[28]) ){
3444 rc = sqlite3PagerWrite(pPage1->pDbPage);
3445 if( rc==SQLITE_OK ){
3446 put4byte(&pPage1->aData[28], pBt->nPage);
3447 }
3448 }
3449 }
danielk1977aef0bf62005-12-30 16:28:01 +00003450 }
3451
drhd677b3d2007-08-20 22:48:41 +00003452trans_begun:
drhbb2d9b12018-06-06 16:28:40 +00003453 if( rc==SQLITE_OK ){
3454 if( pSchemaVersion ){
3455 *pSchemaVersion = get4byte(&pBt->pPage1->aData[40]);
3456 }
3457 if( wrflag ){
3458 /* This call makes sure that the pager has the correct number of
3459 ** open savepoints. If the second parameter is greater than 0 and
3460 ** the sub-journal is not already open, then it will be opened here.
3461 */
3462 rc = sqlite3PagerOpenSavepoint(pBt->pPager, p->db->nSavepoint);
3463 }
danielk1977fd7f0452008-12-17 17:30:26 +00003464 }
danielk197712dd5492008-12-18 15:45:07 +00003465
danielk1977aef0bf62005-12-30 16:28:01 +00003466 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00003467 sqlite3BtreeLeave(p);
drhb8ca3072001-12-05 00:21:20 +00003468 return rc;
drha059ad02001-04-17 20:09:11 +00003469}
3470
danielk1977687566d2004-11-02 12:56:41 +00003471#ifndef SQLITE_OMIT_AUTOVACUUM
3472
3473/*
3474** Set the pointer-map entries for all children of page pPage. Also, if
3475** pPage contains cells that point to overflow pages, set the pointer
3476** map entries for the overflow pages as well.
3477*/
3478static int setChildPtrmaps(MemPage *pPage){
3479 int i; /* Counter variable */
3480 int nCell; /* Number of cells in page pPage */
danielk19772df71c72007-05-24 07:22:42 +00003481 int rc; /* Return code */
danielk1977aef0bf62005-12-30 16:28:01 +00003482 BtShared *pBt = pPage->pBt;
danielk1977687566d2004-11-02 12:56:41 +00003483 Pgno pgno = pPage->pgno;
3484
drh1fee73e2007-08-29 04:00:57 +00003485 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh14e845a2017-05-25 21:35:56 +00003486 rc = pPage->isInit ? SQLITE_OK : btreeInitPage(pPage);
drh2a702542016-12-12 18:12:03 +00003487 if( rc!=SQLITE_OK ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00003488 nCell = pPage->nCell;
3489
3490 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00003491 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00003492
drh98add2e2009-07-20 17:11:49 +00003493 ptrmapPutOvflPtr(pPage, pCell, &rc);
danielk197726836652005-01-17 01:33:13 +00003494
danielk1977687566d2004-11-02 12:56:41 +00003495 if( !pPage->leaf ){
3496 Pgno childPgno = get4byte(pCell);
drh98add2e2009-07-20 17:11:49 +00003497 ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
danielk1977687566d2004-11-02 12:56:41 +00003498 }
3499 }
3500
3501 if( !pPage->leaf ){
3502 Pgno childPgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh98add2e2009-07-20 17:11:49 +00003503 ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
danielk1977687566d2004-11-02 12:56:41 +00003504 }
3505
danielk1977687566d2004-11-02 12:56:41 +00003506 return rc;
3507}
3508
3509/*
drhf3aed592009-07-08 18:12:49 +00003510** Somewhere on pPage is a pointer to page iFrom. Modify this pointer so
3511** that it points to iTo. Parameter eType describes the type of pointer to
3512** be modified, as follows:
danielk1977687566d2004-11-02 12:56:41 +00003513**
3514** PTRMAP_BTREE: pPage is a btree-page. The pointer points at a child
3515** page of pPage.
3516**
3517** PTRMAP_OVERFLOW1: pPage is a btree-page. The pointer points at an overflow
3518** page pointed to by one of the cells on pPage.
3519**
3520** PTRMAP_OVERFLOW2: pPage is an overflow-page. The pointer points at the next
3521** overflow page in the list.
3522*/
danielk1977fdb7cdb2005-01-17 02:12:18 +00003523static int modifyPagePointer(MemPage *pPage, Pgno iFrom, Pgno iTo, u8 eType){
drh1fee73e2007-08-29 04:00:57 +00003524 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhc5053fb2008-11-27 02:22:10 +00003525 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
danielk1977687566d2004-11-02 12:56:41 +00003526 if( eType==PTRMAP_OVERFLOW2 ){
danielk1977f78fc082004-11-02 14:40:32 +00003527 /* The pointer is always the first 4 bytes of the page in this case. */
danielk1977fdb7cdb2005-01-17 02:12:18 +00003528 if( get4byte(pPage->aData)!=iFrom ){
daneebf2f52017-11-18 17:30:08 +00003529 return SQLITE_CORRUPT_PAGE(pPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00003530 }
danielk1977f78fc082004-11-02 14:40:32 +00003531 put4byte(pPage->aData, iTo);
danielk1977687566d2004-11-02 12:56:41 +00003532 }else{
danielk1977687566d2004-11-02 12:56:41 +00003533 int i;
3534 int nCell;
drha1f75d92015-05-24 10:18:12 +00003535 int rc;
danielk1977687566d2004-11-02 12:56:41 +00003536
drh14e845a2017-05-25 21:35:56 +00003537 rc = pPage->isInit ? SQLITE_OK : btreeInitPage(pPage);
drha1f75d92015-05-24 10:18:12 +00003538 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00003539 nCell = pPage->nCell;
3540
danielk1977687566d2004-11-02 12:56:41 +00003541 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00003542 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00003543 if( eType==PTRMAP_OVERFLOW1 ){
3544 CellInfo info;
drh5fa60512015-06-19 17:19:34 +00003545 pPage->xParseCell(pPage, pCell, &info);
drhb701c9a2017-01-12 15:11:03 +00003546 if( info.nLocal<info.nPayload ){
3547 if( pCell+info.nSize > pPage->aData+pPage->pBt->usableSize ){
daneebf2f52017-11-18 17:30:08 +00003548 return SQLITE_CORRUPT_PAGE(pPage);
drhb701c9a2017-01-12 15:11:03 +00003549 }
3550 if( iFrom==get4byte(pCell+info.nSize-4) ){
3551 put4byte(pCell+info.nSize-4, iTo);
3552 break;
3553 }
danielk1977687566d2004-11-02 12:56:41 +00003554 }
3555 }else{
3556 if( get4byte(pCell)==iFrom ){
3557 put4byte(pCell, iTo);
3558 break;
3559 }
3560 }
3561 }
3562
3563 if( i==nCell ){
danielk1977fdb7cdb2005-01-17 02:12:18 +00003564 if( eType!=PTRMAP_BTREE ||
3565 get4byte(&pPage->aData[pPage->hdrOffset+8])!=iFrom ){
daneebf2f52017-11-18 17:30:08 +00003566 return SQLITE_CORRUPT_PAGE(pPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00003567 }
danielk1977687566d2004-11-02 12:56:41 +00003568 put4byte(&pPage->aData[pPage->hdrOffset+8], iTo);
3569 }
danielk1977687566d2004-11-02 12:56:41 +00003570 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00003571 return SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00003572}
3573
danielk1977003ba062004-11-04 02:57:33 +00003574
danielk19777701e812005-01-10 12:59:51 +00003575/*
3576** Move the open database page pDbPage to location iFreePage in the
3577** database. The pDbPage reference remains valid.
drhe64ca7b2009-07-16 18:21:17 +00003578**
3579** The isCommit flag indicates that there is no need to remember that
3580** the journal needs to be sync()ed before database page pDbPage->pgno
3581** can be written to. The caller has already promised not to write to that
3582** page.
danielk19777701e812005-01-10 12:59:51 +00003583*/
danielk1977003ba062004-11-04 02:57:33 +00003584static int relocatePage(
danielk1977aef0bf62005-12-30 16:28:01 +00003585 BtShared *pBt, /* Btree */
danielk19777701e812005-01-10 12:59:51 +00003586 MemPage *pDbPage, /* Open page to move */
3587 u8 eType, /* Pointer map 'type' entry for pDbPage */
3588 Pgno iPtrPage, /* Pointer map 'page-no' entry for pDbPage */
danielk19774c999992008-07-16 18:17:55 +00003589 Pgno iFreePage, /* The location to move pDbPage to */
drhe64ca7b2009-07-16 18:21:17 +00003590 int isCommit /* isCommit flag passed to sqlite3PagerMovepage */
danielk1977003ba062004-11-04 02:57:33 +00003591){
3592 MemPage *pPtrPage; /* The page that contains a pointer to pDbPage */
3593 Pgno iDbPage = pDbPage->pgno;
3594 Pager *pPager = pBt->pPager;
3595 int rc;
3596
danielk1977a0bf2652004-11-04 14:30:04 +00003597 assert( eType==PTRMAP_OVERFLOW2 || eType==PTRMAP_OVERFLOW1 ||
3598 eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE );
drh1fee73e2007-08-29 04:00:57 +00003599 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +00003600 assert( pDbPage->pBt==pBt );
drh49272bc2018-10-31 01:04:18 +00003601 if( iDbPage<3 ) return SQLITE_CORRUPT_BKPT;
danielk1977003ba062004-11-04 02:57:33 +00003602
drh85b623f2007-12-13 21:54:09 +00003603 /* Move page iDbPage from its current location to page number iFreePage */
danielk1977003ba062004-11-04 02:57:33 +00003604 TRACE(("AUTOVACUUM: Moving %d to free page %d (ptr page %d type %d)\n",
3605 iDbPage, iFreePage, iPtrPage, eType));
danielk19774c999992008-07-16 18:17:55 +00003606 rc = sqlite3PagerMovepage(pPager, pDbPage->pDbPage, iFreePage, isCommit);
danielk1977003ba062004-11-04 02:57:33 +00003607 if( rc!=SQLITE_OK ){
3608 return rc;
3609 }
3610 pDbPage->pgno = iFreePage;
3611
3612 /* If pDbPage was a btree-page, then it may have child pages and/or cells
3613 ** that point to overflow pages. The pointer map entries for all these
3614 ** pages need to be changed.
3615 **
3616 ** If pDbPage is an overflow page, then the first 4 bytes may store a
3617 ** pointer to a subsequent overflow page. If this is the case, then
3618 ** the pointer map needs to be updated for the subsequent overflow page.
3619 */
danielk1977a0bf2652004-11-04 14:30:04 +00003620 if( eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00003621 rc = setChildPtrmaps(pDbPage);
3622 if( rc!=SQLITE_OK ){
3623 return rc;
3624 }
3625 }else{
3626 Pgno nextOvfl = get4byte(pDbPage->aData);
3627 if( nextOvfl!=0 ){
drh98add2e2009-07-20 17:11:49 +00003628 ptrmapPut(pBt, nextOvfl, PTRMAP_OVERFLOW2, iFreePage, &rc);
danielk1977003ba062004-11-04 02:57:33 +00003629 if( rc!=SQLITE_OK ){
3630 return rc;
3631 }
3632 }
3633 }
3634
3635 /* Fix the database pointer on page iPtrPage that pointed at iDbPage so
3636 ** that it points at iFreePage. Also fix the pointer map entry for
3637 ** iPtrPage.
3638 */
danielk1977a0bf2652004-11-04 14:30:04 +00003639 if( eType!=PTRMAP_ROOTPAGE ){
drhb00fc3b2013-08-21 23:42:32 +00003640 rc = btreeGetPage(pBt, iPtrPage, &pPtrPage, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003641 if( rc!=SQLITE_OK ){
3642 return rc;
3643 }
danielk19773b8a05f2007-03-19 17:44:26 +00003644 rc = sqlite3PagerWrite(pPtrPage->pDbPage);
danielk1977a0bf2652004-11-04 14:30:04 +00003645 if( rc!=SQLITE_OK ){
3646 releasePage(pPtrPage);
3647 return rc;
3648 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00003649 rc = modifyPagePointer(pPtrPage, iDbPage, iFreePage, eType);
danielk1977003ba062004-11-04 02:57:33 +00003650 releasePage(pPtrPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00003651 if( rc==SQLITE_OK ){
drh98add2e2009-07-20 17:11:49 +00003652 ptrmapPut(pBt, iFreePage, eType, iPtrPage, &rc);
danielk1977fdb7cdb2005-01-17 02:12:18 +00003653 }
danielk1977003ba062004-11-04 02:57:33 +00003654 }
danielk1977003ba062004-11-04 02:57:33 +00003655 return rc;
3656}
3657
danielk1977dddbcdc2007-04-26 14:42:34 +00003658/* Forward declaration required by incrVacuumStep(). */
drh4f0c5872007-03-26 22:05:01 +00003659static int allocateBtreePage(BtShared *, MemPage **, Pgno *, Pgno, u8);
danielk1977687566d2004-11-02 12:56:41 +00003660
3661/*
dan51f0b6d2013-02-22 20:16:34 +00003662** Perform a single step of an incremental-vacuum. If successful, return
3663** SQLITE_OK. If there is no work to do (and therefore no point in
3664** calling this function again), return SQLITE_DONE. Or, if an error
3665** occurs, return some other error code.
danielk1977dddbcdc2007-04-26 14:42:34 +00003666**
peter.d.reid60ec9142014-09-06 16:39:46 +00003667** More specifically, this function attempts to re-organize the database so
dan51f0b6d2013-02-22 20:16:34 +00003668** that the last page of the file currently in use is no longer in use.
danielk1977dddbcdc2007-04-26 14:42:34 +00003669**
dan51f0b6d2013-02-22 20:16:34 +00003670** Parameter nFin is the number of pages that this database would contain
3671** were this function called until it returns SQLITE_DONE.
3672**
3673** If the bCommit parameter is non-zero, this function assumes that the
3674** caller will keep calling incrVacuumStep() until it returns SQLITE_DONE
peter.d.reid60ec9142014-09-06 16:39:46 +00003675** or an error. bCommit is passed true for an auto-vacuum-on-commit
dan51f0b6d2013-02-22 20:16:34 +00003676** operation, or false for an incremental vacuum.
danielk1977dddbcdc2007-04-26 14:42:34 +00003677*/
dan51f0b6d2013-02-22 20:16:34 +00003678static int incrVacuumStep(BtShared *pBt, Pgno nFin, Pgno iLastPg, int bCommit){
danielk1977dddbcdc2007-04-26 14:42:34 +00003679 Pgno nFreeList; /* Number of pages still on the free-list */
drhdd3cd972010-03-27 17:12:36 +00003680 int rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00003681
drh1fee73e2007-08-29 04:00:57 +00003682 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977fa542f12009-04-02 18:28:08 +00003683 assert( iLastPg>nFin );
danielk1977dddbcdc2007-04-26 14:42:34 +00003684
3685 if( !PTRMAP_ISPAGE(pBt, iLastPg) && iLastPg!=PENDING_BYTE_PAGE(pBt) ){
danielk1977dddbcdc2007-04-26 14:42:34 +00003686 u8 eType;
3687 Pgno iPtrPage;
3688
3689 nFreeList = get4byte(&pBt->pPage1->aData[36]);
danielk1977fa542f12009-04-02 18:28:08 +00003690 if( nFreeList==0 ){
danielk1977dddbcdc2007-04-26 14:42:34 +00003691 return SQLITE_DONE;
3692 }
3693
3694 rc = ptrmapGet(pBt, iLastPg, &eType, &iPtrPage);
3695 if( rc!=SQLITE_OK ){
3696 return rc;
3697 }
3698 if( eType==PTRMAP_ROOTPAGE ){
3699 return SQLITE_CORRUPT_BKPT;
3700 }
3701
3702 if( eType==PTRMAP_FREEPAGE ){
dan51f0b6d2013-02-22 20:16:34 +00003703 if( bCommit==0 ){
danielk1977dddbcdc2007-04-26 14:42:34 +00003704 /* Remove the page from the files free-list. This is not required
dan51f0b6d2013-02-22 20:16:34 +00003705 ** if bCommit is non-zero. In that case, the free-list will be
danielk1977dddbcdc2007-04-26 14:42:34 +00003706 ** truncated to zero after this function returns, so it doesn't
3707 ** matter if it still contains some garbage entries.
3708 */
3709 Pgno iFreePg;
3710 MemPage *pFreePg;
dan51f0b6d2013-02-22 20:16:34 +00003711 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iLastPg, BTALLOC_EXACT);
danielk1977dddbcdc2007-04-26 14:42:34 +00003712 if( rc!=SQLITE_OK ){
3713 return rc;
3714 }
3715 assert( iFreePg==iLastPg );
3716 releasePage(pFreePg);
3717 }
3718 } else {
3719 Pgno iFreePg; /* Index of free page to move pLastPg to */
3720 MemPage *pLastPg;
dan51f0b6d2013-02-22 20:16:34 +00003721 u8 eMode = BTALLOC_ANY; /* Mode parameter for allocateBtreePage() */
3722 Pgno iNear = 0; /* nearby parameter for allocateBtreePage() */
danielk1977dddbcdc2007-04-26 14:42:34 +00003723
drhb00fc3b2013-08-21 23:42:32 +00003724 rc = btreeGetPage(pBt, iLastPg, &pLastPg, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00003725 if( rc!=SQLITE_OK ){
3726 return rc;
3727 }
3728
dan51f0b6d2013-02-22 20:16:34 +00003729 /* If bCommit is zero, this loop runs exactly once and page pLastPg
danielk1977b4626a32007-04-28 15:47:43 +00003730 ** is swapped with the first free page pulled off the free list.
3731 **
dan51f0b6d2013-02-22 20:16:34 +00003732 ** On the other hand, if bCommit is greater than zero, then keep
danielk1977b4626a32007-04-28 15:47:43 +00003733 ** looping until a free-page located within the first nFin pages
3734 ** of the file is found.
3735 */
dan51f0b6d2013-02-22 20:16:34 +00003736 if( bCommit==0 ){
3737 eMode = BTALLOC_LE;
3738 iNear = nFin;
3739 }
danielk1977dddbcdc2007-04-26 14:42:34 +00003740 do {
3741 MemPage *pFreePg;
dan51f0b6d2013-02-22 20:16:34 +00003742 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iNear, eMode);
danielk1977dddbcdc2007-04-26 14:42:34 +00003743 if( rc!=SQLITE_OK ){
3744 releasePage(pLastPg);
3745 return rc;
3746 }
3747 releasePage(pFreePg);
dan51f0b6d2013-02-22 20:16:34 +00003748 }while( bCommit && iFreePg>nFin );
danielk1977dddbcdc2007-04-26 14:42:34 +00003749 assert( iFreePg<iLastPg );
danielk1977b4626a32007-04-28 15:47:43 +00003750
dane1df4e32013-03-05 11:27:04 +00003751 rc = relocatePage(pBt, pLastPg, eType, iPtrPage, iFreePg, bCommit);
danielk1977dddbcdc2007-04-26 14:42:34 +00003752 releasePage(pLastPg);
3753 if( rc!=SQLITE_OK ){
3754 return rc;
danielk1977662278e2007-11-05 15:30:12 +00003755 }
danielk1977dddbcdc2007-04-26 14:42:34 +00003756 }
3757 }
3758
dan51f0b6d2013-02-22 20:16:34 +00003759 if( bCommit==0 ){
danbc1a3c62013-02-23 16:40:46 +00003760 do {
danielk19773460d192008-12-27 15:23:13 +00003761 iLastPg--;
danbc1a3c62013-02-23 16:40:46 +00003762 }while( iLastPg==PENDING_BYTE_PAGE(pBt) || PTRMAP_ISPAGE(pBt, iLastPg) );
3763 pBt->bDoTruncate = 1;
drhdd3cd972010-03-27 17:12:36 +00003764 pBt->nPage = iLastPg;
danielk1977dddbcdc2007-04-26 14:42:34 +00003765 }
3766 return SQLITE_OK;
3767}
3768
3769/*
dan51f0b6d2013-02-22 20:16:34 +00003770** The database opened by the first argument is an auto-vacuum database
3771** nOrig pages in size containing nFree free pages. Return the expected
3772** size of the database in pages following an auto-vacuum operation.
3773*/
3774static Pgno finalDbSize(BtShared *pBt, Pgno nOrig, Pgno nFree){
3775 int nEntry; /* Number of entries on one ptrmap page */
3776 Pgno nPtrmap; /* Number of PtrMap pages to be freed */
3777 Pgno nFin; /* Return value */
3778
3779 nEntry = pBt->usableSize/5;
3780 nPtrmap = (nFree-nOrig+PTRMAP_PAGENO(pBt, nOrig)+nEntry)/nEntry;
3781 nFin = nOrig - nFree - nPtrmap;
3782 if( nOrig>PENDING_BYTE_PAGE(pBt) && nFin<PENDING_BYTE_PAGE(pBt) ){
3783 nFin--;
3784 }
3785 while( PTRMAP_ISPAGE(pBt, nFin) || nFin==PENDING_BYTE_PAGE(pBt) ){
3786 nFin--;
3787 }
dan51f0b6d2013-02-22 20:16:34 +00003788
3789 return nFin;
3790}
3791
3792/*
danielk1977dddbcdc2007-04-26 14:42:34 +00003793** A write-transaction must be opened before calling this function.
3794** It performs a single unit of work towards an incremental vacuum.
3795**
3796** If the incremental vacuum is finished after this function has run,
shanebe217792009-03-05 04:20:31 +00003797** SQLITE_DONE is returned. If it is not finished, but no error occurred,
danielk1977dddbcdc2007-04-26 14:42:34 +00003798** SQLITE_OK is returned. Otherwise an SQLite error code.
3799*/
3800int sqlite3BtreeIncrVacuum(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00003801 int rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00003802 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00003803
3804 sqlite3BtreeEnter(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00003805 assert( pBt->inTransaction==TRANS_WRITE && p->inTrans==TRANS_WRITE );
3806 if( !pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00003807 rc = SQLITE_DONE;
3808 }else{
dan51f0b6d2013-02-22 20:16:34 +00003809 Pgno nOrig = btreePagecount(pBt);
3810 Pgno nFree = get4byte(&pBt->pPage1->aData[36]);
3811 Pgno nFin = finalDbSize(pBt, nOrig, nFree);
3812
dan91384712013-02-24 11:50:43 +00003813 if( nOrig<nFin ){
3814 rc = SQLITE_CORRUPT_BKPT;
3815 }else if( nFree>0 ){
dan11dcd112013-03-15 18:29:18 +00003816 rc = saveAllCursors(pBt, 0, 0);
3817 if( rc==SQLITE_OK ){
3818 invalidateAllOverflowCache(pBt);
3819 rc = incrVacuumStep(pBt, nFin, nOrig, 0);
3820 }
dan51f0b6d2013-02-22 20:16:34 +00003821 if( rc==SQLITE_OK ){
3822 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
3823 put4byte(&pBt->pPage1->aData[28], pBt->nPage);
3824 }
3825 }else{
3826 rc = SQLITE_DONE;
drhdd3cd972010-03-27 17:12:36 +00003827 }
danielk1977dddbcdc2007-04-26 14:42:34 +00003828 }
drhd677b3d2007-08-20 22:48:41 +00003829 sqlite3BtreeLeave(p);
3830 return rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00003831}
3832
3833/*
danielk19773b8a05f2007-03-19 17:44:26 +00003834** This routine is called prior to sqlite3PagerCommit when a transaction
drhf7b54962013-05-28 12:11:54 +00003835** is committed for an auto-vacuum database.
danielk197724168722007-04-02 05:07:47 +00003836**
3837** If SQLITE_OK is returned, then *pnTrunc is set to the number of pages
3838** the database file should be truncated to during the commit process.
3839** i.e. the database has been reorganized so that only the first *pnTrunc
3840** pages are in use.
danielk1977687566d2004-11-02 12:56:41 +00003841*/
danielk19773460d192008-12-27 15:23:13 +00003842static int autoVacuumCommit(BtShared *pBt){
danielk1977dddbcdc2007-04-26 14:42:34 +00003843 int rc = SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00003844 Pager *pPager = pBt->pPager;
mistachkinc29cbb02015-07-02 16:52:01 +00003845 VVA_ONLY( int nRef = sqlite3PagerRefcount(pPager); )
danielk1977687566d2004-11-02 12:56:41 +00003846
drh1fee73e2007-08-29 04:00:57 +00003847 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +00003848 invalidateAllOverflowCache(pBt);
danielk1977dddbcdc2007-04-26 14:42:34 +00003849 assert(pBt->autoVacuum);
3850 if( !pBt->incrVacuum ){
drhea8ffdf2009-07-22 00:35:23 +00003851 Pgno nFin; /* Number of pages in database after autovacuuming */
3852 Pgno nFree; /* Number of pages on the freelist initially */
drh41d628c2009-07-11 17:04:08 +00003853 Pgno iFree; /* The next page to be freed */
drh41d628c2009-07-11 17:04:08 +00003854 Pgno nOrig; /* Database size before freeing */
danielk1977687566d2004-11-02 12:56:41 +00003855
drhb1299152010-03-30 22:58:33 +00003856 nOrig = btreePagecount(pBt);
danielk1977ef165ce2009-04-06 17:50:03 +00003857 if( PTRMAP_ISPAGE(pBt, nOrig) || nOrig==PENDING_BYTE_PAGE(pBt) ){
3858 /* It is not possible to create a database for which the final page
3859 ** is either a pointer-map page or the pending-byte page. If one
3860 ** is encountered, this indicates corruption.
3861 */
danielk19773460d192008-12-27 15:23:13 +00003862 return SQLITE_CORRUPT_BKPT;
3863 }
danielk1977ef165ce2009-04-06 17:50:03 +00003864
danielk19773460d192008-12-27 15:23:13 +00003865 nFree = get4byte(&pBt->pPage1->aData[36]);
dan51f0b6d2013-02-22 20:16:34 +00003866 nFin = finalDbSize(pBt, nOrig, nFree);
drhc5e47ac2009-06-04 00:11:56 +00003867 if( nFin>nOrig ) return SQLITE_CORRUPT_BKPT;
dan0aed84d2013-03-26 14:16:20 +00003868 if( nFin<nOrig ){
3869 rc = saveAllCursors(pBt, 0, 0);
3870 }
danielk19773460d192008-12-27 15:23:13 +00003871 for(iFree=nOrig; iFree>nFin && rc==SQLITE_OK; iFree--){
dan51f0b6d2013-02-22 20:16:34 +00003872 rc = incrVacuumStep(pBt, nFin, iFree, 1);
danielk1977dddbcdc2007-04-26 14:42:34 +00003873 }
danielk19773460d192008-12-27 15:23:13 +00003874 if( (rc==SQLITE_DONE || rc==SQLITE_OK) && nFree>0 ){
danielk19773460d192008-12-27 15:23:13 +00003875 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
3876 put4byte(&pBt->pPage1->aData[32], 0);
3877 put4byte(&pBt->pPage1->aData[36], 0);
drhdd3cd972010-03-27 17:12:36 +00003878 put4byte(&pBt->pPage1->aData[28], nFin);
danbc1a3c62013-02-23 16:40:46 +00003879 pBt->bDoTruncate = 1;
drhdd3cd972010-03-27 17:12:36 +00003880 pBt->nPage = nFin;
danielk1977dddbcdc2007-04-26 14:42:34 +00003881 }
3882 if( rc!=SQLITE_OK ){
3883 sqlite3PagerRollback(pPager);
3884 }
danielk1977687566d2004-11-02 12:56:41 +00003885 }
3886
dan0aed84d2013-03-26 14:16:20 +00003887 assert( nRef>=sqlite3PagerRefcount(pPager) );
danielk1977687566d2004-11-02 12:56:41 +00003888 return rc;
3889}
danielk1977dddbcdc2007-04-26 14:42:34 +00003890
danielk1977a50d9aa2009-06-08 14:49:45 +00003891#else /* ifndef SQLITE_OMIT_AUTOVACUUM */
3892# define setChildPtrmaps(x) SQLITE_OK
3893#endif
danielk1977687566d2004-11-02 12:56:41 +00003894
3895/*
drh80e35f42007-03-30 14:06:34 +00003896** This routine does the first phase of a two-phase commit. This routine
3897** causes a rollback journal to be created (if it does not already exist)
3898** and populated with enough information so that if a power loss occurs
3899** the database can be restored to its original state by playing back
3900** the journal. Then the contents of the journal are flushed out to
3901** the disk. After the journal is safely on oxide, the changes to the
3902** database are written into the database file and flushed to oxide.
3903** At the end of this call, the rollback journal still exists on the
3904** disk and we are still holding all locks, so the transaction has not
drh51898cf2009-04-19 20:51:06 +00003905** committed. See sqlite3BtreeCommitPhaseTwo() for the second phase of the
drh80e35f42007-03-30 14:06:34 +00003906** commit process.
3907**
3908** This call is a no-op if no write-transaction is currently active on pBt.
3909**
3910** Otherwise, sync the database file for the btree pBt. zMaster points to
3911** the name of a master journal file that should be written into the
3912** individual journal file, or is NULL, indicating no master journal file
3913** (single database transaction).
3914**
3915** When this is called, the master journal should already have been
3916** created, populated with this journal pointer and synced to disk.
3917**
3918** Once this is routine has returned, the only thing required to commit
3919** the write-transaction for this database file is to delete the journal.
3920*/
3921int sqlite3BtreeCommitPhaseOne(Btree *p, const char *zMaster){
3922 int rc = SQLITE_OK;
3923 if( p->inTrans==TRANS_WRITE ){
3924 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00003925 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00003926#ifndef SQLITE_OMIT_AUTOVACUUM
3927 if( pBt->autoVacuum ){
danielk19773460d192008-12-27 15:23:13 +00003928 rc = autoVacuumCommit(pBt);
drh80e35f42007-03-30 14:06:34 +00003929 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00003930 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00003931 return rc;
3932 }
3933 }
danbc1a3c62013-02-23 16:40:46 +00003934 if( pBt->bDoTruncate ){
3935 sqlite3PagerTruncateImage(pBt->pPager, pBt->nPage);
3936 }
drh80e35f42007-03-30 14:06:34 +00003937#endif
drh49b9d332009-01-02 18:10:42 +00003938 rc = sqlite3PagerCommitPhaseOne(pBt->pPager, zMaster, 0);
drhd677b3d2007-08-20 22:48:41 +00003939 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00003940 }
3941 return rc;
3942}
3943
3944/*
danielk197794b30732009-07-02 17:21:57 +00003945** This function is called from both BtreeCommitPhaseTwo() and BtreeRollback()
3946** at the conclusion of a transaction.
3947*/
3948static void btreeEndTransaction(Btree *p){
3949 BtShared *pBt = p->pBt;
drh1713afb2013-06-28 01:24:57 +00003950 sqlite3 *db = p->db;
danielk197794b30732009-07-02 17:21:57 +00003951 assert( sqlite3BtreeHoldsMutex(p) );
3952
danbc1a3c62013-02-23 16:40:46 +00003953#ifndef SQLITE_OMIT_AUTOVACUUM
3954 pBt->bDoTruncate = 0;
3955#endif
danc0537fe2013-06-28 19:41:43 +00003956 if( p->inTrans>TRANS_NONE && db->nVdbeRead>1 ){
danfa401de2009-10-16 14:55:03 +00003957 /* If there are other active statements that belong to this database
3958 ** handle, downgrade to a read-only transaction. The other statements
3959 ** may still be reading from the database. */
danielk197794b30732009-07-02 17:21:57 +00003960 downgradeAllSharedCacheTableLocks(p);
3961 p->inTrans = TRANS_READ;
3962 }else{
3963 /* If the handle had any kind of transaction open, decrement the
3964 ** transaction count of the shared btree. If the transaction count
3965 ** reaches 0, set the shared state to TRANS_NONE. The unlockBtreeIfUnused()
3966 ** call below will unlock the pager. */
3967 if( p->inTrans!=TRANS_NONE ){
3968 clearAllSharedCacheTableLocks(p);
3969 pBt->nTransaction--;
3970 if( 0==pBt->nTransaction ){
3971 pBt->inTransaction = TRANS_NONE;
3972 }
3973 }
3974
3975 /* Set the current transaction state to TRANS_NONE and unlock the
3976 ** pager if this call closed the only read or write transaction. */
3977 p->inTrans = TRANS_NONE;
3978 unlockBtreeIfUnused(pBt);
3979 }
3980
3981 btreeIntegrity(p);
3982}
3983
3984/*
drh2aa679f2001-06-25 02:11:07 +00003985** Commit the transaction currently in progress.
drh5e00f6c2001-09-13 13:46:56 +00003986**
drh6e345992007-03-30 11:12:08 +00003987** This routine implements the second phase of a 2-phase commit. The
drh51898cf2009-04-19 20:51:06 +00003988** sqlite3BtreeCommitPhaseOne() routine does the first phase and should
3989** be invoked prior to calling this routine. The sqlite3BtreeCommitPhaseOne()
3990** routine did all the work of writing information out to disk and flushing the
drh6e345992007-03-30 11:12:08 +00003991** contents so that they are written onto the disk platter. All this
drh51898cf2009-04-19 20:51:06 +00003992** routine has to do is delete or truncate or zero the header in the
3993** the rollback journal (which causes the transaction to commit) and
3994** drop locks.
drh6e345992007-03-30 11:12:08 +00003995**
dan60939d02011-03-29 15:40:55 +00003996** Normally, if an error occurs while the pager layer is attempting to
3997** finalize the underlying journal file, this function returns an error and
3998** the upper layer will attempt a rollback. However, if the second argument
3999** is non-zero then this b-tree transaction is part of a multi-file
4000** transaction. In this case, the transaction has already been committed
4001** (by deleting a master journal file) and the caller will ignore this
4002** functions return code. So, even if an error occurs in the pager layer,
4003** reset the b-tree objects internal state to indicate that the write
4004** transaction has been closed. This is quite safe, as the pager will have
4005** transitioned to the error state.
4006**
drh5e00f6c2001-09-13 13:46:56 +00004007** This will release the write lock on the database file. If there
4008** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00004009*/
dan60939d02011-03-29 15:40:55 +00004010int sqlite3BtreeCommitPhaseTwo(Btree *p, int bCleanup){
danielk1977aef0bf62005-12-30 16:28:01 +00004011
drh075ed302010-10-14 01:17:30 +00004012 if( p->inTrans==TRANS_NONE ) return SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00004013 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00004014 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00004015
4016 /* If the handle has a write-transaction open, commit the shared-btrees
4017 ** transaction and set the shared state to TRANS_READ.
4018 */
4019 if( p->inTrans==TRANS_WRITE ){
danielk19777f7bc662006-01-23 13:47:47 +00004020 int rc;
drh075ed302010-10-14 01:17:30 +00004021 BtShared *pBt = p->pBt;
danielk1977aef0bf62005-12-30 16:28:01 +00004022 assert( pBt->inTransaction==TRANS_WRITE );
4023 assert( pBt->nTransaction>0 );
drh80e35f42007-03-30 14:06:34 +00004024 rc = sqlite3PagerCommitPhaseTwo(pBt->pPager);
dan60939d02011-03-29 15:40:55 +00004025 if( rc!=SQLITE_OK && bCleanup==0 ){
drhd677b3d2007-08-20 22:48:41 +00004026 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00004027 return rc;
4028 }
drh3da9c042014-12-22 18:41:21 +00004029 p->iDataVersion--; /* Compensate for pPager->iDataVersion++; */
danielk1977aef0bf62005-12-30 16:28:01 +00004030 pBt->inTransaction = TRANS_READ;
danbf0e57a2013-05-14 20:36:31 +00004031 btreeClearHasContent(pBt);
danielk1977ee5741e2004-05-31 10:01:34 +00004032 }
danielk1977aef0bf62005-12-30 16:28:01 +00004033
danielk197794b30732009-07-02 17:21:57 +00004034 btreeEndTransaction(p);
drhd677b3d2007-08-20 22:48:41 +00004035 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00004036 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00004037}
4038
drh80e35f42007-03-30 14:06:34 +00004039/*
4040** Do both phases of a commit.
4041*/
4042int sqlite3BtreeCommit(Btree *p){
4043 int rc;
drhd677b3d2007-08-20 22:48:41 +00004044 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00004045 rc = sqlite3BtreeCommitPhaseOne(p, 0);
4046 if( rc==SQLITE_OK ){
dan60939d02011-03-29 15:40:55 +00004047 rc = sqlite3BtreeCommitPhaseTwo(p, 0);
drh80e35f42007-03-30 14:06:34 +00004048 }
drhd677b3d2007-08-20 22:48:41 +00004049 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00004050 return rc;
4051}
4052
drhc39e0002004-05-07 23:50:57 +00004053/*
drhfb982642007-08-30 01:19:59 +00004054** This routine sets the state to CURSOR_FAULT and the error
drh47b7fc72014-11-11 01:33:57 +00004055** code to errCode for every cursor on any BtShared that pBtree
4056** references. Or if the writeOnly flag is set to 1, then only
4057** trip write cursors and leave read cursors unchanged.
drhfb982642007-08-30 01:19:59 +00004058**
drh47b7fc72014-11-11 01:33:57 +00004059** Every cursor is a candidate to be tripped, including cursors
4060** that belong to other database connections that happen to be
4061** sharing the cache with pBtree.
drhfb982642007-08-30 01:19:59 +00004062**
dan80231042014-11-12 14:56:02 +00004063** This routine gets called when a rollback occurs. If the writeOnly
4064** flag is true, then only write-cursors need be tripped - read-only
4065** cursors save their current positions so that they may continue
4066** following the rollback. Or, if writeOnly is false, all cursors are
4067** tripped. In general, writeOnly is false if the transaction being
4068** rolled back modified the database schema. In this case b-tree root
4069** pages may be moved or deleted from the database altogether, making
4070** it unsafe for read cursors to continue.
4071**
4072** If the writeOnly flag is true and an error is encountered while
4073** saving the current position of a read-only cursor, all cursors,
4074** including all read-cursors are tripped.
4075**
4076** SQLITE_OK is returned if successful, or if an error occurs while
4077** saving a cursor position, an SQLite error code.
drhfb982642007-08-30 01:19:59 +00004078*/
dan80231042014-11-12 14:56:02 +00004079int sqlite3BtreeTripAllCursors(Btree *pBtree, int errCode, int writeOnly){
drhfb982642007-08-30 01:19:59 +00004080 BtCursor *p;
dan80231042014-11-12 14:56:02 +00004081 int rc = SQLITE_OK;
4082
drh47b7fc72014-11-11 01:33:57 +00004083 assert( (writeOnly==0 || writeOnly==1) && BTCF_WriteFlag==1 );
dan80231042014-11-12 14:56:02 +00004084 if( pBtree ){
4085 sqlite3BtreeEnter(pBtree);
4086 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
dan80231042014-11-12 14:56:02 +00004087 if( writeOnly && (p->curFlags & BTCF_WriteFlag)==0 ){
drhd2f83132015-03-25 17:35:01 +00004088 if( p->eState==CURSOR_VALID || p->eState==CURSOR_SKIPNEXT ){
drhbea3b972014-11-18 20:22:05 +00004089 rc = saveCursorPosition(p);
dan80231042014-11-12 14:56:02 +00004090 if( rc!=SQLITE_OK ){
4091 (void)sqlite3BtreeTripAllCursors(pBtree, rc, 0);
4092 break;
4093 }
4094 }
4095 }else{
4096 sqlite3BtreeClearCursor(p);
4097 p->eState = CURSOR_FAULT;
4098 p->skipNext = errCode;
4099 }
drh85ef6302017-08-02 15:50:09 +00004100 btreeReleaseAllCursorPages(p);
danielk1977bc2ca9e2008-11-13 14:28:28 +00004101 }
dan80231042014-11-12 14:56:02 +00004102 sqlite3BtreeLeave(pBtree);
drhfb982642007-08-30 01:19:59 +00004103 }
dan80231042014-11-12 14:56:02 +00004104 return rc;
drhfb982642007-08-30 01:19:59 +00004105}
4106
4107/*
drh47b7fc72014-11-11 01:33:57 +00004108** Rollback the transaction in progress.
4109**
4110** If tripCode is not SQLITE_OK then cursors will be invalidated (tripped).
4111** Only write cursors are tripped if writeOnly is true but all cursors are
4112** tripped if writeOnly is false. Any attempt to use
4113** a tripped cursor will result in an error.
drh5e00f6c2001-09-13 13:46:56 +00004114**
4115** This will release the write lock on the database file. If there
4116** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00004117*/
drh47b7fc72014-11-11 01:33:57 +00004118int sqlite3BtreeRollback(Btree *p, int tripCode, int writeOnly){
danielk19778d34dfd2006-01-24 16:37:57 +00004119 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00004120 BtShared *pBt = p->pBt;
drh24cd67e2004-05-10 16:18:47 +00004121 MemPage *pPage1;
danielk1977aef0bf62005-12-30 16:28:01 +00004122
drh47b7fc72014-11-11 01:33:57 +00004123 assert( writeOnly==1 || writeOnly==0 );
4124 assert( tripCode==SQLITE_ABORT_ROLLBACK || tripCode==SQLITE_OK );
drhd677b3d2007-08-20 22:48:41 +00004125 sqlite3BtreeEnter(p);
drh0f198a72012-02-13 16:43:16 +00004126 if( tripCode==SQLITE_OK ){
4127 rc = tripCode = saveAllCursors(pBt, 0, 0);
drh47b7fc72014-11-11 01:33:57 +00004128 if( rc ) writeOnly = 0;
drh0f198a72012-02-13 16:43:16 +00004129 }else{
4130 rc = SQLITE_OK;
danielk19772b8c13e2006-01-24 14:21:24 +00004131 }
drh0f198a72012-02-13 16:43:16 +00004132 if( tripCode ){
dan80231042014-11-12 14:56:02 +00004133 int rc2 = sqlite3BtreeTripAllCursors(p, tripCode, writeOnly);
4134 assert( rc==SQLITE_OK || (writeOnly==0 && rc2==SQLITE_OK) );
4135 if( rc2!=SQLITE_OK ) rc = rc2;
drh0f198a72012-02-13 16:43:16 +00004136 }
danielk1977aef0bf62005-12-30 16:28:01 +00004137 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00004138
4139 if( p->inTrans==TRANS_WRITE ){
danielk19778d34dfd2006-01-24 16:37:57 +00004140 int rc2;
danielk1977aef0bf62005-12-30 16:28:01 +00004141
danielk19778d34dfd2006-01-24 16:37:57 +00004142 assert( TRANS_WRITE==pBt->inTransaction );
danielk19773b8a05f2007-03-19 17:44:26 +00004143 rc2 = sqlite3PagerRollback(pBt->pPager);
danielk19778d34dfd2006-01-24 16:37:57 +00004144 if( rc2!=SQLITE_OK ){
4145 rc = rc2;
4146 }
4147
drh24cd67e2004-05-10 16:18:47 +00004148 /* The rollback may have destroyed the pPage1->aData value. So
danielk197730548662009-07-09 05:07:37 +00004149 ** call btreeGetPage() on page 1 again to make
drh16a9b832007-05-05 18:39:25 +00004150 ** sure pPage1->aData is set correctly. */
drhb00fc3b2013-08-21 23:42:32 +00004151 if( btreeGetPage(pBt, 1, &pPage1, 0)==SQLITE_OK ){
drh1f5b4672010-04-01 02:22:19 +00004152 int nPage = get4byte(28+(u8*)pPage1->aData);
4153 testcase( nPage==0 );
4154 if( nPage==0 ) sqlite3PagerPagecount(pBt->pPager, &nPage);
4155 testcase( pBt->nPage!=nPage );
4156 pBt->nPage = nPage;
drh3908fe92017-09-01 14:50:19 +00004157 releasePageOne(pPage1);
drh24cd67e2004-05-10 16:18:47 +00004158 }
drh85ec3b62013-05-14 23:12:06 +00004159 assert( countValidCursors(pBt, 1)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00004160 pBt->inTransaction = TRANS_READ;
danbf0e57a2013-05-14 20:36:31 +00004161 btreeClearHasContent(pBt);
drh24cd67e2004-05-10 16:18:47 +00004162 }
danielk1977aef0bf62005-12-30 16:28:01 +00004163
danielk197794b30732009-07-02 17:21:57 +00004164 btreeEndTransaction(p);
drhd677b3d2007-08-20 22:48:41 +00004165 sqlite3BtreeLeave(p);
drha059ad02001-04-17 20:09:11 +00004166 return rc;
4167}
4168
4169/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004170** Start a statement subtransaction. The subtransaction can be rolled
danielk1977bd434552009-03-18 10:33:00 +00004171** back independently of the main transaction. You must start a transaction
4172** before starting a subtransaction. The subtransaction is ended automatically
4173** if the main transaction commits or rolls back.
drhab01f612004-05-22 02:55:23 +00004174**
4175** Statement subtransactions are used around individual SQL statements
4176** that are contained within a BEGIN...COMMIT block. If a constraint
4177** error occurs within the statement, the effect of that one statement
4178** can be rolled back without having to rollback the entire transaction.
danielk1977bd434552009-03-18 10:33:00 +00004179**
4180** A statement sub-transaction is implemented as an anonymous savepoint. The
4181** value passed as the second parameter is the total number of savepoints,
4182** including the new anonymous savepoint, open on the B-Tree. i.e. if there
4183** are no active savepoints and no other statement-transactions open,
4184** iStatement is 1. This anonymous savepoint can be released or rolled back
4185** using the sqlite3BtreeSavepoint() function.
drh663fc632002-02-02 18:49:19 +00004186*/
danielk1977bd434552009-03-18 10:33:00 +00004187int sqlite3BtreeBeginStmt(Btree *p, int iStatement){
drh663fc632002-02-02 18:49:19 +00004188 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00004189 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00004190 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00004191 assert( p->inTrans==TRANS_WRITE );
drhc9166342012-01-05 23:32:06 +00004192 assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk1977bd434552009-03-18 10:33:00 +00004193 assert( iStatement>0 );
4194 assert( iStatement>p->db->nSavepoint );
drh5e0ccc22010-03-29 19:36:52 +00004195 assert( pBt->inTransaction==TRANS_WRITE );
4196 /* At the pager level, a statement transaction is a savepoint with
4197 ** an index greater than all savepoints created explicitly using
4198 ** SQL statements. It is illegal to open, release or rollback any
4199 ** such savepoints while the statement transaction savepoint is active.
4200 */
4201 rc = sqlite3PagerOpenSavepoint(pBt->pPager, iStatement);
drhd677b3d2007-08-20 22:48:41 +00004202 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00004203 return rc;
4204}
4205
4206/*
danielk1977fd7f0452008-12-17 17:30:26 +00004207** The second argument to this function, op, is always SAVEPOINT_ROLLBACK
4208** or SAVEPOINT_RELEASE. This function either releases or rolls back the
danielk197712dd5492008-12-18 15:45:07 +00004209** savepoint identified by parameter iSavepoint, depending on the value
4210** of op.
4211**
4212** Normally, iSavepoint is greater than or equal to zero. However, if op is
4213** SAVEPOINT_ROLLBACK, then iSavepoint may also be -1. In this case the
4214** contents of the entire transaction are rolled back. This is different
4215** from a normal transaction rollback, as no locks are released and the
4216** transaction remains open.
danielk1977fd7f0452008-12-17 17:30:26 +00004217*/
4218int sqlite3BtreeSavepoint(Btree *p, int op, int iSavepoint){
4219 int rc = SQLITE_OK;
4220 if( p && p->inTrans==TRANS_WRITE ){
4221 BtShared *pBt = p->pBt;
danielk1977fd7f0452008-12-17 17:30:26 +00004222 assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
4223 assert( iSavepoint>=0 || (iSavepoint==-1 && op==SAVEPOINT_ROLLBACK) );
4224 sqlite3BtreeEnter(p);
drh2343c7e2017-02-02 00:46:55 +00004225 if( op==SAVEPOINT_ROLLBACK ){
4226 rc = saveAllCursors(pBt, 0, 0);
4227 }
4228 if( rc==SQLITE_OK ){
4229 rc = sqlite3PagerSavepoint(pBt->pPager, op, iSavepoint);
4230 }
drh9f0bbf92009-01-02 21:08:09 +00004231 if( rc==SQLITE_OK ){
drhc9166342012-01-05 23:32:06 +00004232 if( iSavepoint<0 && (pBt->btsFlags & BTS_INITIALLY_EMPTY)!=0 ){
4233 pBt->nPage = 0;
4234 }
drh9f0bbf92009-01-02 21:08:09 +00004235 rc = newDatabase(pBt);
drhdd3cd972010-03-27 17:12:36 +00004236 pBt->nPage = get4byte(28 + pBt->pPage1->aData);
drhb9b49bf2010-08-05 03:21:39 +00004237
4238 /* The database size was written into the offset 28 of the header
4239 ** when the transaction started, so we know that the value at offset
4240 ** 28 is nonzero. */
4241 assert( pBt->nPage>0 );
drh9f0bbf92009-01-02 21:08:09 +00004242 }
danielk1977fd7f0452008-12-17 17:30:26 +00004243 sqlite3BtreeLeave(p);
4244 }
4245 return rc;
4246}
4247
4248/*
drh8b2f49b2001-06-08 00:21:52 +00004249** Create a new cursor for the BTree whose root is on the page
danielk19773e8add92009-07-04 17:16:00 +00004250** iTable. If a read-only cursor is requested, it is assumed that
4251** the caller already has at least a read-only transaction open
4252** on the database already. If a write-cursor is requested, then
4253** the caller is assumed to have an open write transaction.
drh1bee3d72001-10-15 00:44:35 +00004254**
drhe807bdb2016-01-21 17:06:33 +00004255** If the BTREE_WRCSR bit of wrFlag is clear, then the cursor can only
4256** be used for reading. If the BTREE_WRCSR bit is set, then the cursor
4257** can be used for reading or for writing if other conditions for writing
4258** are also met. These are the conditions that must be met in order
4259** for writing to be allowed:
drh6446c4d2001-12-15 14:22:18 +00004260**
drhe807bdb2016-01-21 17:06:33 +00004261** 1: The cursor must have been opened with wrFlag containing BTREE_WRCSR
drhf74b8d92002-09-01 23:20:45 +00004262**
drhfe5d71d2007-03-19 11:54:10 +00004263** 2: Other database connections that share the same pager cache
4264** but which are not in the READ_UNCOMMITTED state may not have
4265** cursors open with wrFlag==0 on the same table. Otherwise
4266** the changes made by this write cursor would be visible to
4267** the read cursors in the other database connection.
drhf74b8d92002-09-01 23:20:45 +00004268**
4269** 3: The database must be writable (not on read-only media)
4270**
4271** 4: There must be an active transaction.
4272**
drhe807bdb2016-01-21 17:06:33 +00004273** The BTREE_FORDELETE bit of wrFlag may optionally be set if BTREE_WRCSR
4274** is set. If FORDELETE is set, that is a hint to the implementation that
4275** this cursor will only be used to seek to and delete entries of an index
4276** as part of a larger DELETE statement. The FORDELETE hint is not used by
4277** this implementation. But in a hypothetical alternative storage engine
4278** in which index entries are automatically deleted when corresponding table
4279** rows are deleted, the FORDELETE flag is a hint that all SEEK and DELETE
4280** operations on this cursor can be no-ops and all READ operations can
4281** return a null row (2-bytes: 0x01 0x00).
4282**
drh6446c4d2001-12-15 14:22:18 +00004283** No checking is done to make sure that page iTable really is the
4284** root page of a b-tree. If it is not, then the cursor acquired
4285** will not work correctly.
danielk197771d5d2c2008-09-29 11:49:47 +00004286**
drhf25a5072009-11-18 23:01:25 +00004287** It is assumed that the sqlite3BtreeCursorZero() has been called
4288** on pCur to initialize the memory space prior to invoking this routine.
drha059ad02001-04-17 20:09:11 +00004289*/
drhd677b3d2007-08-20 22:48:41 +00004290static int btreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00004291 Btree *p, /* The btree */
4292 int iTable, /* Root page of table to open */
4293 int wrFlag, /* 1 to write. 0 read-only */
4294 struct KeyInfo *pKeyInfo, /* First arg to comparison function */
4295 BtCursor *pCur /* Space for new cursor */
drh3aac2dd2004-04-26 14:10:20 +00004296){
danielk19773e8add92009-07-04 17:16:00 +00004297 BtShared *pBt = p->pBt; /* Shared b-tree handle */
drh27fb7462015-06-30 02:47:36 +00004298 BtCursor *pX; /* Looping over other all cursors */
drhecdc7532001-09-23 02:35:53 +00004299
drh1fee73e2007-08-29 04:00:57 +00004300 assert( sqlite3BtreeHoldsMutex(p) );
danfd261ec2015-10-22 20:54:33 +00004301 assert( wrFlag==0
4302 || wrFlag==BTREE_WRCSR
4303 || wrFlag==(BTREE_WRCSR|BTREE_FORDELETE)
4304 );
danielk197796d48e92009-06-29 06:00:37 +00004305
danielk1977602b4662009-07-02 07:47:33 +00004306 /* The following assert statements verify that if this is a sharable
4307 ** b-tree database, the connection is holding the required table locks,
4308 ** and that no other connection has any open cursor that conflicts with
4309 ** this lock. */
danfd261ec2015-10-22 20:54:33 +00004310 assert( hasSharedCacheTableLock(p, iTable, pKeyInfo!=0, (wrFlag?2:1)) );
danielk197796d48e92009-06-29 06:00:37 +00004311 assert( wrFlag==0 || !hasReadConflicts(p, iTable) );
4312
danielk19773e8add92009-07-04 17:16:00 +00004313 /* Assert that the caller has opened the required transaction. */
4314 assert( p->inTrans>TRANS_NONE );
4315 assert( wrFlag==0 || p->inTrans==TRANS_WRITE );
4316 assert( pBt->pPage1 && pBt->pPage1->aData );
drh98ef0f62015-06-30 01:25:52 +00004317 assert( wrFlag==0 || (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk19773e8add92009-07-04 17:16:00 +00004318
drh3fbb0222014-09-24 19:47:27 +00004319 if( wrFlag ){
4320 allocateTempSpace(pBt);
mistachkinfad30392016-02-13 23:43:46 +00004321 if( pBt->pTmpSpace==0 ) return SQLITE_NOMEM_BKPT;
drha0c9a112004-03-10 13:42:37 +00004322 }
drhb1299152010-03-30 22:58:33 +00004323 if( iTable==1 && btreePagecount(pBt)==0 ){
dana205a482011-08-27 18:48:57 +00004324 assert( wrFlag==0 );
4325 iTable = 0;
danielk19773e8add92009-07-04 17:16:00 +00004326 }
danielk1977aef0bf62005-12-30 16:28:01 +00004327
danielk1977aef0bf62005-12-30 16:28:01 +00004328 /* Now that no other errors can occur, finish filling in the BtCursor
danielk19773e8add92009-07-04 17:16:00 +00004329 ** variables and link the cursor into the BtShared list. */
danielk1977172114a2009-07-07 15:47:12 +00004330 pCur->pgnoRoot = (Pgno)iTable;
4331 pCur->iPage = -1;
drh1e968a02008-03-25 00:22:21 +00004332 pCur->pKeyInfo = pKeyInfo;
danielk1977aef0bf62005-12-30 16:28:01 +00004333 pCur->pBtree = p;
drhd0679ed2007-08-28 22:24:34 +00004334 pCur->pBt = pBt;
danfd261ec2015-10-22 20:54:33 +00004335 pCur->curFlags = wrFlag ? BTCF_WriteFlag : 0;
drh28f58dd2015-06-27 19:45:03 +00004336 pCur->curPagerFlags = wrFlag ? 0 : PAGER_GET_READONLY;
drh27fb7462015-06-30 02:47:36 +00004337 /* If there are two or more cursors on the same btree, then all such
4338 ** cursors *must* have the BTCF_Multiple flag set. */
4339 for(pX=pBt->pCursor; pX; pX=pX->pNext){
4340 if( pX->pgnoRoot==(Pgno)iTable ){
4341 pX->curFlags |= BTCF_Multiple;
4342 pCur->curFlags |= BTCF_Multiple;
4343 }
drha059ad02001-04-17 20:09:11 +00004344 }
drh27fb7462015-06-30 02:47:36 +00004345 pCur->pNext = pBt->pCursor;
drha059ad02001-04-17 20:09:11 +00004346 pBt->pCursor = pCur;
danielk1977da184232006-01-05 11:34:32 +00004347 pCur->eState = CURSOR_INVALID;
danielk1977aef0bf62005-12-30 16:28:01 +00004348 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00004349}
drhd677b3d2007-08-20 22:48:41 +00004350int sqlite3BtreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00004351 Btree *p, /* The btree */
4352 int iTable, /* Root page of table to open */
4353 int wrFlag, /* 1 to write. 0 read-only */
4354 struct KeyInfo *pKeyInfo, /* First arg to xCompare() */
4355 BtCursor *pCur /* Write new cursor here */
drhd677b3d2007-08-20 22:48:41 +00004356){
4357 int rc;
dan08f901b2015-05-25 19:24:36 +00004358 if( iTable<1 ){
4359 rc = SQLITE_CORRUPT_BKPT;
4360 }else{
4361 sqlite3BtreeEnter(p);
4362 rc = btreeCursor(p, iTable, wrFlag, pKeyInfo, pCur);
4363 sqlite3BtreeLeave(p);
4364 }
drhd677b3d2007-08-20 22:48:41 +00004365 return rc;
4366}
drh7f751222009-03-17 22:33:00 +00004367
4368/*
4369** Return the size of a BtCursor object in bytes.
4370**
4371** This interfaces is needed so that users of cursors can preallocate
4372** sufficient storage to hold a cursor. The BtCursor object is opaque
4373** to users so they cannot do the sizeof() themselves - they must call
4374** this routine.
4375*/
4376int sqlite3BtreeCursorSize(void){
drhc54055b2009-11-13 17:05:53 +00004377 return ROUND8(sizeof(BtCursor));
danielk1977cd3e8f72008-03-25 09:47:35 +00004378}
4379
drh7f751222009-03-17 22:33:00 +00004380/*
drhf25a5072009-11-18 23:01:25 +00004381** Initialize memory that will be converted into a BtCursor object.
4382**
4383** The simple approach here would be to memset() the entire object
4384** to zero. But it turns out that the apPage[] and aiIdx[] arrays
4385** do not need to be zeroed and they are large, so we can save a lot
4386** of run-time by skipping the initialization of those elements.
4387*/
4388void sqlite3BtreeCursorZero(BtCursor *p){
drhda6bc672018-01-24 16:04:21 +00004389 memset(p, 0, offsetof(BtCursor, BTCURSOR_FIRST_UNINIT));
drhf25a5072009-11-18 23:01:25 +00004390}
4391
4392/*
drh5e00f6c2001-09-13 13:46:56 +00004393** Close a cursor. The read lock on the database file is released
drhbd03cae2001-06-02 02:40:57 +00004394** when the last cursor is closed.
drha059ad02001-04-17 20:09:11 +00004395*/
drh3aac2dd2004-04-26 14:10:20 +00004396int sqlite3BtreeCloseCursor(BtCursor *pCur){
drhff0587c2007-08-29 17:43:19 +00004397 Btree *pBtree = pCur->pBtree;
danielk1977cd3e8f72008-03-25 09:47:35 +00004398 if( pBtree ){
4399 BtShared *pBt = pCur->pBt;
4400 sqlite3BtreeEnter(pBtree);
drh27fb7462015-06-30 02:47:36 +00004401 assert( pBt->pCursor!=0 );
4402 if( pBt->pCursor==pCur ){
danielk1977cd3e8f72008-03-25 09:47:35 +00004403 pBt->pCursor = pCur->pNext;
drh27fb7462015-06-30 02:47:36 +00004404 }else{
4405 BtCursor *pPrev = pBt->pCursor;
4406 do{
4407 if( pPrev->pNext==pCur ){
4408 pPrev->pNext = pCur->pNext;
4409 break;
4410 }
4411 pPrev = pPrev->pNext;
4412 }while( ALWAYS(pPrev) );
danielk1977cd3e8f72008-03-25 09:47:35 +00004413 }
drh352a35a2017-08-15 03:46:47 +00004414 btreeReleaseAllCursorPages(pCur);
danielk1977cd3e8f72008-03-25 09:47:35 +00004415 unlockBtreeIfUnused(pBt);
dan85753662014-12-11 16:38:18 +00004416 sqlite3_free(pCur->aOverflow);
drhf38dd3b2017-08-14 23:53:02 +00004417 sqlite3_free(pCur->pKey);
danielk1977cd3e8f72008-03-25 09:47:35 +00004418 sqlite3BtreeLeave(pBtree);
dan97c8cb32019-01-01 18:00:17 +00004419 pCur->pBtree = 0;
drha059ad02001-04-17 20:09:11 +00004420 }
drh8c42ca92001-06-22 19:15:00 +00004421 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00004422}
4423
drh5e2f8b92001-05-28 00:41:15 +00004424/*
drh86057612007-06-26 01:04:48 +00004425** Make sure the BtCursor* given in the argument has a valid
4426** BtCursor.info structure. If it is not already valid, call
danielk197730548662009-07-09 05:07:37 +00004427** btreeParseCell() to fill it in.
drhab01f612004-05-22 02:55:23 +00004428**
4429** BtCursor.info is a cache of the information in the current cell.
danielk197730548662009-07-09 05:07:37 +00004430** Using this cache reduces the number of calls to btreeParseCell().
drh9188b382004-05-14 21:12:22 +00004431*/
drh9188b382004-05-14 21:12:22 +00004432#ifndef NDEBUG
drha224ee22018-02-19 13:53:56 +00004433 static int cellInfoEqual(CellInfo *a, CellInfo *b){
4434 if( a->nKey!=b->nKey ) return 0;
4435 if( a->pPayload!=b->pPayload ) return 0;
4436 if( a->nPayload!=b->nPayload ) return 0;
4437 if( a->nLocal!=b->nLocal ) return 0;
4438 if( a->nSize!=b->nSize ) return 0;
4439 return 1;
4440 }
danielk19771cc5ed82007-05-16 17:28:43 +00004441 static void assertCellInfo(BtCursor *pCur){
drh9188b382004-05-14 21:12:22 +00004442 CellInfo info;
drh51c6d962004-06-06 00:42:25 +00004443 memset(&info, 0, sizeof(info));
drh352a35a2017-08-15 03:46:47 +00004444 btreeParseCell(pCur->pPage, pCur->ix, &info);
drha224ee22018-02-19 13:53:56 +00004445 assert( CORRUPT_DB || cellInfoEqual(&info, &pCur->info) );
drh9188b382004-05-14 21:12:22 +00004446 }
danielk19771cc5ed82007-05-16 17:28:43 +00004447#else
4448 #define assertCellInfo(x)
4449#endif
drhc5b41ac2015-06-17 02:11:46 +00004450static SQLITE_NOINLINE void getCellInfo(BtCursor *pCur){
4451 if( pCur->info.nSize==0 ){
drhc5b41ac2015-06-17 02:11:46 +00004452 pCur->curFlags |= BTCF_ValidNKey;
drh352a35a2017-08-15 03:46:47 +00004453 btreeParseCell(pCur->pPage,pCur->ix,&pCur->info);
drhc5b41ac2015-06-17 02:11:46 +00004454 }else{
4455 assertCellInfo(pCur);
drh86057612007-06-26 01:04:48 +00004456 }
drhc5b41ac2015-06-17 02:11:46 +00004457}
drh9188b382004-05-14 21:12:22 +00004458
drhea8ffdf2009-07-22 00:35:23 +00004459#ifndef NDEBUG /* The next routine used only within assert() statements */
4460/*
4461** Return true if the given BtCursor is valid. A valid cursor is one
4462** that is currently pointing to a row in a (non-empty) table.
4463** This is a verification routine is used only within assert() statements.
4464*/
4465int sqlite3BtreeCursorIsValid(BtCursor *pCur){
4466 return pCur && pCur->eState==CURSOR_VALID;
4467}
4468#endif /* NDEBUG */
drhd6ef5af2016-11-15 04:00:24 +00004469int sqlite3BtreeCursorIsValidNN(BtCursor *pCur){
4470 assert( pCur!=0 );
4471 return pCur->eState==CURSOR_VALID;
4472}
drhea8ffdf2009-07-22 00:35:23 +00004473
drh9188b382004-05-14 21:12:22 +00004474/*
drha7c90c42016-06-04 20:37:10 +00004475** Return the value of the integer key or "rowid" for a table btree.
4476** This routine is only valid for a cursor that is pointing into a
4477** ordinary table btree. If the cursor points to an index btree or
4478** is invalid, the result of this routine is undefined.
drh7e3b0a02001-04-28 16:52:40 +00004479*/
drha7c90c42016-06-04 20:37:10 +00004480i64 sqlite3BtreeIntegerKey(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00004481 assert( cursorHoldsMutex(pCur) );
drhc5352b92014-11-17 20:33:07 +00004482 assert( pCur->eState==CURSOR_VALID );
drha7c90c42016-06-04 20:37:10 +00004483 assert( pCur->curIntKey );
drhc5352b92014-11-17 20:33:07 +00004484 getCellInfo(pCur);
drha7c90c42016-06-04 20:37:10 +00004485 return pCur->info.nKey;
drha059ad02001-04-17 20:09:11 +00004486}
drh2af926b2001-05-15 00:39:25 +00004487
drh092457b2017-12-29 15:04:49 +00004488#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
drh72f82862001-05-24 21:06:34 +00004489/*
drh2fc865c2017-12-16 20:20:37 +00004490** Return the offset into the database file for the start of the
4491** payload to which the cursor is pointing.
4492*/
drh092457b2017-12-29 15:04:49 +00004493i64 sqlite3BtreeOffset(BtCursor *pCur){
drh2fc865c2017-12-16 20:20:37 +00004494 assert( cursorHoldsMutex(pCur) );
4495 assert( pCur->eState==CURSOR_VALID );
drh2fc865c2017-12-16 20:20:37 +00004496 getCellInfo(pCur);
drhfe6d20e2017-12-29 14:33:54 +00004497 return (i64)pCur->pBt->pageSize*((i64)pCur->pPage->pgno - 1) +
drh2fc865c2017-12-16 20:20:37 +00004498 (i64)(pCur->info.pPayload - pCur->pPage->aData);
4499}
drh092457b2017-12-29 15:04:49 +00004500#endif /* SQLITE_ENABLE_OFFSET_SQL_FUNC */
drh2fc865c2017-12-16 20:20:37 +00004501
4502/*
drha7c90c42016-06-04 20:37:10 +00004503** Return the number of bytes of payload for the entry that pCur is
4504** currently pointing to. For table btrees, this will be the amount
4505** of data. For index btrees, this will be the size of the key.
drhea8ffdf2009-07-22 00:35:23 +00004506**
4507** The caller must guarantee that the cursor is pointing to a non-NULL
4508** valid entry. In other words, the calling procedure must guarantee
4509** that the cursor has Cursor.eState==CURSOR_VALID.
drh0e1c19e2004-05-11 00:58:56 +00004510*/
drha7c90c42016-06-04 20:37:10 +00004511u32 sqlite3BtreePayloadSize(BtCursor *pCur){
4512 assert( cursorHoldsMutex(pCur) );
drhea8ffdf2009-07-22 00:35:23 +00004513 assert( pCur->eState==CURSOR_VALID );
4514 getCellInfo(pCur);
drha7c90c42016-06-04 20:37:10 +00004515 return pCur->info.nPayload;
drh0e1c19e2004-05-11 00:58:56 +00004516}
4517
4518/*
danielk1977d04417962007-05-02 13:16:30 +00004519** Given the page number of an overflow page in the database (parameter
4520** ovfl), this function finds the page number of the next page in the
4521** linked list of overflow pages. If possible, it uses the auto-vacuum
4522** pointer-map data instead of reading the content of page ovfl to do so.
4523**
4524** If an error occurs an SQLite error code is returned. Otherwise:
4525**
danielk1977bea2a942009-01-20 17:06:27 +00004526** The page number of the next overflow page in the linked list is
4527** written to *pPgnoNext. If page ovfl is the last page in its linked
4528** list, *pPgnoNext is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00004529**
danielk1977bea2a942009-01-20 17:06:27 +00004530** If ppPage is not NULL, and a reference to the MemPage object corresponding
4531** to page number pOvfl was obtained, then *ppPage is set to point to that
4532** reference. It is the responsibility of the caller to call releasePage()
4533** on *ppPage to free the reference. In no reference was obtained (because
4534** the pointer-map was used to obtain the value for *pPgnoNext), then
4535** *ppPage is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00004536*/
4537static int getOverflowPage(
drhfa3be902009-07-07 02:44:07 +00004538 BtShared *pBt, /* The database file */
4539 Pgno ovfl, /* Current overflow page number */
danielk1977bea2a942009-01-20 17:06:27 +00004540 MemPage **ppPage, /* OUT: MemPage handle (may be NULL) */
danielk1977d04417962007-05-02 13:16:30 +00004541 Pgno *pPgnoNext /* OUT: Next overflow page number */
4542){
4543 Pgno next = 0;
danielk1977bea2a942009-01-20 17:06:27 +00004544 MemPage *pPage = 0;
drh1bd10f82008-12-10 21:19:56 +00004545 int rc = SQLITE_OK;
danielk1977d04417962007-05-02 13:16:30 +00004546
drh1fee73e2007-08-29 04:00:57 +00004547 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977bea2a942009-01-20 17:06:27 +00004548 assert(pPgnoNext);
danielk1977d04417962007-05-02 13:16:30 +00004549
4550#ifndef SQLITE_OMIT_AUTOVACUUM
4551 /* Try to find the next page in the overflow list using the
4552 ** autovacuum pointer-map pages. Guess that the next page in
4553 ** the overflow list is page number (ovfl+1). If that guess turns
4554 ** out to be wrong, fall back to loading the data of page
4555 ** number ovfl to determine the next page number.
4556 */
4557 if( pBt->autoVacuum ){
4558 Pgno pgno;
4559 Pgno iGuess = ovfl+1;
4560 u8 eType;
4561
4562 while( PTRMAP_ISPAGE(pBt, iGuess) || iGuess==PENDING_BYTE_PAGE(pBt) ){
4563 iGuess++;
4564 }
4565
drhb1299152010-03-30 22:58:33 +00004566 if( iGuess<=btreePagecount(pBt) ){
danielk1977d04417962007-05-02 13:16:30 +00004567 rc = ptrmapGet(pBt, iGuess, &eType, &pgno);
danielk1977bea2a942009-01-20 17:06:27 +00004568 if( rc==SQLITE_OK && eType==PTRMAP_OVERFLOW2 && pgno==ovfl ){
danielk1977d04417962007-05-02 13:16:30 +00004569 next = iGuess;
danielk1977bea2a942009-01-20 17:06:27 +00004570 rc = SQLITE_DONE;
danielk1977d04417962007-05-02 13:16:30 +00004571 }
4572 }
4573 }
4574#endif
4575
danielk1977d8a3f3d2009-07-11 11:45:23 +00004576 assert( next==0 || rc==SQLITE_DONE );
danielk1977bea2a942009-01-20 17:06:27 +00004577 if( rc==SQLITE_OK ){
drhb00fc3b2013-08-21 23:42:32 +00004578 rc = btreeGetPage(pBt, ovfl, &pPage, (ppPage==0) ? PAGER_GET_READONLY : 0);
danielk1977d8a3f3d2009-07-11 11:45:23 +00004579 assert( rc==SQLITE_OK || pPage==0 );
4580 if( rc==SQLITE_OK ){
danielk1977d04417962007-05-02 13:16:30 +00004581 next = get4byte(pPage->aData);
4582 }
danielk1977443c0592009-01-16 15:21:05 +00004583 }
danielk197745d68822009-01-16 16:23:38 +00004584
danielk1977bea2a942009-01-20 17:06:27 +00004585 *pPgnoNext = next;
4586 if( ppPage ){
4587 *ppPage = pPage;
4588 }else{
4589 releasePage(pPage);
4590 }
4591 return (rc==SQLITE_DONE ? SQLITE_OK : rc);
danielk1977d04417962007-05-02 13:16:30 +00004592}
4593
danielk1977da107192007-05-04 08:32:13 +00004594/*
4595** Copy data from a buffer to a page, or from a page to a buffer.
4596**
4597** pPayload is a pointer to data stored on database page pDbPage.
4598** If argument eOp is false, then nByte bytes of data are copied
4599** from pPayload to the buffer pointed at by pBuf. If eOp is true,
4600** then sqlite3PagerWrite() is called on pDbPage and nByte bytes
4601** of data are copied from the buffer pBuf to pPayload.
4602**
4603** SQLITE_OK is returned on success, otherwise an error code.
4604*/
4605static int copyPayload(
4606 void *pPayload, /* Pointer to page data */
4607 void *pBuf, /* Pointer to buffer */
4608 int nByte, /* Number of bytes to copy */
4609 int eOp, /* 0 -> copy from page, 1 -> copy to page */
4610 DbPage *pDbPage /* Page containing pPayload */
4611){
4612 if( eOp ){
4613 /* Copy data from buffer to page (a write operation) */
4614 int rc = sqlite3PagerWrite(pDbPage);
4615 if( rc!=SQLITE_OK ){
4616 return rc;
4617 }
4618 memcpy(pPayload, pBuf, nByte);
4619 }else{
4620 /* Copy data from page to buffer (a read operation) */
4621 memcpy(pBuf, pPayload, nByte);
4622 }
4623 return SQLITE_OK;
4624}
danielk1977d04417962007-05-02 13:16:30 +00004625
4626/*
danielk19779f8d6402007-05-02 17:48:45 +00004627** This function is used to read or overwrite payload information
dan5a500af2014-03-11 20:33:04 +00004628** for the entry that the pCur cursor is pointing to. The eOp
4629** argument is interpreted as follows:
4630**
4631** 0: The operation is a read. Populate the overflow cache.
4632** 1: The operation is a write. Populate the overflow cache.
danielk19779f8d6402007-05-02 17:48:45 +00004633**
4634** A total of "amt" bytes are read or written beginning at "offset".
4635** Data is read to or from the buffer pBuf.
drh72f82862001-05-24 21:06:34 +00004636**
drh3bcdfd22009-07-12 02:32:21 +00004637** The content being read or written might appear on the main page
4638** or be scattered out on multiple overflow pages.
danielk1977da107192007-05-04 08:32:13 +00004639**
drh42e28f12017-01-27 00:31:59 +00004640** If the current cursor entry uses one or more overflow pages
4641** this function may allocate space for and lazily populate
4642** the overflow page-list cache array (BtCursor.aOverflow).
dan5a500af2014-03-11 20:33:04 +00004643** Subsequent calls use this cache to make seeking to the supplied offset
4644** more efficient.
danielk1977da107192007-05-04 08:32:13 +00004645**
drh42e28f12017-01-27 00:31:59 +00004646** Once an overflow page-list cache has been allocated, it must be
danielk1977da107192007-05-04 08:32:13 +00004647** invalidated if some other cursor writes to the same table, or if
4648** the cursor is moved to a different row. Additionally, in auto-vacuum
4649** mode, the following events may invalidate an overflow page-list cache.
4650**
4651** * An incremental vacuum,
4652** * A commit in auto_vacuum="full" mode,
4653** * Creating a table (may require moving an overflow page).
drh72f82862001-05-24 21:06:34 +00004654*/
danielk19779f8d6402007-05-02 17:48:45 +00004655static int accessPayload(
drh3aac2dd2004-04-26 14:10:20 +00004656 BtCursor *pCur, /* Cursor pointing to entry to read from */
danielk197789d40042008-11-17 14:20:56 +00004657 u32 offset, /* Begin reading this far into payload */
4658 u32 amt, /* Read this many bytes */
drh3aac2dd2004-04-26 14:10:20 +00004659 unsigned char *pBuf, /* Write the bytes into this buffer */
danielk19779f8d6402007-05-02 17:48:45 +00004660 int eOp /* zero to read. non-zero to write. */
drh3aac2dd2004-04-26 14:10:20 +00004661){
4662 unsigned char *aPayload;
danielk1977da107192007-05-04 08:32:13 +00004663 int rc = SQLITE_OK;
danielk19772dec9702007-05-02 16:48:37 +00004664 int iIdx = 0;
drh352a35a2017-08-15 03:46:47 +00004665 MemPage *pPage = pCur->pPage; /* Btree page of current entry */
danielk19770d065412008-11-12 18:21:36 +00004666 BtShared *pBt = pCur->pBt; /* Btree this cursor belongs to */
drh4c417182014-03-31 23:57:41 +00004667#ifdef SQLITE_DIRECT_OVERFLOW_READ
drh8bb9fd32017-01-26 16:27:32 +00004668 unsigned char * const pBufStart = pBuf; /* Start of original out buffer */
drh4c417182014-03-31 23:57:41 +00004669#endif
drh3aac2dd2004-04-26 14:10:20 +00004670
danielk1977da107192007-05-04 08:32:13 +00004671 assert( pPage );
drh42e28f12017-01-27 00:31:59 +00004672 assert( eOp==0 || eOp==1 );
danielk1977da184232006-01-05 11:34:32 +00004673 assert( pCur->eState==CURSOR_VALID );
drh75e96b32017-04-01 00:20:06 +00004674 assert( pCur->ix<pPage->nCell );
drh1fee73e2007-08-29 04:00:57 +00004675 assert( cursorHoldsMutex(pCur) );
danielk1977da107192007-05-04 08:32:13 +00004676
drh86057612007-06-26 01:04:48 +00004677 getCellInfo(pCur);
drhab1cc582014-09-23 21:25:19 +00004678 aPayload = pCur->info.pPayload;
drhab1cc582014-09-23 21:25:19 +00004679 assert( offset+amt <= pCur->info.nPayload );
danielk1977da107192007-05-04 08:32:13 +00004680
drh0b982072016-03-22 14:10:45 +00004681 assert( aPayload > pPage->aData );
drhc5e7f942016-03-22 15:25:16 +00004682 if( (uptr)(aPayload - pPage->aData) > (pBt->usableSize - pCur->info.nLocal) ){
drh0b982072016-03-22 14:10:45 +00004683 /* Trying to read or write past the end of the data is an error. The
4684 ** conditional above is really:
4685 ** &aPayload[pCur->info.nLocal] > &pPage->aData[pBt->usableSize]
4686 ** but is recast into its current form to avoid integer overflow problems
4687 */
daneebf2f52017-11-18 17:30:08 +00004688 return SQLITE_CORRUPT_PAGE(pPage);
drh3aac2dd2004-04-26 14:10:20 +00004689 }
danielk1977da107192007-05-04 08:32:13 +00004690
4691 /* Check if data must be read/written to/from the btree page itself. */
drhfa1a98a2004-05-14 19:08:17 +00004692 if( offset<pCur->info.nLocal ){
drh2af926b2001-05-15 00:39:25 +00004693 int a = amt;
drhfa1a98a2004-05-14 19:08:17 +00004694 if( a+offset>pCur->info.nLocal ){
4695 a = pCur->info.nLocal - offset;
drh2af926b2001-05-15 00:39:25 +00004696 }
drh42e28f12017-01-27 00:31:59 +00004697 rc = copyPayload(&aPayload[offset], pBuf, a, eOp, pPage->pDbPage);
drh2aa679f2001-06-25 02:11:07 +00004698 offset = 0;
drha34b6762004-05-07 13:30:42 +00004699 pBuf += a;
drh2af926b2001-05-15 00:39:25 +00004700 amt -= a;
drhdd793422001-06-28 01:54:48 +00004701 }else{
drhfa1a98a2004-05-14 19:08:17 +00004702 offset -= pCur->info.nLocal;
drhbd03cae2001-06-02 02:40:57 +00004703 }
danielk1977da107192007-05-04 08:32:13 +00004704
dan85753662014-12-11 16:38:18 +00004705
danielk1977da107192007-05-04 08:32:13 +00004706 if( rc==SQLITE_OK && amt>0 ){
danielk197789d40042008-11-17 14:20:56 +00004707 const u32 ovflSize = pBt->usableSize - 4; /* Bytes content per ovfl page */
danielk1977da107192007-05-04 08:32:13 +00004708 Pgno nextPage;
4709
drhfa1a98a2004-05-14 19:08:17 +00004710 nextPage = get4byte(&aPayload[pCur->info.nLocal]);
danielk1977da107192007-05-04 08:32:13 +00004711
drha38c9512014-04-01 01:24:34 +00004712 /* If the BtCursor.aOverflow[] has not been allocated, allocate it now.
drha38c9512014-04-01 01:24:34 +00004713 **
4714 ** The aOverflow[] array is sized at one entry for each overflow page
4715 ** in the overflow chain. The page number of the first overflow page is
4716 ** stored in aOverflow[0], etc. A value of 0 in the aOverflow[] array
4717 ** means "not yet known" (the cache is lazily populated).
danielk1977da107192007-05-04 08:32:13 +00004718 */
drh42e28f12017-01-27 00:31:59 +00004719 if( (pCur->curFlags & BTCF_ValidOvfl)==0 ){
danielk19772dec9702007-05-02 16:48:37 +00004720 int nOvfl = (pCur->info.nPayload-pCur->info.nLocal+ovflSize-1)/ovflSize;
drhda6bc672018-01-24 16:04:21 +00004721 if( pCur->aOverflow==0
mistachkin97f90592018-02-04 01:30:54 +00004722 || nOvfl*(int)sizeof(Pgno) > sqlite3MallocSize(pCur->aOverflow)
drhda6bc672018-01-24 16:04:21 +00004723 ){
dan85753662014-12-11 16:38:18 +00004724 Pgno *aNew = (Pgno*)sqlite3Realloc(
4725 pCur->aOverflow, nOvfl*2*sizeof(Pgno)
dan5a500af2014-03-11 20:33:04 +00004726 );
4727 if( aNew==0 ){
drhcd645532017-01-20 20:43:14 +00004728 return SQLITE_NOMEM_BKPT;
dan5a500af2014-03-11 20:33:04 +00004729 }else{
dan5a500af2014-03-11 20:33:04 +00004730 pCur->aOverflow = aNew;
4731 }
4732 }
drhcd645532017-01-20 20:43:14 +00004733 memset(pCur->aOverflow, 0, nOvfl*sizeof(Pgno));
4734 pCur->curFlags |= BTCF_ValidOvfl;
drhcdf360a2017-01-27 01:13:49 +00004735 }else{
4736 /* If the overflow page-list cache has been allocated and the
4737 ** entry for the first required overflow page is valid, skip
4738 ** directly to it.
4739 */
4740 if( pCur->aOverflow[offset/ovflSize] ){
4741 iIdx = (offset/ovflSize);
4742 nextPage = pCur->aOverflow[iIdx];
4743 offset = (offset%ovflSize);
4744 }
danielk19772dec9702007-05-02 16:48:37 +00004745 }
danielk1977da107192007-05-04 08:32:13 +00004746
drhcd645532017-01-20 20:43:14 +00004747 assert( rc==SQLITE_OK && amt>0 );
4748 while( nextPage ){
danielk1977da107192007-05-04 08:32:13 +00004749 /* If required, populate the overflow page-list cache. */
drh42e28f12017-01-27 00:31:59 +00004750 assert( pCur->aOverflow[iIdx]==0
4751 || pCur->aOverflow[iIdx]==nextPage
4752 || CORRUPT_DB );
4753 pCur->aOverflow[iIdx] = nextPage;
danielk1977da107192007-05-04 08:32:13 +00004754
danielk1977d04417962007-05-02 13:16:30 +00004755 if( offset>=ovflSize ){
4756 /* The only reason to read this page is to obtain the page
danielk1977da107192007-05-04 08:32:13 +00004757 ** number for the next page in the overflow chain. The page
drhfd131da2007-08-07 17:13:03 +00004758 ** data is not required. So first try to lookup the overflow
4759 ** page-list cache, if any, then fall back to the getOverflowPage()
danielk1977da107192007-05-04 08:32:13 +00004760 ** function.
danielk1977d04417962007-05-02 13:16:30 +00004761 */
drha38c9512014-04-01 01:24:34 +00004762 assert( pCur->curFlags & BTCF_ValidOvfl );
dan85753662014-12-11 16:38:18 +00004763 assert( pCur->pBtree->db==pBt->db );
drha38c9512014-04-01 01:24:34 +00004764 if( pCur->aOverflow[iIdx+1] ){
danielk1977da107192007-05-04 08:32:13 +00004765 nextPage = pCur->aOverflow[iIdx+1];
drha38c9512014-04-01 01:24:34 +00004766 }else{
danielk1977da107192007-05-04 08:32:13 +00004767 rc = getOverflowPage(pBt, nextPage, 0, &nextPage);
drha38c9512014-04-01 01:24:34 +00004768 }
danielk1977da107192007-05-04 08:32:13 +00004769 offset -= ovflSize;
danielk1977d04417962007-05-02 13:16:30 +00004770 }else{
danielk19779f8d6402007-05-02 17:48:45 +00004771 /* Need to read this page properly. It contains some of the
4772 ** range of data that is being read (eOp==0) or written (eOp!=0).
danielk1977d04417962007-05-02 13:16:30 +00004773 */
danielk1977cfe9a692004-06-16 12:00:29 +00004774 int a = amt;
danf4ba1092011-10-08 14:57:07 +00004775 if( a + offset > ovflSize ){
4776 a = ovflSize - offset;
danielk19779f8d6402007-05-02 17:48:45 +00004777 }
danf4ba1092011-10-08 14:57:07 +00004778
4779#ifdef SQLITE_DIRECT_OVERFLOW_READ
4780 /* If all the following are true:
4781 **
4782 ** 1) this is a read operation, and
4783 ** 2) data is required from the start of this overflow page, and
dan09236752018-11-22 19:10:14 +00004784 ** 3) there are no dirty pages in the page-cache
drh8bb9fd32017-01-26 16:27:32 +00004785 ** 4) the database is file-backed, and
drhd930b5c2017-01-26 02:26:02 +00004786 ** 5) the page is not in the WAL file
drh8bb9fd32017-01-26 16:27:32 +00004787 ** 6) at least 4 bytes have already been read into the output buffer
danf4ba1092011-10-08 14:57:07 +00004788 **
4789 ** then data can be read directly from the database file into the
4790 ** output buffer, bypassing the page-cache altogether. This speeds
4791 ** up loading large records that span many overflow pages.
4792 */
drh42e28f12017-01-27 00:31:59 +00004793 if( eOp==0 /* (1) */
danf4ba1092011-10-08 14:57:07 +00004794 && offset==0 /* (2) */
dan09236752018-11-22 19:10:14 +00004795 && sqlite3PagerDirectReadOk(pBt->pPager, nextPage) /* (3,4,5) */
drh8bb9fd32017-01-26 16:27:32 +00004796 && &pBuf[-4]>=pBufStart /* (6) */
danf4ba1092011-10-08 14:57:07 +00004797 ){
dan09236752018-11-22 19:10:14 +00004798 sqlite3_file *fd = sqlite3PagerFile(pBt->pPager);
danf4ba1092011-10-08 14:57:07 +00004799 u8 aSave[4];
4800 u8 *aWrite = &pBuf[-4];
drh8bb9fd32017-01-26 16:27:32 +00004801 assert( aWrite>=pBufStart ); /* due to (6) */
danf4ba1092011-10-08 14:57:07 +00004802 memcpy(aSave, aWrite, 4);
dan27d47fb2011-12-21 17:00:16 +00004803 rc = sqlite3OsRead(fd, aWrite, a+4, (i64)pBt->pageSize*(nextPage-1));
danf4ba1092011-10-08 14:57:07 +00004804 nextPage = get4byte(aWrite);
4805 memcpy(aWrite, aSave, 4);
4806 }else
4807#endif
4808
4809 {
4810 DbPage *pDbPage;
drh9584f582015-11-04 20:22:37 +00004811 rc = sqlite3PagerGet(pBt->pPager, nextPage, &pDbPage,
drh42e28f12017-01-27 00:31:59 +00004812 (eOp==0 ? PAGER_GET_READONLY : 0)
dan11dcd112013-03-15 18:29:18 +00004813 );
danf4ba1092011-10-08 14:57:07 +00004814 if( rc==SQLITE_OK ){
4815 aPayload = sqlite3PagerGetData(pDbPage);
4816 nextPage = get4byte(aPayload);
drh42e28f12017-01-27 00:31:59 +00004817 rc = copyPayload(&aPayload[offset+4], pBuf, a, eOp, pDbPage);
danf4ba1092011-10-08 14:57:07 +00004818 sqlite3PagerUnref(pDbPage);
4819 offset = 0;
4820 }
4821 }
4822 amt -= a;
drh6ee610b2017-01-27 01:25:00 +00004823 if( amt==0 ) return rc;
danf4ba1092011-10-08 14:57:07 +00004824 pBuf += a;
danielk1977cfe9a692004-06-16 12:00:29 +00004825 }
drhcd645532017-01-20 20:43:14 +00004826 if( rc ) break;
4827 iIdx++;
drh2af926b2001-05-15 00:39:25 +00004828 }
drh2af926b2001-05-15 00:39:25 +00004829 }
danielk1977cfe9a692004-06-16 12:00:29 +00004830
danielk1977da107192007-05-04 08:32:13 +00004831 if( rc==SQLITE_OK && amt>0 ){
drhcc97ca42017-06-07 22:32:59 +00004832 /* Overflow chain ends prematurely */
daneebf2f52017-11-18 17:30:08 +00004833 return SQLITE_CORRUPT_PAGE(pPage);
drha7fcb052001-12-14 15:09:55 +00004834 }
danielk1977da107192007-05-04 08:32:13 +00004835 return rc;
drh2af926b2001-05-15 00:39:25 +00004836}
4837
drh72f82862001-05-24 21:06:34 +00004838/*
drhcb3cabd2016-11-25 19:18:28 +00004839** Read part of the payload for the row at which that cursor pCur is currently
4840** pointing. "amt" bytes will be transferred into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00004841** begins at "offset".
drh8c1238a2003-01-02 14:43:55 +00004842**
drhcb3cabd2016-11-25 19:18:28 +00004843** pCur can be pointing to either a table or an index b-tree.
4844** If pointing to a table btree, then the content section is read. If
4845** pCur is pointing to an index b-tree then the key section is read.
4846**
4847** For sqlite3BtreePayload(), the caller must ensure that pCur is pointing
4848** to a valid row in the table. For sqlite3BtreePayloadChecked(), the
4849** cursor might be invalid or might need to be restored before being read.
drh5d1a8722009-07-22 18:07:40 +00004850**
drh3aac2dd2004-04-26 14:10:20 +00004851** Return SQLITE_OK on success or an error code if anything goes
4852** wrong. An error is returned if "offset+amt" is larger than
4853** the available payload.
drh72f82862001-05-24 21:06:34 +00004854*/
drhcb3cabd2016-11-25 19:18:28 +00004855int sqlite3BtreePayload(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drh1fee73e2007-08-29 04:00:57 +00004856 assert( cursorHoldsMutex(pCur) );
drh5d1a8722009-07-22 18:07:40 +00004857 assert( pCur->eState==CURSOR_VALID );
drh352a35a2017-08-15 03:46:47 +00004858 assert( pCur->iPage>=0 && pCur->pPage );
4859 assert( pCur->ix<pCur->pPage->nCell );
drh5d1a8722009-07-22 18:07:40 +00004860 return accessPayload(pCur, offset, amt, (unsigned char*)pBuf, 0);
drh3aac2dd2004-04-26 14:10:20 +00004861}
drh83ec2762017-01-26 16:54:47 +00004862
4863/*
4864** This variant of sqlite3BtreePayload() works even if the cursor has not
4865** in the CURSOR_VALID state. It is only used by the sqlite3_blob_read()
4866** interface.
4867*/
danielk19773588ceb2008-06-10 17:30:26 +00004868#ifndef SQLITE_OMIT_INCRBLOB
drh83ec2762017-01-26 16:54:47 +00004869static SQLITE_NOINLINE int accessPayloadChecked(
4870 BtCursor *pCur,
4871 u32 offset,
4872 u32 amt,
4873 void *pBuf
4874){
drhcb3cabd2016-11-25 19:18:28 +00004875 int rc;
danielk19773588ceb2008-06-10 17:30:26 +00004876 if ( pCur->eState==CURSOR_INVALID ){
4877 return SQLITE_ABORT;
4878 }
dan7a2347e2016-01-07 16:43:54 +00004879 assert( cursorOwnsBtShared(pCur) );
drh945b0942017-01-26 21:30:00 +00004880 rc = btreeRestoreCursorPosition(pCur);
drh83ec2762017-01-26 16:54:47 +00004881 return rc ? rc : accessPayload(pCur, offset, amt, pBuf, 0);
4882}
4883int sqlite3BtreePayloadChecked(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
4884 if( pCur->eState==CURSOR_VALID ){
4885 assert( cursorOwnsBtShared(pCur) );
4886 return accessPayload(pCur, offset, amt, pBuf, 0);
4887 }else{
4888 return accessPayloadChecked(pCur, offset, amt, pBuf);
danielk1977da184232006-01-05 11:34:32 +00004889 }
drh2af926b2001-05-15 00:39:25 +00004890}
drhcb3cabd2016-11-25 19:18:28 +00004891#endif /* SQLITE_OMIT_INCRBLOB */
drh2af926b2001-05-15 00:39:25 +00004892
drh72f82862001-05-24 21:06:34 +00004893/*
drh0e1c19e2004-05-11 00:58:56 +00004894** Return a pointer to payload information from the entry that the
4895** pCur cursor is pointing to. The pointer is to the beginning of
drh2a8d2262013-12-09 20:43:22 +00004896** the key if index btrees (pPage->intKey==0) and is the data for
4897** table btrees (pPage->intKey==1). The number of bytes of available
4898** key/data is written into *pAmt. If *pAmt==0, then the value
4899** returned will not be a valid pointer.
drh0e1c19e2004-05-11 00:58:56 +00004900**
4901** This routine is an optimization. It is common for the entire key
4902** and data to fit on the local page and for there to be no overflow
4903** pages. When that is so, this routine can be used to access the
4904** key and data without making a copy. If the key and/or data spills
drh7f751222009-03-17 22:33:00 +00004905** onto overflow pages, then accessPayload() must be used to reassemble
drh0e1c19e2004-05-11 00:58:56 +00004906** the key/data and copy it into a preallocated buffer.
4907**
4908** The pointer returned by this routine looks directly into the cached
4909** page of the database. The data might change or move the next time
4910** any btree routine is called.
4911*/
drh2a8d2262013-12-09 20:43:22 +00004912static const void *fetchPayload(
drh0e1c19e2004-05-11 00:58:56 +00004913 BtCursor *pCur, /* Cursor pointing to entry to read from */
drh2a8d2262013-12-09 20:43:22 +00004914 u32 *pAmt /* Write the number of available bytes here */
drh0e1c19e2004-05-11 00:58:56 +00004915){
danf2f72a02017-10-19 15:17:38 +00004916 int amt;
drh352a35a2017-08-15 03:46:47 +00004917 assert( pCur!=0 && pCur->iPage>=0 && pCur->pPage);
danielk1977da184232006-01-05 11:34:32 +00004918 assert( pCur->eState==CURSOR_VALID );
drh2a8d2262013-12-09 20:43:22 +00004919 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
dan7a2347e2016-01-07 16:43:54 +00004920 assert( cursorOwnsBtShared(pCur) );
drh352a35a2017-08-15 03:46:47 +00004921 assert( pCur->ix<pCur->pPage->nCell );
drh86dd3712014-03-25 11:00:21 +00004922 assert( pCur->info.nSize>0 );
drh352a35a2017-08-15 03:46:47 +00004923 assert( pCur->info.pPayload>pCur->pPage->aData || CORRUPT_DB );
4924 assert( pCur->info.pPayload<pCur->pPage->aDataEnd ||CORRUPT_DB);
danf2f72a02017-10-19 15:17:38 +00004925 amt = pCur->info.nLocal;
4926 if( amt>(int)(pCur->pPage->aDataEnd - pCur->info.pPayload) ){
4927 /* There is too little space on the page for the expected amount
4928 ** of local content. Database must be corrupt. */
4929 assert( CORRUPT_DB );
4930 amt = MAX(0, (int)(pCur->pPage->aDataEnd - pCur->info.pPayload));
4931 }
4932 *pAmt = (u32)amt;
drhab1cc582014-09-23 21:25:19 +00004933 return (void*)pCur->info.pPayload;
drh0e1c19e2004-05-11 00:58:56 +00004934}
4935
4936
4937/*
drhe51c44f2004-05-30 20:46:09 +00004938** For the entry that cursor pCur is point to, return as
4939** many bytes of the key or data as are available on the local
4940** b-tree page. Write the number of available bytes into *pAmt.
drh0e1c19e2004-05-11 00:58:56 +00004941**
4942** The pointer returned is ephemeral. The key/data may move
drhd677b3d2007-08-20 22:48:41 +00004943** or be destroyed on the next call to any Btree routine,
4944** including calls from other threads against the same cache.
4945** Hence, a mutex on the BtShared should be held prior to calling
4946** this routine.
drh0e1c19e2004-05-11 00:58:56 +00004947**
4948** These routines is used to get quick access to key and data
4949** in the common case where no overflow pages are used.
drh0e1c19e2004-05-11 00:58:56 +00004950*/
drha7c90c42016-06-04 20:37:10 +00004951const void *sqlite3BtreePayloadFetch(BtCursor *pCur, u32 *pAmt){
drh2a8d2262013-12-09 20:43:22 +00004952 return fetchPayload(pCur, pAmt);
drh0e1c19e2004-05-11 00:58:56 +00004953}
4954
4955
4956/*
drh8178a752003-01-05 21:41:40 +00004957** Move the cursor down to a new child page. The newPgno argument is the
drhab01f612004-05-22 02:55:23 +00004958** page number of the child page to move to.
danielk1977a299d612009-07-13 11:22:10 +00004959**
4960** This function returns SQLITE_CORRUPT if the page-header flags field of
4961** the new child page does not match the flags field of the parent (i.e.
4962** if an intkey page appears to be the parent of a non-intkey page, or
4963** vice-versa).
drh72f82862001-05-24 21:06:34 +00004964*/
drh3aac2dd2004-04-26 14:10:20 +00004965static int moveToChild(BtCursor *pCur, u32 newPgno){
drhd0679ed2007-08-28 22:24:34 +00004966 BtShared *pBt = pCur->pBt;
drh72f82862001-05-24 21:06:34 +00004967
dan7a2347e2016-01-07 16:43:54 +00004968 assert( cursorOwnsBtShared(pCur) );
danielk1977da184232006-01-05 11:34:32 +00004969 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00004970 assert( pCur->iPage<BTCURSOR_MAX_DEPTH );
dan11dcd112013-03-15 18:29:18 +00004971 assert( pCur->iPage>=0 );
danielk197771d5d2c2008-09-29 11:49:47 +00004972 if( pCur->iPage>=(BTCURSOR_MAX_DEPTH-1) ){
4973 return SQLITE_CORRUPT_BKPT;
4974 }
drh271efa52004-05-30 19:19:05 +00004975 pCur->info.nSize = 0;
drh036dbec2014-03-11 23:40:44 +00004976 pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
drh352a35a2017-08-15 03:46:47 +00004977 pCur->aiIdx[pCur->iPage] = pCur->ix;
4978 pCur->apPage[pCur->iPage] = pCur->pPage;
drh75e96b32017-04-01 00:20:06 +00004979 pCur->ix = 0;
drh352a35a2017-08-15 03:46:47 +00004980 pCur->iPage++;
4981 return getAndInitPage(pBt, newPgno, &pCur->pPage, pCur, pCur->curPagerFlags);
drh72f82862001-05-24 21:06:34 +00004982}
4983
drhd879e3e2017-02-13 13:35:55 +00004984#ifdef SQLITE_DEBUG
danielk1977bf93c562008-09-29 15:53:25 +00004985/*
4986** Page pParent is an internal (non-leaf) tree page. This function
4987** asserts that page number iChild is the left-child if the iIdx'th
4988** cell in page pParent. Or, if iIdx is equal to the total number of
4989** cells in pParent, that page number iChild is the right-child of
4990** the page.
4991*/
4992static void assertParentIndex(MemPage *pParent, int iIdx, Pgno iChild){
drhcbd33492015-03-25 13:06:54 +00004993 if( CORRUPT_DB ) return; /* The conditions tested below might not be true
4994 ** in a corrupt database */
danielk1977bf93c562008-09-29 15:53:25 +00004995 assert( iIdx<=pParent->nCell );
4996 if( iIdx==pParent->nCell ){
4997 assert( get4byte(&pParent->aData[pParent->hdrOffset+8])==iChild );
4998 }else{
4999 assert( get4byte(findCell(pParent, iIdx))==iChild );
5000 }
5001}
5002#else
5003# define assertParentIndex(x,y,z)
5004#endif
5005
drh72f82862001-05-24 21:06:34 +00005006/*
drh5e2f8b92001-05-28 00:41:15 +00005007** Move the cursor up to the parent page.
5008**
5009** pCur->idx is set to the cell index that contains the pointer
5010** to the page we are coming from. If we are coming from the
5011** right-most child page then pCur->idx is set to one more than
drhbd03cae2001-06-02 02:40:57 +00005012** the largest cell index.
drh72f82862001-05-24 21:06:34 +00005013*/
danielk197730548662009-07-09 05:07:37 +00005014static void moveToParent(BtCursor *pCur){
drh352a35a2017-08-15 03:46:47 +00005015 MemPage *pLeaf;
dan7a2347e2016-01-07 16:43:54 +00005016 assert( cursorOwnsBtShared(pCur) );
danielk1977da184232006-01-05 11:34:32 +00005017 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00005018 assert( pCur->iPage>0 );
drh352a35a2017-08-15 03:46:47 +00005019 assert( pCur->pPage );
danielk1977bf93c562008-09-29 15:53:25 +00005020 assertParentIndex(
5021 pCur->apPage[pCur->iPage-1],
5022 pCur->aiIdx[pCur->iPage-1],
drh352a35a2017-08-15 03:46:47 +00005023 pCur->pPage->pgno
danielk1977bf93c562008-09-29 15:53:25 +00005024 );
dan6c2688c2012-01-12 15:05:03 +00005025 testcase( pCur->aiIdx[pCur->iPage-1] > pCur->apPage[pCur->iPage-1]->nCell );
drh271efa52004-05-30 19:19:05 +00005026 pCur->info.nSize = 0;
drh036dbec2014-03-11 23:40:44 +00005027 pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
drh75e96b32017-04-01 00:20:06 +00005028 pCur->ix = pCur->aiIdx[pCur->iPage-1];
drh352a35a2017-08-15 03:46:47 +00005029 pLeaf = pCur->pPage;
5030 pCur->pPage = pCur->apPage[--pCur->iPage];
5031 releasePageNotNull(pLeaf);
drh72f82862001-05-24 21:06:34 +00005032}
5033
5034/*
danielk19778f880a82009-07-13 09:41:45 +00005035** Move the cursor to point to the root page of its b-tree structure.
5036**
5037** If the table has a virtual root page, then the cursor is moved to point
5038** to the virtual root page instead of the actual root page. A table has a
5039** virtual root page when the actual root page contains no cells and a
5040** single child page. This can only happen with the table rooted at page 1.
5041**
5042** If the b-tree structure is empty, the cursor state is set to
drh44548e72017-08-14 18:13:52 +00005043** CURSOR_INVALID and this routine returns SQLITE_EMPTY. Otherwise,
5044** the cursor is set to point to the first cell located on the root
5045** (or virtual root) page and the cursor state is set to CURSOR_VALID.
danielk19778f880a82009-07-13 09:41:45 +00005046**
5047** If this function returns successfully, it may be assumed that the
5048** page-header flags indicate that the [virtual] root-page is the expected
5049** kind of b-tree page (i.e. if when opening the cursor the caller did not
5050** specify a KeyInfo structure the flags byte is set to 0x05 or 0x0D,
5051** indicating a table b-tree, or if the caller did specify a KeyInfo
5052** structure the flags byte is set to 0x02 or 0x0A, indicating an index
5053** b-tree).
drh72f82862001-05-24 21:06:34 +00005054*/
drh5e2f8b92001-05-28 00:41:15 +00005055static int moveToRoot(BtCursor *pCur){
drh3aac2dd2004-04-26 14:10:20 +00005056 MemPage *pRoot;
drh777e4c42006-01-13 04:31:58 +00005057 int rc = SQLITE_OK;
drhbd03cae2001-06-02 02:40:57 +00005058
dan7a2347e2016-01-07 16:43:54 +00005059 assert( cursorOwnsBtShared(pCur) );
drhfb982642007-08-30 01:19:59 +00005060 assert( CURSOR_INVALID < CURSOR_REQUIRESEEK );
5061 assert( CURSOR_VALID < CURSOR_REQUIRESEEK );
5062 assert( CURSOR_FAULT > CURSOR_REQUIRESEEK );
drh85ef6302017-08-02 15:50:09 +00005063 assert( pCur->eState < CURSOR_REQUIRESEEK || pCur->iPage<0 );
drh44548e72017-08-14 18:13:52 +00005064 assert( pCur->pgnoRoot>0 || pCur->iPage<0 );
danielk197771d5d2c2008-09-29 11:49:47 +00005065
5066 if( pCur->iPage>=0 ){
drh7ad3eb62016-10-24 01:01:09 +00005067 if( pCur->iPage ){
drh352a35a2017-08-15 03:46:47 +00005068 releasePageNotNull(pCur->pPage);
5069 while( --pCur->iPage ){
5070 releasePageNotNull(pCur->apPage[pCur->iPage]);
5071 }
5072 pCur->pPage = pCur->apPage[0];
drh7ad3eb62016-10-24 01:01:09 +00005073 goto skip_init;
drhbbf0f862015-06-27 14:59:26 +00005074 }
dana205a482011-08-27 18:48:57 +00005075 }else if( pCur->pgnoRoot==0 ){
5076 pCur->eState = CURSOR_INVALID;
drh44548e72017-08-14 18:13:52 +00005077 return SQLITE_EMPTY;
drh777e4c42006-01-13 04:31:58 +00005078 }else{
drh28f58dd2015-06-27 19:45:03 +00005079 assert( pCur->iPage==(-1) );
drh85ef6302017-08-02 15:50:09 +00005080 if( pCur->eState>=CURSOR_REQUIRESEEK ){
5081 if( pCur->eState==CURSOR_FAULT ){
5082 assert( pCur->skipNext!=SQLITE_OK );
5083 return pCur->skipNext;
5084 }
5085 sqlite3BtreeClearCursor(pCur);
5086 }
drh352a35a2017-08-15 03:46:47 +00005087 rc = getAndInitPage(pCur->pBtree->pBt, pCur->pgnoRoot, &pCur->pPage,
drh15a00212015-06-27 20:55:00 +00005088 0, pCur->curPagerFlags);
drh4c301aa2009-07-15 17:25:45 +00005089 if( rc!=SQLITE_OK ){
drh777e4c42006-01-13 04:31:58 +00005090 pCur->eState = CURSOR_INVALID;
drhf0357d82017-08-14 17:03:58 +00005091 return rc;
drh777e4c42006-01-13 04:31:58 +00005092 }
danielk1977172114a2009-07-07 15:47:12 +00005093 pCur->iPage = 0;
drh352a35a2017-08-15 03:46:47 +00005094 pCur->curIntKey = pCur->pPage->intKey;
drhc39e0002004-05-07 23:50:57 +00005095 }
drh352a35a2017-08-15 03:46:47 +00005096 pRoot = pCur->pPage;
danielk197771d5d2c2008-09-29 11:49:47 +00005097 assert( pRoot->pgno==pCur->pgnoRoot );
dan7df42ab2014-01-20 18:25:44 +00005098
5099 /* If pCur->pKeyInfo is not NULL, then the caller that opened this cursor
5100 ** expected to open it on an index b-tree. Otherwise, if pKeyInfo is
5101 ** NULL, the caller expects a table b-tree. If this is not the case,
5102 ** return an SQLITE_CORRUPT error.
5103 **
5104 ** Earlier versions of SQLite assumed that this test could not fail
5105 ** if the root page was already loaded when this function was called (i.e.
5106 ** if pCur->iPage>=0). But this is not so if the database is corrupted
5107 ** in such a way that page pRoot is linked into a second b-tree table
5108 ** (or the freelist). */
5109 assert( pRoot->intKey==1 || pRoot->intKey==0 );
5110 if( pRoot->isInit==0 || (pCur->pKeyInfo==0)!=pRoot->intKey ){
daneebf2f52017-11-18 17:30:08 +00005111 return SQLITE_CORRUPT_PAGE(pCur->pPage);
dan7df42ab2014-01-20 18:25:44 +00005112 }
danielk19778f880a82009-07-13 09:41:45 +00005113
drh7ad3eb62016-10-24 01:01:09 +00005114skip_init:
drh75e96b32017-04-01 00:20:06 +00005115 pCur->ix = 0;
drh271efa52004-05-30 19:19:05 +00005116 pCur->info.nSize = 0;
drh036dbec2014-03-11 23:40:44 +00005117 pCur->curFlags &= ~(BTCF_AtLast|BTCF_ValidNKey|BTCF_ValidOvfl);
danielk197771d5d2c2008-09-29 11:49:47 +00005118
drh352a35a2017-08-15 03:46:47 +00005119 pRoot = pCur->pPage;
drh4e8fe3f2013-12-06 23:25:27 +00005120 if( pRoot->nCell>0 ){
5121 pCur->eState = CURSOR_VALID;
5122 }else if( !pRoot->leaf ){
drh8856d6a2004-04-29 14:42:46 +00005123 Pgno subpage;
drhc85240d2009-06-04 16:14:33 +00005124 if( pRoot->pgno!=1 ) return SQLITE_CORRUPT_BKPT;
drh43605152004-05-29 21:46:49 +00005125 subpage = get4byte(&pRoot->aData[pRoot->hdrOffset+8]);
danielk1977da184232006-01-05 11:34:32 +00005126 pCur->eState = CURSOR_VALID;
drh4b70f112004-05-02 21:12:19 +00005127 rc = moveToChild(pCur, subpage);
danielk197771d5d2c2008-09-29 11:49:47 +00005128 }else{
drh4e8fe3f2013-12-06 23:25:27 +00005129 pCur->eState = CURSOR_INVALID;
drh44548e72017-08-14 18:13:52 +00005130 rc = SQLITE_EMPTY;
drh8856d6a2004-04-29 14:42:46 +00005131 }
5132 return rc;
drh72f82862001-05-24 21:06:34 +00005133}
drh2af926b2001-05-15 00:39:25 +00005134
drh5e2f8b92001-05-28 00:41:15 +00005135/*
5136** Move the cursor down to the left-most leaf entry beneath the
5137** entry to which it is currently pointing.
drh777e4c42006-01-13 04:31:58 +00005138**
5139** The left-most leaf is the one with the smallest key - the first
5140** in ascending order.
drh5e2f8b92001-05-28 00:41:15 +00005141*/
5142static int moveToLeftmost(BtCursor *pCur){
5143 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00005144 int rc = SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00005145 MemPage *pPage;
drh5e2f8b92001-05-28 00:41:15 +00005146
dan7a2347e2016-01-07 16:43:54 +00005147 assert( cursorOwnsBtShared(pCur) );
danielk1977da184232006-01-05 11:34:32 +00005148 assert( pCur->eState==CURSOR_VALID );
drh352a35a2017-08-15 03:46:47 +00005149 while( rc==SQLITE_OK && !(pPage = pCur->pPage)->leaf ){
drh75e96b32017-04-01 00:20:06 +00005150 assert( pCur->ix<pPage->nCell );
5151 pgno = get4byte(findCell(pPage, pCur->ix));
drh8178a752003-01-05 21:41:40 +00005152 rc = moveToChild(pCur, pgno);
drh5e2f8b92001-05-28 00:41:15 +00005153 }
drhd677b3d2007-08-20 22:48:41 +00005154 return rc;
drh5e2f8b92001-05-28 00:41:15 +00005155}
5156
drh2dcc9aa2002-12-04 13:40:25 +00005157/*
5158** Move the cursor down to the right-most leaf entry beneath the
5159** page to which it is currently pointing. Notice the difference
5160** between moveToLeftmost() and moveToRightmost(). moveToLeftmost()
5161** finds the left-most entry beneath the *entry* whereas moveToRightmost()
5162** finds the right-most entry beneath the *page*.
drh777e4c42006-01-13 04:31:58 +00005163**
5164** The right-most entry is the one with the largest key - the last
5165** key in ascending order.
drh2dcc9aa2002-12-04 13:40:25 +00005166*/
5167static int moveToRightmost(BtCursor *pCur){
5168 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00005169 int rc = SQLITE_OK;
drh1bd10f82008-12-10 21:19:56 +00005170 MemPage *pPage = 0;
drh2dcc9aa2002-12-04 13:40:25 +00005171
dan7a2347e2016-01-07 16:43:54 +00005172 assert( cursorOwnsBtShared(pCur) );
danielk1977da184232006-01-05 11:34:32 +00005173 assert( pCur->eState==CURSOR_VALID );
drh352a35a2017-08-15 03:46:47 +00005174 while( !(pPage = pCur->pPage)->leaf ){
drh43605152004-05-29 21:46:49 +00005175 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh75e96b32017-04-01 00:20:06 +00005176 pCur->ix = pPage->nCell;
drh8178a752003-01-05 21:41:40 +00005177 rc = moveToChild(pCur, pgno);
drhee6438d2014-09-01 13:29:32 +00005178 if( rc ) return rc;
drh2dcc9aa2002-12-04 13:40:25 +00005179 }
drh75e96b32017-04-01 00:20:06 +00005180 pCur->ix = pPage->nCell-1;
drhee6438d2014-09-01 13:29:32 +00005181 assert( pCur->info.nSize==0 );
5182 assert( (pCur->curFlags & BTCF_ValidNKey)==0 );
5183 return SQLITE_OK;
drh2dcc9aa2002-12-04 13:40:25 +00005184}
5185
drh5e00f6c2001-09-13 13:46:56 +00005186/* Move the cursor to the first entry in the table. Return SQLITE_OK
5187** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00005188** or set *pRes to 1 if the table is empty.
drh5e00f6c2001-09-13 13:46:56 +00005189*/
drh3aac2dd2004-04-26 14:10:20 +00005190int sqlite3BtreeFirst(BtCursor *pCur, int *pRes){
drh5e00f6c2001-09-13 13:46:56 +00005191 int rc;
drhd677b3d2007-08-20 22:48:41 +00005192
dan7a2347e2016-01-07 16:43:54 +00005193 assert( cursorOwnsBtShared(pCur) );
drhe5fe6902007-12-07 18:55:28 +00005194 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh5e00f6c2001-09-13 13:46:56 +00005195 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00005196 if( rc==SQLITE_OK ){
drh352a35a2017-08-15 03:46:47 +00005197 assert( pCur->pPage->nCell>0 );
drh44548e72017-08-14 18:13:52 +00005198 *pRes = 0;
5199 rc = moveToLeftmost(pCur);
5200 }else if( rc==SQLITE_EMPTY ){
drh352a35a2017-08-15 03:46:47 +00005201 assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
drh44548e72017-08-14 18:13:52 +00005202 *pRes = 1;
5203 rc = SQLITE_OK;
drh5e00f6c2001-09-13 13:46:56 +00005204 }
drh5e00f6c2001-09-13 13:46:56 +00005205 return rc;
5206}
drh5e2f8b92001-05-28 00:41:15 +00005207
danc0bb4452018-06-12 20:53:38 +00005208/*
5209** This function is a no-op if cursor pCur does not point to a valid row.
5210** Otherwise, if pCur is valid, configure it so that the next call to
5211** sqlite3BtreeNext() is a no-op.
5212*/
dan67a9b8e2018-06-22 20:51:35 +00005213#ifndef SQLITE_OMIT_WINDOWFUNC
danc3a20c12018-05-23 20:55:37 +00005214void sqlite3BtreeSkipNext(BtCursor *pCur){
drhf7103452018-07-09 20:41:39 +00005215 /* We believe that the cursor must always be in the valid state when
5216 ** this routine is called, but the proof is difficult, so we add an
5217 ** ALWaYS() test just in case we are wrong. */
5218 if( ALWAYS(pCur->eState==CURSOR_VALID) ){
danc3a20c12018-05-23 20:55:37 +00005219 pCur->eState = CURSOR_SKIPNEXT;
5220 pCur->skipNext = 1;
5221 }
5222}
dan67a9b8e2018-06-22 20:51:35 +00005223#endif /* SQLITE_OMIT_WINDOWFUNC */
danc3a20c12018-05-23 20:55:37 +00005224
drh9562b552002-02-19 15:00:07 +00005225/* Move the cursor to the last entry in the table. Return SQLITE_OK
5226** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00005227** or set *pRes to 1 if the table is empty.
drh9562b552002-02-19 15:00:07 +00005228*/
drh3aac2dd2004-04-26 14:10:20 +00005229int sqlite3BtreeLast(BtCursor *pCur, int *pRes){
drh9562b552002-02-19 15:00:07 +00005230 int rc;
drhd677b3d2007-08-20 22:48:41 +00005231
dan7a2347e2016-01-07 16:43:54 +00005232 assert( cursorOwnsBtShared(pCur) );
drhe5fe6902007-12-07 18:55:28 +00005233 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk19773f632d52009-05-02 10:03:09 +00005234
5235 /* If the cursor already points to the last entry, this is a no-op. */
drh036dbec2014-03-11 23:40:44 +00005236 if( CURSOR_VALID==pCur->eState && (pCur->curFlags & BTCF_AtLast)!=0 ){
danielk19773f632d52009-05-02 10:03:09 +00005237#ifdef SQLITE_DEBUG
5238 /* This block serves to assert() that the cursor really does point
5239 ** to the last entry in the b-tree. */
5240 int ii;
5241 for(ii=0; ii<pCur->iPage; ii++){
5242 assert( pCur->aiIdx[ii]==pCur->apPage[ii]->nCell );
5243 }
drh352a35a2017-08-15 03:46:47 +00005244 assert( pCur->ix==pCur->pPage->nCell-1 );
5245 assert( pCur->pPage->leaf );
danielk19773f632d52009-05-02 10:03:09 +00005246#endif
5247 return SQLITE_OK;
5248 }
5249
drh9562b552002-02-19 15:00:07 +00005250 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00005251 if( rc==SQLITE_OK ){
drh44548e72017-08-14 18:13:52 +00005252 assert( pCur->eState==CURSOR_VALID );
5253 *pRes = 0;
5254 rc = moveToRightmost(pCur);
5255 if( rc==SQLITE_OK ){
5256 pCur->curFlags |= BTCF_AtLast;
drhd677b3d2007-08-20 22:48:41 +00005257 }else{
drh44548e72017-08-14 18:13:52 +00005258 pCur->curFlags &= ~BTCF_AtLast;
drhd677b3d2007-08-20 22:48:41 +00005259 }
drh44548e72017-08-14 18:13:52 +00005260 }else if( rc==SQLITE_EMPTY ){
drh352a35a2017-08-15 03:46:47 +00005261 assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
drh44548e72017-08-14 18:13:52 +00005262 *pRes = 1;
5263 rc = SQLITE_OK;
drh9562b552002-02-19 15:00:07 +00005264 }
drh9562b552002-02-19 15:00:07 +00005265 return rc;
5266}
5267
drhe14006d2008-03-25 17:23:32 +00005268/* Move the cursor so that it points to an entry near the key
drhe63d9992008-08-13 19:11:48 +00005269** specified by pIdxKey or intKey. Return a success code.
drh72f82862001-05-24 21:06:34 +00005270**
drhe63d9992008-08-13 19:11:48 +00005271** For INTKEY tables, the intKey parameter is used. pIdxKey
5272** must be NULL. For index tables, pIdxKey is used and intKey
5273** is ignored.
drh3aac2dd2004-04-26 14:10:20 +00005274**
drh5e2f8b92001-05-28 00:41:15 +00005275** If an exact match is not found, then the cursor is always
drhbd03cae2001-06-02 02:40:57 +00005276** left pointing at a leaf page which would hold the entry if it
drh5e2f8b92001-05-28 00:41:15 +00005277** were present. The cursor might point to an entry that comes
5278** before or after the key.
5279**
drh64022502009-01-09 14:11:04 +00005280** An integer is written into *pRes which is the result of
5281** comparing the key with the entry to which the cursor is
5282** pointing. The meaning of the integer written into
5283** *pRes is as follows:
drhbd03cae2001-06-02 02:40:57 +00005284**
5285** *pRes<0 The cursor is left pointing at an entry that
drh64022502009-01-09 14:11:04 +00005286** is smaller than intKey/pIdxKey or if the table is empty
drh1a844c32002-12-04 22:29:28 +00005287** and the cursor is therefore left point to nothing.
drhbd03cae2001-06-02 02:40:57 +00005288**
5289** *pRes==0 The cursor is left pointing at an entry that
drh64022502009-01-09 14:11:04 +00005290** exactly matches intKey/pIdxKey.
drhbd03cae2001-06-02 02:40:57 +00005291**
5292** *pRes>0 The cursor is left pointing at an entry that
drh64022502009-01-09 14:11:04 +00005293** is larger than intKey/pIdxKey.
drhd677b3d2007-08-20 22:48:41 +00005294**
drhb1d607d2015-11-05 22:30:54 +00005295** For index tables, the pIdxKey->eqSeen field is set to 1 if there
5296** exists an entry in the table that exactly matches pIdxKey.
drha059ad02001-04-17 20:09:11 +00005297*/
drhe63d9992008-08-13 19:11:48 +00005298int sqlite3BtreeMovetoUnpacked(
5299 BtCursor *pCur, /* The cursor to be moved */
5300 UnpackedRecord *pIdxKey, /* Unpacked index key */
5301 i64 intKey, /* The table key */
5302 int biasRight, /* If true, bias the search to the high end */
5303 int *pRes /* Write search results here */
drhe4d90812007-03-29 05:51:49 +00005304){
drh72f82862001-05-24 21:06:34 +00005305 int rc;
dan3b9330f2014-02-27 20:44:18 +00005306 RecordCompare xRecordCompare;
drhd677b3d2007-08-20 22:48:41 +00005307
dan7a2347e2016-01-07 16:43:54 +00005308 assert( cursorOwnsBtShared(pCur) );
drhe5fe6902007-12-07 18:55:28 +00005309 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk19775cb09632009-07-09 11:36:01 +00005310 assert( pRes );
danielk19773fd7cf52009-07-13 07:30:52 +00005311 assert( (pIdxKey==0)==(pCur->pKeyInfo==0) );
drhdebaa862016-06-13 12:51:20 +00005312 assert( pCur->eState!=CURSOR_VALID || (pIdxKey==0)==(pCur->curIntKey!=0) );
drha2c20e42008-03-29 16:01:04 +00005313
5314 /* If the cursor is already positioned at the point we are trying
5315 ** to move to, then just return without doing any work */
drh05a36092016-06-06 01:54:20 +00005316 if( pIdxKey==0
5317 && pCur->eState==CURSOR_VALID && (pCur->curFlags & BTCF_ValidNKey)!=0
danielk197771d5d2c2008-09-29 11:49:47 +00005318 ){
drhe63d9992008-08-13 19:11:48 +00005319 if( pCur->info.nKey==intKey ){
drha2c20e42008-03-29 16:01:04 +00005320 *pRes = 0;
5321 return SQLITE_OK;
5322 }
drh451e76d2017-01-21 16:54:19 +00005323 if( pCur->info.nKey<intKey ){
5324 if( (pCur->curFlags & BTCF_AtLast)!=0 ){
5325 *pRes = -1;
5326 return SQLITE_OK;
5327 }
drh7f11afa2017-01-21 21:47:54 +00005328 /* If the requested key is one more than the previous key, then
5329 ** try to get there using sqlite3BtreeNext() rather than a full
5330 ** binary search. This is an optimization only. The correct answer
drh2ab792e2017-05-30 18:34:07 +00005331 ** is still obtained without this case, only a little more slowely */
drh7f11afa2017-01-21 21:47:54 +00005332 if( pCur->info.nKey+1==intKey && !pCur->skipNext ){
5333 *pRes = 0;
drh2ab792e2017-05-30 18:34:07 +00005334 rc = sqlite3BtreeNext(pCur, 0);
5335 if( rc==SQLITE_OK ){
drh7f11afa2017-01-21 21:47:54 +00005336 getCellInfo(pCur);
5337 if( pCur->info.nKey==intKey ){
5338 return SQLITE_OK;
5339 }
drh2ab792e2017-05-30 18:34:07 +00005340 }else if( rc==SQLITE_DONE ){
5341 rc = SQLITE_OK;
5342 }else{
5343 return rc;
drh451e76d2017-01-21 16:54:19 +00005344 }
5345 }
drha2c20e42008-03-29 16:01:04 +00005346 }
5347 }
5348
dan1fed5da2014-02-25 21:01:25 +00005349 if( pIdxKey ){
5350 xRecordCompare = sqlite3VdbeFindCompare(pIdxKey);
dan38fdead2014-04-01 10:19:02 +00005351 pIdxKey->errCode = 0;
dan3b9330f2014-02-27 20:44:18 +00005352 assert( pIdxKey->default_rc==1
5353 || pIdxKey->default_rc==0
5354 || pIdxKey->default_rc==-1
5355 );
drh13a747e2014-03-03 21:46:55 +00005356 }else{
drhb6e8fd12014-03-06 01:56:33 +00005357 xRecordCompare = 0; /* All keys are integers */
dan1fed5da2014-02-25 21:01:25 +00005358 }
5359
drh5e2f8b92001-05-28 00:41:15 +00005360 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00005361 if( rc ){
drh44548e72017-08-14 18:13:52 +00005362 if( rc==SQLITE_EMPTY ){
drh352a35a2017-08-15 03:46:47 +00005363 assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
drh44548e72017-08-14 18:13:52 +00005364 *pRes = -1;
5365 return SQLITE_OK;
5366 }
drhd677b3d2007-08-20 22:48:41 +00005367 return rc;
5368 }
drh352a35a2017-08-15 03:46:47 +00005369 assert( pCur->pPage );
5370 assert( pCur->pPage->isInit );
drh44548e72017-08-14 18:13:52 +00005371 assert( pCur->eState==CURSOR_VALID );
drh352a35a2017-08-15 03:46:47 +00005372 assert( pCur->pPage->nCell > 0 );
5373 assert( pCur->iPage==0 || pCur->apPage[0]->intKey==pCur->curIntKey );
drhc75d8862015-06-27 23:55:20 +00005374 assert( pCur->curIntKey || pIdxKey );
drh14684382006-11-30 13:05:29 +00005375 for(;;){
drhec3e6b12013-11-25 02:38:55 +00005376 int lwr, upr, idx, c;
drh72f82862001-05-24 21:06:34 +00005377 Pgno chldPg;
drh352a35a2017-08-15 03:46:47 +00005378 MemPage *pPage = pCur->pPage;
drhec3e6b12013-11-25 02:38:55 +00005379 u8 *pCell; /* Pointer to current cell in pPage */
danielk1977171fff32009-07-11 05:06:51 +00005380
5381 /* pPage->nCell must be greater than zero. If this is the root-page
5382 ** the cursor would have been INVALID above and this for(;;) loop
5383 ** not run. If this is not the root-page, then the moveToChild() routine
danielk19773fd7cf52009-07-13 07:30:52 +00005384 ** would have already detected db corruption. Similarly, pPage must
5385 ** be the right kind (index or table) of b-tree page. Otherwise
5386 ** a moveToChild() or moveToRoot() call would have detected corruption. */
danielk1977171fff32009-07-11 05:06:51 +00005387 assert( pPage->nCell>0 );
danielk19773fd7cf52009-07-13 07:30:52 +00005388 assert( pPage->intKey==(pIdxKey==0) );
drh72f82862001-05-24 21:06:34 +00005389 lwr = 0;
5390 upr = pPage->nCell-1;
drhebf10b12013-11-25 17:38:26 +00005391 assert( biasRight==0 || biasRight==1 );
5392 idx = upr>>(1-biasRight); /* idx = biasRight ? upr : (lwr+upr)/2; */
drh75e96b32017-04-01 00:20:06 +00005393 pCur->ix = (u16)idx;
dana4660bd2014-03-04 16:05:25 +00005394 if( xRecordCompare==0 ){
drhec3e6b12013-11-25 02:38:55 +00005395 for(;;){
danielk197711c327a2009-05-04 19:01:26 +00005396 i64 nCellKey;
drhf44890a2015-06-27 03:58:15 +00005397 pCell = findCellPastPtr(pPage, idx);
drh3e28ff52014-09-24 00:59:08 +00005398 if( pPage->intKeyLeaf ){
drh9b2fc612013-11-25 20:14:13 +00005399 while( 0x80 <= *(pCell++) ){
drhcc97ca42017-06-07 22:32:59 +00005400 if( pCell>=pPage->aDataEnd ){
daneebf2f52017-11-18 17:30:08 +00005401 return SQLITE_CORRUPT_PAGE(pPage);
drhcc97ca42017-06-07 22:32:59 +00005402 }
drh9b2fc612013-11-25 20:14:13 +00005403 }
drhd172f862006-01-12 15:01:15 +00005404 }
drha2c20e42008-03-29 16:01:04 +00005405 getVarint(pCell, (u64*)&nCellKey);
drhbb933ef2013-11-25 15:01:38 +00005406 if( nCellKey<intKey ){
5407 lwr = idx+1;
5408 if( lwr>upr ){ c = -1; break; }
5409 }else if( nCellKey>intKey ){
5410 upr = idx-1;
5411 if( lwr>upr ){ c = +1; break; }
5412 }else{
5413 assert( nCellKey==intKey );
drh75e96b32017-04-01 00:20:06 +00005414 pCur->ix = (u16)idx;
drhec3e6b12013-11-25 02:38:55 +00005415 if( !pPage->leaf ){
5416 lwr = idx;
drhebf10b12013-11-25 17:38:26 +00005417 goto moveto_next_layer;
drhec3e6b12013-11-25 02:38:55 +00005418 }else{
drhd95ef5c2016-11-11 18:19:05 +00005419 pCur->curFlags |= BTCF_ValidNKey;
5420 pCur->info.nKey = nCellKey;
5421 pCur->info.nSize = 0;
drhec3e6b12013-11-25 02:38:55 +00005422 *pRes = 0;
drhd95ef5c2016-11-11 18:19:05 +00005423 return SQLITE_OK;
drhec3e6b12013-11-25 02:38:55 +00005424 }
drhd793f442013-11-25 14:10:15 +00005425 }
drhebf10b12013-11-25 17:38:26 +00005426 assert( lwr+upr>=0 );
5427 idx = (lwr+upr)>>1; /* idx = (lwr+upr)/2; */
drhec3e6b12013-11-25 02:38:55 +00005428 }
5429 }else{
5430 for(;;){
drhc6827502015-05-28 15:14:32 +00005431 int nCell; /* Size of the pCell cell in bytes */
drhf44890a2015-06-27 03:58:15 +00005432 pCell = findCellPastPtr(pPage, idx);
drhec3e6b12013-11-25 02:38:55 +00005433
drhb2eced52010-08-12 02:41:12 +00005434 /* The maximum supported page-size is 65536 bytes. This means that
danielk197711c327a2009-05-04 19:01:26 +00005435 ** the maximum number of record bytes stored on an index B-Tree
drhb2eced52010-08-12 02:41:12 +00005436 ** page is less than 16384 bytes and may be stored as a 2-byte
danielk197711c327a2009-05-04 19:01:26 +00005437 ** varint. This information is used to attempt to avoid parsing
5438 ** the entire cell by checking for the cases where the record is
5439 ** stored entirely within the b-tree page by inspecting the first
5440 ** 2 bytes of the cell.
5441 */
drhec3e6b12013-11-25 02:38:55 +00005442 nCell = pCell[0];
drh72b8ef62013-12-06 22:44:51 +00005443 if( nCell<=pPage->max1bytePayload ){
danielk197711c327a2009-05-04 19:01:26 +00005444 /* This branch runs if the record-size field of the cell is a
5445 ** single byte varint and the record fits entirely on the main
5446 ** b-tree page. */
drh3def2352011-11-11 00:27:15 +00005447 testcase( pCell+nCell+1==pPage->aDataEnd );
drh75179de2014-09-16 14:37:35 +00005448 c = xRecordCompare(nCell, (void*)&pCell[1], pIdxKey);
danielk197711c327a2009-05-04 19:01:26 +00005449 }else if( !(pCell[1] & 0x80)
5450 && (nCell = ((nCell&0x7f)<<7) + pCell[1])<=pPage->maxLocal
5451 ){
5452 /* The record-size field is a 2 byte varint and the record
5453 ** fits entirely on the main b-tree page. */
drh3def2352011-11-11 00:27:15 +00005454 testcase( pCell+nCell+2==pPage->aDataEnd );
drh75179de2014-09-16 14:37:35 +00005455 c = xRecordCompare(nCell, (void*)&pCell[2], pIdxKey);
drhe51c44f2004-05-30 20:46:09 +00005456 }else{
danielk197711c327a2009-05-04 19:01:26 +00005457 /* The record flows over onto one or more overflow pages. In
5458 ** this case the whole cell needs to be parsed, a buffer allocated
5459 ** and accessPayload() used to retrieve the record into the
dan3548db72015-05-27 14:21:05 +00005460 ** buffer before VdbeRecordCompare() can be called.
5461 **
5462 ** If the record is corrupt, the xRecordCompare routine may read
5463 ** up to two varints past the end of the buffer. An extra 18
5464 ** bytes of padding is allocated at the end of the buffer in
5465 ** case this happens. */
danielk197711c327a2009-05-04 19:01:26 +00005466 void *pCellKey;
5467 u8 * const pCellBody = pCell - pPage->childPtrSize;
drh5fa60512015-06-19 17:19:34 +00005468 pPage->xParseCell(pPage, pCellBody, &pCur->info);
shane60a4b532009-05-06 18:57:09 +00005469 nCell = (int)pCur->info.nKey;
drhc6827502015-05-28 15:14:32 +00005470 testcase( nCell<0 ); /* True if key size is 2^32 or more */
5471 testcase( nCell==0 ); /* Invalid key size: 0x80 0x80 0x00 */
5472 testcase( nCell==1 ); /* Invalid key size: 0x80 0x80 0x01 */
5473 testcase( nCell==2 ); /* Minimum legal index key size */
dan3548db72015-05-27 14:21:05 +00005474 if( nCell<2 ){
daneebf2f52017-11-18 17:30:08 +00005475 rc = SQLITE_CORRUPT_PAGE(pPage);
dan3548db72015-05-27 14:21:05 +00005476 goto moveto_finish;
5477 }
5478 pCellKey = sqlite3Malloc( nCell+18 );
danielk19776507ecb2008-03-25 09:56:44 +00005479 if( pCellKey==0 ){
mistachkinfad30392016-02-13 23:43:46 +00005480 rc = SQLITE_NOMEM_BKPT;
danielk19776507ecb2008-03-25 09:56:44 +00005481 goto moveto_finish;
5482 }
drh75e96b32017-04-01 00:20:06 +00005483 pCur->ix = (u16)idx;
drh42e28f12017-01-27 00:31:59 +00005484 rc = accessPayload(pCur, 0, nCell, (unsigned char*)pCellKey, 0);
5485 pCur->curFlags &= ~BTCF_ValidOvfl;
drhec9b31f2009-08-25 13:53:49 +00005486 if( rc ){
5487 sqlite3_free(pCellKey);
5488 goto moveto_finish;
5489 }
drh75179de2014-09-16 14:37:35 +00005490 c = xRecordCompare(nCell, pCellKey, pIdxKey);
drhfacf0302008-06-17 15:12:00 +00005491 sqlite3_free(pCellKey);
drhe51c44f2004-05-30 20:46:09 +00005492 }
dan38fdead2014-04-01 10:19:02 +00005493 assert(
5494 (pIdxKey->errCode!=SQLITE_CORRUPT || c==0)
dana7bf23c2014-05-02 17:12:41 +00005495 && (pIdxKey->errCode!=SQLITE_NOMEM || pCur->pBtree->db->mallocFailed)
dan38fdead2014-04-01 10:19:02 +00005496 );
drhbb933ef2013-11-25 15:01:38 +00005497 if( c<0 ){
5498 lwr = idx+1;
5499 }else if( c>0 ){
5500 upr = idx-1;
5501 }else{
5502 assert( c==0 );
drh64022502009-01-09 14:11:04 +00005503 *pRes = 0;
drh1e968a02008-03-25 00:22:21 +00005504 rc = SQLITE_OK;
drh75e96b32017-04-01 00:20:06 +00005505 pCur->ix = (u16)idx;
mistachkin88a79732017-09-04 19:31:54 +00005506 if( pIdxKey->errCode ) rc = SQLITE_CORRUPT_BKPT;
drh1e968a02008-03-25 00:22:21 +00005507 goto moveto_finish;
drh8b18dd42004-05-12 19:18:15 +00005508 }
drhebf10b12013-11-25 17:38:26 +00005509 if( lwr>upr ) break;
5510 assert( lwr+upr>=0 );
5511 idx = (lwr+upr)>>1; /* idx = (lwr+upr)/2 */
drh72f82862001-05-24 21:06:34 +00005512 }
drh72f82862001-05-24 21:06:34 +00005513 }
drhb07028f2011-10-14 21:49:18 +00005514 assert( lwr==upr+1 || (pPage->intKey && !pPage->leaf) );
danielk197771d5d2c2008-09-29 11:49:47 +00005515 assert( pPage->isInit );
drh3aac2dd2004-04-26 14:10:20 +00005516 if( pPage->leaf ){
drh352a35a2017-08-15 03:46:47 +00005517 assert( pCur->ix<pCur->pPage->nCell );
drh75e96b32017-04-01 00:20:06 +00005518 pCur->ix = (u16)idx;
drhec3e6b12013-11-25 02:38:55 +00005519 *pRes = c;
5520 rc = SQLITE_OK;
5521 goto moveto_finish;
drhebf10b12013-11-25 17:38:26 +00005522 }
5523moveto_next_layer:
5524 if( lwr>=pPage->nCell ){
drh43605152004-05-29 21:46:49 +00005525 chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh72f82862001-05-24 21:06:34 +00005526 }else{
danielk19771cc5ed82007-05-16 17:28:43 +00005527 chldPg = get4byte(findCell(pPage, lwr));
drh72f82862001-05-24 21:06:34 +00005528 }
drh75e96b32017-04-01 00:20:06 +00005529 pCur->ix = (u16)lwr;
drh8178a752003-01-05 21:41:40 +00005530 rc = moveToChild(pCur, chldPg);
drhec3e6b12013-11-25 02:38:55 +00005531 if( rc ) break;
drh72f82862001-05-24 21:06:34 +00005532 }
drh1e968a02008-03-25 00:22:21 +00005533moveto_finish:
drhd2022b02013-11-25 16:23:52 +00005534 pCur->info.nSize = 0;
drhd95ef5c2016-11-11 18:19:05 +00005535 assert( (pCur->curFlags & BTCF_ValidOvfl)==0 );
drhe63d9992008-08-13 19:11:48 +00005536 return rc;
5537}
5538
drhd677b3d2007-08-20 22:48:41 +00005539
drh72f82862001-05-24 21:06:34 +00005540/*
drhc39e0002004-05-07 23:50:57 +00005541** Return TRUE if the cursor is not pointing at an entry of the table.
5542**
5543** TRUE will be returned after a call to sqlite3BtreeNext() moves
5544** past the last entry in the table or sqlite3BtreePrev() moves past
5545** the first entry. TRUE is also returned if the table is empty.
5546*/
5547int sqlite3BtreeEof(BtCursor *pCur){
danielk1977da184232006-01-05 11:34:32 +00005548 /* TODO: What if the cursor is in CURSOR_REQUIRESEEK but all table entries
5549 ** have been deleted? This API will need to change to return an error code
5550 ** as well as the boolean result value.
5551 */
5552 return (CURSOR_VALID!=pCur->eState);
drhc39e0002004-05-07 23:50:57 +00005553}
5554
5555/*
drh5e98e832017-02-17 19:24:06 +00005556** Return an estimate for the number of rows in the table that pCur is
5557** pointing to. Return a negative number if no estimate is currently
5558** available.
5559*/
5560i64 sqlite3BtreeRowCountEst(BtCursor *pCur){
5561 i64 n;
5562 u8 i;
5563
5564 assert( cursorOwnsBtShared(pCur) );
5565 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh555227b2017-02-23 02:15:33 +00005566
5567 /* Currently this interface is only called by the OP_IfSmaller
5568 ** opcode, and it that case the cursor will always be valid and
5569 ** will always point to a leaf node. */
5570 if( NEVER(pCur->eState!=CURSOR_VALID) ) return -1;
drh352a35a2017-08-15 03:46:47 +00005571 if( NEVER(pCur->pPage->leaf==0) ) return -1;
drh555227b2017-02-23 02:15:33 +00005572
drh352a35a2017-08-15 03:46:47 +00005573 n = pCur->pPage->nCell;
5574 for(i=0; i<pCur->iPage; i++){
drh5e98e832017-02-17 19:24:06 +00005575 n *= pCur->apPage[i]->nCell;
5576 }
5577 return n;
5578}
5579
5580/*
drh2ab792e2017-05-30 18:34:07 +00005581** Advance the cursor to the next entry in the database.
5582** Return value:
5583**
5584** SQLITE_OK success
5585** SQLITE_DONE cursor is already pointing at the last element
5586** otherwise some kind of error occurred
drhe39a7322014-02-03 14:04:11 +00005587**
drhee6438d2014-09-01 13:29:32 +00005588** The main entry point is sqlite3BtreeNext(). That routine is optimized
5589** for the common case of merely incrementing the cell counter BtCursor.aiIdx
5590** to the next cell on the current page. The (slower) btreeNext() helper
5591** routine is called when it is necessary to move to a different page or
5592** to restore the cursor.
5593**
drh89997982017-07-11 18:11:33 +00005594** If bit 0x01 of the F argument in sqlite3BtreeNext(C,F) is 1, then the
5595** cursor corresponds to an SQL index and this routine could have been
5596** skipped if the SQL index had been a unique index. The F argument
5597** is a hint to the implement. SQLite btree implementation does not use
5598** this hint, but COMDB2 does.
drh72f82862001-05-24 21:06:34 +00005599*/
drh89997982017-07-11 18:11:33 +00005600static SQLITE_NOINLINE int btreeNext(BtCursor *pCur){
drh72f82862001-05-24 21:06:34 +00005601 int rc;
danielk197771d5d2c2008-09-29 11:49:47 +00005602 int idx;
danielk197797a227c2006-01-20 16:32:04 +00005603 MemPage *pPage;
drh8b18dd42004-05-12 19:18:15 +00005604
dan7a2347e2016-01-07 16:43:54 +00005605 assert( cursorOwnsBtShared(pCur) );
drh9b47ee32013-08-20 03:13:51 +00005606 assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
drhf66f26a2013-08-19 20:04:10 +00005607 if( pCur->eState!=CURSOR_VALID ){
drhee6438d2014-09-01 13:29:32 +00005608 assert( (pCur->curFlags & BTCF_ValidOvfl)==0 );
drhf66f26a2013-08-19 20:04:10 +00005609 rc = restoreCursorPosition(pCur);
5610 if( rc!=SQLITE_OK ){
5611 return rc;
5612 }
5613 if( CURSOR_INVALID==pCur->eState ){
drh2ab792e2017-05-30 18:34:07 +00005614 return SQLITE_DONE;
drhf66f26a2013-08-19 20:04:10 +00005615 }
drh9b47ee32013-08-20 03:13:51 +00005616 if( pCur->skipNext ){
5617 assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_SKIPNEXT );
5618 pCur->eState = CURSOR_VALID;
5619 if( pCur->skipNext>0 ){
5620 pCur->skipNext = 0;
drh9b47ee32013-08-20 03:13:51 +00005621 return SQLITE_OK;
5622 }
drhf66f26a2013-08-19 20:04:10 +00005623 pCur->skipNext = 0;
drhf66f26a2013-08-19 20:04:10 +00005624 }
danielk1977da184232006-01-05 11:34:32 +00005625 }
danielk1977da184232006-01-05 11:34:32 +00005626
drh352a35a2017-08-15 03:46:47 +00005627 pPage = pCur->pPage;
drh75e96b32017-04-01 00:20:06 +00005628 idx = ++pCur->ix;
drhf3cd0c82018-06-08 19:13:57 +00005629 if( !pPage->isInit ){
5630 /* The only known way for this to happen is for there to be a
5631 ** recursive SQL function that does a DELETE operation as part of a
5632 ** SELECT which deletes content out from under an active cursor
5633 ** in a corrupt database file where the table being DELETE-ed from
5634 ** has pages in common with the table being queried. See TH3
5635 ** module cov1/btree78.test testcase 220 (2018-06-08) for an
5636 ** example. */
5637 return SQLITE_CORRUPT_BKPT;
5638 }
danbb246c42012-01-12 14:25:55 +00005639
5640 /* If the database file is corrupt, it is possible for the value of idx
5641 ** to be invalid here. This can only occur if a second cursor modifies
5642 ** the page while cursor pCur is holding a reference to it. Which can
5643 ** only happen if the database is corrupt in such a way as to link the
5644 ** page into more than one b-tree structure. */
5645 testcase( idx>pPage->nCell );
danielk19776a43f9b2004-11-16 04:57:24 +00005646
danielk197771d5d2c2008-09-29 11:49:47 +00005647 if( idx>=pPage->nCell ){
drha34b6762004-05-07 13:30:42 +00005648 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005649 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
drhee6438d2014-09-01 13:29:32 +00005650 if( rc ) return rc;
5651 return moveToLeftmost(pCur);
drh72f82862001-05-24 21:06:34 +00005652 }
drh5e2f8b92001-05-28 00:41:15 +00005653 do{
danielk197771d5d2c2008-09-29 11:49:47 +00005654 if( pCur->iPage==0 ){
danielk1977da184232006-01-05 11:34:32 +00005655 pCur->eState = CURSOR_INVALID;
drh2ab792e2017-05-30 18:34:07 +00005656 return SQLITE_DONE;
drh5e2f8b92001-05-28 00:41:15 +00005657 }
danielk197730548662009-07-09 05:07:37 +00005658 moveToParent(pCur);
drh352a35a2017-08-15 03:46:47 +00005659 pPage = pCur->pPage;
drh75e96b32017-04-01 00:20:06 +00005660 }while( pCur->ix>=pPage->nCell );
drh44845222008-07-17 18:39:57 +00005661 if( pPage->intKey ){
drh89997982017-07-11 18:11:33 +00005662 return sqlite3BtreeNext(pCur, 0);
drh8b18dd42004-05-12 19:18:15 +00005663 }else{
drhee6438d2014-09-01 13:29:32 +00005664 return SQLITE_OK;
drh8b18dd42004-05-12 19:18:15 +00005665 }
drh8178a752003-01-05 21:41:40 +00005666 }
drh3aac2dd2004-04-26 14:10:20 +00005667 if( pPage->leaf ){
drh8178a752003-01-05 21:41:40 +00005668 return SQLITE_OK;
drhee6438d2014-09-01 13:29:32 +00005669 }else{
5670 return moveToLeftmost(pCur);
drh72f82862001-05-24 21:06:34 +00005671 }
drh72f82862001-05-24 21:06:34 +00005672}
drh2ab792e2017-05-30 18:34:07 +00005673int sqlite3BtreeNext(BtCursor *pCur, int flags){
drhee6438d2014-09-01 13:29:32 +00005674 MemPage *pPage;
drh89997982017-07-11 18:11:33 +00005675 UNUSED_PARAMETER( flags ); /* Used in COMDB2 but not native SQLite */
dan7a2347e2016-01-07 16:43:54 +00005676 assert( cursorOwnsBtShared(pCur) );
drh2ab792e2017-05-30 18:34:07 +00005677 assert( flags==0 || flags==1 );
drhee6438d2014-09-01 13:29:32 +00005678 assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
5679 pCur->info.nSize = 0;
5680 pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
drh89997982017-07-11 18:11:33 +00005681 if( pCur->eState!=CURSOR_VALID ) return btreeNext(pCur);
drh352a35a2017-08-15 03:46:47 +00005682 pPage = pCur->pPage;
drh75e96b32017-04-01 00:20:06 +00005683 if( (++pCur->ix)>=pPage->nCell ){
5684 pCur->ix--;
drh89997982017-07-11 18:11:33 +00005685 return btreeNext(pCur);
drhee6438d2014-09-01 13:29:32 +00005686 }
5687 if( pPage->leaf ){
5688 return SQLITE_OK;
5689 }else{
5690 return moveToLeftmost(pCur);
5691 }
5692}
drh72f82862001-05-24 21:06:34 +00005693
drh3b7511c2001-05-26 13:15:44 +00005694/*
drh2ab792e2017-05-30 18:34:07 +00005695** Step the cursor to the back to the previous entry in the database.
5696** Return values:
5697**
5698** SQLITE_OK success
5699** SQLITE_DONE the cursor is already on the first element of the table
5700** otherwise some kind of error occurred
drhe39a7322014-02-03 14:04:11 +00005701**
drhee6438d2014-09-01 13:29:32 +00005702** The main entry point is sqlite3BtreePrevious(). That routine is optimized
5703** for the common case of merely decrementing the cell counter BtCursor.aiIdx
drh3f387402014-09-24 01:23:00 +00005704** to the previous cell on the current page. The (slower) btreePrevious()
5705** helper routine is called when it is necessary to move to a different page
5706** or to restore the cursor.
drhee6438d2014-09-01 13:29:32 +00005707**
drh89997982017-07-11 18:11:33 +00005708** If bit 0x01 of the F argument to sqlite3BtreePrevious(C,F) is 1, then
5709** the cursor corresponds to an SQL index and this routine could have been
5710** skipped if the SQL index had been a unique index. The F argument is a
5711** hint to the implement. The native SQLite btree implementation does not
5712** use this hint, but COMDB2 does.
drh2dcc9aa2002-12-04 13:40:25 +00005713*/
drh89997982017-07-11 18:11:33 +00005714static SQLITE_NOINLINE int btreePrevious(BtCursor *pCur){
drh2dcc9aa2002-12-04 13:40:25 +00005715 int rc;
drh8178a752003-01-05 21:41:40 +00005716 MemPage *pPage;
danielk1977da184232006-01-05 11:34:32 +00005717
dan7a2347e2016-01-07 16:43:54 +00005718 assert( cursorOwnsBtShared(pCur) );
drh9b47ee32013-08-20 03:13:51 +00005719 assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
drhee6438d2014-09-01 13:29:32 +00005720 assert( (pCur->curFlags & (BTCF_AtLast|BTCF_ValidOvfl|BTCF_ValidNKey))==0 );
5721 assert( pCur->info.nSize==0 );
drhf66f26a2013-08-19 20:04:10 +00005722 if( pCur->eState!=CURSOR_VALID ){
drh7682a472014-09-29 15:00:28 +00005723 rc = restoreCursorPosition(pCur);
drhee6438d2014-09-01 13:29:32 +00005724 if( rc!=SQLITE_OK ){
5725 return rc;
drhf66f26a2013-08-19 20:04:10 +00005726 }
5727 if( CURSOR_INVALID==pCur->eState ){
drh2ab792e2017-05-30 18:34:07 +00005728 return SQLITE_DONE;
drhf66f26a2013-08-19 20:04:10 +00005729 }
drh9b47ee32013-08-20 03:13:51 +00005730 if( pCur->skipNext ){
5731 assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_SKIPNEXT );
5732 pCur->eState = CURSOR_VALID;
5733 if( pCur->skipNext<0 ){
5734 pCur->skipNext = 0;
drh9b47ee32013-08-20 03:13:51 +00005735 return SQLITE_OK;
5736 }
drhf66f26a2013-08-19 20:04:10 +00005737 pCur->skipNext = 0;
drhf66f26a2013-08-19 20:04:10 +00005738 }
danielk1977da184232006-01-05 11:34:32 +00005739 }
danielk1977da184232006-01-05 11:34:32 +00005740
drh352a35a2017-08-15 03:46:47 +00005741 pPage = pCur->pPage;
danielk197771d5d2c2008-09-29 11:49:47 +00005742 assert( pPage->isInit );
drha34b6762004-05-07 13:30:42 +00005743 if( !pPage->leaf ){
drh75e96b32017-04-01 00:20:06 +00005744 int idx = pCur->ix;
danielk197771d5d2c2008-09-29 11:49:47 +00005745 rc = moveToChild(pCur, get4byte(findCell(pPage, idx)));
drhee6438d2014-09-01 13:29:32 +00005746 if( rc ) return rc;
drh2dcc9aa2002-12-04 13:40:25 +00005747 rc = moveToRightmost(pCur);
5748 }else{
drh75e96b32017-04-01 00:20:06 +00005749 while( pCur->ix==0 ){
danielk197771d5d2c2008-09-29 11:49:47 +00005750 if( pCur->iPage==0 ){
danielk1977da184232006-01-05 11:34:32 +00005751 pCur->eState = CURSOR_INVALID;
drh2ab792e2017-05-30 18:34:07 +00005752 return SQLITE_DONE;
drh2dcc9aa2002-12-04 13:40:25 +00005753 }
danielk197730548662009-07-09 05:07:37 +00005754 moveToParent(pCur);
drh2dcc9aa2002-12-04 13:40:25 +00005755 }
drhee6438d2014-09-01 13:29:32 +00005756 assert( pCur->info.nSize==0 );
drhd95ef5c2016-11-11 18:19:05 +00005757 assert( (pCur->curFlags & (BTCF_ValidOvfl))==0 );
danielk197771d5d2c2008-09-29 11:49:47 +00005758
drh75e96b32017-04-01 00:20:06 +00005759 pCur->ix--;
drh352a35a2017-08-15 03:46:47 +00005760 pPage = pCur->pPage;
drh44845222008-07-17 18:39:57 +00005761 if( pPage->intKey && !pPage->leaf ){
drh89997982017-07-11 18:11:33 +00005762 rc = sqlite3BtreePrevious(pCur, 0);
drh8b18dd42004-05-12 19:18:15 +00005763 }else{
5764 rc = SQLITE_OK;
5765 }
drh2dcc9aa2002-12-04 13:40:25 +00005766 }
drh2dcc9aa2002-12-04 13:40:25 +00005767 return rc;
5768}
drh2ab792e2017-05-30 18:34:07 +00005769int sqlite3BtreePrevious(BtCursor *pCur, int flags){
dan7a2347e2016-01-07 16:43:54 +00005770 assert( cursorOwnsBtShared(pCur) );
drh2ab792e2017-05-30 18:34:07 +00005771 assert( flags==0 || flags==1 );
drhee6438d2014-09-01 13:29:32 +00005772 assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
drh89997982017-07-11 18:11:33 +00005773 UNUSED_PARAMETER( flags ); /* Used in COMDB2 but not native SQLite */
drhee6438d2014-09-01 13:29:32 +00005774 pCur->curFlags &= ~(BTCF_AtLast|BTCF_ValidOvfl|BTCF_ValidNKey);
5775 pCur->info.nSize = 0;
5776 if( pCur->eState!=CURSOR_VALID
drh75e96b32017-04-01 00:20:06 +00005777 || pCur->ix==0
drh352a35a2017-08-15 03:46:47 +00005778 || pCur->pPage->leaf==0
drhee6438d2014-09-01 13:29:32 +00005779 ){
drh89997982017-07-11 18:11:33 +00005780 return btreePrevious(pCur);
drhee6438d2014-09-01 13:29:32 +00005781 }
drh75e96b32017-04-01 00:20:06 +00005782 pCur->ix--;
drhee6438d2014-09-01 13:29:32 +00005783 return SQLITE_OK;
5784}
drh2dcc9aa2002-12-04 13:40:25 +00005785
5786/*
drh3b7511c2001-05-26 13:15:44 +00005787** Allocate a new page from the database file.
5788**
danielk19773b8a05f2007-03-19 17:44:26 +00005789** The new page is marked as dirty. (In other words, sqlite3PagerWrite()
drh3b7511c2001-05-26 13:15:44 +00005790** has already been called on the new page.) The new page has also
5791** been referenced and the calling routine is responsible for calling
danielk19773b8a05f2007-03-19 17:44:26 +00005792** sqlite3PagerUnref() on the new page when it is done.
drh3b7511c2001-05-26 13:15:44 +00005793**
5794** SQLITE_OK is returned on success. Any other return value indicates
drh1c8bade2015-05-29 18:42:11 +00005795** an error. *ppPage is set to NULL in the event of an error.
drhbea00b92002-07-08 10:59:50 +00005796**
drh82e647d2013-03-02 03:25:55 +00005797** If the "nearby" parameter is not 0, then an effort is made to
drh199e3cf2002-07-18 11:01:47 +00005798** locate a page close to the page number "nearby". This can be used in an
drhbea00b92002-07-08 10:59:50 +00005799** attempt to keep related pages close to each other in the database file,
5800** which in turn can make database access faster.
danielk1977cb1a7eb2004-11-05 12:27:02 +00005801**
drh82e647d2013-03-02 03:25:55 +00005802** If the eMode parameter is BTALLOC_EXACT and the nearby page exists
5803** anywhere on the free-list, then it is guaranteed to be returned. If
5804** eMode is BTALLOC_LT then the page returned will be less than or equal
5805** to nearby if any such page exists. If eMode is BTALLOC_ANY then there
5806** are no restrictions on which page is returned.
drh3b7511c2001-05-26 13:15:44 +00005807*/
drh4f0c5872007-03-26 22:05:01 +00005808static int allocateBtreePage(
drh82e647d2013-03-02 03:25:55 +00005809 BtShared *pBt, /* The btree */
5810 MemPage **ppPage, /* Store pointer to the allocated page here */
5811 Pgno *pPgno, /* Store the page number here */
5812 Pgno nearby, /* Search for a page near this one */
5813 u8 eMode /* BTALLOC_EXACT, BTALLOC_LT, or BTALLOC_ANY */
danielk1977cb1a7eb2004-11-05 12:27:02 +00005814){
drh3aac2dd2004-04-26 14:10:20 +00005815 MemPage *pPage1;
drh8c42ca92001-06-22 19:15:00 +00005816 int rc;
drh35cd6432009-06-05 14:17:21 +00005817 u32 n; /* Number of pages on the freelist */
drh042d6a12009-06-17 13:57:16 +00005818 u32 k; /* Number of leaves on the trunk of the freelist */
drhd3627af2006-12-18 18:34:51 +00005819 MemPage *pTrunk = 0;
5820 MemPage *pPrevTrunk = 0;
drh1662b5a2009-06-04 19:06:09 +00005821 Pgno mxPage; /* Total size of the database file */
drh30e58752002-03-02 20:41:57 +00005822
drh1fee73e2007-08-29 04:00:57 +00005823 assert( sqlite3_mutex_held(pBt->mutex) );
dan09ff9e12013-03-11 11:49:03 +00005824 assert( eMode==BTALLOC_ANY || (nearby>0 && IfNotOmitAV(pBt->autoVacuum)) );
drh3aac2dd2004-04-26 14:10:20 +00005825 pPage1 = pBt->pPage1;
drhb1299152010-03-30 22:58:33 +00005826 mxPage = btreePagecount(pBt);
drh113762a2014-11-19 16:36:25 +00005827 /* EVIDENCE-OF: R-05119-02637 The 4-byte big-endian integer at offset 36
5828 ** stores stores the total number of pages on the freelist. */
drh3aac2dd2004-04-26 14:10:20 +00005829 n = get4byte(&pPage1->aData[36]);
drhdf35a082009-07-09 02:24:35 +00005830 testcase( n==mxPage-1 );
5831 if( n>=mxPage ){
drh1662b5a2009-06-04 19:06:09 +00005832 return SQLITE_CORRUPT_BKPT;
5833 }
drh3aac2dd2004-04-26 14:10:20 +00005834 if( n>0 ){
drh91025292004-05-03 19:49:32 +00005835 /* There are pages on the freelist. Reuse one of those pages. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00005836 Pgno iTrunk;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005837 u8 searchList = 0; /* If the free-list must be searched for 'nearby' */
drhc6e956f2015-06-24 13:32:10 +00005838 u32 nSearch = 0; /* Count of the number of search attempts */
danielk1977cb1a7eb2004-11-05 12:27:02 +00005839
drh82e647d2013-03-02 03:25:55 +00005840 /* If eMode==BTALLOC_EXACT and a query of the pointer-map
danielk1977cb1a7eb2004-11-05 12:27:02 +00005841 ** shows that the page 'nearby' is somewhere on the free-list, then
5842 ** the entire-list will be searched for that page.
5843 */
5844#ifndef SQLITE_OMIT_AUTOVACUUM
dan51f0b6d2013-02-22 20:16:34 +00005845 if( eMode==BTALLOC_EXACT ){
5846 if( nearby<=mxPage ){
5847 u8 eType;
5848 assert( nearby>0 );
5849 assert( pBt->autoVacuum );
5850 rc = ptrmapGet(pBt, nearby, &eType, 0);
5851 if( rc ) return rc;
5852 if( eType==PTRMAP_FREEPAGE ){
5853 searchList = 1;
5854 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00005855 }
dan51f0b6d2013-02-22 20:16:34 +00005856 }else if( eMode==BTALLOC_LE ){
5857 searchList = 1;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005858 }
5859#endif
5860
5861 /* Decrement the free-list count by 1. Set iTrunk to the index of the
5862 ** first free-list trunk page. iPrevTrunk is initially 1.
5863 */
danielk19773b8a05f2007-03-19 17:44:26 +00005864 rc = sqlite3PagerWrite(pPage1->pDbPage);
drh3b7511c2001-05-26 13:15:44 +00005865 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00005866 put4byte(&pPage1->aData[36], n-1);
danielk1977cb1a7eb2004-11-05 12:27:02 +00005867
5868 /* The code within this loop is run only once if the 'searchList' variable
5869 ** is not true. Otherwise, it runs once for each trunk-page on the
drh82e647d2013-03-02 03:25:55 +00005870 ** free-list until the page 'nearby' is located (eMode==BTALLOC_EXACT)
5871 ** or until a page less than 'nearby' is located (eMode==BTALLOC_LT)
danielk1977cb1a7eb2004-11-05 12:27:02 +00005872 */
5873 do {
5874 pPrevTrunk = pTrunk;
5875 if( pPrevTrunk ){
drh113762a2014-11-19 16:36:25 +00005876 /* EVIDENCE-OF: R-01506-11053 The first integer on a freelist trunk page
5877 ** is the page number of the next freelist trunk page in the list or
5878 ** zero if this is the last freelist trunk page. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00005879 iTrunk = get4byte(&pPrevTrunk->aData[0]);
drhbea00b92002-07-08 10:59:50 +00005880 }else{
drh113762a2014-11-19 16:36:25 +00005881 /* EVIDENCE-OF: R-59841-13798 The 4-byte big-endian integer at offset 32
5882 ** stores the page number of the first page of the freelist, or zero if
5883 ** the freelist is empty. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00005884 iTrunk = get4byte(&pPage1->aData[32]);
drhbea00b92002-07-08 10:59:50 +00005885 }
drhdf35a082009-07-09 02:24:35 +00005886 testcase( iTrunk==mxPage );
drh9e7804d2015-06-24 12:24:03 +00005887 if( iTrunk>mxPage || nSearch++ > n ){
drhc62aab52017-06-11 18:26:15 +00005888 rc = SQLITE_CORRUPT_PGNO(pPrevTrunk ? pPrevTrunk->pgno : 1);
drh1662b5a2009-06-04 19:06:09 +00005889 }else{
drh7e8c6f12015-05-28 03:28:27 +00005890 rc = btreeGetUnusedPage(pBt, iTrunk, &pTrunk, 0);
drh1662b5a2009-06-04 19:06:09 +00005891 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00005892 if( rc ){
drhd3627af2006-12-18 18:34:51 +00005893 pTrunk = 0;
5894 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005895 }
drhb07028f2011-10-14 21:49:18 +00005896 assert( pTrunk!=0 );
5897 assert( pTrunk->aData!=0 );
drh113762a2014-11-19 16:36:25 +00005898 /* EVIDENCE-OF: R-13523-04394 The second integer on a freelist trunk page
5899 ** is the number of leaf page pointers to follow. */
5900 k = get4byte(&pTrunk->aData[4]);
danielk1977cb1a7eb2004-11-05 12:27:02 +00005901 if( k==0 && !searchList ){
5902 /* The trunk has no leaves and the list is not being searched.
5903 ** So extract the trunk page itself and use it as the newly
5904 ** allocated page */
5905 assert( pPrevTrunk==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00005906 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00005907 if( rc ){
5908 goto end_allocate_page;
5909 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00005910 *pPgno = iTrunk;
5911 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
5912 *ppPage = pTrunk;
5913 pTrunk = 0;
5914 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
drh042d6a12009-06-17 13:57:16 +00005915 }else if( k>(u32)(pBt->usableSize/4 - 2) ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00005916 /* Value of k is out of range. Database corruption */
drhcc97ca42017-06-07 22:32:59 +00005917 rc = SQLITE_CORRUPT_PGNO(iTrunk);
drhd3627af2006-12-18 18:34:51 +00005918 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005919#ifndef SQLITE_OMIT_AUTOVACUUM
dan51f0b6d2013-02-22 20:16:34 +00005920 }else if( searchList
5921 && (nearby==iTrunk || (iTrunk<nearby && eMode==BTALLOC_LE))
5922 ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00005923 /* The list is being searched and this trunk page is the page
5924 ** to allocate, regardless of whether it has leaves.
5925 */
dan51f0b6d2013-02-22 20:16:34 +00005926 *pPgno = iTrunk;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005927 *ppPage = pTrunk;
5928 searchList = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00005929 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00005930 if( rc ){
5931 goto end_allocate_page;
5932 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00005933 if( k==0 ){
5934 if( !pPrevTrunk ){
5935 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
5936 }else{
danf48c3552010-08-23 15:41:24 +00005937 rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
5938 if( rc!=SQLITE_OK ){
5939 goto end_allocate_page;
5940 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00005941 memcpy(&pPrevTrunk->aData[0], &pTrunk->aData[0], 4);
5942 }
5943 }else{
5944 /* The trunk page is required by the caller but it contains
5945 ** pointers to free-list leaves. The first leaf becomes a trunk
5946 ** page in this case.
5947 */
5948 MemPage *pNewTrunk;
5949 Pgno iNewTrunk = get4byte(&pTrunk->aData[8]);
drh1662b5a2009-06-04 19:06:09 +00005950 if( iNewTrunk>mxPage ){
drhcc97ca42017-06-07 22:32:59 +00005951 rc = SQLITE_CORRUPT_PGNO(iTrunk);
drh1662b5a2009-06-04 19:06:09 +00005952 goto end_allocate_page;
5953 }
drhdf35a082009-07-09 02:24:35 +00005954 testcase( iNewTrunk==mxPage );
drh7e8c6f12015-05-28 03:28:27 +00005955 rc = btreeGetUnusedPage(pBt, iNewTrunk, &pNewTrunk, 0);
danielk1977cb1a7eb2004-11-05 12:27:02 +00005956 if( rc!=SQLITE_OK ){
drhd3627af2006-12-18 18:34:51 +00005957 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005958 }
danielk19773b8a05f2007-03-19 17:44:26 +00005959 rc = sqlite3PagerWrite(pNewTrunk->pDbPage);
danielk1977cb1a7eb2004-11-05 12:27:02 +00005960 if( rc!=SQLITE_OK ){
5961 releasePage(pNewTrunk);
drhd3627af2006-12-18 18:34:51 +00005962 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005963 }
5964 memcpy(&pNewTrunk->aData[0], &pTrunk->aData[0], 4);
5965 put4byte(&pNewTrunk->aData[4], k-1);
5966 memcpy(&pNewTrunk->aData[8], &pTrunk->aData[12], (k-1)*4);
drhd3627af2006-12-18 18:34:51 +00005967 releasePage(pNewTrunk);
danielk1977cb1a7eb2004-11-05 12:27:02 +00005968 if( !pPrevTrunk ){
drhc5053fb2008-11-27 02:22:10 +00005969 assert( sqlite3PagerIswriteable(pPage1->pDbPage) );
danielk1977cb1a7eb2004-11-05 12:27:02 +00005970 put4byte(&pPage1->aData[32], iNewTrunk);
5971 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00005972 rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00005973 if( rc ){
5974 goto end_allocate_page;
5975 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00005976 put4byte(&pPrevTrunk->aData[0], iNewTrunk);
5977 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00005978 }
5979 pTrunk = 0;
5980 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
5981#endif
danielk1977e5765212009-06-17 11:13:28 +00005982 }else if( k>0 ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00005983 /* Extract a leaf from the trunk */
drh042d6a12009-06-17 13:57:16 +00005984 u32 closest;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005985 Pgno iPage;
5986 unsigned char *aData = pTrunk->aData;
5987 if( nearby>0 ){
drh042d6a12009-06-17 13:57:16 +00005988 u32 i;
danielk1977cb1a7eb2004-11-05 12:27:02 +00005989 closest = 0;
danf38b65a2013-02-22 20:57:47 +00005990 if( eMode==BTALLOC_LE ){
5991 for(i=0; i<k; i++){
5992 iPage = get4byte(&aData[8+i*4]);
dan87ade192013-02-23 17:49:16 +00005993 if( iPage<=nearby ){
danf38b65a2013-02-22 20:57:47 +00005994 closest = i;
5995 break;
5996 }
5997 }
5998 }else{
5999 int dist;
6000 dist = sqlite3AbsInt32(get4byte(&aData[8]) - nearby);
6001 for(i=1; i<k; i++){
6002 int d2 = sqlite3AbsInt32(get4byte(&aData[8+i*4]) - nearby);
6003 if( d2<dist ){
6004 closest = i;
6005 dist = d2;
6006 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006007 }
6008 }
6009 }else{
6010 closest = 0;
6011 }
6012
6013 iPage = get4byte(&aData[8+closest*4]);
drhdf35a082009-07-09 02:24:35 +00006014 testcase( iPage==mxPage );
drh1662b5a2009-06-04 19:06:09 +00006015 if( iPage>mxPage ){
drhcc97ca42017-06-07 22:32:59 +00006016 rc = SQLITE_CORRUPT_PGNO(iTrunk);
drh1662b5a2009-06-04 19:06:09 +00006017 goto end_allocate_page;
6018 }
drhdf35a082009-07-09 02:24:35 +00006019 testcase( iPage==mxPage );
dan51f0b6d2013-02-22 20:16:34 +00006020 if( !searchList
6021 || (iPage==nearby || (iPage<nearby && eMode==BTALLOC_LE))
6022 ){
danielk1977bea2a942009-01-20 17:06:27 +00006023 int noContent;
shane1f9e6aa2008-06-09 19:27:11 +00006024 *pPgno = iPage;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006025 TRACE(("ALLOCATE: %d was leaf %d of %d on trunk %d"
6026 ": %d more free pages\n",
6027 *pPgno, closest+1, k, pTrunk->pgno, n-1));
drh93b4fc72011-04-07 14:47:01 +00006028 rc = sqlite3PagerWrite(pTrunk->pDbPage);
6029 if( rc ) goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006030 if( closest<k-1 ){
6031 memcpy(&aData[8+closest*4], &aData[4+k*4], 4);
6032 }
6033 put4byte(&aData[4], k-1);
drh3f387402014-09-24 01:23:00 +00006034 noContent = !btreeGetHasContent(pBt, *pPgno)? PAGER_GET_NOCONTENT : 0;
drh7e8c6f12015-05-28 03:28:27 +00006035 rc = btreeGetUnusedPage(pBt, *pPgno, ppPage, noContent);
danielk1977cb1a7eb2004-11-05 12:27:02 +00006036 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00006037 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00006038 if( rc!=SQLITE_OK ){
6039 releasePage(*ppPage);
drh1c8bade2015-05-29 18:42:11 +00006040 *ppPage = 0;
danielk1977aac0a382005-01-16 11:07:06 +00006041 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006042 }
6043 searchList = 0;
6044 }
drhee696e22004-08-30 16:52:17 +00006045 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006046 releasePage(pPrevTrunk);
drhd3627af2006-12-18 18:34:51 +00006047 pPrevTrunk = 0;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006048 }while( searchList );
drh3b7511c2001-05-26 13:15:44 +00006049 }else{
danbc1a3c62013-02-23 16:40:46 +00006050 /* There are no pages on the freelist, so append a new page to the
6051 ** database image.
6052 **
6053 ** Normally, new pages allocated by this block can be requested from the
6054 ** pager layer with the 'no-content' flag set. This prevents the pager
6055 ** from trying to read the pages content from disk. However, if the
6056 ** current transaction has already run one or more incremental-vacuum
6057 ** steps, then the page we are about to allocate may contain content
6058 ** that is required in the event of a rollback. In this case, do
6059 ** not set the no-content flag. This causes the pager to load and journal
6060 ** the current page content before overwriting it.
6061 **
6062 ** Note that the pager will not actually attempt to load or journal
6063 ** content for any page that really does lie past the end of the database
6064 ** file on disk. So the effects of disabling the no-content optimization
6065 ** here are confined to those pages that lie between the end of the
6066 ** database image and the end of the database file.
6067 */
drh3f387402014-09-24 01:23:00 +00006068 int bNoContent = (0==IfNotOmitAV(pBt->bDoTruncate))? PAGER_GET_NOCONTENT:0;
danbc1a3c62013-02-23 16:40:46 +00006069
drhdd3cd972010-03-27 17:12:36 +00006070 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
6071 if( rc ) return rc;
6072 pBt->nPage++;
6073 if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ) pBt->nPage++;
danielk1977bea2a942009-01-20 17:06:27 +00006074
danielk1977afcdd022004-10-31 16:25:42 +00006075#ifndef SQLITE_OMIT_AUTOVACUUM
drhdd3cd972010-03-27 17:12:36 +00006076 if( pBt->autoVacuum && PTRMAP_ISPAGE(pBt, pBt->nPage) ){
danielk1977afcdd022004-10-31 16:25:42 +00006077 /* If *pPgno refers to a pointer-map page, allocate two new pages
6078 ** at the end of the file instead of one. The first allocated page
6079 ** becomes a new pointer-map page, the second is used by the caller.
6080 */
danielk1977ac861692009-03-28 10:54:22 +00006081 MemPage *pPg = 0;
drhdd3cd972010-03-27 17:12:36 +00006082 TRACE(("ALLOCATE: %d from end of file (pointer-map page)\n", pBt->nPage));
6083 assert( pBt->nPage!=PENDING_BYTE_PAGE(pBt) );
drh7e8c6f12015-05-28 03:28:27 +00006084 rc = btreeGetUnusedPage(pBt, pBt->nPage, &pPg, bNoContent);
danielk1977ac861692009-03-28 10:54:22 +00006085 if( rc==SQLITE_OK ){
6086 rc = sqlite3PagerWrite(pPg->pDbPage);
6087 releasePage(pPg);
6088 }
6089 if( rc ) return rc;
drhdd3cd972010-03-27 17:12:36 +00006090 pBt->nPage++;
6091 if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ){ pBt->nPage++; }
danielk1977afcdd022004-10-31 16:25:42 +00006092 }
6093#endif
drhdd3cd972010-03-27 17:12:36 +00006094 put4byte(28 + (u8*)pBt->pPage1->aData, pBt->nPage);
6095 *pPgno = pBt->nPage;
danielk1977afcdd022004-10-31 16:25:42 +00006096
danielk1977599fcba2004-11-08 07:13:13 +00006097 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drh7e8c6f12015-05-28 03:28:27 +00006098 rc = btreeGetUnusedPage(pBt, *pPgno, ppPage, bNoContent);
drh3b7511c2001-05-26 13:15:44 +00006099 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00006100 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00006101 if( rc!=SQLITE_OK ){
6102 releasePage(*ppPage);
drh7e8c6f12015-05-28 03:28:27 +00006103 *ppPage = 0;
danielk1977aac0a382005-01-16 11:07:06 +00006104 }
drh3a4c1412004-05-09 20:40:11 +00006105 TRACE(("ALLOCATE: %d from end of file\n", *pPgno));
drh3b7511c2001-05-26 13:15:44 +00006106 }
danielk1977599fcba2004-11-08 07:13:13 +00006107
6108 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drhd3627af2006-12-18 18:34:51 +00006109
6110end_allocate_page:
6111 releasePage(pTrunk);
6112 releasePage(pPrevTrunk);
drh7e8c6f12015-05-28 03:28:27 +00006113 assert( rc!=SQLITE_OK || sqlite3PagerPageRefcount((*ppPage)->pDbPage)<=1 );
6114 assert( rc!=SQLITE_OK || (*ppPage)->isInit==0 );
drh3b7511c2001-05-26 13:15:44 +00006115 return rc;
6116}
6117
6118/*
danielk1977bea2a942009-01-20 17:06:27 +00006119** This function is used to add page iPage to the database file free-list.
6120** It is assumed that the page is not already a part of the free-list.
drh5e2f8b92001-05-28 00:41:15 +00006121**
danielk1977bea2a942009-01-20 17:06:27 +00006122** The value passed as the second argument to this function is optional.
6123** If the caller happens to have a pointer to the MemPage object
6124** corresponding to page iPage handy, it may pass it as the second value.
6125** Otherwise, it may pass NULL.
6126**
6127** If a pointer to a MemPage object is passed as the second argument,
6128** its reference count is not altered by this function.
drh3b7511c2001-05-26 13:15:44 +00006129*/
danielk1977bea2a942009-01-20 17:06:27 +00006130static int freePage2(BtShared *pBt, MemPage *pMemPage, Pgno iPage){
6131 MemPage *pTrunk = 0; /* Free-list trunk page */
6132 Pgno iTrunk = 0; /* Page number of free-list trunk page */
6133 MemPage *pPage1 = pBt->pPage1; /* Local reference to page 1 */
6134 MemPage *pPage; /* Page being freed. May be NULL. */
6135 int rc; /* Return Code */
6136 int nFree; /* Initial number of pages on free-list */
drh8b2f49b2001-06-08 00:21:52 +00006137
danielk1977bea2a942009-01-20 17:06:27 +00006138 assert( sqlite3_mutex_held(pBt->mutex) );
danfb0246b2015-05-26 12:18:17 +00006139 assert( CORRUPT_DB || iPage>1 );
danielk1977bea2a942009-01-20 17:06:27 +00006140 assert( !pMemPage || pMemPage->pgno==iPage );
6141
danfb0246b2015-05-26 12:18:17 +00006142 if( iPage<2 ) return SQLITE_CORRUPT_BKPT;
danielk1977bea2a942009-01-20 17:06:27 +00006143 if( pMemPage ){
6144 pPage = pMemPage;
6145 sqlite3PagerRef(pPage->pDbPage);
6146 }else{
6147 pPage = btreePageLookup(pBt, iPage);
6148 }
drh3aac2dd2004-04-26 14:10:20 +00006149
drha34b6762004-05-07 13:30:42 +00006150 /* Increment the free page count on pPage1 */
danielk19773b8a05f2007-03-19 17:44:26 +00006151 rc = sqlite3PagerWrite(pPage1->pDbPage);
danielk1977bea2a942009-01-20 17:06:27 +00006152 if( rc ) goto freepage_out;
6153 nFree = get4byte(&pPage1->aData[36]);
6154 put4byte(&pPage1->aData[36], nFree+1);
drh3aac2dd2004-04-26 14:10:20 +00006155
drhc9166342012-01-05 23:32:06 +00006156 if( pBt->btsFlags & BTS_SECURE_DELETE ){
drh5b47efa2010-02-12 18:18:39 +00006157 /* If the secure_delete option is enabled, then
6158 ** always fully overwrite deleted information with zeros.
6159 */
drhb00fc3b2013-08-21 23:42:32 +00006160 if( (!pPage && ((rc = btreeGetPage(pBt, iPage, &pPage, 0))!=0) )
shaneh84f4b2f2010-02-26 01:46:54 +00006161 || ((rc = sqlite3PagerWrite(pPage->pDbPage))!=0)
drh5b47efa2010-02-12 18:18:39 +00006162 ){
6163 goto freepage_out;
6164 }
6165 memset(pPage->aData, 0, pPage->pBt->pageSize);
danielk1977bea2a942009-01-20 17:06:27 +00006166 }
drhfcce93f2006-02-22 03:08:32 +00006167
danielk1977687566d2004-11-02 12:56:41 +00006168 /* If the database supports auto-vacuum, write an entry in the pointer-map
danielk1977cb1a7eb2004-11-05 12:27:02 +00006169 ** to indicate that the page is free.
danielk1977687566d2004-11-02 12:56:41 +00006170 */
danielk197785d90ca2008-07-19 14:25:15 +00006171 if( ISAUTOVACUUM ){
drh98add2e2009-07-20 17:11:49 +00006172 ptrmapPut(pBt, iPage, PTRMAP_FREEPAGE, 0, &rc);
danielk1977bea2a942009-01-20 17:06:27 +00006173 if( rc ) goto freepage_out;
danielk1977687566d2004-11-02 12:56:41 +00006174 }
danielk1977687566d2004-11-02 12:56:41 +00006175
danielk1977bea2a942009-01-20 17:06:27 +00006176 /* Now manipulate the actual database free-list structure. There are two
6177 ** possibilities. If the free-list is currently empty, or if the first
6178 ** trunk page in the free-list is full, then this page will become a
6179 ** new free-list trunk page. Otherwise, it will become a leaf of the
6180 ** first trunk page in the current free-list. This block tests if it
6181 ** is possible to add the page as a new free-list leaf.
6182 */
6183 if( nFree!=0 ){
drhc046e3e2009-07-15 11:26:44 +00006184 u32 nLeaf; /* Initial number of leaf cells on trunk page */
danielk1977bea2a942009-01-20 17:06:27 +00006185
6186 iTrunk = get4byte(&pPage1->aData[32]);
drhb00fc3b2013-08-21 23:42:32 +00006187 rc = btreeGetPage(pBt, iTrunk, &pTrunk, 0);
danielk1977bea2a942009-01-20 17:06:27 +00006188 if( rc!=SQLITE_OK ){
6189 goto freepage_out;
6190 }
6191
6192 nLeaf = get4byte(&pTrunk->aData[4]);
drheeb844a2009-08-08 18:01:07 +00006193 assert( pBt->usableSize>32 );
6194 if( nLeaf > (u32)pBt->usableSize/4 - 2 ){
danielk1977bea2a942009-01-20 17:06:27 +00006195 rc = SQLITE_CORRUPT_BKPT;
6196 goto freepage_out;
6197 }
drheeb844a2009-08-08 18:01:07 +00006198 if( nLeaf < (u32)pBt->usableSize/4 - 8 ){
danielk1977bea2a942009-01-20 17:06:27 +00006199 /* In this case there is room on the trunk page to insert the page
6200 ** being freed as a new leaf.
drh45b1fac2008-07-04 17:52:42 +00006201 **
6202 ** Note that the trunk page is not really full until it contains
6203 ** usableSize/4 - 2 entries, not usableSize/4 - 8 entries as we have
6204 ** coded. But due to a coding error in versions of SQLite prior to
6205 ** 3.6.0, databases with freelist trunk pages holding more than
6206 ** usableSize/4 - 8 entries will be reported as corrupt. In order
6207 ** to maintain backwards compatibility with older versions of SQLite,
drhc046e3e2009-07-15 11:26:44 +00006208 ** we will continue to restrict the number of entries to usableSize/4 - 8
drh45b1fac2008-07-04 17:52:42 +00006209 ** for now. At some point in the future (once everyone has upgraded
6210 ** to 3.6.0 or later) we should consider fixing the conditional above
6211 ** to read "usableSize/4-2" instead of "usableSize/4-8".
drh113762a2014-11-19 16:36:25 +00006212 **
6213 ** EVIDENCE-OF: R-19920-11576 However, newer versions of SQLite still
6214 ** avoid using the last six entries in the freelist trunk page array in
6215 ** order that database files created by newer versions of SQLite can be
6216 ** read by older versions of SQLite.
drh45b1fac2008-07-04 17:52:42 +00006217 */
danielk19773b8a05f2007-03-19 17:44:26 +00006218 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhf5345442007-04-09 12:45:02 +00006219 if( rc==SQLITE_OK ){
danielk1977bea2a942009-01-20 17:06:27 +00006220 put4byte(&pTrunk->aData[4], nLeaf+1);
6221 put4byte(&pTrunk->aData[8+nLeaf*4], iPage);
drhc9166342012-01-05 23:32:06 +00006222 if( pPage && (pBt->btsFlags & BTS_SECURE_DELETE)==0 ){
danielk1977bea2a942009-01-20 17:06:27 +00006223 sqlite3PagerDontWrite(pPage->pDbPage);
6224 }
danielk1977bea2a942009-01-20 17:06:27 +00006225 rc = btreeSetHasContent(pBt, iPage);
drhf5345442007-04-09 12:45:02 +00006226 }
drh3a4c1412004-05-09 20:40:11 +00006227 TRACE(("FREE-PAGE: %d leaf on trunk page %d\n",pPage->pgno,pTrunk->pgno));
danielk1977bea2a942009-01-20 17:06:27 +00006228 goto freepage_out;
drh3aac2dd2004-04-26 14:10:20 +00006229 }
drh3b7511c2001-05-26 13:15:44 +00006230 }
danielk1977bea2a942009-01-20 17:06:27 +00006231
6232 /* If control flows to this point, then it was not possible to add the
6233 ** the page being freed as a leaf page of the first trunk in the free-list.
6234 ** Possibly because the free-list is empty, or possibly because the
6235 ** first trunk in the free-list is full. Either way, the page being freed
6236 ** will become the new first trunk page in the free-list.
6237 */
drhb00fc3b2013-08-21 23:42:32 +00006238 if( pPage==0 && SQLITE_OK!=(rc = btreeGetPage(pBt, iPage, &pPage, 0)) ){
drhc046e3e2009-07-15 11:26:44 +00006239 goto freepage_out;
6240 }
6241 rc = sqlite3PagerWrite(pPage->pDbPage);
6242 if( rc!=SQLITE_OK ){
danielk1977bea2a942009-01-20 17:06:27 +00006243 goto freepage_out;
6244 }
6245 put4byte(pPage->aData, iTrunk);
6246 put4byte(&pPage->aData[4], 0);
6247 put4byte(&pPage1->aData[32], iPage);
6248 TRACE(("FREE-PAGE: %d new trunk page replacing %d\n", pPage->pgno, iTrunk));
6249
6250freepage_out:
6251 if( pPage ){
6252 pPage->isInit = 0;
6253 }
6254 releasePage(pPage);
6255 releasePage(pTrunk);
drh3b7511c2001-05-26 13:15:44 +00006256 return rc;
6257}
drhc314dc72009-07-21 11:52:34 +00006258static void freePage(MemPage *pPage, int *pRC){
6259 if( (*pRC)==SQLITE_OK ){
6260 *pRC = freePage2(pPage->pBt, pPage, pPage->pgno);
6261 }
danielk1977bea2a942009-01-20 17:06:27 +00006262}
drh3b7511c2001-05-26 13:15:44 +00006263
6264/*
drh8d7f1632018-01-23 13:30:38 +00006265** Free any overflow pages associated with the given Cell. Store
6266** size information about the cell in pInfo.
drh3b7511c2001-05-26 13:15:44 +00006267*/
drh9bfdc252014-09-24 02:05:41 +00006268static int clearCell(
6269 MemPage *pPage, /* The page that contains the Cell */
6270 unsigned char *pCell, /* First byte of the Cell */
drh80159da2016-12-09 17:32:51 +00006271 CellInfo *pInfo /* Size information about the cell */
drh9bfdc252014-09-24 02:05:41 +00006272){
drh60172a52017-08-02 18:27:50 +00006273 BtShared *pBt;
drh3aac2dd2004-04-26 14:10:20 +00006274 Pgno ovflPgno;
drh6f11bef2004-05-13 01:12:56 +00006275 int rc;
drh94440812007-03-06 11:42:19 +00006276 int nOvfl;
shaneh1df2db72010-08-18 02:28:48 +00006277 u32 ovflPageSize;
drh3b7511c2001-05-26 13:15:44 +00006278
drh1fee73e2007-08-29 04:00:57 +00006279 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh80159da2016-12-09 17:32:51 +00006280 pPage->xParseCell(pPage, pCell, pInfo);
6281 if( pInfo->nLocal==pInfo->nPayload ){
drha34b6762004-05-07 13:30:42 +00006282 return SQLITE_OK; /* No overflow pages. Return without doing anything */
drh3aac2dd2004-04-26 14:10:20 +00006283 }
drh6fcf83a2018-05-05 01:23:28 +00006284 testcase( pCell + pInfo->nSize == pPage->aDataEnd );
6285 testcase( pCell + (pInfo->nSize-1) == pPage->aDataEnd );
6286 if( pCell + pInfo->nSize > pPage->aDataEnd ){
drhcc97ca42017-06-07 22:32:59 +00006287 /* Cell extends past end of page */
daneebf2f52017-11-18 17:30:08 +00006288 return SQLITE_CORRUPT_PAGE(pPage);
drhe42a9b42011-08-31 13:27:19 +00006289 }
drh80159da2016-12-09 17:32:51 +00006290 ovflPgno = get4byte(pCell + pInfo->nSize - 4);
drh60172a52017-08-02 18:27:50 +00006291 pBt = pPage->pBt;
shane63207ab2009-02-04 01:49:30 +00006292 assert( pBt->usableSize > 4 );
drh94440812007-03-06 11:42:19 +00006293 ovflPageSize = pBt->usableSize - 4;
drh80159da2016-12-09 17:32:51 +00006294 nOvfl = (pInfo->nPayload - pInfo->nLocal + ovflPageSize - 1)/ovflPageSize;
dan0f8076d2015-05-25 18:47:26 +00006295 assert( nOvfl>0 ||
drh80159da2016-12-09 17:32:51 +00006296 (CORRUPT_DB && (pInfo->nPayload + ovflPageSize)<ovflPageSize)
dan0f8076d2015-05-25 18:47:26 +00006297 );
drh72365832007-03-06 15:53:44 +00006298 while( nOvfl-- ){
shane63207ab2009-02-04 01:49:30 +00006299 Pgno iNext = 0;
danielk1977bea2a942009-01-20 17:06:27 +00006300 MemPage *pOvfl = 0;
drhb1299152010-03-30 22:58:33 +00006301 if( ovflPgno<2 || ovflPgno>btreePagecount(pBt) ){
danielk1977e589a672009-04-11 16:06:15 +00006302 /* 0 is not a legal page number and page 1 cannot be an
6303 ** overflow page. Therefore if ovflPgno<2 or past the end of the
6304 ** file the database must be corrupt. */
drh49285702005-09-17 15:20:26 +00006305 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00006306 }
danielk1977bea2a942009-01-20 17:06:27 +00006307 if( nOvfl ){
6308 rc = getOverflowPage(pBt, ovflPgno, &pOvfl, &iNext);
6309 if( rc ) return rc;
6310 }
dan887d4b22010-02-25 12:09:16 +00006311
shaneh1da207e2010-03-09 14:41:12 +00006312 if( ( pOvfl || ((pOvfl = btreePageLookup(pBt, ovflPgno))!=0) )
dan887d4b22010-02-25 12:09:16 +00006313 && sqlite3PagerPageRefcount(pOvfl->pDbPage)!=1
6314 ){
6315 /* There is no reason any cursor should have an outstanding reference
6316 ** to an overflow page belonging to a cell that is being deleted/updated.
6317 ** So if there exists more than one reference to this page, then it
6318 ** must not really be an overflow page and the database must be corrupt.
6319 ** It is helpful to detect this before calling freePage2(), as
6320 ** freePage2() may zero the page contents if secure-delete mode is
6321 ** enabled. If this 'overflow' page happens to be a page that the
6322 ** caller is iterating through or using in some other way, this
6323 ** can be problematic.
6324 */
6325 rc = SQLITE_CORRUPT_BKPT;
6326 }else{
6327 rc = freePage2(pBt, pOvfl, ovflPgno);
6328 }
6329
danielk1977bea2a942009-01-20 17:06:27 +00006330 if( pOvfl ){
6331 sqlite3PagerUnref(pOvfl->pDbPage);
6332 }
drh3b7511c2001-05-26 13:15:44 +00006333 if( rc ) return rc;
danielk1977bea2a942009-01-20 17:06:27 +00006334 ovflPgno = iNext;
drh3b7511c2001-05-26 13:15:44 +00006335 }
drh5e2f8b92001-05-28 00:41:15 +00006336 return SQLITE_OK;
drh3b7511c2001-05-26 13:15:44 +00006337}
6338
6339/*
drh91025292004-05-03 19:49:32 +00006340** Create the byte sequence used to represent a cell on page pPage
6341** and write that byte sequence into pCell[]. Overflow pages are
6342** allocated and filled in as necessary. The calling procedure
6343** is responsible for making sure sufficient space has been allocated
6344** for pCell[].
6345**
6346** Note that pCell does not necessary need to point to the pPage->aData
6347** area. pCell might point to some temporary storage. The cell will
6348** be constructed in this temporary area then copied into pPage->aData
6349** later.
drh3b7511c2001-05-26 13:15:44 +00006350*/
6351static int fillInCell(
drh3aac2dd2004-04-26 14:10:20 +00006352 MemPage *pPage, /* The page that contains the cell */
drh4b70f112004-05-02 21:12:19 +00006353 unsigned char *pCell, /* Complete text of the cell */
drh8eeb4462016-05-21 20:03:42 +00006354 const BtreePayload *pX, /* Payload with which to construct the cell */
drh4b70f112004-05-02 21:12:19 +00006355 int *pnSize /* Write cell size here */
drh3b7511c2001-05-26 13:15:44 +00006356){
drh3b7511c2001-05-26 13:15:44 +00006357 int nPayload;
drh8c6fa9b2004-05-26 00:01:53 +00006358 const u8 *pSrc;
drh5e27e1d2017-08-23 14:45:59 +00006359 int nSrc, n, rc, mn;
drh3aac2dd2004-04-26 14:10:20 +00006360 int spaceLeft;
drh5e27e1d2017-08-23 14:45:59 +00006361 MemPage *pToRelease;
drh3aac2dd2004-04-26 14:10:20 +00006362 unsigned char *pPrior;
6363 unsigned char *pPayload;
drh5e27e1d2017-08-23 14:45:59 +00006364 BtShared *pBt;
6365 Pgno pgnoOvfl;
drh4b70f112004-05-02 21:12:19 +00006366 int nHeader;
drh3b7511c2001-05-26 13:15:44 +00006367
drh1fee73e2007-08-29 04:00:57 +00006368 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00006369
drhc5053fb2008-11-27 02:22:10 +00006370 /* pPage is not necessarily writeable since pCell might be auxiliary
6371 ** buffer space that is separate from the pPage buffer area */
drh5e27e1d2017-08-23 14:45:59 +00006372 assert( pCell<pPage->aData || pCell>=&pPage->aData[pPage->pBt->pageSize]
drhc5053fb2008-11-27 02:22:10 +00006373 || sqlite3PagerIswriteable(pPage->pDbPage) );
6374
drh91025292004-05-03 19:49:32 +00006375 /* Fill in the header. */
drh6200c882014-09-23 22:36:25 +00006376 nHeader = pPage->childPtrSize;
drhdfc2daa2016-05-21 23:25:29 +00006377 if( pPage->intKey ){
6378 nPayload = pX->nData + pX->nZero;
6379 pSrc = pX->pData;
6380 nSrc = pX->nData;
6381 assert( pPage->intKeyLeaf ); /* fillInCell() only called for leaves */
drh6200c882014-09-23 22:36:25 +00006382 nHeader += putVarint32(&pCell[nHeader], nPayload);
drhdfc2daa2016-05-21 23:25:29 +00006383 nHeader += putVarint(&pCell[nHeader], *(u64*)&pX->nKey);
drh6f11bef2004-05-13 01:12:56 +00006384 }else{
drh8eeb4462016-05-21 20:03:42 +00006385 assert( pX->nKey<=0x7fffffff && pX->pKey!=0 );
6386 nSrc = nPayload = (int)pX->nKey;
6387 pSrc = pX->pKey;
drhdfc2daa2016-05-21 23:25:29 +00006388 nHeader += putVarint32(&pCell[nHeader], nPayload);
drh3aac2dd2004-04-26 14:10:20 +00006389 }
drhdfc2daa2016-05-21 23:25:29 +00006390
6391 /* Fill in the payload */
drh5e27e1d2017-08-23 14:45:59 +00006392 pPayload = &pCell[nHeader];
drh6200c882014-09-23 22:36:25 +00006393 if( nPayload<=pPage->maxLocal ){
drh5e27e1d2017-08-23 14:45:59 +00006394 /* This is the common case where everything fits on the btree page
6395 ** and no overflow pages are required. */
drh6200c882014-09-23 22:36:25 +00006396 n = nHeader + nPayload;
6397 testcase( n==3 );
6398 testcase( n==4 );
6399 if( n<4 ) n = 4;
6400 *pnSize = n;
drh5e27e1d2017-08-23 14:45:59 +00006401 assert( nSrc<=nPayload );
6402 testcase( nSrc<nPayload );
6403 memcpy(pPayload, pSrc, nSrc);
6404 memset(pPayload+nSrc, 0, nPayload-nSrc);
6405 return SQLITE_OK;
drh6200c882014-09-23 22:36:25 +00006406 }
drh5e27e1d2017-08-23 14:45:59 +00006407
6408 /* If we reach this point, it means that some of the content will need
6409 ** to spill onto overflow pages.
6410 */
6411 mn = pPage->minLocal;
6412 n = mn + (nPayload - mn) % (pPage->pBt->usableSize - 4);
6413 testcase( n==pPage->maxLocal );
6414 testcase( n==pPage->maxLocal+1 );
6415 if( n > pPage->maxLocal ) n = mn;
6416 spaceLeft = n;
6417 *pnSize = n + nHeader + 4;
6418 pPrior = &pCell[nHeader+n];
6419 pToRelease = 0;
6420 pgnoOvfl = 0;
6421 pBt = pPage->pBt;
drh3b7511c2001-05-26 13:15:44 +00006422
drh6200c882014-09-23 22:36:25 +00006423 /* At this point variables should be set as follows:
6424 **
6425 ** nPayload Total payload size in bytes
6426 ** pPayload Begin writing payload here
6427 ** spaceLeft Space available at pPayload. If nPayload>spaceLeft,
6428 ** that means content must spill into overflow pages.
6429 ** *pnSize Size of the local cell (not counting overflow pages)
6430 ** pPrior Where to write the pgno of the first overflow page
6431 **
6432 ** Use a call to btreeParseCellPtr() to verify that the values above
6433 ** were computed correctly.
6434 */
drhd879e3e2017-02-13 13:35:55 +00006435#ifdef SQLITE_DEBUG
drh6200c882014-09-23 22:36:25 +00006436 {
6437 CellInfo info;
drh5fa60512015-06-19 17:19:34 +00006438 pPage->xParseCell(pPage, pCell, &info);
drhcc5f8a42016-02-06 22:32:06 +00006439 assert( nHeader==(int)(info.pPayload - pCell) );
drh8eeb4462016-05-21 20:03:42 +00006440 assert( info.nKey==pX->nKey );
drh6200c882014-09-23 22:36:25 +00006441 assert( *pnSize == info.nSize );
6442 assert( spaceLeft == info.nLocal );
drh6200c882014-09-23 22:36:25 +00006443 }
6444#endif
6445
6446 /* Write the payload into the local Cell and any extra into overflow pages */
drh5e27e1d2017-08-23 14:45:59 +00006447 while( 1 ){
6448 n = nPayload;
6449 if( n>spaceLeft ) n = spaceLeft;
6450
6451 /* If pToRelease is not zero than pPayload points into the data area
6452 ** of pToRelease. Make sure pToRelease is still writeable. */
6453 assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
6454
6455 /* If pPayload is part of the data area of pPage, then make sure pPage
6456 ** is still writeable */
6457 assert( pPayload<pPage->aData || pPayload>=&pPage->aData[pBt->pageSize]
6458 || sqlite3PagerIswriteable(pPage->pDbPage) );
6459
6460 if( nSrc>=n ){
6461 memcpy(pPayload, pSrc, n);
6462 }else if( nSrc>0 ){
6463 n = nSrc;
6464 memcpy(pPayload, pSrc, n);
6465 }else{
6466 memset(pPayload, 0, n);
6467 }
6468 nPayload -= n;
6469 if( nPayload<=0 ) break;
6470 pPayload += n;
6471 pSrc += n;
6472 nSrc -= n;
6473 spaceLeft -= n;
drh3b7511c2001-05-26 13:15:44 +00006474 if( spaceLeft==0 ){
drh5e27e1d2017-08-23 14:45:59 +00006475 MemPage *pOvfl = 0;
danielk1977afcdd022004-10-31 16:25:42 +00006476#ifndef SQLITE_OMIT_AUTOVACUUM
6477 Pgno pgnoPtrmap = pgnoOvfl; /* Overflow page pointer-map entry page */
danielk1977b39f70b2007-05-17 18:28:11 +00006478 if( pBt->autoVacuum ){
6479 do{
6480 pgnoOvfl++;
6481 } while(
6482 PTRMAP_ISPAGE(pBt, pgnoOvfl) || pgnoOvfl==PENDING_BYTE_PAGE(pBt)
6483 );
danielk1977b39f70b2007-05-17 18:28:11 +00006484 }
danielk1977afcdd022004-10-31 16:25:42 +00006485#endif
drhf49661a2008-12-10 16:45:50 +00006486 rc = allocateBtreePage(pBt, &pOvfl, &pgnoOvfl, pgnoOvfl, 0);
danielk1977afcdd022004-10-31 16:25:42 +00006487#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977a19df672004-11-03 11:37:07 +00006488 /* If the database supports auto-vacuum, and the second or subsequent
6489 ** overflow page is being allocated, add an entry to the pointer-map
danielk19774ef24492007-05-23 09:52:41 +00006490 ** for that page now.
6491 **
6492 ** If this is the first overflow page, then write a partial entry
6493 ** to the pointer-map. If we write nothing to this pointer-map slot,
6494 ** then the optimistic overflow chain processing in clearCell()
mistachkin48864df2013-03-21 21:20:32 +00006495 ** may misinterpret the uninitialized values and delete the
danielk19774ef24492007-05-23 09:52:41 +00006496 ** wrong pages from the database.
danielk1977afcdd022004-10-31 16:25:42 +00006497 */
danielk19774ef24492007-05-23 09:52:41 +00006498 if( pBt->autoVacuum && rc==SQLITE_OK ){
6499 u8 eType = (pgnoPtrmap?PTRMAP_OVERFLOW2:PTRMAP_OVERFLOW1);
drh98add2e2009-07-20 17:11:49 +00006500 ptrmapPut(pBt, pgnoOvfl, eType, pgnoPtrmap, &rc);
danielk197789a4be82007-05-23 13:34:32 +00006501 if( rc ){
6502 releasePage(pOvfl);
6503 }
danielk1977afcdd022004-10-31 16:25:42 +00006504 }
6505#endif
drh3b7511c2001-05-26 13:15:44 +00006506 if( rc ){
drh9b171272004-05-08 02:03:22 +00006507 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00006508 return rc;
6509 }
drhc5053fb2008-11-27 02:22:10 +00006510
6511 /* If pToRelease is not zero than pPrior points into the data area
6512 ** of pToRelease. Make sure pToRelease is still writeable. */
6513 assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
6514
6515 /* If pPrior is part of the data area of pPage, then make sure pPage
6516 ** is still writeable */
6517 assert( pPrior<pPage->aData || pPrior>=&pPage->aData[pBt->pageSize]
6518 || sqlite3PagerIswriteable(pPage->pDbPage) );
6519
drh3aac2dd2004-04-26 14:10:20 +00006520 put4byte(pPrior, pgnoOvfl);
drh9b171272004-05-08 02:03:22 +00006521 releasePage(pToRelease);
6522 pToRelease = pOvfl;
drh3aac2dd2004-04-26 14:10:20 +00006523 pPrior = pOvfl->aData;
6524 put4byte(pPrior, 0);
6525 pPayload = &pOvfl->aData[4];
drhb6f41482004-05-14 01:58:11 +00006526 spaceLeft = pBt->usableSize - 4;
drh3b7511c2001-05-26 13:15:44 +00006527 }
drhdd793422001-06-28 01:54:48 +00006528 }
drh9b171272004-05-08 02:03:22 +00006529 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00006530 return SQLITE_OK;
6531}
6532
drh14acc042001-06-10 19:56:58 +00006533/*
6534** Remove the i-th cell from pPage. This routine effects pPage only.
6535** The cell content is not freed or deallocated. It is assumed that
6536** the cell content has been copied someplace else. This routine just
6537** removes the reference to the cell from pPage.
6538**
6539** "sz" must be the number of bytes in the cell.
drh14acc042001-06-10 19:56:58 +00006540*/
drh98add2e2009-07-20 17:11:49 +00006541static void dropCell(MemPage *pPage, int idx, int sz, int *pRC){
drh43b18e12010-08-17 19:40:08 +00006542 u32 pc; /* Offset to cell content of cell being deleted */
drh43605152004-05-29 21:46:49 +00006543 u8 *data; /* pPage->aData */
6544 u8 *ptr; /* Used to move bytes around within data[] */
shanedcc50b72008-11-13 18:29:50 +00006545 int rc; /* The return code */
drhc314dc72009-07-21 11:52:34 +00006546 int hdr; /* Beginning of the header. 0 most pages. 100 page 1 */
drh43605152004-05-29 21:46:49 +00006547
drh98add2e2009-07-20 17:11:49 +00006548 if( *pRC ) return;
drh8c42ca92001-06-22 19:15:00 +00006549 assert( idx>=0 && idx<pPage->nCell );
dan0f8076d2015-05-25 18:47:26 +00006550 assert( CORRUPT_DB || sz==cellSize(pPage, idx) );
danielk19773b8a05f2007-03-19 17:44:26 +00006551 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00006552 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhda200cc2004-05-09 11:51:38 +00006553 data = pPage->aData;
drh3def2352011-11-11 00:27:15 +00006554 ptr = &pPage->aCellIdx[2*idx];
shane0af3f892008-11-12 04:55:34 +00006555 pc = get2byte(ptr);
drhc314dc72009-07-21 11:52:34 +00006556 hdr = pPage->hdrOffset;
6557 testcase( pc==get2byte(&data[hdr+5]) );
6558 testcase( pc+sz==pPage->pBt->usableSize );
drh5e398e42017-08-23 20:36:06 +00006559 if( pc+sz > pPage->pBt->usableSize ){
drh98add2e2009-07-20 17:11:49 +00006560 *pRC = SQLITE_CORRUPT_BKPT;
6561 return;
shane0af3f892008-11-12 04:55:34 +00006562 }
shanedcc50b72008-11-13 18:29:50 +00006563 rc = freeSpace(pPage, pc, sz);
drh98add2e2009-07-20 17:11:49 +00006564 if( rc ){
6565 *pRC = rc;
6566 return;
shanedcc50b72008-11-13 18:29:50 +00006567 }
drh14acc042001-06-10 19:56:58 +00006568 pPage->nCell--;
drhfdab0262014-11-20 15:30:50 +00006569 if( pPage->nCell==0 ){
6570 memset(&data[hdr+1], 0, 4);
6571 data[hdr+7] = 0;
6572 put2byte(&data[hdr+5], pPage->pBt->usableSize);
6573 pPage->nFree = pPage->pBt->usableSize - pPage->hdrOffset
6574 - pPage->childPtrSize - 8;
6575 }else{
6576 memmove(ptr, ptr+2, 2*(pPage->nCell - idx));
6577 put2byte(&data[hdr+3], pPage->nCell);
6578 pPage->nFree += 2;
6579 }
drh14acc042001-06-10 19:56:58 +00006580}
6581
6582/*
6583** Insert a new cell on pPage at cell index "i". pCell points to the
6584** content of the cell.
6585**
6586** If the cell content will fit on the page, then put it there. If it
drh43605152004-05-29 21:46:49 +00006587** will not fit, then make a copy of the cell content into pTemp if
6588** pTemp is not null. Regardless of pTemp, allocate a new entry
drh2cbd78b2012-02-02 19:37:18 +00006589** in pPage->apOvfl[] and make it point to the cell content (either
drh43605152004-05-29 21:46:49 +00006590** in pTemp or the original pCell) and also record its index.
6591** Allocating a new entry in pPage->aCell[] implies that
6592** pPage->nOverflow is incremented.
drhcb89f4a2016-05-21 11:23:26 +00006593**
6594** *pRC must be SQLITE_OK when this routine is called.
drh14acc042001-06-10 19:56:58 +00006595*/
drh98add2e2009-07-20 17:11:49 +00006596static void insertCell(
drh24cd67e2004-05-10 16:18:47 +00006597 MemPage *pPage, /* Page into which we are copying */
drh43605152004-05-29 21:46:49 +00006598 int i, /* New cell becomes the i-th cell of the page */
6599 u8 *pCell, /* Content of the new cell */
6600 int sz, /* Bytes of content in pCell */
danielk1977a3ad5e72005-01-07 08:56:44 +00006601 u8 *pTemp, /* Temp storage space for pCell, if needed */
drh98add2e2009-07-20 17:11:49 +00006602 Pgno iChild, /* If non-zero, replace first 4 bytes with this value */
6603 int *pRC /* Read and write return code from here */
drh24cd67e2004-05-10 16:18:47 +00006604){
drh383d30f2010-02-26 13:07:37 +00006605 int idx = 0; /* Where to write new cell content in data[] */
drh43605152004-05-29 21:46:49 +00006606 int j; /* Loop counter */
drh43605152004-05-29 21:46:49 +00006607 u8 *data; /* The content of the whole page */
drh2c8fb922015-06-25 19:53:48 +00006608 u8 *pIns; /* The point in pPage->aCellIdx[] where no cell inserted */
danielk19774dbaa892009-06-16 16:50:22 +00006609
drhcb89f4a2016-05-21 11:23:26 +00006610 assert( *pRC==SQLITE_OK );
drh43605152004-05-29 21:46:49 +00006611 assert( i>=0 && i<=pPage->nCell+pPage->nOverflow );
danf216e322014-08-14 19:53:37 +00006612 assert( MX_CELL(pPage->pBt)<=10921 );
6613 assert( pPage->nCell<=MX_CELL(pPage->pBt) || CORRUPT_DB );
drh2cbd78b2012-02-02 19:37:18 +00006614 assert( pPage->nOverflow<=ArraySize(pPage->apOvfl) );
6615 assert( ArraySize(pPage->apOvfl)==ArraySize(pPage->aiOvfl) );
drh1fee73e2007-08-29 04:00:57 +00006616 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhc9b9b8a2009-12-03 21:26:52 +00006617 /* The cell should normally be sized correctly. However, when moving a
6618 ** malformed cell from a leaf page to an interior page, if the cell size
6619 ** wanted to be less than 4 but got rounded up to 4 on the leaf, then size
6620 ** might be less than 8 (leaf-size + pointer) on the interior node. Hence
6621 ** the term after the || in the following assert(). */
drh25ada072015-06-19 15:07:14 +00006622 assert( sz==pPage->xCellSize(pPage, pCell) || (sz==8 && iChild>0) );
drh43605152004-05-29 21:46:49 +00006623 if( pPage->nOverflow || sz+2>pPage->nFree ){
drh24cd67e2004-05-10 16:18:47 +00006624 if( pTemp ){
drhd6176c42014-10-11 17:22:55 +00006625 memcpy(pTemp, pCell, sz);
drh43605152004-05-29 21:46:49 +00006626 pCell = pTemp;
drh24cd67e2004-05-10 16:18:47 +00006627 }
danielk19774dbaa892009-06-16 16:50:22 +00006628 if( iChild ){
6629 put4byte(pCell, iChild);
6630 }
drh43605152004-05-29 21:46:49 +00006631 j = pPage->nOverflow++;
drha2ee5892016-12-09 16:02:00 +00006632 /* Comparison against ArraySize-1 since we hold back one extra slot
6633 ** as a contingency. In other words, never need more than 3 overflow
6634 ** slots but 4 are allocated, just to be safe. */
6635 assert( j < ArraySize(pPage->apOvfl)-1 );
drh2cbd78b2012-02-02 19:37:18 +00006636 pPage->apOvfl[j] = pCell;
6637 pPage->aiOvfl[j] = (u16)i;
drhfe647dc2015-06-23 18:24:25 +00006638
6639 /* When multiple overflows occur, they are always sequential and in
6640 ** sorted order. This invariants arise because multiple overflows can
6641 ** only occur when inserting divider cells into the parent page during
6642 ** balancing, and the dividers are adjacent and sorted.
6643 */
6644 assert( j==0 || pPage->aiOvfl[j-1]<(u16)i ); /* Overflows in sorted order */
6645 assert( j==0 || i==pPage->aiOvfl[j-1]+1 ); /* Overflows are sequential */
drh14acc042001-06-10 19:56:58 +00006646 }else{
danielk19776e465eb2007-08-21 13:11:00 +00006647 int rc = sqlite3PagerWrite(pPage->pDbPage);
6648 if( rc!=SQLITE_OK ){
drh98add2e2009-07-20 17:11:49 +00006649 *pRC = rc;
6650 return;
danielk19776e465eb2007-08-21 13:11:00 +00006651 }
6652 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh43605152004-05-29 21:46:49 +00006653 data = pPage->aData;
drh2c8fb922015-06-25 19:53:48 +00006654 assert( &data[pPage->cellOffset]==pPage->aCellIdx );
drh0a45c272009-07-08 01:49:11 +00006655 rc = allocateSpace(pPage, sz, &idx);
drh98add2e2009-07-20 17:11:49 +00006656 if( rc ){ *pRC = rc; return; }
drhcd8fb7c2015-06-02 14:02:18 +00006657 /* The allocateSpace() routine guarantees the following properties
6658 ** if it returns successfully */
drh2c8fb922015-06-25 19:53:48 +00006659 assert( idx >= 0 );
6660 assert( idx >= pPage->cellOffset+2*pPage->nCell+2 || CORRUPT_DB );
drhfcd71b62011-04-05 22:08:24 +00006661 assert( idx+sz <= (int)pPage->pBt->usableSize );
drh0a45c272009-07-08 01:49:11 +00006662 pPage->nFree -= (u16)(2 + sz);
drhd6176c42014-10-11 17:22:55 +00006663 memcpy(&data[idx], pCell, sz);
danielk19774dbaa892009-06-16 16:50:22 +00006664 if( iChild ){
6665 put4byte(&data[idx], iChild);
6666 }
drh2c8fb922015-06-25 19:53:48 +00006667 pIns = pPage->aCellIdx + i*2;
6668 memmove(pIns+2, pIns, 2*(pPage->nCell - i));
6669 put2byte(pIns, idx);
6670 pPage->nCell++;
6671 /* increment the cell count */
6672 if( (++data[pPage->hdrOffset+4])==0 ) data[pPage->hdrOffset+3]++;
6673 assert( get2byte(&data[pPage->hdrOffset+3])==pPage->nCell );
danielk1977a19df672004-11-03 11:37:07 +00006674#ifndef SQLITE_OMIT_AUTOVACUUM
6675 if( pPage->pBt->autoVacuum ){
6676 /* The cell may contain a pointer to an overflow page. If so, write
6677 ** the entry for the overflow page into the pointer map.
6678 */
drh98add2e2009-07-20 17:11:49 +00006679 ptrmapPutOvflPtr(pPage, pCell, pRC);
danielk1977a19df672004-11-03 11:37:07 +00006680 }
6681#endif
drh14acc042001-06-10 19:56:58 +00006682 }
6683}
6684
6685/*
drh1ffd2472015-06-23 02:37:30 +00006686** A CellArray object contains a cache of pointers and sizes for a
drhc0d269e2016-08-03 14:51:16 +00006687** consecutive sequence of cells that might be held on multiple pages.
drhfa1a98a2004-05-14 19:08:17 +00006688*/
drh1ffd2472015-06-23 02:37:30 +00006689typedef struct CellArray CellArray;
6690struct CellArray {
6691 int nCell; /* Number of cells in apCell[] */
6692 MemPage *pRef; /* Reference page */
6693 u8 **apCell; /* All cells begin balanced */
6694 u16 *szCell; /* Local size of all cells in apCell[] */
6695};
drhfa1a98a2004-05-14 19:08:17 +00006696
drh1ffd2472015-06-23 02:37:30 +00006697/*
6698** Make sure the cell sizes at idx, idx+1, ..., idx+N-1 have been
6699** computed.
6700*/
6701static void populateCellCache(CellArray *p, int idx, int N){
6702 assert( idx>=0 && idx+N<=p->nCell );
6703 while( N>0 ){
6704 assert( p->apCell[idx]!=0 );
6705 if( p->szCell[idx]==0 ){
6706 p->szCell[idx] = p->pRef->xCellSize(p->pRef, p->apCell[idx]);
6707 }else{
6708 assert( CORRUPT_DB ||
6709 p->szCell[idx]==p->pRef->xCellSize(p->pRef, p->apCell[idx]) );
6710 }
6711 idx++;
6712 N--;
drhfa1a98a2004-05-14 19:08:17 +00006713 }
drh1ffd2472015-06-23 02:37:30 +00006714}
6715
6716/*
6717** Return the size of the Nth element of the cell array
6718*/
6719static SQLITE_NOINLINE u16 computeCellSize(CellArray *p, int N){
6720 assert( N>=0 && N<p->nCell );
6721 assert( p->szCell[N]==0 );
6722 p->szCell[N] = p->pRef->xCellSize(p->pRef, p->apCell[N]);
6723 return p->szCell[N];
6724}
6725static u16 cachedCellSize(CellArray *p, int N){
6726 assert( N>=0 && N<p->nCell );
6727 if( p->szCell[N] ) return p->szCell[N];
6728 return computeCellSize(p, N);
6729}
6730
6731/*
dan8e9ba0c2014-10-14 17:27:04 +00006732** Array apCell[] contains pointers to nCell b-tree page cells. The
6733** szCell[] array contains the size in bytes of each cell. This function
6734** replaces the current contents of page pPg with the contents of the cell
6735** array.
6736**
6737** Some of the cells in apCell[] may currently be stored in pPg. This
6738** function works around problems caused by this by making a copy of any
6739** such cells before overwriting the page data.
6740**
6741** The MemPage.nFree field is invalidated by this function. It is the
6742** responsibility of the caller to set it correctly.
drhfa1a98a2004-05-14 19:08:17 +00006743*/
drh658873b2015-06-22 20:02:04 +00006744static int rebuildPage(
dan33ea4862014-10-09 19:35:37 +00006745 MemPage *pPg, /* Edit this page */
dan33ea4862014-10-09 19:35:37 +00006746 int nCell, /* Final number of cells on page */
dan09c68402014-10-11 20:00:24 +00006747 u8 **apCell, /* Array of cells */
6748 u16 *szCell /* Array of cell sizes */
dan33ea4862014-10-09 19:35:37 +00006749){
6750 const int hdr = pPg->hdrOffset; /* Offset of header on pPg */
6751 u8 * const aData = pPg->aData; /* Pointer to data for pPg */
6752 const int usableSize = pPg->pBt->usableSize;
6753 u8 * const pEnd = &aData[usableSize];
6754 int i;
6755 u8 *pCellptr = pPg->aCellIdx;
6756 u8 *pTmp = sqlite3PagerTempSpace(pPg->pBt->pPager);
6757 u8 *pData;
6758
6759 i = get2byte(&aData[hdr+5]);
6760 memcpy(&pTmp[i], &aData[i], usableSize - i);
dan33ea4862014-10-09 19:35:37 +00006761
dan8e9ba0c2014-10-14 17:27:04 +00006762 pData = pEnd;
dan33ea4862014-10-09 19:35:37 +00006763 for(i=0; i<nCell; i++){
6764 u8 *pCell = apCell[i];
drh8b0ba7b2015-12-16 13:07:35 +00006765 if( SQLITE_WITHIN(pCell,aData,pEnd) ){
drhd7a5e492018-12-14 16:20:54 +00006766 if( ((uptr)(pCell+szCell[i]))>(uptr)pEnd ) return SQLITE_CORRUPT_BKPT;
dan33ea4862014-10-09 19:35:37 +00006767 pCell = &pTmp[pCell - aData];
6768 }
6769 pData -= szCell[i];
dan33ea4862014-10-09 19:35:37 +00006770 put2byte(pCellptr, (pData - aData));
6771 pCellptr += 2;
drh658873b2015-06-22 20:02:04 +00006772 if( pData < pCellptr ) return SQLITE_CORRUPT_BKPT;
6773 memcpy(pData, pCell, szCell[i]);
drh25ada072015-06-19 15:07:14 +00006774 assert( szCell[i]==pPg->xCellSize(pPg, pCell) || CORRUPT_DB );
drhea82b372015-06-23 21:35:28 +00006775 testcase( szCell[i]!=pPg->xCellSize(pPg,pCell) );
dan33ea4862014-10-09 19:35:37 +00006776 }
6777
dand7b545b2014-10-13 18:03:27 +00006778 /* The pPg->nFree field is now set incorrectly. The caller will fix it. */
dan33ea4862014-10-09 19:35:37 +00006779 pPg->nCell = nCell;
6780 pPg->nOverflow = 0;
6781
6782 put2byte(&aData[hdr+1], 0);
6783 put2byte(&aData[hdr+3], pPg->nCell);
6784 put2byte(&aData[hdr+5], pData - aData);
6785 aData[hdr+7] = 0x00;
drh658873b2015-06-22 20:02:04 +00006786 return SQLITE_OK;
dan33ea4862014-10-09 19:35:37 +00006787}
6788
dan8e9ba0c2014-10-14 17:27:04 +00006789/*
6790** Array apCell[] contains nCell pointers to b-tree cells. Array szCell
6791** contains the size in bytes of each such cell. This function attempts to
6792** add the cells stored in the array to page pPg. If it cannot (because
6793** the page needs to be defragmented before the cells will fit), non-zero
6794** is returned. Otherwise, if the cells are added successfully, zero is
6795** returned.
6796**
6797** Argument pCellptr points to the first entry in the cell-pointer array
6798** (part of page pPg) to populate. After cell apCell[0] is written to the
6799** page body, a 16-bit offset is written to pCellptr. And so on, for each
6800** cell in the array. It is the responsibility of the caller to ensure
6801** that it is safe to overwrite this part of the cell-pointer array.
6802**
6803** When this function is called, *ppData points to the start of the
6804** content area on page pPg. If the size of the content area is extended,
6805** *ppData is updated to point to the new start of the content area
6806** before returning.
6807**
6808** Finally, argument pBegin points to the byte immediately following the
6809** end of the space required by this page for the cell-pointer area (for
6810** all cells - not just those inserted by the current call). If the content
6811** area must be extended to before this point in order to accomodate all
6812** cells in apCell[], then the cells do not fit and non-zero is returned.
6813*/
dand7b545b2014-10-13 18:03:27 +00006814static int pageInsertArray(
dan8e9ba0c2014-10-14 17:27:04 +00006815 MemPage *pPg, /* Page to add cells to */
6816 u8 *pBegin, /* End of cell-pointer array */
6817 u8 **ppData, /* IN/OUT: Page content -area pointer */
6818 u8 *pCellptr, /* Pointer to cell-pointer area */
drhf7838932015-06-23 15:36:34 +00006819 int iFirst, /* Index of first cell to add */
dan8e9ba0c2014-10-14 17:27:04 +00006820 int nCell, /* Number of cells to add to pPg */
drhf7838932015-06-23 15:36:34 +00006821 CellArray *pCArray /* Array of cells */
dand7b545b2014-10-13 18:03:27 +00006822){
6823 int i;
6824 u8 *aData = pPg->aData;
6825 u8 *pData = *ppData;
drhf7838932015-06-23 15:36:34 +00006826 int iEnd = iFirst + nCell;
dan23eba452014-10-24 18:43:57 +00006827 assert( CORRUPT_DB || pPg->hdrOffset==0 ); /* Never called on page 1 */
drhf7838932015-06-23 15:36:34 +00006828 for(i=iFirst; i<iEnd; i++){
6829 int sz, rc;
dand7b545b2014-10-13 18:03:27 +00006830 u8 *pSlot;
drhf7838932015-06-23 15:36:34 +00006831 sz = cachedCellSize(pCArray, i);
drhb7580e82015-06-25 18:36:13 +00006832 if( (aData[1]==0 && aData[2]==0) || (pSlot = pageFindSlot(pPg,sz,&rc))==0 ){
drhcca66982016-04-05 13:19:19 +00006833 if( (pData - pBegin)<sz ) return 1;
dand7b545b2014-10-13 18:03:27 +00006834 pData -= sz;
dand7b545b2014-10-13 18:03:27 +00006835 pSlot = pData;
6836 }
drh48310f82015-10-10 16:41:28 +00006837 /* pSlot and pCArray->apCell[i] will never overlap on a well-formed
6838 ** database. But they might for a corrupt database. Hence use memmove()
6839 ** since memcpy() sends SIGABORT with overlapping buffers on OpenBSD */
6840 assert( (pSlot+sz)<=pCArray->apCell[i]
6841 || pSlot>=(pCArray->apCell[i]+sz)
6842 || CORRUPT_DB );
6843 memmove(pSlot, pCArray->apCell[i], sz);
dand7b545b2014-10-13 18:03:27 +00006844 put2byte(pCellptr, (pSlot - aData));
6845 pCellptr += 2;
6846 }
6847 *ppData = pData;
6848 return 0;
6849}
6850
dan8e9ba0c2014-10-14 17:27:04 +00006851/*
6852** Array apCell[] contains nCell pointers to b-tree cells. Array szCell
6853** contains the size in bytes of each such cell. This function adds the
6854** space associated with each cell in the array that is currently stored
6855** within the body of pPg to the pPg free-list. The cell-pointers and other
6856** fields of the page are not updated.
6857**
6858** This function returns the total number of cells added to the free-list.
6859*/
dand7b545b2014-10-13 18:03:27 +00006860static int pageFreeArray(
6861 MemPage *pPg, /* Page to edit */
drhf7838932015-06-23 15:36:34 +00006862 int iFirst, /* First cell to delete */
dand7b545b2014-10-13 18:03:27 +00006863 int nCell, /* Cells to delete */
drhf7838932015-06-23 15:36:34 +00006864 CellArray *pCArray /* Array of cells */
dand7b545b2014-10-13 18:03:27 +00006865){
6866 u8 * const aData = pPg->aData;
6867 u8 * const pEnd = &aData[pPg->pBt->usableSize];
dan89ca0b32014-10-25 20:36:28 +00006868 u8 * const pStart = &aData[pPg->hdrOffset + 8 + pPg->childPtrSize];
dand7b545b2014-10-13 18:03:27 +00006869 int nRet = 0;
6870 int i;
drhf7838932015-06-23 15:36:34 +00006871 int iEnd = iFirst + nCell;
dand7b545b2014-10-13 18:03:27 +00006872 u8 *pFree = 0;
6873 int szFree = 0;
6874
drhf7838932015-06-23 15:36:34 +00006875 for(i=iFirst; i<iEnd; i++){
6876 u8 *pCell = pCArray->apCell[i];
drh8b0ba7b2015-12-16 13:07:35 +00006877 if( SQLITE_WITHIN(pCell, pStart, pEnd) ){
drhf7838932015-06-23 15:36:34 +00006878 int sz;
6879 /* No need to use cachedCellSize() here. The sizes of all cells that
6880 ** are to be freed have already been computing while deciding which
6881 ** cells need freeing */
6882 sz = pCArray->szCell[i]; assert( sz>0 );
dand7b545b2014-10-13 18:03:27 +00006883 if( pFree!=(pCell + sz) ){
drhfefa0942014-11-05 21:21:08 +00006884 if( pFree ){
6885 assert( pFree>aData && (pFree - aData)<65536 );
6886 freeSpace(pPg, (u16)(pFree - aData), szFree);
6887 }
dand7b545b2014-10-13 18:03:27 +00006888 pFree = pCell;
6889 szFree = sz;
dan89ca0b32014-10-25 20:36:28 +00006890 if( pFree+sz>pEnd ) return 0;
dand7b545b2014-10-13 18:03:27 +00006891 }else{
6892 pFree = pCell;
6893 szFree += sz;
6894 }
6895 nRet++;
6896 }
6897 }
drhfefa0942014-11-05 21:21:08 +00006898 if( pFree ){
6899 assert( pFree>aData && (pFree - aData)<65536 );
6900 freeSpace(pPg, (u16)(pFree - aData), szFree);
6901 }
dand7b545b2014-10-13 18:03:27 +00006902 return nRet;
6903}
6904
dand7b545b2014-10-13 18:03:27 +00006905/*
drh5ab63772014-11-27 03:46:04 +00006906** apCell[] and szCell[] contains pointers to and sizes of all cells in the
6907** pages being balanced. The current page, pPg, has pPg->nCell cells starting
6908** with apCell[iOld]. After balancing, this page should hold nNew cells
6909** starting at apCell[iNew].
6910**
6911** This routine makes the necessary adjustments to pPg so that it contains
6912** the correct cells after being balanced.
6913**
dand7b545b2014-10-13 18:03:27 +00006914** The pPg->nFree field is invalid when this function returns. It is the
6915** responsibility of the caller to set it correctly.
6916*/
drh658873b2015-06-22 20:02:04 +00006917static int editPage(
dan09c68402014-10-11 20:00:24 +00006918 MemPage *pPg, /* Edit this page */
6919 int iOld, /* Index of first cell currently on page */
6920 int iNew, /* Index of new first cell on page */
6921 int nNew, /* Final number of cells on page */
drh1ffd2472015-06-23 02:37:30 +00006922 CellArray *pCArray /* Array of cells and sizes */
dan09c68402014-10-11 20:00:24 +00006923){
dand7b545b2014-10-13 18:03:27 +00006924 u8 * const aData = pPg->aData;
6925 const int hdr = pPg->hdrOffset;
6926 u8 *pBegin = &pPg->aCellIdx[nNew * 2];
6927 int nCell = pPg->nCell; /* Cells stored on pPg */
6928 u8 *pData;
6929 u8 *pCellptr;
6930 int i;
6931 int iOldEnd = iOld + pPg->nCell + pPg->nOverflow;
6932 int iNewEnd = iNew + nNew;
dan09c68402014-10-11 20:00:24 +00006933
6934#ifdef SQLITE_DEBUG
dand7b545b2014-10-13 18:03:27 +00006935 u8 *pTmp = sqlite3PagerTempSpace(pPg->pBt->pPager);
6936 memcpy(pTmp, aData, pPg->pBt->usableSize);
dan09c68402014-10-11 20:00:24 +00006937#endif
6938
dand7b545b2014-10-13 18:03:27 +00006939 /* Remove cells from the start and end of the page */
6940 if( iOld<iNew ){
drhf7838932015-06-23 15:36:34 +00006941 int nShift = pageFreeArray(pPg, iOld, iNew-iOld, pCArray);
dand7b545b2014-10-13 18:03:27 +00006942 memmove(pPg->aCellIdx, &pPg->aCellIdx[nShift*2], nCell*2);
6943 nCell -= nShift;
6944 }
6945 if( iNewEnd < iOldEnd ){
drhf7838932015-06-23 15:36:34 +00006946 nCell -= pageFreeArray(pPg, iNewEnd, iOldEnd - iNewEnd, pCArray);
dand7b545b2014-10-13 18:03:27 +00006947 }
dan09c68402014-10-11 20:00:24 +00006948
drh5ab63772014-11-27 03:46:04 +00006949 pData = &aData[get2byteNotZero(&aData[hdr+5])];
dand7b545b2014-10-13 18:03:27 +00006950 if( pData<pBegin ) goto editpage_fail;
6951
6952 /* Add cells to the start of the page */
6953 if( iNew<iOld ){
drh5ab63772014-11-27 03:46:04 +00006954 int nAdd = MIN(nNew,iOld-iNew);
6955 assert( (iOld-iNew)<nNew || nCell==0 || CORRUPT_DB );
dand7b545b2014-10-13 18:03:27 +00006956 pCellptr = pPg->aCellIdx;
6957 memmove(&pCellptr[nAdd*2], pCellptr, nCell*2);
6958 if( pageInsertArray(
6959 pPg, pBegin, &pData, pCellptr,
drhf7838932015-06-23 15:36:34 +00006960 iNew, nAdd, pCArray
dand7b545b2014-10-13 18:03:27 +00006961 ) ) goto editpage_fail;
6962 nCell += nAdd;
6963 }
6964
6965 /* Add any overflow cells */
6966 for(i=0; i<pPg->nOverflow; i++){
6967 int iCell = (iOld + pPg->aiOvfl[i]) - iNew;
6968 if( iCell>=0 && iCell<nNew ){
drhfefa0942014-11-05 21:21:08 +00006969 pCellptr = &pPg->aCellIdx[iCell * 2];
dand7b545b2014-10-13 18:03:27 +00006970 memmove(&pCellptr[2], pCellptr, (nCell - iCell) * 2);
6971 nCell++;
6972 if( pageInsertArray(
6973 pPg, pBegin, &pData, pCellptr,
drhf7838932015-06-23 15:36:34 +00006974 iCell+iNew, 1, pCArray
dand7b545b2014-10-13 18:03:27 +00006975 ) ) goto editpage_fail;
dan09c68402014-10-11 20:00:24 +00006976 }
dand7b545b2014-10-13 18:03:27 +00006977 }
dan09c68402014-10-11 20:00:24 +00006978
dand7b545b2014-10-13 18:03:27 +00006979 /* Append cells to the end of the page */
6980 pCellptr = &pPg->aCellIdx[nCell*2];
6981 if( pageInsertArray(
6982 pPg, pBegin, &pData, pCellptr,
drhf7838932015-06-23 15:36:34 +00006983 iNew+nCell, nNew-nCell, pCArray
dand7b545b2014-10-13 18:03:27 +00006984 ) ) goto editpage_fail;
dan09c68402014-10-11 20:00:24 +00006985
dand7b545b2014-10-13 18:03:27 +00006986 pPg->nCell = nNew;
6987 pPg->nOverflow = 0;
dan09c68402014-10-11 20:00:24 +00006988
dand7b545b2014-10-13 18:03:27 +00006989 put2byte(&aData[hdr+3], pPg->nCell);
6990 put2byte(&aData[hdr+5], pData - aData);
dan09c68402014-10-11 20:00:24 +00006991
6992#ifdef SQLITE_DEBUG
dan23eba452014-10-24 18:43:57 +00006993 for(i=0; i<nNew && !CORRUPT_DB; i++){
drh1ffd2472015-06-23 02:37:30 +00006994 u8 *pCell = pCArray->apCell[i+iNew];
drh329428e2015-06-30 13:28:18 +00006995 int iOff = get2byteAligned(&pPg->aCellIdx[i*2]);
drh1c715f62016-04-05 13:35:43 +00006996 if( SQLITE_WITHIN(pCell, aData, &aData[pPg->pBt->usableSize]) ){
dand7b545b2014-10-13 18:03:27 +00006997 pCell = &pTmp[pCell - aData];
dan09c68402014-10-11 20:00:24 +00006998 }
drh1ffd2472015-06-23 02:37:30 +00006999 assert( 0==memcmp(pCell, &aData[iOff],
7000 pCArray->pRef->xCellSize(pCArray->pRef, pCArray->apCell[i+iNew])) );
dand7b545b2014-10-13 18:03:27 +00007001 }
dan09c68402014-10-11 20:00:24 +00007002#endif
7003
drh658873b2015-06-22 20:02:04 +00007004 return SQLITE_OK;
dan09c68402014-10-11 20:00:24 +00007005 editpage_fail:
dan09c68402014-10-11 20:00:24 +00007006 /* Unable to edit this page. Rebuild it from scratch instead. */
drh1ffd2472015-06-23 02:37:30 +00007007 populateCellCache(pCArray, iNew, nNew);
7008 return rebuildPage(pPg, nNew, &pCArray->apCell[iNew], &pCArray->szCell[iNew]);
drhfa1a98a2004-05-14 19:08:17 +00007009}
7010
drh14acc042001-06-10 19:56:58 +00007011/*
drhc3b70572003-01-04 19:44:07 +00007012** The following parameters determine how many adjacent pages get involved
7013** in a balancing operation. NN is the number of neighbors on either side
7014** of the page that participate in the balancing operation. NB is the
7015** total number of pages that participate, including the target page and
7016** NN neighbors on either side.
7017**
7018** The minimum value of NN is 1 (of course). Increasing NN above 1
7019** (to 2 or 3) gives a modest improvement in SELECT and DELETE performance
7020** in exchange for a larger degradation in INSERT and UPDATE performance.
7021** The value of NN appears to give the best results overall.
7022*/
7023#define NN 1 /* Number of neighbors on either side of pPage */
7024#define NB (NN*2+1) /* Total pages involved in the balance */
7025
danielk1977ac245ec2005-01-14 13:50:11 +00007026
drh615ae552005-01-16 23:21:00 +00007027#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00007028/*
7029** This version of balance() handles the common special case where
7030** a new entry is being inserted on the extreme right-end of the
7031** tree, in other words, when the new entry will become the largest
7032** entry in the tree.
7033**
drhc314dc72009-07-21 11:52:34 +00007034** Instead of trying to balance the 3 right-most leaf pages, just add
drhf222e712005-01-14 22:55:49 +00007035** a new page to the right-hand side and put the one new entry in
7036** that page. This leaves the right side of the tree somewhat
7037** unbalanced. But odds are that we will be inserting new entries
7038** at the end soon afterwards so the nearly empty page will quickly
7039** fill up. On average.
7040**
7041** pPage is the leaf page which is the right-most page in the tree.
7042** pParent is its parent. pPage must have a single overflow entry
7043** which is also the right-most entry on the page.
danielk1977a50d9aa2009-06-08 14:49:45 +00007044**
7045** The pSpace buffer is used to store a temporary copy of the divider
7046** cell that will be inserted into pParent. Such a cell consists of a 4
7047** byte page number followed by a variable length integer. In other
7048** words, at most 13 bytes. Hence the pSpace buffer must be at
7049** least 13 bytes in size.
drhf222e712005-01-14 22:55:49 +00007050*/
danielk1977a50d9aa2009-06-08 14:49:45 +00007051static int balance_quick(MemPage *pParent, MemPage *pPage, u8 *pSpace){
7052 BtShared *const pBt = pPage->pBt; /* B-Tree Database */
danielk19774dbaa892009-06-16 16:50:22 +00007053 MemPage *pNew; /* Newly allocated page */
danielk19776f235cc2009-06-04 14:46:08 +00007054 int rc; /* Return Code */
7055 Pgno pgnoNew; /* Page number of pNew */
danielk1977ac245ec2005-01-14 13:50:11 +00007056
drh1fee73e2007-08-29 04:00:57 +00007057 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk1977a50d9aa2009-06-08 14:49:45 +00007058 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk1977e56b60e2009-06-10 09:11:06 +00007059 assert( pPage->nOverflow==1 );
7060
drh6301c432018-12-13 21:52:18 +00007061 if( pPage->nCell==0 ) return SQLITE_CORRUPT_BKPT; /* dbfuzz001.test */
drhd677b3d2007-08-20 22:48:41 +00007062
danielk1977a50d9aa2009-06-08 14:49:45 +00007063 /* Allocate a new page. This page will become the right-sibling of
7064 ** pPage. Make the parent page writable, so that the new divider cell
7065 ** may be inserted. If both these operations are successful, proceed.
7066 */
drh4f0c5872007-03-26 22:05:01 +00007067 rc = allocateBtreePage(pBt, &pNew, &pgnoNew, 0, 0);
danielk19774dbaa892009-06-16 16:50:22 +00007068
danielk1977eaa06f62008-09-18 17:34:44 +00007069 if( rc==SQLITE_OK ){
danielk1977a50d9aa2009-06-08 14:49:45 +00007070
7071 u8 *pOut = &pSpace[4];
drh2cbd78b2012-02-02 19:37:18 +00007072 u8 *pCell = pPage->apOvfl[0];
drh25ada072015-06-19 15:07:14 +00007073 u16 szCell = pPage->xCellSize(pPage, pCell);
danielk19776f235cc2009-06-04 14:46:08 +00007074 u8 *pStop;
7075
drhc5053fb2008-11-27 02:22:10 +00007076 assert( sqlite3PagerIswriteable(pNew->pDbPage) );
danielk1977e56b60e2009-06-10 09:11:06 +00007077 assert( pPage->aData[0]==(PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF) );
7078 zeroPage(pNew, PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF);
drh658873b2015-06-22 20:02:04 +00007079 rc = rebuildPage(pNew, 1, &pCell, &szCell);
drhea82b372015-06-23 21:35:28 +00007080 if( NEVER(rc) ) return rc;
dan8e9ba0c2014-10-14 17:27:04 +00007081 pNew->nFree = pBt->usableSize - pNew->cellOffset - 2 - szCell;
danielk19774dbaa892009-06-16 16:50:22 +00007082
7083 /* If this is an auto-vacuum database, update the pointer map
7084 ** with entries for the new page, and any pointer from the
7085 ** cell on the page to an overflow page. If either of these
7086 ** operations fails, the return code is set, but the contents
7087 ** of the parent page are still manipulated by thh code below.
7088 ** That is Ok, at this point the parent page is guaranteed to
7089 ** be marked as dirty. Returning an error code will cause a
7090 ** rollback, undoing any changes made to the parent page.
7091 */
7092 if( ISAUTOVACUUM ){
drh98add2e2009-07-20 17:11:49 +00007093 ptrmapPut(pBt, pgnoNew, PTRMAP_BTREE, pParent->pgno, &rc);
7094 if( szCell>pNew->minLocal ){
7095 ptrmapPutOvflPtr(pNew, pCell, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00007096 }
7097 }
danielk1977eaa06f62008-09-18 17:34:44 +00007098
danielk19776f235cc2009-06-04 14:46:08 +00007099 /* Create a divider cell to insert into pParent. The divider cell
7100 ** consists of a 4-byte page number (the page number of pPage) and
7101 ** a variable length key value (which must be the same value as the
7102 ** largest key on pPage).
danielk1977eaa06f62008-09-18 17:34:44 +00007103 **
danielk19776f235cc2009-06-04 14:46:08 +00007104 ** To find the largest key value on pPage, first find the right-most
7105 ** cell on pPage. The first two fields of this cell are the
7106 ** record-length (a variable length integer at most 32-bits in size)
7107 ** and the key value (a variable length integer, may have any value).
7108 ** The first of the while(...) loops below skips over the record-length
7109 ** field. The second while(...) loop copies the key value from the
danielk1977a50d9aa2009-06-08 14:49:45 +00007110 ** cell on pPage into the pSpace buffer.
danielk1977eaa06f62008-09-18 17:34:44 +00007111 */
danielk1977eaa06f62008-09-18 17:34:44 +00007112 pCell = findCell(pPage, pPage->nCell-1);
danielk19776f235cc2009-06-04 14:46:08 +00007113 pStop = &pCell[9];
7114 while( (*(pCell++)&0x80) && pCell<pStop );
7115 pStop = &pCell[9];
7116 while( ((*(pOut++) = *(pCell++))&0x80) && pCell<pStop );
7117
danielk19774dbaa892009-06-16 16:50:22 +00007118 /* Insert the new divider cell into pParent. */
drhcb89f4a2016-05-21 11:23:26 +00007119 if( rc==SQLITE_OK ){
7120 insertCell(pParent, pParent->nCell, pSpace, (int)(pOut-pSpace),
7121 0, pPage->pgno, &rc);
7122 }
danielk19776f235cc2009-06-04 14:46:08 +00007123
7124 /* Set the right-child pointer of pParent to point to the new page. */
danielk1977eaa06f62008-09-18 17:34:44 +00007125 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew);
7126
danielk1977e08a3c42008-09-18 18:17:03 +00007127 /* Release the reference to the new page. */
7128 releasePage(pNew);
danielk1977ac11ee62005-01-15 12:45:51 +00007129 }
7130
danielk1977eaa06f62008-09-18 17:34:44 +00007131 return rc;
danielk1977ac245ec2005-01-14 13:50:11 +00007132}
drh615ae552005-01-16 23:21:00 +00007133#endif /* SQLITE_OMIT_QUICKBALANCE */
drh43605152004-05-29 21:46:49 +00007134
danielk19774dbaa892009-06-16 16:50:22 +00007135#if 0
drhc3b70572003-01-04 19:44:07 +00007136/*
danielk19774dbaa892009-06-16 16:50:22 +00007137** This function does not contribute anything to the operation of SQLite.
7138** it is sometimes activated temporarily while debugging code responsible
7139** for setting pointer-map entries.
7140*/
7141static int ptrmapCheckPages(MemPage **apPage, int nPage){
7142 int i, j;
7143 for(i=0; i<nPage; i++){
7144 Pgno n;
7145 u8 e;
7146 MemPage *pPage = apPage[i];
7147 BtShared *pBt = pPage->pBt;
7148 assert( pPage->isInit );
7149
7150 for(j=0; j<pPage->nCell; j++){
7151 CellInfo info;
7152 u8 *z;
7153
7154 z = findCell(pPage, j);
drh5fa60512015-06-19 17:19:34 +00007155 pPage->xParseCell(pPage, z, &info);
drh45ac1c72015-12-18 03:59:16 +00007156 if( info.nLocal<info.nPayload ){
7157 Pgno ovfl = get4byte(&z[info.nSize-4]);
danielk19774dbaa892009-06-16 16:50:22 +00007158 ptrmapGet(pBt, ovfl, &e, &n);
7159 assert( n==pPage->pgno && e==PTRMAP_OVERFLOW1 );
7160 }
7161 if( !pPage->leaf ){
7162 Pgno child = get4byte(z);
7163 ptrmapGet(pBt, child, &e, &n);
7164 assert( n==pPage->pgno && e==PTRMAP_BTREE );
7165 }
7166 }
7167 if( !pPage->leaf ){
7168 Pgno child = get4byte(&pPage->aData[pPage->hdrOffset+8]);
7169 ptrmapGet(pBt, child, &e, &n);
7170 assert( n==pPage->pgno && e==PTRMAP_BTREE );
7171 }
7172 }
7173 return 1;
7174}
7175#endif
7176
danielk1977cd581a72009-06-23 15:43:39 +00007177/*
7178** This function is used to copy the contents of the b-tree node stored
7179** on page pFrom to page pTo. If page pFrom was not a leaf page, then
7180** the pointer-map entries for each child page are updated so that the
7181** parent page stored in the pointer map is page pTo. If pFrom contained
7182** any cells with overflow page pointers, then the corresponding pointer
7183** map entries are also updated so that the parent page is page pTo.
7184**
7185** If pFrom is currently carrying any overflow cells (entries in the
drh2cbd78b2012-02-02 19:37:18 +00007186** MemPage.apOvfl[] array), they are not copied to pTo.
danielk1977cd581a72009-06-23 15:43:39 +00007187**
danielk197730548662009-07-09 05:07:37 +00007188** Before returning, page pTo is reinitialized using btreeInitPage().
danielk1977cd581a72009-06-23 15:43:39 +00007189**
7190** The performance of this function is not critical. It is only used by
7191** the balance_shallower() and balance_deeper() procedures, neither of
7192** which are called often under normal circumstances.
7193*/
drhc314dc72009-07-21 11:52:34 +00007194static void copyNodeContent(MemPage *pFrom, MemPage *pTo, int *pRC){
7195 if( (*pRC)==SQLITE_OK ){
7196 BtShared * const pBt = pFrom->pBt;
7197 u8 * const aFrom = pFrom->aData;
7198 u8 * const aTo = pTo->aData;
7199 int const iFromHdr = pFrom->hdrOffset;
7200 int const iToHdr = ((pTo->pgno==1) ? 100 : 0);
drhdc9b5f82009-12-05 18:34:08 +00007201 int rc;
drhc314dc72009-07-21 11:52:34 +00007202 int iData;
7203
7204
7205 assert( pFrom->isInit );
7206 assert( pFrom->nFree>=iToHdr );
drhfcd71b62011-04-05 22:08:24 +00007207 assert( get2byte(&aFrom[iFromHdr+5]) <= (int)pBt->usableSize );
drhc314dc72009-07-21 11:52:34 +00007208
7209 /* Copy the b-tree node content from page pFrom to page pTo. */
7210 iData = get2byte(&aFrom[iFromHdr+5]);
7211 memcpy(&aTo[iData], &aFrom[iData], pBt->usableSize-iData);
7212 memcpy(&aTo[iToHdr], &aFrom[iFromHdr], pFrom->cellOffset + 2*pFrom->nCell);
7213
7214 /* Reinitialize page pTo so that the contents of the MemPage structure
dan89e060e2009-12-05 18:03:50 +00007215 ** match the new data. The initialization of pTo can actually fail under
7216 ** fairly obscure circumstances, even though it is a copy of initialized
7217 ** page pFrom.
7218 */
drhc314dc72009-07-21 11:52:34 +00007219 pTo->isInit = 0;
dan89e060e2009-12-05 18:03:50 +00007220 rc = btreeInitPage(pTo);
7221 if( rc!=SQLITE_OK ){
7222 *pRC = rc;
7223 return;
7224 }
drhc314dc72009-07-21 11:52:34 +00007225
7226 /* If this is an auto-vacuum database, update the pointer-map entries
7227 ** for any b-tree or overflow pages that pTo now contains the pointers to.
7228 */
7229 if( ISAUTOVACUUM ){
7230 *pRC = setChildPtrmaps(pTo);
7231 }
danielk1977cd581a72009-06-23 15:43:39 +00007232 }
danielk1977cd581a72009-06-23 15:43:39 +00007233}
7234
7235/*
danielk19774dbaa892009-06-16 16:50:22 +00007236** This routine redistributes cells on the iParentIdx'th child of pParent
7237** (hereafter "the page") and up to 2 siblings so that all pages have about the
7238** same amount of free space. Usually a single sibling on either side of the
7239** page are used in the balancing, though both siblings might come from one
7240** side if the page is the first or last child of its parent. If the page
7241** has fewer than 2 siblings (something which can only happen if the page
7242** is a root page or a child of a root page) then all available siblings
7243** participate in the balancing.
drh8b2f49b2001-06-08 00:21:52 +00007244**
danielk19774dbaa892009-06-16 16:50:22 +00007245** The number of siblings of the page might be increased or decreased by
7246** one or two in an effort to keep pages nearly full but not over full.
drh14acc042001-06-10 19:56:58 +00007247**
danielk19774dbaa892009-06-16 16:50:22 +00007248** Note that when this routine is called, some of the cells on the page
7249** might not actually be stored in MemPage.aData[]. This can happen
7250** if the page is overfull. This routine ensures that all cells allocated
7251** to the page and its siblings fit into MemPage.aData[] before returning.
drh14acc042001-06-10 19:56:58 +00007252**
danielk19774dbaa892009-06-16 16:50:22 +00007253** In the course of balancing the page and its siblings, cells may be
7254** inserted into or removed from the parent page (pParent). Doing so
7255** may cause the parent page to become overfull or underfull. If this
7256** happens, it is the responsibility of the caller to invoke the correct
7257** balancing routine to fix this problem (see the balance() routine).
drh8c42ca92001-06-22 19:15:00 +00007258**
drh5e00f6c2001-09-13 13:46:56 +00007259** If this routine fails for any reason, it might leave the database
danielk19776067a9b2009-06-09 09:41:00 +00007260** in a corrupted state. So if this routine fails, the database should
drh5e00f6c2001-09-13 13:46:56 +00007261** be rolled back.
danielk19774dbaa892009-06-16 16:50:22 +00007262**
7263** The third argument to this function, aOvflSpace, is a pointer to a
drhcd09c532009-07-20 19:30:00 +00007264** buffer big enough to hold one page. If while inserting cells into the parent
7265** page (pParent) the parent page becomes overfull, this buffer is
7266** used to store the parent's overflow cells. Because this function inserts
danielk19774dbaa892009-06-16 16:50:22 +00007267** a maximum of four divider cells into the parent page, and the maximum
7268** size of a cell stored within an internal node is always less than 1/4
7269** of the page-size, the aOvflSpace[] buffer is guaranteed to be large
7270** enough for all overflow cells.
7271**
7272** If aOvflSpace is set to a null pointer, this function returns
7273** SQLITE_NOMEM.
drh8b2f49b2001-06-08 00:21:52 +00007274*/
danielk19774dbaa892009-06-16 16:50:22 +00007275static int balance_nonroot(
7276 MemPage *pParent, /* Parent page of siblings being balanced */
7277 int iParentIdx, /* Index of "the page" in pParent */
danielk1977cd581a72009-06-23 15:43:39 +00007278 u8 *aOvflSpace, /* page-size bytes of space for parent ovfl */
dan428c2182012-08-06 18:50:11 +00007279 int isRoot, /* True if pParent is a root-page */
7280 int bBulk /* True if this call is part of a bulk load */
danielk19774dbaa892009-06-16 16:50:22 +00007281){
drh16a9b832007-05-05 18:39:25 +00007282 BtShared *pBt; /* The whole database */
danielk1977634f2982005-03-28 08:44:07 +00007283 int nMaxCells = 0; /* Allocated size of apCell, szCell, aFrom. */
danielk1977a4124bd2008-12-23 10:37:47 +00007284 int nNew = 0; /* Number of pages in apNew[] */
danielk19774dbaa892009-06-16 16:50:22 +00007285 int nOld; /* Number of pages in apOld[] */
drh14acc042001-06-10 19:56:58 +00007286 int i, j, k; /* Loop counters */
drha34b6762004-05-07 13:30:42 +00007287 int nxDiv; /* Next divider slot in pParent->aCell[] */
shane85095702009-06-15 16:27:08 +00007288 int rc = SQLITE_OK; /* The return code */
shane36840fd2009-06-26 16:32:13 +00007289 u16 leafCorrection; /* 4 if pPage is a leaf. 0 if not */
drh8b18dd42004-05-12 19:18:15 +00007290 int leafData; /* True if pPage is a leaf of a LEAFDATA tree */
drh91025292004-05-03 19:49:32 +00007291 int usableSpace; /* Bytes in pPage beyond the header */
7292 int pageFlags; /* Value of pPage->aData[0] */
drhe5ae5732008-06-15 02:51:47 +00007293 int iSpace1 = 0; /* First unused byte of aSpace1[] */
danielk19776067a9b2009-06-09 09:41:00 +00007294 int iOvflSpace = 0; /* First unused byte of aOvflSpace[] */
drhfacf0302008-06-17 15:12:00 +00007295 int szScratch; /* Size of scratch memory requested */
drhc3b70572003-01-04 19:44:07 +00007296 MemPage *apOld[NB]; /* pPage and up to two siblings */
drha2fce642004-06-05 00:01:44 +00007297 MemPage *apNew[NB+2]; /* pPage and up to NB siblings after balancing */
danielk19774dbaa892009-06-16 16:50:22 +00007298 u8 *pRight; /* Location in parent of right-sibling pointer */
7299 u8 *apDiv[NB-1]; /* Divider cells in pParent */
drh1ffd2472015-06-23 02:37:30 +00007300 int cntNew[NB+2]; /* Index in b.paCell[] of cell after i-th page */
7301 int cntOld[NB+2]; /* Old index in b.apCell[] */
drh2a0df922014-10-30 23:14:56 +00007302 int szNew[NB+2]; /* Combined size of cells placed on i-th page */
danielk19774dbaa892009-06-16 16:50:22 +00007303 u8 *aSpace1; /* Space for copies of dividers cells */
7304 Pgno pgno; /* Temp var to store a page number in */
dane6593d82014-10-24 16:40:49 +00007305 u8 abDone[NB+2]; /* True after i'th new page is populated */
7306 Pgno aPgno[NB+2]; /* Page numbers of new pages before shuffling */
drh00fe08a2014-10-31 00:05:23 +00007307 Pgno aPgOrder[NB+2]; /* Copy of aPgno[] used for sorting pages */
dane6593d82014-10-24 16:40:49 +00007308 u16 aPgFlags[NB+2]; /* flags field of new pages before shuffling */
drh1ffd2472015-06-23 02:37:30 +00007309 CellArray b; /* Parsed information on cells being balanced */
drh8b2f49b2001-06-08 00:21:52 +00007310
dan33ea4862014-10-09 19:35:37 +00007311 memset(abDone, 0, sizeof(abDone));
drh1ffd2472015-06-23 02:37:30 +00007312 b.nCell = 0;
7313 b.apCell = 0;
danielk1977a50d9aa2009-06-08 14:49:45 +00007314 pBt = pParent->pBt;
7315 assert( sqlite3_mutex_held(pBt->mutex) );
7316 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk1977474b7cc2008-07-09 11:49:46 +00007317
danielk1977e5765212009-06-17 11:13:28 +00007318#if 0
drh43605152004-05-29 21:46:49 +00007319 TRACE(("BALANCE: begin page %d child of %d\n", pPage->pgno, pParent->pgno));
danielk1977e5765212009-06-17 11:13:28 +00007320#endif
drh2e38c322004-09-03 18:38:44 +00007321
danielk19774dbaa892009-06-16 16:50:22 +00007322 /* At this point pParent may have at most one overflow cell. And if
7323 ** this overflow cell is present, it must be the cell with
7324 ** index iParentIdx. This scenario comes about when this function
drhcd09c532009-07-20 19:30:00 +00007325 ** is called (indirectly) from sqlite3BtreeDelete().
7326 */
danielk19774dbaa892009-06-16 16:50:22 +00007327 assert( pParent->nOverflow==0 || pParent->nOverflow==1 );
drh2cbd78b2012-02-02 19:37:18 +00007328 assert( pParent->nOverflow==0 || pParent->aiOvfl[0]==iParentIdx );
danielk19774dbaa892009-06-16 16:50:22 +00007329
danielk197711a8a862009-06-17 11:49:52 +00007330 if( !aOvflSpace ){
mistachkinfad30392016-02-13 23:43:46 +00007331 return SQLITE_NOMEM_BKPT;
danielk197711a8a862009-06-17 11:49:52 +00007332 }
7333
danielk1977a50d9aa2009-06-08 14:49:45 +00007334 /* Find the sibling pages to balance. Also locate the cells in pParent
7335 ** that divide the siblings. An attempt is made to find NN siblings on
7336 ** either side of pPage. More siblings are taken from one side, however,
7337 ** if there are fewer than NN siblings on the other side. If pParent
danielk19774dbaa892009-06-16 16:50:22 +00007338 ** has NB or fewer children then all children of pParent are taken.
7339 **
7340 ** This loop also drops the divider cells from the parent page. This
7341 ** way, the remainder of the function does not have to deal with any
drhcd09c532009-07-20 19:30:00 +00007342 ** overflow cells in the parent page, since if any existed they will
7343 ** have already been removed.
7344 */
danielk19774dbaa892009-06-16 16:50:22 +00007345 i = pParent->nOverflow + pParent->nCell;
7346 if( i<2 ){
drhc3b70572003-01-04 19:44:07 +00007347 nxDiv = 0;
danielk19774dbaa892009-06-16 16:50:22 +00007348 }else{
dan7d6885a2012-08-08 14:04:56 +00007349 assert( bBulk==0 || bBulk==1 );
danielk19774dbaa892009-06-16 16:50:22 +00007350 if( iParentIdx==0 ){
7351 nxDiv = 0;
7352 }else if( iParentIdx==i ){
dan7d6885a2012-08-08 14:04:56 +00007353 nxDiv = i-2+bBulk;
drh14acc042001-06-10 19:56:58 +00007354 }else{
danielk19774dbaa892009-06-16 16:50:22 +00007355 nxDiv = iParentIdx-1;
drh8b2f49b2001-06-08 00:21:52 +00007356 }
dan7d6885a2012-08-08 14:04:56 +00007357 i = 2-bBulk;
danielk19774dbaa892009-06-16 16:50:22 +00007358 }
dan7d6885a2012-08-08 14:04:56 +00007359 nOld = i+1;
danielk19774dbaa892009-06-16 16:50:22 +00007360 if( (i+nxDiv-pParent->nOverflow)==pParent->nCell ){
7361 pRight = &pParent->aData[pParent->hdrOffset+8];
7362 }else{
7363 pRight = findCell(pParent, i+nxDiv-pParent->nOverflow);
7364 }
7365 pgno = get4byte(pRight);
7366 while( 1 ){
drh28f58dd2015-06-27 19:45:03 +00007367 rc = getAndInitPage(pBt, pgno, &apOld[i], 0, 0);
danielk19774dbaa892009-06-16 16:50:22 +00007368 if( rc ){
danielk197789bc4bc2009-07-21 19:25:24 +00007369 memset(apOld, 0, (i+1)*sizeof(MemPage*));
danielk19774dbaa892009-06-16 16:50:22 +00007370 goto balance_cleanup;
7371 }
danielk1977634f2982005-03-28 08:44:07 +00007372 nMaxCells += 1+apOld[i]->nCell+apOld[i]->nOverflow;
danielk19774dbaa892009-06-16 16:50:22 +00007373 if( (i--)==0 ) break;
7374
drh9cc5b4e2016-12-26 01:41:33 +00007375 if( pParent->nOverflow && i+nxDiv==pParent->aiOvfl[0] ){
drh2cbd78b2012-02-02 19:37:18 +00007376 apDiv[i] = pParent->apOvfl[0];
danielk19774dbaa892009-06-16 16:50:22 +00007377 pgno = get4byte(apDiv[i]);
drh25ada072015-06-19 15:07:14 +00007378 szNew[i] = pParent->xCellSize(pParent, apDiv[i]);
danielk19774dbaa892009-06-16 16:50:22 +00007379 pParent->nOverflow = 0;
7380 }else{
7381 apDiv[i] = findCell(pParent, i+nxDiv-pParent->nOverflow);
7382 pgno = get4byte(apDiv[i]);
drh25ada072015-06-19 15:07:14 +00007383 szNew[i] = pParent->xCellSize(pParent, apDiv[i]);
danielk19774dbaa892009-06-16 16:50:22 +00007384
7385 /* Drop the cell from the parent page. apDiv[i] still points to
7386 ** the cell within the parent, even though it has been dropped.
7387 ** This is safe because dropping a cell only overwrites the first
7388 ** four bytes of it, and this function does not need the first
7389 ** four bytes of the divider cell. So the pointer is safe to use
danielk197711a8a862009-06-17 11:49:52 +00007390 ** later on.
7391 **
drh8a575d92011-10-12 17:00:28 +00007392 ** But not if we are in secure-delete mode. In secure-delete mode,
danielk197711a8a862009-06-17 11:49:52 +00007393 ** the dropCell() routine will overwrite the entire cell with zeroes.
7394 ** In this case, temporarily copy the cell into the aOvflSpace[]
7395 ** buffer. It will be copied out again as soon as the aSpace[] buffer
7396 ** is allocated. */
drha5907a82017-06-19 11:44:22 +00007397 if( pBt->btsFlags & BTS_FAST_SECURE ){
drh8a575d92011-10-12 17:00:28 +00007398 int iOff;
7399
7400 iOff = SQLITE_PTR_TO_INT(apDiv[i]) - SQLITE_PTR_TO_INT(pParent->aData);
drh43b18e12010-08-17 19:40:08 +00007401 if( (iOff+szNew[i])>(int)pBt->usableSize ){
dan2ed11e72010-02-26 15:09:19 +00007402 rc = SQLITE_CORRUPT_BKPT;
7403 memset(apOld, 0, (i+1)*sizeof(MemPage*));
7404 goto balance_cleanup;
7405 }else{
7406 memcpy(&aOvflSpace[iOff], apDiv[i], szNew[i]);
7407 apDiv[i] = &aOvflSpace[apDiv[i]-pParent->aData];
7408 }
drh5b47efa2010-02-12 18:18:39 +00007409 }
drh98add2e2009-07-20 17:11:49 +00007410 dropCell(pParent, i+nxDiv-pParent->nOverflow, szNew[i], &rc);
danielk19774dbaa892009-06-16 16:50:22 +00007411 }
drh8b2f49b2001-06-08 00:21:52 +00007412 }
7413
drha9121e42008-02-19 14:59:35 +00007414 /* Make nMaxCells a multiple of 4 in order to preserve 8-byte
drh8d97f1f2005-05-05 18:14:13 +00007415 ** alignment */
drha9121e42008-02-19 14:59:35 +00007416 nMaxCells = (nMaxCells + 3)&~3;
drh8d97f1f2005-05-05 18:14:13 +00007417
drh8b2f49b2001-06-08 00:21:52 +00007418 /*
danielk1977634f2982005-03-28 08:44:07 +00007419 ** Allocate space for memory structures
7420 */
drhfacf0302008-06-17 15:12:00 +00007421 szScratch =
drh1ffd2472015-06-23 02:37:30 +00007422 nMaxCells*sizeof(u8*) /* b.apCell */
7423 + nMaxCells*sizeof(u16) /* b.szCell */
dan33ea4862014-10-09 19:35:37 +00007424 + pBt->pageSize; /* aSpace1 */
drh5279d342014-11-04 13:41:32 +00007425
mistachkin0fbd7352014-12-09 04:26:56 +00007426 assert( szScratch<=6*(int)pBt->pageSize );
drhb2a0f752017-08-28 15:51:35 +00007427 b.apCell = sqlite3StackAllocRaw(0, szScratch );
drh1ffd2472015-06-23 02:37:30 +00007428 if( b.apCell==0 ){
mistachkinfad30392016-02-13 23:43:46 +00007429 rc = SQLITE_NOMEM_BKPT;
danielk1977634f2982005-03-28 08:44:07 +00007430 goto balance_cleanup;
7431 }
drh1ffd2472015-06-23 02:37:30 +00007432 b.szCell = (u16*)&b.apCell[nMaxCells];
7433 aSpace1 = (u8*)&b.szCell[nMaxCells];
drhea598cb2009-04-05 12:22:08 +00007434 assert( EIGHT_BYTE_ALIGNMENT(aSpace1) );
drh14acc042001-06-10 19:56:58 +00007435
7436 /*
7437 ** Load pointers to all cells on sibling pages and the divider cells
drh1ffd2472015-06-23 02:37:30 +00007438 ** into the local b.apCell[] array. Make copies of the divider cells
dan33ea4862014-10-09 19:35:37 +00007439 ** into space obtained from aSpace1[]. The divider cells have already
7440 ** been removed from pParent.
drh4b70f112004-05-02 21:12:19 +00007441 **
7442 ** If the siblings are on leaf pages, then the child pointers of the
7443 ** divider cells are stripped from the cells before they are copied
drh1ffd2472015-06-23 02:37:30 +00007444 ** into aSpace1[]. In this way, all cells in b.apCell[] are without
drh4b70f112004-05-02 21:12:19 +00007445 ** child pointers. If siblings are not leaves, then all cell in
drh1ffd2472015-06-23 02:37:30 +00007446 ** b.apCell[] include child pointers. Either way, all cells in b.apCell[]
drh4b70f112004-05-02 21:12:19 +00007447 ** are alike.
drh96f5b762004-05-16 16:24:36 +00007448 **
7449 ** leafCorrection: 4 if pPage is a leaf. 0 if pPage is not a leaf.
7450 ** leafData: 1 if pPage holds key+data and pParent holds only keys.
drh8b2f49b2001-06-08 00:21:52 +00007451 */
drh1ffd2472015-06-23 02:37:30 +00007452 b.pRef = apOld[0];
7453 leafCorrection = b.pRef->leaf*4;
7454 leafData = b.pRef->intKeyLeaf;
drh8b2f49b2001-06-08 00:21:52 +00007455 for(i=0; i<nOld; i++){
dan33ea4862014-10-09 19:35:37 +00007456 MemPage *pOld = apOld[i];
drh4edfdd32015-06-23 14:49:42 +00007457 int limit = pOld->nCell;
7458 u8 *aData = pOld->aData;
7459 u16 maskPage = pOld->maskPage;
drh4f4bf772015-06-23 17:09:53 +00007460 u8 *piCell = aData + pOld->cellOffset;
drhfe647dc2015-06-23 18:24:25 +00007461 u8 *piEnd;
danielk19774dbaa892009-06-16 16:50:22 +00007462
drh73d340a2015-05-28 11:23:11 +00007463 /* Verify that all sibling pages are of the same "type" (table-leaf,
7464 ** table-interior, index-leaf, or index-interior).
7465 */
7466 if( pOld->aData[0]!=apOld[0]->aData[0] ){
7467 rc = SQLITE_CORRUPT_BKPT;
7468 goto balance_cleanup;
7469 }
7470
drhfe647dc2015-06-23 18:24:25 +00007471 /* Load b.apCell[] with pointers to all cells in pOld. If pOld
drh8d7f1632018-01-23 13:30:38 +00007472 ** contains overflow cells, include them in the b.apCell[] array
drhfe647dc2015-06-23 18:24:25 +00007473 ** in the correct spot.
7474 **
7475 ** Note that when there are multiple overflow cells, it is always the
7476 ** case that they are sequential and adjacent. This invariant arises
7477 ** because multiple overflows can only occurs when inserting divider
7478 ** cells into a parent on a prior balance, and divider cells are always
7479 ** adjacent and are inserted in order. There is an assert() tagged
7480 ** with "NOTE 1" in the overflow cell insertion loop to prove this
7481 ** invariant.
drh4edfdd32015-06-23 14:49:42 +00007482 **
7483 ** This must be done in advance. Once the balance starts, the cell
7484 ** offset section of the btree page will be overwritten and we will no
7485 ** long be able to find the cells if a pointer to each cell is not saved
7486 ** first.
7487 */
drh36b78ee2016-01-20 01:32:00 +00007488 memset(&b.szCell[b.nCell], 0, sizeof(b.szCell[0])*(limit+pOld->nOverflow));
drh68f2a572011-06-03 17:50:49 +00007489 if( pOld->nOverflow>0 ){
drhfe647dc2015-06-23 18:24:25 +00007490 limit = pOld->aiOvfl[0];
drh68f2a572011-06-03 17:50:49 +00007491 for(j=0; j<limit; j++){
drh329428e2015-06-30 13:28:18 +00007492 b.apCell[b.nCell] = aData + (maskPage & get2byteAligned(piCell));
drhfe647dc2015-06-23 18:24:25 +00007493 piCell += 2;
7494 b.nCell++;
drh68f2a572011-06-03 17:50:49 +00007495 }
drhfe647dc2015-06-23 18:24:25 +00007496 for(k=0; k<pOld->nOverflow; k++){
7497 assert( k==0 || pOld->aiOvfl[k-1]+1==pOld->aiOvfl[k] );/* NOTE 1 */
drh4edfdd32015-06-23 14:49:42 +00007498 b.apCell[b.nCell] = pOld->apOvfl[k];
drh1ffd2472015-06-23 02:37:30 +00007499 b.nCell++;
drh68f2a572011-06-03 17:50:49 +00007500 }
drh1ffd2472015-06-23 02:37:30 +00007501 }
drhfe647dc2015-06-23 18:24:25 +00007502 piEnd = aData + pOld->cellOffset + 2*pOld->nCell;
7503 while( piCell<piEnd ){
drh4edfdd32015-06-23 14:49:42 +00007504 assert( b.nCell<nMaxCells );
drh329428e2015-06-30 13:28:18 +00007505 b.apCell[b.nCell] = aData + (maskPage & get2byteAligned(piCell));
drh4f4bf772015-06-23 17:09:53 +00007506 piCell += 2;
drh4edfdd32015-06-23 14:49:42 +00007507 b.nCell++;
drh4edfdd32015-06-23 14:49:42 +00007508 }
7509
drh1ffd2472015-06-23 02:37:30 +00007510 cntOld[i] = b.nCell;
danielk19774dbaa892009-06-16 16:50:22 +00007511 if( i<nOld-1 && !leafData){
shane36840fd2009-06-26 16:32:13 +00007512 u16 sz = (u16)szNew[i];
danielk19774dbaa892009-06-16 16:50:22 +00007513 u8 *pTemp;
drh1ffd2472015-06-23 02:37:30 +00007514 assert( b.nCell<nMaxCells );
7515 b.szCell[b.nCell] = sz;
danielk19774dbaa892009-06-16 16:50:22 +00007516 pTemp = &aSpace1[iSpace1];
7517 iSpace1 += sz;
drhe22e03e2010-08-18 21:19:03 +00007518 assert( sz<=pBt->maxLocal+23 );
drhfcd71b62011-04-05 22:08:24 +00007519 assert( iSpace1 <= (int)pBt->pageSize );
danielk19774dbaa892009-06-16 16:50:22 +00007520 memcpy(pTemp, apDiv[i], sz);
drh1ffd2472015-06-23 02:37:30 +00007521 b.apCell[b.nCell] = pTemp+leafCorrection;
danielk19774dbaa892009-06-16 16:50:22 +00007522 assert( leafCorrection==0 || leafCorrection==4 );
drh1ffd2472015-06-23 02:37:30 +00007523 b.szCell[b.nCell] = b.szCell[b.nCell] - leafCorrection;
danielk19774dbaa892009-06-16 16:50:22 +00007524 if( !pOld->leaf ){
7525 assert( leafCorrection==0 );
7526 assert( pOld->hdrOffset==0 );
7527 /* The right pointer of the child page pOld becomes the left
7528 ** pointer of the divider cell */
drh1ffd2472015-06-23 02:37:30 +00007529 memcpy(b.apCell[b.nCell], &pOld->aData[8], 4);
danielk19774dbaa892009-06-16 16:50:22 +00007530 }else{
7531 assert( leafCorrection==4 );
drh1ffd2472015-06-23 02:37:30 +00007532 while( b.szCell[b.nCell]<4 ){
dan8f1eb8a2014-12-06 14:56:49 +00007533 /* Do not allow any cells smaller than 4 bytes. If a smaller cell
7534 ** does exist, pad it with 0x00 bytes. */
drh1ffd2472015-06-23 02:37:30 +00007535 assert( b.szCell[b.nCell]==3 || CORRUPT_DB );
7536 assert( b.apCell[b.nCell]==&aSpace1[iSpace1-3] || CORRUPT_DB );
danee7172f2014-12-24 18:11:50 +00007537 aSpace1[iSpace1++] = 0x00;
drh1ffd2472015-06-23 02:37:30 +00007538 b.szCell[b.nCell]++;
danielk1977ac11ee62005-01-15 12:45:51 +00007539 }
7540 }
drh1ffd2472015-06-23 02:37:30 +00007541 b.nCell++;
drh8b2f49b2001-06-08 00:21:52 +00007542 }
drh8b2f49b2001-06-08 00:21:52 +00007543 }
7544
7545 /*
drh1ffd2472015-06-23 02:37:30 +00007546 ** Figure out the number of pages needed to hold all b.nCell cells.
drh6019e162001-07-02 17:51:45 +00007547 ** Store this number in "k". Also compute szNew[] which is the total
7548 ** size of all cells on the i-th page and cntNew[] which is the index
drh1ffd2472015-06-23 02:37:30 +00007549 ** in b.apCell[] of the cell that divides page i from page i+1.
7550 ** cntNew[k] should equal b.nCell.
drh6019e162001-07-02 17:51:45 +00007551 **
drh96f5b762004-05-16 16:24:36 +00007552 ** Values computed by this block:
7553 **
7554 ** k: The total number of sibling pages
7555 ** szNew[i]: Spaced used on the i-th sibling page.
drh1ffd2472015-06-23 02:37:30 +00007556 ** cntNew[i]: Index in b.apCell[] and b.szCell[] for the first cell to
drh96f5b762004-05-16 16:24:36 +00007557 ** the right of the i-th sibling page.
7558 ** usableSpace: Number of bytes of space available on each sibling.
7559 **
drh8b2f49b2001-06-08 00:21:52 +00007560 */
drh43605152004-05-29 21:46:49 +00007561 usableSpace = pBt->usableSize - 12 + leafCorrection;
drh658873b2015-06-22 20:02:04 +00007562 for(i=0; i<nOld; i++){
7563 MemPage *p = apOld[i];
7564 szNew[i] = usableSpace - p->nFree;
drh658873b2015-06-22 20:02:04 +00007565 for(j=0; j<p->nOverflow; j++){
7566 szNew[i] += 2 + p->xCellSize(p, p->apOvfl[j]);
7567 }
7568 cntNew[i] = cntOld[i];
7569 }
7570 k = nOld;
7571 for(i=0; i<k; i++){
7572 int sz;
7573 while( szNew[i]>usableSpace ){
7574 if( i+1>=k ){
7575 k = i+2;
7576 if( k>NB+2 ){ rc = SQLITE_CORRUPT_BKPT; goto balance_cleanup; }
7577 szNew[k-1] = 0;
drh1ffd2472015-06-23 02:37:30 +00007578 cntNew[k-1] = b.nCell;
drh658873b2015-06-22 20:02:04 +00007579 }
drh1ffd2472015-06-23 02:37:30 +00007580 sz = 2 + cachedCellSize(&b, cntNew[i]-1);
drh658873b2015-06-22 20:02:04 +00007581 szNew[i] -= sz;
7582 if( !leafData ){
drh1ffd2472015-06-23 02:37:30 +00007583 if( cntNew[i]<b.nCell ){
7584 sz = 2 + cachedCellSize(&b, cntNew[i]);
7585 }else{
7586 sz = 0;
7587 }
drh658873b2015-06-22 20:02:04 +00007588 }
7589 szNew[i+1] += sz;
7590 cntNew[i]--;
7591 }
drh1ffd2472015-06-23 02:37:30 +00007592 while( cntNew[i]<b.nCell ){
7593 sz = 2 + cachedCellSize(&b, cntNew[i]);
drh658873b2015-06-22 20:02:04 +00007594 if( szNew[i]+sz>usableSpace ) break;
7595 szNew[i] += sz;
7596 cntNew[i]++;
7597 if( !leafData ){
drh1ffd2472015-06-23 02:37:30 +00007598 if( cntNew[i]<b.nCell ){
7599 sz = 2 + cachedCellSize(&b, cntNew[i]);
7600 }else{
7601 sz = 0;
7602 }
drh658873b2015-06-22 20:02:04 +00007603 }
7604 szNew[i+1] -= sz;
7605 }
drh1ffd2472015-06-23 02:37:30 +00007606 if( cntNew[i]>=b.nCell ){
drh658873b2015-06-22 20:02:04 +00007607 k = i+1;
drh672073a2015-06-24 12:07:40 +00007608 }else if( cntNew[i] <= (i>0 ? cntNew[i-1] : 0) ){
drh658873b2015-06-22 20:02:04 +00007609 rc = SQLITE_CORRUPT_BKPT;
7610 goto balance_cleanup;
drh6019e162001-07-02 17:51:45 +00007611 }
7612 }
drh96f5b762004-05-16 16:24:36 +00007613
7614 /*
7615 ** The packing computed by the previous block is biased toward the siblings
drh2a0df922014-10-30 23:14:56 +00007616 ** on the left side (siblings with smaller keys). The left siblings are
7617 ** always nearly full, while the right-most sibling might be nearly empty.
7618 ** The next block of code attempts to adjust the packing of siblings to
7619 ** get a better balance.
drh96f5b762004-05-16 16:24:36 +00007620 **
7621 ** This adjustment is more than an optimization. The packing above might
7622 ** be so out of balance as to be illegal. For example, the right-most
7623 ** sibling might be completely empty. This adjustment is not optional.
7624 */
drh6019e162001-07-02 17:51:45 +00007625 for(i=k-1; i>0; i--){
drh96f5b762004-05-16 16:24:36 +00007626 int szRight = szNew[i]; /* Size of sibling on the right */
7627 int szLeft = szNew[i-1]; /* Size of sibling on the left */
7628 int r; /* Index of right-most cell in left sibling */
7629 int d; /* Index of first cell to the left of right sibling */
7630
7631 r = cntNew[i-1] - 1;
7632 d = r + 1 - leafData;
drh008d64c2015-06-23 16:00:24 +00007633 (void)cachedCellSize(&b, d);
drh672073a2015-06-24 12:07:40 +00007634 do{
drh1ffd2472015-06-23 02:37:30 +00007635 assert( d<nMaxCells );
7636 assert( r<nMaxCells );
drh1ffd2472015-06-23 02:37:30 +00007637 (void)cachedCellSize(&b, r);
7638 if( szRight!=0
drh0b4c0422016-07-14 19:48:08 +00007639 && (bBulk || szRight+b.szCell[d]+2 > szLeft-(b.szCell[r]+(i==k-1?0:2)))){
drh1ffd2472015-06-23 02:37:30 +00007640 break;
7641 }
7642 szRight += b.szCell[d] + 2;
7643 szLeft -= b.szCell[r] + 2;
drh008d64c2015-06-23 16:00:24 +00007644 cntNew[i-1] = r;
drh008d64c2015-06-23 16:00:24 +00007645 r--;
7646 d--;
drh672073a2015-06-24 12:07:40 +00007647 }while( r>=0 );
drh96f5b762004-05-16 16:24:36 +00007648 szNew[i] = szRight;
7649 szNew[i-1] = szLeft;
drh672073a2015-06-24 12:07:40 +00007650 if( cntNew[i-1] <= (i>1 ? cntNew[i-2] : 0) ){
7651 rc = SQLITE_CORRUPT_BKPT;
7652 goto balance_cleanup;
7653 }
drh6019e162001-07-02 17:51:45 +00007654 }
drh09d0deb2005-08-02 17:13:09 +00007655
drh2a0df922014-10-30 23:14:56 +00007656 /* Sanity check: For a non-corrupt database file one of the follwing
7657 ** must be true:
7658 ** (1) We found one or more cells (cntNew[0])>0), or
7659 ** (2) pPage is a virtual root page. A virtual root page is when
7660 ** the real root page is page 1 and we are the only child of
7661 ** that page.
drh09d0deb2005-08-02 17:13:09 +00007662 */
drh2a0df922014-10-30 23:14:56 +00007663 assert( cntNew[0]>0 || (pParent->pgno==1 && pParent->nCell==0) || CORRUPT_DB);
dan33ea4862014-10-09 19:35:37 +00007664 TRACE(("BALANCE: old: %d(nc=%d) %d(nc=%d) %d(nc=%d)\n",
7665 apOld[0]->pgno, apOld[0]->nCell,
7666 nOld>=2 ? apOld[1]->pgno : 0, nOld>=2 ? apOld[1]->nCell : 0,
7667 nOld>=3 ? apOld[2]->pgno : 0, nOld>=3 ? apOld[2]->nCell : 0
danielk1977e5765212009-06-17 11:13:28 +00007668 ));
7669
drh8b2f49b2001-06-08 00:21:52 +00007670 /*
drh6b308672002-07-08 02:16:37 +00007671 ** Allocate k new pages. Reuse old pages where possible.
drh8b2f49b2001-06-08 00:21:52 +00007672 */
danielk1977a50d9aa2009-06-08 14:49:45 +00007673 pageFlags = apOld[0]->aData[0];
drh14acc042001-06-10 19:56:58 +00007674 for(i=0; i<k; i++){
drhda200cc2004-05-09 11:51:38 +00007675 MemPage *pNew;
drh6b308672002-07-08 02:16:37 +00007676 if( i<nOld ){
drhda200cc2004-05-09 11:51:38 +00007677 pNew = apNew[i] = apOld[i];
drh6b308672002-07-08 02:16:37 +00007678 apOld[i] = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00007679 rc = sqlite3PagerWrite(pNew->pDbPage);
drhf5345442007-04-09 12:45:02 +00007680 nNew++;
danielk197728129562005-01-11 10:25:06 +00007681 if( rc ) goto balance_cleanup;
drh6b308672002-07-08 02:16:37 +00007682 }else{
drh7aa8f852006-03-28 00:24:44 +00007683 assert( i>0 );
dan428c2182012-08-06 18:50:11 +00007684 rc = allocateBtreePage(pBt, &pNew, &pgno, (bBulk ? 1 : pgno), 0);
drh6b308672002-07-08 02:16:37 +00007685 if( rc ) goto balance_cleanup;
dan33ea4862014-10-09 19:35:37 +00007686 zeroPage(pNew, pageFlags);
drhda200cc2004-05-09 11:51:38 +00007687 apNew[i] = pNew;
drhf5345442007-04-09 12:45:02 +00007688 nNew++;
drh1ffd2472015-06-23 02:37:30 +00007689 cntOld[i] = b.nCell;
danielk19774dbaa892009-06-16 16:50:22 +00007690
7691 /* Set the pointer-map entry for the new sibling page. */
7692 if( ISAUTOVACUUM ){
drh98add2e2009-07-20 17:11:49 +00007693 ptrmapPut(pBt, pNew->pgno, PTRMAP_BTREE, pParent->pgno, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00007694 if( rc!=SQLITE_OK ){
7695 goto balance_cleanup;
7696 }
7697 }
drh6b308672002-07-08 02:16:37 +00007698 }
drh8b2f49b2001-06-08 00:21:52 +00007699 }
7700
7701 /*
dan33ea4862014-10-09 19:35:37 +00007702 ** Reassign page numbers so that the new pages are in ascending order.
7703 ** This helps to keep entries in the disk file in order so that a scan
7704 ** of the table is closer to a linear scan through the file. That in turn
7705 ** helps the operating system to deliver pages from the disk more rapidly.
drhf9ffac92002-03-02 19:00:31 +00007706 **
dan33ea4862014-10-09 19:35:37 +00007707 ** An O(n^2) insertion sort algorithm is used, but since n is never more
7708 ** than (NB+2) (a small constant), that should not be a problem.
drhf9ffac92002-03-02 19:00:31 +00007709 **
dan33ea4862014-10-09 19:35:37 +00007710 ** When NB==3, this one optimization makes the database about 25% faster
7711 ** for large insertions and deletions.
drhf9ffac92002-03-02 19:00:31 +00007712 */
dan33ea4862014-10-09 19:35:37 +00007713 for(i=0; i<nNew; i++){
drh00fe08a2014-10-31 00:05:23 +00007714 aPgOrder[i] = aPgno[i] = apNew[i]->pgno;
dan33ea4862014-10-09 19:35:37 +00007715 aPgFlags[i] = apNew[i]->pDbPage->flags;
dan89ca0b32014-10-25 20:36:28 +00007716 for(j=0; j<i; j++){
7717 if( aPgno[j]==aPgno[i] ){
7718 /* This branch is taken if the set of sibling pages somehow contains
7719 ** duplicate entries. This can happen if the database is corrupt.
7720 ** It would be simpler to detect this as part of the loop below, but
drhba0f9992014-10-30 20:48:44 +00007721 ** we do the detection here in order to avoid populating the pager
7722 ** cache with two separate objects associated with the same
7723 ** page number. */
dan89ca0b32014-10-25 20:36:28 +00007724 assert( CORRUPT_DB );
7725 rc = SQLITE_CORRUPT_BKPT;
7726 goto balance_cleanup;
drhf9ffac92002-03-02 19:00:31 +00007727 }
7728 }
dan33ea4862014-10-09 19:35:37 +00007729 }
7730 for(i=0; i<nNew; i++){
dan31f4e992014-10-24 20:57:03 +00007731 int iBest = 0; /* aPgno[] index of page number to use */
dan31f4e992014-10-24 20:57:03 +00007732 for(j=1; j<nNew; j++){
drh00fe08a2014-10-31 00:05:23 +00007733 if( aPgOrder[j]<aPgOrder[iBest] ) iBest = j;
drhf9ffac92002-03-02 19:00:31 +00007734 }
drh00fe08a2014-10-31 00:05:23 +00007735 pgno = aPgOrder[iBest];
7736 aPgOrder[iBest] = 0xffffffff;
dan31f4e992014-10-24 20:57:03 +00007737 if( iBest!=i ){
7738 if( iBest>i ){
7739 sqlite3PagerRekey(apNew[iBest]->pDbPage, pBt->nPage+iBest+1, 0);
7740 }
7741 sqlite3PagerRekey(apNew[i]->pDbPage, pgno, aPgFlags[iBest]);
7742 apNew[i]->pgno = pgno;
drhf9ffac92002-03-02 19:00:31 +00007743 }
7744 }
dan33ea4862014-10-09 19:35:37 +00007745
7746 TRACE(("BALANCE: new: %d(%d nc=%d) %d(%d nc=%d) %d(%d nc=%d) "
7747 "%d(%d nc=%d) %d(%d nc=%d)\n",
7748 apNew[0]->pgno, szNew[0], cntNew[0],
danielk19774dbaa892009-06-16 16:50:22 +00007749 nNew>=2 ? apNew[1]->pgno : 0, nNew>=2 ? szNew[1] : 0,
dan33ea4862014-10-09 19:35:37 +00007750 nNew>=2 ? cntNew[1] - cntNew[0] - !leafData : 0,
danielk19774dbaa892009-06-16 16:50:22 +00007751 nNew>=3 ? apNew[2]->pgno : 0, nNew>=3 ? szNew[2] : 0,
dan33ea4862014-10-09 19:35:37 +00007752 nNew>=3 ? cntNew[2] - cntNew[1] - !leafData : 0,
danielk19774dbaa892009-06-16 16:50:22 +00007753 nNew>=4 ? apNew[3]->pgno : 0, nNew>=4 ? szNew[3] : 0,
dan33ea4862014-10-09 19:35:37 +00007754 nNew>=4 ? cntNew[3] - cntNew[2] - !leafData : 0,
7755 nNew>=5 ? apNew[4]->pgno : 0, nNew>=5 ? szNew[4] : 0,
7756 nNew>=5 ? cntNew[4] - cntNew[3] - !leafData : 0
7757 ));
danielk19774dbaa892009-06-16 16:50:22 +00007758
7759 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
7760 put4byte(pRight, apNew[nNew-1]->pgno);
drh24cd67e2004-05-10 16:18:47 +00007761
dan33ea4862014-10-09 19:35:37 +00007762 /* If the sibling pages are not leaves, ensure that the right-child pointer
7763 ** of the right-most new sibling page is set to the value that was
7764 ** originally in the same field of the right-most old sibling page. */
7765 if( (pageFlags & PTF_LEAF)==0 && nOld!=nNew ){
7766 MemPage *pOld = (nNew>nOld ? apNew : apOld)[nOld-1];
7767 memcpy(&apNew[nNew-1]->aData[8], &pOld->aData[8], 4);
7768 }
danielk1977ac11ee62005-01-15 12:45:51 +00007769
dan33ea4862014-10-09 19:35:37 +00007770 /* Make any required updates to pointer map entries associated with
7771 ** cells stored on sibling pages following the balance operation. Pointer
7772 ** map entries associated with divider cells are set by the insertCell()
7773 ** routine. The associated pointer map entries are:
7774 **
7775 ** a) if the cell contains a reference to an overflow chain, the
7776 ** entry associated with the first page in the overflow chain, and
7777 **
7778 ** b) if the sibling pages are not leaves, the child page associated
7779 ** with the cell.
7780 **
7781 ** If the sibling pages are not leaves, then the pointer map entry
7782 ** associated with the right-child of each sibling may also need to be
7783 ** updated. This happens below, after the sibling pages have been
7784 ** populated, not here.
danielk1977ac11ee62005-01-15 12:45:51 +00007785 */
dan33ea4862014-10-09 19:35:37 +00007786 if( ISAUTOVACUUM ){
7787 MemPage *pNew = apNew[0];
7788 u8 *aOld = pNew->aData;
7789 int cntOldNext = pNew->nCell + pNew->nOverflow;
7790 int usableSize = pBt->usableSize;
7791 int iNew = 0;
7792 int iOld = 0;
danielk1977ac11ee62005-01-15 12:45:51 +00007793
drh1ffd2472015-06-23 02:37:30 +00007794 for(i=0; i<b.nCell; i++){
7795 u8 *pCell = b.apCell[i];
dan33ea4862014-10-09 19:35:37 +00007796 if( i==cntOldNext ){
7797 MemPage *pOld = (++iOld)<nNew ? apNew[iOld] : apOld[iOld];
7798 cntOldNext += pOld->nCell + pOld->nOverflow + !leafData;
7799 aOld = pOld->aData;
drh4b70f112004-05-02 21:12:19 +00007800 }
dan33ea4862014-10-09 19:35:37 +00007801 if( i==cntNew[iNew] ){
7802 pNew = apNew[++iNew];
7803 if( !leafData ) continue;
7804 }
danielk197785d90ca2008-07-19 14:25:15 +00007805
dan33ea4862014-10-09 19:35:37 +00007806 /* Cell pCell is destined for new sibling page pNew. Originally, it
drhba0f9992014-10-30 20:48:44 +00007807 ** was either part of sibling page iOld (possibly an overflow cell),
dan33ea4862014-10-09 19:35:37 +00007808 ** or else the divider cell to the left of sibling page iOld. So,
7809 ** if sibling page iOld had the same page number as pNew, and if
7810 ** pCell really was a part of sibling page iOld (not a divider or
7811 ** overflow cell), we can skip updating the pointer map entries. */
drhd52d52b2014-12-06 02:05:44 +00007812 if( iOld>=nNew
7813 || pNew->pgno!=aPgno[iOld]
drhac536e62015-12-10 15:09:17 +00007814 || !SQLITE_WITHIN(pCell,aOld,&aOld[usableSize])
drhd52d52b2014-12-06 02:05:44 +00007815 ){
dan33ea4862014-10-09 19:35:37 +00007816 if( !leafCorrection ){
7817 ptrmapPut(pBt, get4byte(pCell), PTRMAP_BTREE, pNew->pgno, &rc);
7818 }
drh1ffd2472015-06-23 02:37:30 +00007819 if( cachedCellSize(&b,i)>pNew->minLocal ){
dan33ea4862014-10-09 19:35:37 +00007820 ptrmapPutOvflPtr(pNew, pCell, &rc);
danielk1977ac11ee62005-01-15 12:45:51 +00007821 }
drhea82b372015-06-23 21:35:28 +00007822 if( rc ) goto balance_cleanup;
drh43605152004-05-29 21:46:49 +00007823 }
drh14acc042001-06-10 19:56:58 +00007824 }
7825 }
dan33ea4862014-10-09 19:35:37 +00007826
7827 /* Insert new divider cells into pParent. */
7828 for(i=0; i<nNew-1; i++){
7829 u8 *pCell;
7830 u8 *pTemp;
7831 int sz;
7832 MemPage *pNew = apNew[i];
7833 j = cntNew[i];
7834
7835 assert( j<nMaxCells );
drh1ffd2472015-06-23 02:37:30 +00007836 assert( b.apCell[j]!=0 );
7837 pCell = b.apCell[j];
7838 sz = b.szCell[j] + leafCorrection;
dan33ea4862014-10-09 19:35:37 +00007839 pTemp = &aOvflSpace[iOvflSpace];
7840 if( !pNew->leaf ){
7841 memcpy(&pNew->aData[8], pCell, 4);
7842 }else if( leafData ){
7843 /* If the tree is a leaf-data tree, and the siblings are leaves,
drh1ffd2472015-06-23 02:37:30 +00007844 ** then there is no divider cell in b.apCell[]. Instead, the divider
dan33ea4862014-10-09 19:35:37 +00007845 ** cell consists of the integer key for the right-most cell of
7846 ** the sibling-page assembled above only.
7847 */
7848 CellInfo info;
7849 j--;
drh1ffd2472015-06-23 02:37:30 +00007850 pNew->xParseCell(pNew, b.apCell[j], &info);
dan33ea4862014-10-09 19:35:37 +00007851 pCell = pTemp;
7852 sz = 4 + putVarint(&pCell[4], info.nKey);
7853 pTemp = 0;
7854 }else{
7855 pCell -= 4;
7856 /* Obscure case for non-leaf-data trees: If the cell at pCell was
7857 ** previously stored on a leaf node, and its reported size was 4
7858 ** bytes, then it may actually be smaller than this
7859 ** (see btreeParseCellPtr(), 4 bytes is the minimum size of
7860 ** any cell). But it is important to pass the correct size to
7861 ** insertCell(), so reparse the cell now.
7862 **
drhc1fb2b82016-03-09 03:29:27 +00007863 ** This can only happen for b-trees used to evaluate "IN (SELECT ...)"
7864 ** and WITHOUT ROWID tables with exactly one column which is the
7865 ** primary key.
dan33ea4862014-10-09 19:35:37 +00007866 */
drh1ffd2472015-06-23 02:37:30 +00007867 if( b.szCell[j]==4 ){
dan33ea4862014-10-09 19:35:37 +00007868 assert(leafCorrection==4);
drh25ada072015-06-19 15:07:14 +00007869 sz = pParent->xCellSize(pParent, pCell);
dan33ea4862014-10-09 19:35:37 +00007870 }
7871 }
7872 iOvflSpace += sz;
7873 assert( sz<=pBt->maxLocal+23 );
7874 assert( iOvflSpace <= (int)pBt->pageSize );
7875 insertCell(pParent, nxDiv+i, pCell, sz, pTemp, pNew->pgno, &rc);
7876 if( rc!=SQLITE_OK ) goto balance_cleanup;
7877 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
7878 }
7879
7880 /* Now update the actual sibling pages. The order in which they are updated
7881 ** is important, as this code needs to avoid disrupting any page from which
7882 ** cells may still to be read. In practice, this means:
7883 **
drhd836d422014-10-31 14:26:36 +00007884 ** (1) If cells are moving left (from apNew[iPg] to apNew[iPg-1])
7885 ** then it is not safe to update page apNew[iPg] until after
7886 ** the left-hand sibling apNew[iPg-1] has been updated.
dan33ea4862014-10-09 19:35:37 +00007887 **
drhd836d422014-10-31 14:26:36 +00007888 ** (2) If cells are moving right (from apNew[iPg] to apNew[iPg+1])
7889 ** then it is not safe to update page apNew[iPg] until after
7890 ** the right-hand sibling apNew[iPg+1] has been updated.
dan33ea4862014-10-09 19:35:37 +00007891 **
7892 ** If neither of the above apply, the page is safe to update.
drhd836d422014-10-31 14:26:36 +00007893 **
7894 ** The iPg value in the following loop starts at nNew-1 goes down
7895 ** to 0, then back up to nNew-1 again, thus making two passes over
7896 ** the pages. On the initial downward pass, only condition (1) above
7897 ** needs to be tested because (2) will always be true from the previous
7898 ** step. On the upward pass, both conditions are always true, so the
7899 ** upwards pass simply processes pages that were missed on the downward
7900 ** pass.
dan33ea4862014-10-09 19:35:37 +00007901 */
drhbec021b2014-10-31 12:22:00 +00007902 for(i=1-nNew; i<nNew; i++){
7903 int iPg = i<0 ? -i : i;
drhbec021b2014-10-31 12:22:00 +00007904 assert( iPg>=0 && iPg<nNew );
drhd836d422014-10-31 14:26:36 +00007905 if( abDone[iPg] ) continue; /* Skip pages already processed */
7906 if( i>=0 /* On the upwards pass, or... */
7907 || cntOld[iPg-1]>=cntNew[iPg-1] /* Condition (1) is true */
dan33ea4862014-10-09 19:35:37 +00007908 ){
dan09c68402014-10-11 20:00:24 +00007909 int iNew;
7910 int iOld;
7911 int nNewCell;
7912
drhd836d422014-10-31 14:26:36 +00007913 /* Verify condition (1): If cells are moving left, update iPg
7914 ** only after iPg-1 has already been updated. */
7915 assert( iPg==0 || cntOld[iPg-1]>=cntNew[iPg-1] || abDone[iPg-1] );
7916
7917 /* Verify condition (2): If cells are moving right, update iPg
7918 ** only after iPg+1 has already been updated. */
7919 assert( cntNew[iPg]>=cntOld[iPg] || abDone[iPg+1] );
7920
dan09c68402014-10-11 20:00:24 +00007921 if( iPg==0 ){
7922 iNew = iOld = 0;
7923 nNewCell = cntNew[0];
7924 }else{
drh1ffd2472015-06-23 02:37:30 +00007925 iOld = iPg<nOld ? (cntOld[iPg-1] + !leafData) : b.nCell;
dan09c68402014-10-11 20:00:24 +00007926 iNew = cntNew[iPg-1] + !leafData;
7927 nNewCell = cntNew[iPg] - iNew;
7928 }
7929
drh1ffd2472015-06-23 02:37:30 +00007930 rc = editPage(apNew[iPg], iOld, iNew, nNewCell, &b);
drh658873b2015-06-22 20:02:04 +00007931 if( rc ) goto balance_cleanup;
drhd836d422014-10-31 14:26:36 +00007932 abDone[iPg]++;
dand7b545b2014-10-13 18:03:27 +00007933 apNew[iPg]->nFree = usableSpace-szNew[iPg];
dan09c68402014-10-11 20:00:24 +00007934 assert( apNew[iPg]->nOverflow==0 );
7935 assert( apNew[iPg]->nCell==nNewCell );
dan33ea4862014-10-09 19:35:37 +00007936 }
7937 }
drhd836d422014-10-31 14:26:36 +00007938
7939 /* All pages have been processed exactly once */
dan33ea4862014-10-09 19:35:37 +00007940 assert( memcmp(abDone, "\01\01\01\01\01", nNew)==0 );
7941
drh7aa8f852006-03-28 00:24:44 +00007942 assert( nOld>0 );
7943 assert( nNew>0 );
drh14acc042001-06-10 19:56:58 +00007944
danielk197713bd99f2009-06-24 05:40:34 +00007945 if( isRoot && pParent->nCell==0 && pParent->hdrOffset<=apNew[0]->nFree ){
7946 /* The root page of the b-tree now contains no cells. The only sibling
7947 ** page is the right-child of the parent. Copy the contents of the
7948 ** child page into the parent, decreasing the overall height of the
7949 ** b-tree structure by one. This is described as the "balance-shallower"
7950 ** sub-algorithm in some documentation.
7951 **
7952 ** If this is an auto-vacuum database, the call to copyNodeContent()
7953 ** sets all pointer-map entries corresponding to database image pages
7954 ** for which the pointer is stored within the content being copied.
7955 **
drh768f2902014-10-31 02:51:41 +00007956 ** It is critical that the child page be defragmented before being
7957 ** copied into the parent, because if the parent is page 1 then it will
7958 ** by smaller than the child due to the database header, and so all the
7959 ** free space needs to be up front.
7960 */
drh9b5351d2015-09-30 14:19:08 +00007961 assert( nNew==1 || CORRUPT_DB );
dan3b2ede12017-02-25 16:24:02 +00007962 rc = defragmentPage(apNew[0], -1);
drh768f2902014-10-31 02:51:41 +00007963 testcase( rc!=SQLITE_OK );
danielk197713bd99f2009-06-24 05:40:34 +00007964 assert( apNew[0]->nFree ==
drh768f2902014-10-31 02:51:41 +00007965 (get2byte(&apNew[0]->aData[5])-apNew[0]->cellOffset-apNew[0]->nCell*2)
7966 || rc!=SQLITE_OK
danielk197713bd99f2009-06-24 05:40:34 +00007967 );
drhc314dc72009-07-21 11:52:34 +00007968 copyNodeContent(apNew[0], pParent, &rc);
7969 freePage(apNew[0], &rc);
dan33ea4862014-10-09 19:35:37 +00007970 }else if( ISAUTOVACUUM && !leafCorrection ){
7971 /* Fix the pointer map entries associated with the right-child of each
7972 ** sibling page. All other pointer map entries have already been taken
7973 ** care of. */
7974 for(i=0; i<nNew; i++){
7975 u32 key = get4byte(&apNew[i]->aData[8]);
7976 ptrmapPut(pBt, key, PTRMAP_BTREE, apNew[i]->pgno, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00007977 }
dan33ea4862014-10-09 19:35:37 +00007978 }
danielk19774dbaa892009-06-16 16:50:22 +00007979
dan33ea4862014-10-09 19:35:37 +00007980 assert( pParent->isInit );
7981 TRACE(("BALANCE: finished: old=%d new=%d cells=%d\n",
drh1ffd2472015-06-23 02:37:30 +00007982 nOld, nNew, b.nCell));
danielk19774dbaa892009-06-16 16:50:22 +00007983
dan33ea4862014-10-09 19:35:37 +00007984 /* Free any old pages that were not reused as new pages.
7985 */
7986 for(i=nNew; i<nOld; i++){
7987 freePage(apOld[i], &rc);
7988 }
danielk19774dbaa892009-06-16 16:50:22 +00007989
7990#if 0
dan33ea4862014-10-09 19:35:37 +00007991 if( ISAUTOVACUUM && rc==SQLITE_OK && apNew[0]->isInit ){
danielk19774dbaa892009-06-16 16:50:22 +00007992 /* The ptrmapCheckPages() contains assert() statements that verify that
7993 ** all pointer map pages are set correctly. This is helpful while
7994 ** debugging. This is usually disabled because a corrupt database may
7995 ** cause an assert() statement to fail. */
7996 ptrmapCheckPages(apNew, nNew);
7997 ptrmapCheckPages(&pParent, 1);
danielk19774dbaa892009-06-16 16:50:22 +00007998 }
dan33ea4862014-10-09 19:35:37 +00007999#endif
danielk1977cd581a72009-06-23 15:43:39 +00008000
drh8b2f49b2001-06-08 00:21:52 +00008001 /*
drh14acc042001-06-10 19:56:58 +00008002 ** Cleanup before returning.
drh8b2f49b2001-06-08 00:21:52 +00008003 */
drh14acc042001-06-10 19:56:58 +00008004balance_cleanup:
drhb2a0f752017-08-28 15:51:35 +00008005 sqlite3StackFree(0, b.apCell);
drh8b2f49b2001-06-08 00:21:52 +00008006 for(i=0; i<nOld; i++){
drh91025292004-05-03 19:49:32 +00008007 releasePage(apOld[i]);
drh8b2f49b2001-06-08 00:21:52 +00008008 }
drh14acc042001-06-10 19:56:58 +00008009 for(i=0; i<nNew; i++){
drh91025292004-05-03 19:49:32 +00008010 releasePage(apNew[i]);
drh8b2f49b2001-06-08 00:21:52 +00008011 }
danielk1977eaa06f62008-09-18 17:34:44 +00008012
drh8b2f49b2001-06-08 00:21:52 +00008013 return rc;
8014}
8015
drh43605152004-05-29 21:46:49 +00008016
8017/*
danielk1977a50d9aa2009-06-08 14:49:45 +00008018** This function is called when the root page of a b-tree structure is
8019** overfull (has one or more overflow pages).
drh43605152004-05-29 21:46:49 +00008020**
danielk1977a50d9aa2009-06-08 14:49:45 +00008021** A new child page is allocated and the contents of the current root
8022** page, including overflow cells, are copied into the child. The root
8023** page is then overwritten to make it an empty page with the right-child
8024** pointer pointing to the new page.
8025**
8026** Before returning, all pointer-map entries corresponding to pages
8027** that the new child-page now contains pointers to are updated. The
8028** entry corresponding to the new right-child pointer of the root
8029** page is also updated.
8030**
8031** If successful, *ppChild is set to contain a reference to the child
8032** page and SQLITE_OK is returned. In this case the caller is required
8033** to call releasePage() on *ppChild exactly once. If an error occurs,
8034** an error code is returned and *ppChild is set to 0.
drh43605152004-05-29 21:46:49 +00008035*/
danielk1977a50d9aa2009-06-08 14:49:45 +00008036static int balance_deeper(MemPage *pRoot, MemPage **ppChild){
8037 int rc; /* Return value from subprocedures */
8038 MemPage *pChild = 0; /* Pointer to a new child page */
shane5eff7cf2009-08-10 03:57:58 +00008039 Pgno pgnoChild = 0; /* Page number of the new child page */
danielk1977a50d9aa2009-06-08 14:49:45 +00008040 BtShared *pBt = pRoot->pBt; /* The BTree */
drh43605152004-05-29 21:46:49 +00008041
danielk1977a50d9aa2009-06-08 14:49:45 +00008042 assert( pRoot->nOverflow>0 );
drh1fee73e2007-08-29 04:00:57 +00008043 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977bc2ca9e2008-11-13 14:28:28 +00008044
danielk1977a50d9aa2009-06-08 14:49:45 +00008045 /* Make pRoot, the root page of the b-tree, writable. Allocate a new
8046 ** page that will become the new right-child of pPage. Copy the contents
8047 ** of the node stored on pRoot into the new child page.
8048 */
drh98add2e2009-07-20 17:11:49 +00008049 rc = sqlite3PagerWrite(pRoot->pDbPage);
8050 if( rc==SQLITE_OK ){
8051 rc = allocateBtreePage(pBt,&pChild,&pgnoChild,pRoot->pgno,0);
drhc314dc72009-07-21 11:52:34 +00008052 copyNodeContent(pRoot, pChild, &rc);
8053 if( ISAUTOVACUUM ){
8054 ptrmapPut(pBt, pgnoChild, PTRMAP_BTREE, pRoot->pgno, &rc);
drh98add2e2009-07-20 17:11:49 +00008055 }
8056 }
8057 if( rc ){
danielk1977a50d9aa2009-06-08 14:49:45 +00008058 *ppChild = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00008059 releasePage(pChild);
danielk1977a50d9aa2009-06-08 14:49:45 +00008060 return rc;
danielk197771d5d2c2008-09-29 11:49:47 +00008061 }
danielk1977a50d9aa2009-06-08 14:49:45 +00008062 assert( sqlite3PagerIswriteable(pChild->pDbPage) );
8063 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
8064 assert( pChild->nCell==pRoot->nCell );
danielk197771d5d2c2008-09-29 11:49:47 +00008065
danielk1977a50d9aa2009-06-08 14:49:45 +00008066 TRACE(("BALANCE: copy root %d into %d\n", pRoot->pgno, pChild->pgno));
8067
8068 /* Copy the overflow cells from pRoot to pChild */
drh2cbd78b2012-02-02 19:37:18 +00008069 memcpy(pChild->aiOvfl, pRoot->aiOvfl,
8070 pRoot->nOverflow*sizeof(pRoot->aiOvfl[0]));
8071 memcpy(pChild->apOvfl, pRoot->apOvfl,
8072 pRoot->nOverflow*sizeof(pRoot->apOvfl[0]));
danielk1977a50d9aa2009-06-08 14:49:45 +00008073 pChild->nOverflow = pRoot->nOverflow;
danielk1977a50d9aa2009-06-08 14:49:45 +00008074
8075 /* Zero the contents of pRoot. Then install pChild as the right-child. */
8076 zeroPage(pRoot, pChild->aData[0] & ~PTF_LEAF);
8077 put4byte(&pRoot->aData[pRoot->hdrOffset+8], pgnoChild);
8078
8079 *ppChild = pChild;
8080 return SQLITE_OK;
drh43605152004-05-29 21:46:49 +00008081}
8082
8083/*
danielk197771d5d2c2008-09-29 11:49:47 +00008084** The page that pCur currently points to has just been modified in
8085** some way. This function figures out if this modification means the
8086** tree needs to be balanced, and if so calls the appropriate balancing
danielk1977a50d9aa2009-06-08 14:49:45 +00008087** routine. Balancing routines are:
8088**
8089** balance_quick()
danielk1977a50d9aa2009-06-08 14:49:45 +00008090** balance_deeper()
8091** balance_nonroot()
drh43605152004-05-29 21:46:49 +00008092*/
danielk1977a50d9aa2009-06-08 14:49:45 +00008093static int balance(BtCursor *pCur){
drh43605152004-05-29 21:46:49 +00008094 int rc = SQLITE_OK;
danielk1977a50d9aa2009-06-08 14:49:45 +00008095 const int nMin = pCur->pBt->usableSize * 2 / 3;
8096 u8 aBalanceQuickSpace[13];
8097 u8 *pFree = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00008098
drhcc5f8a42016-02-06 22:32:06 +00008099 VVA_ONLY( int balance_quick_called = 0 );
8100 VVA_ONLY( int balance_deeper_called = 0 );
danielk1977a50d9aa2009-06-08 14:49:45 +00008101
8102 do {
8103 int iPage = pCur->iPage;
drh352a35a2017-08-15 03:46:47 +00008104 MemPage *pPage = pCur->pPage;
danielk1977a50d9aa2009-06-08 14:49:45 +00008105
8106 if( iPage==0 ){
8107 if( pPage->nOverflow ){
8108 /* The root page of the b-tree is overfull. In this case call the
8109 ** balance_deeper() function to create a new child for the root-page
8110 ** and copy the current contents of the root-page to it. The
8111 ** next iteration of the do-loop will balance the child page.
8112 */
drhcc5f8a42016-02-06 22:32:06 +00008113 assert( balance_deeper_called==0 );
8114 VVA_ONLY( balance_deeper_called++ );
danielk1977a50d9aa2009-06-08 14:49:45 +00008115 rc = balance_deeper(pPage, &pCur->apPage[1]);
8116 if( rc==SQLITE_OK ){
8117 pCur->iPage = 1;
drh75e96b32017-04-01 00:20:06 +00008118 pCur->ix = 0;
danielk1977a50d9aa2009-06-08 14:49:45 +00008119 pCur->aiIdx[0] = 0;
drh352a35a2017-08-15 03:46:47 +00008120 pCur->apPage[0] = pPage;
8121 pCur->pPage = pCur->apPage[1];
8122 assert( pCur->pPage->nOverflow );
danielk1977a50d9aa2009-06-08 14:49:45 +00008123 }
danielk1977a50d9aa2009-06-08 14:49:45 +00008124 }else{
danielk1977a50d9aa2009-06-08 14:49:45 +00008125 break;
8126 }
8127 }else if( pPage->nOverflow==0 && pPage->nFree<=nMin ){
8128 break;
8129 }else{
8130 MemPage * const pParent = pCur->apPage[iPage-1];
8131 int const iIdx = pCur->aiIdx[iPage-1];
8132
8133 rc = sqlite3PagerWrite(pParent->pDbPage);
8134 if( rc==SQLITE_OK ){
8135#ifndef SQLITE_OMIT_QUICKBALANCE
drh3e28ff52014-09-24 00:59:08 +00008136 if( pPage->intKeyLeaf
danielk1977a50d9aa2009-06-08 14:49:45 +00008137 && pPage->nOverflow==1
drh2cbd78b2012-02-02 19:37:18 +00008138 && pPage->aiOvfl[0]==pPage->nCell
danielk1977a50d9aa2009-06-08 14:49:45 +00008139 && pParent->pgno!=1
8140 && pParent->nCell==iIdx
8141 ){
8142 /* Call balance_quick() to create a new sibling of pPage on which
8143 ** to store the overflow cell. balance_quick() inserts a new cell
8144 ** into pParent, which may cause pParent overflow. If this
peter.d.reid60ec9142014-09-06 16:39:46 +00008145 ** happens, the next iteration of the do-loop will balance pParent
danielk1977a50d9aa2009-06-08 14:49:45 +00008146 ** use either balance_nonroot() or balance_deeper(). Until this
8147 ** happens, the overflow cell is stored in the aBalanceQuickSpace[]
8148 ** buffer.
8149 **
8150 ** The purpose of the following assert() is to check that only a
8151 ** single call to balance_quick() is made for each call to this
8152 ** function. If this were not verified, a subtle bug involving reuse
8153 ** of the aBalanceQuickSpace[] might sneak in.
8154 */
drhcc5f8a42016-02-06 22:32:06 +00008155 assert( balance_quick_called==0 );
8156 VVA_ONLY( balance_quick_called++ );
danielk1977a50d9aa2009-06-08 14:49:45 +00008157 rc = balance_quick(pParent, pPage, aBalanceQuickSpace);
8158 }else
8159#endif
8160 {
8161 /* In this case, call balance_nonroot() to redistribute cells
8162 ** between pPage and up to 2 of its sibling pages. This involves
8163 ** modifying the contents of pParent, which may cause pParent to
8164 ** become overfull or underfull. The next iteration of the do-loop
8165 ** will balance the parent page to correct this.
8166 **
8167 ** If the parent page becomes overfull, the overflow cell or cells
8168 ** are stored in the pSpace buffer allocated immediately below.
8169 ** A subsequent iteration of the do-loop will deal with this by
8170 ** calling balance_nonroot() (balance_deeper() may be called first,
8171 ** but it doesn't deal with overflow cells - just moves them to a
8172 ** different page). Once this subsequent call to balance_nonroot()
8173 ** has completed, it is safe to release the pSpace buffer used by
8174 ** the previous call, as the overflow cell data will have been
8175 ** copied either into the body of a database page or into the new
8176 ** pSpace buffer passed to the latter call to balance_nonroot().
8177 */
8178 u8 *pSpace = sqlite3PageMalloc(pCur->pBt->pageSize);
drhe0997b32015-03-20 14:57:50 +00008179 rc = balance_nonroot(pParent, iIdx, pSpace, iPage==1,
8180 pCur->hints&BTREE_BULKLOAD);
danielk1977a50d9aa2009-06-08 14:49:45 +00008181 if( pFree ){
8182 /* If pFree is not NULL, it points to the pSpace buffer used
8183 ** by a previous call to balance_nonroot(). Its contents are
8184 ** now stored either on real database pages or within the
8185 ** new pSpace buffer, so it may be safely freed here. */
8186 sqlite3PageFree(pFree);
8187 }
8188
danielk19774dbaa892009-06-16 16:50:22 +00008189 /* The pSpace buffer will be freed after the next call to
8190 ** balance_nonroot(), or just before this function returns, whichever
8191 ** comes first. */
danielk1977a50d9aa2009-06-08 14:49:45 +00008192 pFree = pSpace;
danielk1977a50d9aa2009-06-08 14:49:45 +00008193 }
8194 }
8195
8196 pPage->nOverflow = 0;
8197
8198 /* The next iteration of the do-loop balances the parent page. */
8199 releasePage(pPage);
8200 pCur->iPage--;
drhcbd33492015-03-25 13:06:54 +00008201 assert( pCur->iPage>=0 );
drh352a35a2017-08-15 03:46:47 +00008202 pCur->pPage = pCur->apPage[pCur->iPage];
drh43605152004-05-29 21:46:49 +00008203 }
danielk1977a50d9aa2009-06-08 14:49:45 +00008204 }while( rc==SQLITE_OK );
8205
8206 if( pFree ){
8207 sqlite3PageFree(pFree);
drh43605152004-05-29 21:46:49 +00008208 }
8209 return rc;
8210}
8211
drh3de5d162018-05-03 03:59:02 +00008212/* Overwrite content from pX into pDest. Only do the write if the
8213** content is different from what is already there.
8214*/
8215static int btreeOverwriteContent(
8216 MemPage *pPage, /* MemPage on which writing will occur */
8217 u8 *pDest, /* Pointer to the place to start writing */
8218 const BtreePayload *pX, /* Source of data to write */
8219 int iOffset, /* Offset of first byte to write */
8220 int iAmt /* Number of bytes to be written */
8221){
8222 int nData = pX->nData - iOffset;
8223 if( nData<=0 ){
8224 /* Overwritting with zeros */
8225 int i;
8226 for(i=0; i<iAmt && pDest[i]==0; i++){}
8227 if( i<iAmt ){
8228 int rc = sqlite3PagerWrite(pPage->pDbPage);
8229 if( rc ) return rc;
8230 memset(pDest + i, 0, iAmt - i);
8231 }
8232 }else{
8233 if( nData<iAmt ){
8234 /* Mixed read data and zeros at the end. Make a recursive call
8235 ** to write the zeros then fall through to write the real data */
drhd5aa9262018-05-03 16:56:06 +00008236 int rc = btreeOverwriteContent(pPage, pDest+nData, pX, iOffset+nData,
8237 iAmt-nData);
8238 if( rc ) return rc;
drh3de5d162018-05-03 03:59:02 +00008239 iAmt = nData;
8240 }
8241 if( memcmp(pDest, ((u8*)pX->pData) + iOffset, iAmt)!=0 ){
8242 int rc = sqlite3PagerWrite(pPage->pDbPage);
8243 if( rc ) return rc;
8244 memcpy(pDest, ((u8*)pX->pData) + iOffset, iAmt);
8245 }
8246 }
8247 return SQLITE_OK;
8248}
8249
8250/*
8251** Overwrite the cell that cursor pCur is pointing to with fresh content
8252** contained in pX.
8253*/
8254static int btreeOverwriteCell(BtCursor *pCur, const BtreePayload *pX){
8255 int iOffset; /* Next byte of pX->pData to write */
8256 int nTotal = pX->nData + pX->nZero; /* Total bytes of to write */
8257 int rc; /* Return code */
8258 MemPage *pPage = pCur->pPage; /* Page being written */
8259 BtShared *pBt; /* Btree */
8260 Pgno ovflPgno; /* Next overflow page to write */
8261 u32 ovflPageSize; /* Size to write on overflow page */
8262
drh4f84e9c2018-05-03 13:56:23 +00008263 if( pCur->info.pPayload + pCur->info.nLocal > pPage->aDataEnd ){
8264 return SQLITE_CORRUPT_BKPT;
8265 }
drh3de5d162018-05-03 03:59:02 +00008266 /* Overwrite the local portion first */
8267 rc = btreeOverwriteContent(pPage, pCur->info.pPayload, pX,
8268 0, pCur->info.nLocal);
8269 if( rc ) return rc;
8270 if( pCur->info.nLocal==nTotal ) return SQLITE_OK;
8271
8272 /* Now overwrite the overflow pages */
8273 iOffset = pCur->info.nLocal;
drh30f7a252018-05-07 11:29:59 +00008274 assert( nTotal>=0 );
8275 assert( iOffset>=0 );
drh3de5d162018-05-03 03:59:02 +00008276 ovflPgno = get4byte(pCur->info.pPayload + iOffset);
8277 pBt = pPage->pBt;
8278 ovflPageSize = pBt->usableSize - 4;
8279 do{
8280 rc = btreeGetPage(pBt, ovflPgno, &pPage, 0);
8281 if( rc ) return rc;
drh4f84e9c2018-05-03 13:56:23 +00008282 if( sqlite3PagerPageRefcount(pPage->pDbPage)!=1 ){
drhd5aa9262018-05-03 16:56:06 +00008283 rc = SQLITE_CORRUPT_BKPT;
drh3de5d162018-05-03 03:59:02 +00008284 }else{
drh30f7a252018-05-07 11:29:59 +00008285 if( iOffset+ovflPageSize<(u32)nTotal ){
drhd5aa9262018-05-03 16:56:06 +00008286 ovflPgno = get4byte(pPage->aData);
8287 }else{
8288 ovflPageSize = nTotal - iOffset;
8289 }
8290 rc = btreeOverwriteContent(pPage, pPage->aData+4, pX,
8291 iOffset, ovflPageSize);
drh3de5d162018-05-03 03:59:02 +00008292 }
drhd5aa9262018-05-03 16:56:06 +00008293 sqlite3PagerUnref(pPage->pDbPage);
drh3de5d162018-05-03 03:59:02 +00008294 if( rc ) return rc;
8295 iOffset += ovflPageSize;
drh3de5d162018-05-03 03:59:02 +00008296 }while( iOffset<nTotal );
8297 return SQLITE_OK;
8298}
8299
drhf74b8d92002-09-01 23:20:45 +00008300
8301/*
drh8eeb4462016-05-21 20:03:42 +00008302** Insert a new record into the BTree. The content of the new record
8303** is described by the pX object. The pCur cursor is used only to
8304** define what table the record should be inserted into, and is left
8305** pointing at a random location.
drh4b70f112004-05-02 21:12:19 +00008306**
drh8eeb4462016-05-21 20:03:42 +00008307** For a table btree (used for rowid tables), only the pX.nKey value of
8308** the key is used. The pX.pKey value must be NULL. The pX.nKey is the
8309** rowid or INTEGER PRIMARY KEY of the row. The pX.nData,pData,nZero fields
8310** hold the content of the row.
8311**
8312** For an index btree (used for indexes and WITHOUT ROWID tables), the
8313** key is an arbitrary byte sequence stored in pX.pKey,nKey. The
8314** pX.pData,nData,nZero fields must be zero.
danielk1977de630352009-05-04 11:42:29 +00008315**
8316** If the seekResult parameter is non-zero, then a successful call to
drheaf6ae22016-11-09 20:14:34 +00008317** MovetoUnpacked() to seek cursor pCur to (pKey,nKey) has already
8318** been performed. In other words, if seekResult!=0 then the cursor
8319** is currently pointing to a cell that will be adjacent to the cell
8320** to be inserted. If seekResult<0 then pCur points to a cell that is
8321** smaller then (pKey,nKey). If seekResult>0 then pCur points to a cell
8322** that is larger than (pKey,nKey).
danielk1977de630352009-05-04 11:42:29 +00008323**
drheaf6ae22016-11-09 20:14:34 +00008324** If seekResult==0, that means pCur is pointing at some unknown location.
8325** In that case, this routine must seek the cursor to the correct insertion
8326** point for (pKey,nKey) before doing the insertion. For index btrees,
8327** if pX->nMem is non-zero, then pX->aMem contains pointers to the unpacked
8328** key values and pX->aMem can be used instead of pX->pKey to avoid having
8329** to decode the key.
drh3b7511c2001-05-26 13:15:44 +00008330*/
drh3aac2dd2004-04-26 14:10:20 +00008331int sqlite3BtreeInsert(
drh5c4d9702001-08-20 00:33:58 +00008332 BtCursor *pCur, /* Insert data into the table of this cursor */
drh8eeb4462016-05-21 20:03:42 +00008333 const BtreePayload *pX, /* Content of the row to be inserted */
danf91c1312017-01-10 20:04:38 +00008334 int flags, /* True if this is likely an append */
danielk19773509a652009-07-06 18:56:13 +00008335 int seekResult /* Result of prior MovetoUnpacked() call */
drh3b7511c2001-05-26 13:15:44 +00008336){
drh3b7511c2001-05-26 13:15:44 +00008337 int rc;
drh3e9ca092009-09-08 01:14:48 +00008338 int loc = seekResult; /* -1: before desired location +1: after */
drh1d452e12009-11-01 19:26:59 +00008339 int szNew = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00008340 int idx;
drh3b7511c2001-05-26 13:15:44 +00008341 MemPage *pPage;
drhd677b3d2007-08-20 22:48:41 +00008342 Btree *p = pCur->pBtree;
8343 BtShared *pBt = p->pBt;
drha34b6762004-05-07 13:30:42 +00008344 unsigned char *oldCell;
drh2e38c322004-09-03 18:38:44 +00008345 unsigned char *newCell = 0;
drh3b7511c2001-05-26 13:15:44 +00008346
danf91c1312017-01-10 20:04:38 +00008347 assert( (flags & (BTREE_SAVEPOSITION|BTREE_APPEND))==flags );
8348
drh98add2e2009-07-20 17:11:49 +00008349 if( pCur->eState==CURSOR_FAULT ){
8350 assert( pCur->skipNext!=SQLITE_OK );
8351 return pCur->skipNext;
8352 }
8353
dan7a2347e2016-01-07 16:43:54 +00008354 assert( cursorOwnsBtShared(pCur) );
drh3f387402014-09-24 01:23:00 +00008355 assert( (pCur->curFlags & BTCF_WriteFlag)!=0
8356 && pBt->inTransaction==TRANS_WRITE
drhc9166342012-01-05 23:32:06 +00008357 && (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk197796d48e92009-06-29 06:00:37 +00008358 assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
8359
danielk197731d31b82009-07-13 13:18:07 +00008360 /* Assert that the caller has been consistent. If this cursor was opened
8361 ** expecting an index b-tree, then the caller should be inserting blob
8362 ** keys with no associated data. If the cursor was opened expecting an
8363 ** intkey table, the caller should be inserting integer keys with a
8364 ** blob of associated data. */
drh8eeb4462016-05-21 20:03:42 +00008365 assert( (pX->pKey==0)==(pCur->pKeyInfo==0) );
danielk197731d31b82009-07-13 13:18:07 +00008366
danielk19779c3acf32009-05-02 07:36:49 +00008367 /* Save the positions of any other cursors open on this table.
8368 **
danielk19773509a652009-07-06 18:56:13 +00008369 ** In some cases, the call to btreeMoveto() below is a no-op. For
danielk19779c3acf32009-05-02 07:36:49 +00008370 ** example, when inserting data into a table with auto-generated integer
8371 ** keys, the VDBE layer invokes sqlite3BtreeLast() to figure out the
8372 ** integer key to use. It then calls this function to actually insert the
danielk19773509a652009-07-06 18:56:13 +00008373 ** data into the intkey B-Tree. In this case btreeMoveto() recognizes
danielk19779c3acf32009-05-02 07:36:49 +00008374 ** that the cursor is already where it needs to be and returns without
8375 ** doing any work. To avoid thwarting these optimizations, it is important
8376 ** not to clear the cursor here.
8377 */
drh27fb7462015-06-30 02:47:36 +00008378 if( pCur->curFlags & BTCF_Multiple ){
8379 rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
8380 if( rc ) return rc;
drhd60f4f42012-03-23 14:23:52 +00008381 }
8382
danielk197771d5d2c2008-09-29 11:49:47 +00008383 if( pCur->pKeyInfo==0 ){
drh8eeb4462016-05-21 20:03:42 +00008384 assert( pX->pKey==0 );
drhe0670b62014-02-12 21:31:12 +00008385 /* If this is an insert into a table b-tree, invalidate any incrblob
8386 ** cursors open on the row being replaced */
drh9ca431a2017-03-29 18:03:50 +00008387 invalidateIncrblobCursors(p, pCur->pgnoRoot, pX->nKey, 0);
drhe0670b62014-02-12 21:31:12 +00008388
danf91c1312017-01-10 20:04:38 +00008389 /* If BTREE_SAVEPOSITION is set, the cursor must already be pointing
drhd720d392018-05-07 17:27:04 +00008390 ** to a row with the same key as the new entry being inserted.
8391 */
8392#ifdef SQLITE_DEBUG
8393 if( flags & BTREE_SAVEPOSITION ){
8394 assert( pCur->curFlags & BTCF_ValidNKey );
8395 assert( pX->nKey==pCur->info.nKey );
8396 assert( pCur->info.nSize!=0 );
8397 assert( loc==0 );
8398 }
8399#endif
danf91c1312017-01-10 20:04:38 +00008400
drhd720d392018-05-07 17:27:04 +00008401 /* On the other hand, BTREE_SAVEPOSITION==0 does not imply
8402 ** that the cursor is not pointing to a row to be overwritten.
8403 ** So do a complete check.
8404 */
drh7a1c28d2016-11-10 20:42:08 +00008405 if( (pCur->curFlags&BTCF_ValidNKey)!=0 && pX->nKey==pCur->info.nKey ){
drhd720d392018-05-07 17:27:04 +00008406 /* The cursor is pointing to the entry that is to be
drh3de5d162018-05-03 03:59:02 +00008407 ** overwritten */
drh30f7a252018-05-07 11:29:59 +00008408 assert( pX->nData>=0 && pX->nZero>=0 );
8409 if( pCur->info.nSize!=0
8410 && pCur->info.nPayload==(u32)pX->nData+pX->nZero
8411 ){
drhd720d392018-05-07 17:27:04 +00008412 /* New entry is the same size as the old. Do an overwrite */
drh3de5d162018-05-03 03:59:02 +00008413 return btreeOverwriteCell(pCur, pX);
8414 }
drhd720d392018-05-07 17:27:04 +00008415 assert( loc==0 );
drh207c8172015-06-29 23:01:32 +00008416 }else if( loc==0 ){
drhd720d392018-05-07 17:27:04 +00008417 /* The cursor is *not* pointing to the cell to be overwritten, nor
8418 ** to an adjacent cell. Move the cursor so that it is pointing either
8419 ** to the cell to be overwritten or an adjacent cell.
8420 */
danf91c1312017-01-10 20:04:38 +00008421 rc = sqlite3BtreeMovetoUnpacked(pCur, 0, pX->nKey, flags!=0, &loc);
drh207c8172015-06-29 23:01:32 +00008422 if( rc ) return rc;
drhe0670b62014-02-12 21:31:12 +00008423 }
drhd720d392018-05-07 17:27:04 +00008424 }else{
8425 /* This is an index or a WITHOUT ROWID table */
8426
8427 /* If BTREE_SAVEPOSITION is set, the cursor must already be pointing
8428 ** to a row with the same key as the new entry being inserted.
8429 */
8430 assert( (flags & BTREE_SAVEPOSITION)==0 || loc==0 );
8431
8432 /* If the cursor is not already pointing either to the cell to be
8433 ** overwritten, or if a new cell is being inserted, if the cursor is
8434 ** not pointing to an immediately adjacent cell, then move the cursor
8435 ** so that it does.
8436 */
8437 if( loc==0 && (flags & BTREE_SAVEPOSITION)==0 ){
8438 if( pX->nMem ){
8439 UnpackedRecord r;
8440 r.pKeyInfo = pCur->pKeyInfo;
8441 r.aMem = pX->aMem;
8442 r.nField = pX->nMem;
8443 r.default_rc = 0;
8444 r.errCode = 0;
8445 r.r1 = 0;
8446 r.r2 = 0;
8447 r.eqSeen = 0;
8448 rc = sqlite3BtreeMovetoUnpacked(pCur, &r, 0, flags!=0, &loc);
8449 }else{
8450 rc = btreeMoveto(pCur, pX->pKey, pX->nKey, flags!=0, &loc);
8451 }
8452 if( rc ) return rc;
drh9b4eaeb2016-11-09 00:10:33 +00008453 }
drh89ee2292018-05-07 18:41:19 +00008454
8455 /* If the cursor is currently pointing to an entry to be overwritten
8456 ** and the new content is the same as as the old, then use the
8457 ** overwrite optimization.
8458 */
8459 if( loc==0 ){
8460 getCellInfo(pCur);
8461 if( pCur->info.nKey==pX->nKey ){
8462 BtreePayload x2;
8463 x2.pData = pX->pKey;
8464 x2.nData = pX->nKey;
8465 x2.nZero = 0;
8466 return btreeOverwriteCell(pCur, &x2);
8467 }
8468 }
8469
danielk1977da184232006-01-05 11:34:32 +00008470 }
danielk1977b980d2212009-06-22 18:03:51 +00008471 assert( pCur->eState==CURSOR_VALID || (pCur->eState==CURSOR_INVALID && loc) );
danielk1977da184232006-01-05 11:34:32 +00008472
drh352a35a2017-08-15 03:46:47 +00008473 pPage = pCur->pPage;
drh8eeb4462016-05-21 20:03:42 +00008474 assert( pPage->intKey || pX->nKey>=0 );
drh44845222008-07-17 18:39:57 +00008475 assert( pPage->leaf || !pPage->intKey );
danielk19778f880a82009-07-13 09:41:45 +00008476
drh3a4c1412004-05-09 20:40:11 +00008477 TRACE(("INSERT: table=%d nkey=%lld ndata=%d page=%d %s\n",
drh8eeb4462016-05-21 20:03:42 +00008478 pCur->pgnoRoot, pX->nKey, pX->nData, pPage->pgno,
drh3a4c1412004-05-09 20:40:11 +00008479 loc==0 ? "overwrite" : "new entry"));
danielk197771d5d2c2008-09-29 11:49:47 +00008480 assert( pPage->isInit );
danielk197752ae7242008-03-25 14:24:56 +00008481 newCell = pBt->pTmpSpace;
drh3fbb0222014-09-24 19:47:27 +00008482 assert( newCell!=0 );
drh8eeb4462016-05-21 20:03:42 +00008483 rc = fillInCell(pPage, newCell, pX, &szNew);
drh2e38c322004-09-03 18:38:44 +00008484 if( rc ) goto end_insert;
drh25ada072015-06-19 15:07:14 +00008485 assert( szNew==pPage->xCellSize(pPage, newCell) );
drhfcd71b62011-04-05 22:08:24 +00008486 assert( szNew <= MX_CELL_SIZE(pBt) );
drh75e96b32017-04-01 00:20:06 +00008487 idx = pCur->ix;
danielk1977b980d2212009-06-22 18:03:51 +00008488 if( loc==0 ){
drh80159da2016-12-09 17:32:51 +00008489 CellInfo info;
danielk197771d5d2c2008-09-29 11:49:47 +00008490 assert( idx<pPage->nCell );
danielk19776e465eb2007-08-21 13:11:00 +00008491 rc = sqlite3PagerWrite(pPage->pDbPage);
8492 if( rc ){
8493 goto end_insert;
8494 }
danielk197771d5d2c2008-09-29 11:49:47 +00008495 oldCell = findCell(pPage, idx);
drh4b70f112004-05-02 21:12:19 +00008496 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00008497 memcpy(newCell, oldCell, 4);
drh4b70f112004-05-02 21:12:19 +00008498 }
drh80159da2016-12-09 17:32:51 +00008499 rc = clearCell(pPage, oldCell, &info);
danca66f6c2017-06-08 11:14:08 +00008500 if( info.nSize==szNew && info.nLocal==info.nPayload
8501 && (!ISAUTOVACUUM || szNew<pPage->minLocal)
8502 ){
drhf9238252016-12-09 18:09:42 +00008503 /* Overwrite the old cell with the new if they are the same size.
8504 ** We could also try to do this if the old cell is smaller, then add
8505 ** the leftover space to the free list. But experiments show that
8506 ** doing that is no faster then skipping this optimization and just
danca66f6c2017-06-08 11:14:08 +00008507 ** calling dropCell() and insertCell().
8508 **
8509 ** This optimization cannot be used on an autovacuum database if the
8510 ** new entry uses overflow pages, as the insertCell() call below is
8511 ** necessary to add the PTRMAP_OVERFLOW1 pointer-map entry. */
drhf9238252016-12-09 18:09:42 +00008512 assert( rc==SQLITE_OK ); /* clearCell never fails when nLocal==nPayload */
drh2d083432016-12-09 19:42:18 +00008513 if( oldCell+szNew > pPage->aDataEnd ) return SQLITE_CORRUPT_BKPT;
drh80159da2016-12-09 17:32:51 +00008514 memcpy(oldCell, newCell, szNew);
8515 return SQLITE_OK;
8516 }
8517 dropCell(pPage, idx, info.nSize, &rc);
drh2e38c322004-09-03 18:38:44 +00008518 if( rc ) goto end_insert;
drh7c717f72001-06-24 20:39:41 +00008519 }else if( loc<0 && pPage->nCell>0 ){
drh4b70f112004-05-02 21:12:19 +00008520 assert( pPage->leaf );
drh75e96b32017-04-01 00:20:06 +00008521 idx = ++pCur->ix;
dan874080b2017-05-01 18:12:56 +00008522 pCur->curFlags &= ~BTCF_ValidNKey;
drh14acc042001-06-10 19:56:58 +00008523 }else{
drh4b70f112004-05-02 21:12:19 +00008524 assert( pPage->leaf );
drh3b7511c2001-05-26 13:15:44 +00008525 }
drh98add2e2009-07-20 17:11:49 +00008526 insertCell(pPage, idx, newCell, szNew, 0, 0, &rc);
drh09a4e922016-05-21 12:29:04 +00008527 assert( pPage->nOverflow==0 || rc==SQLITE_OK );
danielk19773f632d52009-05-02 10:03:09 +00008528 assert( rc!=SQLITE_OK || pPage->nCell>0 || pPage->nOverflow>0 );
drh9bf9e9c2008-12-05 20:01:43 +00008529
mistachkin48864df2013-03-21 21:20:32 +00008530 /* If no error has occurred and pPage has an overflow cell, call balance()
danielk1977a50d9aa2009-06-08 14:49:45 +00008531 ** to redistribute the cells within the tree. Since balance() may move
drh036dbec2014-03-11 23:40:44 +00008532 ** the cursor, zero the BtCursor.info.nSize and BTCF_ValidNKey
danielk1977a50d9aa2009-06-08 14:49:45 +00008533 ** variables.
danielk19773f632d52009-05-02 10:03:09 +00008534 **
danielk1977a50d9aa2009-06-08 14:49:45 +00008535 ** Previous versions of SQLite called moveToRoot() to move the cursor
8536 ** back to the root page as balance() used to invalidate the contents
danielk197754109bb2009-06-23 11:22:29 +00008537 ** of BtCursor.apPage[] and BtCursor.aiIdx[]. Instead of doing that,
8538 ** set the cursor state to "invalid". This makes common insert operations
8539 ** slightly faster.
danielk19773f632d52009-05-02 10:03:09 +00008540 **
danielk1977a50d9aa2009-06-08 14:49:45 +00008541 ** There is a subtle but important optimization here too. When inserting
8542 ** multiple records into an intkey b-tree using a single cursor (as can
8543 ** happen while processing an "INSERT INTO ... SELECT" statement), it
8544 ** is advantageous to leave the cursor pointing to the last entry in
8545 ** the b-tree if possible. If the cursor is left pointing to the last
8546 ** entry in the table, and the next row inserted has an integer key
8547 ** larger than the largest existing key, it is possible to insert the
8548 ** row without seeking the cursor. This can be a big performance boost.
danielk19773f632d52009-05-02 10:03:09 +00008549 */
danielk1977a50d9aa2009-06-08 14:49:45 +00008550 pCur->info.nSize = 0;
drh09a4e922016-05-21 12:29:04 +00008551 if( pPage->nOverflow ){
8552 assert( rc==SQLITE_OK );
drh036dbec2014-03-11 23:40:44 +00008553 pCur->curFlags &= ~(BTCF_ValidNKey);
danielk1977a50d9aa2009-06-08 14:49:45 +00008554 rc = balance(pCur);
8555
8556 /* Must make sure nOverflow is reset to zero even if the balance()
danielk197754109bb2009-06-23 11:22:29 +00008557 ** fails. Internal data structure corruption will result otherwise.
8558 ** Also, set the cursor state to invalid. This stops saveCursorPosition()
8559 ** from trying to save the current position of the cursor. */
drh352a35a2017-08-15 03:46:47 +00008560 pCur->pPage->nOverflow = 0;
danielk197754109bb2009-06-23 11:22:29 +00008561 pCur->eState = CURSOR_INVALID;
danf91c1312017-01-10 20:04:38 +00008562 if( (flags & BTREE_SAVEPOSITION) && rc==SQLITE_OK ){
drh85ef6302017-08-02 15:50:09 +00008563 btreeReleaseAllCursorPages(pCur);
drh7b20a152017-01-12 19:10:55 +00008564 if( pCur->pKeyInfo ){
danf91c1312017-01-10 20:04:38 +00008565 assert( pCur->pKey==0 );
8566 pCur->pKey = sqlite3Malloc( pX->nKey );
8567 if( pCur->pKey==0 ){
8568 rc = SQLITE_NOMEM;
8569 }else{
8570 memcpy(pCur->pKey, pX->pKey, pX->nKey);
8571 }
8572 }
8573 pCur->eState = CURSOR_REQUIRESEEK;
8574 pCur->nKey = pX->nKey;
8575 }
danielk19773f632d52009-05-02 10:03:09 +00008576 }
drh352a35a2017-08-15 03:46:47 +00008577 assert( pCur->iPage<0 || pCur->pPage->nOverflow==0 );
drh9bf9e9c2008-12-05 20:01:43 +00008578
drh2e38c322004-09-03 18:38:44 +00008579end_insert:
drh5e2f8b92001-05-28 00:41:15 +00008580 return rc;
8581}
8582
8583/*
danf0ee1d32015-09-12 19:26:11 +00008584** Delete the entry that the cursor is pointing to.
8585**
drhe807bdb2016-01-21 17:06:33 +00008586** If the BTREE_SAVEPOSITION bit of the flags parameter is zero, then
8587** the cursor is left pointing at an arbitrary location after the delete.
8588** But if that bit is set, then the cursor is left in a state such that
8589** the next call to BtreeNext() or BtreePrev() moves it to the same row
8590** as it would have been on if the call to BtreeDelete() had been omitted.
8591**
drhdef19e32016-01-27 16:26:25 +00008592** The BTREE_AUXDELETE bit of flags indicates that is one of several deletes
8593** associated with a single table entry and its indexes. Only one of those
8594** deletes is considered the "primary" delete. The primary delete occurs
8595** on a cursor that is not a BTREE_FORDELETE cursor. All but one delete
8596** operation on non-FORDELETE cursors is tagged with the AUXDELETE flag.
8597** The BTREE_AUXDELETE bit is a hint that is not used by this implementation,
drhe807bdb2016-01-21 17:06:33 +00008598** but which might be used by alternative storage engines.
drh3b7511c2001-05-26 13:15:44 +00008599*/
drhe807bdb2016-01-21 17:06:33 +00008600int sqlite3BtreeDelete(BtCursor *pCur, u8 flags){
drhd677b3d2007-08-20 22:48:41 +00008601 Btree *p = pCur->pBtree;
danielk19774dbaa892009-06-16 16:50:22 +00008602 BtShared *pBt = p->pBt;
8603 int rc; /* Return code */
8604 MemPage *pPage; /* Page to delete cell from */
8605 unsigned char *pCell; /* Pointer to cell to delete */
8606 int iCellIdx; /* Index of cell to delete */
8607 int iCellDepth; /* Depth of node containing pCell */
drh80159da2016-12-09 17:32:51 +00008608 CellInfo info; /* Size of the cell being deleted */
danf0ee1d32015-09-12 19:26:11 +00008609 int bSkipnext = 0; /* Leaf cursor in SKIPNEXT state */
drhe807bdb2016-01-21 17:06:33 +00008610 u8 bPreserve = flags & BTREE_SAVEPOSITION; /* Keep cursor valid */
drh8b2f49b2001-06-08 00:21:52 +00008611
dan7a2347e2016-01-07 16:43:54 +00008612 assert( cursorOwnsBtShared(pCur) );
drh64022502009-01-09 14:11:04 +00008613 assert( pBt->inTransaction==TRANS_WRITE );
drhc9166342012-01-05 23:32:06 +00008614 assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
drh036dbec2014-03-11 23:40:44 +00008615 assert( pCur->curFlags & BTCF_WriteFlag );
danielk197796d48e92009-06-29 06:00:37 +00008616 assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
8617 assert( !hasReadConflicts(p, pCur->pgnoRoot) );
drh352a35a2017-08-15 03:46:47 +00008618 assert( pCur->ix<pCur->pPage->nCell );
drh98ef0f62015-06-30 01:25:52 +00008619 assert( pCur->eState==CURSOR_VALID );
drhdef19e32016-01-27 16:26:25 +00008620 assert( (flags & ~(BTREE_SAVEPOSITION | BTREE_AUXDELETE))==0 );
danielk1977da184232006-01-05 11:34:32 +00008621
danielk19774dbaa892009-06-16 16:50:22 +00008622 iCellDepth = pCur->iPage;
drh75e96b32017-04-01 00:20:06 +00008623 iCellIdx = pCur->ix;
drh352a35a2017-08-15 03:46:47 +00008624 pPage = pCur->pPage;
danielk19774dbaa892009-06-16 16:50:22 +00008625 pCell = findCell(pPage, iCellIdx);
8626
drhbfc7a8b2016-04-09 17:04:05 +00008627 /* If the bPreserve flag is set to true, then the cursor position must
8628 ** be preserved following this delete operation. If the current delete
8629 ** will cause a b-tree rebalance, then this is done by saving the cursor
8630 ** key and leaving the cursor in CURSOR_REQUIRESEEK state before
8631 ** returning.
8632 **
8633 ** Or, if the current delete will not cause a rebalance, then the cursor
8634 ** will be left in CURSOR_SKIPNEXT state pointing to the entry immediately
8635 ** before or after the deleted entry. In this case set bSkipnext to true. */
8636 if( bPreserve ){
8637 if( !pPage->leaf
8638 || (pPage->nFree+cellSizePtr(pPage,pCell)+2)>(int)(pBt->usableSize*2/3)
drh1641f112018-12-13 21:05:45 +00008639 || pPage->nCell==1 /* See dbfuzz001.test for a test case */
drhbfc7a8b2016-04-09 17:04:05 +00008640 ){
8641 /* A b-tree rebalance will be required after deleting this entry.
8642 ** Save the cursor key. */
8643 rc = saveCursorKey(pCur);
8644 if( rc ) return rc;
8645 }else{
8646 bSkipnext = 1;
8647 }
8648 }
8649
danielk19774dbaa892009-06-16 16:50:22 +00008650 /* If the page containing the entry to delete is not a leaf page, move
8651 ** the cursor to the largest entry in the tree that is smaller than
8652 ** the entry being deleted. This cell will replace the cell being deleted
8653 ** from the internal node. The 'previous' entry is used for this instead
8654 ** of the 'next' entry, as the previous entry is always a part of the
8655 ** sub-tree headed by the child page of the cell being deleted. This makes
8656 ** balancing the tree following the delete operation easier. */
8657 if( !pPage->leaf ){
drh2ab792e2017-05-30 18:34:07 +00008658 rc = sqlite3BtreePrevious(pCur, 0);
8659 assert( rc!=SQLITE_DONE );
drh4c301aa2009-07-15 17:25:45 +00008660 if( rc ) return rc;
danielk19774dbaa892009-06-16 16:50:22 +00008661 }
8662
8663 /* Save the positions of any other cursors open on this table before
danf0ee1d32015-09-12 19:26:11 +00008664 ** making any modifications. */
drh27fb7462015-06-30 02:47:36 +00008665 if( pCur->curFlags & BTCF_Multiple ){
8666 rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
8667 if( rc ) return rc;
8668 }
drhd60f4f42012-03-23 14:23:52 +00008669
8670 /* If this is a delete operation to remove a row from a table b-tree,
8671 ** invalidate any incrblob cursors open on the row being deleted. */
8672 if( pCur->pKeyInfo==0 ){
drh9ca431a2017-03-29 18:03:50 +00008673 invalidateIncrblobCursors(p, pCur->pgnoRoot, pCur->info.nKey, 0);
drhd60f4f42012-03-23 14:23:52 +00008674 }
8675
danf0ee1d32015-09-12 19:26:11 +00008676 /* Make the page containing the entry to be deleted writable. Then free any
8677 ** overflow pages associated with the entry and finally remove the cell
8678 ** itself from within the page. */
drha4ec1d42009-07-11 13:13:11 +00008679 rc = sqlite3PagerWrite(pPage->pDbPage);
8680 if( rc ) return rc;
drh80159da2016-12-09 17:32:51 +00008681 rc = clearCell(pPage, pCell, &info);
8682 dropCell(pPage, iCellIdx, info.nSize, &rc);
drha4ec1d42009-07-11 13:13:11 +00008683 if( rc ) return rc;
danielk1977e6efa742004-11-10 11:55:10 +00008684
danielk19774dbaa892009-06-16 16:50:22 +00008685 /* If the cell deleted was not located on a leaf page, then the cursor
8686 ** is currently pointing to the largest entry in the sub-tree headed
8687 ** by the child-page of the cell that was just deleted from an internal
8688 ** node. The cell from the leaf node needs to be moved to the internal
8689 ** node to replace the deleted cell. */
drh4b70f112004-05-02 21:12:19 +00008690 if( !pPage->leaf ){
drh352a35a2017-08-15 03:46:47 +00008691 MemPage *pLeaf = pCur->pPage;
danielk19774dbaa892009-06-16 16:50:22 +00008692 int nCell;
drh352a35a2017-08-15 03:46:47 +00008693 Pgno n;
danielk19774dbaa892009-06-16 16:50:22 +00008694 unsigned char *pTmp;
danielk1977e6efa742004-11-10 11:55:10 +00008695
drh352a35a2017-08-15 03:46:47 +00008696 if( iCellDepth<pCur->iPage-1 ){
8697 n = pCur->apPage[iCellDepth+1]->pgno;
8698 }else{
8699 n = pCur->pPage->pgno;
8700 }
danielk19774dbaa892009-06-16 16:50:22 +00008701 pCell = findCell(pLeaf, pLeaf->nCell-1);
drhb468ce12015-06-24 01:07:30 +00008702 if( pCell<&pLeaf->aData[4] ) return SQLITE_CORRUPT_BKPT;
drh25ada072015-06-19 15:07:14 +00008703 nCell = pLeaf->xCellSize(pLeaf, pCell);
drhfcd71b62011-04-05 22:08:24 +00008704 assert( MX_CELL_SIZE(pBt) >= nCell );
danielk19774dbaa892009-06-16 16:50:22 +00008705 pTmp = pBt->pTmpSpace;
drh3fbb0222014-09-24 19:47:27 +00008706 assert( pTmp!=0 );
drha4ec1d42009-07-11 13:13:11 +00008707 rc = sqlite3PagerWrite(pLeaf->pDbPage);
drhcb89f4a2016-05-21 11:23:26 +00008708 if( rc==SQLITE_OK ){
8709 insertCell(pPage, iCellIdx, pCell-4, nCell+4, pTmp, n, &rc);
8710 }
drh98add2e2009-07-20 17:11:49 +00008711 dropCell(pLeaf, pLeaf->nCell-1, nCell, &rc);
drha4ec1d42009-07-11 13:13:11 +00008712 if( rc ) return rc;
drh5e2f8b92001-05-28 00:41:15 +00008713 }
danielk19774dbaa892009-06-16 16:50:22 +00008714
8715 /* Balance the tree. If the entry deleted was located on a leaf page,
8716 ** then the cursor still points to that page. In this case the first
8717 ** call to balance() repairs the tree, and the if(...) condition is
8718 ** never true.
8719 **
8720 ** Otherwise, if the entry deleted was on an internal node page, then
8721 ** pCur is pointing to the leaf page from which a cell was removed to
8722 ** replace the cell deleted from the internal node. This is slightly
8723 ** tricky as the leaf node may be underfull, and the internal node may
8724 ** be either under or overfull. In this case run the balancing algorithm
8725 ** on the leaf node first. If the balance proceeds far enough up the
8726 ** tree that we can be sure that any problem in the internal node has
8727 ** been corrected, so be it. Otherwise, after balancing the leaf node,
8728 ** walk the cursor up the tree to the internal node and balance it as
8729 ** well. */
8730 rc = balance(pCur);
8731 if( rc==SQLITE_OK && pCur->iPage>iCellDepth ){
drh352a35a2017-08-15 03:46:47 +00008732 releasePageNotNull(pCur->pPage);
8733 pCur->iPage--;
danielk19774dbaa892009-06-16 16:50:22 +00008734 while( pCur->iPage>iCellDepth ){
8735 releasePage(pCur->apPage[pCur->iPage--]);
8736 }
drh352a35a2017-08-15 03:46:47 +00008737 pCur->pPage = pCur->apPage[pCur->iPage];
danielk19774dbaa892009-06-16 16:50:22 +00008738 rc = balance(pCur);
8739 }
8740
danielk19776b456a22005-03-21 04:04:02 +00008741 if( rc==SQLITE_OK ){
danf0ee1d32015-09-12 19:26:11 +00008742 if( bSkipnext ){
drha660caf2016-01-01 03:37:44 +00008743 assert( bPreserve && (pCur->iPage==iCellDepth || CORRUPT_DB) );
drh352a35a2017-08-15 03:46:47 +00008744 assert( pPage==pCur->pPage || CORRUPT_DB );
drh78ac1092015-09-20 22:57:47 +00008745 assert( (pPage->nCell>0 || CORRUPT_DB) && iCellIdx<=pPage->nCell );
danf0ee1d32015-09-12 19:26:11 +00008746 pCur->eState = CURSOR_SKIPNEXT;
8747 if( iCellIdx>=pPage->nCell ){
8748 pCur->skipNext = -1;
drh75e96b32017-04-01 00:20:06 +00008749 pCur->ix = pPage->nCell-1;
danf0ee1d32015-09-12 19:26:11 +00008750 }else{
8751 pCur->skipNext = 1;
8752 }
8753 }else{
8754 rc = moveToRoot(pCur);
8755 if( bPreserve ){
drh85ef6302017-08-02 15:50:09 +00008756 btreeReleaseAllCursorPages(pCur);
danf0ee1d32015-09-12 19:26:11 +00008757 pCur->eState = CURSOR_REQUIRESEEK;
8758 }
drh44548e72017-08-14 18:13:52 +00008759 if( rc==SQLITE_EMPTY ) rc = SQLITE_OK;
danf0ee1d32015-09-12 19:26:11 +00008760 }
danielk19776b456a22005-03-21 04:04:02 +00008761 }
drh5e2f8b92001-05-28 00:41:15 +00008762 return rc;
drh3b7511c2001-05-26 13:15:44 +00008763}
drh8b2f49b2001-06-08 00:21:52 +00008764
8765/*
drhc6b52df2002-01-04 03:09:29 +00008766** Create a new BTree table. Write into *piTable the page
8767** number for the root page of the new table.
8768**
drhab01f612004-05-22 02:55:23 +00008769** The type of type is determined by the flags parameter. Only the
8770** following values of flags are currently in use. Other values for
8771** flags might not work:
8772**
8773** BTREE_INTKEY|BTREE_LEAFDATA Used for SQL tables with rowid keys
8774** BTREE_ZERODATA Used for SQL indices
drh8b2f49b2001-06-08 00:21:52 +00008775*/
drhd4187c72010-08-30 22:15:45 +00008776static int btreeCreateTable(Btree *p, int *piTable, int createTabFlags){
danielk1977aef0bf62005-12-30 16:28:01 +00008777 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00008778 MemPage *pRoot;
8779 Pgno pgnoRoot;
8780 int rc;
drhd4187c72010-08-30 22:15:45 +00008781 int ptfFlags; /* Page-type flage for the root page of new table */
drhd677b3d2007-08-20 22:48:41 +00008782
drh1fee73e2007-08-29 04:00:57 +00008783 assert( sqlite3BtreeHoldsMutex(p) );
drh64022502009-01-09 14:11:04 +00008784 assert( pBt->inTransaction==TRANS_WRITE );
drhc9166342012-01-05 23:32:06 +00008785 assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk1977e6efa742004-11-10 11:55:10 +00008786
danielk1977003ba062004-11-04 02:57:33 +00008787#ifdef SQLITE_OMIT_AUTOVACUUM
drh4f0c5872007-03-26 22:05:01 +00008788 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
drhd677b3d2007-08-20 22:48:41 +00008789 if( rc ){
8790 return rc;
8791 }
danielk1977003ba062004-11-04 02:57:33 +00008792#else
danielk1977687566d2004-11-02 12:56:41 +00008793 if( pBt->autoVacuum ){
danielk1977003ba062004-11-04 02:57:33 +00008794 Pgno pgnoMove; /* Move a page here to make room for the root-page */
8795 MemPage *pPageMove; /* The page to move to. */
8796
danielk197720713f32007-05-03 11:43:33 +00008797 /* Creating a new table may probably require moving an existing database
8798 ** to make room for the new tables root page. In case this page turns
8799 ** out to be an overflow page, delete all overflow page-map caches
8800 ** held by open cursors.
8801 */
danielk197792d4d7a2007-05-04 12:05:56 +00008802 invalidateAllOverflowCache(pBt);
danielk197720713f32007-05-03 11:43:33 +00008803
danielk1977003ba062004-11-04 02:57:33 +00008804 /* Read the value of meta[3] from the database to determine where the
8805 ** root page of the new table should go. meta[3] is the largest root-page
8806 ** created so far, so the new root-page is (meta[3]+1).
8807 */
danielk1977602b4662009-07-02 07:47:33 +00008808 sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &pgnoRoot);
danielk1977003ba062004-11-04 02:57:33 +00008809 pgnoRoot++;
8810
danielk1977599fcba2004-11-08 07:13:13 +00008811 /* The new root-page may not be allocated on a pointer-map page, or the
8812 ** PENDING_BYTE page.
8813 */
drh72190432008-01-31 14:54:43 +00008814 while( pgnoRoot==PTRMAP_PAGENO(pBt, pgnoRoot) ||
danielk1977599fcba2004-11-08 07:13:13 +00008815 pgnoRoot==PENDING_BYTE_PAGE(pBt) ){
danielk1977003ba062004-11-04 02:57:33 +00008816 pgnoRoot++;
8817 }
drh499e15b2015-05-22 12:37:37 +00008818 assert( pgnoRoot>=3 || CORRUPT_DB );
8819 testcase( pgnoRoot<3 );
danielk1977003ba062004-11-04 02:57:33 +00008820
8821 /* Allocate a page. The page that currently resides at pgnoRoot will
8822 ** be moved to the allocated page (unless the allocated page happens
8823 ** to reside at pgnoRoot).
8824 */
dan51f0b6d2013-02-22 20:16:34 +00008825 rc = allocateBtreePage(pBt, &pPageMove, &pgnoMove, pgnoRoot, BTALLOC_EXACT);
danielk1977003ba062004-11-04 02:57:33 +00008826 if( rc!=SQLITE_OK ){
danielk1977687566d2004-11-02 12:56:41 +00008827 return rc;
8828 }
danielk1977003ba062004-11-04 02:57:33 +00008829
8830 if( pgnoMove!=pgnoRoot ){
danielk1977f35843b2007-04-07 15:03:17 +00008831 /* pgnoRoot is the page that will be used for the root-page of
8832 ** the new table (assuming an error did not occur). But we were
8833 ** allocated pgnoMove. If required (i.e. if it was not allocated
8834 ** by extending the file), the current page at position pgnoMove
8835 ** is already journaled.
8836 */
drheeb844a2009-08-08 18:01:07 +00008837 u8 eType = 0;
8838 Pgno iPtrPage = 0;
danielk1977003ba062004-11-04 02:57:33 +00008839
danf7679ad2013-04-03 11:38:36 +00008840 /* Save the positions of any open cursors. This is required in
8841 ** case they are holding a reference to an xFetch reference
8842 ** corresponding to page pgnoRoot. */
8843 rc = saveAllCursors(pBt, 0, 0);
danielk1977003ba062004-11-04 02:57:33 +00008844 releasePage(pPageMove);
danf7679ad2013-04-03 11:38:36 +00008845 if( rc!=SQLITE_OK ){
8846 return rc;
8847 }
danielk1977f35843b2007-04-07 15:03:17 +00008848
8849 /* Move the page currently at pgnoRoot to pgnoMove. */
drhb00fc3b2013-08-21 23:42:32 +00008850 rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00008851 if( rc!=SQLITE_OK ){
8852 return rc;
8853 }
8854 rc = ptrmapGet(pBt, pgnoRoot, &eType, &iPtrPage);
drh27731d72009-06-22 12:05:10 +00008855 if( eType==PTRMAP_ROOTPAGE || eType==PTRMAP_FREEPAGE ){
8856 rc = SQLITE_CORRUPT_BKPT;
8857 }
8858 if( rc!=SQLITE_OK ){
danielk1977003ba062004-11-04 02:57:33 +00008859 releasePage(pRoot);
8860 return rc;
8861 }
drhccae6022005-02-26 17:31:26 +00008862 assert( eType!=PTRMAP_ROOTPAGE );
8863 assert( eType!=PTRMAP_FREEPAGE );
danielk19774c999992008-07-16 18:17:55 +00008864 rc = relocatePage(pBt, pRoot, eType, iPtrPage, pgnoMove, 0);
danielk1977003ba062004-11-04 02:57:33 +00008865 releasePage(pRoot);
danielk1977f35843b2007-04-07 15:03:17 +00008866
8867 /* Obtain the page at pgnoRoot */
danielk1977003ba062004-11-04 02:57:33 +00008868 if( rc!=SQLITE_OK ){
8869 return rc;
8870 }
drhb00fc3b2013-08-21 23:42:32 +00008871 rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00008872 if( rc!=SQLITE_OK ){
8873 return rc;
8874 }
danielk19773b8a05f2007-03-19 17:44:26 +00008875 rc = sqlite3PagerWrite(pRoot->pDbPage);
danielk1977003ba062004-11-04 02:57:33 +00008876 if( rc!=SQLITE_OK ){
8877 releasePage(pRoot);
8878 return rc;
8879 }
8880 }else{
8881 pRoot = pPageMove;
8882 }
8883
danielk197742741be2005-01-08 12:42:39 +00008884 /* Update the pointer-map and meta-data with the new root-page number. */
drh98add2e2009-07-20 17:11:49 +00008885 ptrmapPut(pBt, pgnoRoot, PTRMAP_ROOTPAGE, 0, &rc);
danielk1977003ba062004-11-04 02:57:33 +00008886 if( rc ){
8887 releasePage(pRoot);
8888 return rc;
8889 }
drhbf592832010-03-30 15:51:12 +00008890
8891 /* When the new root page was allocated, page 1 was made writable in
8892 ** order either to increase the database filesize, or to decrement the
8893 ** freelist count. Hence, the sqlite3BtreeUpdateMeta() call cannot fail.
8894 */
8895 assert( sqlite3PagerIswriteable(pBt->pPage1->pDbPage) );
danielk1977aef0bf62005-12-30 16:28:01 +00008896 rc = sqlite3BtreeUpdateMeta(p, 4, pgnoRoot);
drhbf592832010-03-30 15:51:12 +00008897 if( NEVER(rc) ){
danielk1977003ba062004-11-04 02:57:33 +00008898 releasePage(pRoot);
8899 return rc;
8900 }
danielk197742741be2005-01-08 12:42:39 +00008901
danielk1977003ba062004-11-04 02:57:33 +00008902 }else{
drh4f0c5872007-03-26 22:05:01 +00008903 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
danielk1977003ba062004-11-04 02:57:33 +00008904 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00008905 }
8906#endif
danielk19773b8a05f2007-03-19 17:44:26 +00008907 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
drhd4187c72010-08-30 22:15:45 +00008908 if( createTabFlags & BTREE_INTKEY ){
8909 ptfFlags = PTF_INTKEY | PTF_LEAFDATA | PTF_LEAF;
8910 }else{
8911 ptfFlags = PTF_ZERODATA | PTF_LEAF;
8912 }
8913 zeroPage(pRoot, ptfFlags);
danielk19773b8a05f2007-03-19 17:44:26 +00008914 sqlite3PagerUnref(pRoot->pDbPage);
drhd4187c72010-08-30 22:15:45 +00008915 assert( (pBt->openFlags & BTREE_SINGLE)==0 || pgnoRoot==2 );
drh8b2f49b2001-06-08 00:21:52 +00008916 *piTable = (int)pgnoRoot;
8917 return SQLITE_OK;
8918}
drhd677b3d2007-08-20 22:48:41 +00008919int sqlite3BtreeCreateTable(Btree *p, int *piTable, int flags){
8920 int rc;
8921 sqlite3BtreeEnter(p);
8922 rc = btreeCreateTable(p, piTable, flags);
8923 sqlite3BtreeLeave(p);
8924 return rc;
8925}
drh8b2f49b2001-06-08 00:21:52 +00008926
8927/*
8928** Erase the given database page and all its children. Return
8929** the page to the freelist.
8930*/
drh4b70f112004-05-02 21:12:19 +00008931static int clearDatabasePage(
danielk1977aef0bf62005-12-30 16:28:01 +00008932 BtShared *pBt, /* The BTree that contains the table */
drh7ab641f2009-11-24 02:37:02 +00008933 Pgno pgno, /* Page number to clear */
8934 int freePageFlag, /* Deallocate page if true */
8935 int *pnChange /* Add number of Cells freed to this counter */
drh4b70f112004-05-02 21:12:19 +00008936){
danielk1977146ba992009-07-22 14:08:13 +00008937 MemPage *pPage;
drh8b2f49b2001-06-08 00:21:52 +00008938 int rc;
drh4b70f112004-05-02 21:12:19 +00008939 unsigned char *pCell;
8940 int i;
dan8ce71842014-01-14 20:14:09 +00008941 int hdr;
drh80159da2016-12-09 17:32:51 +00008942 CellInfo info;
drh8b2f49b2001-06-08 00:21:52 +00008943
drh1fee73e2007-08-29 04:00:57 +00008944 assert( sqlite3_mutex_held(pBt->mutex) );
drhb1299152010-03-30 22:58:33 +00008945 if( pgno>btreePagecount(pBt) ){
drh49285702005-09-17 15:20:26 +00008946 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00008947 }
drh28f58dd2015-06-27 19:45:03 +00008948 rc = getAndInitPage(pBt, pgno, &pPage, 0, 0);
danielk1977146ba992009-07-22 14:08:13 +00008949 if( rc ) return rc;
drhccf46d02015-04-01 13:21:33 +00008950 if( pPage->bBusy ){
8951 rc = SQLITE_CORRUPT_BKPT;
8952 goto cleardatabasepage_out;
8953 }
8954 pPage->bBusy = 1;
dan8ce71842014-01-14 20:14:09 +00008955 hdr = pPage->hdrOffset;
drh4b70f112004-05-02 21:12:19 +00008956 for(i=0; i<pPage->nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00008957 pCell = findCell(pPage, i);
drh4b70f112004-05-02 21:12:19 +00008958 if( !pPage->leaf ){
danielk197762c14b32008-11-19 09:05:26 +00008959 rc = clearDatabasePage(pBt, get4byte(pCell), 1, pnChange);
danielk19776b456a22005-03-21 04:04:02 +00008960 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00008961 }
drh80159da2016-12-09 17:32:51 +00008962 rc = clearCell(pPage, pCell, &info);
danielk19776b456a22005-03-21 04:04:02 +00008963 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00008964 }
drha34b6762004-05-07 13:30:42 +00008965 if( !pPage->leaf ){
dan8ce71842014-01-14 20:14:09 +00008966 rc = clearDatabasePage(pBt, get4byte(&pPage->aData[hdr+8]), 1, pnChange);
danielk19776b456a22005-03-21 04:04:02 +00008967 if( rc ) goto cleardatabasepage_out;
danielk1977c7af4842008-10-27 13:59:33 +00008968 }else if( pnChange ){
drhafe028a2015-05-22 13:09:50 +00008969 assert( pPage->intKey || CORRUPT_DB );
8970 testcase( !pPage->intKey );
danielk1977c7af4842008-10-27 13:59:33 +00008971 *pnChange += pPage->nCell;
drh2aa679f2001-06-25 02:11:07 +00008972 }
8973 if( freePageFlag ){
drhc314dc72009-07-21 11:52:34 +00008974 freePage(pPage, &rc);
danielk19773b8a05f2007-03-19 17:44:26 +00008975 }else if( (rc = sqlite3PagerWrite(pPage->pDbPage))==0 ){
dan8ce71842014-01-14 20:14:09 +00008976 zeroPage(pPage, pPage->aData[hdr] | PTF_LEAF);
drh2aa679f2001-06-25 02:11:07 +00008977 }
danielk19776b456a22005-03-21 04:04:02 +00008978
8979cleardatabasepage_out:
drhccf46d02015-04-01 13:21:33 +00008980 pPage->bBusy = 0;
drh4b70f112004-05-02 21:12:19 +00008981 releasePage(pPage);
drh2aa679f2001-06-25 02:11:07 +00008982 return rc;
drh8b2f49b2001-06-08 00:21:52 +00008983}
8984
8985/*
drhab01f612004-05-22 02:55:23 +00008986** Delete all information from a single table in the database. iTable is
8987** the page number of the root of the table. After this routine returns,
8988** the root page is empty, but still exists.
8989**
8990** This routine will fail with SQLITE_LOCKED if there are any open
8991** read cursors on the table. Open write cursors are moved to the
8992** root of the table.
danielk1977c7af4842008-10-27 13:59:33 +00008993**
8994** If pnChange is not NULL, then table iTable must be an intkey table. The
8995** integer value pointed to by pnChange is incremented by the number of
8996** entries in the table.
drh8b2f49b2001-06-08 00:21:52 +00008997*/
danielk1977c7af4842008-10-27 13:59:33 +00008998int sqlite3BtreeClearTable(Btree *p, int iTable, int *pnChange){
drh8b2f49b2001-06-08 00:21:52 +00008999 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00009000 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00009001 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00009002 assert( p->inTrans==TRANS_WRITE );
danielk197796d48e92009-06-29 06:00:37 +00009003
drhc046e3e2009-07-15 11:26:44 +00009004 rc = saveAllCursors(pBt, (Pgno)iTable, 0);
drhd60f4f42012-03-23 14:23:52 +00009005
drhc046e3e2009-07-15 11:26:44 +00009006 if( SQLITE_OK==rc ){
drhd60f4f42012-03-23 14:23:52 +00009007 /* Invalidate all incrblob cursors open on table iTable (assuming iTable
9008 ** is the root of a table b-tree - if it is not, the following call is
9009 ** a no-op). */
drh9ca431a2017-03-29 18:03:50 +00009010 invalidateIncrblobCursors(p, (Pgno)iTable, 0, 1);
danielk197762c14b32008-11-19 09:05:26 +00009011 rc = clearDatabasePage(pBt, (Pgno)iTable, 0, pnChange);
drh8b2f49b2001-06-08 00:21:52 +00009012 }
drhd677b3d2007-08-20 22:48:41 +00009013 sqlite3BtreeLeave(p);
9014 return rc;
drh8b2f49b2001-06-08 00:21:52 +00009015}
9016
9017/*
drh079a3072014-03-19 14:10:55 +00009018** Delete all information from the single table that pCur is open on.
9019**
9020** This routine only work for pCur on an ephemeral table.
9021*/
9022int sqlite3BtreeClearTableOfCursor(BtCursor *pCur){
9023 return sqlite3BtreeClearTable(pCur->pBtree, pCur->pgnoRoot, 0);
9024}
9025
9026/*
drh8b2f49b2001-06-08 00:21:52 +00009027** Erase all information in a table and add the root of the table to
9028** the freelist. Except, the root of the principle table (the one on
drhab01f612004-05-22 02:55:23 +00009029** page 1) is never added to the freelist.
9030**
9031** This routine will fail with SQLITE_LOCKED if there are any open
9032** cursors on the table.
drh205f48e2004-11-05 00:43:11 +00009033**
9034** If AUTOVACUUM is enabled and the page at iTable is not the last
9035** root page in the database file, then the last root page
9036** in the database file is moved into the slot formerly occupied by
9037** iTable and that last slot formerly occupied by the last root page
9038** is added to the freelist instead of iTable. In this say, all
9039** root pages are kept at the beginning of the database file, which
9040** is necessary for AUTOVACUUM to work right. *piMoved is set to the
9041** page number that used to be the last root page in the file before
9042** the move. If no page gets moved, *piMoved is set to 0.
9043** The last root page is recorded in meta[3] and the value of
9044** meta[3] is updated by this procedure.
drh8b2f49b2001-06-08 00:21:52 +00009045*/
danielk197789d40042008-11-17 14:20:56 +00009046static int btreeDropTable(Btree *p, Pgno iTable, int *piMoved){
drh8b2f49b2001-06-08 00:21:52 +00009047 int rc;
danielk1977a0bf2652004-11-04 14:30:04 +00009048 MemPage *pPage = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00009049 BtShared *pBt = p->pBt;
danielk1977a0bf2652004-11-04 14:30:04 +00009050
drh1fee73e2007-08-29 04:00:57 +00009051 assert( sqlite3BtreeHoldsMutex(p) );
drh64022502009-01-09 14:11:04 +00009052 assert( p->inTrans==TRANS_WRITE );
drh65f38d92016-11-22 01:26:42 +00009053 assert( iTable>=2 );
drh055f2982016-01-15 15:06:41 +00009054
drhb00fc3b2013-08-21 23:42:32 +00009055 rc = btreeGetPage(pBt, (Pgno)iTable, &pPage, 0);
drh2aa679f2001-06-25 02:11:07 +00009056 if( rc ) return rc;
danielk1977c7af4842008-10-27 13:59:33 +00009057 rc = sqlite3BtreeClearTable(p, iTable, 0);
danielk19776b456a22005-03-21 04:04:02 +00009058 if( rc ){
9059 releasePage(pPage);
9060 return rc;
9061 }
danielk1977a0bf2652004-11-04 14:30:04 +00009062
drh205f48e2004-11-05 00:43:11 +00009063 *piMoved = 0;
danielk1977a0bf2652004-11-04 14:30:04 +00009064
danielk1977a0bf2652004-11-04 14:30:04 +00009065#ifdef SQLITE_OMIT_AUTOVACUUM
drh055f2982016-01-15 15:06:41 +00009066 freePage(pPage, &rc);
9067 releasePage(pPage);
danielk1977a0bf2652004-11-04 14:30:04 +00009068#else
drh055f2982016-01-15 15:06:41 +00009069 if( pBt->autoVacuum ){
9070 Pgno maxRootPgno;
9071 sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00009072
drh055f2982016-01-15 15:06:41 +00009073 if( iTable==maxRootPgno ){
9074 /* If the table being dropped is the table with the largest root-page
9075 ** number in the database, put the root page on the free list.
danielk1977599fcba2004-11-08 07:13:13 +00009076 */
drhc314dc72009-07-21 11:52:34 +00009077 freePage(pPage, &rc);
danielk1977a0bf2652004-11-04 14:30:04 +00009078 releasePage(pPage);
drh055f2982016-01-15 15:06:41 +00009079 if( rc!=SQLITE_OK ){
9080 return rc;
9081 }
9082 }else{
9083 /* The table being dropped does not have the largest root-page
9084 ** number in the database. So move the page that does into the
9085 ** gap left by the deleted root-page.
9086 */
9087 MemPage *pMove;
9088 releasePage(pPage);
9089 rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
9090 if( rc!=SQLITE_OK ){
9091 return rc;
9092 }
9093 rc = relocatePage(pBt, pMove, PTRMAP_ROOTPAGE, 0, iTable, 0);
9094 releasePage(pMove);
9095 if( rc!=SQLITE_OK ){
9096 return rc;
9097 }
9098 pMove = 0;
9099 rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
9100 freePage(pMove, &rc);
9101 releasePage(pMove);
9102 if( rc!=SQLITE_OK ){
9103 return rc;
9104 }
9105 *piMoved = maxRootPgno;
danielk1977a0bf2652004-11-04 14:30:04 +00009106 }
drh055f2982016-01-15 15:06:41 +00009107
9108 /* Set the new 'max-root-page' value in the database header. This
9109 ** is the old value less one, less one more if that happens to
9110 ** be a root-page number, less one again if that is the
9111 ** PENDING_BYTE_PAGE.
drhc046e3e2009-07-15 11:26:44 +00009112 */
drh055f2982016-01-15 15:06:41 +00009113 maxRootPgno--;
9114 while( maxRootPgno==PENDING_BYTE_PAGE(pBt)
9115 || PTRMAP_ISPAGE(pBt, maxRootPgno) ){
9116 maxRootPgno--;
9117 }
9118 assert( maxRootPgno!=PENDING_BYTE_PAGE(pBt) );
9119
9120 rc = sqlite3BtreeUpdateMeta(p, 4, maxRootPgno);
9121 }else{
9122 freePage(pPage, &rc);
danielk1977a0bf2652004-11-04 14:30:04 +00009123 releasePage(pPage);
drh8b2f49b2001-06-08 00:21:52 +00009124 }
drh055f2982016-01-15 15:06:41 +00009125#endif
drh8b2f49b2001-06-08 00:21:52 +00009126 return rc;
9127}
drhd677b3d2007-08-20 22:48:41 +00009128int sqlite3BtreeDropTable(Btree *p, int iTable, int *piMoved){
9129 int rc;
9130 sqlite3BtreeEnter(p);
dan7733a4d2011-09-02 18:03:16 +00009131 rc = btreeDropTable(p, iTable, piMoved);
drhd677b3d2007-08-20 22:48:41 +00009132 sqlite3BtreeLeave(p);
9133 return rc;
9134}
drh8b2f49b2001-06-08 00:21:52 +00009135
drh001bbcb2003-03-19 03:14:00 +00009136
drh8b2f49b2001-06-08 00:21:52 +00009137/*
danielk1977602b4662009-07-02 07:47:33 +00009138** This function may only be called if the b-tree connection already
9139** has a read or write transaction open on the database.
9140**
drh23e11ca2004-05-04 17:27:28 +00009141** Read the meta-information out of a database file. Meta[0]
9142** is the number of free pages currently in the database. Meta[1]
drha3b321d2004-05-11 09:31:31 +00009143** through meta[15] are available for use by higher layers. Meta[0]
9144** is read-only, the others are read/write.
9145**
9146** The schema layer numbers meta values differently. At the schema
9147** layer (and the SetCookie and ReadCookie opcodes) the number of
9148** free pages is not visible. So Cookie[0] is the same as Meta[1].
drh91618562014-12-19 19:28:02 +00009149**
9150** This routine treats Meta[BTREE_DATA_VERSION] as a special case. Instead
9151** of reading the value out of the header, it instead loads the "DataVersion"
9152** from the pager. The BTREE_DATA_VERSION value is not actually stored in the
9153** database file. It is a number computed by the pager. But its access
9154** pattern is the same as header meta values, and so it is convenient to
9155** read it from this routine.
drh8b2f49b2001-06-08 00:21:52 +00009156*/
danielk1977602b4662009-07-02 07:47:33 +00009157void sqlite3BtreeGetMeta(Btree *p, int idx, u32 *pMeta){
danielk1977aef0bf62005-12-30 16:28:01 +00009158 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00009159
drhd677b3d2007-08-20 22:48:41 +00009160 sqlite3BtreeEnter(p);
danielk1977602b4662009-07-02 07:47:33 +00009161 assert( p->inTrans>TRANS_NONE );
danielk1977e0d9e6f2009-07-03 16:25:06 +00009162 assert( SQLITE_OK==querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK) );
danielk1977602b4662009-07-02 07:47:33 +00009163 assert( pBt->pPage1 );
drh23e11ca2004-05-04 17:27:28 +00009164 assert( idx>=0 && idx<=15 );
danielk1977ea897302008-09-19 15:10:58 +00009165
drh91618562014-12-19 19:28:02 +00009166 if( idx==BTREE_DATA_VERSION ){
drh3da9c042014-12-22 18:41:21 +00009167 *pMeta = sqlite3PagerDataVersion(pBt->pPager) + p->iDataVersion;
drh91618562014-12-19 19:28:02 +00009168 }else{
9169 *pMeta = get4byte(&pBt->pPage1->aData[36 + idx*4]);
9170 }
drhae157872004-08-14 19:20:09 +00009171
danielk1977602b4662009-07-02 07:47:33 +00009172 /* If auto-vacuum is disabled in this build and this is an auto-vacuum
9173 ** database, mark the database as read-only. */
danielk1977003ba062004-11-04 02:57:33 +00009174#ifdef SQLITE_OMIT_AUTOVACUUM
drhc9166342012-01-05 23:32:06 +00009175 if( idx==BTREE_LARGEST_ROOT_PAGE && *pMeta>0 ){
9176 pBt->btsFlags |= BTS_READ_ONLY;
9177 }
danielk1977003ba062004-11-04 02:57:33 +00009178#endif
drhae157872004-08-14 19:20:09 +00009179
drhd677b3d2007-08-20 22:48:41 +00009180 sqlite3BtreeLeave(p);
drh8b2f49b2001-06-08 00:21:52 +00009181}
9182
9183/*
drh23e11ca2004-05-04 17:27:28 +00009184** Write meta-information back into the database. Meta[0] is
9185** read-only and may not be written.
drh8b2f49b2001-06-08 00:21:52 +00009186*/
danielk1977aef0bf62005-12-30 16:28:01 +00009187int sqlite3BtreeUpdateMeta(Btree *p, int idx, u32 iMeta){
9188 BtShared *pBt = p->pBt;
drh4b70f112004-05-02 21:12:19 +00009189 unsigned char *pP1;
drha34b6762004-05-07 13:30:42 +00009190 int rc;
drh23e11ca2004-05-04 17:27:28 +00009191 assert( idx>=1 && idx<=15 );
drhd677b3d2007-08-20 22:48:41 +00009192 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00009193 assert( p->inTrans==TRANS_WRITE );
9194 assert( pBt->pPage1!=0 );
9195 pP1 = pBt->pPage1->aData;
9196 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
9197 if( rc==SQLITE_OK ){
9198 put4byte(&pP1[36 + idx*4], iMeta);
danielk19774152e672007-09-12 17:01:45 +00009199#ifndef SQLITE_OMIT_AUTOVACUUM
danielk19770d19f7a2009-06-03 11:25:07 +00009200 if( idx==BTREE_INCR_VACUUM ){
drh64022502009-01-09 14:11:04 +00009201 assert( pBt->autoVacuum || iMeta==0 );
9202 assert( iMeta==0 || iMeta==1 );
9203 pBt->incrVacuum = (u8)iMeta;
drhd677b3d2007-08-20 22:48:41 +00009204 }
drh64022502009-01-09 14:11:04 +00009205#endif
drh5df72a52002-06-06 23:16:05 +00009206 }
drhd677b3d2007-08-20 22:48:41 +00009207 sqlite3BtreeLeave(p);
9208 return rc;
drh8b2f49b2001-06-08 00:21:52 +00009209}
drh8c42ca92001-06-22 19:15:00 +00009210
danielk1977a5533162009-02-24 10:01:51 +00009211#ifndef SQLITE_OMIT_BTREECOUNT
9212/*
9213** The first argument, pCur, is a cursor opened on some b-tree. Count the
9214** number of entries in the b-tree and write the result to *pnEntry.
9215**
9216** SQLITE_OK is returned if the operation is successfully executed.
9217** Otherwise, if an error is encountered (i.e. an IO error or database
9218** corruption) an SQLite error code is returned.
9219*/
9220int sqlite3BtreeCount(BtCursor *pCur, i64 *pnEntry){
9221 i64 nEntry = 0; /* Value to return in *pnEntry */
9222 int rc; /* Return code */
dana205a482011-08-27 18:48:57 +00009223
drh44548e72017-08-14 18:13:52 +00009224 rc = moveToRoot(pCur);
9225 if( rc==SQLITE_EMPTY ){
dana205a482011-08-27 18:48:57 +00009226 *pnEntry = 0;
9227 return SQLITE_OK;
9228 }
danielk1977a5533162009-02-24 10:01:51 +00009229
9230 /* Unless an error occurs, the following loop runs one iteration for each
9231 ** page in the B-Tree structure (not including overflow pages).
9232 */
9233 while( rc==SQLITE_OK ){
9234 int iIdx; /* Index of child node in parent */
9235 MemPage *pPage; /* Current page of the b-tree */
9236
9237 /* If this is a leaf page or the tree is not an int-key tree, then
9238 ** this page contains countable entries. Increment the entry counter
9239 ** accordingly.
9240 */
drh352a35a2017-08-15 03:46:47 +00009241 pPage = pCur->pPage;
danielk1977a5533162009-02-24 10:01:51 +00009242 if( pPage->leaf || !pPage->intKey ){
9243 nEntry += pPage->nCell;
9244 }
9245
9246 /* pPage is a leaf node. This loop navigates the cursor so that it
9247 ** points to the first interior cell that it points to the parent of
9248 ** the next page in the tree that has not yet been visited. The
9249 ** pCur->aiIdx[pCur->iPage] value is set to the index of the parent cell
9250 ** of the page, or to the number of cells in the page if the next page
9251 ** to visit is the right-child of its parent.
9252 **
9253 ** If all pages in the tree have been visited, return SQLITE_OK to the
9254 ** caller.
9255 */
9256 if( pPage->leaf ){
9257 do {
9258 if( pCur->iPage==0 ){
9259 /* All pages of the b-tree have been visited. Return successfully. */
9260 *pnEntry = nEntry;
drh7efa4262014-12-16 00:08:31 +00009261 return moveToRoot(pCur);
danielk1977a5533162009-02-24 10:01:51 +00009262 }
danielk197730548662009-07-09 05:07:37 +00009263 moveToParent(pCur);
drh352a35a2017-08-15 03:46:47 +00009264 }while ( pCur->ix>=pCur->pPage->nCell );
danielk1977a5533162009-02-24 10:01:51 +00009265
drh75e96b32017-04-01 00:20:06 +00009266 pCur->ix++;
drh352a35a2017-08-15 03:46:47 +00009267 pPage = pCur->pPage;
danielk1977a5533162009-02-24 10:01:51 +00009268 }
9269
9270 /* Descend to the child node of the cell that the cursor currently
9271 ** points at. This is the right-child if (iIdx==pPage->nCell).
9272 */
drh75e96b32017-04-01 00:20:06 +00009273 iIdx = pCur->ix;
danielk1977a5533162009-02-24 10:01:51 +00009274 if( iIdx==pPage->nCell ){
9275 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
9276 }else{
9277 rc = moveToChild(pCur, get4byte(findCell(pPage, iIdx)));
9278 }
9279 }
9280
shanebe217792009-03-05 04:20:31 +00009281 /* An error has occurred. Return an error code. */
danielk1977a5533162009-02-24 10:01:51 +00009282 return rc;
9283}
9284#endif
drhdd793422001-06-28 01:54:48 +00009285
drhdd793422001-06-28 01:54:48 +00009286/*
drh5eddca62001-06-30 21:53:53 +00009287** Return the pager associated with a BTree. This routine is used for
9288** testing and debugging only.
drhdd793422001-06-28 01:54:48 +00009289*/
danielk1977aef0bf62005-12-30 16:28:01 +00009290Pager *sqlite3BtreePager(Btree *p){
9291 return p->pBt->pPager;
drhdd793422001-06-28 01:54:48 +00009292}
drh5eddca62001-06-30 21:53:53 +00009293
drhb7f91642004-10-31 02:22:47 +00009294#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00009295/*
9296** Append a message to the error message string.
9297*/
drh2e38c322004-09-03 18:38:44 +00009298static void checkAppendMsg(
9299 IntegrityCk *pCheck,
drh2e38c322004-09-03 18:38:44 +00009300 const char *zFormat,
9301 ...
9302){
9303 va_list ap;
drh1dcdbc02007-01-27 02:24:54 +00009304 if( !pCheck->mxErr ) return;
9305 pCheck->mxErr--;
9306 pCheck->nErr++;
drh2e38c322004-09-03 18:38:44 +00009307 va_start(ap, zFormat);
drhf089aa42008-07-08 19:34:06 +00009308 if( pCheck->errMsg.nChar ){
drh0cdbe1a2018-05-09 13:46:26 +00009309 sqlite3_str_append(&pCheck->errMsg, "\n", 1);
drh5eddca62001-06-30 21:53:53 +00009310 }
drh867db832014-09-26 02:41:05 +00009311 if( pCheck->zPfx ){
drh0cdbe1a2018-05-09 13:46:26 +00009312 sqlite3_str_appendf(&pCheck->errMsg, pCheck->zPfx, pCheck->v1, pCheck->v2);
drhf089aa42008-07-08 19:34:06 +00009313 }
drh0cdbe1a2018-05-09 13:46:26 +00009314 sqlite3_str_vappendf(&pCheck->errMsg, zFormat, ap);
drhf089aa42008-07-08 19:34:06 +00009315 va_end(ap);
drh0cdbe1a2018-05-09 13:46:26 +00009316 if( pCheck->errMsg.accError==SQLITE_NOMEM ){
drhc890fec2008-08-01 20:10:08 +00009317 pCheck->mallocFailed = 1;
9318 }
drh5eddca62001-06-30 21:53:53 +00009319}
drhb7f91642004-10-31 02:22:47 +00009320#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00009321
drhb7f91642004-10-31 02:22:47 +00009322#ifndef SQLITE_OMIT_INTEGRITY_CHECK
dan1235bb12012-04-03 17:43:28 +00009323
9324/*
9325** Return non-zero if the bit in the IntegrityCk.aPgRef[] array that
9326** corresponds to page iPg is already set.
9327*/
9328static int getPageReferenced(IntegrityCk *pCheck, Pgno iPg){
9329 assert( iPg<=pCheck->nPage && sizeof(pCheck->aPgRef[0])==1 );
9330 return (pCheck->aPgRef[iPg/8] & (1 << (iPg & 0x07)));
9331}
9332
9333/*
9334** Set the bit in the IntegrityCk.aPgRef[] array that corresponds to page iPg.
9335*/
9336static void setPageReferenced(IntegrityCk *pCheck, Pgno iPg){
9337 assert( iPg<=pCheck->nPage && sizeof(pCheck->aPgRef[0])==1 );
9338 pCheck->aPgRef[iPg/8] |= (1 << (iPg & 0x07));
9339}
9340
9341
drh5eddca62001-06-30 21:53:53 +00009342/*
9343** Add 1 to the reference count for page iPage. If this is the second
9344** reference to the page, add an error message to pCheck->zErrMsg.
peter.d.reid60ec9142014-09-06 16:39:46 +00009345** Return 1 if there are 2 or more references to the page and 0 if
drh5eddca62001-06-30 21:53:53 +00009346** if this is the first reference to the page.
9347**
9348** Also check that the page number is in bounds.
9349*/
drh867db832014-09-26 02:41:05 +00009350static int checkRef(IntegrityCk *pCheck, Pgno iPage){
drh91d58662018-07-20 13:39:28 +00009351 if( iPage>pCheck->nPage || iPage==0 ){
drh867db832014-09-26 02:41:05 +00009352 checkAppendMsg(pCheck, "invalid page number %d", iPage);
drh5eddca62001-06-30 21:53:53 +00009353 return 1;
9354 }
dan1235bb12012-04-03 17:43:28 +00009355 if( getPageReferenced(pCheck, iPage) ){
drh867db832014-09-26 02:41:05 +00009356 checkAppendMsg(pCheck, "2nd reference to page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00009357 return 1;
9358 }
dan1235bb12012-04-03 17:43:28 +00009359 setPageReferenced(pCheck, iPage);
9360 return 0;
drh5eddca62001-06-30 21:53:53 +00009361}
9362
danielk1977afcdd022004-10-31 16:25:42 +00009363#ifndef SQLITE_OMIT_AUTOVACUUM
9364/*
9365** Check that the entry in the pointer-map for page iChild maps to
9366** page iParent, pointer type ptrType. If not, append an error message
9367** to pCheck.
9368*/
9369static void checkPtrmap(
9370 IntegrityCk *pCheck, /* Integrity check context */
9371 Pgno iChild, /* Child page number */
9372 u8 eType, /* Expected pointer map type */
drh867db832014-09-26 02:41:05 +00009373 Pgno iParent /* Expected pointer map parent page number */
danielk1977afcdd022004-10-31 16:25:42 +00009374){
9375 int rc;
9376 u8 ePtrmapType;
9377 Pgno iPtrmapParent;
9378
9379 rc = ptrmapGet(pCheck->pBt, iChild, &ePtrmapType, &iPtrmapParent);
9380 if( rc!=SQLITE_OK ){
drhb56cd552009-05-01 13:16:54 +00009381 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ) pCheck->mallocFailed = 1;
drh867db832014-09-26 02:41:05 +00009382 checkAppendMsg(pCheck, "Failed to read ptrmap key=%d", iChild);
danielk1977afcdd022004-10-31 16:25:42 +00009383 return;
9384 }
9385
9386 if( ePtrmapType!=eType || iPtrmapParent!=iParent ){
drh867db832014-09-26 02:41:05 +00009387 checkAppendMsg(pCheck,
danielk1977afcdd022004-10-31 16:25:42 +00009388 "Bad ptr map entry key=%d expected=(%d,%d) got=(%d,%d)",
9389 iChild, eType, iParent, ePtrmapType, iPtrmapParent);
9390 }
9391}
9392#endif
9393
drh5eddca62001-06-30 21:53:53 +00009394/*
9395** Check the integrity of the freelist or of an overflow page list.
9396** Verify that the number of pages on the list is N.
9397*/
drh30e58752002-03-02 20:41:57 +00009398static void checkList(
9399 IntegrityCk *pCheck, /* Integrity checking context */
9400 int isFreeList, /* True for a freelist. False for overflow page list */
9401 int iPage, /* Page number for first page in the list */
drh867db832014-09-26 02:41:05 +00009402 int N /* Expected number of pages in the list */
drh30e58752002-03-02 20:41:57 +00009403){
9404 int i;
drh3a4c1412004-05-09 20:40:11 +00009405 int expected = N;
drh91d58662018-07-20 13:39:28 +00009406 int nErrAtStart = pCheck->nErr;
9407 while( iPage!=0 && pCheck->mxErr ){
danielk19773b8a05f2007-03-19 17:44:26 +00009408 DbPage *pOvflPage;
9409 unsigned char *pOvflData;
drh867db832014-09-26 02:41:05 +00009410 if( checkRef(pCheck, iPage) ) break;
drh91d58662018-07-20 13:39:28 +00009411 N--;
drh9584f582015-11-04 20:22:37 +00009412 if( sqlite3PagerGet(pCheck->pPager, (Pgno)iPage, &pOvflPage, 0) ){
drh867db832014-09-26 02:41:05 +00009413 checkAppendMsg(pCheck, "failed to get page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00009414 break;
9415 }
danielk19773b8a05f2007-03-19 17:44:26 +00009416 pOvflData = (unsigned char *)sqlite3PagerGetData(pOvflPage);
drh30e58752002-03-02 20:41:57 +00009417 if( isFreeList ){
drhae104742018-12-14 17:57:01 +00009418 u32 n = (u32)get4byte(&pOvflData[4]);
danielk1977687566d2004-11-02 12:56:41 +00009419#ifndef SQLITE_OMIT_AUTOVACUUM
9420 if( pCheck->pBt->autoVacuum ){
drh867db832014-09-26 02:41:05 +00009421 checkPtrmap(pCheck, iPage, PTRMAP_FREEPAGE, 0);
danielk1977687566d2004-11-02 12:56:41 +00009422 }
9423#endif
drhae104742018-12-14 17:57:01 +00009424 if( n>pCheck->pBt->usableSize/4-2 ){
drh867db832014-09-26 02:41:05 +00009425 checkAppendMsg(pCheck,
drh2e38c322004-09-03 18:38:44 +00009426 "freelist leaf count too big on page %d", iPage);
drhee696e22004-08-30 16:52:17 +00009427 N--;
9428 }else{
drhae104742018-12-14 17:57:01 +00009429 for(i=0; i<(int)n; i++){
danielk19773b8a05f2007-03-19 17:44:26 +00009430 Pgno iFreePage = get4byte(&pOvflData[8+i*4]);
danielk1977687566d2004-11-02 12:56:41 +00009431#ifndef SQLITE_OMIT_AUTOVACUUM
9432 if( pCheck->pBt->autoVacuum ){
drh867db832014-09-26 02:41:05 +00009433 checkPtrmap(pCheck, iFreePage, PTRMAP_FREEPAGE, 0);
danielk1977687566d2004-11-02 12:56:41 +00009434 }
9435#endif
drh867db832014-09-26 02:41:05 +00009436 checkRef(pCheck, iFreePage);
drhee696e22004-08-30 16:52:17 +00009437 }
9438 N -= n;
drh30e58752002-03-02 20:41:57 +00009439 }
drh30e58752002-03-02 20:41:57 +00009440 }
danielk1977afcdd022004-10-31 16:25:42 +00009441#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00009442 else{
9443 /* If this database supports auto-vacuum and iPage is not the last
9444 ** page in this overflow list, check that the pointer-map entry for
9445 ** the following page matches iPage.
9446 */
9447 if( pCheck->pBt->autoVacuum && N>0 ){
danielk19773b8a05f2007-03-19 17:44:26 +00009448 i = get4byte(pOvflData);
drh867db832014-09-26 02:41:05 +00009449 checkPtrmap(pCheck, i, PTRMAP_OVERFLOW2, iPage);
danielk1977687566d2004-11-02 12:56:41 +00009450 }
danielk1977afcdd022004-10-31 16:25:42 +00009451 }
9452#endif
danielk19773b8a05f2007-03-19 17:44:26 +00009453 iPage = get4byte(pOvflData);
9454 sqlite3PagerUnref(pOvflPage);
drh91d58662018-07-20 13:39:28 +00009455 }
9456 if( N && nErrAtStart==pCheck->nErr ){
9457 checkAppendMsg(pCheck,
9458 "%s is %d but should be %d",
9459 isFreeList ? "size" : "overflow list length",
9460 expected-N, expected);
drh5eddca62001-06-30 21:53:53 +00009461 }
9462}
drhb7f91642004-10-31 02:22:47 +00009463#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00009464
drh67731a92015-04-16 11:56:03 +00009465/*
9466** An implementation of a min-heap.
9467**
9468** aHeap[0] is the number of elements on the heap. aHeap[1] is the
drha33b6832015-04-16 21:57:37 +00009469** root element. The daughter nodes of aHeap[N] are aHeap[N*2]
drh67731a92015-04-16 11:56:03 +00009470** and aHeap[N*2+1].
9471**
9472** The heap property is this: Every node is less than or equal to both
9473** of its daughter nodes. A consequence of the heap property is that the
drh42c0a2b2015-04-28 01:28:36 +00009474** root node aHeap[1] is always the minimum value currently in the heap.
drh67731a92015-04-16 11:56:03 +00009475**
9476** The btreeHeapInsert() routine inserts an unsigned 32-bit number onto
9477** the heap, preserving the heap property. The btreeHeapPull() routine
9478** removes the root element from the heap (the minimum value in the heap)
drh42c0a2b2015-04-28 01:28:36 +00009479** and then moves other nodes around as necessary to preserve the heap
drh67731a92015-04-16 11:56:03 +00009480** property.
9481**
9482** This heap is used for cell overlap and coverage testing. Each u32
9483** entry represents the span of a cell or freeblock on a btree page.
9484** The upper 16 bits are the index of the first byte of a range and the
9485** lower 16 bits are the index of the last byte of that range.
9486*/
9487static void btreeHeapInsert(u32 *aHeap, u32 x){
9488 u32 j, i = ++aHeap[0];
9489 aHeap[i] = x;
drha33b6832015-04-16 21:57:37 +00009490 while( (j = i/2)>0 && aHeap[j]>aHeap[i] ){
drh67731a92015-04-16 11:56:03 +00009491 x = aHeap[j];
9492 aHeap[j] = aHeap[i];
9493 aHeap[i] = x;
9494 i = j;
9495 }
9496}
9497static int btreeHeapPull(u32 *aHeap, u32 *pOut){
9498 u32 j, i, x;
9499 if( (x = aHeap[0])==0 ) return 0;
9500 *pOut = aHeap[1];
9501 aHeap[1] = aHeap[x];
9502 aHeap[x] = 0xffffffff;
9503 aHeap[0]--;
9504 i = 1;
9505 while( (j = i*2)<=aHeap[0] ){
9506 if( aHeap[j]>aHeap[j+1] ) j++;
9507 if( aHeap[i]<aHeap[j] ) break;
9508 x = aHeap[i];
9509 aHeap[i] = aHeap[j];
9510 aHeap[j] = x;
9511 i = j;
9512 }
9513 return 1;
9514}
9515
drhb7f91642004-10-31 02:22:47 +00009516#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00009517/*
9518** Do various sanity checks on a single page of a tree. Return
9519** the tree depth. Root pages return 0. Parents of root pages
9520** return 1, and so forth.
9521**
9522** These checks are done:
9523**
9524** 1. Make sure that cells and freeblocks do not overlap
9525** but combine to completely cover the page.
drhe05b3f82015-07-01 17:53:49 +00009526** 2. Make sure integer cell keys are in order.
9527** 3. Check the integrity of overflow pages.
9528** 4. Recursively call checkTreePage on all children.
9529** 5. Verify that the depth of all children is the same.
drh5eddca62001-06-30 21:53:53 +00009530*/
9531static int checkTreePage(
drhaaab5722002-02-19 13:39:21 +00009532 IntegrityCk *pCheck, /* Context for the sanity check */
drh5eddca62001-06-30 21:53:53 +00009533 int iPage, /* Page number of the page to check */
drhcbc6b712015-07-02 16:17:30 +00009534 i64 *piMinKey, /* Write minimum integer primary key here */
9535 i64 maxKey /* Error if integer primary key greater than this */
drh5eddca62001-06-30 21:53:53 +00009536){
drhcbc6b712015-07-02 16:17:30 +00009537 MemPage *pPage = 0; /* The page being analyzed */
9538 int i; /* Loop counter */
9539 int rc; /* Result code from subroutine call */
9540 int depth = -1, d2; /* Depth of a subtree */
9541 int pgno; /* Page number */
9542 int nFrag; /* Number of fragmented bytes on the page */
9543 int hdr; /* Offset to the page header */
9544 int cellStart; /* Offset to the start of the cell pointer array */
9545 int nCell; /* Number of cells */
9546 int doCoverageCheck = 1; /* True if cell coverage checking should be done */
9547 int keyCanBeEqual = 1; /* True if IPK can be equal to maxKey
9548 ** False if IPK must be strictly less than maxKey */
9549 u8 *data; /* Page content */
9550 u8 *pCell; /* Cell content */
9551 u8 *pCellIdx; /* Next element of the cell pointer array */
9552 BtShared *pBt; /* The BtShared object that owns pPage */
9553 u32 pc; /* Address of a cell */
9554 u32 usableSize; /* Usable size of the page */
9555 u32 contentOffset; /* Offset to the start of the cell content area */
9556 u32 *heap = 0; /* Min-heap used for checking cell coverage */
drhd2dc87f2015-07-02 19:47:08 +00009557 u32 x, prev = 0; /* Next and previous entry on the min-heap */
drh867db832014-09-26 02:41:05 +00009558 const char *saved_zPfx = pCheck->zPfx;
9559 int saved_v1 = pCheck->v1;
9560 int saved_v2 = pCheck->v2;
mistachkin532f1792015-07-14 17:18:05 +00009561 u8 savedIsInit = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00009562
drh5eddca62001-06-30 21:53:53 +00009563 /* Check that the page exists
9564 */
drhd9cb6ac2005-10-20 07:28:17 +00009565 pBt = pCheck->pBt;
drhb6f41482004-05-14 01:58:11 +00009566 usableSize = pBt->usableSize;
drh5eddca62001-06-30 21:53:53 +00009567 if( iPage==0 ) return 0;
drh867db832014-09-26 02:41:05 +00009568 if( checkRef(pCheck, iPage) ) return 0;
9569 pCheck->zPfx = "Page %d: ";
9570 pCheck->v1 = iPage;
drhb00fc3b2013-08-21 23:42:32 +00009571 if( (rc = btreeGetPage(pBt, (Pgno)iPage, &pPage, 0))!=0 ){
drh867db832014-09-26 02:41:05 +00009572 checkAppendMsg(pCheck,
drh2e38c322004-09-03 18:38:44 +00009573 "unable to get the page. error code=%d", rc);
drh867db832014-09-26 02:41:05 +00009574 goto end_of_check;
drh5eddca62001-06-30 21:53:53 +00009575 }
danielk197793caf5a2009-07-11 06:55:33 +00009576
9577 /* Clear MemPage.isInit to make sure the corruption detection code in
9578 ** btreeInitPage() is executed. */
drh72e191e2015-07-04 11:14:20 +00009579 savedIsInit = pPage->isInit;
danielk197793caf5a2009-07-11 06:55:33 +00009580 pPage->isInit = 0;
danielk197730548662009-07-09 05:07:37 +00009581 if( (rc = btreeInitPage(pPage))!=0 ){
drh64022502009-01-09 14:11:04 +00009582 assert( rc==SQLITE_CORRUPT ); /* The only possible error from InitPage */
drh867db832014-09-26 02:41:05 +00009583 checkAppendMsg(pCheck,
danielk197730548662009-07-09 05:07:37 +00009584 "btreeInitPage() returns error code %d", rc);
drh867db832014-09-26 02:41:05 +00009585 goto end_of_check;
drh5eddca62001-06-30 21:53:53 +00009586 }
drhcbc6b712015-07-02 16:17:30 +00009587 data = pPage->aData;
9588 hdr = pPage->hdrOffset;
drh5eddca62001-06-30 21:53:53 +00009589
drhcbc6b712015-07-02 16:17:30 +00009590 /* Set up for cell analysis */
drhe05b3f82015-07-01 17:53:49 +00009591 pCheck->zPfx = "On tree page %d cell %d: ";
drhcbc6b712015-07-02 16:17:30 +00009592 contentOffset = get2byteNotZero(&data[hdr+5]);
9593 assert( contentOffset<=usableSize ); /* Enforced by btreeInitPage() */
9594
9595 /* EVIDENCE-OF: R-37002-32774 The two-byte integer at offset 3 gives the
9596 ** number of cells on the page. */
9597 nCell = get2byte(&data[hdr+3]);
9598 assert( pPage->nCell==nCell );
9599
9600 /* EVIDENCE-OF: R-23882-45353 The cell pointer array of a b-tree page
9601 ** immediately follows the b-tree page header. */
9602 cellStart = hdr + 12 - 4*pPage->leaf;
9603 assert( pPage->aCellIdx==&data[cellStart] );
9604 pCellIdx = &data[cellStart + 2*(nCell-1)];
9605
9606 if( !pPage->leaf ){
9607 /* Analyze the right-child page of internal pages */
9608 pgno = get4byte(&data[hdr+8]);
9609#ifndef SQLITE_OMIT_AUTOVACUUM
9610 if( pBt->autoVacuum ){
9611 pCheck->zPfx = "On page %d at right child: ";
9612 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage);
9613 }
9614#endif
9615 depth = checkTreePage(pCheck, pgno, &maxKey, maxKey);
9616 keyCanBeEqual = 0;
9617 }else{
9618 /* For leaf pages, the coverage check will occur in the same loop
9619 ** as the other cell checks, so initialize the heap. */
9620 heap = pCheck->heap;
9621 heap[0] = 0;
drh5eddca62001-06-30 21:53:53 +00009622 }
9623
drhcbc6b712015-07-02 16:17:30 +00009624 /* EVIDENCE-OF: R-02776-14802 The cell pointer array consists of K 2-byte
9625 ** integer offsets to the cell contents. */
9626 for(i=nCell-1; i>=0 && pCheck->mxErr; i--){
drh6f11bef2004-05-13 01:12:56 +00009627 CellInfo info;
drh5eddca62001-06-30 21:53:53 +00009628
drhcbc6b712015-07-02 16:17:30 +00009629 /* Check cell size */
drh867db832014-09-26 02:41:05 +00009630 pCheck->v2 = i;
drhcbc6b712015-07-02 16:17:30 +00009631 assert( pCellIdx==&data[cellStart + i*2] );
9632 pc = get2byteAligned(pCellIdx);
9633 pCellIdx -= 2;
9634 if( pc<contentOffset || pc>usableSize-4 ){
9635 checkAppendMsg(pCheck, "Offset %d out of range %d..%d",
9636 pc, contentOffset, usableSize-4);
9637 doCoverageCheck = 0;
9638 continue;
shaneh195475d2010-02-19 04:28:08 +00009639 }
drhcbc6b712015-07-02 16:17:30 +00009640 pCell = &data[pc];
9641 pPage->xParseCell(pPage, pCell, &info);
9642 if( pc+info.nSize>usableSize ){
9643 checkAppendMsg(pCheck, "Extends off end of page");
9644 doCoverageCheck = 0;
9645 continue;
drh5eddca62001-06-30 21:53:53 +00009646 }
9647
drhcbc6b712015-07-02 16:17:30 +00009648 /* Check for integer primary key out of range */
9649 if( pPage->intKey ){
9650 if( keyCanBeEqual ? (info.nKey > maxKey) : (info.nKey >= maxKey) ){
9651 checkAppendMsg(pCheck, "Rowid %lld out of order", info.nKey);
9652 }
9653 maxKey = info.nKey;
dan4b2667c2017-05-01 18:24:01 +00009654 keyCanBeEqual = 0; /* Only the first key on the page may ==maxKey */
drhcbc6b712015-07-02 16:17:30 +00009655 }
9656
9657 /* Check the content overflow list */
9658 if( info.nPayload>info.nLocal ){
9659 int nPage; /* Number of pages on the overflow chain */
9660 Pgno pgnoOvfl; /* First page of the overflow chain */
drh45ac1c72015-12-18 03:59:16 +00009661 assert( pc + info.nSize - 4 <= usableSize );
drhcbc6b712015-07-02 16:17:30 +00009662 nPage = (info.nPayload - info.nLocal + usableSize - 5)/(usableSize - 4);
drh45ac1c72015-12-18 03:59:16 +00009663 pgnoOvfl = get4byte(&pCell[info.nSize - 4]);
drhda200cc2004-05-09 11:51:38 +00009664#ifndef SQLITE_OMIT_AUTOVACUUM
9665 if( pBt->autoVacuum ){
drh867db832014-09-26 02:41:05 +00009666 checkPtrmap(pCheck, pgnoOvfl, PTRMAP_OVERFLOW1, iPage);
drhda200cc2004-05-09 11:51:38 +00009667 }
9668#endif
drh867db832014-09-26 02:41:05 +00009669 checkList(pCheck, 0, pgnoOvfl, nPage);
drh5eddca62001-06-30 21:53:53 +00009670 }
9671
drh5eddca62001-06-30 21:53:53 +00009672 if( !pPage->leaf ){
drhcbc6b712015-07-02 16:17:30 +00009673 /* Check sanity of left child page for internal pages */
drh43605152004-05-29 21:46:49 +00009674 pgno = get4byte(pCell);
danielk1977afcdd022004-10-31 16:25:42 +00009675#ifndef SQLITE_OMIT_AUTOVACUUM
9676 if( pBt->autoVacuum ){
drh867db832014-09-26 02:41:05 +00009677 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage);
danielk1977afcdd022004-10-31 16:25:42 +00009678 }
9679#endif
drhcbc6b712015-07-02 16:17:30 +00009680 d2 = checkTreePage(pCheck, pgno, &maxKey, maxKey);
9681 keyCanBeEqual = 0;
9682 if( d2!=depth ){
drh867db832014-09-26 02:41:05 +00009683 checkAppendMsg(pCheck, "Child page depth differs");
drhcbc6b712015-07-02 16:17:30 +00009684 depth = d2;
drh5eddca62001-06-30 21:53:53 +00009685 }
drhcbc6b712015-07-02 16:17:30 +00009686 }else{
9687 /* Populate the coverage-checking heap for leaf pages */
9688 btreeHeapInsert(heap, (pc<<16)|(pc+info.nSize-1));
drh5eddca62001-06-30 21:53:53 +00009689 }
9690 }
drhcbc6b712015-07-02 16:17:30 +00009691 *piMinKey = maxKey;
shaneh195475d2010-02-19 04:28:08 +00009692
drh5eddca62001-06-30 21:53:53 +00009693 /* Check for complete coverage of the page
9694 */
drh867db832014-09-26 02:41:05 +00009695 pCheck->zPfx = 0;
drhcbc6b712015-07-02 16:17:30 +00009696 if( doCoverageCheck && pCheck->mxErr>0 ){
9697 /* For leaf pages, the min-heap has already been initialized and the
9698 ** cells have already been inserted. But for internal pages, that has
9699 ** not yet been done, so do it now */
9700 if( !pPage->leaf ){
9701 heap = pCheck->heap;
9702 heap[0] = 0;
drhcbc6b712015-07-02 16:17:30 +00009703 for(i=nCell-1; i>=0; i--){
drh1910def2015-07-02 16:29:56 +00009704 u32 size;
9705 pc = get2byteAligned(&data[cellStart+i*2]);
9706 size = pPage->xCellSize(pPage, &data[pc]);
drh67731a92015-04-16 11:56:03 +00009707 btreeHeapInsert(heap, (pc<<16)|(pc+size-1));
danielk19777701e812005-01-10 12:59:51 +00009708 }
drh2e38c322004-09-03 18:38:44 +00009709 }
drhcbc6b712015-07-02 16:17:30 +00009710 /* Add the freeblocks to the min-heap
9711 **
9712 ** EVIDENCE-OF: R-20690-50594 The second field of the b-tree page header
drhfdab0262014-11-20 15:30:50 +00009713 ** is the offset of the first freeblock, or zero if there are no
drhcbc6b712015-07-02 16:17:30 +00009714 ** freeblocks on the page.
9715 */
drh8c2bbb62009-07-10 02:52:20 +00009716 i = get2byte(&data[hdr+1]);
9717 while( i>0 ){
9718 int size, j;
mistachkinc29cbb02015-07-02 16:52:01 +00009719 assert( (u32)i<=usableSize-4 ); /* Enforced by btreeInitPage() */
drh8c2bbb62009-07-10 02:52:20 +00009720 size = get2byte(&data[i+2]);
mistachkinc29cbb02015-07-02 16:52:01 +00009721 assert( (u32)(i+size)<=usableSize ); /* Enforced by btreeInitPage() */
drhe56d4302015-07-08 01:22:52 +00009722 btreeHeapInsert(heap, (((u32)i)<<16)|(i+size-1));
drhfdab0262014-11-20 15:30:50 +00009723 /* EVIDENCE-OF: R-58208-19414 The first 2 bytes of a freeblock are a
9724 ** big-endian integer which is the offset in the b-tree page of the next
9725 ** freeblock in the chain, or zero if the freeblock is the last on the
9726 ** chain. */
drh8c2bbb62009-07-10 02:52:20 +00009727 j = get2byte(&data[i]);
drhfdab0262014-11-20 15:30:50 +00009728 /* EVIDENCE-OF: R-06866-39125 Freeblocks are always connected in order of
9729 ** increasing offset. */
drh8c2bbb62009-07-10 02:52:20 +00009730 assert( j==0 || j>i+size ); /* Enforced by btreeInitPage() */
mistachkinc29cbb02015-07-02 16:52:01 +00009731 assert( (u32)j<=usableSize-4 ); /* Enforced by btreeInitPage() */
drh8c2bbb62009-07-10 02:52:20 +00009732 i = j;
drh2e38c322004-09-03 18:38:44 +00009733 }
drhcbc6b712015-07-02 16:17:30 +00009734 /* Analyze the min-heap looking for overlap between cells and/or
9735 ** freeblocks, and counting the number of untracked bytes in nFrag.
drhd2dc87f2015-07-02 19:47:08 +00009736 **
9737 ** Each min-heap entry is of the form: (start_address<<16)|end_address.
9738 ** There is an implied first entry the covers the page header, the cell
9739 ** pointer index, and the gap between the cell pointer index and the start
9740 ** of cell content.
9741 **
9742 ** The loop below pulls entries from the min-heap in order and compares
9743 ** the start_address against the previous end_address. If there is an
9744 ** overlap, that means bytes are used multiple times. If there is a gap,
9745 ** that gap is added to the fragmentation count.
drhcbc6b712015-07-02 16:17:30 +00009746 */
9747 nFrag = 0;
drhd2dc87f2015-07-02 19:47:08 +00009748 prev = contentOffset - 1; /* Implied first min-heap entry */
drh67731a92015-04-16 11:56:03 +00009749 while( btreeHeapPull(heap,&x) ){
drhd2dc87f2015-07-02 19:47:08 +00009750 if( (prev&0xffff)>=(x>>16) ){
drh867db832014-09-26 02:41:05 +00009751 checkAppendMsg(pCheck,
drh67731a92015-04-16 11:56:03 +00009752 "Multiple uses for byte %u of page %d", x>>16, iPage);
drh2e38c322004-09-03 18:38:44 +00009753 break;
drh67731a92015-04-16 11:56:03 +00009754 }else{
drhcbc6b712015-07-02 16:17:30 +00009755 nFrag += (x>>16) - (prev&0xffff) - 1;
drh67731a92015-04-16 11:56:03 +00009756 prev = x;
drh2e38c322004-09-03 18:38:44 +00009757 }
9758 }
drhcbc6b712015-07-02 16:17:30 +00009759 nFrag += usableSize - (prev&0xffff) - 1;
drhfdab0262014-11-20 15:30:50 +00009760 /* EVIDENCE-OF: R-43263-13491 The total number of bytes in all fragments
9761 ** is stored in the fifth field of the b-tree page header.
9762 ** EVIDENCE-OF: R-07161-27322 The one-byte integer at offset 7 gives the
9763 ** number of fragmented free bytes within the cell content area.
9764 */
drhcbc6b712015-07-02 16:17:30 +00009765 if( heap[0]==0 && nFrag!=data[hdr+7] ){
drh867db832014-09-26 02:41:05 +00009766 checkAppendMsg(pCheck,
drh8c2bbb62009-07-10 02:52:20 +00009767 "Fragmentation of %d bytes reported as %d on page %d",
drhcbc6b712015-07-02 16:17:30 +00009768 nFrag, data[hdr+7], iPage);
drh5eddca62001-06-30 21:53:53 +00009769 }
9770 }
drh867db832014-09-26 02:41:05 +00009771
9772end_of_check:
drh72e191e2015-07-04 11:14:20 +00009773 if( !doCoverageCheck ) pPage->isInit = savedIsInit;
drh4b70f112004-05-02 21:12:19 +00009774 releasePage(pPage);
drh867db832014-09-26 02:41:05 +00009775 pCheck->zPfx = saved_zPfx;
9776 pCheck->v1 = saved_v1;
9777 pCheck->v2 = saved_v2;
drhda200cc2004-05-09 11:51:38 +00009778 return depth+1;
drh5eddca62001-06-30 21:53:53 +00009779}
drhb7f91642004-10-31 02:22:47 +00009780#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00009781
drhb7f91642004-10-31 02:22:47 +00009782#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00009783/*
9784** This routine does a complete check of the given BTree file. aRoot[] is
9785** an array of pages numbers were each page number is the root page of
9786** a table. nRoot is the number of entries in aRoot.
9787**
danielk19773509a652009-07-06 18:56:13 +00009788** A read-only or read-write transaction must be opened before calling
9789** this function.
9790**
drhc890fec2008-08-01 20:10:08 +00009791** Write the number of error seen in *pnErr. Except for some memory
drhe43ba702008-12-05 22:40:08 +00009792** allocation errors, an error message held in memory obtained from
drhc890fec2008-08-01 20:10:08 +00009793** malloc is returned if *pnErr is non-zero. If *pnErr==0 then NULL is
drhe43ba702008-12-05 22:40:08 +00009794** returned. If a memory allocation error occurs, NULL is returned.
drh5eddca62001-06-30 21:53:53 +00009795*/
drh1dcdbc02007-01-27 02:24:54 +00009796char *sqlite3BtreeIntegrityCheck(
9797 Btree *p, /* The btree to be checked */
9798 int *aRoot, /* An array of root pages numbers for individual trees */
9799 int nRoot, /* Number of entries in aRoot[] */
9800 int mxErr, /* Stop reporting errors after this many */
9801 int *pnErr /* Write number of errors seen to this variable */
9802){
danielk197789d40042008-11-17 14:20:56 +00009803 Pgno i;
drhaaab5722002-02-19 13:39:21 +00009804 IntegrityCk sCheck;
danielk1977aef0bf62005-12-30 16:28:01 +00009805 BtShared *pBt = p->pBt;
drhcbc6b712015-07-02 16:17:30 +00009806 int savedDbFlags = pBt->db->flags;
drhf089aa42008-07-08 19:34:06 +00009807 char zErr[100];
drhcbc6b712015-07-02 16:17:30 +00009808 VVA_ONLY( int nRef );
drh5eddca62001-06-30 21:53:53 +00009809
drhd677b3d2007-08-20 22:48:41 +00009810 sqlite3BtreeEnter(p);
danielk19773509a652009-07-06 18:56:13 +00009811 assert( p->inTrans>TRANS_NONE && pBt->inTransaction>TRANS_NONE );
drhcc5f8a42016-02-06 22:32:06 +00009812 VVA_ONLY( nRef = sqlite3PagerRefcount(pBt->pPager) );
9813 assert( nRef>=0 );
drh5eddca62001-06-30 21:53:53 +00009814 sCheck.pBt = pBt;
9815 sCheck.pPager = pBt->pPager;
drhb1299152010-03-30 22:58:33 +00009816 sCheck.nPage = btreePagecount(sCheck.pBt);
drh1dcdbc02007-01-27 02:24:54 +00009817 sCheck.mxErr = mxErr;
9818 sCheck.nErr = 0;
drhc890fec2008-08-01 20:10:08 +00009819 sCheck.mallocFailed = 0;
drh867db832014-09-26 02:41:05 +00009820 sCheck.zPfx = 0;
9821 sCheck.v1 = 0;
9822 sCheck.v2 = 0;
drhe05b3f82015-07-01 17:53:49 +00009823 sCheck.aPgRef = 0;
9824 sCheck.heap = 0;
9825 sqlite3StrAccumInit(&sCheck.errMsg, 0, zErr, sizeof(zErr), SQLITE_MAX_LENGTH);
drh5f4a6862016-01-30 12:50:25 +00009826 sCheck.errMsg.printfFlags = SQLITE_PRINTF_INTERNAL;
drh0de8c112002-07-06 16:32:14 +00009827 if( sCheck.nPage==0 ){
drhe05b3f82015-07-01 17:53:49 +00009828 goto integrity_ck_cleanup;
drh0de8c112002-07-06 16:32:14 +00009829 }
dan1235bb12012-04-03 17:43:28 +00009830
9831 sCheck.aPgRef = sqlite3MallocZero((sCheck.nPage / 8)+ 1);
9832 if( !sCheck.aPgRef ){
drhe05b3f82015-07-01 17:53:49 +00009833 sCheck.mallocFailed = 1;
9834 goto integrity_ck_cleanup;
danielk1977ac245ec2005-01-14 13:50:11 +00009835 }
drhe05b3f82015-07-01 17:53:49 +00009836 sCheck.heap = (u32*)sqlite3PageMalloc( pBt->pageSize );
9837 if( sCheck.heap==0 ){
9838 sCheck.mallocFailed = 1;
9839 goto integrity_ck_cleanup;
9840 }
9841
drh42cac6d2004-11-20 20:31:11 +00009842 i = PENDING_BYTE_PAGE(pBt);
dan1235bb12012-04-03 17:43:28 +00009843 if( i<=sCheck.nPage ) setPageReferenced(&sCheck, i);
drh5eddca62001-06-30 21:53:53 +00009844
9845 /* Check the integrity of the freelist
9846 */
drh867db832014-09-26 02:41:05 +00009847 sCheck.zPfx = "Main freelist: ";
drha34b6762004-05-07 13:30:42 +00009848 checkList(&sCheck, 1, get4byte(&pBt->pPage1->aData[32]),
drh867db832014-09-26 02:41:05 +00009849 get4byte(&pBt->pPage1->aData[36]));
9850 sCheck.zPfx = 0;
drh5eddca62001-06-30 21:53:53 +00009851
9852 /* Check all the tables.
9853 */
drh040d77a2018-07-20 15:44:09 +00009854#ifndef SQLITE_OMIT_AUTOVACUUM
9855 if( pBt->autoVacuum ){
9856 int mx = 0;
9857 int mxInHdr;
9858 for(i=0; (int)i<nRoot; i++) if( mx<aRoot[i] ) mx = aRoot[i];
9859 mxInHdr = get4byte(&pBt->pPage1->aData[52]);
9860 if( mx!=mxInHdr ){
9861 checkAppendMsg(&sCheck,
9862 "max rootpage (%d) disagrees with header (%d)",
9863 mx, mxInHdr
9864 );
9865 }
9866 }else if( get4byte(&pBt->pPage1->aData[64])!=0 ){
9867 checkAppendMsg(&sCheck,
9868 "incremental_vacuum enabled with a max rootpage of zero"
9869 );
9870 }
9871#endif
drhcbc6b712015-07-02 16:17:30 +00009872 testcase( pBt->db->flags & SQLITE_CellSizeCk );
drhd5b44d62018-12-06 17:06:02 +00009873 pBt->db->flags &= ~(u64)SQLITE_CellSizeCk;
danielk197789d40042008-11-17 14:20:56 +00009874 for(i=0; (int)i<nRoot && sCheck.mxErr; i++){
drhcbc6b712015-07-02 16:17:30 +00009875 i64 notUsed;
drh4ff6dfa2002-03-03 23:06:00 +00009876 if( aRoot[i]==0 ) continue;
danielk1977687566d2004-11-02 12:56:41 +00009877#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00009878 if( pBt->autoVacuum && aRoot[i]>1 ){
drh867db832014-09-26 02:41:05 +00009879 checkPtrmap(&sCheck, aRoot[i], PTRMAP_ROOTPAGE, 0);
danielk1977687566d2004-11-02 12:56:41 +00009880 }
9881#endif
drhcbc6b712015-07-02 16:17:30 +00009882 checkTreePage(&sCheck, aRoot[i], &notUsed, LARGEST_INT64);
drh5eddca62001-06-30 21:53:53 +00009883 }
drhcbc6b712015-07-02 16:17:30 +00009884 pBt->db->flags = savedDbFlags;
drh5eddca62001-06-30 21:53:53 +00009885
9886 /* Make sure every page in the file is referenced
9887 */
drh1dcdbc02007-01-27 02:24:54 +00009888 for(i=1; i<=sCheck.nPage && sCheck.mxErr; i++){
danielk1977afcdd022004-10-31 16:25:42 +00009889#ifdef SQLITE_OMIT_AUTOVACUUM
dan1235bb12012-04-03 17:43:28 +00009890 if( getPageReferenced(&sCheck, i)==0 ){
drh867db832014-09-26 02:41:05 +00009891 checkAppendMsg(&sCheck, "Page %d is never used", i);
drh5eddca62001-06-30 21:53:53 +00009892 }
danielk1977afcdd022004-10-31 16:25:42 +00009893#else
9894 /* If the database supports auto-vacuum, make sure no tables contain
9895 ** references to pointer-map pages.
9896 */
dan1235bb12012-04-03 17:43:28 +00009897 if( getPageReferenced(&sCheck, i)==0 &&
danielk1977266664d2006-02-10 08:24:21 +00009898 (PTRMAP_PAGENO(pBt, i)!=i || !pBt->autoVacuum) ){
drh867db832014-09-26 02:41:05 +00009899 checkAppendMsg(&sCheck, "Page %d is never used", i);
danielk1977afcdd022004-10-31 16:25:42 +00009900 }
dan1235bb12012-04-03 17:43:28 +00009901 if( getPageReferenced(&sCheck, i)!=0 &&
danielk1977266664d2006-02-10 08:24:21 +00009902 (PTRMAP_PAGENO(pBt, i)==i && pBt->autoVacuum) ){
drh867db832014-09-26 02:41:05 +00009903 checkAppendMsg(&sCheck, "Pointer map page %d is referenced", i);
danielk1977afcdd022004-10-31 16:25:42 +00009904 }
9905#endif
drh5eddca62001-06-30 21:53:53 +00009906 }
9907
drh5eddca62001-06-30 21:53:53 +00009908 /* Clean up and report errors.
9909 */
drhe05b3f82015-07-01 17:53:49 +00009910integrity_ck_cleanup:
9911 sqlite3PageFree(sCheck.heap);
dan1235bb12012-04-03 17:43:28 +00009912 sqlite3_free(sCheck.aPgRef);
drhc890fec2008-08-01 20:10:08 +00009913 if( sCheck.mallocFailed ){
drh0cdbe1a2018-05-09 13:46:26 +00009914 sqlite3_str_reset(&sCheck.errMsg);
drhe05b3f82015-07-01 17:53:49 +00009915 sCheck.nErr++;
drhc890fec2008-08-01 20:10:08 +00009916 }
drh1dcdbc02007-01-27 02:24:54 +00009917 *pnErr = sCheck.nErr;
drh0cdbe1a2018-05-09 13:46:26 +00009918 if( sCheck.nErr==0 ) sqlite3_str_reset(&sCheck.errMsg);
drhe05b3f82015-07-01 17:53:49 +00009919 /* Make sure this analysis did not leave any unref() pages. */
9920 assert( nRef==sqlite3PagerRefcount(pBt->pPager) );
9921 sqlite3BtreeLeave(p);
drhf089aa42008-07-08 19:34:06 +00009922 return sqlite3StrAccumFinish(&sCheck.errMsg);
drh5eddca62001-06-30 21:53:53 +00009923}
drhb7f91642004-10-31 02:22:47 +00009924#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
paulb95a8862003-04-01 21:16:41 +00009925
drh73509ee2003-04-06 20:44:45 +00009926/*
drhd4e0bb02012-05-27 01:19:04 +00009927** Return the full pathname of the underlying database file. Return
9928** an empty string if the database is in-memory or a TEMP database.
drhd0679ed2007-08-28 22:24:34 +00009929**
9930** The pager filename is invariant as long as the pager is
9931** open so it is safe to access without the BtShared mutex.
drh73509ee2003-04-06 20:44:45 +00009932*/
danielk1977aef0bf62005-12-30 16:28:01 +00009933const char *sqlite3BtreeGetFilename(Btree *p){
9934 assert( p->pBt->pPager!=0 );
drhd4e0bb02012-05-27 01:19:04 +00009935 return sqlite3PagerFilename(p->pBt->pPager, 1);
drh73509ee2003-04-06 20:44:45 +00009936}
9937
9938/*
danielk19775865e3d2004-06-14 06:03:57 +00009939** Return the pathname of the journal file for this database. The return
9940** value of this routine is the same regardless of whether the journal file
9941** has been created or not.
drhd0679ed2007-08-28 22:24:34 +00009942**
9943** The pager journal filename is invariant as long as the pager is
9944** open so it is safe to access without the BtShared mutex.
danielk19775865e3d2004-06-14 06:03:57 +00009945*/
danielk1977aef0bf62005-12-30 16:28:01 +00009946const char *sqlite3BtreeGetJournalname(Btree *p){
9947 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00009948 return sqlite3PagerJournalname(p->pBt->pPager);
danielk19775865e3d2004-06-14 06:03:57 +00009949}
9950
danielk19771d850a72004-05-31 08:26:49 +00009951/*
9952** Return non-zero if a transaction is active.
9953*/
danielk1977aef0bf62005-12-30 16:28:01 +00009954int sqlite3BtreeIsInTrans(Btree *p){
drhe5fe6902007-12-07 18:55:28 +00009955 assert( p==0 || sqlite3_mutex_held(p->db->mutex) );
danielk1977aef0bf62005-12-30 16:28:01 +00009956 return (p && (p->inTrans==TRANS_WRITE));
danielk19771d850a72004-05-31 08:26:49 +00009957}
9958
dana550f2d2010-08-02 10:47:05 +00009959#ifndef SQLITE_OMIT_WAL
9960/*
9961** Run a checkpoint on the Btree passed as the first argument.
9962**
9963** Return SQLITE_LOCKED if this or any other connection has an open
9964** transaction on the shared-cache the argument Btree is connected to.
dana58f26f2010-11-16 18:56:51 +00009965**
dancdc1f042010-11-18 12:11:05 +00009966** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dana550f2d2010-08-02 10:47:05 +00009967*/
dancdc1f042010-11-18 12:11:05 +00009968int sqlite3BtreeCheckpoint(Btree *p, int eMode, int *pnLog, int *pnCkpt){
dana550f2d2010-08-02 10:47:05 +00009969 int rc = SQLITE_OK;
9970 if( p ){
9971 BtShared *pBt = p->pBt;
9972 sqlite3BtreeEnter(p);
9973 if( pBt->inTransaction!=TRANS_NONE ){
9974 rc = SQLITE_LOCKED;
9975 }else{
dan7fb89902016-08-12 16:21:15 +00009976 rc = sqlite3PagerCheckpoint(pBt->pPager, p->db, eMode, pnLog, pnCkpt);
dana550f2d2010-08-02 10:47:05 +00009977 }
9978 sqlite3BtreeLeave(p);
9979 }
9980 return rc;
9981}
9982#endif
9983
danielk19771d850a72004-05-31 08:26:49 +00009984/*
danielk19772372c2b2006-06-27 16:34:56 +00009985** Return non-zero if a read (or write) transaction is active.
9986*/
9987int sqlite3BtreeIsInReadTrans(Btree *p){
drh64022502009-01-09 14:11:04 +00009988 assert( p );
drhe5fe6902007-12-07 18:55:28 +00009989 assert( sqlite3_mutex_held(p->db->mutex) );
drh64022502009-01-09 14:11:04 +00009990 return p->inTrans!=TRANS_NONE;
danielk19772372c2b2006-06-27 16:34:56 +00009991}
9992
danielk197704103022009-02-03 16:51:24 +00009993int sqlite3BtreeIsInBackup(Btree *p){
9994 assert( p );
9995 assert( sqlite3_mutex_held(p->db->mutex) );
9996 return p->nBackup!=0;
9997}
9998
danielk19772372c2b2006-06-27 16:34:56 +00009999/*
danielk1977da184232006-01-05 11:34:32 +000010000** This function returns a pointer to a blob of memory associated with
drh85b623f2007-12-13 21:54:09 +000010001** a single shared-btree. The memory is used by client code for its own
danielk1977da184232006-01-05 11:34:32 +000010002** purposes (for example, to store a high-level schema associated with
10003** the shared-btree). The btree layer manages reference counting issues.
10004**
10005** The first time this is called on a shared-btree, nBytes bytes of memory
10006** are allocated, zeroed, and returned to the caller. For each subsequent
10007** call the nBytes parameter is ignored and a pointer to the same blob
10008** of memory returned.
10009**
danielk1977171bfed2008-06-23 09:50:50 +000010010** If the nBytes parameter is 0 and the blob of memory has not yet been
10011** allocated, a null pointer is returned. If the blob has already been
10012** allocated, it is returned as normal.
10013**
danielk1977da184232006-01-05 11:34:32 +000010014** Just before the shared-btree is closed, the function passed as the
10015** xFree argument when the memory allocation was made is invoked on the
drh4fa7d7c2011-04-03 02:41:00 +000010016** blob of allocated memory. The xFree function should not call sqlite3_free()
danielk1977da184232006-01-05 11:34:32 +000010017** on the memory, the btree layer does that.
10018*/
10019void *sqlite3BtreeSchema(Btree *p, int nBytes, void(*xFree)(void *)){
10020 BtShared *pBt = p->pBt;
drh27641702007-08-22 02:56:42 +000010021 sqlite3BtreeEnter(p);
danielk1977171bfed2008-06-23 09:50:50 +000010022 if( !pBt->pSchema && nBytes ){
drhb9755982010-07-24 16:34:37 +000010023 pBt->pSchema = sqlite3DbMallocZero(0, nBytes);
danielk1977da184232006-01-05 11:34:32 +000010024 pBt->xFreeSchema = xFree;
10025 }
drh27641702007-08-22 02:56:42 +000010026 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +000010027 return pBt->pSchema;
10028}
10029
danielk1977c87d34d2006-01-06 13:00:28 +000010030/*
danielk1977404ca072009-03-16 13:19:36 +000010031** Return SQLITE_LOCKED_SHAREDCACHE if another user of the same shared
10032** btree as the argument handle holds an exclusive lock on the
10033** sqlite_master table. Otherwise SQLITE_OK.
danielk1977c87d34d2006-01-06 13:00:28 +000010034*/
10035int sqlite3BtreeSchemaLocked(Btree *p){
drh27641702007-08-22 02:56:42 +000010036 int rc;
drhe5fe6902007-12-07 18:55:28 +000010037 assert( sqlite3_mutex_held(p->db->mutex) );
drh27641702007-08-22 02:56:42 +000010038 sqlite3BtreeEnter(p);
danielk1977404ca072009-03-16 13:19:36 +000010039 rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK);
10040 assert( rc==SQLITE_OK || rc==SQLITE_LOCKED_SHAREDCACHE );
drh27641702007-08-22 02:56:42 +000010041 sqlite3BtreeLeave(p);
10042 return rc;
danielk1977c87d34d2006-01-06 13:00:28 +000010043}
10044
drha154dcd2006-03-22 22:10:07 +000010045
10046#ifndef SQLITE_OMIT_SHARED_CACHE
10047/*
10048** Obtain a lock on the table whose root page is iTab. The
10049** lock is a write lock if isWritelock is true or a read lock
10050** if it is false.
10051*/
danielk1977c00da102006-01-07 13:21:04 +000010052int sqlite3BtreeLockTable(Btree *p, int iTab, u8 isWriteLock){
danielk19772e94d4d2006-01-09 05:36:27 +000010053 int rc = SQLITE_OK;
danielk1977602b4662009-07-02 07:47:33 +000010054 assert( p->inTrans!=TRANS_NONE );
drh6a9ad3d2008-04-02 16:29:30 +000010055 if( p->sharable ){
10056 u8 lockType = READ_LOCK + isWriteLock;
10057 assert( READ_LOCK+1==WRITE_LOCK );
10058 assert( isWriteLock==0 || isWriteLock==1 );
danielk1977602b4662009-07-02 07:47:33 +000010059
drh6a9ad3d2008-04-02 16:29:30 +000010060 sqlite3BtreeEnter(p);
drhc25eabe2009-02-24 18:57:31 +000010061 rc = querySharedCacheTableLock(p, iTab, lockType);
drh6a9ad3d2008-04-02 16:29:30 +000010062 if( rc==SQLITE_OK ){
drhc25eabe2009-02-24 18:57:31 +000010063 rc = setSharedCacheTableLock(p, iTab, lockType);
drh6a9ad3d2008-04-02 16:29:30 +000010064 }
10065 sqlite3BtreeLeave(p);
danielk1977c00da102006-01-07 13:21:04 +000010066 }
10067 return rc;
10068}
drha154dcd2006-03-22 22:10:07 +000010069#endif
danielk1977b82e7ed2006-01-11 14:09:31 +000010070
danielk1977b4e9af92007-05-01 17:49:49 +000010071#ifndef SQLITE_OMIT_INCRBLOB
10072/*
10073** Argument pCsr must be a cursor opened for writing on an
10074** INTKEY table currently pointing at a valid table entry.
10075** This function modifies the data stored as part of that entry.
danielk1977ecaecf92009-07-08 08:05:35 +000010076**
10077** Only the data content may only be modified, it is not possible to
10078** change the length of the data stored. If this function is called with
10079** parameters that attempt to write past the end of the existing data,
10080** no modifications are made and SQLITE_CORRUPT is returned.
danielk1977b4e9af92007-05-01 17:49:49 +000010081*/
danielk1977dcbb5d32007-05-04 18:36:44 +000010082int sqlite3BtreePutData(BtCursor *pCsr, u32 offset, u32 amt, void *z){
danielk1977c9000e62009-07-08 13:55:28 +000010083 int rc;
dan7a2347e2016-01-07 16:43:54 +000010084 assert( cursorOwnsBtShared(pCsr) );
drhe5fe6902007-12-07 18:55:28 +000010085 assert( sqlite3_mutex_held(pCsr->pBtree->db->mutex) );
drh036dbec2014-03-11 23:40:44 +000010086 assert( pCsr->curFlags & BTCF_Incrblob );
danielk19773588ceb2008-06-10 17:30:26 +000010087
danielk1977c9000e62009-07-08 13:55:28 +000010088 rc = restoreCursorPosition(pCsr);
10089 if( rc!=SQLITE_OK ){
10090 return rc;
10091 }
danielk19773588ceb2008-06-10 17:30:26 +000010092 assert( pCsr->eState!=CURSOR_REQUIRESEEK );
10093 if( pCsr->eState!=CURSOR_VALID ){
10094 return SQLITE_ABORT;
danielk1977dcbb5d32007-05-04 18:36:44 +000010095 }
10096
dan227a1c42013-04-03 11:17:39 +000010097 /* Save the positions of all other cursors open on this table. This is
10098 ** required in case any of them are holding references to an xFetch
10099 ** version of the b-tree page modified by the accessPayload call below.
drh370c9f42013-04-03 20:04:04 +000010100 **
drh3f387402014-09-24 01:23:00 +000010101 ** Note that pCsr must be open on a INTKEY table and saveCursorPosition()
drh370c9f42013-04-03 20:04:04 +000010102 ** and hence saveAllCursors() cannot fail on a BTREE_INTKEY table, hence
10103 ** saveAllCursors can only return SQLITE_OK.
dan227a1c42013-04-03 11:17:39 +000010104 */
drh370c9f42013-04-03 20:04:04 +000010105 VVA_ONLY(rc =) saveAllCursors(pCsr->pBt, pCsr->pgnoRoot, pCsr);
10106 assert( rc==SQLITE_OK );
dan227a1c42013-04-03 11:17:39 +000010107
danielk1977c9000e62009-07-08 13:55:28 +000010108 /* Check some assumptions:
danielk1977dcbb5d32007-05-04 18:36:44 +000010109 ** (a) the cursor is open for writing,
danielk1977c9000e62009-07-08 13:55:28 +000010110 ** (b) there is a read/write transaction open,
10111 ** (c) the connection holds a write-lock on the table (if required),
10112 ** (d) there are no conflicting read-locks, and
10113 ** (e) the cursor points at a valid row of an intKey table.
danielk1977d04417962007-05-02 13:16:30 +000010114 */
drh036dbec2014-03-11 23:40:44 +000010115 if( (pCsr->curFlags & BTCF_WriteFlag)==0 ){
danielk19774f029602009-07-08 18:45:37 +000010116 return SQLITE_READONLY;
10117 }
drhc9166342012-01-05 23:32:06 +000010118 assert( (pCsr->pBt->btsFlags & BTS_READ_ONLY)==0
10119 && pCsr->pBt->inTransaction==TRANS_WRITE );
danielk197796d48e92009-06-29 06:00:37 +000010120 assert( hasSharedCacheTableLock(pCsr->pBtree, pCsr->pgnoRoot, 0, 2) );
10121 assert( !hasReadConflicts(pCsr->pBtree, pCsr->pgnoRoot) );
drh352a35a2017-08-15 03:46:47 +000010122 assert( pCsr->pPage->intKey );
danielk1977b4e9af92007-05-01 17:49:49 +000010123
drhfb192682009-07-11 18:26:28 +000010124 return accessPayload(pCsr, offset, amt, (unsigned char *)z, 1);
danielk1977b4e9af92007-05-01 17:49:49 +000010125}
danielk19772dec9702007-05-02 16:48:37 +000010126
10127/*
dan5a500af2014-03-11 20:33:04 +000010128** Mark this cursor as an incremental blob cursor.
danielk19772dec9702007-05-02 16:48:37 +000010129*/
dan5a500af2014-03-11 20:33:04 +000010130void sqlite3BtreeIncrblobCursor(BtCursor *pCur){
drh036dbec2014-03-11 23:40:44 +000010131 pCur->curFlags |= BTCF_Incrblob;
drh69180952015-06-25 13:03:10 +000010132 pCur->pBtree->hasIncrblobCur = 1;
danielk19772dec9702007-05-02 16:48:37 +000010133}
danielk1977b4e9af92007-05-01 17:49:49 +000010134#endif
dane04dc882010-04-20 18:53:15 +000010135
10136/*
10137** Set both the "read version" (single byte at byte offset 18) and
10138** "write version" (single byte at byte offset 19) fields in the database
10139** header to iVersion.
10140*/
10141int sqlite3BtreeSetVersion(Btree *pBtree, int iVersion){
10142 BtShared *pBt = pBtree->pBt;
10143 int rc; /* Return code */
10144
dane04dc882010-04-20 18:53:15 +000010145 assert( iVersion==1 || iVersion==2 );
10146
danb9780022010-04-21 18:37:57 +000010147 /* If setting the version fields to 1, do not automatically open the
10148 ** WAL connection, even if the version fields are currently set to 2.
10149 */
drhc9166342012-01-05 23:32:06 +000010150 pBt->btsFlags &= ~BTS_NO_WAL;
10151 if( iVersion==1 ) pBt->btsFlags |= BTS_NO_WAL;
danb9780022010-04-21 18:37:57 +000010152
drhbb2d9b12018-06-06 16:28:40 +000010153 rc = sqlite3BtreeBeginTrans(pBtree, 0, 0);
dane04dc882010-04-20 18:53:15 +000010154 if( rc==SQLITE_OK ){
10155 u8 *aData = pBt->pPage1->aData;
danb9780022010-04-21 18:37:57 +000010156 if( aData[18]!=(u8)iVersion || aData[19]!=(u8)iVersion ){
drhbb2d9b12018-06-06 16:28:40 +000010157 rc = sqlite3BtreeBeginTrans(pBtree, 2, 0);
danb9780022010-04-21 18:37:57 +000010158 if( rc==SQLITE_OK ){
10159 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
10160 if( rc==SQLITE_OK ){
10161 aData[18] = (u8)iVersion;
10162 aData[19] = (u8)iVersion;
10163 }
10164 }
10165 }
dane04dc882010-04-20 18:53:15 +000010166 }
10167
drhc9166342012-01-05 23:32:06 +000010168 pBt->btsFlags &= ~BTS_NO_WAL;
dane04dc882010-04-20 18:53:15 +000010169 return rc;
10170}
dan428c2182012-08-06 18:50:11 +000010171
drhe0997b32015-03-20 14:57:50 +000010172/*
10173** Return true if the cursor has a hint specified. This routine is
10174** only used from within assert() statements
10175*/
10176int sqlite3BtreeCursorHasHint(BtCursor *pCsr, unsigned int mask){
10177 return (pCsr->hints & mask)!=0;
10178}
drhe0997b32015-03-20 14:57:50 +000010179
drh781597f2014-05-21 08:21:07 +000010180/*
10181** Return true if the given Btree is read-only.
10182*/
10183int sqlite3BtreeIsReadonly(Btree *p){
10184 return (p->pBt->btsFlags & BTS_READ_ONLY)!=0;
10185}
drhdef68892014-11-04 12:11:23 +000010186
10187/*
10188** Return the size of the header added to each page by this module.
10189*/
drh37c057b2014-12-30 00:57:29 +000010190int sqlite3HeaderSizeBtree(void){ return ROUND8(sizeof(MemPage)); }
dan20d876f2016-01-07 16:06:22 +000010191
drh5a1fb182016-01-08 19:34:39 +000010192#if !defined(SQLITE_OMIT_SHARED_CACHE)
dan20d876f2016-01-07 16:06:22 +000010193/*
10194** Return true if the Btree passed as the only argument is sharable.
10195*/
10196int sqlite3BtreeSharable(Btree *p){
10197 return p->sharable;
10198}
dan272989b2016-07-06 10:12:02 +000010199
10200/*
10201** Return the number of connections to the BtShared object accessed by
10202** the Btree handle passed as the only argument. For private caches
10203** this is always 1. For shared caches it may be 1 or greater.
10204*/
10205int sqlite3BtreeConnectionCount(Btree *p){
10206 testcase( p->sharable );
10207 return p->pBt->nRef;
10208}
drh5a1fb182016-01-08 19:34:39 +000010209#endif