blob: 5c660994b69f0c49effe06d884d2224b2b727761 [file] [log] [blame]
drhed7c8552001-04-11 14:29:21 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhed7c8552001-04-11 14:29:21 +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:
drhed7c8552001-04-11 14:29:21 +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.
drhed7c8552001-04-11 14:29:21 +000010**
11*************************************************************************
drhb19a2bc2001-09-16 00:13:26 +000012** This is the implementation of the page cache subsystem or "pager".
drhed7c8552001-04-11 14:29:21 +000013**
drhb19a2bc2001-09-16 00:13:26 +000014** The pager is used to access a database disk file. It implements
15** atomic commit and rollback through the use of a journal file that
16** is separate from the database file. The pager also implements file
17** locking to prevent two processes from writing the same database
18** file simultaneously, or one process from reading the database while
19** another is writing.
drhed7c8552001-04-11 14:29:21 +000020**
drha06ecba2008-04-22 17:15:17 +000021** @(#) $Id: pager.c,v 1.433 2008/04/22 17:15:18 drh Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drh2e66f0b2005-04-28 17:18:48 +000023#ifndef SQLITE_OMIT_DISKIO
drhd9b02572001-04-15 00:37:09 +000024#include "sqliteInt.h"
drhed7c8552001-04-11 14:29:21 +000025#include <assert.h>
drhd9b02572001-04-15 00:37:09 +000026#include <string.h>
drhed7c8552001-04-11 14:29:21 +000027
28/*
drhdb48ee02003-01-16 13:42:43 +000029** Macros for troubleshooting. Normally turned off
30*/
danielk1977466be562004-06-10 02:16:01 +000031#if 0
drhd3627af2006-12-18 18:34:51 +000032#define sqlite3DebugPrintf printf
drh4f0c5872007-03-26 22:05:01 +000033#define PAGERTRACE1(X) sqlite3DebugPrintf(X)
34#define PAGERTRACE2(X,Y) sqlite3DebugPrintf(X,Y)
35#define PAGERTRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
36#define PAGERTRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
37#define PAGERTRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000038#else
drh4f0c5872007-03-26 22:05:01 +000039#define PAGERTRACE1(X)
40#define PAGERTRACE2(X,Y)
41#define PAGERTRACE3(X,Y,Z)
42#define PAGERTRACE4(X,Y,Z,W)
43#define PAGERTRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000044#endif
45
danielk1977599fcba2004-11-08 07:13:13 +000046/*
drh4f0c5872007-03-26 22:05:01 +000047** The following two macros are used within the PAGERTRACEX() macros above
drhd86959f2005-11-26 03:51:18 +000048** to print out file-descriptors.
danielk1977599fcba2004-11-08 07:13:13 +000049**
drh85b623f2007-12-13 21:54:09 +000050** PAGERID() takes a pointer to a Pager struct as its argument. The
danielk197762079062007-08-15 17:08:46 +000051** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
drh85b623f2007-12-13 21:54:09 +000052** struct as its argument.
danielk1977599fcba2004-11-08 07:13:13 +000053*/
drhc001c582006-03-06 18:23:16 +000054#define PAGERID(p) ((int)(p->fd))
55#define FILEHANDLEID(fd) ((int)fd)
drhdb48ee02003-01-16 13:42:43 +000056
57/*
drhed7c8552001-04-11 14:29:21 +000058** The page cache as a whole is always in one of the following
59** states:
60**
drha6abd042004-06-09 17:37:22 +000061** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000062** writing the database file. There is no
63** data held in memory. This is the initial
64** state.
65**
drha6abd042004-06-09 17:37:22 +000066** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000067** Writing is not permitted. There can be
68** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000069** file at the same time.
drhed7c8552001-04-11 14:29:21 +000070**
drh726de592004-06-10 23:35:50 +000071** PAGER_RESERVED This process has reserved the database for writing
72** but has not yet made any changes. Only one process
73** at a time can reserve the database. The original
74** database file has not been modified so other
75** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000076** database file.
77**
78** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000079** Access is exclusive. No other processes or
80** threads can be reading or writing while one
81** process is writing.
82**
danielk1977aa5ccdf2004-06-14 05:10:42 +000083** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
84** after all dirty pages have been written to the
85** database file and the file has been synced to
drh369339d2007-03-30 16:01:55 +000086** disk. All that remains to do is to remove or
87** truncate the journal file and the transaction
88** will be committed.
danielk1977aa5ccdf2004-06-14 05:10:42 +000089**
drha6abd042004-06-09 17:37:22 +000090** The page cache comes up in PAGER_UNLOCK. The first time a
danielk19773b8a05f2007-03-19 17:44:26 +000091** sqlite3PagerGet() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000092** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000093** the state transitions back to PAGER_UNLOCK. The first time
danielk19773b8a05f2007-03-19 17:44:26 +000094** that sqlite3PagerWrite() is called, the state transitions to
drh369339d2007-03-30 16:01:55 +000095** PAGER_RESERVED. (Note that sqlite3PagerWrite() can only be
drh306dc212001-05-21 13:45:10 +000096** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000097** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh369339d2007-03-30 16:01:55 +000098** PAGER_RESERVED means that there is an open rollback journal.
99** The transition to PAGER_EXCLUSIVE occurs before any changes
100** are made to the database file, though writes to the rollback
101** journal occurs with just PAGER_RESERVED. After an sqlite3PagerRollback()
102** or sqlite3PagerCommitPhaseTwo(), the state can go back to PAGER_SHARED,
103** or it can stay at PAGER_EXCLUSIVE if we are in exclusive access mode.
drhed7c8552001-04-11 14:29:21 +0000104*/
drha6abd042004-06-09 17:37:22 +0000105#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000106#define PAGER_SHARED 1 /* same as SHARED_LOCK */
107#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
108#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
109#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000110
drh684917c2004-10-05 02:41:42 +0000111/*
112** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
113** then failed attempts to get a reserved lock will invoke the busy callback.
114** This is off by default. To see why, consider the following scenario:
115**
116** Suppose thread A already has a shared lock and wants a reserved lock.
117** Thread B already has a reserved lock and wants an exclusive lock. If
118** both threads are using their busy callbacks, it might be a long time
119** be for one of the threads give up and allows the other to proceed.
120** But if the thread trying to get the reserved lock gives up quickly
121** (if it never invokes its busy callback) then the contention will be
122** resolved quickly.
123*/
124#ifndef SQLITE_BUSY_RESERVED_LOCK
125# define SQLITE_BUSY_RESERVED_LOCK 0
126#endif
drhd9b02572001-04-15 00:37:09 +0000127
drhed7c8552001-04-11 14:29:21 +0000128/*
drh887dc4c2004-10-22 16:22:57 +0000129** This macro rounds values up so that if the value is an address it
130** is guaranteed to be an address that is aligned to an 8-byte boundary.
131*/
132#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
133
danielk19779f61c2f2007-08-27 17:27:49 +0000134typedef struct PgHdr PgHdr;
danielk197784f786f2007-08-28 08:00:17 +0000135
136/*
137** Each pager stores all currently unreferenced pages in a list sorted
138** in least-recently-used (LRU) order (i.e. the first item on the list has
139** not been referenced in a long time, the last item has been recently
140** used). An instance of this structure is included as part of each
141** pager structure for this purpose (variable Pager.lru).
142**
143** Additionally, if memory-management is enabled, all unreferenced pages
144** are stored in a global LRU list (global variable sqlite3LruPageList).
145**
146** In both cases, the PagerLruList.pFirstSynced variable points to
147** the first page in the corresponding list that does not require an
drh85b623f2007-12-13 21:54:09 +0000148** fsync() operation before its memory can be reclaimed. If no such
danielk197784f786f2007-08-28 08:00:17 +0000149** page exists, PagerLruList.pFirstSynced is set to NULL.
150*/
151typedef struct PagerLruList PagerLruList;
152struct PagerLruList {
153 PgHdr *pFirst; /* First page in LRU list */
154 PgHdr *pLast; /* Last page in LRU list (the most recently used) */
155 PgHdr *pFirstSynced; /* First page in list with PgHdr.needSync==0 */
156};
157
158/*
159** The following structure contains the next and previous pointers used
160** to link a PgHdr structure into a PagerLruList linked list.
161*/
danielk19779f61c2f2007-08-27 17:27:49 +0000162typedef struct PagerLruLink PagerLruLink;
163struct PagerLruLink {
164 PgHdr *pNext;
165 PgHdr *pPrev;
166};
167
drh887dc4c2004-10-22 16:22:57 +0000168/*
drhed7c8552001-04-11 14:29:21 +0000169** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000170** This header is only visible to this pager module. The client
171** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000172**
danielk19773b8a05f2007-03-19 17:44:26 +0000173** Client code should call sqlite3PagerWrite() on a page prior to making
174** any modifications to that page. The first time sqlite3PagerWrite()
drhf6038712004-02-08 18:07:34 +0000175** is called, the original page contents are written into the rollback
176** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
177** the journal page has made it onto the disk surface, PgHdr.needSync
178** is cleared. The modified page cannot be written back into the original
179** database file until the journal pages has been synced to disk and the
180** PgHdr.needSync has been cleared.
181**
danielk19773b8a05f2007-03-19 17:44:26 +0000182** The PgHdr.dirty flag is set when sqlite3PagerWrite() is called and
drhf6038712004-02-08 18:07:34 +0000183** is cleared again when the page content is written back to the original
184** database file.
drh732c8172007-06-16 11:17:45 +0000185**
186** Details of important structure elements:
187**
188** needSync
189**
190** If this is true, this means that it is not safe to write the page
191** content to the database because the original content needed
192** for rollback has not by synced to the main rollback journal.
193** The original content may have been written to the rollback journal
194** but it has not yet been synced. So we cannot write to the database
195** file because power failure might cause the page in the journal file
196** to never reach the disk. It is as if the write to the journal file
197** does not occur until the journal file is synced.
198**
199** This flag is false if the page content exactly matches what
200** currently exists in the database file. The needSync flag is also
201** false if the original content has been written to the main rollback
202** journal and synced. If the page represents a new page that has
203** been added onto the end of the database during the current
204** transaction, the needSync flag is true until the original database
205** size in the journal header has been synced to disk.
206**
207** inJournal
208**
209** This is true if the original page has been written into the main
210** rollback journal. This is always false for new pages added to
211** the end of the database file during the current transaction.
212** And this flag says nothing about whether or not the journal
213** has been synced to disk. For pages that are in the original
214** database file, the following expression should always be true:
215**
drhf5e7bb52008-02-18 14:47:33 +0000216** inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno)
drh732c8172007-06-16 11:17:45 +0000217**
drhf5e7bb52008-02-18 14:47:33 +0000218** The pPager->pInJournal object is only valid for the original
drh732c8172007-06-16 11:17:45 +0000219** pages of the database, not new pages that are added to the end
220** of the database, so obviously the above expression cannot be
221** valid for new pages. For new pages inJournal is always 0.
222**
223** dirty
224**
225** When true, this means that the content of the page has been
226** modified and needs to be written back to the database file.
227** If false, it means that either the content of the page is
228** unchanged or else the content is unimportant and we do not
229** care whether or not it is preserved.
230**
231** alwaysRollback
232**
233** This means that the sqlite3PagerDontRollback() API should be
234** ignored for this page. The DontRollback() API attempts to say
235** that the content of the page on disk is unimportant (it is an
236** unused page on the freelist) so that it is unnecessary to
237** rollback changes to this page because the content of the page
238** can change without changing the meaning of the database. This
239** flag overrides any DontRollback() attempt. This flag is set
240** when a page that originally contained valid data is added to
241** the freelist. Later in the same transaction, this page might
242** be pulled from the freelist and reused for something different
243** and at that point the DontRollback() API will be called because
244** pages taken from the freelist do not need to be protected by
245** the rollback journal. But this flag says that the page was
246** not originally part of the freelist so that it still needs to
247** be rolled back in spite of any subsequent DontRollback() calls.
248**
249** needRead
250**
251** This flag means (when true) that the content of the page has
252** not yet been loaded from disk. The in-memory content is just
253** garbage. (Actually, we zero the content, but you should not
254** make any assumptions about the content nevertheless.) If the
255** content is needed in the future, it should be read from the
256** original database file.
drhed7c8552001-04-11 14:29:21 +0000257*/
258struct PgHdr {
259 Pager *pPager; /* The pager to which this page belongs */
260 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000261 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
danielk19779f61c2f2007-08-27 17:27:49 +0000262 PagerLruLink free; /* Next and previous free pages */
drhac69b052004-05-12 13:30:07 +0000263 PgHdr *pNextAll; /* A list of all pages */
drh193a6b42002-07-07 16:52:46 +0000264 u8 inJournal; /* TRUE if has been written to journal */
drh193a6b42002-07-07 16:52:46 +0000265 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000266 u8 needSync; /* Sync journal before writing this page */
drh80e35f42007-03-30 14:06:34 +0000267 u8 alwaysRollback; /* Disable DontRollback() for this page */
drh538f5702007-04-13 02:14:30 +0000268 u8 needRead; /* Read content if PagerWrite() is called */
drhac69b052004-05-12 13:30:07 +0000269 short int nRef; /* Number of users of this page */
drhdc3e10b2006-06-15 14:31:06 +0000270 PgHdr *pDirty, *pPrevDirty; /* Dirty pages */
danielk19779f61c2f2007-08-27 17:27:49 +0000271#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
272 PagerLruLink gfree; /* Global list of nRef==0 pages */
273#endif
danielk19773c407372005-02-15 02:54:14 +0000274#ifdef SQLITE_CHECK_PAGES
275 u32 pageHash;
276#endif
drhbf4bca52007-09-06 22:19:14 +0000277 void *pData; /* Page data */
278 /* Pager.nExtra bytes of local data appended to this header */
drhed7c8552001-04-11 14:29:21 +0000279};
280
drhac69b052004-05-12 13:30:07 +0000281/*
282** For an in-memory only database, some extra information is recorded about
283** each page so that changes can be rolled back. (Journal files are not
284** used for in-memory databases.) The following information is added to
285** the end of every EXTRA block for in-memory databases.
286**
287** This information could have been added directly to the PgHdr structure.
288** But then it would take up an extra 8 bytes of storage on every PgHdr
289** even for disk-based databases. Splitting it out saves 8 bytes. This
290** is only a savings of 0.8% but those percentages add up.
291*/
292typedef struct PgHistory PgHistory;
293struct PgHistory {
294 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
295 u8 *pStmt; /* Text as it was at the beginning of the current statement */
danielk1977f35843b2007-04-07 15:03:17 +0000296 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
297 u8 inStmt; /* TRUE if in the statement subjournal */
drhac69b052004-05-12 13:30:07 +0000298};
drh9eb9e262004-02-11 02:18:05 +0000299
300/*
301** A macro used for invoking the codec if there is one
302*/
303#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000304# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
305# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000306#else
drhc001c582006-03-06 18:23:16 +0000307# define CODEC1(P,D,N,X) /* NO-OP */
308# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000309#endif
310
drhed7c8552001-04-11 14:29:21 +0000311/*
drh69688d52001-04-14 16:38:23 +0000312** Convert a pointer to a PgHdr into a pointer to its data
313** and back again.
drhed7c8552001-04-11 14:29:21 +0000314*/
drhbf4bca52007-09-06 22:19:14 +0000315#define PGHDR_TO_DATA(P) ((P)->pData)
316#define PGHDR_TO_EXTRA(G,P) ((void*)&((G)[1]))
drhac69b052004-05-12 13:30:07 +0000317#define PGHDR_TO_HIST(P,PGR) \
drhbf4bca52007-09-06 22:19:14 +0000318 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000319
320/*
drhed7c8552001-04-11 14:29:21 +0000321** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000322**
drh4f0ee682007-03-30 20:43:40 +0000323** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000324** or SQLITE_FULL. Once one of the first three errors occurs, it persists
325** and is returned as the result of every major pager API call. The
326** SQLITE_FULL return code is slightly different. It persists only until the
327** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000328** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000329** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000330*/
331struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000332 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000333 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000334 u8 journalStarted; /* True if header of journal is synced */
335 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000336 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000337 u8 stmtOpen; /* True if the statement subjournal is open */
338 u8 stmtInUse; /* True we are in a statement subtransaction */
339 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000340 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000341 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000342 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000343 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000344 u8 tempFile; /* zFilename is a temporary file */
345 u8 readOnly; /* True for a read-only database */
346 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000347 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000348 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000349 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000350 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000351 u8 doNotSync; /* Boolean. While true, do not spill the cache */
352 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
drhfdc40e92008-04-17 20:59:37 +0000353 u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */
drh80e35f42007-03-30 14:06:34 +0000354 u8 changeCountDone; /* Set after incrementing the change-counter */
drh33f4e022007-09-03 15:19:34 +0000355 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000356 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000357 int dbSize; /* Number of pages in the file */
358 int origDbSize; /* dbSize before the current change */
359 int stmtSize; /* Size of database (in pages) at stmt_begin() */
360 int nRec; /* Number of pages written to the journal */
361 u32 cksumInit; /* Quasi-random value added to every checksum */
362 int stmtNRec; /* Number of records in stmt subjournal */
363 int nExtra; /* Add this many bytes to each in-memory page */
364 int pageSize; /* Number of bytes in a page */
365 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000366 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
367 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000368 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000369 Bitvec *pInJournal; /* One bit for each page in the database file */
370 Bitvec *pInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000371 char *zFilename; /* Name of the database file */
372 char *zJournal; /* Name of the journal file */
373 char *zDirectory; /* Directory hold database and journal files */
drh334b2992007-09-06 23:28:23 +0000374 char *zStmtJrnl; /* Name of the statement journal file */
danielk197762079062007-08-15 17:08:46 +0000375 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
376 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000377 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
danielk19779f61c2f2007-08-27 17:27:49 +0000378 PagerLruList lru; /* LRU list of free pages */
drhd9b02572001-04-15 00:37:09 +0000379 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000380 PgHdr *pStmt; /* List of pages in the statement subjournal */
drh605ad8f2006-05-03 23:34:05 +0000381 PgHdr *pDirty; /* List of all dirty pages */
drheb206252004-10-01 02:00:31 +0000382 i64 journalOff; /* Current byte offset in the journal file */
383 i64 journalHdr; /* Byte offset to previous journal header */
384 i64 stmtHdrOff; /* First journal header written this statement */
385 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000386 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000387 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000388#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000389 int nHit, nMiss; /* Cache hits and missing */
390 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000391#endif
danielk19773b8a05f2007-03-19 17:44:26 +0000392 void (*xDestructor)(DbPage*,int); /* Call this routine when freeing pages */
393 void (*xReiniter)(DbPage*,int); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000394#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000395 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000396 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000397#endif
drh8ca0c722006-05-07 17:49:38 +0000398 int nHash; /* Size of the pager hash table */
399 PgHdr **aHash; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000400#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +0000401 Pager *pNext; /* Doubly linked list of pagers on which */
402 Pager *pPrev; /* sqlite3_release_memory() will work */
403 int iInUseMM; /* Non-zero if unavailable to MM */
404 int iInUseDB; /* Non-zero if in sqlite3_release_memory() */
danielk197713f72992005-12-18 08:51:22 +0000405#endif
danielk19778186df82007-03-06 13:45:59 +0000406 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000407 char dbFileVers[16]; /* Changes whenever database file changes */
drhd9b02572001-04-15 00:37:09 +0000408};
409
410/*
drh538f5702007-04-13 02:14:30 +0000411** The following global variables hold counters used for
412** testing purposes only. These variables do not exist in
413** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000414*/
415#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000416int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
417int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
418int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
419int sqlite3_pager_pgfree_count = 0; /* Number of cache pages freed */
420# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000421#else
drh538f5702007-04-13 02:14:30 +0000422# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000423#endif
424
drh86f8c192007-08-22 00:39:19 +0000425/*
426** The following variable points to the head of a double-linked list
427** of all pagers that are eligible for page stealing by the
428** sqlite3_release_memory() interface. Access to this list is
429** protected by the SQLITE_MUTEX_STATIC_MEM2 mutex.
430*/
431#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
432static Pager *sqlite3PagerList = 0;
danielk19779f61c2f2007-08-27 17:27:49 +0000433static PagerLruList sqlite3LruPageList = {0, 0, 0};
drh86f8c192007-08-22 00:39:19 +0000434#endif
drh538f5702007-04-13 02:14:30 +0000435
436
drhfcd35c72005-05-21 02:48:08 +0000437/*
drh5e00f6c2001-09-13 13:46:56 +0000438** Journal files begin with the following magic string. The data
439** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000440**
drhae2b40c2004-06-09 19:03:54 +0000441** Since version 2.8.0, the journal format contains additional sanity
442** checking information. If the power fails while the journal is begin
443** written, semi-random garbage data might appear in the journal
444** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000445** to roll the journal back, the database could be corrupted. The additional
446** sanity checking data is an attempt to discover the garbage in the
447** journal and ignore it.
448**
drhae2b40c2004-06-09 19:03:54 +0000449** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000450** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000451** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000452** This cksum is initialized to a 32-bit random value that appears in the
453** journal file right after the header. The random initializer is important,
454** because garbage data that appears at the end of a journal is likely
455** data that was once in other files that have now been deleted. If the
456** garbage data came from an obsolete journal file, the checksums might
457** be correct. But by initializing the checksum to random value which
458** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000459*/
drhae2b40c2004-06-09 19:03:54 +0000460static const unsigned char aJournalMagic[] = {
461 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000462};
463
464/*
drh726de592004-06-10 23:35:50 +0000465** The size of the header and of each page in the journal is determined
466** by the following macros.
drh968af522003-02-11 14:55:40 +0000467*/
drhae2b40c2004-06-09 19:03:54 +0000468#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000469
danielk197776572402004-06-25 02:38:54 +0000470/*
471** The journal header size for this pager. In the future, this could be
472** set to some value read from the disk controller. The important
473** characteristic is that it is the same size as a disk sector.
474*/
475#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
476
drhb7f91642004-10-31 02:22:47 +0000477/*
478** The macro MEMDB is true if we are dealing with an in-memory database.
479** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
480** the value of MEMDB will be a constant and the compiler will optimize
481** out code that would never execute.
482*/
483#ifdef SQLITE_OMIT_MEMORYDB
484# define MEMDB 0
485#else
486# define MEMDB pPager->memDb
487#endif
488
489/*
danielk197776572402004-06-25 02:38:54 +0000490** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
491** reserved for working around a windows/posix incompatibility). It is
492** used in the journal to signify that the remainder of the journal file
493** is devoted to storing a master journal name - there are no more pages to
494** roll back. See comments for function writeMasterJournal() for details.
495*/
danielk1977599fcba2004-11-08 07:13:13 +0000496/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
497#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000498
drh968af522003-02-11 14:55:40 +0000499/*
danielk197726836652005-01-17 01:33:13 +0000500** The maximum legal page number is (2^31 - 1).
501*/
502#define PAGER_MAX_PGNO 2147483647
503
504/*
drh86f8c192007-08-22 00:39:19 +0000505** The pagerEnter() and pagerLeave() routines acquire and release
506** a mutex on each pager. The mutex is recursive.
507**
508** This is a special-purpose mutex. It only provides mutual exclusion
509** between the Btree and the Memory Management sqlite3_release_memory()
510** function. It does not prevent, for example, two Btrees from accessing
511** the same pager at the same time. Other general-purpose mutexes in
512** the btree layer handle that chore.
513*/
514#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
515 static void pagerEnter(Pager *p){
516 p->iInUseDB++;
517 if( p->iInUseMM && p->iInUseDB==1 ){
518 sqlite3_mutex *mutex;
519 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
520 p->iInUseDB = 0;
521 sqlite3_mutex_enter(mutex);
522 p->iInUseDB = 1;
523 sqlite3_mutex_leave(mutex);
524 }
525 assert( p->iInUseMM==0 );
526 }
527 static void pagerLeave(Pager *p){
528 p->iInUseDB--;
529 assert( p->iInUseDB>=0 );
530 }
531#else
532# define pagerEnter(X)
533# define pagerLeave(X)
534#endif
535
536/*
danielk197784f786f2007-08-28 08:00:17 +0000537** Add page pPg to the end of the linked list managed by structure
538** pList (pPg becomes the last entry in the list - the most recently
539** used). Argument pLink should point to either pPg->free or pPg->gfree,
540** depending on whether pPg is being added to the pager-specific or
541** global LRU list.
542*/
danielk19779f61c2f2007-08-27 17:27:49 +0000543static void listAdd(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
544 pLink->pNext = 0;
545 pLink->pPrev = pList->pLast;
546
danielk197784f786f2007-08-28 08:00:17 +0000547#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
548 assert(pLink==&pPg->free || pLink==&pPg->gfree);
549 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
550#endif
551
danielk19779f61c2f2007-08-27 17:27:49 +0000552 if( pList->pLast ){
553 int iOff = (char *)pLink - (char *)pPg;
554 PagerLruLink *pLastLink = (PagerLruLink *)(&((u8 *)pList->pLast)[iOff]);
555 pLastLink->pNext = pPg;
556 }else{
557 assert(!pList->pFirst);
558 pList->pFirst = pPg;
559 }
560
561 pList->pLast = pPg;
562 if( !pList->pFirstSynced && pPg->needSync==0 ){
563 pList->pFirstSynced = pPg;
564 }
565}
566
danielk197784f786f2007-08-28 08:00:17 +0000567/*
568** Remove pPg from the list managed by the structure pointed to by pList.
569**
570** Argument pLink should point to either pPg->free or pPg->gfree, depending
571** on whether pPg is being added to the pager-specific or global LRU list.
572*/
danielk19779f61c2f2007-08-27 17:27:49 +0000573static void listRemove(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
574 int iOff = (char *)pLink - (char *)pPg;
575
danielk197784f786f2007-08-28 08:00:17 +0000576#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
577 assert(pLink==&pPg->free || pLink==&pPg->gfree);
578 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
579#endif
580
danielk19779f61c2f2007-08-27 17:27:49 +0000581 if( pPg==pList->pFirst ){
582 pList->pFirst = pLink->pNext;
583 }
584 if( pPg==pList->pLast ){
585 pList->pLast = pLink->pPrev;
586 }
587 if( pLink->pPrev ){
588 PagerLruLink *pPrevLink = (PagerLruLink *)(&((u8 *)pLink->pPrev)[iOff]);
589 pPrevLink->pNext = pLink->pNext;
590 }
591 if( pLink->pNext ){
592 PagerLruLink *pNextLink = (PagerLruLink *)(&((u8 *)pLink->pNext)[iOff]);
593 pNextLink->pPrev = pLink->pPrev;
594 }
595 if( pPg==pList->pFirstSynced ){
596 PgHdr *p = pLink->pNext;
597 while( p && p->needSync ){
598 PagerLruLink *pL = (PagerLruLink *)(&((u8 *)p)[iOff]);
599 p = pL->pNext;
600 }
601 pList->pFirstSynced = p;
602 }
603
604 pLink->pNext = pLink->pPrev = 0;
605}
606
607/*
danielk197784f786f2007-08-28 08:00:17 +0000608** Add page pPg to the list of free pages for the pager. If
609** memory-management is enabled, also add the page to the global
610** list of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000611*/
612static void lruListAdd(PgHdr *pPg){
613 listAdd(&pPg->pPager->lru, &pPg->free, pPg);
614#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
615 if( !pPg->pPager->memDb ){
616 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
617 listAdd(&sqlite3LruPageList, &pPg->gfree, pPg);
618 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
619 }
620#endif
621}
622
623/*
danielk197784f786f2007-08-28 08:00:17 +0000624** Remove page pPg from the list of free pages for the associated pager.
625** If memory-management is enabled, also remove pPg from the global list
626** of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000627*/
628static void lruListRemove(PgHdr *pPg){
629 listRemove(&pPg->pPager->lru, &pPg->free, pPg);
630#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
631 if( !pPg->pPager->memDb ){
632 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
633 listRemove(&sqlite3LruPageList, &pPg->gfree, pPg);
634 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
635 }
636#endif
637}
638
639/*
danielk197784f786f2007-08-28 08:00:17 +0000640** This function is called just after the needSync flag has been cleared
641** from all pages managed by pPager (usually because the journal file
642** has just been synced). It updates the pPager->lru.pFirstSynced variable
643** and, if memory-management is enabled, the sqlite3LruPageList.pFirstSynced
644** variable also.
danielk19779f61c2f2007-08-27 17:27:49 +0000645*/
646static void lruListSetFirstSynced(Pager *pPager){
647 pPager->lru.pFirstSynced = pPager->lru.pFirst;
648#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
649 if( !pPager->memDb ){
650 PgHdr *p;
651 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
652 for(p=sqlite3LruPageList.pFirst; p && p->needSync; p=p->gfree.pNext);
653 assert(p==pPager->lru.pFirstSynced || p==sqlite3LruPageList.pFirstSynced);
654 sqlite3LruPageList.pFirstSynced = p;
655 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
656 }
657#endif
658}
659
danielk1977f35843b2007-04-07 15:03:17 +0000660/*
661** Return true if page *pPg has already been written to the statement
662** journal (or statement snapshot has been created, if *pPg is part
663** of an in-memory database).
664*/
665static int pageInStatement(PgHdr *pPg){
666 Pager *pPager = pPg->pPager;
667 if( MEMDB ){
668 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
669 }else{
drhf5e7bb52008-02-18 14:47:33 +0000670 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000671 }
672}
drh8ca0c722006-05-07 17:49:38 +0000673
674/*
675** Change the size of the pager hash table to N. N must be a power
676** of two.
677*/
678static void pager_resize_hash_table(Pager *pPager, int N){
679 PgHdr **aHash, *pPg;
680 assert( N>0 && (N&(N-1))==0 );
drheee4c8c2008-02-18 22:24:57 +0000681#ifdef SQLITE_MALLOC_SOFT_LIMIT
682 if( N*sizeof(aHash[0])>SQLITE_MALLOC_SOFT_LIMIT ){
683 N = SQLITE_MALLOC_SOFT_LIMIT/sizeof(aHash[0]);
684 }
685 if( N==pPager->nHash ) return;
686#endif
drhed138fb2007-08-22 22:04:37 +0000687 pagerLeave(pPager);
drh643167f2008-01-22 21:30:53 +0000688 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, pPager->aHash!=0);
drh17435752007-08-16 04:30:38 +0000689 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drh643167f2008-01-22 21:30:53 +0000690 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, 0);
drhed138fb2007-08-22 22:04:37 +0000691 pagerEnter(pPager);
drh8ca0c722006-05-07 17:49:38 +0000692 if( aHash==0 ){
693 /* Failure to rehash is not an error. It is only a performance hit. */
694 return;
695 }
drh17435752007-08-16 04:30:38 +0000696 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000697 pPager->nHash = N;
698 pPager->aHash = aHash;
699 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000700 int h;
701 if( pPg->pgno==0 ){
702 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
703 continue;
704 }
705 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000706 pPg->pNextHash = aHash[h];
707 if( aHash[h] ){
708 aHash[h]->pPrevHash = pPg;
709 }
710 aHash[h] = pPg;
711 pPg->pPrevHash = 0;
712 }
713}
714
drhdd793422001-06-28 01:54:48 +0000715/*
drh34e79ce2004-02-08 06:05:46 +0000716** Read a 32-bit integer from the given file descriptor. Store the integer
717** that is read in *pRes. Return SQLITE_OK if everything worked, or an
718** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000719**
720** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000721*/
danielk197762079062007-08-15 17:08:46 +0000722static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000723 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000724 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000725 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000726 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000727 }
drh94f33312002-08-12 12:29:56 +0000728 return rc;
729}
730
731/*
drh97b57482006-01-10 20:32:32 +0000732** Write a 32-bit integer into a string buffer in big-endian byte order.
733*/
drha3152892007-05-05 11:48:52 +0000734#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000735
736/*
drh34e79ce2004-02-08 06:05:46 +0000737** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
738** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000739*/
danielk197762079062007-08-15 17:08:46 +0000740static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000741 char ac[4];
drh97b57482006-01-10 20:32:32 +0000742 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000743 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000744}
745
drh2554f8b2003-01-22 01:26:44 +0000746/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000747** If file pFd is open, call sqlite3OsUnlock() on it.
748*/
749static int osUnlock(sqlite3_file *pFd, int eLock){
750 if( !pFd->pMethods ){
751 return SQLITE_OK;
752 }
753 return sqlite3OsUnlock(pFd, eLock);
754}
755
756/*
danielk1977c7b60172007-08-22 11:22:03 +0000757** This function determines whether or not the atomic-write optimization
758** can be used with this pager. The optimization can be used if:
759**
760** (a) the value returned by OsDeviceCharacteristics() indicates that
761** a database page may be written atomically, and
762** (b) the value returned by OsSectorSize() is less than or equal
763** to the page size.
764**
765** If the optimization cannot be used, 0 is returned. If it can be used,
766** then the value returned is the size of the journal file when it
767** contains rollback data for exactly one page.
768*/
769#ifdef SQLITE_ENABLE_ATOMIC_WRITE
770static int jrnlBufferSize(Pager *pPager){
771 int dc; /* Device characteristics */
772 int nSector; /* Sector size */
773 int nPage; /* Page size */
774 sqlite3_file *fd = pPager->fd;
775
776 if( fd->pMethods ){
777 dc = sqlite3OsDeviceCharacteristics(fd);
778 nSector = sqlite3OsSectorSize(fd);
779 nPage = pPager->pageSize;
780 }
781
782 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
783 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
784
danielk1977f8940ae2007-08-23 11:07:10 +0000785 if( !fd->pMethods || (dc&(SQLITE_IOCAP_ATOMIC|(nPage>>8))&&nSector<=nPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000786 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
787 }
788 return 0;
789}
790#endif
791
792/*
danielk1977aef0bf62005-12-30 16:28:01 +0000793** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000794** code. The first argument is a pointer to the pager structure, the
795** second the error-code about to be returned by a pager API function.
796** The value returned is a copy of the second argument to this function.
797**
drh4f0ee682007-03-30 20:43:40 +0000798** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000799** the error becomes persistent. Until the persisten error is cleared,
800** subsequent API calls on this Pager will immediately return the same
801** error code.
802**
803** A persistent error indicates that the contents of the pager-cache
804** cannot be trusted. This state can be cleared by completely discarding
805** the contents of the pager-cache. If a transaction was active when
806** the persistent error occured, then the rollback journal may need
807** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000808*/
danielk1977ae72d982007-10-03 08:46:44 +0000809static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000810static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000811 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000812 assert(
813 pPager->errCode==SQLITE_FULL ||
814 pPager->errCode==SQLITE_OK ||
815 (pPager->errCode & 0xff)==SQLITE_IOERR
816 );
danielk1977979f38e2007-03-27 16:19:51 +0000817 if(
drh4ac285a2006-09-15 07:28:50 +0000818 rc2==SQLITE_FULL ||
819 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000820 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000821 ){
822 pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000823 if( pPager->state==PAGER_UNLOCK && pPager->nRef==0 ){
824 /* If the pager is already unlocked, call pager_unlock() now to
825 ** clear the error state and ensure that the pager-cache is
826 ** completely empty.
827 */
828 pager_unlock(pPager);
829 }
danielk1977aef0bf62005-12-30 16:28:01 +0000830 }
831 return rc;
832}
833
drh477731b2007-06-16 03:06:27 +0000834/*
835** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
836** on the cache using a hash function. This is used for testing
837** and debugging only.
838*/
danielk19773c407372005-02-15 02:54:14 +0000839#ifdef SQLITE_CHECK_PAGES
840/*
841** Return a 32-bit hash of the page data for pPage.
842*/
drh477731b2007-06-16 03:06:27 +0000843static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000844 u32 hash = 0;
845 int i;
drh477731b2007-06-16 03:06:27 +0000846 for(i=0; i<nByte; i++){
847 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000848 }
849 return hash;
850}
drh477731b2007-06-16 03:06:27 +0000851static u32 pager_pagehash(PgHdr *pPage){
852 return pager_datahash(pPage->pPager->pageSize,
853 (unsigned char *)PGHDR_TO_DATA(pPage));
854}
danielk19773c407372005-02-15 02:54:14 +0000855
856/*
857** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
858** is defined, and NDEBUG is not defined, an assert() statement checks
859** that the page is either dirty or still matches the calculated page-hash.
860*/
861#define CHECK_PAGE(x) checkPage(x)
862static void checkPage(PgHdr *pPg){
863 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000864 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000865 pPg->pageHash==pager_pagehash(pPg) );
866}
867
868#else
drh8ffa8172007-06-18 17:25:17 +0000869#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000870#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000871#define CHECK_PAGE(x)
872#endif
873
drhed7c8552001-04-11 14:29:21 +0000874/*
danielk197776572402004-06-25 02:38:54 +0000875** When this is called the journal file for pager pPager must be open.
876** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000877** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000878**
danielk197765839c62007-08-30 08:08:17 +0000879** zMaster must point to a buffer of at least nMaster bytes allocated by
880** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
881** enough space to write the master journal name). If the master journal
882** name in the journal is longer than nMaster bytes (including a
883** nul-terminator), then this is handled as if no master journal name
884** were present in the journal.
885**
886** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000887** SQLITE_OK returned.
888*/
danielk197765839c62007-08-30 08:08:17 +0000889static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000890 int rc;
891 u32 len;
drheb206252004-10-01 02:00:31 +0000892 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000893 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000894 int i;
danielk197776572402004-06-25 02:38:54 +0000895 unsigned char aMagic[8]; /* A buffer to hold the magic header */
896
danielk197765839c62007-08-30 08:08:17 +0000897 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000898
drh054889e2005-11-30 03:20:31 +0000899 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000900 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000901
danielk197762079062007-08-15 17:08:46 +0000902 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000903 if( rc!=SQLITE_OK ) return rc;
904
danielk197765839c62007-08-30 08:08:17 +0000905 if( len>=nMaster ){
906 return SQLITE_OK;
907 }
908
danielk197762079062007-08-15 17:08:46 +0000909 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000910 if( rc!=SQLITE_OK ) return rc;
911
danielk197762079062007-08-15 17:08:46 +0000912 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000913 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
914
danielk197765839c62007-08-30 08:08:17 +0000915 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000916 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000917 return rc;
918 }
danielk197765839c62007-08-30 08:08:17 +0000919 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000920
921 /* See if the checksum matches the master journal name */
922 for(i=0; i<len; i++){
danielk197765839c62007-08-30 08:08:17 +0000923 cksum -= zMaster[i];
924 }
danielk19778191bff2004-06-28 04:52:30 +0000925 if( cksum ){
926 /* If the checksum doesn't add up, then one or more of the disk sectors
927 ** containing the master journal filename is corrupted. This means
928 ** definitely roll back, so just return SQLITE_OK and report a (nul)
929 ** master-journal filename.
930 */
danielk197765839c62007-08-30 08:08:17 +0000931 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000932 }
danielk197776572402004-06-25 02:38:54 +0000933
934 return SQLITE_OK;
935}
936
937/*
938** Seek the journal file descriptor to the next sector boundary where a
939** journal header may be read or written. Pager.journalOff is updated with
940** the new seek offset.
941**
942** i.e for a sector size of 512:
943**
944** Input Offset Output Offset
945** ---------------------------------------
946** 0 0
947** 512 512
948** 100 512
949** 2000 2048
950**
951*/
danielk197762079062007-08-15 17:08:46 +0000952static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000953 i64 offset = 0;
954 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000955 if( c ){
956 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
957 }
958 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
959 assert( offset>=c );
960 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
961 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000962}
963
964/*
drhf3a87622008-04-17 14:16:42 +0000965** Write zeros over the header of the journal file. This has the
966** effect of invalidating the journal file and committing the
967** transaction.
968*/
969static int zeroJournalHdr(Pager *pPager){
970 int rc;
971 static const char zeroHdr[28];
972
973 IOTRACE(("JZEROHDR %p\n", pPager))
974 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
drha06ecba2008-04-22 17:15:17 +0000975 if( rc==SQLITE_OK ){
976 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY | pPager->sync_flags);
977 }
drhf3a87622008-04-17 14:16:42 +0000978 return rc;
979}
980
981/*
danielk197776572402004-06-25 02:38:54 +0000982** The journal file must be open when this routine is called. A journal
983** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
984** current location.
985**
986** The format for the journal header is as follows:
987** - 8 bytes: Magic identifying journal format.
988** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
989** - 4 bytes: Random number used for page hash.
990** - 4 bytes: Initial database page count.
991** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000992** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000993**
danielk197767c007b2008-03-20 04:45:49 +0000994** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000995*/
996static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000997 int rc = SQLITE_OK;
998 char *zHeader = pPager->pTmpSpace;
999 int nHeader = pPager->pageSize;
1000 int nWrite;
1001
1002 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
1003 nHeader = JOURNAL_HDR_SZ(pPager);
1004 }
danielk197776572402004-06-25 02:38:54 +00001005
danielk19774099f6e2007-03-19 11:25:20 +00001006 if( pPager->stmtHdrOff==0 ){
1007 pPager->stmtHdrOff = pPager->journalOff;
1008 }
1009
danielk197762079062007-08-15 17:08:46 +00001010 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001011 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001012
drh97b57482006-01-10 20:32:32 +00001013 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +00001014
1015 /*
1016 ** Write the nRec Field - the number of page records that follow this
1017 ** journal header. Normally, zero is written to this value at this time.
1018 ** After the records are added to the journal (and the journal synced,
1019 ** if in full-sync mode), the zero is overwritten with the true number
1020 ** of records (see syncJournal()).
1021 **
1022 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
1023 ** reading the journal this value tells SQLite to assume that the
1024 ** rest of the journal file contains valid page records. This assumption
1025 ** is dangerous, as if a failure occured whilst writing to the journal
1026 ** file it may contain some garbage data. There are two scenarios
1027 ** where this risk can be ignored:
1028 **
1029 ** * When the pager is in no-sync mode. Corruption can follow a
1030 ** power failure in this case anyway.
1031 **
1032 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
1033 ** that garbage data is never appended to the journal file.
1034 */
1035 assert(pPager->fd->pMethods||pPager->noSync);
1036 if( (pPager->noSync)
1037 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
1038 ){
1039 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
1040 }else{
1041 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
1042 }
1043
drh97b57482006-01-10 20:32:32 +00001044 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +00001045 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +00001046 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
1047 /* The initial database size */
1048 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
1049 /* The assumed sector size for this process */
1050 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +00001051 if( pPager->journalHdr==0 ){
1052 /* The page size */
1053 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
1054 }
danielk197776572402004-06-25 02:38:54 +00001055
danielk1977a664f8e2008-04-22 14:31:48 +00001056 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
1057 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
1058 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
1059 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +00001060 }
danielk1977a664f8e2008-04-22 14:31:48 +00001061
danielk197776572402004-06-25 02:38:54 +00001062 return rc;
1063}
1064
1065/*
1066** The journal file must be open when this is called. A journal header file
1067** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
1068** file. See comments above function writeJournalHdr() for a description of
1069** the journal header format.
1070**
1071** If the header is read successfully, *nRec is set to the number of
1072** page records following this header and *dbSize is set to the size of the
1073** database before the transaction began, in pages. Also, pPager->cksumInit
1074** is set to the value read from the journal header. SQLITE_OK is returned
1075** in this case.
1076**
1077** If the journal header file appears to be corrupted, SQLITE_DONE is
1078** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
1079** cannot be read from the journal file an error code is returned.
1080*/
1081static int readJournalHdr(
1082 Pager *pPager,
drheb206252004-10-01 02:00:31 +00001083 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +00001084 u32 *pNRec,
1085 u32 *pDbSize
1086){
1087 int rc;
1088 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +00001089 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +00001090 int iPageSize;
danielk197776572402004-06-25 02:38:54 +00001091
danielk197762079062007-08-15 17:08:46 +00001092 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001093 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
1094 return SQLITE_DONE;
1095 }
danielk197762079062007-08-15 17:08:46 +00001096 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001097
danielk197762079062007-08-15 17:08:46 +00001098 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001099 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +00001100 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +00001101
1102 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
1103 return SQLITE_DONE;
1104 }
1105
danielk197762079062007-08-15 17:08:46 +00001106 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +00001107 if( rc ) return rc;
1108
danielk197762079062007-08-15 17:08:46 +00001109 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +00001110 if( rc ) return rc;
1111
danielk197762079062007-08-15 17:08:46 +00001112 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +00001113 if( rc ) return rc;
1114
danielk197767c007b2008-03-20 04:45:49 +00001115 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
1116 if( rc==SQLITE_OK
1117 && iPageSize>=512
1118 && iPageSize<=SQLITE_MAX_PAGE_SIZE
1119 && ((iPageSize-1)&iPageSize)==0
1120 ){
1121 u16 pagesize = iPageSize;
1122 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
1123 }
1124 if( rc ) return rc;
1125
danielk197776572402004-06-25 02:38:54 +00001126 /* Update the assumed sector-size to match the value used by
1127 ** the process that created this journal. If this journal was
1128 ** created by a process other than this one, then this routine
1129 ** is being called from within pager_playback(). The local value
1130 ** of Pager.sectorSize is restored at the end of that routine.
1131 */
danielk197762079062007-08-15 17:08:46 +00001132 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +00001133 if( rc ) return rc;
1134
1135 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +00001136 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +00001137}
1138
1139
1140/*
1141** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +00001142** pPager at the current location. The master journal name must be the last
1143** thing written to a journal file. If the pager is in full-sync mode, the
1144** journal file descriptor is advanced to the next sector boundary before
1145** anything is written. The format is:
1146**
1147** + 4 bytes: PAGER_MJ_PGNO.
1148** + N bytes: length of master journal name.
1149** + 4 bytes: N
1150** + 4 bytes: Master journal name checksum.
1151** + 8 bytes: aJournalMagic[].
1152**
1153** The master journal page checksum is the sum of the bytes in the master
1154** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +00001155**
1156** If zMaster is a NULL pointer (occurs for a single database transaction),
1157** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +00001158*/
1159static int writeMasterJournal(Pager *pPager, const char *zMaster){
1160 int rc;
1161 int len;
danielk1977cafadba2004-06-25 11:11:54 +00001162 int i;
danielk197762079062007-08-15 17:08:46 +00001163 i64 jrnlOff;
drh97b57482006-01-10 20:32:32 +00001164 u32 cksum = 0;
1165 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +00001166
1167 if( !zMaster || pPager->setMaster) return SQLITE_OK;
1168 pPager->setMaster = 1;
1169
1170 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +00001171 for(i=0; i<len; i++){
1172 cksum += zMaster[i];
1173 }
danielk197776572402004-06-25 02:38:54 +00001174
1175 /* If in full-sync mode, advance to the next disk sector before writing
1176 ** the master journal name. This is in case the previous page written to
1177 ** the journal has already been synced.
1178 */
1179 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +00001180 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001181 }
danielk197762079062007-08-15 17:08:46 +00001182 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +00001183 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +00001184
danielk197762079062007-08-15 17:08:46 +00001185 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +00001186 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001187 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +00001188
danielk197762079062007-08-15 17:08:46 +00001189 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001190 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001191 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +00001192
drh97b57482006-01-10 20:32:32 +00001193 put32bits(zBuf, len);
1194 put32bits(&zBuf[4], cksum);
1195 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +00001196 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
drh2c8997b2005-08-27 16:36:48 +00001197 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +00001198 return rc;
1199}
1200
1201/*
drh03eb96a2002-11-10 23:32:56 +00001202** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +00001203** statement journal.
drh03eb96a2002-11-10 23:32:56 +00001204**
1205** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +00001206** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +00001207** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +00001208** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +00001209*/
drh3aac2dd2004-04-26 14:10:20 +00001210static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +00001211 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +00001212 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1213 assert( MEMDB );
1214 if( !pHist->inStmt ){
1215 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
1216 if( pPager->pStmt ){
1217 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
1218 }
1219 pHist->pNextStmt = pPager->pStmt;
1220 pPager->pStmt = pPg;
1221 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +00001222 }
drh03eb96a2002-11-10 23:32:56 +00001223}
1224
1225/*
drhed7c8552001-04-11 14:29:21 +00001226** Find a page in the hash table given its page number. Return
1227** a pointer to the page or NULL if not found.
1228*/
drhd9b02572001-04-15 00:37:09 +00001229static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +00001230 PgHdr *p;
1231 if( pPager->aHash==0 ) return 0;
1232 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +00001233 while( p && p->pgno!=pgno ){
1234 p = p->pNextHash;
1235 }
1236 return p;
1237}
1238
1239/*
danielk1977e180dd92007-04-05 17:15:52 +00001240** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +00001241** sets the state of the pager back to what it was when it was first
1242** opened. Any outstanding pages are invalidated and subsequent attempts
1243** to access those pages will likely result in a coredump.
1244*/
drhd9b02572001-04-15 00:37:09 +00001245static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00001246 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +00001247 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +00001248 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +00001249 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
1250 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +00001251 pNext = pPg->pNextAll;
danielk19779f61c2f2007-08-27 17:27:49 +00001252 lruListRemove(pPg);
drh0d180202008-02-14 23:26:56 +00001253 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00001254 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +00001255 }
danielk19779f61c2f2007-08-27 17:27:49 +00001256 assert(pPager->lru.pFirst==0);
1257 assert(pPager->lru.pFirstSynced==0);
1258 assert(pPager->lru.pLast==0);
danielk1977b94bf852007-03-19 13:53:37 +00001259 pPager->pStmt = 0;
drhd9b02572001-04-15 00:37:09 +00001260 pPager->pAll = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001261 pPager->pDirty = 0;
drh8ca0c722006-05-07 17:49:38 +00001262 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +00001263 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +00001264 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +00001265 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +00001266 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +00001267}
1268
1269/*
danielk1977ae72d982007-10-03 08:46:44 +00001270** Unlock the database file.
1271**
1272** If the pager is currently in error state, discard the contents of
1273** the cache and reset the Pager structure internal state. If there is
1274** an open journal-file, then the next time a shared-lock is obtained
1275** on the pager file (by this or any other process), it will be
1276** treated as a hot-journal and rolled back.
1277*/
1278static void pager_unlock(Pager *pPager){
1279 if( !pPager->exclusiveMode ){
1280 if( !MEMDB ){
drh1aa5af12008-03-07 19:51:14 +00001281 int rc = osUnlock(pPager->fd, NO_LOCK);
drh308aa322008-03-07 20:14:38 +00001282 if( rc ) pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +00001283 pPager->dbSize = -1;
1284 IOTRACE(("UNLOCK %p\n", pPager))
1285
drh16e45a42008-04-19 20:34:18 +00001286 /* Always close the journal file when dropping the database lock.
1287 ** Otherwise, another connection with journal_mode=delete might
1288 ** delete the file out from under us.
1289 */
1290 if( pPager->journalOpen ){
1291 sqlite3OsClose(pPager->jfd);
1292 pPager->journalOpen = 0;
1293 sqlite3BitvecDestroy(pPager->pInJournal);
1294 pPager->pInJournal = 0;
1295 }
1296
danielk1977ae72d982007-10-03 08:46:44 +00001297 /* If Pager.errCode is set, the contents of the pager cache cannot be
1298 ** trusted. Now that the pager file is unlocked, the contents of the
1299 ** cache can be discarded and the error code safely cleared.
1300 */
1301 if( pPager->errCode ){
drh1aa5af12008-03-07 19:51:14 +00001302 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00001303 pager_reset(pPager);
1304 if( pPager->stmtOpen ){
1305 sqlite3OsClose(pPager->stfd);
drhf5e7bb52008-02-18 14:47:33 +00001306 sqlite3BitvecDestroy(pPager->pInStmt);
1307 pPager->pInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001308 }
danielk1977ae72d982007-10-03 08:46:44 +00001309 pPager->stmtOpen = 0;
1310 pPager->stmtInUse = 0;
1311 pPager->journalOff = 0;
1312 pPager->journalStarted = 0;
1313 pPager->stmtAutoopen = 0;
1314 pPager->origDbSize = 0;
1315 }
1316 }
1317
1318 if( !MEMDB || pPager->errCode==SQLITE_OK ){
1319 pPager->state = PAGER_UNLOCK;
1320 pPager->changeCountDone = 0;
1321 }
1322 }
1323}
1324
1325/*
1326** Execute a rollback if a transaction is active and unlock the
1327** database file. If the pager has already entered the error state,
1328** do not attempt the rollback.
1329*/
1330static void pagerUnlockAndRollback(Pager *p){
drhfdc40e92008-04-17 20:59:37 +00001331 /* assert( p->state>=PAGER_RESERVED || p->journalOpen==0 ); */
danielk1977ae72d982007-10-03 08:46:44 +00001332 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
1333 sqlite3PagerRollback(p);
1334 }
1335 pager_unlock(p);
drhfdc40e92008-04-17 20:59:37 +00001336#if 0
danielk1977ae72d982007-10-03 08:46:44 +00001337 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
1338 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drhfdc40e92008-04-17 20:59:37 +00001339#endif
danielk1977ae72d982007-10-03 08:46:44 +00001340}
1341
1342/*
drh80e35f42007-03-30 14:06:34 +00001343** This routine ends a transaction. A transaction is ended by either
1344** a COMMIT or a ROLLBACK.
1345**
drhed7c8552001-04-11 14:29:21 +00001346** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001347** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1348** the database lock and acquires a SHARED lock in its place if that is
1349** the appropriate thing to do. Release locks usually is appropriate,
1350** unless we are in exclusive access mode or unless this is a
1351** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1352**
1353** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001354**
1355** TODO: Consider keeping the journal file open for temporary databases.
1356** This might give a performance improvement on windows where opening
1357** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001358*/
drh80e35f42007-03-30 14:06:34 +00001359static int pager_end_transaction(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001360 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001361 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001362 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001363 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001364 if( pPager->state<PAGER_RESERVED ){
1365 return SQLITE_OK;
1366 }
danielk19773b8a05f2007-03-19 17:44:26 +00001367 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001368 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001369 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001370 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001371 }
drhda47d772002-12-02 04:25:19 +00001372 if( pPager->journalOpen ){
drhfdc40e92008-04-17 20:59:37 +00001373 if( (pPager->exclusiveMode ||
1374 pPager->journalMode==PAGER_JOURNALMODE_PERSIST)
1375 && (rc = zeroJournalHdr(pPager))==SQLITE_OK ){
danielk197741483462007-03-24 16:45:04 +00001376 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001377 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001378 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001379 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001380 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +00001381 if( rc==SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001382 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001383 }
danielk197741483462007-03-24 16:45:04 +00001384 }
drhf5e7bb52008-02-18 14:47:33 +00001385 sqlite3BitvecDestroy(pPager->pInJournal);
1386 pPager->pInJournal = 0;
drhda47d772002-12-02 04:25:19 +00001387 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1388 pPg->inJournal = 0;
1389 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001390 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001391 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001392#ifdef SQLITE_CHECK_PAGES
1393 pPg->pageHash = pager_pagehash(pPg);
1394#endif
drhda47d772002-12-02 04:25:19 +00001395 }
drh605ad8f2006-05-03 23:34:05 +00001396 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001397 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001398 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001399 }else{
drhf5e7bb52008-02-18 14:47:33 +00001400 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001401 }
danielk1977979f38e2007-03-27 16:19:51 +00001402
danielk197741483462007-03-24 16:45:04 +00001403 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001404 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001405 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001406 }else if( pPager->state==PAGER_SYNCED ){
1407 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001408 }
danielk1977334cdb62007-03-26 08:05:12 +00001409 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001410 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001411 pPager->needSync = 0;
danielk19779f61c2f2007-08-27 17:27:49 +00001412 lruListSetFirstSynced(pPager);
drh588f5bc2007-01-02 18:41:54 +00001413 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +00001414
1415 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001416}
1417
drhed7c8552001-04-11 14:29:21 +00001418/*
drh968af522003-02-11 14:55:40 +00001419** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001420**
1421** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001422** random initial value and the page number. We experimented with
1423** a checksum of the entire data, but that was found to be too slow.
1424**
1425** Note that the page number is stored at the beginning of data and
1426** the checksum is stored at the end. This is important. If journal
1427** corruption occurs due to a power failure, the most likely scenario
1428** is that one end or the other of the record will be changed. It is
1429** much less likely that the two ends of the journal record will be
1430** correct and the middle be corrupt. Thus, this "checksum" scheme,
1431** though fast and simple, catches the mostly likely kind of corruption.
1432**
1433** FIX ME: Consider adding every 200th (or so) byte of the data to the
1434** checksum. That way if a single page spans 3 or more disk sectors and
1435** only the middle sector is corrupt, we will still have a reasonable
1436** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001437*/
drh74161702006-02-24 02:53:49 +00001438static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001439 u32 cksum = pPager->cksumInit;
1440 int i = pPager->pageSize-200;
1441 while( i>0 ){
1442 cksum += aData[i];
1443 i -= 200;
1444 }
drh968af522003-02-11 14:55:40 +00001445 return cksum;
1446}
1447
drh605ad8f2006-05-03 23:34:05 +00001448/* Forward declaration */
1449static void makeClean(PgHdr*);
1450
drh968af522003-02-11 14:55:40 +00001451/*
drhfa86c412002-02-02 15:01:15 +00001452** Read a single page from the journal file opened on file descriptor
1453** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001454**
drh726de592004-06-10 23:35:50 +00001455** If useCksum==0 it means this journal does not use checksums. Checksums
1456** are not used in statement journals because statement journals do not
1457** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001458*/
danielk197762079062007-08-15 17:08:46 +00001459static int pager_playback_one_page(
1460 Pager *pPager,
1461 sqlite3_file *jfd,
1462 i64 offset,
1463 int useCksum
1464){
drhfa86c412002-02-02 15:01:15 +00001465 int rc;
drhae2b40c2004-06-09 19:03:54 +00001466 PgHdr *pPg; /* An existing page in the cache */
1467 Pgno pgno; /* The page number of a page in journal */
1468 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001469 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001470
drh96362842005-03-20 22:47:56 +00001471 /* useCksum should be true for the main journal and false for
1472 ** statement journals. Verify that this is always the case
1473 */
drh9cbe6352005-11-29 03:13:21 +00001474 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001475 assert( aData );
drh96362842005-03-20 22:47:56 +00001476
danielk197762079062007-08-15 17:08:46 +00001477 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001478 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001479 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001480 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001481 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001482
drh968af522003-02-11 14:55:40 +00001483 /* Sanity checking on the page. This is more important that I originally
1484 ** thought. If a power failure occurs while the journal is being written,
1485 ** it could cause invalid data to be written into the journal. We need to
1486 ** detect this invalid data (with high probability) and ignore it.
1487 */
danielk197775edc162004-06-26 01:48:18 +00001488 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001489 return SQLITE_DONE;
1490 }
drhae2b40c2004-06-09 19:03:54 +00001491 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001492 return SQLITE_OK;
1493 }
drhae2b40c2004-06-09 19:03:54 +00001494 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001495 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001496 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001497 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001498 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001499 return SQLITE_DONE;
1500 }
1501 }
drhfa86c412002-02-02 15:01:15 +00001502
danielk1977aa5ccdf2004-06-14 05:10:42 +00001503 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001504
1505 /* If the pager is in RESERVED state, then there must be a copy of this
1506 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001507 ** not the database file. The page is left marked dirty in this case.
1508 **
danielk19772df71c72007-05-24 07:22:42 +00001509 ** An exception to the above rule: If the database is in no-sync mode
1510 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001511 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1512 ** during a Movepage() call, then the page may not be in the cache
1513 ** either. So the condition described in the above paragraph is not
1514 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001515 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001516 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1517 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001518 **
1519 ** Ticket #1171: The statement journal might contain page content that is
1520 ** different from the page content at the start of the transaction.
1521 ** This occurs when a page is changed prior to the start of a statement
1522 ** then changed again within the statement. When rolling back such a
1523 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001524 ** for certain that original page contents are synced into the main rollback
1525 ** journal. Otherwise, a power loss might leave modified data in the
1526 ** database file without an entry in the rollback journal that can
1527 ** restore the database to its original form. Two conditions must be
1528 ** met before writing to the database files. (1) the database must be
1529 ** locked. (2) we know that the original page content is fully synced
1530 ** in the main journal either because the page is not in cache or else
1531 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001532 **
1533 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1534 ** is possible to fail a statement on a database that does not yet exist.
1535 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001536 */
drhae2b40c2004-06-09 19:03:54 +00001537 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001538 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1539 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh4c02a232008-04-14 23:13:45 +00001540 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0)
1541 && pPager->fd->pMethods ){
danielk197762079062007-08-15 17:08:46 +00001542 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1543 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001544 if( pPg ){
1545 makeClean(pPg);
1546 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001547 }
drhfa86c412002-02-02 15:01:15 +00001548 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001549 /* No page should ever be explicitly rolled back that is in use, except
1550 ** for page 1 which is held in use in order to keep the lock on the
1551 ** database active. However such a page may be rolled back as a result
1552 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001553 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001554 */
drhb6f41482004-05-14 01:58:11 +00001555 void *pData;
danielk197728129562005-01-11 10:25:06 +00001556 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001557 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001558 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001559 if( pPager->xReiniter ){
1560 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001561 }
danielk19773c407372005-02-15 02:54:14 +00001562#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001563 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001564#endif
drh86a88112007-04-16 15:02:19 +00001565 /* If this was page 1, then restore the value of Pager.dbFileVers.
1566 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001567 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001568 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001569 }
drh86a88112007-04-16 15:02:19 +00001570
1571 /* Decode the page just read from disk */
1572 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001573 }
1574 return rc;
1575}
1576
1577/*
danielk197713adf8a2004-06-03 16:08:41 +00001578** Parameter zMaster is the name of a master journal file. A single journal
1579** file that referred to the master journal file has just been rolled back.
1580** This routine checks if it is possible to delete the master journal file,
1581** and does so if it is.
drh726de592004-06-10 23:35:50 +00001582**
danielk197765839c62007-08-30 08:08:17 +00001583** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1584** available for use within this function.
1585**
1586**
drh726de592004-06-10 23:35:50 +00001587** The master journal file contains the names of all child journals.
1588** To tell if a master journal can be deleted, check to each of the
1589** children. If all children are either missing or do not refer to
1590** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001591*/
danielk1977b4b47412007-08-17 15:53:36 +00001592static int pager_delmaster(Pager *pPager, const char *zMaster){
1593 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001594 int rc;
1595 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001596 sqlite3_file *pMaster;
1597 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001598 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001599 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001600
1601 /* Open the master journal file exclusively in case some other process
1602 ** is running this routine also. Not that it makes too much difference.
1603 */
danielk1977b4b47412007-08-17 15:53:36 +00001604 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001605 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001606 if( !pMaster ){
1607 rc = SQLITE_NOMEM;
1608 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001609 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1610 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001611 }
danielk197713adf8a2004-06-03 16:08:41 +00001612 if( rc!=SQLITE_OK ) goto delmaster_out;
1613 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001614
1615 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001616 if( rc!=SQLITE_OK ) goto delmaster_out;
1617
1618 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001619 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001620 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001621 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001622
1623 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001624 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001625 */
danielk197765839c62007-08-30 08:08:17 +00001626 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001627 if( !zMasterJournal ){
1628 rc = SQLITE_NOMEM;
1629 goto delmaster_out;
1630 }
danielk197765839c62007-08-30 08:08:17 +00001631 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001632 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001633 if( rc!=SQLITE_OK ) goto delmaster_out;
1634
danielk19775865e3d2004-06-14 06:03:57 +00001635 zJournal = zMasterJournal;
1636 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh19db9352008-03-27 22:42:51 +00001637 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS);
1638 if( rc!=0 && rc!=1 ){
1639 rc = SQLITE_IOERR_NOMEM;
1640 goto delmaster_out;
1641 }
1642 if( rc==1 ){
danielk197713adf8a2004-06-03 16:08:41 +00001643 /* One of the journals pointed to by the master journal exists.
1644 ** Open it and check if it points at the master journal. If
1645 ** so, return without deleting the master journal file.
1646 */
drh3b7b78b2004-11-24 01:16:43 +00001647 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001648 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1649 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001650 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001651 goto delmaster_out;
1652 }
danielk197713adf8a2004-06-03 16:08:41 +00001653
danielk197765839c62007-08-30 08:08:17 +00001654 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001655 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001656 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001657 goto delmaster_out;
1658 }
danielk197776572402004-06-25 02:38:54 +00001659
danielk197765839c62007-08-30 08:08:17 +00001660 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001661 if( c ){
danielk197776572402004-06-25 02:38:54 +00001662 /* We have a match. Do not delete the master journal file. */
1663 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001664 }
1665 }
danielk19775865e3d2004-06-14 06:03:57 +00001666 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001667 }
1668 }
1669
danielk1977fee2d252007-08-18 10:59:19 +00001670 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001671
1672delmaster_out:
1673 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001674 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001675 }
1676 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001677 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001678 }
danielk1977b4b47412007-08-17 15:53:36 +00001679 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001680 return rc;
1681}
1682
drha6abd042004-06-09 17:37:22 +00001683
danielk1977e180dd92007-04-05 17:15:52 +00001684static void pager_truncate_cache(Pager *pPager);
1685
drha6abd042004-06-09 17:37:22 +00001686/*
drhcb4c40b2004-08-18 19:09:43 +00001687** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001688** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001689**
1690** Might might be the case that the file on disk is smaller than nPage.
1691** This can happen, for example, if we are in the middle of a transaction
1692** which has extended the file size and the new pages are still all held
1693** in cache, then an INSERT or UPDATE does a statement rollback. Some
1694** operating system implementations can get confused if you try to
1695** truncate a file to some size that is larger than it currently is,
1696** so detect this case and do not do the truncation.
drhcb4c40b2004-08-18 19:09:43 +00001697*/
1698static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001699 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001700 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001701 i64 currentSize, newSize;
1702 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1703 newSize = pPager->pageSize*(i64)nPage;
1704 if( rc==SQLITE_OK && currentSize>newSize ){
1705 rc = sqlite3OsTruncate(pPager->fd, newSize);
1706 }
danielk1977e180dd92007-04-05 17:15:52 +00001707 }
1708 if( rc==SQLITE_OK ){
1709 pPager->dbSize = nPage;
1710 pager_truncate_cache(pPager);
1711 }
1712 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001713}
1714
1715/*
drhc80f0582007-05-01 16:59:48 +00001716** Set the sectorSize for the given pager.
1717**
drh334c80d2008-03-28 17:41:13 +00001718** The sector size is at least as big as the sector size reported
1719** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001720*/
1721static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001722 assert(pPager->fd->pMethods||pPager->tempFile);
1723 if( !pPager->tempFile ){
1724 /* Sector size doesn't matter for temporary files. Also, the file
1725 ** may not have been opened yet, in whcih case the OsSectorSize()
1726 ** call will segfault.
1727 */
1728 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1729 }
drh334c80d2008-03-28 17:41:13 +00001730 if( pPager->sectorSize<512 ){
1731 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001732 }
1733}
1734
1735/*
drhed7c8552001-04-11 14:29:21 +00001736** Playback the journal and thus restore the database file to
1737** the state it was in before we started making changes.
1738**
drh34e79ce2004-02-08 06:05:46 +00001739** The journal file format is as follows:
1740**
drhae2b40c2004-06-09 19:03:54 +00001741** (1) 8 byte prefix. A copy of aJournalMagic[].
1742** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001743** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001744** number of page records from the journal size.
1745** (3) 4 byte big-endian integer which is the initial value for the
1746** sanity checksum.
1747** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001748** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001749** (5) 4 byte big-endian integer which is the sector size. The header
1750** is this many bytes in size.
1751** (6) 4 byte big-endian integer which is the page case.
1752** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001753** name. The value may be zero (indicate that there is no master
1754** journal.)
drh334c80d2008-03-28 17:41:13 +00001755** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001756** and might be shorter than the value read from (5). If the first byte
1757** of the name is \000 then there is no master journal. The master
1758** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001759** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001760** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001761** + pPager->pageSize bytes of data.
1762** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001763**
drh334c80d2008-03-28 17:41:13 +00001764** When we speak of the journal header, we mean the first 8 items above.
1765** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001766**
1767** Call the value from the second bullet "nRec". nRec is the number of
1768** valid page entries in the journal. In most cases, you can compute the
1769** value of nRec from the size of the journal file. But if a power
1770** failure occurred while the journal was being written, it could be the
1771** case that the size of the journal file had already been increased but
1772** the extra entries had not yet made it safely to disk. In such a case,
1773** the value of nRec computed from the file size would be too large. For
1774** that reason, we always use the nRec value in the header.
1775**
1776** If the nRec value is 0xffffffff it means that nRec should be computed
1777** from the file size. This value is used when the user selects the
1778** no-sync option for the journal. A power failure could lead to corruption
1779** in this case. But for things like temporary table (which will be
1780** deleted when the power is restored) we don't care.
1781**
drhd9b02572001-04-15 00:37:09 +00001782** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001783** journal file then all pages up to the first corrupted page are rolled
1784** back (or no pages if the journal header is corrupted). The journal file
1785** is then deleted and SQLITE_OK returned, just as if no corruption had
1786** been encountered.
1787**
1788** If an I/O or malloc() error occurs, the journal-file is not deleted
1789** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001790*/
danielk1977e277be02007-03-23 18:12:06 +00001791static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001792 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001793 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001794 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001795 int i; /* Loop counter */
1796 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001797 int rc; /* Result code of a subroutine */
danielk1977ce98bba2008-04-03 10:13:01 +00001798 int res = 0; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001799 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001800
drhc3a64ba2001-11-22 00:01:27 +00001801 /* Figure out how many records are in the journal. Abort early if
1802 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001803 */
drh8cfbf082001-09-19 13:22:39 +00001804 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001805 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001806 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001807 goto end_playback;
1808 }
drh240c5792004-02-08 00:40:52 +00001809
danielk197776572402004-06-25 02:38:54 +00001810 /* Read the master journal name from the journal, if it is present.
1811 ** If a master journal file name is specified, but the file is not
1812 ** present on disk, then the journal is not hot and does not need to be
1813 ** played back.
drh240c5792004-02-08 00:40:52 +00001814 */
danielk197765839c62007-08-30 08:08:17 +00001815 zMaster = pPager->pTmpSpace;
1816 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977ce98bba2008-04-03 10:13:01 +00001817 if( rc!=SQLITE_OK || (zMaster[0]
1818 && (res=sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS))==0 )
danielk1977b4b47412007-08-17 15:53:36 +00001819 ){
danielk197776572402004-06-25 02:38:54 +00001820 zMaster = 0;
drhc3a64ba2001-11-22 00:01:27 +00001821 goto end_playback;
1822 }
danielk197765839c62007-08-30 08:08:17 +00001823 zMaster = 0;
danielk1977ce98bba2008-04-03 10:13:01 +00001824 if( res<0 ){
1825 rc = SQLITE_IOERR_NOMEM;
1826 goto end_playback;
1827 }
1828 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001829
danielk197776572402004-06-25 02:38:54 +00001830 /* This loop terminates either when the readJournalHdr() call returns
1831 ** SQLITE_DONE or an IO error occurs. */
1832 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001833
danielk197776572402004-06-25 02:38:54 +00001834 /* Read the next journal header from the journal file. If there are
1835 ** not enough bytes left in the journal file for a complete header, or
1836 ** it is corrupted, then a process must of failed while writing it.
1837 ** This indicates nothing more needs to be rolled back.
1838 */
1839 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1840 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001841 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001842 rc = SQLITE_OK;
1843 }
danielk197776572402004-06-25 02:38:54 +00001844 goto end_playback;
1845 }
1846
1847 /* If nRec is 0xffffffff, then this journal was created by a process
1848 ** working in no-sync mode. This means that the rest of the journal
1849 ** file consists of pages, there are no more journal headers. Compute
1850 ** the value of nRec based on this assumption.
1851 */
1852 if( nRec==0xffffffff ){
1853 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1854 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1855 }
1856
danielk1977e277be02007-03-23 18:12:06 +00001857 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001858 ** process and if this is the final header in the journal, then it means
1859 ** that this part of the journal was being filled but has not yet been
1860 ** synced to disk. Compute the number of pages based on the remaining
1861 ** size of the file.
1862 **
1863 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001864 */
drh8940f4e2007-08-11 00:26:20 +00001865 if( nRec==0 && !isHot &&
1866 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001867 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1868 }
1869
danielk197776572402004-06-25 02:38:54 +00001870 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001871 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001872 */
danielk1977e180dd92007-04-05 17:15:52 +00001873 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001874 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001875 if( rc!=SQLITE_OK ){
1876 goto end_playback;
1877 }
danielk197776572402004-06-25 02:38:54 +00001878 }
1879
danielk197776572402004-06-25 02:38:54 +00001880 /* Copy original pages out of the journal and back into the database file.
1881 */
1882 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001883 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001884 if( rc!=SQLITE_OK ){
1885 if( rc==SQLITE_DONE ){
1886 rc = SQLITE_OK;
1887 pPager->journalOff = szJ;
1888 break;
1889 }else{
1890 goto end_playback;
1891 }
1892 }
drh968af522003-02-11 14:55:40 +00001893 }
drhed7c8552001-04-11 14:29:21 +00001894 }
drh580eeaf2006-02-24 03:09:37 +00001895 /*NOTREACHED*/
1896 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001897
1898end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001899 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001900 zMaster = pPager->pTmpSpace;
1901 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1902 }
1903 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001904 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001905 }
danielk197765839c62007-08-30 08:08:17 +00001906 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001907 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001908 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001909 */
danielk197765839c62007-08-30 08:08:17 +00001910 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001911 }
danielk197776572402004-06-25 02:38:54 +00001912
1913 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001914 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001915 ** value. Reset it to the correct value for this process.
1916 */
drhc80f0582007-05-01 16:59:48 +00001917 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001918 return rc;
drhed7c8552001-04-11 14:29:21 +00001919}
1920
1921/*
drhac69b052004-05-12 13:30:07 +00001922** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001923**
1924** This is similar to playing back the transaction journal but with
1925** a few extra twists.
1926**
drh663fc632002-02-02 18:49:19 +00001927** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001928** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001929** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001930**
drhac69b052004-05-12 13:30:07 +00001931** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001932** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001933** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001934*/
drh3aac2dd2004-04-26 14:10:20 +00001935static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001936 i64 szJ; /* Size of the full journal */
1937 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001938 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001939 int i; /* Loop counter */
1940 int rc;
1941
danielk197776572402004-06-25 02:38:54 +00001942 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001943
danielk19774099f6e2007-03-19 11:25:20 +00001944 /* Set hdrOff to be the offset just after the end of the last journal
1945 ** page written before the first journal-header for this statement
1946 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001947 ** header was written.
1948 */
1949 hdrOff = pPager->stmtHdrOff;
1950 assert( pPager->fullSync || !hdrOff );
1951 if( !hdrOff ){
1952 hdrOff = szJ;
1953 }
1954
drhfa86c412002-02-02 15:01:15 +00001955 /* Truncate the database back to its original size.
1956 */
danielk1977e180dd92007-04-05 17:15:52 +00001957 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001958 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001959
drhac69b052004-05-12 13:30:07 +00001960 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001961 */
drhac69b052004-05-12 13:30:07 +00001962 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001963 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001964
drhac69b052004-05-12 13:30:07 +00001965 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001966 ** database file. Note that the statement journal omits checksums from
1967 ** each record since power-failure recovery is not important to statement
1968 ** journals.
drhfa86c412002-02-02 15:01:15 +00001969 */
danielk197762079062007-08-15 17:08:46 +00001970 for(i=0; i<nRec; i++){
1971 i64 offset = i*(4+pPager->pageSize);
1972 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001973 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001974 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001975 }
1976
danielk197776572402004-06-25 02:38:54 +00001977 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1978 ** was the size of the journal file when this statement was started, so
1979 ** everything after that needs to be rolled back, either into the
1980 ** database, the memory cache, or both.
1981 **
1982 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1983 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001984 */
danielk197776572402004-06-25 02:38:54 +00001985 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001986 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001987 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001988 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001989 assert( rc!=SQLITE_DONE );
1990 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1991 }
1992
1993 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001994 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001995 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001996 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001997 if( rc!=SQLITE_OK ){
1998 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001999 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00002000 }
danielk1977f0113002006-01-24 12:09:17 +00002001 if( nJRec==0 ){
2002 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00002003 }
danielk1977f0113002006-01-24 12:09:17 +00002004 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00002005 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00002006 assert( rc!=SQLITE_DONE );
2007 if( rc!=SQLITE_OK ) goto end_stmt_playback;
2008 }
drhfa86c412002-02-02 15:01:15 +00002009 }
danielk197776572402004-06-25 02:38:54 +00002010
2011 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00002012
drh3aac2dd2004-04-26 14:10:20 +00002013end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00002014 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00002015 pPager->journalOff = szJ;
2016 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00002017 }
2018 return rc;
2019}
2020
2021/*
drhf57b14a2001-09-14 18:54:08 +00002022** Change the maximum number of in-memory pages that are allowed.
2023*/
danielk19773b8a05f2007-03-19 17:44:26 +00002024void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00002025 if( mxPage>10 ){
2026 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00002027 }else{
2028 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00002029 }
2030}
2031
2032/*
drh973b6e32003-02-12 14:09:42 +00002033** Adjust the robustness of the database to damage due to OS crashes
2034** or power failures by changing the number of syncs()s when writing
2035** the rollback journal. There are three levels:
2036**
drh054889e2005-11-30 03:20:31 +00002037** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00002038** for temporary and transient files.
2039**
2040** NORMAL The journal is synced once before writes begin on the
2041** database. This is normally adequate protection, but
2042** it is theoretically possible, though very unlikely,
2043** that an inopertune power failure could leave the journal
2044** in a state which would cause damage to the database
2045** when it is rolled back.
2046**
2047** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00002048** database (with some additional information - the nRec field
2049** of the journal header - being written in between the two
2050** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00002051** single disk sector is atomic, then this mode provides
2052** assurance that the journal will not be corrupted to the
2053** point of causing damage to the database during rollback.
2054**
2055** Numeric values associated with these states are OFF==1, NORMAL=2,
2056** and FULL=3.
2057*/
danielk197793758c82005-01-21 08:13:14 +00002058#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00002059void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00002060 pPager->noSync = level==1 || pPager->tempFile;
2061 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00002062 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00002063 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00002064}
danielk197793758c82005-01-21 08:13:14 +00002065#endif
drh973b6e32003-02-12 14:09:42 +00002066
2067/*
drhaf6df112005-06-07 02:12:30 +00002068** The following global variable is incremented whenever the library
2069** attempts to open a temporary file. This information is used for
2070** testing and analysis only.
2071*/
drh0f7eb612006-08-08 13:51:43 +00002072#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002073int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00002074#endif
drhaf6df112005-06-07 02:12:30 +00002075
2076/*
drh3f56e6e2007-03-15 01:16:47 +00002077** Open a temporary file.
2078**
2079** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00002080** other error code if we fail. The OS will automatically delete the temporary
2081** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00002082*/
danielk1977b4b47412007-08-17 15:53:36 +00002083static int sqlite3PagerOpentemp(
drh33f4e022007-09-03 15:19:34 +00002084 sqlite3_vfs *pVfs, /* The virtual file system layer */
2085 sqlite3_file *pFile, /* Write the file descriptor here */
2086 char *zFilename, /* Name of the file. Might be NULL */
2087 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00002088){
drhfa86c412002-02-02 15:01:15 +00002089 int rc;
drh334b2992007-09-06 23:28:23 +00002090 assert( zFilename!=0 );
drh3f56e6e2007-03-15 01:16:47 +00002091
drh0f7eb612006-08-08 13:51:43 +00002092#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002093 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00002094#endif
danielk1977b4b47412007-08-17 15:53:36 +00002095
drh33f4e022007-09-03 15:19:34 +00002096 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
2097 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
2098 rc = sqlite3OsOpen(pVfs, zFilename, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00002099 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00002100 return rc;
2101}
2102
2103/*
drhed7c8552001-04-11 14:29:21 +00002104** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00002105** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00002106** the first call to sqlite3PagerGet() and is only held open until the
2107** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00002108**
drh6446c4d2001-12-15 14:22:18 +00002109** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00002110** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00002111** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00002112**
2113** If zFilename is ":memory:" then all information is held in cache.
2114** It is never written to disk. This can be used to implement an
2115** in-memory database.
drhed7c8552001-04-11 14:29:21 +00002116*/
danielk19773b8a05f2007-03-19 17:44:26 +00002117int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00002118 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00002119 Pager **ppPager, /* Return the Pager structure here */
2120 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00002121 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00002122 int flags, /* flags controlling this file */
2123 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00002124){
danielk1977b4b47412007-08-17 15:53:36 +00002125 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00002126 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00002127 int rc = SQLITE_OK;
2128 int i;
danielk19778def5ea2004-06-16 10:39:52 +00002129 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00002130 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00002131 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00002132 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
2133 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00002134 int journalFileSize = sqlite3JournalSize(pVfs);
drh1cc8c442007-08-24 16:08:29 +00002135 int nDefaultPage = SQLITE_DEFAULT_PAGE_SIZE;
2136 char *zPathname;
2137 int nPathname;
drh99b90c32008-03-17 13:50:58 +00002138 char *zStmtJrnl;
2139 int nStmtJrnl;
danielk1977b4b47412007-08-17 15:53:36 +00002140
drh86f8c192007-08-22 00:39:19 +00002141 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00002142 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002143
drh1cc8c442007-08-24 16:08:29 +00002144 /* Compute the full pathname */
danielk1977adfb9b02007-09-17 07:02:56 +00002145 nPathname = pVfs->mxPathname+1;
drh99b90c32008-03-17 13:50:58 +00002146 zPathname = sqlite3_malloc(nPathname*2);
drh1cc8c442007-08-24 16:08:29 +00002147 if( zPathname==0 ){
2148 return SQLITE_NOMEM;
2149 }
2150 if( zFilename && zFilename[0] ){
2151#ifndef SQLITE_OMIT_MEMORYDB
2152 if( strcmp(zFilename,":memory:")==0 ){
2153 memDb = 1;
2154 zPathname[0] = 0;
2155 }else
2156#endif
2157 {
danielk1977adfb9b02007-09-17 07:02:56 +00002158 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00002159 }
2160 }else{
danielk1977adfb9b02007-09-17 07:02:56 +00002161 rc = sqlite3OsGetTempname(pVfs, nPathname, zPathname);
drhae28c012007-08-24 16:29:23 +00002162 }
2163 if( rc!=SQLITE_OK ){
2164 sqlite3_free(zPathname);
2165 return rc;
drh1cc8c442007-08-24 16:08:29 +00002166 }
2167 nPathname = strlen(zPathname);
2168
drh99b90c32008-03-17 13:50:58 +00002169 /* Put the statement journal in temporary disk space since this is
2170 ** sometimes RAM disk or other optimized storage. Unlikely the main
2171 ** main journal file, the statement journal does not need to be
2172 ** colocated with the database nor does it need to be persistent.
2173 */
2174 zStmtJrnl = &zPathname[nPathname+1];
2175 rc = sqlite3OsGetTempname(pVfs, pVfs->mxPathname+1, zStmtJrnl);
2176 if( rc!=SQLITE_OK ){
2177 sqlite3_free(zPathname);
2178 return rc;
2179 }
2180 nStmtJrnl = strlen(zStmtJrnl);
2181
danielk1977b4b47412007-08-17 15:53:36 +00002182 /* Allocate memory for the pager structure */
2183 pPager = sqlite3MallocZero(
2184 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00002185 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00002186 pVfs->szOsFile * 3 + /* The main db and two journal files */
drh99b90c32008-03-17 13:50:58 +00002187 3*nPathname + 40 + /* zFilename, zDirectory, zJournal */
2188 nStmtJrnl /* zStmtJrnl */
danielk1977b4b47412007-08-17 15:53:36 +00002189 );
2190 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00002191 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002192 return SQLITE_NOMEM;
2193 }
2194 pPtr = (u8 *)&pPager[1];
drh33f4e022007-09-03 15:19:34 +00002195 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00002196 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00002197 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
2198 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
2199 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00002200 pPager->zDirectory = &pPager->zFilename[nPathname+1];
2201 pPager->zJournal = &pPager->zDirectory[nPathname+1];
drh334b2992007-09-06 23:28:23 +00002202 pPager->zStmtJrnl = &pPager->zJournal[nPathname+10];
danielk1977b4b47412007-08-17 15:53:36 +00002203 pPager->pVfs = pVfs;
drh1cc8c442007-08-24 16:08:29 +00002204 memcpy(pPager->zFilename, zPathname, nPathname+1);
drh99b90c32008-03-17 13:50:58 +00002205 memcpy(pPager->zStmtJrnl, zStmtJrnl, nStmtJrnl+1);
drh1cc8c442007-08-24 16:08:29 +00002206 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002207
drh153c62c2007-08-24 03:51:33 +00002208 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00002209 */
drhae28c012007-08-24 16:29:23 +00002210 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00002211 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
2212 rc = SQLITE_CANTOPEN;
2213 }else{
drh1cc8c442007-08-24 16:08:29 +00002214 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00002215 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
2216 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00002217 readOnly = (fout&SQLITE_OPEN_READONLY);
2218
2219 /* If the file was successfully opened for read/write access,
2220 ** choose a default page size in case we have to create the
2221 ** database file. The default page size is the maximum of:
2222 **
2223 ** + SQLITE_DEFAULT_PAGE_SIZE,
2224 ** + The value returned by sqlite3OsSectorSize()
2225 ** + The largest page size that can be written atomically.
2226 */
2227 if( rc==SQLITE_OK && !readOnly ){
2228 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
2229 if( nDefaultPage<iSectorSize ){
2230 nDefaultPage = iSectorSize;
2231 }
danielk19779663b8f2007-08-24 11:52:28 +00002232#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00002233 {
2234 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
2235 int ii;
2236 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
2237 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
2238 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
2239 for(ii=nDefaultPage; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
2240 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) nDefaultPage = ii;
danielk19779663b8f2007-08-24 11:52:28 +00002241 }
danielk1977b4b47412007-08-17 15:53:36 +00002242 }
drh1cc8c442007-08-24 16:08:29 +00002243#endif
2244 if( nDefaultPage>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
2245 nDefaultPage = SQLITE_MAX_DEFAULT_PAGE_SIZE;
2246 }
danielk19778def5ea2004-06-16 10:39:52 +00002247 }
drhac69b052004-05-12 13:30:07 +00002248 }
drh1cc8c442007-08-24 16:08:29 +00002249 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002250 /* If a temporary file is requested, it is not opened immediately.
2251 ** In this case we accept the default page size and delay actually
2252 ** opening the file until the first call to OsWrite().
2253 */
danielk19777a2b1ee2007-08-21 14:27:01 +00002254 tempFile = 1;
2255 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00002256 }
danielk1977aef0bf62005-12-30 16:28:01 +00002257
danielk1977b4b47412007-08-17 15:53:36 +00002258 if( pPager && rc==SQLITE_OK ){
danielk19779663b8f2007-08-24 11:52:28 +00002259 pPager->pTmpSpace = (char *)sqlite3_malloc(nDefaultPage);
drh3e7a6092002-12-07 21:45:14 +00002260 }
danielk1977aef0bf62005-12-30 16:28:01 +00002261
drh153c62c2007-08-24 03:51:33 +00002262 /* If an error occured in either of the blocks above.
2263 ** Free the Pager structure and close the file.
2264 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00002265 ** any Pager.errMask variables.
2266 */
danielk1977b4b47412007-08-17 15:53:36 +00002267 if( !pPager || !pPager->pTmpSpace ){
2268 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00002269 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00002270 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00002271 }
danielk1977aef0bf62005-12-30 16:28:01 +00002272
drh153c62c2007-08-24 03:51:33 +00002273 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
2274 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00002275
danielk1977b4b47412007-08-17 15:53:36 +00002276 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00002277 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00002278 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00002279 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002280
drh99b90c32008-03-17 13:50:58 +00002281 /* Fill in Pager.zJournal[] */
drh1cc8c442007-08-24 16:08:29 +00002282 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
2283 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
danielk1977b4b47412007-08-17 15:53:36 +00002284
drh3b59a5c2006-01-15 20:28:28 +00002285 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00002286 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00002287 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002288 /* pPager->stmtOpen = 0; */
2289 /* pPager->stmtInUse = 0; */
2290 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00002291 pPager->dbSize = memDb-1;
danielk19779663b8f2007-08-24 11:52:28 +00002292 pPager->pageSize = nDefaultPage;
drh3b59a5c2006-01-15 20:28:28 +00002293 /* pPager->stmtSize = 0; */
2294 /* pPager->stmtJSize = 0; */
2295 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002296 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002297 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002298 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002299 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002300 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00002301 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00002302 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2303 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2304 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
2305 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00002306 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00002307 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002308 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00002309 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00002310 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00002311 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002312 /* pPager->pFirst = 0; */
2313 /* pPager->pFirstSynced = 0; */
2314 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00002315 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk19777a2b1ee2007-08-21 14:27:01 +00002316 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00002317 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00002318 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00002319 }
drh3b59a5c2006-01-15 20:28:28 +00002320 /* pPager->pBusyHandler = 0; */
2321 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002322 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00002323#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002324 pPager->iInUseMM = 0;
2325 pPager->iInUseDB = 0;
2326 if( !memDb ){
2327 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2328 sqlite3_mutex_enter(mutex);
2329 pPager->pNext = sqlite3PagerList;
2330 if( sqlite3PagerList ){
2331 assert( sqlite3PagerList->pPrev==0 );
2332 sqlite3PagerList->pPrev = pPager;
2333 }
2334 pPager->pPrev = 0;
2335 sqlite3PagerList = pPager;
2336 sqlite3_mutex_leave(mutex);
2337 }
danielk197752622822006-01-09 09:59:49 +00002338#endif
drhed7c8552001-04-11 14:29:21 +00002339 return SQLITE_OK;
2340}
2341
2342/*
drh90f5ecb2004-07-22 01:19:35 +00002343** Set the busy handler function.
2344*/
danielk19773b8a05f2007-03-19 17:44:26 +00002345void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002346 pPager->pBusyHandler = pBusyHandler;
2347}
2348
2349/*
drh72f82862001-05-24 21:06:34 +00002350** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002351** when the reference count on each page reaches zero. The destructor can
2352** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002353**
danielk19773b8a05f2007-03-19 17:44:26 +00002354** The destructor is not called as a result sqlite3PagerClose().
2355** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002356*/
danielk19773b8a05f2007-03-19 17:44:26 +00002357void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002358 pPager->xDestructor = xDesc;
2359}
2360
2361/*
drha6abd042004-06-09 17:37:22 +00002362** Set the reinitializer for this pager. If not NULL, the reinitializer
2363** is called when the content of a page in cache is restored to its original
2364** value as a result of a rollback. The callback gives higher-level code
2365** an opportunity to restore the EXTRA section to agree with the restored
2366** page data.
2367*/
danielk19773b8a05f2007-03-19 17:44:26 +00002368void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002369 pPager->xReiniter = xReinit;
2370}
2371
2372/*
danielk1977a1644fd2007-08-29 12:31:25 +00002373** Set the page size to *pPageSize. If the suggest new page size is
2374** inappropriate, then an alternative page size is set to that
2375** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002376*/
danielk1977a1644fd2007-08-29 12:31:25 +00002377int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
2378 int rc = SQLITE_OK;
2379 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00002380 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00002381 if( pageSize && pageSize!=pPager->pageSize
2382 && !pPager->memDb && pPager->nRef==0
2383 ){
2384 char *pNew = (char *)sqlite3_malloc(pageSize);
2385 if( !pNew ){
2386 rc = SQLITE_NOMEM;
2387 }else{
2388 pagerEnter(pPager);
2389 pager_reset(pPager);
2390 pPager->pageSize = pageSize;
2391 setSectorSize(pPager);
2392 sqlite3_free(pPager->pTmpSpace);
2393 pPager->pTmpSpace = pNew;
2394 pagerLeave(pPager);
2395 }
drh1c7880e2005-05-20 20:01:55 +00002396 }
danielk1977a1644fd2007-08-29 12:31:25 +00002397 *pPageSize = pPager->pageSize;
2398 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002399}
2400
2401/*
drh26b79942007-11-28 16:19:56 +00002402** Return a pointer to the "temporary page" buffer held internally
2403** by the pager. This is a buffer that is big enough to hold the
2404** entire content of a database page. This buffer is used internally
2405** during rollback and will be overwritten whenever a rollback
2406** occurs. But other modules are free to use it too, as long as
2407** no rollbacks are happening.
2408*/
2409void *sqlite3PagerTempSpace(Pager *pPager){
2410 return pPager->pTmpSpace;
2411}
2412
2413/*
drhf8e632b2007-05-08 14:51:36 +00002414** Attempt to set the maximum database page count if mxPage is positive.
2415** Make no changes if mxPage is zero or negative. And never reduce the
2416** maximum page count below the current size of the database.
2417**
2418** Regardless of mxPage, return the current maximum page count.
2419*/
2420int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2421 if( mxPage>0 ){
2422 pPager->mxPgno = mxPage;
2423 }
2424 sqlite3PagerPagecount(pPager);
2425 return pPager->mxPgno;
2426}
2427
2428/*
drhc9ac5ca2005-11-04 22:03:30 +00002429** The following set of routines are used to disable the simulated
2430** I/O error mechanism. These routines are used to avoid simulated
2431** errors in places where we do not care about errors.
2432**
2433** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2434** and generate no code.
2435*/
2436#ifdef SQLITE_TEST
2437extern int sqlite3_io_error_pending;
2438extern int sqlite3_io_error_hit;
2439static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002440void disable_simulated_io_errors(void){
2441 saved_cnt = sqlite3_io_error_pending;
2442 sqlite3_io_error_pending = -1;
2443}
2444void enable_simulated_io_errors(void){
2445 sqlite3_io_error_pending = saved_cnt;
2446}
2447#else
drh152410f2005-11-05 15:11:22 +00002448# define disable_simulated_io_errors()
2449# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002450#endif
2451
2452/*
drh90f5ecb2004-07-22 01:19:35 +00002453** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002454** that pDest points to.
2455**
2456** No error checking is done. The rational for this is that this function
2457** may be called even if the file does not exist or contain a header. In
2458** these cases sqlite3OsRead() will return an error, to which the correct
2459** response is to zero the memory at pDest and continue. A real IO error
2460** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002461*/
danielk19773b8a05f2007-03-19 17:44:26 +00002462int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002463 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002464 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002465 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2466 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002467 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002468 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002469 if( rc==SQLITE_IOERR_SHORT_READ ){
2470 rc = SQLITE_OK;
2471 }
drh90f5ecb2004-07-22 01:19:35 +00002472 }
drh551b7732006-11-06 21:20:25 +00002473 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002474}
2475
2476/*
drh5e00f6c2001-09-13 13:46:56 +00002477** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002478** pPager.
2479**
2480** If the PENDING_BYTE lies on the page directly after the end of the
2481** file, then consider this page part of the file too. For example, if
2482** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2483** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002484*/
danielk19773b8a05f2007-03-19 17:44:26 +00002485int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002486 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002487 int rc;
drhd9b02572001-04-15 00:37:09 +00002488 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002489 if( pPager->errCode ){
danielk197743468d92008-02-26 06:05:31 +00002490 return -1;
drha7aea3d2007-03-15 12:51:16 +00002491 }
drhed7c8552001-04-11 14:29:21 +00002492 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002493 n = pPager->dbSize;
2494 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002495 assert(pPager->fd->pMethods||pPager->tempFile);
2496 if( (pPager->fd->pMethods)
2497 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002498 pPager->nRef++;
drhe49f9822006-09-15 12:29:16 +00002499 pager_error(pPager, rc);
danielk1977ae72d982007-10-03 08:46:44 +00002500 pPager->nRef--;
danielk197743468d92008-02-26 06:05:31 +00002501 return -1;
danielk197715f411d2005-09-16 10:18:45 +00002502 }
2503 if( n>0 && n<pPager->pageSize ){
2504 n = 1;
2505 }else{
2506 n /= pPager->pageSize;
2507 }
2508 if( pPager->state!=PAGER_UNLOCK ){
2509 pPager->dbSize = n;
2510 }
drhed7c8552001-04-11 14:29:21 +00002511 }
danielk197715f411d2005-09-16 10:18:45 +00002512 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002513 n++;
2514 }
drhf8e632b2007-05-08 14:51:36 +00002515 if( n>pPager->mxPgno ){
2516 pPager->mxPgno = n;
2517 }
drhed7c8552001-04-11 14:29:21 +00002518 return n;
2519}
2520
drhf07e7d52006-04-07 13:54:46 +00002521
2522#ifndef SQLITE_OMIT_MEMORYDB
2523/*
2524** Clear a PgHistory block
2525*/
2526static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002527 sqlite3_free(pHist->pOrig);
2528 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002529 pHist->pOrig = 0;
2530 pHist->pStmt = 0;
2531}
2532#else
2533#define clearHistory(x)
2534#endif
2535
drhed7c8552001-04-11 14:29:21 +00002536/*
drhf7c57532003-04-25 13:22:51 +00002537** Forward declaration
2538*/
danielk197776572402004-06-25 02:38:54 +00002539static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002540
2541/*
drh85b623f2007-12-13 21:54:09 +00002542** Unlink pPg from its hash chain. Also set the page number to 0 to indicate
danielk1977f5fdda82004-11-03 08:44:05 +00002543** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002544** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002545** pNextFree/pPrevFree list that is not a part of any hash-chain.
2546*/
2547static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2548 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002549 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002550 return;
2551 }
2552 if( pPg->pNextHash ){
2553 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2554 }
2555 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002556 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002557 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2558 }else{
drh8ca0c722006-05-07 17:49:38 +00002559 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002560 pPager->aHash[h] = pPg->pNextHash;
2561 }
drh5229ae42006-03-23 23:29:04 +00002562 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002563 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2564 }
danielk1977f5fdda82004-11-03 08:44:05 +00002565 pPg->pgno = 0;
2566 pPg->pNextHash = pPg->pPrevHash = 0;
2567}
2568
2569/*
drhac69b052004-05-12 13:30:07 +00002570** Unlink a page from the free list (the list of all pages where nRef==0)
2571** and from its hash collision chain.
2572*/
2573static void unlinkPage(PgHdr *pPg){
2574 Pager *pPager = pPg->pPager;
2575
danielk19779f61c2f2007-08-27 17:27:49 +00002576 /* Unlink from free page list */
2577 lruListRemove(pPg);
drhac69b052004-05-12 13:30:07 +00002578
2579 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002580 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002581}
2582
2583/*
danielk1977e180dd92007-04-05 17:15:52 +00002584** This routine is used to truncate the cache when a database
2585** is truncated. Drop from the cache all pages whose pgno is
2586** larger than pPager->dbSize and is unreferenced.
2587**
drhac69b052004-05-12 13:30:07 +00002588** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002589**
2590** Actually, at the point this routine is called, it would be
2591** an error to have a referenced page. But rather than delete
2592** that page and guarantee a subsequent segfault, it seems better
2593** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002594*/
danielk1977e180dd92007-04-05 17:15:52 +00002595static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002596 PgHdr *pPg;
2597 PgHdr **ppPg;
2598 int dbSize = pPager->dbSize;
2599
2600 ppPg = &pPager->pAll;
2601 while( (pPg = *ppPg)!=0 ){
2602 if( pPg->pgno<=dbSize ){
2603 ppPg = &pPg->pNextAll;
2604 }else if( pPg->nRef>0 ){
2605 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2606 ppPg = &pPg->pNextAll;
2607 }else{
2608 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002609 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2610 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002611 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002612 makeClean(pPg);
drh0d180202008-02-14 23:26:56 +00002613 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00002614 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002615 pPager->nPage--;
2616 }
2617 }
2618}
2619
drhf7c57532003-04-25 13:22:51 +00002620/*
danielk197717221812005-02-15 03:38:05 +00002621** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002622** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002623** false or until the lock succeeds.
2624**
2625** Return SQLITE_OK on success and an error code if we cannot obtain
2626** the lock.
2627*/
2628static int pager_wait_on_lock(Pager *pPager, int locktype){
2629 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002630
2631 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002632 assert( PAGER_SHARED==SHARED_LOCK );
2633 assert( PAGER_RESERVED==RESERVED_LOCK );
2634 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002635
2636 /* If the file is currently unlocked then the size must be unknown */
2637 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2638
danielk197717221812005-02-15 03:38:05 +00002639 if( pPager->state>=locktype ){
2640 rc = SQLITE_OK;
2641 }else{
drhbefdf832008-03-14 19:33:05 +00002642 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002643 do {
drh054889e2005-11-30 03:20:31 +00002644 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002645 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002646 if( rc==SQLITE_OK ){
2647 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002648 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002649 }
2650 }
2651 return rc;
2652}
2653
2654/*
drhf7c57532003-04-25 13:22:51 +00002655** Truncate the file to the number of pages specified.
2656*/
danielk19773b8a05f2007-03-19 17:44:26 +00002657int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002658 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002659 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002660 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002661 if( pPager->errCode ){
2662 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002663 return rc;
2664 }
drh7d02cb72003-06-04 16:24:39 +00002665 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002666 return SQLITE_OK;
2667 }
drhb7f91642004-10-31 02:22:47 +00002668 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002669 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002670 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002671 return SQLITE_OK;
2672 }
drh86f8c192007-08-22 00:39:19 +00002673 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002674 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002675 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002676 if( rc!=SQLITE_OK ){
2677 return rc;
2678 }
danielk197717221812005-02-15 03:38:05 +00002679
2680 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002681 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002682 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002683 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002684 if( rc!=SQLITE_OK ){
2685 return rc;
2686 }
2687
drhcb4c40b2004-08-18 19:09:43 +00002688 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002689 return rc;
2690}
2691
2692/*
drhed7c8552001-04-11 14:29:21 +00002693** Shutdown the page cache. Free all memory and close all files.
2694**
2695** If a transaction was in progress when this routine is called, that
2696** transaction is rolled back. All outstanding pages are invalidated
2697** and their memory is freed. Any attempt to use a page associated
2698** with this page cache after this function returns will likely
2699** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002700**
2701** This function always succeeds. If a transaction is active an attempt
2702** is made to roll it back. If an error occurs during the rollback
2703** a hot journal may be left in the filesystem but no error is returned
2704** to the caller.
drhed7c8552001-04-11 14:29:21 +00002705*/
danielk19773b8a05f2007-03-19 17:44:26 +00002706int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002707#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002708 if( !MEMDB ){
2709 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2710 sqlite3_mutex_enter(mutex);
2711 if( pPager->pPrev ){
2712 pPager->pPrev->pNext = pPager->pNext;
2713 }else{
2714 sqlite3PagerList = pPager->pNext;
2715 }
2716 if( pPager->pNext ){
2717 pPager->pNext->pPrev = pPager->pPrev;
2718 }
2719 sqlite3_mutex_leave(mutex);
2720 }
danielk197713f72992005-12-18 08:51:22 +00002721#endif
2722
drhbafda092007-01-03 23:36:22 +00002723 disable_simulated_io_errors();
drh16e45a42008-04-19 20:34:18 +00002724 sqlite3FaultBenign(-1, 1);
drhc2ee76c2007-01-04 14:58:14 +00002725 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002726 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002727 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002728 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002729 enable_simulated_io_errors();
drh16e45a42008-04-19 20:34:18 +00002730 sqlite3FaultBenign(-1, 0);
drh4f0c5872007-03-26 22:05:01 +00002731 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002732 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002733 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002734 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002735 }
drhf5e7bb52008-02-18 14:47:33 +00002736 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002737 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002738 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002739 }
danielk1977b4b47412007-08-17 15:53:36 +00002740 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002741 /* Temp files are automatically deleted by the OS
2742 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002743 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002744 ** }
2745 */
danielk1977aca790a2005-01-13 11:07:52 +00002746
drh17435752007-08-16 04:30:38 +00002747 sqlite3_free(pPager->aHash);
2748 sqlite3_free(pPager->pTmpSpace);
2749 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002750 return SQLITE_OK;
2751}
2752
drh87cc3b32007-05-08 21:45:27 +00002753#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002754/*
drh5e00f6c2001-09-13 13:46:56 +00002755** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002756*/
danielk19773b8a05f2007-03-19 17:44:26 +00002757Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002758 return p->pgno;
2759}
drh87cc3b32007-05-08 21:45:27 +00002760#endif
drhed7c8552001-04-11 14:29:21 +00002761
2762/*
drhc8629a12004-05-08 20:07:40 +00002763** The page_ref() function increments the reference count for a page.
2764** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002765** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002766**
2767** For non-test systems, page_ref() is a macro that calls _page_ref()
2768** online of the reference count is zero. For test systems, page_ref()
2769** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002770*/
drh836faa42003-01-11 13:30:57 +00002771static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002772 if( pPg->nRef==0 ){
2773 /* The page is currently on the freelist. Remove it. */
danielk19779f61c2f2007-08-27 17:27:49 +00002774 lruListRemove(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002775 pPg->pPager->nRef++;
2776 }
2777 pPg->nRef++;
drhdf0b3b02001-06-23 11:36:20 +00002778}
danielk1977aca790a2005-01-13 11:07:52 +00002779#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002780 static void page_ref(PgHdr *pPg){
2781 if( pPg->nRef==0 ){
2782 _page_ref(pPg);
2783 }else{
2784 pPg->nRef++;
drhc8629a12004-05-08 20:07:40 +00002785 }
2786 }
2787#else
2788# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2789#endif
drhdf0b3b02001-06-23 11:36:20 +00002790
2791/*
2792** Increment the reference count for a page. The input pointer is
2793** a reference to the page data.
2794*/
danielk19773b8a05f2007-03-19 17:44:26 +00002795int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002796 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002797 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002798 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002799 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002800}
2801
2802/*
drh34e79ce2004-02-08 06:05:46 +00002803** Sync the journal. In other words, make sure all the pages that have
2804** been written to the journal have actually reached the surface of the
2805** disk. It is not safe to modify the original database file until after
2806** the journal has been synced. If the original database is modified before
2807** the journal is synced and a power failure occurs, the unsynced journal
2808** data would be lost and we would be unable to completely rollback the
2809** database changes. Database corruption would occur.
2810**
2811** This routine also updates the nRec field in the header of the journal.
2812** (See comments on the pager_playback() routine for additional information.)
2813** If the sync mode is FULL, two syncs will occur. First the whole journal
2814** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002815**
drh34e79ce2004-02-08 06:05:46 +00002816** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002817** after a power failure, so no sync occurs.
2818**
2819** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2820** the database is stored, then OsSync() is never called on the journal
2821** file. In this case all that is required is to update the nRec field in
2822** the journal header.
drhfa86c412002-02-02 15:01:15 +00002823**
drh34e79ce2004-02-08 06:05:46 +00002824** This routine clears the needSync field of every page current held in
2825** memory.
drh50e5dad2001-09-15 00:57:28 +00002826*/
danielk197776572402004-06-25 02:38:54 +00002827static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002828 PgHdr *pPg;
2829 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002830
danielk19774cd2cd52007-08-23 14:48:23 +00002831
drh03eb96a2002-11-10 23:32:56 +00002832 /* Sync the journal before modifying the main database
2833 ** (assuming there is a journal and it needs to be synced.)
2834 */
danielk197776572402004-06-25 02:38:54 +00002835 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002836 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002837 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002838 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002839
danielk19774cd2cd52007-08-23 14:48:23 +00002840 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002841 /* Write the nRec value into the journal file header. If in
2842 ** full-synchronous mode, sync the journal first. This ensures that
2843 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002844 ** it as a candidate for rollback.
2845 **
2846 ** This is not required if the persistent media supports the
2847 ** SAFE_APPEND property. Because in this case it is not possible
2848 ** for garbage data to be appended to the file, the nRec field
2849 ** is populated with 0xFFFFFFFF when the journal header is written
2850 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002851 */
danielk19774cd2cd52007-08-23 14:48:23 +00002852 i64 jrnlOff;
2853 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002854 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002855 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002856 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002857 if( rc!=0 ) return rc;
2858 }
danielk197713adf8a2004-06-03 16:08:41 +00002859
danielk197762079062007-08-15 17:08:46 +00002860 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2861 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2862 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002863 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002864 }
danielk19774cd2cd52007-08-23 14:48:23 +00002865 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2866 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2867 IOTRACE(("JSYNC %p\n", pPager))
2868 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2869 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2870 );
2871 if( rc!=0 ) return rc;
2872 }
drhdb48ee02003-01-16 13:42:43 +00002873 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002874 }
drh50e5dad2001-09-15 00:57:28 +00002875 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002876
2877 /* Erase the needSync flag from every page.
2878 */
2879 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2880 pPg->needSync = 0;
2881 }
danielk19779f61c2f2007-08-27 17:27:49 +00002882 lruListSetFirstSynced(pPager);
drh50e5dad2001-09-15 00:57:28 +00002883 }
drh03eb96a2002-11-10 23:32:56 +00002884
drh341eae82003-01-21 02:39:36 +00002885#ifndef NDEBUG
2886 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2887 ** flag must also be clear for all pages. Verify that this
2888 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002889 */
drh341eae82003-01-21 02:39:36 +00002890 else{
2891 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2892 assert( pPg->needSync==0 );
2893 }
danielk19779f61c2f2007-08-27 17:27:49 +00002894 assert( pPager->lru.pFirstSynced==pPager->lru.pFirst );
drh03eb96a2002-11-10 23:32:56 +00002895 }
drh341eae82003-01-21 02:39:36 +00002896#endif
drhdb48ee02003-01-16 13:42:43 +00002897
drh81a20f22001-10-12 17:30:04 +00002898 return rc;
drh50e5dad2001-09-15 00:57:28 +00002899}
2900
2901/*
drhdc3e10b2006-06-15 14:31:06 +00002902** Merge two lists of pages connected by pDirty and in pgno order.
2903** Do not both fixing the pPrevDirty pointers.
2904*/
2905static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2906 PgHdr result, *pTail;
2907 pTail = &result;
2908 while( pA && pB ){
2909 if( pA->pgno<pB->pgno ){
2910 pTail->pDirty = pA;
2911 pTail = pA;
2912 pA = pA->pDirty;
2913 }else{
2914 pTail->pDirty = pB;
2915 pTail = pB;
2916 pB = pB->pDirty;
2917 }
2918 }
2919 if( pA ){
2920 pTail->pDirty = pA;
2921 }else if( pB ){
2922 pTail->pDirty = pB;
2923 }else{
2924 pTail->pDirty = 0;
2925 }
2926 return result.pDirty;
2927}
2928
2929/*
2930** Sort the list of pages in accending order by pgno. Pages are
2931** connected by pDirty pointers. The pPrevDirty pointers are
2932** corrupted by this sort.
2933*/
danielk197724168722007-04-02 05:07:47 +00002934#define N_SORT_BUCKET_ALLOC 25
2935#define N_SORT_BUCKET 25
2936#ifdef SQLITE_TEST
2937 int sqlite3_pager_n_sort_bucket = 0;
2938 #undef N_SORT_BUCKET
2939 #define N_SORT_BUCKET \
2940 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2941#endif
drhdc3e10b2006-06-15 14:31:06 +00002942static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002943 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002944 int i;
2945 memset(a, 0, sizeof(a));
2946 while( pIn ){
2947 p = pIn;
2948 pIn = p->pDirty;
2949 p->pDirty = 0;
2950 for(i=0; i<N_SORT_BUCKET-1; i++){
2951 if( a[i]==0 ){
2952 a[i] = p;
2953 break;
2954 }else{
2955 p = merge_pagelist(a[i], p);
2956 a[i] = 0;
2957 }
2958 }
2959 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002960 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2961 ** elements in the input list. This is possible, but impractical.
2962 ** Testing this line is the point of global variable
2963 ** sqlite3_pager_n_sort_bucket.
2964 */
drhdc3e10b2006-06-15 14:31:06 +00002965 a[i] = merge_pagelist(a[i], p);
2966 }
2967 }
2968 p = a[0];
2969 for(i=1; i<N_SORT_BUCKET; i++){
2970 p = merge_pagelist(p, a[i]);
2971 }
2972 return p;
2973}
2974
2975/*
drh2554f8b2003-01-22 01:26:44 +00002976** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2977** every one of those pages out to the database file and mark them all
2978** as clean.
2979*/
2980static int pager_write_pagelist(PgHdr *pList){
2981 Pager *pPager;
drh153c62c2007-08-24 03:51:33 +00002982 PgHdr *p;
drh2554f8b2003-01-22 01:26:44 +00002983 int rc;
2984
2985 if( pList==0 ) return SQLITE_OK;
2986 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002987
2988 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2989 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002990 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002991 **
drha6abd042004-06-09 17:37:22 +00002992 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2993 ** through an intermediate state PENDING. A PENDING lock prevents new
2994 ** readers from attaching to the database but is unsufficient for us to
2995 ** write. The idea of a PENDING lock is to prevent new readers from
2996 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002997 **
drha6abd042004-06-09 17:37:22 +00002998 ** While the pager is in the RESERVED state, the original database file
2999 ** is unchanged and we can rollback without having to playback the
3000 ** journal into the original database file. Once we transition to
3001 ** EXCLUSIVE, it means the database file has been changed and any rollback
3002 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00003003 */
drh684917c2004-10-05 02:41:42 +00003004 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00003005 if( rc!=SQLITE_OK ){
3006 return rc;
3007 }
3008
drhdc3e10b2006-06-15 14:31:06 +00003009 pList = sort_pagelist(pList);
drh153c62c2007-08-24 03:51:33 +00003010 for(p=pList; p; p=p->pDirty){
3011 assert( p->dirty );
3012 p->dirty = 0;
3013 }
drh2554f8b2003-01-22 01:26:44 +00003014 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00003015
3016 /* If the file has not yet been opened, open it now. */
3017 if( !pPager->fd->pMethods ){
3018 assert(pPager->tempFile);
drh33f4e022007-09-03 15:19:34 +00003019 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename,
3020 pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00003021 if( rc ) return rc;
3022 }
3023
danielk1977687566d2004-11-02 12:56:41 +00003024 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00003025 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00003026 ** make the file smaller (presumably by auto-vacuum code). Do not write
3027 ** any such pages to the file.
3028 */
3029 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00003030 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00003031 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00003032 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
3033 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00003034 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00003035 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003036 PAGER_INCR(sqlite3_pager_writedb_count);
3037 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00003038 if( pList->pgno==1 ){
3039 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
3040 }
danielk1977687566d2004-11-02 12:56:41 +00003041 }
3042#ifndef NDEBUG
3043 else{
drh4f0c5872007-03-26 22:05:01 +00003044 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00003045 }
3046#endif
drh2554f8b2003-01-22 01:26:44 +00003047 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00003048#ifdef SQLITE_CHECK_PAGES
3049 pList->pageHash = pager_pagehash(pList);
3050#endif
drh2554f8b2003-01-22 01:26:44 +00003051 pList = pList->pDirty;
3052 }
3053 return SQLITE_OK;
3054}
3055
3056/*
3057** Collect every dirty page into a dirty list and
3058** return a pointer to the head of that list. All pages are
3059** collected even if they are still in use.
3060*/
3061static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh8f2e9a12008-02-26 14:46:04 +00003062
3063#ifndef NDEBUG
3064 /* Verify the sanity of the dirty list when we are running
3065 ** in debugging mode. This is expensive, so do not
3066 ** do this on a normal build. */
3067 int n1 = 0;
3068 int n2 = 0;
3069 PgHdr *p;
3070 for(p=pPager->pAll; p; p=p->pNextAll){ if( p->dirty ) n1++; }
3071 for(p=pPager->pDirty; p; p=p->pDirty){ n2++; }
3072 assert( n1==n2 );
3073#endif
3074
drh605ad8f2006-05-03 23:34:05 +00003075 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00003076}
3077
3078/*
drh19db9352008-03-27 22:42:51 +00003079** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00003080** A hot journal is one that needs to be played back.
3081**
3082** If the current size of the database file is 0 but a journal file
3083** exists, that is probably an old journal left over from a prior
3084** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00003085**
3086** Return negative if unable to determine the status of the journal.
drh165ffe92005-03-15 17:09:30 +00003087*/
3088static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003089 sqlite3_vfs *pVfs = pPager->pVfs;
drh19db9352008-03-27 22:42:51 +00003090 int rc;
drh165ffe92005-03-15 17:09:30 +00003091 if( !pPager->useJournal ) return 0;
drhd3cf2472007-11-27 16:55:07 +00003092 if( !pPager->fd->pMethods ) return 0;
drh19db9352008-03-27 22:42:51 +00003093 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS);
3094 if( rc<=0 ){
3095 return rc;
drhbb5f18d2007-04-06 18:23:17 +00003096 }
3097 if( sqlite3OsCheckReservedLock(pPager->fd) ){
3098 return 0;
3099 }
danielk19773b8a05f2007-03-19 17:44:26 +00003100 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00003101 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00003102 return 0;
3103 }else{
3104 return 1;
3105 }
3106}
3107
danielk19775591df52005-12-20 09:19:37 +00003108/*
danielk1977aef0bf62005-12-30 16:28:01 +00003109** Try to find a page in the cache that can be recycled.
3110**
3111** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00003112** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00003113*/
danielk1977843e65f2007-09-01 16:16:15 +00003114static int pager_recycle(Pager *pPager, PgHdr **ppPg){
danielk197713f72992005-12-18 08:51:22 +00003115 PgHdr *pPg;
3116 *ppPg = 0;
3117
danielk1977843e65f2007-09-01 16:16:15 +00003118 /* It is illegal to call this function unless the pager object
3119 ** pointed to by pPager has at least one free page (page with nRef==0).
3120 */
danielk1977c551edc2007-04-05 13:12:13 +00003121 assert(!MEMDB);
danielk1977843e65f2007-09-01 16:16:15 +00003122 assert(pPager->lru.pFirst);
danielk1977c551edc2007-04-05 13:12:13 +00003123
danielk197713f72992005-12-18 08:51:22 +00003124 /* Find a page to recycle. Try to locate a page that does not
3125 ** require us to do an fsync() on the journal.
3126 */
danielk19779f61c2f2007-08-27 17:27:49 +00003127 pPg = pPager->lru.pFirstSynced;
danielk197713f72992005-12-18 08:51:22 +00003128
3129 /* If we could not find a page that does not require an fsync()
3130 ** on the journal file then fsync the journal file. This is a
3131 ** very slow operation, so we work hard to avoid it. But sometimes
3132 ** it can't be helped.
3133 */
danielk1977843e65f2007-09-01 16:16:15 +00003134 if( pPg==0 && pPager->lru.pFirst){
danielk19774cd2cd52007-08-23 14:48:23 +00003135 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
danielk197713f72992005-12-18 08:51:22 +00003136 int rc = syncJournal(pPager);
3137 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003138 return rc;
danielk197713f72992005-12-18 08:51:22 +00003139 }
danielk19774cd2cd52007-08-23 14:48:23 +00003140 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197713f72992005-12-18 08:51:22 +00003141 /* If in full-sync mode, write a new journal header into the
3142 ** journal file. This is done to avoid ever modifying a journal
3143 ** header that is involved in the rollback of pages that have
3144 ** already been written to the database (in case the header is
3145 ** trashed when the nRec field is updated).
3146 */
3147 pPager->nRec = 0;
3148 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00003149 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00003150 rc = writeJournalHdr(pPager);
3151 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003152 return rc;
danielk197713f72992005-12-18 08:51:22 +00003153 }
3154 }
danielk19779f61c2f2007-08-27 17:27:49 +00003155 pPg = pPager->lru.pFirst;
danielk197713f72992005-12-18 08:51:22 +00003156 }
danielk197713f72992005-12-18 08:51:22 +00003157
3158 assert( pPg->nRef==0 );
3159
3160 /* Write the page to the database file if it is dirty.
3161 */
3162 if( pPg->dirty ){
3163 int rc;
3164 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00003165 makeClean(pPg);
3166 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00003167 pPg->pDirty = 0;
3168 rc = pager_write_pagelist( pPg );
drh153c62c2007-08-24 03:51:33 +00003169 pPg->dirty = 0;
danielk197713f72992005-12-18 08:51:22 +00003170 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00003171 return rc;
danielk197713f72992005-12-18 08:51:22 +00003172 }
3173 }
3174 assert( pPg->dirty==0 );
3175
3176 /* If the page we are recycling is marked as alwaysRollback, then
3177 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00003178 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00003179 ** It is necessary to do this because the page marked alwaysRollback
3180 ** might be reloaded at a later time but at that point we won't remember
3181 ** that is was marked alwaysRollback. This means that all pages must
3182 ** be marked as alwaysRollback from here on out.
3183 */
3184 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00003185 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00003186 pPager->alwaysRollback = 1;
3187 }
3188
3189 /* Unlink the old page from the free list and the hash table
3190 */
3191 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00003192 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00003193
3194 *ppPg = pPg;
3195 return SQLITE_OK;
3196}
3197
drh86f8c192007-08-22 00:39:19 +00003198#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00003199/*
3200** This function is called to free superfluous dynamically allocated memory
3201** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00003202** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00003203**
3204** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00003205** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00003206** of bytes of memory released.
3207*/
danielk19773b8a05f2007-03-19 17:44:26 +00003208int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00003209 int nReleased = 0; /* Bytes of memory released so far */
3210 sqlite3_mutex *mutex; /* The MEM2 mutex */
3211 Pager *pPager; /* For looping over pagers */
drhe5fe6902007-12-07 18:55:28 +00003212 BusyHandler *savedBusy; /* Saved copy of the busy handler */
danielk19779f61c2f2007-08-27 17:27:49 +00003213 int rc = SQLITE_OK;
danielk197713f72992005-12-18 08:51:22 +00003214
drh86f8c192007-08-22 00:39:19 +00003215 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00003216 */
drh86f8c192007-08-22 00:39:19 +00003217 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
3218 sqlite3_mutex_enter(mutex);
3219
3220 /* Signal all database connections that memory management wants
3221 ** to have access to the pagers.
3222 */
3223 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3224 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00003225 }
3226
danielk19779f61c2f2007-08-27 17:27:49 +00003227 while( rc==SQLITE_OK && (nReq<0 || nReleased<nReq) ){
3228 PgHdr *pPg;
3229 PgHdr *pRecycled;
3230
3231 /* Try to find a page to recycle that does not require a sync(). If
3232 ** this is not possible, find one that does require a sync().
3233 */
3234 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
3235 pPg = sqlite3LruPageList.pFirstSynced;
3236 while( pPg && (pPg->needSync || pPg->pPager->iInUseDB) ){
3237 pPg = pPg->gfree.pNext;
3238 }
3239 if( !pPg ){
3240 pPg = sqlite3LruPageList.pFirst;
3241 while( pPg && pPg->pPager->iInUseDB ){
3242 pPg = pPg->gfree.pNext;
3243 }
3244 }
3245 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
danielk197713f72992005-12-18 08:51:22 +00003246
danielk197784f786f2007-08-28 08:00:17 +00003247 /* If pPg==0, then the block above has failed to find a page to
3248 ** recycle. In this case return early - no further memory will
3249 ** be released.
3250 */
danielk19779f61c2f2007-08-27 17:27:49 +00003251 if( !pPg ) break;
danielk197713f72992005-12-18 08:51:22 +00003252
danielk19779f61c2f2007-08-27 17:27:49 +00003253 pPager = pPg->pPager;
3254 assert(!pPg->needSync || pPg==pPager->lru.pFirst);
3255 assert(pPg->needSync || pPg==pPager->lru.pFirstSynced);
3256
drhe5fe6902007-12-07 18:55:28 +00003257 savedBusy = pPager->pBusyHandler;
3258 pPager->pBusyHandler = 0;
danielk1977843e65f2007-09-01 16:16:15 +00003259 rc = pager_recycle(pPager, &pRecycled);
drhe5fe6902007-12-07 18:55:28 +00003260 pPager->pBusyHandler = savedBusy;
danielk19779f61c2f2007-08-27 17:27:49 +00003261 assert(pRecycled==pPg || rc!=SQLITE_OK);
3262 if( rc==SQLITE_OK ){
3263 /* We've found a page to free. At this point the page has been
3264 ** removed from the page hash-table, free-list and synced-list
3265 ** (pFirstSynced). It is still in the all pages (pAll) list.
3266 ** Remove it from this list before freeing.
3267 **
3268 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
3269 ** probably is though.
danielk197713f72992005-12-18 08:51:22 +00003270 */
danielk19779f61c2f2007-08-27 17:27:49 +00003271 PgHdr *pTmp;
3272 assert( pPg );
3273 if( pPg==pPager->pAll ){
3274 pPager->pAll = pPg->pNextAll;
3275 }else{
3276 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
3277 pTmp->pNextAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00003278 }
danielk19779f61c2f2007-08-27 17:27:49 +00003279 nReleased += (
3280 sizeof(*pPg) + pPager->pageSize
3281 + sizeof(u32) + pPager->nExtra
3282 + MEMDB*sizeof(PgHistory)
3283 );
3284 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
3285 PAGER_INCR(sqlite3_pager_pgfree_count);
drh0d180202008-02-14 23:26:56 +00003286 sqlite3_free(pPg->pData);
danielk19779f61c2f2007-08-27 17:27:49 +00003287 sqlite3_free(pPg);
danielk197784f786f2007-08-28 08:00:17 +00003288 pPager->nPage--;
danielk19779f61c2f2007-08-27 17:27:49 +00003289 }else{
3290 /* An error occured whilst writing to the database file or
3291 ** journal in pager_recycle(). The error is not returned to the
3292 ** caller of this function. Instead, set the Pager.errCode variable.
3293 ** The error will be returned to the user (or users, in the case
3294 ** of a shared pager cache) of the pager for which the error occured.
3295 */
3296 assert(
3297 (rc&0xff)==SQLITE_IOERR ||
3298 rc==SQLITE_FULL ||
3299 rc==SQLITE_BUSY
3300 );
3301 assert( pPager->state>=PAGER_RESERVED );
3302 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00003303 }
3304 }
danielk1977aef0bf62005-12-30 16:28:01 +00003305
drh86f8c192007-08-22 00:39:19 +00003306 /* Clear the memory management flags and release the mutex
3307 */
3308 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3309 pPager->iInUseMM = 0;
3310 }
3311 sqlite3_mutex_leave(mutex);
3312
3313 /* Return the number of bytes released
3314 */
danielk197713f72992005-12-18 08:51:22 +00003315 return nReleased;
3316}
drh86f8c192007-08-22 00:39:19 +00003317#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00003318
drh165ffe92005-03-15 17:09:30 +00003319/*
danielk1977e180dd92007-04-05 17:15:52 +00003320** Read the content of page pPg out of the database file.
3321*/
3322static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
3323 int rc;
danielk197762079062007-08-15 17:08:46 +00003324 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00003325 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00003326 assert(pPager->fd->pMethods||pPager->tempFile);
3327 if( !pPager->fd->pMethods ){
3328 return SQLITE_IOERR_SHORT_READ;
3329 }
danielk197762079062007-08-15 17:08:46 +00003330 offset = (pgno-1)*(i64)pPager->pageSize;
3331 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003332 PAGER_INCR(sqlite3_pager_readdb_count);
3333 PAGER_INCR(pPager->nRead);
3334 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00003335 if( pgno==1 ){
3336 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
3337 sizeof(pPager->dbFileVers));
3338 }
danielk1977e180dd92007-04-05 17:15:52 +00003339 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00003340 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
3341 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00003342 return rc;
3343}
3344
3345
3346/*
danielk1977e277be02007-03-23 18:12:06 +00003347** This function is called to obtain the shared lock required before
3348** data may be read from the pager cache. If the shared lock has already
3349** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00003350**
3351** Immediately after obtaining the shared lock (if required), this function
3352** checks for a hot-journal file. If one is found, an emergency rollback
3353** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00003354*/
3355static int pagerSharedLock(Pager *pPager){
3356 int rc = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00003357 int isHot = 0;
danielk1977e277be02007-03-23 18:12:06 +00003358
danielk1977ae72d982007-10-03 08:46:44 +00003359 /* If this database is opened for exclusive access, has no outstanding
3360 ** page references and is in an error-state, now is the chance to clear
3361 ** the error. Discard the contents of the pager-cache and treat any
3362 ** open journal file as a hot-journal.
3363 */
3364 if( !MEMDB && pPager->exclusiveMode && pPager->nRef==0 && pPager->errCode ){
3365 if( pPager->journalOpen ){
3366 isHot = 1;
3367 }
3368 pager_reset(pPager);
3369 pPager->errCode = SQLITE_OK;
3370 }
3371
3372 /* If the pager is still in an error state, do not proceed. The error
3373 ** state will be cleared at some point in the future when all page
3374 ** references are dropped and the cache can be discarded.
3375 */
3376 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3377 return pPager->errCode;
3378 }
3379
3380 if( pPager->state==PAGER_UNLOCK || isHot ){
danielk1977b4b47412007-08-17 15:53:36 +00003381 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00003382 if( !MEMDB ){
3383 assert( pPager->nRef==0 );
3384 if( !pPager->noReadlock ){
3385 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
3386 if( rc!=SQLITE_OK ){
3387 return pager_error(pPager, rc);
3388 }
3389 assert( pPager->state>=SHARED_LOCK );
3390 }
3391
3392 /* If a journal file exists, and there is no RESERVED lock on the
3393 ** database file, then it either needs to be played back or deleted.
3394 */
drh19db9352008-03-27 22:42:51 +00003395 rc = hasHotJournal(pPager);
3396 if( rc<0 ){
danielk1977a3e52182008-04-14 16:37:10 +00003397 return SQLITE_IOERR_NOMEM;
drh19db9352008-03-27 22:42:51 +00003398 }
3399 if( rc==1 || isHot ){
danielk1977e277be02007-03-23 18:12:06 +00003400 /* Get an EXCLUSIVE lock on the database file. At this point it is
3401 ** important that a RESERVED lock is not obtained on the way to the
3402 ** EXCLUSIVE lock. If it were, another process might open the
3403 ** database file, detect the RESERVED lock, and conclude that the
3404 ** database is safe to read while this process is still rolling it
3405 ** back.
3406 **
3407 ** Because the intermediate RESERVED lock is not requested, the
3408 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00003409 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00003410 */
danielk1977ae72d982007-10-03 08:46:44 +00003411 if( pPager->state<EXCLUSIVE_LOCK ){
3412 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3413 if( rc!=SQLITE_OK ){
3414 pager_unlock(pPager);
3415 return pager_error(pPager, rc);
3416 }
3417 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00003418 }
danielk1977e277be02007-03-23 18:12:06 +00003419
drh16e45a42008-04-19 20:34:18 +00003420 /* Open the journal for read/write access. This is because in
drhfd131da2007-08-07 17:13:03 +00003421 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003422 ** possibly used for a transaction later on. On some systems, the
3423 ** OsTruncate() call used in exclusive-access mode also requires
3424 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003425 */
drh16e45a42008-04-19 20:34:18 +00003426 if( !isHot && pPager->journalOpen==0 ){
danielk1977ce98bba2008-04-03 10:13:01 +00003427 int res = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS);
3428 if( res==1 ){
danielk1977ae72d982007-10-03 08:46:44 +00003429 int fout = 0;
3430 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
3431 assert( !pPager->tempFile );
3432 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
3433 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3434 if( fout&SQLITE_OPEN_READONLY ){
3435 rc = SQLITE_BUSY;
3436 sqlite3OsClose(pPager->jfd);
3437 }
drh16e45a42008-04-19 20:34:18 +00003438 }else if( res==0 ){
3439 /* If the journal does not exist, that means some other process
3440 ** has already rolled it back */
3441 rc = SQLITE_BUSY;
danielk1977ce98bba2008-04-03 10:13:01 +00003442 }else{
drh16e45a42008-04-19 20:34:18 +00003443 /* If sqlite3OsAccess() returns a negative value, that means it
3444 ** failed a memory allocation */
3445 rc = SQLITE_IOERR_NOMEM;
danielk1977979f38e2007-03-27 16:19:51 +00003446 }
3447 }
danielk1977e277be02007-03-23 18:12:06 +00003448 if( rc!=SQLITE_OK ){
3449 pager_unlock(pPager);
drh1aa5af12008-03-07 19:51:14 +00003450 switch( rc ){
3451 case SQLITE_NOMEM:
3452 case SQLITE_IOERR_UNLOCK:
3453 case SQLITE_IOERR_NOMEM:
3454 return rc;
3455 default:
3456 return SQLITE_BUSY;
3457 }
danielk1977e277be02007-03-23 18:12:06 +00003458 }
3459 pPager->journalOpen = 1;
3460 pPager->journalStarted = 0;
3461 pPager->journalOff = 0;
3462 pPager->setMaster = 0;
3463 pPager->journalHdr = 0;
3464
3465 /* Playback and delete the journal. Drop the database write
3466 ** lock and reacquire the read lock.
3467 */
3468 rc = pager_playback(pPager, 1);
3469 if( rc!=SQLITE_OK ){
3470 return pager_error(pPager, rc);
3471 }
danielk1977c5859712007-03-26 12:26:27 +00003472 assert(pPager->state==PAGER_SHARED ||
3473 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3474 );
danielk1977e277be02007-03-23 18:12:06 +00003475 }
3476
3477 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003478 /* The shared-lock has just been acquired on the database file
3479 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003480 ** read or write transaction). Check to see if the database
3481 ** has been modified. If the database has changed, flush the
3482 ** cache.
3483 **
3484 ** Database changes is detected by looking at 15 bytes beginning
3485 ** at offset 24 into the file. The first 4 of these 16 bytes are
3486 ** a 32-bit counter that is incremented with each change. The
3487 ** other bytes change randomly with each file change when
3488 ** a codec is in use.
3489 **
3490 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003491 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003492 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003493 */
drh86a88112007-04-16 15:02:19 +00003494 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003495 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003496
danielk1977e180dd92007-04-05 17:15:52 +00003497 if( pPager->errCode ){
3498 return pPager->errCode;
danielk1977e277be02007-03-23 18:12:06 +00003499 }
3500
danielk1977e180dd92007-04-05 17:15:52 +00003501 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003502 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003503 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003504 if( rc!=SQLITE_OK ){
3505 return rc;
3506 }
drh86a88112007-04-16 15:02:19 +00003507 }else{
3508 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003509 }
3510
drh86a88112007-04-16 15:02:19 +00003511 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003512 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003513 }
3514 }
3515 }
danielk1977c5859712007-03-26 12:26:27 +00003516 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3517 if( pPager->state==PAGER_UNLOCK ){
3518 pPager->state = PAGER_SHARED;
3519 }
danielk1977e277be02007-03-23 18:12:06 +00003520 }
3521
3522 return rc;
3523}
3524
3525/*
danielk1977e180dd92007-04-05 17:15:52 +00003526** Allocate a PgHdr object. Either create a new one or reuse
3527** an existing one that is not otherwise in use.
3528**
3529** A new PgHdr structure is created if any of the following are
3530** true:
3531**
3532** (1) We have not exceeded our maximum allocated cache size
3533** as set by the "PRAGMA cache_size" command.
3534**
3535** (2) There are no unused PgHdr objects available at this time.
3536**
3537** (3) This is an in-memory database.
3538**
3539** (4) There are no PgHdr objects that do not require a journal
3540** file sync and a sync of the journal file is currently
3541** prohibited.
3542**
3543** Otherwise, reuse an existing PgHdr. In other words, reuse an
3544** existing PgHdr if all of the following are true:
3545**
3546** (1) We have reached or exceeded the maximum cache size
3547** allowed by "PRAGMA cache_size".
3548**
3549** (2) There is a PgHdr available with PgHdr->nRef==0
3550**
3551** (3) We are not in an in-memory database
3552**
3553** (4) Either there is an available PgHdr that does not need
3554** to be synced to disk or else disk syncing is currently
3555** allowed.
danielk197724168722007-04-02 05:07:47 +00003556*/
3557static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3558 int rc = SQLITE_OK;
3559 PgHdr *pPg;
drh1e3af332007-10-20 13:17:54 +00003560 int nByteHdr;
danielk197724168722007-04-02 05:07:47 +00003561
danielk1977e180dd92007-04-05 17:15:52 +00003562 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003563 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003564 if( pPager->nPage<pPager->mxPage
danielk19779f61c2f2007-08-27 17:27:49 +00003565 || pPager->lru.pFirst==0
danielk1977e180dd92007-04-05 17:15:52 +00003566 || MEMDB
danielk19779f61c2f2007-08-27 17:27:49 +00003567 || (pPager->lru.pFirstSynced==0 && pPager->doNotSync)
danielk1977e180dd92007-04-05 17:15:52 +00003568 ){
drh0d180202008-02-14 23:26:56 +00003569 void *pData;
danielk197724168722007-04-02 05:07:47 +00003570 if( pPager->nPage>=pPager->nHash ){
3571 pager_resize_hash_table(pPager,
3572 pPager->nHash<256 ? 256 : pPager->nHash*2);
3573 if( pPager->nHash==0 ){
3574 rc = SQLITE_NOMEM;
3575 goto pager_allocate_out;
3576 }
3577 }
drhed138fb2007-08-22 22:04:37 +00003578 pagerLeave(pPager);
drh1e3af332007-10-20 13:17:54 +00003579 nByteHdr = sizeof(*pPg) + sizeof(u32) + pPager->nExtra
3580 + MEMDB*sizeof(PgHistory);
drh0d180202008-02-14 23:26:56 +00003581 pPg = sqlite3_malloc( nByteHdr );
3582 if( pPg ){
3583 pData = sqlite3_malloc( pPager->pageSize );
3584 if( pData==0 ){
3585 sqlite3_free(pPg);
3586 pPg = 0;
3587 }
3588 }
drhed138fb2007-08-22 22:04:37 +00003589 pagerEnter(pPager);
danielk197724168722007-04-02 05:07:47 +00003590 if( pPg==0 ){
3591 rc = SQLITE_NOMEM;
3592 goto pager_allocate_out;
3593 }
drh1e3af332007-10-20 13:17:54 +00003594 memset(pPg, 0, nByteHdr);
drh0d180202008-02-14 23:26:56 +00003595 pPg->pData = pData;
danielk197724168722007-04-02 05:07:47 +00003596 pPg->pPager = pPager;
3597 pPg->pNextAll = pPager->pAll;
3598 pPager->pAll = pPg;
3599 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003600 }else{
3601 /* Recycle an existing page with a zero ref-count. */
danielk1977843e65f2007-09-01 16:16:15 +00003602 rc = pager_recycle(pPager, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003603 if( rc==SQLITE_BUSY ){
3604 rc = SQLITE_IOERR_BLOCKED;
3605 }
danielk197724168722007-04-02 05:07:47 +00003606 if( rc!=SQLITE_OK ){
3607 goto pager_allocate_out;
3608 }
3609 assert( pPager->state>=SHARED_LOCK );
3610 assert(pPg);
3611 }
3612 *ppPg = pPg;
3613
3614pager_allocate_out:
3615 return rc;
3616}
3617
3618/*
drhd33d5a82007-04-26 12:11:28 +00003619** Make sure we have the content for a page. If the page was
3620** previously acquired with noContent==1, then the content was
3621** just initialized to zeros instead of being read from disk.
3622** But now we need the real data off of disk. So make sure we
3623** have it. Read it in if we do not have it already.
3624*/
3625static int pager_get_content(PgHdr *pPg){
3626 if( pPg->needRead ){
3627 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3628 if( rc==SQLITE_OK ){
3629 pPg->needRead = 0;
3630 }else{
3631 return rc;
3632 }
3633 }
3634 return SQLITE_OK;
3635}
3636
3637/*
drhd9b02572001-04-15 00:37:09 +00003638** Acquire a page.
3639**
drh58a11682001-11-10 13:51:08 +00003640** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003641** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003642**
drhd33d5a82007-04-26 12:11:28 +00003643** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003644** file is smaller than the requested page, then no actual disk
3645** read occurs and the memory image of the page is initialized to
3646** all zeros. The extra data appended to a page is always initialized
3647** to zeros the first time a page is loaded into memory.
3648**
drhd9b02572001-04-15 00:37:09 +00003649** The acquisition might fail for several reasons. In all cases,
3650** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003651**
drhd33d5a82007-04-26 12:11:28 +00003652** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003653** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003654** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003655** just returns 0. This routine acquires a read-lock the first time it
3656** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003657** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003658** or journal files.
drh0787db62007-03-04 13:15:27 +00003659**
drh538f5702007-04-13 02:14:30 +00003660** If noContent is false, the page contents are actually read from disk.
3661** If noContent is true, it means that we do not care about the contents
3662** of the page at this time, so do not do a disk read. Just fill in the
3663** page content with zeros. But mark the fact that we have not read the
3664** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003665** sqlite3PagerWrite() is called on this page or if this routine is
3666** called again with noContent==0, that means that the content is needed
3667** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003668*/
drh86f8c192007-08-22 00:39:19 +00003669static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003670 Pager *pPager, /* The pager open on the database file */
3671 Pgno pgno, /* Page number to fetch */
3672 DbPage **ppPage, /* Write a pointer to the page here */
3673 int noContent /* Do not bother reading content from disk if true */
3674){
drhed7c8552001-04-11 14:29:21 +00003675 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003676 int rc;
drhed7c8552001-04-11 14:29:21 +00003677
danielk1977e277be02007-03-23 18:12:06 +00003678 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3679
danielk197726836652005-01-17 01:33:13 +00003680 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3681 ** number greater than this, or zero, is requested.
3682 */
drh267cb322005-09-16 17:16:52 +00003683 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003684 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003685 }
3686
drhd9b02572001-04-15 00:37:09 +00003687 /* Make sure we have not hit any critical errors.
3688 */
drh836faa42003-01-11 13:30:57 +00003689 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003690 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00003691
danielk197713adf8a2004-06-03 16:08:41 +00003692 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003693 ** on the database file. pagerSharedLock() is a no-op if
3694 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003695 */
danielk1977e277be02007-03-23 18:12:06 +00003696 rc = pagerSharedLock(pPager);
3697 if( rc!=SQLITE_OK ){
3698 return rc;
drhed7c8552001-04-11 14:29:21 +00003699 }
danielk1977e277be02007-03-23 18:12:06 +00003700 assert( pPager->state!=PAGER_UNLOCK );
3701
3702 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003703 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003704 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003705 int nMax;
drhed7c8552001-04-11 14:29:21 +00003706 int h;
drh538f5702007-04-13 02:14:30 +00003707 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003708 rc = pagerAllocatePage(pPager, &pPg);
3709 if( rc!=SQLITE_OK ){
3710 return rc;
drhed7c8552001-04-11 14:29:21 +00003711 }
danielk197724168722007-04-02 05:07:47 +00003712
drhed7c8552001-04-11 14:29:21 +00003713 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003714 assert( !MEMDB || pgno>pPager->stmtSize );
drhf5e7bb52008-02-18 14:47:33 +00003715 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
3716 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003717
drh605ad8f2006-05-03 23:34:05 +00003718 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003719 pPg->nRef = 1;
danielk197775bab7d2006-01-23 13:09:45 +00003720
drhd9b02572001-04-15 00:37:09 +00003721 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003722 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003723 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003724 }
danielk1977979f38e2007-03-27 16:19:51 +00003725 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003726 if( pPager->errCode ){
danielk1977efaaf572006-01-16 11:29:19 +00003727 rc = pPager->errCode;
danielk1977ae72d982007-10-03 08:46:44 +00003728 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00003729 return rc;
3730 }
danielk197775bab7d2006-01-23 13:09:45 +00003731
3732 /* Populate the page with data, either by reading from the database
3733 ** file, or by setting the entire page to zero.
3734 */
drhd215acf2007-04-13 04:01:58 +00003735 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003736 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003737 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003738 return SQLITE_FULL;
3739 }
drh90f5ecb2004-07-22 01:19:35 +00003740 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003741 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003742 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003743 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003744 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003745 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3746 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003747 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003748 return rc;
drh81a20f22001-10-12 17:30:04 +00003749 }
danielk1977b4626a32007-04-28 15:47:43 +00003750 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003751 }
danielk197775bab7d2006-01-23 13:09:45 +00003752
3753 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003754 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003755 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003756 pPg->pNextHash = pPager->aHash[h];
3757 pPager->aHash[h] = pPg;
3758 if( pPg->pNextHash ){
3759 assert( pPg->pNextHash->pPrevHash==0 );
3760 pPg->pNextHash->pPrevHash = pPg;
3761 }
3762
danielk19773c407372005-02-15 02:54:14 +00003763#ifdef SQLITE_CHECK_PAGES
3764 pPg->pageHash = pager_pagehash(pPg);
3765#endif
drhed7c8552001-04-11 14:29:21 +00003766 }else{
drhd9b02572001-04-15 00:37:09 +00003767 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003768 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003769 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003770 if( !noContent ){
3771 rc = pager_get_content(pPg);
3772 if( rc ){
3773 return rc;
3774 }
3775 }
drhdf0b3b02001-06-23 11:36:20 +00003776 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003777 }
danielk19773b8a05f2007-03-19 17:44:26 +00003778 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003779 return SQLITE_OK;
3780}
drh86f8c192007-08-22 00:39:19 +00003781int sqlite3PagerAcquire(
3782 Pager *pPager, /* The pager open on the database file */
3783 Pgno pgno, /* Page number to fetch */
3784 DbPage **ppPage, /* Write a pointer to the page here */
3785 int noContent /* Do not bother reading content from disk if true */
3786){
3787 int rc;
3788 pagerEnter(pPager);
3789 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3790 pagerLeave(pPager);
3791 return rc;
3792}
3793
drhed7c8552001-04-11 14:29:21 +00003794
3795/*
drh7e3b0a02001-04-28 16:52:40 +00003796** Acquire a page if it is already in the in-memory cache. Do
3797** not read the page from disk. Return a pointer to the page,
3798** or 0 if the page is not in cache.
3799**
danielk19773b8a05f2007-03-19 17:44:26 +00003800** See also sqlite3PagerGet(). The difference between this routine
3801** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003802** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003803** returns NULL if the page is not in cache or if a disk I/O error
3804** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003805*/
danielk19773b8a05f2007-03-19 17:44:26 +00003806DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003807 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003808
drh836faa42003-01-11 13:30:57 +00003809 assert( pPager!=0 );
3810 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003811
drh86f8c192007-08-22 00:39:19 +00003812 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003813 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003814 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003815 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3816 /* Do nothing */
3817 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3818 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003819 }
drh86f8c192007-08-22 00:39:19 +00003820 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003821 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003822}
3823
3824/*
drhed7c8552001-04-11 14:29:21 +00003825** Release a page.
3826**
3827** If the number of references to the page drop to zero, then the
3828** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003829** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003830** removed.
3831*/
danielk19773b8a05f2007-03-19 17:44:26 +00003832int sqlite3PagerUnref(DbPage *pPg){
danielk1977ae72d982007-10-03 08:46:44 +00003833 Pager *pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003834
3835 /* Decrement the reference count for this page
3836 */
drhed7c8552001-04-11 14:29:21 +00003837 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003838 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003839 pPg->nRef--;
drhd9b02572001-04-15 00:37:09 +00003840
danielk19773c407372005-02-15 02:54:14 +00003841 CHECK_PAGE(pPg);
3842
drh72f82862001-05-24 21:06:34 +00003843 /* When the number of references to a page reach 0, call the
3844 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003845 */
drhed7c8552001-04-11 14:29:21 +00003846 if( pPg->nRef==0 ){
danielk19779f61c2f2007-08-27 17:27:49 +00003847
3848 lruListAdd(pPg);
drh72f82862001-05-24 21:06:34 +00003849 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003850 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003851 }
drhd9b02572001-04-15 00:37:09 +00003852
3853 /* When all pages reach the freelist, drop the read lock from
3854 ** the database file.
3855 */
3856 pPager->nRef--;
3857 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003858 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003859 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003860 }
drhed7c8552001-04-11 14:29:21 +00003861 }
danielk1977ae72d982007-10-03 08:46:44 +00003862 pagerLeave(pPager);
drhd9b02572001-04-15 00:37:09 +00003863 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003864}
3865
3866/*
drha6abd042004-06-09 17:37:22 +00003867** Create a journal file for pPager. There should already be a RESERVED
3868** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003869**
3870** Return SQLITE_OK if everything. Return an error code and release the
3871** write lock if anything goes wrong.
3872*/
3873static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003874 sqlite3_vfs *pVfs = pPager->pVfs;
3875 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3876
drhda47d772002-12-02 04:25:19 +00003877 int rc;
drhb7f91642004-10-31 02:22:47 +00003878 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003879 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003880 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003881 assert( pPager->pInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003882 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003883 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003884 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00003885 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003886 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003887 rc = SQLITE_NOMEM;
3888 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003889 }
danielk1977b4b47412007-08-17 15:53:36 +00003890
drhfdc40e92008-04-17 20:59:37 +00003891 if( pPager->journalOpen==0 ){
3892 if( pPager->tempFile ){
3893 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3894 }else{
3895 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00003896 }
drhfdc40e92008-04-17 20:59:37 +00003897#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3898 rc = sqlite3JournalOpen(
3899 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3900 );
3901#else
3902 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
3903#endif
3904 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3905 pPager->journalOff = 0;
3906 pPager->setMaster = 0;
3907 pPager->journalHdr = 0;
3908 if( rc!=SQLITE_OK ){
3909 if( rc==SQLITE_NOMEM ){
3910 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3911 }
3912 goto failed_to_open_journal;
3913 }
drhda47d772002-12-02 04:25:19 +00003914 }
3915 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003916 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003917 pPager->needSync = 0;
3918 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003919 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003920 if( pPager->errCode ){
3921 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003922 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003923 }
drhda47d772002-12-02 04:25:19 +00003924 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003925
danielk197776572402004-06-25 02:38:54 +00003926 rc = writeJournalHdr(pPager);
3927
drhac69b052004-05-12 13:30:07 +00003928 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003929 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003930 }
danielk1977ae72d982007-10-03 08:46:44 +00003931 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003932 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003933 if( rc==SQLITE_OK ){
3934 rc = SQLITE_FULL;
3935 }
3936 }
drh9c105bb2004-10-02 20:38:28 +00003937 return rc;
3938
3939failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003940 sqlite3BitvecDestroy(pPager->pInJournal);
3941 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003942 return rc;
drhda47d772002-12-02 04:25:19 +00003943}
3944
3945/*
drh4b845d72002-03-05 12:41:19 +00003946** Acquire a write-lock on the database. The lock is removed when
3947** the any of the following happen:
3948**
drh80e35f42007-03-30 14:06:34 +00003949** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003950** * sqlite3PagerRollback() is called.
3951** * sqlite3PagerClose() is called.
3952** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003953**
danielk197713adf8a2004-06-03 16:08:41 +00003954** The first parameter to this routine is a pointer to any open page of the
3955** database file. Nothing changes about the page - it is used merely to
3956** acquire a pointer to the Pager structure and as proof that there is
3957** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003958**
danielk197713adf8a2004-06-03 16:08:41 +00003959** The second parameter indicates how much space in bytes to reserve for a
3960** master journal file-name at the start of the journal when it is created.
3961**
3962** A journal file is opened if this is not a temporary file. For temporary
3963** files, the opening of the journal file is deferred until there is an
3964** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003965**
drha6abd042004-06-09 17:37:22 +00003966** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003967**
3968** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3969** immediately instead of waiting until we try to flush the cache. The
3970** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003971*/
danielk19773b8a05f2007-03-19 17:44:26 +00003972int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003973 Pager *pPager = pPg->pPager;
3974 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00003975 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00003976 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003977 assert( pPager->state!=PAGER_UNLOCK );
3978 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003979 assert( pPager->pInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00003980 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003981 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003982 pPager->origDbSize = pPager->dbSize;
3983 }else{
drh054889e2005-11-30 03:20:31 +00003984 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003985 if( rc==SQLITE_OK ){
3986 pPager->state = PAGER_RESERVED;
3987 if( exFlag ){
3988 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3989 }
3990 }
danielk19779eed5052004-06-04 10:38:30 +00003991 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00003992 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00003993 return rc;
drhac69b052004-05-12 13:30:07 +00003994 }
drha6abd042004-06-09 17:37:22 +00003995 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003996 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhfdc40e92008-04-17 20:59:37 +00003997 if( pPager->useJournal && !pPager->tempFile
3998 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drhac69b052004-05-12 13:30:07 +00003999 rc = pager_open_journal(pPager);
4000 }
drh4b845d72002-03-05 12:41:19 +00004001 }
danielk1977334cdb62007-03-26 08:05:12 +00004002 }else if( pPager->journalOpen && pPager->journalOff==0 ){
4003 /* This happens when the pager was in exclusive-access mode last
4004 ** time a (read or write) transaction was successfully concluded
4005 ** by this connection. Instead of deleting the journal file it was
4006 ** kept open and truncated to 0 bytes.
4007 */
4008 assert( pPager->nRec==0 );
4009 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00004010 assert( pPager->pInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00004011 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00004012 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004013 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhed138fb2007-08-22 22:04:37 +00004014 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004015 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00004016 rc = SQLITE_NOMEM;
4017 }else{
drh369339d2007-03-30 16:01:55 +00004018 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00004019 rc = writeJournalHdr(pPager);
4020 }
drh4b845d72002-03-05 12:41:19 +00004021 }
danielk1977334cdb62007-03-26 08:05:12 +00004022 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00004023 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00004024 return rc;
4025}
4026
4027/*
drh605ad8f2006-05-03 23:34:05 +00004028** Make a page dirty. Set its dirty flag and add it to the dirty
4029** page list.
4030*/
4031static void makeDirty(PgHdr *pPg){
4032 if( pPg->dirty==0 ){
4033 Pager *pPager = pPg->pPager;
4034 pPg->dirty = 1;
4035 pPg->pDirty = pPager->pDirty;
4036 if( pPager->pDirty ){
4037 pPager->pDirty->pPrevDirty = pPg;
4038 }
4039 pPg->pPrevDirty = 0;
4040 pPager->pDirty = pPg;
4041 }
4042}
4043
4044/*
4045** Make a page clean. Clear its dirty bit and remove it from the
4046** dirty page list.
4047*/
4048static void makeClean(PgHdr *pPg){
4049 if( pPg->dirty ){
4050 pPg->dirty = 0;
4051 if( pPg->pDirty ){
drh153c62c2007-08-24 03:51:33 +00004052 assert( pPg->pDirty->pPrevDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004053 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
4054 }
4055 if( pPg->pPrevDirty ){
drh153c62c2007-08-24 03:51:33 +00004056 assert( pPg->pPrevDirty->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004057 pPg->pPrevDirty->pDirty = pPg->pDirty;
4058 }else{
drh153c62c2007-08-24 03:51:33 +00004059 assert( pPg->pPager->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004060 pPg->pPager->pDirty = pPg->pDirty;
4061 }
4062 }
4063}
4064
4065
4066/*
drhed7c8552001-04-11 14:29:21 +00004067** Mark a data page as writeable. The page is written into the journal
4068** if it is not there already. This routine must be called before making
4069** changes to a page.
4070**
4071** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00004072** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00004073** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00004074** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00004075** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00004076**
4077** If the journal file could not be written because the disk is full,
4078** then this routine returns SQLITE_FULL and does an immediate rollback.
4079** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00004080** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00004081** reset.
drhed7c8552001-04-11 14:29:21 +00004082*/
danielk19773b8a05f2007-03-19 17:44:26 +00004083static int pager_write(PgHdr *pPg){
4084 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00004085 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00004086 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00004087
drh6446c4d2001-12-15 14:22:18 +00004088 /* Check for errors
4089 */
danielk1977efaaf572006-01-16 11:29:19 +00004090 if( pPager->errCode ){
4091 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004092 }
drh5e00f6c2001-09-13 13:46:56 +00004093 if( pPager->readOnly ){
4094 return SQLITE_PERM;
4095 }
drh6446c4d2001-12-15 14:22:18 +00004096
danielk197776572402004-06-25 02:38:54 +00004097 assert( !pPager->setMaster );
4098
danielk19773c407372005-02-15 02:54:14 +00004099 CHECK_PAGE(pPg);
4100
drh538f5702007-04-13 02:14:30 +00004101 /* If this page was previously acquired with noContent==1, that means
4102 ** we didn't really read in the content of the page. This can happen
4103 ** (for example) when the page is being moved to the freelist. But
4104 ** now we are (perhaps) moving the page off of the freelist for
4105 ** reuse and we need to know its original content so that content
4106 ** can be stored in the rollback journal. So do the read at this
4107 ** time.
4108 */
drhd33d5a82007-04-26 12:11:28 +00004109 rc = pager_get_content(pPg);
4110 if( rc ){
4111 return rc;
drh538f5702007-04-13 02:14:30 +00004112 }
4113
drh6446c4d2001-12-15 14:22:18 +00004114 /* Mark the page as dirty. If the page has already been written
4115 ** to the journal then we can return right away.
4116 */
drh605ad8f2006-05-03 23:34:05 +00004117 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00004118 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00004119 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004120 }else{
drh6446c4d2001-12-15 14:22:18 +00004121
danielk1977a0bf2652004-11-04 14:30:04 +00004122 /* If we get this far, it means that the page needs to be
4123 ** written to the transaction journal or the ckeckpoint journal
4124 ** or both.
4125 **
4126 ** First check to see that the transaction journal exists and
4127 ** create it if it does not.
4128 */
4129 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00004130 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00004131 if( rc!=SQLITE_OK ){
4132 return rc;
4133 }
4134 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00004135 if( !pPager->journalOpen && pPager->useJournal
4136 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00004137 rc = pager_open_journal(pPager);
4138 if( rc!=SQLITE_OK ) return rc;
4139 }
danielk1977a0bf2652004-11-04 14:30:04 +00004140 pPager->dirtyCache = 1;
4141
4142 /* The transaction journal now exists and we have a RESERVED or an
4143 ** EXCLUSIVE lock on the main database file. Write the current page to
4144 ** the transaction journal if it is not there already.
4145 */
drhfdc40e92008-04-17 20:59:37 +00004146 if( !pPg->inJournal && (pPager->journalOpen || MEMDB) ){
danielk1977a0bf2652004-11-04 14:30:04 +00004147 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00004148 if( MEMDB ){
4149 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00004150 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004151 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00004152 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977662278e2007-11-05 15:30:12 +00004153 if( !pHist->pOrig ){
4154 return SQLITE_NOMEM;
danielk1977a0bf2652004-11-04 14:30:04 +00004155 }
danielk1977662278e2007-11-05 15:30:12 +00004156 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977a0bf2652004-11-04 14:30:04 +00004157 }else{
drhbf4bca52007-09-06 22:19:14 +00004158 u32 cksum;
4159 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00004160
drh267cb322005-09-16 17:16:52 +00004161 /* We should never write to the journal file the page that
4162 ** contains the database locks. The following assert verifies
4163 ** that we do not. */
4164 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00004165 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00004166 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00004167 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
4168 if( rc==SQLITE_OK ){
4169 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
4170 pPager->journalOff + 4);
4171 pPager->journalOff += pPager->pageSize+4;
4172 }
4173 if( rc==SQLITE_OK ){
4174 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
4175 pPager->journalOff += 4;
4176 }
4177 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00004178 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00004179 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00004180 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
4181 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00004182
drhfd131da2007-08-07 17:13:03 +00004183 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00004184 ** transaction will be rolled back by the layer above.
4185 */
danielk1977a0bf2652004-11-04 14:30:04 +00004186 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00004187 return rc;
4188 }
danielk197707cb5602006-01-20 10:55:05 +00004189
danielk1977a0bf2652004-11-04 14:30:04 +00004190 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00004191 assert( pPager->pInJournal!=0 );
4192 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004193 pPg->needSync = !pPager->noSync;
4194 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00004195 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004196 }
drhac69b052004-05-12 13:30:07 +00004197 }
danielk197713adf8a2004-06-03 16:08:41 +00004198 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004199 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00004200 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00004201 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00004202 }
4203 if( pPg->needSync ){
4204 pPager->needSync = 1;
4205 }
4206 pPg->inJournal = 1;
4207 }
4208
4209 /* If the statement journal is open and the page is not in it,
4210 ** then write the current page to the statement journal. Note that
4211 ** the statement journal format differs from the standard journal format
4212 ** in that it omits the checksums and the header.
4213 */
danielk1977f35843b2007-04-07 15:03:17 +00004214 if( pPager->stmtInUse
4215 && !pageInStatement(pPg)
4216 && (int)pPg->pgno<=pPager->stmtSize
4217 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004218 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
4219 if( MEMDB ){
4220 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4221 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00004222 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00004223 if( pHist->pStmt ){
4224 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
4225 }
drh4f0c5872007-03-26 22:05:01 +00004226 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00004227 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00004228 }else{
danielk197762079062007-08-15 17:08:46 +00004229 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00004230 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
4231 rc = write32bits(pPager->stfd, offset, pPg->pgno);
4232 if( rc==SQLITE_OK ){
4233 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
4234 }
drh4f0c5872007-03-26 22:05:01 +00004235 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00004236 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00004237 return rc;
4238 }
danielk1977a0bf2652004-11-04 14:30:04 +00004239 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00004240 assert( pPager->pInStmt!=0 );
4241 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00004242 }
drhd9b02572001-04-15 00:37:09 +00004243 }
drhfa86c412002-02-02 15:01:15 +00004244 }
4245
4246 /* Update the database size and return.
4247 */
drh1aa2d8b2007-01-03 15:34:29 +00004248 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00004249 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00004250 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00004251 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00004252 pPager->dbSize++;
4253 }
drh306dc212001-05-21 13:45:10 +00004254 }
drh69688d52001-04-14 16:38:23 +00004255 return rc;
drhed7c8552001-04-11 14:29:21 +00004256}
4257
4258/*
danielk19774099f6e2007-03-19 11:25:20 +00004259** This function is used to mark a data-page as writable. It uses
4260** pager_write() to open a journal file (if it is not already open)
4261** and write the page *pData to the journal.
4262**
4263** The difference between this function and pager_write() is that this
4264** function also deals with the special case where 2 or more pages
4265** fit on a single disk sector. In this case all co-resident pages
4266** must have been written to the journal file before returning.
4267*/
danielk19773b8a05f2007-03-19 17:44:26 +00004268int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00004269 int rc = SQLITE_OK;
4270
danielk19773b8a05f2007-03-19 17:44:26 +00004271 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00004272 Pager *pPager = pPg->pPager;
4273 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
4274
drh86f8c192007-08-22 00:39:19 +00004275 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004276 if( !MEMDB && nPagePerSector>1 ){
4277 Pgno nPageCount; /* Total number of pages in database file */
4278 Pgno pg1; /* First page of the sector pPg is located on. */
4279 int nPage; /* Number of pages starting at pg1 to journal */
4280 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00004281 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00004282
4283 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
4284 ** header to be written between the pages journaled by this function.
4285 */
4286 assert( pPager->doNotSync==0 );
4287 pPager->doNotSync = 1;
4288
4289 /* This trick assumes that both the page-size and sector-size are
4290 ** an integer power of 2. It sets variable pg1 to the identifier
4291 ** of the first page of the sector pPg is located on.
4292 */
4293 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
4294
danielk19773b8a05f2007-03-19 17:44:26 +00004295 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004296 if( pPg->pgno>nPageCount ){
4297 nPage = (pPg->pgno - pg1)+1;
4298 }else if( (pg1+nPagePerSector-1)>nPageCount ){
4299 nPage = nPageCount+1-pg1;
4300 }else{
4301 nPage = nPagePerSector;
4302 }
4303 assert(nPage>0);
4304 assert(pg1<=pPg->pgno);
4305 assert((pg1+nPage)>pPg->pgno);
4306
4307 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
4308 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00004309 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00004310 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00004311 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00004312 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004313 if( rc==SQLITE_OK ){
4314 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00004315 if( pPage->needSync ){
4316 needSync = 1;
4317 }
danielk19773b8a05f2007-03-19 17:44:26 +00004318 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004319 }
4320 }
drhc81945e2008-03-10 14:12:53 +00004321 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk1977dd97a492007-08-22 18:54:32 +00004322 if( pPage->needSync ){
4323 needSync = 1;
4324 }
danielk19774099f6e2007-03-19 11:25:20 +00004325 }
4326 }
4327
danielk1977dd97a492007-08-22 18:54:32 +00004328 /* If the PgHdr.needSync flag is set for any of the nPage pages
4329 ** starting at pg1, then it needs to be set for all of them. Because
4330 ** writing to any of these nPage pages may damage the others, the
4331 ** journal file must contain sync()ed copies of all of them
4332 ** before any of them can be written out to the database file.
4333 */
4334 if( needSync ){
4335 for(ii=0; ii<nPage && needSync; ii++){
4336 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
4337 if( pPage ) pPage->needSync = 1;
4338 }
4339 assert(pPager->needSync);
4340 }
4341
danielk19774099f6e2007-03-19 11:25:20 +00004342 assert( pPager->doNotSync==1 );
4343 pPager->doNotSync = 0;
4344 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004345 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00004346 }
drh86f8c192007-08-22 00:39:19 +00004347 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004348 return rc;
4349}
4350
4351/*
drhaacc5432002-01-06 17:07:40 +00004352** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00004353** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00004354** to change the content of the page.
4355*/
danielk19777d3a6662006-01-23 16:21:05 +00004356#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00004357int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00004358 return pPg->dirty;
4359}
danielk19777d3a6662006-01-23 16:21:05 +00004360#endif
drh6019e162001-07-02 17:51:45 +00004361
danielk1977b84f96f2005-01-20 11:32:23 +00004362#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00004363/*
drh001bbcb2003-03-19 03:14:00 +00004364** Replace the content of a single page with the information in the third
4365** argument.
4366*/
danielk19773b8a05f2007-03-19 17:44:26 +00004367int sqlite3PagerOverwrite(Pager *pPager, Pgno pgno, void *pData){
4368 PgHdr *pPg;
drh001bbcb2003-03-19 03:14:00 +00004369 int rc;
4370
drh86f8c192007-08-22 00:39:19 +00004371 pagerEnter(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00004372 rc = sqlite3PagerGet(pPager, pgno, &pPg);
drh001bbcb2003-03-19 03:14:00 +00004373 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004374 rc = sqlite3PagerWrite(pPg);
drh001bbcb2003-03-19 03:14:00 +00004375 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004376 memcpy(sqlite3PagerGetData(pPg), pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00004377 }
danielk19773b8a05f2007-03-19 17:44:26 +00004378 sqlite3PagerUnref(pPg);
drh001bbcb2003-03-19 03:14:00 +00004379 }
drh86f8c192007-08-22 00:39:19 +00004380 pagerLeave(pPager);
drh001bbcb2003-03-19 03:14:00 +00004381 return rc;
4382}
danielk1977b84f96f2005-01-20 11:32:23 +00004383#endif
drh001bbcb2003-03-19 03:14:00 +00004384
4385/*
drh30e58752002-03-02 20:41:57 +00004386** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00004387** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00004388** that page might be marked as dirty.
4389**
4390** The overlying software layer calls this routine when all of the data
4391** on the given page is unused. The pager marks the page as clean so
4392** that it does not get written to disk.
4393**
4394** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00004395** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00004396** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00004397**
4398** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00004399** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00004400** will thereafter be ignored. This is necessary to avoid a problem
4401** where a page with data is added to the freelist during one part of
4402** a transaction then removed from the freelist during a later part
4403** of the same transaction and reused for some other purpose. When it
4404** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004405** the sqlite3PagerDontRollback() routine is called. But because the
4406** page contains critical data, we still need to be sure it gets
4407** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004408*/
drh538f5702007-04-13 02:14:30 +00004409void sqlite3PagerDontWrite(DbPage *pDbPage){
4410 PgHdr *pPg = pDbPage;
4411 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004412
drhb7f91642004-10-31 02:22:47 +00004413 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004414 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004415 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004416 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004417 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004418 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4419 /* If this pages is the last page in the file and the file has grown
4420 ** during the current transaction, then do NOT mark the page as clean.
4421 ** When the database file grows, we must make sure that the last page
4422 ** gets written at least once so that the disk file will be the correct
4423 ** size. If you do not write this page and the size of the file
4424 ** on the disk ends up being too small, that can lead to database
4425 ** corruption during the next transaction.
4426 */
4427 }else{
drh538f5702007-04-13 02:14:30 +00004428 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4429 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004430 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004431#ifdef SQLITE_CHECK_PAGES
4432 pPg->pageHash = pager_pagehash(pPg);
4433#endif
drh8124a302002-06-25 14:43:57 +00004434 }
drh30e58752002-03-02 20:41:57 +00004435 }
drh86f8c192007-08-22 00:39:19 +00004436 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004437}
4438
4439/*
4440** A call to this routine tells the pager that if a rollback occurs,
4441** it is not necessary to restore the data on the given page. This
4442** means that the pager does not have to record the given page in the
4443** rollback journal.
drh538f5702007-04-13 02:14:30 +00004444**
4445** If we have not yet actually read the content of this page (if
4446** the PgHdr.needRead flag is set) then this routine acts as a promise
4447** that we will never need to read the page content in the future.
4448** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00004449*/
danielk19773b8a05f2007-03-19 17:44:26 +00004450void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004451 Pager *pPager = pPg->pPager;
4452
drh86f8c192007-08-22 00:39:19 +00004453 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004454 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00004455
4456 /* If the journal file is not open, or DontWrite() has been called on
4457 ** this page (DontWrite() sets the alwaysRollback flag), then this
4458 ** function is a no-op.
4459 */
4460 if( pPager->journalOpen==0 || pPg->alwaysRollback || pPager->alwaysRollback ){
danielk197787c29a92008-01-18 11:33:16 +00004461 pagerLeave(pPager);
4462 return;
4463 }
danielk1977a55e9352008-01-21 13:04:34 +00004464 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
4465
drhc5d0bd92008-04-14 01:00:57 +00004466#ifdef SQLITE_SECURE_DELETE
4467 if( pPg->inJournal || (int)pPg->pgno > pPager->origDbSize ){
4468 return;
4469 }
4470#endif
4471
4472 /* If SECURE_DELETE is disabled, then there is no way that this
4473 ** routine can be called on a page for which sqlite3PagerDontWrite()
4474 ** has not been previously called during the same transaction.
4475 ** And if DontWrite() has previously been called, the following
4476 ** conditions must be met.
danielk1977a55e9352008-01-21 13:04:34 +00004477 */
4478 assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize );
4479
drhf5e7bb52008-02-18 14:47:33 +00004480 assert( pPager->pInJournal!=0 );
4481 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00004482 pPg->inJournal = 1;
4483 pPg->needRead = 0;
4484 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00004485 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00004486 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00004487 }
danielk1977a55e9352008-01-21 13:04:34 +00004488 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
4489 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh86f8c192007-08-22 00:39:19 +00004490 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004491}
4492
drhac69b052004-05-12 13:30:07 +00004493
drh30e58752002-03-02 20:41:57 +00004494/*
drh80e35f42007-03-30 14:06:34 +00004495** This routine is called to increment the database file change-counter,
4496** stored at byte 24 of the pager file.
4497*/
danielk1977c7b60172007-08-22 11:22:03 +00004498static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004499 PgHdr *pPgHdr;
4500 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004501 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004502
4503 if( !pPager->changeCountDone ){
4504 /* Open page 1 of the file for writing. */
4505 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4506 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004507
4508 if( !isDirect ){
4509 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00004510 if( rc!=SQLITE_OK ){
4511 sqlite3PagerUnref(pPgHdr);
4512 return rc;
4513 }
danielk1977c7b60172007-08-22 11:22:03 +00004514 }
4515
drh80e35f42007-03-30 14:06:34 +00004516 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004517 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004518 change_counter++;
4519 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004520
4521 if( isDirect && pPager->fd->pMethods ){
4522 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4523 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4524 }
4525
drh80e35f42007-03-30 14:06:34 +00004526 /* Release the page reference. */
4527 sqlite3PagerUnref(pPgHdr);
4528 pPager->changeCountDone = 1;
4529 }
danielk1977c7b60172007-08-22 11:22:03 +00004530 return rc;
drh80e35f42007-03-30 14:06:34 +00004531}
4532
4533/*
danielk1977f653d782008-03-20 11:04:21 +00004534** Sync the pager file to disk.
4535*/
4536int sqlite3PagerSync(Pager *pPager){
4537 int rc;
4538 pagerEnter(pPager);
4539 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
4540 pagerLeave(pPager);
4541 return rc;
4542}
4543
4544/*
drh80e35f42007-03-30 14:06:34 +00004545** Sync the database file for the pager pPager. zMaster points to the name
4546** of a master journal file that should be written into the individual
4547** journal file. zMaster may be NULL, which is interpreted as no master
4548** journal (a single database transaction).
4549**
4550** This routine ensures that the journal is synced, all dirty pages written
4551** to the database file and the database file synced. The only thing that
4552** remains to commit the transaction is to delete the journal file (or
4553** master journal file if specified).
4554**
4555** Note that if zMaster==NULL, this does not overwrite a previous value
4556** passed to an sqlite3PagerCommitPhaseOne() call.
4557**
4558** If parameter nTrunc is non-zero, then the pager file is truncated to
4559** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00004560**
4561** If the final parameter - noSync - is true, then the database file itself
4562** is not synced. The caller must call sqlite3PagerSync() directly to
4563** sync the database file before calling CommitPhaseTwo() to delete the
4564** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00004565*/
danielk1977f653d782008-03-20 11:04:21 +00004566int sqlite3PagerCommitPhaseOne(
4567 Pager *pPager,
4568 const char *zMaster,
4569 Pgno nTrunc,
4570 int noSync
4571){
drh80e35f42007-03-30 14:06:34 +00004572 int rc = SQLITE_OK;
4573
4574 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4575 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004576 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004577
4578 /* If this is an in-memory db, or no pages have been written to, or this
4579 ** function has already been called, it is a no-op.
4580 */
4581 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4582 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00004583
danielk1977c7b60172007-08-22 11:22:03 +00004584#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4585 /* The atomic-write optimization can be used if all of the
4586 ** following are true:
4587 **
4588 ** + The file-system supports the atomic-write property for
4589 ** blocks of size page-size, and
4590 ** + This commit is not part of a multi-file transaction, and
4591 ** + Exactly one page has been modified and store in the journal file.
4592 **
4593 ** If the optimization can be used, then the journal file will never
4594 ** be created for this transaction.
4595 */
danielk1977f55b8992007-08-24 08:15:53 +00004596 int useAtomicWrite = (
4597 !zMaster &&
4598 pPager->journalOff==jrnlBufferSize(pPager) &&
4599 nTrunc==0 &&
4600 (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4601 );
4602 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00004603 /* Update the nRec field in the journal file. */
4604 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4605 assert(pPager->nRec==1);
4606 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4607
4608 /* Update the db file change counter. The following call will modify
4609 ** the in-memory representation of page 1 to include the updated
4610 ** change counter and then write page 1 directly to the database
4611 ** file. Because of the atomic-write property of the host file-system,
4612 ** this is safe.
4613 */
danielk1977ae72d982007-10-03 08:46:44 +00004614 if( rc==SQLITE_OK ){
4615 rc = pager_incr_changecounter(pPager, 1);
4616 }
danielk1977f55b8992007-08-24 08:15:53 +00004617 }else{
4618 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00004619 }
4620
danielk1977ae72d982007-10-03 08:46:44 +00004621 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00004622#endif
4623
drh80e35f42007-03-30 14:06:34 +00004624 /* If a master journal file name has already been written to the
4625 ** journal file, then no sync is required. This happens when it is
4626 ** written, then the process fails to upgrade from a RESERVED to an
4627 ** EXCLUSIVE lock. The next time the process tries to commit the
4628 ** transaction the m-j name will have already been written.
4629 */
4630 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00004631 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004632 if( rc!=SQLITE_OK ) goto sync_exit;
4633#ifndef SQLITE_OMIT_AUTOVACUUM
4634 if( nTrunc!=0 ){
4635 /* If this transaction has made the database smaller, then all pages
4636 ** being discarded by the truncation must be written to the journal
4637 ** file.
4638 */
4639 Pgno i;
4640 int iSkip = PAGER_MJ_PGNO(pPager);
4641 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
drhf5e7bb52008-02-18 14:47:33 +00004642 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
drh80e35f42007-03-30 14:06:34 +00004643 rc = sqlite3PagerGet(pPager, i, &pPg);
4644 if( rc!=SQLITE_OK ) goto sync_exit;
4645 rc = sqlite3PagerWrite(pPg);
4646 sqlite3PagerUnref(pPg);
4647 if( rc!=SQLITE_OK ) goto sync_exit;
4648 }
4649 }
4650 }
4651#endif
4652 rc = writeMasterJournal(pPager, zMaster);
4653 if( rc!=SQLITE_OK ) goto sync_exit;
4654 rc = syncJournal(pPager);
drh80e35f42007-03-30 14:06:34 +00004655 }
danielk1977c7b60172007-08-22 11:22:03 +00004656 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004657
4658#ifndef SQLITE_OMIT_AUTOVACUUM
4659 if( nTrunc!=0 ){
4660 rc = sqlite3PagerTruncate(pPager, nTrunc);
4661 if( rc!=SQLITE_OK ) goto sync_exit;
4662 }
4663#endif
4664
4665 /* Write all dirty pages to the database file */
4666 pPg = pager_get_all_dirty_pages(pPager);
4667 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00004668 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00004669 assert( rc!=SQLITE_IOERR_BLOCKED );
4670 /* The error might have left the dirty list all fouled up here,
4671 ** but that does not matter because if the if the dirty list did
4672 ** get corrupted, then the transaction will roll back and
4673 ** discard the dirty list. There is an assert in
4674 ** pager_get_all_dirty_pages() that verifies that no attempt
4675 ** is made to use an invalid dirty list.
4676 */
drh153c62c2007-08-24 03:51:33 +00004677 goto sync_exit;
4678 }
drh3cdd7d32007-03-30 14:46:01 +00004679 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004680
4681 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00004682 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004683 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004684 }
4685 IOTRACE(("DBSYNC %p\n", pPager))
4686
4687 pPager->state = PAGER_SYNCED;
4688 }else if( MEMDB && nTrunc!=0 ){
4689 rc = sqlite3PagerTruncate(pPager, nTrunc);
4690 }
4691
4692sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004693 if( rc==SQLITE_IOERR_BLOCKED ){
4694 /* pager_incr_changecounter() may attempt to obtain an exclusive
4695 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00004696 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00004697 * better to return SQLITE_BUSY.
4698 */
4699 rc = SQLITE_BUSY;
4700 }
drh86f8c192007-08-22 00:39:19 +00004701 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004702 return rc;
4703}
4704
4705
4706/*
drhed7c8552001-04-11 14:29:21 +00004707** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004708**
4709** If the commit fails for any reason, a rollback attempt is made
4710** and an error code is returned. If the commit worked, SQLITE_OK
4711** is returned.
drhed7c8552001-04-11 14:29:21 +00004712*/
drh80e35f42007-03-30 14:06:34 +00004713int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004714 int rc;
drhed7c8552001-04-11 14:29:21 +00004715 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004716
danielk1977efaaf572006-01-16 11:29:19 +00004717 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004718 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004719 }
drha6abd042004-06-09 17:37:22 +00004720 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004721 return SQLITE_ERROR;
4722 }
drh86f8c192007-08-22 00:39:19 +00004723 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004724 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004725 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004726 pPg = pager_get_all_dirty_pages(pPager);
4727 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004728 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4729 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004730 pPg->dirty = 0;
4731 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004732 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004733 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004734 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004735 pPg = pPg->pDirty;
4736 }
drh605ad8f2006-05-03 23:34:05 +00004737 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004738#ifndef NDEBUG
4739 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4740 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4741 assert( !pPg->alwaysRollback );
4742 assert( !pHist->pOrig );
4743 assert( !pHist->pStmt );
4744 }
4745#endif
drhac69b052004-05-12 13:30:07 +00004746 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004747 pPager->state = PAGER_SHARED;
danielk197787c29a92008-01-18 11:33:16 +00004748 pagerLeave(pPager);
drhac69b052004-05-12 13:30:07 +00004749 return SQLITE_OK;
4750 }
drh3cdd7d32007-03-30 14:46:01 +00004751 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
4752 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004753 rc = pager_error(pPager, rc);
4754 pagerLeave(pPager);
4755 return rc;
drhed7c8552001-04-11 14:29:21 +00004756}
4757
4758/*
drha6abd042004-06-09 17:37:22 +00004759** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004760** All in-memory cache pages revert to their original data contents.
4761** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004762**
4763** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004764** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004765** process is writing trash into the journal file (SQLITE_CORRUPT) or
4766** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4767** codes are returned for all these occasions. Otherwise,
4768** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004769*/
danielk19773b8a05f2007-03-19 17:44:26 +00004770int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004771 int rc;
drh4f0c5872007-03-26 22:05:01 +00004772 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004773 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004774 PgHdr *p;
4775 for(p=pPager->pAll; p; p=p->pNextAll){
4776 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004777 assert( !p->alwaysRollback );
4778 if( !p->dirty ){
4779 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4780 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4781 continue;
4782 }
4783
drhac69b052004-05-12 13:30:07 +00004784 pHist = PGHDR_TO_HIST(p, pPager);
4785 if( pHist->pOrig ){
4786 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004787 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004788 }else{
drh4f0c5872007-03-26 22:05:01 +00004789 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004790 }
4791 clearHistory(pHist);
4792 p->dirty = 0;
4793 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004794 pHist->inStmt = 0;
4795 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004796 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004797 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004798 }
drhac69b052004-05-12 13:30:07 +00004799 }
drh605ad8f2006-05-03 23:34:05 +00004800 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004801 pPager->pStmt = 0;
4802 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004803 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004804 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004805 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004806 return SQLITE_OK;
4807 }
4808
drh86f8c192007-08-22 00:39:19 +00004809 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004810 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00004811 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004812 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004813 return rc;
4814 }
drhdb48ee02003-01-16 13:42:43 +00004815
danielk1977efaaf572006-01-16 11:29:19 +00004816 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004817 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004818 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004819 }
drh86f8c192007-08-22 00:39:19 +00004820 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004821 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004822 }
drha6abd042004-06-09 17:37:22 +00004823 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004824 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004825 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004826 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00004827 if( rc==SQLITE_OK ){
4828 rc = rc2;
4829 }
4830 }else{
danielk1977e277be02007-03-23 18:12:06 +00004831 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004832 }
danielk1977e180dd92007-04-05 17:15:52 +00004833 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004834 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004835
4836 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4837 ** cache. So call pager_error() on the way out to make any error
4838 ** persistent.
4839 */
drh86f8c192007-08-22 00:39:19 +00004840 rc = pager_error(pPager, rc);
4841 pagerLeave(pPager);
4842 return rc;
drh98808ba2001-10-18 12:34:46 +00004843}
drhd9b02572001-04-15 00:37:09 +00004844
4845/*
drh5e00f6c2001-09-13 13:46:56 +00004846** Return TRUE if the database file is opened read-only. Return FALSE
4847** if the database is (in theory) writable.
4848*/
danielk19773b8a05f2007-03-19 17:44:26 +00004849int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004850 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004851}
4852
4853/*
drh0f7eb612006-08-08 13:51:43 +00004854** Return the number of references to the pager.
4855*/
danielk19773b8a05f2007-03-19 17:44:26 +00004856int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004857 return pPager->nRef;
4858}
4859
4860#ifdef SQLITE_TEST
4861/*
drhd9b02572001-04-15 00:37:09 +00004862** This routine is used for testing and analysis only.
4863*/
danielk19773b8a05f2007-03-19 17:44:26 +00004864int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004865 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004866 a[0] = pPager->nRef;
4867 a[1] = pPager->nPage;
4868 a[2] = pPager->mxPage;
4869 a[3] = pPager->dbSize;
4870 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004871 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004872 a[6] = pPager->nHit;
4873 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004874 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004875 a[9] = pPager->nRead;
4876 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004877 return a;
4878}
drh0f7eb612006-08-08 13:51:43 +00004879#endif
drhdd793422001-06-28 01:54:48 +00004880
drhfa86c412002-02-02 15:01:15 +00004881/*
drhac69b052004-05-12 13:30:07 +00004882** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004883**
4884** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004885** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004886** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004887*/
drh86f8c192007-08-22 00:39:19 +00004888static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004889 int rc;
drhac69b052004-05-12 13:30:07 +00004890 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004891 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004892 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004893 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004894 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004895 pPager->stmtInUse = 1;
4896 pPager->stmtSize = pPager->dbSize;
4897 return SQLITE_OK;
4898 }
drhda47d772002-12-02 04:25:19 +00004899 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004900 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004901 return SQLITE_OK;
4902 }
drhfa86c412002-02-02 15:01:15 +00004903 assert( pPager->journalOpen );
drhed138fb2007-08-22 22:04:37 +00004904 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004905 assert( pPager->pInStmt==0 );
4906 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00004907 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004908 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004909 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004910 return SQLITE_NOMEM;
4911 }
danielk197776572402004-06-25 02:38:54 +00004912 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004913 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004914 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004915 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004916 if( !pPager->stmtOpen ){
drh334b2992007-09-06 23:28:23 +00004917 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, pPager->zStmtJrnl,
drh33f4e022007-09-03 15:19:34 +00004918 SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00004919 if( rc ){
4920 goto stmt_begin_failed;
4921 }
drhac69b052004-05-12 13:30:07 +00004922 pPager->stmtOpen = 1;
4923 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004924 }
drhac69b052004-05-12 13:30:07 +00004925 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004926 return SQLITE_OK;
4927
drhac69b052004-05-12 13:30:07 +00004928stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00004929 if( pPager->pInStmt ){
4930 sqlite3BitvecDestroy(pPager->pInStmt);
4931 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004932 }
4933 return rc;
4934}
drh86f8c192007-08-22 00:39:19 +00004935int sqlite3PagerStmtBegin(Pager *pPager){
4936 int rc;
4937 pagerEnter(pPager);
4938 rc = pagerStmtBegin(pPager);
4939 pagerLeave(pPager);
4940 return rc;
4941}
drhfa86c412002-02-02 15:01:15 +00004942
4943/*
drhac69b052004-05-12 13:30:07 +00004944** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004945*/
danielk19773b8a05f2007-03-19 17:44:26 +00004946int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00004947 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004948 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004949 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004950 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004951 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004952 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhf5e7bb52008-02-18 14:47:33 +00004953 sqlite3BitvecDestroy(pPager->pInStmt);
4954 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004955 }else{
4956 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004957 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004958 pNext = pHist->pNextStmt;
4959 assert( pHist->inStmt );
4960 pHist->inStmt = 0;
4961 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00004962 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004963 pHist->pStmt = 0;
4964 }
4965 }
4966 pPager->stmtNRec = 0;
4967 pPager->stmtInUse = 0;
4968 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004969 }
drhac69b052004-05-12 13:30:07 +00004970 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004971 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004972 return SQLITE_OK;
4973}
4974
4975/*
drhac69b052004-05-12 13:30:07 +00004976** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004977*/
danielk19773b8a05f2007-03-19 17:44:26 +00004978int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004979 int rc;
drh86f8c192007-08-22 00:39:19 +00004980 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004981 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004982 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004983 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004984 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004985 PgHistory *pHist;
4986 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4987 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004988 if( pHist->pStmt ){
4989 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00004990 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004991 pHist->pStmt = 0;
4992 }
4993 }
4994 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00004995 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004996 rc = SQLITE_OK;
4997 }else{
4998 rc = pager_stmt_playback(pPager);
4999 }
danielk19773b8a05f2007-03-19 17:44:26 +00005000 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00005001 }else{
5002 rc = SQLITE_OK;
5003 }
drhac69b052004-05-12 13:30:07 +00005004 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00005005 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00005006 return rc;
5007}
5008
drh73509ee2003-04-06 20:44:45 +00005009/*
5010** Return the full pathname of the database file.
5011*/
danielk19773b8a05f2007-03-19 17:44:26 +00005012const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00005013 return pPager->zFilename;
5014}
5015
drhb20ea9d2004-02-09 01:20:36 +00005016/*
drhd0679ed2007-08-28 22:24:34 +00005017** Return the VFS structure for the pager.
5018*/
5019const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
5020 return pPager->pVfs;
5021}
5022
5023/*
drhcc6bb3e2007-08-31 16:11:35 +00005024** Return the file handle for the database file associated
5025** with the pager. This might return NULL if the file has
5026** not yet been opened.
5027*/
5028sqlite3_file *sqlite3PagerFile(Pager *pPager){
5029 return pPager->fd;
5030}
5031
5032/*
danielk19775865e3d2004-06-14 06:03:57 +00005033** Return the directory of the database file.
5034*/
danielk19773b8a05f2007-03-19 17:44:26 +00005035const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005036 return pPager->zDirectory;
5037}
5038
5039/*
5040** Return the full pathname of the journal file.
5041*/
danielk19773b8a05f2007-03-19 17:44:26 +00005042const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005043 return pPager->zJournal;
5044}
5045
5046/*
drh2c8997b2005-08-27 16:36:48 +00005047** Return true if fsync() calls are disabled for this pager. Return FALSE
5048** if fsync()s are executed normally.
5049*/
danielk19773b8a05f2007-03-19 17:44:26 +00005050int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00005051 return pPager->noSync;
5052}
5053
drh7c4ac0c2007-04-05 11:25:58 +00005054#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00005055/*
drhb20ea9d2004-02-09 01:20:36 +00005056** Set the codec for this pager
5057*/
danielk19773b8a05f2007-03-19 17:44:26 +00005058void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00005059 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00005060 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00005061 void *pCodecArg
5062){
5063 pPager->xCodec = xCodec;
5064 pPager->pCodecArg = pCodecArg;
5065}
drh7c4ac0c2007-04-05 11:25:58 +00005066#endif
drhb20ea9d2004-02-09 01:20:36 +00005067
danielk1977687566d2004-11-02 12:56:41 +00005068#ifndef SQLITE_OMIT_AUTOVACUUM
5069/*
danielk197787c29a92008-01-18 11:33:16 +00005070** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00005071**
drh5e385312007-06-16 04:42:12 +00005072** There must be no references to the page previously located at
5073** pgno (which we call pPgOld) though that page is allowed to be
5074** in cache. If the page previous located at pgno is not already
5075** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00005076**
drh5e385312007-06-16 04:42:12 +00005077** References to the page pPg remain valid. Updating any
5078** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00005079** allocated along with the page) is the responsibility of the caller.
5080**
danielk19775fd057a2005-03-09 13:09:43 +00005081** A transaction must be active when this routine is called. It used to be
5082** required that a statement transaction was not active, but this restriction
5083** has been removed (CREATE INDEX needs to move a page when a statement
5084** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00005085*/
danielk19773b8a05f2007-03-19 17:44:26 +00005086int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00005087 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00005088 int h;
danielk197794daf7f2004-11-08 09:26:09 +00005089 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00005090
drh86f8c192007-08-22 00:39:19 +00005091 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005092 assert( pPg->nRef>0 );
5093
drh4f0c5872007-03-26 22:05:01 +00005094 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00005095 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00005096 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00005097
danielk1977b4626a32007-04-28 15:47:43 +00005098 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00005099 if( pPg->needSync ){
5100 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00005101 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00005102 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00005103 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00005104 }
5105
drh85b623f2007-12-13 21:54:09 +00005106 /* Unlink pPg from its hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00005107 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00005108
danielk1977ef73ee92004-11-06 12:26:07 +00005109 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00005110 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00005111 ** page pgno before the 'move' operation, it needs to be retained
5112 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00005113 */
drh5e385312007-06-16 04:42:12 +00005114 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00005115 pPgOld = pager_lookup(pPager, pgno);
5116 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00005117 assert( pPgOld->nRef==0 );
5118 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00005119 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00005120 pPg->needSync = pPgOld->needSync;
5121 }else{
5122 pPg->needSync = 0;
5123 }
drhf5e7bb52008-02-18 14:47:33 +00005124 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
danielk1977687566d2004-11-02 12:56:41 +00005125
danielk1977f5fdda82004-11-03 08:44:05 +00005126 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00005127 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00005128 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00005129 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00005130 if( pPager->aHash[h] ){
5131 assert( pPager->aHash[h]->pPrevHash==0 );
5132 pPager->aHash[h]->pPrevHash = pPg;
5133 }
5134 pPg->pNextHash = pPager->aHash[h];
5135 pPager->aHash[h] = pPg;
5136 pPg->pPrevHash = 0;
5137
drh605ad8f2006-05-03 23:34:05 +00005138 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00005139 pPager->dirtyCache = 1;
5140
danielk197794daf7f2004-11-08 09:26:09 +00005141 if( needSyncPgno ){
5142 /* If needSyncPgno is non-zero, then the journal file needs to be
5143 ** sync()ed before any data is written to database file page needSyncPgno.
5144 ** Currently, no such page exists in the page-cache and the
drhf5e7bb52008-02-18 14:47:33 +00005145 ** Pager.pInJournal bit has been set. This needs to be remedied by loading
danielk197794daf7f2004-11-08 09:26:09 +00005146 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00005147 **
danielk1977a98d7b42008-01-18 13:42:54 +00005148 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00005149 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00005150 ** array. Otherwise, if the page is loaded and written again in
5151 ** this transaction, it may be written to the database file before
5152 ** it is synced into the journal file. This way, it may end up in
5153 ** the journal file twice, but that is not a problem.
5154 **
danielk19773b8a05f2007-03-19 17:44:26 +00005155 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00005156 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00005157 */
5158 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005159 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00005160 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00005161 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00005162 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00005163 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
5164 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00005165 }
danielk197787c29a92008-01-18 11:33:16 +00005166 pagerLeave(pPager);
5167 return rc;
5168 }
danielk1977ae825582004-11-23 09:06:55 +00005169 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00005170 pPgHdr->needSync = 1;
5171 pPgHdr->inJournal = 1;
5172 makeDirty(pPgHdr);
5173 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005174 }
5175
drh86f8c192007-08-22 00:39:19 +00005176 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005177 return SQLITE_OK;
5178}
5179#endif
5180
danielk19773b8a05f2007-03-19 17:44:26 +00005181/*
5182** Return a pointer to the data for the specified page.
5183*/
5184void *sqlite3PagerGetData(DbPage *pPg){
5185 return PGHDR_TO_DATA(pPg);
5186}
5187
5188/*
5189** Return a pointer to the Pager.nExtra bytes of "extra" space
5190** allocated along with the specified page.
5191*/
5192void *sqlite3PagerGetExtra(DbPage *pPg){
5193 Pager *pPager = pPg->pPager;
5194 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
5195}
5196
danielk197741483462007-03-24 16:45:04 +00005197/*
5198** Get/set the locking-mode for this pager. Parameter eMode must be one
5199** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
5200** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
5201** the locking-mode is set to the value specified.
5202**
5203** The returned value is either PAGER_LOCKINGMODE_NORMAL or
5204** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
5205** locking-mode.
5206*/
5207int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00005208 assert( eMode==PAGER_LOCKINGMODE_QUERY
5209 || eMode==PAGER_LOCKINGMODE_NORMAL
5210 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
5211 assert( PAGER_LOCKINGMODE_QUERY<0 );
5212 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
5213 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00005214 pPager->exclusiveMode = eMode;
5215 }
5216 return (int)pPager->exclusiveMode;
5217}
5218
drh3b020132008-04-17 17:02:01 +00005219/*
5220** Get/set the journal-mode for this pager. Parameter eMode must be one
5221** of PAGER_JOURNALMODE_QUERY, PAGER_JOURNALMODE_DELETE or
5222** PAGER_JOURNALMODE_PERSIST. If the parameter is not _QUERY, then
5223** the journal-mode is set to the value specified.
5224**
5225** The returned value is either PAGER_JOURNALMODE_DELETE or
5226** PAGER_JOURNALMODE_PERSIST, indicating the current (possibly updated)
5227** journal-mode.
5228*/
5229int sqlite3PagerJournalMode(Pager *pPager, int eMode){
5230 assert( eMode==PAGER_JOURNALMODE_QUERY
5231 || eMode==PAGER_JOURNALMODE_DELETE
drhfdc40e92008-04-17 20:59:37 +00005232 || eMode==PAGER_JOURNALMODE_PERSIST
5233 || eMode==PAGER_JOURNALMODE_OFF );
drh3b020132008-04-17 17:02:01 +00005234 assert( PAGER_JOURNALMODE_QUERY<0 );
5235 assert( PAGER_JOURNALMODE_DELETE>=0 && PAGER_JOURNALMODE_PERSIST>=0 );
drhfdc40e92008-04-17 20:59:37 +00005236 if( eMode>=0 ){
5237 pPager->journalMode = eMode;
drh3b020132008-04-17 17:02:01 +00005238 }
drhfdc40e92008-04-17 20:59:37 +00005239 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00005240}
5241
drhd919fe12007-12-11 19:34:44 +00005242#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00005243/*
5244** Print a listing of all referenced pages and their ref count.
5245*/
danielk19773b8a05f2007-03-19 17:44:26 +00005246void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00005247 PgHdr *pPg;
5248 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
5249 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00005250 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
5251 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00005252 }
5253}
5254#endif
drh2e66f0b2005-04-28 17:18:48 +00005255
5256#endif /* SQLITE_OMIT_DISKIO */