blob: de95f5b9e95befa56798c39a99461dc60d1f595e [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**
danielk197781620542008-06-07 05:19:37 +000021** @(#) $Id: pager.c,v 1.455 2008/06/07 05:19:38 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 */
drhd138c012008-05-13 00:58:18 +0000354 u8 dbModified; /* True if there are any changes to the Db */
drh80e35f42007-03-30 14:06:34 +0000355 u8 changeCountDone; /* Set after incrementing the change-counter */
drh33f4e022007-09-03 15:19:34 +0000356 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000357 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000358 int dbSize; /* Number of pages in the file */
359 int origDbSize; /* dbSize before the current change */
360 int stmtSize; /* Size of database (in pages) at stmt_begin() */
361 int nRec; /* Number of pages written to the journal */
362 u32 cksumInit; /* Quasi-random value added to every checksum */
363 int stmtNRec; /* Number of records in stmt subjournal */
364 int nExtra; /* Add this many bytes to each in-memory page */
365 int pageSize; /* Number of bytes in a page */
366 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000367 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
368 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000369 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000370 Bitvec *pInJournal; /* One bit for each page in the database file */
371 Bitvec *pInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000372 char *zFilename; /* Name of the database file */
373 char *zJournal; /* Name of the journal file */
374 char *zDirectory; /* Directory hold database and journal files */
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 */
drh80105af2008-05-21 15:38:14 +0000403 volatile int iInUseMM; /* Non-zero if unavailable to MM */
404 volatile 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 */
danielk1977b53e4962008-06-04 06:45:59 +0000408 i64 journalSizeLimit; /* Size limit for persistent journal files */
drhd9b02572001-04-15 00:37:09 +0000409};
410
411/*
drh538f5702007-04-13 02:14:30 +0000412** The following global variables hold counters used for
413** testing purposes only. These variables do not exist in
414** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000415*/
416#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000417int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
418int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
419int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
420int sqlite3_pager_pgfree_count = 0; /* Number of cache pages freed */
421# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000422#else
drh538f5702007-04-13 02:14:30 +0000423# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000424#endif
425
drh86f8c192007-08-22 00:39:19 +0000426/*
427** The following variable points to the head of a double-linked list
428** of all pagers that are eligible for page stealing by the
429** sqlite3_release_memory() interface. Access to this list is
430** protected by the SQLITE_MUTEX_STATIC_MEM2 mutex.
431*/
432#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
433static Pager *sqlite3PagerList = 0;
danielk19779f61c2f2007-08-27 17:27:49 +0000434static PagerLruList sqlite3LruPageList = {0, 0, 0};
drh86f8c192007-08-22 00:39:19 +0000435#endif
drh538f5702007-04-13 02:14:30 +0000436
437
drhfcd35c72005-05-21 02:48:08 +0000438/*
drh5e00f6c2001-09-13 13:46:56 +0000439** Journal files begin with the following magic string. The data
440** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000441**
drhae2b40c2004-06-09 19:03:54 +0000442** Since version 2.8.0, the journal format contains additional sanity
443** checking information. If the power fails while the journal is begin
444** written, semi-random garbage data might appear in the journal
445** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000446** to roll the journal back, the database could be corrupted. The additional
447** sanity checking data is an attempt to discover the garbage in the
448** journal and ignore it.
449**
drhae2b40c2004-06-09 19:03:54 +0000450** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000451** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000452** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000453** This cksum is initialized to a 32-bit random value that appears in the
454** journal file right after the header. The random initializer is important,
455** because garbage data that appears at the end of a journal is likely
456** data that was once in other files that have now been deleted. If the
457** garbage data came from an obsolete journal file, the checksums might
458** be correct. But by initializing the checksum to random value which
459** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000460*/
drhae2b40c2004-06-09 19:03:54 +0000461static const unsigned char aJournalMagic[] = {
462 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000463};
464
465/*
drh726de592004-06-10 23:35:50 +0000466** The size of the header and of each page in the journal is determined
467** by the following macros.
drh968af522003-02-11 14:55:40 +0000468*/
drhae2b40c2004-06-09 19:03:54 +0000469#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000470
danielk197776572402004-06-25 02:38:54 +0000471/*
472** The journal header size for this pager. In the future, this could be
473** set to some value read from the disk controller. The important
474** characteristic is that it is the same size as a disk sector.
475*/
476#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
477
drhb7f91642004-10-31 02:22:47 +0000478/*
479** The macro MEMDB is true if we are dealing with an in-memory database.
480** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
481** the value of MEMDB will be a constant and the compiler will optimize
482** out code that would never execute.
483*/
484#ifdef SQLITE_OMIT_MEMORYDB
485# define MEMDB 0
486#else
487# define MEMDB pPager->memDb
488#endif
489
490/*
danielk197776572402004-06-25 02:38:54 +0000491** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
492** reserved for working around a windows/posix incompatibility). It is
493** used in the journal to signify that the remainder of the journal file
494** is devoted to storing a master journal name - there are no more pages to
495** roll back. See comments for function writeMasterJournal() for details.
496*/
danielk1977599fcba2004-11-08 07:13:13 +0000497/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
498#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000499
drh968af522003-02-11 14:55:40 +0000500/*
danielk197726836652005-01-17 01:33:13 +0000501** The maximum legal page number is (2^31 - 1).
502*/
503#define PAGER_MAX_PGNO 2147483647
504
505/*
drh86f8c192007-08-22 00:39:19 +0000506** The pagerEnter() and pagerLeave() routines acquire and release
507** a mutex on each pager. The mutex is recursive.
508**
509** This is a special-purpose mutex. It only provides mutual exclusion
510** between the Btree and the Memory Management sqlite3_release_memory()
511** function. It does not prevent, for example, two Btrees from accessing
512** the same pager at the same time. Other general-purpose mutexes in
513** the btree layer handle that chore.
514*/
515#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
516 static void pagerEnter(Pager *p){
517 p->iInUseDB++;
518 if( p->iInUseMM && p->iInUseDB==1 ){
drh26e4a8b2008-05-01 17:16:52 +0000519#ifndef SQLITE_MUTEX_NOOP
drh64e2bb72008-05-07 12:29:55 +0000520 sqlite3_mutex *mutex;
drh86f8c192007-08-22 00:39:19 +0000521 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +0000522#endif
drh86f8c192007-08-22 00:39:19 +0000523 p->iInUseDB = 0;
524 sqlite3_mutex_enter(mutex);
525 p->iInUseDB = 1;
526 sqlite3_mutex_leave(mutex);
527 }
528 assert( p->iInUseMM==0 );
529 }
530 static void pagerLeave(Pager *p){
531 p->iInUseDB--;
532 assert( p->iInUseDB>=0 );
533 }
534#else
535# define pagerEnter(X)
536# define pagerLeave(X)
537#endif
538
539/*
danielk197784f786f2007-08-28 08:00:17 +0000540** Add page pPg to the end of the linked list managed by structure
541** pList (pPg becomes the last entry in the list - the most recently
542** used). Argument pLink should point to either pPg->free or pPg->gfree,
543** depending on whether pPg is being added to the pager-specific or
544** global LRU list.
545*/
danielk19779f61c2f2007-08-27 17:27:49 +0000546static void listAdd(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
547 pLink->pNext = 0;
548 pLink->pPrev = pList->pLast;
549
danielk197784f786f2007-08-28 08:00:17 +0000550#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
551 assert(pLink==&pPg->free || pLink==&pPg->gfree);
552 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
553#endif
554
danielk19779f61c2f2007-08-27 17:27:49 +0000555 if( pList->pLast ){
556 int iOff = (char *)pLink - (char *)pPg;
557 PagerLruLink *pLastLink = (PagerLruLink *)(&((u8 *)pList->pLast)[iOff]);
558 pLastLink->pNext = pPg;
559 }else{
560 assert(!pList->pFirst);
561 pList->pFirst = pPg;
562 }
563
564 pList->pLast = pPg;
565 if( !pList->pFirstSynced && pPg->needSync==0 ){
566 pList->pFirstSynced = pPg;
567 }
568}
569
danielk197784f786f2007-08-28 08:00:17 +0000570/*
571** Remove pPg from the list managed by the structure pointed to by pList.
572**
573** Argument pLink should point to either pPg->free or pPg->gfree, depending
574** on whether pPg is being added to the pager-specific or global LRU list.
575*/
danielk19779f61c2f2007-08-27 17:27:49 +0000576static void listRemove(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
577 int iOff = (char *)pLink - (char *)pPg;
578
danielk197784f786f2007-08-28 08:00:17 +0000579#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
580 assert(pLink==&pPg->free || pLink==&pPg->gfree);
581 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
582#endif
583
danielk19779f61c2f2007-08-27 17:27:49 +0000584 if( pPg==pList->pFirst ){
585 pList->pFirst = pLink->pNext;
586 }
587 if( pPg==pList->pLast ){
588 pList->pLast = pLink->pPrev;
589 }
590 if( pLink->pPrev ){
591 PagerLruLink *pPrevLink = (PagerLruLink *)(&((u8 *)pLink->pPrev)[iOff]);
592 pPrevLink->pNext = pLink->pNext;
593 }
594 if( pLink->pNext ){
595 PagerLruLink *pNextLink = (PagerLruLink *)(&((u8 *)pLink->pNext)[iOff]);
596 pNextLink->pPrev = pLink->pPrev;
597 }
598 if( pPg==pList->pFirstSynced ){
599 PgHdr *p = pLink->pNext;
600 while( p && p->needSync ){
601 PagerLruLink *pL = (PagerLruLink *)(&((u8 *)p)[iOff]);
602 p = pL->pNext;
603 }
604 pList->pFirstSynced = p;
605 }
606
607 pLink->pNext = pLink->pPrev = 0;
608}
609
610/*
danielk197784f786f2007-08-28 08:00:17 +0000611** Add page pPg to the list of free pages for the pager. If
612** memory-management is enabled, also add the page to the global
613** list of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000614*/
615static void lruListAdd(PgHdr *pPg){
616 listAdd(&pPg->pPager->lru, &pPg->free, pPg);
617#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
618 if( !pPg->pPager->memDb ){
619 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
620 listAdd(&sqlite3LruPageList, &pPg->gfree, pPg);
621 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
622 }
623#endif
624}
625
626/*
danielk197784f786f2007-08-28 08:00:17 +0000627** Remove page pPg from the list of free pages for the associated pager.
628** If memory-management is enabled, also remove pPg from the global list
629** of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000630*/
631static void lruListRemove(PgHdr *pPg){
632 listRemove(&pPg->pPager->lru, &pPg->free, pPg);
633#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
634 if( !pPg->pPager->memDb ){
635 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
636 listRemove(&sqlite3LruPageList, &pPg->gfree, pPg);
637 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
638 }
639#endif
640}
641
642/*
danielk197784f786f2007-08-28 08:00:17 +0000643** This function is called just after the needSync flag has been cleared
644** from all pages managed by pPager (usually because the journal file
645** has just been synced). It updates the pPager->lru.pFirstSynced variable
646** and, if memory-management is enabled, the sqlite3LruPageList.pFirstSynced
647** variable also.
danielk19779f61c2f2007-08-27 17:27:49 +0000648*/
649static void lruListSetFirstSynced(Pager *pPager){
650 pPager->lru.pFirstSynced = pPager->lru.pFirst;
651#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
652 if( !pPager->memDb ){
653 PgHdr *p;
654 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
655 for(p=sqlite3LruPageList.pFirst; p && p->needSync; p=p->gfree.pNext);
656 assert(p==pPager->lru.pFirstSynced || p==sqlite3LruPageList.pFirstSynced);
657 sqlite3LruPageList.pFirstSynced = p;
658 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
659 }
660#endif
661}
662
danielk1977f35843b2007-04-07 15:03:17 +0000663/*
664** Return true if page *pPg has already been written to the statement
665** journal (or statement snapshot has been created, if *pPg is part
666** of an in-memory database).
667*/
668static int pageInStatement(PgHdr *pPg){
669 Pager *pPager = pPg->pPager;
670 if( MEMDB ){
671 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
672 }else{
drhf5e7bb52008-02-18 14:47:33 +0000673 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000674 }
675}
drh8ca0c722006-05-07 17:49:38 +0000676
677/*
678** Change the size of the pager hash table to N. N must be a power
679** of two.
680*/
681static void pager_resize_hash_table(Pager *pPager, int N){
682 PgHdr **aHash, *pPg;
683 assert( N>0 && (N&(N-1))==0 );
drheee4c8c2008-02-18 22:24:57 +0000684#ifdef SQLITE_MALLOC_SOFT_LIMIT
685 if( N*sizeof(aHash[0])>SQLITE_MALLOC_SOFT_LIMIT ){
686 N = SQLITE_MALLOC_SOFT_LIMIT/sizeof(aHash[0]);
687 }
688 if( N==pPager->nHash ) return;
689#endif
drhed138fb2007-08-22 22:04:37 +0000690 pagerLeave(pPager);
drh4873d5f2008-05-13 13:27:33 +0000691 if( pPager->aHash!=0 ) sqlite3FaultBeginBenign(SQLITE_FAULTINJECTOR_MALLOC);
drh17435752007-08-16 04:30:38 +0000692 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drh4873d5f2008-05-13 13:27:33 +0000693 if( pPager->aHash!=0 ) sqlite3FaultEndBenign(SQLITE_FAULTINJECTOR_MALLOC);
drhed138fb2007-08-22 22:04:37 +0000694 pagerEnter(pPager);
drh8ca0c722006-05-07 17:49:38 +0000695 if( aHash==0 ){
696 /* Failure to rehash is not an error. It is only a performance hit. */
697 return;
698 }
drh17435752007-08-16 04:30:38 +0000699 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000700 pPager->nHash = N;
701 pPager->aHash = aHash;
702 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000703 int h;
704 if( pPg->pgno==0 ){
705 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
706 continue;
707 }
708 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000709 pPg->pNextHash = aHash[h];
710 if( aHash[h] ){
711 aHash[h]->pPrevHash = pPg;
712 }
713 aHash[h] = pPg;
714 pPg->pPrevHash = 0;
715 }
716}
717
drhdd793422001-06-28 01:54:48 +0000718/*
drh34e79ce2004-02-08 06:05:46 +0000719** Read a 32-bit integer from the given file descriptor. Store the integer
720** that is read in *pRes. Return SQLITE_OK if everything worked, or an
721** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000722**
723** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000724*/
danielk197762079062007-08-15 17:08:46 +0000725static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000726 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000727 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000728 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000729 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000730 }
drh94f33312002-08-12 12:29:56 +0000731 return rc;
732}
733
734/*
drh97b57482006-01-10 20:32:32 +0000735** Write a 32-bit integer into a string buffer in big-endian byte order.
736*/
drha3152892007-05-05 11:48:52 +0000737#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000738
739/*
drh34e79ce2004-02-08 06:05:46 +0000740** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
741** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000742*/
danielk197762079062007-08-15 17:08:46 +0000743static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000744 char ac[4];
drh97b57482006-01-10 20:32:32 +0000745 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000746 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000747}
748
drh2554f8b2003-01-22 01:26:44 +0000749/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000750** If file pFd is open, call sqlite3OsUnlock() on it.
751*/
752static int osUnlock(sqlite3_file *pFd, int eLock){
753 if( !pFd->pMethods ){
754 return SQLITE_OK;
755 }
756 return sqlite3OsUnlock(pFd, eLock);
757}
758
759/*
danielk1977c7b60172007-08-22 11:22:03 +0000760** This function determines whether or not the atomic-write optimization
761** can be used with this pager. The optimization can be used if:
762**
763** (a) the value returned by OsDeviceCharacteristics() indicates that
764** a database page may be written atomically, and
765** (b) the value returned by OsSectorSize() is less than or equal
766** to the page size.
767**
768** If the optimization cannot be used, 0 is returned. If it can be used,
769** then the value returned is the size of the journal file when it
770** contains rollback data for exactly one page.
771*/
772#ifdef SQLITE_ENABLE_ATOMIC_WRITE
773static int jrnlBufferSize(Pager *pPager){
774 int dc; /* Device characteristics */
775 int nSector; /* Sector size */
776 int nPage; /* Page size */
777 sqlite3_file *fd = pPager->fd;
778
779 if( fd->pMethods ){
780 dc = sqlite3OsDeviceCharacteristics(fd);
781 nSector = sqlite3OsSectorSize(fd);
782 nPage = pPager->pageSize;
783 }
784
785 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
786 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
787
danielk1977f8940ae2007-08-23 11:07:10 +0000788 if( !fd->pMethods || (dc&(SQLITE_IOCAP_ATOMIC|(nPage>>8))&&nSector<=nPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000789 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
790 }
791 return 0;
792}
793#endif
794
795/*
danielk1977aef0bf62005-12-30 16:28:01 +0000796** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000797** code. The first argument is a pointer to the pager structure, the
798** second the error-code about to be returned by a pager API function.
799** The value returned is a copy of the second argument to this function.
800**
drh4f0ee682007-03-30 20:43:40 +0000801** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000802** the error becomes persistent. Until the persisten error is cleared,
803** subsequent API calls on this Pager will immediately return the same
804** error code.
805**
806** A persistent error indicates that the contents of the pager-cache
807** cannot be trusted. This state can be cleared by completely discarding
808** the contents of the pager-cache. If a transaction was active when
809** the persistent error occured, then the rollback journal may need
810** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000811*/
danielk1977ae72d982007-10-03 08:46:44 +0000812static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000813static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000814 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000815 assert(
816 pPager->errCode==SQLITE_FULL ||
817 pPager->errCode==SQLITE_OK ||
818 (pPager->errCode & 0xff)==SQLITE_IOERR
819 );
danielk1977979f38e2007-03-27 16:19:51 +0000820 if(
drh4ac285a2006-09-15 07:28:50 +0000821 rc2==SQLITE_FULL ||
822 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000823 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000824 ){
825 pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000826 if( pPager->state==PAGER_UNLOCK && pPager->nRef==0 ){
827 /* If the pager is already unlocked, call pager_unlock() now to
828 ** clear the error state and ensure that the pager-cache is
829 ** completely empty.
830 */
831 pager_unlock(pPager);
832 }
danielk1977aef0bf62005-12-30 16:28:01 +0000833 }
834 return rc;
835}
836
drh477731b2007-06-16 03:06:27 +0000837/*
838** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
839** on the cache using a hash function. This is used for testing
840** and debugging only.
841*/
danielk19773c407372005-02-15 02:54:14 +0000842#ifdef SQLITE_CHECK_PAGES
843/*
844** Return a 32-bit hash of the page data for pPage.
845*/
drh477731b2007-06-16 03:06:27 +0000846static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000847 u32 hash = 0;
848 int i;
drh477731b2007-06-16 03:06:27 +0000849 for(i=0; i<nByte; i++){
850 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000851 }
852 return hash;
853}
drh477731b2007-06-16 03:06:27 +0000854static u32 pager_pagehash(PgHdr *pPage){
855 return pager_datahash(pPage->pPager->pageSize,
856 (unsigned char *)PGHDR_TO_DATA(pPage));
857}
danielk19773c407372005-02-15 02:54:14 +0000858
859/*
860** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
861** is defined, and NDEBUG is not defined, an assert() statement checks
862** that the page is either dirty or still matches the calculated page-hash.
863*/
864#define CHECK_PAGE(x) checkPage(x)
865static void checkPage(PgHdr *pPg){
866 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000867 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000868 pPg->pageHash==pager_pagehash(pPg) );
869}
870
871#else
drh8ffa8172007-06-18 17:25:17 +0000872#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000873#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000874#define CHECK_PAGE(x)
875#endif
876
drhed7c8552001-04-11 14:29:21 +0000877/*
danielk197776572402004-06-25 02:38:54 +0000878** When this is called the journal file for pager pPager must be open.
879** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000880** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000881**
danielk197765839c62007-08-30 08:08:17 +0000882** zMaster must point to a buffer of at least nMaster bytes allocated by
883** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
884** enough space to write the master journal name). If the master journal
885** name in the journal is longer than nMaster bytes (including a
886** nul-terminator), then this is handled as if no master journal name
887** were present in the journal.
888**
889** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000890** SQLITE_OK returned.
891*/
danielk197765839c62007-08-30 08:08:17 +0000892static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000893 int rc;
894 u32 len;
drheb206252004-10-01 02:00:31 +0000895 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000896 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000897 int i;
danielk197776572402004-06-25 02:38:54 +0000898 unsigned char aMagic[8]; /* A buffer to hold the magic header */
899
danielk197765839c62007-08-30 08:08:17 +0000900 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000901
drh054889e2005-11-30 03:20:31 +0000902 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000903 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000904
danielk197762079062007-08-15 17:08:46 +0000905 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000906 if( rc!=SQLITE_OK ) return rc;
907
danielk197765839c62007-08-30 08:08:17 +0000908 if( len>=nMaster ){
909 return SQLITE_OK;
910 }
911
danielk197762079062007-08-15 17:08:46 +0000912 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000913 if( rc!=SQLITE_OK ) return rc;
914
danielk197762079062007-08-15 17:08:46 +0000915 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000916 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
917
danielk197765839c62007-08-30 08:08:17 +0000918 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000919 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000920 return rc;
921 }
danielk197765839c62007-08-30 08:08:17 +0000922 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000923
924 /* See if the checksum matches the master journal name */
925 for(i=0; i<len; i++){
danielk197765839c62007-08-30 08:08:17 +0000926 cksum -= zMaster[i];
927 }
danielk19778191bff2004-06-28 04:52:30 +0000928 if( cksum ){
929 /* If the checksum doesn't add up, then one or more of the disk sectors
930 ** containing the master journal filename is corrupted. This means
931 ** definitely roll back, so just return SQLITE_OK and report a (nul)
932 ** master-journal filename.
933 */
danielk197765839c62007-08-30 08:08:17 +0000934 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000935 }
danielk197776572402004-06-25 02:38:54 +0000936
937 return SQLITE_OK;
938}
939
940/*
941** Seek the journal file descriptor to the next sector boundary where a
942** journal header may be read or written. Pager.journalOff is updated with
943** the new seek offset.
944**
945** i.e for a sector size of 512:
946**
947** Input Offset Output Offset
948** ---------------------------------------
949** 0 0
950** 512 512
951** 100 512
952** 2000 2048
953**
954*/
danielk197762079062007-08-15 17:08:46 +0000955static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000956 i64 offset = 0;
957 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000958 if( c ){
959 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
960 }
961 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
962 assert( offset>=c );
963 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
964 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000965}
966
967/*
drhf3a87622008-04-17 14:16:42 +0000968** Write zeros over the header of the journal file. This has the
969** effect of invalidating the journal file and committing the
970** transaction.
971*/
danielk1977df2566a2008-05-07 19:11:03 +0000972static int zeroJournalHdr(Pager *pPager, int doTruncate){
973 int rc = SQLITE_OK;
drhf3a87622008-04-17 14:16:42 +0000974 static const char zeroHdr[28];
975
danielk1977df2566a2008-05-07 19:11:03 +0000976 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000977 i64 iLimit = pPager->journalSizeLimit;
978
danielk1977df2566a2008-05-07 19:11:03 +0000979 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000980 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000981 rc = sqlite3OsTruncate(pPager->jfd, 0);
982 }else{
983 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
984 }
danielk197781620542008-06-07 05:19:37 +0000985 if( rc==SQLITE_OK && !pPager->noSync ){
danielk1977df2566a2008-05-07 19:11:03 +0000986 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
987 }
danielk1977b53e4962008-06-04 06:45:59 +0000988
989 /* At this point the transaction is committed but the write lock
990 ** is still held on the file. If there is a size limit configured for
991 ** the persistent journal and the journal file currently consumes more
992 ** space than that limit allows for, truncate it now. There is no need
993 ** to sync the file following this operation.
994 */
995 if( rc==SQLITE_OK && iLimit>0 ){
996 i64 sz;
997 rc = sqlite3OsFileSize(pPager->jfd, &sz);
998 if( rc==SQLITE_OK && sz>iLimit ){
999 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
1000 }
1001 }
drha06ecba2008-04-22 17:15:17 +00001002 }
drhf3a87622008-04-17 14:16:42 +00001003 return rc;
1004}
1005
1006/*
danielk197776572402004-06-25 02:38:54 +00001007** The journal file must be open when this routine is called. A journal
1008** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
1009** current location.
1010**
1011** The format for the journal header is as follows:
1012** - 8 bytes: Magic identifying journal format.
1013** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
1014** - 4 bytes: Random number used for page hash.
1015** - 4 bytes: Initial database page count.
1016** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +00001017** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +00001018**
danielk197767c007b2008-03-20 04:45:49 +00001019** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +00001020*/
1021static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +00001022 int rc = SQLITE_OK;
1023 char *zHeader = pPager->pTmpSpace;
1024 int nHeader = pPager->pageSize;
1025 int nWrite;
1026
1027 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
1028 nHeader = JOURNAL_HDR_SZ(pPager);
1029 }
danielk197776572402004-06-25 02:38:54 +00001030
danielk19774099f6e2007-03-19 11:25:20 +00001031 if( pPager->stmtHdrOff==0 ){
1032 pPager->stmtHdrOff = pPager->journalOff;
1033 }
1034
danielk197762079062007-08-15 17:08:46 +00001035 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001036 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001037
drh97b57482006-01-10 20:32:32 +00001038 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +00001039
1040 /*
1041 ** Write the nRec Field - the number of page records that follow this
1042 ** journal header. Normally, zero is written to this value at this time.
1043 ** After the records are added to the journal (and the journal synced,
1044 ** if in full-sync mode), the zero is overwritten with the true number
1045 ** of records (see syncJournal()).
1046 **
1047 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
1048 ** reading the journal this value tells SQLite to assume that the
1049 ** rest of the journal file contains valid page records. This assumption
1050 ** is dangerous, as if a failure occured whilst writing to the journal
1051 ** file it may contain some garbage data. There are two scenarios
1052 ** where this risk can be ignored:
1053 **
1054 ** * When the pager is in no-sync mode. Corruption can follow a
1055 ** power failure in this case anyway.
1056 **
1057 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
1058 ** that garbage data is never appended to the journal file.
1059 */
1060 assert(pPager->fd->pMethods||pPager->noSync);
1061 if( (pPager->noSync)
1062 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
1063 ){
1064 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
1065 }else{
1066 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
1067 }
1068
drh97b57482006-01-10 20:32:32 +00001069 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +00001070 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +00001071 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
1072 /* The initial database size */
1073 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
1074 /* The assumed sector size for this process */
1075 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +00001076 if( pPager->journalHdr==0 ){
1077 /* The page size */
1078 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
1079 }
danielk197776572402004-06-25 02:38:54 +00001080
danielk1977a664f8e2008-04-22 14:31:48 +00001081 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
1082 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
1083 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
1084 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +00001085 }
danielk1977a664f8e2008-04-22 14:31:48 +00001086
danielk197776572402004-06-25 02:38:54 +00001087 return rc;
1088}
1089
1090/*
1091** The journal file must be open when this is called. A journal header file
1092** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
1093** file. See comments above function writeJournalHdr() for a description of
1094** the journal header format.
1095**
1096** If the header is read successfully, *nRec is set to the number of
1097** page records following this header and *dbSize is set to the size of the
1098** database before the transaction began, in pages. Also, pPager->cksumInit
1099** is set to the value read from the journal header. SQLITE_OK is returned
1100** in this case.
1101**
1102** If the journal header file appears to be corrupted, SQLITE_DONE is
1103** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
1104** cannot be read from the journal file an error code is returned.
1105*/
1106static int readJournalHdr(
1107 Pager *pPager,
drheb206252004-10-01 02:00:31 +00001108 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +00001109 u32 *pNRec,
1110 u32 *pDbSize
1111){
1112 int rc;
1113 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +00001114 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +00001115 int iPageSize;
danielk197776572402004-06-25 02:38:54 +00001116
danielk197762079062007-08-15 17:08:46 +00001117 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001118 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
1119 return SQLITE_DONE;
1120 }
danielk197762079062007-08-15 17:08:46 +00001121 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001122
danielk197762079062007-08-15 17:08:46 +00001123 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001124 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +00001125 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +00001126
1127 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
1128 return SQLITE_DONE;
1129 }
1130
danielk197762079062007-08-15 17:08:46 +00001131 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +00001132 if( rc ) return rc;
1133
danielk197762079062007-08-15 17:08:46 +00001134 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +00001135 if( rc ) return rc;
1136
danielk197762079062007-08-15 17:08:46 +00001137 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +00001138 if( rc ) return rc;
1139
danielk197767c007b2008-03-20 04:45:49 +00001140 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
1141 if( rc==SQLITE_OK
1142 && iPageSize>=512
1143 && iPageSize<=SQLITE_MAX_PAGE_SIZE
1144 && ((iPageSize-1)&iPageSize)==0
1145 ){
1146 u16 pagesize = iPageSize;
1147 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
1148 }
1149 if( rc ) return rc;
1150
danielk197776572402004-06-25 02:38:54 +00001151 /* Update the assumed sector-size to match the value used by
1152 ** the process that created this journal. If this journal was
1153 ** created by a process other than this one, then this routine
1154 ** is being called from within pager_playback(). The local value
1155 ** of Pager.sectorSize is restored at the end of that routine.
1156 */
danielk197762079062007-08-15 17:08:46 +00001157 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +00001158 if( rc ) return rc;
1159
1160 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +00001161 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +00001162}
1163
1164
1165/*
1166** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +00001167** pPager at the current location. The master journal name must be the last
1168** thing written to a journal file. If the pager is in full-sync mode, the
1169** journal file descriptor is advanced to the next sector boundary before
1170** anything is written. The format is:
1171**
1172** + 4 bytes: PAGER_MJ_PGNO.
1173** + N bytes: length of master journal name.
1174** + 4 bytes: N
1175** + 4 bytes: Master journal name checksum.
1176** + 8 bytes: aJournalMagic[].
1177**
1178** The master journal page checksum is the sum of the bytes in the master
1179** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +00001180**
1181** If zMaster is a NULL pointer (occurs for a single database transaction),
1182** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +00001183*/
1184static int writeMasterJournal(Pager *pPager, const char *zMaster){
1185 int rc;
1186 int len;
danielk1977cafadba2004-06-25 11:11:54 +00001187 int i;
danielk197762079062007-08-15 17:08:46 +00001188 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +00001189 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +00001190 u32 cksum = 0;
1191 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +00001192
1193 if( !zMaster || pPager->setMaster) return SQLITE_OK;
1194 pPager->setMaster = 1;
1195
1196 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +00001197 for(i=0; i<len; i++){
1198 cksum += zMaster[i];
1199 }
danielk197776572402004-06-25 02:38:54 +00001200
1201 /* If in full-sync mode, advance to the next disk sector before writing
1202 ** the master journal name. This is in case the previous page written to
1203 ** the journal has already been synced.
1204 */
1205 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +00001206 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001207 }
danielk197762079062007-08-15 17:08:46 +00001208 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +00001209 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +00001210
danielk197762079062007-08-15 17:08:46 +00001211 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +00001212 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001213 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +00001214
danielk197762079062007-08-15 17:08:46 +00001215 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001216 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001217 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +00001218
drh97b57482006-01-10 20:32:32 +00001219 put32bits(zBuf, len);
1220 put32bits(&zBuf[4], cksum);
1221 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +00001222 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +00001223 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +00001224 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +00001225
1226 /* If the pager is in peristent-journal mode, then the physical
1227 ** journal-file may extend past the end of the master-journal name
1228 ** and 8 bytes of magic data just written to the file. This is
1229 ** dangerous because the code to rollback a hot-journal file
1230 ** will not be able to find the master-journal name to determine
1231 ** whether or not the journal is hot.
1232 **
1233 ** Easiest thing to do in this scenario is to truncate the journal
1234 ** file to the required size.
1235 */
1236 if( (rc==SQLITE_OK)
1237 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
1238 && jrnlSize>jrnlOff
1239 ){
1240 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
1241 }
danielk197776572402004-06-25 02:38:54 +00001242 return rc;
1243}
1244
1245/*
drh03eb96a2002-11-10 23:32:56 +00001246** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +00001247** statement journal.
drh03eb96a2002-11-10 23:32:56 +00001248**
1249** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +00001250** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +00001251** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +00001252** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +00001253*/
drh3aac2dd2004-04-26 14:10:20 +00001254static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +00001255 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +00001256 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1257 assert( MEMDB );
1258 if( !pHist->inStmt ){
1259 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
1260 if( pPager->pStmt ){
1261 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
1262 }
1263 pHist->pNextStmt = pPager->pStmt;
1264 pPager->pStmt = pPg;
1265 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +00001266 }
drh03eb96a2002-11-10 23:32:56 +00001267}
1268
1269/*
drhed7c8552001-04-11 14:29:21 +00001270** Find a page in the hash table given its page number. Return
1271** a pointer to the page or NULL if not found.
1272*/
drhd9b02572001-04-15 00:37:09 +00001273static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +00001274 PgHdr *p;
1275 if( pPager->aHash==0 ) return 0;
1276 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +00001277 while( p && p->pgno!=pgno ){
1278 p = p->pNextHash;
1279 }
1280 return p;
1281}
1282
1283/*
danielk1977e180dd92007-04-05 17:15:52 +00001284** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +00001285** sets the state of the pager back to what it was when it was first
1286** opened. Any outstanding pages are invalidated and subsequent attempts
1287** to access those pages will likely result in a coredump.
1288*/
drhd9b02572001-04-15 00:37:09 +00001289static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00001290 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +00001291 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +00001292 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +00001293 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
1294 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +00001295 pNext = pPg->pNextAll;
danielk19779f61c2f2007-08-27 17:27:49 +00001296 lruListRemove(pPg);
drh0d180202008-02-14 23:26:56 +00001297 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00001298 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +00001299 }
danielk19779f61c2f2007-08-27 17:27:49 +00001300 assert(pPager->lru.pFirst==0);
1301 assert(pPager->lru.pFirstSynced==0);
1302 assert(pPager->lru.pLast==0);
danielk1977b94bf852007-03-19 13:53:37 +00001303 pPager->pStmt = 0;
drhd9b02572001-04-15 00:37:09 +00001304 pPager->pAll = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001305 pPager->pDirty = 0;
drh8ca0c722006-05-07 17:49:38 +00001306 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +00001307 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +00001308 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +00001309 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +00001310 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +00001311}
1312
1313/*
danielk1977ae72d982007-10-03 08:46:44 +00001314** Unlock the database file.
1315**
1316** If the pager is currently in error state, discard the contents of
1317** the cache and reset the Pager structure internal state. If there is
1318** an open journal-file, then the next time a shared-lock is obtained
1319** on the pager file (by this or any other process), it will be
1320** treated as a hot-journal and rolled back.
1321*/
1322static void pager_unlock(Pager *pPager){
1323 if( !pPager->exclusiveMode ){
1324 if( !MEMDB ){
drh1aa5af12008-03-07 19:51:14 +00001325 int rc = osUnlock(pPager->fd, NO_LOCK);
drh308aa322008-03-07 20:14:38 +00001326 if( rc ) pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +00001327 pPager->dbSize = -1;
1328 IOTRACE(("UNLOCK %p\n", pPager))
1329
drh16e45a42008-04-19 20:34:18 +00001330 /* Always close the journal file when dropping the database lock.
1331 ** Otherwise, another connection with journal_mode=delete might
1332 ** delete the file out from under us.
1333 */
1334 if( pPager->journalOpen ){
1335 sqlite3OsClose(pPager->jfd);
1336 pPager->journalOpen = 0;
1337 sqlite3BitvecDestroy(pPager->pInJournal);
1338 pPager->pInJournal = 0;
1339 }
1340
danielk1977ae72d982007-10-03 08:46:44 +00001341 /* If Pager.errCode is set, the contents of the pager cache cannot be
1342 ** trusted. Now that the pager file is unlocked, the contents of the
1343 ** cache can be discarded and the error code safely cleared.
1344 */
1345 if( pPager->errCode ){
drh1aa5af12008-03-07 19:51:14 +00001346 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00001347 pager_reset(pPager);
1348 if( pPager->stmtOpen ){
1349 sqlite3OsClose(pPager->stfd);
drhf5e7bb52008-02-18 14:47:33 +00001350 sqlite3BitvecDestroy(pPager->pInStmt);
1351 pPager->pInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001352 }
danielk1977ae72d982007-10-03 08:46:44 +00001353 pPager->stmtOpen = 0;
1354 pPager->stmtInUse = 0;
1355 pPager->journalOff = 0;
1356 pPager->journalStarted = 0;
1357 pPager->stmtAutoopen = 0;
1358 pPager->origDbSize = 0;
1359 }
1360 }
1361
1362 if( !MEMDB || pPager->errCode==SQLITE_OK ){
1363 pPager->state = PAGER_UNLOCK;
1364 pPager->changeCountDone = 0;
1365 }
1366 }
1367}
1368
1369/*
1370** Execute a rollback if a transaction is active and unlock the
1371** database file. If the pager has already entered the error state,
1372** do not attempt the rollback.
1373*/
1374static void pagerUnlockAndRollback(Pager *p){
drhfdc40e92008-04-17 20:59:37 +00001375 /* assert( p->state>=PAGER_RESERVED || p->journalOpen==0 ); */
danielk1977ae72d982007-10-03 08:46:44 +00001376 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
drh4873d5f2008-05-13 13:27:33 +00001377 sqlite3FaultBeginBenign(-1);
danielk1977ae72d982007-10-03 08:46:44 +00001378 sqlite3PagerRollback(p);
drh4873d5f2008-05-13 13:27:33 +00001379 sqlite3FaultEndBenign(-1);
danielk1977ae72d982007-10-03 08:46:44 +00001380 }
1381 pager_unlock(p);
drhfdc40e92008-04-17 20:59:37 +00001382#if 0
danielk1977ae72d982007-10-03 08:46:44 +00001383 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
1384 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drhfdc40e92008-04-17 20:59:37 +00001385#endif
danielk1977ae72d982007-10-03 08:46:44 +00001386}
1387
1388/*
drh80e35f42007-03-30 14:06:34 +00001389** This routine ends a transaction. A transaction is ended by either
1390** a COMMIT or a ROLLBACK.
1391**
drhed7c8552001-04-11 14:29:21 +00001392** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001393** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1394** the database lock and acquires a SHARED lock in its place if that is
1395** the appropriate thing to do. Release locks usually is appropriate,
1396** unless we are in exclusive access mode or unless this is a
1397** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1398**
1399** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001400**
1401** TODO: Consider keeping the journal file open for temporary databases.
1402** This might give a performance improvement on windows where opening
1403** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001404*/
danielk1977df2566a2008-05-07 19:11:03 +00001405static int pager_end_transaction(Pager *pPager, int hasMaster){
drhd9b02572001-04-15 00:37:09 +00001406 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001407 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001408 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001409 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001410 if( pPager->state<PAGER_RESERVED ){
1411 return SQLITE_OK;
1412 }
danielk19773b8a05f2007-03-19 17:44:26 +00001413 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001414 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001415 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001416 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001417 }
drhda47d772002-12-02 04:25:19 +00001418 if( pPager->journalOpen ){
danielk197793f7af92008-05-09 16:57:50 +00001419 if( pPager->exclusiveMode
1420 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
1421 ){
1422 rc = zeroJournalHdr(pPager, hasMaster);
1423 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +00001424 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001425 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001426 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001427 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001428 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +00001429 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +00001430 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001431 }
danielk197741483462007-03-24 16:45:04 +00001432 }
drhf5e7bb52008-02-18 14:47:33 +00001433 sqlite3BitvecDestroy(pPager->pInJournal);
1434 pPager->pInJournal = 0;
drhda47d772002-12-02 04:25:19 +00001435 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1436 pPg->inJournal = 0;
1437 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001438 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001439 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001440#ifdef SQLITE_CHECK_PAGES
1441 pPg->pageHash = pager_pagehash(pPg);
1442#endif
drhda47d772002-12-02 04:25:19 +00001443 }
drh605ad8f2006-05-03 23:34:05 +00001444 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001445 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001446 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001447 }else{
drhf5e7bb52008-02-18 14:47:33 +00001448 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001449 }
danielk1977979f38e2007-03-27 16:19:51 +00001450
danielk197741483462007-03-24 16:45:04 +00001451 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001452 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001453 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001454 }else if( pPager->state==PAGER_SYNCED ){
1455 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001456 }
danielk1977334cdb62007-03-26 08:05:12 +00001457 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001458 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001459 pPager->needSync = 0;
danielk19779f61c2f2007-08-27 17:27:49 +00001460 lruListSetFirstSynced(pPager);
drh588f5bc2007-01-02 18:41:54 +00001461 pPager->dbSize = -1;
drhd138c012008-05-13 00:58:18 +00001462 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001463
1464 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001465}
1466
drhed7c8552001-04-11 14:29:21 +00001467/*
drh968af522003-02-11 14:55:40 +00001468** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001469**
1470** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001471** random initial value and the page number. We experimented with
1472** a checksum of the entire data, but that was found to be too slow.
1473**
1474** Note that the page number is stored at the beginning of data and
1475** the checksum is stored at the end. This is important. If journal
1476** corruption occurs due to a power failure, the most likely scenario
1477** is that one end or the other of the record will be changed. It is
1478** much less likely that the two ends of the journal record will be
1479** correct and the middle be corrupt. Thus, this "checksum" scheme,
1480** though fast and simple, catches the mostly likely kind of corruption.
1481**
1482** FIX ME: Consider adding every 200th (or so) byte of the data to the
1483** checksum. That way if a single page spans 3 or more disk sectors and
1484** only the middle sector is corrupt, we will still have a reasonable
1485** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001486*/
drh74161702006-02-24 02:53:49 +00001487static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001488 u32 cksum = pPager->cksumInit;
1489 int i = pPager->pageSize-200;
1490 while( i>0 ){
1491 cksum += aData[i];
1492 i -= 200;
1493 }
drh968af522003-02-11 14:55:40 +00001494 return cksum;
1495}
1496
drh605ad8f2006-05-03 23:34:05 +00001497/* Forward declaration */
1498static void makeClean(PgHdr*);
1499
drh968af522003-02-11 14:55:40 +00001500/*
drhfa86c412002-02-02 15:01:15 +00001501** Read a single page from the journal file opened on file descriptor
1502** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001503**
drh726de592004-06-10 23:35:50 +00001504** If useCksum==0 it means this journal does not use checksums. Checksums
1505** are not used in statement journals because statement journals do not
1506** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001507*/
danielk197762079062007-08-15 17:08:46 +00001508static int pager_playback_one_page(
1509 Pager *pPager,
1510 sqlite3_file *jfd,
1511 i64 offset,
1512 int useCksum
1513){
drhfa86c412002-02-02 15:01:15 +00001514 int rc;
drhae2b40c2004-06-09 19:03:54 +00001515 PgHdr *pPg; /* An existing page in the cache */
1516 Pgno pgno; /* The page number of a page in journal */
1517 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001518 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001519
drh96362842005-03-20 22:47:56 +00001520 /* useCksum should be true for the main journal and false for
1521 ** statement journals. Verify that this is always the case
1522 */
drh9cbe6352005-11-29 03:13:21 +00001523 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001524 assert( aData );
drh96362842005-03-20 22:47:56 +00001525
danielk197762079062007-08-15 17:08:46 +00001526 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001527 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001528 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001529 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001530 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001531
drh968af522003-02-11 14:55:40 +00001532 /* Sanity checking on the page. This is more important that I originally
1533 ** thought. If a power failure occurs while the journal is being written,
1534 ** it could cause invalid data to be written into the journal. We need to
1535 ** detect this invalid data (with high probability) and ignore it.
1536 */
danielk197775edc162004-06-26 01:48:18 +00001537 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001538 return SQLITE_DONE;
1539 }
drhae2b40c2004-06-09 19:03:54 +00001540 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001541 return SQLITE_OK;
1542 }
drhae2b40c2004-06-09 19:03:54 +00001543 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001544 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001545 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001546 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001547 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001548 return SQLITE_DONE;
1549 }
1550 }
drhfa86c412002-02-02 15:01:15 +00001551
danielk1977aa5ccdf2004-06-14 05:10:42 +00001552 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001553
1554 /* If the pager is in RESERVED state, then there must be a copy of this
1555 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001556 ** not the database file. The page is left marked dirty in this case.
1557 **
danielk19772df71c72007-05-24 07:22:42 +00001558 ** An exception to the above rule: If the database is in no-sync mode
1559 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001560 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1561 ** during a Movepage() call, then the page may not be in the cache
1562 ** either. So the condition described in the above paragraph is not
1563 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001564 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001565 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1566 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001567 **
1568 ** Ticket #1171: The statement journal might contain page content that is
1569 ** different from the page content at the start of the transaction.
1570 ** This occurs when a page is changed prior to the start of a statement
1571 ** then changed again within the statement. When rolling back such a
1572 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001573 ** for certain that original page contents are synced into the main rollback
1574 ** journal. Otherwise, a power loss might leave modified data in the
1575 ** database file without an entry in the rollback journal that can
1576 ** restore the database to its original form. Two conditions must be
1577 ** met before writing to the database files. (1) the database must be
1578 ** locked. (2) we know that the original page content is fully synced
1579 ** in the main journal either because the page is not in cache or else
1580 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001581 **
1582 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1583 ** is possible to fail a statement on a database that does not yet exist.
1584 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001585 */
drhae2b40c2004-06-09 19:03:54 +00001586 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001587 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1588 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh4c02a232008-04-14 23:13:45 +00001589 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0)
1590 && pPager->fd->pMethods ){
danielk197762079062007-08-15 17:08:46 +00001591 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1592 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001593 if( pPg ){
1594 makeClean(pPg);
1595 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001596 }
drhfa86c412002-02-02 15:01:15 +00001597 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001598 /* No page should ever be explicitly rolled back that is in use, except
1599 ** for page 1 which is held in use in order to keep the lock on the
1600 ** database active. However such a page may be rolled back as a result
1601 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001602 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001603 */
drhb6f41482004-05-14 01:58:11 +00001604 void *pData;
danielk197728129562005-01-11 10:25:06 +00001605 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001606 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001607 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001608 if( pPager->xReiniter ){
1609 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001610 }
danielk19773c407372005-02-15 02:54:14 +00001611#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001612 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001613#endif
drh86a88112007-04-16 15:02:19 +00001614 /* If this was page 1, then restore the value of Pager.dbFileVers.
1615 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001616 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001617 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001618 }
drh86a88112007-04-16 15:02:19 +00001619
1620 /* Decode the page just read from disk */
1621 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001622 }
1623 return rc;
1624}
1625
1626/*
danielk197713adf8a2004-06-03 16:08:41 +00001627** Parameter zMaster is the name of a master journal file. A single journal
1628** file that referred to the master journal file has just been rolled back.
1629** This routine checks if it is possible to delete the master journal file,
1630** and does so if it is.
drh726de592004-06-10 23:35:50 +00001631**
danielk197765839c62007-08-30 08:08:17 +00001632** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1633** available for use within this function.
1634**
1635**
drh726de592004-06-10 23:35:50 +00001636** The master journal file contains the names of all child journals.
1637** To tell if a master journal can be deleted, check to each of the
1638** children. If all children are either missing or do not refer to
1639** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001640*/
danielk1977b4b47412007-08-17 15:53:36 +00001641static int pager_delmaster(Pager *pPager, const char *zMaster){
1642 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001643 int rc;
1644 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001645 sqlite3_file *pMaster;
1646 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001647 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001648 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001649
1650 /* Open the master journal file exclusively in case some other process
1651 ** is running this routine also. Not that it makes too much difference.
1652 */
danielk1977b4b47412007-08-17 15:53:36 +00001653 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001654 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001655 if( !pMaster ){
1656 rc = SQLITE_NOMEM;
1657 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001658 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1659 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001660 }
danielk197713adf8a2004-06-03 16:08:41 +00001661 if( rc!=SQLITE_OK ) goto delmaster_out;
1662 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001663
1664 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001665 if( rc!=SQLITE_OK ) goto delmaster_out;
1666
1667 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001668 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001669 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001670 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001671
1672 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001673 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001674 */
danielk197765839c62007-08-30 08:08:17 +00001675 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001676 if( !zMasterJournal ){
1677 rc = SQLITE_NOMEM;
1678 goto delmaster_out;
1679 }
danielk197765839c62007-08-30 08:08:17 +00001680 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001681 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001682 if( rc!=SQLITE_OK ) goto delmaster_out;
1683
danielk19775865e3d2004-06-14 06:03:57 +00001684 zJournal = zMasterJournal;
1685 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977861f7452008-06-05 11:39:11 +00001686 int exists;
1687 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
1688 if( rc!=SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001689 goto delmaster_out;
1690 }
danielk1977861f7452008-06-05 11:39:11 +00001691 if( exists ){
danielk197713adf8a2004-06-03 16:08:41 +00001692 /* One of the journals pointed to by the master journal exists.
1693 ** Open it and check if it points at the master journal. If
1694 ** so, return without deleting the master journal file.
1695 */
drh3b7b78b2004-11-24 01:16:43 +00001696 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001697 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1698 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001699 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001700 goto delmaster_out;
1701 }
danielk197713adf8a2004-06-03 16:08:41 +00001702
danielk197765839c62007-08-30 08:08:17 +00001703 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001704 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001705 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001706 goto delmaster_out;
1707 }
danielk197776572402004-06-25 02:38:54 +00001708
danielk197765839c62007-08-30 08:08:17 +00001709 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001710 if( c ){
danielk197776572402004-06-25 02:38:54 +00001711 /* We have a match. Do not delete the master journal file. */
1712 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001713 }
1714 }
danielk19775865e3d2004-06-14 06:03:57 +00001715 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001716 }
1717 }
1718
danielk1977fee2d252007-08-18 10:59:19 +00001719 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001720
1721delmaster_out:
1722 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001723 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001724 }
1725 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001726 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001727 }
danielk1977b4b47412007-08-17 15:53:36 +00001728 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001729 return rc;
1730}
1731
drha6abd042004-06-09 17:37:22 +00001732
danielk1977e180dd92007-04-05 17:15:52 +00001733static void pager_truncate_cache(Pager *pPager);
1734
drha6abd042004-06-09 17:37:22 +00001735/*
drhcb4c40b2004-08-18 19:09:43 +00001736** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001737** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001738**
1739** Might might be the case that the file on disk is smaller than nPage.
1740** This can happen, for example, if we are in the middle of a transaction
1741** which has extended the file size and the new pages are still all held
1742** in cache, then an INSERT or UPDATE does a statement rollback. Some
1743** operating system implementations can get confused if you try to
1744** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001745** so detect this case and write a single zero byte to the end of the new
1746** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001747*/
1748static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001749 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001750 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001751 i64 currentSize, newSize;
1752 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1753 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001754 if( rc==SQLITE_OK && currentSize!=newSize ){
1755 if( currentSize>newSize ){
1756 rc = sqlite3OsTruncate(pPager->fd, newSize);
1757 }else{
1758 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1759 }
drh7fe3f7e2007-11-29 18:44:27 +00001760 }
danielk1977e180dd92007-04-05 17:15:52 +00001761 }
1762 if( rc==SQLITE_OK ){
1763 pPager->dbSize = nPage;
1764 pager_truncate_cache(pPager);
1765 }
1766 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001767}
1768
1769/*
drhc80f0582007-05-01 16:59:48 +00001770** Set the sectorSize for the given pager.
1771**
drh334c80d2008-03-28 17:41:13 +00001772** The sector size is at least as big as the sector size reported
1773** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001774*/
1775static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001776 assert(pPager->fd->pMethods||pPager->tempFile);
1777 if( !pPager->tempFile ){
1778 /* Sector size doesn't matter for temporary files. Also, the file
1779 ** may not have been opened yet, in whcih case the OsSectorSize()
1780 ** call will segfault.
1781 */
1782 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1783 }
drh334c80d2008-03-28 17:41:13 +00001784 if( pPager->sectorSize<512 ){
1785 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001786 }
1787}
1788
1789/*
drhed7c8552001-04-11 14:29:21 +00001790** Playback the journal and thus restore the database file to
1791** the state it was in before we started making changes.
1792**
drh34e79ce2004-02-08 06:05:46 +00001793** The journal file format is as follows:
1794**
drhae2b40c2004-06-09 19:03:54 +00001795** (1) 8 byte prefix. A copy of aJournalMagic[].
1796** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001797** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001798** number of page records from the journal size.
1799** (3) 4 byte big-endian integer which is the initial value for the
1800** sanity checksum.
1801** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001802** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001803** (5) 4 byte big-endian integer which is the sector size. The header
1804** is this many bytes in size.
1805** (6) 4 byte big-endian integer which is the page case.
1806** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001807** name. The value may be zero (indicate that there is no master
1808** journal.)
drh334c80d2008-03-28 17:41:13 +00001809** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001810** and might be shorter than the value read from (5). If the first byte
1811** of the name is \000 then there is no master journal. The master
1812** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001813** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001814** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001815** + pPager->pageSize bytes of data.
1816** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001817**
drh334c80d2008-03-28 17:41:13 +00001818** When we speak of the journal header, we mean the first 8 items above.
1819** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001820**
1821** Call the value from the second bullet "nRec". nRec is the number of
1822** valid page entries in the journal. In most cases, you can compute the
1823** value of nRec from the size of the journal file. But if a power
1824** failure occurred while the journal was being written, it could be the
1825** case that the size of the journal file had already been increased but
1826** the extra entries had not yet made it safely to disk. In such a case,
1827** the value of nRec computed from the file size would be too large. For
1828** that reason, we always use the nRec value in the header.
1829**
1830** If the nRec value is 0xffffffff it means that nRec should be computed
1831** from the file size. This value is used when the user selects the
1832** no-sync option for the journal. A power failure could lead to corruption
1833** in this case. But for things like temporary table (which will be
1834** deleted when the power is restored) we don't care.
1835**
drhd9b02572001-04-15 00:37:09 +00001836** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001837** journal file then all pages up to the first corrupted page are rolled
1838** back (or no pages if the journal header is corrupted). The journal file
1839** is then deleted and SQLITE_OK returned, just as if no corruption had
1840** been encountered.
1841**
1842** If an I/O or malloc() error occurs, the journal-file is not deleted
1843** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001844*/
danielk1977e277be02007-03-23 18:12:06 +00001845static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001846 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001847 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001848 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001849 int i; /* Loop counter */
1850 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001851 int rc; /* Result code of a subroutine */
danielk1977861f7452008-06-05 11:39:11 +00001852 int res = 1; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001853 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001854
drhc3a64ba2001-11-22 00:01:27 +00001855 /* Figure out how many records are in the journal. Abort early if
1856 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001857 */
drh8cfbf082001-09-19 13:22:39 +00001858 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001859 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001860 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001861 goto end_playback;
1862 }
drh240c5792004-02-08 00:40:52 +00001863
danielk197776572402004-06-25 02:38:54 +00001864 /* Read the master journal name from the journal, if it is present.
1865 ** If a master journal file name is specified, but the file is not
1866 ** present on disk, then the journal is not hot and does not need to be
1867 ** played back.
drh240c5792004-02-08 00:40:52 +00001868 */
danielk197765839c62007-08-30 08:08:17 +00001869 zMaster = pPager->pTmpSpace;
1870 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977861f7452008-06-05 11:39:11 +00001871 if( rc==SQLITE_OK && zMaster[0] ){
1872 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
drhc3a64ba2001-11-22 00:01:27 +00001873 }
danielk197765839c62007-08-30 08:08:17 +00001874 zMaster = 0;
danielk1977861f7452008-06-05 11:39:11 +00001875 if( rc!=SQLITE_OK || !res ){
danielk1977ce98bba2008-04-03 10:13:01 +00001876 goto end_playback;
1877 }
1878 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001879
danielk197776572402004-06-25 02:38:54 +00001880 /* This loop terminates either when the readJournalHdr() call returns
1881 ** SQLITE_DONE or an IO error occurs. */
1882 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001883
danielk197776572402004-06-25 02:38:54 +00001884 /* Read the next journal header from the journal file. If there are
1885 ** not enough bytes left in the journal file for a complete header, or
1886 ** it is corrupted, then a process must of failed while writing it.
1887 ** This indicates nothing more needs to be rolled back.
1888 */
1889 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1890 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001891 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001892 rc = SQLITE_OK;
1893 }
danielk197776572402004-06-25 02:38:54 +00001894 goto end_playback;
1895 }
1896
1897 /* If nRec is 0xffffffff, then this journal was created by a process
1898 ** working in no-sync mode. This means that the rest of the journal
1899 ** file consists of pages, there are no more journal headers. Compute
1900 ** the value of nRec based on this assumption.
1901 */
1902 if( nRec==0xffffffff ){
1903 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1904 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1905 }
1906
danielk1977e277be02007-03-23 18:12:06 +00001907 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001908 ** process and if this is the final header in the journal, then it means
1909 ** that this part of the journal was being filled but has not yet been
1910 ** synced to disk. Compute the number of pages based on the remaining
1911 ** size of the file.
1912 **
1913 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001914 */
drh8940f4e2007-08-11 00:26:20 +00001915 if( nRec==0 && !isHot &&
1916 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001917 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1918 }
1919
danielk197776572402004-06-25 02:38:54 +00001920 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001921 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001922 */
danielk1977e180dd92007-04-05 17:15:52 +00001923 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001924 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001925 if( rc!=SQLITE_OK ){
1926 goto end_playback;
1927 }
danielk197776572402004-06-25 02:38:54 +00001928 }
1929
danielk197776572402004-06-25 02:38:54 +00001930 /* Copy original pages out of the journal and back into the database file.
1931 */
1932 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001933 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001934 if( rc!=SQLITE_OK ){
1935 if( rc==SQLITE_DONE ){
1936 rc = SQLITE_OK;
1937 pPager->journalOff = szJ;
1938 break;
1939 }else{
1940 goto end_playback;
1941 }
1942 }
drh968af522003-02-11 14:55:40 +00001943 }
drhed7c8552001-04-11 14:29:21 +00001944 }
drh580eeaf2006-02-24 03:09:37 +00001945 /*NOTREACHED*/
1946 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001947
1948end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001949 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001950 zMaster = pPager->pTmpSpace;
1951 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1952 }
1953 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001954 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001955 }
danielk197765839c62007-08-30 08:08:17 +00001956 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001957 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001958 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001959 */
danielk197765839c62007-08-30 08:08:17 +00001960 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001961 }
danielk197776572402004-06-25 02:38:54 +00001962
1963 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001964 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001965 ** value. Reset it to the correct value for this process.
1966 */
drhc80f0582007-05-01 16:59:48 +00001967 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001968 return rc;
drhed7c8552001-04-11 14:29:21 +00001969}
1970
1971/*
drhac69b052004-05-12 13:30:07 +00001972** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001973**
1974** This is similar to playing back the transaction journal but with
1975** a few extra twists.
1976**
drh663fc632002-02-02 18:49:19 +00001977** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001978** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001979** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001980**
drhac69b052004-05-12 13:30:07 +00001981** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001982** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001983** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001984*/
drh3aac2dd2004-04-26 14:10:20 +00001985static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001986 i64 szJ; /* Size of the full journal */
1987 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001988 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001989 int i; /* Loop counter */
1990 int rc;
1991
danielk197776572402004-06-25 02:38:54 +00001992 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001993
danielk19774099f6e2007-03-19 11:25:20 +00001994 /* Set hdrOff to be the offset just after the end of the last journal
1995 ** page written before the first journal-header for this statement
1996 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001997 ** header was written.
1998 */
1999 hdrOff = pPager->stmtHdrOff;
2000 assert( pPager->fullSync || !hdrOff );
2001 if( !hdrOff ){
2002 hdrOff = szJ;
2003 }
2004
drhfa86c412002-02-02 15:01:15 +00002005 /* Truncate the database back to its original size.
2006 */
danielk1977e180dd92007-04-05 17:15:52 +00002007 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00002008 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00002009
drhac69b052004-05-12 13:30:07 +00002010 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00002011 */
drhac69b052004-05-12 13:30:07 +00002012 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00002013 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00002014
drhac69b052004-05-12 13:30:07 +00002015 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00002016 ** database file. Note that the statement journal omits checksums from
2017 ** each record since power-failure recovery is not important to statement
2018 ** journals.
drhfa86c412002-02-02 15:01:15 +00002019 */
danielk197762079062007-08-15 17:08:46 +00002020 for(i=0; i<nRec; i++){
2021 i64 offset = i*(4+pPager->pageSize);
2022 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00002023 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00002024 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00002025 }
2026
danielk197776572402004-06-25 02:38:54 +00002027 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
2028 ** was the size of the journal file when this statement was started, so
2029 ** everything after that needs to be rolled back, either into the
2030 ** database, the memory cache, or both.
2031 **
2032 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
2033 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00002034 */
danielk197776572402004-06-25 02:38:54 +00002035 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00002036 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00002037 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00002038 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00002039 assert( rc!=SQLITE_DONE );
2040 if( rc!=SQLITE_OK ) goto end_stmt_playback;
2041 }
2042
2043 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00002044 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00002045 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00002046 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00002047 if( rc!=SQLITE_OK ){
2048 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00002049 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00002050 }
danielk1977f0113002006-01-24 12:09:17 +00002051 if( nJRec==0 ){
2052 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00002053 }
danielk1977f0113002006-01-24 12:09:17 +00002054 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00002055 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00002056 assert( rc!=SQLITE_DONE );
2057 if( rc!=SQLITE_OK ) goto end_stmt_playback;
2058 }
drhfa86c412002-02-02 15:01:15 +00002059 }
danielk197776572402004-06-25 02:38:54 +00002060
2061 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00002062
drh3aac2dd2004-04-26 14:10:20 +00002063end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00002064 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00002065 pPager->journalOff = szJ;
2066 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00002067 }
2068 return rc;
2069}
2070
2071/*
drhf57b14a2001-09-14 18:54:08 +00002072** Change the maximum number of in-memory pages that are allowed.
2073*/
danielk19773b8a05f2007-03-19 17:44:26 +00002074void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00002075 if( mxPage>10 ){
2076 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00002077 }else{
2078 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00002079 }
2080}
2081
2082/*
drh973b6e32003-02-12 14:09:42 +00002083** Adjust the robustness of the database to damage due to OS crashes
2084** or power failures by changing the number of syncs()s when writing
2085** the rollback journal. There are three levels:
2086**
drh054889e2005-11-30 03:20:31 +00002087** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00002088** for temporary and transient files.
2089**
2090** NORMAL The journal is synced once before writes begin on the
2091** database. This is normally adequate protection, but
2092** it is theoretically possible, though very unlikely,
2093** that an inopertune power failure could leave the journal
2094** in a state which would cause damage to the database
2095** when it is rolled back.
2096**
2097** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00002098** database (with some additional information - the nRec field
2099** of the journal header - being written in between the two
2100** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00002101** single disk sector is atomic, then this mode provides
2102** assurance that the journal will not be corrupted to the
2103** point of causing damage to the database during rollback.
2104**
2105** Numeric values associated with these states are OFF==1, NORMAL=2,
2106** and FULL=3.
2107*/
danielk197793758c82005-01-21 08:13:14 +00002108#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00002109void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00002110 pPager->noSync = level==1 || pPager->tempFile;
2111 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00002112 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00002113 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00002114}
danielk197793758c82005-01-21 08:13:14 +00002115#endif
drh973b6e32003-02-12 14:09:42 +00002116
2117/*
drhaf6df112005-06-07 02:12:30 +00002118** The following global variable is incremented whenever the library
2119** attempts to open a temporary file. This information is used for
2120** testing and analysis only.
2121*/
drh0f7eb612006-08-08 13:51:43 +00002122#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002123int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00002124#endif
drhaf6df112005-06-07 02:12:30 +00002125
2126/*
drh3f56e6e2007-03-15 01:16:47 +00002127** Open a temporary file.
2128**
2129** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00002130** other error code if we fail. The OS will automatically delete the temporary
2131** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00002132*/
danielk1977b4b47412007-08-17 15:53:36 +00002133static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00002134 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00002135 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00002136 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00002137){
drhfa86c412002-02-02 15:01:15 +00002138 int rc;
drh3f56e6e2007-03-15 01:16:47 +00002139
drh0f7eb612006-08-08 13:51:43 +00002140#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002141 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00002142#endif
danielk1977b4b47412007-08-17 15:53:36 +00002143
drh33f4e022007-09-03 15:19:34 +00002144 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
2145 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00002146 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00002147 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00002148 return rc;
2149}
2150
2151/*
drhed7c8552001-04-11 14:29:21 +00002152** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00002153** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00002154** the first call to sqlite3PagerGet() and is only held open until the
2155** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00002156**
drh6446c4d2001-12-15 14:22:18 +00002157** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00002158** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00002159** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00002160**
2161** If zFilename is ":memory:" then all information is held in cache.
2162** It is never written to disk. This can be used to implement an
2163** in-memory database.
drhed7c8552001-04-11 14:29:21 +00002164*/
danielk19773b8a05f2007-03-19 17:44:26 +00002165int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00002166 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00002167 Pager **ppPager, /* Return the Pager structure here */
2168 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00002169 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00002170 int flags, /* flags controlling this file */
2171 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00002172){
danielk1977b4b47412007-08-17 15:53:36 +00002173 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00002174 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00002175 int rc = SQLITE_OK;
2176 int i;
danielk19778def5ea2004-06-16 10:39:52 +00002177 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00002178 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00002179 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00002180 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
2181 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00002182 int journalFileSize = sqlite3JournalSize(pVfs);
drh1cc8c442007-08-24 16:08:29 +00002183 int nDefaultPage = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00002184 char *zPathname = 0;
2185 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002186
drh86f8c192007-08-22 00:39:19 +00002187 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00002188 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002189
danielk197717b90b52008-06-06 11:11:25 +00002190 /* Compute and store the full pathname in an allocated buffer pointed
2191 ** to by zPathname, length nPathname. Or, if this is a temporary file,
2192 ** leave both nPathname and zPathname set to 0.
2193 */
drh1cc8c442007-08-24 16:08:29 +00002194 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00002195 nPathname = pVfs->mxPathname+1;
2196 zPathname = sqlite3_malloc(nPathname*2);
2197 if( zPathname==0 ){
2198 return SQLITE_NOMEM;
2199 }
drh1cc8c442007-08-24 16:08:29 +00002200#ifndef SQLITE_OMIT_MEMORYDB
2201 if( strcmp(zFilename,":memory:")==0 ){
2202 memDb = 1;
2203 zPathname[0] = 0;
2204 }else
2205#endif
2206 {
danielk1977adfb9b02007-09-17 07:02:56 +00002207 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00002208 }
danielk197717b90b52008-06-06 11:11:25 +00002209 if( rc!=SQLITE_OK ){
2210 sqlite3_free(zPathname);
2211 return rc;
2212 }
2213 nPathname = strlen(zPathname);
drhae28c012007-08-24 16:29:23 +00002214 }
drh99b90c32008-03-17 13:50:58 +00002215
danielk1977b4b47412007-08-17 15:53:36 +00002216 /* Allocate memory for the pager structure */
2217 pPager = sqlite3MallocZero(
2218 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00002219 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00002220 pVfs->szOsFile * 3 + /* The main db and two journal files */
danielk197717b90b52008-06-06 11:11:25 +00002221 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00002222 );
2223 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00002224 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002225 return SQLITE_NOMEM;
2226 }
2227 pPtr = (u8 *)&pPager[1];
drh33f4e022007-09-03 15:19:34 +00002228 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00002229 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00002230 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
2231 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
2232 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00002233 pPager->zDirectory = &pPager->zFilename[nPathname+1];
2234 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00002235 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00002236 if( zPathname ){
2237 memcpy(pPager->zFilename, zPathname, nPathname+1);
2238 sqlite3_free(zPathname);
2239 }
danielk1977b4b47412007-08-17 15:53:36 +00002240
drh153c62c2007-08-24 03:51:33 +00002241 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00002242 */
drhae28c012007-08-24 16:29:23 +00002243 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00002244 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
2245 rc = SQLITE_CANTOPEN;
2246 }else{
drh1cc8c442007-08-24 16:08:29 +00002247 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00002248 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
2249 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00002250 readOnly = (fout&SQLITE_OPEN_READONLY);
2251
2252 /* If the file was successfully opened for read/write access,
2253 ** choose a default page size in case we have to create the
2254 ** database file. The default page size is the maximum of:
2255 **
2256 ** + SQLITE_DEFAULT_PAGE_SIZE,
2257 ** + The value returned by sqlite3OsSectorSize()
2258 ** + The largest page size that can be written atomically.
2259 */
2260 if( rc==SQLITE_OK && !readOnly ){
2261 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
2262 if( nDefaultPage<iSectorSize ){
2263 nDefaultPage = iSectorSize;
2264 }
danielk19779663b8f2007-08-24 11:52:28 +00002265#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00002266 {
2267 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
2268 int ii;
2269 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
2270 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
2271 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
2272 for(ii=nDefaultPage; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
2273 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) nDefaultPage = ii;
danielk19779663b8f2007-08-24 11:52:28 +00002274 }
danielk1977b4b47412007-08-17 15:53:36 +00002275 }
drh1cc8c442007-08-24 16:08:29 +00002276#endif
2277 if( nDefaultPage>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
2278 nDefaultPage = SQLITE_MAX_DEFAULT_PAGE_SIZE;
2279 }
danielk19778def5ea2004-06-16 10:39:52 +00002280 }
drhac69b052004-05-12 13:30:07 +00002281 }
drh1cc8c442007-08-24 16:08:29 +00002282 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002283 /* If a temporary file is requested, it is not opened immediately.
2284 ** In this case we accept the default page size and delay actually
2285 ** opening the file until the first call to OsWrite().
2286 */
danielk19777a2b1ee2007-08-21 14:27:01 +00002287 tempFile = 1;
2288 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00002289 }
danielk1977aef0bf62005-12-30 16:28:01 +00002290
danielk1977b4b47412007-08-17 15:53:36 +00002291 if( pPager && rc==SQLITE_OK ){
drhbf8a4342008-04-29 15:38:58 +00002292 pPager->pTmpSpace = sqlite3MallocZero(nDefaultPage);
drh3e7a6092002-12-07 21:45:14 +00002293 }
danielk1977aef0bf62005-12-30 16:28:01 +00002294
drh153c62c2007-08-24 03:51:33 +00002295 /* If an error occured in either of the blocks above.
2296 ** Free the Pager structure and close the file.
2297 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00002298 ** any Pager.errMask variables.
2299 */
danielk1977b4b47412007-08-17 15:53:36 +00002300 if( !pPager || !pPager->pTmpSpace ){
2301 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00002302 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00002303 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00002304 }
danielk1977aef0bf62005-12-30 16:28:01 +00002305
drh153c62c2007-08-24 03:51:33 +00002306 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
2307 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00002308
danielk1977b4b47412007-08-17 15:53:36 +00002309 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00002310 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00002311 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00002312 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002313
drh99b90c32008-03-17 13:50:58 +00002314 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00002315 if( zPathname ){
2316 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
2317 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
2318 }else{
2319 pPager->zJournal = 0;
2320 }
danielk1977b4b47412007-08-17 15:53:36 +00002321
drh3b59a5c2006-01-15 20:28:28 +00002322 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00002323 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00002324 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002325 /* pPager->stmtOpen = 0; */
2326 /* pPager->stmtInUse = 0; */
2327 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00002328 pPager->dbSize = memDb-1;
danielk19779663b8f2007-08-24 11:52:28 +00002329 pPager->pageSize = nDefaultPage;
drh3b59a5c2006-01-15 20:28:28 +00002330 /* pPager->stmtSize = 0; */
2331 /* pPager->stmtJSize = 0; */
2332 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002333 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002334 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002335 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002336 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002337 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00002338 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00002339 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2340 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2341 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
2342 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00002343 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00002344 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002345 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00002346 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00002347 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00002348 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002349 /* pPager->pFirst = 0; */
2350 /* pPager->pFirstSynced = 0; */
2351 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00002352 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk1977b53e4962008-06-04 06:45:59 +00002353 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk19777a2b1ee2007-08-21 14:27:01 +00002354 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00002355 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00002356 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00002357 }
drh3b59a5c2006-01-15 20:28:28 +00002358 /* pPager->pBusyHandler = 0; */
2359 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002360 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00002361#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002362 pPager->iInUseMM = 0;
2363 pPager->iInUseDB = 0;
2364 if( !memDb ){
drh26e4a8b2008-05-01 17:16:52 +00002365#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +00002366 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00002367#endif
drh86f8c192007-08-22 00:39:19 +00002368 sqlite3_mutex_enter(mutex);
2369 pPager->pNext = sqlite3PagerList;
2370 if( sqlite3PagerList ){
2371 assert( sqlite3PagerList->pPrev==0 );
2372 sqlite3PagerList->pPrev = pPager;
2373 }
2374 pPager->pPrev = 0;
2375 sqlite3PagerList = pPager;
2376 sqlite3_mutex_leave(mutex);
2377 }
danielk197752622822006-01-09 09:59:49 +00002378#endif
drhed7c8552001-04-11 14:29:21 +00002379 return SQLITE_OK;
2380}
2381
2382/*
drh90f5ecb2004-07-22 01:19:35 +00002383** Set the busy handler function.
2384*/
danielk19773b8a05f2007-03-19 17:44:26 +00002385void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002386 pPager->pBusyHandler = pBusyHandler;
2387}
2388
2389/*
drh72f82862001-05-24 21:06:34 +00002390** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002391** when the reference count on each page reaches zero. The destructor can
2392** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002393**
danielk19773b8a05f2007-03-19 17:44:26 +00002394** The destructor is not called as a result sqlite3PagerClose().
2395** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002396*/
danielk19773b8a05f2007-03-19 17:44:26 +00002397void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002398 pPager->xDestructor = xDesc;
2399}
2400
2401/*
drha6abd042004-06-09 17:37:22 +00002402** Set the reinitializer for this pager. If not NULL, the reinitializer
2403** is called when the content of a page in cache is restored to its original
2404** value as a result of a rollback. The callback gives higher-level code
2405** an opportunity to restore the EXTRA section to agree with the restored
2406** page data.
2407*/
danielk19773b8a05f2007-03-19 17:44:26 +00002408void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002409 pPager->xReiniter = xReinit;
2410}
2411
2412/*
danielk1977a1644fd2007-08-29 12:31:25 +00002413** Set the page size to *pPageSize. If the suggest new page size is
2414** inappropriate, then an alternative page size is set to that
2415** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002416*/
danielk1977a1644fd2007-08-29 12:31:25 +00002417int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
2418 int rc = SQLITE_OK;
2419 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00002420 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00002421 if( pageSize && pageSize!=pPager->pageSize
2422 && !pPager->memDb && pPager->nRef==0
2423 ){
2424 char *pNew = (char *)sqlite3_malloc(pageSize);
2425 if( !pNew ){
2426 rc = SQLITE_NOMEM;
2427 }else{
2428 pagerEnter(pPager);
2429 pager_reset(pPager);
2430 pPager->pageSize = pageSize;
2431 setSectorSize(pPager);
2432 sqlite3_free(pPager->pTmpSpace);
2433 pPager->pTmpSpace = pNew;
2434 pagerLeave(pPager);
2435 }
drh1c7880e2005-05-20 20:01:55 +00002436 }
danielk1977a1644fd2007-08-29 12:31:25 +00002437 *pPageSize = pPager->pageSize;
2438 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002439}
2440
2441/*
drh26b79942007-11-28 16:19:56 +00002442** Return a pointer to the "temporary page" buffer held internally
2443** by the pager. This is a buffer that is big enough to hold the
2444** entire content of a database page. This buffer is used internally
2445** during rollback and will be overwritten whenever a rollback
2446** occurs. But other modules are free to use it too, as long as
2447** no rollbacks are happening.
2448*/
2449void *sqlite3PagerTempSpace(Pager *pPager){
2450 return pPager->pTmpSpace;
2451}
2452
2453/*
drhf8e632b2007-05-08 14:51:36 +00002454** Attempt to set the maximum database page count if mxPage is positive.
2455** Make no changes if mxPage is zero or negative. And never reduce the
2456** maximum page count below the current size of the database.
2457**
2458** Regardless of mxPage, return the current maximum page count.
2459*/
2460int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2461 if( mxPage>0 ){
2462 pPager->mxPgno = mxPage;
2463 }
2464 sqlite3PagerPagecount(pPager);
2465 return pPager->mxPgno;
2466}
2467
2468/*
drhc9ac5ca2005-11-04 22:03:30 +00002469** The following set of routines are used to disable the simulated
2470** I/O error mechanism. These routines are used to avoid simulated
2471** errors in places where we do not care about errors.
2472**
2473** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2474** and generate no code.
2475*/
2476#ifdef SQLITE_TEST
2477extern int sqlite3_io_error_pending;
2478extern int sqlite3_io_error_hit;
2479static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002480void disable_simulated_io_errors(void){
2481 saved_cnt = sqlite3_io_error_pending;
2482 sqlite3_io_error_pending = -1;
2483}
2484void enable_simulated_io_errors(void){
2485 sqlite3_io_error_pending = saved_cnt;
2486}
2487#else
drh152410f2005-11-05 15:11:22 +00002488# define disable_simulated_io_errors()
2489# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002490#endif
2491
2492/*
drh90f5ecb2004-07-22 01:19:35 +00002493** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002494** that pDest points to.
2495**
2496** No error checking is done. The rational for this is that this function
2497** may be called even if the file does not exist or contain a header. In
2498** these cases sqlite3OsRead() will return an error, to which the correct
2499** response is to zero the memory at pDest and continue. A real IO error
2500** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002501*/
danielk19773b8a05f2007-03-19 17:44:26 +00002502int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002503 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002504 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002505 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2506 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002507 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002508 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002509 if( rc==SQLITE_IOERR_SHORT_READ ){
2510 rc = SQLITE_OK;
2511 }
drh90f5ecb2004-07-22 01:19:35 +00002512 }
drh551b7732006-11-06 21:20:25 +00002513 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002514}
2515
2516/*
drh5e00f6c2001-09-13 13:46:56 +00002517** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002518** pPager.
2519**
2520** If the PENDING_BYTE lies on the page directly after the end of the
2521** file, then consider this page part of the file too. For example, if
2522** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2523** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002524*/
danielk19773b8a05f2007-03-19 17:44:26 +00002525int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002526 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002527 int rc;
drhd9b02572001-04-15 00:37:09 +00002528 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002529 if( pPager->errCode ){
danielk197743468d92008-02-26 06:05:31 +00002530 return -1;
drha7aea3d2007-03-15 12:51:16 +00002531 }
drhed7c8552001-04-11 14:29:21 +00002532 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002533 n = pPager->dbSize;
2534 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002535 assert(pPager->fd->pMethods||pPager->tempFile);
2536 if( (pPager->fd->pMethods)
2537 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002538 pPager->nRef++;
drhe49f9822006-09-15 12:29:16 +00002539 pager_error(pPager, rc);
danielk1977ae72d982007-10-03 08:46:44 +00002540 pPager->nRef--;
danielk197743468d92008-02-26 06:05:31 +00002541 return -1;
danielk197715f411d2005-09-16 10:18:45 +00002542 }
2543 if( n>0 && n<pPager->pageSize ){
2544 n = 1;
2545 }else{
2546 n /= pPager->pageSize;
2547 }
2548 if( pPager->state!=PAGER_UNLOCK ){
2549 pPager->dbSize = n;
2550 }
drhed7c8552001-04-11 14:29:21 +00002551 }
danielk197715f411d2005-09-16 10:18:45 +00002552 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002553 n++;
2554 }
drhf8e632b2007-05-08 14:51:36 +00002555 if( n>pPager->mxPgno ){
2556 pPager->mxPgno = n;
2557 }
drhed7c8552001-04-11 14:29:21 +00002558 return n;
2559}
2560
drhf07e7d52006-04-07 13:54:46 +00002561
2562#ifndef SQLITE_OMIT_MEMORYDB
2563/*
2564** Clear a PgHistory block
2565*/
2566static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002567 sqlite3_free(pHist->pOrig);
2568 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002569 pHist->pOrig = 0;
2570 pHist->pStmt = 0;
2571}
2572#else
2573#define clearHistory(x)
2574#endif
2575
drhed7c8552001-04-11 14:29:21 +00002576/*
drhf7c57532003-04-25 13:22:51 +00002577** Forward declaration
2578*/
danielk197776572402004-06-25 02:38:54 +00002579static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002580
2581/*
drh85b623f2007-12-13 21:54:09 +00002582** Unlink pPg from its hash chain. Also set the page number to 0 to indicate
danielk1977f5fdda82004-11-03 08:44:05 +00002583** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002584** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002585** pNextFree/pPrevFree list that is not a part of any hash-chain.
2586*/
2587static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2588 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002589 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002590 return;
2591 }
2592 if( pPg->pNextHash ){
2593 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2594 }
2595 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002596 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002597 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2598 }else{
drh8ca0c722006-05-07 17:49:38 +00002599 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002600 pPager->aHash[h] = pPg->pNextHash;
2601 }
drh5229ae42006-03-23 23:29:04 +00002602 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002603 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2604 }
danielk1977f5fdda82004-11-03 08:44:05 +00002605 pPg->pgno = 0;
2606 pPg->pNextHash = pPg->pPrevHash = 0;
2607}
2608
2609/*
drhac69b052004-05-12 13:30:07 +00002610** Unlink a page from the free list (the list of all pages where nRef==0)
2611** and from its hash collision chain.
2612*/
2613static void unlinkPage(PgHdr *pPg){
2614 Pager *pPager = pPg->pPager;
2615
danielk19779f61c2f2007-08-27 17:27:49 +00002616 /* Unlink from free page list */
2617 lruListRemove(pPg);
drhac69b052004-05-12 13:30:07 +00002618
2619 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002620 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002621}
2622
2623/*
danielk1977e180dd92007-04-05 17:15:52 +00002624** This routine is used to truncate the cache when a database
2625** is truncated. Drop from the cache all pages whose pgno is
2626** larger than pPager->dbSize and is unreferenced.
2627**
drhac69b052004-05-12 13:30:07 +00002628** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002629**
2630** Actually, at the point this routine is called, it would be
2631** an error to have a referenced page. But rather than delete
2632** that page and guarantee a subsequent segfault, it seems better
2633** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002634*/
danielk1977e180dd92007-04-05 17:15:52 +00002635static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002636 PgHdr *pPg;
2637 PgHdr **ppPg;
2638 int dbSize = pPager->dbSize;
2639
2640 ppPg = &pPager->pAll;
2641 while( (pPg = *ppPg)!=0 ){
2642 if( pPg->pgno<=dbSize ){
2643 ppPg = &pPg->pNextAll;
2644 }else if( pPg->nRef>0 ){
2645 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2646 ppPg = &pPg->pNextAll;
2647 }else{
2648 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002649 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2650 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002651 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002652 makeClean(pPg);
drh0d180202008-02-14 23:26:56 +00002653 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00002654 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002655 pPager->nPage--;
2656 }
2657 }
2658}
2659
drhf7c57532003-04-25 13:22:51 +00002660/*
danielk197717221812005-02-15 03:38:05 +00002661** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002662** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002663** false or until the lock succeeds.
2664**
2665** Return SQLITE_OK on success and an error code if we cannot obtain
2666** the lock.
2667*/
2668static int pager_wait_on_lock(Pager *pPager, int locktype){
2669 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002670
2671 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002672 assert( PAGER_SHARED==SHARED_LOCK );
2673 assert( PAGER_RESERVED==RESERVED_LOCK );
2674 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002675
2676 /* If the file is currently unlocked then the size must be unknown */
2677 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2678
danielk197717221812005-02-15 03:38:05 +00002679 if( pPager->state>=locktype ){
2680 rc = SQLITE_OK;
2681 }else{
drhbefdf832008-03-14 19:33:05 +00002682 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002683 do {
drh054889e2005-11-30 03:20:31 +00002684 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002685 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002686 if( rc==SQLITE_OK ){
2687 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002688 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002689 }
2690 }
2691 return rc;
2692}
2693
2694/*
drhf7c57532003-04-25 13:22:51 +00002695** Truncate the file to the number of pages specified.
2696*/
danielk19773b8a05f2007-03-19 17:44:26 +00002697int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002698 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002699 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002700 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002701 if( pPager->errCode ){
2702 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002703 return rc;
2704 }
drh7d02cb72003-06-04 16:24:39 +00002705 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002706 return SQLITE_OK;
2707 }
drhb7f91642004-10-31 02:22:47 +00002708 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002709 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002710 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002711 return SQLITE_OK;
2712 }
drh86f8c192007-08-22 00:39:19 +00002713 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002714 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002715 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002716 if( rc!=SQLITE_OK ){
2717 return rc;
2718 }
danielk197717221812005-02-15 03:38:05 +00002719
2720 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002721 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002722 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002723 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002724 if( rc!=SQLITE_OK ){
2725 return rc;
2726 }
2727
drhcb4c40b2004-08-18 19:09:43 +00002728 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002729 return rc;
2730}
2731
2732/*
drhed7c8552001-04-11 14:29:21 +00002733** Shutdown the page cache. Free all memory and close all files.
2734**
2735** If a transaction was in progress when this routine is called, that
2736** transaction is rolled back. All outstanding pages are invalidated
2737** and their memory is freed. Any attempt to use a page associated
2738** with this page cache after this function returns will likely
2739** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002740**
2741** This function always succeeds. If a transaction is active an attempt
2742** is made to roll it back. If an error occurs during the rollback
2743** a hot journal may be left in the filesystem but no error is returned
2744** to the caller.
drhed7c8552001-04-11 14:29:21 +00002745*/
danielk19773b8a05f2007-03-19 17:44:26 +00002746int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002747#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002748 if( !MEMDB ){
drh26e4a8b2008-05-01 17:16:52 +00002749#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +00002750 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00002751#endif
drh86f8c192007-08-22 00:39:19 +00002752 sqlite3_mutex_enter(mutex);
2753 if( pPager->pPrev ){
2754 pPager->pPrev->pNext = pPager->pNext;
2755 }else{
2756 sqlite3PagerList = pPager->pNext;
2757 }
2758 if( pPager->pNext ){
2759 pPager->pNext->pPrev = pPager->pPrev;
2760 }
2761 sqlite3_mutex_leave(mutex);
2762 }
danielk197713f72992005-12-18 08:51:22 +00002763#endif
2764
drhbafda092007-01-03 23:36:22 +00002765 disable_simulated_io_errors();
drh4873d5f2008-05-13 13:27:33 +00002766 sqlite3FaultBeginBenign(-1);
drhc2ee76c2007-01-04 14:58:14 +00002767 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002768 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002769 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002770 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002771 enable_simulated_io_errors();
drh4873d5f2008-05-13 13:27:33 +00002772 sqlite3FaultEndBenign(-1);
drh4f0c5872007-03-26 22:05:01 +00002773 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002774 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002775 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002776 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002777 }
drhf5e7bb52008-02-18 14:47:33 +00002778 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002779 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002780 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002781 }
danielk1977b4b47412007-08-17 15:53:36 +00002782 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002783 /* Temp files are automatically deleted by the OS
2784 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002785 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002786 ** }
2787 */
danielk1977aca790a2005-01-13 11:07:52 +00002788
drh17435752007-08-16 04:30:38 +00002789 sqlite3_free(pPager->aHash);
2790 sqlite3_free(pPager->pTmpSpace);
2791 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002792 return SQLITE_OK;
2793}
2794
drh87cc3b32007-05-08 21:45:27 +00002795#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002796/*
drh5e00f6c2001-09-13 13:46:56 +00002797** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002798*/
danielk19773b8a05f2007-03-19 17:44:26 +00002799Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002800 return p->pgno;
2801}
drh87cc3b32007-05-08 21:45:27 +00002802#endif
drhed7c8552001-04-11 14:29:21 +00002803
2804/*
drhc8629a12004-05-08 20:07:40 +00002805** The page_ref() function increments the reference count for a page.
2806** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002807** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002808**
2809** For non-test systems, page_ref() is a macro that calls _page_ref()
2810** online of the reference count is zero. For test systems, page_ref()
2811** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002812*/
drh836faa42003-01-11 13:30:57 +00002813static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002814 if( pPg->nRef==0 ){
2815 /* The page is currently on the freelist. Remove it. */
danielk19779f61c2f2007-08-27 17:27:49 +00002816 lruListRemove(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002817 pPg->pPager->nRef++;
2818 }
2819 pPg->nRef++;
drhdf0b3b02001-06-23 11:36:20 +00002820}
danielk1977aca790a2005-01-13 11:07:52 +00002821#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002822 static void page_ref(PgHdr *pPg){
2823 if( pPg->nRef==0 ){
2824 _page_ref(pPg);
2825 }else{
2826 pPg->nRef++;
drhc8629a12004-05-08 20:07:40 +00002827 }
2828 }
2829#else
2830# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2831#endif
drhdf0b3b02001-06-23 11:36:20 +00002832
2833/*
2834** Increment the reference count for a page. The input pointer is
2835** a reference to the page data.
2836*/
danielk19773b8a05f2007-03-19 17:44:26 +00002837int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002838 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002839 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002840 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002841 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002842}
2843
2844/*
drh34e79ce2004-02-08 06:05:46 +00002845** Sync the journal. In other words, make sure all the pages that have
2846** been written to the journal have actually reached the surface of the
2847** disk. It is not safe to modify the original database file until after
2848** the journal has been synced. If the original database is modified before
2849** the journal is synced and a power failure occurs, the unsynced journal
2850** data would be lost and we would be unable to completely rollback the
2851** database changes. Database corruption would occur.
2852**
2853** This routine also updates the nRec field in the header of the journal.
2854** (See comments on the pager_playback() routine for additional information.)
2855** If the sync mode is FULL, two syncs will occur. First the whole journal
2856** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002857**
drh34e79ce2004-02-08 06:05:46 +00002858** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002859** after a power failure, so no sync occurs.
2860**
2861** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2862** the database is stored, then OsSync() is never called on the journal
2863** file. In this case all that is required is to update the nRec field in
2864** the journal header.
drhfa86c412002-02-02 15:01:15 +00002865**
drh34e79ce2004-02-08 06:05:46 +00002866** This routine clears the needSync field of every page current held in
2867** memory.
drh50e5dad2001-09-15 00:57:28 +00002868*/
danielk197776572402004-06-25 02:38:54 +00002869static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002870 PgHdr *pPg;
2871 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002872
2873 /* Sync the journal before modifying the main database
2874 ** (assuming there is a journal and it needs to be synced.)
2875 */
danielk197776572402004-06-25 02:38:54 +00002876 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002877 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002878 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002879 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002880
danielk19774cd2cd52007-08-23 14:48:23 +00002881 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002882 /* Write the nRec value into the journal file header. If in
2883 ** full-synchronous mode, sync the journal first. This ensures that
2884 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002885 ** it as a candidate for rollback.
2886 **
2887 ** This is not required if the persistent media supports the
2888 ** SAFE_APPEND property. Because in this case it is not possible
2889 ** for garbage data to be appended to the file, the nRec field
2890 ** is populated with 0xFFFFFFFF when the journal header is written
2891 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002892 */
danielk19774cd2cd52007-08-23 14:48:23 +00002893 i64 jrnlOff;
2894 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002895 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002896 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002897 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002898 if( rc!=0 ) return rc;
2899 }
danielk197713adf8a2004-06-03 16:08:41 +00002900
danielk197762079062007-08-15 17:08:46 +00002901 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2902 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2903 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002904 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002905 }
danielk19774cd2cd52007-08-23 14:48:23 +00002906 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2907 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2908 IOTRACE(("JSYNC %p\n", pPager))
2909 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2910 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2911 );
2912 if( rc!=0 ) return rc;
2913 }
drhdb48ee02003-01-16 13:42:43 +00002914 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002915 }
drh50e5dad2001-09-15 00:57:28 +00002916 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002917
2918 /* Erase the needSync flag from every page.
2919 */
2920 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2921 pPg->needSync = 0;
2922 }
danielk19779f61c2f2007-08-27 17:27:49 +00002923 lruListSetFirstSynced(pPager);
drh50e5dad2001-09-15 00:57:28 +00002924 }
drh03eb96a2002-11-10 23:32:56 +00002925
drh341eae82003-01-21 02:39:36 +00002926#ifndef NDEBUG
2927 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2928 ** flag must also be clear for all pages. Verify that this
2929 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002930 */
drh341eae82003-01-21 02:39:36 +00002931 else{
2932 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2933 assert( pPg->needSync==0 );
2934 }
danielk19779f61c2f2007-08-27 17:27:49 +00002935 assert( pPager->lru.pFirstSynced==pPager->lru.pFirst );
drh03eb96a2002-11-10 23:32:56 +00002936 }
drh341eae82003-01-21 02:39:36 +00002937#endif
drhdb48ee02003-01-16 13:42:43 +00002938
drh81a20f22001-10-12 17:30:04 +00002939 return rc;
drh50e5dad2001-09-15 00:57:28 +00002940}
2941
2942/*
drhdc3e10b2006-06-15 14:31:06 +00002943** Merge two lists of pages connected by pDirty and in pgno order.
2944** Do not both fixing the pPrevDirty pointers.
2945*/
2946static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2947 PgHdr result, *pTail;
2948 pTail = &result;
2949 while( pA && pB ){
2950 if( pA->pgno<pB->pgno ){
2951 pTail->pDirty = pA;
2952 pTail = pA;
2953 pA = pA->pDirty;
2954 }else{
2955 pTail->pDirty = pB;
2956 pTail = pB;
2957 pB = pB->pDirty;
2958 }
2959 }
2960 if( pA ){
2961 pTail->pDirty = pA;
2962 }else if( pB ){
2963 pTail->pDirty = pB;
2964 }else{
2965 pTail->pDirty = 0;
2966 }
2967 return result.pDirty;
2968}
2969
2970/*
2971** Sort the list of pages in accending order by pgno. Pages are
2972** connected by pDirty pointers. The pPrevDirty pointers are
2973** corrupted by this sort.
2974*/
danielk197724168722007-04-02 05:07:47 +00002975#define N_SORT_BUCKET_ALLOC 25
2976#define N_SORT_BUCKET 25
2977#ifdef SQLITE_TEST
2978 int sqlite3_pager_n_sort_bucket = 0;
2979 #undef N_SORT_BUCKET
2980 #define N_SORT_BUCKET \
2981 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2982#endif
drhdc3e10b2006-06-15 14:31:06 +00002983static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002984 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002985 int i;
2986 memset(a, 0, sizeof(a));
2987 while( pIn ){
2988 p = pIn;
2989 pIn = p->pDirty;
2990 p->pDirty = 0;
2991 for(i=0; i<N_SORT_BUCKET-1; i++){
2992 if( a[i]==0 ){
2993 a[i] = p;
2994 break;
2995 }else{
2996 p = merge_pagelist(a[i], p);
2997 a[i] = 0;
2998 }
2999 }
3000 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00003001 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
3002 ** elements in the input list. This is possible, but impractical.
3003 ** Testing this line is the point of global variable
3004 ** sqlite3_pager_n_sort_bucket.
3005 */
drhdc3e10b2006-06-15 14:31:06 +00003006 a[i] = merge_pagelist(a[i], p);
3007 }
3008 }
3009 p = a[0];
3010 for(i=1; i<N_SORT_BUCKET; i++){
3011 p = merge_pagelist(p, a[i]);
3012 }
3013 return p;
3014}
3015
3016/*
drh2554f8b2003-01-22 01:26:44 +00003017** Given a list of pages (connected by the PgHdr.pDirty pointer) write
3018** every one of those pages out to the database file and mark them all
3019** as clean.
3020*/
3021static int pager_write_pagelist(PgHdr *pList){
3022 Pager *pPager;
drh153c62c2007-08-24 03:51:33 +00003023 PgHdr *p;
drh2554f8b2003-01-22 01:26:44 +00003024 int rc;
3025
3026 if( pList==0 ) return SQLITE_OK;
3027 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00003028
3029 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
3030 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00003031 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00003032 **
drha6abd042004-06-09 17:37:22 +00003033 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
3034 ** through an intermediate state PENDING. A PENDING lock prevents new
3035 ** readers from attaching to the database but is unsufficient for us to
3036 ** write. The idea of a PENDING lock is to prevent new readers from
3037 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00003038 **
drha6abd042004-06-09 17:37:22 +00003039 ** While the pager is in the RESERVED state, the original database file
3040 ** is unchanged and we can rollback without having to playback the
3041 ** journal into the original database file. Once we transition to
3042 ** EXCLUSIVE, it means the database file has been changed and any rollback
3043 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00003044 */
drh684917c2004-10-05 02:41:42 +00003045 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00003046 if( rc!=SQLITE_OK ){
3047 return rc;
3048 }
3049
drhdc3e10b2006-06-15 14:31:06 +00003050 pList = sort_pagelist(pList);
drh153c62c2007-08-24 03:51:33 +00003051 for(p=pList; p; p=p->pDirty){
3052 assert( p->dirty );
3053 p->dirty = 0;
3054 }
drh2554f8b2003-01-22 01:26:44 +00003055 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00003056
3057 /* If the file has not yet been opened, open it now. */
3058 if( !pPager->fd->pMethods ){
3059 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00003060 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00003061 if( rc ) return rc;
3062 }
3063
danielk1977687566d2004-11-02 12:56:41 +00003064 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00003065 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00003066 ** make the file smaller (presumably by auto-vacuum code). Do not write
3067 ** any such pages to the file.
3068 */
3069 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00003070 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00003071 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00003072 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
3073 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00003074 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00003075 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003076 PAGER_INCR(sqlite3_pager_writedb_count);
3077 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00003078 if( pList->pgno==1 ){
3079 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
3080 }
danielk1977687566d2004-11-02 12:56:41 +00003081 }
3082#ifndef NDEBUG
3083 else{
drh4f0c5872007-03-26 22:05:01 +00003084 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00003085 }
3086#endif
drh2554f8b2003-01-22 01:26:44 +00003087 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00003088#ifdef SQLITE_CHECK_PAGES
3089 pList->pageHash = pager_pagehash(pList);
3090#endif
drh2554f8b2003-01-22 01:26:44 +00003091 pList = pList->pDirty;
3092 }
3093 return SQLITE_OK;
3094}
3095
3096/*
3097** Collect every dirty page into a dirty list and
3098** return a pointer to the head of that list. All pages are
3099** collected even if they are still in use.
3100*/
3101static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh8f2e9a12008-02-26 14:46:04 +00003102
3103#ifndef NDEBUG
3104 /* Verify the sanity of the dirty list when we are running
3105 ** in debugging mode. This is expensive, so do not
3106 ** do this on a normal build. */
3107 int n1 = 0;
3108 int n2 = 0;
3109 PgHdr *p;
3110 for(p=pPager->pAll; p; p=p->pNextAll){ if( p->dirty ) n1++; }
3111 for(p=pPager->pDirty; p; p=p->pDirty){ n2++; }
3112 assert( n1==n2 );
3113#endif
3114
drh605ad8f2006-05-03 23:34:05 +00003115 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00003116}
3117
3118/*
drh19db9352008-03-27 22:42:51 +00003119** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00003120** A hot journal is one that needs to be played back.
3121**
3122** If the current size of the database file is 0 but a journal file
3123** exists, that is probably an old journal left over from a prior
3124** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00003125**
3126** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00003127**
3128** This routine does not open the journal file to examine its
3129** content. Hence, the journal might contain the name of a master
3130** journal file that has been deleted, and hence not be hot. Or
3131** the header of the journal might be zeroed out. This routine
3132** does not discover these cases of a non-hot journal - if the
3133** journal file exists and is not empty this routine assumes it
3134** is hot. The pager_playback() routine will discover that the
3135** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00003136*/
3137static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003138 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977861f7452008-06-05 11:39:11 +00003139 int res = 0;
3140 if( pPager->useJournal && pPager->fd->pMethods ){
3141 int rc;
3142 int exists;
3143 int locked;
3144
3145 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
3146 if( rc==SQLITE_OK && exists ){
3147 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
3148 }
3149
3150 if( rc==SQLITE_OK && exists && !locked ){
danielk197781620542008-06-07 05:19:37 +00003151 int nPage = sqlite3PagerPagecount(pPager);
3152 if( nPage==0 ){
danielk1977861f7452008-06-05 11:39:11 +00003153 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3154 exists = 0;
danielk197781620542008-06-07 05:19:37 +00003155 }else if( nPage<0 ){
3156 rc = SQLITE_IOERR;
danielk1977861f7452008-06-05 11:39:11 +00003157 }
3158 }
3159
3160 res = (rc!=SQLITE_OK ? -1 : (exists && !locked));
drhbb5f18d2007-04-06 18:23:17 +00003161 }
danielk1977861f7452008-06-05 11:39:11 +00003162
3163 return res;
drh165ffe92005-03-15 17:09:30 +00003164}
3165
danielk19775591df52005-12-20 09:19:37 +00003166/*
danielk1977aef0bf62005-12-30 16:28:01 +00003167** Try to find a page in the cache that can be recycled.
3168**
3169** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00003170** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00003171*/
danielk1977843e65f2007-09-01 16:16:15 +00003172static int pager_recycle(Pager *pPager, PgHdr **ppPg){
danielk197713f72992005-12-18 08:51:22 +00003173 PgHdr *pPg;
3174 *ppPg = 0;
3175
danielk1977843e65f2007-09-01 16:16:15 +00003176 /* It is illegal to call this function unless the pager object
3177 ** pointed to by pPager has at least one free page (page with nRef==0).
3178 */
danielk1977c551edc2007-04-05 13:12:13 +00003179 assert(!MEMDB);
danielk1977843e65f2007-09-01 16:16:15 +00003180 assert(pPager->lru.pFirst);
danielk1977c551edc2007-04-05 13:12:13 +00003181
danielk197713f72992005-12-18 08:51:22 +00003182 /* Find a page to recycle. Try to locate a page that does not
3183 ** require us to do an fsync() on the journal.
3184 */
danielk19779f61c2f2007-08-27 17:27:49 +00003185 pPg = pPager->lru.pFirstSynced;
danielk197713f72992005-12-18 08:51:22 +00003186
3187 /* If we could not find a page that does not require an fsync()
3188 ** on the journal file then fsync the journal file. This is a
3189 ** very slow operation, so we work hard to avoid it. But sometimes
3190 ** it can't be helped.
3191 */
danielk1977c41cc392008-05-15 08:34:54 +00003192 if( pPg==0 && pPager->lru.pFirst ){
3193 if( !pPager->errCode ){
3194 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
3195 int rc = syncJournal(pPager);
danielk197713f72992005-12-18 08:51:22 +00003196 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003197 return rc;
danielk197713f72992005-12-18 08:51:22 +00003198 }
danielk1977c41cc392008-05-15 08:34:54 +00003199 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
3200 /* If in full-sync mode, write a new journal header into the
3201 ** journal file. This is done to avoid ever modifying a journal
3202 ** header that is involved in the rollback of pages that have
3203 ** already been written to the database (in case the header is
3204 ** trashed when the nRec field is updated).
3205 */
3206 pPager->nRec = 0;
3207 assert( pPager->journalOff > 0 );
3208 assert( pPager->doNotSync==0 );
3209 rc = writeJournalHdr(pPager);
3210 if( rc!=0 ){
3211 return rc;
3212 }
3213 }
danielk197713f72992005-12-18 08:51:22 +00003214 }
danielk19779f61c2f2007-08-27 17:27:49 +00003215 pPg = pPager->lru.pFirst;
danielk197713f72992005-12-18 08:51:22 +00003216 }
danielk197713f72992005-12-18 08:51:22 +00003217
3218 assert( pPg->nRef==0 );
3219
3220 /* Write the page to the database file if it is dirty.
3221 */
danielk1977c41cc392008-05-15 08:34:54 +00003222 if( pPg->dirty && !pPager->errCode ){
danielk197713f72992005-12-18 08:51:22 +00003223 int rc;
3224 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00003225 makeClean(pPg);
3226 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00003227 pPg->pDirty = 0;
3228 rc = pager_write_pagelist( pPg );
drh153c62c2007-08-24 03:51:33 +00003229 pPg->dirty = 0;
danielk197713f72992005-12-18 08:51:22 +00003230 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00003231 return rc;
danielk197713f72992005-12-18 08:51:22 +00003232 }
3233 }
danielk1977c41cc392008-05-15 08:34:54 +00003234 assert( pPg->dirty==0 || pPager->errCode );
danielk197713f72992005-12-18 08:51:22 +00003235
3236 /* If the page we are recycling is marked as alwaysRollback, then
3237 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00003238 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00003239 ** It is necessary to do this because the page marked alwaysRollback
3240 ** might be reloaded at a later time but at that point we won't remember
3241 ** that is was marked alwaysRollback. This means that all pages must
3242 ** be marked as alwaysRollback from here on out.
3243 */
3244 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00003245 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00003246 pPager->alwaysRollback = 1;
3247 }
3248
3249 /* Unlink the old page from the free list and the hash table
3250 */
3251 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00003252 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00003253
3254 *ppPg = pPg;
3255 return SQLITE_OK;
3256}
3257
drh86f8c192007-08-22 00:39:19 +00003258#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00003259/*
3260** This function is called to free superfluous dynamically allocated memory
3261** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00003262** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00003263**
3264** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00003265** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00003266** of bytes of memory released.
3267*/
danielk19773b8a05f2007-03-19 17:44:26 +00003268int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00003269 int nReleased = 0; /* Bytes of memory released so far */
drh86f8c192007-08-22 00:39:19 +00003270 Pager *pPager; /* For looping over pagers */
drhe5fe6902007-12-07 18:55:28 +00003271 BusyHandler *savedBusy; /* Saved copy of the busy handler */
danielk19779f61c2f2007-08-27 17:27:49 +00003272 int rc = SQLITE_OK;
danielk197713f72992005-12-18 08:51:22 +00003273
drh86f8c192007-08-22 00:39:19 +00003274 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00003275 */
drh26e4a8b2008-05-01 17:16:52 +00003276#ifndef SQLITE_MUTEX_NOOP
drh64e2bb72008-05-07 12:29:55 +00003277 sqlite3_mutex *mutex; /* The MEM2 mutex */
drh86f8c192007-08-22 00:39:19 +00003278 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00003279#endif
drh86f8c192007-08-22 00:39:19 +00003280 sqlite3_mutex_enter(mutex);
3281
3282 /* Signal all database connections that memory management wants
3283 ** to have access to the pagers.
3284 */
3285 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3286 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00003287 }
3288
danielk19779f61c2f2007-08-27 17:27:49 +00003289 while( rc==SQLITE_OK && (nReq<0 || nReleased<nReq) ){
3290 PgHdr *pPg;
3291 PgHdr *pRecycled;
3292
3293 /* Try to find a page to recycle that does not require a sync(). If
3294 ** this is not possible, find one that does require a sync().
3295 */
3296 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
3297 pPg = sqlite3LruPageList.pFirstSynced;
3298 while( pPg && (pPg->needSync || pPg->pPager->iInUseDB) ){
3299 pPg = pPg->gfree.pNext;
3300 }
3301 if( !pPg ){
3302 pPg = sqlite3LruPageList.pFirst;
3303 while( pPg && pPg->pPager->iInUseDB ){
3304 pPg = pPg->gfree.pNext;
3305 }
3306 }
3307 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
danielk197713f72992005-12-18 08:51:22 +00003308
danielk197784f786f2007-08-28 08:00:17 +00003309 /* If pPg==0, then the block above has failed to find a page to
3310 ** recycle. In this case return early - no further memory will
3311 ** be released.
3312 */
danielk19779f61c2f2007-08-27 17:27:49 +00003313 if( !pPg ) break;
danielk197713f72992005-12-18 08:51:22 +00003314
danielk19779f61c2f2007-08-27 17:27:49 +00003315 pPager = pPg->pPager;
3316 assert(!pPg->needSync || pPg==pPager->lru.pFirst);
3317 assert(pPg->needSync || pPg==pPager->lru.pFirstSynced);
3318
drhe5fe6902007-12-07 18:55:28 +00003319 savedBusy = pPager->pBusyHandler;
3320 pPager->pBusyHandler = 0;
danielk1977843e65f2007-09-01 16:16:15 +00003321 rc = pager_recycle(pPager, &pRecycled);
drhe5fe6902007-12-07 18:55:28 +00003322 pPager->pBusyHandler = savedBusy;
danielk19779f61c2f2007-08-27 17:27:49 +00003323 assert(pRecycled==pPg || rc!=SQLITE_OK);
3324 if( rc==SQLITE_OK ){
3325 /* We've found a page to free. At this point the page has been
3326 ** removed from the page hash-table, free-list and synced-list
3327 ** (pFirstSynced). It is still in the all pages (pAll) list.
3328 ** Remove it from this list before freeing.
3329 **
3330 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
3331 ** probably is though.
danielk197713f72992005-12-18 08:51:22 +00003332 */
danielk19779f61c2f2007-08-27 17:27:49 +00003333 PgHdr *pTmp;
3334 assert( pPg );
3335 if( pPg==pPager->pAll ){
3336 pPager->pAll = pPg->pNextAll;
3337 }else{
3338 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
3339 pTmp->pNextAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00003340 }
danielk19779f61c2f2007-08-27 17:27:49 +00003341 nReleased += (
3342 sizeof(*pPg) + pPager->pageSize
3343 + sizeof(u32) + pPager->nExtra
3344 + MEMDB*sizeof(PgHistory)
3345 );
3346 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
3347 PAGER_INCR(sqlite3_pager_pgfree_count);
drh0d180202008-02-14 23:26:56 +00003348 sqlite3_free(pPg->pData);
danielk19779f61c2f2007-08-27 17:27:49 +00003349 sqlite3_free(pPg);
danielk197784f786f2007-08-28 08:00:17 +00003350 pPager->nPage--;
danielk19779f61c2f2007-08-27 17:27:49 +00003351 }else{
3352 /* An error occured whilst writing to the database file or
3353 ** journal in pager_recycle(). The error is not returned to the
3354 ** caller of this function. Instead, set the Pager.errCode variable.
3355 ** The error will be returned to the user (or users, in the case
3356 ** of a shared pager cache) of the pager for which the error occured.
3357 */
3358 assert(
3359 (rc&0xff)==SQLITE_IOERR ||
3360 rc==SQLITE_FULL ||
3361 rc==SQLITE_BUSY
3362 );
3363 assert( pPager->state>=PAGER_RESERVED );
3364 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00003365 }
3366 }
danielk1977aef0bf62005-12-30 16:28:01 +00003367
drh86f8c192007-08-22 00:39:19 +00003368 /* Clear the memory management flags and release the mutex
3369 */
3370 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3371 pPager->iInUseMM = 0;
3372 }
3373 sqlite3_mutex_leave(mutex);
3374
3375 /* Return the number of bytes released
3376 */
danielk197713f72992005-12-18 08:51:22 +00003377 return nReleased;
3378}
drh86f8c192007-08-22 00:39:19 +00003379#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00003380
drh165ffe92005-03-15 17:09:30 +00003381/*
danielk1977e180dd92007-04-05 17:15:52 +00003382** Read the content of page pPg out of the database file.
3383*/
3384static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
3385 int rc;
danielk197762079062007-08-15 17:08:46 +00003386 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00003387 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00003388 assert(pPager->fd->pMethods||pPager->tempFile);
3389 if( !pPager->fd->pMethods ){
3390 return SQLITE_IOERR_SHORT_READ;
3391 }
danielk197762079062007-08-15 17:08:46 +00003392 offset = (pgno-1)*(i64)pPager->pageSize;
3393 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003394 PAGER_INCR(sqlite3_pager_readdb_count);
3395 PAGER_INCR(pPager->nRead);
3396 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00003397 if( pgno==1 ){
3398 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
3399 sizeof(pPager->dbFileVers));
3400 }
danielk1977e180dd92007-04-05 17:15:52 +00003401 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00003402 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
3403 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00003404 return rc;
3405}
3406
3407
3408/*
danielk1977e277be02007-03-23 18:12:06 +00003409** This function is called to obtain the shared lock required before
3410** data may be read from the pager cache. If the shared lock has already
3411** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00003412**
3413** Immediately after obtaining the shared lock (if required), this function
3414** checks for a hot-journal file. If one is found, an emergency rollback
3415** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00003416*/
3417static int pagerSharedLock(Pager *pPager){
3418 int rc = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00003419 int isHot = 0;
danielk1977e277be02007-03-23 18:12:06 +00003420
danielk1977ae72d982007-10-03 08:46:44 +00003421 /* If this database is opened for exclusive access, has no outstanding
3422 ** page references and is in an error-state, now is the chance to clear
3423 ** the error. Discard the contents of the pager-cache and treat any
3424 ** open journal file as a hot-journal.
3425 */
3426 if( !MEMDB && pPager->exclusiveMode && pPager->nRef==0 && pPager->errCode ){
3427 if( pPager->journalOpen ){
3428 isHot = 1;
3429 }
danielk1977ae72d982007-10-03 08:46:44 +00003430 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00003431 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00003432 }
3433
3434 /* If the pager is still in an error state, do not proceed. The error
3435 ** state will be cleared at some point in the future when all page
3436 ** references are dropped and the cache can be discarded.
3437 */
3438 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3439 return pPager->errCode;
3440 }
3441
3442 if( pPager->state==PAGER_UNLOCK || isHot ){
danielk1977b4b47412007-08-17 15:53:36 +00003443 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00003444 if( !MEMDB ){
3445 assert( pPager->nRef==0 );
3446 if( !pPager->noReadlock ){
3447 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
3448 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003449 assert( pPager->state==PAGER_UNLOCK );
danielk1977e277be02007-03-23 18:12:06 +00003450 return pager_error(pPager, rc);
3451 }
3452 assert( pPager->state>=SHARED_LOCK );
3453 }
3454
3455 /* If a journal file exists, and there is no RESERVED lock on the
3456 ** database file, then it either needs to be played back or deleted.
3457 */
drh19db9352008-03-27 22:42:51 +00003458 rc = hasHotJournal(pPager);
3459 if( rc<0 ){
danielk197752b472a2008-05-05 16:23:55 +00003460 rc = SQLITE_IOERR_NOMEM;
3461 goto failed;
drh19db9352008-03-27 22:42:51 +00003462 }
3463 if( rc==1 || isHot ){
danielk1977e277be02007-03-23 18:12:06 +00003464 /* Get an EXCLUSIVE lock on the database file. At this point it is
3465 ** important that a RESERVED lock is not obtained on the way to the
3466 ** EXCLUSIVE lock. If it were, another process might open the
3467 ** database file, detect the RESERVED lock, and conclude that the
3468 ** database is safe to read while this process is still rolling it
3469 ** back.
3470 **
3471 ** Because the intermediate RESERVED lock is not requested, the
3472 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00003473 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00003474 */
danielk1977ae72d982007-10-03 08:46:44 +00003475 if( pPager->state<EXCLUSIVE_LOCK ){
3476 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3477 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003478 rc = pager_error(pPager, rc);
3479 goto failed;
danielk1977ae72d982007-10-03 08:46:44 +00003480 }
3481 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00003482 }
danielk1977e277be02007-03-23 18:12:06 +00003483
drh16e45a42008-04-19 20:34:18 +00003484 /* Open the journal for read/write access. This is because in
drhfd131da2007-08-07 17:13:03 +00003485 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003486 ** possibly used for a transaction later on. On some systems, the
3487 ** OsTruncate() call used in exclusive-access mode also requires
3488 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003489 */
drh16e45a42008-04-19 20:34:18 +00003490 if( !isHot && pPager->journalOpen==0 ){
danielk1977861f7452008-06-05 11:39:11 +00003491 int res;
3492 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
3493 if( rc==SQLITE_OK ){
3494 if( res ){
3495 int fout = 0;
3496 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
3497 assert( !pPager->tempFile );
3498 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
3499 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3500 if( fout&SQLITE_OPEN_READONLY ){
3501 rc = SQLITE_BUSY;
3502 sqlite3OsClose(pPager->jfd);
3503 }
3504 }else{
3505 /* If the journal does not exist, that means some other process
3506 ** has already rolled it back */
danielk1977ae72d982007-10-03 08:46:44 +00003507 rc = SQLITE_BUSY;
danielk1977ae72d982007-10-03 08:46:44 +00003508 }
danielk1977979f38e2007-03-27 16:19:51 +00003509 }
3510 }
danielk1977e277be02007-03-23 18:12:06 +00003511 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003512 if( rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_UNLOCK
3513 && rc!=SQLITE_IOERR_NOMEM
3514 ){
3515 rc = SQLITE_BUSY;
drh1aa5af12008-03-07 19:51:14 +00003516 }
danielk197752b472a2008-05-05 16:23:55 +00003517 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003518 }
3519 pPager->journalOpen = 1;
3520 pPager->journalStarted = 0;
3521 pPager->journalOff = 0;
3522 pPager->setMaster = 0;
3523 pPager->journalHdr = 0;
3524
3525 /* Playback and delete the journal. Drop the database write
3526 ** lock and reacquire the read lock.
3527 */
3528 rc = pager_playback(pPager, 1);
3529 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003530 rc = pager_error(pPager, rc);
3531 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003532 }
danielk1977c5859712007-03-26 12:26:27 +00003533 assert(pPager->state==PAGER_SHARED ||
3534 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3535 );
danielk1977e277be02007-03-23 18:12:06 +00003536 }
3537
3538 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003539 /* The shared-lock has just been acquired on the database file
3540 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003541 ** read or write transaction). Check to see if the database
3542 ** has been modified. If the database has changed, flush the
3543 ** cache.
3544 **
3545 ** Database changes is detected by looking at 15 bytes beginning
3546 ** at offset 24 into the file. The first 4 of these 16 bytes are
3547 ** a 32-bit counter that is incremented with each change. The
3548 ** other bytes change randomly with each file change when
3549 ** a codec is in use.
3550 **
3551 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003552 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003553 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003554 */
drh86a88112007-04-16 15:02:19 +00003555 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003556 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003557
danielk1977e180dd92007-04-05 17:15:52 +00003558 if( pPager->errCode ){
danielk197752b472a2008-05-05 16:23:55 +00003559 rc = pPager->errCode;
3560 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003561 }
3562
danielk1977e180dd92007-04-05 17:15:52 +00003563 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003564 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003565 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003566 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003567 goto failed;
danielk1977e180dd92007-04-05 17:15:52 +00003568 }
drh86a88112007-04-16 15:02:19 +00003569 }else{
3570 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003571 }
3572
drh86a88112007-04-16 15:02:19 +00003573 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003574 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003575 }
3576 }
3577 }
danielk1977c5859712007-03-26 12:26:27 +00003578 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3579 if( pPager->state==PAGER_UNLOCK ){
3580 pPager->state = PAGER_SHARED;
3581 }
danielk1977e277be02007-03-23 18:12:06 +00003582 }
3583
danielk197752b472a2008-05-05 16:23:55 +00003584 failed:
3585 if( rc!=SQLITE_OK ){
3586 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
3587 pager_unlock(pPager);
3588 }
danielk1977e277be02007-03-23 18:12:06 +00003589 return rc;
3590}
3591
3592/*
danielk1977e180dd92007-04-05 17:15:52 +00003593** Allocate a PgHdr object. Either create a new one or reuse
3594** an existing one that is not otherwise in use.
3595**
3596** A new PgHdr structure is created if any of the following are
3597** true:
3598**
3599** (1) We have not exceeded our maximum allocated cache size
3600** as set by the "PRAGMA cache_size" command.
3601**
3602** (2) There are no unused PgHdr objects available at this time.
3603**
3604** (3) This is an in-memory database.
3605**
3606** (4) There are no PgHdr objects that do not require a journal
3607** file sync and a sync of the journal file is currently
3608** prohibited.
3609**
3610** Otherwise, reuse an existing PgHdr. In other words, reuse an
3611** existing PgHdr if all of the following are true:
3612**
3613** (1) We have reached or exceeded the maximum cache size
3614** allowed by "PRAGMA cache_size".
3615**
3616** (2) There is a PgHdr available with PgHdr->nRef==0
3617**
3618** (3) We are not in an in-memory database
3619**
3620** (4) Either there is an available PgHdr that does not need
3621** to be synced to disk or else disk syncing is currently
3622** allowed.
danielk197724168722007-04-02 05:07:47 +00003623*/
3624static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3625 int rc = SQLITE_OK;
3626 PgHdr *pPg;
drh1e3af332007-10-20 13:17:54 +00003627 int nByteHdr;
danielk197724168722007-04-02 05:07:47 +00003628
danielk1977e180dd92007-04-05 17:15:52 +00003629 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003630 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003631 if( pPager->nPage<pPager->mxPage
danielk19779f61c2f2007-08-27 17:27:49 +00003632 || pPager->lru.pFirst==0
danielk1977e180dd92007-04-05 17:15:52 +00003633 || MEMDB
danielk19779f61c2f2007-08-27 17:27:49 +00003634 || (pPager->lru.pFirstSynced==0 && pPager->doNotSync)
danielk1977e180dd92007-04-05 17:15:52 +00003635 ){
drh0d180202008-02-14 23:26:56 +00003636 void *pData;
danielk197724168722007-04-02 05:07:47 +00003637 if( pPager->nPage>=pPager->nHash ){
3638 pager_resize_hash_table(pPager,
3639 pPager->nHash<256 ? 256 : pPager->nHash*2);
3640 if( pPager->nHash==0 ){
3641 rc = SQLITE_NOMEM;
3642 goto pager_allocate_out;
3643 }
3644 }
drhed138fb2007-08-22 22:04:37 +00003645 pagerLeave(pPager);
drh1e3af332007-10-20 13:17:54 +00003646 nByteHdr = sizeof(*pPg) + sizeof(u32) + pPager->nExtra
3647 + MEMDB*sizeof(PgHistory);
drh0d180202008-02-14 23:26:56 +00003648 pPg = sqlite3_malloc( nByteHdr );
3649 if( pPg ){
3650 pData = sqlite3_malloc( pPager->pageSize );
3651 if( pData==0 ){
3652 sqlite3_free(pPg);
3653 pPg = 0;
3654 }
3655 }
drhed138fb2007-08-22 22:04:37 +00003656 pagerEnter(pPager);
danielk197724168722007-04-02 05:07:47 +00003657 if( pPg==0 ){
3658 rc = SQLITE_NOMEM;
3659 goto pager_allocate_out;
3660 }
drh1e3af332007-10-20 13:17:54 +00003661 memset(pPg, 0, nByteHdr);
drh0d180202008-02-14 23:26:56 +00003662 pPg->pData = pData;
danielk197724168722007-04-02 05:07:47 +00003663 pPg->pPager = pPager;
3664 pPg->pNextAll = pPager->pAll;
3665 pPager->pAll = pPg;
3666 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003667 }else{
3668 /* Recycle an existing page with a zero ref-count. */
danielk1977843e65f2007-09-01 16:16:15 +00003669 rc = pager_recycle(pPager, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003670 if( rc==SQLITE_BUSY ){
3671 rc = SQLITE_IOERR_BLOCKED;
3672 }
danielk197724168722007-04-02 05:07:47 +00003673 if( rc!=SQLITE_OK ){
3674 goto pager_allocate_out;
3675 }
3676 assert( pPager->state>=SHARED_LOCK );
3677 assert(pPg);
3678 }
3679 *ppPg = pPg;
3680
3681pager_allocate_out:
3682 return rc;
3683}
3684
3685/*
drhd33d5a82007-04-26 12:11:28 +00003686** Make sure we have the content for a page. If the page was
3687** previously acquired with noContent==1, then the content was
3688** just initialized to zeros instead of being read from disk.
3689** But now we need the real data off of disk. So make sure we
3690** have it. Read it in if we do not have it already.
3691*/
3692static int pager_get_content(PgHdr *pPg){
3693 if( pPg->needRead ){
3694 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3695 if( rc==SQLITE_OK ){
3696 pPg->needRead = 0;
3697 }else{
3698 return rc;
3699 }
3700 }
3701 return SQLITE_OK;
3702}
3703
3704/*
drhd9b02572001-04-15 00:37:09 +00003705** Acquire a page.
3706**
drh58a11682001-11-10 13:51:08 +00003707** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003708** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003709**
drhd33d5a82007-04-26 12:11:28 +00003710** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003711** file is smaller than the requested page, then no actual disk
3712** read occurs and the memory image of the page is initialized to
3713** all zeros. The extra data appended to a page is always initialized
3714** to zeros the first time a page is loaded into memory.
3715**
drhd9b02572001-04-15 00:37:09 +00003716** The acquisition might fail for several reasons. In all cases,
3717** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003718**
drhd33d5a82007-04-26 12:11:28 +00003719** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003720** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003721** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003722** just returns 0. This routine acquires a read-lock the first time it
3723** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003724** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003725** or journal files.
drh0787db62007-03-04 13:15:27 +00003726**
drh538f5702007-04-13 02:14:30 +00003727** If noContent is false, the page contents are actually read from disk.
3728** If noContent is true, it means that we do not care about the contents
3729** of the page at this time, so do not do a disk read. Just fill in the
3730** page content with zeros. But mark the fact that we have not read the
3731** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003732** sqlite3PagerWrite() is called on this page or if this routine is
3733** called again with noContent==0, that means that the content is needed
3734** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003735*/
drh86f8c192007-08-22 00:39:19 +00003736static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003737 Pager *pPager, /* The pager open on the database file */
3738 Pgno pgno, /* Page number to fetch */
3739 DbPage **ppPage, /* Write a pointer to the page here */
3740 int noContent /* Do not bother reading content from disk if true */
3741){
drhed7c8552001-04-11 14:29:21 +00003742 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003743 int rc;
drhed7c8552001-04-11 14:29:21 +00003744
danielk1977e277be02007-03-23 18:12:06 +00003745 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3746
danielk197726836652005-01-17 01:33:13 +00003747 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3748 ** number greater than this, or zero, is requested.
3749 */
drh267cb322005-09-16 17:16:52 +00003750 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003751 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003752 }
3753
drhd9b02572001-04-15 00:37:09 +00003754 /* Make sure we have not hit any critical errors.
3755 */
drh836faa42003-01-11 13:30:57 +00003756 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003757 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00003758
danielk197713adf8a2004-06-03 16:08:41 +00003759 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003760 ** on the database file. pagerSharedLock() is a no-op if
3761 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003762 */
danielk1977e277be02007-03-23 18:12:06 +00003763 rc = pagerSharedLock(pPager);
3764 if( rc!=SQLITE_OK ){
3765 return rc;
drhed7c8552001-04-11 14:29:21 +00003766 }
danielk1977e277be02007-03-23 18:12:06 +00003767 assert( pPager->state!=PAGER_UNLOCK );
3768
3769 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003770 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003771 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003772 int nMax;
drhed7c8552001-04-11 14:29:21 +00003773 int h;
drh538f5702007-04-13 02:14:30 +00003774 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003775 rc = pagerAllocatePage(pPager, &pPg);
3776 if( rc!=SQLITE_OK ){
3777 return rc;
drhed7c8552001-04-11 14:29:21 +00003778 }
danielk197724168722007-04-02 05:07:47 +00003779
drhed7c8552001-04-11 14:29:21 +00003780 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003781 assert( !MEMDB || pgno>pPager->stmtSize );
drhf5e7bb52008-02-18 14:47:33 +00003782 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
3783 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003784
drh605ad8f2006-05-03 23:34:05 +00003785 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003786 pPg->nRef = 1;
danielk197775bab7d2006-01-23 13:09:45 +00003787
drhd9b02572001-04-15 00:37:09 +00003788 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003789 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003790 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003791 }
danielk1977979f38e2007-03-27 16:19:51 +00003792 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003793 if( pPager->errCode ){
danielk1977efaaf572006-01-16 11:29:19 +00003794 rc = pPager->errCode;
danielk1977ae72d982007-10-03 08:46:44 +00003795 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00003796 return rc;
3797 }
danielk197775bab7d2006-01-23 13:09:45 +00003798
3799 /* Populate the page with data, either by reading from the database
3800 ** file, or by setting the entire page to zero.
3801 */
drhd215acf2007-04-13 04:01:58 +00003802 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003803 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003804 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003805 return SQLITE_FULL;
3806 }
drh90f5ecb2004-07-22 01:19:35 +00003807 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003808 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003809 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003810 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003811 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003812 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3813 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003814 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003815 return rc;
drh81a20f22001-10-12 17:30:04 +00003816 }
danielk1977b4626a32007-04-28 15:47:43 +00003817 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003818 }
danielk197775bab7d2006-01-23 13:09:45 +00003819
3820 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003821 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003822 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003823 pPg->pNextHash = pPager->aHash[h];
3824 pPager->aHash[h] = pPg;
3825 if( pPg->pNextHash ){
3826 assert( pPg->pNextHash->pPrevHash==0 );
3827 pPg->pNextHash->pPrevHash = pPg;
3828 }
3829
danielk19773c407372005-02-15 02:54:14 +00003830#ifdef SQLITE_CHECK_PAGES
3831 pPg->pageHash = pager_pagehash(pPg);
3832#endif
drhed7c8552001-04-11 14:29:21 +00003833 }else{
drhd9b02572001-04-15 00:37:09 +00003834 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003835 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003836 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003837 if( !noContent ){
3838 rc = pager_get_content(pPg);
3839 if( rc ){
3840 return rc;
3841 }
3842 }
drhdf0b3b02001-06-23 11:36:20 +00003843 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003844 }
danielk19773b8a05f2007-03-19 17:44:26 +00003845 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003846 return SQLITE_OK;
3847}
drh86f8c192007-08-22 00:39:19 +00003848int sqlite3PagerAcquire(
3849 Pager *pPager, /* The pager open on the database file */
3850 Pgno pgno, /* Page number to fetch */
3851 DbPage **ppPage, /* Write a pointer to the page here */
3852 int noContent /* Do not bother reading content from disk if true */
3853){
3854 int rc;
3855 pagerEnter(pPager);
3856 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3857 pagerLeave(pPager);
3858 return rc;
3859}
3860
drhed7c8552001-04-11 14:29:21 +00003861
3862/*
drh7e3b0a02001-04-28 16:52:40 +00003863** Acquire a page if it is already in the in-memory cache. Do
3864** not read the page from disk. Return a pointer to the page,
3865** or 0 if the page is not in cache.
3866**
danielk19773b8a05f2007-03-19 17:44:26 +00003867** See also sqlite3PagerGet(). The difference between this routine
3868** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003869** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003870** returns NULL if the page is not in cache or if a disk I/O error
3871** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003872*/
danielk19773b8a05f2007-03-19 17:44:26 +00003873DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003874 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003875
drh836faa42003-01-11 13:30:57 +00003876 assert( pPager!=0 );
3877 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003878
drh86f8c192007-08-22 00:39:19 +00003879 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003880 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003881 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003882 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3883 /* Do nothing */
3884 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3885 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003886 }
drh86f8c192007-08-22 00:39:19 +00003887 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003888 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003889}
3890
3891/*
drhed7c8552001-04-11 14:29:21 +00003892** Release a page.
3893**
3894** If the number of references to the page drop to zero, then the
3895** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003896** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003897** removed.
3898*/
danielk19773b8a05f2007-03-19 17:44:26 +00003899int sqlite3PagerUnref(DbPage *pPg){
drh6eac06e2008-05-07 12:45:41 +00003900 Pager *pPager;
3901
3902 if( pPg==0 ) return SQLITE_OK;
3903 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003904
3905 /* Decrement the reference count for this page
3906 */
drhed7c8552001-04-11 14:29:21 +00003907 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003908 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003909 pPg->nRef--;
drhd9b02572001-04-15 00:37:09 +00003910
danielk19773c407372005-02-15 02:54:14 +00003911 CHECK_PAGE(pPg);
3912
drh72f82862001-05-24 21:06:34 +00003913 /* When the number of references to a page reach 0, call the
3914 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003915 */
drhed7c8552001-04-11 14:29:21 +00003916 if( pPg->nRef==0 ){
danielk19779f61c2f2007-08-27 17:27:49 +00003917
3918 lruListAdd(pPg);
drh72f82862001-05-24 21:06:34 +00003919 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003920 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003921 }
drhd9b02572001-04-15 00:37:09 +00003922
3923 /* When all pages reach the freelist, drop the read lock from
3924 ** the database file.
3925 */
3926 pPager->nRef--;
3927 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003928 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003929 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003930 }
drhed7c8552001-04-11 14:29:21 +00003931 }
danielk1977ae72d982007-10-03 08:46:44 +00003932 pagerLeave(pPager);
drhd9b02572001-04-15 00:37:09 +00003933 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003934}
3935
3936/*
drha6abd042004-06-09 17:37:22 +00003937** Create a journal file for pPager. There should already be a RESERVED
3938** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003939**
3940** Return SQLITE_OK if everything. Return an error code and release the
3941** write lock if anything goes wrong.
3942*/
3943static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003944 sqlite3_vfs *pVfs = pPager->pVfs;
3945 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3946
drhda47d772002-12-02 04:25:19 +00003947 int rc;
drhb7f91642004-10-31 02:22:47 +00003948 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003949 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003950 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003951 assert( pPager->pInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003952 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003953 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003954 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00003955 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003956 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003957 rc = SQLITE_NOMEM;
3958 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003959 }
danielk1977b4b47412007-08-17 15:53:36 +00003960
drhfdc40e92008-04-17 20:59:37 +00003961 if( pPager->journalOpen==0 ){
3962 if( pPager->tempFile ){
3963 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3964 }else{
3965 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00003966 }
drhfdc40e92008-04-17 20:59:37 +00003967#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3968 rc = sqlite3JournalOpen(
3969 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3970 );
3971#else
3972 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
3973#endif
3974 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3975 pPager->journalOff = 0;
3976 pPager->setMaster = 0;
3977 pPager->journalHdr = 0;
3978 if( rc!=SQLITE_OK ){
3979 if( rc==SQLITE_NOMEM ){
3980 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3981 }
3982 goto failed_to_open_journal;
3983 }
drhda47d772002-12-02 04:25:19 +00003984 }
3985 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003986 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003987 pPager->needSync = 0;
3988 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003989 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003990 if( pPager->errCode ){
3991 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003992 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003993 }
drhda47d772002-12-02 04:25:19 +00003994 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003995
danielk197776572402004-06-25 02:38:54 +00003996 rc = writeJournalHdr(pPager);
3997
drhac69b052004-05-12 13:30:07 +00003998 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003999 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00004000 }
danielk1977ae72d982007-10-03 08:46:44 +00004001 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00004002 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00004003 if( rc==SQLITE_OK ){
4004 rc = SQLITE_FULL;
4005 }
4006 }
drh9c105bb2004-10-02 20:38:28 +00004007 return rc;
4008
4009failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00004010 sqlite3BitvecDestroy(pPager->pInJournal);
4011 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00004012 return rc;
drhda47d772002-12-02 04:25:19 +00004013}
4014
4015/*
drh4b845d72002-03-05 12:41:19 +00004016** Acquire a write-lock on the database. The lock is removed when
4017** the any of the following happen:
4018**
drh80e35f42007-03-30 14:06:34 +00004019** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00004020** * sqlite3PagerRollback() is called.
4021** * sqlite3PagerClose() is called.
4022** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00004023**
danielk197713adf8a2004-06-03 16:08:41 +00004024** The first parameter to this routine is a pointer to any open page of the
4025** database file. Nothing changes about the page - it is used merely to
4026** acquire a pointer to the Pager structure and as proof that there is
4027** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00004028**
danielk197713adf8a2004-06-03 16:08:41 +00004029** The second parameter indicates how much space in bytes to reserve for a
4030** master journal file-name at the start of the journal when it is created.
4031**
4032** A journal file is opened if this is not a temporary file. For temporary
4033** files, the opening of the journal file is deferred until there is an
4034** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00004035**
drha6abd042004-06-09 17:37:22 +00004036** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00004037**
4038** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
4039** immediately instead of waiting until we try to flush the cache. The
4040** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00004041*/
danielk19773b8a05f2007-03-19 17:44:26 +00004042int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00004043 Pager *pPager = pPg->pPager;
4044 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00004045 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00004046 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00004047 assert( pPager->state!=PAGER_UNLOCK );
4048 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00004049 assert( pPager->pInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00004050 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00004051 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00004052 pPager->origDbSize = pPager->dbSize;
4053 }else{
drh054889e2005-11-30 03:20:31 +00004054 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00004055 if( rc==SQLITE_OK ){
4056 pPager->state = PAGER_RESERVED;
4057 if( exFlag ){
4058 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
4059 }
4060 }
danielk19779eed5052004-06-04 10:38:30 +00004061 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00004062 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00004063 return rc;
drhac69b052004-05-12 13:30:07 +00004064 }
drha6abd042004-06-09 17:37:22 +00004065 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00004066 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhfdc40e92008-04-17 20:59:37 +00004067 if( pPager->useJournal && !pPager->tempFile
4068 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drhac69b052004-05-12 13:30:07 +00004069 rc = pager_open_journal(pPager);
4070 }
drh4b845d72002-03-05 12:41:19 +00004071 }
danielk1977334cdb62007-03-26 08:05:12 +00004072 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00004073 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00004074 ** time a (read or write) transaction was successfully concluded
4075 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00004076 ** kept open and either was truncated to 0 bytes or its header was
4077 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00004078 */
4079 assert( pPager->nRec==0 );
4080 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00004081 assert( pPager->pInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00004082 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00004083 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004084 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhed138fb2007-08-22 22:04:37 +00004085 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004086 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00004087 rc = SQLITE_NOMEM;
4088 }else{
drh369339d2007-03-30 16:01:55 +00004089 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00004090 rc = writeJournalHdr(pPager);
4091 }
drh4b845d72002-03-05 12:41:19 +00004092 }
danielk1977334cdb62007-03-26 08:05:12 +00004093 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00004094 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00004095 return rc;
4096}
4097
4098/*
drh605ad8f2006-05-03 23:34:05 +00004099** Make a page dirty. Set its dirty flag and add it to the dirty
4100** page list.
4101*/
4102static void makeDirty(PgHdr *pPg){
4103 if( pPg->dirty==0 ){
4104 Pager *pPager = pPg->pPager;
4105 pPg->dirty = 1;
4106 pPg->pDirty = pPager->pDirty;
4107 if( pPager->pDirty ){
4108 pPager->pDirty->pPrevDirty = pPg;
4109 }
4110 pPg->pPrevDirty = 0;
4111 pPager->pDirty = pPg;
4112 }
4113}
4114
4115/*
4116** Make a page clean. Clear its dirty bit and remove it from the
4117** dirty page list.
4118*/
4119static void makeClean(PgHdr *pPg){
4120 if( pPg->dirty ){
4121 pPg->dirty = 0;
4122 if( pPg->pDirty ){
drh153c62c2007-08-24 03:51:33 +00004123 assert( pPg->pDirty->pPrevDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004124 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
4125 }
4126 if( pPg->pPrevDirty ){
drh153c62c2007-08-24 03:51:33 +00004127 assert( pPg->pPrevDirty->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004128 pPg->pPrevDirty->pDirty = pPg->pDirty;
4129 }else{
drh153c62c2007-08-24 03:51:33 +00004130 assert( pPg->pPager->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004131 pPg->pPager->pDirty = pPg->pDirty;
4132 }
4133 }
4134}
4135
4136
4137/*
drhed7c8552001-04-11 14:29:21 +00004138** Mark a data page as writeable. The page is written into the journal
4139** if it is not there already. This routine must be called before making
4140** changes to a page.
4141**
4142** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00004143** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00004144** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00004145** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00004146** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00004147**
4148** If the journal file could not be written because the disk is full,
4149** then this routine returns SQLITE_FULL and does an immediate rollback.
4150** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00004151** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00004152** reset.
drhed7c8552001-04-11 14:29:21 +00004153*/
danielk19773b8a05f2007-03-19 17:44:26 +00004154static int pager_write(PgHdr *pPg){
4155 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00004156 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00004157 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00004158
drh6446c4d2001-12-15 14:22:18 +00004159 /* Check for errors
4160 */
danielk1977efaaf572006-01-16 11:29:19 +00004161 if( pPager->errCode ){
4162 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004163 }
drh5e00f6c2001-09-13 13:46:56 +00004164 if( pPager->readOnly ){
4165 return SQLITE_PERM;
4166 }
drh6446c4d2001-12-15 14:22:18 +00004167
danielk197776572402004-06-25 02:38:54 +00004168 assert( !pPager->setMaster );
4169
danielk19773c407372005-02-15 02:54:14 +00004170 CHECK_PAGE(pPg);
4171
drh538f5702007-04-13 02:14:30 +00004172 /* If this page was previously acquired with noContent==1, that means
4173 ** we didn't really read in the content of the page. This can happen
4174 ** (for example) when the page is being moved to the freelist. But
4175 ** now we are (perhaps) moving the page off of the freelist for
4176 ** reuse and we need to know its original content so that content
4177 ** can be stored in the rollback journal. So do the read at this
4178 ** time.
4179 */
drhd33d5a82007-04-26 12:11:28 +00004180 rc = pager_get_content(pPg);
4181 if( rc ){
4182 return rc;
drh538f5702007-04-13 02:14:30 +00004183 }
4184
drh6446c4d2001-12-15 14:22:18 +00004185 /* Mark the page as dirty. If the page has already been written
4186 ** to the journal then we can return right away.
4187 */
drh605ad8f2006-05-03 23:34:05 +00004188 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00004189 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00004190 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004191 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004192 }else{
drh6446c4d2001-12-15 14:22:18 +00004193
danielk1977a0bf2652004-11-04 14:30:04 +00004194 /* If we get this far, it means that the page needs to be
4195 ** written to the transaction journal or the ckeckpoint journal
4196 ** or both.
4197 **
4198 ** First check to see that the transaction journal exists and
4199 ** create it if it does not.
4200 */
4201 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00004202 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00004203 if( rc!=SQLITE_OK ){
4204 return rc;
4205 }
4206 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00004207 if( !pPager->journalOpen && pPager->useJournal
4208 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00004209 rc = pager_open_journal(pPager);
4210 if( rc!=SQLITE_OK ) return rc;
4211 }
danielk1977a0bf2652004-11-04 14:30:04 +00004212 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004213 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004214
4215 /* The transaction journal now exists and we have a RESERVED or an
4216 ** EXCLUSIVE lock on the main database file. Write the current page to
4217 ** the transaction journal if it is not there already.
4218 */
drhfdc40e92008-04-17 20:59:37 +00004219 if( !pPg->inJournal && (pPager->journalOpen || MEMDB) ){
danielk1977a0bf2652004-11-04 14:30:04 +00004220 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00004221 if( MEMDB ){
4222 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00004223 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004224 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00004225 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977662278e2007-11-05 15:30:12 +00004226 if( !pHist->pOrig ){
4227 return SQLITE_NOMEM;
danielk1977a0bf2652004-11-04 14:30:04 +00004228 }
danielk1977662278e2007-11-05 15:30:12 +00004229 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977a0bf2652004-11-04 14:30:04 +00004230 }else{
drhbf4bca52007-09-06 22:19:14 +00004231 u32 cksum;
4232 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00004233
drh267cb322005-09-16 17:16:52 +00004234 /* We should never write to the journal file the page that
4235 ** contains the database locks. The following assert verifies
4236 ** that we do not. */
4237 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00004238 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00004239 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00004240 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
4241 if( rc==SQLITE_OK ){
4242 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
4243 pPager->journalOff + 4);
4244 pPager->journalOff += pPager->pageSize+4;
4245 }
4246 if( rc==SQLITE_OK ){
4247 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
4248 pPager->journalOff += 4;
4249 }
4250 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00004251 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00004252 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00004253 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
4254 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00004255
drhfd131da2007-08-07 17:13:03 +00004256 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00004257 ** transaction will be rolled back by the layer above.
4258 */
danielk1977a0bf2652004-11-04 14:30:04 +00004259 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00004260 return rc;
4261 }
danielk197707cb5602006-01-20 10:55:05 +00004262
danielk1977a0bf2652004-11-04 14:30:04 +00004263 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00004264 assert( pPager->pInJournal!=0 );
4265 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004266 pPg->needSync = !pPager->noSync;
4267 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00004268 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004269 }
drhac69b052004-05-12 13:30:07 +00004270 }
danielk197713adf8a2004-06-03 16:08:41 +00004271 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004272 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00004273 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00004274 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00004275 }
4276 if( pPg->needSync ){
4277 pPager->needSync = 1;
4278 }
4279 pPg->inJournal = 1;
4280 }
4281
4282 /* If the statement journal is open and the page is not in it,
4283 ** then write the current page to the statement journal. Note that
4284 ** the statement journal format differs from the standard journal format
4285 ** in that it omits the checksums and the header.
4286 */
danielk1977f35843b2007-04-07 15:03:17 +00004287 if( pPager->stmtInUse
4288 && !pageInStatement(pPg)
4289 && (int)pPg->pgno<=pPager->stmtSize
4290 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004291 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
4292 if( MEMDB ){
4293 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4294 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00004295 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00004296 if( pHist->pStmt ){
4297 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
4298 }
drh4f0c5872007-03-26 22:05:01 +00004299 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00004300 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00004301 }else{
danielk197762079062007-08-15 17:08:46 +00004302 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00004303 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
4304 rc = write32bits(pPager->stfd, offset, pPg->pgno);
4305 if( rc==SQLITE_OK ){
4306 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
4307 }
drh4f0c5872007-03-26 22:05:01 +00004308 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00004309 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00004310 return rc;
4311 }
danielk1977a0bf2652004-11-04 14:30:04 +00004312 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00004313 assert( pPager->pInStmt!=0 );
4314 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00004315 }
drhd9b02572001-04-15 00:37:09 +00004316 }
drhfa86c412002-02-02 15:01:15 +00004317 }
4318
4319 /* Update the database size and return.
4320 */
drh1aa2d8b2007-01-03 15:34:29 +00004321 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00004322 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00004323 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00004324 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00004325 pPager->dbSize++;
4326 }
drh306dc212001-05-21 13:45:10 +00004327 }
drh69688d52001-04-14 16:38:23 +00004328 return rc;
drhed7c8552001-04-11 14:29:21 +00004329}
4330
4331/*
danielk19774099f6e2007-03-19 11:25:20 +00004332** This function is used to mark a data-page as writable. It uses
4333** pager_write() to open a journal file (if it is not already open)
4334** and write the page *pData to the journal.
4335**
4336** The difference between this function and pager_write() is that this
4337** function also deals with the special case where 2 or more pages
4338** fit on a single disk sector. In this case all co-resident pages
4339** must have been written to the journal file before returning.
4340*/
danielk19773b8a05f2007-03-19 17:44:26 +00004341int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00004342 int rc = SQLITE_OK;
4343
danielk19773b8a05f2007-03-19 17:44:26 +00004344 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00004345 Pager *pPager = pPg->pPager;
4346 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
4347
drh86f8c192007-08-22 00:39:19 +00004348 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004349 if( !MEMDB && nPagePerSector>1 ){
4350 Pgno nPageCount; /* Total number of pages in database file */
4351 Pgno pg1; /* First page of the sector pPg is located on. */
4352 int nPage; /* Number of pages starting at pg1 to journal */
4353 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00004354 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00004355
4356 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
4357 ** header to be written between the pages journaled by this function.
4358 */
4359 assert( pPager->doNotSync==0 );
4360 pPager->doNotSync = 1;
4361
4362 /* This trick assumes that both the page-size and sector-size are
4363 ** an integer power of 2. It sets variable pg1 to the identifier
4364 ** of the first page of the sector pPg is located on.
4365 */
4366 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
4367
danielk19773b8a05f2007-03-19 17:44:26 +00004368 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004369 if( pPg->pgno>nPageCount ){
4370 nPage = (pPg->pgno - pg1)+1;
4371 }else if( (pg1+nPagePerSector-1)>nPageCount ){
4372 nPage = nPageCount+1-pg1;
4373 }else{
4374 nPage = nPagePerSector;
4375 }
4376 assert(nPage>0);
4377 assert(pg1<=pPg->pgno);
4378 assert((pg1+nPage)>pPg->pgno);
4379
4380 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
4381 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00004382 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00004383 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00004384 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00004385 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004386 if( rc==SQLITE_OK ){
4387 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00004388 if( pPage->needSync ){
4389 needSync = 1;
4390 }
danielk19773b8a05f2007-03-19 17:44:26 +00004391 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004392 }
4393 }
drhc81945e2008-03-10 14:12:53 +00004394 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk1977dd97a492007-08-22 18:54:32 +00004395 if( pPage->needSync ){
4396 needSync = 1;
4397 }
danielk19774099f6e2007-03-19 11:25:20 +00004398 }
4399 }
4400
danielk1977dd97a492007-08-22 18:54:32 +00004401 /* If the PgHdr.needSync flag is set for any of the nPage pages
4402 ** starting at pg1, then it needs to be set for all of them. Because
4403 ** writing to any of these nPage pages may damage the others, the
4404 ** journal file must contain sync()ed copies of all of them
4405 ** before any of them can be written out to the database file.
4406 */
4407 if( needSync ){
4408 for(ii=0; ii<nPage && needSync; ii++){
4409 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
4410 if( pPage ) pPage->needSync = 1;
4411 }
4412 assert(pPager->needSync);
4413 }
4414
danielk19774099f6e2007-03-19 11:25:20 +00004415 assert( pPager->doNotSync==1 );
4416 pPager->doNotSync = 0;
4417 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004418 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00004419 }
drh86f8c192007-08-22 00:39:19 +00004420 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004421 return rc;
4422}
4423
4424/*
drhaacc5432002-01-06 17:07:40 +00004425** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00004426** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00004427** to change the content of the page.
4428*/
danielk19777d3a6662006-01-23 16:21:05 +00004429#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00004430int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00004431 return pPg->dirty;
4432}
danielk19777d3a6662006-01-23 16:21:05 +00004433#endif
drh6019e162001-07-02 17:51:45 +00004434
drh001bbcb2003-03-19 03:14:00 +00004435/*
drh30e58752002-03-02 20:41:57 +00004436** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00004437** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00004438** that page might be marked as dirty.
4439**
4440** The overlying software layer calls this routine when all of the data
4441** on the given page is unused. The pager marks the page as clean so
4442** that it does not get written to disk.
4443**
4444** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00004445** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00004446** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00004447**
4448** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00004449** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00004450** will thereafter be ignored. This is necessary to avoid a problem
4451** where a page with data is added to the freelist during one part of
4452** a transaction then removed from the freelist during a later part
4453** of the same transaction and reused for some other purpose. When it
4454** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004455** the sqlite3PagerDontRollback() routine is called. But because the
4456** page contains critical data, we still need to be sure it gets
4457** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004458*/
drh538f5702007-04-13 02:14:30 +00004459void sqlite3PagerDontWrite(DbPage *pDbPage){
4460 PgHdr *pPg = pDbPage;
4461 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004462
drhb7f91642004-10-31 02:22:47 +00004463 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004464 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004465 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004466 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004467 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004468 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4469 /* If this pages is the last page in the file and the file has grown
4470 ** during the current transaction, then do NOT mark the page as clean.
4471 ** When the database file grows, we must make sure that the last page
4472 ** gets written at least once so that the disk file will be the correct
4473 ** size. If you do not write this page and the size of the file
4474 ** on the disk ends up being too small, that can lead to database
4475 ** corruption during the next transaction.
4476 */
4477 }else{
drh538f5702007-04-13 02:14:30 +00004478 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4479 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004480 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004481#ifdef SQLITE_CHECK_PAGES
4482 pPg->pageHash = pager_pagehash(pPg);
4483#endif
drh8124a302002-06-25 14:43:57 +00004484 }
drh30e58752002-03-02 20:41:57 +00004485 }
drh86f8c192007-08-22 00:39:19 +00004486 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004487}
4488
4489/*
4490** A call to this routine tells the pager that if a rollback occurs,
4491** it is not necessary to restore the data on the given page. This
4492** means that the pager does not have to record the given page in the
4493** rollback journal.
drh538f5702007-04-13 02:14:30 +00004494**
4495** If we have not yet actually read the content of this page (if
4496** the PgHdr.needRead flag is set) then this routine acts as a promise
4497** that we will never need to read the page content in the future.
4498** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00004499*/
danielk19773b8a05f2007-03-19 17:44:26 +00004500void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004501 Pager *pPager = pPg->pPager;
4502
drh86f8c192007-08-22 00:39:19 +00004503 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004504 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00004505
4506 /* If the journal file is not open, or DontWrite() has been called on
4507 ** this page (DontWrite() sets the alwaysRollback flag), then this
4508 ** function is a no-op.
4509 */
4510 if( pPager->journalOpen==0 || pPg->alwaysRollback || pPager->alwaysRollback ){
danielk197787c29a92008-01-18 11:33:16 +00004511 pagerLeave(pPager);
4512 return;
4513 }
danielk1977a55e9352008-01-21 13:04:34 +00004514 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
4515
drhc5d0bd92008-04-14 01:00:57 +00004516#ifdef SQLITE_SECURE_DELETE
4517 if( pPg->inJournal || (int)pPg->pgno > pPager->origDbSize ){
4518 return;
4519 }
4520#endif
4521
4522 /* If SECURE_DELETE is disabled, then there is no way that this
4523 ** routine can be called on a page for which sqlite3PagerDontWrite()
4524 ** has not been previously called during the same transaction.
4525 ** And if DontWrite() has previously been called, the following
4526 ** conditions must be met.
danielk1977a55e9352008-01-21 13:04:34 +00004527 */
4528 assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize );
4529
drhf5e7bb52008-02-18 14:47:33 +00004530 assert( pPager->pInJournal!=0 );
4531 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00004532 pPg->inJournal = 1;
4533 pPg->needRead = 0;
4534 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00004535 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00004536 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00004537 }
danielk1977a55e9352008-01-21 13:04:34 +00004538 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
4539 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh86f8c192007-08-22 00:39:19 +00004540 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004541}
4542
drhac69b052004-05-12 13:30:07 +00004543
drh30e58752002-03-02 20:41:57 +00004544/*
drh80e35f42007-03-30 14:06:34 +00004545** This routine is called to increment the database file change-counter,
4546** stored at byte 24 of the pager file.
4547*/
danielk1977c7b60172007-08-22 11:22:03 +00004548static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004549 PgHdr *pPgHdr;
4550 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004551 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004552
4553 if( !pPager->changeCountDone ){
4554 /* Open page 1 of the file for writing. */
4555 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4556 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004557
4558 if( !isDirect ){
4559 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00004560 if( rc!=SQLITE_OK ){
4561 sqlite3PagerUnref(pPgHdr);
4562 return rc;
4563 }
danielk1977c7b60172007-08-22 11:22:03 +00004564 }
4565
drh80e35f42007-03-30 14:06:34 +00004566 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004567 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004568 change_counter++;
4569 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004570
4571 if( isDirect && pPager->fd->pMethods ){
4572 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4573 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4574 }
4575
drh80e35f42007-03-30 14:06:34 +00004576 /* Release the page reference. */
4577 sqlite3PagerUnref(pPgHdr);
4578 pPager->changeCountDone = 1;
4579 }
danielk1977c7b60172007-08-22 11:22:03 +00004580 return rc;
drh80e35f42007-03-30 14:06:34 +00004581}
4582
4583/*
danielk1977f653d782008-03-20 11:04:21 +00004584** Sync the pager file to disk.
4585*/
4586int sqlite3PagerSync(Pager *pPager){
4587 int rc;
4588 pagerEnter(pPager);
4589 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
4590 pagerLeave(pPager);
4591 return rc;
4592}
4593
4594/*
drh80e35f42007-03-30 14:06:34 +00004595** Sync the database file for the pager pPager. zMaster points to the name
4596** of a master journal file that should be written into the individual
4597** journal file. zMaster may be NULL, which is interpreted as no master
4598** journal (a single database transaction).
4599**
4600** This routine ensures that the journal is synced, all dirty pages written
4601** to the database file and the database file synced. The only thing that
4602** remains to commit the transaction is to delete the journal file (or
4603** master journal file if specified).
4604**
4605** Note that if zMaster==NULL, this does not overwrite a previous value
4606** passed to an sqlite3PagerCommitPhaseOne() call.
4607**
4608** If parameter nTrunc is non-zero, then the pager file is truncated to
4609** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00004610**
4611** If the final parameter - noSync - is true, then the database file itself
4612** is not synced. The caller must call sqlite3PagerSync() directly to
4613** sync the database file before calling CommitPhaseTwo() to delete the
4614** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00004615*/
danielk1977f653d782008-03-20 11:04:21 +00004616int sqlite3PagerCommitPhaseOne(
4617 Pager *pPager,
4618 const char *zMaster,
4619 Pgno nTrunc,
4620 int noSync
4621){
drh80e35f42007-03-30 14:06:34 +00004622 int rc = SQLITE_OK;
4623
danielk1977dad31b52008-05-15 11:08:07 +00004624 if( pPager->errCode ){
4625 return pPager->errCode;
4626 }
4627
drhd138c012008-05-13 00:58:18 +00004628 /* If no changes have been made, we can leave the transaction early.
4629 */
4630 if( pPager->dbModified==0 &&
4631 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
4632 pPager->exclusiveMode!=0) ){
4633 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
4634 return SQLITE_OK;
4635 }
4636
drh80e35f42007-03-30 14:06:34 +00004637 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4638 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004639 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004640
4641 /* If this is an in-memory db, or no pages have been written to, or this
4642 ** function has already been called, it is a no-op.
4643 */
4644 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4645 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00004646
danielk1977c7b60172007-08-22 11:22:03 +00004647#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4648 /* The atomic-write optimization can be used if all of the
4649 ** following are true:
4650 **
4651 ** + The file-system supports the atomic-write property for
4652 ** blocks of size page-size, and
4653 ** + This commit is not part of a multi-file transaction, and
4654 ** + Exactly one page has been modified and store in the journal file.
4655 **
4656 ** If the optimization can be used, then the journal file will never
4657 ** be created for this transaction.
4658 */
danielk1977f55b8992007-08-24 08:15:53 +00004659 int useAtomicWrite = (
4660 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00004661 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00004662 pPager->journalOff==jrnlBufferSize(pPager) &&
4663 nTrunc==0 &&
4664 (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4665 );
danielk1977700b9c52008-04-24 12:37:40 +00004666 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00004667 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00004668 /* Update the nRec field in the journal file. */
4669 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4670 assert(pPager->nRec==1);
4671 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4672
4673 /* Update the db file change counter. The following call will modify
4674 ** the in-memory representation of page 1 to include the updated
4675 ** change counter and then write page 1 directly to the database
4676 ** file. Because of the atomic-write property of the host file-system,
4677 ** this is safe.
4678 */
danielk1977ae72d982007-10-03 08:46:44 +00004679 if( rc==SQLITE_OK ){
4680 rc = pager_incr_changecounter(pPager, 1);
4681 }
danielk1977f55b8992007-08-24 08:15:53 +00004682 }else{
4683 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00004684 }
4685
danielk1977ae72d982007-10-03 08:46:44 +00004686 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00004687#endif
4688
drh80e35f42007-03-30 14:06:34 +00004689 /* If a master journal file name has already been written to the
4690 ** journal file, then no sync is required. This happens when it is
4691 ** written, then the process fails to upgrade from a RESERVED to an
4692 ** EXCLUSIVE lock. The next time the process tries to commit the
4693 ** transaction the m-j name will have already been written.
4694 */
4695 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00004696 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004697 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00004698 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00004699#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00004700 if( nTrunc!=0 ){
4701 /* If this transaction has made the database smaller, then all pages
4702 ** being discarded by the truncation must be written to the journal
4703 ** file.
4704 */
4705 Pgno i;
4706 int iSkip = PAGER_MJ_PGNO(pPager);
4707 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
4708 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
4709 rc = sqlite3PagerGet(pPager, i, &pPg);
4710 if( rc!=SQLITE_OK ) goto sync_exit;
4711 rc = sqlite3PagerWrite(pPg);
4712 sqlite3PagerUnref(pPg);
4713 if( rc!=SQLITE_OK ) goto sync_exit;
4714 }
4715 }
4716 }
drh80e35f42007-03-30 14:06:34 +00004717#endif
danielk197771aa7ff2008-05-20 07:05:09 +00004718 rc = writeMasterJournal(pPager, zMaster);
4719 if( rc!=SQLITE_OK ) goto sync_exit;
4720 rc = syncJournal(pPager);
4721 }
drh80e35f42007-03-30 14:06:34 +00004722 }
danielk1977c7b60172007-08-22 11:22:03 +00004723 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004724
4725#ifndef SQLITE_OMIT_AUTOVACUUM
4726 if( nTrunc!=0 ){
4727 rc = sqlite3PagerTruncate(pPager, nTrunc);
4728 if( rc!=SQLITE_OK ) goto sync_exit;
4729 }
4730#endif
4731
4732 /* Write all dirty pages to the database file */
4733 pPg = pager_get_all_dirty_pages(pPager);
4734 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00004735 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00004736 assert( rc!=SQLITE_IOERR_BLOCKED );
4737 /* The error might have left the dirty list all fouled up here,
4738 ** but that does not matter because if the if the dirty list did
4739 ** get corrupted, then the transaction will roll back and
4740 ** discard the dirty list. There is an assert in
4741 ** pager_get_all_dirty_pages() that verifies that no attempt
4742 ** is made to use an invalid dirty list.
4743 */
drh153c62c2007-08-24 03:51:33 +00004744 goto sync_exit;
4745 }
drh3cdd7d32007-03-30 14:46:01 +00004746 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004747
4748 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00004749 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004750 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004751 }
4752 IOTRACE(("DBSYNC %p\n", pPager))
4753
4754 pPager->state = PAGER_SYNCED;
4755 }else if( MEMDB && nTrunc!=0 ){
4756 rc = sqlite3PagerTruncate(pPager, nTrunc);
4757 }
4758
4759sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004760 if( rc==SQLITE_IOERR_BLOCKED ){
4761 /* pager_incr_changecounter() may attempt to obtain an exclusive
4762 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00004763 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00004764 * better to return SQLITE_BUSY.
4765 */
4766 rc = SQLITE_BUSY;
4767 }
drh86f8c192007-08-22 00:39:19 +00004768 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004769 return rc;
4770}
4771
4772
4773/*
drhed7c8552001-04-11 14:29:21 +00004774** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004775**
4776** If the commit fails for any reason, a rollback attempt is made
4777** and an error code is returned. If the commit worked, SQLITE_OK
4778** is returned.
drhed7c8552001-04-11 14:29:21 +00004779*/
drh80e35f42007-03-30 14:06:34 +00004780int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004781 int rc;
drhed7c8552001-04-11 14:29:21 +00004782 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004783
danielk1977efaaf572006-01-16 11:29:19 +00004784 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004785 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004786 }
drha6abd042004-06-09 17:37:22 +00004787 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004788 return SQLITE_ERROR;
4789 }
drhd138c012008-05-13 00:58:18 +00004790 if( pPager->dbModified==0 &&
4791 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
4792 pPager->exclusiveMode!=0) ){
4793 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
4794 return SQLITE_OK;
4795 }
drh86f8c192007-08-22 00:39:19 +00004796 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004797 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004798 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004799 pPg = pager_get_all_dirty_pages(pPager);
4800 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004801 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4802 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004803 pPg->dirty = 0;
4804 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004805 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004806 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004807 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004808 pPg = pPg->pDirty;
4809 }
drh605ad8f2006-05-03 23:34:05 +00004810 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004811#ifndef NDEBUG
4812 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4813 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4814 assert( !pPg->alwaysRollback );
4815 assert( !pHist->pOrig );
4816 assert( !pHist->pStmt );
4817 }
4818#endif
drhac69b052004-05-12 13:30:07 +00004819 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004820 pPager->state = PAGER_SHARED;
danielk197787c29a92008-01-18 11:33:16 +00004821 pagerLeave(pPager);
drhac69b052004-05-12 13:30:07 +00004822 return SQLITE_OK;
4823 }
drh3cdd7d32007-03-30 14:46:01 +00004824 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
danielk1977df2566a2008-05-07 19:11:03 +00004825 rc = pager_end_transaction(pPager, pPager->setMaster);
drh86f8c192007-08-22 00:39:19 +00004826 rc = pager_error(pPager, rc);
4827 pagerLeave(pPager);
4828 return rc;
drhed7c8552001-04-11 14:29:21 +00004829}
4830
4831/*
drha6abd042004-06-09 17:37:22 +00004832** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004833** All in-memory cache pages revert to their original data contents.
4834** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004835**
4836** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004837** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004838** process is writing trash into the journal file (SQLITE_CORRUPT) or
4839** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4840** codes are returned for all these occasions. Otherwise,
4841** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004842*/
danielk19773b8a05f2007-03-19 17:44:26 +00004843int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004844 int rc;
drh4f0c5872007-03-26 22:05:01 +00004845 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004846 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004847 PgHdr *p;
4848 for(p=pPager->pAll; p; p=p->pNextAll){
4849 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004850 assert( !p->alwaysRollback );
4851 if( !p->dirty ){
4852 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4853 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4854 continue;
4855 }
4856
drhac69b052004-05-12 13:30:07 +00004857 pHist = PGHDR_TO_HIST(p, pPager);
4858 if( pHist->pOrig ){
4859 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004860 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004861 }else{
drh4f0c5872007-03-26 22:05:01 +00004862 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004863 }
4864 clearHistory(pHist);
4865 p->dirty = 0;
4866 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004867 pHist->inStmt = 0;
4868 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004869 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004870 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004871 }
drhac69b052004-05-12 13:30:07 +00004872 }
drh605ad8f2006-05-03 23:34:05 +00004873 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004874 pPager->pStmt = 0;
4875 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004876 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004877 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004878 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004879 return SQLITE_OK;
4880 }
4881
drh86f8c192007-08-22 00:39:19 +00004882 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004883 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00004884 rc = pager_end_transaction(pPager, pPager->setMaster);
drh86f8c192007-08-22 00:39:19 +00004885 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004886 return rc;
4887 }
drhdb48ee02003-01-16 13:42:43 +00004888
danielk1977efaaf572006-01-16 11:29:19 +00004889 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004890 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004891 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004892 }
drh86f8c192007-08-22 00:39:19 +00004893 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004894 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004895 }
drha6abd042004-06-09 17:37:22 +00004896 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004897 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004898 rc = pager_playback(pPager, 0);
danielk1977df2566a2008-05-07 19:11:03 +00004899 rc2 = pager_end_transaction(pPager, pPager->setMaster);
drha6abd042004-06-09 17:37:22 +00004900 if( rc==SQLITE_OK ){
4901 rc = rc2;
4902 }
4903 }else{
danielk1977e277be02007-03-23 18:12:06 +00004904 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004905 }
danielk1977e180dd92007-04-05 17:15:52 +00004906 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004907 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004908
4909 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4910 ** cache. So call pager_error() on the way out to make any error
4911 ** persistent.
4912 */
drh86f8c192007-08-22 00:39:19 +00004913 rc = pager_error(pPager, rc);
4914 pagerLeave(pPager);
4915 return rc;
drh98808ba2001-10-18 12:34:46 +00004916}
drhd9b02572001-04-15 00:37:09 +00004917
4918/*
drh5e00f6c2001-09-13 13:46:56 +00004919** Return TRUE if the database file is opened read-only. Return FALSE
4920** if the database is (in theory) writable.
4921*/
danielk19773b8a05f2007-03-19 17:44:26 +00004922int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004923 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004924}
4925
4926/*
drh0f7eb612006-08-08 13:51:43 +00004927** Return the number of references to the pager.
4928*/
danielk19773b8a05f2007-03-19 17:44:26 +00004929int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004930 return pPager->nRef;
4931}
4932
4933#ifdef SQLITE_TEST
4934/*
drhd9b02572001-04-15 00:37:09 +00004935** This routine is used for testing and analysis only.
4936*/
danielk19773b8a05f2007-03-19 17:44:26 +00004937int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004938 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004939 a[0] = pPager->nRef;
4940 a[1] = pPager->nPage;
4941 a[2] = pPager->mxPage;
4942 a[3] = pPager->dbSize;
4943 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004944 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004945 a[6] = pPager->nHit;
4946 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004947 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004948 a[9] = pPager->nRead;
4949 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004950 return a;
4951}
danielk197717b90b52008-06-06 11:11:25 +00004952int sqlite3PagerIsMemdb(Pager *pPager){
4953 return MEMDB;
4954}
drh0f7eb612006-08-08 13:51:43 +00004955#endif
drhdd793422001-06-28 01:54:48 +00004956
drhfa86c412002-02-02 15:01:15 +00004957/*
drhac69b052004-05-12 13:30:07 +00004958** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004959**
4960** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004961** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004962** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004963*/
drh86f8c192007-08-22 00:39:19 +00004964static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004965 int rc;
drhac69b052004-05-12 13:30:07 +00004966 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004967 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004968 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004969 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004970 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004971 pPager->stmtInUse = 1;
4972 pPager->stmtSize = pPager->dbSize;
4973 return SQLITE_OK;
4974 }
drhda47d772002-12-02 04:25:19 +00004975 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004976 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004977 return SQLITE_OK;
4978 }
drhfa86c412002-02-02 15:01:15 +00004979 assert( pPager->journalOpen );
drhed138fb2007-08-22 22:04:37 +00004980 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004981 assert( pPager->pInStmt==0 );
4982 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00004983 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004984 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004985 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004986 return SQLITE_NOMEM;
4987 }
danielk197776572402004-06-25 02:38:54 +00004988 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004989 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004990 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004991 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004992 if( !pPager->stmtOpen ){
danielk197717b90b52008-06-06 11:11:25 +00004993 rc = sqlite3PagerOpentemp(pPager, pPager->stfd, SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00004994 if( rc ){
4995 goto stmt_begin_failed;
4996 }
drhac69b052004-05-12 13:30:07 +00004997 pPager->stmtOpen = 1;
4998 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004999 }
drhac69b052004-05-12 13:30:07 +00005000 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00005001 return SQLITE_OK;
5002
drhac69b052004-05-12 13:30:07 +00005003stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00005004 if( pPager->pInStmt ){
5005 sqlite3BitvecDestroy(pPager->pInStmt);
5006 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00005007 }
5008 return rc;
5009}
drh86f8c192007-08-22 00:39:19 +00005010int sqlite3PagerStmtBegin(Pager *pPager){
5011 int rc;
5012 pagerEnter(pPager);
5013 rc = pagerStmtBegin(pPager);
5014 pagerLeave(pPager);
5015 return rc;
5016}
drhfa86c412002-02-02 15:01:15 +00005017
5018/*
drhac69b052004-05-12 13:30:07 +00005019** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00005020*/
danielk19773b8a05f2007-03-19 17:44:26 +00005021int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00005022 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00005023 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00005024 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00005025 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00005026 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00005027 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhf5e7bb52008-02-18 14:47:33 +00005028 sqlite3BitvecDestroy(pPager->pInStmt);
5029 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00005030 }else{
5031 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00005032 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00005033 pNext = pHist->pNextStmt;
5034 assert( pHist->inStmt );
5035 pHist->inStmt = 0;
5036 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00005037 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00005038 pHist->pStmt = 0;
5039 }
5040 }
5041 pPager->stmtNRec = 0;
5042 pPager->stmtInUse = 0;
5043 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00005044 }
drhac69b052004-05-12 13:30:07 +00005045 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00005046 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00005047 return SQLITE_OK;
5048}
5049
5050/*
drhac69b052004-05-12 13:30:07 +00005051** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00005052*/
danielk19773b8a05f2007-03-19 17:44:26 +00005053int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00005054 int rc;
drh86f8c192007-08-22 00:39:19 +00005055 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00005056 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00005057 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00005058 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00005059 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00005060 PgHistory *pHist;
5061 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
5062 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00005063 if( pHist->pStmt ){
5064 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00005065 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00005066 pHist->pStmt = 0;
5067 }
5068 }
5069 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00005070 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00005071 rc = SQLITE_OK;
5072 }else{
5073 rc = pager_stmt_playback(pPager);
5074 }
danielk19773b8a05f2007-03-19 17:44:26 +00005075 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00005076 }else{
5077 rc = SQLITE_OK;
5078 }
drhac69b052004-05-12 13:30:07 +00005079 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00005080 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00005081 return rc;
5082}
5083
drh73509ee2003-04-06 20:44:45 +00005084/*
5085** Return the full pathname of the database file.
5086*/
danielk19773b8a05f2007-03-19 17:44:26 +00005087const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00005088 return pPager->zFilename;
5089}
5090
drhb20ea9d2004-02-09 01:20:36 +00005091/*
drhd0679ed2007-08-28 22:24:34 +00005092** Return the VFS structure for the pager.
5093*/
5094const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
5095 return pPager->pVfs;
5096}
5097
5098/*
drhcc6bb3e2007-08-31 16:11:35 +00005099** Return the file handle for the database file associated
5100** with the pager. This might return NULL if the file has
5101** not yet been opened.
5102*/
5103sqlite3_file *sqlite3PagerFile(Pager *pPager){
5104 return pPager->fd;
5105}
5106
5107/*
danielk19775865e3d2004-06-14 06:03:57 +00005108** Return the directory of the database file.
5109*/
danielk19773b8a05f2007-03-19 17:44:26 +00005110const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005111 return pPager->zDirectory;
5112}
5113
5114/*
5115** Return the full pathname of the journal file.
5116*/
danielk19773b8a05f2007-03-19 17:44:26 +00005117const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005118 return pPager->zJournal;
5119}
5120
5121/*
drh2c8997b2005-08-27 16:36:48 +00005122** Return true if fsync() calls are disabled for this pager. Return FALSE
5123** if fsync()s are executed normally.
5124*/
danielk19773b8a05f2007-03-19 17:44:26 +00005125int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00005126 return pPager->noSync;
5127}
5128
drh7c4ac0c2007-04-05 11:25:58 +00005129#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00005130/*
drhb20ea9d2004-02-09 01:20:36 +00005131** Set the codec for this pager
5132*/
danielk19773b8a05f2007-03-19 17:44:26 +00005133void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00005134 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00005135 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00005136 void *pCodecArg
5137){
5138 pPager->xCodec = xCodec;
5139 pPager->pCodecArg = pCodecArg;
5140}
drh7c4ac0c2007-04-05 11:25:58 +00005141#endif
drhb20ea9d2004-02-09 01:20:36 +00005142
danielk1977687566d2004-11-02 12:56:41 +00005143#ifndef SQLITE_OMIT_AUTOVACUUM
5144/*
danielk197787c29a92008-01-18 11:33:16 +00005145** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00005146**
drh5e385312007-06-16 04:42:12 +00005147** There must be no references to the page previously located at
5148** pgno (which we call pPgOld) though that page is allowed to be
5149** in cache. If the page previous located at pgno is not already
5150** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00005151**
drh5e385312007-06-16 04:42:12 +00005152** References to the page pPg remain valid. Updating any
5153** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00005154** allocated along with the page) is the responsibility of the caller.
5155**
danielk19775fd057a2005-03-09 13:09:43 +00005156** A transaction must be active when this routine is called. It used to be
5157** required that a statement transaction was not active, but this restriction
5158** has been removed (CREATE INDEX needs to move a page when a statement
5159** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00005160*/
danielk19773b8a05f2007-03-19 17:44:26 +00005161int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00005162 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00005163 int h;
danielk197794daf7f2004-11-08 09:26:09 +00005164 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00005165
drh86f8c192007-08-22 00:39:19 +00005166 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005167 assert( pPg->nRef>0 );
5168
drh4f0c5872007-03-26 22:05:01 +00005169 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00005170 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00005171 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00005172
danielk1977b4626a32007-04-28 15:47:43 +00005173 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00005174 if( pPg->needSync ){
5175 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00005176 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00005177 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00005178 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00005179 }
5180
drh85b623f2007-12-13 21:54:09 +00005181 /* Unlink pPg from its hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00005182 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00005183
danielk1977ef73ee92004-11-06 12:26:07 +00005184 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00005185 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00005186 ** page pgno before the 'move' operation, it needs to be retained
5187 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00005188 */
drh5e385312007-06-16 04:42:12 +00005189 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00005190 pPgOld = pager_lookup(pPager, pgno);
5191 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00005192 assert( pPgOld->nRef==0 );
5193 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00005194 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00005195 pPg->needSync = pPgOld->needSync;
5196 }else{
5197 pPg->needSync = 0;
5198 }
drhf5e7bb52008-02-18 14:47:33 +00005199 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
danielk1977687566d2004-11-02 12:56:41 +00005200
danielk1977f5fdda82004-11-03 08:44:05 +00005201 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00005202 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00005203 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00005204 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00005205 if( pPager->aHash[h] ){
5206 assert( pPager->aHash[h]->pPrevHash==0 );
5207 pPager->aHash[h]->pPrevHash = pPg;
5208 }
5209 pPg->pNextHash = pPager->aHash[h];
5210 pPager->aHash[h] = pPg;
5211 pPg->pPrevHash = 0;
5212
drh605ad8f2006-05-03 23:34:05 +00005213 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00005214 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00005215 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00005216
danielk197794daf7f2004-11-08 09:26:09 +00005217 if( needSyncPgno ){
5218 /* If needSyncPgno is non-zero, then the journal file needs to be
5219 ** sync()ed before any data is written to database file page needSyncPgno.
5220 ** Currently, no such page exists in the page-cache and the
drhf5e7bb52008-02-18 14:47:33 +00005221 ** Pager.pInJournal bit has been set. This needs to be remedied by loading
danielk197794daf7f2004-11-08 09:26:09 +00005222 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00005223 **
danielk1977a98d7b42008-01-18 13:42:54 +00005224 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00005225 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00005226 ** array. Otherwise, if the page is loaded and written again in
5227 ** this transaction, it may be written to the database file before
5228 ** it is synced into the journal file. This way, it may end up in
5229 ** the journal file twice, but that is not a problem.
5230 **
danielk19773b8a05f2007-03-19 17:44:26 +00005231 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00005232 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00005233 */
5234 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005235 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00005236 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00005237 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00005238 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00005239 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
5240 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00005241 }
danielk197787c29a92008-01-18 11:33:16 +00005242 pagerLeave(pPager);
5243 return rc;
5244 }
danielk1977ae825582004-11-23 09:06:55 +00005245 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00005246 pPgHdr->needSync = 1;
5247 pPgHdr->inJournal = 1;
5248 makeDirty(pPgHdr);
5249 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005250 }
5251
drh86f8c192007-08-22 00:39:19 +00005252 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005253 return SQLITE_OK;
5254}
5255#endif
5256
danielk19773b8a05f2007-03-19 17:44:26 +00005257/*
5258** Return a pointer to the data for the specified page.
5259*/
5260void *sqlite3PagerGetData(DbPage *pPg){
5261 return PGHDR_TO_DATA(pPg);
5262}
5263
5264/*
5265** Return a pointer to the Pager.nExtra bytes of "extra" space
5266** allocated along with the specified page.
5267*/
5268void *sqlite3PagerGetExtra(DbPage *pPg){
5269 Pager *pPager = pPg->pPager;
5270 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
5271}
5272
danielk197741483462007-03-24 16:45:04 +00005273/*
5274** Get/set the locking-mode for this pager. Parameter eMode must be one
5275** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
5276** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
5277** the locking-mode is set to the value specified.
5278**
5279** The returned value is either PAGER_LOCKINGMODE_NORMAL or
5280** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
5281** locking-mode.
5282*/
5283int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00005284 assert( eMode==PAGER_LOCKINGMODE_QUERY
5285 || eMode==PAGER_LOCKINGMODE_NORMAL
5286 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
5287 assert( PAGER_LOCKINGMODE_QUERY<0 );
5288 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
5289 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00005290 pPager->exclusiveMode = eMode;
5291 }
5292 return (int)pPager->exclusiveMode;
5293}
5294
drh3b020132008-04-17 17:02:01 +00005295/*
5296** Get/set the journal-mode for this pager. Parameter eMode must be one
5297** of PAGER_JOURNALMODE_QUERY, PAGER_JOURNALMODE_DELETE or
5298** PAGER_JOURNALMODE_PERSIST. If the parameter is not _QUERY, then
5299** the journal-mode is set to the value specified.
5300**
5301** The returned value is either PAGER_JOURNALMODE_DELETE or
5302** PAGER_JOURNALMODE_PERSIST, indicating the current (possibly updated)
5303** journal-mode.
5304*/
5305int sqlite3PagerJournalMode(Pager *pPager, int eMode){
5306 assert( eMode==PAGER_JOURNALMODE_QUERY
5307 || eMode==PAGER_JOURNALMODE_DELETE
drhfdc40e92008-04-17 20:59:37 +00005308 || eMode==PAGER_JOURNALMODE_PERSIST
5309 || eMode==PAGER_JOURNALMODE_OFF );
drh3b020132008-04-17 17:02:01 +00005310 assert( PAGER_JOURNALMODE_QUERY<0 );
5311 assert( PAGER_JOURNALMODE_DELETE>=0 && PAGER_JOURNALMODE_PERSIST>=0 );
drhfdc40e92008-04-17 20:59:37 +00005312 if( eMode>=0 ){
5313 pPager->journalMode = eMode;
drh3b020132008-04-17 17:02:01 +00005314 }
drhfdc40e92008-04-17 20:59:37 +00005315 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00005316}
5317
danielk1977b53e4962008-06-04 06:45:59 +00005318/*
5319** Get/set the size-limit used for persistent journal files.
5320*/
5321i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
5322 if( iLimit>=-1 ){
5323 pPager->journalSizeLimit = iLimit;
5324 }
5325 return pPager->journalSizeLimit;
5326}
5327
drhd919fe12007-12-11 19:34:44 +00005328#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00005329/*
5330** Print a listing of all referenced pages and their ref count.
5331*/
danielk19773b8a05f2007-03-19 17:44:26 +00005332void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00005333 PgHdr *pPg;
5334 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
5335 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00005336 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
5337 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00005338 }
5339}
5340#endif
drh2e66f0b2005-04-28 17:18:48 +00005341
5342#endif /* SQLITE_OMIT_DISKIO */