blob: 57c556cc26a127132400ba1b907f0c1328ec1ad3 [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**
drhccb21132020-06-19 11:34:57 +000072** Access to this variable is protected by SQLITE_MUTEX_STATIC_MAIN.
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
drh37ccfcf2020-08-31 18:49:04 +0000115#ifdef SQLITE_DEBUG
116/*
drha7fc1682020-11-24 19:55:49 +0000117** Return and reset the seek counter for a Btree object.
drh37ccfcf2020-08-31 18:49:04 +0000118*/
119sqlite3_uint64 sqlite3BtreeSeekCount(Btree *pBt){
120 u64 n = pBt->nSeek;
121 pBt->nSeek = 0;
122 return n;
123}
124#endif
125
daneebf2f52017-11-18 17:30:08 +0000126/*
127** Implementation of the SQLITE_CORRUPT_PAGE() macro. Takes a single
128** (MemPage*) as an argument. The (MemPage*) must not be NULL.
129**
130** If SQLITE_DEBUG is not defined, then this macro is equivalent to
131** SQLITE_CORRUPT_BKPT. Or, if SQLITE_DEBUG is set, then the log message
132** normally produced as a side-effect of SQLITE_CORRUPT_BKPT is augmented
133** with the page number and filename associated with the (MemPage*).
134*/
135#ifdef SQLITE_DEBUG
136int corruptPageError(int lineno, MemPage *p){
drh8bfe66a2018-01-22 15:45:12 +0000137 char *zMsg;
138 sqlite3BeginBenignMalloc();
139 zMsg = sqlite3_mprintf("database corruption page %d of %s",
daneebf2f52017-11-18 17:30:08 +0000140 (int)p->pgno, sqlite3PagerFilename(p->pBt->pPager, 0)
141 );
drh8bfe66a2018-01-22 15:45:12 +0000142 sqlite3EndBenignMalloc();
daneebf2f52017-11-18 17:30:08 +0000143 if( zMsg ){
144 sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
145 }
146 sqlite3_free(zMsg);
147 return SQLITE_CORRUPT_BKPT;
148}
149# define SQLITE_CORRUPT_PAGE(pMemPage) corruptPageError(__LINE__, pMemPage)
150#else
151# define SQLITE_CORRUPT_PAGE(pMemPage) SQLITE_CORRUPT_PGNO(pMemPage->pgno)
152#endif
153
drhe53831d2007-08-17 01:14:38 +0000154#ifndef SQLITE_OMIT_SHARED_CACHE
danielk197796d48e92009-06-29 06:00:37 +0000155
156#ifdef SQLITE_DEBUG
157/*
drh0ee3dbe2009-10-16 15:05:18 +0000158**** This function is only used as part of an assert() statement. ***
159**
160** Check to see if pBtree holds the required locks to read or write to the
161** table with root page iRoot. Return 1 if it does and 0 if not.
162**
163** For example, when writing to a table with root-page iRoot via
danielk197796d48e92009-06-29 06:00:37 +0000164** Btree connection pBtree:
165**
166** assert( hasSharedCacheTableLock(pBtree, iRoot, 0, WRITE_LOCK) );
167**
drh0ee3dbe2009-10-16 15:05:18 +0000168** When writing to an index that resides in a sharable database, the
danielk197796d48e92009-06-29 06:00:37 +0000169** caller should have first obtained a lock specifying the root page of
drh0ee3dbe2009-10-16 15:05:18 +0000170** the corresponding table. This makes things a bit more complicated,
171** as this module treats each table as a separate structure. To determine
172** the table corresponding to the index being written, this
danielk197796d48e92009-06-29 06:00:37 +0000173** function has to search through the database schema.
174**
drh0ee3dbe2009-10-16 15:05:18 +0000175** Instead of a lock on the table/index rooted at page iRoot, the caller may
danielk197796d48e92009-06-29 06:00:37 +0000176** hold a write-lock on the schema table (root page 1). This is also
177** acceptable.
178*/
179static int hasSharedCacheTableLock(
180 Btree *pBtree, /* Handle that must hold lock */
181 Pgno iRoot, /* Root page of b-tree */
182 int isIndex, /* True if iRoot is the root of an index b-tree */
183 int eLockType /* Required lock type (READ_LOCK or WRITE_LOCK) */
184){
185 Schema *pSchema = (Schema *)pBtree->pBt->pSchema;
186 Pgno iTab = 0;
187 BtLock *pLock;
188
drh0ee3dbe2009-10-16 15:05:18 +0000189 /* If this database is not shareable, or if the client is reading
danielk197796d48e92009-06-29 06:00:37 +0000190 ** and has the read-uncommitted flag set, then no lock is required.
drh0ee3dbe2009-10-16 15:05:18 +0000191 ** Return true immediately.
192 */
danielk197796d48e92009-06-29 06:00:37 +0000193 if( (pBtree->sharable==0)
drh169dd922017-06-26 13:57:49 +0000194 || (eLockType==READ_LOCK && (pBtree->db->flags & SQLITE_ReadUncommit))
danielk197796d48e92009-06-29 06:00:37 +0000195 ){
196 return 1;
197 }
198
drh0ee3dbe2009-10-16 15:05:18 +0000199 /* If the client is reading or writing an index and the schema is
200 ** not loaded, then it is too difficult to actually check to see if
201 ** the correct locks are held. So do not bother - just return true.
202 ** This case does not come up very often anyhow.
203 */
drh2c5e35f2014-08-05 11:04:21 +0000204 if( isIndex && (!pSchema || (pSchema->schemaFlags&DB_SchemaLoaded)==0) ){
drh0ee3dbe2009-10-16 15:05:18 +0000205 return 1;
206 }
207
danielk197796d48e92009-06-29 06:00:37 +0000208 /* Figure out the root-page that the lock should be held on. For table
209 ** b-trees, this is just the root page of the b-tree being read or
210 ** written. For index b-trees, it is the root page of the associated
211 ** table. */
212 if( isIndex ){
213 HashElem *p;
dan877859f2020-06-17 20:29:56 +0000214 int bSeen = 0;
danielk197796d48e92009-06-29 06:00:37 +0000215 for(p=sqliteHashFirst(&pSchema->idxHash); p; p=sqliteHashNext(p)){
216 Index *pIdx = (Index *)sqliteHashData(p);
shane5eff7cf2009-08-10 03:57:58 +0000217 if( pIdx->tnum==(int)iRoot ){
dan877859f2020-06-17 20:29:56 +0000218 if( bSeen ){
drh1ffede82015-01-30 20:59:27 +0000219 /* Two or more indexes share the same root page. There must
220 ** be imposter tables. So just return true. The assert is not
221 ** useful in that case. */
222 return 1;
223 }
shane5eff7cf2009-08-10 03:57:58 +0000224 iTab = pIdx->pTable->tnum;
dan877859f2020-06-17 20:29:56 +0000225 bSeen = 1;
danielk197796d48e92009-06-29 06:00:37 +0000226 }
227 }
228 }else{
229 iTab = iRoot;
230 }
231
232 /* Search for the required lock. Either a write-lock on root-page iTab, a
233 ** write-lock on the schema table, or (if the client is reading) a
234 ** read-lock on iTab will suffice. Return 1 if any of these are found. */
235 for(pLock=pBtree->pBt->pLock; pLock; pLock=pLock->pNext){
236 if( pLock->pBtree==pBtree
237 && (pLock->iTable==iTab || (pLock->eLock==WRITE_LOCK && pLock->iTable==1))
238 && pLock->eLock>=eLockType
239 ){
240 return 1;
241 }
242 }
243
244 /* Failed to find the required lock. */
245 return 0;
246}
drh0ee3dbe2009-10-16 15:05:18 +0000247#endif /* SQLITE_DEBUG */
danielk197796d48e92009-06-29 06:00:37 +0000248
drh0ee3dbe2009-10-16 15:05:18 +0000249#ifdef SQLITE_DEBUG
danielk197796d48e92009-06-29 06:00:37 +0000250/*
drh0ee3dbe2009-10-16 15:05:18 +0000251**** This function may be used as part of assert() statements only. ****
danielk197796d48e92009-06-29 06:00:37 +0000252**
drh0ee3dbe2009-10-16 15:05:18 +0000253** Return true if it would be illegal for pBtree to write into the
254** table or index rooted at iRoot because other shared connections are
255** simultaneously reading that same table or index.
256**
257** It is illegal for pBtree to write if some other Btree object that
258** shares the same BtShared object is currently reading or writing
259** the iRoot table. Except, if the other Btree object has the
260** read-uncommitted flag set, then it is OK for the other object to
261** have a read cursor.
262**
263** For example, before writing to any part of the table or index
264** rooted at page iRoot, one should call:
danielk197796d48e92009-06-29 06:00:37 +0000265**
266** assert( !hasReadConflicts(pBtree, iRoot) );
267*/
268static int hasReadConflicts(Btree *pBtree, Pgno iRoot){
269 BtCursor *p;
270 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
271 if( p->pgnoRoot==iRoot
272 && p->pBtree!=pBtree
drh169dd922017-06-26 13:57:49 +0000273 && 0==(p->pBtree->db->flags & SQLITE_ReadUncommit)
danielk197796d48e92009-06-29 06:00:37 +0000274 ){
275 return 1;
276 }
277 }
278 return 0;
279}
280#endif /* #ifdef SQLITE_DEBUG */
281
danielk1977da184232006-01-05 11:34:32 +0000282/*
drh0ee3dbe2009-10-16 15:05:18 +0000283** Query to see if Btree handle p may obtain a lock of type eLock
danielk1977aef0bf62005-12-30 16:28:01 +0000284** (READ_LOCK or WRITE_LOCK) on the table with root-page iTab. Return
drhc25eabe2009-02-24 18:57:31 +0000285** SQLITE_OK if the lock may be obtained (by calling
286** setSharedCacheTableLock()), or SQLITE_LOCKED if not.
danielk1977aef0bf62005-12-30 16:28:01 +0000287*/
drhc25eabe2009-02-24 18:57:31 +0000288static int querySharedCacheTableLock(Btree *p, Pgno iTab, u8 eLock){
danielk1977aef0bf62005-12-30 16:28:01 +0000289 BtShared *pBt = p->pBt;
290 BtLock *pIter;
291
drh1fee73e2007-08-29 04:00:57 +0000292 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000293 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
294 assert( p->db!=0 );
drh169dd922017-06-26 13:57:49 +0000295 assert( !(p->db->flags&SQLITE_ReadUncommit)||eLock==WRITE_LOCK||iTab==1 );
drhd677b3d2007-08-20 22:48:41 +0000296
danielk19775b413d72009-04-01 09:41:54 +0000297 /* If requesting a write-lock, then the Btree must have an open write
298 ** transaction on this file. And, obviously, for this to be so there
299 ** must be an open write transaction on the file itself.
300 */
301 assert( eLock==READ_LOCK || (p==pBt->pWriter && p->inTrans==TRANS_WRITE) );
302 assert( eLock==READ_LOCK || pBt->inTransaction==TRANS_WRITE );
303
drh0ee3dbe2009-10-16 15:05:18 +0000304 /* This routine is a no-op if the shared-cache is not enabled */
drhe53831d2007-08-17 01:14:38 +0000305 if( !p->sharable ){
danielk1977da184232006-01-05 11:34:32 +0000306 return SQLITE_OK;
307 }
308
danielk1977641b0f42007-12-21 04:47:25 +0000309 /* If some other connection is holding an exclusive lock, the
310 ** requested lock may not be obtained.
311 */
drhc9166342012-01-05 23:32:06 +0000312 if( pBt->pWriter!=p && (pBt->btsFlags & BTS_EXCLUSIVE)!=0 ){
danielk1977404ca072009-03-16 13:19:36 +0000313 sqlite3ConnectionBlocked(p->db, pBt->pWriter->db);
314 return SQLITE_LOCKED_SHAREDCACHE;
danielk1977641b0f42007-12-21 04:47:25 +0000315 }
316
danielk1977e0d9e6f2009-07-03 16:25:06 +0000317 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
318 /* The condition (pIter->eLock!=eLock) in the following if(...)
319 ** statement is a simplification of:
320 **
321 ** (eLock==WRITE_LOCK || pIter->eLock==WRITE_LOCK)
322 **
323 ** since we know that if eLock==WRITE_LOCK, then no other connection
324 ** may hold a WRITE_LOCK on any table in this file (since there can
325 ** only be a single writer).
326 */
327 assert( pIter->eLock==READ_LOCK || pIter->eLock==WRITE_LOCK );
328 assert( eLock==READ_LOCK || pIter->pBtree==p || pIter->eLock==READ_LOCK);
329 if( pIter->pBtree!=p && pIter->iTable==iTab && pIter->eLock!=eLock ){
330 sqlite3ConnectionBlocked(p->db, pIter->pBtree->db);
331 if( eLock==WRITE_LOCK ){
332 assert( p==pBt->pWriter );
drhc9166342012-01-05 23:32:06 +0000333 pBt->btsFlags |= BTS_PENDING;
danielk1977da184232006-01-05 11:34:32 +0000334 }
danielk1977e0d9e6f2009-07-03 16:25:06 +0000335 return SQLITE_LOCKED_SHAREDCACHE;
danielk1977aef0bf62005-12-30 16:28:01 +0000336 }
337 }
338 return SQLITE_OK;
339}
drhe53831d2007-08-17 01:14:38 +0000340#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000341
drhe53831d2007-08-17 01:14:38 +0000342#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000343/*
344** Add a lock on the table with root-page iTable to the shared-btree used
345** by Btree handle p. Parameter eLock must be either READ_LOCK or
346** WRITE_LOCK.
347**
danielk19779d104862009-07-09 08:27:14 +0000348** This function assumes the following:
349**
drh0ee3dbe2009-10-16 15:05:18 +0000350** (a) The specified Btree object p is connected to a sharable
351** database (one with the BtShared.sharable flag set), and
danielk19779d104862009-07-09 08:27:14 +0000352**
drh0ee3dbe2009-10-16 15:05:18 +0000353** (b) No other Btree objects hold a lock that conflicts
danielk19779d104862009-07-09 08:27:14 +0000354** with the requested lock (i.e. querySharedCacheTableLock() has
355** already been called and returned SQLITE_OK).
356**
357** SQLITE_OK is returned if the lock is added successfully. SQLITE_NOMEM
358** is returned if a malloc attempt fails.
danielk1977aef0bf62005-12-30 16:28:01 +0000359*/
drhc25eabe2009-02-24 18:57:31 +0000360static int setSharedCacheTableLock(Btree *p, Pgno iTable, u8 eLock){
danielk1977aef0bf62005-12-30 16:28:01 +0000361 BtShared *pBt = p->pBt;
362 BtLock *pLock = 0;
363 BtLock *pIter;
364
drh1fee73e2007-08-29 04:00:57 +0000365 assert( sqlite3BtreeHoldsMutex(p) );
drhfa67c3c2008-07-11 02:21:40 +0000366 assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
367 assert( p->db!=0 );
drhd677b3d2007-08-20 22:48:41 +0000368
danielk1977e0d9e6f2009-07-03 16:25:06 +0000369 /* A connection with the read-uncommitted flag set will never try to
370 ** obtain a read-lock using this function. The only read-lock obtained
drh1e32bed2020-06-19 13:33:53 +0000371 ** by a connection in read-uncommitted mode is on the sqlite_schema
danielk1977e0d9e6f2009-07-03 16:25:06 +0000372 ** table, and that lock is obtained in BtreeBeginTrans(). */
drh169dd922017-06-26 13:57:49 +0000373 assert( 0==(p->db->flags&SQLITE_ReadUncommit) || eLock==WRITE_LOCK );
danielk1977e0d9e6f2009-07-03 16:25:06 +0000374
danielk19779d104862009-07-09 08:27:14 +0000375 /* This function should only be called on a sharable b-tree after it
376 ** has been determined that no other b-tree holds a conflicting lock. */
377 assert( p->sharable );
drhc25eabe2009-02-24 18:57:31 +0000378 assert( SQLITE_OK==querySharedCacheTableLock(p, iTable, eLock) );
danielk1977aef0bf62005-12-30 16:28:01 +0000379
380 /* First search the list for an existing lock on this table. */
381 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
382 if( pIter->iTable==iTable && pIter->pBtree==p ){
383 pLock = pIter;
384 break;
385 }
386 }
387
388 /* If the above search did not find a BtLock struct associating Btree p
389 ** with table iTable, allocate one and link it into the list.
390 */
391 if( !pLock ){
drh17435752007-08-16 04:30:38 +0000392 pLock = (BtLock *)sqlite3MallocZero(sizeof(BtLock));
danielk1977aef0bf62005-12-30 16:28:01 +0000393 if( !pLock ){
mistachkinfad30392016-02-13 23:43:46 +0000394 return SQLITE_NOMEM_BKPT;
danielk1977aef0bf62005-12-30 16:28:01 +0000395 }
396 pLock->iTable = iTable;
397 pLock->pBtree = p;
398 pLock->pNext = pBt->pLock;
399 pBt->pLock = pLock;
400 }
401
402 /* Set the BtLock.eLock variable to the maximum of the current lock
403 ** and the requested lock. This means if a write-lock was already held
404 ** and a read-lock requested, we don't incorrectly downgrade the lock.
405 */
406 assert( WRITE_LOCK>READ_LOCK );
danielk19775118b912005-12-30 16:31:53 +0000407 if( eLock>pLock->eLock ){
408 pLock->eLock = eLock;
409 }
danielk1977aef0bf62005-12-30 16:28:01 +0000410
411 return SQLITE_OK;
412}
drhe53831d2007-08-17 01:14:38 +0000413#endif /* !SQLITE_OMIT_SHARED_CACHE */
danielk1977aef0bf62005-12-30 16:28:01 +0000414
drhe53831d2007-08-17 01:14:38 +0000415#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977aef0bf62005-12-30 16:28:01 +0000416/*
drhc25eabe2009-02-24 18:57:31 +0000417** Release all the table locks (locks obtained via calls to
drh0ee3dbe2009-10-16 15:05:18 +0000418** the setSharedCacheTableLock() procedure) held by Btree object p.
danielk1977fa542f12009-04-02 18:28:08 +0000419**
drh0ee3dbe2009-10-16 15:05:18 +0000420** This function assumes that Btree p has an open read or write
drhc9166342012-01-05 23:32:06 +0000421** transaction. If it does not, then the BTS_PENDING flag
danielk1977fa542f12009-04-02 18:28:08 +0000422** may be incorrectly cleared.
danielk1977aef0bf62005-12-30 16:28:01 +0000423*/
drhc25eabe2009-02-24 18:57:31 +0000424static void clearAllSharedCacheTableLocks(Btree *p){
danielk1977641b0f42007-12-21 04:47:25 +0000425 BtShared *pBt = p->pBt;
426 BtLock **ppIter = &pBt->pLock;
danielk1977da184232006-01-05 11:34:32 +0000427
drh1fee73e2007-08-29 04:00:57 +0000428 assert( sqlite3BtreeHoldsMutex(p) );
drhe53831d2007-08-17 01:14:38 +0000429 assert( p->sharable || 0==*ppIter );
danielk1977fa542f12009-04-02 18:28:08 +0000430 assert( p->inTrans>0 );
danielk1977da184232006-01-05 11:34:32 +0000431
danielk1977aef0bf62005-12-30 16:28:01 +0000432 while( *ppIter ){
433 BtLock *pLock = *ppIter;
drhc9166342012-01-05 23:32:06 +0000434 assert( (pBt->btsFlags & BTS_EXCLUSIVE)==0 || pBt->pWriter==pLock->pBtree );
danielk1977fa542f12009-04-02 18:28:08 +0000435 assert( pLock->pBtree->inTrans>=pLock->eLock );
danielk1977aef0bf62005-12-30 16:28:01 +0000436 if( pLock->pBtree==p ){
437 *ppIter = pLock->pNext;
danielk1977602b4662009-07-02 07:47:33 +0000438 assert( pLock->iTable!=1 || pLock==&p->lock );
439 if( pLock->iTable!=1 ){
440 sqlite3_free(pLock);
441 }
danielk1977aef0bf62005-12-30 16:28:01 +0000442 }else{
443 ppIter = &pLock->pNext;
444 }
445 }
danielk1977641b0f42007-12-21 04:47:25 +0000446
drhc9166342012-01-05 23:32:06 +0000447 assert( (pBt->btsFlags & BTS_PENDING)==0 || pBt->pWriter );
danielk1977404ca072009-03-16 13:19:36 +0000448 if( pBt->pWriter==p ){
449 pBt->pWriter = 0;
drhc9166342012-01-05 23:32:06 +0000450 pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
danielk1977404ca072009-03-16 13:19:36 +0000451 }else if( pBt->nTransaction==2 ){
drh0ee3dbe2009-10-16 15:05:18 +0000452 /* This function is called when Btree p is concluding its
danielk1977404ca072009-03-16 13:19:36 +0000453 ** transaction. If there currently exists a writer, and p is not
454 ** that writer, then the number of locks held by connections other
455 ** than the writer must be about to drop to zero. In this case
drhc9166342012-01-05 23:32:06 +0000456 ** set the BTS_PENDING flag to 0.
danielk1977404ca072009-03-16 13:19:36 +0000457 **
drhc9166342012-01-05 23:32:06 +0000458 ** If there is not currently a writer, then BTS_PENDING must
danielk1977404ca072009-03-16 13:19:36 +0000459 ** be zero already. So this next line is harmless in that case.
460 */
drhc9166342012-01-05 23:32:06 +0000461 pBt->btsFlags &= ~BTS_PENDING;
danielk1977641b0f42007-12-21 04:47:25 +0000462 }
danielk1977aef0bf62005-12-30 16:28:01 +0000463}
danielk197794b30732009-07-02 17:21:57 +0000464
danielk1977e0d9e6f2009-07-03 16:25:06 +0000465/*
drh0ee3dbe2009-10-16 15:05:18 +0000466** This function changes all write-locks held by Btree p into read-locks.
danielk1977e0d9e6f2009-07-03 16:25:06 +0000467*/
danielk197794b30732009-07-02 17:21:57 +0000468static void downgradeAllSharedCacheTableLocks(Btree *p){
469 BtShared *pBt = p->pBt;
470 if( pBt->pWriter==p ){
471 BtLock *pLock;
472 pBt->pWriter = 0;
drhc9166342012-01-05 23:32:06 +0000473 pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
danielk197794b30732009-07-02 17:21:57 +0000474 for(pLock=pBt->pLock; pLock; pLock=pLock->pNext){
475 assert( pLock->eLock==READ_LOCK || pLock->pBtree==p );
476 pLock->eLock = READ_LOCK;
477 }
478 }
479}
480
danielk1977aef0bf62005-12-30 16:28:01 +0000481#endif /* SQLITE_OMIT_SHARED_CACHE */
482
drh3908fe92017-09-01 14:50:19 +0000483static void releasePage(MemPage *pPage); /* Forward reference */
484static void releasePageOne(MemPage *pPage); /* Forward reference */
drh352a35a2017-08-15 03:46:47 +0000485static void releasePageNotNull(MemPage *pPage); /* Forward reference */
drh980b1a72006-08-16 16:42:48 +0000486
drh1fee73e2007-08-29 04:00:57 +0000487/*
drh0ee3dbe2009-10-16 15:05:18 +0000488***** This routine is used inside of assert() only ****
489**
490** Verify that the cursor holds the mutex on its BtShared
drh1fee73e2007-08-29 04:00:57 +0000491*/
drh0ee3dbe2009-10-16 15:05:18 +0000492#ifdef SQLITE_DEBUG
drh1fee73e2007-08-29 04:00:57 +0000493static int cursorHoldsMutex(BtCursor *p){
drhff0587c2007-08-29 17:43:19 +0000494 return sqlite3_mutex_held(p->pBt->mutex);
drh1fee73e2007-08-29 04:00:57 +0000495}
drh5e08d0f2016-06-04 21:05:54 +0000496
497/* Verify that the cursor and the BtShared agree about what is the current
498** database connetion. This is important in shared-cache mode. If the database
499** connection pointers get out-of-sync, it is possible for routines like
500** btreeInitPage() to reference an stale connection pointer that references a
501** a connection that has already closed. This routine is used inside assert()
502** statements only and for the purpose of double-checking that the btree code
503** does keep the database connection pointers up-to-date.
504*/
dan7a2347e2016-01-07 16:43:54 +0000505static int cursorOwnsBtShared(BtCursor *p){
506 assert( cursorHoldsMutex(p) );
507 return (p->pBtree->db==p->pBt->db);
508}
drh1fee73e2007-08-29 04:00:57 +0000509#endif
510
danielk197792d4d7a2007-05-04 12:05:56 +0000511/*
dan5a500af2014-03-11 20:33:04 +0000512** Invalidate the overflow cache of the cursor passed as the first argument.
513** on the shared btree structure pBt.
danielk197792d4d7a2007-05-04 12:05:56 +0000514*/
drh036dbec2014-03-11 23:40:44 +0000515#define invalidateOverflowCache(pCur) (pCur->curFlags &= ~BTCF_ValidOvfl)
danielk197792d4d7a2007-05-04 12:05:56 +0000516
517/*
518** Invalidate the overflow page-list cache for all cursors opened
519** on the shared btree structure pBt.
520*/
521static void invalidateAllOverflowCache(BtShared *pBt){
522 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000523 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +0000524 for(p=pBt->pCursor; p; p=p->pNext){
525 invalidateOverflowCache(p);
526 }
527}
danielk197796d48e92009-06-29 06:00:37 +0000528
dan5a500af2014-03-11 20:33:04 +0000529#ifndef SQLITE_OMIT_INCRBLOB
danielk197796d48e92009-06-29 06:00:37 +0000530/*
531** This function is called before modifying the contents of a table
drh0ee3dbe2009-10-16 15:05:18 +0000532** to invalidate any incrblob cursors that are open on the
drheeb844a2009-08-08 18:01:07 +0000533** row or one of the rows being modified.
danielk197796d48e92009-06-29 06:00:37 +0000534**
535** If argument isClearTable is true, then the entire contents of the
536** table is about to be deleted. In this case invalidate all incrblob
537** cursors open on any row within the table with root-page pgnoRoot.
538**
539** Otherwise, if argument isClearTable is false, then the row with
540** rowid iRow is being replaced or deleted. In this case invalidate
drh0ee3dbe2009-10-16 15:05:18 +0000541** only those incrblob cursors open on that specific row.
danielk197796d48e92009-06-29 06:00:37 +0000542*/
543static void invalidateIncrblobCursors(
544 Btree *pBtree, /* The database file to check */
drh9ca431a2017-03-29 18:03:50 +0000545 Pgno pgnoRoot, /* The table that might be changing */
danielk197796d48e92009-06-29 06:00:37 +0000546 i64 iRow, /* The rowid that might be changing */
547 int isClearTable /* True if all rows are being deleted */
548){
549 BtCursor *p;
drh49bb56e2021-05-14 20:01:36 +0000550 assert( pBtree->hasIncrblobCur );
danielk197796d48e92009-06-29 06:00:37 +0000551 assert( sqlite3BtreeHoldsMutex(pBtree) );
drh69180952015-06-25 13:03:10 +0000552 pBtree->hasIncrblobCur = 0;
553 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
554 if( (p->curFlags & BTCF_Incrblob)!=0 ){
555 pBtree->hasIncrblobCur = 1;
drh9ca431a2017-03-29 18:03:50 +0000556 if( p->pgnoRoot==pgnoRoot && (isClearTable || p->info.nKey==iRow) ){
drh69180952015-06-25 13:03:10 +0000557 p->eState = CURSOR_INVALID;
558 }
danielk197796d48e92009-06-29 06:00:37 +0000559 }
560 }
561}
562
danielk197792d4d7a2007-05-04 12:05:56 +0000563#else
dan5a500af2014-03-11 20:33:04 +0000564 /* Stub function when INCRBLOB is omitted */
drh9ca431a2017-03-29 18:03:50 +0000565 #define invalidateIncrblobCursors(w,x,y,z)
drh0ee3dbe2009-10-16 15:05:18 +0000566#endif /* SQLITE_OMIT_INCRBLOB */
danielk197792d4d7a2007-05-04 12:05:56 +0000567
drh980b1a72006-08-16 16:42:48 +0000568/*
danielk1977bea2a942009-01-20 17:06:27 +0000569** Set bit pgno of the BtShared.pHasContent bitvec. This is called
570** when a page that previously contained data becomes a free-list leaf
571** page.
572**
573** The BtShared.pHasContent bitvec exists to work around an obscure
574** bug caused by the interaction of two useful IO optimizations surrounding
575** free-list leaf pages:
576**
577** 1) When all data is deleted from a page and the page becomes
578** a free-list leaf page, the page is not written to the database
579** (as free-list leaf pages contain no meaningful data). Sometimes
580** such a page is not even journalled (as it will not be modified,
581** why bother journalling it?).
582**
583** 2) When a free-list leaf page is reused, its content is not read
584** from the database or written to the journal file (why should it
585** be, if it is not at all meaningful?).
586**
587** By themselves, these optimizations work fine and provide a handy
588** performance boost to bulk delete or insert operations. However, if
589** a page is moved to the free-list and then reused within the same
590** transaction, a problem comes up. If the page is not journalled when
591** it is moved to the free-list and it is also not journalled when it
592** is extracted from the free-list and reused, then the original data
593** may be lost. In the event of a rollback, it may not be possible
594** to restore the database to its original configuration.
595**
596** The solution is the BtShared.pHasContent bitvec. Whenever a page is
597** moved to become a free-list leaf page, the corresponding bit is
598** set in the bitvec. Whenever a leaf page is extracted from the free-list,
drh0ee3dbe2009-10-16 15:05:18 +0000599** optimization 2 above is omitted if the corresponding bit is already
danielk1977bea2a942009-01-20 17:06:27 +0000600** set in BtShared.pHasContent. The contents of the bitvec are cleared
601** at the end of every transaction.
602*/
603static int btreeSetHasContent(BtShared *pBt, Pgno pgno){
604 int rc = SQLITE_OK;
605 if( !pBt->pHasContent ){
drhdd3cd972010-03-27 17:12:36 +0000606 assert( pgno<=pBt->nPage );
607 pBt->pHasContent = sqlite3BitvecCreate(pBt->nPage);
drh4c301aa2009-07-15 17:25:45 +0000608 if( !pBt->pHasContent ){
mistachkinfad30392016-02-13 23:43:46 +0000609 rc = SQLITE_NOMEM_BKPT;
danielk1977bea2a942009-01-20 17:06:27 +0000610 }
611 }
612 if( rc==SQLITE_OK && pgno<=sqlite3BitvecSize(pBt->pHasContent) ){
613 rc = sqlite3BitvecSet(pBt->pHasContent, pgno);
614 }
615 return rc;
616}
617
618/*
619** Query the BtShared.pHasContent vector.
620**
621** This function is called when a free-list leaf page is removed from the
622** free-list for reuse. It returns false if it is safe to retrieve the
623** page from the pager layer with the 'no-content' flag set. True otherwise.
624*/
625static int btreeGetHasContent(BtShared *pBt, Pgno pgno){
626 Bitvec *p = pBt->pHasContent;
pdrdb9cb172020-03-08 13:33:58 +0000627 return p && (pgno>sqlite3BitvecSize(p) || sqlite3BitvecTestNotNull(p, pgno));
danielk1977bea2a942009-01-20 17:06:27 +0000628}
629
630/*
631** Clear (destroy) the BtShared.pHasContent bitvec. This should be
632** invoked at the conclusion of each write-transaction.
633*/
634static void btreeClearHasContent(BtShared *pBt){
635 sqlite3BitvecDestroy(pBt->pHasContent);
636 pBt->pHasContent = 0;
637}
638
639/*
drh138eeeb2013-03-27 03:15:23 +0000640** Release all of the apPage[] pages for a cursor.
641*/
642static void btreeReleaseAllCursorPages(BtCursor *pCur){
643 int i;
drh352a35a2017-08-15 03:46:47 +0000644 if( pCur->iPage>=0 ){
645 for(i=0; i<pCur->iPage; i++){
646 releasePageNotNull(pCur->apPage[i]);
647 }
648 releasePageNotNull(pCur->pPage);
649 pCur->iPage = -1;
drh138eeeb2013-03-27 03:15:23 +0000650 }
drh138eeeb2013-03-27 03:15:23 +0000651}
652
danf0ee1d32015-09-12 19:26:11 +0000653/*
654** The cursor passed as the only argument must point to a valid entry
655** when this function is called (i.e. have eState==CURSOR_VALID). This
656** function saves the current cursor key in variables pCur->nKey and
657** pCur->pKey. SQLITE_OK is returned if successful or an SQLite error
658** code otherwise.
659**
660** If the cursor is open on an intkey table, then the integer key
661** (the rowid) is stored in pCur->nKey and pCur->pKey is left set to
662** NULL. If the cursor is open on a non-intkey table, then pCur->pKey is
663** set to point to a malloced buffer pCur->nKey bytes in size containing
664** the key.
665*/
666static int saveCursorKey(BtCursor *pCur){
drha7c90c42016-06-04 20:37:10 +0000667 int rc = SQLITE_OK;
danf0ee1d32015-09-12 19:26:11 +0000668 assert( CURSOR_VALID==pCur->eState );
669 assert( 0==pCur->pKey );
670 assert( cursorHoldsMutex(pCur) );
671
drha7c90c42016-06-04 20:37:10 +0000672 if( pCur->curIntKey ){
673 /* Only the rowid is required for a table btree */
674 pCur->nKey = sqlite3BtreeIntegerKey(pCur);
675 }else{
danfffaf232018-12-14 13:18:35 +0000676 /* For an index btree, save the complete key content. It is possible
677 ** that the current key is corrupt. In that case, it is possible that
678 ** the sqlite3VdbeRecordUnpack() function may overread the buffer by
679 ** up to the size of 1 varint plus 1 8-byte value when the cursor
680 ** position is restored. Hence the 17 bytes of padding allocated
681 ** below. */
drhd66c4f82016-06-04 20:58:35 +0000682 void *pKey;
drha7c90c42016-06-04 20:37:10 +0000683 pCur->nKey = sqlite3BtreePayloadSize(pCur);
danfffaf232018-12-14 13:18:35 +0000684 pKey = sqlite3Malloc( pCur->nKey + 9 + 8 );
danf0ee1d32015-09-12 19:26:11 +0000685 if( pKey ){
drhcb3cabd2016-11-25 19:18:28 +0000686 rc = sqlite3BtreePayload(pCur, 0, (int)pCur->nKey, pKey);
danf0ee1d32015-09-12 19:26:11 +0000687 if( rc==SQLITE_OK ){
drhe6c628e2019-01-21 16:01:17 +0000688 memset(((u8*)pKey)+pCur->nKey, 0, 9+8);
danf0ee1d32015-09-12 19:26:11 +0000689 pCur->pKey = pKey;
690 }else{
691 sqlite3_free(pKey);
692 }
693 }else{
mistachkinfad30392016-02-13 23:43:46 +0000694 rc = SQLITE_NOMEM_BKPT;
danf0ee1d32015-09-12 19:26:11 +0000695 }
696 }
697 assert( !pCur->curIntKey || !pCur->pKey );
698 return rc;
699}
drh138eeeb2013-03-27 03:15:23 +0000700
701/*
drh980b1a72006-08-16 16:42:48 +0000702** Save the current cursor position in the variables BtCursor.nKey
703** and BtCursor.pKey. The cursor's state is set to CURSOR_REQUIRESEEK.
drhea8ffdf2009-07-22 00:35:23 +0000704**
705** The caller must ensure that the cursor is valid (has eState==CURSOR_VALID)
706** prior to calling this routine.
drh980b1a72006-08-16 16:42:48 +0000707*/
708static int saveCursorPosition(BtCursor *pCur){
709 int rc;
710
drhd2f83132015-03-25 17:35:01 +0000711 assert( CURSOR_VALID==pCur->eState || CURSOR_SKIPNEXT==pCur->eState );
drh980b1a72006-08-16 16:42:48 +0000712 assert( 0==pCur->pKey );
drh1fee73e2007-08-29 04:00:57 +0000713 assert( cursorHoldsMutex(pCur) );
drh980b1a72006-08-16 16:42:48 +0000714
drh7b14b652019-12-29 22:08:20 +0000715 if( pCur->curFlags & BTCF_Pinned ){
716 return SQLITE_CONSTRAINT_PINNED;
717 }
drhd2f83132015-03-25 17:35:01 +0000718 if( pCur->eState==CURSOR_SKIPNEXT ){
719 pCur->eState = CURSOR_VALID;
720 }else{
721 pCur->skipNext = 0;
722 }
drh980b1a72006-08-16 16:42:48 +0000723
danf0ee1d32015-09-12 19:26:11 +0000724 rc = saveCursorKey(pCur);
drh980b1a72006-08-16 16:42:48 +0000725 if( rc==SQLITE_OK ){
drh138eeeb2013-03-27 03:15:23 +0000726 btreeReleaseAllCursorPages(pCur);
drh980b1a72006-08-16 16:42:48 +0000727 pCur->eState = CURSOR_REQUIRESEEK;
728 }
729
dane755e102015-09-30 12:59:12 +0000730 pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl|BTCF_AtLast);
drh980b1a72006-08-16 16:42:48 +0000731 return rc;
732}
733
drh637f3d82014-08-22 22:26:07 +0000734/* Forward reference */
735static int SQLITE_NOINLINE saveCursorsOnList(BtCursor*,Pgno,BtCursor*);
736
drh980b1a72006-08-16 16:42:48 +0000737/*
drh0ee3dbe2009-10-16 15:05:18 +0000738** Save the positions of all cursors (except pExcept) that are open on
drh637f3d82014-08-22 22:26:07 +0000739** the table with root-page iRoot. "Saving the cursor position" means that
740** the location in the btree is remembered in such a way that it can be
741** moved back to the same spot after the btree has been modified. This
742** routine is called just before cursor pExcept is used to modify the
743** table, for example in BtreeDelete() or BtreeInsert().
744**
drh27fb7462015-06-30 02:47:36 +0000745** If there are two or more cursors on the same btree, then all such
746** cursors should have their BTCF_Multiple flag set. The btreeCursor()
747** routine enforces that rule. This routine only needs to be called in
748** the uncommon case when pExpect has the BTCF_Multiple flag set.
749**
750** If pExpect!=NULL and if no other cursors are found on the same root-page,
751** then the BTCF_Multiple flag on pExpect is cleared, to avoid another
752** pointless call to this routine.
753**
drh637f3d82014-08-22 22:26:07 +0000754** Implementation note: This routine merely checks to see if any cursors
755** need to be saved. It calls out to saveCursorsOnList() in the (unusual)
756** event that cursors are in need to being saved.
drh980b1a72006-08-16 16:42:48 +0000757*/
758static int saveAllCursors(BtShared *pBt, Pgno iRoot, BtCursor *pExcept){
759 BtCursor *p;
drh1fee73e2007-08-29 04:00:57 +0000760 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +0000761 assert( pExcept==0 || pExcept->pBt==pBt );
drh980b1a72006-08-16 16:42:48 +0000762 for(p=pBt->pCursor; p; p=p->pNext){
drh637f3d82014-08-22 22:26:07 +0000763 if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) ) break;
764 }
drh27fb7462015-06-30 02:47:36 +0000765 if( p ) return saveCursorsOnList(p, iRoot, pExcept);
766 if( pExcept ) pExcept->curFlags &= ~BTCF_Multiple;
767 return SQLITE_OK;
drh637f3d82014-08-22 22:26:07 +0000768}
769
770/* This helper routine to saveAllCursors does the actual work of saving
771** the cursors if and when a cursor is found that actually requires saving.
772** The common case is that no cursors need to be saved, so this routine is
773** broken out from its caller to avoid unnecessary stack pointer movement.
774*/
775static int SQLITE_NOINLINE saveCursorsOnList(
drh3f387402014-09-24 01:23:00 +0000776 BtCursor *p, /* The first cursor that needs saving */
777 Pgno iRoot, /* Only save cursor with this iRoot. Save all if zero */
778 BtCursor *pExcept /* Do not save this cursor */
drh637f3d82014-08-22 22:26:07 +0000779){
780 do{
drh138eeeb2013-03-27 03:15:23 +0000781 if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) ){
drhd2f83132015-03-25 17:35:01 +0000782 if( p->eState==CURSOR_VALID || p->eState==CURSOR_SKIPNEXT ){
drh138eeeb2013-03-27 03:15:23 +0000783 int rc = saveCursorPosition(p);
784 if( SQLITE_OK!=rc ){
785 return rc;
786 }
787 }else{
drh85ef6302017-08-02 15:50:09 +0000788 testcase( p->iPage>=0 );
drh138eeeb2013-03-27 03:15:23 +0000789 btreeReleaseAllCursorPages(p);
drh980b1a72006-08-16 16:42:48 +0000790 }
791 }
drh637f3d82014-08-22 22:26:07 +0000792 p = p->pNext;
793 }while( p );
drh980b1a72006-08-16 16:42:48 +0000794 return SQLITE_OK;
795}
796
797/*
drhbf700f32007-03-31 02:36:44 +0000798** Clear the current cursor position.
799*/
danielk1977be51a652008-10-08 17:58:48 +0000800void sqlite3BtreeClearCursor(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +0000801 assert( cursorHoldsMutex(pCur) );
drh17435752007-08-16 04:30:38 +0000802 sqlite3_free(pCur->pKey);
drhbf700f32007-03-31 02:36:44 +0000803 pCur->pKey = 0;
804 pCur->eState = CURSOR_INVALID;
805}
806
807/*
danielk19773509a652009-07-06 18:56:13 +0000808** In this version of BtreeMoveto, pKey is a packed index record
809** such as is generated by the OP_MakeRecord opcode. Unpack the
810** record and then call BtreeMovetoUnpacked() to do the work.
811*/
812static int btreeMoveto(
813 BtCursor *pCur, /* Cursor open on the btree to be searched */
814 const void *pKey, /* Packed key if the btree is an index */
815 i64 nKey, /* Integer key for tables. Size of pKey for indices */
816 int bias, /* Bias search to the high end */
817 int *pRes /* Write search results here */
818){
819 int rc; /* Status code */
820 UnpackedRecord *pIdxKey; /* Unpacked index key */
danielk19773509a652009-07-06 18:56:13 +0000821
822 if( pKey ){
danb0c4c942019-01-24 15:16:17 +0000823 KeyInfo *pKeyInfo = pCur->pKeyInfo;
danielk19773509a652009-07-06 18:56:13 +0000824 assert( nKey==(i64)(int)nKey );
danb0c4c942019-01-24 15:16:17 +0000825 pIdxKey = sqlite3VdbeAllocUnpackedRecord(pKeyInfo);
mistachkinfad30392016-02-13 23:43:46 +0000826 if( pIdxKey==0 ) return SQLITE_NOMEM_BKPT;
danb0c4c942019-01-24 15:16:17 +0000827 sqlite3VdbeRecordUnpack(pKeyInfo, (int)nKey, pKey, pIdxKey);
828 if( pIdxKey->nField==0 || pIdxKey->nField>pKeyInfo->nAllField ){
mistachkin88a79732017-09-04 19:31:54 +0000829 rc = SQLITE_CORRUPT_BKPT;
drh42a410d2021-06-19 18:32:20 +0000830 }else{
831 rc = sqlite3BtreeIndexMoveto(pCur, pIdxKey, pRes);
drh094b7582013-11-30 12:49:28 +0000832 }
drh42a410d2021-06-19 18:32:20 +0000833 sqlite3DbFree(pCur->pKeyInfo->db, pIdxKey);
danielk19773509a652009-07-06 18:56:13 +0000834 }else{
835 pIdxKey = 0;
drh42a410d2021-06-19 18:32:20 +0000836 rc = sqlite3BtreeTableMoveto(pCur, nKey, bias, pRes);
danielk19773509a652009-07-06 18:56:13 +0000837 }
838 return rc;
839}
840
841/*
drh980b1a72006-08-16 16:42:48 +0000842** Restore the cursor to the position it was in (or as close to as possible)
843** when saveCursorPosition() was called. Note that this call deletes the
844** saved position info stored by saveCursorPosition(), so there can be
drha3460582008-07-11 21:02:53 +0000845** at most one effective restoreCursorPosition() call after each
drh980b1a72006-08-16 16:42:48 +0000846** saveCursorPosition().
drh980b1a72006-08-16 16:42:48 +0000847*/
danielk197730548662009-07-09 05:07:37 +0000848static int btreeRestoreCursorPosition(BtCursor *pCur){
drhbf700f32007-03-31 02:36:44 +0000849 int rc;
mistachkin4e2d3d42019-04-01 03:07:21 +0000850 int skipNext = 0;
dan7a2347e2016-01-07 16:43:54 +0000851 assert( cursorOwnsBtShared(pCur) );
drhfb982642007-08-30 01:19:59 +0000852 assert( pCur->eState>=CURSOR_REQUIRESEEK );
853 if( pCur->eState==CURSOR_FAULT ){
drh4c301aa2009-07-15 17:25:45 +0000854 return pCur->skipNext;
drhfb982642007-08-30 01:19:59 +0000855 }
drh980b1a72006-08-16 16:42:48 +0000856 pCur->eState = CURSOR_INVALID;
drhb336d1a2019-03-30 19:17:35 +0000857 if( sqlite3FaultSim(410) ){
858 rc = SQLITE_IOERR;
859 }else{
860 rc = btreeMoveto(pCur, pCur->pKey, pCur->nKey, 0, &skipNext);
861 }
drh980b1a72006-08-16 16:42:48 +0000862 if( rc==SQLITE_OK ){
drh17435752007-08-16 04:30:38 +0000863 sqlite3_free(pCur->pKey);
drh980b1a72006-08-16 16:42:48 +0000864 pCur->pKey = 0;
drhbf700f32007-03-31 02:36:44 +0000865 assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_INVALID );
drh0c873bf2019-01-28 00:42:06 +0000866 if( skipNext ) pCur->skipNext = skipNext;
drh9b47ee32013-08-20 03:13:51 +0000867 if( pCur->skipNext && pCur->eState==CURSOR_VALID ){
868 pCur->eState = CURSOR_SKIPNEXT;
869 }
drh980b1a72006-08-16 16:42:48 +0000870 }
871 return rc;
872}
873
drha3460582008-07-11 21:02:53 +0000874#define restoreCursorPosition(p) \
drhfb982642007-08-30 01:19:59 +0000875 (p->eState>=CURSOR_REQUIRESEEK ? \
danielk197730548662009-07-09 05:07:37 +0000876 btreeRestoreCursorPosition(p) : \
drh16a9b832007-05-05 18:39:25 +0000877 SQLITE_OK)
drh980b1a72006-08-16 16:42:48 +0000878
drha3460582008-07-11 21:02:53 +0000879/*
drh6848dad2014-08-22 23:33:03 +0000880** Determine whether or not a cursor has moved from the position where
881** it was last placed, or has been invalidated for any other reason.
882** Cursors can move when the row they are pointing at is deleted out
883** from under them, for example. Cursor might also move if a btree
884** is rebalanced.
drha3460582008-07-11 21:02:53 +0000885**
drh6848dad2014-08-22 23:33:03 +0000886** Calling this routine with a NULL cursor pointer returns false.
drh86dd3712014-03-25 11:00:21 +0000887**
drh6848dad2014-08-22 23:33:03 +0000888** Use the separate sqlite3BtreeCursorRestore() routine to restore a cursor
889** back to where it ought to be if this routine returns true.
drha3460582008-07-11 21:02:53 +0000890*/
drh6848dad2014-08-22 23:33:03 +0000891int sqlite3BtreeCursorHasMoved(BtCursor *pCur){
drh5ba5f5b2018-06-02 16:32:04 +0000892 assert( EIGHT_BYTE_ALIGNMENT(pCur)
893 || pCur==sqlite3BtreeFakeValidCursor() );
894 assert( offsetof(BtCursor, eState)==0 );
895 assert( sizeof(pCur->eState)==1 );
896 return CURSOR_VALID != *(u8*)pCur;
drh6848dad2014-08-22 23:33:03 +0000897}
898
899/*
drhfe0cf7a2017-08-16 19:20:20 +0000900** Return a pointer to a fake BtCursor object that will always answer
901** false to the sqlite3BtreeCursorHasMoved() routine above. The fake
902** cursor returned must not be used with any other Btree interface.
903*/
904BtCursor *sqlite3BtreeFakeValidCursor(void){
905 static u8 fakeCursor = CURSOR_VALID;
906 assert( offsetof(BtCursor, eState)==0 );
907 return (BtCursor*)&fakeCursor;
908}
909
910/*
drh6848dad2014-08-22 23:33:03 +0000911** This routine restores a cursor back to its original position after it
912** has been moved by some outside activity (such as a btree rebalance or
913** a row having been deleted out from under the cursor).
914**
915** On success, the *pDifferentRow parameter is false if the cursor is left
916** pointing at exactly the same row. *pDifferntRow is the row the cursor
917** was pointing to has been deleted, forcing the cursor to point to some
918** nearby row.
919**
920** This routine should only be called for a cursor that just returned
921** TRUE from sqlite3BtreeCursorHasMoved().
922*/
923int sqlite3BtreeCursorRestore(BtCursor *pCur, int *pDifferentRow){
drha3460582008-07-11 21:02:53 +0000924 int rc;
925
drh6848dad2014-08-22 23:33:03 +0000926 assert( pCur!=0 );
927 assert( pCur->eState!=CURSOR_VALID );
drha3460582008-07-11 21:02:53 +0000928 rc = restoreCursorPosition(pCur);
929 if( rc ){
drh6848dad2014-08-22 23:33:03 +0000930 *pDifferentRow = 1;
drha3460582008-07-11 21:02:53 +0000931 return rc;
932 }
drh606a3572015-03-25 18:29:10 +0000933 if( pCur->eState!=CURSOR_VALID ){
drh6848dad2014-08-22 23:33:03 +0000934 *pDifferentRow = 1;
drha3460582008-07-11 21:02:53 +0000935 }else{
drh6848dad2014-08-22 23:33:03 +0000936 *pDifferentRow = 0;
drha3460582008-07-11 21:02:53 +0000937 }
938 return SQLITE_OK;
939}
940
drhf7854c72015-10-27 13:24:37 +0000941#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh28935362013-12-07 20:39:19 +0000942/*
drh0df57012015-08-14 15:05:55 +0000943** Provide hints to the cursor. The particular hint given (and the type
944** and number of the varargs parameters) is determined by the eHintType
945** parameter. See the definitions of the BTREE_HINT_* macros for details.
drh28935362013-12-07 20:39:19 +0000946*/
drh0df57012015-08-14 15:05:55 +0000947void sqlite3BtreeCursorHint(BtCursor *pCur, int eHintType, ...){
drhf7854c72015-10-27 13:24:37 +0000948 /* Used only by system that substitute their own storage engine */
drh28935362013-12-07 20:39:19 +0000949}
drhf7854c72015-10-27 13:24:37 +0000950#endif
951
952/*
953** Provide flag hints to the cursor.
954*/
955void sqlite3BtreeCursorHintFlags(BtCursor *pCur, unsigned x){
956 assert( x==BTREE_SEEK_EQ || x==BTREE_BULKLOAD || x==0 );
957 pCur->hints = x;
958}
959
drh28935362013-12-07 20:39:19 +0000960
danielk1977599fcba2004-11-08 07:13:13 +0000961#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977afcdd022004-10-31 16:25:42 +0000962/*
drha3152892007-05-05 11:48:52 +0000963** Given a page number of a regular database page, return the page
964** number for the pointer-map page that contains the entry for the
965** input page number.
drh5f77b2e2010-08-21 15:09:37 +0000966**
967** Return 0 (not a valid page) for pgno==1 since there is
968** no pointer map associated with page 1. The integrity_check logic
969** requires that ptrmapPageno(*,1)!=1.
danielk1977afcdd022004-10-31 16:25:42 +0000970*/
danielk1977266664d2006-02-10 08:24:21 +0000971static Pgno ptrmapPageno(BtShared *pBt, Pgno pgno){
danielk197789d40042008-11-17 14:20:56 +0000972 int nPagesPerMapPage;
973 Pgno iPtrMap, ret;
drh1fee73e2007-08-29 04:00:57 +0000974 assert( sqlite3_mutex_held(pBt->mutex) );
drh5f77b2e2010-08-21 15:09:37 +0000975 if( pgno<2 ) return 0;
drhd677b3d2007-08-20 22:48:41 +0000976 nPagesPerMapPage = (pBt->usableSize/5)+1;
977 iPtrMap = (pgno-2)/nPagesPerMapPage;
978 ret = (iPtrMap*nPagesPerMapPage) + 2;
danielk1977266664d2006-02-10 08:24:21 +0000979 if( ret==PENDING_BYTE_PAGE(pBt) ){
980 ret++;
981 }
982 return ret;
983}
danielk1977a19df672004-11-03 11:37:07 +0000984
danielk1977afcdd022004-10-31 16:25:42 +0000985/*
danielk1977afcdd022004-10-31 16:25:42 +0000986** Write an entry into the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000987**
988** This routine updates the pointer map entry for page number 'key'
989** so that it maps to type 'eType' and parent page number 'pgno'.
drh98add2e2009-07-20 17:11:49 +0000990**
991** If *pRC is initially non-zero (non-SQLITE_OK) then this routine is
992** a no-op. If an error occurs, the appropriate error code is written
993** into *pRC.
danielk1977afcdd022004-10-31 16:25:42 +0000994*/
drh98add2e2009-07-20 17:11:49 +0000995static void ptrmapPut(BtShared *pBt, Pgno key, u8 eType, Pgno parent, int *pRC){
danielk19773b8a05f2007-03-19 17:44:26 +0000996 DbPage *pDbPage; /* The pointer map page */
997 u8 *pPtrmap; /* The pointer map data */
998 Pgno iPtrmap; /* The pointer map page number */
999 int offset; /* Offset in pointer map page */
drh98add2e2009-07-20 17:11:49 +00001000 int rc; /* Return code from subfunctions */
1001
1002 if( *pRC ) return;
danielk1977afcdd022004-10-31 16:25:42 +00001003
drh1fee73e2007-08-29 04:00:57 +00001004 assert( sqlite3_mutex_held(pBt->mutex) );
drh067b92b2020-06-19 15:24:12 +00001005 /* The super-journal page number must never be used as a pointer map page */
danielk1977266664d2006-02-10 08:24:21 +00001006 assert( 0==PTRMAP_ISPAGE(pBt, PENDING_BYTE_PAGE(pBt)) );
1007
danielk1977ac11ee62005-01-15 12:45:51 +00001008 assert( pBt->autoVacuum );
danielk1977fdb7cdb2005-01-17 02:12:18 +00001009 if( key==0 ){
drh98add2e2009-07-20 17:11:49 +00001010 *pRC = SQLITE_CORRUPT_BKPT;
1011 return;
danielk1977fdb7cdb2005-01-17 02:12:18 +00001012 }
danielk1977266664d2006-02-10 08:24:21 +00001013 iPtrmap = PTRMAP_PAGENO(pBt, key);
drh9584f582015-11-04 20:22:37 +00001014 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage, 0);
danielk1977687566d2004-11-02 12:56:41 +00001015 if( rc!=SQLITE_OK ){
drh98add2e2009-07-20 17:11:49 +00001016 *pRC = rc;
1017 return;
danielk1977afcdd022004-10-31 16:25:42 +00001018 }
drh203b1ea2018-12-14 03:14:18 +00001019 if( ((char*)sqlite3PagerGetExtra(pDbPage))[0]!=0 ){
1020 /* The first byte of the extra data is the MemPage.isInit byte.
1021 ** If that byte is set, it means this page is also being used
1022 ** as a btree page. */
1023 *pRC = SQLITE_CORRUPT_BKPT;
1024 goto ptrmap_exit;
1025 }
danielk19778c666b12008-07-18 09:34:57 +00001026 offset = PTRMAP_PTROFFSET(iPtrmap, key);
drhacfc72b2009-06-05 18:44:15 +00001027 if( offset<0 ){
drh98add2e2009-07-20 17:11:49 +00001028 *pRC = SQLITE_CORRUPT_BKPT;
drh4925a552009-07-07 11:39:58 +00001029 goto ptrmap_exit;
drhacfc72b2009-06-05 18:44:15 +00001030 }
drhfc243732011-05-17 15:21:56 +00001031 assert( offset <= (int)pBt->usableSize-5 );
danielk19773b8a05f2007-03-19 17:44:26 +00001032 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +00001033
drh615ae552005-01-16 23:21:00 +00001034 if( eType!=pPtrmap[offset] || get4byte(&pPtrmap[offset+1])!=parent ){
1035 TRACE(("PTRMAP_UPDATE: %d->(%d,%d)\n", key, eType, parent));
drh98add2e2009-07-20 17:11:49 +00001036 *pRC= rc = sqlite3PagerWrite(pDbPage);
danielk19775558a8a2005-01-17 07:53:44 +00001037 if( rc==SQLITE_OK ){
1038 pPtrmap[offset] = eType;
1039 put4byte(&pPtrmap[offset+1], parent);
danielk1977afcdd022004-10-31 16:25:42 +00001040 }
danielk1977afcdd022004-10-31 16:25:42 +00001041 }
1042
drh4925a552009-07-07 11:39:58 +00001043ptrmap_exit:
danielk19773b8a05f2007-03-19 17:44:26 +00001044 sqlite3PagerUnref(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +00001045}
1046
1047/*
1048** Read an entry from the pointer map.
danielk1977687566d2004-11-02 12:56:41 +00001049**
1050** This routine retrieves the pointer map entry for page 'key', writing
1051** the type and parent page number to *pEType and *pPgno respectively.
1052** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +00001053*/
danielk1977aef0bf62005-12-30 16:28:01 +00001054static int ptrmapGet(BtShared *pBt, Pgno key, u8 *pEType, Pgno *pPgno){
danielk19773b8a05f2007-03-19 17:44:26 +00001055 DbPage *pDbPage; /* The pointer map page */
danielk1977afcdd022004-10-31 16:25:42 +00001056 int iPtrmap; /* Pointer map page index */
1057 u8 *pPtrmap; /* Pointer map page data */
1058 int offset; /* Offset of entry in pointer map */
1059 int rc;
1060
drh1fee73e2007-08-29 04:00:57 +00001061 assert( sqlite3_mutex_held(pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00001062
danielk1977266664d2006-02-10 08:24:21 +00001063 iPtrmap = PTRMAP_PAGENO(pBt, key);
drh9584f582015-11-04 20:22:37 +00001064 rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage, 0);
danielk1977afcdd022004-10-31 16:25:42 +00001065 if( rc!=0 ){
1066 return rc;
1067 }
danielk19773b8a05f2007-03-19 17:44:26 +00001068 pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
danielk1977afcdd022004-10-31 16:25:42 +00001069
danielk19778c666b12008-07-18 09:34:57 +00001070 offset = PTRMAP_PTROFFSET(iPtrmap, key);
drhfc243732011-05-17 15:21:56 +00001071 if( offset<0 ){
1072 sqlite3PagerUnref(pDbPage);
1073 return SQLITE_CORRUPT_BKPT;
1074 }
1075 assert( offset <= (int)pBt->usableSize-5 );
drh43617e92006-03-06 20:55:46 +00001076 assert( pEType!=0 );
1077 *pEType = pPtrmap[offset];
danielk1977687566d2004-11-02 12:56:41 +00001078 if( pPgno ) *pPgno = get4byte(&pPtrmap[offset+1]);
danielk1977afcdd022004-10-31 16:25:42 +00001079
danielk19773b8a05f2007-03-19 17:44:26 +00001080 sqlite3PagerUnref(pDbPage);
drhcc97ca42017-06-07 22:32:59 +00001081 if( *pEType<1 || *pEType>5 ) return SQLITE_CORRUPT_PGNO(iPtrmap);
danielk1977afcdd022004-10-31 16:25:42 +00001082 return SQLITE_OK;
1083}
1084
danielk197785d90ca2008-07-19 14:25:15 +00001085#else /* if defined SQLITE_OMIT_AUTOVACUUM */
drh98add2e2009-07-20 17:11:49 +00001086 #define ptrmapPut(w,x,y,z,rc)
danielk197785d90ca2008-07-19 14:25:15 +00001087 #define ptrmapGet(w,x,y,z) SQLITE_OK
drh0f1bf4c2019-01-13 20:17:21 +00001088 #define ptrmapPutOvflPtr(x, y, z, rc)
danielk197785d90ca2008-07-19 14:25:15 +00001089#endif
danielk1977afcdd022004-10-31 16:25:42 +00001090
drh0d316a42002-08-11 20:10:47 +00001091/*
drh271efa52004-05-30 19:19:05 +00001092** Given a btree page and a cell index (0 means the first cell on
1093** the page, 1 means the second cell, and so forth) return a pointer
1094** to the cell content.
1095**
drhf44890a2015-06-27 03:58:15 +00001096** findCellPastPtr() does the same except it skips past the initial
1097** 4-byte child pointer found on interior pages, if there is one.
1098**
drh271efa52004-05-30 19:19:05 +00001099** This routine works only for pages that do not contain overflow cells.
drh3aac2dd2004-04-26 14:10:20 +00001100*/
drh1688c862008-07-18 02:44:17 +00001101#define findCell(P,I) \
drh329428e2015-06-30 13:28:18 +00001102 ((P)->aData + ((P)->maskPage & get2byteAligned(&(P)->aCellIdx[2*(I)])))
drhf44890a2015-06-27 03:58:15 +00001103#define findCellPastPtr(P,I) \
drh329428e2015-06-30 13:28:18 +00001104 ((P)->aDataOfst + ((P)->maskPage & get2byteAligned(&(P)->aCellIdx[2*(I)])))
drh68f2a572011-06-03 17:50:49 +00001105
drh43605152004-05-29 21:46:49 +00001106
1107/*
drh5fa60512015-06-19 17:19:34 +00001108** This is common tail processing for btreeParseCellPtr() and
1109** btreeParseCellPtrIndex() for the case when the cell does not fit entirely
1110** on a single B-tree page. Make necessary adjustments to the CellInfo
1111** structure.
drh43605152004-05-29 21:46:49 +00001112*/
drh5fa60512015-06-19 17:19:34 +00001113static SQLITE_NOINLINE void btreeParseCellAdjustSizeForOverflow(
1114 MemPage *pPage, /* Page containing the cell */
1115 u8 *pCell, /* Pointer to the cell text. */
1116 CellInfo *pInfo /* Fill in this structure */
1117){
1118 /* If the payload will not fit completely on the local page, we have
1119 ** to decide how much to store locally and how much to spill onto
1120 ** overflow pages. The strategy is to minimize the amount of unused
1121 ** space on overflow pages while keeping the amount of local storage
1122 ** in between minLocal and maxLocal.
1123 **
1124 ** Warning: changing the way overflow payload is distributed in any
1125 ** way will result in an incompatible file format.
1126 */
1127 int minLocal; /* Minimum amount of payload held locally */
1128 int maxLocal; /* Maximum amount of payload held locally */
1129 int surplus; /* Overflow payload available for local storage */
1130
1131 minLocal = pPage->minLocal;
1132 maxLocal = pPage->maxLocal;
1133 surplus = minLocal + (pInfo->nPayload - minLocal)%(pPage->pBt->usableSize-4);
1134 testcase( surplus==maxLocal );
1135 testcase( surplus==maxLocal+1 );
1136 if( surplus <= maxLocal ){
1137 pInfo->nLocal = (u16)surplus;
1138 }else{
1139 pInfo->nLocal = (u16)minLocal;
drh43605152004-05-29 21:46:49 +00001140 }
drh45ac1c72015-12-18 03:59:16 +00001141 pInfo->nSize = (u16)(&pInfo->pPayload[pInfo->nLocal] - pCell) + 4;
drh43605152004-05-29 21:46:49 +00001142}
1143
1144/*
danebbf3682020-12-09 16:32:11 +00001145** Given a record with nPayload bytes of payload stored within btree
1146** page pPage, return the number of bytes of payload stored locally.
1147*/
dan59964b42020-12-14 15:25:14 +00001148static int btreePayloadToLocal(MemPage *pPage, i64 nPayload){
danebbf3682020-12-09 16:32:11 +00001149 int maxLocal; /* Maximum amount of payload held locally */
1150 maxLocal = pPage->maxLocal;
1151 if( nPayload<=maxLocal ){
1152 return nPayload;
1153 }else{
1154 int minLocal; /* Minimum amount of payload held locally */
1155 int surplus; /* Overflow payload available for local storage */
1156 minLocal = pPage->minLocal;
1157 surplus = minLocal + (nPayload - minLocal)%(pPage->pBt->usableSize-4);
1158 return ( surplus <= maxLocal ) ? surplus : minLocal;
1159 }
1160}
1161
1162/*
drh5fa60512015-06-19 17:19:34 +00001163** The following routines are implementations of the MemPage.xParseCell()
1164** method.
danielk19771cc5ed82007-05-16 17:28:43 +00001165**
drh5fa60512015-06-19 17:19:34 +00001166** Parse a cell content block and fill in the CellInfo structure.
1167**
1168** btreeParseCellPtr() => table btree leaf nodes
1169** btreeParseCellNoPayload() => table btree internal nodes
1170** btreeParseCellPtrIndex() => index btree nodes
1171**
1172** There is also a wrapper function btreeParseCell() that works for
1173** all MemPage types and that references the cell by index rather than
1174** by pointer.
drh43605152004-05-29 21:46:49 +00001175*/
drh5fa60512015-06-19 17:19:34 +00001176static void btreeParseCellPtrNoPayload(
1177 MemPage *pPage, /* Page containing the cell */
1178 u8 *pCell, /* Pointer to the cell text. */
1179 CellInfo *pInfo /* Fill in this structure */
1180){
1181 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
1182 assert( pPage->leaf==0 );
drh5fa60512015-06-19 17:19:34 +00001183 assert( pPage->childPtrSize==4 );
drh94a31152015-07-01 04:08:40 +00001184#ifndef SQLITE_DEBUG
1185 UNUSED_PARAMETER(pPage);
1186#endif
drh5fa60512015-06-19 17:19:34 +00001187 pInfo->nSize = 4 + getVarint(&pCell[4], (u64*)&pInfo->nKey);
1188 pInfo->nPayload = 0;
1189 pInfo->nLocal = 0;
drh5fa60512015-06-19 17:19:34 +00001190 pInfo->pPayload = 0;
1191 return;
1192}
danielk197730548662009-07-09 05:07:37 +00001193static void btreeParseCellPtr(
drh3aac2dd2004-04-26 14:10:20 +00001194 MemPage *pPage, /* Page containing the cell */
drh43605152004-05-29 21:46:49 +00001195 u8 *pCell, /* Pointer to the cell text. */
drh6f11bef2004-05-13 01:12:56 +00001196 CellInfo *pInfo /* Fill in this structure */
drh3aac2dd2004-04-26 14:10:20 +00001197){
drh3e28ff52014-09-24 00:59:08 +00001198 u8 *pIter; /* For scanning through pCell */
drh271efa52004-05-30 19:19:05 +00001199 u32 nPayload; /* Number of bytes of cell payload */
drh56cb04e2015-06-19 18:24:37 +00001200 u64 iKey; /* Extracted Key value */
drh43605152004-05-29 21:46:49 +00001201
drh1fee73e2007-08-29 04:00:57 +00001202 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhab01f612004-05-22 02:55:23 +00001203 assert( pPage->leaf==0 || pPage->leaf==1 );
drh5fa60512015-06-19 17:19:34 +00001204 assert( pPage->intKeyLeaf );
1205 assert( pPage->childPtrSize==0 );
drh56cb04e2015-06-19 18:24:37 +00001206 pIter = pCell;
1207
1208 /* The next block of code is equivalent to:
1209 **
1210 ** pIter += getVarint32(pIter, nPayload);
1211 **
1212 ** The code is inlined to avoid a function call.
1213 */
1214 nPayload = *pIter;
1215 if( nPayload>=0x80 ){
drheeab2c62015-06-19 20:08:39 +00001216 u8 *pEnd = &pIter[8];
drh56cb04e2015-06-19 18:24:37 +00001217 nPayload &= 0x7f;
1218 do{
1219 nPayload = (nPayload<<7) | (*++pIter & 0x7f);
1220 }while( (*pIter)>=0x80 && pIter<pEnd );
drh6f11bef2004-05-13 01:12:56 +00001221 }
drh56cb04e2015-06-19 18:24:37 +00001222 pIter++;
1223
1224 /* The next block of code is equivalent to:
1225 **
1226 ** pIter += getVarint(pIter, (u64*)&pInfo->nKey);
1227 **
1228 ** The code is inlined to avoid a function call.
1229 */
1230 iKey = *pIter;
1231 if( iKey>=0x80 ){
1232 u8 *pEnd = &pIter[7];
1233 iKey &= 0x7f;
1234 while(1){
1235 iKey = (iKey<<7) | (*++pIter & 0x7f);
1236 if( (*pIter)<0x80 ) break;
1237 if( pIter>=pEnd ){
1238 iKey = (iKey<<8) | *++pIter;
1239 break;
1240 }
1241 }
1242 }
1243 pIter++;
1244
1245 pInfo->nKey = *(i64*)&iKey;
drh72365832007-03-06 15:53:44 +00001246 pInfo->nPayload = nPayload;
drhab1cc582014-09-23 21:25:19 +00001247 pInfo->pPayload = pIter;
drh0a45c272009-07-08 01:49:11 +00001248 testcase( nPayload==pPage->maxLocal );
1249 testcase( nPayload==pPage->maxLocal+1 );
drhab1cc582014-09-23 21:25:19 +00001250 if( nPayload<=pPage->maxLocal ){
drh271efa52004-05-30 19:19:05 +00001251 /* This is the (easy) common case where the entire payload fits
1252 ** on the local page. No overflow is required.
1253 */
drhab1cc582014-09-23 21:25:19 +00001254 pInfo->nSize = nPayload + (u16)(pIter - pCell);
1255 if( pInfo->nSize<4 ) pInfo->nSize = 4;
drhf49661a2008-12-10 16:45:50 +00001256 pInfo->nLocal = (u16)nPayload;
drh6f11bef2004-05-13 01:12:56 +00001257 }else{
drh5fa60512015-06-19 17:19:34 +00001258 btreeParseCellAdjustSizeForOverflow(pPage, pCell, pInfo);
drh6f11bef2004-05-13 01:12:56 +00001259 }
drh3aac2dd2004-04-26 14:10:20 +00001260}
drh5fa60512015-06-19 17:19:34 +00001261static void btreeParseCellPtrIndex(
1262 MemPage *pPage, /* Page containing the cell */
1263 u8 *pCell, /* Pointer to the cell text. */
1264 CellInfo *pInfo /* Fill in this structure */
1265){
1266 u8 *pIter; /* For scanning through pCell */
1267 u32 nPayload; /* Number of bytes of cell payload */
drh3aac2dd2004-04-26 14:10:20 +00001268
drh5fa60512015-06-19 17:19:34 +00001269 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
1270 assert( pPage->leaf==0 || pPage->leaf==1 );
1271 assert( pPage->intKeyLeaf==0 );
drh5fa60512015-06-19 17:19:34 +00001272 pIter = pCell + pPage->childPtrSize;
1273 nPayload = *pIter;
1274 if( nPayload>=0x80 ){
drheeab2c62015-06-19 20:08:39 +00001275 u8 *pEnd = &pIter[8];
drh5fa60512015-06-19 17:19:34 +00001276 nPayload &= 0x7f;
1277 do{
1278 nPayload = (nPayload<<7) | (*++pIter & 0x7f);
1279 }while( *(pIter)>=0x80 && pIter<pEnd );
1280 }
1281 pIter++;
1282 pInfo->nKey = nPayload;
1283 pInfo->nPayload = nPayload;
1284 pInfo->pPayload = pIter;
1285 testcase( nPayload==pPage->maxLocal );
1286 testcase( nPayload==pPage->maxLocal+1 );
1287 if( nPayload<=pPage->maxLocal ){
1288 /* This is the (easy) common case where the entire payload fits
1289 ** on the local page. No overflow is required.
1290 */
1291 pInfo->nSize = nPayload + (u16)(pIter - pCell);
1292 if( pInfo->nSize<4 ) pInfo->nSize = 4;
1293 pInfo->nLocal = (u16)nPayload;
drh5fa60512015-06-19 17:19:34 +00001294 }else{
1295 btreeParseCellAdjustSizeForOverflow(pPage, pCell, pInfo);
drh3aac2dd2004-04-26 14:10:20 +00001296 }
1297}
danielk197730548662009-07-09 05:07:37 +00001298static void btreeParseCell(
drh43605152004-05-29 21:46:49 +00001299 MemPage *pPage, /* Page containing the cell */
1300 int iCell, /* The cell index. First cell is 0 */
1301 CellInfo *pInfo /* Fill in this structure */
1302){
drh5fa60512015-06-19 17:19:34 +00001303 pPage->xParseCell(pPage, findCell(pPage, iCell), pInfo);
drh43605152004-05-29 21:46:49 +00001304}
drh3aac2dd2004-04-26 14:10:20 +00001305
1306/*
drh5fa60512015-06-19 17:19:34 +00001307** The following routines are implementations of the MemPage.xCellSize
1308** method.
1309**
drh43605152004-05-29 21:46:49 +00001310** Compute the total number of bytes that a Cell needs in the cell
1311** data area of the btree-page. The return number includes the cell
1312** data header and the local payload, but not any overflow page or
1313** the space used by the cell pointer.
drh25ada072015-06-19 15:07:14 +00001314**
drh5fa60512015-06-19 17:19:34 +00001315** cellSizePtrNoPayload() => table internal nodes
1316** cellSizePtr() => all index nodes & table leaf nodes
drh3b7511c2001-05-26 13:15:44 +00001317*/
danielk1977ae5558b2009-04-29 11:31:47 +00001318static u16 cellSizePtr(MemPage *pPage, u8 *pCell){
drh3f387402014-09-24 01:23:00 +00001319 u8 *pIter = pCell + pPage->childPtrSize; /* For looping over bytes of pCell */
1320 u8 *pEnd; /* End mark for a varint */
1321 u32 nSize; /* Size value to return */
danielk1977ae5558b2009-04-29 11:31:47 +00001322
1323#ifdef SQLITE_DEBUG
1324 /* The value returned by this function should always be the same as
1325 ** the (CellInfo.nSize) value found by doing a full parse of the
1326 ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
1327 ** this function verifies that this invariant is not violated. */
1328 CellInfo debuginfo;
drh5fa60512015-06-19 17:19:34 +00001329 pPage->xParseCell(pPage, pCell, &debuginfo);
danielk1977ae5558b2009-04-29 11:31:47 +00001330#endif
1331
drh3e28ff52014-09-24 00:59:08 +00001332 nSize = *pIter;
1333 if( nSize>=0x80 ){
drheeab2c62015-06-19 20:08:39 +00001334 pEnd = &pIter[8];
drh3e28ff52014-09-24 00:59:08 +00001335 nSize &= 0x7f;
1336 do{
1337 nSize = (nSize<<7) | (*++pIter & 0x7f);
1338 }while( *(pIter)>=0x80 && pIter<pEnd );
1339 }
1340 pIter++;
danielk1977ae5558b2009-04-29 11:31:47 +00001341 if( pPage->intKey ){
danielk1977ae5558b2009-04-29 11:31:47 +00001342 /* pIter now points at the 64-bit integer key value, a variable length
1343 ** integer. The following block moves pIter to point at the first byte
1344 ** past the end of the key value. */
1345 pEnd = &pIter[9];
1346 while( (*pIter++)&0x80 && pIter<pEnd );
danielk1977ae5558b2009-04-29 11:31:47 +00001347 }
drh0a45c272009-07-08 01:49:11 +00001348 testcase( nSize==pPage->maxLocal );
1349 testcase( nSize==pPage->maxLocal+1 );
drh3e28ff52014-09-24 00:59:08 +00001350 if( nSize<=pPage->maxLocal ){
1351 nSize += (u32)(pIter - pCell);
1352 if( nSize<4 ) nSize = 4;
1353 }else{
danielk1977ae5558b2009-04-29 11:31:47 +00001354 int minLocal = pPage->minLocal;
1355 nSize = minLocal + (nSize - minLocal) % (pPage->pBt->usableSize - 4);
drh0a45c272009-07-08 01:49:11 +00001356 testcase( nSize==pPage->maxLocal );
1357 testcase( nSize==pPage->maxLocal+1 );
danielk1977ae5558b2009-04-29 11:31:47 +00001358 if( nSize>pPage->maxLocal ){
1359 nSize = minLocal;
1360 }
drh3e28ff52014-09-24 00:59:08 +00001361 nSize += 4 + (u16)(pIter - pCell);
danielk1977ae5558b2009-04-29 11:31:47 +00001362 }
drhdc41d602014-09-22 19:51:35 +00001363 assert( nSize==debuginfo.nSize || CORRUPT_DB );
shane60a4b532009-05-06 18:57:09 +00001364 return (u16)nSize;
danielk1977ae5558b2009-04-29 11:31:47 +00001365}
drh25ada072015-06-19 15:07:14 +00001366static u16 cellSizePtrNoPayload(MemPage *pPage, u8 *pCell){
1367 u8 *pIter = pCell + 4; /* For looping over bytes of pCell */
1368 u8 *pEnd; /* End mark for a varint */
1369
1370#ifdef SQLITE_DEBUG
1371 /* The value returned by this function should always be the same as
1372 ** the (CellInfo.nSize) value found by doing a full parse of the
1373 ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
1374 ** this function verifies that this invariant is not violated. */
1375 CellInfo debuginfo;
drh5fa60512015-06-19 17:19:34 +00001376 pPage->xParseCell(pPage, pCell, &debuginfo);
drh94a31152015-07-01 04:08:40 +00001377#else
1378 UNUSED_PARAMETER(pPage);
drh25ada072015-06-19 15:07:14 +00001379#endif
1380
1381 assert( pPage->childPtrSize==4 );
1382 pEnd = pIter + 9;
1383 while( (*pIter++)&0x80 && pIter<pEnd );
1384 assert( debuginfo.nSize==(u16)(pIter - pCell) || CORRUPT_DB );
1385 return (u16)(pIter - pCell);
1386}
1387
drh0ee3dbe2009-10-16 15:05:18 +00001388
1389#ifdef SQLITE_DEBUG
1390/* This variation on cellSizePtr() is used inside of assert() statements
1391** only. */
drha9121e42008-02-19 14:59:35 +00001392static u16 cellSize(MemPage *pPage, int iCell){
drh25ada072015-06-19 15:07:14 +00001393 return pPage->xCellSize(pPage, findCell(pPage, iCell));
drh43605152004-05-29 21:46:49 +00001394}
danielk1977bc6ada42004-06-30 08:20:16 +00001395#endif
drh3b7511c2001-05-26 13:15:44 +00001396
danielk197779a40da2005-01-16 08:00:01 +00001397#ifndef SQLITE_OMIT_AUTOVACUUM
drh3b7511c2001-05-26 13:15:44 +00001398/*
drh0f1bf4c2019-01-13 20:17:21 +00001399** The cell pCell is currently part of page pSrc but will ultimately be part
1400** of pPage. (pSrc and pPager are often the same.) If pCell contains a
1401** pointer to an overflow page, insert an entry into the pointer-map for
1402** the overflow page that will be valid after pCell has been moved to pPage.
danielk1977ac11ee62005-01-15 12:45:51 +00001403*/
drh0f1bf4c2019-01-13 20:17:21 +00001404static void ptrmapPutOvflPtr(MemPage *pPage, MemPage *pSrc, u8 *pCell,int *pRC){
drhfa67c3c2008-07-11 02:21:40 +00001405 CellInfo info;
drh98add2e2009-07-20 17:11:49 +00001406 if( *pRC ) return;
drhfa67c3c2008-07-11 02:21:40 +00001407 assert( pCell!=0 );
drh5fa60512015-06-19 17:19:34 +00001408 pPage->xParseCell(pPage, pCell, &info);
drh45ac1c72015-12-18 03:59:16 +00001409 if( info.nLocal<info.nPayload ){
drhe7acce62018-12-14 16:00:38 +00001410 Pgno ovfl;
drh0f1bf4c2019-01-13 20:17:21 +00001411 if( SQLITE_WITHIN(pSrc->aDataEnd, pCell, pCell+info.nLocal) ){
1412 testcase( pSrc!=pPage );
drhe7acce62018-12-14 16:00:38 +00001413 *pRC = SQLITE_CORRUPT_BKPT;
1414 return;
1415 }
1416 ovfl = get4byte(&pCell[info.nSize-4]);
drh98add2e2009-07-20 17:11:49 +00001417 ptrmapPut(pPage->pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno, pRC);
danielk1977ac11ee62005-01-15 12:45:51 +00001418 }
danielk1977ac11ee62005-01-15 12:45:51 +00001419}
danielk197779a40da2005-01-16 08:00:01 +00001420#endif
1421
danielk1977ac11ee62005-01-15 12:45:51 +00001422
drhda200cc2004-05-09 11:51:38 +00001423/*
dane6d065a2017-02-24 19:58:22 +00001424** Defragment the page given. This routine reorganizes cells within the
1425** page so that there are no free-blocks on the free-block list.
1426**
1427** Parameter nMaxFrag is the maximum amount of fragmented space that may be
1428** present in the page after this routine returns.
drhfdab0262014-11-20 15:30:50 +00001429**
1430** EVIDENCE-OF: R-44582-60138 SQLite may from time to time reorganize a
1431** b-tree page so that there are no freeblocks or fragment bytes, all
1432** unused bytes are contained in the unallocated space region, and all
1433** cells are packed tightly at the end of the page.
drh365d68f2001-05-11 11:02:46 +00001434*/
dane6d065a2017-02-24 19:58:22 +00001435static int defragmentPage(MemPage *pPage, int nMaxFrag){
drh43605152004-05-29 21:46:49 +00001436 int i; /* Loop counter */
peter.d.reid60ec9142014-09-06 16:39:46 +00001437 int pc; /* Address of the i-th cell */
drh43605152004-05-29 21:46:49 +00001438 int hdr; /* Offset to the page header */
1439 int size; /* Size of a cell */
1440 int usableSize; /* Number of usable bytes on a page */
1441 int cellOffset; /* Offset to the cell pointer array */
drh281b21d2008-08-22 12:57:08 +00001442 int cbrk; /* Offset to the cell content area */
drh43605152004-05-29 21:46:49 +00001443 int nCell; /* Number of cells on the page */
drh2e38c322004-09-03 18:38:44 +00001444 unsigned char *data; /* The page data */
1445 unsigned char *temp; /* Temp area for cell content */
drh588400b2014-09-27 05:00:25 +00001446 unsigned char *src; /* Source of content */
drh17146622009-07-07 17:38:38 +00001447 int iCellFirst; /* First allowable cell index */
1448 int iCellLast; /* Last possible cell index */
dan7f65b7a2021-04-10 20:27:06 +00001449 int iCellStart; /* First cell offset in input */
drh17146622009-07-07 17:38:38 +00001450
danielk19773b8a05f2007-03-19 17:44:26 +00001451 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +00001452 assert( pPage->pBt!=0 );
drh90f5ecb2004-07-22 01:19:35 +00001453 assert( pPage->pBt->usableSize <= SQLITE_MAX_PAGE_SIZE );
drh43605152004-05-29 21:46:49 +00001454 assert( pPage->nOverflow==0 );
drh1fee73e2007-08-29 04:00:57 +00001455 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh588400b2014-09-27 05:00:25 +00001456 temp = 0;
1457 src = data = pPage->aData;
drh9e572e62004-04-23 23:43:10 +00001458 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +00001459 cellOffset = pPage->cellOffset;
1460 nCell = pPage->nCell;
drh45616c72019-02-28 13:21:36 +00001461 assert( nCell==get2byte(&data[hdr+3]) || CORRUPT_DB );
dane6d065a2017-02-24 19:58:22 +00001462 iCellFirst = cellOffset + 2*nCell;
dan30741eb2017-03-03 20:02:53 +00001463 usableSize = pPage->pBt->usableSize;
dane6d065a2017-02-24 19:58:22 +00001464
1465 /* This block handles pages with two or fewer free blocks and nMaxFrag
1466 ** or fewer fragmented bytes. In this case it is faster to move the
1467 ** two (or one) blocks of cells using memmove() and add the required
1468 ** offsets to each pointer in the cell-pointer array than it is to
1469 ** reconstruct the entire page. */
1470 if( (int)data[hdr+7]<=nMaxFrag ){
1471 int iFree = get2byte(&data[hdr+1]);
drh119e1ff2019-03-30 18:39:13 +00001472 if( iFree>usableSize-4 ) return SQLITE_CORRUPT_PAGE(pPage);
dane6d065a2017-02-24 19:58:22 +00001473 if( iFree ){
1474 int iFree2 = get2byte(&data[iFree]);
drh5881dfe2018-12-13 03:36:13 +00001475 if( iFree2>usableSize-4 ) return SQLITE_CORRUPT_PAGE(pPage);
dane6d065a2017-02-24 19:58:22 +00001476 if( 0==iFree2 || (data[iFree2]==0 && data[iFree2+1]==0) ){
1477 u8 *pEnd = &data[cellOffset + nCell*2];
1478 u8 *pAddr;
1479 int sz2 = 0;
1480 int sz = get2byte(&data[iFree+2]);
1481 int top = get2byte(&data[hdr+5]);
drh4b9e7362020-02-18 23:58:58 +00001482 if( top>=iFree ){
daneebf2f52017-11-18 17:30:08 +00001483 return SQLITE_CORRUPT_PAGE(pPage);
drh4e6cec12017-09-28 13:47:35 +00001484 }
dane6d065a2017-02-24 19:58:22 +00001485 if( iFree2 ){
drh5881dfe2018-12-13 03:36:13 +00001486 if( iFree+sz>iFree2 ) return SQLITE_CORRUPT_PAGE(pPage);
dane6d065a2017-02-24 19:58:22 +00001487 sz2 = get2byte(&data[iFree2+2]);
drh5881dfe2018-12-13 03:36:13 +00001488 if( iFree2+sz2 > usableSize ) return SQLITE_CORRUPT_PAGE(pPage);
dane6d065a2017-02-24 19:58:22 +00001489 memmove(&data[iFree+sz+sz2], &data[iFree+sz], iFree2-(iFree+sz));
1490 sz += sz2;
drhd78fe4e2021-04-09 22:34:59 +00001491 }else if( iFree+sz>usableSize ){
dandcc427c2019-03-21 21:18:36 +00001492 return SQLITE_CORRUPT_PAGE(pPage);
dane6d065a2017-02-24 19:58:22 +00001493 }
dandcc427c2019-03-21 21:18:36 +00001494
dane6d065a2017-02-24 19:58:22 +00001495 cbrk = top+sz;
dan30741eb2017-03-03 20:02:53 +00001496 assert( cbrk+(iFree-top) <= usableSize );
dane6d065a2017-02-24 19:58:22 +00001497 memmove(&data[cbrk], &data[top], iFree-top);
1498 for(pAddr=&data[cellOffset]; pAddr<pEnd; pAddr+=2){
1499 pc = get2byte(pAddr);
1500 if( pc<iFree ){ put2byte(pAddr, pc+sz); }
1501 else if( pc<iFree2 ){ put2byte(pAddr, pc+sz2); }
1502 }
1503 goto defragment_out;
1504 }
1505 }
1506 }
1507
drh281b21d2008-08-22 12:57:08 +00001508 cbrk = usableSize;
drh17146622009-07-07 17:38:38 +00001509 iCellLast = usableSize - 4;
dan7f65b7a2021-04-10 20:27:06 +00001510 iCellStart = get2byte(&data[hdr+5]);
drh43605152004-05-29 21:46:49 +00001511 for(i=0; i<nCell; i++){
1512 u8 *pAddr; /* The i-th cell pointer */
1513 pAddr = &data[cellOffset + i*2];
1514 pc = get2byte(pAddr);
drh0a45c272009-07-08 01:49:11 +00001515 testcase( pc==iCellFirst );
1516 testcase( pc==iCellLast );
danielk197730548662009-07-09 05:07:37 +00001517 /* These conditions have already been verified in btreeInitPage()
drh1421d982015-05-27 03:46:18 +00001518 ** if PRAGMA cell_size_check=ON.
drh17146622009-07-07 17:38:38 +00001519 */
dan7f65b7a2021-04-10 20:27:06 +00001520 if( pc<iCellStart || pc>iCellLast ){
daneebf2f52017-11-18 17:30:08 +00001521 return SQLITE_CORRUPT_PAGE(pPage);
shane0af3f892008-11-12 04:55:34 +00001522 }
dan7f65b7a2021-04-10 20:27:06 +00001523 assert( pc>=iCellStart && pc<=iCellLast );
drh25ada072015-06-19 15:07:14 +00001524 size = pPage->xCellSize(pPage, &src[pc]);
drh281b21d2008-08-22 12:57:08 +00001525 cbrk -= size;
dan7f65b7a2021-04-10 20:27:06 +00001526 if( cbrk<iCellStart || pc+size>usableSize ){
daneebf2f52017-11-18 17:30:08 +00001527 return SQLITE_CORRUPT_PAGE(pPage);
drh17146622009-07-07 17:38:38 +00001528 }
dan7f65b7a2021-04-10 20:27:06 +00001529 assert( cbrk+size<=usableSize && cbrk>=iCellStart );
drh0a45c272009-07-08 01:49:11 +00001530 testcase( cbrk+size==usableSize );
drh0a45c272009-07-08 01:49:11 +00001531 testcase( pc+size==usableSize );
drh281b21d2008-08-22 12:57:08 +00001532 put2byte(pAddr, cbrk);
drh588400b2014-09-27 05:00:25 +00001533 if( temp==0 ){
drh588400b2014-09-27 05:00:25 +00001534 if( cbrk==pc ) continue;
1535 temp = sqlite3PagerTempSpace(pPage->pBt->pPager);
drhccf0bb42021-06-07 13:50:36 +00001536 memcpy(&temp[iCellStart], &data[iCellStart], usableSize - iCellStart);
drh588400b2014-09-27 05:00:25 +00001537 src = temp;
1538 }
1539 memcpy(&data[cbrk], &src[pc], size);
drh2af926b2001-05-15 00:39:25 +00001540 }
dane6d065a2017-02-24 19:58:22 +00001541 data[hdr+7] = 0;
dane6d065a2017-02-24 19:58:22 +00001542
1543 defragment_out:
drhb0ea9432019-02-09 21:06:40 +00001544 assert( pPage->nFree>=0 );
dan3b2ede12017-02-25 16:24:02 +00001545 if( data[hdr+7]+cbrk-iCellFirst!=pPage->nFree ){
daneebf2f52017-11-18 17:30:08 +00001546 return SQLITE_CORRUPT_PAGE(pPage);
dan3b2ede12017-02-25 16:24:02 +00001547 }
drh17146622009-07-07 17:38:38 +00001548 assert( cbrk>=iCellFirst );
drh281b21d2008-08-22 12:57:08 +00001549 put2byte(&data[hdr+5], cbrk);
drh43605152004-05-29 21:46:49 +00001550 data[hdr+1] = 0;
1551 data[hdr+2] = 0;
drh17146622009-07-07 17:38:38 +00001552 memset(&data[iCellFirst], 0, cbrk-iCellFirst);
drhc5053fb2008-11-27 02:22:10 +00001553 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
shane0af3f892008-11-12 04:55:34 +00001554 return SQLITE_OK;
drh365d68f2001-05-11 11:02:46 +00001555}
1556
drha059ad02001-04-17 20:09:11 +00001557/*
dan8e9ba0c2014-10-14 17:27:04 +00001558** Search the free-list on page pPg for space to store a cell nByte bytes in
1559** size. If one can be found, return a pointer to the space and remove it
1560** from the free-list.
1561**
1562** If no suitable space can be found on the free-list, return NULL.
1563**
drhba0f9992014-10-30 20:48:44 +00001564** This function may detect corruption within pPg. If corruption is
1565** detected then *pRc is set to SQLITE_CORRUPT and NULL is returned.
dan61e94c92014-10-27 08:02:16 +00001566**
drhb7580e82015-06-25 18:36:13 +00001567** Slots on the free list that are between 1 and 3 bytes larger than nByte
1568** will be ignored if adding the extra space to the fragmentation count
1569** causes the fragmentation count to exceed 60.
dan8e9ba0c2014-10-14 17:27:04 +00001570*/
drhb7580e82015-06-25 18:36:13 +00001571static u8 *pageFindSlot(MemPage *pPg, int nByte, int *pRc){
drh298f45c2019-02-08 22:34:59 +00001572 const int hdr = pPg->hdrOffset; /* Offset to page header */
1573 u8 * const aData = pPg->aData; /* Page data */
1574 int iAddr = hdr + 1; /* Address of ptr to pc */
1575 int pc = get2byte(&aData[iAddr]); /* Address of a free slot */
1576 int x; /* Excess size of the slot */
1577 int maxPC = pPg->pBt->usableSize - nByte; /* Max address for a usable slot */
1578 int size; /* Size of the free slot */
dan8e9ba0c2014-10-14 17:27:04 +00001579
drhb7580e82015-06-25 18:36:13 +00001580 assert( pc>0 );
drh298f45c2019-02-08 22:34:59 +00001581 while( pc<=maxPC ){
drh113762a2014-11-19 16:36:25 +00001582 /* EVIDENCE-OF: R-22710-53328 The third and fourth bytes of each
1583 ** freeblock form a big-endian integer which is the size of the freeblock
1584 ** in bytes, including the 4-byte header. */
dan8e9ba0c2014-10-14 17:27:04 +00001585 size = get2byte(&aData[pc+2]);
drhb7580e82015-06-25 18:36:13 +00001586 if( (x = size - nByte)>=0 ){
dan8e9ba0c2014-10-14 17:27:04 +00001587 testcase( x==4 );
1588 testcase( x==3 );
drh298f45c2019-02-08 22:34:59 +00001589 if( x<4 ){
drhfdab0262014-11-20 15:30:50 +00001590 /* EVIDENCE-OF: R-11498-58022 In a well-formed b-tree page, the total
1591 ** number of bytes in fragments may not exceed 60. */
drhb7580e82015-06-25 18:36:13 +00001592 if( aData[hdr+7]>57 ) return 0;
1593
dan8e9ba0c2014-10-14 17:27:04 +00001594 /* Remove the slot from the free-list. Update the number of
1595 ** fragmented bytes within the page. */
1596 memcpy(&aData[iAddr], &aData[pc], 2);
1597 aData[hdr+7] += (u8)x;
drh298f45c2019-02-08 22:34:59 +00001598 }else if( x+pc > maxPC ){
1599 /* This slot extends off the end of the usable part of the page */
1600 *pRc = SQLITE_CORRUPT_PAGE(pPg);
1601 return 0;
dan8e9ba0c2014-10-14 17:27:04 +00001602 }else{
1603 /* The slot remains on the free-list. Reduce its size to account
drh298f45c2019-02-08 22:34:59 +00001604 ** for the portion used by the new allocation. */
dan8e9ba0c2014-10-14 17:27:04 +00001605 put2byte(&aData[pc+2], x);
1606 }
1607 return &aData[pc + x];
1608 }
drhb7580e82015-06-25 18:36:13 +00001609 iAddr = pc;
1610 pc = get2byte(&aData[pc]);
drh2a934d72019-03-13 10:29:16 +00001611 if( pc<=iAddr+size ){
drh298f45c2019-02-08 22:34:59 +00001612 if( pc ){
1613 /* The next slot in the chain is not past the end of the current slot */
1614 *pRc = SQLITE_CORRUPT_PAGE(pPg);
1615 }
1616 return 0;
1617 }
drh87d63c92017-08-23 23:09:03 +00001618 }
drh298f45c2019-02-08 22:34:59 +00001619 if( pc>maxPC+nByte-4 ){
1620 /* The free slot chain extends off the end of the page */
daneebf2f52017-11-18 17:30:08 +00001621 *pRc = SQLITE_CORRUPT_PAGE(pPg);
drh87d63c92017-08-23 23:09:03 +00001622 }
dan8e9ba0c2014-10-14 17:27:04 +00001623 return 0;
1624}
1625
1626/*
danielk19776011a752009-04-01 16:25:32 +00001627** Allocate nByte bytes of space from within the B-Tree page passed
drh0a45c272009-07-08 01:49:11 +00001628** as the first argument. Write into *pIdx the index into pPage->aData[]
1629** of the first byte of allocated space. Return either SQLITE_OK or
1630** an error code (usually SQLITE_CORRUPT).
drhbd03cae2001-06-02 02:40:57 +00001631**
drh0a45c272009-07-08 01:49:11 +00001632** The caller guarantees that there is sufficient space to make the
1633** allocation. This routine might need to defragment in order to bring
1634** all the space together, however. This routine will avoid using
1635** the first two bytes past the cell pointer area since presumably this
1636** allocation is being made in order to insert a new cell, so we will
1637** also end up needing a new cell pointer.
drh7e3b0a02001-04-28 16:52:40 +00001638*/
drh0a45c272009-07-08 01:49:11 +00001639static int allocateSpace(MemPage *pPage, int nByte, int *pIdx){
danielk19776011a752009-04-01 16:25:32 +00001640 const int hdr = pPage->hdrOffset; /* Local cache of pPage->hdrOffset */
1641 u8 * const data = pPage->aData; /* Local cache of pPage->aData */
drh0a45c272009-07-08 01:49:11 +00001642 int top; /* First byte of cell content area */
drhfefa0942014-11-05 21:21:08 +00001643 int rc = SQLITE_OK; /* Integer return code */
drh0a45c272009-07-08 01:49:11 +00001644 int gap; /* First byte of gap between cell pointers and cell content */
drh43605152004-05-29 21:46:49 +00001645
danielk19773b8a05f2007-03-19 17:44:26 +00001646 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh9e572e62004-04-23 23:43:10 +00001647 assert( pPage->pBt );
drh1fee73e2007-08-29 04:00:57 +00001648 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhfa67c3c2008-07-11 02:21:40 +00001649 assert( nByte>=0 ); /* Minimum cell size is 4 */
1650 assert( pPage->nFree>=nByte );
1651 assert( pPage->nOverflow==0 );
mistachkina95d8ca2014-10-27 19:42:02 +00001652 assert( nByte < (int)(pPage->pBt->usableSize-8) );
drh43605152004-05-29 21:46:49 +00001653
drh0a45c272009-07-08 01:49:11 +00001654 assert( pPage->cellOffset == hdr + 12 - 4*pPage->leaf );
1655 gap = pPage->cellOffset + 2*pPage->nCell;
drh75b31dc2014-08-20 00:54:46 +00001656 assert( gap<=65536 );
drhfdab0262014-11-20 15:30:50 +00001657 /* EVIDENCE-OF: R-29356-02391 If the database uses a 65536-byte page size
1658 ** and the reserved space is zero (the usual value for reserved space)
1659 ** then the cell content offset of an empty page wants to be 65536.
1660 ** However, that integer is too large to be stored in a 2-byte unsigned
1661 ** integer, so a value of 0 is used in its place. */
drhded340e2015-06-25 15:04:56 +00001662 top = get2byte(&data[hdr+5]);
drhdfcecdf2019-05-08 00:17:45 +00001663 assert( top<=(int)pPage->pBt->usableSize ); /* by btreeComputeFreeSpace() */
drhded340e2015-06-25 15:04:56 +00001664 if( gap>top ){
drh291508f2019-05-08 04:33:17 +00001665 if( top==0 && pPage->pBt->usableSize==65536 ){
drhded340e2015-06-25 15:04:56 +00001666 top = 65536;
1667 }else{
daneebf2f52017-11-18 17:30:08 +00001668 return SQLITE_CORRUPT_PAGE(pPage);
drh9e572e62004-04-23 23:43:10 +00001669 }
1670 }
drh43605152004-05-29 21:46:49 +00001671
drhd4a67442019-02-11 19:27:36 +00001672 /* If there is enough space between gap and top for one more cell pointer,
1673 ** and if the freelist is not empty, then search the
1674 ** freelist looking for a slot big enough to satisfy the request.
drh4c04f3c2014-08-20 11:56:14 +00001675 */
drh5e2f8b92001-05-28 00:41:15 +00001676 testcase( gap+2==top );
drh7aa128d2002-06-21 13:09:16 +00001677 testcase( gap+1==top );
drh14acc042001-06-10 19:56:58 +00001678 testcase( gap==top );
drhe674bf12015-06-25 16:01:44 +00001679 if( (data[hdr+2] || data[hdr+1]) && gap+2<=top ){
drhb7580e82015-06-25 18:36:13 +00001680 u8 *pSpace = pageFindSlot(pPage, nByte, &rc);
dan8e9ba0c2014-10-14 17:27:04 +00001681 if( pSpace ){
drh3b76c452020-01-03 17:40:30 +00001682 int g2;
drh2b96b692019-08-05 16:22:20 +00001683 assert( pSpace+nByte<=data+pPage->pBt->usableSize );
drh3b76c452020-01-03 17:40:30 +00001684 *pIdx = g2 = (int)(pSpace-data);
drhb9154182021-06-20 22:49:26 +00001685 if( g2<=gap ){
drh2b96b692019-08-05 16:22:20 +00001686 return SQLITE_CORRUPT_PAGE(pPage);
1687 }else{
1688 return SQLITE_OK;
1689 }
drhb7580e82015-06-25 18:36:13 +00001690 }else if( rc ){
1691 return rc;
drh9e572e62004-04-23 23:43:10 +00001692 }
1693 }
drh43605152004-05-29 21:46:49 +00001694
drh4c04f3c2014-08-20 11:56:14 +00001695 /* The request could not be fulfilled using a freelist slot. Check
1696 ** to see if defragmentation is necessary.
drh0a45c272009-07-08 01:49:11 +00001697 */
1698 testcase( gap+2+nByte==top );
1699 if( gap+2+nByte>top ){
drh1fd2d7d2014-12-02 16:16:47 +00001700 assert( pPage->nCell>0 || CORRUPT_DB );
drhb0ea9432019-02-09 21:06:40 +00001701 assert( pPage->nFree>=0 );
dane6d065a2017-02-24 19:58:22 +00001702 rc = defragmentPage(pPage, MIN(4, pPage->nFree - (2+nByte)));
drh0a45c272009-07-08 01:49:11 +00001703 if( rc ) return rc;
drh5d433ce2010-08-14 16:02:52 +00001704 top = get2byteNotZero(&data[hdr+5]);
dan3b2ede12017-02-25 16:24:02 +00001705 assert( gap+2+nByte<=top );
drh0a45c272009-07-08 01:49:11 +00001706 }
1707
1708
drh43605152004-05-29 21:46:49 +00001709 /* Allocate memory from the gap in between the cell pointer array
drh5860a612019-02-12 16:58:26 +00001710 ** and the cell content area. The btreeComputeFreeSpace() call has already
drhc314dc72009-07-21 11:52:34 +00001711 ** validated the freelist. Given that the freelist is valid, there
1712 ** is no way that the allocation can extend off the end of the page.
1713 ** The assert() below verifies the previous sentence.
drh43605152004-05-29 21:46:49 +00001714 */
drh0a45c272009-07-08 01:49:11 +00001715 top -= nByte;
drh43605152004-05-29 21:46:49 +00001716 put2byte(&data[hdr+5], top);
drhfcd71b62011-04-05 22:08:24 +00001717 assert( top+nByte <= (int)pPage->pBt->usableSize );
drh0a45c272009-07-08 01:49:11 +00001718 *pIdx = top;
1719 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001720}
1721
1722/*
drh9e572e62004-04-23 23:43:10 +00001723** Return a section of the pPage->aData to the freelist.
drh7fb91642014-08-20 14:37:09 +00001724** The first byte of the new free block is pPage->aData[iStart]
1725** and the size of the block is iSize bytes.
drh306dc212001-05-21 13:45:10 +00001726**
drh5f5c7532014-08-20 17:56:27 +00001727** Adjacent freeblocks are coalesced.
1728**
drh5860a612019-02-12 16:58:26 +00001729** Even though the freeblock list was checked by btreeComputeFreeSpace(),
drh5f5c7532014-08-20 17:56:27 +00001730** that routine will not detect overlap between cells or freeblocks. Nor
1731** does it detect cells or freeblocks that encrouch into the reserved bytes
1732** at the end of the page. So do additional corruption checks inside this
1733** routine and return SQLITE_CORRUPT if any problems are found.
drh7e3b0a02001-04-28 16:52:40 +00001734*/
drh5f5c7532014-08-20 17:56:27 +00001735static int freeSpace(MemPage *pPage, u16 iStart, u16 iSize){
drh3f387402014-09-24 01:23:00 +00001736 u16 iPtr; /* Address of ptr to next freeblock */
drh5f5c7532014-08-20 17:56:27 +00001737 u16 iFreeBlk; /* Address of the next freeblock */
1738 u8 hdr; /* Page header size. 0 or 100 */
1739 u8 nFrag = 0; /* Reduction in fragmentation */
1740 u16 iOrigSize = iSize; /* Original value of iSize */
drh5e398e42017-08-23 20:36:06 +00001741 u16 x; /* Offset to cell content area */
drh5f5c7532014-08-20 17:56:27 +00001742 u32 iEnd = iStart + iSize; /* First byte past the iStart buffer */
drh7fb91642014-08-20 14:37:09 +00001743 unsigned char *data = pPage->aData; /* Page content */
drh2af926b2001-05-15 00:39:25 +00001744
drh9e572e62004-04-23 23:43:10 +00001745 assert( pPage->pBt!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +00001746 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
dancf3d17c2015-05-25 15:03:49 +00001747 assert( CORRUPT_DB || iStart>=pPage->hdrOffset+6+pPage->childPtrSize );
dan23eba452014-10-24 18:43:57 +00001748 assert( CORRUPT_DB || iEnd <= pPage->pBt->usableSize );
drh1fee73e2007-08-29 04:00:57 +00001749 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh7fb91642014-08-20 14:37:09 +00001750 assert( iSize>=4 ); /* Minimum cell size is 4 */
drh5e398e42017-08-23 20:36:06 +00001751 assert( iStart<=pPage->pBt->usableSize-4 );
drhfcce93f2006-02-22 03:08:32 +00001752
drh5f5c7532014-08-20 17:56:27 +00001753 /* The list of freeblocks must be in ascending order. Find the
1754 ** spot on the list where iStart should be inserted.
drh0a45c272009-07-08 01:49:11 +00001755 */
drh43605152004-05-29 21:46:49 +00001756 hdr = pPage->hdrOffset;
drh7fb91642014-08-20 14:37:09 +00001757 iPtr = hdr + 1;
drh7bc4c452014-08-20 18:43:44 +00001758 if( data[iPtr+1]==0 && data[iPtr]==0 ){
1759 iFreeBlk = 0; /* Shortcut for the case when the freelist is empty */
1760 }else{
drh85f071b2016-09-17 19:34:32 +00001761 while( (iFreeBlk = get2byte(&data[iPtr]))<iStart ){
1762 if( iFreeBlk<iPtr+4 ){
drh05e8c542020-01-14 16:39:54 +00001763 if( iFreeBlk==0 ) break; /* TH3: corrupt082.100 */
daneebf2f52017-11-18 17:30:08 +00001764 return SQLITE_CORRUPT_PAGE(pPage);
drh85f071b2016-09-17 19:34:32 +00001765 }
drh7bc4c452014-08-20 18:43:44 +00001766 iPtr = iFreeBlk;
shanedcc50b72008-11-13 18:29:50 +00001767 }
drh628b1a32020-01-05 21:53:15 +00001768 if( iFreeBlk>pPage->pBt->usableSize-4 ){ /* TH3: corrupt081.100 */
daneebf2f52017-11-18 17:30:08 +00001769 return SQLITE_CORRUPT_PAGE(pPage);
drh5e398e42017-08-23 20:36:06 +00001770 }
drh7bc4c452014-08-20 18:43:44 +00001771 assert( iFreeBlk>iPtr || iFreeBlk==0 );
1772
1773 /* At this point:
1774 ** iFreeBlk: First freeblock after iStart, or zero if none
drh3e24a342015-06-15 16:09:35 +00001775 ** iPtr: The address of a pointer to iFreeBlk
drh7bc4c452014-08-20 18:43:44 +00001776 **
1777 ** Check to see if iFreeBlk should be coalesced onto the end of iStart.
1778 */
1779 if( iFreeBlk && iEnd+3>=iFreeBlk ){
1780 nFrag = iFreeBlk - iEnd;
daneebf2f52017-11-18 17:30:08 +00001781 if( iEnd>iFreeBlk ) return SQLITE_CORRUPT_PAGE(pPage);
drh7bc4c452014-08-20 18:43:44 +00001782 iEnd = iFreeBlk + get2byte(&data[iFreeBlk+2]);
drh6aa75152020-06-12 00:31:52 +00001783 if( iEnd > pPage->pBt->usableSize ){
daneebf2f52017-11-18 17:30:08 +00001784 return SQLITE_CORRUPT_PAGE(pPage);
drhcc97ca42017-06-07 22:32:59 +00001785 }
drh7bc4c452014-08-20 18:43:44 +00001786 iSize = iEnd - iStart;
1787 iFreeBlk = get2byte(&data[iFreeBlk]);
1788 }
1789
drh3f387402014-09-24 01:23:00 +00001790 /* If iPtr is another freeblock (that is, if iPtr is not the freelist
1791 ** pointer in the page header) then check to see if iStart should be
1792 ** coalesced onto the end of iPtr.
drh7bc4c452014-08-20 18:43:44 +00001793 */
1794 if( iPtr>hdr+1 ){
1795 int iPtrEnd = iPtr + get2byte(&data[iPtr+2]);
1796 if( iPtrEnd+3>=iStart ){
daneebf2f52017-11-18 17:30:08 +00001797 if( iPtrEnd>iStart ) return SQLITE_CORRUPT_PAGE(pPage);
drh7bc4c452014-08-20 18:43:44 +00001798 nFrag += iStart - iPtrEnd;
1799 iSize = iEnd - iPtr;
1800 iStart = iPtr;
shanedcc50b72008-11-13 18:29:50 +00001801 }
drh9e572e62004-04-23 23:43:10 +00001802 }
daneebf2f52017-11-18 17:30:08 +00001803 if( nFrag>data[hdr+7] ) return SQLITE_CORRUPT_PAGE(pPage);
drh7bc4c452014-08-20 18:43:44 +00001804 data[hdr+7] -= nFrag;
drh9e572e62004-04-23 23:43:10 +00001805 }
drh5e398e42017-08-23 20:36:06 +00001806 x = get2byte(&data[hdr+5]);
1807 if( iStart<=x ){
drh5f5c7532014-08-20 17:56:27 +00001808 /* The new freeblock is at the beginning of the cell content area,
1809 ** so just extend the cell content area rather than create another
1810 ** freelist entry */
drh3b76c452020-01-03 17:40:30 +00001811 if( iStart<x ) return SQLITE_CORRUPT_PAGE(pPage);
drh48118e42020-01-29 13:50:11 +00001812 if( iPtr!=hdr+1 ) return SQLITE_CORRUPT_PAGE(pPage);
drh5f5c7532014-08-20 17:56:27 +00001813 put2byte(&data[hdr+1], iFreeBlk);
1814 put2byte(&data[hdr+5], iEnd);
1815 }else{
1816 /* Insert the new freeblock into the freelist */
1817 put2byte(&data[iPtr], iStart);
drh4b70f112004-05-02 21:12:19 +00001818 }
drh5e398e42017-08-23 20:36:06 +00001819 if( pPage->pBt->btsFlags & BTS_FAST_SECURE ){
1820 /* Overwrite deleted information with zeros when the secure_delete
1821 ** option is enabled */
1822 memset(&data[iStart], 0, iSize);
1823 }
1824 put2byte(&data[iStart], iFreeBlk);
1825 put2byte(&data[iStart+2], iSize);
drh5f5c7532014-08-20 17:56:27 +00001826 pPage->nFree += iOrigSize;
shanedcc50b72008-11-13 18:29:50 +00001827 return SQLITE_OK;
drh4b70f112004-05-02 21:12:19 +00001828}
1829
1830/*
drh271efa52004-05-30 19:19:05 +00001831** Decode the flags byte (the first byte of the header) for a page
1832** and initialize fields of the MemPage structure accordingly.
drh44845222008-07-17 18:39:57 +00001833**
1834** Only the following combinations are supported. Anything different
1835** indicates a corrupt database files:
1836**
1837** PTF_ZERODATA
1838** PTF_ZERODATA | PTF_LEAF
1839** PTF_LEAFDATA | PTF_INTKEY
1840** PTF_LEAFDATA | PTF_INTKEY | PTF_LEAF
drh271efa52004-05-30 19:19:05 +00001841*/
drh44845222008-07-17 18:39:57 +00001842static int decodeFlags(MemPage *pPage, int flagByte){
danielk1977aef0bf62005-12-30 16:28:01 +00001843 BtShared *pBt; /* A copy of pPage->pBt */
drh271efa52004-05-30 19:19:05 +00001844
1845 assert( pPage->hdrOffset==(pPage->pgno==1 ? 100 : 0) );
drh1fee73e2007-08-29 04:00:57 +00001846 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhf49661a2008-12-10 16:45:50 +00001847 pPage->leaf = (u8)(flagByte>>3); assert( PTF_LEAF == 1<<3 );
drh44845222008-07-17 18:39:57 +00001848 flagByte &= ~PTF_LEAF;
1849 pPage->childPtrSize = 4-4*pPage->leaf;
drh25ada072015-06-19 15:07:14 +00001850 pPage->xCellSize = cellSizePtr;
drh271efa52004-05-30 19:19:05 +00001851 pBt = pPage->pBt;
drh44845222008-07-17 18:39:57 +00001852 if( flagByte==(PTF_LEAFDATA | PTF_INTKEY) ){
drh3791c9c2016-05-09 23:11:47 +00001853 /* EVIDENCE-OF: R-07291-35328 A value of 5 (0x05) means the page is an
1854 ** interior table b-tree page. */
drhfdab0262014-11-20 15:30:50 +00001855 assert( (PTF_LEAFDATA|PTF_INTKEY)==5 );
drh3791c9c2016-05-09 23:11:47 +00001856 /* EVIDENCE-OF: R-26900-09176 A value of 13 (0x0d) means the page is a
1857 ** leaf table b-tree page. */
drhfdab0262014-11-20 15:30:50 +00001858 assert( (PTF_LEAFDATA|PTF_INTKEY|PTF_LEAF)==13 );
drh44845222008-07-17 18:39:57 +00001859 pPage->intKey = 1;
drh25ada072015-06-19 15:07:14 +00001860 if( pPage->leaf ){
1861 pPage->intKeyLeaf = 1;
drh5fa60512015-06-19 17:19:34 +00001862 pPage->xParseCell = btreeParseCellPtr;
drh25ada072015-06-19 15:07:14 +00001863 }else{
1864 pPage->intKeyLeaf = 0;
drh25ada072015-06-19 15:07:14 +00001865 pPage->xCellSize = cellSizePtrNoPayload;
drh5fa60512015-06-19 17:19:34 +00001866 pPage->xParseCell = btreeParseCellPtrNoPayload;
drh25ada072015-06-19 15:07:14 +00001867 }
drh271efa52004-05-30 19:19:05 +00001868 pPage->maxLocal = pBt->maxLeaf;
1869 pPage->minLocal = pBt->minLeaf;
drh44845222008-07-17 18:39:57 +00001870 }else if( flagByte==PTF_ZERODATA ){
drh3791c9c2016-05-09 23:11:47 +00001871 /* EVIDENCE-OF: R-43316-37308 A value of 2 (0x02) means the page is an
1872 ** interior index b-tree page. */
drhfdab0262014-11-20 15:30:50 +00001873 assert( (PTF_ZERODATA)==2 );
drh3791c9c2016-05-09 23:11:47 +00001874 /* EVIDENCE-OF: R-59615-42828 A value of 10 (0x0a) means the page is a
1875 ** leaf index b-tree page. */
drhfdab0262014-11-20 15:30:50 +00001876 assert( (PTF_ZERODATA|PTF_LEAF)==10 );
drh44845222008-07-17 18:39:57 +00001877 pPage->intKey = 0;
drh3e28ff52014-09-24 00:59:08 +00001878 pPage->intKeyLeaf = 0;
drh5fa60512015-06-19 17:19:34 +00001879 pPage->xParseCell = btreeParseCellPtrIndex;
drh271efa52004-05-30 19:19:05 +00001880 pPage->maxLocal = pBt->maxLocal;
1881 pPage->minLocal = pBt->minLocal;
drh44845222008-07-17 18:39:57 +00001882 }else{
drhfdab0262014-11-20 15:30:50 +00001883 /* EVIDENCE-OF: R-47608-56469 Any other value for the b-tree page type is
1884 ** an error. */
daneebf2f52017-11-18 17:30:08 +00001885 return SQLITE_CORRUPT_PAGE(pPage);
drh271efa52004-05-30 19:19:05 +00001886 }
drhc9166342012-01-05 23:32:06 +00001887 pPage->max1bytePayload = pBt->max1bytePayload;
drh44845222008-07-17 18:39:57 +00001888 return SQLITE_OK;
drh271efa52004-05-30 19:19:05 +00001889}
1890
1891/*
drhb0ea9432019-02-09 21:06:40 +00001892** Compute the amount of freespace on the page. In other words, fill
1893** in the pPage->nFree field.
drh7e3b0a02001-04-28 16:52:40 +00001894*/
drhb0ea9432019-02-09 21:06:40 +00001895static int btreeComputeFreeSpace(MemPage *pPage){
drh14e845a2017-05-25 21:35:56 +00001896 int pc; /* Address of a freeblock within pPage->aData[] */
1897 u8 hdr; /* Offset to beginning of page header */
1898 u8 *data; /* Equal to pPage->aData */
drh14e845a2017-05-25 21:35:56 +00001899 int usableSize; /* Amount of usable space on each page */
drh14e845a2017-05-25 21:35:56 +00001900 int nFree; /* Number of unused bytes on the page */
1901 int top; /* First byte of the cell content area */
1902 int iCellFirst; /* First allowable cell or freeblock offset */
1903 int iCellLast; /* Last possible cell or freeblock offset */
drh2af926b2001-05-15 00:39:25 +00001904
danielk197771d5d2c2008-09-29 11:49:47 +00001905 assert( pPage->pBt!=0 );
drh1421d982015-05-27 03:46:18 +00001906 assert( pPage->pBt->db!=0 );
danielk197771d5d2c2008-09-29 11:49:47 +00001907 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk19773b8a05f2007-03-19 17:44:26 +00001908 assert( pPage->pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
drhbf4bca52007-09-06 22:19:14 +00001909 assert( pPage == sqlite3PagerGetExtra(pPage->pDbPage) );
1910 assert( pPage->aData == sqlite3PagerGetData(pPage->pDbPage) );
drhb0ea9432019-02-09 21:06:40 +00001911 assert( pPage->isInit==1 );
1912 assert( pPage->nFree<0 );
danielk197771d5d2c2008-09-29 11:49:47 +00001913
drhb0ea9432019-02-09 21:06:40 +00001914 usableSize = pPage->pBt->usableSize;
drh14e845a2017-05-25 21:35:56 +00001915 hdr = pPage->hdrOffset;
1916 data = pPage->aData;
drh14e845a2017-05-25 21:35:56 +00001917 /* EVIDENCE-OF: R-58015-48175 The two-byte integer at offset 5 designates
1918 ** the start of the cell content area. A zero value for this integer is
1919 ** interpreted as 65536. */
1920 top = get2byteNotZero(&data[hdr+5]);
drhb0ea9432019-02-09 21:06:40 +00001921 iCellFirst = hdr + 8 + pPage->childPtrSize + 2*pPage->nCell;
drh14e845a2017-05-25 21:35:56 +00001922 iCellLast = usableSize - 4;
danielk197793c829c2009-06-03 17:26:17 +00001923
drh14e845a2017-05-25 21:35:56 +00001924 /* Compute the total free space on the page
1925 ** EVIDENCE-OF: R-23588-34450 The two-byte integer at offset 1 gives the
1926 ** start of the first freeblock on the page, or is zero if there are no
1927 ** freeblocks. */
1928 pc = get2byte(&data[hdr+1]);
1929 nFree = data[hdr+7] + top; /* Init nFree to non-freeblock free space */
1930 if( pc>0 ){
1931 u32 next, size;
dan9a20ea92020-01-03 15:51:23 +00001932 if( pc<top ){
drh14e845a2017-05-25 21:35:56 +00001933 /* EVIDENCE-OF: R-55530-52930 In a well-formed b-tree page, there will
1934 ** always be at least one cell before the first freeblock.
1935 */
daneebf2f52017-11-18 17:30:08 +00001936 return SQLITE_CORRUPT_PAGE(pPage);
drhee696e22004-08-30 16:52:17 +00001937 }
drh14e845a2017-05-25 21:35:56 +00001938 while( 1 ){
1939 if( pc>iCellLast ){
drhcc97ca42017-06-07 22:32:59 +00001940 /* Freeblock off the end of the page */
daneebf2f52017-11-18 17:30:08 +00001941 return SQLITE_CORRUPT_PAGE(pPage);
drh14e845a2017-05-25 21:35:56 +00001942 }
1943 next = get2byte(&data[pc]);
1944 size = get2byte(&data[pc+2]);
1945 nFree = nFree + size;
1946 if( next<=pc+size+3 ) break;
1947 pc = next;
1948 }
1949 if( next>0 ){
drhcc97ca42017-06-07 22:32:59 +00001950 /* Freeblock not in ascending order */
daneebf2f52017-11-18 17:30:08 +00001951 return SQLITE_CORRUPT_PAGE(pPage);
drh14e845a2017-05-25 21:35:56 +00001952 }
1953 if( pc+size>(unsigned int)usableSize ){
drhcc97ca42017-06-07 22:32:59 +00001954 /* Last freeblock extends past page end */
daneebf2f52017-11-18 17:30:08 +00001955 return SQLITE_CORRUPT_PAGE(pPage);
drh14e845a2017-05-25 21:35:56 +00001956 }
danielk197771d5d2c2008-09-29 11:49:47 +00001957 }
drh14e845a2017-05-25 21:35:56 +00001958
1959 /* At this point, nFree contains the sum of the offset to the start
1960 ** of the cell-content area plus the number of free bytes within
1961 ** the cell-content area. If this is greater than the usable-size
1962 ** of the page, then the page must be corrupted. This check also
1963 ** serves to verify that the offset to the start of the cell-content
1964 ** area, according to the page header, lies within the page.
1965 */
drhdfcecdf2019-05-08 00:17:45 +00001966 if( nFree>usableSize || nFree<iCellFirst ){
daneebf2f52017-11-18 17:30:08 +00001967 return SQLITE_CORRUPT_PAGE(pPage);
drh14e845a2017-05-25 21:35:56 +00001968 }
1969 pPage->nFree = (u16)(nFree - iCellFirst);
drhb0ea9432019-02-09 21:06:40 +00001970 return SQLITE_OK;
1971}
1972
1973/*
drh5860a612019-02-12 16:58:26 +00001974** Do additional sanity check after btreeInitPage() if
1975** PRAGMA cell_size_check=ON
1976*/
1977static SQLITE_NOINLINE int btreeCellSizeCheck(MemPage *pPage){
1978 int iCellFirst; /* First allowable cell or freeblock offset */
1979 int iCellLast; /* Last possible cell or freeblock offset */
1980 int i; /* Index into the cell pointer array */
1981 int sz; /* Size of a cell */
1982 int pc; /* Address of a freeblock within pPage->aData[] */
1983 u8 *data; /* Equal to pPage->aData */
1984 int usableSize; /* Maximum usable space on the page */
1985 int cellOffset; /* Start of cell content area */
1986
1987 iCellFirst = pPage->cellOffset + 2*pPage->nCell;
1988 usableSize = pPage->pBt->usableSize;
1989 iCellLast = usableSize - 4;
1990 data = pPage->aData;
1991 cellOffset = pPage->cellOffset;
1992 if( !pPage->leaf ) iCellLast--;
1993 for(i=0; i<pPage->nCell; i++){
1994 pc = get2byteAligned(&data[cellOffset+i*2]);
1995 testcase( pc==iCellFirst );
1996 testcase( pc==iCellLast );
1997 if( pc<iCellFirst || pc>iCellLast ){
1998 return SQLITE_CORRUPT_PAGE(pPage);
1999 }
2000 sz = pPage->xCellSize(pPage, &data[pc]);
2001 testcase( pc+sz==usableSize );
2002 if( pc+sz>usableSize ){
2003 return SQLITE_CORRUPT_PAGE(pPage);
2004 }
2005 }
2006 return SQLITE_OK;
2007}
2008
2009/*
drhb0ea9432019-02-09 21:06:40 +00002010** Initialize the auxiliary information for a disk block.
2011**
2012** Return SQLITE_OK on success. If we see that the page does
2013** not contain a well-formed database page, then return
2014** SQLITE_CORRUPT. Note that a return of SQLITE_OK does not
2015** guarantee that the page is well-formed. It only shows that
2016** we failed to detect any corruption.
2017*/
2018static int btreeInitPage(MemPage *pPage){
drhb0ea9432019-02-09 21:06:40 +00002019 u8 *data; /* Equal to pPage->aData */
2020 BtShared *pBt; /* The main btree structure */
drhb0ea9432019-02-09 21:06:40 +00002021
2022 assert( pPage->pBt!=0 );
2023 assert( pPage->pBt->db!=0 );
2024 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
2025 assert( pPage->pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
2026 assert( pPage == sqlite3PagerGetExtra(pPage->pDbPage) );
2027 assert( pPage->aData == sqlite3PagerGetData(pPage->pDbPage) );
2028 assert( pPage->isInit==0 );
2029
2030 pBt = pPage->pBt;
drh5860a612019-02-12 16:58:26 +00002031 data = pPage->aData + pPage->hdrOffset;
drhb0ea9432019-02-09 21:06:40 +00002032 /* EVIDENCE-OF: R-28594-02890 The one-byte flag at offset 0 indicating
2033 ** the b-tree page type. */
drh5860a612019-02-12 16:58:26 +00002034 if( decodeFlags(pPage, data[0]) ){
drhb0ea9432019-02-09 21:06:40 +00002035 return SQLITE_CORRUPT_PAGE(pPage);
2036 }
2037 assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
2038 pPage->maskPage = (u16)(pBt->pageSize - 1);
2039 pPage->nOverflow = 0;
drh5860a612019-02-12 16:58:26 +00002040 pPage->cellOffset = pPage->hdrOffset + 8 + pPage->childPtrSize;
2041 pPage->aCellIdx = data + pPage->childPtrSize + 8;
2042 pPage->aDataEnd = pPage->aData + pBt->usableSize;
2043 pPage->aDataOfst = pPage->aData + pPage->childPtrSize;
drhb0ea9432019-02-09 21:06:40 +00002044 /* EVIDENCE-OF: R-37002-32774 The two-byte integer at offset 3 gives the
2045 ** number of cells on the page. */
drh5860a612019-02-12 16:58:26 +00002046 pPage->nCell = get2byte(&data[3]);
drhb0ea9432019-02-09 21:06:40 +00002047 if( pPage->nCell>MX_CELL(pBt) ){
2048 /* To many cells for a single page. The page must be corrupt */
2049 return SQLITE_CORRUPT_PAGE(pPage);
2050 }
2051 testcase( pPage->nCell==MX_CELL(pBt) );
2052 /* EVIDENCE-OF: R-24089-57979 If a page contains no cells (which is only
2053 ** possible for a root page of a table that contains no rows) then the
2054 ** offset to the cell content area will equal the page size minus the
2055 ** bytes of reserved space. */
2056 assert( pPage->nCell>0
mistachkin065f3bf2019-03-20 05:45:03 +00002057 || get2byteNotZero(&data[5])==(int)pBt->usableSize
drhb0ea9432019-02-09 21:06:40 +00002058 || CORRUPT_DB );
drhb0ea9432019-02-09 21:06:40 +00002059 pPage->nFree = -1; /* Indicate that this value is yet uncomputed */
drh14e845a2017-05-25 21:35:56 +00002060 pPage->isInit = 1;
drh5860a612019-02-12 16:58:26 +00002061 if( pBt->db->flags & SQLITE_CellSizeCk ){
2062 return btreeCellSizeCheck(pPage);
2063 }
drh9e572e62004-04-23 23:43:10 +00002064 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002065}
2066
2067/*
drh8b2f49b2001-06-08 00:21:52 +00002068** Set up a raw page so that it looks like a database page holding
2069** no entries.
drhbd03cae2001-06-02 02:40:57 +00002070*/
drh9e572e62004-04-23 23:43:10 +00002071static void zeroPage(MemPage *pPage, int flags){
2072 unsigned char *data = pPage->aData;
danielk1977aef0bf62005-12-30 16:28:01 +00002073 BtShared *pBt = pPage->pBt;
drhf49661a2008-12-10 16:45:50 +00002074 u8 hdr = pPage->hdrOffset;
2075 u16 first;
drh9e572e62004-04-23 23:43:10 +00002076
danielk19773b8a05f2007-03-19 17:44:26 +00002077 assert( sqlite3PagerPagenumber(pPage->pDbPage)==pPage->pgno );
drhbf4bca52007-09-06 22:19:14 +00002078 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
2079 assert( sqlite3PagerGetData(pPage->pDbPage) == data );
danielk19773b8a05f2007-03-19 17:44:26 +00002080 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00002081 assert( sqlite3_mutex_held(pBt->mutex) );
drha5907a82017-06-19 11:44:22 +00002082 if( pBt->btsFlags & BTS_FAST_SECURE ){
drh5b47efa2010-02-12 18:18:39 +00002083 memset(&data[hdr], 0, pBt->usableSize - hdr);
2084 }
drh1bd10f82008-12-10 21:19:56 +00002085 data[hdr] = (char)flags;
drhfe485992014-02-12 23:52:16 +00002086 first = hdr + ((flags&PTF_LEAF)==0 ? 12 : 8);
drh43605152004-05-29 21:46:49 +00002087 memset(&data[hdr+1], 0, 4);
2088 data[hdr+7] = 0;
2089 put2byte(&data[hdr+5], pBt->usableSize);
shaneh1df2db72010-08-18 02:28:48 +00002090 pPage->nFree = (u16)(pBt->usableSize - first);
drh271efa52004-05-30 19:19:05 +00002091 decodeFlags(pPage, flags);
drh43605152004-05-29 21:46:49 +00002092 pPage->cellOffset = first;
drh3def2352011-11-11 00:27:15 +00002093 pPage->aDataEnd = &data[pBt->usableSize];
2094 pPage->aCellIdx = &data[first];
drhf44890a2015-06-27 03:58:15 +00002095 pPage->aDataOfst = &data[pPage->childPtrSize];
drh43605152004-05-29 21:46:49 +00002096 pPage->nOverflow = 0;
drhb2eced52010-08-12 02:41:12 +00002097 assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
2098 pPage->maskPage = (u16)(pBt->pageSize - 1);
drh43605152004-05-29 21:46:49 +00002099 pPage->nCell = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00002100 pPage->isInit = 1;
drhbd03cae2001-06-02 02:40:57 +00002101}
2102
drh897a8202008-09-18 01:08:15 +00002103
2104/*
2105** Convert a DbPage obtained from the pager into a MemPage used by
2106** the btree layer.
2107*/
2108static MemPage *btreePageFromDbPage(DbPage *pDbPage, Pgno pgno, BtShared *pBt){
2109 MemPage *pPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
drh8dd1c252015-11-04 22:31:02 +00002110 if( pgno!=pPage->pgno ){
2111 pPage->aData = sqlite3PagerGetData(pDbPage);
2112 pPage->pDbPage = pDbPage;
2113 pPage->pBt = pBt;
2114 pPage->pgno = pgno;
2115 pPage->hdrOffset = pgno==1 ? 100 : 0;
2116 }
2117 assert( pPage->aData==sqlite3PagerGetData(pDbPage) );
drh897a8202008-09-18 01:08:15 +00002118 return pPage;
2119}
2120
drhbd03cae2001-06-02 02:40:57 +00002121/*
drh3aac2dd2004-04-26 14:10:20 +00002122** Get a page from the pager. Initialize the MemPage.pBt and
drh7e8c6f12015-05-28 03:28:27 +00002123** MemPage.aData elements if needed. See also: btreeGetUnusedPage().
drh538f5702007-04-13 02:14:30 +00002124**
drh7e8c6f12015-05-28 03:28:27 +00002125** If the PAGER_GET_NOCONTENT flag is set, it means that we do not care
2126** about the content of the page at this time. So do not go to the disk
drh538f5702007-04-13 02:14:30 +00002127** to fetch the content. Just fill in the content with zeros for now.
2128** If in the future we call sqlite3PagerWrite() on this page, that
2129** means we have started to be concerned about content and the disk
2130** read should occur at that point.
drh3aac2dd2004-04-26 14:10:20 +00002131*/
danielk197730548662009-07-09 05:07:37 +00002132static int btreeGetPage(
drh16a9b832007-05-05 18:39:25 +00002133 BtShared *pBt, /* The btree */
2134 Pgno pgno, /* Number of the page to fetch */
2135 MemPage **ppPage, /* Return the page in this parameter */
drhb00fc3b2013-08-21 23:42:32 +00002136 int flags /* PAGER_GET_NOCONTENT or PAGER_GET_READONLY */
drh16a9b832007-05-05 18:39:25 +00002137){
drh3aac2dd2004-04-26 14:10:20 +00002138 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00002139 DbPage *pDbPage;
2140
drhb00fc3b2013-08-21 23:42:32 +00002141 assert( flags==0 || flags==PAGER_GET_NOCONTENT || flags==PAGER_GET_READONLY );
drh1fee73e2007-08-29 04:00:57 +00002142 assert( sqlite3_mutex_held(pBt->mutex) );
drh9584f582015-11-04 20:22:37 +00002143 rc = sqlite3PagerGet(pBt->pPager, pgno, (DbPage**)&pDbPage, flags);
drh3aac2dd2004-04-26 14:10:20 +00002144 if( rc ) return rc;
drh897a8202008-09-18 01:08:15 +00002145 *ppPage = btreePageFromDbPage(pDbPage, pgno, pBt);
drh3aac2dd2004-04-26 14:10:20 +00002146 return SQLITE_OK;
2147}
2148
2149/*
danielk1977bea2a942009-01-20 17:06:27 +00002150** Retrieve a page from the pager cache. If the requested page is not
2151** already in the pager cache return NULL. Initialize the MemPage.pBt and
2152** MemPage.aData elements if needed.
2153*/
2154static MemPage *btreePageLookup(BtShared *pBt, Pgno pgno){
2155 DbPage *pDbPage;
2156 assert( sqlite3_mutex_held(pBt->mutex) );
2157 pDbPage = sqlite3PagerLookup(pBt->pPager, pgno);
2158 if( pDbPage ){
2159 return btreePageFromDbPage(pDbPage, pgno, pBt);
2160 }
2161 return 0;
2162}
2163
2164/*
danielk197789d40042008-11-17 14:20:56 +00002165** Return the size of the database file in pages. If there is any kind of
2166** error, return ((unsigned int)-1).
danielk197767fd7a92008-09-10 17:53:35 +00002167*/
drhb1299152010-03-30 22:58:33 +00002168static Pgno btreePagecount(BtShared *pBt){
drh406dfcb2020-01-07 18:10:01 +00002169 return pBt->nPage;
drhb1299152010-03-30 22:58:33 +00002170}
drh584e8b72020-07-22 17:12:59 +00002171Pgno sqlite3BtreeLastPage(Btree *p){
drhb1299152010-03-30 22:58:33 +00002172 assert( sqlite3BtreeHoldsMutex(p) );
drh584e8b72020-07-22 17:12:59 +00002173 return btreePagecount(p->pBt);
danielk197767fd7a92008-09-10 17:53:35 +00002174}
2175
2176/*
drh28f58dd2015-06-27 19:45:03 +00002177** Get a page from the pager and initialize it.
danielk197789bc4bc2009-07-21 19:25:24 +00002178**
drh15a00212015-06-27 20:55:00 +00002179** If pCur!=0 then the page is being fetched as part of a moveToChild()
2180** call. Do additional sanity checking on the page in this case.
2181** And if the fetch fails, this routine must decrement pCur->iPage.
drh28f58dd2015-06-27 19:45:03 +00002182**
2183** The page is fetched as read-write unless pCur is not NULL and is
2184** a read-only cursor.
2185**
2186** If an error occurs, then *ppPage is undefined. It
danielk197789bc4bc2009-07-21 19:25:24 +00002187** may remain unchanged, or it may be set to an invalid value.
drhde647132004-05-07 17:57:49 +00002188*/
2189static int getAndInitPage(
dan11dcd112013-03-15 18:29:18 +00002190 BtShared *pBt, /* The database file */
2191 Pgno pgno, /* Number of the page to get */
2192 MemPage **ppPage, /* Write the page pointer here */
drh28f58dd2015-06-27 19:45:03 +00002193 BtCursor *pCur, /* Cursor to receive the page, or NULL */
2194 int bReadOnly /* True for a read-only page */
drhde647132004-05-07 17:57:49 +00002195){
2196 int rc;
drh28f58dd2015-06-27 19:45:03 +00002197 DbPage *pDbPage;
drh1fee73e2007-08-29 04:00:57 +00002198 assert( sqlite3_mutex_held(pBt->mutex) );
drh352a35a2017-08-15 03:46:47 +00002199 assert( pCur==0 || ppPage==&pCur->pPage );
drh28f58dd2015-06-27 19:45:03 +00002200 assert( pCur==0 || bReadOnly==pCur->curPagerFlags );
drh15a00212015-06-27 20:55:00 +00002201 assert( pCur==0 || pCur->iPage>0 );
danielk197789bc4bc2009-07-21 19:25:24 +00002202
danba3cbf32010-06-30 04:29:03 +00002203 if( pgno>btreePagecount(pBt) ){
2204 rc = SQLITE_CORRUPT_BKPT;
drhb0ea9432019-02-09 21:06:40 +00002205 goto getAndInitPage_error1;
drh28f58dd2015-06-27 19:45:03 +00002206 }
drh9584f582015-11-04 20:22:37 +00002207 rc = sqlite3PagerGet(pBt->pPager, pgno, (DbPage**)&pDbPage, bReadOnly);
drh28f58dd2015-06-27 19:45:03 +00002208 if( rc ){
drhb0ea9432019-02-09 21:06:40 +00002209 goto getAndInitPage_error1;
drh28f58dd2015-06-27 19:45:03 +00002210 }
drh8dd1c252015-11-04 22:31:02 +00002211 *ppPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
drh28f58dd2015-06-27 19:45:03 +00002212 if( (*ppPage)->isInit==0 ){
drh8dd1c252015-11-04 22:31:02 +00002213 btreePageFromDbPage(pDbPage, pgno, pBt);
drh28f58dd2015-06-27 19:45:03 +00002214 rc = btreeInitPage(*ppPage);
2215 if( rc!=SQLITE_OK ){
drhb0ea9432019-02-09 21:06:40 +00002216 goto getAndInitPage_error2;
danielk197789bc4bc2009-07-21 19:25:24 +00002217 }
drhee696e22004-08-30 16:52:17 +00002218 }
drh8dd1c252015-11-04 22:31:02 +00002219 assert( (*ppPage)->pgno==pgno );
2220 assert( (*ppPage)->aData==sqlite3PagerGetData(pDbPage) );
danba3cbf32010-06-30 04:29:03 +00002221
drh15a00212015-06-27 20:55:00 +00002222 /* If obtaining a child page for a cursor, we must verify that the page is
2223 ** compatible with the root page. */
drh8dd1c252015-11-04 22:31:02 +00002224 if( pCur && ((*ppPage)->nCell<1 || (*ppPage)->intKey!=pCur->curIntKey) ){
drhcc97ca42017-06-07 22:32:59 +00002225 rc = SQLITE_CORRUPT_PGNO(pgno);
drhb0ea9432019-02-09 21:06:40 +00002226 goto getAndInitPage_error2;
drh28f58dd2015-06-27 19:45:03 +00002227 }
drh28f58dd2015-06-27 19:45:03 +00002228 return SQLITE_OK;
2229
drhb0ea9432019-02-09 21:06:40 +00002230getAndInitPage_error2:
2231 releasePage(*ppPage);
2232getAndInitPage_error1:
drh352a35a2017-08-15 03:46:47 +00002233 if( pCur ){
2234 pCur->iPage--;
2235 pCur->pPage = pCur->apPage[pCur->iPage];
2236 }
danba3cbf32010-06-30 04:29:03 +00002237 testcase( pgno==0 );
2238 assert( pgno!=0 || rc==SQLITE_CORRUPT );
drhde647132004-05-07 17:57:49 +00002239 return rc;
2240}
2241
2242/*
drh3aac2dd2004-04-26 14:10:20 +00002243** Release a MemPage. This should be called once for each prior
danielk197730548662009-07-09 05:07:37 +00002244** call to btreeGetPage.
drh3908fe92017-09-01 14:50:19 +00002245**
2246** Page1 is a special case and must be released using releasePageOne().
drh3aac2dd2004-04-26 14:10:20 +00002247*/
drhbbf0f862015-06-27 14:59:26 +00002248static void releasePageNotNull(MemPage *pPage){
2249 assert( pPage->aData );
2250 assert( pPage->pBt );
2251 assert( pPage->pDbPage!=0 );
2252 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
2253 assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
2254 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
2255 sqlite3PagerUnrefNotNull(pPage->pDbPage);
drh3aac2dd2004-04-26 14:10:20 +00002256}
drh3aac2dd2004-04-26 14:10:20 +00002257static void releasePage(MemPage *pPage){
drhbbf0f862015-06-27 14:59:26 +00002258 if( pPage ) releasePageNotNull(pPage);
drh3aac2dd2004-04-26 14:10:20 +00002259}
drh3908fe92017-09-01 14:50:19 +00002260static void releasePageOne(MemPage *pPage){
2261 assert( pPage!=0 );
2262 assert( pPage->aData );
2263 assert( pPage->pBt );
2264 assert( pPage->pDbPage!=0 );
2265 assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
2266 assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
2267 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
2268 sqlite3PagerUnrefPageOne(pPage->pDbPage);
2269}
drh3aac2dd2004-04-26 14:10:20 +00002270
2271/*
drh7e8c6f12015-05-28 03:28:27 +00002272** Get an unused page.
2273**
2274** This works just like btreeGetPage() with the addition:
2275**
2276** * If the page is already in use for some other purpose, immediately
2277** release it and return an SQLITE_CURRUPT error.
2278** * Make sure the isInit flag is clear
2279*/
2280static int btreeGetUnusedPage(
2281 BtShared *pBt, /* The btree */
2282 Pgno pgno, /* Number of the page to fetch */
2283 MemPage **ppPage, /* Return the page in this parameter */
2284 int flags /* PAGER_GET_NOCONTENT or PAGER_GET_READONLY */
2285){
2286 int rc = btreeGetPage(pBt, pgno, ppPage, flags);
2287 if( rc==SQLITE_OK ){
2288 if( sqlite3PagerPageRefcount((*ppPage)->pDbPage)>1 ){
2289 releasePage(*ppPage);
2290 *ppPage = 0;
2291 return SQLITE_CORRUPT_BKPT;
2292 }
2293 (*ppPage)->isInit = 0;
2294 }else{
2295 *ppPage = 0;
2296 }
2297 return rc;
2298}
2299
drha059ad02001-04-17 20:09:11 +00002300
2301/*
drha6abd042004-06-09 17:37:22 +00002302** During a rollback, when the pager reloads information into the cache
2303** so that the cache is restored to its original state at the start of
2304** the transaction, for each page restored this routine is called.
2305**
2306** This routine needs to reset the extra data section at the end of the
2307** page to agree with the restored data.
2308*/
danielk1977eaa06f62008-09-18 17:34:44 +00002309static void pageReinit(DbPage *pData){
drh07d183d2005-05-01 22:52:42 +00002310 MemPage *pPage;
danielk19773b8a05f2007-03-19 17:44:26 +00002311 pPage = (MemPage *)sqlite3PagerGetExtra(pData);
danielk1977d217e6f2009-04-01 17:13:51 +00002312 assert( sqlite3PagerPageRefcount(pData)>0 );
danielk197771d5d2c2008-09-29 11:49:47 +00002313 if( pPage->isInit ){
drh1fee73e2007-08-29 04:00:57 +00002314 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drha6abd042004-06-09 17:37:22 +00002315 pPage->isInit = 0;
danielk1977d217e6f2009-04-01 17:13:51 +00002316 if( sqlite3PagerPageRefcount(pData)>1 ){
drh5e8d8872009-03-30 17:19:48 +00002317 /* pPage might not be a btree page; it might be an overflow page
2318 ** or ptrmap page or a free page. In those cases, the following
danielk197730548662009-07-09 05:07:37 +00002319 ** call to btreeInitPage() will likely return SQLITE_CORRUPT.
drh5e8d8872009-03-30 17:19:48 +00002320 ** But no harm is done by this. And it is very important that
danielk197730548662009-07-09 05:07:37 +00002321 ** btreeInitPage() be called on every btree page so we make
drh5e8d8872009-03-30 17:19:48 +00002322 ** the call for every page that comes in for re-initing. */
danielk197730548662009-07-09 05:07:37 +00002323 btreeInitPage(pPage);
danielk197771d5d2c2008-09-29 11:49:47 +00002324 }
drha6abd042004-06-09 17:37:22 +00002325 }
2326}
2327
2328/*
drhe5fe6902007-12-07 18:55:28 +00002329** Invoke the busy handler for a btree.
2330*/
danielk19771ceedd32008-11-19 10:22:33 +00002331static int btreeInvokeBusyHandler(void *pArg){
drhe5fe6902007-12-07 18:55:28 +00002332 BtShared *pBt = (BtShared*)pArg;
2333 assert( pBt->db );
2334 assert( sqlite3_mutex_held(pBt->db->mutex) );
drh783e1592020-05-06 20:55:38 +00002335 return sqlite3InvokeBusyHandler(&pBt->db->busyHandler);
drhe5fe6902007-12-07 18:55:28 +00002336}
2337
2338/*
drhad3e0102004-09-03 23:32:18 +00002339** Open a database file.
2340**
drh382c0242001-10-06 16:33:02 +00002341** zFilename is the name of the database file. If zFilename is NULL
drh75c014c2010-08-30 15:02:28 +00002342** then an ephemeral database is created. The ephemeral database might
2343** be exclusively in memory, or it might use a disk-based memory cache.
2344** Either way, the ephemeral database will be automatically deleted
2345** when sqlite3BtreeClose() is called.
2346**
drhe53831d2007-08-17 01:14:38 +00002347** If zFilename is ":memory:" then an in-memory database is created
2348** that is automatically destroyed when it is closed.
drhc47fd8e2009-04-30 13:30:32 +00002349**
drh33f111d2012-01-17 15:29:14 +00002350** The "flags" parameter is a bitmask that might contain bits like
2351** BTREE_OMIT_JOURNAL and/or BTREE_MEMORY.
drh75c014c2010-08-30 15:02:28 +00002352**
drhc47fd8e2009-04-30 13:30:32 +00002353** If the database is already opened in the same database connection
2354** and we are in shared cache mode, then the open will fail with an
2355** SQLITE_CONSTRAINT error. We cannot allow two or more BtShared
2356** objects in the same database connection since doing so will lead
2357** to problems with locking.
drha059ad02001-04-17 20:09:11 +00002358*/
drh23e11ca2004-05-04 17:27:28 +00002359int sqlite3BtreeOpen(
dan3a6d8ae2011-04-23 15:54:54 +00002360 sqlite3_vfs *pVfs, /* VFS to use for this b-tree */
drh3aac2dd2004-04-26 14:10:20 +00002361 const char *zFilename, /* Name of the file containing the BTree database */
drhe5fe6902007-12-07 18:55:28 +00002362 sqlite3 *db, /* Associated database handle */
drh3aac2dd2004-04-26 14:10:20 +00002363 Btree **ppBtree, /* Pointer to new Btree object written here */
drh33f4e022007-09-03 15:19:34 +00002364 int flags, /* Options */
2365 int vfsFlags /* Flags passed through to sqlite3_vfs.xOpen() */
drh6019e162001-07-02 17:51:45 +00002366){
drh7555d8e2009-03-20 13:15:30 +00002367 BtShared *pBt = 0; /* Shared part of btree structure */
2368 Btree *p; /* Handle to return */
2369 sqlite3_mutex *mutexOpen = 0; /* Prevents a race condition. Ticket #3537 */
2370 int rc = SQLITE_OK; /* Result code from this function */
2371 u8 nReserve; /* Byte of unused space on each page */
2372 unsigned char zDbHeader[100]; /* Database header content */
danielk1977aef0bf62005-12-30 16:28:01 +00002373
drh75c014c2010-08-30 15:02:28 +00002374 /* True if opening an ephemeral, temporary database */
2375 const int isTempDb = zFilename==0 || zFilename[0]==0;
2376
danielk1977aef0bf62005-12-30 16:28:01 +00002377 /* Set the variable isMemdb to true for an in-memory database, or
drhb0a7c9c2010-12-06 21:09:59 +00002378 ** false for a file-based database.
danielk1977aef0bf62005-12-30 16:28:01 +00002379 */
drhb0a7c9c2010-12-06 21:09:59 +00002380#ifdef SQLITE_OMIT_MEMORYDB
2381 const int isMemdb = 0;
2382#else
2383 const int isMemdb = (zFilename && strcmp(zFilename, ":memory:")==0)
drh9c67b2a2012-05-28 13:58:00 +00002384 || (isTempDb && sqlite3TempInMemory(db))
2385 || (vfsFlags & SQLITE_OPEN_MEMORY)!=0;
danielk1977aef0bf62005-12-30 16:28:01 +00002386#endif
2387
drhe5fe6902007-12-07 18:55:28 +00002388 assert( db!=0 );
dan3a6d8ae2011-04-23 15:54:54 +00002389 assert( pVfs!=0 );
drhe5fe6902007-12-07 18:55:28 +00002390 assert( sqlite3_mutex_held(db->mutex) );
drhd4187c72010-08-30 22:15:45 +00002391 assert( (flags&0xff)==flags ); /* flags fit in 8 bits */
2392
2393 /* Only a BTREE_SINGLE database can be BTREE_UNORDERED */
2394 assert( (flags & BTREE_UNORDERED)==0 || (flags & BTREE_SINGLE)!=0 );
2395
2396 /* A BTREE_SINGLE database is always a temporary and/or ephemeral */
2397 assert( (flags & BTREE_SINGLE)==0 || isTempDb );
drh153c62c2007-08-24 03:51:33 +00002398
drh75c014c2010-08-30 15:02:28 +00002399 if( isMemdb ){
2400 flags |= BTREE_MEMORY;
2401 }
2402 if( (vfsFlags & SQLITE_OPEN_MAIN_DB)!=0 && (isMemdb || isTempDb) ){
2403 vfsFlags = (vfsFlags & ~SQLITE_OPEN_MAIN_DB) | SQLITE_OPEN_TEMP_DB;
2404 }
drh17435752007-08-16 04:30:38 +00002405 p = sqlite3MallocZero(sizeof(Btree));
danielk1977aef0bf62005-12-30 16:28:01 +00002406 if( !p ){
mistachkinfad30392016-02-13 23:43:46 +00002407 return SQLITE_NOMEM_BKPT;
danielk1977aef0bf62005-12-30 16:28:01 +00002408 }
2409 p->inTrans = TRANS_NONE;
drhe5fe6902007-12-07 18:55:28 +00002410 p->db = db;
danielk1977602b4662009-07-02 07:47:33 +00002411#ifndef SQLITE_OMIT_SHARED_CACHE
2412 p->lock.pBtree = p;
2413 p->lock.iTable = 1;
2414#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002415
drh198bf392006-01-06 21:52:49 +00002416#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00002417 /*
2418 ** If this Btree is a candidate for shared cache, try to find an
2419 ** existing BtShared object that we can share with
2420 */
drh4ab9d252012-05-26 20:08:49 +00002421 if( isTempDb==0 && (isMemdb==0 || (vfsFlags&SQLITE_OPEN_URI)!=0) ){
drhf1f12682009-09-09 14:17:52 +00002422 if( vfsFlags & SQLITE_OPEN_SHAREDCACHE ){
drh6b5f0eb2015-03-31 16:33:08 +00002423 int nFilename = sqlite3Strlen30(zFilename)+1;
danielk1977adfb9b02007-09-17 07:02:56 +00002424 int nFullPathname = pVfs->mxPathname+1;
drh6b5f0eb2015-03-31 16:33:08 +00002425 char *zFullPathname = sqlite3Malloc(MAX(nFullPathname,nFilename));
drh30ddce62011-10-15 00:16:30 +00002426 MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
drh6b5f0eb2015-03-31 16:33:08 +00002427
drhff0587c2007-08-29 17:43:19 +00002428 p->sharable = 1;
drhff0587c2007-08-29 17:43:19 +00002429 if( !zFullPathname ){
2430 sqlite3_free(p);
mistachkinfad30392016-02-13 23:43:46 +00002431 return SQLITE_NOMEM_BKPT;
drhff0587c2007-08-29 17:43:19 +00002432 }
drhafc8b7f2012-05-26 18:06:38 +00002433 if( isMemdb ){
drh6b5f0eb2015-03-31 16:33:08 +00002434 memcpy(zFullPathname, zFilename, nFilename);
drhafc8b7f2012-05-26 18:06:38 +00002435 }else{
2436 rc = sqlite3OsFullPathname(pVfs, zFilename,
2437 nFullPathname, zFullPathname);
2438 if( rc ){
drhc398c652019-11-22 00:42:01 +00002439 if( rc==SQLITE_OK_SYMLINK ){
2440 rc = SQLITE_OK;
2441 }else{
2442 sqlite3_free(zFullPathname);
2443 sqlite3_free(p);
2444 return rc;
2445 }
drhafc8b7f2012-05-26 18:06:38 +00002446 }
drh070ad6b2011-11-17 11:43:19 +00002447 }
drh30ddce62011-10-15 00:16:30 +00002448#if SQLITE_THREADSAFE
drh7555d8e2009-03-20 13:15:30 +00002449 mutexOpen = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_OPEN);
2450 sqlite3_mutex_enter(mutexOpen);
drhccb21132020-06-19 11:34:57 +00002451 mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN);
drhff0587c2007-08-29 17:43:19 +00002452 sqlite3_mutex_enter(mutexShared);
drh30ddce62011-10-15 00:16:30 +00002453#endif
drh78f82d12008-09-02 00:52:52 +00002454 for(pBt=GLOBAL(BtShared*,sqlite3SharedCacheList); pBt; pBt=pBt->pNext){
drhff0587c2007-08-29 17:43:19 +00002455 assert( pBt->nRef>0 );
drhd4e0bb02012-05-27 01:19:04 +00002456 if( 0==strcmp(zFullPathname, sqlite3PagerFilename(pBt->pPager, 0))
drhff0587c2007-08-29 17:43:19 +00002457 && sqlite3PagerVfs(pBt->pPager)==pVfs ){
drhc47fd8e2009-04-30 13:30:32 +00002458 int iDb;
2459 for(iDb=db->nDb-1; iDb>=0; iDb--){
2460 Btree *pExisting = db->aDb[iDb].pBt;
2461 if( pExisting && pExisting->pBt==pBt ){
2462 sqlite3_mutex_leave(mutexShared);
2463 sqlite3_mutex_leave(mutexOpen);
2464 sqlite3_free(zFullPathname);
2465 sqlite3_free(p);
2466 return SQLITE_CONSTRAINT;
2467 }
2468 }
drhff0587c2007-08-29 17:43:19 +00002469 p->pBt = pBt;
2470 pBt->nRef++;
2471 break;
2472 }
2473 }
2474 sqlite3_mutex_leave(mutexShared);
2475 sqlite3_free(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00002476 }
drhff0587c2007-08-29 17:43:19 +00002477#ifdef SQLITE_DEBUG
2478 else{
2479 /* In debug mode, we mark all persistent databases as sharable
2480 ** even when they are not. This exercises the locking code and
2481 ** gives more opportunity for asserts(sqlite3_mutex_held())
2482 ** statements to find locking problems.
2483 */
2484 p->sharable = 1;
2485 }
2486#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002487 }
2488#endif
drha059ad02001-04-17 20:09:11 +00002489 if( pBt==0 ){
drhe53831d2007-08-17 01:14:38 +00002490 /*
2491 ** The following asserts make sure that structures used by the btree are
2492 ** the right size. This is to guard against size changes that result
2493 ** when compiling on a different architecture.
danielk197703aded42004-11-22 05:26:27 +00002494 */
drh062cf272015-03-23 19:03:51 +00002495 assert( sizeof(i64)==8 );
2496 assert( sizeof(u64)==8 );
drhe53831d2007-08-17 01:14:38 +00002497 assert( sizeof(u32)==4 );
2498 assert( sizeof(u16)==2 );
2499 assert( sizeof(Pgno)==4 );
2500
2501 pBt = sqlite3MallocZero( sizeof(*pBt) );
2502 if( pBt==0 ){
mistachkinfad30392016-02-13 23:43:46 +00002503 rc = SQLITE_NOMEM_BKPT;
drhe53831d2007-08-17 01:14:38 +00002504 goto btree_open_out;
2505 }
danielk197771d5d2c2008-09-29 11:49:47 +00002506 rc = sqlite3PagerOpen(pVfs, &pBt->pPager, zFilename,
drha2ee5892016-12-09 16:02:00 +00002507 sizeof(MemPage), flags, vfsFlags, pageReinit);
drhe53831d2007-08-17 01:14:38 +00002508 if( rc==SQLITE_OK ){
drh9b4c59f2013-04-15 17:03:42 +00002509 sqlite3PagerSetMmapLimit(pBt->pPager, db->szMmap);
drhe53831d2007-08-17 01:14:38 +00002510 rc = sqlite3PagerReadFileheader(pBt->pPager,sizeof(zDbHeader),zDbHeader);
2511 }
2512 if( rc!=SQLITE_OK ){
2513 goto btree_open_out;
2514 }
shanehbd2aaf92010-09-01 02:38:21 +00002515 pBt->openFlags = (u8)flags;
danielk19772a50ff02009-04-10 09:47:06 +00002516 pBt->db = db;
drh80262892018-03-26 16:37:53 +00002517 sqlite3PagerSetBusyHandler(pBt->pPager, btreeInvokeBusyHandler, pBt);
drhe53831d2007-08-17 01:14:38 +00002518 p->pBt = pBt;
2519
drhe53831d2007-08-17 01:14:38 +00002520 pBt->pCursor = 0;
2521 pBt->pPage1 = 0;
drhc9166342012-01-05 23:32:06 +00002522 if( sqlite3PagerIsreadonly(pBt->pPager) ) pBt->btsFlags |= BTS_READ_ONLY;
drha5907a82017-06-19 11:44:22 +00002523#if defined(SQLITE_SECURE_DELETE)
drhc9166342012-01-05 23:32:06 +00002524 pBt->btsFlags |= BTS_SECURE_DELETE;
drha5907a82017-06-19 11:44:22 +00002525#elif defined(SQLITE_FAST_SECURE_DELETE)
2526 pBt->btsFlags |= BTS_OVERWRITE;
drh5b47efa2010-02-12 18:18:39 +00002527#endif
drh113762a2014-11-19 16:36:25 +00002528 /* EVIDENCE-OF: R-51873-39618 The page size for a database file is
2529 ** determined by the 2-byte integer located at an offset of 16 bytes from
2530 ** the beginning of the database file. */
drhb2eced52010-08-12 02:41:12 +00002531 pBt->pageSize = (zDbHeader[16]<<8) | (zDbHeader[17]<<16);
drhe53831d2007-08-17 01:14:38 +00002532 if( pBt->pageSize<512 || pBt->pageSize>SQLITE_MAX_PAGE_SIZE
2533 || ((pBt->pageSize-1)&pBt->pageSize)!=0 ){
danielk1977a1644fd2007-08-29 12:31:25 +00002534 pBt->pageSize = 0;
drhe53831d2007-08-17 01:14:38 +00002535#ifndef SQLITE_OMIT_AUTOVACUUM
2536 /* If the magic name ":memory:" will create an in-memory database, then
2537 ** leave the autoVacuum mode at 0 (do not auto-vacuum), even if
2538 ** SQLITE_DEFAULT_AUTOVACUUM is true. On the other hand, if
2539 ** SQLITE_OMIT_MEMORYDB has been defined, then ":memory:" is just a
2540 ** regular file-name. In this case the auto-vacuum applies as per normal.
2541 */
2542 if( zFilename && !isMemdb ){
2543 pBt->autoVacuum = (SQLITE_DEFAULT_AUTOVACUUM ? 1 : 0);
2544 pBt->incrVacuum = (SQLITE_DEFAULT_AUTOVACUUM==2 ? 1 : 0);
2545 }
2546#endif
2547 nReserve = 0;
2548 }else{
drh113762a2014-11-19 16:36:25 +00002549 /* EVIDENCE-OF: R-37497-42412 The size of the reserved region is
2550 ** determined by the one-byte unsigned integer found at an offset of 20
2551 ** into the database file header. */
drhe53831d2007-08-17 01:14:38 +00002552 nReserve = zDbHeader[20];
drhc9166342012-01-05 23:32:06 +00002553 pBt->btsFlags |= BTS_PAGESIZE_FIXED;
drhe53831d2007-08-17 01:14:38 +00002554#ifndef SQLITE_OMIT_AUTOVACUUM
2555 pBt->autoVacuum = (get4byte(&zDbHeader[36 + 4*4])?1:0);
2556 pBt->incrVacuum = (get4byte(&zDbHeader[36 + 7*4])?1:0);
2557#endif
2558 }
drhfa9601a2009-06-18 17:22:39 +00002559 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
drhc0b61812009-04-30 01:22:41 +00002560 if( rc ) goto btree_open_out;
drhe53831d2007-08-17 01:14:38 +00002561 pBt->usableSize = pBt->pageSize - nReserve;
2562 assert( (pBt->pageSize & 7)==0 ); /* 8-byte alignment of pageSize */
drhe53831d2007-08-17 01:14:38 +00002563
2564#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
2565 /* Add the new BtShared object to the linked list sharable BtShareds.
2566 */
dan272989b2016-07-06 10:12:02 +00002567 pBt->nRef = 1;
drhe53831d2007-08-17 01:14:38 +00002568 if( p->sharable ){
drh30ddce62011-10-15 00:16:30 +00002569 MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
drhccb21132020-06-19 11:34:57 +00002570 MUTEX_LOGIC( mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN);)
danielk1977075c23a2008-09-01 18:34:20 +00002571 if( SQLITE_THREADSAFE && sqlite3GlobalConfig.bCoreMutex ){
danielk197759f8c082008-06-18 17:09:10 +00002572 pBt->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_FAST);
drh3285db22007-09-03 22:00:39 +00002573 if( pBt->mutex==0 ){
mistachkinfad30392016-02-13 23:43:46 +00002574 rc = SQLITE_NOMEM_BKPT;
drh3285db22007-09-03 22:00:39 +00002575 goto btree_open_out;
2576 }
drhff0587c2007-08-29 17:43:19 +00002577 }
drhe53831d2007-08-17 01:14:38 +00002578 sqlite3_mutex_enter(mutexShared);
drh78f82d12008-09-02 00:52:52 +00002579 pBt->pNext = GLOBAL(BtShared*,sqlite3SharedCacheList);
2580 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt;
drhe53831d2007-08-17 01:14:38 +00002581 sqlite3_mutex_leave(mutexShared);
danielk1977951af802004-11-05 15:45:09 +00002582 }
drheee46cf2004-11-06 00:02:48 +00002583#endif
drh90f5ecb2004-07-22 01:19:35 +00002584 }
danielk1977aef0bf62005-12-30 16:28:01 +00002585
drhcfed7bc2006-03-13 14:28:05 +00002586#if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
drhe53831d2007-08-17 01:14:38 +00002587 /* If the new Btree uses a sharable pBtShared, then link the new
2588 ** Btree into the list of all sharable Btrees for the same connection.
drhabddb0c2007-08-20 13:14:28 +00002589 ** The list is kept in ascending order by pBt address.
danielk197754f01982006-01-18 15:25:17 +00002590 */
drhe53831d2007-08-17 01:14:38 +00002591 if( p->sharable ){
2592 int i;
2593 Btree *pSib;
drhe5fe6902007-12-07 18:55:28 +00002594 for(i=0; i<db->nDb; i++){
2595 if( (pSib = db->aDb[i].pBt)!=0 && pSib->sharable ){
drhe53831d2007-08-17 01:14:38 +00002596 while( pSib->pPrev ){ pSib = pSib->pPrev; }
drh3bfa7e82016-03-22 14:37:59 +00002597 if( (uptr)p->pBt<(uptr)pSib->pBt ){
drhe53831d2007-08-17 01:14:38 +00002598 p->pNext = pSib;
2599 p->pPrev = 0;
2600 pSib->pPrev = p;
2601 }else{
drh3bfa7e82016-03-22 14:37:59 +00002602 while( pSib->pNext && (uptr)pSib->pNext->pBt<(uptr)p->pBt ){
drhe53831d2007-08-17 01:14:38 +00002603 pSib = pSib->pNext;
2604 }
2605 p->pNext = pSib->pNext;
2606 p->pPrev = pSib;
2607 if( p->pNext ){
2608 p->pNext->pPrev = p;
2609 }
2610 pSib->pNext = p;
2611 }
2612 break;
2613 }
2614 }
danielk1977aef0bf62005-12-30 16:28:01 +00002615 }
danielk1977aef0bf62005-12-30 16:28:01 +00002616#endif
2617 *ppBtree = p;
danielk1977dddbcdc2007-04-26 14:42:34 +00002618
2619btree_open_out:
2620 if( rc!=SQLITE_OK ){
2621 if( pBt && pBt->pPager ){
dan7fb89902016-08-12 16:21:15 +00002622 sqlite3PagerClose(pBt->pPager, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00002623 }
drh17435752007-08-16 04:30:38 +00002624 sqlite3_free(pBt);
2625 sqlite3_free(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00002626 *ppBtree = 0;
drh75c014c2010-08-30 15:02:28 +00002627 }else{
dan0f5a1862016-08-13 14:30:23 +00002628 sqlite3_file *pFile;
2629
drh75c014c2010-08-30 15:02:28 +00002630 /* If the B-Tree was successfully opened, set the pager-cache size to the
2631 ** default value. Except, when opening on an existing shared pager-cache,
2632 ** do not change the pager-cache size.
2633 */
2634 if( sqlite3BtreeSchema(p, 0, 0)==0 ){
dan78f04752020-09-04 19:10:43 +00002635 sqlite3BtreeSetCacheSize(p, SQLITE_DEFAULT_CACHE_SIZE);
drh75c014c2010-08-30 15:02:28 +00002636 }
dan0f5a1862016-08-13 14:30:23 +00002637
2638 pFile = sqlite3PagerFile(pBt->pPager);
2639 if( pFile->pMethods ){
2640 sqlite3OsFileControlHint(pFile, SQLITE_FCNTL_PDB, (void*)&pBt->db);
2641 }
danielk1977dddbcdc2007-04-26 14:42:34 +00002642 }
drh7555d8e2009-03-20 13:15:30 +00002643 if( mutexOpen ){
2644 assert( sqlite3_mutex_held(mutexOpen) );
2645 sqlite3_mutex_leave(mutexOpen);
2646 }
dan272989b2016-07-06 10:12:02 +00002647 assert( rc!=SQLITE_OK || sqlite3BtreeConnectionCount(*ppBtree)>0 );
danielk1977dddbcdc2007-04-26 14:42:34 +00002648 return rc;
drha059ad02001-04-17 20:09:11 +00002649}
2650
2651/*
drhe53831d2007-08-17 01:14:38 +00002652** Decrement the BtShared.nRef counter. When it reaches zero,
2653** remove the BtShared structure from the sharing list. Return
2654** true if the BtShared.nRef counter reaches zero and return
2655** false if it is still positive.
2656*/
2657static int removeFromSharingList(BtShared *pBt){
2658#ifndef SQLITE_OMIT_SHARED_CACHE
drh067b92b2020-06-19 15:24:12 +00002659 MUTEX_LOGIC( sqlite3_mutex *pMainMtx; )
drhe53831d2007-08-17 01:14:38 +00002660 BtShared *pList;
2661 int removed = 0;
2662
drhd677b3d2007-08-20 22:48:41 +00002663 assert( sqlite3_mutex_notheld(pBt->mutex) );
drh067b92b2020-06-19 15:24:12 +00002664 MUTEX_LOGIC( pMainMtx = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN); )
2665 sqlite3_mutex_enter(pMainMtx);
drhe53831d2007-08-17 01:14:38 +00002666 pBt->nRef--;
2667 if( pBt->nRef<=0 ){
drh78f82d12008-09-02 00:52:52 +00002668 if( GLOBAL(BtShared*,sqlite3SharedCacheList)==pBt ){
2669 GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt->pNext;
drhe53831d2007-08-17 01:14:38 +00002670 }else{
drh78f82d12008-09-02 00:52:52 +00002671 pList = GLOBAL(BtShared*,sqlite3SharedCacheList);
drh34004ce2008-07-11 16:15:17 +00002672 while( ALWAYS(pList) && pList->pNext!=pBt ){
drhe53831d2007-08-17 01:14:38 +00002673 pList=pList->pNext;
2674 }
drh34004ce2008-07-11 16:15:17 +00002675 if( ALWAYS(pList) ){
drhe53831d2007-08-17 01:14:38 +00002676 pList->pNext = pBt->pNext;
2677 }
2678 }
drh3285db22007-09-03 22:00:39 +00002679 if( SQLITE_THREADSAFE ){
2680 sqlite3_mutex_free(pBt->mutex);
2681 }
drhe53831d2007-08-17 01:14:38 +00002682 removed = 1;
2683 }
drh067b92b2020-06-19 15:24:12 +00002684 sqlite3_mutex_leave(pMainMtx);
drhe53831d2007-08-17 01:14:38 +00002685 return removed;
2686#else
2687 return 1;
2688#endif
2689}
2690
2691/*
drhf7141992008-06-19 00:16:08 +00002692** Make sure pBt->pTmpSpace points to an allocation of
drh92787cf2014-10-15 11:55:51 +00002693** MX_CELL_SIZE(pBt) bytes with a 4-byte prefix for a left-child
2694** pointer.
drhf7141992008-06-19 00:16:08 +00002695*/
2696static void allocateTempSpace(BtShared *pBt){
2697 if( !pBt->pTmpSpace ){
2698 pBt->pTmpSpace = sqlite3PageMalloc( pBt->pageSize );
dan14285b72013-10-16 11:39:07 +00002699
2700 /* One of the uses of pBt->pTmpSpace is to format cells before
2701 ** inserting them into a leaf page (function fillInCell()). If
2702 ** a cell is less than 4 bytes in size, it is rounded up to 4 bytes
2703 ** by the various routines that manipulate binary cells. Which
2704 ** can mean that fillInCell() only initializes the first 2 or 3
2705 ** bytes of pTmpSpace, but that the first 4 bytes are copied from
2706 ** it into a database page. This is not actually a problem, but it
2707 ** does cause a valgrind error when the 1 or 2 bytes of unitialized
2708 ** data is passed to system call write(). So to avoid this error,
drh92787cf2014-10-15 11:55:51 +00002709 ** zero the first 4 bytes of temp space here.
2710 **
2711 ** Also: Provide four bytes of initialized space before the
2712 ** beginning of pTmpSpace as an area available to prepend the
2713 ** left-child pointer to the beginning of a cell.
2714 */
2715 if( pBt->pTmpSpace ){
2716 memset(pBt->pTmpSpace, 0, 8);
2717 pBt->pTmpSpace += 4;
2718 }
drhf7141992008-06-19 00:16:08 +00002719 }
2720}
2721
2722/*
2723** Free the pBt->pTmpSpace allocation
2724*/
2725static void freeTempSpace(BtShared *pBt){
drh92787cf2014-10-15 11:55:51 +00002726 if( pBt->pTmpSpace ){
2727 pBt->pTmpSpace -= 4;
2728 sqlite3PageFree(pBt->pTmpSpace);
2729 pBt->pTmpSpace = 0;
2730 }
drhf7141992008-06-19 00:16:08 +00002731}
2732
2733/*
drha059ad02001-04-17 20:09:11 +00002734** Close an open database and invalidate all cursors.
2735*/
danielk1977aef0bf62005-12-30 16:28:01 +00002736int sqlite3BtreeClose(Btree *p){
danielk1977aef0bf62005-12-30 16:28:01 +00002737 BtShared *pBt = p->pBt;
danielk1977aef0bf62005-12-30 16:28:01 +00002738
danielk1977aef0bf62005-12-30 16:28:01 +00002739 /* Close all cursors opened via this handle. */
drhe5fe6902007-12-07 18:55:28 +00002740 assert( sqlite3_mutex_held(p->db->mutex) );
drhe53831d2007-08-17 01:14:38 +00002741 sqlite3BtreeEnter(p);
drh5a4a15f2021-03-18 15:42:59 +00002742
2743 /* Verify that no other cursors have this Btree open */
2744#ifdef SQLITE_DEBUG
2745 {
2746 BtCursor *pCur = pBt->pCursor;
2747 while( pCur ){
2748 BtCursor *pTmp = pCur;
2749 pCur = pCur->pNext;
2750 assert( pTmp->pBtree!=p );
2751
danielk1977aef0bf62005-12-30 16:28:01 +00002752 }
drha059ad02001-04-17 20:09:11 +00002753 }
drh5a4a15f2021-03-18 15:42:59 +00002754#endif
danielk1977aef0bf62005-12-30 16:28:01 +00002755
danielk19778d34dfd2006-01-24 16:37:57 +00002756 /* Rollback any active transaction and free the handle structure.
2757 ** The call to sqlite3BtreeRollback() drops any table-locks held by
2758 ** this handle.
2759 */
drh47b7fc72014-11-11 01:33:57 +00002760 sqlite3BtreeRollback(p, SQLITE_OK, 0);
drhe53831d2007-08-17 01:14:38 +00002761 sqlite3BtreeLeave(p);
danielk1977aef0bf62005-12-30 16:28:01 +00002762
danielk1977aef0bf62005-12-30 16:28:01 +00002763 /* If there are still other outstanding references to the shared-btree
2764 ** structure, return now. The remainder of this procedure cleans
2765 ** up the shared-btree.
2766 */
drhe53831d2007-08-17 01:14:38 +00002767 assert( p->wantToLock==0 && p->locked==0 );
2768 if( !p->sharable || removeFromSharingList(pBt) ){
2769 /* The pBt is no longer on the sharing list, so we can access
2770 ** it without having to hold the mutex.
2771 **
2772 ** Clean out and delete the BtShared object.
2773 */
2774 assert( !pBt->pCursor );
dan7fb89902016-08-12 16:21:15 +00002775 sqlite3PagerClose(pBt->pPager, p->db);
drhe53831d2007-08-17 01:14:38 +00002776 if( pBt->xFreeSchema && pBt->pSchema ){
2777 pBt->xFreeSchema(pBt->pSchema);
2778 }
drhb9755982010-07-24 16:34:37 +00002779 sqlite3DbFree(0, pBt->pSchema);
drhf7141992008-06-19 00:16:08 +00002780 freeTempSpace(pBt);
drh65bbf292008-06-19 01:03:17 +00002781 sqlite3_free(pBt);
danielk1977aef0bf62005-12-30 16:28:01 +00002782 }
2783
drhe53831d2007-08-17 01:14:38 +00002784#ifndef SQLITE_OMIT_SHARED_CACHE
drhcab5ed72007-08-22 11:41:18 +00002785 assert( p->wantToLock==0 );
2786 assert( p->locked==0 );
2787 if( p->pPrev ) p->pPrev->pNext = p->pNext;
2788 if( p->pNext ) p->pNext->pPrev = p->pPrev;
danielk1977aef0bf62005-12-30 16:28:01 +00002789#endif
2790
drhe53831d2007-08-17 01:14:38 +00002791 sqlite3_free(p);
drha059ad02001-04-17 20:09:11 +00002792 return SQLITE_OK;
2793}
2794
2795/*
drh9b0cf342015-11-12 14:57:19 +00002796** Change the "soft" limit on the number of pages in the cache.
2797** Unused and unmodified pages will be recycled when the number of
2798** pages in the cache exceeds this soft limit. But the size of the
2799** cache is allowed to grow larger than this limit if it contains
2800** dirty pages or pages still in active use.
drhf57b14a2001-09-14 18:54:08 +00002801*/
danielk1977aef0bf62005-12-30 16:28:01 +00002802int sqlite3BtreeSetCacheSize(Btree *p, int mxPage){
2803 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00002804 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00002805 sqlite3BtreeEnter(p);
danielk19773b8a05f2007-03-19 17:44:26 +00002806 sqlite3PagerSetCachesize(pBt->pPager, mxPage);
drhd677b3d2007-08-20 22:48:41 +00002807 sqlite3BtreeLeave(p);
drhf57b14a2001-09-14 18:54:08 +00002808 return SQLITE_OK;
2809}
2810
drh9b0cf342015-11-12 14:57:19 +00002811/*
2812** Change the "spill" limit on the number of pages in the cache.
2813** If the number of pages exceeds this limit during a write transaction,
2814** the pager might attempt to "spill" pages to the journal early in
2815** order to free up memory.
2816**
2817** The value returned is the current spill size. If zero is passed
2818** as an argument, no changes are made to the spill size setting, so
2819** using mxPage of 0 is a way to query the current spill size.
2820*/
2821int sqlite3BtreeSetSpillSize(Btree *p, int mxPage){
2822 BtShared *pBt = p->pBt;
2823 int res;
2824 assert( sqlite3_mutex_held(p->db->mutex) );
2825 sqlite3BtreeEnter(p);
2826 res = sqlite3PagerSetSpillsize(pBt->pPager, mxPage);
2827 sqlite3BtreeLeave(p);
2828 return res;
2829}
2830
drh18c7e402014-03-14 11:46:10 +00002831#if SQLITE_MAX_MMAP_SIZE>0
drhf57b14a2001-09-14 18:54:08 +00002832/*
dan5d8a1372013-03-19 19:28:06 +00002833** Change the limit on the amount of the database file that may be
2834** memory mapped.
2835*/
drh9b4c59f2013-04-15 17:03:42 +00002836int sqlite3BtreeSetMmapLimit(Btree *p, sqlite3_int64 szMmap){
dan5d8a1372013-03-19 19:28:06 +00002837 BtShared *pBt = p->pBt;
2838 assert( sqlite3_mutex_held(p->db->mutex) );
2839 sqlite3BtreeEnter(p);
drh9b4c59f2013-04-15 17:03:42 +00002840 sqlite3PagerSetMmapLimit(pBt->pPager, szMmap);
dan5d8a1372013-03-19 19:28:06 +00002841 sqlite3BtreeLeave(p);
2842 return SQLITE_OK;
2843}
drh18c7e402014-03-14 11:46:10 +00002844#endif /* SQLITE_MAX_MMAP_SIZE>0 */
dan5d8a1372013-03-19 19:28:06 +00002845
2846/*
drh973b6e32003-02-12 14:09:42 +00002847** Change the way data is synced to disk in order to increase or decrease
2848** how well the database resists damage due to OS crashes and power
2849** failures. Level 1 is the same as asynchronous (no syncs() occur and
2850** there is a high probability of damage) Level 2 is the default. There
2851** is a very low but non-zero probability of damage. Level 3 reduces the
2852** probability of damage to near zero but with a write performance reduction.
2853*/
danielk197793758c82005-01-21 08:13:14 +00002854#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh40c39412013-08-16 20:42:20 +00002855int sqlite3BtreeSetPagerFlags(
drhc97d8462010-11-19 18:23:35 +00002856 Btree *p, /* The btree to set the safety level on */
drh40c39412013-08-16 20:42:20 +00002857 unsigned pgFlags /* Various PAGER_* flags */
drhc97d8462010-11-19 18:23:35 +00002858){
danielk1977aef0bf62005-12-30 16:28:01 +00002859 BtShared *pBt = p->pBt;
drhe5fe6902007-12-07 18:55:28 +00002860 assert( sqlite3_mutex_held(p->db->mutex) );
drhd677b3d2007-08-20 22:48:41 +00002861 sqlite3BtreeEnter(p);
drh40c39412013-08-16 20:42:20 +00002862 sqlite3PagerSetFlags(pBt->pPager, pgFlags);
drhd677b3d2007-08-20 22:48:41 +00002863 sqlite3BtreeLeave(p);
drh973b6e32003-02-12 14:09:42 +00002864 return SQLITE_OK;
2865}
danielk197793758c82005-01-21 08:13:14 +00002866#endif
drh973b6e32003-02-12 14:09:42 +00002867
drh2c8997b2005-08-27 16:36:48 +00002868/*
drh90f5ecb2004-07-22 01:19:35 +00002869** Change the default pages size and the number of reserved bytes per page.
drhce4869f2009-04-02 20:16:58 +00002870** Or, if the page size has already been fixed, return SQLITE_READONLY
2871** without changing anything.
drh06f50212004-11-02 14:24:33 +00002872**
2873** The page size must be a power of 2 between 512 and 65536. If the page
2874** size supplied does not meet this constraint then the page size is not
2875** changed.
2876**
2877** Page sizes are constrained to be a power of two so that the region
2878** of the database file used for locking (beginning at PENDING_BYTE,
2879** the first byte past the 1GB boundary, 0x40000000) needs to occur
2880** at the beginning of a page.
danielk197728129562005-01-11 10:25:06 +00002881**
2882** If parameter nReserve is less than zero, then the number of reserved
2883** bytes per page is left unchanged.
drhce4869f2009-04-02 20:16:58 +00002884**
drhc9166342012-01-05 23:32:06 +00002885** If the iFix!=0 then the BTS_PAGESIZE_FIXED flag is set so that the page size
drhce4869f2009-04-02 20:16:58 +00002886** and autovacuum mode can no longer be changed.
drh90f5ecb2004-07-22 01:19:35 +00002887*/
drhce4869f2009-04-02 20:16:58 +00002888int sqlite3BtreeSetPageSize(Btree *p, int pageSize, int nReserve, int iFix){
danielk1977a1644fd2007-08-29 12:31:25 +00002889 int rc = SQLITE_OK;
drhe937df82020-05-07 01:56:57 +00002890 int x;
danielk1977aef0bf62005-12-30 16:28:01 +00002891 BtShared *pBt = p->pBt;
drhe937df82020-05-07 01:56:57 +00002892 assert( nReserve>=0 && nReserve<=255 );
drhd677b3d2007-08-20 22:48:41 +00002893 sqlite3BtreeEnter(p);
drhe937df82020-05-07 01:56:57 +00002894 pBt->nReserveWanted = nReserve;
2895 x = pBt->pageSize - pBt->usableSize;
2896 if( nReserve<x ) nReserve = x;
drhc9166342012-01-05 23:32:06 +00002897 if( pBt->btsFlags & BTS_PAGESIZE_FIXED ){
drhd677b3d2007-08-20 22:48:41 +00002898 sqlite3BtreeLeave(p);
drh90f5ecb2004-07-22 01:19:35 +00002899 return SQLITE_READONLY;
2900 }
drhf49661a2008-12-10 16:45:50 +00002901 assert( nReserve>=0 && nReserve<=255 );
drh06f50212004-11-02 14:24:33 +00002902 if( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE &&
2903 ((pageSize-1)&pageSize)==0 ){
drh07d183d2005-05-01 22:52:42 +00002904 assert( (pageSize & 7)==0 );
dandd14ecb2015-05-05 10:03:08 +00002905 assert( !pBt->pCursor );
drh906602a2021-01-21 21:36:25 +00002906 if( nReserve>32 && pageSize==512 ) pageSize = 1024;
drhb2eced52010-08-12 02:41:12 +00002907 pBt->pageSize = (u32)pageSize;
drhf7141992008-06-19 00:16:08 +00002908 freeTempSpace(pBt);
drh90f5ecb2004-07-22 01:19:35 +00002909 }
drhfa9601a2009-06-18 17:22:39 +00002910 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
drhf49661a2008-12-10 16:45:50 +00002911 pBt->usableSize = pBt->pageSize - (u16)nReserve;
drhc9166342012-01-05 23:32:06 +00002912 if( iFix ) pBt->btsFlags |= BTS_PAGESIZE_FIXED;
drhd677b3d2007-08-20 22:48:41 +00002913 sqlite3BtreeLeave(p);
danielk1977a1644fd2007-08-29 12:31:25 +00002914 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002915}
2916
2917/*
2918** Return the currently defined page size
2919*/
danielk1977aef0bf62005-12-30 16:28:01 +00002920int sqlite3BtreeGetPageSize(Btree *p){
2921 return p->pBt->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00002922}
drh7f751222009-03-17 22:33:00 +00002923
dan0094f372012-09-28 20:23:42 +00002924/*
2925** This function is similar to sqlite3BtreeGetReserve(), except that it
2926** may only be called if it is guaranteed that the b-tree mutex is already
2927** held.
2928**
2929** This is useful in one special case in the backup API code where it is
2930** known that the shared b-tree mutex is held, but the mutex on the
2931** database handle that owns *p is not. In this case if sqlite3BtreeEnter()
2932** were to be called, it might collide with some other operation on the
mistachkin48864df2013-03-21 21:20:32 +00002933** database handle that owns *p, causing undefined behavior.
dan0094f372012-09-28 20:23:42 +00002934*/
2935int sqlite3BtreeGetReserveNoMutex(Btree *p){
drhad0961b2015-02-21 00:19:25 +00002936 int n;
dan0094f372012-09-28 20:23:42 +00002937 assert( sqlite3_mutex_held(p->pBt->mutex) );
drhad0961b2015-02-21 00:19:25 +00002938 n = p->pBt->pageSize - p->pBt->usableSize;
2939 return n;
dan0094f372012-09-28 20:23:42 +00002940}
2941
drh7f751222009-03-17 22:33:00 +00002942/*
2943** Return the number of bytes of space at the end of every page that
2944** are intentually left unused. This is the "reserved" space that is
2945** sometimes used by extensions.
drhad0961b2015-02-21 00:19:25 +00002946**
drh4d347662020-04-22 00:50:21 +00002947** The value returned is the larger of the current reserve size and
2948** the latest reserve size requested by SQLITE_FILECTRL_RESERVE_BYTES.
2949** The amount of reserve can only grow - never shrink.
drh7f751222009-03-17 22:33:00 +00002950*/
drh45248de2020-04-20 15:18:43 +00002951int sqlite3BtreeGetRequestedReserve(Btree *p){
drhe937df82020-05-07 01:56:57 +00002952 int n1, n2;
drhd677b3d2007-08-20 22:48:41 +00002953 sqlite3BtreeEnter(p);
drhe937df82020-05-07 01:56:57 +00002954 n1 = (int)p->pBt->nReserveWanted;
2955 n2 = sqlite3BtreeGetReserveNoMutex(p);
drhd677b3d2007-08-20 22:48:41 +00002956 sqlite3BtreeLeave(p);
drhe937df82020-05-07 01:56:57 +00002957 return n1>n2 ? n1 : n2;
drh2011d5f2004-07-22 02:40:37 +00002958}
drhf8e632b2007-05-08 14:51:36 +00002959
drhad0961b2015-02-21 00:19:25 +00002960
drhf8e632b2007-05-08 14:51:36 +00002961/*
2962** Set the maximum page count for a database if mxPage is positive.
2963** No changes are made if mxPage is 0 or negative.
2964** Regardless of the value of mxPage, return the maximum page count.
2965*/
drhe9261db2020-07-20 12:47:32 +00002966Pgno sqlite3BtreeMaxPageCount(Btree *p, Pgno mxPage){
2967 Pgno n;
drhd677b3d2007-08-20 22:48:41 +00002968 sqlite3BtreeEnter(p);
2969 n = sqlite3PagerMaxPageCount(p->pBt->pPager, mxPage);
2970 sqlite3BtreeLeave(p);
2971 return n;
drhf8e632b2007-05-08 14:51:36 +00002972}
drh5b47efa2010-02-12 18:18:39 +00002973
2974/*
drha5907a82017-06-19 11:44:22 +00002975** Change the values for the BTS_SECURE_DELETE and BTS_OVERWRITE flags:
2976**
2977** newFlag==0 Both BTS_SECURE_DELETE and BTS_OVERWRITE are cleared
2978** newFlag==1 BTS_SECURE_DELETE set and BTS_OVERWRITE is cleared
2979** newFlag==2 BTS_SECURE_DELETE cleared and BTS_OVERWRITE is set
2980** newFlag==(-1) No changes
2981**
2982** This routine acts as a query if newFlag is less than zero
2983**
2984** With BTS_OVERWRITE set, deleted content is overwritten by zeros, but
2985** freelist leaf pages are not written back to the database. Thus in-page
2986** deleted content is cleared, but freelist deleted content is not.
2987**
2988** With BTS_SECURE_DELETE, operation is like BTS_OVERWRITE with the addition
2989** that freelist leaf pages are written back into the database, increasing
2990** the amount of disk I/O.
drh5b47efa2010-02-12 18:18:39 +00002991*/
2992int sqlite3BtreeSecureDelete(Btree *p, int newFlag){
2993 int b;
drhaf034ed2010-02-12 19:46:26 +00002994 if( p==0 ) return 0;
drh5b47efa2010-02-12 18:18:39 +00002995 sqlite3BtreeEnter(p);
drha5907a82017-06-19 11:44:22 +00002996 assert( BTS_OVERWRITE==BTS_SECURE_DELETE*2 );
2997 assert( BTS_FAST_SECURE==(BTS_OVERWRITE|BTS_SECURE_DELETE) );
drh5b47efa2010-02-12 18:18:39 +00002998 if( newFlag>=0 ){
drha5907a82017-06-19 11:44:22 +00002999 p->pBt->btsFlags &= ~BTS_FAST_SECURE;
3000 p->pBt->btsFlags |= BTS_SECURE_DELETE*newFlag;
3001 }
3002 b = (p->pBt->btsFlags & BTS_FAST_SECURE)/BTS_SECURE_DELETE;
drh5b47efa2010-02-12 18:18:39 +00003003 sqlite3BtreeLeave(p);
3004 return b;
3005}
drh90f5ecb2004-07-22 01:19:35 +00003006
3007/*
danielk1977951af802004-11-05 15:45:09 +00003008** Change the 'auto-vacuum' property of the database. If the 'autoVacuum'
3009** parameter is non-zero, then auto-vacuum mode is enabled. If zero, it
3010** is disabled. The default value for the auto-vacuum property is
3011** determined by the SQLITE_DEFAULT_AUTOVACUUM macro.
3012*/
danielk1977aef0bf62005-12-30 16:28:01 +00003013int sqlite3BtreeSetAutoVacuum(Btree *p, int autoVacuum){
danielk1977951af802004-11-05 15:45:09 +00003014#ifdef SQLITE_OMIT_AUTOVACUUM
drheee46cf2004-11-06 00:02:48 +00003015 return SQLITE_READONLY;
danielk1977951af802004-11-05 15:45:09 +00003016#else
danielk1977dddbcdc2007-04-26 14:42:34 +00003017 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00003018 int rc = SQLITE_OK;
drh076d4662009-02-18 20:31:18 +00003019 u8 av = (u8)autoVacuum;
drhd677b3d2007-08-20 22:48:41 +00003020
3021 sqlite3BtreeEnter(p);
drhc9166342012-01-05 23:32:06 +00003022 if( (pBt->btsFlags & BTS_PAGESIZE_FIXED)!=0 && (av ?1:0)!=pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00003023 rc = SQLITE_READONLY;
3024 }else{
drh076d4662009-02-18 20:31:18 +00003025 pBt->autoVacuum = av ?1:0;
3026 pBt->incrVacuum = av==2 ?1:0;
danielk1977951af802004-11-05 15:45:09 +00003027 }
drhd677b3d2007-08-20 22:48:41 +00003028 sqlite3BtreeLeave(p);
3029 return rc;
danielk1977951af802004-11-05 15:45:09 +00003030#endif
3031}
3032
3033/*
3034** Return the value of the 'auto-vacuum' property. If auto-vacuum is
3035** enabled 1 is returned. Otherwise 0.
3036*/
danielk1977aef0bf62005-12-30 16:28:01 +00003037int sqlite3BtreeGetAutoVacuum(Btree *p){
danielk1977951af802004-11-05 15:45:09 +00003038#ifdef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00003039 return BTREE_AUTOVACUUM_NONE;
danielk1977951af802004-11-05 15:45:09 +00003040#else
drhd677b3d2007-08-20 22:48:41 +00003041 int rc;
3042 sqlite3BtreeEnter(p);
3043 rc = (
danielk1977dddbcdc2007-04-26 14:42:34 +00003044 (!p->pBt->autoVacuum)?BTREE_AUTOVACUUM_NONE:
3045 (!p->pBt->incrVacuum)?BTREE_AUTOVACUUM_FULL:
3046 BTREE_AUTOVACUUM_INCR
3047 );
drhd677b3d2007-08-20 22:48:41 +00003048 sqlite3BtreeLeave(p);
3049 return rc;
danielk1977951af802004-11-05 15:45:09 +00003050#endif
3051}
3052
danf5da7db2017-03-16 18:14:39 +00003053/*
3054** If the user has not set the safety-level for this database connection
3055** using "PRAGMA synchronous", and if the safety-level is not already
3056** set to the value passed to this function as the second parameter,
3057** set it so.
3058*/
drh2ed57372017-10-05 20:57:38 +00003059#if SQLITE_DEFAULT_SYNCHRONOUS!=SQLITE_DEFAULT_WAL_SYNCHRONOUS \
3060 && !defined(SQLITE_OMIT_WAL)
danf5da7db2017-03-16 18:14:39 +00003061static void setDefaultSyncFlag(BtShared *pBt, u8 safety_level){
3062 sqlite3 *db;
3063 Db *pDb;
3064 if( (db=pBt->db)!=0 && (pDb=db->aDb)!=0 ){
3065 while( pDb->pBt==0 || pDb->pBt->pBt!=pBt ){ pDb++; }
3066 if( pDb->bSyncSet==0
3067 && pDb->safety_level!=safety_level
3068 && pDb!=&db->aDb[1]
3069 ){
3070 pDb->safety_level = safety_level;
3071 sqlite3PagerSetFlags(pBt->pPager,
3072 pDb->safety_level | (db->flags & PAGER_FLAGS_MASK));
3073 }
3074 }
3075}
3076#else
danfc8f4b62017-03-16 18:54:42 +00003077# define setDefaultSyncFlag(pBt,safety_level)
danf5da7db2017-03-16 18:14:39 +00003078#endif
danielk1977951af802004-11-05 15:45:09 +00003079
drh0314cf32018-04-28 01:27:09 +00003080/* Forward declaration */
3081static int newDatabase(BtShared*);
3082
3083
danielk1977951af802004-11-05 15:45:09 +00003084/*
drha34b6762004-05-07 13:30:42 +00003085** Get a reference to pPage1 of the database file. This will
drh306dc212001-05-21 13:45:10 +00003086** also acquire a readlock on that file.
3087**
3088** SQLITE_OK is returned on success. If the file is not a
3089** well-formed database file, then SQLITE_CORRUPT is returned.
3090** SQLITE_BUSY is returned if the database is locked. SQLITE_NOMEM
drh4f0ee682007-03-30 20:43:40 +00003091** is returned if we run out of memory.
drh306dc212001-05-21 13:45:10 +00003092*/
danielk1977aef0bf62005-12-30 16:28:01 +00003093static int lockBtree(BtShared *pBt){
drhc2a4bab2010-04-02 12:46:45 +00003094 int rc; /* Result code from subfunctions */
3095 MemPage *pPage1; /* Page 1 of the database file */
dane6370e92019-01-11 17:41:23 +00003096 u32 nPage; /* Number of pages in the database */
3097 u32 nPageFile = 0; /* Number of pages in the database file */
3098 u32 nPageHeader; /* Number of pages in the database according to hdr */
drhd677b3d2007-08-20 22:48:41 +00003099
drh1fee73e2007-08-29 04:00:57 +00003100 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977295dc102009-04-01 19:07:03 +00003101 assert( pBt->pPage1==0 );
danielk197789bc4bc2009-07-21 19:25:24 +00003102 rc = sqlite3PagerSharedLock(pBt->pPager);
3103 if( rc!=SQLITE_OK ) return rc;
drhb00fc3b2013-08-21 23:42:32 +00003104 rc = btreeGetPage(pBt, 1, &pPage1, 0);
drh306dc212001-05-21 13:45:10 +00003105 if( rc!=SQLITE_OK ) return rc;
drh306dc212001-05-21 13:45:10 +00003106
3107 /* Do some checking to help insure the file we opened really is
3108 ** a valid database file.
3109 */
drhc2a4bab2010-04-02 12:46:45 +00003110 nPage = nPageHeader = get4byte(28+(u8*)pPage1->aData);
dane6370e92019-01-11 17:41:23 +00003111 sqlite3PagerPagecount(pBt->pPager, (int*)&nPageFile);
drhb28e59b2010-06-17 02:13:39 +00003112 if( nPage==0 || memcmp(24+(u8*)pPage1->aData, 92+(u8*)pPage1->aData,4)!=0 ){
drhc2a4bab2010-04-02 12:46:45 +00003113 nPage = nPageFile;
drh97b59a52010-03-31 02:31:33 +00003114 }
drh0314cf32018-04-28 01:27:09 +00003115 if( (pBt->db->flags & SQLITE_ResetDatabase)!=0 ){
3116 nPage = 0;
3117 }
drh97b59a52010-03-31 02:31:33 +00003118 if( nPage>0 ){
drh43b18e12010-08-17 19:40:08 +00003119 u32 pageSize;
3120 u32 usableSize;
drhb6f41482004-05-14 01:58:11 +00003121 u8 *page1 = pPage1->aData;
danielk1977ad0132d2008-06-07 08:58:22 +00003122 rc = SQLITE_NOTADB;
drh113762a2014-11-19 16:36:25 +00003123 /* EVIDENCE-OF: R-43737-39999 Every valid SQLite database file begins
3124 ** with the following 16 bytes (in hex): 53 51 4c 69 74 65 20 66 6f 72 6d
3125 ** 61 74 20 33 00. */
drhb6f41482004-05-14 01:58:11 +00003126 if( memcmp(page1, zMagicHeader, 16)!=0 ){
drh72f82862001-05-24 21:06:34 +00003127 goto page1_init_failed;
drh306dc212001-05-21 13:45:10 +00003128 }
dan5cf53532010-05-01 16:40:20 +00003129
3130#ifdef SQLITE_OMIT_WAL
3131 if( page1[18]>1 ){
drhc9166342012-01-05 23:32:06 +00003132 pBt->btsFlags |= BTS_READ_ONLY;
dan5cf53532010-05-01 16:40:20 +00003133 }
3134 if( page1[19]>1 ){
3135 goto page1_init_failed;
3136 }
3137#else
dane04dc882010-04-20 18:53:15 +00003138 if( page1[18]>2 ){
drhc9166342012-01-05 23:32:06 +00003139 pBt->btsFlags |= BTS_READ_ONLY;
drh309169a2007-04-24 17:27:51 +00003140 }
dane04dc882010-04-20 18:53:15 +00003141 if( page1[19]>2 ){
drhb6f41482004-05-14 01:58:11 +00003142 goto page1_init_failed;
3143 }
drhe5ae5732008-06-15 02:51:47 +00003144
dana470aeb2010-04-21 11:43:38 +00003145 /* If the write version is set to 2, this database should be accessed
3146 ** in WAL mode. If the log is not already open, open it now. Then
3147 ** return SQLITE_OK and return without populating BtShared.pPage1.
3148 ** The caller detects this and calls this function again. This is
3149 ** required as the version of page 1 currently in the page1 buffer
3150 ** may not be the latest version - there may be a newer one in the log
3151 ** file.
3152 */
drhc9166342012-01-05 23:32:06 +00003153 if( page1[19]==2 && (pBt->btsFlags & BTS_NO_WAL)==0 ){
dane04dc882010-04-20 18:53:15 +00003154 int isOpen = 0;
drh7ed91f22010-04-29 22:34:07 +00003155 rc = sqlite3PagerOpenWal(pBt->pPager, &isOpen);
dane04dc882010-04-20 18:53:15 +00003156 if( rc!=SQLITE_OK ){
3157 goto page1_init_failed;
drhe243de52016-03-08 15:14:26 +00003158 }else{
danf5da7db2017-03-16 18:14:39 +00003159 setDefaultSyncFlag(pBt, SQLITE_DEFAULT_WAL_SYNCHRONOUS+1);
drhe243de52016-03-08 15:14:26 +00003160 if( isOpen==0 ){
drh3908fe92017-09-01 14:50:19 +00003161 releasePageOne(pPage1);
drhe243de52016-03-08 15:14:26 +00003162 return SQLITE_OK;
3163 }
dane04dc882010-04-20 18:53:15 +00003164 }
dan8b5444b2010-04-27 14:37:47 +00003165 rc = SQLITE_NOTADB;
danf5da7db2017-03-16 18:14:39 +00003166 }else{
3167 setDefaultSyncFlag(pBt, SQLITE_DEFAULT_SYNCHRONOUS+1);
dane04dc882010-04-20 18:53:15 +00003168 }
dan5cf53532010-05-01 16:40:20 +00003169#endif
dane04dc882010-04-20 18:53:15 +00003170
drh113762a2014-11-19 16:36:25 +00003171 /* EVIDENCE-OF: R-15465-20813 The maximum and minimum embedded payload
3172 ** fractions and the leaf payload fraction values must be 64, 32, and 32.
3173 **
drhe5ae5732008-06-15 02:51:47 +00003174 ** The original design allowed these amounts to vary, but as of
3175 ** version 3.6.0, we require them to be fixed.
3176 */
3177 if( memcmp(&page1[21], "\100\040\040",3)!=0 ){
3178 goto page1_init_failed;
3179 }
drh113762a2014-11-19 16:36:25 +00003180 /* EVIDENCE-OF: R-51873-39618 The page size for a database file is
3181 ** determined by the 2-byte integer located at an offset of 16 bytes from
3182 ** the beginning of the database file. */
drhb2eced52010-08-12 02:41:12 +00003183 pageSize = (page1[16]<<8) | (page1[17]<<16);
drh113762a2014-11-19 16:36:25 +00003184 /* EVIDENCE-OF: R-25008-21688 The size of a page is a power of two
3185 ** between 512 and 65536 inclusive. */
drhb2eced52010-08-12 02:41:12 +00003186 if( ((pageSize-1)&pageSize)!=0
3187 || pageSize>SQLITE_MAX_PAGE_SIZE
3188 || pageSize<=256
drh7dc385e2007-09-06 23:39:36 +00003189 ){
drh07d183d2005-05-01 22:52:42 +00003190 goto page1_init_failed;
3191 }
drhdcc27002019-01-06 02:06:31 +00003192 pBt->btsFlags |= BTS_PAGESIZE_FIXED;
drh07d183d2005-05-01 22:52:42 +00003193 assert( (pageSize & 7)==0 );
drh113762a2014-11-19 16:36:25 +00003194 /* EVIDENCE-OF: R-59310-51205 The "reserved space" size in the 1-byte
3195 ** integer at offset 20 is the number of bytes of space at the end of
3196 ** each page to reserve for extensions.
3197 **
3198 ** EVIDENCE-OF: R-37497-42412 The size of the reserved region is
3199 ** determined by the one-byte unsigned integer found at an offset of 20
3200 ** into the database file header. */
danielk1977f653d782008-03-20 11:04:21 +00003201 usableSize = pageSize - page1[20];
shaneh1df2db72010-08-18 02:28:48 +00003202 if( (u32)pageSize!=pBt->pageSize ){
danielk1977f653d782008-03-20 11:04:21 +00003203 /* After reading the first page of the database assuming a page size
3204 ** of BtShared.pageSize, we have discovered that the page-size is
3205 ** actually pageSize. Unlock the database, leave pBt->pPage1 at
3206 ** zero and return SQLITE_OK. The caller will call this function
3207 ** again with the correct page-size.
3208 */
drh3908fe92017-09-01 14:50:19 +00003209 releasePageOne(pPage1);
drh43b18e12010-08-17 19:40:08 +00003210 pBt->usableSize = usableSize;
3211 pBt->pageSize = pageSize;
drhf7141992008-06-19 00:16:08 +00003212 freeTempSpace(pBt);
drhfa9601a2009-06-18 17:22:39 +00003213 rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize,
3214 pageSize-usableSize);
drh5e483932009-07-10 16:51:30 +00003215 return rc;
danielk1977f653d782008-03-20 11:04:21 +00003216 }
drh0f1c2eb2018-11-03 17:31:48 +00003217 if( sqlite3WritableSchema(pBt->db)==0 && nPage>nPageFile ){
drhc2a4bab2010-04-02 12:46:45 +00003218 rc = SQLITE_CORRUPT_BKPT;
3219 goto page1_init_failed;
3220 }
drh113762a2014-11-19 16:36:25 +00003221 /* EVIDENCE-OF: R-28312-64704 However, the usable size is not allowed to
3222 ** be less than 480. In other words, if the page size is 512, then the
3223 ** reserved space size cannot exceed 32. */
drhb33e1b92009-06-18 11:29:20 +00003224 if( usableSize<480 ){
drhb6f41482004-05-14 01:58:11 +00003225 goto page1_init_failed;
3226 }
drh43b18e12010-08-17 19:40:08 +00003227 pBt->pageSize = pageSize;
3228 pBt->usableSize = usableSize;
drh057cd3a2005-02-15 16:23:02 +00003229#ifndef SQLITE_OMIT_AUTOVACUUM
3230 pBt->autoVacuum = (get4byte(&page1[36 + 4*4])?1:0);
danielk197727b1f952007-06-25 08:16:58 +00003231 pBt->incrVacuum = (get4byte(&page1[36 + 7*4])?1:0);
drh057cd3a2005-02-15 16:23:02 +00003232#endif
drh306dc212001-05-21 13:45:10 +00003233 }
drhb6f41482004-05-14 01:58:11 +00003234
3235 /* maxLocal is the maximum amount of payload to store locally for
3236 ** a cell. Make sure it is small enough so that at least minFanout
3237 ** cells can will fit on one page. We assume a 10-byte page header.
3238 ** Besides the payload, the cell must store:
drh43605152004-05-29 21:46:49 +00003239 ** 2-byte pointer to the cell
drhb6f41482004-05-14 01:58:11 +00003240 ** 4-byte child pointer
3241 ** 9-byte nKey value
3242 ** 4-byte nData value
3243 ** 4-byte overflow page pointer
drhe22e03e2010-08-18 21:19:03 +00003244 ** So a cell consists of a 2-byte pointer, a header which is as much as
drh43605152004-05-29 21:46:49 +00003245 ** 17 bytes long, 0 to N bytes of payload, and an optional 4 byte overflow
3246 ** page pointer.
drhb6f41482004-05-14 01:58:11 +00003247 */
shaneh1df2db72010-08-18 02:28:48 +00003248 pBt->maxLocal = (u16)((pBt->usableSize-12)*64/255 - 23);
3249 pBt->minLocal = (u16)((pBt->usableSize-12)*32/255 - 23);
3250 pBt->maxLeaf = (u16)(pBt->usableSize - 35);
3251 pBt->minLeaf = (u16)((pBt->usableSize-12)*32/255 - 23);
drhc9166342012-01-05 23:32:06 +00003252 if( pBt->maxLocal>127 ){
3253 pBt->max1bytePayload = 127;
3254 }else{
mistachkin0547e2f2012-01-08 00:54:02 +00003255 pBt->max1bytePayload = (u8)pBt->maxLocal;
drhc9166342012-01-05 23:32:06 +00003256 }
drh2e38c322004-09-03 18:38:44 +00003257 assert( pBt->maxLeaf + 23 <= MX_CELL_SIZE(pBt) );
drh3aac2dd2004-04-26 14:10:20 +00003258 pBt->pPage1 = pPage1;
drhdd3cd972010-03-27 17:12:36 +00003259 pBt->nPage = nPage;
drhb6f41482004-05-14 01:58:11 +00003260 return SQLITE_OK;
drh306dc212001-05-21 13:45:10 +00003261
drh72f82862001-05-24 21:06:34 +00003262page1_init_failed:
drh3908fe92017-09-01 14:50:19 +00003263 releasePageOne(pPage1);
drh3aac2dd2004-04-26 14:10:20 +00003264 pBt->pPage1 = 0;
drh72f82862001-05-24 21:06:34 +00003265 return rc;
drh306dc212001-05-21 13:45:10 +00003266}
3267
drh85ec3b62013-05-14 23:12:06 +00003268#ifndef NDEBUG
3269/*
3270** Return the number of cursors open on pBt. This is for use
3271** in assert() expressions, so it is only compiled if NDEBUG is not
3272** defined.
3273**
3274** Only write cursors are counted if wrOnly is true. If wrOnly is
3275** false then all cursors are counted.
3276**
3277** For the purposes of this routine, a cursor is any cursor that
peter.d.reid60ec9142014-09-06 16:39:46 +00003278** is capable of reading or writing to the database. Cursors that
drh85ec3b62013-05-14 23:12:06 +00003279** have been tripped into the CURSOR_FAULT state are not counted.
3280*/
3281static int countValidCursors(BtShared *pBt, int wrOnly){
3282 BtCursor *pCur;
3283 int r = 0;
3284 for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
drh036dbec2014-03-11 23:40:44 +00003285 if( (wrOnly==0 || (pCur->curFlags & BTCF_WriteFlag)!=0)
3286 && pCur->eState!=CURSOR_FAULT ) r++;
drh85ec3b62013-05-14 23:12:06 +00003287 }
3288 return r;
3289}
3290#endif
3291
drh306dc212001-05-21 13:45:10 +00003292/*
drhb8ca3072001-12-05 00:21:20 +00003293** If there are no outstanding cursors and we are not in the middle
3294** of a transaction but there is a read lock on the database, then
3295** this routine unrefs the first page of the database file which
3296** has the effect of releasing the read lock.
3297**
drhb8ca3072001-12-05 00:21:20 +00003298** If there is a transaction in progress, this routine is a no-op.
3299*/
danielk1977aef0bf62005-12-30 16:28:01 +00003300static void unlockBtreeIfUnused(BtShared *pBt){
drh1fee73e2007-08-29 04:00:57 +00003301 assert( sqlite3_mutex_held(pBt->mutex) );
drh85ec3b62013-05-14 23:12:06 +00003302 assert( countValidCursors(pBt,0)==0 || pBt->inTransaction>TRANS_NONE );
danielk19771bc9ee92009-07-04 15:41:02 +00003303 if( pBt->inTransaction==TRANS_NONE && pBt->pPage1!=0 ){
drhb2325b72014-09-24 18:31:07 +00003304 MemPage *pPage1 = pBt->pPage1;
3305 assert( pPage1->aData );
danielk1977c1761e82009-06-25 09:40:03 +00003306 assert( sqlite3PagerRefcount(pBt->pPager)==1 );
drh3aac2dd2004-04-26 14:10:20 +00003307 pBt->pPage1 = 0;
drh3908fe92017-09-01 14:50:19 +00003308 releasePageOne(pPage1);
drhb8ca3072001-12-05 00:21:20 +00003309 }
3310}
3311
3312/*
drhe39f2f92009-07-23 01:43:59 +00003313** If pBt points to an empty file then convert that empty file
3314** into a new empty database by initializing the first page of
3315** the database.
drh8b2f49b2001-06-08 00:21:52 +00003316*/
danielk1977aef0bf62005-12-30 16:28:01 +00003317static int newDatabase(BtShared *pBt){
drh9e572e62004-04-23 23:43:10 +00003318 MemPage *pP1;
3319 unsigned char *data;
drh8c42ca92001-06-22 19:15:00 +00003320 int rc;
drhd677b3d2007-08-20 22:48:41 +00003321
drh1fee73e2007-08-29 04:00:57 +00003322 assert( sqlite3_mutex_held(pBt->mutex) );
drhdd3cd972010-03-27 17:12:36 +00003323 if( pBt->nPage>0 ){
3324 return SQLITE_OK;
danielk1977ad0132d2008-06-07 08:58:22 +00003325 }
drh3aac2dd2004-04-26 14:10:20 +00003326 pP1 = pBt->pPage1;
drh9e572e62004-04-23 23:43:10 +00003327 assert( pP1!=0 );
3328 data = pP1->aData;
danielk19773b8a05f2007-03-19 17:44:26 +00003329 rc = sqlite3PagerWrite(pP1->pDbPage);
drh8b2f49b2001-06-08 00:21:52 +00003330 if( rc ) return rc;
drh9e572e62004-04-23 23:43:10 +00003331 memcpy(data, zMagicHeader, sizeof(zMagicHeader));
3332 assert( sizeof(zMagicHeader)==16 );
shaneh1df2db72010-08-18 02:28:48 +00003333 data[16] = (u8)((pBt->pageSize>>8)&0xff);
3334 data[17] = (u8)((pBt->pageSize>>16)&0xff);
drh9e572e62004-04-23 23:43:10 +00003335 data[18] = 1;
3336 data[19] = 1;
drhf49661a2008-12-10 16:45:50 +00003337 assert( pBt->usableSize<=pBt->pageSize && pBt->usableSize+255>=pBt->pageSize);
3338 data[20] = (u8)(pBt->pageSize - pBt->usableSize);
drhe5ae5732008-06-15 02:51:47 +00003339 data[21] = 64;
3340 data[22] = 32;
3341 data[23] = 32;
drhb6f41482004-05-14 01:58:11 +00003342 memset(&data[24], 0, 100-24);
drhe6c43812004-05-14 12:17:46 +00003343 zeroPage(pP1, PTF_INTKEY|PTF_LEAF|PTF_LEAFDATA );
drhc9166342012-01-05 23:32:06 +00003344 pBt->btsFlags |= BTS_PAGESIZE_FIXED;
danielk1977003ba062004-11-04 02:57:33 +00003345#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977dddbcdc2007-04-26 14:42:34 +00003346 assert( pBt->autoVacuum==1 || pBt->autoVacuum==0 );
danielk1977418899a2007-06-24 10:14:00 +00003347 assert( pBt->incrVacuum==1 || pBt->incrVacuum==0 );
danielk1977dddbcdc2007-04-26 14:42:34 +00003348 put4byte(&data[36 + 4*4], pBt->autoVacuum);
danielk1977418899a2007-06-24 10:14:00 +00003349 put4byte(&data[36 + 7*4], pBt->incrVacuum);
danielk1977003ba062004-11-04 02:57:33 +00003350#endif
drhdd3cd972010-03-27 17:12:36 +00003351 pBt->nPage = 1;
3352 data[31] = 1;
drh8b2f49b2001-06-08 00:21:52 +00003353 return SQLITE_OK;
3354}
3355
3356/*
danb483eba2012-10-13 19:58:11 +00003357** Initialize the first page of the database file (creating a database
3358** consisting of a single page and no schema objects). Return SQLITE_OK
3359** if successful, or an SQLite error code otherwise.
3360*/
3361int sqlite3BtreeNewDb(Btree *p){
3362 int rc;
3363 sqlite3BtreeEnter(p);
3364 p->pBt->nPage = 0;
3365 rc = newDatabase(p->pBt);
3366 sqlite3BtreeLeave(p);
3367 return rc;
3368}
3369
3370/*
danielk1977ee5741e2004-05-31 10:01:34 +00003371** Attempt to start a new transaction. A write-transaction
drh684917c2004-10-05 02:41:42 +00003372** is started if the second argument is nonzero, otherwise a read-
3373** transaction. If the second argument is 2 or more and exclusive
3374** transaction is started, meaning that no other process is allowed
3375** to access the database. A preexisting transaction may not be
drhb8ef32c2005-03-14 02:01:49 +00003376** upgraded to exclusive by calling this routine a second time - the
drh684917c2004-10-05 02:41:42 +00003377** exclusivity flag only works for a new transaction.
drh8b2f49b2001-06-08 00:21:52 +00003378**
danielk1977ee5741e2004-05-31 10:01:34 +00003379** A write-transaction must be started before attempting any
3380** changes to the database. None of the following routines
3381** will work unless a transaction is started first:
drh8b2f49b2001-06-08 00:21:52 +00003382**
drh23e11ca2004-05-04 17:27:28 +00003383** sqlite3BtreeCreateTable()
3384** sqlite3BtreeCreateIndex()
3385** sqlite3BtreeClearTable()
3386** sqlite3BtreeDropTable()
3387** sqlite3BtreeInsert()
3388** sqlite3BtreeDelete()
3389** sqlite3BtreeUpdateMeta()
danielk197713adf8a2004-06-03 16:08:41 +00003390**
drhb8ef32c2005-03-14 02:01:49 +00003391** If an initial attempt to acquire the lock fails because of lock contention
3392** and the database was previously unlocked, then invoke the busy handler
3393** if there is one. But if there was previously a read-lock, do not
3394** invoke the busy handler - just return SQLITE_BUSY. SQLITE_BUSY is
3395** returned when there is already a read-lock in order to avoid a deadlock.
3396**
3397** Suppose there are two processes A and B. A has a read lock and B has
3398** a reserved lock. B tries to promote to exclusive but is blocked because
3399** of A's read lock. A tries to promote to reserved but is blocked by B.
3400** One or the other of the two processes must give way or there can be
3401** no progress. By returning SQLITE_BUSY and not invoking the busy callback
3402** when A already has a read lock, we encourage A to give up and let B
3403** proceed.
drha059ad02001-04-17 20:09:11 +00003404*/
drhbb2d9b12018-06-06 16:28:40 +00003405int sqlite3BtreeBeginTrans(Btree *p, int wrflag, int *pSchemaVersion){
danielk1977aef0bf62005-12-30 16:28:01 +00003406 BtShared *pBt = p->pBt;
dan7bb8b8a2020-05-06 20:27:18 +00003407 Pager *pPager = pBt->pPager;
danielk1977ee5741e2004-05-31 10:01:34 +00003408 int rc = SQLITE_OK;
3409
drhd677b3d2007-08-20 22:48:41 +00003410 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00003411 btreeIntegrity(p);
3412
danielk1977ee5741e2004-05-31 10:01:34 +00003413 /* If the btree is already in a write-transaction, or it
3414 ** is already in a read-transaction and a read-transaction
3415 ** is requested, this is a no-op.
3416 */
danielk1977aef0bf62005-12-30 16:28:01 +00003417 if( p->inTrans==TRANS_WRITE || (p->inTrans==TRANS_READ && !wrflag) ){
drhd677b3d2007-08-20 22:48:41 +00003418 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00003419 }
dan56c517a2013-09-26 11:04:33 +00003420 assert( pBt->inTransaction==TRANS_WRITE || IfNotOmitAV(pBt->bDoTruncate)==0 );
drhb8ef32c2005-03-14 02:01:49 +00003421
danea933f02018-07-19 11:44:02 +00003422 if( (p->db->flags & SQLITE_ResetDatabase)
dan7bb8b8a2020-05-06 20:27:18 +00003423 && sqlite3PagerIsreadonly(pPager)==0
danea933f02018-07-19 11:44:02 +00003424 ){
3425 pBt->btsFlags &= ~BTS_READ_ONLY;
3426 }
3427
drhb8ef32c2005-03-14 02:01:49 +00003428 /* Write transactions are not possible on a read-only database */
drhc9166342012-01-05 23:32:06 +00003429 if( (pBt->btsFlags & BTS_READ_ONLY)!=0 && wrflag ){
drhd677b3d2007-08-20 22:48:41 +00003430 rc = SQLITE_READONLY;
3431 goto trans_begun;
danielk1977ee5741e2004-05-31 10:01:34 +00003432 }
3433
danielk1977404ca072009-03-16 13:19:36 +00003434#ifndef SQLITE_OMIT_SHARED_CACHE
drh5a1fb182016-01-08 19:34:39 +00003435 {
3436 sqlite3 *pBlock = 0;
3437 /* If another database handle has already opened a write transaction
3438 ** on this shared-btree structure and a second write transaction is
3439 ** requested, return SQLITE_LOCKED.
3440 */
3441 if( (wrflag && pBt->inTransaction==TRANS_WRITE)
3442 || (pBt->btsFlags & BTS_PENDING)!=0
3443 ){
3444 pBlock = pBt->pWriter->db;
3445 }else if( wrflag>1 ){
3446 BtLock *pIter;
3447 for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
3448 if( pIter->pBtree!=p ){
3449 pBlock = pIter->pBtree->db;
3450 break;
3451 }
danielk1977641b0f42007-12-21 04:47:25 +00003452 }
3453 }
drh5a1fb182016-01-08 19:34:39 +00003454 if( pBlock ){
3455 sqlite3ConnectionBlocked(p->db, pBlock);
3456 rc = SQLITE_LOCKED_SHAREDCACHE;
3457 goto trans_begun;
3458 }
danielk1977404ca072009-03-16 13:19:36 +00003459 }
danielk1977641b0f42007-12-21 04:47:25 +00003460#endif
3461
danielk1977602b4662009-07-02 07:47:33 +00003462 /* Any read-only or read-write transaction implies a read-lock on
3463 ** page 1. So if some other shared-cache client already has a write-lock
3464 ** on page 1, the transaction cannot be opened. */
drh346a70c2020-06-15 20:27:35 +00003465 rc = querySharedCacheTableLock(p, SCHEMA_ROOT, READ_LOCK);
drh4c301aa2009-07-15 17:25:45 +00003466 if( SQLITE_OK!=rc ) goto trans_begun;
danielk1977602b4662009-07-02 07:47:33 +00003467
drhc9166342012-01-05 23:32:06 +00003468 pBt->btsFlags &= ~BTS_INITIALLY_EMPTY;
3469 if( pBt->nPage==0 ) pBt->btsFlags |= BTS_INITIALLY_EMPTY;
drhb8ef32c2005-03-14 02:01:49 +00003470 do {
dan11a81822020-05-07 14:26:40 +00003471 sqlite3PagerWalDb(pPager, p->db);
dan58021b22020-05-05 20:30:07 +00003472
3473#ifdef SQLITE_ENABLE_SETLK_TIMEOUT
3474 /* If transitioning from no transaction directly to a write transaction,
3475 ** block for the WRITER lock first if possible. */
3476 if( pBt->pPage1==0 && wrflag ){
3477 assert( pBt->inTransaction==TRANS_NONE );
dan861fb1e2020-05-06 19:14:41 +00003478 rc = sqlite3PagerWalWriteLock(pPager, 1);
dan7bb8b8a2020-05-06 20:27:18 +00003479 if( rc!=SQLITE_BUSY && rc!=SQLITE_OK ) break;
dan58021b22020-05-05 20:30:07 +00003480 }
3481#endif
3482
danielk1977295dc102009-04-01 19:07:03 +00003483 /* Call lockBtree() until either pBt->pPage1 is populated or
3484 ** lockBtree() returns something other than SQLITE_OK. lockBtree()
3485 ** may return SQLITE_OK but leave pBt->pPage1 set to 0 if after
3486 ** reading page 1 it discovers that the page-size of the database
3487 ** file is not pBt->pageSize. In this case lockBtree() will update
3488 ** pBt->pageSize to the page-size of the file on disk.
3489 */
3490 while( pBt->pPage1==0 && SQLITE_OK==(rc = lockBtree(pBt)) );
drh309169a2007-04-24 17:27:51 +00003491
drhb8ef32c2005-03-14 02:01:49 +00003492 if( rc==SQLITE_OK && wrflag ){
drhc9166342012-01-05 23:32:06 +00003493 if( (pBt->btsFlags & BTS_READ_ONLY)!=0 ){
drh309169a2007-04-24 17:27:51 +00003494 rc = SQLITE_READONLY;
3495 }else{
dan58021b22020-05-05 20:30:07 +00003496 rc = sqlite3PagerBegin(pPager, wrflag>1, sqlite3TempInMemory(p->db));
drh309169a2007-04-24 17:27:51 +00003497 if( rc==SQLITE_OK ){
3498 rc = newDatabase(pBt);
dan8bf6d702018-07-05 17:16:55 +00003499 }else if( rc==SQLITE_BUSY_SNAPSHOT && pBt->inTransaction==TRANS_NONE ){
3500 /* if there was no transaction opened when this function was
3501 ** called and SQLITE_BUSY_SNAPSHOT is returned, change the error
3502 ** code to SQLITE_BUSY. */
3503 rc = SQLITE_BUSY;
drh309169a2007-04-24 17:27:51 +00003504 }
drhb8ef32c2005-03-14 02:01:49 +00003505 }
3506 }
3507
danielk1977bd434552009-03-18 10:33:00 +00003508 if( rc!=SQLITE_OK ){
danfc87ab82020-05-06 19:22:59 +00003509 (void)sqlite3PagerWalWriteLock(pPager, 0);
drhb8ef32c2005-03-14 02:01:49 +00003510 unlockBtreeIfUnused(pBt);
3511 }
danf9b76712010-06-01 14:12:45 +00003512 }while( (rc&0xFF)==SQLITE_BUSY && pBt->inTransaction==TRANS_NONE &&
danielk19771ceedd32008-11-19 10:22:33 +00003513 btreeInvokeBusyHandler(pBt) );
dan7bb8b8a2020-05-06 20:27:18 +00003514 sqlite3PagerWalDb(pPager, 0);
3515#ifdef SQLITE_ENABLE_SETLK_TIMEOUT
3516 if( rc==SQLITE_BUSY_TIMEOUT ) rc = SQLITE_BUSY;
3517#endif
danielk1977aef0bf62005-12-30 16:28:01 +00003518
3519 if( rc==SQLITE_OK ){
3520 if( p->inTrans==TRANS_NONE ){
3521 pBt->nTransaction++;
danielk1977602b4662009-07-02 07:47:33 +00003522#ifndef SQLITE_OMIT_SHARED_CACHE
3523 if( p->sharable ){
drhf2f105d2012-08-20 15:53:54 +00003524 assert( p->lock.pBtree==p && p->lock.iTable==1 );
danielk1977602b4662009-07-02 07:47:33 +00003525 p->lock.eLock = READ_LOCK;
3526 p->lock.pNext = pBt->pLock;
3527 pBt->pLock = &p->lock;
3528 }
3529#endif
danielk1977aef0bf62005-12-30 16:28:01 +00003530 }
3531 p->inTrans = (wrflag?TRANS_WRITE:TRANS_READ);
3532 if( p->inTrans>pBt->inTransaction ){
3533 pBt->inTransaction = p->inTrans;
3534 }
danielk1977404ca072009-03-16 13:19:36 +00003535 if( wrflag ){
dan59257dc2010-08-04 11:34:31 +00003536 MemPage *pPage1 = pBt->pPage1;
3537#ifndef SQLITE_OMIT_SHARED_CACHE
danielk1977404ca072009-03-16 13:19:36 +00003538 assert( !pBt->pWriter );
3539 pBt->pWriter = p;
drhc9166342012-01-05 23:32:06 +00003540 pBt->btsFlags &= ~BTS_EXCLUSIVE;
3541 if( wrflag>1 ) pBt->btsFlags |= BTS_EXCLUSIVE;
danielk1977641b0f42007-12-21 04:47:25 +00003542#endif
dan59257dc2010-08-04 11:34:31 +00003543
3544 /* If the db-size header field is incorrect (as it may be if an old
3545 ** client has been writing the database file), update it now. Doing
3546 ** this sooner rather than later means the database size can safely
3547 ** re-read the database size from page 1 if a savepoint or transaction
3548 ** rollback occurs within the transaction.
3549 */
3550 if( pBt->nPage!=get4byte(&pPage1->aData[28]) ){
3551 rc = sqlite3PagerWrite(pPage1->pDbPage);
3552 if( rc==SQLITE_OK ){
3553 put4byte(&pPage1->aData[28], pBt->nPage);
3554 }
3555 }
3556 }
danielk1977aef0bf62005-12-30 16:28:01 +00003557 }
3558
drhd677b3d2007-08-20 22:48:41 +00003559trans_begun:
drhbb2d9b12018-06-06 16:28:40 +00003560 if( rc==SQLITE_OK ){
3561 if( pSchemaVersion ){
3562 *pSchemaVersion = get4byte(&pBt->pPage1->aData[40]);
3563 }
3564 if( wrflag ){
3565 /* This call makes sure that the pager has the correct number of
3566 ** open savepoints. If the second parameter is greater than 0 and
3567 ** the sub-journal is not already open, then it will be opened here.
3568 */
dan7bb8b8a2020-05-06 20:27:18 +00003569 rc = sqlite3PagerOpenSavepoint(pPager, p->db->nSavepoint);
drhbb2d9b12018-06-06 16:28:40 +00003570 }
danielk1977fd7f0452008-12-17 17:30:26 +00003571 }
danielk197712dd5492008-12-18 15:45:07 +00003572
danielk1977aef0bf62005-12-30 16:28:01 +00003573 btreeIntegrity(p);
drhd677b3d2007-08-20 22:48:41 +00003574 sqlite3BtreeLeave(p);
drhb8ca3072001-12-05 00:21:20 +00003575 return rc;
drha059ad02001-04-17 20:09:11 +00003576}
3577
danielk1977687566d2004-11-02 12:56:41 +00003578#ifndef SQLITE_OMIT_AUTOVACUUM
3579
3580/*
3581** Set the pointer-map entries for all children of page pPage. Also, if
3582** pPage contains cells that point to overflow pages, set the pointer
3583** map entries for the overflow pages as well.
3584*/
3585static int setChildPtrmaps(MemPage *pPage){
3586 int i; /* Counter variable */
3587 int nCell; /* Number of cells in page pPage */
danielk19772df71c72007-05-24 07:22:42 +00003588 int rc; /* Return code */
danielk1977aef0bf62005-12-30 16:28:01 +00003589 BtShared *pBt = pPage->pBt;
danielk1977687566d2004-11-02 12:56:41 +00003590 Pgno pgno = pPage->pgno;
3591
drh1fee73e2007-08-29 04:00:57 +00003592 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh14e845a2017-05-25 21:35:56 +00003593 rc = pPage->isInit ? SQLITE_OK : btreeInitPage(pPage);
drh2a702542016-12-12 18:12:03 +00003594 if( rc!=SQLITE_OK ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00003595 nCell = pPage->nCell;
3596
3597 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00003598 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00003599
drh0f1bf4c2019-01-13 20:17:21 +00003600 ptrmapPutOvflPtr(pPage, pPage, pCell, &rc);
danielk197726836652005-01-17 01:33:13 +00003601
danielk1977687566d2004-11-02 12:56:41 +00003602 if( !pPage->leaf ){
3603 Pgno childPgno = get4byte(pCell);
drh98add2e2009-07-20 17:11:49 +00003604 ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
danielk1977687566d2004-11-02 12:56:41 +00003605 }
3606 }
3607
3608 if( !pPage->leaf ){
3609 Pgno childPgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh98add2e2009-07-20 17:11:49 +00003610 ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
danielk1977687566d2004-11-02 12:56:41 +00003611 }
3612
danielk1977687566d2004-11-02 12:56:41 +00003613 return rc;
3614}
3615
3616/*
drhf3aed592009-07-08 18:12:49 +00003617** Somewhere on pPage is a pointer to page iFrom. Modify this pointer so
3618** that it points to iTo. Parameter eType describes the type of pointer to
3619** be modified, as follows:
danielk1977687566d2004-11-02 12:56:41 +00003620**
3621** PTRMAP_BTREE: pPage is a btree-page. The pointer points at a child
3622** page of pPage.
3623**
3624** PTRMAP_OVERFLOW1: pPage is a btree-page. The pointer points at an overflow
3625** page pointed to by one of the cells on pPage.
3626**
3627** PTRMAP_OVERFLOW2: pPage is an overflow-page. The pointer points at the next
3628** overflow page in the list.
3629*/
danielk1977fdb7cdb2005-01-17 02:12:18 +00003630static int modifyPagePointer(MemPage *pPage, Pgno iFrom, Pgno iTo, u8 eType){
drh1fee73e2007-08-29 04:00:57 +00003631 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhc5053fb2008-11-27 02:22:10 +00003632 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
danielk1977687566d2004-11-02 12:56:41 +00003633 if( eType==PTRMAP_OVERFLOW2 ){
danielk1977f78fc082004-11-02 14:40:32 +00003634 /* The pointer is always the first 4 bytes of the page in this case. */
danielk1977fdb7cdb2005-01-17 02:12:18 +00003635 if( get4byte(pPage->aData)!=iFrom ){
daneebf2f52017-11-18 17:30:08 +00003636 return SQLITE_CORRUPT_PAGE(pPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00003637 }
danielk1977f78fc082004-11-02 14:40:32 +00003638 put4byte(pPage->aData, iTo);
danielk1977687566d2004-11-02 12:56:41 +00003639 }else{
danielk1977687566d2004-11-02 12:56:41 +00003640 int i;
3641 int nCell;
drha1f75d92015-05-24 10:18:12 +00003642 int rc;
danielk1977687566d2004-11-02 12:56:41 +00003643
drh14e845a2017-05-25 21:35:56 +00003644 rc = pPage->isInit ? SQLITE_OK : btreeInitPage(pPage);
drha1f75d92015-05-24 10:18:12 +00003645 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00003646 nCell = pPage->nCell;
3647
danielk1977687566d2004-11-02 12:56:41 +00003648 for(i=0; i<nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00003649 u8 *pCell = findCell(pPage, i);
danielk1977687566d2004-11-02 12:56:41 +00003650 if( eType==PTRMAP_OVERFLOW1 ){
3651 CellInfo info;
drh5fa60512015-06-19 17:19:34 +00003652 pPage->xParseCell(pPage, pCell, &info);
drhb701c9a2017-01-12 15:11:03 +00003653 if( info.nLocal<info.nPayload ){
3654 if( pCell+info.nSize > pPage->aData+pPage->pBt->usableSize ){
daneebf2f52017-11-18 17:30:08 +00003655 return SQLITE_CORRUPT_PAGE(pPage);
drhb701c9a2017-01-12 15:11:03 +00003656 }
3657 if( iFrom==get4byte(pCell+info.nSize-4) ){
3658 put4byte(pCell+info.nSize-4, iTo);
3659 break;
3660 }
danielk1977687566d2004-11-02 12:56:41 +00003661 }
3662 }else{
3663 if( get4byte(pCell)==iFrom ){
3664 put4byte(pCell, iTo);
3665 break;
3666 }
3667 }
3668 }
3669
3670 if( i==nCell ){
danielk1977fdb7cdb2005-01-17 02:12:18 +00003671 if( eType!=PTRMAP_BTREE ||
3672 get4byte(&pPage->aData[pPage->hdrOffset+8])!=iFrom ){
daneebf2f52017-11-18 17:30:08 +00003673 return SQLITE_CORRUPT_PAGE(pPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00003674 }
danielk1977687566d2004-11-02 12:56:41 +00003675 put4byte(&pPage->aData[pPage->hdrOffset+8], iTo);
3676 }
danielk1977687566d2004-11-02 12:56:41 +00003677 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00003678 return SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00003679}
3680
danielk1977003ba062004-11-04 02:57:33 +00003681
danielk19777701e812005-01-10 12:59:51 +00003682/*
3683** Move the open database page pDbPage to location iFreePage in the
3684** database. The pDbPage reference remains valid.
drhe64ca7b2009-07-16 18:21:17 +00003685**
3686** The isCommit flag indicates that there is no need to remember that
3687** the journal needs to be sync()ed before database page pDbPage->pgno
3688** can be written to. The caller has already promised not to write to that
3689** page.
danielk19777701e812005-01-10 12:59:51 +00003690*/
danielk1977003ba062004-11-04 02:57:33 +00003691static int relocatePage(
danielk1977aef0bf62005-12-30 16:28:01 +00003692 BtShared *pBt, /* Btree */
danielk19777701e812005-01-10 12:59:51 +00003693 MemPage *pDbPage, /* Open page to move */
3694 u8 eType, /* Pointer map 'type' entry for pDbPage */
3695 Pgno iPtrPage, /* Pointer map 'page-no' entry for pDbPage */
danielk19774c999992008-07-16 18:17:55 +00003696 Pgno iFreePage, /* The location to move pDbPage to */
drhe64ca7b2009-07-16 18:21:17 +00003697 int isCommit /* isCommit flag passed to sqlite3PagerMovepage */
danielk1977003ba062004-11-04 02:57:33 +00003698){
3699 MemPage *pPtrPage; /* The page that contains a pointer to pDbPage */
3700 Pgno iDbPage = pDbPage->pgno;
3701 Pager *pPager = pBt->pPager;
3702 int rc;
3703
danielk1977a0bf2652004-11-04 14:30:04 +00003704 assert( eType==PTRMAP_OVERFLOW2 || eType==PTRMAP_OVERFLOW1 ||
3705 eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE );
drh1fee73e2007-08-29 04:00:57 +00003706 assert( sqlite3_mutex_held(pBt->mutex) );
drhd0679ed2007-08-28 22:24:34 +00003707 assert( pDbPage->pBt==pBt );
drh49272bc2018-10-31 01:04:18 +00003708 if( iDbPage<3 ) return SQLITE_CORRUPT_BKPT;
danielk1977003ba062004-11-04 02:57:33 +00003709
drh85b623f2007-12-13 21:54:09 +00003710 /* Move page iDbPage from its current location to page number iFreePage */
danielk1977003ba062004-11-04 02:57:33 +00003711 TRACE(("AUTOVACUUM: Moving %d to free page %d (ptr page %d type %d)\n",
3712 iDbPage, iFreePage, iPtrPage, eType));
danielk19774c999992008-07-16 18:17:55 +00003713 rc = sqlite3PagerMovepage(pPager, pDbPage->pDbPage, iFreePage, isCommit);
danielk1977003ba062004-11-04 02:57:33 +00003714 if( rc!=SQLITE_OK ){
3715 return rc;
3716 }
3717 pDbPage->pgno = iFreePage;
3718
3719 /* If pDbPage was a btree-page, then it may have child pages and/or cells
3720 ** that point to overflow pages. The pointer map entries for all these
3721 ** pages need to be changed.
3722 **
3723 ** If pDbPage is an overflow page, then the first 4 bytes may store a
3724 ** pointer to a subsequent overflow page. If this is the case, then
3725 ** the pointer map needs to be updated for the subsequent overflow page.
3726 */
danielk1977a0bf2652004-11-04 14:30:04 +00003727 if( eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00003728 rc = setChildPtrmaps(pDbPage);
3729 if( rc!=SQLITE_OK ){
3730 return rc;
3731 }
3732 }else{
3733 Pgno nextOvfl = get4byte(pDbPage->aData);
3734 if( nextOvfl!=0 ){
drh98add2e2009-07-20 17:11:49 +00003735 ptrmapPut(pBt, nextOvfl, PTRMAP_OVERFLOW2, iFreePage, &rc);
danielk1977003ba062004-11-04 02:57:33 +00003736 if( rc!=SQLITE_OK ){
3737 return rc;
3738 }
3739 }
3740 }
3741
3742 /* Fix the database pointer on page iPtrPage that pointed at iDbPage so
3743 ** that it points at iFreePage. Also fix the pointer map entry for
3744 ** iPtrPage.
3745 */
danielk1977a0bf2652004-11-04 14:30:04 +00003746 if( eType!=PTRMAP_ROOTPAGE ){
drhb00fc3b2013-08-21 23:42:32 +00003747 rc = btreeGetPage(pBt, iPtrPage, &pPtrPage, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003748 if( rc!=SQLITE_OK ){
3749 return rc;
3750 }
danielk19773b8a05f2007-03-19 17:44:26 +00003751 rc = sqlite3PagerWrite(pPtrPage->pDbPage);
danielk1977a0bf2652004-11-04 14:30:04 +00003752 if( rc!=SQLITE_OK ){
3753 releasePage(pPtrPage);
3754 return rc;
3755 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00003756 rc = modifyPagePointer(pPtrPage, iDbPage, iFreePage, eType);
danielk1977003ba062004-11-04 02:57:33 +00003757 releasePage(pPtrPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00003758 if( rc==SQLITE_OK ){
drh98add2e2009-07-20 17:11:49 +00003759 ptrmapPut(pBt, iFreePage, eType, iPtrPage, &rc);
danielk1977fdb7cdb2005-01-17 02:12:18 +00003760 }
danielk1977003ba062004-11-04 02:57:33 +00003761 }
danielk1977003ba062004-11-04 02:57:33 +00003762 return rc;
3763}
3764
danielk1977dddbcdc2007-04-26 14:42:34 +00003765/* Forward declaration required by incrVacuumStep(). */
drh4f0c5872007-03-26 22:05:01 +00003766static int allocateBtreePage(BtShared *, MemPage **, Pgno *, Pgno, u8);
danielk1977687566d2004-11-02 12:56:41 +00003767
3768/*
dan51f0b6d2013-02-22 20:16:34 +00003769** Perform a single step of an incremental-vacuum. If successful, return
3770** SQLITE_OK. If there is no work to do (and therefore no point in
3771** calling this function again), return SQLITE_DONE. Or, if an error
3772** occurs, return some other error code.
danielk1977dddbcdc2007-04-26 14:42:34 +00003773**
peter.d.reid60ec9142014-09-06 16:39:46 +00003774** More specifically, this function attempts to re-organize the database so
dan51f0b6d2013-02-22 20:16:34 +00003775** that the last page of the file currently in use is no longer in use.
danielk1977dddbcdc2007-04-26 14:42:34 +00003776**
dan51f0b6d2013-02-22 20:16:34 +00003777** Parameter nFin is the number of pages that this database would contain
3778** were this function called until it returns SQLITE_DONE.
3779**
3780** If the bCommit parameter is non-zero, this function assumes that the
3781** caller will keep calling incrVacuumStep() until it returns SQLITE_DONE
peter.d.reid60ec9142014-09-06 16:39:46 +00003782** or an error. bCommit is passed true for an auto-vacuum-on-commit
dan51f0b6d2013-02-22 20:16:34 +00003783** operation, or false for an incremental vacuum.
danielk1977dddbcdc2007-04-26 14:42:34 +00003784*/
dan51f0b6d2013-02-22 20:16:34 +00003785static int incrVacuumStep(BtShared *pBt, Pgno nFin, Pgno iLastPg, int bCommit){
danielk1977dddbcdc2007-04-26 14:42:34 +00003786 Pgno nFreeList; /* Number of pages still on the free-list */
drhdd3cd972010-03-27 17:12:36 +00003787 int rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00003788
drh1fee73e2007-08-29 04:00:57 +00003789 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977fa542f12009-04-02 18:28:08 +00003790 assert( iLastPg>nFin );
danielk1977dddbcdc2007-04-26 14:42:34 +00003791
3792 if( !PTRMAP_ISPAGE(pBt, iLastPg) && iLastPg!=PENDING_BYTE_PAGE(pBt) ){
danielk1977dddbcdc2007-04-26 14:42:34 +00003793 u8 eType;
3794 Pgno iPtrPage;
3795
3796 nFreeList = get4byte(&pBt->pPage1->aData[36]);
danielk1977fa542f12009-04-02 18:28:08 +00003797 if( nFreeList==0 ){
danielk1977dddbcdc2007-04-26 14:42:34 +00003798 return SQLITE_DONE;
3799 }
3800
3801 rc = ptrmapGet(pBt, iLastPg, &eType, &iPtrPage);
3802 if( rc!=SQLITE_OK ){
3803 return rc;
3804 }
3805 if( eType==PTRMAP_ROOTPAGE ){
3806 return SQLITE_CORRUPT_BKPT;
3807 }
3808
3809 if( eType==PTRMAP_FREEPAGE ){
dan51f0b6d2013-02-22 20:16:34 +00003810 if( bCommit==0 ){
danielk1977dddbcdc2007-04-26 14:42:34 +00003811 /* Remove the page from the files free-list. This is not required
dan51f0b6d2013-02-22 20:16:34 +00003812 ** if bCommit is non-zero. In that case, the free-list will be
danielk1977dddbcdc2007-04-26 14:42:34 +00003813 ** truncated to zero after this function returns, so it doesn't
3814 ** matter if it still contains some garbage entries.
3815 */
3816 Pgno iFreePg;
3817 MemPage *pFreePg;
dan51f0b6d2013-02-22 20:16:34 +00003818 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iLastPg, BTALLOC_EXACT);
danielk1977dddbcdc2007-04-26 14:42:34 +00003819 if( rc!=SQLITE_OK ){
3820 return rc;
3821 }
3822 assert( iFreePg==iLastPg );
3823 releasePage(pFreePg);
3824 }
3825 } else {
3826 Pgno iFreePg; /* Index of free page to move pLastPg to */
3827 MemPage *pLastPg;
dan51f0b6d2013-02-22 20:16:34 +00003828 u8 eMode = BTALLOC_ANY; /* Mode parameter for allocateBtreePage() */
3829 Pgno iNear = 0; /* nearby parameter for allocateBtreePage() */
danielk1977dddbcdc2007-04-26 14:42:34 +00003830
drhb00fc3b2013-08-21 23:42:32 +00003831 rc = btreeGetPage(pBt, iLastPg, &pLastPg, 0);
danielk1977dddbcdc2007-04-26 14:42:34 +00003832 if( rc!=SQLITE_OK ){
3833 return rc;
3834 }
3835
dan51f0b6d2013-02-22 20:16:34 +00003836 /* If bCommit is zero, this loop runs exactly once and page pLastPg
danielk1977b4626a32007-04-28 15:47:43 +00003837 ** is swapped with the first free page pulled off the free list.
3838 **
dan51f0b6d2013-02-22 20:16:34 +00003839 ** On the other hand, if bCommit is greater than zero, then keep
danielk1977b4626a32007-04-28 15:47:43 +00003840 ** looping until a free-page located within the first nFin pages
3841 ** of the file is found.
3842 */
dan51f0b6d2013-02-22 20:16:34 +00003843 if( bCommit==0 ){
3844 eMode = BTALLOC_LE;
3845 iNear = nFin;
3846 }
danielk1977dddbcdc2007-04-26 14:42:34 +00003847 do {
3848 MemPage *pFreePg;
dan51f0b6d2013-02-22 20:16:34 +00003849 rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iNear, eMode);
danielk1977dddbcdc2007-04-26 14:42:34 +00003850 if( rc!=SQLITE_OK ){
3851 releasePage(pLastPg);
3852 return rc;
3853 }
3854 releasePage(pFreePg);
dan51f0b6d2013-02-22 20:16:34 +00003855 }while( bCommit && iFreePg>nFin );
danielk1977dddbcdc2007-04-26 14:42:34 +00003856 assert( iFreePg<iLastPg );
danielk1977b4626a32007-04-28 15:47:43 +00003857
dane1df4e32013-03-05 11:27:04 +00003858 rc = relocatePage(pBt, pLastPg, eType, iPtrPage, iFreePg, bCommit);
danielk1977dddbcdc2007-04-26 14:42:34 +00003859 releasePage(pLastPg);
3860 if( rc!=SQLITE_OK ){
3861 return rc;
danielk1977662278e2007-11-05 15:30:12 +00003862 }
danielk1977dddbcdc2007-04-26 14:42:34 +00003863 }
3864 }
3865
dan51f0b6d2013-02-22 20:16:34 +00003866 if( bCommit==0 ){
danbc1a3c62013-02-23 16:40:46 +00003867 do {
danielk19773460d192008-12-27 15:23:13 +00003868 iLastPg--;
danbc1a3c62013-02-23 16:40:46 +00003869 }while( iLastPg==PENDING_BYTE_PAGE(pBt) || PTRMAP_ISPAGE(pBt, iLastPg) );
3870 pBt->bDoTruncate = 1;
drhdd3cd972010-03-27 17:12:36 +00003871 pBt->nPage = iLastPg;
danielk1977dddbcdc2007-04-26 14:42:34 +00003872 }
3873 return SQLITE_OK;
3874}
3875
3876/*
dan51f0b6d2013-02-22 20:16:34 +00003877** The database opened by the first argument is an auto-vacuum database
3878** nOrig pages in size containing nFree free pages. Return the expected
3879** size of the database in pages following an auto-vacuum operation.
3880*/
3881static Pgno finalDbSize(BtShared *pBt, Pgno nOrig, Pgno nFree){
3882 int nEntry; /* Number of entries on one ptrmap page */
3883 Pgno nPtrmap; /* Number of PtrMap pages to be freed */
3884 Pgno nFin; /* Return value */
3885
3886 nEntry = pBt->usableSize/5;
3887 nPtrmap = (nFree-nOrig+PTRMAP_PAGENO(pBt, nOrig)+nEntry)/nEntry;
3888 nFin = nOrig - nFree - nPtrmap;
3889 if( nOrig>PENDING_BYTE_PAGE(pBt) && nFin<PENDING_BYTE_PAGE(pBt) ){
3890 nFin--;
3891 }
3892 while( PTRMAP_ISPAGE(pBt, nFin) || nFin==PENDING_BYTE_PAGE(pBt) ){
3893 nFin--;
3894 }
dan51f0b6d2013-02-22 20:16:34 +00003895
3896 return nFin;
3897}
3898
3899/*
danielk1977dddbcdc2007-04-26 14:42:34 +00003900** A write-transaction must be opened before calling this function.
3901** It performs a single unit of work towards an incremental vacuum.
3902**
3903** If the incremental vacuum is finished after this function has run,
shanebe217792009-03-05 04:20:31 +00003904** SQLITE_DONE is returned. If it is not finished, but no error occurred,
danielk1977dddbcdc2007-04-26 14:42:34 +00003905** SQLITE_OK is returned. Otherwise an SQLite error code.
3906*/
3907int sqlite3BtreeIncrVacuum(Btree *p){
drhd677b3d2007-08-20 22:48:41 +00003908 int rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00003909 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00003910
3911 sqlite3BtreeEnter(p);
danielk1977dddbcdc2007-04-26 14:42:34 +00003912 assert( pBt->inTransaction==TRANS_WRITE && p->inTrans==TRANS_WRITE );
3913 if( !pBt->autoVacuum ){
drhd677b3d2007-08-20 22:48:41 +00003914 rc = SQLITE_DONE;
3915 }else{
dan51f0b6d2013-02-22 20:16:34 +00003916 Pgno nOrig = btreePagecount(pBt);
3917 Pgno nFree = get4byte(&pBt->pPage1->aData[36]);
3918 Pgno nFin = finalDbSize(pBt, nOrig, nFree);
3919
drhbc2cf3b2020-07-14 12:40:53 +00003920 if( nOrig<nFin || nFree>=nOrig ){
dan91384712013-02-24 11:50:43 +00003921 rc = SQLITE_CORRUPT_BKPT;
3922 }else if( nFree>0 ){
dan11dcd112013-03-15 18:29:18 +00003923 rc = saveAllCursors(pBt, 0, 0);
3924 if( rc==SQLITE_OK ){
3925 invalidateAllOverflowCache(pBt);
3926 rc = incrVacuumStep(pBt, nFin, nOrig, 0);
3927 }
dan51f0b6d2013-02-22 20:16:34 +00003928 if( rc==SQLITE_OK ){
3929 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
3930 put4byte(&pBt->pPage1->aData[28], pBt->nPage);
3931 }
3932 }else{
3933 rc = SQLITE_DONE;
drhdd3cd972010-03-27 17:12:36 +00003934 }
danielk1977dddbcdc2007-04-26 14:42:34 +00003935 }
drhd677b3d2007-08-20 22:48:41 +00003936 sqlite3BtreeLeave(p);
3937 return rc;
danielk1977dddbcdc2007-04-26 14:42:34 +00003938}
3939
3940/*
danielk19773b8a05f2007-03-19 17:44:26 +00003941** This routine is called prior to sqlite3PagerCommit when a transaction
drhf7b54962013-05-28 12:11:54 +00003942** is committed for an auto-vacuum database.
danielk197724168722007-04-02 05:07:47 +00003943**
3944** If SQLITE_OK is returned, then *pnTrunc is set to the number of pages
3945** the database file should be truncated to during the commit process.
3946** i.e. the database has been reorganized so that only the first *pnTrunc
3947** pages are in use.
danielk1977687566d2004-11-02 12:56:41 +00003948*/
danielk19773460d192008-12-27 15:23:13 +00003949static int autoVacuumCommit(BtShared *pBt){
danielk1977dddbcdc2007-04-26 14:42:34 +00003950 int rc = SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00003951 Pager *pPager = pBt->pPager;
mistachkinc29cbb02015-07-02 16:52:01 +00003952 VVA_ONLY( int nRef = sqlite3PagerRefcount(pPager); )
danielk1977687566d2004-11-02 12:56:41 +00003953
drh1fee73e2007-08-29 04:00:57 +00003954 assert( sqlite3_mutex_held(pBt->mutex) );
danielk197792d4d7a2007-05-04 12:05:56 +00003955 invalidateAllOverflowCache(pBt);
danielk1977dddbcdc2007-04-26 14:42:34 +00003956 assert(pBt->autoVacuum);
3957 if( !pBt->incrVacuum ){
drhea8ffdf2009-07-22 00:35:23 +00003958 Pgno nFin; /* Number of pages in database after autovacuuming */
3959 Pgno nFree; /* Number of pages on the freelist initially */
drh41d628c2009-07-11 17:04:08 +00003960 Pgno iFree; /* The next page to be freed */
drh41d628c2009-07-11 17:04:08 +00003961 Pgno nOrig; /* Database size before freeing */
danielk1977687566d2004-11-02 12:56:41 +00003962
drhb1299152010-03-30 22:58:33 +00003963 nOrig = btreePagecount(pBt);
danielk1977ef165ce2009-04-06 17:50:03 +00003964 if( PTRMAP_ISPAGE(pBt, nOrig) || nOrig==PENDING_BYTE_PAGE(pBt) ){
3965 /* It is not possible to create a database for which the final page
3966 ** is either a pointer-map page or the pending-byte page. If one
3967 ** is encountered, this indicates corruption.
3968 */
danielk19773460d192008-12-27 15:23:13 +00003969 return SQLITE_CORRUPT_BKPT;
3970 }
danielk1977ef165ce2009-04-06 17:50:03 +00003971
danielk19773460d192008-12-27 15:23:13 +00003972 nFree = get4byte(&pBt->pPage1->aData[36]);
dan51f0b6d2013-02-22 20:16:34 +00003973 nFin = finalDbSize(pBt, nOrig, nFree);
drhc5e47ac2009-06-04 00:11:56 +00003974 if( nFin>nOrig ) return SQLITE_CORRUPT_BKPT;
dan0aed84d2013-03-26 14:16:20 +00003975 if( nFin<nOrig ){
3976 rc = saveAllCursors(pBt, 0, 0);
3977 }
danielk19773460d192008-12-27 15:23:13 +00003978 for(iFree=nOrig; iFree>nFin && rc==SQLITE_OK; iFree--){
dan51f0b6d2013-02-22 20:16:34 +00003979 rc = incrVacuumStep(pBt, nFin, iFree, 1);
danielk1977dddbcdc2007-04-26 14:42:34 +00003980 }
danielk19773460d192008-12-27 15:23:13 +00003981 if( (rc==SQLITE_DONE || rc==SQLITE_OK) && nFree>0 ){
danielk19773460d192008-12-27 15:23:13 +00003982 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
3983 put4byte(&pBt->pPage1->aData[32], 0);
3984 put4byte(&pBt->pPage1->aData[36], 0);
drhdd3cd972010-03-27 17:12:36 +00003985 put4byte(&pBt->pPage1->aData[28], nFin);
danbc1a3c62013-02-23 16:40:46 +00003986 pBt->bDoTruncate = 1;
drhdd3cd972010-03-27 17:12:36 +00003987 pBt->nPage = nFin;
danielk1977dddbcdc2007-04-26 14:42:34 +00003988 }
3989 if( rc!=SQLITE_OK ){
3990 sqlite3PagerRollback(pPager);
3991 }
danielk1977687566d2004-11-02 12:56:41 +00003992 }
3993
dan0aed84d2013-03-26 14:16:20 +00003994 assert( nRef>=sqlite3PagerRefcount(pPager) );
danielk1977687566d2004-11-02 12:56:41 +00003995 return rc;
3996}
danielk1977dddbcdc2007-04-26 14:42:34 +00003997
danielk1977a50d9aa2009-06-08 14:49:45 +00003998#else /* ifndef SQLITE_OMIT_AUTOVACUUM */
3999# define setChildPtrmaps(x) SQLITE_OK
4000#endif
danielk1977687566d2004-11-02 12:56:41 +00004001
4002/*
drh80e35f42007-03-30 14:06:34 +00004003** This routine does the first phase of a two-phase commit. This routine
4004** causes a rollback journal to be created (if it does not already exist)
4005** and populated with enough information so that if a power loss occurs
4006** the database can be restored to its original state by playing back
4007** the journal. Then the contents of the journal are flushed out to
4008** the disk. After the journal is safely on oxide, the changes to the
4009** database are written into the database file and flushed to oxide.
4010** At the end of this call, the rollback journal still exists on the
4011** disk and we are still holding all locks, so the transaction has not
drh51898cf2009-04-19 20:51:06 +00004012** committed. See sqlite3BtreeCommitPhaseTwo() for the second phase of the
drh80e35f42007-03-30 14:06:34 +00004013** commit process.
4014**
4015** This call is a no-op if no write-transaction is currently active on pBt.
4016**
drh067b92b2020-06-19 15:24:12 +00004017** Otherwise, sync the database file for the btree pBt. zSuperJrnl points to
4018** the name of a super-journal file that should be written into the
4019** individual journal file, or is NULL, indicating no super-journal file
drh80e35f42007-03-30 14:06:34 +00004020** (single database transaction).
4021**
drh067b92b2020-06-19 15:24:12 +00004022** When this is called, the super-journal should already have been
drh80e35f42007-03-30 14:06:34 +00004023** created, populated with this journal pointer and synced to disk.
4024**
4025** Once this is routine has returned, the only thing required to commit
4026** the write-transaction for this database file is to delete the journal.
4027*/
drh067b92b2020-06-19 15:24:12 +00004028int sqlite3BtreeCommitPhaseOne(Btree *p, const char *zSuperJrnl){
drh80e35f42007-03-30 14:06:34 +00004029 int rc = SQLITE_OK;
4030 if( p->inTrans==TRANS_WRITE ){
4031 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00004032 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00004033#ifndef SQLITE_OMIT_AUTOVACUUM
4034 if( pBt->autoVacuum ){
danielk19773460d192008-12-27 15:23:13 +00004035 rc = autoVacuumCommit(pBt);
drh80e35f42007-03-30 14:06:34 +00004036 if( rc!=SQLITE_OK ){
drhd677b3d2007-08-20 22:48:41 +00004037 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00004038 return rc;
4039 }
4040 }
danbc1a3c62013-02-23 16:40:46 +00004041 if( pBt->bDoTruncate ){
4042 sqlite3PagerTruncateImage(pBt->pPager, pBt->nPage);
4043 }
drh80e35f42007-03-30 14:06:34 +00004044#endif
drh067b92b2020-06-19 15:24:12 +00004045 rc = sqlite3PagerCommitPhaseOne(pBt->pPager, zSuperJrnl, 0);
drhd677b3d2007-08-20 22:48:41 +00004046 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00004047 }
4048 return rc;
4049}
4050
4051/*
danielk197794b30732009-07-02 17:21:57 +00004052** This function is called from both BtreeCommitPhaseTwo() and BtreeRollback()
4053** at the conclusion of a transaction.
4054*/
4055static void btreeEndTransaction(Btree *p){
4056 BtShared *pBt = p->pBt;
drh1713afb2013-06-28 01:24:57 +00004057 sqlite3 *db = p->db;
danielk197794b30732009-07-02 17:21:57 +00004058 assert( sqlite3BtreeHoldsMutex(p) );
4059
danbc1a3c62013-02-23 16:40:46 +00004060#ifndef SQLITE_OMIT_AUTOVACUUM
4061 pBt->bDoTruncate = 0;
4062#endif
danc0537fe2013-06-28 19:41:43 +00004063 if( p->inTrans>TRANS_NONE && db->nVdbeRead>1 ){
danfa401de2009-10-16 14:55:03 +00004064 /* If there are other active statements that belong to this database
4065 ** handle, downgrade to a read-only transaction. The other statements
4066 ** may still be reading from the database. */
danielk197794b30732009-07-02 17:21:57 +00004067 downgradeAllSharedCacheTableLocks(p);
4068 p->inTrans = TRANS_READ;
4069 }else{
4070 /* If the handle had any kind of transaction open, decrement the
4071 ** transaction count of the shared btree. If the transaction count
4072 ** reaches 0, set the shared state to TRANS_NONE. The unlockBtreeIfUnused()
4073 ** call below will unlock the pager. */
4074 if( p->inTrans!=TRANS_NONE ){
4075 clearAllSharedCacheTableLocks(p);
4076 pBt->nTransaction--;
4077 if( 0==pBt->nTransaction ){
4078 pBt->inTransaction = TRANS_NONE;
4079 }
4080 }
4081
4082 /* Set the current transaction state to TRANS_NONE and unlock the
4083 ** pager if this call closed the only read or write transaction. */
4084 p->inTrans = TRANS_NONE;
4085 unlockBtreeIfUnused(pBt);
4086 }
4087
4088 btreeIntegrity(p);
4089}
4090
4091/*
drh2aa679f2001-06-25 02:11:07 +00004092** Commit the transaction currently in progress.
drh5e00f6c2001-09-13 13:46:56 +00004093**
drh6e345992007-03-30 11:12:08 +00004094** This routine implements the second phase of a 2-phase commit. The
drh51898cf2009-04-19 20:51:06 +00004095** sqlite3BtreeCommitPhaseOne() routine does the first phase and should
4096** be invoked prior to calling this routine. The sqlite3BtreeCommitPhaseOne()
4097** routine did all the work of writing information out to disk and flushing the
drh6e345992007-03-30 11:12:08 +00004098** contents so that they are written onto the disk platter. All this
drh51898cf2009-04-19 20:51:06 +00004099** routine has to do is delete or truncate or zero the header in the
4100** the rollback journal (which causes the transaction to commit) and
4101** drop locks.
drh6e345992007-03-30 11:12:08 +00004102**
dan60939d02011-03-29 15:40:55 +00004103** Normally, if an error occurs while the pager layer is attempting to
4104** finalize the underlying journal file, this function returns an error and
4105** the upper layer will attempt a rollback. However, if the second argument
4106** is non-zero then this b-tree transaction is part of a multi-file
4107** transaction. In this case, the transaction has already been committed
drh067b92b2020-06-19 15:24:12 +00004108** (by deleting a super-journal file) and the caller will ignore this
dan60939d02011-03-29 15:40:55 +00004109** functions return code. So, even if an error occurs in the pager layer,
4110** reset the b-tree objects internal state to indicate that the write
4111** transaction has been closed. This is quite safe, as the pager will have
4112** transitioned to the error state.
4113**
drh5e00f6c2001-09-13 13:46:56 +00004114** This will release the write lock on the database file. If there
4115** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00004116*/
dan60939d02011-03-29 15:40:55 +00004117int sqlite3BtreeCommitPhaseTwo(Btree *p, int bCleanup){
danielk1977aef0bf62005-12-30 16:28:01 +00004118
drh075ed302010-10-14 01:17:30 +00004119 if( p->inTrans==TRANS_NONE ) return SQLITE_OK;
drhd677b3d2007-08-20 22:48:41 +00004120 sqlite3BtreeEnter(p);
danielk1977aef0bf62005-12-30 16:28:01 +00004121 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00004122
4123 /* If the handle has a write-transaction open, commit the shared-btrees
4124 ** transaction and set the shared state to TRANS_READ.
4125 */
4126 if( p->inTrans==TRANS_WRITE ){
danielk19777f7bc662006-01-23 13:47:47 +00004127 int rc;
drh075ed302010-10-14 01:17:30 +00004128 BtShared *pBt = p->pBt;
danielk1977aef0bf62005-12-30 16:28:01 +00004129 assert( pBt->inTransaction==TRANS_WRITE );
4130 assert( pBt->nTransaction>0 );
drh80e35f42007-03-30 14:06:34 +00004131 rc = sqlite3PagerCommitPhaseTwo(pBt->pPager);
dan60939d02011-03-29 15:40:55 +00004132 if( rc!=SQLITE_OK && bCleanup==0 ){
drhd677b3d2007-08-20 22:48:41 +00004133 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00004134 return rc;
4135 }
drh2b994ce2021-03-18 12:36:09 +00004136 p->iBDataVersion--; /* Compensate for pPager->iDataVersion++; */
danielk1977aef0bf62005-12-30 16:28:01 +00004137 pBt->inTransaction = TRANS_READ;
danbf0e57a2013-05-14 20:36:31 +00004138 btreeClearHasContent(pBt);
danielk1977ee5741e2004-05-31 10:01:34 +00004139 }
danielk1977aef0bf62005-12-30 16:28:01 +00004140
danielk197794b30732009-07-02 17:21:57 +00004141 btreeEndTransaction(p);
drhd677b3d2007-08-20 22:48:41 +00004142 sqlite3BtreeLeave(p);
danielk19777f7bc662006-01-23 13:47:47 +00004143 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00004144}
4145
drh80e35f42007-03-30 14:06:34 +00004146/*
4147** Do both phases of a commit.
4148*/
4149int sqlite3BtreeCommit(Btree *p){
4150 int rc;
drhd677b3d2007-08-20 22:48:41 +00004151 sqlite3BtreeEnter(p);
drh80e35f42007-03-30 14:06:34 +00004152 rc = sqlite3BtreeCommitPhaseOne(p, 0);
4153 if( rc==SQLITE_OK ){
dan60939d02011-03-29 15:40:55 +00004154 rc = sqlite3BtreeCommitPhaseTwo(p, 0);
drh80e35f42007-03-30 14:06:34 +00004155 }
drhd677b3d2007-08-20 22:48:41 +00004156 sqlite3BtreeLeave(p);
drh80e35f42007-03-30 14:06:34 +00004157 return rc;
4158}
4159
drhc39e0002004-05-07 23:50:57 +00004160/*
drhfb982642007-08-30 01:19:59 +00004161** This routine sets the state to CURSOR_FAULT and the error
drh47b7fc72014-11-11 01:33:57 +00004162** code to errCode for every cursor on any BtShared that pBtree
4163** references. Or if the writeOnly flag is set to 1, then only
4164** trip write cursors and leave read cursors unchanged.
drhfb982642007-08-30 01:19:59 +00004165**
drh47b7fc72014-11-11 01:33:57 +00004166** Every cursor is a candidate to be tripped, including cursors
4167** that belong to other database connections that happen to be
4168** sharing the cache with pBtree.
drhfb982642007-08-30 01:19:59 +00004169**
dan80231042014-11-12 14:56:02 +00004170** This routine gets called when a rollback occurs. If the writeOnly
4171** flag is true, then only write-cursors need be tripped - read-only
4172** cursors save their current positions so that they may continue
4173** following the rollback. Or, if writeOnly is false, all cursors are
4174** tripped. In general, writeOnly is false if the transaction being
4175** rolled back modified the database schema. In this case b-tree root
4176** pages may be moved or deleted from the database altogether, making
4177** it unsafe for read cursors to continue.
4178**
4179** If the writeOnly flag is true and an error is encountered while
4180** saving the current position of a read-only cursor, all cursors,
4181** including all read-cursors are tripped.
4182**
4183** SQLITE_OK is returned if successful, or if an error occurs while
4184** saving a cursor position, an SQLite error code.
drhfb982642007-08-30 01:19:59 +00004185*/
dan80231042014-11-12 14:56:02 +00004186int sqlite3BtreeTripAllCursors(Btree *pBtree, int errCode, int writeOnly){
drhfb982642007-08-30 01:19:59 +00004187 BtCursor *p;
dan80231042014-11-12 14:56:02 +00004188 int rc = SQLITE_OK;
4189
drh47b7fc72014-11-11 01:33:57 +00004190 assert( (writeOnly==0 || writeOnly==1) && BTCF_WriteFlag==1 );
dan80231042014-11-12 14:56:02 +00004191 if( pBtree ){
4192 sqlite3BtreeEnter(pBtree);
4193 for(p=pBtree->pBt->pCursor; p; p=p->pNext){
dan80231042014-11-12 14:56:02 +00004194 if( writeOnly && (p->curFlags & BTCF_WriteFlag)==0 ){
drhd2f83132015-03-25 17:35:01 +00004195 if( p->eState==CURSOR_VALID || p->eState==CURSOR_SKIPNEXT ){
drhbea3b972014-11-18 20:22:05 +00004196 rc = saveCursorPosition(p);
dan80231042014-11-12 14:56:02 +00004197 if( rc!=SQLITE_OK ){
4198 (void)sqlite3BtreeTripAllCursors(pBtree, rc, 0);
4199 break;
4200 }
4201 }
4202 }else{
4203 sqlite3BtreeClearCursor(p);
4204 p->eState = CURSOR_FAULT;
4205 p->skipNext = errCode;
4206 }
drh85ef6302017-08-02 15:50:09 +00004207 btreeReleaseAllCursorPages(p);
danielk1977bc2ca9e2008-11-13 14:28:28 +00004208 }
dan80231042014-11-12 14:56:02 +00004209 sqlite3BtreeLeave(pBtree);
drhfb982642007-08-30 01:19:59 +00004210 }
dan80231042014-11-12 14:56:02 +00004211 return rc;
drhfb982642007-08-30 01:19:59 +00004212}
4213
4214/*
drh41422652019-05-10 14:34:18 +00004215** Set the pBt->nPage field correctly, according to the current
4216** state of the database. Assume pBt->pPage1 is valid.
4217*/
4218static void btreeSetNPage(BtShared *pBt, MemPage *pPage1){
4219 int nPage = get4byte(&pPage1->aData[28]);
4220 testcase( nPage==0 );
4221 if( nPage==0 ) sqlite3PagerPagecount(pBt->pPager, &nPage);
4222 testcase( pBt->nPage!=nPage );
4223 pBt->nPage = nPage;
4224}
4225
4226/*
drh47b7fc72014-11-11 01:33:57 +00004227** Rollback the transaction in progress.
4228**
4229** If tripCode is not SQLITE_OK then cursors will be invalidated (tripped).
4230** Only write cursors are tripped if writeOnly is true but all cursors are
4231** tripped if writeOnly is false. Any attempt to use
4232** a tripped cursor will result in an error.
drh5e00f6c2001-09-13 13:46:56 +00004233**
4234** This will release the write lock on the database file. If there
4235** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00004236*/
drh47b7fc72014-11-11 01:33:57 +00004237int sqlite3BtreeRollback(Btree *p, int tripCode, int writeOnly){
danielk19778d34dfd2006-01-24 16:37:57 +00004238 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00004239 BtShared *pBt = p->pBt;
drh24cd67e2004-05-10 16:18:47 +00004240 MemPage *pPage1;
danielk1977aef0bf62005-12-30 16:28:01 +00004241
drh47b7fc72014-11-11 01:33:57 +00004242 assert( writeOnly==1 || writeOnly==0 );
4243 assert( tripCode==SQLITE_ABORT_ROLLBACK || tripCode==SQLITE_OK );
drhd677b3d2007-08-20 22:48:41 +00004244 sqlite3BtreeEnter(p);
drh0f198a72012-02-13 16:43:16 +00004245 if( tripCode==SQLITE_OK ){
4246 rc = tripCode = saveAllCursors(pBt, 0, 0);
drh47b7fc72014-11-11 01:33:57 +00004247 if( rc ) writeOnly = 0;
drh0f198a72012-02-13 16:43:16 +00004248 }else{
4249 rc = SQLITE_OK;
danielk19772b8c13e2006-01-24 14:21:24 +00004250 }
drh0f198a72012-02-13 16:43:16 +00004251 if( tripCode ){
dan80231042014-11-12 14:56:02 +00004252 int rc2 = sqlite3BtreeTripAllCursors(p, tripCode, writeOnly);
4253 assert( rc==SQLITE_OK || (writeOnly==0 && rc2==SQLITE_OK) );
4254 if( rc2!=SQLITE_OK ) rc = rc2;
drh0f198a72012-02-13 16:43:16 +00004255 }
danielk1977aef0bf62005-12-30 16:28:01 +00004256 btreeIntegrity(p);
danielk1977aef0bf62005-12-30 16:28:01 +00004257
4258 if( p->inTrans==TRANS_WRITE ){
danielk19778d34dfd2006-01-24 16:37:57 +00004259 int rc2;
danielk1977aef0bf62005-12-30 16:28:01 +00004260
danielk19778d34dfd2006-01-24 16:37:57 +00004261 assert( TRANS_WRITE==pBt->inTransaction );
danielk19773b8a05f2007-03-19 17:44:26 +00004262 rc2 = sqlite3PagerRollback(pBt->pPager);
danielk19778d34dfd2006-01-24 16:37:57 +00004263 if( rc2!=SQLITE_OK ){
4264 rc = rc2;
4265 }
4266
drh24cd67e2004-05-10 16:18:47 +00004267 /* The rollback may have destroyed the pPage1->aData value. So
danielk197730548662009-07-09 05:07:37 +00004268 ** call btreeGetPage() on page 1 again to make
drh16a9b832007-05-05 18:39:25 +00004269 ** sure pPage1->aData is set correctly. */
drhb00fc3b2013-08-21 23:42:32 +00004270 if( btreeGetPage(pBt, 1, &pPage1, 0)==SQLITE_OK ){
drh41422652019-05-10 14:34:18 +00004271 btreeSetNPage(pBt, pPage1);
drh3908fe92017-09-01 14:50:19 +00004272 releasePageOne(pPage1);
drh24cd67e2004-05-10 16:18:47 +00004273 }
drh85ec3b62013-05-14 23:12:06 +00004274 assert( countValidCursors(pBt, 1)==0 );
danielk1977aef0bf62005-12-30 16:28:01 +00004275 pBt->inTransaction = TRANS_READ;
danbf0e57a2013-05-14 20:36:31 +00004276 btreeClearHasContent(pBt);
drh24cd67e2004-05-10 16:18:47 +00004277 }
danielk1977aef0bf62005-12-30 16:28:01 +00004278
danielk197794b30732009-07-02 17:21:57 +00004279 btreeEndTransaction(p);
drhd677b3d2007-08-20 22:48:41 +00004280 sqlite3BtreeLeave(p);
drha059ad02001-04-17 20:09:11 +00004281 return rc;
4282}
4283
4284/*
peter.d.reid60ec9142014-09-06 16:39:46 +00004285** Start a statement subtransaction. The subtransaction can be rolled
danielk1977bd434552009-03-18 10:33:00 +00004286** back independently of the main transaction. You must start a transaction
4287** before starting a subtransaction. The subtransaction is ended automatically
4288** if the main transaction commits or rolls back.
drhab01f612004-05-22 02:55:23 +00004289**
4290** Statement subtransactions are used around individual SQL statements
4291** that are contained within a BEGIN...COMMIT block. If a constraint
4292** error occurs within the statement, the effect of that one statement
4293** can be rolled back without having to rollback the entire transaction.
danielk1977bd434552009-03-18 10:33:00 +00004294**
4295** A statement sub-transaction is implemented as an anonymous savepoint. The
4296** value passed as the second parameter is the total number of savepoints,
4297** including the new anonymous savepoint, open on the B-Tree. i.e. if there
4298** are no active savepoints and no other statement-transactions open,
4299** iStatement is 1. This anonymous savepoint can be released or rolled back
4300** using the sqlite3BtreeSavepoint() function.
drh663fc632002-02-02 18:49:19 +00004301*/
danielk1977bd434552009-03-18 10:33:00 +00004302int sqlite3BtreeBeginStmt(Btree *p, int iStatement){
drh663fc632002-02-02 18:49:19 +00004303 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00004304 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00004305 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00004306 assert( p->inTrans==TRANS_WRITE );
drhc9166342012-01-05 23:32:06 +00004307 assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk1977bd434552009-03-18 10:33:00 +00004308 assert( iStatement>0 );
4309 assert( iStatement>p->db->nSavepoint );
drh5e0ccc22010-03-29 19:36:52 +00004310 assert( pBt->inTransaction==TRANS_WRITE );
4311 /* At the pager level, a statement transaction is a savepoint with
4312 ** an index greater than all savepoints created explicitly using
4313 ** SQL statements. It is illegal to open, release or rollback any
4314 ** such savepoints while the statement transaction savepoint is active.
4315 */
4316 rc = sqlite3PagerOpenSavepoint(pBt->pPager, iStatement);
drhd677b3d2007-08-20 22:48:41 +00004317 sqlite3BtreeLeave(p);
drh663fc632002-02-02 18:49:19 +00004318 return rc;
4319}
4320
4321/*
danielk1977fd7f0452008-12-17 17:30:26 +00004322** The second argument to this function, op, is always SAVEPOINT_ROLLBACK
4323** or SAVEPOINT_RELEASE. This function either releases or rolls back the
danielk197712dd5492008-12-18 15:45:07 +00004324** savepoint identified by parameter iSavepoint, depending on the value
4325** of op.
4326**
4327** Normally, iSavepoint is greater than or equal to zero. However, if op is
4328** SAVEPOINT_ROLLBACK, then iSavepoint may also be -1. In this case the
4329** contents of the entire transaction are rolled back. This is different
4330** from a normal transaction rollback, as no locks are released and the
4331** transaction remains open.
danielk1977fd7f0452008-12-17 17:30:26 +00004332*/
4333int sqlite3BtreeSavepoint(Btree *p, int op, int iSavepoint){
4334 int rc = SQLITE_OK;
4335 if( p && p->inTrans==TRANS_WRITE ){
4336 BtShared *pBt = p->pBt;
danielk1977fd7f0452008-12-17 17:30:26 +00004337 assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
4338 assert( iSavepoint>=0 || (iSavepoint==-1 && op==SAVEPOINT_ROLLBACK) );
4339 sqlite3BtreeEnter(p);
drh2343c7e2017-02-02 00:46:55 +00004340 if( op==SAVEPOINT_ROLLBACK ){
4341 rc = saveAllCursors(pBt, 0, 0);
4342 }
4343 if( rc==SQLITE_OK ){
4344 rc = sqlite3PagerSavepoint(pBt->pPager, op, iSavepoint);
4345 }
drh9f0bbf92009-01-02 21:08:09 +00004346 if( rc==SQLITE_OK ){
drhc9166342012-01-05 23:32:06 +00004347 if( iSavepoint<0 && (pBt->btsFlags & BTS_INITIALLY_EMPTY)!=0 ){
4348 pBt->nPage = 0;
4349 }
drh9f0bbf92009-01-02 21:08:09 +00004350 rc = newDatabase(pBt);
drh41422652019-05-10 14:34:18 +00004351 btreeSetNPage(pBt, pBt->pPage1);
drhb9b49bf2010-08-05 03:21:39 +00004352
dana9a54652019-04-22 11:47:40 +00004353 /* pBt->nPage might be zero if the database was corrupt when
4354 ** the transaction was started. Otherwise, it must be at least 1. */
4355 assert( CORRUPT_DB || pBt->nPage>0 );
drh9f0bbf92009-01-02 21:08:09 +00004356 }
danielk1977fd7f0452008-12-17 17:30:26 +00004357 sqlite3BtreeLeave(p);
4358 }
4359 return rc;
4360}
4361
4362/*
drh8b2f49b2001-06-08 00:21:52 +00004363** Create a new cursor for the BTree whose root is on the page
danielk19773e8add92009-07-04 17:16:00 +00004364** iTable. If a read-only cursor is requested, it is assumed that
4365** the caller already has at least a read-only transaction open
4366** on the database already. If a write-cursor is requested, then
4367** the caller is assumed to have an open write transaction.
drh1bee3d72001-10-15 00:44:35 +00004368**
drhe807bdb2016-01-21 17:06:33 +00004369** If the BTREE_WRCSR bit of wrFlag is clear, then the cursor can only
4370** be used for reading. If the BTREE_WRCSR bit is set, then the cursor
4371** can be used for reading or for writing if other conditions for writing
4372** are also met. These are the conditions that must be met in order
4373** for writing to be allowed:
drh6446c4d2001-12-15 14:22:18 +00004374**
drhe807bdb2016-01-21 17:06:33 +00004375** 1: The cursor must have been opened with wrFlag containing BTREE_WRCSR
drhf74b8d92002-09-01 23:20:45 +00004376**
drhfe5d71d2007-03-19 11:54:10 +00004377** 2: Other database connections that share the same pager cache
4378** but which are not in the READ_UNCOMMITTED state may not have
4379** cursors open with wrFlag==0 on the same table. Otherwise
4380** the changes made by this write cursor would be visible to
4381** the read cursors in the other database connection.
drhf74b8d92002-09-01 23:20:45 +00004382**
4383** 3: The database must be writable (not on read-only media)
4384**
4385** 4: There must be an active transaction.
4386**
drhe807bdb2016-01-21 17:06:33 +00004387** The BTREE_FORDELETE bit of wrFlag may optionally be set if BTREE_WRCSR
4388** is set. If FORDELETE is set, that is a hint to the implementation that
4389** this cursor will only be used to seek to and delete entries of an index
4390** as part of a larger DELETE statement. The FORDELETE hint is not used by
4391** this implementation. But in a hypothetical alternative storage engine
4392** in which index entries are automatically deleted when corresponding table
4393** rows are deleted, the FORDELETE flag is a hint that all SEEK and DELETE
4394** operations on this cursor can be no-ops and all READ operations can
4395** return a null row (2-bytes: 0x01 0x00).
4396**
drh6446c4d2001-12-15 14:22:18 +00004397** No checking is done to make sure that page iTable really is the
4398** root page of a b-tree. If it is not, then the cursor acquired
4399** will not work correctly.
danielk197771d5d2c2008-09-29 11:49:47 +00004400**
drhf25a5072009-11-18 23:01:25 +00004401** It is assumed that the sqlite3BtreeCursorZero() has been called
4402** on pCur to initialize the memory space prior to invoking this routine.
drha059ad02001-04-17 20:09:11 +00004403*/
drhd677b3d2007-08-20 22:48:41 +00004404static int btreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00004405 Btree *p, /* The btree */
drhabc38152020-07-22 13:38:04 +00004406 Pgno iTable, /* Root page of table to open */
danielk1977cd3e8f72008-03-25 09:47:35 +00004407 int wrFlag, /* 1 to write. 0 read-only */
4408 struct KeyInfo *pKeyInfo, /* First arg to comparison function */
4409 BtCursor *pCur /* Space for new cursor */
drh3aac2dd2004-04-26 14:10:20 +00004410){
danielk19773e8add92009-07-04 17:16:00 +00004411 BtShared *pBt = p->pBt; /* Shared b-tree handle */
drh27fb7462015-06-30 02:47:36 +00004412 BtCursor *pX; /* Looping over other all cursors */
drhecdc7532001-09-23 02:35:53 +00004413
drh1fee73e2007-08-29 04:00:57 +00004414 assert( sqlite3BtreeHoldsMutex(p) );
danfd261ec2015-10-22 20:54:33 +00004415 assert( wrFlag==0
4416 || wrFlag==BTREE_WRCSR
4417 || wrFlag==(BTREE_WRCSR|BTREE_FORDELETE)
4418 );
danielk197796d48e92009-06-29 06:00:37 +00004419
danielk1977602b4662009-07-02 07:47:33 +00004420 /* The following assert statements verify that if this is a sharable
4421 ** b-tree database, the connection is holding the required table locks,
4422 ** and that no other connection has any open cursor that conflicts with
drhac801802019-11-17 11:47:50 +00004423 ** this lock. The iTable<1 term disables the check for corrupt schemas. */
4424 assert( hasSharedCacheTableLock(p, iTable, pKeyInfo!=0, (wrFlag?2:1))
4425 || iTable<1 );
danielk197796d48e92009-06-29 06:00:37 +00004426 assert( wrFlag==0 || !hasReadConflicts(p, iTable) );
4427
danielk19773e8add92009-07-04 17:16:00 +00004428 /* Assert that the caller has opened the required transaction. */
4429 assert( p->inTrans>TRANS_NONE );
4430 assert( wrFlag==0 || p->inTrans==TRANS_WRITE );
4431 assert( pBt->pPage1 && pBt->pPage1->aData );
drh98ef0f62015-06-30 01:25:52 +00004432 assert( wrFlag==0 || (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk19773e8add92009-07-04 17:16:00 +00004433
drh3fbb0222014-09-24 19:47:27 +00004434 if( wrFlag ){
4435 allocateTempSpace(pBt);
mistachkinfad30392016-02-13 23:43:46 +00004436 if( pBt->pTmpSpace==0 ) return SQLITE_NOMEM_BKPT;
drha0c9a112004-03-10 13:42:37 +00004437 }
drhdb561bc2019-10-25 14:46:05 +00004438 if( iTable<=1 ){
4439 if( iTable<1 ){
4440 return SQLITE_CORRUPT_BKPT;
4441 }else if( btreePagecount(pBt)==0 ){
4442 assert( wrFlag==0 );
4443 iTable = 0;
4444 }
danielk19773e8add92009-07-04 17:16:00 +00004445 }
danielk1977aef0bf62005-12-30 16:28:01 +00004446
danielk1977aef0bf62005-12-30 16:28:01 +00004447 /* Now that no other errors can occur, finish filling in the BtCursor
danielk19773e8add92009-07-04 17:16:00 +00004448 ** variables and link the cursor into the BtShared list. */
drhabc38152020-07-22 13:38:04 +00004449 pCur->pgnoRoot = iTable;
danielk1977172114a2009-07-07 15:47:12 +00004450 pCur->iPage = -1;
drh1e968a02008-03-25 00:22:21 +00004451 pCur->pKeyInfo = pKeyInfo;
danielk1977aef0bf62005-12-30 16:28:01 +00004452 pCur->pBtree = p;
drhd0679ed2007-08-28 22:24:34 +00004453 pCur->pBt = pBt;
danfd261ec2015-10-22 20:54:33 +00004454 pCur->curFlags = wrFlag ? BTCF_WriteFlag : 0;
drh28f58dd2015-06-27 19:45:03 +00004455 pCur->curPagerFlags = wrFlag ? 0 : PAGER_GET_READONLY;
drh27fb7462015-06-30 02:47:36 +00004456 /* If there are two or more cursors on the same btree, then all such
4457 ** cursors *must* have the BTCF_Multiple flag set. */
4458 for(pX=pBt->pCursor; pX; pX=pX->pNext){
drhabc38152020-07-22 13:38:04 +00004459 if( pX->pgnoRoot==iTable ){
drh27fb7462015-06-30 02:47:36 +00004460 pX->curFlags |= BTCF_Multiple;
4461 pCur->curFlags |= BTCF_Multiple;
4462 }
drha059ad02001-04-17 20:09:11 +00004463 }
drh27fb7462015-06-30 02:47:36 +00004464 pCur->pNext = pBt->pCursor;
drha059ad02001-04-17 20:09:11 +00004465 pBt->pCursor = pCur;
danielk1977da184232006-01-05 11:34:32 +00004466 pCur->eState = CURSOR_INVALID;
danielk1977aef0bf62005-12-30 16:28:01 +00004467 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00004468}
drhdb561bc2019-10-25 14:46:05 +00004469static int btreeCursorWithLock(
4470 Btree *p, /* The btree */
drhabc38152020-07-22 13:38:04 +00004471 Pgno iTable, /* Root page of table to open */
drhdb561bc2019-10-25 14:46:05 +00004472 int wrFlag, /* 1 to write. 0 read-only */
4473 struct KeyInfo *pKeyInfo, /* First arg to comparison function */
4474 BtCursor *pCur /* Space for new cursor */
4475){
4476 int rc;
4477 sqlite3BtreeEnter(p);
4478 rc = btreeCursor(p, iTable, wrFlag, pKeyInfo, pCur);
4479 sqlite3BtreeLeave(p);
4480 return rc;
4481}
drhd677b3d2007-08-20 22:48:41 +00004482int sqlite3BtreeCursor(
danielk1977cd3e8f72008-03-25 09:47:35 +00004483 Btree *p, /* The btree */
drhabc38152020-07-22 13:38:04 +00004484 Pgno iTable, /* Root page of table to open */
danielk1977cd3e8f72008-03-25 09:47:35 +00004485 int wrFlag, /* 1 to write. 0 read-only */
4486 struct KeyInfo *pKeyInfo, /* First arg to xCompare() */
4487 BtCursor *pCur /* Write new cursor here */
drhd677b3d2007-08-20 22:48:41 +00004488){
drhdb561bc2019-10-25 14:46:05 +00004489 if( p->sharable ){
4490 return btreeCursorWithLock(p, iTable, wrFlag, pKeyInfo, pCur);
dan08f901b2015-05-25 19:24:36 +00004491 }else{
drhdb561bc2019-10-25 14:46:05 +00004492 return btreeCursor(p, iTable, wrFlag, pKeyInfo, pCur);
dan08f901b2015-05-25 19:24:36 +00004493 }
drhd677b3d2007-08-20 22:48:41 +00004494}
drh7f751222009-03-17 22:33:00 +00004495
4496/*
4497** Return the size of a BtCursor object in bytes.
4498**
4499** This interfaces is needed so that users of cursors can preallocate
4500** sufficient storage to hold a cursor. The BtCursor object is opaque
4501** to users so they cannot do the sizeof() themselves - they must call
4502** this routine.
4503*/
4504int sqlite3BtreeCursorSize(void){
drhc54055b2009-11-13 17:05:53 +00004505 return ROUND8(sizeof(BtCursor));
danielk1977cd3e8f72008-03-25 09:47:35 +00004506}
4507
drh7f751222009-03-17 22:33:00 +00004508/*
drhf25a5072009-11-18 23:01:25 +00004509** Initialize memory that will be converted into a BtCursor object.
4510**
4511** The simple approach here would be to memset() the entire object
4512** to zero. But it turns out that the apPage[] and aiIdx[] arrays
4513** do not need to be zeroed and they are large, so we can save a lot
4514** of run-time by skipping the initialization of those elements.
4515*/
4516void sqlite3BtreeCursorZero(BtCursor *p){
drhda6bc672018-01-24 16:04:21 +00004517 memset(p, 0, offsetof(BtCursor, BTCURSOR_FIRST_UNINIT));
drhf25a5072009-11-18 23:01:25 +00004518}
4519
4520/*
drh5e00f6c2001-09-13 13:46:56 +00004521** Close a cursor. The read lock on the database file is released
drhbd03cae2001-06-02 02:40:57 +00004522** when the last cursor is closed.
drha059ad02001-04-17 20:09:11 +00004523*/
drh3aac2dd2004-04-26 14:10:20 +00004524int sqlite3BtreeCloseCursor(BtCursor *pCur){
drhff0587c2007-08-29 17:43:19 +00004525 Btree *pBtree = pCur->pBtree;
danielk1977cd3e8f72008-03-25 09:47:35 +00004526 if( pBtree ){
4527 BtShared *pBt = pCur->pBt;
4528 sqlite3BtreeEnter(pBtree);
drh27fb7462015-06-30 02:47:36 +00004529 assert( pBt->pCursor!=0 );
4530 if( pBt->pCursor==pCur ){
danielk1977cd3e8f72008-03-25 09:47:35 +00004531 pBt->pCursor = pCur->pNext;
drh27fb7462015-06-30 02:47:36 +00004532 }else{
4533 BtCursor *pPrev = pBt->pCursor;
4534 do{
4535 if( pPrev->pNext==pCur ){
4536 pPrev->pNext = pCur->pNext;
4537 break;
4538 }
4539 pPrev = pPrev->pNext;
4540 }while( ALWAYS(pPrev) );
danielk1977cd3e8f72008-03-25 09:47:35 +00004541 }
drh352a35a2017-08-15 03:46:47 +00004542 btreeReleaseAllCursorPages(pCur);
danielk1977cd3e8f72008-03-25 09:47:35 +00004543 unlockBtreeIfUnused(pBt);
dan85753662014-12-11 16:38:18 +00004544 sqlite3_free(pCur->aOverflow);
drhf38dd3b2017-08-14 23:53:02 +00004545 sqlite3_free(pCur->pKey);
daneeee8a52021-03-18 14:31:37 +00004546 if( (pBt->openFlags & BTREE_SINGLE) && pBt->pCursor==0 ){
4547 /* Since the BtShared is not sharable, there is no need to
4548 ** worry about the missing sqlite3BtreeLeave() call here. */
4549 assert( pBtree->sharable==0 );
4550 sqlite3BtreeClose(pBtree);
4551 }else{
4552 sqlite3BtreeLeave(pBtree);
4553 }
dan97c8cb32019-01-01 18:00:17 +00004554 pCur->pBtree = 0;
drha059ad02001-04-17 20:09:11 +00004555 }
drh8c42ca92001-06-22 19:15:00 +00004556 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00004557}
4558
drh5e2f8b92001-05-28 00:41:15 +00004559/*
drh86057612007-06-26 01:04:48 +00004560** Make sure the BtCursor* given in the argument has a valid
4561** BtCursor.info structure. If it is not already valid, call
danielk197730548662009-07-09 05:07:37 +00004562** btreeParseCell() to fill it in.
drhab01f612004-05-22 02:55:23 +00004563**
4564** BtCursor.info is a cache of the information in the current cell.
danielk197730548662009-07-09 05:07:37 +00004565** Using this cache reduces the number of calls to btreeParseCell().
drh9188b382004-05-14 21:12:22 +00004566*/
drh9188b382004-05-14 21:12:22 +00004567#ifndef NDEBUG
drha224ee22018-02-19 13:53:56 +00004568 static int cellInfoEqual(CellInfo *a, CellInfo *b){
4569 if( a->nKey!=b->nKey ) return 0;
4570 if( a->pPayload!=b->pPayload ) return 0;
4571 if( a->nPayload!=b->nPayload ) return 0;
4572 if( a->nLocal!=b->nLocal ) return 0;
4573 if( a->nSize!=b->nSize ) return 0;
4574 return 1;
4575 }
danielk19771cc5ed82007-05-16 17:28:43 +00004576 static void assertCellInfo(BtCursor *pCur){
drh9188b382004-05-14 21:12:22 +00004577 CellInfo info;
drh51c6d962004-06-06 00:42:25 +00004578 memset(&info, 0, sizeof(info));
drh352a35a2017-08-15 03:46:47 +00004579 btreeParseCell(pCur->pPage, pCur->ix, &info);
drha224ee22018-02-19 13:53:56 +00004580 assert( CORRUPT_DB || cellInfoEqual(&info, &pCur->info) );
drh9188b382004-05-14 21:12:22 +00004581 }
danielk19771cc5ed82007-05-16 17:28:43 +00004582#else
4583 #define assertCellInfo(x)
4584#endif
drhc5b41ac2015-06-17 02:11:46 +00004585static SQLITE_NOINLINE void getCellInfo(BtCursor *pCur){
4586 if( pCur->info.nSize==0 ){
drhc5b41ac2015-06-17 02:11:46 +00004587 pCur->curFlags |= BTCF_ValidNKey;
drh352a35a2017-08-15 03:46:47 +00004588 btreeParseCell(pCur->pPage,pCur->ix,&pCur->info);
drhc5b41ac2015-06-17 02:11:46 +00004589 }else{
4590 assertCellInfo(pCur);
drh86057612007-06-26 01:04:48 +00004591 }
drhc5b41ac2015-06-17 02:11:46 +00004592}
drh9188b382004-05-14 21:12:22 +00004593
drhea8ffdf2009-07-22 00:35:23 +00004594#ifndef NDEBUG /* The next routine used only within assert() statements */
4595/*
4596** Return true if the given BtCursor is valid. A valid cursor is one
4597** that is currently pointing to a row in a (non-empty) table.
4598** This is a verification routine is used only within assert() statements.
4599*/
4600int sqlite3BtreeCursorIsValid(BtCursor *pCur){
4601 return pCur && pCur->eState==CURSOR_VALID;
4602}
4603#endif /* NDEBUG */
drhd6ef5af2016-11-15 04:00:24 +00004604int sqlite3BtreeCursorIsValidNN(BtCursor *pCur){
4605 assert( pCur!=0 );
4606 return pCur->eState==CURSOR_VALID;
4607}
drhea8ffdf2009-07-22 00:35:23 +00004608
drh9188b382004-05-14 21:12:22 +00004609/*
drha7c90c42016-06-04 20:37:10 +00004610** Return the value of the integer key or "rowid" for a table btree.
4611** This routine is only valid for a cursor that is pointing into a
4612** ordinary table btree. If the cursor points to an index btree or
4613** is invalid, the result of this routine is undefined.
drh7e3b0a02001-04-28 16:52:40 +00004614*/
drha7c90c42016-06-04 20:37:10 +00004615i64 sqlite3BtreeIntegerKey(BtCursor *pCur){
drh1fee73e2007-08-29 04:00:57 +00004616 assert( cursorHoldsMutex(pCur) );
drhc5352b92014-11-17 20:33:07 +00004617 assert( pCur->eState==CURSOR_VALID );
drha7c90c42016-06-04 20:37:10 +00004618 assert( pCur->curIntKey );
drhc5352b92014-11-17 20:33:07 +00004619 getCellInfo(pCur);
drha7c90c42016-06-04 20:37:10 +00004620 return pCur->info.nKey;
drha059ad02001-04-17 20:09:11 +00004621}
drh2af926b2001-05-15 00:39:25 +00004622
drh7b14b652019-12-29 22:08:20 +00004623/*
4624** Pin or unpin a cursor.
4625*/
4626void sqlite3BtreeCursorPin(BtCursor *pCur){
4627 assert( (pCur->curFlags & BTCF_Pinned)==0 );
4628 pCur->curFlags |= BTCF_Pinned;
4629}
4630void sqlite3BtreeCursorUnpin(BtCursor *pCur){
4631 assert( (pCur->curFlags & BTCF_Pinned)!=0 );
4632 pCur->curFlags &= ~BTCF_Pinned;
4633}
4634
drh092457b2017-12-29 15:04:49 +00004635#ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
drh72f82862001-05-24 21:06:34 +00004636/*
drh2fc865c2017-12-16 20:20:37 +00004637** Return the offset into the database file for the start of the
4638** payload to which the cursor is pointing.
4639*/
drh092457b2017-12-29 15:04:49 +00004640i64 sqlite3BtreeOffset(BtCursor *pCur){
drh2fc865c2017-12-16 20:20:37 +00004641 assert( cursorHoldsMutex(pCur) );
4642 assert( pCur->eState==CURSOR_VALID );
drh2fc865c2017-12-16 20:20:37 +00004643 getCellInfo(pCur);
drhfe6d20e2017-12-29 14:33:54 +00004644 return (i64)pCur->pBt->pageSize*((i64)pCur->pPage->pgno - 1) +
drh2fc865c2017-12-16 20:20:37 +00004645 (i64)(pCur->info.pPayload - pCur->pPage->aData);
4646}
drh092457b2017-12-29 15:04:49 +00004647#endif /* SQLITE_ENABLE_OFFSET_SQL_FUNC */
drh2fc865c2017-12-16 20:20:37 +00004648
4649/*
drha7c90c42016-06-04 20:37:10 +00004650** Return the number of bytes of payload for the entry that pCur is
4651** currently pointing to. For table btrees, this will be the amount
4652** of data. For index btrees, this will be the size of the key.
drhea8ffdf2009-07-22 00:35:23 +00004653**
4654** The caller must guarantee that the cursor is pointing to a non-NULL
4655** valid entry. In other words, the calling procedure must guarantee
4656** that the cursor has Cursor.eState==CURSOR_VALID.
drh0e1c19e2004-05-11 00:58:56 +00004657*/
drha7c90c42016-06-04 20:37:10 +00004658u32 sqlite3BtreePayloadSize(BtCursor *pCur){
4659 assert( cursorHoldsMutex(pCur) );
drhea8ffdf2009-07-22 00:35:23 +00004660 assert( pCur->eState==CURSOR_VALID );
4661 getCellInfo(pCur);
drha7c90c42016-06-04 20:37:10 +00004662 return pCur->info.nPayload;
drh0e1c19e2004-05-11 00:58:56 +00004663}
4664
4665/*
drh53d30dd2019-02-04 21:10:24 +00004666** Return an upper bound on the size of any record for the table
4667** that the cursor is pointing into.
4668**
4669** This is an optimization. Everything will still work if this
4670** routine always returns 2147483647 (which is the largest record
4671** that SQLite can handle) or more. But returning a smaller value might
4672** prevent large memory allocations when trying to interpret a
4673** corrupt datrabase.
4674**
4675** The current implementation merely returns the size of the underlying
4676** database file.
4677*/
4678sqlite3_int64 sqlite3BtreeMaxRecordSize(BtCursor *pCur){
4679 assert( cursorHoldsMutex(pCur) );
4680 assert( pCur->eState==CURSOR_VALID );
4681 return pCur->pBt->pageSize * (sqlite3_int64)pCur->pBt->nPage;
4682}
4683
4684/*
danielk1977d04417962007-05-02 13:16:30 +00004685** Given the page number of an overflow page in the database (parameter
4686** ovfl), this function finds the page number of the next page in the
4687** linked list of overflow pages. If possible, it uses the auto-vacuum
4688** pointer-map data instead of reading the content of page ovfl to do so.
4689**
4690** If an error occurs an SQLite error code is returned. Otherwise:
4691**
danielk1977bea2a942009-01-20 17:06:27 +00004692** The page number of the next overflow page in the linked list is
4693** written to *pPgnoNext. If page ovfl is the last page in its linked
4694** list, *pPgnoNext is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00004695**
danielk1977bea2a942009-01-20 17:06:27 +00004696** If ppPage is not NULL, and a reference to the MemPage object corresponding
4697** to page number pOvfl was obtained, then *ppPage is set to point to that
4698** reference. It is the responsibility of the caller to call releasePage()
4699** on *ppPage to free the reference. In no reference was obtained (because
4700** the pointer-map was used to obtain the value for *pPgnoNext), then
4701** *ppPage is set to zero.
danielk1977d04417962007-05-02 13:16:30 +00004702*/
4703static int getOverflowPage(
drhfa3be902009-07-07 02:44:07 +00004704 BtShared *pBt, /* The database file */
4705 Pgno ovfl, /* Current overflow page number */
danielk1977bea2a942009-01-20 17:06:27 +00004706 MemPage **ppPage, /* OUT: MemPage handle (may be NULL) */
danielk1977d04417962007-05-02 13:16:30 +00004707 Pgno *pPgnoNext /* OUT: Next overflow page number */
4708){
4709 Pgno next = 0;
danielk1977bea2a942009-01-20 17:06:27 +00004710 MemPage *pPage = 0;
drh1bd10f82008-12-10 21:19:56 +00004711 int rc = SQLITE_OK;
danielk1977d04417962007-05-02 13:16:30 +00004712
drh1fee73e2007-08-29 04:00:57 +00004713 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977bea2a942009-01-20 17:06:27 +00004714 assert(pPgnoNext);
danielk1977d04417962007-05-02 13:16:30 +00004715
4716#ifndef SQLITE_OMIT_AUTOVACUUM
4717 /* Try to find the next page in the overflow list using the
4718 ** autovacuum pointer-map pages. Guess that the next page in
4719 ** the overflow list is page number (ovfl+1). If that guess turns
4720 ** out to be wrong, fall back to loading the data of page
4721 ** number ovfl to determine the next page number.
4722 */
4723 if( pBt->autoVacuum ){
4724 Pgno pgno;
4725 Pgno iGuess = ovfl+1;
4726 u8 eType;
4727
4728 while( PTRMAP_ISPAGE(pBt, iGuess) || iGuess==PENDING_BYTE_PAGE(pBt) ){
4729 iGuess++;
4730 }
4731
drhb1299152010-03-30 22:58:33 +00004732 if( iGuess<=btreePagecount(pBt) ){
danielk1977d04417962007-05-02 13:16:30 +00004733 rc = ptrmapGet(pBt, iGuess, &eType, &pgno);
danielk1977bea2a942009-01-20 17:06:27 +00004734 if( rc==SQLITE_OK && eType==PTRMAP_OVERFLOW2 && pgno==ovfl ){
danielk1977d04417962007-05-02 13:16:30 +00004735 next = iGuess;
danielk1977bea2a942009-01-20 17:06:27 +00004736 rc = SQLITE_DONE;
danielk1977d04417962007-05-02 13:16:30 +00004737 }
4738 }
4739 }
4740#endif
4741
danielk1977d8a3f3d2009-07-11 11:45:23 +00004742 assert( next==0 || rc==SQLITE_DONE );
danielk1977bea2a942009-01-20 17:06:27 +00004743 if( rc==SQLITE_OK ){
drhb00fc3b2013-08-21 23:42:32 +00004744 rc = btreeGetPage(pBt, ovfl, &pPage, (ppPage==0) ? PAGER_GET_READONLY : 0);
danielk1977d8a3f3d2009-07-11 11:45:23 +00004745 assert( rc==SQLITE_OK || pPage==0 );
4746 if( rc==SQLITE_OK ){
danielk1977d04417962007-05-02 13:16:30 +00004747 next = get4byte(pPage->aData);
4748 }
danielk1977443c0592009-01-16 15:21:05 +00004749 }
danielk197745d68822009-01-16 16:23:38 +00004750
danielk1977bea2a942009-01-20 17:06:27 +00004751 *pPgnoNext = next;
4752 if( ppPage ){
4753 *ppPage = pPage;
4754 }else{
4755 releasePage(pPage);
4756 }
4757 return (rc==SQLITE_DONE ? SQLITE_OK : rc);
danielk1977d04417962007-05-02 13:16:30 +00004758}
4759
danielk1977da107192007-05-04 08:32:13 +00004760/*
4761** Copy data from a buffer to a page, or from a page to a buffer.
4762**
4763** pPayload is a pointer to data stored on database page pDbPage.
4764** If argument eOp is false, then nByte bytes of data are copied
4765** from pPayload to the buffer pointed at by pBuf. If eOp is true,
4766** then sqlite3PagerWrite() is called on pDbPage and nByte bytes
4767** of data are copied from the buffer pBuf to pPayload.
4768**
4769** SQLITE_OK is returned on success, otherwise an error code.
4770*/
4771static int copyPayload(
4772 void *pPayload, /* Pointer to page data */
4773 void *pBuf, /* Pointer to buffer */
4774 int nByte, /* Number of bytes to copy */
4775 int eOp, /* 0 -> copy from page, 1 -> copy to page */
4776 DbPage *pDbPage /* Page containing pPayload */
4777){
4778 if( eOp ){
4779 /* Copy data from buffer to page (a write operation) */
4780 int rc = sqlite3PagerWrite(pDbPage);
4781 if( rc!=SQLITE_OK ){
4782 return rc;
4783 }
4784 memcpy(pPayload, pBuf, nByte);
4785 }else{
4786 /* Copy data from page to buffer (a read operation) */
4787 memcpy(pBuf, pPayload, nByte);
4788 }
4789 return SQLITE_OK;
4790}
danielk1977d04417962007-05-02 13:16:30 +00004791
4792/*
danielk19779f8d6402007-05-02 17:48:45 +00004793** This function is used to read or overwrite payload information
dan5a500af2014-03-11 20:33:04 +00004794** for the entry that the pCur cursor is pointing to. The eOp
4795** argument is interpreted as follows:
4796**
4797** 0: The operation is a read. Populate the overflow cache.
4798** 1: The operation is a write. Populate the overflow cache.
danielk19779f8d6402007-05-02 17:48:45 +00004799**
4800** A total of "amt" bytes are read or written beginning at "offset".
4801** Data is read to or from the buffer pBuf.
drh72f82862001-05-24 21:06:34 +00004802**
drh3bcdfd22009-07-12 02:32:21 +00004803** The content being read or written might appear on the main page
4804** or be scattered out on multiple overflow pages.
danielk1977da107192007-05-04 08:32:13 +00004805**
drh42e28f12017-01-27 00:31:59 +00004806** If the current cursor entry uses one or more overflow pages
4807** this function may allocate space for and lazily populate
4808** the overflow page-list cache array (BtCursor.aOverflow).
dan5a500af2014-03-11 20:33:04 +00004809** Subsequent calls use this cache to make seeking to the supplied offset
4810** more efficient.
danielk1977da107192007-05-04 08:32:13 +00004811**
drh42e28f12017-01-27 00:31:59 +00004812** Once an overflow page-list cache has been allocated, it must be
danielk1977da107192007-05-04 08:32:13 +00004813** invalidated if some other cursor writes to the same table, or if
4814** the cursor is moved to a different row. Additionally, in auto-vacuum
4815** mode, the following events may invalidate an overflow page-list cache.
4816**
4817** * An incremental vacuum,
4818** * A commit in auto_vacuum="full" mode,
4819** * Creating a table (may require moving an overflow page).
drh72f82862001-05-24 21:06:34 +00004820*/
danielk19779f8d6402007-05-02 17:48:45 +00004821static int accessPayload(
drh3aac2dd2004-04-26 14:10:20 +00004822 BtCursor *pCur, /* Cursor pointing to entry to read from */
danielk197789d40042008-11-17 14:20:56 +00004823 u32 offset, /* Begin reading this far into payload */
4824 u32 amt, /* Read this many bytes */
drh3aac2dd2004-04-26 14:10:20 +00004825 unsigned char *pBuf, /* Write the bytes into this buffer */
danielk19779f8d6402007-05-02 17:48:45 +00004826 int eOp /* zero to read. non-zero to write. */
drh3aac2dd2004-04-26 14:10:20 +00004827){
4828 unsigned char *aPayload;
danielk1977da107192007-05-04 08:32:13 +00004829 int rc = SQLITE_OK;
danielk19772dec9702007-05-02 16:48:37 +00004830 int iIdx = 0;
drh352a35a2017-08-15 03:46:47 +00004831 MemPage *pPage = pCur->pPage; /* Btree page of current entry */
danielk19770d065412008-11-12 18:21:36 +00004832 BtShared *pBt = pCur->pBt; /* Btree this cursor belongs to */
drh4c417182014-03-31 23:57:41 +00004833#ifdef SQLITE_DIRECT_OVERFLOW_READ
drh8bb9fd32017-01-26 16:27:32 +00004834 unsigned char * const pBufStart = pBuf; /* Start of original out buffer */
drh4c417182014-03-31 23:57:41 +00004835#endif
drh3aac2dd2004-04-26 14:10:20 +00004836
danielk1977da107192007-05-04 08:32:13 +00004837 assert( pPage );
drh42e28f12017-01-27 00:31:59 +00004838 assert( eOp==0 || eOp==1 );
danielk1977da184232006-01-05 11:34:32 +00004839 assert( pCur->eState==CURSOR_VALID );
drh75e96b32017-04-01 00:20:06 +00004840 assert( pCur->ix<pPage->nCell );
drh1fee73e2007-08-29 04:00:57 +00004841 assert( cursorHoldsMutex(pCur) );
danielk1977da107192007-05-04 08:32:13 +00004842
drh86057612007-06-26 01:04:48 +00004843 getCellInfo(pCur);
drhab1cc582014-09-23 21:25:19 +00004844 aPayload = pCur->info.pPayload;
drhab1cc582014-09-23 21:25:19 +00004845 assert( offset+amt <= pCur->info.nPayload );
danielk1977da107192007-05-04 08:32:13 +00004846
drh0b982072016-03-22 14:10:45 +00004847 assert( aPayload > pPage->aData );
drhc5e7f942016-03-22 15:25:16 +00004848 if( (uptr)(aPayload - pPage->aData) > (pBt->usableSize - pCur->info.nLocal) ){
drh0b982072016-03-22 14:10:45 +00004849 /* Trying to read or write past the end of the data is an error. The
4850 ** conditional above is really:
4851 ** &aPayload[pCur->info.nLocal] > &pPage->aData[pBt->usableSize]
4852 ** but is recast into its current form to avoid integer overflow problems
4853 */
daneebf2f52017-11-18 17:30:08 +00004854 return SQLITE_CORRUPT_PAGE(pPage);
drh3aac2dd2004-04-26 14:10:20 +00004855 }
danielk1977da107192007-05-04 08:32:13 +00004856
4857 /* Check if data must be read/written to/from the btree page itself. */
drhfa1a98a2004-05-14 19:08:17 +00004858 if( offset<pCur->info.nLocal ){
drh2af926b2001-05-15 00:39:25 +00004859 int a = amt;
drhfa1a98a2004-05-14 19:08:17 +00004860 if( a+offset>pCur->info.nLocal ){
4861 a = pCur->info.nLocal - offset;
drh2af926b2001-05-15 00:39:25 +00004862 }
drh42e28f12017-01-27 00:31:59 +00004863 rc = copyPayload(&aPayload[offset], pBuf, a, eOp, pPage->pDbPage);
drh2aa679f2001-06-25 02:11:07 +00004864 offset = 0;
drha34b6762004-05-07 13:30:42 +00004865 pBuf += a;
drh2af926b2001-05-15 00:39:25 +00004866 amt -= a;
drhdd793422001-06-28 01:54:48 +00004867 }else{
drhfa1a98a2004-05-14 19:08:17 +00004868 offset -= pCur->info.nLocal;
drhbd03cae2001-06-02 02:40:57 +00004869 }
danielk1977da107192007-05-04 08:32:13 +00004870
dan85753662014-12-11 16:38:18 +00004871
danielk1977da107192007-05-04 08:32:13 +00004872 if( rc==SQLITE_OK && amt>0 ){
danielk197789d40042008-11-17 14:20:56 +00004873 const u32 ovflSize = pBt->usableSize - 4; /* Bytes content per ovfl page */
danielk1977da107192007-05-04 08:32:13 +00004874 Pgno nextPage;
4875
drhfa1a98a2004-05-14 19:08:17 +00004876 nextPage = get4byte(&aPayload[pCur->info.nLocal]);
drh584e8b72020-07-22 17:12:59 +00004877
drha38c9512014-04-01 01:24:34 +00004878 /* If the BtCursor.aOverflow[] has not been allocated, allocate it now.
drha38c9512014-04-01 01:24:34 +00004879 **
4880 ** The aOverflow[] array is sized at one entry for each overflow page
4881 ** in the overflow chain. The page number of the first overflow page is
4882 ** stored in aOverflow[0], etc. A value of 0 in the aOverflow[] array
4883 ** means "not yet known" (the cache is lazily populated).
danielk1977da107192007-05-04 08:32:13 +00004884 */
drh42e28f12017-01-27 00:31:59 +00004885 if( (pCur->curFlags & BTCF_ValidOvfl)==0 ){
danielk19772dec9702007-05-02 16:48:37 +00004886 int nOvfl = (pCur->info.nPayload-pCur->info.nLocal+ovflSize-1)/ovflSize;
drhda6bc672018-01-24 16:04:21 +00004887 if( pCur->aOverflow==0
mistachkin97f90592018-02-04 01:30:54 +00004888 || nOvfl*(int)sizeof(Pgno) > sqlite3MallocSize(pCur->aOverflow)
drhda6bc672018-01-24 16:04:21 +00004889 ){
dan85753662014-12-11 16:38:18 +00004890 Pgno *aNew = (Pgno*)sqlite3Realloc(
4891 pCur->aOverflow, nOvfl*2*sizeof(Pgno)
dan5a500af2014-03-11 20:33:04 +00004892 );
4893 if( aNew==0 ){
drhcd645532017-01-20 20:43:14 +00004894 return SQLITE_NOMEM_BKPT;
dan5a500af2014-03-11 20:33:04 +00004895 }else{
dan5a500af2014-03-11 20:33:04 +00004896 pCur->aOverflow = aNew;
4897 }
4898 }
drhcd645532017-01-20 20:43:14 +00004899 memset(pCur->aOverflow, 0, nOvfl*sizeof(Pgno));
4900 pCur->curFlags |= BTCF_ValidOvfl;
drhcdf360a2017-01-27 01:13:49 +00004901 }else{
4902 /* If the overflow page-list cache has been allocated and the
4903 ** entry for the first required overflow page is valid, skip
4904 ** directly to it.
4905 */
4906 if( pCur->aOverflow[offset/ovflSize] ){
4907 iIdx = (offset/ovflSize);
4908 nextPage = pCur->aOverflow[iIdx];
4909 offset = (offset%ovflSize);
4910 }
danielk19772dec9702007-05-02 16:48:37 +00004911 }
danielk1977da107192007-05-04 08:32:13 +00004912
drhcd645532017-01-20 20:43:14 +00004913 assert( rc==SQLITE_OK && amt>0 );
4914 while( nextPage ){
danielk1977da107192007-05-04 08:32:13 +00004915 /* If required, populate the overflow page-list cache. */
drh584e8b72020-07-22 17:12:59 +00004916 if( nextPage > pBt->nPage ) return SQLITE_CORRUPT_BKPT;
drh42e28f12017-01-27 00:31:59 +00004917 assert( pCur->aOverflow[iIdx]==0
4918 || pCur->aOverflow[iIdx]==nextPage
4919 || CORRUPT_DB );
4920 pCur->aOverflow[iIdx] = nextPage;
danielk1977da107192007-05-04 08:32:13 +00004921
danielk1977d04417962007-05-02 13:16:30 +00004922 if( offset>=ovflSize ){
4923 /* The only reason to read this page is to obtain the page
danielk1977da107192007-05-04 08:32:13 +00004924 ** number for the next page in the overflow chain. The page
drhfd131da2007-08-07 17:13:03 +00004925 ** data is not required. So first try to lookup the overflow
4926 ** page-list cache, if any, then fall back to the getOverflowPage()
danielk1977da107192007-05-04 08:32:13 +00004927 ** function.
danielk1977d04417962007-05-02 13:16:30 +00004928 */
drha38c9512014-04-01 01:24:34 +00004929 assert( pCur->curFlags & BTCF_ValidOvfl );
dan85753662014-12-11 16:38:18 +00004930 assert( pCur->pBtree->db==pBt->db );
drha38c9512014-04-01 01:24:34 +00004931 if( pCur->aOverflow[iIdx+1] ){
danielk1977da107192007-05-04 08:32:13 +00004932 nextPage = pCur->aOverflow[iIdx+1];
drha38c9512014-04-01 01:24:34 +00004933 }else{
danielk1977da107192007-05-04 08:32:13 +00004934 rc = getOverflowPage(pBt, nextPage, 0, &nextPage);
drha38c9512014-04-01 01:24:34 +00004935 }
danielk1977da107192007-05-04 08:32:13 +00004936 offset -= ovflSize;
danielk1977d04417962007-05-02 13:16:30 +00004937 }else{
danielk19779f8d6402007-05-02 17:48:45 +00004938 /* Need to read this page properly. It contains some of the
4939 ** range of data that is being read (eOp==0) or written (eOp!=0).
danielk1977d04417962007-05-02 13:16:30 +00004940 */
danielk1977cfe9a692004-06-16 12:00:29 +00004941 int a = amt;
danf4ba1092011-10-08 14:57:07 +00004942 if( a + offset > ovflSize ){
4943 a = ovflSize - offset;
danielk19779f8d6402007-05-02 17:48:45 +00004944 }
danf4ba1092011-10-08 14:57:07 +00004945
4946#ifdef SQLITE_DIRECT_OVERFLOW_READ
4947 /* If all the following are true:
4948 **
4949 ** 1) this is a read operation, and
4950 ** 2) data is required from the start of this overflow page, and
dan09236752018-11-22 19:10:14 +00004951 ** 3) there are no dirty pages in the page-cache
drh8bb9fd32017-01-26 16:27:32 +00004952 ** 4) the database is file-backed, and
drhd930b5c2017-01-26 02:26:02 +00004953 ** 5) the page is not in the WAL file
drh8bb9fd32017-01-26 16:27:32 +00004954 ** 6) at least 4 bytes have already been read into the output buffer
danf4ba1092011-10-08 14:57:07 +00004955 **
4956 ** then data can be read directly from the database file into the
4957 ** output buffer, bypassing the page-cache altogether. This speeds
4958 ** up loading large records that span many overflow pages.
4959 */
drh42e28f12017-01-27 00:31:59 +00004960 if( eOp==0 /* (1) */
danf4ba1092011-10-08 14:57:07 +00004961 && offset==0 /* (2) */
dan09236752018-11-22 19:10:14 +00004962 && sqlite3PagerDirectReadOk(pBt->pPager, nextPage) /* (3,4,5) */
drh8bb9fd32017-01-26 16:27:32 +00004963 && &pBuf[-4]>=pBufStart /* (6) */
danf4ba1092011-10-08 14:57:07 +00004964 ){
dan09236752018-11-22 19:10:14 +00004965 sqlite3_file *fd = sqlite3PagerFile(pBt->pPager);
danf4ba1092011-10-08 14:57:07 +00004966 u8 aSave[4];
4967 u8 *aWrite = &pBuf[-4];
drh8bb9fd32017-01-26 16:27:32 +00004968 assert( aWrite>=pBufStart ); /* due to (6) */
danf4ba1092011-10-08 14:57:07 +00004969 memcpy(aSave, aWrite, 4);
dan27d47fb2011-12-21 17:00:16 +00004970 rc = sqlite3OsRead(fd, aWrite, a+4, (i64)pBt->pageSize*(nextPage-1));
drhb9fc4552019-08-15 00:04:44 +00004971 if( rc && nextPage>pBt->nPage ) rc = SQLITE_CORRUPT_BKPT;
danf4ba1092011-10-08 14:57:07 +00004972 nextPage = get4byte(aWrite);
4973 memcpy(aWrite, aSave, 4);
4974 }else
4975#endif
4976
4977 {
4978 DbPage *pDbPage;
drh9584f582015-11-04 20:22:37 +00004979 rc = sqlite3PagerGet(pBt->pPager, nextPage, &pDbPage,
drh42e28f12017-01-27 00:31:59 +00004980 (eOp==0 ? PAGER_GET_READONLY : 0)
dan11dcd112013-03-15 18:29:18 +00004981 );
danf4ba1092011-10-08 14:57:07 +00004982 if( rc==SQLITE_OK ){
4983 aPayload = sqlite3PagerGetData(pDbPage);
4984 nextPage = get4byte(aPayload);
drh42e28f12017-01-27 00:31:59 +00004985 rc = copyPayload(&aPayload[offset+4], pBuf, a, eOp, pDbPage);
danf4ba1092011-10-08 14:57:07 +00004986 sqlite3PagerUnref(pDbPage);
4987 offset = 0;
4988 }
4989 }
4990 amt -= a;
drh6ee610b2017-01-27 01:25:00 +00004991 if( amt==0 ) return rc;
danf4ba1092011-10-08 14:57:07 +00004992 pBuf += a;
danielk1977cfe9a692004-06-16 12:00:29 +00004993 }
drhcd645532017-01-20 20:43:14 +00004994 if( rc ) break;
4995 iIdx++;
drh2af926b2001-05-15 00:39:25 +00004996 }
drh2af926b2001-05-15 00:39:25 +00004997 }
danielk1977cfe9a692004-06-16 12:00:29 +00004998
danielk1977da107192007-05-04 08:32:13 +00004999 if( rc==SQLITE_OK && amt>0 ){
drhcc97ca42017-06-07 22:32:59 +00005000 /* Overflow chain ends prematurely */
daneebf2f52017-11-18 17:30:08 +00005001 return SQLITE_CORRUPT_PAGE(pPage);
drha7fcb052001-12-14 15:09:55 +00005002 }
danielk1977da107192007-05-04 08:32:13 +00005003 return rc;
drh2af926b2001-05-15 00:39:25 +00005004}
5005
drh72f82862001-05-24 21:06:34 +00005006/*
drhcb3cabd2016-11-25 19:18:28 +00005007** Read part of the payload for the row at which that cursor pCur is currently
5008** pointing. "amt" bytes will be transferred into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00005009** begins at "offset".
drh8c1238a2003-01-02 14:43:55 +00005010**
drhcb3cabd2016-11-25 19:18:28 +00005011** pCur can be pointing to either a table or an index b-tree.
5012** If pointing to a table btree, then the content section is read. If
5013** pCur is pointing to an index b-tree then the key section is read.
5014**
5015** For sqlite3BtreePayload(), the caller must ensure that pCur is pointing
5016** to a valid row in the table. For sqlite3BtreePayloadChecked(), the
5017** cursor might be invalid or might need to be restored before being read.
drh5d1a8722009-07-22 18:07:40 +00005018**
drh3aac2dd2004-04-26 14:10:20 +00005019** Return SQLITE_OK on success or an error code if anything goes
5020** wrong. An error is returned if "offset+amt" is larger than
5021** the available payload.
drh72f82862001-05-24 21:06:34 +00005022*/
drhcb3cabd2016-11-25 19:18:28 +00005023int sqlite3BtreePayload(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
drh1fee73e2007-08-29 04:00:57 +00005024 assert( cursorHoldsMutex(pCur) );
drh5d1a8722009-07-22 18:07:40 +00005025 assert( pCur->eState==CURSOR_VALID );
drh352a35a2017-08-15 03:46:47 +00005026 assert( pCur->iPage>=0 && pCur->pPage );
5027 assert( pCur->ix<pCur->pPage->nCell );
drh5d1a8722009-07-22 18:07:40 +00005028 return accessPayload(pCur, offset, amt, (unsigned char*)pBuf, 0);
drh3aac2dd2004-04-26 14:10:20 +00005029}
drh83ec2762017-01-26 16:54:47 +00005030
5031/*
5032** This variant of sqlite3BtreePayload() works even if the cursor has not
5033** in the CURSOR_VALID state. It is only used by the sqlite3_blob_read()
5034** interface.
5035*/
danielk19773588ceb2008-06-10 17:30:26 +00005036#ifndef SQLITE_OMIT_INCRBLOB
drh83ec2762017-01-26 16:54:47 +00005037static SQLITE_NOINLINE int accessPayloadChecked(
5038 BtCursor *pCur,
5039 u32 offset,
5040 u32 amt,
5041 void *pBuf
5042){
drhcb3cabd2016-11-25 19:18:28 +00005043 int rc;
danielk19773588ceb2008-06-10 17:30:26 +00005044 if ( pCur->eState==CURSOR_INVALID ){
5045 return SQLITE_ABORT;
5046 }
dan7a2347e2016-01-07 16:43:54 +00005047 assert( cursorOwnsBtShared(pCur) );
drh945b0942017-01-26 21:30:00 +00005048 rc = btreeRestoreCursorPosition(pCur);
drh83ec2762017-01-26 16:54:47 +00005049 return rc ? rc : accessPayload(pCur, offset, amt, pBuf, 0);
5050}
5051int sqlite3BtreePayloadChecked(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
5052 if( pCur->eState==CURSOR_VALID ){
5053 assert( cursorOwnsBtShared(pCur) );
5054 return accessPayload(pCur, offset, amt, pBuf, 0);
5055 }else{
5056 return accessPayloadChecked(pCur, offset, amt, pBuf);
danielk1977da184232006-01-05 11:34:32 +00005057 }
drh2af926b2001-05-15 00:39:25 +00005058}
drhcb3cabd2016-11-25 19:18:28 +00005059#endif /* SQLITE_OMIT_INCRBLOB */
drh2af926b2001-05-15 00:39:25 +00005060
drh72f82862001-05-24 21:06:34 +00005061/*
drh0e1c19e2004-05-11 00:58:56 +00005062** Return a pointer to payload information from the entry that the
5063** pCur cursor is pointing to. The pointer is to the beginning of
drh2a8d2262013-12-09 20:43:22 +00005064** the key if index btrees (pPage->intKey==0) and is the data for
5065** table btrees (pPage->intKey==1). The number of bytes of available
5066** key/data is written into *pAmt. If *pAmt==0, then the value
5067** returned will not be a valid pointer.
drh0e1c19e2004-05-11 00:58:56 +00005068**
5069** This routine is an optimization. It is common for the entire key
5070** and data to fit on the local page and for there to be no overflow
5071** pages. When that is so, this routine can be used to access the
5072** key and data without making a copy. If the key and/or data spills
drh7f751222009-03-17 22:33:00 +00005073** onto overflow pages, then accessPayload() must be used to reassemble
drh0e1c19e2004-05-11 00:58:56 +00005074** the key/data and copy it into a preallocated buffer.
5075**
5076** The pointer returned by this routine looks directly into the cached
5077** page of the database. The data might change or move the next time
5078** any btree routine is called.
5079*/
drh2a8d2262013-12-09 20:43:22 +00005080static const void *fetchPayload(
drh0e1c19e2004-05-11 00:58:56 +00005081 BtCursor *pCur, /* Cursor pointing to entry to read from */
drh2a8d2262013-12-09 20:43:22 +00005082 u32 *pAmt /* Write the number of available bytes here */
drh0e1c19e2004-05-11 00:58:56 +00005083){
danf2f72a02017-10-19 15:17:38 +00005084 int amt;
drh352a35a2017-08-15 03:46:47 +00005085 assert( pCur!=0 && pCur->iPage>=0 && pCur->pPage);
danielk1977da184232006-01-05 11:34:32 +00005086 assert( pCur->eState==CURSOR_VALID );
drh2a8d2262013-12-09 20:43:22 +00005087 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
dan7a2347e2016-01-07 16:43:54 +00005088 assert( cursorOwnsBtShared(pCur) );
drh352a35a2017-08-15 03:46:47 +00005089 assert( pCur->ix<pCur->pPage->nCell );
drh86dd3712014-03-25 11:00:21 +00005090 assert( pCur->info.nSize>0 );
drh352a35a2017-08-15 03:46:47 +00005091 assert( pCur->info.pPayload>pCur->pPage->aData || CORRUPT_DB );
5092 assert( pCur->info.pPayload<pCur->pPage->aDataEnd ||CORRUPT_DB);
danf2f72a02017-10-19 15:17:38 +00005093 amt = pCur->info.nLocal;
5094 if( amt>(int)(pCur->pPage->aDataEnd - pCur->info.pPayload) ){
5095 /* There is too little space on the page for the expected amount
5096 ** of local content. Database must be corrupt. */
5097 assert( CORRUPT_DB );
5098 amt = MAX(0, (int)(pCur->pPage->aDataEnd - pCur->info.pPayload));
5099 }
5100 *pAmt = (u32)amt;
drhab1cc582014-09-23 21:25:19 +00005101 return (void*)pCur->info.pPayload;
drh0e1c19e2004-05-11 00:58:56 +00005102}
5103
5104
5105/*
drhe51c44f2004-05-30 20:46:09 +00005106** For the entry that cursor pCur is point to, return as
5107** many bytes of the key or data as are available on the local
5108** b-tree page. Write the number of available bytes into *pAmt.
drh0e1c19e2004-05-11 00:58:56 +00005109**
5110** The pointer returned is ephemeral. The key/data may move
drhd677b3d2007-08-20 22:48:41 +00005111** or be destroyed on the next call to any Btree routine,
5112** including calls from other threads against the same cache.
5113** Hence, a mutex on the BtShared should be held prior to calling
5114** this routine.
drh0e1c19e2004-05-11 00:58:56 +00005115**
5116** These routines is used to get quick access to key and data
5117** in the common case where no overflow pages are used.
drh0e1c19e2004-05-11 00:58:56 +00005118*/
drha7c90c42016-06-04 20:37:10 +00005119const void *sqlite3BtreePayloadFetch(BtCursor *pCur, u32 *pAmt){
drh2a8d2262013-12-09 20:43:22 +00005120 return fetchPayload(pCur, pAmt);
drh0e1c19e2004-05-11 00:58:56 +00005121}
5122
5123
5124/*
drh8178a752003-01-05 21:41:40 +00005125** Move the cursor down to a new child page. The newPgno argument is the
drhab01f612004-05-22 02:55:23 +00005126** page number of the child page to move to.
danielk1977a299d612009-07-13 11:22:10 +00005127**
5128** This function returns SQLITE_CORRUPT if the page-header flags field of
5129** the new child page does not match the flags field of the parent (i.e.
5130** if an intkey page appears to be the parent of a non-intkey page, or
5131** vice-versa).
drh72f82862001-05-24 21:06:34 +00005132*/
drh3aac2dd2004-04-26 14:10:20 +00005133static int moveToChild(BtCursor *pCur, u32 newPgno){
drhd0679ed2007-08-28 22:24:34 +00005134 BtShared *pBt = pCur->pBt;
drh72f82862001-05-24 21:06:34 +00005135
dan7a2347e2016-01-07 16:43:54 +00005136 assert( cursorOwnsBtShared(pCur) );
danielk1977da184232006-01-05 11:34:32 +00005137 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00005138 assert( pCur->iPage<BTCURSOR_MAX_DEPTH );
dan11dcd112013-03-15 18:29:18 +00005139 assert( pCur->iPage>=0 );
danielk197771d5d2c2008-09-29 11:49:47 +00005140 if( pCur->iPage>=(BTCURSOR_MAX_DEPTH-1) ){
5141 return SQLITE_CORRUPT_BKPT;
5142 }
drh271efa52004-05-30 19:19:05 +00005143 pCur->info.nSize = 0;
drh036dbec2014-03-11 23:40:44 +00005144 pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
drh352a35a2017-08-15 03:46:47 +00005145 pCur->aiIdx[pCur->iPage] = pCur->ix;
5146 pCur->apPage[pCur->iPage] = pCur->pPage;
drh75e96b32017-04-01 00:20:06 +00005147 pCur->ix = 0;
drh352a35a2017-08-15 03:46:47 +00005148 pCur->iPage++;
5149 return getAndInitPage(pBt, newPgno, &pCur->pPage, pCur, pCur->curPagerFlags);
drh72f82862001-05-24 21:06:34 +00005150}
5151
drhd879e3e2017-02-13 13:35:55 +00005152#ifdef SQLITE_DEBUG
danielk1977bf93c562008-09-29 15:53:25 +00005153/*
5154** Page pParent is an internal (non-leaf) tree page. This function
5155** asserts that page number iChild is the left-child if the iIdx'th
5156** cell in page pParent. Or, if iIdx is equal to the total number of
5157** cells in pParent, that page number iChild is the right-child of
5158** the page.
5159*/
5160static void assertParentIndex(MemPage *pParent, int iIdx, Pgno iChild){
drhcbd33492015-03-25 13:06:54 +00005161 if( CORRUPT_DB ) return; /* The conditions tested below might not be true
5162 ** in a corrupt database */
danielk1977bf93c562008-09-29 15:53:25 +00005163 assert( iIdx<=pParent->nCell );
5164 if( iIdx==pParent->nCell ){
5165 assert( get4byte(&pParent->aData[pParent->hdrOffset+8])==iChild );
5166 }else{
5167 assert( get4byte(findCell(pParent, iIdx))==iChild );
5168 }
5169}
5170#else
5171# define assertParentIndex(x,y,z)
5172#endif
5173
drh72f82862001-05-24 21:06:34 +00005174/*
drh5e2f8b92001-05-28 00:41:15 +00005175** Move the cursor up to the parent page.
5176**
5177** pCur->idx is set to the cell index that contains the pointer
5178** to the page we are coming from. If we are coming from the
5179** right-most child page then pCur->idx is set to one more than
drhbd03cae2001-06-02 02:40:57 +00005180** the largest cell index.
drh72f82862001-05-24 21:06:34 +00005181*/
danielk197730548662009-07-09 05:07:37 +00005182static void moveToParent(BtCursor *pCur){
drh352a35a2017-08-15 03:46:47 +00005183 MemPage *pLeaf;
dan7a2347e2016-01-07 16:43:54 +00005184 assert( cursorOwnsBtShared(pCur) );
danielk1977da184232006-01-05 11:34:32 +00005185 assert( pCur->eState==CURSOR_VALID );
danielk197771d5d2c2008-09-29 11:49:47 +00005186 assert( pCur->iPage>0 );
drh352a35a2017-08-15 03:46:47 +00005187 assert( pCur->pPage );
danielk1977bf93c562008-09-29 15:53:25 +00005188 assertParentIndex(
5189 pCur->apPage[pCur->iPage-1],
5190 pCur->aiIdx[pCur->iPage-1],
drh352a35a2017-08-15 03:46:47 +00005191 pCur->pPage->pgno
danielk1977bf93c562008-09-29 15:53:25 +00005192 );
dan6c2688c2012-01-12 15:05:03 +00005193 testcase( pCur->aiIdx[pCur->iPage-1] > pCur->apPage[pCur->iPage-1]->nCell );
drh271efa52004-05-30 19:19:05 +00005194 pCur->info.nSize = 0;
drh036dbec2014-03-11 23:40:44 +00005195 pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
drh75e96b32017-04-01 00:20:06 +00005196 pCur->ix = pCur->aiIdx[pCur->iPage-1];
drh352a35a2017-08-15 03:46:47 +00005197 pLeaf = pCur->pPage;
5198 pCur->pPage = pCur->apPage[--pCur->iPage];
5199 releasePageNotNull(pLeaf);
drh72f82862001-05-24 21:06:34 +00005200}
5201
5202/*
danielk19778f880a82009-07-13 09:41:45 +00005203** Move the cursor to point to the root page of its b-tree structure.
5204**
5205** If the table has a virtual root page, then the cursor is moved to point
5206** to the virtual root page instead of the actual root page. A table has a
5207** virtual root page when the actual root page contains no cells and a
5208** single child page. This can only happen with the table rooted at page 1.
5209**
5210** If the b-tree structure is empty, the cursor state is set to
drh44548e72017-08-14 18:13:52 +00005211** CURSOR_INVALID and this routine returns SQLITE_EMPTY. Otherwise,
5212** the cursor is set to point to the first cell located on the root
5213** (or virtual root) page and the cursor state is set to CURSOR_VALID.
danielk19778f880a82009-07-13 09:41:45 +00005214**
5215** If this function returns successfully, it may be assumed that the
5216** page-header flags indicate that the [virtual] root-page is the expected
5217** kind of b-tree page (i.e. if when opening the cursor the caller did not
5218** specify a KeyInfo structure the flags byte is set to 0x05 or 0x0D,
5219** indicating a table b-tree, or if the caller did specify a KeyInfo
5220** structure the flags byte is set to 0x02 or 0x0A, indicating an index
5221** b-tree).
drh72f82862001-05-24 21:06:34 +00005222*/
drh5e2f8b92001-05-28 00:41:15 +00005223static int moveToRoot(BtCursor *pCur){
drh3aac2dd2004-04-26 14:10:20 +00005224 MemPage *pRoot;
drh777e4c42006-01-13 04:31:58 +00005225 int rc = SQLITE_OK;
drhbd03cae2001-06-02 02:40:57 +00005226
dan7a2347e2016-01-07 16:43:54 +00005227 assert( cursorOwnsBtShared(pCur) );
drhfb982642007-08-30 01:19:59 +00005228 assert( CURSOR_INVALID < CURSOR_REQUIRESEEK );
5229 assert( CURSOR_VALID < CURSOR_REQUIRESEEK );
5230 assert( CURSOR_FAULT > CURSOR_REQUIRESEEK );
drh85ef6302017-08-02 15:50:09 +00005231 assert( pCur->eState < CURSOR_REQUIRESEEK || pCur->iPage<0 );
drh44548e72017-08-14 18:13:52 +00005232 assert( pCur->pgnoRoot>0 || pCur->iPage<0 );
danielk197771d5d2c2008-09-29 11:49:47 +00005233
5234 if( pCur->iPage>=0 ){
drh7ad3eb62016-10-24 01:01:09 +00005235 if( pCur->iPage ){
drh352a35a2017-08-15 03:46:47 +00005236 releasePageNotNull(pCur->pPage);
5237 while( --pCur->iPage ){
5238 releasePageNotNull(pCur->apPage[pCur->iPage]);
5239 }
5240 pCur->pPage = pCur->apPage[0];
drh7ad3eb62016-10-24 01:01:09 +00005241 goto skip_init;
drhbbf0f862015-06-27 14:59:26 +00005242 }
dana205a482011-08-27 18:48:57 +00005243 }else if( pCur->pgnoRoot==0 ){
5244 pCur->eState = CURSOR_INVALID;
drh44548e72017-08-14 18:13:52 +00005245 return SQLITE_EMPTY;
drh777e4c42006-01-13 04:31:58 +00005246 }else{
drh28f58dd2015-06-27 19:45:03 +00005247 assert( pCur->iPage==(-1) );
drh85ef6302017-08-02 15:50:09 +00005248 if( pCur->eState>=CURSOR_REQUIRESEEK ){
5249 if( pCur->eState==CURSOR_FAULT ){
5250 assert( pCur->skipNext!=SQLITE_OK );
5251 return pCur->skipNext;
5252 }
5253 sqlite3BtreeClearCursor(pCur);
5254 }
drh352a35a2017-08-15 03:46:47 +00005255 rc = getAndInitPage(pCur->pBtree->pBt, pCur->pgnoRoot, &pCur->pPage,
drh15a00212015-06-27 20:55:00 +00005256 0, pCur->curPagerFlags);
drh4c301aa2009-07-15 17:25:45 +00005257 if( rc!=SQLITE_OK ){
drh777e4c42006-01-13 04:31:58 +00005258 pCur->eState = CURSOR_INVALID;
drhf0357d82017-08-14 17:03:58 +00005259 return rc;
drh777e4c42006-01-13 04:31:58 +00005260 }
danielk1977172114a2009-07-07 15:47:12 +00005261 pCur->iPage = 0;
drh352a35a2017-08-15 03:46:47 +00005262 pCur->curIntKey = pCur->pPage->intKey;
drhc39e0002004-05-07 23:50:57 +00005263 }
drh352a35a2017-08-15 03:46:47 +00005264 pRoot = pCur->pPage;
danielk197771d5d2c2008-09-29 11:49:47 +00005265 assert( pRoot->pgno==pCur->pgnoRoot );
dan7df42ab2014-01-20 18:25:44 +00005266
5267 /* If pCur->pKeyInfo is not NULL, then the caller that opened this cursor
5268 ** expected to open it on an index b-tree. Otherwise, if pKeyInfo is
5269 ** NULL, the caller expects a table b-tree. If this is not the case,
5270 ** return an SQLITE_CORRUPT error.
5271 **
5272 ** Earlier versions of SQLite assumed that this test could not fail
5273 ** if the root page was already loaded when this function was called (i.e.
5274 ** if pCur->iPage>=0). But this is not so if the database is corrupted
5275 ** in such a way that page pRoot is linked into a second b-tree table
5276 ** (or the freelist). */
5277 assert( pRoot->intKey==1 || pRoot->intKey==0 );
5278 if( pRoot->isInit==0 || (pCur->pKeyInfo==0)!=pRoot->intKey ){
daneebf2f52017-11-18 17:30:08 +00005279 return SQLITE_CORRUPT_PAGE(pCur->pPage);
dan7df42ab2014-01-20 18:25:44 +00005280 }
danielk19778f880a82009-07-13 09:41:45 +00005281
drh7ad3eb62016-10-24 01:01:09 +00005282skip_init:
drh75e96b32017-04-01 00:20:06 +00005283 pCur->ix = 0;
drh271efa52004-05-30 19:19:05 +00005284 pCur->info.nSize = 0;
drh036dbec2014-03-11 23:40:44 +00005285 pCur->curFlags &= ~(BTCF_AtLast|BTCF_ValidNKey|BTCF_ValidOvfl);
danielk197771d5d2c2008-09-29 11:49:47 +00005286
drh352a35a2017-08-15 03:46:47 +00005287 pRoot = pCur->pPage;
drh4e8fe3f2013-12-06 23:25:27 +00005288 if( pRoot->nCell>0 ){
5289 pCur->eState = CURSOR_VALID;
5290 }else if( !pRoot->leaf ){
drh8856d6a2004-04-29 14:42:46 +00005291 Pgno subpage;
drhc85240d2009-06-04 16:14:33 +00005292 if( pRoot->pgno!=1 ) return SQLITE_CORRUPT_BKPT;
drh43605152004-05-29 21:46:49 +00005293 subpage = get4byte(&pRoot->aData[pRoot->hdrOffset+8]);
danielk1977da184232006-01-05 11:34:32 +00005294 pCur->eState = CURSOR_VALID;
drh4b70f112004-05-02 21:12:19 +00005295 rc = moveToChild(pCur, subpage);
danielk197771d5d2c2008-09-29 11:49:47 +00005296 }else{
drh4e8fe3f2013-12-06 23:25:27 +00005297 pCur->eState = CURSOR_INVALID;
drh44548e72017-08-14 18:13:52 +00005298 rc = SQLITE_EMPTY;
drh8856d6a2004-04-29 14:42:46 +00005299 }
5300 return rc;
drh72f82862001-05-24 21:06:34 +00005301}
drh2af926b2001-05-15 00:39:25 +00005302
drh5e2f8b92001-05-28 00:41:15 +00005303/*
5304** Move the cursor down to the left-most leaf entry beneath the
5305** entry to which it is currently pointing.
drh777e4c42006-01-13 04:31:58 +00005306**
5307** The left-most leaf is the one with the smallest key - the first
5308** in ascending order.
drh5e2f8b92001-05-28 00:41:15 +00005309*/
5310static int moveToLeftmost(BtCursor *pCur){
5311 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00005312 int rc = SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00005313 MemPage *pPage;
drh5e2f8b92001-05-28 00:41:15 +00005314
dan7a2347e2016-01-07 16:43:54 +00005315 assert( cursorOwnsBtShared(pCur) );
danielk1977da184232006-01-05 11:34:32 +00005316 assert( pCur->eState==CURSOR_VALID );
drh352a35a2017-08-15 03:46:47 +00005317 while( rc==SQLITE_OK && !(pPage = pCur->pPage)->leaf ){
drh75e96b32017-04-01 00:20:06 +00005318 assert( pCur->ix<pPage->nCell );
5319 pgno = get4byte(findCell(pPage, pCur->ix));
drh8178a752003-01-05 21:41:40 +00005320 rc = moveToChild(pCur, pgno);
drh5e2f8b92001-05-28 00:41:15 +00005321 }
drhd677b3d2007-08-20 22:48:41 +00005322 return rc;
drh5e2f8b92001-05-28 00:41:15 +00005323}
5324
drh2dcc9aa2002-12-04 13:40:25 +00005325/*
5326** Move the cursor down to the right-most leaf entry beneath the
5327** page to which it is currently pointing. Notice the difference
5328** between moveToLeftmost() and moveToRightmost(). moveToLeftmost()
5329** finds the left-most entry beneath the *entry* whereas moveToRightmost()
5330** finds the right-most entry beneath the *page*.
drh777e4c42006-01-13 04:31:58 +00005331**
5332** The right-most entry is the one with the largest key - the last
5333** key in ascending order.
drh2dcc9aa2002-12-04 13:40:25 +00005334*/
5335static int moveToRightmost(BtCursor *pCur){
5336 Pgno pgno;
drhd677b3d2007-08-20 22:48:41 +00005337 int rc = SQLITE_OK;
drh1bd10f82008-12-10 21:19:56 +00005338 MemPage *pPage = 0;
drh2dcc9aa2002-12-04 13:40:25 +00005339
dan7a2347e2016-01-07 16:43:54 +00005340 assert( cursorOwnsBtShared(pCur) );
danielk1977da184232006-01-05 11:34:32 +00005341 assert( pCur->eState==CURSOR_VALID );
drh352a35a2017-08-15 03:46:47 +00005342 while( !(pPage = pCur->pPage)->leaf ){
drh43605152004-05-29 21:46:49 +00005343 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh75e96b32017-04-01 00:20:06 +00005344 pCur->ix = pPage->nCell;
drh8178a752003-01-05 21:41:40 +00005345 rc = moveToChild(pCur, pgno);
drhee6438d2014-09-01 13:29:32 +00005346 if( rc ) return rc;
drh2dcc9aa2002-12-04 13:40:25 +00005347 }
drh75e96b32017-04-01 00:20:06 +00005348 pCur->ix = pPage->nCell-1;
drhee6438d2014-09-01 13:29:32 +00005349 assert( pCur->info.nSize==0 );
5350 assert( (pCur->curFlags & BTCF_ValidNKey)==0 );
5351 return SQLITE_OK;
drh2dcc9aa2002-12-04 13:40:25 +00005352}
5353
drh5e00f6c2001-09-13 13:46:56 +00005354/* Move the cursor to the first entry in the table. Return SQLITE_OK
5355** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00005356** or set *pRes to 1 if the table is empty.
drh5e00f6c2001-09-13 13:46:56 +00005357*/
drh3aac2dd2004-04-26 14:10:20 +00005358int sqlite3BtreeFirst(BtCursor *pCur, int *pRes){
drh5e00f6c2001-09-13 13:46:56 +00005359 int rc;
drhd677b3d2007-08-20 22:48:41 +00005360
dan7a2347e2016-01-07 16:43:54 +00005361 assert( cursorOwnsBtShared(pCur) );
drhe5fe6902007-12-07 18:55:28 +00005362 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh5e00f6c2001-09-13 13:46:56 +00005363 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00005364 if( rc==SQLITE_OK ){
drh352a35a2017-08-15 03:46:47 +00005365 assert( pCur->pPage->nCell>0 );
drh44548e72017-08-14 18:13:52 +00005366 *pRes = 0;
5367 rc = moveToLeftmost(pCur);
5368 }else if( rc==SQLITE_EMPTY ){
drh352a35a2017-08-15 03:46:47 +00005369 assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
drh44548e72017-08-14 18:13:52 +00005370 *pRes = 1;
5371 rc = SQLITE_OK;
drh5e00f6c2001-09-13 13:46:56 +00005372 }
drh5e00f6c2001-09-13 13:46:56 +00005373 return rc;
5374}
drh5e2f8b92001-05-28 00:41:15 +00005375
drh9562b552002-02-19 15:00:07 +00005376/* Move the cursor to the last entry in the table. Return SQLITE_OK
5377** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00005378** or set *pRes to 1 if the table is empty.
drh9562b552002-02-19 15:00:07 +00005379*/
drh3aac2dd2004-04-26 14:10:20 +00005380int sqlite3BtreeLast(BtCursor *pCur, int *pRes){
drh9562b552002-02-19 15:00:07 +00005381 int rc;
drhd677b3d2007-08-20 22:48:41 +00005382
dan7a2347e2016-01-07 16:43:54 +00005383 assert( cursorOwnsBtShared(pCur) );
drhe5fe6902007-12-07 18:55:28 +00005384 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk19773f632d52009-05-02 10:03:09 +00005385
5386 /* If the cursor already points to the last entry, this is a no-op. */
drh036dbec2014-03-11 23:40:44 +00005387 if( CURSOR_VALID==pCur->eState && (pCur->curFlags & BTCF_AtLast)!=0 ){
danielk19773f632d52009-05-02 10:03:09 +00005388#ifdef SQLITE_DEBUG
5389 /* This block serves to assert() that the cursor really does point
5390 ** to the last entry in the b-tree. */
5391 int ii;
5392 for(ii=0; ii<pCur->iPage; ii++){
5393 assert( pCur->aiIdx[ii]==pCur->apPage[ii]->nCell );
5394 }
drh319deef2021-04-04 23:56:15 +00005395 assert( pCur->ix==pCur->pPage->nCell-1 || CORRUPT_DB );
5396 testcase( pCur->ix!=pCur->pPage->nCell-1 );
5397 /* ^-- dbsqlfuzz b92b72e4de80b5140c30ab71372ca719b8feb618 */
drh352a35a2017-08-15 03:46:47 +00005398 assert( pCur->pPage->leaf );
danielk19773f632d52009-05-02 10:03:09 +00005399#endif
drheb265342019-05-08 23:55:04 +00005400 *pRes = 0;
danielk19773f632d52009-05-02 10:03:09 +00005401 return SQLITE_OK;
5402 }
5403
drh9562b552002-02-19 15:00:07 +00005404 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00005405 if( rc==SQLITE_OK ){
drh44548e72017-08-14 18:13:52 +00005406 assert( pCur->eState==CURSOR_VALID );
5407 *pRes = 0;
5408 rc = moveToRightmost(pCur);
5409 if( rc==SQLITE_OK ){
5410 pCur->curFlags |= BTCF_AtLast;
drhd677b3d2007-08-20 22:48:41 +00005411 }else{
drh44548e72017-08-14 18:13:52 +00005412 pCur->curFlags &= ~BTCF_AtLast;
drhd677b3d2007-08-20 22:48:41 +00005413 }
drh44548e72017-08-14 18:13:52 +00005414 }else if( rc==SQLITE_EMPTY ){
drh352a35a2017-08-15 03:46:47 +00005415 assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
drh44548e72017-08-14 18:13:52 +00005416 *pRes = 1;
5417 rc = SQLITE_OK;
drh9562b552002-02-19 15:00:07 +00005418 }
drh9562b552002-02-19 15:00:07 +00005419 return rc;
5420}
5421
drh42a410d2021-06-19 18:32:20 +00005422/* Move the cursor so that it points to an entry in a table (a.k.a INTKEY)
5423** table near the key intKey. Return a success code.
drh3aac2dd2004-04-26 14:10:20 +00005424**
drh5e2f8b92001-05-28 00:41:15 +00005425** If an exact match is not found, then the cursor is always
drhbd03cae2001-06-02 02:40:57 +00005426** left pointing at a leaf page which would hold the entry if it
drh5e2f8b92001-05-28 00:41:15 +00005427** were present. The cursor might point to an entry that comes
5428** before or after the key.
5429**
drh64022502009-01-09 14:11:04 +00005430** An integer is written into *pRes which is the result of
5431** comparing the key with the entry to which the cursor is
5432** pointing. The meaning of the integer written into
5433** *pRes is as follows:
drhbd03cae2001-06-02 02:40:57 +00005434**
5435** *pRes<0 The cursor is left pointing at an entry that
drh42a410d2021-06-19 18:32:20 +00005436** is smaller than intKey or if the table is empty
drh1a844c32002-12-04 22:29:28 +00005437** and the cursor is therefore left point to nothing.
drhbd03cae2001-06-02 02:40:57 +00005438**
5439** *pRes==0 The cursor is left pointing at an entry that
drh42a410d2021-06-19 18:32:20 +00005440** exactly matches intKey.
drhbd03cae2001-06-02 02:40:57 +00005441**
5442** *pRes>0 The cursor is left pointing at an entry that
drh42a410d2021-06-19 18:32:20 +00005443** is larger than intKey.
drha059ad02001-04-17 20:09:11 +00005444*/
drh42a410d2021-06-19 18:32:20 +00005445int sqlite3BtreeTableMoveto(
drhe63d9992008-08-13 19:11:48 +00005446 BtCursor *pCur, /* The cursor to be moved */
drhe63d9992008-08-13 19:11:48 +00005447 i64 intKey, /* The table key */
5448 int biasRight, /* If true, bias the search to the high end */
5449 int *pRes /* Write search results here */
drhe4d90812007-03-29 05:51:49 +00005450){
drh72f82862001-05-24 21:06:34 +00005451 int rc;
drhd677b3d2007-08-20 22:48:41 +00005452
dan7a2347e2016-01-07 16:43:54 +00005453 assert( cursorOwnsBtShared(pCur) );
drhe5fe6902007-12-07 18:55:28 +00005454 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
danielk19775cb09632009-07-09 11:36:01 +00005455 assert( pRes );
drh42a410d2021-06-19 18:32:20 +00005456 assert( pCur->pKeyInfo==0 );
5457 assert( pCur->eState!=CURSOR_VALID || pCur->curIntKey!=0 );
drha2c20e42008-03-29 16:01:04 +00005458
5459 /* If the cursor is already positioned at the point we are trying
5460 ** to move to, then just return without doing any work */
drh42a410d2021-06-19 18:32:20 +00005461 if( pCur->eState==CURSOR_VALID && (pCur->curFlags & BTCF_ValidNKey)!=0 ){
drhe63d9992008-08-13 19:11:48 +00005462 if( pCur->info.nKey==intKey ){
drha2c20e42008-03-29 16:01:04 +00005463 *pRes = 0;
5464 return SQLITE_OK;
5465 }
drh451e76d2017-01-21 16:54:19 +00005466 if( pCur->info.nKey<intKey ){
5467 if( (pCur->curFlags & BTCF_AtLast)!=0 ){
5468 *pRes = -1;
5469 return SQLITE_OK;
5470 }
drh7f11afa2017-01-21 21:47:54 +00005471 /* If the requested key is one more than the previous key, then
5472 ** try to get there using sqlite3BtreeNext() rather than a full
5473 ** binary search. This is an optimization only. The correct answer
drh2ab792e2017-05-30 18:34:07 +00005474 ** is still obtained without this case, only a little more slowely */
drh0c873bf2019-01-28 00:42:06 +00005475 if( pCur->info.nKey+1==intKey ){
drh7f11afa2017-01-21 21:47:54 +00005476 *pRes = 0;
drh2ab792e2017-05-30 18:34:07 +00005477 rc = sqlite3BtreeNext(pCur, 0);
5478 if( rc==SQLITE_OK ){
drh7f11afa2017-01-21 21:47:54 +00005479 getCellInfo(pCur);
5480 if( pCur->info.nKey==intKey ){
5481 return SQLITE_OK;
5482 }
drh2ab792e2017-05-30 18:34:07 +00005483 }else if( rc==SQLITE_DONE ){
5484 rc = SQLITE_OK;
5485 }else{
5486 return rc;
drh451e76d2017-01-21 16:54:19 +00005487 }
5488 }
drha2c20e42008-03-29 16:01:04 +00005489 }
5490 }
5491
drh37ccfcf2020-08-31 18:49:04 +00005492#ifdef SQLITE_DEBUG
5493 pCur->pBtree->nSeek++; /* Performance measurement during testing */
5494#endif
5495
drh42a410d2021-06-19 18:32:20 +00005496 rc = moveToRoot(pCur);
5497 if( rc ){
5498 if( rc==SQLITE_EMPTY ){
5499 assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
5500 *pRes = -1;
5501 return SQLITE_OK;
5502 }
5503 return rc;
dan1fed5da2014-02-25 21:01:25 +00005504 }
drh42a410d2021-06-19 18:32:20 +00005505 assert( pCur->pPage );
5506 assert( pCur->pPage->isInit );
5507 assert( pCur->eState==CURSOR_VALID );
5508 assert( pCur->pPage->nCell > 0 );
5509 assert( pCur->iPage==0 || pCur->apPage[0]->intKey==pCur->curIntKey );
5510 assert( pCur->curIntKey );
5511
5512 for(;;){
5513 int lwr, upr, idx, c;
5514 Pgno chldPg;
5515 MemPage *pPage = pCur->pPage;
5516 u8 *pCell; /* Pointer to current cell in pPage */
5517
5518 /* pPage->nCell must be greater than zero. If this is the root-page
5519 ** the cursor would have been INVALID above and this for(;;) loop
5520 ** not run. If this is not the root-page, then the moveToChild() routine
5521 ** would have already detected db corruption. Similarly, pPage must
5522 ** be the right kind (index or table) of b-tree page. Otherwise
5523 ** a moveToChild() or moveToRoot() call would have detected corruption. */
5524 assert( pPage->nCell>0 );
5525 assert( pPage->intKey );
5526 lwr = 0;
5527 upr = pPage->nCell-1;
5528 assert( biasRight==0 || biasRight==1 );
5529 idx = upr>>(1-biasRight); /* idx = biasRight ? upr : (lwr+upr)/2; */
5530 pCur->ix = (u16)idx;
5531 for(;;){
5532 i64 nCellKey;
5533 pCell = findCellPastPtr(pPage, idx);
5534 if( pPage->intKeyLeaf ){
5535 while( 0x80 <= *(pCell++) ){
5536 if( pCell>=pPage->aDataEnd ){
5537 return SQLITE_CORRUPT_PAGE(pPage);
5538 }
5539 }
5540 }
5541 getVarint(pCell, (u64*)&nCellKey);
5542 if( nCellKey<intKey ){
5543 lwr = idx+1;
5544 if( lwr>upr ){ c = -1; break; }
5545 }else if( nCellKey>intKey ){
5546 upr = idx-1;
5547 if( lwr>upr ){ c = +1; break; }
5548 }else{
5549 assert( nCellKey==intKey );
5550 pCur->ix = (u16)idx;
5551 if( !pPage->leaf ){
5552 lwr = idx;
5553 goto moveto_table_next_layer;
5554 }else{
5555 pCur->curFlags |= BTCF_ValidNKey;
5556 pCur->info.nKey = nCellKey;
5557 pCur->info.nSize = 0;
5558 *pRes = 0;
5559 return SQLITE_OK;
5560 }
5561 }
5562 assert( lwr+upr>=0 );
5563 idx = (lwr+upr)>>1; /* idx = (lwr+upr)/2; */
5564 }
5565 assert( lwr==upr+1 || !pPage->leaf );
5566 assert( pPage->isInit );
5567 if( pPage->leaf ){
5568 assert( pCur->ix<pCur->pPage->nCell );
5569 pCur->ix = (u16)idx;
5570 *pRes = c;
5571 rc = SQLITE_OK;
5572 goto moveto_table_finish;
5573 }
5574moveto_table_next_layer:
5575 if( lwr>=pPage->nCell ){
5576 chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
5577 }else{
5578 chldPg = get4byte(findCell(pPage, lwr));
5579 }
5580 pCur->ix = (u16)lwr;
5581 rc = moveToChild(pCur, chldPg);
5582 if( rc ) break;
5583 }
5584moveto_table_finish:
5585 pCur->info.nSize = 0;
5586 assert( (pCur->curFlags & BTCF_ValidOvfl)==0 );
5587 return rc;
5588}
5589
5590/* Move the cursor so that it points to an entry in an index table
5591** near the key pIdxKey. Return a success code.
5592**
5593** If an exact match is not found, then the cursor is always
5594** left pointing at a leaf page which would hold the entry if it
5595** were present. The cursor might point to an entry that comes
5596** before or after the key.
5597**
5598** An integer is written into *pRes which is the result of
5599** comparing the key with the entry to which the cursor is
5600** pointing. The meaning of the integer written into
5601** *pRes is as follows:
5602**
5603** *pRes<0 The cursor is left pointing at an entry that
5604** is smaller than pIdxKey or if the table is empty
5605** and the cursor is therefore left point to nothing.
5606**
5607** *pRes==0 The cursor is left pointing at an entry that
5608** exactly matches pIdxKey.
5609**
5610** *pRes>0 The cursor is left pointing at an entry that
5611** is larger than pIdxKey.
5612**
5613** The pIdxKey->eqSeen field is set to 1 if there
5614** exists an entry in the table that exactly matches pIdxKey.
5615*/
5616int sqlite3BtreeIndexMoveto(
5617 BtCursor *pCur, /* The cursor to be moved */
5618 UnpackedRecord *pIdxKey, /* Unpacked index key */
5619 int *pRes /* Write search results here */
5620){
5621 int rc;
5622 RecordCompare xRecordCompare;
5623
5624 assert( cursorOwnsBtShared(pCur) );
5625 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
5626 assert( pRes );
5627 assert( pCur->pKeyInfo!=0 );
5628
5629#ifdef SQLITE_DEBUG
5630 pCur->pBtree->nSeek++; /* Performance measurement during testing */
5631#endif
5632
5633 xRecordCompare = sqlite3VdbeFindCompare(pIdxKey);
5634 pIdxKey->errCode = 0;
5635 assert( pIdxKey->default_rc==1
5636 || pIdxKey->default_rc==0
5637 || pIdxKey->default_rc==-1
5638 );
dan1fed5da2014-02-25 21:01:25 +00005639
drh5e2f8b92001-05-28 00:41:15 +00005640 rc = moveToRoot(pCur);
drhd677b3d2007-08-20 22:48:41 +00005641 if( rc ){
drh44548e72017-08-14 18:13:52 +00005642 if( rc==SQLITE_EMPTY ){
drh352a35a2017-08-15 03:46:47 +00005643 assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
drh44548e72017-08-14 18:13:52 +00005644 *pRes = -1;
5645 return SQLITE_OK;
5646 }
drhd677b3d2007-08-20 22:48:41 +00005647 return rc;
5648 }
drh352a35a2017-08-15 03:46:47 +00005649 assert( pCur->pPage );
5650 assert( pCur->pPage->isInit );
drh44548e72017-08-14 18:13:52 +00005651 assert( pCur->eState==CURSOR_VALID );
drh352a35a2017-08-15 03:46:47 +00005652 assert( pCur->pPage->nCell > 0 );
5653 assert( pCur->iPage==0 || pCur->apPage[0]->intKey==pCur->curIntKey );
drhc75d8862015-06-27 23:55:20 +00005654 assert( pCur->curIntKey || pIdxKey );
drh14684382006-11-30 13:05:29 +00005655 for(;;){
drhec3e6b12013-11-25 02:38:55 +00005656 int lwr, upr, idx, c;
drh72f82862001-05-24 21:06:34 +00005657 Pgno chldPg;
drh352a35a2017-08-15 03:46:47 +00005658 MemPage *pPage = pCur->pPage;
drhec3e6b12013-11-25 02:38:55 +00005659 u8 *pCell; /* Pointer to current cell in pPage */
danielk1977171fff32009-07-11 05:06:51 +00005660
5661 /* pPage->nCell must be greater than zero. If this is the root-page
5662 ** the cursor would have been INVALID above and this for(;;) loop
5663 ** not run. If this is not the root-page, then the moveToChild() routine
danielk19773fd7cf52009-07-13 07:30:52 +00005664 ** would have already detected db corruption. Similarly, pPage must
5665 ** be the right kind (index or table) of b-tree page. Otherwise
5666 ** a moveToChild() or moveToRoot() call would have detected corruption. */
danielk1977171fff32009-07-11 05:06:51 +00005667 assert( pPage->nCell>0 );
danielk19773fd7cf52009-07-13 07:30:52 +00005668 assert( pPage->intKey==(pIdxKey==0) );
drh72f82862001-05-24 21:06:34 +00005669 lwr = 0;
5670 upr = pPage->nCell-1;
drh42a410d2021-06-19 18:32:20 +00005671 idx = upr>>1; /* idx = (lwr+upr)/2; */
drh75e96b32017-04-01 00:20:06 +00005672 pCur->ix = (u16)idx;
drh42a410d2021-06-19 18:32:20 +00005673 for(;;){
5674 int nCell; /* Size of the pCell cell in bytes */
5675 pCell = findCellPastPtr(pPage, idx);
drhec3e6b12013-11-25 02:38:55 +00005676
drh42a410d2021-06-19 18:32:20 +00005677 /* The maximum supported page-size is 65536 bytes. This means that
5678 ** the maximum number of record bytes stored on an index B-Tree
5679 ** page is less than 16384 bytes and may be stored as a 2-byte
5680 ** varint. This information is used to attempt to avoid parsing
5681 ** the entire cell by checking for the cases where the record is
5682 ** stored entirely within the b-tree page by inspecting the first
5683 ** 2 bytes of the cell.
5684 */
5685 nCell = pCell[0];
5686 if( nCell<=pPage->max1bytePayload ){
5687 /* This branch runs if the record-size field of the cell is a
5688 ** single byte varint and the record fits entirely on the main
5689 ** b-tree page. */
5690 testcase( pCell+nCell+1==pPage->aDataEnd );
5691 c = xRecordCompare(nCell, (void*)&pCell[1], pIdxKey);
5692 }else if( !(pCell[1] & 0x80)
5693 && (nCell = ((nCell&0x7f)<<7) + pCell[1])<=pPage->maxLocal
5694 ){
5695 /* The record-size field is a 2 byte varint and the record
5696 ** fits entirely on the main b-tree page. */
5697 testcase( pCell+nCell+2==pPage->aDataEnd );
5698 c = xRecordCompare(nCell, (void*)&pCell[2], pIdxKey);
5699 }else{
5700 /* The record flows over onto one or more overflow pages. In
5701 ** this case the whole cell needs to be parsed, a buffer allocated
5702 ** and accessPayload() used to retrieve the record into the
5703 ** buffer before VdbeRecordCompare() can be called.
5704 **
5705 ** If the record is corrupt, the xRecordCompare routine may read
5706 ** up to two varints past the end of the buffer. An extra 18
5707 ** bytes of padding is allocated at the end of the buffer in
5708 ** case this happens. */
5709 void *pCellKey;
5710 u8 * const pCellBody = pCell - pPage->childPtrSize;
5711 const int nOverrun = 18; /* Size of the overrun padding */
5712 pPage->xParseCell(pPage, pCellBody, &pCur->info);
5713 nCell = (int)pCur->info.nKey;
5714 testcase( nCell<0 ); /* True if key size is 2^32 or more */
5715 testcase( nCell==0 ); /* Invalid key size: 0x80 0x80 0x00 */
5716 testcase( nCell==1 ); /* Invalid key size: 0x80 0x80 0x01 */
5717 testcase( nCell==2 ); /* Minimum legal index key size */
5718 if( nCell<2 || nCell/pCur->pBt->usableSize>pCur->pBt->nPage ){
5719 rc = SQLITE_CORRUPT_PAGE(pPage);
5720 goto moveto_index_finish;
5721 }
5722 pCellKey = sqlite3Malloc( nCell+nOverrun );
5723 if( pCellKey==0 ){
5724 rc = SQLITE_NOMEM_BKPT;
5725 goto moveto_index_finish;
5726 }
5727 pCur->ix = (u16)idx;
5728 rc = accessPayload(pCur, 0, nCell, (unsigned char*)pCellKey, 0);
5729 memset(((u8*)pCellKey)+nCell,0,nOverrun); /* Fix uninit warnings */
5730 pCur->curFlags &= ~BTCF_ValidOvfl;
5731 if( rc ){
drhfacf0302008-06-17 15:12:00 +00005732 sqlite3_free(pCellKey);
drh42a410d2021-06-19 18:32:20 +00005733 goto moveto_index_finish;
drhe51c44f2004-05-30 20:46:09 +00005734 }
drh42a410d2021-06-19 18:32:20 +00005735 c = sqlite3VdbeRecordCompare(nCell, pCellKey, pIdxKey);
5736 sqlite3_free(pCellKey);
drh72f82862001-05-24 21:06:34 +00005737 }
drh42a410d2021-06-19 18:32:20 +00005738 assert(
5739 (pIdxKey->errCode!=SQLITE_CORRUPT || c==0)
5740 && (pIdxKey->errCode!=SQLITE_NOMEM || pCur->pBtree->db->mallocFailed)
5741 );
5742 if( c<0 ){
5743 lwr = idx+1;
5744 }else if( c>0 ){
5745 upr = idx-1;
5746 }else{
5747 assert( c==0 );
5748 *pRes = 0;
5749 rc = SQLITE_OK;
5750 pCur->ix = (u16)idx;
5751 if( pIdxKey->errCode ) rc = SQLITE_CORRUPT_BKPT;
5752 goto moveto_index_finish;
5753 }
5754 if( lwr>upr ) break;
5755 assert( lwr+upr>=0 );
5756 idx = (lwr+upr)>>1; /* idx = (lwr+upr)/2 */
drh72f82862001-05-24 21:06:34 +00005757 }
drhb07028f2011-10-14 21:49:18 +00005758 assert( lwr==upr+1 || (pPage->intKey && !pPage->leaf) );
danielk197771d5d2c2008-09-29 11:49:47 +00005759 assert( pPage->isInit );
drh3aac2dd2004-04-26 14:10:20 +00005760 if( pPage->leaf ){
drh352a35a2017-08-15 03:46:47 +00005761 assert( pCur->ix<pCur->pPage->nCell );
drh75e96b32017-04-01 00:20:06 +00005762 pCur->ix = (u16)idx;
drhec3e6b12013-11-25 02:38:55 +00005763 *pRes = c;
5764 rc = SQLITE_OK;
drh42a410d2021-06-19 18:32:20 +00005765 goto moveto_index_finish;
drhebf10b12013-11-25 17:38:26 +00005766 }
drhebf10b12013-11-25 17:38:26 +00005767 if( lwr>=pPage->nCell ){
drh43605152004-05-29 21:46:49 +00005768 chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh72f82862001-05-24 21:06:34 +00005769 }else{
danielk19771cc5ed82007-05-16 17:28:43 +00005770 chldPg = get4byte(findCell(pPage, lwr));
drh72f82862001-05-24 21:06:34 +00005771 }
drh75e96b32017-04-01 00:20:06 +00005772 pCur->ix = (u16)lwr;
drh8178a752003-01-05 21:41:40 +00005773 rc = moveToChild(pCur, chldPg);
drhec3e6b12013-11-25 02:38:55 +00005774 if( rc ) break;
drh72f82862001-05-24 21:06:34 +00005775 }
drh42a410d2021-06-19 18:32:20 +00005776moveto_index_finish:
drhd2022b02013-11-25 16:23:52 +00005777 pCur->info.nSize = 0;
drhd95ef5c2016-11-11 18:19:05 +00005778 assert( (pCur->curFlags & BTCF_ValidOvfl)==0 );
drhe63d9992008-08-13 19:11:48 +00005779 return rc;
5780}
5781
drhd677b3d2007-08-20 22:48:41 +00005782
drh72f82862001-05-24 21:06:34 +00005783/*
drhc39e0002004-05-07 23:50:57 +00005784** Return TRUE if the cursor is not pointing at an entry of the table.
5785**
5786** TRUE will be returned after a call to sqlite3BtreeNext() moves
5787** past the last entry in the table or sqlite3BtreePrev() moves past
5788** the first entry. TRUE is also returned if the table is empty.
5789*/
5790int sqlite3BtreeEof(BtCursor *pCur){
danielk1977da184232006-01-05 11:34:32 +00005791 /* TODO: What if the cursor is in CURSOR_REQUIRESEEK but all table entries
5792 ** have been deleted? This API will need to change to return an error code
5793 ** as well as the boolean result value.
5794 */
5795 return (CURSOR_VALID!=pCur->eState);
drhc39e0002004-05-07 23:50:57 +00005796}
5797
5798/*
drh5e98e832017-02-17 19:24:06 +00005799** Return an estimate for the number of rows in the table that pCur is
5800** pointing to. Return a negative number if no estimate is currently
5801** available.
5802*/
5803i64 sqlite3BtreeRowCountEst(BtCursor *pCur){
5804 i64 n;
5805 u8 i;
5806
5807 assert( cursorOwnsBtShared(pCur) );
5808 assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
drh555227b2017-02-23 02:15:33 +00005809
5810 /* Currently this interface is only called by the OP_IfSmaller
5811 ** opcode, and it that case the cursor will always be valid and
5812 ** will always point to a leaf node. */
5813 if( NEVER(pCur->eState!=CURSOR_VALID) ) return -1;
drh352a35a2017-08-15 03:46:47 +00005814 if( NEVER(pCur->pPage->leaf==0) ) return -1;
drh555227b2017-02-23 02:15:33 +00005815
drh352a35a2017-08-15 03:46:47 +00005816 n = pCur->pPage->nCell;
5817 for(i=0; i<pCur->iPage; i++){
drh5e98e832017-02-17 19:24:06 +00005818 n *= pCur->apPage[i]->nCell;
5819 }
5820 return n;
5821}
5822
5823/*
drh2ab792e2017-05-30 18:34:07 +00005824** Advance the cursor to the next entry in the database.
5825** Return value:
5826**
5827** SQLITE_OK success
5828** SQLITE_DONE cursor is already pointing at the last element
5829** otherwise some kind of error occurred
drhe39a7322014-02-03 14:04:11 +00005830**
drhee6438d2014-09-01 13:29:32 +00005831** The main entry point is sqlite3BtreeNext(). That routine is optimized
5832** for the common case of merely incrementing the cell counter BtCursor.aiIdx
5833** to the next cell on the current page. The (slower) btreeNext() helper
5834** routine is called when it is necessary to move to a different page or
5835** to restore the cursor.
5836**
drh89997982017-07-11 18:11:33 +00005837** If bit 0x01 of the F argument in sqlite3BtreeNext(C,F) is 1, then the
5838** cursor corresponds to an SQL index and this routine could have been
5839** skipped if the SQL index had been a unique index. The F argument
5840** is a hint to the implement. SQLite btree implementation does not use
5841** this hint, but COMDB2 does.
drh72f82862001-05-24 21:06:34 +00005842*/
drh89997982017-07-11 18:11:33 +00005843static SQLITE_NOINLINE int btreeNext(BtCursor *pCur){
drh72f82862001-05-24 21:06:34 +00005844 int rc;
danielk197771d5d2c2008-09-29 11:49:47 +00005845 int idx;
danielk197797a227c2006-01-20 16:32:04 +00005846 MemPage *pPage;
drh8b18dd42004-05-12 19:18:15 +00005847
dan7a2347e2016-01-07 16:43:54 +00005848 assert( cursorOwnsBtShared(pCur) );
drhf66f26a2013-08-19 20:04:10 +00005849 if( pCur->eState!=CURSOR_VALID ){
drhee6438d2014-09-01 13:29:32 +00005850 assert( (pCur->curFlags & BTCF_ValidOvfl)==0 );
drhf66f26a2013-08-19 20:04:10 +00005851 rc = restoreCursorPosition(pCur);
5852 if( rc!=SQLITE_OK ){
5853 return rc;
5854 }
5855 if( CURSOR_INVALID==pCur->eState ){
drh2ab792e2017-05-30 18:34:07 +00005856 return SQLITE_DONE;
drhf66f26a2013-08-19 20:04:10 +00005857 }
drh0c873bf2019-01-28 00:42:06 +00005858 if( pCur->eState==CURSOR_SKIPNEXT ){
drh9b47ee32013-08-20 03:13:51 +00005859 pCur->eState = CURSOR_VALID;
drh0c873bf2019-01-28 00:42:06 +00005860 if( pCur->skipNext>0 ) return SQLITE_OK;
drhf66f26a2013-08-19 20:04:10 +00005861 }
danielk1977da184232006-01-05 11:34:32 +00005862 }
danielk1977da184232006-01-05 11:34:32 +00005863
drh352a35a2017-08-15 03:46:47 +00005864 pPage = pCur->pPage;
drh75e96b32017-04-01 00:20:06 +00005865 idx = ++pCur->ix;
drha957e222020-09-30 00:48:45 +00005866 if( !pPage->isInit || sqlite3FaultSim(412) ){
drhf3cd0c82018-06-08 19:13:57 +00005867 /* The only known way for this to happen is for there to be a
5868 ** recursive SQL function that does a DELETE operation as part of a
5869 ** SELECT which deletes content out from under an active cursor
5870 ** in a corrupt database file where the table being DELETE-ed from
5871 ** has pages in common with the table being queried. See TH3
5872 ** module cov1/btree78.test testcase 220 (2018-06-08) for an
5873 ** example. */
5874 return SQLITE_CORRUPT_BKPT;
5875 }
danbb246c42012-01-12 14:25:55 +00005876
5877 /* If the database file is corrupt, it is possible for the value of idx
5878 ** to be invalid here. This can only occur if a second cursor modifies
5879 ** the page while cursor pCur is holding a reference to it. Which can
5880 ** only happen if the database is corrupt in such a way as to link the
drha2d50282019-12-23 18:02:15 +00005881 ** page into more than one b-tree structure.
5882 **
5883 ** Update 2019-12-23: appears to long longer be possible after the
5884 ** addition of anotherValidCursor() condition on balance_deeper(). */
5885 harmless( idx>pPage->nCell );
danielk19776a43f9b2004-11-16 04:57:24 +00005886
danielk197771d5d2c2008-09-29 11:49:47 +00005887 if( idx>=pPage->nCell ){
drha34b6762004-05-07 13:30:42 +00005888 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005889 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
drhee6438d2014-09-01 13:29:32 +00005890 if( rc ) return rc;
5891 return moveToLeftmost(pCur);
drh72f82862001-05-24 21:06:34 +00005892 }
drh5e2f8b92001-05-28 00:41:15 +00005893 do{
danielk197771d5d2c2008-09-29 11:49:47 +00005894 if( pCur->iPage==0 ){
danielk1977da184232006-01-05 11:34:32 +00005895 pCur->eState = CURSOR_INVALID;
drh2ab792e2017-05-30 18:34:07 +00005896 return SQLITE_DONE;
drh5e2f8b92001-05-28 00:41:15 +00005897 }
danielk197730548662009-07-09 05:07:37 +00005898 moveToParent(pCur);
drh352a35a2017-08-15 03:46:47 +00005899 pPage = pCur->pPage;
drh75e96b32017-04-01 00:20:06 +00005900 }while( pCur->ix>=pPage->nCell );
drh44845222008-07-17 18:39:57 +00005901 if( pPage->intKey ){
drh89997982017-07-11 18:11:33 +00005902 return sqlite3BtreeNext(pCur, 0);
drh8b18dd42004-05-12 19:18:15 +00005903 }else{
drhee6438d2014-09-01 13:29:32 +00005904 return SQLITE_OK;
drh8b18dd42004-05-12 19:18:15 +00005905 }
drh8178a752003-01-05 21:41:40 +00005906 }
drh3aac2dd2004-04-26 14:10:20 +00005907 if( pPage->leaf ){
drh8178a752003-01-05 21:41:40 +00005908 return SQLITE_OK;
drhee6438d2014-09-01 13:29:32 +00005909 }else{
5910 return moveToLeftmost(pCur);
drh72f82862001-05-24 21:06:34 +00005911 }
drh72f82862001-05-24 21:06:34 +00005912}
drh2ab792e2017-05-30 18:34:07 +00005913int sqlite3BtreeNext(BtCursor *pCur, int flags){
drhee6438d2014-09-01 13:29:32 +00005914 MemPage *pPage;
drh89997982017-07-11 18:11:33 +00005915 UNUSED_PARAMETER( flags ); /* Used in COMDB2 but not native SQLite */
dan7a2347e2016-01-07 16:43:54 +00005916 assert( cursorOwnsBtShared(pCur) );
drh2ab792e2017-05-30 18:34:07 +00005917 assert( flags==0 || flags==1 );
drhee6438d2014-09-01 13:29:32 +00005918 pCur->info.nSize = 0;
5919 pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
drh89997982017-07-11 18:11:33 +00005920 if( pCur->eState!=CURSOR_VALID ) return btreeNext(pCur);
drh352a35a2017-08-15 03:46:47 +00005921 pPage = pCur->pPage;
drh75e96b32017-04-01 00:20:06 +00005922 if( (++pCur->ix)>=pPage->nCell ){
5923 pCur->ix--;
drh89997982017-07-11 18:11:33 +00005924 return btreeNext(pCur);
drhee6438d2014-09-01 13:29:32 +00005925 }
5926 if( pPage->leaf ){
5927 return SQLITE_OK;
5928 }else{
5929 return moveToLeftmost(pCur);
5930 }
5931}
drh72f82862001-05-24 21:06:34 +00005932
drh3b7511c2001-05-26 13:15:44 +00005933/*
drh2ab792e2017-05-30 18:34:07 +00005934** Step the cursor to the back to the previous entry in the database.
5935** Return values:
5936**
5937** SQLITE_OK success
5938** SQLITE_DONE the cursor is already on the first element of the table
5939** otherwise some kind of error occurred
drhe39a7322014-02-03 14:04:11 +00005940**
drhee6438d2014-09-01 13:29:32 +00005941** The main entry point is sqlite3BtreePrevious(). That routine is optimized
5942** for the common case of merely decrementing the cell counter BtCursor.aiIdx
drh3f387402014-09-24 01:23:00 +00005943** to the previous cell on the current page. The (slower) btreePrevious()
5944** helper routine is called when it is necessary to move to a different page
5945** or to restore the cursor.
drhee6438d2014-09-01 13:29:32 +00005946**
drh89997982017-07-11 18:11:33 +00005947** If bit 0x01 of the F argument to sqlite3BtreePrevious(C,F) is 1, then
5948** the cursor corresponds to an SQL index and this routine could have been
5949** skipped if the SQL index had been a unique index. The F argument is a
5950** hint to the implement. The native SQLite btree implementation does not
5951** use this hint, but COMDB2 does.
drh2dcc9aa2002-12-04 13:40:25 +00005952*/
drh89997982017-07-11 18:11:33 +00005953static SQLITE_NOINLINE int btreePrevious(BtCursor *pCur){
drh2dcc9aa2002-12-04 13:40:25 +00005954 int rc;
drh8178a752003-01-05 21:41:40 +00005955 MemPage *pPage;
danielk1977da184232006-01-05 11:34:32 +00005956
dan7a2347e2016-01-07 16:43:54 +00005957 assert( cursorOwnsBtShared(pCur) );
drhee6438d2014-09-01 13:29:32 +00005958 assert( (pCur->curFlags & (BTCF_AtLast|BTCF_ValidOvfl|BTCF_ValidNKey))==0 );
5959 assert( pCur->info.nSize==0 );
drhf66f26a2013-08-19 20:04:10 +00005960 if( pCur->eState!=CURSOR_VALID ){
drh7682a472014-09-29 15:00:28 +00005961 rc = restoreCursorPosition(pCur);
drhee6438d2014-09-01 13:29:32 +00005962 if( rc!=SQLITE_OK ){
5963 return rc;
drhf66f26a2013-08-19 20:04:10 +00005964 }
5965 if( CURSOR_INVALID==pCur->eState ){
drh2ab792e2017-05-30 18:34:07 +00005966 return SQLITE_DONE;
drhf66f26a2013-08-19 20:04:10 +00005967 }
drh0c873bf2019-01-28 00:42:06 +00005968 if( CURSOR_SKIPNEXT==pCur->eState ){
drh9b47ee32013-08-20 03:13:51 +00005969 pCur->eState = CURSOR_VALID;
drh0c873bf2019-01-28 00:42:06 +00005970 if( pCur->skipNext<0 ) return SQLITE_OK;
drhf66f26a2013-08-19 20:04:10 +00005971 }
danielk1977da184232006-01-05 11:34:32 +00005972 }
danielk1977da184232006-01-05 11:34:32 +00005973
drh352a35a2017-08-15 03:46:47 +00005974 pPage = pCur->pPage;
danielk197771d5d2c2008-09-29 11:49:47 +00005975 assert( pPage->isInit );
drha34b6762004-05-07 13:30:42 +00005976 if( !pPage->leaf ){
drh75e96b32017-04-01 00:20:06 +00005977 int idx = pCur->ix;
danielk197771d5d2c2008-09-29 11:49:47 +00005978 rc = moveToChild(pCur, get4byte(findCell(pPage, idx)));
drhee6438d2014-09-01 13:29:32 +00005979 if( rc ) return rc;
drh2dcc9aa2002-12-04 13:40:25 +00005980 rc = moveToRightmost(pCur);
5981 }else{
drh75e96b32017-04-01 00:20:06 +00005982 while( pCur->ix==0 ){
danielk197771d5d2c2008-09-29 11:49:47 +00005983 if( pCur->iPage==0 ){
danielk1977da184232006-01-05 11:34:32 +00005984 pCur->eState = CURSOR_INVALID;
drh2ab792e2017-05-30 18:34:07 +00005985 return SQLITE_DONE;
drh2dcc9aa2002-12-04 13:40:25 +00005986 }
danielk197730548662009-07-09 05:07:37 +00005987 moveToParent(pCur);
drh2dcc9aa2002-12-04 13:40:25 +00005988 }
drhee6438d2014-09-01 13:29:32 +00005989 assert( pCur->info.nSize==0 );
drhd95ef5c2016-11-11 18:19:05 +00005990 assert( (pCur->curFlags & (BTCF_ValidOvfl))==0 );
danielk197771d5d2c2008-09-29 11:49:47 +00005991
drh75e96b32017-04-01 00:20:06 +00005992 pCur->ix--;
drh352a35a2017-08-15 03:46:47 +00005993 pPage = pCur->pPage;
drh44845222008-07-17 18:39:57 +00005994 if( pPage->intKey && !pPage->leaf ){
drh89997982017-07-11 18:11:33 +00005995 rc = sqlite3BtreePrevious(pCur, 0);
drh8b18dd42004-05-12 19:18:15 +00005996 }else{
5997 rc = SQLITE_OK;
5998 }
drh2dcc9aa2002-12-04 13:40:25 +00005999 }
drh2dcc9aa2002-12-04 13:40:25 +00006000 return rc;
6001}
drh2ab792e2017-05-30 18:34:07 +00006002int sqlite3BtreePrevious(BtCursor *pCur, int flags){
dan7a2347e2016-01-07 16:43:54 +00006003 assert( cursorOwnsBtShared(pCur) );
drh2ab792e2017-05-30 18:34:07 +00006004 assert( flags==0 || flags==1 );
drh89997982017-07-11 18:11:33 +00006005 UNUSED_PARAMETER( flags ); /* Used in COMDB2 but not native SQLite */
drhee6438d2014-09-01 13:29:32 +00006006 pCur->curFlags &= ~(BTCF_AtLast|BTCF_ValidOvfl|BTCF_ValidNKey);
6007 pCur->info.nSize = 0;
6008 if( pCur->eState!=CURSOR_VALID
drh75e96b32017-04-01 00:20:06 +00006009 || pCur->ix==0
drh352a35a2017-08-15 03:46:47 +00006010 || pCur->pPage->leaf==0
drhee6438d2014-09-01 13:29:32 +00006011 ){
drh89997982017-07-11 18:11:33 +00006012 return btreePrevious(pCur);
drhee6438d2014-09-01 13:29:32 +00006013 }
drh75e96b32017-04-01 00:20:06 +00006014 pCur->ix--;
drhee6438d2014-09-01 13:29:32 +00006015 return SQLITE_OK;
6016}
drh2dcc9aa2002-12-04 13:40:25 +00006017
6018/*
drh3b7511c2001-05-26 13:15:44 +00006019** Allocate a new page from the database file.
6020**
danielk19773b8a05f2007-03-19 17:44:26 +00006021** The new page is marked as dirty. (In other words, sqlite3PagerWrite()
drh3b7511c2001-05-26 13:15:44 +00006022** has already been called on the new page.) The new page has also
6023** been referenced and the calling routine is responsible for calling
danielk19773b8a05f2007-03-19 17:44:26 +00006024** sqlite3PagerUnref() on the new page when it is done.
drh3b7511c2001-05-26 13:15:44 +00006025**
6026** SQLITE_OK is returned on success. Any other return value indicates
drh1c8bade2015-05-29 18:42:11 +00006027** an error. *ppPage is set to NULL in the event of an error.
drhbea00b92002-07-08 10:59:50 +00006028**
drh82e647d2013-03-02 03:25:55 +00006029** If the "nearby" parameter is not 0, then an effort is made to
drh199e3cf2002-07-18 11:01:47 +00006030** locate a page close to the page number "nearby". This can be used in an
drhbea00b92002-07-08 10:59:50 +00006031** attempt to keep related pages close to each other in the database file,
6032** which in turn can make database access faster.
danielk1977cb1a7eb2004-11-05 12:27:02 +00006033**
drh82e647d2013-03-02 03:25:55 +00006034** If the eMode parameter is BTALLOC_EXACT and the nearby page exists
6035** anywhere on the free-list, then it is guaranteed to be returned. If
6036** eMode is BTALLOC_LT then the page returned will be less than or equal
6037** to nearby if any such page exists. If eMode is BTALLOC_ANY then there
6038** are no restrictions on which page is returned.
drh3b7511c2001-05-26 13:15:44 +00006039*/
drh4f0c5872007-03-26 22:05:01 +00006040static int allocateBtreePage(
drh82e647d2013-03-02 03:25:55 +00006041 BtShared *pBt, /* The btree */
6042 MemPage **ppPage, /* Store pointer to the allocated page here */
6043 Pgno *pPgno, /* Store the page number here */
6044 Pgno nearby, /* Search for a page near this one */
6045 u8 eMode /* BTALLOC_EXACT, BTALLOC_LT, or BTALLOC_ANY */
danielk1977cb1a7eb2004-11-05 12:27:02 +00006046){
drh3aac2dd2004-04-26 14:10:20 +00006047 MemPage *pPage1;
drh8c42ca92001-06-22 19:15:00 +00006048 int rc;
drh35cd6432009-06-05 14:17:21 +00006049 u32 n; /* Number of pages on the freelist */
drh042d6a12009-06-17 13:57:16 +00006050 u32 k; /* Number of leaves on the trunk of the freelist */
drhd3627af2006-12-18 18:34:51 +00006051 MemPage *pTrunk = 0;
6052 MemPage *pPrevTrunk = 0;
drh1662b5a2009-06-04 19:06:09 +00006053 Pgno mxPage; /* Total size of the database file */
drh30e58752002-03-02 20:41:57 +00006054
drh1fee73e2007-08-29 04:00:57 +00006055 assert( sqlite3_mutex_held(pBt->mutex) );
dan09ff9e12013-03-11 11:49:03 +00006056 assert( eMode==BTALLOC_ANY || (nearby>0 && IfNotOmitAV(pBt->autoVacuum)) );
drh3aac2dd2004-04-26 14:10:20 +00006057 pPage1 = pBt->pPage1;
drhb1299152010-03-30 22:58:33 +00006058 mxPage = btreePagecount(pBt);
drh113762a2014-11-19 16:36:25 +00006059 /* EVIDENCE-OF: R-05119-02637 The 4-byte big-endian integer at offset 36
6060 ** stores stores the total number of pages on the freelist. */
drh3aac2dd2004-04-26 14:10:20 +00006061 n = get4byte(&pPage1->aData[36]);
drhdf35a082009-07-09 02:24:35 +00006062 testcase( n==mxPage-1 );
6063 if( n>=mxPage ){
drh1662b5a2009-06-04 19:06:09 +00006064 return SQLITE_CORRUPT_BKPT;
6065 }
drh3aac2dd2004-04-26 14:10:20 +00006066 if( n>0 ){
drh91025292004-05-03 19:49:32 +00006067 /* There are pages on the freelist. Reuse one of those pages. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00006068 Pgno iTrunk;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006069 u8 searchList = 0; /* If the free-list must be searched for 'nearby' */
drhc6e956f2015-06-24 13:32:10 +00006070 u32 nSearch = 0; /* Count of the number of search attempts */
danielk1977cb1a7eb2004-11-05 12:27:02 +00006071
drh82e647d2013-03-02 03:25:55 +00006072 /* If eMode==BTALLOC_EXACT and a query of the pointer-map
danielk1977cb1a7eb2004-11-05 12:27:02 +00006073 ** shows that the page 'nearby' is somewhere on the free-list, then
6074 ** the entire-list will be searched for that page.
6075 */
6076#ifndef SQLITE_OMIT_AUTOVACUUM
dan51f0b6d2013-02-22 20:16:34 +00006077 if( eMode==BTALLOC_EXACT ){
drh41af5b32020-07-31 02:07:16 +00006078 if( nearby<=mxPage ){
dan51f0b6d2013-02-22 20:16:34 +00006079 u8 eType;
6080 assert( nearby>0 );
6081 assert( pBt->autoVacuum );
6082 rc = ptrmapGet(pBt, nearby, &eType, 0);
6083 if( rc ) return rc;
6084 if( eType==PTRMAP_FREEPAGE ){
6085 searchList = 1;
6086 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006087 }
dan51f0b6d2013-02-22 20:16:34 +00006088 }else if( eMode==BTALLOC_LE ){
6089 searchList = 1;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006090 }
6091#endif
6092
6093 /* Decrement the free-list count by 1. Set iTrunk to the index of the
6094 ** first free-list trunk page. iPrevTrunk is initially 1.
6095 */
danielk19773b8a05f2007-03-19 17:44:26 +00006096 rc = sqlite3PagerWrite(pPage1->pDbPage);
drh3b7511c2001-05-26 13:15:44 +00006097 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00006098 put4byte(&pPage1->aData[36], n-1);
danielk1977cb1a7eb2004-11-05 12:27:02 +00006099
6100 /* The code within this loop is run only once if the 'searchList' variable
6101 ** is not true. Otherwise, it runs once for each trunk-page on the
drh82e647d2013-03-02 03:25:55 +00006102 ** free-list until the page 'nearby' is located (eMode==BTALLOC_EXACT)
6103 ** or until a page less than 'nearby' is located (eMode==BTALLOC_LT)
danielk1977cb1a7eb2004-11-05 12:27:02 +00006104 */
6105 do {
6106 pPrevTrunk = pTrunk;
6107 if( pPrevTrunk ){
drh113762a2014-11-19 16:36:25 +00006108 /* EVIDENCE-OF: R-01506-11053 The first integer on a freelist trunk page
6109 ** is the page number of the next freelist trunk page in the list or
6110 ** zero if this is the last freelist trunk page. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00006111 iTrunk = get4byte(&pPrevTrunk->aData[0]);
drhbea00b92002-07-08 10:59:50 +00006112 }else{
drh113762a2014-11-19 16:36:25 +00006113 /* EVIDENCE-OF: R-59841-13798 The 4-byte big-endian integer at offset 32
6114 ** stores the page number of the first page of the freelist, or zero if
6115 ** the freelist is empty. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00006116 iTrunk = get4byte(&pPage1->aData[32]);
drhbea00b92002-07-08 10:59:50 +00006117 }
drhdf35a082009-07-09 02:24:35 +00006118 testcase( iTrunk==mxPage );
drh9e7804d2015-06-24 12:24:03 +00006119 if( iTrunk>mxPage || nSearch++ > n ){
drhc62aab52017-06-11 18:26:15 +00006120 rc = SQLITE_CORRUPT_PGNO(pPrevTrunk ? pPrevTrunk->pgno : 1);
drh1662b5a2009-06-04 19:06:09 +00006121 }else{
drh7e8c6f12015-05-28 03:28:27 +00006122 rc = btreeGetUnusedPage(pBt, iTrunk, &pTrunk, 0);
drh1662b5a2009-06-04 19:06:09 +00006123 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006124 if( rc ){
drhd3627af2006-12-18 18:34:51 +00006125 pTrunk = 0;
6126 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006127 }
drhb07028f2011-10-14 21:49:18 +00006128 assert( pTrunk!=0 );
6129 assert( pTrunk->aData!=0 );
drh113762a2014-11-19 16:36:25 +00006130 /* EVIDENCE-OF: R-13523-04394 The second integer on a freelist trunk page
6131 ** is the number of leaf page pointers to follow. */
6132 k = get4byte(&pTrunk->aData[4]);
danielk1977cb1a7eb2004-11-05 12:27:02 +00006133 if( k==0 && !searchList ){
6134 /* The trunk has no leaves and the list is not being searched.
6135 ** So extract the trunk page itself and use it as the newly
6136 ** allocated page */
6137 assert( pPrevTrunk==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00006138 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00006139 if( rc ){
6140 goto end_allocate_page;
6141 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006142 *pPgno = iTrunk;
6143 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
6144 *ppPage = pTrunk;
6145 pTrunk = 0;
6146 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
drh042d6a12009-06-17 13:57:16 +00006147 }else if( k>(u32)(pBt->usableSize/4 - 2) ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00006148 /* Value of k is out of range. Database corruption */
drhcc97ca42017-06-07 22:32:59 +00006149 rc = SQLITE_CORRUPT_PGNO(iTrunk);
drhd3627af2006-12-18 18:34:51 +00006150 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006151#ifndef SQLITE_OMIT_AUTOVACUUM
dan51f0b6d2013-02-22 20:16:34 +00006152 }else if( searchList
6153 && (nearby==iTrunk || (iTrunk<nearby && eMode==BTALLOC_LE))
6154 ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00006155 /* The list is being searched and this trunk page is the page
6156 ** to allocate, regardless of whether it has leaves.
6157 */
dan51f0b6d2013-02-22 20:16:34 +00006158 *pPgno = iTrunk;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006159 *ppPage = pTrunk;
6160 searchList = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00006161 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00006162 if( rc ){
6163 goto end_allocate_page;
6164 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006165 if( k==0 ){
6166 if( !pPrevTrunk ){
6167 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
6168 }else{
danf48c3552010-08-23 15:41:24 +00006169 rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
6170 if( rc!=SQLITE_OK ){
6171 goto end_allocate_page;
6172 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006173 memcpy(&pPrevTrunk->aData[0], &pTrunk->aData[0], 4);
6174 }
6175 }else{
6176 /* The trunk page is required by the caller but it contains
6177 ** pointers to free-list leaves. The first leaf becomes a trunk
6178 ** page in this case.
6179 */
6180 MemPage *pNewTrunk;
6181 Pgno iNewTrunk = get4byte(&pTrunk->aData[8]);
drh1662b5a2009-06-04 19:06:09 +00006182 if( iNewTrunk>mxPage ){
drhcc97ca42017-06-07 22:32:59 +00006183 rc = SQLITE_CORRUPT_PGNO(iTrunk);
drh1662b5a2009-06-04 19:06:09 +00006184 goto end_allocate_page;
6185 }
drhdf35a082009-07-09 02:24:35 +00006186 testcase( iNewTrunk==mxPage );
drh7e8c6f12015-05-28 03:28:27 +00006187 rc = btreeGetUnusedPage(pBt, iNewTrunk, &pNewTrunk, 0);
danielk1977cb1a7eb2004-11-05 12:27:02 +00006188 if( rc!=SQLITE_OK ){
drhd3627af2006-12-18 18:34:51 +00006189 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006190 }
danielk19773b8a05f2007-03-19 17:44:26 +00006191 rc = sqlite3PagerWrite(pNewTrunk->pDbPage);
danielk1977cb1a7eb2004-11-05 12:27:02 +00006192 if( rc!=SQLITE_OK ){
6193 releasePage(pNewTrunk);
drhd3627af2006-12-18 18:34:51 +00006194 goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006195 }
6196 memcpy(&pNewTrunk->aData[0], &pTrunk->aData[0], 4);
6197 put4byte(&pNewTrunk->aData[4], k-1);
6198 memcpy(&pNewTrunk->aData[8], &pTrunk->aData[12], (k-1)*4);
drhd3627af2006-12-18 18:34:51 +00006199 releasePage(pNewTrunk);
danielk1977cb1a7eb2004-11-05 12:27:02 +00006200 if( !pPrevTrunk ){
drhc5053fb2008-11-27 02:22:10 +00006201 assert( sqlite3PagerIswriteable(pPage1->pDbPage) );
danielk1977cb1a7eb2004-11-05 12:27:02 +00006202 put4byte(&pPage1->aData[32], iNewTrunk);
6203 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00006204 rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
drhd3627af2006-12-18 18:34:51 +00006205 if( rc ){
6206 goto end_allocate_page;
6207 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006208 put4byte(&pPrevTrunk->aData[0], iNewTrunk);
6209 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006210 }
6211 pTrunk = 0;
6212 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
6213#endif
danielk1977e5765212009-06-17 11:13:28 +00006214 }else if( k>0 ){
danielk1977cb1a7eb2004-11-05 12:27:02 +00006215 /* Extract a leaf from the trunk */
drh042d6a12009-06-17 13:57:16 +00006216 u32 closest;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006217 Pgno iPage;
6218 unsigned char *aData = pTrunk->aData;
6219 if( nearby>0 ){
drh042d6a12009-06-17 13:57:16 +00006220 u32 i;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006221 closest = 0;
danf38b65a2013-02-22 20:57:47 +00006222 if( eMode==BTALLOC_LE ){
6223 for(i=0; i<k; i++){
6224 iPage = get4byte(&aData[8+i*4]);
dan87ade192013-02-23 17:49:16 +00006225 if( iPage<=nearby ){
danf38b65a2013-02-22 20:57:47 +00006226 closest = i;
6227 break;
6228 }
6229 }
6230 }else{
6231 int dist;
6232 dist = sqlite3AbsInt32(get4byte(&aData[8]) - nearby);
6233 for(i=1; i<k; i++){
6234 int d2 = sqlite3AbsInt32(get4byte(&aData[8+i*4]) - nearby);
6235 if( d2<dist ){
6236 closest = i;
6237 dist = d2;
6238 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006239 }
6240 }
6241 }else{
6242 closest = 0;
6243 }
6244
6245 iPage = get4byte(&aData[8+closest*4]);
drhdf35a082009-07-09 02:24:35 +00006246 testcase( iPage==mxPage );
drh07812192021-04-07 12:21:35 +00006247 if( iPage>mxPage || iPage<2 ){
drhcc97ca42017-06-07 22:32:59 +00006248 rc = SQLITE_CORRUPT_PGNO(iTrunk);
drh1662b5a2009-06-04 19:06:09 +00006249 goto end_allocate_page;
6250 }
drhdf35a082009-07-09 02:24:35 +00006251 testcase( iPage==mxPage );
dan51f0b6d2013-02-22 20:16:34 +00006252 if( !searchList
6253 || (iPage==nearby || (iPage<nearby && eMode==BTALLOC_LE))
6254 ){
danielk1977bea2a942009-01-20 17:06:27 +00006255 int noContent;
shane1f9e6aa2008-06-09 19:27:11 +00006256 *pPgno = iPage;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006257 TRACE(("ALLOCATE: %d was leaf %d of %d on trunk %d"
6258 ": %d more free pages\n",
6259 *pPgno, closest+1, k, pTrunk->pgno, n-1));
drh93b4fc72011-04-07 14:47:01 +00006260 rc = sqlite3PagerWrite(pTrunk->pDbPage);
6261 if( rc ) goto end_allocate_page;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006262 if( closest<k-1 ){
6263 memcpy(&aData[8+closest*4], &aData[4+k*4], 4);
6264 }
6265 put4byte(&aData[4], k-1);
drh3f387402014-09-24 01:23:00 +00006266 noContent = !btreeGetHasContent(pBt, *pPgno)? PAGER_GET_NOCONTENT : 0;
drh7e8c6f12015-05-28 03:28:27 +00006267 rc = btreeGetUnusedPage(pBt, *pPgno, ppPage, noContent);
danielk1977cb1a7eb2004-11-05 12:27:02 +00006268 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00006269 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00006270 if( rc!=SQLITE_OK ){
6271 releasePage(*ppPage);
drh1c8bade2015-05-29 18:42:11 +00006272 *ppPage = 0;
danielk1977aac0a382005-01-16 11:07:06 +00006273 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006274 }
6275 searchList = 0;
6276 }
drhee696e22004-08-30 16:52:17 +00006277 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00006278 releasePage(pPrevTrunk);
drhd3627af2006-12-18 18:34:51 +00006279 pPrevTrunk = 0;
danielk1977cb1a7eb2004-11-05 12:27:02 +00006280 }while( searchList );
drh3b7511c2001-05-26 13:15:44 +00006281 }else{
danbc1a3c62013-02-23 16:40:46 +00006282 /* There are no pages on the freelist, so append a new page to the
6283 ** database image.
6284 **
6285 ** Normally, new pages allocated by this block can be requested from the
6286 ** pager layer with the 'no-content' flag set. This prevents the pager
6287 ** from trying to read the pages content from disk. However, if the
6288 ** current transaction has already run one or more incremental-vacuum
6289 ** steps, then the page we are about to allocate may contain content
6290 ** that is required in the event of a rollback. In this case, do
6291 ** not set the no-content flag. This causes the pager to load and journal
6292 ** the current page content before overwriting it.
6293 **
6294 ** Note that the pager will not actually attempt to load or journal
6295 ** content for any page that really does lie past the end of the database
6296 ** file on disk. So the effects of disabling the no-content optimization
6297 ** here are confined to those pages that lie between the end of the
6298 ** database image and the end of the database file.
6299 */
drh3f387402014-09-24 01:23:00 +00006300 int bNoContent = (0==IfNotOmitAV(pBt->bDoTruncate))? PAGER_GET_NOCONTENT:0;
danbc1a3c62013-02-23 16:40:46 +00006301
drhdd3cd972010-03-27 17:12:36 +00006302 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
6303 if( rc ) return rc;
6304 pBt->nPage++;
6305 if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ) pBt->nPage++;
danielk1977bea2a942009-01-20 17:06:27 +00006306
danielk1977afcdd022004-10-31 16:25:42 +00006307#ifndef SQLITE_OMIT_AUTOVACUUM
drhdd3cd972010-03-27 17:12:36 +00006308 if( pBt->autoVacuum && PTRMAP_ISPAGE(pBt, pBt->nPage) ){
danielk1977afcdd022004-10-31 16:25:42 +00006309 /* If *pPgno refers to a pointer-map page, allocate two new pages
6310 ** at the end of the file instead of one. The first allocated page
6311 ** becomes a new pointer-map page, the second is used by the caller.
6312 */
danielk1977ac861692009-03-28 10:54:22 +00006313 MemPage *pPg = 0;
drhdd3cd972010-03-27 17:12:36 +00006314 TRACE(("ALLOCATE: %d from end of file (pointer-map page)\n", pBt->nPage));
6315 assert( pBt->nPage!=PENDING_BYTE_PAGE(pBt) );
drh7e8c6f12015-05-28 03:28:27 +00006316 rc = btreeGetUnusedPage(pBt, pBt->nPage, &pPg, bNoContent);
danielk1977ac861692009-03-28 10:54:22 +00006317 if( rc==SQLITE_OK ){
6318 rc = sqlite3PagerWrite(pPg->pDbPage);
6319 releasePage(pPg);
6320 }
6321 if( rc ) return rc;
drhdd3cd972010-03-27 17:12:36 +00006322 pBt->nPage++;
6323 if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ){ pBt->nPage++; }
danielk1977afcdd022004-10-31 16:25:42 +00006324 }
6325#endif
drhdd3cd972010-03-27 17:12:36 +00006326 put4byte(28 + (u8*)pBt->pPage1->aData, pBt->nPage);
6327 *pPgno = pBt->nPage;
danielk1977afcdd022004-10-31 16:25:42 +00006328
danielk1977599fcba2004-11-08 07:13:13 +00006329 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drh7e8c6f12015-05-28 03:28:27 +00006330 rc = btreeGetUnusedPage(pBt, *pPgno, ppPage, bNoContent);
drh3b7511c2001-05-26 13:15:44 +00006331 if( rc ) return rc;
danielk19773b8a05f2007-03-19 17:44:26 +00006332 rc = sqlite3PagerWrite((*ppPage)->pDbPage);
danielk1977aac0a382005-01-16 11:07:06 +00006333 if( rc!=SQLITE_OK ){
6334 releasePage(*ppPage);
drh7e8c6f12015-05-28 03:28:27 +00006335 *ppPage = 0;
danielk1977aac0a382005-01-16 11:07:06 +00006336 }
drh3a4c1412004-05-09 20:40:11 +00006337 TRACE(("ALLOCATE: %d from end of file\n", *pPgno));
drh3b7511c2001-05-26 13:15:44 +00006338 }
danielk1977599fcba2004-11-08 07:13:13 +00006339
danba14c692019-01-25 13:42:12 +00006340 assert( CORRUPT_DB || *pPgno!=PENDING_BYTE_PAGE(pBt) );
drhd3627af2006-12-18 18:34:51 +00006341
6342end_allocate_page:
6343 releasePage(pTrunk);
6344 releasePage(pPrevTrunk);
drh7e8c6f12015-05-28 03:28:27 +00006345 assert( rc!=SQLITE_OK || sqlite3PagerPageRefcount((*ppPage)->pDbPage)<=1 );
6346 assert( rc!=SQLITE_OK || (*ppPage)->isInit==0 );
drh3b7511c2001-05-26 13:15:44 +00006347 return rc;
6348}
6349
6350/*
danielk1977bea2a942009-01-20 17:06:27 +00006351** This function is used to add page iPage to the database file free-list.
6352** It is assumed that the page is not already a part of the free-list.
drh5e2f8b92001-05-28 00:41:15 +00006353**
danielk1977bea2a942009-01-20 17:06:27 +00006354** The value passed as the second argument to this function is optional.
6355** If the caller happens to have a pointer to the MemPage object
6356** corresponding to page iPage handy, it may pass it as the second value.
6357** Otherwise, it may pass NULL.
6358**
6359** If a pointer to a MemPage object is passed as the second argument,
6360** its reference count is not altered by this function.
drh3b7511c2001-05-26 13:15:44 +00006361*/
danielk1977bea2a942009-01-20 17:06:27 +00006362static int freePage2(BtShared *pBt, MemPage *pMemPage, Pgno iPage){
6363 MemPage *pTrunk = 0; /* Free-list trunk page */
6364 Pgno iTrunk = 0; /* Page number of free-list trunk page */
6365 MemPage *pPage1 = pBt->pPage1; /* Local reference to page 1 */
6366 MemPage *pPage; /* Page being freed. May be NULL. */
6367 int rc; /* Return Code */
drh25050f22019-04-09 01:26:31 +00006368 u32 nFree; /* Initial number of pages on free-list */
drh8b2f49b2001-06-08 00:21:52 +00006369
danielk1977bea2a942009-01-20 17:06:27 +00006370 assert( sqlite3_mutex_held(pBt->mutex) );
danfb0246b2015-05-26 12:18:17 +00006371 assert( CORRUPT_DB || iPage>1 );
danielk1977bea2a942009-01-20 17:06:27 +00006372 assert( !pMemPage || pMemPage->pgno==iPage );
6373
drh53218e22020-07-31 23:34:53 +00006374 if( iPage<2 || iPage>pBt->nPage ){
drh58b42ad2019-03-25 19:50:19 +00006375 return SQLITE_CORRUPT_BKPT;
6376 }
danielk1977bea2a942009-01-20 17:06:27 +00006377 if( pMemPage ){
6378 pPage = pMemPage;
6379 sqlite3PagerRef(pPage->pDbPage);
6380 }else{
6381 pPage = btreePageLookup(pBt, iPage);
6382 }
drh3aac2dd2004-04-26 14:10:20 +00006383
drha34b6762004-05-07 13:30:42 +00006384 /* Increment the free page count on pPage1 */
danielk19773b8a05f2007-03-19 17:44:26 +00006385 rc = sqlite3PagerWrite(pPage1->pDbPage);
danielk1977bea2a942009-01-20 17:06:27 +00006386 if( rc ) goto freepage_out;
6387 nFree = get4byte(&pPage1->aData[36]);
6388 put4byte(&pPage1->aData[36], nFree+1);
drh3aac2dd2004-04-26 14:10:20 +00006389
drhc9166342012-01-05 23:32:06 +00006390 if( pBt->btsFlags & BTS_SECURE_DELETE ){
drh5b47efa2010-02-12 18:18:39 +00006391 /* If the secure_delete option is enabled, then
6392 ** always fully overwrite deleted information with zeros.
6393 */
drhb00fc3b2013-08-21 23:42:32 +00006394 if( (!pPage && ((rc = btreeGetPage(pBt, iPage, &pPage, 0))!=0) )
shaneh84f4b2f2010-02-26 01:46:54 +00006395 || ((rc = sqlite3PagerWrite(pPage->pDbPage))!=0)
drh5b47efa2010-02-12 18:18:39 +00006396 ){
6397 goto freepage_out;
6398 }
6399 memset(pPage->aData, 0, pPage->pBt->pageSize);
danielk1977bea2a942009-01-20 17:06:27 +00006400 }
drhfcce93f2006-02-22 03:08:32 +00006401
danielk1977687566d2004-11-02 12:56:41 +00006402 /* If the database supports auto-vacuum, write an entry in the pointer-map
danielk1977cb1a7eb2004-11-05 12:27:02 +00006403 ** to indicate that the page is free.
danielk1977687566d2004-11-02 12:56:41 +00006404 */
danielk197785d90ca2008-07-19 14:25:15 +00006405 if( ISAUTOVACUUM ){
drh98add2e2009-07-20 17:11:49 +00006406 ptrmapPut(pBt, iPage, PTRMAP_FREEPAGE, 0, &rc);
danielk1977bea2a942009-01-20 17:06:27 +00006407 if( rc ) goto freepage_out;
danielk1977687566d2004-11-02 12:56:41 +00006408 }
danielk1977687566d2004-11-02 12:56:41 +00006409
danielk1977bea2a942009-01-20 17:06:27 +00006410 /* Now manipulate the actual database free-list structure. There are two
6411 ** possibilities. If the free-list is currently empty, or if the first
6412 ** trunk page in the free-list is full, then this page will become a
6413 ** new free-list trunk page. Otherwise, it will become a leaf of the
6414 ** first trunk page in the current free-list. This block tests if it
6415 ** is possible to add the page as a new free-list leaf.
6416 */
6417 if( nFree!=0 ){
drhc046e3e2009-07-15 11:26:44 +00006418 u32 nLeaf; /* Initial number of leaf cells on trunk page */
danielk1977bea2a942009-01-20 17:06:27 +00006419
6420 iTrunk = get4byte(&pPage1->aData[32]);
drh10248222020-07-28 20:32:12 +00006421 if( iTrunk>btreePagecount(pBt) ){
6422 rc = SQLITE_CORRUPT_BKPT;
6423 goto freepage_out;
6424 }
drhb00fc3b2013-08-21 23:42:32 +00006425 rc = btreeGetPage(pBt, iTrunk, &pTrunk, 0);
danielk1977bea2a942009-01-20 17:06:27 +00006426 if( rc!=SQLITE_OK ){
6427 goto freepage_out;
6428 }
6429
6430 nLeaf = get4byte(&pTrunk->aData[4]);
drheeb844a2009-08-08 18:01:07 +00006431 assert( pBt->usableSize>32 );
6432 if( nLeaf > (u32)pBt->usableSize/4 - 2 ){
danielk1977bea2a942009-01-20 17:06:27 +00006433 rc = SQLITE_CORRUPT_BKPT;
6434 goto freepage_out;
6435 }
drheeb844a2009-08-08 18:01:07 +00006436 if( nLeaf < (u32)pBt->usableSize/4 - 8 ){
danielk1977bea2a942009-01-20 17:06:27 +00006437 /* In this case there is room on the trunk page to insert the page
6438 ** being freed as a new leaf.
drh45b1fac2008-07-04 17:52:42 +00006439 **
6440 ** Note that the trunk page is not really full until it contains
6441 ** usableSize/4 - 2 entries, not usableSize/4 - 8 entries as we have
6442 ** coded. But due to a coding error in versions of SQLite prior to
6443 ** 3.6.0, databases with freelist trunk pages holding more than
6444 ** usableSize/4 - 8 entries will be reported as corrupt. In order
6445 ** to maintain backwards compatibility with older versions of SQLite,
drhc046e3e2009-07-15 11:26:44 +00006446 ** we will continue to restrict the number of entries to usableSize/4 - 8
drh45b1fac2008-07-04 17:52:42 +00006447 ** for now. At some point in the future (once everyone has upgraded
6448 ** to 3.6.0 or later) we should consider fixing the conditional above
6449 ** to read "usableSize/4-2" instead of "usableSize/4-8".
drh113762a2014-11-19 16:36:25 +00006450 **
6451 ** EVIDENCE-OF: R-19920-11576 However, newer versions of SQLite still
6452 ** avoid using the last six entries in the freelist trunk page array in
6453 ** order that database files created by newer versions of SQLite can be
6454 ** read by older versions of SQLite.
drh45b1fac2008-07-04 17:52:42 +00006455 */
danielk19773b8a05f2007-03-19 17:44:26 +00006456 rc = sqlite3PagerWrite(pTrunk->pDbPage);
drhf5345442007-04-09 12:45:02 +00006457 if( rc==SQLITE_OK ){
danielk1977bea2a942009-01-20 17:06:27 +00006458 put4byte(&pTrunk->aData[4], nLeaf+1);
6459 put4byte(&pTrunk->aData[8+nLeaf*4], iPage);
drhc9166342012-01-05 23:32:06 +00006460 if( pPage && (pBt->btsFlags & BTS_SECURE_DELETE)==0 ){
danielk1977bea2a942009-01-20 17:06:27 +00006461 sqlite3PagerDontWrite(pPage->pDbPage);
6462 }
danielk1977bea2a942009-01-20 17:06:27 +00006463 rc = btreeSetHasContent(pBt, iPage);
drhf5345442007-04-09 12:45:02 +00006464 }
drh3a4c1412004-05-09 20:40:11 +00006465 TRACE(("FREE-PAGE: %d leaf on trunk page %d\n",pPage->pgno,pTrunk->pgno));
danielk1977bea2a942009-01-20 17:06:27 +00006466 goto freepage_out;
drh3aac2dd2004-04-26 14:10:20 +00006467 }
drh3b7511c2001-05-26 13:15:44 +00006468 }
danielk1977bea2a942009-01-20 17:06:27 +00006469
6470 /* If control flows to this point, then it was not possible to add the
6471 ** the page being freed as a leaf page of the first trunk in the free-list.
6472 ** Possibly because the free-list is empty, or possibly because the
6473 ** first trunk in the free-list is full. Either way, the page being freed
6474 ** will become the new first trunk page in the free-list.
6475 */
drhb00fc3b2013-08-21 23:42:32 +00006476 if( pPage==0 && SQLITE_OK!=(rc = btreeGetPage(pBt, iPage, &pPage, 0)) ){
drhc046e3e2009-07-15 11:26:44 +00006477 goto freepage_out;
6478 }
6479 rc = sqlite3PagerWrite(pPage->pDbPage);
6480 if( rc!=SQLITE_OK ){
danielk1977bea2a942009-01-20 17:06:27 +00006481 goto freepage_out;
6482 }
6483 put4byte(pPage->aData, iTrunk);
6484 put4byte(&pPage->aData[4], 0);
6485 put4byte(&pPage1->aData[32], iPage);
6486 TRACE(("FREE-PAGE: %d new trunk page replacing %d\n", pPage->pgno, iTrunk));
6487
6488freepage_out:
6489 if( pPage ){
6490 pPage->isInit = 0;
6491 }
6492 releasePage(pPage);
6493 releasePage(pTrunk);
drh3b7511c2001-05-26 13:15:44 +00006494 return rc;
6495}
drhc314dc72009-07-21 11:52:34 +00006496static void freePage(MemPage *pPage, int *pRC){
6497 if( (*pRC)==SQLITE_OK ){
6498 *pRC = freePage2(pPage->pBt, pPage, pPage->pgno);
6499 }
danielk1977bea2a942009-01-20 17:06:27 +00006500}
drh3b7511c2001-05-26 13:15:44 +00006501
6502/*
drh86c779f2021-05-15 13:08:44 +00006503** Free the overflow pages associated with the given Cell.
drh3b7511c2001-05-26 13:15:44 +00006504*/
drh86c779f2021-05-15 13:08:44 +00006505static SQLITE_NOINLINE int clearCellOverflow(
drh9bfdc252014-09-24 02:05:41 +00006506 MemPage *pPage, /* The page that contains the Cell */
6507 unsigned char *pCell, /* First byte of the Cell */
drh80159da2016-12-09 17:32:51 +00006508 CellInfo *pInfo /* Size information about the cell */
drh9bfdc252014-09-24 02:05:41 +00006509){
drh60172a52017-08-02 18:27:50 +00006510 BtShared *pBt;
drh3aac2dd2004-04-26 14:10:20 +00006511 Pgno ovflPgno;
drh6f11bef2004-05-13 01:12:56 +00006512 int rc;
drh94440812007-03-06 11:42:19 +00006513 int nOvfl;
shaneh1df2db72010-08-18 02:28:48 +00006514 u32 ovflPageSize;
drh3b7511c2001-05-26 13:15:44 +00006515
drh1fee73e2007-08-29 04:00:57 +00006516 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh86c779f2021-05-15 13:08:44 +00006517 assert( pInfo->nLocal!=pInfo->nPayload );
drh6fcf83a2018-05-05 01:23:28 +00006518 testcase( pCell + pInfo->nSize == pPage->aDataEnd );
6519 testcase( pCell + (pInfo->nSize-1) == pPage->aDataEnd );
6520 if( pCell + pInfo->nSize > pPage->aDataEnd ){
drhcc97ca42017-06-07 22:32:59 +00006521 /* Cell extends past end of page */
daneebf2f52017-11-18 17:30:08 +00006522 return SQLITE_CORRUPT_PAGE(pPage);
drhe42a9b42011-08-31 13:27:19 +00006523 }
drh80159da2016-12-09 17:32:51 +00006524 ovflPgno = get4byte(pCell + pInfo->nSize - 4);
drh60172a52017-08-02 18:27:50 +00006525 pBt = pPage->pBt;
shane63207ab2009-02-04 01:49:30 +00006526 assert( pBt->usableSize > 4 );
drh94440812007-03-06 11:42:19 +00006527 ovflPageSize = pBt->usableSize - 4;
drh80159da2016-12-09 17:32:51 +00006528 nOvfl = (pInfo->nPayload - pInfo->nLocal + ovflPageSize - 1)/ovflPageSize;
dan0f8076d2015-05-25 18:47:26 +00006529 assert( nOvfl>0 ||
drh80159da2016-12-09 17:32:51 +00006530 (CORRUPT_DB && (pInfo->nPayload + ovflPageSize)<ovflPageSize)
dan0f8076d2015-05-25 18:47:26 +00006531 );
drh72365832007-03-06 15:53:44 +00006532 while( nOvfl-- ){
shane63207ab2009-02-04 01:49:30 +00006533 Pgno iNext = 0;
danielk1977bea2a942009-01-20 17:06:27 +00006534 MemPage *pOvfl = 0;
drhb1299152010-03-30 22:58:33 +00006535 if( ovflPgno<2 || ovflPgno>btreePagecount(pBt) ){
danielk1977e589a672009-04-11 16:06:15 +00006536 /* 0 is not a legal page number and page 1 cannot be an
6537 ** overflow page. Therefore if ovflPgno<2 or past the end of the
6538 ** file the database must be corrupt. */
drh49285702005-09-17 15:20:26 +00006539 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00006540 }
danielk1977bea2a942009-01-20 17:06:27 +00006541 if( nOvfl ){
6542 rc = getOverflowPage(pBt, ovflPgno, &pOvfl, &iNext);
6543 if( rc ) return rc;
6544 }
dan887d4b22010-02-25 12:09:16 +00006545
shaneh1da207e2010-03-09 14:41:12 +00006546 if( ( pOvfl || ((pOvfl = btreePageLookup(pBt, ovflPgno))!=0) )
dan887d4b22010-02-25 12:09:16 +00006547 && sqlite3PagerPageRefcount(pOvfl->pDbPage)!=1
6548 ){
6549 /* There is no reason any cursor should have an outstanding reference
6550 ** to an overflow page belonging to a cell that is being deleted/updated.
6551 ** So if there exists more than one reference to this page, then it
6552 ** must not really be an overflow page and the database must be corrupt.
6553 ** It is helpful to detect this before calling freePage2(), as
6554 ** freePage2() may zero the page contents if secure-delete mode is
6555 ** enabled. If this 'overflow' page happens to be a page that the
6556 ** caller is iterating through or using in some other way, this
6557 ** can be problematic.
6558 */
6559 rc = SQLITE_CORRUPT_BKPT;
6560 }else{
6561 rc = freePage2(pBt, pOvfl, ovflPgno);
6562 }
6563
danielk1977bea2a942009-01-20 17:06:27 +00006564 if( pOvfl ){
6565 sqlite3PagerUnref(pOvfl->pDbPage);
6566 }
drh3b7511c2001-05-26 13:15:44 +00006567 if( rc ) return rc;
danielk1977bea2a942009-01-20 17:06:27 +00006568 ovflPgno = iNext;
drh3b7511c2001-05-26 13:15:44 +00006569 }
drh5e2f8b92001-05-28 00:41:15 +00006570 return SQLITE_OK;
drh3b7511c2001-05-26 13:15:44 +00006571}
6572
drh86c779f2021-05-15 13:08:44 +00006573/* Call xParseCell to compute the size of a cell. If the cell contains
6574** overflow, then invoke cellClearOverflow to clear out that overflow.
6575** STore the result code (SQLITE_OK or some error code) in rc.
6576**
6577** Implemented as macro to force inlining for performance.
6578*/
6579#define BTREE_CLEAR_CELL(rc, pPage, pCell, sInfo) \
6580 pPage->xParseCell(pPage, pCell, &sInfo); \
6581 if( sInfo.nLocal!=sInfo.nPayload ){ \
6582 rc = clearCellOverflow(pPage, pCell, &sInfo); \
6583 }else{ \
6584 rc = SQLITE_OK; \
6585 }
6586
6587
drh3b7511c2001-05-26 13:15:44 +00006588/*
drh91025292004-05-03 19:49:32 +00006589** Create the byte sequence used to represent a cell on page pPage
6590** and write that byte sequence into pCell[]. Overflow pages are
6591** allocated and filled in as necessary. The calling procedure
6592** is responsible for making sure sufficient space has been allocated
6593** for pCell[].
6594**
6595** Note that pCell does not necessary need to point to the pPage->aData
6596** area. pCell might point to some temporary storage. The cell will
6597** be constructed in this temporary area then copied into pPage->aData
6598** later.
drh3b7511c2001-05-26 13:15:44 +00006599*/
6600static int fillInCell(
drh3aac2dd2004-04-26 14:10:20 +00006601 MemPage *pPage, /* The page that contains the cell */
drh4b70f112004-05-02 21:12:19 +00006602 unsigned char *pCell, /* Complete text of the cell */
drh8eeb4462016-05-21 20:03:42 +00006603 const BtreePayload *pX, /* Payload with which to construct the cell */
drh4b70f112004-05-02 21:12:19 +00006604 int *pnSize /* Write cell size here */
drh3b7511c2001-05-26 13:15:44 +00006605){
drh3b7511c2001-05-26 13:15:44 +00006606 int nPayload;
drh8c6fa9b2004-05-26 00:01:53 +00006607 const u8 *pSrc;
drh5e27e1d2017-08-23 14:45:59 +00006608 int nSrc, n, rc, mn;
drh3aac2dd2004-04-26 14:10:20 +00006609 int spaceLeft;
drh5e27e1d2017-08-23 14:45:59 +00006610 MemPage *pToRelease;
drh3aac2dd2004-04-26 14:10:20 +00006611 unsigned char *pPrior;
6612 unsigned char *pPayload;
drh5e27e1d2017-08-23 14:45:59 +00006613 BtShared *pBt;
6614 Pgno pgnoOvfl;
drh4b70f112004-05-02 21:12:19 +00006615 int nHeader;
drh3b7511c2001-05-26 13:15:44 +00006616
drh1fee73e2007-08-29 04:00:57 +00006617 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhd677b3d2007-08-20 22:48:41 +00006618
drhc5053fb2008-11-27 02:22:10 +00006619 /* pPage is not necessarily writeable since pCell might be auxiliary
6620 ** buffer space that is separate from the pPage buffer area */
drh5e27e1d2017-08-23 14:45:59 +00006621 assert( pCell<pPage->aData || pCell>=&pPage->aData[pPage->pBt->pageSize]
drhc5053fb2008-11-27 02:22:10 +00006622 || sqlite3PagerIswriteable(pPage->pDbPage) );
6623
drh91025292004-05-03 19:49:32 +00006624 /* Fill in the header. */
drh6200c882014-09-23 22:36:25 +00006625 nHeader = pPage->childPtrSize;
drhdfc2daa2016-05-21 23:25:29 +00006626 if( pPage->intKey ){
6627 nPayload = pX->nData + pX->nZero;
6628 pSrc = pX->pData;
6629 nSrc = pX->nData;
6630 assert( pPage->intKeyLeaf ); /* fillInCell() only called for leaves */
drh6200c882014-09-23 22:36:25 +00006631 nHeader += putVarint32(&pCell[nHeader], nPayload);
drhdfc2daa2016-05-21 23:25:29 +00006632 nHeader += putVarint(&pCell[nHeader], *(u64*)&pX->nKey);
drh6f11bef2004-05-13 01:12:56 +00006633 }else{
drh8eeb4462016-05-21 20:03:42 +00006634 assert( pX->nKey<=0x7fffffff && pX->pKey!=0 );
6635 nSrc = nPayload = (int)pX->nKey;
6636 pSrc = pX->pKey;
drhdfc2daa2016-05-21 23:25:29 +00006637 nHeader += putVarint32(&pCell[nHeader], nPayload);
drh3aac2dd2004-04-26 14:10:20 +00006638 }
drhdfc2daa2016-05-21 23:25:29 +00006639
6640 /* Fill in the payload */
drh5e27e1d2017-08-23 14:45:59 +00006641 pPayload = &pCell[nHeader];
drh6200c882014-09-23 22:36:25 +00006642 if( nPayload<=pPage->maxLocal ){
drh5e27e1d2017-08-23 14:45:59 +00006643 /* This is the common case where everything fits on the btree page
6644 ** and no overflow pages are required. */
drh6200c882014-09-23 22:36:25 +00006645 n = nHeader + nPayload;
6646 testcase( n==3 );
6647 testcase( n==4 );
6648 if( n<4 ) n = 4;
6649 *pnSize = n;
drh5e27e1d2017-08-23 14:45:59 +00006650 assert( nSrc<=nPayload );
6651 testcase( nSrc<nPayload );
6652 memcpy(pPayload, pSrc, nSrc);
6653 memset(pPayload+nSrc, 0, nPayload-nSrc);
6654 return SQLITE_OK;
drh6200c882014-09-23 22:36:25 +00006655 }
drh5e27e1d2017-08-23 14:45:59 +00006656
6657 /* If we reach this point, it means that some of the content will need
6658 ** to spill onto overflow pages.
6659 */
6660 mn = pPage->minLocal;
6661 n = mn + (nPayload - mn) % (pPage->pBt->usableSize - 4);
6662 testcase( n==pPage->maxLocal );
6663 testcase( n==pPage->maxLocal+1 );
6664 if( n > pPage->maxLocal ) n = mn;
6665 spaceLeft = n;
6666 *pnSize = n + nHeader + 4;
6667 pPrior = &pCell[nHeader+n];
6668 pToRelease = 0;
6669 pgnoOvfl = 0;
6670 pBt = pPage->pBt;
drh3b7511c2001-05-26 13:15:44 +00006671
drh6200c882014-09-23 22:36:25 +00006672 /* At this point variables should be set as follows:
6673 **
6674 ** nPayload Total payload size in bytes
6675 ** pPayload Begin writing payload here
6676 ** spaceLeft Space available at pPayload. If nPayload>spaceLeft,
6677 ** that means content must spill into overflow pages.
6678 ** *pnSize Size of the local cell (not counting overflow pages)
6679 ** pPrior Where to write the pgno of the first overflow page
6680 **
6681 ** Use a call to btreeParseCellPtr() to verify that the values above
6682 ** were computed correctly.
6683 */
drhd879e3e2017-02-13 13:35:55 +00006684#ifdef SQLITE_DEBUG
drh6200c882014-09-23 22:36:25 +00006685 {
6686 CellInfo info;
drh5fa60512015-06-19 17:19:34 +00006687 pPage->xParseCell(pPage, pCell, &info);
drhcc5f8a42016-02-06 22:32:06 +00006688 assert( nHeader==(int)(info.pPayload - pCell) );
drh8eeb4462016-05-21 20:03:42 +00006689 assert( info.nKey==pX->nKey );
drh6200c882014-09-23 22:36:25 +00006690 assert( *pnSize == info.nSize );
6691 assert( spaceLeft == info.nLocal );
drh6200c882014-09-23 22:36:25 +00006692 }
6693#endif
6694
6695 /* Write the payload into the local Cell and any extra into overflow pages */
drh5e27e1d2017-08-23 14:45:59 +00006696 while( 1 ){
6697 n = nPayload;
6698 if( n>spaceLeft ) n = spaceLeft;
6699
6700 /* If pToRelease is not zero than pPayload points into the data area
6701 ** of pToRelease. Make sure pToRelease is still writeable. */
6702 assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
6703
6704 /* If pPayload is part of the data area of pPage, then make sure pPage
6705 ** is still writeable */
6706 assert( pPayload<pPage->aData || pPayload>=&pPage->aData[pBt->pageSize]
6707 || sqlite3PagerIswriteable(pPage->pDbPage) );
6708
6709 if( nSrc>=n ){
6710 memcpy(pPayload, pSrc, n);
6711 }else if( nSrc>0 ){
6712 n = nSrc;
6713 memcpy(pPayload, pSrc, n);
6714 }else{
6715 memset(pPayload, 0, n);
6716 }
6717 nPayload -= n;
6718 if( nPayload<=0 ) break;
6719 pPayload += n;
6720 pSrc += n;
6721 nSrc -= n;
6722 spaceLeft -= n;
drh3b7511c2001-05-26 13:15:44 +00006723 if( spaceLeft==0 ){
drh5e27e1d2017-08-23 14:45:59 +00006724 MemPage *pOvfl = 0;
danielk1977afcdd022004-10-31 16:25:42 +00006725#ifndef SQLITE_OMIT_AUTOVACUUM
6726 Pgno pgnoPtrmap = pgnoOvfl; /* Overflow page pointer-map entry page */
danielk1977b39f70b2007-05-17 18:28:11 +00006727 if( pBt->autoVacuum ){
6728 do{
6729 pgnoOvfl++;
6730 } while(
6731 PTRMAP_ISPAGE(pBt, pgnoOvfl) || pgnoOvfl==PENDING_BYTE_PAGE(pBt)
6732 );
danielk1977b39f70b2007-05-17 18:28:11 +00006733 }
danielk1977afcdd022004-10-31 16:25:42 +00006734#endif
drhf49661a2008-12-10 16:45:50 +00006735 rc = allocateBtreePage(pBt, &pOvfl, &pgnoOvfl, pgnoOvfl, 0);
danielk1977afcdd022004-10-31 16:25:42 +00006736#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977a19df672004-11-03 11:37:07 +00006737 /* If the database supports auto-vacuum, and the second or subsequent
6738 ** overflow page is being allocated, add an entry to the pointer-map
danielk19774ef24492007-05-23 09:52:41 +00006739 ** for that page now.
6740 **
6741 ** If this is the first overflow page, then write a partial entry
6742 ** to the pointer-map. If we write nothing to this pointer-map slot,
6743 ** then the optimistic overflow chain processing in clearCell()
mistachkin48864df2013-03-21 21:20:32 +00006744 ** may misinterpret the uninitialized values and delete the
danielk19774ef24492007-05-23 09:52:41 +00006745 ** wrong pages from the database.
danielk1977afcdd022004-10-31 16:25:42 +00006746 */
danielk19774ef24492007-05-23 09:52:41 +00006747 if( pBt->autoVacuum && rc==SQLITE_OK ){
6748 u8 eType = (pgnoPtrmap?PTRMAP_OVERFLOW2:PTRMAP_OVERFLOW1);
drh98add2e2009-07-20 17:11:49 +00006749 ptrmapPut(pBt, pgnoOvfl, eType, pgnoPtrmap, &rc);
danielk197789a4be82007-05-23 13:34:32 +00006750 if( rc ){
6751 releasePage(pOvfl);
6752 }
danielk1977afcdd022004-10-31 16:25:42 +00006753 }
6754#endif
drh3b7511c2001-05-26 13:15:44 +00006755 if( rc ){
drh9b171272004-05-08 02:03:22 +00006756 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00006757 return rc;
6758 }
drhc5053fb2008-11-27 02:22:10 +00006759
6760 /* If pToRelease is not zero than pPrior points into the data area
6761 ** of pToRelease. Make sure pToRelease is still writeable. */
6762 assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
6763
6764 /* If pPrior is part of the data area of pPage, then make sure pPage
6765 ** is still writeable */
6766 assert( pPrior<pPage->aData || pPrior>=&pPage->aData[pBt->pageSize]
6767 || sqlite3PagerIswriteable(pPage->pDbPage) );
6768
drh3aac2dd2004-04-26 14:10:20 +00006769 put4byte(pPrior, pgnoOvfl);
drh9b171272004-05-08 02:03:22 +00006770 releasePage(pToRelease);
6771 pToRelease = pOvfl;
drh3aac2dd2004-04-26 14:10:20 +00006772 pPrior = pOvfl->aData;
6773 put4byte(pPrior, 0);
6774 pPayload = &pOvfl->aData[4];
drhb6f41482004-05-14 01:58:11 +00006775 spaceLeft = pBt->usableSize - 4;
drh3b7511c2001-05-26 13:15:44 +00006776 }
drhdd793422001-06-28 01:54:48 +00006777 }
drh9b171272004-05-08 02:03:22 +00006778 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00006779 return SQLITE_OK;
6780}
6781
drh14acc042001-06-10 19:56:58 +00006782/*
6783** Remove the i-th cell from pPage. This routine effects pPage only.
6784** The cell content is not freed or deallocated. It is assumed that
6785** the cell content has been copied someplace else. This routine just
6786** removes the reference to the cell from pPage.
6787**
6788** "sz" must be the number of bytes in the cell.
drh14acc042001-06-10 19:56:58 +00006789*/
drh98add2e2009-07-20 17:11:49 +00006790static void dropCell(MemPage *pPage, int idx, int sz, int *pRC){
drh43b18e12010-08-17 19:40:08 +00006791 u32 pc; /* Offset to cell content of cell being deleted */
drh43605152004-05-29 21:46:49 +00006792 u8 *data; /* pPage->aData */
6793 u8 *ptr; /* Used to move bytes around within data[] */
shanedcc50b72008-11-13 18:29:50 +00006794 int rc; /* The return code */
drhc314dc72009-07-21 11:52:34 +00006795 int hdr; /* Beginning of the header. 0 most pages. 100 page 1 */
drh43605152004-05-29 21:46:49 +00006796
drh98add2e2009-07-20 17:11:49 +00006797 if( *pRC ) return;
drh8c42ca92001-06-22 19:15:00 +00006798 assert( idx>=0 && idx<pPage->nCell );
dan0f8076d2015-05-25 18:47:26 +00006799 assert( CORRUPT_DB || sz==cellSize(pPage, idx) );
danielk19773b8a05f2007-03-19 17:44:26 +00006800 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh1fee73e2007-08-29 04:00:57 +00006801 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drhb0ea9432019-02-09 21:06:40 +00006802 assert( pPage->nFree>=0 );
drhda200cc2004-05-09 11:51:38 +00006803 data = pPage->aData;
drh3def2352011-11-11 00:27:15 +00006804 ptr = &pPage->aCellIdx[2*idx];
shane0af3f892008-11-12 04:55:34 +00006805 pc = get2byte(ptr);
drhc314dc72009-07-21 11:52:34 +00006806 hdr = pPage->hdrOffset;
6807 testcase( pc==get2byte(&data[hdr+5]) );
6808 testcase( pc+sz==pPage->pBt->usableSize );
drh5e398e42017-08-23 20:36:06 +00006809 if( pc+sz > pPage->pBt->usableSize ){
drh98add2e2009-07-20 17:11:49 +00006810 *pRC = SQLITE_CORRUPT_BKPT;
6811 return;
shane0af3f892008-11-12 04:55:34 +00006812 }
shanedcc50b72008-11-13 18:29:50 +00006813 rc = freeSpace(pPage, pc, sz);
drh98add2e2009-07-20 17:11:49 +00006814 if( rc ){
6815 *pRC = rc;
6816 return;
shanedcc50b72008-11-13 18:29:50 +00006817 }
drh14acc042001-06-10 19:56:58 +00006818 pPage->nCell--;
drhfdab0262014-11-20 15:30:50 +00006819 if( pPage->nCell==0 ){
6820 memset(&data[hdr+1], 0, 4);
6821 data[hdr+7] = 0;
6822 put2byte(&data[hdr+5], pPage->pBt->usableSize);
6823 pPage->nFree = pPage->pBt->usableSize - pPage->hdrOffset
6824 - pPage->childPtrSize - 8;
6825 }else{
6826 memmove(ptr, ptr+2, 2*(pPage->nCell - idx));
6827 put2byte(&data[hdr+3], pPage->nCell);
6828 pPage->nFree += 2;
6829 }
drh14acc042001-06-10 19:56:58 +00006830}
6831
6832/*
6833** Insert a new cell on pPage at cell index "i". pCell points to the
6834** content of the cell.
6835**
6836** If the cell content will fit on the page, then put it there. If it
drh43605152004-05-29 21:46:49 +00006837** will not fit, then make a copy of the cell content into pTemp if
6838** pTemp is not null. Regardless of pTemp, allocate a new entry
drh2cbd78b2012-02-02 19:37:18 +00006839** in pPage->apOvfl[] and make it point to the cell content (either
drh43605152004-05-29 21:46:49 +00006840** in pTemp or the original pCell) and also record its index.
6841** Allocating a new entry in pPage->aCell[] implies that
6842** pPage->nOverflow is incremented.
drhcb89f4a2016-05-21 11:23:26 +00006843**
6844** *pRC must be SQLITE_OK when this routine is called.
drh14acc042001-06-10 19:56:58 +00006845*/
drh98add2e2009-07-20 17:11:49 +00006846static void insertCell(
drh24cd67e2004-05-10 16:18:47 +00006847 MemPage *pPage, /* Page into which we are copying */
drh43605152004-05-29 21:46:49 +00006848 int i, /* New cell becomes the i-th cell of the page */
6849 u8 *pCell, /* Content of the new cell */
6850 int sz, /* Bytes of content in pCell */
danielk1977a3ad5e72005-01-07 08:56:44 +00006851 u8 *pTemp, /* Temp storage space for pCell, if needed */
drh98add2e2009-07-20 17:11:49 +00006852 Pgno iChild, /* If non-zero, replace first 4 bytes with this value */
6853 int *pRC /* Read and write return code from here */
drh24cd67e2004-05-10 16:18:47 +00006854){
drh383d30f2010-02-26 13:07:37 +00006855 int idx = 0; /* Where to write new cell content in data[] */
drh43605152004-05-29 21:46:49 +00006856 int j; /* Loop counter */
drh43605152004-05-29 21:46:49 +00006857 u8 *data; /* The content of the whole page */
drh2c8fb922015-06-25 19:53:48 +00006858 u8 *pIns; /* The point in pPage->aCellIdx[] where no cell inserted */
danielk19774dbaa892009-06-16 16:50:22 +00006859
drhcb89f4a2016-05-21 11:23:26 +00006860 assert( *pRC==SQLITE_OK );
drh43605152004-05-29 21:46:49 +00006861 assert( i>=0 && i<=pPage->nCell+pPage->nOverflow );
danf216e322014-08-14 19:53:37 +00006862 assert( MX_CELL(pPage->pBt)<=10921 );
6863 assert( pPage->nCell<=MX_CELL(pPage->pBt) || CORRUPT_DB );
drh2cbd78b2012-02-02 19:37:18 +00006864 assert( pPage->nOverflow<=ArraySize(pPage->apOvfl) );
6865 assert( ArraySize(pPage->apOvfl)==ArraySize(pPage->aiOvfl) );
drh1fee73e2007-08-29 04:00:57 +00006866 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
drh996f5cc2019-07-17 16:18:01 +00006867 assert( sz==pPage->xCellSize(pPage, pCell) || CORRUPT_DB );
drhb0ea9432019-02-09 21:06:40 +00006868 assert( pPage->nFree>=0 );
drh43605152004-05-29 21:46:49 +00006869 if( pPage->nOverflow || sz+2>pPage->nFree ){
drh24cd67e2004-05-10 16:18:47 +00006870 if( pTemp ){
drhd6176c42014-10-11 17:22:55 +00006871 memcpy(pTemp, pCell, sz);
drh43605152004-05-29 21:46:49 +00006872 pCell = pTemp;
drh24cd67e2004-05-10 16:18:47 +00006873 }
danielk19774dbaa892009-06-16 16:50:22 +00006874 if( iChild ){
6875 put4byte(pCell, iChild);
6876 }
drh43605152004-05-29 21:46:49 +00006877 j = pPage->nOverflow++;
drha2ee5892016-12-09 16:02:00 +00006878 /* Comparison against ArraySize-1 since we hold back one extra slot
6879 ** as a contingency. In other words, never need more than 3 overflow
6880 ** slots but 4 are allocated, just to be safe. */
6881 assert( j < ArraySize(pPage->apOvfl)-1 );
drh2cbd78b2012-02-02 19:37:18 +00006882 pPage->apOvfl[j] = pCell;
6883 pPage->aiOvfl[j] = (u16)i;
drhfe647dc2015-06-23 18:24:25 +00006884
6885 /* When multiple overflows occur, they are always sequential and in
6886 ** sorted order. This invariants arise because multiple overflows can
6887 ** only occur when inserting divider cells into the parent page during
6888 ** balancing, and the dividers are adjacent and sorted.
6889 */
6890 assert( j==0 || pPage->aiOvfl[j-1]<(u16)i ); /* Overflows in sorted order */
6891 assert( j==0 || i==pPage->aiOvfl[j-1]+1 ); /* Overflows are sequential */
drh14acc042001-06-10 19:56:58 +00006892 }else{
danielk19776e465eb2007-08-21 13:11:00 +00006893 int rc = sqlite3PagerWrite(pPage->pDbPage);
6894 if( rc!=SQLITE_OK ){
drh98add2e2009-07-20 17:11:49 +00006895 *pRC = rc;
6896 return;
danielk19776e465eb2007-08-21 13:11:00 +00006897 }
6898 assert( sqlite3PagerIswriteable(pPage->pDbPage) );
drh43605152004-05-29 21:46:49 +00006899 data = pPage->aData;
drh2c8fb922015-06-25 19:53:48 +00006900 assert( &data[pPage->cellOffset]==pPage->aCellIdx );
drh0a45c272009-07-08 01:49:11 +00006901 rc = allocateSpace(pPage, sz, &idx);
drh98add2e2009-07-20 17:11:49 +00006902 if( rc ){ *pRC = rc; return; }
drhcd8fb7c2015-06-02 14:02:18 +00006903 /* The allocateSpace() routine guarantees the following properties
6904 ** if it returns successfully */
drh2c8fb922015-06-25 19:53:48 +00006905 assert( idx >= 0 );
6906 assert( idx >= pPage->cellOffset+2*pPage->nCell+2 || CORRUPT_DB );
drhfcd71b62011-04-05 22:08:24 +00006907 assert( idx+sz <= (int)pPage->pBt->usableSize );
drh0a45c272009-07-08 01:49:11 +00006908 pPage->nFree -= (u16)(2 + sz);
danielk19774dbaa892009-06-16 16:50:22 +00006909 if( iChild ){
drhd12db3d2019-01-14 05:48:10 +00006910 /* In a corrupt database where an entry in the cell index section of
6911 ** a btree page has a value of 3 or less, the pCell value might point
6912 ** as many as 4 bytes in front of the start of the aData buffer for
6913 ** the source page. Make sure this does not cause problems by not
6914 ** reading the first 4 bytes */
6915 memcpy(&data[idx+4], pCell+4, sz-4);
danielk19774dbaa892009-06-16 16:50:22 +00006916 put4byte(&data[idx], iChild);
drhd12db3d2019-01-14 05:48:10 +00006917 }else{
6918 memcpy(&data[idx], pCell, sz);
danielk19774dbaa892009-06-16 16:50:22 +00006919 }
drh2c8fb922015-06-25 19:53:48 +00006920 pIns = pPage->aCellIdx + i*2;
6921 memmove(pIns+2, pIns, 2*(pPage->nCell - i));
6922 put2byte(pIns, idx);
6923 pPage->nCell++;
6924 /* increment the cell count */
6925 if( (++data[pPage->hdrOffset+4])==0 ) data[pPage->hdrOffset+3]++;
drh56785a02019-02-16 22:45:55 +00006926 assert( get2byte(&data[pPage->hdrOffset+3])==pPage->nCell || CORRUPT_DB );
danielk1977a19df672004-11-03 11:37:07 +00006927#ifndef SQLITE_OMIT_AUTOVACUUM
6928 if( pPage->pBt->autoVacuum ){
6929 /* The cell may contain a pointer to an overflow page. If so, write
6930 ** the entry for the overflow page into the pointer map.
6931 */
drh0f1bf4c2019-01-13 20:17:21 +00006932 ptrmapPutOvflPtr(pPage, pPage, pCell, pRC);
danielk1977a19df672004-11-03 11:37:07 +00006933 }
6934#endif
drh14acc042001-06-10 19:56:58 +00006935 }
6936}
6937
6938/*
drhe3dadac2019-01-23 19:25:59 +00006939** The following parameters determine how many adjacent pages get involved
6940** in a balancing operation. NN is the number of neighbors on either side
6941** of the page that participate in the balancing operation. NB is the
6942** total number of pages that participate, including the target page and
6943** NN neighbors on either side.
6944**
6945** The minimum value of NN is 1 (of course). Increasing NN above 1
6946** (to 2 or 3) gives a modest improvement in SELECT and DELETE performance
6947** in exchange for a larger degradation in INSERT and UPDATE performance.
6948** The value of NN appears to give the best results overall.
6949**
6950** (Later:) The description above makes it seem as if these values are
6951** tunable - as if you could change them and recompile and it would all work.
6952** But that is unlikely. NB has been 3 since the inception of SQLite and
6953** we have never tested any other value.
6954*/
6955#define NN 1 /* Number of neighbors on either side of pPage */
6956#define NB 3 /* (NN*2+1): Total pages involved in the balance */
6957
6958/*
drh1ffd2472015-06-23 02:37:30 +00006959** A CellArray object contains a cache of pointers and sizes for a
drhc0d269e2016-08-03 14:51:16 +00006960** consecutive sequence of cells that might be held on multiple pages.
drhe3dadac2019-01-23 19:25:59 +00006961**
6962** The cells in this array are the divider cell or cells from the pParent
6963** page plus up to three child pages. There are a total of nCell cells.
6964**
6965** pRef is a pointer to one of the pages that contributes cells. This is
6966** used to access information such as MemPage.intKey and MemPage.pBt->pageSize
6967** which should be common to all pages that contribute cells to this array.
6968**
6969** apCell[] and szCell[] hold, respectively, pointers to the start of each
6970** cell and the size of each cell. Some of the apCell[] pointers might refer
6971** to overflow cells. In other words, some apCel[] pointers might not point
6972** to content area of the pages.
6973**
6974** A szCell[] of zero means the size of that cell has not yet been computed.
6975**
6976** The cells come from as many as four different pages:
6977**
6978** -----------
6979** | Parent |
6980** -----------
6981** / | \
6982** / | \
6983** --------- --------- ---------
6984** |Child-1| |Child-2| |Child-3|
6985** --------- --------- ---------
6986**
drh26b7ec82019-02-01 14:50:43 +00006987** The order of cells is in the array is for an index btree is:
drhe3dadac2019-01-23 19:25:59 +00006988**
6989** 1. All cells from Child-1 in order
6990** 2. The first divider cell from Parent
6991** 3. All cells from Child-2 in order
6992** 4. The second divider cell from Parent
6993** 5. All cells from Child-3 in order
6994**
drh26b7ec82019-02-01 14:50:43 +00006995** For a table-btree (with rowids) the items 2 and 4 are empty because
6996** content exists only in leaves and there are no divider cells.
6997**
6998** For an index btree, the apEnd[] array holds pointer to the end of page
6999** for Child-1, the Parent, Child-2, the Parent (again), and Child-3,
7000** respectively. The ixNx[] array holds the number of cells contained in
7001** each of these 5 stages, and all stages to the left. Hence:
7002**
drhe3dadac2019-01-23 19:25:59 +00007003** ixNx[0] = Number of cells in Child-1.
7004** ixNx[1] = Number of cells in Child-1 plus 1 for first divider.
7005** ixNx[2] = Number of cells in Child-1 and Child-2 + 1 for 1st divider.
7006** ixNx[3] = Number of cells in Child-1 and Child-2 + both divider cells
7007** ixNx[4] = Total number of cells.
drh26b7ec82019-02-01 14:50:43 +00007008**
7009** For a table-btree, the concept is similar, except only apEnd[0]..apEnd[2]
7010** are used and they point to the leaf pages only, and the ixNx value are:
7011**
7012** ixNx[0] = Number of cells in Child-1.
drh9c7e44c2019-02-14 15:27:12 +00007013** ixNx[1] = Number of cells in Child-1 and Child-2.
7014** ixNx[2] = Total number of cells.
7015**
7016** Sometimes when deleting, a child page can have zero cells. In those
7017** cases, ixNx[] entries with higher indexes, and the corresponding apEnd[]
7018** entries, shift down. The end result is that each ixNx[] entry should
7019** be larger than the previous
drhfa1a98a2004-05-14 19:08:17 +00007020*/
drh1ffd2472015-06-23 02:37:30 +00007021typedef struct CellArray CellArray;
7022struct CellArray {
7023 int nCell; /* Number of cells in apCell[] */
7024 MemPage *pRef; /* Reference page */
7025 u8 **apCell; /* All cells begin balanced */
7026 u16 *szCell; /* Local size of all cells in apCell[] */
drhe3dadac2019-01-23 19:25:59 +00007027 u8 *apEnd[NB*2]; /* MemPage.aDataEnd values */
7028 int ixNx[NB*2]; /* Index of at which we move to the next apEnd[] */
drh1ffd2472015-06-23 02:37:30 +00007029};
drhfa1a98a2004-05-14 19:08:17 +00007030
drh1ffd2472015-06-23 02:37:30 +00007031/*
7032** Make sure the cell sizes at idx, idx+1, ..., idx+N-1 have been
7033** computed.
7034*/
7035static void populateCellCache(CellArray *p, int idx, int N){
7036 assert( idx>=0 && idx+N<=p->nCell );
7037 while( N>0 ){
7038 assert( p->apCell[idx]!=0 );
7039 if( p->szCell[idx]==0 ){
7040 p->szCell[idx] = p->pRef->xCellSize(p->pRef, p->apCell[idx]);
7041 }else{
7042 assert( CORRUPT_DB ||
7043 p->szCell[idx]==p->pRef->xCellSize(p->pRef, p->apCell[idx]) );
7044 }
7045 idx++;
7046 N--;
drhfa1a98a2004-05-14 19:08:17 +00007047 }
drh1ffd2472015-06-23 02:37:30 +00007048}
7049
7050/*
7051** Return the size of the Nth element of the cell array
7052*/
7053static SQLITE_NOINLINE u16 computeCellSize(CellArray *p, int N){
7054 assert( N>=0 && N<p->nCell );
7055 assert( p->szCell[N]==0 );
7056 p->szCell[N] = p->pRef->xCellSize(p->pRef, p->apCell[N]);
7057 return p->szCell[N];
7058}
7059static u16 cachedCellSize(CellArray *p, int N){
7060 assert( N>=0 && N<p->nCell );
7061 if( p->szCell[N] ) return p->szCell[N];
7062 return computeCellSize(p, N);
7063}
7064
7065/*
dan8e9ba0c2014-10-14 17:27:04 +00007066** Array apCell[] contains pointers to nCell b-tree page cells. The
7067** szCell[] array contains the size in bytes of each cell. This function
7068** replaces the current contents of page pPg with the contents of the cell
7069** array.
7070**
7071** Some of the cells in apCell[] may currently be stored in pPg. This
7072** function works around problems caused by this by making a copy of any
7073** such cells before overwriting the page data.
7074**
7075** The MemPage.nFree field is invalidated by this function. It is the
7076** responsibility of the caller to set it correctly.
drhfa1a98a2004-05-14 19:08:17 +00007077*/
drh658873b2015-06-22 20:02:04 +00007078static int rebuildPage(
drhe3dadac2019-01-23 19:25:59 +00007079 CellArray *pCArray, /* Content to be added to page pPg */
7080 int iFirst, /* First cell in pCArray to use */
dan33ea4862014-10-09 19:35:37 +00007081 int nCell, /* Final number of cells on page */
drhe3dadac2019-01-23 19:25:59 +00007082 MemPage *pPg /* The page to be reconstructed */
dan33ea4862014-10-09 19:35:37 +00007083){
7084 const int hdr = pPg->hdrOffset; /* Offset of header on pPg */
7085 u8 * const aData = pPg->aData; /* Pointer to data for pPg */
7086 const int usableSize = pPg->pBt->usableSize;
7087 u8 * const pEnd = &aData[usableSize];
drhe3dadac2019-01-23 19:25:59 +00007088 int i = iFirst; /* Which cell to copy from pCArray*/
drha0466432019-01-29 16:41:13 +00007089 u32 j; /* Start of cell content area */
drhe3dadac2019-01-23 19:25:59 +00007090 int iEnd = i+nCell; /* Loop terminator */
dan33ea4862014-10-09 19:35:37 +00007091 u8 *pCellptr = pPg->aCellIdx;
7092 u8 *pTmp = sqlite3PagerTempSpace(pPg->pBt->pPager);
7093 u8 *pData;
drhe3dadac2019-01-23 19:25:59 +00007094 int k; /* Current slot in pCArray->apEnd[] */
7095 u8 *pSrcEnd; /* Current pCArray->apEnd[k] value */
dan33ea4862014-10-09 19:35:37 +00007096
drhe3dadac2019-01-23 19:25:59 +00007097 assert( i<iEnd );
7098 j = get2byte(&aData[hdr+5]);
drh3b76c452020-01-03 17:40:30 +00007099 if( NEVER(j>(u32)usableSize) ){ j = 0; }
drhe3dadac2019-01-23 19:25:59 +00007100 memcpy(&pTmp[j], &aData[j], usableSize - j);
7101
7102 for(k=0; pCArray->ixNx[k]<=i && ALWAYS(k<NB*2); k++){}
7103 pSrcEnd = pCArray->apEnd[k];
dan33ea4862014-10-09 19:35:37 +00007104
dan8e9ba0c2014-10-14 17:27:04 +00007105 pData = pEnd;
drhe3dadac2019-01-23 19:25:59 +00007106 while( 1/*exit by break*/ ){
7107 u8 *pCell = pCArray->apCell[i];
7108 u16 sz = pCArray->szCell[i];
7109 assert( sz>0 );
drh8cae5a42021-04-20 20:48:15 +00007110 if( SQLITE_WITHIN(pCell,aData+j,pEnd) ){
drhb2b61bb2020-01-04 14:50:06 +00007111 if( ((uptr)(pCell+sz))>(uptr)pEnd ) return SQLITE_CORRUPT_BKPT;
dan33ea4862014-10-09 19:35:37 +00007112 pCell = &pTmp[pCell - aData];
drhe3dadac2019-01-23 19:25:59 +00007113 }else if( (uptr)(pCell+sz)>(uptr)pSrcEnd
7114 && (uptr)(pCell)<(uptr)pSrcEnd
7115 ){
7116 return SQLITE_CORRUPT_BKPT;
dan33ea4862014-10-09 19:35:37 +00007117 }
drhe3dadac2019-01-23 19:25:59 +00007118
7119 pData -= sz;
dan33ea4862014-10-09 19:35:37 +00007120 put2byte(pCellptr, (pData - aData));
7121 pCellptr += 2;
drhe5cf3e92020-01-04 12:34:44 +00007122 if( pData < pCellptr ) return SQLITE_CORRUPT_BKPT;
drheca3c672021-04-22 20:01:02 +00007123 memmove(pData, pCell, sz);
drhe5cf3e92020-01-04 12:34:44 +00007124 assert( sz==pPg->xCellSize(pPg, pCell) || CORRUPT_DB );
drhe3dadac2019-01-23 19:25:59 +00007125 i++;
7126 if( i>=iEnd ) break;
7127 if( pCArray->ixNx[k]<=i ){
7128 k++;
7129 pSrcEnd = pCArray->apEnd[k];
7130 }
dan33ea4862014-10-09 19:35:37 +00007131 }
7132
dand7b545b2014-10-13 18:03:27 +00007133 /* The pPg->nFree field is now set incorrectly. The caller will fix it. */
dan33ea4862014-10-09 19:35:37 +00007134 pPg->nCell = nCell;
7135 pPg->nOverflow = 0;
7136
7137 put2byte(&aData[hdr+1], 0);
7138 put2byte(&aData[hdr+3], pPg->nCell);
7139 put2byte(&aData[hdr+5], pData - aData);
7140 aData[hdr+7] = 0x00;
drh658873b2015-06-22 20:02:04 +00007141 return SQLITE_OK;
dan33ea4862014-10-09 19:35:37 +00007142}
7143
dan8e9ba0c2014-10-14 17:27:04 +00007144/*
drhe3dadac2019-01-23 19:25:59 +00007145** The pCArray objects contains pointers to b-tree cells and the cell sizes.
7146** This function attempts to add the cells stored in the array to page pPg.
7147** If it cannot (because the page needs to be defragmented before the cells
7148** will fit), non-zero is returned. Otherwise, if the cells are added
7149** successfully, zero is returned.
dan8e9ba0c2014-10-14 17:27:04 +00007150**
7151** Argument pCellptr points to the first entry in the cell-pointer array
7152** (part of page pPg) to populate. After cell apCell[0] is written to the
7153** page body, a 16-bit offset is written to pCellptr. And so on, for each
7154** cell in the array. It is the responsibility of the caller to ensure
7155** that it is safe to overwrite this part of the cell-pointer array.
7156**
7157** When this function is called, *ppData points to the start of the
7158** content area on page pPg. If the size of the content area is extended,
7159** *ppData is updated to point to the new start of the content area
7160** before returning.
7161**
7162** Finally, argument pBegin points to the byte immediately following the
7163** end of the space required by this page for the cell-pointer area (for
7164** all cells - not just those inserted by the current call). If the content
7165** area must be extended to before this point in order to accomodate all
7166** cells in apCell[], then the cells do not fit and non-zero is returned.
7167*/
dand7b545b2014-10-13 18:03:27 +00007168static int pageInsertArray(
dan8e9ba0c2014-10-14 17:27:04 +00007169 MemPage *pPg, /* Page to add cells to */
7170 u8 *pBegin, /* End of cell-pointer array */
drhe3dadac2019-01-23 19:25:59 +00007171 u8 **ppData, /* IN/OUT: Page content-area pointer */
dan8e9ba0c2014-10-14 17:27:04 +00007172 u8 *pCellptr, /* Pointer to cell-pointer area */
drhf7838932015-06-23 15:36:34 +00007173 int iFirst, /* Index of first cell to add */
dan8e9ba0c2014-10-14 17:27:04 +00007174 int nCell, /* Number of cells to add to pPg */
drhf7838932015-06-23 15:36:34 +00007175 CellArray *pCArray /* Array of cells */
dand7b545b2014-10-13 18:03:27 +00007176){
drhe3dadac2019-01-23 19:25:59 +00007177 int i = iFirst; /* Loop counter - cell index to insert */
7178 u8 *aData = pPg->aData; /* Complete page */
7179 u8 *pData = *ppData; /* Content area. A subset of aData[] */
7180 int iEnd = iFirst + nCell; /* End of loop. One past last cell to ins */
7181 int k; /* Current slot in pCArray->apEnd[] */
7182 u8 *pEnd; /* Maximum extent of cell data */
dan23eba452014-10-24 18:43:57 +00007183 assert( CORRUPT_DB || pPg->hdrOffset==0 ); /* Never called on page 1 */
drhe3dadac2019-01-23 19:25:59 +00007184 if( iEnd<=iFirst ) return 0;
7185 for(k=0; pCArray->ixNx[k]<=i && ALWAYS(k<NB*2); k++){}
7186 pEnd = pCArray->apEnd[k];
7187 while( 1 /*Exit by break*/ ){
drhf7838932015-06-23 15:36:34 +00007188 int sz, rc;
dand7b545b2014-10-13 18:03:27 +00007189 u8 *pSlot;
dan666a42f2019-08-24 21:02:47 +00007190 assert( pCArray->szCell[i]!=0 );
7191 sz = pCArray->szCell[i];
drhb7580e82015-06-25 18:36:13 +00007192 if( (aData[1]==0 && aData[2]==0) || (pSlot = pageFindSlot(pPg,sz,&rc))==0 ){
drhcca66982016-04-05 13:19:19 +00007193 if( (pData - pBegin)<sz ) return 1;
dand7b545b2014-10-13 18:03:27 +00007194 pData -= sz;
dand7b545b2014-10-13 18:03:27 +00007195 pSlot = pData;
7196 }
drh48310f82015-10-10 16:41:28 +00007197 /* pSlot and pCArray->apCell[i] will never overlap on a well-formed
7198 ** database. But they might for a corrupt database. Hence use memmove()
7199 ** since memcpy() sends SIGABORT with overlapping buffers on OpenBSD */
7200 assert( (pSlot+sz)<=pCArray->apCell[i]
7201 || pSlot>=(pCArray->apCell[i]+sz)
7202 || CORRUPT_DB );
drhe3dadac2019-01-23 19:25:59 +00007203 if( (uptr)(pCArray->apCell[i]+sz)>(uptr)pEnd
7204 && (uptr)(pCArray->apCell[i])<(uptr)pEnd
7205 ){
7206 assert( CORRUPT_DB );
7207 (void)SQLITE_CORRUPT_BKPT;
7208 return 1;
7209 }
drh48310f82015-10-10 16:41:28 +00007210 memmove(pSlot, pCArray->apCell[i], sz);
dand7b545b2014-10-13 18:03:27 +00007211 put2byte(pCellptr, (pSlot - aData));
7212 pCellptr += 2;
drhe3dadac2019-01-23 19:25:59 +00007213 i++;
7214 if( i>=iEnd ) break;
7215 if( pCArray->ixNx[k]<=i ){
7216 k++;
7217 pEnd = pCArray->apEnd[k];
7218 }
dand7b545b2014-10-13 18:03:27 +00007219 }
7220 *ppData = pData;
7221 return 0;
7222}
7223
dan8e9ba0c2014-10-14 17:27:04 +00007224/*
drhe3dadac2019-01-23 19:25:59 +00007225** The pCArray object contains pointers to b-tree cells and their sizes.
7226**
7227** This function adds the space associated with each cell in the array
7228** that is currently stored within the body of pPg to the pPg free-list.
7229** The cell-pointers and other fields of the page are not updated.
dan8e9ba0c2014-10-14 17:27:04 +00007230**
7231** This function returns the total number of cells added to the free-list.
7232*/
dand7b545b2014-10-13 18:03:27 +00007233static int pageFreeArray(
7234 MemPage *pPg, /* Page to edit */
drhf7838932015-06-23 15:36:34 +00007235 int iFirst, /* First cell to delete */
dand7b545b2014-10-13 18:03:27 +00007236 int nCell, /* Cells to delete */
drhf7838932015-06-23 15:36:34 +00007237 CellArray *pCArray /* Array of cells */
dand7b545b2014-10-13 18:03:27 +00007238){
7239 u8 * const aData = pPg->aData;
7240 u8 * const pEnd = &aData[pPg->pBt->usableSize];
dan89ca0b32014-10-25 20:36:28 +00007241 u8 * const pStart = &aData[pPg->hdrOffset + 8 + pPg->childPtrSize];
dand7b545b2014-10-13 18:03:27 +00007242 int nRet = 0;
7243 int i;
drhf7838932015-06-23 15:36:34 +00007244 int iEnd = iFirst + nCell;
dand7b545b2014-10-13 18:03:27 +00007245 u8 *pFree = 0;
7246 int szFree = 0;
7247
drhf7838932015-06-23 15:36:34 +00007248 for(i=iFirst; i<iEnd; i++){
7249 u8 *pCell = pCArray->apCell[i];
drh8b0ba7b2015-12-16 13:07:35 +00007250 if( SQLITE_WITHIN(pCell, pStart, pEnd) ){
drhf7838932015-06-23 15:36:34 +00007251 int sz;
7252 /* No need to use cachedCellSize() here. The sizes of all cells that
7253 ** are to be freed have already been computing while deciding which
7254 ** cells need freeing */
7255 sz = pCArray->szCell[i]; assert( sz>0 );
dand7b545b2014-10-13 18:03:27 +00007256 if( pFree!=(pCell + sz) ){
drhfefa0942014-11-05 21:21:08 +00007257 if( pFree ){
7258 assert( pFree>aData && (pFree - aData)<65536 );
7259 freeSpace(pPg, (u16)(pFree - aData), szFree);
7260 }
dand7b545b2014-10-13 18:03:27 +00007261 pFree = pCell;
7262 szFree = sz;
drhccb897c2021-05-11 10:47:41 +00007263 if( pFree+sz>pEnd ){
7264 return 0;
drhc3c23f32021-05-06 11:02:55 +00007265 }
dand7b545b2014-10-13 18:03:27 +00007266 }else{
7267 pFree = pCell;
7268 szFree += sz;
7269 }
7270 nRet++;
7271 }
7272 }
drhfefa0942014-11-05 21:21:08 +00007273 if( pFree ){
7274 assert( pFree>aData && (pFree - aData)<65536 );
7275 freeSpace(pPg, (u16)(pFree - aData), szFree);
7276 }
dand7b545b2014-10-13 18:03:27 +00007277 return nRet;
7278}
7279
dand7b545b2014-10-13 18:03:27 +00007280/*
drha0466432019-01-29 16:41:13 +00007281** pCArray contains pointers to and sizes of all cells in the page being
drhe3dadac2019-01-23 19:25:59 +00007282** balanced. The current page, pPg, has pPg->nCell cells starting with
7283** pCArray->apCell[iOld]. After balancing, this page should hold nNew cells
drh5ab63772014-11-27 03:46:04 +00007284** starting at apCell[iNew].
7285**
7286** This routine makes the necessary adjustments to pPg so that it contains
7287** the correct cells after being balanced.
7288**
dand7b545b2014-10-13 18:03:27 +00007289** The pPg->nFree field is invalid when this function returns. It is the
7290** responsibility of the caller to set it correctly.
7291*/
drh658873b2015-06-22 20:02:04 +00007292static int editPage(
dan09c68402014-10-11 20:00:24 +00007293 MemPage *pPg, /* Edit this page */
7294 int iOld, /* Index of first cell currently on page */
7295 int iNew, /* Index of new first cell on page */
7296 int nNew, /* Final number of cells on page */
drh1ffd2472015-06-23 02:37:30 +00007297 CellArray *pCArray /* Array of cells and sizes */
dan09c68402014-10-11 20:00:24 +00007298){
dand7b545b2014-10-13 18:03:27 +00007299 u8 * const aData = pPg->aData;
7300 const int hdr = pPg->hdrOffset;
7301 u8 *pBegin = &pPg->aCellIdx[nNew * 2];
7302 int nCell = pPg->nCell; /* Cells stored on pPg */
7303 u8 *pData;
7304 u8 *pCellptr;
7305 int i;
7306 int iOldEnd = iOld + pPg->nCell + pPg->nOverflow;
7307 int iNewEnd = iNew + nNew;
dan09c68402014-10-11 20:00:24 +00007308
7309#ifdef SQLITE_DEBUG
dand7b545b2014-10-13 18:03:27 +00007310 u8 *pTmp = sqlite3PagerTempSpace(pPg->pBt->pPager);
7311 memcpy(pTmp, aData, pPg->pBt->usableSize);
dan09c68402014-10-11 20:00:24 +00007312#endif
7313
dand7b545b2014-10-13 18:03:27 +00007314 /* Remove cells from the start and end of the page */
drha0466432019-01-29 16:41:13 +00007315 assert( nCell>=0 );
dand7b545b2014-10-13 18:03:27 +00007316 if( iOld<iNew ){
drhf7838932015-06-23 15:36:34 +00007317 int nShift = pageFreeArray(pPg, iOld, iNew-iOld, pCArray);
drhfde25922020-05-05 19:54:02 +00007318 if( NEVER(nShift>nCell) ) return SQLITE_CORRUPT_BKPT;
dand7b545b2014-10-13 18:03:27 +00007319 memmove(pPg->aCellIdx, &pPg->aCellIdx[nShift*2], nCell*2);
7320 nCell -= nShift;
7321 }
7322 if( iNewEnd < iOldEnd ){
drha0466432019-01-29 16:41:13 +00007323 int nTail = pageFreeArray(pPg, iNewEnd, iOldEnd - iNewEnd, pCArray);
7324 assert( nCell>=nTail );
7325 nCell -= nTail;
dand7b545b2014-10-13 18:03:27 +00007326 }
dan09c68402014-10-11 20:00:24 +00007327
drh5ab63772014-11-27 03:46:04 +00007328 pData = &aData[get2byteNotZero(&aData[hdr+5])];
dand7b545b2014-10-13 18:03:27 +00007329 if( pData<pBegin ) goto editpage_fail;
7330
7331 /* Add cells to the start of the page */
7332 if( iNew<iOld ){
drh5ab63772014-11-27 03:46:04 +00007333 int nAdd = MIN(nNew,iOld-iNew);
7334 assert( (iOld-iNew)<nNew || nCell==0 || CORRUPT_DB );
drha0466432019-01-29 16:41:13 +00007335 assert( nAdd>=0 );
dand7b545b2014-10-13 18:03:27 +00007336 pCellptr = pPg->aCellIdx;
7337 memmove(&pCellptr[nAdd*2], pCellptr, nCell*2);
7338 if( pageInsertArray(
7339 pPg, pBegin, &pData, pCellptr,
drhf7838932015-06-23 15:36:34 +00007340 iNew, nAdd, pCArray
dand7b545b2014-10-13 18:03:27 +00007341 ) ) goto editpage_fail;
7342 nCell += nAdd;
7343 }
7344
7345 /* Add any overflow cells */
7346 for(i=0; i<pPg->nOverflow; i++){
7347 int iCell = (iOld + pPg->aiOvfl[i]) - iNew;
7348 if( iCell>=0 && iCell<nNew ){
drhfefa0942014-11-05 21:21:08 +00007349 pCellptr = &pPg->aCellIdx[iCell * 2];
drh4b986b22019-03-08 14:02:11 +00007350 if( nCell>iCell ){
7351 memmove(&pCellptr[2], pCellptr, (nCell - iCell) * 2);
7352 }
dand7b545b2014-10-13 18:03:27 +00007353 nCell++;
dan666a42f2019-08-24 21:02:47 +00007354 cachedCellSize(pCArray, iCell+iNew);
dand7b545b2014-10-13 18:03:27 +00007355 if( pageInsertArray(
7356 pPg, pBegin, &pData, pCellptr,
drhf7838932015-06-23 15:36:34 +00007357 iCell+iNew, 1, pCArray
dand7b545b2014-10-13 18:03:27 +00007358 ) ) goto editpage_fail;
dan09c68402014-10-11 20:00:24 +00007359 }
dand7b545b2014-10-13 18:03:27 +00007360 }
dan09c68402014-10-11 20:00:24 +00007361
dand7b545b2014-10-13 18:03:27 +00007362 /* Append cells to the end of the page */
drha0466432019-01-29 16:41:13 +00007363 assert( nCell>=0 );
dand7b545b2014-10-13 18:03:27 +00007364 pCellptr = &pPg->aCellIdx[nCell*2];
7365 if( pageInsertArray(
7366 pPg, pBegin, &pData, pCellptr,
drhf7838932015-06-23 15:36:34 +00007367 iNew+nCell, nNew-nCell, pCArray
dand7b545b2014-10-13 18:03:27 +00007368 ) ) goto editpage_fail;
dan09c68402014-10-11 20:00:24 +00007369
dand7b545b2014-10-13 18:03:27 +00007370 pPg->nCell = nNew;
7371 pPg->nOverflow = 0;
dan09c68402014-10-11 20:00:24 +00007372
dand7b545b2014-10-13 18:03:27 +00007373 put2byte(&aData[hdr+3], pPg->nCell);
7374 put2byte(&aData[hdr+5], pData - aData);
dan09c68402014-10-11 20:00:24 +00007375
7376#ifdef SQLITE_DEBUG
dan23eba452014-10-24 18:43:57 +00007377 for(i=0; i<nNew && !CORRUPT_DB; i++){
drh1ffd2472015-06-23 02:37:30 +00007378 u8 *pCell = pCArray->apCell[i+iNew];
drh329428e2015-06-30 13:28:18 +00007379 int iOff = get2byteAligned(&pPg->aCellIdx[i*2]);
drh1c715f62016-04-05 13:35:43 +00007380 if( SQLITE_WITHIN(pCell, aData, &aData[pPg->pBt->usableSize]) ){
dand7b545b2014-10-13 18:03:27 +00007381 pCell = &pTmp[pCell - aData];
dan09c68402014-10-11 20:00:24 +00007382 }
drh1ffd2472015-06-23 02:37:30 +00007383 assert( 0==memcmp(pCell, &aData[iOff],
7384 pCArray->pRef->xCellSize(pCArray->pRef, pCArray->apCell[i+iNew])) );
dand7b545b2014-10-13 18:03:27 +00007385 }
dan09c68402014-10-11 20:00:24 +00007386#endif
7387
drh658873b2015-06-22 20:02:04 +00007388 return SQLITE_OK;
dan09c68402014-10-11 20:00:24 +00007389 editpage_fail:
dan09c68402014-10-11 20:00:24 +00007390 /* Unable to edit this page. Rebuild it from scratch instead. */
drh1ffd2472015-06-23 02:37:30 +00007391 populateCellCache(pCArray, iNew, nNew);
drhe3dadac2019-01-23 19:25:59 +00007392 return rebuildPage(pCArray, iNew, nNew, pPg);
drhfa1a98a2004-05-14 19:08:17 +00007393}
7394
danielk1977ac245ec2005-01-14 13:50:11 +00007395
drh615ae552005-01-16 23:21:00 +00007396#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00007397/*
7398** This version of balance() handles the common special case where
7399** a new entry is being inserted on the extreme right-end of the
7400** tree, in other words, when the new entry will become the largest
7401** entry in the tree.
7402**
drhc314dc72009-07-21 11:52:34 +00007403** Instead of trying to balance the 3 right-most leaf pages, just add
drhf222e712005-01-14 22:55:49 +00007404** a new page to the right-hand side and put the one new entry in
7405** that page. This leaves the right side of the tree somewhat
7406** unbalanced. But odds are that we will be inserting new entries
7407** at the end soon afterwards so the nearly empty page will quickly
7408** fill up. On average.
7409**
7410** pPage is the leaf page which is the right-most page in the tree.
7411** pParent is its parent. pPage must have a single overflow entry
7412** which is also the right-most entry on the page.
danielk1977a50d9aa2009-06-08 14:49:45 +00007413**
7414** The pSpace buffer is used to store a temporary copy of the divider
7415** cell that will be inserted into pParent. Such a cell consists of a 4
7416** byte page number followed by a variable length integer. In other
7417** words, at most 13 bytes. Hence the pSpace buffer must be at
7418** least 13 bytes in size.
drhf222e712005-01-14 22:55:49 +00007419*/
danielk1977a50d9aa2009-06-08 14:49:45 +00007420static int balance_quick(MemPage *pParent, MemPage *pPage, u8 *pSpace){
7421 BtShared *const pBt = pPage->pBt; /* B-Tree Database */
danielk19774dbaa892009-06-16 16:50:22 +00007422 MemPage *pNew; /* Newly allocated page */
danielk19776f235cc2009-06-04 14:46:08 +00007423 int rc; /* Return Code */
7424 Pgno pgnoNew; /* Page number of pNew */
danielk1977ac245ec2005-01-14 13:50:11 +00007425
drh1fee73e2007-08-29 04:00:57 +00007426 assert( sqlite3_mutex_held(pPage->pBt->mutex) );
danielk1977a50d9aa2009-06-08 14:49:45 +00007427 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk1977e56b60e2009-06-10 09:11:06 +00007428 assert( pPage->nOverflow==1 );
drhb0ea9432019-02-09 21:06:40 +00007429
drh6301c432018-12-13 21:52:18 +00007430 if( pPage->nCell==0 ) return SQLITE_CORRUPT_BKPT; /* dbfuzz001.test */
drh68133502019-02-11 17:22:30 +00007431 assert( pPage->nFree>=0 );
7432 assert( pParent->nFree>=0 );
drhd677b3d2007-08-20 22:48:41 +00007433
danielk1977a50d9aa2009-06-08 14:49:45 +00007434 /* Allocate a new page. This page will become the right-sibling of
7435 ** pPage. Make the parent page writable, so that the new divider cell
7436 ** may be inserted. If both these operations are successful, proceed.
7437 */
drh4f0c5872007-03-26 22:05:01 +00007438 rc = allocateBtreePage(pBt, &pNew, &pgnoNew, 0, 0);
danielk19774dbaa892009-06-16 16:50:22 +00007439
danielk1977eaa06f62008-09-18 17:34:44 +00007440 if( rc==SQLITE_OK ){
danielk1977a50d9aa2009-06-08 14:49:45 +00007441
7442 u8 *pOut = &pSpace[4];
drh2cbd78b2012-02-02 19:37:18 +00007443 u8 *pCell = pPage->apOvfl[0];
drh25ada072015-06-19 15:07:14 +00007444 u16 szCell = pPage->xCellSize(pPage, pCell);
danielk19776f235cc2009-06-04 14:46:08 +00007445 u8 *pStop;
drhe3dadac2019-01-23 19:25:59 +00007446 CellArray b;
danielk19776f235cc2009-06-04 14:46:08 +00007447
drhc5053fb2008-11-27 02:22:10 +00007448 assert( sqlite3PagerIswriteable(pNew->pDbPage) );
danba14c692019-01-25 13:42:12 +00007449 assert( CORRUPT_DB || pPage->aData[0]==(PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF) );
danielk1977e56b60e2009-06-10 09:11:06 +00007450 zeroPage(pNew, PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF);
drhe3dadac2019-01-23 19:25:59 +00007451 b.nCell = 1;
7452 b.pRef = pPage;
7453 b.apCell = &pCell;
7454 b.szCell = &szCell;
7455 b.apEnd[0] = pPage->aDataEnd;
7456 b.ixNx[0] = 2;
7457 rc = rebuildPage(&b, 0, 1, pNew);
7458 if( NEVER(rc) ){
7459 releasePage(pNew);
7460 return rc;
7461 }
dan8e9ba0c2014-10-14 17:27:04 +00007462 pNew->nFree = pBt->usableSize - pNew->cellOffset - 2 - szCell;
danielk19774dbaa892009-06-16 16:50:22 +00007463
7464 /* If this is an auto-vacuum database, update the pointer map
7465 ** with entries for the new page, and any pointer from the
7466 ** cell on the page to an overflow page. If either of these
7467 ** operations fails, the return code is set, but the contents
7468 ** of the parent page are still manipulated by thh code below.
7469 ** That is Ok, at this point the parent page is guaranteed to
7470 ** be marked as dirty. Returning an error code will cause a
7471 ** rollback, undoing any changes made to the parent page.
7472 */
7473 if( ISAUTOVACUUM ){
drh98add2e2009-07-20 17:11:49 +00007474 ptrmapPut(pBt, pgnoNew, PTRMAP_BTREE, pParent->pgno, &rc);
7475 if( szCell>pNew->minLocal ){
drh0f1bf4c2019-01-13 20:17:21 +00007476 ptrmapPutOvflPtr(pNew, pNew, pCell, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00007477 }
7478 }
danielk1977eaa06f62008-09-18 17:34:44 +00007479
danielk19776f235cc2009-06-04 14:46:08 +00007480 /* Create a divider cell to insert into pParent. The divider cell
7481 ** consists of a 4-byte page number (the page number of pPage) and
7482 ** a variable length key value (which must be the same value as the
7483 ** largest key on pPage).
danielk1977eaa06f62008-09-18 17:34:44 +00007484 **
danielk19776f235cc2009-06-04 14:46:08 +00007485 ** To find the largest key value on pPage, first find the right-most
7486 ** cell on pPage. The first two fields of this cell are the
7487 ** record-length (a variable length integer at most 32-bits in size)
7488 ** and the key value (a variable length integer, may have any value).
7489 ** The first of the while(...) loops below skips over the record-length
7490 ** field. The second while(...) loop copies the key value from the
danielk1977a50d9aa2009-06-08 14:49:45 +00007491 ** cell on pPage into the pSpace buffer.
danielk1977eaa06f62008-09-18 17:34:44 +00007492 */
danielk1977eaa06f62008-09-18 17:34:44 +00007493 pCell = findCell(pPage, pPage->nCell-1);
danielk19776f235cc2009-06-04 14:46:08 +00007494 pStop = &pCell[9];
7495 while( (*(pCell++)&0x80) && pCell<pStop );
7496 pStop = &pCell[9];
7497 while( ((*(pOut++) = *(pCell++))&0x80) && pCell<pStop );
7498
danielk19774dbaa892009-06-16 16:50:22 +00007499 /* Insert the new divider cell into pParent. */
drhcb89f4a2016-05-21 11:23:26 +00007500 if( rc==SQLITE_OK ){
7501 insertCell(pParent, pParent->nCell, pSpace, (int)(pOut-pSpace),
7502 0, pPage->pgno, &rc);
7503 }
danielk19776f235cc2009-06-04 14:46:08 +00007504
7505 /* Set the right-child pointer of pParent to point to the new page. */
danielk1977eaa06f62008-09-18 17:34:44 +00007506 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew);
7507
danielk1977e08a3c42008-09-18 18:17:03 +00007508 /* Release the reference to the new page. */
7509 releasePage(pNew);
danielk1977ac11ee62005-01-15 12:45:51 +00007510 }
7511
danielk1977eaa06f62008-09-18 17:34:44 +00007512 return rc;
danielk1977ac245ec2005-01-14 13:50:11 +00007513}
drh615ae552005-01-16 23:21:00 +00007514#endif /* SQLITE_OMIT_QUICKBALANCE */
drh43605152004-05-29 21:46:49 +00007515
danielk19774dbaa892009-06-16 16:50:22 +00007516#if 0
drhc3b70572003-01-04 19:44:07 +00007517/*
danielk19774dbaa892009-06-16 16:50:22 +00007518** This function does not contribute anything to the operation of SQLite.
7519** it is sometimes activated temporarily while debugging code responsible
7520** for setting pointer-map entries.
7521*/
7522static int ptrmapCheckPages(MemPage **apPage, int nPage){
7523 int i, j;
7524 for(i=0; i<nPage; i++){
7525 Pgno n;
7526 u8 e;
7527 MemPage *pPage = apPage[i];
7528 BtShared *pBt = pPage->pBt;
7529 assert( pPage->isInit );
7530
7531 for(j=0; j<pPage->nCell; j++){
7532 CellInfo info;
7533 u8 *z;
7534
7535 z = findCell(pPage, j);
drh5fa60512015-06-19 17:19:34 +00007536 pPage->xParseCell(pPage, z, &info);
drh45ac1c72015-12-18 03:59:16 +00007537 if( info.nLocal<info.nPayload ){
7538 Pgno ovfl = get4byte(&z[info.nSize-4]);
danielk19774dbaa892009-06-16 16:50:22 +00007539 ptrmapGet(pBt, ovfl, &e, &n);
7540 assert( n==pPage->pgno && e==PTRMAP_OVERFLOW1 );
7541 }
7542 if( !pPage->leaf ){
7543 Pgno child = get4byte(z);
7544 ptrmapGet(pBt, child, &e, &n);
7545 assert( n==pPage->pgno && e==PTRMAP_BTREE );
7546 }
7547 }
7548 if( !pPage->leaf ){
7549 Pgno child = get4byte(&pPage->aData[pPage->hdrOffset+8]);
7550 ptrmapGet(pBt, child, &e, &n);
7551 assert( n==pPage->pgno && e==PTRMAP_BTREE );
7552 }
7553 }
7554 return 1;
7555}
7556#endif
7557
danielk1977cd581a72009-06-23 15:43:39 +00007558/*
7559** This function is used to copy the contents of the b-tree node stored
7560** on page pFrom to page pTo. If page pFrom was not a leaf page, then
7561** the pointer-map entries for each child page are updated so that the
7562** parent page stored in the pointer map is page pTo. If pFrom contained
7563** any cells with overflow page pointers, then the corresponding pointer
7564** map entries are also updated so that the parent page is page pTo.
7565**
7566** If pFrom is currently carrying any overflow cells (entries in the
drh2cbd78b2012-02-02 19:37:18 +00007567** MemPage.apOvfl[] array), they are not copied to pTo.
danielk1977cd581a72009-06-23 15:43:39 +00007568**
danielk197730548662009-07-09 05:07:37 +00007569** Before returning, page pTo is reinitialized using btreeInitPage().
danielk1977cd581a72009-06-23 15:43:39 +00007570**
7571** The performance of this function is not critical. It is only used by
7572** the balance_shallower() and balance_deeper() procedures, neither of
7573** which are called often under normal circumstances.
7574*/
drhc314dc72009-07-21 11:52:34 +00007575static void copyNodeContent(MemPage *pFrom, MemPage *pTo, int *pRC){
7576 if( (*pRC)==SQLITE_OK ){
7577 BtShared * const pBt = pFrom->pBt;
7578 u8 * const aFrom = pFrom->aData;
7579 u8 * const aTo = pTo->aData;
7580 int const iFromHdr = pFrom->hdrOffset;
7581 int const iToHdr = ((pTo->pgno==1) ? 100 : 0);
drhdc9b5f82009-12-05 18:34:08 +00007582 int rc;
drhc314dc72009-07-21 11:52:34 +00007583 int iData;
7584
7585
7586 assert( pFrom->isInit );
7587 assert( pFrom->nFree>=iToHdr );
drhfcd71b62011-04-05 22:08:24 +00007588 assert( get2byte(&aFrom[iFromHdr+5]) <= (int)pBt->usableSize );
drhc314dc72009-07-21 11:52:34 +00007589
7590 /* Copy the b-tree node content from page pFrom to page pTo. */
7591 iData = get2byte(&aFrom[iFromHdr+5]);
7592 memcpy(&aTo[iData], &aFrom[iData], pBt->usableSize-iData);
7593 memcpy(&aTo[iToHdr], &aFrom[iFromHdr], pFrom->cellOffset + 2*pFrom->nCell);
7594
7595 /* Reinitialize page pTo so that the contents of the MemPage structure
dan89e060e2009-12-05 18:03:50 +00007596 ** match the new data. The initialization of pTo can actually fail under
7597 ** fairly obscure circumstances, even though it is a copy of initialized
7598 ** page pFrom.
7599 */
drhc314dc72009-07-21 11:52:34 +00007600 pTo->isInit = 0;
dan89e060e2009-12-05 18:03:50 +00007601 rc = btreeInitPage(pTo);
drh8357c662019-02-11 22:50:01 +00007602 if( rc==SQLITE_OK ) rc = btreeComputeFreeSpace(pTo);
dan89e060e2009-12-05 18:03:50 +00007603 if( rc!=SQLITE_OK ){
7604 *pRC = rc;
7605 return;
7606 }
drhc314dc72009-07-21 11:52:34 +00007607
7608 /* If this is an auto-vacuum database, update the pointer-map entries
7609 ** for any b-tree or overflow pages that pTo now contains the pointers to.
7610 */
7611 if( ISAUTOVACUUM ){
7612 *pRC = setChildPtrmaps(pTo);
7613 }
danielk1977cd581a72009-06-23 15:43:39 +00007614 }
danielk1977cd581a72009-06-23 15:43:39 +00007615}
7616
7617/*
danielk19774dbaa892009-06-16 16:50:22 +00007618** This routine redistributes cells on the iParentIdx'th child of pParent
7619** (hereafter "the page") and up to 2 siblings so that all pages have about the
7620** same amount of free space. Usually a single sibling on either side of the
7621** page are used in the balancing, though both siblings might come from one
7622** side if the page is the first or last child of its parent. If the page
7623** has fewer than 2 siblings (something which can only happen if the page
7624** is a root page or a child of a root page) then all available siblings
7625** participate in the balancing.
drh8b2f49b2001-06-08 00:21:52 +00007626**
danielk19774dbaa892009-06-16 16:50:22 +00007627** The number of siblings of the page might be increased or decreased by
7628** one or two in an effort to keep pages nearly full but not over full.
drh14acc042001-06-10 19:56:58 +00007629**
danielk19774dbaa892009-06-16 16:50:22 +00007630** Note that when this routine is called, some of the cells on the page
7631** might not actually be stored in MemPage.aData[]. This can happen
7632** if the page is overfull. This routine ensures that all cells allocated
7633** to the page and its siblings fit into MemPage.aData[] before returning.
drh14acc042001-06-10 19:56:58 +00007634**
danielk19774dbaa892009-06-16 16:50:22 +00007635** In the course of balancing the page and its siblings, cells may be
7636** inserted into or removed from the parent page (pParent). Doing so
7637** may cause the parent page to become overfull or underfull. If this
7638** happens, it is the responsibility of the caller to invoke the correct
7639** balancing routine to fix this problem (see the balance() routine).
drh8c42ca92001-06-22 19:15:00 +00007640**
drh5e00f6c2001-09-13 13:46:56 +00007641** If this routine fails for any reason, it might leave the database
danielk19776067a9b2009-06-09 09:41:00 +00007642** in a corrupted state. So if this routine fails, the database should
drh5e00f6c2001-09-13 13:46:56 +00007643** be rolled back.
danielk19774dbaa892009-06-16 16:50:22 +00007644**
7645** The third argument to this function, aOvflSpace, is a pointer to a
drhcd09c532009-07-20 19:30:00 +00007646** buffer big enough to hold one page. If while inserting cells into the parent
7647** page (pParent) the parent page becomes overfull, this buffer is
7648** used to store the parent's overflow cells. Because this function inserts
danielk19774dbaa892009-06-16 16:50:22 +00007649** a maximum of four divider cells into the parent page, and the maximum
7650** size of a cell stored within an internal node is always less than 1/4
7651** of the page-size, the aOvflSpace[] buffer is guaranteed to be large
7652** enough for all overflow cells.
7653**
7654** If aOvflSpace is set to a null pointer, this function returns
7655** SQLITE_NOMEM.
drh8b2f49b2001-06-08 00:21:52 +00007656*/
danielk19774dbaa892009-06-16 16:50:22 +00007657static int balance_nonroot(
7658 MemPage *pParent, /* Parent page of siblings being balanced */
7659 int iParentIdx, /* Index of "the page" in pParent */
danielk1977cd581a72009-06-23 15:43:39 +00007660 u8 *aOvflSpace, /* page-size bytes of space for parent ovfl */
dan428c2182012-08-06 18:50:11 +00007661 int isRoot, /* True if pParent is a root-page */
7662 int bBulk /* True if this call is part of a bulk load */
danielk19774dbaa892009-06-16 16:50:22 +00007663){
drh16a9b832007-05-05 18:39:25 +00007664 BtShared *pBt; /* The whole database */
danielk1977634f2982005-03-28 08:44:07 +00007665 int nMaxCells = 0; /* Allocated size of apCell, szCell, aFrom. */
danielk1977a4124bd2008-12-23 10:37:47 +00007666 int nNew = 0; /* Number of pages in apNew[] */
danielk19774dbaa892009-06-16 16:50:22 +00007667 int nOld; /* Number of pages in apOld[] */
drh14acc042001-06-10 19:56:58 +00007668 int i, j, k; /* Loop counters */
drha34b6762004-05-07 13:30:42 +00007669 int nxDiv; /* Next divider slot in pParent->aCell[] */
shane85095702009-06-15 16:27:08 +00007670 int rc = SQLITE_OK; /* The return code */
shane36840fd2009-06-26 16:32:13 +00007671 u16 leafCorrection; /* 4 if pPage is a leaf. 0 if not */
drh8b18dd42004-05-12 19:18:15 +00007672 int leafData; /* True if pPage is a leaf of a LEAFDATA tree */
drh91025292004-05-03 19:49:32 +00007673 int usableSpace; /* Bytes in pPage beyond the header */
7674 int pageFlags; /* Value of pPage->aData[0] */
drhe5ae5732008-06-15 02:51:47 +00007675 int iSpace1 = 0; /* First unused byte of aSpace1[] */
danielk19776067a9b2009-06-09 09:41:00 +00007676 int iOvflSpace = 0; /* First unused byte of aOvflSpace[] */
drhfacf0302008-06-17 15:12:00 +00007677 int szScratch; /* Size of scratch memory requested */
drhc3b70572003-01-04 19:44:07 +00007678 MemPage *apOld[NB]; /* pPage and up to two siblings */
drha2fce642004-06-05 00:01:44 +00007679 MemPage *apNew[NB+2]; /* pPage and up to NB siblings after balancing */
danielk19774dbaa892009-06-16 16:50:22 +00007680 u8 *pRight; /* Location in parent of right-sibling pointer */
7681 u8 *apDiv[NB-1]; /* Divider cells in pParent */
drh1ffd2472015-06-23 02:37:30 +00007682 int cntNew[NB+2]; /* Index in b.paCell[] of cell after i-th page */
7683 int cntOld[NB+2]; /* Old index in b.apCell[] */
drh2a0df922014-10-30 23:14:56 +00007684 int szNew[NB+2]; /* Combined size of cells placed on i-th page */
danielk19774dbaa892009-06-16 16:50:22 +00007685 u8 *aSpace1; /* Space for copies of dividers cells */
7686 Pgno pgno; /* Temp var to store a page number in */
dane6593d82014-10-24 16:40:49 +00007687 u8 abDone[NB+2]; /* True after i'th new page is populated */
7688 Pgno aPgno[NB+2]; /* Page numbers of new pages before shuffling */
drh00fe08a2014-10-31 00:05:23 +00007689 Pgno aPgOrder[NB+2]; /* Copy of aPgno[] used for sorting pages */
dane6593d82014-10-24 16:40:49 +00007690 u16 aPgFlags[NB+2]; /* flags field of new pages before shuffling */
drh1ffd2472015-06-23 02:37:30 +00007691 CellArray b; /* Parsed information on cells being balanced */
drh8b2f49b2001-06-08 00:21:52 +00007692
dan33ea4862014-10-09 19:35:37 +00007693 memset(abDone, 0, sizeof(abDone));
drh1ffd2472015-06-23 02:37:30 +00007694 b.nCell = 0;
7695 b.apCell = 0;
danielk1977a50d9aa2009-06-08 14:49:45 +00007696 pBt = pParent->pBt;
7697 assert( sqlite3_mutex_held(pBt->mutex) );
7698 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
danielk1977474b7cc2008-07-09 11:49:46 +00007699
danielk19774dbaa892009-06-16 16:50:22 +00007700 /* At this point pParent may have at most one overflow cell. And if
7701 ** this overflow cell is present, it must be the cell with
7702 ** index iParentIdx. This scenario comes about when this function
drhcd09c532009-07-20 19:30:00 +00007703 ** is called (indirectly) from sqlite3BtreeDelete().
7704 */
danielk19774dbaa892009-06-16 16:50:22 +00007705 assert( pParent->nOverflow==0 || pParent->nOverflow==1 );
drh2cbd78b2012-02-02 19:37:18 +00007706 assert( pParent->nOverflow==0 || pParent->aiOvfl[0]==iParentIdx );
danielk19774dbaa892009-06-16 16:50:22 +00007707
danielk197711a8a862009-06-17 11:49:52 +00007708 if( !aOvflSpace ){
mistachkinfad30392016-02-13 23:43:46 +00007709 return SQLITE_NOMEM_BKPT;
danielk197711a8a862009-06-17 11:49:52 +00007710 }
drh68133502019-02-11 17:22:30 +00007711 assert( pParent->nFree>=0 );
danielk197711a8a862009-06-17 11:49:52 +00007712
danielk1977a50d9aa2009-06-08 14:49:45 +00007713 /* Find the sibling pages to balance. Also locate the cells in pParent
7714 ** that divide the siblings. An attempt is made to find NN siblings on
7715 ** either side of pPage. More siblings are taken from one side, however,
7716 ** if there are fewer than NN siblings on the other side. If pParent
danielk19774dbaa892009-06-16 16:50:22 +00007717 ** has NB or fewer children then all children of pParent are taken.
7718 **
7719 ** This loop also drops the divider cells from the parent page. This
7720 ** way, the remainder of the function does not have to deal with any
drhcd09c532009-07-20 19:30:00 +00007721 ** overflow cells in the parent page, since if any existed they will
7722 ** have already been removed.
7723 */
danielk19774dbaa892009-06-16 16:50:22 +00007724 i = pParent->nOverflow + pParent->nCell;
7725 if( i<2 ){
drhc3b70572003-01-04 19:44:07 +00007726 nxDiv = 0;
danielk19774dbaa892009-06-16 16:50:22 +00007727 }else{
dan7d6885a2012-08-08 14:04:56 +00007728 assert( bBulk==0 || bBulk==1 );
danielk19774dbaa892009-06-16 16:50:22 +00007729 if( iParentIdx==0 ){
7730 nxDiv = 0;
7731 }else if( iParentIdx==i ){
dan7d6885a2012-08-08 14:04:56 +00007732 nxDiv = i-2+bBulk;
drh14acc042001-06-10 19:56:58 +00007733 }else{
danielk19774dbaa892009-06-16 16:50:22 +00007734 nxDiv = iParentIdx-1;
drh8b2f49b2001-06-08 00:21:52 +00007735 }
dan7d6885a2012-08-08 14:04:56 +00007736 i = 2-bBulk;
danielk19774dbaa892009-06-16 16:50:22 +00007737 }
dan7d6885a2012-08-08 14:04:56 +00007738 nOld = i+1;
danielk19774dbaa892009-06-16 16:50:22 +00007739 if( (i+nxDiv-pParent->nOverflow)==pParent->nCell ){
7740 pRight = &pParent->aData[pParent->hdrOffset+8];
7741 }else{
7742 pRight = findCell(pParent, i+nxDiv-pParent->nOverflow);
7743 }
7744 pgno = get4byte(pRight);
7745 while( 1 ){
dan1f9f5762021-03-01 16:15:41 +00007746 if( rc==SQLITE_OK ){
7747 rc = getAndInitPage(pBt, pgno, &apOld[i], 0, 0);
7748 }
danielk19774dbaa892009-06-16 16:50:22 +00007749 if( rc ){
danielk197789bc4bc2009-07-21 19:25:24 +00007750 memset(apOld, 0, (i+1)*sizeof(MemPage*));
danielk19774dbaa892009-06-16 16:50:22 +00007751 goto balance_cleanup;
7752 }
drh85a379b2019-02-09 22:33:44 +00007753 if( apOld[i]->nFree<0 ){
7754 rc = btreeComputeFreeSpace(apOld[i]);
7755 if( rc ){
7756 memset(apOld, 0, (i)*sizeof(MemPage*));
7757 goto balance_cleanup;
7758 }
7759 }
danb9f8a182021-06-22 14:59:34 +00007760 nMaxCells += apOld[i]->nCell + ArraySize(pParent->apOvfl);
danielk19774dbaa892009-06-16 16:50:22 +00007761 if( (i--)==0 ) break;
7762
drh9cc5b4e2016-12-26 01:41:33 +00007763 if( pParent->nOverflow && i+nxDiv==pParent->aiOvfl[0] ){
drh2cbd78b2012-02-02 19:37:18 +00007764 apDiv[i] = pParent->apOvfl[0];
danielk19774dbaa892009-06-16 16:50:22 +00007765 pgno = get4byte(apDiv[i]);
drh25ada072015-06-19 15:07:14 +00007766 szNew[i] = pParent->xCellSize(pParent, apDiv[i]);
danielk19774dbaa892009-06-16 16:50:22 +00007767 pParent->nOverflow = 0;
7768 }else{
7769 apDiv[i] = findCell(pParent, i+nxDiv-pParent->nOverflow);
7770 pgno = get4byte(apDiv[i]);
drh25ada072015-06-19 15:07:14 +00007771 szNew[i] = pParent->xCellSize(pParent, apDiv[i]);
danielk19774dbaa892009-06-16 16:50:22 +00007772
7773 /* Drop the cell from the parent page. apDiv[i] still points to
7774 ** the cell within the parent, even though it has been dropped.
7775 ** This is safe because dropping a cell only overwrites the first
7776 ** four bytes of it, and this function does not need the first
7777 ** four bytes of the divider cell. So the pointer is safe to use
danielk197711a8a862009-06-17 11:49:52 +00007778 ** later on.
7779 **
drh8a575d92011-10-12 17:00:28 +00007780 ** But not if we are in secure-delete mode. In secure-delete mode,
danielk197711a8a862009-06-17 11:49:52 +00007781 ** the dropCell() routine will overwrite the entire cell with zeroes.
7782 ** In this case, temporarily copy the cell into the aOvflSpace[]
7783 ** buffer. It will be copied out again as soon as the aSpace[] buffer
7784 ** is allocated. */
drha5907a82017-06-19 11:44:22 +00007785 if( pBt->btsFlags & BTS_FAST_SECURE ){
drh8a575d92011-10-12 17:00:28 +00007786 int iOff;
7787
dan1f9f5762021-03-01 16:15:41 +00007788 /* If the following if() condition is not true, the db is corrupted.
7789 ** The call to dropCell() below will detect this. */
drh8a575d92011-10-12 17:00:28 +00007790 iOff = SQLITE_PTR_TO_INT(apDiv[i]) - SQLITE_PTR_TO_INT(pParent->aData);
dan1f9f5762021-03-01 16:15:41 +00007791 if( (iOff+szNew[i])<=(int)pBt->usableSize ){
dan2ed11e72010-02-26 15:09:19 +00007792 memcpy(&aOvflSpace[iOff], apDiv[i], szNew[i]);
7793 apDiv[i] = &aOvflSpace[apDiv[i]-pParent->aData];
7794 }
drh5b47efa2010-02-12 18:18:39 +00007795 }
drh98add2e2009-07-20 17:11:49 +00007796 dropCell(pParent, i+nxDiv-pParent->nOverflow, szNew[i], &rc);
danielk19774dbaa892009-06-16 16:50:22 +00007797 }
drh8b2f49b2001-06-08 00:21:52 +00007798 }
7799
drha9121e42008-02-19 14:59:35 +00007800 /* Make nMaxCells a multiple of 4 in order to preserve 8-byte
drh8d97f1f2005-05-05 18:14:13 +00007801 ** alignment */
drha9121e42008-02-19 14:59:35 +00007802 nMaxCells = (nMaxCells + 3)&~3;
drh8d97f1f2005-05-05 18:14:13 +00007803
drh8b2f49b2001-06-08 00:21:52 +00007804 /*
danielk1977634f2982005-03-28 08:44:07 +00007805 ** Allocate space for memory structures
7806 */
drhfacf0302008-06-17 15:12:00 +00007807 szScratch =
drh1ffd2472015-06-23 02:37:30 +00007808 nMaxCells*sizeof(u8*) /* b.apCell */
7809 + nMaxCells*sizeof(u16) /* b.szCell */
dan33ea4862014-10-09 19:35:37 +00007810 + pBt->pageSize; /* aSpace1 */
drh5279d342014-11-04 13:41:32 +00007811
drhf012dc42019-03-19 15:36:46 +00007812 assert( szScratch<=7*(int)pBt->pageSize );
drhb2a0f752017-08-28 15:51:35 +00007813 b.apCell = sqlite3StackAllocRaw(0, szScratch );
drh1ffd2472015-06-23 02:37:30 +00007814 if( b.apCell==0 ){
mistachkinfad30392016-02-13 23:43:46 +00007815 rc = SQLITE_NOMEM_BKPT;
danielk1977634f2982005-03-28 08:44:07 +00007816 goto balance_cleanup;
7817 }
drh1ffd2472015-06-23 02:37:30 +00007818 b.szCell = (u16*)&b.apCell[nMaxCells];
7819 aSpace1 = (u8*)&b.szCell[nMaxCells];
drhea598cb2009-04-05 12:22:08 +00007820 assert( EIGHT_BYTE_ALIGNMENT(aSpace1) );
drh14acc042001-06-10 19:56:58 +00007821
7822 /*
7823 ** Load pointers to all cells on sibling pages and the divider cells
drh1ffd2472015-06-23 02:37:30 +00007824 ** into the local b.apCell[] array. Make copies of the divider cells
dan33ea4862014-10-09 19:35:37 +00007825 ** into space obtained from aSpace1[]. The divider cells have already
7826 ** been removed from pParent.
drh4b70f112004-05-02 21:12:19 +00007827 **
7828 ** If the siblings are on leaf pages, then the child pointers of the
7829 ** divider cells are stripped from the cells before they are copied
drh1ffd2472015-06-23 02:37:30 +00007830 ** into aSpace1[]. In this way, all cells in b.apCell[] are without
drh4b70f112004-05-02 21:12:19 +00007831 ** child pointers. If siblings are not leaves, then all cell in
drh1ffd2472015-06-23 02:37:30 +00007832 ** b.apCell[] include child pointers. Either way, all cells in b.apCell[]
drh4b70f112004-05-02 21:12:19 +00007833 ** are alike.
drh96f5b762004-05-16 16:24:36 +00007834 **
7835 ** leafCorrection: 4 if pPage is a leaf. 0 if pPage is not a leaf.
7836 ** leafData: 1 if pPage holds key+data and pParent holds only keys.
drh8b2f49b2001-06-08 00:21:52 +00007837 */
drh1ffd2472015-06-23 02:37:30 +00007838 b.pRef = apOld[0];
7839 leafCorrection = b.pRef->leaf*4;
7840 leafData = b.pRef->intKeyLeaf;
drh8b2f49b2001-06-08 00:21:52 +00007841 for(i=0; i<nOld; i++){
dan33ea4862014-10-09 19:35:37 +00007842 MemPage *pOld = apOld[i];
drh4edfdd32015-06-23 14:49:42 +00007843 int limit = pOld->nCell;
7844 u8 *aData = pOld->aData;
7845 u16 maskPage = pOld->maskPage;
drh4f4bf772015-06-23 17:09:53 +00007846 u8 *piCell = aData + pOld->cellOffset;
drhfe647dc2015-06-23 18:24:25 +00007847 u8 *piEnd;
drhe12ca5a2019-05-02 15:56:39 +00007848 VVA_ONLY( int nCellAtStart = b.nCell; )
danielk19774dbaa892009-06-16 16:50:22 +00007849
drh73d340a2015-05-28 11:23:11 +00007850 /* Verify that all sibling pages are of the same "type" (table-leaf,
7851 ** table-interior, index-leaf, or index-interior).
7852 */
7853 if( pOld->aData[0]!=apOld[0]->aData[0] ){
7854 rc = SQLITE_CORRUPT_BKPT;
7855 goto balance_cleanup;
7856 }
7857
drhfe647dc2015-06-23 18:24:25 +00007858 /* Load b.apCell[] with pointers to all cells in pOld. If pOld
drh8d7f1632018-01-23 13:30:38 +00007859 ** contains overflow cells, include them in the b.apCell[] array
drhfe647dc2015-06-23 18:24:25 +00007860 ** in the correct spot.
7861 **
7862 ** Note that when there are multiple overflow cells, it is always the
7863 ** case that they are sequential and adjacent. This invariant arises
7864 ** because multiple overflows can only occurs when inserting divider
7865 ** cells into a parent on a prior balance, and divider cells are always
7866 ** adjacent and are inserted in order. There is an assert() tagged
7867 ** with "NOTE 1" in the overflow cell insertion loop to prove this
7868 ** invariant.
drh4edfdd32015-06-23 14:49:42 +00007869 **
7870 ** This must be done in advance. Once the balance starts, the cell
7871 ** offset section of the btree page will be overwritten and we will no
7872 ** long be able to find the cells if a pointer to each cell is not saved
7873 ** first.
7874 */
drh36b78ee2016-01-20 01:32:00 +00007875 memset(&b.szCell[b.nCell], 0, sizeof(b.szCell[0])*(limit+pOld->nOverflow));
drh68f2a572011-06-03 17:50:49 +00007876 if( pOld->nOverflow>0 ){
drh27e80a32019-08-15 13:17:49 +00007877 if( NEVER(limit<pOld->aiOvfl[0]) ){
drhe12ca5a2019-05-02 15:56:39 +00007878 rc = SQLITE_CORRUPT_BKPT;
7879 goto balance_cleanup;
7880 }
drhfe647dc2015-06-23 18:24:25 +00007881 limit = pOld->aiOvfl[0];
drh68f2a572011-06-03 17:50:49 +00007882 for(j=0; j<limit; j++){
drh329428e2015-06-30 13:28:18 +00007883 b.apCell[b.nCell] = aData + (maskPage & get2byteAligned(piCell));
drhfe647dc2015-06-23 18:24:25 +00007884 piCell += 2;
7885 b.nCell++;
drh68f2a572011-06-03 17:50:49 +00007886 }
drhfe647dc2015-06-23 18:24:25 +00007887 for(k=0; k<pOld->nOverflow; k++){
7888 assert( k==0 || pOld->aiOvfl[k-1]+1==pOld->aiOvfl[k] );/* NOTE 1 */
drh4edfdd32015-06-23 14:49:42 +00007889 b.apCell[b.nCell] = pOld->apOvfl[k];
drh1ffd2472015-06-23 02:37:30 +00007890 b.nCell++;
drh68f2a572011-06-03 17:50:49 +00007891 }
drh1ffd2472015-06-23 02:37:30 +00007892 }
drhfe647dc2015-06-23 18:24:25 +00007893 piEnd = aData + pOld->cellOffset + 2*pOld->nCell;
7894 while( piCell<piEnd ){
drh4edfdd32015-06-23 14:49:42 +00007895 assert( b.nCell<nMaxCells );
drh329428e2015-06-30 13:28:18 +00007896 b.apCell[b.nCell] = aData + (maskPage & get2byteAligned(piCell));
drh4f4bf772015-06-23 17:09:53 +00007897 piCell += 2;
drh4edfdd32015-06-23 14:49:42 +00007898 b.nCell++;
drh4edfdd32015-06-23 14:49:42 +00007899 }
drhe12ca5a2019-05-02 15:56:39 +00007900 assert( (b.nCell-nCellAtStart)==(pOld->nCell+pOld->nOverflow) );
drh4edfdd32015-06-23 14:49:42 +00007901
drh1ffd2472015-06-23 02:37:30 +00007902 cntOld[i] = b.nCell;
danielk19774dbaa892009-06-16 16:50:22 +00007903 if( i<nOld-1 && !leafData){
shane36840fd2009-06-26 16:32:13 +00007904 u16 sz = (u16)szNew[i];
danielk19774dbaa892009-06-16 16:50:22 +00007905 u8 *pTemp;
drh1ffd2472015-06-23 02:37:30 +00007906 assert( b.nCell<nMaxCells );
7907 b.szCell[b.nCell] = sz;
danielk19774dbaa892009-06-16 16:50:22 +00007908 pTemp = &aSpace1[iSpace1];
7909 iSpace1 += sz;
drhe22e03e2010-08-18 21:19:03 +00007910 assert( sz<=pBt->maxLocal+23 );
drhfcd71b62011-04-05 22:08:24 +00007911 assert( iSpace1 <= (int)pBt->pageSize );
danielk19774dbaa892009-06-16 16:50:22 +00007912 memcpy(pTemp, apDiv[i], sz);
drh1ffd2472015-06-23 02:37:30 +00007913 b.apCell[b.nCell] = pTemp+leafCorrection;
danielk19774dbaa892009-06-16 16:50:22 +00007914 assert( leafCorrection==0 || leafCorrection==4 );
drh1ffd2472015-06-23 02:37:30 +00007915 b.szCell[b.nCell] = b.szCell[b.nCell] - leafCorrection;
danielk19774dbaa892009-06-16 16:50:22 +00007916 if( !pOld->leaf ){
7917 assert( leafCorrection==0 );
dan5b482a92021-04-20 13:31:51 +00007918 assert( pOld->hdrOffset==0 || CORRUPT_DB );
danielk19774dbaa892009-06-16 16:50:22 +00007919 /* The right pointer of the child page pOld becomes the left
7920 ** pointer of the divider cell */
drh1ffd2472015-06-23 02:37:30 +00007921 memcpy(b.apCell[b.nCell], &pOld->aData[8], 4);
danielk19774dbaa892009-06-16 16:50:22 +00007922 }else{
7923 assert( leafCorrection==4 );
drh1ffd2472015-06-23 02:37:30 +00007924 while( b.szCell[b.nCell]<4 ){
dan8f1eb8a2014-12-06 14:56:49 +00007925 /* Do not allow any cells smaller than 4 bytes. If a smaller cell
7926 ** does exist, pad it with 0x00 bytes. */
drh1ffd2472015-06-23 02:37:30 +00007927 assert( b.szCell[b.nCell]==3 || CORRUPT_DB );
7928 assert( b.apCell[b.nCell]==&aSpace1[iSpace1-3] || CORRUPT_DB );
danee7172f2014-12-24 18:11:50 +00007929 aSpace1[iSpace1++] = 0x00;
drh1ffd2472015-06-23 02:37:30 +00007930 b.szCell[b.nCell]++;
danielk1977ac11ee62005-01-15 12:45:51 +00007931 }
7932 }
drh1ffd2472015-06-23 02:37:30 +00007933 b.nCell++;
drh8b2f49b2001-06-08 00:21:52 +00007934 }
drh8b2f49b2001-06-08 00:21:52 +00007935 }
7936
7937 /*
drh1ffd2472015-06-23 02:37:30 +00007938 ** Figure out the number of pages needed to hold all b.nCell cells.
drh6019e162001-07-02 17:51:45 +00007939 ** Store this number in "k". Also compute szNew[] which is the total
7940 ** size of all cells on the i-th page and cntNew[] which is the index
drh1ffd2472015-06-23 02:37:30 +00007941 ** in b.apCell[] of the cell that divides page i from page i+1.
7942 ** cntNew[k] should equal b.nCell.
drh6019e162001-07-02 17:51:45 +00007943 **
drh96f5b762004-05-16 16:24:36 +00007944 ** Values computed by this block:
7945 **
7946 ** k: The total number of sibling pages
7947 ** szNew[i]: Spaced used on the i-th sibling page.
drh1ffd2472015-06-23 02:37:30 +00007948 ** cntNew[i]: Index in b.apCell[] and b.szCell[] for the first cell to
drh96f5b762004-05-16 16:24:36 +00007949 ** the right of the i-th sibling page.
7950 ** usableSpace: Number of bytes of space available on each sibling.
7951 **
drh8b2f49b2001-06-08 00:21:52 +00007952 */
drh43605152004-05-29 21:46:49 +00007953 usableSpace = pBt->usableSize - 12 + leafCorrection;
drh26b7ec82019-02-01 14:50:43 +00007954 for(i=k=0; i<nOld; i++, k++){
drh658873b2015-06-22 20:02:04 +00007955 MemPage *p = apOld[i];
drh26b7ec82019-02-01 14:50:43 +00007956 b.apEnd[k] = p->aDataEnd;
7957 b.ixNx[k] = cntOld[i];
drh9c7e44c2019-02-14 15:27:12 +00007958 if( k && b.ixNx[k]==b.ixNx[k-1] ){
7959 k--; /* Omit b.ixNx[] entry for child pages with no cells */
7960 }
drh26b7ec82019-02-01 14:50:43 +00007961 if( !leafData ){
7962 k++;
7963 b.apEnd[k] = pParent->aDataEnd;
7964 b.ixNx[k] = cntOld[i]+1;
7965 }
drhb0ea9432019-02-09 21:06:40 +00007966 assert( p->nFree>=0 );
drh658873b2015-06-22 20:02:04 +00007967 szNew[i] = usableSpace - p->nFree;
drh658873b2015-06-22 20:02:04 +00007968 for(j=0; j<p->nOverflow; j++){
7969 szNew[i] += 2 + p->xCellSize(p, p->apOvfl[j]);
7970 }
7971 cntNew[i] = cntOld[i];
7972 }
7973 k = nOld;
7974 for(i=0; i<k; i++){
7975 int sz;
7976 while( szNew[i]>usableSpace ){
7977 if( i+1>=k ){
7978 k = i+2;
7979 if( k>NB+2 ){ rc = SQLITE_CORRUPT_BKPT; goto balance_cleanup; }
7980 szNew[k-1] = 0;
drh1ffd2472015-06-23 02:37:30 +00007981 cntNew[k-1] = b.nCell;
drh658873b2015-06-22 20:02:04 +00007982 }
drh1ffd2472015-06-23 02:37:30 +00007983 sz = 2 + cachedCellSize(&b, cntNew[i]-1);
drh658873b2015-06-22 20:02:04 +00007984 szNew[i] -= sz;
7985 if( !leafData ){
drh1ffd2472015-06-23 02:37:30 +00007986 if( cntNew[i]<b.nCell ){
7987 sz = 2 + cachedCellSize(&b, cntNew[i]);
7988 }else{
7989 sz = 0;
7990 }
drh658873b2015-06-22 20:02:04 +00007991 }
7992 szNew[i+1] += sz;
7993 cntNew[i]--;
7994 }
drh1ffd2472015-06-23 02:37:30 +00007995 while( cntNew[i]<b.nCell ){
7996 sz = 2 + cachedCellSize(&b, cntNew[i]);
drh658873b2015-06-22 20:02:04 +00007997 if( szNew[i]+sz>usableSpace ) break;
7998 szNew[i] += sz;
7999 cntNew[i]++;
8000 if( !leafData ){
drh1ffd2472015-06-23 02:37:30 +00008001 if( cntNew[i]<b.nCell ){
8002 sz = 2 + cachedCellSize(&b, cntNew[i]);
8003 }else{
8004 sz = 0;
8005 }
drh658873b2015-06-22 20:02:04 +00008006 }
8007 szNew[i+1] -= sz;
8008 }
drh1ffd2472015-06-23 02:37:30 +00008009 if( cntNew[i]>=b.nCell ){
drh658873b2015-06-22 20:02:04 +00008010 k = i+1;
drh672073a2015-06-24 12:07:40 +00008011 }else if( cntNew[i] <= (i>0 ? cntNew[i-1] : 0) ){
drh658873b2015-06-22 20:02:04 +00008012 rc = SQLITE_CORRUPT_BKPT;
8013 goto balance_cleanup;
drh6019e162001-07-02 17:51:45 +00008014 }
8015 }
drh96f5b762004-05-16 16:24:36 +00008016
8017 /*
8018 ** The packing computed by the previous block is biased toward the siblings
drh2a0df922014-10-30 23:14:56 +00008019 ** on the left side (siblings with smaller keys). The left siblings are
8020 ** always nearly full, while the right-most sibling might be nearly empty.
8021 ** The next block of code attempts to adjust the packing of siblings to
8022 ** get a better balance.
drh96f5b762004-05-16 16:24:36 +00008023 **
8024 ** This adjustment is more than an optimization. The packing above might
8025 ** be so out of balance as to be illegal. For example, the right-most
8026 ** sibling might be completely empty. This adjustment is not optional.
8027 */
drh6019e162001-07-02 17:51:45 +00008028 for(i=k-1; i>0; i--){
drh96f5b762004-05-16 16:24:36 +00008029 int szRight = szNew[i]; /* Size of sibling on the right */
8030 int szLeft = szNew[i-1]; /* Size of sibling on the left */
8031 int r; /* Index of right-most cell in left sibling */
8032 int d; /* Index of first cell to the left of right sibling */
8033
8034 r = cntNew[i-1] - 1;
8035 d = r + 1 - leafData;
drh008d64c2015-06-23 16:00:24 +00008036 (void)cachedCellSize(&b, d);
drh672073a2015-06-24 12:07:40 +00008037 do{
drh1ffd2472015-06-23 02:37:30 +00008038 assert( d<nMaxCells );
8039 assert( r<nMaxCells );
drh1ffd2472015-06-23 02:37:30 +00008040 (void)cachedCellSize(&b, r);
8041 if( szRight!=0
drh0b4c0422016-07-14 19:48:08 +00008042 && (bBulk || szRight+b.szCell[d]+2 > szLeft-(b.szCell[r]+(i==k-1?0:2)))){
drh1ffd2472015-06-23 02:37:30 +00008043 break;
8044 }
8045 szRight += b.szCell[d] + 2;
8046 szLeft -= b.szCell[r] + 2;
drh008d64c2015-06-23 16:00:24 +00008047 cntNew[i-1] = r;
drh008d64c2015-06-23 16:00:24 +00008048 r--;
8049 d--;
drh672073a2015-06-24 12:07:40 +00008050 }while( r>=0 );
drh96f5b762004-05-16 16:24:36 +00008051 szNew[i] = szRight;
8052 szNew[i-1] = szLeft;
drh672073a2015-06-24 12:07:40 +00008053 if( cntNew[i-1] <= (i>1 ? cntNew[i-2] : 0) ){
8054 rc = SQLITE_CORRUPT_BKPT;
8055 goto balance_cleanup;
8056 }
drh6019e162001-07-02 17:51:45 +00008057 }
drh09d0deb2005-08-02 17:13:09 +00008058
drh2a0df922014-10-30 23:14:56 +00008059 /* Sanity check: For a non-corrupt database file one of the follwing
8060 ** must be true:
8061 ** (1) We found one or more cells (cntNew[0])>0), or
8062 ** (2) pPage is a virtual root page. A virtual root page is when
8063 ** the real root page is page 1 and we are the only child of
8064 ** that page.
drh09d0deb2005-08-02 17:13:09 +00008065 */
drh2a0df922014-10-30 23:14:56 +00008066 assert( cntNew[0]>0 || (pParent->pgno==1 && pParent->nCell==0) || CORRUPT_DB);
dan33ea4862014-10-09 19:35:37 +00008067 TRACE(("BALANCE: old: %d(nc=%d) %d(nc=%d) %d(nc=%d)\n",
8068 apOld[0]->pgno, apOld[0]->nCell,
8069 nOld>=2 ? apOld[1]->pgno : 0, nOld>=2 ? apOld[1]->nCell : 0,
8070 nOld>=3 ? apOld[2]->pgno : 0, nOld>=3 ? apOld[2]->nCell : 0
danielk1977e5765212009-06-17 11:13:28 +00008071 ));
8072
drh8b2f49b2001-06-08 00:21:52 +00008073 /*
drh6b308672002-07-08 02:16:37 +00008074 ** Allocate k new pages. Reuse old pages where possible.
drh8b2f49b2001-06-08 00:21:52 +00008075 */
danielk1977a50d9aa2009-06-08 14:49:45 +00008076 pageFlags = apOld[0]->aData[0];
drh14acc042001-06-10 19:56:58 +00008077 for(i=0; i<k; i++){
drhda200cc2004-05-09 11:51:38 +00008078 MemPage *pNew;
drh6b308672002-07-08 02:16:37 +00008079 if( i<nOld ){
drhda200cc2004-05-09 11:51:38 +00008080 pNew = apNew[i] = apOld[i];
drh6b308672002-07-08 02:16:37 +00008081 apOld[i] = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00008082 rc = sqlite3PagerWrite(pNew->pDbPage);
drhf5345442007-04-09 12:45:02 +00008083 nNew++;
drh41d26392021-06-20 22:17:49 +00008084 if( sqlite3PagerPageRefcount(pNew->pDbPage)!=1+(i==(iParentIdx-nxDiv))
8085 && rc==SQLITE_OK
8086 ){
drh9e673ac2021-02-01 12:39:50 +00008087 rc = SQLITE_CORRUPT_BKPT;
8088 }
danielk197728129562005-01-11 10:25:06 +00008089 if( rc ) goto balance_cleanup;
drh6b308672002-07-08 02:16:37 +00008090 }else{
drh7aa8f852006-03-28 00:24:44 +00008091 assert( i>0 );
dan428c2182012-08-06 18:50:11 +00008092 rc = allocateBtreePage(pBt, &pNew, &pgno, (bBulk ? 1 : pgno), 0);
drh6b308672002-07-08 02:16:37 +00008093 if( rc ) goto balance_cleanup;
dan33ea4862014-10-09 19:35:37 +00008094 zeroPage(pNew, pageFlags);
drhda200cc2004-05-09 11:51:38 +00008095 apNew[i] = pNew;
drhf5345442007-04-09 12:45:02 +00008096 nNew++;
drh1ffd2472015-06-23 02:37:30 +00008097 cntOld[i] = b.nCell;
danielk19774dbaa892009-06-16 16:50:22 +00008098
8099 /* Set the pointer-map entry for the new sibling page. */
8100 if( ISAUTOVACUUM ){
drh98add2e2009-07-20 17:11:49 +00008101 ptrmapPut(pBt, pNew->pgno, PTRMAP_BTREE, pParent->pgno, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00008102 if( rc!=SQLITE_OK ){
8103 goto balance_cleanup;
8104 }
8105 }
drh6b308672002-07-08 02:16:37 +00008106 }
drh8b2f49b2001-06-08 00:21:52 +00008107 }
8108
8109 /*
dan33ea4862014-10-09 19:35:37 +00008110 ** Reassign page numbers so that the new pages are in ascending order.
8111 ** This helps to keep entries in the disk file in order so that a scan
8112 ** of the table is closer to a linear scan through the file. That in turn
8113 ** helps the operating system to deliver pages from the disk more rapidly.
drhf9ffac92002-03-02 19:00:31 +00008114 **
dan33ea4862014-10-09 19:35:37 +00008115 ** An O(n^2) insertion sort algorithm is used, but since n is never more
8116 ** than (NB+2) (a small constant), that should not be a problem.
drhf9ffac92002-03-02 19:00:31 +00008117 **
dan33ea4862014-10-09 19:35:37 +00008118 ** When NB==3, this one optimization makes the database about 25% faster
8119 ** for large insertions and deletions.
drhf9ffac92002-03-02 19:00:31 +00008120 */
dan33ea4862014-10-09 19:35:37 +00008121 for(i=0; i<nNew; i++){
drh00fe08a2014-10-31 00:05:23 +00008122 aPgOrder[i] = aPgno[i] = apNew[i]->pgno;
dan33ea4862014-10-09 19:35:37 +00008123 aPgFlags[i] = apNew[i]->pDbPage->flags;
dan89ca0b32014-10-25 20:36:28 +00008124 for(j=0; j<i; j++){
drh8ab79d62021-02-04 13:52:34 +00008125 if( NEVER(aPgno[j]==aPgno[i]) ){
dan89ca0b32014-10-25 20:36:28 +00008126 /* This branch is taken if the set of sibling pages somehow contains
8127 ** duplicate entries. This can happen if the database is corrupt.
8128 ** It would be simpler to detect this as part of the loop below, but
drhba0f9992014-10-30 20:48:44 +00008129 ** we do the detection here in order to avoid populating the pager
8130 ** cache with two separate objects associated with the same
8131 ** page number. */
dan89ca0b32014-10-25 20:36:28 +00008132 assert( CORRUPT_DB );
8133 rc = SQLITE_CORRUPT_BKPT;
8134 goto balance_cleanup;
drhf9ffac92002-03-02 19:00:31 +00008135 }
8136 }
dan33ea4862014-10-09 19:35:37 +00008137 }
8138 for(i=0; i<nNew; i++){
dan31f4e992014-10-24 20:57:03 +00008139 int iBest = 0; /* aPgno[] index of page number to use */
dan31f4e992014-10-24 20:57:03 +00008140 for(j=1; j<nNew; j++){
drh00fe08a2014-10-31 00:05:23 +00008141 if( aPgOrder[j]<aPgOrder[iBest] ) iBest = j;
drhf9ffac92002-03-02 19:00:31 +00008142 }
drh00fe08a2014-10-31 00:05:23 +00008143 pgno = aPgOrder[iBest];
8144 aPgOrder[iBest] = 0xffffffff;
dan31f4e992014-10-24 20:57:03 +00008145 if( iBest!=i ){
8146 if( iBest>i ){
8147 sqlite3PagerRekey(apNew[iBest]->pDbPage, pBt->nPage+iBest+1, 0);
8148 }
8149 sqlite3PagerRekey(apNew[i]->pDbPage, pgno, aPgFlags[iBest]);
8150 apNew[i]->pgno = pgno;
drhf9ffac92002-03-02 19:00:31 +00008151 }
8152 }
dan33ea4862014-10-09 19:35:37 +00008153
8154 TRACE(("BALANCE: new: %d(%d nc=%d) %d(%d nc=%d) %d(%d nc=%d) "
8155 "%d(%d nc=%d) %d(%d nc=%d)\n",
8156 apNew[0]->pgno, szNew[0], cntNew[0],
danielk19774dbaa892009-06-16 16:50:22 +00008157 nNew>=2 ? apNew[1]->pgno : 0, nNew>=2 ? szNew[1] : 0,
dan33ea4862014-10-09 19:35:37 +00008158 nNew>=2 ? cntNew[1] - cntNew[0] - !leafData : 0,
danielk19774dbaa892009-06-16 16:50:22 +00008159 nNew>=3 ? apNew[2]->pgno : 0, nNew>=3 ? szNew[2] : 0,
dan33ea4862014-10-09 19:35:37 +00008160 nNew>=3 ? cntNew[2] - cntNew[1] - !leafData : 0,
danielk19774dbaa892009-06-16 16:50:22 +00008161 nNew>=4 ? apNew[3]->pgno : 0, nNew>=4 ? szNew[3] : 0,
dan33ea4862014-10-09 19:35:37 +00008162 nNew>=4 ? cntNew[3] - cntNew[2] - !leafData : 0,
8163 nNew>=5 ? apNew[4]->pgno : 0, nNew>=5 ? szNew[4] : 0,
8164 nNew>=5 ? cntNew[4] - cntNew[3] - !leafData : 0
8165 ));
danielk19774dbaa892009-06-16 16:50:22 +00008166
8167 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
drh55f66b32019-07-16 19:44:32 +00008168 assert( nNew>=1 && nNew<=ArraySize(apNew) );
8169 assert( apNew[nNew-1]!=0 );
danielk19774dbaa892009-06-16 16:50:22 +00008170 put4byte(pRight, apNew[nNew-1]->pgno);
drh24cd67e2004-05-10 16:18:47 +00008171
dan33ea4862014-10-09 19:35:37 +00008172 /* If the sibling pages are not leaves, ensure that the right-child pointer
8173 ** of the right-most new sibling page is set to the value that was
8174 ** originally in the same field of the right-most old sibling page. */
8175 if( (pageFlags & PTF_LEAF)==0 && nOld!=nNew ){
8176 MemPage *pOld = (nNew>nOld ? apNew : apOld)[nOld-1];
8177 memcpy(&apNew[nNew-1]->aData[8], &pOld->aData[8], 4);
8178 }
danielk1977ac11ee62005-01-15 12:45:51 +00008179
dan33ea4862014-10-09 19:35:37 +00008180 /* Make any required updates to pointer map entries associated with
8181 ** cells stored on sibling pages following the balance operation. Pointer
8182 ** map entries associated with divider cells are set by the insertCell()
8183 ** routine. The associated pointer map entries are:
8184 **
8185 ** a) if the cell contains a reference to an overflow chain, the
8186 ** entry associated with the first page in the overflow chain, and
8187 **
8188 ** b) if the sibling pages are not leaves, the child page associated
8189 ** with the cell.
8190 **
8191 ** If the sibling pages are not leaves, then the pointer map entry
8192 ** associated with the right-child of each sibling may also need to be
8193 ** updated. This happens below, after the sibling pages have been
8194 ** populated, not here.
danielk1977ac11ee62005-01-15 12:45:51 +00008195 */
dan33ea4862014-10-09 19:35:37 +00008196 if( ISAUTOVACUUM ){
drh0f1bf4c2019-01-13 20:17:21 +00008197 MemPage *pOld;
8198 MemPage *pNew = pOld = apNew[0];
dan33ea4862014-10-09 19:35:37 +00008199 int cntOldNext = pNew->nCell + pNew->nOverflow;
dan33ea4862014-10-09 19:35:37 +00008200 int iNew = 0;
8201 int iOld = 0;
danielk1977ac11ee62005-01-15 12:45:51 +00008202
drh1ffd2472015-06-23 02:37:30 +00008203 for(i=0; i<b.nCell; i++){
8204 u8 *pCell = b.apCell[i];
drh9c7e44c2019-02-14 15:27:12 +00008205 while( i==cntOldNext ){
8206 iOld++;
8207 assert( iOld<nNew || iOld<nOld );
drhdd2d9a32019-05-07 17:47:43 +00008208 assert( iOld>=0 && iOld<NB );
drh9c7e44c2019-02-14 15:27:12 +00008209 pOld = iOld<nNew ? apNew[iOld] : apOld[iOld];
dan33ea4862014-10-09 19:35:37 +00008210 cntOldNext += pOld->nCell + pOld->nOverflow + !leafData;
drh4b70f112004-05-02 21:12:19 +00008211 }
dan33ea4862014-10-09 19:35:37 +00008212 if( i==cntNew[iNew] ){
8213 pNew = apNew[++iNew];
8214 if( !leafData ) continue;
8215 }
danielk197785d90ca2008-07-19 14:25:15 +00008216
dan33ea4862014-10-09 19:35:37 +00008217 /* Cell pCell is destined for new sibling page pNew. Originally, it
drhba0f9992014-10-30 20:48:44 +00008218 ** was either part of sibling page iOld (possibly an overflow cell),
dan33ea4862014-10-09 19:35:37 +00008219 ** or else the divider cell to the left of sibling page iOld. So,
8220 ** if sibling page iOld had the same page number as pNew, and if
8221 ** pCell really was a part of sibling page iOld (not a divider or
8222 ** overflow cell), we can skip updating the pointer map entries. */
drhd52d52b2014-12-06 02:05:44 +00008223 if( iOld>=nNew
8224 || pNew->pgno!=aPgno[iOld]
drh9c7e44c2019-02-14 15:27:12 +00008225 || !SQLITE_WITHIN(pCell,pOld->aData,pOld->aDataEnd)
drhd52d52b2014-12-06 02:05:44 +00008226 ){
dan33ea4862014-10-09 19:35:37 +00008227 if( !leafCorrection ){
8228 ptrmapPut(pBt, get4byte(pCell), PTRMAP_BTREE, pNew->pgno, &rc);
8229 }
drh1ffd2472015-06-23 02:37:30 +00008230 if( cachedCellSize(&b,i)>pNew->minLocal ){
drh0f1bf4c2019-01-13 20:17:21 +00008231 ptrmapPutOvflPtr(pNew, pOld, pCell, &rc);
danielk1977ac11ee62005-01-15 12:45:51 +00008232 }
drhea82b372015-06-23 21:35:28 +00008233 if( rc ) goto balance_cleanup;
drh43605152004-05-29 21:46:49 +00008234 }
drh14acc042001-06-10 19:56:58 +00008235 }
8236 }
dan33ea4862014-10-09 19:35:37 +00008237
8238 /* Insert new divider cells into pParent. */
8239 for(i=0; i<nNew-1; i++){
8240 u8 *pCell;
8241 u8 *pTemp;
8242 int sz;
drhc3c23f32021-05-06 11:02:55 +00008243 u8 *pSrcEnd;
dan33ea4862014-10-09 19:35:37 +00008244 MemPage *pNew = apNew[i];
8245 j = cntNew[i];
8246
8247 assert( j<nMaxCells );
drh1ffd2472015-06-23 02:37:30 +00008248 assert( b.apCell[j]!=0 );
8249 pCell = b.apCell[j];
8250 sz = b.szCell[j] + leafCorrection;
dan33ea4862014-10-09 19:35:37 +00008251 pTemp = &aOvflSpace[iOvflSpace];
8252 if( !pNew->leaf ){
8253 memcpy(&pNew->aData[8], pCell, 4);
8254 }else if( leafData ){
8255 /* If the tree is a leaf-data tree, and the siblings are leaves,
drh1ffd2472015-06-23 02:37:30 +00008256 ** then there is no divider cell in b.apCell[]. Instead, the divider
dan33ea4862014-10-09 19:35:37 +00008257 ** cell consists of the integer key for the right-most cell of
8258 ** the sibling-page assembled above only.
8259 */
8260 CellInfo info;
8261 j--;
drh1ffd2472015-06-23 02:37:30 +00008262 pNew->xParseCell(pNew, b.apCell[j], &info);
dan33ea4862014-10-09 19:35:37 +00008263 pCell = pTemp;
8264 sz = 4 + putVarint(&pCell[4], info.nKey);
8265 pTemp = 0;
8266 }else{
8267 pCell -= 4;
8268 /* Obscure case for non-leaf-data trees: If the cell at pCell was
8269 ** previously stored on a leaf node, and its reported size was 4
8270 ** bytes, then it may actually be smaller than this
8271 ** (see btreeParseCellPtr(), 4 bytes is the minimum size of
8272 ** any cell). But it is important to pass the correct size to
8273 ** insertCell(), so reparse the cell now.
8274 **
drhc1fb2b82016-03-09 03:29:27 +00008275 ** This can only happen for b-trees used to evaluate "IN (SELECT ...)"
8276 ** and WITHOUT ROWID tables with exactly one column which is the
8277 ** primary key.
dan33ea4862014-10-09 19:35:37 +00008278 */
drh1ffd2472015-06-23 02:37:30 +00008279 if( b.szCell[j]==4 ){
dan33ea4862014-10-09 19:35:37 +00008280 assert(leafCorrection==4);
drh25ada072015-06-19 15:07:14 +00008281 sz = pParent->xCellSize(pParent, pCell);
dan33ea4862014-10-09 19:35:37 +00008282 }
8283 }
8284 iOvflSpace += sz;
8285 assert( sz<=pBt->maxLocal+23 );
8286 assert( iOvflSpace <= (int)pBt->pageSize );
drhc3c23f32021-05-06 11:02:55 +00008287 for(k=0; b.ixNx[k]<=i && ALWAYS(k<NB*2); k++){}
8288 pSrcEnd = b.apEnd[k];
8289 if( SQLITE_WITHIN(pSrcEnd, pCell, pCell+sz) ){
8290 rc = SQLITE_CORRUPT_BKPT;
8291 goto balance_cleanup;
8292 }
dan33ea4862014-10-09 19:35:37 +00008293 insertCell(pParent, nxDiv+i, pCell, sz, pTemp, pNew->pgno, &rc);
drhd2cfbea2019-05-08 03:34:53 +00008294 if( rc!=SQLITE_OK ) goto balance_cleanup;
dan33ea4862014-10-09 19:35:37 +00008295 assert( sqlite3PagerIswriteable(pParent->pDbPage) );
8296 }
8297
8298 /* Now update the actual sibling pages. The order in which they are updated
8299 ** is important, as this code needs to avoid disrupting any page from which
8300 ** cells may still to be read. In practice, this means:
8301 **
drhd836d422014-10-31 14:26:36 +00008302 ** (1) If cells are moving left (from apNew[iPg] to apNew[iPg-1])
8303 ** then it is not safe to update page apNew[iPg] until after
8304 ** the left-hand sibling apNew[iPg-1] has been updated.
dan33ea4862014-10-09 19:35:37 +00008305 **
drhd836d422014-10-31 14:26:36 +00008306 ** (2) If cells are moving right (from apNew[iPg] to apNew[iPg+1])
8307 ** then it is not safe to update page apNew[iPg] until after
8308 ** the right-hand sibling apNew[iPg+1] has been updated.
dan33ea4862014-10-09 19:35:37 +00008309 **
8310 ** If neither of the above apply, the page is safe to update.
drhd836d422014-10-31 14:26:36 +00008311 **
8312 ** The iPg value in the following loop starts at nNew-1 goes down
8313 ** to 0, then back up to nNew-1 again, thus making two passes over
8314 ** the pages. On the initial downward pass, only condition (1) above
8315 ** needs to be tested because (2) will always be true from the previous
8316 ** step. On the upward pass, both conditions are always true, so the
8317 ** upwards pass simply processes pages that were missed on the downward
8318 ** pass.
dan33ea4862014-10-09 19:35:37 +00008319 */
drhbec021b2014-10-31 12:22:00 +00008320 for(i=1-nNew; i<nNew; i++){
8321 int iPg = i<0 ? -i : i;
drhbec021b2014-10-31 12:22:00 +00008322 assert( iPg>=0 && iPg<nNew );
drhd836d422014-10-31 14:26:36 +00008323 if( abDone[iPg] ) continue; /* Skip pages already processed */
8324 if( i>=0 /* On the upwards pass, or... */
8325 || cntOld[iPg-1]>=cntNew[iPg-1] /* Condition (1) is true */
dan33ea4862014-10-09 19:35:37 +00008326 ){
dan09c68402014-10-11 20:00:24 +00008327 int iNew;
8328 int iOld;
8329 int nNewCell;
8330
drhd836d422014-10-31 14:26:36 +00008331 /* Verify condition (1): If cells are moving left, update iPg
8332 ** only after iPg-1 has already been updated. */
8333 assert( iPg==0 || cntOld[iPg-1]>=cntNew[iPg-1] || abDone[iPg-1] );
8334
8335 /* Verify condition (2): If cells are moving right, update iPg
8336 ** only after iPg+1 has already been updated. */
8337 assert( cntNew[iPg]>=cntOld[iPg] || abDone[iPg+1] );
8338
dan09c68402014-10-11 20:00:24 +00008339 if( iPg==0 ){
8340 iNew = iOld = 0;
8341 nNewCell = cntNew[0];
8342 }else{
drh1ffd2472015-06-23 02:37:30 +00008343 iOld = iPg<nOld ? (cntOld[iPg-1] + !leafData) : b.nCell;
dan09c68402014-10-11 20:00:24 +00008344 iNew = cntNew[iPg-1] + !leafData;
8345 nNewCell = cntNew[iPg] - iNew;
8346 }
8347
drh1ffd2472015-06-23 02:37:30 +00008348 rc = editPage(apNew[iPg], iOld, iNew, nNewCell, &b);
drh658873b2015-06-22 20:02:04 +00008349 if( rc ) goto balance_cleanup;
drhd836d422014-10-31 14:26:36 +00008350 abDone[iPg]++;
dand7b545b2014-10-13 18:03:27 +00008351 apNew[iPg]->nFree = usableSpace-szNew[iPg];
dan09c68402014-10-11 20:00:24 +00008352 assert( apNew[iPg]->nOverflow==0 );
8353 assert( apNew[iPg]->nCell==nNewCell );
dan33ea4862014-10-09 19:35:37 +00008354 }
8355 }
drhd836d422014-10-31 14:26:36 +00008356
8357 /* All pages have been processed exactly once */
dan33ea4862014-10-09 19:35:37 +00008358 assert( memcmp(abDone, "\01\01\01\01\01", nNew)==0 );
8359
drh7aa8f852006-03-28 00:24:44 +00008360 assert( nOld>0 );
8361 assert( nNew>0 );
drh14acc042001-06-10 19:56:58 +00008362
danielk197713bd99f2009-06-24 05:40:34 +00008363 if( isRoot && pParent->nCell==0 && pParent->hdrOffset<=apNew[0]->nFree ){
8364 /* The root page of the b-tree now contains no cells. The only sibling
8365 ** page is the right-child of the parent. Copy the contents of the
8366 ** child page into the parent, decreasing the overall height of the
8367 ** b-tree structure by one. This is described as the "balance-shallower"
8368 ** sub-algorithm in some documentation.
8369 **
8370 ** If this is an auto-vacuum database, the call to copyNodeContent()
8371 ** sets all pointer-map entries corresponding to database image pages
8372 ** for which the pointer is stored within the content being copied.
8373 **
drh768f2902014-10-31 02:51:41 +00008374 ** It is critical that the child page be defragmented before being
8375 ** copied into the parent, because if the parent is page 1 then it will
8376 ** by smaller than the child due to the database header, and so all the
8377 ** free space needs to be up front.
8378 */
drh9b5351d2015-09-30 14:19:08 +00008379 assert( nNew==1 || CORRUPT_DB );
dan3b2ede12017-02-25 16:24:02 +00008380 rc = defragmentPage(apNew[0], -1);
drh768f2902014-10-31 02:51:41 +00008381 testcase( rc!=SQLITE_OK );
danielk197713bd99f2009-06-24 05:40:34 +00008382 assert( apNew[0]->nFree ==
drh1c960262019-03-25 18:44:08 +00008383 (get2byteNotZero(&apNew[0]->aData[5]) - apNew[0]->cellOffset
8384 - apNew[0]->nCell*2)
drh768f2902014-10-31 02:51:41 +00008385 || rc!=SQLITE_OK
danielk197713bd99f2009-06-24 05:40:34 +00008386 );
drhc314dc72009-07-21 11:52:34 +00008387 copyNodeContent(apNew[0], pParent, &rc);
8388 freePage(apNew[0], &rc);
dan33ea4862014-10-09 19:35:37 +00008389 }else if( ISAUTOVACUUM && !leafCorrection ){
8390 /* Fix the pointer map entries associated with the right-child of each
8391 ** sibling page. All other pointer map entries have already been taken
8392 ** care of. */
8393 for(i=0; i<nNew; i++){
8394 u32 key = get4byte(&apNew[i]->aData[8]);
8395 ptrmapPut(pBt, key, PTRMAP_BTREE, apNew[i]->pgno, &rc);
danielk19774dbaa892009-06-16 16:50:22 +00008396 }
dan33ea4862014-10-09 19:35:37 +00008397 }
danielk19774dbaa892009-06-16 16:50:22 +00008398
dan33ea4862014-10-09 19:35:37 +00008399 assert( pParent->isInit );
8400 TRACE(("BALANCE: finished: old=%d new=%d cells=%d\n",
drh1ffd2472015-06-23 02:37:30 +00008401 nOld, nNew, b.nCell));
danielk19774dbaa892009-06-16 16:50:22 +00008402
dan33ea4862014-10-09 19:35:37 +00008403 /* Free any old pages that were not reused as new pages.
8404 */
8405 for(i=nNew; i<nOld; i++){
8406 freePage(apOld[i], &rc);
8407 }
danielk19774dbaa892009-06-16 16:50:22 +00008408
8409#if 0
dan33ea4862014-10-09 19:35:37 +00008410 if( ISAUTOVACUUM && rc==SQLITE_OK && apNew[0]->isInit ){
danielk19774dbaa892009-06-16 16:50:22 +00008411 /* The ptrmapCheckPages() contains assert() statements that verify that
8412 ** all pointer map pages are set correctly. This is helpful while
8413 ** debugging. This is usually disabled because a corrupt database may
8414 ** cause an assert() statement to fail. */
8415 ptrmapCheckPages(apNew, nNew);
8416 ptrmapCheckPages(&pParent, 1);
danielk19774dbaa892009-06-16 16:50:22 +00008417 }
dan33ea4862014-10-09 19:35:37 +00008418#endif
danielk1977cd581a72009-06-23 15:43:39 +00008419
drh8b2f49b2001-06-08 00:21:52 +00008420 /*
drh14acc042001-06-10 19:56:58 +00008421 ** Cleanup before returning.
drh8b2f49b2001-06-08 00:21:52 +00008422 */
drh14acc042001-06-10 19:56:58 +00008423balance_cleanup:
drhb2a0f752017-08-28 15:51:35 +00008424 sqlite3StackFree(0, b.apCell);
drh8b2f49b2001-06-08 00:21:52 +00008425 for(i=0; i<nOld; i++){
drh91025292004-05-03 19:49:32 +00008426 releasePage(apOld[i]);
drh8b2f49b2001-06-08 00:21:52 +00008427 }
drh14acc042001-06-10 19:56:58 +00008428 for(i=0; i<nNew; i++){
drh91025292004-05-03 19:49:32 +00008429 releasePage(apNew[i]);
drh8b2f49b2001-06-08 00:21:52 +00008430 }
danielk1977eaa06f62008-09-18 17:34:44 +00008431
drh8b2f49b2001-06-08 00:21:52 +00008432 return rc;
8433}
8434
drh43605152004-05-29 21:46:49 +00008435
8436/*
danielk1977a50d9aa2009-06-08 14:49:45 +00008437** This function is called when the root page of a b-tree structure is
8438** overfull (has one or more overflow pages).
drh43605152004-05-29 21:46:49 +00008439**
danielk1977a50d9aa2009-06-08 14:49:45 +00008440** A new child page is allocated and the contents of the current root
8441** page, including overflow cells, are copied into the child. The root
8442** page is then overwritten to make it an empty page with the right-child
8443** pointer pointing to the new page.
8444**
8445** Before returning, all pointer-map entries corresponding to pages
8446** that the new child-page now contains pointers to are updated. The
8447** entry corresponding to the new right-child pointer of the root
8448** page is also updated.
8449**
8450** If successful, *ppChild is set to contain a reference to the child
8451** page and SQLITE_OK is returned. In this case the caller is required
8452** to call releasePage() on *ppChild exactly once. If an error occurs,
8453** an error code is returned and *ppChild is set to 0.
drh43605152004-05-29 21:46:49 +00008454*/
danielk1977a50d9aa2009-06-08 14:49:45 +00008455static int balance_deeper(MemPage *pRoot, MemPage **ppChild){
8456 int rc; /* Return value from subprocedures */
8457 MemPage *pChild = 0; /* Pointer to a new child page */
shane5eff7cf2009-08-10 03:57:58 +00008458 Pgno pgnoChild = 0; /* Page number of the new child page */
danielk1977a50d9aa2009-06-08 14:49:45 +00008459 BtShared *pBt = pRoot->pBt; /* The BTree */
drh43605152004-05-29 21:46:49 +00008460
danielk1977a50d9aa2009-06-08 14:49:45 +00008461 assert( pRoot->nOverflow>0 );
drh1fee73e2007-08-29 04:00:57 +00008462 assert( sqlite3_mutex_held(pBt->mutex) );
danielk1977bc2ca9e2008-11-13 14:28:28 +00008463
danielk1977a50d9aa2009-06-08 14:49:45 +00008464 /* Make pRoot, the root page of the b-tree, writable. Allocate a new
8465 ** page that will become the new right-child of pPage. Copy the contents
8466 ** of the node stored on pRoot into the new child page.
8467 */
drh98add2e2009-07-20 17:11:49 +00008468 rc = sqlite3PagerWrite(pRoot->pDbPage);
8469 if( rc==SQLITE_OK ){
8470 rc = allocateBtreePage(pBt,&pChild,&pgnoChild,pRoot->pgno,0);
drhc314dc72009-07-21 11:52:34 +00008471 copyNodeContent(pRoot, pChild, &rc);
8472 if( ISAUTOVACUUM ){
8473 ptrmapPut(pBt, pgnoChild, PTRMAP_BTREE, pRoot->pgno, &rc);
drh98add2e2009-07-20 17:11:49 +00008474 }
8475 }
8476 if( rc ){
danielk1977a50d9aa2009-06-08 14:49:45 +00008477 *ppChild = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00008478 releasePage(pChild);
danielk1977a50d9aa2009-06-08 14:49:45 +00008479 return rc;
danielk197771d5d2c2008-09-29 11:49:47 +00008480 }
danielk1977a50d9aa2009-06-08 14:49:45 +00008481 assert( sqlite3PagerIswriteable(pChild->pDbPage) );
8482 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
drh12fe9a02019-02-19 16:42:54 +00008483 assert( pChild->nCell==pRoot->nCell || CORRUPT_DB );
danielk197771d5d2c2008-09-29 11:49:47 +00008484
danielk1977a50d9aa2009-06-08 14:49:45 +00008485 TRACE(("BALANCE: copy root %d into %d\n", pRoot->pgno, pChild->pgno));
8486
8487 /* Copy the overflow cells from pRoot to pChild */
drh2cbd78b2012-02-02 19:37:18 +00008488 memcpy(pChild->aiOvfl, pRoot->aiOvfl,
8489 pRoot->nOverflow*sizeof(pRoot->aiOvfl[0]));
8490 memcpy(pChild->apOvfl, pRoot->apOvfl,
8491 pRoot->nOverflow*sizeof(pRoot->apOvfl[0]));
danielk1977a50d9aa2009-06-08 14:49:45 +00008492 pChild->nOverflow = pRoot->nOverflow;
danielk1977a50d9aa2009-06-08 14:49:45 +00008493
8494 /* Zero the contents of pRoot. Then install pChild as the right-child. */
8495 zeroPage(pRoot, pChild->aData[0] & ~PTF_LEAF);
8496 put4byte(&pRoot->aData[pRoot->hdrOffset+8], pgnoChild);
8497
8498 *ppChild = pChild;
8499 return SQLITE_OK;
drh43605152004-05-29 21:46:49 +00008500}
8501
8502/*
drha2d50282019-12-23 18:02:15 +00008503** Return SQLITE_CORRUPT if any cursor other than pCur is currently valid
8504** on the same B-tree as pCur.
8505**
8506** This can if a database is corrupt with two or more SQL tables
8507** pointing to the same b-tree. If an insert occurs on one SQL table
8508** and causes a BEFORE TRIGGER to do a secondary insert on the other SQL
8509** table linked to the same b-tree. If the secondary insert causes a
8510** rebalance, that can change content out from under the cursor on the
8511** first SQL table, violating invariants on the first insert.
8512*/
8513static int anotherValidCursor(BtCursor *pCur){
8514 BtCursor *pOther;
8515 for(pOther=pCur->pBt->pCursor; pOther; pOther=pOther->pNext){
8516 if( pOther!=pCur
8517 && pOther->eState==CURSOR_VALID
8518 && pOther->pPage==pCur->pPage
8519 ){
8520 return SQLITE_CORRUPT_BKPT;
8521 }
8522 }
8523 return SQLITE_OK;
8524}
8525
8526/*
danielk197771d5d2c2008-09-29 11:49:47 +00008527** The page that pCur currently points to has just been modified in
8528** some way. This function figures out if this modification means the
8529** tree needs to be balanced, and if so calls the appropriate balancing
danielk1977a50d9aa2009-06-08 14:49:45 +00008530** routine. Balancing routines are:
8531**
8532** balance_quick()
danielk1977a50d9aa2009-06-08 14:49:45 +00008533** balance_deeper()
8534** balance_nonroot()
drh43605152004-05-29 21:46:49 +00008535*/
danielk1977a50d9aa2009-06-08 14:49:45 +00008536static int balance(BtCursor *pCur){
drh43605152004-05-29 21:46:49 +00008537 int rc = SQLITE_OK;
danielk1977a50d9aa2009-06-08 14:49:45 +00008538 const int nMin = pCur->pBt->usableSize * 2 / 3;
8539 u8 aBalanceQuickSpace[13];
8540 u8 *pFree = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00008541
drhcc5f8a42016-02-06 22:32:06 +00008542 VVA_ONLY( int balance_quick_called = 0 );
8543 VVA_ONLY( int balance_deeper_called = 0 );
danielk1977a50d9aa2009-06-08 14:49:45 +00008544
8545 do {
dan01fd42b2019-07-13 09:55:33 +00008546 int iPage;
drh352a35a2017-08-15 03:46:47 +00008547 MemPage *pPage = pCur->pPage;
danielk1977a50d9aa2009-06-08 14:49:45 +00008548
drha941ff72019-02-12 00:58:10 +00008549 if( NEVER(pPage->nFree<0) && btreeComputeFreeSpace(pPage) ) break;
dan01fd42b2019-07-13 09:55:33 +00008550 if( pPage->nOverflow==0 && pPage->nFree<=nMin ){
8551 break;
8552 }else if( (iPage = pCur->iPage)==0 ){
drha2d50282019-12-23 18:02:15 +00008553 if( pPage->nOverflow && (rc = anotherValidCursor(pCur))==SQLITE_OK ){
danielk1977a50d9aa2009-06-08 14:49:45 +00008554 /* The root page of the b-tree is overfull. In this case call the
8555 ** balance_deeper() function to create a new child for the root-page
8556 ** and copy the current contents of the root-page to it. The
8557 ** next iteration of the do-loop will balance the child page.
8558 */
drhcc5f8a42016-02-06 22:32:06 +00008559 assert( balance_deeper_called==0 );
8560 VVA_ONLY( balance_deeper_called++ );
danielk1977a50d9aa2009-06-08 14:49:45 +00008561 rc = balance_deeper(pPage, &pCur->apPage[1]);
8562 if( rc==SQLITE_OK ){
8563 pCur->iPage = 1;
drh75e96b32017-04-01 00:20:06 +00008564 pCur->ix = 0;
danielk1977a50d9aa2009-06-08 14:49:45 +00008565 pCur->aiIdx[0] = 0;
drh352a35a2017-08-15 03:46:47 +00008566 pCur->apPage[0] = pPage;
8567 pCur->pPage = pCur->apPage[1];
8568 assert( pCur->pPage->nOverflow );
danielk1977a50d9aa2009-06-08 14:49:45 +00008569 }
danielk1977a50d9aa2009-06-08 14:49:45 +00008570 }else{
danielk1977a50d9aa2009-06-08 14:49:45 +00008571 break;
8572 }
danielk1977a50d9aa2009-06-08 14:49:45 +00008573 }else{
8574 MemPage * const pParent = pCur->apPage[iPage-1];
8575 int const iIdx = pCur->aiIdx[iPage-1];
8576
8577 rc = sqlite3PagerWrite(pParent->pDbPage);
drh68133502019-02-11 17:22:30 +00008578 if( rc==SQLITE_OK && pParent->nFree<0 ){
8579 rc = btreeComputeFreeSpace(pParent);
8580 }
danielk1977a50d9aa2009-06-08 14:49:45 +00008581 if( rc==SQLITE_OK ){
8582#ifndef SQLITE_OMIT_QUICKBALANCE
drh3e28ff52014-09-24 00:59:08 +00008583 if( pPage->intKeyLeaf
danielk1977a50d9aa2009-06-08 14:49:45 +00008584 && pPage->nOverflow==1
drh2cbd78b2012-02-02 19:37:18 +00008585 && pPage->aiOvfl[0]==pPage->nCell
danielk1977a50d9aa2009-06-08 14:49:45 +00008586 && pParent->pgno!=1
8587 && pParent->nCell==iIdx
8588 ){
8589 /* Call balance_quick() to create a new sibling of pPage on which
8590 ** to store the overflow cell. balance_quick() inserts a new cell
8591 ** into pParent, which may cause pParent overflow. If this
peter.d.reid60ec9142014-09-06 16:39:46 +00008592 ** happens, the next iteration of the do-loop will balance pParent
danielk1977a50d9aa2009-06-08 14:49:45 +00008593 ** use either balance_nonroot() or balance_deeper(). Until this
8594 ** happens, the overflow cell is stored in the aBalanceQuickSpace[]
8595 ** buffer.
8596 **
8597 ** The purpose of the following assert() is to check that only a
8598 ** single call to balance_quick() is made for each call to this
8599 ** function. If this were not verified, a subtle bug involving reuse
8600 ** of the aBalanceQuickSpace[] might sneak in.
8601 */
drhcc5f8a42016-02-06 22:32:06 +00008602 assert( balance_quick_called==0 );
8603 VVA_ONLY( balance_quick_called++ );
danielk1977a50d9aa2009-06-08 14:49:45 +00008604 rc = balance_quick(pParent, pPage, aBalanceQuickSpace);
8605 }else
8606#endif
8607 {
8608 /* In this case, call balance_nonroot() to redistribute cells
8609 ** between pPage and up to 2 of its sibling pages. This involves
8610 ** modifying the contents of pParent, which may cause pParent to
8611 ** become overfull or underfull. The next iteration of the do-loop
8612 ** will balance the parent page to correct this.
8613 **
8614 ** If the parent page becomes overfull, the overflow cell or cells
8615 ** are stored in the pSpace buffer allocated immediately below.
8616 ** A subsequent iteration of the do-loop will deal with this by
8617 ** calling balance_nonroot() (balance_deeper() may be called first,
8618 ** but it doesn't deal with overflow cells - just moves them to a
8619 ** different page). Once this subsequent call to balance_nonroot()
8620 ** has completed, it is safe to release the pSpace buffer used by
8621 ** the previous call, as the overflow cell data will have been
8622 ** copied either into the body of a database page or into the new
8623 ** pSpace buffer passed to the latter call to balance_nonroot().
8624 */
8625 u8 *pSpace = sqlite3PageMalloc(pCur->pBt->pageSize);
drhe0997b32015-03-20 14:57:50 +00008626 rc = balance_nonroot(pParent, iIdx, pSpace, iPage==1,
8627 pCur->hints&BTREE_BULKLOAD);
danielk1977a50d9aa2009-06-08 14:49:45 +00008628 if( pFree ){
8629 /* If pFree is not NULL, it points to the pSpace buffer used
8630 ** by a previous call to balance_nonroot(). Its contents are
8631 ** now stored either on real database pages or within the
8632 ** new pSpace buffer, so it may be safely freed here. */
8633 sqlite3PageFree(pFree);
8634 }
8635
danielk19774dbaa892009-06-16 16:50:22 +00008636 /* The pSpace buffer will be freed after the next call to
8637 ** balance_nonroot(), or just before this function returns, whichever
8638 ** comes first. */
danielk1977a50d9aa2009-06-08 14:49:45 +00008639 pFree = pSpace;
danielk1977a50d9aa2009-06-08 14:49:45 +00008640 }
8641 }
8642
8643 pPage->nOverflow = 0;
8644
8645 /* The next iteration of the do-loop balances the parent page. */
8646 releasePage(pPage);
8647 pCur->iPage--;
drhcbd33492015-03-25 13:06:54 +00008648 assert( pCur->iPage>=0 );
drh352a35a2017-08-15 03:46:47 +00008649 pCur->pPage = pCur->apPage[pCur->iPage];
drh43605152004-05-29 21:46:49 +00008650 }
danielk1977a50d9aa2009-06-08 14:49:45 +00008651 }while( rc==SQLITE_OK );
8652
8653 if( pFree ){
8654 sqlite3PageFree(pFree);
drh43605152004-05-29 21:46:49 +00008655 }
8656 return rc;
8657}
8658
drh3de5d162018-05-03 03:59:02 +00008659/* Overwrite content from pX into pDest. Only do the write if the
8660** content is different from what is already there.
8661*/
8662static int btreeOverwriteContent(
8663 MemPage *pPage, /* MemPage on which writing will occur */
8664 u8 *pDest, /* Pointer to the place to start writing */
8665 const BtreePayload *pX, /* Source of data to write */
8666 int iOffset, /* Offset of first byte to write */
8667 int iAmt /* Number of bytes to be written */
8668){
8669 int nData = pX->nData - iOffset;
8670 if( nData<=0 ){
8671 /* Overwritting with zeros */
8672 int i;
8673 for(i=0; i<iAmt && pDest[i]==0; i++){}
8674 if( i<iAmt ){
8675 int rc = sqlite3PagerWrite(pPage->pDbPage);
8676 if( rc ) return rc;
8677 memset(pDest + i, 0, iAmt - i);
8678 }
8679 }else{
8680 if( nData<iAmt ){
8681 /* Mixed read data and zeros at the end. Make a recursive call
8682 ** to write the zeros then fall through to write the real data */
drhd5aa9262018-05-03 16:56:06 +00008683 int rc = btreeOverwriteContent(pPage, pDest+nData, pX, iOffset+nData,
8684 iAmt-nData);
8685 if( rc ) return rc;
drh3de5d162018-05-03 03:59:02 +00008686 iAmt = nData;
8687 }
8688 if( memcmp(pDest, ((u8*)pX->pData) + iOffset, iAmt)!=0 ){
8689 int rc = sqlite3PagerWrite(pPage->pDbPage);
8690 if( rc ) return rc;
drh55469bb2019-01-24 13:36:47 +00008691 /* In a corrupt database, it is possible for the source and destination
8692 ** buffers to overlap. This is harmless since the database is already
8693 ** corrupt but it does cause valgrind and ASAN warnings. So use
8694 ** memmove(). */
8695 memmove(pDest, ((u8*)pX->pData) + iOffset, iAmt);
drh3de5d162018-05-03 03:59:02 +00008696 }
8697 }
8698 return SQLITE_OK;
8699}
8700
8701/*
8702** Overwrite the cell that cursor pCur is pointing to with fresh content
8703** contained in pX.
8704*/
8705static int btreeOverwriteCell(BtCursor *pCur, const BtreePayload *pX){
8706 int iOffset; /* Next byte of pX->pData to write */
8707 int nTotal = pX->nData + pX->nZero; /* Total bytes of to write */
8708 int rc; /* Return code */
8709 MemPage *pPage = pCur->pPage; /* Page being written */
8710 BtShared *pBt; /* Btree */
8711 Pgno ovflPgno; /* Next overflow page to write */
8712 u32 ovflPageSize; /* Size to write on overflow page */
8713
drh27e80a32019-08-15 13:17:49 +00008714 if( pCur->info.pPayload + pCur->info.nLocal > pPage->aDataEnd
8715 || pCur->info.pPayload < pPage->aData + pPage->cellOffset
8716 ){
drh4f84e9c2018-05-03 13:56:23 +00008717 return SQLITE_CORRUPT_BKPT;
8718 }
drh3de5d162018-05-03 03:59:02 +00008719 /* Overwrite the local portion first */
8720 rc = btreeOverwriteContent(pPage, pCur->info.pPayload, pX,
8721 0, pCur->info.nLocal);
8722 if( rc ) return rc;
8723 if( pCur->info.nLocal==nTotal ) return SQLITE_OK;
8724
8725 /* Now overwrite the overflow pages */
8726 iOffset = pCur->info.nLocal;
drh30f7a252018-05-07 11:29:59 +00008727 assert( nTotal>=0 );
8728 assert( iOffset>=0 );
drh3de5d162018-05-03 03:59:02 +00008729 ovflPgno = get4byte(pCur->info.pPayload + iOffset);
8730 pBt = pPage->pBt;
8731 ovflPageSize = pBt->usableSize - 4;
8732 do{
8733 rc = btreeGetPage(pBt, ovflPgno, &pPage, 0);
8734 if( rc ) return rc;
drh4f84e9c2018-05-03 13:56:23 +00008735 if( sqlite3PagerPageRefcount(pPage->pDbPage)!=1 ){
drhd5aa9262018-05-03 16:56:06 +00008736 rc = SQLITE_CORRUPT_BKPT;
drh3de5d162018-05-03 03:59:02 +00008737 }else{
drh30f7a252018-05-07 11:29:59 +00008738 if( iOffset+ovflPageSize<(u32)nTotal ){
drhd5aa9262018-05-03 16:56:06 +00008739 ovflPgno = get4byte(pPage->aData);
8740 }else{
8741 ovflPageSize = nTotal - iOffset;
8742 }
8743 rc = btreeOverwriteContent(pPage, pPage->aData+4, pX,
8744 iOffset, ovflPageSize);
drh3de5d162018-05-03 03:59:02 +00008745 }
drhd5aa9262018-05-03 16:56:06 +00008746 sqlite3PagerUnref(pPage->pDbPage);
drh3de5d162018-05-03 03:59:02 +00008747 if( rc ) return rc;
8748 iOffset += ovflPageSize;
drh3de5d162018-05-03 03:59:02 +00008749 }while( iOffset<nTotal );
8750 return SQLITE_OK;
8751}
8752
drhf74b8d92002-09-01 23:20:45 +00008753
8754/*
drh8eeb4462016-05-21 20:03:42 +00008755** Insert a new record into the BTree. The content of the new record
8756** is described by the pX object. The pCur cursor is used only to
8757** define what table the record should be inserted into, and is left
8758** pointing at a random location.
drh4b70f112004-05-02 21:12:19 +00008759**
drh8eeb4462016-05-21 20:03:42 +00008760** For a table btree (used for rowid tables), only the pX.nKey value of
8761** the key is used. The pX.pKey value must be NULL. The pX.nKey is the
8762** rowid or INTEGER PRIMARY KEY of the row. The pX.nData,pData,nZero fields
8763** hold the content of the row.
8764**
8765** For an index btree (used for indexes and WITHOUT ROWID tables), the
8766** key is an arbitrary byte sequence stored in pX.pKey,nKey. The
8767** pX.pData,nData,nZero fields must be zero.
danielk1977de630352009-05-04 11:42:29 +00008768**
8769** If the seekResult parameter is non-zero, then a successful call to
drheaf6ae22016-11-09 20:14:34 +00008770** MovetoUnpacked() to seek cursor pCur to (pKey,nKey) has already
8771** been performed. In other words, if seekResult!=0 then the cursor
8772** is currently pointing to a cell that will be adjacent to the cell
8773** to be inserted. If seekResult<0 then pCur points to a cell that is
8774** smaller then (pKey,nKey). If seekResult>0 then pCur points to a cell
8775** that is larger than (pKey,nKey).
danielk1977de630352009-05-04 11:42:29 +00008776**
drheaf6ae22016-11-09 20:14:34 +00008777** If seekResult==0, that means pCur is pointing at some unknown location.
8778** In that case, this routine must seek the cursor to the correct insertion
8779** point for (pKey,nKey) before doing the insertion. For index btrees,
8780** if pX->nMem is non-zero, then pX->aMem contains pointers to the unpacked
8781** key values and pX->aMem can be used instead of pX->pKey to avoid having
8782** to decode the key.
drh3b7511c2001-05-26 13:15:44 +00008783*/
drh3aac2dd2004-04-26 14:10:20 +00008784int sqlite3BtreeInsert(
drh5c4d9702001-08-20 00:33:58 +00008785 BtCursor *pCur, /* Insert data into the table of this cursor */
drh8eeb4462016-05-21 20:03:42 +00008786 const BtreePayload *pX, /* Content of the row to be inserted */
danf91c1312017-01-10 20:04:38 +00008787 int flags, /* True if this is likely an append */
danielk19773509a652009-07-06 18:56:13 +00008788 int seekResult /* Result of prior MovetoUnpacked() call */
drh3b7511c2001-05-26 13:15:44 +00008789){
drh3b7511c2001-05-26 13:15:44 +00008790 int rc;
drh3e9ca092009-09-08 01:14:48 +00008791 int loc = seekResult; /* -1: before desired location +1: after */
drh1d452e12009-11-01 19:26:59 +00008792 int szNew = 0;
danielk197771d5d2c2008-09-29 11:49:47 +00008793 int idx;
drh3b7511c2001-05-26 13:15:44 +00008794 MemPage *pPage;
drhd677b3d2007-08-20 22:48:41 +00008795 Btree *p = pCur->pBtree;
8796 BtShared *pBt = p->pBt;
drha34b6762004-05-07 13:30:42 +00008797 unsigned char *oldCell;
drh2e38c322004-09-03 18:38:44 +00008798 unsigned char *newCell = 0;
drh3b7511c2001-05-26 13:15:44 +00008799
dancd1b2d02020-12-09 20:33:51 +00008800 assert( (flags & (BTREE_SAVEPOSITION|BTREE_APPEND|BTREE_PREFORMAT))==flags );
dan7aae7352020-12-10 18:06:24 +00008801 assert( (flags & BTREE_PREFORMAT)==0 || seekResult || pCur->pKeyInfo==0 );
danf91c1312017-01-10 20:04:38 +00008802
danf5ea93b2021-04-08 19:39:00 +00008803 if( pCur->eState==CURSOR_FAULT ){
8804 assert( pCur->skipNext!=SQLITE_OK );
8805 return pCur->skipNext;
drh98add2e2009-07-20 17:11:49 +00008806 }
8807
dan7a2347e2016-01-07 16:43:54 +00008808 assert( cursorOwnsBtShared(pCur) );
drh3f387402014-09-24 01:23:00 +00008809 assert( (pCur->curFlags & BTCF_WriteFlag)!=0
8810 && pBt->inTransaction==TRANS_WRITE
drhc9166342012-01-05 23:32:06 +00008811 && (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk197796d48e92009-06-29 06:00:37 +00008812 assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
8813
danielk197731d31b82009-07-13 13:18:07 +00008814 /* Assert that the caller has been consistent. If this cursor was opened
8815 ** expecting an index b-tree, then the caller should be inserting blob
8816 ** keys with no associated data. If the cursor was opened expecting an
8817 ** intkey table, the caller should be inserting integer keys with a
8818 ** blob of associated data. */
dan855aed12020-12-11 19:01:24 +00008819 assert( (flags & BTREE_PREFORMAT) || (pX->pKey==0)==(pCur->pKeyInfo==0) );
danielk197731d31b82009-07-13 13:18:07 +00008820
danielk19779c3acf32009-05-02 07:36:49 +00008821 /* Save the positions of any other cursors open on this table.
8822 **
danielk19773509a652009-07-06 18:56:13 +00008823 ** In some cases, the call to btreeMoveto() below is a no-op. For
danielk19779c3acf32009-05-02 07:36:49 +00008824 ** example, when inserting data into a table with auto-generated integer
8825 ** keys, the VDBE layer invokes sqlite3BtreeLast() to figure out the
8826 ** integer key to use. It then calls this function to actually insert the
danielk19773509a652009-07-06 18:56:13 +00008827 ** data into the intkey B-Tree. In this case btreeMoveto() recognizes
danielk19779c3acf32009-05-02 07:36:49 +00008828 ** that the cursor is already where it needs to be and returns without
8829 ** doing any work. To avoid thwarting these optimizations, it is important
8830 ** not to clear the cursor here.
8831 */
drh27fb7462015-06-30 02:47:36 +00008832 if( pCur->curFlags & BTCF_Multiple ){
8833 rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
8834 if( rc ) return rc;
danf5ea93b2021-04-08 19:39:00 +00008835 if( loc && pCur->iPage<0 ){
8836 /* This can only happen if the schema is corrupt such that there is more
8837 ** than one table or index with the same root page as used by the cursor.
8838 ** Which can only happen if the SQLITE_NoSchemaError flag was set when
8839 ** the schema was loaded. This cannot be asserted though, as a user might
8840 ** set the flag, load the schema, and then unset the flag. */
8841 return SQLITE_CORRUPT_BKPT;
8842 }
drhd60f4f42012-03-23 14:23:52 +00008843 }
8844
danielk197771d5d2c2008-09-29 11:49:47 +00008845 if( pCur->pKeyInfo==0 ){
drh8eeb4462016-05-21 20:03:42 +00008846 assert( pX->pKey==0 );
drhe0670b62014-02-12 21:31:12 +00008847 /* If this is an insert into a table b-tree, invalidate any incrblob
8848 ** cursors open on the row being replaced */
drh49bb56e2021-05-14 20:01:36 +00008849 if( p->hasIncrblobCur ){
8850 invalidateIncrblobCursors(p, pCur->pgnoRoot, pX->nKey, 0);
8851 }
drhe0670b62014-02-12 21:31:12 +00008852
danf91c1312017-01-10 20:04:38 +00008853 /* If BTREE_SAVEPOSITION is set, the cursor must already be pointing
drhd720d392018-05-07 17:27:04 +00008854 ** to a row with the same key as the new entry being inserted.
8855 */
8856#ifdef SQLITE_DEBUG
8857 if( flags & BTREE_SAVEPOSITION ){
8858 assert( pCur->curFlags & BTCF_ValidNKey );
8859 assert( pX->nKey==pCur->info.nKey );
drhd720d392018-05-07 17:27:04 +00008860 assert( loc==0 );
8861 }
8862#endif
danf91c1312017-01-10 20:04:38 +00008863
drhd720d392018-05-07 17:27:04 +00008864 /* On the other hand, BTREE_SAVEPOSITION==0 does not imply
8865 ** that the cursor is not pointing to a row to be overwritten.
8866 ** So do a complete check.
8867 */
drh7a1c28d2016-11-10 20:42:08 +00008868 if( (pCur->curFlags&BTCF_ValidNKey)!=0 && pX->nKey==pCur->info.nKey ){
drhd720d392018-05-07 17:27:04 +00008869 /* The cursor is pointing to the entry that is to be
drh3de5d162018-05-03 03:59:02 +00008870 ** overwritten */
drh30f7a252018-05-07 11:29:59 +00008871 assert( pX->nData>=0 && pX->nZero>=0 );
8872 if( pCur->info.nSize!=0
8873 && pCur->info.nPayload==(u32)pX->nData+pX->nZero
8874 ){
drhd720d392018-05-07 17:27:04 +00008875 /* New entry is the same size as the old. Do an overwrite */
drh3de5d162018-05-03 03:59:02 +00008876 return btreeOverwriteCell(pCur, pX);
8877 }
drhd720d392018-05-07 17:27:04 +00008878 assert( loc==0 );
drh207c8172015-06-29 23:01:32 +00008879 }else if( loc==0 ){
drhd720d392018-05-07 17:27:04 +00008880 /* The cursor is *not* pointing to the cell to be overwritten, nor
8881 ** to an adjacent cell. Move the cursor so that it is pointing either
8882 ** to the cell to be overwritten or an adjacent cell.
8883 */
drh42a410d2021-06-19 18:32:20 +00008884 rc = sqlite3BtreeTableMoveto(pCur, pX->nKey,
8885 (flags & BTREE_APPEND)!=0, &loc);
drh207c8172015-06-29 23:01:32 +00008886 if( rc ) return rc;
drhe0670b62014-02-12 21:31:12 +00008887 }
drhd720d392018-05-07 17:27:04 +00008888 }else{
8889 /* This is an index or a WITHOUT ROWID table */
8890
8891 /* If BTREE_SAVEPOSITION is set, the cursor must already be pointing
8892 ** to a row with the same key as the new entry being inserted.
8893 */
8894 assert( (flags & BTREE_SAVEPOSITION)==0 || loc==0 );
8895
8896 /* If the cursor is not already pointing either to the cell to be
8897 ** overwritten, or if a new cell is being inserted, if the cursor is
8898 ** not pointing to an immediately adjacent cell, then move the cursor
8899 ** so that it does.
8900 */
8901 if( loc==0 && (flags & BTREE_SAVEPOSITION)==0 ){
8902 if( pX->nMem ){
8903 UnpackedRecord r;
8904 r.pKeyInfo = pCur->pKeyInfo;
8905 r.aMem = pX->aMem;
8906 r.nField = pX->nMem;
8907 r.default_rc = 0;
drhd720d392018-05-07 17:27:04 +00008908 r.eqSeen = 0;
drh42a410d2021-06-19 18:32:20 +00008909 rc = sqlite3BtreeIndexMoveto(pCur, &r, &loc);
drhd720d392018-05-07 17:27:04 +00008910 }else{
drh42a410d2021-06-19 18:32:20 +00008911 rc = btreeMoveto(pCur, pX->pKey, pX->nKey,
8912 (flags & BTREE_APPEND)!=0, &loc);
drhd720d392018-05-07 17:27:04 +00008913 }
8914 if( rc ) return rc;
drh9b4eaeb2016-11-09 00:10:33 +00008915 }
drh89ee2292018-05-07 18:41:19 +00008916
8917 /* If the cursor is currently pointing to an entry to be overwritten
8918 ** and the new content is the same as as the old, then use the
8919 ** overwrite optimization.
8920 */
8921 if( loc==0 ){
8922 getCellInfo(pCur);
8923 if( pCur->info.nKey==pX->nKey ){
8924 BtreePayload x2;
8925 x2.pData = pX->pKey;
8926 x2.nData = pX->nKey;
8927 x2.nZero = 0;
8928 return btreeOverwriteCell(pCur, &x2);
8929 }
8930 }
danielk1977da184232006-01-05 11:34:32 +00008931 }
drh0e5ce802019-12-20 12:33:17 +00008932 assert( pCur->eState==CURSOR_VALID
8933 || (pCur->eState==CURSOR_INVALID && loc)
8934 || CORRUPT_DB );
danielk1977da184232006-01-05 11:34:32 +00008935
drh352a35a2017-08-15 03:46:47 +00008936 pPage = pCur->pPage;
dancd1b2d02020-12-09 20:33:51 +00008937 assert( pPage->intKey || pX->nKey>=0 || (flags & BTREE_PREFORMAT) );
drh44845222008-07-17 18:39:57 +00008938 assert( pPage->leaf || !pPage->intKey );
drhb0ea9432019-02-09 21:06:40 +00008939 if( pPage->nFree<0 ){
drh21c7ccb2021-04-10 20:21:28 +00008940 if( NEVER(pCur->eState>CURSOR_INVALID) ){
drha1085f02020-07-11 16:42:28 +00008941 rc = SQLITE_CORRUPT_BKPT;
8942 }else{
8943 rc = btreeComputeFreeSpace(pPage);
8944 }
drhb0ea9432019-02-09 21:06:40 +00008945 if( rc ) return rc;
8946 }
danielk19778f880a82009-07-13 09:41:45 +00008947
drh3a4c1412004-05-09 20:40:11 +00008948 TRACE(("INSERT: table=%d nkey=%lld ndata=%d page=%d %s\n",
drh8eeb4462016-05-21 20:03:42 +00008949 pCur->pgnoRoot, pX->nKey, pX->nData, pPage->pgno,
drh3a4c1412004-05-09 20:40:11 +00008950 loc==0 ? "overwrite" : "new entry"));
danielk197771d5d2c2008-09-29 11:49:47 +00008951 assert( pPage->isInit );
danielk197752ae7242008-03-25 14:24:56 +00008952 newCell = pBt->pTmpSpace;
drh3fbb0222014-09-24 19:47:27 +00008953 assert( newCell!=0 );
dancd1b2d02020-12-09 20:33:51 +00008954 if( flags & BTREE_PREFORMAT ){
dancd1b2d02020-12-09 20:33:51 +00008955 rc = SQLITE_OK;
dan7aae7352020-12-10 18:06:24 +00008956 szNew = pBt->nPreformatSize;
8957 if( szNew<4 ) szNew = 4;
8958 if( ISAUTOVACUUM && szNew>pPage->maxLocal ){
8959 CellInfo info;
8960 pPage->xParseCell(pPage, newCell, &info);
dan9257ddb2020-12-10 19:54:13 +00008961 if( info.nPayload!=info.nLocal ){
dan7aae7352020-12-10 18:06:24 +00008962 Pgno ovfl = get4byte(&newCell[szNew-4]);
8963 ptrmapPut(pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno, &rc);
8964 }
8965 }
dancd1b2d02020-12-09 20:33:51 +00008966 }else{
8967 rc = fillInCell(pPage, newCell, pX, &szNew);
dancd1b2d02020-12-09 20:33:51 +00008968 }
dan7aae7352020-12-10 18:06:24 +00008969 if( rc ) goto end_insert;
drh25ada072015-06-19 15:07:14 +00008970 assert( szNew==pPage->xCellSize(pPage, newCell) );
drhfcd71b62011-04-05 22:08:24 +00008971 assert( szNew <= MX_CELL_SIZE(pBt) );
drh75e96b32017-04-01 00:20:06 +00008972 idx = pCur->ix;
danielk1977b980d2212009-06-22 18:03:51 +00008973 if( loc==0 ){
drh80159da2016-12-09 17:32:51 +00008974 CellInfo info;
danielk197771d5d2c2008-09-29 11:49:47 +00008975 assert( idx<pPage->nCell );
danielk19776e465eb2007-08-21 13:11:00 +00008976 rc = sqlite3PagerWrite(pPage->pDbPage);
8977 if( rc ){
8978 goto end_insert;
8979 }
danielk197771d5d2c2008-09-29 11:49:47 +00008980 oldCell = findCell(pPage, idx);
drh4b70f112004-05-02 21:12:19 +00008981 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00008982 memcpy(newCell, oldCell, 4);
drh4b70f112004-05-02 21:12:19 +00008983 }
drh86c779f2021-05-15 13:08:44 +00008984 BTREE_CLEAR_CELL(rc, pPage, oldCell, info);
drh554a19d2019-08-12 18:26:46 +00008985 testcase( pCur->curFlags & BTCF_ValidOvfl );
8986 invalidateOverflowCache(pCur);
danca66f6c2017-06-08 11:14:08 +00008987 if( info.nSize==szNew && info.nLocal==info.nPayload
8988 && (!ISAUTOVACUUM || szNew<pPage->minLocal)
8989 ){
drhf9238252016-12-09 18:09:42 +00008990 /* Overwrite the old cell with the new if they are the same size.
8991 ** We could also try to do this if the old cell is smaller, then add
8992 ** the leftover space to the free list. But experiments show that
8993 ** doing that is no faster then skipping this optimization and just
danca66f6c2017-06-08 11:14:08 +00008994 ** calling dropCell() and insertCell().
8995 **
8996 ** This optimization cannot be used on an autovacuum database if the
8997 ** new entry uses overflow pages, as the insertCell() call below is
8998 ** necessary to add the PTRMAP_OVERFLOW1 pointer-map entry. */
drhf9238252016-12-09 18:09:42 +00008999 assert( rc==SQLITE_OK ); /* clearCell never fails when nLocal==nPayload */
drh93788182019-07-22 23:24:01 +00009000 if( oldCell < pPage->aData+pPage->hdrOffset+10 ){
9001 return SQLITE_CORRUPT_BKPT;
9002 }
9003 if( oldCell+szNew > pPage->aDataEnd ){
9004 return SQLITE_CORRUPT_BKPT;
9005 }
drh80159da2016-12-09 17:32:51 +00009006 memcpy(oldCell, newCell, szNew);
9007 return SQLITE_OK;
9008 }
9009 dropCell(pPage, idx, info.nSize, &rc);
drh2e38c322004-09-03 18:38:44 +00009010 if( rc ) goto end_insert;
drh7c717f72001-06-24 20:39:41 +00009011 }else if( loc<0 && pPage->nCell>0 ){
drh4b70f112004-05-02 21:12:19 +00009012 assert( pPage->leaf );
drh75e96b32017-04-01 00:20:06 +00009013 idx = ++pCur->ix;
dan874080b2017-05-01 18:12:56 +00009014 pCur->curFlags &= ~BTCF_ValidNKey;
drh14acc042001-06-10 19:56:58 +00009015 }else{
drh4b70f112004-05-02 21:12:19 +00009016 assert( pPage->leaf );
drh3b7511c2001-05-26 13:15:44 +00009017 }
drh98add2e2009-07-20 17:11:49 +00009018 insertCell(pPage, idx, newCell, szNew, 0, 0, &rc);
drh09a4e922016-05-21 12:29:04 +00009019 assert( pPage->nOverflow==0 || rc==SQLITE_OK );
danielk19773f632d52009-05-02 10:03:09 +00009020 assert( rc!=SQLITE_OK || pPage->nCell>0 || pPage->nOverflow>0 );
drh9bf9e9c2008-12-05 20:01:43 +00009021
mistachkin48864df2013-03-21 21:20:32 +00009022 /* If no error has occurred and pPage has an overflow cell, call balance()
danielk1977a50d9aa2009-06-08 14:49:45 +00009023 ** to redistribute the cells within the tree. Since balance() may move
drh036dbec2014-03-11 23:40:44 +00009024 ** the cursor, zero the BtCursor.info.nSize and BTCF_ValidNKey
danielk1977a50d9aa2009-06-08 14:49:45 +00009025 ** variables.
danielk19773f632d52009-05-02 10:03:09 +00009026 **
danielk1977a50d9aa2009-06-08 14:49:45 +00009027 ** Previous versions of SQLite called moveToRoot() to move the cursor
9028 ** back to the root page as balance() used to invalidate the contents
danielk197754109bb2009-06-23 11:22:29 +00009029 ** of BtCursor.apPage[] and BtCursor.aiIdx[]. Instead of doing that,
9030 ** set the cursor state to "invalid". This makes common insert operations
9031 ** slightly faster.
danielk19773f632d52009-05-02 10:03:09 +00009032 **
danielk1977a50d9aa2009-06-08 14:49:45 +00009033 ** There is a subtle but important optimization here too. When inserting
9034 ** multiple records into an intkey b-tree using a single cursor (as can
9035 ** happen while processing an "INSERT INTO ... SELECT" statement), it
9036 ** is advantageous to leave the cursor pointing to the last entry in
9037 ** the b-tree if possible. If the cursor is left pointing to the last
9038 ** entry in the table, and the next row inserted has an integer key
9039 ** larger than the largest existing key, it is possible to insert the
9040 ** row without seeking the cursor. This can be a big performance boost.
danielk19773f632d52009-05-02 10:03:09 +00009041 */
danielk1977a50d9aa2009-06-08 14:49:45 +00009042 pCur->info.nSize = 0;
drh09a4e922016-05-21 12:29:04 +00009043 if( pPage->nOverflow ){
9044 assert( rc==SQLITE_OK );
drh036dbec2014-03-11 23:40:44 +00009045 pCur->curFlags &= ~(BTCF_ValidNKey);
danielk1977a50d9aa2009-06-08 14:49:45 +00009046 rc = balance(pCur);
9047
9048 /* Must make sure nOverflow is reset to zero even if the balance()
danielk197754109bb2009-06-23 11:22:29 +00009049 ** fails. Internal data structure corruption will result otherwise.
9050 ** Also, set the cursor state to invalid. This stops saveCursorPosition()
9051 ** from trying to save the current position of the cursor. */
drh352a35a2017-08-15 03:46:47 +00009052 pCur->pPage->nOverflow = 0;
danielk197754109bb2009-06-23 11:22:29 +00009053 pCur->eState = CURSOR_INVALID;
danf91c1312017-01-10 20:04:38 +00009054 if( (flags & BTREE_SAVEPOSITION) && rc==SQLITE_OK ){
drh85ef6302017-08-02 15:50:09 +00009055 btreeReleaseAllCursorPages(pCur);
drh7b20a152017-01-12 19:10:55 +00009056 if( pCur->pKeyInfo ){
danf91c1312017-01-10 20:04:38 +00009057 assert( pCur->pKey==0 );
9058 pCur->pKey = sqlite3Malloc( pX->nKey );
9059 if( pCur->pKey==0 ){
9060 rc = SQLITE_NOMEM;
9061 }else{
9062 memcpy(pCur->pKey, pX->pKey, pX->nKey);
9063 }
9064 }
9065 pCur->eState = CURSOR_REQUIRESEEK;
9066 pCur->nKey = pX->nKey;
9067 }
danielk19773f632d52009-05-02 10:03:09 +00009068 }
drh352a35a2017-08-15 03:46:47 +00009069 assert( pCur->iPage<0 || pCur->pPage->nOverflow==0 );
drh9bf9e9c2008-12-05 20:01:43 +00009070
drh2e38c322004-09-03 18:38:44 +00009071end_insert:
drh5e2f8b92001-05-28 00:41:15 +00009072 return rc;
9073}
9074
dand2ffc972020-12-10 19:20:15 +00009075/*
9076** This function is used as part of copying the current row from cursor
9077** pSrc into cursor pDest. If the cursors are open on intkey tables, then
9078** parameter iKey is used as the rowid value when the record is copied
9079** into pDest. Otherwise, the record is copied verbatim.
9080**
9081** This function does not actually write the new value to cursor pDest.
9082** Instead, it creates and populates any required overflow pages and
9083** writes the data for the new cell into the BtShared.pTmpSpace buffer
9084** for the destination database. The size of the cell, in bytes, is left
9085** in BtShared.nPreformatSize. The caller completes the insertion by
9086** calling sqlite3BtreeInsert() with the BTREE_PREFORMAT flag specified.
9087**
9088** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
9089*/
dan7aae7352020-12-10 18:06:24 +00009090int sqlite3BtreeTransferRow(BtCursor *pDest, BtCursor *pSrc, i64 iKey){
dan036e0672020-12-08 20:19:07 +00009091 int rc = SQLITE_OK;
dan7aae7352020-12-10 18:06:24 +00009092 BtShared *pBt = pDest->pBt;
9093 u8 *aOut = pBt->pTmpSpace; /* Pointer to next output buffer */
danebbf3682020-12-09 16:32:11 +00009094 const u8 *aIn; /* Pointer to next input buffer */
drhe5baf5c2020-12-16 14:20:45 +00009095 u32 nIn; /* Size of input buffer aIn[] */
dan7f607062020-12-15 19:27:20 +00009096 u32 nRem; /* Bytes of data still to copy */
dan036e0672020-12-08 20:19:07 +00009097
dan036e0672020-12-08 20:19:07 +00009098 getCellInfo(pSrc);
dan7aae7352020-12-10 18:06:24 +00009099 aOut += putVarint32(aOut, pSrc->info.nPayload);
9100 if( pDest->pKeyInfo==0 ) aOut += putVarint(aOut, iKey);
danebbf3682020-12-09 16:32:11 +00009101 nIn = pSrc->info.nLocal;
9102 aIn = pSrc->info.pPayload;
drh0a8b6a92020-12-16 21:09:45 +00009103 if( aIn+nIn>pSrc->pPage->aDataEnd ){
9104 return SQLITE_CORRUPT_BKPT;
9105 }
danebbf3682020-12-09 16:32:11 +00009106 nRem = pSrc->info.nPayload;
dan7aae7352020-12-10 18:06:24 +00009107 if( nIn==nRem && nIn<pDest->pPage->maxLocal ){
9108 memcpy(aOut, aIn, nIn);
9109 pBt->nPreformatSize = nIn + (aOut - pBt->pTmpSpace);
9110 }else{
9111 Pager *pSrcPager = pSrc->pBt->pPager;
9112 u8 *pPgnoOut = 0;
9113 Pgno ovflIn = 0;
9114 DbPage *pPageIn = 0;
9115 MemPage *pPageOut = 0;
drhe5baf5c2020-12-16 14:20:45 +00009116 u32 nOut; /* Size of output buffer aOut[] */
danebbf3682020-12-09 16:32:11 +00009117
dan7aae7352020-12-10 18:06:24 +00009118 nOut = btreePayloadToLocal(pDest->pPage, pSrc->info.nPayload);
9119 pBt->nPreformatSize = nOut + (aOut - pBt->pTmpSpace);
9120 if( nOut<pSrc->info.nPayload ){
9121 pPgnoOut = &aOut[nOut];
9122 pBt->nPreformatSize += 4;
9123 }
9124
9125 if( nRem>nIn ){
drh0a8b6a92020-12-16 21:09:45 +00009126 if( aIn+nIn+4>pSrc->pPage->aDataEnd ){
9127 return SQLITE_CORRUPT_BKPT;
9128 }
dan7aae7352020-12-10 18:06:24 +00009129 ovflIn = get4byte(&pSrc->info.pPayload[nIn]);
9130 }
9131
9132 do {
9133 nRem -= nOut;
9134 do{
9135 assert( nOut>0 );
9136 if( nIn>0 ){
9137 int nCopy = MIN(nOut, nIn);
9138 memcpy(aOut, aIn, nCopy);
9139 nOut -= nCopy;
9140 nIn -= nCopy;
9141 aOut += nCopy;
9142 aIn += nCopy;
9143 }
9144 if( nOut>0 ){
9145 sqlite3PagerUnref(pPageIn);
9146 pPageIn = 0;
9147 rc = sqlite3PagerGet(pSrcPager, ovflIn, &pPageIn, PAGER_GET_READONLY);
9148 if( rc==SQLITE_OK ){
9149 aIn = (const u8*)sqlite3PagerGetData(pPageIn);
9150 ovflIn = get4byte(aIn);
9151 aIn += 4;
9152 nIn = pSrc->pBt->usableSize - 4;
9153 }
9154 }
9155 }while( rc==SQLITE_OK && nOut>0 );
9156
9157 if( rc==SQLITE_OK && nRem>0 ){
9158 Pgno pgnoNew;
9159 MemPage *pNew = 0;
9160 rc = allocateBtreePage(pBt, &pNew, &pgnoNew, 0, 0);
9161 put4byte(pPgnoOut, pgnoNew);
9162 if( ISAUTOVACUUM && pPageOut ){
9163 ptrmapPut(pBt, pgnoNew, PTRMAP_OVERFLOW2, pPageOut->pgno, &rc);
9164 }
9165 releasePage(pPageOut);
9166 pPageOut = pNew;
9167 if( pPageOut ){
9168 pPgnoOut = pPageOut->aData;
9169 put4byte(pPgnoOut, 0);
9170 aOut = &pPgnoOut[4];
9171 nOut = MIN(pBt->usableSize - 4, nRem);
danebbf3682020-12-09 16:32:11 +00009172 }
9173 }
dan7aae7352020-12-10 18:06:24 +00009174 }while( nRem>0 && rc==SQLITE_OK );
9175
9176 releasePage(pPageOut);
9177 sqlite3PagerUnref(pPageIn);
dan036e0672020-12-08 20:19:07 +00009178 }
9179
9180 return rc;
9181}
9182
drh5e2f8b92001-05-28 00:41:15 +00009183/*
danf0ee1d32015-09-12 19:26:11 +00009184** Delete the entry that the cursor is pointing to.
9185**
drhe807bdb2016-01-21 17:06:33 +00009186** If the BTREE_SAVEPOSITION bit of the flags parameter is zero, then
9187** the cursor is left pointing at an arbitrary location after the delete.
9188** But if that bit is set, then the cursor is left in a state such that
9189** the next call to BtreeNext() or BtreePrev() moves it to the same row
9190** as it would have been on if the call to BtreeDelete() had been omitted.
9191**
drhdef19e32016-01-27 16:26:25 +00009192** The BTREE_AUXDELETE bit of flags indicates that is one of several deletes
9193** associated with a single table entry and its indexes. Only one of those
9194** deletes is considered the "primary" delete. The primary delete occurs
9195** on a cursor that is not a BTREE_FORDELETE cursor. All but one delete
9196** operation on non-FORDELETE cursors is tagged with the AUXDELETE flag.
9197** The BTREE_AUXDELETE bit is a hint that is not used by this implementation,
drhe807bdb2016-01-21 17:06:33 +00009198** but which might be used by alternative storage engines.
drh3b7511c2001-05-26 13:15:44 +00009199*/
drhe807bdb2016-01-21 17:06:33 +00009200int sqlite3BtreeDelete(BtCursor *pCur, u8 flags){
drhd677b3d2007-08-20 22:48:41 +00009201 Btree *p = pCur->pBtree;
danielk19774dbaa892009-06-16 16:50:22 +00009202 BtShared *pBt = p->pBt;
9203 int rc; /* Return code */
9204 MemPage *pPage; /* Page to delete cell from */
9205 unsigned char *pCell; /* Pointer to cell to delete */
9206 int iCellIdx; /* Index of cell to delete */
9207 int iCellDepth; /* Depth of node containing pCell */
drh80159da2016-12-09 17:32:51 +00009208 CellInfo info; /* Size of the cell being deleted */
danf0ee1d32015-09-12 19:26:11 +00009209 int bSkipnext = 0; /* Leaf cursor in SKIPNEXT state */
drhe807bdb2016-01-21 17:06:33 +00009210 u8 bPreserve = flags & BTREE_SAVEPOSITION; /* Keep cursor valid */
drh8b2f49b2001-06-08 00:21:52 +00009211
dan7a2347e2016-01-07 16:43:54 +00009212 assert( cursorOwnsBtShared(pCur) );
drh64022502009-01-09 14:11:04 +00009213 assert( pBt->inTransaction==TRANS_WRITE );
drhc9166342012-01-05 23:32:06 +00009214 assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
drh036dbec2014-03-11 23:40:44 +00009215 assert( pCur->curFlags & BTCF_WriteFlag );
danielk197796d48e92009-06-29 06:00:37 +00009216 assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
9217 assert( !hasReadConflicts(p, pCur->pgnoRoot) );
drhdef19e32016-01-27 16:26:25 +00009218 assert( (flags & ~(BTREE_SAVEPOSITION | BTREE_AUXDELETE))==0 );
danb560a712019-03-13 15:29:14 +00009219 if( pCur->eState==CURSOR_REQUIRESEEK ){
9220 rc = btreeRestoreCursorPosition(pCur);
danf0ac2902021-04-26 15:32:36 +00009221 assert( rc!=SQLITE_OK || CORRUPT_DB || pCur->eState==CURSOR_VALID );
9222 if( rc || pCur->eState!=CURSOR_VALID ) return rc;
danb560a712019-03-13 15:29:14 +00009223 }
dan112501f2021-04-06 18:02:17 +00009224 assert( CORRUPT_DB || pCur->eState==CURSOR_VALID );
danielk1977da184232006-01-05 11:34:32 +00009225
danielk19774dbaa892009-06-16 16:50:22 +00009226 iCellDepth = pCur->iPage;
drh75e96b32017-04-01 00:20:06 +00009227 iCellIdx = pCur->ix;
drh352a35a2017-08-15 03:46:47 +00009228 pPage = pCur->pPage;
danielk19774dbaa892009-06-16 16:50:22 +00009229 pCell = findCell(pPage, iCellIdx);
drhb0ea9432019-02-09 21:06:40 +00009230 if( pPage->nFree<0 && btreeComputeFreeSpace(pPage) ) return SQLITE_CORRUPT;
danielk19774dbaa892009-06-16 16:50:22 +00009231
drhbfc7a8b2016-04-09 17:04:05 +00009232 /* If the bPreserve flag is set to true, then the cursor position must
9233 ** be preserved following this delete operation. If the current delete
9234 ** will cause a b-tree rebalance, then this is done by saving the cursor
9235 ** key and leaving the cursor in CURSOR_REQUIRESEEK state before
9236 ** returning.
9237 **
9238 ** Or, if the current delete will not cause a rebalance, then the cursor
9239 ** will be left in CURSOR_SKIPNEXT state pointing to the entry immediately
9240 ** before or after the deleted entry. In this case set bSkipnext to true. */
9241 if( bPreserve ){
9242 if( !pPage->leaf
9243 || (pPage->nFree+cellSizePtr(pPage,pCell)+2)>(int)(pBt->usableSize*2/3)
drh1641f112018-12-13 21:05:45 +00009244 || pPage->nCell==1 /* See dbfuzz001.test for a test case */
drhbfc7a8b2016-04-09 17:04:05 +00009245 ){
9246 /* A b-tree rebalance will be required after deleting this entry.
9247 ** Save the cursor key. */
9248 rc = saveCursorKey(pCur);
9249 if( rc ) return rc;
9250 }else{
9251 bSkipnext = 1;
9252 }
9253 }
9254
danielk19774dbaa892009-06-16 16:50:22 +00009255 /* If the page containing the entry to delete is not a leaf page, move
9256 ** the cursor to the largest entry in the tree that is smaller than
9257 ** the entry being deleted. This cell will replace the cell being deleted
9258 ** from the internal node. The 'previous' entry is used for this instead
9259 ** of the 'next' entry, as the previous entry is always a part of the
9260 ** sub-tree headed by the child page of the cell being deleted. This makes
9261 ** balancing the tree following the delete operation easier. */
9262 if( !pPage->leaf ){
drh2ab792e2017-05-30 18:34:07 +00009263 rc = sqlite3BtreePrevious(pCur, 0);
9264 assert( rc!=SQLITE_DONE );
drh4c301aa2009-07-15 17:25:45 +00009265 if( rc ) return rc;
danielk19774dbaa892009-06-16 16:50:22 +00009266 }
9267
9268 /* Save the positions of any other cursors open on this table before
danf0ee1d32015-09-12 19:26:11 +00009269 ** making any modifications. */
drh27fb7462015-06-30 02:47:36 +00009270 if( pCur->curFlags & BTCF_Multiple ){
9271 rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
9272 if( rc ) return rc;
9273 }
drhd60f4f42012-03-23 14:23:52 +00009274
9275 /* If this is a delete operation to remove a row from a table b-tree,
9276 ** invalidate any incrblob cursors open on the row being deleted. */
drh49bb56e2021-05-14 20:01:36 +00009277 if( pCur->pKeyInfo==0 && p->hasIncrblobCur ){
drh9ca431a2017-03-29 18:03:50 +00009278 invalidateIncrblobCursors(p, pCur->pgnoRoot, pCur->info.nKey, 0);
drhd60f4f42012-03-23 14:23:52 +00009279 }
9280
danf0ee1d32015-09-12 19:26:11 +00009281 /* Make the page containing the entry to be deleted writable. Then free any
9282 ** overflow pages associated with the entry and finally remove the cell
9283 ** itself from within the page. */
drha4ec1d42009-07-11 13:13:11 +00009284 rc = sqlite3PagerWrite(pPage->pDbPage);
9285 if( rc ) return rc;
drh86c779f2021-05-15 13:08:44 +00009286 BTREE_CLEAR_CELL(rc, pPage, pCell, info);
drh80159da2016-12-09 17:32:51 +00009287 dropCell(pPage, iCellIdx, info.nSize, &rc);
drha4ec1d42009-07-11 13:13:11 +00009288 if( rc ) return rc;
danielk1977e6efa742004-11-10 11:55:10 +00009289
danielk19774dbaa892009-06-16 16:50:22 +00009290 /* If the cell deleted was not located on a leaf page, then the cursor
9291 ** is currently pointing to the largest entry in the sub-tree headed
9292 ** by the child-page of the cell that was just deleted from an internal
9293 ** node. The cell from the leaf node needs to be moved to the internal
9294 ** node to replace the deleted cell. */
drh4b70f112004-05-02 21:12:19 +00009295 if( !pPage->leaf ){
drh352a35a2017-08-15 03:46:47 +00009296 MemPage *pLeaf = pCur->pPage;
danielk19774dbaa892009-06-16 16:50:22 +00009297 int nCell;
drh352a35a2017-08-15 03:46:47 +00009298 Pgno n;
danielk19774dbaa892009-06-16 16:50:22 +00009299 unsigned char *pTmp;
danielk1977e6efa742004-11-10 11:55:10 +00009300
drhb0ea9432019-02-09 21:06:40 +00009301 if( pLeaf->nFree<0 ){
9302 rc = btreeComputeFreeSpace(pLeaf);
9303 if( rc ) return rc;
9304 }
drh352a35a2017-08-15 03:46:47 +00009305 if( iCellDepth<pCur->iPage-1 ){
9306 n = pCur->apPage[iCellDepth+1]->pgno;
9307 }else{
9308 n = pCur->pPage->pgno;
9309 }
danielk19774dbaa892009-06-16 16:50:22 +00009310 pCell = findCell(pLeaf, pLeaf->nCell-1);
drhb468ce12015-06-24 01:07:30 +00009311 if( pCell<&pLeaf->aData[4] ) return SQLITE_CORRUPT_BKPT;
drh25ada072015-06-19 15:07:14 +00009312 nCell = pLeaf->xCellSize(pLeaf, pCell);
drhfcd71b62011-04-05 22:08:24 +00009313 assert( MX_CELL_SIZE(pBt) >= nCell );
danielk19774dbaa892009-06-16 16:50:22 +00009314 pTmp = pBt->pTmpSpace;
drh3fbb0222014-09-24 19:47:27 +00009315 assert( pTmp!=0 );
drha4ec1d42009-07-11 13:13:11 +00009316 rc = sqlite3PagerWrite(pLeaf->pDbPage);
drhcb89f4a2016-05-21 11:23:26 +00009317 if( rc==SQLITE_OK ){
9318 insertCell(pPage, iCellIdx, pCell-4, nCell+4, pTmp, n, &rc);
9319 }
drh98add2e2009-07-20 17:11:49 +00009320 dropCell(pLeaf, pLeaf->nCell-1, nCell, &rc);
drha4ec1d42009-07-11 13:13:11 +00009321 if( rc ) return rc;
drh5e2f8b92001-05-28 00:41:15 +00009322 }
danielk19774dbaa892009-06-16 16:50:22 +00009323
9324 /* Balance the tree. If the entry deleted was located on a leaf page,
9325 ** then the cursor still points to that page. In this case the first
9326 ** call to balance() repairs the tree, and the if(...) condition is
9327 ** never true.
9328 **
9329 ** Otherwise, if the entry deleted was on an internal node page, then
9330 ** pCur is pointing to the leaf page from which a cell was removed to
9331 ** replace the cell deleted from the internal node. This is slightly
9332 ** tricky as the leaf node may be underfull, and the internal node may
9333 ** be either under or overfull. In this case run the balancing algorithm
9334 ** on the leaf node first. If the balance proceeds far enough up the
9335 ** tree that we can be sure that any problem in the internal node has
9336 ** been corrected, so be it. Otherwise, after balancing the leaf node,
9337 ** walk the cursor up the tree to the internal node and balance it as
9338 ** well. */
9339 rc = balance(pCur);
9340 if( rc==SQLITE_OK && pCur->iPage>iCellDepth ){
drh352a35a2017-08-15 03:46:47 +00009341 releasePageNotNull(pCur->pPage);
9342 pCur->iPage--;
danielk19774dbaa892009-06-16 16:50:22 +00009343 while( pCur->iPage>iCellDepth ){
9344 releasePage(pCur->apPage[pCur->iPage--]);
9345 }
drh352a35a2017-08-15 03:46:47 +00009346 pCur->pPage = pCur->apPage[pCur->iPage];
danielk19774dbaa892009-06-16 16:50:22 +00009347 rc = balance(pCur);
9348 }
9349
danielk19776b456a22005-03-21 04:04:02 +00009350 if( rc==SQLITE_OK ){
danf0ee1d32015-09-12 19:26:11 +00009351 if( bSkipnext ){
drha660caf2016-01-01 03:37:44 +00009352 assert( bPreserve && (pCur->iPage==iCellDepth || CORRUPT_DB) );
drh352a35a2017-08-15 03:46:47 +00009353 assert( pPage==pCur->pPage || CORRUPT_DB );
drh78ac1092015-09-20 22:57:47 +00009354 assert( (pPage->nCell>0 || CORRUPT_DB) && iCellIdx<=pPage->nCell );
danf0ee1d32015-09-12 19:26:11 +00009355 pCur->eState = CURSOR_SKIPNEXT;
9356 if( iCellIdx>=pPage->nCell ){
9357 pCur->skipNext = -1;
drh75e96b32017-04-01 00:20:06 +00009358 pCur->ix = pPage->nCell-1;
danf0ee1d32015-09-12 19:26:11 +00009359 }else{
9360 pCur->skipNext = 1;
9361 }
9362 }else{
9363 rc = moveToRoot(pCur);
9364 if( bPreserve ){
drh85ef6302017-08-02 15:50:09 +00009365 btreeReleaseAllCursorPages(pCur);
danf0ee1d32015-09-12 19:26:11 +00009366 pCur->eState = CURSOR_REQUIRESEEK;
9367 }
drh44548e72017-08-14 18:13:52 +00009368 if( rc==SQLITE_EMPTY ) rc = SQLITE_OK;
danf0ee1d32015-09-12 19:26:11 +00009369 }
danielk19776b456a22005-03-21 04:04:02 +00009370 }
drh5e2f8b92001-05-28 00:41:15 +00009371 return rc;
drh3b7511c2001-05-26 13:15:44 +00009372}
drh8b2f49b2001-06-08 00:21:52 +00009373
9374/*
drhc6b52df2002-01-04 03:09:29 +00009375** Create a new BTree table. Write into *piTable the page
9376** number for the root page of the new table.
9377**
drhab01f612004-05-22 02:55:23 +00009378** The type of type is determined by the flags parameter. Only the
9379** following values of flags are currently in use. Other values for
9380** flags might not work:
9381**
9382** BTREE_INTKEY|BTREE_LEAFDATA Used for SQL tables with rowid keys
9383** BTREE_ZERODATA Used for SQL indices
drh8b2f49b2001-06-08 00:21:52 +00009384*/
drhabc38152020-07-22 13:38:04 +00009385static int btreeCreateTable(Btree *p, Pgno *piTable, int createTabFlags){
danielk1977aef0bf62005-12-30 16:28:01 +00009386 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00009387 MemPage *pRoot;
9388 Pgno pgnoRoot;
9389 int rc;
drhd4187c72010-08-30 22:15:45 +00009390 int ptfFlags; /* Page-type flage for the root page of new table */
drhd677b3d2007-08-20 22:48:41 +00009391
drh1fee73e2007-08-29 04:00:57 +00009392 assert( sqlite3BtreeHoldsMutex(p) );
drh64022502009-01-09 14:11:04 +00009393 assert( pBt->inTransaction==TRANS_WRITE );
drhc9166342012-01-05 23:32:06 +00009394 assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
danielk1977e6efa742004-11-10 11:55:10 +00009395
danielk1977003ba062004-11-04 02:57:33 +00009396#ifdef SQLITE_OMIT_AUTOVACUUM
drh4f0c5872007-03-26 22:05:01 +00009397 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
drhd677b3d2007-08-20 22:48:41 +00009398 if( rc ){
9399 return rc;
9400 }
danielk1977003ba062004-11-04 02:57:33 +00009401#else
danielk1977687566d2004-11-02 12:56:41 +00009402 if( pBt->autoVacuum ){
danielk1977003ba062004-11-04 02:57:33 +00009403 Pgno pgnoMove; /* Move a page here to make room for the root-page */
9404 MemPage *pPageMove; /* The page to move to. */
9405
danielk197720713f32007-05-03 11:43:33 +00009406 /* Creating a new table may probably require moving an existing database
9407 ** to make room for the new tables root page. In case this page turns
9408 ** out to be an overflow page, delete all overflow page-map caches
9409 ** held by open cursors.
9410 */
danielk197792d4d7a2007-05-04 12:05:56 +00009411 invalidateAllOverflowCache(pBt);
danielk197720713f32007-05-03 11:43:33 +00009412
danielk1977003ba062004-11-04 02:57:33 +00009413 /* Read the value of meta[3] from the database to determine where the
9414 ** root page of the new table should go. meta[3] is the largest root-page
9415 ** created so far, so the new root-page is (meta[3]+1).
9416 */
danielk1977602b4662009-07-02 07:47:33 +00009417 sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &pgnoRoot);
drh10248222020-07-28 20:32:12 +00009418 if( pgnoRoot>btreePagecount(pBt) ){
9419 return SQLITE_CORRUPT_BKPT;
9420 }
danielk1977003ba062004-11-04 02:57:33 +00009421 pgnoRoot++;
9422
danielk1977599fcba2004-11-08 07:13:13 +00009423 /* The new root-page may not be allocated on a pointer-map page, or the
9424 ** PENDING_BYTE page.
9425 */
drh72190432008-01-31 14:54:43 +00009426 while( pgnoRoot==PTRMAP_PAGENO(pBt, pgnoRoot) ||
danielk1977599fcba2004-11-08 07:13:13 +00009427 pgnoRoot==PENDING_BYTE_PAGE(pBt) ){
danielk1977003ba062004-11-04 02:57:33 +00009428 pgnoRoot++;
9429 }
drh48bf2d72020-07-30 17:14:55 +00009430 assert( pgnoRoot>=3 );
danielk1977003ba062004-11-04 02:57:33 +00009431
9432 /* Allocate a page. The page that currently resides at pgnoRoot will
9433 ** be moved to the allocated page (unless the allocated page happens
9434 ** to reside at pgnoRoot).
9435 */
dan51f0b6d2013-02-22 20:16:34 +00009436 rc = allocateBtreePage(pBt, &pPageMove, &pgnoMove, pgnoRoot, BTALLOC_EXACT);
danielk1977003ba062004-11-04 02:57:33 +00009437 if( rc!=SQLITE_OK ){
danielk1977687566d2004-11-02 12:56:41 +00009438 return rc;
9439 }
danielk1977003ba062004-11-04 02:57:33 +00009440
9441 if( pgnoMove!=pgnoRoot ){
danielk1977f35843b2007-04-07 15:03:17 +00009442 /* pgnoRoot is the page that will be used for the root-page of
9443 ** the new table (assuming an error did not occur). But we were
9444 ** allocated pgnoMove. If required (i.e. if it was not allocated
9445 ** by extending the file), the current page at position pgnoMove
9446 ** is already journaled.
9447 */
drheeb844a2009-08-08 18:01:07 +00009448 u8 eType = 0;
9449 Pgno iPtrPage = 0;
danielk1977003ba062004-11-04 02:57:33 +00009450
danf7679ad2013-04-03 11:38:36 +00009451 /* Save the positions of any open cursors. This is required in
9452 ** case they are holding a reference to an xFetch reference
9453 ** corresponding to page pgnoRoot. */
9454 rc = saveAllCursors(pBt, 0, 0);
danielk1977003ba062004-11-04 02:57:33 +00009455 releasePage(pPageMove);
danf7679ad2013-04-03 11:38:36 +00009456 if( rc!=SQLITE_OK ){
9457 return rc;
9458 }
danielk1977f35843b2007-04-07 15:03:17 +00009459
9460 /* Move the page currently at pgnoRoot to pgnoMove. */
drhb00fc3b2013-08-21 23:42:32 +00009461 rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00009462 if( rc!=SQLITE_OK ){
9463 return rc;
9464 }
9465 rc = ptrmapGet(pBt, pgnoRoot, &eType, &iPtrPage);
drh27731d72009-06-22 12:05:10 +00009466 if( eType==PTRMAP_ROOTPAGE || eType==PTRMAP_FREEPAGE ){
9467 rc = SQLITE_CORRUPT_BKPT;
9468 }
9469 if( rc!=SQLITE_OK ){
danielk1977003ba062004-11-04 02:57:33 +00009470 releasePage(pRoot);
9471 return rc;
9472 }
drhccae6022005-02-26 17:31:26 +00009473 assert( eType!=PTRMAP_ROOTPAGE );
9474 assert( eType!=PTRMAP_FREEPAGE );
danielk19774c999992008-07-16 18:17:55 +00009475 rc = relocatePage(pBt, pRoot, eType, iPtrPage, pgnoMove, 0);
danielk1977003ba062004-11-04 02:57:33 +00009476 releasePage(pRoot);
danielk1977f35843b2007-04-07 15:03:17 +00009477
9478 /* Obtain the page at pgnoRoot */
danielk1977003ba062004-11-04 02:57:33 +00009479 if( rc!=SQLITE_OK ){
9480 return rc;
9481 }
drhb00fc3b2013-08-21 23:42:32 +00009482 rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
danielk1977003ba062004-11-04 02:57:33 +00009483 if( rc!=SQLITE_OK ){
9484 return rc;
9485 }
danielk19773b8a05f2007-03-19 17:44:26 +00009486 rc = sqlite3PagerWrite(pRoot->pDbPage);
danielk1977003ba062004-11-04 02:57:33 +00009487 if( rc!=SQLITE_OK ){
9488 releasePage(pRoot);
9489 return rc;
9490 }
9491 }else{
9492 pRoot = pPageMove;
9493 }
9494
danielk197742741be2005-01-08 12:42:39 +00009495 /* Update the pointer-map and meta-data with the new root-page number. */
drh98add2e2009-07-20 17:11:49 +00009496 ptrmapPut(pBt, pgnoRoot, PTRMAP_ROOTPAGE, 0, &rc);
danielk1977003ba062004-11-04 02:57:33 +00009497 if( rc ){
9498 releasePage(pRoot);
9499 return rc;
9500 }
drhbf592832010-03-30 15:51:12 +00009501
9502 /* When the new root page was allocated, page 1 was made writable in
9503 ** order either to increase the database filesize, or to decrement the
9504 ** freelist count. Hence, the sqlite3BtreeUpdateMeta() call cannot fail.
9505 */
9506 assert( sqlite3PagerIswriteable(pBt->pPage1->pDbPage) );
danielk1977aef0bf62005-12-30 16:28:01 +00009507 rc = sqlite3BtreeUpdateMeta(p, 4, pgnoRoot);
drhbf592832010-03-30 15:51:12 +00009508 if( NEVER(rc) ){
danielk1977003ba062004-11-04 02:57:33 +00009509 releasePage(pRoot);
9510 return rc;
9511 }
danielk197742741be2005-01-08 12:42:39 +00009512
danielk1977003ba062004-11-04 02:57:33 +00009513 }else{
drh4f0c5872007-03-26 22:05:01 +00009514 rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
danielk1977003ba062004-11-04 02:57:33 +00009515 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00009516 }
9517#endif
danielk19773b8a05f2007-03-19 17:44:26 +00009518 assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
drhd4187c72010-08-30 22:15:45 +00009519 if( createTabFlags & BTREE_INTKEY ){
9520 ptfFlags = PTF_INTKEY | PTF_LEAFDATA | PTF_LEAF;
9521 }else{
9522 ptfFlags = PTF_ZERODATA | PTF_LEAF;
9523 }
9524 zeroPage(pRoot, ptfFlags);
danielk19773b8a05f2007-03-19 17:44:26 +00009525 sqlite3PagerUnref(pRoot->pDbPage);
drhd4187c72010-08-30 22:15:45 +00009526 assert( (pBt->openFlags & BTREE_SINGLE)==0 || pgnoRoot==2 );
drhabc38152020-07-22 13:38:04 +00009527 *piTable = pgnoRoot;
drh8b2f49b2001-06-08 00:21:52 +00009528 return SQLITE_OK;
9529}
drhabc38152020-07-22 13:38:04 +00009530int sqlite3BtreeCreateTable(Btree *p, Pgno *piTable, int flags){
drhd677b3d2007-08-20 22:48:41 +00009531 int rc;
9532 sqlite3BtreeEnter(p);
9533 rc = btreeCreateTable(p, piTable, flags);
9534 sqlite3BtreeLeave(p);
9535 return rc;
9536}
drh8b2f49b2001-06-08 00:21:52 +00009537
9538/*
9539** Erase the given database page and all its children. Return
9540** the page to the freelist.
9541*/
drh4b70f112004-05-02 21:12:19 +00009542static int clearDatabasePage(
danielk1977aef0bf62005-12-30 16:28:01 +00009543 BtShared *pBt, /* The BTree that contains the table */
drh7ab641f2009-11-24 02:37:02 +00009544 Pgno pgno, /* Page number to clear */
9545 int freePageFlag, /* Deallocate page if true */
dan2c718872021-06-22 18:32:05 +00009546 i64 *pnChange /* Add number of Cells freed to this counter */
drh4b70f112004-05-02 21:12:19 +00009547){
danielk1977146ba992009-07-22 14:08:13 +00009548 MemPage *pPage;
drh8b2f49b2001-06-08 00:21:52 +00009549 int rc;
drh4b70f112004-05-02 21:12:19 +00009550 unsigned char *pCell;
9551 int i;
dan8ce71842014-01-14 20:14:09 +00009552 int hdr;
drh80159da2016-12-09 17:32:51 +00009553 CellInfo info;
drh8b2f49b2001-06-08 00:21:52 +00009554
drh1fee73e2007-08-29 04:00:57 +00009555 assert( sqlite3_mutex_held(pBt->mutex) );
drhb1299152010-03-30 22:58:33 +00009556 if( pgno>btreePagecount(pBt) ){
drh49285702005-09-17 15:20:26 +00009557 return SQLITE_CORRUPT_BKPT;
danielk1977a1cb1832005-02-12 08:59:55 +00009558 }
drh28f58dd2015-06-27 19:45:03 +00009559 rc = getAndInitPage(pBt, pgno, &pPage, 0, 0);
danielk1977146ba992009-07-22 14:08:13 +00009560 if( rc ) return rc;
drhccf46d02015-04-01 13:21:33 +00009561 if( pPage->bBusy ){
9562 rc = SQLITE_CORRUPT_BKPT;
9563 goto cleardatabasepage_out;
9564 }
9565 pPage->bBusy = 1;
dan8ce71842014-01-14 20:14:09 +00009566 hdr = pPage->hdrOffset;
drh4b70f112004-05-02 21:12:19 +00009567 for(i=0; i<pPage->nCell; i++){
danielk19771cc5ed82007-05-16 17:28:43 +00009568 pCell = findCell(pPage, i);
drh4b70f112004-05-02 21:12:19 +00009569 if( !pPage->leaf ){
danielk197762c14b32008-11-19 09:05:26 +00009570 rc = clearDatabasePage(pBt, get4byte(pCell), 1, pnChange);
danielk19776b456a22005-03-21 04:04:02 +00009571 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00009572 }
drh86c779f2021-05-15 13:08:44 +00009573 BTREE_CLEAR_CELL(rc, pPage, pCell, info);
danielk19776b456a22005-03-21 04:04:02 +00009574 if( rc ) goto cleardatabasepage_out;
drh8b2f49b2001-06-08 00:21:52 +00009575 }
drha34b6762004-05-07 13:30:42 +00009576 if( !pPage->leaf ){
dan8ce71842014-01-14 20:14:09 +00009577 rc = clearDatabasePage(pBt, get4byte(&pPage->aData[hdr+8]), 1, pnChange);
danielk19776b456a22005-03-21 04:04:02 +00009578 if( rc ) goto cleardatabasepage_out;
dan020c4f32021-06-22 18:06:23 +00009579 if( pPage->intKey ) pnChange = 0;
drha6df0e62021-06-03 18:51:51 +00009580 }
9581 if( pnChange ){
drhafe028a2015-05-22 13:09:50 +00009582 testcase( !pPage->intKey );
danielk1977c7af4842008-10-27 13:59:33 +00009583 *pnChange += pPage->nCell;
drh2aa679f2001-06-25 02:11:07 +00009584 }
9585 if( freePageFlag ){
drhc314dc72009-07-21 11:52:34 +00009586 freePage(pPage, &rc);
danielk19773b8a05f2007-03-19 17:44:26 +00009587 }else if( (rc = sqlite3PagerWrite(pPage->pDbPage))==0 ){
dan8ce71842014-01-14 20:14:09 +00009588 zeroPage(pPage, pPage->aData[hdr] | PTF_LEAF);
drh2aa679f2001-06-25 02:11:07 +00009589 }
danielk19776b456a22005-03-21 04:04:02 +00009590
9591cleardatabasepage_out:
drhccf46d02015-04-01 13:21:33 +00009592 pPage->bBusy = 0;
drh4b70f112004-05-02 21:12:19 +00009593 releasePage(pPage);
drh2aa679f2001-06-25 02:11:07 +00009594 return rc;
drh8b2f49b2001-06-08 00:21:52 +00009595}
9596
9597/*
drhab01f612004-05-22 02:55:23 +00009598** Delete all information from a single table in the database. iTable is
9599** the page number of the root of the table. After this routine returns,
9600** the root page is empty, but still exists.
9601**
9602** This routine will fail with SQLITE_LOCKED if there are any open
9603** read cursors on the table. Open write cursors are moved to the
9604** root of the table.
danielk1977c7af4842008-10-27 13:59:33 +00009605**
drha6df0e62021-06-03 18:51:51 +00009606** If pnChange is not NULL, then the integer value pointed to by pnChange
9607** is incremented by the number of entries in the table.
drh8b2f49b2001-06-08 00:21:52 +00009608*/
dan2c718872021-06-22 18:32:05 +00009609int sqlite3BtreeClearTable(Btree *p, int iTable, i64 *pnChange){
drh8b2f49b2001-06-08 00:21:52 +00009610 int rc;
danielk1977aef0bf62005-12-30 16:28:01 +00009611 BtShared *pBt = p->pBt;
drhd677b3d2007-08-20 22:48:41 +00009612 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00009613 assert( p->inTrans==TRANS_WRITE );
danielk197796d48e92009-06-29 06:00:37 +00009614
drhc046e3e2009-07-15 11:26:44 +00009615 rc = saveAllCursors(pBt, (Pgno)iTable, 0);
drhd60f4f42012-03-23 14:23:52 +00009616
drhc046e3e2009-07-15 11:26:44 +00009617 if( SQLITE_OK==rc ){
drhd60f4f42012-03-23 14:23:52 +00009618 /* Invalidate all incrblob cursors open on table iTable (assuming iTable
9619 ** is the root of a table b-tree - if it is not, the following call is
9620 ** a no-op). */
drh49bb56e2021-05-14 20:01:36 +00009621 if( p->hasIncrblobCur ){
9622 invalidateIncrblobCursors(p, (Pgno)iTable, 0, 1);
9623 }
danielk197762c14b32008-11-19 09:05:26 +00009624 rc = clearDatabasePage(pBt, (Pgno)iTable, 0, pnChange);
drh8b2f49b2001-06-08 00:21:52 +00009625 }
drhd677b3d2007-08-20 22:48:41 +00009626 sqlite3BtreeLeave(p);
9627 return rc;
drh8b2f49b2001-06-08 00:21:52 +00009628}
9629
9630/*
drh079a3072014-03-19 14:10:55 +00009631** Delete all information from the single table that pCur is open on.
9632**
9633** This routine only work for pCur on an ephemeral table.
9634*/
9635int sqlite3BtreeClearTableOfCursor(BtCursor *pCur){
9636 return sqlite3BtreeClearTable(pCur->pBtree, pCur->pgnoRoot, 0);
9637}
9638
9639/*
drh8b2f49b2001-06-08 00:21:52 +00009640** Erase all information in a table and add the root of the table to
9641** the freelist. Except, the root of the principle table (the one on
drhab01f612004-05-22 02:55:23 +00009642** page 1) is never added to the freelist.
9643**
9644** This routine will fail with SQLITE_LOCKED if there are any open
9645** cursors on the table.
drh205f48e2004-11-05 00:43:11 +00009646**
9647** If AUTOVACUUM is enabled and the page at iTable is not the last
9648** root page in the database file, then the last root page
9649** in the database file is moved into the slot formerly occupied by
9650** iTable and that last slot formerly occupied by the last root page
9651** is added to the freelist instead of iTable. In this say, all
9652** root pages are kept at the beginning of the database file, which
9653** is necessary for AUTOVACUUM to work right. *piMoved is set to the
9654** page number that used to be the last root page in the file before
9655** the move. If no page gets moved, *piMoved is set to 0.
9656** The last root page is recorded in meta[3] and the value of
9657** meta[3] is updated by this procedure.
drh8b2f49b2001-06-08 00:21:52 +00009658*/
danielk197789d40042008-11-17 14:20:56 +00009659static int btreeDropTable(Btree *p, Pgno iTable, int *piMoved){
drh8b2f49b2001-06-08 00:21:52 +00009660 int rc;
danielk1977a0bf2652004-11-04 14:30:04 +00009661 MemPage *pPage = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00009662 BtShared *pBt = p->pBt;
danielk1977a0bf2652004-11-04 14:30:04 +00009663
drh1fee73e2007-08-29 04:00:57 +00009664 assert( sqlite3BtreeHoldsMutex(p) );
drh64022502009-01-09 14:11:04 +00009665 assert( p->inTrans==TRANS_WRITE );
drh65f38d92016-11-22 01:26:42 +00009666 assert( iTable>=2 );
drh9a518842019-03-08 01:52:30 +00009667 if( iTable>btreePagecount(pBt) ){
9668 return SQLITE_CORRUPT_BKPT;
9669 }
drh055f2982016-01-15 15:06:41 +00009670
drhb00fc3b2013-08-21 23:42:32 +00009671 rc = btreeGetPage(pBt, (Pgno)iTable, &pPage, 0);
drh2aa679f2001-06-25 02:11:07 +00009672 if( rc ) return rc;
danielk1977c7af4842008-10-27 13:59:33 +00009673 rc = sqlite3BtreeClearTable(p, iTable, 0);
danielk19776b456a22005-03-21 04:04:02 +00009674 if( rc ){
9675 releasePage(pPage);
9676 return rc;
9677 }
danielk1977a0bf2652004-11-04 14:30:04 +00009678
drh205f48e2004-11-05 00:43:11 +00009679 *piMoved = 0;
danielk1977a0bf2652004-11-04 14:30:04 +00009680
danielk1977a0bf2652004-11-04 14:30:04 +00009681#ifdef SQLITE_OMIT_AUTOVACUUM
drh055f2982016-01-15 15:06:41 +00009682 freePage(pPage, &rc);
9683 releasePage(pPage);
danielk1977a0bf2652004-11-04 14:30:04 +00009684#else
drh055f2982016-01-15 15:06:41 +00009685 if( pBt->autoVacuum ){
9686 Pgno maxRootPgno;
9687 sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00009688
drh055f2982016-01-15 15:06:41 +00009689 if( iTable==maxRootPgno ){
9690 /* If the table being dropped is the table with the largest root-page
9691 ** number in the database, put the root page on the free list.
danielk1977599fcba2004-11-08 07:13:13 +00009692 */
drhc314dc72009-07-21 11:52:34 +00009693 freePage(pPage, &rc);
danielk1977a0bf2652004-11-04 14:30:04 +00009694 releasePage(pPage);
drh055f2982016-01-15 15:06:41 +00009695 if( rc!=SQLITE_OK ){
9696 return rc;
9697 }
9698 }else{
9699 /* The table being dropped does not have the largest root-page
9700 ** number in the database. So move the page that does into the
9701 ** gap left by the deleted root-page.
9702 */
9703 MemPage *pMove;
9704 releasePage(pPage);
9705 rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
9706 if( rc!=SQLITE_OK ){
9707 return rc;
9708 }
9709 rc = relocatePage(pBt, pMove, PTRMAP_ROOTPAGE, 0, iTable, 0);
9710 releasePage(pMove);
9711 if( rc!=SQLITE_OK ){
9712 return rc;
9713 }
9714 pMove = 0;
9715 rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
9716 freePage(pMove, &rc);
9717 releasePage(pMove);
9718 if( rc!=SQLITE_OK ){
9719 return rc;
9720 }
9721 *piMoved = maxRootPgno;
danielk1977a0bf2652004-11-04 14:30:04 +00009722 }
drh055f2982016-01-15 15:06:41 +00009723
9724 /* Set the new 'max-root-page' value in the database header. This
9725 ** is the old value less one, less one more if that happens to
9726 ** be a root-page number, less one again if that is the
9727 ** PENDING_BYTE_PAGE.
drhc046e3e2009-07-15 11:26:44 +00009728 */
drh055f2982016-01-15 15:06:41 +00009729 maxRootPgno--;
9730 while( maxRootPgno==PENDING_BYTE_PAGE(pBt)
9731 || PTRMAP_ISPAGE(pBt, maxRootPgno) ){
9732 maxRootPgno--;
9733 }
9734 assert( maxRootPgno!=PENDING_BYTE_PAGE(pBt) );
9735
9736 rc = sqlite3BtreeUpdateMeta(p, 4, maxRootPgno);
9737 }else{
9738 freePage(pPage, &rc);
danielk1977a0bf2652004-11-04 14:30:04 +00009739 releasePage(pPage);
drh8b2f49b2001-06-08 00:21:52 +00009740 }
drh055f2982016-01-15 15:06:41 +00009741#endif
drh8b2f49b2001-06-08 00:21:52 +00009742 return rc;
9743}
drhd677b3d2007-08-20 22:48:41 +00009744int sqlite3BtreeDropTable(Btree *p, int iTable, int *piMoved){
9745 int rc;
9746 sqlite3BtreeEnter(p);
dan7733a4d2011-09-02 18:03:16 +00009747 rc = btreeDropTable(p, iTable, piMoved);
drhd677b3d2007-08-20 22:48:41 +00009748 sqlite3BtreeLeave(p);
9749 return rc;
9750}
drh8b2f49b2001-06-08 00:21:52 +00009751
drh001bbcb2003-03-19 03:14:00 +00009752
drh8b2f49b2001-06-08 00:21:52 +00009753/*
danielk1977602b4662009-07-02 07:47:33 +00009754** This function may only be called if the b-tree connection already
9755** has a read or write transaction open on the database.
9756**
drh23e11ca2004-05-04 17:27:28 +00009757** Read the meta-information out of a database file. Meta[0]
9758** is the number of free pages currently in the database. Meta[1]
drha3b321d2004-05-11 09:31:31 +00009759** through meta[15] are available for use by higher layers. Meta[0]
9760** is read-only, the others are read/write.
9761**
9762** The schema layer numbers meta values differently. At the schema
9763** layer (and the SetCookie and ReadCookie opcodes) the number of
9764** free pages is not visible. So Cookie[0] is the same as Meta[1].
drh91618562014-12-19 19:28:02 +00009765**
9766** This routine treats Meta[BTREE_DATA_VERSION] as a special case. Instead
9767** of reading the value out of the header, it instead loads the "DataVersion"
9768** from the pager. The BTREE_DATA_VERSION value is not actually stored in the
9769** database file. It is a number computed by the pager. But its access
9770** pattern is the same as header meta values, and so it is convenient to
9771** read it from this routine.
drh8b2f49b2001-06-08 00:21:52 +00009772*/
danielk1977602b4662009-07-02 07:47:33 +00009773void sqlite3BtreeGetMeta(Btree *p, int idx, u32 *pMeta){
danielk1977aef0bf62005-12-30 16:28:01 +00009774 BtShared *pBt = p->pBt;
drh8b2f49b2001-06-08 00:21:52 +00009775
drhd677b3d2007-08-20 22:48:41 +00009776 sqlite3BtreeEnter(p);
danielk1977602b4662009-07-02 07:47:33 +00009777 assert( p->inTrans>TRANS_NONE );
drh346a70c2020-06-15 20:27:35 +00009778 assert( SQLITE_OK==querySharedCacheTableLock(p, SCHEMA_ROOT, READ_LOCK) );
danielk1977602b4662009-07-02 07:47:33 +00009779 assert( pBt->pPage1 );
drh23e11ca2004-05-04 17:27:28 +00009780 assert( idx>=0 && idx<=15 );
danielk1977ea897302008-09-19 15:10:58 +00009781
drh91618562014-12-19 19:28:02 +00009782 if( idx==BTREE_DATA_VERSION ){
drh2b994ce2021-03-18 12:36:09 +00009783 *pMeta = sqlite3PagerDataVersion(pBt->pPager) + p->iBDataVersion;
drh91618562014-12-19 19:28:02 +00009784 }else{
9785 *pMeta = get4byte(&pBt->pPage1->aData[36 + idx*4]);
9786 }
drhae157872004-08-14 19:20:09 +00009787
danielk1977602b4662009-07-02 07:47:33 +00009788 /* If auto-vacuum is disabled in this build and this is an auto-vacuum
9789 ** database, mark the database as read-only. */
danielk1977003ba062004-11-04 02:57:33 +00009790#ifdef SQLITE_OMIT_AUTOVACUUM
drhc9166342012-01-05 23:32:06 +00009791 if( idx==BTREE_LARGEST_ROOT_PAGE && *pMeta>0 ){
9792 pBt->btsFlags |= BTS_READ_ONLY;
9793 }
danielk1977003ba062004-11-04 02:57:33 +00009794#endif
drhae157872004-08-14 19:20:09 +00009795
drhd677b3d2007-08-20 22:48:41 +00009796 sqlite3BtreeLeave(p);
drh8b2f49b2001-06-08 00:21:52 +00009797}
9798
9799/*
drh23e11ca2004-05-04 17:27:28 +00009800** Write meta-information back into the database. Meta[0] is
9801** read-only and may not be written.
drh8b2f49b2001-06-08 00:21:52 +00009802*/
danielk1977aef0bf62005-12-30 16:28:01 +00009803int sqlite3BtreeUpdateMeta(Btree *p, int idx, u32 iMeta){
9804 BtShared *pBt = p->pBt;
drh4b70f112004-05-02 21:12:19 +00009805 unsigned char *pP1;
drha34b6762004-05-07 13:30:42 +00009806 int rc;
drh23e11ca2004-05-04 17:27:28 +00009807 assert( idx>=1 && idx<=15 );
drhd677b3d2007-08-20 22:48:41 +00009808 sqlite3BtreeEnter(p);
drh64022502009-01-09 14:11:04 +00009809 assert( p->inTrans==TRANS_WRITE );
9810 assert( pBt->pPage1!=0 );
9811 pP1 = pBt->pPage1->aData;
9812 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
9813 if( rc==SQLITE_OK ){
9814 put4byte(&pP1[36 + idx*4], iMeta);
danielk19774152e672007-09-12 17:01:45 +00009815#ifndef SQLITE_OMIT_AUTOVACUUM
danielk19770d19f7a2009-06-03 11:25:07 +00009816 if( idx==BTREE_INCR_VACUUM ){
drh64022502009-01-09 14:11:04 +00009817 assert( pBt->autoVacuum || iMeta==0 );
9818 assert( iMeta==0 || iMeta==1 );
9819 pBt->incrVacuum = (u8)iMeta;
drhd677b3d2007-08-20 22:48:41 +00009820 }
drh64022502009-01-09 14:11:04 +00009821#endif
drh5df72a52002-06-06 23:16:05 +00009822 }
drhd677b3d2007-08-20 22:48:41 +00009823 sqlite3BtreeLeave(p);
9824 return rc;
drh8b2f49b2001-06-08 00:21:52 +00009825}
drh8c42ca92001-06-22 19:15:00 +00009826
danielk1977a5533162009-02-24 10:01:51 +00009827/*
9828** The first argument, pCur, is a cursor opened on some b-tree. Count the
9829** number of entries in the b-tree and write the result to *pnEntry.
9830**
9831** SQLITE_OK is returned if the operation is successfully executed.
9832** Otherwise, if an error is encountered (i.e. an IO error or database
9833** corruption) an SQLite error code is returned.
9834*/
drh21f6daa2019-10-11 14:21:48 +00009835int sqlite3BtreeCount(sqlite3 *db, BtCursor *pCur, i64 *pnEntry){
danielk1977a5533162009-02-24 10:01:51 +00009836 i64 nEntry = 0; /* Value to return in *pnEntry */
9837 int rc; /* Return code */
dana205a482011-08-27 18:48:57 +00009838
drh44548e72017-08-14 18:13:52 +00009839 rc = moveToRoot(pCur);
9840 if( rc==SQLITE_EMPTY ){
dana205a482011-08-27 18:48:57 +00009841 *pnEntry = 0;
9842 return SQLITE_OK;
9843 }
danielk1977a5533162009-02-24 10:01:51 +00009844
9845 /* Unless an error occurs, the following loop runs one iteration for each
9846 ** page in the B-Tree structure (not including overflow pages).
9847 */
dan892edb62020-03-30 13:35:05 +00009848 while( rc==SQLITE_OK && !AtomicLoad(&db->u1.isInterrupted) ){
danielk1977a5533162009-02-24 10:01:51 +00009849 int iIdx; /* Index of child node in parent */
9850 MemPage *pPage; /* Current page of the b-tree */
9851
9852 /* If this is a leaf page or the tree is not an int-key tree, then
9853 ** this page contains countable entries. Increment the entry counter
9854 ** accordingly.
9855 */
drh352a35a2017-08-15 03:46:47 +00009856 pPage = pCur->pPage;
danielk1977a5533162009-02-24 10:01:51 +00009857 if( pPage->leaf || !pPage->intKey ){
9858 nEntry += pPage->nCell;
9859 }
9860
9861 /* pPage is a leaf node. This loop navigates the cursor so that it
9862 ** points to the first interior cell that it points to the parent of
9863 ** the next page in the tree that has not yet been visited. The
9864 ** pCur->aiIdx[pCur->iPage] value is set to the index of the parent cell
9865 ** of the page, or to the number of cells in the page if the next page
9866 ** to visit is the right-child of its parent.
9867 **
9868 ** If all pages in the tree have been visited, return SQLITE_OK to the
9869 ** caller.
9870 */
9871 if( pPage->leaf ){
9872 do {
9873 if( pCur->iPage==0 ){
9874 /* All pages of the b-tree have been visited. Return successfully. */
9875 *pnEntry = nEntry;
drh7efa4262014-12-16 00:08:31 +00009876 return moveToRoot(pCur);
danielk1977a5533162009-02-24 10:01:51 +00009877 }
danielk197730548662009-07-09 05:07:37 +00009878 moveToParent(pCur);
drh352a35a2017-08-15 03:46:47 +00009879 }while ( pCur->ix>=pCur->pPage->nCell );
danielk1977a5533162009-02-24 10:01:51 +00009880
drh75e96b32017-04-01 00:20:06 +00009881 pCur->ix++;
drh352a35a2017-08-15 03:46:47 +00009882 pPage = pCur->pPage;
danielk1977a5533162009-02-24 10:01:51 +00009883 }
9884
9885 /* Descend to the child node of the cell that the cursor currently
9886 ** points at. This is the right-child if (iIdx==pPage->nCell).
9887 */
drh75e96b32017-04-01 00:20:06 +00009888 iIdx = pCur->ix;
danielk1977a5533162009-02-24 10:01:51 +00009889 if( iIdx==pPage->nCell ){
9890 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
9891 }else{
9892 rc = moveToChild(pCur, get4byte(findCell(pPage, iIdx)));
9893 }
9894 }
9895
shanebe217792009-03-05 04:20:31 +00009896 /* An error has occurred. Return an error code. */
danielk1977a5533162009-02-24 10:01:51 +00009897 return rc;
9898}
drhdd793422001-06-28 01:54:48 +00009899
drhdd793422001-06-28 01:54:48 +00009900/*
drh5eddca62001-06-30 21:53:53 +00009901** Return the pager associated with a BTree. This routine is used for
9902** testing and debugging only.
drhdd793422001-06-28 01:54:48 +00009903*/
danielk1977aef0bf62005-12-30 16:28:01 +00009904Pager *sqlite3BtreePager(Btree *p){
9905 return p->pBt->pPager;
drhdd793422001-06-28 01:54:48 +00009906}
drh5eddca62001-06-30 21:53:53 +00009907
drhb7f91642004-10-31 02:22:47 +00009908#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00009909/*
9910** Append a message to the error message string.
9911*/
drh2e38c322004-09-03 18:38:44 +00009912static void checkAppendMsg(
9913 IntegrityCk *pCheck,
drh2e38c322004-09-03 18:38:44 +00009914 const char *zFormat,
9915 ...
9916){
9917 va_list ap;
drh1dcdbc02007-01-27 02:24:54 +00009918 if( !pCheck->mxErr ) return;
9919 pCheck->mxErr--;
9920 pCheck->nErr++;
drh2e38c322004-09-03 18:38:44 +00009921 va_start(ap, zFormat);
drhf089aa42008-07-08 19:34:06 +00009922 if( pCheck->errMsg.nChar ){
drh0cdbe1a2018-05-09 13:46:26 +00009923 sqlite3_str_append(&pCheck->errMsg, "\n", 1);
drh5eddca62001-06-30 21:53:53 +00009924 }
drh867db832014-09-26 02:41:05 +00009925 if( pCheck->zPfx ){
drh0cdbe1a2018-05-09 13:46:26 +00009926 sqlite3_str_appendf(&pCheck->errMsg, pCheck->zPfx, pCheck->v1, pCheck->v2);
drhf089aa42008-07-08 19:34:06 +00009927 }
drh0cdbe1a2018-05-09 13:46:26 +00009928 sqlite3_str_vappendf(&pCheck->errMsg, zFormat, ap);
drhf089aa42008-07-08 19:34:06 +00009929 va_end(ap);
drh0cdbe1a2018-05-09 13:46:26 +00009930 if( pCheck->errMsg.accError==SQLITE_NOMEM ){
drh8ddf6352020-06-29 18:30:49 +00009931 pCheck->bOomFault = 1;
drhc890fec2008-08-01 20:10:08 +00009932 }
drh5eddca62001-06-30 21:53:53 +00009933}
drhb7f91642004-10-31 02:22:47 +00009934#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00009935
drhb7f91642004-10-31 02:22:47 +00009936#ifndef SQLITE_OMIT_INTEGRITY_CHECK
dan1235bb12012-04-03 17:43:28 +00009937
9938/*
9939** Return non-zero if the bit in the IntegrityCk.aPgRef[] array that
9940** corresponds to page iPg is already set.
9941*/
9942static int getPageReferenced(IntegrityCk *pCheck, Pgno iPg){
9943 assert( iPg<=pCheck->nPage && sizeof(pCheck->aPgRef[0])==1 );
9944 return (pCheck->aPgRef[iPg/8] & (1 << (iPg & 0x07)));
9945}
9946
9947/*
9948** Set the bit in the IntegrityCk.aPgRef[] array that corresponds to page iPg.
9949*/
9950static void setPageReferenced(IntegrityCk *pCheck, Pgno iPg){
9951 assert( iPg<=pCheck->nPage && sizeof(pCheck->aPgRef[0])==1 );
9952 pCheck->aPgRef[iPg/8] |= (1 << (iPg & 0x07));
9953}
9954
9955
drh5eddca62001-06-30 21:53:53 +00009956/*
9957** Add 1 to the reference count for page iPage. If this is the second
9958** reference to the page, add an error message to pCheck->zErrMsg.
peter.d.reid60ec9142014-09-06 16:39:46 +00009959** Return 1 if there are 2 or more references to the page and 0 if
drh5eddca62001-06-30 21:53:53 +00009960** if this is the first reference to the page.
9961**
9962** Also check that the page number is in bounds.
9963*/
drh867db832014-09-26 02:41:05 +00009964static int checkRef(IntegrityCk *pCheck, Pgno iPage){
drh91d58662018-07-20 13:39:28 +00009965 if( iPage>pCheck->nPage || iPage==0 ){
drh867db832014-09-26 02:41:05 +00009966 checkAppendMsg(pCheck, "invalid page number %d", iPage);
drh5eddca62001-06-30 21:53:53 +00009967 return 1;
9968 }
dan1235bb12012-04-03 17:43:28 +00009969 if( getPageReferenced(pCheck, iPage) ){
drh867db832014-09-26 02:41:05 +00009970 checkAppendMsg(pCheck, "2nd reference to page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00009971 return 1;
9972 }
dan892edb62020-03-30 13:35:05 +00009973 if( AtomicLoad(&pCheck->db->u1.isInterrupted) ) return 1;
dan1235bb12012-04-03 17:43:28 +00009974 setPageReferenced(pCheck, iPage);
9975 return 0;
drh5eddca62001-06-30 21:53:53 +00009976}
9977
danielk1977afcdd022004-10-31 16:25:42 +00009978#ifndef SQLITE_OMIT_AUTOVACUUM
9979/*
9980** Check that the entry in the pointer-map for page iChild maps to
9981** page iParent, pointer type ptrType. If not, append an error message
9982** to pCheck.
9983*/
9984static void checkPtrmap(
9985 IntegrityCk *pCheck, /* Integrity check context */
9986 Pgno iChild, /* Child page number */
9987 u8 eType, /* Expected pointer map type */
drh867db832014-09-26 02:41:05 +00009988 Pgno iParent /* Expected pointer map parent page number */
danielk1977afcdd022004-10-31 16:25:42 +00009989){
9990 int rc;
9991 u8 ePtrmapType;
9992 Pgno iPtrmapParent;
9993
9994 rc = ptrmapGet(pCheck->pBt, iChild, &ePtrmapType, &iPtrmapParent);
9995 if( rc!=SQLITE_OK ){
drh8ddf6352020-06-29 18:30:49 +00009996 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ) pCheck->bOomFault = 1;
drh867db832014-09-26 02:41:05 +00009997 checkAppendMsg(pCheck, "Failed to read ptrmap key=%d", iChild);
danielk1977afcdd022004-10-31 16:25:42 +00009998 return;
9999 }
10000
10001 if( ePtrmapType!=eType || iPtrmapParent!=iParent ){
drh867db832014-09-26 02:41:05 +000010002 checkAppendMsg(pCheck,
danielk1977afcdd022004-10-31 16:25:42 +000010003 "Bad ptr map entry key=%d expected=(%d,%d) got=(%d,%d)",
10004 iChild, eType, iParent, ePtrmapType, iPtrmapParent);
10005 }
10006}
10007#endif
10008
drh5eddca62001-06-30 21:53:53 +000010009/*
10010** Check the integrity of the freelist or of an overflow page list.
10011** Verify that the number of pages on the list is N.
10012*/
drh30e58752002-03-02 20:41:57 +000010013static void checkList(
10014 IntegrityCk *pCheck, /* Integrity checking context */
10015 int isFreeList, /* True for a freelist. False for overflow page list */
drhabc38152020-07-22 13:38:04 +000010016 Pgno iPage, /* Page number for first page in the list */
drheaac9992019-02-26 16:17:06 +000010017 u32 N /* Expected number of pages in the list */
drh30e58752002-03-02 20:41:57 +000010018){
10019 int i;
drheaac9992019-02-26 16:17:06 +000010020 u32 expected = N;
drh91d58662018-07-20 13:39:28 +000010021 int nErrAtStart = pCheck->nErr;
10022 while( iPage!=0 && pCheck->mxErr ){
danielk19773b8a05f2007-03-19 17:44:26 +000010023 DbPage *pOvflPage;
10024 unsigned char *pOvflData;
drh867db832014-09-26 02:41:05 +000010025 if( checkRef(pCheck, iPage) ) break;
drh91d58662018-07-20 13:39:28 +000010026 N--;
drh9584f582015-11-04 20:22:37 +000010027 if( sqlite3PagerGet(pCheck->pPager, (Pgno)iPage, &pOvflPage, 0) ){
drh867db832014-09-26 02:41:05 +000010028 checkAppendMsg(pCheck, "failed to get page %d", iPage);
drh5eddca62001-06-30 21:53:53 +000010029 break;
10030 }
danielk19773b8a05f2007-03-19 17:44:26 +000010031 pOvflData = (unsigned char *)sqlite3PagerGetData(pOvflPage);
drh30e58752002-03-02 20:41:57 +000010032 if( isFreeList ){
drhae104742018-12-14 17:57:01 +000010033 u32 n = (u32)get4byte(&pOvflData[4]);
danielk1977687566d2004-11-02 12:56:41 +000010034#ifndef SQLITE_OMIT_AUTOVACUUM
10035 if( pCheck->pBt->autoVacuum ){
drh867db832014-09-26 02:41:05 +000010036 checkPtrmap(pCheck, iPage, PTRMAP_FREEPAGE, 0);
danielk1977687566d2004-11-02 12:56:41 +000010037 }
10038#endif
drhae104742018-12-14 17:57:01 +000010039 if( n>pCheck->pBt->usableSize/4-2 ){
drh867db832014-09-26 02:41:05 +000010040 checkAppendMsg(pCheck,
drh2e38c322004-09-03 18:38:44 +000010041 "freelist leaf count too big on page %d", iPage);
drhee696e22004-08-30 16:52:17 +000010042 N--;
10043 }else{
drhae104742018-12-14 17:57:01 +000010044 for(i=0; i<(int)n; i++){
danielk19773b8a05f2007-03-19 17:44:26 +000010045 Pgno iFreePage = get4byte(&pOvflData[8+i*4]);
danielk1977687566d2004-11-02 12:56:41 +000010046#ifndef SQLITE_OMIT_AUTOVACUUM
10047 if( pCheck->pBt->autoVacuum ){
drh867db832014-09-26 02:41:05 +000010048 checkPtrmap(pCheck, iFreePage, PTRMAP_FREEPAGE, 0);
danielk1977687566d2004-11-02 12:56:41 +000010049 }
10050#endif
drh867db832014-09-26 02:41:05 +000010051 checkRef(pCheck, iFreePage);
drhee696e22004-08-30 16:52:17 +000010052 }
10053 N -= n;
drh30e58752002-03-02 20:41:57 +000010054 }
drh30e58752002-03-02 20:41:57 +000010055 }
danielk1977afcdd022004-10-31 16:25:42 +000010056#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +000010057 else{
10058 /* If this database supports auto-vacuum and iPage is not the last
10059 ** page in this overflow list, check that the pointer-map entry for
10060 ** the following page matches iPage.
10061 */
10062 if( pCheck->pBt->autoVacuum && N>0 ){
danielk19773b8a05f2007-03-19 17:44:26 +000010063 i = get4byte(pOvflData);
drh867db832014-09-26 02:41:05 +000010064 checkPtrmap(pCheck, i, PTRMAP_OVERFLOW2, iPage);
danielk1977687566d2004-11-02 12:56:41 +000010065 }
danielk1977afcdd022004-10-31 16:25:42 +000010066 }
10067#endif
danielk19773b8a05f2007-03-19 17:44:26 +000010068 iPage = get4byte(pOvflData);
10069 sqlite3PagerUnref(pOvflPage);
drh91d58662018-07-20 13:39:28 +000010070 }
10071 if( N && nErrAtStart==pCheck->nErr ){
10072 checkAppendMsg(pCheck,
10073 "%s is %d but should be %d",
10074 isFreeList ? "size" : "overflow list length",
10075 expected-N, expected);
drh5eddca62001-06-30 21:53:53 +000010076 }
10077}
drhb7f91642004-10-31 02:22:47 +000010078#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +000010079
drh67731a92015-04-16 11:56:03 +000010080/*
10081** An implementation of a min-heap.
10082**
10083** aHeap[0] is the number of elements on the heap. aHeap[1] is the
drha33b6832015-04-16 21:57:37 +000010084** root element. The daughter nodes of aHeap[N] are aHeap[N*2]
drh67731a92015-04-16 11:56:03 +000010085** and aHeap[N*2+1].
10086**
10087** The heap property is this: Every node is less than or equal to both
10088** of its daughter nodes. A consequence of the heap property is that the
drh42c0a2b2015-04-28 01:28:36 +000010089** root node aHeap[1] is always the minimum value currently in the heap.
drh67731a92015-04-16 11:56:03 +000010090**
10091** The btreeHeapInsert() routine inserts an unsigned 32-bit number onto
10092** the heap, preserving the heap property. The btreeHeapPull() routine
10093** removes the root element from the heap (the minimum value in the heap)
drh42c0a2b2015-04-28 01:28:36 +000010094** and then moves other nodes around as necessary to preserve the heap
drh67731a92015-04-16 11:56:03 +000010095** property.
10096**
10097** This heap is used for cell overlap and coverage testing. Each u32
10098** entry represents the span of a cell or freeblock on a btree page.
10099** The upper 16 bits are the index of the first byte of a range and the
10100** lower 16 bits are the index of the last byte of that range.
10101*/
10102static void btreeHeapInsert(u32 *aHeap, u32 x){
10103 u32 j, i = ++aHeap[0];
10104 aHeap[i] = x;
drha33b6832015-04-16 21:57:37 +000010105 while( (j = i/2)>0 && aHeap[j]>aHeap[i] ){
drh67731a92015-04-16 11:56:03 +000010106 x = aHeap[j];
10107 aHeap[j] = aHeap[i];
10108 aHeap[i] = x;
10109 i = j;
10110 }
10111}
10112static int btreeHeapPull(u32 *aHeap, u32 *pOut){
10113 u32 j, i, x;
10114 if( (x = aHeap[0])==0 ) return 0;
10115 *pOut = aHeap[1];
10116 aHeap[1] = aHeap[x];
10117 aHeap[x] = 0xffffffff;
10118 aHeap[0]--;
10119 i = 1;
10120 while( (j = i*2)<=aHeap[0] ){
10121 if( aHeap[j]>aHeap[j+1] ) j++;
10122 if( aHeap[i]<aHeap[j] ) break;
10123 x = aHeap[i];
10124 aHeap[i] = aHeap[j];
10125 aHeap[j] = x;
10126 i = j;
10127 }
10128 return 1;
10129}
10130
drhb7f91642004-10-31 02:22:47 +000010131#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +000010132/*
10133** Do various sanity checks on a single page of a tree. Return
10134** the tree depth. Root pages return 0. Parents of root pages
10135** return 1, and so forth.
10136**
10137** These checks are done:
10138**
10139** 1. Make sure that cells and freeblocks do not overlap
10140** but combine to completely cover the page.
drhe05b3f82015-07-01 17:53:49 +000010141** 2. Make sure integer cell keys are in order.
10142** 3. Check the integrity of overflow pages.
10143** 4. Recursively call checkTreePage on all children.
10144** 5. Verify that the depth of all children is the same.
drh5eddca62001-06-30 21:53:53 +000010145*/
10146static int checkTreePage(
drhaaab5722002-02-19 13:39:21 +000010147 IntegrityCk *pCheck, /* Context for the sanity check */
drhabc38152020-07-22 13:38:04 +000010148 Pgno iPage, /* Page number of the page to check */
drhcbc6b712015-07-02 16:17:30 +000010149 i64 *piMinKey, /* Write minimum integer primary key here */
10150 i64 maxKey /* Error if integer primary key greater than this */
drh5eddca62001-06-30 21:53:53 +000010151){
drhcbc6b712015-07-02 16:17:30 +000010152 MemPage *pPage = 0; /* The page being analyzed */
10153 int i; /* Loop counter */
10154 int rc; /* Result code from subroutine call */
10155 int depth = -1, d2; /* Depth of a subtree */
10156 int pgno; /* Page number */
10157 int nFrag; /* Number of fragmented bytes on the page */
10158 int hdr; /* Offset to the page header */
10159 int cellStart; /* Offset to the start of the cell pointer array */
10160 int nCell; /* Number of cells */
10161 int doCoverageCheck = 1; /* True if cell coverage checking should be done */
10162 int keyCanBeEqual = 1; /* True if IPK can be equal to maxKey
10163 ** False if IPK must be strictly less than maxKey */
10164 u8 *data; /* Page content */
10165 u8 *pCell; /* Cell content */
10166 u8 *pCellIdx; /* Next element of the cell pointer array */
10167 BtShared *pBt; /* The BtShared object that owns pPage */
10168 u32 pc; /* Address of a cell */
10169 u32 usableSize; /* Usable size of the page */
10170 u32 contentOffset; /* Offset to the start of the cell content area */
10171 u32 *heap = 0; /* Min-heap used for checking cell coverage */
drhd2dc87f2015-07-02 19:47:08 +000010172 u32 x, prev = 0; /* Next and previous entry on the min-heap */
drh867db832014-09-26 02:41:05 +000010173 const char *saved_zPfx = pCheck->zPfx;
10174 int saved_v1 = pCheck->v1;
10175 int saved_v2 = pCheck->v2;
mistachkin532f1792015-07-14 17:18:05 +000010176 u8 savedIsInit = 0;
danielk1977ef73ee92004-11-06 12:26:07 +000010177
drh5eddca62001-06-30 21:53:53 +000010178 /* Check that the page exists
10179 */
drhd9cb6ac2005-10-20 07:28:17 +000010180 pBt = pCheck->pBt;
drhb6f41482004-05-14 01:58:11 +000010181 usableSize = pBt->usableSize;
drh5eddca62001-06-30 21:53:53 +000010182 if( iPage==0 ) return 0;
drh867db832014-09-26 02:41:05 +000010183 if( checkRef(pCheck, iPage) ) return 0;
drhabc38152020-07-22 13:38:04 +000010184 pCheck->zPfx = "Page %u: ";
drh867db832014-09-26 02:41:05 +000010185 pCheck->v1 = iPage;
drhabc38152020-07-22 13:38:04 +000010186 if( (rc = btreeGetPage(pBt, iPage, &pPage, 0))!=0 ){
drh867db832014-09-26 02:41:05 +000010187 checkAppendMsg(pCheck,
drh2e38c322004-09-03 18:38:44 +000010188 "unable to get the page. error code=%d", rc);
drh867db832014-09-26 02:41:05 +000010189 goto end_of_check;
drh5eddca62001-06-30 21:53:53 +000010190 }
danielk197793caf5a2009-07-11 06:55:33 +000010191
10192 /* Clear MemPage.isInit to make sure the corruption detection code in
10193 ** btreeInitPage() is executed. */
drh72e191e2015-07-04 11:14:20 +000010194 savedIsInit = pPage->isInit;
danielk197793caf5a2009-07-11 06:55:33 +000010195 pPage->isInit = 0;
danielk197730548662009-07-09 05:07:37 +000010196 if( (rc = btreeInitPage(pPage))!=0 ){
drh64022502009-01-09 14:11:04 +000010197 assert( rc==SQLITE_CORRUPT ); /* The only possible error from InitPage */
drh867db832014-09-26 02:41:05 +000010198 checkAppendMsg(pCheck,
danielk197730548662009-07-09 05:07:37 +000010199 "btreeInitPage() returns error code %d", rc);
drh867db832014-09-26 02:41:05 +000010200 goto end_of_check;
drh5eddca62001-06-30 21:53:53 +000010201 }
drhb0ea9432019-02-09 21:06:40 +000010202 if( (rc = btreeComputeFreeSpace(pPage))!=0 ){
10203 assert( rc==SQLITE_CORRUPT );
10204 checkAppendMsg(pCheck, "free space corruption", rc);
10205 goto end_of_check;
10206 }
drhcbc6b712015-07-02 16:17:30 +000010207 data = pPage->aData;
10208 hdr = pPage->hdrOffset;
drh5eddca62001-06-30 21:53:53 +000010209
drhcbc6b712015-07-02 16:17:30 +000010210 /* Set up for cell analysis */
drhabc38152020-07-22 13:38:04 +000010211 pCheck->zPfx = "On tree page %u cell %d: ";
drhcbc6b712015-07-02 16:17:30 +000010212 contentOffset = get2byteNotZero(&data[hdr+5]);
10213 assert( contentOffset<=usableSize ); /* Enforced by btreeInitPage() */
10214
10215 /* EVIDENCE-OF: R-37002-32774 The two-byte integer at offset 3 gives the
10216 ** number of cells on the page. */
10217 nCell = get2byte(&data[hdr+3]);
10218 assert( pPage->nCell==nCell );
10219
10220 /* EVIDENCE-OF: R-23882-45353 The cell pointer array of a b-tree page
10221 ** immediately follows the b-tree page header. */
10222 cellStart = hdr + 12 - 4*pPage->leaf;
10223 assert( pPage->aCellIdx==&data[cellStart] );
10224 pCellIdx = &data[cellStart + 2*(nCell-1)];
10225
10226 if( !pPage->leaf ){
10227 /* Analyze the right-child page of internal pages */
10228 pgno = get4byte(&data[hdr+8]);
10229#ifndef SQLITE_OMIT_AUTOVACUUM
10230 if( pBt->autoVacuum ){
drhabc38152020-07-22 13:38:04 +000010231 pCheck->zPfx = "On page %u at right child: ";
drhcbc6b712015-07-02 16:17:30 +000010232 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage);
10233 }
10234#endif
10235 depth = checkTreePage(pCheck, pgno, &maxKey, maxKey);
10236 keyCanBeEqual = 0;
10237 }else{
10238 /* For leaf pages, the coverage check will occur in the same loop
10239 ** as the other cell checks, so initialize the heap. */
10240 heap = pCheck->heap;
10241 heap[0] = 0;
drh5eddca62001-06-30 21:53:53 +000010242 }
10243
drhcbc6b712015-07-02 16:17:30 +000010244 /* EVIDENCE-OF: R-02776-14802 The cell pointer array consists of K 2-byte
10245 ** integer offsets to the cell contents. */
10246 for(i=nCell-1; i>=0 && pCheck->mxErr; i--){
drh6f11bef2004-05-13 01:12:56 +000010247 CellInfo info;
drh5eddca62001-06-30 21:53:53 +000010248
drhcbc6b712015-07-02 16:17:30 +000010249 /* Check cell size */
drh867db832014-09-26 02:41:05 +000010250 pCheck->v2 = i;
drhcbc6b712015-07-02 16:17:30 +000010251 assert( pCellIdx==&data[cellStart + i*2] );
10252 pc = get2byteAligned(pCellIdx);
10253 pCellIdx -= 2;
10254 if( pc<contentOffset || pc>usableSize-4 ){
10255 checkAppendMsg(pCheck, "Offset %d out of range %d..%d",
10256 pc, contentOffset, usableSize-4);
10257 doCoverageCheck = 0;
10258 continue;
shaneh195475d2010-02-19 04:28:08 +000010259 }
drhcbc6b712015-07-02 16:17:30 +000010260 pCell = &data[pc];
10261 pPage->xParseCell(pPage, pCell, &info);
10262 if( pc+info.nSize>usableSize ){
10263 checkAppendMsg(pCheck, "Extends off end of page");
10264 doCoverageCheck = 0;
10265 continue;
drh5eddca62001-06-30 21:53:53 +000010266 }
10267
drhcbc6b712015-07-02 16:17:30 +000010268 /* Check for integer primary key out of range */
10269 if( pPage->intKey ){
10270 if( keyCanBeEqual ? (info.nKey > maxKey) : (info.nKey >= maxKey) ){
10271 checkAppendMsg(pCheck, "Rowid %lld out of order", info.nKey);
10272 }
10273 maxKey = info.nKey;
dan4b2667c2017-05-01 18:24:01 +000010274 keyCanBeEqual = 0; /* Only the first key on the page may ==maxKey */
drhcbc6b712015-07-02 16:17:30 +000010275 }
10276
10277 /* Check the content overflow list */
10278 if( info.nPayload>info.nLocal ){
drheaac9992019-02-26 16:17:06 +000010279 u32 nPage; /* Number of pages on the overflow chain */
drhcbc6b712015-07-02 16:17:30 +000010280 Pgno pgnoOvfl; /* First page of the overflow chain */
drh45ac1c72015-12-18 03:59:16 +000010281 assert( pc + info.nSize - 4 <= usableSize );
drhcbc6b712015-07-02 16:17:30 +000010282 nPage = (info.nPayload - info.nLocal + usableSize - 5)/(usableSize - 4);
drh45ac1c72015-12-18 03:59:16 +000010283 pgnoOvfl = get4byte(&pCell[info.nSize - 4]);
drhda200cc2004-05-09 11:51:38 +000010284#ifndef SQLITE_OMIT_AUTOVACUUM
10285 if( pBt->autoVacuum ){
drh867db832014-09-26 02:41:05 +000010286 checkPtrmap(pCheck, pgnoOvfl, PTRMAP_OVERFLOW1, iPage);
drhda200cc2004-05-09 11:51:38 +000010287 }
10288#endif
drh867db832014-09-26 02:41:05 +000010289 checkList(pCheck, 0, pgnoOvfl, nPage);
drh5eddca62001-06-30 21:53:53 +000010290 }
10291
drh5eddca62001-06-30 21:53:53 +000010292 if( !pPage->leaf ){
drhcbc6b712015-07-02 16:17:30 +000010293 /* Check sanity of left child page for internal pages */
drh43605152004-05-29 21:46:49 +000010294 pgno = get4byte(pCell);
danielk1977afcdd022004-10-31 16:25:42 +000010295#ifndef SQLITE_OMIT_AUTOVACUUM
10296 if( pBt->autoVacuum ){
drh867db832014-09-26 02:41:05 +000010297 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage);
danielk1977afcdd022004-10-31 16:25:42 +000010298 }
10299#endif
drhcbc6b712015-07-02 16:17:30 +000010300 d2 = checkTreePage(pCheck, pgno, &maxKey, maxKey);
10301 keyCanBeEqual = 0;
10302 if( d2!=depth ){
drh867db832014-09-26 02:41:05 +000010303 checkAppendMsg(pCheck, "Child page depth differs");
drhcbc6b712015-07-02 16:17:30 +000010304 depth = d2;
drh5eddca62001-06-30 21:53:53 +000010305 }
drhcbc6b712015-07-02 16:17:30 +000010306 }else{
10307 /* Populate the coverage-checking heap for leaf pages */
10308 btreeHeapInsert(heap, (pc<<16)|(pc+info.nSize-1));
drh5eddca62001-06-30 21:53:53 +000010309 }
10310 }
drhcbc6b712015-07-02 16:17:30 +000010311 *piMinKey = maxKey;
shaneh195475d2010-02-19 04:28:08 +000010312
drh5eddca62001-06-30 21:53:53 +000010313 /* Check for complete coverage of the page
10314 */
drh867db832014-09-26 02:41:05 +000010315 pCheck->zPfx = 0;
drhcbc6b712015-07-02 16:17:30 +000010316 if( doCoverageCheck && pCheck->mxErr>0 ){
10317 /* For leaf pages, the min-heap has already been initialized and the
10318 ** cells have already been inserted. But for internal pages, that has
10319 ** not yet been done, so do it now */
10320 if( !pPage->leaf ){
10321 heap = pCheck->heap;
10322 heap[0] = 0;
drhcbc6b712015-07-02 16:17:30 +000010323 for(i=nCell-1; i>=0; i--){
drh1910def2015-07-02 16:29:56 +000010324 u32 size;
10325 pc = get2byteAligned(&data[cellStart+i*2]);
10326 size = pPage->xCellSize(pPage, &data[pc]);
drh67731a92015-04-16 11:56:03 +000010327 btreeHeapInsert(heap, (pc<<16)|(pc+size-1));
danielk19777701e812005-01-10 12:59:51 +000010328 }
drh2e38c322004-09-03 18:38:44 +000010329 }
drhcbc6b712015-07-02 16:17:30 +000010330 /* Add the freeblocks to the min-heap
10331 **
10332 ** EVIDENCE-OF: R-20690-50594 The second field of the b-tree page header
drhfdab0262014-11-20 15:30:50 +000010333 ** is the offset of the first freeblock, or zero if there are no
drhcbc6b712015-07-02 16:17:30 +000010334 ** freeblocks on the page.
10335 */
drh8c2bbb62009-07-10 02:52:20 +000010336 i = get2byte(&data[hdr+1]);
10337 while( i>0 ){
10338 int size, j;
drh5860a612019-02-12 16:58:26 +000010339 assert( (u32)i<=usableSize-4 ); /* Enforced by btreeComputeFreeSpace() */
drh8c2bbb62009-07-10 02:52:20 +000010340 size = get2byte(&data[i+2]);
drh5860a612019-02-12 16:58:26 +000010341 assert( (u32)(i+size)<=usableSize ); /* due to btreeComputeFreeSpace() */
drhe56d4302015-07-08 01:22:52 +000010342 btreeHeapInsert(heap, (((u32)i)<<16)|(i+size-1));
drhfdab0262014-11-20 15:30:50 +000010343 /* EVIDENCE-OF: R-58208-19414 The first 2 bytes of a freeblock are a
10344 ** big-endian integer which is the offset in the b-tree page of the next
10345 ** freeblock in the chain, or zero if the freeblock is the last on the
10346 ** chain. */
drh8c2bbb62009-07-10 02:52:20 +000010347 j = get2byte(&data[i]);
drhfdab0262014-11-20 15:30:50 +000010348 /* EVIDENCE-OF: R-06866-39125 Freeblocks are always connected in order of
10349 ** increasing offset. */
drh5860a612019-02-12 16:58:26 +000010350 assert( j==0 || j>i+size ); /* Enforced by btreeComputeFreeSpace() */
10351 assert( (u32)j<=usableSize-4 ); /* Enforced by btreeComputeFreeSpace() */
drh8c2bbb62009-07-10 02:52:20 +000010352 i = j;
drh2e38c322004-09-03 18:38:44 +000010353 }
drhcbc6b712015-07-02 16:17:30 +000010354 /* Analyze the min-heap looking for overlap between cells and/or
10355 ** freeblocks, and counting the number of untracked bytes in nFrag.
drhd2dc87f2015-07-02 19:47:08 +000010356 **
10357 ** Each min-heap entry is of the form: (start_address<<16)|end_address.
10358 ** There is an implied first entry the covers the page header, the cell
10359 ** pointer index, and the gap between the cell pointer index and the start
10360 ** of cell content.
10361 **
10362 ** The loop below pulls entries from the min-heap in order and compares
10363 ** the start_address against the previous end_address. If there is an
10364 ** overlap, that means bytes are used multiple times. If there is a gap,
10365 ** that gap is added to the fragmentation count.
drhcbc6b712015-07-02 16:17:30 +000010366 */
10367 nFrag = 0;
drhd2dc87f2015-07-02 19:47:08 +000010368 prev = contentOffset - 1; /* Implied first min-heap entry */
drh67731a92015-04-16 11:56:03 +000010369 while( btreeHeapPull(heap,&x) ){
drhd2dc87f2015-07-02 19:47:08 +000010370 if( (prev&0xffff)>=(x>>16) ){
drh867db832014-09-26 02:41:05 +000010371 checkAppendMsg(pCheck,
drhabc38152020-07-22 13:38:04 +000010372 "Multiple uses for byte %u of page %u", x>>16, iPage);
drh2e38c322004-09-03 18:38:44 +000010373 break;
drh67731a92015-04-16 11:56:03 +000010374 }else{
drhcbc6b712015-07-02 16:17:30 +000010375 nFrag += (x>>16) - (prev&0xffff) - 1;
drh67731a92015-04-16 11:56:03 +000010376 prev = x;
drh2e38c322004-09-03 18:38:44 +000010377 }
10378 }
drhcbc6b712015-07-02 16:17:30 +000010379 nFrag += usableSize - (prev&0xffff) - 1;
drhfdab0262014-11-20 15:30:50 +000010380 /* EVIDENCE-OF: R-43263-13491 The total number of bytes in all fragments
10381 ** is stored in the fifth field of the b-tree page header.
10382 ** EVIDENCE-OF: R-07161-27322 The one-byte integer at offset 7 gives the
10383 ** number of fragmented free bytes within the cell content area.
10384 */
drhcbc6b712015-07-02 16:17:30 +000010385 if( heap[0]==0 && nFrag!=data[hdr+7] ){
drh867db832014-09-26 02:41:05 +000010386 checkAppendMsg(pCheck,
drhabc38152020-07-22 13:38:04 +000010387 "Fragmentation of %d bytes reported as %d on page %u",
drhcbc6b712015-07-02 16:17:30 +000010388 nFrag, data[hdr+7], iPage);
drh5eddca62001-06-30 21:53:53 +000010389 }
10390 }
drh867db832014-09-26 02:41:05 +000010391
10392end_of_check:
drh72e191e2015-07-04 11:14:20 +000010393 if( !doCoverageCheck ) pPage->isInit = savedIsInit;
drh4b70f112004-05-02 21:12:19 +000010394 releasePage(pPage);
drh867db832014-09-26 02:41:05 +000010395 pCheck->zPfx = saved_zPfx;
10396 pCheck->v1 = saved_v1;
10397 pCheck->v2 = saved_v2;
drhda200cc2004-05-09 11:51:38 +000010398 return depth+1;
drh5eddca62001-06-30 21:53:53 +000010399}
drhb7f91642004-10-31 02:22:47 +000010400#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +000010401
drhb7f91642004-10-31 02:22:47 +000010402#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +000010403/*
10404** This routine does a complete check of the given BTree file. aRoot[] is
10405** an array of pages numbers were each page number is the root page of
10406** a table. nRoot is the number of entries in aRoot.
10407**
danielk19773509a652009-07-06 18:56:13 +000010408** A read-only or read-write transaction must be opened before calling
10409** this function.
10410**
drhc890fec2008-08-01 20:10:08 +000010411** Write the number of error seen in *pnErr. Except for some memory
drhe43ba702008-12-05 22:40:08 +000010412** allocation errors, an error message held in memory obtained from
drhc890fec2008-08-01 20:10:08 +000010413** malloc is returned if *pnErr is non-zero. If *pnErr==0 then NULL is
drhe43ba702008-12-05 22:40:08 +000010414** returned. If a memory allocation error occurs, NULL is returned.
drh17d2d592020-07-23 00:45:06 +000010415**
10416** If the first entry in aRoot[] is 0, that indicates that the list of
10417** root pages is incomplete. This is a "partial integrity-check". This
10418** happens when performing an integrity check on a single table. The
10419** zero is skipped, of course. But in addition, the freelist checks
10420** and the checks to make sure every page is referenced are also skipped,
10421** since obviously it is not possible to know which pages are covered by
10422** the unverified btrees. Except, if aRoot[1] is 1, then the freelist
10423** checks are still performed.
drh5eddca62001-06-30 21:53:53 +000010424*/
drh1dcdbc02007-01-27 02:24:54 +000010425char *sqlite3BtreeIntegrityCheck(
drh21f6daa2019-10-11 14:21:48 +000010426 sqlite3 *db, /* Database connection that is running the check */
drh1dcdbc02007-01-27 02:24:54 +000010427 Btree *p, /* The btree to be checked */
drhabc38152020-07-22 13:38:04 +000010428 Pgno *aRoot, /* An array of root pages numbers for individual trees */
drh1dcdbc02007-01-27 02:24:54 +000010429 int nRoot, /* Number of entries in aRoot[] */
10430 int mxErr, /* Stop reporting errors after this many */
10431 int *pnErr /* Write number of errors seen to this variable */
10432){
danielk197789d40042008-11-17 14:20:56 +000010433 Pgno i;
drhaaab5722002-02-19 13:39:21 +000010434 IntegrityCk sCheck;
danielk1977aef0bf62005-12-30 16:28:01 +000010435 BtShared *pBt = p->pBt;
drhf10ce632019-01-11 14:46:44 +000010436 u64 savedDbFlags = pBt->db->flags;
drhf089aa42008-07-08 19:34:06 +000010437 char zErr[100];
drh17d2d592020-07-23 00:45:06 +000010438 int bPartial = 0; /* True if not checking all btrees */
10439 int bCkFreelist = 1; /* True to scan the freelist */
drh8deae5a2020-07-29 12:23:20 +000010440 VVA_ONLY( int nRef );
drh17d2d592020-07-23 00:45:06 +000010441 assert( nRoot>0 );
10442
10443 /* aRoot[0]==0 means this is a partial check */
10444 if( aRoot[0]==0 ){
10445 assert( nRoot>1 );
10446 bPartial = 1;
10447 if( aRoot[1]!=1 ) bCkFreelist = 0;
10448 }
drh5eddca62001-06-30 21:53:53 +000010449
drhd677b3d2007-08-20 22:48:41 +000010450 sqlite3BtreeEnter(p);
danielk19773509a652009-07-06 18:56:13 +000010451 assert( p->inTrans>TRANS_NONE && pBt->inTransaction>TRANS_NONE );
drhcc5f8a42016-02-06 22:32:06 +000010452 VVA_ONLY( nRef = sqlite3PagerRefcount(pBt->pPager) );
10453 assert( nRef>=0 );
drh21f6daa2019-10-11 14:21:48 +000010454 sCheck.db = db;
drh5eddca62001-06-30 21:53:53 +000010455 sCheck.pBt = pBt;
10456 sCheck.pPager = pBt->pPager;
drhb1299152010-03-30 22:58:33 +000010457 sCheck.nPage = btreePagecount(sCheck.pBt);
drh1dcdbc02007-01-27 02:24:54 +000010458 sCheck.mxErr = mxErr;
10459 sCheck.nErr = 0;
drh8ddf6352020-06-29 18:30:49 +000010460 sCheck.bOomFault = 0;
drh867db832014-09-26 02:41:05 +000010461 sCheck.zPfx = 0;
10462 sCheck.v1 = 0;
10463 sCheck.v2 = 0;
drhe05b3f82015-07-01 17:53:49 +000010464 sCheck.aPgRef = 0;
10465 sCheck.heap = 0;
10466 sqlite3StrAccumInit(&sCheck.errMsg, 0, zErr, sizeof(zErr), SQLITE_MAX_LENGTH);
drh5f4a6862016-01-30 12:50:25 +000010467 sCheck.errMsg.printfFlags = SQLITE_PRINTF_INTERNAL;
drh0de8c112002-07-06 16:32:14 +000010468 if( sCheck.nPage==0 ){
drhe05b3f82015-07-01 17:53:49 +000010469 goto integrity_ck_cleanup;
drh0de8c112002-07-06 16:32:14 +000010470 }
dan1235bb12012-04-03 17:43:28 +000010471
10472 sCheck.aPgRef = sqlite3MallocZero((sCheck.nPage / 8)+ 1);
10473 if( !sCheck.aPgRef ){
drh8ddf6352020-06-29 18:30:49 +000010474 sCheck.bOomFault = 1;
drhe05b3f82015-07-01 17:53:49 +000010475 goto integrity_ck_cleanup;
danielk1977ac245ec2005-01-14 13:50:11 +000010476 }
drhe05b3f82015-07-01 17:53:49 +000010477 sCheck.heap = (u32*)sqlite3PageMalloc( pBt->pageSize );
10478 if( sCheck.heap==0 ){
drh8ddf6352020-06-29 18:30:49 +000010479 sCheck.bOomFault = 1;
drhe05b3f82015-07-01 17:53:49 +000010480 goto integrity_ck_cleanup;
10481 }
10482
drh42cac6d2004-11-20 20:31:11 +000010483 i = PENDING_BYTE_PAGE(pBt);
dan1235bb12012-04-03 17:43:28 +000010484 if( i<=sCheck.nPage ) setPageReferenced(&sCheck, i);
drh5eddca62001-06-30 21:53:53 +000010485
10486 /* Check the integrity of the freelist
10487 */
drh17d2d592020-07-23 00:45:06 +000010488 if( bCkFreelist ){
10489 sCheck.zPfx = "Main freelist: ";
10490 checkList(&sCheck, 1, get4byte(&pBt->pPage1->aData[32]),
10491 get4byte(&pBt->pPage1->aData[36]));
10492 sCheck.zPfx = 0;
10493 }
drh5eddca62001-06-30 21:53:53 +000010494
10495 /* Check all the tables.
10496 */
drh040d77a2018-07-20 15:44:09 +000010497#ifndef SQLITE_OMIT_AUTOVACUUM
drh17d2d592020-07-23 00:45:06 +000010498 if( !bPartial ){
10499 if( pBt->autoVacuum ){
drhed109c02020-07-23 09:14:25 +000010500 Pgno mx = 0;
10501 Pgno mxInHdr;
drh17d2d592020-07-23 00:45:06 +000010502 for(i=0; (int)i<nRoot; i++) if( mx<aRoot[i] ) mx = aRoot[i];
10503 mxInHdr = get4byte(&pBt->pPage1->aData[52]);
10504 if( mx!=mxInHdr ){
10505 checkAppendMsg(&sCheck,
10506 "max rootpage (%d) disagrees with header (%d)",
10507 mx, mxInHdr
10508 );
10509 }
10510 }else if( get4byte(&pBt->pPage1->aData[64])!=0 ){
drh040d77a2018-07-20 15:44:09 +000010511 checkAppendMsg(&sCheck,
drh17d2d592020-07-23 00:45:06 +000010512 "incremental_vacuum enabled with a max rootpage of zero"
drh040d77a2018-07-20 15:44:09 +000010513 );
10514 }
drh040d77a2018-07-20 15:44:09 +000010515 }
10516#endif
drhcbc6b712015-07-02 16:17:30 +000010517 testcase( pBt->db->flags & SQLITE_CellSizeCk );
drhd5b44d62018-12-06 17:06:02 +000010518 pBt->db->flags &= ~(u64)SQLITE_CellSizeCk;
danielk197789d40042008-11-17 14:20:56 +000010519 for(i=0; (int)i<nRoot && sCheck.mxErr; i++){
drhcbc6b712015-07-02 16:17:30 +000010520 i64 notUsed;
drh4ff6dfa2002-03-03 23:06:00 +000010521 if( aRoot[i]==0 ) continue;
danielk1977687566d2004-11-02 12:56:41 +000010522#ifndef SQLITE_OMIT_AUTOVACUUM
drh17d2d592020-07-23 00:45:06 +000010523 if( pBt->autoVacuum && aRoot[i]>1 && !bPartial ){
drh867db832014-09-26 02:41:05 +000010524 checkPtrmap(&sCheck, aRoot[i], PTRMAP_ROOTPAGE, 0);
danielk1977687566d2004-11-02 12:56:41 +000010525 }
10526#endif
drhcbc6b712015-07-02 16:17:30 +000010527 checkTreePage(&sCheck, aRoot[i], &notUsed, LARGEST_INT64);
drh5eddca62001-06-30 21:53:53 +000010528 }
drhcbc6b712015-07-02 16:17:30 +000010529 pBt->db->flags = savedDbFlags;
drh5eddca62001-06-30 21:53:53 +000010530
10531 /* Make sure every page in the file is referenced
10532 */
drh17d2d592020-07-23 00:45:06 +000010533 if( !bPartial ){
10534 for(i=1; i<=sCheck.nPage && sCheck.mxErr; i++){
danielk1977afcdd022004-10-31 16:25:42 +000010535#ifdef SQLITE_OMIT_AUTOVACUUM
drh17d2d592020-07-23 00:45:06 +000010536 if( getPageReferenced(&sCheck, i)==0 ){
10537 checkAppendMsg(&sCheck, "Page %d is never used", i);
10538 }
danielk1977afcdd022004-10-31 16:25:42 +000010539#else
drh17d2d592020-07-23 00:45:06 +000010540 /* If the database supports auto-vacuum, make sure no tables contain
10541 ** references to pointer-map pages.
10542 */
10543 if( getPageReferenced(&sCheck, i)==0 &&
10544 (PTRMAP_PAGENO(pBt, i)!=i || !pBt->autoVacuum) ){
10545 checkAppendMsg(&sCheck, "Page %d is never used", i);
10546 }
10547 if( getPageReferenced(&sCheck, i)!=0 &&
10548 (PTRMAP_PAGENO(pBt, i)==i && pBt->autoVacuum) ){
10549 checkAppendMsg(&sCheck, "Pointer map page %d is referenced", i);
10550 }
danielk1977afcdd022004-10-31 16:25:42 +000010551#endif
drh47eb5612020-08-10 21:01:32 +000010552 }
drh5eddca62001-06-30 21:53:53 +000010553 }
10554
drh5eddca62001-06-30 21:53:53 +000010555 /* Clean up and report errors.
10556 */
drhe05b3f82015-07-01 17:53:49 +000010557integrity_ck_cleanup:
10558 sqlite3PageFree(sCheck.heap);
dan1235bb12012-04-03 17:43:28 +000010559 sqlite3_free(sCheck.aPgRef);
drh8ddf6352020-06-29 18:30:49 +000010560 if( sCheck.bOomFault ){
drh0cdbe1a2018-05-09 13:46:26 +000010561 sqlite3_str_reset(&sCheck.errMsg);
drhe05b3f82015-07-01 17:53:49 +000010562 sCheck.nErr++;
drhc890fec2008-08-01 20:10:08 +000010563 }
drh1dcdbc02007-01-27 02:24:54 +000010564 *pnErr = sCheck.nErr;
drh0cdbe1a2018-05-09 13:46:26 +000010565 if( sCheck.nErr==0 ) sqlite3_str_reset(&sCheck.errMsg);
drhe05b3f82015-07-01 17:53:49 +000010566 /* Make sure this analysis did not leave any unref() pages. */
10567 assert( nRef==sqlite3PagerRefcount(pBt->pPager) );
10568 sqlite3BtreeLeave(p);
drhf089aa42008-07-08 19:34:06 +000010569 return sqlite3StrAccumFinish(&sCheck.errMsg);
drh5eddca62001-06-30 21:53:53 +000010570}
drhb7f91642004-10-31 02:22:47 +000010571#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
paulb95a8862003-04-01 21:16:41 +000010572
drh73509ee2003-04-06 20:44:45 +000010573/*
drhd4e0bb02012-05-27 01:19:04 +000010574** Return the full pathname of the underlying database file. Return
10575** an empty string if the database is in-memory or a TEMP database.
drhd0679ed2007-08-28 22:24:34 +000010576**
10577** The pager filename is invariant as long as the pager is
10578** open so it is safe to access without the BtShared mutex.
drh73509ee2003-04-06 20:44:45 +000010579*/
danielk1977aef0bf62005-12-30 16:28:01 +000010580const char *sqlite3BtreeGetFilename(Btree *p){
10581 assert( p->pBt->pPager!=0 );
drhd4e0bb02012-05-27 01:19:04 +000010582 return sqlite3PagerFilename(p->pBt->pPager, 1);
drh73509ee2003-04-06 20:44:45 +000010583}
10584
10585/*
danielk19775865e3d2004-06-14 06:03:57 +000010586** Return the pathname of the journal file for this database. The return
10587** value of this routine is the same regardless of whether the journal file
10588** has been created or not.
drhd0679ed2007-08-28 22:24:34 +000010589**
10590** The pager journal filename is invariant as long as the pager is
10591** open so it is safe to access without the BtShared mutex.
danielk19775865e3d2004-06-14 06:03:57 +000010592*/
danielk1977aef0bf62005-12-30 16:28:01 +000010593const char *sqlite3BtreeGetJournalname(Btree *p){
10594 assert( p->pBt->pPager!=0 );
danielk19773b8a05f2007-03-19 17:44:26 +000010595 return sqlite3PagerJournalname(p->pBt->pPager);
danielk19775865e3d2004-06-14 06:03:57 +000010596}
10597
danielk19771d850a72004-05-31 08:26:49 +000010598/*
drh99744fa2020-08-25 19:09:07 +000010599** Return one of SQLITE_TXN_NONE, SQLITE_TXN_READ, or SQLITE_TXN_WRITE
10600** to describe the current transaction state of Btree p.
danielk19771d850a72004-05-31 08:26:49 +000010601*/
drh99744fa2020-08-25 19:09:07 +000010602int sqlite3BtreeTxnState(Btree *p){
drhe5fe6902007-12-07 18:55:28 +000010603 assert( p==0 || sqlite3_mutex_held(p->db->mutex) );
drh99744fa2020-08-25 19:09:07 +000010604 return p ? p->inTrans : 0;
danielk19771d850a72004-05-31 08:26:49 +000010605}
10606
dana550f2d2010-08-02 10:47:05 +000010607#ifndef SQLITE_OMIT_WAL
10608/*
10609** Run a checkpoint on the Btree passed as the first argument.
10610**
10611** Return SQLITE_LOCKED if this or any other connection has an open
10612** transaction on the shared-cache the argument Btree is connected to.
dana58f26f2010-11-16 18:56:51 +000010613**
dancdc1f042010-11-18 12:11:05 +000010614** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
dana550f2d2010-08-02 10:47:05 +000010615*/
dancdc1f042010-11-18 12:11:05 +000010616int sqlite3BtreeCheckpoint(Btree *p, int eMode, int *pnLog, int *pnCkpt){
dana550f2d2010-08-02 10:47:05 +000010617 int rc = SQLITE_OK;
10618 if( p ){
10619 BtShared *pBt = p->pBt;
10620 sqlite3BtreeEnter(p);
10621 if( pBt->inTransaction!=TRANS_NONE ){
10622 rc = SQLITE_LOCKED;
10623 }else{
dan7fb89902016-08-12 16:21:15 +000010624 rc = sqlite3PagerCheckpoint(pBt->pPager, p->db, eMode, pnLog, pnCkpt);
dana550f2d2010-08-02 10:47:05 +000010625 }
10626 sqlite3BtreeLeave(p);
10627 }
10628 return rc;
10629}
10630#endif
10631
danielk19771d850a72004-05-31 08:26:49 +000010632/*
drh99744fa2020-08-25 19:09:07 +000010633** Return true if there is currently a backup running on Btree p.
danielk19772372c2b2006-06-27 16:34:56 +000010634*/
danielk197704103022009-02-03 16:51:24 +000010635int sqlite3BtreeIsInBackup(Btree *p){
10636 assert( p );
10637 assert( sqlite3_mutex_held(p->db->mutex) );
10638 return p->nBackup!=0;
10639}
10640
danielk19772372c2b2006-06-27 16:34:56 +000010641/*
danielk1977da184232006-01-05 11:34:32 +000010642** This function returns a pointer to a blob of memory associated with
drh85b623f2007-12-13 21:54:09 +000010643** a single shared-btree. The memory is used by client code for its own
danielk1977da184232006-01-05 11:34:32 +000010644** purposes (for example, to store a high-level schema associated with
10645** the shared-btree). The btree layer manages reference counting issues.
10646**
10647** The first time this is called on a shared-btree, nBytes bytes of memory
10648** are allocated, zeroed, and returned to the caller. For each subsequent
10649** call the nBytes parameter is ignored and a pointer to the same blob
10650** of memory returned.
10651**
danielk1977171bfed2008-06-23 09:50:50 +000010652** If the nBytes parameter is 0 and the blob of memory has not yet been
10653** allocated, a null pointer is returned. If the blob has already been
10654** allocated, it is returned as normal.
10655**
danielk1977da184232006-01-05 11:34:32 +000010656** Just before the shared-btree is closed, the function passed as the
10657** xFree argument when the memory allocation was made is invoked on the
drh4fa7d7c2011-04-03 02:41:00 +000010658** blob of allocated memory. The xFree function should not call sqlite3_free()
danielk1977da184232006-01-05 11:34:32 +000010659** on the memory, the btree layer does that.
10660*/
10661void *sqlite3BtreeSchema(Btree *p, int nBytes, void(*xFree)(void *)){
10662 BtShared *pBt = p->pBt;
drh27641702007-08-22 02:56:42 +000010663 sqlite3BtreeEnter(p);
danielk1977171bfed2008-06-23 09:50:50 +000010664 if( !pBt->pSchema && nBytes ){
drhb9755982010-07-24 16:34:37 +000010665 pBt->pSchema = sqlite3DbMallocZero(0, nBytes);
danielk1977da184232006-01-05 11:34:32 +000010666 pBt->xFreeSchema = xFree;
10667 }
drh27641702007-08-22 02:56:42 +000010668 sqlite3BtreeLeave(p);
danielk1977da184232006-01-05 11:34:32 +000010669 return pBt->pSchema;
10670}
10671
danielk1977c87d34d2006-01-06 13:00:28 +000010672/*
danielk1977404ca072009-03-16 13:19:36 +000010673** Return SQLITE_LOCKED_SHAREDCACHE if another user of the same shared
10674** btree as the argument handle holds an exclusive lock on the
drh1e32bed2020-06-19 13:33:53 +000010675** sqlite_schema table. Otherwise SQLITE_OK.
danielk1977c87d34d2006-01-06 13:00:28 +000010676*/
10677int sqlite3BtreeSchemaLocked(Btree *p){
drh27641702007-08-22 02:56:42 +000010678 int rc;
drhe5fe6902007-12-07 18:55:28 +000010679 assert( sqlite3_mutex_held(p->db->mutex) );
drh27641702007-08-22 02:56:42 +000010680 sqlite3BtreeEnter(p);
drh346a70c2020-06-15 20:27:35 +000010681 rc = querySharedCacheTableLock(p, SCHEMA_ROOT, READ_LOCK);
danielk1977404ca072009-03-16 13:19:36 +000010682 assert( rc==SQLITE_OK || rc==SQLITE_LOCKED_SHAREDCACHE );
drh27641702007-08-22 02:56:42 +000010683 sqlite3BtreeLeave(p);
10684 return rc;
danielk1977c87d34d2006-01-06 13:00:28 +000010685}
10686
drha154dcd2006-03-22 22:10:07 +000010687
10688#ifndef SQLITE_OMIT_SHARED_CACHE
10689/*
10690** Obtain a lock on the table whose root page is iTab. The
10691** lock is a write lock if isWritelock is true or a read lock
10692** if it is false.
10693*/
danielk1977c00da102006-01-07 13:21:04 +000010694int sqlite3BtreeLockTable(Btree *p, int iTab, u8 isWriteLock){
danielk19772e94d4d2006-01-09 05:36:27 +000010695 int rc = SQLITE_OK;
danielk1977602b4662009-07-02 07:47:33 +000010696 assert( p->inTrans!=TRANS_NONE );
drh6a9ad3d2008-04-02 16:29:30 +000010697 if( p->sharable ){
10698 u8 lockType = READ_LOCK + isWriteLock;
10699 assert( READ_LOCK+1==WRITE_LOCK );
10700 assert( isWriteLock==0 || isWriteLock==1 );
danielk1977602b4662009-07-02 07:47:33 +000010701
drh6a9ad3d2008-04-02 16:29:30 +000010702 sqlite3BtreeEnter(p);
drhc25eabe2009-02-24 18:57:31 +000010703 rc = querySharedCacheTableLock(p, iTab, lockType);
drh6a9ad3d2008-04-02 16:29:30 +000010704 if( rc==SQLITE_OK ){
drhc25eabe2009-02-24 18:57:31 +000010705 rc = setSharedCacheTableLock(p, iTab, lockType);
drh6a9ad3d2008-04-02 16:29:30 +000010706 }
10707 sqlite3BtreeLeave(p);
danielk1977c00da102006-01-07 13:21:04 +000010708 }
10709 return rc;
10710}
drha154dcd2006-03-22 22:10:07 +000010711#endif
danielk1977b82e7ed2006-01-11 14:09:31 +000010712
danielk1977b4e9af92007-05-01 17:49:49 +000010713#ifndef SQLITE_OMIT_INCRBLOB
10714/*
10715** Argument pCsr must be a cursor opened for writing on an
10716** INTKEY table currently pointing at a valid table entry.
10717** This function modifies the data stored as part of that entry.
danielk1977ecaecf92009-07-08 08:05:35 +000010718**
10719** Only the data content may only be modified, it is not possible to
10720** change the length of the data stored. If this function is called with
10721** parameters that attempt to write past the end of the existing data,
10722** no modifications are made and SQLITE_CORRUPT is returned.
danielk1977b4e9af92007-05-01 17:49:49 +000010723*/
danielk1977dcbb5d32007-05-04 18:36:44 +000010724int sqlite3BtreePutData(BtCursor *pCsr, u32 offset, u32 amt, void *z){
danielk1977c9000e62009-07-08 13:55:28 +000010725 int rc;
dan7a2347e2016-01-07 16:43:54 +000010726 assert( cursorOwnsBtShared(pCsr) );
drhe5fe6902007-12-07 18:55:28 +000010727 assert( sqlite3_mutex_held(pCsr->pBtree->db->mutex) );
drh036dbec2014-03-11 23:40:44 +000010728 assert( pCsr->curFlags & BTCF_Incrblob );
danielk19773588ceb2008-06-10 17:30:26 +000010729
danielk1977c9000e62009-07-08 13:55:28 +000010730 rc = restoreCursorPosition(pCsr);
10731 if( rc!=SQLITE_OK ){
10732 return rc;
10733 }
danielk19773588ceb2008-06-10 17:30:26 +000010734 assert( pCsr->eState!=CURSOR_REQUIRESEEK );
10735 if( pCsr->eState!=CURSOR_VALID ){
10736 return SQLITE_ABORT;
danielk1977dcbb5d32007-05-04 18:36:44 +000010737 }
10738
dan227a1c42013-04-03 11:17:39 +000010739 /* Save the positions of all other cursors open on this table. This is
10740 ** required in case any of them are holding references to an xFetch
10741 ** version of the b-tree page modified by the accessPayload call below.
drh370c9f42013-04-03 20:04:04 +000010742 **
drh3f387402014-09-24 01:23:00 +000010743 ** Note that pCsr must be open on a INTKEY table and saveCursorPosition()
drh370c9f42013-04-03 20:04:04 +000010744 ** and hence saveAllCursors() cannot fail on a BTREE_INTKEY table, hence
10745 ** saveAllCursors can only return SQLITE_OK.
dan227a1c42013-04-03 11:17:39 +000010746 */
drh370c9f42013-04-03 20:04:04 +000010747 VVA_ONLY(rc =) saveAllCursors(pCsr->pBt, pCsr->pgnoRoot, pCsr);
10748 assert( rc==SQLITE_OK );
dan227a1c42013-04-03 11:17:39 +000010749
danielk1977c9000e62009-07-08 13:55:28 +000010750 /* Check some assumptions:
danielk1977dcbb5d32007-05-04 18:36:44 +000010751 ** (a) the cursor is open for writing,
danielk1977c9000e62009-07-08 13:55:28 +000010752 ** (b) there is a read/write transaction open,
10753 ** (c) the connection holds a write-lock on the table (if required),
10754 ** (d) there are no conflicting read-locks, and
10755 ** (e) the cursor points at a valid row of an intKey table.
danielk1977d04417962007-05-02 13:16:30 +000010756 */
drh036dbec2014-03-11 23:40:44 +000010757 if( (pCsr->curFlags & BTCF_WriteFlag)==0 ){
danielk19774f029602009-07-08 18:45:37 +000010758 return SQLITE_READONLY;
10759 }
drhc9166342012-01-05 23:32:06 +000010760 assert( (pCsr->pBt->btsFlags & BTS_READ_ONLY)==0
10761 && pCsr->pBt->inTransaction==TRANS_WRITE );
danielk197796d48e92009-06-29 06:00:37 +000010762 assert( hasSharedCacheTableLock(pCsr->pBtree, pCsr->pgnoRoot, 0, 2) );
10763 assert( !hasReadConflicts(pCsr->pBtree, pCsr->pgnoRoot) );
drh352a35a2017-08-15 03:46:47 +000010764 assert( pCsr->pPage->intKey );
danielk1977b4e9af92007-05-01 17:49:49 +000010765
drhfb192682009-07-11 18:26:28 +000010766 return accessPayload(pCsr, offset, amt, (unsigned char *)z, 1);
danielk1977b4e9af92007-05-01 17:49:49 +000010767}
danielk19772dec9702007-05-02 16:48:37 +000010768
10769/*
dan5a500af2014-03-11 20:33:04 +000010770** Mark this cursor as an incremental blob cursor.
danielk19772dec9702007-05-02 16:48:37 +000010771*/
dan5a500af2014-03-11 20:33:04 +000010772void sqlite3BtreeIncrblobCursor(BtCursor *pCur){
drh036dbec2014-03-11 23:40:44 +000010773 pCur->curFlags |= BTCF_Incrblob;
drh69180952015-06-25 13:03:10 +000010774 pCur->pBtree->hasIncrblobCur = 1;
danielk19772dec9702007-05-02 16:48:37 +000010775}
danielk1977b4e9af92007-05-01 17:49:49 +000010776#endif
dane04dc882010-04-20 18:53:15 +000010777
10778/*
10779** Set both the "read version" (single byte at byte offset 18) and
10780** "write version" (single byte at byte offset 19) fields in the database
10781** header to iVersion.
10782*/
10783int sqlite3BtreeSetVersion(Btree *pBtree, int iVersion){
10784 BtShared *pBt = pBtree->pBt;
10785 int rc; /* Return code */
10786
dane04dc882010-04-20 18:53:15 +000010787 assert( iVersion==1 || iVersion==2 );
10788
danb9780022010-04-21 18:37:57 +000010789 /* If setting the version fields to 1, do not automatically open the
10790 ** WAL connection, even if the version fields are currently set to 2.
10791 */
drhc9166342012-01-05 23:32:06 +000010792 pBt->btsFlags &= ~BTS_NO_WAL;
10793 if( iVersion==1 ) pBt->btsFlags |= BTS_NO_WAL;
danb9780022010-04-21 18:37:57 +000010794
drhbb2d9b12018-06-06 16:28:40 +000010795 rc = sqlite3BtreeBeginTrans(pBtree, 0, 0);
dane04dc882010-04-20 18:53:15 +000010796 if( rc==SQLITE_OK ){
10797 u8 *aData = pBt->pPage1->aData;
danb9780022010-04-21 18:37:57 +000010798 if( aData[18]!=(u8)iVersion || aData[19]!=(u8)iVersion ){
drhbb2d9b12018-06-06 16:28:40 +000010799 rc = sqlite3BtreeBeginTrans(pBtree, 2, 0);
danb9780022010-04-21 18:37:57 +000010800 if( rc==SQLITE_OK ){
10801 rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
10802 if( rc==SQLITE_OK ){
10803 aData[18] = (u8)iVersion;
10804 aData[19] = (u8)iVersion;
10805 }
10806 }
10807 }
dane04dc882010-04-20 18:53:15 +000010808 }
10809
drhc9166342012-01-05 23:32:06 +000010810 pBt->btsFlags &= ~BTS_NO_WAL;
dane04dc882010-04-20 18:53:15 +000010811 return rc;
10812}
dan428c2182012-08-06 18:50:11 +000010813
drhe0997b32015-03-20 14:57:50 +000010814/*
10815** Return true if the cursor has a hint specified. This routine is
10816** only used from within assert() statements
10817*/
10818int sqlite3BtreeCursorHasHint(BtCursor *pCsr, unsigned int mask){
10819 return (pCsr->hints & mask)!=0;
10820}
drhe0997b32015-03-20 14:57:50 +000010821
drh781597f2014-05-21 08:21:07 +000010822/*
10823** Return true if the given Btree is read-only.
10824*/
10825int sqlite3BtreeIsReadonly(Btree *p){
10826 return (p->pBt->btsFlags & BTS_READ_ONLY)!=0;
10827}
drhdef68892014-11-04 12:11:23 +000010828
10829/*
10830** Return the size of the header added to each page by this module.
10831*/
drh37c057b2014-12-30 00:57:29 +000010832int sqlite3HeaderSizeBtree(void){ return ROUND8(sizeof(MemPage)); }
dan20d876f2016-01-07 16:06:22 +000010833
drh5a1fb182016-01-08 19:34:39 +000010834#if !defined(SQLITE_OMIT_SHARED_CACHE)
dan20d876f2016-01-07 16:06:22 +000010835/*
10836** Return true if the Btree passed as the only argument is sharable.
10837*/
10838int sqlite3BtreeSharable(Btree *p){
10839 return p->sharable;
10840}
dan272989b2016-07-06 10:12:02 +000010841
10842/*
10843** Return the number of connections to the BtShared object accessed by
10844** the Btree handle passed as the only argument. For private caches
10845** this is always 1. For shared caches it may be 1 or greater.
10846*/
10847int sqlite3BtreeConnectionCount(Btree *p){
10848 testcase( p->sharable );
10849 return p->pBt->nRef;
10850}
drh5a1fb182016-01-08 19:34:39 +000010851#endif