blob: ac42d13ff51dee60df3da3ff392d294443bb6a0f [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**
danielk19773460d192008-12-27 15:23:13 +000021** @(#) $Id: pager.c,v 1.524 2008/12/27 15:23:13 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
26/*
drhdb48ee02003-01-16 13:42:43 +000027** Macros for troubleshooting. Normally turned off
28*/
danielk1977466be562004-06-10 02:16:01 +000029#if 0
drhd3627af2006-12-18 18:34:51 +000030#define sqlite3DebugPrintf printf
drh4f0c5872007-03-26 22:05:01 +000031#define PAGERTRACE1(X) sqlite3DebugPrintf(X)
32#define PAGERTRACE2(X,Y) sqlite3DebugPrintf(X,Y)
33#define PAGERTRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
34#define PAGERTRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
35#define PAGERTRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000036#else
drh4f0c5872007-03-26 22:05:01 +000037#define PAGERTRACE1(X)
38#define PAGERTRACE2(X,Y)
39#define PAGERTRACE3(X,Y,Z)
40#define PAGERTRACE4(X,Y,Z,W)
41#define PAGERTRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000042#endif
43
danielk1977599fcba2004-11-08 07:13:13 +000044/*
drh4f0c5872007-03-26 22:05:01 +000045** The following two macros are used within the PAGERTRACEX() macros above
drhd86959f2005-11-26 03:51:18 +000046** to print out file-descriptors.
danielk1977599fcba2004-11-08 07:13:13 +000047**
drh85b623f2007-12-13 21:54:09 +000048** PAGERID() takes a pointer to a Pager struct as its argument. The
danielk197762079062007-08-15 17:08:46 +000049** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
drh85b623f2007-12-13 21:54:09 +000050** struct as its argument.
danielk1977599fcba2004-11-08 07:13:13 +000051*/
drhc001c582006-03-06 18:23:16 +000052#define PAGERID(p) ((int)(p->fd))
53#define FILEHANDLEID(fd) ((int)fd)
drhdb48ee02003-01-16 13:42:43 +000054
55/*
drhed7c8552001-04-11 14:29:21 +000056** The page cache as a whole is always in one of the following
57** states:
58**
drha6abd042004-06-09 17:37:22 +000059** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000060** writing the database file. There is no
61** data held in memory. This is the initial
62** state.
63**
drha6abd042004-06-09 17:37:22 +000064** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000065** Writing is not permitted. There can be
66** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000067** file at the same time.
drhed7c8552001-04-11 14:29:21 +000068**
drh726de592004-06-10 23:35:50 +000069** PAGER_RESERVED This process has reserved the database for writing
70** but has not yet made any changes. Only one process
71** at a time can reserve the database. The original
72** database file has not been modified so other
73** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000074** database file.
75**
76** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000077** Access is exclusive. No other processes or
78** threads can be reading or writing while one
79** process is writing.
80**
danielk1977aa5ccdf2004-06-14 05:10:42 +000081** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
82** after all dirty pages have been written to the
83** database file and the file has been synced to
drh369339d2007-03-30 16:01:55 +000084** disk. All that remains to do is to remove or
85** truncate the journal file and the transaction
86** will be committed.
danielk1977aa5ccdf2004-06-14 05:10:42 +000087**
drha6abd042004-06-09 17:37:22 +000088** The page cache comes up in PAGER_UNLOCK. The first time a
danielk19773b8a05f2007-03-19 17:44:26 +000089** sqlite3PagerGet() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000090** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000091** the state transitions back to PAGER_UNLOCK. The first time
danielk19773b8a05f2007-03-19 17:44:26 +000092** that sqlite3PagerWrite() is called, the state transitions to
drh369339d2007-03-30 16:01:55 +000093** PAGER_RESERVED. (Note that sqlite3PagerWrite() can only be
drh306dc212001-05-21 13:45:10 +000094** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000095** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh369339d2007-03-30 16:01:55 +000096** PAGER_RESERVED means that there is an open rollback journal.
97** The transition to PAGER_EXCLUSIVE occurs before any changes
98** are made to the database file, though writes to the rollback
99** journal occurs with just PAGER_RESERVED. After an sqlite3PagerRollback()
100** or sqlite3PagerCommitPhaseTwo(), the state can go back to PAGER_SHARED,
101** or it can stay at PAGER_EXCLUSIVE if we are in exclusive access mode.
drhed7c8552001-04-11 14:29:21 +0000102*/
drha6abd042004-06-09 17:37:22 +0000103#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000104#define PAGER_SHARED 1 /* same as SHARED_LOCK */
105#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
106#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
107#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000108
drh684917c2004-10-05 02:41:42 +0000109/*
110** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
111** then failed attempts to get a reserved lock will invoke the busy callback.
112** This is off by default. To see why, consider the following scenario:
113**
114** Suppose thread A already has a shared lock and wants a reserved lock.
115** Thread B already has a reserved lock and wants an exclusive lock. If
116** both threads are using their busy callbacks, it might be a long time
117** be for one of the threads give up and allows the other to proceed.
118** But if the thread trying to get the reserved lock gives up quickly
119** (if it never invokes its busy callback) then the contention will be
120** resolved quickly.
121*/
122#ifndef SQLITE_BUSY_RESERVED_LOCK
123# define SQLITE_BUSY_RESERVED_LOCK 0
124#endif
drhd9b02572001-04-15 00:37:09 +0000125
drhed7c8552001-04-11 14:29:21 +0000126/*
drh887dc4c2004-10-22 16:22:57 +0000127** This macro rounds values up so that if the value is an address it
128** is guaranteed to be an address that is aligned to an 8-byte boundary.
129*/
130#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
131
drh9eb9e262004-02-11 02:18:05 +0000132/*
133** A macro used for invoking the codec if there is one
134*/
135#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000136# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
137# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000138#else
drhc001c582006-03-06 18:23:16 +0000139# define CODEC1(P,D,N,X) /* NO-OP */
140# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000141#endif
142
drhed7c8552001-04-11 14:29:21 +0000143/*
danielk1977fd7f0452008-12-17 17:30:26 +0000144** An instance of the following structure is allocated for each active
145** savepoint and statement transaction in the system. All such structures
146** are stored in the Pager.aSavepoint[] array, which is allocated and
147** resized using sqlite3Realloc().
148**
149** When a savepoint is created, the PagerSavepoint.iHdrOffset field is
150** set to 0. If a journal-header is written into the main journal while
151** the savepoint is active, then iHdrOffset is set to the byte offset
152** immediately following the last journal record written into the main
153** journal before the journal-header. This is required during savepoint
154** rollback (see pagerPlaybackSavepoint()).
155*/
156typedef struct PagerSavepoint PagerSavepoint;
157struct PagerSavepoint {
158 i64 iOffset; /* Starting offset in main journal */
159 i64 iHdrOffset; /* See above */
160 Bitvec *pInSavepoint; /* Set of pages in this savepoint */
161 Pgno nOrig; /* Original number of pages in file */
162 Pgno iSubRec; /* Index of first record in sub-journal */
163};
164
165/*
drhed7c8552001-04-11 14:29:21 +0000166** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000167**
drh4f0ee682007-03-30 20:43:40 +0000168** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000169** or SQLITE_FULL. Once one of the first three errors occurs, it persists
170** and is returned as the result of every major pager API call. The
171** SQLITE_FULL return code is slightly different. It persists only until the
172** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000173** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000174** APIs, they may still be used successfully.
danielk19773460d192008-12-27 15:23:13 +0000175**
176** Managing the size of the database file in pages is a little complicated.
177** The variable Pager.dbSize contains the number of pages that the database
178** image currently contains. As the database image grows or shrinks this
179** variable is updated. The variable Pager.dbFileSize contains the number
180** of pages in the database file. This may be different from Pager.dbSize
181** if some pages have been appended to the database image but not yet written
182** out from the cache to the actual file on disk. Or if the image has been
183** truncated by an incremental-vacuum operation. The Pager.dbOrigSize variable
184** contains the number of pages in the database image when the current
185** transaction was opened. The contents of all three of these variables is
186** only guaranteed to be correct if the boolean Pager.dbSizeValid is true.
drhed7c8552001-04-11 14:29:21 +0000187*/
188struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000189 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000190 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000191 u8 journalStarted; /* True if header of journal is synced */
192 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000193 u8 noReadlock; /* Do not bother to obtain readlocks */
drh603240c2002-03-05 01:11:12 +0000194 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000195 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000196 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000197 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000198 u8 tempFile; /* zFilename is a temporary file */
199 u8 readOnly; /* True for a read-only database */
200 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000201 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000202 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000203 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000204 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000205 u8 doNotSync; /* Boolean. While true, do not spill the cache */
206 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
drhfdc40e92008-04-17 20:59:37 +0000207 u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */
drhd138c012008-05-13 00:58:18 +0000208 u8 dbModified; /* True if there are any changes to the Db */
drh80e35f42007-03-30 14:06:34 +0000209 u8 changeCountDone; /* Set after incrementing the change-counter */
danielk1977d92db532008-11-17 04:56:24 +0000210 u8 dbSizeValid; /* Set when dbSize is correct */
danielk19773460d192008-12-27 15:23:13 +0000211 Pgno dbSize; /* Number of pages in the database */
212 Pgno dbOrigSize; /* dbSize before the current transaction */
213 Pgno dbFileSize; /* Number of pages in the database file */
drh33f4e022007-09-03 15:19:34 +0000214 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000215 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000216 int nRec; /* Number of pages written to the journal */
217 u32 cksumInit; /* Quasi-random value added to every checksum */
218 int stmtNRec; /* Number of records in stmt subjournal */
219 int nExtra; /* Add this many bytes to each in-memory page */
220 int pageSize; /* Number of bytes in a page */
221 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000222 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000223 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000224 Bitvec *pInJournal; /* One bit for each page in the database file */
danielk1977a1fa00d2008-08-27 15:16:33 +0000225 Bitvec *pAlwaysRollback; /* One bit for each page marked always-rollback */
drhfcd35c72005-05-21 02:48:08 +0000226 char *zFilename; /* Name of the database file */
227 char *zJournal; /* Name of the journal file */
228 char *zDirectory; /* Directory hold database and journal files */
danielk197762079062007-08-15 17:08:46 +0000229 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
danielk1977fd7f0452008-12-17 17:30:26 +0000230 sqlite3_file *sjfd; /* File descriptor for the sub-journal*/
danielk19771ceedd32008-11-19 10:22:33 +0000231 int (*xBusyHandler)(void*); /* Function to call when busy */
232 void *pBusyHandlerArg; /* Context argument for xBusyHandler */
drheb206252004-10-01 02:00:31 +0000233 i64 journalOff; /* Current byte offset in the journal file */
234 i64 journalHdr; /* Byte offset to previous journal header */
drh98c58352008-11-07 00:24:53 +0000235 u32 sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000236#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000237 int nHit, nMiss; /* Cache hits and missing */
238 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000239#endif
danielk1977eaa06f62008-09-18 17:34:44 +0000240 void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000241#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000242 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000243 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000244#endif
danielk19778186df82007-03-06 13:45:59 +0000245 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000246 char dbFileVers[16]; /* Changes whenever database file changes */
danielk1977b53e4962008-06-04 06:45:59 +0000247 i64 journalSizeLimit; /* Size limit for persistent journal files */
danielk19778c0a7912008-08-20 14:49:23 +0000248 PCache *pPCache; /* Pointer to page cache object */
danielk1977fd7f0452008-12-17 17:30:26 +0000249
250 PagerSavepoint *aSavepoint;
251 int nSavepoint;
drhd9b02572001-04-15 00:37:09 +0000252};
253
254/*
drh538f5702007-04-13 02:14:30 +0000255** The following global variables hold counters used for
256** testing purposes only. These variables do not exist in
257** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000258*/
259#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000260int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
261int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
262int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
drh538f5702007-04-13 02:14:30 +0000263# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000264#else
drh538f5702007-04-13 02:14:30 +0000265# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000266#endif
267
drh538f5702007-04-13 02:14:30 +0000268
269
drhfcd35c72005-05-21 02:48:08 +0000270/*
drh5e00f6c2001-09-13 13:46:56 +0000271** Journal files begin with the following magic string. The data
272** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000273**
drhae2b40c2004-06-09 19:03:54 +0000274** Since version 2.8.0, the journal format contains additional sanity
275** checking information. If the power fails while the journal is begin
276** written, semi-random garbage data might appear in the journal
277** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000278** to roll the journal back, the database could be corrupted. The additional
279** sanity checking data is an attempt to discover the garbage in the
280** journal and ignore it.
281**
drhae2b40c2004-06-09 19:03:54 +0000282** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000283** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000284** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000285** This cksum is initialized to a 32-bit random value that appears in the
286** journal file right after the header. The random initializer is important,
287** because garbage data that appears at the end of a journal is likely
288** data that was once in other files that have now been deleted. If the
289** garbage data came from an obsolete journal file, the checksums might
290** be correct. But by initializing the checksum to random value which
291** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000292*/
drhae2b40c2004-06-09 19:03:54 +0000293static const unsigned char aJournalMagic[] = {
294 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000295};
296
297/*
drh726de592004-06-10 23:35:50 +0000298** The size of the header and of each page in the journal is determined
299** by the following macros.
drh968af522003-02-11 14:55:40 +0000300*/
drhae2b40c2004-06-09 19:03:54 +0000301#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000302
danielk197776572402004-06-25 02:38:54 +0000303/*
304** The journal header size for this pager. In the future, this could be
305** set to some value read from the disk controller. The important
306** characteristic is that it is the same size as a disk sector.
307*/
308#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
309
drhb7f91642004-10-31 02:22:47 +0000310/*
311** The macro MEMDB is true if we are dealing with an in-memory database.
312** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
313** the value of MEMDB will be a constant and the compiler will optimize
314** out code that would never execute.
315*/
316#ifdef SQLITE_OMIT_MEMORYDB
317# define MEMDB 0
318#else
319# define MEMDB pPager->memDb
320#endif
321
322/*
danielk197776572402004-06-25 02:38:54 +0000323** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
324** reserved for working around a windows/posix incompatibility). It is
325** used in the journal to signify that the remainder of the journal file
326** is devoted to storing a master journal name - there are no more pages to
327** roll back. See comments for function writeMasterJournal() for details.
328*/
danielk1977599fcba2004-11-08 07:13:13 +0000329/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
danielk1977d92db532008-11-17 04:56:24 +0000330#define PAGER_MJ_PGNO(x) ((Pgno)((PENDING_BYTE/((x)->pageSize))+1))
danielk197713adf8a2004-06-03 16:08:41 +0000331
drh968af522003-02-11 14:55:40 +0000332/*
danielk197726836652005-01-17 01:33:13 +0000333** The maximum legal page number is (2^31 - 1).
334*/
335#define PAGER_MAX_PGNO 2147483647
336
337/*
danielk19773460d192008-12-27 15:23:13 +0000338** Return true if it is necessary to write page *pPg into the sub-journal.
339** A page needs to be written into the sub-journal if there exists one
340** or more open savepoints for which:
danielk1977fd7f0452008-12-17 17:30:26 +0000341**
danielk19773460d192008-12-27 15:23:13 +0000342** * The page-number is less than or equal to PagerSavepoint.nOrig, and
343** * The bit corresponding to the page-number is not set in
344** PagerSavepoint.pInSavepoint.
danielk1977f35843b2007-04-07 15:03:17 +0000345*/
danielk19773460d192008-12-27 15:23:13 +0000346static int subjRequiresPage(PgHdr *pPg){
347 Pgno pgno = pPg->pgno;
danielk1977f35843b2007-04-07 15:03:17 +0000348 Pager *pPager = pPg->pPager;
danielk19773460d192008-12-27 15:23:13 +0000349 int i;
350 for(i=0; i<pPager->nSavepoint; i++){
351 PagerSavepoint *p = &pPager->aSavepoint[i];
352 if( p->nOrig>=pgno && 0==sqlite3BitvecTest(p->pInSavepoint, pgno) ){
353 return 1;
354 }
danielk1977fd7f0452008-12-17 17:30:26 +0000355 }
danielk19773460d192008-12-27 15:23:13 +0000356 return 0;
danielk1977f35843b2007-04-07 15:03:17 +0000357}
drh8ca0c722006-05-07 17:49:38 +0000358
danielk19773460d192008-12-27 15:23:13 +0000359/*
360** Return true if the page is already in the journal file.
361*/
danielk1977bc2ca9e2008-11-13 14:28:28 +0000362static int pageInJournal(PgHdr *pPg){
363 return sqlite3BitvecTest(pPg->pPager->pInJournal, pPg->pgno);
364}
365
drh8ca0c722006-05-07 17:49:38 +0000366/*
drh34e79ce2004-02-08 06:05:46 +0000367** Read a 32-bit integer from the given file descriptor. Store the integer
368** that is read in *pRes. Return SQLITE_OK if everything worked, or an
369** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000370**
371** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000372*/
danielk197762079062007-08-15 17:08:46 +0000373static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000374 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000375 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000376 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000377 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000378 }
drh94f33312002-08-12 12:29:56 +0000379 return rc;
380}
381
382/*
drh97b57482006-01-10 20:32:32 +0000383** Write a 32-bit integer into a string buffer in big-endian byte order.
384*/
drha3152892007-05-05 11:48:52 +0000385#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000386
387/*
drh34e79ce2004-02-08 06:05:46 +0000388** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
389** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000390*/
danielk197762079062007-08-15 17:08:46 +0000391static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000392 char ac[4];
drh97b57482006-01-10 20:32:32 +0000393 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000394 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000395}
396
drh2554f8b2003-01-22 01:26:44 +0000397/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000398** If file pFd is open, call sqlite3OsUnlock() on it.
399*/
400static int osUnlock(sqlite3_file *pFd, int eLock){
401 if( !pFd->pMethods ){
402 return SQLITE_OK;
403 }
404 return sqlite3OsUnlock(pFd, eLock);
405}
406
407/*
danielk1977c7b60172007-08-22 11:22:03 +0000408** This function determines whether or not the atomic-write optimization
409** can be used with this pager. The optimization can be used if:
410**
411** (a) the value returned by OsDeviceCharacteristics() indicates that
412** a database page may be written atomically, and
413** (b) the value returned by OsSectorSize() is less than or equal
414** to the page size.
415**
416** If the optimization cannot be used, 0 is returned. If it can be used,
417** then the value returned is the size of the journal file when it
418** contains rollback data for exactly one page.
419*/
420#ifdef SQLITE_ENABLE_ATOMIC_WRITE
421static int jrnlBufferSize(Pager *pPager){
422 int dc; /* Device characteristics */
423 int nSector; /* Sector size */
drhfacf0302008-06-17 15:12:00 +0000424 int szPage; /* Page size */
danielk1977c7b60172007-08-22 11:22:03 +0000425 sqlite3_file *fd = pPager->fd;
426
427 if( fd->pMethods ){
428 dc = sqlite3OsDeviceCharacteristics(fd);
429 nSector = sqlite3OsSectorSize(fd);
drhfacf0302008-06-17 15:12:00 +0000430 szPage = pPager->pageSize;
danielk1977c7b60172007-08-22 11:22:03 +0000431 }
432
433 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
434 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
435
drhfacf0302008-06-17 15:12:00 +0000436 if( !fd->pMethods ||
437 (dc & (SQLITE_IOCAP_ATOMIC|(szPage>>8)) && nSector<=szPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000438 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
439 }
440 return 0;
441}
442#endif
443
444/*
danielk1977aef0bf62005-12-30 16:28:01 +0000445** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000446** code. The first argument is a pointer to the pager structure, the
447** second the error-code about to be returned by a pager API function.
448** The value returned is a copy of the second argument to this function.
449**
drh4f0ee682007-03-30 20:43:40 +0000450** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000451** the error becomes persistent. Until the persisten error is cleared,
452** subsequent API calls on this Pager will immediately return the same
453** error code.
454**
455** A persistent error indicates that the contents of the pager-cache
456** cannot be trusted. This state can be cleared by completely discarding
457** the contents of the pager-cache. If a transaction was active when
458** the persistent error occured, then the rollback journal may need
459** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000460*/
danielk1977ae72d982007-10-03 08:46:44 +0000461static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000462static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000463 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000464 assert(
465 pPager->errCode==SQLITE_FULL ||
466 pPager->errCode==SQLITE_OK ||
467 (pPager->errCode & 0xff)==SQLITE_IOERR
468 );
danielk1977979f38e2007-03-27 16:19:51 +0000469 if(
drh4ac285a2006-09-15 07:28:50 +0000470 rc2==SQLITE_FULL ||
471 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000472 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000473 ){
474 pPager->errCode = rc;
danielk19778c0a7912008-08-20 14:49:23 +0000475 if( pPager->state==PAGER_UNLOCK
476 && sqlite3PcacheRefCount(pPager->pPCache)==0
477 ){
danielk1977ae72d982007-10-03 08:46:44 +0000478 /* If the pager is already unlocked, call pager_unlock() now to
479 ** clear the error state and ensure that the pager-cache is
480 ** completely empty.
481 */
482 pager_unlock(pPager);
483 }
danielk1977aef0bf62005-12-30 16:28:01 +0000484 }
485 return rc;
486}
487
drh477731b2007-06-16 03:06:27 +0000488/*
489** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
490** on the cache using a hash function. This is used for testing
491** and debugging only.
492*/
danielk19773c407372005-02-15 02:54:14 +0000493#ifdef SQLITE_CHECK_PAGES
494/*
495** Return a 32-bit hash of the page data for pPage.
496*/
drh477731b2007-06-16 03:06:27 +0000497static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000498 u32 hash = 0;
499 int i;
drh477731b2007-06-16 03:06:27 +0000500 for(i=0; i<nByte; i++){
501 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000502 }
503 return hash;
504}
drh477731b2007-06-16 03:06:27 +0000505static u32 pager_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000506 return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
507}
danielk1977bc2ca9e2008-11-13 14:28:28 +0000508static void pager_set_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000509 pPage->pageHash = pager_pagehash(pPage);
drh477731b2007-06-16 03:06:27 +0000510}
danielk19773c407372005-02-15 02:54:14 +0000511
512/*
513** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
514** is defined, and NDEBUG is not defined, an assert() statement checks
515** that the page is either dirty or still matches the calculated page-hash.
516*/
517#define CHECK_PAGE(x) checkPage(x)
518static void checkPage(PgHdr *pPg){
519 Pager *pPager = pPg->pPager;
danielk1977b3175382008-10-17 18:51:52 +0000520 assert( !pPg->pageHash || pPager->errCode
danielk19778c0a7912008-08-20 14:49:23 +0000521 || (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
danielk19773c407372005-02-15 02:54:14 +0000522}
523
524#else
drh8ffa8172007-06-18 17:25:17 +0000525#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000526#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000527#define CHECK_PAGE(x)
drh41d30272008-08-20 21:47:45 +0000528#endif /* SQLITE_CHECK_PAGES */
danielk19773c407372005-02-15 02:54:14 +0000529
drhed7c8552001-04-11 14:29:21 +0000530/*
danielk197776572402004-06-25 02:38:54 +0000531** When this is called the journal file for pager pPager must be open.
532** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000533** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000534**
danielk197765839c62007-08-30 08:08:17 +0000535** zMaster must point to a buffer of at least nMaster bytes allocated by
536** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
537** enough space to write the master journal name). If the master journal
538** name in the journal is longer than nMaster bytes (including a
539** nul-terminator), then this is handled as if no master journal name
540** were present in the journal.
541**
542** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000543** SQLITE_OK returned.
544*/
danielk1977d92db532008-11-17 04:56:24 +0000545static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, u32 nMaster){
danielk197776572402004-06-25 02:38:54 +0000546 int rc;
547 u32 len;
drheb206252004-10-01 02:00:31 +0000548 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000549 u32 cksum;
shane0b8d2762008-07-22 05:18:00 +0000550 u32 u; /* Unsigned loop counter */
danielk197776572402004-06-25 02:38:54 +0000551 unsigned char aMagic[8]; /* A buffer to hold the magic header */
552
danielk197765839c62007-08-30 08:08:17 +0000553 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000554
drh054889e2005-11-30 03:20:31 +0000555 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000556 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000557
danielk197762079062007-08-15 17:08:46 +0000558 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000559 if( rc!=SQLITE_OK ) return rc;
560
danielk197765839c62007-08-30 08:08:17 +0000561 if( len>=nMaster ){
562 return SQLITE_OK;
563 }
564
danielk197762079062007-08-15 17:08:46 +0000565 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000566 if( rc!=SQLITE_OK ) return rc;
567
danielk197762079062007-08-15 17:08:46 +0000568 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000569 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
570
danielk197765839c62007-08-30 08:08:17 +0000571 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000572 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000573 return rc;
574 }
danielk197765839c62007-08-30 08:08:17 +0000575 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000576
577 /* See if the checksum matches the master journal name */
shane0b8d2762008-07-22 05:18:00 +0000578 for(u=0; u<len; u++){
579 cksum -= zMaster[u];
danielk197765839c62007-08-30 08:08:17 +0000580 }
danielk19778191bff2004-06-28 04:52:30 +0000581 if( cksum ){
582 /* If the checksum doesn't add up, then one or more of the disk sectors
583 ** containing the master journal filename is corrupted. This means
584 ** definitely roll back, so just return SQLITE_OK and report a (nul)
585 ** master-journal filename.
586 */
danielk197765839c62007-08-30 08:08:17 +0000587 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000588 }
danielk197776572402004-06-25 02:38:54 +0000589
590 return SQLITE_OK;
591}
592
593/*
594** Seek the journal file descriptor to the next sector boundary where a
595** journal header may be read or written. Pager.journalOff is updated with
596** the new seek offset.
597**
598** i.e for a sector size of 512:
599**
600** Input Offset Output Offset
601** ---------------------------------------
602** 0 0
603** 512 512
604** 100 512
605** 2000 2048
606**
607*/
danielk197762079062007-08-15 17:08:46 +0000608static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000609 i64 offset = 0;
610 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000611 if( c ){
612 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
613 }
614 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
615 assert( offset>=c );
616 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
617 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000618}
619
620/*
drhf3a87622008-04-17 14:16:42 +0000621** Write zeros over the header of the journal file. This has the
622** effect of invalidating the journal file and committing the
623** transaction.
624*/
danielk1977df2566a2008-05-07 19:11:03 +0000625static int zeroJournalHdr(Pager *pPager, int doTruncate){
626 int rc = SQLITE_OK;
danielk197755a25a12008-09-11 10:29:15 +0000627 static const char zeroHdr[28] = {0};
drhf3a87622008-04-17 14:16:42 +0000628
danielk1977df2566a2008-05-07 19:11:03 +0000629 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000630 i64 iLimit = pPager->journalSizeLimit;
631
danielk1977df2566a2008-05-07 19:11:03 +0000632 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000633 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000634 rc = sqlite3OsTruncate(pPager->jfd, 0);
635 }else{
636 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
637 }
danielk197781620542008-06-07 05:19:37 +0000638 if( rc==SQLITE_OK && !pPager->noSync ){
danielk1977df2566a2008-05-07 19:11:03 +0000639 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
640 }
danielk1977b53e4962008-06-04 06:45:59 +0000641
642 /* At this point the transaction is committed but the write lock
643 ** is still held on the file. If there is a size limit configured for
644 ** the persistent journal and the journal file currently consumes more
645 ** space than that limit allows for, truncate it now. There is no need
646 ** to sync the file following this operation.
647 */
648 if( rc==SQLITE_OK && iLimit>0 ){
649 i64 sz;
650 rc = sqlite3OsFileSize(pPager->jfd, &sz);
651 if( rc==SQLITE_OK && sz>iLimit ){
652 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
653 }
654 }
drha06ecba2008-04-22 17:15:17 +0000655 }
drhf3a87622008-04-17 14:16:42 +0000656 return rc;
657}
658
659/*
danielk197776572402004-06-25 02:38:54 +0000660** The journal file must be open when this routine is called. A journal
661** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
662** current location.
663**
664** The format for the journal header is as follows:
665** - 8 bytes: Magic identifying journal format.
666** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
667** - 4 bytes: Random number used for page hash.
668** - 4 bytes: Initial database page count.
669** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000670** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000671**
danielk197767c007b2008-03-20 04:45:49 +0000672** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000673*/
674static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000675 int rc = SQLITE_OK;
676 char *zHeader = pPager->pTmpSpace;
danielk1977d92db532008-11-17 04:56:24 +0000677 u32 nHeader = pPager->pageSize;
678 u32 nWrite;
danielk1977fd7f0452008-12-17 17:30:26 +0000679 int ii;
danielk1977a664f8e2008-04-22 14:31:48 +0000680
681 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
682 nHeader = JOURNAL_HDR_SZ(pPager);
683 }
danielk197776572402004-06-25 02:38:54 +0000684
danielk1977fd7f0452008-12-17 17:30:26 +0000685 /* If there are active savepoints and any of them were created since the
686 ** most recent journal header was written, update the PagerSavepoint.iHdrOff
687 ** fields now.
688 */
689 for(ii=0; ii<pPager->nSavepoint; ii++){
690 if( pPager->aSavepoint[ii].iHdrOffset==0 ){
691 pPager->aSavepoint[ii].iHdrOffset = pPager->journalOff;
692 }
danielk19774099f6e2007-03-19 11:25:20 +0000693 }
694
danielk197762079062007-08-15 17:08:46 +0000695 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000696 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000697
drh97b57482006-01-10 20:32:32 +0000698 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +0000699
700 /*
701 ** Write the nRec Field - the number of page records that follow this
702 ** journal header. Normally, zero is written to this value at this time.
703 ** After the records are added to the journal (and the journal synced,
704 ** if in full-sync mode), the zero is overwritten with the true number
705 ** of records (see syncJournal()).
706 **
707 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
708 ** reading the journal this value tells SQLite to assume that the
709 ** rest of the journal file contains valid page records. This assumption
710 ** is dangerous, as if a failure occured whilst writing to the journal
711 ** file it may contain some garbage data. There are two scenarios
712 ** where this risk can be ignored:
713 **
714 ** * When the pager is in no-sync mode. Corruption can follow a
715 ** power failure in this case anyway.
716 **
717 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
718 ** that garbage data is never appended to the journal file.
719 */
720 assert(pPager->fd->pMethods||pPager->noSync);
danielk1977b3175382008-10-17 18:51:52 +0000721 if( (pPager->noSync) || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY)
danielk19774cd2cd52007-08-23 14:48:23 +0000722 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
723 ){
724 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
725 }else{
726 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
727 }
728
drh97b57482006-01-10 20:32:32 +0000729 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +0000730 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +0000731 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
732 /* The initial database size */
danielk19773460d192008-12-27 15:23:13 +0000733 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbOrigSize);
drh97b57482006-01-10 20:32:32 +0000734 /* The assumed sector size for this process */
735 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
drh08609ce2008-11-29 22:49:23 +0000736
737 /* Initializing the tail of the buffer is not necessary. Everything
738 ** works find if the following memset() is omitted. But initializing
739 ** the memory prevents valgrind from complaining, so we are willing to
740 ** take the performance hit.
741 */
742 memset(&zHeader[sizeof(aJournalMagic)+16], 0,
743 nHeader-(sizeof(aJournalMagic)+16));
744
danielk197767c007b2008-03-20 04:45:49 +0000745 if( pPager->journalHdr==0 ){
746 /* The page size */
747 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
748 }
danielk197776572402004-06-25 02:38:54 +0000749
danielk1977a664f8e2008-04-22 14:31:48 +0000750 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
751 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
752 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
753 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +0000754 }
danielk1977a664f8e2008-04-22 14:31:48 +0000755
danielk197776572402004-06-25 02:38:54 +0000756 return rc;
757}
758
759/*
760** The journal file must be open when this is called. A journal header file
761** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
762** file. See comments above function writeJournalHdr() for a description of
763** the journal header format.
764**
765** If the header is read successfully, *nRec is set to the number of
766** page records following this header and *dbSize is set to the size of the
767** database before the transaction began, in pages. Also, pPager->cksumInit
768** is set to the value read from the journal header. SQLITE_OK is returned
769** in this case.
770**
771** If the journal header file appears to be corrupted, SQLITE_DONE is
772** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
773** cannot be read from the journal file an error code is returned.
774*/
775static int readJournalHdr(
776 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000777 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000778 u32 *pNRec,
779 u32 *pDbSize
780){
781 int rc;
782 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000783 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +0000784 int iPageSize;
danielk197776572402004-06-25 02:38:54 +0000785
danielk197762079062007-08-15 17:08:46 +0000786 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000787 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
788 return SQLITE_DONE;
789 }
danielk197762079062007-08-15 17:08:46 +0000790 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000791
danielk197762079062007-08-15 17:08:46 +0000792 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000793 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000794 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000795
796 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
797 return SQLITE_DONE;
798 }
799
danielk197762079062007-08-15 17:08:46 +0000800 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000801 if( rc ) return rc;
802
danielk197762079062007-08-15 17:08:46 +0000803 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000804 if( rc ) return rc;
805
danielk197762079062007-08-15 17:08:46 +0000806 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000807 if( rc ) return rc;
808
danielk197767c007b2008-03-20 04:45:49 +0000809 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
810 if( rc==SQLITE_OK
811 && iPageSize>=512
812 && iPageSize<=SQLITE_MAX_PAGE_SIZE
813 && ((iPageSize-1)&iPageSize)==0
814 ){
drh4f21c4a2008-12-10 22:15:00 +0000815 u16 pagesize = (u16)iPageSize;
danielk197767c007b2008-03-20 04:45:49 +0000816 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
817 }
818 if( rc ) return rc;
819
danielk197776572402004-06-25 02:38:54 +0000820 /* Update the assumed sector-size to match the value used by
821 ** the process that created this journal. If this journal was
822 ** created by a process other than this one, then this routine
823 ** is being called from within pager_playback(). The local value
824 ** of Pager.sectorSize is restored at the end of that routine.
825 */
drh98c58352008-11-07 00:24:53 +0000826 rc = read32bits(pPager->jfd, jrnlOff+12, &pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000827 if( rc ) return rc;
drh98c58352008-11-07 00:24:53 +0000828 if( (pPager->sectorSize & (pPager->sectorSize-1))!=0
829 || pPager->sectorSize>0x1000000 ){
830 return SQLITE_DONE;
831 }
danielk197776572402004-06-25 02:38:54 +0000832
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;
danielk1977df2566a2008-05-07 19:11:03 +0000862 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +0000863 u32 cksum = 0;
864 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000865
danielk1977b3175382008-10-17 18:51:52 +0000866 if( !zMaster || pPager->setMaster ) return SQLITE_OK;
867 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ) return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000868 pPager->setMaster = 1;
869
drhea678832008-12-10 19:26:22 +0000870 len = sqlite3Strlen30(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000871 for(i=0; i<len; i++){
872 cksum += zMaster[i];
873 }
danielk197776572402004-06-25 02:38:54 +0000874
875 /* If in full-sync mode, advance to the next disk sector before writing
876 ** the master journal name. This is in case the previous page written to
877 ** the journal has already been synced.
878 */
879 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000880 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000881 }
danielk197762079062007-08-15 17:08:46 +0000882 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000883 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000884
danielk197762079062007-08-15 17:08:46 +0000885 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000886 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000887 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000888
danielk197762079062007-08-15 17:08:46 +0000889 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000890 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000891 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000892
drh97b57482006-01-10 20:32:32 +0000893 put32bits(zBuf, len);
894 put32bits(&zBuf[4], cksum);
895 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000896 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +0000897 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +0000898 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +0000899
900 /* If the pager is in peristent-journal mode, then the physical
901 ** journal-file may extend past the end of the master-journal name
902 ** and 8 bytes of magic data just written to the file. This is
903 ** dangerous because the code to rollback a hot-journal file
904 ** will not be able to find the master-journal name to determine
905 ** whether or not the journal is hot.
906 **
907 ** Easiest thing to do in this scenario is to truncate the journal
908 ** file to the required size.
909 */
910 if( (rc==SQLITE_OK)
911 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
912 && jrnlSize>jrnlOff
913 ){
914 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
915 }
danielk197776572402004-06-25 02:38:54 +0000916 return rc;
917}
918
919/*
drhed7c8552001-04-11 14:29:21 +0000920** Find a page in the hash table given its page number. Return
921** a pointer to the page or NULL if not found.
922*/
drhd9b02572001-04-15 00:37:09 +0000923static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000924 PgHdr *p;
danielk19778c0a7912008-08-20 14:49:23 +0000925 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &p);
drhed7c8552001-04-11 14:29:21 +0000926 return p;
927}
928
929/*
danielk1977e180dd92007-04-05 17:15:52 +0000930** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000931** sets the state of the pager back to what it was when it was first
932** opened. Any outstanding pages are invalidated and subsequent attempts
933** to access those pages will likely result in a coredump.
934*/
drhd9b02572001-04-15 00:37:09 +0000935static void pager_reset(Pager *pPager){
danielk1977efaaf572006-01-16 11:29:19 +0000936 if( pPager->errCode ) return;
danielk19778c0a7912008-08-20 14:49:23 +0000937 sqlite3PcacheClear(pPager->pPCache);
danielk1977e277be02007-03-23 18:12:06 +0000938}
939
danielk197734cf35d2008-12-18 18:31:38 +0000940/*
941** Free all structures in the Pager.aSavepoint[] array and set both
942** Pager.aSavepoint and Pager.nSavepoint to zero. Close the sub-journal
943** if it is open and the pager is not in exclusive mode.
944*/
danielk1977fd7f0452008-12-17 17:30:26 +0000945static void releaseAllSavepoint(Pager *pPager){
946 int ii;
947 for(ii=0; ii<pPager->nSavepoint; ii++){
948 sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
949 }
950 if( !pPager->exclusiveMode ){
951 sqlite3OsClose(pPager->sjfd);
952 }
953 sqlite3_free(pPager->aSavepoint);
954 pPager->aSavepoint = 0;
955 pPager->nSavepoint = 0;
danielk197767ddef62008-12-23 19:15:56 +0000956 pPager->stmtNRec = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000957}
958
danielk197734cf35d2008-12-18 18:31:38 +0000959/*
960** Set the bit number pgno in the PagerSavepoint.pInSavepoint bitvecs of
961** all open savepoints.
962*/
danielk1977fd7f0452008-12-17 17:30:26 +0000963static int addToSavepointBitvecs(Pager *pPager, Pgno pgno){
964 int ii;
965 for(ii=0; ii<pPager->nSavepoint; ii++){
966 PagerSavepoint *p = &pPager->aSavepoint[ii];
967 if( pgno<=p->nOrig ){
968 /* TODO: malloc() failure handling */
969 sqlite3BitvecSet(p->pInSavepoint, pgno);
970 }
971 }
972 return SQLITE_OK;
973}
974
danielk1977e277be02007-03-23 18:12:06 +0000975/*
danielk1977ae72d982007-10-03 08:46:44 +0000976** Unlock the database file.
977**
978** If the pager is currently in error state, discard the contents of
979** the cache and reset the Pager structure internal state. If there is
980** an open journal-file, then the next time a shared-lock is obtained
981** on the pager file (by this or any other process), it will be
982** treated as a hot-journal and rolled back.
983*/
984static void pager_unlock(Pager *pPager){
985 if( !pPager->exclusiveMode ){
danielk1977b3175382008-10-17 18:51:52 +0000986 int rc = osUnlock(pPager->fd, NO_LOCK);
987 if( rc ) pPager->errCode = rc;
danielk1977d92db532008-11-17 04:56:24 +0000988 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +0000989 IOTRACE(("UNLOCK %p\n", pPager))
danielk1977ae72d982007-10-03 08:46:44 +0000990
danielk1977b3175382008-10-17 18:51:52 +0000991 /* Always close the journal file when dropping the database lock.
992 ** Otherwise, another connection with journal_mode=delete might
993 ** delete the file out from under us.
994 */
995 if( pPager->journalOpen ){
996 sqlite3OsClose(pPager->jfd);
997 pPager->journalOpen = 0;
998 sqlite3BitvecDestroy(pPager->pInJournal);
999 pPager->pInJournal = 0;
1000 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
1001 pPager->pAlwaysRollback = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001002 }
1003
danielk1977b3175382008-10-17 18:51:52 +00001004 /* If Pager.errCode is set, the contents of the pager cache cannot be
1005 ** trusted. Now that the pager file is unlocked, the contents of the
1006 ** cache can be discarded and the error code safely cleared.
1007 */
1008 if( pPager->errCode ){
1009 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
1010 pager_reset(pPager);
danielk1977fd7f0452008-12-17 17:30:26 +00001011 releaseAllSavepoint(pPager);
danielk1977b3175382008-10-17 18:51:52 +00001012 pPager->journalOff = 0;
1013 pPager->journalStarted = 0;
danielk19773460d192008-12-27 15:23:13 +00001014 pPager->dbOrigSize = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001015 }
danielk1977b3175382008-10-17 18:51:52 +00001016
1017 pPager->state = PAGER_UNLOCK;
1018 pPager->changeCountDone = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001019 }
1020}
1021
1022/*
1023** Execute a rollback if a transaction is active and unlock the
1024** database file. If the pager has already entered the error state,
1025** do not attempt the rollback.
1026*/
1027static void pagerUnlockAndRollback(Pager *p){
danielk1977ae72d982007-10-03 08:46:44 +00001028 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
danielk19772d1d86f2008-06-20 14:59:51 +00001029 sqlite3BeginBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001030 sqlite3PagerRollback(p);
danielk19772d1d86f2008-06-20 14:59:51 +00001031 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001032 }
1033 pager_unlock(p);
danielk1977ae72d982007-10-03 08:46:44 +00001034}
1035
1036/*
drh80e35f42007-03-30 14:06:34 +00001037** This routine ends a transaction. A transaction is ended by either
1038** a COMMIT or a ROLLBACK.
1039**
drhed7c8552001-04-11 14:29:21 +00001040** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001041** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1042** the database lock and acquires a SHARED lock in its place if that is
1043** the appropriate thing to do. Release locks usually is appropriate,
1044** unless we are in exclusive access mode or unless this is a
1045** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1046**
1047** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001048**
1049** TODO: Consider keeping the journal file open for temporary databases.
1050** This might give a performance improvement on windows where opening
1051** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001052*/
danielk1977df2566a2008-05-07 19:11:03 +00001053static int pager_end_transaction(Pager *pPager, int hasMaster){
danielk197741483462007-03-24 16:45:04 +00001054 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001055 int rc2 = SQLITE_OK;
drha6abd042004-06-09 17:37:22 +00001056 if( pPager->state<PAGER_RESERVED ){
1057 return SQLITE_OK;
1058 }
danielk1977fd7f0452008-12-17 17:30:26 +00001059 releaseAllSavepoint(pPager);
drhda47d772002-12-02 04:25:19 +00001060 if( pPager->journalOpen ){
danielk1977b3175382008-10-17 18:51:52 +00001061 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
1062 int isMemoryJournal = sqlite3IsMemJournal(pPager->jfd);
1063 sqlite3OsClose(pPager->jfd);
1064 pPager->journalOpen = 0;
1065 if( !isMemoryJournal ){
1066 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
1067 }
1068 }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE
drh04335882008-09-26 21:08:08 +00001069 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){
1070 pPager->journalOff = 0;
1071 pPager->journalStarted = 0;
1072 }else if( pPager->exclusiveMode
danielk197793f7af92008-05-09 16:57:50 +00001073 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
1074 ){
1075 rc = zeroJournalHdr(pPager, hasMaster);
1076 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +00001077 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001078 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001079 }else{
drh04335882008-09-26 21:08:08 +00001080 assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE || rc );
danielk1977b4b47412007-08-17 15:53:36 +00001081 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001082 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +00001083 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +00001084 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001085 }
danielk197741483462007-03-24 16:45:04 +00001086 }
drhf5e7bb52008-02-18 14:47:33 +00001087 sqlite3BitvecDestroy(pPager->pInJournal);
1088 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +00001089 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
1090 pPager->pAlwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001091#ifdef SQLITE_CHECK_PAGES
danielk1977bc2ca9e2008-11-13 14:28:28 +00001092 sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash);
danielk19773c407372005-02-15 02:54:14 +00001093#endif
danielk1977bc2ca9e2008-11-13 14:28:28 +00001094 sqlite3PcacheCleanAll(pPager->pPCache);
danielk1977ef317ab2004-06-23 10:43:10 +00001095 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001096 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001097 }else{
drhf5e7bb52008-02-18 14:47:33 +00001098 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001099 }
danielk1977979f38e2007-03-27 16:19:51 +00001100
danielk197741483462007-03-24 16:45:04 +00001101 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001102 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001103 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001104 }else if( pPager->state==PAGER_SYNCED ){
1105 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001106 }
danielk19773460d192008-12-27 15:23:13 +00001107 pPager->dbOrigSize = 0;
danielk197776572402004-06-25 02:38:54 +00001108 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001109 pPager->needSync = 0;
danielk19778c0a7912008-08-20 14:49:23 +00001110 /* lruListSetFirstSynced(pPager); */
danielk1977b3175382008-10-17 18:51:52 +00001111 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00001112 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00001113 }
drhd138c012008-05-13 00:58:18 +00001114 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001115
1116 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001117}
1118
drhed7c8552001-04-11 14:29:21 +00001119/*
drh968af522003-02-11 14:55:40 +00001120** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001121**
1122** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001123** random initial value and the page number. We experimented with
1124** a checksum of the entire data, but that was found to be too slow.
1125**
1126** Note that the page number is stored at the beginning of data and
1127** the checksum is stored at the end. This is important. If journal
1128** corruption occurs due to a power failure, the most likely scenario
1129** is that one end or the other of the record will be changed. It is
1130** much less likely that the two ends of the journal record will be
1131** correct and the middle be corrupt. Thus, this "checksum" scheme,
1132** though fast and simple, catches the mostly likely kind of corruption.
1133**
1134** FIX ME: Consider adding every 200th (or so) byte of the data to the
1135** checksum. That way if a single page spans 3 or more disk sectors and
1136** only the middle sector is corrupt, we will still have a reasonable
1137** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001138*/
drh74161702006-02-24 02:53:49 +00001139static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001140 u32 cksum = pPager->cksumInit;
1141 int i = pPager->pageSize-200;
1142 while( i>0 ){
1143 cksum += aData[i];
1144 i -= 200;
1145 }
drh968af522003-02-11 14:55:40 +00001146 return cksum;
1147}
1148
1149/*
drhfa86c412002-02-02 15:01:15 +00001150** Read a single page from the journal file opened on file descriptor
1151** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001152**
drhc13148f2008-08-27 18:03:20 +00001153** The isMainJrnl flag is true if this is the main rollback journal and
1154** false for the statement journal. The main rollback journal uses
1155** checksums - the statement journal does not.
drhfa86c412002-02-02 15:01:15 +00001156*/
danielk197762079062007-08-15 17:08:46 +00001157static int pager_playback_one_page(
danielk1977fd7f0452008-12-17 17:30:26 +00001158 Pager *pPager, /* The pager being played back */
1159 int isMainJrnl, /* 1 -> main journal. 0 -> sub-journal. */
1160 i64 offset, /* Offset of record to playback */
danielk1977ecfef982008-12-20 08:39:57 +00001161 int isSavepnt, /* True for a savepoint rollback */
danielk1977fd7f0452008-12-17 17:30:26 +00001162 Bitvec *pDone /* Bitvec of pages already played back */
danielk197762079062007-08-15 17:08:46 +00001163){
drhfa86c412002-02-02 15:01:15 +00001164 int rc;
drhae2b40c2004-06-09 19:03:54 +00001165 PgHdr *pPg; /* An existing page in the cache */
1166 Pgno pgno; /* The page number of a page in journal */
1167 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001168 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
danielk1977fd7f0452008-12-17 17:30:26 +00001169 sqlite3_file *jfd = (isMainJrnl ? pPager->jfd : pPager->sjfd);
drhfa86c412002-02-02 15:01:15 +00001170
danielk1977fd7f0452008-12-17 17:30:26 +00001171 /* The temp storage must be allocated at this point */
danielk19778186df82007-03-06 13:45:59 +00001172 assert( aData );
danielk1977488af092008-12-19 16:31:11 +00001173 assert( isMainJrnl || pDone );
danielk1977ecfef982008-12-20 08:39:57 +00001174 assert( isSavepnt || pDone==0 );
drh96362842005-03-20 22:47:56 +00001175
danielk197762079062007-08-15 17:08:46 +00001176 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001177 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001178 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001179 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001180 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001181
drh968af522003-02-11 14:55:40 +00001182 /* Sanity checking on the page. This is more important that I originally
1183 ** thought. If a power failure occurs while the journal is being written,
1184 ** it could cause invalid data to be written into the journal. We need to
1185 ** detect this invalid data (with high probability) and ignore it.
1186 */
danielk197775edc162004-06-26 01:48:18 +00001187 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001188 return SQLITE_DONE;
1189 }
danielk1977fd7f0452008-12-17 17:30:26 +00001190 if( pgno>(Pgno)pPager->dbSize || sqlite3BitvecTest(pDone, pgno) ){
drh968af522003-02-11 14:55:40 +00001191 return SQLITE_OK;
1192 }
drhc13148f2008-08-27 18:03:20 +00001193 if( isMainJrnl ){
danielk197762079062007-08-15 17:08:46 +00001194 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001195 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001196 pPager->journalOff += 4;
danielk1977ecfef982008-12-20 08:39:57 +00001197 if( !isSavepnt && pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001198 return SQLITE_DONE;
1199 }
1200 }
danielk1977fd7f0452008-12-17 17:30:26 +00001201 if( pDone && (rc = sqlite3BitvecSet(pDone, pgno)) ){
1202 return rc;
1203 }
drhfa86c412002-02-02 15:01:15 +00001204
danielk1977aa5ccdf2004-06-14 05:10:42 +00001205 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001206
1207 /* If the pager is in RESERVED state, then there must be a copy of this
1208 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001209 ** not the database file. The page is left marked dirty in this case.
1210 **
danielk19772df71c72007-05-24 07:22:42 +00001211 ** An exception to the above rule: If the database is in no-sync mode
1212 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001213 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1214 ** during a Movepage() call, then the page may not be in the cache
1215 ** either. So the condition described in the above paragraph is not
1216 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001217 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001218 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1219 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001220 **
1221 ** Ticket #1171: The statement journal might contain page content that is
1222 ** different from the page content at the start of the transaction.
1223 ** This occurs when a page is changed prior to the start of a statement
1224 ** then changed again within the statement. When rolling back such a
1225 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001226 ** for certain that original page contents are synced into the main rollback
1227 ** journal. Otherwise, a power loss might leave modified data in the
1228 ** database file without an entry in the rollback journal that can
1229 ** restore the database to its original form. Two conditions must be
1230 ** met before writing to the database files. (1) the database must be
1231 ** locked. (2) we know that the original page content is fully synced
1232 ** in the main journal either because the page is not in cache or else
1233 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001234 **
1235 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1236 ** is possible to fail a statement on a database that does not yet exist.
1237 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001238 */
drhae2b40c2004-06-09 19:03:54 +00001239 pPg = pager_lookup(pPager, pgno);
danielk1977ecfef982008-12-20 08:39:57 +00001240 PAGERTRACE5("PLAYBACK %d page %d hash(%08x) %s\n",
1241 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData),
1242 (isMainJrnl?"main-journal":"sub-journal")
1243 );
danielk19778c0a7912008-08-20 14:49:23 +00001244 if( (pPager->state>=PAGER_EXCLUSIVE)
1245 && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC))
1246 && (pPager->fd->pMethods)
1247 ){
drh281b21d2008-08-22 12:57:08 +00001248 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
1249 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst);
danielk19773460d192008-12-27 15:23:13 +00001250 if( pgno>pPager->dbFileSize ){
1251 pPager->dbFileSize = pgno;
1252 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001253 }
drhfa86c412002-02-02 15:01:15 +00001254 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001255 /* No page should ever be explicitly rolled back that is in use, except
1256 ** for page 1 which is held in use in order to keep the lock on the
1257 ** database active. However such a page may be rolled back as a result
1258 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001259 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001260 */
drhb6f41482004-05-14 01:58:11 +00001261 void *pData;
danielk19778c0a7912008-08-20 14:49:23 +00001262 pData = pPg->pData;
drhae2b40c2004-06-09 19:03:54 +00001263 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001264 if( pPager->xReiniter ){
danielk1977eaa06f62008-09-18 17:34:44 +00001265 pPager->xReiniter(pPg);
drhde647132004-05-07 17:57:49 +00001266 }
danielk1977ecfef982008-12-20 08:39:57 +00001267 if( isMainJrnl && (!isSavepnt || pPager->journalOff<=pPager->journalHdr) ){
danielk1977488af092008-12-19 16:31:11 +00001268 /* If the contents of this page were just restored from the main
1269 ** journal file, then its content must be as they were when the
1270 ** transaction was first opened. In this case we can mark the page
1271 ** as clean, since there will be no need to write it out to the.
1272 **
1273 ** There is one exception to this rule. If the page is being rolled
1274 ** back as part of a savepoint (or statement) rollback from an
1275 ** unsynced portion of the main journal file, then it is not safe
1276 ** to mark the page as clean. This is because marking the page as
1277 ** clean will clear the PGHDR_NEED_SYNC flag. Since the page is
1278 ** already in the journal file (recorded in Pager.pInJournal) and
1279 ** the PGHDR_NEED_SYNC flag is cleared, if the page is written to
1280 ** again within this transaction, it will be marked as dirty but
1281 ** the PGHDR_NEED_SYNC flag will not be set. It could then potentially
1282 ** be written out into the database file before its journal file
1283 ** segment is synced. If a crash occurs during or following this,
1284 ** database corruption may ensue.
1285 */
drhc047b9f2008-11-21 03:23:43 +00001286 sqlite3PcacheMakeClean(pPg);
1287 }
danielk19773c407372005-02-15 02:54:14 +00001288#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001289 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001290#endif
drh86a88112007-04-16 15:02:19 +00001291 /* If this was page 1, then restore the value of Pager.dbFileVers.
1292 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001293 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001294 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001295 }
drh86a88112007-04-16 15:02:19 +00001296
1297 /* Decode the page just read from disk */
1298 CODEC1(pPager, pData, pPg->pgno, 3);
danielk19778c0a7912008-08-20 14:49:23 +00001299 sqlite3PcacheRelease(pPg);
drhfa86c412002-02-02 15:01:15 +00001300 }
1301 return rc;
1302}
1303
1304/*
danielk197713adf8a2004-06-03 16:08:41 +00001305** Parameter zMaster is the name of a master journal file. A single journal
1306** file that referred to the master journal file has just been rolled back.
1307** This routine checks if it is possible to delete the master journal file,
1308** and does so if it is.
drh726de592004-06-10 23:35:50 +00001309**
danielk197765839c62007-08-30 08:08:17 +00001310** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1311** available for use within this function.
1312**
1313**
drh726de592004-06-10 23:35:50 +00001314** The master journal file contains the names of all child journals.
1315** To tell if a master journal can be deleted, check to each of the
1316** children. If all children are either missing or do not refer to
1317** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001318*/
danielk1977b4b47412007-08-17 15:53:36 +00001319static int pager_delmaster(Pager *pPager, const char *zMaster){
1320 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001321 int rc;
1322 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001323 sqlite3_file *pMaster;
1324 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001325 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001326 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001327
1328 /* Open the master journal file exclusively in case some other process
1329 ** is running this routine also. Not that it makes too much difference.
1330 */
drhe5ae5732008-06-15 02:51:47 +00001331 pMaster = (sqlite3_file *)sqlite3Malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001332 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001333 if( !pMaster ){
1334 rc = SQLITE_NOMEM;
1335 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001336 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1337 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001338 }
danielk197713adf8a2004-06-03 16:08:41 +00001339 if( rc!=SQLITE_OK ) goto delmaster_out;
1340 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001341
1342 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001343 if( rc!=SQLITE_OK ) goto delmaster_out;
1344
1345 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001346 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001347 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001348 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001349
1350 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001351 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001352 */
drh4f21c4a2008-12-10 22:15:00 +00001353 zMasterJournal = (char *)sqlite3Malloc((int)nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001354 if( !zMasterJournal ){
1355 rc = SQLITE_NOMEM;
1356 goto delmaster_out;
1357 }
danielk197765839c62007-08-30 08:08:17 +00001358 zMasterPtr = &zMasterJournal[nMasterJournal];
drh4f21c4a2008-12-10 22:15:00 +00001359 rc = sqlite3OsRead(pMaster, zMasterJournal, (int)nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001360 if( rc!=SQLITE_OK ) goto delmaster_out;
1361
danielk19775865e3d2004-06-14 06:03:57 +00001362 zJournal = zMasterJournal;
1363 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977861f7452008-06-05 11:39:11 +00001364 int exists;
1365 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
1366 if( rc!=SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001367 goto delmaster_out;
1368 }
danielk1977861f7452008-06-05 11:39:11 +00001369 if( exists ){
danielk197713adf8a2004-06-03 16:08:41 +00001370 /* One of the journals pointed to by the master journal exists.
1371 ** Open it and check if it points at the master journal. If
1372 ** so, return without deleting the master journal file.
1373 */
drh3b7b78b2004-11-24 01:16:43 +00001374 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001375 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1376 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001377 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001378 goto delmaster_out;
1379 }
danielk197713adf8a2004-06-03 16:08:41 +00001380
danielk197765839c62007-08-30 08:08:17 +00001381 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001382 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001383 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001384 goto delmaster_out;
1385 }
danielk197776572402004-06-25 02:38:54 +00001386
danielk197765839c62007-08-30 08:08:17 +00001387 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001388 if( c ){
danielk197776572402004-06-25 02:38:54 +00001389 /* We have a match. Do not delete the master journal file. */
1390 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001391 }
1392 }
drhea678832008-12-10 19:26:22 +00001393 zJournal += (sqlite3Strlen30(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001394 }
1395 }
1396
danielk1977fee2d252007-08-18 10:59:19 +00001397 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001398
1399delmaster_out:
1400 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001401 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001402 }
1403 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001404 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001405 }
danielk1977b4b47412007-08-17 15:53:36 +00001406 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001407 return rc;
1408}
1409
drha6abd042004-06-09 17:37:22 +00001410
danielk1977e180dd92007-04-05 17:15:52 +00001411static void pager_truncate_cache(Pager *pPager);
1412
drha6abd042004-06-09 17:37:22 +00001413/*
drhcb4c40b2004-08-18 19:09:43 +00001414** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001415** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001416**
1417** Might might be the case that the file on disk is smaller than nPage.
1418** This can happen, for example, if we are in the middle of a transaction
1419** which has extended the file size and the new pages are still all held
1420** in cache, then an INSERT or UPDATE does a statement rollback. Some
1421** operating system implementations can get confused if you try to
1422** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001423** so detect this case and write a single zero byte to the end of the new
1424** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001425*/
danielk1977d92db532008-11-17 04:56:24 +00001426static int pager_truncate(Pager *pPager, Pgno nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001427 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001428 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001429 i64 currentSize, newSize;
1430 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1431 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001432 if( rc==SQLITE_OK && currentSize!=newSize ){
1433 if( currentSize>newSize ){
1434 rc = sqlite3OsTruncate(pPager->fd, newSize);
1435 }else{
1436 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1437 }
danielk19773460d192008-12-27 15:23:13 +00001438 if( rc==SQLITE_OK ){
1439 pPager->dbFileSize = nPage;
1440 }
drh7fe3f7e2007-11-29 18:44:27 +00001441 }
danielk1977e180dd92007-04-05 17:15:52 +00001442 }
1443 if( rc==SQLITE_OK ){
1444 pPager->dbSize = nPage;
1445 pager_truncate_cache(pPager);
1446 }
1447 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001448}
1449
1450/*
drhc80f0582007-05-01 16:59:48 +00001451** Set the sectorSize for the given pager.
1452**
drh334c80d2008-03-28 17:41:13 +00001453** The sector size is at least as big as the sector size reported
1454** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001455*/
1456static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001457 assert(pPager->fd->pMethods||pPager->tempFile);
1458 if( !pPager->tempFile ){
1459 /* Sector size doesn't matter for temporary files. Also, the file
1460 ** may not have been opened yet, in whcih case the OsSectorSize()
1461 ** call will segfault.
1462 */
1463 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1464 }
drh334c80d2008-03-28 17:41:13 +00001465 if( pPager->sectorSize<512 ){
1466 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001467 }
1468}
1469
1470/*
drhed7c8552001-04-11 14:29:21 +00001471** Playback the journal and thus restore the database file to
1472** the state it was in before we started making changes.
1473**
drh34e79ce2004-02-08 06:05:46 +00001474** The journal file format is as follows:
1475**
drhae2b40c2004-06-09 19:03:54 +00001476** (1) 8 byte prefix. A copy of aJournalMagic[].
1477** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001478** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001479** number of page records from the journal size.
1480** (3) 4 byte big-endian integer which is the initial value for the
1481** sanity checksum.
1482** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001483** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001484** (5) 4 byte big-endian integer which is the sector size. The header
1485** is this many bytes in size.
1486** (6) 4 byte big-endian integer which is the page case.
1487** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001488** name. The value may be zero (indicate that there is no master
1489** journal.)
drh334c80d2008-03-28 17:41:13 +00001490** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001491** and might be shorter than the value read from (5). If the first byte
1492** of the name is \000 then there is no master journal. The master
1493** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001494** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001495** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001496** + pPager->pageSize bytes of data.
1497** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001498**
drh334c80d2008-03-28 17:41:13 +00001499** When we speak of the journal header, we mean the first 8 items above.
1500** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001501**
1502** Call the value from the second bullet "nRec". nRec is the number of
1503** valid page entries in the journal. In most cases, you can compute the
1504** value of nRec from the size of the journal file. But if a power
1505** failure occurred while the journal was being written, it could be the
1506** case that the size of the journal file had already been increased but
1507** the extra entries had not yet made it safely to disk. In such a case,
1508** the value of nRec computed from the file size would be too large. For
1509** that reason, we always use the nRec value in the header.
1510**
1511** If the nRec value is 0xffffffff it means that nRec should be computed
1512** from the file size. This value is used when the user selects the
1513** no-sync option for the journal. A power failure could lead to corruption
1514** in this case. But for things like temporary table (which will be
1515** deleted when the power is restored) we don't care.
1516**
drhd9b02572001-04-15 00:37:09 +00001517** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001518** journal file then all pages up to the first corrupted page are rolled
1519** back (or no pages if the journal header is corrupted). The journal file
1520** is then deleted and SQLITE_OK returned, just as if no corruption had
1521** been encountered.
1522**
1523** If an I/O or malloc() error occurs, the journal-file is not deleted
1524** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001525*/
danielk1977e277be02007-03-23 18:12:06 +00001526static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001527 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001528 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001529 u32 nRec; /* Number of Records in the journal */
shane0b8d2762008-07-22 05:18:00 +00001530 u32 u; /* Unsigned loop counter */
drhd9b02572001-04-15 00:37:09 +00001531 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001532 int rc; /* Result code of a subroutine */
danielk1977861f7452008-06-05 11:39:11 +00001533 int res = 1; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001534 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001535
drhc3a64ba2001-11-22 00:01:27 +00001536 /* Figure out how many records are in the journal. Abort early if
1537 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001538 */
drh8cfbf082001-09-19 13:22:39 +00001539 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001540 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001541 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001542 goto end_playback;
1543 }
drh240c5792004-02-08 00:40:52 +00001544
danielk197776572402004-06-25 02:38:54 +00001545 /* Read the master journal name from the journal, if it is present.
1546 ** If a master journal file name is specified, but the file is not
1547 ** present on disk, then the journal is not hot and does not need to be
1548 ** played back.
drh240c5792004-02-08 00:40:52 +00001549 */
danielk197765839c62007-08-30 08:08:17 +00001550 zMaster = pPager->pTmpSpace;
1551 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977861f7452008-06-05 11:39:11 +00001552 if( rc==SQLITE_OK && zMaster[0] ){
1553 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
drhc3a64ba2001-11-22 00:01:27 +00001554 }
danielk197765839c62007-08-30 08:08:17 +00001555 zMaster = 0;
danielk1977861f7452008-06-05 11:39:11 +00001556 if( rc!=SQLITE_OK || !res ){
danielk1977ce98bba2008-04-03 10:13:01 +00001557 goto end_playback;
1558 }
1559 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001560
danielk197776572402004-06-25 02:38:54 +00001561 /* This loop terminates either when the readJournalHdr() call returns
1562 ** SQLITE_DONE or an IO error occurs. */
1563 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001564
danielk197776572402004-06-25 02:38:54 +00001565 /* Read the next journal header from the journal file. If there are
1566 ** not enough bytes left in the journal file for a complete header, or
1567 ** it is corrupted, then a process must of failed while writing it.
1568 ** This indicates nothing more needs to be rolled back.
1569 */
1570 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1571 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001572 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001573 rc = SQLITE_OK;
1574 }
danielk197776572402004-06-25 02:38:54 +00001575 goto end_playback;
1576 }
1577
1578 /* If nRec is 0xffffffff, then this journal was created by a process
1579 ** working in no-sync mode. This means that the rest of the journal
1580 ** file consists of pages, there are no more journal headers. Compute
1581 ** the value of nRec based on this assumption.
1582 */
1583 if( nRec==0xffffffff ){
1584 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
drh4f21c4a2008-12-10 22:15:00 +00001585 nRec = (int)((szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager));
danielk197776572402004-06-25 02:38:54 +00001586 }
1587
danielk1977e277be02007-03-23 18:12:06 +00001588 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001589 ** process and if this is the final header in the journal, then it means
1590 ** that this part of the journal was being filled but has not yet been
1591 ** synced to disk. Compute the number of pages based on the remaining
1592 ** size of the file.
1593 **
1594 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001595 */
drh8940f4e2007-08-11 00:26:20 +00001596 if( nRec==0 && !isHot &&
1597 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
drh4f21c4a2008-12-10 22:15:00 +00001598 nRec = (int)((szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager));
danielk1977e277be02007-03-23 18:12:06 +00001599 }
1600
danielk197776572402004-06-25 02:38:54 +00001601 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001602 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001603 */
danielk1977e180dd92007-04-05 17:15:52 +00001604 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001605 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001606 if( rc!=SQLITE_OK ){
1607 goto end_playback;
1608 }
danielk197776572402004-06-25 02:38:54 +00001609 }
1610
danielk197776572402004-06-25 02:38:54 +00001611 /* Copy original pages out of the journal and back into the database file.
1612 */
shane0b8d2762008-07-22 05:18:00 +00001613 for(u=0; u<nRec; u++){
danielk1977ecfef982008-12-20 08:39:57 +00001614 rc = pager_playback_one_page(pPager, 1, pPager->journalOff, 0, 0);
danielk197776572402004-06-25 02:38:54 +00001615 if( rc!=SQLITE_OK ){
1616 if( rc==SQLITE_DONE ){
1617 rc = SQLITE_OK;
1618 pPager->journalOff = szJ;
1619 break;
1620 }else{
drha9625ea2008-09-03 00:08:29 +00001621 /* If we are unable to rollback, then the database is probably
1622 ** going to end up being corrupt. It is corrupt to us, anyhow.
1623 ** Perhaps the next process to come along can fix it....
1624 */
danielk197798c21902008-09-23 16:41:29 +00001625 rc = SQLITE_CORRUPT_BKPT;
danielk197776572402004-06-25 02:38:54 +00001626 goto end_playback;
1627 }
1628 }
drh968af522003-02-11 14:55:40 +00001629 }
drhed7c8552001-04-11 14:29:21 +00001630 }
drh580eeaf2006-02-24 03:09:37 +00001631 /*NOTREACHED*/
1632 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001633
1634end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001635 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001636 zMaster = pPager->pTmpSpace;
1637 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1638 }
1639 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001640 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001641 }
danielk1977c56774e2008-10-07 11:51:20 +00001642 if( rc==SQLITE_OK && zMaster[0] && res ){
danielk1977979f38e2007-03-27 16:19:51 +00001643 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001644 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001645 */
danielk197765839c62007-08-30 08:08:17 +00001646 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001647 }
danielk197776572402004-06-25 02:38:54 +00001648
1649 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001650 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001651 ** value. Reset it to the correct value for this process.
1652 */
drhc80f0582007-05-01 16:59:48 +00001653 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001654 return rc;
drhed7c8552001-04-11 14:29:21 +00001655}
1656
1657/*
danielk1977fd7f0452008-12-17 17:30:26 +00001658** Playback a savepoint.
drhfa86c412002-02-02 15:01:15 +00001659*/
danielk1977fd7f0452008-12-17 17:30:26 +00001660static int pagerPlaybackSavepoint(Pager *pPager, PagerSavepoint *pSavepoint){
drheb206252004-10-01 02:00:31 +00001661 i64 szJ; /* Size of the full journal */
danielk1977fd7f0452008-12-17 17:30:26 +00001662 i64 iHdrOff; /* End of first segment of main-journal records */
1663 Pgno ii; /* Loop counter */
1664 int rc; /* Return code */
1665 Bitvec *pDone = 0; /* Bitvec to ensure pages played back only once */
drhfa86c412002-02-02 15:01:15 +00001666
danielk1977fd7f0452008-12-17 17:30:26 +00001667 /* Allocate a bitvec to use to store the set of pages rolled back */
1668 if( pSavepoint ){
1669 pDone = sqlite3BitvecCreate(pSavepoint->nOrig);
1670 if( !pDone ){
1671 return SQLITE_NOMEM;
1672 }
danielk197776572402004-06-25 02:38:54 +00001673 }
danielk1977fd7f0452008-12-17 17:30:26 +00001674
1675 /* Truncate the database back to the size it was before the
1676 ** savepoint being reverted was opened.
drhfa86c412002-02-02 15:01:15 +00001677 */
danielk19773460d192008-12-27 15:23:13 +00001678 rc = pager_truncate(pPager, pSavepoint?pSavepoint->nOrig:pPager->dbOrigSize);
drh1aa2d8b2007-01-03 15:34:29 +00001679 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001680
danielk1977fd7f0452008-12-17 17:30:26 +00001681 /* Now roll back all main journal file records that occur after byte
1682 ** byte offset PagerSavepoint.iOffset that have a page number less than
1683 ** or equal to PagerSavepoint.nOrig. As each record is played back,
1684 ** the corresponding bit in bitvec PagerSavepoint.pInSavepoint is
1685 ** cleared.
drhfa86c412002-02-02 15:01:15 +00001686 */
danielk1977fd7f0452008-12-17 17:30:26 +00001687 szJ = pPager->journalOff;
1688 if( pSavepoint ){
1689 iHdrOff = pSavepoint->iHdrOffset ? pSavepoint->iHdrOffset : szJ;
1690 pPager->journalOff = pSavepoint->iOffset;
1691 while( rc==SQLITE_OK && pPager->journalOff<iHdrOff ){
danielk1977ecfef982008-12-20 08:39:57 +00001692 rc = pager_playback_one_page(pPager, 1, pPager->journalOff, 1, pDone);
danielk1977fd7f0452008-12-17 17:30:26 +00001693 assert( rc!=SQLITE_DONE );
1694 }
1695 }else{
1696 pPager->journalOff = 0;
drhfa86c412002-02-02 15:01:15 +00001697 }
danielk1977fd7f0452008-12-17 17:30:26 +00001698 while( rc==SQLITE_OK && pPager->journalOff<szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001699 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001700 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001701 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
danielk1977fd7f0452008-12-17 17:30:26 +00001702 assert( rc!=SQLITE_DONE );
danielk1977f0113002006-01-24 12:09:17 +00001703 if( nJRec==0 ){
danielk1977fd7f0452008-12-17 17:30:26 +00001704 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001705 }
danielk197712dd5492008-12-18 15:45:07 +00001706 for(ii=0; rc==SQLITE_OK && ii<nJRec && pPager->journalOff<szJ; ii++){
danielk1977ecfef982008-12-20 08:39:57 +00001707 rc = pager_playback_one_page(pPager, 1, pPager->journalOff, 1, pDone);
danielk197776572402004-06-25 02:38:54 +00001708 assert( rc!=SQLITE_DONE );
danielk1977fd7f0452008-12-17 17:30:26 +00001709 }
1710 }
1711 assert( rc!=SQLITE_OK || pPager->journalOff==szJ );
1712
1713 /* Now roll back pages from the sub-journal. */
1714 if( pSavepoint ){
1715 for(ii=pSavepoint->iSubRec; rc==SQLITE_OK && ii<pPager->stmtNRec; ii++){
1716 i64 offset = ii*(4+pPager->pageSize);
danielk1977ecfef982008-12-20 08:39:57 +00001717 rc = pager_playback_one_page(pPager, 0, offset, 1, pDone);
danielk1977fd7f0452008-12-17 17:30:26 +00001718 assert( rc!=SQLITE_DONE );
danielk197776572402004-06-25 02:38:54 +00001719 }
drhfa86c412002-02-02 15:01:15 +00001720 }
danielk197776572402004-06-25 02:38:54 +00001721
danielk1977fd7f0452008-12-17 17:30:26 +00001722 sqlite3BitvecDestroy(pDone);
1723 if( rc==SQLITE_OK ){
danielk197775edc162004-06-26 01:48:18 +00001724 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001725 }
1726 return rc;
1727}
1728
1729/*
drhf57b14a2001-09-14 18:54:08 +00001730** Change the maximum number of in-memory pages that are allowed.
1731*/
danielk19773b8a05f2007-03-19 17:44:26 +00001732void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
danielk19778c0a7912008-08-20 14:49:23 +00001733 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001734}
1735
1736/*
drh973b6e32003-02-12 14:09:42 +00001737** Adjust the robustness of the database to damage due to OS crashes
1738** or power failures by changing the number of syncs()s when writing
1739** the rollback journal. There are three levels:
1740**
drh054889e2005-11-30 03:20:31 +00001741** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001742** for temporary and transient files.
1743**
1744** NORMAL The journal is synced once before writes begin on the
1745** database. This is normally adequate protection, but
1746** it is theoretically possible, though very unlikely,
1747** that an inopertune power failure could leave the journal
1748** in a state which would cause damage to the database
1749** when it is rolled back.
1750**
1751** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001752** database (with some additional information - the nRec field
1753** of the journal header - being written in between the two
1754** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001755** single disk sector is atomic, then this mode provides
1756** assurance that the journal will not be corrupted to the
1757** point of causing damage to the database during rollback.
1758**
1759** Numeric values associated with these states are OFF==1, NORMAL=2,
1760** and FULL=3.
1761*/
danielk197793758c82005-01-21 08:13:14 +00001762#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh281b21d2008-08-22 12:57:08 +00001763void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){
drh4f21c4a2008-12-10 22:15:00 +00001764 pPager->noSync = (level==1 || pPager->tempFile) ?1:0;
1765 pPager->fullSync = (level==3 && !pPager->tempFile) ?1:0;
drh281b21d2008-08-22 12:57:08 +00001766 pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001767 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001768}
danielk197793758c82005-01-21 08:13:14 +00001769#endif
drh973b6e32003-02-12 14:09:42 +00001770
1771/*
drhaf6df112005-06-07 02:12:30 +00001772** The following global variable is incremented whenever the library
1773** attempts to open a temporary file. This information is used for
1774** testing and analysis only.
1775*/
drh0f7eb612006-08-08 13:51:43 +00001776#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001777int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001778#endif
drhaf6df112005-06-07 02:12:30 +00001779
1780/*
drh3f56e6e2007-03-15 01:16:47 +00001781** Open a temporary file.
1782**
1783** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001784** other error code if we fail. The OS will automatically delete the temporary
1785** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001786*/
danielk1977b4b47412007-08-17 15:53:36 +00001787static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00001788 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00001789 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00001790 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00001791){
drhfa86c412002-02-02 15:01:15 +00001792 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001793
drh0f7eb612006-08-08 13:51:43 +00001794#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001795 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001796#endif
danielk1977b4b47412007-08-17 15:53:36 +00001797
drh33f4e022007-09-03 15:19:34 +00001798 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
1799 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00001800 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00001801 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00001802 return rc;
1803}
1804
danielk1977a858aa22008-08-22 16:22:17 +00001805static int pagerStress(void *,PgHdr *);
danielk19778c0a7912008-08-20 14:49:23 +00001806
drhfa86c412002-02-02 15:01:15 +00001807/*
drhed7c8552001-04-11 14:29:21 +00001808** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001809** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001810** the first call to sqlite3PagerGet() and is only held open until the
1811** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001812**
drh6446c4d2001-12-15 14:22:18 +00001813** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00001814** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00001815** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001816**
1817** If zFilename is ":memory:" then all information is held in cache.
1818** It is never written to disk. This can be used to implement an
1819** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001820*/
danielk19773b8a05f2007-03-19 17:44:26 +00001821int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001822 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001823 Pager **ppPager, /* Return the Pager structure here */
1824 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001825 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00001826 int flags, /* flags controlling this file */
1827 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00001828){
danielk1977b4b47412007-08-17 15:53:36 +00001829 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001830 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001831 int rc = SQLITE_OK;
1832 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001833 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001834 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001835 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001836 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1837 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977b3175382008-10-17 18:51:52 +00001838 int journalFileSize;
danielk19778c0a7912008-08-20 14:49:23 +00001839 int pcacheSize = sqlite3PcacheSize();
drhfacf0302008-06-17 15:12:00 +00001840 int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00001841 char *zPathname = 0;
1842 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001843
danielk1977b3175382008-10-17 18:51:52 +00001844 if( sqlite3JournalSize(pVfs)>sqlite3MemJournalSize() ){
1845 journalFileSize = sqlite3JournalSize(pVfs);
1846 }else{
1847 journalFileSize = sqlite3MemJournalSize();
1848 }
1849
drh86f8c192007-08-22 00:39:19 +00001850 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001851 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001852
danielk197717b90b52008-06-06 11:11:25 +00001853 /* Compute and store the full pathname in an allocated buffer pointed
1854 ** to by zPathname, length nPathname. Or, if this is a temporary file,
1855 ** leave both nPathname and zPathname set to 0.
1856 */
drh1cc8c442007-08-24 16:08:29 +00001857 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00001858 nPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001859 zPathname = sqlite3Malloc(nPathname*2);
danielk197717b90b52008-06-06 11:11:25 +00001860 if( zPathname==0 ){
1861 return SQLITE_NOMEM;
1862 }
drh1cc8c442007-08-24 16:08:29 +00001863#ifndef SQLITE_OMIT_MEMORYDB
1864 if( strcmp(zFilename,":memory:")==0 ){
1865 memDb = 1;
1866 zPathname[0] = 0;
1867 }else
1868#endif
1869 {
danielk1977adfb9b02007-09-17 07:02:56 +00001870 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00001871 }
danielk197717b90b52008-06-06 11:11:25 +00001872 if( rc!=SQLITE_OK ){
1873 sqlite3_free(zPathname);
1874 return rc;
1875 }
drhea678832008-12-10 19:26:22 +00001876 nPathname = sqlite3Strlen30(zPathname);
drhae28c012007-08-24 16:29:23 +00001877 }
drh99b90c32008-03-17 13:50:58 +00001878
danielk1977b4b47412007-08-17 15:53:36 +00001879 /* Allocate memory for the pager structure */
1880 pPager = sqlite3MallocZero(
1881 sizeof(*pPager) + /* Pager structure */
danielk19778c0a7912008-08-20 14:49:23 +00001882 pcacheSize + /* PCache object */
danielk1977c7b60172007-08-22 11:22:03 +00001883 journalFileSize + /* The journal file structure */
danielk1977b3175382008-10-17 18:51:52 +00001884 pVfs->szOsFile + /* The main db file */
1885 journalFileSize * 2 + /* The two journal files */
danielk197717b90b52008-06-06 11:11:25 +00001886 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00001887 );
1888 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00001889 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00001890 return SQLITE_NOMEM;
1891 }
danielk19778c0a7912008-08-20 14:49:23 +00001892 pPager->pPCache = (PCache *)&pPager[1];
1893 pPtr = ((u8 *)&pPager[1]) + pcacheSize;
drh33f4e022007-09-03 15:19:34 +00001894 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00001895 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977fd7f0452008-12-17 17:30:26 +00001896 pPager->sjfd = (sqlite3_file*)&pPtr[pVfs->szOsFile];
danielk1977b3175382008-10-17 18:51:52 +00001897 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile+journalFileSize];
1898 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile+2*journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00001899 pPager->zDirectory = &pPager->zFilename[nPathname+1];
1900 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00001901 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00001902 if( zPathname ){
1903 memcpy(pPager->zFilename, zPathname, nPathname+1);
1904 sqlite3_free(zPathname);
1905 }
danielk1977b4b47412007-08-17 15:53:36 +00001906
drh153c62c2007-08-24 03:51:33 +00001907 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00001908 */
drhae28c012007-08-24 16:29:23 +00001909 if( zFilename && zFilename[0] && !memDb ){
danielk1977d92db532008-11-17 04:56:24 +00001910 if( nPathname>(pVfs->mxPathname - (int)sizeof("-journal")) ){
drh1cc8c442007-08-24 16:08:29 +00001911 rc = SQLITE_CANTOPEN;
1912 }else{
drh1cc8c442007-08-24 16:08:29 +00001913 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00001914 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
1915 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00001916 readOnly = (fout&SQLITE_OPEN_READONLY);
1917
1918 /* If the file was successfully opened for read/write access,
1919 ** choose a default page size in case we have to create the
1920 ** database file. The default page size is the maximum of:
1921 **
1922 ** + SQLITE_DEFAULT_PAGE_SIZE,
1923 ** + The value returned by sqlite3OsSectorSize()
1924 ** + The largest page size that can be written atomically.
1925 */
1926 if( rc==SQLITE_OK && !readOnly ){
1927 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
drhfacf0302008-06-17 15:12:00 +00001928 if( szPageDflt<iSectorSize ){
1929 szPageDflt = iSectorSize;
drh1cc8c442007-08-24 16:08:29 +00001930 }
danielk19779663b8f2007-08-24 11:52:28 +00001931#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00001932 {
1933 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
1934 int ii;
1935 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1936 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1937 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
drhfacf0302008-06-17 15:12:00 +00001938 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
1939 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii;
danielk19779663b8f2007-08-24 11:52:28 +00001940 }
danielk1977b4b47412007-08-17 15:53:36 +00001941 }
drh1cc8c442007-08-24 16:08:29 +00001942#endif
drhfacf0302008-06-17 15:12:00 +00001943 if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
1944 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
drh1cc8c442007-08-24 16:08:29 +00001945 }
danielk19778def5ea2004-06-16 10:39:52 +00001946 }
drhac69b052004-05-12 13:30:07 +00001947 }
danielk1977b3175382008-10-17 18:51:52 +00001948 }else{
danielk19777a2b1ee2007-08-21 14:27:01 +00001949 /* If a temporary file is requested, it is not opened immediately.
1950 ** In this case we accept the default page size and delay actually
1951 ** opening the file until the first call to OsWrite().
danielk1977b3175382008-10-17 18:51:52 +00001952 **
1953 ** This branch is also run for an in-memory database. An in-memory
1954 ** database is the same as a temp-file that is never written out to
1955 ** disk and uses an in-memory rollback journal.
danielk19777a2b1ee2007-08-21 14:27:01 +00001956 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001957 tempFile = 1;
1958 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001959 }
danielk1977aef0bf62005-12-30 16:28:01 +00001960
danielk1977b4b47412007-08-17 15:53:36 +00001961 if( pPager && rc==SQLITE_OK ){
drhfacf0302008-06-17 15:12:00 +00001962 pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt);
drh3e7a6092002-12-07 21:45:14 +00001963 }
danielk1977aef0bf62005-12-30 16:28:01 +00001964
drh153c62c2007-08-24 03:51:33 +00001965 /* If an error occured in either of the blocks above.
1966 ** Free the Pager structure and close the file.
1967 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00001968 ** any Pager.errMask variables.
1969 */
danielk1977b4b47412007-08-17 15:53:36 +00001970 if( !pPager || !pPager->pTmpSpace ){
1971 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001972 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001973 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001974 }
danielk19778c0a7912008-08-20 14:49:23 +00001975 nExtra = FORCE_ALIGNMENT(nExtra);
danielk197771d5d2c2008-09-29 11:49:47 +00001976 sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
drh41d30272008-08-20 21:47:45 +00001977 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
danielk1977aef0bf62005-12-30 16:28:01 +00001978
drh153c62c2007-08-24 03:51:33 +00001979 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
1980 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00001981
danielk1977b4b47412007-08-17 15:53:36 +00001982 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00001983 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
drhea678832008-12-10 19:26:22 +00001984 for(i=sqlite3Strlen30(pPager->zDirectory);
1985 i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001986 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001987
drh99b90c32008-03-17 13:50:58 +00001988 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00001989 if( zPathname ){
1990 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
1991 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
1992 }else{
1993 pPager->zJournal = 0;
1994 }
danielk1977b4b47412007-08-17 15:53:36 +00001995
drh3b59a5c2006-01-15 20:28:28 +00001996 /* pPager->journalOpen = 0; */
drh4f21c4a2008-12-10 22:15:00 +00001997 pPager->useJournal = (u8)useJournal;
1998 pPager->noReadlock = (noReadlock && readOnly) ?1:0;
drh3b59a5c2006-01-15 20:28:28 +00001999 /* pPager->stmtOpen = 0; */
2000 /* pPager->stmtInUse = 0; */
2001 /* pPager->nRef = 0; */
drh4f21c4a2008-12-10 22:15:00 +00002002 pPager->dbSizeValid = (u8)memDb;
drhfacf0302008-06-17 15:12:00 +00002003 pPager->pageSize = szPageDflt;
drh3b59a5c2006-01-15 20:28:28 +00002004 /* pPager->stmtSize = 0; */
2005 /* pPager->stmtJSize = 0; */
2006 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002007 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002008 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002009 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002010 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002011 /* pPager->errMask = 0; */
drh4f21c4a2008-12-10 22:15:00 +00002012 pPager->tempFile = (u8)tempFile;
drh369339d2007-03-30 16:01:55 +00002013 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2014 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2015 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
drh4f21c4a2008-12-10 22:15:00 +00002016 pPager->exclusiveMode = (u8)tempFile;
2017 pPager->memDb = (u8)memDb;
2018 pPager->readOnly = (u8)readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002019 /* pPager->needSync = 0; */
drh4f21c4a2008-12-10 22:15:00 +00002020 pPager->noSync = (pPager->tempFile || !useJournal) ?1:0;
2021 pPager->fullSync = pPager->noSync ?0:1;
danielk1977f036aef2007-08-20 05:36:51 +00002022 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002023 /* pPager->pFirst = 0; */
2024 /* pPager->pFirstSynced = 0; */
2025 /* pPager->pLast = 0; */
danielk19778c0a7912008-08-20 14:49:23 +00002026 pPager->nExtra = nExtra;
danielk1977b53e4962008-06-04 06:45:59 +00002027 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk1977b3175382008-10-17 18:51:52 +00002028 assert(pPager->fd->pMethods||tempFile);
2029 setSectorSize(pPager);
2030 if( memDb ){
2031 pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
danielk1977b4721172007-03-19 05:54:48 +00002032 }
danielk19771ceedd32008-11-19 10:22:33 +00002033 /* pPager->xBusyHandler = 0; */
2034 /* pPager->pBusyHandlerArg = 0; */
drh3b59a5c2006-01-15 20:28:28 +00002035 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002036 *ppPager = pPager;
2037 return SQLITE_OK;
2038}
2039
2040/*
drh90f5ecb2004-07-22 01:19:35 +00002041** Set the busy handler function.
2042*/
danielk19771ceedd32008-11-19 10:22:33 +00002043void sqlite3PagerSetBusyhandler(
2044 Pager *pPager,
2045 int (*xBusyHandler)(void *),
2046 void *pBusyHandlerArg
2047){
2048 pPager->xBusyHandler = xBusyHandler;
2049 pPager->pBusyHandlerArg = pBusyHandlerArg;
drh90f5ecb2004-07-22 01:19:35 +00002050}
2051
2052/*
drha6abd042004-06-09 17:37:22 +00002053** Set the reinitializer for this pager. If not NULL, the reinitializer
2054** is called when the content of a page in cache is restored to its original
2055** value as a result of a rollback. The callback gives higher-level code
2056** an opportunity to restore the EXTRA section to agree with the restored
2057** page data.
2058*/
danielk1977eaa06f62008-09-18 17:34:44 +00002059void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*)){
drha6abd042004-06-09 17:37:22 +00002060 pPager->xReiniter = xReinit;
2061}
2062
2063/*
danielk1977a1644fd2007-08-29 12:31:25 +00002064** Set the page size to *pPageSize. If the suggest new page size is
2065** inappropriate, then an alternative page size is set to that
2066** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002067*/
danielk1977a1644fd2007-08-29 12:31:25 +00002068int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
danielk19771357d9f2008-09-16 05:12:24 +00002069 int rc = pPager->errCode;
2070 if( rc==SQLITE_OK ){
2071 u16 pageSize = *pPageSize;
2072 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
2073 if( pageSize && pageSize!=pPager->pageSize
2074 && (pPager->memDb==0 || pPager->dbSize==0)
2075 && sqlite3PcacheRefCount(pPager->pPCache)==0
2076 ){
2077 char *pNew = (char *)sqlite3PageMalloc(pageSize);
2078 if( !pNew ){
2079 rc = SQLITE_NOMEM;
2080 }else{
2081 pager_reset(pPager);
2082 pPager->pageSize = pageSize;
2083 if( !pPager->memDb ) setSectorSize(pPager);
2084 sqlite3PageFree(pPager->pTmpSpace);
2085 pPager->pTmpSpace = pNew;
2086 sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
2087 }
danielk1977a1644fd2007-08-29 12:31:25 +00002088 }
drh4f21c4a2008-12-10 22:15:00 +00002089 *pPageSize = (u16)pPager->pageSize;
drh1c7880e2005-05-20 20:01:55 +00002090 }
danielk1977a1644fd2007-08-29 12:31:25 +00002091 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002092}
2093
2094/*
drh26b79942007-11-28 16:19:56 +00002095** Return a pointer to the "temporary page" buffer held internally
2096** by the pager. This is a buffer that is big enough to hold the
2097** entire content of a database page. This buffer is used internally
2098** during rollback and will be overwritten whenever a rollback
2099** occurs. But other modules are free to use it too, as long as
2100** no rollbacks are happening.
2101*/
2102void *sqlite3PagerTempSpace(Pager *pPager){
2103 return pPager->pTmpSpace;
2104}
2105
2106/*
drhf8e632b2007-05-08 14:51:36 +00002107** Attempt to set the maximum database page count if mxPage is positive.
2108** Make no changes if mxPage is zero or negative. And never reduce the
2109** maximum page count below the current size of the database.
2110**
2111** Regardless of mxPage, return the current maximum page count.
2112*/
2113int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2114 if( mxPage>0 ){
2115 pPager->mxPgno = mxPage;
2116 }
danielk1977ad0132d2008-06-07 08:58:22 +00002117 sqlite3PagerPagecount(pPager, 0);
drhf8e632b2007-05-08 14:51:36 +00002118 return pPager->mxPgno;
2119}
2120
2121/*
drhc9ac5ca2005-11-04 22:03:30 +00002122** The following set of routines are used to disable the simulated
2123** I/O error mechanism. These routines are used to avoid simulated
2124** errors in places where we do not care about errors.
2125**
2126** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2127** and generate no code.
2128*/
2129#ifdef SQLITE_TEST
2130extern int sqlite3_io_error_pending;
2131extern int sqlite3_io_error_hit;
2132static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002133void disable_simulated_io_errors(void){
2134 saved_cnt = sqlite3_io_error_pending;
2135 sqlite3_io_error_pending = -1;
2136}
2137void enable_simulated_io_errors(void){
2138 sqlite3_io_error_pending = saved_cnt;
2139}
2140#else
drh152410f2005-11-05 15:11:22 +00002141# define disable_simulated_io_errors()
2142# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002143#endif
2144
2145/*
drh90f5ecb2004-07-22 01:19:35 +00002146** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002147** that pDest points to.
2148**
2149** No error checking is done. The rational for this is that this function
2150** may be called even if the file does not exist or contain a header. In
2151** these cases sqlite3OsRead() will return an error, to which the correct
2152** response is to zero the memory at pDest and continue. A real IO error
2153** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002154*/
danielk19773b8a05f2007-03-19 17:44:26 +00002155int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002156 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002157 memset(pDest, 0, N);
danielk1977b3175382008-10-17 18:51:52 +00002158 assert(pPager->fd->pMethods||pPager->tempFile);
danielk19777a2b1ee2007-08-21 14:27:01 +00002159 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002160 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002161 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002162 if( rc==SQLITE_IOERR_SHORT_READ ){
2163 rc = SQLITE_OK;
2164 }
drh90f5ecb2004-07-22 01:19:35 +00002165 }
drh551b7732006-11-06 21:20:25 +00002166 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002167}
2168
2169/*
drh5e00f6c2001-09-13 13:46:56 +00002170** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002171** pPager.
2172**
2173** If the PENDING_BYTE lies on the page directly after the end of the
2174** file, then consider this page part of the file too. For example, if
2175** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2176** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002177*/
danielk1977ad0132d2008-06-07 08:58:22 +00002178int sqlite3PagerPagecount(Pager *pPager, int *pnPage){
danielk19777a2b1ee2007-08-21 14:27:01 +00002179 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002180 int rc;
drhd9b02572001-04-15 00:37:09 +00002181 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002182 if( pPager->errCode ){
danielk19778c0a7912008-08-20 14:49:23 +00002183 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002184 return rc;
drha7aea3d2007-03-15 12:51:16 +00002185 }
danielk1977d92db532008-11-17 04:56:24 +00002186 if( pPager->dbSizeValid ){
danielk197715f411d2005-09-16 10:18:45 +00002187 n = pPager->dbSize;
2188 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002189 assert(pPager->fd->pMethods||pPager->tempFile);
2190 if( (pPager->fd->pMethods)
2191 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002192 pager_error(pPager, rc);
danielk1977ad0132d2008-06-07 08:58:22 +00002193 return rc;
danielk197715f411d2005-09-16 10:18:45 +00002194 }
2195 if( n>0 && n<pPager->pageSize ){
2196 n = 1;
2197 }else{
2198 n /= pPager->pageSize;
2199 }
2200 if( pPager->state!=PAGER_UNLOCK ){
danielk19773460d192008-12-27 15:23:13 +00002201 pPager->dbSize = (Pgno)n;
2202 pPager->dbFileSize = (Pgno)n;
danielk1977d92db532008-11-17 04:56:24 +00002203 pPager->dbSizeValid = 1;
danielk197715f411d2005-09-16 10:18:45 +00002204 }
drhed7c8552001-04-11 14:29:21 +00002205 }
danielk197715f411d2005-09-16 10:18:45 +00002206 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002207 n++;
2208 }
drhf8e632b2007-05-08 14:51:36 +00002209 if( n>pPager->mxPgno ){
drh4f21c4a2008-12-10 22:15:00 +00002210 pPager->mxPgno = (Pgno)n;
drhf8e632b2007-05-08 14:51:36 +00002211 }
danielk1977ad0132d2008-06-07 08:58:22 +00002212 if( pnPage ){
drh4f21c4a2008-12-10 22:15:00 +00002213 *pnPage = (int)n;
danielk1977ad0132d2008-06-07 08:58:22 +00002214 }
2215 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002216}
2217
2218/*
drhf7c57532003-04-25 13:22:51 +00002219** Forward declaration
2220*/
danielk197776572402004-06-25 02:38:54 +00002221static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002222
2223/*
danielk1977e180dd92007-04-05 17:15:52 +00002224** This routine is used to truncate the cache when a database
2225** is truncated. Drop from the cache all pages whose pgno is
2226** larger than pPager->dbSize and is unreferenced.
2227**
drhac69b052004-05-12 13:30:07 +00002228** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002229**
2230** Actually, at the point this routine is called, it would be
2231** an error to have a referenced page. But rather than delete
2232** that page and guarantee a subsequent segfault, it seems better
2233** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002234*/
danielk1977e180dd92007-04-05 17:15:52 +00002235static void pager_truncate_cache(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00002236 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
drhac69b052004-05-12 13:30:07 +00002237}
2238
drhf7c57532003-04-25 13:22:51 +00002239/*
danielk197717221812005-02-15 03:38:05 +00002240** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002241** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002242** false or until the lock succeeds.
2243**
2244** Return SQLITE_OK on success and an error code if we cannot obtain
2245** the lock.
2246*/
2247static int pager_wait_on_lock(Pager *pPager, int locktype){
2248 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002249
2250 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002251 assert( PAGER_SHARED==SHARED_LOCK );
2252 assert( PAGER_RESERVED==RESERVED_LOCK );
2253 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002254
2255 /* If the file is currently unlocked then the size must be unknown */
danielk1977d92db532008-11-17 04:56:24 +00002256 assert( pPager->state>=PAGER_SHARED || pPager->dbSizeValid==0 );
drh1aa2d8b2007-01-03 15:34:29 +00002257
danielk197717221812005-02-15 03:38:05 +00002258 if( pPager->state>=locktype ){
2259 rc = SQLITE_OK;
2260 }else{
danielk197717221812005-02-15 03:38:05 +00002261 do {
drh054889e2005-11-30 03:20:31 +00002262 rc = sqlite3OsLock(pPager->fd, locktype);
danielk19771ceedd32008-11-19 10:22:33 +00002263 }while( rc==SQLITE_BUSY && pPager->xBusyHandler(pPager->pBusyHandlerArg) );
danielk197717221812005-02-15 03:38:05 +00002264 if( rc==SQLITE_OK ){
drh4f21c4a2008-12-10 22:15:00 +00002265 pPager->state = (u8)locktype;
drhb0603412007-02-28 04:47:26 +00002266 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002267 }
2268 }
2269 return rc;
2270}
2271
2272/*
danielk19773460d192008-12-27 15:23:13 +00002273** Truncate the file to the number of pages specified.
2274**
2275** Unless an IO error occurs, this function is guaranteed to modify the
2276** database file itself. If an exclusive lock is not held when this function
2277** is called, one is obtained before truncating the file.
drhf7c57532003-04-25 13:22:51 +00002278*/
danielk19773b8a05f2007-03-19 17:44:26 +00002279int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
danielk19778c0a7912008-08-20 14:49:23 +00002280 int rc = SQLITE_OK;
danielk1977b3175382008-10-17 18:51:52 +00002281 assert( pPager->state>=PAGER_SHARED );
danielk19778c0a7912008-08-20 14:49:23 +00002282
danielk1977ad0132d2008-06-07 08:58:22 +00002283 sqlite3PagerPagecount(pPager, 0);
danielk1977efaaf572006-01-16 11:29:19 +00002284 if( pPager->errCode ){
2285 rc = pPager->errCode;
danielk19773460d192008-12-27 15:23:13 +00002286 }else if( nPage<pPager->dbFileSize ){
danielk1977b3175382008-10-17 18:51:52 +00002287 rc = syncJournal(pPager);
2288 if( rc==SQLITE_OK ){
2289 /* Get an exclusive lock on the database before truncating. */
2290 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2291 }
2292 if( rc==SQLITE_OK ){
2293 rc = pager_truncate(pPager, nPage);
danielk19778c0a7912008-08-20 14:49:23 +00002294 }
danielk1977369f27e2004-06-15 11:40:04 +00002295 }
danielk197717221812005-02-15 03:38:05 +00002296
drhf7c57532003-04-25 13:22:51 +00002297 return rc;
2298}
2299
danielk19773460d192008-12-27 15:23:13 +00002300#ifndef SQLITE_OMIT_AUTOVACUUM
2301/*
2302** Truncate the in-memory database file image to nPage pages. Unlike
2303** sqlite3PagerTruncate(), this function does not actually modify the
2304** database file on disk. It just sets the internal state of the pager
2305** object so that the truncation will be done when the current
2306** transaction is committed.
2307*/
2308void sqlite3PagerTruncateImage(Pager *pPager, Pgno nPage){
2309 assert( pPager->dbSizeValid );
2310 assert( pPager->dbSize>=nPage );
2311 pPager->dbSize = nPage;
2312}
2313
2314/*
2315** Return the current size of the database file image in pages. This
2316** function differs from sqlite3PagerPagecount() in two ways:
2317**
2318** a) It may only be called when at least one reference to a database
2319** page is held. This guarantees that the database size is already
2320** known and a call to sqlite3OsFileSize() is not required.
2321**
2322** b) The return value is not adjusted for the locking page.
2323*/
2324Pgno sqlite3PagerImageSize(Pager *pPager){
2325 assert( pPager->dbSizeValid );
2326 return pPager->dbSize;
2327}
2328#endif /* ifndef SQLITE_OMIT_AUTOVACUUM */
2329
drhf7c57532003-04-25 13:22:51 +00002330/*
drhed7c8552001-04-11 14:29:21 +00002331** Shutdown the page cache. Free all memory and close all files.
2332**
2333** If a transaction was in progress when this routine is called, that
2334** transaction is rolled back. All outstanding pages are invalidated
2335** and their memory is freed. Any attempt to use a page associated
2336** with this page cache after this function returns will likely
2337** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002338**
2339** This function always succeeds. If a transaction is active an attempt
2340** is made to roll it back. If an error occurs during the rollback
2341** a hot journal may be left in the filesystem but no error is returned
2342** to the caller.
drhed7c8552001-04-11 14:29:21 +00002343*/
danielk19773b8a05f2007-03-19 17:44:26 +00002344int sqlite3PagerClose(Pager *pPager){
danielk197713f72992005-12-18 08:51:22 +00002345
drhbafda092007-01-03 23:36:22 +00002346 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002347 sqlite3BeginBenignMalloc();
drhc2ee76c2007-01-04 14:58:14 +00002348 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002349 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002350 pager_reset(pPager);
danielk1977b3175382008-10-17 18:51:52 +00002351 if( !MEMDB ){
2352 pagerUnlockAndRollback(pPager);
2353 }
drhbafda092007-01-03 23:36:22 +00002354 enable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002355 sqlite3EndBenignMalloc();
drh4f0c5872007-03-26 22:05:01 +00002356 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002357 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002358 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002359 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002360 }
drhf5e7bb52008-02-18 14:47:33 +00002361 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977a1fa00d2008-08-27 15:16:33 +00002362 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
danielk1977fd7f0452008-12-17 17:30:26 +00002363 releaseAllSavepoint(pPager);
danielk1977b4b47412007-08-17 15:53:36 +00002364 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002365 /* Temp files are automatically deleted by the OS
2366 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002367 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002368 ** }
2369 */
danielk1977aca790a2005-01-13 11:07:52 +00002370
drhfacf0302008-06-17 15:12:00 +00002371 sqlite3PageFree(pPager->pTmpSpace);
danielk19778c0a7912008-08-20 14:49:23 +00002372 sqlite3PcacheClose(pPager->pPCache);
drh17435752007-08-16 04:30:38 +00002373 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002374 return SQLITE_OK;
2375}
2376
drh87cc3b32007-05-08 21:45:27 +00002377#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002378/*
drh5e00f6c2001-09-13 13:46:56 +00002379** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002380*/
danielk19773b8a05f2007-03-19 17:44:26 +00002381Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002382 return p->pgno;
2383}
drh87cc3b32007-05-08 21:45:27 +00002384#endif
drhed7c8552001-04-11 14:29:21 +00002385
2386/*
drhdf0b3b02001-06-23 11:36:20 +00002387** Increment the reference count for a page. The input pointer is
2388** a reference to the page data.
2389*/
danielk19773b8a05f2007-03-19 17:44:26 +00002390int sqlite3PagerRef(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002391 sqlite3PcacheRef(pPg);
drh8c42ca92001-06-22 19:15:00 +00002392 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002393}
2394
2395/*
drh34e79ce2004-02-08 06:05:46 +00002396** Sync the journal. In other words, make sure all the pages that have
2397** been written to the journal have actually reached the surface of the
2398** disk. It is not safe to modify the original database file until after
2399** the journal has been synced. If the original database is modified before
2400** the journal is synced and a power failure occurs, the unsynced journal
2401** data would be lost and we would be unable to completely rollback the
2402** database changes. Database corruption would occur.
2403**
2404** This routine also updates the nRec field in the header of the journal.
2405** (See comments on the pager_playback() routine for additional information.)
2406** If the sync mode is FULL, two syncs will occur. First the whole journal
2407** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002408**
drh34e79ce2004-02-08 06:05:46 +00002409** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002410** after a power failure, so no sync occurs.
2411**
2412** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2413** the database is stored, then OsSync() is never called on the journal
2414** file. In this case all that is required is to update the nRec field in
2415** the journal header.
drhfa86c412002-02-02 15:01:15 +00002416**
drh34e79ce2004-02-08 06:05:46 +00002417** This routine clears the needSync field of every page current held in
2418** memory.
drh50e5dad2001-09-15 00:57:28 +00002419*/
danielk197776572402004-06-25 02:38:54 +00002420static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002421 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002422
2423 /* Sync the journal before modifying the main database
2424 ** (assuming there is a journal and it needs to be synced.)
2425 */
danielk197776572402004-06-25 02:38:54 +00002426 if( pPager->needSync ){
danielk1977b3175382008-10-17 18:51:52 +00002427 assert( !pPager->tempFile );
2428 if( pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
danielk19774cd2cd52007-08-23 14:48:23 +00002429 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002430 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002431
danielk19774cd2cd52007-08-23 14:48:23 +00002432 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002433 /* Write the nRec value into the journal file header. If in
2434 ** full-synchronous mode, sync the journal first. This ensures that
2435 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002436 ** it as a candidate for rollback.
2437 **
2438 ** This is not required if the persistent media supports the
2439 ** SAFE_APPEND property. Because in this case it is not possible
2440 ** for garbage data to be appended to the file, the nRec field
2441 ** is populated with 0xFFFFFFFF when the journal header is written
2442 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002443 */
danielk19774cd2cd52007-08-23 14:48:23 +00002444 i64 jrnlOff;
2445 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002446 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002447 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002448 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002449 if( rc!=0 ) return rc;
2450 }
danielk197713adf8a2004-06-03 16:08:41 +00002451
danielk197762079062007-08-15 17:08:46 +00002452 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2453 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2454 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002455 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002456 }
danielk19774cd2cd52007-08-23 14:48:23 +00002457 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2458 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2459 IOTRACE(("JSYNC %p\n", pPager))
2460 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2461 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2462 );
2463 if( rc!=0 ) return rc;
2464 }
drhdb48ee02003-01-16 13:42:43 +00002465 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002466 }
drh50e5dad2001-09-15 00:57:28 +00002467 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002468
2469 /* Erase the needSync flag from every page.
2470 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00002471 sqlite3PcacheClearSyncFlags(pPager->pPCache);
drh50e5dad2001-09-15 00:57:28 +00002472 }
drh03eb96a2002-11-10 23:32:56 +00002473
drh81a20f22001-10-12 17:30:04 +00002474 return rc;
drh50e5dad2001-09-15 00:57:28 +00002475}
2476
2477/*
drh2554f8b2003-01-22 01:26:44 +00002478** Given a list of pages (connected by the PgHdr.pDirty pointer) write
danielk1977a858aa22008-08-22 16:22:17 +00002479** every one of those pages out to the database file. No calls are made
2480** to the page-cache to mark the pages as clean. It is the responsibility
2481** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark
2482** the pages as clean.
drh2554f8b2003-01-22 01:26:44 +00002483*/
2484static int pager_write_pagelist(PgHdr *pList){
2485 Pager *pPager;
2486 int rc;
2487
2488 if( pList==0 ) return SQLITE_OK;
2489 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002490
2491 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2492 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002493 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002494 **
drha6abd042004-06-09 17:37:22 +00002495 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2496 ** through an intermediate state PENDING. A PENDING lock prevents new
2497 ** readers from attaching to the database but is unsufficient for us to
2498 ** write. The idea of a PENDING lock is to prevent new readers from
2499 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002500 **
drha6abd042004-06-09 17:37:22 +00002501 ** While the pager is in the RESERVED state, the original database file
2502 ** is unchanged and we can rollback without having to playback the
2503 ** journal into the original database file. Once we transition to
2504 ** EXCLUSIVE, it means the database file has been changed and any rollback
2505 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002506 */
drh684917c2004-10-05 02:41:42 +00002507 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002508 if( rc!=SQLITE_OK ){
2509 return rc;
2510 }
2511
drh2554f8b2003-01-22 01:26:44 +00002512 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002513
2514 /* If the file has not yet been opened, open it now. */
2515 if( !pPager->fd->pMethods ){
2516 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00002517 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002518 if( rc ) return rc;
2519 }
2520
danielk1977687566d2004-11-02 12:56:41 +00002521 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002522 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002523 ** make the file smaller (presumably by auto-vacuum code). Do not write
2524 ** any such pages to the file.
2525 */
danielk197733e32162008-08-23 18:53:08 +00002526 if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
danielk197762079062007-08-15 17:08:46 +00002527 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002528 char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6);
danielk197712dd5492008-12-18 15:45:07 +00002529
drh477731b2007-06-16 03:06:27 +00002530 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2531 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002532 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002533 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002534 PAGER_INCR(sqlite3_pager_writedb_count);
2535 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002536 if( pList->pgno==1 ){
2537 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2538 }
danielk19773460d192008-12-27 15:23:13 +00002539 if( pList->pgno>pPager->dbFileSize ){
2540 pPager->dbFileSize = pList->pgno;
2541 }
danielk1977687566d2004-11-02 12:56:41 +00002542 }
2543#ifndef NDEBUG
2544 else{
drh4f0c5872007-03-26 22:05:01 +00002545 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002546 }
2547#endif
drh2554f8b2003-01-22 01:26:44 +00002548 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002549#ifdef SQLITE_CHECK_PAGES
2550 pList->pageHash = pager_pagehash(pList);
2551#endif
drh2554f8b2003-01-22 01:26:44 +00002552 pList = pList->pDirty;
2553 }
danielk19778c0a7912008-08-20 14:49:23 +00002554
drh2554f8b2003-01-22 01:26:44 +00002555 return SQLITE_OK;
2556}
2557
2558/*
danielk19778c0a7912008-08-20 14:49:23 +00002559** This function is called by the pcache layer when it has reached some
2560** soft memory limit. The argument is a pointer to a purgeable Pager
2561** object. This function attempts to make a single dirty page that has no
2562** outstanding references (if one exists) clean so that it can be recycled
2563** by the pcache layer.
drh2554f8b2003-01-22 01:26:44 +00002564*/
danielk1977a858aa22008-08-22 16:22:17 +00002565static int pagerStress(void *p, PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002566 Pager *pPager = (Pager *)p;
danielk19778c0a7912008-08-20 14:49:23 +00002567 int rc = SQLITE_OK;
drh8f2e9a12008-02-26 14:46:04 +00002568
danielk19778c200142008-08-25 07:12:28 +00002569 if( pPager->doNotSync ){
2570 return SQLITE_OK;
2571 }
2572
danielk1977a858aa22008-08-22 16:22:17 +00002573 assert( pPg->flags&PGHDR_DIRTY );
2574 if( pPager->errCode==SQLITE_OK ){
2575 if( pPg->flags&PGHDR_NEED_SYNC ){
2576 rc = syncJournal(pPager);
2577 if( rc==SQLITE_OK && pPager->fullSync &&
danielk1977b3175382008-10-17 18:51:52 +00002578 !(pPager->journalMode==PAGER_JOURNALMODE_MEMORY) &&
danielk1977a858aa22008-08-22 16:22:17 +00002579 !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
2580 ){
2581 pPager->nRec = 0;
2582 rc = writeJournalHdr(pPager);
danielk19778c0a7912008-08-20 14:49:23 +00002583 }
danielk19778c0a7912008-08-20 14:49:23 +00002584 }
danielk1977a858aa22008-08-22 16:22:17 +00002585 if( rc==SQLITE_OK ){
2586 pPg->pDirty = 0;
2587 rc = pager_write_pagelist(pPg);
2588 }
2589 if( rc!=SQLITE_OK ){
2590 pager_error(pPager, rc);
2591 }
2592 }
2593
2594 if( rc==SQLITE_OK ){
2595 sqlite3PcacheMakeClean(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00002596 }
2597 return rc;
drh2554f8b2003-01-22 01:26:44 +00002598}
2599
danielk19778c0a7912008-08-20 14:49:23 +00002600
drh2554f8b2003-01-22 01:26:44 +00002601/*
drh19db9352008-03-27 22:42:51 +00002602** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00002603** A hot journal is one that needs to be played back.
2604**
2605** If the current size of the database file is 0 but a journal file
2606** exists, that is probably an old journal left over from a prior
2607** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00002608**
2609** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00002610**
2611** This routine does not open the journal file to examine its
2612** content. Hence, the journal might contain the name of a master
2613** journal file that has been deleted, and hence not be hot. Or
2614** the header of the journal might be zeroed out. This routine
2615** does not discover these cases of a non-hot journal - if the
2616** journal file exists and is not empty this routine assumes it
2617** is hot. The pager_playback() routine will discover that the
2618** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00002619*/
danielk1977d300b8a2008-08-01 10:50:23 +00002620static int hasHotJournal(Pager *pPager, int *pExists){
danielk1977b4b47412007-08-17 15:53:36 +00002621 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977d300b8a2008-08-01 10:50:23 +00002622 int rc = SQLITE_OK;
drhea678832008-12-10 19:26:22 +00002623 int exists = 0;
2624 int locked = 0;
drh0a846f92008-08-25 17:23:29 +00002625 assert( pPager!=0 );
2626 assert( pPager->useJournal );
2627 assert( pPager->fd->pMethods );
danielk1977d300b8a2008-08-01 10:50:23 +00002628 *pExists = 0;
drh0a846f92008-08-25 17:23:29 +00002629 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
2630 if( rc==SQLITE_OK && exists ){
2631 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
2632 }
2633 if( rc==SQLITE_OK && exists && !locked ){
2634 int nPage;
2635 rc = sqlite3PagerPagecount(pPager, &nPage);
2636 if( rc==SQLITE_OK ){
2637 if( nPage==0 ){
2638 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2639 }else{
2640 *pExists = 1;
danielk1977861f7452008-06-05 11:39:11 +00002641 }
2642 }
drhbb5f18d2007-04-06 18:23:17 +00002643 }
danielk1977d300b8a2008-08-01 10:50:23 +00002644 return rc;
drh165ffe92005-03-15 17:09:30 +00002645}
2646
2647/*
danielk1977e180dd92007-04-05 17:15:52 +00002648** Read the content of page pPg out of the database file.
2649*/
2650static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2651 int rc;
danielk197762079062007-08-15 17:08:46 +00002652 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002653 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002654 assert(pPager->fd->pMethods||pPager->tempFile);
2655 if( !pPager->fd->pMethods ){
2656 return SQLITE_IOERR_SHORT_READ;
2657 }
danielk197762079062007-08-15 17:08:46 +00002658 offset = (pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002659 rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002660 PAGER_INCR(sqlite3_pager_readdb_count);
2661 PAGER_INCR(pPager->nRead);
2662 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002663 if( pgno==1 ){
danielk19778c0a7912008-08-20 14:49:23 +00002664 memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24],
drh86a88112007-04-16 15:02:19 +00002665 sizeof(pPager->dbFileVers));
2666 }
danielk197730849522008-08-21 04:35:18 +00002667 CODEC1(pPager, pPg->pData, pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002668 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2669 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002670 return rc;
2671}
2672
2673
2674/*
danielk1977e277be02007-03-23 18:12:06 +00002675** This function is called to obtain the shared lock required before
2676** data may be read from the pager cache. If the shared lock has already
2677** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002678**
2679** Immediately after obtaining the shared lock (if required), this function
2680** checks for a hot-journal file. If one is found, an emergency rollback
2681** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002682*/
2683static int pagerSharedLock(Pager *pPager){
2684 int rc = SQLITE_OK;
danielk1977d300b8a2008-08-01 10:50:23 +00002685 int isErrorReset = 0;
danielk1977e277be02007-03-23 18:12:06 +00002686
danielk1977ae72d982007-10-03 08:46:44 +00002687 /* If this database is opened for exclusive access, has no outstanding
2688 ** page references and is in an error-state, now is the chance to clear
2689 ** the error. Discard the contents of the pager-cache and treat any
2690 ** open journal file as a hot-journal.
2691 */
danielk19778c0a7912008-08-20 14:49:23 +00002692 if( !MEMDB && pPager->exclusiveMode
2693 && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode
2694 ){
danielk1977ae72d982007-10-03 08:46:44 +00002695 if( pPager->journalOpen ){
danielk1977d300b8a2008-08-01 10:50:23 +00002696 isErrorReset = 1;
danielk1977ae72d982007-10-03 08:46:44 +00002697 }
danielk1977ae72d982007-10-03 08:46:44 +00002698 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00002699 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00002700 }
2701
2702 /* If the pager is still in an error state, do not proceed. The error
2703 ** state will be cleared at some point in the future when all page
2704 ** references are dropped and the cache can be discarded.
2705 */
2706 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2707 return pPager->errCode;
2708 }
2709
danielk1977d300b8a2008-08-01 10:50:23 +00002710 if( pPager->state==PAGER_UNLOCK || isErrorReset ){
danielk1977b4b47412007-08-17 15:53:36 +00002711 sqlite3_vfs *pVfs = pPager->pVfs;
drh4f21c4a2008-12-10 22:15:00 +00002712 int isHotJournal = 0;
shane049fc212008-10-22 16:26:47 +00002713 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00002714 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
2715 if( !pPager->noReadlock ){
2716 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2717 if( rc!=SQLITE_OK ){
2718 assert( pPager->state==PAGER_UNLOCK );
2719 return pager_error(pPager, rc);
danielk1977e277be02007-03-23 18:12:06 +00002720 }
danielk1977b3175382008-10-17 18:51:52 +00002721 assert( pPager->state>=SHARED_LOCK );
2722 }
2723
2724 /* If a journal file exists, and there is no RESERVED lock on the
2725 ** database file, then it either needs to be played back or deleted.
2726 */
2727 if( !isErrorReset ){
2728 rc = hasHotJournal(pPager, &isHotJournal);
2729 if( rc!=SQLITE_OK ){
2730 goto failed;
2731 }
2732 }
2733 if( isErrorReset || isHotJournal ){
2734 /* Get an EXCLUSIVE lock on the database file. At this point it is
2735 ** important that a RESERVED lock is not obtained on the way to the
2736 ** EXCLUSIVE lock. If it were, another process might open the
2737 ** database file, detect the RESERVED lock, and conclude that the
2738 ** database is safe to read while this process is still rolling it
2739 ** back.
2740 **
2741 ** Because the intermediate RESERVED lock is not requested, the
2742 ** second process will get to this point in the code and fail to
2743 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00002744 */
danielk1977b3175382008-10-17 18:51:52 +00002745 if( pPager->state<EXCLUSIVE_LOCK ){
2746 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
danielk1977e277be02007-03-23 18:12:06 +00002747 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002748 rc = pager_error(pPager, rc);
2749 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002750 }
danielk1977b3175382008-10-17 18:51:52 +00002751 pPager->state = PAGER_EXCLUSIVE;
2752 }
2753
2754 /* Open the journal for read/write access. This is because in
2755 ** exclusive-access mode the file descriptor will be kept open and
2756 ** possibly used for a transaction later on. On some systems, the
2757 ** OsTruncate() call used in exclusive-access mode also requires
2758 ** a read/write file handle.
2759 */
2760 if( !isErrorReset && pPager->journalOpen==0 ){
2761 int res;
2762 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
2763 if( rc==SQLITE_OK ){
2764 if( res ){
2765 int fout = 0;
2766 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
2767 assert( !pPager->tempFile );
2768 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
2769 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk1977281d8bd2008-10-29 07:01:56 +00002770 if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
2771 rc = SQLITE_CANTOPEN;
danielk1977b3175382008-10-17 18:51:52 +00002772 sqlite3OsClose(pPager->jfd);
2773 }
2774 }else{
2775 /* If the journal does not exist, that means some other process
2776 ** has already rolled it back */
2777 rc = SQLITE_BUSY;
2778 }
2779 }
2780 }
2781 if( rc!=SQLITE_OK ){
danielk1977b3175382008-10-17 18:51:52 +00002782 goto failed;
2783 }
2784 pPager->journalOpen = 1;
2785 pPager->journalStarted = 0;
2786 pPager->journalOff = 0;
2787 pPager->setMaster = 0;
2788 pPager->journalHdr = 0;
2789
2790 /* Playback and delete the journal. Drop the database write
2791 ** lock and reacquire the read lock.
2792 */
2793 rc = pager_playback(pPager, 1);
2794 if( rc!=SQLITE_OK ){
2795 rc = pager_error(pPager, rc);
2796 goto failed;
2797 }
2798 assert(pPager->state==PAGER_SHARED ||
2799 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2800 );
2801 }
2802
2803 if( sqlite3PcachePagecount(pPager->pPCache)>0 ){
2804 /* The shared-lock has just been acquired on the database file
2805 ** and there are already pages in the cache (from a previous
2806 ** read or write transaction). Check to see if the database
2807 ** has been modified. If the database has changed, flush the
2808 ** cache.
2809 **
2810 ** Database changes is detected by looking at 15 bytes beginning
2811 ** at offset 24 into the file. The first 4 of these 16 bytes are
2812 ** a 32-bit counter that is incremented with each change. The
2813 ** other bytes change randomly with each file change when
2814 ** a codec is in use.
2815 **
2816 ** There is a vanishingly small chance that a change will not be
2817 ** detected. The chance of an undetected change is so small that
2818 ** it can be neglected.
2819 */
2820 char dbFileVers[sizeof(pPager->dbFileVers)];
2821 sqlite3PagerPagecount(pPager, 0);
2822
2823 if( pPager->errCode ){
2824 rc = pPager->errCode;
2825 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002826 }
2827
danielk1977d92db532008-11-17 04:56:24 +00002828 assert( pPager->dbSizeValid );
danielk1977b3175382008-10-17 18:51:52 +00002829 if( pPager->dbSize>0 ){
2830 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
2831 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
2832 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002833 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002834 }
danielk1977b3175382008-10-17 18:51:52 +00002835 }else{
2836 memset(dbFileVers, 0, sizeof(dbFileVers));
2837 }
danielk1977e277be02007-03-23 18:12:06 +00002838
danielk1977b3175382008-10-17 18:51:52 +00002839 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
2840 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002841 }
2842 }
danielk1977c5859712007-03-26 12:26:27 +00002843 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2844 if( pPager->state==PAGER_UNLOCK ){
2845 pPager->state = PAGER_SHARED;
2846 }
danielk1977e277be02007-03-23 18:12:06 +00002847 }
2848
danielk197752b472a2008-05-05 16:23:55 +00002849 failed:
2850 if( rc!=SQLITE_OK ){
2851 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
2852 pager_unlock(pPager);
2853 }
danielk1977e277be02007-03-23 18:12:06 +00002854 return rc;
2855}
2856
2857/*
drhd33d5a82007-04-26 12:11:28 +00002858** Make sure we have the content for a page. If the page was
2859** previously acquired with noContent==1, then the content was
2860** just initialized to zeros instead of being read from disk.
2861** But now we need the real data off of disk. So make sure we
2862** have it. Read it in if we do not have it already.
2863*/
2864static int pager_get_content(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002865 if( pPg->flags&PGHDR_NEED_READ ){
drhd33d5a82007-04-26 12:11:28 +00002866 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
2867 if( rc==SQLITE_OK ){
danielk19778c0a7912008-08-20 14:49:23 +00002868 pPg->flags &= ~PGHDR_NEED_READ;
drhd33d5a82007-04-26 12:11:28 +00002869 }else{
2870 return rc;
2871 }
2872 }
2873 return SQLITE_OK;
2874}
2875
2876/*
danielk19778c0a7912008-08-20 14:49:23 +00002877** If the reference count has reached zero, and the pager is not in the
2878** middle of a write transaction or opened in exclusive mode, unlock it.
2879*/
2880static void pagerUnlockIfUnused(Pager *pPager){
2881 if( (sqlite3PcacheRefCount(pPager->pPCache)==0)
2882 && (!pPager->exclusiveMode || pPager->journalOff>0)
2883 ){
2884 pagerUnlockAndRollback(pPager);
2885 }
2886}
2887
2888/*
2889** Drop a page from the cache using sqlite3PcacheDrop().
2890**
2891** If this means there are now no pages with references to them, a rollback
2892** occurs and the lock on the database is removed.
2893*/
2894static void pagerDropPage(DbPage *pPg){
2895 Pager *pPager = pPg->pPager;
2896 sqlite3PcacheDrop(pPg);
2897 pagerUnlockIfUnused(pPager);
2898}
2899
2900/*
drhd9b02572001-04-15 00:37:09 +00002901** Acquire a page.
2902**
drh58a11682001-11-10 13:51:08 +00002903** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002904** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002905**
drhd33d5a82007-04-26 12:11:28 +00002906** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00002907** file is smaller than the requested page, then no actual disk
2908** read occurs and the memory image of the page is initialized to
2909** all zeros. The extra data appended to a page is always initialized
2910** to zeros the first time a page is loaded into memory.
2911**
drhd9b02572001-04-15 00:37:09 +00002912** The acquisition might fail for several reasons. In all cases,
2913** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002914**
drhd33d5a82007-04-26 12:11:28 +00002915** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002916** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00002917** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00002918** just returns 0. This routine acquires a read-lock the first time it
2919** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00002920** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00002921** or journal files.
drh0787db62007-03-04 13:15:27 +00002922**
drh538f5702007-04-13 02:14:30 +00002923** If noContent is false, the page contents are actually read from disk.
2924** If noContent is true, it means that we do not care about the contents
2925** of the page at this time, so do not do a disk read. Just fill in the
2926** page content with zeros. But mark the fact that we have not read the
2927** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00002928** sqlite3PagerWrite() is called on this page or if this routine is
2929** called again with noContent==0, that means that the content is needed
2930** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002931*/
danielk197765e0ff32008-09-19 09:14:43 +00002932int sqlite3PagerAcquire(
drh538f5702007-04-13 02:14:30 +00002933 Pager *pPager, /* The pager open on the database file */
2934 Pgno pgno, /* Page number to fetch */
2935 DbPage **ppPage, /* Write a pointer to the page here */
2936 int noContent /* Do not bother reading content from disk if true */
2937){
danielk19778c0a7912008-08-20 14:49:23 +00002938 PgHdr *pPg = 0;
drh165ffe92005-03-15 17:09:30 +00002939 int rc;
drhed7c8552001-04-11 14:29:21 +00002940
danielk19778c0a7912008-08-20 14:49:23 +00002941 assert( pPager->state==PAGER_UNLOCK
2942 || sqlite3PcacheRefCount(pPager->pPCache)>0
danielk1977b3175382008-10-17 18:51:52 +00002943 || pgno==1
danielk19778c0a7912008-08-20 14:49:23 +00002944 );
danielk1977e277be02007-03-23 18:12:06 +00002945
danielk197726836652005-01-17 01:33:13 +00002946 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2947 ** number greater than this, or zero, is requested.
2948 */
drh267cb322005-09-16 17:16:52 +00002949 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002950 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002951 }
2952
drhd9b02572001-04-15 00:37:09 +00002953 /* Make sure we have not hit any critical errors.
2954 */
drh836faa42003-01-11 13:30:57 +00002955 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002956 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002957
danielk197713adf8a2004-06-03 16:08:41 +00002958 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002959 ** on the database file. pagerSharedLock() is a no-op if
2960 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002961 */
danielk1977e277be02007-03-23 18:12:06 +00002962 rc = pagerSharedLock(pPager);
2963 if( rc!=SQLITE_OK ){
2964 return rc;
drhed7c8552001-04-11 14:29:21 +00002965 }
danielk1977e277be02007-03-23 18:12:06 +00002966 assert( pPager->state!=PAGER_UNLOCK );
2967
danielk19778c0a7912008-08-20 14:49:23 +00002968 rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg);
2969 if( rc!=SQLITE_OK ){
2970 return rc;
2971 }
danielk19778c0a7912008-08-20 14:49:23 +00002972 if( pPg->pPager==0 ){
2973 /* The pager cache has created a new page. Its content needs to
2974 ** be initialized.
2975 */
danielk1977979f38e2007-03-27 16:19:51 +00002976 int nMax;
drh538f5702007-04-13 02:14:30 +00002977 PAGER_INCR(pPager->nMiss);
danielk19778c0a7912008-08-20 14:49:23 +00002978 pPg->pPager = pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002979 memset(pPg->pExtra, 0, pPager->nExtra);
danielk197724168722007-04-02 05:07:47 +00002980
danielk1977ad0132d2008-06-07 08:58:22 +00002981 rc = sqlite3PagerPagecount(pPager, &nMax);
2982 if( rc!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002983 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00002984 return rc;
2985 }
danielk197775bab7d2006-01-23 13:09:45 +00002986
danielk1977a1fa00d2008-08-27 15:16:33 +00002987 if( nMax<(int)pgno || MEMDB || noContent ){
drhf8e632b2007-05-08 14:51:36 +00002988 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00002989 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00002990 return SQLITE_FULL;
2991 }
danielk19778c0a7912008-08-20 14:49:23 +00002992 memset(pPg->pData, 0, pPager->pageSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00002993 if( noContent ){
danielk19778c0a7912008-08-20 14:49:23 +00002994 pPg->flags |= PGHDR_NEED_READ;
2995 }
drh538f5702007-04-13 02:14:30 +00002996 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00002997 }else{
danielk1977e180dd92007-04-05 17:15:52 +00002998 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00002999 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
danielk19778c0a7912008-08-20 14:49:23 +00003000 /* sqlite3PagerUnref(pPg); */
3001 pagerDropPage(pPg);
drh551b7732006-11-06 21:20:25 +00003002 return rc;
drh81a20f22001-10-12 17:30:04 +00003003 }
drh306dc212001-05-21 13:45:10 +00003004 }
danielk19773c407372005-02-15 02:54:14 +00003005#ifdef SQLITE_CHECK_PAGES
3006 pPg->pageHash = pager_pagehash(pPg);
3007#endif
drhed7c8552001-04-11 14:29:21 +00003008 }else{
drhd9b02572001-04-15 00:37:09 +00003009 /* The requested page is in the page cache. */
danielk19778c0a7912008-08-20 14:49:23 +00003010 assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003011 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003012 if( !noContent ){
3013 rc = pager_get_content(pPg);
3014 if( rc ){
danielk19778c0a7912008-08-20 14:49:23 +00003015 sqlite3PagerUnref(pPg);
drhd33d5a82007-04-26 12:11:28 +00003016 return rc;
3017 }
3018 }
drhed7c8552001-04-11 14:29:21 +00003019 }
danielk19778c0a7912008-08-20 14:49:23 +00003020
danielk19773b8a05f2007-03-19 17:44:26 +00003021 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003022 return SQLITE_OK;
3023}
danielk19778c0a7912008-08-20 14:49:23 +00003024
drhed7c8552001-04-11 14:29:21 +00003025/*
drh7e3b0a02001-04-28 16:52:40 +00003026** Acquire a page if it is already in the in-memory cache. Do
3027** not read the page from disk. Return a pointer to the page,
3028** or 0 if the page is not in cache.
3029**
danielk19773b8a05f2007-03-19 17:44:26 +00003030** See also sqlite3PagerGet(). The difference between this routine
3031** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003032** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003033** returns NULL if the page is not in cache or if a disk I/O error
3034** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003035*/
danielk19773b8a05f2007-03-19 17:44:26 +00003036DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003037 PgHdr *pPg = 0;
drh836faa42003-01-11 13:30:57 +00003038 assert( pPager!=0 );
3039 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003040
danielk19778c0a7912008-08-20 14:49:23 +00003041 if( (pPager->state!=PAGER_UNLOCK)
3042 && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL)
3043 ){
3044 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg);
danielk1977e277be02007-03-23 18:12:06 +00003045 }
danielk19778c0a7912008-08-20 14:49:23 +00003046
danielk19773b8a05f2007-03-19 17:44:26 +00003047 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003048}
3049
3050/*
drhed7c8552001-04-11 14:29:21 +00003051** Release a page.
3052**
3053** If the number of references to the page drop to zero, then the
3054** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003055** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003056** removed.
3057*/
danielk19773b8a05f2007-03-19 17:44:26 +00003058int sqlite3PagerUnref(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003059 if( pPg ){
3060 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00003061 sqlite3PcacheRelease(pPg);
3062 pagerUnlockIfUnused(pPager);
drhed7c8552001-04-11 14:29:21 +00003063 }
drhd9b02572001-04-15 00:37:09 +00003064 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003065}
3066
danielk1977fd7f0452008-12-17 17:30:26 +00003067static int openSubJournal(Pager *pPager){
3068 int rc = SQLITE_OK;
3069 if( pPager->journalOpen && !pPager->sjfd->pMethods ){
3070 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
3071 sqlite3MemJournalOpen(pPager->sjfd);
3072 }else{
3073 rc = sqlite3PagerOpentemp(pPager, pPager->sjfd, SQLITE_OPEN_SUBJOURNAL);
3074 }
3075 }
3076 return rc;
3077}
3078
drhed7c8552001-04-11 14:29:21 +00003079/*
drha6abd042004-06-09 17:37:22 +00003080** Create a journal file for pPager. There should already be a RESERVED
3081** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003082**
3083** Return SQLITE_OK if everything. Return an error code and release the
3084** write lock if anything goes wrong.
3085*/
3086static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003087 sqlite3_vfs *pVfs = pPager->pVfs;
3088 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3089
drhda47d772002-12-02 04:25:19 +00003090 int rc;
drha6abd042004-06-09 17:37:22 +00003091 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003092 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003093 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003094 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003095 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00003096 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003097 rc = SQLITE_NOMEM;
3098 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003099 }
danielk1977b4b47412007-08-17 15:53:36 +00003100
drhfdc40e92008-04-17 20:59:37 +00003101 if( pPager->journalOpen==0 ){
3102 if( pPager->tempFile ){
3103 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3104 }else{
3105 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00003106 }
danielk1977b3175382008-10-17 18:51:52 +00003107 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
3108 sqlite3MemJournalOpen(pPager->jfd);
3109 rc = SQLITE_OK;
3110 }else{
drhfdc40e92008-04-17 20:59:37 +00003111#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977b3175382008-10-17 18:51:52 +00003112 rc = sqlite3JournalOpen(
3113 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3114 );
drhfdc40e92008-04-17 20:59:37 +00003115#else
danielk1977b3175382008-10-17 18:51:52 +00003116 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
drhfdc40e92008-04-17 20:59:37 +00003117#endif
danielk1977b3175382008-10-17 18:51:52 +00003118 }
drhfdc40e92008-04-17 20:59:37 +00003119 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3120 pPager->journalOff = 0;
3121 pPager->setMaster = 0;
3122 pPager->journalHdr = 0;
3123 if( rc!=SQLITE_OK ){
3124 if( rc==SQLITE_NOMEM ){
3125 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3126 }
3127 goto failed_to_open_journal;
3128 }
drhda47d772002-12-02 04:25:19 +00003129 }
3130 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003131 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003132 pPager->needSync = 0;
drh968af522003-02-11 14:55:40 +00003133 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003134 if( pPager->errCode ){
3135 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003136 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003137 }
danielk19773460d192008-12-27 15:23:13 +00003138 pPager->dbOrigSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003139
danielk197776572402004-06-25 02:38:54 +00003140 rc = writeJournalHdr(pPager);
3141
danielk1977fd7f0452008-12-17 17:30:26 +00003142 if( pPager->nSavepoint && rc==SQLITE_OK ){
3143 rc = openSubJournal(pPager);
drhda47d772002-12-02 04:25:19 +00003144 }
danielk1977ae72d982007-10-03 08:46:44 +00003145 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003146 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003147 if( rc==SQLITE_OK ){
3148 rc = SQLITE_FULL;
3149 }
3150 }
drh9c105bb2004-10-02 20:38:28 +00003151 return rc;
3152
3153failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003154 sqlite3BitvecDestroy(pPager->pInJournal);
3155 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003156 return rc;
drhda47d772002-12-02 04:25:19 +00003157}
3158
3159/*
drh4b845d72002-03-05 12:41:19 +00003160** Acquire a write-lock on the database. The lock is removed when
3161** the any of the following happen:
3162**
drh80e35f42007-03-30 14:06:34 +00003163** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003164** * sqlite3PagerRollback() is called.
3165** * sqlite3PagerClose() is called.
3166** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003167**
danielk197713adf8a2004-06-03 16:08:41 +00003168** The first parameter to this routine is a pointer to any open page of the
3169** database file. Nothing changes about the page - it is used merely to
3170** acquire a pointer to the Pager structure and as proof that there is
3171** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003172**
danielk197713adf8a2004-06-03 16:08:41 +00003173** The second parameter indicates how much space in bytes to reserve for a
3174** master journal file-name at the start of the journal when it is created.
3175**
3176** A journal file is opened if this is not a temporary file. For temporary
3177** files, the opening of the journal file is deferred until there is an
3178** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003179**
drha6abd042004-06-09 17:37:22 +00003180** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003181**
3182** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3183** immediately instead of waiting until we try to flush the cache. The
3184** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003185*/
danielk19773b8a05f2007-03-19 17:44:26 +00003186int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003187 Pager *pPager = pPg->pPager;
3188 int rc = SQLITE_OK;
3189 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003190 assert( pPager->state!=PAGER_UNLOCK );
3191 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003192 assert( pPager->pInJournal==0 );
danielk1977b3175382008-10-17 18:51:52 +00003193 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00003194 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
3195 if( rc==SQLITE_OK ){
3196 pPager->state = PAGER_RESERVED;
3197 if( exFlag ){
3198 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh684917c2004-10-05 02:41:42 +00003199 }
danielk1977b3175382008-10-17 18:51:52 +00003200 }
3201 if( rc!=SQLITE_OK ){
3202 return rc;
3203 }
3204 pPager->dirtyCache = 0;
3205 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
3206 if( pPager->useJournal && !pPager->tempFile
3207 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
3208 rc = pager_open_journal(pPager);
drh4b845d72002-03-05 12:41:19 +00003209 }
danielk1977334cdb62007-03-26 08:05:12 +00003210 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00003211 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00003212 ** time a (read or write) transaction was successfully concluded
3213 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00003214 ** kept open and either was truncated to 0 bytes or its header was
3215 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00003216 */
3217 assert( pPager->nRec==0 );
danielk19773460d192008-12-27 15:23:13 +00003218 assert( pPager->dbOrigSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003219 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003220 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003221 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhf5e7bb52008-02-18 14:47:33 +00003222 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003223 rc = SQLITE_NOMEM;
3224 }else{
danielk19773460d192008-12-27 15:23:13 +00003225 pPager->dbOrigSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003226 rc = writeJournalHdr(pPager);
3227 }
drh4b845d72002-03-05 12:41:19 +00003228 }
danielk1977334cdb62007-03-26 08:05:12 +00003229 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003230 return rc;
3231}
3232
3233/*
drhed7c8552001-04-11 14:29:21 +00003234** Mark a data page as writeable. The page is written into the journal
3235** if it is not there already. This routine must be called before making
3236** changes to a page.
3237**
3238** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003239** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003240** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003241** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003242** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003243**
3244** If the journal file could not be written because the disk is full,
3245** then this routine returns SQLITE_FULL and does an immediate rollback.
3246** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003247** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003248** reset.
drhed7c8552001-04-11 14:29:21 +00003249*/
danielk19773b8a05f2007-03-19 17:44:26 +00003250static int pager_write(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003251 void *pData = pPg->pData;
drh69688d52001-04-14 16:38:23 +00003252 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003253 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003254
drh6446c4d2001-12-15 14:22:18 +00003255 /* Check for errors
3256 */
danielk1977efaaf572006-01-16 11:29:19 +00003257 if( pPager->errCode ){
3258 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003259 }
drh5e00f6c2001-09-13 13:46:56 +00003260 if( pPager->readOnly ){
3261 return SQLITE_PERM;
3262 }
drh6446c4d2001-12-15 14:22:18 +00003263
danielk197776572402004-06-25 02:38:54 +00003264 assert( !pPager->setMaster );
3265
danielk19773c407372005-02-15 02:54:14 +00003266 CHECK_PAGE(pPg);
3267
drh538f5702007-04-13 02:14:30 +00003268 /* If this page was previously acquired with noContent==1, that means
3269 ** we didn't really read in the content of the page. This can happen
3270 ** (for example) when the page is being moved to the freelist. But
3271 ** now we are (perhaps) moving the page off of the freelist for
3272 ** reuse and we need to know its original content so that content
3273 ** can be stored in the rollback journal. So do the read at this
3274 ** time.
3275 */
drhd33d5a82007-04-26 12:11:28 +00003276 rc = pager_get_content(pPg);
3277 if( rc ){
3278 return rc;
drh538f5702007-04-13 02:14:30 +00003279 }
3280
drh6446c4d2001-12-15 14:22:18 +00003281 /* Mark the page as dirty. If the page has already been written
3282 ** to the journal then we can return right away.
3283 */
drhc047b9f2008-11-21 03:23:43 +00003284 sqlite3PcacheMakeDirty(pPg);
danielk19773460d192008-12-27 15:23:13 +00003285 if( pageInJournal(pPg) && !subjRequiresPage(pPg) ){
drha6abd042004-06-09 17:37:22 +00003286 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003287 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003288 }else{
drh6446c4d2001-12-15 14:22:18 +00003289
danielk1977a0bf2652004-11-04 14:30:04 +00003290 /* If we get this far, it means that the page needs to be
3291 ** written to the transaction journal or the ckeckpoint journal
3292 ** or both.
3293 **
3294 ** First check to see that the transaction journal exists and
3295 ** create it if it does not.
3296 */
3297 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003298 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003299 if( rc!=SQLITE_OK ){
3300 return rc;
3301 }
3302 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00003303 if( !pPager->journalOpen && pPager->useJournal
3304 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00003305 rc = pager_open_journal(pPager);
3306 if( rc!=SQLITE_OK ) return rc;
3307 }
danielk1977a0bf2652004-11-04 14:30:04 +00003308 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003309 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003310
3311 /* The transaction journal now exists and we have a RESERVED or an
3312 ** EXCLUSIVE lock on the main database file. Write the current page to
3313 ** the transaction journal if it is not there already.
3314 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00003315 if( !pageInJournal(pPg) && pPager->journalOpen ){
danielk19773460d192008-12-27 15:23:13 +00003316 if( pPg->pgno<=pPager->dbOrigSize ){
danielk1977b3175382008-10-17 18:51:52 +00003317 u32 cksum;
3318 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00003319
danielk1977b3175382008-10-17 18:51:52 +00003320 /* We should never write to the journal file the page that
3321 ** contains the database locks. The following assert verifies
3322 ** that we do not. */
3323 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
3324 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
3325 cksum = pager_cksum(pPager, (u8*)pData2);
3326 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
3327 if( rc==SQLITE_OK ){
3328 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
3329 pPager->journalOff + 4);
3330 pPager->journalOff += pPager->pageSize+4;
3331 }
3332 if( rc==SQLITE_OK ){
3333 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
3334 pPager->journalOff += 4;
3335 }
3336 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
3337 pPager->journalOff, pPager->pageSize));
3338 PAGER_INCR(sqlite3_pager_writej_count);
3339 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
3340 PAGERID(pPager), pPg->pgno,
3341 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00003342
danielk1977f3107512008-12-22 10:58:46 +00003343 /* Even if an IO or diskfull error occurred while journalling the
3344 ** page in the block above, set the need-sync flag for the page.
3345 ** Otherwise, when the transaction is rolled back, the logic in
3346 ** playback_one_page() will think that the page needs to be restored
3347 ** in the database file. And if an IO error occurs while doing so,
3348 ** then corruption may follow.
3349 */
3350 if( !pPager->noSync ){
3351 pPg->flags |= PGHDR_NEED_SYNC;
danielk1977a4124bd2008-12-23 10:37:47 +00003352 pPager->needSync = 1;
danielk1977f3107512008-12-22 10:58:46 +00003353 }
3354
danielk1977b3175382008-10-17 18:51:52 +00003355 /* An error has occured writing to the journal file. The
3356 ** transaction will be rolled back by the layer above.
3357 */
3358 if( rc!=SQLITE_OK ){
3359 return rc;
3360 }
danielk197707cb5602006-01-20 10:55:05 +00003361
danielk1977b3175382008-10-17 18:51:52 +00003362 pPager->nRec++;
3363 assert( pPager->pInJournal!=0 );
3364 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977fd7f0452008-12-17 17:30:26 +00003365 addToSavepointBitvecs(pPager, pPg->pgno);
danielk197713adf8a2004-06-03 16:08:41 +00003366 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003367 if( !pPager->journalStarted && !pPager->noSync ){
3368 pPg->flags |= PGHDR_NEED_SYNC;
danielk1977a4124bd2008-12-23 10:37:47 +00003369 pPager->needSync = 1;
danielk19778c0a7912008-08-20 14:49:23 +00003370 }
drh4f0c5872007-03-26 22:05:01 +00003371 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk19778c0a7912008-08-20 14:49:23 +00003372 PAGERID(pPager), pPg->pgno,
3373 ((pPg->flags&PGHDR_NEED_SYNC)?1:0));
danielk1977a0bf2652004-11-04 14:30:04 +00003374 }
danielk1977a0bf2652004-11-04 14:30:04 +00003375 }
3376
3377 /* If the statement journal is open and the page is not in it,
3378 ** then write the current page to the statement journal. Note that
3379 ** the statement journal format differs from the standard journal format
3380 ** in that it omits the checksums and the header.
3381 */
danielk19773460d192008-12-27 15:23:13 +00003382 if( subjRequiresPage(pPg) ){
danielk1977b3175382008-10-17 18:51:52 +00003383 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
3384 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
danielk19773460d192008-12-27 15:23:13 +00003385 assert( pageInJournal(pPg) || pPg->pgno>pPager->dbOrigSize );
danielk1977fd7f0452008-12-17 17:30:26 +00003386 rc = write32bits(pPager->sjfd, offset, pPg->pgno);
danielk1977b3175382008-10-17 18:51:52 +00003387 if( rc==SQLITE_OK ){
danielk1977fd7f0452008-12-17 17:30:26 +00003388 rc = sqlite3OsWrite(pPager->sjfd, pData2, pPager->pageSize, offset+4);
drhdb48ee02003-01-16 13:42:43 +00003389 }
danielk197767ddef62008-12-23 19:15:56 +00003390 PAGERTRACE3("STMT-JOURNAL %d page %d @ %d\n", PAGERID(pPager), pPg->pgno);
danielk1977b3175382008-10-17 18:51:52 +00003391 if( rc!=SQLITE_OK ){
3392 return rc;
3393 }
3394 pPager->stmtNRec++;
danielk1977fd7f0452008-12-17 17:30:26 +00003395 assert( pPager->nSavepoint>0 );
3396 addToSavepointBitvecs(pPager, pPg->pgno);
drhd9b02572001-04-15 00:37:09 +00003397 }
drhfa86c412002-02-02 15:01:15 +00003398 }
3399
3400 /* Update the database size and return.
3401 */
drh1aa2d8b2007-01-03 15:34:29 +00003402 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003403 if( pPager->dbSize<pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003404 pPager->dbSize = pPg->pgno;
danielk1977d92db532008-11-17 04:56:24 +00003405 if( pPager->dbSize==(PAGER_MJ_PGNO(pPager)-1) ){
drh1f595712004-06-15 01:40:29 +00003406 pPager->dbSize++;
3407 }
drh306dc212001-05-21 13:45:10 +00003408 }
drh69688d52001-04-14 16:38:23 +00003409 return rc;
drhed7c8552001-04-11 14:29:21 +00003410}
3411
3412/*
danielk19774099f6e2007-03-19 11:25:20 +00003413** This function is used to mark a data-page as writable. It uses
3414** pager_write() to open a journal file (if it is not already open)
3415** and write the page *pData to the journal.
3416**
3417** The difference between this function and pager_write() is that this
3418** function also deals with the special case where 2 or more pages
3419** fit on a single disk sector. In this case all co-resident pages
3420** must have been written to the journal file before returning.
3421*/
danielk19773b8a05f2007-03-19 17:44:26 +00003422int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003423 int rc = SQLITE_OK;
3424
danielk19773b8a05f2007-03-19 17:44:26 +00003425 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003426 Pager *pPager = pPg->pPager;
3427 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3428
danielk1977b3175382008-10-17 18:51:52 +00003429 if( nPagePerSector>1 ){
danielk19774099f6e2007-03-19 11:25:20 +00003430 Pgno nPageCount; /* Total number of pages in database file */
3431 Pgno pg1; /* First page of the sector pPg is located on. */
3432 int nPage; /* Number of pages starting at pg1 to journal */
3433 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003434 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003435
3436 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3437 ** header to be written between the pages journaled by this function.
3438 */
danielk1977b3175382008-10-17 18:51:52 +00003439 assert( !MEMDB );
danielk19774099f6e2007-03-19 11:25:20 +00003440 assert( pPager->doNotSync==0 );
3441 pPager->doNotSync = 1;
3442
3443 /* This trick assumes that both the page-size and sector-size are
3444 ** an integer power of 2. It sets variable pg1 to the identifier
3445 ** of the first page of the sector pPg is located on.
3446 */
3447 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3448
danielk1977ad0132d2008-06-07 08:58:22 +00003449 sqlite3PagerPagecount(pPager, (int *)&nPageCount);
danielk19774099f6e2007-03-19 11:25:20 +00003450 if( pPg->pgno>nPageCount ){
3451 nPage = (pPg->pgno - pg1)+1;
3452 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3453 nPage = nPageCount+1-pg1;
3454 }else{
3455 nPage = nPagePerSector;
3456 }
3457 assert(nPage>0);
3458 assert(pg1<=pPg->pgno);
3459 assert((pg1+nPage)>pPg->pgno);
3460
3461 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3462 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003463 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00003464 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00003465 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003466 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003467 if( rc==SQLITE_OK ){
3468 rc = pager_write(pPage);
danielk19778c0a7912008-08-20 14:49:23 +00003469 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003470 needSync = 1;
danielk1977a4124bd2008-12-23 10:37:47 +00003471 assert(pPager->needSync);
danielk1977dd97a492007-08-22 18:54:32 +00003472 }
danielk19773b8a05f2007-03-19 17:44:26 +00003473 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003474 }
3475 }
drhc81945e2008-03-10 14:12:53 +00003476 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk19778c0a7912008-08-20 14:49:23 +00003477 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003478 needSync = 1;
3479 }
danielk19778c0a7912008-08-20 14:49:23 +00003480 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003481 }
3482 }
3483
danielk1977dd97a492007-08-22 18:54:32 +00003484 /* If the PgHdr.needSync flag is set for any of the nPage pages
3485 ** starting at pg1, then it needs to be set for all of them. Because
3486 ** writing to any of these nPage pages may damage the others, the
3487 ** journal file must contain sync()ed copies of all of them
3488 ** before any of them can be written out to the database file.
3489 */
3490 if( needSync ){
drhb3df2e12008-09-17 20:06:26 +00003491 assert( !MEMDB && pPager->noSync==0 );
danielk1977dd97a492007-08-22 18:54:32 +00003492 for(ii=0; ii<nPage && needSync; ii++){
3493 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
danielk19778c0a7912008-08-20 14:49:23 +00003494 if( pPage ) pPage->flags |= PGHDR_NEED_SYNC;
3495 sqlite3PagerUnref(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003496 }
3497 assert(pPager->needSync);
3498 }
3499
danielk19774099f6e2007-03-19 11:25:20 +00003500 assert( pPager->doNotSync==1 );
3501 pPager->doNotSync = 0;
3502 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003503 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003504 }
3505 return rc;
3506}
3507
3508/*
drhaacc5432002-01-06 17:07:40 +00003509** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003510** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003511** to change the content of the page.
3512*/
danielk19777d3a6662006-01-23 16:21:05 +00003513#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003514int sqlite3PagerIswriteable(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003515 return pPg->flags&PGHDR_DIRTY;
drh6019e162001-07-02 17:51:45 +00003516}
danielk19777d3a6662006-01-23 16:21:05 +00003517#endif
drh6019e162001-07-02 17:51:45 +00003518
drh001bbcb2003-03-19 03:14:00 +00003519/*
drh30e58752002-03-02 20:41:57 +00003520** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003521** write the information on page pPg back to the disk, even though
drhdfe88ec2008-11-03 20:55:06 +00003522** that page might be marked as dirty. This happens, for example, when
3523** the page has been added as a leaf of the freelist and so its
3524** content no longer matters.
drh30e58752002-03-02 20:41:57 +00003525**
3526** The overlying software layer calls this routine when all of the data
3527** on the given page is unused. The pager marks the page as clean so
3528** that it does not get written to disk.
3529**
3530** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003531** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003532** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003533**
3534** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003535** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003536** will thereafter be ignored. This is necessary to avoid a problem
3537** where a page with data is added to the freelist during one part of
3538** a transaction then removed from the freelist during a later part
3539** of the same transaction and reused for some other purpose. When it
3540** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003541** the sqlite3PagerDontRollback() routine is called. But because the
3542** page contains critical data, we still need to be sure it gets
3543** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003544*/
danielk1977a1fa00d2008-08-27 15:16:33 +00003545int sqlite3PagerDontWrite(DbPage *pDbPage){
drh538f5702007-04-13 02:14:30 +00003546 PgHdr *pPg = pDbPage;
3547 Pager *pPager = pPg->pPager;
danielk1977a1fa00d2008-08-27 15:16:33 +00003548 int rc;
drh8e298f92002-07-06 16:28:47 +00003549
danielk19773460d192008-12-27 15:23:13 +00003550 if( pPg->pgno>pPager->dbOrigSize ){
danielk1977a1fa00d2008-08-27 15:16:33 +00003551 return SQLITE_OK;
3552 }
3553 if( pPager->pAlwaysRollback==0 ){
3554 assert( pPager->pInJournal );
danielk19773460d192008-12-27 15:23:13 +00003555 pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->dbOrigSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00003556 if( !pPager->pAlwaysRollback ){
3557 return SQLITE_NOMEM;
3558 }
3559 }
3560 rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno);
3561
danielk1977fd7f0452008-12-17 17:30:26 +00003562 if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && pPager->nSavepoint==0 ){
drh1aa2d8b2007-01-03 15:34:29 +00003563 assert( pPager->state>=PAGER_SHARED );
danielk19773460d192008-12-27 15:23:13 +00003564 if( pPager->dbSize==pPg->pgno && pPager->dbOrigSize<pPager->dbSize ){
drh8124a302002-06-25 14:43:57 +00003565 /* If this pages is the last page in the file and the file has grown
3566 ** during the current transaction, then do NOT mark the page as clean.
3567 ** When the database file grows, we must make sure that the last page
3568 ** gets written at least once so that the disk file will be the correct
3569 ** size. If you do not write this page and the size of the file
3570 ** on the disk ends up being too small, that can lead to database
3571 ** corruption during the next transaction.
3572 */
3573 }else{
drh538f5702007-04-13 02:14:30 +00003574 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3575 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
danielk197733e32162008-08-23 18:53:08 +00003576 pPg->flags |= PGHDR_DONT_WRITE;
danielk19773c407372005-02-15 02:54:14 +00003577#ifdef SQLITE_CHECK_PAGES
3578 pPg->pageHash = pager_pagehash(pPg);
3579#endif
drh8124a302002-06-25 14:43:57 +00003580 }
drh30e58752002-03-02 20:41:57 +00003581 }
danielk1977a1fa00d2008-08-27 15:16:33 +00003582 return rc;
drh30e58752002-03-02 20:41:57 +00003583}
3584
3585/*
3586** A call to this routine tells the pager that if a rollback occurs,
3587** it is not necessary to restore the data on the given page. This
3588** means that the pager does not have to record the given page in the
3589** rollback journal.
drh538f5702007-04-13 02:14:30 +00003590**
3591** If we have not yet actually read the content of this page (if
3592** the PgHdr.needRead flag is set) then this routine acts as a promise
3593** that we will never need to read the page content in the future.
3594** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003595*/
danielk19773b8a05f2007-03-19 17:44:26 +00003596void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003597 Pager *pPager = pPg->pPager;
3598
drhd3627af2006-12-18 18:34:51 +00003599 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00003600
3601 /* If the journal file is not open, or DontWrite() has been called on
3602 ** this page (DontWrite() sets the alwaysRollback flag), then this
3603 ** function is a no-op.
3604 */
danielk1977a1fa00d2008-08-27 15:16:33 +00003605 if( pPager->journalOpen==0
3606 || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno)
danielk19773460d192008-12-27 15:23:13 +00003607 || pPg->pgno>pPager->dbOrigSize
danielk19778c0a7912008-08-20 14:49:23 +00003608 ){
danielk197787c29a92008-01-18 11:33:16 +00003609 return;
3610 }
danielk1977a55e9352008-01-21 13:04:34 +00003611
drhc5d0bd92008-04-14 01:00:57 +00003612#ifdef SQLITE_SECURE_DELETE
drh1feb7dd2008-11-19 18:30:29 +00003613 if( sqlite3BitvecTest(pPager->pInJournal, pPg->pgno)!=0
danielk19773460d192008-12-27 15:23:13 +00003614 || pPg->pgno>pPager->dbOrigSize ){
drhc5d0bd92008-04-14 01:00:57 +00003615 return;
3616 }
3617#endif
3618
3619 /* If SECURE_DELETE is disabled, then there is no way that this
3620 ** routine can be called on a page for which sqlite3PagerDontWrite()
3621 ** has not been previously called during the same transaction.
3622 ** And if DontWrite() has previously been called, the following
3623 ** conditions must be met.
drh10131482008-07-11 03:34:09 +00003624 **
3625 ** (Later:) Not true. If the database is corrupted by having duplicate
3626 ** pages on the freelist (ex: corrupt9.test) then the following is not
3627 ** necessarily true:
danielk1977a55e9352008-01-21 13:04:34 +00003628 */
danielk19773460d192008-12-27 15:23:13 +00003629 /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->dbOrigSize ); */
danielk1977a55e9352008-01-21 13:04:34 +00003630
drhf5e7bb52008-02-18 14:47:33 +00003631 assert( pPager->pInJournal!=0 );
3632 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003633 pPg->flags &= ~PGHDR_NEED_READ;
danielk1977fd7f0452008-12-17 17:30:26 +00003634 addToSavepointBitvecs(pPager, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00003635 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
3636 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003637}
3638
drhac69b052004-05-12 13:30:07 +00003639
drh30e58752002-03-02 20:41:57 +00003640/*
drh80e35f42007-03-30 14:06:34 +00003641** This routine is called to increment the database file change-counter,
3642** stored at byte 24 of the pager file.
3643*/
danielk1977c7b60172007-08-22 11:22:03 +00003644static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00003645 PgHdr *pPgHdr;
3646 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00003647 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00003648
drh701bb3b2008-08-02 03:50:39 +00003649#ifndef SQLITE_ENABLE_ATOMIC_WRITE
3650 assert( isDirect==0 ); /* isDirect is only true for atomic writes */
3651#endif
danielk197712dd5492008-12-18 15:45:07 +00003652 if( !pPager->changeCountDone && pPager->dbSize>0 ){
drh80e35f42007-03-30 14:06:34 +00003653 /* Open page 1 of the file for writing. */
3654 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3655 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00003656
3657 if( !isDirect ){
3658 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00003659 if( rc!=SQLITE_OK ){
3660 sqlite3PagerUnref(pPgHdr);
3661 return rc;
3662 }
danielk1977c7b60172007-08-22 11:22:03 +00003663 }
3664
drh80e35f42007-03-30 14:06:34 +00003665 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003666 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003667 change_counter++;
danielk19778c0a7912008-08-20 14:49:23 +00003668 put32bits(((char*)pPgHdr->pData)+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00003669
drh701bb3b2008-08-02 03:50:39 +00003670#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977c7b60172007-08-22 11:22:03 +00003671 if( isDirect && pPager->fd->pMethods ){
danielk19778c0a7912008-08-20 14:49:23 +00003672 const void *zBuf = pPgHdr->pData;
danielk19773460d192008-12-27 15:23:13 +00003673 assert( pPager->dbFileSize>0 );
danielk1977c7b60172007-08-22 11:22:03 +00003674 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
3675 }
drh701bb3b2008-08-02 03:50:39 +00003676#endif
danielk1977c7b60172007-08-22 11:22:03 +00003677
drh80e35f42007-03-30 14:06:34 +00003678 /* Release the page reference. */
3679 sqlite3PagerUnref(pPgHdr);
3680 pPager->changeCountDone = 1;
3681 }
danielk1977c7b60172007-08-22 11:22:03 +00003682 return rc;
drh80e35f42007-03-30 14:06:34 +00003683}
3684
3685/*
danielk1977f653d782008-03-20 11:04:21 +00003686** Sync the pager file to disk.
3687*/
3688int sqlite3PagerSync(Pager *pPager){
3689 int rc;
drh7426f862008-08-26 21:07:26 +00003690 if( MEMDB ){
3691 rc = SQLITE_OK;
3692 }else{
3693 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
3694 }
danielk1977f653d782008-03-20 11:04:21 +00003695 return rc;
3696}
3697
3698/*
drh80e35f42007-03-30 14:06:34 +00003699** Sync the database file for the pager pPager. zMaster points to the name
3700** of a master journal file that should be written into the individual
3701** journal file. zMaster may be NULL, which is interpreted as no master
3702** journal (a single database transaction).
3703**
3704** This routine ensures that the journal is synced, all dirty pages written
3705** to the database file and the database file synced. The only thing that
3706** remains to commit the transaction is to delete the journal file (or
3707** master journal file if specified).
3708**
3709** Note that if zMaster==NULL, this does not overwrite a previous value
3710** passed to an sqlite3PagerCommitPhaseOne() call.
3711**
3712** If parameter nTrunc is non-zero, then the pager file is truncated to
3713** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00003714**
3715** If the final parameter - noSync - is true, then the database file itself
3716** is not synced. The caller must call sqlite3PagerSync() directly to
3717** sync the database file before calling CommitPhaseTwo() to delete the
3718** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00003719*/
danielk1977f653d782008-03-20 11:04:21 +00003720int sqlite3PagerCommitPhaseOne(
3721 Pager *pPager,
3722 const char *zMaster,
3723 Pgno nTrunc,
3724 int noSync
3725){
drh80e35f42007-03-30 14:06:34 +00003726 int rc = SQLITE_OK;
3727
danielk1977dad31b52008-05-15 11:08:07 +00003728 if( pPager->errCode ){
3729 return pPager->errCode;
3730 }
3731
drhd138c012008-05-13 00:58:18 +00003732 /* If no changes have been made, we can leave the transaction early.
3733 */
3734 if( pPager->dbModified==0 &&
3735 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3736 pPager->exclusiveMode!=0) ){
3737 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3738 return SQLITE_OK;
3739 }
3740
danielk19773460d192008-12-27 15:23:13 +00003741 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nSize=%d\n",
3742 pPager->zFilename, zMaster, pPager->dbSize);
drh80e35f42007-03-30 14:06:34 +00003743
3744 /* If this is an in-memory db, or no pages have been written to, or this
3745 ** function has already been called, it is a no-op.
3746 */
3747 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3748 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00003749
danielk1977c7b60172007-08-22 11:22:03 +00003750#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3751 /* The atomic-write optimization can be used if all of the
3752 ** following are true:
3753 **
3754 ** + The file-system supports the atomic-write property for
3755 ** blocks of size page-size, and
3756 ** + This commit is not part of a multi-file transaction, and
3757 ** + Exactly one page has been modified and store in the journal file.
3758 **
3759 ** If the optimization can be used, then the journal file will never
3760 ** be created for this transaction.
3761 */
danielk19774d60af92008-09-08 15:35:06 +00003762 int useAtomicWrite;
danielk19778c0a7912008-08-20 14:49:23 +00003763 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
danielk19774d60af92008-09-08 15:35:06 +00003764 useAtomicWrite = (
danielk1977f55b8992007-08-24 08:15:53 +00003765 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00003766 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00003767 pPager->journalOff==jrnlBufferSize(pPager) &&
danielk19773460d192008-12-27 15:23:13 +00003768 pPager->dbSize>=pPager->dbFileSize &&
danielk19778c0a7912008-08-20 14:49:23 +00003769 (pPg==0 || pPg->pDirty==0)
danielk1977f55b8992007-08-24 08:15:53 +00003770 );
danielk1977700b9c52008-04-24 12:37:40 +00003771 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00003772 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00003773 /* Update the nRec field in the journal file. */
3774 int offset = pPager->journalHdr + sizeof(aJournalMagic);
3775 assert(pPager->nRec==1);
3776 rc = write32bits(pPager->jfd, offset, pPager->nRec);
3777
3778 /* Update the db file change counter. The following call will modify
3779 ** the in-memory representation of page 1 to include the updated
3780 ** change counter and then write page 1 directly to the database
3781 ** file. Because of the atomic-write property of the host file-system,
3782 ** this is safe.
3783 */
danielk1977ae72d982007-10-03 08:46:44 +00003784 if( rc==SQLITE_OK ){
3785 rc = pager_incr_changecounter(pPager, 1);
3786 }
danielk1977f55b8992007-08-24 08:15:53 +00003787 }else{
3788 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00003789 }
3790
danielk1977ae72d982007-10-03 08:46:44 +00003791 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00003792#endif
3793
drh80e35f42007-03-30 14:06:34 +00003794 /* If a master journal file name has already been written to the
3795 ** journal file, then no sync is required. This happens when it is
3796 ** written, then the process fails to upgrade from a RESERVED to an
3797 ** EXCLUSIVE lock. The next time the process tries to commit the
3798 ** transaction the m-j name will have already been written.
3799 */
3800 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00003801 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003802 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00003803 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00003804#ifndef SQLITE_OMIT_AUTOVACUUM
danielk19773460d192008-12-27 15:23:13 +00003805 if( pPager->dbSize<pPager->dbOrigSize ){
danielk197771aa7ff2008-05-20 07:05:09 +00003806 /* If this transaction has made the database smaller, then all pages
3807 ** being discarded by the truncation must be written to the journal
3808 ** file.
3809 */
3810 Pgno i;
danielk1977d92db532008-11-17 04:56:24 +00003811 Pgno iSkip = PAGER_MJ_PGNO(pPager);
danielk19773460d192008-12-27 15:23:13 +00003812 Pgno dbSize = pPager->dbSize;
3813 for( i=pPager->dbSize+1; i<=pPager->dbOrigSize; i++ ){
danielk197771aa7ff2008-05-20 07:05:09 +00003814 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
3815 rc = sqlite3PagerGet(pPager, i, &pPg);
3816 if( rc!=SQLITE_OK ) goto sync_exit;
3817 rc = sqlite3PagerWrite(pPg);
3818 sqlite3PagerUnref(pPg);
3819 if( rc!=SQLITE_OK ) goto sync_exit;
3820 }
3821 }
danielk19773460d192008-12-27 15:23:13 +00003822 pPager->dbSize = dbSize;
danielk197771aa7ff2008-05-20 07:05:09 +00003823 }
drh80e35f42007-03-30 14:06:34 +00003824#endif
danielk197771aa7ff2008-05-20 07:05:09 +00003825 rc = writeMasterJournal(pPager, zMaster);
3826 if( rc!=SQLITE_OK ) goto sync_exit;
3827 rc = syncJournal(pPager);
3828 }
drh80e35f42007-03-30 14:06:34 +00003829 }
danielk1977c7b60172007-08-22 11:22:03 +00003830 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00003831
3832#ifndef SQLITE_OMIT_AUTOVACUUM
danielk19773460d192008-12-27 15:23:13 +00003833 if( pPager->dbSize<pPager->dbFileSize ){
3834 rc = sqlite3PagerTruncate(pPager, pPager->dbSize);
drh80e35f42007-03-30 14:06:34 +00003835 if( rc!=SQLITE_OK ) goto sync_exit;
3836 }
3837#endif
3838
3839 /* Write all dirty pages to the database file */
danielk19778c0a7912008-08-20 14:49:23 +00003840 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003841 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00003842 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00003843 assert( rc!=SQLITE_IOERR_BLOCKED );
3844 /* The error might have left the dirty list all fouled up here,
3845 ** but that does not matter because if the if the dirty list did
3846 ** get corrupted, then the transaction will roll back and
3847 ** discard the dirty list. There is an assert in
3848 ** pager_get_all_dirty_pages() that verifies that no attempt
3849 ** is made to use an invalid dirty list.
3850 */
drh153c62c2007-08-24 03:51:33 +00003851 goto sync_exit;
3852 }
danielk19778c0a7912008-08-20 14:49:23 +00003853 sqlite3PcacheCleanAll(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003854
3855 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00003856 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00003857 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00003858 }
3859 IOTRACE(("DBSYNC %p\n", pPager))
3860
3861 pPager->state = PAGER_SYNCED;
danielk19773460d192008-12-27 15:23:13 +00003862 }else if( MEMDB && pPager->dbSize<pPager->dbFileSize ){
3863 rc = sqlite3PagerTruncate(pPager, pPager->dbSize);
drh80e35f42007-03-30 14:06:34 +00003864 }
3865
3866sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00003867 if( rc==SQLITE_IOERR_BLOCKED ){
3868 /* pager_incr_changecounter() may attempt to obtain an exclusive
3869 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00003870 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00003871 * better to return SQLITE_BUSY.
3872 */
3873 rc = SQLITE_BUSY;
3874 }
drh80e35f42007-03-30 14:06:34 +00003875 return rc;
3876}
3877
3878
3879/*
drhed7c8552001-04-11 14:29:21 +00003880** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003881**
3882** If the commit fails for any reason, a rollback attempt is made
3883** and an error code is returned. If the commit worked, SQLITE_OK
3884** is returned.
drhed7c8552001-04-11 14:29:21 +00003885*/
drh80e35f42007-03-30 14:06:34 +00003886int sqlite3PagerCommitPhaseTwo(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003887 int rc = SQLITE_OK;
drhd9b02572001-04-15 00:37:09 +00003888
danielk1977efaaf572006-01-16 11:29:19 +00003889 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003890 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003891 }
drha6abd042004-06-09 17:37:22 +00003892 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003893 return SQLITE_ERROR;
3894 }
drhd138c012008-05-13 00:58:18 +00003895 if( pPager->dbModified==0 &&
3896 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3897 pPager->exclusiveMode!=0) ){
3898 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3899 return SQLITE_OK;
3900 }
drh4f0c5872007-03-26 22:05:01 +00003901 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003902 assert( pPager->state==PAGER_SYNCED || MEMDB || !pPager->dirtyCache );
3903 rc = pager_end_transaction(pPager, pPager->setMaster);
3904 rc = pager_error(pPager, rc);
drh86f8c192007-08-22 00:39:19 +00003905 return rc;
drhed7c8552001-04-11 14:29:21 +00003906}
3907
3908/*
drha6abd042004-06-09 17:37:22 +00003909** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003910** All in-memory cache pages revert to their original data contents.
3911** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003912**
3913** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003914** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003915** process is writing trash into the journal file (SQLITE_CORRUPT) or
3916** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3917** codes are returned for all these occasions. Otherwise,
3918** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003919*/
danielk19773b8a05f2007-03-19 17:44:26 +00003920int sqlite3PagerRollback(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003921 int rc = SQLITE_OK;
drh4f0c5872007-03-26 22:05:01 +00003922 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003923 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00003924 rc = pager_end_transaction(pPager, pPager->setMaster);
danielk19778c0a7912008-08-20 14:49:23 +00003925 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003926 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003927 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003928 }
danielk19778c0a7912008-08-20 14:49:23 +00003929 rc = pPager->errCode;
drha6abd042004-06-09 17:37:22 +00003930 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003931 if( pPager->state==PAGER_RESERVED ){
3932 int rc2;
3933 rc = pager_playback(pPager, 0);
3934 rc2 = pager_end_transaction(pPager, pPager->setMaster);
3935 if( rc==SQLITE_OK ){
3936 rc = rc2;
3937 }
3938 }else{
3939 rc = pager_playback(pPager, 0);
3940 }
danielk197707cb5602006-01-20 10:55:05 +00003941
danielk1977b3175382008-10-17 18:51:52 +00003942 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00003943 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00003944 }
danielk19778c0a7912008-08-20 14:49:23 +00003945
3946 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3947 ** cache. So call pager_error() on the way out to make any error
3948 ** persistent.
3949 */
3950 rc = pager_error(pPager, rc);
3951 }
drh86f8c192007-08-22 00:39:19 +00003952 return rc;
drh98808ba2001-10-18 12:34:46 +00003953}
drhd9b02572001-04-15 00:37:09 +00003954
3955/*
drh5e00f6c2001-09-13 13:46:56 +00003956** Return TRUE if the database file is opened read-only. Return FALSE
3957** if the database is (in theory) writable.
3958*/
drhf49661a2008-12-10 16:45:50 +00003959u8 sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003960 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003961}
3962
3963/*
drh0f7eb612006-08-08 13:51:43 +00003964** Return the number of references to the pager.
3965*/
danielk19773b8a05f2007-03-19 17:44:26 +00003966int sqlite3PagerRefcount(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003967 return sqlite3PcacheRefCount(pPager->pPCache);
drh0f7eb612006-08-08 13:51:43 +00003968}
3969
danielk197771d5d2c2008-09-29 11:49:47 +00003970/*
3971** Return the number of references to the specified page.
3972*/
3973int sqlite3PagerPageRefcount(DbPage *pPage){
3974 return sqlite3PcachePageRefcount(pPage);
3975}
3976
drh0f7eb612006-08-08 13:51:43 +00003977#ifdef SQLITE_TEST
3978/*
drhd9b02572001-04-15 00:37:09 +00003979** This routine is used for testing and analysis only.
3980*/
danielk19773b8a05f2007-03-19 17:44:26 +00003981int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003982 static int a[11];
danielk19778c0a7912008-08-20 14:49:23 +00003983 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
3984 a[1] = sqlite3PcachePagecount(pPager->pPCache);
3985 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
danielk1977d92db532008-11-17 04:56:24 +00003986 a[3] = pPager->dbSizeValid ? (int) pPager->dbSize : -1;
drhd9b02572001-04-15 00:37:09 +00003987 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003988 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003989 a[6] = pPager->nHit;
3990 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003991 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003992 a[9] = pPager->nRead;
3993 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003994 return a;
3995}
danielk197717b90b52008-06-06 11:11:25 +00003996int sqlite3PagerIsMemdb(Pager *pPager){
3997 return MEMDB;
3998}
drh0f7eb612006-08-08 13:51:43 +00003999#endif
drhdd793422001-06-28 01:54:48 +00004000
drhfa86c412002-02-02 15:01:15 +00004001/*
danielk1977fd7f0452008-12-17 17:30:26 +00004002** Ensure that there are at least nSavepoint savepoints open.
drhfa86c412002-02-02 15:01:15 +00004003*/
danielk1977fd7f0452008-12-17 17:30:26 +00004004int sqlite3PagerOpenSavepoint(Pager *pPager, int nSavepoint){
4005 int rc = SQLITE_OK;
4006
danielk197712dd5492008-12-18 15:45:07 +00004007 if( nSavepoint>pPager->nSavepoint && pPager->useJournal ){
danielk1977fd7f0452008-12-17 17:30:26 +00004008 int ii;
4009
4010 /* Either the sub-journal is open or there are no active savepoints. */
4011 assert( pPager->nSavepoint==0 || pPager->sjfd->pMethods );
4012
4013 /* Grow the Pager.aSavepoint array using realloc(). Return SQLITE_NOMEM
4014 ** if the allocation fails. Otherwise, zero the new portion in case a
4015 ** malloc failure occurs while populating it in the for(...) loop below.
4016 */
4017 PagerSavepoint *aNew = (PagerSavepoint *)sqlite3Realloc(
4018 pPager->aSavepoint, sizeof(PagerSavepoint)*nSavepoint
4019 );
4020 if( !aNew ){
4021 return SQLITE_NOMEM;
4022 }
4023 memset(&aNew[pPager->nSavepoint], 0,
4024 (nSavepoint - pPager->nSavepoint) * sizeof(PagerSavepoint)
4025 );
4026 pPager->aSavepoint = aNew;
4027 ii = pPager->nSavepoint;
4028 pPager->nSavepoint = nSavepoint;
4029
4030 /* Populate the PagerSavepoint structures just allocated. */
4031 for(/* no-op */; ii<nSavepoint; ii++){
danielk197712dd5492008-12-18 15:45:07 +00004032 assert( pPager->dbSizeValid );
danielk1977fd7f0452008-12-17 17:30:26 +00004033 aNew[ii].nOrig = pPager->dbSize;
danielk197767ddef62008-12-23 19:15:56 +00004034 if( pPager->journalOpen && pPager->journalOff>0 ){
4035 aNew[ii].iOffset = pPager->journalOff;
4036 }else{
4037 aNew[ii].iOffset = JOURNAL_HDR_SZ(pPager);
4038 }
danielk1977fd7f0452008-12-17 17:30:26 +00004039 aNew[ii].iSubRec = pPager->stmtNRec;
4040 aNew[ii].pInSavepoint = sqlite3BitvecCreate(pPager->dbSize);
4041 if( !aNew[ii].pInSavepoint ){
4042 return SQLITE_NOMEM;
danielk1977b3175382008-10-17 18:51:52 +00004043 }
drh334b2992007-09-06 23:28:23 +00004044 }
danielk1977fd7f0452008-12-17 17:30:26 +00004045
4046 /* Open the sub-journal, if it is not already opened. */
4047 rc = openSubJournal(pPager);
drh0f892532002-05-30 12:27:03 +00004048 }
danielk1977fd7f0452008-12-17 17:30:26 +00004049
drh86f8c192007-08-22 00:39:19 +00004050 return rc;
4051}
drhfa86c412002-02-02 15:01:15 +00004052
4053/*
danielk1977fd7f0452008-12-17 17:30:26 +00004054** Parameter op is always either SAVEPOINT_ROLLBACK or SAVEPOINT_RELEASE.
4055** If it is SAVEPOINT_RELEASE, then release and destroy the savepoint with
4056** index iSavepoint. If it is SAVEPOINT_ROLLBACK, then rollback all changes
4057** that have occured since savepoint iSavepoint was created.
4058**
4059** In either case, all savepoints with an index greater than iSavepoint
4060** are destroyed.
4061**
4062** If there are less than (iSavepoint+1) active savepoints when this
4063** function is called it is a no-op.
4064*/
4065int sqlite3PagerSavepoint(Pager *pPager, int op, int iSavepoint){
4066 int rc = SQLITE_OK;
4067
4068 assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
4069
4070 if( iSavepoint<pPager->nSavepoint ){
4071 int ii;
4072 int nNew = iSavepoint + (op==SAVEPOINT_ROLLBACK);
4073 for(ii=nNew; ii<pPager->nSavepoint; ii++){
4074 sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
4075 }
4076 pPager->nSavepoint = nNew;
4077
danielk19778a7adb02008-12-22 11:43:35 +00004078 if( op==SAVEPOINT_ROLLBACK && pPager->jfd->pMethods ){
danielk1977f3107512008-12-22 10:58:46 +00004079 PagerSavepoint *pSavepoint = (nNew==0)?0:&pPager->aSavepoint[nNew-1];
danielk1977fd7f0452008-12-17 17:30:26 +00004080 rc = pagerPlaybackSavepoint(pPager, pSavepoint);
4081 assert(rc!=SQLITE_DONE);
4082 }
danielk1977f3107512008-12-22 10:58:46 +00004083
danielk1977fd7f0452008-12-17 17:30:26 +00004084 /* If this is a release of the outermost savepoint, truncate
4085 ** the sub-journal. */
4086 if( nNew==0 && op==SAVEPOINT_RELEASE && pPager->sjfd->pMethods ){
4087 assert( rc==SQLITE_OK );
4088 rc = sqlite3OsTruncate(pPager->sjfd, 0);
4089 pPager->stmtNRec = 0;
danielk1977b3175382008-10-17 18:51:52 +00004090 }
drh663fc632002-02-02 18:49:19 +00004091 }
drhfa86c412002-02-02 15:01:15 +00004092 return rc;
4093}
4094
drh73509ee2003-04-06 20:44:45 +00004095/*
4096** Return the full pathname of the database file.
4097*/
danielk19773b8a05f2007-03-19 17:44:26 +00004098const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004099 return pPager->zFilename;
4100}
4101
drhb20ea9d2004-02-09 01:20:36 +00004102/*
drhd0679ed2007-08-28 22:24:34 +00004103** Return the VFS structure for the pager.
4104*/
4105const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
4106 return pPager->pVfs;
4107}
4108
4109/*
drhcc6bb3e2007-08-31 16:11:35 +00004110** Return the file handle for the database file associated
4111** with the pager. This might return NULL if the file has
4112** not yet been opened.
4113*/
4114sqlite3_file *sqlite3PagerFile(Pager *pPager){
4115 return pPager->fd;
4116}
4117
4118/*
danielk19775865e3d2004-06-14 06:03:57 +00004119** Return the directory of the database file.
4120*/
danielk19773b8a05f2007-03-19 17:44:26 +00004121const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004122 return pPager->zDirectory;
4123}
4124
4125/*
4126** Return the full pathname of the journal file.
4127*/
danielk19773b8a05f2007-03-19 17:44:26 +00004128const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004129 return pPager->zJournal;
4130}
4131
4132/*
drh2c8997b2005-08-27 16:36:48 +00004133** Return true if fsync() calls are disabled for this pager. Return FALSE
4134** if fsync()s are executed normally.
4135*/
danielk19773b8a05f2007-03-19 17:44:26 +00004136int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004137 return pPager->noSync;
4138}
4139
drh7c4ac0c2007-04-05 11:25:58 +00004140#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004141/*
drhb20ea9d2004-02-09 01:20:36 +00004142** Set the codec for this pager
4143*/
danielk19773b8a05f2007-03-19 17:44:26 +00004144void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004145 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004146 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004147 void *pCodecArg
4148){
4149 pPager->xCodec = xCodec;
4150 pPager->pCodecArg = pCodecArg;
4151}
drh7c4ac0c2007-04-05 11:25:58 +00004152#endif
drhb20ea9d2004-02-09 01:20:36 +00004153
danielk1977687566d2004-11-02 12:56:41 +00004154#ifndef SQLITE_OMIT_AUTOVACUUM
4155/*
danielk197787c29a92008-01-18 11:33:16 +00004156** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004157**
drh5e385312007-06-16 04:42:12 +00004158** There must be no references to the page previously located at
4159** pgno (which we call pPgOld) though that page is allowed to be
drhb3df2e12008-09-17 20:06:26 +00004160** in cache. If the page previously located at pgno is not already
drh5e385312007-06-16 04:42:12 +00004161** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004162**
drh5e385312007-06-16 04:42:12 +00004163** References to the page pPg remain valid. Updating any
4164** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004165** allocated along with the page) is the responsibility of the caller.
4166**
danielk19775fd057a2005-03-09 13:09:43 +00004167** A transaction must be active when this routine is called. It used to be
4168** required that a statement transaction was not active, but this restriction
4169** has been removed (CREATE INDEX needs to move a page when a statement
4170** transaction is active).
danielk19774c999992008-07-16 18:17:55 +00004171**
4172** If the fourth argument, isCommit, is non-zero, then this page is being
4173** moved as part of a database reorganization just before the transaction
4174** is being committed. In this case, it is guaranteed that the database page
4175** pPg refers to will not be written to again within this transaction.
danielk1977687566d2004-11-02 12:56:41 +00004176*/
danielk19774c999992008-07-16 18:17:55 +00004177int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
drh5e385312007-06-16 04:42:12 +00004178 PgHdr *pPgOld; /* The page being overwritten. */
danielk197794daf7f2004-11-08 09:26:09 +00004179 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004180
danielk1977687566d2004-11-02 12:56:41 +00004181 assert( pPg->nRef>0 );
4182
drh4f0c5872007-03-26 22:05:01 +00004183 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk19778c0a7912008-08-20 14:49:23 +00004184 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno);
drhb0603412007-02-28 04:47:26 +00004185 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004186
danielk1977b4626a32007-04-28 15:47:43 +00004187 pager_get_content(pPg);
danielk19774c999992008-07-16 18:17:55 +00004188
4189 /* If the journal needs to be sync()ed before page pPg->pgno can
4190 ** be written to, store pPg->pgno in local variable needSyncPgno.
4191 **
4192 ** If the isCommit flag is set, there is no need to remember that
4193 ** the journal needs to be sync()ed before database page pPg->pgno
4194 ** can be written to. The caller has already promised not to write to it.
4195 */
danielk19778c0a7912008-08-20 14:49:23 +00004196 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
danielk197794daf7f2004-11-08 09:26:09 +00004197 needSyncPgno = pPg->pgno;
danielk19773460d192008-12-27 15:23:13 +00004198 assert( pageInJournal(pPg) || pPg->pgno>pPager->dbOrigSize );
danielk19778c0a7912008-08-20 14:49:23 +00004199 assert( pPg->flags&PGHDR_DIRTY );
danielk1977ae825582004-11-23 09:06:55 +00004200 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004201 }
4202
danielk1977ef73ee92004-11-06 12:26:07 +00004203 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00004204 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00004205 ** page pgno before the 'move' operation, it needs to be retained
4206 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004207 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00004208 pPg->flags &= ~PGHDR_NEED_SYNC;
danielk1977687566d2004-11-02 12:56:41 +00004209 pPgOld = pager_lookup(pPager, pgno);
danielk19778c0a7912008-08-20 14:49:23 +00004210 assert( !pPgOld || pPgOld->nRef==1 );
danielk1977687566d2004-11-02 12:56:41 +00004211 if( pPgOld ){
danielk19778c0a7912008-08-20 14:49:23 +00004212 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
drh5e385312007-06-16 04:42:12 +00004213 }
danielk1977687566d2004-11-02 12:56:41 +00004214
danielk19778c0a7912008-08-20 14:49:23 +00004215 sqlite3PcacheMove(pPg, pgno);
4216 if( pPgOld ){
danielk1977bc2ca9e2008-11-13 14:28:28 +00004217 sqlite3PcacheDrop(pPgOld);
danielk1977f5fdda82004-11-03 08:44:05 +00004218 }
danielk1977f5fdda82004-11-03 08:44:05 +00004219
drhc047b9f2008-11-21 03:23:43 +00004220 sqlite3PcacheMakeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004221 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004222 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00004223
danielk197794daf7f2004-11-08 09:26:09 +00004224 if( needSyncPgno ){
4225 /* If needSyncPgno is non-zero, then the journal file needs to be
4226 ** sync()ed before any data is written to database file page needSyncPgno.
4227 ** Currently, no such page exists in the page-cache and the
danielk19774c999992008-07-16 18:17:55 +00004228 ** "is journaled" bitvec flag has been set. This needs to be remedied by
4229 ** loading the page into the pager-cache and setting the PgHdr.needSync
4230 ** flag.
danielk1977ae825582004-11-23 09:06:55 +00004231 **
danielk1977a98d7b42008-01-18 13:42:54 +00004232 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00004233 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00004234 ** array. Otherwise, if the page is loaded and written again in
4235 ** this transaction, it may be written to the database file before
4236 ** it is synced into the journal file. This way, it may end up in
4237 ** the journal file twice, but that is not a problem.
4238 **
danielk19773b8a05f2007-03-19 17:44:26 +00004239 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004240 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004241 */
4242 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004243 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004244 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004245 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00004246 if( rc!=SQLITE_OK ){
danielk19773460d192008-12-27 15:23:13 +00004247 if( pPager->pInJournal && needSyncPgno<=pPager->dbOrigSize ){
drhf5e7bb52008-02-18 14:47:33 +00004248 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00004249 }
danielk197787c29a92008-01-18 11:33:16 +00004250 return rc;
4251 }
danielk1977ae825582004-11-23 09:06:55 +00004252 pPager->needSync = 1;
drhb3df2e12008-09-17 20:06:26 +00004253 assert( pPager->noSync==0 && !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00004254 pPgHdr->flags |= PGHDR_NEED_SYNC;
drhc047b9f2008-11-21 03:23:43 +00004255 sqlite3PcacheMakeDirty(pPgHdr);
danielk19773b8a05f2007-03-19 17:44:26 +00004256 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004257 }
4258
danielk1977687566d2004-11-02 12:56:41 +00004259 return SQLITE_OK;
4260}
4261#endif
4262
danielk19773b8a05f2007-03-19 17:44:26 +00004263/*
4264** Return a pointer to the data for the specified page.
4265*/
4266void *sqlite3PagerGetData(DbPage *pPg){
danielk197771d5d2c2008-09-29 11:49:47 +00004267 assert( pPg->nRef>0 || pPg->pPager->memDb );
danielk19778c0a7912008-08-20 14:49:23 +00004268 return pPg->pData;
danielk19773b8a05f2007-03-19 17:44:26 +00004269}
4270
4271/*
4272** Return a pointer to the Pager.nExtra bytes of "extra" space
4273** allocated along with the specified page.
4274*/
4275void *sqlite3PagerGetExtra(DbPage *pPg){
4276 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00004277 return (pPager?pPg->pExtra:0);
danielk19773b8a05f2007-03-19 17:44:26 +00004278}
4279
danielk197741483462007-03-24 16:45:04 +00004280/*
4281** Get/set the locking-mode for this pager. Parameter eMode must be one
4282** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4283** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4284** the locking-mode is set to the value specified.
4285**
4286** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4287** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4288** locking-mode.
4289*/
4290int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004291 assert( eMode==PAGER_LOCKINGMODE_QUERY
4292 || eMode==PAGER_LOCKINGMODE_NORMAL
4293 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4294 assert( PAGER_LOCKINGMODE_QUERY<0 );
4295 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4296 if( eMode>=0 && !pPager->tempFile ){
drh1bd10f82008-12-10 21:19:56 +00004297 pPager->exclusiveMode = (u8)eMode;
danielk197741483462007-03-24 16:45:04 +00004298 }
4299 return (int)pPager->exclusiveMode;
4300}
4301
drh3b020132008-04-17 17:02:01 +00004302/*
drh04335882008-09-26 21:08:08 +00004303** Get/set the journal-mode for this pager. Parameter eMode must be one of:
drh3b020132008-04-17 17:02:01 +00004304**
drh04335882008-09-26 21:08:08 +00004305** PAGER_JOURNALMODE_QUERY
4306** PAGER_JOURNALMODE_DELETE
4307** PAGER_JOURNALMODE_TRUNCATE
4308** PAGER_JOURNALMODE_PERSIST
4309** PAGER_JOURNALMODE_OFF
4310**
4311** If the parameter is not _QUERY, then the journal-mode is set to the
4312** value specified.
4313**
4314** The returned indicate the current (possibly updated)
drh3b020132008-04-17 17:02:01 +00004315** journal-mode.
4316*/
4317int sqlite3PagerJournalMode(Pager *pPager, int eMode){
danielk1977b3175382008-10-17 18:51:52 +00004318 if( !MEMDB ){
4319 assert( eMode==PAGER_JOURNALMODE_QUERY
4320 || eMode==PAGER_JOURNALMODE_DELETE
4321 || eMode==PAGER_JOURNALMODE_TRUNCATE
4322 || eMode==PAGER_JOURNALMODE_PERSIST
4323 || eMode==PAGER_JOURNALMODE_OFF
4324 || eMode==PAGER_JOURNALMODE_MEMORY );
4325 assert( PAGER_JOURNALMODE_QUERY<0 );
4326 if( eMode>=0 ){
drh1bd10f82008-12-10 21:19:56 +00004327 pPager->journalMode = (u8)eMode;
danielk1977b3175382008-10-17 18:51:52 +00004328 }else{
4329 assert( eMode==PAGER_JOURNALMODE_QUERY );
4330 }
drh3b020132008-04-17 17:02:01 +00004331 }
drhfdc40e92008-04-17 20:59:37 +00004332 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00004333}
4334
danielk1977b53e4962008-06-04 06:45:59 +00004335/*
4336** Get/set the size-limit used for persistent journal files.
4337*/
4338i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
4339 if( iLimit>=-1 ){
4340 pPager->journalSizeLimit = iLimit;
4341 }
4342 return pPager->journalSizeLimit;
4343}
4344
drh2e66f0b2005-04-28 17:18:48 +00004345#endif /* SQLITE_OMIT_DISKIO */