blob: 208241a5c603537d2b456f482aa5605352a7aefa [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**
danielk19777a2b1ee2007-08-21 14:27:01 +000021** @(#) $Id: pager.c,v 1.364 2007/08/21 14:27:02 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
danielk197713f72992005-12-18 08:51:22 +0000365 Pager *pNext; /* Linked list of pagers in this thread */
366#endif
danielk19778186df82007-03-06 13:45:59 +0000367 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000368 char dbFileVers[16]; /* Changes whenever database file changes */
drhd9b02572001-04-15 00:37:09 +0000369};
370
371/*
drh538f5702007-04-13 02:14:30 +0000372** The following global variables hold counters used for
373** testing purposes only. These variables do not exist in
374** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000375*/
376#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000377int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
378int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
379int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
380int sqlite3_pager_pgfree_count = 0; /* Number of cache pages freed */
381# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000382#else
drh538f5702007-04-13 02:14:30 +0000383# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000384#endif
385
drh538f5702007-04-13 02:14:30 +0000386
387
drhfcd35c72005-05-21 02:48:08 +0000388/*
drh5e00f6c2001-09-13 13:46:56 +0000389** Journal files begin with the following magic string. The data
390** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000391**
drhae2b40c2004-06-09 19:03:54 +0000392** Since version 2.8.0, the journal format contains additional sanity
393** checking information. If the power fails while the journal is begin
394** written, semi-random garbage data might appear in the journal
395** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000396** to roll the journal back, the database could be corrupted. The additional
397** sanity checking data is an attempt to discover the garbage in the
398** journal and ignore it.
399**
drhae2b40c2004-06-09 19:03:54 +0000400** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000401** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000402** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000403** This cksum is initialized to a 32-bit random value that appears in the
404** journal file right after the header. The random initializer is important,
405** because garbage data that appears at the end of a journal is likely
406** data that was once in other files that have now been deleted. If the
407** garbage data came from an obsolete journal file, the checksums might
408** be correct. But by initializing the checksum to random value which
409** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000410*/
drhae2b40c2004-06-09 19:03:54 +0000411static const unsigned char aJournalMagic[] = {
412 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000413};
414
415/*
drh726de592004-06-10 23:35:50 +0000416** The size of the header and of each page in the journal is determined
417** by the following macros.
drh968af522003-02-11 14:55:40 +0000418*/
drhae2b40c2004-06-09 19:03:54 +0000419#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000420
danielk197776572402004-06-25 02:38:54 +0000421/*
422** The journal header size for this pager. In the future, this could be
423** set to some value read from the disk controller. The important
424** characteristic is that it is the same size as a disk sector.
425*/
426#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
427
drhb7f91642004-10-31 02:22:47 +0000428/*
429** The macro MEMDB is true if we are dealing with an in-memory database.
430** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
431** the value of MEMDB will be a constant and the compiler will optimize
432** out code that would never execute.
433*/
434#ifdef SQLITE_OMIT_MEMORYDB
435# define MEMDB 0
436#else
437# define MEMDB pPager->memDb
438#endif
439
440/*
danielk197776572402004-06-25 02:38:54 +0000441** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
442** reserved for working around a windows/posix incompatibility). It is
443** used in the journal to signify that the remainder of the journal file
444** is devoted to storing a master journal name - there are no more pages to
445** roll back. See comments for function writeMasterJournal() for details.
446*/
danielk1977599fcba2004-11-08 07:13:13 +0000447/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
448#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000449
drh968af522003-02-11 14:55:40 +0000450/*
danielk197726836652005-01-17 01:33:13 +0000451** The maximum legal page number is (2^31 - 1).
452*/
453#define PAGER_MAX_PGNO 2147483647
454
455/*
drh726de592004-06-10 23:35:50 +0000456** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000457*/
drh7c4ac0c2007-04-05 11:25:58 +0000458#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000459 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000460 static void pager_refinfo(PgHdr *p){
461 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000462 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000463 sqlite3DebugPrintf(
drh24c9a2e2007-01-05 02:00:47 +0000464 "REFCNT: %4d addr=%p nRef=%-3d total=%d\n",
465 p->pgno, PGHDR_TO_DATA(p), p->nRef, p->pPager->nRef
drhdd793422001-06-28 01:54:48 +0000466 );
467 cnt++; /* Something to set a breakpoint on */
468 }
469# define REFINFO(X) pager_refinfo(X)
470#else
471# define REFINFO(X)
472#endif
473
danielk1977f35843b2007-04-07 15:03:17 +0000474/*
475** Return true if page *pPg has already been written to the statement
476** journal (or statement snapshot has been created, if *pPg is part
477** of an in-memory database).
478*/
479static int pageInStatement(PgHdr *pPg){
480 Pager *pPager = pPg->pPager;
481 if( MEMDB ){
482 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
483 }else{
484 Pgno pgno = pPg->pgno;
485 u8 *a = pPager->aInStmt;
486 return (a && (int)pgno<=pPager->stmtSize && (a[pgno/8] & (1<<(pgno&7))));
487 }
488}
drh8ca0c722006-05-07 17:49:38 +0000489
490/*
491** Change the size of the pager hash table to N. N must be a power
492** of two.
493*/
494static void pager_resize_hash_table(Pager *pPager, int N){
495 PgHdr **aHash, *pPg;
496 assert( N>0 && (N&(N-1))==0 );
drh17435752007-08-16 04:30:38 +0000497 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drh8ca0c722006-05-07 17:49:38 +0000498 if( aHash==0 ){
499 /* Failure to rehash is not an error. It is only a performance hit. */
500 return;
501 }
drh17435752007-08-16 04:30:38 +0000502 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000503 pPager->nHash = N;
504 pPager->aHash = aHash;
505 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000506 int h;
507 if( pPg->pgno==0 ){
508 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
509 continue;
510 }
511 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000512 pPg->pNextHash = aHash[h];
513 if( aHash[h] ){
514 aHash[h]->pPrevHash = pPg;
515 }
516 aHash[h] = pPg;
517 pPg->pPrevHash = 0;
518 }
519}
520
drhdd793422001-06-28 01:54:48 +0000521/*
drh34e79ce2004-02-08 06:05:46 +0000522** Read a 32-bit integer from the given file descriptor. Store the integer
523** that is read in *pRes. Return SQLITE_OK if everything worked, or an
524** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000525**
526** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000527*/
danielk197762079062007-08-15 17:08:46 +0000528static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000529 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000530 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000531 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000532 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000533 }
drh94f33312002-08-12 12:29:56 +0000534 return rc;
535}
536
537/*
drh97b57482006-01-10 20:32:32 +0000538** Write a 32-bit integer into a string buffer in big-endian byte order.
539*/
drha3152892007-05-05 11:48:52 +0000540#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000541
542/*
drh34e79ce2004-02-08 06:05:46 +0000543** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
544** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000545*/
danielk197762079062007-08-15 17:08:46 +0000546static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000547 char ac[4];
drh97b57482006-01-10 20:32:32 +0000548 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000549 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000550}
551
drh2554f8b2003-01-22 01:26:44 +0000552/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000553** If file pFd is open, call sqlite3OsUnlock() on it.
554*/
555static int osUnlock(sqlite3_file *pFd, int eLock){
556 if( !pFd->pMethods ){
557 return SQLITE_OK;
558 }
559 return sqlite3OsUnlock(pFd, eLock);
560}
561
562/*
danielk1977aef0bf62005-12-30 16:28:01 +0000563** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000564** code. The first argument is a pointer to the pager structure, the
565** second the error-code about to be returned by a pager API function.
566** The value returned is a copy of the second argument to this function.
567**
drh4f0ee682007-03-30 20:43:40 +0000568** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977a96a7102006-01-16 12:46:41 +0000569** the error becomes persistent. All subsequent API calls on this Pager
570** will immediately return the same error code.
danielk1977aef0bf62005-12-30 16:28:01 +0000571*/
572static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000573 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000574 assert(
575 pPager->errCode==SQLITE_FULL ||
576 pPager->errCode==SQLITE_OK ||
577 (pPager->errCode & 0xff)==SQLITE_IOERR
578 );
danielk1977979f38e2007-03-27 16:19:51 +0000579 if(
drh4ac285a2006-09-15 07:28:50 +0000580 rc2==SQLITE_FULL ||
581 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000582 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000583 ){
584 pPager->errCode = rc;
danielk1977aef0bf62005-12-30 16:28:01 +0000585 }
586 return rc;
587}
588
drh477731b2007-06-16 03:06:27 +0000589/*
590** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
591** on the cache using a hash function. This is used for testing
592** and debugging only.
593*/
danielk19773c407372005-02-15 02:54:14 +0000594#ifdef SQLITE_CHECK_PAGES
595/*
596** Return a 32-bit hash of the page data for pPage.
597*/
drh477731b2007-06-16 03:06:27 +0000598static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000599 u32 hash = 0;
600 int i;
drh477731b2007-06-16 03:06:27 +0000601 for(i=0; i<nByte; i++){
602 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000603 }
604 return hash;
605}
drh477731b2007-06-16 03:06:27 +0000606static u32 pager_pagehash(PgHdr *pPage){
607 return pager_datahash(pPage->pPager->pageSize,
608 (unsigned char *)PGHDR_TO_DATA(pPage));
609}
danielk19773c407372005-02-15 02:54:14 +0000610
611/*
612** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
613** is defined, and NDEBUG is not defined, an assert() statement checks
614** that the page is either dirty or still matches the calculated page-hash.
615*/
616#define CHECK_PAGE(x) checkPage(x)
617static void checkPage(PgHdr *pPg){
618 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000619 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000620 pPg->pageHash==pager_pagehash(pPg) );
621}
622
623#else
drh8ffa8172007-06-18 17:25:17 +0000624#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000625#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000626#define CHECK_PAGE(x)
627#endif
628
drhed7c8552001-04-11 14:29:21 +0000629/*
danielk197776572402004-06-25 02:38:54 +0000630** When this is called the journal file for pager pPager must be open.
631** The master journal file name is read from the end of the file and
drh17435752007-08-16 04:30:38 +0000632** written into memory obtained from sqlite3_malloc(). *pzMaster is
danielk197776572402004-06-25 02:38:54 +0000633** set to point at the memory and SQLITE_OK returned. The caller must
drh17435752007-08-16 04:30:38 +0000634** sqlite3_free() *pzMaster.
danielk197776572402004-06-25 02:38:54 +0000635**
636** If no master journal file name is present *pzMaster is set to 0 and
637** SQLITE_OK returned.
638*/
danielk197762079062007-08-15 17:08:46 +0000639static int readMasterJournal(sqlite3_file *pJrnl, char **pzMaster){
danielk197776572402004-06-25 02:38:54 +0000640 int rc;
641 u32 len;
drheb206252004-10-01 02:00:31 +0000642 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000643 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000644 int i;
danielk197776572402004-06-25 02:38:54 +0000645 unsigned char aMagic[8]; /* A buffer to hold the magic header */
646
647 *pzMaster = 0;
648
drh054889e2005-11-30 03:20:31 +0000649 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000650 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000651
danielk197762079062007-08-15 17:08:46 +0000652 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000653 if( rc!=SQLITE_OK ) return rc;
654
danielk197762079062007-08-15 17:08:46 +0000655 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000656 if( rc!=SQLITE_OK ) return rc;
657
danielk197762079062007-08-15 17:08:46 +0000658 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000659 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
660
drh17435752007-08-16 04:30:38 +0000661 *pzMaster = (char *)sqlite3MallocZero(len+1);
danielk197776572402004-06-25 02:38:54 +0000662 if( !*pzMaster ){
663 return SQLITE_NOMEM;
664 }
danielk197762079062007-08-15 17:08:46 +0000665 rc = sqlite3OsRead(pJrnl, *pzMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000666 if( rc!=SQLITE_OK ){
drh17435752007-08-16 04:30:38 +0000667 sqlite3_free(*pzMaster);
danielk197776572402004-06-25 02:38:54 +0000668 *pzMaster = 0;
669 return rc;
670 }
danielk1977cafadba2004-06-25 11:11:54 +0000671
672 /* See if the checksum matches the master journal name */
673 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000674 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000675 }
danielk19778191bff2004-06-28 04:52:30 +0000676 if( cksum ){
677 /* If the checksum doesn't add up, then one or more of the disk sectors
678 ** containing the master journal filename is corrupted. This means
679 ** definitely roll back, so just return SQLITE_OK and report a (nul)
680 ** master-journal filename.
681 */
drh17435752007-08-16 04:30:38 +0000682 sqlite3_free(*pzMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000683 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000684 }else{
685 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000686 }
danielk197776572402004-06-25 02:38:54 +0000687
688 return SQLITE_OK;
689}
690
691/*
692** Seek the journal file descriptor to the next sector boundary where a
693** journal header may be read or written. Pager.journalOff is updated with
694** the new seek offset.
695**
696** i.e for a sector size of 512:
697**
698** Input Offset Output Offset
699** ---------------------------------------
700** 0 0
701** 512 512
702** 100 512
703** 2000 2048
704**
705*/
danielk197762079062007-08-15 17:08:46 +0000706static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000707 i64 offset = 0;
708 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000709 if( c ){
710 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
711 }
712 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
713 assert( offset>=c );
714 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
715 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000716}
717
718/*
719** The journal file must be open when this routine is called. A journal
720** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
721** current location.
722**
723** The format for the journal header is as follows:
724** - 8 bytes: Magic identifying journal format.
725** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
726** - 4 bytes: Random number used for page hash.
727** - 4 bytes: Initial database page count.
728** - 4 bytes: Sector size used by the process that wrote this journal.
729**
danielk1977f42f25c2004-06-25 07:21:28 +0000730** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000731*/
732static int writeJournalHdr(Pager *pPager){
drh97b57482006-01-10 20:32:32 +0000733 char zHeader[sizeof(aJournalMagic)+16];
danielk19774099f6e2007-03-19 11:25:20 +0000734 int rc;
danielk197776572402004-06-25 02:38:54 +0000735
danielk19774099f6e2007-03-19 11:25:20 +0000736 if( pPager->stmtHdrOff==0 ){
737 pPager->stmtHdrOff = pPager->journalOff;
738 }
739
danielk197762079062007-08-15 17:08:46 +0000740 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000741 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000742
743 /* FIX ME:
744 **
745 ** Possibly for a pager not in no-sync mode, the journal magic should not
746 ** be written until nRec is filled in as part of next syncJournal().
747 **
748 ** Actually maybe the whole journal header should be delayed until that
749 ** point. Think about this.
750 */
drh97b57482006-01-10 20:32:32 +0000751 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
752 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
753 put32bits(&zHeader[sizeof(aJournalMagic)], pPager->noSync ? 0xffffffff : 0);
754 /* The random check-hash initialiser */
755 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
756 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
757 /* The initial database size */
758 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
759 /* The assumed sector size for this process */
760 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
drhb0603412007-02-28 04:47:26 +0000761 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, sizeof(zHeader)))
danielk197762079062007-08-15 17:08:46 +0000762 rc = sqlite3OsWrite(pPager->jfd, zHeader, sizeof(zHeader),pPager->journalOff);
763 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197776572402004-06-25 02:38:54 +0000764
765 /* The journal header has been written successfully. Seek the journal
766 ** file descriptor to the end of the journal header sector.
767 */
768 if( rc==SQLITE_OK ){
drhb0603412007-02-28 04:47:26 +0000769 IOTRACE(("JTAIL %p %lld\n", pPager, pPager->journalOff-1))
danielk197762079062007-08-15 17:08:46 +0000770 rc = sqlite3OsWrite(pPager->jfd, "\000", 1, pPager->journalOff-1);
danielk197776572402004-06-25 02:38:54 +0000771 }
772 return rc;
773}
774
775/*
776** The journal file must be open when this is called. A journal header file
777** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
778** file. See comments above function writeJournalHdr() for a description of
779** the journal header format.
780**
781** If the header is read successfully, *nRec is set to the number of
782** page records following this header and *dbSize is set to the size of the
783** database before the transaction began, in pages. Also, pPager->cksumInit
784** is set to the value read from the journal header. SQLITE_OK is returned
785** in this case.
786**
787** If the journal header file appears to be corrupted, SQLITE_DONE is
788** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
789** cannot be read from the journal file an error code is returned.
790*/
791static int readJournalHdr(
792 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000793 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000794 u32 *pNRec,
795 u32 *pDbSize
796){
797 int rc;
798 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000799 i64 jrnlOff;
danielk197776572402004-06-25 02:38:54 +0000800
danielk197762079062007-08-15 17:08:46 +0000801 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000802 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
803 return SQLITE_DONE;
804 }
danielk197762079062007-08-15 17:08:46 +0000805 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000806
danielk197762079062007-08-15 17:08:46 +0000807 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000808 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000809 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000810
811 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
812 return SQLITE_DONE;
813 }
814
danielk197762079062007-08-15 17:08:46 +0000815 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000816 if( rc ) return rc;
817
danielk197762079062007-08-15 17:08:46 +0000818 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000819 if( rc ) return rc;
820
danielk197762079062007-08-15 17:08:46 +0000821 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000822 if( rc ) return rc;
823
824 /* Update the assumed sector-size to match the value used by
825 ** the process that created this journal. If this journal was
826 ** created by a process other than this one, then this routine
827 ** is being called from within pager_playback(). The local value
828 ** of Pager.sectorSize is restored at the end of that routine.
829 */
danielk197762079062007-08-15 17:08:46 +0000830 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000831 if( rc ) return rc;
832
833 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +0000834 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000835}
836
837
838/*
839** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000840** pPager at the current location. The master journal name must be the last
841** thing written to a journal file. If the pager is in full-sync mode, the
842** journal file descriptor is advanced to the next sector boundary before
843** anything is written. The format is:
844**
845** + 4 bytes: PAGER_MJ_PGNO.
846** + N bytes: length of master journal name.
847** + 4 bytes: N
848** + 4 bytes: Master journal name checksum.
849** + 8 bytes: aJournalMagic[].
850**
851** The master journal page checksum is the sum of the bytes in the master
852** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000853**
854** If zMaster is a NULL pointer (occurs for a single database transaction),
855** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000856*/
857static int writeMasterJournal(Pager *pPager, const char *zMaster){
858 int rc;
859 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000860 int i;
danielk197762079062007-08-15 17:08:46 +0000861 i64 jrnlOff;
drh97b57482006-01-10 20:32:32 +0000862 u32 cksum = 0;
863 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000864
865 if( !zMaster || pPager->setMaster) return SQLITE_OK;
866 pPager->setMaster = 1;
867
868 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000869 for(i=0; i<len; i++){
870 cksum += zMaster[i];
871 }
danielk197776572402004-06-25 02:38:54 +0000872
873 /* If in full-sync mode, advance to the next disk sector before writing
874 ** the master journal name. This is in case the previous page written to
875 ** the journal has already been synced.
876 */
877 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000878 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000879 }
danielk197762079062007-08-15 17:08:46 +0000880 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000881 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000882
danielk197762079062007-08-15 17:08:46 +0000883 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000884 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000885 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000886
danielk197762079062007-08-15 17:08:46 +0000887 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000888 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000889 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000890
drh97b57482006-01-10 20:32:32 +0000891 put32bits(zBuf, len);
892 put32bits(&zBuf[4], cksum);
893 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000894 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
drh2c8997b2005-08-27 16:36:48 +0000895 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +0000896 return rc;
897}
898
899/*
drh03eb96a2002-11-10 23:32:56 +0000900** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000901** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000902**
903** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +0000904** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +0000905** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000906** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000907*/
drh3aac2dd2004-04-26 14:10:20 +0000908static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000909 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +0000910 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
911 assert( MEMDB );
912 if( !pHist->inStmt ){
913 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
914 if( pPager->pStmt ){
915 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
916 }
917 pHist->pNextStmt = pPager->pStmt;
918 pPager->pStmt = pPg;
919 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000920 }
drh03eb96a2002-11-10 23:32:56 +0000921}
922
923/*
drhed7c8552001-04-11 14:29:21 +0000924** Find a page in the hash table given its page number. Return
925** a pointer to the page or NULL if not found.
926*/
drhd9b02572001-04-15 00:37:09 +0000927static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000928 PgHdr *p;
929 if( pPager->aHash==0 ) return 0;
930 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +0000931 while( p && p->pgno!=pgno ){
932 p = p->pNextHash;
933 }
934 return p;
935}
936
937/*
drh1aa2d8b2007-01-03 15:34:29 +0000938** Unlock the database file.
drh1aa2d8b2007-01-03 15:34:29 +0000939*/
940static void pager_unlock(Pager *pPager){
danielk197741483462007-03-24 16:45:04 +0000941 if( !pPager->exclusiveMode ){
942 if( !MEMDB ){
danielk19777a2b1ee2007-08-21 14:27:01 +0000943 osUnlock(pPager->fd, NO_LOCK);
danielk197741483462007-03-24 16:45:04 +0000944 pPager->dbSize = -1;
945 IOTRACE(("UNLOCK %p\n", pPager))
946 }
947 pPager->state = PAGER_UNLOCK;
948 pPager->changeCountDone = 0;
drh1aa2d8b2007-01-03 15:34:29 +0000949 }
danielk1977e277be02007-03-23 18:12:06 +0000950}
951
952/*
953** Execute a rollback if a transaction is active and unlock the
954** database file. This is a no-op if the pager has already entered
955** the error-state.
956*/
danielk1977334cdb62007-03-26 08:05:12 +0000957static void pagerUnlockAndRollback(Pager *p){
958 if( p->errCode ) return;
danielk1977c5859712007-03-26 12:26:27 +0000959 assert( p->state>=PAGER_RESERVED || p->journalOpen==0 );
danielk1977334cdb62007-03-26 08:05:12 +0000960 if( p->state>=PAGER_RESERVED ){
961 sqlite3PagerRollback(p);
danielk1977e277be02007-03-23 18:12:06 +0000962 }
danielk1977334cdb62007-03-26 08:05:12 +0000963 pager_unlock(p);
964 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
965 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drh1aa2d8b2007-01-03 15:34:29 +0000966}
967
968
969/*
danielk1977e180dd92007-04-05 17:15:52 +0000970** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000971** sets the state of the pager back to what it was when it was first
972** opened. Any outstanding pages are invalidated and subsequent attempts
973** to access those pages will likely result in a coredump.
974*/
drhd9b02572001-04-15 00:37:09 +0000975static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000976 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +0000977 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +0000978 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +0000979 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
980 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +0000981 pNext = pPg->pNextAll;
drh17435752007-08-16 04:30:38 +0000982 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +0000983 }
danielk1977b94bf852007-03-19 13:53:37 +0000984 pPager->pStmt = 0;
drhed7c8552001-04-11 14:29:21 +0000985 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000986 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000987 pPager->pLast = 0;
988 pPager->pAll = 0;
drh8ca0c722006-05-07 17:49:38 +0000989 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +0000990 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +0000991 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +0000992 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +0000993 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +0000994}
995
996/*
drh80e35f42007-03-30 14:06:34 +0000997** This routine ends a transaction. A transaction is ended by either
998** a COMMIT or a ROLLBACK.
999**
drhed7c8552001-04-11 14:29:21 +00001000** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001001** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1002** the database lock and acquires a SHARED lock in its place if that is
1003** the appropriate thing to do. Release locks usually is appropriate,
1004** unless we are in exclusive access mode or unless this is a
1005** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1006**
1007** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001008**
1009** TODO: Consider keeping the journal file open for temporary databases.
1010** This might give a performance improvement on windows where opening
1011** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001012*/
drh80e35f42007-03-30 14:06:34 +00001013static int pager_end_transaction(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001014 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001015 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001016 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001017 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001018 if( pPager->state<PAGER_RESERVED ){
1019 return SQLITE_OK;
1020 }
danielk19773b8a05f2007-03-19 17:44:26 +00001021 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001022 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001023 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001024 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001025 }
drhda47d772002-12-02 04:25:19 +00001026 if( pPager->journalOpen ){
drh01fa4c32007-04-02 11:22:22 +00001027 if( pPager->exclusiveMode
1028 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){;
danielk197741483462007-03-24 16:45:04 +00001029 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001030 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001031 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001032 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001033 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +00001034 if( rc==SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001035 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001036 }
danielk197741483462007-03-24 16:45:04 +00001037 }
drh17435752007-08-16 04:30:38 +00001038 sqlite3_free( pPager->aInJournal );
drhda47d772002-12-02 04:25:19 +00001039 pPager->aInJournal = 0;
1040 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1041 pPg->inJournal = 0;
1042 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001043 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001044 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001045#ifdef SQLITE_CHECK_PAGES
1046 pPg->pageHash = pager_pagehash(pPg);
1047#endif
drhda47d772002-12-02 04:25:19 +00001048 }
drh605ad8f2006-05-03 23:34:05 +00001049 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001050 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001051 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001052 }else{
drh88b01a12005-03-28 18:04:27 +00001053 assert( pPager->aInJournal==0 );
drha6abd042004-06-09 17:37:22 +00001054 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001055 }
danielk1977979f38e2007-03-27 16:19:51 +00001056
danielk197741483462007-03-24 16:45:04 +00001057 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001058 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001059 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001060 }else if( pPager->state==PAGER_SYNCED ){
1061 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001062 }
danielk1977334cdb62007-03-26 08:05:12 +00001063 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001064 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001065 pPager->needSync = 0;
1066 pPager->pFirstSynced = pPager->pFirst;
drh588f5bc2007-01-02 18:41:54 +00001067 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +00001068
1069 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001070}
1071
drhed7c8552001-04-11 14:29:21 +00001072/*
drh968af522003-02-11 14:55:40 +00001073** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001074**
1075** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001076** random initial value and the page number. We experimented with
1077** a checksum of the entire data, but that was found to be too slow.
1078**
1079** Note that the page number is stored at the beginning of data and
1080** the checksum is stored at the end. This is important. If journal
1081** corruption occurs due to a power failure, the most likely scenario
1082** is that one end or the other of the record will be changed. It is
1083** much less likely that the two ends of the journal record will be
1084** correct and the middle be corrupt. Thus, this "checksum" scheme,
1085** though fast and simple, catches the mostly likely kind of corruption.
1086**
1087** FIX ME: Consider adding every 200th (or so) byte of the data to the
1088** checksum. That way if a single page spans 3 or more disk sectors and
1089** only the middle sector is corrupt, we will still have a reasonable
1090** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001091*/
drh74161702006-02-24 02:53:49 +00001092static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001093 u32 cksum = pPager->cksumInit;
1094 int i = pPager->pageSize-200;
1095 while( i>0 ){
1096 cksum += aData[i];
1097 i -= 200;
1098 }
drh968af522003-02-11 14:55:40 +00001099 return cksum;
1100}
1101
drh605ad8f2006-05-03 23:34:05 +00001102/* Forward declaration */
1103static void makeClean(PgHdr*);
1104
drh968af522003-02-11 14:55:40 +00001105/*
drhfa86c412002-02-02 15:01:15 +00001106** Read a single page from the journal file opened on file descriptor
1107** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001108**
drh726de592004-06-10 23:35:50 +00001109** If useCksum==0 it means this journal does not use checksums. Checksums
1110** are not used in statement journals because statement journals do not
1111** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001112*/
danielk197762079062007-08-15 17:08:46 +00001113static int pager_playback_one_page(
1114 Pager *pPager,
1115 sqlite3_file *jfd,
1116 i64 offset,
1117 int useCksum
1118){
drhfa86c412002-02-02 15:01:15 +00001119 int rc;
drhae2b40c2004-06-09 19:03:54 +00001120 PgHdr *pPg; /* An existing page in the cache */
1121 Pgno pgno; /* The page number of a page in journal */
1122 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001123 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001124
drh96362842005-03-20 22:47:56 +00001125 /* useCksum should be true for the main journal and false for
1126 ** statement journals. Verify that this is always the case
1127 */
drh9cbe6352005-11-29 03:13:21 +00001128 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001129 assert( aData );
drh96362842005-03-20 22:47:56 +00001130
danielk197762079062007-08-15 17:08:46 +00001131 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001132 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001133 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001134 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001135 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001136
drh968af522003-02-11 14:55:40 +00001137 /* Sanity checking on the page. This is more important that I originally
1138 ** thought. If a power failure occurs while the journal is being written,
1139 ** it could cause invalid data to be written into the journal. We need to
1140 ** detect this invalid data (with high probability) and ignore it.
1141 */
danielk197775edc162004-06-26 01:48:18 +00001142 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001143 return SQLITE_DONE;
1144 }
drhae2b40c2004-06-09 19:03:54 +00001145 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001146 return SQLITE_OK;
1147 }
drhae2b40c2004-06-09 19:03:54 +00001148 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001149 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001150 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001151 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001152 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001153 return SQLITE_DONE;
1154 }
1155 }
drhfa86c412002-02-02 15:01:15 +00001156
danielk1977aa5ccdf2004-06-14 05:10:42 +00001157 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001158
1159 /* If the pager is in RESERVED state, then there must be a copy of this
1160 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001161 ** not the database file. The page is left marked dirty in this case.
1162 **
danielk19772df71c72007-05-24 07:22:42 +00001163 ** An exception to the above rule: If the database is in no-sync mode
1164 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001165 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1166 ** during a Movepage() call, then the page may not be in the cache
1167 ** either. So the condition described in the above paragraph is not
1168 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001169 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001170 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1171 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001172 **
1173 ** Ticket #1171: The statement journal might contain page content that is
1174 ** different from the page content at the start of the transaction.
1175 ** This occurs when a page is changed prior to the start of a statement
1176 ** then changed again within the statement. When rolling back such a
1177 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001178 ** for certain that original page contents are synced into the main rollback
1179 ** journal. Otherwise, a power loss might leave modified data in the
1180 ** database file without an entry in the rollback journal that can
1181 ** restore the database to its original form. Two conditions must be
1182 ** met before writing to the database files. (1) the database must be
1183 ** locked. (2) we know that the original page content is fully synced
1184 ** in the main journal either because the page is not in cache or else
1185 ** the page is marked as needSync==0.
drhfa86c412002-02-02 15:01:15 +00001186 */
drhae2b40c2004-06-09 19:03:54 +00001187 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001188 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1189 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh96362842005-03-20 22:47:56 +00001190 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
danielk197762079062007-08-15 17:08:46 +00001191 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1192 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001193 if( pPg ){
1194 makeClean(pPg);
1195 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001196 }
drhfa86c412002-02-02 15:01:15 +00001197 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001198 /* No page should ever be explicitly rolled back that is in use, except
1199 ** for page 1 which is held in use in order to keep the lock on the
1200 ** database active. However such a page may be rolled back as a result
1201 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001202 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001203 */
drhb6f41482004-05-14 01:58:11 +00001204 void *pData;
danielk197728129562005-01-11 10:25:06 +00001205 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001206 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001207 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001208 if( pPager->xReiniter ){
1209 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001210 }
danielk19773c407372005-02-15 02:54:14 +00001211#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001212 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001213#endif
drh86a88112007-04-16 15:02:19 +00001214 /* If this was page 1, then restore the value of Pager.dbFileVers.
1215 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001216 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001217 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001218 }
drh86a88112007-04-16 15:02:19 +00001219
1220 /* Decode the page just read from disk */
1221 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001222 }
1223 return rc;
1224}
1225
1226/*
danielk197713adf8a2004-06-03 16:08:41 +00001227** Parameter zMaster is the name of a master journal file. A single journal
1228** file that referred to the master journal file has just been rolled back.
1229** This routine checks if it is possible to delete the master journal file,
1230** and does so if it is.
drh726de592004-06-10 23:35:50 +00001231**
1232** The master journal file contains the names of all child journals.
1233** To tell if a master journal can be deleted, check to each of the
1234** children. If all children are either missing or do not refer to
1235** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001236*/
danielk1977b4b47412007-08-17 15:53:36 +00001237static int pager_delmaster(Pager *pPager, const char *zMaster){
1238 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001239 int rc;
1240 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001241 sqlite3_file *pMaster;
1242 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001243 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001244 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001245
1246 /* Open the master journal file exclusively in case some other process
1247 ** is running this routine also. Not that it makes too much difference.
1248 */
danielk1977b4b47412007-08-17 15:53:36 +00001249 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001250 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001251 if( !pMaster ){
1252 rc = SQLITE_NOMEM;
1253 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001254 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1255 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001256 }
danielk197713adf8a2004-06-03 16:08:41 +00001257 if( rc!=SQLITE_OK ) goto delmaster_out;
1258 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001259
1260 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001261 if( rc!=SQLITE_OK ) goto delmaster_out;
1262
1263 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001264 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001265 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +00001266
1267 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001268 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001269 */
drh17435752007-08-16 04:30:38 +00001270 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001271 if( !zMasterJournal ){
1272 rc = SQLITE_NOMEM;
1273 goto delmaster_out;
1274 }
danielk1977b4b47412007-08-17 15:53:36 +00001275 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001276 if( rc!=SQLITE_OK ) goto delmaster_out;
1277
danielk19775865e3d2004-06-14 06:03:57 +00001278 zJournal = zMasterJournal;
1279 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977b4b47412007-08-17 15:53:36 +00001280 if( sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS) ){
danielk197713adf8a2004-06-03 16:08:41 +00001281 /* One of the journals pointed to by the master journal exists.
1282 ** Open it and check if it points at the master journal. If
1283 ** so, return without deleting the master journal file.
1284 */
drh3b7b78b2004-11-24 01:16:43 +00001285 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001286 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1287 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001288 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001289 goto delmaster_out;
1290 }
danielk197713adf8a2004-06-03 16:08:41 +00001291
danielk1977b4b47412007-08-17 15:53:36 +00001292 rc = readMasterJournal(pJournal, &zMasterPtr);
1293 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001294 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001295 goto delmaster_out;
1296 }
danielk197776572402004-06-25 02:38:54 +00001297
drh3b7b78b2004-11-24 01:16:43 +00001298 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
drh17435752007-08-16 04:30:38 +00001299 sqlite3_free(zMasterPtr);
drh3b7b78b2004-11-24 01:16:43 +00001300 if( c ){
danielk197776572402004-06-25 02:38:54 +00001301 /* We have a match. Do not delete the master journal file. */
1302 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001303 }
1304 }
danielk19775865e3d2004-06-14 06:03:57 +00001305 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001306 }
1307 }
1308
danielk1977fee2d252007-08-18 10:59:19 +00001309 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001310
1311delmaster_out:
1312 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001313 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001314 }
1315 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001316 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001317 }
danielk1977b4b47412007-08-17 15:53:36 +00001318 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001319 return rc;
1320}
1321
drha6abd042004-06-09 17:37:22 +00001322
danielk1977e180dd92007-04-05 17:15:52 +00001323static void pager_truncate_cache(Pager *pPager);
1324
drha6abd042004-06-09 17:37:22 +00001325/*
drhcb4c40b2004-08-18 19:09:43 +00001326** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001327** indicated. Also truncate the cached representation of the file.
drhcb4c40b2004-08-18 19:09:43 +00001328*/
1329static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001330 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001331 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
danielk1977e180dd92007-04-05 17:15:52 +00001332 rc = sqlite3OsTruncate(pPager->fd, pPager->pageSize*(i64)nPage);
1333 }
1334 if( rc==SQLITE_OK ){
1335 pPager->dbSize = nPage;
1336 pager_truncate_cache(pPager);
1337 }
1338 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001339}
1340
1341/*
drhc80f0582007-05-01 16:59:48 +00001342** Set the sectorSize for the given pager.
1343**
1344** The sector size is the larger of the sector size reported
1345** by sqlite3OsSectorSize() and the pageSize.
1346*/
1347static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001348 assert(pPager->fd->pMethods||pPager->tempFile);
1349 if( !pPager->tempFile ){
1350 /* Sector size doesn't matter for temporary files. Also, the file
1351 ** may not have been opened yet, in whcih case the OsSectorSize()
1352 ** call will segfault.
1353 */
1354 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1355 }
drhc80f0582007-05-01 16:59:48 +00001356 if( pPager->sectorSize<pPager->pageSize ){
1357 pPager->sectorSize = pPager->pageSize;
1358 }
1359}
1360
1361/*
drhed7c8552001-04-11 14:29:21 +00001362** Playback the journal and thus restore the database file to
1363** the state it was in before we started making changes.
1364**
drh34e79ce2004-02-08 06:05:46 +00001365** The journal file format is as follows:
1366**
drhae2b40c2004-06-09 19:03:54 +00001367** (1) 8 byte prefix. A copy of aJournalMagic[].
1368** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001369** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001370** number of page records from the journal size.
1371** (3) 4 byte big-endian integer which is the initial value for the
1372** sanity checksum.
1373** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001374** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001375** (5) 4 byte integer which is the number of bytes in the master journal
1376** name. The value may be zero (indicate that there is no master
1377** journal.)
1378** (6) N bytes of the master journal name. The name will be nul-terminated
1379** and might be shorter than the value read from (5). If the first byte
1380** of the name is \000 then there is no master journal. The master
1381** journal name is stored in UTF-8.
1382** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001383** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001384** + pPager->pageSize bytes of data.
1385** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001386**
drhae2b40c2004-06-09 19:03:54 +00001387** When we speak of the journal header, we mean the first 6 items above.
1388** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001389**
1390** Call the value from the second bullet "nRec". nRec is the number of
1391** valid page entries in the journal. In most cases, you can compute the
1392** value of nRec from the size of the journal file. But if a power
1393** failure occurred while the journal was being written, it could be the
1394** case that the size of the journal file had already been increased but
1395** the extra entries had not yet made it safely to disk. In such a case,
1396** the value of nRec computed from the file size would be too large. For
1397** that reason, we always use the nRec value in the header.
1398**
1399** If the nRec value is 0xffffffff it means that nRec should be computed
1400** from the file size. This value is used when the user selects the
1401** no-sync option for the journal. A power failure could lead to corruption
1402** in this case. But for things like temporary table (which will be
1403** deleted when the power is restored) we don't care.
1404**
drhd9b02572001-04-15 00:37:09 +00001405** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001406** journal file then all pages up to the first corrupted page are rolled
1407** back (or no pages if the journal header is corrupted). The journal file
1408** is then deleted and SQLITE_OK returned, just as if no corruption had
1409** been encountered.
1410**
1411** If an I/O or malloc() error occurs, the journal-file is not deleted
1412** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001413*/
danielk1977e277be02007-03-23 18:12:06 +00001414static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001415 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001416 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001417 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001418 int i; /* Loop counter */
1419 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001420 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001421 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001422
drhc3a64ba2001-11-22 00:01:27 +00001423 /* Figure out how many records are in the journal. Abort early if
1424 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001425 */
drh8cfbf082001-09-19 13:22:39 +00001426 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001427 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001428 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001429 goto end_playback;
1430 }
drh240c5792004-02-08 00:40:52 +00001431
danielk197776572402004-06-25 02:38:54 +00001432 /* Read the master journal name from the journal, if it is present.
1433 ** If a master journal file name is specified, but the file is not
1434 ** present on disk, then the journal is not hot and does not need to be
1435 ** played back.
drh240c5792004-02-08 00:40:52 +00001436 */
drh9cbe6352005-11-29 03:13:21 +00001437 rc = readMasterJournal(pPager->jfd, &zMaster);
danielk197776572402004-06-25 02:38:54 +00001438 assert( rc!=SQLITE_DONE );
danielk1977b4b47412007-08-17 15:53:36 +00001439 if( rc!=SQLITE_OK
1440 || (zMaster && !sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS))
1441 ){
drh17435752007-08-16 04:30:38 +00001442 sqlite3_free(zMaster);
danielk197776572402004-06-25 02:38:54 +00001443 zMaster = 0;
1444 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001445 goto end_playback;
1446 }
danielk197776572402004-06-25 02:38:54 +00001447 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001448
danielk197776572402004-06-25 02:38:54 +00001449 /* This loop terminates either when the readJournalHdr() call returns
1450 ** SQLITE_DONE or an IO error occurs. */
1451 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001452
danielk197776572402004-06-25 02:38:54 +00001453 /* Read the next journal header from the journal file. If there are
1454 ** not enough bytes left in the journal file for a complete header, or
1455 ** it is corrupted, then a process must of failed while writing it.
1456 ** This indicates nothing more needs to be rolled back.
1457 */
1458 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1459 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001460 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001461 rc = SQLITE_OK;
1462 }
danielk197776572402004-06-25 02:38:54 +00001463 goto end_playback;
1464 }
1465
1466 /* If nRec is 0xffffffff, then this journal was created by a process
1467 ** working in no-sync mode. This means that the rest of the journal
1468 ** file consists of pages, there are no more journal headers. Compute
1469 ** the value of nRec based on this assumption.
1470 */
1471 if( nRec==0xffffffff ){
1472 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1473 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1474 }
1475
danielk1977e277be02007-03-23 18:12:06 +00001476 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001477 ** process and if this is the final header in the journal, then it means
1478 ** that this part of the journal was being filled but has not yet been
1479 ** synced to disk. Compute the number of pages based on the remaining
1480 ** size of the file.
1481 **
1482 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001483 */
drh8940f4e2007-08-11 00:26:20 +00001484 if( nRec==0 && !isHot &&
1485 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001486 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1487 }
1488
danielk197776572402004-06-25 02:38:54 +00001489 /* If this is the first header read from the journal, truncate the
1490 ** database file back to it's original size.
1491 */
danielk1977e180dd92007-04-05 17:15:52 +00001492 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001493 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001494 if( rc!=SQLITE_OK ){
1495 goto end_playback;
1496 }
danielk197776572402004-06-25 02:38:54 +00001497 }
1498
danielk197776572402004-06-25 02:38:54 +00001499 /* Copy original pages out of the journal and back into the database file.
1500 */
1501 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001502 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001503 if( rc!=SQLITE_OK ){
1504 if( rc==SQLITE_DONE ){
1505 rc = SQLITE_OK;
1506 pPager->journalOff = szJ;
1507 break;
1508 }else{
1509 goto end_playback;
1510 }
1511 }
drh968af522003-02-11 14:55:40 +00001512 }
drhed7c8552001-04-11 14:29:21 +00001513 }
drh580eeaf2006-02-24 03:09:37 +00001514 /*NOTREACHED*/
1515 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001516
1517end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001518 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001519 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001520 }
danielk197713adf8a2004-06-03 16:08:41 +00001521 if( zMaster ){
danielk1977979f38e2007-03-27 16:19:51 +00001522 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001523 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001524 */
1525 if( rc==SQLITE_OK ){
danielk1977b4b47412007-08-17 15:53:36 +00001526 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001527 }
drh17435752007-08-16 04:30:38 +00001528 sqlite3_free(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001529 }
danielk197776572402004-06-25 02:38:54 +00001530
1531 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001532 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001533 ** value. Reset it to the correct value for this process.
1534 */
drhc80f0582007-05-01 16:59:48 +00001535 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001536 return rc;
drhed7c8552001-04-11 14:29:21 +00001537}
1538
1539/*
drhac69b052004-05-12 13:30:07 +00001540** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001541**
1542** This is similar to playing back the transaction journal but with
1543** a few extra twists.
1544**
drh663fc632002-02-02 18:49:19 +00001545** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001546** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001547** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001548**
drhac69b052004-05-12 13:30:07 +00001549** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001550** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001551** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001552*/
drh3aac2dd2004-04-26 14:10:20 +00001553static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001554 i64 szJ; /* Size of the full journal */
1555 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001556 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001557 int i; /* Loop counter */
1558 int rc;
1559
danielk197776572402004-06-25 02:38:54 +00001560 szJ = pPager->journalOff;
1561#ifndef NDEBUG
1562 {
drheb206252004-10-01 02:00:31 +00001563 i64 os_szJ;
drh054889e2005-11-30 03:20:31 +00001564 rc = sqlite3OsFileSize(pPager->jfd, &os_szJ);
danielk197776572402004-06-25 02:38:54 +00001565 if( rc!=SQLITE_OK ) return rc;
1566 assert( szJ==os_szJ );
1567 }
1568#endif
1569
danielk19774099f6e2007-03-19 11:25:20 +00001570 /* Set hdrOff to be the offset just after the end of the last journal
1571 ** page written before the first journal-header for this statement
1572 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001573 ** header was written.
1574 */
1575 hdrOff = pPager->stmtHdrOff;
1576 assert( pPager->fullSync || !hdrOff );
1577 if( !hdrOff ){
1578 hdrOff = szJ;
1579 }
1580
drhfa86c412002-02-02 15:01:15 +00001581 /* Truncate the database back to its original size.
1582 */
danielk1977e180dd92007-04-05 17:15:52 +00001583 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001584 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001585
drhac69b052004-05-12 13:30:07 +00001586 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001587 */
drhac69b052004-05-12 13:30:07 +00001588 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001589 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001590
drhac69b052004-05-12 13:30:07 +00001591 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001592 ** database file. Note that the statement journal omits checksums from
1593 ** each record since power-failure recovery is not important to statement
1594 ** journals.
drhfa86c412002-02-02 15:01:15 +00001595 */
danielk197762079062007-08-15 17:08:46 +00001596 for(i=0; i<nRec; i++){
1597 i64 offset = i*(4+pPager->pageSize);
1598 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001599 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001600 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001601 }
1602
danielk197776572402004-06-25 02:38:54 +00001603 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1604 ** was the size of the journal file when this statement was started, so
1605 ** everything after that needs to be rolled back, either into the
1606 ** database, the memory cache, or both.
1607 **
1608 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1609 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001610 */
danielk197776572402004-06-25 02:38:54 +00001611 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001612 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001613 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001614 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001615 assert( rc!=SQLITE_DONE );
1616 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1617 }
1618
1619 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001620 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001621 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001622 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001623 if( rc!=SQLITE_OK ){
1624 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001625 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001626 }
danielk1977f0113002006-01-24 12:09:17 +00001627 if( nJRec==0 ){
1628 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001629 }
danielk1977f0113002006-01-24 12:09:17 +00001630 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001631 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001632 assert( rc!=SQLITE_DONE );
1633 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1634 }
drhfa86c412002-02-02 15:01:15 +00001635 }
danielk197776572402004-06-25 02:38:54 +00001636
1637 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001638
drh3aac2dd2004-04-26 14:10:20 +00001639end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001640 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001641 pPager->journalOff = szJ;
1642 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001643 }
1644 return rc;
1645}
1646
1647/*
drhf57b14a2001-09-14 18:54:08 +00001648** Change the maximum number of in-memory pages that are allowed.
1649*/
danielk19773b8a05f2007-03-19 17:44:26 +00001650void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00001651 if( mxPage>10 ){
1652 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001653 }else{
1654 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001655 }
1656}
1657
1658/*
drh973b6e32003-02-12 14:09:42 +00001659** Adjust the robustness of the database to damage due to OS crashes
1660** or power failures by changing the number of syncs()s when writing
1661** the rollback journal. There are three levels:
1662**
drh054889e2005-11-30 03:20:31 +00001663** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001664** for temporary and transient files.
1665**
1666** NORMAL The journal is synced once before writes begin on the
1667** database. This is normally adequate protection, but
1668** it is theoretically possible, though very unlikely,
1669** that an inopertune power failure could leave the journal
1670** in a state which would cause damage to the database
1671** when it is rolled back.
1672**
1673** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001674** database (with some additional information - the nRec field
1675** of the journal header - being written in between the two
1676** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001677** single disk sector is atomic, then this mode provides
1678** assurance that the journal will not be corrupted to the
1679** point of causing damage to the database during rollback.
1680**
1681** Numeric values associated with these states are OFF==1, NORMAL=2,
1682** and FULL=3.
1683*/
danielk197793758c82005-01-21 08:13:14 +00001684#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00001685void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00001686 pPager->noSync = level==1 || pPager->tempFile;
1687 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00001688 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001689 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001690}
danielk197793758c82005-01-21 08:13:14 +00001691#endif
drh973b6e32003-02-12 14:09:42 +00001692
1693/*
drhaf6df112005-06-07 02:12:30 +00001694** The following global variable is incremented whenever the library
1695** attempts to open a temporary file. This information is used for
1696** testing and analysis only.
1697*/
drh0f7eb612006-08-08 13:51:43 +00001698#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001699int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001700#endif
drhaf6df112005-06-07 02:12:30 +00001701
1702/*
drh3f56e6e2007-03-15 01:16:47 +00001703** Open a temporary file.
1704**
1705** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001706** other error code if we fail. The OS will automatically delete the temporary
1707** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001708**
danielk1977fee2d252007-08-18 10:59:19 +00001709** If zNameOut is 0, then SQLITE_OPEN_SUBJOURNAL is passed to the OS layer.
1710** If zNameOut is not 0, SQLITE_OPEN_TEMP_DB is passed.
drhfa86c412002-02-02 15:01:15 +00001711*/
danielk1977b4b47412007-08-17 15:53:36 +00001712static int sqlite3PagerOpentemp(
1713 sqlite3_vfs *pVfs,
1714 sqlite3_file *pFile,
1715 char *zNameOut
1716){
drhfa86c412002-02-02 15:01:15 +00001717 int cnt = 8;
1718 int rc;
danielk1977b4b47412007-08-17 15:53:36 +00001719 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|SQLITE_OPEN_EXCLUSIVE);
1720
1721 char *zFree = 0;
1722 if( zNameOut==0 ){
1723 zFree = (char *)sqlite3_malloc(pVfs->mxPathname);
1724 if( !zFree ){
1725 return SQLITE_NOMEM;
1726 }
1727 zNameOut = zFree;
danielk1977fee2d252007-08-18 10:59:19 +00001728 flags |= SQLITE_OPEN_SUBJOURNAL;
1729 }else{
1730 flags |= SQLITE_OPEN_TEMP_DB;
danielk1977b4b47412007-08-17 15:53:36 +00001731 }
drh3f56e6e2007-03-15 01:16:47 +00001732
drh0f7eb612006-08-08 13:51:43 +00001733#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001734 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001735#endif
danielk1977b4b47412007-08-17 15:53:36 +00001736
drhfa86c412002-02-02 15:01:15 +00001737 do{
1738 cnt--;
danielk1977b4b47412007-08-17 15:53:36 +00001739 sqlite3OsGetTempName(pVfs, zNameOut);
1740 rc = sqlite3OsOpen(pVfs, zNameOut, pFile, flags, 0);
1741 assert( rc!=SQLITE_OK || pFile->pMethods );
danielk197713073932004-06-30 11:54:06 +00001742 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
danielk1977b4b47412007-08-17 15:53:36 +00001743
1744 sqlite3_free(zFree);
drhfa86c412002-02-02 15:01:15 +00001745 return rc;
1746}
1747
1748/*
drhed7c8552001-04-11 14:29:21 +00001749** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001750** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001751** the first call to sqlite3PagerGet() and is only held open until the
1752** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001753**
drh6446c4d2001-12-15 14:22:18 +00001754** If zFilename is NULL then a randomly-named temporary file is created
1755** and used as the file to be cached. The file will be deleted
1756** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001757**
1758** If zFilename is ":memory:" then all information is held in cache.
1759** It is never written to disk. This can be used to implement an
1760** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001761*/
danielk19773b8a05f2007-03-19 17:44:26 +00001762int sqlite3PagerOpen(
danielk1977b4b47412007-08-17 15:53:36 +00001763 sqlite3_vfs *pVfs,
drh7e3b0a02001-04-28 16:52:40 +00001764 Pager **ppPager, /* Return the Pager structure here */
1765 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001766 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001767 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001768){
danielk1977b4b47412007-08-17 15:53:36 +00001769 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001770 Pager *pPager = 0;
danielk19778def5ea2004-06-16 10:39:52 +00001771 char *zFullPathname = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001772 int rc = SQLITE_OK;
1773 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001774 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001775 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001776 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001777 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1778 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977b4b47412007-08-17 15:53:36 +00001779
drh6f7adc82006-01-11 21:41:20 +00001780#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197754f01982006-01-18 15:25:17 +00001781 /* A malloc() cannot fail in sqlite3ThreadData() as one or more calls to
1782 ** malloc() must have already been made by this thread before it gets
1783 ** to this point. This means the ThreadData must have been allocated already
1784 ** so that ThreadData.nAlloc can be set. It would be nice to assert
1785 ** that ThreadData.nAlloc is non-zero, but alas this breaks test cases
1786 ** written to invoke the pager directly.
1787 */
danielk19778212def2006-01-16 15:32:23 +00001788 ThreadData *pTsd = sqlite3ThreadData();
danielk197754f01982006-01-18 15:25:17 +00001789 assert( pTsd );
danielk197752622822006-01-09 09:59:49 +00001790#endif
drhed7c8552001-04-11 14:29:21 +00001791
danielk1977393f0682007-03-31 10:00:48 +00001792 /* We used to test if malloc() had already failed before proceeding.
1793 ** But the way this function is used in SQLite means that can never
1794 ** happen. Furthermore, if the malloc-failed flag is already set,
drh17435752007-08-16 04:30:38 +00001795 ** either the call to sqlite3StrDup() or sqlite3_malloc() below will
danielk1977393f0682007-03-31 10:00:48 +00001796 ** fail shortly and SQLITE_NOMEM returned anyway.
danielk1977aef0bf62005-12-30 16:28:01 +00001797 */
drhd9b02572001-04-15 00:37:09 +00001798 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001799
danielk1977b4b47412007-08-17 15:53:36 +00001800 /* Allocate memory for the pager structure */
1801 pPager = sqlite3MallocZero(
1802 sizeof(*pPager) + /* Pager structure */
1803 pVfs->szOsFile * 3 + /* The db, journal and stmt journal files */
1804 pVfs->mxPathname * 3 + 30 /* zFilename, zDirectory, zJournal */
1805 );
1806 if( !pPager ){
1807 return SQLITE_NOMEM;
1808 }
1809 pPtr = (u8 *)&pPager[1];
1810 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
1811 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
1812 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
1813 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*3];
1814 pPager->zDirectory = &pPager->zFilename[pVfs->mxPathname];
1815 pPager->zJournal = &pPager->zDirectory[pVfs->mxPathname];
1816 pPager->pVfs = pVfs;
1817
danielk1977aef0bf62005-12-30 16:28:01 +00001818 /* Open the pager file and set zFullPathname to point at malloc()ed
1819 ** memory containing the complete filename (i.e. including the directory).
1820 */
drh901afd42003-08-26 11:25:58 +00001821 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001822#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001823 if( strcmp(zFilename,":memory:")==0 ){
1824 memDb = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001825 pPager->zFilename[0] = '\0';
drhb7f91642004-10-31 02:22:47 +00001826 }else
1827#endif
1828 {
danielk1977b4b47412007-08-17 15:53:36 +00001829 rc = sqlite3OsFullPathname(pVfs, zFilename, pPager->zFilename);
1830 if( rc==SQLITE_OK ){
1831 if( strlen(pPager->zFilename)>(pVfs->mxPathname - strlen("-journal")) ){
1832 rc = SQLITE_CANTOPEN;
1833 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001834 int oflag =
1835 (SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|SQLITE_OPEN_MAIN_DB);
danielk1977b4b47412007-08-17 15:53:36 +00001836 int fout = 0;
danielk1977fee2d252007-08-18 10:59:19 +00001837 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd, oflag, &fout);
danielk1977b4b47412007-08-17 15:53:36 +00001838 readOnly = (fout&SQLITE_OPEN_READONLY);
1839 }
danielk19778def5ea2004-06-16 10:39:52 +00001840 }
drhac69b052004-05-12 13:30:07 +00001841 }
drh5e00f6c2001-09-13 13:46:56 +00001842 }else{
danielk19777a2b1ee2007-08-21 14:27:01 +00001843 /* If a temporary file is requested, it is not opened immediately.
1844 ** In this case we accept the default page size and delay actually
1845 ** opening the file until the first call to OsWrite().
1846 */
1847 /* rc = sqlite3PagerOpentemp(pVfs, pPager->fd, pPager->zFilename); */
1848 tempFile = 1;
1849 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001850 }
danielk1977aef0bf62005-12-30 16:28:01 +00001851
danielk1977b4b47412007-08-17 15:53:36 +00001852 if( pPager && rc==SQLITE_OK ){
1853 pPager->pTmpSpace = (char *)sqlite3_malloc(SQLITE_DEFAULT_PAGE_SIZE);
drh3e7a6092002-12-07 21:45:14 +00001854 }
danielk1977aef0bf62005-12-30 16:28:01 +00001855
1856 /* If an error occured in either of the blocks above, free the memory
1857 ** pointed to by zFullPathname, free the Pager structure and close the
1858 ** file. Since the pager is not allocated there is no need to set
1859 ** any Pager.errMask variables.
1860 */
danielk1977b4b47412007-08-17 15:53:36 +00001861 if( !pPager || !pPager->pTmpSpace ){
1862 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001863 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001864 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001865 }
danielk1977aef0bf62005-12-30 16:28:01 +00001866
drh4f0c5872007-03-26 22:05:01 +00001867 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhb0603412007-02-28 04:47:26 +00001868 IOTRACE(("OPEN %p %s\n", pPager, zFullPathname))
danielk1977aef0bf62005-12-30 16:28:01 +00001869
danielk1977b4b47412007-08-17 15:53:36 +00001870 /* Fill in Pager.zDirectory[] */
1871 memcpy(pPager->zDirectory, pPager->zFilename, pVfs->mxPathname);
1872 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001873 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001874
1875 /* Fill in Pager.zJournal[] */
1876 memcpy(pPager->zJournal, pPager->zFilename, pVfs->mxPathname);
1877 memcpy(&pPager->zJournal[strlen(pPager->zJournal)], "-journal", 9);
1878
drh3b59a5c2006-01-15 20:28:28 +00001879 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00001880 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001881 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001882 /* pPager->stmtOpen = 0; */
1883 /* pPager->stmtInUse = 0; */
1884 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001885 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001886 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drh3b59a5c2006-01-15 20:28:28 +00001887 /* pPager->stmtSize = 0; */
1888 /* pPager->stmtJSize = 0; */
1889 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001890 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001891 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001892 assert( PAGER_UNLOCK==0 );
1893 /* pPager->state = PAGER_UNLOCK; */
1894 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001895 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001896 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1897 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1898 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1899 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001900 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001901 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001902 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001903 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001904 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00001905 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00001906 /* pPager->pFirst = 0; */
1907 /* pPager->pFirstSynced = 0; */
1908 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00001909 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk19777a2b1ee2007-08-21 14:27:01 +00001910 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00001911 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00001912 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00001913 }
drh3b59a5c2006-01-15 20:28:28 +00001914 /* pPager->pBusyHandler = 0; */
1915 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001916 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00001917#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk19778212def2006-01-16 15:32:23 +00001918 pPager->pNext = pTsd->pPager;
1919 pTsd->pPager = pPager;
danielk197752622822006-01-09 09:59:49 +00001920#endif
drhed7c8552001-04-11 14:29:21 +00001921 return SQLITE_OK;
1922}
1923
1924/*
drh90f5ecb2004-07-22 01:19:35 +00001925** Set the busy handler function.
1926*/
danielk19773b8a05f2007-03-19 17:44:26 +00001927void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00001928 pPager->pBusyHandler = pBusyHandler;
1929}
1930
1931/*
drh72f82862001-05-24 21:06:34 +00001932** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001933** when the reference count on each page reaches zero. The destructor can
1934** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001935**
danielk19773b8a05f2007-03-19 17:44:26 +00001936** The destructor is not called as a result sqlite3PagerClose().
1937** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00001938*/
danielk19773b8a05f2007-03-19 17:44:26 +00001939void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00001940 pPager->xDestructor = xDesc;
1941}
1942
1943/*
drha6abd042004-06-09 17:37:22 +00001944** Set the reinitializer for this pager. If not NULL, the reinitializer
1945** is called when the content of a page in cache is restored to its original
1946** value as a result of a rollback. The callback gives higher-level code
1947** an opportunity to restore the EXTRA section to agree with the restored
1948** page data.
1949*/
danielk19773b8a05f2007-03-19 17:44:26 +00001950void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00001951 pPager->xReiniter = xReinit;
1952}
1953
1954/*
drh1c7880e2005-05-20 20:01:55 +00001955** Set the page size. Return the new size. If the suggest new page
1956** size is inappropriate, then an alternative page size is selected
1957** and returned.
drh90f5ecb2004-07-22 01:19:35 +00001958*/
danielk19773b8a05f2007-03-19 17:44:26 +00001959int sqlite3PagerSetPagesize(Pager *pPager, int pageSize){
drh90f5ecb2004-07-22 01:19:35 +00001960 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
danielk1977c7c7e622007-03-26 15:46:00 +00001961 if( !pPager->memDb && pPager->nRef==0 ){
1962 pager_reset(pPager);
drh1c7880e2005-05-20 20:01:55 +00001963 pPager->pageSize = pageSize;
drh17435752007-08-16 04:30:38 +00001964 sqlite3_free(pPager->pTmpSpace);
1965 pPager->pTmpSpace = sqlite3_malloc(pageSize);
drh1c7880e2005-05-20 20:01:55 +00001966 }
1967 return pPager->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00001968}
1969
1970/*
drhf8e632b2007-05-08 14:51:36 +00001971** Attempt to set the maximum database page count if mxPage is positive.
1972** Make no changes if mxPage is zero or negative. And never reduce the
1973** maximum page count below the current size of the database.
1974**
1975** Regardless of mxPage, return the current maximum page count.
1976*/
1977int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
1978 if( mxPage>0 ){
1979 pPager->mxPgno = mxPage;
1980 }
1981 sqlite3PagerPagecount(pPager);
1982 return pPager->mxPgno;
1983}
1984
1985/*
drhc9ac5ca2005-11-04 22:03:30 +00001986** The following set of routines are used to disable the simulated
1987** I/O error mechanism. These routines are used to avoid simulated
1988** errors in places where we do not care about errors.
1989**
1990** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
1991** and generate no code.
1992*/
1993#ifdef SQLITE_TEST
1994extern int sqlite3_io_error_pending;
1995extern int sqlite3_io_error_hit;
1996static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00001997void disable_simulated_io_errors(void){
1998 saved_cnt = sqlite3_io_error_pending;
1999 sqlite3_io_error_pending = -1;
2000}
2001void enable_simulated_io_errors(void){
2002 sqlite3_io_error_pending = saved_cnt;
2003}
2004#else
drh152410f2005-11-05 15:11:22 +00002005# define disable_simulated_io_errors()
2006# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002007#endif
2008
2009/*
drh90f5ecb2004-07-22 01:19:35 +00002010** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002011** that pDest points to.
2012**
2013** No error checking is done. The rational for this is that this function
2014** may be called even if the file does not exist or contain a header. In
2015** these cases sqlite3OsRead() will return an error, to which the correct
2016** response is to zero the memory at pDest and continue. A real IO error
2017** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002018*/
danielk19773b8a05f2007-03-19 17:44:26 +00002019int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002020 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002021 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002022 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2023 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002024 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002025 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002026 if( rc==SQLITE_IOERR_SHORT_READ ){
2027 rc = SQLITE_OK;
2028 }
drh90f5ecb2004-07-22 01:19:35 +00002029 }
drh551b7732006-11-06 21:20:25 +00002030 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002031}
2032
2033/*
drh5e00f6c2001-09-13 13:46:56 +00002034** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002035** pPager.
2036**
2037** If the PENDING_BYTE lies on the page directly after the end of the
2038** file, then consider this page part of the file too. For example, if
2039** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2040** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002041*/
danielk19773b8a05f2007-03-19 17:44:26 +00002042int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002043 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002044 int rc;
drhd9b02572001-04-15 00:37:09 +00002045 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002046 if( pPager->errCode ){
2047 return 0;
2048 }
drhed7c8552001-04-11 14:29:21 +00002049 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002050 n = pPager->dbSize;
2051 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002052 assert(pPager->fd->pMethods||pPager->tempFile);
2053 if( (pPager->fd->pMethods)
2054 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002055 pager_error(pPager, rc);
danielk197715f411d2005-09-16 10:18:45 +00002056 return 0;
2057 }
2058 if( n>0 && n<pPager->pageSize ){
2059 n = 1;
2060 }else{
2061 n /= pPager->pageSize;
2062 }
2063 if( pPager->state!=PAGER_UNLOCK ){
2064 pPager->dbSize = n;
2065 }
drhed7c8552001-04-11 14:29:21 +00002066 }
danielk197715f411d2005-09-16 10:18:45 +00002067 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002068 n++;
2069 }
drhf8e632b2007-05-08 14:51:36 +00002070 if( n>pPager->mxPgno ){
2071 pPager->mxPgno = n;
2072 }
drhed7c8552001-04-11 14:29:21 +00002073 return n;
2074}
2075
drhf07e7d52006-04-07 13:54:46 +00002076
2077#ifndef SQLITE_OMIT_MEMORYDB
2078/*
2079** Clear a PgHistory block
2080*/
2081static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002082 sqlite3_free(pHist->pOrig);
2083 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002084 pHist->pOrig = 0;
2085 pHist->pStmt = 0;
2086}
2087#else
2088#define clearHistory(x)
2089#endif
2090
drhed7c8552001-04-11 14:29:21 +00002091/*
drhf7c57532003-04-25 13:22:51 +00002092** Forward declaration
2093*/
danielk197776572402004-06-25 02:38:54 +00002094static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002095
2096/*
danielk1977f5fdda82004-11-03 08:44:05 +00002097** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
2098** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002099** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002100** pNextFree/pPrevFree list that is not a part of any hash-chain.
2101*/
2102static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2103 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002104 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002105 return;
2106 }
2107 if( pPg->pNextHash ){
2108 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2109 }
2110 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002111 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002112 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2113 }else{
drh8ca0c722006-05-07 17:49:38 +00002114 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002115 pPager->aHash[h] = pPg->pNextHash;
2116 }
drh5229ae42006-03-23 23:29:04 +00002117 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002118 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2119 }
danielk1977f5fdda82004-11-03 08:44:05 +00002120 pPg->pgno = 0;
2121 pPg->pNextHash = pPg->pPrevHash = 0;
2122}
2123
2124/*
drhac69b052004-05-12 13:30:07 +00002125** Unlink a page from the free list (the list of all pages where nRef==0)
2126** and from its hash collision chain.
2127*/
2128static void unlinkPage(PgHdr *pPg){
2129 Pager *pPager = pPg->pPager;
2130
2131 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
2132 if( pPg==pPager->pFirstSynced ){
2133 PgHdr *p = pPg->pNextFree;
2134 while( p && p->needSync ){ p = p->pNextFree; }
2135 pPager->pFirstSynced = p;
2136 }
2137
2138 /* Unlink from the freelist */
2139 if( pPg->pPrevFree ){
2140 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2141 }else{
2142 assert( pPager->pFirst==pPg );
2143 pPager->pFirst = pPg->pNextFree;
2144 }
2145 if( pPg->pNextFree ){
2146 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2147 }else{
2148 assert( pPager->pLast==pPg );
2149 pPager->pLast = pPg->pPrevFree;
2150 }
2151 pPg->pNextFree = pPg->pPrevFree = 0;
2152
2153 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002154 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002155}
2156
2157/*
danielk1977e180dd92007-04-05 17:15:52 +00002158** This routine is used to truncate the cache when a database
2159** is truncated. Drop from the cache all pages whose pgno is
2160** larger than pPager->dbSize and is unreferenced.
2161**
drhac69b052004-05-12 13:30:07 +00002162** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002163**
2164** Actually, at the point this routine is called, it would be
2165** an error to have a referenced page. But rather than delete
2166** that page and guarantee a subsequent segfault, it seems better
2167** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002168*/
danielk1977e180dd92007-04-05 17:15:52 +00002169static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002170 PgHdr *pPg;
2171 PgHdr **ppPg;
2172 int dbSize = pPager->dbSize;
2173
2174 ppPg = &pPager->pAll;
2175 while( (pPg = *ppPg)!=0 ){
2176 if( pPg->pgno<=dbSize ){
2177 ppPg = &pPg->pNextAll;
2178 }else if( pPg->nRef>0 ){
2179 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2180 ppPg = &pPg->pNextAll;
2181 }else{
2182 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002183 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2184 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002185 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002186 makeClean(pPg);
drh17435752007-08-16 04:30:38 +00002187 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002188 pPager->nPage--;
2189 }
2190 }
2191}
2192
drhf7c57532003-04-25 13:22:51 +00002193/*
danielk197717221812005-02-15 03:38:05 +00002194** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002195** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002196** false or until the lock succeeds.
2197**
2198** Return SQLITE_OK on success and an error code if we cannot obtain
2199** the lock.
2200*/
2201static int pager_wait_on_lock(Pager *pPager, int locktype){
2202 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002203
2204 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002205 assert( PAGER_SHARED==SHARED_LOCK );
2206 assert( PAGER_RESERVED==RESERVED_LOCK );
2207 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002208
2209 /* If the file is currently unlocked then the size must be unknown */
2210 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2211
danielk197717221812005-02-15 03:38:05 +00002212 if( pPager->state>=locktype ){
2213 rc = SQLITE_OK;
2214 }else{
danielk197717221812005-02-15 03:38:05 +00002215 do {
drh054889e2005-11-30 03:20:31 +00002216 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002217 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002218 if( rc==SQLITE_OK ){
2219 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002220 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002221 }
2222 }
2223 return rc;
2224}
2225
2226/*
drhf7c57532003-04-25 13:22:51 +00002227** Truncate the file to the number of pages specified.
2228*/
danielk19773b8a05f2007-03-19 17:44:26 +00002229int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002230 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002231 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002232 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002233 if( pPager->errCode ){
2234 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002235 return rc;
2236 }
drh7d02cb72003-06-04 16:24:39 +00002237 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002238 return SQLITE_OK;
2239 }
drhb7f91642004-10-31 02:22:47 +00002240 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002241 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002242 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002243 return SQLITE_OK;
2244 }
danielk197776572402004-06-25 02:38:54 +00002245 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002246 if( rc!=SQLITE_OK ){
2247 return rc;
2248 }
danielk197717221812005-02-15 03:38:05 +00002249
2250 /* Get an exclusive lock on the database before truncating. */
2251 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2252 if( rc!=SQLITE_OK ){
2253 return rc;
2254 }
2255
drhcb4c40b2004-08-18 19:09:43 +00002256 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002257 return rc;
2258}
2259
2260/*
drhed7c8552001-04-11 14:29:21 +00002261** Shutdown the page cache. Free all memory and close all files.
2262**
2263** If a transaction was in progress when this routine is called, that
2264** transaction is rolled back. All outstanding pages are invalidated
2265** and their memory is freed. Any attempt to use a page associated
2266** with this page cache after this function returns will likely
2267** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002268**
2269** This function always succeeds. If a transaction is active an attempt
2270** is made to roll it back. If an error occurs during the rollback
2271** a hot journal may be left in the filesystem but no error is returned
2272** to the caller.
drhed7c8552001-04-11 14:29:21 +00002273*/
danielk19773b8a05f2007-03-19 17:44:26 +00002274int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002275#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197754f01982006-01-18 15:25:17 +00002276 /* A malloc() cannot fail in sqlite3ThreadData() as one or more calls to
2277 ** malloc() must have already been made by this thread before it gets
2278 ** to this point. This means the ThreadData must have been allocated already
2279 ** so that ThreadData.nAlloc can be set.
2280 */
danielk19778212def2006-01-16 15:32:23 +00002281 ThreadData *pTsd = sqlite3ThreadData();
danielk197776e8d1a2006-01-18 18:22:43 +00002282 assert( pPager );
danielk197754f01982006-01-18 15:25:17 +00002283 assert( pTsd && pTsd->nAlloc );
danielk197713f72992005-12-18 08:51:22 +00002284#endif
2285
drhbafda092007-01-03 23:36:22 +00002286 disable_simulated_io_errors();
drhc2ee76c2007-01-04 14:58:14 +00002287 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002288 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002289 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002290 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002291 enable_simulated_io_errors();
drh4f0c5872007-03-26 22:05:01 +00002292 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002293 IOTRACE(("CLOSE %p\n", pPager))
danielk1977efaaf572006-01-16 11:29:19 +00002294 assert( pPager->errCode || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
danielk1977e94ddc92005-03-21 03:53:38 +00002295 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002296 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002297 }
drh17435752007-08-16 04:30:38 +00002298 sqlite3_free(pPager->aInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002299 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002300 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002301 }
danielk1977b4b47412007-08-17 15:53:36 +00002302 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002303 /* Temp files are automatically deleted by the OS
2304 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002305 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002306 ** }
2307 */
danielk1977aca790a2005-01-13 11:07:52 +00002308
drh6f7adc82006-01-11 21:41:20 +00002309#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk1977aef0bf62005-12-30 16:28:01 +00002310 /* Remove the pager from the linked list of pagers starting at
danielk197752622822006-01-09 09:59:49 +00002311 ** ThreadData.pPager if memory-management is enabled.
danielk1977aef0bf62005-12-30 16:28:01 +00002312 */
danielk19778212def2006-01-16 15:32:23 +00002313 if( pPager==pTsd->pPager ){
2314 pTsd->pPager = pPager->pNext;
2315 }else{
2316 Pager *pTmp;
drh74161702006-02-24 02:53:49 +00002317 for(pTmp = pTsd->pPager; pTmp->pNext!=pPager; pTmp=pTmp->pNext){}
danielk19778212def2006-01-16 15:32:23 +00002318 pTmp->pNext = pPager->pNext;
danielk197713f72992005-12-18 08:51:22 +00002319 }
2320#endif
drh17435752007-08-16 04:30:38 +00002321 sqlite3_free(pPager->aHash);
2322 sqlite3_free(pPager->pTmpSpace);
2323 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002324 return SQLITE_OK;
2325}
2326
drh87cc3b32007-05-08 21:45:27 +00002327#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002328/*
drh5e00f6c2001-09-13 13:46:56 +00002329** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002330*/
danielk19773b8a05f2007-03-19 17:44:26 +00002331Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002332 return p->pgno;
2333}
drh87cc3b32007-05-08 21:45:27 +00002334#endif
drhed7c8552001-04-11 14:29:21 +00002335
2336/*
drhc8629a12004-05-08 20:07:40 +00002337** The page_ref() function increments the reference count for a page.
2338** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002339** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002340**
2341** For non-test systems, page_ref() is a macro that calls _page_ref()
2342** online of the reference count is zero. For test systems, page_ref()
2343** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002344*/
drh836faa42003-01-11 13:30:57 +00002345static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002346 if( pPg->nRef==0 ){
2347 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00002348 if( pPg==pPg->pPager->pFirstSynced ){
2349 PgHdr *p = pPg->pNextFree;
2350 while( p && p->needSync ){ p = p->pNextFree; }
2351 pPg->pPager->pFirstSynced = p;
2352 }
drh7e3b0a02001-04-28 16:52:40 +00002353 if( pPg->pPrevFree ){
2354 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2355 }else{
2356 pPg->pPager->pFirst = pPg->pNextFree;
2357 }
2358 if( pPg->pNextFree ){
2359 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2360 }else{
2361 pPg->pPager->pLast = pPg->pPrevFree;
2362 }
2363 pPg->pPager->nRef++;
2364 }
2365 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00002366 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00002367}
danielk1977aca790a2005-01-13 11:07:52 +00002368#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002369 static void page_ref(PgHdr *pPg){
2370 if( pPg->nRef==0 ){
2371 _page_ref(pPg);
2372 }else{
2373 pPg->nRef++;
2374 REFINFO(pPg);
2375 }
2376 }
2377#else
2378# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2379#endif
drhdf0b3b02001-06-23 11:36:20 +00002380
2381/*
2382** Increment the reference count for a page. The input pointer is
2383** a reference to the page data.
2384*/
danielk19773b8a05f2007-03-19 17:44:26 +00002385int sqlite3PagerRef(DbPage *pPg){
drhdf0b3b02001-06-23 11:36:20 +00002386 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00002387 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002388}
2389
2390/*
drh34e79ce2004-02-08 06:05:46 +00002391** Sync the journal. In other words, make sure all the pages that have
2392** been written to the journal have actually reached the surface of the
2393** disk. It is not safe to modify the original database file until after
2394** the journal has been synced. If the original database is modified before
2395** the journal is synced and a power failure occurs, the unsynced journal
2396** data would be lost and we would be unable to completely rollback the
2397** database changes. Database corruption would occur.
2398**
2399** This routine also updates the nRec field in the header of the journal.
2400** (See comments on the pager_playback() routine for additional information.)
2401** If the sync mode is FULL, two syncs will occur. First the whole journal
2402** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002403**
drh34e79ce2004-02-08 06:05:46 +00002404** For temporary databases, we do not care if we are able to rollback
2405** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00002406**
drh34e79ce2004-02-08 06:05:46 +00002407** This routine clears the needSync field of every page current held in
2408** memory.
drh50e5dad2001-09-15 00:57:28 +00002409*/
danielk197776572402004-06-25 02:38:54 +00002410static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002411 PgHdr *pPg;
2412 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002413
2414 /* Sync the journal before modifying the main database
2415 ** (assuming there is a journal and it needs to be synced.)
2416 */
danielk197776572402004-06-25 02:38:54 +00002417 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002418 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00002419 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00002420 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2421 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002422#ifndef NDEBUG
2423 {
drh34e79ce2004-02-08 06:05:46 +00002424 /* Make sure the pPager->nRec counter we are keeping agrees
2425 ** with the nRec computed from the size of the journal file.
2426 */
drheb206252004-10-01 02:00:31 +00002427 i64 jSz;
drh054889e2005-11-30 03:20:31 +00002428 rc = sqlite3OsFileSize(pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002429 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002430 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002431 }
2432#endif
drhae2b40c2004-06-09 19:03:54 +00002433 {
danielk197762079062007-08-15 17:08:46 +00002434 i64 jrnlOff;
2435
danielk197776572402004-06-25 02:38:54 +00002436 /* Write the nRec value into the journal file header. If in
2437 ** full-synchronous mode, sync the journal first. This ensures that
2438 ** all data has really hit the disk before nRec is updated to mark
2439 ** it as a candidate for rollback.
2440 */
drhd8d66e82003-02-12 02:10:15 +00002441 if( pPager->fullSync ){
drh4f0c5872007-03-26 22:05:01 +00002442 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002443 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002444 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002445 if( rc!=0 ) return rc;
2446 }
danielk197713adf8a2004-06-03 16:08:41 +00002447
danielk197762079062007-08-15 17:08:46 +00002448 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2449 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2450 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002451 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002452 }
drh4f0c5872007-03-26 22:05:01 +00002453 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drh126afe62007-05-04 12:01:02 +00002454 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002455 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2456 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2457 );
drhfa86c412002-02-02 15:01:15 +00002458 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00002459 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002460 }
drh50e5dad2001-09-15 00:57:28 +00002461 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002462
2463 /* Erase the needSync flag from every page.
2464 */
2465 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2466 pPg->needSync = 0;
2467 }
2468 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002469 }
drh03eb96a2002-11-10 23:32:56 +00002470
drh341eae82003-01-21 02:39:36 +00002471#ifndef NDEBUG
2472 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2473 ** flag must also be clear for all pages. Verify that this
2474 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002475 */
drh341eae82003-01-21 02:39:36 +00002476 else{
2477 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2478 assert( pPg->needSync==0 );
2479 }
2480 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002481 }
drh341eae82003-01-21 02:39:36 +00002482#endif
drhdb48ee02003-01-16 13:42:43 +00002483
drh81a20f22001-10-12 17:30:04 +00002484 return rc;
drh50e5dad2001-09-15 00:57:28 +00002485}
2486
2487/*
drhdc3e10b2006-06-15 14:31:06 +00002488** Merge two lists of pages connected by pDirty and in pgno order.
2489** Do not both fixing the pPrevDirty pointers.
2490*/
2491static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2492 PgHdr result, *pTail;
2493 pTail = &result;
2494 while( pA && pB ){
2495 if( pA->pgno<pB->pgno ){
2496 pTail->pDirty = pA;
2497 pTail = pA;
2498 pA = pA->pDirty;
2499 }else{
2500 pTail->pDirty = pB;
2501 pTail = pB;
2502 pB = pB->pDirty;
2503 }
2504 }
2505 if( pA ){
2506 pTail->pDirty = pA;
2507 }else if( pB ){
2508 pTail->pDirty = pB;
2509 }else{
2510 pTail->pDirty = 0;
2511 }
2512 return result.pDirty;
2513}
2514
2515/*
2516** Sort the list of pages in accending order by pgno. Pages are
2517** connected by pDirty pointers. The pPrevDirty pointers are
2518** corrupted by this sort.
2519*/
danielk197724168722007-04-02 05:07:47 +00002520#define N_SORT_BUCKET_ALLOC 25
2521#define N_SORT_BUCKET 25
2522#ifdef SQLITE_TEST
2523 int sqlite3_pager_n_sort_bucket = 0;
2524 #undef N_SORT_BUCKET
2525 #define N_SORT_BUCKET \
2526 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2527#endif
drhdc3e10b2006-06-15 14:31:06 +00002528static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002529 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002530 int i;
2531 memset(a, 0, sizeof(a));
2532 while( pIn ){
2533 p = pIn;
2534 pIn = p->pDirty;
2535 p->pDirty = 0;
2536 for(i=0; i<N_SORT_BUCKET-1; i++){
2537 if( a[i]==0 ){
2538 a[i] = p;
2539 break;
2540 }else{
2541 p = merge_pagelist(a[i], p);
2542 a[i] = 0;
2543 }
2544 }
2545 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002546 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2547 ** elements in the input list. This is possible, but impractical.
2548 ** Testing this line is the point of global variable
2549 ** sqlite3_pager_n_sort_bucket.
2550 */
drhdc3e10b2006-06-15 14:31:06 +00002551 a[i] = merge_pagelist(a[i], p);
2552 }
2553 }
2554 p = a[0];
2555 for(i=1; i<N_SORT_BUCKET; i++){
2556 p = merge_pagelist(p, a[i]);
2557 }
2558 return p;
2559}
2560
2561/*
drh2554f8b2003-01-22 01:26:44 +00002562** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2563** every one of those pages out to the database file and mark them all
2564** as clean.
2565*/
2566static int pager_write_pagelist(PgHdr *pList){
2567 Pager *pPager;
2568 int rc;
2569
2570 if( pList==0 ) return SQLITE_OK;
2571 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002572
2573 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2574 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002575 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002576 **
drha6abd042004-06-09 17:37:22 +00002577 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2578 ** through an intermediate state PENDING. A PENDING lock prevents new
2579 ** readers from attaching to the database but is unsufficient for us to
2580 ** write. The idea of a PENDING lock is to prevent new readers from
2581 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002582 **
drha6abd042004-06-09 17:37:22 +00002583 ** While the pager is in the RESERVED state, the original database file
2584 ** is unchanged and we can rollback without having to playback the
2585 ** journal into the original database file. Once we transition to
2586 ** EXCLUSIVE, it means the database file has been changed and any rollback
2587 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002588 */
drh684917c2004-10-05 02:41:42 +00002589 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002590 if( rc!=SQLITE_OK ){
2591 return rc;
2592 }
2593
drhdc3e10b2006-06-15 14:31:06 +00002594 pList = sort_pagelist(pList);
drh2554f8b2003-01-22 01:26:44 +00002595 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002596
2597 /* If the file has not yet been opened, open it now. */
2598 if( !pPager->fd->pMethods ){
2599 assert(pPager->tempFile);
2600 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename);
2601 if( rc ) return rc;
2602 }
2603
drh2554f8b2003-01-22 01:26:44 +00002604 assert( pList->dirty );
danielk1977687566d2004-11-02 12:56:41 +00002605 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002606 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002607 ** make the file smaller (presumably by auto-vacuum code). Do not write
2608 ** any such pages to the file.
2609 */
2610 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00002611 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00002612 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00002613 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2614 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002615 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002616 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002617 PAGER_INCR(sqlite3_pager_writedb_count);
2618 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002619 if( pList->pgno==1 ){
2620 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2621 }
danielk1977687566d2004-11-02 12:56:41 +00002622 }
2623#ifndef NDEBUG
2624 else{
drh4f0c5872007-03-26 22:05:01 +00002625 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002626 }
2627#endif
drh2554f8b2003-01-22 01:26:44 +00002628 if( rc ) return rc;
2629 pList->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002630#ifdef SQLITE_CHECK_PAGES
2631 pList->pageHash = pager_pagehash(pList);
2632#endif
drh2554f8b2003-01-22 01:26:44 +00002633 pList = pList->pDirty;
2634 }
2635 return SQLITE_OK;
2636}
2637
2638/*
2639** Collect every dirty page into a dirty list and
2640** return a pointer to the head of that list. All pages are
2641** collected even if they are still in use.
2642*/
2643static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh605ad8f2006-05-03 23:34:05 +00002644 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00002645}
2646
2647/*
drh165ffe92005-03-15 17:09:30 +00002648** Return TRUE if there is a hot journal on the given pager.
2649** A hot journal is one that needs to be played back.
2650**
2651** If the current size of the database file is 0 but a journal file
2652** exists, that is probably an old journal left over from a prior
2653** database with the same name. Just delete the journal.
2654*/
2655static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00002656 sqlite3_vfs *pVfs = pPager->pVfs;
drh165ffe92005-03-15 17:09:30 +00002657 if( !pPager->useJournal ) return 0;
danielk1977b4b47412007-08-17 15:53:36 +00002658 if( !sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS) ){
drhbb5f18d2007-04-06 18:23:17 +00002659 return 0;
2660 }
2661 if( sqlite3OsCheckReservedLock(pPager->fd) ){
2662 return 0;
2663 }
danielk19773b8a05f2007-03-19 17:44:26 +00002664 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00002665 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00002666 return 0;
2667 }else{
2668 return 1;
2669 }
2670}
2671
danielk19775591df52005-12-20 09:19:37 +00002672/*
danielk1977aef0bf62005-12-30 16:28:01 +00002673** Try to find a page in the cache that can be recycled.
2674**
2675** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00002676** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00002677*/
danielk197713f72992005-12-18 08:51:22 +00002678static int pager_recycle(Pager *pPager, int syncOk, PgHdr **ppPg){
2679 PgHdr *pPg;
2680 *ppPg = 0;
2681
danielk1977c551edc2007-04-05 13:12:13 +00002682 assert(!MEMDB);
2683
danielk197713f72992005-12-18 08:51:22 +00002684 /* Find a page to recycle. Try to locate a page that does not
2685 ** require us to do an fsync() on the journal.
2686 */
2687 pPg = pPager->pFirstSynced;
2688
2689 /* If we could not find a page that does not require an fsync()
2690 ** on the journal file then fsync the journal file. This is a
2691 ** very slow operation, so we work hard to avoid it. But sometimes
2692 ** it can't be helped.
2693 */
drh8940f4e2007-08-11 00:26:20 +00002694 if( pPg==0 && pPager->pFirst && syncOk && !MEMDB){
danielk197713f72992005-12-18 08:51:22 +00002695 int rc = syncJournal(pPager);
2696 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002697 return rc;
danielk197713f72992005-12-18 08:51:22 +00002698 }
2699 if( pPager->fullSync ){
2700 /* If in full-sync mode, write a new journal header into the
2701 ** journal file. This is done to avoid ever modifying a journal
2702 ** header that is involved in the rollback of pages that have
2703 ** already been written to the database (in case the header is
2704 ** trashed when the nRec field is updated).
2705 */
2706 pPager->nRec = 0;
2707 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00002708 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00002709 rc = writeJournalHdr(pPager);
2710 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002711 return rc;
danielk197713f72992005-12-18 08:51:22 +00002712 }
2713 }
2714 pPg = pPager->pFirst;
2715 }
2716 if( pPg==0 ){
2717 return SQLITE_OK;
2718 }
2719
2720 assert( pPg->nRef==0 );
2721
2722 /* Write the page to the database file if it is dirty.
2723 */
2724 if( pPg->dirty ){
2725 int rc;
2726 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00002727 makeClean(pPg);
2728 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00002729 pPg->pDirty = 0;
2730 rc = pager_write_pagelist( pPg );
2731 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002732 return rc;
danielk197713f72992005-12-18 08:51:22 +00002733 }
2734 }
2735 assert( pPg->dirty==0 );
2736
2737 /* If the page we are recycling is marked as alwaysRollback, then
2738 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00002739 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00002740 ** It is necessary to do this because the page marked alwaysRollback
2741 ** might be reloaded at a later time but at that point we won't remember
2742 ** that is was marked alwaysRollback. This means that all pages must
2743 ** be marked as alwaysRollback from here on out.
2744 */
2745 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00002746 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00002747 pPager->alwaysRollback = 1;
2748 }
2749
2750 /* Unlink the old page from the free list and the hash table
2751 */
2752 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00002753 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00002754
2755 *ppPg = pPg;
2756 return SQLITE_OK;
2757}
2758
2759/*
2760** This function is called to free superfluous dynamically allocated memory
2761** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00002762** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00002763**
2764** nReq is the number of bytes of memory required. Once this much has
danielk19770190d1d2005-12-19 14:18:11 +00002765** been released, the function returns. A negative value for nReq means
2766** free as much memory as possible. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00002767** of bytes of memory released.
2768*/
drh87cc3b32007-05-08 21:45:27 +00002769#if defined(SQLITE_ENABLE_MEMORY_MANAGEMENT) && !defined(SQLITE_OMIT_DISKIO)
danielk19773b8a05f2007-03-19 17:44:26 +00002770int sqlite3PagerReleaseMemory(int nReq){
drh6f7adc82006-01-11 21:41:20 +00002771 const ThreadData *pTsdro = sqlite3ThreadDataReadOnly();
danielk197713f72992005-12-18 08:51:22 +00002772 int nReleased = 0;
2773 int i;
2774
drh29c636b2006-01-09 23:40:25 +00002775 /* If the the global mutex is held, this subroutine becomes a
2776 ** o-op; zero bytes of memory are freed. This is because
2777 ** some of the code invoked by this function may also
2778 ** try to obtain the mutex, resulting in a deadlock.
danielk1977441b09a2006-01-05 13:48:29 +00002779 */
danielk1977b4b47412007-08-17 15:53:36 +00002780#if 0
drh757b04e2006-01-18 17:25:45 +00002781 if( sqlite3OsInMutex(0) ){
danielk1977441b09a2006-01-05 13:48:29 +00002782 return 0;
2783 }
danielk1977b4b47412007-08-17 15:53:36 +00002784#endif
danielk1977441b09a2006-01-05 13:48:29 +00002785
danielk197713f72992005-12-18 08:51:22 +00002786 /* Outermost loop runs for at most two iterations. First iteration we
2787 ** try to find memory that can be released without calling fsync(). Second
2788 ** iteration (which only runs if the first failed to free nReq bytes of
2789 ** memory) is permitted to call fsync(). This is of course much more
2790 ** expensive.
2791 */
drh29c636b2006-01-09 23:40:25 +00002792 for(i=0; i<=1; i++){
danielk197713f72992005-12-18 08:51:22 +00002793
2794 /* Loop through all the SQLite pagers opened by the current thread. */
danielk197738ec0cb2007-04-05 14:29:42 +00002795 Pager *pPager = pTsdro->pPager;
2796 for( ; pPager && (nReq<0 || nReleased<nReq); pPager=pPager->pNext){
danielk197713f72992005-12-18 08:51:22 +00002797 PgHdr *pPg;
2798 int rc;
2799
danielk197738ec0cb2007-04-05 14:29:42 +00002800 if( MEMDB ){
danielk1977c551edc2007-04-05 13:12:13 +00002801 continue;
2802 }
danielk1977c551edc2007-04-05 13:12:13 +00002803
danielk197713f72992005-12-18 08:51:22 +00002804 /* For each pager, try to free as many pages as possible (without
2805 ** calling fsync() if this is the first iteration of the outermost
2806 ** loop).
2807 */
danielk197738ec0cb2007-04-05 14:29:42 +00002808 while( SQLITE_OK==(rc = pager_recycle(pPager, i, &pPg)) && pPg) {
danielk1977aef0bf62005-12-30 16:28:01 +00002809 /* We've found a page to free. At this point the page has been
danielk197713f72992005-12-18 08:51:22 +00002810 ** removed from the page hash-table, free-list and synced-list
danielk1977aef0bf62005-12-30 16:28:01 +00002811 ** (pFirstSynced). It is still in the all pages (pAll) list.
danielk197713f72992005-12-18 08:51:22 +00002812 ** Remove it from this list before freeing.
2813 **
2814 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
2815 ** probably is though.
2816 */
2817 PgHdr *pTmp;
danielk19770190d1d2005-12-19 14:18:11 +00002818 assert( pPg );
danielk197738ec0cb2007-04-05 14:29:42 +00002819 if( pPg==pPager->pAll ){
2820 pPager->pAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00002821 }else{
danielk197738ec0cb2007-04-05 14:29:42 +00002822 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
danielk197713f72992005-12-18 08:51:22 +00002823 pTmp->pNextAll = pPg->pNextAll;
2824 }
danielk19771e536952007-08-16 10:09:01 +00002825#if 0
danielk197713f72992005-12-18 08:51:22 +00002826 nReleased += sqliteAllocSize(pPg);
danielk19771e536952007-08-16 10:09:01 +00002827#else
2828 nReleased += (
2829 sizeof(*pPg) + pPager->pageSize
2830 + sizeof(u32) + pPager->nExtra
2831 + MEMDB*sizeof(PgHistory)
2832 );
2833#endif
drh34f56212007-08-10 23:56:35 +00002834 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
drh538f5702007-04-13 02:14:30 +00002835 PAGER_INCR(sqlite3_pager_pgfree_count);
drh17435752007-08-16 04:30:38 +00002836 sqlite3_free(pPg);
danielk197713f72992005-12-18 08:51:22 +00002837 }
2838
2839 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002840 /* An error occured whilst writing to the database file or
2841 ** journal in pager_recycle(). The error is not returned to the
danielk1977efaaf572006-01-16 11:29:19 +00002842 ** caller of this function. Instead, set the Pager.errCode variable.
danielk1977aef0bf62005-12-30 16:28:01 +00002843 ** The error will be returned to the user (or users, in the case
2844 ** of a shared pager cache) of the pager for which the error occured.
danielk197713f72992005-12-18 08:51:22 +00002845 */
drh34f56212007-08-10 23:56:35 +00002846 assert(
2847 (rc&0xff)==SQLITE_IOERR ||
2848 rc==SQLITE_FULL ||
2849 rc==SQLITE_BUSY
2850 );
danielk197738ec0cb2007-04-05 14:29:42 +00002851 assert( pPager->state>=PAGER_RESERVED );
2852 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00002853 }
2854 }
2855 }
danielk1977aef0bf62005-12-30 16:28:01 +00002856
danielk197713f72992005-12-18 08:51:22 +00002857 return nReleased;
2858}
drh87cc3b32007-05-08 21:45:27 +00002859#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT && !SQLITE_OMIT_DISKIO */
danielk197713f72992005-12-18 08:51:22 +00002860
drh165ffe92005-03-15 17:09:30 +00002861/*
danielk1977e180dd92007-04-05 17:15:52 +00002862** Read the content of page pPg out of the database file.
2863*/
2864static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2865 int rc;
danielk197762079062007-08-15 17:08:46 +00002866 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002867 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002868 assert(pPager->fd->pMethods||pPager->tempFile);
2869 if( !pPager->fd->pMethods ){
2870 return SQLITE_IOERR_SHORT_READ;
2871 }
danielk197762079062007-08-15 17:08:46 +00002872 offset = (pgno-1)*(i64)pPager->pageSize;
2873 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002874 PAGER_INCR(sqlite3_pager_readdb_count);
2875 PAGER_INCR(pPager->nRead);
2876 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002877 if( pgno==1 ){
2878 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
2879 sizeof(pPager->dbFileVers));
2880 }
danielk1977e180dd92007-04-05 17:15:52 +00002881 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002882 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2883 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002884 return rc;
2885}
2886
2887
2888/*
danielk1977e277be02007-03-23 18:12:06 +00002889** This function is called to obtain the shared lock required before
2890** data may be read from the pager cache. If the shared lock has already
2891** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002892**
2893** Immediately after obtaining the shared lock (if required), this function
2894** checks for a hot-journal file. If one is found, an emergency rollback
2895** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002896*/
2897static int pagerSharedLock(Pager *pPager){
2898 int rc = SQLITE_OK;
2899
2900 if( pPager->state==PAGER_UNLOCK ){
danielk1977b4b47412007-08-17 15:53:36 +00002901 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00002902 if( !MEMDB ){
2903 assert( pPager->nRef==0 );
2904 if( !pPager->noReadlock ){
2905 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2906 if( rc!=SQLITE_OK ){
2907 return pager_error(pPager, rc);
2908 }
2909 assert( pPager->state>=SHARED_LOCK );
2910 }
2911
2912 /* If a journal file exists, and there is no RESERVED lock on the
2913 ** database file, then it either needs to be played back or deleted.
2914 */
2915 if( hasHotJournal(pPager) ){
2916 /* Get an EXCLUSIVE lock on the database file. At this point it is
2917 ** important that a RESERVED lock is not obtained on the way to the
2918 ** EXCLUSIVE lock. If it were, another process might open the
2919 ** database file, detect the RESERVED lock, and conclude that the
2920 ** database is safe to read while this process is still rolling it
2921 ** back.
2922 **
2923 ** Because the intermediate RESERVED lock is not requested, the
2924 ** second process will get to this point in the code and fail to
2925 ** obtain it's own EXCLUSIVE lock on the database file.
2926 */
2927 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
2928 if( rc!=SQLITE_OK ){
2929 pager_unlock(pPager);
2930 return pager_error(pPager, rc);
2931 }
2932 pPager->state = PAGER_EXCLUSIVE;
2933
2934 /* Open the journal for reading only. Return SQLITE_BUSY if
2935 ** we are unable to open the journal file.
2936 **
2937 ** The journal file does not need to be locked itself. The
2938 ** journal file is never open unless the main database file holds
2939 ** a write lock, so there is never any chance of two or more
2940 ** processes opening the journal at the same time.
danielk1977979f38e2007-03-27 16:19:51 +00002941 **
drhfd131da2007-08-07 17:13:03 +00002942 ** Open the journal for read/write access. This is because in
2943 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00002944 ** possibly used for a transaction later on. On some systems, the
2945 ** OsTruncate() call used in exclusive-access mode also requires
2946 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00002947 */
danielk1977979f38e2007-03-27 16:19:51 +00002948 rc = SQLITE_BUSY;
danielk1977b4b47412007-08-17 15:53:36 +00002949 if( sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS) ){
2950 int fout = 0;
danielk1977fee2d252007-08-18 10:59:19 +00002951 int flags = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
danielk19777152de82007-03-29 17:28:14 +00002952 assert( !pPager->tempFile );
danielk1977b4b47412007-08-17 15:53:36 +00002953 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, &fout);
2954 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
2955 if( fout&SQLITE_OPEN_READONLY ){
danielk1977979f38e2007-03-27 16:19:51 +00002956 rc = SQLITE_BUSY;
danielk1977b4b47412007-08-17 15:53:36 +00002957 sqlite3OsClose(pPager->jfd);
danielk1977979f38e2007-03-27 16:19:51 +00002958 }
2959 }
danielk1977e277be02007-03-23 18:12:06 +00002960 if( rc!=SQLITE_OK ){
2961 pager_unlock(pPager);
2962 return SQLITE_BUSY;
2963 }
2964 pPager->journalOpen = 1;
2965 pPager->journalStarted = 0;
2966 pPager->journalOff = 0;
2967 pPager->setMaster = 0;
2968 pPager->journalHdr = 0;
2969
2970 /* Playback and delete the journal. Drop the database write
2971 ** lock and reacquire the read lock.
2972 */
2973 rc = pager_playback(pPager, 1);
2974 if( rc!=SQLITE_OK ){
2975 return pager_error(pPager, rc);
2976 }
danielk1977c5859712007-03-26 12:26:27 +00002977 assert(pPager->state==PAGER_SHARED ||
2978 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2979 );
danielk1977e277be02007-03-23 18:12:06 +00002980 }
2981
2982 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00002983 /* The shared-lock has just been acquired on the database file
2984 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00002985 ** read or write transaction). Check to see if the database
2986 ** has been modified. If the database has changed, flush the
2987 ** cache.
2988 **
2989 ** Database changes is detected by looking at 15 bytes beginning
2990 ** at offset 24 into the file. The first 4 of these 16 bytes are
2991 ** a 32-bit counter that is incremented with each change. The
2992 ** other bytes change randomly with each file change when
2993 ** a codec is in use.
2994 **
2995 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00002996 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00002997 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00002998 */
drh86a88112007-04-16 15:02:19 +00002999 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003000 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003001
danielk1977e180dd92007-04-05 17:15:52 +00003002 if( pPager->errCode ){
3003 return pPager->errCode;
danielk1977e277be02007-03-23 18:12:06 +00003004 }
3005
danielk1977e180dd92007-04-05 17:15:52 +00003006 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003007 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003008 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003009 if( rc!=SQLITE_OK ){
3010 return rc;
3011 }
drh86a88112007-04-16 15:02:19 +00003012 }else{
3013 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003014 }
3015
drh86a88112007-04-16 15:02:19 +00003016 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003017 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003018 }
3019 }
3020 }
danielk1977c5859712007-03-26 12:26:27 +00003021 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3022 if( pPager->state==PAGER_UNLOCK ){
3023 pPager->state = PAGER_SHARED;
3024 }
danielk1977e277be02007-03-23 18:12:06 +00003025 }
3026
3027 return rc;
3028}
3029
3030/*
danielk1977e180dd92007-04-05 17:15:52 +00003031** Allocate a PgHdr object. Either create a new one or reuse
3032** an existing one that is not otherwise in use.
3033**
3034** A new PgHdr structure is created if any of the following are
3035** true:
3036**
3037** (1) We have not exceeded our maximum allocated cache size
3038** as set by the "PRAGMA cache_size" command.
3039**
3040** (2) There are no unused PgHdr objects available at this time.
3041**
3042** (3) This is an in-memory database.
3043**
3044** (4) There are no PgHdr objects that do not require a journal
3045** file sync and a sync of the journal file is currently
3046** prohibited.
3047**
3048** Otherwise, reuse an existing PgHdr. In other words, reuse an
3049** existing PgHdr if all of the following are true:
3050**
3051** (1) We have reached or exceeded the maximum cache size
3052** allowed by "PRAGMA cache_size".
3053**
3054** (2) There is a PgHdr available with PgHdr->nRef==0
3055**
3056** (3) We are not in an in-memory database
3057**
3058** (4) Either there is an available PgHdr that does not need
3059** to be synced to disk or else disk syncing is currently
3060** allowed.
danielk197724168722007-04-02 05:07:47 +00003061*/
3062static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3063 int rc = SQLITE_OK;
3064 PgHdr *pPg;
3065
danielk1977e180dd92007-04-05 17:15:52 +00003066 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003067 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003068 if( pPager->nPage<pPager->mxPage
3069 || pPager->pFirst==0
3070 || MEMDB
3071 || (pPager->pFirstSynced==0 && pPager->doNotSync)
3072 ){
danielk197724168722007-04-02 05:07:47 +00003073 if( pPager->nPage>=pPager->nHash ){
3074 pager_resize_hash_table(pPager,
3075 pPager->nHash<256 ? 256 : pPager->nHash*2);
3076 if( pPager->nHash==0 ){
3077 rc = SQLITE_NOMEM;
3078 goto pager_allocate_out;
3079 }
3080 }
drh17435752007-08-16 04:30:38 +00003081 pPg = sqlite3_malloc( sizeof(*pPg) + pPager->pageSize
danielk197724168722007-04-02 05:07:47 +00003082 + sizeof(u32) + pPager->nExtra
3083 + MEMDB*sizeof(PgHistory) );
3084 if( pPg==0 ){
3085 rc = SQLITE_NOMEM;
3086 goto pager_allocate_out;
3087 }
3088 memset(pPg, 0, sizeof(*pPg));
3089 if( MEMDB ){
3090 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
3091 }
3092 pPg->pPager = pPager;
3093 pPg->pNextAll = pPager->pAll;
3094 pPager->pAll = pPg;
3095 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003096 }else{
3097 /* Recycle an existing page with a zero ref-count. */
3098 rc = pager_recycle(pPager, 1, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003099 if( rc==SQLITE_BUSY ){
3100 rc = SQLITE_IOERR_BLOCKED;
3101 }
danielk197724168722007-04-02 05:07:47 +00003102 if( rc!=SQLITE_OK ){
3103 goto pager_allocate_out;
3104 }
3105 assert( pPager->state>=SHARED_LOCK );
3106 assert(pPg);
3107 }
3108 *ppPg = pPg;
3109
3110pager_allocate_out:
3111 return rc;
3112}
3113
3114/*
drhd33d5a82007-04-26 12:11:28 +00003115** Make sure we have the content for a page. If the page was
3116** previously acquired with noContent==1, then the content was
3117** just initialized to zeros instead of being read from disk.
3118** But now we need the real data off of disk. So make sure we
3119** have it. Read it in if we do not have it already.
3120*/
3121static int pager_get_content(PgHdr *pPg){
3122 if( pPg->needRead ){
3123 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3124 if( rc==SQLITE_OK ){
3125 pPg->needRead = 0;
3126 }else{
3127 return rc;
3128 }
3129 }
3130 return SQLITE_OK;
3131}
3132
3133/*
drhd9b02572001-04-15 00:37:09 +00003134** Acquire a page.
3135**
drh58a11682001-11-10 13:51:08 +00003136** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003137** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003138**
drhd33d5a82007-04-26 12:11:28 +00003139** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003140** file is smaller than the requested page, then no actual disk
3141** read occurs and the memory image of the page is initialized to
3142** all zeros. The extra data appended to a page is always initialized
3143** to zeros the first time a page is loaded into memory.
3144**
drhd9b02572001-04-15 00:37:09 +00003145** The acquisition might fail for several reasons. In all cases,
3146** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003147**
drhd33d5a82007-04-26 12:11:28 +00003148** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003149** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003150** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003151** just returns 0. This routine acquires a read-lock the first time it
3152** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003153** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003154** or journal files.
drh0787db62007-03-04 13:15:27 +00003155**
drh538f5702007-04-13 02:14:30 +00003156** If noContent is false, the page contents are actually read from disk.
3157** If noContent is true, it means that we do not care about the contents
3158** of the page at this time, so do not do a disk read. Just fill in the
3159** page content with zeros. But mark the fact that we have not read the
3160** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003161** sqlite3PagerWrite() is called on this page or if this routine is
3162** called again with noContent==0, that means that the content is needed
3163** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003164*/
drh538f5702007-04-13 02:14:30 +00003165int sqlite3PagerAcquire(
3166 Pager *pPager, /* The pager open on the database file */
3167 Pgno pgno, /* Page number to fetch */
3168 DbPage **ppPage, /* Write a pointer to the page here */
3169 int noContent /* Do not bother reading content from disk if true */
3170){
drhed7c8552001-04-11 14:29:21 +00003171 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003172 int rc;
drhed7c8552001-04-11 14:29:21 +00003173
danielk1977e277be02007-03-23 18:12:06 +00003174 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3175
danielk197726836652005-01-17 01:33:13 +00003176 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3177 ** number greater than this, or zero, is requested.
3178 */
drh267cb322005-09-16 17:16:52 +00003179 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003180 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003181 }
3182
drhd9b02572001-04-15 00:37:09 +00003183 /* Make sure we have not hit any critical errors.
3184 */
drh836faa42003-01-11 13:30:57 +00003185 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003186 *ppPage = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003187 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3188 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003189 }
3190
danielk197713adf8a2004-06-03 16:08:41 +00003191 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003192 ** on the database file. pagerSharedLock() is a no-op if
3193 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003194 */
danielk1977e277be02007-03-23 18:12:06 +00003195 rc = pagerSharedLock(pPager);
3196 if( rc!=SQLITE_OK ){
3197 return rc;
drhed7c8552001-04-11 14:29:21 +00003198 }
danielk1977e277be02007-03-23 18:12:06 +00003199 assert( pPager->state!=PAGER_UNLOCK );
3200
3201 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003202 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003203 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003204 int nMax;
drhed7c8552001-04-11 14:29:21 +00003205 int h;
drh538f5702007-04-13 02:14:30 +00003206 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003207 rc = pagerAllocatePage(pPager, &pPg);
3208 if( rc!=SQLITE_OK ){
3209 return rc;
drhed7c8552001-04-11 14:29:21 +00003210 }
danielk197724168722007-04-02 05:07:47 +00003211
drhed7c8552001-04-11 14:29:21 +00003212 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003213 assert( !MEMDB || pgno>pPager->stmtSize );
drh1ab43002002-01-14 09:28:19 +00003214 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19771e536952007-08-16 10:09:01 +00003215#if 0
danielk19774adee202004-05-08 08:23:19 +00003216 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
danielk19771e536952007-08-16 10:09:01 +00003217#endif
drhdb48ee02003-01-16 13:42:43 +00003218 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00003219 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00003220 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00003221 }else{
3222 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00003223 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00003224 }
danielk1977f35843b2007-04-07 15:03:17 +00003225
drh605ad8f2006-05-03 23:34:05 +00003226 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003227 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00003228 REFINFO(pPg);
danielk197775bab7d2006-01-23 13:09:45 +00003229
drhd9b02572001-04-15 00:37:09 +00003230 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003231 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003232 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003233 }
danielk1977979f38e2007-03-27 16:19:51 +00003234 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003235 if( pPager->errCode ){
danielk19773b8a05f2007-03-19 17:44:26 +00003236 sqlite3PagerUnref(pPg);
danielk1977efaaf572006-01-16 11:29:19 +00003237 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00003238 return rc;
3239 }
danielk197775bab7d2006-01-23 13:09:45 +00003240
3241 /* Populate the page with data, either by reading from the database
3242 ** file, or by setting the entire page to zero.
3243 */
drhd215acf2007-04-13 04:01:58 +00003244 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003245 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003246 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003247 return SQLITE_FULL;
3248 }
drh90f5ecb2004-07-22 01:19:35 +00003249 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003250 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003251 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003252 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003253 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003254 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3255 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003256 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003257 return rc;
drh81a20f22001-10-12 17:30:04 +00003258 }
danielk1977b4626a32007-04-28 15:47:43 +00003259 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003260 }
danielk197775bab7d2006-01-23 13:09:45 +00003261
3262 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003263 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003264 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003265 pPg->pNextHash = pPager->aHash[h];
3266 pPager->aHash[h] = pPg;
3267 if( pPg->pNextHash ){
3268 assert( pPg->pNextHash->pPrevHash==0 );
3269 pPg->pNextHash->pPrevHash = pPg;
3270 }
3271
danielk19773c407372005-02-15 02:54:14 +00003272#ifdef SQLITE_CHECK_PAGES
3273 pPg->pageHash = pager_pagehash(pPg);
3274#endif
drhed7c8552001-04-11 14:29:21 +00003275 }else{
drhd9b02572001-04-15 00:37:09 +00003276 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003277 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003278 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003279 if( !noContent ){
3280 rc = pager_get_content(pPg);
3281 if( rc ){
3282 return rc;
3283 }
3284 }
drhdf0b3b02001-06-23 11:36:20 +00003285 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003286 }
danielk19773b8a05f2007-03-19 17:44:26 +00003287 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003288 return SQLITE_OK;
3289}
3290
3291/*
drh7e3b0a02001-04-28 16:52:40 +00003292** Acquire a page if it is already in the in-memory cache. Do
3293** not read the page from disk. Return a pointer to the page,
3294** or 0 if the page is not in cache.
3295**
danielk19773b8a05f2007-03-19 17:44:26 +00003296** See also sqlite3PagerGet(). The difference between this routine
3297** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003298** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003299** returns NULL if the page is not in cache or if a disk I/O error
3300** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003301*/
danielk19773b8a05f2007-03-19 17:44:26 +00003302DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00003303 PgHdr *pPg;
3304
drh836faa42003-01-11 13:30:57 +00003305 assert( pPager!=0 );
3306 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003307
3308 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003309 assert( !pPager->pAll || pPager->exclusiveMode );
danielk1977e277be02007-03-23 18:12:06 +00003310 return 0;
3311 }
danielk1977334cdb62007-03-26 08:05:12 +00003312 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drh7e3b0a02001-04-28 16:52:40 +00003313 return 0;
3314 }
drh7e3b0a02001-04-28 16:52:40 +00003315 pPg = pager_lookup(pPager, pgno);
3316 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00003317 page_ref(pPg);
danielk19773b8a05f2007-03-19 17:44:26 +00003318 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003319}
3320
3321/*
drhed7c8552001-04-11 14:29:21 +00003322** Release a page.
3323**
3324** If the number of references to the page drop to zero, then the
3325** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003326** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003327** removed.
3328*/
danielk19773b8a05f2007-03-19 17:44:26 +00003329int sqlite3PagerUnref(DbPage *pPg){
drhd9b02572001-04-15 00:37:09 +00003330
3331 /* Decrement the reference count for this page
3332 */
drhed7c8552001-04-11 14:29:21 +00003333 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00003334 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00003335 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00003336
danielk19773c407372005-02-15 02:54:14 +00003337 CHECK_PAGE(pPg);
3338
drh72f82862001-05-24 21:06:34 +00003339 /* When the number of references to a page reach 0, call the
3340 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003341 */
drhed7c8552001-04-11 14:29:21 +00003342 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00003343 Pager *pPager;
3344 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003345 pPg->pNextFree = 0;
3346 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00003347 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00003348 if( pPg->pPrevFree ){
3349 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00003350 }else{
3351 pPager->pFirst = pPg;
3352 }
drh341eae82003-01-21 02:39:36 +00003353 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
3354 pPager->pFirstSynced = pPg;
3355 }
drh72f82862001-05-24 21:06:34 +00003356 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003357 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003358 }
drhd9b02572001-04-15 00:37:09 +00003359
3360 /* When all pages reach the freelist, drop the read lock from
3361 ** the database file.
3362 */
3363 pPager->nRef--;
3364 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003365 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003366 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003367 }
drhed7c8552001-04-11 14:29:21 +00003368 }
drhd9b02572001-04-15 00:37:09 +00003369 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003370}
3371
3372/*
drha6abd042004-06-09 17:37:22 +00003373** Create a journal file for pPager. There should already be a RESERVED
3374** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003375**
3376** Return SQLITE_OK if everything. Return an error code and release the
3377** write lock if anything goes wrong.
3378*/
3379static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003380 sqlite3_vfs *pVfs = pPager->pVfs;
3381 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3382
drhda47d772002-12-02 04:25:19 +00003383 int rc;
drhb7f91642004-10-31 02:22:47 +00003384 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003385 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003386 assert( pPager->journalOpen==0 );
3387 assert( pPager->useJournal );
drh88b01a12005-03-28 18:04:27 +00003388 assert( pPager->aInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003389 sqlite3PagerPagecount(pPager);
drh17435752007-08-16 04:30:38 +00003390 pPager->aInJournal = sqlite3MallocZero( pPager->dbSize/8 + 1 );
drhda47d772002-12-02 04:25:19 +00003391 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003392 rc = SQLITE_NOMEM;
3393 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003394 }
danielk1977b4b47412007-08-17 15:53:36 +00003395
3396 if( pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +00003397 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3398 }else{
3399 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
danielk1977b4b47412007-08-17 15:53:36 +00003400 }
3401 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
3402 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk197776572402004-06-25 02:38:54 +00003403 pPager->journalOff = 0;
3404 pPager->setMaster = 0;
3405 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00003406 if( rc!=SQLITE_OK ){
drh600e46a2007-03-28 01:59:33 +00003407 if( rc==SQLITE_NOMEM ){
danielk1977fee2d252007-08-18 10:59:19 +00003408 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh600e46a2007-03-28 01:59:33 +00003409 }
drh9c105bb2004-10-02 20:38:28 +00003410 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003411 }
3412 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003413 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003414 pPager->needSync = 0;
3415 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003416 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003417 if( pPager->errCode ){
3418 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003419 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003420 }
drhda47d772002-12-02 04:25:19 +00003421 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003422
danielk197776572402004-06-25 02:38:54 +00003423 rc = writeJournalHdr(pPager);
3424
drhac69b052004-05-12 13:30:07 +00003425 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003426 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003427 }
danielk1977261919c2005-12-06 12:52:59 +00003428 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003429 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003430 if( rc==SQLITE_OK ){
3431 rc = SQLITE_FULL;
3432 }
3433 }
drh9c105bb2004-10-02 20:38:28 +00003434 return rc;
3435
3436failed_to_open_journal:
drh17435752007-08-16 04:30:38 +00003437 sqlite3_free(pPager->aInJournal);
drh9c105bb2004-10-02 20:38:28 +00003438 pPager->aInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003439 return rc;
drhda47d772002-12-02 04:25:19 +00003440}
3441
3442/*
drh4b845d72002-03-05 12:41:19 +00003443** Acquire a write-lock on the database. The lock is removed when
3444** the any of the following happen:
3445**
drh80e35f42007-03-30 14:06:34 +00003446** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003447** * sqlite3PagerRollback() is called.
3448** * sqlite3PagerClose() is called.
3449** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003450**
danielk197713adf8a2004-06-03 16:08:41 +00003451** The first parameter to this routine is a pointer to any open page of the
3452** database file. Nothing changes about the page - it is used merely to
3453** acquire a pointer to the Pager structure and as proof that there is
3454** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003455**
danielk197713adf8a2004-06-03 16:08:41 +00003456** The second parameter indicates how much space in bytes to reserve for a
3457** master journal file-name at the start of the journal when it is created.
3458**
3459** A journal file is opened if this is not a temporary file. For temporary
3460** files, the opening of the journal file is deferred until there is an
3461** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003462**
drha6abd042004-06-09 17:37:22 +00003463** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003464**
3465** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3466** immediately instead of waiting until we try to flush the cache. The
3467** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003468*/
danielk19773b8a05f2007-03-19 17:44:26 +00003469int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003470 Pager *pPager = pPg->pPager;
3471 int rc = SQLITE_OK;
3472 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003473 assert( pPager->state!=PAGER_UNLOCK );
3474 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00003475 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00003476 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003477 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003478 pPager->origDbSize = pPager->dbSize;
3479 }else{
drh054889e2005-11-30 03:20:31 +00003480 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003481 if( rc==SQLITE_OK ){
3482 pPager->state = PAGER_RESERVED;
3483 if( exFlag ){
3484 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3485 }
3486 }
danielk19779eed5052004-06-04 10:38:30 +00003487 if( rc!=SQLITE_OK ){
3488 return rc;
drhac69b052004-05-12 13:30:07 +00003489 }
drha6abd042004-06-09 17:37:22 +00003490 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003491 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003492 if( pPager->useJournal && !pPager->tempFile ){
3493 rc = pager_open_journal(pPager);
3494 }
drh4b845d72002-03-05 12:41:19 +00003495 }
danielk1977334cdb62007-03-26 08:05:12 +00003496 }else if( pPager->journalOpen && pPager->journalOff==0 ){
3497 /* This happens when the pager was in exclusive-access mode last
3498 ** time a (read or write) transaction was successfully concluded
3499 ** by this connection. Instead of deleting the journal file it was
3500 ** kept open and truncated to 0 bytes.
3501 */
3502 assert( pPager->nRec==0 );
3503 assert( pPager->origDbSize==0 );
drh369339d2007-03-30 16:01:55 +00003504 assert( pPager->aInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00003505 sqlite3PagerPagecount(pPager);
drh17435752007-08-16 04:30:38 +00003506 pPager->aInJournal = sqlite3MallocZero( pPager->dbSize/8 + 1 );
danielk1977334cdb62007-03-26 08:05:12 +00003507 if( !pPager->aInJournal ){
3508 rc = SQLITE_NOMEM;
3509 }else{
drh369339d2007-03-30 16:01:55 +00003510 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003511 rc = writeJournalHdr(pPager);
3512 }
drh4b845d72002-03-05 12:41:19 +00003513 }
danielk1977334cdb62007-03-26 08:05:12 +00003514 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003515 return rc;
3516}
3517
3518/*
drh605ad8f2006-05-03 23:34:05 +00003519** Make a page dirty. Set its dirty flag and add it to the dirty
3520** page list.
3521*/
3522static void makeDirty(PgHdr *pPg){
3523 if( pPg->dirty==0 ){
3524 Pager *pPager = pPg->pPager;
3525 pPg->dirty = 1;
3526 pPg->pDirty = pPager->pDirty;
3527 if( pPager->pDirty ){
3528 pPager->pDirty->pPrevDirty = pPg;
3529 }
3530 pPg->pPrevDirty = 0;
3531 pPager->pDirty = pPg;
3532 }
3533}
3534
3535/*
3536** Make a page clean. Clear its dirty bit and remove it from the
3537** dirty page list.
3538*/
3539static void makeClean(PgHdr *pPg){
3540 if( pPg->dirty ){
3541 pPg->dirty = 0;
3542 if( pPg->pDirty ){
3543 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
3544 }
3545 if( pPg->pPrevDirty ){
3546 pPg->pPrevDirty->pDirty = pPg->pDirty;
3547 }else{
3548 pPg->pPager->pDirty = pPg->pDirty;
3549 }
3550 }
3551}
3552
3553
3554/*
drhed7c8552001-04-11 14:29:21 +00003555** Mark a data page as writeable. The page is written into the journal
3556** if it is not there already. This routine must be called before making
3557** changes to a page.
3558**
3559** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003560** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003561** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003562** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003563** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003564**
3565** If the journal file could not be written because the disk is full,
3566** then this routine returns SQLITE_FULL and does an immediate rollback.
3567** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003568** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003569** reset.
drhed7c8552001-04-11 14:29:21 +00003570*/
danielk19773b8a05f2007-03-19 17:44:26 +00003571static int pager_write(PgHdr *pPg){
3572 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00003573 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003574 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003575
drh6446c4d2001-12-15 14:22:18 +00003576 /* Check for errors
3577 */
danielk1977efaaf572006-01-16 11:29:19 +00003578 if( pPager->errCode ){
3579 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003580 }
drh5e00f6c2001-09-13 13:46:56 +00003581 if( pPager->readOnly ){
3582 return SQLITE_PERM;
3583 }
drh6446c4d2001-12-15 14:22:18 +00003584
danielk197776572402004-06-25 02:38:54 +00003585 assert( !pPager->setMaster );
3586
danielk19773c407372005-02-15 02:54:14 +00003587 CHECK_PAGE(pPg);
3588
drh538f5702007-04-13 02:14:30 +00003589 /* If this page was previously acquired with noContent==1, that means
3590 ** we didn't really read in the content of the page. This can happen
3591 ** (for example) when the page is being moved to the freelist. But
3592 ** now we are (perhaps) moving the page off of the freelist for
3593 ** reuse and we need to know its original content so that content
3594 ** can be stored in the rollback journal. So do the read at this
3595 ** time.
3596 */
drhd33d5a82007-04-26 12:11:28 +00003597 rc = pager_get_content(pPg);
3598 if( rc ){
3599 return rc;
drh538f5702007-04-13 02:14:30 +00003600 }
3601
drh6446c4d2001-12-15 14:22:18 +00003602 /* Mark the page as dirty. If the page has already been written
3603 ** to the journal then we can return right away.
3604 */
drh605ad8f2006-05-03 23:34:05 +00003605 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00003606 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00003607 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003608 }else{
drh6446c4d2001-12-15 14:22:18 +00003609
danielk1977a0bf2652004-11-04 14:30:04 +00003610 /* If we get this far, it means that the page needs to be
3611 ** written to the transaction journal or the ckeckpoint journal
3612 ** or both.
3613 **
3614 ** First check to see that the transaction journal exists and
3615 ** create it if it does not.
3616 */
3617 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003618 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003619 if( rc!=SQLITE_OK ){
3620 return rc;
3621 }
3622 assert( pPager->state>=PAGER_RESERVED );
3623 if( !pPager->journalOpen && pPager->useJournal ){
3624 rc = pager_open_journal(pPager);
3625 if( rc!=SQLITE_OK ) return rc;
3626 }
3627 assert( pPager->journalOpen || !pPager->useJournal );
3628 pPager->dirtyCache = 1;
3629
3630 /* The transaction journal now exists and we have a RESERVED or an
3631 ** EXCLUSIVE lock on the main database file. Write the current page to
3632 ** the transaction journal if it is not there already.
3633 */
3634 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
3635 if( (int)pPg->pgno <= pPager->origDbSize ){
3636 int szPg;
danielk1977a0bf2652004-11-04 14:30:04 +00003637 if( MEMDB ){
3638 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00003639 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003640 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00003641 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00003642 if( pHist->pOrig ){
3643 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
3644 }
3645 }else{
drhc001c582006-03-06 18:23:16 +00003646 u32 cksum, saved;
3647 char *pData2, *pEnd;
drh267cb322005-09-16 17:16:52 +00003648 /* We should never write to the journal file the page that
3649 ** contains the database locks. The following assert verifies
3650 ** that we do not. */
3651 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00003652 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00003653 cksum = pager_cksum(pPager, (u8*)pData2);
drhc001c582006-03-06 18:23:16 +00003654 pEnd = pData2 + pPager->pageSize;
3655 pData2 -= 4;
3656 saved = *(u32*)pEnd;
3657 put32bits(pEnd, cksum);
danielk1977a0bf2652004-11-04 14:30:04 +00003658 szPg = pPager->pageSize+8;
drhc001c582006-03-06 18:23:16 +00003659 put32bits(pData2, pPg->pgno);
danielk197762079062007-08-15 17:08:46 +00003660 rc = sqlite3OsWrite(pPager->jfd, pData2, szPg, pPager->journalOff);
drhb0603412007-02-28 04:47:26 +00003661 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
drh538f5702007-04-13 02:14:30 +00003662 pPager->journalOff, szPg));
3663 PAGER_INCR(sqlite3_pager_writej_count);
danielk1977a0bf2652004-11-04 14:30:04 +00003664 pPager->journalOff += szPg;
drh477731b2007-06-16 03:06:27 +00003665 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
3666 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
drhc001c582006-03-06 18:23:16 +00003667 *(u32*)pEnd = saved;
danielk197707cb5602006-01-20 10:55:05 +00003668
drhfd131da2007-08-07 17:13:03 +00003669 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00003670 ** transaction will be rolled back by the layer above.
3671 */
danielk1977a0bf2652004-11-04 14:30:04 +00003672 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00003673 return rc;
3674 }
danielk197707cb5602006-01-20 10:55:05 +00003675
danielk1977a0bf2652004-11-04 14:30:04 +00003676 pPager->nRec++;
3677 assert( pPager->aInJournal!=0 );
3678 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3679 pPg->needSync = !pPager->noSync;
3680 if( pPager->stmtInUse ){
3681 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
danielk1977a0bf2652004-11-04 14:30:04 +00003682 }
drhac69b052004-05-12 13:30:07 +00003683 }
danielk197713adf8a2004-06-03 16:08:41 +00003684 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00003685 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00003686 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003687 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00003688 }
3689 if( pPg->needSync ){
3690 pPager->needSync = 1;
3691 }
3692 pPg->inJournal = 1;
3693 }
3694
3695 /* If the statement journal is open and the page is not in it,
3696 ** then write the current page to the statement journal. Note that
3697 ** the statement journal format differs from the standard journal format
3698 ** in that it omits the checksums and the header.
3699 */
danielk1977f35843b2007-04-07 15:03:17 +00003700 if( pPager->stmtInUse
3701 && !pageInStatement(pPg)
3702 && (int)pPg->pgno<=pPager->stmtSize
3703 ){
danielk1977a0bf2652004-11-04 14:30:04 +00003704 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
3705 if( MEMDB ){
3706 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3707 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00003708 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00003709 if( pHist->pStmt ){
3710 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
3711 }
drh4f0c5872007-03-26 22:05:01 +00003712 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00003713 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00003714 }else{
danielk197762079062007-08-15 17:08:46 +00003715 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhc001c582006-03-06 18:23:16 +00003716 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7)-4;
3717 put32bits(pData2, pPg->pgno);
danielk197762079062007-08-15 17:08:46 +00003718 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize+4, offset);
drh4f0c5872007-03-26 22:05:01 +00003719 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003720 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00003721 return rc;
3722 }
danielk1977a0bf2652004-11-04 14:30:04 +00003723 pPager->stmtNRec++;
3724 assert( pPager->aInStmt!=0 );
3725 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00003726 }
drhd9b02572001-04-15 00:37:09 +00003727 }
drhfa86c412002-02-02 15:01:15 +00003728 }
3729
3730 /* Update the database size and return.
3731 */
drh1aa2d8b2007-01-03 15:34:29 +00003732 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00003733 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003734 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00003735 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003736 pPager->dbSize++;
3737 }
drh306dc212001-05-21 13:45:10 +00003738 }
drh69688d52001-04-14 16:38:23 +00003739 return rc;
drhed7c8552001-04-11 14:29:21 +00003740}
3741
3742/*
danielk19774099f6e2007-03-19 11:25:20 +00003743** This function is used to mark a data-page as writable. It uses
3744** pager_write() to open a journal file (if it is not already open)
3745** and write the page *pData to the journal.
3746**
3747** The difference between this function and pager_write() is that this
3748** function also deals with the special case where 2 or more pages
3749** fit on a single disk sector. In this case all co-resident pages
3750** must have been written to the journal file before returning.
3751*/
danielk19773b8a05f2007-03-19 17:44:26 +00003752int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003753 int rc = SQLITE_OK;
3754
danielk19773b8a05f2007-03-19 17:44:26 +00003755 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003756 Pager *pPager = pPg->pPager;
3757 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3758
3759 if( !MEMDB && nPagePerSector>1 ){
3760 Pgno nPageCount; /* Total number of pages in database file */
3761 Pgno pg1; /* First page of the sector pPg is located on. */
3762 int nPage; /* Number of pages starting at pg1 to journal */
3763 int ii;
3764
3765 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3766 ** header to be written between the pages journaled by this function.
3767 */
3768 assert( pPager->doNotSync==0 );
3769 pPager->doNotSync = 1;
3770
3771 /* This trick assumes that both the page-size and sector-size are
3772 ** an integer power of 2. It sets variable pg1 to the identifier
3773 ** of the first page of the sector pPg is located on.
3774 */
3775 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3776
danielk19773b8a05f2007-03-19 17:44:26 +00003777 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00003778 if( pPg->pgno>nPageCount ){
3779 nPage = (pPg->pgno - pg1)+1;
3780 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3781 nPage = nPageCount+1-pg1;
3782 }else{
3783 nPage = nPagePerSector;
3784 }
3785 assert(nPage>0);
3786 assert(pg1<=pPg->pgno);
3787 assert((pg1+nPage)>pPg->pgno);
3788
3789 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3790 Pgno pg = pg1+ii;
3791 if( !pPager->aInJournal || pg==pPg->pgno ||
3792 pg>pPager->origDbSize || !(pPager->aInJournal[pg/8]&(1<<(pg&7)))
3793 ) {
3794 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003795 PgHdr *pPage;
3796 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003797 if( rc==SQLITE_OK ){
3798 rc = pager_write(pPage);
danielk19773b8a05f2007-03-19 17:44:26 +00003799 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003800 }
3801 }
3802 }
3803 }
3804
3805 assert( pPager->doNotSync==1 );
3806 pPager->doNotSync = 0;
3807 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003808 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003809 }
3810 return rc;
3811}
3812
3813/*
drhaacc5432002-01-06 17:07:40 +00003814** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003815** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003816** to change the content of the page.
3817*/
danielk19777d3a6662006-01-23 16:21:05 +00003818#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003819int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00003820 return pPg->dirty;
3821}
danielk19777d3a6662006-01-23 16:21:05 +00003822#endif
drh6019e162001-07-02 17:51:45 +00003823
danielk1977b84f96f2005-01-20 11:32:23 +00003824#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00003825/*
drh001bbcb2003-03-19 03:14:00 +00003826** Replace the content of a single page with the information in the third
3827** argument.
3828*/
danielk19773b8a05f2007-03-19 17:44:26 +00003829int sqlite3PagerOverwrite(Pager *pPager, Pgno pgno, void *pData){
3830 PgHdr *pPg;
drh001bbcb2003-03-19 03:14:00 +00003831 int rc;
3832
danielk19773b8a05f2007-03-19 17:44:26 +00003833 rc = sqlite3PagerGet(pPager, pgno, &pPg);
drh001bbcb2003-03-19 03:14:00 +00003834 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003835 rc = sqlite3PagerWrite(pPg);
drh001bbcb2003-03-19 03:14:00 +00003836 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003837 memcpy(sqlite3PagerGetData(pPg), pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00003838 }
danielk19773b8a05f2007-03-19 17:44:26 +00003839 sqlite3PagerUnref(pPg);
drh001bbcb2003-03-19 03:14:00 +00003840 }
3841 return rc;
3842}
danielk1977b84f96f2005-01-20 11:32:23 +00003843#endif
drh001bbcb2003-03-19 03:14:00 +00003844
3845/*
drh30e58752002-03-02 20:41:57 +00003846** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003847** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00003848** that page might be marked as dirty.
3849**
3850** The overlying software layer calls this routine when all of the data
3851** on the given page is unused. The pager marks the page as clean so
3852** that it does not get written to disk.
3853**
3854** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003855** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003856** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003857**
3858** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003859** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003860** will thereafter be ignored. This is necessary to avoid a problem
3861** where a page with data is added to the freelist during one part of
3862** a transaction then removed from the freelist during a later part
3863** of the same transaction and reused for some other purpose. When it
3864** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003865** the sqlite3PagerDontRollback() routine is called. But because the
3866** page contains critical data, we still need to be sure it gets
3867** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003868*/
drh538f5702007-04-13 02:14:30 +00003869void sqlite3PagerDontWrite(DbPage *pDbPage){
3870 PgHdr *pPg = pDbPage;
3871 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00003872
drhb7f91642004-10-31 02:22:47 +00003873 if( MEMDB ) return;
drh8e298f92002-07-06 16:28:47 +00003874 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00003875 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00003876 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00003877 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
3878 /* If this pages is the last page in the file and the file has grown
3879 ** during the current transaction, then do NOT mark the page as clean.
3880 ** When the database file grows, we must make sure that the last page
3881 ** gets written at least once so that the disk file will be the correct
3882 ** size. If you do not write this page and the size of the file
3883 ** on the disk ends up being too small, that can lead to database
3884 ** corruption during the next transaction.
3885 */
3886 }else{
drh538f5702007-04-13 02:14:30 +00003887 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3888 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00003889 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00003890#ifdef SQLITE_CHECK_PAGES
3891 pPg->pageHash = pager_pagehash(pPg);
3892#endif
drh8124a302002-06-25 14:43:57 +00003893 }
drh30e58752002-03-02 20:41:57 +00003894 }
3895}
3896
3897/*
3898** A call to this routine tells the pager that if a rollback occurs,
3899** it is not necessary to restore the data on the given page. This
3900** means that the pager does not have to record the given page in the
3901** rollback journal.
drh538f5702007-04-13 02:14:30 +00003902**
3903** If we have not yet actually read the content of this page (if
3904** the PgHdr.needRead flag is set) then this routine acts as a promise
3905** that we will never need to read the page content in the future.
3906** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003907*/
danielk19773b8a05f2007-03-19 17:44:26 +00003908void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003909 Pager *pPager = pPg->pPager;
3910
drhd3627af2006-12-18 18:34:51 +00003911 assert( pPager->state>=PAGER_RESERVED );
3912 if( pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00003913 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00003914 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
3915 assert( pPager->aInJournal!=0 );
3916 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3917 pPg->inJournal = 1;
drh538f5702007-04-13 02:14:30 +00003918 pPg->needRead = 0;
drhac69b052004-05-12 13:30:07 +00003919 if( pPager->stmtInUse ){
3920 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00003921 }
drh4f0c5872007-03-26 22:05:01 +00003922 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00003923 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003924 }
danielk1977f35843b2007-04-07 15:03:17 +00003925 if( pPager->stmtInUse
3926 && !pageInStatement(pPg)
3927 && (int)pPg->pgno<=pPager->stmtSize
3928 ){
drh30e58752002-03-02 20:41:57 +00003929 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00003930 assert( pPager->aInStmt!=0 );
3931 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00003932 }
3933}
3934
drhac69b052004-05-12 13:30:07 +00003935
drh30e58752002-03-02 20:41:57 +00003936/*
drh80e35f42007-03-30 14:06:34 +00003937** This routine is called to increment the database file change-counter,
3938** stored at byte 24 of the pager file.
3939*/
3940static int pager_incr_changecounter(Pager *pPager){
3941 PgHdr *pPgHdr;
3942 u32 change_counter;
3943 int rc;
3944
3945 if( !pPager->changeCountDone ){
3946 /* Open page 1 of the file for writing. */
3947 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3948 if( rc!=SQLITE_OK ) return rc;
3949 rc = sqlite3PagerWrite(pPgHdr);
3950 if( rc!=SQLITE_OK ) return rc;
3951
drh80e35f42007-03-30 14:06:34 +00003952 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003953 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003954 change_counter++;
3955 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
drh80e35f42007-03-30 14:06:34 +00003956 /* Release the page reference. */
3957 sqlite3PagerUnref(pPgHdr);
3958 pPager->changeCountDone = 1;
3959 }
3960 return SQLITE_OK;
3961}
3962
3963/*
3964** Sync the database file for the pager pPager. zMaster points to the name
3965** of a master journal file that should be written into the individual
3966** journal file. zMaster may be NULL, which is interpreted as no master
3967** journal (a single database transaction).
3968**
3969** This routine ensures that the journal is synced, all dirty pages written
3970** to the database file and the database file synced. The only thing that
3971** remains to commit the transaction is to delete the journal file (or
3972** master journal file if specified).
3973**
3974** Note that if zMaster==NULL, this does not overwrite a previous value
3975** passed to an sqlite3PagerCommitPhaseOne() call.
3976**
3977** If parameter nTrunc is non-zero, then the pager file is truncated to
3978** nTrunc pages (this is used by auto-vacuum databases).
3979*/
3980int sqlite3PagerCommitPhaseOne(Pager *pPager, const char *zMaster, Pgno nTrunc){
3981 int rc = SQLITE_OK;
3982
3983 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3984 pPager->zFilename, zMaster, nTrunc);
3985
3986 /* If this is an in-memory db, or no pages have been written to, or this
3987 ** function has already been called, it is a no-op.
3988 */
3989 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3990 PgHdr *pPg;
3991 assert( pPager->journalOpen );
3992
3993 /* If a master journal file name has already been written to the
3994 ** journal file, then no sync is required. This happens when it is
3995 ** written, then the process fails to upgrade from a RESERVED to an
3996 ** EXCLUSIVE lock. The next time the process tries to commit the
3997 ** transaction the m-j name will have already been written.
3998 */
3999 if( !pPager->setMaster ){
4000 rc = pager_incr_changecounter(pPager);
4001 if( rc!=SQLITE_OK ) goto sync_exit;
4002#ifndef SQLITE_OMIT_AUTOVACUUM
4003 if( nTrunc!=0 ){
4004 /* If this transaction has made the database smaller, then all pages
4005 ** being discarded by the truncation must be written to the journal
4006 ** file.
4007 */
4008 Pgno i;
4009 int iSkip = PAGER_MJ_PGNO(pPager);
4010 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
4011 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) && i!=iSkip ){
4012 rc = sqlite3PagerGet(pPager, i, &pPg);
4013 if( rc!=SQLITE_OK ) goto sync_exit;
4014 rc = sqlite3PagerWrite(pPg);
4015 sqlite3PagerUnref(pPg);
4016 if( rc!=SQLITE_OK ) goto sync_exit;
4017 }
4018 }
4019 }
4020#endif
4021 rc = writeMasterJournal(pPager, zMaster);
4022 if( rc!=SQLITE_OK ) goto sync_exit;
4023 rc = syncJournal(pPager);
4024 if( rc!=SQLITE_OK ) goto sync_exit;
4025 }
4026
4027#ifndef SQLITE_OMIT_AUTOVACUUM
4028 if( nTrunc!=0 ){
4029 rc = sqlite3PagerTruncate(pPager, nTrunc);
4030 if( rc!=SQLITE_OK ) goto sync_exit;
4031 }
4032#endif
4033
4034 /* Write all dirty pages to the database file */
4035 pPg = pager_get_all_dirty_pages(pPager);
4036 rc = pager_write_pagelist(pPg);
4037 if( rc!=SQLITE_OK ) goto sync_exit;
drh3cdd7d32007-03-30 14:46:01 +00004038 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004039
4040 /* Sync the database file. */
4041 if( !pPager->noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004042 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004043 }
4044 IOTRACE(("DBSYNC %p\n", pPager))
4045
4046 pPager->state = PAGER_SYNCED;
4047 }else if( MEMDB && nTrunc!=0 ){
4048 rc = sqlite3PagerTruncate(pPager, nTrunc);
4049 }
4050
4051sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004052 if( rc==SQLITE_IOERR_BLOCKED ){
4053 /* pager_incr_changecounter() may attempt to obtain an exclusive
4054 * lock to spill the cache and return IOERR_BLOCKED. But since
4055 * there is no chance the cache is inconsistent, it's
4056 * better to return SQLITE_BUSY.
4057 */
4058 rc = SQLITE_BUSY;
4059 }
drh80e35f42007-03-30 14:06:34 +00004060 return rc;
4061}
4062
4063
4064/*
drhed7c8552001-04-11 14:29:21 +00004065** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004066**
4067** If the commit fails for any reason, a rollback attempt is made
4068** and an error code is returned. If the commit worked, SQLITE_OK
4069** is returned.
drhed7c8552001-04-11 14:29:21 +00004070*/
drh80e35f42007-03-30 14:06:34 +00004071int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004072 int rc;
drhed7c8552001-04-11 14:29:21 +00004073 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004074
danielk1977efaaf572006-01-16 11:29:19 +00004075 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004076 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004077 }
drha6abd042004-06-09 17:37:22 +00004078 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004079 return SQLITE_ERROR;
4080 }
drh4f0c5872007-03-26 22:05:01 +00004081 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004082 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004083 pPg = pager_get_all_dirty_pages(pPager);
4084 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004085 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4086 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004087 pPg->dirty = 0;
4088 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004089 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004090 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004091 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004092 pPg = pPg->pDirty;
4093 }
drh605ad8f2006-05-03 23:34:05 +00004094 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004095#ifndef NDEBUG
4096 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4097 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4098 assert( !pPg->alwaysRollback );
4099 assert( !pHist->pOrig );
4100 assert( !pHist->pStmt );
4101 }
4102#endif
drhac69b052004-05-12 13:30:07 +00004103 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004104 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004105 return SQLITE_OK;
4106 }
drh3cdd7d32007-03-30 14:46:01 +00004107 assert( pPager->journalOpen || !pPager->dirtyCache );
4108 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
4109 rc = pager_end_transaction(pPager);
danielk1977979f38e2007-03-27 16:19:51 +00004110 return pager_error(pPager, rc);
drhed7c8552001-04-11 14:29:21 +00004111}
4112
4113/*
drha6abd042004-06-09 17:37:22 +00004114** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004115** All in-memory cache pages revert to their original data contents.
4116** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004117**
4118** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004119** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004120** process is writing trash into the journal file (SQLITE_CORRUPT) or
4121** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4122** codes are returned for all these occasions. Otherwise,
4123** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004124*/
danielk19773b8a05f2007-03-19 17:44:26 +00004125int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004126 int rc;
drh4f0c5872007-03-26 22:05:01 +00004127 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004128 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004129 PgHdr *p;
4130 for(p=pPager->pAll; p; p=p->pNextAll){
4131 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004132 assert( !p->alwaysRollback );
4133 if( !p->dirty ){
4134 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4135 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4136 continue;
4137 }
4138
drhac69b052004-05-12 13:30:07 +00004139 pHist = PGHDR_TO_HIST(p, pPager);
4140 if( pHist->pOrig ){
4141 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004142 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004143 }else{
drh4f0c5872007-03-26 22:05:01 +00004144 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004145 }
4146 clearHistory(pHist);
4147 p->dirty = 0;
4148 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004149 pHist->inStmt = 0;
4150 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004151 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004152 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004153 }
drhac69b052004-05-12 13:30:07 +00004154 }
drh605ad8f2006-05-03 23:34:05 +00004155 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004156 pPager->pStmt = 0;
4157 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004158 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004159 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004160 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004161 return SQLITE_OK;
4162 }
4163
drha6abd042004-06-09 17:37:22 +00004164 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00004165 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00004166 return rc;
4167 }
drhdb48ee02003-01-16 13:42:43 +00004168
danielk1977efaaf572006-01-16 11:29:19 +00004169 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004170 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004171 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004172 }
danielk1977efaaf572006-01-16 11:29:19 +00004173 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004174 }
drha6abd042004-06-09 17:37:22 +00004175 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004176 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004177 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004178 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00004179 if( rc==SQLITE_OK ){
4180 rc = rc2;
4181 }
4182 }else{
danielk1977e277be02007-03-23 18:12:06 +00004183 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004184 }
danielk1977e180dd92007-04-05 17:15:52 +00004185 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004186 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004187
4188 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4189 ** cache. So call pager_error() on the way out to make any error
4190 ** persistent.
4191 */
4192 return pager_error(pPager, rc);
drh98808ba2001-10-18 12:34:46 +00004193}
drhd9b02572001-04-15 00:37:09 +00004194
4195/*
drh5e00f6c2001-09-13 13:46:56 +00004196** Return TRUE if the database file is opened read-only. Return FALSE
4197** if the database is (in theory) writable.
4198*/
danielk19773b8a05f2007-03-19 17:44:26 +00004199int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004200 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004201}
4202
4203/*
drh0f7eb612006-08-08 13:51:43 +00004204** Return the number of references to the pager.
4205*/
danielk19773b8a05f2007-03-19 17:44:26 +00004206int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004207 return pPager->nRef;
4208}
4209
4210#ifdef SQLITE_TEST
4211/*
drhd9b02572001-04-15 00:37:09 +00004212** This routine is used for testing and analysis only.
4213*/
danielk19773b8a05f2007-03-19 17:44:26 +00004214int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004215 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004216 a[0] = pPager->nRef;
4217 a[1] = pPager->nPage;
4218 a[2] = pPager->mxPage;
4219 a[3] = pPager->dbSize;
4220 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004221 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004222 a[6] = pPager->nHit;
4223 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004224 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004225 a[9] = pPager->nRead;
4226 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004227 return a;
4228}
drh0f7eb612006-08-08 13:51:43 +00004229#endif
drhdd793422001-06-28 01:54:48 +00004230
drhfa86c412002-02-02 15:01:15 +00004231/*
drhac69b052004-05-12 13:30:07 +00004232** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004233**
4234** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004235** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004236** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004237*/
danielk19773b8a05f2007-03-19 17:44:26 +00004238int sqlite3PagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004239 int rc;
drhac69b052004-05-12 13:30:07 +00004240 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004241 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004242 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004243 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004244 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004245 pPager->stmtInUse = 1;
4246 pPager->stmtSize = pPager->dbSize;
4247 return SQLITE_OK;
4248 }
drhda47d772002-12-02 04:25:19 +00004249 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004250 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004251 return SQLITE_OK;
4252 }
drhfa86c412002-02-02 15:01:15 +00004253 assert( pPager->journalOpen );
drh17435752007-08-16 04:30:38 +00004254 pPager->aInStmt = sqlite3MallocZero( pPager->dbSize/8 + 1 );
drhac69b052004-05-12 13:30:07 +00004255 if( pPager->aInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004256 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004257 return SQLITE_NOMEM;
4258 }
drh968af522003-02-11 14:55:40 +00004259#ifndef NDEBUG
drh054889e2005-11-30 03:20:31 +00004260 rc = sqlite3OsFileSize(pPager->jfd, &pPager->stmtJSize);
drhac69b052004-05-12 13:30:07 +00004261 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00004262 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00004263#endif
danielk197776572402004-06-25 02:38:54 +00004264 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004265 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004266 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004267 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004268 if( !pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00004269 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, 0);
drhac69b052004-05-12 13:30:07 +00004270 if( rc ) goto stmt_begin_failed;
4271 pPager->stmtOpen = 1;
4272 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004273 }
drhac69b052004-05-12 13:30:07 +00004274 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004275 return SQLITE_OK;
4276
drhac69b052004-05-12 13:30:07 +00004277stmt_begin_failed:
4278 if( pPager->aInStmt ){
drh17435752007-08-16 04:30:38 +00004279 sqlite3_free(pPager->aInStmt);
drhac69b052004-05-12 13:30:07 +00004280 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004281 }
4282 return rc;
4283}
4284
4285/*
drhac69b052004-05-12 13:30:07 +00004286** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004287*/
danielk19773b8a05f2007-03-19 17:44:26 +00004288int sqlite3PagerStmtCommit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00004289 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004290 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004291 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004292 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004293 /* sqlite3OsTruncate(pPager->stfd, 0); */
drh17435752007-08-16 04:30:38 +00004294 sqlite3_free( pPager->aInStmt );
drhac69b052004-05-12 13:30:07 +00004295 pPager->aInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004296 }else{
4297 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004298 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004299 pNext = pHist->pNextStmt;
4300 assert( pHist->inStmt );
4301 pHist->inStmt = 0;
4302 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00004303 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004304 pHist->pStmt = 0;
4305 }
4306 }
4307 pPager->stmtNRec = 0;
4308 pPager->stmtInUse = 0;
4309 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004310 }
drhac69b052004-05-12 13:30:07 +00004311 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00004312 return SQLITE_OK;
4313}
4314
4315/*
drhac69b052004-05-12 13:30:07 +00004316** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004317*/
danielk19773b8a05f2007-03-19 17:44:26 +00004318int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004319 int rc;
drhac69b052004-05-12 13:30:07 +00004320 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004321 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004322 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004323 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004324 PgHistory *pHist;
4325 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4326 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004327 if( pHist->pStmt ){
4328 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00004329 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004330 pHist->pStmt = 0;
4331 }
4332 }
4333 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00004334 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004335 rc = SQLITE_OK;
4336 }else{
4337 rc = pager_stmt_playback(pPager);
4338 }
danielk19773b8a05f2007-03-19 17:44:26 +00004339 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00004340 }else{
4341 rc = SQLITE_OK;
4342 }
drhac69b052004-05-12 13:30:07 +00004343 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00004344 return rc;
4345}
4346
drh73509ee2003-04-06 20:44:45 +00004347/*
4348** Return the full pathname of the database file.
4349*/
danielk19773b8a05f2007-03-19 17:44:26 +00004350const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004351 return pPager->zFilename;
4352}
4353
drhb20ea9d2004-02-09 01:20:36 +00004354/*
danielk19775865e3d2004-06-14 06:03:57 +00004355** Return the directory of the database file.
4356*/
danielk19773b8a05f2007-03-19 17:44:26 +00004357const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004358 return pPager->zDirectory;
4359}
4360
4361/*
4362** Return the full pathname of the journal file.
4363*/
danielk19773b8a05f2007-03-19 17:44:26 +00004364const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004365 return pPager->zJournal;
4366}
4367
4368/*
drh2c8997b2005-08-27 16:36:48 +00004369** Return true if fsync() calls are disabled for this pager. Return FALSE
4370** if fsync()s are executed normally.
4371*/
danielk19773b8a05f2007-03-19 17:44:26 +00004372int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004373 return pPager->noSync;
4374}
4375
drh7c4ac0c2007-04-05 11:25:58 +00004376#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004377/*
drhb20ea9d2004-02-09 01:20:36 +00004378** Set the codec for this pager
4379*/
danielk19773b8a05f2007-03-19 17:44:26 +00004380void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004381 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004382 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004383 void *pCodecArg
4384){
4385 pPager->xCodec = xCodec;
4386 pPager->pCodecArg = pCodecArg;
4387}
drh7c4ac0c2007-04-05 11:25:58 +00004388#endif
drhb20ea9d2004-02-09 01:20:36 +00004389
danielk1977687566d2004-11-02 12:56:41 +00004390#ifndef SQLITE_OMIT_AUTOVACUUM
4391/*
drh5e385312007-06-16 04:42:12 +00004392** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004393**
drh5e385312007-06-16 04:42:12 +00004394** There must be no references to the page previously located at
4395** pgno (which we call pPgOld) though that page is allowed to be
4396** in cache. If the page previous located at pgno is not already
4397** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004398**
drh5e385312007-06-16 04:42:12 +00004399** References to the page pPg remain valid. Updating any
4400** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004401** allocated along with the page) is the responsibility of the caller.
4402**
danielk19775fd057a2005-03-09 13:09:43 +00004403** A transaction must be active when this routine is called. It used to be
4404** required that a statement transaction was not active, but this restriction
4405** has been removed (CREATE INDEX needs to move a page when a statement
4406** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00004407*/
danielk19773b8a05f2007-03-19 17:44:26 +00004408int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00004409 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00004410 int h;
danielk197794daf7f2004-11-08 09:26:09 +00004411 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004412
danielk1977687566d2004-11-02 12:56:41 +00004413 assert( pPg->nRef>0 );
4414
drh4f0c5872007-03-26 22:05:01 +00004415 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00004416 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00004417 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004418
danielk1977b4626a32007-04-28 15:47:43 +00004419 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00004420 if( pPg->needSync ){
4421 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00004422 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00004423 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00004424 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004425 }
4426
danielk1977687566d2004-11-02 12:56:41 +00004427 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00004428 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00004429
danielk1977ef73ee92004-11-06 12:26:07 +00004430 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00004431 ** from it's hash chain. Also, if the PgHdr.needSync was set for
4432 ** page pgno before the 'move' operation, it needs to be retained
4433 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004434 */
drh5e385312007-06-16 04:42:12 +00004435 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00004436 pPgOld = pager_lookup(pPager, pgno);
4437 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00004438 assert( pPgOld->nRef==0 );
4439 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00004440 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00004441 pPg->needSync = pPgOld->needSync;
4442 }else{
4443 pPg->needSync = 0;
4444 }
4445 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
4446 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drh5e385312007-06-16 04:42:12 +00004447 }else{
4448 pPg->inJournal = 0;
drh732c8172007-06-16 11:17:45 +00004449 assert( pPg->needSync==0 || (int)pgno>pPager->origDbSize );
danielk1977687566d2004-11-02 12:56:41 +00004450 }
4451
danielk1977f5fdda82004-11-03 08:44:05 +00004452 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00004453 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00004454 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00004455 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00004456 if( pPager->aHash[h] ){
4457 assert( pPager->aHash[h]->pPrevHash==0 );
4458 pPager->aHash[h]->pPrevHash = pPg;
4459 }
4460 pPg->pNextHash = pPager->aHash[h];
4461 pPager->aHash[h] = pPg;
4462 pPg->pPrevHash = 0;
4463
drh605ad8f2006-05-03 23:34:05 +00004464 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004465 pPager->dirtyCache = 1;
4466
danielk197794daf7f2004-11-08 09:26:09 +00004467 if( needSyncPgno ){
4468 /* If needSyncPgno is non-zero, then the journal file needs to be
4469 ** sync()ed before any data is written to database file page needSyncPgno.
4470 ** Currently, no such page exists in the page-cache and the
4471 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
4472 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00004473 **
danielk19773b8a05f2007-03-19 17:44:26 +00004474 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004475 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004476 */
4477 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004478 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004479 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004480 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004481 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00004482 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00004483 pPgHdr->needSync = 1;
4484 pPgHdr->inJournal = 1;
4485 makeDirty(pPgHdr);
4486 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004487 }
4488
danielk1977687566d2004-11-02 12:56:41 +00004489 return SQLITE_OK;
4490}
4491#endif
4492
danielk19773b8a05f2007-03-19 17:44:26 +00004493/*
4494** Return a pointer to the data for the specified page.
4495*/
4496void *sqlite3PagerGetData(DbPage *pPg){
4497 return PGHDR_TO_DATA(pPg);
4498}
4499
4500/*
4501** Return a pointer to the Pager.nExtra bytes of "extra" space
4502** allocated along with the specified page.
4503*/
4504void *sqlite3PagerGetExtra(DbPage *pPg){
4505 Pager *pPager = pPg->pPager;
4506 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
4507}
4508
danielk197741483462007-03-24 16:45:04 +00004509/*
4510** Get/set the locking-mode for this pager. Parameter eMode must be one
4511** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4512** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4513** the locking-mode is set to the value specified.
4514**
4515** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4516** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4517** locking-mode.
4518*/
4519int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004520 assert( eMode==PAGER_LOCKINGMODE_QUERY
4521 || eMode==PAGER_LOCKINGMODE_NORMAL
4522 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4523 assert( PAGER_LOCKINGMODE_QUERY<0 );
4524 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4525 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00004526 pPager->exclusiveMode = eMode;
4527 }
4528 return (int)pPager->exclusiveMode;
4529}
4530
dougcurrie81c95ef2004-06-18 23:21:47 +00004531#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00004532/*
4533** Return the current state of the file lock for the given pager.
4534** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
4535** PENDING_LOCK, or EXCLUSIVE_LOCK.
4536*/
danielk19773b8a05f2007-03-19 17:44:26 +00004537int sqlite3PagerLockstate(Pager *pPager){
drh054889e2005-11-30 03:20:31 +00004538 return sqlite3OsLockState(pPager->fd);
drh89ac8c12004-06-09 14:17:20 +00004539}
4540#endif
4541
danielk197793758c82005-01-21 08:13:14 +00004542#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00004543/*
4544** Print a listing of all referenced pages and their ref count.
4545*/
danielk19773b8a05f2007-03-19 17:44:26 +00004546void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00004547 PgHdr *pPg;
4548 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4549 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00004550 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
4551 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00004552 }
4553}
4554#endif
drh2e66f0b2005-04-28 17:18:48 +00004555
4556#endif /* SQLITE_OMIT_DISKIO */