blob: 44298cea160d708d2953f2bcede51ad60fb01392 [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**
danielk1977b53e4962008-06-04 06:45:59 +000021** @(#) $Id: pager.c,v 1.451 2008/06/04 06:45:59 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 */
drh334b2992007-09-06 23:28:23 +0000375 char *zStmtJrnl; /* Name of the statement journal file */
danielk197762079062007-08-15 17:08:46 +0000376 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
377 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000378 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
danielk19779f61c2f2007-08-27 17:27:49 +0000379 PagerLruList lru; /* LRU list of free pages */
drhd9b02572001-04-15 00:37:09 +0000380 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000381 PgHdr *pStmt; /* List of pages in the statement subjournal */
drh605ad8f2006-05-03 23:34:05 +0000382 PgHdr *pDirty; /* List of all dirty pages */
drheb206252004-10-01 02:00:31 +0000383 i64 journalOff; /* Current byte offset in the journal file */
384 i64 journalHdr; /* Byte offset to previous journal header */
385 i64 stmtHdrOff; /* First journal header written this statement */
386 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000387 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000388 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000389#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000390 int nHit, nMiss; /* Cache hits and missing */
391 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000392#endif
danielk19773b8a05f2007-03-19 17:44:26 +0000393 void (*xDestructor)(DbPage*,int); /* Call this routine when freeing pages */
394 void (*xReiniter)(DbPage*,int); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000395#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000396 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000397 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000398#endif
drh8ca0c722006-05-07 17:49:38 +0000399 int nHash; /* Size of the pager hash table */
400 PgHdr **aHash; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000401#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +0000402 Pager *pNext; /* Doubly linked list of pagers on which */
403 Pager *pPrev; /* sqlite3_release_memory() will work */
drh80105af2008-05-21 15:38:14 +0000404 volatile int iInUseMM; /* Non-zero if unavailable to MM */
405 volatile int iInUseDB; /* Non-zero if in sqlite3_release_memory() */
danielk197713f72992005-12-18 08:51:22 +0000406#endif
danielk19778186df82007-03-06 13:45:59 +0000407 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000408 char dbFileVers[16]; /* Changes whenever database file changes */
danielk1977b53e4962008-06-04 06:45:59 +0000409 i64 journalSizeLimit; /* Size limit for persistent journal files */
drhd9b02572001-04-15 00:37:09 +0000410};
411
412/*
drh538f5702007-04-13 02:14:30 +0000413** The following global variables hold counters used for
414** testing purposes only. These variables do not exist in
415** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000416*/
417#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000418int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
419int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
420int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
421int sqlite3_pager_pgfree_count = 0; /* Number of cache pages freed */
422# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000423#else
drh538f5702007-04-13 02:14:30 +0000424# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000425#endif
426
drh86f8c192007-08-22 00:39:19 +0000427/*
428** The following variable points to the head of a double-linked list
429** of all pagers that are eligible for page stealing by the
430** sqlite3_release_memory() interface. Access to this list is
431** protected by the SQLITE_MUTEX_STATIC_MEM2 mutex.
432*/
433#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
434static Pager *sqlite3PagerList = 0;
danielk19779f61c2f2007-08-27 17:27:49 +0000435static PagerLruList sqlite3LruPageList = {0, 0, 0};
drh86f8c192007-08-22 00:39:19 +0000436#endif
drh538f5702007-04-13 02:14:30 +0000437
438
drhfcd35c72005-05-21 02:48:08 +0000439/*
drh5e00f6c2001-09-13 13:46:56 +0000440** Journal files begin with the following magic string. The data
441** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000442**
drhae2b40c2004-06-09 19:03:54 +0000443** Since version 2.8.0, the journal format contains additional sanity
444** checking information. If the power fails while the journal is begin
445** written, semi-random garbage data might appear in the journal
446** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000447** to roll the journal back, the database could be corrupted. The additional
448** sanity checking data is an attempt to discover the garbage in the
449** journal and ignore it.
450**
drhae2b40c2004-06-09 19:03:54 +0000451** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000452** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000453** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000454** This cksum is initialized to a 32-bit random value that appears in the
455** journal file right after the header. The random initializer is important,
456** because garbage data that appears at the end of a journal is likely
457** data that was once in other files that have now been deleted. If the
458** garbage data came from an obsolete journal file, the checksums might
459** be correct. But by initializing the checksum to random value which
460** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000461*/
drhae2b40c2004-06-09 19:03:54 +0000462static const unsigned char aJournalMagic[] = {
463 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000464};
465
466/*
drh726de592004-06-10 23:35:50 +0000467** The size of the header and of each page in the journal is determined
468** by the following macros.
drh968af522003-02-11 14:55:40 +0000469*/
drhae2b40c2004-06-09 19:03:54 +0000470#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000471
danielk197776572402004-06-25 02:38:54 +0000472/*
473** The journal header size for this pager. In the future, this could be
474** set to some value read from the disk controller. The important
475** characteristic is that it is the same size as a disk sector.
476*/
477#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
478
drhb7f91642004-10-31 02:22:47 +0000479/*
480** The macro MEMDB is true if we are dealing with an in-memory database.
481** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
482** the value of MEMDB will be a constant and the compiler will optimize
483** out code that would never execute.
484*/
485#ifdef SQLITE_OMIT_MEMORYDB
486# define MEMDB 0
487#else
488# define MEMDB pPager->memDb
489#endif
490
491/*
danielk197776572402004-06-25 02:38:54 +0000492** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
493** reserved for working around a windows/posix incompatibility). It is
494** used in the journal to signify that the remainder of the journal file
495** is devoted to storing a master journal name - there are no more pages to
496** roll back. See comments for function writeMasterJournal() for details.
497*/
danielk1977599fcba2004-11-08 07:13:13 +0000498/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
499#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000500
drh968af522003-02-11 14:55:40 +0000501/*
danielk197726836652005-01-17 01:33:13 +0000502** The maximum legal page number is (2^31 - 1).
503*/
504#define PAGER_MAX_PGNO 2147483647
505
506/*
drh86f8c192007-08-22 00:39:19 +0000507** The pagerEnter() and pagerLeave() routines acquire and release
508** a mutex on each pager. The mutex is recursive.
509**
510** This is a special-purpose mutex. It only provides mutual exclusion
511** between the Btree and the Memory Management sqlite3_release_memory()
512** function. It does not prevent, for example, two Btrees from accessing
513** the same pager at the same time. Other general-purpose mutexes in
514** the btree layer handle that chore.
515*/
516#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
517 static void pagerEnter(Pager *p){
518 p->iInUseDB++;
519 if( p->iInUseMM && p->iInUseDB==1 ){
drh26e4a8b2008-05-01 17:16:52 +0000520#ifndef SQLITE_MUTEX_NOOP
drh64e2bb72008-05-07 12:29:55 +0000521 sqlite3_mutex *mutex;
drh86f8c192007-08-22 00:39:19 +0000522 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +0000523#endif
drh86f8c192007-08-22 00:39:19 +0000524 p->iInUseDB = 0;
525 sqlite3_mutex_enter(mutex);
526 p->iInUseDB = 1;
527 sqlite3_mutex_leave(mutex);
528 }
529 assert( p->iInUseMM==0 );
530 }
531 static void pagerLeave(Pager *p){
532 p->iInUseDB--;
533 assert( p->iInUseDB>=0 );
534 }
535#else
536# define pagerEnter(X)
537# define pagerLeave(X)
538#endif
539
540/*
danielk197784f786f2007-08-28 08:00:17 +0000541** Add page pPg to the end of the linked list managed by structure
542** pList (pPg becomes the last entry in the list - the most recently
543** used). Argument pLink should point to either pPg->free or pPg->gfree,
544** depending on whether pPg is being added to the pager-specific or
545** global LRU list.
546*/
danielk19779f61c2f2007-08-27 17:27:49 +0000547static void listAdd(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
548 pLink->pNext = 0;
549 pLink->pPrev = pList->pLast;
550
danielk197784f786f2007-08-28 08:00:17 +0000551#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
552 assert(pLink==&pPg->free || pLink==&pPg->gfree);
553 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
554#endif
555
danielk19779f61c2f2007-08-27 17:27:49 +0000556 if( pList->pLast ){
557 int iOff = (char *)pLink - (char *)pPg;
558 PagerLruLink *pLastLink = (PagerLruLink *)(&((u8 *)pList->pLast)[iOff]);
559 pLastLink->pNext = pPg;
560 }else{
561 assert(!pList->pFirst);
562 pList->pFirst = pPg;
563 }
564
565 pList->pLast = pPg;
566 if( !pList->pFirstSynced && pPg->needSync==0 ){
567 pList->pFirstSynced = pPg;
568 }
569}
570
danielk197784f786f2007-08-28 08:00:17 +0000571/*
572** Remove pPg from the list managed by the structure pointed to by pList.
573**
574** Argument pLink should point to either pPg->free or pPg->gfree, depending
575** on whether pPg is being added to the pager-specific or global LRU list.
576*/
danielk19779f61c2f2007-08-27 17:27:49 +0000577static void listRemove(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
578 int iOff = (char *)pLink - (char *)pPg;
579
danielk197784f786f2007-08-28 08:00:17 +0000580#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
581 assert(pLink==&pPg->free || pLink==&pPg->gfree);
582 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
583#endif
584
danielk19779f61c2f2007-08-27 17:27:49 +0000585 if( pPg==pList->pFirst ){
586 pList->pFirst = pLink->pNext;
587 }
588 if( pPg==pList->pLast ){
589 pList->pLast = pLink->pPrev;
590 }
591 if( pLink->pPrev ){
592 PagerLruLink *pPrevLink = (PagerLruLink *)(&((u8 *)pLink->pPrev)[iOff]);
593 pPrevLink->pNext = pLink->pNext;
594 }
595 if( pLink->pNext ){
596 PagerLruLink *pNextLink = (PagerLruLink *)(&((u8 *)pLink->pNext)[iOff]);
597 pNextLink->pPrev = pLink->pPrev;
598 }
599 if( pPg==pList->pFirstSynced ){
600 PgHdr *p = pLink->pNext;
601 while( p && p->needSync ){
602 PagerLruLink *pL = (PagerLruLink *)(&((u8 *)p)[iOff]);
603 p = pL->pNext;
604 }
605 pList->pFirstSynced = p;
606 }
607
608 pLink->pNext = pLink->pPrev = 0;
609}
610
611/*
danielk197784f786f2007-08-28 08:00:17 +0000612** Add page pPg to the list of free pages for the pager. If
613** memory-management is enabled, also add the page to the global
614** list of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000615*/
616static void lruListAdd(PgHdr *pPg){
617 listAdd(&pPg->pPager->lru, &pPg->free, pPg);
618#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
619 if( !pPg->pPager->memDb ){
620 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
621 listAdd(&sqlite3LruPageList, &pPg->gfree, pPg);
622 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
623 }
624#endif
625}
626
627/*
danielk197784f786f2007-08-28 08:00:17 +0000628** Remove page pPg from the list of free pages for the associated pager.
629** If memory-management is enabled, also remove pPg from the global list
630** of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000631*/
632static void lruListRemove(PgHdr *pPg){
633 listRemove(&pPg->pPager->lru, &pPg->free, pPg);
634#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
635 if( !pPg->pPager->memDb ){
636 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
637 listRemove(&sqlite3LruPageList, &pPg->gfree, pPg);
638 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
639 }
640#endif
641}
642
643/*
danielk197784f786f2007-08-28 08:00:17 +0000644** This function is called just after the needSync flag has been cleared
645** from all pages managed by pPager (usually because the journal file
646** has just been synced). It updates the pPager->lru.pFirstSynced variable
647** and, if memory-management is enabled, the sqlite3LruPageList.pFirstSynced
648** variable also.
danielk19779f61c2f2007-08-27 17:27:49 +0000649*/
650static void lruListSetFirstSynced(Pager *pPager){
651 pPager->lru.pFirstSynced = pPager->lru.pFirst;
652#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
653 if( !pPager->memDb ){
654 PgHdr *p;
655 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
656 for(p=sqlite3LruPageList.pFirst; p && p->needSync; p=p->gfree.pNext);
657 assert(p==pPager->lru.pFirstSynced || p==sqlite3LruPageList.pFirstSynced);
658 sqlite3LruPageList.pFirstSynced = p;
659 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
660 }
661#endif
662}
663
danielk1977f35843b2007-04-07 15:03:17 +0000664/*
665** Return true if page *pPg has already been written to the statement
666** journal (or statement snapshot has been created, if *pPg is part
667** of an in-memory database).
668*/
669static int pageInStatement(PgHdr *pPg){
670 Pager *pPager = pPg->pPager;
671 if( MEMDB ){
672 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
673 }else{
drhf5e7bb52008-02-18 14:47:33 +0000674 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000675 }
676}
drh8ca0c722006-05-07 17:49:38 +0000677
678/*
679** Change the size of the pager hash table to N. N must be a power
680** of two.
681*/
682static void pager_resize_hash_table(Pager *pPager, int N){
683 PgHdr **aHash, *pPg;
684 assert( N>0 && (N&(N-1))==0 );
drheee4c8c2008-02-18 22:24:57 +0000685#ifdef SQLITE_MALLOC_SOFT_LIMIT
686 if( N*sizeof(aHash[0])>SQLITE_MALLOC_SOFT_LIMIT ){
687 N = SQLITE_MALLOC_SOFT_LIMIT/sizeof(aHash[0]);
688 }
689 if( N==pPager->nHash ) return;
690#endif
drhed138fb2007-08-22 22:04:37 +0000691 pagerLeave(pPager);
drh4873d5f2008-05-13 13:27:33 +0000692 if( pPager->aHash!=0 ) sqlite3FaultBeginBenign(SQLITE_FAULTINJECTOR_MALLOC);
drh17435752007-08-16 04:30:38 +0000693 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drh4873d5f2008-05-13 13:27:33 +0000694 if( pPager->aHash!=0 ) sqlite3FaultEndBenign(SQLITE_FAULTINJECTOR_MALLOC);
drhed138fb2007-08-22 22:04:37 +0000695 pagerEnter(pPager);
drh8ca0c722006-05-07 17:49:38 +0000696 if( aHash==0 ){
697 /* Failure to rehash is not an error. It is only a performance hit. */
698 return;
699 }
drh17435752007-08-16 04:30:38 +0000700 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000701 pPager->nHash = N;
702 pPager->aHash = aHash;
703 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000704 int h;
705 if( pPg->pgno==0 ){
706 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
707 continue;
708 }
709 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000710 pPg->pNextHash = aHash[h];
711 if( aHash[h] ){
712 aHash[h]->pPrevHash = pPg;
713 }
714 aHash[h] = pPg;
715 pPg->pPrevHash = 0;
716 }
717}
718
drhdd793422001-06-28 01:54:48 +0000719/*
drh34e79ce2004-02-08 06:05:46 +0000720** Read a 32-bit integer from the given file descriptor. Store the integer
721** that is read in *pRes. Return SQLITE_OK if everything worked, or an
722** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000723**
724** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000725*/
danielk197762079062007-08-15 17:08:46 +0000726static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000727 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000728 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000729 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000730 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000731 }
drh94f33312002-08-12 12:29:56 +0000732 return rc;
733}
734
735/*
drh97b57482006-01-10 20:32:32 +0000736** Write a 32-bit integer into a string buffer in big-endian byte order.
737*/
drha3152892007-05-05 11:48:52 +0000738#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000739
740/*
drh34e79ce2004-02-08 06:05:46 +0000741** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
742** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000743*/
danielk197762079062007-08-15 17:08:46 +0000744static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000745 char ac[4];
drh97b57482006-01-10 20:32:32 +0000746 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000747 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000748}
749
drh2554f8b2003-01-22 01:26:44 +0000750/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000751** If file pFd is open, call sqlite3OsUnlock() on it.
752*/
753static int osUnlock(sqlite3_file *pFd, int eLock){
754 if( !pFd->pMethods ){
755 return SQLITE_OK;
756 }
757 return sqlite3OsUnlock(pFd, eLock);
758}
759
760/*
danielk1977c7b60172007-08-22 11:22:03 +0000761** This function determines whether or not the atomic-write optimization
762** can be used with this pager. The optimization can be used if:
763**
764** (a) the value returned by OsDeviceCharacteristics() indicates that
765** a database page may be written atomically, and
766** (b) the value returned by OsSectorSize() is less than or equal
767** to the page size.
768**
769** If the optimization cannot be used, 0 is returned. If it can be used,
770** then the value returned is the size of the journal file when it
771** contains rollback data for exactly one page.
772*/
773#ifdef SQLITE_ENABLE_ATOMIC_WRITE
774static int jrnlBufferSize(Pager *pPager){
775 int dc; /* Device characteristics */
776 int nSector; /* Sector size */
777 int nPage; /* Page size */
778 sqlite3_file *fd = pPager->fd;
779
780 if( fd->pMethods ){
781 dc = sqlite3OsDeviceCharacteristics(fd);
782 nSector = sqlite3OsSectorSize(fd);
783 nPage = pPager->pageSize;
784 }
785
786 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
787 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
788
danielk1977f8940ae2007-08-23 11:07:10 +0000789 if( !fd->pMethods || (dc&(SQLITE_IOCAP_ATOMIC|(nPage>>8))&&nSector<=nPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000790 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
791 }
792 return 0;
793}
794#endif
795
796/*
danielk1977aef0bf62005-12-30 16:28:01 +0000797** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000798** code. The first argument is a pointer to the pager structure, the
799** second the error-code about to be returned by a pager API function.
800** The value returned is a copy of the second argument to this function.
801**
drh4f0ee682007-03-30 20:43:40 +0000802** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000803** the error becomes persistent. Until the persisten error is cleared,
804** subsequent API calls on this Pager will immediately return the same
805** error code.
806**
807** A persistent error indicates that the contents of the pager-cache
808** cannot be trusted. This state can be cleared by completely discarding
809** the contents of the pager-cache. If a transaction was active when
810** the persistent error occured, then the rollback journal may need
811** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000812*/
danielk1977ae72d982007-10-03 08:46:44 +0000813static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000814static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000815 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000816 assert(
817 pPager->errCode==SQLITE_FULL ||
818 pPager->errCode==SQLITE_OK ||
819 (pPager->errCode & 0xff)==SQLITE_IOERR
820 );
danielk1977979f38e2007-03-27 16:19:51 +0000821 if(
drh4ac285a2006-09-15 07:28:50 +0000822 rc2==SQLITE_FULL ||
823 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000824 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000825 ){
826 pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000827 if( pPager->state==PAGER_UNLOCK && pPager->nRef==0 ){
828 /* If the pager is already unlocked, call pager_unlock() now to
829 ** clear the error state and ensure that the pager-cache is
830 ** completely empty.
831 */
832 pager_unlock(pPager);
833 }
danielk1977aef0bf62005-12-30 16:28:01 +0000834 }
835 return rc;
836}
837
drh477731b2007-06-16 03:06:27 +0000838/*
839** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
840** on the cache using a hash function. This is used for testing
841** and debugging only.
842*/
danielk19773c407372005-02-15 02:54:14 +0000843#ifdef SQLITE_CHECK_PAGES
844/*
845** Return a 32-bit hash of the page data for pPage.
846*/
drh477731b2007-06-16 03:06:27 +0000847static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000848 u32 hash = 0;
849 int i;
drh477731b2007-06-16 03:06:27 +0000850 for(i=0; i<nByte; i++){
851 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000852 }
853 return hash;
854}
drh477731b2007-06-16 03:06:27 +0000855static u32 pager_pagehash(PgHdr *pPage){
856 return pager_datahash(pPage->pPager->pageSize,
857 (unsigned char *)PGHDR_TO_DATA(pPage));
858}
danielk19773c407372005-02-15 02:54:14 +0000859
860/*
861** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
862** is defined, and NDEBUG is not defined, an assert() statement checks
863** that the page is either dirty or still matches the calculated page-hash.
864*/
865#define CHECK_PAGE(x) checkPage(x)
866static void checkPage(PgHdr *pPg){
867 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000868 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000869 pPg->pageHash==pager_pagehash(pPg) );
870}
871
872#else
drh8ffa8172007-06-18 17:25:17 +0000873#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000874#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000875#define CHECK_PAGE(x)
876#endif
877
drhed7c8552001-04-11 14:29:21 +0000878/*
danielk197776572402004-06-25 02:38:54 +0000879** When this is called the journal file for pager pPager must be open.
880** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000881** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000882**
danielk197765839c62007-08-30 08:08:17 +0000883** zMaster must point to a buffer of at least nMaster bytes allocated by
884** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
885** enough space to write the master journal name). If the master journal
886** name in the journal is longer than nMaster bytes (including a
887** nul-terminator), then this is handled as if no master journal name
888** were present in the journal.
889**
890** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000891** SQLITE_OK returned.
892*/
danielk197765839c62007-08-30 08:08:17 +0000893static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000894 int rc;
895 u32 len;
drheb206252004-10-01 02:00:31 +0000896 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000897 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000898 int i;
danielk197776572402004-06-25 02:38:54 +0000899 unsigned char aMagic[8]; /* A buffer to hold the magic header */
900
danielk197765839c62007-08-30 08:08:17 +0000901 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000902
drh054889e2005-11-30 03:20:31 +0000903 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000904 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000905
danielk197762079062007-08-15 17:08:46 +0000906 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000907 if( rc!=SQLITE_OK ) return rc;
908
danielk197765839c62007-08-30 08:08:17 +0000909 if( len>=nMaster ){
910 return SQLITE_OK;
911 }
912
danielk197762079062007-08-15 17:08:46 +0000913 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000914 if( rc!=SQLITE_OK ) return rc;
915
danielk197762079062007-08-15 17:08:46 +0000916 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000917 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
918
danielk197765839c62007-08-30 08:08:17 +0000919 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000920 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000921 return rc;
922 }
danielk197765839c62007-08-30 08:08:17 +0000923 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000924
925 /* See if the checksum matches the master journal name */
926 for(i=0; i<len; i++){
danielk197765839c62007-08-30 08:08:17 +0000927 cksum -= zMaster[i];
928 }
danielk19778191bff2004-06-28 04:52:30 +0000929 if( cksum ){
930 /* If the checksum doesn't add up, then one or more of the disk sectors
931 ** containing the master journal filename is corrupted. This means
932 ** definitely roll back, so just return SQLITE_OK and report a (nul)
933 ** master-journal filename.
934 */
danielk197765839c62007-08-30 08:08:17 +0000935 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000936 }
danielk197776572402004-06-25 02:38:54 +0000937
938 return SQLITE_OK;
939}
940
941/*
942** Seek the journal file descriptor to the next sector boundary where a
943** journal header may be read or written. Pager.journalOff is updated with
944** the new seek offset.
945**
946** i.e for a sector size of 512:
947**
948** Input Offset Output Offset
949** ---------------------------------------
950** 0 0
951** 512 512
952** 100 512
953** 2000 2048
954**
955*/
danielk197762079062007-08-15 17:08:46 +0000956static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000957 i64 offset = 0;
958 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000959 if( c ){
960 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
961 }
962 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
963 assert( offset>=c );
964 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
965 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000966}
967
968/*
drhf3a87622008-04-17 14:16:42 +0000969** Write zeros over the header of the journal file. This has the
970** effect of invalidating the journal file and committing the
971** transaction.
972*/
danielk1977df2566a2008-05-07 19:11:03 +0000973static int zeroJournalHdr(Pager *pPager, int doTruncate){
974 int rc = SQLITE_OK;
drhf3a87622008-04-17 14:16:42 +0000975 static const char zeroHdr[28];
976
danielk1977df2566a2008-05-07 19:11:03 +0000977 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000978 i64 iLimit = pPager->journalSizeLimit;
979
danielk1977df2566a2008-05-07 19:11:03 +0000980 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000981 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000982 rc = sqlite3OsTruncate(pPager->jfd, 0);
983 }else{
984 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
985 }
986 if( rc==SQLITE_OK ){
987 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
988 }
danielk1977b53e4962008-06-04 06:45:59 +0000989
990 /* At this point the transaction is committed but the write lock
991 ** is still held on the file. If there is a size limit configured for
992 ** the persistent journal and the journal file currently consumes more
993 ** space than that limit allows for, truncate it now. There is no need
994 ** to sync the file following this operation.
995 */
996 if( rc==SQLITE_OK && iLimit>0 ){
997 i64 sz;
998 rc = sqlite3OsFileSize(pPager->jfd, &sz);
999 if( rc==SQLITE_OK && sz>iLimit ){
1000 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
1001 }
1002 }
drha06ecba2008-04-22 17:15:17 +00001003 }
drhf3a87622008-04-17 14:16:42 +00001004 return rc;
1005}
1006
1007/*
danielk197776572402004-06-25 02:38:54 +00001008** The journal file must be open when this routine is called. A journal
1009** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
1010** current location.
1011**
1012** The format for the journal header is as follows:
1013** - 8 bytes: Magic identifying journal format.
1014** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
1015** - 4 bytes: Random number used for page hash.
1016** - 4 bytes: Initial database page count.
1017** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +00001018** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +00001019**
danielk197767c007b2008-03-20 04:45:49 +00001020** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +00001021*/
1022static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +00001023 int rc = SQLITE_OK;
1024 char *zHeader = pPager->pTmpSpace;
1025 int nHeader = pPager->pageSize;
1026 int nWrite;
1027
1028 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
1029 nHeader = JOURNAL_HDR_SZ(pPager);
1030 }
danielk197776572402004-06-25 02:38:54 +00001031
danielk19774099f6e2007-03-19 11:25:20 +00001032 if( pPager->stmtHdrOff==0 ){
1033 pPager->stmtHdrOff = pPager->journalOff;
1034 }
1035
danielk197762079062007-08-15 17:08:46 +00001036 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001037 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001038
drh97b57482006-01-10 20:32:32 +00001039 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +00001040
1041 /*
1042 ** Write the nRec Field - the number of page records that follow this
1043 ** journal header. Normally, zero is written to this value at this time.
1044 ** After the records are added to the journal (and the journal synced,
1045 ** if in full-sync mode), the zero is overwritten with the true number
1046 ** of records (see syncJournal()).
1047 **
1048 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
1049 ** reading the journal this value tells SQLite to assume that the
1050 ** rest of the journal file contains valid page records. This assumption
1051 ** is dangerous, as if a failure occured whilst writing to the journal
1052 ** file it may contain some garbage data. There are two scenarios
1053 ** where this risk can be ignored:
1054 **
1055 ** * When the pager is in no-sync mode. Corruption can follow a
1056 ** power failure in this case anyway.
1057 **
1058 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
1059 ** that garbage data is never appended to the journal file.
1060 */
1061 assert(pPager->fd->pMethods||pPager->noSync);
1062 if( (pPager->noSync)
1063 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
1064 ){
1065 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
1066 }else{
1067 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
1068 }
1069
drh97b57482006-01-10 20:32:32 +00001070 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +00001071 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +00001072 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
1073 /* The initial database size */
1074 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
1075 /* The assumed sector size for this process */
1076 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +00001077 if( pPager->journalHdr==0 ){
1078 /* The page size */
1079 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
1080 }
danielk197776572402004-06-25 02:38:54 +00001081
danielk1977a664f8e2008-04-22 14:31:48 +00001082 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
1083 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
1084 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
1085 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +00001086 }
danielk1977a664f8e2008-04-22 14:31:48 +00001087
danielk197776572402004-06-25 02:38:54 +00001088 return rc;
1089}
1090
1091/*
1092** The journal file must be open when this is called. A journal header file
1093** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
1094** file. See comments above function writeJournalHdr() for a description of
1095** the journal header format.
1096**
1097** If the header is read successfully, *nRec is set to the number of
1098** page records following this header and *dbSize is set to the size of the
1099** database before the transaction began, in pages. Also, pPager->cksumInit
1100** is set to the value read from the journal header. SQLITE_OK is returned
1101** in this case.
1102**
1103** If the journal header file appears to be corrupted, SQLITE_DONE is
1104** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
1105** cannot be read from the journal file an error code is returned.
1106*/
1107static int readJournalHdr(
1108 Pager *pPager,
drheb206252004-10-01 02:00:31 +00001109 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +00001110 u32 *pNRec,
1111 u32 *pDbSize
1112){
1113 int rc;
1114 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +00001115 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +00001116 int iPageSize;
danielk197776572402004-06-25 02:38:54 +00001117
danielk197762079062007-08-15 17:08:46 +00001118 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001119 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
1120 return SQLITE_DONE;
1121 }
danielk197762079062007-08-15 17:08:46 +00001122 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001123
danielk197762079062007-08-15 17:08:46 +00001124 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001125 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +00001126 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +00001127
1128 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
1129 return SQLITE_DONE;
1130 }
1131
danielk197762079062007-08-15 17:08:46 +00001132 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +00001133 if( rc ) return rc;
1134
danielk197762079062007-08-15 17:08:46 +00001135 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +00001136 if( rc ) return rc;
1137
danielk197762079062007-08-15 17:08:46 +00001138 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +00001139 if( rc ) return rc;
1140
danielk197767c007b2008-03-20 04:45:49 +00001141 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
1142 if( rc==SQLITE_OK
1143 && iPageSize>=512
1144 && iPageSize<=SQLITE_MAX_PAGE_SIZE
1145 && ((iPageSize-1)&iPageSize)==0
1146 ){
1147 u16 pagesize = iPageSize;
1148 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
1149 }
1150 if( rc ) return rc;
1151
danielk197776572402004-06-25 02:38:54 +00001152 /* Update the assumed sector-size to match the value used by
1153 ** the process that created this journal. If this journal was
1154 ** created by a process other than this one, then this routine
1155 ** is being called from within pager_playback(). The local value
1156 ** of Pager.sectorSize is restored at the end of that routine.
1157 */
danielk197762079062007-08-15 17:08:46 +00001158 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +00001159 if( rc ) return rc;
1160
1161 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +00001162 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +00001163}
1164
1165
1166/*
1167** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +00001168** pPager at the current location. The master journal name must be the last
1169** thing written to a journal file. If the pager is in full-sync mode, the
1170** journal file descriptor is advanced to the next sector boundary before
1171** anything is written. The format is:
1172**
1173** + 4 bytes: PAGER_MJ_PGNO.
1174** + N bytes: length of master journal name.
1175** + 4 bytes: N
1176** + 4 bytes: Master journal name checksum.
1177** + 8 bytes: aJournalMagic[].
1178**
1179** The master journal page checksum is the sum of the bytes in the master
1180** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +00001181**
1182** If zMaster is a NULL pointer (occurs for a single database transaction),
1183** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +00001184*/
1185static int writeMasterJournal(Pager *pPager, const char *zMaster){
1186 int rc;
1187 int len;
danielk1977cafadba2004-06-25 11:11:54 +00001188 int i;
danielk197762079062007-08-15 17:08:46 +00001189 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +00001190 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +00001191 u32 cksum = 0;
1192 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +00001193
1194 if( !zMaster || pPager->setMaster) return SQLITE_OK;
1195 pPager->setMaster = 1;
1196
1197 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +00001198 for(i=0; i<len; i++){
1199 cksum += zMaster[i];
1200 }
danielk197776572402004-06-25 02:38:54 +00001201
1202 /* If in full-sync mode, advance to the next disk sector before writing
1203 ** the master journal name. This is in case the previous page written to
1204 ** the journal has already been synced.
1205 */
1206 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +00001207 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001208 }
danielk197762079062007-08-15 17:08:46 +00001209 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +00001210 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +00001211
danielk197762079062007-08-15 17:08:46 +00001212 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +00001213 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001214 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +00001215
danielk197762079062007-08-15 17:08:46 +00001216 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001217 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001218 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +00001219
drh97b57482006-01-10 20:32:32 +00001220 put32bits(zBuf, len);
1221 put32bits(&zBuf[4], cksum);
1222 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +00001223 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +00001224 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +00001225 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +00001226
1227 /* If the pager is in peristent-journal mode, then the physical
1228 ** journal-file may extend past the end of the master-journal name
1229 ** and 8 bytes of magic data just written to the file. This is
1230 ** dangerous because the code to rollback a hot-journal file
1231 ** will not be able to find the master-journal name to determine
1232 ** whether or not the journal is hot.
1233 **
1234 ** Easiest thing to do in this scenario is to truncate the journal
1235 ** file to the required size.
1236 */
1237 if( (rc==SQLITE_OK)
1238 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
1239 && jrnlSize>jrnlOff
1240 ){
1241 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
1242 }
danielk197776572402004-06-25 02:38:54 +00001243 return rc;
1244}
1245
1246/*
drh03eb96a2002-11-10 23:32:56 +00001247** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +00001248** statement journal.
drh03eb96a2002-11-10 23:32:56 +00001249**
1250** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +00001251** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +00001252** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +00001253** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +00001254*/
drh3aac2dd2004-04-26 14:10:20 +00001255static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +00001256 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +00001257 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1258 assert( MEMDB );
1259 if( !pHist->inStmt ){
1260 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
1261 if( pPager->pStmt ){
1262 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
1263 }
1264 pHist->pNextStmt = pPager->pStmt;
1265 pPager->pStmt = pPg;
1266 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +00001267 }
drh03eb96a2002-11-10 23:32:56 +00001268}
1269
1270/*
drhed7c8552001-04-11 14:29:21 +00001271** Find a page in the hash table given its page number. Return
1272** a pointer to the page or NULL if not found.
1273*/
drhd9b02572001-04-15 00:37:09 +00001274static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +00001275 PgHdr *p;
1276 if( pPager->aHash==0 ) return 0;
1277 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +00001278 while( p && p->pgno!=pgno ){
1279 p = p->pNextHash;
1280 }
1281 return p;
1282}
1283
1284/*
danielk1977e180dd92007-04-05 17:15:52 +00001285** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +00001286** sets the state of the pager back to what it was when it was first
1287** opened. Any outstanding pages are invalidated and subsequent attempts
1288** to access those pages will likely result in a coredump.
1289*/
drhd9b02572001-04-15 00:37:09 +00001290static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00001291 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +00001292 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +00001293 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +00001294 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
1295 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +00001296 pNext = pPg->pNextAll;
danielk19779f61c2f2007-08-27 17:27:49 +00001297 lruListRemove(pPg);
drh0d180202008-02-14 23:26:56 +00001298 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00001299 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +00001300 }
danielk19779f61c2f2007-08-27 17:27:49 +00001301 assert(pPager->lru.pFirst==0);
1302 assert(pPager->lru.pFirstSynced==0);
1303 assert(pPager->lru.pLast==0);
danielk1977b94bf852007-03-19 13:53:37 +00001304 pPager->pStmt = 0;
drhd9b02572001-04-15 00:37:09 +00001305 pPager->pAll = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001306 pPager->pDirty = 0;
drh8ca0c722006-05-07 17:49:38 +00001307 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +00001308 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +00001309 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +00001310 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +00001311 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +00001312}
1313
1314/*
danielk1977ae72d982007-10-03 08:46:44 +00001315** Unlock the database file.
1316**
1317** If the pager is currently in error state, discard the contents of
1318** the cache and reset the Pager structure internal state. If there is
1319** an open journal-file, then the next time a shared-lock is obtained
1320** on the pager file (by this or any other process), it will be
1321** treated as a hot-journal and rolled back.
1322*/
1323static void pager_unlock(Pager *pPager){
1324 if( !pPager->exclusiveMode ){
1325 if( !MEMDB ){
drh1aa5af12008-03-07 19:51:14 +00001326 int rc = osUnlock(pPager->fd, NO_LOCK);
drh308aa322008-03-07 20:14:38 +00001327 if( rc ) pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +00001328 pPager->dbSize = -1;
1329 IOTRACE(("UNLOCK %p\n", pPager))
1330
drh16e45a42008-04-19 20:34:18 +00001331 /* Always close the journal file when dropping the database lock.
1332 ** Otherwise, another connection with journal_mode=delete might
1333 ** delete the file out from under us.
1334 */
1335 if( pPager->journalOpen ){
1336 sqlite3OsClose(pPager->jfd);
1337 pPager->journalOpen = 0;
1338 sqlite3BitvecDestroy(pPager->pInJournal);
1339 pPager->pInJournal = 0;
1340 }
1341
danielk1977ae72d982007-10-03 08:46:44 +00001342 /* If Pager.errCode is set, the contents of the pager cache cannot be
1343 ** trusted. Now that the pager file is unlocked, the contents of the
1344 ** cache can be discarded and the error code safely cleared.
1345 */
1346 if( pPager->errCode ){
drh1aa5af12008-03-07 19:51:14 +00001347 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00001348 pager_reset(pPager);
1349 if( pPager->stmtOpen ){
1350 sqlite3OsClose(pPager->stfd);
drhf5e7bb52008-02-18 14:47:33 +00001351 sqlite3BitvecDestroy(pPager->pInStmt);
1352 pPager->pInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001353 }
danielk1977ae72d982007-10-03 08:46:44 +00001354 pPager->stmtOpen = 0;
1355 pPager->stmtInUse = 0;
1356 pPager->journalOff = 0;
1357 pPager->journalStarted = 0;
1358 pPager->stmtAutoopen = 0;
1359 pPager->origDbSize = 0;
1360 }
1361 }
1362
1363 if( !MEMDB || pPager->errCode==SQLITE_OK ){
1364 pPager->state = PAGER_UNLOCK;
1365 pPager->changeCountDone = 0;
1366 }
1367 }
1368}
1369
1370/*
1371** Execute a rollback if a transaction is active and unlock the
1372** database file. If the pager has already entered the error state,
1373** do not attempt the rollback.
1374*/
1375static void pagerUnlockAndRollback(Pager *p){
drhfdc40e92008-04-17 20:59:37 +00001376 /* assert( p->state>=PAGER_RESERVED || p->journalOpen==0 ); */
danielk1977ae72d982007-10-03 08:46:44 +00001377 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
drh4873d5f2008-05-13 13:27:33 +00001378 sqlite3FaultBeginBenign(-1);
danielk1977ae72d982007-10-03 08:46:44 +00001379 sqlite3PagerRollback(p);
drh4873d5f2008-05-13 13:27:33 +00001380 sqlite3FaultEndBenign(-1);
danielk1977ae72d982007-10-03 08:46:44 +00001381 }
1382 pager_unlock(p);
drhfdc40e92008-04-17 20:59:37 +00001383#if 0
danielk1977ae72d982007-10-03 08:46:44 +00001384 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
1385 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drhfdc40e92008-04-17 20:59:37 +00001386#endif
danielk1977ae72d982007-10-03 08:46:44 +00001387}
1388
1389/*
drh80e35f42007-03-30 14:06:34 +00001390** This routine ends a transaction. A transaction is ended by either
1391** a COMMIT or a ROLLBACK.
1392**
drhed7c8552001-04-11 14:29:21 +00001393** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001394** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1395** the database lock and acquires a SHARED lock in its place if that is
1396** the appropriate thing to do. Release locks usually is appropriate,
1397** unless we are in exclusive access mode or unless this is a
1398** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1399**
1400** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001401**
1402** TODO: Consider keeping the journal file open for temporary databases.
1403** This might give a performance improvement on windows where opening
1404** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001405*/
danielk1977df2566a2008-05-07 19:11:03 +00001406static int pager_end_transaction(Pager *pPager, int hasMaster){
drhd9b02572001-04-15 00:37:09 +00001407 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001408 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001409 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001410 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001411 if( pPager->state<PAGER_RESERVED ){
1412 return SQLITE_OK;
1413 }
danielk19773b8a05f2007-03-19 17:44:26 +00001414 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001415 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001416 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001417 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001418 }
drhda47d772002-12-02 04:25:19 +00001419 if( pPager->journalOpen ){
danielk197793f7af92008-05-09 16:57:50 +00001420 if( pPager->exclusiveMode
1421 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
1422 ){
1423 rc = zeroJournalHdr(pPager, hasMaster);
1424 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +00001425 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001426 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001427 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001428 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001429 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +00001430 if( rc==SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001431 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001432 }
danielk197741483462007-03-24 16:45:04 +00001433 }
drhf5e7bb52008-02-18 14:47:33 +00001434 sqlite3BitvecDestroy(pPager->pInJournal);
1435 pPager->pInJournal = 0;
drhda47d772002-12-02 04:25:19 +00001436 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1437 pPg->inJournal = 0;
1438 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001439 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001440 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001441#ifdef SQLITE_CHECK_PAGES
1442 pPg->pageHash = pager_pagehash(pPg);
1443#endif
drhda47d772002-12-02 04:25:19 +00001444 }
drh605ad8f2006-05-03 23:34:05 +00001445 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001446 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001447 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001448 }else{
drhf5e7bb52008-02-18 14:47:33 +00001449 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001450 }
danielk1977979f38e2007-03-27 16:19:51 +00001451
danielk197741483462007-03-24 16:45:04 +00001452 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001453 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001454 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001455 }else if( pPager->state==PAGER_SYNCED ){
1456 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001457 }
danielk1977334cdb62007-03-26 08:05:12 +00001458 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001459 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001460 pPager->needSync = 0;
danielk19779f61c2f2007-08-27 17:27:49 +00001461 lruListSetFirstSynced(pPager);
drh588f5bc2007-01-02 18:41:54 +00001462 pPager->dbSize = -1;
drhd138c012008-05-13 00:58:18 +00001463 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001464
1465 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001466}
1467
drhed7c8552001-04-11 14:29:21 +00001468/*
drh968af522003-02-11 14:55:40 +00001469** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001470**
1471** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001472** random initial value and the page number. We experimented with
1473** a checksum of the entire data, but that was found to be too slow.
1474**
1475** Note that the page number is stored at the beginning of data and
1476** the checksum is stored at the end. This is important. If journal
1477** corruption occurs due to a power failure, the most likely scenario
1478** is that one end or the other of the record will be changed. It is
1479** much less likely that the two ends of the journal record will be
1480** correct and the middle be corrupt. Thus, this "checksum" scheme,
1481** though fast and simple, catches the mostly likely kind of corruption.
1482**
1483** FIX ME: Consider adding every 200th (or so) byte of the data to the
1484** checksum. That way if a single page spans 3 or more disk sectors and
1485** only the middle sector is corrupt, we will still have a reasonable
1486** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001487*/
drh74161702006-02-24 02:53:49 +00001488static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001489 u32 cksum = pPager->cksumInit;
1490 int i = pPager->pageSize-200;
1491 while( i>0 ){
1492 cksum += aData[i];
1493 i -= 200;
1494 }
drh968af522003-02-11 14:55:40 +00001495 return cksum;
1496}
1497
drh605ad8f2006-05-03 23:34:05 +00001498/* Forward declaration */
1499static void makeClean(PgHdr*);
1500
drh968af522003-02-11 14:55:40 +00001501/*
drhfa86c412002-02-02 15:01:15 +00001502** Read a single page from the journal file opened on file descriptor
1503** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001504**
drh726de592004-06-10 23:35:50 +00001505** If useCksum==0 it means this journal does not use checksums. Checksums
1506** are not used in statement journals because statement journals do not
1507** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001508*/
danielk197762079062007-08-15 17:08:46 +00001509static int pager_playback_one_page(
1510 Pager *pPager,
1511 sqlite3_file *jfd,
1512 i64 offset,
1513 int useCksum
1514){
drhfa86c412002-02-02 15:01:15 +00001515 int rc;
drhae2b40c2004-06-09 19:03:54 +00001516 PgHdr *pPg; /* An existing page in the cache */
1517 Pgno pgno; /* The page number of a page in journal */
1518 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001519 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001520
drh96362842005-03-20 22:47:56 +00001521 /* useCksum should be true for the main journal and false for
1522 ** statement journals. Verify that this is always the case
1523 */
drh9cbe6352005-11-29 03:13:21 +00001524 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001525 assert( aData );
drh96362842005-03-20 22:47:56 +00001526
danielk197762079062007-08-15 17:08:46 +00001527 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001528 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001529 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001530 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001531 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001532
drh968af522003-02-11 14:55:40 +00001533 /* Sanity checking on the page. This is more important that I originally
1534 ** thought. If a power failure occurs while the journal is being written,
1535 ** it could cause invalid data to be written into the journal. We need to
1536 ** detect this invalid data (with high probability) and ignore it.
1537 */
danielk197775edc162004-06-26 01:48:18 +00001538 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001539 return SQLITE_DONE;
1540 }
drhae2b40c2004-06-09 19:03:54 +00001541 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001542 return SQLITE_OK;
1543 }
drhae2b40c2004-06-09 19:03:54 +00001544 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001545 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001546 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001547 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001548 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001549 return SQLITE_DONE;
1550 }
1551 }
drhfa86c412002-02-02 15:01:15 +00001552
danielk1977aa5ccdf2004-06-14 05:10:42 +00001553 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001554
1555 /* If the pager is in RESERVED state, then there must be a copy of this
1556 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001557 ** not the database file. The page is left marked dirty in this case.
1558 **
danielk19772df71c72007-05-24 07:22:42 +00001559 ** An exception to the above rule: If the database is in no-sync mode
1560 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001561 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1562 ** during a Movepage() call, then the page may not be in the cache
1563 ** either. So the condition described in the above paragraph is not
1564 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001565 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001566 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1567 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001568 **
1569 ** Ticket #1171: The statement journal might contain page content that is
1570 ** different from the page content at the start of the transaction.
1571 ** This occurs when a page is changed prior to the start of a statement
1572 ** then changed again within the statement. When rolling back such a
1573 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001574 ** for certain that original page contents are synced into the main rollback
1575 ** journal. Otherwise, a power loss might leave modified data in the
1576 ** database file without an entry in the rollback journal that can
1577 ** restore the database to its original form. Two conditions must be
1578 ** met before writing to the database files. (1) the database must be
1579 ** locked. (2) we know that the original page content is fully synced
1580 ** in the main journal either because the page is not in cache or else
1581 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001582 **
1583 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1584 ** is possible to fail a statement on a database that does not yet exist.
1585 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001586 */
drhae2b40c2004-06-09 19:03:54 +00001587 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001588 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1589 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh4c02a232008-04-14 23:13:45 +00001590 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0)
1591 && pPager->fd->pMethods ){
danielk197762079062007-08-15 17:08:46 +00001592 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1593 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001594 if( pPg ){
1595 makeClean(pPg);
1596 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001597 }
drhfa86c412002-02-02 15:01:15 +00001598 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001599 /* No page should ever be explicitly rolled back that is in use, except
1600 ** for page 1 which is held in use in order to keep the lock on the
1601 ** database active. However such a page may be rolled back as a result
1602 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001603 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001604 */
drhb6f41482004-05-14 01:58:11 +00001605 void *pData;
danielk197728129562005-01-11 10:25:06 +00001606 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001607 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001608 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001609 if( pPager->xReiniter ){
1610 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001611 }
danielk19773c407372005-02-15 02:54:14 +00001612#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001613 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001614#endif
drh86a88112007-04-16 15:02:19 +00001615 /* If this was page 1, then restore the value of Pager.dbFileVers.
1616 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001617 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001618 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001619 }
drh86a88112007-04-16 15:02:19 +00001620
1621 /* Decode the page just read from disk */
1622 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001623 }
1624 return rc;
1625}
1626
1627/*
danielk197713adf8a2004-06-03 16:08:41 +00001628** Parameter zMaster is the name of a master journal file. A single journal
1629** file that referred to the master journal file has just been rolled back.
1630** This routine checks if it is possible to delete the master journal file,
1631** and does so if it is.
drh726de592004-06-10 23:35:50 +00001632**
danielk197765839c62007-08-30 08:08:17 +00001633** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1634** available for use within this function.
1635**
1636**
drh726de592004-06-10 23:35:50 +00001637** The master journal file contains the names of all child journals.
1638** To tell if a master journal can be deleted, check to each of the
1639** children. If all children are either missing or do not refer to
1640** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001641*/
danielk1977b4b47412007-08-17 15:53:36 +00001642static int pager_delmaster(Pager *pPager, const char *zMaster){
1643 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001644 int rc;
1645 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001646 sqlite3_file *pMaster;
1647 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001648 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001649 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001650
1651 /* Open the master journal file exclusively in case some other process
1652 ** is running this routine also. Not that it makes too much difference.
1653 */
danielk1977b4b47412007-08-17 15:53:36 +00001654 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001655 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001656 if( !pMaster ){
1657 rc = SQLITE_NOMEM;
1658 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001659 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1660 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001661 }
danielk197713adf8a2004-06-03 16:08:41 +00001662 if( rc!=SQLITE_OK ) goto delmaster_out;
1663 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001664
1665 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001666 if( rc!=SQLITE_OK ) goto delmaster_out;
1667
1668 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001669 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001670 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001671 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001672
1673 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001674 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001675 */
danielk197765839c62007-08-30 08:08:17 +00001676 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001677 if( !zMasterJournal ){
1678 rc = SQLITE_NOMEM;
1679 goto delmaster_out;
1680 }
danielk197765839c62007-08-30 08:08:17 +00001681 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001682 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001683 if( rc!=SQLITE_OK ) goto delmaster_out;
1684
danielk19775865e3d2004-06-14 06:03:57 +00001685 zJournal = zMasterJournal;
1686 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh19db9352008-03-27 22:42:51 +00001687 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS);
1688 if( rc!=0 && rc!=1 ){
1689 rc = SQLITE_IOERR_NOMEM;
1690 goto delmaster_out;
1691 }
1692 if( rc==1 ){
danielk197713adf8a2004-06-03 16:08:41 +00001693 /* One of the journals pointed to by the master journal exists.
1694 ** Open it and check if it points at the master journal. If
1695 ** so, return without deleting the master journal file.
1696 */
drh3b7b78b2004-11-24 01:16:43 +00001697 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001698 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1699 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001700 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001701 goto delmaster_out;
1702 }
danielk197713adf8a2004-06-03 16:08:41 +00001703
danielk197765839c62007-08-30 08:08:17 +00001704 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001705 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001706 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001707 goto delmaster_out;
1708 }
danielk197776572402004-06-25 02:38:54 +00001709
danielk197765839c62007-08-30 08:08:17 +00001710 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001711 if( c ){
danielk197776572402004-06-25 02:38:54 +00001712 /* We have a match. Do not delete the master journal file. */
1713 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001714 }
1715 }
danielk19775865e3d2004-06-14 06:03:57 +00001716 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001717 }
1718 }
1719
danielk1977fee2d252007-08-18 10:59:19 +00001720 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001721
1722delmaster_out:
1723 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001724 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001725 }
1726 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001727 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001728 }
danielk1977b4b47412007-08-17 15:53:36 +00001729 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001730 return rc;
1731}
1732
drha6abd042004-06-09 17:37:22 +00001733
danielk1977e180dd92007-04-05 17:15:52 +00001734static void pager_truncate_cache(Pager *pPager);
1735
drha6abd042004-06-09 17:37:22 +00001736/*
drhcb4c40b2004-08-18 19:09:43 +00001737** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001738** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001739**
1740** Might might be the case that the file on disk is smaller than nPage.
1741** This can happen, for example, if we are in the middle of a transaction
1742** which has extended the file size and the new pages are still all held
1743** in cache, then an INSERT or UPDATE does a statement rollback. Some
1744** operating system implementations can get confused if you try to
1745** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001746** so detect this case and write a single zero byte to the end of the new
1747** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001748*/
1749static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001750 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001751 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001752 i64 currentSize, newSize;
1753 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1754 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001755 if( rc==SQLITE_OK && currentSize!=newSize ){
1756 if( currentSize>newSize ){
1757 rc = sqlite3OsTruncate(pPager->fd, newSize);
1758 }else{
1759 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1760 }
drh7fe3f7e2007-11-29 18:44:27 +00001761 }
danielk1977e180dd92007-04-05 17:15:52 +00001762 }
1763 if( rc==SQLITE_OK ){
1764 pPager->dbSize = nPage;
1765 pager_truncate_cache(pPager);
1766 }
1767 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001768}
1769
1770/*
drhc80f0582007-05-01 16:59:48 +00001771** Set the sectorSize for the given pager.
1772**
drh334c80d2008-03-28 17:41:13 +00001773** The sector size is at least as big as the sector size reported
1774** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001775*/
1776static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001777 assert(pPager->fd->pMethods||pPager->tempFile);
1778 if( !pPager->tempFile ){
1779 /* Sector size doesn't matter for temporary files. Also, the file
1780 ** may not have been opened yet, in whcih case the OsSectorSize()
1781 ** call will segfault.
1782 */
1783 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1784 }
drh334c80d2008-03-28 17:41:13 +00001785 if( pPager->sectorSize<512 ){
1786 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001787 }
1788}
1789
1790/*
drhed7c8552001-04-11 14:29:21 +00001791** Playback the journal and thus restore the database file to
1792** the state it was in before we started making changes.
1793**
drh34e79ce2004-02-08 06:05:46 +00001794** The journal file format is as follows:
1795**
drhae2b40c2004-06-09 19:03:54 +00001796** (1) 8 byte prefix. A copy of aJournalMagic[].
1797** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001798** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001799** number of page records from the journal size.
1800** (3) 4 byte big-endian integer which is the initial value for the
1801** sanity checksum.
1802** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001803** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001804** (5) 4 byte big-endian integer which is the sector size. The header
1805** is this many bytes in size.
1806** (6) 4 byte big-endian integer which is the page case.
1807** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001808** name. The value may be zero (indicate that there is no master
1809** journal.)
drh334c80d2008-03-28 17:41:13 +00001810** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001811** and might be shorter than the value read from (5). If the first byte
1812** of the name is \000 then there is no master journal. The master
1813** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001814** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001815** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001816** + pPager->pageSize bytes of data.
1817** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001818**
drh334c80d2008-03-28 17:41:13 +00001819** When we speak of the journal header, we mean the first 8 items above.
1820** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001821**
1822** Call the value from the second bullet "nRec". nRec is the number of
1823** valid page entries in the journal. In most cases, you can compute the
1824** value of nRec from the size of the journal file. But if a power
1825** failure occurred while the journal was being written, it could be the
1826** case that the size of the journal file had already been increased but
1827** the extra entries had not yet made it safely to disk. In such a case,
1828** the value of nRec computed from the file size would be too large. For
1829** that reason, we always use the nRec value in the header.
1830**
1831** If the nRec value is 0xffffffff it means that nRec should be computed
1832** from the file size. This value is used when the user selects the
1833** no-sync option for the journal. A power failure could lead to corruption
1834** in this case. But for things like temporary table (which will be
1835** deleted when the power is restored) we don't care.
1836**
drhd9b02572001-04-15 00:37:09 +00001837** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001838** journal file then all pages up to the first corrupted page are rolled
1839** back (or no pages if the journal header is corrupted). The journal file
1840** is then deleted and SQLITE_OK returned, just as if no corruption had
1841** been encountered.
1842**
1843** If an I/O or malloc() error occurs, the journal-file is not deleted
1844** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001845*/
danielk1977e277be02007-03-23 18:12:06 +00001846static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001847 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001848 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001849 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001850 int i; /* Loop counter */
1851 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001852 int rc; /* Result code of a subroutine */
danielk1977ce98bba2008-04-03 10:13:01 +00001853 int res = 0; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001854 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001855
drhc3a64ba2001-11-22 00:01:27 +00001856 /* Figure out how many records are in the journal. Abort early if
1857 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001858 */
drh8cfbf082001-09-19 13:22:39 +00001859 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001860 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001861 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001862 goto end_playback;
1863 }
drh240c5792004-02-08 00:40:52 +00001864
danielk197776572402004-06-25 02:38:54 +00001865 /* Read the master journal name from the journal, if it is present.
1866 ** If a master journal file name is specified, but the file is not
1867 ** present on disk, then the journal is not hot and does not need to be
1868 ** played back.
drh240c5792004-02-08 00:40:52 +00001869 */
danielk197765839c62007-08-30 08:08:17 +00001870 zMaster = pPager->pTmpSpace;
1871 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977ce98bba2008-04-03 10:13:01 +00001872 if( rc!=SQLITE_OK || (zMaster[0]
1873 && (res=sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS))==0 )
danielk1977b4b47412007-08-17 15:53:36 +00001874 ){
danielk197776572402004-06-25 02:38:54 +00001875 zMaster = 0;
drhc3a64ba2001-11-22 00:01:27 +00001876 goto end_playback;
1877 }
danielk197765839c62007-08-30 08:08:17 +00001878 zMaster = 0;
danielk1977ce98bba2008-04-03 10:13:01 +00001879 if( res<0 ){
1880 rc = SQLITE_IOERR_NOMEM;
1881 goto end_playback;
1882 }
1883 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001884
danielk197776572402004-06-25 02:38:54 +00001885 /* This loop terminates either when the readJournalHdr() call returns
1886 ** SQLITE_DONE or an IO error occurs. */
1887 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001888
danielk197776572402004-06-25 02:38:54 +00001889 /* Read the next journal header from the journal file. If there are
1890 ** not enough bytes left in the journal file for a complete header, or
1891 ** it is corrupted, then a process must of failed while writing it.
1892 ** This indicates nothing more needs to be rolled back.
1893 */
1894 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1895 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001896 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001897 rc = SQLITE_OK;
1898 }
danielk197776572402004-06-25 02:38:54 +00001899 goto end_playback;
1900 }
1901
1902 /* If nRec is 0xffffffff, then this journal was created by a process
1903 ** working in no-sync mode. This means that the rest of the journal
1904 ** file consists of pages, there are no more journal headers. Compute
1905 ** the value of nRec based on this assumption.
1906 */
1907 if( nRec==0xffffffff ){
1908 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1909 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1910 }
1911
danielk1977e277be02007-03-23 18:12:06 +00001912 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001913 ** process and if this is the final header in the journal, then it means
1914 ** that this part of the journal was being filled but has not yet been
1915 ** synced to disk. Compute the number of pages based on the remaining
1916 ** size of the file.
1917 **
1918 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001919 */
drh8940f4e2007-08-11 00:26:20 +00001920 if( nRec==0 && !isHot &&
1921 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001922 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1923 }
1924
danielk197776572402004-06-25 02:38:54 +00001925 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001926 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001927 */
danielk1977e180dd92007-04-05 17:15:52 +00001928 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001929 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001930 if( rc!=SQLITE_OK ){
1931 goto end_playback;
1932 }
danielk197776572402004-06-25 02:38:54 +00001933 }
1934
danielk197776572402004-06-25 02:38:54 +00001935 /* Copy original pages out of the journal and back into the database file.
1936 */
1937 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001938 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001939 if( rc!=SQLITE_OK ){
1940 if( rc==SQLITE_DONE ){
1941 rc = SQLITE_OK;
1942 pPager->journalOff = szJ;
1943 break;
1944 }else{
1945 goto end_playback;
1946 }
1947 }
drh968af522003-02-11 14:55:40 +00001948 }
drhed7c8552001-04-11 14:29:21 +00001949 }
drh580eeaf2006-02-24 03:09:37 +00001950 /*NOTREACHED*/
1951 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001952
1953end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001954 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001955 zMaster = pPager->pTmpSpace;
1956 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1957 }
1958 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001959 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001960 }
danielk197765839c62007-08-30 08:08:17 +00001961 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001962 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001963 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001964 */
danielk197765839c62007-08-30 08:08:17 +00001965 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001966 }
danielk197776572402004-06-25 02:38:54 +00001967
1968 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001969 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001970 ** value. Reset it to the correct value for this process.
1971 */
drhc80f0582007-05-01 16:59:48 +00001972 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001973 return rc;
drhed7c8552001-04-11 14:29:21 +00001974}
1975
1976/*
drhac69b052004-05-12 13:30:07 +00001977** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001978**
1979** This is similar to playing back the transaction journal but with
1980** a few extra twists.
1981**
drh663fc632002-02-02 18:49:19 +00001982** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001983** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001984** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001985**
drhac69b052004-05-12 13:30:07 +00001986** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001987** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001988** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001989*/
drh3aac2dd2004-04-26 14:10:20 +00001990static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001991 i64 szJ; /* Size of the full journal */
1992 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001993 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001994 int i; /* Loop counter */
1995 int rc;
1996
danielk197776572402004-06-25 02:38:54 +00001997 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001998
danielk19774099f6e2007-03-19 11:25:20 +00001999 /* Set hdrOff to be the offset just after the end of the last journal
2000 ** page written before the first journal-header for this statement
2001 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00002002 ** header was written.
2003 */
2004 hdrOff = pPager->stmtHdrOff;
2005 assert( pPager->fullSync || !hdrOff );
2006 if( !hdrOff ){
2007 hdrOff = szJ;
2008 }
2009
drhfa86c412002-02-02 15:01:15 +00002010 /* Truncate the database back to its original size.
2011 */
danielk1977e180dd92007-04-05 17:15:52 +00002012 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00002013 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00002014
drhac69b052004-05-12 13:30:07 +00002015 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00002016 */
drhac69b052004-05-12 13:30:07 +00002017 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00002018 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00002019
drhac69b052004-05-12 13:30:07 +00002020 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00002021 ** database file. Note that the statement journal omits checksums from
2022 ** each record since power-failure recovery is not important to statement
2023 ** journals.
drhfa86c412002-02-02 15:01:15 +00002024 */
danielk197762079062007-08-15 17:08:46 +00002025 for(i=0; i<nRec; i++){
2026 i64 offset = i*(4+pPager->pageSize);
2027 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00002028 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00002029 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00002030 }
2031
danielk197776572402004-06-25 02:38:54 +00002032 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
2033 ** was the size of the journal file when this statement was started, so
2034 ** everything after that needs to be rolled back, either into the
2035 ** database, the memory cache, or both.
2036 **
2037 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
2038 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00002039 */
danielk197776572402004-06-25 02:38:54 +00002040 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00002041 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00002042 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00002043 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00002044 assert( rc!=SQLITE_DONE );
2045 if( rc!=SQLITE_OK ) goto end_stmt_playback;
2046 }
2047
2048 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00002049 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00002050 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00002051 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00002052 if( rc!=SQLITE_OK ){
2053 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00002054 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00002055 }
danielk1977f0113002006-01-24 12:09:17 +00002056 if( nJRec==0 ){
2057 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00002058 }
danielk1977f0113002006-01-24 12:09:17 +00002059 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00002060 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00002061 assert( rc!=SQLITE_DONE );
2062 if( rc!=SQLITE_OK ) goto end_stmt_playback;
2063 }
drhfa86c412002-02-02 15:01:15 +00002064 }
danielk197776572402004-06-25 02:38:54 +00002065
2066 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00002067
drh3aac2dd2004-04-26 14:10:20 +00002068end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00002069 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00002070 pPager->journalOff = szJ;
2071 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00002072 }
2073 return rc;
2074}
2075
2076/*
drhf57b14a2001-09-14 18:54:08 +00002077** Change the maximum number of in-memory pages that are allowed.
2078*/
danielk19773b8a05f2007-03-19 17:44:26 +00002079void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00002080 if( mxPage>10 ){
2081 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00002082 }else{
2083 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00002084 }
2085}
2086
2087/*
drh973b6e32003-02-12 14:09:42 +00002088** Adjust the robustness of the database to damage due to OS crashes
2089** or power failures by changing the number of syncs()s when writing
2090** the rollback journal. There are three levels:
2091**
drh054889e2005-11-30 03:20:31 +00002092** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00002093** for temporary and transient files.
2094**
2095** NORMAL The journal is synced once before writes begin on the
2096** database. This is normally adequate protection, but
2097** it is theoretically possible, though very unlikely,
2098** that an inopertune power failure could leave the journal
2099** in a state which would cause damage to the database
2100** when it is rolled back.
2101**
2102** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00002103** database (with some additional information - the nRec field
2104** of the journal header - being written in between the two
2105** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00002106** single disk sector is atomic, then this mode provides
2107** assurance that the journal will not be corrupted to the
2108** point of causing damage to the database during rollback.
2109**
2110** Numeric values associated with these states are OFF==1, NORMAL=2,
2111** and FULL=3.
2112*/
danielk197793758c82005-01-21 08:13:14 +00002113#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00002114void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00002115 pPager->noSync = level==1 || pPager->tempFile;
2116 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00002117 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00002118 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00002119}
danielk197793758c82005-01-21 08:13:14 +00002120#endif
drh973b6e32003-02-12 14:09:42 +00002121
2122/*
drhaf6df112005-06-07 02:12:30 +00002123** The following global variable is incremented whenever the library
2124** attempts to open a temporary file. This information is used for
2125** testing and analysis only.
2126*/
drh0f7eb612006-08-08 13:51:43 +00002127#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002128int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00002129#endif
drhaf6df112005-06-07 02:12:30 +00002130
2131/*
drh3f56e6e2007-03-15 01:16:47 +00002132** Open a temporary file.
2133**
2134** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00002135** other error code if we fail. The OS will automatically delete the temporary
2136** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00002137*/
danielk1977b4b47412007-08-17 15:53:36 +00002138static int sqlite3PagerOpentemp(
drh33f4e022007-09-03 15:19:34 +00002139 sqlite3_vfs *pVfs, /* The virtual file system layer */
2140 sqlite3_file *pFile, /* Write the file descriptor here */
2141 char *zFilename, /* Name of the file. Might be NULL */
2142 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00002143){
drhfa86c412002-02-02 15:01:15 +00002144 int rc;
drh334b2992007-09-06 23:28:23 +00002145 assert( zFilename!=0 );
drh3f56e6e2007-03-15 01:16:47 +00002146
drh0f7eb612006-08-08 13:51:43 +00002147#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002148 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00002149#endif
danielk1977b4b47412007-08-17 15:53:36 +00002150
drh33f4e022007-09-03 15:19:34 +00002151 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
2152 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
2153 rc = sqlite3OsOpen(pVfs, zFilename, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00002154 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00002155 return rc;
2156}
2157
2158/*
drhed7c8552001-04-11 14:29:21 +00002159** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00002160** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00002161** the first call to sqlite3PagerGet() and is only held open until the
2162** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00002163**
drh6446c4d2001-12-15 14:22:18 +00002164** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00002165** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00002166** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00002167**
2168** If zFilename is ":memory:" then all information is held in cache.
2169** It is never written to disk. This can be used to implement an
2170** in-memory database.
drhed7c8552001-04-11 14:29:21 +00002171*/
danielk19773b8a05f2007-03-19 17:44:26 +00002172int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00002173 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00002174 Pager **ppPager, /* Return the Pager structure here */
2175 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00002176 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00002177 int flags, /* flags controlling this file */
2178 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00002179){
danielk1977b4b47412007-08-17 15:53:36 +00002180 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00002181 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00002182 int rc = SQLITE_OK;
2183 int i;
danielk19778def5ea2004-06-16 10:39:52 +00002184 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00002185 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00002186 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00002187 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
2188 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00002189 int journalFileSize = sqlite3JournalSize(pVfs);
drh1cc8c442007-08-24 16:08:29 +00002190 int nDefaultPage = SQLITE_DEFAULT_PAGE_SIZE;
2191 char *zPathname;
2192 int nPathname;
drh99b90c32008-03-17 13:50:58 +00002193 char *zStmtJrnl;
2194 int nStmtJrnl;
danielk1977b4b47412007-08-17 15:53:36 +00002195
drh86f8c192007-08-22 00:39:19 +00002196 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00002197 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002198
drh1cc8c442007-08-24 16:08:29 +00002199 /* Compute the full pathname */
danielk1977adfb9b02007-09-17 07:02:56 +00002200 nPathname = pVfs->mxPathname+1;
drh99b90c32008-03-17 13:50:58 +00002201 zPathname = sqlite3_malloc(nPathname*2);
drh1cc8c442007-08-24 16:08:29 +00002202 if( zPathname==0 ){
2203 return SQLITE_NOMEM;
2204 }
2205 if( zFilename && zFilename[0] ){
2206#ifndef SQLITE_OMIT_MEMORYDB
2207 if( strcmp(zFilename,":memory:")==0 ){
2208 memDb = 1;
2209 zPathname[0] = 0;
2210 }else
2211#endif
2212 {
danielk1977adfb9b02007-09-17 07:02:56 +00002213 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00002214 }
2215 }else{
danielk1977adfb9b02007-09-17 07:02:56 +00002216 rc = sqlite3OsGetTempname(pVfs, nPathname, zPathname);
drhae28c012007-08-24 16:29:23 +00002217 }
2218 if( rc!=SQLITE_OK ){
2219 sqlite3_free(zPathname);
2220 return rc;
drh1cc8c442007-08-24 16:08:29 +00002221 }
2222 nPathname = strlen(zPathname);
2223
drh99b90c32008-03-17 13:50:58 +00002224 /* Put the statement journal in temporary disk space since this is
2225 ** sometimes RAM disk or other optimized storage. Unlikely the main
2226 ** main journal file, the statement journal does not need to be
2227 ** colocated with the database nor does it need to be persistent.
2228 */
2229 zStmtJrnl = &zPathname[nPathname+1];
2230 rc = sqlite3OsGetTempname(pVfs, pVfs->mxPathname+1, zStmtJrnl);
2231 if( rc!=SQLITE_OK ){
2232 sqlite3_free(zPathname);
2233 return rc;
2234 }
2235 nStmtJrnl = strlen(zStmtJrnl);
2236
danielk1977b4b47412007-08-17 15:53:36 +00002237 /* Allocate memory for the pager structure */
2238 pPager = sqlite3MallocZero(
2239 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00002240 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00002241 pVfs->szOsFile * 3 + /* The main db and two journal files */
drh99b90c32008-03-17 13:50:58 +00002242 3*nPathname + 40 + /* zFilename, zDirectory, zJournal */
2243 nStmtJrnl /* zStmtJrnl */
danielk1977b4b47412007-08-17 15:53:36 +00002244 );
2245 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00002246 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002247 return SQLITE_NOMEM;
2248 }
2249 pPtr = (u8 *)&pPager[1];
drh33f4e022007-09-03 15:19:34 +00002250 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00002251 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00002252 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
2253 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
2254 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00002255 pPager->zDirectory = &pPager->zFilename[nPathname+1];
2256 pPager->zJournal = &pPager->zDirectory[nPathname+1];
drh334b2992007-09-06 23:28:23 +00002257 pPager->zStmtJrnl = &pPager->zJournal[nPathname+10];
danielk1977b4b47412007-08-17 15:53:36 +00002258 pPager->pVfs = pVfs;
drh1cc8c442007-08-24 16:08:29 +00002259 memcpy(pPager->zFilename, zPathname, nPathname+1);
drh99b90c32008-03-17 13:50:58 +00002260 memcpy(pPager->zStmtJrnl, zStmtJrnl, nStmtJrnl+1);
drh1cc8c442007-08-24 16:08:29 +00002261 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002262
drh153c62c2007-08-24 03:51:33 +00002263 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00002264 */
drhae28c012007-08-24 16:29:23 +00002265 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00002266 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
2267 rc = SQLITE_CANTOPEN;
2268 }else{
drh1cc8c442007-08-24 16:08:29 +00002269 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00002270 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
2271 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00002272 readOnly = (fout&SQLITE_OPEN_READONLY);
2273
2274 /* If the file was successfully opened for read/write access,
2275 ** choose a default page size in case we have to create the
2276 ** database file. The default page size is the maximum of:
2277 **
2278 ** + SQLITE_DEFAULT_PAGE_SIZE,
2279 ** + The value returned by sqlite3OsSectorSize()
2280 ** + The largest page size that can be written atomically.
2281 */
2282 if( rc==SQLITE_OK && !readOnly ){
2283 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
2284 if( nDefaultPage<iSectorSize ){
2285 nDefaultPage = iSectorSize;
2286 }
danielk19779663b8f2007-08-24 11:52:28 +00002287#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00002288 {
2289 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
2290 int ii;
2291 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
2292 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
2293 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
2294 for(ii=nDefaultPage; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
2295 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) nDefaultPage = ii;
danielk19779663b8f2007-08-24 11:52:28 +00002296 }
danielk1977b4b47412007-08-17 15:53:36 +00002297 }
drh1cc8c442007-08-24 16:08:29 +00002298#endif
2299 if( nDefaultPage>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
2300 nDefaultPage = SQLITE_MAX_DEFAULT_PAGE_SIZE;
2301 }
danielk19778def5ea2004-06-16 10:39:52 +00002302 }
drhac69b052004-05-12 13:30:07 +00002303 }
drh1cc8c442007-08-24 16:08:29 +00002304 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002305 /* If a temporary file is requested, it is not opened immediately.
2306 ** In this case we accept the default page size and delay actually
2307 ** opening the file until the first call to OsWrite().
2308 */
danielk19777a2b1ee2007-08-21 14:27:01 +00002309 tempFile = 1;
2310 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00002311 }
danielk1977aef0bf62005-12-30 16:28:01 +00002312
danielk1977b4b47412007-08-17 15:53:36 +00002313 if( pPager && rc==SQLITE_OK ){
drhbf8a4342008-04-29 15:38:58 +00002314 pPager->pTmpSpace = sqlite3MallocZero(nDefaultPage);
drh3e7a6092002-12-07 21:45:14 +00002315 }
danielk1977aef0bf62005-12-30 16:28:01 +00002316
drh153c62c2007-08-24 03:51:33 +00002317 /* If an error occured in either of the blocks above.
2318 ** Free the Pager structure and close the file.
2319 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00002320 ** any Pager.errMask variables.
2321 */
danielk1977b4b47412007-08-17 15:53:36 +00002322 if( !pPager || !pPager->pTmpSpace ){
2323 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00002324 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00002325 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00002326 }
danielk1977aef0bf62005-12-30 16:28:01 +00002327
drh153c62c2007-08-24 03:51:33 +00002328 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
2329 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00002330
danielk1977b4b47412007-08-17 15:53:36 +00002331 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00002332 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00002333 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00002334 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002335
drh99b90c32008-03-17 13:50:58 +00002336 /* Fill in Pager.zJournal[] */
drh1cc8c442007-08-24 16:08:29 +00002337 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
2338 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
danielk1977b4b47412007-08-17 15:53:36 +00002339
drh3b59a5c2006-01-15 20:28:28 +00002340 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00002341 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00002342 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002343 /* pPager->stmtOpen = 0; */
2344 /* pPager->stmtInUse = 0; */
2345 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00002346 pPager->dbSize = memDb-1;
danielk19779663b8f2007-08-24 11:52:28 +00002347 pPager->pageSize = nDefaultPage;
drh3b59a5c2006-01-15 20:28:28 +00002348 /* pPager->stmtSize = 0; */
2349 /* pPager->stmtJSize = 0; */
2350 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002351 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002352 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002353 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002354 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002355 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00002356 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00002357 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2358 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2359 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
2360 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00002361 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00002362 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002363 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00002364 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00002365 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00002366 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002367 /* pPager->pFirst = 0; */
2368 /* pPager->pFirstSynced = 0; */
2369 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00002370 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk1977b53e4962008-06-04 06:45:59 +00002371 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk19777a2b1ee2007-08-21 14:27:01 +00002372 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00002373 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00002374 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00002375 }
drh3b59a5c2006-01-15 20:28:28 +00002376 /* pPager->pBusyHandler = 0; */
2377 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002378 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00002379#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002380 pPager->iInUseMM = 0;
2381 pPager->iInUseDB = 0;
2382 if( !memDb ){
drh26e4a8b2008-05-01 17:16:52 +00002383#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +00002384 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00002385#endif
drh86f8c192007-08-22 00:39:19 +00002386 sqlite3_mutex_enter(mutex);
2387 pPager->pNext = sqlite3PagerList;
2388 if( sqlite3PagerList ){
2389 assert( sqlite3PagerList->pPrev==0 );
2390 sqlite3PagerList->pPrev = pPager;
2391 }
2392 pPager->pPrev = 0;
2393 sqlite3PagerList = pPager;
2394 sqlite3_mutex_leave(mutex);
2395 }
danielk197752622822006-01-09 09:59:49 +00002396#endif
drhed7c8552001-04-11 14:29:21 +00002397 return SQLITE_OK;
2398}
2399
2400/*
drh90f5ecb2004-07-22 01:19:35 +00002401** Set the busy handler function.
2402*/
danielk19773b8a05f2007-03-19 17:44:26 +00002403void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002404 pPager->pBusyHandler = pBusyHandler;
2405}
2406
2407/*
drh72f82862001-05-24 21:06:34 +00002408** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002409** when the reference count on each page reaches zero. The destructor can
2410** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002411**
danielk19773b8a05f2007-03-19 17:44:26 +00002412** The destructor is not called as a result sqlite3PagerClose().
2413** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002414*/
danielk19773b8a05f2007-03-19 17:44:26 +00002415void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002416 pPager->xDestructor = xDesc;
2417}
2418
2419/*
drha6abd042004-06-09 17:37:22 +00002420** Set the reinitializer for this pager. If not NULL, the reinitializer
2421** is called when the content of a page in cache is restored to its original
2422** value as a result of a rollback. The callback gives higher-level code
2423** an opportunity to restore the EXTRA section to agree with the restored
2424** page data.
2425*/
danielk19773b8a05f2007-03-19 17:44:26 +00002426void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002427 pPager->xReiniter = xReinit;
2428}
2429
2430/*
danielk1977a1644fd2007-08-29 12:31:25 +00002431** Set the page size to *pPageSize. If the suggest new page size is
2432** inappropriate, then an alternative page size is set to that
2433** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002434*/
danielk1977a1644fd2007-08-29 12:31:25 +00002435int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
2436 int rc = SQLITE_OK;
2437 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00002438 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00002439 if( pageSize && pageSize!=pPager->pageSize
2440 && !pPager->memDb && pPager->nRef==0
2441 ){
2442 char *pNew = (char *)sqlite3_malloc(pageSize);
2443 if( !pNew ){
2444 rc = SQLITE_NOMEM;
2445 }else{
2446 pagerEnter(pPager);
2447 pager_reset(pPager);
2448 pPager->pageSize = pageSize;
2449 setSectorSize(pPager);
2450 sqlite3_free(pPager->pTmpSpace);
2451 pPager->pTmpSpace = pNew;
2452 pagerLeave(pPager);
2453 }
drh1c7880e2005-05-20 20:01:55 +00002454 }
danielk1977a1644fd2007-08-29 12:31:25 +00002455 *pPageSize = pPager->pageSize;
2456 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002457}
2458
2459/*
drh26b79942007-11-28 16:19:56 +00002460** Return a pointer to the "temporary page" buffer held internally
2461** by the pager. This is a buffer that is big enough to hold the
2462** entire content of a database page. This buffer is used internally
2463** during rollback and will be overwritten whenever a rollback
2464** occurs. But other modules are free to use it too, as long as
2465** no rollbacks are happening.
2466*/
2467void *sqlite3PagerTempSpace(Pager *pPager){
2468 return pPager->pTmpSpace;
2469}
2470
2471/*
drhf8e632b2007-05-08 14:51:36 +00002472** Attempt to set the maximum database page count if mxPage is positive.
2473** Make no changes if mxPage is zero or negative. And never reduce the
2474** maximum page count below the current size of the database.
2475**
2476** Regardless of mxPage, return the current maximum page count.
2477*/
2478int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2479 if( mxPage>0 ){
2480 pPager->mxPgno = mxPage;
2481 }
2482 sqlite3PagerPagecount(pPager);
2483 return pPager->mxPgno;
2484}
2485
2486/*
drhc9ac5ca2005-11-04 22:03:30 +00002487** The following set of routines are used to disable the simulated
2488** I/O error mechanism. These routines are used to avoid simulated
2489** errors in places where we do not care about errors.
2490**
2491** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2492** and generate no code.
2493*/
2494#ifdef SQLITE_TEST
2495extern int sqlite3_io_error_pending;
2496extern int sqlite3_io_error_hit;
2497static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002498void disable_simulated_io_errors(void){
2499 saved_cnt = sqlite3_io_error_pending;
2500 sqlite3_io_error_pending = -1;
2501}
2502void enable_simulated_io_errors(void){
2503 sqlite3_io_error_pending = saved_cnt;
2504}
2505#else
drh152410f2005-11-05 15:11:22 +00002506# define disable_simulated_io_errors()
2507# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002508#endif
2509
2510/*
drh90f5ecb2004-07-22 01:19:35 +00002511** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002512** that pDest points to.
2513**
2514** No error checking is done. The rational for this is that this function
2515** may be called even if the file does not exist or contain a header. In
2516** these cases sqlite3OsRead() will return an error, to which the correct
2517** response is to zero the memory at pDest and continue. A real IO error
2518** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002519*/
danielk19773b8a05f2007-03-19 17:44:26 +00002520int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002521 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002522 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002523 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2524 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002525 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002526 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002527 if( rc==SQLITE_IOERR_SHORT_READ ){
2528 rc = SQLITE_OK;
2529 }
drh90f5ecb2004-07-22 01:19:35 +00002530 }
drh551b7732006-11-06 21:20:25 +00002531 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002532}
2533
2534/*
drh5e00f6c2001-09-13 13:46:56 +00002535** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002536** pPager.
2537**
2538** If the PENDING_BYTE lies on the page directly after the end of the
2539** file, then consider this page part of the file too. For example, if
2540** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2541** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002542*/
danielk19773b8a05f2007-03-19 17:44:26 +00002543int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002544 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002545 int rc;
drhd9b02572001-04-15 00:37:09 +00002546 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002547 if( pPager->errCode ){
danielk197743468d92008-02-26 06:05:31 +00002548 return -1;
drha7aea3d2007-03-15 12:51:16 +00002549 }
drhed7c8552001-04-11 14:29:21 +00002550 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002551 n = pPager->dbSize;
2552 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002553 assert(pPager->fd->pMethods||pPager->tempFile);
2554 if( (pPager->fd->pMethods)
2555 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002556 pPager->nRef++;
drhe49f9822006-09-15 12:29:16 +00002557 pager_error(pPager, rc);
danielk1977ae72d982007-10-03 08:46:44 +00002558 pPager->nRef--;
danielk197743468d92008-02-26 06:05:31 +00002559 return -1;
danielk197715f411d2005-09-16 10:18:45 +00002560 }
2561 if( n>0 && n<pPager->pageSize ){
2562 n = 1;
2563 }else{
2564 n /= pPager->pageSize;
2565 }
2566 if( pPager->state!=PAGER_UNLOCK ){
2567 pPager->dbSize = n;
2568 }
drhed7c8552001-04-11 14:29:21 +00002569 }
danielk197715f411d2005-09-16 10:18:45 +00002570 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002571 n++;
2572 }
drhf8e632b2007-05-08 14:51:36 +00002573 if( n>pPager->mxPgno ){
2574 pPager->mxPgno = n;
2575 }
drhed7c8552001-04-11 14:29:21 +00002576 return n;
2577}
2578
drhf07e7d52006-04-07 13:54:46 +00002579
2580#ifndef SQLITE_OMIT_MEMORYDB
2581/*
2582** Clear a PgHistory block
2583*/
2584static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002585 sqlite3_free(pHist->pOrig);
2586 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002587 pHist->pOrig = 0;
2588 pHist->pStmt = 0;
2589}
2590#else
2591#define clearHistory(x)
2592#endif
2593
drhed7c8552001-04-11 14:29:21 +00002594/*
drhf7c57532003-04-25 13:22:51 +00002595** Forward declaration
2596*/
danielk197776572402004-06-25 02:38:54 +00002597static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002598
2599/*
drh85b623f2007-12-13 21:54:09 +00002600** Unlink pPg from its hash chain. Also set the page number to 0 to indicate
danielk1977f5fdda82004-11-03 08:44:05 +00002601** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002602** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002603** pNextFree/pPrevFree list that is not a part of any hash-chain.
2604*/
2605static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2606 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002607 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002608 return;
2609 }
2610 if( pPg->pNextHash ){
2611 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2612 }
2613 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002614 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002615 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2616 }else{
drh8ca0c722006-05-07 17:49:38 +00002617 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002618 pPager->aHash[h] = pPg->pNextHash;
2619 }
drh5229ae42006-03-23 23:29:04 +00002620 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002621 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2622 }
danielk1977f5fdda82004-11-03 08:44:05 +00002623 pPg->pgno = 0;
2624 pPg->pNextHash = pPg->pPrevHash = 0;
2625}
2626
2627/*
drhac69b052004-05-12 13:30:07 +00002628** Unlink a page from the free list (the list of all pages where nRef==0)
2629** and from its hash collision chain.
2630*/
2631static void unlinkPage(PgHdr *pPg){
2632 Pager *pPager = pPg->pPager;
2633
danielk19779f61c2f2007-08-27 17:27:49 +00002634 /* Unlink from free page list */
2635 lruListRemove(pPg);
drhac69b052004-05-12 13:30:07 +00002636
2637 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002638 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002639}
2640
2641/*
danielk1977e180dd92007-04-05 17:15:52 +00002642** This routine is used to truncate the cache when a database
2643** is truncated. Drop from the cache all pages whose pgno is
2644** larger than pPager->dbSize and is unreferenced.
2645**
drhac69b052004-05-12 13:30:07 +00002646** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002647**
2648** Actually, at the point this routine is called, it would be
2649** an error to have a referenced page. But rather than delete
2650** that page and guarantee a subsequent segfault, it seems better
2651** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002652*/
danielk1977e180dd92007-04-05 17:15:52 +00002653static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002654 PgHdr *pPg;
2655 PgHdr **ppPg;
2656 int dbSize = pPager->dbSize;
2657
2658 ppPg = &pPager->pAll;
2659 while( (pPg = *ppPg)!=0 ){
2660 if( pPg->pgno<=dbSize ){
2661 ppPg = &pPg->pNextAll;
2662 }else if( pPg->nRef>0 ){
2663 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2664 ppPg = &pPg->pNextAll;
2665 }else{
2666 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002667 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2668 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002669 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002670 makeClean(pPg);
drh0d180202008-02-14 23:26:56 +00002671 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00002672 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002673 pPager->nPage--;
2674 }
2675 }
2676}
2677
drhf7c57532003-04-25 13:22:51 +00002678/*
danielk197717221812005-02-15 03:38:05 +00002679** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002680** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002681** false or until the lock succeeds.
2682**
2683** Return SQLITE_OK on success and an error code if we cannot obtain
2684** the lock.
2685*/
2686static int pager_wait_on_lock(Pager *pPager, int locktype){
2687 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002688
2689 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002690 assert( PAGER_SHARED==SHARED_LOCK );
2691 assert( PAGER_RESERVED==RESERVED_LOCK );
2692 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002693
2694 /* If the file is currently unlocked then the size must be unknown */
2695 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2696
danielk197717221812005-02-15 03:38:05 +00002697 if( pPager->state>=locktype ){
2698 rc = SQLITE_OK;
2699 }else{
drhbefdf832008-03-14 19:33:05 +00002700 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002701 do {
drh054889e2005-11-30 03:20:31 +00002702 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002703 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002704 if( rc==SQLITE_OK ){
2705 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002706 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002707 }
2708 }
2709 return rc;
2710}
2711
2712/*
drhf7c57532003-04-25 13:22:51 +00002713** Truncate the file to the number of pages specified.
2714*/
danielk19773b8a05f2007-03-19 17:44:26 +00002715int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002716 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002717 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002718 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002719 if( pPager->errCode ){
2720 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002721 return rc;
2722 }
drh7d02cb72003-06-04 16:24:39 +00002723 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002724 return SQLITE_OK;
2725 }
drhb7f91642004-10-31 02:22:47 +00002726 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002727 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002728 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002729 return SQLITE_OK;
2730 }
drh86f8c192007-08-22 00:39:19 +00002731 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002732 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002733 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002734 if( rc!=SQLITE_OK ){
2735 return rc;
2736 }
danielk197717221812005-02-15 03:38:05 +00002737
2738 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002739 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002740 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002741 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002742 if( rc!=SQLITE_OK ){
2743 return rc;
2744 }
2745
drhcb4c40b2004-08-18 19:09:43 +00002746 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002747 return rc;
2748}
2749
2750/*
drhed7c8552001-04-11 14:29:21 +00002751** Shutdown the page cache. Free all memory and close all files.
2752**
2753** If a transaction was in progress when this routine is called, that
2754** transaction is rolled back. All outstanding pages are invalidated
2755** and their memory is freed. Any attempt to use a page associated
2756** with this page cache after this function returns will likely
2757** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002758**
2759** This function always succeeds. If a transaction is active an attempt
2760** is made to roll it back. If an error occurs during the rollback
2761** a hot journal may be left in the filesystem but no error is returned
2762** to the caller.
drhed7c8552001-04-11 14:29:21 +00002763*/
danielk19773b8a05f2007-03-19 17:44:26 +00002764int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002765#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002766 if( !MEMDB ){
drh26e4a8b2008-05-01 17:16:52 +00002767#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +00002768 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00002769#endif
drh86f8c192007-08-22 00:39:19 +00002770 sqlite3_mutex_enter(mutex);
2771 if( pPager->pPrev ){
2772 pPager->pPrev->pNext = pPager->pNext;
2773 }else{
2774 sqlite3PagerList = pPager->pNext;
2775 }
2776 if( pPager->pNext ){
2777 pPager->pNext->pPrev = pPager->pPrev;
2778 }
2779 sqlite3_mutex_leave(mutex);
2780 }
danielk197713f72992005-12-18 08:51:22 +00002781#endif
2782
drhbafda092007-01-03 23:36:22 +00002783 disable_simulated_io_errors();
drh4873d5f2008-05-13 13:27:33 +00002784 sqlite3FaultBeginBenign(-1);
drhc2ee76c2007-01-04 14:58:14 +00002785 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002786 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002787 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002788 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002789 enable_simulated_io_errors();
drh4873d5f2008-05-13 13:27:33 +00002790 sqlite3FaultEndBenign(-1);
drh4f0c5872007-03-26 22:05:01 +00002791 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002792 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002793 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002794 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002795 }
drhf5e7bb52008-02-18 14:47:33 +00002796 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002797 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002798 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002799 }
danielk1977b4b47412007-08-17 15:53:36 +00002800 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002801 /* Temp files are automatically deleted by the OS
2802 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002803 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002804 ** }
2805 */
danielk1977aca790a2005-01-13 11:07:52 +00002806
drh17435752007-08-16 04:30:38 +00002807 sqlite3_free(pPager->aHash);
2808 sqlite3_free(pPager->pTmpSpace);
2809 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002810 return SQLITE_OK;
2811}
2812
drh87cc3b32007-05-08 21:45:27 +00002813#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002814/*
drh5e00f6c2001-09-13 13:46:56 +00002815** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002816*/
danielk19773b8a05f2007-03-19 17:44:26 +00002817Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002818 return p->pgno;
2819}
drh87cc3b32007-05-08 21:45:27 +00002820#endif
drhed7c8552001-04-11 14:29:21 +00002821
2822/*
drhc8629a12004-05-08 20:07:40 +00002823** The page_ref() function increments the reference count for a page.
2824** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002825** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002826**
2827** For non-test systems, page_ref() is a macro that calls _page_ref()
2828** online of the reference count is zero. For test systems, page_ref()
2829** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002830*/
drh836faa42003-01-11 13:30:57 +00002831static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002832 if( pPg->nRef==0 ){
2833 /* The page is currently on the freelist. Remove it. */
danielk19779f61c2f2007-08-27 17:27:49 +00002834 lruListRemove(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002835 pPg->pPager->nRef++;
2836 }
2837 pPg->nRef++;
drhdf0b3b02001-06-23 11:36:20 +00002838}
danielk1977aca790a2005-01-13 11:07:52 +00002839#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002840 static void page_ref(PgHdr *pPg){
2841 if( pPg->nRef==0 ){
2842 _page_ref(pPg);
2843 }else{
2844 pPg->nRef++;
drhc8629a12004-05-08 20:07:40 +00002845 }
2846 }
2847#else
2848# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2849#endif
drhdf0b3b02001-06-23 11:36:20 +00002850
2851/*
2852** Increment the reference count for a page. The input pointer is
2853** a reference to the page data.
2854*/
danielk19773b8a05f2007-03-19 17:44:26 +00002855int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002856 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002857 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002858 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002859 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002860}
2861
2862/*
drh34e79ce2004-02-08 06:05:46 +00002863** Sync the journal. In other words, make sure all the pages that have
2864** been written to the journal have actually reached the surface of the
2865** disk. It is not safe to modify the original database file until after
2866** the journal has been synced. If the original database is modified before
2867** the journal is synced and a power failure occurs, the unsynced journal
2868** data would be lost and we would be unable to completely rollback the
2869** database changes. Database corruption would occur.
2870**
2871** This routine also updates the nRec field in the header of the journal.
2872** (See comments on the pager_playback() routine for additional information.)
2873** If the sync mode is FULL, two syncs will occur. First the whole journal
2874** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002875**
drh34e79ce2004-02-08 06:05:46 +00002876** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002877** after a power failure, so no sync occurs.
2878**
2879** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2880** the database is stored, then OsSync() is never called on the journal
2881** file. In this case all that is required is to update the nRec field in
2882** the journal header.
drhfa86c412002-02-02 15:01:15 +00002883**
drh34e79ce2004-02-08 06:05:46 +00002884** This routine clears the needSync field of every page current held in
2885** memory.
drh50e5dad2001-09-15 00:57:28 +00002886*/
danielk197776572402004-06-25 02:38:54 +00002887static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002888 PgHdr *pPg;
2889 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002890
2891 /* Sync the journal before modifying the main database
2892 ** (assuming there is a journal and it needs to be synced.)
2893 */
danielk197776572402004-06-25 02:38:54 +00002894 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002895 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002896 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002897 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002898
danielk19774cd2cd52007-08-23 14:48:23 +00002899 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002900 /* Write the nRec value into the journal file header. If in
2901 ** full-synchronous mode, sync the journal first. This ensures that
2902 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002903 ** it as a candidate for rollback.
2904 **
2905 ** This is not required if the persistent media supports the
2906 ** SAFE_APPEND property. Because in this case it is not possible
2907 ** for garbage data to be appended to the file, the nRec field
2908 ** is populated with 0xFFFFFFFF when the journal header is written
2909 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002910 */
danielk19774cd2cd52007-08-23 14:48:23 +00002911 i64 jrnlOff;
2912 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002913 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002914 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002915 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002916 if( rc!=0 ) return rc;
2917 }
danielk197713adf8a2004-06-03 16:08:41 +00002918
danielk197762079062007-08-15 17:08:46 +00002919 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2920 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2921 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002922 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002923 }
danielk19774cd2cd52007-08-23 14:48:23 +00002924 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2925 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2926 IOTRACE(("JSYNC %p\n", pPager))
2927 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2928 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2929 );
2930 if( rc!=0 ) return rc;
2931 }
drhdb48ee02003-01-16 13:42:43 +00002932 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002933 }
drh50e5dad2001-09-15 00:57:28 +00002934 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002935
2936 /* Erase the needSync flag from every page.
2937 */
2938 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2939 pPg->needSync = 0;
2940 }
danielk19779f61c2f2007-08-27 17:27:49 +00002941 lruListSetFirstSynced(pPager);
drh50e5dad2001-09-15 00:57:28 +00002942 }
drh03eb96a2002-11-10 23:32:56 +00002943
drh341eae82003-01-21 02:39:36 +00002944#ifndef NDEBUG
2945 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2946 ** flag must also be clear for all pages. Verify that this
2947 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002948 */
drh341eae82003-01-21 02:39:36 +00002949 else{
2950 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2951 assert( pPg->needSync==0 );
2952 }
danielk19779f61c2f2007-08-27 17:27:49 +00002953 assert( pPager->lru.pFirstSynced==pPager->lru.pFirst );
drh03eb96a2002-11-10 23:32:56 +00002954 }
drh341eae82003-01-21 02:39:36 +00002955#endif
drhdb48ee02003-01-16 13:42:43 +00002956
drh81a20f22001-10-12 17:30:04 +00002957 return rc;
drh50e5dad2001-09-15 00:57:28 +00002958}
2959
2960/*
drhdc3e10b2006-06-15 14:31:06 +00002961** Merge two lists of pages connected by pDirty and in pgno order.
2962** Do not both fixing the pPrevDirty pointers.
2963*/
2964static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2965 PgHdr result, *pTail;
2966 pTail = &result;
2967 while( pA && pB ){
2968 if( pA->pgno<pB->pgno ){
2969 pTail->pDirty = pA;
2970 pTail = pA;
2971 pA = pA->pDirty;
2972 }else{
2973 pTail->pDirty = pB;
2974 pTail = pB;
2975 pB = pB->pDirty;
2976 }
2977 }
2978 if( pA ){
2979 pTail->pDirty = pA;
2980 }else if( pB ){
2981 pTail->pDirty = pB;
2982 }else{
2983 pTail->pDirty = 0;
2984 }
2985 return result.pDirty;
2986}
2987
2988/*
2989** Sort the list of pages in accending order by pgno. Pages are
2990** connected by pDirty pointers. The pPrevDirty pointers are
2991** corrupted by this sort.
2992*/
danielk197724168722007-04-02 05:07:47 +00002993#define N_SORT_BUCKET_ALLOC 25
2994#define N_SORT_BUCKET 25
2995#ifdef SQLITE_TEST
2996 int sqlite3_pager_n_sort_bucket = 0;
2997 #undef N_SORT_BUCKET
2998 #define N_SORT_BUCKET \
2999 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
3000#endif
drhdc3e10b2006-06-15 14:31:06 +00003001static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00003002 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00003003 int i;
3004 memset(a, 0, sizeof(a));
3005 while( pIn ){
3006 p = pIn;
3007 pIn = p->pDirty;
3008 p->pDirty = 0;
3009 for(i=0; i<N_SORT_BUCKET-1; i++){
3010 if( a[i]==0 ){
3011 a[i] = p;
3012 break;
3013 }else{
3014 p = merge_pagelist(a[i], p);
3015 a[i] = 0;
3016 }
3017 }
3018 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00003019 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
3020 ** elements in the input list. This is possible, but impractical.
3021 ** Testing this line is the point of global variable
3022 ** sqlite3_pager_n_sort_bucket.
3023 */
drhdc3e10b2006-06-15 14:31:06 +00003024 a[i] = merge_pagelist(a[i], p);
3025 }
3026 }
3027 p = a[0];
3028 for(i=1; i<N_SORT_BUCKET; i++){
3029 p = merge_pagelist(p, a[i]);
3030 }
3031 return p;
3032}
3033
3034/*
drh2554f8b2003-01-22 01:26:44 +00003035** Given a list of pages (connected by the PgHdr.pDirty pointer) write
3036** every one of those pages out to the database file and mark them all
3037** as clean.
3038*/
3039static int pager_write_pagelist(PgHdr *pList){
3040 Pager *pPager;
drh153c62c2007-08-24 03:51:33 +00003041 PgHdr *p;
drh2554f8b2003-01-22 01:26:44 +00003042 int rc;
3043
3044 if( pList==0 ) return SQLITE_OK;
3045 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00003046
3047 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
3048 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00003049 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00003050 **
drha6abd042004-06-09 17:37:22 +00003051 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
3052 ** through an intermediate state PENDING. A PENDING lock prevents new
3053 ** readers from attaching to the database but is unsufficient for us to
3054 ** write. The idea of a PENDING lock is to prevent new readers from
3055 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00003056 **
drha6abd042004-06-09 17:37:22 +00003057 ** While the pager is in the RESERVED state, the original database file
3058 ** is unchanged and we can rollback without having to playback the
3059 ** journal into the original database file. Once we transition to
3060 ** EXCLUSIVE, it means the database file has been changed and any rollback
3061 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00003062 */
drh684917c2004-10-05 02:41:42 +00003063 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00003064 if( rc!=SQLITE_OK ){
3065 return rc;
3066 }
3067
drhdc3e10b2006-06-15 14:31:06 +00003068 pList = sort_pagelist(pList);
drh153c62c2007-08-24 03:51:33 +00003069 for(p=pList; p; p=p->pDirty){
3070 assert( p->dirty );
3071 p->dirty = 0;
3072 }
drh2554f8b2003-01-22 01:26:44 +00003073 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00003074
3075 /* If the file has not yet been opened, open it now. */
3076 if( !pPager->fd->pMethods ){
3077 assert(pPager->tempFile);
drh33f4e022007-09-03 15:19:34 +00003078 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename,
3079 pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00003080 if( rc ) return rc;
3081 }
3082
danielk1977687566d2004-11-02 12:56:41 +00003083 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00003084 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00003085 ** make the file smaller (presumably by auto-vacuum code). Do not write
3086 ** any such pages to the file.
3087 */
3088 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00003089 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00003090 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00003091 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
3092 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00003093 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00003094 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003095 PAGER_INCR(sqlite3_pager_writedb_count);
3096 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00003097 if( pList->pgno==1 ){
3098 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
3099 }
danielk1977687566d2004-11-02 12:56:41 +00003100 }
3101#ifndef NDEBUG
3102 else{
drh4f0c5872007-03-26 22:05:01 +00003103 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00003104 }
3105#endif
drh2554f8b2003-01-22 01:26:44 +00003106 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00003107#ifdef SQLITE_CHECK_PAGES
3108 pList->pageHash = pager_pagehash(pList);
3109#endif
drh2554f8b2003-01-22 01:26:44 +00003110 pList = pList->pDirty;
3111 }
3112 return SQLITE_OK;
3113}
3114
3115/*
3116** Collect every dirty page into a dirty list and
3117** return a pointer to the head of that list. All pages are
3118** collected even if they are still in use.
3119*/
3120static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh8f2e9a12008-02-26 14:46:04 +00003121
3122#ifndef NDEBUG
3123 /* Verify the sanity of the dirty list when we are running
3124 ** in debugging mode. This is expensive, so do not
3125 ** do this on a normal build. */
3126 int n1 = 0;
3127 int n2 = 0;
3128 PgHdr *p;
3129 for(p=pPager->pAll; p; p=p->pNextAll){ if( p->dirty ) n1++; }
3130 for(p=pPager->pDirty; p; p=p->pDirty){ n2++; }
3131 assert( n1==n2 );
3132#endif
3133
drh605ad8f2006-05-03 23:34:05 +00003134 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00003135}
3136
3137/*
drh19db9352008-03-27 22:42:51 +00003138** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00003139** A hot journal is one that needs to be played back.
3140**
3141** If the current size of the database file is 0 but a journal file
3142** exists, that is probably an old journal left over from a prior
3143** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00003144**
3145** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00003146**
3147** This routine does not open the journal file to examine its
3148** content. Hence, the journal might contain the name of a master
3149** journal file that has been deleted, and hence not be hot. Or
3150** the header of the journal might be zeroed out. This routine
3151** does not discover these cases of a non-hot journal - if the
3152** journal file exists and is not empty this routine assumes it
3153** is hot. The pager_playback() routine will discover that the
3154** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00003155*/
3156static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003157 sqlite3_vfs *pVfs = pPager->pVfs;
drh19db9352008-03-27 22:42:51 +00003158 int rc;
drh165ffe92005-03-15 17:09:30 +00003159 if( !pPager->useJournal ) return 0;
drhd3cf2472007-11-27 16:55:07 +00003160 if( !pPager->fd->pMethods ) return 0;
drh19db9352008-03-27 22:42:51 +00003161 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS);
3162 if( rc<=0 ){
3163 return rc;
drhbb5f18d2007-04-06 18:23:17 +00003164 }
3165 if( sqlite3OsCheckReservedLock(pPager->fd) ){
3166 return 0;
3167 }
danielk19773b8a05f2007-03-19 17:44:26 +00003168 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00003169 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00003170 return 0;
3171 }else{
3172 return 1;
3173 }
3174}
3175
danielk19775591df52005-12-20 09:19:37 +00003176/*
danielk1977aef0bf62005-12-30 16:28:01 +00003177** Try to find a page in the cache that can be recycled.
3178**
3179** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00003180** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00003181*/
danielk1977843e65f2007-09-01 16:16:15 +00003182static int pager_recycle(Pager *pPager, PgHdr **ppPg){
danielk197713f72992005-12-18 08:51:22 +00003183 PgHdr *pPg;
3184 *ppPg = 0;
3185
danielk1977843e65f2007-09-01 16:16:15 +00003186 /* It is illegal to call this function unless the pager object
3187 ** pointed to by pPager has at least one free page (page with nRef==0).
3188 */
danielk1977c551edc2007-04-05 13:12:13 +00003189 assert(!MEMDB);
danielk1977843e65f2007-09-01 16:16:15 +00003190 assert(pPager->lru.pFirst);
danielk1977c551edc2007-04-05 13:12:13 +00003191
danielk197713f72992005-12-18 08:51:22 +00003192 /* Find a page to recycle. Try to locate a page that does not
3193 ** require us to do an fsync() on the journal.
3194 */
danielk19779f61c2f2007-08-27 17:27:49 +00003195 pPg = pPager->lru.pFirstSynced;
danielk197713f72992005-12-18 08:51:22 +00003196
3197 /* If we could not find a page that does not require an fsync()
3198 ** on the journal file then fsync the journal file. This is a
3199 ** very slow operation, so we work hard to avoid it. But sometimes
3200 ** it can't be helped.
3201 */
danielk1977c41cc392008-05-15 08:34:54 +00003202 if( pPg==0 && pPager->lru.pFirst ){
3203 if( !pPager->errCode ){
3204 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
3205 int rc = syncJournal(pPager);
danielk197713f72992005-12-18 08:51:22 +00003206 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003207 return rc;
danielk197713f72992005-12-18 08:51:22 +00003208 }
danielk1977c41cc392008-05-15 08:34:54 +00003209 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
3210 /* If in full-sync mode, write a new journal header into the
3211 ** journal file. This is done to avoid ever modifying a journal
3212 ** header that is involved in the rollback of pages that have
3213 ** already been written to the database (in case the header is
3214 ** trashed when the nRec field is updated).
3215 */
3216 pPager->nRec = 0;
3217 assert( pPager->journalOff > 0 );
3218 assert( pPager->doNotSync==0 );
3219 rc = writeJournalHdr(pPager);
3220 if( rc!=0 ){
3221 return rc;
3222 }
3223 }
danielk197713f72992005-12-18 08:51:22 +00003224 }
danielk19779f61c2f2007-08-27 17:27:49 +00003225 pPg = pPager->lru.pFirst;
danielk197713f72992005-12-18 08:51:22 +00003226 }
danielk197713f72992005-12-18 08:51:22 +00003227
3228 assert( pPg->nRef==0 );
3229
3230 /* Write the page to the database file if it is dirty.
3231 */
danielk1977c41cc392008-05-15 08:34:54 +00003232 if( pPg->dirty && !pPager->errCode ){
danielk197713f72992005-12-18 08:51:22 +00003233 int rc;
3234 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00003235 makeClean(pPg);
3236 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00003237 pPg->pDirty = 0;
3238 rc = pager_write_pagelist( pPg );
drh153c62c2007-08-24 03:51:33 +00003239 pPg->dirty = 0;
danielk197713f72992005-12-18 08:51:22 +00003240 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00003241 return rc;
danielk197713f72992005-12-18 08:51:22 +00003242 }
3243 }
danielk1977c41cc392008-05-15 08:34:54 +00003244 assert( pPg->dirty==0 || pPager->errCode );
danielk197713f72992005-12-18 08:51:22 +00003245
3246 /* If the page we are recycling is marked as alwaysRollback, then
3247 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00003248 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00003249 ** It is necessary to do this because the page marked alwaysRollback
3250 ** might be reloaded at a later time but at that point we won't remember
3251 ** that is was marked alwaysRollback. This means that all pages must
3252 ** be marked as alwaysRollback from here on out.
3253 */
3254 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00003255 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00003256 pPager->alwaysRollback = 1;
3257 }
3258
3259 /* Unlink the old page from the free list and the hash table
3260 */
3261 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00003262 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00003263
3264 *ppPg = pPg;
3265 return SQLITE_OK;
3266}
3267
drh86f8c192007-08-22 00:39:19 +00003268#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00003269/*
3270** This function is called to free superfluous dynamically allocated memory
3271** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00003272** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00003273**
3274** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00003275** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00003276** of bytes of memory released.
3277*/
danielk19773b8a05f2007-03-19 17:44:26 +00003278int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00003279 int nReleased = 0; /* Bytes of memory released so far */
drh86f8c192007-08-22 00:39:19 +00003280 Pager *pPager; /* For looping over pagers */
drhe5fe6902007-12-07 18:55:28 +00003281 BusyHandler *savedBusy; /* Saved copy of the busy handler */
danielk19779f61c2f2007-08-27 17:27:49 +00003282 int rc = SQLITE_OK;
danielk197713f72992005-12-18 08:51:22 +00003283
drh86f8c192007-08-22 00:39:19 +00003284 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00003285 */
drh26e4a8b2008-05-01 17:16:52 +00003286#ifndef SQLITE_MUTEX_NOOP
drh64e2bb72008-05-07 12:29:55 +00003287 sqlite3_mutex *mutex; /* The MEM2 mutex */
drh86f8c192007-08-22 00:39:19 +00003288 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00003289#endif
drh86f8c192007-08-22 00:39:19 +00003290 sqlite3_mutex_enter(mutex);
3291
3292 /* Signal all database connections that memory management wants
3293 ** to have access to the pagers.
3294 */
3295 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3296 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00003297 }
3298
danielk19779f61c2f2007-08-27 17:27:49 +00003299 while( rc==SQLITE_OK && (nReq<0 || nReleased<nReq) ){
3300 PgHdr *pPg;
3301 PgHdr *pRecycled;
3302
3303 /* Try to find a page to recycle that does not require a sync(). If
3304 ** this is not possible, find one that does require a sync().
3305 */
3306 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
3307 pPg = sqlite3LruPageList.pFirstSynced;
3308 while( pPg && (pPg->needSync || pPg->pPager->iInUseDB) ){
3309 pPg = pPg->gfree.pNext;
3310 }
3311 if( !pPg ){
3312 pPg = sqlite3LruPageList.pFirst;
3313 while( pPg && pPg->pPager->iInUseDB ){
3314 pPg = pPg->gfree.pNext;
3315 }
3316 }
3317 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
danielk197713f72992005-12-18 08:51:22 +00003318
danielk197784f786f2007-08-28 08:00:17 +00003319 /* If pPg==0, then the block above has failed to find a page to
3320 ** recycle. In this case return early - no further memory will
3321 ** be released.
3322 */
danielk19779f61c2f2007-08-27 17:27:49 +00003323 if( !pPg ) break;
danielk197713f72992005-12-18 08:51:22 +00003324
danielk19779f61c2f2007-08-27 17:27:49 +00003325 pPager = pPg->pPager;
3326 assert(!pPg->needSync || pPg==pPager->lru.pFirst);
3327 assert(pPg->needSync || pPg==pPager->lru.pFirstSynced);
3328
drhe5fe6902007-12-07 18:55:28 +00003329 savedBusy = pPager->pBusyHandler;
3330 pPager->pBusyHandler = 0;
danielk1977843e65f2007-09-01 16:16:15 +00003331 rc = pager_recycle(pPager, &pRecycled);
drhe5fe6902007-12-07 18:55:28 +00003332 pPager->pBusyHandler = savedBusy;
danielk19779f61c2f2007-08-27 17:27:49 +00003333 assert(pRecycled==pPg || rc!=SQLITE_OK);
3334 if( rc==SQLITE_OK ){
3335 /* We've found a page to free. At this point the page has been
3336 ** removed from the page hash-table, free-list and synced-list
3337 ** (pFirstSynced). It is still in the all pages (pAll) list.
3338 ** Remove it from this list before freeing.
3339 **
3340 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
3341 ** probably is though.
danielk197713f72992005-12-18 08:51:22 +00003342 */
danielk19779f61c2f2007-08-27 17:27:49 +00003343 PgHdr *pTmp;
3344 assert( pPg );
3345 if( pPg==pPager->pAll ){
3346 pPager->pAll = pPg->pNextAll;
3347 }else{
3348 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
3349 pTmp->pNextAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00003350 }
danielk19779f61c2f2007-08-27 17:27:49 +00003351 nReleased += (
3352 sizeof(*pPg) + pPager->pageSize
3353 + sizeof(u32) + pPager->nExtra
3354 + MEMDB*sizeof(PgHistory)
3355 );
3356 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
3357 PAGER_INCR(sqlite3_pager_pgfree_count);
drh0d180202008-02-14 23:26:56 +00003358 sqlite3_free(pPg->pData);
danielk19779f61c2f2007-08-27 17:27:49 +00003359 sqlite3_free(pPg);
danielk197784f786f2007-08-28 08:00:17 +00003360 pPager->nPage--;
danielk19779f61c2f2007-08-27 17:27:49 +00003361 }else{
3362 /* An error occured whilst writing to the database file or
3363 ** journal in pager_recycle(). The error is not returned to the
3364 ** caller of this function. Instead, set the Pager.errCode variable.
3365 ** The error will be returned to the user (or users, in the case
3366 ** of a shared pager cache) of the pager for which the error occured.
3367 */
3368 assert(
3369 (rc&0xff)==SQLITE_IOERR ||
3370 rc==SQLITE_FULL ||
3371 rc==SQLITE_BUSY
3372 );
3373 assert( pPager->state>=PAGER_RESERVED );
3374 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00003375 }
3376 }
danielk1977aef0bf62005-12-30 16:28:01 +00003377
drh86f8c192007-08-22 00:39:19 +00003378 /* Clear the memory management flags and release the mutex
3379 */
3380 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3381 pPager->iInUseMM = 0;
3382 }
3383 sqlite3_mutex_leave(mutex);
3384
3385 /* Return the number of bytes released
3386 */
danielk197713f72992005-12-18 08:51:22 +00003387 return nReleased;
3388}
drh86f8c192007-08-22 00:39:19 +00003389#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00003390
drh165ffe92005-03-15 17:09:30 +00003391/*
danielk1977e180dd92007-04-05 17:15:52 +00003392** Read the content of page pPg out of the database file.
3393*/
3394static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
3395 int rc;
danielk197762079062007-08-15 17:08:46 +00003396 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00003397 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00003398 assert(pPager->fd->pMethods||pPager->tempFile);
3399 if( !pPager->fd->pMethods ){
3400 return SQLITE_IOERR_SHORT_READ;
3401 }
danielk197762079062007-08-15 17:08:46 +00003402 offset = (pgno-1)*(i64)pPager->pageSize;
3403 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003404 PAGER_INCR(sqlite3_pager_readdb_count);
3405 PAGER_INCR(pPager->nRead);
3406 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00003407 if( pgno==1 ){
3408 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
3409 sizeof(pPager->dbFileVers));
3410 }
danielk1977e180dd92007-04-05 17:15:52 +00003411 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00003412 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
3413 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00003414 return rc;
3415}
3416
3417
3418/*
danielk1977e277be02007-03-23 18:12:06 +00003419** This function is called to obtain the shared lock required before
3420** data may be read from the pager cache. If the shared lock has already
3421** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00003422**
3423** Immediately after obtaining the shared lock (if required), this function
3424** checks for a hot-journal file. If one is found, an emergency rollback
3425** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00003426*/
3427static int pagerSharedLock(Pager *pPager){
3428 int rc = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00003429 int isHot = 0;
danielk1977e277be02007-03-23 18:12:06 +00003430
danielk1977ae72d982007-10-03 08:46:44 +00003431 /* If this database is opened for exclusive access, has no outstanding
3432 ** page references and is in an error-state, now is the chance to clear
3433 ** the error. Discard the contents of the pager-cache and treat any
3434 ** open journal file as a hot-journal.
3435 */
3436 if( !MEMDB && pPager->exclusiveMode && pPager->nRef==0 && pPager->errCode ){
3437 if( pPager->journalOpen ){
3438 isHot = 1;
3439 }
danielk1977ae72d982007-10-03 08:46:44 +00003440 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00003441 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00003442 }
3443
3444 /* If the pager is still in an error state, do not proceed. The error
3445 ** state will be cleared at some point in the future when all page
3446 ** references are dropped and the cache can be discarded.
3447 */
3448 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3449 return pPager->errCode;
3450 }
3451
3452 if( pPager->state==PAGER_UNLOCK || isHot ){
danielk1977b4b47412007-08-17 15:53:36 +00003453 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00003454 if( !MEMDB ){
3455 assert( pPager->nRef==0 );
3456 if( !pPager->noReadlock ){
3457 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
3458 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003459 assert( pPager->state==PAGER_UNLOCK );
danielk1977e277be02007-03-23 18:12:06 +00003460 return pager_error(pPager, rc);
3461 }
3462 assert( pPager->state>=SHARED_LOCK );
3463 }
3464
3465 /* If a journal file exists, and there is no RESERVED lock on the
3466 ** database file, then it either needs to be played back or deleted.
3467 */
drh19db9352008-03-27 22:42:51 +00003468 rc = hasHotJournal(pPager);
3469 if( rc<0 ){
danielk197752b472a2008-05-05 16:23:55 +00003470 rc = SQLITE_IOERR_NOMEM;
3471 goto failed;
drh19db9352008-03-27 22:42:51 +00003472 }
3473 if( rc==1 || isHot ){
danielk1977e277be02007-03-23 18:12:06 +00003474 /* Get an EXCLUSIVE lock on the database file. At this point it is
3475 ** important that a RESERVED lock is not obtained on the way to the
3476 ** EXCLUSIVE lock. If it were, another process might open the
3477 ** database file, detect the RESERVED lock, and conclude that the
3478 ** database is safe to read while this process is still rolling it
3479 ** back.
3480 **
3481 ** Because the intermediate RESERVED lock is not requested, the
3482 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00003483 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00003484 */
danielk1977ae72d982007-10-03 08:46:44 +00003485 if( pPager->state<EXCLUSIVE_LOCK ){
3486 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3487 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003488 rc = pager_error(pPager, rc);
3489 goto failed;
danielk1977ae72d982007-10-03 08:46:44 +00003490 }
3491 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00003492 }
danielk1977e277be02007-03-23 18:12:06 +00003493
drh16e45a42008-04-19 20:34:18 +00003494 /* Open the journal for read/write access. This is because in
drhfd131da2007-08-07 17:13:03 +00003495 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003496 ** possibly used for a transaction later on. On some systems, the
3497 ** OsTruncate() call used in exclusive-access mode also requires
3498 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003499 */
drh16e45a42008-04-19 20:34:18 +00003500 if( !isHot && pPager->journalOpen==0 ){
danielk1977ce98bba2008-04-03 10:13:01 +00003501 int res = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS);
3502 if( res==1 ){
danielk1977ae72d982007-10-03 08:46:44 +00003503 int fout = 0;
3504 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
3505 assert( !pPager->tempFile );
3506 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
3507 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3508 if( fout&SQLITE_OPEN_READONLY ){
3509 rc = SQLITE_BUSY;
3510 sqlite3OsClose(pPager->jfd);
3511 }
drh16e45a42008-04-19 20:34:18 +00003512 }else if( res==0 ){
3513 /* If the journal does not exist, that means some other process
3514 ** has already rolled it back */
3515 rc = SQLITE_BUSY;
danielk1977ce98bba2008-04-03 10:13:01 +00003516 }else{
drh16e45a42008-04-19 20:34:18 +00003517 /* If sqlite3OsAccess() returns a negative value, that means it
3518 ** failed a memory allocation */
3519 rc = SQLITE_IOERR_NOMEM;
danielk1977979f38e2007-03-27 16:19:51 +00003520 }
3521 }
danielk1977e277be02007-03-23 18:12:06 +00003522 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003523 if( rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_UNLOCK
3524 && rc!=SQLITE_IOERR_NOMEM
3525 ){
3526 rc = SQLITE_BUSY;
drh1aa5af12008-03-07 19:51:14 +00003527 }
danielk197752b472a2008-05-05 16:23:55 +00003528 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003529 }
3530 pPager->journalOpen = 1;
3531 pPager->journalStarted = 0;
3532 pPager->journalOff = 0;
3533 pPager->setMaster = 0;
3534 pPager->journalHdr = 0;
3535
3536 /* Playback and delete the journal. Drop the database write
3537 ** lock and reacquire the read lock.
3538 */
3539 rc = pager_playback(pPager, 1);
3540 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003541 rc = pager_error(pPager, rc);
3542 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003543 }
danielk1977c5859712007-03-26 12:26:27 +00003544 assert(pPager->state==PAGER_SHARED ||
3545 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3546 );
danielk1977e277be02007-03-23 18:12:06 +00003547 }
3548
3549 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003550 /* The shared-lock has just been acquired on the database file
3551 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003552 ** read or write transaction). Check to see if the database
3553 ** has been modified. If the database has changed, flush the
3554 ** cache.
3555 **
3556 ** Database changes is detected by looking at 15 bytes beginning
3557 ** at offset 24 into the file. The first 4 of these 16 bytes are
3558 ** a 32-bit counter that is incremented with each change. The
3559 ** other bytes change randomly with each file change when
3560 ** a codec is in use.
3561 **
3562 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003563 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003564 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003565 */
drh86a88112007-04-16 15:02:19 +00003566 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003567 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003568
danielk1977e180dd92007-04-05 17:15:52 +00003569 if( pPager->errCode ){
danielk197752b472a2008-05-05 16:23:55 +00003570 rc = pPager->errCode;
3571 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003572 }
3573
danielk1977e180dd92007-04-05 17:15:52 +00003574 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003575 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003576 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003577 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003578 goto failed;
danielk1977e180dd92007-04-05 17:15:52 +00003579 }
drh86a88112007-04-16 15:02:19 +00003580 }else{
3581 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003582 }
3583
drh86a88112007-04-16 15:02:19 +00003584 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003585 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003586 }
3587 }
3588 }
danielk1977c5859712007-03-26 12:26:27 +00003589 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3590 if( pPager->state==PAGER_UNLOCK ){
3591 pPager->state = PAGER_SHARED;
3592 }
danielk1977e277be02007-03-23 18:12:06 +00003593 }
3594
danielk197752b472a2008-05-05 16:23:55 +00003595 failed:
3596 if( rc!=SQLITE_OK ){
3597 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
3598 pager_unlock(pPager);
3599 }
danielk1977e277be02007-03-23 18:12:06 +00003600 return rc;
3601}
3602
3603/*
danielk1977e180dd92007-04-05 17:15:52 +00003604** Allocate a PgHdr object. Either create a new one or reuse
3605** an existing one that is not otherwise in use.
3606**
3607** A new PgHdr structure is created if any of the following are
3608** true:
3609**
3610** (1) We have not exceeded our maximum allocated cache size
3611** as set by the "PRAGMA cache_size" command.
3612**
3613** (2) There are no unused PgHdr objects available at this time.
3614**
3615** (3) This is an in-memory database.
3616**
3617** (4) There are no PgHdr objects that do not require a journal
3618** file sync and a sync of the journal file is currently
3619** prohibited.
3620**
3621** Otherwise, reuse an existing PgHdr. In other words, reuse an
3622** existing PgHdr if all of the following are true:
3623**
3624** (1) We have reached or exceeded the maximum cache size
3625** allowed by "PRAGMA cache_size".
3626**
3627** (2) There is a PgHdr available with PgHdr->nRef==0
3628**
3629** (3) We are not in an in-memory database
3630**
3631** (4) Either there is an available PgHdr that does not need
3632** to be synced to disk or else disk syncing is currently
3633** allowed.
danielk197724168722007-04-02 05:07:47 +00003634*/
3635static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3636 int rc = SQLITE_OK;
3637 PgHdr *pPg;
drh1e3af332007-10-20 13:17:54 +00003638 int nByteHdr;
danielk197724168722007-04-02 05:07:47 +00003639
danielk1977e180dd92007-04-05 17:15:52 +00003640 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003641 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003642 if( pPager->nPage<pPager->mxPage
danielk19779f61c2f2007-08-27 17:27:49 +00003643 || pPager->lru.pFirst==0
danielk1977e180dd92007-04-05 17:15:52 +00003644 || MEMDB
danielk19779f61c2f2007-08-27 17:27:49 +00003645 || (pPager->lru.pFirstSynced==0 && pPager->doNotSync)
danielk1977e180dd92007-04-05 17:15:52 +00003646 ){
drh0d180202008-02-14 23:26:56 +00003647 void *pData;
danielk197724168722007-04-02 05:07:47 +00003648 if( pPager->nPage>=pPager->nHash ){
3649 pager_resize_hash_table(pPager,
3650 pPager->nHash<256 ? 256 : pPager->nHash*2);
3651 if( pPager->nHash==0 ){
3652 rc = SQLITE_NOMEM;
3653 goto pager_allocate_out;
3654 }
3655 }
drhed138fb2007-08-22 22:04:37 +00003656 pagerLeave(pPager);
drh1e3af332007-10-20 13:17:54 +00003657 nByteHdr = sizeof(*pPg) + sizeof(u32) + pPager->nExtra
3658 + MEMDB*sizeof(PgHistory);
drh0d180202008-02-14 23:26:56 +00003659 pPg = sqlite3_malloc( nByteHdr );
3660 if( pPg ){
3661 pData = sqlite3_malloc( pPager->pageSize );
3662 if( pData==0 ){
3663 sqlite3_free(pPg);
3664 pPg = 0;
3665 }
3666 }
drhed138fb2007-08-22 22:04:37 +00003667 pagerEnter(pPager);
danielk197724168722007-04-02 05:07:47 +00003668 if( pPg==0 ){
3669 rc = SQLITE_NOMEM;
3670 goto pager_allocate_out;
3671 }
drh1e3af332007-10-20 13:17:54 +00003672 memset(pPg, 0, nByteHdr);
drh0d180202008-02-14 23:26:56 +00003673 pPg->pData = pData;
danielk197724168722007-04-02 05:07:47 +00003674 pPg->pPager = pPager;
3675 pPg->pNextAll = pPager->pAll;
3676 pPager->pAll = pPg;
3677 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003678 }else{
3679 /* Recycle an existing page with a zero ref-count. */
danielk1977843e65f2007-09-01 16:16:15 +00003680 rc = pager_recycle(pPager, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003681 if( rc==SQLITE_BUSY ){
3682 rc = SQLITE_IOERR_BLOCKED;
3683 }
danielk197724168722007-04-02 05:07:47 +00003684 if( rc!=SQLITE_OK ){
3685 goto pager_allocate_out;
3686 }
3687 assert( pPager->state>=SHARED_LOCK );
3688 assert(pPg);
3689 }
3690 *ppPg = pPg;
3691
3692pager_allocate_out:
3693 return rc;
3694}
3695
3696/*
drhd33d5a82007-04-26 12:11:28 +00003697** Make sure we have the content for a page. If the page was
3698** previously acquired with noContent==1, then the content was
3699** just initialized to zeros instead of being read from disk.
3700** But now we need the real data off of disk. So make sure we
3701** have it. Read it in if we do not have it already.
3702*/
3703static int pager_get_content(PgHdr *pPg){
3704 if( pPg->needRead ){
3705 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3706 if( rc==SQLITE_OK ){
3707 pPg->needRead = 0;
3708 }else{
3709 return rc;
3710 }
3711 }
3712 return SQLITE_OK;
3713}
3714
3715/*
drhd9b02572001-04-15 00:37:09 +00003716** Acquire a page.
3717**
drh58a11682001-11-10 13:51:08 +00003718** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003719** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003720**
drhd33d5a82007-04-26 12:11:28 +00003721** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003722** file is smaller than the requested page, then no actual disk
3723** read occurs and the memory image of the page is initialized to
3724** all zeros. The extra data appended to a page is always initialized
3725** to zeros the first time a page is loaded into memory.
3726**
drhd9b02572001-04-15 00:37:09 +00003727** The acquisition might fail for several reasons. In all cases,
3728** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003729**
drhd33d5a82007-04-26 12:11:28 +00003730** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003731** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003732** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003733** just returns 0. This routine acquires a read-lock the first time it
3734** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003735** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003736** or journal files.
drh0787db62007-03-04 13:15:27 +00003737**
drh538f5702007-04-13 02:14:30 +00003738** If noContent is false, the page contents are actually read from disk.
3739** If noContent is true, it means that we do not care about the contents
3740** of the page at this time, so do not do a disk read. Just fill in the
3741** page content with zeros. But mark the fact that we have not read the
3742** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003743** sqlite3PagerWrite() is called on this page or if this routine is
3744** called again with noContent==0, that means that the content is needed
3745** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003746*/
drh86f8c192007-08-22 00:39:19 +00003747static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003748 Pager *pPager, /* The pager open on the database file */
3749 Pgno pgno, /* Page number to fetch */
3750 DbPage **ppPage, /* Write a pointer to the page here */
3751 int noContent /* Do not bother reading content from disk if true */
3752){
drhed7c8552001-04-11 14:29:21 +00003753 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003754 int rc;
drhed7c8552001-04-11 14:29:21 +00003755
danielk1977e277be02007-03-23 18:12:06 +00003756 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3757
danielk197726836652005-01-17 01:33:13 +00003758 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3759 ** number greater than this, or zero, is requested.
3760 */
drh267cb322005-09-16 17:16:52 +00003761 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003762 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003763 }
3764
drhd9b02572001-04-15 00:37:09 +00003765 /* Make sure we have not hit any critical errors.
3766 */
drh836faa42003-01-11 13:30:57 +00003767 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003768 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00003769
danielk197713adf8a2004-06-03 16:08:41 +00003770 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003771 ** on the database file. pagerSharedLock() is a no-op if
3772 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003773 */
danielk1977e277be02007-03-23 18:12:06 +00003774 rc = pagerSharedLock(pPager);
3775 if( rc!=SQLITE_OK ){
3776 return rc;
drhed7c8552001-04-11 14:29:21 +00003777 }
danielk1977e277be02007-03-23 18:12:06 +00003778 assert( pPager->state!=PAGER_UNLOCK );
3779
3780 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003781 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003782 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003783 int nMax;
drhed7c8552001-04-11 14:29:21 +00003784 int h;
drh538f5702007-04-13 02:14:30 +00003785 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003786 rc = pagerAllocatePage(pPager, &pPg);
3787 if( rc!=SQLITE_OK ){
3788 return rc;
drhed7c8552001-04-11 14:29:21 +00003789 }
danielk197724168722007-04-02 05:07:47 +00003790
drhed7c8552001-04-11 14:29:21 +00003791 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003792 assert( !MEMDB || pgno>pPager->stmtSize );
drhf5e7bb52008-02-18 14:47:33 +00003793 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
3794 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003795
drh605ad8f2006-05-03 23:34:05 +00003796 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003797 pPg->nRef = 1;
danielk197775bab7d2006-01-23 13:09:45 +00003798
drhd9b02572001-04-15 00:37:09 +00003799 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003800 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003801 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003802 }
danielk1977979f38e2007-03-27 16:19:51 +00003803 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003804 if( pPager->errCode ){
danielk1977efaaf572006-01-16 11:29:19 +00003805 rc = pPager->errCode;
danielk1977ae72d982007-10-03 08:46:44 +00003806 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00003807 return rc;
3808 }
danielk197775bab7d2006-01-23 13:09:45 +00003809
3810 /* Populate the page with data, either by reading from the database
3811 ** file, or by setting the entire page to zero.
3812 */
drhd215acf2007-04-13 04:01:58 +00003813 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003814 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003815 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003816 return SQLITE_FULL;
3817 }
drh90f5ecb2004-07-22 01:19:35 +00003818 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003819 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003820 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003821 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003822 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003823 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3824 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003825 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003826 return rc;
drh81a20f22001-10-12 17:30:04 +00003827 }
danielk1977b4626a32007-04-28 15:47:43 +00003828 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003829 }
danielk197775bab7d2006-01-23 13:09:45 +00003830
3831 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003832 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003833 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003834 pPg->pNextHash = pPager->aHash[h];
3835 pPager->aHash[h] = pPg;
3836 if( pPg->pNextHash ){
3837 assert( pPg->pNextHash->pPrevHash==0 );
3838 pPg->pNextHash->pPrevHash = pPg;
3839 }
3840
danielk19773c407372005-02-15 02:54:14 +00003841#ifdef SQLITE_CHECK_PAGES
3842 pPg->pageHash = pager_pagehash(pPg);
3843#endif
drhed7c8552001-04-11 14:29:21 +00003844 }else{
drhd9b02572001-04-15 00:37:09 +00003845 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003846 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003847 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003848 if( !noContent ){
3849 rc = pager_get_content(pPg);
3850 if( rc ){
3851 return rc;
3852 }
3853 }
drhdf0b3b02001-06-23 11:36:20 +00003854 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003855 }
danielk19773b8a05f2007-03-19 17:44:26 +00003856 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003857 return SQLITE_OK;
3858}
drh86f8c192007-08-22 00:39:19 +00003859int sqlite3PagerAcquire(
3860 Pager *pPager, /* The pager open on the database file */
3861 Pgno pgno, /* Page number to fetch */
3862 DbPage **ppPage, /* Write a pointer to the page here */
3863 int noContent /* Do not bother reading content from disk if true */
3864){
3865 int rc;
3866 pagerEnter(pPager);
3867 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3868 pagerLeave(pPager);
3869 return rc;
3870}
3871
drhed7c8552001-04-11 14:29:21 +00003872
3873/*
drh7e3b0a02001-04-28 16:52:40 +00003874** Acquire a page if it is already in the in-memory cache. Do
3875** not read the page from disk. Return a pointer to the page,
3876** or 0 if the page is not in cache.
3877**
danielk19773b8a05f2007-03-19 17:44:26 +00003878** See also sqlite3PagerGet(). The difference between this routine
3879** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003880** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003881** returns NULL if the page is not in cache or if a disk I/O error
3882** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003883*/
danielk19773b8a05f2007-03-19 17:44:26 +00003884DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003885 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003886
drh836faa42003-01-11 13:30:57 +00003887 assert( pPager!=0 );
3888 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003889
drh86f8c192007-08-22 00:39:19 +00003890 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003891 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003892 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003893 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3894 /* Do nothing */
3895 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3896 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003897 }
drh86f8c192007-08-22 00:39:19 +00003898 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003899 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003900}
3901
3902/*
drhed7c8552001-04-11 14:29:21 +00003903** Release a page.
3904**
3905** If the number of references to the page drop to zero, then the
3906** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003907** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003908** removed.
3909*/
danielk19773b8a05f2007-03-19 17:44:26 +00003910int sqlite3PagerUnref(DbPage *pPg){
drh6eac06e2008-05-07 12:45:41 +00003911 Pager *pPager;
3912
3913 if( pPg==0 ) return SQLITE_OK;
3914 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003915
3916 /* Decrement the reference count for this page
3917 */
drhed7c8552001-04-11 14:29:21 +00003918 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003919 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003920 pPg->nRef--;
drhd9b02572001-04-15 00:37:09 +00003921
danielk19773c407372005-02-15 02:54:14 +00003922 CHECK_PAGE(pPg);
3923
drh72f82862001-05-24 21:06:34 +00003924 /* When the number of references to a page reach 0, call the
3925 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003926 */
drhed7c8552001-04-11 14:29:21 +00003927 if( pPg->nRef==0 ){
danielk19779f61c2f2007-08-27 17:27:49 +00003928
3929 lruListAdd(pPg);
drh72f82862001-05-24 21:06:34 +00003930 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003931 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003932 }
drhd9b02572001-04-15 00:37:09 +00003933
3934 /* When all pages reach the freelist, drop the read lock from
3935 ** the database file.
3936 */
3937 pPager->nRef--;
3938 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003939 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003940 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003941 }
drhed7c8552001-04-11 14:29:21 +00003942 }
danielk1977ae72d982007-10-03 08:46:44 +00003943 pagerLeave(pPager);
drhd9b02572001-04-15 00:37:09 +00003944 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003945}
3946
3947/*
drha6abd042004-06-09 17:37:22 +00003948** Create a journal file for pPager. There should already be a RESERVED
3949** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003950**
3951** Return SQLITE_OK if everything. Return an error code and release the
3952** write lock if anything goes wrong.
3953*/
3954static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003955 sqlite3_vfs *pVfs = pPager->pVfs;
3956 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3957
drhda47d772002-12-02 04:25:19 +00003958 int rc;
drhb7f91642004-10-31 02:22:47 +00003959 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003960 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003961 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003962 assert( pPager->pInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003963 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003964 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003965 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00003966 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003967 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003968 rc = SQLITE_NOMEM;
3969 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003970 }
danielk1977b4b47412007-08-17 15:53:36 +00003971
drhfdc40e92008-04-17 20:59:37 +00003972 if( pPager->journalOpen==0 ){
3973 if( pPager->tempFile ){
3974 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3975 }else{
3976 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00003977 }
drhfdc40e92008-04-17 20:59:37 +00003978#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3979 rc = sqlite3JournalOpen(
3980 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3981 );
3982#else
3983 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
3984#endif
3985 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3986 pPager->journalOff = 0;
3987 pPager->setMaster = 0;
3988 pPager->journalHdr = 0;
3989 if( rc!=SQLITE_OK ){
3990 if( rc==SQLITE_NOMEM ){
3991 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3992 }
3993 goto failed_to_open_journal;
3994 }
drhda47d772002-12-02 04:25:19 +00003995 }
3996 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003997 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003998 pPager->needSync = 0;
3999 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00004000 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00004001 if( pPager->errCode ){
4002 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00004003 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00004004 }
drhda47d772002-12-02 04:25:19 +00004005 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00004006
danielk197776572402004-06-25 02:38:54 +00004007 rc = writeJournalHdr(pPager);
4008
drhac69b052004-05-12 13:30:07 +00004009 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004010 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00004011 }
danielk1977ae72d982007-10-03 08:46:44 +00004012 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00004013 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00004014 if( rc==SQLITE_OK ){
4015 rc = SQLITE_FULL;
4016 }
4017 }
drh9c105bb2004-10-02 20:38:28 +00004018 return rc;
4019
4020failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00004021 sqlite3BitvecDestroy(pPager->pInJournal);
4022 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00004023 return rc;
drhda47d772002-12-02 04:25:19 +00004024}
4025
4026/*
drh4b845d72002-03-05 12:41:19 +00004027** Acquire a write-lock on the database. The lock is removed when
4028** the any of the following happen:
4029**
drh80e35f42007-03-30 14:06:34 +00004030** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00004031** * sqlite3PagerRollback() is called.
4032** * sqlite3PagerClose() is called.
4033** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00004034**
danielk197713adf8a2004-06-03 16:08:41 +00004035** The first parameter to this routine is a pointer to any open page of the
4036** database file. Nothing changes about the page - it is used merely to
4037** acquire a pointer to the Pager structure and as proof that there is
4038** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00004039**
danielk197713adf8a2004-06-03 16:08:41 +00004040** The second parameter indicates how much space in bytes to reserve for a
4041** master journal file-name at the start of the journal when it is created.
4042**
4043** A journal file is opened if this is not a temporary file. For temporary
4044** files, the opening of the journal file is deferred until there is an
4045** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00004046**
drha6abd042004-06-09 17:37:22 +00004047** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00004048**
4049** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
4050** immediately instead of waiting until we try to flush the cache. The
4051** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00004052*/
danielk19773b8a05f2007-03-19 17:44:26 +00004053int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00004054 Pager *pPager = pPg->pPager;
4055 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00004056 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00004057 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00004058 assert( pPager->state!=PAGER_UNLOCK );
4059 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00004060 assert( pPager->pInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00004061 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00004062 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00004063 pPager->origDbSize = pPager->dbSize;
4064 }else{
drh054889e2005-11-30 03:20:31 +00004065 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00004066 if( rc==SQLITE_OK ){
4067 pPager->state = PAGER_RESERVED;
4068 if( exFlag ){
4069 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
4070 }
4071 }
danielk19779eed5052004-06-04 10:38:30 +00004072 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00004073 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00004074 return rc;
drhac69b052004-05-12 13:30:07 +00004075 }
drha6abd042004-06-09 17:37:22 +00004076 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00004077 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhfdc40e92008-04-17 20:59:37 +00004078 if( pPager->useJournal && !pPager->tempFile
4079 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drhac69b052004-05-12 13:30:07 +00004080 rc = pager_open_journal(pPager);
4081 }
drh4b845d72002-03-05 12:41:19 +00004082 }
danielk1977334cdb62007-03-26 08:05:12 +00004083 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00004084 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00004085 ** time a (read or write) transaction was successfully concluded
4086 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00004087 ** kept open and either was truncated to 0 bytes or its header was
4088 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00004089 */
4090 assert( pPager->nRec==0 );
4091 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00004092 assert( pPager->pInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00004093 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00004094 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004095 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhed138fb2007-08-22 22:04:37 +00004096 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004097 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00004098 rc = SQLITE_NOMEM;
4099 }else{
drh369339d2007-03-30 16:01:55 +00004100 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00004101 rc = writeJournalHdr(pPager);
4102 }
drh4b845d72002-03-05 12:41:19 +00004103 }
danielk1977334cdb62007-03-26 08:05:12 +00004104 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00004105 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00004106 return rc;
4107}
4108
4109/*
drh605ad8f2006-05-03 23:34:05 +00004110** Make a page dirty. Set its dirty flag and add it to the dirty
4111** page list.
4112*/
4113static void makeDirty(PgHdr *pPg){
4114 if( pPg->dirty==0 ){
4115 Pager *pPager = pPg->pPager;
4116 pPg->dirty = 1;
4117 pPg->pDirty = pPager->pDirty;
4118 if( pPager->pDirty ){
4119 pPager->pDirty->pPrevDirty = pPg;
4120 }
4121 pPg->pPrevDirty = 0;
4122 pPager->pDirty = pPg;
4123 }
4124}
4125
4126/*
4127** Make a page clean. Clear its dirty bit and remove it from the
4128** dirty page list.
4129*/
4130static void makeClean(PgHdr *pPg){
4131 if( pPg->dirty ){
4132 pPg->dirty = 0;
4133 if( pPg->pDirty ){
drh153c62c2007-08-24 03:51:33 +00004134 assert( pPg->pDirty->pPrevDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004135 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
4136 }
4137 if( pPg->pPrevDirty ){
drh153c62c2007-08-24 03:51:33 +00004138 assert( pPg->pPrevDirty->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004139 pPg->pPrevDirty->pDirty = pPg->pDirty;
4140 }else{
drh153c62c2007-08-24 03:51:33 +00004141 assert( pPg->pPager->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004142 pPg->pPager->pDirty = pPg->pDirty;
4143 }
4144 }
4145}
4146
4147
4148/*
drhed7c8552001-04-11 14:29:21 +00004149** Mark a data page as writeable. The page is written into the journal
4150** if it is not there already. This routine must be called before making
4151** changes to a page.
4152**
4153** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00004154** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00004155** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00004156** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00004157** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00004158**
4159** If the journal file could not be written because the disk is full,
4160** then this routine returns SQLITE_FULL and does an immediate rollback.
4161** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00004162** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00004163** reset.
drhed7c8552001-04-11 14:29:21 +00004164*/
danielk19773b8a05f2007-03-19 17:44:26 +00004165static int pager_write(PgHdr *pPg){
4166 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00004167 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00004168 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00004169
drh6446c4d2001-12-15 14:22:18 +00004170 /* Check for errors
4171 */
danielk1977efaaf572006-01-16 11:29:19 +00004172 if( pPager->errCode ){
4173 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004174 }
drh5e00f6c2001-09-13 13:46:56 +00004175 if( pPager->readOnly ){
4176 return SQLITE_PERM;
4177 }
drh6446c4d2001-12-15 14:22:18 +00004178
danielk197776572402004-06-25 02:38:54 +00004179 assert( !pPager->setMaster );
4180
danielk19773c407372005-02-15 02:54:14 +00004181 CHECK_PAGE(pPg);
4182
drh538f5702007-04-13 02:14:30 +00004183 /* If this page was previously acquired with noContent==1, that means
4184 ** we didn't really read in the content of the page. This can happen
4185 ** (for example) when the page is being moved to the freelist. But
4186 ** now we are (perhaps) moving the page off of the freelist for
4187 ** reuse and we need to know its original content so that content
4188 ** can be stored in the rollback journal. So do the read at this
4189 ** time.
4190 */
drhd33d5a82007-04-26 12:11:28 +00004191 rc = pager_get_content(pPg);
4192 if( rc ){
4193 return rc;
drh538f5702007-04-13 02:14:30 +00004194 }
4195
drh6446c4d2001-12-15 14:22:18 +00004196 /* Mark the page as dirty. If the page has already been written
4197 ** to the journal then we can return right away.
4198 */
drh605ad8f2006-05-03 23:34:05 +00004199 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00004200 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00004201 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004202 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004203 }else{
drh6446c4d2001-12-15 14:22:18 +00004204
danielk1977a0bf2652004-11-04 14:30:04 +00004205 /* If we get this far, it means that the page needs to be
4206 ** written to the transaction journal or the ckeckpoint journal
4207 ** or both.
4208 **
4209 ** First check to see that the transaction journal exists and
4210 ** create it if it does not.
4211 */
4212 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00004213 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00004214 if( rc!=SQLITE_OK ){
4215 return rc;
4216 }
4217 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00004218 if( !pPager->journalOpen && pPager->useJournal
4219 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00004220 rc = pager_open_journal(pPager);
4221 if( rc!=SQLITE_OK ) return rc;
4222 }
danielk1977a0bf2652004-11-04 14:30:04 +00004223 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004224 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004225
4226 /* The transaction journal now exists and we have a RESERVED or an
4227 ** EXCLUSIVE lock on the main database file. Write the current page to
4228 ** the transaction journal if it is not there already.
4229 */
drhfdc40e92008-04-17 20:59:37 +00004230 if( !pPg->inJournal && (pPager->journalOpen || MEMDB) ){
danielk1977a0bf2652004-11-04 14:30:04 +00004231 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00004232 if( MEMDB ){
4233 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00004234 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004235 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00004236 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977662278e2007-11-05 15:30:12 +00004237 if( !pHist->pOrig ){
4238 return SQLITE_NOMEM;
danielk1977a0bf2652004-11-04 14:30:04 +00004239 }
danielk1977662278e2007-11-05 15:30:12 +00004240 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977a0bf2652004-11-04 14:30:04 +00004241 }else{
drhbf4bca52007-09-06 22:19:14 +00004242 u32 cksum;
4243 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00004244
drh267cb322005-09-16 17:16:52 +00004245 /* We should never write to the journal file the page that
4246 ** contains the database locks. The following assert verifies
4247 ** that we do not. */
4248 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00004249 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00004250 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00004251 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
4252 if( rc==SQLITE_OK ){
4253 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
4254 pPager->journalOff + 4);
4255 pPager->journalOff += pPager->pageSize+4;
4256 }
4257 if( rc==SQLITE_OK ){
4258 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
4259 pPager->journalOff += 4;
4260 }
4261 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00004262 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00004263 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00004264 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
4265 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00004266
drhfd131da2007-08-07 17:13:03 +00004267 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00004268 ** transaction will be rolled back by the layer above.
4269 */
danielk1977a0bf2652004-11-04 14:30:04 +00004270 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00004271 return rc;
4272 }
danielk197707cb5602006-01-20 10:55:05 +00004273
danielk1977a0bf2652004-11-04 14:30:04 +00004274 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00004275 assert( pPager->pInJournal!=0 );
4276 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004277 pPg->needSync = !pPager->noSync;
4278 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00004279 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004280 }
drhac69b052004-05-12 13:30:07 +00004281 }
danielk197713adf8a2004-06-03 16:08:41 +00004282 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004283 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00004284 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00004285 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00004286 }
4287 if( pPg->needSync ){
4288 pPager->needSync = 1;
4289 }
4290 pPg->inJournal = 1;
4291 }
4292
4293 /* If the statement journal is open and the page is not in it,
4294 ** then write the current page to the statement journal. Note that
4295 ** the statement journal format differs from the standard journal format
4296 ** in that it omits the checksums and the header.
4297 */
danielk1977f35843b2007-04-07 15:03:17 +00004298 if( pPager->stmtInUse
4299 && !pageInStatement(pPg)
4300 && (int)pPg->pgno<=pPager->stmtSize
4301 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004302 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
4303 if( MEMDB ){
4304 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4305 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00004306 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00004307 if( pHist->pStmt ){
4308 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
4309 }
drh4f0c5872007-03-26 22:05:01 +00004310 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00004311 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00004312 }else{
danielk197762079062007-08-15 17:08:46 +00004313 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00004314 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
4315 rc = write32bits(pPager->stfd, offset, pPg->pgno);
4316 if( rc==SQLITE_OK ){
4317 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
4318 }
drh4f0c5872007-03-26 22:05:01 +00004319 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00004320 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00004321 return rc;
4322 }
danielk1977a0bf2652004-11-04 14:30:04 +00004323 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00004324 assert( pPager->pInStmt!=0 );
4325 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00004326 }
drhd9b02572001-04-15 00:37:09 +00004327 }
drhfa86c412002-02-02 15:01:15 +00004328 }
4329
4330 /* Update the database size and return.
4331 */
drh1aa2d8b2007-01-03 15:34:29 +00004332 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00004333 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00004334 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00004335 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00004336 pPager->dbSize++;
4337 }
drh306dc212001-05-21 13:45:10 +00004338 }
drh69688d52001-04-14 16:38:23 +00004339 return rc;
drhed7c8552001-04-11 14:29:21 +00004340}
4341
4342/*
danielk19774099f6e2007-03-19 11:25:20 +00004343** This function is used to mark a data-page as writable. It uses
4344** pager_write() to open a journal file (if it is not already open)
4345** and write the page *pData to the journal.
4346**
4347** The difference between this function and pager_write() is that this
4348** function also deals with the special case where 2 or more pages
4349** fit on a single disk sector. In this case all co-resident pages
4350** must have been written to the journal file before returning.
4351*/
danielk19773b8a05f2007-03-19 17:44:26 +00004352int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00004353 int rc = SQLITE_OK;
4354
danielk19773b8a05f2007-03-19 17:44:26 +00004355 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00004356 Pager *pPager = pPg->pPager;
4357 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
4358
drh86f8c192007-08-22 00:39:19 +00004359 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004360 if( !MEMDB && nPagePerSector>1 ){
4361 Pgno nPageCount; /* Total number of pages in database file */
4362 Pgno pg1; /* First page of the sector pPg is located on. */
4363 int nPage; /* Number of pages starting at pg1 to journal */
4364 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00004365 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00004366
4367 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
4368 ** header to be written between the pages journaled by this function.
4369 */
4370 assert( pPager->doNotSync==0 );
4371 pPager->doNotSync = 1;
4372
4373 /* This trick assumes that both the page-size and sector-size are
4374 ** an integer power of 2. It sets variable pg1 to the identifier
4375 ** of the first page of the sector pPg is located on.
4376 */
4377 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
4378
danielk19773b8a05f2007-03-19 17:44:26 +00004379 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004380 if( pPg->pgno>nPageCount ){
4381 nPage = (pPg->pgno - pg1)+1;
4382 }else if( (pg1+nPagePerSector-1)>nPageCount ){
4383 nPage = nPageCount+1-pg1;
4384 }else{
4385 nPage = nPagePerSector;
4386 }
4387 assert(nPage>0);
4388 assert(pg1<=pPg->pgno);
4389 assert((pg1+nPage)>pPg->pgno);
4390
4391 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
4392 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00004393 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00004394 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00004395 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00004396 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004397 if( rc==SQLITE_OK ){
4398 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00004399 if( pPage->needSync ){
4400 needSync = 1;
4401 }
danielk19773b8a05f2007-03-19 17:44:26 +00004402 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004403 }
4404 }
drhc81945e2008-03-10 14:12:53 +00004405 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk1977dd97a492007-08-22 18:54:32 +00004406 if( pPage->needSync ){
4407 needSync = 1;
4408 }
danielk19774099f6e2007-03-19 11:25:20 +00004409 }
4410 }
4411
danielk1977dd97a492007-08-22 18:54:32 +00004412 /* If the PgHdr.needSync flag is set for any of the nPage pages
4413 ** starting at pg1, then it needs to be set for all of them. Because
4414 ** writing to any of these nPage pages may damage the others, the
4415 ** journal file must contain sync()ed copies of all of them
4416 ** before any of them can be written out to the database file.
4417 */
4418 if( needSync ){
4419 for(ii=0; ii<nPage && needSync; ii++){
4420 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
4421 if( pPage ) pPage->needSync = 1;
4422 }
4423 assert(pPager->needSync);
4424 }
4425
danielk19774099f6e2007-03-19 11:25:20 +00004426 assert( pPager->doNotSync==1 );
4427 pPager->doNotSync = 0;
4428 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004429 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00004430 }
drh86f8c192007-08-22 00:39:19 +00004431 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004432 return rc;
4433}
4434
4435/*
drhaacc5432002-01-06 17:07:40 +00004436** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00004437** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00004438** to change the content of the page.
4439*/
danielk19777d3a6662006-01-23 16:21:05 +00004440#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00004441int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00004442 return pPg->dirty;
4443}
danielk19777d3a6662006-01-23 16:21:05 +00004444#endif
drh6019e162001-07-02 17:51:45 +00004445
drh001bbcb2003-03-19 03:14:00 +00004446/*
drh30e58752002-03-02 20:41:57 +00004447** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00004448** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00004449** that page might be marked as dirty.
4450**
4451** The overlying software layer calls this routine when all of the data
4452** on the given page is unused. The pager marks the page as clean so
4453** that it does not get written to disk.
4454**
4455** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00004456** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00004457** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00004458**
4459** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00004460** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00004461** will thereafter be ignored. This is necessary to avoid a problem
4462** where a page with data is added to the freelist during one part of
4463** a transaction then removed from the freelist during a later part
4464** of the same transaction and reused for some other purpose. When it
4465** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004466** the sqlite3PagerDontRollback() routine is called. But because the
4467** page contains critical data, we still need to be sure it gets
4468** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004469*/
drh538f5702007-04-13 02:14:30 +00004470void sqlite3PagerDontWrite(DbPage *pDbPage){
4471 PgHdr *pPg = pDbPage;
4472 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004473
drhb7f91642004-10-31 02:22:47 +00004474 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004475 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004476 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004477 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004478 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004479 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4480 /* If this pages is the last page in the file and the file has grown
4481 ** during the current transaction, then do NOT mark the page as clean.
4482 ** When the database file grows, we must make sure that the last page
4483 ** gets written at least once so that the disk file will be the correct
4484 ** size. If you do not write this page and the size of the file
4485 ** on the disk ends up being too small, that can lead to database
4486 ** corruption during the next transaction.
4487 */
4488 }else{
drh538f5702007-04-13 02:14:30 +00004489 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4490 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004491 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004492#ifdef SQLITE_CHECK_PAGES
4493 pPg->pageHash = pager_pagehash(pPg);
4494#endif
drh8124a302002-06-25 14:43:57 +00004495 }
drh30e58752002-03-02 20:41:57 +00004496 }
drh86f8c192007-08-22 00:39:19 +00004497 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004498}
4499
4500/*
4501** A call to this routine tells the pager that if a rollback occurs,
4502** it is not necessary to restore the data on the given page. This
4503** means that the pager does not have to record the given page in the
4504** rollback journal.
drh538f5702007-04-13 02:14:30 +00004505**
4506** If we have not yet actually read the content of this page (if
4507** the PgHdr.needRead flag is set) then this routine acts as a promise
4508** that we will never need to read the page content in the future.
4509** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00004510*/
danielk19773b8a05f2007-03-19 17:44:26 +00004511void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004512 Pager *pPager = pPg->pPager;
4513
drh86f8c192007-08-22 00:39:19 +00004514 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004515 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00004516
4517 /* If the journal file is not open, or DontWrite() has been called on
4518 ** this page (DontWrite() sets the alwaysRollback flag), then this
4519 ** function is a no-op.
4520 */
4521 if( pPager->journalOpen==0 || pPg->alwaysRollback || pPager->alwaysRollback ){
danielk197787c29a92008-01-18 11:33:16 +00004522 pagerLeave(pPager);
4523 return;
4524 }
danielk1977a55e9352008-01-21 13:04:34 +00004525 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
4526
drhc5d0bd92008-04-14 01:00:57 +00004527#ifdef SQLITE_SECURE_DELETE
4528 if( pPg->inJournal || (int)pPg->pgno > pPager->origDbSize ){
4529 return;
4530 }
4531#endif
4532
4533 /* If SECURE_DELETE is disabled, then there is no way that this
4534 ** routine can be called on a page for which sqlite3PagerDontWrite()
4535 ** has not been previously called during the same transaction.
4536 ** And if DontWrite() has previously been called, the following
4537 ** conditions must be met.
danielk1977a55e9352008-01-21 13:04:34 +00004538 */
4539 assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize );
4540
drhf5e7bb52008-02-18 14:47:33 +00004541 assert( pPager->pInJournal!=0 );
4542 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00004543 pPg->inJournal = 1;
4544 pPg->needRead = 0;
4545 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00004546 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00004547 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00004548 }
danielk1977a55e9352008-01-21 13:04:34 +00004549 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
4550 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh86f8c192007-08-22 00:39:19 +00004551 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004552}
4553
drhac69b052004-05-12 13:30:07 +00004554
drh30e58752002-03-02 20:41:57 +00004555/*
drh80e35f42007-03-30 14:06:34 +00004556** This routine is called to increment the database file change-counter,
4557** stored at byte 24 of the pager file.
4558*/
danielk1977c7b60172007-08-22 11:22:03 +00004559static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004560 PgHdr *pPgHdr;
4561 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004562 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004563
4564 if( !pPager->changeCountDone ){
4565 /* Open page 1 of the file for writing. */
4566 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4567 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004568
4569 if( !isDirect ){
4570 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00004571 if( rc!=SQLITE_OK ){
4572 sqlite3PagerUnref(pPgHdr);
4573 return rc;
4574 }
danielk1977c7b60172007-08-22 11:22:03 +00004575 }
4576
drh80e35f42007-03-30 14:06:34 +00004577 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004578 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004579 change_counter++;
4580 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004581
4582 if( isDirect && pPager->fd->pMethods ){
4583 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4584 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4585 }
4586
drh80e35f42007-03-30 14:06:34 +00004587 /* Release the page reference. */
4588 sqlite3PagerUnref(pPgHdr);
4589 pPager->changeCountDone = 1;
4590 }
danielk1977c7b60172007-08-22 11:22:03 +00004591 return rc;
drh80e35f42007-03-30 14:06:34 +00004592}
4593
4594/*
danielk1977f653d782008-03-20 11:04:21 +00004595** Sync the pager file to disk.
4596*/
4597int sqlite3PagerSync(Pager *pPager){
4598 int rc;
4599 pagerEnter(pPager);
4600 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
4601 pagerLeave(pPager);
4602 return rc;
4603}
4604
4605/*
drh80e35f42007-03-30 14:06:34 +00004606** Sync the database file for the pager pPager. zMaster points to the name
4607** of a master journal file that should be written into the individual
4608** journal file. zMaster may be NULL, which is interpreted as no master
4609** journal (a single database transaction).
4610**
4611** This routine ensures that the journal is synced, all dirty pages written
4612** to the database file and the database file synced. The only thing that
4613** remains to commit the transaction is to delete the journal file (or
4614** master journal file if specified).
4615**
4616** Note that if zMaster==NULL, this does not overwrite a previous value
4617** passed to an sqlite3PagerCommitPhaseOne() call.
4618**
4619** If parameter nTrunc is non-zero, then the pager file is truncated to
4620** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00004621**
4622** If the final parameter - noSync - is true, then the database file itself
4623** is not synced. The caller must call sqlite3PagerSync() directly to
4624** sync the database file before calling CommitPhaseTwo() to delete the
4625** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00004626*/
danielk1977f653d782008-03-20 11:04:21 +00004627int sqlite3PagerCommitPhaseOne(
4628 Pager *pPager,
4629 const char *zMaster,
4630 Pgno nTrunc,
4631 int noSync
4632){
drh80e35f42007-03-30 14:06:34 +00004633 int rc = SQLITE_OK;
4634
danielk1977dad31b52008-05-15 11:08:07 +00004635 if( pPager->errCode ){
4636 return pPager->errCode;
4637 }
4638
drhd138c012008-05-13 00:58:18 +00004639 /* If no changes have been made, we can leave the transaction early.
4640 */
4641 if( pPager->dbModified==0 &&
4642 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
4643 pPager->exclusiveMode!=0) ){
4644 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
4645 return SQLITE_OK;
4646 }
4647
drh80e35f42007-03-30 14:06:34 +00004648 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4649 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004650 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004651
4652 /* If this is an in-memory db, or no pages have been written to, or this
4653 ** function has already been called, it is a no-op.
4654 */
4655 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4656 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00004657
danielk1977c7b60172007-08-22 11:22:03 +00004658#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4659 /* The atomic-write optimization can be used if all of the
4660 ** following are true:
4661 **
4662 ** + The file-system supports the atomic-write property for
4663 ** blocks of size page-size, and
4664 ** + This commit is not part of a multi-file transaction, and
4665 ** + Exactly one page has been modified and store in the journal file.
4666 **
4667 ** If the optimization can be used, then the journal file will never
4668 ** be created for this transaction.
4669 */
danielk1977f55b8992007-08-24 08:15:53 +00004670 int useAtomicWrite = (
4671 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00004672 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00004673 pPager->journalOff==jrnlBufferSize(pPager) &&
4674 nTrunc==0 &&
4675 (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4676 );
danielk1977700b9c52008-04-24 12:37:40 +00004677 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00004678 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00004679 /* Update the nRec field in the journal file. */
4680 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4681 assert(pPager->nRec==1);
4682 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4683
4684 /* Update the db file change counter. The following call will modify
4685 ** the in-memory representation of page 1 to include the updated
4686 ** change counter and then write page 1 directly to the database
4687 ** file. Because of the atomic-write property of the host file-system,
4688 ** this is safe.
4689 */
danielk1977ae72d982007-10-03 08:46:44 +00004690 if( rc==SQLITE_OK ){
4691 rc = pager_incr_changecounter(pPager, 1);
4692 }
danielk1977f55b8992007-08-24 08:15:53 +00004693 }else{
4694 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00004695 }
4696
danielk1977ae72d982007-10-03 08:46:44 +00004697 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00004698#endif
4699
drh80e35f42007-03-30 14:06:34 +00004700 /* If a master journal file name has already been written to the
4701 ** journal file, then no sync is required. This happens when it is
4702 ** written, then the process fails to upgrade from a RESERVED to an
4703 ** EXCLUSIVE lock. The next time the process tries to commit the
4704 ** transaction the m-j name will have already been written.
4705 */
4706 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00004707 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004708 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00004709 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00004710#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00004711 if( nTrunc!=0 ){
4712 /* If this transaction has made the database smaller, then all pages
4713 ** being discarded by the truncation must be written to the journal
4714 ** file.
4715 */
4716 Pgno i;
4717 int iSkip = PAGER_MJ_PGNO(pPager);
4718 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
4719 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
4720 rc = sqlite3PagerGet(pPager, i, &pPg);
4721 if( rc!=SQLITE_OK ) goto sync_exit;
4722 rc = sqlite3PagerWrite(pPg);
4723 sqlite3PagerUnref(pPg);
4724 if( rc!=SQLITE_OK ) goto sync_exit;
4725 }
4726 }
4727 }
drh80e35f42007-03-30 14:06:34 +00004728#endif
danielk197771aa7ff2008-05-20 07:05:09 +00004729 rc = writeMasterJournal(pPager, zMaster);
4730 if( rc!=SQLITE_OK ) goto sync_exit;
4731 rc = syncJournal(pPager);
4732 }
drh80e35f42007-03-30 14:06:34 +00004733 }
danielk1977c7b60172007-08-22 11:22:03 +00004734 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004735
4736#ifndef SQLITE_OMIT_AUTOVACUUM
4737 if( nTrunc!=0 ){
4738 rc = sqlite3PagerTruncate(pPager, nTrunc);
4739 if( rc!=SQLITE_OK ) goto sync_exit;
4740 }
4741#endif
4742
4743 /* Write all dirty pages to the database file */
4744 pPg = pager_get_all_dirty_pages(pPager);
4745 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00004746 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00004747 assert( rc!=SQLITE_IOERR_BLOCKED );
4748 /* The error might have left the dirty list all fouled up here,
4749 ** but that does not matter because if the if the dirty list did
4750 ** get corrupted, then the transaction will roll back and
4751 ** discard the dirty list. There is an assert in
4752 ** pager_get_all_dirty_pages() that verifies that no attempt
4753 ** is made to use an invalid dirty list.
4754 */
drh153c62c2007-08-24 03:51:33 +00004755 goto sync_exit;
4756 }
drh3cdd7d32007-03-30 14:46:01 +00004757 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004758
4759 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00004760 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004761 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004762 }
4763 IOTRACE(("DBSYNC %p\n", pPager))
4764
4765 pPager->state = PAGER_SYNCED;
4766 }else if( MEMDB && nTrunc!=0 ){
4767 rc = sqlite3PagerTruncate(pPager, nTrunc);
4768 }
4769
4770sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004771 if( rc==SQLITE_IOERR_BLOCKED ){
4772 /* pager_incr_changecounter() may attempt to obtain an exclusive
4773 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00004774 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00004775 * better to return SQLITE_BUSY.
4776 */
4777 rc = SQLITE_BUSY;
4778 }
drh86f8c192007-08-22 00:39:19 +00004779 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004780 return rc;
4781}
4782
4783
4784/*
drhed7c8552001-04-11 14:29:21 +00004785** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004786**
4787** If the commit fails for any reason, a rollback attempt is made
4788** and an error code is returned. If the commit worked, SQLITE_OK
4789** is returned.
drhed7c8552001-04-11 14:29:21 +00004790*/
drh80e35f42007-03-30 14:06:34 +00004791int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004792 int rc;
drhed7c8552001-04-11 14:29:21 +00004793 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004794
danielk1977efaaf572006-01-16 11:29:19 +00004795 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004796 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004797 }
drha6abd042004-06-09 17:37:22 +00004798 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004799 return SQLITE_ERROR;
4800 }
drhd138c012008-05-13 00:58:18 +00004801 if( pPager->dbModified==0 &&
4802 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
4803 pPager->exclusiveMode!=0) ){
4804 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
4805 return SQLITE_OK;
4806 }
drh86f8c192007-08-22 00:39:19 +00004807 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004808 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004809 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004810 pPg = pager_get_all_dirty_pages(pPager);
4811 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004812 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4813 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004814 pPg->dirty = 0;
4815 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004816 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004817 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004818 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004819 pPg = pPg->pDirty;
4820 }
drh605ad8f2006-05-03 23:34:05 +00004821 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004822#ifndef NDEBUG
4823 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4824 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4825 assert( !pPg->alwaysRollback );
4826 assert( !pHist->pOrig );
4827 assert( !pHist->pStmt );
4828 }
4829#endif
drhac69b052004-05-12 13:30:07 +00004830 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004831 pPager->state = PAGER_SHARED;
danielk197787c29a92008-01-18 11:33:16 +00004832 pagerLeave(pPager);
drhac69b052004-05-12 13:30:07 +00004833 return SQLITE_OK;
4834 }
drh3cdd7d32007-03-30 14:46:01 +00004835 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
danielk1977df2566a2008-05-07 19:11:03 +00004836 rc = pager_end_transaction(pPager, pPager->setMaster);
drh86f8c192007-08-22 00:39:19 +00004837 rc = pager_error(pPager, rc);
4838 pagerLeave(pPager);
4839 return rc;
drhed7c8552001-04-11 14:29:21 +00004840}
4841
4842/*
drha6abd042004-06-09 17:37:22 +00004843** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004844** All in-memory cache pages revert to their original data contents.
4845** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004846**
4847** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004848** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004849** process is writing trash into the journal file (SQLITE_CORRUPT) or
4850** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4851** codes are returned for all these occasions. Otherwise,
4852** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004853*/
danielk19773b8a05f2007-03-19 17:44:26 +00004854int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004855 int rc;
drh4f0c5872007-03-26 22:05:01 +00004856 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004857 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004858 PgHdr *p;
4859 for(p=pPager->pAll; p; p=p->pNextAll){
4860 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004861 assert( !p->alwaysRollback );
4862 if( !p->dirty ){
4863 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4864 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4865 continue;
4866 }
4867
drhac69b052004-05-12 13:30:07 +00004868 pHist = PGHDR_TO_HIST(p, pPager);
4869 if( pHist->pOrig ){
4870 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004871 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004872 }else{
drh4f0c5872007-03-26 22:05:01 +00004873 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004874 }
4875 clearHistory(pHist);
4876 p->dirty = 0;
4877 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004878 pHist->inStmt = 0;
4879 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004880 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004881 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004882 }
drhac69b052004-05-12 13:30:07 +00004883 }
drh605ad8f2006-05-03 23:34:05 +00004884 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004885 pPager->pStmt = 0;
4886 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004887 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004888 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004889 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004890 return SQLITE_OK;
4891 }
4892
drh86f8c192007-08-22 00:39:19 +00004893 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004894 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00004895 rc = pager_end_transaction(pPager, pPager->setMaster);
drh86f8c192007-08-22 00:39:19 +00004896 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004897 return rc;
4898 }
drhdb48ee02003-01-16 13:42:43 +00004899
danielk1977efaaf572006-01-16 11:29:19 +00004900 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004901 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004902 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004903 }
drh86f8c192007-08-22 00:39:19 +00004904 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004905 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004906 }
drha6abd042004-06-09 17:37:22 +00004907 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004908 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004909 rc = pager_playback(pPager, 0);
danielk1977df2566a2008-05-07 19:11:03 +00004910 rc2 = pager_end_transaction(pPager, pPager->setMaster);
drha6abd042004-06-09 17:37:22 +00004911 if( rc==SQLITE_OK ){
4912 rc = rc2;
4913 }
4914 }else{
danielk1977e277be02007-03-23 18:12:06 +00004915 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004916 }
danielk1977e180dd92007-04-05 17:15:52 +00004917 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004918 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004919
4920 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4921 ** cache. So call pager_error() on the way out to make any error
4922 ** persistent.
4923 */
drh86f8c192007-08-22 00:39:19 +00004924 rc = pager_error(pPager, rc);
4925 pagerLeave(pPager);
4926 return rc;
drh98808ba2001-10-18 12:34:46 +00004927}
drhd9b02572001-04-15 00:37:09 +00004928
4929/*
drh5e00f6c2001-09-13 13:46:56 +00004930** Return TRUE if the database file is opened read-only. Return FALSE
4931** if the database is (in theory) writable.
4932*/
danielk19773b8a05f2007-03-19 17:44:26 +00004933int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004934 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004935}
4936
4937/*
drh0f7eb612006-08-08 13:51:43 +00004938** Return the number of references to the pager.
4939*/
danielk19773b8a05f2007-03-19 17:44:26 +00004940int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004941 return pPager->nRef;
4942}
4943
4944#ifdef SQLITE_TEST
4945/*
drhd9b02572001-04-15 00:37:09 +00004946** This routine is used for testing and analysis only.
4947*/
danielk19773b8a05f2007-03-19 17:44:26 +00004948int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004949 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004950 a[0] = pPager->nRef;
4951 a[1] = pPager->nPage;
4952 a[2] = pPager->mxPage;
4953 a[3] = pPager->dbSize;
4954 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004955 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004956 a[6] = pPager->nHit;
4957 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004958 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004959 a[9] = pPager->nRead;
4960 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004961 return a;
4962}
drh0f7eb612006-08-08 13:51:43 +00004963#endif
drhdd793422001-06-28 01:54:48 +00004964
drhfa86c412002-02-02 15:01:15 +00004965/*
drhac69b052004-05-12 13:30:07 +00004966** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004967**
4968** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004969** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004970** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004971*/
drh86f8c192007-08-22 00:39:19 +00004972static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004973 int rc;
drhac69b052004-05-12 13:30:07 +00004974 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004975 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004976 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004977 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004978 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004979 pPager->stmtInUse = 1;
4980 pPager->stmtSize = pPager->dbSize;
4981 return SQLITE_OK;
4982 }
drhda47d772002-12-02 04:25:19 +00004983 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004984 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004985 return SQLITE_OK;
4986 }
drhfa86c412002-02-02 15:01:15 +00004987 assert( pPager->journalOpen );
drhed138fb2007-08-22 22:04:37 +00004988 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004989 assert( pPager->pInStmt==0 );
4990 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00004991 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004992 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004993 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004994 return SQLITE_NOMEM;
4995 }
danielk197776572402004-06-25 02:38:54 +00004996 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004997 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004998 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004999 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00005000 if( !pPager->stmtOpen ){
drh334b2992007-09-06 23:28:23 +00005001 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, pPager->zStmtJrnl,
drh33f4e022007-09-03 15:19:34 +00005002 SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00005003 if( rc ){
5004 goto stmt_begin_failed;
5005 }
drhac69b052004-05-12 13:30:07 +00005006 pPager->stmtOpen = 1;
5007 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00005008 }
drhac69b052004-05-12 13:30:07 +00005009 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00005010 return SQLITE_OK;
5011
drhac69b052004-05-12 13:30:07 +00005012stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00005013 if( pPager->pInStmt ){
5014 sqlite3BitvecDestroy(pPager->pInStmt);
5015 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00005016 }
5017 return rc;
5018}
drh86f8c192007-08-22 00:39:19 +00005019int sqlite3PagerStmtBegin(Pager *pPager){
5020 int rc;
5021 pagerEnter(pPager);
5022 rc = pagerStmtBegin(pPager);
5023 pagerLeave(pPager);
5024 return rc;
5025}
drhfa86c412002-02-02 15:01:15 +00005026
5027/*
drhac69b052004-05-12 13:30:07 +00005028** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00005029*/
danielk19773b8a05f2007-03-19 17:44:26 +00005030int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00005031 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00005032 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00005033 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00005034 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00005035 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00005036 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhf5e7bb52008-02-18 14:47:33 +00005037 sqlite3BitvecDestroy(pPager->pInStmt);
5038 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00005039 }else{
5040 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00005041 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00005042 pNext = pHist->pNextStmt;
5043 assert( pHist->inStmt );
5044 pHist->inStmt = 0;
5045 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00005046 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00005047 pHist->pStmt = 0;
5048 }
5049 }
5050 pPager->stmtNRec = 0;
5051 pPager->stmtInUse = 0;
5052 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00005053 }
drhac69b052004-05-12 13:30:07 +00005054 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00005055 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00005056 return SQLITE_OK;
5057}
5058
5059/*
drhac69b052004-05-12 13:30:07 +00005060** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00005061*/
danielk19773b8a05f2007-03-19 17:44:26 +00005062int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00005063 int rc;
drh86f8c192007-08-22 00:39:19 +00005064 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00005065 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00005066 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00005067 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00005068 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00005069 PgHistory *pHist;
5070 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
5071 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00005072 if( pHist->pStmt ){
5073 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00005074 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00005075 pHist->pStmt = 0;
5076 }
5077 }
5078 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00005079 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00005080 rc = SQLITE_OK;
5081 }else{
5082 rc = pager_stmt_playback(pPager);
5083 }
danielk19773b8a05f2007-03-19 17:44:26 +00005084 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00005085 }else{
5086 rc = SQLITE_OK;
5087 }
drhac69b052004-05-12 13:30:07 +00005088 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00005089 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00005090 return rc;
5091}
5092
drh73509ee2003-04-06 20:44:45 +00005093/*
5094** Return the full pathname of the database file.
5095*/
danielk19773b8a05f2007-03-19 17:44:26 +00005096const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00005097 return pPager->zFilename;
5098}
5099
drhb20ea9d2004-02-09 01:20:36 +00005100/*
drhd0679ed2007-08-28 22:24:34 +00005101** Return the VFS structure for the pager.
5102*/
5103const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
5104 return pPager->pVfs;
5105}
5106
5107/*
drhcc6bb3e2007-08-31 16:11:35 +00005108** Return the file handle for the database file associated
5109** with the pager. This might return NULL if the file has
5110** not yet been opened.
5111*/
5112sqlite3_file *sqlite3PagerFile(Pager *pPager){
5113 return pPager->fd;
5114}
5115
5116/*
danielk19775865e3d2004-06-14 06:03:57 +00005117** Return the directory of the database file.
5118*/
danielk19773b8a05f2007-03-19 17:44:26 +00005119const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005120 return pPager->zDirectory;
5121}
5122
5123/*
5124** Return the full pathname of the journal file.
5125*/
danielk19773b8a05f2007-03-19 17:44:26 +00005126const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005127 return pPager->zJournal;
5128}
5129
5130/*
drh2c8997b2005-08-27 16:36:48 +00005131** Return true if fsync() calls are disabled for this pager. Return FALSE
5132** if fsync()s are executed normally.
5133*/
danielk19773b8a05f2007-03-19 17:44:26 +00005134int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00005135 return pPager->noSync;
5136}
5137
drh7c4ac0c2007-04-05 11:25:58 +00005138#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00005139/*
drhb20ea9d2004-02-09 01:20:36 +00005140** Set the codec for this pager
5141*/
danielk19773b8a05f2007-03-19 17:44:26 +00005142void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00005143 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00005144 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00005145 void *pCodecArg
5146){
5147 pPager->xCodec = xCodec;
5148 pPager->pCodecArg = pCodecArg;
5149}
drh7c4ac0c2007-04-05 11:25:58 +00005150#endif
drhb20ea9d2004-02-09 01:20:36 +00005151
danielk1977687566d2004-11-02 12:56:41 +00005152#ifndef SQLITE_OMIT_AUTOVACUUM
5153/*
danielk197787c29a92008-01-18 11:33:16 +00005154** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00005155**
drh5e385312007-06-16 04:42:12 +00005156** There must be no references to the page previously located at
5157** pgno (which we call pPgOld) though that page is allowed to be
5158** in cache. If the page previous located at pgno is not already
5159** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00005160**
drh5e385312007-06-16 04:42:12 +00005161** References to the page pPg remain valid. Updating any
5162** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00005163** allocated along with the page) is the responsibility of the caller.
5164**
danielk19775fd057a2005-03-09 13:09:43 +00005165** A transaction must be active when this routine is called. It used to be
5166** required that a statement transaction was not active, but this restriction
5167** has been removed (CREATE INDEX needs to move a page when a statement
5168** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00005169*/
danielk19773b8a05f2007-03-19 17:44:26 +00005170int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00005171 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00005172 int h;
danielk197794daf7f2004-11-08 09:26:09 +00005173 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00005174
drh86f8c192007-08-22 00:39:19 +00005175 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005176 assert( pPg->nRef>0 );
5177
drh4f0c5872007-03-26 22:05:01 +00005178 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00005179 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00005180 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00005181
danielk1977b4626a32007-04-28 15:47:43 +00005182 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00005183 if( pPg->needSync ){
5184 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00005185 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00005186 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00005187 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00005188 }
5189
drh85b623f2007-12-13 21:54:09 +00005190 /* Unlink pPg from its hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00005191 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00005192
danielk1977ef73ee92004-11-06 12:26:07 +00005193 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00005194 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00005195 ** page pgno before the 'move' operation, it needs to be retained
5196 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00005197 */
drh5e385312007-06-16 04:42:12 +00005198 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00005199 pPgOld = pager_lookup(pPager, pgno);
5200 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00005201 assert( pPgOld->nRef==0 );
5202 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00005203 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00005204 pPg->needSync = pPgOld->needSync;
5205 }else{
5206 pPg->needSync = 0;
5207 }
drhf5e7bb52008-02-18 14:47:33 +00005208 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
danielk1977687566d2004-11-02 12:56:41 +00005209
danielk1977f5fdda82004-11-03 08:44:05 +00005210 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00005211 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00005212 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00005213 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00005214 if( pPager->aHash[h] ){
5215 assert( pPager->aHash[h]->pPrevHash==0 );
5216 pPager->aHash[h]->pPrevHash = pPg;
5217 }
5218 pPg->pNextHash = pPager->aHash[h];
5219 pPager->aHash[h] = pPg;
5220 pPg->pPrevHash = 0;
5221
drh605ad8f2006-05-03 23:34:05 +00005222 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00005223 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00005224 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00005225
danielk197794daf7f2004-11-08 09:26:09 +00005226 if( needSyncPgno ){
5227 /* If needSyncPgno is non-zero, then the journal file needs to be
5228 ** sync()ed before any data is written to database file page needSyncPgno.
5229 ** Currently, no such page exists in the page-cache and the
drhf5e7bb52008-02-18 14:47:33 +00005230 ** Pager.pInJournal bit has been set. This needs to be remedied by loading
danielk197794daf7f2004-11-08 09:26:09 +00005231 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00005232 **
danielk1977a98d7b42008-01-18 13:42:54 +00005233 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00005234 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00005235 ** array. Otherwise, if the page is loaded and written again in
5236 ** this transaction, it may be written to the database file before
5237 ** it is synced into the journal file. This way, it may end up in
5238 ** the journal file twice, but that is not a problem.
5239 **
danielk19773b8a05f2007-03-19 17:44:26 +00005240 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00005241 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00005242 */
5243 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005244 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00005245 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00005246 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00005247 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00005248 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
5249 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00005250 }
danielk197787c29a92008-01-18 11:33:16 +00005251 pagerLeave(pPager);
5252 return rc;
5253 }
danielk1977ae825582004-11-23 09:06:55 +00005254 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00005255 pPgHdr->needSync = 1;
5256 pPgHdr->inJournal = 1;
5257 makeDirty(pPgHdr);
5258 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005259 }
5260
drh86f8c192007-08-22 00:39:19 +00005261 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005262 return SQLITE_OK;
5263}
5264#endif
5265
danielk19773b8a05f2007-03-19 17:44:26 +00005266/*
5267** Return a pointer to the data for the specified page.
5268*/
5269void *sqlite3PagerGetData(DbPage *pPg){
5270 return PGHDR_TO_DATA(pPg);
5271}
5272
5273/*
5274** Return a pointer to the Pager.nExtra bytes of "extra" space
5275** allocated along with the specified page.
5276*/
5277void *sqlite3PagerGetExtra(DbPage *pPg){
5278 Pager *pPager = pPg->pPager;
5279 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
5280}
5281
danielk197741483462007-03-24 16:45:04 +00005282/*
5283** Get/set the locking-mode for this pager. Parameter eMode must be one
5284** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
5285** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
5286** the locking-mode is set to the value specified.
5287**
5288** The returned value is either PAGER_LOCKINGMODE_NORMAL or
5289** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
5290** locking-mode.
5291*/
5292int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00005293 assert( eMode==PAGER_LOCKINGMODE_QUERY
5294 || eMode==PAGER_LOCKINGMODE_NORMAL
5295 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
5296 assert( PAGER_LOCKINGMODE_QUERY<0 );
5297 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
5298 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00005299 pPager->exclusiveMode = eMode;
5300 }
5301 return (int)pPager->exclusiveMode;
5302}
5303
drh3b020132008-04-17 17:02:01 +00005304/*
5305** Get/set the journal-mode for this pager. Parameter eMode must be one
5306** of PAGER_JOURNALMODE_QUERY, PAGER_JOURNALMODE_DELETE or
5307** PAGER_JOURNALMODE_PERSIST. If the parameter is not _QUERY, then
5308** the journal-mode is set to the value specified.
5309**
5310** The returned value is either PAGER_JOURNALMODE_DELETE or
5311** PAGER_JOURNALMODE_PERSIST, indicating the current (possibly updated)
5312** journal-mode.
5313*/
5314int sqlite3PagerJournalMode(Pager *pPager, int eMode){
5315 assert( eMode==PAGER_JOURNALMODE_QUERY
5316 || eMode==PAGER_JOURNALMODE_DELETE
drhfdc40e92008-04-17 20:59:37 +00005317 || eMode==PAGER_JOURNALMODE_PERSIST
5318 || eMode==PAGER_JOURNALMODE_OFF );
drh3b020132008-04-17 17:02:01 +00005319 assert( PAGER_JOURNALMODE_QUERY<0 );
5320 assert( PAGER_JOURNALMODE_DELETE>=0 && PAGER_JOURNALMODE_PERSIST>=0 );
drhfdc40e92008-04-17 20:59:37 +00005321 if( eMode>=0 ){
5322 pPager->journalMode = eMode;
drh3b020132008-04-17 17:02:01 +00005323 }
drhfdc40e92008-04-17 20:59:37 +00005324 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00005325}
5326
danielk1977b53e4962008-06-04 06:45:59 +00005327/*
5328** Get/set the size-limit used for persistent journal files.
5329*/
5330i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
5331 if( iLimit>=-1 ){
5332 pPager->journalSizeLimit = iLimit;
5333 }
5334 return pPager->journalSizeLimit;
5335}
5336
drhd919fe12007-12-11 19:34:44 +00005337#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00005338/*
5339** Print a listing of all referenced pages and their ref count.
5340*/
danielk19773b8a05f2007-03-19 17:44:26 +00005341void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00005342 PgHdr *pPg;
5343 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
5344 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00005345 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
5346 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00005347 }
5348}
5349#endif
drh2e66f0b2005-04-28 17:18:48 +00005350
5351#endif /* SQLITE_OMIT_DISKIO */