blob: b0fbcffb544aa7a0a3692cb7449b0f7895c09be7 [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**
danielk1977dd97a492007-08-22 18:54:32 +000021** @(#) $Id: pager.c,v 1.367 2007/08/22 18:54:33 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**
50** PAGERID() takes a pointer to a Pager struct as it's argument. The
danielk197762079062007-08-15 17:08:46 +000051** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
danielk1977599fcba2004-11-08 07:13:13 +000052** struct as it's argument.
53*/
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
134/*
drhed7c8552001-04-11 14:29:21 +0000135** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000136** This header is only visible to this pager module. The client
137** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000138**
danielk19773b8a05f2007-03-19 17:44:26 +0000139** Client code should call sqlite3PagerWrite() on a page prior to making
140** any modifications to that page. The first time sqlite3PagerWrite()
drhf6038712004-02-08 18:07:34 +0000141** is called, the original page contents are written into the rollback
142** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
143** the journal page has made it onto the disk surface, PgHdr.needSync
144** is cleared. The modified page cannot be written back into the original
145** database file until the journal pages has been synced to disk and the
146** PgHdr.needSync has been cleared.
147**
danielk19773b8a05f2007-03-19 17:44:26 +0000148** The PgHdr.dirty flag is set when sqlite3PagerWrite() is called and
drhf6038712004-02-08 18:07:34 +0000149** is cleared again when the page content is written back to the original
150** database file.
drh732c8172007-06-16 11:17:45 +0000151**
152** Details of important structure elements:
153**
154** needSync
155**
156** If this is true, this means that it is not safe to write the page
157** content to the database because the original content needed
158** for rollback has not by synced to the main rollback journal.
159** The original content may have been written to the rollback journal
160** but it has not yet been synced. So we cannot write to the database
161** file because power failure might cause the page in the journal file
162** to never reach the disk. It is as if the write to the journal file
163** does not occur until the journal file is synced.
164**
165** This flag is false if the page content exactly matches what
166** currently exists in the database file. The needSync flag is also
167** false if the original content has been written to the main rollback
168** journal and synced. If the page represents a new page that has
169** been added onto the end of the database during the current
170** transaction, the needSync flag is true until the original database
171** size in the journal header has been synced to disk.
172**
173** inJournal
174**
175** This is true if the original page has been written into the main
176** rollback journal. This is always false for new pages added to
177** the end of the database file during the current transaction.
178** And this flag says nothing about whether or not the journal
179** has been synced to disk. For pages that are in the original
180** database file, the following expression should always be true:
181**
182** inJournal = (pPager->aInJournal[(pgno-1)/8] & (1<<((pgno-1)%8))!=0
183**
184** The pPager->aInJournal[] array is only valid for the original
185** pages of the database, not new pages that are added to the end
186** of the database, so obviously the above expression cannot be
187** valid for new pages. For new pages inJournal is always 0.
188**
189** dirty
190**
191** When true, this means that the content of the page has been
192** modified and needs to be written back to the database file.
193** If false, it means that either the content of the page is
194** unchanged or else the content is unimportant and we do not
195** care whether or not it is preserved.
196**
197** alwaysRollback
198**
199** This means that the sqlite3PagerDontRollback() API should be
200** ignored for this page. The DontRollback() API attempts to say
201** that the content of the page on disk is unimportant (it is an
202** unused page on the freelist) so that it is unnecessary to
203** rollback changes to this page because the content of the page
204** can change without changing the meaning of the database. This
205** flag overrides any DontRollback() attempt. This flag is set
206** when a page that originally contained valid data is added to
207** the freelist. Later in the same transaction, this page might
208** be pulled from the freelist and reused for something different
209** and at that point the DontRollback() API will be called because
210** pages taken from the freelist do not need to be protected by
211** the rollback journal. But this flag says that the page was
212** not originally part of the freelist so that it still needs to
213** be rolled back in spite of any subsequent DontRollback() calls.
214**
215** needRead
216**
217** This flag means (when true) that the content of the page has
218** not yet been loaded from disk. The in-memory content is just
219** garbage. (Actually, we zero the content, but you should not
220** make any assumptions about the content nevertheless.) If the
221** content is needed in the future, it should be read from the
222** original database file.
drhed7c8552001-04-11 14:29:21 +0000223*/
drhd9b02572001-04-15 00:37:09 +0000224typedef struct PgHdr PgHdr;
drhed7c8552001-04-11 14:29:21 +0000225struct PgHdr {
226 Pager *pPager; /* The pager to which this page belongs */
227 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000228 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
drhd9b02572001-04-15 00:37:09 +0000229 PgHdr *pNextFree, *pPrevFree; /* Freelist of pages where nRef==0 */
drhac69b052004-05-12 13:30:07 +0000230 PgHdr *pNextAll; /* A list of all pages */
drh193a6b42002-07-07 16:52:46 +0000231 u8 inJournal; /* TRUE if has been written to journal */
drh193a6b42002-07-07 16:52:46 +0000232 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000233 u8 needSync; /* Sync journal before writing this page */
drh80e35f42007-03-30 14:06:34 +0000234 u8 alwaysRollback; /* Disable DontRollback() for this page */
drh538f5702007-04-13 02:14:30 +0000235 u8 needRead; /* Read content if PagerWrite() is called */
drhac69b052004-05-12 13:30:07 +0000236 short int nRef; /* Number of users of this page */
drhdc3e10b2006-06-15 14:31:06 +0000237 PgHdr *pDirty, *pPrevDirty; /* Dirty pages */
drh605ad8f2006-05-03 23:34:05 +0000238 u32 notUsed; /* Buffer space */
danielk19773c407372005-02-15 02:54:14 +0000239#ifdef SQLITE_CHECK_PAGES
240 u32 pageHash;
241#endif
drh1c7880e2005-05-20 20:01:55 +0000242 /* pPager->pageSize bytes of page data follow this header */
drh973b6e32003-02-12 14:09:42 +0000243 /* Pager.nExtra bytes of local data follow the page data */
drhed7c8552001-04-11 14:29:21 +0000244};
245
drhac69b052004-05-12 13:30:07 +0000246/*
247** For an in-memory only database, some extra information is recorded about
248** each page so that changes can be rolled back. (Journal files are not
249** used for in-memory databases.) The following information is added to
250** the end of every EXTRA block for in-memory databases.
251**
252** This information could have been added directly to the PgHdr structure.
253** But then it would take up an extra 8 bytes of storage on every PgHdr
254** even for disk-based databases. Splitting it out saves 8 bytes. This
255** is only a savings of 0.8% but those percentages add up.
256*/
257typedef struct PgHistory PgHistory;
258struct PgHistory {
259 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
260 u8 *pStmt; /* Text as it was at the beginning of the current statement */
danielk1977f35843b2007-04-07 15:03:17 +0000261 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
262 u8 inStmt; /* TRUE if in the statement subjournal */
drhac69b052004-05-12 13:30:07 +0000263};
drh9eb9e262004-02-11 02:18:05 +0000264
265/*
266** A macro used for invoking the codec if there is one
267*/
268#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000269# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
270# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000271#else
drhc001c582006-03-06 18:23:16 +0000272# define CODEC1(P,D,N,X) /* NO-OP */
273# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000274#endif
275
drhed7c8552001-04-11 14:29:21 +0000276/*
drh69688d52001-04-14 16:38:23 +0000277** Convert a pointer to a PgHdr into a pointer to its data
278** and back again.
drhed7c8552001-04-11 14:29:21 +0000279*/
280#define PGHDR_TO_DATA(P) ((void*)(&(P)[1]))
281#define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1])
drh1c7880e2005-05-20 20:01:55 +0000282#define PGHDR_TO_EXTRA(G,P) ((void*)&((char*)(&(G)[1]))[(P)->pageSize])
drhac69b052004-05-12 13:30:07 +0000283#define PGHDR_TO_HIST(P,PGR) \
drh1c7880e2005-05-20 20:01:55 +0000284 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->pageSize+(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000285
286/*
drhed7c8552001-04-11 14:29:21 +0000287** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000288**
drh4f0ee682007-03-30 20:43:40 +0000289** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000290** or SQLITE_FULL. Once one of the first three errors occurs, it persists
291** and is returned as the result of every major pager API call. The
292** SQLITE_FULL return code is slightly different. It persists only until the
293** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000294** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000295** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000296*/
297struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000298 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000299 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000300 u8 journalStarted; /* True if header of journal is synced */
301 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000302 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000303 u8 stmtOpen; /* True if the statement subjournal is open */
304 u8 stmtInUse; /* True we are in a statement subtransaction */
305 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000306 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000307 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000308 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000309 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000310 u8 tempFile; /* zFilename is a temporary file */
311 u8 readOnly; /* True for a read-only database */
312 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000313 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000314 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000315 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000316 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000317 u8 doNotSync; /* Boolean. While true, do not spill the cache */
318 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
319 u8 changeCountDone; /* Set after incrementing the change-counter */
drhe49f9822006-09-15 12:29:16 +0000320 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000321 int dbSize; /* Number of pages in the file */
322 int origDbSize; /* dbSize before the current change */
323 int stmtSize; /* Size of database (in pages) at stmt_begin() */
324 int nRec; /* Number of pages written to the journal */
325 u32 cksumInit; /* Quasi-random value added to every checksum */
326 int stmtNRec; /* Number of records in stmt subjournal */
327 int nExtra; /* Add this many bytes to each in-memory page */
328 int pageSize; /* Number of bytes in a page */
329 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000330 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
331 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000332 Pgno mxPgno; /* Maximum allowed size of the database */
drh603240c2002-03-05 01:11:12 +0000333 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000334 u8 *aInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000335 char *zFilename; /* Name of the database file */
336 char *zJournal; /* Name of the journal file */
337 char *zDirectory; /* Directory hold database and journal files */
danielk197762079062007-08-15 17:08:46 +0000338 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
339 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000340 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000341 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000342 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000343 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000344 PgHdr *pStmt; /* List of pages in the statement subjournal */
drh605ad8f2006-05-03 23:34:05 +0000345 PgHdr *pDirty; /* List of all dirty pages */
drheb206252004-10-01 02:00:31 +0000346 i64 journalOff; /* Current byte offset in the journal file */
347 i64 journalHdr; /* Byte offset to previous journal header */
348 i64 stmtHdrOff; /* First journal header written this statement */
349 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000350 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000351 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000352#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000353 int nHit, nMiss; /* Cache hits and missing */
354 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000355#endif
danielk19773b8a05f2007-03-19 17:44:26 +0000356 void (*xDestructor)(DbPage*,int); /* Call this routine when freeing pages */
357 void (*xReiniter)(DbPage*,int); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000358#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000359 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000360 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000361#endif
drh8ca0c722006-05-07 17:49:38 +0000362 int nHash; /* Size of the pager hash table */
363 PgHdr **aHash; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000364#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +0000365 Pager *pNext; /* Doubly linked list of pagers on which */
366 Pager *pPrev; /* sqlite3_release_memory() will work */
367 int iInUseMM; /* Non-zero if unavailable to MM */
368 int iInUseDB; /* Non-zero if in sqlite3_release_memory() */
danielk197713f72992005-12-18 08:51:22 +0000369#endif
danielk19778186df82007-03-06 13:45:59 +0000370 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000371 char dbFileVers[16]; /* Changes whenever database file changes */
drhd9b02572001-04-15 00:37:09 +0000372};
373
374/*
drh538f5702007-04-13 02:14:30 +0000375** The following global variables hold counters used for
376** testing purposes only. These variables do not exist in
377** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000378*/
379#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000380int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
381int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
382int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
383int sqlite3_pager_pgfree_count = 0; /* Number of cache pages freed */
384# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000385#else
drh538f5702007-04-13 02:14:30 +0000386# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000387#endif
388
drh86f8c192007-08-22 00:39:19 +0000389/*
390** The following variable points to the head of a double-linked list
391** of all pagers that are eligible for page stealing by the
392** sqlite3_release_memory() interface. Access to this list is
393** protected by the SQLITE_MUTEX_STATIC_MEM2 mutex.
394*/
395#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
396static Pager *sqlite3PagerList = 0;
397#endif
drh538f5702007-04-13 02:14:30 +0000398
399
drhfcd35c72005-05-21 02:48:08 +0000400/*
drh5e00f6c2001-09-13 13:46:56 +0000401** Journal files begin with the following magic string. The data
402** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000403**
drhae2b40c2004-06-09 19:03:54 +0000404** Since version 2.8.0, the journal format contains additional sanity
405** checking information. If the power fails while the journal is begin
406** written, semi-random garbage data might appear in the journal
407** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000408** to roll the journal back, the database could be corrupted. The additional
409** sanity checking data is an attempt to discover the garbage in the
410** journal and ignore it.
411**
drhae2b40c2004-06-09 19:03:54 +0000412** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000413** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000414** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000415** This cksum is initialized to a 32-bit random value that appears in the
416** journal file right after the header. The random initializer is important,
417** because garbage data that appears at the end of a journal is likely
418** data that was once in other files that have now been deleted. If the
419** garbage data came from an obsolete journal file, the checksums might
420** be correct. But by initializing the checksum to random value which
421** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000422*/
drhae2b40c2004-06-09 19:03:54 +0000423static const unsigned char aJournalMagic[] = {
424 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000425};
426
427/*
drh726de592004-06-10 23:35:50 +0000428** The size of the header and of each page in the journal is determined
429** by the following macros.
drh968af522003-02-11 14:55:40 +0000430*/
drhae2b40c2004-06-09 19:03:54 +0000431#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000432
danielk197776572402004-06-25 02:38:54 +0000433/*
434** The journal header size for this pager. In the future, this could be
435** set to some value read from the disk controller. The important
436** characteristic is that it is the same size as a disk sector.
437*/
438#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
439
drhb7f91642004-10-31 02:22:47 +0000440/*
441** The macro MEMDB is true if we are dealing with an in-memory database.
442** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
443** the value of MEMDB will be a constant and the compiler will optimize
444** out code that would never execute.
445*/
446#ifdef SQLITE_OMIT_MEMORYDB
447# define MEMDB 0
448#else
449# define MEMDB pPager->memDb
450#endif
451
452/*
danielk197776572402004-06-25 02:38:54 +0000453** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
454** reserved for working around a windows/posix incompatibility). It is
455** used in the journal to signify that the remainder of the journal file
456** is devoted to storing a master journal name - there are no more pages to
457** roll back. See comments for function writeMasterJournal() for details.
458*/
danielk1977599fcba2004-11-08 07:13:13 +0000459/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
460#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000461
drh968af522003-02-11 14:55:40 +0000462/*
danielk197726836652005-01-17 01:33:13 +0000463** The maximum legal page number is (2^31 - 1).
464*/
465#define PAGER_MAX_PGNO 2147483647
466
467/*
drh86f8c192007-08-22 00:39:19 +0000468** The pagerEnter() and pagerLeave() routines acquire and release
469** a mutex on each pager. The mutex is recursive.
470**
471** This is a special-purpose mutex. It only provides mutual exclusion
472** between the Btree and the Memory Management sqlite3_release_memory()
473** function. It does not prevent, for example, two Btrees from accessing
474** the same pager at the same time. Other general-purpose mutexes in
475** the btree layer handle that chore.
476*/
477#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
478 static void pagerEnter(Pager *p){
479 p->iInUseDB++;
480 if( p->iInUseMM && p->iInUseDB==1 ){
481 sqlite3_mutex *mutex;
482 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
483 p->iInUseDB = 0;
484 sqlite3_mutex_enter(mutex);
485 p->iInUseDB = 1;
486 sqlite3_mutex_leave(mutex);
487 }
488 assert( p->iInUseMM==0 );
489 }
490 static void pagerLeave(Pager *p){
491 p->iInUseDB--;
492 assert( p->iInUseDB>=0 );
493 }
494#else
495# define pagerEnter(X)
496# define pagerLeave(X)
497#endif
498
499/*
drh726de592004-06-10 23:35:50 +0000500** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000501*/
drh7c4ac0c2007-04-05 11:25:58 +0000502#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000503 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000504 static void pager_refinfo(PgHdr *p){
505 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000506 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000507 sqlite3DebugPrintf(
drh24c9a2e2007-01-05 02:00:47 +0000508 "REFCNT: %4d addr=%p nRef=%-3d total=%d\n",
509 p->pgno, PGHDR_TO_DATA(p), p->nRef, p->pPager->nRef
drhdd793422001-06-28 01:54:48 +0000510 );
511 cnt++; /* Something to set a breakpoint on */
512 }
513# define REFINFO(X) pager_refinfo(X)
514#else
515# define REFINFO(X)
516#endif
517
danielk1977f35843b2007-04-07 15:03:17 +0000518/*
519** Return true if page *pPg has already been written to the statement
520** journal (or statement snapshot has been created, if *pPg is part
521** of an in-memory database).
522*/
523static int pageInStatement(PgHdr *pPg){
524 Pager *pPager = pPg->pPager;
525 if( MEMDB ){
526 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
527 }else{
528 Pgno pgno = pPg->pgno;
529 u8 *a = pPager->aInStmt;
530 return (a && (int)pgno<=pPager->stmtSize && (a[pgno/8] & (1<<(pgno&7))));
531 }
532}
drh8ca0c722006-05-07 17:49:38 +0000533
534/*
535** Change the size of the pager hash table to N. N must be a power
536** of two.
537*/
538static void pager_resize_hash_table(Pager *pPager, int N){
539 PgHdr **aHash, *pPg;
540 assert( N>0 && (N&(N-1))==0 );
drh17435752007-08-16 04:30:38 +0000541 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drh8ca0c722006-05-07 17:49:38 +0000542 if( aHash==0 ){
543 /* Failure to rehash is not an error. It is only a performance hit. */
544 return;
545 }
drh17435752007-08-16 04:30:38 +0000546 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000547 pPager->nHash = N;
548 pPager->aHash = aHash;
549 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000550 int h;
551 if( pPg->pgno==0 ){
552 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
553 continue;
554 }
555 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000556 pPg->pNextHash = aHash[h];
557 if( aHash[h] ){
558 aHash[h]->pPrevHash = pPg;
559 }
560 aHash[h] = pPg;
561 pPg->pPrevHash = 0;
562 }
563}
564
drhdd793422001-06-28 01:54:48 +0000565/*
drh34e79ce2004-02-08 06:05:46 +0000566** Read a 32-bit integer from the given file descriptor. Store the integer
567** that is read in *pRes. Return SQLITE_OK if everything worked, or an
568** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000569**
570** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000571*/
danielk197762079062007-08-15 17:08:46 +0000572static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000573 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000574 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000575 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000576 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000577 }
drh94f33312002-08-12 12:29:56 +0000578 return rc;
579}
580
581/*
drh97b57482006-01-10 20:32:32 +0000582** Write a 32-bit integer into a string buffer in big-endian byte order.
583*/
drha3152892007-05-05 11:48:52 +0000584#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000585
586/*
drh34e79ce2004-02-08 06:05:46 +0000587** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
588** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000589*/
danielk197762079062007-08-15 17:08:46 +0000590static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000591 char ac[4];
drh97b57482006-01-10 20:32:32 +0000592 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000593 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000594}
595
drh2554f8b2003-01-22 01:26:44 +0000596/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000597** If file pFd is open, call sqlite3OsUnlock() on it.
598*/
599static int osUnlock(sqlite3_file *pFd, int eLock){
600 if( !pFd->pMethods ){
601 return SQLITE_OK;
602 }
603 return sqlite3OsUnlock(pFd, eLock);
604}
605
606/*
danielk1977c7b60172007-08-22 11:22:03 +0000607** This function determines whether or not the atomic-write optimization
608** can be used with this pager. The optimization can be used if:
609**
610** (a) the value returned by OsDeviceCharacteristics() indicates that
611** a database page may be written atomically, and
612** (b) the value returned by OsSectorSize() is less than or equal
613** to the page size.
614**
615** If the optimization cannot be used, 0 is returned. If it can be used,
616** then the value returned is the size of the journal file when it
617** contains rollback data for exactly one page.
618*/
619#ifdef SQLITE_ENABLE_ATOMIC_WRITE
620static int jrnlBufferSize(Pager *pPager){
621 int dc; /* Device characteristics */
622 int nSector; /* Sector size */
623 int nPage; /* Page size */
624 sqlite3_file *fd = pPager->fd;
625
626 if( fd->pMethods ){
627 dc = sqlite3OsDeviceCharacteristics(fd);
628 nSector = sqlite3OsSectorSize(fd);
629 nPage = pPager->pageSize;
630 }
631
632 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
633 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
634
635 if( !fd->pMethods || (dc&(SQLITE_IOCAP_ATOMIC|(nPage<<8))&&nSector<=nPage) ){
636 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
637 }
638 return 0;
639}
640#endif
641
642/*
danielk1977aef0bf62005-12-30 16:28:01 +0000643** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000644** code. The first argument is a pointer to the pager structure, the
645** second the error-code about to be returned by a pager API function.
646** The value returned is a copy of the second argument to this function.
647**
drh4f0ee682007-03-30 20:43:40 +0000648** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977a96a7102006-01-16 12:46:41 +0000649** the error becomes persistent. All subsequent API calls on this Pager
650** will immediately return the same error code.
danielk1977aef0bf62005-12-30 16:28:01 +0000651*/
652static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000653 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000654 assert(
655 pPager->errCode==SQLITE_FULL ||
656 pPager->errCode==SQLITE_OK ||
657 (pPager->errCode & 0xff)==SQLITE_IOERR
658 );
danielk1977979f38e2007-03-27 16:19:51 +0000659 if(
drh4ac285a2006-09-15 07:28:50 +0000660 rc2==SQLITE_FULL ||
661 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000662 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000663 ){
664 pPager->errCode = rc;
danielk1977aef0bf62005-12-30 16:28:01 +0000665 }
666 return rc;
667}
668
drh477731b2007-06-16 03:06:27 +0000669/*
670** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
671** on the cache using a hash function. This is used for testing
672** and debugging only.
673*/
danielk19773c407372005-02-15 02:54:14 +0000674#ifdef SQLITE_CHECK_PAGES
675/*
676** Return a 32-bit hash of the page data for pPage.
677*/
drh477731b2007-06-16 03:06:27 +0000678static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000679 u32 hash = 0;
680 int i;
drh477731b2007-06-16 03:06:27 +0000681 for(i=0; i<nByte; i++){
682 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000683 }
684 return hash;
685}
drh477731b2007-06-16 03:06:27 +0000686static u32 pager_pagehash(PgHdr *pPage){
687 return pager_datahash(pPage->pPager->pageSize,
688 (unsigned char *)PGHDR_TO_DATA(pPage));
689}
danielk19773c407372005-02-15 02:54:14 +0000690
691/*
692** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
693** is defined, and NDEBUG is not defined, an assert() statement checks
694** that the page is either dirty or still matches the calculated page-hash.
695*/
696#define CHECK_PAGE(x) checkPage(x)
697static void checkPage(PgHdr *pPg){
698 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000699 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000700 pPg->pageHash==pager_pagehash(pPg) );
701}
702
703#else
drh8ffa8172007-06-18 17:25:17 +0000704#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000705#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000706#define CHECK_PAGE(x)
707#endif
708
drhed7c8552001-04-11 14:29:21 +0000709/*
danielk197776572402004-06-25 02:38:54 +0000710** When this is called the journal file for pager pPager must be open.
711** The master journal file name is read from the end of the file and
drh17435752007-08-16 04:30:38 +0000712** written into memory obtained from sqlite3_malloc(). *pzMaster is
danielk197776572402004-06-25 02:38:54 +0000713** set to point at the memory and SQLITE_OK returned. The caller must
drh17435752007-08-16 04:30:38 +0000714** sqlite3_free() *pzMaster.
danielk197776572402004-06-25 02:38:54 +0000715**
716** If no master journal file name is present *pzMaster is set to 0 and
717** SQLITE_OK returned.
718*/
danielk197762079062007-08-15 17:08:46 +0000719static int readMasterJournal(sqlite3_file *pJrnl, char **pzMaster){
danielk197776572402004-06-25 02:38:54 +0000720 int rc;
721 u32 len;
drheb206252004-10-01 02:00:31 +0000722 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000723 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000724 int i;
danielk197776572402004-06-25 02:38:54 +0000725 unsigned char aMagic[8]; /* A buffer to hold the magic header */
726
727 *pzMaster = 0;
728
drh054889e2005-11-30 03:20:31 +0000729 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000730 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000731
danielk197762079062007-08-15 17:08:46 +0000732 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000733 if( rc!=SQLITE_OK ) return rc;
734
danielk197762079062007-08-15 17:08:46 +0000735 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000736 if( rc!=SQLITE_OK ) return rc;
737
danielk197762079062007-08-15 17:08:46 +0000738 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000739 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
740
drh17435752007-08-16 04:30:38 +0000741 *pzMaster = (char *)sqlite3MallocZero(len+1);
danielk197776572402004-06-25 02:38:54 +0000742 if( !*pzMaster ){
743 return SQLITE_NOMEM;
744 }
danielk197762079062007-08-15 17:08:46 +0000745 rc = sqlite3OsRead(pJrnl, *pzMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000746 if( rc!=SQLITE_OK ){
drh17435752007-08-16 04:30:38 +0000747 sqlite3_free(*pzMaster);
danielk197776572402004-06-25 02:38:54 +0000748 *pzMaster = 0;
749 return rc;
750 }
danielk1977cafadba2004-06-25 11:11:54 +0000751
752 /* See if the checksum matches the master journal name */
753 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000754 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000755 }
danielk19778191bff2004-06-28 04:52:30 +0000756 if( cksum ){
757 /* If the checksum doesn't add up, then one or more of the disk sectors
758 ** containing the master journal filename is corrupted. This means
759 ** definitely roll back, so just return SQLITE_OK and report a (nul)
760 ** master-journal filename.
761 */
drh17435752007-08-16 04:30:38 +0000762 sqlite3_free(*pzMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000763 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000764 }else{
765 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000766 }
danielk197776572402004-06-25 02:38:54 +0000767
768 return SQLITE_OK;
769}
770
771/*
772** Seek the journal file descriptor to the next sector boundary where a
773** journal header may be read or written. Pager.journalOff is updated with
774** the new seek offset.
775**
776** i.e for a sector size of 512:
777**
778** Input Offset Output Offset
779** ---------------------------------------
780** 0 0
781** 512 512
782** 100 512
783** 2000 2048
784**
785*/
danielk197762079062007-08-15 17:08:46 +0000786static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000787 i64 offset = 0;
788 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000789 if( c ){
790 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
791 }
792 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
793 assert( offset>=c );
794 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
795 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000796}
797
798/*
799** The journal file must be open when this routine is called. A journal
800** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
801** current location.
802**
803** The format for the journal header is as follows:
804** - 8 bytes: Magic identifying journal format.
805** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
806** - 4 bytes: Random number used for page hash.
807** - 4 bytes: Initial database page count.
808** - 4 bytes: Sector size used by the process that wrote this journal.
809**
danielk1977f42f25c2004-06-25 07:21:28 +0000810** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000811*/
812static int writeJournalHdr(Pager *pPager){
drh97b57482006-01-10 20:32:32 +0000813 char zHeader[sizeof(aJournalMagic)+16];
danielk19774099f6e2007-03-19 11:25:20 +0000814 int rc;
danielk197776572402004-06-25 02:38:54 +0000815
danielk19774099f6e2007-03-19 11:25:20 +0000816 if( pPager->stmtHdrOff==0 ){
817 pPager->stmtHdrOff = pPager->journalOff;
818 }
819
danielk197762079062007-08-15 17:08:46 +0000820 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000821 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000822
823 /* FIX ME:
824 **
825 ** Possibly for a pager not in no-sync mode, the journal magic should not
826 ** be written until nRec is filled in as part of next syncJournal().
827 **
828 ** Actually maybe the whole journal header should be delayed until that
829 ** point. Think about this.
830 */
drh97b57482006-01-10 20:32:32 +0000831 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
832 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
833 put32bits(&zHeader[sizeof(aJournalMagic)], pPager->noSync ? 0xffffffff : 0);
834 /* The random check-hash initialiser */
835 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
836 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
837 /* The initial database size */
838 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
839 /* The assumed sector size for this process */
840 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
drhb0603412007-02-28 04:47:26 +0000841 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, sizeof(zHeader)))
danielk197762079062007-08-15 17:08:46 +0000842 rc = sqlite3OsWrite(pPager->jfd, zHeader, sizeof(zHeader),pPager->journalOff);
843 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197776572402004-06-25 02:38:54 +0000844
845 /* The journal header has been written successfully. Seek the journal
846 ** file descriptor to the end of the journal header sector.
847 */
848 if( rc==SQLITE_OK ){
drhb0603412007-02-28 04:47:26 +0000849 IOTRACE(("JTAIL %p %lld\n", pPager, pPager->journalOff-1))
danielk197762079062007-08-15 17:08:46 +0000850 rc = sqlite3OsWrite(pPager->jfd, "\000", 1, pPager->journalOff-1);
danielk197776572402004-06-25 02:38:54 +0000851 }
852 return rc;
853}
854
855/*
856** The journal file must be open when this is called. A journal header file
857** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
858** file. See comments above function writeJournalHdr() for a description of
859** the journal header format.
860**
861** If the header is read successfully, *nRec is set to the number of
862** page records following this header and *dbSize is set to the size of the
863** database before the transaction began, in pages. Also, pPager->cksumInit
864** is set to the value read from the journal header. SQLITE_OK is returned
865** in this case.
866**
867** If the journal header file appears to be corrupted, SQLITE_DONE is
868** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
869** cannot be read from the journal file an error code is returned.
870*/
871static int readJournalHdr(
872 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000873 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000874 u32 *pNRec,
875 u32 *pDbSize
876){
877 int rc;
878 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000879 i64 jrnlOff;
danielk197776572402004-06-25 02:38:54 +0000880
danielk197762079062007-08-15 17:08:46 +0000881 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000882 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
883 return SQLITE_DONE;
884 }
danielk197762079062007-08-15 17:08:46 +0000885 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000886
danielk197762079062007-08-15 17:08:46 +0000887 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000888 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000889 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000890
891 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
892 return SQLITE_DONE;
893 }
894
danielk197762079062007-08-15 17:08:46 +0000895 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000896 if( rc ) return rc;
897
danielk197762079062007-08-15 17:08:46 +0000898 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000899 if( rc ) return rc;
900
danielk197762079062007-08-15 17:08:46 +0000901 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000902 if( rc ) return rc;
903
904 /* Update the assumed sector-size to match the value used by
905 ** the process that created this journal. If this journal was
906 ** created by a process other than this one, then this routine
907 ** is being called from within pager_playback(). The local value
908 ** of Pager.sectorSize is restored at the end of that routine.
909 */
danielk197762079062007-08-15 17:08:46 +0000910 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000911 if( rc ) return rc;
912
913 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +0000914 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000915}
916
917
918/*
919** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000920** pPager at the current location. The master journal name must be the last
921** thing written to a journal file. If the pager is in full-sync mode, the
922** journal file descriptor is advanced to the next sector boundary before
923** anything is written. The format is:
924**
925** + 4 bytes: PAGER_MJ_PGNO.
926** + N bytes: length of master journal name.
927** + 4 bytes: N
928** + 4 bytes: Master journal name checksum.
929** + 8 bytes: aJournalMagic[].
930**
931** The master journal page checksum is the sum of the bytes in the master
932** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000933**
934** If zMaster is a NULL pointer (occurs for a single database transaction),
935** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000936*/
937static int writeMasterJournal(Pager *pPager, const char *zMaster){
938 int rc;
939 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000940 int i;
danielk197762079062007-08-15 17:08:46 +0000941 i64 jrnlOff;
drh97b57482006-01-10 20:32:32 +0000942 u32 cksum = 0;
943 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000944
945 if( !zMaster || pPager->setMaster) return SQLITE_OK;
946 pPager->setMaster = 1;
947
948 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000949 for(i=0; i<len; i++){
950 cksum += zMaster[i];
951 }
danielk197776572402004-06-25 02:38:54 +0000952
953 /* If in full-sync mode, advance to the next disk sector before writing
954 ** the master journal name. This is in case the previous page written to
955 ** the journal has already been synced.
956 */
957 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000958 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000959 }
danielk197762079062007-08-15 17:08:46 +0000960 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000961 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000962
danielk197762079062007-08-15 17:08:46 +0000963 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000964 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000965 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000966
danielk197762079062007-08-15 17:08:46 +0000967 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000968 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000969 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000970
drh97b57482006-01-10 20:32:32 +0000971 put32bits(zBuf, len);
972 put32bits(&zBuf[4], cksum);
973 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000974 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
drh2c8997b2005-08-27 16:36:48 +0000975 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +0000976 return rc;
977}
978
979/*
drh03eb96a2002-11-10 23:32:56 +0000980** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000981** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000982**
983** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +0000984** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +0000985** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000986** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000987*/
drh3aac2dd2004-04-26 14:10:20 +0000988static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000989 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +0000990 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
991 assert( MEMDB );
992 if( !pHist->inStmt ){
993 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
994 if( pPager->pStmt ){
995 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
996 }
997 pHist->pNextStmt = pPager->pStmt;
998 pPager->pStmt = pPg;
999 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +00001000 }
drh03eb96a2002-11-10 23:32:56 +00001001}
1002
1003/*
drhed7c8552001-04-11 14:29:21 +00001004** Find a page in the hash table given its page number. Return
1005** a pointer to the page or NULL if not found.
1006*/
drhd9b02572001-04-15 00:37:09 +00001007static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +00001008 PgHdr *p;
1009 if( pPager->aHash==0 ) return 0;
1010 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +00001011 while( p && p->pgno!=pgno ){
1012 p = p->pNextHash;
1013 }
1014 return p;
1015}
1016
1017/*
drh1aa2d8b2007-01-03 15:34:29 +00001018** Unlock the database file.
drh1aa2d8b2007-01-03 15:34:29 +00001019*/
1020static void pager_unlock(Pager *pPager){
danielk197741483462007-03-24 16:45:04 +00001021 if( !pPager->exclusiveMode ){
1022 if( !MEMDB ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001023 osUnlock(pPager->fd, NO_LOCK);
danielk197741483462007-03-24 16:45:04 +00001024 pPager->dbSize = -1;
1025 IOTRACE(("UNLOCK %p\n", pPager))
1026 }
1027 pPager->state = PAGER_UNLOCK;
1028 pPager->changeCountDone = 0;
drh1aa2d8b2007-01-03 15:34:29 +00001029 }
danielk1977e277be02007-03-23 18:12:06 +00001030}
1031
1032/*
1033** Execute a rollback if a transaction is active and unlock the
1034** database file. This is a no-op if the pager has already entered
1035** the error-state.
1036*/
danielk1977334cdb62007-03-26 08:05:12 +00001037static void pagerUnlockAndRollback(Pager *p){
1038 if( p->errCode ) return;
danielk1977c5859712007-03-26 12:26:27 +00001039 assert( p->state>=PAGER_RESERVED || p->journalOpen==0 );
danielk1977334cdb62007-03-26 08:05:12 +00001040 if( p->state>=PAGER_RESERVED ){
1041 sqlite3PagerRollback(p);
danielk1977e277be02007-03-23 18:12:06 +00001042 }
danielk1977334cdb62007-03-26 08:05:12 +00001043 pager_unlock(p);
1044 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
1045 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drh1aa2d8b2007-01-03 15:34:29 +00001046}
1047
1048
1049/*
danielk1977e180dd92007-04-05 17:15:52 +00001050** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +00001051** sets the state of the pager back to what it was when it was first
1052** opened. Any outstanding pages are invalidated and subsequent attempts
1053** to access those pages will likely result in a coredump.
1054*/
drhd9b02572001-04-15 00:37:09 +00001055static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00001056 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +00001057 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +00001058 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +00001059 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
1060 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +00001061 pNext = pPg->pNextAll;
drh17435752007-08-16 04:30:38 +00001062 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +00001063 }
danielk1977b94bf852007-03-19 13:53:37 +00001064 pPager->pStmt = 0;
drhed7c8552001-04-11 14:29:21 +00001065 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +00001066 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +00001067 pPager->pLast = 0;
1068 pPager->pAll = 0;
drh8ca0c722006-05-07 17:49:38 +00001069 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +00001070 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +00001071 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +00001072 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +00001073 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +00001074}
1075
1076/*
drh80e35f42007-03-30 14:06:34 +00001077** This routine ends a transaction. A transaction is ended by either
1078** a COMMIT or a ROLLBACK.
1079**
drhed7c8552001-04-11 14:29:21 +00001080** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001081** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1082** the database lock and acquires a SHARED lock in its place if that is
1083** the appropriate thing to do. Release locks usually is appropriate,
1084** unless we are in exclusive access mode or unless this is a
1085** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1086**
1087** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001088**
1089** TODO: Consider keeping the journal file open for temporary databases.
1090** This might give a performance improvement on windows where opening
1091** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001092*/
drh80e35f42007-03-30 14:06:34 +00001093static int pager_end_transaction(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001094 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001095 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001096 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001097 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001098 if( pPager->state<PAGER_RESERVED ){
1099 return SQLITE_OK;
1100 }
danielk19773b8a05f2007-03-19 17:44:26 +00001101 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001102 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001103 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001104 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001105 }
drhda47d772002-12-02 04:25:19 +00001106 if( pPager->journalOpen ){
drh01fa4c32007-04-02 11:22:22 +00001107 if( pPager->exclusiveMode
1108 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){;
danielk197741483462007-03-24 16:45:04 +00001109 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001110 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001111 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001112 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001113 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +00001114 if( rc==SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001115 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001116 }
danielk197741483462007-03-24 16:45:04 +00001117 }
drh17435752007-08-16 04:30:38 +00001118 sqlite3_free( pPager->aInJournal );
drhda47d772002-12-02 04:25:19 +00001119 pPager->aInJournal = 0;
1120 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1121 pPg->inJournal = 0;
1122 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001123 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001124 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001125#ifdef SQLITE_CHECK_PAGES
1126 pPg->pageHash = pager_pagehash(pPg);
1127#endif
drhda47d772002-12-02 04:25:19 +00001128 }
drh605ad8f2006-05-03 23:34:05 +00001129 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001130 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001131 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001132 }else{
drh88b01a12005-03-28 18:04:27 +00001133 assert( pPager->aInJournal==0 );
drha6abd042004-06-09 17:37:22 +00001134 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001135 }
danielk1977979f38e2007-03-27 16:19:51 +00001136
danielk197741483462007-03-24 16:45:04 +00001137 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001138 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001139 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001140 }else if( pPager->state==PAGER_SYNCED ){
1141 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001142 }
danielk1977334cdb62007-03-26 08:05:12 +00001143 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001144 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001145 pPager->needSync = 0;
1146 pPager->pFirstSynced = pPager->pFirst;
drh588f5bc2007-01-02 18:41:54 +00001147 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +00001148
1149 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001150}
1151
drhed7c8552001-04-11 14:29:21 +00001152/*
drh968af522003-02-11 14:55:40 +00001153** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001154**
1155** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001156** random initial value and the page number. We experimented with
1157** a checksum of the entire data, but that was found to be too slow.
1158**
1159** Note that the page number is stored at the beginning of data and
1160** the checksum is stored at the end. This is important. If journal
1161** corruption occurs due to a power failure, the most likely scenario
1162** is that one end or the other of the record will be changed. It is
1163** much less likely that the two ends of the journal record will be
1164** correct and the middle be corrupt. Thus, this "checksum" scheme,
1165** though fast and simple, catches the mostly likely kind of corruption.
1166**
1167** FIX ME: Consider adding every 200th (or so) byte of the data to the
1168** checksum. That way if a single page spans 3 or more disk sectors and
1169** only the middle sector is corrupt, we will still have a reasonable
1170** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001171*/
drh74161702006-02-24 02:53:49 +00001172static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001173 u32 cksum = pPager->cksumInit;
1174 int i = pPager->pageSize-200;
1175 while( i>0 ){
1176 cksum += aData[i];
1177 i -= 200;
1178 }
drh968af522003-02-11 14:55:40 +00001179 return cksum;
1180}
1181
drh605ad8f2006-05-03 23:34:05 +00001182/* Forward declaration */
1183static void makeClean(PgHdr*);
1184
drh968af522003-02-11 14:55:40 +00001185/*
drhfa86c412002-02-02 15:01:15 +00001186** Read a single page from the journal file opened on file descriptor
1187** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001188**
drh726de592004-06-10 23:35:50 +00001189** If useCksum==0 it means this journal does not use checksums. Checksums
1190** are not used in statement journals because statement journals do not
1191** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001192*/
danielk197762079062007-08-15 17:08:46 +00001193static int pager_playback_one_page(
1194 Pager *pPager,
1195 sqlite3_file *jfd,
1196 i64 offset,
1197 int useCksum
1198){
drhfa86c412002-02-02 15:01:15 +00001199 int rc;
drhae2b40c2004-06-09 19:03:54 +00001200 PgHdr *pPg; /* An existing page in the cache */
1201 Pgno pgno; /* The page number of a page in journal */
1202 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001203 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001204
drh96362842005-03-20 22:47:56 +00001205 /* useCksum should be true for the main journal and false for
1206 ** statement journals. Verify that this is always the case
1207 */
drh9cbe6352005-11-29 03:13:21 +00001208 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001209 assert( aData );
drh96362842005-03-20 22:47:56 +00001210
danielk197762079062007-08-15 17:08:46 +00001211 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001212 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001213 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001214 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001215 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001216
drh968af522003-02-11 14:55:40 +00001217 /* Sanity checking on the page. This is more important that I originally
1218 ** thought. If a power failure occurs while the journal is being written,
1219 ** it could cause invalid data to be written into the journal. We need to
1220 ** detect this invalid data (with high probability) and ignore it.
1221 */
danielk197775edc162004-06-26 01:48:18 +00001222 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001223 return SQLITE_DONE;
1224 }
drhae2b40c2004-06-09 19:03:54 +00001225 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001226 return SQLITE_OK;
1227 }
drhae2b40c2004-06-09 19:03:54 +00001228 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001229 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001230 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001231 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001232 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001233 return SQLITE_DONE;
1234 }
1235 }
drhfa86c412002-02-02 15:01:15 +00001236
danielk1977aa5ccdf2004-06-14 05:10:42 +00001237 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001238
1239 /* If the pager is in RESERVED state, then there must be a copy of this
1240 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001241 ** not the database file. The page is left marked dirty in this case.
1242 **
danielk19772df71c72007-05-24 07:22:42 +00001243 ** An exception to the above rule: If the database is in no-sync mode
1244 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001245 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1246 ** during a Movepage() call, then the page may not be in the cache
1247 ** either. So the condition described in the above paragraph is not
1248 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001249 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001250 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1251 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001252 **
1253 ** Ticket #1171: The statement journal might contain page content that is
1254 ** different from the page content at the start of the transaction.
1255 ** This occurs when a page is changed prior to the start of a statement
1256 ** then changed again within the statement. When rolling back such a
1257 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001258 ** for certain that original page contents are synced into the main rollback
1259 ** journal. Otherwise, a power loss might leave modified data in the
1260 ** database file without an entry in the rollback journal that can
1261 ** restore the database to its original form. Two conditions must be
1262 ** met before writing to the database files. (1) the database must be
1263 ** locked. (2) we know that the original page content is fully synced
1264 ** in the main journal either because the page is not in cache or else
1265 ** the page is marked as needSync==0.
drhfa86c412002-02-02 15:01:15 +00001266 */
drhae2b40c2004-06-09 19:03:54 +00001267 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001268 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1269 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh96362842005-03-20 22:47:56 +00001270 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
danielk197762079062007-08-15 17:08:46 +00001271 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1272 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001273 if( pPg ){
1274 makeClean(pPg);
1275 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001276 }
drhfa86c412002-02-02 15:01:15 +00001277 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001278 /* No page should ever be explicitly rolled back that is in use, except
1279 ** for page 1 which is held in use in order to keep the lock on the
1280 ** database active. However such a page may be rolled back as a result
1281 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001282 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001283 */
drhb6f41482004-05-14 01:58:11 +00001284 void *pData;
danielk197728129562005-01-11 10:25:06 +00001285 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001286 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001287 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001288 if( pPager->xReiniter ){
1289 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001290 }
danielk19773c407372005-02-15 02:54:14 +00001291#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001292 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001293#endif
drh86a88112007-04-16 15:02:19 +00001294 /* If this was page 1, then restore the value of Pager.dbFileVers.
1295 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001296 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001297 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001298 }
drh86a88112007-04-16 15:02:19 +00001299
1300 /* Decode the page just read from disk */
1301 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001302 }
1303 return rc;
1304}
1305
1306/*
danielk197713adf8a2004-06-03 16:08:41 +00001307** Parameter zMaster is the name of a master journal file. A single journal
1308** file that referred to the master journal file has just been rolled back.
1309** This routine checks if it is possible to delete the master journal file,
1310** and does so if it is.
drh726de592004-06-10 23:35:50 +00001311**
1312** The master journal file contains the names of all child journals.
1313** To tell if a master journal can be deleted, check to each of the
1314** children. If all children are either missing or do not refer to
1315** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001316*/
danielk1977b4b47412007-08-17 15:53:36 +00001317static int pager_delmaster(Pager *pPager, const char *zMaster){
1318 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001319 int rc;
1320 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001321 sqlite3_file *pMaster;
1322 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001323 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001324 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001325
1326 /* Open the master journal file exclusively in case some other process
1327 ** is running this routine also. Not that it makes too much difference.
1328 */
danielk1977b4b47412007-08-17 15:53:36 +00001329 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001330 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001331 if( !pMaster ){
1332 rc = SQLITE_NOMEM;
1333 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001334 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1335 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001336 }
danielk197713adf8a2004-06-03 16:08:41 +00001337 if( rc!=SQLITE_OK ) goto delmaster_out;
1338 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001339
1340 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001341 if( rc!=SQLITE_OK ) goto delmaster_out;
1342
1343 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001344 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001345 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +00001346
1347 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001348 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001349 */
drh17435752007-08-16 04:30:38 +00001350 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001351 if( !zMasterJournal ){
1352 rc = SQLITE_NOMEM;
1353 goto delmaster_out;
1354 }
danielk1977b4b47412007-08-17 15:53:36 +00001355 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001356 if( rc!=SQLITE_OK ) goto delmaster_out;
1357
danielk19775865e3d2004-06-14 06:03:57 +00001358 zJournal = zMasterJournal;
1359 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977b4b47412007-08-17 15:53:36 +00001360 if( sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS) ){
danielk197713adf8a2004-06-03 16:08:41 +00001361 /* One of the journals pointed to by the master journal exists.
1362 ** Open it and check if it points at the master journal. If
1363 ** so, return without deleting the master journal file.
1364 */
drh3b7b78b2004-11-24 01:16:43 +00001365 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001366 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1367 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001368 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001369 goto delmaster_out;
1370 }
danielk197713adf8a2004-06-03 16:08:41 +00001371
danielk1977b4b47412007-08-17 15:53:36 +00001372 rc = readMasterJournal(pJournal, &zMasterPtr);
1373 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001374 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001375 goto delmaster_out;
1376 }
danielk197776572402004-06-25 02:38:54 +00001377
drh3b7b78b2004-11-24 01:16:43 +00001378 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
drh17435752007-08-16 04:30:38 +00001379 sqlite3_free(zMasterPtr);
drh3b7b78b2004-11-24 01:16:43 +00001380 if( c ){
danielk197776572402004-06-25 02:38:54 +00001381 /* We have a match. Do not delete the master journal file. */
1382 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001383 }
1384 }
danielk19775865e3d2004-06-14 06:03:57 +00001385 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001386 }
1387 }
1388
danielk1977fee2d252007-08-18 10:59:19 +00001389 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001390
1391delmaster_out:
1392 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001393 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001394 }
1395 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001396 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001397 }
danielk1977b4b47412007-08-17 15:53:36 +00001398 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001399 return rc;
1400}
1401
drha6abd042004-06-09 17:37:22 +00001402
danielk1977e180dd92007-04-05 17:15:52 +00001403static void pager_truncate_cache(Pager *pPager);
1404
drha6abd042004-06-09 17:37:22 +00001405/*
drhcb4c40b2004-08-18 19:09:43 +00001406** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001407** indicated. Also truncate the cached representation of the file.
drhcb4c40b2004-08-18 19:09:43 +00001408*/
1409static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001410 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001411 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
danielk1977e180dd92007-04-05 17:15:52 +00001412 rc = sqlite3OsTruncate(pPager->fd, pPager->pageSize*(i64)nPage);
1413 }
1414 if( rc==SQLITE_OK ){
1415 pPager->dbSize = nPage;
1416 pager_truncate_cache(pPager);
1417 }
1418 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001419}
1420
1421/*
drhc80f0582007-05-01 16:59:48 +00001422** Set the sectorSize for the given pager.
1423**
1424** The sector size is the larger of the sector size reported
1425** by sqlite3OsSectorSize() and the pageSize.
1426*/
1427static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001428 assert(pPager->fd->pMethods||pPager->tempFile);
1429 if( !pPager->tempFile ){
1430 /* Sector size doesn't matter for temporary files. Also, the file
1431 ** may not have been opened yet, in whcih case the OsSectorSize()
1432 ** call will segfault.
1433 */
1434 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1435 }
drhc80f0582007-05-01 16:59:48 +00001436 if( pPager->sectorSize<pPager->pageSize ){
1437 pPager->sectorSize = pPager->pageSize;
1438 }
1439}
1440
1441/*
drhed7c8552001-04-11 14:29:21 +00001442** Playback the journal and thus restore the database file to
1443** the state it was in before we started making changes.
1444**
drh34e79ce2004-02-08 06:05:46 +00001445** The journal file format is as follows:
1446**
drhae2b40c2004-06-09 19:03:54 +00001447** (1) 8 byte prefix. A copy of aJournalMagic[].
1448** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001449** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001450** number of page records from the journal size.
1451** (3) 4 byte big-endian integer which is the initial value for the
1452** sanity checksum.
1453** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001454** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001455** (5) 4 byte integer which is the number of bytes in the master journal
1456** name. The value may be zero (indicate that there is no master
1457** journal.)
1458** (6) N bytes of the master journal name. The name will be nul-terminated
1459** and might be shorter than the value read from (5). If the first byte
1460** of the name is \000 then there is no master journal. The master
1461** journal name is stored in UTF-8.
1462** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001463** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001464** + pPager->pageSize bytes of data.
1465** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001466**
drhae2b40c2004-06-09 19:03:54 +00001467** When we speak of the journal header, we mean the first 6 items above.
1468** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001469**
1470** Call the value from the second bullet "nRec". nRec is the number of
1471** valid page entries in the journal. In most cases, you can compute the
1472** value of nRec from the size of the journal file. But if a power
1473** failure occurred while the journal was being written, it could be the
1474** case that the size of the journal file had already been increased but
1475** the extra entries had not yet made it safely to disk. In such a case,
1476** the value of nRec computed from the file size would be too large. For
1477** that reason, we always use the nRec value in the header.
1478**
1479** If the nRec value is 0xffffffff it means that nRec should be computed
1480** from the file size. This value is used when the user selects the
1481** no-sync option for the journal. A power failure could lead to corruption
1482** in this case. But for things like temporary table (which will be
1483** deleted when the power is restored) we don't care.
1484**
drhd9b02572001-04-15 00:37:09 +00001485** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001486** journal file then all pages up to the first corrupted page are rolled
1487** back (or no pages if the journal header is corrupted). The journal file
1488** is then deleted and SQLITE_OK returned, just as if no corruption had
1489** been encountered.
1490**
1491** If an I/O or malloc() error occurs, the journal-file is not deleted
1492** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001493*/
danielk1977e277be02007-03-23 18:12:06 +00001494static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001495 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001496 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001497 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001498 int i; /* Loop counter */
1499 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001500 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001501 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001502
drhc3a64ba2001-11-22 00:01:27 +00001503 /* Figure out how many records are in the journal. Abort early if
1504 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001505 */
drh8cfbf082001-09-19 13:22:39 +00001506 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001507 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001508 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001509 goto end_playback;
1510 }
drh240c5792004-02-08 00:40:52 +00001511
danielk197776572402004-06-25 02:38:54 +00001512 /* Read the master journal name from the journal, if it is present.
1513 ** If a master journal file name is specified, but the file is not
1514 ** present on disk, then the journal is not hot and does not need to be
1515 ** played back.
drh240c5792004-02-08 00:40:52 +00001516 */
drh9cbe6352005-11-29 03:13:21 +00001517 rc = readMasterJournal(pPager->jfd, &zMaster);
danielk197776572402004-06-25 02:38:54 +00001518 assert( rc!=SQLITE_DONE );
danielk1977b4b47412007-08-17 15:53:36 +00001519 if( rc!=SQLITE_OK
1520 || (zMaster && !sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS))
1521 ){
drh17435752007-08-16 04:30:38 +00001522 sqlite3_free(zMaster);
danielk197776572402004-06-25 02:38:54 +00001523 zMaster = 0;
1524 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001525 goto end_playback;
1526 }
danielk197776572402004-06-25 02:38:54 +00001527 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001528
danielk197776572402004-06-25 02:38:54 +00001529 /* This loop terminates either when the readJournalHdr() call returns
1530 ** SQLITE_DONE or an IO error occurs. */
1531 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001532
danielk197776572402004-06-25 02:38:54 +00001533 /* Read the next journal header from the journal file. If there are
1534 ** not enough bytes left in the journal file for a complete header, or
1535 ** it is corrupted, then a process must of failed while writing it.
1536 ** This indicates nothing more needs to be rolled back.
1537 */
1538 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1539 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001540 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001541 rc = SQLITE_OK;
1542 }
danielk197776572402004-06-25 02:38:54 +00001543 goto end_playback;
1544 }
1545
1546 /* If nRec is 0xffffffff, then this journal was created by a process
1547 ** working in no-sync mode. This means that the rest of the journal
1548 ** file consists of pages, there are no more journal headers. Compute
1549 ** the value of nRec based on this assumption.
1550 */
1551 if( nRec==0xffffffff ){
1552 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1553 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1554 }
1555
danielk1977e277be02007-03-23 18:12:06 +00001556 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001557 ** process and if this is the final header in the journal, then it means
1558 ** that this part of the journal was being filled but has not yet been
1559 ** synced to disk. Compute the number of pages based on the remaining
1560 ** size of the file.
1561 **
1562 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001563 */
drh8940f4e2007-08-11 00:26:20 +00001564 if( nRec==0 && !isHot &&
1565 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001566 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1567 }
1568
danielk197776572402004-06-25 02:38:54 +00001569 /* If this is the first header read from the journal, truncate the
1570 ** database file back to it's original size.
1571 */
danielk1977e180dd92007-04-05 17:15:52 +00001572 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001573 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001574 if( rc!=SQLITE_OK ){
1575 goto end_playback;
1576 }
danielk197776572402004-06-25 02:38:54 +00001577 }
1578
danielk197776572402004-06-25 02:38:54 +00001579 /* Copy original pages out of the journal and back into the database file.
1580 */
1581 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001582 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001583 if( rc!=SQLITE_OK ){
1584 if( rc==SQLITE_DONE ){
1585 rc = SQLITE_OK;
1586 pPager->journalOff = szJ;
1587 break;
1588 }else{
1589 goto end_playback;
1590 }
1591 }
drh968af522003-02-11 14:55:40 +00001592 }
drhed7c8552001-04-11 14:29:21 +00001593 }
drh580eeaf2006-02-24 03:09:37 +00001594 /*NOTREACHED*/
1595 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001596
1597end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001598 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001599 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001600 }
danielk197713adf8a2004-06-03 16:08:41 +00001601 if( zMaster ){
danielk1977979f38e2007-03-27 16:19:51 +00001602 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001603 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001604 */
1605 if( rc==SQLITE_OK ){
danielk1977b4b47412007-08-17 15:53:36 +00001606 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001607 }
drh17435752007-08-16 04:30:38 +00001608 sqlite3_free(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001609 }
danielk197776572402004-06-25 02:38:54 +00001610
1611 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001612 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001613 ** value. Reset it to the correct value for this process.
1614 */
drhc80f0582007-05-01 16:59:48 +00001615 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001616 return rc;
drhed7c8552001-04-11 14:29:21 +00001617}
1618
1619/*
drhac69b052004-05-12 13:30:07 +00001620** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001621**
1622** This is similar to playing back the transaction journal but with
1623** a few extra twists.
1624**
drh663fc632002-02-02 18:49:19 +00001625** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001626** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001627** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001628**
drhac69b052004-05-12 13:30:07 +00001629** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001630** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001631** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001632*/
drh3aac2dd2004-04-26 14:10:20 +00001633static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001634 i64 szJ; /* Size of the full journal */
1635 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001636 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001637 int i; /* Loop counter */
1638 int rc;
1639
danielk197776572402004-06-25 02:38:54 +00001640 szJ = pPager->journalOff;
1641#ifndef NDEBUG
1642 {
drheb206252004-10-01 02:00:31 +00001643 i64 os_szJ;
drh054889e2005-11-30 03:20:31 +00001644 rc = sqlite3OsFileSize(pPager->jfd, &os_szJ);
danielk197776572402004-06-25 02:38:54 +00001645 if( rc!=SQLITE_OK ) return rc;
1646 assert( szJ==os_szJ );
1647 }
1648#endif
1649
danielk19774099f6e2007-03-19 11:25:20 +00001650 /* Set hdrOff to be the offset just after the end of the last journal
1651 ** page written before the first journal-header for this statement
1652 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001653 ** header was written.
1654 */
1655 hdrOff = pPager->stmtHdrOff;
1656 assert( pPager->fullSync || !hdrOff );
1657 if( !hdrOff ){
1658 hdrOff = szJ;
1659 }
1660
drhfa86c412002-02-02 15:01:15 +00001661 /* Truncate the database back to its original size.
1662 */
danielk1977e180dd92007-04-05 17:15:52 +00001663 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001664 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001665
drhac69b052004-05-12 13:30:07 +00001666 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001667 */
drhac69b052004-05-12 13:30:07 +00001668 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001669 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001670
drhac69b052004-05-12 13:30:07 +00001671 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001672 ** database file. Note that the statement journal omits checksums from
1673 ** each record since power-failure recovery is not important to statement
1674 ** journals.
drhfa86c412002-02-02 15:01:15 +00001675 */
danielk197762079062007-08-15 17:08:46 +00001676 for(i=0; i<nRec; i++){
1677 i64 offset = i*(4+pPager->pageSize);
1678 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001679 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001680 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001681 }
1682
danielk197776572402004-06-25 02:38:54 +00001683 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1684 ** was the size of the journal file when this statement was started, so
1685 ** everything after that needs to be rolled back, either into the
1686 ** database, the memory cache, or both.
1687 **
1688 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1689 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001690 */
danielk197776572402004-06-25 02:38:54 +00001691 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001692 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001693 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001694 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001695 assert( rc!=SQLITE_DONE );
1696 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1697 }
1698
1699 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001700 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001701 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001702 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001703 if( rc!=SQLITE_OK ){
1704 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001705 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001706 }
danielk1977f0113002006-01-24 12:09:17 +00001707 if( nJRec==0 ){
1708 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001709 }
danielk1977f0113002006-01-24 12:09:17 +00001710 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001711 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001712 assert( rc!=SQLITE_DONE );
1713 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1714 }
drhfa86c412002-02-02 15:01:15 +00001715 }
danielk197776572402004-06-25 02:38:54 +00001716
1717 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001718
drh3aac2dd2004-04-26 14:10:20 +00001719end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001720 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001721 pPager->journalOff = szJ;
1722 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001723 }
1724 return rc;
1725}
1726
1727/*
drhf57b14a2001-09-14 18:54:08 +00001728** Change the maximum number of in-memory pages that are allowed.
1729*/
danielk19773b8a05f2007-03-19 17:44:26 +00001730void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00001731 if( mxPage>10 ){
1732 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001733 }else{
1734 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001735 }
1736}
1737
1738/*
drh973b6e32003-02-12 14:09:42 +00001739** Adjust the robustness of the database to damage due to OS crashes
1740** or power failures by changing the number of syncs()s when writing
1741** the rollback journal. There are three levels:
1742**
drh054889e2005-11-30 03:20:31 +00001743** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001744** for temporary and transient files.
1745**
1746** NORMAL The journal is synced once before writes begin on the
1747** database. This is normally adequate protection, but
1748** it is theoretically possible, though very unlikely,
1749** that an inopertune power failure could leave the journal
1750** in a state which would cause damage to the database
1751** when it is rolled back.
1752**
1753** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001754** database (with some additional information - the nRec field
1755** of the journal header - being written in between the two
1756** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001757** single disk sector is atomic, then this mode provides
1758** assurance that the journal will not be corrupted to the
1759** point of causing damage to the database during rollback.
1760**
1761** Numeric values associated with these states are OFF==1, NORMAL=2,
1762** and FULL=3.
1763*/
danielk197793758c82005-01-21 08:13:14 +00001764#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00001765void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00001766 pPager->noSync = level==1 || pPager->tempFile;
1767 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00001768 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001769 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001770}
danielk197793758c82005-01-21 08:13:14 +00001771#endif
drh973b6e32003-02-12 14:09:42 +00001772
1773/*
drhaf6df112005-06-07 02:12:30 +00001774** The following global variable is incremented whenever the library
1775** attempts to open a temporary file. This information is used for
1776** testing and analysis only.
1777*/
drh0f7eb612006-08-08 13:51:43 +00001778#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001779int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001780#endif
drhaf6df112005-06-07 02:12:30 +00001781
1782/*
drh3f56e6e2007-03-15 01:16:47 +00001783** Open a temporary file.
1784**
1785** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001786** other error code if we fail. The OS will automatically delete the temporary
1787** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001788**
danielk1977fee2d252007-08-18 10:59:19 +00001789** If zNameOut is 0, then SQLITE_OPEN_SUBJOURNAL is passed to the OS layer.
1790** If zNameOut is not 0, SQLITE_OPEN_TEMP_DB is passed.
drhfa86c412002-02-02 15:01:15 +00001791*/
danielk1977b4b47412007-08-17 15:53:36 +00001792static int sqlite3PagerOpentemp(
1793 sqlite3_vfs *pVfs,
1794 sqlite3_file *pFile,
1795 char *zNameOut
1796){
drhfa86c412002-02-02 15:01:15 +00001797 int cnt = 8;
1798 int rc;
danielk1977b4b47412007-08-17 15:53:36 +00001799 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|SQLITE_OPEN_EXCLUSIVE);
1800
1801 char *zFree = 0;
1802 if( zNameOut==0 ){
1803 zFree = (char *)sqlite3_malloc(pVfs->mxPathname);
1804 if( !zFree ){
1805 return SQLITE_NOMEM;
1806 }
1807 zNameOut = zFree;
danielk1977fee2d252007-08-18 10:59:19 +00001808 flags |= SQLITE_OPEN_SUBJOURNAL;
1809 }else{
1810 flags |= SQLITE_OPEN_TEMP_DB;
danielk1977b4b47412007-08-17 15:53:36 +00001811 }
drh3f56e6e2007-03-15 01:16:47 +00001812
drh0f7eb612006-08-08 13:51:43 +00001813#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001814 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001815#endif
danielk1977b4b47412007-08-17 15:53:36 +00001816
drhfa86c412002-02-02 15:01:15 +00001817 do{
1818 cnt--;
danielk1977b4b47412007-08-17 15:53:36 +00001819 sqlite3OsGetTempName(pVfs, zNameOut);
1820 rc = sqlite3OsOpen(pVfs, zNameOut, pFile, flags, 0);
1821 assert( rc!=SQLITE_OK || pFile->pMethods );
danielk197713073932004-06-30 11:54:06 +00001822 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
danielk1977b4b47412007-08-17 15:53:36 +00001823
1824 sqlite3_free(zFree);
drhfa86c412002-02-02 15:01:15 +00001825 return rc;
1826}
1827
1828/*
drhed7c8552001-04-11 14:29:21 +00001829** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001830** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001831** the first call to sqlite3PagerGet() and is only held open until the
1832** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001833**
drh6446c4d2001-12-15 14:22:18 +00001834** If zFilename is NULL then a randomly-named temporary file is created
1835** and used as the file to be cached. The file will be deleted
1836** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001837**
1838** If zFilename is ":memory:" then all information is held in cache.
1839** It is never written to disk. This can be used to implement an
1840** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001841*/
danielk19773b8a05f2007-03-19 17:44:26 +00001842int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001843 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001844 Pager **ppPager, /* Return the Pager structure here */
1845 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001846 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001847 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001848){
danielk1977b4b47412007-08-17 15:53:36 +00001849 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001850 Pager *pPager = 0;
danielk19778def5ea2004-06-16 10:39:52 +00001851 char *zFullPathname = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001852 int rc = SQLITE_OK;
1853 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001854 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001855 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001856 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001857 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1858 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00001859 int journalFileSize = sqlite3JournalSize(pVfs);
danielk1977b4b47412007-08-17 15:53:36 +00001860
drh86f8c192007-08-22 00:39:19 +00001861 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001862 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001863
danielk1977b4b47412007-08-17 15:53:36 +00001864 /* Allocate memory for the pager structure */
1865 pPager = sqlite3MallocZero(
1866 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00001867 journalFileSize + /* The journal file structure */
1868 pVfs->szOsFile * 2 + /* The db and stmt journal files */
danielk1977b4b47412007-08-17 15:53:36 +00001869 pVfs->mxPathname * 3 + 30 /* zFilename, zDirectory, zJournal */
1870 );
1871 if( !pPager ){
1872 return SQLITE_NOMEM;
1873 }
1874 pPtr = (u8 *)&pPager[1];
1875 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00001876 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
1877 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
1878 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
danielk1977b4b47412007-08-17 15:53:36 +00001879 pPager->zDirectory = &pPager->zFilename[pVfs->mxPathname];
1880 pPager->zJournal = &pPager->zDirectory[pVfs->mxPathname];
1881 pPager->pVfs = pVfs;
1882
danielk1977aef0bf62005-12-30 16:28:01 +00001883 /* Open the pager file and set zFullPathname to point at malloc()ed
1884 ** memory containing the complete filename (i.e. including the directory).
1885 */
drh901afd42003-08-26 11:25:58 +00001886 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001887#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001888 if( strcmp(zFilename,":memory:")==0 ){
1889 memDb = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001890 pPager->zFilename[0] = '\0';
drhb7f91642004-10-31 02:22:47 +00001891 }else
1892#endif
1893 {
danielk1977b4b47412007-08-17 15:53:36 +00001894 rc = sqlite3OsFullPathname(pVfs, zFilename, pPager->zFilename);
1895 if( rc==SQLITE_OK ){
1896 if( strlen(pPager->zFilename)>(pVfs->mxPathname - strlen("-journal")) ){
1897 rc = SQLITE_CANTOPEN;
1898 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001899 int oflag =
1900 (SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|SQLITE_OPEN_MAIN_DB);
danielk1977b4b47412007-08-17 15:53:36 +00001901 int fout = 0;
danielk1977fee2d252007-08-18 10:59:19 +00001902 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd, oflag, &fout);
danielk1977b4b47412007-08-17 15:53:36 +00001903 readOnly = (fout&SQLITE_OPEN_READONLY);
1904 }
danielk19778def5ea2004-06-16 10:39:52 +00001905 }
drhac69b052004-05-12 13:30:07 +00001906 }
drh5e00f6c2001-09-13 13:46:56 +00001907 }else{
danielk19777a2b1ee2007-08-21 14:27:01 +00001908 /* If a temporary file is requested, it is not opened immediately.
1909 ** In this case we accept the default page size and delay actually
1910 ** opening the file until the first call to OsWrite().
1911 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001912 tempFile = 1;
1913 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001914 }
danielk1977aef0bf62005-12-30 16:28:01 +00001915
danielk1977b4b47412007-08-17 15:53:36 +00001916 if( pPager && rc==SQLITE_OK ){
1917 pPager->pTmpSpace = (char *)sqlite3_malloc(SQLITE_DEFAULT_PAGE_SIZE);
drh3e7a6092002-12-07 21:45:14 +00001918 }
danielk1977aef0bf62005-12-30 16:28:01 +00001919
1920 /* If an error occured in either of the blocks above, free the memory
1921 ** pointed to by zFullPathname, free the Pager structure and close the
1922 ** file. Since the pager is not allocated there is no need to set
1923 ** any Pager.errMask variables.
1924 */
danielk1977b4b47412007-08-17 15:53:36 +00001925 if( !pPager || !pPager->pTmpSpace ){
1926 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001927 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001928 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001929 }
danielk1977aef0bf62005-12-30 16:28:01 +00001930
danielk1977dd97a492007-08-22 18:54:32 +00001931 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), zFullPathname);
drhb0603412007-02-28 04:47:26 +00001932 IOTRACE(("OPEN %p %s\n", pPager, zFullPathname))
danielk1977aef0bf62005-12-30 16:28:01 +00001933
danielk1977b4b47412007-08-17 15:53:36 +00001934 /* Fill in Pager.zDirectory[] */
1935 memcpy(pPager->zDirectory, pPager->zFilename, pVfs->mxPathname);
1936 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001937 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001938
1939 /* Fill in Pager.zJournal[] */
1940 memcpy(pPager->zJournal, pPager->zFilename, pVfs->mxPathname);
1941 memcpy(&pPager->zJournal[strlen(pPager->zJournal)], "-journal", 9);
1942
drh3b59a5c2006-01-15 20:28:28 +00001943 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00001944 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001945 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001946 /* pPager->stmtOpen = 0; */
1947 /* pPager->stmtInUse = 0; */
1948 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001949 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001950 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drh3b59a5c2006-01-15 20:28:28 +00001951 /* pPager->stmtSize = 0; */
1952 /* pPager->stmtJSize = 0; */
1953 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001954 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001955 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001956 assert( PAGER_UNLOCK==0 );
1957 /* pPager->state = PAGER_UNLOCK; */
1958 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001959 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001960 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1961 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1962 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1963 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001964 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001965 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001966 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001967 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001968 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00001969 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00001970 /* pPager->pFirst = 0; */
1971 /* pPager->pFirstSynced = 0; */
1972 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00001973 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk19777a2b1ee2007-08-21 14:27:01 +00001974 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00001975 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00001976 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00001977 }
drh3b59a5c2006-01-15 20:28:28 +00001978 /* pPager->pBusyHandler = 0; */
1979 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001980 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00001981#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00001982 pPager->iInUseMM = 0;
1983 pPager->iInUseDB = 0;
1984 if( !memDb ){
1985 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
1986 sqlite3_mutex_enter(mutex);
1987 pPager->pNext = sqlite3PagerList;
1988 if( sqlite3PagerList ){
1989 assert( sqlite3PagerList->pPrev==0 );
1990 sqlite3PagerList->pPrev = pPager;
1991 }
1992 pPager->pPrev = 0;
1993 sqlite3PagerList = pPager;
1994 sqlite3_mutex_leave(mutex);
1995 }
danielk197752622822006-01-09 09:59:49 +00001996#endif
drhed7c8552001-04-11 14:29:21 +00001997 return SQLITE_OK;
1998}
1999
2000/*
drh90f5ecb2004-07-22 01:19:35 +00002001** Set the busy handler function.
2002*/
danielk19773b8a05f2007-03-19 17:44:26 +00002003void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002004 pPager->pBusyHandler = pBusyHandler;
2005}
2006
2007/*
drh72f82862001-05-24 21:06:34 +00002008** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002009** when the reference count on each page reaches zero. The destructor can
2010** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002011**
danielk19773b8a05f2007-03-19 17:44:26 +00002012** The destructor is not called as a result sqlite3PagerClose().
2013** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002014*/
danielk19773b8a05f2007-03-19 17:44:26 +00002015void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002016 pPager->xDestructor = xDesc;
2017}
2018
2019/*
drha6abd042004-06-09 17:37:22 +00002020** Set the reinitializer for this pager. If not NULL, the reinitializer
2021** is called when the content of a page in cache is restored to its original
2022** value as a result of a rollback. The callback gives higher-level code
2023** an opportunity to restore the EXTRA section to agree with the restored
2024** page data.
2025*/
danielk19773b8a05f2007-03-19 17:44:26 +00002026void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002027 pPager->xReiniter = xReinit;
2028}
2029
2030/*
drh1c7880e2005-05-20 20:01:55 +00002031** Set the page size. Return the new size. If the suggest new page
2032** size is inappropriate, then an alternative page size is selected
2033** and returned.
drh90f5ecb2004-07-22 01:19:35 +00002034*/
danielk19773b8a05f2007-03-19 17:44:26 +00002035int sqlite3PagerSetPagesize(Pager *pPager, int pageSize){
drh90f5ecb2004-07-22 01:19:35 +00002036 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
danielk1977c7c7e622007-03-26 15:46:00 +00002037 if( !pPager->memDb && pPager->nRef==0 ){
drh86f8c192007-08-22 00:39:19 +00002038 pagerEnter(pPager);
danielk1977c7c7e622007-03-26 15:46:00 +00002039 pager_reset(pPager);
drh1c7880e2005-05-20 20:01:55 +00002040 pPager->pageSize = pageSize;
drh86f8c192007-08-22 00:39:19 +00002041 pagerLeave(pPager);
drh17435752007-08-16 04:30:38 +00002042 sqlite3_free(pPager->pTmpSpace);
2043 pPager->pTmpSpace = sqlite3_malloc(pageSize);
drh1c7880e2005-05-20 20:01:55 +00002044 }
2045 return pPager->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00002046}
2047
2048/*
drhf8e632b2007-05-08 14:51:36 +00002049** Attempt to set the maximum database page count if mxPage is positive.
2050** Make no changes if mxPage is zero or negative. And never reduce the
2051** maximum page count below the current size of the database.
2052**
2053** Regardless of mxPage, return the current maximum page count.
2054*/
2055int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2056 if( mxPage>0 ){
2057 pPager->mxPgno = mxPage;
2058 }
2059 sqlite3PagerPagecount(pPager);
2060 return pPager->mxPgno;
2061}
2062
2063/*
drhc9ac5ca2005-11-04 22:03:30 +00002064** The following set of routines are used to disable the simulated
2065** I/O error mechanism. These routines are used to avoid simulated
2066** errors in places where we do not care about errors.
2067**
2068** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2069** and generate no code.
2070*/
2071#ifdef SQLITE_TEST
2072extern int sqlite3_io_error_pending;
2073extern int sqlite3_io_error_hit;
2074static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002075void disable_simulated_io_errors(void){
2076 saved_cnt = sqlite3_io_error_pending;
2077 sqlite3_io_error_pending = -1;
2078}
2079void enable_simulated_io_errors(void){
2080 sqlite3_io_error_pending = saved_cnt;
2081}
2082#else
drh152410f2005-11-05 15:11:22 +00002083# define disable_simulated_io_errors()
2084# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002085#endif
2086
2087/*
drh90f5ecb2004-07-22 01:19:35 +00002088** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002089** that pDest points to.
2090**
2091** No error checking is done. The rational for this is that this function
2092** may be called even if the file does not exist or contain a header. In
2093** these cases sqlite3OsRead() will return an error, to which the correct
2094** response is to zero the memory at pDest and continue. A real IO error
2095** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002096*/
danielk19773b8a05f2007-03-19 17:44:26 +00002097int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002098 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002099 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002100 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2101 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002102 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002103 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002104 if( rc==SQLITE_IOERR_SHORT_READ ){
2105 rc = SQLITE_OK;
2106 }
drh90f5ecb2004-07-22 01:19:35 +00002107 }
drh551b7732006-11-06 21:20:25 +00002108 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002109}
2110
2111/*
drh5e00f6c2001-09-13 13:46:56 +00002112** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002113** pPager.
2114**
2115** If the PENDING_BYTE lies on the page directly after the end of the
2116** file, then consider this page part of the file too. For example, if
2117** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2118** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002119*/
danielk19773b8a05f2007-03-19 17:44:26 +00002120int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002121 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002122 int rc;
drhd9b02572001-04-15 00:37:09 +00002123 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002124 if( pPager->errCode ){
2125 return 0;
2126 }
drhed7c8552001-04-11 14:29:21 +00002127 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002128 n = pPager->dbSize;
2129 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002130 assert(pPager->fd->pMethods||pPager->tempFile);
2131 if( (pPager->fd->pMethods)
2132 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002133 pager_error(pPager, rc);
danielk197715f411d2005-09-16 10:18:45 +00002134 return 0;
2135 }
2136 if( n>0 && n<pPager->pageSize ){
2137 n = 1;
2138 }else{
2139 n /= pPager->pageSize;
2140 }
2141 if( pPager->state!=PAGER_UNLOCK ){
2142 pPager->dbSize = n;
2143 }
drhed7c8552001-04-11 14:29:21 +00002144 }
danielk197715f411d2005-09-16 10:18:45 +00002145 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002146 n++;
2147 }
drhf8e632b2007-05-08 14:51:36 +00002148 if( n>pPager->mxPgno ){
2149 pPager->mxPgno = n;
2150 }
drhed7c8552001-04-11 14:29:21 +00002151 return n;
2152}
2153
drhf07e7d52006-04-07 13:54:46 +00002154
2155#ifndef SQLITE_OMIT_MEMORYDB
2156/*
2157** Clear a PgHistory block
2158*/
2159static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002160 sqlite3_free(pHist->pOrig);
2161 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002162 pHist->pOrig = 0;
2163 pHist->pStmt = 0;
2164}
2165#else
2166#define clearHistory(x)
2167#endif
2168
drhed7c8552001-04-11 14:29:21 +00002169/*
drhf7c57532003-04-25 13:22:51 +00002170** Forward declaration
2171*/
danielk197776572402004-06-25 02:38:54 +00002172static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002173
2174/*
danielk1977f5fdda82004-11-03 08:44:05 +00002175** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
2176** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002177** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002178** pNextFree/pPrevFree list that is not a part of any hash-chain.
2179*/
2180static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2181 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002182 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002183 return;
2184 }
2185 if( pPg->pNextHash ){
2186 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2187 }
2188 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002189 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002190 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2191 }else{
drh8ca0c722006-05-07 17:49:38 +00002192 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002193 pPager->aHash[h] = pPg->pNextHash;
2194 }
drh5229ae42006-03-23 23:29:04 +00002195 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002196 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2197 }
danielk1977f5fdda82004-11-03 08:44:05 +00002198 pPg->pgno = 0;
2199 pPg->pNextHash = pPg->pPrevHash = 0;
2200}
2201
2202/*
drhac69b052004-05-12 13:30:07 +00002203** Unlink a page from the free list (the list of all pages where nRef==0)
2204** and from its hash collision chain.
2205*/
2206static void unlinkPage(PgHdr *pPg){
2207 Pager *pPager = pPg->pPager;
2208
2209 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
2210 if( pPg==pPager->pFirstSynced ){
2211 PgHdr *p = pPg->pNextFree;
2212 while( p && p->needSync ){ p = p->pNextFree; }
2213 pPager->pFirstSynced = p;
2214 }
2215
2216 /* Unlink from the freelist */
2217 if( pPg->pPrevFree ){
2218 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2219 }else{
2220 assert( pPager->pFirst==pPg );
2221 pPager->pFirst = pPg->pNextFree;
2222 }
2223 if( pPg->pNextFree ){
2224 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2225 }else{
2226 assert( pPager->pLast==pPg );
2227 pPager->pLast = pPg->pPrevFree;
2228 }
2229 pPg->pNextFree = pPg->pPrevFree = 0;
2230
2231 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002232 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002233}
2234
2235/*
danielk1977e180dd92007-04-05 17:15:52 +00002236** This routine is used to truncate the cache when a database
2237** is truncated. Drop from the cache all pages whose pgno is
2238** larger than pPager->dbSize and is unreferenced.
2239**
drhac69b052004-05-12 13:30:07 +00002240** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002241**
2242** Actually, at the point this routine is called, it would be
2243** an error to have a referenced page. But rather than delete
2244** that page and guarantee a subsequent segfault, it seems better
2245** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002246*/
danielk1977e180dd92007-04-05 17:15:52 +00002247static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002248 PgHdr *pPg;
2249 PgHdr **ppPg;
2250 int dbSize = pPager->dbSize;
2251
2252 ppPg = &pPager->pAll;
2253 while( (pPg = *ppPg)!=0 ){
2254 if( pPg->pgno<=dbSize ){
2255 ppPg = &pPg->pNextAll;
2256 }else if( pPg->nRef>0 ){
2257 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2258 ppPg = &pPg->pNextAll;
2259 }else{
2260 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002261 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2262 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002263 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002264 makeClean(pPg);
drh17435752007-08-16 04:30:38 +00002265 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002266 pPager->nPage--;
2267 }
2268 }
2269}
2270
drhf7c57532003-04-25 13:22:51 +00002271/*
danielk197717221812005-02-15 03:38:05 +00002272** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002273** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002274** false or until the lock succeeds.
2275**
2276** Return SQLITE_OK on success and an error code if we cannot obtain
2277** the lock.
2278*/
2279static int pager_wait_on_lock(Pager *pPager, int locktype){
2280 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002281
2282 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002283 assert( PAGER_SHARED==SHARED_LOCK );
2284 assert( PAGER_RESERVED==RESERVED_LOCK );
2285 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002286
2287 /* If the file is currently unlocked then the size must be unknown */
2288 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2289
danielk197717221812005-02-15 03:38:05 +00002290 if( pPager->state>=locktype ){
2291 rc = SQLITE_OK;
2292 }else{
danielk197717221812005-02-15 03:38:05 +00002293 do {
drh054889e2005-11-30 03:20:31 +00002294 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002295 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002296 if( rc==SQLITE_OK ){
2297 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002298 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002299 }
2300 }
2301 return rc;
2302}
2303
2304/*
drhf7c57532003-04-25 13:22:51 +00002305** Truncate the file to the number of pages specified.
2306*/
danielk19773b8a05f2007-03-19 17:44:26 +00002307int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002308 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002309 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002310 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002311 if( pPager->errCode ){
2312 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002313 return rc;
2314 }
drh7d02cb72003-06-04 16:24:39 +00002315 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002316 return SQLITE_OK;
2317 }
drhb7f91642004-10-31 02:22:47 +00002318 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002319 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002320 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002321 return SQLITE_OK;
2322 }
drh86f8c192007-08-22 00:39:19 +00002323 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002324 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002325 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002326 if( rc!=SQLITE_OK ){
2327 return rc;
2328 }
danielk197717221812005-02-15 03:38:05 +00002329
2330 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002331 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002332 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002333 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002334 if( rc!=SQLITE_OK ){
2335 return rc;
2336 }
2337
drhcb4c40b2004-08-18 19:09:43 +00002338 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002339 return rc;
2340}
2341
2342/*
drhed7c8552001-04-11 14:29:21 +00002343** Shutdown the page cache. Free all memory and close all files.
2344**
2345** If a transaction was in progress when this routine is called, that
2346** transaction is rolled back. All outstanding pages are invalidated
2347** and their memory is freed. Any attempt to use a page associated
2348** with this page cache after this function returns will likely
2349** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002350**
2351** This function always succeeds. If a transaction is active an attempt
2352** is made to roll it back. If an error occurs during the rollback
2353** a hot journal may be left in the filesystem but no error is returned
2354** to the caller.
drhed7c8552001-04-11 14:29:21 +00002355*/
danielk19773b8a05f2007-03-19 17:44:26 +00002356int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002357#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002358 if( !MEMDB ){
2359 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2360 sqlite3_mutex_enter(mutex);
2361 if( pPager->pPrev ){
2362 pPager->pPrev->pNext = pPager->pNext;
2363 }else{
2364 sqlite3PagerList = pPager->pNext;
2365 }
2366 if( pPager->pNext ){
2367 pPager->pNext->pPrev = pPager->pPrev;
2368 }
2369 sqlite3_mutex_leave(mutex);
2370 }
danielk197713f72992005-12-18 08:51:22 +00002371#endif
2372
drhbafda092007-01-03 23:36:22 +00002373 disable_simulated_io_errors();
drhc2ee76c2007-01-04 14:58:14 +00002374 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002375 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002376 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002377 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002378 enable_simulated_io_errors();
drh4f0c5872007-03-26 22:05:01 +00002379 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002380 IOTRACE(("CLOSE %p\n", pPager))
danielk1977efaaf572006-01-16 11:29:19 +00002381 assert( pPager->errCode || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
danielk1977e94ddc92005-03-21 03:53:38 +00002382 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002383 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002384 }
drh17435752007-08-16 04:30:38 +00002385 sqlite3_free(pPager->aInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002386 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002387 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002388 }
danielk1977b4b47412007-08-17 15:53:36 +00002389 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002390 /* Temp files are automatically deleted by the OS
2391 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002392 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002393 ** }
2394 */
danielk1977aca790a2005-01-13 11:07:52 +00002395
drh17435752007-08-16 04:30:38 +00002396 sqlite3_free(pPager->aHash);
2397 sqlite3_free(pPager->pTmpSpace);
2398 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002399 return SQLITE_OK;
2400}
2401
drh87cc3b32007-05-08 21:45:27 +00002402#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002403/*
drh5e00f6c2001-09-13 13:46:56 +00002404** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002405*/
danielk19773b8a05f2007-03-19 17:44:26 +00002406Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002407 return p->pgno;
2408}
drh87cc3b32007-05-08 21:45:27 +00002409#endif
drhed7c8552001-04-11 14:29:21 +00002410
2411/*
drhc8629a12004-05-08 20:07:40 +00002412** The page_ref() function increments the reference count for a page.
2413** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002414** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002415**
2416** For non-test systems, page_ref() is a macro that calls _page_ref()
2417** online of the reference count is zero. For test systems, page_ref()
2418** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002419*/
drh836faa42003-01-11 13:30:57 +00002420static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002421 if( pPg->nRef==0 ){
2422 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00002423 if( pPg==pPg->pPager->pFirstSynced ){
2424 PgHdr *p = pPg->pNextFree;
2425 while( p && p->needSync ){ p = p->pNextFree; }
2426 pPg->pPager->pFirstSynced = p;
2427 }
drh7e3b0a02001-04-28 16:52:40 +00002428 if( pPg->pPrevFree ){
2429 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2430 }else{
2431 pPg->pPager->pFirst = pPg->pNextFree;
2432 }
2433 if( pPg->pNextFree ){
2434 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2435 }else{
2436 pPg->pPager->pLast = pPg->pPrevFree;
2437 }
2438 pPg->pPager->nRef++;
2439 }
2440 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00002441 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00002442}
danielk1977aca790a2005-01-13 11:07:52 +00002443#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002444 static void page_ref(PgHdr *pPg){
2445 if( pPg->nRef==0 ){
2446 _page_ref(pPg);
2447 }else{
2448 pPg->nRef++;
2449 REFINFO(pPg);
2450 }
2451 }
2452#else
2453# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2454#endif
drhdf0b3b02001-06-23 11:36:20 +00002455
2456/*
2457** Increment the reference count for a page. The input pointer is
2458** a reference to the page data.
2459*/
danielk19773b8a05f2007-03-19 17:44:26 +00002460int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002461 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002462 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002463 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002464 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002465}
2466
2467/*
drh34e79ce2004-02-08 06:05:46 +00002468** Sync the journal. In other words, make sure all the pages that have
2469** been written to the journal have actually reached the surface of the
2470** disk. It is not safe to modify the original database file until after
2471** the journal has been synced. If the original database is modified before
2472** the journal is synced and a power failure occurs, the unsynced journal
2473** data would be lost and we would be unable to completely rollback the
2474** database changes. Database corruption would occur.
2475**
2476** This routine also updates the nRec field in the header of the journal.
2477** (See comments on the pager_playback() routine for additional information.)
2478** If the sync mode is FULL, two syncs will occur. First the whole journal
2479** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002480**
drh34e79ce2004-02-08 06:05:46 +00002481** For temporary databases, we do not care if we are able to rollback
2482** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00002483**
drh34e79ce2004-02-08 06:05:46 +00002484** This routine clears the needSync field of every page current held in
2485** memory.
drh50e5dad2001-09-15 00:57:28 +00002486*/
danielk197776572402004-06-25 02:38:54 +00002487static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002488 PgHdr *pPg;
2489 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002490
2491 /* Sync the journal before modifying the main database
2492 ** (assuming there is a journal and it needs to be synced.)
2493 */
danielk197776572402004-06-25 02:38:54 +00002494 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002495 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00002496 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00002497 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2498 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002499#ifndef NDEBUG
2500 {
drh34e79ce2004-02-08 06:05:46 +00002501 /* Make sure the pPager->nRec counter we are keeping agrees
2502 ** with the nRec computed from the size of the journal file.
2503 */
drheb206252004-10-01 02:00:31 +00002504 i64 jSz;
drh054889e2005-11-30 03:20:31 +00002505 rc = sqlite3OsFileSize(pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002506 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002507 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002508 }
2509#endif
drhae2b40c2004-06-09 19:03:54 +00002510 {
danielk197762079062007-08-15 17:08:46 +00002511 i64 jrnlOff;
2512
danielk197776572402004-06-25 02:38:54 +00002513 /* Write the nRec value into the journal file header. If in
2514 ** full-synchronous mode, sync the journal first. This ensures that
2515 ** all data has really hit the disk before nRec is updated to mark
2516 ** it as a candidate for rollback.
2517 */
drhd8d66e82003-02-12 02:10:15 +00002518 if( pPager->fullSync ){
drh4f0c5872007-03-26 22:05:01 +00002519 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002520 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002521 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002522 if( rc!=0 ) return rc;
2523 }
danielk197713adf8a2004-06-03 16:08:41 +00002524
danielk197762079062007-08-15 17:08:46 +00002525 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2526 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2527 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002528 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002529 }
drh4f0c5872007-03-26 22:05:01 +00002530 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drh126afe62007-05-04 12:01:02 +00002531 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002532 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2533 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2534 );
drhfa86c412002-02-02 15:01:15 +00002535 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00002536 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002537 }
drh50e5dad2001-09-15 00:57:28 +00002538 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002539
2540 /* Erase the needSync flag from every page.
2541 */
2542 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2543 pPg->needSync = 0;
2544 }
2545 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002546 }
drh03eb96a2002-11-10 23:32:56 +00002547
drh341eae82003-01-21 02:39:36 +00002548#ifndef NDEBUG
2549 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2550 ** flag must also be clear for all pages. Verify that this
2551 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002552 */
drh341eae82003-01-21 02:39:36 +00002553 else{
2554 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2555 assert( pPg->needSync==0 );
2556 }
2557 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002558 }
drh341eae82003-01-21 02:39:36 +00002559#endif
drhdb48ee02003-01-16 13:42:43 +00002560
drh81a20f22001-10-12 17:30:04 +00002561 return rc;
drh50e5dad2001-09-15 00:57:28 +00002562}
2563
2564/*
drhdc3e10b2006-06-15 14:31:06 +00002565** Merge two lists of pages connected by pDirty and in pgno order.
2566** Do not both fixing the pPrevDirty pointers.
2567*/
2568static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2569 PgHdr result, *pTail;
2570 pTail = &result;
2571 while( pA && pB ){
2572 if( pA->pgno<pB->pgno ){
2573 pTail->pDirty = pA;
2574 pTail = pA;
2575 pA = pA->pDirty;
2576 }else{
2577 pTail->pDirty = pB;
2578 pTail = pB;
2579 pB = pB->pDirty;
2580 }
2581 }
2582 if( pA ){
2583 pTail->pDirty = pA;
2584 }else if( pB ){
2585 pTail->pDirty = pB;
2586 }else{
2587 pTail->pDirty = 0;
2588 }
2589 return result.pDirty;
2590}
2591
2592/*
2593** Sort the list of pages in accending order by pgno. Pages are
2594** connected by pDirty pointers. The pPrevDirty pointers are
2595** corrupted by this sort.
2596*/
danielk197724168722007-04-02 05:07:47 +00002597#define N_SORT_BUCKET_ALLOC 25
2598#define N_SORT_BUCKET 25
2599#ifdef SQLITE_TEST
2600 int sqlite3_pager_n_sort_bucket = 0;
2601 #undef N_SORT_BUCKET
2602 #define N_SORT_BUCKET \
2603 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2604#endif
drhdc3e10b2006-06-15 14:31:06 +00002605static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002606 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002607 int i;
2608 memset(a, 0, sizeof(a));
2609 while( pIn ){
2610 p = pIn;
2611 pIn = p->pDirty;
2612 p->pDirty = 0;
2613 for(i=0; i<N_SORT_BUCKET-1; i++){
2614 if( a[i]==0 ){
2615 a[i] = p;
2616 break;
2617 }else{
2618 p = merge_pagelist(a[i], p);
2619 a[i] = 0;
2620 }
2621 }
2622 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002623 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2624 ** elements in the input list. This is possible, but impractical.
2625 ** Testing this line is the point of global variable
2626 ** sqlite3_pager_n_sort_bucket.
2627 */
drhdc3e10b2006-06-15 14:31:06 +00002628 a[i] = merge_pagelist(a[i], p);
2629 }
2630 }
2631 p = a[0];
2632 for(i=1; i<N_SORT_BUCKET; i++){
2633 p = merge_pagelist(p, a[i]);
2634 }
2635 return p;
2636}
2637
2638/*
drh2554f8b2003-01-22 01:26:44 +00002639** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2640** every one of those pages out to the database file and mark them all
2641** as clean.
2642*/
2643static int pager_write_pagelist(PgHdr *pList){
2644 Pager *pPager;
2645 int rc;
2646
2647 if( pList==0 ) return SQLITE_OK;
2648 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002649
2650 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2651 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002652 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002653 **
drha6abd042004-06-09 17:37:22 +00002654 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2655 ** through an intermediate state PENDING. A PENDING lock prevents new
2656 ** readers from attaching to the database but is unsufficient for us to
2657 ** write. The idea of a PENDING lock is to prevent new readers from
2658 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002659 **
drha6abd042004-06-09 17:37:22 +00002660 ** While the pager is in the RESERVED state, the original database file
2661 ** is unchanged and we can rollback without having to playback the
2662 ** journal into the original database file. Once we transition to
2663 ** EXCLUSIVE, it means the database file has been changed and any rollback
2664 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002665 */
drh684917c2004-10-05 02:41:42 +00002666 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002667 if( rc!=SQLITE_OK ){
2668 return rc;
2669 }
2670
drhdc3e10b2006-06-15 14:31:06 +00002671 pList = sort_pagelist(pList);
drh2554f8b2003-01-22 01:26:44 +00002672 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002673
2674 /* If the file has not yet been opened, open it now. */
2675 if( !pPager->fd->pMethods ){
2676 assert(pPager->tempFile);
2677 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename);
2678 if( rc ) return rc;
2679 }
2680
drh2554f8b2003-01-22 01:26:44 +00002681 assert( pList->dirty );
danielk1977687566d2004-11-02 12:56:41 +00002682 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002683 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002684 ** make the file smaller (presumably by auto-vacuum code). Do not write
2685 ** any such pages to the file.
2686 */
2687 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00002688 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00002689 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00002690 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2691 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002692 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002693 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002694 PAGER_INCR(sqlite3_pager_writedb_count);
2695 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002696 if( pList->pgno==1 ){
2697 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2698 }
danielk1977687566d2004-11-02 12:56:41 +00002699 }
2700#ifndef NDEBUG
2701 else{
drh4f0c5872007-03-26 22:05:01 +00002702 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002703 }
2704#endif
drh2554f8b2003-01-22 01:26:44 +00002705 if( rc ) return rc;
2706 pList->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002707#ifdef SQLITE_CHECK_PAGES
2708 pList->pageHash = pager_pagehash(pList);
2709#endif
drh2554f8b2003-01-22 01:26:44 +00002710 pList = pList->pDirty;
2711 }
2712 return SQLITE_OK;
2713}
2714
2715/*
2716** Collect every dirty page into a dirty list and
2717** return a pointer to the head of that list. All pages are
2718** collected even if they are still in use.
2719*/
2720static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh605ad8f2006-05-03 23:34:05 +00002721 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00002722}
2723
2724/*
drh165ffe92005-03-15 17:09:30 +00002725** Return TRUE if there is a hot journal on the given pager.
2726** A hot journal is one that needs to be played back.
2727**
2728** If the current size of the database file is 0 but a journal file
2729** exists, that is probably an old journal left over from a prior
2730** database with the same name. Just delete the journal.
2731*/
2732static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00002733 sqlite3_vfs *pVfs = pPager->pVfs;
drh165ffe92005-03-15 17:09:30 +00002734 if( !pPager->useJournal ) return 0;
danielk1977b4b47412007-08-17 15:53:36 +00002735 if( !sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS) ){
drhbb5f18d2007-04-06 18:23:17 +00002736 return 0;
2737 }
2738 if( sqlite3OsCheckReservedLock(pPager->fd) ){
2739 return 0;
2740 }
danielk19773b8a05f2007-03-19 17:44:26 +00002741 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00002742 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00002743 return 0;
2744 }else{
2745 return 1;
2746 }
2747}
2748
danielk19775591df52005-12-20 09:19:37 +00002749/*
danielk1977aef0bf62005-12-30 16:28:01 +00002750** Try to find a page in the cache that can be recycled.
2751**
2752** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00002753** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00002754*/
danielk197713f72992005-12-18 08:51:22 +00002755static int pager_recycle(Pager *pPager, int syncOk, PgHdr **ppPg){
2756 PgHdr *pPg;
2757 *ppPg = 0;
2758
danielk1977c551edc2007-04-05 13:12:13 +00002759 assert(!MEMDB);
2760
danielk197713f72992005-12-18 08:51:22 +00002761 /* Find a page to recycle. Try to locate a page that does not
2762 ** require us to do an fsync() on the journal.
2763 */
2764 pPg = pPager->pFirstSynced;
2765
2766 /* If we could not find a page that does not require an fsync()
2767 ** on the journal file then fsync the journal file. This is a
2768 ** very slow operation, so we work hard to avoid it. But sometimes
2769 ** it can't be helped.
2770 */
drh8940f4e2007-08-11 00:26:20 +00002771 if( pPg==0 && pPager->pFirst && syncOk && !MEMDB){
danielk197713f72992005-12-18 08:51:22 +00002772 int rc = syncJournal(pPager);
2773 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002774 return rc;
danielk197713f72992005-12-18 08:51:22 +00002775 }
2776 if( pPager->fullSync ){
2777 /* If in full-sync mode, write a new journal header into the
2778 ** journal file. This is done to avoid ever modifying a journal
2779 ** header that is involved in the rollback of pages that have
2780 ** already been written to the database (in case the header is
2781 ** trashed when the nRec field is updated).
2782 */
2783 pPager->nRec = 0;
2784 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00002785 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00002786 rc = writeJournalHdr(pPager);
2787 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002788 return rc;
danielk197713f72992005-12-18 08:51:22 +00002789 }
2790 }
2791 pPg = pPager->pFirst;
2792 }
2793 if( pPg==0 ){
2794 return SQLITE_OK;
2795 }
2796
2797 assert( pPg->nRef==0 );
2798
2799 /* Write the page to the database file if it is dirty.
2800 */
2801 if( pPg->dirty ){
2802 int rc;
2803 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00002804 makeClean(pPg);
2805 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00002806 pPg->pDirty = 0;
2807 rc = pager_write_pagelist( pPg );
2808 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002809 return rc;
danielk197713f72992005-12-18 08:51:22 +00002810 }
2811 }
2812 assert( pPg->dirty==0 );
2813
2814 /* If the page we are recycling is marked as alwaysRollback, then
2815 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00002816 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00002817 ** It is necessary to do this because the page marked alwaysRollback
2818 ** might be reloaded at a later time but at that point we won't remember
2819 ** that is was marked alwaysRollback. This means that all pages must
2820 ** be marked as alwaysRollback from here on out.
2821 */
2822 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00002823 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00002824 pPager->alwaysRollback = 1;
2825 }
2826
2827 /* Unlink the old page from the free list and the hash table
2828 */
2829 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00002830 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00002831
2832 *ppPg = pPg;
2833 return SQLITE_OK;
2834}
2835
drh86f8c192007-08-22 00:39:19 +00002836#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00002837/*
2838** This function is called to free superfluous dynamically allocated memory
2839** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00002840** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00002841**
2842** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00002843** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00002844** of bytes of memory released.
2845*/
danielk19773b8a05f2007-03-19 17:44:26 +00002846int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00002847 int nReleased = 0; /* Bytes of memory released so far */
2848 sqlite3_mutex *mutex; /* The MEM2 mutex */
2849 Pager *pPager; /* For looping over pagers */
2850 int i; /* Passes over pagers */
danielk197713f72992005-12-18 08:51:22 +00002851
drh86f8c192007-08-22 00:39:19 +00002852 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00002853 */
drh86f8c192007-08-22 00:39:19 +00002854 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2855 sqlite3_mutex_enter(mutex);
2856
2857 /* Signal all database connections that memory management wants
2858 ** to have access to the pagers.
2859 */
2860 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
2861 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00002862 }
2863
danielk197713f72992005-12-18 08:51:22 +00002864 /* Outermost loop runs for at most two iterations. First iteration we
2865 ** try to find memory that can be released without calling fsync(). Second
2866 ** iteration (which only runs if the first failed to free nReq bytes of
2867 ** memory) is permitted to call fsync(). This is of course much more
2868 ** expensive.
2869 */
drh29c636b2006-01-09 23:40:25 +00002870 for(i=0; i<=1; i++){
danielk197713f72992005-12-18 08:51:22 +00002871
2872 /* Loop through all the SQLite pagers opened by the current thread. */
drh86f8c192007-08-22 00:39:19 +00002873 Pager *pPager = sqlite3PagerList;
danielk197738ec0cb2007-04-05 14:29:42 +00002874 for( ; pPager && (nReq<0 || nReleased<nReq); pPager=pPager->pNext){
danielk197713f72992005-12-18 08:51:22 +00002875 PgHdr *pPg;
2876 int rc;
2877
drh86f8c192007-08-22 00:39:19 +00002878 /* In-memory databases should not appear on the pager list */
2879 assert( !MEMDB );
2880
2881 /* Skip pagers that are currently in use by the b-tree layer */
2882 if( pPager->iInUseDB ) continue;
danielk1977c551edc2007-04-05 13:12:13 +00002883
danielk197713f72992005-12-18 08:51:22 +00002884 /* For each pager, try to free as many pages as possible (without
2885 ** calling fsync() if this is the first iteration of the outermost
2886 ** loop).
2887 */
danielk197738ec0cb2007-04-05 14:29:42 +00002888 while( SQLITE_OK==(rc = pager_recycle(pPager, i, &pPg)) && pPg) {
danielk1977aef0bf62005-12-30 16:28:01 +00002889 /* We've found a page to free. At this point the page has been
danielk197713f72992005-12-18 08:51:22 +00002890 ** removed from the page hash-table, free-list and synced-list
danielk1977aef0bf62005-12-30 16:28:01 +00002891 ** (pFirstSynced). It is still in the all pages (pAll) list.
danielk197713f72992005-12-18 08:51:22 +00002892 ** Remove it from this list before freeing.
2893 **
2894 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
2895 ** probably is though.
2896 */
2897 PgHdr *pTmp;
danielk19770190d1d2005-12-19 14:18:11 +00002898 assert( pPg );
danielk197738ec0cb2007-04-05 14:29:42 +00002899 if( pPg==pPager->pAll ){
2900 pPager->pAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00002901 }else{
danielk197738ec0cb2007-04-05 14:29:42 +00002902 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
danielk197713f72992005-12-18 08:51:22 +00002903 pTmp->pNextAll = pPg->pNextAll;
2904 }
danielk19771e536952007-08-16 10:09:01 +00002905 nReleased += (
2906 sizeof(*pPg) + pPager->pageSize
2907 + sizeof(u32) + pPager->nExtra
2908 + MEMDB*sizeof(PgHistory)
2909 );
drh34f56212007-08-10 23:56:35 +00002910 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
drh538f5702007-04-13 02:14:30 +00002911 PAGER_INCR(sqlite3_pager_pgfree_count);
drh17435752007-08-16 04:30:38 +00002912 sqlite3_free(pPg);
danielk197713f72992005-12-18 08:51:22 +00002913 }
2914
2915 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002916 /* An error occured whilst writing to the database file or
2917 ** journal in pager_recycle(). The error is not returned to the
danielk1977efaaf572006-01-16 11:29:19 +00002918 ** caller of this function. Instead, set the Pager.errCode variable.
danielk1977aef0bf62005-12-30 16:28:01 +00002919 ** The error will be returned to the user (or users, in the case
2920 ** of a shared pager cache) of the pager for which the error occured.
danielk197713f72992005-12-18 08:51:22 +00002921 */
drh34f56212007-08-10 23:56:35 +00002922 assert(
2923 (rc&0xff)==SQLITE_IOERR ||
2924 rc==SQLITE_FULL ||
2925 rc==SQLITE_BUSY
2926 );
danielk197738ec0cb2007-04-05 14:29:42 +00002927 assert( pPager->state>=PAGER_RESERVED );
2928 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00002929 }
2930 }
2931 }
danielk1977aef0bf62005-12-30 16:28:01 +00002932
drh86f8c192007-08-22 00:39:19 +00002933 /* Clear the memory management flags and release the mutex
2934 */
2935 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
2936 pPager->iInUseMM = 0;
2937 }
2938 sqlite3_mutex_leave(mutex);
2939
2940 /* Return the number of bytes released
2941 */
danielk197713f72992005-12-18 08:51:22 +00002942 return nReleased;
2943}
drh86f8c192007-08-22 00:39:19 +00002944#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00002945
drh165ffe92005-03-15 17:09:30 +00002946/*
danielk1977e180dd92007-04-05 17:15:52 +00002947** Read the content of page pPg out of the database file.
2948*/
2949static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2950 int rc;
danielk197762079062007-08-15 17:08:46 +00002951 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002952 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002953 assert(pPager->fd->pMethods||pPager->tempFile);
2954 if( !pPager->fd->pMethods ){
2955 return SQLITE_IOERR_SHORT_READ;
2956 }
danielk197762079062007-08-15 17:08:46 +00002957 offset = (pgno-1)*(i64)pPager->pageSize;
2958 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002959 PAGER_INCR(sqlite3_pager_readdb_count);
2960 PAGER_INCR(pPager->nRead);
2961 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002962 if( pgno==1 ){
2963 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
2964 sizeof(pPager->dbFileVers));
2965 }
danielk1977e180dd92007-04-05 17:15:52 +00002966 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002967 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2968 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002969 return rc;
2970}
2971
2972
2973/*
danielk1977e277be02007-03-23 18:12:06 +00002974** This function is called to obtain the shared lock required before
2975** data may be read from the pager cache. If the shared lock has already
2976** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002977**
2978** Immediately after obtaining the shared lock (if required), this function
2979** checks for a hot-journal file. If one is found, an emergency rollback
2980** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002981*/
2982static int pagerSharedLock(Pager *pPager){
2983 int rc = SQLITE_OK;
2984
2985 if( pPager->state==PAGER_UNLOCK ){
danielk1977b4b47412007-08-17 15:53:36 +00002986 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00002987 if( !MEMDB ){
2988 assert( pPager->nRef==0 );
2989 if( !pPager->noReadlock ){
2990 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2991 if( rc!=SQLITE_OK ){
2992 return pager_error(pPager, rc);
2993 }
2994 assert( pPager->state>=SHARED_LOCK );
2995 }
2996
2997 /* If a journal file exists, and there is no RESERVED lock on the
2998 ** database file, then it either needs to be played back or deleted.
2999 */
3000 if( hasHotJournal(pPager) ){
3001 /* Get an EXCLUSIVE lock on the database file. At this point it is
3002 ** important that a RESERVED lock is not obtained on the way to the
3003 ** EXCLUSIVE lock. If it were, another process might open the
3004 ** database file, detect the RESERVED lock, and conclude that the
3005 ** database is safe to read while this process is still rolling it
3006 ** back.
3007 **
3008 ** Because the intermediate RESERVED lock is not requested, the
3009 ** second process will get to this point in the code and fail to
3010 ** obtain it's own EXCLUSIVE lock on the database file.
3011 */
3012 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3013 if( rc!=SQLITE_OK ){
3014 pager_unlock(pPager);
3015 return pager_error(pPager, rc);
3016 }
3017 pPager->state = PAGER_EXCLUSIVE;
3018
3019 /* Open the journal for reading only. Return SQLITE_BUSY if
3020 ** we are unable to open the journal file.
3021 **
3022 ** The journal file does not need to be locked itself. The
3023 ** journal file is never open unless the main database file holds
3024 ** a write lock, so there is never any chance of two or more
3025 ** processes opening the journal at the same time.
danielk1977979f38e2007-03-27 16:19:51 +00003026 **
drhfd131da2007-08-07 17:13:03 +00003027 ** Open the journal for read/write access. This is because in
3028 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003029 ** possibly used for a transaction later on. On some systems, the
3030 ** OsTruncate() call used in exclusive-access mode also requires
3031 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003032 */
danielk1977979f38e2007-03-27 16:19:51 +00003033 rc = SQLITE_BUSY;
danielk1977b4b47412007-08-17 15:53:36 +00003034 if( sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS) ){
3035 int fout = 0;
danielk1977fee2d252007-08-18 10:59:19 +00003036 int flags = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
danielk19777152de82007-03-29 17:28:14 +00003037 assert( !pPager->tempFile );
danielk1977c7b60172007-08-22 11:22:03 +00003038 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags,&fout);
danielk1977b4b47412007-08-17 15:53:36 +00003039 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3040 if( fout&SQLITE_OPEN_READONLY ){
danielk1977979f38e2007-03-27 16:19:51 +00003041 rc = SQLITE_BUSY;
danielk1977b4b47412007-08-17 15:53:36 +00003042 sqlite3OsClose(pPager->jfd);
danielk1977979f38e2007-03-27 16:19:51 +00003043 }
3044 }
danielk1977e277be02007-03-23 18:12:06 +00003045 if( rc!=SQLITE_OK ){
3046 pager_unlock(pPager);
3047 return SQLITE_BUSY;
3048 }
3049 pPager->journalOpen = 1;
3050 pPager->journalStarted = 0;
3051 pPager->journalOff = 0;
3052 pPager->setMaster = 0;
3053 pPager->journalHdr = 0;
3054
3055 /* Playback and delete the journal. Drop the database write
3056 ** lock and reacquire the read lock.
3057 */
3058 rc = pager_playback(pPager, 1);
3059 if( rc!=SQLITE_OK ){
3060 return pager_error(pPager, rc);
3061 }
danielk1977c5859712007-03-26 12:26:27 +00003062 assert(pPager->state==PAGER_SHARED ||
3063 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3064 );
danielk1977e277be02007-03-23 18:12:06 +00003065 }
3066
3067 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003068 /* The shared-lock has just been acquired on the database file
3069 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003070 ** read or write transaction). Check to see if the database
3071 ** has been modified. If the database has changed, flush the
3072 ** cache.
3073 **
3074 ** Database changes is detected by looking at 15 bytes beginning
3075 ** at offset 24 into the file. The first 4 of these 16 bytes are
3076 ** a 32-bit counter that is incremented with each change. The
3077 ** other bytes change randomly with each file change when
3078 ** a codec is in use.
3079 **
3080 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003081 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003082 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003083 */
drh86a88112007-04-16 15:02:19 +00003084 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003085 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003086
danielk1977e180dd92007-04-05 17:15:52 +00003087 if( pPager->errCode ){
3088 return pPager->errCode;
danielk1977e277be02007-03-23 18:12:06 +00003089 }
3090
danielk1977e180dd92007-04-05 17:15:52 +00003091 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003092 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003093 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003094 if( rc!=SQLITE_OK ){
3095 return rc;
3096 }
drh86a88112007-04-16 15:02:19 +00003097 }else{
3098 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003099 }
3100
drh86a88112007-04-16 15:02:19 +00003101 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003102 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003103 }
3104 }
3105 }
danielk1977c5859712007-03-26 12:26:27 +00003106 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3107 if( pPager->state==PAGER_UNLOCK ){
3108 pPager->state = PAGER_SHARED;
3109 }
danielk1977e277be02007-03-23 18:12:06 +00003110 }
3111
3112 return rc;
3113}
3114
3115/*
danielk1977e180dd92007-04-05 17:15:52 +00003116** Allocate a PgHdr object. Either create a new one or reuse
3117** an existing one that is not otherwise in use.
3118**
3119** A new PgHdr structure is created if any of the following are
3120** true:
3121**
3122** (1) We have not exceeded our maximum allocated cache size
3123** as set by the "PRAGMA cache_size" command.
3124**
3125** (2) There are no unused PgHdr objects available at this time.
3126**
3127** (3) This is an in-memory database.
3128**
3129** (4) There are no PgHdr objects that do not require a journal
3130** file sync and a sync of the journal file is currently
3131** prohibited.
3132**
3133** Otherwise, reuse an existing PgHdr. In other words, reuse an
3134** existing PgHdr if all of the following are true:
3135**
3136** (1) We have reached or exceeded the maximum cache size
3137** allowed by "PRAGMA cache_size".
3138**
3139** (2) There is a PgHdr available with PgHdr->nRef==0
3140**
3141** (3) We are not in an in-memory database
3142**
3143** (4) Either there is an available PgHdr that does not need
3144** to be synced to disk or else disk syncing is currently
3145** allowed.
danielk197724168722007-04-02 05:07:47 +00003146*/
3147static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3148 int rc = SQLITE_OK;
3149 PgHdr *pPg;
3150
danielk1977e180dd92007-04-05 17:15:52 +00003151 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003152 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003153 if( pPager->nPage<pPager->mxPage
3154 || pPager->pFirst==0
3155 || MEMDB
3156 || (pPager->pFirstSynced==0 && pPager->doNotSync)
3157 ){
danielk197724168722007-04-02 05:07:47 +00003158 if( pPager->nPage>=pPager->nHash ){
3159 pager_resize_hash_table(pPager,
3160 pPager->nHash<256 ? 256 : pPager->nHash*2);
3161 if( pPager->nHash==0 ){
3162 rc = SQLITE_NOMEM;
3163 goto pager_allocate_out;
3164 }
3165 }
drh17435752007-08-16 04:30:38 +00003166 pPg = sqlite3_malloc( sizeof(*pPg) + pPager->pageSize
danielk197724168722007-04-02 05:07:47 +00003167 + sizeof(u32) + pPager->nExtra
3168 + MEMDB*sizeof(PgHistory) );
3169 if( pPg==0 ){
3170 rc = SQLITE_NOMEM;
3171 goto pager_allocate_out;
3172 }
3173 memset(pPg, 0, sizeof(*pPg));
3174 if( MEMDB ){
3175 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
3176 }
3177 pPg->pPager = pPager;
3178 pPg->pNextAll = pPager->pAll;
3179 pPager->pAll = pPg;
3180 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003181 }else{
3182 /* Recycle an existing page with a zero ref-count. */
3183 rc = pager_recycle(pPager, 1, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003184 if( rc==SQLITE_BUSY ){
3185 rc = SQLITE_IOERR_BLOCKED;
3186 }
danielk197724168722007-04-02 05:07:47 +00003187 if( rc!=SQLITE_OK ){
3188 goto pager_allocate_out;
3189 }
3190 assert( pPager->state>=SHARED_LOCK );
3191 assert(pPg);
3192 }
3193 *ppPg = pPg;
3194
3195pager_allocate_out:
3196 return rc;
3197}
3198
3199/*
drhd33d5a82007-04-26 12:11:28 +00003200** Make sure we have the content for a page. If the page was
3201** previously acquired with noContent==1, then the content was
3202** just initialized to zeros instead of being read from disk.
3203** But now we need the real data off of disk. So make sure we
3204** have it. Read it in if we do not have it already.
3205*/
3206static int pager_get_content(PgHdr *pPg){
3207 if( pPg->needRead ){
3208 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3209 if( rc==SQLITE_OK ){
3210 pPg->needRead = 0;
3211 }else{
3212 return rc;
3213 }
3214 }
3215 return SQLITE_OK;
3216}
3217
3218/*
drhd9b02572001-04-15 00:37:09 +00003219** Acquire a page.
3220**
drh58a11682001-11-10 13:51:08 +00003221** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003222** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003223**
drhd33d5a82007-04-26 12:11:28 +00003224** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003225** file is smaller than the requested page, then no actual disk
3226** read occurs and the memory image of the page is initialized to
3227** all zeros. The extra data appended to a page is always initialized
3228** to zeros the first time a page is loaded into memory.
3229**
drhd9b02572001-04-15 00:37:09 +00003230** The acquisition might fail for several reasons. In all cases,
3231** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003232**
drhd33d5a82007-04-26 12:11:28 +00003233** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003234** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003235** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003236** just returns 0. This routine acquires a read-lock the first time it
3237** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003238** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003239** or journal files.
drh0787db62007-03-04 13:15:27 +00003240**
drh538f5702007-04-13 02:14:30 +00003241** If noContent is false, the page contents are actually read from disk.
3242** If noContent is true, it means that we do not care about the contents
3243** of the page at this time, so do not do a disk read. Just fill in the
3244** page content with zeros. But mark the fact that we have not read the
3245** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003246** sqlite3PagerWrite() is called on this page or if this routine is
3247** called again with noContent==0, that means that the content is needed
3248** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003249*/
drh86f8c192007-08-22 00:39:19 +00003250static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003251 Pager *pPager, /* The pager open on the database file */
3252 Pgno pgno, /* Page number to fetch */
3253 DbPage **ppPage, /* Write a pointer to the page here */
3254 int noContent /* Do not bother reading content from disk if true */
3255){
drhed7c8552001-04-11 14:29:21 +00003256 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003257 int rc;
drhed7c8552001-04-11 14:29:21 +00003258
danielk1977e277be02007-03-23 18:12:06 +00003259 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3260
danielk197726836652005-01-17 01:33:13 +00003261 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3262 ** number greater than this, or zero, is requested.
3263 */
drh267cb322005-09-16 17:16:52 +00003264 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003265 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003266 }
3267
drhd9b02572001-04-15 00:37:09 +00003268 /* Make sure we have not hit any critical errors.
3269 */
drh836faa42003-01-11 13:30:57 +00003270 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003271 *ppPage = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003272 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3273 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003274 }
3275
danielk197713adf8a2004-06-03 16:08:41 +00003276 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003277 ** on the database file. pagerSharedLock() is a no-op if
3278 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003279 */
danielk1977e277be02007-03-23 18:12:06 +00003280 rc = pagerSharedLock(pPager);
3281 if( rc!=SQLITE_OK ){
3282 return rc;
drhed7c8552001-04-11 14:29:21 +00003283 }
danielk1977e277be02007-03-23 18:12:06 +00003284 assert( pPager->state!=PAGER_UNLOCK );
3285
3286 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003287 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003288 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003289 int nMax;
drhed7c8552001-04-11 14:29:21 +00003290 int h;
drh538f5702007-04-13 02:14:30 +00003291 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003292 rc = pagerAllocatePage(pPager, &pPg);
3293 if( rc!=SQLITE_OK ){
3294 return rc;
drhed7c8552001-04-11 14:29:21 +00003295 }
danielk197724168722007-04-02 05:07:47 +00003296
drhed7c8552001-04-11 14:29:21 +00003297 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003298 assert( !MEMDB || pgno>pPager->stmtSize );
drh1ab43002002-01-14 09:28:19 +00003299 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19771e536952007-08-16 10:09:01 +00003300#if 0
danielk19774adee202004-05-08 08:23:19 +00003301 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
danielk19771e536952007-08-16 10:09:01 +00003302#endif
drhdb48ee02003-01-16 13:42:43 +00003303 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00003304 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00003305 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00003306 }else{
3307 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00003308 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00003309 }
danielk1977f35843b2007-04-07 15:03:17 +00003310
drh605ad8f2006-05-03 23:34:05 +00003311 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003312 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00003313 REFINFO(pPg);
danielk197775bab7d2006-01-23 13:09:45 +00003314
drhd9b02572001-04-15 00:37:09 +00003315 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003316 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003317 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003318 }
danielk1977979f38e2007-03-27 16:19:51 +00003319 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003320 if( pPager->errCode ){
danielk19773b8a05f2007-03-19 17:44:26 +00003321 sqlite3PagerUnref(pPg);
danielk1977efaaf572006-01-16 11:29:19 +00003322 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00003323 return rc;
3324 }
danielk197775bab7d2006-01-23 13:09:45 +00003325
3326 /* Populate the page with data, either by reading from the database
3327 ** file, or by setting the entire page to zero.
3328 */
drhd215acf2007-04-13 04:01:58 +00003329 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003330 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003331 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003332 return SQLITE_FULL;
3333 }
drh90f5ecb2004-07-22 01:19:35 +00003334 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003335 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003336 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003337 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003338 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003339 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3340 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003341 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003342 return rc;
drh81a20f22001-10-12 17:30:04 +00003343 }
danielk1977b4626a32007-04-28 15:47:43 +00003344 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003345 }
danielk197775bab7d2006-01-23 13:09:45 +00003346
3347 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003348 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003349 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003350 pPg->pNextHash = pPager->aHash[h];
3351 pPager->aHash[h] = pPg;
3352 if( pPg->pNextHash ){
3353 assert( pPg->pNextHash->pPrevHash==0 );
3354 pPg->pNextHash->pPrevHash = pPg;
3355 }
3356
danielk19773c407372005-02-15 02:54:14 +00003357#ifdef SQLITE_CHECK_PAGES
3358 pPg->pageHash = pager_pagehash(pPg);
3359#endif
drhed7c8552001-04-11 14:29:21 +00003360 }else{
drhd9b02572001-04-15 00:37:09 +00003361 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003362 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003363 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003364 if( !noContent ){
3365 rc = pager_get_content(pPg);
3366 if( rc ){
3367 return rc;
3368 }
3369 }
drhdf0b3b02001-06-23 11:36:20 +00003370 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003371 }
danielk19773b8a05f2007-03-19 17:44:26 +00003372 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003373 return SQLITE_OK;
3374}
drh86f8c192007-08-22 00:39:19 +00003375int sqlite3PagerAcquire(
3376 Pager *pPager, /* The pager open on the database file */
3377 Pgno pgno, /* Page number to fetch */
3378 DbPage **ppPage, /* Write a pointer to the page here */
3379 int noContent /* Do not bother reading content from disk if true */
3380){
3381 int rc;
3382 pagerEnter(pPager);
3383 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3384 pagerLeave(pPager);
3385 return rc;
3386}
3387
drhed7c8552001-04-11 14:29:21 +00003388
3389/*
drh7e3b0a02001-04-28 16:52:40 +00003390** Acquire a page if it is already in the in-memory cache. Do
3391** not read the page from disk. Return a pointer to the page,
3392** or 0 if the page is not in cache.
3393**
danielk19773b8a05f2007-03-19 17:44:26 +00003394** See also sqlite3PagerGet(). The difference between this routine
3395** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003396** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003397** returns NULL if the page is not in cache or if a disk I/O error
3398** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003399*/
danielk19773b8a05f2007-03-19 17:44:26 +00003400DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003401 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003402
drh836faa42003-01-11 13:30:57 +00003403 assert( pPager!=0 );
3404 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003405
drh86f8c192007-08-22 00:39:19 +00003406 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003407 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003408 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003409 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3410 /* Do nothing */
3411 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3412 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003413 }
drh86f8c192007-08-22 00:39:19 +00003414 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003415 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003416}
3417
3418/*
drhed7c8552001-04-11 14:29:21 +00003419** Release a page.
3420**
3421** If the number of references to the page drop to zero, then the
3422** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003423** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003424** removed.
3425*/
danielk19773b8a05f2007-03-19 17:44:26 +00003426int sqlite3PagerUnref(DbPage *pPg){
drhd9b02572001-04-15 00:37:09 +00003427
3428 /* Decrement the reference count for this page
3429 */
drhed7c8552001-04-11 14:29:21 +00003430 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003431 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003432 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00003433 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00003434
danielk19773c407372005-02-15 02:54:14 +00003435 CHECK_PAGE(pPg);
3436
drh72f82862001-05-24 21:06:34 +00003437 /* When the number of references to a page reach 0, call the
3438 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003439 */
drhed7c8552001-04-11 14:29:21 +00003440 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00003441 Pager *pPager;
3442 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003443 pPg->pNextFree = 0;
3444 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00003445 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00003446 if( pPg->pPrevFree ){
3447 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00003448 }else{
3449 pPager->pFirst = pPg;
3450 }
drh341eae82003-01-21 02:39:36 +00003451 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
3452 pPager->pFirstSynced = pPg;
3453 }
drh72f82862001-05-24 21:06:34 +00003454 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003455 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003456 }
drhd9b02572001-04-15 00:37:09 +00003457
3458 /* When all pages reach the freelist, drop the read lock from
3459 ** the database file.
3460 */
3461 pPager->nRef--;
3462 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003463 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003464 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003465 }
drhed7c8552001-04-11 14:29:21 +00003466 }
drh86f8c192007-08-22 00:39:19 +00003467 pagerLeave(pPg->pPager);
drhd9b02572001-04-15 00:37:09 +00003468 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003469}
3470
3471/*
drha6abd042004-06-09 17:37:22 +00003472** Create a journal file for pPager. There should already be a RESERVED
3473** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003474**
3475** Return SQLITE_OK if everything. Return an error code and release the
3476** write lock if anything goes wrong.
3477*/
3478static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003479 sqlite3_vfs *pVfs = pPager->pVfs;
3480 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3481
drhda47d772002-12-02 04:25:19 +00003482 int rc;
drhb7f91642004-10-31 02:22:47 +00003483 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003484 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003485 assert( pPager->journalOpen==0 );
3486 assert( pPager->useJournal );
drh88b01a12005-03-28 18:04:27 +00003487 assert( pPager->aInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003488 sqlite3PagerPagecount(pPager);
drh17435752007-08-16 04:30:38 +00003489 pPager->aInJournal = sqlite3MallocZero( pPager->dbSize/8 + 1 );
drhda47d772002-12-02 04:25:19 +00003490 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003491 rc = SQLITE_NOMEM;
3492 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003493 }
danielk1977b4b47412007-08-17 15:53:36 +00003494
3495 if( pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +00003496 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3497 }else{
3498 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
danielk1977b4b47412007-08-17 15:53:36 +00003499 }
danielk1977c7b60172007-08-22 11:22:03 +00003500#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3501 rc = sqlite3JournalOpen(
3502 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3503 );
3504#else
danielk1977b4b47412007-08-17 15:53:36 +00003505 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
danielk1977c7b60172007-08-22 11:22:03 +00003506#endif
danielk1977b4b47412007-08-17 15:53:36 +00003507 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk197776572402004-06-25 02:38:54 +00003508 pPager->journalOff = 0;
3509 pPager->setMaster = 0;
3510 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00003511 if( rc!=SQLITE_OK ){
drh600e46a2007-03-28 01:59:33 +00003512 if( rc==SQLITE_NOMEM ){
danielk1977fee2d252007-08-18 10:59:19 +00003513 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh600e46a2007-03-28 01:59:33 +00003514 }
drh9c105bb2004-10-02 20:38:28 +00003515 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003516 }
3517 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003518 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003519 pPager->needSync = 0;
3520 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003521 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003522 if( pPager->errCode ){
3523 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003524 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003525 }
drhda47d772002-12-02 04:25:19 +00003526 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003527
danielk197776572402004-06-25 02:38:54 +00003528 rc = writeJournalHdr(pPager);
3529
drhac69b052004-05-12 13:30:07 +00003530 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003531 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003532 }
danielk1977261919c2005-12-06 12:52:59 +00003533 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003534 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003535 if( rc==SQLITE_OK ){
3536 rc = SQLITE_FULL;
3537 }
3538 }
drh9c105bb2004-10-02 20:38:28 +00003539 return rc;
3540
3541failed_to_open_journal:
drh17435752007-08-16 04:30:38 +00003542 sqlite3_free(pPager->aInJournal);
drh9c105bb2004-10-02 20:38:28 +00003543 pPager->aInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003544 return rc;
drhda47d772002-12-02 04:25:19 +00003545}
3546
3547/*
drh4b845d72002-03-05 12:41:19 +00003548** Acquire a write-lock on the database. The lock is removed when
3549** the any of the following happen:
3550**
drh80e35f42007-03-30 14:06:34 +00003551** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003552** * sqlite3PagerRollback() is called.
3553** * sqlite3PagerClose() is called.
3554** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003555**
danielk197713adf8a2004-06-03 16:08:41 +00003556** The first parameter to this routine is a pointer to any open page of the
3557** database file. Nothing changes about the page - it is used merely to
3558** acquire a pointer to the Pager structure and as proof that there is
3559** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003560**
danielk197713adf8a2004-06-03 16:08:41 +00003561** The second parameter indicates how much space in bytes to reserve for a
3562** master journal file-name at the start of the journal when it is created.
3563**
3564** A journal file is opened if this is not a temporary file. For temporary
3565** files, the opening of the journal file is deferred until there is an
3566** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003567**
drha6abd042004-06-09 17:37:22 +00003568** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003569**
3570** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3571** immediately instead of waiting until we try to flush the cache. The
3572** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003573*/
danielk19773b8a05f2007-03-19 17:44:26 +00003574int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003575 Pager *pPager = pPg->pPager;
3576 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00003577 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00003578 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003579 assert( pPager->state!=PAGER_UNLOCK );
3580 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00003581 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00003582 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003583 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003584 pPager->origDbSize = pPager->dbSize;
3585 }else{
drh054889e2005-11-30 03:20:31 +00003586 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003587 if( rc==SQLITE_OK ){
3588 pPager->state = PAGER_RESERVED;
3589 if( exFlag ){
3590 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3591 }
3592 }
danielk19779eed5052004-06-04 10:38:30 +00003593 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00003594 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00003595 return rc;
drhac69b052004-05-12 13:30:07 +00003596 }
drha6abd042004-06-09 17:37:22 +00003597 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003598 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003599 if( pPager->useJournal && !pPager->tempFile ){
3600 rc = pager_open_journal(pPager);
3601 }
drh4b845d72002-03-05 12:41:19 +00003602 }
danielk1977334cdb62007-03-26 08:05:12 +00003603 }else if( pPager->journalOpen && pPager->journalOff==0 ){
3604 /* This happens when the pager was in exclusive-access mode last
3605 ** time a (read or write) transaction was successfully concluded
3606 ** by this connection. Instead of deleting the journal file it was
3607 ** kept open and truncated to 0 bytes.
3608 */
3609 assert( pPager->nRec==0 );
3610 assert( pPager->origDbSize==0 );
drh369339d2007-03-30 16:01:55 +00003611 assert( pPager->aInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00003612 sqlite3PagerPagecount(pPager);
drh17435752007-08-16 04:30:38 +00003613 pPager->aInJournal = sqlite3MallocZero( pPager->dbSize/8 + 1 );
danielk1977334cdb62007-03-26 08:05:12 +00003614 if( !pPager->aInJournal ){
3615 rc = SQLITE_NOMEM;
3616 }else{
drh369339d2007-03-30 16:01:55 +00003617 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003618 rc = writeJournalHdr(pPager);
3619 }
drh4b845d72002-03-05 12:41:19 +00003620 }
danielk1977334cdb62007-03-26 08:05:12 +00003621 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00003622 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00003623 return rc;
3624}
3625
3626/*
drh605ad8f2006-05-03 23:34:05 +00003627** Make a page dirty. Set its dirty flag and add it to the dirty
3628** page list.
3629*/
3630static void makeDirty(PgHdr *pPg){
3631 if( pPg->dirty==0 ){
3632 Pager *pPager = pPg->pPager;
3633 pPg->dirty = 1;
3634 pPg->pDirty = pPager->pDirty;
3635 if( pPager->pDirty ){
3636 pPager->pDirty->pPrevDirty = pPg;
3637 }
3638 pPg->pPrevDirty = 0;
3639 pPager->pDirty = pPg;
3640 }
3641}
3642
3643/*
3644** Make a page clean. Clear its dirty bit and remove it from the
3645** dirty page list.
3646*/
3647static void makeClean(PgHdr *pPg){
3648 if( pPg->dirty ){
3649 pPg->dirty = 0;
3650 if( pPg->pDirty ){
3651 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
3652 }
3653 if( pPg->pPrevDirty ){
3654 pPg->pPrevDirty->pDirty = pPg->pDirty;
3655 }else{
3656 pPg->pPager->pDirty = pPg->pDirty;
3657 }
3658 }
3659}
3660
3661
3662/*
drhed7c8552001-04-11 14:29:21 +00003663** Mark a data page as writeable. The page is written into the journal
3664** if it is not there already. This routine must be called before making
3665** changes to a page.
3666**
3667** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003668** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003669** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003670** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003671** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003672**
3673** If the journal file could not be written because the disk is full,
3674** then this routine returns SQLITE_FULL and does an immediate rollback.
3675** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003676** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003677** reset.
drhed7c8552001-04-11 14:29:21 +00003678*/
danielk19773b8a05f2007-03-19 17:44:26 +00003679static int pager_write(PgHdr *pPg){
3680 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00003681 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003682 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003683
drh6446c4d2001-12-15 14:22:18 +00003684 /* Check for errors
3685 */
danielk1977efaaf572006-01-16 11:29:19 +00003686 if( pPager->errCode ){
3687 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003688 }
drh5e00f6c2001-09-13 13:46:56 +00003689 if( pPager->readOnly ){
3690 return SQLITE_PERM;
3691 }
drh6446c4d2001-12-15 14:22:18 +00003692
danielk197776572402004-06-25 02:38:54 +00003693 assert( !pPager->setMaster );
3694
danielk19773c407372005-02-15 02:54:14 +00003695 CHECK_PAGE(pPg);
3696
drh538f5702007-04-13 02:14:30 +00003697 /* If this page was previously acquired with noContent==1, that means
3698 ** we didn't really read in the content of the page. This can happen
3699 ** (for example) when the page is being moved to the freelist. But
3700 ** now we are (perhaps) moving the page off of the freelist for
3701 ** reuse and we need to know its original content so that content
3702 ** can be stored in the rollback journal. So do the read at this
3703 ** time.
3704 */
drhd33d5a82007-04-26 12:11:28 +00003705 rc = pager_get_content(pPg);
3706 if( rc ){
3707 return rc;
drh538f5702007-04-13 02:14:30 +00003708 }
3709
drh6446c4d2001-12-15 14:22:18 +00003710 /* Mark the page as dirty. If the page has already been written
3711 ** to the journal then we can return right away.
3712 */
drh605ad8f2006-05-03 23:34:05 +00003713 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00003714 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00003715 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003716 }else{
drh6446c4d2001-12-15 14:22:18 +00003717
danielk1977a0bf2652004-11-04 14:30:04 +00003718 /* If we get this far, it means that the page needs to be
3719 ** written to the transaction journal or the ckeckpoint journal
3720 ** or both.
3721 **
3722 ** First check to see that the transaction journal exists and
3723 ** create it if it does not.
3724 */
3725 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003726 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003727 if( rc!=SQLITE_OK ){
3728 return rc;
3729 }
3730 assert( pPager->state>=PAGER_RESERVED );
3731 if( !pPager->journalOpen && pPager->useJournal ){
3732 rc = pager_open_journal(pPager);
3733 if( rc!=SQLITE_OK ) return rc;
3734 }
3735 assert( pPager->journalOpen || !pPager->useJournal );
3736 pPager->dirtyCache = 1;
3737
3738 /* The transaction journal now exists and we have a RESERVED or an
3739 ** EXCLUSIVE lock on the main database file. Write the current page to
3740 ** the transaction journal if it is not there already.
3741 */
3742 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
3743 if( (int)pPg->pgno <= pPager->origDbSize ){
3744 int szPg;
danielk1977a0bf2652004-11-04 14:30:04 +00003745 if( MEMDB ){
3746 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00003747 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003748 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00003749 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00003750 if( pHist->pOrig ){
3751 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
3752 }
3753 }else{
drhc001c582006-03-06 18:23:16 +00003754 u32 cksum, saved;
3755 char *pData2, *pEnd;
danielk1977dd97a492007-08-22 18:54:32 +00003756
drh267cb322005-09-16 17:16:52 +00003757 /* We should never write to the journal file the page that
3758 ** contains the database locks. The following assert verifies
3759 ** that we do not. */
3760 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00003761 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00003762 cksum = pager_cksum(pPager, (u8*)pData2);
drhc001c582006-03-06 18:23:16 +00003763 pEnd = pData2 + pPager->pageSize;
3764 pData2 -= 4;
3765 saved = *(u32*)pEnd;
3766 put32bits(pEnd, cksum);
danielk1977a0bf2652004-11-04 14:30:04 +00003767 szPg = pPager->pageSize+8;
drhc001c582006-03-06 18:23:16 +00003768 put32bits(pData2, pPg->pgno);
danielk197762079062007-08-15 17:08:46 +00003769 rc = sqlite3OsWrite(pPager->jfd, pData2, szPg, pPager->journalOff);
drhb0603412007-02-28 04:47:26 +00003770 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
drh538f5702007-04-13 02:14:30 +00003771 pPager->journalOff, szPg));
3772 PAGER_INCR(sqlite3_pager_writej_count);
danielk1977a0bf2652004-11-04 14:30:04 +00003773 pPager->journalOff += szPg;
drh477731b2007-06-16 03:06:27 +00003774 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
3775 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
drhc001c582006-03-06 18:23:16 +00003776 *(u32*)pEnd = saved;
danielk197707cb5602006-01-20 10:55:05 +00003777
drhfd131da2007-08-07 17:13:03 +00003778 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00003779 ** transaction will be rolled back by the layer above.
3780 */
danielk1977a0bf2652004-11-04 14:30:04 +00003781 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00003782 return rc;
3783 }
danielk197707cb5602006-01-20 10:55:05 +00003784
danielk1977a0bf2652004-11-04 14:30:04 +00003785 pPager->nRec++;
3786 assert( pPager->aInJournal!=0 );
3787 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3788 pPg->needSync = !pPager->noSync;
3789 if( pPager->stmtInUse ){
3790 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
danielk1977a0bf2652004-11-04 14:30:04 +00003791 }
drhac69b052004-05-12 13:30:07 +00003792 }
danielk197713adf8a2004-06-03 16:08:41 +00003793 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00003794 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00003795 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003796 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00003797 }
3798 if( pPg->needSync ){
3799 pPager->needSync = 1;
3800 }
3801 pPg->inJournal = 1;
3802 }
3803
3804 /* If the statement journal is open and the page is not in it,
3805 ** then write the current page to the statement journal. Note that
3806 ** the statement journal format differs from the standard journal format
3807 ** in that it omits the checksums and the header.
3808 */
danielk1977f35843b2007-04-07 15:03:17 +00003809 if( pPager->stmtInUse
3810 && !pageInStatement(pPg)
3811 && (int)pPg->pgno<=pPager->stmtSize
3812 ){
danielk1977a0bf2652004-11-04 14:30:04 +00003813 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
3814 if( MEMDB ){
3815 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3816 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00003817 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00003818 if( pHist->pStmt ){
3819 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
3820 }
drh4f0c5872007-03-26 22:05:01 +00003821 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00003822 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00003823 }else{
danielk197762079062007-08-15 17:08:46 +00003824 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhc001c582006-03-06 18:23:16 +00003825 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7)-4;
3826 put32bits(pData2, pPg->pgno);
danielk197762079062007-08-15 17:08:46 +00003827 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize+4, offset);
drh4f0c5872007-03-26 22:05:01 +00003828 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003829 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00003830 return rc;
3831 }
danielk1977a0bf2652004-11-04 14:30:04 +00003832 pPager->stmtNRec++;
3833 assert( pPager->aInStmt!=0 );
3834 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00003835 }
drhd9b02572001-04-15 00:37:09 +00003836 }
drhfa86c412002-02-02 15:01:15 +00003837 }
3838
3839 /* Update the database size and return.
3840 */
drh1aa2d8b2007-01-03 15:34:29 +00003841 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00003842 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003843 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00003844 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003845 pPager->dbSize++;
3846 }
drh306dc212001-05-21 13:45:10 +00003847 }
drh69688d52001-04-14 16:38:23 +00003848 return rc;
drhed7c8552001-04-11 14:29:21 +00003849}
3850
3851/*
danielk19774099f6e2007-03-19 11:25:20 +00003852** This function is used to mark a data-page as writable. It uses
3853** pager_write() to open a journal file (if it is not already open)
3854** and write the page *pData to the journal.
3855**
3856** The difference between this function and pager_write() is that this
3857** function also deals with the special case where 2 or more pages
3858** fit on a single disk sector. In this case all co-resident pages
3859** must have been written to the journal file before returning.
3860*/
danielk19773b8a05f2007-03-19 17:44:26 +00003861int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003862 int rc = SQLITE_OK;
3863
danielk19773b8a05f2007-03-19 17:44:26 +00003864 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003865 Pager *pPager = pPg->pPager;
3866 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3867
drh86f8c192007-08-22 00:39:19 +00003868 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00003869 if( !MEMDB && nPagePerSector>1 ){
3870 Pgno nPageCount; /* Total number of pages in database file */
3871 Pgno pg1; /* First page of the sector pPg is located on. */
3872 int nPage; /* Number of pages starting at pg1 to journal */
3873 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003874 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003875
3876 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3877 ** header to be written between the pages journaled by this function.
3878 */
3879 assert( pPager->doNotSync==0 );
3880 pPager->doNotSync = 1;
3881
3882 /* This trick assumes that both the page-size and sector-size are
3883 ** an integer power of 2. It sets variable pg1 to the identifier
3884 ** of the first page of the sector pPg is located on.
3885 */
3886 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3887
danielk19773b8a05f2007-03-19 17:44:26 +00003888 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00003889 if( pPg->pgno>nPageCount ){
3890 nPage = (pPg->pgno - pg1)+1;
3891 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3892 nPage = nPageCount+1-pg1;
3893 }else{
3894 nPage = nPagePerSector;
3895 }
3896 assert(nPage>0);
3897 assert(pg1<=pPg->pgno);
3898 assert((pg1+nPage)>pPg->pgno);
3899
3900 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3901 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003902 PgHdr *pPage;
danielk19774099f6e2007-03-19 11:25:20 +00003903 if( !pPager->aInJournal || pg==pPg->pgno ||
3904 pg>pPager->origDbSize || !(pPager->aInJournal[pg/8]&(1<<(pg&7)))
3905 ) {
3906 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003907 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003908 if( rc==SQLITE_OK ){
3909 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003910 if( pPage->needSync ){
3911 needSync = 1;
3912 }
danielk19773b8a05f2007-03-19 17:44:26 +00003913 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003914 }
3915 }
danielk1977dd97a492007-08-22 18:54:32 +00003916 }else if( (pPage = pager_lookup(pPager, pg)) ){
3917 if( pPage->needSync ){
3918 needSync = 1;
3919 }
danielk19774099f6e2007-03-19 11:25:20 +00003920 }
3921 }
3922
danielk1977dd97a492007-08-22 18:54:32 +00003923 /* If the PgHdr.needSync flag is set for any of the nPage pages
3924 ** starting at pg1, then it needs to be set for all of them. Because
3925 ** writing to any of these nPage pages may damage the others, the
3926 ** journal file must contain sync()ed copies of all of them
3927 ** before any of them can be written out to the database file.
3928 */
3929 if( needSync ){
3930 for(ii=0; ii<nPage && needSync; ii++){
3931 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
3932 if( pPage ) pPage->needSync = 1;
3933 }
3934 assert(pPager->needSync);
3935 }
3936
danielk19774099f6e2007-03-19 11:25:20 +00003937 assert( pPager->doNotSync==1 );
3938 pPager->doNotSync = 0;
3939 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003940 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003941 }
drh86f8c192007-08-22 00:39:19 +00003942 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00003943 return rc;
3944}
3945
3946/*
drhaacc5432002-01-06 17:07:40 +00003947** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003948** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003949** to change the content of the page.
3950*/
danielk19777d3a6662006-01-23 16:21:05 +00003951#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003952int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00003953 return pPg->dirty;
3954}
danielk19777d3a6662006-01-23 16:21:05 +00003955#endif
drh6019e162001-07-02 17:51:45 +00003956
danielk1977b84f96f2005-01-20 11:32:23 +00003957#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00003958/*
drh001bbcb2003-03-19 03:14:00 +00003959** Replace the content of a single page with the information in the third
3960** argument.
3961*/
danielk19773b8a05f2007-03-19 17:44:26 +00003962int sqlite3PagerOverwrite(Pager *pPager, Pgno pgno, void *pData){
3963 PgHdr *pPg;
drh001bbcb2003-03-19 03:14:00 +00003964 int rc;
3965
drh86f8c192007-08-22 00:39:19 +00003966 pagerEnter(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003967 rc = sqlite3PagerGet(pPager, pgno, &pPg);
drh001bbcb2003-03-19 03:14:00 +00003968 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003969 rc = sqlite3PagerWrite(pPg);
drh001bbcb2003-03-19 03:14:00 +00003970 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003971 memcpy(sqlite3PagerGetData(pPg), pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00003972 }
danielk19773b8a05f2007-03-19 17:44:26 +00003973 sqlite3PagerUnref(pPg);
drh001bbcb2003-03-19 03:14:00 +00003974 }
drh86f8c192007-08-22 00:39:19 +00003975 pagerLeave(pPager);
drh001bbcb2003-03-19 03:14:00 +00003976 return rc;
3977}
danielk1977b84f96f2005-01-20 11:32:23 +00003978#endif
drh001bbcb2003-03-19 03:14:00 +00003979
3980/*
drh30e58752002-03-02 20:41:57 +00003981** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003982** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00003983** that page might be marked as dirty.
3984**
3985** The overlying software layer calls this routine when all of the data
3986** on the given page is unused. The pager marks the page as clean so
3987** that it does not get written to disk.
3988**
3989** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003990** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003991** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003992**
3993** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003994** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003995** will thereafter be ignored. This is necessary to avoid a problem
3996** where a page with data is added to the freelist during one part of
3997** a transaction then removed from the freelist during a later part
3998** of the same transaction and reused for some other purpose. When it
3999** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004000** the sqlite3PagerDontRollback() routine is called. But because the
4001** page contains critical data, we still need to be sure it gets
4002** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004003*/
drh538f5702007-04-13 02:14:30 +00004004void sqlite3PagerDontWrite(DbPage *pDbPage){
4005 PgHdr *pPg = pDbPage;
4006 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004007
drhb7f91642004-10-31 02:22:47 +00004008 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004009 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004010 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004011 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004012 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004013 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4014 /* If this pages is the last page in the file and the file has grown
4015 ** during the current transaction, then do NOT mark the page as clean.
4016 ** When the database file grows, we must make sure that the last page
4017 ** gets written at least once so that the disk file will be the correct
4018 ** size. If you do not write this page and the size of the file
4019 ** on the disk ends up being too small, that can lead to database
4020 ** corruption during the next transaction.
4021 */
4022 }else{
drh538f5702007-04-13 02:14:30 +00004023 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4024 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004025 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004026#ifdef SQLITE_CHECK_PAGES
4027 pPg->pageHash = pager_pagehash(pPg);
4028#endif
drh8124a302002-06-25 14:43:57 +00004029 }
drh30e58752002-03-02 20:41:57 +00004030 }
drh86f8c192007-08-22 00:39:19 +00004031 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004032}
4033
4034/*
4035** A call to this routine tells the pager that if a rollback occurs,
4036** it is not necessary to restore the data on the given page. This
4037** means that the pager does not have to record the given page in the
4038** rollback journal.
drh538f5702007-04-13 02:14:30 +00004039**
4040** If we have not yet actually read the content of this page (if
4041** the PgHdr.needRead flag is set) then this routine acts as a promise
4042** that we will never need to read the page content in the future.
4043** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00004044*/
danielk19773b8a05f2007-03-19 17:44:26 +00004045void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004046 Pager *pPager = pPg->pPager;
4047
drh86f8c192007-08-22 00:39:19 +00004048 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004049 assert( pPager->state>=PAGER_RESERVED );
4050 if( pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00004051 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00004052 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
4053 assert( pPager->aInJournal!=0 );
4054 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
4055 pPg->inJournal = 1;
drh538f5702007-04-13 02:14:30 +00004056 pPg->needRead = 0;
drhac69b052004-05-12 13:30:07 +00004057 if( pPager->stmtInUse ){
4058 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00004059 }
drh4f0c5872007-03-26 22:05:01 +00004060 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00004061 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00004062 }
danielk1977f35843b2007-04-07 15:03:17 +00004063 if( pPager->stmtInUse
4064 && !pageInStatement(pPg)
4065 && (int)pPg->pgno<=pPager->stmtSize
4066 ){
drh30e58752002-03-02 20:41:57 +00004067 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00004068 assert( pPager->aInStmt!=0 );
4069 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00004070 }
drh86f8c192007-08-22 00:39:19 +00004071 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004072}
4073
drhac69b052004-05-12 13:30:07 +00004074
drh30e58752002-03-02 20:41:57 +00004075/*
drh80e35f42007-03-30 14:06:34 +00004076** This routine is called to increment the database file change-counter,
4077** stored at byte 24 of the pager file.
4078*/
danielk1977c7b60172007-08-22 11:22:03 +00004079static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004080 PgHdr *pPgHdr;
4081 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004082 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004083
4084 if( !pPager->changeCountDone ){
4085 /* Open page 1 of the file for writing. */
4086 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4087 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004088
4089 if( !isDirect ){
4090 rc = sqlite3PagerWrite(pPgHdr);
4091 if( rc!=SQLITE_OK ) return rc;
4092 }
4093
drh80e35f42007-03-30 14:06:34 +00004094 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004095 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004096 change_counter++;
4097 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004098
4099 if( isDirect && pPager->fd->pMethods ){
4100 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4101 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4102 }
4103
drh80e35f42007-03-30 14:06:34 +00004104 /* Release the page reference. */
4105 sqlite3PagerUnref(pPgHdr);
4106 pPager->changeCountDone = 1;
4107 }
danielk1977c7b60172007-08-22 11:22:03 +00004108 return rc;
drh80e35f42007-03-30 14:06:34 +00004109}
4110
4111/*
4112** Sync the database file for the pager pPager. zMaster points to the name
4113** of a master journal file that should be written into the individual
4114** journal file. zMaster may be NULL, which is interpreted as no master
4115** journal (a single database transaction).
4116**
4117** This routine ensures that the journal is synced, all dirty pages written
4118** to the database file and the database file synced. The only thing that
4119** remains to commit the transaction is to delete the journal file (or
4120** master journal file if specified).
4121**
4122** Note that if zMaster==NULL, this does not overwrite a previous value
4123** passed to an sqlite3PagerCommitPhaseOne() call.
4124**
4125** If parameter nTrunc is non-zero, then the pager file is truncated to
4126** nTrunc pages (this is used by auto-vacuum databases).
4127*/
4128int sqlite3PagerCommitPhaseOne(Pager *pPager, const char *zMaster, Pgno nTrunc){
4129 int rc = SQLITE_OK;
4130
4131 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4132 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004133 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004134
4135 /* If this is an in-memory db, or no pages have been written to, or this
4136 ** function has already been called, it is a no-op.
4137 */
4138 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4139 PgHdr *pPg;
4140 assert( pPager->journalOpen );
4141
danielk1977c7b60172007-08-22 11:22:03 +00004142#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4143 /* The atomic-write optimization can be used if all of the
4144 ** following are true:
4145 **
4146 ** + The file-system supports the atomic-write property for
4147 ** blocks of size page-size, and
4148 ** + This commit is not part of a multi-file transaction, and
4149 ** + Exactly one page has been modified and store in the journal file.
4150 **
4151 ** If the optimization can be used, then the journal file will never
4152 ** be created for this transaction.
4153 */
4154 if( !zMaster && pPager->journalOff==jrnlBufferSize(pPager) && nTrunc==0
4155 && (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4156 ){
4157 /* Update the nRec field in the journal file. */
4158 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4159 assert(pPager->nRec==1);
4160 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4161
4162 /* Update the db file change counter. The following call will modify
4163 ** the in-memory representation of page 1 to include the updated
4164 ** change counter and then write page 1 directly to the database
4165 ** file. Because of the atomic-write property of the host file-system,
4166 ** this is safe.
4167 */
4168 rc = pager_incr_changecounter(pPager, 1);
4169 }else
4170#endif
4171
drh80e35f42007-03-30 14:06:34 +00004172 /* If a master journal file name has already been written to the
4173 ** journal file, then no sync is required. This happens when it is
4174 ** written, then the process fails to upgrade from a RESERVED to an
4175 ** EXCLUSIVE lock. The next time the process tries to commit the
4176 ** transaction the m-j name will have already been written.
4177 */
4178 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00004179 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004180 if( rc!=SQLITE_OK ) goto sync_exit;
4181#ifndef SQLITE_OMIT_AUTOVACUUM
4182 if( nTrunc!=0 ){
4183 /* If this transaction has made the database smaller, then all pages
4184 ** being discarded by the truncation must be written to the journal
4185 ** file.
4186 */
4187 Pgno i;
4188 int iSkip = PAGER_MJ_PGNO(pPager);
4189 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
4190 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) && i!=iSkip ){
4191 rc = sqlite3PagerGet(pPager, i, &pPg);
4192 if( rc!=SQLITE_OK ) goto sync_exit;
4193 rc = sqlite3PagerWrite(pPg);
4194 sqlite3PagerUnref(pPg);
4195 if( rc!=SQLITE_OK ) goto sync_exit;
4196 }
4197 }
4198 }
4199#endif
4200 rc = writeMasterJournal(pPager, zMaster);
4201 if( rc!=SQLITE_OK ) goto sync_exit;
4202 rc = syncJournal(pPager);
drh80e35f42007-03-30 14:06:34 +00004203 }
danielk1977c7b60172007-08-22 11:22:03 +00004204 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004205
4206#ifndef SQLITE_OMIT_AUTOVACUUM
4207 if( nTrunc!=0 ){
4208 rc = sqlite3PagerTruncate(pPager, nTrunc);
4209 if( rc!=SQLITE_OK ) goto sync_exit;
4210 }
4211#endif
4212
4213 /* Write all dirty pages to the database file */
4214 pPg = pager_get_all_dirty_pages(pPager);
4215 rc = pager_write_pagelist(pPg);
4216 if( rc!=SQLITE_OK ) goto sync_exit;
drh3cdd7d32007-03-30 14:46:01 +00004217 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004218
4219 /* Sync the database file. */
4220 if( !pPager->noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004221 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004222 }
4223 IOTRACE(("DBSYNC %p\n", pPager))
4224
4225 pPager->state = PAGER_SYNCED;
4226 }else if( MEMDB && nTrunc!=0 ){
4227 rc = sqlite3PagerTruncate(pPager, nTrunc);
4228 }
4229
4230sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004231 if( rc==SQLITE_IOERR_BLOCKED ){
4232 /* pager_incr_changecounter() may attempt to obtain an exclusive
4233 * lock to spill the cache and return IOERR_BLOCKED. But since
4234 * there is no chance the cache is inconsistent, it's
4235 * better to return SQLITE_BUSY.
4236 */
4237 rc = SQLITE_BUSY;
4238 }
drh86f8c192007-08-22 00:39:19 +00004239 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004240 return rc;
4241}
4242
4243
4244/*
drhed7c8552001-04-11 14:29:21 +00004245** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004246**
4247** If the commit fails for any reason, a rollback attempt is made
4248** and an error code is returned. If the commit worked, SQLITE_OK
4249** is returned.
drhed7c8552001-04-11 14:29:21 +00004250*/
drh80e35f42007-03-30 14:06:34 +00004251int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004252 int rc;
drhed7c8552001-04-11 14:29:21 +00004253 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004254
danielk1977efaaf572006-01-16 11:29:19 +00004255 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004256 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004257 }
drha6abd042004-06-09 17:37:22 +00004258 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004259 return SQLITE_ERROR;
4260 }
drh86f8c192007-08-22 00:39:19 +00004261 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004262 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004263 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004264 pPg = pager_get_all_dirty_pages(pPager);
4265 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004266 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4267 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004268 pPg->dirty = 0;
4269 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004270 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004271 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004272 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004273 pPg = pPg->pDirty;
4274 }
drh605ad8f2006-05-03 23:34:05 +00004275 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004276#ifndef NDEBUG
4277 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4278 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4279 assert( !pPg->alwaysRollback );
4280 assert( !pHist->pOrig );
4281 assert( !pHist->pStmt );
4282 }
4283#endif
drhac69b052004-05-12 13:30:07 +00004284 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004285 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004286 return SQLITE_OK;
4287 }
drh3cdd7d32007-03-30 14:46:01 +00004288 assert( pPager->journalOpen || !pPager->dirtyCache );
4289 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
4290 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004291 rc = pager_error(pPager, rc);
4292 pagerLeave(pPager);
4293 return rc;
drhed7c8552001-04-11 14:29:21 +00004294}
4295
4296/*
drha6abd042004-06-09 17:37:22 +00004297** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004298** All in-memory cache pages revert to their original data contents.
4299** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004300**
4301** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004302** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004303** process is writing trash into the journal file (SQLITE_CORRUPT) or
4304** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4305** codes are returned for all these occasions. Otherwise,
4306** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004307*/
danielk19773b8a05f2007-03-19 17:44:26 +00004308int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004309 int rc;
drh4f0c5872007-03-26 22:05:01 +00004310 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004311 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004312 PgHdr *p;
4313 for(p=pPager->pAll; p; p=p->pNextAll){
4314 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004315 assert( !p->alwaysRollback );
4316 if( !p->dirty ){
4317 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4318 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4319 continue;
4320 }
4321
drhac69b052004-05-12 13:30:07 +00004322 pHist = PGHDR_TO_HIST(p, pPager);
4323 if( pHist->pOrig ){
4324 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004325 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004326 }else{
drh4f0c5872007-03-26 22:05:01 +00004327 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004328 }
4329 clearHistory(pHist);
4330 p->dirty = 0;
4331 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004332 pHist->inStmt = 0;
4333 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004334 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004335 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004336 }
drhac69b052004-05-12 13:30:07 +00004337 }
drh605ad8f2006-05-03 23:34:05 +00004338 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004339 pPager->pStmt = 0;
4340 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004341 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004342 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004343 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004344 return SQLITE_OK;
4345 }
4346
drh86f8c192007-08-22 00:39:19 +00004347 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004348 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00004349 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004350 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004351 return rc;
4352 }
drhdb48ee02003-01-16 13:42:43 +00004353
danielk1977efaaf572006-01-16 11:29:19 +00004354 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004355 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004356 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004357 }
drh86f8c192007-08-22 00:39:19 +00004358 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004359 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004360 }
drha6abd042004-06-09 17:37:22 +00004361 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004362 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004363 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004364 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00004365 if( rc==SQLITE_OK ){
4366 rc = rc2;
4367 }
4368 }else{
danielk1977e277be02007-03-23 18:12:06 +00004369 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004370 }
danielk1977e180dd92007-04-05 17:15:52 +00004371 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004372 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004373
4374 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4375 ** cache. So call pager_error() on the way out to make any error
4376 ** persistent.
4377 */
drh86f8c192007-08-22 00:39:19 +00004378 rc = pager_error(pPager, rc);
4379 pagerLeave(pPager);
4380 return rc;
drh98808ba2001-10-18 12:34:46 +00004381}
drhd9b02572001-04-15 00:37:09 +00004382
4383/*
drh5e00f6c2001-09-13 13:46:56 +00004384** Return TRUE if the database file is opened read-only. Return FALSE
4385** if the database is (in theory) writable.
4386*/
danielk19773b8a05f2007-03-19 17:44:26 +00004387int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004388 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004389}
4390
4391/*
drh0f7eb612006-08-08 13:51:43 +00004392** Return the number of references to the pager.
4393*/
danielk19773b8a05f2007-03-19 17:44:26 +00004394int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004395 return pPager->nRef;
4396}
4397
4398#ifdef SQLITE_TEST
4399/*
drhd9b02572001-04-15 00:37:09 +00004400** This routine is used for testing and analysis only.
4401*/
danielk19773b8a05f2007-03-19 17:44:26 +00004402int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004403 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004404 a[0] = pPager->nRef;
4405 a[1] = pPager->nPage;
4406 a[2] = pPager->mxPage;
4407 a[3] = pPager->dbSize;
4408 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004409 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004410 a[6] = pPager->nHit;
4411 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004412 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004413 a[9] = pPager->nRead;
4414 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004415 return a;
4416}
drh0f7eb612006-08-08 13:51:43 +00004417#endif
drhdd793422001-06-28 01:54:48 +00004418
drhfa86c412002-02-02 15:01:15 +00004419/*
drhac69b052004-05-12 13:30:07 +00004420** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004421**
4422** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004423** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004424** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004425*/
drh86f8c192007-08-22 00:39:19 +00004426static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004427 int rc;
drhac69b052004-05-12 13:30:07 +00004428 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004429 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004430 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004431 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004432 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004433 pPager->stmtInUse = 1;
4434 pPager->stmtSize = pPager->dbSize;
4435 return SQLITE_OK;
4436 }
drhda47d772002-12-02 04:25:19 +00004437 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004438 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004439 return SQLITE_OK;
4440 }
drhfa86c412002-02-02 15:01:15 +00004441 assert( pPager->journalOpen );
drh17435752007-08-16 04:30:38 +00004442 pPager->aInStmt = sqlite3MallocZero( pPager->dbSize/8 + 1 );
drhac69b052004-05-12 13:30:07 +00004443 if( pPager->aInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004444 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004445 return SQLITE_NOMEM;
4446 }
drh968af522003-02-11 14:55:40 +00004447#ifndef NDEBUG
drh054889e2005-11-30 03:20:31 +00004448 rc = sqlite3OsFileSize(pPager->jfd, &pPager->stmtJSize);
drhac69b052004-05-12 13:30:07 +00004449 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00004450 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00004451#endif
danielk197776572402004-06-25 02:38:54 +00004452 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004453 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004454 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004455 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004456 if( !pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00004457 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, 0);
drhac69b052004-05-12 13:30:07 +00004458 if( rc ) goto stmt_begin_failed;
4459 pPager->stmtOpen = 1;
4460 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004461 }
drhac69b052004-05-12 13:30:07 +00004462 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004463 return SQLITE_OK;
4464
drhac69b052004-05-12 13:30:07 +00004465stmt_begin_failed:
4466 if( pPager->aInStmt ){
drh17435752007-08-16 04:30:38 +00004467 sqlite3_free(pPager->aInStmt);
drhac69b052004-05-12 13:30:07 +00004468 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004469 }
4470 return rc;
4471}
drh86f8c192007-08-22 00:39:19 +00004472int sqlite3PagerStmtBegin(Pager *pPager){
4473 int rc;
4474 pagerEnter(pPager);
4475 rc = pagerStmtBegin(pPager);
4476 pagerLeave(pPager);
4477 return rc;
4478}
drhfa86c412002-02-02 15:01:15 +00004479
4480/*
drhac69b052004-05-12 13:30:07 +00004481** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004482*/
danielk19773b8a05f2007-03-19 17:44:26 +00004483int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00004484 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004485 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004486 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004487 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004488 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004489 /* sqlite3OsTruncate(pPager->stfd, 0); */
drh17435752007-08-16 04:30:38 +00004490 sqlite3_free( pPager->aInStmt );
drhac69b052004-05-12 13:30:07 +00004491 pPager->aInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004492 }else{
4493 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004494 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004495 pNext = pHist->pNextStmt;
4496 assert( pHist->inStmt );
4497 pHist->inStmt = 0;
4498 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00004499 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004500 pHist->pStmt = 0;
4501 }
4502 }
4503 pPager->stmtNRec = 0;
4504 pPager->stmtInUse = 0;
4505 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004506 }
drhac69b052004-05-12 13:30:07 +00004507 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004508 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004509 return SQLITE_OK;
4510}
4511
4512/*
drhac69b052004-05-12 13:30:07 +00004513** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004514*/
danielk19773b8a05f2007-03-19 17:44:26 +00004515int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004516 int rc;
drh86f8c192007-08-22 00:39:19 +00004517 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004518 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004519 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004520 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004521 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004522 PgHistory *pHist;
4523 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4524 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004525 if( pHist->pStmt ){
4526 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00004527 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004528 pHist->pStmt = 0;
4529 }
4530 }
4531 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00004532 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004533 rc = SQLITE_OK;
4534 }else{
4535 rc = pager_stmt_playback(pPager);
4536 }
danielk19773b8a05f2007-03-19 17:44:26 +00004537 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00004538 }else{
4539 rc = SQLITE_OK;
4540 }
drhac69b052004-05-12 13:30:07 +00004541 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004542 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004543 return rc;
4544}
4545
drh73509ee2003-04-06 20:44:45 +00004546/*
4547** Return the full pathname of the database file.
4548*/
danielk19773b8a05f2007-03-19 17:44:26 +00004549const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004550 return pPager->zFilename;
4551}
4552
drhb20ea9d2004-02-09 01:20:36 +00004553/*
danielk19775865e3d2004-06-14 06:03:57 +00004554** Return the directory of the database file.
4555*/
danielk19773b8a05f2007-03-19 17:44:26 +00004556const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004557 return pPager->zDirectory;
4558}
4559
4560/*
4561** Return the full pathname of the journal file.
4562*/
danielk19773b8a05f2007-03-19 17:44:26 +00004563const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004564 return pPager->zJournal;
4565}
4566
4567/*
drh2c8997b2005-08-27 16:36:48 +00004568** Return true if fsync() calls are disabled for this pager. Return FALSE
4569** if fsync()s are executed normally.
4570*/
danielk19773b8a05f2007-03-19 17:44:26 +00004571int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004572 return pPager->noSync;
4573}
4574
drh7c4ac0c2007-04-05 11:25:58 +00004575#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004576/*
drhb20ea9d2004-02-09 01:20:36 +00004577** Set the codec for this pager
4578*/
danielk19773b8a05f2007-03-19 17:44:26 +00004579void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004580 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004581 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004582 void *pCodecArg
4583){
4584 pPager->xCodec = xCodec;
4585 pPager->pCodecArg = pCodecArg;
4586}
drh7c4ac0c2007-04-05 11:25:58 +00004587#endif
drhb20ea9d2004-02-09 01:20:36 +00004588
danielk1977687566d2004-11-02 12:56:41 +00004589#ifndef SQLITE_OMIT_AUTOVACUUM
4590/*
drh5e385312007-06-16 04:42:12 +00004591** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004592**
drh5e385312007-06-16 04:42:12 +00004593** There must be no references to the page previously located at
4594** pgno (which we call pPgOld) though that page is allowed to be
4595** in cache. If the page previous located at pgno is not already
4596** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004597**
drh5e385312007-06-16 04:42:12 +00004598** References to the page pPg remain valid. Updating any
4599** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004600** allocated along with the page) is the responsibility of the caller.
4601**
danielk19775fd057a2005-03-09 13:09:43 +00004602** A transaction must be active when this routine is called. It used to be
4603** required that a statement transaction was not active, but this restriction
4604** has been removed (CREATE INDEX needs to move a page when a statement
4605** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00004606*/
danielk19773b8a05f2007-03-19 17:44:26 +00004607int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00004608 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00004609 int h;
danielk197794daf7f2004-11-08 09:26:09 +00004610 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004611
drh86f8c192007-08-22 00:39:19 +00004612 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00004613 assert( pPg->nRef>0 );
4614
drh4f0c5872007-03-26 22:05:01 +00004615 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00004616 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00004617 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004618
danielk1977b4626a32007-04-28 15:47:43 +00004619 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00004620 if( pPg->needSync ){
4621 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00004622 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00004623 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00004624 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004625 }
4626
danielk1977687566d2004-11-02 12:56:41 +00004627 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00004628 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00004629
danielk1977ef73ee92004-11-06 12:26:07 +00004630 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00004631 ** from it's hash chain. Also, if the PgHdr.needSync was set for
4632 ** page pgno before the 'move' operation, it needs to be retained
4633 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004634 */
drh5e385312007-06-16 04:42:12 +00004635 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00004636 pPgOld = pager_lookup(pPager, pgno);
4637 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00004638 assert( pPgOld->nRef==0 );
4639 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00004640 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00004641 pPg->needSync = pPgOld->needSync;
4642 }else{
4643 pPg->needSync = 0;
4644 }
4645 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
4646 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drh5e385312007-06-16 04:42:12 +00004647 }else{
4648 pPg->inJournal = 0;
drh732c8172007-06-16 11:17:45 +00004649 assert( pPg->needSync==0 || (int)pgno>pPager->origDbSize );
danielk1977687566d2004-11-02 12:56:41 +00004650 }
4651
danielk1977f5fdda82004-11-03 08:44:05 +00004652 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00004653 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00004654 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00004655 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00004656 if( pPager->aHash[h] ){
4657 assert( pPager->aHash[h]->pPrevHash==0 );
4658 pPager->aHash[h]->pPrevHash = pPg;
4659 }
4660 pPg->pNextHash = pPager->aHash[h];
4661 pPager->aHash[h] = pPg;
4662 pPg->pPrevHash = 0;
4663
drh605ad8f2006-05-03 23:34:05 +00004664 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004665 pPager->dirtyCache = 1;
4666
danielk197794daf7f2004-11-08 09:26:09 +00004667 if( needSyncPgno ){
4668 /* If needSyncPgno is non-zero, then the journal file needs to be
4669 ** sync()ed before any data is written to database file page needSyncPgno.
4670 ** Currently, no such page exists in the page-cache and the
4671 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
4672 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00004673 **
danielk19773b8a05f2007-03-19 17:44:26 +00004674 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004675 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004676 */
4677 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004678 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004679 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004680 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004681 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00004682 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00004683 pPgHdr->needSync = 1;
4684 pPgHdr->inJournal = 1;
4685 makeDirty(pPgHdr);
4686 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004687 }
4688
drh86f8c192007-08-22 00:39:19 +00004689 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00004690 return SQLITE_OK;
4691}
4692#endif
4693
danielk19773b8a05f2007-03-19 17:44:26 +00004694/*
4695** Return a pointer to the data for the specified page.
4696*/
4697void *sqlite3PagerGetData(DbPage *pPg){
4698 return PGHDR_TO_DATA(pPg);
4699}
4700
4701/*
4702** Return a pointer to the Pager.nExtra bytes of "extra" space
4703** allocated along with the specified page.
4704*/
4705void *sqlite3PagerGetExtra(DbPage *pPg){
4706 Pager *pPager = pPg->pPager;
4707 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
4708}
4709
danielk197741483462007-03-24 16:45:04 +00004710/*
4711** Get/set the locking-mode for this pager. Parameter eMode must be one
4712** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4713** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4714** the locking-mode is set to the value specified.
4715**
4716** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4717** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4718** locking-mode.
4719*/
4720int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004721 assert( eMode==PAGER_LOCKINGMODE_QUERY
4722 || eMode==PAGER_LOCKINGMODE_NORMAL
4723 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4724 assert( PAGER_LOCKINGMODE_QUERY<0 );
4725 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4726 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00004727 pPager->exclusiveMode = eMode;
4728 }
4729 return (int)pPager->exclusiveMode;
4730}
4731
dougcurrie81c95ef2004-06-18 23:21:47 +00004732#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00004733/*
4734** Return the current state of the file lock for the given pager.
4735** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
4736** PENDING_LOCK, or EXCLUSIVE_LOCK.
4737*/
danielk19773b8a05f2007-03-19 17:44:26 +00004738int sqlite3PagerLockstate(Pager *pPager){
drh054889e2005-11-30 03:20:31 +00004739 return sqlite3OsLockState(pPager->fd);
drh89ac8c12004-06-09 14:17:20 +00004740}
4741#endif
4742
danielk197793758c82005-01-21 08:13:14 +00004743#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00004744/*
4745** Print a listing of all referenced pages and their ref count.
4746*/
danielk19773b8a05f2007-03-19 17:44:26 +00004747void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00004748 PgHdr *pPg;
4749 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4750 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00004751 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
4752 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00004753 }
4754}
4755#endif
drh2e66f0b2005-04-28 17:18:48 +00004756
4757#endif /* SQLITE_OMIT_DISKIO */