blob: 75f069de6b292b3f7eced72c98e7a4f0f083c4c5 [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**
danielk197793f7af92008-05-09 16:57:50 +000021** @(#) $Id: pager.c,v 1.444 2008/05/09 16:57:51 danielk1977 Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drh2e66f0b2005-04-28 17:18:48 +000023#ifndef SQLITE_OMIT_DISKIO
drhd9b02572001-04-15 00:37:09 +000024#include "sqliteInt.h"
drhed7c8552001-04-11 14:29:21 +000025#include <assert.h>
drhd9b02572001-04-15 00:37:09 +000026#include <string.h>
drhed7c8552001-04-11 14:29:21 +000027
28/*
drhdb48ee02003-01-16 13:42:43 +000029** Macros for troubleshooting. Normally turned off
30*/
danielk1977466be562004-06-10 02:16:01 +000031#if 0
drhd3627af2006-12-18 18:34:51 +000032#define sqlite3DebugPrintf printf
drh4f0c5872007-03-26 22:05:01 +000033#define PAGERTRACE1(X) sqlite3DebugPrintf(X)
34#define PAGERTRACE2(X,Y) sqlite3DebugPrintf(X,Y)
35#define PAGERTRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
36#define PAGERTRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
37#define PAGERTRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000038#else
drh4f0c5872007-03-26 22:05:01 +000039#define PAGERTRACE1(X)
40#define PAGERTRACE2(X,Y)
41#define PAGERTRACE3(X,Y,Z)
42#define PAGERTRACE4(X,Y,Z,W)
43#define PAGERTRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000044#endif
45
danielk1977599fcba2004-11-08 07:13:13 +000046/*
drh4f0c5872007-03-26 22:05:01 +000047** The following two macros are used within the PAGERTRACEX() macros above
drhd86959f2005-11-26 03:51:18 +000048** to print out file-descriptors.
danielk1977599fcba2004-11-08 07:13:13 +000049**
drh85b623f2007-12-13 21:54:09 +000050** PAGERID() takes a pointer to a Pager struct as its argument. The
danielk197762079062007-08-15 17:08:46 +000051** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
drh85b623f2007-12-13 21:54:09 +000052** struct as its argument.
danielk1977599fcba2004-11-08 07:13:13 +000053*/
drhc001c582006-03-06 18:23:16 +000054#define PAGERID(p) ((int)(p->fd))
55#define FILEHANDLEID(fd) ((int)fd)
drhdb48ee02003-01-16 13:42:43 +000056
57/*
drhed7c8552001-04-11 14:29:21 +000058** The page cache as a whole is always in one of the following
59** states:
60**
drha6abd042004-06-09 17:37:22 +000061** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000062** writing the database file. There is no
63** data held in memory. This is the initial
64** state.
65**
drha6abd042004-06-09 17:37:22 +000066** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000067** Writing is not permitted. There can be
68** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000069** file at the same time.
drhed7c8552001-04-11 14:29:21 +000070**
drh726de592004-06-10 23:35:50 +000071** PAGER_RESERVED This process has reserved the database for writing
72** but has not yet made any changes. Only one process
73** at a time can reserve the database. The original
74** database file has not been modified so other
75** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000076** database file.
77**
78** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000079** Access is exclusive. No other processes or
80** threads can be reading or writing while one
81** process is writing.
82**
danielk1977aa5ccdf2004-06-14 05:10:42 +000083** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
84** after all dirty pages have been written to the
85** database file and the file has been synced to
drh369339d2007-03-30 16:01:55 +000086** disk. All that remains to do is to remove or
87** truncate the journal file and the transaction
88** will be committed.
danielk1977aa5ccdf2004-06-14 05:10:42 +000089**
drha6abd042004-06-09 17:37:22 +000090** The page cache comes up in PAGER_UNLOCK. The first time a
danielk19773b8a05f2007-03-19 17:44:26 +000091** sqlite3PagerGet() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000092** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000093** the state transitions back to PAGER_UNLOCK. The first time
danielk19773b8a05f2007-03-19 17:44:26 +000094** that sqlite3PagerWrite() is called, the state transitions to
drh369339d2007-03-30 16:01:55 +000095** PAGER_RESERVED. (Note that sqlite3PagerWrite() can only be
drh306dc212001-05-21 13:45:10 +000096** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000097** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh369339d2007-03-30 16:01:55 +000098** PAGER_RESERVED means that there is an open rollback journal.
99** The transition to PAGER_EXCLUSIVE occurs before any changes
100** are made to the database file, though writes to the rollback
101** journal occurs with just PAGER_RESERVED. After an sqlite3PagerRollback()
102** or sqlite3PagerCommitPhaseTwo(), the state can go back to PAGER_SHARED,
103** or it can stay at PAGER_EXCLUSIVE if we are in exclusive access mode.
drhed7c8552001-04-11 14:29:21 +0000104*/
drha6abd042004-06-09 17:37:22 +0000105#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000106#define PAGER_SHARED 1 /* same as SHARED_LOCK */
107#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
108#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
109#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000110
drh684917c2004-10-05 02:41:42 +0000111/*
112** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
113** then failed attempts to get a reserved lock will invoke the busy callback.
114** This is off by default. To see why, consider the following scenario:
115**
116** Suppose thread A already has a shared lock and wants a reserved lock.
117** Thread B already has a reserved lock and wants an exclusive lock. If
118** both threads are using their busy callbacks, it might be a long time
119** be for one of the threads give up and allows the other to proceed.
120** But if the thread trying to get the reserved lock gives up quickly
121** (if it never invokes its busy callback) then the contention will be
122** resolved quickly.
123*/
124#ifndef SQLITE_BUSY_RESERVED_LOCK
125# define SQLITE_BUSY_RESERVED_LOCK 0
126#endif
drhd9b02572001-04-15 00:37:09 +0000127
drhed7c8552001-04-11 14:29:21 +0000128/*
drh887dc4c2004-10-22 16:22:57 +0000129** This macro rounds values up so that if the value is an address it
130** is guaranteed to be an address that is aligned to an 8-byte boundary.
131*/
132#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
133
danielk19779f61c2f2007-08-27 17:27:49 +0000134typedef struct PgHdr PgHdr;
danielk197784f786f2007-08-28 08:00:17 +0000135
136/*
137** Each pager stores all currently unreferenced pages in a list sorted
138** in least-recently-used (LRU) order (i.e. the first item on the list has
139** not been referenced in a long time, the last item has been recently
140** used). An instance of this structure is included as part of each
141** pager structure for this purpose (variable Pager.lru).
142**
143** Additionally, if memory-management is enabled, all unreferenced pages
144** are stored in a global LRU list (global variable sqlite3LruPageList).
145**
146** In both cases, the PagerLruList.pFirstSynced variable points to
147** the first page in the corresponding list that does not require an
drh85b623f2007-12-13 21:54:09 +0000148** fsync() operation before its memory can be reclaimed. If no such
danielk197784f786f2007-08-28 08:00:17 +0000149** page exists, PagerLruList.pFirstSynced is set to NULL.
150*/
151typedef struct PagerLruList PagerLruList;
152struct PagerLruList {
153 PgHdr *pFirst; /* First page in LRU list */
154 PgHdr *pLast; /* Last page in LRU list (the most recently used) */
155 PgHdr *pFirstSynced; /* First page in list with PgHdr.needSync==0 */
156};
157
158/*
159** The following structure contains the next and previous pointers used
160** to link a PgHdr structure into a PagerLruList linked list.
161*/
danielk19779f61c2f2007-08-27 17:27:49 +0000162typedef struct PagerLruLink PagerLruLink;
163struct PagerLruLink {
164 PgHdr *pNext;
165 PgHdr *pPrev;
166};
167
drh887dc4c2004-10-22 16:22:57 +0000168/*
drhed7c8552001-04-11 14:29:21 +0000169** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000170** This header is only visible to this pager module. The client
171** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000172**
danielk19773b8a05f2007-03-19 17:44:26 +0000173** Client code should call sqlite3PagerWrite() on a page prior to making
174** any modifications to that page. The first time sqlite3PagerWrite()
drhf6038712004-02-08 18:07:34 +0000175** is called, the original page contents are written into the rollback
176** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
177** the journal page has made it onto the disk surface, PgHdr.needSync
178** is cleared. The modified page cannot be written back into the original
179** database file until the journal pages has been synced to disk and the
180** PgHdr.needSync has been cleared.
181**
danielk19773b8a05f2007-03-19 17:44:26 +0000182** The PgHdr.dirty flag is set when sqlite3PagerWrite() is called and
drhf6038712004-02-08 18:07:34 +0000183** is cleared again when the page content is written back to the original
184** database file.
drh732c8172007-06-16 11:17:45 +0000185**
186** Details of important structure elements:
187**
188** needSync
189**
190** If this is true, this means that it is not safe to write the page
191** content to the database because the original content needed
192** for rollback has not by synced to the main rollback journal.
193** The original content may have been written to the rollback journal
194** but it has not yet been synced. So we cannot write to the database
195** file because power failure might cause the page in the journal file
196** to never reach the disk. It is as if the write to the journal file
197** does not occur until the journal file is synced.
198**
199** This flag is false if the page content exactly matches what
200** currently exists in the database file. The needSync flag is also
201** false if the original content has been written to the main rollback
202** journal and synced. If the page represents a new page that has
203** been added onto the end of the database during the current
204** transaction, the needSync flag is true until the original database
205** size in the journal header has been synced to disk.
206**
207** inJournal
208**
209** This is true if the original page has been written into the main
210** rollback journal. This is always false for new pages added to
211** the end of the database file during the current transaction.
212** And this flag says nothing about whether or not the journal
213** has been synced to disk. For pages that are in the original
214** database file, the following expression should always be true:
215**
drhf5e7bb52008-02-18 14:47:33 +0000216** inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno)
drh732c8172007-06-16 11:17:45 +0000217**
drhf5e7bb52008-02-18 14:47:33 +0000218** The pPager->pInJournal object is only valid for the original
drh732c8172007-06-16 11:17:45 +0000219** pages of the database, not new pages that are added to the end
220** of the database, so obviously the above expression cannot be
221** valid for new pages. For new pages inJournal is always 0.
222**
223** dirty
224**
225** When true, this means that the content of the page has been
226** modified and needs to be written back to the database file.
227** If false, it means that either the content of the page is
228** unchanged or else the content is unimportant and we do not
229** care whether or not it is preserved.
230**
231** alwaysRollback
232**
233** This means that the sqlite3PagerDontRollback() API should be
234** ignored for this page. The DontRollback() API attempts to say
235** that the content of the page on disk is unimportant (it is an
236** unused page on the freelist) so that it is unnecessary to
237** rollback changes to this page because the content of the page
238** can change without changing the meaning of the database. This
239** flag overrides any DontRollback() attempt. This flag is set
240** when a page that originally contained valid data is added to
241** the freelist. Later in the same transaction, this page might
242** be pulled from the freelist and reused for something different
243** and at that point the DontRollback() API will be called because
244** pages taken from the freelist do not need to be protected by
245** the rollback journal. But this flag says that the page was
246** not originally part of the freelist so that it still needs to
247** be rolled back in spite of any subsequent DontRollback() calls.
248**
249** needRead
250**
251** This flag means (when true) that the content of the page has
252** not yet been loaded from disk. The in-memory content is just
253** garbage. (Actually, we zero the content, but you should not
254** make any assumptions about the content nevertheless.) If the
255** content is needed in the future, it should be read from the
256** original database file.
drhed7c8552001-04-11 14:29:21 +0000257*/
258struct PgHdr {
259 Pager *pPager; /* The pager to which this page belongs */
260 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000261 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
danielk19779f61c2f2007-08-27 17:27:49 +0000262 PagerLruLink free; /* Next and previous free pages */
drhac69b052004-05-12 13:30:07 +0000263 PgHdr *pNextAll; /* A list of all pages */
drh193a6b42002-07-07 16:52:46 +0000264 u8 inJournal; /* TRUE if has been written to journal */
drh193a6b42002-07-07 16:52:46 +0000265 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000266 u8 needSync; /* Sync journal before writing this page */
drh80e35f42007-03-30 14:06:34 +0000267 u8 alwaysRollback; /* Disable DontRollback() for this page */
drh538f5702007-04-13 02:14:30 +0000268 u8 needRead; /* Read content if PagerWrite() is called */
drhac69b052004-05-12 13:30:07 +0000269 short int nRef; /* Number of users of this page */
drhdc3e10b2006-06-15 14:31:06 +0000270 PgHdr *pDirty, *pPrevDirty; /* Dirty pages */
danielk19779f61c2f2007-08-27 17:27:49 +0000271#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
272 PagerLruLink gfree; /* Global list of nRef==0 pages */
273#endif
danielk19773c407372005-02-15 02:54:14 +0000274#ifdef SQLITE_CHECK_PAGES
275 u32 pageHash;
276#endif
drhbf4bca52007-09-06 22:19:14 +0000277 void *pData; /* Page data */
278 /* Pager.nExtra bytes of local data appended to this header */
drhed7c8552001-04-11 14:29:21 +0000279};
280
drhac69b052004-05-12 13:30:07 +0000281/*
282** For an in-memory only database, some extra information is recorded about
283** each page so that changes can be rolled back. (Journal files are not
284** used for in-memory databases.) The following information is added to
285** the end of every EXTRA block for in-memory databases.
286**
287** This information could have been added directly to the PgHdr structure.
288** But then it would take up an extra 8 bytes of storage on every PgHdr
289** even for disk-based databases. Splitting it out saves 8 bytes. This
290** is only a savings of 0.8% but those percentages add up.
291*/
292typedef struct PgHistory PgHistory;
293struct PgHistory {
294 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
295 u8 *pStmt; /* Text as it was at the beginning of the current statement */
danielk1977f35843b2007-04-07 15:03:17 +0000296 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
297 u8 inStmt; /* TRUE if in the statement subjournal */
drhac69b052004-05-12 13:30:07 +0000298};
drh9eb9e262004-02-11 02:18:05 +0000299
300/*
301** A macro used for invoking the codec if there is one
302*/
303#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000304# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
305# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000306#else
drhc001c582006-03-06 18:23:16 +0000307# define CODEC1(P,D,N,X) /* NO-OP */
308# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000309#endif
310
drhed7c8552001-04-11 14:29:21 +0000311/*
drh69688d52001-04-14 16:38:23 +0000312** Convert a pointer to a PgHdr into a pointer to its data
313** and back again.
drhed7c8552001-04-11 14:29:21 +0000314*/
drhbf4bca52007-09-06 22:19:14 +0000315#define PGHDR_TO_DATA(P) ((P)->pData)
316#define PGHDR_TO_EXTRA(G,P) ((void*)&((G)[1]))
drhac69b052004-05-12 13:30:07 +0000317#define PGHDR_TO_HIST(P,PGR) \
drhbf4bca52007-09-06 22:19:14 +0000318 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000319
320/*
drhed7c8552001-04-11 14:29:21 +0000321** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000322**
drh4f0ee682007-03-30 20:43:40 +0000323** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000324** or SQLITE_FULL. Once one of the first three errors occurs, it persists
325** and is returned as the result of every major pager API call. The
326** SQLITE_FULL return code is slightly different. It persists only until the
327** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000328** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000329** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000330*/
331struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000332 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000333 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000334 u8 journalStarted; /* True if header of journal is synced */
335 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000336 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000337 u8 stmtOpen; /* True if the statement subjournal is open */
338 u8 stmtInUse; /* True we are in a statement subtransaction */
339 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000340 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000341 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000342 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000343 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000344 u8 tempFile; /* zFilename is a temporary file */
345 u8 readOnly; /* True for a read-only database */
346 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000347 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000348 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000349 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000350 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000351 u8 doNotSync; /* Boolean. While true, do not spill the cache */
352 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
drhfdc40e92008-04-17 20:59:37 +0000353 u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */
drh80e35f42007-03-30 14:06:34 +0000354 u8 changeCountDone; /* Set after incrementing the change-counter */
drh33f4e022007-09-03 15:19:34 +0000355 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000356 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000357 int dbSize; /* Number of pages in the file */
358 int origDbSize; /* dbSize before the current change */
359 int stmtSize; /* Size of database (in pages) at stmt_begin() */
360 int nRec; /* Number of pages written to the journal */
361 u32 cksumInit; /* Quasi-random value added to every checksum */
362 int stmtNRec; /* Number of records in stmt subjournal */
363 int nExtra; /* Add this many bytes to each in-memory page */
364 int pageSize; /* Number of bytes in a page */
365 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000366 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
367 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000368 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000369 Bitvec *pInJournal; /* One bit for each page in the database file */
370 Bitvec *pInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000371 char *zFilename; /* Name of the database file */
372 char *zJournal; /* Name of the journal file */
373 char *zDirectory; /* Directory hold database and journal files */
drh334b2992007-09-06 23:28:23 +0000374 char *zStmtJrnl; /* Name of the statement journal file */
danielk197762079062007-08-15 17:08:46 +0000375 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
376 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000377 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
danielk19779f61c2f2007-08-27 17:27:49 +0000378 PagerLruList lru; /* LRU list of free pages */
drhd9b02572001-04-15 00:37:09 +0000379 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000380 PgHdr *pStmt; /* List of pages in the statement subjournal */
drh605ad8f2006-05-03 23:34:05 +0000381 PgHdr *pDirty; /* List of all dirty pages */
drheb206252004-10-01 02:00:31 +0000382 i64 journalOff; /* Current byte offset in the journal file */
383 i64 journalHdr; /* Byte offset to previous journal header */
384 i64 stmtHdrOff; /* First journal header written this statement */
385 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000386 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000387 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000388#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000389 int nHit, nMiss; /* Cache hits and missing */
390 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000391#endif
danielk19773b8a05f2007-03-19 17:44:26 +0000392 void (*xDestructor)(DbPage*,int); /* Call this routine when freeing pages */
393 void (*xReiniter)(DbPage*,int); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000394#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000395 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000396 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000397#endif
drh8ca0c722006-05-07 17:49:38 +0000398 int nHash; /* Size of the pager hash table */
399 PgHdr **aHash; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000400#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +0000401 Pager *pNext; /* Doubly linked list of pagers on which */
402 Pager *pPrev; /* sqlite3_release_memory() will work */
403 int iInUseMM; /* Non-zero if unavailable to MM */
404 int iInUseDB; /* Non-zero if in sqlite3_release_memory() */
danielk197713f72992005-12-18 08:51:22 +0000405#endif
danielk19778186df82007-03-06 13:45:59 +0000406 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000407 char dbFileVers[16]; /* Changes whenever database file changes */
drhd9b02572001-04-15 00:37:09 +0000408};
409
410/*
drh538f5702007-04-13 02:14:30 +0000411** The following global variables hold counters used for
412** testing purposes only. These variables do not exist in
413** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000414*/
415#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000416int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
417int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
418int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
419int sqlite3_pager_pgfree_count = 0; /* Number of cache pages freed */
420# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000421#else
drh538f5702007-04-13 02:14:30 +0000422# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000423#endif
424
drh86f8c192007-08-22 00:39:19 +0000425/*
426** The following variable points to the head of a double-linked list
427** of all pagers that are eligible for page stealing by the
428** sqlite3_release_memory() interface. Access to this list is
429** protected by the SQLITE_MUTEX_STATIC_MEM2 mutex.
430*/
431#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
432static Pager *sqlite3PagerList = 0;
danielk19779f61c2f2007-08-27 17:27:49 +0000433static PagerLruList sqlite3LruPageList = {0, 0, 0};
drh86f8c192007-08-22 00:39:19 +0000434#endif
drh538f5702007-04-13 02:14:30 +0000435
436
drhfcd35c72005-05-21 02:48:08 +0000437/*
drh5e00f6c2001-09-13 13:46:56 +0000438** Journal files begin with the following magic string. The data
439** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000440**
drhae2b40c2004-06-09 19:03:54 +0000441** Since version 2.8.0, the journal format contains additional sanity
442** checking information. If the power fails while the journal is begin
443** written, semi-random garbage data might appear in the journal
444** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000445** to roll the journal back, the database could be corrupted. The additional
446** sanity checking data is an attempt to discover the garbage in the
447** journal and ignore it.
448**
drhae2b40c2004-06-09 19:03:54 +0000449** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000450** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000451** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000452** This cksum is initialized to a 32-bit random value that appears in the
453** journal file right after the header. The random initializer is important,
454** because garbage data that appears at the end of a journal is likely
455** data that was once in other files that have now been deleted. If the
456** garbage data came from an obsolete journal file, the checksums might
457** be correct. But by initializing the checksum to random value which
458** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000459*/
drhae2b40c2004-06-09 19:03:54 +0000460static const unsigned char aJournalMagic[] = {
461 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000462};
463
464/*
drh726de592004-06-10 23:35:50 +0000465** The size of the header and of each page in the journal is determined
466** by the following macros.
drh968af522003-02-11 14:55:40 +0000467*/
drhae2b40c2004-06-09 19:03:54 +0000468#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000469
danielk197776572402004-06-25 02:38:54 +0000470/*
471** The journal header size for this pager. In the future, this could be
472** set to some value read from the disk controller. The important
473** characteristic is that it is the same size as a disk sector.
474*/
475#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
476
drhb7f91642004-10-31 02:22:47 +0000477/*
478** The macro MEMDB is true if we are dealing with an in-memory database.
479** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
480** the value of MEMDB will be a constant and the compiler will optimize
481** out code that would never execute.
482*/
483#ifdef SQLITE_OMIT_MEMORYDB
484# define MEMDB 0
485#else
486# define MEMDB pPager->memDb
487#endif
488
489/*
danielk197776572402004-06-25 02:38:54 +0000490** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
491** reserved for working around a windows/posix incompatibility). It is
492** used in the journal to signify that the remainder of the journal file
493** is devoted to storing a master journal name - there are no more pages to
494** roll back. See comments for function writeMasterJournal() for details.
495*/
danielk1977599fcba2004-11-08 07:13:13 +0000496/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
497#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000498
drh968af522003-02-11 14:55:40 +0000499/*
danielk197726836652005-01-17 01:33:13 +0000500** The maximum legal page number is (2^31 - 1).
501*/
502#define PAGER_MAX_PGNO 2147483647
503
504/*
drh86f8c192007-08-22 00:39:19 +0000505** The pagerEnter() and pagerLeave() routines acquire and release
506** a mutex on each pager. The mutex is recursive.
507**
508** This is a special-purpose mutex. It only provides mutual exclusion
509** between the Btree and the Memory Management sqlite3_release_memory()
510** function. It does not prevent, for example, two Btrees from accessing
511** the same pager at the same time. Other general-purpose mutexes in
512** the btree layer handle that chore.
513*/
514#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
515 static void pagerEnter(Pager *p){
516 p->iInUseDB++;
517 if( p->iInUseMM && p->iInUseDB==1 ){
drh26e4a8b2008-05-01 17:16:52 +0000518#ifndef SQLITE_MUTEX_NOOP
drh64e2bb72008-05-07 12:29:55 +0000519 sqlite3_mutex *mutex;
drh86f8c192007-08-22 00:39:19 +0000520 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +0000521#endif
drh86f8c192007-08-22 00:39:19 +0000522 p->iInUseDB = 0;
523 sqlite3_mutex_enter(mutex);
524 p->iInUseDB = 1;
525 sqlite3_mutex_leave(mutex);
526 }
527 assert( p->iInUseMM==0 );
528 }
529 static void pagerLeave(Pager *p){
530 p->iInUseDB--;
531 assert( p->iInUseDB>=0 );
532 }
533#else
534# define pagerEnter(X)
535# define pagerLeave(X)
536#endif
537
538/*
danielk197784f786f2007-08-28 08:00:17 +0000539** Add page pPg to the end of the linked list managed by structure
540** pList (pPg becomes the last entry in the list - the most recently
541** used). Argument pLink should point to either pPg->free or pPg->gfree,
542** depending on whether pPg is being added to the pager-specific or
543** global LRU list.
544*/
danielk19779f61c2f2007-08-27 17:27:49 +0000545static void listAdd(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
546 pLink->pNext = 0;
547 pLink->pPrev = pList->pLast;
548
danielk197784f786f2007-08-28 08:00:17 +0000549#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
550 assert(pLink==&pPg->free || pLink==&pPg->gfree);
551 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
552#endif
553
danielk19779f61c2f2007-08-27 17:27:49 +0000554 if( pList->pLast ){
555 int iOff = (char *)pLink - (char *)pPg;
556 PagerLruLink *pLastLink = (PagerLruLink *)(&((u8 *)pList->pLast)[iOff]);
557 pLastLink->pNext = pPg;
558 }else{
559 assert(!pList->pFirst);
560 pList->pFirst = pPg;
561 }
562
563 pList->pLast = pPg;
564 if( !pList->pFirstSynced && pPg->needSync==0 ){
565 pList->pFirstSynced = pPg;
566 }
567}
568
danielk197784f786f2007-08-28 08:00:17 +0000569/*
570** Remove pPg from the list managed by the structure pointed to by pList.
571**
572** Argument pLink should point to either pPg->free or pPg->gfree, depending
573** on whether pPg is being added to the pager-specific or global LRU list.
574*/
danielk19779f61c2f2007-08-27 17:27:49 +0000575static void listRemove(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
576 int iOff = (char *)pLink - (char *)pPg;
577
danielk197784f786f2007-08-28 08:00:17 +0000578#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
579 assert(pLink==&pPg->free || pLink==&pPg->gfree);
580 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
581#endif
582
danielk19779f61c2f2007-08-27 17:27:49 +0000583 if( pPg==pList->pFirst ){
584 pList->pFirst = pLink->pNext;
585 }
586 if( pPg==pList->pLast ){
587 pList->pLast = pLink->pPrev;
588 }
589 if( pLink->pPrev ){
590 PagerLruLink *pPrevLink = (PagerLruLink *)(&((u8 *)pLink->pPrev)[iOff]);
591 pPrevLink->pNext = pLink->pNext;
592 }
593 if( pLink->pNext ){
594 PagerLruLink *pNextLink = (PagerLruLink *)(&((u8 *)pLink->pNext)[iOff]);
595 pNextLink->pPrev = pLink->pPrev;
596 }
597 if( pPg==pList->pFirstSynced ){
598 PgHdr *p = pLink->pNext;
599 while( p && p->needSync ){
600 PagerLruLink *pL = (PagerLruLink *)(&((u8 *)p)[iOff]);
601 p = pL->pNext;
602 }
603 pList->pFirstSynced = p;
604 }
605
606 pLink->pNext = pLink->pPrev = 0;
607}
608
609/*
danielk197784f786f2007-08-28 08:00:17 +0000610** Add page pPg to the list of free pages for the pager. If
611** memory-management is enabled, also add the page to the global
612** list of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000613*/
614static void lruListAdd(PgHdr *pPg){
615 listAdd(&pPg->pPager->lru, &pPg->free, pPg);
616#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
617 if( !pPg->pPager->memDb ){
618 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
619 listAdd(&sqlite3LruPageList, &pPg->gfree, pPg);
620 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
621 }
622#endif
623}
624
625/*
danielk197784f786f2007-08-28 08:00:17 +0000626** Remove page pPg from the list of free pages for the associated pager.
627** If memory-management is enabled, also remove pPg from the global list
628** of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000629*/
630static void lruListRemove(PgHdr *pPg){
631 listRemove(&pPg->pPager->lru, &pPg->free, pPg);
632#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
633 if( !pPg->pPager->memDb ){
634 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
635 listRemove(&sqlite3LruPageList, &pPg->gfree, pPg);
636 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
637 }
638#endif
639}
640
641/*
danielk197784f786f2007-08-28 08:00:17 +0000642** This function is called just after the needSync flag has been cleared
643** from all pages managed by pPager (usually because the journal file
644** has just been synced). It updates the pPager->lru.pFirstSynced variable
645** and, if memory-management is enabled, the sqlite3LruPageList.pFirstSynced
646** variable also.
danielk19779f61c2f2007-08-27 17:27:49 +0000647*/
648static void lruListSetFirstSynced(Pager *pPager){
649 pPager->lru.pFirstSynced = pPager->lru.pFirst;
650#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
651 if( !pPager->memDb ){
652 PgHdr *p;
653 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
654 for(p=sqlite3LruPageList.pFirst; p && p->needSync; p=p->gfree.pNext);
655 assert(p==pPager->lru.pFirstSynced || p==sqlite3LruPageList.pFirstSynced);
656 sqlite3LruPageList.pFirstSynced = p;
657 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
658 }
659#endif
660}
661
danielk1977f35843b2007-04-07 15:03:17 +0000662/*
663** Return true if page *pPg has already been written to the statement
664** journal (or statement snapshot has been created, if *pPg is part
665** of an in-memory database).
666*/
667static int pageInStatement(PgHdr *pPg){
668 Pager *pPager = pPg->pPager;
669 if( MEMDB ){
670 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
671 }else{
drhf5e7bb52008-02-18 14:47:33 +0000672 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000673 }
674}
drh8ca0c722006-05-07 17:49:38 +0000675
676/*
677** Change the size of the pager hash table to N. N must be a power
678** of two.
679*/
680static void pager_resize_hash_table(Pager *pPager, int N){
681 PgHdr **aHash, *pPg;
682 assert( N>0 && (N&(N-1))==0 );
drheee4c8c2008-02-18 22:24:57 +0000683#ifdef SQLITE_MALLOC_SOFT_LIMIT
684 if( N*sizeof(aHash[0])>SQLITE_MALLOC_SOFT_LIMIT ){
685 N = SQLITE_MALLOC_SOFT_LIMIT/sizeof(aHash[0]);
686 }
687 if( N==pPager->nHash ) return;
688#endif
drhed138fb2007-08-22 22:04:37 +0000689 pagerLeave(pPager);
drh643167f2008-01-22 21:30:53 +0000690 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, pPager->aHash!=0);
drh17435752007-08-16 04:30:38 +0000691 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drh643167f2008-01-22 21:30:53 +0000692 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, 0);
drhed138fb2007-08-22 22:04:37 +0000693 pagerEnter(pPager);
drh8ca0c722006-05-07 17:49:38 +0000694 if( aHash==0 ){
695 /* Failure to rehash is not an error. It is only a performance hit. */
696 return;
697 }
drh17435752007-08-16 04:30:38 +0000698 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000699 pPager->nHash = N;
700 pPager->aHash = aHash;
701 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000702 int h;
703 if( pPg->pgno==0 ){
704 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
705 continue;
706 }
707 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000708 pPg->pNextHash = aHash[h];
709 if( aHash[h] ){
710 aHash[h]->pPrevHash = pPg;
711 }
712 aHash[h] = pPg;
713 pPg->pPrevHash = 0;
714 }
715}
716
drhdd793422001-06-28 01:54:48 +0000717/*
drh34e79ce2004-02-08 06:05:46 +0000718** Read a 32-bit integer from the given file descriptor. Store the integer
719** that is read in *pRes. Return SQLITE_OK if everything worked, or an
720** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000721**
722** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000723*/
danielk197762079062007-08-15 17:08:46 +0000724static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000725 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000726 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000727 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000728 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000729 }
drh94f33312002-08-12 12:29:56 +0000730 return rc;
731}
732
733/*
drh97b57482006-01-10 20:32:32 +0000734** Write a 32-bit integer into a string buffer in big-endian byte order.
735*/
drha3152892007-05-05 11:48:52 +0000736#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000737
738/*
drh34e79ce2004-02-08 06:05:46 +0000739** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
740** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000741*/
danielk197762079062007-08-15 17:08:46 +0000742static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000743 char ac[4];
drh97b57482006-01-10 20:32:32 +0000744 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000745 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000746}
747
drh2554f8b2003-01-22 01:26:44 +0000748/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000749** If file pFd is open, call sqlite3OsUnlock() on it.
750*/
751static int osUnlock(sqlite3_file *pFd, int eLock){
752 if( !pFd->pMethods ){
753 return SQLITE_OK;
754 }
755 return sqlite3OsUnlock(pFd, eLock);
756}
757
758/*
danielk1977c7b60172007-08-22 11:22:03 +0000759** This function determines whether or not the atomic-write optimization
760** can be used with this pager. The optimization can be used if:
761**
762** (a) the value returned by OsDeviceCharacteristics() indicates that
763** a database page may be written atomically, and
764** (b) the value returned by OsSectorSize() is less than or equal
765** to the page size.
766**
767** If the optimization cannot be used, 0 is returned. If it can be used,
768** then the value returned is the size of the journal file when it
769** contains rollback data for exactly one page.
770*/
771#ifdef SQLITE_ENABLE_ATOMIC_WRITE
772static int jrnlBufferSize(Pager *pPager){
773 int dc; /* Device characteristics */
774 int nSector; /* Sector size */
775 int nPage; /* Page size */
776 sqlite3_file *fd = pPager->fd;
777
778 if( fd->pMethods ){
779 dc = sqlite3OsDeviceCharacteristics(fd);
780 nSector = sqlite3OsSectorSize(fd);
781 nPage = pPager->pageSize;
782 }
783
784 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
785 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
786
danielk1977f8940ae2007-08-23 11:07:10 +0000787 if( !fd->pMethods || (dc&(SQLITE_IOCAP_ATOMIC|(nPage>>8))&&nSector<=nPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000788 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
789 }
790 return 0;
791}
792#endif
793
794/*
danielk1977aef0bf62005-12-30 16:28:01 +0000795** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000796** code. The first argument is a pointer to the pager structure, the
797** second the error-code about to be returned by a pager API function.
798** The value returned is a copy of the second argument to this function.
799**
drh4f0ee682007-03-30 20:43:40 +0000800** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000801** the error becomes persistent. Until the persisten error is cleared,
802** subsequent API calls on this Pager will immediately return the same
803** error code.
804**
805** A persistent error indicates that the contents of the pager-cache
806** cannot be trusted. This state can be cleared by completely discarding
807** the contents of the pager-cache. If a transaction was active when
808** the persistent error occured, then the rollback journal may need
809** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000810*/
danielk1977ae72d982007-10-03 08:46:44 +0000811static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000812static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000813 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000814 assert(
815 pPager->errCode==SQLITE_FULL ||
816 pPager->errCode==SQLITE_OK ||
817 (pPager->errCode & 0xff)==SQLITE_IOERR
818 );
danielk1977979f38e2007-03-27 16:19:51 +0000819 if(
drh4ac285a2006-09-15 07:28:50 +0000820 rc2==SQLITE_FULL ||
821 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000822 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000823 ){
824 pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000825 if( pPager->state==PAGER_UNLOCK && pPager->nRef==0 ){
826 /* If the pager is already unlocked, call pager_unlock() now to
827 ** clear the error state and ensure that the pager-cache is
828 ** completely empty.
829 */
830 pager_unlock(pPager);
831 }
danielk1977aef0bf62005-12-30 16:28:01 +0000832 }
833 return rc;
834}
835
drh477731b2007-06-16 03:06:27 +0000836/*
837** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
838** on the cache using a hash function. This is used for testing
839** and debugging only.
840*/
danielk19773c407372005-02-15 02:54:14 +0000841#ifdef SQLITE_CHECK_PAGES
842/*
843** Return a 32-bit hash of the page data for pPage.
844*/
drh477731b2007-06-16 03:06:27 +0000845static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000846 u32 hash = 0;
847 int i;
drh477731b2007-06-16 03:06:27 +0000848 for(i=0; i<nByte; i++){
849 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000850 }
851 return hash;
852}
drh477731b2007-06-16 03:06:27 +0000853static u32 pager_pagehash(PgHdr *pPage){
854 return pager_datahash(pPage->pPager->pageSize,
855 (unsigned char *)PGHDR_TO_DATA(pPage));
856}
danielk19773c407372005-02-15 02:54:14 +0000857
858/*
859** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
860** is defined, and NDEBUG is not defined, an assert() statement checks
861** that the page is either dirty or still matches the calculated page-hash.
862*/
863#define CHECK_PAGE(x) checkPage(x)
864static void checkPage(PgHdr *pPg){
865 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000866 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000867 pPg->pageHash==pager_pagehash(pPg) );
868}
869
870#else
drh8ffa8172007-06-18 17:25:17 +0000871#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000872#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000873#define CHECK_PAGE(x)
874#endif
875
drhed7c8552001-04-11 14:29:21 +0000876/*
danielk197776572402004-06-25 02:38:54 +0000877** When this is called the journal file for pager pPager must be open.
878** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000879** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000880**
danielk197765839c62007-08-30 08:08:17 +0000881** zMaster must point to a buffer of at least nMaster bytes allocated by
882** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
883** enough space to write the master journal name). If the master journal
884** name in the journal is longer than nMaster bytes (including a
885** nul-terminator), then this is handled as if no master journal name
886** were present in the journal.
887**
888** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000889** SQLITE_OK returned.
890*/
danielk197765839c62007-08-30 08:08:17 +0000891static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000892 int rc;
893 u32 len;
drheb206252004-10-01 02:00:31 +0000894 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000895 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000896 int i;
danielk197776572402004-06-25 02:38:54 +0000897 unsigned char aMagic[8]; /* A buffer to hold the magic header */
898
danielk197765839c62007-08-30 08:08:17 +0000899 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000900
drh054889e2005-11-30 03:20:31 +0000901 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000902 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000903
danielk197762079062007-08-15 17:08:46 +0000904 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000905 if( rc!=SQLITE_OK ) return rc;
906
danielk197765839c62007-08-30 08:08:17 +0000907 if( len>=nMaster ){
908 return SQLITE_OK;
909 }
910
danielk197762079062007-08-15 17:08:46 +0000911 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000912 if( rc!=SQLITE_OK ) return rc;
913
danielk197762079062007-08-15 17:08:46 +0000914 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000915 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
916
danielk197765839c62007-08-30 08:08:17 +0000917 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000918 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000919 return rc;
920 }
danielk197765839c62007-08-30 08:08:17 +0000921 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000922
923 /* See if the checksum matches the master journal name */
924 for(i=0; i<len; i++){
danielk197765839c62007-08-30 08:08:17 +0000925 cksum -= zMaster[i];
926 }
danielk19778191bff2004-06-28 04:52:30 +0000927 if( cksum ){
928 /* If the checksum doesn't add up, then one or more of the disk sectors
929 ** containing the master journal filename is corrupted. This means
930 ** definitely roll back, so just return SQLITE_OK and report a (nul)
931 ** master-journal filename.
932 */
danielk197765839c62007-08-30 08:08:17 +0000933 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000934 }
danielk197776572402004-06-25 02:38:54 +0000935
936 return SQLITE_OK;
937}
938
939/*
940** Seek the journal file descriptor to the next sector boundary where a
941** journal header may be read or written. Pager.journalOff is updated with
942** the new seek offset.
943**
944** i.e for a sector size of 512:
945**
946** Input Offset Output Offset
947** ---------------------------------------
948** 0 0
949** 512 512
950** 100 512
951** 2000 2048
952**
953*/
danielk197762079062007-08-15 17:08:46 +0000954static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000955 i64 offset = 0;
956 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000957 if( c ){
958 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
959 }
960 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
961 assert( offset>=c );
962 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
963 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000964}
965
966/*
drhf3a87622008-04-17 14:16:42 +0000967** Write zeros over the header of the journal file. This has the
968** effect of invalidating the journal file and committing the
969** transaction.
970*/
danielk1977df2566a2008-05-07 19:11:03 +0000971static int zeroJournalHdr(Pager *pPager, int doTruncate){
972 int rc = SQLITE_OK;
drhf3a87622008-04-17 14:16:42 +0000973 static const char zeroHdr[28];
974
danielk1977df2566a2008-05-07 19:11:03 +0000975 if( pPager->journalOff ){
976 IOTRACE(("JZEROHDR %p\n", pPager))
977 if( doTruncate ){
978 rc = sqlite3OsTruncate(pPager->jfd, 0);
979 }else{
980 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
981 }
982 if( rc==SQLITE_OK ){
983 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
984 }
drha06ecba2008-04-22 17:15:17 +0000985 }
drhf3a87622008-04-17 14:16:42 +0000986 return rc;
987}
988
989/*
danielk197776572402004-06-25 02:38:54 +0000990** The journal file must be open when this routine is called. A journal
991** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
992** current location.
993**
994** The format for the journal header is as follows:
995** - 8 bytes: Magic identifying journal format.
996** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
997** - 4 bytes: Random number used for page hash.
998** - 4 bytes: Initial database page count.
999** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +00001000** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +00001001**
danielk197767c007b2008-03-20 04:45:49 +00001002** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +00001003*/
1004static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +00001005 int rc = SQLITE_OK;
1006 char *zHeader = pPager->pTmpSpace;
1007 int nHeader = pPager->pageSize;
1008 int nWrite;
1009
1010 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
1011 nHeader = JOURNAL_HDR_SZ(pPager);
1012 }
danielk197776572402004-06-25 02:38:54 +00001013
danielk19774099f6e2007-03-19 11:25:20 +00001014 if( pPager->stmtHdrOff==0 ){
1015 pPager->stmtHdrOff = pPager->journalOff;
1016 }
1017
danielk197762079062007-08-15 17:08:46 +00001018 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001019 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001020
drh97b57482006-01-10 20:32:32 +00001021 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +00001022
1023 /*
1024 ** Write the nRec Field - the number of page records that follow this
1025 ** journal header. Normally, zero is written to this value at this time.
1026 ** After the records are added to the journal (and the journal synced,
1027 ** if in full-sync mode), the zero is overwritten with the true number
1028 ** of records (see syncJournal()).
1029 **
1030 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
1031 ** reading the journal this value tells SQLite to assume that the
1032 ** rest of the journal file contains valid page records. This assumption
1033 ** is dangerous, as if a failure occured whilst writing to the journal
1034 ** file it may contain some garbage data. There are two scenarios
1035 ** where this risk can be ignored:
1036 **
1037 ** * When the pager is in no-sync mode. Corruption can follow a
1038 ** power failure in this case anyway.
1039 **
1040 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
1041 ** that garbage data is never appended to the journal file.
1042 */
1043 assert(pPager->fd->pMethods||pPager->noSync);
1044 if( (pPager->noSync)
1045 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
1046 ){
1047 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
1048 }else{
1049 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
1050 }
1051
drh97b57482006-01-10 20:32:32 +00001052 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +00001053 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +00001054 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
1055 /* The initial database size */
1056 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
1057 /* The assumed sector size for this process */
1058 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +00001059 if( pPager->journalHdr==0 ){
1060 /* The page size */
1061 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
1062 }
danielk197776572402004-06-25 02:38:54 +00001063
danielk1977a664f8e2008-04-22 14:31:48 +00001064 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
1065 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
1066 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
1067 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +00001068 }
danielk1977a664f8e2008-04-22 14:31:48 +00001069
danielk197776572402004-06-25 02:38:54 +00001070 return rc;
1071}
1072
1073/*
1074** The journal file must be open when this is called. A journal header file
1075** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
1076** file. See comments above function writeJournalHdr() for a description of
1077** the journal header format.
1078**
1079** If the header is read successfully, *nRec is set to the number of
1080** page records following this header and *dbSize is set to the size of the
1081** database before the transaction began, in pages. Also, pPager->cksumInit
1082** is set to the value read from the journal header. SQLITE_OK is returned
1083** in this case.
1084**
1085** If the journal header file appears to be corrupted, SQLITE_DONE is
1086** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
1087** cannot be read from the journal file an error code is returned.
1088*/
1089static int readJournalHdr(
1090 Pager *pPager,
drheb206252004-10-01 02:00:31 +00001091 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +00001092 u32 *pNRec,
1093 u32 *pDbSize
1094){
1095 int rc;
1096 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +00001097 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +00001098 int iPageSize;
danielk197776572402004-06-25 02:38:54 +00001099
danielk197762079062007-08-15 17:08:46 +00001100 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001101 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
1102 return SQLITE_DONE;
1103 }
danielk197762079062007-08-15 17:08:46 +00001104 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001105
danielk197762079062007-08-15 17:08:46 +00001106 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001107 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +00001108 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +00001109
1110 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
1111 return SQLITE_DONE;
1112 }
1113
danielk197762079062007-08-15 17:08:46 +00001114 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +00001115 if( rc ) return rc;
1116
danielk197762079062007-08-15 17:08:46 +00001117 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +00001118 if( rc ) return rc;
1119
danielk197762079062007-08-15 17:08:46 +00001120 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +00001121 if( rc ) return rc;
1122
danielk197767c007b2008-03-20 04:45:49 +00001123 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
1124 if( rc==SQLITE_OK
1125 && iPageSize>=512
1126 && iPageSize<=SQLITE_MAX_PAGE_SIZE
1127 && ((iPageSize-1)&iPageSize)==0
1128 ){
1129 u16 pagesize = iPageSize;
1130 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
1131 }
1132 if( rc ) return rc;
1133
danielk197776572402004-06-25 02:38:54 +00001134 /* Update the assumed sector-size to match the value used by
1135 ** the process that created this journal. If this journal was
1136 ** created by a process other than this one, then this routine
1137 ** is being called from within pager_playback(). The local value
1138 ** of Pager.sectorSize is restored at the end of that routine.
1139 */
danielk197762079062007-08-15 17:08:46 +00001140 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +00001141 if( rc ) return rc;
1142
1143 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +00001144 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +00001145}
1146
1147
1148/*
1149** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +00001150** pPager at the current location. The master journal name must be the last
1151** thing written to a journal file. If the pager is in full-sync mode, the
1152** journal file descriptor is advanced to the next sector boundary before
1153** anything is written. The format is:
1154**
1155** + 4 bytes: PAGER_MJ_PGNO.
1156** + N bytes: length of master journal name.
1157** + 4 bytes: N
1158** + 4 bytes: Master journal name checksum.
1159** + 8 bytes: aJournalMagic[].
1160**
1161** The master journal page checksum is the sum of the bytes in the master
1162** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +00001163**
1164** If zMaster is a NULL pointer (occurs for a single database transaction),
1165** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +00001166*/
1167static int writeMasterJournal(Pager *pPager, const char *zMaster){
1168 int rc;
1169 int len;
danielk1977cafadba2004-06-25 11:11:54 +00001170 int i;
danielk197762079062007-08-15 17:08:46 +00001171 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +00001172 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +00001173 u32 cksum = 0;
1174 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +00001175
1176 if( !zMaster || pPager->setMaster) return SQLITE_OK;
1177 pPager->setMaster = 1;
1178
1179 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +00001180 for(i=0; i<len; i++){
1181 cksum += zMaster[i];
1182 }
danielk197776572402004-06-25 02:38:54 +00001183
1184 /* If in full-sync mode, advance to the next disk sector before writing
1185 ** the master journal name. This is in case the previous page written to
1186 ** the journal has already been synced.
1187 */
1188 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +00001189 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001190 }
danielk197762079062007-08-15 17:08:46 +00001191 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +00001192 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +00001193
danielk197762079062007-08-15 17:08:46 +00001194 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +00001195 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001196 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +00001197
danielk197762079062007-08-15 17:08:46 +00001198 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001199 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001200 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +00001201
drh97b57482006-01-10 20:32:32 +00001202 put32bits(zBuf, len);
1203 put32bits(&zBuf[4], cksum);
1204 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +00001205 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +00001206 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +00001207 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +00001208
1209 /* If the pager is in peristent-journal mode, then the physical
1210 ** journal-file may extend past the end of the master-journal name
1211 ** and 8 bytes of magic data just written to the file. This is
1212 ** dangerous because the code to rollback a hot-journal file
1213 ** will not be able to find the master-journal name to determine
1214 ** whether or not the journal is hot.
1215 **
1216 ** Easiest thing to do in this scenario is to truncate the journal
1217 ** file to the required size.
1218 */
1219 if( (rc==SQLITE_OK)
1220 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
1221 && jrnlSize>jrnlOff
1222 ){
1223 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
1224 }
danielk197776572402004-06-25 02:38:54 +00001225 return rc;
1226}
1227
1228/*
drh03eb96a2002-11-10 23:32:56 +00001229** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +00001230** statement journal.
drh03eb96a2002-11-10 23:32:56 +00001231**
1232** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +00001233** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +00001234** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +00001235** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +00001236*/
drh3aac2dd2004-04-26 14:10:20 +00001237static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +00001238 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +00001239 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1240 assert( MEMDB );
1241 if( !pHist->inStmt ){
1242 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
1243 if( pPager->pStmt ){
1244 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
1245 }
1246 pHist->pNextStmt = pPager->pStmt;
1247 pPager->pStmt = pPg;
1248 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +00001249 }
drh03eb96a2002-11-10 23:32:56 +00001250}
1251
1252/*
drhed7c8552001-04-11 14:29:21 +00001253** Find a page in the hash table given its page number. Return
1254** a pointer to the page or NULL if not found.
1255*/
drhd9b02572001-04-15 00:37:09 +00001256static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +00001257 PgHdr *p;
1258 if( pPager->aHash==0 ) return 0;
1259 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +00001260 while( p && p->pgno!=pgno ){
1261 p = p->pNextHash;
1262 }
1263 return p;
1264}
1265
1266/*
danielk1977e180dd92007-04-05 17:15:52 +00001267** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +00001268** sets the state of the pager back to what it was when it was first
1269** opened. Any outstanding pages are invalidated and subsequent attempts
1270** to access those pages will likely result in a coredump.
1271*/
drhd9b02572001-04-15 00:37:09 +00001272static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00001273 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +00001274 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +00001275 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +00001276 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
1277 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +00001278 pNext = pPg->pNextAll;
danielk19779f61c2f2007-08-27 17:27:49 +00001279 lruListRemove(pPg);
drh0d180202008-02-14 23:26:56 +00001280 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00001281 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +00001282 }
danielk19779f61c2f2007-08-27 17:27:49 +00001283 assert(pPager->lru.pFirst==0);
1284 assert(pPager->lru.pFirstSynced==0);
1285 assert(pPager->lru.pLast==0);
danielk1977b94bf852007-03-19 13:53:37 +00001286 pPager->pStmt = 0;
drhd9b02572001-04-15 00:37:09 +00001287 pPager->pAll = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001288 pPager->pDirty = 0;
drh8ca0c722006-05-07 17:49:38 +00001289 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +00001290 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +00001291 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +00001292 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +00001293 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +00001294}
1295
1296/*
danielk1977ae72d982007-10-03 08:46:44 +00001297** Unlock the database file.
1298**
1299** If the pager is currently in error state, discard the contents of
1300** the cache and reset the Pager structure internal state. If there is
1301** an open journal-file, then the next time a shared-lock is obtained
1302** on the pager file (by this or any other process), it will be
1303** treated as a hot-journal and rolled back.
1304*/
1305static void pager_unlock(Pager *pPager){
1306 if( !pPager->exclusiveMode ){
1307 if( !MEMDB ){
drh1aa5af12008-03-07 19:51:14 +00001308 int rc = osUnlock(pPager->fd, NO_LOCK);
drh308aa322008-03-07 20:14:38 +00001309 if( rc ) pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +00001310 pPager->dbSize = -1;
1311 IOTRACE(("UNLOCK %p\n", pPager))
1312
drh16e45a42008-04-19 20:34:18 +00001313 /* Always close the journal file when dropping the database lock.
1314 ** Otherwise, another connection with journal_mode=delete might
1315 ** delete the file out from under us.
1316 */
1317 if( pPager->journalOpen ){
1318 sqlite3OsClose(pPager->jfd);
1319 pPager->journalOpen = 0;
1320 sqlite3BitvecDestroy(pPager->pInJournal);
1321 pPager->pInJournal = 0;
1322 }
1323
danielk1977ae72d982007-10-03 08:46:44 +00001324 /* If Pager.errCode is set, the contents of the pager cache cannot be
1325 ** trusted. Now that the pager file is unlocked, the contents of the
1326 ** cache can be discarded and the error code safely cleared.
1327 */
1328 if( pPager->errCode ){
drh1aa5af12008-03-07 19:51:14 +00001329 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00001330 pager_reset(pPager);
1331 if( pPager->stmtOpen ){
1332 sqlite3OsClose(pPager->stfd);
drhf5e7bb52008-02-18 14:47:33 +00001333 sqlite3BitvecDestroy(pPager->pInStmt);
1334 pPager->pInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001335 }
danielk1977ae72d982007-10-03 08:46:44 +00001336 pPager->stmtOpen = 0;
1337 pPager->stmtInUse = 0;
1338 pPager->journalOff = 0;
1339 pPager->journalStarted = 0;
1340 pPager->stmtAutoopen = 0;
1341 pPager->origDbSize = 0;
1342 }
1343 }
1344
1345 if( !MEMDB || pPager->errCode==SQLITE_OK ){
1346 pPager->state = PAGER_UNLOCK;
1347 pPager->changeCountDone = 0;
1348 }
1349 }
1350}
1351
1352/*
1353** Execute a rollback if a transaction is active and unlock the
1354** database file. If the pager has already entered the error state,
1355** do not attempt the rollback.
1356*/
1357static void pagerUnlockAndRollback(Pager *p){
drhfdc40e92008-04-17 20:59:37 +00001358 /* assert( p->state>=PAGER_RESERVED || p->journalOpen==0 ); */
danielk1977ae72d982007-10-03 08:46:44 +00001359 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
1360 sqlite3PagerRollback(p);
1361 }
1362 pager_unlock(p);
drhfdc40e92008-04-17 20:59:37 +00001363#if 0
danielk1977ae72d982007-10-03 08:46:44 +00001364 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
1365 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drhfdc40e92008-04-17 20:59:37 +00001366#endif
danielk1977ae72d982007-10-03 08:46:44 +00001367}
1368
1369/*
drh80e35f42007-03-30 14:06:34 +00001370** This routine ends a transaction. A transaction is ended by either
1371** a COMMIT or a ROLLBACK.
1372**
drhed7c8552001-04-11 14:29:21 +00001373** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001374** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1375** the database lock and acquires a SHARED lock in its place if that is
1376** the appropriate thing to do. Release locks usually is appropriate,
1377** unless we are in exclusive access mode or unless this is a
1378** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1379**
1380** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001381**
1382** TODO: Consider keeping the journal file open for temporary databases.
1383** This might give a performance improvement on windows where opening
1384** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001385*/
danielk1977df2566a2008-05-07 19:11:03 +00001386static int pager_end_transaction(Pager *pPager, int hasMaster){
drhd9b02572001-04-15 00:37:09 +00001387 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001388 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001389 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001390 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001391 if( pPager->state<PAGER_RESERVED ){
1392 return SQLITE_OK;
1393 }
danielk19773b8a05f2007-03-19 17:44:26 +00001394 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001395 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001396 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001397 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001398 }
drhda47d772002-12-02 04:25:19 +00001399 if( pPager->journalOpen ){
danielk197793f7af92008-05-09 16:57:50 +00001400 if( pPager->exclusiveMode
1401 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
1402 ){
1403 rc = zeroJournalHdr(pPager, hasMaster);
1404 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +00001405 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001406 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001407 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001408 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001409 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +00001410 if( rc==SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001411 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001412 }
danielk197741483462007-03-24 16:45:04 +00001413 }
drhf5e7bb52008-02-18 14:47:33 +00001414 sqlite3BitvecDestroy(pPager->pInJournal);
1415 pPager->pInJournal = 0;
drhda47d772002-12-02 04:25:19 +00001416 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1417 pPg->inJournal = 0;
1418 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001419 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001420 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001421#ifdef SQLITE_CHECK_PAGES
1422 pPg->pageHash = pager_pagehash(pPg);
1423#endif
drhda47d772002-12-02 04:25:19 +00001424 }
drh605ad8f2006-05-03 23:34:05 +00001425 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001426 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001427 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001428 }else{
drhf5e7bb52008-02-18 14:47:33 +00001429 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001430 }
danielk1977979f38e2007-03-27 16:19:51 +00001431
danielk197741483462007-03-24 16:45:04 +00001432 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001433 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001434 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001435 }else if( pPager->state==PAGER_SYNCED ){
1436 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001437 }
danielk1977334cdb62007-03-26 08:05:12 +00001438 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001439 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001440 pPager->needSync = 0;
danielk19779f61c2f2007-08-27 17:27:49 +00001441 lruListSetFirstSynced(pPager);
drh588f5bc2007-01-02 18:41:54 +00001442 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +00001443
1444 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001445}
1446
drhed7c8552001-04-11 14:29:21 +00001447/*
drh968af522003-02-11 14:55:40 +00001448** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001449**
1450** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001451** random initial value and the page number. We experimented with
1452** a checksum of the entire data, but that was found to be too slow.
1453**
1454** Note that the page number is stored at the beginning of data and
1455** the checksum is stored at the end. This is important. If journal
1456** corruption occurs due to a power failure, the most likely scenario
1457** is that one end or the other of the record will be changed. It is
1458** much less likely that the two ends of the journal record will be
1459** correct and the middle be corrupt. Thus, this "checksum" scheme,
1460** though fast and simple, catches the mostly likely kind of corruption.
1461**
1462** FIX ME: Consider adding every 200th (or so) byte of the data to the
1463** checksum. That way if a single page spans 3 or more disk sectors and
1464** only the middle sector is corrupt, we will still have a reasonable
1465** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001466*/
drh74161702006-02-24 02:53:49 +00001467static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001468 u32 cksum = pPager->cksumInit;
1469 int i = pPager->pageSize-200;
1470 while( i>0 ){
1471 cksum += aData[i];
1472 i -= 200;
1473 }
drh968af522003-02-11 14:55:40 +00001474 return cksum;
1475}
1476
drh605ad8f2006-05-03 23:34:05 +00001477/* Forward declaration */
1478static void makeClean(PgHdr*);
1479
drh968af522003-02-11 14:55:40 +00001480/*
drhfa86c412002-02-02 15:01:15 +00001481** Read a single page from the journal file opened on file descriptor
1482** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001483**
drh726de592004-06-10 23:35:50 +00001484** If useCksum==0 it means this journal does not use checksums. Checksums
1485** are not used in statement journals because statement journals do not
1486** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001487*/
danielk197762079062007-08-15 17:08:46 +00001488static int pager_playback_one_page(
1489 Pager *pPager,
1490 sqlite3_file *jfd,
1491 i64 offset,
1492 int useCksum
1493){
drhfa86c412002-02-02 15:01:15 +00001494 int rc;
drhae2b40c2004-06-09 19:03:54 +00001495 PgHdr *pPg; /* An existing page in the cache */
1496 Pgno pgno; /* The page number of a page in journal */
1497 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001498 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001499
drh96362842005-03-20 22:47:56 +00001500 /* useCksum should be true for the main journal and false for
1501 ** statement journals. Verify that this is always the case
1502 */
drh9cbe6352005-11-29 03:13:21 +00001503 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001504 assert( aData );
drh96362842005-03-20 22:47:56 +00001505
danielk197762079062007-08-15 17:08:46 +00001506 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001507 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001508 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001509 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001510 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001511
drh968af522003-02-11 14:55:40 +00001512 /* Sanity checking on the page. This is more important that I originally
1513 ** thought. If a power failure occurs while the journal is being written,
1514 ** it could cause invalid data to be written into the journal. We need to
1515 ** detect this invalid data (with high probability) and ignore it.
1516 */
danielk197775edc162004-06-26 01:48:18 +00001517 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001518 return SQLITE_DONE;
1519 }
drhae2b40c2004-06-09 19:03:54 +00001520 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001521 return SQLITE_OK;
1522 }
drhae2b40c2004-06-09 19:03:54 +00001523 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001524 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001525 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001526 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001527 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001528 return SQLITE_DONE;
1529 }
1530 }
drhfa86c412002-02-02 15:01:15 +00001531
danielk1977aa5ccdf2004-06-14 05:10:42 +00001532 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001533
1534 /* If the pager is in RESERVED state, then there must be a copy of this
1535 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001536 ** not the database file. The page is left marked dirty in this case.
1537 **
danielk19772df71c72007-05-24 07:22:42 +00001538 ** An exception to the above rule: If the database is in no-sync mode
1539 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001540 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1541 ** during a Movepage() call, then the page may not be in the cache
1542 ** either. So the condition described in the above paragraph is not
1543 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001544 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001545 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1546 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001547 **
1548 ** Ticket #1171: The statement journal might contain page content that is
1549 ** different from the page content at the start of the transaction.
1550 ** This occurs when a page is changed prior to the start of a statement
1551 ** then changed again within the statement. When rolling back such a
1552 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001553 ** for certain that original page contents are synced into the main rollback
1554 ** journal. Otherwise, a power loss might leave modified data in the
1555 ** database file without an entry in the rollback journal that can
1556 ** restore the database to its original form. Two conditions must be
1557 ** met before writing to the database files. (1) the database must be
1558 ** locked. (2) we know that the original page content is fully synced
1559 ** in the main journal either because the page is not in cache or else
1560 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001561 **
1562 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1563 ** is possible to fail a statement on a database that does not yet exist.
1564 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001565 */
drhae2b40c2004-06-09 19:03:54 +00001566 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001567 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1568 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh4c02a232008-04-14 23:13:45 +00001569 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0)
1570 && pPager->fd->pMethods ){
danielk197762079062007-08-15 17:08:46 +00001571 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1572 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001573 if( pPg ){
1574 makeClean(pPg);
1575 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001576 }
drhfa86c412002-02-02 15:01:15 +00001577 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001578 /* No page should ever be explicitly rolled back that is in use, except
1579 ** for page 1 which is held in use in order to keep the lock on the
1580 ** database active. However such a page may be rolled back as a result
1581 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001582 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001583 */
drhb6f41482004-05-14 01:58:11 +00001584 void *pData;
danielk197728129562005-01-11 10:25:06 +00001585 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001586 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001587 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001588 if( pPager->xReiniter ){
1589 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001590 }
danielk19773c407372005-02-15 02:54:14 +00001591#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001592 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001593#endif
drh86a88112007-04-16 15:02:19 +00001594 /* If this was page 1, then restore the value of Pager.dbFileVers.
1595 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001596 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001597 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001598 }
drh86a88112007-04-16 15:02:19 +00001599
1600 /* Decode the page just read from disk */
1601 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001602 }
1603 return rc;
1604}
1605
1606/*
danielk197713adf8a2004-06-03 16:08:41 +00001607** Parameter zMaster is the name of a master journal file. A single journal
1608** file that referred to the master journal file has just been rolled back.
1609** This routine checks if it is possible to delete the master journal file,
1610** and does so if it is.
drh726de592004-06-10 23:35:50 +00001611**
danielk197765839c62007-08-30 08:08:17 +00001612** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1613** available for use within this function.
1614**
1615**
drh726de592004-06-10 23:35:50 +00001616** The master journal file contains the names of all child journals.
1617** To tell if a master journal can be deleted, check to each of the
1618** children. If all children are either missing or do not refer to
1619** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001620*/
danielk1977b4b47412007-08-17 15:53:36 +00001621static int pager_delmaster(Pager *pPager, const char *zMaster){
1622 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001623 int rc;
1624 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001625 sqlite3_file *pMaster;
1626 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001627 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001628 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001629
1630 /* Open the master journal file exclusively in case some other process
1631 ** is running this routine also. Not that it makes too much difference.
1632 */
danielk1977b4b47412007-08-17 15:53:36 +00001633 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001634 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001635 if( !pMaster ){
1636 rc = SQLITE_NOMEM;
1637 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001638 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1639 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001640 }
danielk197713adf8a2004-06-03 16:08:41 +00001641 if( rc!=SQLITE_OK ) goto delmaster_out;
1642 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001643
1644 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001645 if( rc!=SQLITE_OK ) goto delmaster_out;
1646
1647 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001648 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001649 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001650 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001651
1652 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001653 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001654 */
danielk197765839c62007-08-30 08:08:17 +00001655 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001656 if( !zMasterJournal ){
1657 rc = SQLITE_NOMEM;
1658 goto delmaster_out;
1659 }
danielk197765839c62007-08-30 08:08:17 +00001660 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001661 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001662 if( rc!=SQLITE_OK ) goto delmaster_out;
1663
danielk19775865e3d2004-06-14 06:03:57 +00001664 zJournal = zMasterJournal;
1665 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh19db9352008-03-27 22:42:51 +00001666 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS);
1667 if( rc!=0 && rc!=1 ){
1668 rc = SQLITE_IOERR_NOMEM;
1669 goto delmaster_out;
1670 }
1671 if( rc==1 ){
danielk197713adf8a2004-06-03 16:08:41 +00001672 /* One of the journals pointed to by the master journal exists.
1673 ** Open it and check if it points at the master journal. If
1674 ** so, return without deleting the master journal file.
1675 */
drh3b7b78b2004-11-24 01:16:43 +00001676 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001677 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1678 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001679 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001680 goto delmaster_out;
1681 }
danielk197713adf8a2004-06-03 16:08:41 +00001682
danielk197765839c62007-08-30 08:08:17 +00001683 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001684 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001685 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001686 goto delmaster_out;
1687 }
danielk197776572402004-06-25 02:38:54 +00001688
danielk197765839c62007-08-30 08:08:17 +00001689 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001690 if( c ){
danielk197776572402004-06-25 02:38:54 +00001691 /* We have a match. Do not delete the master journal file. */
1692 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001693 }
1694 }
danielk19775865e3d2004-06-14 06:03:57 +00001695 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001696 }
1697 }
1698
danielk1977fee2d252007-08-18 10:59:19 +00001699 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001700
1701delmaster_out:
1702 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001703 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001704 }
1705 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001706 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001707 }
danielk1977b4b47412007-08-17 15:53:36 +00001708 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001709 return rc;
1710}
1711
drha6abd042004-06-09 17:37:22 +00001712
danielk1977e180dd92007-04-05 17:15:52 +00001713static void pager_truncate_cache(Pager *pPager);
1714
drha6abd042004-06-09 17:37:22 +00001715/*
drhcb4c40b2004-08-18 19:09:43 +00001716** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001717** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001718**
1719** Might might be the case that the file on disk is smaller than nPage.
1720** This can happen, for example, if we are in the middle of a transaction
1721** which has extended the file size and the new pages are still all held
1722** in cache, then an INSERT or UPDATE does a statement rollback. Some
1723** operating system implementations can get confused if you try to
1724** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001725** so detect this case and write a single zero byte to the end of the new
1726** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001727*/
1728static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001729 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001730 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001731 i64 currentSize, newSize;
1732 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1733 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001734 if( rc==SQLITE_OK && currentSize!=newSize ){
1735 if( currentSize>newSize ){
1736 rc = sqlite3OsTruncate(pPager->fd, newSize);
1737 }else{
1738 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1739 }
drh7fe3f7e2007-11-29 18:44:27 +00001740 }
danielk1977e180dd92007-04-05 17:15:52 +00001741 }
1742 if( rc==SQLITE_OK ){
1743 pPager->dbSize = nPage;
1744 pager_truncate_cache(pPager);
1745 }
1746 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001747}
1748
1749/*
drhc80f0582007-05-01 16:59:48 +00001750** Set the sectorSize for the given pager.
1751**
drh334c80d2008-03-28 17:41:13 +00001752** The sector size is at least as big as the sector size reported
1753** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001754*/
1755static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001756 assert(pPager->fd->pMethods||pPager->tempFile);
1757 if( !pPager->tempFile ){
1758 /* Sector size doesn't matter for temporary files. Also, the file
1759 ** may not have been opened yet, in whcih case the OsSectorSize()
1760 ** call will segfault.
1761 */
1762 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1763 }
drh334c80d2008-03-28 17:41:13 +00001764 if( pPager->sectorSize<512 ){
1765 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001766 }
1767}
1768
1769/*
drhed7c8552001-04-11 14:29:21 +00001770** Playback the journal and thus restore the database file to
1771** the state it was in before we started making changes.
1772**
drh34e79ce2004-02-08 06:05:46 +00001773** The journal file format is as follows:
1774**
drhae2b40c2004-06-09 19:03:54 +00001775** (1) 8 byte prefix. A copy of aJournalMagic[].
1776** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001777** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001778** number of page records from the journal size.
1779** (3) 4 byte big-endian integer which is the initial value for the
1780** sanity checksum.
1781** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001782** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001783** (5) 4 byte big-endian integer which is the sector size. The header
1784** is this many bytes in size.
1785** (6) 4 byte big-endian integer which is the page case.
1786** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001787** name. The value may be zero (indicate that there is no master
1788** journal.)
drh334c80d2008-03-28 17:41:13 +00001789** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001790** and might be shorter than the value read from (5). If the first byte
1791** of the name is \000 then there is no master journal. The master
1792** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001793** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001794** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001795** + pPager->pageSize bytes of data.
1796** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001797**
drh334c80d2008-03-28 17:41:13 +00001798** When we speak of the journal header, we mean the first 8 items above.
1799** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001800**
1801** Call the value from the second bullet "nRec". nRec is the number of
1802** valid page entries in the journal. In most cases, you can compute the
1803** value of nRec from the size of the journal file. But if a power
1804** failure occurred while the journal was being written, it could be the
1805** case that the size of the journal file had already been increased but
1806** the extra entries had not yet made it safely to disk. In such a case,
1807** the value of nRec computed from the file size would be too large. For
1808** that reason, we always use the nRec value in the header.
1809**
1810** If the nRec value is 0xffffffff it means that nRec should be computed
1811** from the file size. This value is used when the user selects the
1812** no-sync option for the journal. A power failure could lead to corruption
1813** in this case. But for things like temporary table (which will be
1814** deleted when the power is restored) we don't care.
1815**
drhd9b02572001-04-15 00:37:09 +00001816** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001817** journal file then all pages up to the first corrupted page are rolled
1818** back (or no pages if the journal header is corrupted). The journal file
1819** is then deleted and SQLITE_OK returned, just as if no corruption had
1820** been encountered.
1821**
1822** If an I/O or malloc() error occurs, the journal-file is not deleted
1823** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001824*/
danielk1977e277be02007-03-23 18:12:06 +00001825static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001826 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001827 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001828 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001829 int i; /* Loop counter */
1830 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001831 int rc; /* Result code of a subroutine */
danielk1977ce98bba2008-04-03 10:13:01 +00001832 int res = 0; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001833 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001834
drhc3a64ba2001-11-22 00:01:27 +00001835 /* Figure out how many records are in the journal. Abort early if
1836 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001837 */
drh8cfbf082001-09-19 13:22:39 +00001838 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001839 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001840 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001841 goto end_playback;
1842 }
drh240c5792004-02-08 00:40:52 +00001843
danielk197776572402004-06-25 02:38:54 +00001844 /* Read the master journal name from the journal, if it is present.
1845 ** If a master journal file name is specified, but the file is not
1846 ** present on disk, then the journal is not hot and does not need to be
1847 ** played back.
drh240c5792004-02-08 00:40:52 +00001848 */
danielk197765839c62007-08-30 08:08:17 +00001849 zMaster = pPager->pTmpSpace;
1850 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977ce98bba2008-04-03 10:13:01 +00001851 if( rc!=SQLITE_OK || (zMaster[0]
1852 && (res=sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS))==0 )
danielk1977b4b47412007-08-17 15:53:36 +00001853 ){
danielk197776572402004-06-25 02:38:54 +00001854 zMaster = 0;
drhc3a64ba2001-11-22 00:01:27 +00001855 goto end_playback;
1856 }
danielk197765839c62007-08-30 08:08:17 +00001857 zMaster = 0;
danielk1977ce98bba2008-04-03 10:13:01 +00001858 if( res<0 ){
1859 rc = SQLITE_IOERR_NOMEM;
1860 goto end_playback;
1861 }
1862 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001863
danielk197776572402004-06-25 02:38:54 +00001864 /* This loop terminates either when the readJournalHdr() call returns
1865 ** SQLITE_DONE or an IO error occurs. */
1866 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001867
danielk197776572402004-06-25 02:38:54 +00001868 /* Read the next journal header from the journal file. If there are
1869 ** not enough bytes left in the journal file for a complete header, or
1870 ** it is corrupted, then a process must of failed while writing it.
1871 ** This indicates nothing more needs to be rolled back.
1872 */
1873 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1874 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001875 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001876 rc = SQLITE_OK;
1877 }
danielk197776572402004-06-25 02:38:54 +00001878 goto end_playback;
1879 }
1880
1881 /* If nRec is 0xffffffff, then this journal was created by a process
1882 ** working in no-sync mode. This means that the rest of the journal
1883 ** file consists of pages, there are no more journal headers. Compute
1884 ** the value of nRec based on this assumption.
1885 */
1886 if( nRec==0xffffffff ){
1887 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1888 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1889 }
1890
danielk1977e277be02007-03-23 18:12:06 +00001891 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001892 ** process and if this is the final header in the journal, then it means
1893 ** that this part of the journal was being filled but has not yet been
1894 ** synced to disk. Compute the number of pages based on the remaining
1895 ** size of the file.
1896 **
1897 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001898 */
drh8940f4e2007-08-11 00:26:20 +00001899 if( nRec==0 && !isHot &&
1900 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001901 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1902 }
1903
danielk197776572402004-06-25 02:38:54 +00001904 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001905 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001906 */
danielk1977e180dd92007-04-05 17:15:52 +00001907 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001908 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001909 if( rc!=SQLITE_OK ){
1910 goto end_playback;
1911 }
danielk197776572402004-06-25 02:38:54 +00001912 }
1913
danielk197776572402004-06-25 02:38:54 +00001914 /* Copy original pages out of the journal and back into the database file.
1915 */
1916 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001917 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001918 if( rc!=SQLITE_OK ){
1919 if( rc==SQLITE_DONE ){
1920 rc = SQLITE_OK;
1921 pPager->journalOff = szJ;
1922 break;
1923 }else{
1924 goto end_playback;
1925 }
1926 }
drh968af522003-02-11 14:55:40 +00001927 }
drhed7c8552001-04-11 14:29:21 +00001928 }
drh580eeaf2006-02-24 03:09:37 +00001929 /*NOTREACHED*/
1930 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001931
1932end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001933 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001934 zMaster = pPager->pTmpSpace;
1935 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1936 }
1937 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001938 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001939 }
danielk197765839c62007-08-30 08:08:17 +00001940 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001941 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001942 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001943 */
danielk197765839c62007-08-30 08:08:17 +00001944 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001945 }
danielk197776572402004-06-25 02:38:54 +00001946
1947 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001948 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001949 ** value. Reset it to the correct value for this process.
1950 */
drhc80f0582007-05-01 16:59:48 +00001951 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001952 return rc;
drhed7c8552001-04-11 14:29:21 +00001953}
1954
1955/*
drhac69b052004-05-12 13:30:07 +00001956** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001957**
1958** This is similar to playing back the transaction journal but with
1959** a few extra twists.
1960**
drh663fc632002-02-02 18:49:19 +00001961** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001962** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001963** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001964**
drhac69b052004-05-12 13:30:07 +00001965** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001966** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001967** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001968*/
drh3aac2dd2004-04-26 14:10:20 +00001969static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001970 i64 szJ; /* Size of the full journal */
1971 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001972 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001973 int i; /* Loop counter */
1974 int rc;
1975
danielk197776572402004-06-25 02:38:54 +00001976 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001977
danielk19774099f6e2007-03-19 11:25:20 +00001978 /* Set hdrOff to be the offset just after the end of the last journal
1979 ** page written before the first journal-header for this statement
1980 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001981 ** header was written.
1982 */
1983 hdrOff = pPager->stmtHdrOff;
1984 assert( pPager->fullSync || !hdrOff );
1985 if( !hdrOff ){
1986 hdrOff = szJ;
1987 }
1988
drhfa86c412002-02-02 15:01:15 +00001989 /* Truncate the database back to its original size.
1990 */
danielk1977e180dd92007-04-05 17:15:52 +00001991 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001992 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001993
drhac69b052004-05-12 13:30:07 +00001994 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001995 */
drhac69b052004-05-12 13:30:07 +00001996 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001997 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001998
drhac69b052004-05-12 13:30:07 +00001999 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00002000 ** database file. Note that the statement journal omits checksums from
2001 ** each record since power-failure recovery is not important to statement
2002 ** journals.
drhfa86c412002-02-02 15:01:15 +00002003 */
danielk197762079062007-08-15 17:08:46 +00002004 for(i=0; i<nRec; i++){
2005 i64 offset = i*(4+pPager->pageSize);
2006 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00002007 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00002008 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00002009 }
2010
danielk197776572402004-06-25 02:38:54 +00002011 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
2012 ** was the size of the journal file when this statement was started, so
2013 ** everything after that needs to be rolled back, either into the
2014 ** database, the memory cache, or both.
2015 **
2016 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
2017 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00002018 */
danielk197776572402004-06-25 02:38:54 +00002019 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00002020 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00002021 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00002022 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00002023 assert( rc!=SQLITE_DONE );
2024 if( rc!=SQLITE_OK ) goto end_stmt_playback;
2025 }
2026
2027 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00002028 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00002029 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00002030 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00002031 if( rc!=SQLITE_OK ){
2032 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00002033 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00002034 }
danielk1977f0113002006-01-24 12:09:17 +00002035 if( nJRec==0 ){
2036 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00002037 }
danielk1977f0113002006-01-24 12:09:17 +00002038 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00002039 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00002040 assert( rc!=SQLITE_DONE );
2041 if( rc!=SQLITE_OK ) goto end_stmt_playback;
2042 }
drhfa86c412002-02-02 15:01:15 +00002043 }
danielk197776572402004-06-25 02:38:54 +00002044
2045 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00002046
drh3aac2dd2004-04-26 14:10:20 +00002047end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00002048 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00002049 pPager->journalOff = szJ;
2050 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00002051 }
2052 return rc;
2053}
2054
2055/*
drhf57b14a2001-09-14 18:54:08 +00002056** Change the maximum number of in-memory pages that are allowed.
2057*/
danielk19773b8a05f2007-03-19 17:44:26 +00002058void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00002059 if( mxPage>10 ){
2060 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00002061 }else{
2062 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00002063 }
2064}
2065
2066/*
drh973b6e32003-02-12 14:09:42 +00002067** Adjust the robustness of the database to damage due to OS crashes
2068** or power failures by changing the number of syncs()s when writing
2069** the rollback journal. There are three levels:
2070**
drh054889e2005-11-30 03:20:31 +00002071** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00002072** for temporary and transient files.
2073**
2074** NORMAL The journal is synced once before writes begin on the
2075** database. This is normally adequate protection, but
2076** it is theoretically possible, though very unlikely,
2077** that an inopertune power failure could leave the journal
2078** in a state which would cause damage to the database
2079** when it is rolled back.
2080**
2081** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00002082** database (with some additional information - the nRec field
2083** of the journal header - being written in between the two
2084** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00002085** single disk sector is atomic, then this mode provides
2086** assurance that the journal will not be corrupted to the
2087** point of causing damage to the database during rollback.
2088**
2089** Numeric values associated with these states are OFF==1, NORMAL=2,
2090** and FULL=3.
2091*/
danielk197793758c82005-01-21 08:13:14 +00002092#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00002093void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00002094 pPager->noSync = level==1 || pPager->tempFile;
2095 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00002096 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00002097 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00002098}
danielk197793758c82005-01-21 08:13:14 +00002099#endif
drh973b6e32003-02-12 14:09:42 +00002100
2101/*
drhaf6df112005-06-07 02:12:30 +00002102** The following global variable is incremented whenever the library
2103** attempts to open a temporary file. This information is used for
2104** testing and analysis only.
2105*/
drh0f7eb612006-08-08 13:51:43 +00002106#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002107int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00002108#endif
drhaf6df112005-06-07 02:12:30 +00002109
2110/*
drh3f56e6e2007-03-15 01:16:47 +00002111** Open a temporary file.
2112**
2113** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00002114** other error code if we fail. The OS will automatically delete the temporary
2115** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00002116*/
danielk1977b4b47412007-08-17 15:53:36 +00002117static int sqlite3PagerOpentemp(
drh33f4e022007-09-03 15:19:34 +00002118 sqlite3_vfs *pVfs, /* The virtual file system layer */
2119 sqlite3_file *pFile, /* Write the file descriptor here */
2120 char *zFilename, /* Name of the file. Might be NULL */
2121 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00002122){
drhfa86c412002-02-02 15:01:15 +00002123 int rc;
drh334b2992007-09-06 23:28:23 +00002124 assert( zFilename!=0 );
drh3f56e6e2007-03-15 01:16:47 +00002125
drh0f7eb612006-08-08 13:51:43 +00002126#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002127 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00002128#endif
danielk1977b4b47412007-08-17 15:53:36 +00002129
drh33f4e022007-09-03 15:19:34 +00002130 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
2131 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
2132 rc = sqlite3OsOpen(pVfs, zFilename, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00002133 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00002134 return rc;
2135}
2136
2137/*
drhed7c8552001-04-11 14:29:21 +00002138** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00002139** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00002140** the first call to sqlite3PagerGet() and is only held open until the
2141** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00002142**
drh6446c4d2001-12-15 14:22:18 +00002143** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00002144** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00002145** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00002146**
2147** If zFilename is ":memory:" then all information is held in cache.
2148** It is never written to disk. This can be used to implement an
2149** in-memory database.
drhed7c8552001-04-11 14:29:21 +00002150*/
danielk19773b8a05f2007-03-19 17:44:26 +00002151int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00002152 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00002153 Pager **ppPager, /* Return the Pager structure here */
2154 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00002155 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00002156 int flags, /* flags controlling this file */
2157 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00002158){
danielk1977b4b47412007-08-17 15:53:36 +00002159 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00002160 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00002161 int rc = SQLITE_OK;
2162 int i;
danielk19778def5ea2004-06-16 10:39:52 +00002163 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00002164 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00002165 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00002166 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
2167 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00002168 int journalFileSize = sqlite3JournalSize(pVfs);
drh1cc8c442007-08-24 16:08:29 +00002169 int nDefaultPage = SQLITE_DEFAULT_PAGE_SIZE;
2170 char *zPathname;
2171 int nPathname;
drh99b90c32008-03-17 13:50:58 +00002172 char *zStmtJrnl;
2173 int nStmtJrnl;
danielk1977b4b47412007-08-17 15:53:36 +00002174
drh86f8c192007-08-22 00:39:19 +00002175 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00002176 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002177
drh1cc8c442007-08-24 16:08:29 +00002178 /* Compute the full pathname */
danielk1977adfb9b02007-09-17 07:02:56 +00002179 nPathname = pVfs->mxPathname+1;
drh99b90c32008-03-17 13:50:58 +00002180 zPathname = sqlite3_malloc(nPathname*2);
drh1cc8c442007-08-24 16:08:29 +00002181 if( zPathname==0 ){
2182 return SQLITE_NOMEM;
2183 }
2184 if( zFilename && zFilename[0] ){
2185#ifndef SQLITE_OMIT_MEMORYDB
2186 if( strcmp(zFilename,":memory:")==0 ){
2187 memDb = 1;
2188 zPathname[0] = 0;
2189 }else
2190#endif
2191 {
danielk1977adfb9b02007-09-17 07:02:56 +00002192 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00002193 }
2194 }else{
danielk1977adfb9b02007-09-17 07:02:56 +00002195 rc = sqlite3OsGetTempname(pVfs, nPathname, zPathname);
drhae28c012007-08-24 16:29:23 +00002196 }
2197 if( rc!=SQLITE_OK ){
2198 sqlite3_free(zPathname);
2199 return rc;
drh1cc8c442007-08-24 16:08:29 +00002200 }
2201 nPathname = strlen(zPathname);
2202
drh99b90c32008-03-17 13:50:58 +00002203 /* Put the statement journal in temporary disk space since this is
2204 ** sometimes RAM disk or other optimized storage. Unlikely the main
2205 ** main journal file, the statement journal does not need to be
2206 ** colocated with the database nor does it need to be persistent.
2207 */
2208 zStmtJrnl = &zPathname[nPathname+1];
2209 rc = sqlite3OsGetTempname(pVfs, pVfs->mxPathname+1, zStmtJrnl);
2210 if( rc!=SQLITE_OK ){
2211 sqlite3_free(zPathname);
2212 return rc;
2213 }
2214 nStmtJrnl = strlen(zStmtJrnl);
2215
danielk1977b4b47412007-08-17 15:53:36 +00002216 /* Allocate memory for the pager structure */
2217 pPager = sqlite3MallocZero(
2218 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00002219 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00002220 pVfs->szOsFile * 3 + /* The main db and two journal files */
drh99b90c32008-03-17 13:50:58 +00002221 3*nPathname + 40 + /* zFilename, zDirectory, zJournal */
2222 nStmtJrnl /* zStmtJrnl */
danielk1977b4b47412007-08-17 15:53:36 +00002223 );
2224 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00002225 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002226 return SQLITE_NOMEM;
2227 }
2228 pPtr = (u8 *)&pPager[1];
drh33f4e022007-09-03 15:19:34 +00002229 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00002230 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00002231 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
2232 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
2233 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00002234 pPager->zDirectory = &pPager->zFilename[nPathname+1];
2235 pPager->zJournal = &pPager->zDirectory[nPathname+1];
drh334b2992007-09-06 23:28:23 +00002236 pPager->zStmtJrnl = &pPager->zJournal[nPathname+10];
danielk1977b4b47412007-08-17 15:53:36 +00002237 pPager->pVfs = pVfs;
drh1cc8c442007-08-24 16:08:29 +00002238 memcpy(pPager->zFilename, zPathname, nPathname+1);
drh99b90c32008-03-17 13:50:58 +00002239 memcpy(pPager->zStmtJrnl, zStmtJrnl, nStmtJrnl+1);
drh1cc8c442007-08-24 16:08:29 +00002240 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002241
drh153c62c2007-08-24 03:51:33 +00002242 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00002243 */
drhae28c012007-08-24 16:29:23 +00002244 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00002245 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
2246 rc = SQLITE_CANTOPEN;
2247 }else{
drh1cc8c442007-08-24 16:08:29 +00002248 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00002249 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
2250 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00002251 readOnly = (fout&SQLITE_OPEN_READONLY);
2252
2253 /* If the file was successfully opened for read/write access,
2254 ** choose a default page size in case we have to create the
2255 ** database file. The default page size is the maximum of:
2256 **
2257 ** + SQLITE_DEFAULT_PAGE_SIZE,
2258 ** + The value returned by sqlite3OsSectorSize()
2259 ** + The largest page size that can be written atomically.
2260 */
2261 if( rc==SQLITE_OK && !readOnly ){
2262 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
2263 if( nDefaultPage<iSectorSize ){
2264 nDefaultPage = iSectorSize;
2265 }
danielk19779663b8f2007-08-24 11:52:28 +00002266#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00002267 {
2268 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
2269 int ii;
2270 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
2271 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
2272 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
2273 for(ii=nDefaultPage; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
2274 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) nDefaultPage = ii;
danielk19779663b8f2007-08-24 11:52:28 +00002275 }
danielk1977b4b47412007-08-17 15:53:36 +00002276 }
drh1cc8c442007-08-24 16:08:29 +00002277#endif
2278 if( nDefaultPage>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
2279 nDefaultPage = SQLITE_MAX_DEFAULT_PAGE_SIZE;
2280 }
danielk19778def5ea2004-06-16 10:39:52 +00002281 }
drhac69b052004-05-12 13:30:07 +00002282 }
drh1cc8c442007-08-24 16:08:29 +00002283 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002284 /* If a temporary file is requested, it is not opened immediately.
2285 ** In this case we accept the default page size and delay actually
2286 ** opening the file until the first call to OsWrite().
2287 */
danielk19777a2b1ee2007-08-21 14:27:01 +00002288 tempFile = 1;
2289 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00002290 }
danielk1977aef0bf62005-12-30 16:28:01 +00002291
danielk1977b4b47412007-08-17 15:53:36 +00002292 if( pPager && rc==SQLITE_OK ){
drhbf8a4342008-04-29 15:38:58 +00002293 pPager->pTmpSpace = sqlite3MallocZero(nDefaultPage);
drh3e7a6092002-12-07 21:45:14 +00002294 }
danielk1977aef0bf62005-12-30 16:28:01 +00002295
drh153c62c2007-08-24 03:51:33 +00002296 /* If an error occured in either of the blocks above.
2297 ** Free the Pager structure and close the file.
2298 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00002299 ** any Pager.errMask variables.
2300 */
danielk1977b4b47412007-08-17 15:53:36 +00002301 if( !pPager || !pPager->pTmpSpace ){
2302 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00002303 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00002304 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00002305 }
danielk1977aef0bf62005-12-30 16:28:01 +00002306
drh153c62c2007-08-24 03:51:33 +00002307 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
2308 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00002309
danielk1977b4b47412007-08-17 15:53:36 +00002310 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00002311 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00002312 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00002313 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002314
drh99b90c32008-03-17 13:50:58 +00002315 /* Fill in Pager.zJournal[] */
drh1cc8c442007-08-24 16:08:29 +00002316 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
2317 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
danielk1977b4b47412007-08-17 15:53:36 +00002318
drh3b59a5c2006-01-15 20:28:28 +00002319 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00002320 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00002321 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002322 /* pPager->stmtOpen = 0; */
2323 /* pPager->stmtInUse = 0; */
2324 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00002325 pPager->dbSize = memDb-1;
danielk19779663b8f2007-08-24 11:52:28 +00002326 pPager->pageSize = nDefaultPage;
drh3b59a5c2006-01-15 20:28:28 +00002327 /* pPager->stmtSize = 0; */
2328 /* pPager->stmtJSize = 0; */
2329 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002330 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002331 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002332 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002333 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002334 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00002335 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00002336 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2337 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2338 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
2339 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00002340 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00002341 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002342 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00002343 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00002344 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00002345 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002346 /* pPager->pFirst = 0; */
2347 /* pPager->pFirstSynced = 0; */
2348 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00002349 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk19777a2b1ee2007-08-21 14:27:01 +00002350 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00002351 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00002352 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00002353 }
drh3b59a5c2006-01-15 20:28:28 +00002354 /* pPager->pBusyHandler = 0; */
2355 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002356 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00002357#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002358 pPager->iInUseMM = 0;
2359 pPager->iInUseDB = 0;
2360 if( !memDb ){
drh26e4a8b2008-05-01 17:16:52 +00002361#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +00002362 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00002363#endif
drh86f8c192007-08-22 00:39:19 +00002364 sqlite3_mutex_enter(mutex);
2365 pPager->pNext = sqlite3PagerList;
2366 if( sqlite3PagerList ){
2367 assert( sqlite3PagerList->pPrev==0 );
2368 sqlite3PagerList->pPrev = pPager;
2369 }
2370 pPager->pPrev = 0;
2371 sqlite3PagerList = pPager;
2372 sqlite3_mutex_leave(mutex);
2373 }
danielk197752622822006-01-09 09:59:49 +00002374#endif
drhed7c8552001-04-11 14:29:21 +00002375 return SQLITE_OK;
2376}
2377
2378/*
drh90f5ecb2004-07-22 01:19:35 +00002379** Set the busy handler function.
2380*/
danielk19773b8a05f2007-03-19 17:44:26 +00002381void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002382 pPager->pBusyHandler = pBusyHandler;
2383}
2384
2385/*
drh72f82862001-05-24 21:06:34 +00002386** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002387** when the reference count on each page reaches zero. The destructor can
2388** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002389**
danielk19773b8a05f2007-03-19 17:44:26 +00002390** The destructor is not called as a result sqlite3PagerClose().
2391** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002392*/
danielk19773b8a05f2007-03-19 17:44:26 +00002393void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002394 pPager->xDestructor = xDesc;
2395}
2396
2397/*
drha6abd042004-06-09 17:37:22 +00002398** Set the reinitializer for this pager. If not NULL, the reinitializer
2399** is called when the content of a page in cache is restored to its original
2400** value as a result of a rollback. The callback gives higher-level code
2401** an opportunity to restore the EXTRA section to agree with the restored
2402** page data.
2403*/
danielk19773b8a05f2007-03-19 17:44:26 +00002404void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002405 pPager->xReiniter = xReinit;
2406}
2407
2408/*
danielk1977a1644fd2007-08-29 12:31:25 +00002409** Set the page size to *pPageSize. If the suggest new page size is
2410** inappropriate, then an alternative page size is set to that
2411** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002412*/
danielk1977a1644fd2007-08-29 12:31:25 +00002413int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
2414 int rc = SQLITE_OK;
2415 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00002416 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00002417 if( pageSize && pageSize!=pPager->pageSize
2418 && !pPager->memDb && pPager->nRef==0
2419 ){
2420 char *pNew = (char *)sqlite3_malloc(pageSize);
2421 if( !pNew ){
2422 rc = SQLITE_NOMEM;
2423 }else{
2424 pagerEnter(pPager);
2425 pager_reset(pPager);
2426 pPager->pageSize = pageSize;
2427 setSectorSize(pPager);
2428 sqlite3_free(pPager->pTmpSpace);
2429 pPager->pTmpSpace = pNew;
2430 pagerLeave(pPager);
2431 }
drh1c7880e2005-05-20 20:01:55 +00002432 }
danielk1977a1644fd2007-08-29 12:31:25 +00002433 *pPageSize = pPager->pageSize;
2434 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002435}
2436
2437/*
drh26b79942007-11-28 16:19:56 +00002438** Return a pointer to the "temporary page" buffer held internally
2439** by the pager. This is a buffer that is big enough to hold the
2440** entire content of a database page. This buffer is used internally
2441** during rollback and will be overwritten whenever a rollback
2442** occurs. But other modules are free to use it too, as long as
2443** no rollbacks are happening.
2444*/
2445void *sqlite3PagerTempSpace(Pager *pPager){
2446 return pPager->pTmpSpace;
2447}
2448
2449/*
drhf8e632b2007-05-08 14:51:36 +00002450** Attempt to set the maximum database page count if mxPage is positive.
2451** Make no changes if mxPage is zero or negative. And never reduce the
2452** maximum page count below the current size of the database.
2453**
2454** Regardless of mxPage, return the current maximum page count.
2455*/
2456int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2457 if( mxPage>0 ){
2458 pPager->mxPgno = mxPage;
2459 }
2460 sqlite3PagerPagecount(pPager);
2461 return pPager->mxPgno;
2462}
2463
2464/*
drhc9ac5ca2005-11-04 22:03:30 +00002465** The following set of routines are used to disable the simulated
2466** I/O error mechanism. These routines are used to avoid simulated
2467** errors in places where we do not care about errors.
2468**
2469** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2470** and generate no code.
2471*/
2472#ifdef SQLITE_TEST
2473extern int sqlite3_io_error_pending;
2474extern int sqlite3_io_error_hit;
2475static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002476void disable_simulated_io_errors(void){
2477 saved_cnt = sqlite3_io_error_pending;
2478 sqlite3_io_error_pending = -1;
2479}
2480void enable_simulated_io_errors(void){
2481 sqlite3_io_error_pending = saved_cnt;
2482}
2483#else
drh152410f2005-11-05 15:11:22 +00002484# define disable_simulated_io_errors()
2485# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002486#endif
2487
2488/*
drh90f5ecb2004-07-22 01:19:35 +00002489** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002490** that pDest points to.
2491**
2492** No error checking is done. The rational for this is that this function
2493** may be called even if the file does not exist or contain a header. In
2494** these cases sqlite3OsRead() will return an error, to which the correct
2495** response is to zero the memory at pDest and continue. A real IO error
2496** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002497*/
danielk19773b8a05f2007-03-19 17:44:26 +00002498int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002499 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002500 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002501 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2502 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002503 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002504 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002505 if( rc==SQLITE_IOERR_SHORT_READ ){
2506 rc = SQLITE_OK;
2507 }
drh90f5ecb2004-07-22 01:19:35 +00002508 }
drh551b7732006-11-06 21:20:25 +00002509 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002510}
2511
2512/*
drh5e00f6c2001-09-13 13:46:56 +00002513** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002514** pPager.
2515**
2516** If the PENDING_BYTE lies on the page directly after the end of the
2517** file, then consider this page part of the file too. For example, if
2518** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2519** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002520*/
danielk19773b8a05f2007-03-19 17:44:26 +00002521int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002522 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002523 int rc;
drhd9b02572001-04-15 00:37:09 +00002524 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002525 if( pPager->errCode ){
danielk197743468d92008-02-26 06:05:31 +00002526 return -1;
drha7aea3d2007-03-15 12:51:16 +00002527 }
drhed7c8552001-04-11 14:29:21 +00002528 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002529 n = pPager->dbSize;
2530 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002531 assert(pPager->fd->pMethods||pPager->tempFile);
2532 if( (pPager->fd->pMethods)
2533 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002534 pPager->nRef++;
drhe49f9822006-09-15 12:29:16 +00002535 pager_error(pPager, rc);
danielk1977ae72d982007-10-03 08:46:44 +00002536 pPager->nRef--;
danielk197743468d92008-02-26 06:05:31 +00002537 return -1;
danielk197715f411d2005-09-16 10:18:45 +00002538 }
2539 if( n>0 && n<pPager->pageSize ){
2540 n = 1;
2541 }else{
2542 n /= pPager->pageSize;
2543 }
2544 if( pPager->state!=PAGER_UNLOCK ){
2545 pPager->dbSize = n;
2546 }
drhed7c8552001-04-11 14:29:21 +00002547 }
danielk197715f411d2005-09-16 10:18:45 +00002548 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002549 n++;
2550 }
drhf8e632b2007-05-08 14:51:36 +00002551 if( n>pPager->mxPgno ){
2552 pPager->mxPgno = n;
2553 }
drhed7c8552001-04-11 14:29:21 +00002554 return n;
2555}
2556
drhf07e7d52006-04-07 13:54:46 +00002557
2558#ifndef SQLITE_OMIT_MEMORYDB
2559/*
2560** Clear a PgHistory block
2561*/
2562static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002563 sqlite3_free(pHist->pOrig);
2564 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002565 pHist->pOrig = 0;
2566 pHist->pStmt = 0;
2567}
2568#else
2569#define clearHistory(x)
2570#endif
2571
drhed7c8552001-04-11 14:29:21 +00002572/*
drhf7c57532003-04-25 13:22:51 +00002573** Forward declaration
2574*/
danielk197776572402004-06-25 02:38:54 +00002575static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002576
2577/*
drh85b623f2007-12-13 21:54:09 +00002578** Unlink pPg from its hash chain. Also set the page number to 0 to indicate
danielk1977f5fdda82004-11-03 08:44:05 +00002579** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002580** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002581** pNextFree/pPrevFree list that is not a part of any hash-chain.
2582*/
2583static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2584 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002585 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002586 return;
2587 }
2588 if( pPg->pNextHash ){
2589 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2590 }
2591 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002592 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002593 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2594 }else{
drh8ca0c722006-05-07 17:49:38 +00002595 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002596 pPager->aHash[h] = pPg->pNextHash;
2597 }
drh5229ae42006-03-23 23:29:04 +00002598 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002599 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2600 }
danielk1977f5fdda82004-11-03 08:44:05 +00002601 pPg->pgno = 0;
2602 pPg->pNextHash = pPg->pPrevHash = 0;
2603}
2604
2605/*
drhac69b052004-05-12 13:30:07 +00002606** Unlink a page from the free list (the list of all pages where nRef==0)
2607** and from its hash collision chain.
2608*/
2609static void unlinkPage(PgHdr *pPg){
2610 Pager *pPager = pPg->pPager;
2611
danielk19779f61c2f2007-08-27 17:27:49 +00002612 /* Unlink from free page list */
2613 lruListRemove(pPg);
drhac69b052004-05-12 13:30:07 +00002614
2615 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002616 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002617}
2618
2619/*
danielk1977e180dd92007-04-05 17:15:52 +00002620** This routine is used to truncate the cache when a database
2621** is truncated. Drop from the cache all pages whose pgno is
2622** larger than pPager->dbSize and is unreferenced.
2623**
drhac69b052004-05-12 13:30:07 +00002624** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002625**
2626** Actually, at the point this routine is called, it would be
2627** an error to have a referenced page. But rather than delete
2628** that page and guarantee a subsequent segfault, it seems better
2629** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002630*/
danielk1977e180dd92007-04-05 17:15:52 +00002631static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002632 PgHdr *pPg;
2633 PgHdr **ppPg;
2634 int dbSize = pPager->dbSize;
2635
2636 ppPg = &pPager->pAll;
2637 while( (pPg = *ppPg)!=0 ){
2638 if( pPg->pgno<=dbSize ){
2639 ppPg = &pPg->pNextAll;
2640 }else if( pPg->nRef>0 ){
2641 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2642 ppPg = &pPg->pNextAll;
2643 }else{
2644 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002645 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2646 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002647 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002648 makeClean(pPg);
drh0d180202008-02-14 23:26:56 +00002649 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00002650 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002651 pPager->nPage--;
2652 }
2653 }
2654}
2655
drhf7c57532003-04-25 13:22:51 +00002656/*
danielk197717221812005-02-15 03:38:05 +00002657** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002658** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002659** false or until the lock succeeds.
2660**
2661** Return SQLITE_OK on success and an error code if we cannot obtain
2662** the lock.
2663*/
2664static int pager_wait_on_lock(Pager *pPager, int locktype){
2665 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002666
2667 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002668 assert( PAGER_SHARED==SHARED_LOCK );
2669 assert( PAGER_RESERVED==RESERVED_LOCK );
2670 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002671
2672 /* If the file is currently unlocked then the size must be unknown */
2673 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2674
danielk197717221812005-02-15 03:38:05 +00002675 if( pPager->state>=locktype ){
2676 rc = SQLITE_OK;
2677 }else{
drhbefdf832008-03-14 19:33:05 +00002678 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002679 do {
drh054889e2005-11-30 03:20:31 +00002680 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002681 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002682 if( rc==SQLITE_OK ){
2683 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002684 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002685 }
2686 }
2687 return rc;
2688}
2689
2690/*
drhf7c57532003-04-25 13:22:51 +00002691** Truncate the file to the number of pages specified.
2692*/
danielk19773b8a05f2007-03-19 17:44:26 +00002693int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002694 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002695 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002696 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002697 if( pPager->errCode ){
2698 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002699 return rc;
2700 }
drh7d02cb72003-06-04 16:24:39 +00002701 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002702 return SQLITE_OK;
2703 }
drhb7f91642004-10-31 02:22:47 +00002704 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002705 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002706 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002707 return SQLITE_OK;
2708 }
drh86f8c192007-08-22 00:39:19 +00002709 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002710 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002711 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002712 if( rc!=SQLITE_OK ){
2713 return rc;
2714 }
danielk197717221812005-02-15 03:38:05 +00002715
2716 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002717 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002718 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002719 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002720 if( rc!=SQLITE_OK ){
2721 return rc;
2722 }
2723
drhcb4c40b2004-08-18 19:09:43 +00002724 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002725 return rc;
2726}
2727
2728/*
drhed7c8552001-04-11 14:29:21 +00002729** Shutdown the page cache. Free all memory and close all files.
2730**
2731** If a transaction was in progress when this routine is called, that
2732** transaction is rolled back. All outstanding pages are invalidated
2733** and their memory is freed. Any attempt to use a page associated
2734** with this page cache after this function returns will likely
2735** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002736**
2737** This function always succeeds. If a transaction is active an attempt
2738** is made to roll it back. If an error occurs during the rollback
2739** a hot journal may be left in the filesystem but no error is returned
2740** to the caller.
drhed7c8552001-04-11 14:29:21 +00002741*/
danielk19773b8a05f2007-03-19 17:44:26 +00002742int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002743#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002744 if( !MEMDB ){
drh26e4a8b2008-05-01 17:16:52 +00002745#ifndef SQLITE_MUTEX_NOOP
drh86f8c192007-08-22 00:39:19 +00002746 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00002747#endif
drh86f8c192007-08-22 00:39:19 +00002748 sqlite3_mutex_enter(mutex);
2749 if( pPager->pPrev ){
2750 pPager->pPrev->pNext = pPager->pNext;
2751 }else{
2752 sqlite3PagerList = pPager->pNext;
2753 }
2754 if( pPager->pNext ){
2755 pPager->pNext->pPrev = pPager->pPrev;
2756 }
2757 sqlite3_mutex_leave(mutex);
2758 }
danielk197713f72992005-12-18 08:51:22 +00002759#endif
2760
drhbafda092007-01-03 23:36:22 +00002761 disable_simulated_io_errors();
drh16e45a42008-04-19 20:34:18 +00002762 sqlite3FaultBenign(-1, 1);
drhc2ee76c2007-01-04 14:58:14 +00002763 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002764 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002765 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002766 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002767 enable_simulated_io_errors();
drh16e45a42008-04-19 20:34:18 +00002768 sqlite3FaultBenign(-1, 0);
drh4f0c5872007-03-26 22:05:01 +00002769 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002770 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002771 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002772 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002773 }
drhf5e7bb52008-02-18 14:47:33 +00002774 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002775 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002776 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002777 }
danielk1977b4b47412007-08-17 15:53:36 +00002778 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002779 /* Temp files are automatically deleted by the OS
2780 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002781 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002782 ** }
2783 */
danielk1977aca790a2005-01-13 11:07:52 +00002784
drh17435752007-08-16 04:30:38 +00002785 sqlite3_free(pPager->aHash);
2786 sqlite3_free(pPager->pTmpSpace);
2787 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002788 return SQLITE_OK;
2789}
2790
drh87cc3b32007-05-08 21:45:27 +00002791#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002792/*
drh5e00f6c2001-09-13 13:46:56 +00002793** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002794*/
danielk19773b8a05f2007-03-19 17:44:26 +00002795Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002796 return p->pgno;
2797}
drh87cc3b32007-05-08 21:45:27 +00002798#endif
drhed7c8552001-04-11 14:29:21 +00002799
2800/*
drhc8629a12004-05-08 20:07:40 +00002801** The page_ref() function increments the reference count for a page.
2802** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002803** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002804**
2805** For non-test systems, page_ref() is a macro that calls _page_ref()
2806** online of the reference count is zero. For test systems, page_ref()
2807** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002808*/
drh836faa42003-01-11 13:30:57 +00002809static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002810 if( pPg->nRef==0 ){
2811 /* The page is currently on the freelist. Remove it. */
danielk19779f61c2f2007-08-27 17:27:49 +00002812 lruListRemove(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002813 pPg->pPager->nRef++;
2814 }
2815 pPg->nRef++;
drhdf0b3b02001-06-23 11:36:20 +00002816}
danielk1977aca790a2005-01-13 11:07:52 +00002817#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002818 static void page_ref(PgHdr *pPg){
2819 if( pPg->nRef==0 ){
2820 _page_ref(pPg);
2821 }else{
2822 pPg->nRef++;
drhc8629a12004-05-08 20:07:40 +00002823 }
2824 }
2825#else
2826# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2827#endif
drhdf0b3b02001-06-23 11:36:20 +00002828
2829/*
2830** Increment the reference count for a page. The input pointer is
2831** a reference to the page data.
2832*/
danielk19773b8a05f2007-03-19 17:44:26 +00002833int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002834 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002835 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002836 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002837 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002838}
2839
2840/*
drh34e79ce2004-02-08 06:05:46 +00002841** Sync the journal. In other words, make sure all the pages that have
2842** been written to the journal have actually reached the surface of the
2843** disk. It is not safe to modify the original database file until after
2844** the journal has been synced. If the original database is modified before
2845** the journal is synced and a power failure occurs, the unsynced journal
2846** data would be lost and we would be unable to completely rollback the
2847** database changes. Database corruption would occur.
2848**
2849** This routine also updates the nRec field in the header of the journal.
2850** (See comments on the pager_playback() routine for additional information.)
2851** If the sync mode is FULL, two syncs will occur. First the whole journal
2852** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002853**
drh34e79ce2004-02-08 06:05:46 +00002854** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002855** after a power failure, so no sync occurs.
2856**
2857** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2858** the database is stored, then OsSync() is never called on the journal
2859** file. In this case all that is required is to update the nRec field in
2860** the journal header.
drhfa86c412002-02-02 15:01:15 +00002861**
drh34e79ce2004-02-08 06:05:46 +00002862** This routine clears the needSync field of every page current held in
2863** memory.
drh50e5dad2001-09-15 00:57:28 +00002864*/
danielk197776572402004-06-25 02:38:54 +00002865static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002866 PgHdr *pPg;
2867 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002868
danielk19774cd2cd52007-08-23 14:48:23 +00002869
drh03eb96a2002-11-10 23:32:56 +00002870 /* Sync the journal before modifying the main database
2871 ** (assuming there is a journal and it needs to be synced.)
2872 */
danielk197776572402004-06-25 02:38:54 +00002873 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002874 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002875 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002876 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002877
danielk19774cd2cd52007-08-23 14:48:23 +00002878 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002879 /* Write the nRec value into the journal file header. If in
2880 ** full-synchronous mode, sync the journal first. This ensures that
2881 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002882 ** it as a candidate for rollback.
2883 **
2884 ** This is not required if the persistent media supports the
2885 ** SAFE_APPEND property. Because in this case it is not possible
2886 ** for garbage data to be appended to the file, the nRec field
2887 ** is populated with 0xFFFFFFFF when the journal header is written
2888 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002889 */
danielk19774cd2cd52007-08-23 14:48:23 +00002890 i64 jrnlOff;
2891 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002892 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002893 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002894 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002895 if( rc!=0 ) return rc;
2896 }
danielk197713adf8a2004-06-03 16:08:41 +00002897
danielk197762079062007-08-15 17:08:46 +00002898 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2899 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2900 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002901 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002902 }
danielk19774cd2cd52007-08-23 14:48:23 +00002903 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2904 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2905 IOTRACE(("JSYNC %p\n", pPager))
2906 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2907 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2908 );
2909 if( rc!=0 ) return rc;
2910 }
drhdb48ee02003-01-16 13:42:43 +00002911 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002912 }
drh50e5dad2001-09-15 00:57:28 +00002913 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002914
2915 /* Erase the needSync flag from every page.
2916 */
2917 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2918 pPg->needSync = 0;
2919 }
danielk19779f61c2f2007-08-27 17:27:49 +00002920 lruListSetFirstSynced(pPager);
drh50e5dad2001-09-15 00:57:28 +00002921 }
drh03eb96a2002-11-10 23:32:56 +00002922
drh341eae82003-01-21 02:39:36 +00002923#ifndef NDEBUG
2924 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2925 ** flag must also be clear for all pages. Verify that this
2926 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002927 */
drh341eae82003-01-21 02:39:36 +00002928 else{
2929 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2930 assert( pPg->needSync==0 );
2931 }
danielk19779f61c2f2007-08-27 17:27:49 +00002932 assert( pPager->lru.pFirstSynced==pPager->lru.pFirst );
drh03eb96a2002-11-10 23:32:56 +00002933 }
drh341eae82003-01-21 02:39:36 +00002934#endif
drhdb48ee02003-01-16 13:42:43 +00002935
drh81a20f22001-10-12 17:30:04 +00002936 return rc;
drh50e5dad2001-09-15 00:57:28 +00002937}
2938
2939/*
drhdc3e10b2006-06-15 14:31:06 +00002940** Merge two lists of pages connected by pDirty and in pgno order.
2941** Do not both fixing the pPrevDirty pointers.
2942*/
2943static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2944 PgHdr result, *pTail;
2945 pTail = &result;
2946 while( pA && pB ){
2947 if( pA->pgno<pB->pgno ){
2948 pTail->pDirty = pA;
2949 pTail = pA;
2950 pA = pA->pDirty;
2951 }else{
2952 pTail->pDirty = pB;
2953 pTail = pB;
2954 pB = pB->pDirty;
2955 }
2956 }
2957 if( pA ){
2958 pTail->pDirty = pA;
2959 }else if( pB ){
2960 pTail->pDirty = pB;
2961 }else{
2962 pTail->pDirty = 0;
2963 }
2964 return result.pDirty;
2965}
2966
2967/*
2968** Sort the list of pages in accending order by pgno. Pages are
2969** connected by pDirty pointers. The pPrevDirty pointers are
2970** corrupted by this sort.
2971*/
danielk197724168722007-04-02 05:07:47 +00002972#define N_SORT_BUCKET_ALLOC 25
2973#define N_SORT_BUCKET 25
2974#ifdef SQLITE_TEST
2975 int sqlite3_pager_n_sort_bucket = 0;
2976 #undef N_SORT_BUCKET
2977 #define N_SORT_BUCKET \
2978 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2979#endif
drhdc3e10b2006-06-15 14:31:06 +00002980static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002981 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002982 int i;
2983 memset(a, 0, sizeof(a));
2984 while( pIn ){
2985 p = pIn;
2986 pIn = p->pDirty;
2987 p->pDirty = 0;
2988 for(i=0; i<N_SORT_BUCKET-1; i++){
2989 if( a[i]==0 ){
2990 a[i] = p;
2991 break;
2992 }else{
2993 p = merge_pagelist(a[i], p);
2994 a[i] = 0;
2995 }
2996 }
2997 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002998 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2999 ** elements in the input list. This is possible, but impractical.
3000 ** Testing this line is the point of global variable
3001 ** sqlite3_pager_n_sort_bucket.
3002 */
drhdc3e10b2006-06-15 14:31:06 +00003003 a[i] = merge_pagelist(a[i], p);
3004 }
3005 }
3006 p = a[0];
3007 for(i=1; i<N_SORT_BUCKET; i++){
3008 p = merge_pagelist(p, a[i]);
3009 }
3010 return p;
3011}
3012
3013/*
drh2554f8b2003-01-22 01:26:44 +00003014** Given a list of pages (connected by the PgHdr.pDirty pointer) write
3015** every one of those pages out to the database file and mark them all
3016** as clean.
3017*/
3018static int pager_write_pagelist(PgHdr *pList){
3019 Pager *pPager;
drh153c62c2007-08-24 03:51:33 +00003020 PgHdr *p;
drh2554f8b2003-01-22 01:26:44 +00003021 int rc;
3022
3023 if( pList==0 ) return SQLITE_OK;
3024 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00003025
3026 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
3027 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00003028 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00003029 **
drha6abd042004-06-09 17:37:22 +00003030 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
3031 ** through an intermediate state PENDING. A PENDING lock prevents new
3032 ** readers from attaching to the database but is unsufficient for us to
3033 ** write. The idea of a PENDING lock is to prevent new readers from
3034 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00003035 **
drha6abd042004-06-09 17:37:22 +00003036 ** While the pager is in the RESERVED state, the original database file
3037 ** is unchanged and we can rollback without having to playback the
3038 ** journal into the original database file. Once we transition to
3039 ** EXCLUSIVE, it means the database file has been changed and any rollback
3040 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00003041 */
drh684917c2004-10-05 02:41:42 +00003042 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00003043 if( rc!=SQLITE_OK ){
3044 return rc;
3045 }
3046
drhdc3e10b2006-06-15 14:31:06 +00003047 pList = sort_pagelist(pList);
drh153c62c2007-08-24 03:51:33 +00003048 for(p=pList; p; p=p->pDirty){
3049 assert( p->dirty );
3050 p->dirty = 0;
3051 }
drh2554f8b2003-01-22 01:26:44 +00003052 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00003053
3054 /* If the file has not yet been opened, open it now. */
3055 if( !pPager->fd->pMethods ){
3056 assert(pPager->tempFile);
drh33f4e022007-09-03 15:19:34 +00003057 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename,
3058 pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00003059 if( rc ) return rc;
3060 }
3061
danielk1977687566d2004-11-02 12:56:41 +00003062 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00003063 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00003064 ** make the file smaller (presumably by auto-vacuum code). Do not write
3065 ** any such pages to the file.
3066 */
3067 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00003068 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00003069 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00003070 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
3071 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00003072 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00003073 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003074 PAGER_INCR(sqlite3_pager_writedb_count);
3075 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00003076 if( pList->pgno==1 ){
3077 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
3078 }
danielk1977687566d2004-11-02 12:56:41 +00003079 }
3080#ifndef NDEBUG
3081 else{
drh4f0c5872007-03-26 22:05:01 +00003082 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00003083 }
3084#endif
drh2554f8b2003-01-22 01:26:44 +00003085 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00003086#ifdef SQLITE_CHECK_PAGES
3087 pList->pageHash = pager_pagehash(pList);
3088#endif
drh2554f8b2003-01-22 01:26:44 +00003089 pList = pList->pDirty;
3090 }
3091 return SQLITE_OK;
3092}
3093
3094/*
3095** Collect every dirty page into a dirty list and
3096** return a pointer to the head of that list. All pages are
3097** collected even if they are still in use.
3098*/
3099static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh8f2e9a12008-02-26 14:46:04 +00003100
3101#ifndef NDEBUG
3102 /* Verify the sanity of the dirty list when we are running
3103 ** in debugging mode. This is expensive, so do not
3104 ** do this on a normal build. */
3105 int n1 = 0;
3106 int n2 = 0;
3107 PgHdr *p;
3108 for(p=pPager->pAll; p; p=p->pNextAll){ if( p->dirty ) n1++; }
3109 for(p=pPager->pDirty; p; p=p->pDirty){ n2++; }
3110 assert( n1==n2 );
3111#endif
3112
drh605ad8f2006-05-03 23:34:05 +00003113 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00003114}
3115
3116/*
drh19db9352008-03-27 22:42:51 +00003117** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00003118** A hot journal is one that needs to be played back.
3119**
3120** If the current size of the database file is 0 but a journal file
3121** exists, that is probably an old journal left over from a prior
3122** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00003123**
3124** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00003125**
3126** This routine does not open the journal file to examine its
3127** content. Hence, the journal might contain the name of a master
3128** journal file that has been deleted, and hence not be hot. Or
3129** the header of the journal might be zeroed out. This routine
3130** does not discover these cases of a non-hot journal - if the
3131** journal file exists and is not empty this routine assumes it
3132** is hot. The pager_playback() routine will discover that the
3133** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00003134*/
3135static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003136 sqlite3_vfs *pVfs = pPager->pVfs;
drh19db9352008-03-27 22:42:51 +00003137 int rc;
drh165ffe92005-03-15 17:09:30 +00003138 if( !pPager->useJournal ) return 0;
drhd3cf2472007-11-27 16:55:07 +00003139 if( !pPager->fd->pMethods ) return 0;
drh19db9352008-03-27 22:42:51 +00003140 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS);
3141 if( rc<=0 ){
3142 return rc;
drhbb5f18d2007-04-06 18:23:17 +00003143 }
3144 if( sqlite3OsCheckReservedLock(pPager->fd) ){
3145 return 0;
3146 }
danielk19773b8a05f2007-03-19 17:44:26 +00003147 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00003148 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00003149 return 0;
3150 }else{
3151 return 1;
3152 }
3153}
3154
danielk19775591df52005-12-20 09:19:37 +00003155/*
danielk1977aef0bf62005-12-30 16:28:01 +00003156** Try to find a page in the cache that can be recycled.
3157**
3158** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00003159** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00003160*/
danielk1977843e65f2007-09-01 16:16:15 +00003161static int pager_recycle(Pager *pPager, PgHdr **ppPg){
danielk197713f72992005-12-18 08:51:22 +00003162 PgHdr *pPg;
3163 *ppPg = 0;
3164
danielk1977843e65f2007-09-01 16:16:15 +00003165 /* It is illegal to call this function unless the pager object
3166 ** pointed to by pPager has at least one free page (page with nRef==0).
3167 */
danielk1977c551edc2007-04-05 13:12:13 +00003168 assert(!MEMDB);
danielk1977843e65f2007-09-01 16:16:15 +00003169 assert(pPager->lru.pFirst);
danielk1977c551edc2007-04-05 13:12:13 +00003170
danielk197713f72992005-12-18 08:51:22 +00003171 /* Find a page to recycle. Try to locate a page that does not
3172 ** require us to do an fsync() on the journal.
3173 */
danielk19779f61c2f2007-08-27 17:27:49 +00003174 pPg = pPager->lru.pFirstSynced;
danielk197713f72992005-12-18 08:51:22 +00003175
3176 /* If we could not find a page that does not require an fsync()
3177 ** on the journal file then fsync the journal file. This is a
3178 ** very slow operation, so we work hard to avoid it. But sometimes
3179 ** it can't be helped.
3180 */
danielk1977843e65f2007-09-01 16:16:15 +00003181 if( pPg==0 && pPager->lru.pFirst){
danielk19774cd2cd52007-08-23 14:48:23 +00003182 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
danielk197713f72992005-12-18 08:51:22 +00003183 int rc = syncJournal(pPager);
3184 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003185 return rc;
danielk197713f72992005-12-18 08:51:22 +00003186 }
danielk19774cd2cd52007-08-23 14:48:23 +00003187 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197713f72992005-12-18 08:51:22 +00003188 /* If in full-sync mode, write a new journal header into the
3189 ** journal file. This is done to avoid ever modifying a journal
3190 ** header that is involved in the rollback of pages that have
3191 ** already been written to the database (in case the header is
3192 ** trashed when the nRec field is updated).
3193 */
3194 pPager->nRec = 0;
3195 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00003196 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00003197 rc = writeJournalHdr(pPager);
3198 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003199 return rc;
danielk197713f72992005-12-18 08:51:22 +00003200 }
3201 }
danielk19779f61c2f2007-08-27 17:27:49 +00003202 pPg = pPager->lru.pFirst;
danielk197713f72992005-12-18 08:51:22 +00003203 }
danielk197713f72992005-12-18 08:51:22 +00003204
3205 assert( pPg->nRef==0 );
3206
3207 /* Write the page to the database file if it is dirty.
3208 */
3209 if( pPg->dirty ){
3210 int rc;
3211 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00003212 makeClean(pPg);
3213 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00003214 pPg->pDirty = 0;
3215 rc = pager_write_pagelist( pPg );
drh153c62c2007-08-24 03:51:33 +00003216 pPg->dirty = 0;
danielk197713f72992005-12-18 08:51:22 +00003217 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00003218 return rc;
danielk197713f72992005-12-18 08:51:22 +00003219 }
3220 }
3221 assert( pPg->dirty==0 );
3222
3223 /* If the page we are recycling is marked as alwaysRollback, then
3224 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00003225 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00003226 ** It is necessary to do this because the page marked alwaysRollback
3227 ** might be reloaded at a later time but at that point we won't remember
3228 ** that is was marked alwaysRollback. This means that all pages must
3229 ** be marked as alwaysRollback from here on out.
3230 */
3231 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00003232 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00003233 pPager->alwaysRollback = 1;
3234 }
3235
3236 /* Unlink the old page from the free list and the hash table
3237 */
3238 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00003239 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00003240
3241 *ppPg = pPg;
3242 return SQLITE_OK;
3243}
3244
drh86f8c192007-08-22 00:39:19 +00003245#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00003246/*
3247** This function is called to free superfluous dynamically allocated memory
3248** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00003249** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00003250**
3251** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00003252** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00003253** of bytes of memory released.
3254*/
danielk19773b8a05f2007-03-19 17:44:26 +00003255int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00003256 int nReleased = 0; /* Bytes of memory released so far */
drh86f8c192007-08-22 00:39:19 +00003257 Pager *pPager; /* For looping over pagers */
drhe5fe6902007-12-07 18:55:28 +00003258 BusyHandler *savedBusy; /* Saved copy of the busy handler */
danielk19779f61c2f2007-08-27 17:27:49 +00003259 int rc = SQLITE_OK;
danielk197713f72992005-12-18 08:51:22 +00003260
drh86f8c192007-08-22 00:39:19 +00003261 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00003262 */
drh26e4a8b2008-05-01 17:16:52 +00003263#ifndef SQLITE_MUTEX_NOOP
drh64e2bb72008-05-07 12:29:55 +00003264 sqlite3_mutex *mutex; /* The MEM2 mutex */
drh86f8c192007-08-22 00:39:19 +00003265 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
drh26e4a8b2008-05-01 17:16:52 +00003266#endif
drh86f8c192007-08-22 00:39:19 +00003267 sqlite3_mutex_enter(mutex);
3268
3269 /* Signal all database connections that memory management wants
3270 ** to have access to the pagers.
3271 */
3272 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3273 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00003274 }
3275
danielk19779f61c2f2007-08-27 17:27:49 +00003276 while( rc==SQLITE_OK && (nReq<0 || nReleased<nReq) ){
3277 PgHdr *pPg;
3278 PgHdr *pRecycled;
3279
3280 /* Try to find a page to recycle that does not require a sync(). If
3281 ** this is not possible, find one that does require a sync().
3282 */
3283 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
3284 pPg = sqlite3LruPageList.pFirstSynced;
3285 while( pPg && (pPg->needSync || pPg->pPager->iInUseDB) ){
3286 pPg = pPg->gfree.pNext;
3287 }
3288 if( !pPg ){
3289 pPg = sqlite3LruPageList.pFirst;
3290 while( pPg && pPg->pPager->iInUseDB ){
3291 pPg = pPg->gfree.pNext;
3292 }
3293 }
3294 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
danielk197713f72992005-12-18 08:51:22 +00003295
danielk197784f786f2007-08-28 08:00:17 +00003296 /* If pPg==0, then the block above has failed to find a page to
3297 ** recycle. In this case return early - no further memory will
3298 ** be released.
3299 */
danielk19779f61c2f2007-08-27 17:27:49 +00003300 if( !pPg ) break;
danielk197713f72992005-12-18 08:51:22 +00003301
danielk19779f61c2f2007-08-27 17:27:49 +00003302 pPager = pPg->pPager;
3303 assert(!pPg->needSync || pPg==pPager->lru.pFirst);
3304 assert(pPg->needSync || pPg==pPager->lru.pFirstSynced);
3305
drhe5fe6902007-12-07 18:55:28 +00003306 savedBusy = pPager->pBusyHandler;
3307 pPager->pBusyHandler = 0;
danielk1977843e65f2007-09-01 16:16:15 +00003308 rc = pager_recycle(pPager, &pRecycled);
drhe5fe6902007-12-07 18:55:28 +00003309 pPager->pBusyHandler = savedBusy;
danielk19779f61c2f2007-08-27 17:27:49 +00003310 assert(pRecycled==pPg || rc!=SQLITE_OK);
3311 if( rc==SQLITE_OK ){
3312 /* We've found a page to free. At this point the page has been
3313 ** removed from the page hash-table, free-list and synced-list
3314 ** (pFirstSynced). It is still in the all pages (pAll) list.
3315 ** Remove it from this list before freeing.
3316 **
3317 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
3318 ** probably is though.
danielk197713f72992005-12-18 08:51:22 +00003319 */
danielk19779f61c2f2007-08-27 17:27:49 +00003320 PgHdr *pTmp;
3321 assert( pPg );
3322 if( pPg==pPager->pAll ){
3323 pPager->pAll = pPg->pNextAll;
3324 }else{
3325 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
3326 pTmp->pNextAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00003327 }
danielk19779f61c2f2007-08-27 17:27:49 +00003328 nReleased += (
3329 sizeof(*pPg) + pPager->pageSize
3330 + sizeof(u32) + pPager->nExtra
3331 + MEMDB*sizeof(PgHistory)
3332 );
3333 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
3334 PAGER_INCR(sqlite3_pager_pgfree_count);
drh0d180202008-02-14 23:26:56 +00003335 sqlite3_free(pPg->pData);
danielk19779f61c2f2007-08-27 17:27:49 +00003336 sqlite3_free(pPg);
danielk197784f786f2007-08-28 08:00:17 +00003337 pPager->nPage--;
danielk19779f61c2f2007-08-27 17:27:49 +00003338 }else{
3339 /* An error occured whilst writing to the database file or
3340 ** journal in pager_recycle(). The error is not returned to the
3341 ** caller of this function. Instead, set the Pager.errCode variable.
3342 ** The error will be returned to the user (or users, in the case
3343 ** of a shared pager cache) of the pager for which the error occured.
3344 */
3345 assert(
3346 (rc&0xff)==SQLITE_IOERR ||
3347 rc==SQLITE_FULL ||
3348 rc==SQLITE_BUSY
3349 );
3350 assert( pPager->state>=PAGER_RESERVED );
3351 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00003352 }
3353 }
danielk1977aef0bf62005-12-30 16:28:01 +00003354
drh86f8c192007-08-22 00:39:19 +00003355 /* Clear the memory management flags and release the mutex
3356 */
3357 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3358 pPager->iInUseMM = 0;
3359 }
3360 sqlite3_mutex_leave(mutex);
3361
3362 /* Return the number of bytes released
3363 */
danielk197713f72992005-12-18 08:51:22 +00003364 return nReleased;
3365}
drh86f8c192007-08-22 00:39:19 +00003366#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00003367
drh165ffe92005-03-15 17:09:30 +00003368/*
danielk1977e180dd92007-04-05 17:15:52 +00003369** Read the content of page pPg out of the database file.
3370*/
3371static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
3372 int rc;
danielk197762079062007-08-15 17:08:46 +00003373 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00003374 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00003375 assert(pPager->fd->pMethods||pPager->tempFile);
3376 if( !pPager->fd->pMethods ){
3377 return SQLITE_IOERR_SHORT_READ;
3378 }
danielk197762079062007-08-15 17:08:46 +00003379 offset = (pgno-1)*(i64)pPager->pageSize;
3380 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003381 PAGER_INCR(sqlite3_pager_readdb_count);
3382 PAGER_INCR(pPager->nRead);
3383 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00003384 if( pgno==1 ){
3385 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
3386 sizeof(pPager->dbFileVers));
3387 }
danielk1977e180dd92007-04-05 17:15:52 +00003388 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00003389 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
3390 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00003391 return rc;
3392}
3393
3394
3395/*
danielk1977e277be02007-03-23 18:12:06 +00003396** This function is called to obtain the shared lock required before
3397** data may be read from the pager cache. If the shared lock has already
3398** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00003399**
3400** Immediately after obtaining the shared lock (if required), this function
3401** checks for a hot-journal file. If one is found, an emergency rollback
3402** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00003403*/
3404static int pagerSharedLock(Pager *pPager){
3405 int rc = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00003406 int isHot = 0;
danielk1977e277be02007-03-23 18:12:06 +00003407
danielk1977ae72d982007-10-03 08:46:44 +00003408 /* If this database is opened for exclusive access, has no outstanding
3409 ** page references and is in an error-state, now is the chance to clear
3410 ** the error. Discard the contents of the pager-cache and treat any
3411 ** open journal file as a hot-journal.
3412 */
3413 if( !MEMDB && pPager->exclusiveMode && pPager->nRef==0 && pPager->errCode ){
3414 if( pPager->journalOpen ){
3415 isHot = 1;
3416 }
danielk1977ae72d982007-10-03 08:46:44 +00003417 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00003418 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00003419 }
3420
3421 /* If the pager is still in an error state, do not proceed. The error
3422 ** state will be cleared at some point in the future when all page
3423 ** references are dropped and the cache can be discarded.
3424 */
3425 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3426 return pPager->errCode;
3427 }
3428
3429 if( pPager->state==PAGER_UNLOCK || isHot ){
danielk1977b4b47412007-08-17 15:53:36 +00003430 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00003431 if( !MEMDB ){
3432 assert( pPager->nRef==0 );
3433 if( !pPager->noReadlock ){
3434 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
3435 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003436 assert( pPager->state==PAGER_UNLOCK );
danielk1977e277be02007-03-23 18:12:06 +00003437 return pager_error(pPager, rc);
3438 }
3439 assert( pPager->state>=SHARED_LOCK );
3440 }
3441
3442 /* If a journal file exists, and there is no RESERVED lock on the
3443 ** database file, then it either needs to be played back or deleted.
3444 */
drh19db9352008-03-27 22:42:51 +00003445 rc = hasHotJournal(pPager);
3446 if( rc<0 ){
danielk197752b472a2008-05-05 16:23:55 +00003447 rc = SQLITE_IOERR_NOMEM;
3448 goto failed;
drh19db9352008-03-27 22:42:51 +00003449 }
3450 if( rc==1 || isHot ){
danielk1977e277be02007-03-23 18:12:06 +00003451 /* Get an EXCLUSIVE lock on the database file. At this point it is
3452 ** important that a RESERVED lock is not obtained on the way to the
3453 ** EXCLUSIVE lock. If it were, another process might open the
3454 ** database file, detect the RESERVED lock, and conclude that the
3455 ** database is safe to read while this process is still rolling it
3456 ** back.
3457 **
3458 ** Because the intermediate RESERVED lock is not requested, the
3459 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00003460 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00003461 */
danielk1977ae72d982007-10-03 08:46:44 +00003462 if( pPager->state<EXCLUSIVE_LOCK ){
3463 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3464 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003465 rc = pager_error(pPager, rc);
3466 goto failed;
danielk1977ae72d982007-10-03 08:46:44 +00003467 }
3468 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00003469 }
danielk1977e277be02007-03-23 18:12:06 +00003470
drh16e45a42008-04-19 20:34:18 +00003471 /* Open the journal for read/write access. This is because in
drhfd131da2007-08-07 17:13:03 +00003472 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003473 ** possibly used for a transaction later on. On some systems, the
3474 ** OsTruncate() call used in exclusive-access mode also requires
3475 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003476 */
drh16e45a42008-04-19 20:34:18 +00003477 if( !isHot && pPager->journalOpen==0 ){
danielk1977ce98bba2008-04-03 10:13:01 +00003478 int res = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS);
3479 if( res==1 ){
danielk1977ae72d982007-10-03 08:46:44 +00003480 int fout = 0;
3481 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
3482 assert( !pPager->tempFile );
3483 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
3484 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3485 if( fout&SQLITE_OPEN_READONLY ){
3486 rc = SQLITE_BUSY;
3487 sqlite3OsClose(pPager->jfd);
3488 }
drh16e45a42008-04-19 20:34:18 +00003489 }else if( res==0 ){
3490 /* If the journal does not exist, that means some other process
3491 ** has already rolled it back */
3492 rc = SQLITE_BUSY;
danielk1977ce98bba2008-04-03 10:13:01 +00003493 }else{
drh16e45a42008-04-19 20:34:18 +00003494 /* If sqlite3OsAccess() returns a negative value, that means it
3495 ** failed a memory allocation */
3496 rc = SQLITE_IOERR_NOMEM;
danielk1977979f38e2007-03-27 16:19:51 +00003497 }
3498 }
danielk1977e277be02007-03-23 18:12:06 +00003499 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003500 if( rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_UNLOCK
3501 && rc!=SQLITE_IOERR_NOMEM
3502 ){
3503 rc = SQLITE_BUSY;
drh1aa5af12008-03-07 19:51:14 +00003504 }
danielk197752b472a2008-05-05 16:23:55 +00003505 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003506 }
3507 pPager->journalOpen = 1;
3508 pPager->journalStarted = 0;
3509 pPager->journalOff = 0;
3510 pPager->setMaster = 0;
3511 pPager->journalHdr = 0;
3512
3513 /* Playback and delete the journal. Drop the database write
3514 ** lock and reacquire the read lock.
3515 */
3516 rc = pager_playback(pPager, 1);
3517 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003518 rc = pager_error(pPager, rc);
3519 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003520 }
danielk1977c5859712007-03-26 12:26:27 +00003521 assert(pPager->state==PAGER_SHARED ||
3522 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3523 );
danielk1977e277be02007-03-23 18:12:06 +00003524 }
3525
3526 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003527 /* The shared-lock has just been acquired on the database file
3528 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003529 ** read or write transaction). Check to see if the database
3530 ** has been modified. If the database has changed, flush the
3531 ** cache.
3532 **
3533 ** Database changes is detected by looking at 15 bytes beginning
3534 ** at offset 24 into the file. The first 4 of these 16 bytes are
3535 ** a 32-bit counter that is incremented with each change. The
3536 ** other bytes change randomly with each file change when
3537 ** a codec is in use.
3538 **
3539 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003540 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003541 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003542 */
drh86a88112007-04-16 15:02:19 +00003543 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003544 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003545
danielk1977e180dd92007-04-05 17:15:52 +00003546 if( pPager->errCode ){
danielk197752b472a2008-05-05 16:23:55 +00003547 rc = pPager->errCode;
3548 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00003549 }
3550
danielk1977e180dd92007-04-05 17:15:52 +00003551 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003552 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003553 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003554 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00003555 goto failed;
danielk1977e180dd92007-04-05 17:15:52 +00003556 }
drh86a88112007-04-16 15:02:19 +00003557 }else{
3558 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003559 }
3560
drh86a88112007-04-16 15:02:19 +00003561 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003562 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003563 }
3564 }
3565 }
danielk1977c5859712007-03-26 12:26:27 +00003566 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3567 if( pPager->state==PAGER_UNLOCK ){
3568 pPager->state = PAGER_SHARED;
3569 }
danielk1977e277be02007-03-23 18:12:06 +00003570 }
3571
danielk197752b472a2008-05-05 16:23:55 +00003572 failed:
3573 if( rc!=SQLITE_OK ){
3574 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
3575 pager_unlock(pPager);
3576 }
danielk1977e277be02007-03-23 18:12:06 +00003577 return rc;
3578}
3579
3580/*
danielk1977e180dd92007-04-05 17:15:52 +00003581** Allocate a PgHdr object. Either create a new one or reuse
3582** an existing one that is not otherwise in use.
3583**
3584** A new PgHdr structure is created if any of the following are
3585** true:
3586**
3587** (1) We have not exceeded our maximum allocated cache size
3588** as set by the "PRAGMA cache_size" command.
3589**
3590** (2) There are no unused PgHdr objects available at this time.
3591**
3592** (3) This is an in-memory database.
3593**
3594** (4) There are no PgHdr objects that do not require a journal
3595** file sync and a sync of the journal file is currently
3596** prohibited.
3597**
3598** Otherwise, reuse an existing PgHdr. In other words, reuse an
3599** existing PgHdr if all of the following are true:
3600**
3601** (1) We have reached or exceeded the maximum cache size
3602** allowed by "PRAGMA cache_size".
3603**
3604** (2) There is a PgHdr available with PgHdr->nRef==0
3605**
3606** (3) We are not in an in-memory database
3607**
3608** (4) Either there is an available PgHdr that does not need
3609** to be synced to disk or else disk syncing is currently
3610** allowed.
danielk197724168722007-04-02 05:07:47 +00003611*/
3612static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3613 int rc = SQLITE_OK;
3614 PgHdr *pPg;
drh1e3af332007-10-20 13:17:54 +00003615 int nByteHdr;
danielk197724168722007-04-02 05:07:47 +00003616
danielk1977e180dd92007-04-05 17:15:52 +00003617 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003618 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003619 if( pPager->nPage<pPager->mxPage
danielk19779f61c2f2007-08-27 17:27:49 +00003620 || pPager->lru.pFirst==0
danielk1977e180dd92007-04-05 17:15:52 +00003621 || MEMDB
danielk19779f61c2f2007-08-27 17:27:49 +00003622 || (pPager->lru.pFirstSynced==0 && pPager->doNotSync)
danielk1977e180dd92007-04-05 17:15:52 +00003623 ){
drh0d180202008-02-14 23:26:56 +00003624 void *pData;
danielk197724168722007-04-02 05:07:47 +00003625 if( pPager->nPage>=pPager->nHash ){
3626 pager_resize_hash_table(pPager,
3627 pPager->nHash<256 ? 256 : pPager->nHash*2);
3628 if( pPager->nHash==0 ){
3629 rc = SQLITE_NOMEM;
3630 goto pager_allocate_out;
3631 }
3632 }
drhed138fb2007-08-22 22:04:37 +00003633 pagerLeave(pPager);
drh1e3af332007-10-20 13:17:54 +00003634 nByteHdr = sizeof(*pPg) + sizeof(u32) + pPager->nExtra
3635 + MEMDB*sizeof(PgHistory);
drh0d180202008-02-14 23:26:56 +00003636 pPg = sqlite3_malloc( nByteHdr );
3637 if( pPg ){
3638 pData = sqlite3_malloc( pPager->pageSize );
3639 if( pData==0 ){
3640 sqlite3_free(pPg);
3641 pPg = 0;
3642 }
3643 }
drhed138fb2007-08-22 22:04:37 +00003644 pagerEnter(pPager);
danielk197724168722007-04-02 05:07:47 +00003645 if( pPg==0 ){
3646 rc = SQLITE_NOMEM;
3647 goto pager_allocate_out;
3648 }
drh1e3af332007-10-20 13:17:54 +00003649 memset(pPg, 0, nByteHdr);
drh0d180202008-02-14 23:26:56 +00003650 pPg->pData = pData;
danielk197724168722007-04-02 05:07:47 +00003651 pPg->pPager = pPager;
3652 pPg->pNextAll = pPager->pAll;
3653 pPager->pAll = pPg;
3654 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003655 }else{
3656 /* Recycle an existing page with a zero ref-count. */
danielk1977843e65f2007-09-01 16:16:15 +00003657 rc = pager_recycle(pPager, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003658 if( rc==SQLITE_BUSY ){
3659 rc = SQLITE_IOERR_BLOCKED;
3660 }
danielk197724168722007-04-02 05:07:47 +00003661 if( rc!=SQLITE_OK ){
3662 goto pager_allocate_out;
3663 }
3664 assert( pPager->state>=SHARED_LOCK );
3665 assert(pPg);
3666 }
3667 *ppPg = pPg;
3668
3669pager_allocate_out:
3670 return rc;
3671}
3672
3673/*
drhd33d5a82007-04-26 12:11:28 +00003674** Make sure we have the content for a page. If the page was
3675** previously acquired with noContent==1, then the content was
3676** just initialized to zeros instead of being read from disk.
3677** But now we need the real data off of disk. So make sure we
3678** have it. Read it in if we do not have it already.
3679*/
3680static int pager_get_content(PgHdr *pPg){
3681 if( pPg->needRead ){
3682 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3683 if( rc==SQLITE_OK ){
3684 pPg->needRead = 0;
3685 }else{
3686 return rc;
3687 }
3688 }
3689 return SQLITE_OK;
3690}
3691
3692/*
drhd9b02572001-04-15 00:37:09 +00003693** Acquire a page.
3694**
drh58a11682001-11-10 13:51:08 +00003695** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003696** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003697**
drhd33d5a82007-04-26 12:11:28 +00003698** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003699** file is smaller than the requested page, then no actual disk
3700** read occurs and the memory image of the page is initialized to
3701** all zeros. The extra data appended to a page is always initialized
3702** to zeros the first time a page is loaded into memory.
3703**
drhd9b02572001-04-15 00:37:09 +00003704** The acquisition might fail for several reasons. In all cases,
3705** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003706**
drhd33d5a82007-04-26 12:11:28 +00003707** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003708** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003709** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003710** just returns 0. This routine acquires a read-lock the first time it
3711** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003712** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003713** or journal files.
drh0787db62007-03-04 13:15:27 +00003714**
drh538f5702007-04-13 02:14:30 +00003715** If noContent is false, the page contents are actually read from disk.
3716** If noContent is true, it means that we do not care about the contents
3717** of the page at this time, so do not do a disk read. Just fill in the
3718** page content with zeros. But mark the fact that we have not read the
3719** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003720** sqlite3PagerWrite() is called on this page or if this routine is
3721** called again with noContent==0, that means that the content is needed
3722** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003723*/
drh86f8c192007-08-22 00:39:19 +00003724static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003725 Pager *pPager, /* The pager open on the database file */
3726 Pgno pgno, /* Page number to fetch */
3727 DbPage **ppPage, /* Write a pointer to the page here */
3728 int noContent /* Do not bother reading content from disk if true */
3729){
drhed7c8552001-04-11 14:29:21 +00003730 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003731 int rc;
drhed7c8552001-04-11 14:29:21 +00003732
danielk1977e277be02007-03-23 18:12:06 +00003733 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3734
danielk197726836652005-01-17 01:33:13 +00003735 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3736 ** number greater than this, or zero, is requested.
3737 */
drh267cb322005-09-16 17:16:52 +00003738 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003739 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003740 }
3741
drhd9b02572001-04-15 00:37:09 +00003742 /* Make sure we have not hit any critical errors.
3743 */
drh836faa42003-01-11 13:30:57 +00003744 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003745 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00003746
danielk197713adf8a2004-06-03 16:08:41 +00003747 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003748 ** on the database file. pagerSharedLock() is a no-op if
3749 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003750 */
danielk1977e277be02007-03-23 18:12:06 +00003751 rc = pagerSharedLock(pPager);
3752 if( rc!=SQLITE_OK ){
3753 return rc;
drhed7c8552001-04-11 14:29:21 +00003754 }
danielk1977e277be02007-03-23 18:12:06 +00003755 assert( pPager->state!=PAGER_UNLOCK );
3756
3757 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003758 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003759 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003760 int nMax;
drhed7c8552001-04-11 14:29:21 +00003761 int h;
drh538f5702007-04-13 02:14:30 +00003762 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003763 rc = pagerAllocatePage(pPager, &pPg);
3764 if( rc!=SQLITE_OK ){
3765 return rc;
drhed7c8552001-04-11 14:29:21 +00003766 }
danielk197724168722007-04-02 05:07:47 +00003767
drhed7c8552001-04-11 14:29:21 +00003768 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003769 assert( !MEMDB || pgno>pPager->stmtSize );
drhf5e7bb52008-02-18 14:47:33 +00003770 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
3771 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003772
drh605ad8f2006-05-03 23:34:05 +00003773 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003774 pPg->nRef = 1;
danielk197775bab7d2006-01-23 13:09:45 +00003775
drhd9b02572001-04-15 00:37:09 +00003776 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003777 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003778 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003779 }
danielk1977979f38e2007-03-27 16:19:51 +00003780 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003781 if( pPager->errCode ){
danielk1977efaaf572006-01-16 11:29:19 +00003782 rc = pPager->errCode;
danielk1977ae72d982007-10-03 08:46:44 +00003783 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00003784 return rc;
3785 }
danielk197775bab7d2006-01-23 13:09:45 +00003786
3787 /* Populate the page with data, either by reading from the database
3788 ** file, or by setting the entire page to zero.
3789 */
drhd215acf2007-04-13 04:01:58 +00003790 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003791 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003792 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003793 return SQLITE_FULL;
3794 }
drh90f5ecb2004-07-22 01:19:35 +00003795 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003796 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003797 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003798 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003799 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003800 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3801 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003802 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003803 return rc;
drh81a20f22001-10-12 17:30:04 +00003804 }
danielk1977b4626a32007-04-28 15:47:43 +00003805 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003806 }
danielk197775bab7d2006-01-23 13:09:45 +00003807
3808 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003809 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003810 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003811 pPg->pNextHash = pPager->aHash[h];
3812 pPager->aHash[h] = pPg;
3813 if( pPg->pNextHash ){
3814 assert( pPg->pNextHash->pPrevHash==0 );
3815 pPg->pNextHash->pPrevHash = pPg;
3816 }
3817
danielk19773c407372005-02-15 02:54:14 +00003818#ifdef SQLITE_CHECK_PAGES
3819 pPg->pageHash = pager_pagehash(pPg);
3820#endif
drhed7c8552001-04-11 14:29:21 +00003821 }else{
drhd9b02572001-04-15 00:37:09 +00003822 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003823 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003824 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003825 if( !noContent ){
3826 rc = pager_get_content(pPg);
3827 if( rc ){
3828 return rc;
3829 }
3830 }
drhdf0b3b02001-06-23 11:36:20 +00003831 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003832 }
danielk19773b8a05f2007-03-19 17:44:26 +00003833 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003834 return SQLITE_OK;
3835}
drh86f8c192007-08-22 00:39:19 +00003836int sqlite3PagerAcquire(
3837 Pager *pPager, /* The pager open on the database file */
3838 Pgno pgno, /* Page number to fetch */
3839 DbPage **ppPage, /* Write a pointer to the page here */
3840 int noContent /* Do not bother reading content from disk if true */
3841){
3842 int rc;
3843 pagerEnter(pPager);
3844 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3845 pagerLeave(pPager);
3846 return rc;
3847}
3848
drhed7c8552001-04-11 14:29:21 +00003849
3850/*
drh7e3b0a02001-04-28 16:52:40 +00003851** Acquire a page if it is already in the in-memory cache. Do
3852** not read the page from disk. Return a pointer to the page,
3853** or 0 if the page is not in cache.
3854**
danielk19773b8a05f2007-03-19 17:44:26 +00003855** See also sqlite3PagerGet(). The difference between this routine
3856** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003857** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003858** returns NULL if the page is not in cache or if a disk I/O error
3859** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003860*/
danielk19773b8a05f2007-03-19 17:44:26 +00003861DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003862 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003863
drh836faa42003-01-11 13:30:57 +00003864 assert( pPager!=0 );
3865 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003866
drh86f8c192007-08-22 00:39:19 +00003867 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003868 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003869 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003870 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3871 /* Do nothing */
3872 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3873 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003874 }
drh86f8c192007-08-22 00:39:19 +00003875 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003876 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003877}
3878
3879/*
drhed7c8552001-04-11 14:29:21 +00003880** Release a page.
3881**
3882** If the number of references to the page drop to zero, then the
3883** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003884** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003885** removed.
3886*/
danielk19773b8a05f2007-03-19 17:44:26 +00003887int sqlite3PagerUnref(DbPage *pPg){
drh6eac06e2008-05-07 12:45:41 +00003888 Pager *pPager;
3889
3890 if( pPg==0 ) return SQLITE_OK;
3891 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003892
3893 /* Decrement the reference count for this page
3894 */
drhed7c8552001-04-11 14:29:21 +00003895 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003896 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003897 pPg->nRef--;
drhd9b02572001-04-15 00:37:09 +00003898
danielk19773c407372005-02-15 02:54:14 +00003899 CHECK_PAGE(pPg);
3900
drh72f82862001-05-24 21:06:34 +00003901 /* When the number of references to a page reach 0, call the
3902 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003903 */
drhed7c8552001-04-11 14:29:21 +00003904 if( pPg->nRef==0 ){
danielk19779f61c2f2007-08-27 17:27:49 +00003905
3906 lruListAdd(pPg);
drh72f82862001-05-24 21:06:34 +00003907 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003908 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003909 }
drhd9b02572001-04-15 00:37:09 +00003910
3911 /* When all pages reach the freelist, drop the read lock from
3912 ** the database file.
3913 */
3914 pPager->nRef--;
3915 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003916 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003917 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003918 }
drhed7c8552001-04-11 14:29:21 +00003919 }
danielk1977ae72d982007-10-03 08:46:44 +00003920 pagerLeave(pPager);
drhd9b02572001-04-15 00:37:09 +00003921 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003922}
3923
3924/*
drha6abd042004-06-09 17:37:22 +00003925** Create a journal file for pPager. There should already be a RESERVED
3926** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003927**
3928** Return SQLITE_OK if everything. Return an error code and release the
3929** write lock if anything goes wrong.
3930*/
3931static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003932 sqlite3_vfs *pVfs = pPager->pVfs;
3933 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3934
drhda47d772002-12-02 04:25:19 +00003935 int rc;
drhb7f91642004-10-31 02:22:47 +00003936 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003937 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003938 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003939 assert( pPager->pInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003940 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003941 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003942 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00003943 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003944 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003945 rc = SQLITE_NOMEM;
3946 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003947 }
danielk1977b4b47412007-08-17 15:53:36 +00003948
drhfdc40e92008-04-17 20:59:37 +00003949 if( pPager->journalOpen==0 ){
3950 if( pPager->tempFile ){
3951 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3952 }else{
3953 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00003954 }
drhfdc40e92008-04-17 20:59:37 +00003955#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3956 rc = sqlite3JournalOpen(
3957 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3958 );
3959#else
3960 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
3961#endif
3962 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3963 pPager->journalOff = 0;
3964 pPager->setMaster = 0;
3965 pPager->journalHdr = 0;
3966 if( rc!=SQLITE_OK ){
3967 if( rc==SQLITE_NOMEM ){
3968 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3969 }
3970 goto failed_to_open_journal;
3971 }
drhda47d772002-12-02 04:25:19 +00003972 }
3973 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003974 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003975 pPager->needSync = 0;
3976 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003977 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003978 if( pPager->errCode ){
3979 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003980 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003981 }
drhda47d772002-12-02 04:25:19 +00003982 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003983
danielk197776572402004-06-25 02:38:54 +00003984 rc = writeJournalHdr(pPager);
3985
drhac69b052004-05-12 13:30:07 +00003986 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003987 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003988 }
danielk1977ae72d982007-10-03 08:46:44 +00003989 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003990 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003991 if( rc==SQLITE_OK ){
3992 rc = SQLITE_FULL;
3993 }
3994 }
drh9c105bb2004-10-02 20:38:28 +00003995 return rc;
3996
3997failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003998 sqlite3BitvecDestroy(pPager->pInJournal);
3999 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00004000 return rc;
drhda47d772002-12-02 04:25:19 +00004001}
4002
4003/*
drh4b845d72002-03-05 12:41:19 +00004004** Acquire a write-lock on the database. The lock is removed when
4005** the any of the following happen:
4006**
drh80e35f42007-03-30 14:06:34 +00004007** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00004008** * sqlite3PagerRollback() is called.
4009** * sqlite3PagerClose() is called.
4010** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00004011**
danielk197713adf8a2004-06-03 16:08:41 +00004012** The first parameter to this routine is a pointer to any open page of the
4013** database file. Nothing changes about the page - it is used merely to
4014** acquire a pointer to the Pager structure and as proof that there is
4015** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00004016**
danielk197713adf8a2004-06-03 16:08:41 +00004017** The second parameter indicates how much space in bytes to reserve for a
4018** master journal file-name at the start of the journal when it is created.
4019**
4020** A journal file is opened if this is not a temporary file. For temporary
4021** files, the opening of the journal file is deferred until there is an
4022** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00004023**
drha6abd042004-06-09 17:37:22 +00004024** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00004025**
4026** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
4027** immediately instead of waiting until we try to flush the cache. The
4028** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00004029*/
danielk19773b8a05f2007-03-19 17:44:26 +00004030int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00004031 Pager *pPager = pPg->pPager;
4032 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00004033 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00004034 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00004035 assert( pPager->state!=PAGER_UNLOCK );
4036 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00004037 assert( pPager->pInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00004038 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00004039 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00004040 pPager->origDbSize = pPager->dbSize;
4041 }else{
drh054889e2005-11-30 03:20:31 +00004042 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00004043 if( rc==SQLITE_OK ){
4044 pPager->state = PAGER_RESERVED;
4045 if( exFlag ){
4046 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
4047 }
4048 }
danielk19779eed5052004-06-04 10:38:30 +00004049 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00004050 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00004051 return rc;
drhac69b052004-05-12 13:30:07 +00004052 }
drha6abd042004-06-09 17:37:22 +00004053 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00004054 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhfdc40e92008-04-17 20:59:37 +00004055 if( pPager->useJournal && !pPager->tempFile
4056 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drhac69b052004-05-12 13:30:07 +00004057 rc = pager_open_journal(pPager);
4058 }
drh4b845d72002-03-05 12:41:19 +00004059 }
danielk1977334cdb62007-03-26 08:05:12 +00004060 }else if( pPager->journalOpen && pPager->journalOff==0 ){
4061 /* This happens when the pager was in exclusive-access mode last
4062 ** time a (read or write) transaction was successfully concluded
4063 ** by this connection. Instead of deleting the journal file it was
4064 ** kept open and truncated to 0 bytes.
4065 */
4066 assert( pPager->nRec==0 );
4067 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00004068 assert( pPager->pInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00004069 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00004070 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004071 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhed138fb2007-08-22 22:04:37 +00004072 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004073 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00004074 rc = SQLITE_NOMEM;
4075 }else{
drh369339d2007-03-30 16:01:55 +00004076 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00004077 rc = writeJournalHdr(pPager);
4078 }
drh4b845d72002-03-05 12:41:19 +00004079 }
danielk1977334cdb62007-03-26 08:05:12 +00004080 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00004081 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00004082 return rc;
4083}
4084
4085/*
drh605ad8f2006-05-03 23:34:05 +00004086** Make a page dirty. Set its dirty flag and add it to the dirty
4087** page list.
4088*/
4089static void makeDirty(PgHdr *pPg){
4090 if( pPg->dirty==0 ){
4091 Pager *pPager = pPg->pPager;
4092 pPg->dirty = 1;
4093 pPg->pDirty = pPager->pDirty;
4094 if( pPager->pDirty ){
4095 pPager->pDirty->pPrevDirty = pPg;
4096 }
4097 pPg->pPrevDirty = 0;
4098 pPager->pDirty = pPg;
4099 }
4100}
4101
4102/*
4103** Make a page clean. Clear its dirty bit and remove it from the
4104** dirty page list.
4105*/
4106static void makeClean(PgHdr *pPg){
4107 if( pPg->dirty ){
4108 pPg->dirty = 0;
4109 if( pPg->pDirty ){
drh153c62c2007-08-24 03:51:33 +00004110 assert( pPg->pDirty->pPrevDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004111 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
4112 }
4113 if( pPg->pPrevDirty ){
drh153c62c2007-08-24 03:51:33 +00004114 assert( pPg->pPrevDirty->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004115 pPg->pPrevDirty->pDirty = pPg->pDirty;
4116 }else{
drh153c62c2007-08-24 03:51:33 +00004117 assert( pPg->pPager->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004118 pPg->pPager->pDirty = pPg->pDirty;
4119 }
4120 }
4121}
4122
4123
4124/*
drhed7c8552001-04-11 14:29:21 +00004125** Mark a data page as writeable. The page is written into the journal
4126** if it is not there already. This routine must be called before making
4127** changes to a page.
4128**
4129** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00004130** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00004131** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00004132** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00004133** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00004134**
4135** If the journal file could not be written because the disk is full,
4136** then this routine returns SQLITE_FULL and does an immediate rollback.
4137** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00004138** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00004139** reset.
drhed7c8552001-04-11 14:29:21 +00004140*/
danielk19773b8a05f2007-03-19 17:44:26 +00004141static int pager_write(PgHdr *pPg){
4142 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00004143 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00004144 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00004145
drh6446c4d2001-12-15 14:22:18 +00004146 /* Check for errors
4147 */
danielk1977efaaf572006-01-16 11:29:19 +00004148 if( pPager->errCode ){
4149 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004150 }
drh5e00f6c2001-09-13 13:46:56 +00004151 if( pPager->readOnly ){
4152 return SQLITE_PERM;
4153 }
drh6446c4d2001-12-15 14:22:18 +00004154
danielk197776572402004-06-25 02:38:54 +00004155 assert( !pPager->setMaster );
4156
danielk19773c407372005-02-15 02:54:14 +00004157 CHECK_PAGE(pPg);
4158
drh538f5702007-04-13 02:14:30 +00004159 /* If this page was previously acquired with noContent==1, that means
4160 ** we didn't really read in the content of the page. This can happen
4161 ** (for example) when the page is being moved to the freelist. But
4162 ** now we are (perhaps) moving the page off of the freelist for
4163 ** reuse and we need to know its original content so that content
4164 ** can be stored in the rollback journal. So do the read at this
4165 ** time.
4166 */
drhd33d5a82007-04-26 12:11:28 +00004167 rc = pager_get_content(pPg);
4168 if( rc ){
4169 return rc;
drh538f5702007-04-13 02:14:30 +00004170 }
4171
drh6446c4d2001-12-15 14:22:18 +00004172 /* Mark the page as dirty. If the page has already been written
4173 ** to the journal then we can return right away.
4174 */
drh605ad8f2006-05-03 23:34:05 +00004175 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00004176 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00004177 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004178 }else{
drh6446c4d2001-12-15 14:22:18 +00004179
danielk1977a0bf2652004-11-04 14:30:04 +00004180 /* If we get this far, it means that the page needs to be
4181 ** written to the transaction journal or the ckeckpoint journal
4182 ** or both.
4183 **
4184 ** First check to see that the transaction journal exists and
4185 ** create it if it does not.
4186 */
4187 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00004188 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00004189 if( rc!=SQLITE_OK ){
4190 return rc;
4191 }
4192 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00004193 if( !pPager->journalOpen && pPager->useJournal
4194 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00004195 rc = pager_open_journal(pPager);
4196 if( rc!=SQLITE_OK ) return rc;
4197 }
danielk1977a0bf2652004-11-04 14:30:04 +00004198 pPager->dirtyCache = 1;
4199
4200 /* The transaction journal now exists and we have a RESERVED or an
4201 ** EXCLUSIVE lock on the main database file. Write the current page to
4202 ** the transaction journal if it is not there already.
4203 */
drhfdc40e92008-04-17 20:59:37 +00004204 if( !pPg->inJournal && (pPager->journalOpen || MEMDB) ){
danielk1977a0bf2652004-11-04 14:30:04 +00004205 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00004206 if( MEMDB ){
4207 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00004208 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004209 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00004210 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977662278e2007-11-05 15:30:12 +00004211 if( !pHist->pOrig ){
4212 return SQLITE_NOMEM;
danielk1977a0bf2652004-11-04 14:30:04 +00004213 }
danielk1977662278e2007-11-05 15:30:12 +00004214 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977a0bf2652004-11-04 14:30:04 +00004215 }else{
drhbf4bca52007-09-06 22:19:14 +00004216 u32 cksum;
4217 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00004218
drh267cb322005-09-16 17:16:52 +00004219 /* We should never write to the journal file the page that
4220 ** contains the database locks. The following assert verifies
4221 ** that we do not. */
4222 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00004223 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00004224 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00004225 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
4226 if( rc==SQLITE_OK ){
4227 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
4228 pPager->journalOff + 4);
4229 pPager->journalOff += pPager->pageSize+4;
4230 }
4231 if( rc==SQLITE_OK ){
4232 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
4233 pPager->journalOff += 4;
4234 }
4235 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00004236 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00004237 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00004238 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
4239 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00004240
drhfd131da2007-08-07 17:13:03 +00004241 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00004242 ** transaction will be rolled back by the layer above.
4243 */
danielk1977a0bf2652004-11-04 14:30:04 +00004244 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00004245 return rc;
4246 }
danielk197707cb5602006-01-20 10:55:05 +00004247
danielk1977a0bf2652004-11-04 14:30:04 +00004248 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00004249 assert( pPager->pInJournal!=0 );
4250 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004251 pPg->needSync = !pPager->noSync;
4252 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00004253 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004254 }
drhac69b052004-05-12 13:30:07 +00004255 }
danielk197713adf8a2004-06-03 16:08:41 +00004256 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004257 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00004258 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00004259 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00004260 }
4261 if( pPg->needSync ){
4262 pPager->needSync = 1;
4263 }
4264 pPg->inJournal = 1;
4265 }
4266
4267 /* If the statement journal is open and the page is not in it,
4268 ** then write the current page to the statement journal. Note that
4269 ** the statement journal format differs from the standard journal format
4270 ** in that it omits the checksums and the header.
4271 */
danielk1977f35843b2007-04-07 15:03:17 +00004272 if( pPager->stmtInUse
4273 && !pageInStatement(pPg)
4274 && (int)pPg->pgno<=pPager->stmtSize
4275 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004276 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
4277 if( MEMDB ){
4278 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4279 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00004280 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00004281 if( pHist->pStmt ){
4282 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
4283 }
drh4f0c5872007-03-26 22:05:01 +00004284 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00004285 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00004286 }else{
danielk197762079062007-08-15 17:08:46 +00004287 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00004288 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
4289 rc = write32bits(pPager->stfd, offset, pPg->pgno);
4290 if( rc==SQLITE_OK ){
4291 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
4292 }
drh4f0c5872007-03-26 22:05:01 +00004293 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00004294 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00004295 return rc;
4296 }
danielk1977a0bf2652004-11-04 14:30:04 +00004297 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00004298 assert( pPager->pInStmt!=0 );
4299 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00004300 }
drhd9b02572001-04-15 00:37:09 +00004301 }
drhfa86c412002-02-02 15:01:15 +00004302 }
4303
4304 /* Update the database size and return.
4305 */
drh1aa2d8b2007-01-03 15:34:29 +00004306 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00004307 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00004308 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00004309 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00004310 pPager->dbSize++;
4311 }
drh306dc212001-05-21 13:45:10 +00004312 }
drh69688d52001-04-14 16:38:23 +00004313 return rc;
drhed7c8552001-04-11 14:29:21 +00004314}
4315
4316/*
danielk19774099f6e2007-03-19 11:25:20 +00004317** This function is used to mark a data-page as writable. It uses
4318** pager_write() to open a journal file (if it is not already open)
4319** and write the page *pData to the journal.
4320**
4321** The difference between this function and pager_write() is that this
4322** function also deals with the special case where 2 or more pages
4323** fit on a single disk sector. In this case all co-resident pages
4324** must have been written to the journal file before returning.
4325*/
danielk19773b8a05f2007-03-19 17:44:26 +00004326int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00004327 int rc = SQLITE_OK;
4328
danielk19773b8a05f2007-03-19 17:44:26 +00004329 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00004330 Pager *pPager = pPg->pPager;
4331 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
4332
drh86f8c192007-08-22 00:39:19 +00004333 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004334 if( !MEMDB && nPagePerSector>1 ){
4335 Pgno nPageCount; /* Total number of pages in database file */
4336 Pgno pg1; /* First page of the sector pPg is located on. */
4337 int nPage; /* Number of pages starting at pg1 to journal */
4338 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00004339 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00004340
4341 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
4342 ** header to be written between the pages journaled by this function.
4343 */
4344 assert( pPager->doNotSync==0 );
4345 pPager->doNotSync = 1;
4346
4347 /* This trick assumes that both the page-size and sector-size are
4348 ** an integer power of 2. It sets variable pg1 to the identifier
4349 ** of the first page of the sector pPg is located on.
4350 */
4351 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
4352
danielk19773b8a05f2007-03-19 17:44:26 +00004353 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004354 if( pPg->pgno>nPageCount ){
4355 nPage = (pPg->pgno - pg1)+1;
4356 }else if( (pg1+nPagePerSector-1)>nPageCount ){
4357 nPage = nPageCount+1-pg1;
4358 }else{
4359 nPage = nPagePerSector;
4360 }
4361 assert(nPage>0);
4362 assert(pg1<=pPg->pgno);
4363 assert((pg1+nPage)>pPg->pgno);
4364
4365 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
4366 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00004367 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00004368 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00004369 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00004370 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004371 if( rc==SQLITE_OK ){
4372 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00004373 if( pPage->needSync ){
4374 needSync = 1;
4375 }
danielk19773b8a05f2007-03-19 17:44:26 +00004376 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004377 }
4378 }
drhc81945e2008-03-10 14:12:53 +00004379 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk1977dd97a492007-08-22 18:54:32 +00004380 if( pPage->needSync ){
4381 needSync = 1;
4382 }
danielk19774099f6e2007-03-19 11:25:20 +00004383 }
4384 }
4385
danielk1977dd97a492007-08-22 18:54:32 +00004386 /* If the PgHdr.needSync flag is set for any of the nPage pages
4387 ** starting at pg1, then it needs to be set for all of them. Because
4388 ** writing to any of these nPage pages may damage the others, the
4389 ** journal file must contain sync()ed copies of all of them
4390 ** before any of them can be written out to the database file.
4391 */
4392 if( needSync ){
4393 for(ii=0; ii<nPage && needSync; ii++){
4394 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
4395 if( pPage ) pPage->needSync = 1;
4396 }
4397 assert(pPager->needSync);
4398 }
4399
danielk19774099f6e2007-03-19 11:25:20 +00004400 assert( pPager->doNotSync==1 );
4401 pPager->doNotSync = 0;
4402 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004403 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00004404 }
drh86f8c192007-08-22 00:39:19 +00004405 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004406 return rc;
4407}
4408
4409/*
drhaacc5432002-01-06 17:07:40 +00004410** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00004411** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00004412** to change the content of the page.
4413*/
danielk19777d3a6662006-01-23 16:21:05 +00004414#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00004415int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00004416 return pPg->dirty;
4417}
danielk19777d3a6662006-01-23 16:21:05 +00004418#endif
drh6019e162001-07-02 17:51:45 +00004419
drh001bbcb2003-03-19 03:14:00 +00004420/*
drh30e58752002-03-02 20:41:57 +00004421** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00004422** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00004423** that page might be marked as dirty.
4424**
4425** The overlying software layer calls this routine when all of the data
4426** on the given page is unused. The pager marks the page as clean so
4427** that it does not get written to disk.
4428**
4429** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00004430** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00004431** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00004432**
4433** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00004434** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00004435** will thereafter be ignored. This is necessary to avoid a problem
4436** where a page with data is added to the freelist during one part of
4437** a transaction then removed from the freelist during a later part
4438** of the same transaction and reused for some other purpose. When it
4439** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004440** the sqlite3PagerDontRollback() routine is called. But because the
4441** page contains critical data, we still need to be sure it gets
4442** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004443*/
drh538f5702007-04-13 02:14:30 +00004444void sqlite3PagerDontWrite(DbPage *pDbPage){
4445 PgHdr *pPg = pDbPage;
4446 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004447
drhb7f91642004-10-31 02:22:47 +00004448 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004449 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004450 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004451 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004452 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004453 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4454 /* If this pages is the last page in the file and the file has grown
4455 ** during the current transaction, then do NOT mark the page as clean.
4456 ** When the database file grows, we must make sure that the last page
4457 ** gets written at least once so that the disk file will be the correct
4458 ** size. If you do not write this page and the size of the file
4459 ** on the disk ends up being too small, that can lead to database
4460 ** corruption during the next transaction.
4461 */
4462 }else{
drh538f5702007-04-13 02:14:30 +00004463 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4464 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004465 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004466#ifdef SQLITE_CHECK_PAGES
4467 pPg->pageHash = pager_pagehash(pPg);
4468#endif
drh8124a302002-06-25 14:43:57 +00004469 }
drh30e58752002-03-02 20:41:57 +00004470 }
drh86f8c192007-08-22 00:39:19 +00004471 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004472}
4473
4474/*
4475** A call to this routine tells the pager that if a rollback occurs,
4476** it is not necessary to restore the data on the given page. This
4477** means that the pager does not have to record the given page in the
4478** rollback journal.
drh538f5702007-04-13 02:14:30 +00004479**
4480** If we have not yet actually read the content of this page (if
4481** the PgHdr.needRead flag is set) then this routine acts as a promise
4482** that we will never need to read the page content in the future.
4483** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00004484*/
danielk19773b8a05f2007-03-19 17:44:26 +00004485void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004486 Pager *pPager = pPg->pPager;
4487
drh86f8c192007-08-22 00:39:19 +00004488 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004489 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00004490
4491 /* If the journal file is not open, or DontWrite() has been called on
4492 ** this page (DontWrite() sets the alwaysRollback flag), then this
4493 ** function is a no-op.
4494 */
4495 if( pPager->journalOpen==0 || pPg->alwaysRollback || pPager->alwaysRollback ){
danielk197787c29a92008-01-18 11:33:16 +00004496 pagerLeave(pPager);
4497 return;
4498 }
danielk1977a55e9352008-01-21 13:04:34 +00004499 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
4500
drhc5d0bd92008-04-14 01:00:57 +00004501#ifdef SQLITE_SECURE_DELETE
4502 if( pPg->inJournal || (int)pPg->pgno > pPager->origDbSize ){
4503 return;
4504 }
4505#endif
4506
4507 /* If SECURE_DELETE is disabled, then there is no way that this
4508 ** routine can be called on a page for which sqlite3PagerDontWrite()
4509 ** has not been previously called during the same transaction.
4510 ** And if DontWrite() has previously been called, the following
4511 ** conditions must be met.
danielk1977a55e9352008-01-21 13:04:34 +00004512 */
4513 assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize );
4514
drhf5e7bb52008-02-18 14:47:33 +00004515 assert( pPager->pInJournal!=0 );
4516 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00004517 pPg->inJournal = 1;
4518 pPg->needRead = 0;
4519 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00004520 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00004521 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00004522 }
danielk1977a55e9352008-01-21 13:04:34 +00004523 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
4524 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh86f8c192007-08-22 00:39:19 +00004525 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004526}
4527
drhac69b052004-05-12 13:30:07 +00004528
drh30e58752002-03-02 20:41:57 +00004529/*
drh80e35f42007-03-30 14:06:34 +00004530** This routine is called to increment the database file change-counter,
4531** stored at byte 24 of the pager file.
4532*/
danielk1977c7b60172007-08-22 11:22:03 +00004533static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004534 PgHdr *pPgHdr;
4535 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004536 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004537
4538 if( !pPager->changeCountDone ){
4539 /* Open page 1 of the file for writing. */
4540 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4541 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004542
4543 if( !isDirect ){
4544 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00004545 if( rc!=SQLITE_OK ){
4546 sqlite3PagerUnref(pPgHdr);
4547 return rc;
4548 }
danielk1977c7b60172007-08-22 11:22:03 +00004549 }
4550
drh80e35f42007-03-30 14:06:34 +00004551 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004552 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004553 change_counter++;
4554 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004555
4556 if( isDirect && pPager->fd->pMethods ){
4557 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4558 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4559 }
4560
drh80e35f42007-03-30 14:06:34 +00004561 /* Release the page reference. */
4562 sqlite3PagerUnref(pPgHdr);
4563 pPager->changeCountDone = 1;
4564 }
danielk1977c7b60172007-08-22 11:22:03 +00004565 return rc;
drh80e35f42007-03-30 14:06:34 +00004566}
4567
4568/*
danielk1977f653d782008-03-20 11:04:21 +00004569** Sync the pager file to disk.
4570*/
4571int sqlite3PagerSync(Pager *pPager){
4572 int rc;
4573 pagerEnter(pPager);
4574 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
4575 pagerLeave(pPager);
4576 return rc;
4577}
4578
4579/*
drh80e35f42007-03-30 14:06:34 +00004580** Sync the database file for the pager pPager. zMaster points to the name
4581** of a master journal file that should be written into the individual
4582** journal file. zMaster may be NULL, which is interpreted as no master
4583** journal (a single database transaction).
4584**
4585** This routine ensures that the journal is synced, all dirty pages written
4586** to the database file and the database file synced. The only thing that
4587** remains to commit the transaction is to delete the journal file (or
4588** master journal file if specified).
4589**
4590** Note that if zMaster==NULL, this does not overwrite a previous value
4591** passed to an sqlite3PagerCommitPhaseOne() call.
4592**
4593** If parameter nTrunc is non-zero, then the pager file is truncated to
4594** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00004595**
4596** If the final parameter - noSync - is true, then the database file itself
4597** is not synced. The caller must call sqlite3PagerSync() directly to
4598** sync the database file before calling CommitPhaseTwo() to delete the
4599** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00004600*/
danielk1977f653d782008-03-20 11:04:21 +00004601int sqlite3PagerCommitPhaseOne(
4602 Pager *pPager,
4603 const char *zMaster,
4604 Pgno nTrunc,
4605 int noSync
4606){
drh80e35f42007-03-30 14:06:34 +00004607 int rc = SQLITE_OK;
4608
4609 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4610 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004611 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004612
4613 /* If this is an in-memory db, or no pages have been written to, or this
4614 ** function has already been called, it is a no-op.
4615 */
4616 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4617 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00004618
danielk1977c7b60172007-08-22 11:22:03 +00004619#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4620 /* The atomic-write optimization can be used if all of the
4621 ** following are true:
4622 **
4623 ** + The file-system supports the atomic-write property for
4624 ** blocks of size page-size, and
4625 ** + This commit is not part of a multi-file transaction, and
4626 ** + Exactly one page has been modified and store in the journal file.
4627 **
4628 ** If the optimization can be used, then the journal file will never
4629 ** be created for this transaction.
4630 */
danielk1977f55b8992007-08-24 08:15:53 +00004631 int useAtomicWrite = (
4632 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00004633 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00004634 pPager->journalOff==jrnlBufferSize(pPager) &&
4635 nTrunc==0 &&
4636 (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4637 );
danielk1977700b9c52008-04-24 12:37:40 +00004638 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00004639 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00004640 /* Update the nRec field in the journal file. */
4641 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4642 assert(pPager->nRec==1);
4643 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4644
4645 /* Update the db file change counter. The following call will modify
4646 ** the in-memory representation of page 1 to include the updated
4647 ** change counter and then write page 1 directly to the database
4648 ** file. Because of the atomic-write property of the host file-system,
4649 ** this is safe.
4650 */
danielk1977ae72d982007-10-03 08:46:44 +00004651 if( rc==SQLITE_OK ){
4652 rc = pager_incr_changecounter(pPager, 1);
4653 }
danielk1977f55b8992007-08-24 08:15:53 +00004654 }else{
4655 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00004656 }
4657
danielk1977ae72d982007-10-03 08:46:44 +00004658 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00004659#endif
4660
drh80e35f42007-03-30 14:06:34 +00004661 /* If a master journal file name has already been written to the
4662 ** journal file, then no sync is required. This happens when it is
4663 ** written, then the process fails to upgrade from a RESERVED to an
4664 ** EXCLUSIVE lock. The next time the process tries to commit the
4665 ** transaction the m-j name will have already been written.
4666 */
4667 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00004668 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004669 if( rc!=SQLITE_OK ) goto sync_exit;
4670#ifndef SQLITE_OMIT_AUTOVACUUM
4671 if( nTrunc!=0 ){
4672 /* If this transaction has made the database smaller, then all pages
4673 ** being discarded by the truncation must be written to the journal
4674 ** file.
4675 */
4676 Pgno i;
4677 int iSkip = PAGER_MJ_PGNO(pPager);
4678 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
drhf5e7bb52008-02-18 14:47:33 +00004679 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
drh80e35f42007-03-30 14:06:34 +00004680 rc = sqlite3PagerGet(pPager, i, &pPg);
4681 if( rc!=SQLITE_OK ) goto sync_exit;
4682 rc = sqlite3PagerWrite(pPg);
4683 sqlite3PagerUnref(pPg);
4684 if( rc!=SQLITE_OK ) goto sync_exit;
4685 }
4686 }
4687 }
4688#endif
4689 rc = writeMasterJournal(pPager, zMaster);
4690 if( rc!=SQLITE_OK ) goto sync_exit;
4691 rc = syncJournal(pPager);
drh80e35f42007-03-30 14:06:34 +00004692 }
danielk1977c7b60172007-08-22 11:22:03 +00004693 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004694
4695#ifndef SQLITE_OMIT_AUTOVACUUM
4696 if( nTrunc!=0 ){
4697 rc = sqlite3PagerTruncate(pPager, nTrunc);
4698 if( rc!=SQLITE_OK ) goto sync_exit;
4699 }
4700#endif
4701
4702 /* Write all dirty pages to the database file */
4703 pPg = pager_get_all_dirty_pages(pPager);
4704 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00004705 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00004706 assert( rc!=SQLITE_IOERR_BLOCKED );
4707 /* The error might have left the dirty list all fouled up here,
4708 ** but that does not matter because if the if the dirty list did
4709 ** get corrupted, then the transaction will roll back and
4710 ** discard the dirty list. There is an assert in
4711 ** pager_get_all_dirty_pages() that verifies that no attempt
4712 ** is made to use an invalid dirty list.
4713 */
drh153c62c2007-08-24 03:51:33 +00004714 goto sync_exit;
4715 }
drh3cdd7d32007-03-30 14:46:01 +00004716 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004717
4718 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00004719 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004720 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004721 }
4722 IOTRACE(("DBSYNC %p\n", pPager))
4723
4724 pPager->state = PAGER_SYNCED;
4725 }else if( MEMDB && nTrunc!=0 ){
4726 rc = sqlite3PagerTruncate(pPager, nTrunc);
4727 }
4728
4729sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004730 if( rc==SQLITE_IOERR_BLOCKED ){
4731 /* pager_incr_changecounter() may attempt to obtain an exclusive
4732 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00004733 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00004734 * better to return SQLITE_BUSY.
4735 */
4736 rc = SQLITE_BUSY;
4737 }
drh86f8c192007-08-22 00:39:19 +00004738 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004739 return rc;
4740}
4741
4742
4743/*
drhed7c8552001-04-11 14:29:21 +00004744** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004745**
4746** If the commit fails for any reason, a rollback attempt is made
4747** and an error code is returned. If the commit worked, SQLITE_OK
4748** is returned.
drhed7c8552001-04-11 14:29:21 +00004749*/
drh80e35f42007-03-30 14:06:34 +00004750int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004751 int rc;
drhed7c8552001-04-11 14:29:21 +00004752 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004753
danielk1977efaaf572006-01-16 11:29:19 +00004754 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004755 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004756 }
drha6abd042004-06-09 17:37:22 +00004757 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004758 return SQLITE_ERROR;
4759 }
drh86f8c192007-08-22 00:39:19 +00004760 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004761 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004762 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004763 pPg = pager_get_all_dirty_pages(pPager);
4764 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004765 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4766 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004767 pPg->dirty = 0;
4768 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004769 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004770 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004771 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004772 pPg = pPg->pDirty;
4773 }
drh605ad8f2006-05-03 23:34:05 +00004774 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004775#ifndef NDEBUG
4776 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4777 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4778 assert( !pPg->alwaysRollback );
4779 assert( !pHist->pOrig );
4780 assert( !pHist->pStmt );
4781 }
4782#endif
drhac69b052004-05-12 13:30:07 +00004783 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004784 pPager->state = PAGER_SHARED;
danielk197787c29a92008-01-18 11:33:16 +00004785 pagerLeave(pPager);
drhac69b052004-05-12 13:30:07 +00004786 return SQLITE_OK;
4787 }
drh3cdd7d32007-03-30 14:46:01 +00004788 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
danielk1977df2566a2008-05-07 19:11:03 +00004789 rc = pager_end_transaction(pPager, pPager->setMaster);
drh86f8c192007-08-22 00:39:19 +00004790 rc = pager_error(pPager, rc);
4791 pagerLeave(pPager);
4792 return rc;
drhed7c8552001-04-11 14:29:21 +00004793}
4794
4795/*
drha6abd042004-06-09 17:37:22 +00004796** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004797** All in-memory cache pages revert to their original data contents.
4798** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004799**
4800** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004801** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004802** process is writing trash into the journal file (SQLITE_CORRUPT) or
4803** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4804** codes are returned for all these occasions. Otherwise,
4805** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004806*/
danielk19773b8a05f2007-03-19 17:44:26 +00004807int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004808 int rc;
drh4f0c5872007-03-26 22:05:01 +00004809 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004810 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004811 PgHdr *p;
4812 for(p=pPager->pAll; p; p=p->pNextAll){
4813 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004814 assert( !p->alwaysRollback );
4815 if( !p->dirty ){
4816 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4817 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4818 continue;
4819 }
4820
drhac69b052004-05-12 13:30:07 +00004821 pHist = PGHDR_TO_HIST(p, pPager);
4822 if( pHist->pOrig ){
4823 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004824 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004825 }else{
drh4f0c5872007-03-26 22:05:01 +00004826 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004827 }
4828 clearHistory(pHist);
4829 p->dirty = 0;
4830 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004831 pHist->inStmt = 0;
4832 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004833 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004834 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004835 }
drhac69b052004-05-12 13:30:07 +00004836 }
drh605ad8f2006-05-03 23:34:05 +00004837 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004838 pPager->pStmt = 0;
4839 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004840 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004841 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004842 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004843 return SQLITE_OK;
4844 }
4845
drh86f8c192007-08-22 00:39:19 +00004846 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004847 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00004848 rc = pager_end_transaction(pPager, pPager->setMaster);
drh86f8c192007-08-22 00:39:19 +00004849 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004850 return rc;
4851 }
drhdb48ee02003-01-16 13:42:43 +00004852
danielk1977efaaf572006-01-16 11:29:19 +00004853 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004854 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004855 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004856 }
drh86f8c192007-08-22 00:39:19 +00004857 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004858 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004859 }
drha6abd042004-06-09 17:37:22 +00004860 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004861 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004862 rc = pager_playback(pPager, 0);
danielk1977df2566a2008-05-07 19:11:03 +00004863 rc2 = pager_end_transaction(pPager, pPager->setMaster);
drha6abd042004-06-09 17:37:22 +00004864 if( rc==SQLITE_OK ){
4865 rc = rc2;
4866 }
4867 }else{
danielk1977e277be02007-03-23 18:12:06 +00004868 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004869 }
danielk1977e180dd92007-04-05 17:15:52 +00004870 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004871 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004872
4873 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4874 ** cache. So call pager_error() on the way out to make any error
4875 ** persistent.
4876 */
drh86f8c192007-08-22 00:39:19 +00004877 rc = pager_error(pPager, rc);
4878 pagerLeave(pPager);
4879 return rc;
drh98808ba2001-10-18 12:34:46 +00004880}
drhd9b02572001-04-15 00:37:09 +00004881
4882/*
drh5e00f6c2001-09-13 13:46:56 +00004883** Return TRUE if the database file is opened read-only. Return FALSE
4884** if the database is (in theory) writable.
4885*/
danielk19773b8a05f2007-03-19 17:44:26 +00004886int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004887 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004888}
4889
4890/*
drh0f7eb612006-08-08 13:51:43 +00004891** Return the number of references to the pager.
4892*/
danielk19773b8a05f2007-03-19 17:44:26 +00004893int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004894 return pPager->nRef;
4895}
4896
4897#ifdef SQLITE_TEST
4898/*
drhd9b02572001-04-15 00:37:09 +00004899** This routine is used for testing and analysis only.
4900*/
danielk19773b8a05f2007-03-19 17:44:26 +00004901int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004902 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004903 a[0] = pPager->nRef;
4904 a[1] = pPager->nPage;
4905 a[2] = pPager->mxPage;
4906 a[3] = pPager->dbSize;
4907 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004908 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004909 a[6] = pPager->nHit;
4910 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004911 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004912 a[9] = pPager->nRead;
4913 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004914 return a;
4915}
drh0f7eb612006-08-08 13:51:43 +00004916#endif
drhdd793422001-06-28 01:54:48 +00004917
drhfa86c412002-02-02 15:01:15 +00004918/*
drhac69b052004-05-12 13:30:07 +00004919** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004920**
4921** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004922** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004923** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004924*/
drh86f8c192007-08-22 00:39:19 +00004925static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004926 int rc;
drhac69b052004-05-12 13:30:07 +00004927 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004928 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004929 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004930 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004931 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004932 pPager->stmtInUse = 1;
4933 pPager->stmtSize = pPager->dbSize;
4934 return SQLITE_OK;
4935 }
drhda47d772002-12-02 04:25:19 +00004936 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004937 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004938 return SQLITE_OK;
4939 }
drhfa86c412002-02-02 15:01:15 +00004940 assert( pPager->journalOpen );
drhed138fb2007-08-22 22:04:37 +00004941 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004942 assert( pPager->pInStmt==0 );
4943 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00004944 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004945 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004946 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004947 return SQLITE_NOMEM;
4948 }
danielk197776572402004-06-25 02:38:54 +00004949 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004950 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004951 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004952 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004953 if( !pPager->stmtOpen ){
drh334b2992007-09-06 23:28:23 +00004954 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, pPager->zStmtJrnl,
drh33f4e022007-09-03 15:19:34 +00004955 SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00004956 if( rc ){
4957 goto stmt_begin_failed;
4958 }
drhac69b052004-05-12 13:30:07 +00004959 pPager->stmtOpen = 1;
4960 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004961 }
drhac69b052004-05-12 13:30:07 +00004962 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004963 return SQLITE_OK;
4964
drhac69b052004-05-12 13:30:07 +00004965stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00004966 if( pPager->pInStmt ){
4967 sqlite3BitvecDestroy(pPager->pInStmt);
4968 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004969 }
4970 return rc;
4971}
drh86f8c192007-08-22 00:39:19 +00004972int sqlite3PagerStmtBegin(Pager *pPager){
4973 int rc;
4974 pagerEnter(pPager);
4975 rc = pagerStmtBegin(pPager);
4976 pagerLeave(pPager);
4977 return rc;
4978}
drhfa86c412002-02-02 15:01:15 +00004979
4980/*
drhac69b052004-05-12 13:30:07 +00004981** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004982*/
danielk19773b8a05f2007-03-19 17:44:26 +00004983int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00004984 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004985 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004986 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004987 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004988 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004989 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhf5e7bb52008-02-18 14:47:33 +00004990 sqlite3BitvecDestroy(pPager->pInStmt);
4991 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004992 }else{
4993 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004994 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004995 pNext = pHist->pNextStmt;
4996 assert( pHist->inStmt );
4997 pHist->inStmt = 0;
4998 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00004999 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00005000 pHist->pStmt = 0;
5001 }
5002 }
5003 pPager->stmtNRec = 0;
5004 pPager->stmtInUse = 0;
5005 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00005006 }
drhac69b052004-05-12 13:30:07 +00005007 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00005008 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00005009 return SQLITE_OK;
5010}
5011
5012/*
drhac69b052004-05-12 13:30:07 +00005013** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00005014*/
danielk19773b8a05f2007-03-19 17:44:26 +00005015int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00005016 int rc;
drh86f8c192007-08-22 00:39:19 +00005017 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00005018 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00005019 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00005020 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00005021 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00005022 PgHistory *pHist;
5023 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
5024 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00005025 if( pHist->pStmt ){
5026 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00005027 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00005028 pHist->pStmt = 0;
5029 }
5030 }
5031 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00005032 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00005033 rc = SQLITE_OK;
5034 }else{
5035 rc = pager_stmt_playback(pPager);
5036 }
danielk19773b8a05f2007-03-19 17:44:26 +00005037 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00005038 }else{
5039 rc = SQLITE_OK;
5040 }
drhac69b052004-05-12 13:30:07 +00005041 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00005042 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00005043 return rc;
5044}
5045
drh73509ee2003-04-06 20:44:45 +00005046/*
5047** Return the full pathname of the database file.
5048*/
danielk19773b8a05f2007-03-19 17:44:26 +00005049const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00005050 return pPager->zFilename;
5051}
5052
drhb20ea9d2004-02-09 01:20:36 +00005053/*
drhd0679ed2007-08-28 22:24:34 +00005054** Return the VFS structure for the pager.
5055*/
5056const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
5057 return pPager->pVfs;
5058}
5059
5060/*
drhcc6bb3e2007-08-31 16:11:35 +00005061** Return the file handle for the database file associated
5062** with the pager. This might return NULL if the file has
5063** not yet been opened.
5064*/
5065sqlite3_file *sqlite3PagerFile(Pager *pPager){
5066 return pPager->fd;
5067}
5068
5069/*
danielk19775865e3d2004-06-14 06:03:57 +00005070** Return the directory of the database file.
5071*/
danielk19773b8a05f2007-03-19 17:44:26 +00005072const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005073 return pPager->zDirectory;
5074}
5075
5076/*
5077** Return the full pathname of the journal file.
5078*/
danielk19773b8a05f2007-03-19 17:44:26 +00005079const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005080 return pPager->zJournal;
5081}
5082
5083/*
drh2c8997b2005-08-27 16:36:48 +00005084** Return true if fsync() calls are disabled for this pager. Return FALSE
5085** if fsync()s are executed normally.
5086*/
danielk19773b8a05f2007-03-19 17:44:26 +00005087int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00005088 return pPager->noSync;
5089}
5090
drh7c4ac0c2007-04-05 11:25:58 +00005091#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00005092/*
drhb20ea9d2004-02-09 01:20:36 +00005093** Set the codec for this pager
5094*/
danielk19773b8a05f2007-03-19 17:44:26 +00005095void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00005096 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00005097 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00005098 void *pCodecArg
5099){
5100 pPager->xCodec = xCodec;
5101 pPager->pCodecArg = pCodecArg;
5102}
drh7c4ac0c2007-04-05 11:25:58 +00005103#endif
drhb20ea9d2004-02-09 01:20:36 +00005104
danielk1977687566d2004-11-02 12:56:41 +00005105#ifndef SQLITE_OMIT_AUTOVACUUM
5106/*
danielk197787c29a92008-01-18 11:33:16 +00005107** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00005108**
drh5e385312007-06-16 04:42:12 +00005109** There must be no references to the page previously located at
5110** pgno (which we call pPgOld) though that page is allowed to be
5111** in cache. If the page previous located at pgno is not already
5112** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00005113**
drh5e385312007-06-16 04:42:12 +00005114** References to the page pPg remain valid. Updating any
5115** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00005116** allocated along with the page) is the responsibility of the caller.
5117**
danielk19775fd057a2005-03-09 13:09:43 +00005118** A transaction must be active when this routine is called. It used to be
5119** required that a statement transaction was not active, but this restriction
5120** has been removed (CREATE INDEX needs to move a page when a statement
5121** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00005122*/
danielk19773b8a05f2007-03-19 17:44:26 +00005123int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00005124 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00005125 int h;
danielk197794daf7f2004-11-08 09:26:09 +00005126 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00005127
drh86f8c192007-08-22 00:39:19 +00005128 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005129 assert( pPg->nRef>0 );
5130
drh4f0c5872007-03-26 22:05:01 +00005131 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00005132 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00005133 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00005134
danielk1977b4626a32007-04-28 15:47:43 +00005135 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00005136 if( pPg->needSync ){
5137 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00005138 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00005139 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00005140 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00005141 }
5142
drh85b623f2007-12-13 21:54:09 +00005143 /* Unlink pPg from its hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00005144 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00005145
danielk1977ef73ee92004-11-06 12:26:07 +00005146 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00005147 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00005148 ** page pgno before the 'move' operation, it needs to be retained
5149 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00005150 */
drh5e385312007-06-16 04:42:12 +00005151 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00005152 pPgOld = pager_lookup(pPager, pgno);
5153 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00005154 assert( pPgOld->nRef==0 );
5155 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00005156 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00005157 pPg->needSync = pPgOld->needSync;
5158 }else{
5159 pPg->needSync = 0;
5160 }
drhf5e7bb52008-02-18 14:47:33 +00005161 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
danielk1977687566d2004-11-02 12:56:41 +00005162
danielk1977f5fdda82004-11-03 08:44:05 +00005163 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00005164 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00005165 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00005166 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00005167 if( pPager->aHash[h] ){
5168 assert( pPager->aHash[h]->pPrevHash==0 );
5169 pPager->aHash[h]->pPrevHash = pPg;
5170 }
5171 pPg->pNextHash = pPager->aHash[h];
5172 pPager->aHash[h] = pPg;
5173 pPg->pPrevHash = 0;
5174
drh605ad8f2006-05-03 23:34:05 +00005175 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00005176 pPager->dirtyCache = 1;
5177
danielk197794daf7f2004-11-08 09:26:09 +00005178 if( needSyncPgno ){
5179 /* If needSyncPgno is non-zero, then the journal file needs to be
5180 ** sync()ed before any data is written to database file page needSyncPgno.
5181 ** Currently, no such page exists in the page-cache and the
drhf5e7bb52008-02-18 14:47:33 +00005182 ** Pager.pInJournal bit has been set. This needs to be remedied by loading
danielk197794daf7f2004-11-08 09:26:09 +00005183 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00005184 **
danielk1977a98d7b42008-01-18 13:42:54 +00005185 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00005186 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00005187 ** array. Otherwise, if the page is loaded and written again in
5188 ** this transaction, it may be written to the database file before
5189 ** it is synced into the journal file. This way, it may end up in
5190 ** the journal file twice, but that is not a problem.
5191 **
danielk19773b8a05f2007-03-19 17:44:26 +00005192 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00005193 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00005194 */
5195 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005196 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00005197 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00005198 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00005199 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00005200 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
5201 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00005202 }
danielk197787c29a92008-01-18 11:33:16 +00005203 pagerLeave(pPager);
5204 return rc;
5205 }
danielk1977ae825582004-11-23 09:06:55 +00005206 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00005207 pPgHdr->needSync = 1;
5208 pPgHdr->inJournal = 1;
5209 makeDirty(pPgHdr);
5210 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005211 }
5212
drh86f8c192007-08-22 00:39:19 +00005213 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005214 return SQLITE_OK;
5215}
5216#endif
5217
danielk19773b8a05f2007-03-19 17:44:26 +00005218/*
5219** Return a pointer to the data for the specified page.
5220*/
5221void *sqlite3PagerGetData(DbPage *pPg){
5222 return PGHDR_TO_DATA(pPg);
5223}
5224
5225/*
5226** Return a pointer to the Pager.nExtra bytes of "extra" space
5227** allocated along with the specified page.
5228*/
5229void *sqlite3PagerGetExtra(DbPage *pPg){
5230 Pager *pPager = pPg->pPager;
5231 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
5232}
5233
danielk197741483462007-03-24 16:45:04 +00005234/*
5235** Get/set the locking-mode for this pager. Parameter eMode must be one
5236** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
5237** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
5238** the locking-mode is set to the value specified.
5239**
5240** The returned value is either PAGER_LOCKINGMODE_NORMAL or
5241** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
5242** locking-mode.
5243*/
5244int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00005245 assert( eMode==PAGER_LOCKINGMODE_QUERY
5246 || eMode==PAGER_LOCKINGMODE_NORMAL
5247 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
5248 assert( PAGER_LOCKINGMODE_QUERY<0 );
5249 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
5250 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00005251 pPager->exclusiveMode = eMode;
5252 }
5253 return (int)pPager->exclusiveMode;
5254}
5255
drh3b020132008-04-17 17:02:01 +00005256/*
5257** Get/set the journal-mode for this pager. Parameter eMode must be one
5258** of PAGER_JOURNALMODE_QUERY, PAGER_JOURNALMODE_DELETE or
5259** PAGER_JOURNALMODE_PERSIST. If the parameter is not _QUERY, then
5260** the journal-mode is set to the value specified.
5261**
5262** The returned value is either PAGER_JOURNALMODE_DELETE or
5263** PAGER_JOURNALMODE_PERSIST, indicating the current (possibly updated)
5264** journal-mode.
5265*/
5266int sqlite3PagerJournalMode(Pager *pPager, int eMode){
5267 assert( eMode==PAGER_JOURNALMODE_QUERY
5268 || eMode==PAGER_JOURNALMODE_DELETE
drhfdc40e92008-04-17 20:59:37 +00005269 || eMode==PAGER_JOURNALMODE_PERSIST
5270 || eMode==PAGER_JOURNALMODE_OFF );
drh3b020132008-04-17 17:02:01 +00005271 assert( PAGER_JOURNALMODE_QUERY<0 );
5272 assert( PAGER_JOURNALMODE_DELETE>=0 && PAGER_JOURNALMODE_PERSIST>=0 );
drhfdc40e92008-04-17 20:59:37 +00005273 if( eMode>=0 ){
5274 pPager->journalMode = eMode;
drh3b020132008-04-17 17:02:01 +00005275 }
drhfdc40e92008-04-17 20:59:37 +00005276 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00005277}
5278
drhd919fe12007-12-11 19:34:44 +00005279#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00005280/*
5281** Print a listing of all referenced pages and their ref count.
5282*/
danielk19773b8a05f2007-03-19 17:44:26 +00005283void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00005284 PgHdr *pPg;
5285 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
5286 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00005287 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
5288 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00005289 }
5290}
5291#endif
drh2e66f0b2005-04-28 17:18:48 +00005292
5293#endif /* SQLITE_OMIT_DISKIO */