blob: f68766e8d74c39fab1e268ed708ce1dbc48723aa [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*************************************************************************
drhccae6022005-02-26 17:31:26 +000012** $Id: btree.c,v 1.249 2005/02/26 17:31:27 drh Exp $
drh8b2f49b2001-06-08 00:21:52 +000013**
14** This file implements a external (disk-based) database using BTrees.
15** For a detailed discussion of BTrees, refer to
16**
17** Donald E. Knuth, THE ART OF COMPUTER PROGRAMMING, Volume 3:
18** "Sorting And Searching", pages 473-480. Addison-Wesley
19** Publishing Company, Reading, Massachusetts.
20**
21** The basic idea is that each page of the file contains N database
22** entries and N+1 pointers to subpages.
23**
24** ----------------------------------------------------------------
25** | Ptr(0) | Key(0) | Ptr(1) | Key(1) | ... | Key(N) | Ptr(N+1) |
26** ----------------------------------------------------------------
27**
28** All of the keys on the page that Ptr(0) points to have values less
29** than Key(0). All of the keys on page Ptr(1) and its subpages have
30** values greater than Key(0) and less than Key(1). All of the keys
31** on Ptr(N+1) and its subpages have values greater than Key(N). And
32** so forth.
33**
drh5e00f6c2001-09-13 13:46:56 +000034** Finding a particular key requires reading O(log(M)) pages from the
35** disk where M is the number of entries in the tree.
drh8b2f49b2001-06-08 00:21:52 +000036**
37** In this implementation, a single file can hold one or more separate
38** BTrees. Each BTree is identified by the index of its root page. The
drh9e572e62004-04-23 23:43:10 +000039** key and data for any entry are combined to form the "payload". A
40** fixed amount of payload can be carried directly on the database
41** page. If the payload is larger than the preset amount then surplus
42** bytes are stored on overflow pages. The payload for an entry
43** and the preceding pointer are combined to form a "Cell". Each
44** page has a small header which contains the Ptr(N+1) pointer and other
45** information such as the size of key and data.
drh8b2f49b2001-06-08 00:21:52 +000046**
drh9e572e62004-04-23 23:43:10 +000047** FORMAT DETAILS
48**
49** The file is divided into pages. The first page is called page 1,
50** the second is page 2, and so forth. A page number of zero indicates
51** "no such page". The page size can be anything between 512 and 65536.
52** Each page can be either a btree page, a freelist page or an overflow
53** page.
54**
55** The first page is always a btree page. The first 100 bytes of the first
drh271efa52004-05-30 19:19:05 +000056** page contain a special header (the "file header") that describes the file.
57** The format of the file header is as follows:
drh9e572e62004-04-23 23:43:10 +000058**
59** OFFSET SIZE DESCRIPTION
drhde647132004-05-07 17:57:49 +000060** 0 16 Header string: "SQLite format 3\000"
drh9e572e62004-04-23 23:43:10 +000061** 16 2 Page size in bytes.
62** 18 1 File format write version
63** 19 1 File format read version
drh6f11bef2004-05-13 01:12:56 +000064** 20 1 Bytes of unused space at the end of each page
65** 21 1 Max embedded payload fraction
66** 22 1 Min embedded payload fraction
67** 23 1 Min leaf payload fraction
68** 24 4 File change counter
69** 28 4 Reserved for future use
drh9e572e62004-04-23 23:43:10 +000070** 32 4 First freelist page
71** 36 4 Number of freelist pages in the file
72** 40 60 15 4-byte meta values passed to higher layers
73**
74** All of the integer values are big-endian (most significant byte first).
drh6f11bef2004-05-13 01:12:56 +000075**
drhab01f612004-05-22 02:55:23 +000076** The file change counter is incremented when the database is changed more
drh6f11bef2004-05-13 01:12:56 +000077** than once within the same second. This counter, together with the
78** modification time of the file, allows other processes to know
79** when the file has changed and thus when they need to flush their
80** cache.
81**
82** The max embedded payload fraction is the amount of the total usable
83** space in a page that can be consumed by a single cell for standard
84** B-tree (non-LEAFDATA) tables. A value of 255 means 100%. The default
85** is to limit the maximum cell size so that at least 4 cells will fit
drhab01f612004-05-22 02:55:23 +000086** on one page. Thus the default max embedded payload fraction is 64.
drh6f11bef2004-05-13 01:12:56 +000087**
88** If the payload for a cell is larger than the max payload, then extra
89** payload is spilled to overflow pages. Once an overflow page is allocated,
90** as many bytes as possible are moved into the overflow pages without letting
91** the cell size drop below the min embedded payload fraction.
92**
93** The min leaf payload fraction is like the min embedded payload fraction
94** except that it applies to leaf nodes in a LEAFDATA tree. The maximum
95** payload fraction for a LEAFDATA tree is always 100% (or 255) and it
96** not specified in the header.
drh9e572e62004-04-23 23:43:10 +000097**
drh43605152004-05-29 21:46:49 +000098** Each btree pages is divided into three sections: The header, the
99** cell pointer array, and the cell area area. Page 1 also has a 100-byte
drh271efa52004-05-30 19:19:05 +0000100** file header that occurs before the page header.
101**
102** |----------------|
103** | file header | 100 bytes. Page 1 only.
104** |----------------|
105** | page header | 8 bytes for leaves. 12 bytes for interior nodes
106** |----------------|
107** | cell pointer | | 2 bytes per cell. Sorted order.
108** | array | | Grows downward
109** | | v
110** |----------------|
111** | unallocated |
112** | space |
113** |----------------| ^ Grows upwards
114** | cell content | | Arbitrary order interspersed with freeblocks.
115** | area | | and free space fragments.
116** |----------------|
drh43605152004-05-29 21:46:49 +0000117**
118** The page headers looks like this:
drh9e572e62004-04-23 23:43:10 +0000119**
120** OFFSET SIZE DESCRIPTION
drh6f11bef2004-05-13 01:12:56 +0000121** 0 1 Flags. 1: intkey, 2: zerodata, 4: leafdata, 8: leaf
drh9e572e62004-04-23 23:43:10 +0000122** 1 2 byte offset to the first freeblock
drh43605152004-05-29 21:46:49 +0000123** 3 2 number of cells on this page
drh271efa52004-05-30 19:19:05 +0000124** 5 2 first byte of the cell content area
drh43605152004-05-29 21:46:49 +0000125** 7 1 number of fragmented free bytes
drh271efa52004-05-30 19:19:05 +0000126** 8 4 Right child (the Ptr(N+1) value). Omitted on leaves.
drh9e572e62004-04-23 23:43:10 +0000127**
128** The flags define the format of this btree page. The leaf flag means that
129** this page has no children. The zerodata flag means that this page carries
drh44f87bd2004-09-27 13:19:51 +0000130** only keys and no data. The intkey flag means that the key is a integer
131** which is stored in the key size entry of the cell header rather than in
132** the payload area.
drh9e572e62004-04-23 23:43:10 +0000133**
drh43605152004-05-29 21:46:49 +0000134** The cell pointer array begins on the first byte after the page header.
135** The cell pointer array contains zero or more 2-byte numbers which are
136** offsets from the beginning of the page to the cell content in the cell
137** content area. The cell pointers occur in sorted order. The system strives
138** to keep free space after the last cell pointer so that new cells can
drh44f87bd2004-09-27 13:19:51 +0000139** be easily added without having to defragment the page.
drh43605152004-05-29 21:46:49 +0000140**
141** Cell content is stored at the very end of the page and grows toward the
142** beginning of the page.
143**
144** Unused space within the cell content area is collected into a linked list of
145** freeblocks. Each freeblock is at least 4 bytes in size. The byte offset
146** to the first freeblock is given in the header. Freeblocks occur in
147** increasing order. Because a freeblock must be at least 4 bytes in size,
148** any group of 3 or fewer unused bytes in the cell content area cannot
149** exist on the freeblock chain. A group of 3 or fewer free bytes is called
150** a fragment. The total number of bytes in all fragments is recorded.
151** in the page header at offset 7.
152**
153** SIZE DESCRIPTION
154** 2 Byte offset of the next freeblock
155** 2 Bytes in this freeblock
156**
157** Cells are of variable length. Cells are stored in the cell content area at
158** the end of the page. Pointers to the cells are in the cell pointer array
159** that immediately follows the page header. Cells is not necessarily
160** contiguous or in order, but cell pointers are contiguous and in order.
161**
162** Cell content makes use of variable length integers. A variable
163** length integer is 1 to 9 bytes where the lower 7 bits of each
drh9e572e62004-04-23 23:43:10 +0000164** byte are used. The integer consists of all bytes that have bit 8 set and
drh6f11bef2004-05-13 01:12:56 +0000165** the first byte with bit 8 clear. The most significant byte of the integer
drhab01f612004-05-22 02:55:23 +0000166** appears first. A variable-length integer may not be more than 9 bytes long.
167** As a special case, all 8 bytes of the 9th byte are used as data. This
168** allows a 64-bit integer to be encoded in 9 bytes.
drh9e572e62004-04-23 23:43:10 +0000169**
170** 0x00 becomes 0x00000000
drh6f11bef2004-05-13 01:12:56 +0000171** 0x7f becomes 0x0000007f
172** 0x81 0x00 becomes 0x00000080
173** 0x82 0x00 becomes 0x00000100
174** 0x80 0x7f becomes 0x0000007f
175** 0x8a 0x91 0xd1 0xac 0x78 becomes 0x12345678
drh9e572e62004-04-23 23:43:10 +0000176** 0x81 0x81 0x81 0x81 0x01 becomes 0x10204081
177**
178** Variable length integers are used for rowids and to hold the number of
179** bytes of key and data in a btree cell.
180**
drh43605152004-05-29 21:46:49 +0000181** The content of a cell looks like this:
drh9e572e62004-04-23 23:43:10 +0000182**
183** SIZE DESCRIPTION
drh3aac2dd2004-04-26 14:10:20 +0000184** 4 Page number of the left child. Omitted if leaf flag is set.
185** var Number of bytes of data. Omitted if the zerodata flag is set.
186** var Number of bytes of key. Or the key itself if intkey flag is set.
drh9e572e62004-04-23 23:43:10 +0000187** * Payload
188** 4 First page of the overflow chain. Omitted if no overflow
189**
190** Overflow pages form a linked list. Each page except the last is completely
191** filled with data (pagesize - 4 bytes). The last page can have as little
192** as 1 byte of data.
193**
194** SIZE DESCRIPTION
195** 4 Page number of next overflow page
196** * Data
197**
198** Freelist pages come in two subtypes: trunk pages and leaf pages. The
199** file header points to first in a linked list of trunk page. Each trunk
200** page points to multiple leaf pages. The content of a leaf page is
201** unspecified. A trunk page looks like this:
202**
203** SIZE DESCRIPTION
204** 4 Page number of next trunk page
205** 4 Number of leaf pointers on this page
206** * zero or more pages numbers of leaves
drha059ad02001-04-17 20:09:11 +0000207*/
208#include "sqliteInt.h"
209#include "pager.h"
210#include "btree.h"
drh1f595712004-06-15 01:40:29 +0000211#include "os.h"
drha059ad02001-04-17 20:09:11 +0000212#include <assert.h>
213
drh887dc4c2004-10-22 16:22:57 +0000214/*
215** This macro rounds values up so that if the value is an address it
216** is guaranteed to be an address that is aligned to an 8-byte boundary.
217*/
218#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
drh4b70f112004-05-02 21:12:19 +0000219
drh4b70f112004-05-02 21:12:19 +0000220/* The following value is the maximum cell size assuming a maximum page
221** size give above.
222*/
drh2e38c322004-09-03 18:38:44 +0000223#define MX_CELL_SIZE(pBt) (pBt->pageSize-8)
drh4b70f112004-05-02 21:12:19 +0000224
225/* The maximum number of cells on a single page of the database. This
226** assumes a minimum cell size of 3 bytes. Such small cells will be
227** exceedingly rare, but they are possible.
228*/
drh2e38c322004-09-03 18:38:44 +0000229#define MX_CELL(pBt) ((pBt->pageSize-8)/3)
drh4b70f112004-05-02 21:12:19 +0000230
paulb95a8862003-04-01 21:16:41 +0000231/* Forward declarations */
drh3aac2dd2004-04-26 14:10:20 +0000232typedef struct MemPage MemPage;
paulb95a8862003-04-01 21:16:41 +0000233
drh8c42ca92001-06-22 19:15:00 +0000234/*
drhbd03cae2001-06-02 02:40:57 +0000235** This is a magic string that appears at the beginning of every
drh8c42ca92001-06-22 19:15:00 +0000236** SQLite database in order to identify the file as a real database.
drhde647132004-05-07 17:57:49 +0000237** 123456789 123456 */
238static const char zMagicHeader[] = "SQLite format 3";
drh08ed44e2001-04-29 23:32:55 +0000239
240/*
drh4b70f112004-05-02 21:12:19 +0000241** Page type flags. An ORed combination of these flags appear as the
242** first byte of every BTree page.
drh8c42ca92001-06-22 19:15:00 +0000243*/
drhde647132004-05-07 17:57:49 +0000244#define PTF_INTKEY 0x01
drh9e572e62004-04-23 23:43:10 +0000245#define PTF_ZERODATA 0x02
drh8b18dd42004-05-12 19:18:15 +0000246#define PTF_LEAFDATA 0x04
247#define PTF_LEAF 0x08
drh8c42ca92001-06-22 19:15:00 +0000248
249/*
drh9e572e62004-04-23 23:43:10 +0000250** As each page of the file is loaded into memory, an instance of the following
251** structure is appended and initialized to zero. This structure stores
252** information about the page that is decoded from the raw file page.
drh14acc042001-06-10 19:56:58 +0000253**
drh72f82862001-05-24 21:06:34 +0000254** The pParent field points back to the parent page. This allows us to
255** walk up the BTree from any leaf to the root. Care must be taken to
256** unref() the parent page pointer when this page is no longer referenced.
drhbd03cae2001-06-02 02:40:57 +0000257** The pageDestructor() routine handles that chore.
drh7e3b0a02001-04-28 16:52:40 +0000258*/
259struct MemPage {
drha6abd042004-06-09 17:37:22 +0000260 u8 isInit; /* True if previously initialized. MUST BE FIRST! */
drh43605152004-05-29 21:46:49 +0000261 u8 idxShift; /* True if Cell indices have changed */
262 u8 nOverflow; /* Number of overflow cell bodies in aCell[] */
263 u8 intKey; /* True if intkey flag is set */
264 u8 leaf; /* True if leaf flag is set */
265 u8 zeroData; /* True if table stores keys only */
266 u8 leafData; /* True if tables stores data on leaves only */
267 u8 hasData; /* True if this page stores data */
268 u8 hdrOffset; /* 100 for page 1. 0 otherwise */
drh271efa52004-05-30 19:19:05 +0000269 u8 childPtrSize; /* 0 if leaf==1. 4 if leaf==0 */
drha2fce642004-06-05 00:01:44 +0000270 u16 maxLocal; /* Copy of Btree.maxLocal or Btree.maxLeaf */
271 u16 minLocal; /* Copy of Btree.minLocal or Btree.minLeaf */
drh43605152004-05-29 21:46:49 +0000272 u16 cellOffset; /* Index in aData of first cell pointer */
273 u16 idxParent; /* Index in parent of this node */
274 u16 nFree; /* Number of free bytes on the page */
275 u16 nCell; /* Number of cells on this page, local and ovfl */
276 struct _OvflCell { /* Cells that will not fit on aData[] */
277 u8 *pCell; /* Pointers to the body of the overflow cell */
278 u16 idx; /* Insert this cell before idx-th non-overflow cell */
drha2fce642004-06-05 00:01:44 +0000279 } aOvfl[5];
drh43605152004-05-29 21:46:49 +0000280 struct Btree *pBt; /* Pointer back to BTree structure */
281 u8 *aData; /* Pointer back to the start of the page */
282 Pgno pgno; /* Page number for this page */
283 MemPage *pParent; /* The parent of this page. NULL for root */
drh8c42ca92001-06-22 19:15:00 +0000284};
drh7e3b0a02001-04-28 16:52:40 +0000285
286/*
drh3b7511c2001-05-26 13:15:44 +0000287** The in-memory image of a disk page has the auxiliary information appended
288** to the end. EXTRA_SIZE is the number of bytes of space needed to hold
289** that extra information.
290*/
drh3aac2dd2004-04-26 14:10:20 +0000291#define EXTRA_SIZE sizeof(MemPage)
drh3b7511c2001-05-26 13:15:44 +0000292
293/*
drha059ad02001-04-17 20:09:11 +0000294** Everything we need to know about an open database
295*/
296struct Btree {
297 Pager *pPager; /* The page cache */
drh306dc212001-05-21 13:45:10 +0000298 BtCursor *pCursor; /* A list of all open cursors */
drh3aac2dd2004-04-26 14:10:20 +0000299 MemPage *pPage1; /* First page of the database */
drh663fc632002-02-02 18:49:19 +0000300 u8 inTrans; /* True if a transaction is in progress */
drhab01f612004-05-22 02:55:23 +0000301 u8 inStmt; /* True if we are in a statement subtransaction */
drh5df72a52002-06-06 23:16:05 +0000302 u8 readOnly; /* True if the underlying file is readonly */
drhab01f612004-05-22 02:55:23 +0000303 u8 maxEmbedFrac; /* Maximum payload as % of total page size */
304 u8 minEmbedFrac; /* Minimum payload as % of total page size */
305 u8 minLeafFrac; /* Minimum leaf payload as % of total page size */
drh90f5ecb2004-07-22 01:19:35 +0000306 u8 pageSizeFixed; /* True if the page size can no longer be changed */
drh057cd3a2005-02-15 16:23:02 +0000307#ifndef SQLITE_OMIT_AUTOVACUUM
308 u8 autoVacuum; /* True if database supports auto-vacuum */
309#endif
drha2fce642004-06-05 00:01:44 +0000310 u16 pageSize; /* Total number of bytes on a page */
drh887dc4c2004-10-22 16:22:57 +0000311 u16 psAligned; /* pageSize rounded up to a multiple of 8 */
drha2fce642004-06-05 00:01:44 +0000312 u16 usableSize; /* Number of usable bytes on each page */
drh6f11bef2004-05-13 01:12:56 +0000313 int maxLocal; /* Maximum local payload in non-LEAFDATA tables */
314 int minLocal; /* Minimum local payload in non-LEAFDATA tables */
315 int maxLeaf; /* Maximum local payload in a LEAFDATA table */
316 int minLeaf; /* Minimum local payload in a LEAFDATA table */
drha059ad02001-04-17 20:09:11 +0000317};
318typedef Btree Bt;
319
drh365d68f2001-05-11 11:02:46 +0000320/*
danielk1977ee5741e2004-05-31 10:01:34 +0000321** Btree.inTrans may take one of the following values.
322*/
323#define TRANS_NONE 0
324#define TRANS_READ 1
325#define TRANS_WRITE 2
326
327/*
drhfa1a98a2004-05-14 19:08:17 +0000328** An instance of the following structure is used to hold information
drh271efa52004-05-30 19:19:05 +0000329** about a cell. The parseCellPtr() function fills in this structure
drhab01f612004-05-22 02:55:23 +0000330** based on information extract from the raw disk page.
drhfa1a98a2004-05-14 19:08:17 +0000331*/
332typedef struct CellInfo CellInfo;
333struct CellInfo {
drh43605152004-05-29 21:46:49 +0000334 u8 *pCell; /* Pointer to the start of cell content */
drhfa1a98a2004-05-14 19:08:17 +0000335 i64 nKey; /* The key for INTKEY tables, or number of bytes in key */
336 u32 nData; /* Number of bytes of data */
drh271efa52004-05-30 19:19:05 +0000337 u16 nHeader; /* Size of the cell content header in bytes */
drhfa1a98a2004-05-14 19:08:17 +0000338 u16 nLocal; /* Amount of payload held locally */
drhab01f612004-05-22 02:55:23 +0000339 u16 iOverflow; /* Offset to overflow page number. Zero if no overflow */
drh271efa52004-05-30 19:19:05 +0000340 u16 nSize; /* Size of the cell content on the main b-tree page */
drhfa1a98a2004-05-14 19:08:17 +0000341};
342
343/*
drh365d68f2001-05-11 11:02:46 +0000344** A cursor is a pointer to a particular entry in the BTree.
345** The entry is identified by its MemPage and the index in
drha34b6762004-05-07 13:30:42 +0000346** MemPage.aCell[] of the entry.
drh365d68f2001-05-11 11:02:46 +0000347*/
drh72f82862001-05-24 21:06:34 +0000348struct BtCursor {
drh5e2f8b92001-05-28 00:41:15 +0000349 Btree *pBt; /* The Btree to which this cursor belongs */
drh14acc042001-06-10 19:56:58 +0000350 BtCursor *pNext, *pPrev; /* Forms a linked list of all cursors */
drh3aac2dd2004-04-26 14:10:20 +0000351 int (*xCompare)(void*,int,const void*,int,const void*); /* Key comp func */
352 void *pArg; /* First arg to xCompare() */
drh8b2f49b2001-06-08 00:21:52 +0000353 Pgno pgnoRoot; /* The root page of this tree */
drh5e2f8b92001-05-28 00:41:15 +0000354 MemPage *pPage; /* Page that contains the entry */
drh3aac2dd2004-04-26 14:10:20 +0000355 int idx; /* Index of the entry in pPage->aCell[] */
drhfa1a98a2004-05-14 19:08:17 +0000356 CellInfo info; /* A parse of the cell we are pointing at */
drhecdc7532001-09-23 02:35:53 +0000357 u8 wrFlag; /* True if writable */
drhc39e0002004-05-07 23:50:57 +0000358 u8 isValid; /* TRUE if points to a valid entry */
drh365d68f2001-05-11 11:02:46 +0000359};
drh7e3b0a02001-04-28 16:52:40 +0000360
drha059ad02001-04-17 20:09:11 +0000361/*
drh615ae552005-01-16 23:21:00 +0000362** The TRACE macro will print high-level status information about the
363** btree operation when the global variable sqlite3_btree_trace is
364** enabled.
365*/
366#if SQLITE_TEST
367# define TRACE(X) if( sqlite3_btree_trace )\
368 { sqlite3DebugPrintf X; fflush(stdout); }
369#else
370# define TRACE(X)
371#endif
372int sqlite3_btree_trace=0; /* True to enable tracing */
373
374/*
drh66cbd152004-09-01 16:12:25 +0000375** Forward declaration
376*/
377static int checkReadLocks(Btree*,Pgno,BtCursor*);
378
drh66cbd152004-09-01 16:12:25 +0000379/*
drhab01f612004-05-22 02:55:23 +0000380** Read or write a two- and four-byte big-endian integer values.
drh0d316a42002-08-11 20:10:47 +0000381*/
drh9e572e62004-04-23 23:43:10 +0000382static u32 get2byte(unsigned char *p){
383 return (p[0]<<8) | p[1];
drh0d316a42002-08-11 20:10:47 +0000384}
drh9e572e62004-04-23 23:43:10 +0000385static u32 get4byte(unsigned char *p){
386 return (p[0]<<24) | (p[1]<<16) | (p[2]<<8) | p[3];
387}
drh9e572e62004-04-23 23:43:10 +0000388static void put2byte(unsigned char *p, u32 v){
389 p[0] = v>>8;
390 p[1] = v;
391}
392static void put4byte(unsigned char *p, u32 v){
393 p[0] = v>>24;
394 p[1] = v>>16;
395 p[2] = v>>8;
396 p[3] = v;
397}
drh6f11bef2004-05-13 01:12:56 +0000398
drh9e572e62004-04-23 23:43:10 +0000399/*
drhab01f612004-05-22 02:55:23 +0000400** Routines to read and write variable-length integers. These used to
401** be defined locally, but now we use the varint routines in the util.c
402** file.
drh9e572e62004-04-23 23:43:10 +0000403*/
drh6d2fb152004-05-14 16:50:06 +0000404#define getVarint sqlite3GetVarint
405#define getVarint32 sqlite3GetVarint32
406#define putVarint sqlite3PutVarint
drh0d316a42002-08-11 20:10:47 +0000407
danielk1977599fcba2004-11-08 07:13:13 +0000408/* The database page the PENDING_BYTE occupies. This page is never used.
409** TODO: This macro is very similary to PAGER_MJ_PGNO() in pager.c. They
410** should possibly be consolidated (presumably in pager.h).
411*/
412#define PENDING_BYTE_PAGE(pBt) ((PENDING_BYTE/(pBt)->pageSize)+1)
danielk1977afcdd022004-10-31 16:25:42 +0000413
danielk1977599fcba2004-11-08 07:13:13 +0000414#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977afcdd022004-10-31 16:25:42 +0000415/*
drh42cac6d2004-11-20 20:31:11 +0000416** These macros define the location of the pointer-map entry for a
417** database page. The first argument to each is the number of usable
418** bytes on each page of the database (often 1024). The second is the
419** page number to look up in the pointer map.
danielk1977afcdd022004-10-31 16:25:42 +0000420**
421** PTRMAP_PAGENO returns the database page number of the pointer-map
422** page that stores the required pointer. PTRMAP_PTROFFSET returns
423** the offset of the requested map entry.
424**
425** If the pgno argument passed to PTRMAP_PAGENO is a pointer-map page,
426** then pgno is returned. So (pgno==PTRMAP_PAGENO(pgsz, pgno)) can be
danielk1977599fcba2004-11-08 07:13:13 +0000427** used to test if pgno is a pointer-map page. PTRMAP_ISPAGE implements
428** this test.
danielk1977afcdd022004-10-31 16:25:42 +0000429*/
430#define PTRMAP_PAGENO(pgsz, pgno) (((pgno-2)/(pgsz/5+1))*(pgsz/5+1)+2)
431#define PTRMAP_PTROFFSET(pgsz, pgno) (((pgno-2)%(pgsz/5+1)-1)*5)
danielk1977a19df672004-11-03 11:37:07 +0000432#define PTRMAP_ISPAGE(pgsz, pgno) (PTRMAP_PAGENO(pgsz,pgno)==pgno)
433
danielk1977afcdd022004-10-31 16:25:42 +0000434/*
drh615ae552005-01-16 23:21:00 +0000435** The pointer map is a lookup table that identifies the parent page for
436** each child page in the database file. The parent page is the page that
437** contains a pointer to the child. Every page in the database contains
438** 0 or 1 parent pages. (In this context 'database page' refers
439** to any page that is not part of the pointer map itself.) Each pointer map
440** entry consists of a single byte 'type' and a 4 byte parent page number.
441** The PTRMAP_XXX identifiers below are the valid types.
442**
443** The purpose of the pointer map is to facility moving pages from one
444** position in the file to another as part of autovacuum. When a page
445** is moved, the pointer in its parent must be updated to point to the
446** new location. The pointer map is used to locate the parent page quickly.
danielk1977afcdd022004-10-31 16:25:42 +0000447**
danielk1977687566d2004-11-02 12:56:41 +0000448** PTRMAP_ROOTPAGE: The database page is a root-page. The page-number is not
449** used in this case.
danielk1977afcdd022004-10-31 16:25:42 +0000450**
danielk1977687566d2004-11-02 12:56:41 +0000451** PTRMAP_FREEPAGE: The database page is an unused (free) page. The page-number
452** is not used in this case.
453**
454** PTRMAP_OVERFLOW1: The database page is the first page in a list of
455** overflow pages. The page number identifies the page that
456** contains the cell with a pointer to this overflow page.
457**
458** PTRMAP_OVERFLOW2: The database page is the second or later page in a list of
459** overflow pages. The page-number identifies the previous
460** page in the overflow page list.
461**
462** PTRMAP_BTREE: The database page is a non-root btree page. The page number
463** identifies the parent page in the btree.
danielk1977afcdd022004-10-31 16:25:42 +0000464*/
danielk1977687566d2004-11-02 12:56:41 +0000465#define PTRMAP_ROOTPAGE 1
466#define PTRMAP_FREEPAGE 2
467#define PTRMAP_OVERFLOW1 3
468#define PTRMAP_OVERFLOW2 4
469#define PTRMAP_BTREE 5
danielk1977afcdd022004-10-31 16:25:42 +0000470
471/*
472** Write an entry into the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000473**
474** This routine updates the pointer map entry for page number 'key'
475** so that it maps to type 'eType' and parent page number 'pgno'.
476** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +0000477*/
drh615ae552005-01-16 23:21:00 +0000478static int ptrmapPut(Btree *pBt, Pgno key, u8 eType, Pgno parent){
danielk1977afcdd022004-10-31 16:25:42 +0000479 u8 *pPtrmap; /* The pointer map page */
480 Pgno iPtrmap; /* The pointer map page number */
481 int offset; /* Offset in pointer map page */
482 int rc;
483
danielk1977ac11ee62005-01-15 12:45:51 +0000484 assert( pBt->autoVacuum );
danielk1977fdb7cdb2005-01-17 02:12:18 +0000485 if( key==0 ){
486 return SQLITE_CORRUPT;
487 }
drh42cac6d2004-11-20 20:31:11 +0000488 iPtrmap = PTRMAP_PAGENO(pBt->usableSize, key);
danielk1977afcdd022004-10-31 16:25:42 +0000489 rc = sqlite3pager_get(pBt->pPager, iPtrmap, (void **)&pPtrmap);
danielk1977687566d2004-11-02 12:56:41 +0000490 if( rc!=SQLITE_OK ){
danielk1977afcdd022004-10-31 16:25:42 +0000491 return rc;
492 }
drh42cac6d2004-11-20 20:31:11 +0000493 offset = PTRMAP_PTROFFSET(pBt->usableSize, key);
danielk1977afcdd022004-10-31 16:25:42 +0000494
drh615ae552005-01-16 23:21:00 +0000495 if( eType!=pPtrmap[offset] || get4byte(&pPtrmap[offset+1])!=parent ){
496 TRACE(("PTRMAP_UPDATE: %d->(%d,%d)\n", key, eType, parent));
danielk1977afcdd022004-10-31 16:25:42 +0000497 rc = sqlite3pager_write(pPtrmap);
danielk19775558a8a2005-01-17 07:53:44 +0000498 if( rc==SQLITE_OK ){
499 pPtrmap[offset] = eType;
500 put4byte(&pPtrmap[offset+1], parent);
danielk1977afcdd022004-10-31 16:25:42 +0000501 }
danielk1977afcdd022004-10-31 16:25:42 +0000502 }
503
504 sqlite3pager_unref(pPtrmap);
danielk19775558a8a2005-01-17 07:53:44 +0000505 return rc;
danielk1977afcdd022004-10-31 16:25:42 +0000506}
507
508/*
509** Read an entry from the pointer map.
danielk1977687566d2004-11-02 12:56:41 +0000510**
511** This routine retrieves the pointer map entry for page 'key', writing
512** the type and parent page number to *pEType and *pPgno respectively.
513** An error code is returned if something goes wrong, otherwise SQLITE_OK.
danielk1977afcdd022004-10-31 16:25:42 +0000514*/
515static int ptrmapGet(Btree *pBt, Pgno key, u8 *pEType, Pgno *pPgno){
516 int iPtrmap; /* Pointer map page index */
517 u8 *pPtrmap; /* Pointer map page data */
518 int offset; /* Offset of entry in pointer map */
519 int rc;
520
drh42cac6d2004-11-20 20:31:11 +0000521 iPtrmap = PTRMAP_PAGENO(pBt->usableSize, key);
danielk1977afcdd022004-10-31 16:25:42 +0000522 rc = sqlite3pager_get(pBt->pPager, iPtrmap, (void **)&pPtrmap);
523 if( rc!=0 ){
524 return rc;
525 }
526
drh42cac6d2004-11-20 20:31:11 +0000527 offset = PTRMAP_PTROFFSET(pBt->usableSize, key);
danielk1977687566d2004-11-02 12:56:41 +0000528 if( pEType ) *pEType = pPtrmap[offset];
529 if( pPgno ) *pPgno = get4byte(&pPtrmap[offset+1]);
danielk1977afcdd022004-10-31 16:25:42 +0000530
531 sqlite3pager_unref(pPtrmap);
danielk1977fdb7cdb2005-01-17 02:12:18 +0000532 if( *pEType<1 || *pEType>5 ) return SQLITE_CORRUPT;
danielk1977afcdd022004-10-31 16:25:42 +0000533 return SQLITE_OK;
534}
535
536#endif /* SQLITE_OMIT_AUTOVACUUM */
537
drh0d316a42002-08-11 20:10:47 +0000538/*
drh271efa52004-05-30 19:19:05 +0000539** Given a btree page and a cell index (0 means the first cell on
540** the page, 1 means the second cell, and so forth) return a pointer
541** to the cell content.
542**
543** This routine works only for pages that do not contain overflow cells.
drh3aac2dd2004-04-26 14:10:20 +0000544*/
drh43605152004-05-29 21:46:49 +0000545static u8 *findCell(MemPage *pPage, int iCell){
546 u8 *data = pPage->aData;
547 assert( iCell>=0 );
548 assert( iCell<get2byte(&data[pPage->hdrOffset+3]) );
549 return data + get2byte(&data[pPage->cellOffset+2*iCell]);
550}
551
552/*
553** This a more complex version of findCell() that works for
554** pages that do contain overflow cells. See insert
555*/
556static u8 *findOverflowCell(MemPage *pPage, int iCell){
557 int i;
558 for(i=pPage->nOverflow-1; i>=0; i--){
drh6d08b4d2004-07-20 12:45:22 +0000559 int k;
560 struct _OvflCell *pOvfl;
561 pOvfl = &pPage->aOvfl[i];
562 k = pOvfl->idx;
563 if( k<=iCell ){
564 if( k==iCell ){
565 return pOvfl->pCell;
drh43605152004-05-29 21:46:49 +0000566 }
567 iCell--;
568 }
569 }
570 return findCell(pPage, iCell);
571}
572
573/*
574** Parse a cell content block and fill in the CellInfo structure. There
575** are two versions of this function. parseCell() takes a cell index
576** as the second argument and parseCellPtr() takes a pointer to the
577** body of the cell as its second argument.
578*/
579static void parseCellPtr(
drh3aac2dd2004-04-26 14:10:20 +0000580 MemPage *pPage, /* Page containing the cell */
drh43605152004-05-29 21:46:49 +0000581 u8 *pCell, /* Pointer to the cell text. */
drh6f11bef2004-05-13 01:12:56 +0000582 CellInfo *pInfo /* Fill in this structure */
drh3aac2dd2004-04-26 14:10:20 +0000583){
drh271efa52004-05-30 19:19:05 +0000584 int n; /* Number bytes in cell content header */
585 u32 nPayload; /* Number of bytes of cell payload */
drh43605152004-05-29 21:46:49 +0000586
587 pInfo->pCell = pCell;
drhab01f612004-05-22 02:55:23 +0000588 assert( pPage->leaf==0 || pPage->leaf==1 );
drh271efa52004-05-30 19:19:05 +0000589 n = pPage->childPtrSize;
590 assert( n==4-4*pPage->leaf );
drh8b18dd42004-05-12 19:18:15 +0000591 if( pPage->hasData ){
drh271efa52004-05-30 19:19:05 +0000592 n += getVarint32(&pCell[n], &nPayload);
drh8b18dd42004-05-12 19:18:15 +0000593 }else{
drh271efa52004-05-30 19:19:05 +0000594 nPayload = 0;
drh3aac2dd2004-04-26 14:10:20 +0000595 }
danielk1977e0d4b062004-06-28 01:11:46 +0000596 n += getVarint(&pCell[n], (u64 *)&pInfo->nKey);
drh6f11bef2004-05-13 01:12:56 +0000597 pInfo->nHeader = n;
drh271efa52004-05-30 19:19:05 +0000598 pInfo->nData = nPayload;
drh6f11bef2004-05-13 01:12:56 +0000599 if( !pPage->intKey ){
600 nPayload += pInfo->nKey;
601 }
drh271efa52004-05-30 19:19:05 +0000602 if( nPayload<=pPage->maxLocal ){
603 /* This is the (easy) common case where the entire payload fits
604 ** on the local page. No overflow is required.
605 */
606 int nSize; /* Total size of cell content in bytes */
drh6f11bef2004-05-13 01:12:56 +0000607 pInfo->nLocal = nPayload;
608 pInfo->iOverflow = 0;
drh271efa52004-05-30 19:19:05 +0000609 nSize = nPayload + n;
610 if( nSize<4 ){
611 nSize = 4; /* Minimum cell size is 4 */
drh43605152004-05-29 21:46:49 +0000612 }
drh271efa52004-05-30 19:19:05 +0000613 pInfo->nSize = nSize;
drh6f11bef2004-05-13 01:12:56 +0000614 }else{
drh271efa52004-05-30 19:19:05 +0000615 /* If the payload will not fit completely on the local page, we have
616 ** to decide how much to store locally and how much to spill onto
617 ** overflow pages. The strategy is to minimize the amount of unused
618 ** space on overflow pages while keeping the amount of local storage
619 ** in between minLocal and maxLocal.
620 **
621 ** Warning: changing the way overflow payload is distributed in any
622 ** way will result in an incompatible file format.
623 */
624 int minLocal; /* Minimum amount of payload held locally */
625 int maxLocal; /* Maximum amount of payload held locally */
626 int surplus; /* Overflow payload available for local storage */
627
628 minLocal = pPage->minLocal;
629 maxLocal = pPage->maxLocal;
630 surplus = minLocal + (nPayload - minLocal)%(pPage->pBt->usableSize - 4);
drh6f11bef2004-05-13 01:12:56 +0000631 if( surplus <= maxLocal ){
632 pInfo->nLocal = surplus;
633 }else{
634 pInfo->nLocal = minLocal;
635 }
636 pInfo->iOverflow = pInfo->nLocal + n;
637 pInfo->nSize = pInfo->iOverflow + 4;
638 }
drh3aac2dd2004-04-26 14:10:20 +0000639}
drh43605152004-05-29 21:46:49 +0000640static void parseCell(
641 MemPage *pPage, /* Page containing the cell */
642 int iCell, /* The cell index. First cell is 0 */
643 CellInfo *pInfo /* Fill in this structure */
644){
645 parseCellPtr(pPage, findCell(pPage, iCell), pInfo);
646}
drh3aac2dd2004-04-26 14:10:20 +0000647
648/*
drh43605152004-05-29 21:46:49 +0000649** Compute the total number of bytes that a Cell needs in the cell
650** data area of the btree-page. The return number includes the cell
651** data header and the local payload, but not any overflow page or
652** the space used by the cell pointer.
drh3b7511c2001-05-26 13:15:44 +0000653*/
danielk1977bc6ada42004-06-30 08:20:16 +0000654#ifndef NDEBUG
drh43605152004-05-29 21:46:49 +0000655static int cellSize(MemPage *pPage, int iCell){
drh6f11bef2004-05-13 01:12:56 +0000656 CellInfo info;
drh43605152004-05-29 21:46:49 +0000657 parseCell(pPage, iCell, &info);
658 return info.nSize;
659}
danielk1977bc6ada42004-06-30 08:20:16 +0000660#endif
drh43605152004-05-29 21:46:49 +0000661static int cellSizePtr(MemPage *pPage, u8 *pCell){
662 CellInfo info;
663 parseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +0000664 return info.nSize;
drh3b7511c2001-05-26 13:15:44 +0000665}
666
danielk197779a40da2005-01-16 08:00:01 +0000667#ifndef SQLITE_OMIT_AUTOVACUUM
drh3b7511c2001-05-26 13:15:44 +0000668/*
danielk197726836652005-01-17 01:33:13 +0000669** If the cell pCell, part of page pPage contains a pointer
danielk197779a40da2005-01-16 08:00:01 +0000670** to an overflow page, insert an entry into the pointer-map
671** for the overflow page.
danielk1977ac11ee62005-01-15 12:45:51 +0000672*/
danielk197726836652005-01-17 01:33:13 +0000673static int ptrmapPutOvflPtr(MemPage *pPage, u8 *pCell){
danielk197779a40da2005-01-16 08:00:01 +0000674 if( pCell ){
675 CellInfo info;
676 parseCellPtr(pPage, pCell, &info);
677 if( (info.nData+(pPage->intKey?0:info.nKey))>info.nLocal ){
678 Pgno ovfl = get4byte(&pCell[info.iOverflow]);
679 return ptrmapPut(pPage->pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno);
680 }
danielk1977ac11ee62005-01-15 12:45:51 +0000681 }
danielk197779a40da2005-01-16 08:00:01 +0000682 return SQLITE_OK;
danielk1977ac11ee62005-01-15 12:45:51 +0000683}
danielk197726836652005-01-17 01:33:13 +0000684/*
685** If the cell with index iCell on page pPage contains a pointer
686** to an overflow page, insert an entry into the pointer-map
687** for the overflow page.
688*/
689static int ptrmapPutOvfl(MemPage *pPage, int iCell){
690 u8 *pCell;
691 pCell = findOverflowCell(pPage, iCell);
692 return ptrmapPutOvflPtr(pPage, pCell);
693}
danielk197779a40da2005-01-16 08:00:01 +0000694#endif
695
danielk1977ac11ee62005-01-15 12:45:51 +0000696
697/*
drhda200cc2004-05-09 11:51:38 +0000698** Do sanity checking on a page. Throw an exception if anything is
699** not right.
700**
701** This routine is used for internal error checking only. It is omitted
702** from most builds.
703*/
704#if defined(BTREE_DEBUG) && !defined(NDEBUG) && 0
705static void _pageIntegrity(MemPage *pPage){
drhb6f41482004-05-14 01:58:11 +0000706 int usableSize;
drhda200cc2004-05-09 11:51:38 +0000707 u8 *data;
drh43605152004-05-29 21:46:49 +0000708 int i, j, idx, c, pc, hdr, nFree;
709 int cellOffset;
710 int nCell, cellLimit;
drh2e38c322004-09-03 18:38:44 +0000711 u8 *used;
drhda200cc2004-05-09 11:51:38 +0000712
drh2e38c322004-09-03 18:38:44 +0000713 used = sqliteMallocRaw( pPage->pBt->pageSize );
714 if( used==0 ) return;
drhb6f41482004-05-14 01:58:11 +0000715 usableSize = pPage->pBt->usableSize;
drh887dc4c2004-10-22 16:22:57 +0000716 assert( pPage->aData==&((unsigned char*)pPage)[-pPage->pBt->psAligned] );
drhda200cc2004-05-09 11:51:38 +0000717 hdr = pPage->hdrOffset;
718 assert( hdr==(pPage->pgno==1 ? 100 : 0) );
719 assert( pPage->pgno==sqlite3pager_pagenumber(pPage->aData) );
720 c = pPage->aData[hdr];
721 if( pPage->isInit ){
722 assert( pPage->leaf == ((c & PTF_LEAF)!=0) );
723 assert( pPage->zeroData == ((c & PTF_ZERODATA)!=0) );
drh8b18dd42004-05-12 19:18:15 +0000724 assert( pPage->leafData == ((c & PTF_LEAFDATA)!=0) );
725 assert( pPage->intKey == ((c & (PTF_INTKEY|PTF_LEAFDATA))!=0) );
726 assert( pPage->hasData ==
727 !(pPage->zeroData || (!pPage->leaf && pPage->leafData)) );
drh43605152004-05-29 21:46:49 +0000728 assert( pPage->cellOffset==pPage->hdrOffset+12-4*pPage->leaf );
729 assert( pPage->nCell = get2byte(&pPage->aData[hdr+3]) );
drhda200cc2004-05-09 11:51:38 +0000730 }
731 data = pPage->aData;
drhb6f41482004-05-14 01:58:11 +0000732 memset(used, 0, usableSize);
drhda200cc2004-05-09 11:51:38 +0000733 for(i=0; i<hdr+10-pPage->leaf*4; i++) used[i] = 1;
734 nFree = 0;
735 pc = get2byte(&data[hdr+1]);
736 while( pc ){
737 int size;
drhb6f41482004-05-14 01:58:11 +0000738 assert( pc>0 && pc<usableSize-4 );
drhda200cc2004-05-09 11:51:38 +0000739 size = get2byte(&data[pc+2]);
drhb6f41482004-05-14 01:58:11 +0000740 assert( pc+size<=usableSize );
drhda200cc2004-05-09 11:51:38 +0000741 nFree += size;
742 for(i=pc; i<pc+size; i++){
743 assert( used[i]==0 );
744 used[i] = 1;
745 }
746 pc = get2byte(&data[pc]);
747 }
drhda200cc2004-05-09 11:51:38 +0000748 idx = 0;
drh43605152004-05-29 21:46:49 +0000749 nCell = get2byte(&data[hdr+3]);
750 cellLimit = get2byte(&data[hdr+5]);
751 assert( pPage->isInit==0
752 || pPage->nFree==nFree+data[hdr+7]+cellLimit-(cellOffset+2*nCell) );
753 cellOffset = pPage->cellOffset;
754 for(i=0; i<nCell; i++){
drhda200cc2004-05-09 11:51:38 +0000755 int size;
drh43605152004-05-29 21:46:49 +0000756 pc = get2byte(&data[cellOffset+2*i]);
drhb6f41482004-05-14 01:58:11 +0000757 assert( pc>0 && pc<usableSize-4 );
drhda200cc2004-05-09 11:51:38 +0000758 size = cellSize(pPage, &data[pc]);
drhb6f41482004-05-14 01:58:11 +0000759 assert( pc+size<=usableSize );
drh43605152004-05-29 21:46:49 +0000760 for(j=pc; j<pc+size; j++){
761 assert( used[j]==0 );
762 used[j] = 1;
drhda200cc2004-05-09 11:51:38 +0000763 }
drhda200cc2004-05-09 11:51:38 +0000764 }
drh43605152004-05-29 21:46:49 +0000765 for(i=cellOffset+2*nCell; i<cellimit; i++){
766 assert( used[i]==0 );
767 used[i] = 1;
768 }
drhda200cc2004-05-09 11:51:38 +0000769 nFree = 0;
drhb6f41482004-05-14 01:58:11 +0000770 for(i=0; i<usableSize; i++){
drhda200cc2004-05-09 11:51:38 +0000771 assert( used[i]<=1 );
772 if( used[i]==0 ) nFree++;
773 }
drh43605152004-05-29 21:46:49 +0000774 assert( nFree==data[hdr+7] );
drh2e38c322004-09-03 18:38:44 +0000775 sqliteFree(used);
drhda200cc2004-05-09 11:51:38 +0000776}
777#define pageIntegrity(X) _pageIntegrity(X)
778#else
779# define pageIntegrity(X)
780#endif
781
782/*
drh72f82862001-05-24 21:06:34 +0000783** Defragment the page given. All Cells are moved to the
784** beginning of the page and all free space is collected
785** into one big FreeBlk at the end of the page.
drh365d68f2001-05-11 11:02:46 +0000786*/
drh2e38c322004-09-03 18:38:44 +0000787static int defragmentPage(MemPage *pPage){
drh43605152004-05-29 21:46:49 +0000788 int i; /* Loop counter */
789 int pc; /* Address of a i-th cell */
790 int addr; /* Offset of first byte after cell pointer array */
791 int hdr; /* Offset to the page header */
792 int size; /* Size of a cell */
793 int usableSize; /* Number of usable bytes on a page */
794 int cellOffset; /* Offset to the cell pointer array */
795 int brk; /* Offset to the cell content area */
796 int nCell; /* Number of cells on the page */
drh2e38c322004-09-03 18:38:44 +0000797 unsigned char *data; /* The page data */
798 unsigned char *temp; /* Temp area for cell content */
drh2af926b2001-05-15 00:39:25 +0000799
drha34b6762004-05-07 13:30:42 +0000800 assert( sqlite3pager_iswriteable(pPage->aData) );
drh9e572e62004-04-23 23:43:10 +0000801 assert( pPage->pBt!=0 );
drh90f5ecb2004-07-22 01:19:35 +0000802 assert( pPage->pBt->usableSize <= SQLITE_MAX_PAGE_SIZE );
drh43605152004-05-29 21:46:49 +0000803 assert( pPage->nOverflow==0 );
drh2e38c322004-09-03 18:38:44 +0000804 temp = sqliteMalloc( pPage->pBt->pageSize );
805 if( temp==0 ) return SQLITE_NOMEM;
drh43605152004-05-29 21:46:49 +0000806 data = pPage->aData;
drh9e572e62004-04-23 23:43:10 +0000807 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +0000808 cellOffset = pPage->cellOffset;
809 nCell = pPage->nCell;
810 assert( nCell==get2byte(&data[hdr+3]) );
811 usableSize = pPage->pBt->usableSize;
812 brk = get2byte(&data[hdr+5]);
813 memcpy(&temp[brk], &data[brk], usableSize - brk);
814 brk = usableSize;
815 for(i=0; i<nCell; i++){
816 u8 *pAddr; /* The i-th cell pointer */
817 pAddr = &data[cellOffset + i*2];
818 pc = get2byte(pAddr);
819 assert( pc<pPage->pBt->usableSize );
820 size = cellSizePtr(pPage, &temp[pc]);
821 brk -= size;
822 memcpy(&data[brk], &temp[pc], size);
823 put2byte(pAddr, brk);
drh2af926b2001-05-15 00:39:25 +0000824 }
drh43605152004-05-29 21:46:49 +0000825 assert( brk>=cellOffset+2*nCell );
826 put2byte(&data[hdr+5], brk);
827 data[hdr+1] = 0;
828 data[hdr+2] = 0;
829 data[hdr+7] = 0;
830 addr = cellOffset+2*nCell;
831 memset(&data[addr], 0, brk-addr);
drh2e38c322004-09-03 18:38:44 +0000832 sqliteFree(temp);
833 return SQLITE_OK;
drh365d68f2001-05-11 11:02:46 +0000834}
835
drha059ad02001-04-17 20:09:11 +0000836/*
drh43605152004-05-29 21:46:49 +0000837** Allocate nByte bytes of space on a page.
drhbd03cae2001-06-02 02:40:57 +0000838**
drh9e572e62004-04-23 23:43:10 +0000839** Return the index into pPage->aData[] of the first byte of
drhbd03cae2001-06-02 02:40:57 +0000840** the new allocation. Or return 0 if there is not enough free
841** space on the page to satisfy the allocation request.
drh2af926b2001-05-15 00:39:25 +0000842**
drh72f82862001-05-24 21:06:34 +0000843** If the page contains nBytes of free space but does not contain
drh8b2f49b2001-06-08 00:21:52 +0000844** nBytes of contiguous free space, then this routine automatically
845** calls defragementPage() to consolidate all free space before
846** allocating the new chunk.
drh7e3b0a02001-04-28 16:52:40 +0000847*/
drh9e572e62004-04-23 23:43:10 +0000848static int allocateSpace(MemPage *pPage, int nByte){
drh3aac2dd2004-04-26 14:10:20 +0000849 int addr, pc, hdr;
drh9e572e62004-04-23 23:43:10 +0000850 int size;
drh24cd67e2004-05-10 16:18:47 +0000851 int nFrag;
drh43605152004-05-29 21:46:49 +0000852 int top;
853 int nCell;
854 int cellOffset;
drh9e572e62004-04-23 23:43:10 +0000855 unsigned char *data;
drh43605152004-05-29 21:46:49 +0000856
drh9e572e62004-04-23 23:43:10 +0000857 data = pPage->aData;
drha34b6762004-05-07 13:30:42 +0000858 assert( sqlite3pager_iswriteable(data) );
drh9e572e62004-04-23 23:43:10 +0000859 assert( pPage->pBt );
860 if( nByte<4 ) nByte = 4;
drh43605152004-05-29 21:46:49 +0000861 if( pPage->nFree<nByte || pPage->nOverflow>0 ) return 0;
862 pPage->nFree -= nByte;
drh9e572e62004-04-23 23:43:10 +0000863 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +0000864
865 nFrag = data[hdr+7];
866 if( nFrag<60 ){
867 /* Search the freelist looking for a slot big enough to satisfy the
868 ** space request. */
869 addr = hdr+1;
870 while( (pc = get2byte(&data[addr]))>0 ){
871 size = get2byte(&data[pc+2]);
872 if( size>=nByte ){
873 if( size<nByte+4 ){
874 memcpy(&data[addr], &data[pc], 2);
875 data[hdr+7] = nFrag + size - nByte;
876 return pc;
877 }else{
878 put2byte(&data[pc+2], size-nByte);
879 return pc + size - nByte;
880 }
881 }
882 addr = pc;
drh9e572e62004-04-23 23:43:10 +0000883 }
884 }
drh43605152004-05-29 21:46:49 +0000885
886 /* Allocate memory from the gap in between the cell pointer array
887 ** and the cell content area.
888 */
889 top = get2byte(&data[hdr+5]);
890 nCell = get2byte(&data[hdr+3]);
891 cellOffset = pPage->cellOffset;
892 if( nFrag>=60 || cellOffset + 2*nCell > top - nByte ){
drh2e38c322004-09-03 18:38:44 +0000893 if( defragmentPage(pPage) ) return 0;
drh43605152004-05-29 21:46:49 +0000894 top = get2byte(&data[hdr+5]);
drh2af926b2001-05-15 00:39:25 +0000895 }
drh43605152004-05-29 21:46:49 +0000896 top -= nByte;
897 assert( cellOffset + 2*nCell <= top );
898 put2byte(&data[hdr+5], top);
899 return top;
drh7e3b0a02001-04-28 16:52:40 +0000900}
901
902/*
drh9e572e62004-04-23 23:43:10 +0000903** Return a section of the pPage->aData to the freelist.
904** The first byte of the new free block is pPage->aDisk[start]
905** and the size of the block is "size" bytes.
drh306dc212001-05-21 13:45:10 +0000906**
907** Most of the effort here is involved in coalesing adjacent
908** free blocks into a single big free block.
drh7e3b0a02001-04-28 16:52:40 +0000909*/
drh9e572e62004-04-23 23:43:10 +0000910static void freeSpace(MemPage *pPage, int start, int size){
drh43605152004-05-29 21:46:49 +0000911 int addr, pbegin, hdr;
drh9e572e62004-04-23 23:43:10 +0000912 unsigned char *data = pPage->aData;
drh2af926b2001-05-15 00:39:25 +0000913
drh9e572e62004-04-23 23:43:10 +0000914 assert( pPage->pBt!=0 );
drha34b6762004-05-07 13:30:42 +0000915 assert( sqlite3pager_iswriteable(data) );
drh9e572e62004-04-23 23:43:10 +0000916 assert( start>=pPage->hdrOffset+6+(pPage->leaf?0:4) );
danielk1977bc6ada42004-06-30 08:20:16 +0000917 assert( (start + size)<=pPage->pBt->usableSize );
drh9e572e62004-04-23 23:43:10 +0000918 if( size<4 ) size = 4;
919
920 /* Add the space back into the linked list of freeblocks */
drh43605152004-05-29 21:46:49 +0000921 hdr = pPage->hdrOffset;
922 addr = hdr + 1;
drh3aac2dd2004-04-26 14:10:20 +0000923 while( (pbegin = get2byte(&data[addr]))<start && pbegin>0 ){
drhb6f41482004-05-14 01:58:11 +0000924 assert( pbegin<=pPage->pBt->usableSize-4 );
drh3aac2dd2004-04-26 14:10:20 +0000925 assert( pbegin>addr );
926 addr = pbegin;
drh2af926b2001-05-15 00:39:25 +0000927 }
drhb6f41482004-05-14 01:58:11 +0000928 assert( pbegin<=pPage->pBt->usableSize-4 );
drh3aac2dd2004-04-26 14:10:20 +0000929 assert( pbegin>addr || pbegin==0 );
drha34b6762004-05-07 13:30:42 +0000930 put2byte(&data[addr], start);
931 put2byte(&data[start], pbegin);
932 put2byte(&data[start+2], size);
drh2af926b2001-05-15 00:39:25 +0000933 pPage->nFree += size;
drh9e572e62004-04-23 23:43:10 +0000934
935 /* Coalesce adjacent free blocks */
drh3aac2dd2004-04-26 14:10:20 +0000936 addr = pPage->hdrOffset + 1;
937 while( (pbegin = get2byte(&data[addr]))>0 ){
drh9e572e62004-04-23 23:43:10 +0000938 int pnext, psize;
drh3aac2dd2004-04-26 14:10:20 +0000939 assert( pbegin>addr );
drh43605152004-05-29 21:46:49 +0000940 assert( pbegin<=pPage->pBt->usableSize-4 );
drh9e572e62004-04-23 23:43:10 +0000941 pnext = get2byte(&data[pbegin]);
942 psize = get2byte(&data[pbegin+2]);
943 if( pbegin + psize + 3 >= pnext && pnext>0 ){
944 int frag = pnext - (pbegin+psize);
drh43605152004-05-29 21:46:49 +0000945 assert( frag<=data[pPage->hdrOffset+7] );
946 data[pPage->hdrOffset+7] -= frag;
drh9e572e62004-04-23 23:43:10 +0000947 put2byte(&data[pbegin], get2byte(&data[pnext]));
948 put2byte(&data[pbegin+2], pnext+get2byte(&data[pnext+2])-pbegin);
949 }else{
drh3aac2dd2004-04-26 14:10:20 +0000950 addr = pbegin;
drh9e572e62004-04-23 23:43:10 +0000951 }
952 }
drh7e3b0a02001-04-28 16:52:40 +0000953
drh43605152004-05-29 21:46:49 +0000954 /* If the cell content area begins with a freeblock, remove it. */
955 if( data[hdr+1]==data[hdr+5] && data[hdr+2]==data[hdr+6] ){
956 int top;
957 pbegin = get2byte(&data[hdr+1]);
958 memcpy(&data[hdr+1], &data[pbegin], 2);
959 top = get2byte(&data[hdr+5]);
960 put2byte(&data[hdr+5], top + get2byte(&data[pbegin+2]));
drh4b70f112004-05-02 21:12:19 +0000961 }
drh4b70f112004-05-02 21:12:19 +0000962}
963
964/*
drh271efa52004-05-30 19:19:05 +0000965** Decode the flags byte (the first byte of the header) for a page
966** and initialize fields of the MemPage structure accordingly.
967*/
968static void decodeFlags(MemPage *pPage, int flagByte){
969 Btree *pBt; /* A copy of pPage->pBt */
970
971 assert( pPage->hdrOffset==(pPage->pgno==1 ? 100 : 0) );
972 pPage->intKey = (flagByte & (PTF_INTKEY|PTF_LEAFDATA))!=0;
973 pPage->zeroData = (flagByte & PTF_ZERODATA)!=0;
974 pPage->leaf = (flagByte & PTF_LEAF)!=0;
975 pPage->childPtrSize = 4*(pPage->leaf==0);
976 pBt = pPage->pBt;
977 if( flagByte & PTF_LEAFDATA ){
978 pPage->leafData = 1;
979 pPage->maxLocal = pBt->maxLeaf;
980 pPage->minLocal = pBt->minLeaf;
981 }else{
982 pPage->leafData = 0;
983 pPage->maxLocal = pBt->maxLocal;
984 pPage->minLocal = pBt->minLocal;
985 }
986 pPage->hasData = !(pPage->zeroData || (!pPage->leaf && pPage->leafData));
987}
988
989/*
drh7e3b0a02001-04-28 16:52:40 +0000990** Initialize the auxiliary information for a disk block.
drh72f82862001-05-24 21:06:34 +0000991**
drhbd03cae2001-06-02 02:40:57 +0000992** The pParent parameter must be a pointer to the MemPage which
drh9e572e62004-04-23 23:43:10 +0000993** is the parent of the page being initialized. The root of a
994** BTree has no parent and so for that page, pParent==NULL.
drh5e2f8b92001-05-28 00:41:15 +0000995**
drh72f82862001-05-24 21:06:34 +0000996** Return SQLITE_OK on success. If we see that the page does
drhda47d772002-12-02 04:25:19 +0000997** not contain a well-formed database page, then return
drh72f82862001-05-24 21:06:34 +0000998** SQLITE_CORRUPT. Note that a return of SQLITE_OK does not
999** guarantee that the page is well-formed. It only shows that
1000** we failed to detect any corruption.
drh7e3b0a02001-04-28 16:52:40 +00001001*/
drh9e572e62004-04-23 23:43:10 +00001002static int initPage(
drh3aac2dd2004-04-26 14:10:20 +00001003 MemPage *pPage, /* The page to be initialized */
drh9e572e62004-04-23 23:43:10 +00001004 MemPage *pParent /* The parent. Might be NULL */
1005){
drh271efa52004-05-30 19:19:05 +00001006 int pc; /* Address of a freeblock within pPage->aData[] */
drh271efa52004-05-30 19:19:05 +00001007 int hdr; /* Offset to beginning of page header */
1008 u8 *data; /* Equal to pPage->aData */
drh2e38c322004-09-03 18:38:44 +00001009 Btree *pBt; /* The main btree structure */
drh271efa52004-05-30 19:19:05 +00001010 int usableSize; /* Amount of usable space on each page */
1011 int cellOffset; /* Offset from start of page to first cell pointer */
1012 int nFree; /* Number of unused bytes on the page */
1013 int top; /* First byte of the cell content area */
drh2af926b2001-05-15 00:39:25 +00001014
drh2e38c322004-09-03 18:38:44 +00001015 pBt = pPage->pBt;
1016 assert( pBt!=0 );
1017 assert( pParent==0 || pParent->pBt==pBt );
drha34b6762004-05-07 13:30:42 +00001018 assert( pPage->pgno==sqlite3pager_pagenumber(pPage->aData) );
drh887dc4c2004-10-22 16:22:57 +00001019 assert( pPage->aData == &((unsigned char*)pPage)[-pBt->psAligned] );
drhee696e22004-08-30 16:52:17 +00001020 if( pPage->pParent!=pParent && (pPage->pParent!=0 || pPage->isInit) ){
1021 /* The parent page should never change unless the file is corrupt */
1022 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
1023 }
drh10617cd2004-05-14 15:27:27 +00001024 if( pPage->isInit ) return SQLITE_OK;
drhda200cc2004-05-09 11:51:38 +00001025 if( pPage->pParent==0 && pParent!=0 ){
1026 pPage->pParent = pParent;
drha34b6762004-05-07 13:30:42 +00001027 sqlite3pager_ref(pParent->aData);
drh5e2f8b92001-05-28 00:41:15 +00001028 }
drhde647132004-05-07 17:57:49 +00001029 hdr = pPage->hdrOffset;
drha34b6762004-05-07 13:30:42 +00001030 data = pPage->aData;
drh271efa52004-05-30 19:19:05 +00001031 decodeFlags(pPage, data[hdr]);
drh43605152004-05-29 21:46:49 +00001032 pPage->nOverflow = 0;
drhc8629a12004-05-08 20:07:40 +00001033 pPage->idxShift = 0;
drh2e38c322004-09-03 18:38:44 +00001034 usableSize = pBt->usableSize;
drh43605152004-05-29 21:46:49 +00001035 pPage->cellOffset = cellOffset = hdr + 12 - 4*pPage->leaf;
1036 top = get2byte(&data[hdr+5]);
1037 pPage->nCell = get2byte(&data[hdr+3]);
drh2e38c322004-09-03 18:38:44 +00001038 if( pPage->nCell>MX_CELL(pBt) ){
drhee696e22004-08-30 16:52:17 +00001039 /* To many cells for a single page. The page must be corrupt */
1040 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
1041 }
1042 if( pPage->nCell==0 && pParent!=0 && pParent->pgno!=1 ){
1043 /* All pages must have at least one cell, except for root pages */
1044 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
1045 }
drh9e572e62004-04-23 23:43:10 +00001046
1047 /* Compute the total free space on the page */
drh9e572e62004-04-23 23:43:10 +00001048 pc = get2byte(&data[hdr+1]);
drh43605152004-05-29 21:46:49 +00001049 nFree = data[hdr+7] + top - (cellOffset + 2*pPage->nCell);
drh9e572e62004-04-23 23:43:10 +00001050 while( pc>0 ){
1051 int next, size;
drhee696e22004-08-30 16:52:17 +00001052 if( pc>usableSize-4 ){
1053 /* Free block is off the page */
1054 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
1055 }
drh9e572e62004-04-23 23:43:10 +00001056 next = get2byte(&data[pc]);
1057 size = get2byte(&data[pc+2]);
drhee696e22004-08-30 16:52:17 +00001058 if( next>0 && next<=pc+size+3 ){
1059 /* Free blocks must be in accending order */
1060 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
1061 }
drh3add3672004-05-15 00:29:24 +00001062 nFree += size;
drh9e572e62004-04-23 23:43:10 +00001063 pc = next;
1064 }
drh3add3672004-05-15 00:29:24 +00001065 pPage->nFree = nFree;
drhee696e22004-08-30 16:52:17 +00001066 if( nFree>=usableSize ){
1067 /* Free space cannot exceed total page size */
1068 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
1069 }
drh9e572e62004-04-23 23:43:10 +00001070
drhde647132004-05-07 17:57:49 +00001071 pPage->isInit = 1;
drhda200cc2004-05-09 11:51:38 +00001072 pageIntegrity(pPage);
drh9e572e62004-04-23 23:43:10 +00001073 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001074}
1075
1076/*
drh8b2f49b2001-06-08 00:21:52 +00001077** Set up a raw page so that it looks like a database page holding
1078** no entries.
drhbd03cae2001-06-02 02:40:57 +00001079*/
drh9e572e62004-04-23 23:43:10 +00001080static void zeroPage(MemPage *pPage, int flags){
1081 unsigned char *data = pPage->aData;
1082 Btree *pBt = pPage->pBt;
drh3aac2dd2004-04-26 14:10:20 +00001083 int hdr = pPage->hdrOffset;
drh9e572e62004-04-23 23:43:10 +00001084 int first;
1085
drhda200cc2004-05-09 11:51:38 +00001086 assert( sqlite3pager_pagenumber(data)==pPage->pgno );
drh887dc4c2004-10-22 16:22:57 +00001087 assert( &data[pBt->psAligned] == (unsigned char*)pPage );
drha34b6762004-05-07 13:30:42 +00001088 assert( sqlite3pager_iswriteable(data) );
drhb6f41482004-05-14 01:58:11 +00001089 memset(&data[hdr], 0, pBt->usableSize - hdr);
drh9e572e62004-04-23 23:43:10 +00001090 data[hdr] = flags;
drh43605152004-05-29 21:46:49 +00001091 first = hdr + 8 + 4*((flags&PTF_LEAF)==0);
1092 memset(&data[hdr+1], 0, 4);
1093 data[hdr+7] = 0;
1094 put2byte(&data[hdr+5], pBt->usableSize);
drhb6f41482004-05-14 01:58:11 +00001095 pPage->nFree = pBt->usableSize - first;
drh271efa52004-05-30 19:19:05 +00001096 decodeFlags(pPage, flags);
drh9e572e62004-04-23 23:43:10 +00001097 pPage->hdrOffset = hdr;
drh43605152004-05-29 21:46:49 +00001098 pPage->cellOffset = first;
1099 pPage->nOverflow = 0;
drhda200cc2004-05-09 11:51:38 +00001100 pPage->idxShift = 0;
drh43605152004-05-29 21:46:49 +00001101 pPage->nCell = 0;
drhda200cc2004-05-09 11:51:38 +00001102 pPage->isInit = 1;
1103 pageIntegrity(pPage);
drhbd03cae2001-06-02 02:40:57 +00001104}
1105
1106/*
drh3aac2dd2004-04-26 14:10:20 +00001107** Get a page from the pager. Initialize the MemPage.pBt and
1108** MemPage.aData elements if needed.
1109*/
1110static int getPage(Btree *pBt, Pgno pgno, MemPage **ppPage){
1111 int rc;
1112 unsigned char *aData;
1113 MemPage *pPage;
drha34b6762004-05-07 13:30:42 +00001114 rc = sqlite3pager_get(pBt->pPager, pgno, (void**)&aData);
drh3aac2dd2004-04-26 14:10:20 +00001115 if( rc ) return rc;
drh887dc4c2004-10-22 16:22:57 +00001116 pPage = (MemPage*)&aData[pBt->psAligned];
drh3aac2dd2004-04-26 14:10:20 +00001117 pPage->aData = aData;
1118 pPage->pBt = pBt;
1119 pPage->pgno = pgno;
drhde647132004-05-07 17:57:49 +00001120 pPage->hdrOffset = pPage->pgno==1 ? 100 : 0;
drh3aac2dd2004-04-26 14:10:20 +00001121 *ppPage = pPage;
1122 return SQLITE_OK;
1123}
1124
1125/*
drhde647132004-05-07 17:57:49 +00001126** Get a page from the pager and initialize it. This routine
1127** is just a convenience wrapper around separate calls to
1128** getPage() and initPage().
1129*/
1130static int getAndInitPage(
1131 Btree *pBt, /* The database file */
1132 Pgno pgno, /* Number of the page to get */
1133 MemPage **ppPage, /* Write the page pointer here */
1134 MemPage *pParent /* Parent of the page */
1135){
1136 int rc;
drhee696e22004-08-30 16:52:17 +00001137 if( pgno==0 ){
1138 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
1139 }
drhde647132004-05-07 17:57:49 +00001140 rc = getPage(pBt, pgno, ppPage);
drh10617cd2004-05-14 15:27:27 +00001141 if( rc==SQLITE_OK && (*ppPage)->isInit==0 ){
drhde647132004-05-07 17:57:49 +00001142 rc = initPage(*ppPage, pParent);
1143 }
1144 return rc;
1145}
1146
1147/*
drh3aac2dd2004-04-26 14:10:20 +00001148** Release a MemPage. This should be called once for each prior
1149** call to getPage.
1150*/
drh4b70f112004-05-02 21:12:19 +00001151static void releasePage(MemPage *pPage){
drh3aac2dd2004-04-26 14:10:20 +00001152 if( pPage ){
1153 assert( pPage->aData );
1154 assert( pPage->pBt );
drh887dc4c2004-10-22 16:22:57 +00001155 assert( &pPage->aData[pPage->pBt->psAligned]==(unsigned char*)pPage );
drha34b6762004-05-07 13:30:42 +00001156 sqlite3pager_unref(pPage->aData);
drh3aac2dd2004-04-26 14:10:20 +00001157 }
1158}
1159
1160/*
drh72f82862001-05-24 21:06:34 +00001161** This routine is called when the reference count for a page
1162** reaches zero. We need to unref the pParent pointer when that
1163** happens.
1164*/
drhb6f41482004-05-14 01:58:11 +00001165static void pageDestructor(void *pData, int pageSize){
drh887dc4c2004-10-22 16:22:57 +00001166 MemPage *pPage = (MemPage*)&((char*)pData)[FORCE_ALIGNMENT(pageSize)];
drh72f82862001-05-24 21:06:34 +00001167 if( pPage->pParent ){
1168 MemPage *pParent = pPage->pParent;
1169 pPage->pParent = 0;
drha34b6762004-05-07 13:30:42 +00001170 releasePage(pParent);
drh72f82862001-05-24 21:06:34 +00001171 }
drh3aac2dd2004-04-26 14:10:20 +00001172 pPage->isInit = 0;
drh72f82862001-05-24 21:06:34 +00001173}
1174
1175/*
drha6abd042004-06-09 17:37:22 +00001176** During a rollback, when the pager reloads information into the cache
1177** so that the cache is restored to its original state at the start of
1178** the transaction, for each page restored this routine is called.
1179**
1180** This routine needs to reset the extra data section at the end of the
1181** page to agree with the restored data.
1182*/
1183static void pageReinit(void *pData, int pageSize){
drh887dc4c2004-10-22 16:22:57 +00001184 MemPage *pPage = (MemPage*)&((char*)pData)[FORCE_ALIGNMENT(pageSize)];
drha6abd042004-06-09 17:37:22 +00001185 if( pPage->isInit ){
1186 pPage->isInit = 0;
1187 initPage(pPage, pPage->pParent);
1188 }
1189}
1190
1191/*
drhad3e0102004-09-03 23:32:18 +00001192** Open a database file.
1193**
drh382c0242001-10-06 16:33:02 +00001194** zFilename is the name of the database file. If zFilename is NULL
drh1bee3d72001-10-15 00:44:35 +00001195** a new database with a random name is created. This randomly named
drh23e11ca2004-05-04 17:27:28 +00001196** database file will be deleted when sqlite3BtreeClose() is called.
drha059ad02001-04-17 20:09:11 +00001197*/
drh23e11ca2004-05-04 17:27:28 +00001198int sqlite3BtreeOpen(
drh3aac2dd2004-04-26 14:10:20 +00001199 const char *zFilename, /* Name of the file containing the BTree database */
1200 Btree **ppBtree, /* Pointer to new Btree object written here */
drh90f5ecb2004-07-22 01:19:35 +00001201 int flags /* Options */
drh6019e162001-07-02 17:51:45 +00001202){
drha059ad02001-04-17 20:09:11 +00001203 Btree *pBt;
drha34b6762004-05-07 13:30:42 +00001204 int rc;
drh90f5ecb2004-07-22 01:19:35 +00001205 int nReserve;
1206 unsigned char zDbHeader[100];
drha059ad02001-04-17 20:09:11 +00001207
drhd62d3d02003-01-24 12:14:20 +00001208 /*
1209 ** The following asserts make sure that structures used by the btree are
1210 ** the right size. This is to guard against size changes that result
1211 ** when compiling on a different architecture.
1212 */
drh4a1c3802004-05-12 15:15:47 +00001213 assert( sizeof(i64)==8 );
drh9e572e62004-04-23 23:43:10 +00001214 assert( sizeof(u64)==8 );
drhd62d3d02003-01-24 12:14:20 +00001215 assert( sizeof(u32)==4 );
1216 assert( sizeof(u16)==2 );
1217 assert( sizeof(Pgno)==4 );
drhd62d3d02003-01-24 12:14:20 +00001218 assert( sizeof(ptr)==sizeof(char*) );
1219 assert( sizeof(uptr)==sizeof(ptr) );
1220
drha059ad02001-04-17 20:09:11 +00001221 pBt = sqliteMalloc( sizeof(*pBt) );
1222 if( pBt==0 ){
drh8c42ca92001-06-22 19:15:00 +00001223 *ppBtree = 0;
drha059ad02001-04-17 20:09:11 +00001224 return SQLITE_NOMEM;
1225 }
drh7bec5052005-02-06 02:45:41 +00001226 rc = sqlite3pager_open(&pBt->pPager, zFilename, EXTRA_SIZE, flags);
drha059ad02001-04-17 20:09:11 +00001227 if( rc!=SQLITE_OK ){
drha34b6762004-05-07 13:30:42 +00001228 if( pBt->pPager ) sqlite3pager_close(pBt->pPager);
drha059ad02001-04-17 20:09:11 +00001229 sqliteFree(pBt);
1230 *ppBtree = 0;
1231 return rc;
1232 }
drha34b6762004-05-07 13:30:42 +00001233 sqlite3pager_set_destructor(pBt->pPager, pageDestructor);
drha6abd042004-06-09 17:37:22 +00001234 sqlite3pager_set_reiniter(pBt->pPager, pageReinit);
drha059ad02001-04-17 20:09:11 +00001235 pBt->pCursor = 0;
drha34b6762004-05-07 13:30:42 +00001236 pBt->pPage1 = 0;
1237 pBt->readOnly = sqlite3pager_isreadonly(pBt->pPager);
drh90f5ecb2004-07-22 01:19:35 +00001238 sqlite3pager_read_fileheader(pBt->pPager, sizeof(zDbHeader), zDbHeader);
1239 pBt->pageSize = get2byte(&zDbHeader[16]);
1240 if( pBt->pageSize<512 || pBt->pageSize>SQLITE_MAX_PAGE_SIZE ){
1241 pBt->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
1242 pBt->maxEmbedFrac = 64; /* 25% */
1243 pBt->minEmbedFrac = 32; /* 12.5% */
1244 pBt->minLeafFrac = 32; /* 12.5% */
drheee46cf2004-11-06 00:02:48 +00001245#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197703aded42004-11-22 05:26:27 +00001246 /* If the magic name ":memory:" will create an in-memory database, then
1247 ** do not set the auto-vacuum flag, even if SQLITE_DEFAULT_AUTOVACUUM
1248 ** is true. On the other hand, if SQLITE_OMIT_MEMORYDB has been defined,
1249 ** then ":memory:" is just a regular file-name. Respect the auto-vacuum
1250 ** default in this case.
1251 */
1252#ifndef SQLITE_OMIT_MEMORYDB
danielk1977951af802004-11-05 15:45:09 +00001253 if( zFilename && strcmp(zFilename,":memory:") ){
danielk197703aded42004-11-22 05:26:27 +00001254#else
1255 if( zFilename ){
1256#endif
danielk1977951af802004-11-05 15:45:09 +00001257 pBt->autoVacuum = SQLITE_DEFAULT_AUTOVACUUM;
1258 }
drheee46cf2004-11-06 00:02:48 +00001259#endif
drh90f5ecb2004-07-22 01:19:35 +00001260 nReserve = 0;
1261 }else{
1262 nReserve = zDbHeader[20];
1263 pBt->maxEmbedFrac = zDbHeader[21];
1264 pBt->minEmbedFrac = zDbHeader[22];
1265 pBt->minLeafFrac = zDbHeader[23];
1266 pBt->pageSizeFixed = 1;
danielk1977951af802004-11-05 15:45:09 +00001267#ifndef SQLITE_OMIT_AUTOVACUUM
1268 pBt->autoVacuum = (get4byte(&zDbHeader[36 + 4*4])?1:0);
1269#endif
drh90f5ecb2004-07-22 01:19:35 +00001270 }
1271 pBt->usableSize = pBt->pageSize - nReserve;
drh887dc4c2004-10-22 16:22:57 +00001272 pBt->psAligned = FORCE_ALIGNMENT(pBt->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00001273 sqlite3pager_set_pagesize(pBt->pPager, pBt->pageSize);
drha059ad02001-04-17 20:09:11 +00001274 *ppBtree = pBt;
1275 return SQLITE_OK;
1276}
1277
1278/*
1279** Close an open database and invalidate all cursors.
1280*/
drh3aac2dd2004-04-26 14:10:20 +00001281int sqlite3BtreeClose(Btree *pBt){
drha059ad02001-04-17 20:09:11 +00001282 while( pBt->pCursor ){
drh3aac2dd2004-04-26 14:10:20 +00001283 sqlite3BtreeCloseCursor(pBt->pCursor);
drha059ad02001-04-17 20:09:11 +00001284 }
drha34b6762004-05-07 13:30:42 +00001285 sqlite3pager_close(pBt->pPager);
drha059ad02001-04-17 20:09:11 +00001286 sqliteFree(pBt);
1287 return SQLITE_OK;
1288}
1289
1290/*
drh90f5ecb2004-07-22 01:19:35 +00001291** Change the busy handler callback function.
1292*/
1293int sqlite3BtreeSetBusyHandler(Btree *pBt, BusyHandler *pHandler){
1294 sqlite3pager_set_busyhandler(pBt->pPager, pHandler);
1295 return SQLITE_OK;
1296}
1297
1298/*
drhda47d772002-12-02 04:25:19 +00001299** Change the limit on the number of pages allowed in the cache.
drhcd61c282002-03-06 22:01:34 +00001300**
1301** The maximum number of cache pages is set to the absolute
1302** value of mxPage. If mxPage is negative, the pager will
1303** operate asynchronously - it will not stop to do fsync()s
1304** to insure data is written to the disk surface before
1305** continuing. Transactions still work if synchronous is off,
1306** and the database cannot be corrupted if this program
1307** crashes. But if the operating system crashes or there is
1308** an abrupt power failure when synchronous is off, the database
1309** could be left in an inconsistent and unrecoverable state.
1310** Synchronous is on by default so database corruption is not
1311** normally a worry.
drhf57b14a2001-09-14 18:54:08 +00001312*/
drh23e11ca2004-05-04 17:27:28 +00001313int sqlite3BtreeSetCacheSize(Btree *pBt, int mxPage){
drha34b6762004-05-07 13:30:42 +00001314 sqlite3pager_set_cachesize(pBt->pPager, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001315 return SQLITE_OK;
1316}
1317
1318/*
drh973b6e32003-02-12 14:09:42 +00001319** Change the way data is synced to disk in order to increase or decrease
1320** how well the database resists damage due to OS crashes and power
1321** failures. Level 1 is the same as asynchronous (no syncs() occur and
1322** there is a high probability of damage) Level 2 is the default. There
1323** is a very low but non-zero probability of damage. Level 3 reduces the
1324** probability of damage to near zero but with a write performance reduction.
1325*/
danielk197793758c82005-01-21 08:13:14 +00001326#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh3aac2dd2004-04-26 14:10:20 +00001327int sqlite3BtreeSetSafetyLevel(Btree *pBt, int level){
drha34b6762004-05-07 13:30:42 +00001328 sqlite3pager_set_safety_level(pBt->pPager, level);
drh973b6e32003-02-12 14:09:42 +00001329 return SQLITE_OK;
1330}
danielk197793758c82005-01-21 08:13:14 +00001331#endif
drh973b6e32003-02-12 14:09:42 +00001332
danielk1977576ec6b2005-01-21 11:55:25 +00001333#if !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM)
drh973b6e32003-02-12 14:09:42 +00001334/*
drh90f5ecb2004-07-22 01:19:35 +00001335** Change the default pages size and the number of reserved bytes per page.
drh06f50212004-11-02 14:24:33 +00001336**
1337** The page size must be a power of 2 between 512 and 65536. If the page
1338** size supplied does not meet this constraint then the page size is not
1339** changed.
1340**
1341** Page sizes are constrained to be a power of two so that the region
1342** of the database file used for locking (beginning at PENDING_BYTE,
1343** the first byte past the 1GB boundary, 0x40000000) needs to occur
1344** at the beginning of a page.
danielk197728129562005-01-11 10:25:06 +00001345**
1346** If parameter nReserve is less than zero, then the number of reserved
1347** bytes per page is left unchanged.
drh90f5ecb2004-07-22 01:19:35 +00001348*/
1349int sqlite3BtreeSetPageSize(Btree *pBt, int pageSize, int nReserve){
1350 if( pBt->pageSizeFixed ){
1351 return SQLITE_READONLY;
1352 }
1353 if( nReserve<0 ){
1354 nReserve = pBt->pageSize - pBt->usableSize;
1355 }
drh06f50212004-11-02 14:24:33 +00001356 if( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE &&
1357 ((pageSize-1)&pageSize)==0 ){
drh90f5ecb2004-07-22 01:19:35 +00001358 pBt->pageSize = pageSize;
drh887dc4c2004-10-22 16:22:57 +00001359 pBt->psAligned = FORCE_ALIGNMENT(pageSize);
drh90f5ecb2004-07-22 01:19:35 +00001360 sqlite3pager_set_pagesize(pBt->pPager, pageSize);
1361 }
1362 pBt->usableSize = pBt->pageSize - nReserve;
1363 return SQLITE_OK;
1364}
1365
1366/*
1367** Return the currently defined page size
1368*/
1369int sqlite3BtreeGetPageSize(Btree *pBt){
1370 return pBt->pageSize;
1371}
drh2011d5f2004-07-22 02:40:37 +00001372int sqlite3BtreeGetReserve(Btree *pBt){
1373 return pBt->pageSize - pBt->usableSize;
1374}
danielk1977576ec6b2005-01-21 11:55:25 +00001375#endif /* !defined(SQLITE_OMIT_PAGER_PRAGMAS) || !defined(SQLITE_OMIT_VACUUM) */
drh90f5ecb2004-07-22 01:19:35 +00001376
1377/*
danielk1977951af802004-11-05 15:45:09 +00001378** Change the 'auto-vacuum' property of the database. If the 'autoVacuum'
1379** parameter is non-zero, then auto-vacuum mode is enabled. If zero, it
1380** is disabled. The default value for the auto-vacuum property is
1381** determined by the SQLITE_DEFAULT_AUTOVACUUM macro.
1382*/
1383int sqlite3BtreeSetAutoVacuum(Btree *pBt, int autoVacuum){
1384#ifdef SQLITE_OMIT_AUTOVACUUM
drheee46cf2004-11-06 00:02:48 +00001385 return SQLITE_READONLY;
danielk1977951af802004-11-05 15:45:09 +00001386#else
1387 if( pBt->pageSizeFixed ){
1388 return SQLITE_READONLY;
1389 }
1390 pBt->autoVacuum = (autoVacuum?1:0);
1391 return SQLITE_OK;
1392#endif
1393}
1394
1395/*
1396** Return the value of the 'auto-vacuum' property. If auto-vacuum is
1397** enabled 1 is returned. Otherwise 0.
1398*/
1399int sqlite3BtreeGetAutoVacuum(Btree *pBt){
1400#ifdef SQLITE_OMIT_AUTOVACUUM
1401 return 0;
1402#else
1403 return pBt->autoVacuum;
1404#endif
1405}
1406
1407
1408/*
drha34b6762004-05-07 13:30:42 +00001409** Get a reference to pPage1 of the database file. This will
drh306dc212001-05-21 13:45:10 +00001410** also acquire a readlock on that file.
1411**
1412** SQLITE_OK is returned on success. If the file is not a
1413** well-formed database file, then SQLITE_CORRUPT is returned.
1414** SQLITE_BUSY is returned if the database is locked. SQLITE_NOMEM
1415** is returned if we run out of memory. SQLITE_PROTOCOL is returned
1416** if there is a locking protocol violation.
1417*/
1418static int lockBtree(Btree *pBt){
1419 int rc;
drh3aac2dd2004-04-26 14:10:20 +00001420 MemPage *pPage1;
drha34b6762004-05-07 13:30:42 +00001421 if( pBt->pPage1 ) return SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00001422 rc = getPage(pBt, 1, &pPage1);
drh306dc212001-05-21 13:45:10 +00001423 if( rc!=SQLITE_OK ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00001424
drh306dc212001-05-21 13:45:10 +00001425
1426 /* Do some checking to help insure the file we opened really is
1427 ** a valid database file.
1428 */
drhb6f41482004-05-14 01:58:11 +00001429 rc = SQLITE_NOTADB;
drha34b6762004-05-07 13:30:42 +00001430 if( sqlite3pager_pagecount(pBt->pPager)>0 ){
drhb6f41482004-05-14 01:58:11 +00001431 u8 *page1 = pPage1->aData;
1432 if( memcmp(page1, zMagicHeader, 16)!=0 ){
drh72f82862001-05-24 21:06:34 +00001433 goto page1_init_failed;
drh306dc212001-05-21 13:45:10 +00001434 }
drhb6f41482004-05-14 01:58:11 +00001435 if( page1[18]>1 || page1[19]>1 ){
1436 goto page1_init_failed;
1437 }
1438 pBt->pageSize = get2byte(&page1[16]);
1439 pBt->usableSize = pBt->pageSize - page1[20];
1440 if( pBt->usableSize<500 ){
1441 goto page1_init_failed;
1442 }
drh887dc4c2004-10-22 16:22:57 +00001443 pBt->psAligned = FORCE_ALIGNMENT(pBt->pageSize);
drhb6f41482004-05-14 01:58:11 +00001444 pBt->maxEmbedFrac = page1[21];
1445 pBt->minEmbedFrac = page1[22];
1446 pBt->minLeafFrac = page1[23];
drh057cd3a2005-02-15 16:23:02 +00001447#ifndef SQLITE_OMIT_AUTOVACUUM
1448 pBt->autoVacuum = (get4byte(&page1[36 + 4*4])?1:0);
1449#endif
drh306dc212001-05-21 13:45:10 +00001450 }
drhb6f41482004-05-14 01:58:11 +00001451
1452 /* maxLocal is the maximum amount of payload to store locally for
1453 ** a cell. Make sure it is small enough so that at least minFanout
1454 ** cells can will fit on one page. We assume a 10-byte page header.
1455 ** Besides the payload, the cell must store:
drh43605152004-05-29 21:46:49 +00001456 ** 2-byte pointer to the cell
drhb6f41482004-05-14 01:58:11 +00001457 ** 4-byte child pointer
1458 ** 9-byte nKey value
1459 ** 4-byte nData value
1460 ** 4-byte overflow page pointer
drh43605152004-05-29 21:46:49 +00001461 ** So a cell consists of a 2-byte poiner, a header which is as much as
1462 ** 17 bytes long, 0 to N bytes of payload, and an optional 4 byte overflow
1463 ** page pointer.
drhb6f41482004-05-14 01:58:11 +00001464 */
drh43605152004-05-29 21:46:49 +00001465 pBt->maxLocal = (pBt->usableSize-12)*pBt->maxEmbedFrac/255 - 23;
1466 pBt->minLocal = (pBt->usableSize-12)*pBt->minEmbedFrac/255 - 23;
1467 pBt->maxLeaf = pBt->usableSize - 35;
1468 pBt->minLeaf = (pBt->usableSize-12)*pBt->minLeafFrac/255 - 23;
drhb6f41482004-05-14 01:58:11 +00001469 if( pBt->minLocal>pBt->maxLocal || pBt->maxLocal<0 ){
1470 goto page1_init_failed;
1471 }
drh2e38c322004-09-03 18:38:44 +00001472 assert( pBt->maxLeaf + 23 <= MX_CELL_SIZE(pBt) );
drh3aac2dd2004-04-26 14:10:20 +00001473 pBt->pPage1 = pPage1;
drhb6f41482004-05-14 01:58:11 +00001474 return SQLITE_OK;
drh306dc212001-05-21 13:45:10 +00001475
drh72f82862001-05-24 21:06:34 +00001476page1_init_failed:
drh3aac2dd2004-04-26 14:10:20 +00001477 releasePage(pPage1);
1478 pBt->pPage1 = 0;
drh72f82862001-05-24 21:06:34 +00001479 return rc;
drh306dc212001-05-21 13:45:10 +00001480}
1481
1482/*
drhb8ca3072001-12-05 00:21:20 +00001483** If there are no outstanding cursors and we are not in the middle
1484** of a transaction but there is a read lock on the database, then
1485** this routine unrefs the first page of the database file which
1486** has the effect of releasing the read lock.
1487**
1488** If there are any outstanding cursors, this routine is a no-op.
1489**
1490** If there is a transaction in progress, this routine is a no-op.
1491*/
1492static void unlockBtreeIfUnused(Btree *pBt){
danielk1977ee5741e2004-05-31 10:01:34 +00001493 if( pBt->inTrans==TRANS_NONE && pBt->pCursor==0 && pBt->pPage1!=0 ){
drh51c6d962004-06-06 00:42:25 +00001494 if( pBt->pPage1->aData==0 ){
1495 MemPage *pPage = pBt->pPage1;
drh887dc4c2004-10-22 16:22:57 +00001496 pPage->aData = &((char*)pPage)[-pBt->psAligned];
drh51c6d962004-06-06 00:42:25 +00001497 pPage->pBt = pBt;
1498 pPage->pgno = 1;
1499 }
drh3aac2dd2004-04-26 14:10:20 +00001500 releasePage(pBt->pPage1);
1501 pBt->pPage1 = 0;
drh3aac2dd2004-04-26 14:10:20 +00001502 pBt->inStmt = 0;
drhb8ca3072001-12-05 00:21:20 +00001503 }
1504}
1505
1506/*
drh9e572e62004-04-23 23:43:10 +00001507** Create a new database by initializing the first page of the
drh8c42ca92001-06-22 19:15:00 +00001508** file.
drh8b2f49b2001-06-08 00:21:52 +00001509*/
1510static int newDatabase(Btree *pBt){
drh9e572e62004-04-23 23:43:10 +00001511 MemPage *pP1;
1512 unsigned char *data;
drh8c42ca92001-06-22 19:15:00 +00001513 int rc;
drhde647132004-05-07 17:57:49 +00001514 if( sqlite3pager_pagecount(pBt->pPager)>0 ) return SQLITE_OK;
drh3aac2dd2004-04-26 14:10:20 +00001515 pP1 = pBt->pPage1;
drh9e572e62004-04-23 23:43:10 +00001516 assert( pP1!=0 );
1517 data = pP1->aData;
drha34b6762004-05-07 13:30:42 +00001518 rc = sqlite3pager_write(data);
drh8b2f49b2001-06-08 00:21:52 +00001519 if( rc ) return rc;
drh9e572e62004-04-23 23:43:10 +00001520 memcpy(data, zMagicHeader, sizeof(zMagicHeader));
1521 assert( sizeof(zMagicHeader)==16 );
drhb6f41482004-05-14 01:58:11 +00001522 put2byte(&data[16], pBt->pageSize);
drh9e572e62004-04-23 23:43:10 +00001523 data[18] = 1;
1524 data[19] = 1;
drhb6f41482004-05-14 01:58:11 +00001525 data[20] = pBt->pageSize - pBt->usableSize;
1526 data[21] = pBt->maxEmbedFrac;
1527 data[22] = pBt->minEmbedFrac;
1528 data[23] = pBt->minLeafFrac;
1529 memset(&data[24], 0, 100-24);
drhe6c43812004-05-14 12:17:46 +00001530 zeroPage(pP1, PTF_INTKEY|PTF_LEAF|PTF_LEAFDATA );
drhf2a611c2004-09-05 00:33:43 +00001531 pBt->pageSizeFixed = 1;
danielk1977003ba062004-11-04 02:57:33 +00001532#ifndef SQLITE_OMIT_AUTOVACUUM
1533 if( pBt->autoVacuum ){
1534 put4byte(&data[36 + 4*4], 1);
1535 }
1536#endif
drh8b2f49b2001-06-08 00:21:52 +00001537 return SQLITE_OK;
1538}
1539
1540/*
danielk1977ee5741e2004-05-31 10:01:34 +00001541** Attempt to start a new transaction. A write-transaction
drh684917c2004-10-05 02:41:42 +00001542** is started if the second argument is nonzero, otherwise a read-
1543** transaction. If the second argument is 2 or more and exclusive
1544** transaction is started, meaning that no other process is allowed
1545** to access the database. A preexisting transaction may not be
1546** upgrade to exclusive by calling this routine a second time - the
1547** exclusivity flag only works for a new transaction.
drh8b2f49b2001-06-08 00:21:52 +00001548**
danielk1977ee5741e2004-05-31 10:01:34 +00001549** A write-transaction must be started before attempting any
1550** changes to the database. None of the following routines
1551** will work unless a transaction is started first:
drh8b2f49b2001-06-08 00:21:52 +00001552**
drh23e11ca2004-05-04 17:27:28 +00001553** sqlite3BtreeCreateTable()
1554** sqlite3BtreeCreateIndex()
1555** sqlite3BtreeClearTable()
1556** sqlite3BtreeDropTable()
1557** sqlite3BtreeInsert()
1558** sqlite3BtreeDelete()
1559** sqlite3BtreeUpdateMeta()
danielk197713adf8a2004-06-03 16:08:41 +00001560**
1561** If wrflag is true, then nMaster specifies the maximum length of
1562** a master journal file name supplied later via sqlite3BtreeSync().
1563** This is so that appropriate space can be allocated in the journal file
1564** when it is created..
drha059ad02001-04-17 20:09:11 +00001565*/
danielk197740b38dc2004-06-26 08:38:24 +00001566int sqlite3BtreeBeginTrans(Btree *pBt, int wrflag){
danielk1977ee5741e2004-05-31 10:01:34 +00001567 int rc = SQLITE_OK;
1568
1569 /* If the btree is already in a write-transaction, or it
1570 ** is already in a read-transaction and a read-transaction
1571 ** is requested, this is a no-op.
1572 */
1573 if( pBt->inTrans==TRANS_WRITE ||
1574 (pBt->inTrans==TRANS_READ && !wrflag) ){
1575 return SQLITE_OK;
1576 }
1577 if( pBt->readOnly && wrflag ){
1578 return SQLITE_READONLY;
1579 }
1580
drh3aac2dd2004-04-26 14:10:20 +00001581 if( pBt->pPage1==0 ){
drh7e3b0a02001-04-28 16:52:40 +00001582 rc = lockBtree(pBt);
danielk1977ee5741e2004-05-31 10:01:34 +00001583 }
1584
1585 if( rc==SQLITE_OK && wrflag ){
drh684917c2004-10-05 02:41:42 +00001586 rc = sqlite3pager_begin(pBt->pPage1->aData, wrflag>1);
danielk1977ee5741e2004-05-31 10:01:34 +00001587 if( rc==SQLITE_OK ){
1588 rc = newDatabase(pBt);
drh8c42ca92001-06-22 19:15:00 +00001589 }
drha059ad02001-04-17 20:09:11 +00001590 }
danielk1977ee5741e2004-05-31 10:01:34 +00001591
drhf74b8d92002-09-01 23:20:45 +00001592 if( rc==SQLITE_OK ){
danielk1977ee5741e2004-05-31 10:01:34 +00001593 pBt->inTrans = (wrflag?TRANS_WRITE:TRANS_READ);
1594 if( wrflag ) pBt->inStmt = 0;
drhb8ca3072001-12-05 00:21:20 +00001595 }else{
1596 unlockBtreeIfUnused(pBt);
drha059ad02001-04-17 20:09:11 +00001597 }
drhb8ca3072001-12-05 00:21:20 +00001598 return rc;
drha059ad02001-04-17 20:09:11 +00001599}
1600
danielk1977687566d2004-11-02 12:56:41 +00001601#ifndef SQLITE_OMIT_AUTOVACUUM
1602
1603/*
1604** Set the pointer-map entries for all children of page pPage. Also, if
1605** pPage contains cells that point to overflow pages, set the pointer
1606** map entries for the overflow pages as well.
1607*/
1608static int setChildPtrmaps(MemPage *pPage){
1609 int i; /* Counter variable */
1610 int nCell; /* Number of cells in page pPage */
1611 int rc = SQLITE_OK; /* Return code */
1612 Btree *pBt = pPage->pBt;
1613 int isInitOrig = pPage->isInit;
1614 Pgno pgno = pPage->pgno;
1615
1616 initPage(pPage, 0);
1617 nCell = pPage->nCell;
1618
1619 for(i=0; i<nCell; i++){
danielk1977687566d2004-11-02 12:56:41 +00001620 u8 *pCell = findCell(pPage, i);
1621
danielk197726836652005-01-17 01:33:13 +00001622 rc = ptrmapPutOvflPtr(pPage, pCell);
1623 if( rc!=SQLITE_OK ){
1624 goto set_child_ptrmaps_out;
danielk1977687566d2004-11-02 12:56:41 +00001625 }
danielk197726836652005-01-17 01:33:13 +00001626
danielk1977687566d2004-11-02 12:56:41 +00001627 if( !pPage->leaf ){
1628 Pgno childPgno = get4byte(pCell);
1629 rc = ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno);
1630 if( rc!=SQLITE_OK ) goto set_child_ptrmaps_out;
1631 }
1632 }
1633
1634 if( !pPage->leaf ){
1635 Pgno childPgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
1636 rc = ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno);
1637 }
1638
1639set_child_ptrmaps_out:
1640 pPage->isInit = isInitOrig;
1641 return rc;
1642}
1643
1644/*
1645** Somewhere on pPage, which is guarenteed to be a btree page, not an overflow
1646** page, is a pointer to page iFrom. Modify this pointer so that it points to
1647** iTo. Parameter eType describes the type of pointer to be modified, as
1648** follows:
1649**
1650** PTRMAP_BTREE: pPage is a btree-page. The pointer points at a child
1651** page of pPage.
1652**
1653** PTRMAP_OVERFLOW1: pPage is a btree-page. The pointer points at an overflow
1654** page pointed to by one of the cells on pPage.
1655**
1656** PTRMAP_OVERFLOW2: pPage is an overflow-page. The pointer points at the next
1657** overflow page in the list.
1658*/
danielk1977fdb7cdb2005-01-17 02:12:18 +00001659static int modifyPagePointer(MemPage *pPage, Pgno iFrom, Pgno iTo, u8 eType){
danielk1977687566d2004-11-02 12:56:41 +00001660 if( eType==PTRMAP_OVERFLOW2 ){
danielk1977f78fc082004-11-02 14:40:32 +00001661 /* The pointer is always the first 4 bytes of the page in this case. */
danielk1977fdb7cdb2005-01-17 02:12:18 +00001662 if( get4byte(pPage->aData)!=iFrom ){
1663 return SQLITE_CORRUPT;
1664 }
danielk1977f78fc082004-11-02 14:40:32 +00001665 put4byte(pPage->aData, iTo);
danielk1977687566d2004-11-02 12:56:41 +00001666 }else{
1667 int isInitOrig = pPage->isInit;
1668 int i;
1669 int nCell;
1670
1671 initPage(pPage, 0);
1672 nCell = pPage->nCell;
1673
danielk1977687566d2004-11-02 12:56:41 +00001674 for(i=0; i<nCell; i++){
1675 u8 *pCell = findCell(pPage, i);
1676 if( eType==PTRMAP_OVERFLOW1 ){
1677 CellInfo info;
1678 parseCellPtr(pPage, pCell, &info);
1679 if( info.iOverflow ){
1680 if( iFrom==get4byte(&pCell[info.iOverflow]) ){
1681 put4byte(&pCell[info.iOverflow], iTo);
1682 break;
1683 }
1684 }
1685 }else{
1686 if( get4byte(pCell)==iFrom ){
1687 put4byte(pCell, iTo);
1688 break;
1689 }
1690 }
1691 }
1692
1693 if( i==nCell ){
danielk1977fdb7cdb2005-01-17 02:12:18 +00001694 if( eType!=PTRMAP_BTREE ||
1695 get4byte(&pPage->aData[pPage->hdrOffset+8])!=iFrom ){
1696 return SQLITE_CORRUPT;
1697 }
danielk1977687566d2004-11-02 12:56:41 +00001698 put4byte(&pPage->aData[pPage->hdrOffset+8], iTo);
1699 }
1700
1701 pPage->isInit = isInitOrig;
1702 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00001703 return SQLITE_OK;
danielk1977687566d2004-11-02 12:56:41 +00001704}
1705
danielk1977003ba062004-11-04 02:57:33 +00001706
danielk19777701e812005-01-10 12:59:51 +00001707/*
1708** Move the open database page pDbPage to location iFreePage in the
1709** database. The pDbPage reference remains valid.
1710*/
danielk1977003ba062004-11-04 02:57:33 +00001711static int relocatePage(
danielk19777701e812005-01-10 12:59:51 +00001712 Btree *pBt, /* Btree */
1713 MemPage *pDbPage, /* Open page to move */
1714 u8 eType, /* Pointer map 'type' entry for pDbPage */
1715 Pgno iPtrPage, /* Pointer map 'page-no' entry for pDbPage */
1716 Pgno iFreePage /* The location to move pDbPage to */
danielk1977003ba062004-11-04 02:57:33 +00001717){
1718 MemPage *pPtrPage; /* The page that contains a pointer to pDbPage */
1719 Pgno iDbPage = pDbPage->pgno;
1720 Pager *pPager = pBt->pPager;
1721 int rc;
1722
danielk1977a0bf2652004-11-04 14:30:04 +00001723 assert( eType==PTRMAP_OVERFLOW2 || eType==PTRMAP_OVERFLOW1 ||
1724 eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE );
danielk1977003ba062004-11-04 02:57:33 +00001725
1726 /* Move page iDbPage from it's current location to page number iFreePage */
1727 TRACE(("AUTOVACUUM: Moving %d to free page %d (ptr page %d type %d)\n",
1728 iDbPage, iFreePage, iPtrPage, eType));
1729 rc = sqlite3pager_movepage(pPager, pDbPage->aData, iFreePage);
1730 if( rc!=SQLITE_OK ){
1731 return rc;
1732 }
1733 pDbPage->pgno = iFreePage;
1734
1735 /* If pDbPage was a btree-page, then it may have child pages and/or cells
1736 ** that point to overflow pages. The pointer map entries for all these
1737 ** pages need to be changed.
1738 **
1739 ** If pDbPage is an overflow page, then the first 4 bytes may store a
1740 ** pointer to a subsequent overflow page. If this is the case, then
1741 ** the pointer map needs to be updated for the subsequent overflow page.
1742 */
danielk1977a0bf2652004-11-04 14:30:04 +00001743 if( eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00001744 rc = setChildPtrmaps(pDbPage);
1745 if( rc!=SQLITE_OK ){
1746 return rc;
1747 }
1748 }else{
1749 Pgno nextOvfl = get4byte(pDbPage->aData);
1750 if( nextOvfl!=0 ){
danielk1977003ba062004-11-04 02:57:33 +00001751 rc = ptrmapPut(pBt, nextOvfl, PTRMAP_OVERFLOW2, iFreePage);
1752 if( rc!=SQLITE_OK ){
1753 return rc;
1754 }
1755 }
1756 }
1757
1758 /* Fix the database pointer on page iPtrPage that pointed at iDbPage so
1759 ** that it points at iFreePage. Also fix the pointer map entry for
1760 ** iPtrPage.
1761 */
danielk1977a0bf2652004-11-04 14:30:04 +00001762 if( eType!=PTRMAP_ROOTPAGE ){
1763 rc = getPage(pBt, iPtrPage, &pPtrPage);
1764 if( rc!=SQLITE_OK ){
1765 return rc;
1766 }
1767 rc = sqlite3pager_write(pPtrPage->aData);
1768 if( rc!=SQLITE_OK ){
1769 releasePage(pPtrPage);
1770 return rc;
1771 }
danielk1977fdb7cdb2005-01-17 02:12:18 +00001772 rc = modifyPagePointer(pPtrPage, iDbPage, iFreePage, eType);
danielk1977003ba062004-11-04 02:57:33 +00001773 releasePage(pPtrPage);
danielk1977fdb7cdb2005-01-17 02:12:18 +00001774 if( rc==SQLITE_OK ){
1775 rc = ptrmapPut(pBt, iFreePage, eType, iPtrPage);
1776 }
danielk1977003ba062004-11-04 02:57:33 +00001777 }
danielk1977003ba062004-11-04 02:57:33 +00001778 return rc;
1779}
1780
danielk1977687566d2004-11-02 12:56:41 +00001781/* Forward declaration required by autoVacuumCommit(). */
danielk1977cb1a7eb2004-11-05 12:27:02 +00001782static int allocatePage(Btree *, MemPage **, Pgno *, Pgno, u8);
danielk1977687566d2004-11-02 12:56:41 +00001783
1784/*
1785** This routine is called prior to sqlite3pager_commit when a transaction
1786** is commited for an auto-vacuum database.
1787*/
danielk1977d761c0c2004-11-05 16:37:02 +00001788static int autoVacuumCommit(Btree *pBt, Pgno *nTrunc){
danielk1977687566d2004-11-02 12:56:41 +00001789 Pager *pPager = pBt->pPager;
1790 Pgno nFreeList; /* Number of pages remaining on the free-list. */
danielk1977a19df672004-11-03 11:37:07 +00001791 int nPtrMap; /* Number of pointer-map pages deallocated */
1792 Pgno origSize; /* Pages in the database file */
1793 Pgno finSize; /* Pages in the database file after truncation */
danielk1977687566d2004-11-02 12:56:41 +00001794 int rc; /* Return code */
1795 u8 eType;
danielk1977a19df672004-11-03 11:37:07 +00001796 int pgsz = pBt->pageSize; /* Page size for this database */
danielk1977687566d2004-11-02 12:56:41 +00001797 Pgno iDbPage; /* The database page to move */
danielk1977687566d2004-11-02 12:56:41 +00001798 MemPage *pDbMemPage = 0; /* "" */
1799 Pgno iPtrPage; /* The page that contains a pointer to iDbPage */
danielk1977687566d2004-11-02 12:56:41 +00001800 Pgno iFreePage; /* The free-list page to move iDbPage to */
1801 MemPage *pFreeMemPage = 0; /* "" */
1802
1803#ifndef NDEBUG
1804 int nRef = *sqlite3pager_stats(pPager);
1805#endif
1806
1807 assert( pBt->autoVacuum );
danielk1977fdb7cdb2005-01-17 02:12:18 +00001808 if( PTRMAP_ISPAGE(pgsz, sqlite3pager_pagecount(pPager)) ){
1809 return SQLITE_CORRUPT;
1810 }
danielk1977687566d2004-11-02 12:56:41 +00001811
1812 /* Figure out how many free-pages are in the database. If there are no
1813 ** free pages, then auto-vacuum is a no-op.
1814 */
1815 nFreeList = get4byte(&pBt->pPage1->aData[36]);
danielk1977a19df672004-11-03 11:37:07 +00001816 if( nFreeList==0 ){
danielk1977d761c0c2004-11-05 16:37:02 +00001817 *nTrunc = 0;
danielk1977a19df672004-11-03 11:37:07 +00001818 return SQLITE_OK;
1819 }
danielk1977687566d2004-11-02 12:56:41 +00001820
danielk1977a19df672004-11-03 11:37:07 +00001821 origSize = sqlite3pager_pagecount(pPager);
1822 nPtrMap = (nFreeList-origSize+PTRMAP_PAGENO(pgsz, origSize)+pgsz/5)/(pgsz/5);
1823 finSize = origSize - nFreeList - nPtrMap;
danielk1977599fcba2004-11-08 07:13:13 +00001824 if( origSize>PENDING_BYTE_PAGE(pBt) && finSize<=PENDING_BYTE_PAGE(pBt) ){
1825 finSize--;
drh42cac6d2004-11-20 20:31:11 +00001826 if( PTRMAP_ISPAGE(pBt->usableSize, finSize) ){
danielk1977599fcba2004-11-08 07:13:13 +00001827 finSize--;
1828 }
1829 }
danielk1977a19df672004-11-03 11:37:07 +00001830 TRACE(("AUTOVACUUM: Begin (db size %d->%d)\n", origSize, finSize));
danielk1977687566d2004-11-02 12:56:41 +00001831
danielk1977a19df672004-11-03 11:37:07 +00001832 /* Variable 'finSize' will be the size of the file in pages after
danielk1977687566d2004-11-02 12:56:41 +00001833 ** the auto-vacuum has completed (the current file size minus the number
1834 ** of pages on the free list). Loop through the pages that lie beyond
1835 ** this mark, and if they are not already on the free list, move them
danielk1977a19df672004-11-03 11:37:07 +00001836 ** to a free page earlier in the file (somewhere before finSize).
danielk1977687566d2004-11-02 12:56:41 +00001837 */
danielk1977a19df672004-11-03 11:37:07 +00001838 for( iDbPage=finSize+1; iDbPage<=origSize; iDbPage++ ){
danielk1977599fcba2004-11-08 07:13:13 +00001839 /* If iDbPage is a pointer map page, or the pending-byte page, skip it. */
1840 if( PTRMAP_ISPAGE(pgsz, iDbPage) || iDbPage==PENDING_BYTE_PAGE(pBt) ){
1841 continue;
1842 }
1843
danielk1977687566d2004-11-02 12:56:41 +00001844 rc = ptrmapGet(pBt, iDbPage, &eType, &iPtrPage);
1845 if( rc!=SQLITE_OK ) goto autovacuum_out;
drhccae6022005-02-26 17:31:26 +00001846 if( eType==PTRMAP_ROOTPAGE ){
1847 rc = SQLITE_CORRUPT;
1848 goto autovacuum_out;
1849 }
danielk1977687566d2004-11-02 12:56:41 +00001850
danielk1977599fcba2004-11-08 07:13:13 +00001851 /* If iDbPage is free, do not swap it. */
1852 if( eType==PTRMAP_FREEPAGE ){
danielk1977687566d2004-11-02 12:56:41 +00001853 continue;
1854 }
1855 rc = getPage(pBt, iDbPage, &pDbMemPage);
1856 if( rc!=SQLITE_OK ) goto autovacuum_out;
danielk1977687566d2004-11-02 12:56:41 +00001857
1858 /* Find the next page in the free-list that is not already at the end
1859 ** of the file. A page can be pulled off the free list using the
1860 ** allocatePage() routine.
1861 */
1862 do{
1863 if( pFreeMemPage ){
1864 releasePage(pFreeMemPage);
1865 pFreeMemPage = 0;
1866 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00001867 rc = allocatePage(pBt, &pFreeMemPage, &iFreePage, 0, 0);
danielk1977ac11ee62005-01-15 12:45:51 +00001868 if( rc!=SQLITE_OK ){
1869 releasePage(pDbMemPage);
1870 goto autovacuum_out;
1871 }
danielk1977a19df672004-11-03 11:37:07 +00001872 assert( iFreePage<=origSize );
1873 }while( iFreePage>finSize );
danielk1977687566d2004-11-02 12:56:41 +00001874 releasePage(pFreeMemPage);
1875 pFreeMemPage = 0;
danielk1977687566d2004-11-02 12:56:41 +00001876
danielk1977003ba062004-11-04 02:57:33 +00001877 rc = relocatePage(pBt, pDbMemPage, eType, iPtrPage, iFreePage);
danielk1977687566d2004-11-02 12:56:41 +00001878 releasePage(pDbMemPage);
danielk1977687566d2004-11-02 12:56:41 +00001879 if( rc!=SQLITE_OK ) goto autovacuum_out;
danielk1977687566d2004-11-02 12:56:41 +00001880 }
1881
1882 /* The entire free-list has been swapped to the end of the file. So
danielk1977a19df672004-11-03 11:37:07 +00001883 ** truncate the database file to finSize pages and consider the
danielk1977687566d2004-11-02 12:56:41 +00001884 ** free-list empty.
1885 */
1886 rc = sqlite3pager_write(pBt->pPage1->aData);
1887 if( rc!=SQLITE_OK ) goto autovacuum_out;
1888 put4byte(&pBt->pPage1->aData[32], 0);
1889 put4byte(&pBt->pPage1->aData[36], 0);
danielk1977687566d2004-11-02 12:56:41 +00001890 if( rc!=SQLITE_OK ) goto autovacuum_out;
danielk1977d761c0c2004-11-05 16:37:02 +00001891 *nTrunc = finSize;
danielk1977687566d2004-11-02 12:56:41 +00001892
1893autovacuum_out:
danielk1977687566d2004-11-02 12:56:41 +00001894 assert( nRef==*sqlite3pager_stats(pPager) );
1895 if( rc!=SQLITE_OK ){
1896 sqlite3pager_rollback(pPager);
1897 }
1898 return rc;
1899}
1900#endif
1901
1902/*
drh2aa679f2001-06-25 02:11:07 +00001903** Commit the transaction currently in progress.
drh5e00f6c2001-09-13 13:46:56 +00001904**
1905** This will release the write lock on the database file. If there
1906** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00001907*/
drh3aac2dd2004-04-26 14:10:20 +00001908int sqlite3BtreeCommit(Btree *pBt){
danielk1977ee5741e2004-05-31 10:01:34 +00001909 int rc = SQLITE_OK;
1910 if( pBt->inTrans==TRANS_WRITE ){
1911 rc = sqlite3pager_commit(pBt->pPager);
1912 }
1913 pBt->inTrans = TRANS_NONE;
drh3aac2dd2004-04-26 14:10:20 +00001914 pBt->inStmt = 0;
drh5e00f6c2001-09-13 13:46:56 +00001915 unlockBtreeIfUnused(pBt);
drha059ad02001-04-17 20:09:11 +00001916 return rc;
1917}
1918
danielk1977fbcd5852004-06-15 02:44:18 +00001919#ifndef NDEBUG
1920/*
1921** Return the number of write-cursors open on this handle. This is for use
1922** in assert() expressions, so it is only compiled if NDEBUG is not
1923** defined.
1924*/
1925static int countWriteCursors(Btree *pBt){
1926 BtCursor *pCur;
1927 int r = 0;
1928 for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
1929 if( pCur->wrFlag ) r++;
1930 }
1931 return r;
1932}
1933#endif
1934
drhda200cc2004-05-09 11:51:38 +00001935#ifdef SQLITE_TEST
1936/*
1937** Print debugging information about all cursors to standard output.
1938*/
1939void sqlite3BtreeCursorList(Btree *pBt){
1940 BtCursor *pCur;
1941 for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
1942 MemPage *pPage = pCur->pPage;
1943 char *zMode = pCur->wrFlag ? "rw" : "ro";
drhfe63d1c2004-09-08 20:13:04 +00001944 sqlite3DebugPrintf("CURSOR %p rooted at %4d(%s) currently at %d.%d%s\n",
1945 pCur, pCur->pgnoRoot, zMode,
drhda200cc2004-05-09 11:51:38 +00001946 pPage ? pPage->pgno : 0, pCur->idx,
1947 pCur->isValid ? "" : " eof"
1948 );
1949 }
1950}
1951#endif
1952
drhc39e0002004-05-07 23:50:57 +00001953/*
drhecdc7532001-09-23 02:35:53 +00001954** Rollback the transaction in progress. All cursors will be
1955** invalided by this operation. Any attempt to use a cursor
1956** that was open at the beginning of this operation will result
1957** in an error.
drh5e00f6c2001-09-13 13:46:56 +00001958**
1959** This will release the write lock on the database file. If there
1960** are no active cursors, it also releases the read lock.
drha059ad02001-04-17 20:09:11 +00001961*/
drh3aac2dd2004-04-26 14:10:20 +00001962int sqlite3BtreeRollback(Btree *pBt){
danielk1977cfe9a692004-06-16 12:00:29 +00001963 int rc = SQLITE_OK;
drh24cd67e2004-05-10 16:18:47 +00001964 MemPage *pPage1;
danielk1977ee5741e2004-05-31 10:01:34 +00001965 if( pBt->inTrans==TRANS_WRITE ){
drh24cd67e2004-05-10 16:18:47 +00001966 rc = sqlite3pager_rollback(pBt->pPager);
1967 /* The rollback may have destroyed the pPage1->aData value. So
1968 ** call getPage() on page 1 again to make sure pPage1->aData is
1969 ** set correctly. */
1970 if( getPage(pBt, 1, &pPage1)==SQLITE_OK ){
1971 releasePage(pPage1);
1972 }
danielk1977fbcd5852004-06-15 02:44:18 +00001973 assert( countWriteCursors(pBt)==0 );
drh24cd67e2004-05-10 16:18:47 +00001974 }
danielk1977ee5741e2004-05-31 10:01:34 +00001975 pBt->inTrans = TRANS_NONE;
1976 pBt->inStmt = 0;
drh5e00f6c2001-09-13 13:46:56 +00001977 unlockBtreeIfUnused(pBt);
drha059ad02001-04-17 20:09:11 +00001978 return rc;
1979}
1980
1981/*
drhab01f612004-05-22 02:55:23 +00001982** Start a statement subtransaction. The subtransaction can
1983** can be rolled back independently of the main transaction.
1984** You must start a transaction before starting a subtransaction.
1985** The subtransaction is ended automatically if the main transaction
drh663fc632002-02-02 18:49:19 +00001986** commits or rolls back.
1987**
drhab01f612004-05-22 02:55:23 +00001988** Only one subtransaction may be active at a time. It is an error to try
1989** to start a new subtransaction if another subtransaction is already active.
1990**
1991** Statement subtransactions are used around individual SQL statements
1992** that are contained within a BEGIN...COMMIT block. If a constraint
1993** error occurs within the statement, the effect of that one statement
1994** can be rolled back without having to rollback the entire transaction.
drh663fc632002-02-02 18:49:19 +00001995*/
drh3aac2dd2004-04-26 14:10:20 +00001996int sqlite3BtreeBeginStmt(Btree *pBt){
drh663fc632002-02-02 18:49:19 +00001997 int rc;
danielk1977ee5741e2004-05-31 10:01:34 +00001998 if( (pBt->inTrans!=TRANS_WRITE) || pBt->inStmt ){
drhf74b8d92002-09-01 23:20:45 +00001999 return pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drh0d65dc02002-02-03 00:56:09 +00002000 }
drha34b6762004-05-07 13:30:42 +00002001 rc = pBt->readOnly ? SQLITE_OK : sqlite3pager_stmt_begin(pBt->pPager);
drh3aac2dd2004-04-26 14:10:20 +00002002 pBt->inStmt = 1;
drh663fc632002-02-02 18:49:19 +00002003 return rc;
2004}
2005
2006
2007/*
drhab01f612004-05-22 02:55:23 +00002008** Commit the statment subtransaction currently in progress. If no
2009** subtransaction is active, this is a no-op.
drh663fc632002-02-02 18:49:19 +00002010*/
drh3aac2dd2004-04-26 14:10:20 +00002011int sqlite3BtreeCommitStmt(Btree *pBt){
drh663fc632002-02-02 18:49:19 +00002012 int rc;
drh3aac2dd2004-04-26 14:10:20 +00002013 if( pBt->inStmt && !pBt->readOnly ){
drha34b6762004-05-07 13:30:42 +00002014 rc = sqlite3pager_stmt_commit(pBt->pPager);
drh663fc632002-02-02 18:49:19 +00002015 }else{
2016 rc = SQLITE_OK;
2017 }
drh3aac2dd2004-04-26 14:10:20 +00002018 pBt->inStmt = 0;
drh663fc632002-02-02 18:49:19 +00002019 return rc;
2020}
2021
2022/*
drhab01f612004-05-22 02:55:23 +00002023** Rollback the active statement subtransaction. If no subtransaction
2024** is active this routine is a no-op.
drh663fc632002-02-02 18:49:19 +00002025**
drhab01f612004-05-22 02:55:23 +00002026** All cursors will be invalidated by this operation. Any attempt
drh663fc632002-02-02 18:49:19 +00002027** to use a cursor that was open at the beginning of this operation
2028** will result in an error.
2029*/
drh3aac2dd2004-04-26 14:10:20 +00002030int sqlite3BtreeRollbackStmt(Btree *pBt){
drh663fc632002-02-02 18:49:19 +00002031 int rc;
drh3aac2dd2004-04-26 14:10:20 +00002032 if( pBt->inStmt==0 || pBt->readOnly ) return SQLITE_OK;
drha34b6762004-05-07 13:30:42 +00002033 rc = sqlite3pager_stmt_rollback(pBt->pPager);
danielk1977fbcd5852004-06-15 02:44:18 +00002034 assert( countWriteCursors(pBt)==0 );
drh3aac2dd2004-04-26 14:10:20 +00002035 pBt->inStmt = 0;
drh663fc632002-02-02 18:49:19 +00002036 return rc;
2037}
2038
2039/*
drh3aac2dd2004-04-26 14:10:20 +00002040** Default key comparison function to be used if no comparison function
2041** is specified on the sqlite3BtreeCursor() call.
2042*/
2043static int dfltCompare(
2044 void *NotUsed, /* User data is not used */
2045 int n1, const void *p1, /* First key to compare */
2046 int n2, const void *p2 /* Second key to compare */
2047){
2048 int c;
2049 c = memcmp(p1, p2, n1<n2 ? n1 : n2);
2050 if( c==0 ){
2051 c = n1 - n2;
2052 }
2053 return c;
2054}
2055
2056/*
drh8b2f49b2001-06-08 00:21:52 +00002057** Create a new cursor for the BTree whose root is on the page
2058** iTable. The act of acquiring a cursor gets a read lock on
2059** the database file.
drh1bee3d72001-10-15 00:44:35 +00002060**
2061** If wrFlag==0, then the cursor can only be used for reading.
drhf74b8d92002-09-01 23:20:45 +00002062** If wrFlag==1, then the cursor can be used for reading or for
2063** writing if other conditions for writing are also met. These
2064** are the conditions that must be met in order for writing to
2065** be allowed:
drh6446c4d2001-12-15 14:22:18 +00002066**
drhf74b8d92002-09-01 23:20:45 +00002067** 1: The cursor must have been opened with wrFlag==1
2068**
2069** 2: No other cursors may be open with wrFlag==0 on the same table
2070**
2071** 3: The database must be writable (not on read-only media)
2072**
2073** 4: There must be an active transaction.
2074**
2075** Condition 2 warrants further discussion. If any cursor is opened
2076** on a table with wrFlag==0, that prevents all other cursors from
2077** writing to that table. This is a kind of "read-lock". When a cursor
2078** is opened with wrFlag==0 it is guaranteed that the table will not
2079** change as long as the cursor is open. This allows the cursor to
2080** do a sequential scan of the table without having to worry about
2081** entries being inserted or deleted during the scan. Cursors should
2082** be opened with wrFlag==0 only if this read-lock property is needed.
2083** That is to say, cursors should be opened with wrFlag==0 only if they
drh23e11ca2004-05-04 17:27:28 +00002084** intend to use the sqlite3BtreeNext() system call. All other cursors
drhf74b8d92002-09-01 23:20:45 +00002085** should be opened with wrFlag==1 even if they never really intend
2086** to write.
2087**
drh6446c4d2001-12-15 14:22:18 +00002088** No checking is done to make sure that page iTable really is the
2089** root page of a b-tree. If it is not, then the cursor acquired
2090** will not work correctly.
drh3aac2dd2004-04-26 14:10:20 +00002091**
2092** The comparison function must be logically the same for every cursor
2093** on a particular table. Changing the comparison function will result
2094** in incorrect operations. If the comparison function is NULL, a
2095** default comparison function is used. The comparison function is
2096** always ignored for INTKEY tables.
drha059ad02001-04-17 20:09:11 +00002097*/
drh3aac2dd2004-04-26 14:10:20 +00002098int sqlite3BtreeCursor(
2099 Btree *pBt, /* The btree */
2100 int iTable, /* Root page of table to open */
2101 int wrFlag, /* 1 to write. 0 read-only */
2102 int (*xCmp)(void*,int,const void*,int,const void*), /* Key Comparison func */
2103 void *pArg, /* First arg to xCompare() */
2104 BtCursor **ppCur /* Write new cursor here */
2105){
drha059ad02001-04-17 20:09:11 +00002106 int rc;
drh8dcd7ca2004-08-08 19:43:29 +00002107 BtCursor *pCur;
drhecdc7532001-09-23 02:35:53 +00002108
drh8dcd7ca2004-08-08 19:43:29 +00002109 *ppCur = 0;
2110 if( wrFlag ){
drh8dcd7ca2004-08-08 19:43:29 +00002111 if( pBt->readOnly ){
2112 return SQLITE_READONLY;
2113 }
2114 if( checkReadLocks(pBt, iTable, 0) ){
2115 return SQLITE_LOCKED;
2116 }
drha0c9a112004-03-10 13:42:37 +00002117 }
drh4b70f112004-05-02 21:12:19 +00002118 if( pBt->pPage1==0 ){
drha059ad02001-04-17 20:09:11 +00002119 rc = lockBtree(pBt);
2120 if( rc!=SQLITE_OK ){
drha059ad02001-04-17 20:09:11 +00002121 return rc;
2122 }
2123 }
drheafe05b2004-06-13 00:54:01 +00002124 pCur = sqliteMallocRaw( sizeof(*pCur) );
drha059ad02001-04-17 20:09:11 +00002125 if( pCur==0 ){
drhbd03cae2001-06-02 02:40:57 +00002126 rc = SQLITE_NOMEM;
2127 goto create_cursor_exception;
2128 }
drh8b2f49b2001-06-08 00:21:52 +00002129 pCur->pgnoRoot = (Pgno)iTable;
drh24cd67e2004-05-10 16:18:47 +00002130 if( iTable==1 && sqlite3pager_pagecount(pBt->pPager)==0 ){
2131 rc = SQLITE_EMPTY;
drheafe05b2004-06-13 00:54:01 +00002132 pCur->pPage = 0;
drh24cd67e2004-05-10 16:18:47 +00002133 goto create_cursor_exception;
2134 }
danielk1977369f27e2004-06-15 11:40:04 +00002135 pCur->pPage = 0; /* For exit-handler, in case getAndInitPage() fails. */
drhde647132004-05-07 17:57:49 +00002136 rc = getAndInitPage(pBt, pCur->pgnoRoot, &pCur->pPage, 0);
drhbd03cae2001-06-02 02:40:57 +00002137 if( rc!=SQLITE_OK ){
2138 goto create_cursor_exception;
drha059ad02001-04-17 20:09:11 +00002139 }
drh3aac2dd2004-04-26 14:10:20 +00002140 pCur->xCompare = xCmp ? xCmp : dfltCompare;
2141 pCur->pArg = pArg;
drh14acc042001-06-10 19:56:58 +00002142 pCur->pBt = pBt;
drhecdc7532001-09-23 02:35:53 +00002143 pCur->wrFlag = wrFlag;
drh14acc042001-06-10 19:56:58 +00002144 pCur->idx = 0;
drh59eb6762004-06-13 23:07:04 +00002145 memset(&pCur->info, 0, sizeof(pCur->info));
drha059ad02001-04-17 20:09:11 +00002146 pCur->pNext = pBt->pCursor;
2147 if( pCur->pNext ){
2148 pCur->pNext->pPrev = pCur;
2149 }
drh14acc042001-06-10 19:56:58 +00002150 pCur->pPrev = 0;
drha059ad02001-04-17 20:09:11 +00002151 pBt->pCursor = pCur;
drhc39e0002004-05-07 23:50:57 +00002152 pCur->isValid = 0;
drh2af926b2001-05-15 00:39:25 +00002153 *ppCur = pCur;
2154 return SQLITE_OK;
drhbd03cae2001-06-02 02:40:57 +00002155
2156create_cursor_exception:
drhbd03cae2001-06-02 02:40:57 +00002157 if( pCur ){
drh3aac2dd2004-04-26 14:10:20 +00002158 releasePage(pCur->pPage);
drhbd03cae2001-06-02 02:40:57 +00002159 sqliteFree(pCur);
2160 }
drh5e00f6c2001-09-13 13:46:56 +00002161 unlockBtreeIfUnused(pBt);
drhbd03cae2001-06-02 02:40:57 +00002162 return rc;
drha059ad02001-04-17 20:09:11 +00002163}
2164
drh7a224de2004-06-02 01:22:02 +00002165#if 0 /* Not Used */
drhd3d39e92004-05-20 22:16:29 +00002166/*
2167** Change the value of the comparison function used by a cursor.
2168*/
danielk1977bf3b7212004-05-18 10:06:24 +00002169void sqlite3BtreeSetCompare(
drhd3d39e92004-05-20 22:16:29 +00002170 BtCursor *pCur, /* The cursor to whose comparison function is changed */
2171 int(*xCmp)(void*,int,const void*,int,const void*), /* New comparison func */
2172 void *pArg /* First argument to xCmp() */
danielk1977bf3b7212004-05-18 10:06:24 +00002173){
2174 pCur->xCompare = xCmp ? xCmp : dfltCompare;
2175 pCur->pArg = pArg;
2176}
drh7a224de2004-06-02 01:22:02 +00002177#endif
danielk1977bf3b7212004-05-18 10:06:24 +00002178
drha059ad02001-04-17 20:09:11 +00002179/*
drh5e00f6c2001-09-13 13:46:56 +00002180** Close a cursor. The read lock on the database file is released
drhbd03cae2001-06-02 02:40:57 +00002181** when the last cursor is closed.
drha059ad02001-04-17 20:09:11 +00002182*/
drh3aac2dd2004-04-26 14:10:20 +00002183int sqlite3BtreeCloseCursor(BtCursor *pCur){
drha059ad02001-04-17 20:09:11 +00002184 Btree *pBt = pCur->pBt;
drha059ad02001-04-17 20:09:11 +00002185 if( pCur->pPrev ){
2186 pCur->pPrev->pNext = pCur->pNext;
2187 }else{
2188 pBt->pCursor = pCur->pNext;
2189 }
2190 if( pCur->pNext ){
2191 pCur->pNext->pPrev = pCur->pPrev;
2192 }
drh3aac2dd2004-04-26 14:10:20 +00002193 releasePage(pCur->pPage);
drh5e00f6c2001-09-13 13:46:56 +00002194 unlockBtreeIfUnused(pBt);
drha059ad02001-04-17 20:09:11 +00002195 sqliteFree(pCur);
drh8c42ca92001-06-22 19:15:00 +00002196 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00002197}
2198
drh7e3b0a02001-04-28 16:52:40 +00002199/*
drh5e2f8b92001-05-28 00:41:15 +00002200** Make a temporary cursor by filling in the fields of pTempCur.
2201** The temporary cursor is not on the cursor list for the Btree.
2202*/
drh14acc042001-06-10 19:56:58 +00002203static void getTempCursor(BtCursor *pCur, BtCursor *pTempCur){
drh5e2f8b92001-05-28 00:41:15 +00002204 memcpy(pTempCur, pCur, sizeof(*pCur));
2205 pTempCur->pNext = 0;
2206 pTempCur->pPrev = 0;
drhecdc7532001-09-23 02:35:53 +00002207 if( pTempCur->pPage ){
drha34b6762004-05-07 13:30:42 +00002208 sqlite3pager_ref(pTempCur->pPage->aData);
drhecdc7532001-09-23 02:35:53 +00002209 }
drh5e2f8b92001-05-28 00:41:15 +00002210}
2211
2212/*
drhbd03cae2001-06-02 02:40:57 +00002213** Delete a temporary cursor such as was made by the CreateTemporaryCursor()
drh5e2f8b92001-05-28 00:41:15 +00002214** function above.
2215*/
drh14acc042001-06-10 19:56:58 +00002216static void releaseTempCursor(BtCursor *pCur){
drhecdc7532001-09-23 02:35:53 +00002217 if( pCur->pPage ){
drha34b6762004-05-07 13:30:42 +00002218 sqlite3pager_unref(pCur->pPage->aData);
drhecdc7532001-09-23 02:35:53 +00002219 }
drh5e2f8b92001-05-28 00:41:15 +00002220}
2221
2222/*
drh9188b382004-05-14 21:12:22 +00002223** Make sure the BtCursor.info field of the given cursor is valid.
drhab01f612004-05-22 02:55:23 +00002224** If it is not already valid, call parseCell() to fill it in.
2225**
2226** BtCursor.info is a cache of the information in the current cell.
2227** Using this cache reduces the number of calls to parseCell().
drh9188b382004-05-14 21:12:22 +00002228*/
2229static void getCellInfo(BtCursor *pCur){
drh271efa52004-05-30 19:19:05 +00002230 if( pCur->info.nSize==0 ){
drh3a41a3f2004-05-30 02:14:17 +00002231 parseCell(pCur->pPage, pCur->idx, &pCur->info);
drh9188b382004-05-14 21:12:22 +00002232 }else{
2233#ifndef NDEBUG
2234 CellInfo info;
drh51c6d962004-06-06 00:42:25 +00002235 memset(&info, 0, sizeof(info));
drh3a41a3f2004-05-30 02:14:17 +00002236 parseCell(pCur->pPage, pCur->idx, &info);
drh9188b382004-05-14 21:12:22 +00002237 assert( memcmp(&info, &pCur->info, sizeof(info))==0 );
2238#endif
2239 }
2240}
2241
2242/*
drh3aac2dd2004-04-26 14:10:20 +00002243** Set *pSize to the size of the buffer needed to hold the value of
2244** the key for the current entry. If the cursor is not pointing
2245** to a valid entry, *pSize is set to 0.
2246**
drh4b70f112004-05-02 21:12:19 +00002247** For a table with the INTKEY flag set, this routine returns the key
drh3aac2dd2004-04-26 14:10:20 +00002248** itself, not the number of bytes in the key.
drh7e3b0a02001-04-28 16:52:40 +00002249*/
drh4a1c3802004-05-12 15:15:47 +00002250int sqlite3BtreeKeySize(BtCursor *pCur, i64 *pSize){
danielk1977299b1872004-11-22 10:02:10 +00002251 if( !pCur->isValid ){
drh72f82862001-05-24 21:06:34 +00002252 *pSize = 0;
2253 }else{
drh9188b382004-05-14 21:12:22 +00002254 getCellInfo(pCur);
2255 *pSize = pCur->info.nKey;
drh72f82862001-05-24 21:06:34 +00002256 }
2257 return SQLITE_OK;
drha059ad02001-04-17 20:09:11 +00002258}
drh2af926b2001-05-15 00:39:25 +00002259
drh72f82862001-05-24 21:06:34 +00002260/*
drh0e1c19e2004-05-11 00:58:56 +00002261** Set *pSize to the number of bytes of data in the entry the
2262** cursor currently points to. Always return SQLITE_OK.
2263** Failure is not possible. If the cursor is not currently
2264** pointing to an entry (which can happen, for example, if
2265** the database is empty) then *pSize is set to 0.
2266*/
2267int sqlite3BtreeDataSize(BtCursor *pCur, u32 *pSize){
danielk1977299b1872004-11-22 10:02:10 +00002268 if( !pCur->isValid ){
danielk197796fc5fe2004-05-13 11:34:16 +00002269 /* Not pointing at a valid entry - set *pSize to 0. */
drh0e1c19e2004-05-11 00:58:56 +00002270 *pSize = 0;
2271 }else{
drh9188b382004-05-14 21:12:22 +00002272 getCellInfo(pCur);
2273 *pSize = pCur->info.nData;
drh0e1c19e2004-05-11 00:58:56 +00002274 }
2275 return SQLITE_OK;
2276}
2277
2278/*
drh72f82862001-05-24 21:06:34 +00002279** Read payload information from the entry that the pCur cursor is
2280** pointing to. Begin reading the payload at "offset" and read
2281** a total of "amt" bytes. Put the result in zBuf.
2282**
2283** This routine does not make a distinction between key and data.
drhab01f612004-05-22 02:55:23 +00002284** It just reads bytes from the payload area. Data might appear
2285** on the main page or be scattered out on multiple overflow pages.
drh72f82862001-05-24 21:06:34 +00002286*/
drh3aac2dd2004-04-26 14:10:20 +00002287static int getPayload(
2288 BtCursor *pCur, /* Cursor pointing to entry to read from */
2289 int offset, /* Begin reading this far into payload */
2290 int amt, /* Read this many bytes */
2291 unsigned char *pBuf, /* Write the bytes into this buffer */
2292 int skipKey /* offset begins at data if this is true */
2293){
2294 unsigned char *aPayload;
drh2af926b2001-05-15 00:39:25 +00002295 Pgno nextPage;
drh8c42ca92001-06-22 19:15:00 +00002296 int rc;
drh3aac2dd2004-04-26 14:10:20 +00002297 MemPage *pPage;
2298 Btree *pBt;
drh6f11bef2004-05-13 01:12:56 +00002299 int ovflSize;
drhfa1a98a2004-05-14 19:08:17 +00002300 u32 nKey;
drh3aac2dd2004-04-26 14:10:20 +00002301
drh72f82862001-05-24 21:06:34 +00002302 assert( pCur!=0 && pCur->pPage!=0 );
drhc39e0002004-05-07 23:50:57 +00002303 assert( pCur->isValid );
drh3aac2dd2004-04-26 14:10:20 +00002304 pBt = pCur->pBt;
2305 pPage = pCur->pPage;
drhda200cc2004-05-09 11:51:38 +00002306 pageIntegrity(pPage);
drh3aac2dd2004-04-26 14:10:20 +00002307 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
drh9188b382004-05-14 21:12:22 +00002308 getCellInfo(pCur);
drh43605152004-05-29 21:46:49 +00002309 aPayload = pCur->info.pCell;
drhfa1a98a2004-05-14 19:08:17 +00002310 aPayload += pCur->info.nHeader;
drh3aac2dd2004-04-26 14:10:20 +00002311 if( pPage->intKey ){
drhfa1a98a2004-05-14 19:08:17 +00002312 nKey = 0;
2313 }else{
2314 nKey = pCur->info.nKey;
drh3aac2dd2004-04-26 14:10:20 +00002315 }
2316 assert( offset>=0 );
2317 if( skipKey ){
drhfa1a98a2004-05-14 19:08:17 +00002318 offset += nKey;
drh3aac2dd2004-04-26 14:10:20 +00002319 }
drhfa1a98a2004-05-14 19:08:17 +00002320 if( offset+amt > nKey+pCur->info.nData ){
drha34b6762004-05-07 13:30:42 +00002321 return SQLITE_ERROR;
drh3aac2dd2004-04-26 14:10:20 +00002322 }
drhfa1a98a2004-05-14 19:08:17 +00002323 if( offset<pCur->info.nLocal ){
drh2af926b2001-05-15 00:39:25 +00002324 int a = amt;
drhfa1a98a2004-05-14 19:08:17 +00002325 if( a+offset>pCur->info.nLocal ){
2326 a = pCur->info.nLocal - offset;
drh2af926b2001-05-15 00:39:25 +00002327 }
drha34b6762004-05-07 13:30:42 +00002328 memcpy(pBuf, &aPayload[offset], a);
drh2af926b2001-05-15 00:39:25 +00002329 if( a==amt ){
2330 return SQLITE_OK;
2331 }
drh2aa679f2001-06-25 02:11:07 +00002332 offset = 0;
drha34b6762004-05-07 13:30:42 +00002333 pBuf += a;
drh2af926b2001-05-15 00:39:25 +00002334 amt -= a;
drhdd793422001-06-28 01:54:48 +00002335 }else{
drhfa1a98a2004-05-14 19:08:17 +00002336 offset -= pCur->info.nLocal;
drhbd03cae2001-06-02 02:40:57 +00002337 }
danielk1977cfe9a692004-06-16 12:00:29 +00002338 ovflSize = pBt->usableSize - 4;
drhbd03cae2001-06-02 02:40:57 +00002339 if( amt>0 ){
drhfa1a98a2004-05-14 19:08:17 +00002340 nextPage = get4byte(&aPayload[pCur->info.nLocal]);
danielk1977cfe9a692004-06-16 12:00:29 +00002341 while( amt>0 && nextPage ){
2342 rc = sqlite3pager_get(pBt->pPager, nextPage, (void**)&aPayload);
2343 if( rc!=0 ){
2344 return rc;
drh2af926b2001-05-15 00:39:25 +00002345 }
danielk1977cfe9a692004-06-16 12:00:29 +00002346 nextPage = get4byte(aPayload);
2347 if( offset<ovflSize ){
2348 int a = amt;
2349 if( a + offset > ovflSize ){
2350 a = ovflSize - offset;
2351 }
2352 memcpy(pBuf, &aPayload[offset+4], a);
2353 offset = 0;
2354 amt -= a;
2355 pBuf += a;
2356 }else{
2357 offset -= ovflSize;
2358 }
2359 sqlite3pager_unref(aPayload);
drh2af926b2001-05-15 00:39:25 +00002360 }
drh2af926b2001-05-15 00:39:25 +00002361 }
danielk1977cfe9a692004-06-16 12:00:29 +00002362
drha7fcb052001-12-14 15:09:55 +00002363 if( amt>0 ){
drhee696e22004-08-30 16:52:17 +00002364 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
drha7fcb052001-12-14 15:09:55 +00002365 }
2366 return SQLITE_OK;
drh2af926b2001-05-15 00:39:25 +00002367}
2368
drh72f82862001-05-24 21:06:34 +00002369/*
drh3aac2dd2004-04-26 14:10:20 +00002370** Read part of the key associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00002371** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00002372** begins at "offset".
drh8c1238a2003-01-02 14:43:55 +00002373**
drh3aac2dd2004-04-26 14:10:20 +00002374** Return SQLITE_OK on success or an error code if anything goes
2375** wrong. An error is returned if "offset+amt" is larger than
2376** the available payload.
drh72f82862001-05-24 21:06:34 +00002377*/
drha34b6762004-05-07 13:30:42 +00002378int sqlite3BtreeKey(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
danielk197728129562005-01-11 10:25:06 +00002379 assert( pCur->isValid );
drhc39e0002004-05-07 23:50:57 +00002380 assert( pCur->pPage!=0 );
2381 assert( pCur->pPage->intKey==0 );
2382 assert( pCur->idx>=0 && pCur->idx<pCur->pPage->nCell );
drh3aac2dd2004-04-26 14:10:20 +00002383 return getPayload(pCur, offset, amt, (unsigned char*)pBuf, 0);
2384}
2385
2386/*
drh3aac2dd2004-04-26 14:10:20 +00002387** Read part of the data associated with cursor pCur. Exactly
drha34b6762004-05-07 13:30:42 +00002388** "amt" bytes will be transfered into pBuf[]. The transfer
drh3aac2dd2004-04-26 14:10:20 +00002389** begins at "offset".
2390**
2391** Return SQLITE_OK on success or an error code if anything goes
2392** wrong. An error is returned if "offset+amt" is larger than
2393** the available payload.
drh72f82862001-05-24 21:06:34 +00002394*/
drh3aac2dd2004-04-26 14:10:20 +00002395int sqlite3BtreeData(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
danielk197728129562005-01-11 10:25:06 +00002396 assert( pCur->isValid );
drh8c1238a2003-01-02 14:43:55 +00002397 assert( pCur->pPage!=0 );
drhc39e0002004-05-07 23:50:57 +00002398 assert( pCur->idx>=0 && pCur->idx<pCur->pPage->nCell );
drh3aac2dd2004-04-26 14:10:20 +00002399 return getPayload(pCur, offset, amt, pBuf, 1);
drh2af926b2001-05-15 00:39:25 +00002400}
2401
drh72f82862001-05-24 21:06:34 +00002402/*
drh0e1c19e2004-05-11 00:58:56 +00002403** Return a pointer to payload information from the entry that the
2404** pCur cursor is pointing to. The pointer is to the beginning of
2405** the key if skipKey==0 and it points to the beginning of data if
drhe51c44f2004-05-30 20:46:09 +00002406** skipKey==1. The number of bytes of available key/data is written
2407** into *pAmt. If *pAmt==0, then the value returned will not be
2408** a valid pointer.
drh0e1c19e2004-05-11 00:58:56 +00002409**
2410** This routine is an optimization. It is common for the entire key
2411** and data to fit on the local page and for there to be no overflow
2412** pages. When that is so, this routine can be used to access the
2413** key and data without making a copy. If the key and/or data spills
2414** onto overflow pages, then getPayload() must be used to reassembly
2415** the key/data and copy it into a preallocated buffer.
2416**
2417** The pointer returned by this routine looks directly into the cached
2418** page of the database. The data might change or move the next time
2419** any btree routine is called.
2420*/
2421static const unsigned char *fetchPayload(
2422 BtCursor *pCur, /* Cursor pointing to entry to read from */
drhe51c44f2004-05-30 20:46:09 +00002423 int *pAmt, /* Write the number of available bytes here */
drh0e1c19e2004-05-11 00:58:56 +00002424 int skipKey /* read beginning at data if this is true */
2425){
2426 unsigned char *aPayload;
2427 MemPage *pPage;
2428 Btree *pBt;
drhfa1a98a2004-05-14 19:08:17 +00002429 u32 nKey;
2430 int nLocal;
drh0e1c19e2004-05-11 00:58:56 +00002431
2432 assert( pCur!=0 && pCur->pPage!=0 );
2433 assert( pCur->isValid );
2434 pBt = pCur->pBt;
2435 pPage = pCur->pPage;
2436 pageIntegrity(pPage);
2437 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
drh9188b382004-05-14 21:12:22 +00002438 getCellInfo(pCur);
drh43605152004-05-29 21:46:49 +00002439 aPayload = pCur->info.pCell;
drhfa1a98a2004-05-14 19:08:17 +00002440 aPayload += pCur->info.nHeader;
drh0e1c19e2004-05-11 00:58:56 +00002441 if( pPage->intKey ){
drhfa1a98a2004-05-14 19:08:17 +00002442 nKey = 0;
2443 }else{
2444 nKey = pCur->info.nKey;
drh0e1c19e2004-05-11 00:58:56 +00002445 }
drh0e1c19e2004-05-11 00:58:56 +00002446 if( skipKey ){
drhfa1a98a2004-05-14 19:08:17 +00002447 aPayload += nKey;
2448 nLocal = pCur->info.nLocal - nKey;
drh0e1c19e2004-05-11 00:58:56 +00002449 }else{
drhfa1a98a2004-05-14 19:08:17 +00002450 nLocal = pCur->info.nLocal;
drhe51c44f2004-05-30 20:46:09 +00002451 if( nLocal>nKey ){
2452 nLocal = nKey;
2453 }
drh0e1c19e2004-05-11 00:58:56 +00002454 }
drhe51c44f2004-05-30 20:46:09 +00002455 *pAmt = nLocal;
drh0e1c19e2004-05-11 00:58:56 +00002456 return aPayload;
2457}
2458
2459
2460/*
drhe51c44f2004-05-30 20:46:09 +00002461** For the entry that cursor pCur is point to, return as
2462** many bytes of the key or data as are available on the local
2463** b-tree page. Write the number of available bytes into *pAmt.
drh0e1c19e2004-05-11 00:58:56 +00002464**
2465** The pointer returned is ephemeral. The key/data may move
2466** or be destroyed on the next call to any Btree routine.
2467**
2468** These routines is used to get quick access to key and data
2469** in the common case where no overflow pages are used.
drh0e1c19e2004-05-11 00:58:56 +00002470*/
drhe51c44f2004-05-30 20:46:09 +00002471const void *sqlite3BtreeKeyFetch(BtCursor *pCur, int *pAmt){
2472 return (const void*)fetchPayload(pCur, pAmt, 0);
drh0e1c19e2004-05-11 00:58:56 +00002473}
drhe51c44f2004-05-30 20:46:09 +00002474const void *sqlite3BtreeDataFetch(BtCursor *pCur, int *pAmt){
2475 return (const void*)fetchPayload(pCur, pAmt, 1);
drh0e1c19e2004-05-11 00:58:56 +00002476}
2477
2478
2479/*
drh8178a752003-01-05 21:41:40 +00002480** Move the cursor down to a new child page. The newPgno argument is the
drhab01f612004-05-22 02:55:23 +00002481** page number of the child page to move to.
drh72f82862001-05-24 21:06:34 +00002482*/
drh3aac2dd2004-04-26 14:10:20 +00002483static int moveToChild(BtCursor *pCur, u32 newPgno){
drh72f82862001-05-24 21:06:34 +00002484 int rc;
2485 MemPage *pNewPage;
drh3aac2dd2004-04-26 14:10:20 +00002486 MemPage *pOldPage;
drh0d316a42002-08-11 20:10:47 +00002487 Btree *pBt = pCur->pBt;
drh72f82862001-05-24 21:06:34 +00002488
drhc39e0002004-05-07 23:50:57 +00002489 assert( pCur->isValid );
drhde647132004-05-07 17:57:49 +00002490 rc = getAndInitPage(pBt, newPgno, &pNewPage, pCur->pPage);
drh6019e162001-07-02 17:51:45 +00002491 if( rc ) return rc;
drhda200cc2004-05-09 11:51:38 +00002492 pageIntegrity(pNewPage);
drh428ae8c2003-01-04 16:48:09 +00002493 pNewPage->idxParent = pCur->idx;
drh3aac2dd2004-04-26 14:10:20 +00002494 pOldPage = pCur->pPage;
2495 pOldPage->idxShift = 0;
2496 releasePage(pOldPage);
drh72f82862001-05-24 21:06:34 +00002497 pCur->pPage = pNewPage;
2498 pCur->idx = 0;
drh271efa52004-05-30 19:19:05 +00002499 pCur->info.nSize = 0;
drh4be295b2003-12-16 03:44:47 +00002500 if( pNewPage->nCell<1 ){
drhee696e22004-08-30 16:52:17 +00002501 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
drh4be295b2003-12-16 03:44:47 +00002502 }
drh72f82862001-05-24 21:06:34 +00002503 return SQLITE_OK;
2504}
2505
2506/*
drh8856d6a2004-04-29 14:42:46 +00002507** Return true if the page is the virtual root of its table.
2508**
2509** The virtual root page is the root page for most tables. But
2510** for the table rooted on page 1, sometime the real root page
2511** is empty except for the right-pointer. In such cases the
2512** virtual root page is the page that the right-pointer of page
2513** 1 is pointing to.
2514*/
2515static int isRootPage(MemPage *pPage){
2516 MemPage *pParent = pPage->pParent;
drhda200cc2004-05-09 11:51:38 +00002517 if( pParent==0 ) return 1;
2518 if( pParent->pgno>1 ) return 0;
2519 if( get2byte(&pParent->aData[pParent->hdrOffset+3])==0 ) return 1;
drh8856d6a2004-04-29 14:42:46 +00002520 return 0;
2521}
2522
2523/*
drh5e2f8b92001-05-28 00:41:15 +00002524** Move the cursor up to the parent page.
2525**
2526** pCur->idx is set to the cell index that contains the pointer
2527** to the page we are coming from. If we are coming from the
2528** right-most child page then pCur->idx is set to one more than
drhbd03cae2001-06-02 02:40:57 +00002529** the largest cell index.
drh72f82862001-05-24 21:06:34 +00002530*/
drh8178a752003-01-05 21:41:40 +00002531static void moveToParent(BtCursor *pCur){
drh72f82862001-05-24 21:06:34 +00002532 Pgno oldPgno;
2533 MemPage *pParent;
drh8178a752003-01-05 21:41:40 +00002534 MemPage *pPage;
drh428ae8c2003-01-04 16:48:09 +00002535 int idxParent;
drh3aac2dd2004-04-26 14:10:20 +00002536
drhc39e0002004-05-07 23:50:57 +00002537 assert( pCur->isValid );
drh8178a752003-01-05 21:41:40 +00002538 pPage = pCur->pPage;
2539 assert( pPage!=0 );
drh8856d6a2004-04-29 14:42:46 +00002540 assert( !isRootPage(pPage) );
drhda200cc2004-05-09 11:51:38 +00002541 pageIntegrity(pPage);
drh8178a752003-01-05 21:41:40 +00002542 pParent = pPage->pParent;
2543 assert( pParent!=0 );
drhda200cc2004-05-09 11:51:38 +00002544 pageIntegrity(pParent);
drh8178a752003-01-05 21:41:40 +00002545 idxParent = pPage->idxParent;
drha34b6762004-05-07 13:30:42 +00002546 sqlite3pager_ref(pParent->aData);
drh3aac2dd2004-04-26 14:10:20 +00002547 oldPgno = pPage->pgno;
2548 releasePage(pPage);
drh72f82862001-05-24 21:06:34 +00002549 pCur->pPage = pParent;
drh271efa52004-05-30 19:19:05 +00002550 pCur->info.nSize = 0;
drh428ae8c2003-01-04 16:48:09 +00002551 assert( pParent->idxShift==0 );
drh43605152004-05-29 21:46:49 +00002552 pCur->idx = idxParent;
drh72f82862001-05-24 21:06:34 +00002553}
2554
2555/*
2556** Move the cursor to the root page
2557*/
drh5e2f8b92001-05-28 00:41:15 +00002558static int moveToRoot(BtCursor *pCur){
drh3aac2dd2004-04-26 14:10:20 +00002559 MemPage *pRoot;
drhbd03cae2001-06-02 02:40:57 +00002560 int rc;
drh0d316a42002-08-11 20:10:47 +00002561 Btree *pBt = pCur->pBt;
drhbd03cae2001-06-02 02:40:57 +00002562
drhde647132004-05-07 17:57:49 +00002563 rc = getAndInitPage(pBt, pCur->pgnoRoot, &pRoot, 0);
drhc39e0002004-05-07 23:50:57 +00002564 if( rc ){
2565 pCur->isValid = 0;
2566 return rc;
2567 }
drh3aac2dd2004-04-26 14:10:20 +00002568 releasePage(pCur->pPage);
drhda200cc2004-05-09 11:51:38 +00002569 pageIntegrity(pRoot);
drh3aac2dd2004-04-26 14:10:20 +00002570 pCur->pPage = pRoot;
drh72f82862001-05-24 21:06:34 +00002571 pCur->idx = 0;
drh271efa52004-05-30 19:19:05 +00002572 pCur->info.nSize = 0;
drh8856d6a2004-04-29 14:42:46 +00002573 if( pRoot->nCell==0 && !pRoot->leaf ){
2574 Pgno subpage;
2575 assert( pRoot->pgno==1 );
drh43605152004-05-29 21:46:49 +00002576 subpage = get4byte(&pRoot->aData[pRoot->hdrOffset+8]);
drh8856d6a2004-04-29 14:42:46 +00002577 assert( subpage>0 );
drh3644f082004-05-10 18:45:09 +00002578 pCur->isValid = 1;
drh4b70f112004-05-02 21:12:19 +00002579 rc = moveToChild(pCur, subpage);
drh8856d6a2004-04-29 14:42:46 +00002580 }
drhc39e0002004-05-07 23:50:57 +00002581 pCur->isValid = pCur->pPage->nCell>0;
drh8856d6a2004-04-29 14:42:46 +00002582 return rc;
drh72f82862001-05-24 21:06:34 +00002583}
drh2af926b2001-05-15 00:39:25 +00002584
drh5e2f8b92001-05-28 00:41:15 +00002585/*
2586** Move the cursor down to the left-most leaf entry beneath the
2587** entry to which it is currently pointing.
2588*/
2589static int moveToLeftmost(BtCursor *pCur){
2590 Pgno pgno;
2591 int rc;
drh3aac2dd2004-04-26 14:10:20 +00002592 MemPage *pPage;
drh5e2f8b92001-05-28 00:41:15 +00002593
drhc39e0002004-05-07 23:50:57 +00002594 assert( pCur->isValid );
drh3aac2dd2004-04-26 14:10:20 +00002595 while( !(pPage = pCur->pPage)->leaf ){
drha34b6762004-05-07 13:30:42 +00002596 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
drh43605152004-05-29 21:46:49 +00002597 pgno = get4byte(findCell(pPage, pCur->idx));
drh8178a752003-01-05 21:41:40 +00002598 rc = moveToChild(pCur, pgno);
drh5e2f8b92001-05-28 00:41:15 +00002599 if( rc ) return rc;
2600 }
2601 return SQLITE_OK;
2602}
2603
drh2dcc9aa2002-12-04 13:40:25 +00002604/*
2605** Move the cursor down to the right-most leaf entry beneath the
2606** page to which it is currently pointing. Notice the difference
2607** between moveToLeftmost() and moveToRightmost(). moveToLeftmost()
2608** finds the left-most entry beneath the *entry* whereas moveToRightmost()
2609** finds the right-most entry beneath the *page*.
2610*/
2611static int moveToRightmost(BtCursor *pCur){
2612 Pgno pgno;
2613 int rc;
drh3aac2dd2004-04-26 14:10:20 +00002614 MemPage *pPage;
drh2dcc9aa2002-12-04 13:40:25 +00002615
drhc39e0002004-05-07 23:50:57 +00002616 assert( pCur->isValid );
drh3aac2dd2004-04-26 14:10:20 +00002617 while( !(pPage = pCur->pPage)->leaf ){
drh43605152004-05-29 21:46:49 +00002618 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh3aac2dd2004-04-26 14:10:20 +00002619 pCur->idx = pPage->nCell;
drh8178a752003-01-05 21:41:40 +00002620 rc = moveToChild(pCur, pgno);
drh2dcc9aa2002-12-04 13:40:25 +00002621 if( rc ) return rc;
2622 }
drh3aac2dd2004-04-26 14:10:20 +00002623 pCur->idx = pPage->nCell - 1;
drh271efa52004-05-30 19:19:05 +00002624 pCur->info.nSize = 0;
drh2dcc9aa2002-12-04 13:40:25 +00002625 return SQLITE_OK;
2626}
2627
drh5e00f6c2001-09-13 13:46:56 +00002628/* Move the cursor to the first entry in the table. Return SQLITE_OK
2629** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00002630** or set *pRes to 1 if the table is empty.
drh5e00f6c2001-09-13 13:46:56 +00002631*/
drh3aac2dd2004-04-26 14:10:20 +00002632int sqlite3BtreeFirst(BtCursor *pCur, int *pRes){
drh5e00f6c2001-09-13 13:46:56 +00002633 int rc;
2634 rc = moveToRoot(pCur);
2635 if( rc ) return rc;
drhc39e0002004-05-07 23:50:57 +00002636 if( pCur->isValid==0 ){
2637 assert( pCur->pPage->nCell==0 );
drh5e00f6c2001-09-13 13:46:56 +00002638 *pRes = 1;
2639 return SQLITE_OK;
2640 }
drhc39e0002004-05-07 23:50:57 +00002641 assert( pCur->pPage->nCell>0 );
drh5e00f6c2001-09-13 13:46:56 +00002642 *pRes = 0;
2643 rc = moveToLeftmost(pCur);
2644 return rc;
2645}
drh5e2f8b92001-05-28 00:41:15 +00002646
drh9562b552002-02-19 15:00:07 +00002647/* Move the cursor to the last entry in the table. Return SQLITE_OK
2648** on success. Set *pRes to 0 if the cursor actually points to something
drh77c679c2002-02-19 22:43:58 +00002649** or set *pRes to 1 if the table is empty.
drh9562b552002-02-19 15:00:07 +00002650*/
drh3aac2dd2004-04-26 14:10:20 +00002651int sqlite3BtreeLast(BtCursor *pCur, int *pRes){
drh9562b552002-02-19 15:00:07 +00002652 int rc;
drh9562b552002-02-19 15:00:07 +00002653 rc = moveToRoot(pCur);
2654 if( rc ) return rc;
drhc39e0002004-05-07 23:50:57 +00002655 if( pCur->isValid==0 ){
2656 assert( pCur->pPage->nCell==0 );
drh9562b552002-02-19 15:00:07 +00002657 *pRes = 1;
2658 return SQLITE_OK;
2659 }
drhc39e0002004-05-07 23:50:57 +00002660 assert( pCur->isValid );
drh9562b552002-02-19 15:00:07 +00002661 *pRes = 0;
drh2dcc9aa2002-12-04 13:40:25 +00002662 rc = moveToRightmost(pCur);
drh9562b552002-02-19 15:00:07 +00002663 return rc;
2664}
2665
drh3aac2dd2004-04-26 14:10:20 +00002666/* Move the cursor so that it points to an entry near pKey/nKey.
drh72f82862001-05-24 21:06:34 +00002667** Return a success code.
2668**
drh3aac2dd2004-04-26 14:10:20 +00002669** For INTKEY tables, only the nKey parameter is used. pKey is
2670** ignored. For other tables, nKey is the number of bytes of data
2671** in nKey. The comparison function specified when the cursor was
2672** created is used to compare keys.
2673**
drh5e2f8b92001-05-28 00:41:15 +00002674** If an exact match is not found, then the cursor is always
drhbd03cae2001-06-02 02:40:57 +00002675** left pointing at a leaf page which would hold the entry if it
drh5e2f8b92001-05-28 00:41:15 +00002676** were present. The cursor might point to an entry that comes
2677** before or after the key.
2678**
drhbd03cae2001-06-02 02:40:57 +00002679** The result of comparing the key with the entry to which the
drhab01f612004-05-22 02:55:23 +00002680** cursor is written to *pRes if pRes!=NULL. The meaning of
drhbd03cae2001-06-02 02:40:57 +00002681** this value is as follows:
2682**
2683** *pRes<0 The cursor is left pointing at an entry that
drh1a844c32002-12-04 22:29:28 +00002684** is smaller than pKey or if the table is empty
2685** and the cursor is therefore left point to nothing.
drhbd03cae2001-06-02 02:40:57 +00002686**
2687** *pRes==0 The cursor is left pointing at an entry that
2688** exactly matches pKey.
2689**
2690** *pRes>0 The cursor is left pointing at an entry that
drh7c717f72001-06-24 20:39:41 +00002691** is larger than pKey.
drha059ad02001-04-17 20:09:11 +00002692*/
drh4a1c3802004-05-12 15:15:47 +00002693int sqlite3BtreeMoveto(BtCursor *pCur, const void *pKey, i64 nKey, int *pRes){
drh72f82862001-05-24 21:06:34 +00002694 int rc;
drh5e2f8b92001-05-28 00:41:15 +00002695 rc = moveToRoot(pCur);
drh72f82862001-05-24 21:06:34 +00002696 if( rc ) return rc;
drhc39e0002004-05-07 23:50:57 +00002697 assert( pCur->pPage );
2698 assert( pCur->pPage->isInit );
2699 if( pCur->isValid==0 ){
drhf328bc82004-05-10 23:29:49 +00002700 *pRes = -1;
drhc39e0002004-05-07 23:50:57 +00002701 assert( pCur->pPage->nCell==0 );
2702 return SQLITE_OK;
2703 }
drh4eec4c12005-01-21 00:22:37 +00002704 for(;;){
drh72f82862001-05-24 21:06:34 +00002705 int lwr, upr;
2706 Pgno chldPg;
2707 MemPage *pPage = pCur->pPage;
drh1a844c32002-12-04 22:29:28 +00002708 int c = -1; /* pRes return if table is empty must be -1 */
drh72f82862001-05-24 21:06:34 +00002709 lwr = 0;
2710 upr = pPage->nCell-1;
drh4eec4c12005-01-21 00:22:37 +00002711 if( !pPage->intKey && pKey==0 ){
2712 return SQLITE_CORRUPT;
2713 }
drhda200cc2004-05-09 11:51:38 +00002714 pageIntegrity(pPage);
drh72f82862001-05-24 21:06:34 +00002715 while( lwr<=upr ){
danielk197713adf8a2004-06-03 16:08:41 +00002716 void *pCellKey;
drh4a1c3802004-05-12 15:15:47 +00002717 i64 nCellKey;
drh72f82862001-05-24 21:06:34 +00002718 pCur->idx = (lwr+upr)/2;
drh271efa52004-05-30 19:19:05 +00002719 pCur->info.nSize = 0;
drhde647132004-05-07 17:57:49 +00002720 sqlite3BtreeKeySize(pCur, &nCellKey);
drh3aac2dd2004-04-26 14:10:20 +00002721 if( pPage->intKey ){
2722 if( nCellKey<nKey ){
2723 c = -1;
2724 }else if( nCellKey>nKey ){
2725 c = +1;
2726 }else{
2727 c = 0;
2728 }
drh3aac2dd2004-04-26 14:10:20 +00002729 }else{
drhe51c44f2004-05-30 20:46:09 +00002730 int available;
danielk197713adf8a2004-06-03 16:08:41 +00002731 pCellKey = (void *)fetchPayload(pCur, &available, 0);
drhe51c44f2004-05-30 20:46:09 +00002732 if( available>=nCellKey ){
2733 c = pCur->xCompare(pCur->pArg, nCellKey, pCellKey, nKey, pKey);
2734 }else{
2735 pCellKey = sqliteMallocRaw( nCellKey );
2736 if( pCellKey==0 ) return SQLITE_NOMEM;
danielk197713adf8a2004-06-03 16:08:41 +00002737 rc = sqlite3BtreeKey(pCur, 0, nCellKey, (void *)pCellKey);
drhe51c44f2004-05-30 20:46:09 +00002738 c = pCur->xCompare(pCur->pArg, nCellKey, pCellKey, nKey, pKey);
2739 sqliteFree(pCellKey);
2740 if( rc ) return rc;
2741 }
drh3aac2dd2004-04-26 14:10:20 +00002742 }
drh72f82862001-05-24 21:06:34 +00002743 if( c==0 ){
drh8b18dd42004-05-12 19:18:15 +00002744 if( pPage->leafData && !pPage->leaf ){
drhfc70e6f2004-05-12 21:11:27 +00002745 lwr = pCur->idx;
2746 upr = lwr - 1;
drh8b18dd42004-05-12 19:18:15 +00002747 break;
2748 }else{
drh8b18dd42004-05-12 19:18:15 +00002749 if( pRes ) *pRes = 0;
2750 return SQLITE_OK;
2751 }
drh72f82862001-05-24 21:06:34 +00002752 }
2753 if( c<0 ){
2754 lwr = pCur->idx+1;
2755 }else{
2756 upr = pCur->idx-1;
2757 }
2758 }
2759 assert( lwr==upr+1 );
drh7aa128d2002-06-21 13:09:16 +00002760 assert( pPage->isInit );
drh3aac2dd2004-04-26 14:10:20 +00002761 if( pPage->leaf ){
drha34b6762004-05-07 13:30:42 +00002762 chldPg = 0;
drh3aac2dd2004-04-26 14:10:20 +00002763 }else if( lwr>=pPage->nCell ){
drh43605152004-05-29 21:46:49 +00002764 chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drh72f82862001-05-24 21:06:34 +00002765 }else{
drh43605152004-05-29 21:46:49 +00002766 chldPg = get4byte(findCell(pPage, lwr));
drh72f82862001-05-24 21:06:34 +00002767 }
2768 if( chldPg==0 ){
drhc39e0002004-05-07 23:50:57 +00002769 assert( pCur->idx>=0 && pCur->idx<pCur->pPage->nCell );
drh72f82862001-05-24 21:06:34 +00002770 if( pRes ) *pRes = c;
2771 return SQLITE_OK;
2772 }
drh428ae8c2003-01-04 16:48:09 +00002773 pCur->idx = lwr;
drh271efa52004-05-30 19:19:05 +00002774 pCur->info.nSize = 0;
drh8178a752003-01-05 21:41:40 +00002775 rc = moveToChild(pCur, chldPg);
drhc39e0002004-05-07 23:50:57 +00002776 if( rc ){
2777 return rc;
2778 }
drh72f82862001-05-24 21:06:34 +00002779 }
drhbd03cae2001-06-02 02:40:57 +00002780 /* NOT REACHED */
drh72f82862001-05-24 21:06:34 +00002781}
2782
2783/*
drhc39e0002004-05-07 23:50:57 +00002784** Return TRUE if the cursor is not pointing at an entry of the table.
2785**
2786** TRUE will be returned after a call to sqlite3BtreeNext() moves
2787** past the last entry in the table or sqlite3BtreePrev() moves past
2788** the first entry. TRUE is also returned if the table is empty.
2789*/
2790int sqlite3BtreeEof(BtCursor *pCur){
2791 return pCur->isValid==0;
2792}
2793
2794/*
drhbd03cae2001-06-02 02:40:57 +00002795** Advance the cursor to the next entry in the database. If
drh8c1238a2003-01-02 14:43:55 +00002796** successful then set *pRes=0. If the cursor
drhbd03cae2001-06-02 02:40:57 +00002797** was already pointing to the last entry in the database before
drh8c1238a2003-01-02 14:43:55 +00002798** this routine was called, then set *pRes=1.
drh72f82862001-05-24 21:06:34 +00002799*/
drh3aac2dd2004-04-26 14:10:20 +00002800int sqlite3BtreeNext(BtCursor *pCur, int *pRes){
drh72f82862001-05-24 21:06:34 +00002801 int rc;
drh8178a752003-01-05 21:41:40 +00002802 MemPage *pPage = pCur->pPage;
drh8b18dd42004-05-12 19:18:15 +00002803
drh8c1238a2003-01-02 14:43:55 +00002804 assert( pRes!=0 );
drhc39e0002004-05-07 23:50:57 +00002805 if( pCur->isValid==0 ){
drh8c1238a2003-01-02 14:43:55 +00002806 *pRes = 1;
drhc39e0002004-05-07 23:50:57 +00002807 return SQLITE_OK;
drhecdc7532001-09-23 02:35:53 +00002808 }
drh8178a752003-01-05 21:41:40 +00002809 assert( pPage->isInit );
drh8178a752003-01-05 21:41:40 +00002810 assert( pCur->idx<pPage->nCell );
danielk19776a43f9b2004-11-16 04:57:24 +00002811
drh72f82862001-05-24 21:06:34 +00002812 pCur->idx++;
drh271efa52004-05-30 19:19:05 +00002813 pCur->info.nSize = 0;
drh8178a752003-01-05 21:41:40 +00002814 if( pCur->idx>=pPage->nCell ){
drha34b6762004-05-07 13:30:42 +00002815 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00002816 rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
drh5e2f8b92001-05-28 00:41:15 +00002817 if( rc ) return rc;
2818 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00002819 *pRes = 0;
2820 return rc;
drh72f82862001-05-24 21:06:34 +00002821 }
drh5e2f8b92001-05-28 00:41:15 +00002822 do{
drh8856d6a2004-04-29 14:42:46 +00002823 if( isRootPage(pPage) ){
drh8c1238a2003-01-02 14:43:55 +00002824 *pRes = 1;
drhc39e0002004-05-07 23:50:57 +00002825 pCur->isValid = 0;
drh5e2f8b92001-05-28 00:41:15 +00002826 return SQLITE_OK;
2827 }
drh8178a752003-01-05 21:41:40 +00002828 moveToParent(pCur);
2829 pPage = pCur->pPage;
2830 }while( pCur->idx>=pPage->nCell );
drh8c1238a2003-01-02 14:43:55 +00002831 *pRes = 0;
drh8b18dd42004-05-12 19:18:15 +00002832 if( pPage->leafData ){
2833 rc = sqlite3BtreeNext(pCur, pRes);
2834 }else{
2835 rc = SQLITE_OK;
2836 }
2837 return rc;
drh8178a752003-01-05 21:41:40 +00002838 }
2839 *pRes = 0;
drh3aac2dd2004-04-26 14:10:20 +00002840 if( pPage->leaf ){
drh8178a752003-01-05 21:41:40 +00002841 return SQLITE_OK;
drh72f82862001-05-24 21:06:34 +00002842 }
drh5e2f8b92001-05-28 00:41:15 +00002843 rc = moveToLeftmost(pCur);
drh8c1238a2003-01-02 14:43:55 +00002844 return rc;
drh72f82862001-05-24 21:06:34 +00002845}
2846
drh3b7511c2001-05-26 13:15:44 +00002847/*
drh2dcc9aa2002-12-04 13:40:25 +00002848** Step the cursor to the back to the previous entry in the database. If
drh8178a752003-01-05 21:41:40 +00002849** successful then set *pRes=0. If the cursor
drh2dcc9aa2002-12-04 13:40:25 +00002850** was already pointing to the first entry in the database before
drh8178a752003-01-05 21:41:40 +00002851** this routine was called, then set *pRes=1.
drh2dcc9aa2002-12-04 13:40:25 +00002852*/
drh3aac2dd2004-04-26 14:10:20 +00002853int sqlite3BtreePrevious(BtCursor *pCur, int *pRes){
drh2dcc9aa2002-12-04 13:40:25 +00002854 int rc;
2855 Pgno pgno;
drh8178a752003-01-05 21:41:40 +00002856 MemPage *pPage;
drhc39e0002004-05-07 23:50:57 +00002857 if( pCur->isValid==0 ){
2858 *pRes = 1;
2859 return SQLITE_OK;
2860 }
danielk19776a43f9b2004-11-16 04:57:24 +00002861
drh8178a752003-01-05 21:41:40 +00002862 pPage = pCur->pPage;
drh8178a752003-01-05 21:41:40 +00002863 assert( pPage->isInit );
drh2dcc9aa2002-12-04 13:40:25 +00002864 assert( pCur->idx>=0 );
drha34b6762004-05-07 13:30:42 +00002865 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00002866 pgno = get4byte( findCell(pPage, pCur->idx) );
drh8178a752003-01-05 21:41:40 +00002867 rc = moveToChild(pCur, pgno);
drh2dcc9aa2002-12-04 13:40:25 +00002868 if( rc ) return rc;
2869 rc = moveToRightmost(pCur);
2870 }else{
2871 while( pCur->idx==0 ){
drh8856d6a2004-04-29 14:42:46 +00002872 if( isRootPage(pPage) ){
drhc39e0002004-05-07 23:50:57 +00002873 pCur->isValid = 0;
2874 *pRes = 1;
drh2dcc9aa2002-12-04 13:40:25 +00002875 return SQLITE_OK;
2876 }
drh8178a752003-01-05 21:41:40 +00002877 moveToParent(pCur);
2878 pPage = pCur->pPage;
drh2dcc9aa2002-12-04 13:40:25 +00002879 }
2880 pCur->idx--;
drh271efa52004-05-30 19:19:05 +00002881 pCur->info.nSize = 0;
drh8237d452004-11-22 19:07:09 +00002882 if( pPage->leafData && !pPage->leaf ){
drh8b18dd42004-05-12 19:18:15 +00002883 rc = sqlite3BtreePrevious(pCur, pRes);
2884 }else{
2885 rc = SQLITE_OK;
2886 }
drh2dcc9aa2002-12-04 13:40:25 +00002887 }
drh8178a752003-01-05 21:41:40 +00002888 *pRes = 0;
drh2dcc9aa2002-12-04 13:40:25 +00002889 return rc;
2890}
2891
2892/*
drh3b7511c2001-05-26 13:15:44 +00002893** Allocate a new page from the database file.
2894**
drha34b6762004-05-07 13:30:42 +00002895** The new page is marked as dirty. (In other words, sqlite3pager_write()
drh3b7511c2001-05-26 13:15:44 +00002896** has already been called on the new page.) The new page has also
2897** been referenced and the calling routine is responsible for calling
drha34b6762004-05-07 13:30:42 +00002898** sqlite3pager_unref() on the new page when it is done.
drh3b7511c2001-05-26 13:15:44 +00002899**
2900** SQLITE_OK is returned on success. Any other return value indicates
2901** an error. *ppPage and *pPgno are undefined in the event of an error.
drha34b6762004-05-07 13:30:42 +00002902** Do not invoke sqlite3pager_unref() on *ppPage if an error is returned.
drhbea00b92002-07-08 10:59:50 +00002903**
drh199e3cf2002-07-18 11:01:47 +00002904** If the "nearby" parameter is not 0, then a (feeble) effort is made to
2905** locate a page close to the page number "nearby". This can be used in an
drhbea00b92002-07-08 10:59:50 +00002906** attempt to keep related pages close to each other in the database file,
2907** which in turn can make database access faster.
danielk1977cb1a7eb2004-11-05 12:27:02 +00002908**
2909** If the "exact" parameter is not 0, and the page-number nearby exists
2910** anywhere on the free-list, then it is guarenteed to be returned. This
2911** is only used by auto-vacuum databases when allocating a new table.
drh3b7511c2001-05-26 13:15:44 +00002912*/
danielk1977cb1a7eb2004-11-05 12:27:02 +00002913static int allocatePage(
2914 Btree *pBt,
2915 MemPage **ppPage,
2916 Pgno *pPgno,
2917 Pgno nearby,
2918 u8 exact
2919){
drh3aac2dd2004-04-26 14:10:20 +00002920 MemPage *pPage1;
drh8c42ca92001-06-22 19:15:00 +00002921 int rc;
drh3aac2dd2004-04-26 14:10:20 +00002922 int n; /* Number of pages on the freelist */
2923 int k; /* Number of leaves on the trunk of the freelist */
drh30e58752002-03-02 20:41:57 +00002924
drh3aac2dd2004-04-26 14:10:20 +00002925 pPage1 = pBt->pPage1;
2926 n = get4byte(&pPage1->aData[36]);
2927 if( n>0 ){
drh91025292004-05-03 19:49:32 +00002928 /* There are pages on the freelist. Reuse one of those pages. */
danielk1977cb1a7eb2004-11-05 12:27:02 +00002929 MemPage *pTrunk = 0;
2930 Pgno iTrunk;
2931 MemPage *pPrevTrunk = 0;
2932 u8 searchList = 0; /* If the free-list must be searched for 'nearby' */
2933
2934 /* If the 'exact' parameter was true and a query of the pointer-map
2935 ** shows that the page 'nearby' is somewhere on the free-list, then
2936 ** the entire-list will be searched for that page.
2937 */
2938#ifndef SQLITE_OMIT_AUTOVACUUM
2939 if( exact ){
2940 u8 eType;
2941 assert( nearby>0 );
2942 assert( pBt->autoVacuum );
2943 rc = ptrmapGet(pBt, nearby, &eType, 0);
2944 if( rc ) return rc;
2945 if( eType==PTRMAP_FREEPAGE ){
2946 searchList = 1;
2947 }
2948 *pPgno = nearby;
2949 }
2950#endif
2951
2952 /* Decrement the free-list count by 1. Set iTrunk to the index of the
2953 ** first free-list trunk page. iPrevTrunk is initially 1.
2954 */
drha34b6762004-05-07 13:30:42 +00002955 rc = sqlite3pager_write(pPage1->aData);
drh3b7511c2001-05-26 13:15:44 +00002956 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00002957 put4byte(&pPage1->aData[36], n-1);
danielk1977cb1a7eb2004-11-05 12:27:02 +00002958
2959 /* The code within this loop is run only once if the 'searchList' variable
2960 ** is not true. Otherwise, it runs once for each trunk-page on the
2961 ** free-list until the page 'nearby' is located.
2962 */
2963 do {
2964 pPrevTrunk = pTrunk;
2965 if( pPrevTrunk ){
2966 iTrunk = get4byte(&pPrevTrunk->aData[0]);
drhbea00b92002-07-08 10:59:50 +00002967 }else{
danielk1977cb1a7eb2004-11-05 12:27:02 +00002968 iTrunk = get4byte(&pPage1->aData[32]);
drhbea00b92002-07-08 10:59:50 +00002969 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00002970 rc = getPage(pBt, iTrunk, &pTrunk);
2971 if( rc ){
2972 releasePage(pPrevTrunk);
2973 return rc;
2974 }
2975
2976 /* TODO: This should move to after the loop? */
2977 rc = sqlite3pager_write(pTrunk->aData);
2978 if( rc ){
2979 releasePage(pTrunk);
2980 releasePage(pPrevTrunk);
2981 return rc;
2982 }
2983
2984 k = get4byte(&pTrunk->aData[4]);
2985 if( k==0 && !searchList ){
2986 /* The trunk has no leaves and the list is not being searched.
2987 ** So extract the trunk page itself and use it as the newly
2988 ** allocated page */
2989 assert( pPrevTrunk==0 );
2990 *pPgno = iTrunk;
2991 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
2992 *ppPage = pTrunk;
2993 pTrunk = 0;
2994 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
2995 }else if( k>pBt->usableSize/4 - 8 ){
2996 /* Value of k is out of range. Database corruption */
drhee696e22004-08-30 16:52:17 +00002997 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
danielk1977cb1a7eb2004-11-05 12:27:02 +00002998#ifndef SQLITE_OMIT_AUTOVACUUM
2999 }else if( searchList && nearby==iTrunk ){
3000 /* The list is being searched and this trunk page is the page
3001 ** to allocate, regardless of whether it has leaves.
3002 */
3003 assert( *pPgno==iTrunk );
3004 *ppPage = pTrunk;
3005 searchList = 0;
3006 if( k==0 ){
3007 if( !pPrevTrunk ){
3008 memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
3009 }else{
3010 memcpy(&pPrevTrunk->aData[0], &pTrunk->aData[0], 4);
3011 }
3012 }else{
3013 /* The trunk page is required by the caller but it contains
3014 ** pointers to free-list leaves. The first leaf becomes a trunk
3015 ** page in this case.
3016 */
3017 MemPage *pNewTrunk;
3018 Pgno iNewTrunk = get4byte(&pTrunk->aData[8]);
3019 rc = getPage(pBt, iNewTrunk, &pNewTrunk);
3020 if( rc!=SQLITE_OK ){
3021 releasePage(pTrunk);
3022 releasePage(pPrevTrunk);
3023 return rc;
3024 }
3025 rc = sqlite3pager_write(pNewTrunk->aData);
3026 if( rc!=SQLITE_OK ){
3027 releasePage(pNewTrunk);
3028 releasePage(pTrunk);
3029 releasePage(pPrevTrunk);
3030 return rc;
3031 }
3032 memcpy(&pNewTrunk->aData[0], &pTrunk->aData[0], 4);
3033 put4byte(&pNewTrunk->aData[4], k-1);
3034 memcpy(&pNewTrunk->aData[8], &pTrunk->aData[12], (k-1)*4);
3035 if( !pPrevTrunk ){
3036 put4byte(&pPage1->aData[32], iNewTrunk);
3037 }else{
3038 put4byte(&pPrevTrunk->aData[0], iNewTrunk);
3039 }
3040 releasePage(pNewTrunk);
3041 }
3042 pTrunk = 0;
3043 TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
3044#endif
3045 }else{
3046 /* Extract a leaf from the trunk */
3047 int closest;
3048 Pgno iPage;
3049 unsigned char *aData = pTrunk->aData;
3050 if( nearby>0 ){
3051 int i, dist;
3052 closest = 0;
3053 dist = get4byte(&aData[8]) - nearby;
3054 if( dist<0 ) dist = -dist;
3055 for(i=1; i<k; i++){
3056 int d2 = get4byte(&aData[8+i*4]) - nearby;
3057 if( d2<0 ) d2 = -d2;
3058 if( d2<dist ){
3059 closest = i;
3060 dist = d2;
3061 }
3062 }
3063 }else{
3064 closest = 0;
3065 }
3066
3067 iPage = get4byte(&aData[8+closest*4]);
3068 if( !searchList || iPage==nearby ){
3069 *pPgno = iPage;
3070 if( *pPgno>sqlite3pager_pagecount(pBt->pPager) ){
3071 /* Free page off the end of the file */
3072 return SQLITE_CORRUPT; /* bkpt-CORRUPT */
3073 }
3074 TRACE(("ALLOCATE: %d was leaf %d of %d on trunk %d"
3075 ": %d more free pages\n",
3076 *pPgno, closest+1, k, pTrunk->pgno, n-1));
3077 if( closest<k-1 ){
3078 memcpy(&aData[8+closest*4], &aData[4+k*4], 4);
3079 }
3080 put4byte(&aData[4], k-1);
3081 rc = getPage(pBt, *pPgno, ppPage);
3082 if( rc==SQLITE_OK ){
3083 sqlite3pager_dont_rollback((*ppPage)->aData);
3084 rc = sqlite3pager_write((*ppPage)->aData);
danielk1977aac0a382005-01-16 11:07:06 +00003085 if( rc!=SQLITE_OK ){
3086 releasePage(*ppPage);
3087 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00003088 }
3089 searchList = 0;
3090 }
drhee696e22004-08-30 16:52:17 +00003091 }
danielk1977cb1a7eb2004-11-05 12:27:02 +00003092 releasePage(pPrevTrunk);
3093 }while( searchList );
3094 releasePage(pTrunk);
drh3b7511c2001-05-26 13:15:44 +00003095 }else{
drh3aac2dd2004-04-26 14:10:20 +00003096 /* There are no pages on the freelist, so create a new page at the
3097 ** end of the file */
drha34b6762004-05-07 13:30:42 +00003098 *pPgno = sqlite3pager_pagecount(pBt->pPager) + 1;
danielk1977afcdd022004-10-31 16:25:42 +00003099
3100#ifndef SQLITE_OMIT_AUTOVACUUM
drh42cac6d2004-11-20 20:31:11 +00003101 if( pBt->autoVacuum && PTRMAP_ISPAGE(pBt->usableSize, *pPgno) ){
danielk1977afcdd022004-10-31 16:25:42 +00003102 /* If *pPgno refers to a pointer-map page, allocate two new pages
3103 ** at the end of the file instead of one. The first allocated page
3104 ** becomes a new pointer-map page, the second is used by the caller.
3105 */
3106 TRACE(("ALLOCATE: %d from end of file (pointer-map page)\n", *pPgno));
danielk1977599fcba2004-11-08 07:13:13 +00003107 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
danielk1977afcdd022004-10-31 16:25:42 +00003108 (*pPgno)++;
3109 }
3110#endif
3111
danielk1977599fcba2004-11-08 07:13:13 +00003112 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drh3aac2dd2004-04-26 14:10:20 +00003113 rc = getPage(pBt, *pPgno, ppPage);
drh3b7511c2001-05-26 13:15:44 +00003114 if( rc ) return rc;
drha34b6762004-05-07 13:30:42 +00003115 rc = sqlite3pager_write((*ppPage)->aData);
danielk1977aac0a382005-01-16 11:07:06 +00003116 if( rc!=SQLITE_OK ){
3117 releasePage(*ppPage);
3118 }
drh3a4c1412004-05-09 20:40:11 +00003119 TRACE(("ALLOCATE: %d from end of file\n", *pPgno));
drh3b7511c2001-05-26 13:15:44 +00003120 }
danielk1977599fcba2004-11-08 07:13:13 +00003121
3122 assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
drh3b7511c2001-05-26 13:15:44 +00003123 return rc;
3124}
3125
3126/*
drh3aac2dd2004-04-26 14:10:20 +00003127** Add a page of the database file to the freelist.
drh5e2f8b92001-05-28 00:41:15 +00003128**
drha34b6762004-05-07 13:30:42 +00003129** sqlite3pager_unref() is NOT called for pPage.
drh3b7511c2001-05-26 13:15:44 +00003130*/
drh3aac2dd2004-04-26 14:10:20 +00003131static int freePage(MemPage *pPage){
3132 Btree *pBt = pPage->pBt;
3133 MemPage *pPage1 = pBt->pPage1;
3134 int rc, n, k;
drh8b2f49b2001-06-08 00:21:52 +00003135
drh3aac2dd2004-04-26 14:10:20 +00003136 /* Prepare the page for freeing */
3137 assert( pPage->pgno>1 );
3138 pPage->isInit = 0;
3139 releasePage(pPage->pParent);
3140 pPage->pParent = 0;
3141
drha34b6762004-05-07 13:30:42 +00003142 /* Increment the free page count on pPage1 */
3143 rc = sqlite3pager_write(pPage1->aData);
drh3aac2dd2004-04-26 14:10:20 +00003144 if( rc ) return rc;
3145 n = get4byte(&pPage1->aData[36]);
3146 put4byte(&pPage1->aData[36], n+1);
3147
danielk1977687566d2004-11-02 12:56:41 +00003148#ifndef SQLITE_OMIT_AUTOVACUUM
3149 /* If the database supports auto-vacuum, write an entry in the pointer-map
danielk1977cb1a7eb2004-11-05 12:27:02 +00003150 ** to indicate that the page is free.
danielk1977687566d2004-11-02 12:56:41 +00003151 */
3152 if( pBt->autoVacuum ){
3153 rc = ptrmapPut(pBt, pPage->pgno, PTRMAP_FREEPAGE, 0);
danielk1977a64a0352004-11-05 01:45:13 +00003154 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00003155 }
3156#endif
3157
drh3aac2dd2004-04-26 14:10:20 +00003158 if( n==0 ){
3159 /* This is the first free page */
drhda200cc2004-05-09 11:51:38 +00003160 rc = sqlite3pager_write(pPage->aData);
3161 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00003162 memset(pPage->aData, 0, 8);
drha34b6762004-05-07 13:30:42 +00003163 put4byte(&pPage1->aData[32], pPage->pgno);
drh3a4c1412004-05-09 20:40:11 +00003164 TRACE(("FREE-PAGE: %d first\n", pPage->pgno));
drh3aac2dd2004-04-26 14:10:20 +00003165 }else{
3166 /* Other free pages already exist. Retrive the first trunk page
3167 ** of the freelist and find out how many leaves it has. */
drha34b6762004-05-07 13:30:42 +00003168 MemPage *pTrunk;
3169 rc = getPage(pBt, get4byte(&pPage1->aData[32]), &pTrunk);
drh3b7511c2001-05-26 13:15:44 +00003170 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00003171 k = get4byte(&pTrunk->aData[4]);
drhee696e22004-08-30 16:52:17 +00003172 if( k>=pBt->usableSize/4 - 8 ){
drh3aac2dd2004-04-26 14:10:20 +00003173 /* The trunk is full. Turn the page being freed into a new
3174 ** trunk page with no leaves. */
drha34b6762004-05-07 13:30:42 +00003175 rc = sqlite3pager_write(pPage->aData);
drh3aac2dd2004-04-26 14:10:20 +00003176 if( rc ) return rc;
3177 put4byte(pPage->aData, pTrunk->pgno);
3178 put4byte(&pPage->aData[4], 0);
3179 put4byte(&pPage1->aData[32], pPage->pgno);
drh3a4c1412004-05-09 20:40:11 +00003180 TRACE(("FREE-PAGE: %d new trunk page replacing %d\n",
3181 pPage->pgno, pTrunk->pgno));
drh3aac2dd2004-04-26 14:10:20 +00003182 }else{
3183 /* Add the newly freed page as a leaf on the current trunk */
drha34b6762004-05-07 13:30:42 +00003184 rc = sqlite3pager_write(pTrunk->aData);
drh3aac2dd2004-04-26 14:10:20 +00003185 if( rc ) return rc;
3186 put4byte(&pTrunk->aData[4], k+1);
3187 put4byte(&pTrunk->aData[8+k*4], pPage->pgno);
drha34b6762004-05-07 13:30:42 +00003188 sqlite3pager_dont_write(pBt->pPager, pPage->pgno);
drh3a4c1412004-05-09 20:40:11 +00003189 TRACE(("FREE-PAGE: %d leaf on trunk page %d\n",pPage->pgno,pTrunk->pgno));
drh3aac2dd2004-04-26 14:10:20 +00003190 }
3191 releasePage(pTrunk);
drh3b7511c2001-05-26 13:15:44 +00003192 }
drh3b7511c2001-05-26 13:15:44 +00003193 return rc;
3194}
3195
3196/*
drh3aac2dd2004-04-26 14:10:20 +00003197** Free any overflow pages associated with the given Cell.
drh3b7511c2001-05-26 13:15:44 +00003198*/
drh3aac2dd2004-04-26 14:10:20 +00003199static int clearCell(MemPage *pPage, unsigned char *pCell){
3200 Btree *pBt = pPage->pBt;
drh6f11bef2004-05-13 01:12:56 +00003201 CellInfo info;
drh3aac2dd2004-04-26 14:10:20 +00003202 Pgno ovflPgno;
drh6f11bef2004-05-13 01:12:56 +00003203 int rc;
drh3b7511c2001-05-26 13:15:44 +00003204
drh43605152004-05-29 21:46:49 +00003205 parseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00003206 if( info.iOverflow==0 ){
drha34b6762004-05-07 13:30:42 +00003207 return SQLITE_OK; /* No overflow pages. Return without doing anything */
drh3aac2dd2004-04-26 14:10:20 +00003208 }
drh6f11bef2004-05-13 01:12:56 +00003209 ovflPgno = get4byte(&pCell[info.iOverflow]);
drh3aac2dd2004-04-26 14:10:20 +00003210 while( ovflPgno!=0 ){
3211 MemPage *pOvfl;
danielk1977a1cb1832005-02-12 08:59:55 +00003212 if( ovflPgno>sqlite3pager_pagecount(pBt->pPager) ){
3213 return SQLITE_CORRUPT;
3214 }
drh3aac2dd2004-04-26 14:10:20 +00003215 rc = getPage(pBt, ovflPgno, &pOvfl);
drh3b7511c2001-05-26 13:15:44 +00003216 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00003217 ovflPgno = get4byte(pOvfl->aData);
drha34b6762004-05-07 13:30:42 +00003218 rc = freePage(pOvfl);
drhbd03cae2001-06-02 02:40:57 +00003219 if( rc ) return rc;
drha34b6762004-05-07 13:30:42 +00003220 sqlite3pager_unref(pOvfl->aData);
drh3b7511c2001-05-26 13:15:44 +00003221 }
drh5e2f8b92001-05-28 00:41:15 +00003222 return SQLITE_OK;
drh3b7511c2001-05-26 13:15:44 +00003223}
3224
3225/*
drh91025292004-05-03 19:49:32 +00003226** Create the byte sequence used to represent a cell on page pPage
3227** and write that byte sequence into pCell[]. Overflow pages are
3228** allocated and filled in as necessary. The calling procedure
3229** is responsible for making sure sufficient space has been allocated
3230** for pCell[].
3231**
3232** Note that pCell does not necessary need to point to the pPage->aData
3233** area. pCell might point to some temporary storage. The cell will
3234** be constructed in this temporary area then copied into pPage->aData
3235** later.
drh3b7511c2001-05-26 13:15:44 +00003236*/
3237static int fillInCell(
drh3aac2dd2004-04-26 14:10:20 +00003238 MemPage *pPage, /* The page that contains the cell */
drh4b70f112004-05-02 21:12:19 +00003239 unsigned char *pCell, /* Complete text of the cell */
drh4a1c3802004-05-12 15:15:47 +00003240 const void *pKey, i64 nKey, /* The key */
drh4b70f112004-05-02 21:12:19 +00003241 const void *pData,int nData, /* The data */
3242 int *pnSize /* Write cell size here */
drh3b7511c2001-05-26 13:15:44 +00003243){
drh3b7511c2001-05-26 13:15:44 +00003244 int nPayload;
drh8c6fa9b2004-05-26 00:01:53 +00003245 const u8 *pSrc;
drha34b6762004-05-07 13:30:42 +00003246 int nSrc, n, rc;
drh3aac2dd2004-04-26 14:10:20 +00003247 int spaceLeft;
3248 MemPage *pOvfl = 0;
drh9b171272004-05-08 02:03:22 +00003249 MemPage *pToRelease = 0;
drh3aac2dd2004-04-26 14:10:20 +00003250 unsigned char *pPrior;
3251 unsigned char *pPayload;
3252 Btree *pBt = pPage->pBt;
3253 Pgno pgnoOvfl = 0;
drh4b70f112004-05-02 21:12:19 +00003254 int nHeader;
drh6f11bef2004-05-13 01:12:56 +00003255 CellInfo info;
drh3b7511c2001-05-26 13:15:44 +00003256
drh91025292004-05-03 19:49:32 +00003257 /* Fill in the header. */
drh43605152004-05-29 21:46:49 +00003258 nHeader = 0;
drh91025292004-05-03 19:49:32 +00003259 if( !pPage->leaf ){
3260 nHeader += 4;
3261 }
drh8b18dd42004-05-12 19:18:15 +00003262 if( pPage->hasData ){
drh91025292004-05-03 19:49:32 +00003263 nHeader += putVarint(&pCell[nHeader], nData);
drh6f11bef2004-05-13 01:12:56 +00003264 }else{
drh91025292004-05-03 19:49:32 +00003265 nData = 0;
3266 }
drh6f11bef2004-05-13 01:12:56 +00003267 nHeader += putVarint(&pCell[nHeader], *(u64*)&nKey);
drh43605152004-05-29 21:46:49 +00003268 parseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00003269 assert( info.nHeader==nHeader );
3270 assert( info.nKey==nKey );
3271 assert( info.nData==nData );
3272
3273 /* Fill in the payload */
drh3aac2dd2004-04-26 14:10:20 +00003274 nPayload = nData;
3275 if( pPage->intKey ){
3276 pSrc = pData;
3277 nSrc = nData;
drh91025292004-05-03 19:49:32 +00003278 nData = 0;
drh3aac2dd2004-04-26 14:10:20 +00003279 }else{
3280 nPayload += nKey;
3281 pSrc = pKey;
3282 nSrc = nKey;
3283 }
drh6f11bef2004-05-13 01:12:56 +00003284 *pnSize = info.nSize;
3285 spaceLeft = info.nLocal;
drh3aac2dd2004-04-26 14:10:20 +00003286 pPayload = &pCell[nHeader];
drh6f11bef2004-05-13 01:12:56 +00003287 pPrior = &pCell[info.iOverflow];
drh3b7511c2001-05-26 13:15:44 +00003288
drh3b7511c2001-05-26 13:15:44 +00003289 while( nPayload>0 ){
3290 if( spaceLeft==0 ){
danielk1977afcdd022004-10-31 16:25:42 +00003291#ifndef SQLITE_OMIT_AUTOVACUUM
3292 Pgno pgnoPtrmap = pgnoOvfl; /* Overflow page pointer-map entry page */
3293#endif
danielk1977cb1a7eb2004-11-05 12:27:02 +00003294 rc = allocatePage(pBt, &pOvfl, &pgnoOvfl, pgnoOvfl, 0);
danielk1977afcdd022004-10-31 16:25:42 +00003295#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977a19df672004-11-03 11:37:07 +00003296 /* If the database supports auto-vacuum, and the second or subsequent
3297 ** overflow page is being allocated, add an entry to the pointer-map
3298 ** for that page now. The entry for the first overflow page will be
3299 ** added later, by the insertCell() routine.
danielk1977afcdd022004-10-31 16:25:42 +00003300 */
danielk1977a19df672004-11-03 11:37:07 +00003301 if( pBt->autoVacuum && pgnoPtrmap!=0 && rc==SQLITE_OK ){
3302 rc = ptrmapPut(pBt, pgnoOvfl, PTRMAP_OVERFLOW2, pgnoPtrmap);
danielk1977afcdd022004-10-31 16:25:42 +00003303 }
3304#endif
drh3b7511c2001-05-26 13:15:44 +00003305 if( rc ){
drh9b171272004-05-08 02:03:22 +00003306 releasePage(pToRelease);
danielk197728129562005-01-11 10:25:06 +00003307 /* clearCell(pPage, pCell); */
drh3b7511c2001-05-26 13:15:44 +00003308 return rc;
3309 }
drh3aac2dd2004-04-26 14:10:20 +00003310 put4byte(pPrior, pgnoOvfl);
drh9b171272004-05-08 02:03:22 +00003311 releasePage(pToRelease);
3312 pToRelease = pOvfl;
drh3aac2dd2004-04-26 14:10:20 +00003313 pPrior = pOvfl->aData;
3314 put4byte(pPrior, 0);
3315 pPayload = &pOvfl->aData[4];
drhb6f41482004-05-14 01:58:11 +00003316 spaceLeft = pBt->usableSize - 4;
drh3b7511c2001-05-26 13:15:44 +00003317 }
3318 n = nPayload;
3319 if( n>spaceLeft ) n = spaceLeft;
drh3aac2dd2004-04-26 14:10:20 +00003320 if( n>nSrc ) n = nSrc;
3321 memcpy(pPayload, pSrc, n);
drh3b7511c2001-05-26 13:15:44 +00003322 nPayload -= n;
drhde647132004-05-07 17:57:49 +00003323 pPayload += n;
drh9b171272004-05-08 02:03:22 +00003324 pSrc += n;
drh3aac2dd2004-04-26 14:10:20 +00003325 nSrc -= n;
drh3b7511c2001-05-26 13:15:44 +00003326 spaceLeft -= n;
drh3aac2dd2004-04-26 14:10:20 +00003327 if( nSrc==0 ){
3328 nSrc = nData;
3329 pSrc = pData;
3330 }
drhdd793422001-06-28 01:54:48 +00003331 }
drh9b171272004-05-08 02:03:22 +00003332 releasePage(pToRelease);
drh3b7511c2001-05-26 13:15:44 +00003333 return SQLITE_OK;
3334}
3335
3336/*
drhbd03cae2001-06-02 02:40:57 +00003337** Change the MemPage.pParent pointer on the page whose number is
drh8b2f49b2001-06-08 00:21:52 +00003338** given in the second argument so that MemPage.pParent holds the
drhbd03cae2001-06-02 02:40:57 +00003339** pointer in the third argument.
3340*/
danielk1977afcdd022004-10-31 16:25:42 +00003341static int reparentPage(Btree *pBt, Pgno pgno, MemPage *pNewParent, int idx){
drhbd03cae2001-06-02 02:40:57 +00003342 MemPage *pThis;
drh4b70f112004-05-02 21:12:19 +00003343 unsigned char *aData;
drhbd03cae2001-06-02 02:40:57 +00003344
danielk1977afcdd022004-10-31 16:25:42 +00003345 if( pgno==0 ) return SQLITE_OK;
drh4b70f112004-05-02 21:12:19 +00003346 assert( pBt->pPager!=0 );
drha34b6762004-05-07 13:30:42 +00003347 aData = sqlite3pager_lookup(pBt->pPager, pgno);
drhda200cc2004-05-09 11:51:38 +00003348 if( aData ){
drh887dc4c2004-10-22 16:22:57 +00003349 pThis = (MemPage*)&aData[pBt->psAligned];
drh31276532004-09-27 12:20:52 +00003350 assert( pThis->aData==aData );
drhda200cc2004-05-09 11:51:38 +00003351 if( pThis->isInit ){
3352 if( pThis->pParent!=pNewParent ){
3353 if( pThis->pParent ) sqlite3pager_unref(pThis->pParent->aData);
3354 pThis->pParent = pNewParent;
3355 if( pNewParent ) sqlite3pager_ref(pNewParent->aData);
3356 }
3357 pThis->idxParent = idx;
drhdd793422001-06-28 01:54:48 +00003358 }
drha34b6762004-05-07 13:30:42 +00003359 sqlite3pager_unref(aData);
drhbd03cae2001-06-02 02:40:57 +00003360 }
danielk1977afcdd022004-10-31 16:25:42 +00003361
3362#ifndef SQLITE_OMIT_AUTOVACUUM
3363 if( pBt->autoVacuum ){
3364 return ptrmapPut(pBt, pgno, PTRMAP_BTREE, pNewParent->pgno);
3365 }
3366#endif
3367 return SQLITE_OK;
drhbd03cae2001-06-02 02:40:57 +00003368}
3369
danielk1977ac11ee62005-01-15 12:45:51 +00003370
3371
drhbd03cae2001-06-02 02:40:57 +00003372/*
drh4b70f112004-05-02 21:12:19 +00003373** Change the pParent pointer of all children of pPage to point back
3374** to pPage.
3375**
drhbd03cae2001-06-02 02:40:57 +00003376** In other words, for every child of pPage, invoke reparentPage()
drh5e00f6c2001-09-13 13:46:56 +00003377** to make sure that each child knows that pPage is its parent.
drhbd03cae2001-06-02 02:40:57 +00003378**
3379** This routine gets called after you memcpy() one page into
3380** another.
3381*/
danielk1977afcdd022004-10-31 16:25:42 +00003382static int reparentChildPages(MemPage *pPage){
drhbd03cae2001-06-02 02:40:57 +00003383 int i;
danielk1977afcdd022004-10-31 16:25:42 +00003384 Btree *pBt = pPage->pBt;
3385 int rc = SQLITE_OK;
drh4b70f112004-05-02 21:12:19 +00003386
danielk1977afcdd022004-10-31 16:25:42 +00003387 if( pPage->leaf ) return SQLITE_OK;
danielk1977afcdd022004-10-31 16:25:42 +00003388
drhbd03cae2001-06-02 02:40:57 +00003389 for(i=0; i<pPage->nCell; i++){
danielk1977afcdd022004-10-31 16:25:42 +00003390 u8 *pCell = findCell(pPage, i);
3391 if( !pPage->leaf ){
3392 rc = reparentPage(pBt, get4byte(pCell), pPage, i);
3393 if( rc!=SQLITE_OK ) return rc;
3394 }
drhbd03cae2001-06-02 02:40:57 +00003395 }
danielk1977afcdd022004-10-31 16:25:42 +00003396 if( !pPage->leaf ){
3397 rc = reparentPage(pBt, get4byte(&pPage->aData[pPage->hdrOffset+8]),
3398 pPage, i);
3399 pPage->idxShift = 0;
3400 }
3401 return rc;
drh14acc042001-06-10 19:56:58 +00003402}
3403
3404/*
3405** Remove the i-th cell from pPage. This routine effects pPage only.
3406** The cell content is not freed or deallocated. It is assumed that
3407** the cell content has been copied someplace else. This routine just
3408** removes the reference to the cell from pPage.
3409**
3410** "sz" must be the number of bytes in the cell.
drh14acc042001-06-10 19:56:58 +00003411*/
drh4b70f112004-05-02 21:12:19 +00003412static void dropCell(MemPage *pPage, int idx, int sz){
drh43605152004-05-29 21:46:49 +00003413 int i; /* Loop counter */
3414 int pc; /* Offset to cell content of cell being deleted */
3415 u8 *data; /* pPage->aData */
3416 u8 *ptr; /* Used to move bytes around within data[] */
3417
drh8c42ca92001-06-22 19:15:00 +00003418 assert( idx>=0 && idx<pPage->nCell );
drh43605152004-05-29 21:46:49 +00003419 assert( sz==cellSize(pPage, idx) );
drha34b6762004-05-07 13:30:42 +00003420 assert( sqlite3pager_iswriteable(pPage->aData) );
drhda200cc2004-05-09 11:51:38 +00003421 data = pPage->aData;
drh43605152004-05-29 21:46:49 +00003422 ptr = &data[pPage->cellOffset + 2*idx];
3423 pc = get2byte(ptr);
3424 assert( pc>10 && pc+sz<=pPage->pBt->usableSize );
drhde647132004-05-07 17:57:49 +00003425 freeSpace(pPage, pc, sz);
drh43605152004-05-29 21:46:49 +00003426 for(i=idx+1; i<pPage->nCell; i++, ptr+=2){
3427 ptr[0] = ptr[2];
3428 ptr[1] = ptr[3];
drh14acc042001-06-10 19:56:58 +00003429 }
3430 pPage->nCell--;
drh43605152004-05-29 21:46:49 +00003431 put2byte(&data[pPage->hdrOffset+3], pPage->nCell);
3432 pPage->nFree += 2;
drh428ae8c2003-01-04 16:48:09 +00003433 pPage->idxShift = 1;
drh14acc042001-06-10 19:56:58 +00003434}
3435
3436/*
3437** Insert a new cell on pPage at cell index "i". pCell points to the
3438** content of the cell.
3439**
3440** If the cell content will fit on the page, then put it there. If it
drh43605152004-05-29 21:46:49 +00003441** will not fit, then make a copy of the cell content into pTemp if
3442** pTemp is not null. Regardless of pTemp, allocate a new entry
3443** in pPage->aOvfl[] and make it point to the cell content (either
3444** in pTemp or the original pCell) and also record its index.
3445** Allocating a new entry in pPage->aCell[] implies that
3446** pPage->nOverflow is incremented.
danielk1977a3ad5e72005-01-07 08:56:44 +00003447**
3448** If nSkip is non-zero, then do not copy the first nSkip bytes of the
3449** cell. The caller will overwrite them after this function returns. If
drh4b238df2005-01-08 15:43:18 +00003450** nSkip is non-zero, then pCell may not point to an invalid memory location
danielk1977a3ad5e72005-01-07 08:56:44 +00003451** (but pCell+nSkip is always valid).
drh14acc042001-06-10 19:56:58 +00003452*/
danielk1977e80463b2004-11-03 03:01:16 +00003453static int insertCell(
drh24cd67e2004-05-10 16:18:47 +00003454 MemPage *pPage, /* Page into which we are copying */
drh43605152004-05-29 21:46:49 +00003455 int i, /* New cell becomes the i-th cell of the page */
3456 u8 *pCell, /* Content of the new cell */
3457 int sz, /* Bytes of content in pCell */
danielk1977a3ad5e72005-01-07 08:56:44 +00003458 u8 *pTemp, /* Temp storage space for pCell, if needed */
3459 u8 nSkip /* Do not write the first nSkip bytes of the cell */
drh24cd67e2004-05-10 16:18:47 +00003460){
drh43605152004-05-29 21:46:49 +00003461 int idx; /* Where to write new cell content in data[] */
3462 int j; /* Loop counter */
3463 int top; /* First byte of content for any cell in data[] */
3464 int end; /* First byte past the last cell pointer in data[] */
3465 int ins; /* Index in data[] where new cell pointer is inserted */
3466 int hdr; /* Offset into data[] of the page header */
3467 int cellOffset; /* Address of first cell pointer in data[] */
3468 u8 *data; /* The content of the whole page */
3469 u8 *ptr; /* Used for moving information around in data[] */
3470
3471 assert( i>=0 && i<=pPage->nCell+pPage->nOverflow );
3472 assert( sz==cellSizePtr(pPage, pCell) );
drha34b6762004-05-07 13:30:42 +00003473 assert( sqlite3pager_iswriteable(pPage->aData) );
drh43605152004-05-29 21:46:49 +00003474 if( pPage->nOverflow || sz+2>pPage->nFree ){
drh24cd67e2004-05-10 16:18:47 +00003475 if( pTemp ){
danielk1977a3ad5e72005-01-07 08:56:44 +00003476 memcpy(pTemp+nSkip, pCell+nSkip, sz-nSkip);
drh43605152004-05-29 21:46:49 +00003477 pCell = pTemp;
drh24cd67e2004-05-10 16:18:47 +00003478 }
drh43605152004-05-29 21:46:49 +00003479 j = pPage->nOverflow++;
3480 assert( j<sizeof(pPage->aOvfl)/sizeof(pPage->aOvfl[0]) );
3481 pPage->aOvfl[j].pCell = pCell;
3482 pPage->aOvfl[j].idx = i;
3483 pPage->nFree = 0;
drh14acc042001-06-10 19:56:58 +00003484 }else{
drh43605152004-05-29 21:46:49 +00003485 data = pPage->aData;
3486 hdr = pPage->hdrOffset;
3487 top = get2byte(&data[hdr+5]);
3488 cellOffset = pPage->cellOffset;
3489 end = cellOffset + 2*pPage->nCell + 2;
3490 ins = cellOffset + 2*i;
3491 if( end > top - sz ){
3492 defragmentPage(pPage);
3493 top = get2byte(&data[hdr+5]);
3494 assert( end + sz <= top );
3495 }
3496 idx = allocateSpace(pPage, sz);
3497 assert( idx>0 );
3498 assert( end <= get2byte(&data[hdr+5]) );
3499 pPage->nCell++;
3500 pPage->nFree -= 2;
danielk1977a3ad5e72005-01-07 08:56:44 +00003501 memcpy(&data[idx+nSkip], pCell+nSkip, sz-nSkip);
drh43605152004-05-29 21:46:49 +00003502 for(j=end-2, ptr=&data[j]; j>ins; j-=2, ptr-=2){
3503 ptr[0] = ptr[-2];
3504 ptr[1] = ptr[-1];
drhda200cc2004-05-09 11:51:38 +00003505 }
drh43605152004-05-29 21:46:49 +00003506 put2byte(&data[ins], idx);
3507 put2byte(&data[hdr+3], pPage->nCell);
3508 pPage->idxShift = 1;
drhda200cc2004-05-09 11:51:38 +00003509 pageIntegrity(pPage);
danielk1977a19df672004-11-03 11:37:07 +00003510#ifndef SQLITE_OMIT_AUTOVACUUM
3511 if( pPage->pBt->autoVacuum ){
3512 /* The cell may contain a pointer to an overflow page. If so, write
3513 ** the entry for the overflow page into the pointer map.
3514 */
3515 CellInfo info;
3516 parseCellPtr(pPage, pCell, &info);
3517 if( (info.nData+(pPage->intKey?0:info.nKey))>info.nLocal ){
3518 Pgno pgnoOvfl = get4byte(&pCell[info.iOverflow]);
3519 int rc = ptrmapPut(pPage->pBt, pgnoOvfl, PTRMAP_OVERFLOW1, pPage->pgno);
3520 if( rc!=SQLITE_OK ) return rc;
3521 }
3522 }
3523#endif
drh14acc042001-06-10 19:56:58 +00003524 }
danielk1977e80463b2004-11-03 03:01:16 +00003525
danielk1977e80463b2004-11-03 03:01:16 +00003526 return SQLITE_OK;
drh14acc042001-06-10 19:56:58 +00003527}
3528
3529/*
drhfa1a98a2004-05-14 19:08:17 +00003530** Add a list of cells to a page. The page should be initially empty.
3531** The cells are guaranteed to fit on the page.
3532*/
3533static void assemblePage(
3534 MemPage *pPage, /* The page to be assemblied */
3535 int nCell, /* The number of cells to add to this page */
drh43605152004-05-29 21:46:49 +00003536 u8 **apCell, /* Pointers to cell bodies */
drhfa1a98a2004-05-14 19:08:17 +00003537 int *aSize /* Sizes of the cells */
3538){
3539 int i; /* Loop counter */
3540 int totalSize; /* Total size of all cells */
3541 int hdr; /* Index of page header */
drh43605152004-05-29 21:46:49 +00003542 int cellptr; /* Address of next cell pointer */
3543 int cellbody; /* Address of next cell body */
drhfa1a98a2004-05-14 19:08:17 +00003544 u8 *data; /* Data for the page */
3545
drh43605152004-05-29 21:46:49 +00003546 assert( pPage->nOverflow==0 );
drhfa1a98a2004-05-14 19:08:17 +00003547 totalSize = 0;
3548 for(i=0; i<nCell; i++){
3549 totalSize += aSize[i];
3550 }
drh43605152004-05-29 21:46:49 +00003551 assert( totalSize+2*nCell<=pPage->nFree );
drhfa1a98a2004-05-14 19:08:17 +00003552 assert( pPage->nCell==0 );
drh43605152004-05-29 21:46:49 +00003553 cellptr = pPage->cellOffset;
drhfa1a98a2004-05-14 19:08:17 +00003554 data = pPage->aData;
3555 hdr = pPage->hdrOffset;
drh43605152004-05-29 21:46:49 +00003556 put2byte(&data[hdr+3], nCell);
3557 cellbody = allocateSpace(pPage, totalSize);
3558 assert( cellbody>0 );
3559 assert( pPage->nFree >= 2*nCell );
3560 pPage->nFree -= 2*nCell;
drhfa1a98a2004-05-14 19:08:17 +00003561 for(i=0; i<nCell; i++){
drh43605152004-05-29 21:46:49 +00003562 put2byte(&data[cellptr], cellbody);
3563 memcpy(&data[cellbody], apCell[i], aSize[i]);
3564 cellptr += 2;
3565 cellbody += aSize[i];
drhfa1a98a2004-05-14 19:08:17 +00003566 }
drh43605152004-05-29 21:46:49 +00003567 assert( cellbody==pPage->pBt->usableSize );
drhfa1a98a2004-05-14 19:08:17 +00003568 pPage->nCell = nCell;
drhfa1a98a2004-05-14 19:08:17 +00003569}
3570
drh14acc042001-06-10 19:56:58 +00003571/*
drhc3b70572003-01-04 19:44:07 +00003572** The following parameters determine how many adjacent pages get involved
3573** in a balancing operation. NN is the number of neighbors on either side
3574** of the page that participate in the balancing operation. NB is the
3575** total number of pages that participate, including the target page and
3576** NN neighbors on either side.
3577**
3578** The minimum value of NN is 1 (of course). Increasing NN above 1
3579** (to 2 or 3) gives a modest improvement in SELECT and DELETE performance
3580** in exchange for a larger degradation in INSERT and UPDATE performance.
3581** The value of NN appears to give the best results overall.
3582*/
3583#define NN 1 /* Number of neighbors on either side of pPage */
3584#define NB (NN*2+1) /* Total pages involved in the balance */
3585
drh43605152004-05-29 21:46:49 +00003586/* Forward reference */
danielk1977ac245ec2005-01-14 13:50:11 +00003587static int balance(MemPage*, int);
3588
drh615ae552005-01-16 23:21:00 +00003589#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00003590/*
3591** This version of balance() handles the common special case where
3592** a new entry is being inserted on the extreme right-end of the
3593** tree, in other words, when the new entry will become the largest
3594** entry in the tree.
3595**
3596** Instead of trying balance the 3 right-most leaf pages, just add
3597** a new page to the right-hand side and put the one new entry in
3598** that page. This leaves the right side of the tree somewhat
3599** unbalanced. But odds are that we will be inserting new entries
3600** at the end soon afterwards so the nearly empty page will quickly
3601** fill up. On average.
3602**
3603** pPage is the leaf page which is the right-most page in the tree.
3604** pParent is its parent. pPage must have a single overflow entry
3605** which is also the right-most entry on the page.
3606*/
danielk1977ac245ec2005-01-14 13:50:11 +00003607static int balance_quick(MemPage *pPage, MemPage *pParent){
3608 int rc;
3609 MemPage *pNew;
3610 Pgno pgnoNew;
3611 u8 *pCell;
3612 int szCell;
3613 CellInfo info;
danielk1977ac11ee62005-01-15 12:45:51 +00003614 Btree *pBt = pPage->pBt;
danielk197779a40da2005-01-16 08:00:01 +00003615 int parentIdx = pParent->nCell; /* pParent new divider cell index */
3616 int parentSize; /* Size of new divider cell */
3617 u8 parentCell[64]; /* Space for the new divider cell */
danielk1977ac245ec2005-01-14 13:50:11 +00003618
3619 /* Allocate a new page. Insert the overflow cell from pPage
3620 ** into it. Then remove the overflow cell from pPage.
3621 */
danielk1977ac11ee62005-01-15 12:45:51 +00003622 rc = allocatePage(pBt, &pNew, &pgnoNew, 0, 0);
danielk1977ac245ec2005-01-14 13:50:11 +00003623 if( rc!=SQLITE_OK ){
3624 return rc;
3625 }
3626 pCell = pPage->aOvfl[0].pCell;
3627 szCell = cellSizePtr(pPage, pCell);
3628 zeroPage(pNew, pPage->aData[0]);
3629 assemblePage(pNew, 1, &pCell, &szCell);
3630 pPage->nOverflow = 0;
3631
danielk197779a40da2005-01-16 08:00:01 +00003632 /* Set the parent of the newly allocated page to pParent. */
3633 pNew->pParent = pParent;
3634 sqlite3pager_ref(pParent->aData);
3635
danielk1977ac245ec2005-01-14 13:50:11 +00003636 /* pPage is currently the right-child of pParent. Change this
3637 ** so that the right-child is the new page allocated above and
danielk197779a40da2005-01-16 08:00:01 +00003638 ** pPage is the next-to-right child.
danielk1977ac245ec2005-01-14 13:50:11 +00003639 */
danielk1977ac11ee62005-01-15 12:45:51 +00003640 assert( pPage->nCell>0 );
danielk1977ac245ec2005-01-14 13:50:11 +00003641 parseCellPtr(pPage, findCell(pPage, pPage->nCell-1), &info);
3642 rc = fillInCell(pParent, parentCell, 0, info.nKey, 0, 0, &parentSize);
3643 if( rc!=SQLITE_OK ){
danielk197779a40da2005-01-16 08:00:01 +00003644 return rc;
danielk1977ac245ec2005-01-14 13:50:11 +00003645 }
3646 assert( parentSize<64 );
3647 rc = insertCell(pParent, parentIdx, parentCell, parentSize, 0, 4);
3648 if( rc!=SQLITE_OK ){
danielk197779a40da2005-01-16 08:00:01 +00003649 return rc;
danielk1977ac245ec2005-01-14 13:50:11 +00003650 }
3651 put4byte(findOverflowCell(pParent,parentIdx), pPage->pgno);
3652 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew);
3653
danielk197779a40da2005-01-16 08:00:01 +00003654#ifndef SQLITE_OMIT_AUTOVACUUM
3655 /* If this is an auto-vacuum database, update the pointer map
3656 ** with entries for the new page, and any pointer from the
3657 ** cell on the page to an overflow page.
3658 */
danielk1977ac11ee62005-01-15 12:45:51 +00003659 if( pBt->autoVacuum ){
3660 rc = ptrmapPut(pBt, pgnoNew, PTRMAP_BTREE, pParent->pgno);
3661 if( rc!=SQLITE_OK ){
3662 return rc;
3663 }
danielk197779a40da2005-01-16 08:00:01 +00003664 rc = ptrmapPutOvfl(pNew, 0);
3665 if( rc!=SQLITE_OK ){
3666 return rc;
danielk1977ac11ee62005-01-15 12:45:51 +00003667 }
3668 }
danielk197779a40da2005-01-16 08:00:01 +00003669#endif
danielk1977ac11ee62005-01-15 12:45:51 +00003670
danielk197779a40da2005-01-16 08:00:01 +00003671 /* Release the reference to the new page and balance the parent page,
3672 ** in case the divider cell inserted caused it to become overfull.
3673 */
danielk1977ac245ec2005-01-14 13:50:11 +00003674 releasePage(pNew);
3675 return balance(pParent, 0);
3676}
drh615ae552005-01-16 23:21:00 +00003677#endif /* SQLITE_OMIT_QUICKBALANCE */
drh43605152004-05-29 21:46:49 +00003678
drhc3b70572003-01-04 19:44:07 +00003679/*
danielk1977ac11ee62005-01-15 12:45:51 +00003680** The ISAUTOVACUUM macro is used within balance_nonroot() to determine
3681** if the database supports auto-vacuum or not. Because it is used
3682** within an expression that is an argument to another macro
3683** (sqliteMallocRaw), it is not possible to use conditional compilation.
3684** So, this macro is defined instead.
3685*/
3686#ifndef SQLITE_OMIT_AUTOVACUUM
3687#define ISAUTOVACUUM (pBt->autoVacuum)
3688#else
3689#define ISAUTOVACUUM 0
3690#endif
3691
3692/*
drhab01f612004-05-22 02:55:23 +00003693** This routine redistributes Cells on pPage and up to NN*2 siblings
drh8b2f49b2001-06-08 00:21:52 +00003694** of pPage so that all pages have about the same amount of free space.
drh0c6cc4e2004-06-15 02:13:26 +00003695** Usually NN siblings on either side of pPage is used in the balancing,
3696** though more siblings might come from one side if pPage is the first
drhab01f612004-05-22 02:55:23 +00003697** or last child of its parent. If pPage has fewer than 2*NN siblings
drh8b2f49b2001-06-08 00:21:52 +00003698** (something which can only happen if pPage is the root page or a
drh14acc042001-06-10 19:56:58 +00003699** child of root) then all available siblings participate in the balancing.
drh8b2f49b2001-06-08 00:21:52 +00003700**
drh0c6cc4e2004-06-15 02:13:26 +00003701** The number of siblings of pPage might be increased or decreased by one or
3702** two in an effort to keep pages nearly full but not over full. The root page
drhab01f612004-05-22 02:55:23 +00003703** is special and is allowed to be nearly empty. If pPage is
drh8c42ca92001-06-22 19:15:00 +00003704** the root page, then the depth of the tree might be increased
drh8b2f49b2001-06-08 00:21:52 +00003705** or decreased by one, as necessary, to keep the root page from being
drhab01f612004-05-22 02:55:23 +00003706** overfull or completely empty.
drh14acc042001-06-10 19:56:58 +00003707**
drh8b2f49b2001-06-08 00:21:52 +00003708** Note that when this routine is called, some of the Cells on pPage
drh4b70f112004-05-02 21:12:19 +00003709** might not actually be stored in pPage->aData[]. This can happen
drh8b2f49b2001-06-08 00:21:52 +00003710** if the page is overfull. Part of the job of this routine is to
drh4b70f112004-05-02 21:12:19 +00003711** make sure all Cells for pPage once again fit in pPage->aData[].
drh14acc042001-06-10 19:56:58 +00003712**
drh8c42ca92001-06-22 19:15:00 +00003713** In the course of balancing the siblings of pPage, the parent of pPage
3714** might become overfull or underfull. If that happens, then this routine
3715** is called recursively on the parent.
3716**
drh5e00f6c2001-09-13 13:46:56 +00003717** If this routine fails for any reason, it might leave the database
3718** in a corrupted state. So if this routine fails, the database should
3719** be rolled back.
drh8b2f49b2001-06-08 00:21:52 +00003720*/
drh43605152004-05-29 21:46:49 +00003721static int balance_nonroot(MemPage *pPage){
drh8b2f49b2001-06-08 00:21:52 +00003722 MemPage *pParent; /* The parent of pPage */
drh4b70f112004-05-02 21:12:19 +00003723 Btree *pBt; /* The whole database */
danielk1977cfe9a692004-06-16 12:00:29 +00003724 int nCell = 0; /* Number of cells in aCell[] */
drh8b2f49b2001-06-08 00:21:52 +00003725 int nOld; /* Number of pages in apOld[] */
3726 int nNew; /* Number of pages in apNew[] */
drh8b2f49b2001-06-08 00:21:52 +00003727 int nDiv; /* Number of cells in apDiv[] */
drh14acc042001-06-10 19:56:58 +00003728 int i, j, k; /* Loop counters */
drha34b6762004-05-07 13:30:42 +00003729 int idx; /* Index of pPage in pParent->aCell[] */
3730 int nxDiv; /* Next divider slot in pParent->aCell[] */
drh14acc042001-06-10 19:56:58 +00003731 int rc; /* The return code */
drh91025292004-05-03 19:49:32 +00003732 int leafCorrection; /* 4 if pPage is a leaf. 0 if not */
drh8b18dd42004-05-12 19:18:15 +00003733 int leafData; /* True if pPage is a leaf of a LEAFDATA tree */
drh91025292004-05-03 19:49:32 +00003734 int usableSpace; /* Bytes in pPage beyond the header */
3735 int pageFlags; /* Value of pPage->aData[0] */
drh6019e162001-07-02 17:51:45 +00003736 int subtotal; /* Subtotal of bytes in cells on one page */
drhb6f41482004-05-14 01:58:11 +00003737 int iSpace = 0; /* First unused byte of aSpace[] */
drh2e38c322004-09-03 18:38:44 +00003738 int mxCellPerPage; /* Maximum number of cells in one page */
drhc3b70572003-01-04 19:44:07 +00003739 MemPage *apOld[NB]; /* pPage and up to two siblings */
3740 Pgno pgnoOld[NB]; /* Page numbers for each page in apOld[] */
drh4b70f112004-05-02 21:12:19 +00003741 MemPage *apCopy[NB]; /* Private copies of apOld[] pages */
drha2fce642004-06-05 00:01:44 +00003742 MemPage *apNew[NB+2]; /* pPage and up to NB siblings after balancing */
3743 Pgno pgnoNew[NB+2]; /* Page numbers for each page in apNew[] */
drhc3b70572003-01-04 19:44:07 +00003744 int idxDiv[NB]; /* Indices of divider cells in pParent */
drh4b70f112004-05-02 21:12:19 +00003745 u8 *apDiv[NB]; /* Divider cells in pParent */
drha2fce642004-06-05 00:01:44 +00003746 int cntNew[NB+2]; /* Index in aCell[] of cell after i-th page */
3747 int szNew[NB+2]; /* Combined size of cells place on i-th page */
drh2e38c322004-09-03 18:38:44 +00003748 u8 **apCell; /* All cells begin balanced */
3749 int *szCell; /* Local size of all cells in apCell[] */
3750 u8 *aCopy[NB]; /* Space for holding data of apCopy[] */
3751 u8 *aSpace; /* Space to hold copies of dividers cells */
danielk19774e17d142005-01-16 09:06:33 +00003752#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977ac11ee62005-01-15 12:45:51 +00003753 u8 *aFrom = 0;
3754#endif
drh8b2f49b2001-06-08 00:21:52 +00003755
drh14acc042001-06-10 19:56:58 +00003756 /*
drh43605152004-05-29 21:46:49 +00003757 ** Find the parent page.
drh8b2f49b2001-06-08 00:21:52 +00003758 */
drh3a4c1412004-05-09 20:40:11 +00003759 assert( pPage->isInit );
drha34b6762004-05-07 13:30:42 +00003760 assert( sqlite3pager_iswriteable(pPage->aData) );
drh4b70f112004-05-02 21:12:19 +00003761 pBt = pPage->pBt;
drh14acc042001-06-10 19:56:58 +00003762 pParent = pPage->pParent;
drh43605152004-05-29 21:46:49 +00003763 sqlite3pager_write(pParent->aData);
3764 assert( pParent );
3765 TRACE(("BALANCE: begin page %d child of %d\n", pPage->pgno, pParent->pgno));
drh2e38c322004-09-03 18:38:44 +00003766
drh615ae552005-01-16 23:21:00 +00003767#ifndef SQLITE_OMIT_QUICKBALANCE
drhf222e712005-01-14 22:55:49 +00003768 /*
3769 ** A special case: If a new entry has just been inserted into a
3770 ** table (that is, a btree with integer keys and all data at the leaves)
3771 ** an the new entry is the right-most entry in the tree (it has the
3772 ** largest key) then use the special balance_quick() routine for
3773 ** balancing. balance_quick() is much faster and results in a tighter
3774 ** packing of data in the common case.
3775 */
danielk1977ac245ec2005-01-14 13:50:11 +00003776 if( pPage->leaf &&
3777 pPage->intKey &&
3778 pPage->leafData &&
3779 pPage->nOverflow==1 &&
3780 pPage->aOvfl[0].idx==pPage->nCell &&
danielk1977ac11ee62005-01-15 12:45:51 +00003781 pPage->pParent->pgno!=1 &&
danielk1977ac245ec2005-01-14 13:50:11 +00003782 get4byte(&pParent->aData[pParent->hdrOffset+8])==pPage->pgno
3783 ){
danielk1977ac11ee62005-01-15 12:45:51 +00003784 /*
3785 ** TODO: Check the siblings to the left of pPage. It may be that
3786 ** they are not full and no new page is required.
3787 */
danielk1977ac245ec2005-01-14 13:50:11 +00003788 return balance_quick(pPage, pParent);
3789 }
3790#endif
3791
drh2e38c322004-09-03 18:38:44 +00003792 /*
3793 ** Allocate space for memory structures
3794 */
3795 mxCellPerPage = MX_CELL(pBt);
3796 apCell = sqliteMallocRaw(
3797 (mxCellPerPage+2)*NB*(sizeof(u8*)+sizeof(int))
3798 + sizeof(MemPage)*NB
drh887dc4c2004-10-22 16:22:57 +00003799 + pBt->psAligned*(5+NB)
danielk1977ac11ee62005-01-15 12:45:51 +00003800 + (ISAUTOVACUUM ? (mxCellPerPage+2)*NN*2 : 0)
drh2e38c322004-09-03 18:38:44 +00003801 );
3802 if( apCell==0 ){
3803 return SQLITE_NOMEM;
3804 }
3805 szCell = (int*)&apCell[(mxCellPerPage+2)*NB];
3806 aCopy[0] = (u8*)&szCell[(mxCellPerPage+2)*NB];
3807 for(i=1; i<NB; i++){
drh887dc4c2004-10-22 16:22:57 +00003808 aCopy[i] = &aCopy[i-1][pBt->psAligned+sizeof(MemPage)];
drh2e38c322004-09-03 18:38:44 +00003809 }
drh887dc4c2004-10-22 16:22:57 +00003810 aSpace = &aCopy[NB-1][pBt->psAligned+sizeof(MemPage)];
danielk1977ac11ee62005-01-15 12:45:51 +00003811#ifndef SQLITE_OMIT_AUTOVACUUM
3812 if( pBt->autoVacuum ){
3813 aFrom = &aSpace[5*pBt->psAligned];
3814 }
3815#endif
drh14acc042001-06-10 19:56:58 +00003816
drh8b2f49b2001-06-08 00:21:52 +00003817 /*
drh4b70f112004-05-02 21:12:19 +00003818 ** Find the cell in the parent page whose left child points back
drh14acc042001-06-10 19:56:58 +00003819 ** to pPage. The "idx" variable is the index of that cell. If pPage
3820 ** is the rightmost child of pParent then set idx to pParent->nCell
drh8b2f49b2001-06-08 00:21:52 +00003821 */
drhbb49aba2003-01-04 18:53:27 +00003822 if( pParent->idxShift ){
drha34b6762004-05-07 13:30:42 +00003823 Pgno pgno;
drh4b70f112004-05-02 21:12:19 +00003824 pgno = pPage->pgno;
drha34b6762004-05-07 13:30:42 +00003825 assert( pgno==sqlite3pager_pagenumber(pPage->aData) );
drhbb49aba2003-01-04 18:53:27 +00003826 for(idx=0; idx<pParent->nCell; idx++){
drh43605152004-05-29 21:46:49 +00003827 if( get4byte(findCell(pParent, idx))==pgno ){
drhbb49aba2003-01-04 18:53:27 +00003828 break;
3829 }
drh8b2f49b2001-06-08 00:21:52 +00003830 }
drh4b70f112004-05-02 21:12:19 +00003831 assert( idx<pParent->nCell
drh43605152004-05-29 21:46:49 +00003832 || get4byte(&pParent->aData[pParent->hdrOffset+8])==pgno );
drhbb49aba2003-01-04 18:53:27 +00003833 }else{
3834 idx = pPage->idxParent;
drh8b2f49b2001-06-08 00:21:52 +00003835 }
drh8b2f49b2001-06-08 00:21:52 +00003836
3837 /*
drh14acc042001-06-10 19:56:58 +00003838 ** Initialize variables so that it will be safe to jump
drh5edc3122001-09-13 21:53:09 +00003839 ** directly to balance_cleanup at any moment.
drh8b2f49b2001-06-08 00:21:52 +00003840 */
drh14acc042001-06-10 19:56:58 +00003841 nOld = nNew = 0;
drha34b6762004-05-07 13:30:42 +00003842 sqlite3pager_ref(pParent->aData);
drh14acc042001-06-10 19:56:58 +00003843
3844 /*
drh4b70f112004-05-02 21:12:19 +00003845 ** Find sibling pages to pPage and the cells in pParent that divide
drhc3b70572003-01-04 19:44:07 +00003846 ** the siblings. An attempt is made to find NN siblings on either
3847 ** side of pPage. More siblings are taken from one side, however, if
3848 ** pPage there are fewer than NN siblings on the other side. If pParent
3849 ** has NB or fewer children then all children of pParent are taken.
drh14acc042001-06-10 19:56:58 +00003850 */
drhc3b70572003-01-04 19:44:07 +00003851 nxDiv = idx - NN;
3852 if( nxDiv + NB > pParent->nCell ){
3853 nxDiv = pParent->nCell - NB + 1;
drh8b2f49b2001-06-08 00:21:52 +00003854 }
drhc3b70572003-01-04 19:44:07 +00003855 if( nxDiv<0 ){
3856 nxDiv = 0;
3857 }
drh8b2f49b2001-06-08 00:21:52 +00003858 nDiv = 0;
drhc3b70572003-01-04 19:44:07 +00003859 for(i=0, k=nxDiv; i<NB; i++, k++){
drh14acc042001-06-10 19:56:58 +00003860 if( k<pParent->nCell ){
3861 idxDiv[i] = k;
drh43605152004-05-29 21:46:49 +00003862 apDiv[i] = findCell(pParent, k);
drh8b2f49b2001-06-08 00:21:52 +00003863 nDiv++;
drha34b6762004-05-07 13:30:42 +00003864 assert( !pParent->leaf );
drh43605152004-05-29 21:46:49 +00003865 pgnoOld[i] = get4byte(apDiv[i]);
drh14acc042001-06-10 19:56:58 +00003866 }else if( k==pParent->nCell ){
drh43605152004-05-29 21:46:49 +00003867 pgnoOld[i] = get4byte(&pParent->aData[pParent->hdrOffset+8]);
drh14acc042001-06-10 19:56:58 +00003868 }else{
3869 break;
drh8b2f49b2001-06-08 00:21:52 +00003870 }
drhde647132004-05-07 17:57:49 +00003871 rc = getAndInitPage(pBt, pgnoOld[i], &apOld[i], pParent);
drh6019e162001-07-02 17:51:45 +00003872 if( rc ) goto balance_cleanup;
drh428ae8c2003-01-04 16:48:09 +00003873 apOld[i]->idxParent = k;
drh91025292004-05-03 19:49:32 +00003874 apCopy[i] = 0;
3875 assert( i==nOld );
drh14acc042001-06-10 19:56:58 +00003876 nOld++;
drh8b2f49b2001-06-08 00:21:52 +00003877 }
3878
3879 /*
drh14acc042001-06-10 19:56:58 +00003880 ** Make copies of the content of pPage and its siblings into aOld[].
3881 ** The rest of this function will use data from the copies rather
3882 ** that the original pages since the original pages will be in the
3883 ** process of being overwritten.
3884 */
3885 for(i=0; i<nOld; i++){
drh887dc4c2004-10-22 16:22:57 +00003886 MemPage *p = apCopy[i] = (MemPage*)&aCopy[i][pBt->psAligned];
3887 p->aData = &((u8*)p)[-pBt->psAligned];
3888 memcpy(p->aData, apOld[i]->aData, pBt->psAligned + sizeof(MemPage));
3889 p->aData = &((u8*)p)[-pBt->psAligned];
drh14acc042001-06-10 19:56:58 +00003890 }
3891
3892 /*
3893 ** Load pointers to all cells on sibling pages and the divider cells
3894 ** into the local apCell[] array. Make copies of the divider cells
drhb6f41482004-05-14 01:58:11 +00003895 ** into space obtained form aSpace[] and remove the the divider Cells
3896 ** from pParent.
drh4b70f112004-05-02 21:12:19 +00003897 **
3898 ** If the siblings are on leaf pages, then the child pointers of the
3899 ** divider cells are stripped from the cells before they are copied
drh96f5b762004-05-16 16:24:36 +00003900 ** into aSpace[]. In this way, all cells in apCell[] are without
drh4b70f112004-05-02 21:12:19 +00003901 ** child pointers. If siblings are not leaves, then all cell in
3902 ** apCell[] include child pointers. Either way, all cells in apCell[]
3903 ** are alike.
drh96f5b762004-05-16 16:24:36 +00003904 **
3905 ** leafCorrection: 4 if pPage is a leaf. 0 if pPage is not a leaf.
3906 ** leafData: 1 if pPage holds key+data and pParent holds only keys.
drh8b2f49b2001-06-08 00:21:52 +00003907 */
3908 nCell = 0;
drh4b70f112004-05-02 21:12:19 +00003909 leafCorrection = pPage->leaf*4;
drh8b18dd42004-05-12 19:18:15 +00003910 leafData = pPage->leafData && pPage->leaf;
drh8b2f49b2001-06-08 00:21:52 +00003911 for(i=0; i<nOld; i++){
drh4b70f112004-05-02 21:12:19 +00003912 MemPage *pOld = apCopy[i];
drh43605152004-05-29 21:46:49 +00003913 int limit = pOld->nCell+pOld->nOverflow;
3914 for(j=0; j<limit; j++){
3915 apCell[nCell] = findOverflowCell(pOld, j);
3916 szCell[nCell] = cellSizePtr(pOld, apCell[nCell]);
danielk1977ac11ee62005-01-15 12:45:51 +00003917#ifndef SQLITE_OMIT_AUTOVACUUM
3918 if( pBt->autoVacuum ){
3919 int a;
3920 aFrom[nCell] = i;
3921 for(a=0; a<pOld->nOverflow; a++){
3922 if( pOld->aOvfl[a].pCell==apCell[nCell] ){
3923 aFrom[nCell] = 0xFF;
3924 break;
3925 }
3926 }
3927 }
3928#endif
drh14acc042001-06-10 19:56:58 +00003929 nCell++;
drh8b2f49b2001-06-08 00:21:52 +00003930 }
3931 if( i<nOld-1 ){
drh43605152004-05-29 21:46:49 +00003932 int sz = cellSizePtr(pParent, apDiv[i]);
drh8b18dd42004-05-12 19:18:15 +00003933 if( leafData ){
drh96f5b762004-05-16 16:24:36 +00003934 /* With the LEAFDATA flag, pParent cells hold only INTKEYs that
3935 ** are duplicates of keys on the child pages. We need to remove
3936 ** the divider cells from pParent, but the dividers cells are not
3937 ** added to apCell[] because they are duplicates of child cells.
3938 */
drh8b18dd42004-05-12 19:18:15 +00003939 dropCell(pParent, nxDiv, sz);
drh4b70f112004-05-02 21:12:19 +00003940 }else{
drhb6f41482004-05-14 01:58:11 +00003941 u8 *pTemp;
3942 szCell[nCell] = sz;
3943 pTemp = &aSpace[iSpace];
3944 iSpace += sz;
drh887dc4c2004-10-22 16:22:57 +00003945 assert( iSpace<=pBt->psAligned*5 );
drhb6f41482004-05-14 01:58:11 +00003946 memcpy(pTemp, apDiv[i], sz);
3947 apCell[nCell] = pTemp+leafCorrection;
danielk1977ac11ee62005-01-15 12:45:51 +00003948#ifndef SQLITE_OMIT_AUTOVACUUM
3949 if( pBt->autoVacuum ){
3950 aFrom[nCell] = 0xFF;
3951 }
3952#endif
drhb6f41482004-05-14 01:58:11 +00003953 dropCell(pParent, nxDiv, sz);
drh8b18dd42004-05-12 19:18:15 +00003954 szCell[nCell] -= leafCorrection;
drh43605152004-05-29 21:46:49 +00003955 assert( get4byte(pTemp)==pgnoOld[i] );
drh8b18dd42004-05-12 19:18:15 +00003956 if( !pOld->leaf ){
3957 assert( leafCorrection==0 );
3958 /* The right pointer of the child page pOld becomes the left
3959 ** pointer of the divider cell */
drh43605152004-05-29 21:46:49 +00003960 memcpy(apCell[nCell], &pOld->aData[pOld->hdrOffset+8], 4);
drh8b18dd42004-05-12 19:18:15 +00003961 }else{
3962 assert( leafCorrection==4 );
3963 }
3964 nCell++;
drh4b70f112004-05-02 21:12:19 +00003965 }
drh8b2f49b2001-06-08 00:21:52 +00003966 }
3967 }
3968
3969 /*
drh6019e162001-07-02 17:51:45 +00003970 ** Figure out the number of pages needed to hold all nCell cells.
3971 ** Store this number in "k". Also compute szNew[] which is the total
3972 ** size of all cells on the i-th page and cntNew[] which is the index
drh4b70f112004-05-02 21:12:19 +00003973 ** in apCell[] of the cell that divides page i from page i+1.
drh6019e162001-07-02 17:51:45 +00003974 ** cntNew[k] should equal nCell.
3975 **
drh96f5b762004-05-16 16:24:36 +00003976 ** Values computed by this block:
3977 **
3978 ** k: The total number of sibling pages
3979 ** szNew[i]: Spaced used on the i-th sibling page.
3980 ** cntNew[i]: Index in apCell[] and szCell[] for the first cell to
3981 ** the right of the i-th sibling page.
3982 ** usableSpace: Number of bytes of space available on each sibling.
3983 **
drh8b2f49b2001-06-08 00:21:52 +00003984 */
drh43605152004-05-29 21:46:49 +00003985 usableSpace = pBt->usableSize - 12 + leafCorrection;
drh6019e162001-07-02 17:51:45 +00003986 for(subtotal=k=i=0; i<nCell; i++){
drh43605152004-05-29 21:46:49 +00003987 subtotal += szCell[i] + 2;
drh4b70f112004-05-02 21:12:19 +00003988 if( subtotal > usableSpace ){
drh6019e162001-07-02 17:51:45 +00003989 szNew[k] = subtotal - szCell[i];
3990 cntNew[k] = i;
drh8b18dd42004-05-12 19:18:15 +00003991 if( leafData ){ i--; }
drh6019e162001-07-02 17:51:45 +00003992 subtotal = 0;
3993 k++;
3994 }
3995 }
3996 szNew[k] = subtotal;
3997 cntNew[k] = nCell;
3998 k++;
drh96f5b762004-05-16 16:24:36 +00003999
4000 /*
4001 ** The packing computed by the previous block is biased toward the siblings
4002 ** on the left side. The left siblings are always nearly full, while the
4003 ** right-most sibling might be nearly empty. This block of code attempts
4004 ** to adjust the packing of siblings to get a better balance.
4005 **
4006 ** This adjustment is more than an optimization. The packing above might
4007 ** be so out of balance as to be illegal. For example, the right-most
4008 ** sibling might be completely empty. This adjustment is not optional.
4009 */
drh6019e162001-07-02 17:51:45 +00004010 for(i=k-1; i>0; i--){
drh96f5b762004-05-16 16:24:36 +00004011 int szRight = szNew[i]; /* Size of sibling on the right */
4012 int szLeft = szNew[i-1]; /* Size of sibling on the left */
4013 int r; /* Index of right-most cell in left sibling */
4014 int d; /* Index of first cell to the left of right sibling */
4015
4016 r = cntNew[i-1] - 1;
4017 d = r + 1 - leafData;
drh43605152004-05-29 21:46:49 +00004018 while( szRight==0 || szRight+szCell[d]+2<=szLeft-(szCell[r]+2) ){
4019 szRight += szCell[d] + 2;
4020 szLeft -= szCell[r] + 2;
drh6019e162001-07-02 17:51:45 +00004021 cntNew[i-1]--;
drh96f5b762004-05-16 16:24:36 +00004022 r = cntNew[i-1] - 1;
4023 d = r + 1 - leafData;
drh6019e162001-07-02 17:51:45 +00004024 }
drh96f5b762004-05-16 16:24:36 +00004025 szNew[i] = szRight;
4026 szNew[i-1] = szLeft;
drh6019e162001-07-02 17:51:45 +00004027 }
4028 assert( cntNew[0]>0 );
drh8b2f49b2001-06-08 00:21:52 +00004029
4030 /*
drh6b308672002-07-08 02:16:37 +00004031 ** Allocate k new pages. Reuse old pages where possible.
drh8b2f49b2001-06-08 00:21:52 +00004032 */
drh4b70f112004-05-02 21:12:19 +00004033 assert( pPage->pgno>1 );
4034 pageFlags = pPage->aData[0];
drh14acc042001-06-10 19:56:58 +00004035 for(i=0; i<k; i++){
drhda200cc2004-05-09 11:51:38 +00004036 MemPage *pNew;
drh6b308672002-07-08 02:16:37 +00004037 if( i<nOld ){
drhda200cc2004-05-09 11:51:38 +00004038 pNew = apNew[i] = apOld[i];
drh6b308672002-07-08 02:16:37 +00004039 pgnoNew[i] = pgnoOld[i];
4040 apOld[i] = 0;
danielk197728129562005-01-11 10:25:06 +00004041 rc = sqlite3pager_write(pNew->aData);
4042 if( rc ) goto balance_cleanup;
drh6b308672002-07-08 02:16:37 +00004043 }else{
danielk1977cb1a7eb2004-11-05 12:27:02 +00004044 rc = allocatePage(pBt, &pNew, &pgnoNew[i], pgnoNew[i-1], 0);
drh6b308672002-07-08 02:16:37 +00004045 if( rc ) goto balance_cleanup;
drhda200cc2004-05-09 11:51:38 +00004046 apNew[i] = pNew;
drh6b308672002-07-08 02:16:37 +00004047 }
drh14acc042001-06-10 19:56:58 +00004048 nNew++;
drhda200cc2004-05-09 11:51:38 +00004049 zeroPage(pNew, pageFlags);
drh8b2f49b2001-06-08 00:21:52 +00004050 }
4051
danielk1977299b1872004-11-22 10:02:10 +00004052 /* Free any old pages that were not reused as new pages.
4053 */
4054 while( i<nOld ){
4055 rc = freePage(apOld[i]);
4056 if( rc ) goto balance_cleanup;
4057 releasePage(apOld[i]);
4058 apOld[i] = 0;
4059 i++;
4060 }
4061
drh8b2f49b2001-06-08 00:21:52 +00004062 /*
drhf9ffac92002-03-02 19:00:31 +00004063 ** Put the new pages in accending order. This helps to
4064 ** keep entries in the disk file in order so that a scan
4065 ** of the table is a linear scan through the file. That
4066 ** in turn helps the operating system to deliver pages
4067 ** from the disk more rapidly.
4068 **
4069 ** An O(n^2) insertion sort algorithm is used, but since
drhc3b70572003-01-04 19:44:07 +00004070 ** n is never more than NB (a small constant), that should
4071 ** not be a problem.
drhf9ffac92002-03-02 19:00:31 +00004072 **
drhc3b70572003-01-04 19:44:07 +00004073 ** When NB==3, this one optimization makes the database
4074 ** about 25% faster for large insertions and deletions.
drhf9ffac92002-03-02 19:00:31 +00004075 */
4076 for(i=0; i<k-1; i++){
4077 int minV = pgnoNew[i];
4078 int minI = i;
4079 for(j=i+1; j<k; j++){
drh7d02cb72003-06-04 16:24:39 +00004080 if( pgnoNew[j]<(unsigned)minV ){
drhf9ffac92002-03-02 19:00:31 +00004081 minI = j;
4082 minV = pgnoNew[j];
4083 }
4084 }
4085 if( minI>i ){
4086 int t;
4087 MemPage *pT;
4088 t = pgnoNew[i];
4089 pT = apNew[i];
4090 pgnoNew[i] = pgnoNew[minI];
4091 apNew[i] = apNew[minI];
4092 pgnoNew[minI] = t;
4093 apNew[minI] = pT;
4094 }
4095 }
drha2fce642004-06-05 00:01:44 +00004096 TRACE(("BALANCE: old: %d %d %d new: %d(%d) %d(%d) %d(%d) %d(%d) %d(%d)\n",
drh24cd67e2004-05-10 16:18:47 +00004097 pgnoOld[0],
4098 nOld>=2 ? pgnoOld[1] : 0,
4099 nOld>=3 ? pgnoOld[2] : 0,
drh10c0fa62004-05-18 12:50:17 +00004100 pgnoNew[0], szNew[0],
4101 nNew>=2 ? pgnoNew[1] : 0, nNew>=2 ? szNew[1] : 0,
4102 nNew>=3 ? pgnoNew[2] : 0, nNew>=3 ? szNew[2] : 0,
drha2fce642004-06-05 00:01:44 +00004103 nNew>=4 ? pgnoNew[3] : 0, nNew>=4 ? szNew[3] : 0,
4104 nNew>=5 ? pgnoNew[4] : 0, nNew>=5 ? szNew[4] : 0));
drh24cd67e2004-05-10 16:18:47 +00004105
drhf9ffac92002-03-02 19:00:31 +00004106 /*
drh14acc042001-06-10 19:56:58 +00004107 ** Evenly distribute the data in apCell[] across the new pages.
4108 ** Insert divider cells into pParent as necessary.
4109 */
4110 j = 0;
4111 for(i=0; i<nNew; i++){
danielk1977ac11ee62005-01-15 12:45:51 +00004112 /* Assemble the new sibling page. */
drh14acc042001-06-10 19:56:58 +00004113 MemPage *pNew = apNew[i];
drh4b70f112004-05-02 21:12:19 +00004114 assert( pNew->pgno==pgnoNew[i] );
drhfa1a98a2004-05-14 19:08:17 +00004115 assemblePage(pNew, cntNew[i]-j, &apCell[j], &szCell[j]);
drh6019e162001-07-02 17:51:45 +00004116 assert( pNew->nCell>0 );
drh43605152004-05-29 21:46:49 +00004117 assert( pNew->nOverflow==0 );
danielk1977ac11ee62005-01-15 12:45:51 +00004118
4119#ifndef SQLITE_OMIT_AUTOVACUUM
4120 /* If this is an auto-vacuum database, update the pointer map entries
4121 ** that point to the siblings that were rearranged. These can be: left
4122 ** children of cells, the right-child of the page, or overflow pages
4123 ** pointed to by cells.
4124 */
4125 if( pBt->autoVacuum ){
4126 for(k=j; k<cntNew[i]; k++){
4127 if( aFrom[k]==0xFF || apCopy[aFrom[k]]->pgno!=pNew->pgno ){
danielk197779a40da2005-01-16 08:00:01 +00004128 rc = ptrmapPutOvfl(pNew, k-j);
4129 if( rc!=SQLITE_OK ){
4130 goto balance_cleanup;
danielk1977ac11ee62005-01-15 12:45:51 +00004131 }
4132 }
4133 }
4134 }
4135#endif
4136
4137 j = cntNew[i];
4138
4139 /* If the sibling page assembled above was not the right-most sibling,
4140 ** insert a divider cell into the parent page.
4141 */
drh14acc042001-06-10 19:56:58 +00004142 if( i<nNew-1 && j<nCell ){
drh8b18dd42004-05-12 19:18:15 +00004143 u8 *pCell;
drh24cd67e2004-05-10 16:18:47 +00004144 u8 *pTemp;
drh8b18dd42004-05-12 19:18:15 +00004145 int sz;
4146 pCell = apCell[j];
4147 sz = szCell[j] + leafCorrection;
drh4b70f112004-05-02 21:12:19 +00004148 if( !pNew->leaf ){
drh43605152004-05-29 21:46:49 +00004149 memcpy(&pNew->aData[8], pCell, 4);
drh24cd67e2004-05-10 16:18:47 +00004150 pTemp = 0;
drh8b18dd42004-05-12 19:18:15 +00004151 }else if( leafData ){
danielk1977ac11ee62005-01-15 12:45:51 +00004152 /* If the tree is a leaf-data tree, and the siblings are leaves,
4153 ** then there is no divider cell in apCell[]. Instead, the divider
4154 ** cell consists of the integer key for the right-most cell of
4155 ** the sibling-page assembled above only.
4156 */
drh6f11bef2004-05-13 01:12:56 +00004157 CellInfo info;
drh8b18dd42004-05-12 19:18:15 +00004158 j--;
drh43605152004-05-29 21:46:49 +00004159 parseCellPtr(pNew, apCell[j], &info);
drhb6f41482004-05-14 01:58:11 +00004160 pCell = &aSpace[iSpace];
drh6f11bef2004-05-13 01:12:56 +00004161 fillInCell(pParent, pCell, 0, info.nKey, 0, 0, &sz);
drhb6f41482004-05-14 01:58:11 +00004162 iSpace += sz;
drh887dc4c2004-10-22 16:22:57 +00004163 assert( iSpace<=pBt->psAligned*5 );
drh8b18dd42004-05-12 19:18:15 +00004164 pTemp = 0;
drh4b70f112004-05-02 21:12:19 +00004165 }else{
4166 pCell -= 4;
drhb6f41482004-05-14 01:58:11 +00004167 pTemp = &aSpace[iSpace];
4168 iSpace += sz;
drh887dc4c2004-10-22 16:22:57 +00004169 assert( iSpace<=pBt->psAligned*5 );
drh4b70f112004-05-02 21:12:19 +00004170 }
danielk1977a3ad5e72005-01-07 08:56:44 +00004171 rc = insertCell(pParent, nxDiv, pCell, sz, pTemp, 4);
danielk1977e80463b2004-11-03 03:01:16 +00004172 if( rc!=SQLITE_OK ) goto balance_cleanup;
drh43605152004-05-29 21:46:49 +00004173 put4byte(findOverflowCell(pParent,nxDiv), pNew->pgno);
danielk1977ac11ee62005-01-15 12:45:51 +00004174#ifndef SQLITE_OMIT_AUTOVACUUM
4175 /* If this is an auto-vacuum database, and not a leaf-data tree,
4176 ** then update the pointer map with an entry for the overflow page
4177 ** that the cell just inserted points to (if any).
4178 */
4179 if( pBt->autoVacuum && !leafData ){
danielk197779a40da2005-01-16 08:00:01 +00004180 rc = ptrmapPutOvfl(pParent, nxDiv);
4181 if( rc!=SQLITE_OK ){
4182 goto balance_cleanup;
danielk1977ac11ee62005-01-15 12:45:51 +00004183 }
4184 }
4185#endif
drh14acc042001-06-10 19:56:58 +00004186 j++;
4187 nxDiv++;
4188 }
4189 }
drh6019e162001-07-02 17:51:45 +00004190 assert( j==nCell );
drh4b70f112004-05-02 21:12:19 +00004191 if( (pageFlags & PTF_LEAF)==0 ){
drh43605152004-05-29 21:46:49 +00004192 memcpy(&apNew[nNew-1]->aData[8], &apCopy[nOld-1]->aData[8], 4);
drh14acc042001-06-10 19:56:58 +00004193 }
drh43605152004-05-29 21:46:49 +00004194 if( nxDiv==pParent->nCell+pParent->nOverflow ){
drh4b70f112004-05-02 21:12:19 +00004195 /* Right-most sibling is the right-most child of pParent */
drh43605152004-05-29 21:46:49 +00004196 put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew[nNew-1]);
drh4b70f112004-05-02 21:12:19 +00004197 }else{
4198 /* Right-most sibling is the left child of the first entry in pParent
4199 ** past the right-most divider entry */
drh43605152004-05-29 21:46:49 +00004200 put4byte(findOverflowCell(pParent, nxDiv), pgnoNew[nNew-1]);
drh14acc042001-06-10 19:56:58 +00004201 }
4202
4203 /*
4204 ** Reparent children of all cells.
drh8b2f49b2001-06-08 00:21:52 +00004205 */
4206 for(i=0; i<nNew; i++){
danielk1977afcdd022004-10-31 16:25:42 +00004207 rc = reparentChildPages(apNew[i]);
4208 if( rc!=SQLITE_OK ) goto balance_cleanup;
drh8b2f49b2001-06-08 00:21:52 +00004209 }
danielk1977afcdd022004-10-31 16:25:42 +00004210 rc = reparentChildPages(pParent);
4211 if( rc!=SQLITE_OK ) goto balance_cleanup;
drh8b2f49b2001-06-08 00:21:52 +00004212
4213 /*
drh3a4c1412004-05-09 20:40:11 +00004214 ** Balance the parent page. Note that the current page (pPage) might
danielk1977ac11ee62005-01-15 12:45:51 +00004215 ** have been added to the freelist so it might no longer be initialized.
drh3a4c1412004-05-09 20:40:11 +00004216 ** But the parent page will always be initialized.
drh8b2f49b2001-06-08 00:21:52 +00004217 */
drhda200cc2004-05-09 11:51:38 +00004218 assert( pParent->isInit );
drh3a4c1412004-05-09 20:40:11 +00004219 /* assert( pPage->isInit ); // No! pPage might have been added to freelist */
4220 /* pageIntegrity(pPage); // No! pPage might have been added to freelist */
danielk1977ac245ec2005-01-14 13:50:11 +00004221 rc = balance(pParent, 0);
drhda200cc2004-05-09 11:51:38 +00004222
drh8b2f49b2001-06-08 00:21:52 +00004223 /*
drh14acc042001-06-10 19:56:58 +00004224 ** Cleanup before returning.
drh8b2f49b2001-06-08 00:21:52 +00004225 */
drh14acc042001-06-10 19:56:58 +00004226balance_cleanup:
drh2e38c322004-09-03 18:38:44 +00004227 sqliteFree(apCell);
drh8b2f49b2001-06-08 00:21:52 +00004228 for(i=0; i<nOld; i++){
drh91025292004-05-03 19:49:32 +00004229 releasePage(apOld[i]);
drh8b2f49b2001-06-08 00:21:52 +00004230 }
drh14acc042001-06-10 19:56:58 +00004231 for(i=0; i<nNew; i++){
drh91025292004-05-03 19:49:32 +00004232 releasePage(apNew[i]);
drh8b2f49b2001-06-08 00:21:52 +00004233 }
drh91025292004-05-03 19:49:32 +00004234 releasePage(pParent);
drh3a4c1412004-05-09 20:40:11 +00004235 TRACE(("BALANCE: finished with %d: old=%d new=%d cells=%d\n",
4236 pPage->pgno, nOld, nNew, nCell));
drh8b2f49b2001-06-08 00:21:52 +00004237 return rc;
4238}
4239
4240/*
drh43605152004-05-29 21:46:49 +00004241** This routine is called for the root page of a btree when the root
4242** page contains no cells. This is an opportunity to make the tree
4243** shallower by one level.
4244*/
4245static int balance_shallower(MemPage *pPage){
4246 MemPage *pChild; /* The only child page of pPage */
4247 Pgno pgnoChild; /* Page number for pChild */
drh2e38c322004-09-03 18:38:44 +00004248 int rc = SQLITE_OK; /* Return code from subprocedures */
4249 Btree *pBt; /* The main BTree structure */
4250 int mxCellPerPage; /* Maximum number of cells per page */
4251 u8 **apCell; /* All cells from pages being balanced */
4252 int *szCell; /* Local size of all cells */
drh43605152004-05-29 21:46:49 +00004253
4254 assert( pPage->pParent==0 );
4255 assert( pPage->nCell==0 );
drh2e38c322004-09-03 18:38:44 +00004256 pBt = pPage->pBt;
4257 mxCellPerPage = MX_CELL(pBt);
4258 apCell = sqliteMallocRaw( mxCellPerPage*(sizeof(u8*)+sizeof(int)) );
4259 if( apCell==0 ) return SQLITE_NOMEM;
4260 szCell = (int*)&apCell[mxCellPerPage];
drh43605152004-05-29 21:46:49 +00004261 if( pPage->leaf ){
4262 /* The table is completely empty */
4263 TRACE(("BALANCE: empty table %d\n", pPage->pgno));
4264 }else{
4265 /* The root page is empty but has one child. Transfer the
4266 ** information from that one child into the root page if it
4267 ** will fit. This reduces the depth of the tree by one.
4268 **
4269 ** If the root page is page 1, it has less space available than
4270 ** its child (due to the 100 byte header that occurs at the beginning
4271 ** of the database fle), so it might not be able to hold all of the
4272 ** information currently contained in the child. If this is the
4273 ** case, then do not do the transfer. Leave page 1 empty except
4274 ** for the right-pointer to the child page. The child page becomes
4275 ** the virtual root of the tree.
4276 */
4277 pgnoChild = get4byte(&pPage->aData[pPage->hdrOffset+8]);
4278 assert( pgnoChild>0 );
4279 assert( pgnoChild<=sqlite3pager_pagecount(pPage->pBt->pPager) );
4280 rc = getPage(pPage->pBt, pgnoChild, &pChild);
drh2e38c322004-09-03 18:38:44 +00004281 if( rc ) goto end_shallow_balance;
drh43605152004-05-29 21:46:49 +00004282 if( pPage->pgno==1 ){
4283 rc = initPage(pChild, pPage);
drh2e38c322004-09-03 18:38:44 +00004284 if( rc ) goto end_shallow_balance;
drh43605152004-05-29 21:46:49 +00004285 assert( pChild->nOverflow==0 );
4286 if( pChild->nFree>=100 ){
4287 /* The child information will fit on the root page, so do the
4288 ** copy */
4289 int i;
4290 zeroPage(pPage, pChild->aData[0]);
4291 for(i=0; i<pChild->nCell; i++){
4292 apCell[i] = findCell(pChild,i);
4293 szCell[i] = cellSizePtr(pChild, apCell[i]);
4294 }
4295 assemblePage(pPage, pChild->nCell, apCell, szCell);
danielk1977ae825582004-11-23 09:06:55 +00004296 /* Copy the right-pointer of the child to the parent. */
4297 put4byte(&pPage->aData[pPage->hdrOffset+8],
4298 get4byte(&pChild->aData[pChild->hdrOffset+8]));
drh43605152004-05-29 21:46:49 +00004299 freePage(pChild);
4300 TRACE(("BALANCE: child %d transfer to page 1\n", pChild->pgno));
4301 }else{
4302 /* The child has more information that will fit on the root.
4303 ** The tree is already balanced. Do nothing. */
4304 TRACE(("BALANCE: child %d will not fit on page 1\n", pChild->pgno));
4305 }
4306 }else{
4307 memcpy(pPage->aData, pChild->aData, pPage->pBt->usableSize);
4308 pPage->isInit = 0;
4309 pPage->pParent = 0;
4310 rc = initPage(pPage, 0);
4311 assert( rc==SQLITE_OK );
4312 freePage(pChild);
4313 TRACE(("BALANCE: transfer child %d into root %d\n",
4314 pChild->pgno, pPage->pgno));
4315 }
danielk1977afcdd022004-10-31 16:25:42 +00004316 rc = reparentChildPages(pPage);
danielk1977ac11ee62005-01-15 12:45:51 +00004317 assert( pPage->nOverflow==0 );
4318#ifndef SQLITE_OMIT_AUTOVACUUM
4319 if( pBt->autoVacuum ){
danielk1977aac0a382005-01-16 11:07:06 +00004320 int i;
danielk1977ac11ee62005-01-15 12:45:51 +00004321 for(i=0; i<pPage->nCell; i++){
danielk197779a40da2005-01-16 08:00:01 +00004322 rc = ptrmapPutOvfl(pPage, i);
4323 if( rc!=SQLITE_OK ){
4324 goto end_shallow_balance;
danielk1977ac11ee62005-01-15 12:45:51 +00004325 }
4326 }
4327 }
4328#endif
danielk1977afcdd022004-10-31 16:25:42 +00004329 if( rc!=SQLITE_OK ) goto end_shallow_balance;
drh43605152004-05-29 21:46:49 +00004330 releasePage(pChild);
4331 }
drh2e38c322004-09-03 18:38:44 +00004332end_shallow_balance:
4333 sqliteFree(apCell);
4334 return rc;
drh43605152004-05-29 21:46:49 +00004335}
4336
4337
4338/*
4339** The root page is overfull
4340**
4341** When this happens, Create a new child page and copy the
4342** contents of the root into the child. Then make the root
4343** page an empty page with rightChild pointing to the new
4344** child. Finally, call balance_internal() on the new child
4345** to cause it to split.
4346*/
4347static int balance_deeper(MemPage *pPage){
4348 int rc; /* Return value from subprocedures */
4349 MemPage *pChild; /* Pointer to a new child page */
4350 Pgno pgnoChild; /* Page number of the new child page */
4351 Btree *pBt; /* The BTree */
4352 int usableSize; /* Total usable size of a page */
4353 u8 *data; /* Content of the parent page */
4354 u8 *cdata; /* Content of the child page */
4355 int hdr; /* Offset to page header in parent */
4356 int brk; /* Offset to content of first cell in parent */
4357
4358 assert( pPage->pParent==0 );
4359 assert( pPage->nOverflow>0 );
4360 pBt = pPage->pBt;
danielk1977cb1a7eb2004-11-05 12:27:02 +00004361 rc = allocatePage(pBt, &pChild, &pgnoChild, pPage->pgno, 0);
drh43605152004-05-29 21:46:49 +00004362 if( rc ) return rc;
4363 assert( sqlite3pager_iswriteable(pChild->aData) );
4364 usableSize = pBt->usableSize;
4365 data = pPage->aData;
4366 hdr = pPage->hdrOffset;
4367 brk = get2byte(&data[hdr+5]);
4368 cdata = pChild->aData;
4369 memcpy(cdata, &data[hdr], pPage->cellOffset+2*pPage->nCell-hdr);
4370 memcpy(&cdata[brk], &data[brk], usableSize-brk);
danielk1977c7dc7532004-11-17 10:22:03 +00004371 assert( pChild->isInit==0 );
drh43605152004-05-29 21:46:49 +00004372 rc = initPage(pChild, pPage);
4373 if( rc ) return rc;
4374 memcpy(pChild->aOvfl, pPage->aOvfl, pPage->nOverflow*sizeof(pPage->aOvfl[0]));
4375 pChild->nOverflow = pPage->nOverflow;
4376 if( pChild->nOverflow ){
4377 pChild->nFree = 0;
4378 }
4379 assert( pChild->nCell==pPage->nCell );
4380 zeroPage(pPage, pChild->aData[0] & ~PTF_LEAF);
4381 put4byte(&pPage->aData[pPage->hdrOffset+8], pgnoChild);
4382 TRACE(("BALANCE: copy root %d into %d\n", pPage->pgno, pChild->pgno));
danielk19774e17d142005-01-16 09:06:33 +00004383#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977ac11ee62005-01-15 12:45:51 +00004384 if( pBt->autoVacuum ){
4385 int i;
4386 rc = ptrmapPut(pBt, pChild->pgno, PTRMAP_BTREE, pPage->pgno);
4387 if( rc ) return rc;
4388 for(i=0; i<pChild->nCell; i++){
danielk197779a40da2005-01-16 08:00:01 +00004389 rc = ptrmapPutOvfl(pChild, i);
4390 if( rc!=SQLITE_OK ){
4391 return rc;
danielk1977ac11ee62005-01-15 12:45:51 +00004392 }
4393 }
4394 }
danielk19774e17d142005-01-16 09:06:33 +00004395#endif
drh43605152004-05-29 21:46:49 +00004396 rc = balance_nonroot(pChild);
4397 releasePage(pChild);
4398 return rc;
4399}
4400
4401/*
4402** Decide if the page pPage needs to be balanced. If balancing is
4403** required, call the appropriate balancing routine.
4404*/
danielk1977ac245ec2005-01-14 13:50:11 +00004405static int balance(MemPage *pPage, int insert){
drh43605152004-05-29 21:46:49 +00004406 int rc = SQLITE_OK;
4407 if( pPage->pParent==0 ){
4408 if( pPage->nOverflow>0 ){
4409 rc = balance_deeper(pPage);
4410 }
danielk1977687566d2004-11-02 12:56:41 +00004411 if( rc==SQLITE_OK && pPage->nCell==0 ){
drh43605152004-05-29 21:46:49 +00004412 rc = balance_shallower(pPage);
4413 }
4414 }else{
danielk1977ac245ec2005-01-14 13:50:11 +00004415 if( pPage->nOverflow>0 ||
4416 (!insert && pPage->nFree>pPage->pBt->usableSize*2/3) ){
drh43605152004-05-29 21:46:49 +00004417 rc = balance_nonroot(pPage);
4418 }
4419 }
4420 return rc;
4421}
4422
4423/*
drh8dcd7ca2004-08-08 19:43:29 +00004424** This routine checks all cursors that point to table pgnoRoot.
4425** If any of those cursors other than pExclude were opened with
drhf74b8d92002-09-01 23:20:45 +00004426** wrFlag==0 then this routine returns SQLITE_LOCKED. If all
drh8dcd7ca2004-08-08 19:43:29 +00004427** cursors that point to pgnoRoot were opened with wrFlag==1
drhf74b8d92002-09-01 23:20:45 +00004428** then this routine returns SQLITE_OK.
danielk1977299b1872004-11-22 10:02:10 +00004429**
4430** In addition to checking for read-locks (where a read-lock
4431** means a cursor opened with wrFlag==0) this routine also moves
4432** all cursors other than pExclude so that they are pointing to the
4433** first Cell on root page. This is necessary because an insert
4434** or delete might change the number of cells on a page or delete
4435** a page entirely and we do not want to leave any cursors
4436** pointing to non-existant pages or cells.
drhf74b8d92002-09-01 23:20:45 +00004437*/
drh8dcd7ca2004-08-08 19:43:29 +00004438static int checkReadLocks(Btree *pBt, Pgno pgnoRoot, BtCursor *pExclude){
danielk1977299b1872004-11-22 10:02:10 +00004439 BtCursor *p;
4440 for(p=pBt->pCursor; p; p=p->pNext){
4441 if( p->pgnoRoot!=pgnoRoot || p==pExclude ) continue;
4442 if( p->wrFlag==0 ) return SQLITE_LOCKED;
4443 if( p->pPage->pgno!=p->pgnoRoot ){
4444 moveToRoot(p);
4445 }
4446 }
drhf74b8d92002-09-01 23:20:45 +00004447 return SQLITE_OK;
4448}
4449
4450/*
drh3b7511c2001-05-26 13:15:44 +00004451** Insert a new record into the BTree. The key is given by (pKey,nKey)
4452** and the data is given by (pData,nData). The cursor is used only to
drh91025292004-05-03 19:49:32 +00004453** define what table the record should be inserted into. The cursor
drh4b70f112004-05-02 21:12:19 +00004454** is left pointing at a random location.
4455**
4456** For an INTKEY table, only the nKey value of the key is used. pKey is
4457** ignored. For a ZERODATA table, the pData and nData are both ignored.
drh3b7511c2001-05-26 13:15:44 +00004458*/
drh3aac2dd2004-04-26 14:10:20 +00004459int sqlite3BtreeInsert(
drh5c4d9702001-08-20 00:33:58 +00004460 BtCursor *pCur, /* Insert data into the table of this cursor */
drh4a1c3802004-05-12 15:15:47 +00004461 const void *pKey, i64 nKey, /* The key of the new record */
drh5c4d9702001-08-20 00:33:58 +00004462 const void *pData, int nData /* The data of the new record */
drh3b7511c2001-05-26 13:15:44 +00004463){
drh3b7511c2001-05-26 13:15:44 +00004464 int rc;
4465 int loc;
drh14acc042001-06-10 19:56:58 +00004466 int szNew;
drh3b7511c2001-05-26 13:15:44 +00004467 MemPage *pPage;
4468 Btree *pBt = pCur->pBt;
drha34b6762004-05-07 13:30:42 +00004469 unsigned char *oldCell;
drh2e38c322004-09-03 18:38:44 +00004470 unsigned char *newCell = 0;
drh3b7511c2001-05-26 13:15:44 +00004471
danielk1977ee5741e2004-05-31 10:01:34 +00004472 if( pBt->inTrans!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00004473 /* Must start a transaction before doing an insert */
4474 return pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drh8b2f49b2001-06-08 00:21:52 +00004475 }
drhf74b8d92002-09-01 23:20:45 +00004476 assert( !pBt->readOnly );
drhecdc7532001-09-23 02:35:53 +00004477 if( !pCur->wrFlag ){
4478 return SQLITE_PERM; /* Cursor not open for writing */
4479 }
drh8dcd7ca2004-08-08 19:43:29 +00004480 if( checkReadLocks(pBt, pCur->pgnoRoot, pCur) ){
drhf74b8d92002-09-01 23:20:45 +00004481 return SQLITE_LOCKED; /* The table pCur points to has a read lock */
4482 }
drh3aac2dd2004-04-26 14:10:20 +00004483 rc = sqlite3BtreeMoveto(pCur, pKey, nKey, &loc);
drh3b7511c2001-05-26 13:15:44 +00004484 if( rc ) return rc;
drh14acc042001-06-10 19:56:58 +00004485 pPage = pCur->pPage;
drh4a1c3802004-05-12 15:15:47 +00004486 assert( pPage->intKey || nKey>=0 );
drh8b18dd42004-05-12 19:18:15 +00004487 assert( pPage->leaf || !pPage->leafData );
drh3a4c1412004-05-09 20:40:11 +00004488 TRACE(("INSERT: table=%d nkey=%lld ndata=%d page=%d %s\n",
4489 pCur->pgnoRoot, nKey, nData, pPage->pgno,
4490 loc==0 ? "overwrite" : "new entry"));
drh7aa128d2002-06-21 13:09:16 +00004491 assert( pPage->isInit );
drha34b6762004-05-07 13:30:42 +00004492 rc = sqlite3pager_write(pPage->aData);
drhbd03cae2001-06-02 02:40:57 +00004493 if( rc ) return rc;
drh2e38c322004-09-03 18:38:44 +00004494 newCell = sqliteMallocRaw( MX_CELL_SIZE(pBt) );
4495 if( newCell==0 ) return SQLITE_NOMEM;
drha34b6762004-05-07 13:30:42 +00004496 rc = fillInCell(pPage, newCell, pKey, nKey, pData, nData, &szNew);
drh2e38c322004-09-03 18:38:44 +00004497 if( rc ) goto end_insert;
drh43605152004-05-29 21:46:49 +00004498 assert( szNew==cellSizePtr(pPage, newCell) );
drh2e38c322004-09-03 18:38:44 +00004499 assert( szNew<=MX_CELL_SIZE(pBt) );
drhf328bc82004-05-10 23:29:49 +00004500 if( loc==0 && pCur->isValid ){
drha34b6762004-05-07 13:30:42 +00004501 int szOld;
4502 assert( pCur->idx>=0 && pCur->idx<pPage->nCell );
drh43605152004-05-29 21:46:49 +00004503 oldCell = findCell(pPage, pCur->idx);
drh4b70f112004-05-02 21:12:19 +00004504 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00004505 memcpy(newCell, oldCell, 4);
drh4b70f112004-05-02 21:12:19 +00004506 }
drh43605152004-05-29 21:46:49 +00004507 szOld = cellSizePtr(pPage, oldCell);
drh4b70f112004-05-02 21:12:19 +00004508 rc = clearCell(pPage, oldCell);
drh2e38c322004-09-03 18:38:44 +00004509 if( rc ) goto end_insert;
drh4b70f112004-05-02 21:12:19 +00004510 dropCell(pPage, pCur->idx, szOld);
drh7c717f72001-06-24 20:39:41 +00004511 }else if( loc<0 && pPage->nCell>0 ){
drh4b70f112004-05-02 21:12:19 +00004512 assert( pPage->leaf );
drh14acc042001-06-10 19:56:58 +00004513 pCur->idx++;
drh271efa52004-05-30 19:19:05 +00004514 pCur->info.nSize = 0;
drh14acc042001-06-10 19:56:58 +00004515 }else{
drh4b70f112004-05-02 21:12:19 +00004516 assert( pPage->leaf );
drh3b7511c2001-05-26 13:15:44 +00004517 }
danielk1977a3ad5e72005-01-07 08:56:44 +00004518 rc = insertCell(pPage, pCur->idx, newCell, szNew, 0, 0);
danielk1977e80463b2004-11-03 03:01:16 +00004519 if( rc!=SQLITE_OK ) goto end_insert;
danielk1977ac245ec2005-01-14 13:50:11 +00004520 rc = balance(pPage, 1);
drh23e11ca2004-05-04 17:27:28 +00004521 /* sqlite3BtreePageDump(pCur->pBt, pCur->pgnoRoot, 1); */
drh3fc190c2001-09-14 03:24:23 +00004522 /* fflush(stdout); */
danielk1977299b1872004-11-22 10:02:10 +00004523 if( rc==SQLITE_OK ){
4524 moveToRoot(pCur);
4525 }
drh2e38c322004-09-03 18:38:44 +00004526end_insert:
4527 sqliteFree(newCell);
drh5e2f8b92001-05-28 00:41:15 +00004528 return rc;
4529}
4530
4531/*
drh4b70f112004-05-02 21:12:19 +00004532** Delete the entry that the cursor is pointing to. The cursor
4533** is left pointing at a random location.
drh3b7511c2001-05-26 13:15:44 +00004534*/
drh3aac2dd2004-04-26 14:10:20 +00004535int sqlite3BtreeDelete(BtCursor *pCur){
drh5e2f8b92001-05-28 00:41:15 +00004536 MemPage *pPage = pCur->pPage;
drh4b70f112004-05-02 21:12:19 +00004537 unsigned char *pCell;
drh5e2f8b92001-05-28 00:41:15 +00004538 int rc;
danielk1977cfe9a692004-06-16 12:00:29 +00004539 Pgno pgnoChild = 0;
drh0d316a42002-08-11 20:10:47 +00004540 Btree *pBt = pCur->pBt;
drh8b2f49b2001-06-08 00:21:52 +00004541
drh7aa128d2002-06-21 13:09:16 +00004542 assert( pPage->isInit );
danielk1977ee5741e2004-05-31 10:01:34 +00004543 if( pBt->inTrans!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00004544 /* Must start a transaction before doing a delete */
4545 return pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drh8b2f49b2001-06-08 00:21:52 +00004546 }
drhf74b8d92002-09-01 23:20:45 +00004547 assert( !pBt->readOnly );
drhbd03cae2001-06-02 02:40:57 +00004548 if( pCur->idx >= pPage->nCell ){
4549 return SQLITE_ERROR; /* The cursor is not pointing to anything */
4550 }
drhecdc7532001-09-23 02:35:53 +00004551 if( !pCur->wrFlag ){
4552 return SQLITE_PERM; /* Did not open this cursor for writing */
4553 }
drh8dcd7ca2004-08-08 19:43:29 +00004554 if( checkReadLocks(pBt, pCur->pgnoRoot, pCur) ){
drhf74b8d92002-09-01 23:20:45 +00004555 return SQLITE_LOCKED; /* The table pCur points to has a read lock */
4556 }
drha34b6762004-05-07 13:30:42 +00004557 rc = sqlite3pager_write(pPage->aData);
drhbd03cae2001-06-02 02:40:57 +00004558 if( rc ) return rc;
danielk1977e6efa742004-11-10 11:55:10 +00004559
4560 /* Locate the cell within it's page and leave pCell pointing to the
4561 ** data. The clearCell() call frees any overflow pages associated with the
4562 ** cell. The cell itself is still intact.
4563 */
danielk1977299b1872004-11-22 10:02:10 +00004564 pCell = findCell(pPage, pCur->idx);
drh4b70f112004-05-02 21:12:19 +00004565 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00004566 pgnoChild = get4byte(pCell);
drh4b70f112004-05-02 21:12:19 +00004567 }
danielk197728129562005-01-11 10:25:06 +00004568 rc = clearCell(pPage, pCell);
4569 if( rc ) return rc;
danielk1977e6efa742004-11-10 11:55:10 +00004570
drh4b70f112004-05-02 21:12:19 +00004571 if( !pPage->leaf ){
drh14acc042001-06-10 19:56:58 +00004572 /*
drh5e00f6c2001-09-13 13:46:56 +00004573 ** The entry we are about to delete is not a leaf so if we do not
drh9ca7d3b2001-06-28 11:50:21 +00004574 ** do something we will leave a hole on an internal page.
4575 ** We have to fill the hole by moving in a cell from a leaf. The
4576 ** next Cell after the one to be deleted is guaranteed to exist and
danielk1977299b1872004-11-22 10:02:10 +00004577 ** to be a leaf so we can use it.
drh5e2f8b92001-05-28 00:41:15 +00004578 */
drh14acc042001-06-10 19:56:58 +00004579 BtCursor leafCur;
drh4b70f112004-05-02 21:12:19 +00004580 unsigned char *pNext;
drh14acc042001-06-10 19:56:58 +00004581 int szNext;
danielk1977299b1872004-11-22 10:02:10 +00004582 int notUsed;
drh2e38c322004-09-03 18:38:44 +00004583 unsigned char *tempCell;
drh8b18dd42004-05-12 19:18:15 +00004584 assert( !pPage->leafData );
drh14acc042001-06-10 19:56:58 +00004585 getTempCursor(pCur, &leafCur);
danielk1977299b1872004-11-22 10:02:10 +00004586 rc = sqlite3BtreeNext(&leafCur, &notUsed);
drh14acc042001-06-10 19:56:58 +00004587 if( rc!=SQLITE_OK ){
drhee696e22004-08-30 16:52:17 +00004588 if( rc!=SQLITE_NOMEM ){
4589 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
4590 }
danielk1977299b1872004-11-22 10:02:10 +00004591 return rc;
drh5e2f8b92001-05-28 00:41:15 +00004592 }
drha34b6762004-05-07 13:30:42 +00004593 rc = sqlite3pager_write(leafCur.pPage->aData);
danielk1977299b1872004-11-22 10:02:10 +00004594 if( rc ) return rc;
4595 TRACE(("DELETE: table=%d delete internal from %d replace from leaf %d\n",
4596 pCur->pgnoRoot, pPage->pgno, leafCur.pPage->pgno));
4597 dropCell(pPage, pCur->idx, cellSizePtr(pPage, pCell));
drh43605152004-05-29 21:46:49 +00004598 pNext = findCell(leafCur.pPage, leafCur.idx);
4599 szNext = cellSizePtr(leafCur.pPage, pNext);
drh2e38c322004-09-03 18:38:44 +00004600 assert( MX_CELL_SIZE(pBt)>=szNext+4 );
4601 tempCell = sqliteMallocRaw( MX_CELL_SIZE(pBt) );
danielk1977299b1872004-11-22 10:02:10 +00004602 if( tempCell==0 ) return SQLITE_NOMEM;
danielk1977a3ad5e72005-01-07 08:56:44 +00004603 rc = insertCell(pPage, pCur->idx, pNext-4, szNext+4, tempCell, 0);
danielk1977299b1872004-11-22 10:02:10 +00004604 if( rc!=SQLITE_OK ) return rc;
4605 put4byte(findOverflowCell(pPage, pCur->idx), pgnoChild);
danielk1977ac245ec2005-01-14 13:50:11 +00004606 rc = balance(pPage, 0);
drh2e38c322004-09-03 18:38:44 +00004607 sqliteFree(tempCell);
danielk1977299b1872004-11-22 10:02:10 +00004608 if( rc ) return rc;
drh4b70f112004-05-02 21:12:19 +00004609 dropCell(leafCur.pPage, leafCur.idx, szNext);
danielk1977ac245ec2005-01-14 13:50:11 +00004610 rc = balance(leafCur.pPage, 0);
drh8c42ca92001-06-22 19:15:00 +00004611 releaseTempCursor(&leafCur);
drh5e2f8b92001-05-28 00:41:15 +00004612 }else{
danielk1977299b1872004-11-22 10:02:10 +00004613 TRACE(("DELETE: table=%d delete from leaf %d\n",
4614 pCur->pgnoRoot, pPage->pgno));
4615 dropCell(pPage, pCur->idx, cellSizePtr(pPage, pCell));
danielk1977ac245ec2005-01-14 13:50:11 +00004616 rc = balance(pPage, 0);
drh5e2f8b92001-05-28 00:41:15 +00004617 }
danielk1977299b1872004-11-22 10:02:10 +00004618 moveToRoot(pCur);
drh5e2f8b92001-05-28 00:41:15 +00004619 return rc;
drh3b7511c2001-05-26 13:15:44 +00004620}
drh8b2f49b2001-06-08 00:21:52 +00004621
4622/*
drhc6b52df2002-01-04 03:09:29 +00004623** Create a new BTree table. Write into *piTable the page
4624** number for the root page of the new table.
4625**
drhab01f612004-05-22 02:55:23 +00004626** The type of type is determined by the flags parameter. Only the
4627** following values of flags are currently in use. Other values for
4628** flags might not work:
4629**
4630** BTREE_INTKEY|BTREE_LEAFDATA Used for SQL tables with rowid keys
4631** BTREE_ZERODATA Used for SQL indices
drh8b2f49b2001-06-08 00:21:52 +00004632*/
drh3aac2dd2004-04-26 14:10:20 +00004633int sqlite3BtreeCreateTable(Btree *pBt, int *piTable, int flags){
drh8b2f49b2001-06-08 00:21:52 +00004634 MemPage *pRoot;
4635 Pgno pgnoRoot;
4636 int rc;
danielk1977ee5741e2004-05-31 10:01:34 +00004637 if( pBt->inTrans!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00004638 /* Must start a transaction first */
4639 return pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drh8b2f49b2001-06-08 00:21:52 +00004640 }
danielk197728129562005-01-11 10:25:06 +00004641 assert( !pBt->readOnly );
danielk1977e6efa742004-11-10 11:55:10 +00004642
4643 /* It is illegal to create a table if any cursors are open on the
4644 ** database. This is because in auto-vacuum mode the backend may
4645 ** need to move a database page to make room for the new root-page.
4646 ** If an open cursor was using the page a problem would occur.
4647 */
4648 if( pBt->pCursor ){
4649 return SQLITE_LOCKED;
4650 }
4651
danielk1977003ba062004-11-04 02:57:33 +00004652#ifdef SQLITE_OMIT_AUTOVACUUM
danielk1977cb1a7eb2004-11-05 12:27:02 +00004653 rc = allocatePage(pBt, &pRoot, &pgnoRoot, 1, 0);
drh8b2f49b2001-06-08 00:21:52 +00004654 if( rc ) return rc;
danielk1977003ba062004-11-04 02:57:33 +00004655#else
danielk1977687566d2004-11-02 12:56:41 +00004656 if( pBt->autoVacuum ){
danielk1977003ba062004-11-04 02:57:33 +00004657 Pgno pgnoMove; /* Move a page here to make room for the root-page */
4658 MemPage *pPageMove; /* The page to move to. */
4659
danielk1977003ba062004-11-04 02:57:33 +00004660 /* Read the value of meta[3] from the database to determine where the
4661 ** root page of the new table should go. meta[3] is the largest root-page
4662 ** created so far, so the new root-page is (meta[3]+1).
4663 */
4664 rc = sqlite3BtreeGetMeta(pBt, 4, &pgnoRoot);
4665 if( rc!=SQLITE_OK ) return rc;
4666 pgnoRoot++;
4667
danielk1977599fcba2004-11-08 07:13:13 +00004668 /* The new root-page may not be allocated on a pointer-map page, or the
4669 ** PENDING_BYTE page.
4670 */
drh42cac6d2004-11-20 20:31:11 +00004671 if( pgnoRoot==PTRMAP_PAGENO(pBt->usableSize, pgnoRoot) ||
danielk1977599fcba2004-11-08 07:13:13 +00004672 pgnoRoot==PENDING_BYTE_PAGE(pBt) ){
danielk1977003ba062004-11-04 02:57:33 +00004673 pgnoRoot++;
4674 }
4675 assert( pgnoRoot>=3 );
4676
4677 /* Allocate a page. The page that currently resides at pgnoRoot will
4678 ** be moved to the allocated page (unless the allocated page happens
4679 ** to reside at pgnoRoot).
4680 */
danielk1977cb1a7eb2004-11-05 12:27:02 +00004681 rc = allocatePage(pBt, &pPageMove, &pgnoMove, pgnoRoot, 1);
danielk1977003ba062004-11-04 02:57:33 +00004682 if( rc!=SQLITE_OK ){
danielk1977687566d2004-11-02 12:56:41 +00004683 return rc;
4684 }
danielk1977003ba062004-11-04 02:57:33 +00004685
4686 if( pgnoMove!=pgnoRoot ){
4687 u8 eType;
4688 Pgno iPtrPage;
4689
4690 releasePage(pPageMove);
4691 rc = getPage(pBt, pgnoRoot, &pRoot);
4692 if( rc!=SQLITE_OK ){
4693 return rc;
4694 }
4695 rc = ptrmapGet(pBt, pgnoRoot, &eType, &iPtrPage);
drhccae6022005-02-26 17:31:26 +00004696 if( rc!=SQLITE_OK || eType==PTRMAP_ROOTPAGE || eType==PTRMAP_FREEPAGE ){
danielk1977003ba062004-11-04 02:57:33 +00004697 releasePage(pRoot);
4698 return rc;
4699 }
drhccae6022005-02-26 17:31:26 +00004700 assert( eType!=PTRMAP_ROOTPAGE );
4701 assert( eType!=PTRMAP_FREEPAGE );
danielk1977003ba062004-11-04 02:57:33 +00004702 rc = relocatePage(pBt, pRoot, eType, iPtrPage, pgnoMove);
4703 releasePage(pRoot);
4704 if( rc!=SQLITE_OK ){
4705 return rc;
4706 }
4707 rc = getPage(pBt, pgnoRoot, &pRoot);
4708 if( rc!=SQLITE_OK ){
4709 return rc;
4710 }
4711 rc = sqlite3pager_write(pRoot->aData);
4712 if( rc!=SQLITE_OK ){
4713 releasePage(pRoot);
4714 return rc;
4715 }
4716 }else{
4717 pRoot = pPageMove;
4718 }
4719
danielk197742741be2005-01-08 12:42:39 +00004720 /* Update the pointer-map and meta-data with the new root-page number. */
danielk1977003ba062004-11-04 02:57:33 +00004721 rc = ptrmapPut(pBt, pgnoRoot, PTRMAP_ROOTPAGE, 0);
4722 if( rc ){
4723 releasePage(pRoot);
4724 return rc;
4725 }
4726 rc = sqlite3BtreeUpdateMeta(pBt, 4, pgnoRoot);
4727 if( rc ){
4728 releasePage(pRoot);
4729 return rc;
4730 }
danielk197742741be2005-01-08 12:42:39 +00004731
danielk1977003ba062004-11-04 02:57:33 +00004732 }else{
danielk1977cb1a7eb2004-11-05 12:27:02 +00004733 rc = allocatePage(pBt, &pRoot, &pgnoRoot, 1, 0);
danielk1977003ba062004-11-04 02:57:33 +00004734 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00004735 }
4736#endif
drha34b6762004-05-07 13:30:42 +00004737 assert( sqlite3pager_iswriteable(pRoot->aData) );
drhde647132004-05-07 17:57:49 +00004738 zeroPage(pRoot, flags | PTF_LEAF);
drha34b6762004-05-07 13:30:42 +00004739 sqlite3pager_unref(pRoot->aData);
drh8b2f49b2001-06-08 00:21:52 +00004740 *piTable = (int)pgnoRoot;
4741 return SQLITE_OK;
4742}
4743
4744/*
4745** Erase the given database page and all its children. Return
4746** the page to the freelist.
4747*/
drh4b70f112004-05-02 21:12:19 +00004748static int clearDatabasePage(
4749 Btree *pBt, /* The BTree that contains the table */
4750 Pgno pgno, /* Page number to clear */
4751 MemPage *pParent, /* Parent page. NULL for the root */
4752 int freePageFlag /* Deallocate page if true */
4753){
drh8b2f49b2001-06-08 00:21:52 +00004754 MemPage *pPage;
4755 int rc;
drh4b70f112004-05-02 21:12:19 +00004756 unsigned char *pCell;
4757 int i;
drh8b2f49b2001-06-08 00:21:52 +00004758
danielk1977a1cb1832005-02-12 08:59:55 +00004759 if( pgno>sqlite3pager_pagecount(pBt->pPager) ){
4760 return SQLITE_CORRUPT;
4761 }
4762
drhde647132004-05-07 17:57:49 +00004763 rc = getAndInitPage(pBt, pgno, &pPage, pParent);
drh8b2f49b2001-06-08 00:21:52 +00004764 if( rc ) return rc;
drha34b6762004-05-07 13:30:42 +00004765 rc = sqlite3pager_write(pPage->aData);
drh6019e162001-07-02 17:51:45 +00004766 if( rc ) return rc;
drh4b70f112004-05-02 21:12:19 +00004767 for(i=0; i<pPage->nCell; i++){
drh43605152004-05-29 21:46:49 +00004768 pCell = findCell(pPage, i);
drh4b70f112004-05-02 21:12:19 +00004769 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00004770 rc = clearDatabasePage(pBt, get4byte(pCell), pPage->pParent, 1);
drh8b2f49b2001-06-08 00:21:52 +00004771 if( rc ) return rc;
4772 }
drh4b70f112004-05-02 21:12:19 +00004773 rc = clearCell(pPage, pCell);
drh8b2f49b2001-06-08 00:21:52 +00004774 if( rc ) return rc;
4775 }
drha34b6762004-05-07 13:30:42 +00004776 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00004777 rc = clearDatabasePage(pBt, get4byte(&pPage->aData[8]), pPage->pParent, 1);
drh2aa679f2001-06-25 02:11:07 +00004778 if( rc ) return rc;
4779 }
4780 if( freePageFlag ){
drh4b70f112004-05-02 21:12:19 +00004781 rc = freePage(pPage);
drh2aa679f2001-06-25 02:11:07 +00004782 }else{
drh3a4c1412004-05-09 20:40:11 +00004783 zeroPage(pPage, pPage->aData[0] | PTF_LEAF);
drh2aa679f2001-06-25 02:11:07 +00004784 }
drh4b70f112004-05-02 21:12:19 +00004785 releasePage(pPage);
drh2aa679f2001-06-25 02:11:07 +00004786 return rc;
drh8b2f49b2001-06-08 00:21:52 +00004787}
4788
4789/*
drhab01f612004-05-22 02:55:23 +00004790** Delete all information from a single table in the database. iTable is
4791** the page number of the root of the table. After this routine returns,
4792** the root page is empty, but still exists.
4793**
4794** This routine will fail with SQLITE_LOCKED if there are any open
4795** read cursors on the table. Open write cursors are moved to the
4796** root of the table.
drh8b2f49b2001-06-08 00:21:52 +00004797*/
drh3aac2dd2004-04-26 14:10:20 +00004798int sqlite3BtreeClearTable(Btree *pBt, int iTable){
drh8b2f49b2001-06-08 00:21:52 +00004799 int rc;
drhf74b8d92002-09-01 23:20:45 +00004800 BtCursor *pCur;
danielk1977ee5741e2004-05-31 10:01:34 +00004801 if( pBt->inTrans!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00004802 return pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drh8b2f49b2001-06-08 00:21:52 +00004803 }
drhf74b8d92002-09-01 23:20:45 +00004804 for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
4805 if( pCur->pgnoRoot==(Pgno)iTable ){
4806 if( pCur->wrFlag==0 ) return SQLITE_LOCKED;
4807 moveToRoot(pCur);
4808 }
drhecdc7532001-09-23 02:35:53 +00004809 }
drha34b6762004-05-07 13:30:42 +00004810 rc = clearDatabasePage(pBt, (Pgno)iTable, 0, 0);
drh8b2f49b2001-06-08 00:21:52 +00004811 if( rc ){
drh3aac2dd2004-04-26 14:10:20 +00004812 sqlite3BtreeRollback(pBt);
drh8b2f49b2001-06-08 00:21:52 +00004813 }
drh8c42ca92001-06-22 19:15:00 +00004814 return rc;
drh8b2f49b2001-06-08 00:21:52 +00004815}
4816
4817/*
4818** Erase all information in a table and add the root of the table to
4819** the freelist. Except, the root of the principle table (the one on
drhab01f612004-05-22 02:55:23 +00004820** page 1) is never added to the freelist.
4821**
4822** This routine will fail with SQLITE_LOCKED if there are any open
4823** cursors on the table.
drh205f48e2004-11-05 00:43:11 +00004824**
4825** If AUTOVACUUM is enabled and the page at iTable is not the last
4826** root page in the database file, then the last root page
4827** in the database file is moved into the slot formerly occupied by
4828** iTable and that last slot formerly occupied by the last root page
4829** is added to the freelist instead of iTable. In this say, all
4830** root pages are kept at the beginning of the database file, which
4831** is necessary for AUTOVACUUM to work right. *piMoved is set to the
4832** page number that used to be the last root page in the file before
4833** the move. If no page gets moved, *piMoved is set to 0.
4834** The last root page is recorded in meta[3] and the value of
4835** meta[3] is updated by this procedure.
drh8b2f49b2001-06-08 00:21:52 +00004836*/
danielk1977a0bf2652004-11-04 14:30:04 +00004837int sqlite3BtreeDropTable(Btree *pBt, int iTable, int *piMoved){
drh8b2f49b2001-06-08 00:21:52 +00004838 int rc;
danielk1977a0bf2652004-11-04 14:30:04 +00004839 MemPage *pPage = 0;
danielk1977a0bf2652004-11-04 14:30:04 +00004840
danielk1977ee5741e2004-05-31 10:01:34 +00004841 if( pBt->inTrans!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00004842 return pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drh8b2f49b2001-06-08 00:21:52 +00004843 }
danielk1977a0bf2652004-11-04 14:30:04 +00004844
danielk1977e6efa742004-11-10 11:55:10 +00004845 /* It is illegal to drop a table if any cursors are open on the
4846 ** database. This is because in auto-vacuum mode the backend may
4847 ** need to move another root-page to fill a gap left by the deleted
4848 ** root page. If an open cursor was using this page a problem would
4849 ** occur.
4850 */
4851 if( pBt->pCursor ){
4852 return SQLITE_LOCKED;
drh5df72a52002-06-06 23:16:05 +00004853 }
danielk1977a0bf2652004-11-04 14:30:04 +00004854
drha34b6762004-05-07 13:30:42 +00004855 rc = getPage(pBt, (Pgno)iTable, &pPage);
drh2aa679f2001-06-25 02:11:07 +00004856 if( rc ) return rc;
drh3aac2dd2004-04-26 14:10:20 +00004857 rc = sqlite3BtreeClearTable(pBt, iTable);
drh2aa679f2001-06-25 02:11:07 +00004858 if( rc ) return rc;
danielk1977a0bf2652004-11-04 14:30:04 +00004859
drh205f48e2004-11-05 00:43:11 +00004860 *piMoved = 0;
danielk1977a0bf2652004-11-04 14:30:04 +00004861
drh4b70f112004-05-02 21:12:19 +00004862 if( iTable>1 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004863#ifdef SQLITE_OMIT_AUTOVACUUM
drha34b6762004-05-07 13:30:42 +00004864 rc = freePage(pPage);
danielk1977a0bf2652004-11-04 14:30:04 +00004865 releasePage(pPage);
4866#else
4867 if( pBt->autoVacuum ){
4868 Pgno maxRootPgno;
4869 rc = sqlite3BtreeGetMeta(pBt, 4, &maxRootPgno);
4870 if( rc!=SQLITE_OK ){
4871 releasePage(pPage);
4872 return rc;
4873 }
4874
4875 if( iTable==maxRootPgno ){
4876 /* If the table being dropped is the table with the largest root-page
4877 ** number in the database, put the root page on the free list.
4878 */
4879 rc = freePage(pPage);
4880 releasePage(pPage);
4881 if( rc!=SQLITE_OK ){
4882 return rc;
4883 }
4884 }else{
4885 /* The table being dropped does not have the largest root-page
4886 ** number in the database. So move the page that does into the
4887 ** gap left by the deleted root-page.
4888 */
4889 MemPage *pMove;
4890 releasePage(pPage);
4891 rc = getPage(pBt, maxRootPgno, &pMove);
4892 if( rc!=SQLITE_OK ){
4893 return rc;
4894 }
4895 rc = relocatePage(pBt, pMove, PTRMAP_ROOTPAGE, 0, iTable);
4896 releasePage(pMove);
4897 if( rc!=SQLITE_OK ){
4898 return rc;
4899 }
4900 rc = getPage(pBt, maxRootPgno, &pMove);
4901 if( rc!=SQLITE_OK ){
4902 return rc;
4903 }
4904 rc = freePage(pMove);
4905 releasePage(pMove);
4906 if( rc!=SQLITE_OK ){
4907 return rc;
4908 }
4909 *piMoved = maxRootPgno;
4910 }
4911
danielk1977599fcba2004-11-08 07:13:13 +00004912 /* Set the new 'max-root-page' value in the database header. This
4913 ** is the old value less one, less one more if that happens to
4914 ** be a root-page number, less one again if that is the
4915 ** PENDING_BYTE_PAGE.
4916 */
danielk197787a6e732004-11-05 12:58:25 +00004917 maxRootPgno--;
danielk1977599fcba2004-11-08 07:13:13 +00004918 if( maxRootPgno==PENDING_BYTE_PAGE(pBt) ){
4919 maxRootPgno--;
4920 }
drh42cac6d2004-11-20 20:31:11 +00004921 if( maxRootPgno==PTRMAP_PAGENO(pBt->usableSize, maxRootPgno) ){
danielk197787a6e732004-11-05 12:58:25 +00004922 maxRootPgno--;
4923 }
danielk1977599fcba2004-11-08 07:13:13 +00004924 assert( maxRootPgno!=PENDING_BYTE_PAGE(pBt) );
4925
danielk197787a6e732004-11-05 12:58:25 +00004926 rc = sqlite3BtreeUpdateMeta(pBt, 4, maxRootPgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004927 }else{
4928 rc = freePage(pPage);
4929 releasePage(pPage);
4930 }
4931#endif
drh2aa679f2001-06-25 02:11:07 +00004932 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004933 /* If sqlite3BtreeDropTable was called on page 1. */
drha34b6762004-05-07 13:30:42 +00004934 zeroPage(pPage, PTF_INTKEY|PTF_LEAF );
danielk1977a0bf2652004-11-04 14:30:04 +00004935 releasePage(pPage);
drh8b2f49b2001-06-08 00:21:52 +00004936 }
drh8b2f49b2001-06-08 00:21:52 +00004937 return rc;
4938}
4939
drh001bbcb2003-03-19 03:14:00 +00004940
drh8b2f49b2001-06-08 00:21:52 +00004941/*
drh23e11ca2004-05-04 17:27:28 +00004942** Read the meta-information out of a database file. Meta[0]
4943** is the number of free pages currently in the database. Meta[1]
drha3b321d2004-05-11 09:31:31 +00004944** through meta[15] are available for use by higher layers. Meta[0]
4945** is read-only, the others are read/write.
4946**
4947** The schema layer numbers meta values differently. At the schema
4948** layer (and the SetCookie and ReadCookie opcodes) the number of
4949** free pages is not visible. So Cookie[0] is the same as Meta[1].
drh8b2f49b2001-06-08 00:21:52 +00004950*/
drh3aac2dd2004-04-26 14:10:20 +00004951int sqlite3BtreeGetMeta(Btree *pBt, int idx, u32 *pMeta){
drh8b2f49b2001-06-08 00:21:52 +00004952 int rc;
drh4b70f112004-05-02 21:12:19 +00004953 unsigned char *pP1;
drh8b2f49b2001-06-08 00:21:52 +00004954
drh23e11ca2004-05-04 17:27:28 +00004955 assert( idx>=0 && idx<=15 );
drha34b6762004-05-07 13:30:42 +00004956 rc = sqlite3pager_get(pBt->pPager, 1, (void**)&pP1);
drh8b2f49b2001-06-08 00:21:52 +00004957 if( rc ) return rc;
drh23e11ca2004-05-04 17:27:28 +00004958 *pMeta = get4byte(&pP1[36 + idx*4]);
drha34b6762004-05-07 13:30:42 +00004959 sqlite3pager_unref(pP1);
drhae157872004-08-14 19:20:09 +00004960
danielk1977599fcba2004-11-08 07:13:13 +00004961 /* If autovacuumed is disabled in this build but we are trying to
4962 ** access an autovacuumed database, then make the database readonly.
4963 */
danielk1977003ba062004-11-04 02:57:33 +00004964#ifdef SQLITE_OMIT_AUTOVACUUM
drhae157872004-08-14 19:20:09 +00004965 if( idx==4 && *pMeta>0 ) pBt->readOnly = 1;
danielk1977003ba062004-11-04 02:57:33 +00004966#endif
drhae157872004-08-14 19:20:09 +00004967
drh8b2f49b2001-06-08 00:21:52 +00004968 return SQLITE_OK;
4969}
4970
4971/*
drh23e11ca2004-05-04 17:27:28 +00004972** Write meta-information back into the database. Meta[0] is
4973** read-only and may not be written.
drh8b2f49b2001-06-08 00:21:52 +00004974*/
drh3aac2dd2004-04-26 14:10:20 +00004975int sqlite3BtreeUpdateMeta(Btree *pBt, int idx, u32 iMeta){
drh4b70f112004-05-02 21:12:19 +00004976 unsigned char *pP1;
drha34b6762004-05-07 13:30:42 +00004977 int rc;
drh23e11ca2004-05-04 17:27:28 +00004978 assert( idx>=1 && idx<=15 );
danielk1977ee5741e2004-05-31 10:01:34 +00004979 if( pBt->inTrans!=TRANS_WRITE ){
drhf74b8d92002-09-01 23:20:45 +00004980 return pBt->readOnly ? SQLITE_READONLY : SQLITE_ERROR;
drh5df72a52002-06-06 23:16:05 +00004981 }
drhde647132004-05-07 17:57:49 +00004982 assert( pBt->pPage1!=0 );
4983 pP1 = pBt->pPage1->aData;
drha34b6762004-05-07 13:30:42 +00004984 rc = sqlite3pager_write(pP1);
drh4b70f112004-05-02 21:12:19 +00004985 if( rc ) return rc;
drh23e11ca2004-05-04 17:27:28 +00004986 put4byte(&pP1[36 + idx*4], iMeta);
drh8b2f49b2001-06-08 00:21:52 +00004987 return SQLITE_OK;
4988}
drh8c42ca92001-06-22 19:15:00 +00004989
drhf328bc82004-05-10 23:29:49 +00004990/*
4991** Return the flag byte at the beginning of the page that the cursor
4992** is currently pointing to.
4993*/
4994int sqlite3BtreeFlags(BtCursor *pCur){
4995 MemPage *pPage = pCur->pPage;
4996 return pPage ? pPage->aData[pPage->hdrOffset] : 0;
4997}
4998
danielk1977b5402fb2005-01-12 07:15:04 +00004999#ifdef SQLITE_DEBUG
drh8c42ca92001-06-22 19:15:00 +00005000/*
5001** Print a disassembly of the given page on standard output. This routine
5002** is used for debugging and testing only.
5003*/
danielk1977c7dc7532004-11-17 10:22:03 +00005004static int btreePageDump(Btree *pBt, int pgno, int recursive, MemPage *pParent){
drh8c42ca92001-06-22 19:15:00 +00005005 int rc;
5006 MemPage *pPage;
drhc8629a12004-05-08 20:07:40 +00005007 int i, j, c;
drh8c42ca92001-06-22 19:15:00 +00005008 int nFree;
5009 u16 idx;
drhab9f7f12004-05-08 10:56:11 +00005010 int hdr;
drh43605152004-05-29 21:46:49 +00005011 int nCell;
drha2fce642004-06-05 00:01:44 +00005012 int isInit;
drhab9f7f12004-05-08 10:56:11 +00005013 unsigned char *data;
drh8c42ca92001-06-22 19:15:00 +00005014 char range[20];
5015 unsigned char payload[20];
drhab9f7f12004-05-08 10:56:11 +00005016
drh4b70f112004-05-02 21:12:19 +00005017 rc = getPage(pBt, (Pgno)pgno, &pPage);
drha2fce642004-06-05 00:01:44 +00005018 isInit = pPage->isInit;
5019 if( pPage->isInit==0 ){
danielk1977c7dc7532004-11-17 10:22:03 +00005020 initPage(pPage, pParent);
drha2fce642004-06-05 00:01:44 +00005021 }
drh8c42ca92001-06-22 19:15:00 +00005022 if( rc ){
5023 return rc;
5024 }
drhab9f7f12004-05-08 10:56:11 +00005025 hdr = pPage->hdrOffset;
5026 data = pPage->aData;
drhc8629a12004-05-08 20:07:40 +00005027 c = data[hdr];
drh8b18dd42004-05-12 19:18:15 +00005028 pPage->intKey = (c & (PTF_INTKEY|PTF_LEAFDATA))!=0;
drhc8629a12004-05-08 20:07:40 +00005029 pPage->zeroData = (c & PTF_ZERODATA)!=0;
drh8b18dd42004-05-12 19:18:15 +00005030 pPage->leafData = (c & PTF_LEAFDATA)!=0;
drhc8629a12004-05-08 20:07:40 +00005031 pPage->leaf = (c & PTF_LEAF)!=0;
drh8b18dd42004-05-12 19:18:15 +00005032 pPage->hasData = !(pPage->zeroData || (!pPage->leaf && pPage->leafData));
drh43605152004-05-29 21:46:49 +00005033 nCell = get2byte(&data[hdr+3]);
drhfe63d1c2004-09-08 20:13:04 +00005034 sqlite3DebugPrintf("PAGE %d: flags=0x%02x frag=%d parent=%d\n", pgno,
drh43605152004-05-29 21:46:49 +00005035 data[hdr], data[hdr+7],
drhda200cc2004-05-09 11:51:38 +00005036 (pPage->isInit && pPage->pParent) ? pPage->pParent->pgno : 0);
drhab9f7f12004-05-08 10:56:11 +00005037 assert( hdr == (pgno==1 ? 100 : 0) );
drh43605152004-05-29 21:46:49 +00005038 idx = hdr + 12 - pPage->leaf*4;
5039 for(i=0; i<nCell; i++){
drh6f11bef2004-05-13 01:12:56 +00005040 CellInfo info;
drh4b70f112004-05-02 21:12:19 +00005041 Pgno child;
drh43605152004-05-29 21:46:49 +00005042 unsigned char *pCell;
drh6f11bef2004-05-13 01:12:56 +00005043 int sz;
drh43605152004-05-29 21:46:49 +00005044 int addr;
drh6f11bef2004-05-13 01:12:56 +00005045
drh43605152004-05-29 21:46:49 +00005046 addr = get2byte(&data[idx + 2*i]);
5047 pCell = &data[addr];
5048 parseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00005049 sz = info.nSize;
drh43605152004-05-29 21:46:49 +00005050 sprintf(range,"%d..%d", addr, addr+sz-1);
drh4b70f112004-05-02 21:12:19 +00005051 if( pPage->leaf ){
5052 child = 0;
5053 }else{
drh43605152004-05-29 21:46:49 +00005054 child = get4byte(pCell);
drh4b70f112004-05-02 21:12:19 +00005055 }
drh6f11bef2004-05-13 01:12:56 +00005056 sz = info.nData;
5057 if( !pPage->intKey ) sz += info.nKey;
drh8c42ca92001-06-22 19:15:00 +00005058 if( sz>sizeof(payload)-1 ) sz = sizeof(payload)-1;
drh6f11bef2004-05-13 01:12:56 +00005059 memcpy(payload, &pCell[info.nHeader], sz);
drh8c42ca92001-06-22 19:15:00 +00005060 for(j=0; j<sz; j++){
5061 if( payload[j]<0x20 || payload[j]>0x7f ) payload[j] = '.';
5062 }
5063 payload[sz] = 0;
drhfe63d1c2004-09-08 20:13:04 +00005064 sqlite3DebugPrintf(
drh6f11bef2004-05-13 01:12:56 +00005065 "cell %2d: i=%-10s chld=%-4d nk=%-4lld nd=%-4d payload=%s\n",
5066 i, range, child, info.nKey, info.nData, payload
drh8c42ca92001-06-22 19:15:00 +00005067 );
drh8c42ca92001-06-22 19:15:00 +00005068 }
drh4b70f112004-05-02 21:12:19 +00005069 if( !pPage->leaf ){
drhfe63d1c2004-09-08 20:13:04 +00005070 sqlite3DebugPrintf("right_child: %d\n", get4byte(&data[hdr+8]));
drh4b70f112004-05-02 21:12:19 +00005071 }
drh8c42ca92001-06-22 19:15:00 +00005072 nFree = 0;
5073 i = 0;
drhab9f7f12004-05-08 10:56:11 +00005074 idx = get2byte(&data[hdr+1]);
drhb6f41482004-05-14 01:58:11 +00005075 while( idx>0 && idx<pPage->pBt->usableSize ){
drhab9f7f12004-05-08 10:56:11 +00005076 int sz = get2byte(&data[idx+2]);
drh4b70f112004-05-02 21:12:19 +00005077 sprintf(range,"%d..%d", idx, idx+sz-1);
5078 nFree += sz;
drhfe63d1c2004-09-08 20:13:04 +00005079 sqlite3DebugPrintf("freeblock %2d: i=%-10s size=%-4d total=%d\n",
drh4b70f112004-05-02 21:12:19 +00005080 i, range, sz, nFree);
drhab9f7f12004-05-08 10:56:11 +00005081 idx = get2byte(&data[idx]);
drh2aa679f2001-06-25 02:11:07 +00005082 i++;
drh8c42ca92001-06-22 19:15:00 +00005083 }
5084 if( idx!=0 ){
drhfe63d1c2004-09-08 20:13:04 +00005085 sqlite3DebugPrintf("ERROR: next freeblock index out of range: %d\n", idx);
drh8c42ca92001-06-22 19:15:00 +00005086 }
drha34b6762004-05-07 13:30:42 +00005087 if( recursive && !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005088 for(i=0; i<nCell; i++){
5089 unsigned char *pCell = findCell(pPage, i);
danielk1977c7dc7532004-11-17 10:22:03 +00005090 btreePageDump(pBt, get4byte(pCell), 1, pPage);
drha34b6762004-05-07 13:30:42 +00005091 idx = get2byte(pCell);
drh6019e162001-07-02 17:51:45 +00005092 }
danielk1977c7dc7532004-11-17 10:22:03 +00005093 btreePageDump(pBt, get4byte(&data[hdr+8]), 1, pPage);
drh6019e162001-07-02 17:51:45 +00005094 }
drha2fce642004-06-05 00:01:44 +00005095 pPage->isInit = isInit;
drhab9f7f12004-05-08 10:56:11 +00005096 sqlite3pager_unref(data);
drh3644f082004-05-10 18:45:09 +00005097 fflush(stdout);
drh8c42ca92001-06-22 19:15:00 +00005098 return SQLITE_OK;
5099}
danielk1977c7dc7532004-11-17 10:22:03 +00005100int sqlite3BtreePageDump(Btree *pBt, int pgno, int recursive){
5101 return btreePageDump(pBt, pgno, recursive, 0);
5102}
drhaaab5722002-02-19 13:39:21 +00005103#endif
drh8c42ca92001-06-22 19:15:00 +00005104
drhaaab5722002-02-19 13:39:21 +00005105#ifdef SQLITE_TEST
drh8c42ca92001-06-22 19:15:00 +00005106/*
drh2aa679f2001-06-25 02:11:07 +00005107** Fill aResult[] with information about the entry and page that the
5108** cursor is pointing to.
5109**
5110** aResult[0] = The page number
5111** aResult[1] = The entry number
5112** aResult[2] = Total number of entries on this page
drh3e27c022004-07-23 00:01:38 +00005113** aResult[3] = Cell size (local payload + header)
drh2aa679f2001-06-25 02:11:07 +00005114** aResult[4] = Number of free bytes on this page
5115** aResult[5] = Number of free blocks on the page
drh3e27c022004-07-23 00:01:38 +00005116** aResult[6] = Total payload size (local + overflow)
5117** aResult[7] = Header size in bytes
5118** aResult[8] = Local payload size
5119** aResult[9] = Parent page number
drh5eddca62001-06-30 21:53:53 +00005120**
5121** This routine is used for testing and debugging only.
drh8c42ca92001-06-22 19:15:00 +00005122*/
drh3e27c022004-07-23 00:01:38 +00005123int sqlite3BtreeCursorInfo(BtCursor *pCur, int *aResult, int upCnt){
drh2aa679f2001-06-25 02:11:07 +00005124 int cnt, idx;
5125 MemPage *pPage = pCur->pPage;
drh3e27c022004-07-23 00:01:38 +00005126 BtCursor tmpCur;
drhda200cc2004-05-09 11:51:38 +00005127
5128 pageIntegrity(pPage);
drh4b70f112004-05-02 21:12:19 +00005129 assert( pPage->isInit );
drh3e27c022004-07-23 00:01:38 +00005130 getTempCursor(pCur, &tmpCur);
5131 while( upCnt-- ){
5132 moveToParent(&tmpCur);
5133 }
5134 pPage = tmpCur.pPage;
5135 pageIntegrity(pPage);
drha34b6762004-05-07 13:30:42 +00005136 aResult[0] = sqlite3pager_pagenumber(pPage->aData);
drh91025292004-05-03 19:49:32 +00005137 assert( aResult[0]==pPage->pgno );
drh3e27c022004-07-23 00:01:38 +00005138 aResult[1] = tmpCur.idx;
drh2aa679f2001-06-25 02:11:07 +00005139 aResult[2] = pPage->nCell;
drh3e27c022004-07-23 00:01:38 +00005140 if( tmpCur.idx>=0 && tmpCur.idx<pPage->nCell ){
5141 getCellInfo(&tmpCur);
5142 aResult[3] = tmpCur.info.nSize;
5143 aResult[6] = tmpCur.info.nData;
5144 aResult[7] = tmpCur.info.nHeader;
5145 aResult[8] = tmpCur.info.nLocal;
drh2aa679f2001-06-25 02:11:07 +00005146 }else{
5147 aResult[3] = 0;
5148 aResult[6] = 0;
drh3e27c022004-07-23 00:01:38 +00005149 aResult[7] = 0;
5150 aResult[8] = 0;
drh2aa679f2001-06-25 02:11:07 +00005151 }
5152 aResult[4] = pPage->nFree;
5153 cnt = 0;
drh4b70f112004-05-02 21:12:19 +00005154 idx = get2byte(&pPage->aData[pPage->hdrOffset+1]);
drhb6f41482004-05-14 01:58:11 +00005155 while( idx>0 && idx<pPage->pBt->usableSize ){
drh2aa679f2001-06-25 02:11:07 +00005156 cnt++;
drh4b70f112004-05-02 21:12:19 +00005157 idx = get2byte(&pPage->aData[idx]);
drh2aa679f2001-06-25 02:11:07 +00005158 }
5159 aResult[5] = cnt;
drh3e27c022004-07-23 00:01:38 +00005160 if( pPage->pParent==0 || isRootPage(pPage) ){
5161 aResult[9] = 0;
5162 }else{
5163 aResult[9] = pPage->pParent->pgno;
5164 }
5165 releaseTempCursor(&tmpCur);
drh8c42ca92001-06-22 19:15:00 +00005166 return SQLITE_OK;
5167}
drhaaab5722002-02-19 13:39:21 +00005168#endif
drhdd793422001-06-28 01:54:48 +00005169
drhdd793422001-06-28 01:54:48 +00005170/*
drh5eddca62001-06-30 21:53:53 +00005171** Return the pager associated with a BTree. This routine is used for
5172** testing and debugging only.
drhdd793422001-06-28 01:54:48 +00005173*/
drh3aac2dd2004-04-26 14:10:20 +00005174Pager *sqlite3BtreePager(Btree *pBt){
drhdd793422001-06-28 01:54:48 +00005175 return pBt->pPager;
5176}
drh5eddca62001-06-30 21:53:53 +00005177
5178/*
5179** This structure is passed around through all the sanity checking routines
5180** in order to keep track of some global state information.
5181*/
drhaaab5722002-02-19 13:39:21 +00005182typedef struct IntegrityCk IntegrityCk;
5183struct IntegrityCk {
drh100569d2001-10-02 13:01:48 +00005184 Btree *pBt; /* The tree being checked out */
5185 Pager *pPager; /* The associated pager. Also accessible by pBt->pPager */
5186 int nPage; /* Number of pages in the database */
5187 int *anRef; /* Number of times each page is referenced */
drh100569d2001-10-02 13:01:48 +00005188 char *zErrMsg; /* An error message. NULL of no errors seen. */
drh5eddca62001-06-30 21:53:53 +00005189};
5190
drhb7f91642004-10-31 02:22:47 +00005191#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00005192/*
5193** Append a message to the error message string.
5194*/
drh2e38c322004-09-03 18:38:44 +00005195static void checkAppendMsg(
5196 IntegrityCk *pCheck,
5197 char *zMsg1,
5198 const char *zFormat,
5199 ...
5200){
5201 va_list ap;
5202 char *zMsg2;
5203 va_start(ap, zFormat);
5204 zMsg2 = sqlite3VMPrintf(zFormat, ap);
5205 va_end(ap);
5206 if( zMsg1==0 ) zMsg1 = "";
drh5eddca62001-06-30 21:53:53 +00005207 if( pCheck->zErrMsg ){
5208 char *zOld = pCheck->zErrMsg;
5209 pCheck->zErrMsg = 0;
danielk19774adee202004-05-08 08:23:19 +00005210 sqlite3SetString(&pCheck->zErrMsg, zOld, "\n", zMsg1, zMsg2, (char*)0);
drh5eddca62001-06-30 21:53:53 +00005211 sqliteFree(zOld);
5212 }else{
danielk19774adee202004-05-08 08:23:19 +00005213 sqlite3SetString(&pCheck->zErrMsg, zMsg1, zMsg2, (char*)0);
drh5eddca62001-06-30 21:53:53 +00005214 }
drh2e38c322004-09-03 18:38:44 +00005215 sqliteFree(zMsg2);
drh5eddca62001-06-30 21:53:53 +00005216}
drhb7f91642004-10-31 02:22:47 +00005217#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00005218
drhb7f91642004-10-31 02:22:47 +00005219#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00005220/*
5221** Add 1 to the reference count for page iPage. If this is the second
5222** reference to the page, add an error message to pCheck->zErrMsg.
5223** Return 1 if there are 2 ore more references to the page and 0 if
5224** if this is the first reference to the page.
5225**
5226** Also check that the page number is in bounds.
5227*/
drhaaab5722002-02-19 13:39:21 +00005228static int checkRef(IntegrityCk *pCheck, int iPage, char *zContext){
drh5eddca62001-06-30 21:53:53 +00005229 if( iPage==0 ) return 1;
drh0de8c112002-07-06 16:32:14 +00005230 if( iPage>pCheck->nPage || iPage<0 ){
drh2e38c322004-09-03 18:38:44 +00005231 checkAppendMsg(pCheck, zContext, "invalid page number %d", iPage);
drh5eddca62001-06-30 21:53:53 +00005232 return 1;
5233 }
5234 if( pCheck->anRef[iPage]==1 ){
drh2e38c322004-09-03 18:38:44 +00005235 checkAppendMsg(pCheck, zContext, "2nd reference to page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00005236 return 1;
5237 }
5238 return (pCheck->anRef[iPage]++)>1;
5239}
5240
danielk1977afcdd022004-10-31 16:25:42 +00005241#ifndef SQLITE_OMIT_AUTOVACUUM
5242/*
5243** Check that the entry in the pointer-map for page iChild maps to
5244** page iParent, pointer type ptrType. If not, append an error message
5245** to pCheck.
5246*/
5247static void checkPtrmap(
5248 IntegrityCk *pCheck, /* Integrity check context */
5249 Pgno iChild, /* Child page number */
5250 u8 eType, /* Expected pointer map type */
5251 Pgno iParent, /* Expected pointer map parent page number */
5252 char *zContext /* Context description (used for error msg) */
5253){
5254 int rc;
5255 u8 ePtrmapType;
5256 Pgno iPtrmapParent;
5257
5258 rc = ptrmapGet(pCheck->pBt, iChild, &ePtrmapType, &iPtrmapParent);
5259 if( rc!=SQLITE_OK ){
5260 checkAppendMsg(pCheck, zContext, "Failed to read ptrmap key=%d", iChild);
5261 return;
5262 }
5263
5264 if( ePtrmapType!=eType || iPtrmapParent!=iParent ){
5265 checkAppendMsg(pCheck, zContext,
5266 "Bad ptr map entry key=%d expected=(%d,%d) got=(%d,%d)",
5267 iChild, eType, iParent, ePtrmapType, iPtrmapParent);
5268 }
5269}
5270#endif
5271
drh5eddca62001-06-30 21:53:53 +00005272/*
5273** Check the integrity of the freelist or of an overflow page list.
5274** Verify that the number of pages on the list is N.
5275*/
drh30e58752002-03-02 20:41:57 +00005276static void checkList(
5277 IntegrityCk *pCheck, /* Integrity checking context */
5278 int isFreeList, /* True for a freelist. False for overflow page list */
5279 int iPage, /* Page number for first page in the list */
5280 int N, /* Expected number of pages in the list */
5281 char *zContext /* Context for error messages */
5282){
5283 int i;
drh3a4c1412004-05-09 20:40:11 +00005284 int expected = N;
5285 int iFirst = iPage;
drh30e58752002-03-02 20:41:57 +00005286 while( N-- > 0 ){
drh4b70f112004-05-02 21:12:19 +00005287 unsigned char *pOvfl;
drh5eddca62001-06-30 21:53:53 +00005288 if( iPage<1 ){
drh2e38c322004-09-03 18:38:44 +00005289 checkAppendMsg(pCheck, zContext,
5290 "%d of %d pages missing from overflow list starting at %d",
drh3a4c1412004-05-09 20:40:11 +00005291 N+1, expected, iFirst);
drh5eddca62001-06-30 21:53:53 +00005292 break;
5293 }
5294 if( checkRef(pCheck, iPage, zContext) ) break;
drha34b6762004-05-07 13:30:42 +00005295 if( sqlite3pager_get(pCheck->pPager, (Pgno)iPage, (void**)&pOvfl) ){
drh2e38c322004-09-03 18:38:44 +00005296 checkAppendMsg(pCheck, zContext, "failed to get page %d", iPage);
drh5eddca62001-06-30 21:53:53 +00005297 break;
5298 }
drh30e58752002-03-02 20:41:57 +00005299 if( isFreeList ){
drh4b70f112004-05-02 21:12:19 +00005300 int n = get4byte(&pOvfl[4]);
danielk1977687566d2004-11-02 12:56:41 +00005301#ifndef SQLITE_OMIT_AUTOVACUUM
5302 if( pCheck->pBt->autoVacuum ){
5303 checkPtrmap(pCheck, iPage, PTRMAP_FREEPAGE, 0, zContext);
5304 }
5305#endif
drh855eb1c2004-08-31 13:45:11 +00005306 if( n>pCheck->pBt->usableSize/4-8 ){
drh2e38c322004-09-03 18:38:44 +00005307 checkAppendMsg(pCheck, zContext,
5308 "freelist leaf count too big on page %d", iPage);
drhee696e22004-08-30 16:52:17 +00005309 N--;
5310 }else{
5311 for(i=0; i<n; i++){
danielk1977687566d2004-11-02 12:56:41 +00005312 Pgno iFreePage = get4byte(&pOvfl[8+i*4]);
5313#ifndef SQLITE_OMIT_AUTOVACUUM
5314 if( pCheck->pBt->autoVacuum ){
5315 checkPtrmap(pCheck, iFreePage, PTRMAP_FREEPAGE, 0, zContext);
5316 }
5317#endif
5318 checkRef(pCheck, iFreePage, zContext);
drhee696e22004-08-30 16:52:17 +00005319 }
5320 N -= n;
drh30e58752002-03-02 20:41:57 +00005321 }
drh30e58752002-03-02 20:41:57 +00005322 }
danielk1977afcdd022004-10-31 16:25:42 +00005323#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00005324 else{
5325 /* If this database supports auto-vacuum and iPage is not the last
5326 ** page in this overflow list, check that the pointer-map entry for
5327 ** the following page matches iPage.
5328 */
5329 if( pCheck->pBt->autoVacuum && N>0 ){
5330 i = get4byte(pOvfl);
5331 checkPtrmap(pCheck, i, PTRMAP_OVERFLOW2, iPage, zContext);
5332 }
danielk1977afcdd022004-10-31 16:25:42 +00005333 }
5334#endif
drh4b70f112004-05-02 21:12:19 +00005335 iPage = get4byte(pOvfl);
drha34b6762004-05-07 13:30:42 +00005336 sqlite3pager_unref(pOvfl);
drh5eddca62001-06-30 21:53:53 +00005337 }
5338}
drhb7f91642004-10-31 02:22:47 +00005339#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00005340
drhb7f91642004-10-31 02:22:47 +00005341#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00005342/*
5343** Do various sanity checks on a single page of a tree. Return
5344** the tree depth. Root pages return 0. Parents of root pages
5345** return 1, and so forth.
5346**
5347** These checks are done:
5348**
5349** 1. Make sure that cells and freeblocks do not overlap
5350** but combine to completely cover the page.
drhda200cc2004-05-09 11:51:38 +00005351** NO 2. Make sure cell keys are in order.
5352** NO 3. Make sure no key is less than or equal to zLowerBound.
5353** NO 4. Make sure no key is greater than or equal to zUpperBound.
drh5eddca62001-06-30 21:53:53 +00005354** 5. Check the integrity of overflow pages.
5355** 6. Recursively call checkTreePage on all children.
5356** 7. Verify that the depth of all children is the same.
drh6019e162001-07-02 17:51:45 +00005357** 8. Make sure this page is at least 33% full or else it is
drh5eddca62001-06-30 21:53:53 +00005358** the root of the tree.
5359*/
5360static int checkTreePage(
drhaaab5722002-02-19 13:39:21 +00005361 IntegrityCk *pCheck, /* Context for the sanity check */
drh5eddca62001-06-30 21:53:53 +00005362 int iPage, /* Page number of the page to check */
5363 MemPage *pParent, /* Parent page */
5364 char *zParentContext, /* Parent context */
5365 char *zLowerBound, /* All keys should be greater than this, if not NULL */
drh1bffb9c2002-02-03 17:37:36 +00005366 int nLower, /* Number of characters in zLowerBound */
5367 char *zUpperBound, /* All keys should be less than this, if not NULL */
5368 int nUpper /* Number of characters in zUpperBound */
drh5eddca62001-06-30 21:53:53 +00005369){
5370 MemPage *pPage;
drhda200cc2004-05-09 11:51:38 +00005371 int i, rc, depth, d2, pgno, cnt;
drh43605152004-05-29 21:46:49 +00005372 int hdr, cellStart;
5373 int nCell;
drhda200cc2004-05-09 11:51:38 +00005374 u8 *data;
drh5eddca62001-06-30 21:53:53 +00005375 BtCursor cur;
drh0d316a42002-08-11 20:10:47 +00005376 Btree *pBt;
drhb6f41482004-05-14 01:58:11 +00005377 int maxLocal, usableSize;
drh5eddca62001-06-30 21:53:53 +00005378 char zContext[100];
drh2e38c322004-09-03 18:38:44 +00005379 char *hit;
drh5eddca62001-06-30 21:53:53 +00005380
danielk1977ef73ee92004-11-06 12:26:07 +00005381 sprintf(zContext, "Page %d: ", iPage);
5382
drh5eddca62001-06-30 21:53:53 +00005383 /* Check that the page exists
5384 */
drh0d316a42002-08-11 20:10:47 +00005385 cur.pBt = pBt = pCheck->pBt;
drhb6f41482004-05-14 01:58:11 +00005386 usableSize = pBt->usableSize;
drh5eddca62001-06-30 21:53:53 +00005387 if( iPage==0 ) return 0;
5388 if( checkRef(pCheck, iPage, zParentContext) ) return 0;
drh4b70f112004-05-02 21:12:19 +00005389 if( (rc = getPage(pBt, (Pgno)iPage, &pPage))!=0 ){
drh2e38c322004-09-03 18:38:44 +00005390 checkAppendMsg(pCheck, zContext,
5391 "unable to get the page. error code=%d", rc);
drh5eddca62001-06-30 21:53:53 +00005392 return 0;
5393 }
drh6f11bef2004-05-13 01:12:56 +00005394 maxLocal = pPage->leafData ? pBt->maxLeaf : pBt->maxLocal;
drh4b70f112004-05-02 21:12:19 +00005395 if( (rc = initPage(pPage, pParent))!=0 ){
drh2e38c322004-09-03 18:38:44 +00005396 checkAppendMsg(pCheck, zContext, "initPage() returns error code %d", rc);
drh91025292004-05-03 19:49:32 +00005397 releasePage(pPage);
drh5eddca62001-06-30 21:53:53 +00005398 return 0;
5399 }
5400
5401 /* Check out all the cells.
5402 */
5403 depth = 0;
drh5eddca62001-06-30 21:53:53 +00005404 cur.pPage = pPage;
drh5eddca62001-06-30 21:53:53 +00005405 for(i=0; i<pPage->nCell; i++){
drh6f11bef2004-05-13 01:12:56 +00005406 u8 *pCell;
5407 int sz;
5408 CellInfo info;
drh5eddca62001-06-30 21:53:53 +00005409
5410 /* Check payload overflow pages
5411 */
drh3a4c1412004-05-09 20:40:11 +00005412 sprintf(zContext, "On tree page %d cell %d: ", iPage, i);
drh43605152004-05-29 21:46:49 +00005413 pCell = findCell(pPage,i);
5414 parseCellPtr(pPage, pCell, &info);
drh6f11bef2004-05-13 01:12:56 +00005415 sz = info.nData;
5416 if( !pPage->intKey ) sz += info.nKey;
5417 if( sz>info.nLocal ){
drhb6f41482004-05-14 01:58:11 +00005418 int nPage = (sz - info.nLocal + usableSize - 5)/(usableSize - 4);
danielk1977afcdd022004-10-31 16:25:42 +00005419 Pgno pgnoOvfl = get4byte(&pCell[info.iOverflow]);
5420#ifndef SQLITE_OMIT_AUTOVACUUM
5421 if( pBt->autoVacuum ){
danielk1977687566d2004-11-02 12:56:41 +00005422 checkPtrmap(pCheck, pgnoOvfl, PTRMAP_OVERFLOW1, iPage, zContext);
danielk1977afcdd022004-10-31 16:25:42 +00005423 }
5424#endif
5425 checkList(pCheck, 0, pgnoOvfl, nPage, zContext);
drh5eddca62001-06-30 21:53:53 +00005426 }
5427
5428 /* Check sanity of left child page.
5429 */
drhda200cc2004-05-09 11:51:38 +00005430 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005431 pgno = get4byte(pCell);
danielk1977afcdd022004-10-31 16:25:42 +00005432#ifndef SQLITE_OMIT_AUTOVACUUM
5433 if( pBt->autoVacuum ){
5434 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, zContext);
5435 }
5436#endif
drhda200cc2004-05-09 11:51:38 +00005437 d2 = checkTreePage(pCheck,pgno,pPage,zContext,0,0,0,0);
5438 if( i>0 && d2!=depth ){
5439 checkAppendMsg(pCheck, zContext, "Child page depth differs");
5440 }
5441 depth = d2;
drh5eddca62001-06-30 21:53:53 +00005442 }
drh5eddca62001-06-30 21:53:53 +00005443 }
drhda200cc2004-05-09 11:51:38 +00005444 if( !pPage->leaf ){
drh43605152004-05-29 21:46:49 +00005445 pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
drhda200cc2004-05-09 11:51:38 +00005446 sprintf(zContext, "On page %d at right child: ", iPage);
danielk1977afcdd022004-10-31 16:25:42 +00005447#ifndef SQLITE_OMIT_AUTOVACUUM
5448 if( pBt->autoVacuum ){
danielk1977687566d2004-11-02 12:56:41 +00005449 checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage, 0);
danielk1977afcdd022004-10-31 16:25:42 +00005450 }
5451#endif
drhda200cc2004-05-09 11:51:38 +00005452 checkTreePage(pCheck, pgno, pPage, zContext,0,0,0,0);
5453 }
drh5eddca62001-06-30 21:53:53 +00005454
5455 /* Check for complete coverage of the page
5456 */
drhda200cc2004-05-09 11:51:38 +00005457 data = pPage->aData;
5458 hdr = pPage->hdrOffset;
drh2e38c322004-09-03 18:38:44 +00005459 hit = sqliteMalloc( usableSize );
5460 if( hit ){
5461 memset(hit, 1, get2byte(&data[hdr+5]));
5462 nCell = get2byte(&data[hdr+3]);
5463 cellStart = hdr + 12 - 4*pPage->leaf;
5464 for(i=0; i<nCell; i++){
5465 int pc = get2byte(&data[cellStart+i*2]);
5466 int size = cellSizePtr(pPage, &data[pc]);
5467 int j;
danielk19777701e812005-01-10 12:59:51 +00005468 if( (pc+size-1)>=usableSize || pc<0 ){
5469 checkAppendMsg(pCheck, 0,
5470 "Corruption detected in cell %d on page %d",i,iPage,0);
5471 }else{
5472 for(j=pc+size-1; j>=pc; j--) hit[j]++;
5473 }
drh2e38c322004-09-03 18:38:44 +00005474 }
5475 for(cnt=0, i=get2byte(&data[hdr+1]); i>0 && i<usableSize && cnt<10000;
5476 cnt++){
5477 int size = get2byte(&data[i+2]);
5478 int j;
danielk19777701e812005-01-10 12:59:51 +00005479 if( (i+size-1)>=usableSize || i<0 ){
5480 checkAppendMsg(pCheck, 0,
5481 "Corruption detected in cell %d on page %d",i,iPage,0);
5482 }else{
5483 for(j=i+size-1; j>=i; j--) hit[j]++;
5484 }
drh2e38c322004-09-03 18:38:44 +00005485 i = get2byte(&data[i]);
5486 }
5487 for(i=cnt=0; i<usableSize; i++){
5488 if( hit[i]==0 ){
5489 cnt++;
5490 }else if( hit[i]>1 ){
5491 checkAppendMsg(pCheck, 0,
5492 "Multiple uses for byte %d of page %d", i, iPage);
5493 break;
5494 }
5495 }
5496 if( cnt!=data[hdr+7] ){
5497 checkAppendMsg(pCheck, 0,
5498 "Fragmented space is %d byte reported as %d on page %d",
5499 cnt, data[hdr+7], iPage);
drh5eddca62001-06-30 21:53:53 +00005500 }
5501 }
drh2e38c322004-09-03 18:38:44 +00005502 sqliteFree(hit);
drh6019e162001-07-02 17:51:45 +00005503
drh4b70f112004-05-02 21:12:19 +00005504 releasePage(pPage);
drhda200cc2004-05-09 11:51:38 +00005505 return depth+1;
drh5eddca62001-06-30 21:53:53 +00005506}
drhb7f91642004-10-31 02:22:47 +00005507#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
drh5eddca62001-06-30 21:53:53 +00005508
drhb7f91642004-10-31 02:22:47 +00005509#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh5eddca62001-06-30 21:53:53 +00005510/*
5511** This routine does a complete check of the given BTree file. aRoot[] is
5512** an array of pages numbers were each page number is the root page of
5513** a table. nRoot is the number of entries in aRoot.
5514**
5515** If everything checks out, this routine returns NULL. If something is
5516** amiss, an error message is written into memory obtained from malloc()
5517** and a pointer to that error message is returned. The calling function
5518** is responsible for freeing the error message when it is done.
5519*/
drh3aac2dd2004-04-26 14:10:20 +00005520char *sqlite3BtreeIntegrityCheck(Btree *pBt, int *aRoot, int nRoot){
drh5eddca62001-06-30 21:53:53 +00005521 int i;
5522 int nRef;
drhaaab5722002-02-19 13:39:21 +00005523 IntegrityCk sCheck;
drh5eddca62001-06-30 21:53:53 +00005524
drha34b6762004-05-07 13:30:42 +00005525 nRef = *sqlite3pager_stats(pBt->pPager);
drhefc251d2001-07-01 22:12:01 +00005526 if( lockBtree(pBt)!=SQLITE_OK ){
5527 return sqliteStrDup("Unable to acquire a read lock on the database");
5528 }
drh5eddca62001-06-30 21:53:53 +00005529 sCheck.pBt = pBt;
5530 sCheck.pPager = pBt->pPager;
drha34b6762004-05-07 13:30:42 +00005531 sCheck.nPage = sqlite3pager_pagecount(sCheck.pPager);
drh0de8c112002-07-06 16:32:14 +00005532 if( sCheck.nPage==0 ){
5533 unlockBtreeIfUnused(pBt);
5534 return 0;
5535 }
drh8c1238a2003-01-02 14:43:55 +00005536 sCheck.anRef = sqliteMallocRaw( (sCheck.nPage+1)*sizeof(sCheck.anRef[0]) );
danielk1977ac245ec2005-01-14 13:50:11 +00005537 if( !sCheck.anRef ){
5538 unlockBtreeIfUnused(pBt);
5539 return sqlite3MPrintf("Unable to malloc %d bytes",
5540 (sCheck.nPage+1)*sizeof(sCheck.anRef[0]));
5541 }
drhda200cc2004-05-09 11:51:38 +00005542 for(i=0; i<=sCheck.nPage; i++){ sCheck.anRef[i] = 0; }
drh42cac6d2004-11-20 20:31:11 +00005543 i = PENDING_BYTE_PAGE(pBt);
drh1f595712004-06-15 01:40:29 +00005544 if( i<=sCheck.nPage ){
5545 sCheck.anRef[i] = 1;
5546 }
drh5eddca62001-06-30 21:53:53 +00005547 sCheck.zErrMsg = 0;
5548
5549 /* Check the integrity of the freelist
5550 */
drha34b6762004-05-07 13:30:42 +00005551 checkList(&sCheck, 1, get4byte(&pBt->pPage1->aData[32]),
5552 get4byte(&pBt->pPage1->aData[36]), "Main freelist: ");
drh5eddca62001-06-30 21:53:53 +00005553
5554 /* Check all the tables.
5555 */
5556 for(i=0; i<nRoot; i++){
drh4ff6dfa2002-03-03 23:06:00 +00005557 if( aRoot[i]==0 ) continue;
danielk1977687566d2004-11-02 12:56:41 +00005558#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977687566d2004-11-02 12:56:41 +00005559 if( pBt->autoVacuum && aRoot[i]>1 ){
5560 checkPtrmap(&sCheck, aRoot[i], PTRMAP_ROOTPAGE, 0, 0);
5561 }
5562#endif
drh1bffb9c2002-02-03 17:37:36 +00005563 checkTreePage(&sCheck, aRoot[i], 0, "List of tree roots: ", 0,0,0,0);
drh5eddca62001-06-30 21:53:53 +00005564 }
5565
5566 /* Make sure every page in the file is referenced
5567 */
5568 for(i=1; i<=sCheck.nPage; i++){
danielk1977afcdd022004-10-31 16:25:42 +00005569#ifdef SQLITE_OMIT_AUTOVACUUM
drh5eddca62001-06-30 21:53:53 +00005570 if( sCheck.anRef[i]==0 ){
drh2e38c322004-09-03 18:38:44 +00005571 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
drh5eddca62001-06-30 21:53:53 +00005572 }
danielk1977afcdd022004-10-31 16:25:42 +00005573#else
5574 /* If the database supports auto-vacuum, make sure no tables contain
5575 ** references to pointer-map pages.
5576 */
5577 if( sCheck.anRef[i]==0 &&
drh42cac6d2004-11-20 20:31:11 +00005578 (PTRMAP_PAGENO(pBt->usableSize, i)!=i || !pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00005579 checkAppendMsg(&sCheck, 0, "Page %d is never used", i);
5580 }
5581 if( sCheck.anRef[i]!=0 &&
drh42cac6d2004-11-20 20:31:11 +00005582 (PTRMAP_PAGENO(pBt->usableSize, i)==i && pBt->autoVacuum) ){
danielk1977afcdd022004-10-31 16:25:42 +00005583 checkAppendMsg(&sCheck, 0, "Pointer map page %d is referenced", i);
5584 }
5585#endif
drh5eddca62001-06-30 21:53:53 +00005586 }
5587
5588 /* Make sure this analysis did not leave any unref() pages
5589 */
drh5e00f6c2001-09-13 13:46:56 +00005590 unlockBtreeIfUnused(pBt);
drha34b6762004-05-07 13:30:42 +00005591 if( nRef != *sqlite3pager_stats(pBt->pPager) ){
drh2e38c322004-09-03 18:38:44 +00005592 checkAppendMsg(&sCheck, 0,
drh5eddca62001-06-30 21:53:53 +00005593 "Outstanding page count goes from %d to %d during this analysis",
drha34b6762004-05-07 13:30:42 +00005594 nRef, *sqlite3pager_stats(pBt->pPager)
drh5eddca62001-06-30 21:53:53 +00005595 );
drh5eddca62001-06-30 21:53:53 +00005596 }
5597
5598 /* Clean up and report errors.
5599 */
5600 sqliteFree(sCheck.anRef);
5601 return sCheck.zErrMsg;
5602}
drhb7f91642004-10-31 02:22:47 +00005603#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
paulb95a8862003-04-01 21:16:41 +00005604
drh73509ee2003-04-06 20:44:45 +00005605/*
5606** Return the full pathname of the underlying database file.
5607*/
drh3aac2dd2004-04-26 14:10:20 +00005608const char *sqlite3BtreeGetFilename(Btree *pBt){
drh73509ee2003-04-06 20:44:45 +00005609 assert( pBt->pPager!=0 );
drha34b6762004-05-07 13:30:42 +00005610 return sqlite3pager_filename(pBt->pPager);
drh73509ee2003-04-06 20:44:45 +00005611}
5612
5613/*
danielk19775865e3d2004-06-14 06:03:57 +00005614** Return the pathname of the directory that contains the database file.
5615*/
5616const char *sqlite3BtreeGetDirname(Btree *pBt){
5617 assert( pBt->pPager!=0 );
5618 return sqlite3pager_dirname(pBt->pPager);
5619}
5620
5621/*
5622** Return the pathname of the journal file for this database. The return
5623** value of this routine is the same regardless of whether the journal file
5624** has been created or not.
5625*/
5626const char *sqlite3BtreeGetJournalname(Btree *pBt){
5627 assert( pBt->pPager!=0 );
5628 return sqlite3pager_journalname(pBt->pPager);
5629}
5630
drhb7f91642004-10-31 02:22:47 +00005631#ifndef SQLITE_OMIT_VACUUM
danielk19775865e3d2004-06-14 06:03:57 +00005632/*
drhf7c57532003-04-25 13:22:51 +00005633** Copy the complete content of pBtFrom into pBtTo. A transaction
5634** must be active for both files.
5635**
5636** The size of file pBtFrom may be reduced by this operation.
drh43605152004-05-29 21:46:49 +00005637** If anything goes wrong, the transaction on pBtFrom is rolled back.
drh73509ee2003-04-06 20:44:45 +00005638*/
drh3aac2dd2004-04-26 14:10:20 +00005639int sqlite3BtreeCopyFile(Btree *pBtTo, Btree *pBtFrom){
drhf7c57532003-04-25 13:22:51 +00005640 int rc = SQLITE_OK;
drh2e6d11b2003-04-25 15:37:57 +00005641 Pgno i, nPage, nToPage;
drhf7c57532003-04-25 13:22:51 +00005642
danielk1977ee5741e2004-05-31 10:01:34 +00005643 if( pBtTo->inTrans!=TRANS_WRITE || pBtFrom->inTrans!=TRANS_WRITE ){
5644 return SQLITE_ERROR;
5645 }
drhf7c57532003-04-25 13:22:51 +00005646 if( pBtTo->pCursor ) return SQLITE_BUSY;
drha34b6762004-05-07 13:30:42 +00005647 nToPage = sqlite3pager_pagecount(pBtTo->pPager);
5648 nPage = sqlite3pager_pagecount(pBtFrom->pPager);
danielk1977369f27e2004-06-15 11:40:04 +00005649 for(i=1; rc==SQLITE_OK && i<=nPage; i++){
drhf7c57532003-04-25 13:22:51 +00005650 void *pPage;
drha34b6762004-05-07 13:30:42 +00005651 rc = sqlite3pager_get(pBtFrom->pPager, i, &pPage);
drhf7c57532003-04-25 13:22:51 +00005652 if( rc ) break;
drha34b6762004-05-07 13:30:42 +00005653 rc = sqlite3pager_overwrite(pBtTo->pPager, i, pPage);
drh2e6d11b2003-04-25 15:37:57 +00005654 if( rc ) break;
drha34b6762004-05-07 13:30:42 +00005655 sqlite3pager_unref(pPage);
drhf7c57532003-04-25 13:22:51 +00005656 }
drh2e6d11b2003-04-25 15:37:57 +00005657 for(i=nPage+1; rc==SQLITE_OK && i<=nToPage; i++){
5658 void *pPage;
drha34b6762004-05-07 13:30:42 +00005659 rc = sqlite3pager_get(pBtTo->pPager, i, &pPage);
drh2e6d11b2003-04-25 15:37:57 +00005660 if( rc ) break;
drha34b6762004-05-07 13:30:42 +00005661 rc = sqlite3pager_write(pPage);
5662 sqlite3pager_unref(pPage);
5663 sqlite3pager_dont_write(pBtTo->pPager, i);
drh2e6d11b2003-04-25 15:37:57 +00005664 }
5665 if( !rc && nPage<nToPage ){
drha34b6762004-05-07 13:30:42 +00005666 rc = sqlite3pager_truncate(pBtTo->pPager, nPage);
drh2e6d11b2003-04-25 15:37:57 +00005667 }
drhf7c57532003-04-25 13:22:51 +00005668 if( rc ){
drh3aac2dd2004-04-26 14:10:20 +00005669 sqlite3BtreeRollback(pBtTo);
drhf7c57532003-04-25 13:22:51 +00005670 }
5671 return rc;
drh73509ee2003-04-06 20:44:45 +00005672}
drhb7f91642004-10-31 02:22:47 +00005673#endif /* SQLITE_OMIT_VACUUM */
danielk19771d850a72004-05-31 08:26:49 +00005674
5675/*
5676** Return non-zero if a transaction is active.
5677*/
5678int sqlite3BtreeIsInTrans(Btree *pBt){
danielk1977ee5741e2004-05-31 10:01:34 +00005679 return (pBt && (pBt->inTrans==TRANS_WRITE));
danielk19771d850a72004-05-31 08:26:49 +00005680}
5681
5682/*
5683** Return non-zero if a statement transaction is active.
5684*/
5685int sqlite3BtreeIsInStmt(Btree *pBt){
5686 return (pBt && pBt->inStmt);
5687}
danielk197713adf8a2004-06-03 16:08:41 +00005688
5689/*
5690** This call is a no-op if no write-transaction is currently active on pBt.
5691**
5692** Otherwise, sync the database file for the btree pBt. zMaster points to
5693** the name of a master journal file that should be written into the
5694** individual journal file, or is NULL, indicating no master journal file
5695** (single database transaction).
5696**
5697** When this is called, the master journal should already have been
5698** created, populated with this journal pointer and synced to disk.
5699**
5700** Once this is routine has returned, the only thing required to commit
5701** the write-transaction for this database file is to delete the journal.
5702*/
5703int sqlite3BtreeSync(Btree *pBt, const char *zMaster){
5704 if( pBt->inTrans==TRANS_WRITE ){
danielk1977687566d2004-11-02 12:56:41 +00005705#ifndef SQLITE_OMIT_AUTOVACUUM
danielk1977d761c0c2004-11-05 16:37:02 +00005706 Pgno nTrunc = 0;
danielk1977687566d2004-11-02 12:56:41 +00005707 if( pBt->autoVacuum ){
danielk1977d761c0c2004-11-05 16:37:02 +00005708 int rc = autoVacuumCommit(pBt, &nTrunc);
danielk1977687566d2004-11-02 12:56:41 +00005709 if( rc!=SQLITE_OK ) return rc;
5710 }
danielk1977d761c0c2004-11-05 16:37:02 +00005711 return sqlite3pager_sync(pBt->pPager, zMaster, nTrunc);
danielk1977687566d2004-11-02 12:56:41 +00005712#endif
danielk1977d761c0c2004-11-05 16:37:02 +00005713 return sqlite3pager_sync(pBt->pPager, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00005714 }
5715 return SQLITE_OK;
5716}