blob: dd691c2eebc3b0f098cf277eaadf2f12b3e5f338 [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**
danielk197706e11af2008-05-06 18:13:26 +000021** @(#) $Id: pager.c,v 1.440 2008/05/06 18:13:26 danielk1977 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;
drh26e4a8b2008-05-01 17:16:52 +0000519#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +0000520 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +0000521#endif
drh86f8c192007-08-22 00:39:19 +0000522 p->iInUseDB = 0;
523 sqlite3_mutex_enter(mutex);
524 p->iInUseDB = 1;
525 sqlite3_mutex_leave(mutex);
526 }
527 assert( p->iInUseMM==0 );
528 }
529 static void pagerLeave(Pager *p){
530 p->iInUseDB--;
531 assert( p->iInUseDB>=0 );
532 }
533#else
534# define pagerEnter(X)
535# define pagerLeave(X)
536#endif
537
538/*
danielk197784f786f2007-08-28 08:00:17 +0000539** Add page pPg to the end of the linked list managed by structure
540** pList (pPg becomes the last entry in the list - the most recently
541** used). Argument pLink should point to either pPg->free or pPg->gfree,
542** depending on whether pPg is being added to the pager-specific or
543** global LRU list.
544*/
danielk19779f61c2f2007-08-27 17:27:49 +0000545static void listAdd(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
546 pLink->pNext = 0;
547 pLink->pPrev = pList->pLast;
548
danielk197784f786f2007-08-28 08:00:17 +0000549#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
550 assert(pLink==&pPg->free || pLink==&pPg->gfree);
551 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
552#endif
553
danielk19779f61c2f2007-08-27 17:27:49 +0000554 if( pList->pLast ){
555 int iOff = (char *)pLink - (char *)pPg;
556 PagerLruLink *pLastLink = (PagerLruLink *)(&((u8 *)pList->pLast)[iOff]);
557 pLastLink->pNext = pPg;
558 }else{
559 assert(!pList->pFirst);
560 pList->pFirst = pPg;
561 }
562
563 pList->pLast = pPg;
564 if( !pList->pFirstSynced && pPg->needSync==0 ){
565 pList->pFirstSynced = pPg;
566 }
567}
568
danielk197784f786f2007-08-28 08:00:17 +0000569/*
570** Remove pPg from the list managed by the structure pointed to by pList.
571**
572** Argument pLink should point to either pPg->free or pPg->gfree, depending
573** on whether pPg is being added to the pager-specific or global LRU list.
574*/
danielk19779f61c2f2007-08-27 17:27:49 +0000575static void listRemove(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
576 int iOff = (char *)pLink - (char *)pPg;
577
danielk197784f786f2007-08-28 08:00:17 +0000578#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
579 assert(pLink==&pPg->free || pLink==&pPg->gfree);
580 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
581#endif
582
danielk19779f61c2f2007-08-27 17:27:49 +0000583 if( pPg==pList->pFirst ){
584 pList->pFirst = pLink->pNext;
585 }
586 if( pPg==pList->pLast ){
587 pList->pLast = pLink->pPrev;
588 }
589 if( pLink->pPrev ){
590 PagerLruLink *pPrevLink = (PagerLruLink *)(&((u8 *)pLink->pPrev)[iOff]);
591 pPrevLink->pNext = pLink->pNext;
592 }
593 if( pLink->pNext ){
594 PagerLruLink *pNextLink = (PagerLruLink *)(&((u8 *)pLink->pNext)[iOff]);
595 pNextLink->pPrev = pLink->pPrev;
596 }
597 if( pPg==pList->pFirstSynced ){
598 PgHdr *p = pLink->pNext;
599 while( p && p->needSync ){
600 PagerLruLink *pL = (PagerLruLink *)(&((u8 *)p)[iOff]);
601 p = pL->pNext;
602 }
603 pList->pFirstSynced = p;
604 }
605
606 pLink->pNext = pLink->pPrev = 0;
607}
608
609/*
danielk197784f786f2007-08-28 08:00:17 +0000610** Add page pPg to the list of free pages for the pager. If
611** memory-management is enabled, also add the page to the global
612** list of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000613*/
614static void lruListAdd(PgHdr *pPg){
615 listAdd(&pPg->pPager->lru, &pPg->free, pPg);
616#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
617 if( !pPg->pPager->memDb ){
618 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
619 listAdd(&sqlite3LruPageList, &pPg->gfree, pPg);
620 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
621 }
622#endif
623}
624
625/*
danielk197784f786f2007-08-28 08:00:17 +0000626** Remove page pPg from the list of free pages for the associated pager.
627** If memory-management is enabled, also remove pPg from the global list
628** of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000629*/
630static void lruListRemove(PgHdr *pPg){
631 listRemove(&pPg->pPager->lru, &pPg->free, pPg);
632#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
633 if( !pPg->pPager->memDb ){
634 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
635 listRemove(&sqlite3LruPageList, &pPg->gfree, pPg);
636 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
637 }
638#endif
639}
640
641/*
danielk197784f786f2007-08-28 08:00:17 +0000642** This function is called just after the needSync flag has been cleared
643** from all pages managed by pPager (usually because the journal file
644** has just been synced). It updates the pPager->lru.pFirstSynced variable
645** and, if memory-management is enabled, the sqlite3LruPageList.pFirstSynced
646** variable also.
danielk19779f61c2f2007-08-27 17:27:49 +0000647*/
648static void lruListSetFirstSynced(Pager *pPager){
649 pPager->lru.pFirstSynced = pPager->lru.pFirst;
650#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
651 if( !pPager->memDb ){
652 PgHdr *p;
653 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
654 for(p=sqlite3LruPageList.pFirst; p && p->needSync; p=p->gfree.pNext);
655 assert(p==pPager->lru.pFirstSynced || p==sqlite3LruPageList.pFirstSynced);
656 sqlite3LruPageList.pFirstSynced = p;
657 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
658 }
659#endif
660}
661
danielk1977f35843b2007-04-07 15:03:17 +0000662/*
663** Return true if page *pPg has already been written to the statement
664** journal (or statement snapshot has been created, if *pPg is part
665** of an in-memory database).
666*/
667static int pageInStatement(PgHdr *pPg){
668 Pager *pPager = pPg->pPager;
669 if( MEMDB ){
670 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
671 }else{
drhf5e7bb52008-02-18 14:47:33 +0000672 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000673 }
674}
drh8ca0c722006-05-07 17:49:38 +0000675
676/*
677** Change the size of the pager hash table to N. N must be a power
678** of two.
679*/
680static void pager_resize_hash_table(Pager *pPager, int N){
681 PgHdr **aHash, *pPg;
682 assert( N>0 && (N&(N-1))==0 );
drheee4c8c2008-02-18 22:24:57 +0000683#ifdef SQLITE_MALLOC_SOFT_LIMIT
684 if( N*sizeof(aHash[0])>SQLITE_MALLOC_SOFT_LIMIT ){
685 N = SQLITE_MALLOC_SOFT_LIMIT/sizeof(aHash[0]);
686 }
687 if( N==pPager->nHash ) return;
688#endif
drhed138fb2007-08-22 22:04:37 +0000689 pagerLeave(pPager);
drh643167f2008-01-22 21:30:53 +0000690 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, pPager->aHash!=0);
drh17435752007-08-16 04:30:38 +0000691 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drh643167f2008-01-22 21:30:53 +0000692 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, 0);
drhed138fb2007-08-22 22:04:37 +0000693 pagerEnter(pPager);
drh8ca0c722006-05-07 17:49:38 +0000694 if( aHash==0 ){
695 /* Failure to rehash is not an error. It is only a performance hit. */
696 return;
697 }
drh17435752007-08-16 04:30:38 +0000698 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000699 pPager->nHash = N;
700 pPager->aHash = aHash;
701 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000702 int h;
703 if( pPg->pgno==0 ){
704 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
705 continue;
706 }
707 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000708 pPg->pNextHash = aHash[h];
709 if( aHash[h] ){
710 aHash[h]->pPrevHash = pPg;
711 }
712 aHash[h] = pPg;
713 pPg->pPrevHash = 0;
714 }
715}
716
drhdd793422001-06-28 01:54:48 +0000717/*
drh34e79ce2004-02-08 06:05:46 +0000718** Read a 32-bit integer from the given file descriptor. Store the integer
719** that is read in *pRes. Return SQLITE_OK if everything worked, or an
720** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000721**
722** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000723*/
danielk197762079062007-08-15 17:08:46 +0000724static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000725 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000726 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000727 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000728 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000729 }
drh94f33312002-08-12 12:29:56 +0000730 return rc;
731}
732
733/*
drh97b57482006-01-10 20:32:32 +0000734** Write a 32-bit integer into a string buffer in big-endian byte order.
735*/
drha3152892007-05-05 11:48:52 +0000736#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000737
738/*
drh34e79ce2004-02-08 06:05:46 +0000739** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
740** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000741*/
danielk197762079062007-08-15 17:08:46 +0000742static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000743 char ac[4];
drh97b57482006-01-10 20:32:32 +0000744 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000745 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000746}
747
drh2554f8b2003-01-22 01:26:44 +0000748/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000749** If file pFd is open, call sqlite3OsUnlock() on it.
750*/
751static int osUnlock(sqlite3_file *pFd, int eLock){
752 if( !pFd->pMethods ){
753 return SQLITE_OK;
754 }
755 return sqlite3OsUnlock(pFd, eLock);
756}
757
758/*
danielk1977c7b60172007-08-22 11:22:03 +0000759** This function determines whether or not the atomic-write optimization
760** can be used with this pager. The optimization can be used if:
761**
762** (a) the value returned by OsDeviceCharacteristics() indicates that
763** a database page may be written atomically, and
764** (b) the value returned by OsSectorSize() is less than or equal
765** to the page size.
766**
767** If the optimization cannot be used, 0 is returned. If it can be used,
768** then the value returned is the size of the journal file when it
769** contains rollback data for exactly one page.
770*/
771#ifdef SQLITE_ENABLE_ATOMIC_WRITE
772static int jrnlBufferSize(Pager *pPager){
773 int dc; /* Device characteristics */
774 int nSector; /* Sector size */
775 int nPage; /* Page size */
776 sqlite3_file *fd = pPager->fd;
777
778 if( fd->pMethods ){
779 dc = sqlite3OsDeviceCharacteristics(fd);
780 nSector = sqlite3OsSectorSize(fd);
781 nPage = pPager->pageSize;
782 }
783
784 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
785 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
786
danielk1977f8940ae2007-08-23 11:07:10 +0000787 if( !fd->pMethods || (dc&(SQLITE_IOCAP_ATOMIC|(nPage>>8))&&nSector<=nPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000788 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
789 }
790 return 0;
791}
792#endif
793
794/*
danielk1977aef0bf62005-12-30 16:28:01 +0000795** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000796** code. The first argument is a pointer to the pager structure, the
797** second the error-code about to be returned by a pager API function.
798** The value returned is a copy of the second argument to this function.
799**
drh4f0ee682007-03-30 20:43:40 +0000800** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000801** the error becomes persistent. Until the persisten error is cleared,
802** subsequent API calls on this Pager will immediately return the same
803** error code.
804**
805** A persistent error indicates that the contents of the pager-cache
806** cannot be trusted. This state can be cleared by completely discarding
807** the contents of the pager-cache. If a transaction was active when
808** the persistent error occured, then the rollback journal may need
809** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000810*/
danielk1977ae72d982007-10-03 08:46:44 +0000811static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000812static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000813 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000814 assert(
815 pPager->errCode==SQLITE_FULL ||
816 pPager->errCode==SQLITE_OK ||
817 (pPager->errCode & 0xff)==SQLITE_IOERR
818 );
danielk1977979f38e2007-03-27 16:19:51 +0000819 if(
drh4ac285a2006-09-15 07:28:50 +0000820 rc2==SQLITE_FULL ||
821 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000822 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000823 ){
824 pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000825 if( pPager->state==PAGER_UNLOCK && pPager->nRef==0 ){
826 /* If the pager is already unlocked, call pager_unlock() now to
827 ** clear the error state and ensure that the pager-cache is
828 ** completely empty.
829 */
830 pager_unlock(pPager);
831 }
danielk1977aef0bf62005-12-30 16:28:01 +0000832 }
833 return rc;
834}
835
drh477731b2007-06-16 03:06:27 +0000836/*
837** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
838** on the cache using a hash function. This is used for testing
839** and debugging only.
840*/
danielk19773c407372005-02-15 02:54:14 +0000841#ifdef SQLITE_CHECK_PAGES
842/*
843** Return a 32-bit hash of the page data for pPage.
844*/
drh477731b2007-06-16 03:06:27 +0000845static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000846 u32 hash = 0;
847 int i;
drh477731b2007-06-16 03:06:27 +0000848 for(i=0; i<nByte; i++){
849 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000850 }
851 return hash;
852}
drh477731b2007-06-16 03:06:27 +0000853static u32 pager_pagehash(PgHdr *pPage){
854 return pager_datahash(pPage->pPager->pageSize,
855 (unsigned char *)PGHDR_TO_DATA(pPage));
856}
danielk19773c407372005-02-15 02:54:14 +0000857
858/*
859** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
860** is defined, and NDEBUG is not defined, an assert() statement checks
861** that the page is either dirty or still matches the calculated page-hash.
862*/
863#define CHECK_PAGE(x) checkPage(x)
864static void checkPage(PgHdr *pPg){
865 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000866 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000867 pPg->pageHash==pager_pagehash(pPg) );
868}
869
870#else
drh8ffa8172007-06-18 17:25:17 +0000871#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000872#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000873#define CHECK_PAGE(x)
874#endif
875
drhed7c8552001-04-11 14:29:21 +0000876/*
danielk197776572402004-06-25 02:38:54 +0000877** When this is called the journal file for pager pPager must be open.
878** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000879** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000880**
danielk197765839c62007-08-30 08:08:17 +0000881** zMaster must point to a buffer of at least nMaster bytes allocated by
882** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
883** enough space to write the master journal name). If the master journal
884** name in the journal is longer than nMaster bytes (including a
885** nul-terminator), then this is handled as if no master journal name
886** were present in the journal.
887**
888** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000889** SQLITE_OK returned.
890*/
danielk197765839c62007-08-30 08:08:17 +0000891static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000892 int rc;
893 u32 len;
drheb206252004-10-01 02:00:31 +0000894 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000895 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000896 int i;
danielk197776572402004-06-25 02:38:54 +0000897 unsigned char aMagic[8]; /* A buffer to hold the magic header */
898
danielk197765839c62007-08-30 08:08:17 +0000899 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000900
drh054889e2005-11-30 03:20:31 +0000901 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000902 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000903
danielk197762079062007-08-15 17:08:46 +0000904 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000905 if( rc!=SQLITE_OK ) return rc;
906
danielk197765839c62007-08-30 08:08:17 +0000907 if( len>=nMaster ){
908 return SQLITE_OK;
909 }
910
danielk197762079062007-08-15 17:08:46 +0000911 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000912 if( rc!=SQLITE_OK ) return rc;
913
danielk197762079062007-08-15 17:08:46 +0000914 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000915 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
916
danielk197765839c62007-08-30 08:08:17 +0000917 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000918 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000919 return rc;
920 }
danielk197765839c62007-08-30 08:08:17 +0000921 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000922
923 /* See if the checksum matches the master journal name */
924 for(i=0; i<len; i++){
danielk197765839c62007-08-30 08:08:17 +0000925 cksum -= zMaster[i];
926 }
danielk19778191bff2004-06-28 04:52:30 +0000927 if( cksum ){
928 /* If the checksum doesn't add up, then one or more of the disk sectors
929 ** containing the master journal filename is corrupted. This means
930 ** definitely roll back, so just return SQLITE_OK and report a (nul)
931 ** master-journal filename.
932 */
danielk197765839c62007-08-30 08:08:17 +0000933 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000934 }
danielk197776572402004-06-25 02:38:54 +0000935
936 return SQLITE_OK;
937}
938
939/*
940** Seek the journal file descriptor to the next sector boundary where a
941** journal header may be read or written. Pager.journalOff is updated with
942** the new seek offset.
943**
944** i.e for a sector size of 512:
945**
946** Input Offset Output Offset
947** ---------------------------------------
948** 0 0
949** 512 512
950** 100 512
951** 2000 2048
952**
953*/
danielk197762079062007-08-15 17:08:46 +0000954static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000955 i64 offset = 0;
956 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000957 if( c ){
958 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
959 }
960 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
961 assert( offset>=c );
962 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
963 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000964}
965
966/*
drhf3a87622008-04-17 14:16:42 +0000967** Write zeros over the header of the journal file. This has the
968** effect of invalidating the journal file and committing the
969** transaction.
970*/
971static int zeroJournalHdr(Pager *pPager){
972 int rc;
973 static const char zeroHdr[28];
974
975 IOTRACE(("JZEROHDR %p\n", pPager))
976 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
drha06ecba2008-04-22 17:15:17 +0000977 if( rc==SQLITE_OK ){
978 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY | pPager->sync_flags);
979 }
drhf3a87622008-04-17 14:16:42 +0000980 return rc;
981}
982
983/*
danielk197776572402004-06-25 02:38:54 +0000984** The journal file must be open when this routine is called. A journal
985** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
986** current location.
987**
988** The format for the journal header is as follows:
989** - 8 bytes: Magic identifying journal format.
990** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
991** - 4 bytes: Random number used for page hash.
992** - 4 bytes: Initial database page count.
993** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000994** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000995**
danielk197767c007b2008-03-20 04:45:49 +0000996** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000997*/
998static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000999 int rc = SQLITE_OK;
1000 char *zHeader = pPager->pTmpSpace;
1001 int nHeader = pPager->pageSize;
1002 int nWrite;
1003
1004 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
1005 nHeader = JOURNAL_HDR_SZ(pPager);
1006 }
danielk197776572402004-06-25 02:38:54 +00001007
danielk19774099f6e2007-03-19 11:25:20 +00001008 if( pPager->stmtHdrOff==0 ){
1009 pPager->stmtHdrOff = pPager->journalOff;
1010 }
1011
danielk197762079062007-08-15 17:08:46 +00001012 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001013 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001014
drh97b57482006-01-10 20:32:32 +00001015 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +00001016
1017 /*
1018 ** Write the nRec Field - the number of page records that follow this
1019 ** journal header. Normally, zero is written to this value at this time.
1020 ** After the records are added to the journal (and the journal synced,
1021 ** if in full-sync mode), the zero is overwritten with the true number
1022 ** of records (see syncJournal()).
1023 **
1024 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
1025 ** reading the journal this value tells SQLite to assume that the
1026 ** rest of the journal file contains valid page records. This assumption
1027 ** is dangerous, as if a failure occured whilst writing to the journal
1028 ** file it may contain some garbage data. There are two scenarios
1029 ** where this risk can be ignored:
1030 **
1031 ** * When the pager is in no-sync mode. Corruption can follow a
1032 ** power failure in this case anyway.
1033 **
1034 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
1035 ** that garbage data is never appended to the journal file.
1036 */
1037 assert(pPager->fd->pMethods||pPager->noSync);
1038 if( (pPager->noSync)
1039 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
1040 ){
1041 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
1042 }else{
1043 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
1044 }
1045
drh97b57482006-01-10 20:32:32 +00001046 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +00001047 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +00001048 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
1049 /* The initial database size */
1050 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
1051 /* The assumed sector size for this process */
1052 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +00001053 if( pPager->journalHdr==0 ){
1054 /* The page size */
1055 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
1056 }
danielk197776572402004-06-25 02:38:54 +00001057
danielk1977a664f8e2008-04-22 14:31:48 +00001058 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
1059 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
1060 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
1061 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +00001062 }
danielk1977a664f8e2008-04-22 14:31:48 +00001063
danielk197776572402004-06-25 02:38:54 +00001064 return rc;
1065}
1066
1067/*
1068** The journal file must be open when this is called. A journal header file
1069** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
1070** file. See comments above function writeJournalHdr() for a description of
1071** the journal header format.
1072**
1073** If the header is read successfully, *nRec is set to the number of
1074** page records following this header and *dbSize is set to the size of the
1075** database before the transaction began, in pages. Also, pPager->cksumInit
1076** is set to the value read from the journal header. SQLITE_OK is returned
1077** in this case.
1078**
1079** If the journal header file appears to be corrupted, SQLITE_DONE is
1080** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
1081** cannot be read from the journal file an error code is returned.
1082*/
1083static int readJournalHdr(
1084 Pager *pPager,
drheb206252004-10-01 02:00:31 +00001085 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +00001086 u32 *pNRec,
1087 u32 *pDbSize
1088){
1089 int rc;
1090 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +00001091 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +00001092 int iPageSize;
danielk197776572402004-06-25 02:38:54 +00001093
danielk197762079062007-08-15 17:08:46 +00001094 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001095 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
1096 return SQLITE_DONE;
1097 }
danielk197762079062007-08-15 17:08:46 +00001098 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001099
danielk197762079062007-08-15 17:08:46 +00001100 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001101 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +00001102 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +00001103
1104 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
1105 return SQLITE_DONE;
1106 }
1107
danielk197762079062007-08-15 17:08:46 +00001108 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +00001109 if( rc ) return rc;
1110
danielk197762079062007-08-15 17:08:46 +00001111 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +00001112 if( rc ) return rc;
1113
danielk197762079062007-08-15 17:08:46 +00001114 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +00001115 if( rc ) return rc;
1116
danielk197767c007b2008-03-20 04:45:49 +00001117 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
1118 if( rc==SQLITE_OK
1119 && iPageSize>=512
1120 && iPageSize<=SQLITE_MAX_PAGE_SIZE
1121 && ((iPageSize-1)&iPageSize)==0
1122 ){
1123 u16 pagesize = iPageSize;
1124 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
1125 }
1126 if( rc ) return rc;
1127
danielk197776572402004-06-25 02:38:54 +00001128 /* Update the assumed sector-size to match the value used by
1129 ** the process that created this journal. If this journal was
1130 ** created by a process other than this one, then this routine
1131 ** is being called from within pager_playback(). The local value
1132 ** of Pager.sectorSize is restored at the end of that routine.
1133 */
danielk197762079062007-08-15 17:08:46 +00001134 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +00001135 if( rc ) return rc;
1136
1137 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +00001138 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +00001139}
1140
1141
1142/*
1143** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +00001144** pPager at the current location. The master journal name must be the last
1145** thing written to a journal file. If the pager is in full-sync mode, the
1146** journal file descriptor is advanced to the next sector boundary before
1147** anything is written. The format is:
1148**
1149** + 4 bytes: PAGER_MJ_PGNO.
1150** + N bytes: length of master journal name.
1151** + 4 bytes: N
1152** + 4 bytes: Master journal name checksum.
1153** + 8 bytes: aJournalMagic[].
1154**
1155** The master journal page checksum is the sum of the bytes in the master
1156** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +00001157**
1158** If zMaster is a NULL pointer (occurs for a single database transaction),
1159** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +00001160*/
1161static int writeMasterJournal(Pager *pPager, const char *zMaster){
1162 int rc;
1163 int len;
danielk1977cafadba2004-06-25 11:11:54 +00001164 int i;
danielk197762079062007-08-15 17:08:46 +00001165 i64 jrnlOff;
drh97b57482006-01-10 20:32:32 +00001166 u32 cksum = 0;
1167 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +00001168
1169 if( !zMaster || pPager->setMaster) return SQLITE_OK;
1170 pPager->setMaster = 1;
1171
1172 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +00001173 for(i=0; i<len; i++){
1174 cksum += zMaster[i];
1175 }
danielk197776572402004-06-25 02:38:54 +00001176
1177 /* If in full-sync mode, advance to the next disk sector before writing
1178 ** the master journal name. This is in case the previous page written to
1179 ** the journal has already been synced.
1180 */
1181 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +00001182 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001183 }
danielk197762079062007-08-15 17:08:46 +00001184 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +00001185 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +00001186
danielk197762079062007-08-15 17:08:46 +00001187 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +00001188 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001189 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +00001190
danielk197762079062007-08-15 17:08:46 +00001191 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001192 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001193 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +00001194
drh97b57482006-01-10 20:32:32 +00001195 put32bits(zBuf, len);
1196 put32bits(&zBuf[4], cksum);
1197 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +00001198 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
drh2c8997b2005-08-27 16:36:48 +00001199 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +00001200 return rc;
1201}
1202
1203/*
drh03eb96a2002-11-10 23:32:56 +00001204** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +00001205** statement journal.
drh03eb96a2002-11-10 23:32:56 +00001206**
1207** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +00001208** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +00001209** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +00001210** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +00001211*/
drh3aac2dd2004-04-26 14:10:20 +00001212static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +00001213 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +00001214 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1215 assert( MEMDB );
1216 if( !pHist->inStmt ){
1217 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
1218 if( pPager->pStmt ){
1219 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
1220 }
1221 pHist->pNextStmt = pPager->pStmt;
1222 pPager->pStmt = pPg;
1223 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +00001224 }
drh03eb96a2002-11-10 23:32:56 +00001225}
1226
1227/*
drhed7c8552001-04-11 14:29:21 +00001228** Find a page in the hash table given its page number. Return
1229** a pointer to the page or NULL if not found.
1230*/
drhd9b02572001-04-15 00:37:09 +00001231static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +00001232 PgHdr *p;
1233 if( pPager->aHash==0 ) return 0;
1234 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +00001235 while( p && p->pgno!=pgno ){
1236 p = p->pNextHash;
1237 }
1238 return p;
1239}
1240
1241/*
danielk1977e180dd92007-04-05 17:15:52 +00001242** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +00001243** sets the state of the pager back to what it was when it was first
1244** opened. Any outstanding pages are invalidated and subsequent attempts
1245** to access those pages will likely result in a coredump.
1246*/
drhd9b02572001-04-15 00:37:09 +00001247static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00001248 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +00001249 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +00001250 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +00001251 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
1252 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +00001253 pNext = pPg->pNextAll;
danielk19779f61c2f2007-08-27 17:27:49 +00001254 lruListRemove(pPg);
drh0d180202008-02-14 23:26:56 +00001255 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00001256 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +00001257 }
danielk19779f61c2f2007-08-27 17:27:49 +00001258 assert(pPager->lru.pFirst==0);
1259 assert(pPager->lru.pFirstSynced==0);
1260 assert(pPager->lru.pLast==0);
danielk1977b94bf852007-03-19 13:53:37 +00001261 pPager->pStmt = 0;
drhd9b02572001-04-15 00:37:09 +00001262 pPager->pAll = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001263 pPager->pDirty = 0;
drh8ca0c722006-05-07 17:49:38 +00001264 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +00001265 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +00001266 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +00001267 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +00001268 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +00001269}
1270
1271/*
danielk1977ae72d982007-10-03 08:46:44 +00001272** Unlock the database file.
1273**
1274** If the pager is currently in error state, discard the contents of
1275** the cache and reset the Pager structure internal state. If there is
1276** an open journal-file, then the next time a shared-lock is obtained
1277** on the pager file (by this or any other process), it will be
1278** treated as a hot-journal and rolled back.
1279*/
1280static void pager_unlock(Pager *pPager){
1281 if( !pPager->exclusiveMode ){
1282 if( !MEMDB ){
drh1aa5af12008-03-07 19:51:14 +00001283 int rc = osUnlock(pPager->fd, NO_LOCK);
drh308aa322008-03-07 20:14:38 +00001284 if( rc ) pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +00001285 pPager->dbSize = -1;
1286 IOTRACE(("UNLOCK %p\n", pPager))
1287
drh16e45a42008-04-19 20:34:18 +00001288 /* Always close the journal file when dropping the database lock.
1289 ** Otherwise, another connection with journal_mode=delete might
1290 ** delete the file out from under us.
1291 */
1292 if( pPager->journalOpen ){
1293 sqlite3OsClose(pPager->jfd);
1294 pPager->journalOpen = 0;
1295 sqlite3BitvecDestroy(pPager->pInJournal);
1296 pPager->pInJournal = 0;
1297 }
1298
danielk1977ae72d982007-10-03 08:46:44 +00001299 /* If Pager.errCode is set, the contents of the pager cache cannot be
1300 ** trusted. Now that the pager file is unlocked, the contents of the
1301 ** cache can be discarded and the error code safely cleared.
1302 */
1303 if( pPager->errCode ){
drh1aa5af12008-03-07 19:51:14 +00001304 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00001305 pager_reset(pPager);
1306 if( pPager->stmtOpen ){
1307 sqlite3OsClose(pPager->stfd);
drhf5e7bb52008-02-18 14:47:33 +00001308 sqlite3BitvecDestroy(pPager->pInStmt);
1309 pPager->pInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001310 }
danielk1977ae72d982007-10-03 08:46:44 +00001311 pPager->stmtOpen = 0;
1312 pPager->stmtInUse = 0;
1313 pPager->journalOff = 0;
1314 pPager->journalStarted = 0;
1315 pPager->stmtAutoopen = 0;
1316 pPager->origDbSize = 0;
1317 }
1318 }
1319
1320 if( !MEMDB || pPager->errCode==SQLITE_OK ){
1321 pPager->state = PAGER_UNLOCK;
1322 pPager->changeCountDone = 0;
1323 }
1324 }
1325}
1326
1327/*
1328** Execute a rollback if a transaction is active and unlock the
1329** database file. If the pager has already entered the error state,
1330** do not attempt the rollback.
1331*/
1332static void pagerUnlockAndRollback(Pager *p){
drhfdc40e92008-04-17 20:59:37 +00001333 /* assert( p->state>=PAGER_RESERVED || p->journalOpen==0 ); */
danielk1977ae72d982007-10-03 08:46:44 +00001334 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
1335 sqlite3PagerRollback(p);
1336 }
1337 pager_unlock(p);
drhfdc40e92008-04-17 20:59:37 +00001338#if 0
danielk1977ae72d982007-10-03 08:46:44 +00001339 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
1340 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drhfdc40e92008-04-17 20:59:37 +00001341#endif
danielk1977ae72d982007-10-03 08:46:44 +00001342}
1343
1344/*
drh80e35f42007-03-30 14:06:34 +00001345** This routine ends a transaction. A transaction is ended by either
1346** a COMMIT or a ROLLBACK.
1347**
drhed7c8552001-04-11 14:29:21 +00001348** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001349** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1350** the database lock and acquires a SHARED lock in its place if that is
1351** the appropriate thing to do. Release locks usually is appropriate,
1352** unless we are in exclusive access mode or unless this is a
1353** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1354**
1355** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001356**
1357** TODO: Consider keeping the journal file open for temporary databases.
1358** This might give a performance improvement on windows where opening
1359** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001360*/
drh80e35f42007-03-30 14:06:34 +00001361static int pager_end_transaction(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001362 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001363 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001364 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001365 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001366 if( pPager->state<PAGER_RESERVED ){
1367 return SQLITE_OK;
1368 }
danielk19773b8a05f2007-03-19 17:44:26 +00001369 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001370 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001371 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001372 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001373 }
drhda47d772002-12-02 04:25:19 +00001374 if( pPager->journalOpen ){
drhfdc40e92008-04-17 20:59:37 +00001375 if( (pPager->exclusiveMode ||
1376 pPager->journalMode==PAGER_JOURNALMODE_PERSIST)
1377 && (rc = zeroJournalHdr(pPager))==SQLITE_OK ){
danielk197741483462007-03-24 16:45:04 +00001378 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001379 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001380 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001381 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001382 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +00001383 if( rc==SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001384 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001385 }
danielk197741483462007-03-24 16:45:04 +00001386 }
drhf5e7bb52008-02-18 14:47:33 +00001387 sqlite3BitvecDestroy(pPager->pInJournal);
1388 pPager->pInJournal = 0;
drhda47d772002-12-02 04:25:19 +00001389 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1390 pPg->inJournal = 0;
1391 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001392 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001393 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001394#ifdef SQLITE_CHECK_PAGES
1395 pPg->pageHash = pager_pagehash(pPg);
1396#endif
drhda47d772002-12-02 04:25:19 +00001397 }
drh605ad8f2006-05-03 23:34:05 +00001398 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001399 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001400 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001401 }else{
drhf5e7bb52008-02-18 14:47:33 +00001402 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001403 }
danielk1977979f38e2007-03-27 16:19:51 +00001404
danielk197741483462007-03-24 16:45:04 +00001405 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001406 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001407 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001408 }else if( pPager->state==PAGER_SYNCED ){
1409 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001410 }
danielk1977334cdb62007-03-26 08:05:12 +00001411 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001412 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001413 pPager->needSync = 0;
danielk19779f61c2f2007-08-27 17:27:49 +00001414 lruListSetFirstSynced(pPager);
drh588f5bc2007-01-02 18:41:54 +00001415 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +00001416
1417 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001418}
1419
drhed7c8552001-04-11 14:29:21 +00001420/*
drh968af522003-02-11 14:55:40 +00001421** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001422**
1423** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001424** random initial value and the page number. We experimented with
1425** a checksum of the entire data, but that was found to be too slow.
1426**
1427** Note that the page number is stored at the beginning of data and
1428** the checksum is stored at the end. This is important. If journal
1429** corruption occurs due to a power failure, the most likely scenario
1430** is that one end or the other of the record will be changed. It is
1431** much less likely that the two ends of the journal record will be
1432** correct and the middle be corrupt. Thus, this "checksum" scheme,
1433** though fast and simple, catches the mostly likely kind of corruption.
1434**
1435** FIX ME: Consider adding every 200th (or so) byte of the data to the
1436** checksum. That way if a single page spans 3 or more disk sectors and
1437** only the middle sector is corrupt, we will still have a reasonable
1438** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001439*/
drh74161702006-02-24 02:53:49 +00001440static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001441 u32 cksum = pPager->cksumInit;
1442 int i = pPager->pageSize-200;
1443 while( i>0 ){
1444 cksum += aData[i];
1445 i -= 200;
1446 }
drh968af522003-02-11 14:55:40 +00001447 return cksum;
1448}
1449
drh605ad8f2006-05-03 23:34:05 +00001450/* Forward declaration */
1451static void makeClean(PgHdr*);
1452
drh968af522003-02-11 14:55:40 +00001453/*
drhfa86c412002-02-02 15:01:15 +00001454** Read a single page from the journal file opened on file descriptor
1455** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001456**
drh726de592004-06-10 23:35:50 +00001457** If useCksum==0 it means this journal does not use checksums. Checksums
1458** are not used in statement journals because statement journals do not
1459** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001460*/
danielk197762079062007-08-15 17:08:46 +00001461static int pager_playback_one_page(
1462 Pager *pPager,
1463 sqlite3_file *jfd,
1464 i64 offset,
1465 int useCksum
1466){
drhfa86c412002-02-02 15:01:15 +00001467 int rc;
drhae2b40c2004-06-09 19:03:54 +00001468 PgHdr *pPg; /* An existing page in the cache */
1469 Pgno pgno; /* The page number of a page in journal */
1470 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001471 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001472
drh96362842005-03-20 22:47:56 +00001473 /* useCksum should be true for the main journal and false for
1474 ** statement journals. Verify that this is always the case
1475 */
drh9cbe6352005-11-29 03:13:21 +00001476 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001477 assert( aData );
drh96362842005-03-20 22:47:56 +00001478
danielk197762079062007-08-15 17:08:46 +00001479 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001480 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001481 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001482 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001483 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001484
drh968af522003-02-11 14:55:40 +00001485 /* Sanity checking on the page. This is more important that I originally
1486 ** thought. If a power failure occurs while the journal is being written,
1487 ** it could cause invalid data to be written into the journal. We need to
1488 ** detect this invalid data (with high probability) and ignore it.
1489 */
danielk197775edc162004-06-26 01:48:18 +00001490 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001491 return SQLITE_DONE;
1492 }
drhae2b40c2004-06-09 19:03:54 +00001493 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001494 return SQLITE_OK;
1495 }
drhae2b40c2004-06-09 19:03:54 +00001496 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001497 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001498 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001499 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001500 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001501 return SQLITE_DONE;
1502 }
1503 }
drhfa86c412002-02-02 15:01:15 +00001504
danielk1977aa5ccdf2004-06-14 05:10:42 +00001505 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001506
1507 /* If the pager is in RESERVED state, then there must be a copy of this
1508 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001509 ** not the database file. The page is left marked dirty in this case.
1510 **
danielk19772df71c72007-05-24 07:22:42 +00001511 ** An exception to the above rule: If the database is in no-sync mode
1512 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001513 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1514 ** during a Movepage() call, then the page may not be in the cache
1515 ** either. So the condition described in the above paragraph is not
1516 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001517 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001518 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1519 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001520 **
1521 ** Ticket #1171: The statement journal might contain page content that is
1522 ** different from the page content at the start of the transaction.
1523 ** This occurs when a page is changed prior to the start of a statement
1524 ** then changed again within the statement. When rolling back such a
1525 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001526 ** for certain that original page contents are synced into the main rollback
1527 ** journal. Otherwise, a power loss might leave modified data in the
1528 ** database file without an entry in the rollback journal that can
1529 ** restore the database to its original form. Two conditions must be
1530 ** met before writing to the database files. (1) the database must be
1531 ** locked. (2) we know that the original page content is fully synced
1532 ** in the main journal either because the page is not in cache or else
1533 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001534 **
1535 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1536 ** is possible to fail a statement on a database that does not yet exist.
1537 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001538 */
drhae2b40c2004-06-09 19:03:54 +00001539 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001540 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1541 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh4c02a232008-04-14 23:13:45 +00001542 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0)
1543 && pPager->fd->pMethods ){
danielk197762079062007-08-15 17:08:46 +00001544 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1545 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001546 if( pPg ){
1547 makeClean(pPg);
1548 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001549 }
drhfa86c412002-02-02 15:01:15 +00001550 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001551 /* No page should ever be explicitly rolled back that is in use, except
1552 ** for page 1 which is held in use in order to keep the lock on the
1553 ** database active. However such a page may be rolled back as a result
1554 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001555 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001556 */
drhb6f41482004-05-14 01:58:11 +00001557 void *pData;
danielk197728129562005-01-11 10:25:06 +00001558 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001559 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001560 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001561 if( pPager->xReiniter ){
1562 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001563 }
danielk19773c407372005-02-15 02:54:14 +00001564#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001565 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001566#endif
drh86a88112007-04-16 15:02:19 +00001567 /* If this was page 1, then restore the value of Pager.dbFileVers.
1568 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001569 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001570 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001571 }
drh86a88112007-04-16 15:02:19 +00001572
1573 /* Decode the page just read from disk */
1574 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001575 }
1576 return rc;
1577}
1578
1579/*
danielk197713adf8a2004-06-03 16:08:41 +00001580** Parameter zMaster is the name of a master journal file. A single journal
1581** file that referred to the master journal file has just been rolled back.
1582** This routine checks if it is possible to delete the master journal file,
1583** and does so if it is.
drh726de592004-06-10 23:35:50 +00001584**
danielk197765839c62007-08-30 08:08:17 +00001585** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1586** available for use within this function.
1587**
1588**
drh726de592004-06-10 23:35:50 +00001589** The master journal file contains the names of all child journals.
1590** To tell if a master journal can be deleted, check to each of the
1591** children. If all children are either missing or do not refer to
1592** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001593*/
danielk1977b4b47412007-08-17 15:53:36 +00001594static int pager_delmaster(Pager *pPager, const char *zMaster){
1595 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001596 int rc;
1597 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001598 sqlite3_file *pMaster;
1599 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001600 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001601 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001602
1603 /* Open the master journal file exclusively in case some other process
1604 ** is running this routine also. Not that it makes too much difference.
1605 */
danielk1977b4b47412007-08-17 15:53:36 +00001606 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001607 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001608 if( !pMaster ){
1609 rc = SQLITE_NOMEM;
1610 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001611 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1612 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001613 }
danielk197713adf8a2004-06-03 16:08:41 +00001614 if( rc!=SQLITE_OK ) goto delmaster_out;
1615 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001616
1617 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001618 if( rc!=SQLITE_OK ) goto delmaster_out;
1619
1620 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001621 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001622 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001623 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001624
1625 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001626 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001627 */
danielk197765839c62007-08-30 08:08:17 +00001628 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001629 if( !zMasterJournal ){
1630 rc = SQLITE_NOMEM;
1631 goto delmaster_out;
1632 }
danielk197765839c62007-08-30 08:08:17 +00001633 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001634 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001635 if( rc!=SQLITE_OK ) goto delmaster_out;
1636
danielk19775865e3d2004-06-14 06:03:57 +00001637 zJournal = zMasterJournal;
1638 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh19db9352008-03-27 22:42:51 +00001639 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS);
1640 if( rc!=0 && rc!=1 ){
1641 rc = SQLITE_IOERR_NOMEM;
1642 goto delmaster_out;
1643 }
1644 if( rc==1 ){
danielk197713adf8a2004-06-03 16:08:41 +00001645 /* One of the journals pointed to by the master journal exists.
1646 ** Open it and check if it points at the master journal. If
1647 ** so, return without deleting the master journal file.
1648 */
drh3b7b78b2004-11-24 01:16:43 +00001649 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001650 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1651 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001652 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001653 goto delmaster_out;
1654 }
danielk197713adf8a2004-06-03 16:08:41 +00001655
danielk197765839c62007-08-30 08:08:17 +00001656 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001657 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001658 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001659 goto delmaster_out;
1660 }
danielk197776572402004-06-25 02:38:54 +00001661
danielk197765839c62007-08-30 08:08:17 +00001662 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001663 if( c ){
danielk197776572402004-06-25 02:38:54 +00001664 /* We have a match. Do not delete the master journal file. */
1665 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001666 }
1667 }
danielk19775865e3d2004-06-14 06:03:57 +00001668 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001669 }
1670 }
1671
danielk1977fee2d252007-08-18 10:59:19 +00001672 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001673
1674delmaster_out:
1675 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001676 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001677 }
1678 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001679 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001680 }
danielk1977b4b47412007-08-17 15:53:36 +00001681 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001682 return rc;
1683}
1684
drha6abd042004-06-09 17:37:22 +00001685
danielk1977e180dd92007-04-05 17:15:52 +00001686static void pager_truncate_cache(Pager *pPager);
1687
drha6abd042004-06-09 17:37:22 +00001688/*
drhcb4c40b2004-08-18 19:09:43 +00001689** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001690** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001691**
1692** Might might be the case that the file on disk is smaller than nPage.
1693** This can happen, for example, if we are in the middle of a transaction
1694** which has extended the file size and the new pages are still all held
1695** in cache, then an INSERT or UPDATE does a statement rollback. Some
1696** operating system implementations can get confused if you try to
1697** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001698** so detect this case and write a single zero byte to the end of the new
1699** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001700*/
1701static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001702 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001703 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001704 i64 currentSize, newSize;
1705 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1706 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001707 if( rc==SQLITE_OK && currentSize!=newSize ){
1708 if( currentSize>newSize ){
1709 rc = sqlite3OsTruncate(pPager->fd, newSize);
1710 }else{
1711 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1712 }
drh7fe3f7e2007-11-29 18:44:27 +00001713 }
danielk1977e180dd92007-04-05 17:15:52 +00001714 }
1715 if( rc==SQLITE_OK ){
1716 pPager->dbSize = nPage;
1717 pager_truncate_cache(pPager);
1718 }
1719 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001720}
1721
1722/*
drhc80f0582007-05-01 16:59:48 +00001723** Set the sectorSize for the given pager.
1724**
drh334c80d2008-03-28 17:41:13 +00001725** The sector size is at least as big as the sector size reported
1726** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001727*/
1728static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001729 assert(pPager->fd->pMethods||pPager->tempFile);
1730 if( !pPager->tempFile ){
1731 /* Sector size doesn't matter for temporary files. Also, the file
1732 ** may not have been opened yet, in whcih case the OsSectorSize()
1733 ** call will segfault.
1734 */
1735 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1736 }
drh334c80d2008-03-28 17:41:13 +00001737 if( pPager->sectorSize<512 ){
1738 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001739 }
1740}
1741
1742/*
drhed7c8552001-04-11 14:29:21 +00001743** Playback the journal and thus restore the database file to
1744** the state it was in before we started making changes.
1745**
drh34e79ce2004-02-08 06:05:46 +00001746** The journal file format is as follows:
1747**
drhae2b40c2004-06-09 19:03:54 +00001748** (1) 8 byte prefix. A copy of aJournalMagic[].
1749** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001750** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001751** number of page records from the journal size.
1752** (3) 4 byte big-endian integer which is the initial value for the
1753** sanity checksum.
1754** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001755** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001756** (5) 4 byte big-endian integer which is the sector size. The header
1757** is this many bytes in size.
1758** (6) 4 byte big-endian integer which is the page case.
1759** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001760** name. The value may be zero (indicate that there is no master
1761** journal.)
drh334c80d2008-03-28 17:41:13 +00001762** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001763** and might be shorter than the value read from (5). If the first byte
1764** of the name is \000 then there is no master journal. The master
1765** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001766** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001767** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001768** + pPager->pageSize bytes of data.
1769** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001770**
drh334c80d2008-03-28 17:41:13 +00001771** When we speak of the journal header, we mean the first 8 items above.
1772** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001773**
1774** Call the value from the second bullet "nRec". nRec is the number of
1775** valid page entries in the journal. In most cases, you can compute the
1776** value of nRec from the size of the journal file. But if a power
1777** failure occurred while the journal was being written, it could be the
1778** case that the size of the journal file had already been increased but
1779** the extra entries had not yet made it safely to disk. In such a case,
1780** the value of nRec computed from the file size would be too large. For
1781** that reason, we always use the nRec value in the header.
1782**
1783** If the nRec value is 0xffffffff it means that nRec should be computed
1784** from the file size. This value is used when the user selects the
1785** no-sync option for the journal. A power failure could lead to corruption
1786** in this case. But for things like temporary table (which will be
1787** deleted when the power is restored) we don't care.
1788**
drhd9b02572001-04-15 00:37:09 +00001789** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001790** journal file then all pages up to the first corrupted page are rolled
1791** back (or no pages if the journal header is corrupted). The journal file
1792** is then deleted and SQLITE_OK returned, just as if no corruption had
1793** been encountered.
1794**
1795** If an I/O or malloc() error occurs, the journal-file is not deleted
1796** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001797*/
danielk1977e277be02007-03-23 18:12:06 +00001798static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001799 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001800 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001801 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001802 int i; /* Loop counter */
1803 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001804 int rc; /* Result code of a subroutine */
danielk1977ce98bba2008-04-03 10:13:01 +00001805 int res = 0; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001806 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001807
drhc3a64ba2001-11-22 00:01:27 +00001808 /* Figure out how many records are in the journal. Abort early if
1809 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001810 */
drh8cfbf082001-09-19 13:22:39 +00001811 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001812 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001813 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001814 goto end_playback;
1815 }
drh240c5792004-02-08 00:40:52 +00001816
danielk197776572402004-06-25 02:38:54 +00001817 /* Read the master journal name from the journal, if it is present.
1818 ** If a master journal file name is specified, but the file is not
1819 ** present on disk, then the journal is not hot and does not need to be
1820 ** played back.
drh240c5792004-02-08 00:40:52 +00001821 */
danielk197765839c62007-08-30 08:08:17 +00001822 zMaster = pPager->pTmpSpace;
1823 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977ce98bba2008-04-03 10:13:01 +00001824 if( rc!=SQLITE_OK || (zMaster[0]
1825 && (res=sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS))==0 )
danielk1977b4b47412007-08-17 15:53:36 +00001826 ){
danielk197776572402004-06-25 02:38:54 +00001827 zMaster = 0;
drhc3a64ba2001-11-22 00:01:27 +00001828 goto end_playback;
1829 }
danielk197765839c62007-08-30 08:08:17 +00001830 zMaster = 0;
danielk1977ce98bba2008-04-03 10:13:01 +00001831 if( res<0 ){
1832 rc = SQLITE_IOERR_NOMEM;
1833 goto end_playback;
1834 }
1835 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001836
danielk197776572402004-06-25 02:38:54 +00001837 /* This loop terminates either when the readJournalHdr() call returns
1838 ** SQLITE_DONE or an IO error occurs. */
1839 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001840
danielk197776572402004-06-25 02:38:54 +00001841 /* Read the next journal header from the journal file. If there are
1842 ** not enough bytes left in the journal file for a complete header, or
1843 ** it is corrupted, then a process must of failed while writing it.
1844 ** This indicates nothing more needs to be rolled back.
1845 */
1846 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1847 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001848 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001849 rc = SQLITE_OK;
1850 }
danielk197776572402004-06-25 02:38:54 +00001851 goto end_playback;
1852 }
1853
1854 /* If nRec is 0xffffffff, then this journal was created by a process
1855 ** working in no-sync mode. This means that the rest of the journal
1856 ** file consists of pages, there are no more journal headers. Compute
1857 ** the value of nRec based on this assumption.
1858 */
1859 if( nRec==0xffffffff ){
1860 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1861 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1862 }
1863
danielk1977e277be02007-03-23 18:12:06 +00001864 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001865 ** process and if this is the final header in the journal, then it means
1866 ** that this part of the journal was being filled but has not yet been
1867 ** synced to disk. Compute the number of pages based on the remaining
1868 ** size of the file.
1869 **
1870 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001871 */
drh8940f4e2007-08-11 00:26:20 +00001872 if( nRec==0 && !isHot &&
1873 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001874 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1875 }
1876
danielk197776572402004-06-25 02:38:54 +00001877 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001878 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001879 */
danielk1977e180dd92007-04-05 17:15:52 +00001880 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001881 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001882 if( rc!=SQLITE_OK ){
1883 goto end_playback;
1884 }
danielk197776572402004-06-25 02:38:54 +00001885 }
1886
danielk197776572402004-06-25 02:38:54 +00001887 /* Copy original pages out of the journal and back into the database file.
1888 */
1889 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001890 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001891 if( rc!=SQLITE_OK ){
1892 if( rc==SQLITE_DONE ){
1893 rc = SQLITE_OK;
1894 pPager->journalOff = szJ;
1895 break;
1896 }else{
1897 goto end_playback;
1898 }
1899 }
drh968af522003-02-11 14:55:40 +00001900 }
drhed7c8552001-04-11 14:29:21 +00001901 }
drh580eeaf2006-02-24 03:09:37 +00001902 /*NOTREACHED*/
1903 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001904
1905end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001906 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001907 zMaster = pPager->pTmpSpace;
1908 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1909 }
1910 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001911 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001912 }
danielk197765839c62007-08-30 08:08:17 +00001913 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001914 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001915 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001916 */
danielk197765839c62007-08-30 08:08:17 +00001917 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001918 }
danielk197776572402004-06-25 02:38:54 +00001919
1920 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001921 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001922 ** value. Reset it to the correct value for this process.
1923 */
drhc80f0582007-05-01 16:59:48 +00001924 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001925 return rc;
drhed7c8552001-04-11 14:29:21 +00001926}
1927
1928/*
drhac69b052004-05-12 13:30:07 +00001929** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001930**
1931** This is similar to playing back the transaction journal but with
1932** a few extra twists.
1933**
drh663fc632002-02-02 18:49:19 +00001934** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001935** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001936** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001937**
drhac69b052004-05-12 13:30:07 +00001938** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001939** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001940** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001941*/
drh3aac2dd2004-04-26 14:10:20 +00001942static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001943 i64 szJ; /* Size of the full journal */
1944 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001945 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001946 int i; /* Loop counter */
1947 int rc;
1948
danielk197776572402004-06-25 02:38:54 +00001949 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001950
danielk19774099f6e2007-03-19 11:25:20 +00001951 /* Set hdrOff to be the offset just after the end of the last journal
1952 ** page written before the first journal-header for this statement
1953 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001954 ** header was written.
1955 */
1956 hdrOff = pPager->stmtHdrOff;
1957 assert( pPager->fullSync || !hdrOff );
1958 if( !hdrOff ){
1959 hdrOff = szJ;
1960 }
1961
drhfa86c412002-02-02 15:01:15 +00001962 /* Truncate the database back to its original size.
1963 */
danielk1977e180dd92007-04-05 17:15:52 +00001964 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001965 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001966
drhac69b052004-05-12 13:30:07 +00001967 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001968 */
drhac69b052004-05-12 13:30:07 +00001969 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001970 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001971
drhac69b052004-05-12 13:30:07 +00001972 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001973 ** database file. Note that the statement journal omits checksums from
1974 ** each record since power-failure recovery is not important to statement
1975 ** journals.
drhfa86c412002-02-02 15:01:15 +00001976 */
danielk197762079062007-08-15 17:08:46 +00001977 for(i=0; i<nRec; i++){
1978 i64 offset = i*(4+pPager->pageSize);
1979 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001980 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001981 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001982 }
1983
danielk197776572402004-06-25 02:38:54 +00001984 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1985 ** was the size of the journal file when this statement was started, so
1986 ** everything after that needs to be rolled back, either into the
1987 ** database, the memory cache, or both.
1988 **
1989 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1990 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001991 */
danielk197776572402004-06-25 02:38:54 +00001992 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001993 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001994 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001995 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001996 assert( rc!=SQLITE_DONE );
1997 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1998 }
1999
2000 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00002001 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00002002 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00002003 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00002004 if( rc!=SQLITE_OK ){
2005 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00002006 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00002007 }
danielk1977f0113002006-01-24 12:09:17 +00002008 if( nJRec==0 ){
2009 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00002010 }
danielk1977f0113002006-01-24 12:09:17 +00002011 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00002012 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00002013 assert( rc!=SQLITE_DONE );
2014 if( rc!=SQLITE_OK ) goto end_stmt_playback;
2015 }
drhfa86c412002-02-02 15:01:15 +00002016 }
danielk197776572402004-06-25 02:38:54 +00002017
2018 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00002019
drh3aac2dd2004-04-26 14:10:20 +00002020end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00002021 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00002022 pPager->journalOff = szJ;
2023 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00002024 }
2025 return rc;
2026}
2027
2028/*
drhf57b14a2001-09-14 18:54:08 +00002029** Change the maximum number of in-memory pages that are allowed.
2030*/
danielk19773b8a05f2007-03-19 17:44:26 +00002031void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00002032 if( mxPage>10 ){
2033 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00002034 }else{
2035 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00002036 }
2037}
2038
2039/*
drh973b6e32003-02-12 14:09:42 +00002040** Adjust the robustness of the database to damage due to OS crashes
2041** or power failures by changing the number of syncs()s when writing
2042** the rollback journal. There are three levels:
2043**
drh054889e2005-11-30 03:20:31 +00002044** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00002045** for temporary and transient files.
2046**
2047** NORMAL The journal is synced once before writes begin on the
2048** database. This is normally adequate protection, but
2049** it is theoretically possible, though very unlikely,
2050** that an inopertune power failure could leave the journal
2051** in a state which would cause damage to the database
2052** when it is rolled back.
2053**
2054** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00002055** database (with some additional information - the nRec field
2056** of the journal header - being written in between the two
2057** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00002058** single disk sector is atomic, then this mode provides
2059** assurance that the journal will not be corrupted to the
2060** point of causing damage to the database during rollback.
2061**
2062** Numeric values associated with these states are OFF==1, NORMAL=2,
2063** and FULL=3.
2064*/
danielk197793758c82005-01-21 08:13:14 +00002065#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00002066void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00002067 pPager->noSync = level==1 || pPager->tempFile;
2068 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00002069 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00002070 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00002071}
danielk197793758c82005-01-21 08:13:14 +00002072#endif
drh973b6e32003-02-12 14:09:42 +00002073
2074/*
drhaf6df112005-06-07 02:12:30 +00002075** The following global variable is incremented whenever the library
2076** attempts to open a temporary file. This information is used for
2077** testing and analysis only.
2078*/
drh0f7eb612006-08-08 13:51:43 +00002079#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002080int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00002081#endif
drhaf6df112005-06-07 02:12:30 +00002082
2083/*
drh3f56e6e2007-03-15 01:16:47 +00002084** Open a temporary file.
2085**
2086** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00002087** other error code if we fail. The OS will automatically delete the temporary
2088** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00002089*/
danielk1977b4b47412007-08-17 15:53:36 +00002090static int sqlite3PagerOpentemp(
drh33f4e022007-09-03 15:19:34 +00002091 sqlite3_vfs *pVfs, /* The virtual file system layer */
2092 sqlite3_file *pFile, /* Write the file descriptor here */
2093 char *zFilename, /* Name of the file. Might be NULL */
2094 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00002095){
drhfa86c412002-02-02 15:01:15 +00002096 int rc;
drh334b2992007-09-06 23:28:23 +00002097 assert( zFilename!=0 );
drh3f56e6e2007-03-15 01:16:47 +00002098
drh0f7eb612006-08-08 13:51:43 +00002099#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002100 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00002101#endif
danielk1977b4b47412007-08-17 15:53:36 +00002102
drh33f4e022007-09-03 15:19:34 +00002103 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
2104 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
2105 rc = sqlite3OsOpen(pVfs, zFilename, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00002106 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00002107 return rc;
2108}
2109
2110/*
drhed7c8552001-04-11 14:29:21 +00002111** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00002112** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00002113** the first call to sqlite3PagerGet() and is only held open until the
2114** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00002115**
drh6446c4d2001-12-15 14:22:18 +00002116** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00002117** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00002118** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00002119**
2120** If zFilename is ":memory:" then all information is held in cache.
2121** It is never written to disk. This can be used to implement an
2122** in-memory database.
drhed7c8552001-04-11 14:29:21 +00002123*/
danielk19773b8a05f2007-03-19 17:44:26 +00002124int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00002125 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00002126 Pager **ppPager, /* Return the Pager structure here */
2127 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00002128 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00002129 int flags, /* flags controlling this file */
2130 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00002131){
danielk1977b4b47412007-08-17 15:53:36 +00002132 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00002133 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00002134 int rc = SQLITE_OK;
2135 int i;
danielk19778def5ea2004-06-16 10:39:52 +00002136 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00002137 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00002138 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00002139 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
2140 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00002141 int journalFileSize = sqlite3JournalSize(pVfs);
drh1cc8c442007-08-24 16:08:29 +00002142 int nDefaultPage = SQLITE_DEFAULT_PAGE_SIZE;
2143 char *zPathname;
2144 int nPathname;
drh99b90c32008-03-17 13:50:58 +00002145 char *zStmtJrnl;
2146 int nStmtJrnl;
danielk1977b4b47412007-08-17 15:53:36 +00002147
drh86f8c192007-08-22 00:39:19 +00002148 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00002149 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002150
drh1cc8c442007-08-24 16:08:29 +00002151 /* Compute the full pathname */
danielk1977adfb9b02007-09-17 07:02:56 +00002152 nPathname = pVfs->mxPathname+1;
drh99b90c32008-03-17 13:50:58 +00002153 zPathname = sqlite3_malloc(nPathname*2);
drh1cc8c442007-08-24 16:08:29 +00002154 if( zPathname==0 ){
2155 return SQLITE_NOMEM;
2156 }
2157 if( zFilename && zFilename[0] ){
2158#ifndef SQLITE_OMIT_MEMORYDB
2159 if( strcmp(zFilename,":memory:")==0 ){
2160 memDb = 1;
2161 zPathname[0] = 0;
2162 }else
2163#endif
2164 {
danielk1977adfb9b02007-09-17 07:02:56 +00002165 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00002166 }
2167 }else{
danielk1977adfb9b02007-09-17 07:02:56 +00002168 rc = sqlite3OsGetTempname(pVfs, nPathname, zPathname);
drhae28c012007-08-24 16:29:23 +00002169 }
2170 if( rc!=SQLITE_OK ){
2171 sqlite3_free(zPathname);
2172 return rc;
drh1cc8c442007-08-24 16:08:29 +00002173 }
2174 nPathname = strlen(zPathname);
2175
drh99b90c32008-03-17 13:50:58 +00002176 /* Put the statement journal in temporary disk space since this is
2177 ** sometimes RAM disk or other optimized storage. Unlikely the main
2178 ** main journal file, the statement journal does not need to be
2179 ** colocated with the database nor does it need to be persistent.
2180 */
2181 zStmtJrnl = &zPathname[nPathname+1];
2182 rc = sqlite3OsGetTempname(pVfs, pVfs->mxPathname+1, zStmtJrnl);
2183 if( rc!=SQLITE_OK ){
2184 sqlite3_free(zPathname);
2185 return rc;
2186 }
2187 nStmtJrnl = strlen(zStmtJrnl);
2188
danielk1977b4b47412007-08-17 15:53:36 +00002189 /* Allocate memory for the pager structure */
2190 pPager = sqlite3MallocZero(
2191 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00002192 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00002193 pVfs->szOsFile * 3 + /* The main db and two journal files */
drh99b90c32008-03-17 13:50:58 +00002194 3*nPathname + 40 + /* zFilename, zDirectory, zJournal */
2195 nStmtJrnl /* zStmtJrnl */
danielk1977b4b47412007-08-17 15:53:36 +00002196 );
2197 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00002198 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002199 return SQLITE_NOMEM;
2200 }
2201 pPtr = (u8 *)&pPager[1];
drh33f4e022007-09-03 15:19:34 +00002202 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00002203 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00002204 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
2205 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
2206 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00002207 pPager->zDirectory = &pPager->zFilename[nPathname+1];
2208 pPager->zJournal = &pPager->zDirectory[nPathname+1];
drh334b2992007-09-06 23:28:23 +00002209 pPager->zStmtJrnl = &pPager->zJournal[nPathname+10];
danielk1977b4b47412007-08-17 15:53:36 +00002210 pPager->pVfs = pVfs;
drh1cc8c442007-08-24 16:08:29 +00002211 memcpy(pPager->zFilename, zPathname, nPathname+1);
drh99b90c32008-03-17 13:50:58 +00002212 memcpy(pPager->zStmtJrnl, zStmtJrnl, nStmtJrnl+1);
drh1cc8c442007-08-24 16:08:29 +00002213 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002214
drh153c62c2007-08-24 03:51:33 +00002215 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00002216 */
drhae28c012007-08-24 16:29:23 +00002217 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00002218 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
2219 rc = SQLITE_CANTOPEN;
2220 }else{
drh1cc8c442007-08-24 16:08:29 +00002221 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00002222 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
2223 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00002224 readOnly = (fout&SQLITE_OPEN_READONLY);
2225
2226 /* If the file was successfully opened for read/write access,
2227 ** choose a default page size in case we have to create the
2228 ** database file. The default page size is the maximum of:
2229 **
2230 ** + SQLITE_DEFAULT_PAGE_SIZE,
2231 ** + The value returned by sqlite3OsSectorSize()
2232 ** + The largest page size that can be written atomically.
2233 */
2234 if( rc==SQLITE_OK && !readOnly ){
2235 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
2236 if( nDefaultPage<iSectorSize ){
2237 nDefaultPage = iSectorSize;
2238 }
danielk19779663b8f2007-08-24 11:52:28 +00002239#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00002240 {
2241 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
2242 int ii;
2243 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
2244 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
2245 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
2246 for(ii=nDefaultPage; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
2247 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) nDefaultPage = ii;
danielk19779663b8f2007-08-24 11:52:28 +00002248 }
danielk1977b4b47412007-08-17 15:53:36 +00002249 }
drh1cc8c442007-08-24 16:08:29 +00002250#endif
2251 if( nDefaultPage>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
2252 nDefaultPage = SQLITE_MAX_DEFAULT_PAGE_SIZE;
2253 }
danielk19778def5ea2004-06-16 10:39:52 +00002254 }
drhac69b052004-05-12 13:30:07 +00002255 }
drh1cc8c442007-08-24 16:08:29 +00002256 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002257 /* If a temporary file is requested, it is not opened immediately.
2258 ** In this case we accept the default page size and delay actually
2259 ** opening the file until the first call to OsWrite().
2260 */
danielk19777a2b1ee2007-08-21 14:27:01 +00002261 tempFile = 1;
2262 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00002263 }
danielk1977aef0bf62005-12-30 16:28:01 +00002264
danielk1977b4b47412007-08-17 15:53:36 +00002265 if( pPager && rc==SQLITE_OK ){
drhbf8a4342008-04-29 15:38:58 +00002266 pPager->pTmpSpace = sqlite3MallocZero(nDefaultPage);
drh3e7a6092002-12-07 21:45:14 +00002267 }
danielk1977aef0bf62005-12-30 16:28:01 +00002268
drh153c62c2007-08-24 03:51:33 +00002269 /* If an error occured in either of the blocks above.
2270 ** Free the Pager structure and close the file.
2271 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00002272 ** any Pager.errMask variables.
2273 */
danielk1977b4b47412007-08-17 15:53:36 +00002274 if( !pPager || !pPager->pTmpSpace ){
2275 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00002276 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00002277 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00002278 }
danielk1977aef0bf62005-12-30 16:28:01 +00002279
drh153c62c2007-08-24 03:51:33 +00002280 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
2281 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00002282
danielk1977b4b47412007-08-17 15:53:36 +00002283 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00002284 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00002285 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00002286 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002287
drh99b90c32008-03-17 13:50:58 +00002288 /* Fill in Pager.zJournal[] */
drh1cc8c442007-08-24 16:08:29 +00002289 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
2290 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
danielk1977b4b47412007-08-17 15:53:36 +00002291
drh3b59a5c2006-01-15 20:28:28 +00002292 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00002293 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00002294 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002295 /* pPager->stmtOpen = 0; */
2296 /* pPager->stmtInUse = 0; */
2297 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00002298 pPager->dbSize = memDb-1;
danielk19779663b8f2007-08-24 11:52:28 +00002299 pPager->pageSize = nDefaultPage;
drh3b59a5c2006-01-15 20:28:28 +00002300 /* pPager->stmtSize = 0; */
2301 /* pPager->stmtJSize = 0; */
2302 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002303 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002304 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002305 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002306 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002307 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00002308 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00002309 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2310 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2311 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
2312 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00002313 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00002314 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002315 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00002316 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00002317 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00002318 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002319 /* pPager->pFirst = 0; */
2320 /* pPager->pFirstSynced = 0; */
2321 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00002322 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk19777a2b1ee2007-08-21 14:27:01 +00002323 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00002324 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00002325 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00002326 }
drh3b59a5c2006-01-15 20:28:28 +00002327 /* pPager->pBusyHandler = 0; */
2328 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002329 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00002330#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002331 pPager->iInUseMM = 0;
2332 pPager->iInUseDB = 0;
2333 if( !memDb ){
drh26e4a8b2008-05-01 17:16:52 +00002334#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +00002335 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00002336#endif
drh86f8c192007-08-22 00:39:19 +00002337 sqlite3_mutex_enter(mutex);
2338 pPager->pNext = sqlite3PagerList;
2339 if( sqlite3PagerList ){
2340 assert( sqlite3PagerList->pPrev==0 );
2341 sqlite3PagerList->pPrev = pPager;
2342 }
2343 pPager->pPrev = 0;
2344 sqlite3PagerList = pPager;
2345 sqlite3_mutex_leave(mutex);
2346 }
danielk197752622822006-01-09 09:59:49 +00002347#endif
drhed7c8552001-04-11 14:29:21 +00002348 return SQLITE_OK;
2349}
2350
2351/*
drh90f5ecb2004-07-22 01:19:35 +00002352** Set the busy handler function.
2353*/
danielk19773b8a05f2007-03-19 17:44:26 +00002354void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002355 pPager->pBusyHandler = pBusyHandler;
2356}
2357
2358/*
drh72f82862001-05-24 21:06:34 +00002359** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002360** when the reference count on each page reaches zero. The destructor can
2361** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002362**
danielk19773b8a05f2007-03-19 17:44:26 +00002363** The destructor is not called as a result sqlite3PagerClose().
2364** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002365*/
danielk19773b8a05f2007-03-19 17:44:26 +00002366void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002367 pPager->xDestructor = xDesc;
2368}
2369
2370/*
drha6abd042004-06-09 17:37:22 +00002371** Set the reinitializer for this pager. If not NULL, the reinitializer
2372** is called when the content of a page in cache is restored to its original
2373** value as a result of a rollback. The callback gives higher-level code
2374** an opportunity to restore the EXTRA section to agree with the restored
2375** page data.
2376*/
danielk19773b8a05f2007-03-19 17:44:26 +00002377void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002378 pPager->xReiniter = xReinit;
2379}
2380
2381/*
danielk1977a1644fd2007-08-29 12:31:25 +00002382** Set the page size to *pPageSize. If the suggest new page size is
2383** inappropriate, then an alternative page size is set to that
2384** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002385*/
danielk1977a1644fd2007-08-29 12:31:25 +00002386int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
2387 int rc = SQLITE_OK;
2388 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00002389 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00002390 if( pageSize && pageSize!=pPager->pageSize
2391 && !pPager->memDb && pPager->nRef==0
2392 ){
2393 char *pNew = (char *)sqlite3_malloc(pageSize);
2394 if( !pNew ){
2395 rc = SQLITE_NOMEM;
2396 }else{
2397 pagerEnter(pPager);
2398 pager_reset(pPager);
2399 pPager->pageSize = pageSize;
2400 setSectorSize(pPager);
2401 sqlite3_free(pPager->pTmpSpace);
2402 pPager->pTmpSpace = pNew;
2403 pagerLeave(pPager);
2404 }
drh1c7880e2005-05-20 20:01:55 +00002405 }
danielk1977a1644fd2007-08-29 12:31:25 +00002406 *pPageSize = pPager->pageSize;
2407 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002408}
2409
2410/*
drh26b79942007-11-28 16:19:56 +00002411** Return a pointer to the "temporary page" buffer held internally
2412** by the pager. This is a buffer that is big enough to hold the
2413** entire content of a database page. This buffer is used internally
2414** during rollback and will be overwritten whenever a rollback
2415** occurs. But other modules are free to use it too, as long as
2416** no rollbacks are happening.
2417*/
2418void *sqlite3PagerTempSpace(Pager *pPager){
2419 return pPager->pTmpSpace;
2420}
2421
2422/*
drhf8e632b2007-05-08 14:51:36 +00002423** Attempt to set the maximum database page count if mxPage is positive.
2424** Make no changes if mxPage is zero or negative. And never reduce the
2425** maximum page count below the current size of the database.
2426**
2427** Regardless of mxPage, return the current maximum page count.
2428*/
2429int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2430 if( mxPage>0 ){
2431 pPager->mxPgno = mxPage;
2432 }
2433 sqlite3PagerPagecount(pPager);
2434 return pPager->mxPgno;
2435}
2436
2437/*
drhc9ac5ca2005-11-04 22:03:30 +00002438** The following set of routines are used to disable the simulated
2439** I/O error mechanism. These routines are used to avoid simulated
2440** errors in places where we do not care about errors.
2441**
2442** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2443** and generate no code.
2444*/
2445#ifdef SQLITE_TEST
2446extern int sqlite3_io_error_pending;
2447extern int sqlite3_io_error_hit;
2448static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002449void disable_simulated_io_errors(void){
2450 saved_cnt = sqlite3_io_error_pending;
2451 sqlite3_io_error_pending = -1;
2452}
2453void enable_simulated_io_errors(void){
2454 sqlite3_io_error_pending = saved_cnt;
2455}
2456#else
drh152410f2005-11-05 15:11:22 +00002457# define disable_simulated_io_errors()
2458# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002459#endif
2460
2461/*
drh90f5ecb2004-07-22 01:19:35 +00002462** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002463** that pDest points to.
2464**
2465** No error checking is done. The rational for this is that this function
2466** may be called even if the file does not exist or contain a header. In
2467** these cases sqlite3OsRead() will return an error, to which the correct
2468** response is to zero the memory at pDest and continue. A real IO error
2469** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002470*/
danielk19773b8a05f2007-03-19 17:44:26 +00002471int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002472 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002473 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002474 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2475 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002476 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002477 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002478 if( rc==SQLITE_IOERR_SHORT_READ ){
2479 rc = SQLITE_OK;
2480 }
drh90f5ecb2004-07-22 01:19:35 +00002481 }
drh551b7732006-11-06 21:20:25 +00002482 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002483}
2484
2485/*
drh5e00f6c2001-09-13 13:46:56 +00002486** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002487** pPager.
2488**
2489** If the PENDING_BYTE lies on the page directly after the end of the
2490** file, then consider this page part of the file too. For example, if
2491** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2492** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002493*/
danielk19773b8a05f2007-03-19 17:44:26 +00002494int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002495 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002496 int rc;
drhd9b02572001-04-15 00:37:09 +00002497 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002498 if( pPager->errCode ){
danielk197743468d92008-02-26 06:05:31 +00002499 return -1;
drha7aea3d2007-03-15 12:51:16 +00002500 }
drhed7c8552001-04-11 14:29:21 +00002501 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002502 n = pPager->dbSize;
2503 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002504 assert(pPager->fd->pMethods||pPager->tempFile);
2505 if( (pPager->fd->pMethods)
2506 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002507 pPager->nRef++;
drhe49f9822006-09-15 12:29:16 +00002508 pager_error(pPager, rc);
danielk1977ae72d982007-10-03 08:46:44 +00002509 pPager->nRef--;
danielk197743468d92008-02-26 06:05:31 +00002510 return -1;
danielk197715f411d2005-09-16 10:18:45 +00002511 }
2512 if( n>0 && n<pPager->pageSize ){
2513 n = 1;
2514 }else{
2515 n /= pPager->pageSize;
2516 }
2517 if( pPager->state!=PAGER_UNLOCK ){
2518 pPager->dbSize = n;
2519 }
drhed7c8552001-04-11 14:29:21 +00002520 }
danielk197715f411d2005-09-16 10:18:45 +00002521 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002522 n++;
2523 }
drhf8e632b2007-05-08 14:51:36 +00002524 if( n>pPager->mxPgno ){
2525 pPager->mxPgno = n;
2526 }
drhed7c8552001-04-11 14:29:21 +00002527 return n;
2528}
2529
drhf07e7d52006-04-07 13:54:46 +00002530
2531#ifndef SQLITE_OMIT_MEMORYDB
2532/*
2533** Clear a PgHistory block
2534*/
2535static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002536 sqlite3_free(pHist->pOrig);
2537 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002538 pHist->pOrig = 0;
2539 pHist->pStmt = 0;
2540}
2541#else
2542#define clearHistory(x)
2543#endif
2544
drhed7c8552001-04-11 14:29:21 +00002545/*
drhf7c57532003-04-25 13:22:51 +00002546** Forward declaration
2547*/
danielk197776572402004-06-25 02:38:54 +00002548static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002549
2550/*
drh85b623f2007-12-13 21:54:09 +00002551** Unlink pPg from its hash chain. Also set the page number to 0 to indicate
danielk1977f5fdda82004-11-03 08:44:05 +00002552** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002553** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002554** pNextFree/pPrevFree list that is not a part of any hash-chain.
2555*/
2556static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2557 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002558 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002559 return;
2560 }
2561 if( pPg->pNextHash ){
2562 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2563 }
2564 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002565 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002566 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2567 }else{
drh8ca0c722006-05-07 17:49:38 +00002568 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002569 pPager->aHash[h] = pPg->pNextHash;
2570 }
drh5229ae42006-03-23 23:29:04 +00002571 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002572 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2573 }
danielk1977f5fdda82004-11-03 08:44:05 +00002574 pPg->pgno = 0;
2575 pPg->pNextHash = pPg->pPrevHash = 0;
2576}
2577
2578/*
drhac69b052004-05-12 13:30:07 +00002579** Unlink a page from the free list (the list of all pages where nRef==0)
2580** and from its hash collision chain.
2581*/
2582static void unlinkPage(PgHdr *pPg){
2583 Pager *pPager = pPg->pPager;
2584
danielk19779f61c2f2007-08-27 17:27:49 +00002585 /* Unlink from free page list */
2586 lruListRemove(pPg);
drhac69b052004-05-12 13:30:07 +00002587
2588 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002589 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002590}
2591
2592/*
danielk1977e180dd92007-04-05 17:15:52 +00002593** This routine is used to truncate the cache when a database
2594** is truncated. Drop from the cache all pages whose pgno is
2595** larger than pPager->dbSize and is unreferenced.
2596**
drhac69b052004-05-12 13:30:07 +00002597** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002598**
2599** Actually, at the point this routine is called, it would be
2600** an error to have a referenced page. But rather than delete
2601** that page and guarantee a subsequent segfault, it seems better
2602** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002603*/
danielk1977e180dd92007-04-05 17:15:52 +00002604static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002605 PgHdr *pPg;
2606 PgHdr **ppPg;
2607 int dbSize = pPager->dbSize;
2608
2609 ppPg = &pPager->pAll;
2610 while( (pPg = *ppPg)!=0 ){
2611 if( pPg->pgno<=dbSize ){
2612 ppPg = &pPg->pNextAll;
2613 }else if( pPg->nRef>0 ){
2614 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2615 ppPg = &pPg->pNextAll;
2616 }else{
2617 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002618 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2619 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002620 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002621 makeClean(pPg);
drh0d180202008-02-14 23:26:56 +00002622 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00002623 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002624 pPager->nPage--;
2625 }
2626 }
2627}
2628
drhf7c57532003-04-25 13:22:51 +00002629/*
danielk197717221812005-02-15 03:38:05 +00002630** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002631** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002632** false or until the lock succeeds.
2633**
2634** Return SQLITE_OK on success and an error code if we cannot obtain
2635** the lock.
2636*/
2637static int pager_wait_on_lock(Pager *pPager, int locktype){
2638 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002639
2640 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002641 assert( PAGER_SHARED==SHARED_LOCK );
2642 assert( PAGER_RESERVED==RESERVED_LOCK );
2643 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002644
2645 /* If the file is currently unlocked then the size must be unknown */
2646 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2647
danielk197717221812005-02-15 03:38:05 +00002648 if( pPager->state>=locktype ){
2649 rc = SQLITE_OK;
2650 }else{
drhbefdf832008-03-14 19:33:05 +00002651 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002652 do {
drh054889e2005-11-30 03:20:31 +00002653 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002654 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002655 if( rc==SQLITE_OK ){
2656 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002657 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002658 }
2659 }
2660 return rc;
2661}
2662
2663/*
drhf7c57532003-04-25 13:22:51 +00002664** Truncate the file to the number of pages specified.
2665*/
danielk19773b8a05f2007-03-19 17:44:26 +00002666int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002667 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002668 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002669 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002670 if( pPager->errCode ){
2671 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002672 return rc;
2673 }
drh7d02cb72003-06-04 16:24:39 +00002674 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002675 return SQLITE_OK;
2676 }
drhb7f91642004-10-31 02:22:47 +00002677 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002678 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002679 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002680 return SQLITE_OK;
2681 }
drh86f8c192007-08-22 00:39:19 +00002682 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002683 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002684 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002685 if( rc!=SQLITE_OK ){
2686 return rc;
2687 }
danielk197717221812005-02-15 03:38:05 +00002688
2689 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002690 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002691 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002692 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002693 if( rc!=SQLITE_OK ){
2694 return rc;
2695 }
2696
drhcb4c40b2004-08-18 19:09:43 +00002697 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002698 return rc;
2699}
2700
2701/*
drhed7c8552001-04-11 14:29:21 +00002702** Shutdown the page cache. Free all memory and close all files.
2703**
2704** If a transaction was in progress when this routine is called, that
2705** transaction is rolled back. All outstanding pages are invalidated
2706** and their memory is freed. Any attempt to use a page associated
2707** with this page cache after this function returns will likely
2708** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002709**
2710** This function always succeeds. If a transaction is active an attempt
2711** is made to roll it back. If an error occurs during the rollback
2712** a hot journal may be left in the filesystem but no error is returned
2713** to the caller.
drhed7c8552001-04-11 14:29:21 +00002714*/
danielk19773b8a05f2007-03-19 17:44:26 +00002715int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002716#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002717 if( !MEMDB ){
drh26e4a8b2008-05-01 17:16:52 +00002718#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +00002719 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00002720#endif
drh86f8c192007-08-22 00:39:19 +00002721 sqlite3_mutex_enter(mutex);
2722 if( pPager->pPrev ){
2723 pPager->pPrev->pNext = pPager->pNext;
2724 }else{
2725 sqlite3PagerList = pPager->pNext;
2726 }
2727 if( pPager->pNext ){
2728 pPager->pNext->pPrev = pPager->pPrev;
2729 }
2730 sqlite3_mutex_leave(mutex);
2731 }
danielk197713f72992005-12-18 08:51:22 +00002732#endif
2733
drhbafda092007-01-03 23:36:22 +00002734 disable_simulated_io_errors();
drh16e45a42008-04-19 20:34:18 +00002735 sqlite3FaultBenign(-1, 1);
drhc2ee76c2007-01-04 14:58:14 +00002736 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002737 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002738 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002739 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002740 enable_simulated_io_errors();
drh16e45a42008-04-19 20:34:18 +00002741 sqlite3FaultBenign(-1, 0);
drh4f0c5872007-03-26 22:05:01 +00002742 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002743 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002744 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002745 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002746 }
drhf5e7bb52008-02-18 14:47:33 +00002747 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002748 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002749 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002750 }
danielk1977b4b47412007-08-17 15:53:36 +00002751 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002752 /* Temp files are automatically deleted by the OS
2753 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002754 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002755 ** }
2756 */
danielk1977aca790a2005-01-13 11:07:52 +00002757
drh17435752007-08-16 04:30:38 +00002758 sqlite3_free(pPager->aHash);
2759 sqlite3_free(pPager->pTmpSpace);
2760 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002761 return SQLITE_OK;
2762}
2763
drh87cc3b32007-05-08 21:45:27 +00002764#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002765/*
drh5e00f6c2001-09-13 13:46:56 +00002766** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002767*/
danielk19773b8a05f2007-03-19 17:44:26 +00002768Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002769 return p->pgno;
2770}
drh87cc3b32007-05-08 21:45:27 +00002771#endif
drhed7c8552001-04-11 14:29:21 +00002772
2773/*
drhc8629a12004-05-08 20:07:40 +00002774** The page_ref() function increments the reference count for a page.
2775** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002776** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002777**
2778** For non-test systems, page_ref() is a macro that calls _page_ref()
2779** online of the reference count is zero. For test systems, page_ref()
2780** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002781*/
drh836faa42003-01-11 13:30:57 +00002782static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002783 if( pPg->nRef==0 ){
2784 /* The page is currently on the freelist. Remove it. */
danielk19779f61c2f2007-08-27 17:27:49 +00002785 lruListRemove(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002786 pPg->pPager->nRef++;
2787 }
2788 pPg->nRef++;
drhdf0b3b02001-06-23 11:36:20 +00002789}
danielk1977aca790a2005-01-13 11:07:52 +00002790#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002791 static void page_ref(PgHdr *pPg){
2792 if( pPg->nRef==0 ){
2793 _page_ref(pPg);
2794 }else{
2795 pPg->nRef++;
drhc8629a12004-05-08 20:07:40 +00002796 }
2797 }
2798#else
2799# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2800#endif
drhdf0b3b02001-06-23 11:36:20 +00002801
2802/*
2803** Increment the reference count for a page. The input pointer is
2804** a reference to the page data.
2805*/
danielk19773b8a05f2007-03-19 17:44:26 +00002806int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002807 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002808 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002809 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002810 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002811}
2812
2813/*
drh34e79ce2004-02-08 06:05:46 +00002814** Sync the journal. In other words, make sure all the pages that have
2815** been written to the journal have actually reached the surface of the
2816** disk. It is not safe to modify the original database file until after
2817** the journal has been synced. If the original database is modified before
2818** the journal is synced and a power failure occurs, the unsynced journal
2819** data would be lost and we would be unable to completely rollback the
2820** database changes. Database corruption would occur.
2821**
2822** This routine also updates the nRec field in the header of the journal.
2823** (See comments on the pager_playback() routine for additional information.)
2824** If the sync mode is FULL, two syncs will occur. First the whole journal
2825** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002826**
drh34e79ce2004-02-08 06:05:46 +00002827** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002828** after a power failure, so no sync occurs.
2829**
2830** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2831** the database is stored, then OsSync() is never called on the journal
2832** file. In this case all that is required is to update the nRec field in
2833** the journal header.
drhfa86c412002-02-02 15:01:15 +00002834**
drh34e79ce2004-02-08 06:05:46 +00002835** This routine clears the needSync field of every page current held in
2836** memory.
drh50e5dad2001-09-15 00:57:28 +00002837*/
danielk197776572402004-06-25 02:38:54 +00002838static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002839 PgHdr *pPg;
2840 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002841
danielk19774cd2cd52007-08-23 14:48:23 +00002842
drh03eb96a2002-11-10 23:32:56 +00002843 /* Sync the journal before modifying the main database
2844 ** (assuming there is a journal and it needs to be synced.)
2845 */
danielk197776572402004-06-25 02:38:54 +00002846 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002847 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002848 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002849 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002850
danielk19774cd2cd52007-08-23 14:48:23 +00002851 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002852 /* Write the nRec value into the journal file header. If in
2853 ** full-synchronous mode, sync the journal first. This ensures that
2854 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002855 ** it as a candidate for rollback.
2856 **
2857 ** This is not required if the persistent media supports the
2858 ** SAFE_APPEND property. Because in this case it is not possible
2859 ** for garbage data to be appended to the file, the nRec field
2860 ** is populated with 0xFFFFFFFF when the journal header is written
2861 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002862 */
danielk19774cd2cd52007-08-23 14:48:23 +00002863 i64 jrnlOff;
2864 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002865 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002866 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002867 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002868 if( rc!=0 ) return rc;
2869 }
danielk197713adf8a2004-06-03 16:08:41 +00002870
danielk197762079062007-08-15 17:08:46 +00002871 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2872 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2873 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002874 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002875 }
danielk19774cd2cd52007-08-23 14:48:23 +00002876 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2877 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2878 IOTRACE(("JSYNC %p\n", pPager))
2879 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2880 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2881 );
2882 if( rc!=0 ) return rc;
2883 }
drhdb48ee02003-01-16 13:42:43 +00002884 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002885 }
drh50e5dad2001-09-15 00:57:28 +00002886 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002887
2888 /* Erase the needSync flag from every page.
2889 */
2890 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2891 pPg->needSync = 0;
2892 }
danielk19779f61c2f2007-08-27 17:27:49 +00002893 lruListSetFirstSynced(pPager);
drh50e5dad2001-09-15 00:57:28 +00002894 }
drh03eb96a2002-11-10 23:32:56 +00002895
drh341eae82003-01-21 02:39:36 +00002896#ifndef NDEBUG
2897 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2898 ** flag must also be clear for all pages. Verify that this
2899 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002900 */
drh341eae82003-01-21 02:39:36 +00002901 else{
2902 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2903 assert( pPg->needSync==0 );
2904 }
danielk19779f61c2f2007-08-27 17:27:49 +00002905 assert( pPager->lru.pFirstSynced==pPager->lru.pFirst );
drh03eb96a2002-11-10 23:32:56 +00002906 }
drh341eae82003-01-21 02:39:36 +00002907#endif
drhdb48ee02003-01-16 13:42:43 +00002908
drh81a20f22001-10-12 17:30:04 +00002909 return rc;
drh50e5dad2001-09-15 00:57:28 +00002910}
2911
2912/*
drhdc3e10b2006-06-15 14:31:06 +00002913** Merge two lists of pages connected by pDirty and in pgno order.
2914** Do not both fixing the pPrevDirty pointers.
2915*/
2916static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2917 PgHdr result, *pTail;
2918 pTail = &result;
2919 while( pA && pB ){
2920 if( pA->pgno<pB->pgno ){
2921 pTail->pDirty = pA;
2922 pTail = pA;
2923 pA = pA->pDirty;
2924 }else{
2925 pTail->pDirty = pB;
2926 pTail = pB;
2927 pB = pB->pDirty;
2928 }
2929 }
2930 if( pA ){
2931 pTail->pDirty = pA;
2932 }else if( pB ){
2933 pTail->pDirty = pB;
2934 }else{
2935 pTail->pDirty = 0;
2936 }
2937 return result.pDirty;
2938}
2939
2940/*
2941** Sort the list of pages in accending order by pgno. Pages are
2942** connected by pDirty pointers. The pPrevDirty pointers are
2943** corrupted by this sort.
2944*/
danielk197724168722007-04-02 05:07:47 +00002945#define N_SORT_BUCKET_ALLOC 25
2946#define N_SORT_BUCKET 25
2947#ifdef SQLITE_TEST
2948 int sqlite3_pager_n_sort_bucket = 0;
2949 #undef N_SORT_BUCKET
2950 #define N_SORT_BUCKET \
2951 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2952#endif
drhdc3e10b2006-06-15 14:31:06 +00002953static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002954 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002955 int i;
2956 memset(a, 0, sizeof(a));
2957 while( pIn ){
2958 p = pIn;
2959 pIn = p->pDirty;
2960 p->pDirty = 0;
2961 for(i=0; i<N_SORT_BUCKET-1; i++){
2962 if( a[i]==0 ){
2963 a[i] = p;
2964 break;
2965 }else{
2966 p = merge_pagelist(a[i], p);
2967 a[i] = 0;
2968 }
2969 }
2970 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002971 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2972 ** elements in the input list. This is possible, but impractical.
2973 ** Testing this line is the point of global variable
2974 ** sqlite3_pager_n_sort_bucket.
2975 */
drhdc3e10b2006-06-15 14:31:06 +00002976 a[i] = merge_pagelist(a[i], p);
2977 }
2978 }
2979 p = a[0];
2980 for(i=1; i<N_SORT_BUCKET; i++){
2981 p = merge_pagelist(p, a[i]);
2982 }
2983 return p;
2984}
2985
2986/*
drh2554f8b2003-01-22 01:26:44 +00002987** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2988** every one of those pages out to the database file and mark them all
2989** as clean.
2990*/
2991static int pager_write_pagelist(PgHdr *pList){
2992 Pager *pPager;
drh153c62c2007-08-24 03:51:33 +00002993 PgHdr *p;
drh2554f8b2003-01-22 01:26:44 +00002994 int rc;
2995
2996 if( pList==0 ) return SQLITE_OK;
2997 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002998
2999 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
3000 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00003001 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00003002 **
drha6abd042004-06-09 17:37:22 +00003003 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
3004 ** through an intermediate state PENDING. A PENDING lock prevents new
3005 ** readers from attaching to the database but is unsufficient for us to
3006 ** write. The idea of a PENDING lock is to prevent new readers from
3007 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00003008 **
drha6abd042004-06-09 17:37:22 +00003009 ** While the pager is in the RESERVED state, the original database file
3010 ** is unchanged and we can rollback without having to playback the
3011 ** journal into the original database file. Once we transition to
3012 ** EXCLUSIVE, it means the database file has been changed and any rollback
3013 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00003014 */
drh684917c2004-10-05 02:41:42 +00003015 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00003016 if( rc!=SQLITE_OK ){
3017 return rc;
3018 }
3019
drhdc3e10b2006-06-15 14:31:06 +00003020 pList = sort_pagelist(pList);
drh153c62c2007-08-24 03:51:33 +00003021 for(p=pList; p; p=p->pDirty){
3022 assert( p->dirty );
3023 p->dirty = 0;
3024 }
drh2554f8b2003-01-22 01:26:44 +00003025 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00003026
3027 /* If the file has not yet been opened, open it now. */
3028 if( !pPager->fd->pMethods ){
3029 assert(pPager->tempFile);
drh33f4e022007-09-03 15:19:34 +00003030 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename,
3031 pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00003032 if( rc ) return rc;
3033 }
3034
danielk1977687566d2004-11-02 12:56:41 +00003035 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00003036 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00003037 ** make the file smaller (presumably by auto-vacuum code). Do not write
3038 ** any such pages to the file.
3039 */
3040 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00003041 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00003042 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00003043 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
3044 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00003045 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00003046 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003047 PAGER_INCR(sqlite3_pager_writedb_count);
3048 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00003049 if( pList->pgno==1 ){
3050 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
3051 }
danielk1977687566d2004-11-02 12:56:41 +00003052 }
3053#ifndef NDEBUG
3054 else{
drh4f0c5872007-03-26 22:05:01 +00003055 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00003056 }
3057#endif
drh2554f8b2003-01-22 01:26:44 +00003058 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00003059#ifdef SQLITE_CHECK_PAGES
3060 pList->pageHash = pager_pagehash(pList);
3061#endif
drh2554f8b2003-01-22 01:26:44 +00003062 pList = pList->pDirty;
3063 }
3064 return SQLITE_OK;
3065}
3066
3067/*
3068** Collect every dirty page into a dirty list and
3069** return a pointer to the head of that list. All pages are
3070** collected even if they are still in use.
3071*/
3072static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh8f2e9a12008-02-26 14:46:04 +00003073
3074#ifndef NDEBUG
3075 /* Verify the sanity of the dirty list when we are running
3076 ** in debugging mode. This is expensive, so do not
3077 ** do this on a normal build. */
3078 int n1 = 0;
3079 int n2 = 0;
3080 PgHdr *p;
3081 for(p=pPager->pAll; p; p=p->pNextAll){ if( p->dirty ) n1++; }
3082 for(p=pPager->pDirty; p; p=p->pDirty){ n2++; }
3083 assert( n1==n2 );
3084#endif
3085
drh605ad8f2006-05-03 23:34:05 +00003086 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00003087}
3088
3089/*
drh19db9352008-03-27 22:42:51 +00003090** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00003091** A hot journal is one that needs to be played back.
3092**
3093** If the current size of the database file is 0 but a journal file
3094** exists, that is probably an old journal left over from a prior
3095** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00003096**
3097** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00003098**
3099** This routine does not open the journal file to examine its
3100** content. Hence, the journal might contain the name of a master
3101** journal file that has been deleted, and hence not be hot. Or
3102** the header of the journal might be zeroed out. This routine
3103** does not discover these cases of a non-hot journal - if the
3104** journal file exists and is not empty this routine assumes it
3105** is hot. The pager_playback() routine will discover that the
3106** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00003107*/
3108static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003109 sqlite3_vfs *pVfs = pPager->pVfs;
drh19db9352008-03-27 22:42:51 +00003110 int rc;
drh165ffe92005-03-15 17:09:30 +00003111 if( !pPager->useJournal ) return 0;
drhd3cf2472007-11-27 16:55:07 +00003112 if( !pPager->fd->pMethods ) return 0;
drh19db9352008-03-27 22:42:51 +00003113 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS);
3114 if( rc<=0 ){
3115 return rc;
drhbb5f18d2007-04-06 18:23:17 +00003116 }
3117 if( sqlite3OsCheckReservedLock(pPager->fd) ){
3118 return 0;
3119 }
danielk19773b8a05f2007-03-19 17:44:26 +00003120 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00003121 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00003122 return 0;
3123 }else{
3124 return 1;
3125 }
3126}
3127
danielk19775591df52005-12-20 09:19:37 +00003128/*
danielk1977aef0bf62005-12-30 16:28:01 +00003129** Try to find a page in the cache that can be recycled.
3130**
3131** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00003132** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00003133*/
danielk1977843e65f2007-09-01 16:16:15 +00003134static int pager_recycle(Pager *pPager, PgHdr **ppPg){
danielk197713f72992005-12-18 08:51:22 +00003135 PgHdr *pPg;
3136 *ppPg = 0;
3137
danielk1977843e65f2007-09-01 16:16:15 +00003138 /* It is illegal to call this function unless the pager object
3139 ** pointed to by pPager has at least one free page (page with nRef==0).
3140 */
danielk1977c551edc2007-04-05 13:12:13 +00003141 assert(!MEMDB);
danielk1977843e65f2007-09-01 16:16:15 +00003142 assert(pPager->lru.pFirst);
danielk1977c551edc2007-04-05 13:12:13 +00003143
danielk197713f72992005-12-18 08:51:22 +00003144 /* Find a page to recycle. Try to locate a page that does not
3145 ** require us to do an fsync() on the journal.
3146 */
danielk19779f61c2f2007-08-27 17:27:49 +00003147 pPg = pPager->lru.pFirstSynced;
danielk197713f72992005-12-18 08:51:22 +00003148
3149 /* If we could not find a page that does not require an fsync()
3150 ** on the journal file then fsync the journal file. This is a
3151 ** very slow operation, so we work hard to avoid it. But sometimes
3152 ** it can't be helped.
3153 */
danielk1977843e65f2007-09-01 16:16:15 +00003154 if( pPg==0 && pPager->lru.pFirst){
danielk19774cd2cd52007-08-23 14:48:23 +00003155 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
danielk197713f72992005-12-18 08:51:22 +00003156 int rc = syncJournal(pPager);
3157 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003158 return rc;
danielk197713f72992005-12-18 08:51:22 +00003159 }
danielk19774cd2cd52007-08-23 14:48:23 +00003160 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197713f72992005-12-18 08:51:22 +00003161 /* If in full-sync mode, write a new journal header into the
3162 ** journal file. This is done to avoid ever modifying a journal
3163 ** header that is involved in the rollback of pages that have
3164 ** already been written to the database (in case the header is
3165 ** trashed when the nRec field is updated).
3166 */
3167 pPager->nRec = 0;
3168 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00003169 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00003170 rc = writeJournalHdr(pPager);
3171 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003172 return rc;
danielk197713f72992005-12-18 08:51:22 +00003173 }
3174 }
danielk19779f61c2f2007-08-27 17:27:49 +00003175 pPg = pPager->lru.pFirst;
danielk197713f72992005-12-18 08:51:22 +00003176 }
danielk197713f72992005-12-18 08:51:22 +00003177
3178 assert( pPg->nRef==0 );
3179
3180 /* Write the page to the database file if it is dirty.
3181 */
3182 if( pPg->dirty ){
3183 int rc;
3184 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00003185 makeClean(pPg);
3186 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00003187 pPg->pDirty = 0;
3188 rc = pager_write_pagelist( pPg );
drh153c62c2007-08-24 03:51:33 +00003189 pPg->dirty = 0;
danielk197713f72992005-12-18 08:51:22 +00003190 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00003191 return rc;
danielk197713f72992005-12-18 08:51:22 +00003192 }
3193 }
3194 assert( pPg->dirty==0 );
3195
3196 /* If the page we are recycling is marked as alwaysRollback, then
3197 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00003198 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00003199 ** It is necessary to do this because the page marked alwaysRollback
3200 ** might be reloaded at a later time but at that point we won't remember
3201 ** that is was marked alwaysRollback. This means that all pages must
3202 ** be marked as alwaysRollback from here on out.
3203 */
3204 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00003205 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00003206 pPager->alwaysRollback = 1;
3207 }
3208
3209 /* Unlink the old page from the free list and the hash table
3210 */
3211 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00003212 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00003213
3214 *ppPg = pPg;
3215 return SQLITE_OK;
3216}
3217
drh86f8c192007-08-22 00:39:19 +00003218#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00003219/*
3220** This function is called to free superfluous dynamically allocated memory
3221** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00003222** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00003223**
3224** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00003225** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00003226** of bytes of memory released.
3227*/
danielk19773b8a05f2007-03-19 17:44:26 +00003228int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00003229 int nReleased = 0; /* Bytes of memory released so far */
3230 sqlite3_mutex *mutex; /* The MEM2 mutex */
3231 Pager *pPager; /* For looping over pagers */
drhe5fe6902007-12-07 18:55:28 +00003232 BusyHandler *savedBusy; /* Saved copy of the busy handler */
danielk19779f61c2f2007-08-27 17:27:49 +00003233 int rc = SQLITE_OK;
danielk197713f72992005-12-18 08:51:22 +00003234
drh86f8c192007-08-22 00:39:19 +00003235 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00003236 */
drh26e4a8b2008-05-01 17:16:52 +00003237#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +00003238 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00003239#endif
drh86f8c192007-08-22 00:39:19 +00003240 sqlite3_mutex_enter(mutex);
3241
3242 /* Signal all database connections that memory management wants
3243 ** to have access to the pagers.
3244 */
3245 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3246 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00003247 }
3248
danielk19779f61c2f2007-08-27 17:27:49 +00003249 while( rc==SQLITE_OK && (nReq<0 || nReleased<nReq) ){
3250 PgHdr *pPg;
3251 PgHdr *pRecycled;
3252
3253 /* Try to find a page to recycle that does not require a sync(). If
3254 ** this is not possible, find one that does require a sync().
3255 */
3256 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
3257 pPg = sqlite3LruPageList.pFirstSynced;
3258 while( pPg && (pPg->needSync || pPg->pPager->iInUseDB) ){
3259 pPg = pPg->gfree.pNext;
3260 }
3261 if( !pPg ){
3262 pPg = sqlite3LruPageList.pFirst;
3263 while( pPg && pPg->pPager->iInUseDB ){
3264 pPg = pPg->gfree.pNext;
3265 }
3266 }
3267 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
danielk197713f72992005-12-18 08:51:22 +00003268
danielk197784f786f2007-08-28 08:00:17 +00003269 /* If pPg==0, then the block above has failed to find a page to
3270 ** recycle. In this case return early - no further memory will
3271 ** be released.
3272 */
danielk19779f61c2f2007-08-27 17:27:49 +00003273 if( !pPg ) break;
danielk197713f72992005-12-18 08:51:22 +00003274
danielk19779f61c2f2007-08-27 17:27:49 +00003275 pPager = pPg->pPager;
3276 assert(!pPg->needSync || pPg==pPager->lru.pFirst);
3277 assert(pPg->needSync || pPg==pPager->lru.pFirstSynced);
3278
drhe5fe6902007-12-07 18:55:28 +00003279 savedBusy = pPager->pBusyHandler;
3280 pPager->pBusyHandler = 0;
danielk1977843e65f2007-09-01 16:16:15 +00003281 rc = pager_recycle(pPager, &pRecycled);
drhe5fe6902007-12-07 18:55:28 +00003282 pPager->pBusyHandler = savedBusy;
danielk19779f61c2f2007-08-27 17:27:49 +00003283 assert(pRecycled==pPg || rc!=SQLITE_OK);
3284 if( rc==SQLITE_OK ){
3285 /* We've found a page to free. At this point the page has been
3286 ** removed from the page hash-table, free-list and synced-list
3287 ** (pFirstSynced). It is still in the all pages (pAll) list.
3288 ** Remove it from this list before freeing.
3289 **
3290 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
3291 ** probably is though.
danielk197713f72992005-12-18 08:51:22 +00003292 */
danielk19779f61c2f2007-08-27 17:27:49 +00003293 PgHdr *pTmp;
3294 assert( pPg );
3295 if( pPg==pPager->pAll ){
3296 pPager->pAll = pPg->pNextAll;
3297 }else{
3298 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
3299 pTmp->pNextAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00003300 }
danielk19779f61c2f2007-08-27 17:27:49 +00003301 nReleased += (
3302 sizeof(*pPg) + pPager->pageSize
3303 + sizeof(u32) + pPager->nExtra
3304 + MEMDB*sizeof(PgHistory)
3305 );
3306 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
3307 PAGER_INCR(sqlite3_pager_pgfree_count);
drh0d180202008-02-14 23:26:56 +00003308 sqlite3_free(pPg->pData);
danielk19779f61c2f2007-08-27 17:27:49 +00003309 sqlite3_free(pPg);
danielk197784f786f2007-08-28 08:00:17 +00003310 pPager->nPage--;
danielk19779f61c2f2007-08-27 17:27:49 +00003311 }else{
3312 /* An error occured whilst writing to the database file or
3313 ** journal in pager_recycle(). The error is not returned to the
3314 ** caller of this function. Instead, set the Pager.errCode variable.
3315 ** The error will be returned to the user (or users, in the case
3316 ** of a shared pager cache) of the pager for which the error occured.
3317 */
3318 assert(
3319 (rc&0xff)==SQLITE_IOERR ||
3320 rc==SQLITE_FULL ||
3321 rc==SQLITE_BUSY
3322 );
3323 assert( pPager->state>=PAGER_RESERVED );
3324 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00003325 }
3326 }
danielk1977aef0bf62005-12-30 16:28:01 +00003327
drh86f8c192007-08-22 00:39:19 +00003328 /* Clear the memory management flags and release the mutex
3329 */
3330 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3331 pPager->iInUseMM = 0;
3332 }
3333 sqlite3_mutex_leave(mutex);
3334
3335 /* Return the number of bytes released
3336 */
danielk197713f72992005-12-18 08:51:22 +00003337 return nReleased;
3338}
drh86f8c192007-08-22 00:39:19 +00003339#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00003340
drh165ffe92005-03-15 17:09:30 +00003341/*
danielk1977e180dd92007-04-05 17:15:52 +00003342** Read the content of page pPg out of the database file.
3343*/
3344static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
3345 int rc;
danielk197762079062007-08-15 17:08:46 +00003346 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00003347 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00003348 assert(pPager->fd->pMethods||pPager->tempFile);
3349 if( !pPager->fd->pMethods ){
3350 return SQLITE_IOERR_SHORT_READ;
3351 }
danielk197762079062007-08-15 17:08:46 +00003352 offset = (pgno-1)*(i64)pPager->pageSize;
3353 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003354 PAGER_INCR(sqlite3_pager_readdb_count);
3355 PAGER_INCR(pPager->nRead);
3356 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00003357 if( pgno==1 ){
3358 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
3359 sizeof(pPager->dbFileVers));
3360 }
danielk1977e180dd92007-04-05 17:15:52 +00003361 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00003362 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
3363 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00003364 return rc;
3365}
3366
3367
3368/*
danielk1977e277be02007-03-23 18:12:06 +00003369** This function is called to obtain the shared lock required before
3370** data may be read from the pager cache. If the shared lock has already
3371** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00003372**
3373** Immediately after obtaining the shared lock (if required), this function
3374** checks for a hot-journal file. If one is found, an emergency rollback
3375** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00003376*/
3377static int pagerSharedLock(Pager *pPager){
3378 int rc = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00003379 int isHot = 0;
danielk1977e277be02007-03-23 18:12:06 +00003380
danielk1977ae72d982007-10-03 08:46:44 +00003381 /* If this database is opened for exclusive access, has no outstanding
3382 ** page references and is in an error-state, now is the chance to clear
3383 ** the error. Discard the contents of the pager-cache and treat any
3384 ** open journal file as a hot-journal.
3385 */
3386 if( !MEMDB && pPager->exclusiveMode && pPager->nRef==0 && pPager->errCode ){
3387 if( pPager->journalOpen ){
3388 isHot = 1;
3389 }
3390 pager_reset(pPager);
3391 pPager->errCode = SQLITE_OK;
3392 }
3393
3394 /* If the pager is still in an error state, do not proceed. The error
3395 ** state will be cleared at some point in the future when all page
3396 ** references are dropped and the cache can be discarded.
3397 */
3398 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3399 return pPager->errCode;
3400 }
3401
3402 if( pPager->state==PAGER_UNLOCK || isHot ){
danielk1977b4b47412007-08-17 15:53:36 +00003403 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00003404 if( !MEMDB ){
3405 assert( pPager->nRef==0 );
3406 if( !pPager->noReadlock ){
3407 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
3408 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003409 assert( pPager->state==PAGER_UNLOCK );
danielk1977e277be02007-03-23 18:12:06 +00003410 return pager_error(pPager, rc);
3411 }
3412 assert( pPager->state>=SHARED_LOCK );
3413 }
3414
3415 /* If a journal file exists, and there is no RESERVED lock on the
3416 ** database file, then it either needs to be played back or deleted.
3417 */
drh19db9352008-03-27 22:42:51 +00003418 rc = hasHotJournal(pPager);
3419 if( rc<0 ){
danielk197752b472a2008-05-05 16:23:55 +00003420 rc = SQLITE_IOERR_NOMEM;
3421 goto failed;
drh19db9352008-03-27 22:42:51 +00003422 }
3423 if( rc==1 || isHot ){
danielk1977e277be02007-03-23 18:12:06 +00003424 /* Get an EXCLUSIVE lock on the database file. At this point it is
3425 ** important that a RESERVED lock is not obtained on the way to the
3426 ** EXCLUSIVE lock. If it were, another process might open the
3427 ** database file, detect the RESERVED lock, and conclude that the
3428 ** database is safe to read while this process is still rolling it
3429 ** back.
3430 **
3431 ** Because the intermediate RESERVED lock is not requested, the
3432 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00003433 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00003434 */
danielk1977ae72d982007-10-03 08:46:44 +00003435 if( pPager->state<EXCLUSIVE_LOCK ){
3436 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3437 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003438 rc = pager_error(pPager, rc);
3439 goto failed;
danielk1977ae72d982007-10-03 08:46:44 +00003440 }
3441 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00003442 }
danielk1977e277be02007-03-23 18:12:06 +00003443
drh16e45a42008-04-19 20:34:18 +00003444 /* Open the journal for read/write access. This is because in
drhfd131da2007-08-07 17:13:03 +00003445 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003446 ** possibly used for a transaction later on. On some systems, the
3447 ** OsTruncate() call used in exclusive-access mode also requires
3448 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003449 */
drh16e45a42008-04-19 20:34:18 +00003450 if( !isHot && pPager->journalOpen==0 ){
danielk1977ce98bba2008-04-03 10:13:01 +00003451 int res = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS);
3452 if( res==1 ){
danielk1977ae72d982007-10-03 08:46:44 +00003453 int fout = 0;
3454 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
3455 assert( !pPager->tempFile );
3456 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
3457 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3458 if( fout&SQLITE_OPEN_READONLY ){
3459 rc = SQLITE_BUSY;
3460 sqlite3OsClose(pPager->jfd);
3461 }
drh16e45a42008-04-19 20:34:18 +00003462 }else if( res==0 ){
3463 /* If the journal does not exist, that means some other process
3464 ** has already rolled it back */
3465 rc = SQLITE_BUSY;
danielk1977ce98bba2008-04-03 10:13:01 +00003466 }else{
drh16e45a42008-04-19 20:34:18 +00003467 /* If sqlite3OsAccess() returns a negative value, that means it
3468 ** failed a memory allocation */
3469 rc = SQLITE_IOERR_NOMEM;
danielk1977979f38e2007-03-27 16:19:51 +00003470 }
3471 }
danielk1977e277be02007-03-23 18:12:06 +00003472 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003473 if( rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_UNLOCK
3474 && rc!=SQLITE_IOERR_NOMEM
3475 ){
3476 rc = SQLITE_BUSY;
drh1aa5af12008-03-07 19:51:14 +00003477 }
danielk197752b472a2008-05-05 16:23:55 +00003478 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003479 }
3480 pPager->journalOpen = 1;
3481 pPager->journalStarted = 0;
3482 pPager->journalOff = 0;
3483 pPager->setMaster = 0;
3484 pPager->journalHdr = 0;
3485
3486 /* Playback and delete the journal. Drop the database write
3487 ** lock and reacquire the read lock.
3488 */
3489 rc = pager_playback(pPager, 1);
3490 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003491 rc = pager_error(pPager, rc);
3492 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003493 }
danielk1977c5859712007-03-26 12:26:27 +00003494 assert(pPager->state==PAGER_SHARED ||
3495 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3496 );
danielk1977e277be02007-03-23 18:12:06 +00003497 }
3498
3499 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003500 /* The shared-lock has just been acquired on the database file
3501 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003502 ** read or write transaction). Check to see if the database
3503 ** has been modified. If the database has changed, flush the
3504 ** cache.
3505 **
3506 ** Database changes is detected by looking at 15 bytes beginning
3507 ** at offset 24 into the file. The first 4 of these 16 bytes are
3508 ** a 32-bit counter that is incremented with each change. The
3509 ** other bytes change randomly with each file change when
3510 ** a codec is in use.
3511 **
3512 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003513 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003514 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003515 */
drh86a88112007-04-16 15:02:19 +00003516 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003517 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003518
danielk1977e180dd92007-04-05 17:15:52 +00003519 if( pPager->errCode ){
danielk197752b472a2008-05-05 16:23:55 +00003520 rc = pPager->errCode;
3521 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003522 }
3523
danielk1977e180dd92007-04-05 17:15:52 +00003524 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003525 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003526 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003527 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003528 goto failed;
danielk1977e180dd92007-04-05 17:15:52 +00003529 }
drh86a88112007-04-16 15:02:19 +00003530 }else{
3531 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003532 }
3533
drh86a88112007-04-16 15:02:19 +00003534 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003535 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003536 }
3537 }
3538 }
danielk1977c5859712007-03-26 12:26:27 +00003539 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3540 if( pPager->state==PAGER_UNLOCK ){
3541 pPager->state = PAGER_SHARED;
3542 }
danielk1977e277be02007-03-23 18:12:06 +00003543 }
3544
danielk197752b472a2008-05-05 16:23:55 +00003545 failed:
3546 if( rc!=SQLITE_OK ){
3547 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
3548 pager_unlock(pPager);
3549 }
danielk1977e277be02007-03-23 18:12:06 +00003550 return rc;
3551}
3552
3553/*
danielk1977e180dd92007-04-05 17:15:52 +00003554** Allocate a PgHdr object. Either create a new one or reuse
3555** an existing one that is not otherwise in use.
3556**
3557** A new PgHdr structure is created if any of the following are
3558** true:
3559**
3560** (1) We have not exceeded our maximum allocated cache size
3561** as set by the "PRAGMA cache_size" command.
3562**
3563** (2) There are no unused PgHdr objects available at this time.
3564**
3565** (3) This is an in-memory database.
3566**
3567** (4) There are no PgHdr objects that do not require a journal
3568** file sync and a sync of the journal file is currently
3569** prohibited.
3570**
3571** Otherwise, reuse an existing PgHdr. In other words, reuse an
3572** existing PgHdr if all of the following are true:
3573**
3574** (1) We have reached or exceeded the maximum cache size
3575** allowed by "PRAGMA cache_size".
3576**
3577** (2) There is a PgHdr available with PgHdr->nRef==0
3578**
3579** (3) We are not in an in-memory database
3580**
3581** (4) Either there is an available PgHdr that does not need
3582** to be synced to disk or else disk syncing is currently
3583** allowed.
danielk197724168722007-04-02 05:07:47 +00003584*/
3585static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3586 int rc = SQLITE_OK;
3587 PgHdr *pPg;
drh1e3af332007-10-20 13:17:54 +00003588 int nByteHdr;
danielk197724168722007-04-02 05:07:47 +00003589
danielk1977e180dd92007-04-05 17:15:52 +00003590 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003591 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003592 if( pPager->nPage<pPager->mxPage
danielk19779f61c2f2007-08-27 17:27:49 +00003593 || pPager->lru.pFirst==0
danielk1977e180dd92007-04-05 17:15:52 +00003594 || MEMDB
danielk19779f61c2f2007-08-27 17:27:49 +00003595 || (pPager->lru.pFirstSynced==0 && pPager->doNotSync)
danielk1977e180dd92007-04-05 17:15:52 +00003596 ){
drh0d180202008-02-14 23:26:56 +00003597 void *pData;
danielk197724168722007-04-02 05:07:47 +00003598 if( pPager->nPage>=pPager->nHash ){
3599 pager_resize_hash_table(pPager,
3600 pPager->nHash<256 ? 256 : pPager->nHash*2);
3601 if( pPager->nHash==0 ){
3602 rc = SQLITE_NOMEM;
3603 goto pager_allocate_out;
3604 }
3605 }
drhed138fb2007-08-22 22:04:37 +00003606 pagerLeave(pPager);
drh1e3af332007-10-20 13:17:54 +00003607 nByteHdr = sizeof(*pPg) + sizeof(u32) + pPager->nExtra
3608 + MEMDB*sizeof(PgHistory);
drh0d180202008-02-14 23:26:56 +00003609 pPg = sqlite3_malloc( nByteHdr );
3610 if( pPg ){
3611 pData = sqlite3_malloc( pPager->pageSize );
3612 if( pData==0 ){
3613 sqlite3_free(pPg);
3614 pPg = 0;
3615 }
3616 }
drhed138fb2007-08-22 22:04:37 +00003617 pagerEnter(pPager);
danielk197724168722007-04-02 05:07:47 +00003618 if( pPg==0 ){
3619 rc = SQLITE_NOMEM;
3620 goto pager_allocate_out;
3621 }
drh1e3af332007-10-20 13:17:54 +00003622 memset(pPg, 0, nByteHdr);
drh0d180202008-02-14 23:26:56 +00003623 pPg->pData = pData;
danielk197724168722007-04-02 05:07:47 +00003624 pPg->pPager = pPager;
3625 pPg->pNextAll = pPager->pAll;
3626 pPager->pAll = pPg;
3627 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003628 }else{
3629 /* Recycle an existing page with a zero ref-count. */
danielk1977843e65f2007-09-01 16:16:15 +00003630 rc = pager_recycle(pPager, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003631 if( rc==SQLITE_BUSY ){
3632 rc = SQLITE_IOERR_BLOCKED;
3633 }
danielk197724168722007-04-02 05:07:47 +00003634 if( rc!=SQLITE_OK ){
3635 goto pager_allocate_out;
3636 }
3637 assert( pPager->state>=SHARED_LOCK );
3638 assert(pPg);
3639 }
3640 *ppPg = pPg;
3641
3642pager_allocate_out:
3643 return rc;
3644}
3645
3646/*
drhd33d5a82007-04-26 12:11:28 +00003647** Make sure we have the content for a page. If the page was
3648** previously acquired with noContent==1, then the content was
3649** just initialized to zeros instead of being read from disk.
3650** But now we need the real data off of disk. So make sure we
3651** have it. Read it in if we do not have it already.
3652*/
3653static int pager_get_content(PgHdr *pPg){
3654 if( pPg->needRead ){
3655 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3656 if( rc==SQLITE_OK ){
3657 pPg->needRead = 0;
3658 }else{
3659 return rc;
3660 }
3661 }
3662 return SQLITE_OK;
3663}
3664
3665/*
drhd9b02572001-04-15 00:37:09 +00003666** Acquire a page.
3667**
drh58a11682001-11-10 13:51:08 +00003668** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003669** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003670**
drhd33d5a82007-04-26 12:11:28 +00003671** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003672** file is smaller than the requested page, then no actual disk
3673** read occurs and the memory image of the page is initialized to
3674** all zeros. The extra data appended to a page is always initialized
3675** to zeros the first time a page is loaded into memory.
3676**
drhd9b02572001-04-15 00:37:09 +00003677** The acquisition might fail for several reasons. In all cases,
3678** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003679**
drhd33d5a82007-04-26 12:11:28 +00003680** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003681** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003682** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003683** just returns 0. This routine acquires a read-lock the first time it
3684** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003685** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003686** or journal files.
drh0787db62007-03-04 13:15:27 +00003687**
drh538f5702007-04-13 02:14:30 +00003688** If noContent is false, the page contents are actually read from disk.
3689** If noContent is true, it means that we do not care about the contents
3690** of the page at this time, so do not do a disk read. Just fill in the
3691** page content with zeros. But mark the fact that we have not read the
3692** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003693** sqlite3PagerWrite() is called on this page or if this routine is
3694** called again with noContent==0, that means that the content is needed
3695** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003696*/
drh86f8c192007-08-22 00:39:19 +00003697static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003698 Pager *pPager, /* The pager open on the database file */
3699 Pgno pgno, /* Page number to fetch */
3700 DbPage **ppPage, /* Write a pointer to the page here */
3701 int noContent /* Do not bother reading content from disk if true */
3702){
drhed7c8552001-04-11 14:29:21 +00003703 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003704 int rc;
drhed7c8552001-04-11 14:29:21 +00003705
danielk1977e277be02007-03-23 18:12:06 +00003706 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3707
danielk197726836652005-01-17 01:33:13 +00003708 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3709 ** number greater than this, or zero, is requested.
3710 */
drh267cb322005-09-16 17:16:52 +00003711 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003712 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003713 }
3714
drhd9b02572001-04-15 00:37:09 +00003715 /* Make sure we have not hit any critical errors.
3716 */
drh836faa42003-01-11 13:30:57 +00003717 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003718 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00003719
danielk197713adf8a2004-06-03 16:08:41 +00003720 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003721 ** on the database file. pagerSharedLock() is a no-op if
3722 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003723 */
danielk1977e277be02007-03-23 18:12:06 +00003724 rc = pagerSharedLock(pPager);
3725 if( rc!=SQLITE_OK ){
3726 return rc;
drhed7c8552001-04-11 14:29:21 +00003727 }
danielk1977e277be02007-03-23 18:12:06 +00003728 assert( pPager->state!=PAGER_UNLOCK );
3729
3730 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003731 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003732 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003733 int nMax;
drhed7c8552001-04-11 14:29:21 +00003734 int h;
drh538f5702007-04-13 02:14:30 +00003735 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003736 rc = pagerAllocatePage(pPager, &pPg);
3737 if( rc!=SQLITE_OK ){
3738 return rc;
drhed7c8552001-04-11 14:29:21 +00003739 }
danielk197724168722007-04-02 05:07:47 +00003740
drhed7c8552001-04-11 14:29:21 +00003741 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003742 assert( !MEMDB || pgno>pPager->stmtSize );
drhf5e7bb52008-02-18 14:47:33 +00003743 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
3744 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003745
drh605ad8f2006-05-03 23:34:05 +00003746 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003747 pPg->nRef = 1;
danielk197775bab7d2006-01-23 13:09:45 +00003748
drhd9b02572001-04-15 00:37:09 +00003749 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003750 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003751 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003752 }
danielk1977979f38e2007-03-27 16:19:51 +00003753 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003754 if( pPager->errCode ){
danielk1977efaaf572006-01-16 11:29:19 +00003755 rc = pPager->errCode;
danielk1977ae72d982007-10-03 08:46:44 +00003756 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00003757 return rc;
3758 }
danielk197775bab7d2006-01-23 13:09:45 +00003759
3760 /* Populate the page with data, either by reading from the database
3761 ** file, or by setting the entire page to zero.
3762 */
drhd215acf2007-04-13 04:01:58 +00003763 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003764 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003765 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003766 return SQLITE_FULL;
3767 }
drh90f5ecb2004-07-22 01:19:35 +00003768 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003769 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003770 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003771 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003772 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003773 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3774 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003775 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003776 return rc;
drh81a20f22001-10-12 17:30:04 +00003777 }
danielk1977b4626a32007-04-28 15:47:43 +00003778 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003779 }
danielk197775bab7d2006-01-23 13:09:45 +00003780
3781 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003782 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003783 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003784 pPg->pNextHash = pPager->aHash[h];
3785 pPager->aHash[h] = pPg;
3786 if( pPg->pNextHash ){
3787 assert( pPg->pNextHash->pPrevHash==0 );
3788 pPg->pNextHash->pPrevHash = pPg;
3789 }
3790
danielk19773c407372005-02-15 02:54:14 +00003791#ifdef SQLITE_CHECK_PAGES
3792 pPg->pageHash = pager_pagehash(pPg);
3793#endif
drhed7c8552001-04-11 14:29:21 +00003794 }else{
drhd9b02572001-04-15 00:37:09 +00003795 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003796 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003797 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003798 if( !noContent ){
3799 rc = pager_get_content(pPg);
3800 if( rc ){
3801 return rc;
3802 }
3803 }
drhdf0b3b02001-06-23 11:36:20 +00003804 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003805 }
danielk19773b8a05f2007-03-19 17:44:26 +00003806 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003807 return SQLITE_OK;
3808}
drh86f8c192007-08-22 00:39:19 +00003809int sqlite3PagerAcquire(
3810 Pager *pPager, /* The pager open on the database file */
3811 Pgno pgno, /* Page number to fetch */
3812 DbPage **ppPage, /* Write a pointer to the page here */
3813 int noContent /* Do not bother reading content from disk if true */
3814){
3815 int rc;
3816 pagerEnter(pPager);
3817 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3818 pagerLeave(pPager);
3819 return rc;
3820}
3821
drhed7c8552001-04-11 14:29:21 +00003822
3823/*
drh7e3b0a02001-04-28 16:52:40 +00003824** Acquire a page if it is already in the in-memory cache. Do
3825** not read the page from disk. Return a pointer to the page,
3826** or 0 if the page is not in cache.
3827**
danielk19773b8a05f2007-03-19 17:44:26 +00003828** See also sqlite3PagerGet(). The difference between this routine
3829** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003830** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003831** returns NULL if the page is not in cache or if a disk I/O error
3832** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003833*/
danielk19773b8a05f2007-03-19 17:44:26 +00003834DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003835 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003836
drh836faa42003-01-11 13:30:57 +00003837 assert( pPager!=0 );
3838 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003839
drh86f8c192007-08-22 00:39:19 +00003840 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003841 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003842 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003843 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3844 /* Do nothing */
3845 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3846 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003847 }
drh86f8c192007-08-22 00:39:19 +00003848 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003849 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003850}
3851
3852/*
drhed7c8552001-04-11 14:29:21 +00003853** Release a page.
3854**
3855** If the number of references to the page drop to zero, then the
3856** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003857** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003858** removed.
3859*/
danielk19773b8a05f2007-03-19 17:44:26 +00003860int sqlite3PagerUnref(DbPage *pPg){
danielk1977ae72d982007-10-03 08:46:44 +00003861 Pager *pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003862
3863 /* Decrement the reference count for this page
3864 */
drhed7c8552001-04-11 14:29:21 +00003865 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003866 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003867 pPg->nRef--;
drhd9b02572001-04-15 00:37:09 +00003868
danielk19773c407372005-02-15 02:54:14 +00003869 CHECK_PAGE(pPg);
3870
drh72f82862001-05-24 21:06:34 +00003871 /* When the number of references to a page reach 0, call the
3872 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003873 */
drhed7c8552001-04-11 14:29:21 +00003874 if( pPg->nRef==0 ){
danielk19779f61c2f2007-08-27 17:27:49 +00003875
3876 lruListAdd(pPg);
drh72f82862001-05-24 21:06:34 +00003877 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003878 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003879 }
drhd9b02572001-04-15 00:37:09 +00003880
3881 /* When all pages reach the freelist, drop the read lock from
3882 ** the database file.
3883 */
3884 pPager->nRef--;
3885 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003886 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003887 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003888 }
drhed7c8552001-04-11 14:29:21 +00003889 }
danielk1977ae72d982007-10-03 08:46:44 +00003890 pagerLeave(pPager);
drhd9b02572001-04-15 00:37:09 +00003891 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003892}
3893
3894/*
drha6abd042004-06-09 17:37:22 +00003895** Create a journal file for pPager. There should already be a RESERVED
3896** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003897**
3898** Return SQLITE_OK if everything. Return an error code and release the
3899** write lock if anything goes wrong.
3900*/
3901static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003902 sqlite3_vfs *pVfs = pPager->pVfs;
3903 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3904
drhda47d772002-12-02 04:25:19 +00003905 int rc;
drhb7f91642004-10-31 02:22:47 +00003906 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003907 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003908 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003909 assert( pPager->pInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003910 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003911 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003912 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00003913 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003914 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003915 rc = SQLITE_NOMEM;
3916 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003917 }
danielk1977b4b47412007-08-17 15:53:36 +00003918
drhfdc40e92008-04-17 20:59:37 +00003919 if( pPager->journalOpen==0 ){
3920 if( pPager->tempFile ){
3921 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3922 }else{
3923 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00003924 }
drhfdc40e92008-04-17 20:59:37 +00003925#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3926 rc = sqlite3JournalOpen(
3927 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3928 );
3929#else
3930 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
3931#endif
3932 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3933 pPager->journalOff = 0;
3934 pPager->setMaster = 0;
3935 pPager->journalHdr = 0;
3936 if( rc!=SQLITE_OK ){
3937 if( rc==SQLITE_NOMEM ){
3938 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3939 }
3940 goto failed_to_open_journal;
3941 }
drhda47d772002-12-02 04:25:19 +00003942 }
3943 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003944 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003945 pPager->needSync = 0;
3946 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003947 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003948 if( pPager->errCode ){
3949 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003950 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003951 }
drhda47d772002-12-02 04:25:19 +00003952 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003953
danielk197776572402004-06-25 02:38:54 +00003954 rc = writeJournalHdr(pPager);
3955
drhac69b052004-05-12 13:30:07 +00003956 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003957 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003958 }
danielk1977ae72d982007-10-03 08:46:44 +00003959 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003960 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003961 if( rc==SQLITE_OK ){
3962 rc = SQLITE_FULL;
3963 }
3964 }
drh9c105bb2004-10-02 20:38:28 +00003965 return rc;
3966
3967failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003968 sqlite3BitvecDestroy(pPager->pInJournal);
3969 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003970 return rc;
drhda47d772002-12-02 04:25:19 +00003971}
3972
3973/*
drh4b845d72002-03-05 12:41:19 +00003974** Acquire a write-lock on the database. The lock is removed when
3975** the any of the following happen:
3976**
drh80e35f42007-03-30 14:06:34 +00003977** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003978** * sqlite3PagerRollback() is called.
3979** * sqlite3PagerClose() is called.
3980** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003981**
danielk197713adf8a2004-06-03 16:08:41 +00003982** The first parameter to this routine is a pointer to any open page of the
3983** database file. Nothing changes about the page - it is used merely to
3984** acquire a pointer to the Pager structure and as proof that there is
3985** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003986**
danielk197713adf8a2004-06-03 16:08:41 +00003987** The second parameter indicates how much space in bytes to reserve for a
3988** master journal file-name at the start of the journal when it is created.
3989**
3990** A journal file is opened if this is not a temporary file. For temporary
3991** files, the opening of the journal file is deferred until there is an
3992** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003993**
drha6abd042004-06-09 17:37:22 +00003994** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003995**
3996** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3997** immediately instead of waiting until we try to flush the cache. The
3998** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003999*/
danielk19773b8a05f2007-03-19 17:44:26 +00004000int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00004001 Pager *pPager = pPg->pPager;
4002 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00004003 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00004004 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00004005 assert( pPager->state!=PAGER_UNLOCK );
4006 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00004007 assert( pPager->pInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00004008 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00004009 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00004010 pPager->origDbSize = pPager->dbSize;
4011 }else{
drh054889e2005-11-30 03:20:31 +00004012 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00004013 if( rc==SQLITE_OK ){
4014 pPager->state = PAGER_RESERVED;
4015 if( exFlag ){
4016 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
4017 }
4018 }
danielk19779eed5052004-06-04 10:38:30 +00004019 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00004020 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00004021 return rc;
drhac69b052004-05-12 13:30:07 +00004022 }
drha6abd042004-06-09 17:37:22 +00004023 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00004024 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhfdc40e92008-04-17 20:59:37 +00004025 if( pPager->useJournal && !pPager->tempFile
4026 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drhac69b052004-05-12 13:30:07 +00004027 rc = pager_open_journal(pPager);
4028 }
drh4b845d72002-03-05 12:41:19 +00004029 }
danielk1977334cdb62007-03-26 08:05:12 +00004030 }else if( pPager->journalOpen && pPager->journalOff==0 ){
4031 /* This happens when the pager was in exclusive-access mode last
4032 ** time a (read or write) transaction was successfully concluded
4033 ** by this connection. Instead of deleting the journal file it was
4034 ** kept open and truncated to 0 bytes.
4035 */
4036 assert( pPager->nRec==0 );
4037 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00004038 assert( pPager->pInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00004039 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00004040 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004041 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhed138fb2007-08-22 22:04:37 +00004042 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004043 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00004044 rc = SQLITE_NOMEM;
4045 }else{
drh369339d2007-03-30 16:01:55 +00004046 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00004047 rc = writeJournalHdr(pPager);
4048 }
drh4b845d72002-03-05 12:41:19 +00004049 }
danielk1977334cdb62007-03-26 08:05:12 +00004050 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00004051 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00004052 return rc;
4053}
4054
4055/*
drh605ad8f2006-05-03 23:34:05 +00004056** Make a page dirty. Set its dirty flag and add it to the dirty
4057** page list.
4058*/
4059static void makeDirty(PgHdr *pPg){
4060 if( pPg->dirty==0 ){
4061 Pager *pPager = pPg->pPager;
4062 pPg->dirty = 1;
4063 pPg->pDirty = pPager->pDirty;
4064 if( pPager->pDirty ){
4065 pPager->pDirty->pPrevDirty = pPg;
4066 }
4067 pPg->pPrevDirty = 0;
4068 pPager->pDirty = pPg;
4069 }
4070}
4071
4072/*
4073** Make a page clean. Clear its dirty bit and remove it from the
4074** dirty page list.
4075*/
4076static void makeClean(PgHdr *pPg){
4077 if( pPg->dirty ){
4078 pPg->dirty = 0;
4079 if( pPg->pDirty ){
drh153c62c2007-08-24 03:51:33 +00004080 assert( pPg->pDirty->pPrevDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004081 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
4082 }
4083 if( pPg->pPrevDirty ){
drh153c62c2007-08-24 03:51:33 +00004084 assert( pPg->pPrevDirty->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004085 pPg->pPrevDirty->pDirty = pPg->pDirty;
4086 }else{
drh153c62c2007-08-24 03:51:33 +00004087 assert( pPg->pPager->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004088 pPg->pPager->pDirty = pPg->pDirty;
4089 }
4090 }
4091}
4092
4093
4094/*
drhed7c8552001-04-11 14:29:21 +00004095** Mark a data page as writeable. The page is written into the journal
4096** if it is not there already. This routine must be called before making
4097** changes to a page.
4098**
4099** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00004100** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00004101** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00004102** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00004103** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00004104**
4105** If the journal file could not be written because the disk is full,
4106** then this routine returns SQLITE_FULL and does an immediate rollback.
4107** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00004108** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00004109** reset.
drhed7c8552001-04-11 14:29:21 +00004110*/
danielk19773b8a05f2007-03-19 17:44:26 +00004111static int pager_write(PgHdr *pPg){
4112 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00004113 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00004114 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00004115
drh6446c4d2001-12-15 14:22:18 +00004116 /* Check for errors
4117 */
danielk1977efaaf572006-01-16 11:29:19 +00004118 if( pPager->errCode ){
4119 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004120 }
drh5e00f6c2001-09-13 13:46:56 +00004121 if( pPager->readOnly ){
4122 return SQLITE_PERM;
4123 }
drh6446c4d2001-12-15 14:22:18 +00004124
danielk197776572402004-06-25 02:38:54 +00004125 assert( !pPager->setMaster );
4126
danielk19773c407372005-02-15 02:54:14 +00004127 CHECK_PAGE(pPg);
4128
drh538f5702007-04-13 02:14:30 +00004129 /* If this page was previously acquired with noContent==1, that means
4130 ** we didn't really read in the content of the page. This can happen
4131 ** (for example) when the page is being moved to the freelist. But
4132 ** now we are (perhaps) moving the page off of the freelist for
4133 ** reuse and we need to know its original content so that content
4134 ** can be stored in the rollback journal. So do the read at this
4135 ** time.
4136 */
drhd33d5a82007-04-26 12:11:28 +00004137 rc = pager_get_content(pPg);
4138 if( rc ){
4139 return rc;
drh538f5702007-04-13 02:14:30 +00004140 }
4141
drh6446c4d2001-12-15 14:22:18 +00004142 /* Mark the page as dirty. If the page has already been written
4143 ** to the journal then we can return right away.
4144 */
drh605ad8f2006-05-03 23:34:05 +00004145 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00004146 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00004147 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004148 }else{
drh6446c4d2001-12-15 14:22:18 +00004149
danielk1977a0bf2652004-11-04 14:30:04 +00004150 /* If we get this far, it means that the page needs to be
4151 ** written to the transaction journal or the ckeckpoint journal
4152 ** or both.
4153 **
4154 ** First check to see that the transaction journal exists and
4155 ** create it if it does not.
4156 */
4157 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00004158 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00004159 if( rc!=SQLITE_OK ){
4160 return rc;
4161 }
4162 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00004163 if( !pPager->journalOpen && pPager->useJournal
4164 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00004165 rc = pager_open_journal(pPager);
4166 if( rc!=SQLITE_OK ) return rc;
4167 }
danielk1977a0bf2652004-11-04 14:30:04 +00004168 pPager->dirtyCache = 1;
4169
4170 /* The transaction journal now exists and we have a RESERVED or an
4171 ** EXCLUSIVE lock on the main database file. Write the current page to
4172 ** the transaction journal if it is not there already.
4173 */
drhfdc40e92008-04-17 20:59:37 +00004174 if( !pPg->inJournal && (pPager->journalOpen || MEMDB) ){
danielk1977a0bf2652004-11-04 14:30:04 +00004175 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00004176 if( MEMDB ){
4177 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00004178 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004179 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00004180 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977662278e2007-11-05 15:30:12 +00004181 if( !pHist->pOrig ){
4182 return SQLITE_NOMEM;
danielk1977a0bf2652004-11-04 14:30:04 +00004183 }
danielk1977662278e2007-11-05 15:30:12 +00004184 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977a0bf2652004-11-04 14:30:04 +00004185 }else{
drhbf4bca52007-09-06 22:19:14 +00004186 u32 cksum;
4187 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00004188
drh267cb322005-09-16 17:16:52 +00004189 /* We should never write to the journal file the page that
4190 ** contains the database locks. The following assert verifies
4191 ** that we do not. */
4192 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00004193 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00004194 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00004195 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
4196 if( rc==SQLITE_OK ){
4197 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
4198 pPager->journalOff + 4);
4199 pPager->journalOff += pPager->pageSize+4;
4200 }
4201 if( rc==SQLITE_OK ){
4202 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
4203 pPager->journalOff += 4;
4204 }
4205 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00004206 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00004207 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00004208 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
4209 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00004210
drhfd131da2007-08-07 17:13:03 +00004211 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00004212 ** transaction will be rolled back by the layer above.
4213 */
danielk1977a0bf2652004-11-04 14:30:04 +00004214 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00004215 return rc;
4216 }
danielk197707cb5602006-01-20 10:55:05 +00004217
danielk1977a0bf2652004-11-04 14:30:04 +00004218 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00004219 assert( pPager->pInJournal!=0 );
4220 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004221 pPg->needSync = !pPager->noSync;
4222 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00004223 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004224 }
drhac69b052004-05-12 13:30:07 +00004225 }
danielk197713adf8a2004-06-03 16:08:41 +00004226 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004227 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00004228 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00004229 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00004230 }
4231 if( pPg->needSync ){
4232 pPager->needSync = 1;
4233 }
4234 pPg->inJournal = 1;
4235 }
4236
4237 /* If the statement journal is open and the page is not in it,
4238 ** then write the current page to the statement journal. Note that
4239 ** the statement journal format differs from the standard journal format
4240 ** in that it omits the checksums and the header.
4241 */
danielk1977f35843b2007-04-07 15:03:17 +00004242 if( pPager->stmtInUse
4243 && !pageInStatement(pPg)
4244 && (int)pPg->pgno<=pPager->stmtSize
4245 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004246 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
4247 if( MEMDB ){
4248 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4249 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00004250 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00004251 if( pHist->pStmt ){
4252 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
4253 }
drh4f0c5872007-03-26 22:05:01 +00004254 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00004255 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00004256 }else{
danielk197762079062007-08-15 17:08:46 +00004257 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00004258 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
4259 rc = write32bits(pPager->stfd, offset, pPg->pgno);
4260 if( rc==SQLITE_OK ){
4261 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
4262 }
drh4f0c5872007-03-26 22:05:01 +00004263 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00004264 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00004265 return rc;
4266 }
danielk1977a0bf2652004-11-04 14:30:04 +00004267 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00004268 assert( pPager->pInStmt!=0 );
4269 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00004270 }
drhd9b02572001-04-15 00:37:09 +00004271 }
drhfa86c412002-02-02 15:01:15 +00004272 }
4273
4274 /* Update the database size and return.
4275 */
drh1aa2d8b2007-01-03 15:34:29 +00004276 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00004277 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00004278 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00004279 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00004280 pPager->dbSize++;
4281 }
drh306dc212001-05-21 13:45:10 +00004282 }
drh69688d52001-04-14 16:38:23 +00004283 return rc;
drhed7c8552001-04-11 14:29:21 +00004284}
4285
4286/*
danielk19774099f6e2007-03-19 11:25:20 +00004287** This function is used to mark a data-page as writable. It uses
4288** pager_write() to open a journal file (if it is not already open)
4289** and write the page *pData to the journal.
4290**
4291** The difference between this function and pager_write() is that this
4292** function also deals with the special case where 2 or more pages
4293** fit on a single disk sector. In this case all co-resident pages
4294** must have been written to the journal file before returning.
4295*/
danielk19773b8a05f2007-03-19 17:44:26 +00004296int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00004297 int rc = SQLITE_OK;
4298
danielk19773b8a05f2007-03-19 17:44:26 +00004299 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00004300 Pager *pPager = pPg->pPager;
4301 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
4302
drh86f8c192007-08-22 00:39:19 +00004303 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004304 if( !MEMDB && nPagePerSector>1 ){
4305 Pgno nPageCount; /* Total number of pages in database file */
4306 Pgno pg1; /* First page of the sector pPg is located on. */
4307 int nPage; /* Number of pages starting at pg1 to journal */
4308 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00004309 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00004310
4311 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
4312 ** header to be written between the pages journaled by this function.
4313 */
4314 assert( pPager->doNotSync==0 );
4315 pPager->doNotSync = 1;
4316
4317 /* This trick assumes that both the page-size and sector-size are
4318 ** an integer power of 2. It sets variable pg1 to the identifier
4319 ** of the first page of the sector pPg is located on.
4320 */
4321 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
4322
danielk19773b8a05f2007-03-19 17:44:26 +00004323 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004324 if( pPg->pgno>nPageCount ){
4325 nPage = (pPg->pgno - pg1)+1;
4326 }else if( (pg1+nPagePerSector-1)>nPageCount ){
4327 nPage = nPageCount+1-pg1;
4328 }else{
4329 nPage = nPagePerSector;
4330 }
4331 assert(nPage>0);
4332 assert(pg1<=pPg->pgno);
4333 assert((pg1+nPage)>pPg->pgno);
4334
4335 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
4336 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00004337 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00004338 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00004339 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00004340 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004341 if( rc==SQLITE_OK ){
4342 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00004343 if( pPage->needSync ){
4344 needSync = 1;
4345 }
danielk19773b8a05f2007-03-19 17:44:26 +00004346 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004347 }
4348 }
drhc81945e2008-03-10 14:12:53 +00004349 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk1977dd97a492007-08-22 18:54:32 +00004350 if( pPage->needSync ){
4351 needSync = 1;
4352 }
danielk19774099f6e2007-03-19 11:25:20 +00004353 }
4354 }
4355
danielk1977dd97a492007-08-22 18:54:32 +00004356 /* If the PgHdr.needSync flag is set for any of the nPage pages
4357 ** starting at pg1, then it needs to be set for all of them. Because
4358 ** writing to any of these nPage pages may damage the others, the
4359 ** journal file must contain sync()ed copies of all of them
4360 ** before any of them can be written out to the database file.
4361 */
4362 if( needSync ){
4363 for(ii=0; ii<nPage && needSync; ii++){
4364 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
4365 if( pPage ) pPage->needSync = 1;
4366 }
4367 assert(pPager->needSync);
4368 }
4369
danielk19774099f6e2007-03-19 11:25:20 +00004370 assert( pPager->doNotSync==1 );
4371 pPager->doNotSync = 0;
4372 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004373 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00004374 }
drh86f8c192007-08-22 00:39:19 +00004375 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004376 return rc;
4377}
4378
4379/*
drhaacc5432002-01-06 17:07:40 +00004380** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00004381** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00004382** to change the content of the page.
4383*/
danielk19777d3a6662006-01-23 16:21:05 +00004384#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00004385int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00004386 return pPg->dirty;
4387}
danielk19777d3a6662006-01-23 16:21:05 +00004388#endif
drh6019e162001-07-02 17:51:45 +00004389
drh001bbcb2003-03-19 03:14:00 +00004390/*
drh30e58752002-03-02 20:41:57 +00004391** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00004392** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00004393** that page might be marked as dirty.
4394**
4395** The overlying software layer calls this routine when all of the data
4396** on the given page is unused. The pager marks the page as clean so
4397** that it does not get written to disk.
4398**
4399** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00004400** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00004401** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00004402**
4403** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00004404** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00004405** will thereafter be ignored. This is necessary to avoid a problem
4406** where a page with data is added to the freelist during one part of
4407** a transaction then removed from the freelist during a later part
4408** of the same transaction and reused for some other purpose. When it
4409** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004410** the sqlite3PagerDontRollback() routine is called. But because the
4411** page contains critical data, we still need to be sure it gets
4412** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004413*/
drh538f5702007-04-13 02:14:30 +00004414void sqlite3PagerDontWrite(DbPage *pDbPage){
4415 PgHdr *pPg = pDbPage;
4416 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004417
drhb7f91642004-10-31 02:22:47 +00004418 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004419 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004420 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004421 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004422 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004423 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4424 /* If this pages is the last page in the file and the file has grown
4425 ** during the current transaction, then do NOT mark the page as clean.
4426 ** When the database file grows, we must make sure that the last page
4427 ** gets written at least once so that the disk file will be the correct
4428 ** size. If you do not write this page and the size of the file
4429 ** on the disk ends up being too small, that can lead to database
4430 ** corruption during the next transaction.
4431 */
4432 }else{
drh538f5702007-04-13 02:14:30 +00004433 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4434 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004435 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004436#ifdef SQLITE_CHECK_PAGES
4437 pPg->pageHash = pager_pagehash(pPg);
4438#endif
drh8124a302002-06-25 14:43:57 +00004439 }
drh30e58752002-03-02 20:41:57 +00004440 }
drh86f8c192007-08-22 00:39:19 +00004441 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004442}
4443
4444/*
4445** A call to this routine tells the pager that if a rollback occurs,
4446** it is not necessary to restore the data on the given page. This
4447** means that the pager does not have to record the given page in the
4448** rollback journal.
drh538f5702007-04-13 02:14:30 +00004449**
4450** If we have not yet actually read the content of this page (if
4451** the PgHdr.needRead flag is set) then this routine acts as a promise
4452** that we will never need to read the page content in the future.
4453** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00004454*/
danielk19773b8a05f2007-03-19 17:44:26 +00004455void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004456 Pager *pPager = pPg->pPager;
4457
drh86f8c192007-08-22 00:39:19 +00004458 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004459 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00004460
4461 /* If the journal file is not open, or DontWrite() has been called on
4462 ** this page (DontWrite() sets the alwaysRollback flag), then this
4463 ** function is a no-op.
4464 */
4465 if( pPager->journalOpen==0 || pPg->alwaysRollback || pPager->alwaysRollback ){
danielk197787c29a92008-01-18 11:33:16 +00004466 pagerLeave(pPager);
4467 return;
4468 }
danielk1977a55e9352008-01-21 13:04:34 +00004469 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
4470
drhc5d0bd92008-04-14 01:00:57 +00004471#ifdef SQLITE_SECURE_DELETE
4472 if( pPg->inJournal || (int)pPg->pgno > pPager->origDbSize ){
4473 return;
4474 }
4475#endif
4476
4477 /* If SECURE_DELETE is disabled, then there is no way that this
4478 ** routine can be called on a page for which sqlite3PagerDontWrite()
4479 ** has not been previously called during the same transaction.
4480 ** And if DontWrite() has previously been called, the following
4481 ** conditions must be met.
danielk1977a55e9352008-01-21 13:04:34 +00004482 */
4483 assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize );
4484
drhf5e7bb52008-02-18 14:47:33 +00004485 assert( pPager->pInJournal!=0 );
4486 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00004487 pPg->inJournal = 1;
4488 pPg->needRead = 0;
4489 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00004490 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00004491 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00004492 }
danielk1977a55e9352008-01-21 13:04:34 +00004493 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
4494 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh86f8c192007-08-22 00:39:19 +00004495 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004496}
4497
drhac69b052004-05-12 13:30:07 +00004498
drh30e58752002-03-02 20:41:57 +00004499/*
drh80e35f42007-03-30 14:06:34 +00004500** This routine is called to increment the database file change-counter,
4501** stored at byte 24 of the pager file.
4502*/
danielk1977c7b60172007-08-22 11:22:03 +00004503static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004504 PgHdr *pPgHdr;
4505 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004506 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004507
4508 if( !pPager->changeCountDone ){
4509 /* Open page 1 of the file for writing. */
4510 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4511 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004512
4513 if( !isDirect ){
4514 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00004515 if( rc!=SQLITE_OK ){
4516 sqlite3PagerUnref(pPgHdr);
4517 return rc;
4518 }
danielk1977c7b60172007-08-22 11:22:03 +00004519 }
4520
drh80e35f42007-03-30 14:06:34 +00004521 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004522 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004523 change_counter++;
4524 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004525
4526 if( isDirect && pPager->fd->pMethods ){
4527 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4528 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4529 }
4530
drh80e35f42007-03-30 14:06:34 +00004531 /* Release the page reference. */
4532 sqlite3PagerUnref(pPgHdr);
4533 pPager->changeCountDone = 1;
4534 }
danielk1977c7b60172007-08-22 11:22:03 +00004535 return rc;
drh80e35f42007-03-30 14:06:34 +00004536}
4537
4538/*
danielk1977f653d782008-03-20 11:04:21 +00004539** Sync the pager file to disk.
4540*/
4541int sqlite3PagerSync(Pager *pPager){
4542 int rc;
4543 pagerEnter(pPager);
4544 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
4545 pagerLeave(pPager);
4546 return rc;
4547}
4548
4549/*
drh80e35f42007-03-30 14:06:34 +00004550** Sync the database file for the pager pPager. zMaster points to the name
4551** of a master journal file that should be written into the individual
4552** journal file. zMaster may be NULL, which is interpreted as no master
4553** journal (a single database transaction).
4554**
4555** This routine ensures that the journal is synced, all dirty pages written
4556** to the database file and the database file synced. The only thing that
4557** remains to commit the transaction is to delete the journal file (or
4558** master journal file if specified).
4559**
4560** Note that if zMaster==NULL, this does not overwrite a previous value
4561** passed to an sqlite3PagerCommitPhaseOne() call.
4562**
4563** If parameter nTrunc is non-zero, then the pager file is truncated to
4564** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00004565**
4566** If the final parameter - noSync - is true, then the database file itself
4567** is not synced. The caller must call sqlite3PagerSync() directly to
4568** sync the database file before calling CommitPhaseTwo() to delete the
4569** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00004570*/
danielk1977f653d782008-03-20 11:04:21 +00004571int sqlite3PagerCommitPhaseOne(
4572 Pager *pPager,
4573 const char *zMaster,
4574 Pgno nTrunc,
4575 int noSync
4576){
drh80e35f42007-03-30 14:06:34 +00004577 int rc = SQLITE_OK;
4578
4579 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4580 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004581 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004582
4583 /* If this is an in-memory db, or no pages have been written to, or this
4584 ** function has already been called, it is a no-op.
4585 */
4586 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4587 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00004588
danielk1977c7b60172007-08-22 11:22:03 +00004589#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4590 /* The atomic-write optimization can be used if all of the
4591 ** following are true:
4592 **
4593 ** + The file-system supports the atomic-write property for
4594 ** blocks of size page-size, and
4595 ** + This commit is not part of a multi-file transaction, and
4596 ** + Exactly one page has been modified and store in the journal file.
4597 **
4598 ** If the optimization can be used, then the journal file will never
4599 ** be created for this transaction.
4600 */
danielk1977f55b8992007-08-24 08:15:53 +00004601 int useAtomicWrite = (
4602 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00004603 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00004604 pPager->journalOff==jrnlBufferSize(pPager) &&
4605 nTrunc==0 &&
4606 (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4607 );
danielk1977700b9c52008-04-24 12:37:40 +00004608 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00004609 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00004610 /* Update the nRec field in the journal file. */
4611 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4612 assert(pPager->nRec==1);
4613 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4614
4615 /* Update the db file change counter. The following call will modify
4616 ** the in-memory representation of page 1 to include the updated
4617 ** change counter and then write page 1 directly to the database
4618 ** file. Because of the atomic-write property of the host file-system,
4619 ** this is safe.
4620 */
danielk1977ae72d982007-10-03 08:46:44 +00004621 if( rc==SQLITE_OK ){
4622 rc = pager_incr_changecounter(pPager, 1);
4623 }
danielk1977f55b8992007-08-24 08:15:53 +00004624 }else{
4625 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00004626 }
4627
danielk1977ae72d982007-10-03 08:46:44 +00004628 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00004629#endif
4630
drh80e35f42007-03-30 14:06:34 +00004631 /* If a master journal file name has already been written to the
4632 ** journal file, then no sync is required. This happens when it is
4633 ** written, then the process fails to upgrade from a RESERVED to an
4634 ** EXCLUSIVE lock. The next time the process tries to commit the
4635 ** transaction the m-j name will have already been written.
4636 */
4637 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00004638 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004639 if( rc!=SQLITE_OK ) goto sync_exit;
4640#ifndef SQLITE_OMIT_AUTOVACUUM
4641 if( nTrunc!=0 ){
4642 /* If this transaction has made the database smaller, then all pages
4643 ** being discarded by the truncation must be written to the journal
4644 ** file.
4645 */
4646 Pgno i;
4647 int iSkip = PAGER_MJ_PGNO(pPager);
4648 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
drhf5e7bb52008-02-18 14:47:33 +00004649 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
drh80e35f42007-03-30 14:06:34 +00004650 rc = sqlite3PagerGet(pPager, i, &pPg);
4651 if( rc!=SQLITE_OK ) goto sync_exit;
4652 rc = sqlite3PagerWrite(pPg);
4653 sqlite3PagerUnref(pPg);
4654 if( rc!=SQLITE_OK ) goto sync_exit;
4655 }
4656 }
4657 }
4658#endif
4659 rc = writeMasterJournal(pPager, zMaster);
4660 if( rc!=SQLITE_OK ) goto sync_exit;
4661 rc = syncJournal(pPager);
drh80e35f42007-03-30 14:06:34 +00004662 }
danielk1977c7b60172007-08-22 11:22:03 +00004663 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004664
4665#ifndef SQLITE_OMIT_AUTOVACUUM
4666 if( nTrunc!=0 ){
4667 rc = sqlite3PagerTruncate(pPager, nTrunc);
4668 if( rc!=SQLITE_OK ) goto sync_exit;
4669 }
4670#endif
4671
4672 /* Write all dirty pages to the database file */
4673 pPg = pager_get_all_dirty_pages(pPager);
4674 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00004675 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00004676 assert( rc!=SQLITE_IOERR_BLOCKED );
4677 /* The error might have left the dirty list all fouled up here,
4678 ** but that does not matter because if the if the dirty list did
4679 ** get corrupted, then the transaction will roll back and
4680 ** discard the dirty list. There is an assert in
4681 ** pager_get_all_dirty_pages() that verifies that no attempt
4682 ** is made to use an invalid dirty list.
4683 */
drh153c62c2007-08-24 03:51:33 +00004684 goto sync_exit;
4685 }
drh3cdd7d32007-03-30 14:46:01 +00004686 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004687
4688 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00004689 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004690 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004691 }
4692 IOTRACE(("DBSYNC %p\n", pPager))
4693
4694 pPager->state = PAGER_SYNCED;
4695 }else if( MEMDB && nTrunc!=0 ){
4696 rc = sqlite3PagerTruncate(pPager, nTrunc);
4697 }
4698
4699sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004700 if( rc==SQLITE_IOERR_BLOCKED ){
4701 /* pager_incr_changecounter() may attempt to obtain an exclusive
4702 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00004703 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00004704 * better to return SQLITE_BUSY.
4705 */
4706 rc = SQLITE_BUSY;
4707 }
drh86f8c192007-08-22 00:39:19 +00004708 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004709 return rc;
4710}
4711
4712
4713/*
drhed7c8552001-04-11 14:29:21 +00004714** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004715**
4716** If the commit fails for any reason, a rollback attempt is made
4717** and an error code is returned. If the commit worked, SQLITE_OK
4718** is returned.
drhed7c8552001-04-11 14:29:21 +00004719*/
drh80e35f42007-03-30 14:06:34 +00004720int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004721 int rc;
drhed7c8552001-04-11 14:29:21 +00004722 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004723
danielk1977efaaf572006-01-16 11:29:19 +00004724 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004725 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004726 }
drha6abd042004-06-09 17:37:22 +00004727 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004728 return SQLITE_ERROR;
4729 }
drh86f8c192007-08-22 00:39:19 +00004730 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004731 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004732 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004733 pPg = pager_get_all_dirty_pages(pPager);
4734 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004735 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4736 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004737 pPg->dirty = 0;
4738 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004739 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004740 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004741 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004742 pPg = pPg->pDirty;
4743 }
drh605ad8f2006-05-03 23:34:05 +00004744 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004745#ifndef NDEBUG
4746 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4747 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4748 assert( !pPg->alwaysRollback );
4749 assert( !pHist->pOrig );
4750 assert( !pHist->pStmt );
4751 }
4752#endif
drhac69b052004-05-12 13:30:07 +00004753 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004754 pPager->state = PAGER_SHARED;
danielk197787c29a92008-01-18 11:33:16 +00004755 pagerLeave(pPager);
drhac69b052004-05-12 13:30:07 +00004756 return SQLITE_OK;
4757 }
drh3cdd7d32007-03-30 14:46:01 +00004758 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
4759 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004760 rc = pager_error(pPager, rc);
4761 pagerLeave(pPager);
4762 return rc;
drhed7c8552001-04-11 14:29:21 +00004763}
4764
4765/*
drha6abd042004-06-09 17:37:22 +00004766** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004767** All in-memory cache pages revert to their original data contents.
4768** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004769**
4770** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004771** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004772** process is writing trash into the journal file (SQLITE_CORRUPT) or
4773** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4774** codes are returned for all these occasions. Otherwise,
4775** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004776*/
danielk19773b8a05f2007-03-19 17:44:26 +00004777int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004778 int rc;
drh4f0c5872007-03-26 22:05:01 +00004779 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004780 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004781 PgHdr *p;
4782 for(p=pPager->pAll; p; p=p->pNextAll){
4783 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004784 assert( !p->alwaysRollback );
4785 if( !p->dirty ){
4786 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4787 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4788 continue;
4789 }
4790
drhac69b052004-05-12 13:30:07 +00004791 pHist = PGHDR_TO_HIST(p, pPager);
4792 if( pHist->pOrig ){
4793 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004794 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004795 }else{
drh4f0c5872007-03-26 22:05:01 +00004796 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004797 }
4798 clearHistory(pHist);
4799 p->dirty = 0;
4800 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004801 pHist->inStmt = 0;
4802 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004803 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004804 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004805 }
drhac69b052004-05-12 13:30:07 +00004806 }
drh605ad8f2006-05-03 23:34:05 +00004807 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004808 pPager->pStmt = 0;
4809 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004810 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004811 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004812 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004813 return SQLITE_OK;
4814 }
4815
drh86f8c192007-08-22 00:39:19 +00004816 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004817 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00004818 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004819 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004820 return rc;
4821 }
drhdb48ee02003-01-16 13:42:43 +00004822
danielk1977efaaf572006-01-16 11:29:19 +00004823 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004824 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004825 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004826 }
drh86f8c192007-08-22 00:39:19 +00004827 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004828 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004829 }
drha6abd042004-06-09 17:37:22 +00004830 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004831 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004832 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004833 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00004834 if( rc==SQLITE_OK ){
4835 rc = rc2;
4836 }
4837 }else{
danielk1977e277be02007-03-23 18:12:06 +00004838 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004839 }
danielk1977e180dd92007-04-05 17:15:52 +00004840 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004841 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004842
4843 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4844 ** cache. So call pager_error() on the way out to make any error
4845 ** persistent.
4846 */
drh86f8c192007-08-22 00:39:19 +00004847 rc = pager_error(pPager, rc);
4848 pagerLeave(pPager);
4849 return rc;
drh98808ba2001-10-18 12:34:46 +00004850}
drhd9b02572001-04-15 00:37:09 +00004851
4852/*
drh5e00f6c2001-09-13 13:46:56 +00004853** Return TRUE if the database file is opened read-only. Return FALSE
4854** if the database is (in theory) writable.
4855*/
danielk19773b8a05f2007-03-19 17:44:26 +00004856int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004857 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004858}
4859
4860/*
drh0f7eb612006-08-08 13:51:43 +00004861** Return the number of references to the pager.
4862*/
danielk19773b8a05f2007-03-19 17:44:26 +00004863int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004864 return pPager->nRef;
4865}
4866
4867#ifdef SQLITE_TEST
4868/*
drhd9b02572001-04-15 00:37:09 +00004869** This routine is used for testing and analysis only.
4870*/
danielk19773b8a05f2007-03-19 17:44:26 +00004871int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004872 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004873 a[0] = pPager->nRef;
4874 a[1] = pPager->nPage;
4875 a[2] = pPager->mxPage;
4876 a[3] = pPager->dbSize;
4877 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004878 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004879 a[6] = pPager->nHit;
4880 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004881 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004882 a[9] = pPager->nRead;
4883 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004884 return a;
4885}
drh0f7eb612006-08-08 13:51:43 +00004886#endif
drhdd793422001-06-28 01:54:48 +00004887
drhfa86c412002-02-02 15:01:15 +00004888/*
drhac69b052004-05-12 13:30:07 +00004889** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004890**
4891** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004892** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004893** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004894*/
drh86f8c192007-08-22 00:39:19 +00004895static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004896 int rc;
drhac69b052004-05-12 13:30:07 +00004897 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004898 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004899 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004900 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004901 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004902 pPager->stmtInUse = 1;
4903 pPager->stmtSize = pPager->dbSize;
4904 return SQLITE_OK;
4905 }
drhda47d772002-12-02 04:25:19 +00004906 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004907 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004908 return SQLITE_OK;
4909 }
drhfa86c412002-02-02 15:01:15 +00004910 assert( pPager->journalOpen );
drhed138fb2007-08-22 22:04:37 +00004911 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004912 assert( pPager->pInStmt==0 );
4913 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00004914 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004915 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004916 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004917 return SQLITE_NOMEM;
4918 }
danielk197776572402004-06-25 02:38:54 +00004919 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004920 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004921 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004922 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004923 if( !pPager->stmtOpen ){
drh334b2992007-09-06 23:28:23 +00004924 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, pPager->zStmtJrnl,
drh33f4e022007-09-03 15:19:34 +00004925 SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00004926 if( rc ){
4927 goto stmt_begin_failed;
4928 }
drhac69b052004-05-12 13:30:07 +00004929 pPager->stmtOpen = 1;
4930 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004931 }
drhac69b052004-05-12 13:30:07 +00004932 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004933 return SQLITE_OK;
4934
drhac69b052004-05-12 13:30:07 +00004935stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00004936 if( pPager->pInStmt ){
4937 sqlite3BitvecDestroy(pPager->pInStmt);
4938 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004939 }
4940 return rc;
4941}
drh86f8c192007-08-22 00:39:19 +00004942int sqlite3PagerStmtBegin(Pager *pPager){
4943 int rc;
4944 pagerEnter(pPager);
4945 rc = pagerStmtBegin(pPager);
4946 pagerLeave(pPager);
4947 return rc;
4948}
drhfa86c412002-02-02 15:01:15 +00004949
4950/*
drhac69b052004-05-12 13:30:07 +00004951** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004952*/
danielk19773b8a05f2007-03-19 17:44:26 +00004953int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00004954 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004955 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004956 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004957 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004958 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004959 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhf5e7bb52008-02-18 14:47:33 +00004960 sqlite3BitvecDestroy(pPager->pInStmt);
4961 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004962 }else{
4963 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004964 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004965 pNext = pHist->pNextStmt;
4966 assert( pHist->inStmt );
4967 pHist->inStmt = 0;
4968 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00004969 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004970 pHist->pStmt = 0;
4971 }
4972 }
4973 pPager->stmtNRec = 0;
4974 pPager->stmtInUse = 0;
4975 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004976 }
drhac69b052004-05-12 13:30:07 +00004977 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004978 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004979 return SQLITE_OK;
4980}
4981
4982/*
drhac69b052004-05-12 13:30:07 +00004983** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004984*/
danielk19773b8a05f2007-03-19 17:44:26 +00004985int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004986 int rc;
drh86f8c192007-08-22 00:39:19 +00004987 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004988 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004989 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004990 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004991 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004992 PgHistory *pHist;
4993 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4994 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004995 if( pHist->pStmt ){
4996 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00004997 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004998 pHist->pStmt = 0;
4999 }
5000 }
5001 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00005002 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00005003 rc = SQLITE_OK;
5004 }else{
5005 rc = pager_stmt_playback(pPager);
5006 }
danielk19773b8a05f2007-03-19 17:44:26 +00005007 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00005008 }else{
5009 rc = SQLITE_OK;
5010 }
drhac69b052004-05-12 13:30:07 +00005011 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00005012 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00005013 return rc;
5014}
5015
drh73509ee2003-04-06 20:44:45 +00005016/*
5017** Return the full pathname of the database file.
5018*/
danielk19773b8a05f2007-03-19 17:44:26 +00005019const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00005020 return pPager->zFilename;
5021}
5022
drhb20ea9d2004-02-09 01:20:36 +00005023/*
drhd0679ed2007-08-28 22:24:34 +00005024** Return the VFS structure for the pager.
5025*/
5026const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
5027 return pPager->pVfs;
5028}
5029
5030/*
drhcc6bb3e2007-08-31 16:11:35 +00005031** Return the file handle for the database file associated
5032** with the pager. This might return NULL if the file has
5033** not yet been opened.
5034*/
5035sqlite3_file *sqlite3PagerFile(Pager *pPager){
5036 return pPager->fd;
5037}
5038
5039/*
danielk19775865e3d2004-06-14 06:03:57 +00005040** Return the directory of the database file.
5041*/
danielk19773b8a05f2007-03-19 17:44:26 +00005042const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005043 return pPager->zDirectory;
5044}
5045
5046/*
5047** Return the full pathname of the journal file.
5048*/
danielk19773b8a05f2007-03-19 17:44:26 +00005049const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005050 return pPager->zJournal;
5051}
5052
5053/*
drh2c8997b2005-08-27 16:36:48 +00005054** Return true if fsync() calls are disabled for this pager. Return FALSE
5055** if fsync()s are executed normally.
5056*/
danielk19773b8a05f2007-03-19 17:44:26 +00005057int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00005058 return pPager->noSync;
5059}
5060
drh7c4ac0c2007-04-05 11:25:58 +00005061#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00005062/*
drhb20ea9d2004-02-09 01:20:36 +00005063** Set the codec for this pager
5064*/
danielk19773b8a05f2007-03-19 17:44:26 +00005065void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00005066 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00005067 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00005068 void *pCodecArg
5069){
5070 pPager->xCodec = xCodec;
5071 pPager->pCodecArg = pCodecArg;
5072}
drh7c4ac0c2007-04-05 11:25:58 +00005073#endif
drhb20ea9d2004-02-09 01:20:36 +00005074
danielk1977687566d2004-11-02 12:56:41 +00005075#ifndef SQLITE_OMIT_AUTOVACUUM
5076/*
danielk197787c29a92008-01-18 11:33:16 +00005077** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00005078**
drh5e385312007-06-16 04:42:12 +00005079** There must be no references to the page previously located at
5080** pgno (which we call pPgOld) though that page is allowed to be
5081** in cache. If the page previous located at pgno is not already
5082** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00005083**
drh5e385312007-06-16 04:42:12 +00005084** References to the page pPg remain valid. Updating any
5085** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00005086** allocated along with the page) is the responsibility of the caller.
5087**
danielk19775fd057a2005-03-09 13:09:43 +00005088** A transaction must be active when this routine is called. It used to be
5089** required that a statement transaction was not active, but this restriction
5090** has been removed (CREATE INDEX needs to move a page when a statement
5091** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00005092*/
danielk19773b8a05f2007-03-19 17:44:26 +00005093int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00005094 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00005095 int h;
danielk197794daf7f2004-11-08 09:26:09 +00005096 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00005097
drh86f8c192007-08-22 00:39:19 +00005098 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005099 assert( pPg->nRef>0 );
5100
drh4f0c5872007-03-26 22:05:01 +00005101 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00005102 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00005103 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00005104
danielk1977b4626a32007-04-28 15:47:43 +00005105 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00005106 if( pPg->needSync ){
5107 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00005108 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00005109 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00005110 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00005111 }
5112
drh85b623f2007-12-13 21:54:09 +00005113 /* Unlink pPg from its hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00005114 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00005115
danielk1977ef73ee92004-11-06 12:26:07 +00005116 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00005117 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00005118 ** page pgno before the 'move' operation, it needs to be retained
5119 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00005120 */
drh5e385312007-06-16 04:42:12 +00005121 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00005122 pPgOld = pager_lookup(pPager, pgno);
5123 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00005124 assert( pPgOld->nRef==0 );
5125 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00005126 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00005127 pPg->needSync = pPgOld->needSync;
5128 }else{
5129 pPg->needSync = 0;
5130 }
drhf5e7bb52008-02-18 14:47:33 +00005131 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
danielk1977687566d2004-11-02 12:56:41 +00005132
danielk1977f5fdda82004-11-03 08:44:05 +00005133 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00005134 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00005135 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00005136 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00005137 if( pPager->aHash[h] ){
5138 assert( pPager->aHash[h]->pPrevHash==0 );
5139 pPager->aHash[h]->pPrevHash = pPg;
5140 }
5141 pPg->pNextHash = pPager->aHash[h];
5142 pPager->aHash[h] = pPg;
5143 pPg->pPrevHash = 0;
5144
drh605ad8f2006-05-03 23:34:05 +00005145 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00005146 pPager->dirtyCache = 1;
5147
danielk197794daf7f2004-11-08 09:26:09 +00005148 if( needSyncPgno ){
5149 /* If needSyncPgno is non-zero, then the journal file needs to be
5150 ** sync()ed before any data is written to database file page needSyncPgno.
5151 ** Currently, no such page exists in the page-cache and the
drhf5e7bb52008-02-18 14:47:33 +00005152 ** Pager.pInJournal bit has been set. This needs to be remedied by loading
danielk197794daf7f2004-11-08 09:26:09 +00005153 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00005154 **
danielk1977a98d7b42008-01-18 13:42:54 +00005155 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00005156 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00005157 ** array. Otherwise, if the page is loaded and written again in
5158 ** this transaction, it may be written to the database file before
5159 ** it is synced into the journal file. This way, it may end up in
5160 ** the journal file twice, but that is not a problem.
5161 **
danielk19773b8a05f2007-03-19 17:44:26 +00005162 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00005163 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00005164 */
5165 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005166 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00005167 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00005168 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00005169 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00005170 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
5171 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00005172 }
danielk197787c29a92008-01-18 11:33:16 +00005173 pagerLeave(pPager);
5174 return rc;
5175 }
danielk1977ae825582004-11-23 09:06:55 +00005176 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00005177 pPgHdr->needSync = 1;
5178 pPgHdr->inJournal = 1;
5179 makeDirty(pPgHdr);
5180 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005181 }
5182
drh86f8c192007-08-22 00:39:19 +00005183 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005184 return SQLITE_OK;
5185}
5186#endif
5187
danielk19773b8a05f2007-03-19 17:44:26 +00005188/*
5189** Return a pointer to the data for the specified page.
5190*/
5191void *sqlite3PagerGetData(DbPage *pPg){
5192 return PGHDR_TO_DATA(pPg);
5193}
5194
5195/*
5196** Return a pointer to the Pager.nExtra bytes of "extra" space
5197** allocated along with the specified page.
5198*/
5199void *sqlite3PagerGetExtra(DbPage *pPg){
5200 Pager *pPager = pPg->pPager;
5201 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
5202}
5203
danielk197741483462007-03-24 16:45:04 +00005204/*
5205** Get/set the locking-mode for this pager. Parameter eMode must be one
5206** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
5207** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
5208** the locking-mode is set to the value specified.
5209**
5210** The returned value is either PAGER_LOCKINGMODE_NORMAL or
5211** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
5212** locking-mode.
5213*/
5214int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00005215 assert( eMode==PAGER_LOCKINGMODE_QUERY
5216 || eMode==PAGER_LOCKINGMODE_NORMAL
5217 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
5218 assert( PAGER_LOCKINGMODE_QUERY<0 );
5219 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
5220 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00005221 pPager->exclusiveMode = eMode;
5222 }
5223 return (int)pPager->exclusiveMode;
5224}
5225
drh3b020132008-04-17 17:02:01 +00005226/*
5227** Get/set the journal-mode for this pager. Parameter eMode must be one
5228** of PAGER_JOURNALMODE_QUERY, PAGER_JOURNALMODE_DELETE or
5229** PAGER_JOURNALMODE_PERSIST. If the parameter is not _QUERY, then
5230** the journal-mode is set to the value specified.
5231**
5232** The returned value is either PAGER_JOURNALMODE_DELETE or
5233** PAGER_JOURNALMODE_PERSIST, indicating the current (possibly updated)
5234** journal-mode.
5235*/
5236int sqlite3PagerJournalMode(Pager *pPager, int eMode){
5237 assert( eMode==PAGER_JOURNALMODE_QUERY
5238 || eMode==PAGER_JOURNALMODE_DELETE
drhfdc40e92008-04-17 20:59:37 +00005239 || eMode==PAGER_JOURNALMODE_PERSIST
5240 || eMode==PAGER_JOURNALMODE_OFF );
drh3b020132008-04-17 17:02:01 +00005241 assert( PAGER_JOURNALMODE_QUERY<0 );
5242 assert( PAGER_JOURNALMODE_DELETE>=0 && PAGER_JOURNALMODE_PERSIST>=0 );
drhfdc40e92008-04-17 20:59:37 +00005243 if( eMode>=0 ){
5244 pPager->journalMode = eMode;
drh3b020132008-04-17 17:02:01 +00005245 }
drhfdc40e92008-04-17 20:59:37 +00005246 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00005247}
5248
drhd919fe12007-12-11 19:34:44 +00005249#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00005250/*
5251** Print a listing of all referenced pages and their ref count.
5252*/
danielk19773b8a05f2007-03-19 17:44:26 +00005253void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00005254 PgHdr *pPg;
5255 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
5256 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00005257 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
5258 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00005259 }
5260}
5261#endif
drh2e66f0b2005-04-28 17:18:48 +00005262
5263#endif /* SQLITE_OMIT_DISKIO */