blob: 40e74d91a49f7858c416ead1090576637dc908b4 [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**
danielk1977281d8bd2008-10-29 07:01:56 +000021** @(#) $Id: pager.c,v 1.500 2008/10/29 07:01:57 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/*
drhed7c8552001-04-11 14:29:21 +0000144** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000145**
drh4f0ee682007-03-30 20:43:40 +0000146** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000147** or SQLITE_FULL. Once one of the first three errors occurs, it persists
148** and is returned as the result of every major pager API call. The
149** SQLITE_FULL return code is slightly different. It persists only until the
150** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000151** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000152** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000153*/
154struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000155 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000156 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000157 u8 journalStarted; /* True if header of journal is synced */
158 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000159 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000160 u8 stmtOpen; /* True if the statement subjournal is open */
161 u8 stmtInUse; /* True we are in a statement subtransaction */
162 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000163 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000164 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000165 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000166 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000167 u8 tempFile; /* zFilename is a temporary file */
168 u8 readOnly; /* True for a read-only database */
169 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000170 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000171 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000172 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000173 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000174 u8 doNotSync; /* Boolean. While true, do not spill the cache */
175 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
drhfdc40e92008-04-17 20:59:37 +0000176 u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */
drhd138c012008-05-13 00:58:18 +0000177 u8 dbModified; /* True if there are any changes to the Db */
drh80e35f42007-03-30 14:06:34 +0000178 u8 changeCountDone; /* Set after incrementing the change-counter */
drh33f4e022007-09-03 15:19:34 +0000179 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000180 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000181 int dbSize; /* Number of pages in the file */
182 int origDbSize; /* dbSize before the current change */
183 int stmtSize; /* Size of database (in pages) at stmt_begin() */
184 int nRec; /* Number of pages written to the journal */
185 u32 cksumInit; /* Quasi-random value added to every checksum */
186 int stmtNRec; /* Number of records in stmt subjournal */
187 int nExtra; /* Add this many bytes to each in-memory page */
188 int pageSize; /* Number of bytes in a page */
189 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000190 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000191 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000192 Bitvec *pInJournal; /* One bit for each page in the database file */
193 Bitvec *pInStmt; /* One bit for each page in the database */
danielk1977a1fa00d2008-08-27 15:16:33 +0000194 Bitvec *pAlwaysRollback; /* One bit for each page marked always-rollback */
drhfcd35c72005-05-21 02:48:08 +0000195 char *zFilename; /* Name of the database file */
196 char *zJournal; /* Name of the journal file */
197 char *zDirectory; /* Directory hold database and journal files */
danielk197762079062007-08-15 17:08:46 +0000198 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
199 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000200 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drheb206252004-10-01 02:00:31 +0000201 i64 journalOff; /* Current byte offset in the journal file */
202 i64 journalHdr; /* Byte offset to previous journal header */
203 i64 stmtHdrOff; /* First journal header written this statement */
204 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000205 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000206 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000207#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000208 int nHit, nMiss; /* Cache hits and missing */
209 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000210#endif
danielk1977eaa06f62008-09-18 17:34:44 +0000211 void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000212#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000213 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000214 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000215#endif
danielk19778186df82007-03-06 13:45:59 +0000216 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000217 char dbFileVers[16]; /* Changes whenever database file changes */
danielk1977b53e4962008-06-04 06:45:59 +0000218 i64 journalSizeLimit; /* Size limit for persistent journal files */
danielk19778c0a7912008-08-20 14:49:23 +0000219 PCache *pPCache; /* Pointer to page cache object */
drhd9b02572001-04-15 00:37:09 +0000220};
221
222/*
drh538f5702007-04-13 02:14:30 +0000223** The following global variables hold counters used for
224** testing purposes only. These variables do not exist in
225** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000226*/
227#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000228int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
229int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
230int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
drh538f5702007-04-13 02:14:30 +0000231# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000232#else
drh538f5702007-04-13 02:14:30 +0000233# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000234#endif
235
drh538f5702007-04-13 02:14:30 +0000236
237
drhfcd35c72005-05-21 02:48:08 +0000238/*
drh5e00f6c2001-09-13 13:46:56 +0000239** Journal files begin with the following magic string. The data
240** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000241**
drhae2b40c2004-06-09 19:03:54 +0000242** Since version 2.8.0, the journal format contains additional sanity
243** checking information. If the power fails while the journal is begin
244** written, semi-random garbage data might appear in the journal
245** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000246** to roll the journal back, the database could be corrupted. The additional
247** sanity checking data is an attempt to discover the garbage in the
248** journal and ignore it.
249**
drhae2b40c2004-06-09 19:03:54 +0000250** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000251** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000252** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000253** This cksum is initialized to a 32-bit random value that appears in the
254** journal file right after the header. The random initializer is important,
255** because garbage data that appears at the end of a journal is likely
256** data that was once in other files that have now been deleted. If the
257** garbage data came from an obsolete journal file, the checksums might
258** be correct. But by initializing the checksum to random value which
259** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000260*/
drhae2b40c2004-06-09 19:03:54 +0000261static const unsigned char aJournalMagic[] = {
262 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000263};
264
265/*
drh726de592004-06-10 23:35:50 +0000266** The size of the header and of each page in the journal is determined
267** by the following macros.
drh968af522003-02-11 14:55:40 +0000268*/
drhae2b40c2004-06-09 19:03:54 +0000269#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000270
danielk197776572402004-06-25 02:38:54 +0000271/*
272** The journal header size for this pager. In the future, this could be
273** set to some value read from the disk controller. The important
274** characteristic is that it is the same size as a disk sector.
275*/
276#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
277
drhb7f91642004-10-31 02:22:47 +0000278/*
279** The macro MEMDB is true if we are dealing with an in-memory database.
280** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
281** the value of MEMDB will be a constant and the compiler will optimize
282** out code that would never execute.
283*/
284#ifdef SQLITE_OMIT_MEMORYDB
285# define MEMDB 0
286#else
287# define MEMDB pPager->memDb
288#endif
289
290/*
danielk197776572402004-06-25 02:38:54 +0000291** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
292** reserved for working around a windows/posix incompatibility). It is
293** used in the journal to signify that the remainder of the journal file
294** is devoted to storing a master journal name - there are no more pages to
295** roll back. See comments for function writeMasterJournal() for details.
296*/
danielk1977599fcba2004-11-08 07:13:13 +0000297/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
298#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000299
drh968af522003-02-11 14:55:40 +0000300/*
danielk197726836652005-01-17 01:33:13 +0000301** The maximum legal page number is (2^31 - 1).
302*/
303#define PAGER_MAX_PGNO 2147483647
304
305/*
danielk1977f35843b2007-04-07 15:03:17 +0000306** Return true if page *pPg has already been written to the statement
307** journal (or statement snapshot has been created, if *pPg is part
308** of an in-memory database).
309*/
310static int pageInStatement(PgHdr *pPg){
311 Pager *pPager = pPg->pPager;
danielk1977b3175382008-10-17 18:51:52 +0000312 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000313}
drh8ca0c722006-05-07 17:49:38 +0000314
315/*
drh34e79ce2004-02-08 06:05:46 +0000316** Read a 32-bit integer from the given file descriptor. Store the integer
317** that is read in *pRes. Return SQLITE_OK if everything worked, or an
318** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000319**
320** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000321*/
danielk197762079062007-08-15 17:08:46 +0000322static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000323 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000324 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000325 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000326 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000327 }
drh94f33312002-08-12 12:29:56 +0000328 return rc;
329}
330
331/*
drh97b57482006-01-10 20:32:32 +0000332** Write a 32-bit integer into a string buffer in big-endian byte order.
333*/
drha3152892007-05-05 11:48:52 +0000334#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000335
336/*
drh34e79ce2004-02-08 06:05:46 +0000337** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
338** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000339*/
danielk197762079062007-08-15 17:08:46 +0000340static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000341 char ac[4];
drh97b57482006-01-10 20:32:32 +0000342 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000343 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000344}
345
drh2554f8b2003-01-22 01:26:44 +0000346/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000347** If file pFd is open, call sqlite3OsUnlock() on it.
348*/
349static int osUnlock(sqlite3_file *pFd, int eLock){
350 if( !pFd->pMethods ){
351 return SQLITE_OK;
352 }
353 return sqlite3OsUnlock(pFd, eLock);
354}
355
356/*
danielk1977c7b60172007-08-22 11:22:03 +0000357** This function determines whether or not the atomic-write optimization
358** can be used with this pager. The optimization can be used if:
359**
360** (a) the value returned by OsDeviceCharacteristics() indicates that
361** a database page may be written atomically, and
362** (b) the value returned by OsSectorSize() is less than or equal
363** to the page size.
364**
365** If the optimization cannot be used, 0 is returned. If it can be used,
366** then the value returned is the size of the journal file when it
367** contains rollback data for exactly one page.
368*/
369#ifdef SQLITE_ENABLE_ATOMIC_WRITE
370static int jrnlBufferSize(Pager *pPager){
371 int dc; /* Device characteristics */
372 int nSector; /* Sector size */
drhfacf0302008-06-17 15:12:00 +0000373 int szPage; /* Page size */
danielk1977c7b60172007-08-22 11:22:03 +0000374 sqlite3_file *fd = pPager->fd;
375
376 if( fd->pMethods ){
377 dc = sqlite3OsDeviceCharacteristics(fd);
378 nSector = sqlite3OsSectorSize(fd);
drhfacf0302008-06-17 15:12:00 +0000379 szPage = pPager->pageSize;
danielk1977c7b60172007-08-22 11:22:03 +0000380 }
381
382 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
383 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
384
drhfacf0302008-06-17 15:12:00 +0000385 if( !fd->pMethods ||
386 (dc & (SQLITE_IOCAP_ATOMIC|(szPage>>8)) && nSector<=szPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000387 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
388 }
389 return 0;
390}
391#endif
392
393/*
danielk1977aef0bf62005-12-30 16:28:01 +0000394** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000395** code. The first argument is a pointer to the pager structure, the
396** second the error-code about to be returned by a pager API function.
397** The value returned is a copy of the second argument to this function.
398**
drh4f0ee682007-03-30 20:43:40 +0000399** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000400** the error becomes persistent. Until the persisten error is cleared,
401** subsequent API calls on this Pager will immediately return the same
402** error code.
403**
404** A persistent error indicates that the contents of the pager-cache
405** cannot be trusted. This state can be cleared by completely discarding
406** the contents of the pager-cache. If a transaction was active when
407** the persistent error occured, then the rollback journal may need
408** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000409*/
danielk1977ae72d982007-10-03 08:46:44 +0000410static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000411static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000412 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000413 assert(
414 pPager->errCode==SQLITE_FULL ||
415 pPager->errCode==SQLITE_OK ||
416 (pPager->errCode & 0xff)==SQLITE_IOERR
417 );
danielk1977979f38e2007-03-27 16:19:51 +0000418 if(
drh4ac285a2006-09-15 07:28:50 +0000419 rc2==SQLITE_FULL ||
420 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000421 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000422 ){
423 pPager->errCode = rc;
danielk19778c0a7912008-08-20 14:49:23 +0000424 if( pPager->state==PAGER_UNLOCK
425 && sqlite3PcacheRefCount(pPager->pPCache)==0
426 ){
danielk1977ae72d982007-10-03 08:46:44 +0000427 /* If the pager is already unlocked, call pager_unlock() now to
428 ** clear the error state and ensure that the pager-cache is
429 ** completely empty.
430 */
431 pager_unlock(pPager);
432 }
danielk1977aef0bf62005-12-30 16:28:01 +0000433 }
434 return rc;
435}
436
drh477731b2007-06-16 03:06:27 +0000437/*
438** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
439** on the cache using a hash function. This is used for testing
440** and debugging only.
441*/
danielk19773c407372005-02-15 02:54:14 +0000442#ifdef SQLITE_CHECK_PAGES
443/*
444** Return a 32-bit hash of the page data for pPage.
445*/
drh477731b2007-06-16 03:06:27 +0000446static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000447 u32 hash = 0;
448 int i;
drh477731b2007-06-16 03:06:27 +0000449 for(i=0; i<nByte; i++){
450 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000451 }
452 return hash;
453}
drh477731b2007-06-16 03:06:27 +0000454static u32 pager_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000455 return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
456}
457static u32 pager_set_pagehash(PgHdr *pPage){
458 pPage->pageHash = pager_pagehash(pPage);
drh477731b2007-06-16 03:06:27 +0000459}
danielk19773c407372005-02-15 02:54:14 +0000460
461/*
462** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
463** is defined, and NDEBUG is not defined, an assert() statement checks
464** that the page is either dirty or still matches the calculated page-hash.
465*/
466#define CHECK_PAGE(x) checkPage(x)
467static void checkPage(PgHdr *pPg){
468 Pager *pPager = pPg->pPager;
danielk1977b3175382008-10-17 18:51:52 +0000469 assert( !pPg->pageHash || pPager->errCode
danielk19778c0a7912008-08-20 14:49:23 +0000470 || (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
danielk19773c407372005-02-15 02:54:14 +0000471}
472
473#else
drh8ffa8172007-06-18 17:25:17 +0000474#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000475#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000476#define CHECK_PAGE(x)
drh41d30272008-08-20 21:47:45 +0000477#endif /* SQLITE_CHECK_PAGES */
danielk19773c407372005-02-15 02:54:14 +0000478
drhed7c8552001-04-11 14:29:21 +0000479/*
danielk197776572402004-06-25 02:38:54 +0000480** When this is called the journal file for pager pPager must be open.
481** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000482** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000483**
danielk197765839c62007-08-30 08:08:17 +0000484** zMaster must point to a buffer of at least nMaster bytes allocated by
485** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
486** enough space to write the master journal name). If the master journal
487** name in the journal is longer than nMaster bytes (including a
488** nul-terminator), then this is handled as if no master journal name
489** were present in the journal.
490**
491** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000492** SQLITE_OK returned.
493*/
danielk197765839c62007-08-30 08:08:17 +0000494static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000495 int rc;
496 u32 len;
drheb206252004-10-01 02:00:31 +0000497 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000498 u32 cksum;
shane0b8d2762008-07-22 05:18:00 +0000499 u32 u; /* Unsigned loop counter */
danielk197776572402004-06-25 02:38:54 +0000500 unsigned char aMagic[8]; /* A buffer to hold the magic header */
501
danielk197765839c62007-08-30 08:08:17 +0000502 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000503
drh054889e2005-11-30 03:20:31 +0000504 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000505 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000506
danielk197762079062007-08-15 17:08:46 +0000507 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000508 if( rc!=SQLITE_OK ) return rc;
509
danielk197765839c62007-08-30 08:08:17 +0000510 if( len>=nMaster ){
511 return SQLITE_OK;
512 }
513
danielk197762079062007-08-15 17:08:46 +0000514 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000515 if( rc!=SQLITE_OK ) return rc;
516
danielk197762079062007-08-15 17:08:46 +0000517 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000518 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
519
danielk197765839c62007-08-30 08:08:17 +0000520 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000521 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000522 return rc;
523 }
danielk197765839c62007-08-30 08:08:17 +0000524 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000525
526 /* See if the checksum matches the master journal name */
shane0b8d2762008-07-22 05:18:00 +0000527 for(u=0; u<len; u++){
528 cksum -= zMaster[u];
danielk197765839c62007-08-30 08:08:17 +0000529 }
danielk19778191bff2004-06-28 04:52:30 +0000530 if( cksum ){
531 /* If the checksum doesn't add up, then one or more of the disk sectors
532 ** containing the master journal filename is corrupted. This means
533 ** definitely roll back, so just return SQLITE_OK and report a (nul)
534 ** master-journal filename.
535 */
danielk197765839c62007-08-30 08:08:17 +0000536 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000537 }
danielk197776572402004-06-25 02:38:54 +0000538
539 return SQLITE_OK;
540}
541
542/*
543** Seek the journal file descriptor to the next sector boundary where a
544** journal header may be read or written. Pager.journalOff is updated with
545** the new seek offset.
546**
547** i.e for a sector size of 512:
548**
549** Input Offset Output Offset
550** ---------------------------------------
551** 0 0
552** 512 512
553** 100 512
554** 2000 2048
555**
556*/
danielk197762079062007-08-15 17:08:46 +0000557static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000558 i64 offset = 0;
559 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000560 if( c ){
561 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
562 }
563 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
564 assert( offset>=c );
565 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
566 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000567}
568
569/*
drhf3a87622008-04-17 14:16:42 +0000570** Write zeros over the header of the journal file. This has the
571** effect of invalidating the journal file and committing the
572** transaction.
573*/
danielk1977df2566a2008-05-07 19:11:03 +0000574static int zeroJournalHdr(Pager *pPager, int doTruncate){
575 int rc = SQLITE_OK;
danielk197755a25a12008-09-11 10:29:15 +0000576 static const char zeroHdr[28] = {0};
drhf3a87622008-04-17 14:16:42 +0000577
danielk1977df2566a2008-05-07 19:11:03 +0000578 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000579 i64 iLimit = pPager->journalSizeLimit;
580
danielk1977df2566a2008-05-07 19:11:03 +0000581 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000582 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000583 rc = sqlite3OsTruncate(pPager->jfd, 0);
584 }else{
585 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
586 }
danielk197781620542008-06-07 05:19:37 +0000587 if( rc==SQLITE_OK && !pPager->noSync ){
danielk1977df2566a2008-05-07 19:11:03 +0000588 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
589 }
danielk1977b53e4962008-06-04 06:45:59 +0000590
591 /* At this point the transaction is committed but the write lock
592 ** is still held on the file. If there is a size limit configured for
593 ** the persistent journal and the journal file currently consumes more
594 ** space than that limit allows for, truncate it now. There is no need
595 ** to sync the file following this operation.
596 */
597 if( rc==SQLITE_OK && iLimit>0 ){
598 i64 sz;
599 rc = sqlite3OsFileSize(pPager->jfd, &sz);
600 if( rc==SQLITE_OK && sz>iLimit ){
601 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
602 }
603 }
drha06ecba2008-04-22 17:15:17 +0000604 }
drhf3a87622008-04-17 14:16:42 +0000605 return rc;
606}
607
608/*
danielk197776572402004-06-25 02:38:54 +0000609** The journal file must be open when this routine is called. A journal
610** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
611** current location.
612**
613** The format for the journal header is as follows:
614** - 8 bytes: Magic identifying journal format.
615** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
616** - 4 bytes: Random number used for page hash.
617** - 4 bytes: Initial database page count.
618** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000619** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000620**
danielk197767c007b2008-03-20 04:45:49 +0000621** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000622*/
623static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000624 int rc = SQLITE_OK;
625 char *zHeader = pPager->pTmpSpace;
626 int nHeader = pPager->pageSize;
627 int nWrite;
628
629 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
630 nHeader = JOURNAL_HDR_SZ(pPager);
631 }
danielk197776572402004-06-25 02:38:54 +0000632
danielk19774099f6e2007-03-19 11:25:20 +0000633 if( pPager->stmtHdrOff==0 ){
634 pPager->stmtHdrOff = pPager->journalOff;
635 }
636
danielk197762079062007-08-15 17:08:46 +0000637 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000638 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000639
drh97b57482006-01-10 20:32:32 +0000640 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +0000641
642 /*
643 ** Write the nRec Field - the number of page records that follow this
644 ** journal header. Normally, zero is written to this value at this time.
645 ** After the records are added to the journal (and the journal synced,
646 ** if in full-sync mode), the zero is overwritten with the true number
647 ** of records (see syncJournal()).
648 **
649 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
650 ** reading the journal this value tells SQLite to assume that the
651 ** rest of the journal file contains valid page records. This assumption
652 ** is dangerous, as if a failure occured whilst writing to the journal
653 ** file it may contain some garbage data. There are two scenarios
654 ** where this risk can be ignored:
655 **
656 ** * When the pager is in no-sync mode. Corruption can follow a
657 ** power failure in this case anyway.
658 **
659 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
660 ** that garbage data is never appended to the journal file.
661 */
662 assert(pPager->fd->pMethods||pPager->noSync);
danielk1977b3175382008-10-17 18:51:52 +0000663 if( (pPager->noSync) || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY)
danielk19774cd2cd52007-08-23 14:48:23 +0000664 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
665 ){
666 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
667 }else{
668 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
669 }
670
drh97b57482006-01-10 20:32:32 +0000671 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +0000672 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +0000673 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
674 /* The initial database size */
675 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
676 /* The assumed sector size for this process */
677 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +0000678 if( pPager->journalHdr==0 ){
679 /* The page size */
680 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
681 }
danielk197776572402004-06-25 02:38:54 +0000682
danielk1977a664f8e2008-04-22 14:31:48 +0000683 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
684 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
685 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
686 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +0000687 }
danielk1977a664f8e2008-04-22 14:31:48 +0000688
danielk197776572402004-06-25 02:38:54 +0000689 return rc;
690}
691
692/*
693** The journal file must be open when this is called. A journal header file
694** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
695** file. See comments above function writeJournalHdr() for a description of
696** the journal header format.
697**
698** If the header is read successfully, *nRec is set to the number of
699** page records following this header and *dbSize is set to the size of the
700** database before the transaction began, in pages. Also, pPager->cksumInit
701** is set to the value read from the journal header. SQLITE_OK is returned
702** in this case.
703**
704** If the journal header file appears to be corrupted, SQLITE_DONE is
705** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
706** cannot be read from the journal file an error code is returned.
707*/
708static int readJournalHdr(
709 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000710 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000711 u32 *pNRec,
712 u32 *pDbSize
713){
714 int rc;
715 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000716 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +0000717 int iPageSize;
danielk197776572402004-06-25 02:38:54 +0000718
danielk197762079062007-08-15 17:08:46 +0000719 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000720 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
721 return SQLITE_DONE;
722 }
danielk197762079062007-08-15 17:08:46 +0000723 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000724
danielk197762079062007-08-15 17:08:46 +0000725 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000726 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000727 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000728
729 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
730 return SQLITE_DONE;
731 }
732
danielk197762079062007-08-15 17:08:46 +0000733 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000734 if( rc ) return rc;
735
danielk197762079062007-08-15 17:08:46 +0000736 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000737 if( rc ) return rc;
738
danielk197762079062007-08-15 17:08:46 +0000739 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000740 if( rc ) return rc;
741
danielk197767c007b2008-03-20 04:45:49 +0000742 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
743 if( rc==SQLITE_OK
744 && iPageSize>=512
745 && iPageSize<=SQLITE_MAX_PAGE_SIZE
746 && ((iPageSize-1)&iPageSize)==0
747 ){
748 u16 pagesize = iPageSize;
749 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
750 }
751 if( rc ) return rc;
752
danielk197776572402004-06-25 02:38:54 +0000753 /* Update the assumed sector-size to match the value used by
754 ** the process that created this journal. If this journal was
755 ** created by a process other than this one, then this routine
756 ** is being called from within pager_playback(). The local value
757 ** of Pager.sectorSize is restored at the end of that routine.
758 */
danielk197762079062007-08-15 17:08:46 +0000759 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000760 if( rc ) return rc;
761
762 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +0000763 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000764}
765
766
767/*
768** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000769** pPager at the current location. The master journal name must be the last
770** thing written to a journal file. If the pager is in full-sync mode, the
771** journal file descriptor is advanced to the next sector boundary before
772** anything is written. The format is:
773**
774** + 4 bytes: PAGER_MJ_PGNO.
775** + N bytes: length of master journal name.
776** + 4 bytes: N
777** + 4 bytes: Master journal name checksum.
778** + 8 bytes: aJournalMagic[].
779**
780** The master journal page checksum is the sum of the bytes in the master
781** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000782**
783** If zMaster is a NULL pointer (occurs for a single database transaction),
784** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000785*/
786static int writeMasterJournal(Pager *pPager, const char *zMaster){
787 int rc;
788 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000789 int i;
danielk197762079062007-08-15 17:08:46 +0000790 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +0000791 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +0000792 u32 cksum = 0;
793 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000794
danielk1977b3175382008-10-17 18:51:52 +0000795 if( !zMaster || pPager->setMaster ) return SQLITE_OK;
796 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ) return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000797 pPager->setMaster = 1;
798
799 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000800 for(i=0; i<len; i++){
801 cksum += zMaster[i];
802 }
danielk197776572402004-06-25 02:38:54 +0000803
804 /* If in full-sync mode, advance to the next disk sector before writing
805 ** the master journal name. This is in case the previous page written to
806 ** the journal has already been synced.
807 */
808 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000809 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000810 }
danielk197762079062007-08-15 17:08:46 +0000811 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000812 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000813
danielk197762079062007-08-15 17:08:46 +0000814 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000815 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000816 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000817
danielk197762079062007-08-15 17:08:46 +0000818 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000819 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000820 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000821
drh97b57482006-01-10 20:32:32 +0000822 put32bits(zBuf, len);
823 put32bits(&zBuf[4], cksum);
824 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000825 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +0000826 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +0000827 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +0000828
829 /* If the pager is in peristent-journal mode, then the physical
830 ** journal-file may extend past the end of the master-journal name
831 ** and 8 bytes of magic data just written to the file. This is
832 ** dangerous because the code to rollback a hot-journal file
833 ** will not be able to find the master-journal name to determine
834 ** whether or not the journal is hot.
835 **
836 ** Easiest thing to do in this scenario is to truncate the journal
837 ** file to the required size.
838 */
839 if( (rc==SQLITE_OK)
840 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
841 && jrnlSize>jrnlOff
842 ){
843 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
844 }
danielk197776572402004-06-25 02:38:54 +0000845 return rc;
846}
847
848/*
drhed7c8552001-04-11 14:29:21 +0000849** Find a page in the hash table given its page number. Return
850** a pointer to the page or NULL if not found.
851*/
drhd9b02572001-04-15 00:37:09 +0000852static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000853 PgHdr *p;
danielk19778c0a7912008-08-20 14:49:23 +0000854 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &p);
drhed7c8552001-04-11 14:29:21 +0000855 return p;
856}
857
858/*
danielk1977e180dd92007-04-05 17:15:52 +0000859** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000860** sets the state of the pager back to what it was when it was first
861** opened. Any outstanding pages are invalidated and subsequent attempts
862** to access those pages will likely result in a coredump.
863*/
drhd9b02572001-04-15 00:37:09 +0000864static void pager_reset(Pager *pPager){
danielk1977efaaf572006-01-16 11:29:19 +0000865 if( pPager->errCode ) return;
danielk19778c0a7912008-08-20 14:49:23 +0000866 sqlite3PcacheClear(pPager->pPCache);
danielk1977e277be02007-03-23 18:12:06 +0000867}
868
869/*
danielk1977ae72d982007-10-03 08:46:44 +0000870** Unlock the database file.
871**
872** If the pager is currently in error state, discard the contents of
873** the cache and reset the Pager structure internal state. If there is
874** an open journal-file, then the next time a shared-lock is obtained
875** on the pager file (by this or any other process), it will be
876** treated as a hot-journal and rolled back.
877*/
878static void pager_unlock(Pager *pPager){
879 if( !pPager->exclusiveMode ){
danielk1977b3175382008-10-17 18:51:52 +0000880 int rc = osUnlock(pPager->fd, NO_LOCK);
881 if( rc ) pPager->errCode = rc;
882 pPager->dbSize = -1;
883 IOTRACE(("UNLOCK %p\n", pPager))
danielk1977ae72d982007-10-03 08:46:44 +0000884
danielk1977b3175382008-10-17 18:51:52 +0000885 /* Always close the journal file when dropping the database lock.
886 ** Otherwise, another connection with journal_mode=delete might
887 ** delete the file out from under us.
888 */
889 if( pPager->journalOpen ){
890 sqlite3OsClose(pPager->jfd);
891 pPager->journalOpen = 0;
892 sqlite3BitvecDestroy(pPager->pInJournal);
893 pPager->pInJournal = 0;
894 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
895 pPager->pAlwaysRollback = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000896 }
897
danielk1977b3175382008-10-17 18:51:52 +0000898 /* If Pager.errCode is set, the contents of the pager cache cannot be
899 ** trusted. Now that the pager file is unlocked, the contents of the
900 ** cache can be discarded and the error code safely cleared.
901 */
902 if( pPager->errCode ){
903 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
904 pager_reset(pPager);
905 if( pPager->stmtOpen ){
906 sqlite3OsClose(pPager->stfd);
907 sqlite3BitvecDestroy(pPager->pInStmt);
908 pPager->pInStmt = 0;
909 }
910 pPager->stmtOpen = 0;
911 pPager->stmtInUse = 0;
912 pPager->journalOff = 0;
913 pPager->journalStarted = 0;
914 pPager->stmtAutoopen = 0;
915 pPager->origDbSize = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000916 }
danielk1977b3175382008-10-17 18:51:52 +0000917
918 pPager->state = PAGER_UNLOCK;
919 pPager->changeCountDone = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000920 }
921}
922
923/*
924** Execute a rollback if a transaction is active and unlock the
925** database file. If the pager has already entered the error state,
926** do not attempt the rollback.
927*/
928static void pagerUnlockAndRollback(Pager *p){
danielk1977ae72d982007-10-03 08:46:44 +0000929 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
danielk19772d1d86f2008-06-20 14:59:51 +0000930 sqlite3BeginBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000931 sqlite3PagerRollback(p);
danielk19772d1d86f2008-06-20 14:59:51 +0000932 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000933 }
934 pager_unlock(p);
danielk1977ae72d982007-10-03 08:46:44 +0000935}
936
937/*
drh80e35f42007-03-30 14:06:34 +0000938** This routine ends a transaction. A transaction is ended by either
939** a COMMIT or a ROLLBACK.
940**
drhed7c8552001-04-11 14:29:21 +0000941** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +0000942** a RESERVED or EXCLUSIVE lock on the database. This routine will release
943** the database lock and acquires a SHARED lock in its place if that is
944** the appropriate thing to do. Release locks usually is appropriate,
945** unless we are in exclusive access mode or unless this is a
946** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
947**
948** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +0000949**
950** TODO: Consider keeping the journal file open for temporary databases.
951** This might give a performance improvement on windows where opening
952** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000953*/
danielk1977df2566a2008-05-07 19:11:03 +0000954static int pager_end_transaction(Pager *pPager, int hasMaster){
danielk197741483462007-03-24 16:45:04 +0000955 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +0000956 int rc2 = SQLITE_OK;
drha6abd042004-06-09 17:37:22 +0000957 if( pPager->state<PAGER_RESERVED ){
958 return SQLITE_OK;
959 }
danielk19773b8a05f2007-03-19 17:44:26 +0000960 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +0000961 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +0000962 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +0000963 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000964 }
drhda47d772002-12-02 04:25:19 +0000965 if( pPager->journalOpen ){
danielk1977b3175382008-10-17 18:51:52 +0000966 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
967 int isMemoryJournal = sqlite3IsMemJournal(pPager->jfd);
968 sqlite3OsClose(pPager->jfd);
969 pPager->journalOpen = 0;
970 if( !isMemoryJournal ){
971 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
972 }
973 }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE
drh04335882008-09-26 21:08:08 +0000974 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){
975 pPager->journalOff = 0;
976 pPager->journalStarted = 0;
977 }else if( pPager->exclusiveMode
danielk197793f7af92008-05-09 16:57:50 +0000978 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
979 ){
980 rc = zeroJournalHdr(pPager, hasMaster);
981 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +0000982 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +0000983 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +0000984 }else{
drh04335882008-09-26 21:08:08 +0000985 assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE || rc );
danielk1977b4b47412007-08-17 15:53:36 +0000986 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +0000987 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +0000988 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +0000989 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +0000990 }
danielk197741483462007-03-24 16:45:04 +0000991 }
drhf5e7bb52008-02-18 14:47:33 +0000992 sqlite3BitvecDestroy(pPager->pInJournal);
993 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +0000994 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
995 pPager->pAlwaysRollback = 0;
danielk19778c0a7912008-08-20 14:49:23 +0000996 sqlite3PcacheCleanAll(pPager->pPCache);
danielk19773c407372005-02-15 02:54:14 +0000997#ifdef SQLITE_CHECK_PAGES
danielk19778c0a7912008-08-20 14:49:23 +0000998 sqlite3PcacheIterate(pPager->pPCache, pager_set_pagehash);
danielk19773c407372005-02-15 02:54:14 +0000999#endif
drhb3df2e12008-09-17 20:06:26 +00001000 sqlite3PcacheClearFlags(pPager->pPCache,
1001 PGHDR_IN_JOURNAL | PGHDR_NEED_SYNC
danielk19778c0a7912008-08-20 14:49:23 +00001002 );
danielk1977ef317ab2004-06-23 10:43:10 +00001003 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001004 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001005 }else{
drhf5e7bb52008-02-18 14:47:33 +00001006 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001007 }
danielk1977979f38e2007-03-27 16:19:51 +00001008
danielk197741483462007-03-24 16:45:04 +00001009 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001010 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001011 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001012 }else if( pPager->state==PAGER_SYNCED ){
1013 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001014 }
danielk1977334cdb62007-03-26 08:05:12 +00001015 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001016 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001017 pPager->needSync = 0;
danielk19778c0a7912008-08-20 14:49:23 +00001018 /* lruListSetFirstSynced(pPager); */
danielk1977b3175382008-10-17 18:51:52 +00001019 if( !MEMDB ){
1020 pPager->dbSize = -1;
1021 }
drhd138c012008-05-13 00:58:18 +00001022 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001023
1024 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001025}
1026
drhed7c8552001-04-11 14:29:21 +00001027/*
drh968af522003-02-11 14:55:40 +00001028** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001029**
1030** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001031** random initial value and the page number. We experimented with
1032** a checksum of the entire data, but that was found to be too slow.
1033**
1034** Note that the page number is stored at the beginning of data and
1035** the checksum is stored at the end. This is important. If journal
1036** corruption occurs due to a power failure, the most likely scenario
1037** is that one end or the other of the record will be changed. It is
1038** much less likely that the two ends of the journal record will be
1039** correct and the middle be corrupt. Thus, this "checksum" scheme,
1040** though fast and simple, catches the mostly likely kind of corruption.
1041**
1042** FIX ME: Consider adding every 200th (or so) byte of the data to the
1043** checksum. That way if a single page spans 3 or more disk sectors and
1044** only the middle sector is corrupt, we will still have a reasonable
1045** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001046*/
drh74161702006-02-24 02:53:49 +00001047static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001048 u32 cksum = pPager->cksumInit;
1049 int i = pPager->pageSize-200;
1050 while( i>0 ){
1051 cksum += aData[i];
1052 i -= 200;
1053 }
drh968af522003-02-11 14:55:40 +00001054 return cksum;
1055}
1056
drh605ad8f2006-05-03 23:34:05 +00001057/* Forward declaration */
1058static void makeClean(PgHdr*);
1059
drh968af522003-02-11 14:55:40 +00001060/*
drhfa86c412002-02-02 15:01:15 +00001061** Read a single page from the journal file opened on file descriptor
1062** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001063**
drhc13148f2008-08-27 18:03:20 +00001064** The isMainJrnl flag is true if this is the main rollback journal and
1065** false for the statement journal. The main rollback journal uses
1066** checksums - the statement journal does not.
drhfa86c412002-02-02 15:01:15 +00001067*/
danielk197762079062007-08-15 17:08:46 +00001068static int pager_playback_one_page(
drhc13148f2008-08-27 18:03:20 +00001069 Pager *pPager, /* The pager being played back */
1070 sqlite3_file *jfd, /* The file that is the journal being rolled back */
1071 i64 offset, /* Offset of the page within the journal */
1072 int isMainJrnl /* True for main rollback journal. False for Stmt jrnl */
danielk197762079062007-08-15 17:08:46 +00001073){
drhfa86c412002-02-02 15:01:15 +00001074 int rc;
drhae2b40c2004-06-09 19:03:54 +00001075 PgHdr *pPg; /* An existing page in the cache */
1076 Pgno pgno; /* The page number of a page in journal */
1077 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001078 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001079
drhc13148f2008-08-27 18:03:20 +00001080 /* isMainJrnl should be true for the main journal and false for
drh96362842005-03-20 22:47:56 +00001081 ** statement journals. Verify that this is always the case
1082 */
drhc13148f2008-08-27 18:03:20 +00001083 assert( jfd == (isMainJrnl ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001084 assert( aData );
drh96362842005-03-20 22:47:56 +00001085
danielk197762079062007-08-15 17:08:46 +00001086 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001087 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001088 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001089 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001090 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001091
drh968af522003-02-11 14:55:40 +00001092 /* Sanity checking on the page. This is more important that I originally
1093 ** thought. If a power failure occurs while the journal is being written,
1094 ** it could cause invalid data to be written into the journal. We need to
1095 ** detect this invalid data (with high probability) and ignore it.
1096 */
danielk197775edc162004-06-26 01:48:18 +00001097 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001098 return SQLITE_DONE;
1099 }
drhae2b40c2004-06-09 19:03:54 +00001100 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001101 return SQLITE_OK;
1102 }
drhc13148f2008-08-27 18:03:20 +00001103 if( isMainJrnl ){
danielk197762079062007-08-15 17:08:46 +00001104 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001105 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001106 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001107 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001108 return SQLITE_DONE;
1109 }
1110 }
drhfa86c412002-02-02 15:01:15 +00001111
danielk1977aa5ccdf2004-06-14 05:10:42 +00001112 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001113
1114 /* If the pager is in RESERVED state, then there must be a copy of this
1115 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001116 ** not the database file. The page is left marked dirty in this case.
1117 **
danielk19772df71c72007-05-24 07:22:42 +00001118 ** An exception to the above rule: If the database is in no-sync mode
1119 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001120 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1121 ** during a Movepage() call, then the page may not be in the cache
1122 ** either. So the condition described in the above paragraph is not
1123 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001124 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001125 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1126 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001127 **
1128 ** Ticket #1171: The statement journal might contain page content that is
1129 ** different from the page content at the start of the transaction.
1130 ** This occurs when a page is changed prior to the start of a statement
1131 ** then changed again within the statement. When rolling back such a
1132 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001133 ** for certain that original page contents are synced into the main rollback
1134 ** journal. Otherwise, a power loss might leave modified data in the
1135 ** database file without an entry in the rollback journal that can
1136 ** restore the database to its original form. Two conditions must be
1137 ** met before writing to the database files. (1) the database must be
1138 ** locked. (2) we know that the original page content is fully synced
1139 ** in the main journal either because the page is not in cache or else
1140 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001141 **
1142 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1143 ** is possible to fail a statement on a database that does not yet exist.
1144 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001145 */
drhae2b40c2004-06-09 19:03:54 +00001146 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001147 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1148 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
danielk19778c0a7912008-08-20 14:49:23 +00001149 if( (pPager->state>=PAGER_EXCLUSIVE)
1150 && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC))
1151 && (pPager->fd->pMethods)
1152 ){
drh281b21d2008-08-22 12:57:08 +00001153 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
1154 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst);
danielk1977a3f3a5f2004-06-10 04:32:16 +00001155 }
drhfa86c412002-02-02 15:01:15 +00001156 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001157 /* No page should ever be explicitly rolled back that is in use, except
1158 ** for page 1 which is held in use in order to keep the lock on the
1159 ** database active. However such a page may be rolled back as a result
1160 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001161 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001162 */
drhb6f41482004-05-14 01:58:11 +00001163 void *pData;
danielk19778c0a7912008-08-20 14:49:23 +00001164 pData = pPg->pData;
drhae2b40c2004-06-09 19:03:54 +00001165 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001166 if( pPager->xReiniter ){
danielk1977eaa06f62008-09-18 17:34:44 +00001167 pPager->xReiniter(pPg);
drhde647132004-05-07 17:57:49 +00001168 }
drhc13148f2008-08-27 18:03:20 +00001169 if( isMainJrnl ) makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00001170#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001171 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001172#endif
drh86a88112007-04-16 15:02:19 +00001173 /* If this was page 1, then restore the value of Pager.dbFileVers.
1174 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001175 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001176 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001177 }
drh86a88112007-04-16 15:02:19 +00001178
1179 /* Decode the page just read from disk */
1180 CODEC1(pPager, pData, pPg->pgno, 3);
danielk19778c0a7912008-08-20 14:49:23 +00001181 sqlite3PcacheRelease(pPg);
drhfa86c412002-02-02 15:01:15 +00001182 }
1183 return rc;
1184}
1185
1186/*
danielk197713adf8a2004-06-03 16:08:41 +00001187** Parameter zMaster is the name of a master journal file. A single journal
1188** file that referred to the master journal file has just been rolled back.
1189** This routine checks if it is possible to delete the master journal file,
1190** and does so if it is.
drh726de592004-06-10 23:35:50 +00001191**
danielk197765839c62007-08-30 08:08:17 +00001192** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1193** available for use within this function.
1194**
1195**
drh726de592004-06-10 23:35:50 +00001196** The master journal file contains the names of all child journals.
1197** To tell if a master journal can be deleted, check to each of the
1198** children. If all children are either missing or do not refer to
1199** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001200*/
danielk1977b4b47412007-08-17 15:53:36 +00001201static int pager_delmaster(Pager *pPager, const char *zMaster){
1202 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001203 int rc;
1204 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001205 sqlite3_file *pMaster;
1206 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001207 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001208 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001209
1210 /* Open the master journal file exclusively in case some other process
1211 ** is running this routine also. Not that it makes too much difference.
1212 */
drhe5ae5732008-06-15 02:51:47 +00001213 pMaster = (sqlite3_file *)sqlite3Malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001214 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001215 if( !pMaster ){
1216 rc = SQLITE_NOMEM;
1217 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001218 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1219 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001220 }
danielk197713adf8a2004-06-03 16:08:41 +00001221 if( rc!=SQLITE_OK ) goto delmaster_out;
1222 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001223
1224 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001225 if( rc!=SQLITE_OK ) goto delmaster_out;
1226
1227 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001228 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001229 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001230 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001231
1232 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001233 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001234 */
drhe5ae5732008-06-15 02:51:47 +00001235 zMasterJournal = (char *)sqlite3Malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001236 if( !zMasterJournal ){
1237 rc = SQLITE_NOMEM;
1238 goto delmaster_out;
1239 }
danielk197765839c62007-08-30 08:08:17 +00001240 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001241 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001242 if( rc!=SQLITE_OK ) goto delmaster_out;
1243
danielk19775865e3d2004-06-14 06:03:57 +00001244 zJournal = zMasterJournal;
1245 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977861f7452008-06-05 11:39:11 +00001246 int exists;
1247 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
1248 if( rc!=SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001249 goto delmaster_out;
1250 }
danielk1977861f7452008-06-05 11:39:11 +00001251 if( exists ){
danielk197713adf8a2004-06-03 16:08:41 +00001252 /* One of the journals pointed to by the master journal exists.
1253 ** Open it and check if it points at the master journal. If
1254 ** so, return without deleting the master journal file.
1255 */
drh3b7b78b2004-11-24 01:16:43 +00001256 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001257 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1258 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001259 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001260 goto delmaster_out;
1261 }
danielk197713adf8a2004-06-03 16:08:41 +00001262
danielk197765839c62007-08-30 08:08:17 +00001263 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001264 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001265 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001266 goto delmaster_out;
1267 }
danielk197776572402004-06-25 02:38:54 +00001268
danielk197765839c62007-08-30 08:08:17 +00001269 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001270 if( c ){
danielk197776572402004-06-25 02:38:54 +00001271 /* We have a match. Do not delete the master journal file. */
1272 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001273 }
1274 }
danielk19775865e3d2004-06-14 06:03:57 +00001275 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001276 }
1277 }
1278
danielk1977fee2d252007-08-18 10:59:19 +00001279 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001280
1281delmaster_out:
1282 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001283 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001284 }
1285 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001286 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001287 }
danielk1977b4b47412007-08-17 15:53:36 +00001288 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001289 return rc;
1290}
1291
drha6abd042004-06-09 17:37:22 +00001292
danielk1977e180dd92007-04-05 17:15:52 +00001293static void pager_truncate_cache(Pager *pPager);
1294
drha6abd042004-06-09 17:37:22 +00001295/*
drhcb4c40b2004-08-18 19:09:43 +00001296** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001297** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001298**
1299** Might might be the case that the file on disk is smaller than nPage.
1300** This can happen, for example, if we are in the middle of a transaction
1301** which has extended the file size and the new pages are still all held
1302** in cache, then an INSERT or UPDATE does a statement rollback. Some
1303** operating system implementations can get confused if you try to
1304** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001305** so detect this case and write a single zero byte to the end of the new
1306** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001307*/
1308static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001309 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001310 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001311 i64 currentSize, newSize;
1312 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1313 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001314 if( rc==SQLITE_OK && currentSize!=newSize ){
1315 if( currentSize>newSize ){
1316 rc = sqlite3OsTruncate(pPager->fd, newSize);
1317 }else{
1318 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1319 }
drh7fe3f7e2007-11-29 18:44:27 +00001320 }
danielk1977e180dd92007-04-05 17:15:52 +00001321 }
1322 if( rc==SQLITE_OK ){
1323 pPager->dbSize = nPage;
1324 pager_truncate_cache(pPager);
1325 }
1326 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001327}
1328
1329/*
drhc80f0582007-05-01 16:59:48 +00001330** Set the sectorSize for the given pager.
1331**
drh334c80d2008-03-28 17:41:13 +00001332** The sector size is at least as big as the sector size reported
1333** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001334*/
1335static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001336 assert(pPager->fd->pMethods||pPager->tempFile);
1337 if( !pPager->tempFile ){
1338 /* Sector size doesn't matter for temporary files. Also, the file
1339 ** may not have been opened yet, in whcih case the OsSectorSize()
1340 ** call will segfault.
1341 */
1342 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1343 }
drh334c80d2008-03-28 17:41:13 +00001344 if( pPager->sectorSize<512 ){
1345 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001346 }
1347}
1348
1349/*
drhed7c8552001-04-11 14:29:21 +00001350** Playback the journal and thus restore the database file to
1351** the state it was in before we started making changes.
1352**
drh34e79ce2004-02-08 06:05:46 +00001353** The journal file format is as follows:
1354**
drhae2b40c2004-06-09 19:03:54 +00001355** (1) 8 byte prefix. A copy of aJournalMagic[].
1356** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001357** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001358** number of page records from the journal size.
1359** (3) 4 byte big-endian integer which is the initial value for the
1360** sanity checksum.
1361** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001362** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001363** (5) 4 byte big-endian integer which is the sector size. The header
1364** is this many bytes in size.
1365** (6) 4 byte big-endian integer which is the page case.
1366** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001367** name. The value may be zero (indicate that there is no master
1368** journal.)
drh334c80d2008-03-28 17:41:13 +00001369** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001370** and might be shorter than the value read from (5). If the first byte
1371** of the name is \000 then there is no master journal. The master
1372** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001373** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001374** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001375** + pPager->pageSize bytes of data.
1376** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001377**
drh334c80d2008-03-28 17:41:13 +00001378** When we speak of the journal header, we mean the first 8 items above.
1379** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001380**
1381** Call the value from the second bullet "nRec". nRec is the number of
1382** valid page entries in the journal. In most cases, you can compute the
1383** value of nRec from the size of the journal file. But if a power
1384** failure occurred while the journal was being written, it could be the
1385** case that the size of the journal file had already been increased but
1386** the extra entries had not yet made it safely to disk. In such a case,
1387** the value of nRec computed from the file size would be too large. For
1388** that reason, we always use the nRec value in the header.
1389**
1390** If the nRec value is 0xffffffff it means that nRec should be computed
1391** from the file size. This value is used when the user selects the
1392** no-sync option for the journal. A power failure could lead to corruption
1393** in this case. But for things like temporary table (which will be
1394** deleted when the power is restored) we don't care.
1395**
drhd9b02572001-04-15 00:37:09 +00001396** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001397** journal file then all pages up to the first corrupted page are rolled
1398** back (or no pages if the journal header is corrupted). The journal file
1399** is then deleted and SQLITE_OK returned, just as if no corruption had
1400** been encountered.
1401**
1402** If an I/O or malloc() error occurs, the journal-file is not deleted
1403** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001404*/
danielk1977e277be02007-03-23 18:12:06 +00001405static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001406 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001407 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001408 u32 nRec; /* Number of Records in the journal */
shane0b8d2762008-07-22 05:18:00 +00001409 u32 u; /* Unsigned loop counter */
drhd9b02572001-04-15 00:37:09 +00001410 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001411 int rc; /* Result code of a subroutine */
danielk1977861f7452008-06-05 11:39:11 +00001412 int res = 1; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001413 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001414
drhc3a64ba2001-11-22 00:01:27 +00001415 /* Figure out how many records are in the journal. Abort early if
1416 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001417 */
drh8cfbf082001-09-19 13:22:39 +00001418 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001419 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001420 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001421 goto end_playback;
1422 }
drh240c5792004-02-08 00:40:52 +00001423
danielk197776572402004-06-25 02:38:54 +00001424 /* Read the master journal name from the journal, if it is present.
1425 ** If a master journal file name is specified, but the file is not
1426 ** present on disk, then the journal is not hot and does not need to be
1427 ** played back.
drh240c5792004-02-08 00:40:52 +00001428 */
danielk197765839c62007-08-30 08:08:17 +00001429 zMaster = pPager->pTmpSpace;
1430 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977861f7452008-06-05 11:39:11 +00001431 if( rc==SQLITE_OK && zMaster[0] ){
1432 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
drhc3a64ba2001-11-22 00:01:27 +00001433 }
danielk197765839c62007-08-30 08:08:17 +00001434 zMaster = 0;
danielk1977861f7452008-06-05 11:39:11 +00001435 if( rc!=SQLITE_OK || !res ){
danielk1977ce98bba2008-04-03 10:13:01 +00001436 goto end_playback;
1437 }
1438 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001439
danielk197776572402004-06-25 02:38:54 +00001440 /* This loop terminates either when the readJournalHdr() call returns
1441 ** SQLITE_DONE or an IO error occurs. */
1442 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001443
danielk197776572402004-06-25 02:38:54 +00001444 /* Read the next journal header from the journal file. If there are
1445 ** not enough bytes left in the journal file for a complete header, or
1446 ** it is corrupted, then a process must of failed while writing it.
1447 ** This indicates nothing more needs to be rolled back.
1448 */
1449 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1450 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001451 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001452 rc = SQLITE_OK;
1453 }
danielk197776572402004-06-25 02:38:54 +00001454 goto end_playback;
1455 }
1456
1457 /* If nRec is 0xffffffff, then this journal was created by a process
1458 ** working in no-sync mode. This means that the rest of the journal
1459 ** file consists of pages, there are no more journal headers. Compute
1460 ** the value of nRec based on this assumption.
1461 */
1462 if( nRec==0xffffffff ){
1463 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1464 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1465 }
1466
danielk1977e277be02007-03-23 18:12:06 +00001467 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001468 ** process and if this is the final header in the journal, then it means
1469 ** that this part of the journal was being filled but has not yet been
1470 ** synced to disk. Compute the number of pages based on the remaining
1471 ** size of the file.
1472 **
1473 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001474 */
drh8940f4e2007-08-11 00:26:20 +00001475 if( nRec==0 && !isHot &&
1476 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001477 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1478 }
1479
danielk197776572402004-06-25 02:38:54 +00001480 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001481 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001482 */
danielk1977e180dd92007-04-05 17:15:52 +00001483 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001484 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001485 if( rc!=SQLITE_OK ){
1486 goto end_playback;
1487 }
danielk197776572402004-06-25 02:38:54 +00001488 }
1489
danielk197776572402004-06-25 02:38:54 +00001490 /* Copy original pages out of the journal and back into the database file.
1491 */
shane0b8d2762008-07-22 05:18:00 +00001492 for(u=0; u<nRec; u++){
danielk197762079062007-08-15 17:08:46 +00001493 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001494 if( rc!=SQLITE_OK ){
1495 if( rc==SQLITE_DONE ){
1496 rc = SQLITE_OK;
1497 pPager->journalOff = szJ;
1498 break;
1499 }else{
drha9625ea2008-09-03 00:08:29 +00001500 /* If we are unable to rollback, then the database is probably
1501 ** going to end up being corrupt. It is corrupt to us, anyhow.
1502 ** Perhaps the next process to come along can fix it....
1503 */
danielk197798c21902008-09-23 16:41:29 +00001504 rc = SQLITE_CORRUPT_BKPT;
danielk197776572402004-06-25 02:38:54 +00001505 goto end_playback;
1506 }
1507 }
drh968af522003-02-11 14:55:40 +00001508 }
drhed7c8552001-04-11 14:29:21 +00001509 }
drh580eeaf2006-02-24 03:09:37 +00001510 /*NOTREACHED*/
1511 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001512
1513end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001514 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001515 zMaster = pPager->pTmpSpace;
1516 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1517 }
1518 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001519 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001520 }
danielk1977c56774e2008-10-07 11:51:20 +00001521 if( rc==SQLITE_OK && zMaster[0] && res ){
danielk1977979f38e2007-03-27 16:19:51 +00001522 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001523 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001524 */
danielk197765839c62007-08-30 08:08:17 +00001525 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001526 }
danielk197776572402004-06-25 02:38:54 +00001527
1528 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001529 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001530 ** value. Reset it to the correct value for this process.
1531 */
drhc80f0582007-05-01 16:59:48 +00001532 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001533 return rc;
drhed7c8552001-04-11 14:29:21 +00001534}
1535
1536/*
drhac69b052004-05-12 13:30:07 +00001537** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001538**
1539** This is similar to playing back the transaction journal but with
1540** a few extra twists.
1541**
drh663fc632002-02-02 18:49:19 +00001542** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001543** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001544** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001545**
drhac69b052004-05-12 13:30:07 +00001546** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001547** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001548** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001549*/
drh3aac2dd2004-04-26 14:10:20 +00001550static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001551 i64 szJ; /* Size of the full journal */
1552 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001553 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001554 int i; /* Loop counter */
1555 int rc;
1556
danielk197776572402004-06-25 02:38:54 +00001557 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001558
danielk19774099f6e2007-03-19 11:25:20 +00001559 /* Set hdrOff to be the offset just after the end of the last journal
1560 ** page written before the first journal-header for this statement
1561 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001562 ** header was written.
1563 */
1564 hdrOff = pPager->stmtHdrOff;
1565 assert( pPager->fullSync || !hdrOff );
1566 if( !hdrOff ){
1567 hdrOff = szJ;
1568 }
1569
drhfa86c412002-02-02 15:01:15 +00001570 /* Truncate the database back to its original size.
1571 */
danielk1977e180dd92007-04-05 17:15:52 +00001572 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001573 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001574
drhac69b052004-05-12 13:30:07 +00001575 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001576 */
drhac69b052004-05-12 13:30:07 +00001577 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001578 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001579
drhac69b052004-05-12 13:30:07 +00001580 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001581 ** database file. Note that the statement journal omits checksums from
1582 ** each record since power-failure recovery is not important to statement
1583 ** journals.
drhfa86c412002-02-02 15:01:15 +00001584 */
danielk197762079062007-08-15 17:08:46 +00001585 for(i=0; i<nRec; i++){
1586 i64 offset = i*(4+pPager->pageSize);
1587 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001588 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001589 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001590 }
1591
danielk197776572402004-06-25 02:38:54 +00001592 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1593 ** was the size of the journal file when this statement was started, so
1594 ** everything after that needs to be rolled back, either into the
1595 ** database, the memory cache, or both.
1596 **
1597 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1598 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001599 */
danielk197776572402004-06-25 02:38:54 +00001600 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001601 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001602 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001603 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001604 assert( rc!=SQLITE_DONE );
1605 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1606 }
1607
1608 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001609 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001610 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001611 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001612 if( rc!=SQLITE_OK ){
1613 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001614 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001615 }
danielk1977f0113002006-01-24 12:09:17 +00001616 if( nJRec==0 ){
1617 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001618 }
danielk1977f0113002006-01-24 12:09:17 +00001619 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001620 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001621 assert( rc!=SQLITE_DONE );
1622 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1623 }
drhfa86c412002-02-02 15:01:15 +00001624 }
danielk197776572402004-06-25 02:38:54 +00001625
1626 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001627
drh3aac2dd2004-04-26 14:10:20 +00001628end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001629 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001630 pPager->journalOff = szJ;
1631 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001632 }
1633 return rc;
1634}
1635
1636/*
drhf57b14a2001-09-14 18:54:08 +00001637** Change the maximum number of in-memory pages that are allowed.
1638*/
danielk19773b8a05f2007-03-19 17:44:26 +00001639void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
danielk19778c0a7912008-08-20 14:49:23 +00001640 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001641}
1642
1643/*
drh973b6e32003-02-12 14:09:42 +00001644** Adjust the robustness of the database to damage due to OS crashes
1645** or power failures by changing the number of syncs()s when writing
1646** the rollback journal. There are three levels:
1647**
drh054889e2005-11-30 03:20:31 +00001648** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001649** for temporary and transient files.
1650**
1651** NORMAL The journal is synced once before writes begin on the
1652** database. This is normally adequate protection, but
1653** it is theoretically possible, though very unlikely,
1654** that an inopertune power failure could leave the journal
1655** in a state which would cause damage to the database
1656** when it is rolled back.
1657**
1658** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001659** database (with some additional information - the nRec field
1660** of the journal header - being written in between the two
1661** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001662** single disk sector is atomic, then this mode provides
1663** assurance that the journal will not be corrupted to the
1664** point of causing damage to the database during rollback.
1665**
1666** Numeric values associated with these states are OFF==1, NORMAL=2,
1667** and FULL=3.
1668*/
danielk197793758c82005-01-21 08:13:14 +00001669#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh281b21d2008-08-22 12:57:08 +00001670void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){
danielk1977b3175382008-10-17 18:51:52 +00001671 pPager->noSync = level==1 || pPager->tempFile;
drh973b6e32003-02-12 14:09:42 +00001672 pPager->fullSync = level==3 && !pPager->tempFile;
drh281b21d2008-08-22 12:57:08 +00001673 pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001674 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001675}
danielk197793758c82005-01-21 08:13:14 +00001676#endif
drh973b6e32003-02-12 14:09:42 +00001677
1678/*
drhaf6df112005-06-07 02:12:30 +00001679** The following global variable is incremented whenever the library
1680** attempts to open a temporary file. This information is used for
1681** testing and analysis only.
1682*/
drh0f7eb612006-08-08 13:51:43 +00001683#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001684int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001685#endif
drhaf6df112005-06-07 02:12:30 +00001686
1687/*
drh3f56e6e2007-03-15 01:16:47 +00001688** Open a temporary file.
1689**
1690** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001691** other error code if we fail. The OS will automatically delete the temporary
1692** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001693*/
danielk1977b4b47412007-08-17 15:53:36 +00001694static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00001695 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00001696 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00001697 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00001698){
drhfa86c412002-02-02 15:01:15 +00001699 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001700
drh0f7eb612006-08-08 13:51:43 +00001701#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001702 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001703#endif
danielk1977b4b47412007-08-17 15:53:36 +00001704
drh33f4e022007-09-03 15:19:34 +00001705 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
1706 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00001707 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00001708 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00001709 return rc;
1710}
1711
danielk1977a858aa22008-08-22 16:22:17 +00001712static int pagerStress(void *,PgHdr *);
danielk19778c0a7912008-08-20 14:49:23 +00001713
drhfa86c412002-02-02 15:01:15 +00001714/*
drhed7c8552001-04-11 14:29:21 +00001715** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001716** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001717** the first call to sqlite3PagerGet() and is only held open until the
1718** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001719**
drh6446c4d2001-12-15 14:22:18 +00001720** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00001721** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00001722** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001723**
1724** If zFilename is ":memory:" then all information is held in cache.
1725** It is never written to disk. This can be used to implement an
1726** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001727*/
danielk19773b8a05f2007-03-19 17:44:26 +00001728int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001729 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001730 Pager **ppPager, /* Return the Pager structure here */
1731 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001732 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00001733 int flags, /* flags controlling this file */
1734 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00001735){
danielk1977b4b47412007-08-17 15:53:36 +00001736 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001737 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001738 int rc = SQLITE_OK;
1739 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001740 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001741 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001742 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001743 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1744 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977b3175382008-10-17 18:51:52 +00001745 int journalFileSize;
danielk19778c0a7912008-08-20 14:49:23 +00001746 int pcacheSize = sqlite3PcacheSize();
drhfacf0302008-06-17 15:12:00 +00001747 int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00001748 char *zPathname = 0;
1749 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001750
danielk1977b3175382008-10-17 18:51:52 +00001751 if( sqlite3JournalSize(pVfs)>sqlite3MemJournalSize() ){
1752 journalFileSize = sqlite3JournalSize(pVfs);
1753 }else{
1754 journalFileSize = sqlite3MemJournalSize();
1755 }
1756
drh86f8c192007-08-22 00:39:19 +00001757 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001758 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001759
danielk197717b90b52008-06-06 11:11:25 +00001760 /* Compute and store the full pathname in an allocated buffer pointed
1761 ** to by zPathname, length nPathname. Or, if this is a temporary file,
1762 ** leave both nPathname and zPathname set to 0.
1763 */
drh1cc8c442007-08-24 16:08:29 +00001764 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00001765 nPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001766 zPathname = sqlite3Malloc(nPathname*2);
danielk197717b90b52008-06-06 11:11:25 +00001767 if( zPathname==0 ){
1768 return SQLITE_NOMEM;
1769 }
drh1cc8c442007-08-24 16:08:29 +00001770#ifndef SQLITE_OMIT_MEMORYDB
1771 if( strcmp(zFilename,":memory:")==0 ){
1772 memDb = 1;
1773 zPathname[0] = 0;
1774 }else
1775#endif
1776 {
danielk1977adfb9b02007-09-17 07:02:56 +00001777 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00001778 }
danielk197717b90b52008-06-06 11:11:25 +00001779 if( rc!=SQLITE_OK ){
1780 sqlite3_free(zPathname);
1781 return rc;
1782 }
1783 nPathname = strlen(zPathname);
drhae28c012007-08-24 16:29:23 +00001784 }
drh99b90c32008-03-17 13:50:58 +00001785
danielk1977b4b47412007-08-17 15:53:36 +00001786 /* Allocate memory for the pager structure */
1787 pPager = sqlite3MallocZero(
1788 sizeof(*pPager) + /* Pager structure */
danielk19778c0a7912008-08-20 14:49:23 +00001789 pcacheSize + /* PCache object */
danielk1977c7b60172007-08-22 11:22:03 +00001790 journalFileSize + /* The journal file structure */
danielk1977b3175382008-10-17 18:51:52 +00001791 pVfs->szOsFile + /* The main db file */
1792 journalFileSize * 2 + /* The two journal files */
danielk197717b90b52008-06-06 11:11:25 +00001793 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00001794 );
1795 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00001796 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00001797 return SQLITE_NOMEM;
1798 }
danielk19778c0a7912008-08-20 14:49:23 +00001799 pPager->pPCache = (PCache *)&pPager[1];
1800 pPtr = ((u8 *)&pPager[1]) + pcacheSize;
drh33f4e022007-09-03 15:19:34 +00001801 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00001802 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977b3175382008-10-17 18:51:52 +00001803 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile];
1804 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile+journalFileSize];
1805 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile+2*journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00001806 pPager->zDirectory = &pPager->zFilename[nPathname+1];
1807 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00001808 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00001809 if( zPathname ){
1810 memcpy(pPager->zFilename, zPathname, nPathname+1);
1811 sqlite3_free(zPathname);
1812 }
danielk1977b4b47412007-08-17 15:53:36 +00001813
drh153c62c2007-08-24 03:51:33 +00001814 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00001815 */
drhae28c012007-08-24 16:29:23 +00001816 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00001817 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
1818 rc = SQLITE_CANTOPEN;
1819 }else{
drh1cc8c442007-08-24 16:08:29 +00001820 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00001821 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
1822 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00001823 readOnly = (fout&SQLITE_OPEN_READONLY);
1824
1825 /* If the file was successfully opened for read/write access,
1826 ** choose a default page size in case we have to create the
1827 ** database file. The default page size is the maximum of:
1828 **
1829 ** + SQLITE_DEFAULT_PAGE_SIZE,
1830 ** + The value returned by sqlite3OsSectorSize()
1831 ** + The largest page size that can be written atomically.
1832 */
1833 if( rc==SQLITE_OK && !readOnly ){
1834 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
drhfacf0302008-06-17 15:12:00 +00001835 if( szPageDflt<iSectorSize ){
1836 szPageDflt = iSectorSize;
drh1cc8c442007-08-24 16:08:29 +00001837 }
danielk19779663b8f2007-08-24 11:52:28 +00001838#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00001839 {
1840 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
1841 int ii;
1842 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1843 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1844 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
drhfacf0302008-06-17 15:12:00 +00001845 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
1846 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii;
danielk19779663b8f2007-08-24 11:52:28 +00001847 }
danielk1977b4b47412007-08-17 15:53:36 +00001848 }
drh1cc8c442007-08-24 16:08:29 +00001849#endif
drhfacf0302008-06-17 15:12:00 +00001850 if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
1851 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
drh1cc8c442007-08-24 16:08:29 +00001852 }
danielk19778def5ea2004-06-16 10:39:52 +00001853 }
drhac69b052004-05-12 13:30:07 +00001854 }
danielk1977b3175382008-10-17 18:51:52 +00001855 }else{
danielk19777a2b1ee2007-08-21 14:27:01 +00001856 /* If a temporary file is requested, it is not opened immediately.
1857 ** In this case we accept the default page size and delay actually
1858 ** opening the file until the first call to OsWrite().
danielk1977b3175382008-10-17 18:51:52 +00001859 **
1860 ** This branch is also run for an in-memory database. An in-memory
1861 ** database is the same as a temp-file that is never written out to
1862 ** disk and uses an in-memory rollback journal.
danielk19777a2b1ee2007-08-21 14:27:01 +00001863 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001864 tempFile = 1;
1865 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001866 }
danielk1977aef0bf62005-12-30 16:28:01 +00001867
danielk1977b4b47412007-08-17 15:53:36 +00001868 if( pPager && rc==SQLITE_OK ){
drhfacf0302008-06-17 15:12:00 +00001869 pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt);
drh3e7a6092002-12-07 21:45:14 +00001870 }
danielk1977aef0bf62005-12-30 16:28:01 +00001871
drh153c62c2007-08-24 03:51:33 +00001872 /* If an error occured in either of the blocks above.
1873 ** Free the Pager structure and close the file.
1874 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00001875 ** any Pager.errMask variables.
1876 */
danielk1977b4b47412007-08-17 15:53:36 +00001877 if( !pPager || !pPager->pTmpSpace ){
1878 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001879 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001880 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001881 }
danielk19778c0a7912008-08-20 14:49:23 +00001882 nExtra = FORCE_ALIGNMENT(nExtra);
danielk197771d5d2c2008-09-29 11:49:47 +00001883 sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
drh41d30272008-08-20 21:47:45 +00001884 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
danielk1977aef0bf62005-12-30 16:28:01 +00001885
drh153c62c2007-08-24 03:51:33 +00001886 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
1887 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00001888
danielk1977b4b47412007-08-17 15:53:36 +00001889 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00001890 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00001891 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001892 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001893
drh99b90c32008-03-17 13:50:58 +00001894 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00001895 if( zPathname ){
1896 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
1897 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
1898 }else{
1899 pPager->zJournal = 0;
1900 }
danielk1977b4b47412007-08-17 15:53:36 +00001901
drh3b59a5c2006-01-15 20:28:28 +00001902 /* pPager->journalOpen = 0; */
drhb3df2e12008-09-17 20:06:26 +00001903 pPager->useJournal = useJournal;
drh7bec5052005-02-06 02:45:41 +00001904 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001905 /* pPager->stmtOpen = 0; */
1906 /* pPager->stmtInUse = 0; */
1907 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001908 pPager->dbSize = memDb-1;
drhfacf0302008-06-17 15:12:00 +00001909 pPager->pageSize = szPageDflt;
drh3b59a5c2006-01-15 20:28:28 +00001910 /* pPager->stmtSize = 0; */
1911 /* pPager->stmtJSize = 0; */
1912 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001913 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001914 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001915 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00001916 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00001917 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001918 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001919 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1920 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1921 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1922 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001923 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001924 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001925 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001926 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001927 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00001928 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00001929 /* pPager->pFirst = 0; */
1930 /* pPager->pFirstSynced = 0; */
1931 /* pPager->pLast = 0; */
danielk19778c0a7912008-08-20 14:49:23 +00001932 pPager->nExtra = nExtra;
danielk1977b53e4962008-06-04 06:45:59 +00001933 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk1977b3175382008-10-17 18:51:52 +00001934 assert(pPager->fd->pMethods||tempFile);
1935 setSectorSize(pPager);
1936 if( memDb ){
1937 pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
danielk1977b4721172007-03-19 05:54:48 +00001938 }
drh3b59a5c2006-01-15 20:28:28 +00001939 /* pPager->pBusyHandler = 0; */
1940 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001941 *ppPager = pPager;
1942 return SQLITE_OK;
1943}
1944
1945/*
drh90f5ecb2004-07-22 01:19:35 +00001946** Set the busy handler function.
1947*/
danielk19773b8a05f2007-03-19 17:44:26 +00001948void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00001949 pPager->pBusyHandler = pBusyHandler;
1950}
1951
1952/*
drha6abd042004-06-09 17:37:22 +00001953** Set the reinitializer for this pager. If not NULL, the reinitializer
1954** is called when the content of a page in cache is restored to its original
1955** value as a result of a rollback. The callback gives higher-level code
1956** an opportunity to restore the EXTRA section to agree with the restored
1957** page data.
1958*/
danielk1977eaa06f62008-09-18 17:34:44 +00001959void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*)){
drha6abd042004-06-09 17:37:22 +00001960 pPager->xReiniter = xReinit;
1961}
1962
1963/*
danielk1977a1644fd2007-08-29 12:31:25 +00001964** Set the page size to *pPageSize. If the suggest new page size is
1965** inappropriate, then an alternative page size is set to that
1966** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00001967*/
danielk1977a1644fd2007-08-29 12:31:25 +00001968int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
danielk19771357d9f2008-09-16 05:12:24 +00001969 int rc = pPager->errCode;
1970 if( rc==SQLITE_OK ){
1971 u16 pageSize = *pPageSize;
1972 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
1973 if( pageSize && pageSize!=pPager->pageSize
1974 && (pPager->memDb==0 || pPager->dbSize==0)
1975 && sqlite3PcacheRefCount(pPager->pPCache)==0
1976 ){
1977 char *pNew = (char *)sqlite3PageMalloc(pageSize);
1978 if( !pNew ){
1979 rc = SQLITE_NOMEM;
1980 }else{
1981 pager_reset(pPager);
1982 pPager->pageSize = pageSize;
1983 if( !pPager->memDb ) setSectorSize(pPager);
1984 sqlite3PageFree(pPager->pTmpSpace);
1985 pPager->pTmpSpace = pNew;
1986 sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
1987 }
danielk1977a1644fd2007-08-29 12:31:25 +00001988 }
danielk19771357d9f2008-09-16 05:12:24 +00001989 *pPageSize = pPager->pageSize;
drh1c7880e2005-05-20 20:01:55 +00001990 }
danielk1977a1644fd2007-08-29 12:31:25 +00001991 return rc;
drh90f5ecb2004-07-22 01:19:35 +00001992}
1993
1994/*
drh26b79942007-11-28 16:19:56 +00001995** Return a pointer to the "temporary page" buffer held internally
1996** by the pager. This is a buffer that is big enough to hold the
1997** entire content of a database page. This buffer is used internally
1998** during rollback and will be overwritten whenever a rollback
1999** occurs. But other modules are free to use it too, as long as
2000** no rollbacks are happening.
2001*/
2002void *sqlite3PagerTempSpace(Pager *pPager){
2003 return pPager->pTmpSpace;
2004}
2005
2006/*
drhf8e632b2007-05-08 14:51:36 +00002007** Attempt to set the maximum database page count if mxPage is positive.
2008** Make no changes if mxPage is zero or negative. And never reduce the
2009** maximum page count below the current size of the database.
2010**
2011** Regardless of mxPage, return the current maximum page count.
2012*/
2013int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2014 if( mxPage>0 ){
2015 pPager->mxPgno = mxPage;
2016 }
danielk1977ad0132d2008-06-07 08:58:22 +00002017 sqlite3PagerPagecount(pPager, 0);
drhf8e632b2007-05-08 14:51:36 +00002018 return pPager->mxPgno;
2019}
2020
2021/*
drhc9ac5ca2005-11-04 22:03:30 +00002022** The following set of routines are used to disable the simulated
2023** I/O error mechanism. These routines are used to avoid simulated
2024** errors in places where we do not care about errors.
2025**
2026** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2027** and generate no code.
2028*/
2029#ifdef SQLITE_TEST
2030extern int sqlite3_io_error_pending;
2031extern int sqlite3_io_error_hit;
2032static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002033void disable_simulated_io_errors(void){
2034 saved_cnt = sqlite3_io_error_pending;
2035 sqlite3_io_error_pending = -1;
2036}
2037void enable_simulated_io_errors(void){
2038 sqlite3_io_error_pending = saved_cnt;
2039}
2040#else
drh152410f2005-11-05 15:11:22 +00002041# define disable_simulated_io_errors()
2042# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002043#endif
2044
2045/*
drh90f5ecb2004-07-22 01:19:35 +00002046** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002047** that pDest points to.
2048**
2049** No error checking is done. The rational for this is that this function
2050** may be called even if the file does not exist or contain a header. In
2051** these cases sqlite3OsRead() will return an error, to which the correct
2052** response is to zero the memory at pDest and continue. A real IO error
2053** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002054*/
danielk19773b8a05f2007-03-19 17:44:26 +00002055int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002056 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002057 memset(pDest, 0, N);
danielk1977b3175382008-10-17 18:51:52 +00002058 assert(pPager->fd->pMethods||pPager->tempFile);
danielk19777a2b1ee2007-08-21 14:27:01 +00002059 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002060 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002061 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002062 if( rc==SQLITE_IOERR_SHORT_READ ){
2063 rc = SQLITE_OK;
2064 }
drh90f5ecb2004-07-22 01:19:35 +00002065 }
drh551b7732006-11-06 21:20:25 +00002066 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002067}
2068
2069/*
drh5e00f6c2001-09-13 13:46:56 +00002070** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002071** pPager.
2072**
2073** If the PENDING_BYTE lies on the page directly after the end of the
2074** file, then consider this page part of the file too. For example, if
2075** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2076** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002077*/
danielk1977ad0132d2008-06-07 08:58:22 +00002078int sqlite3PagerPagecount(Pager *pPager, int *pnPage){
danielk19777a2b1ee2007-08-21 14:27:01 +00002079 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002080 int rc;
drhd9b02572001-04-15 00:37:09 +00002081 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002082 if( pPager->errCode ){
danielk19778c0a7912008-08-20 14:49:23 +00002083 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002084 return rc;
drha7aea3d2007-03-15 12:51:16 +00002085 }
drhed7c8552001-04-11 14:29:21 +00002086 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002087 n = pPager->dbSize;
2088 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002089 assert(pPager->fd->pMethods||pPager->tempFile);
2090 if( (pPager->fd->pMethods)
2091 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002092 pager_error(pPager, rc);
danielk1977ad0132d2008-06-07 08:58:22 +00002093 return rc;
danielk197715f411d2005-09-16 10:18:45 +00002094 }
2095 if( n>0 && n<pPager->pageSize ){
2096 n = 1;
2097 }else{
2098 n /= pPager->pageSize;
2099 }
2100 if( pPager->state!=PAGER_UNLOCK ){
2101 pPager->dbSize = n;
2102 }
drhed7c8552001-04-11 14:29:21 +00002103 }
danielk197715f411d2005-09-16 10:18:45 +00002104 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002105 n++;
2106 }
drhf8e632b2007-05-08 14:51:36 +00002107 if( n>pPager->mxPgno ){
2108 pPager->mxPgno = n;
2109 }
danielk1977ad0132d2008-06-07 08:58:22 +00002110 if( pnPage ){
2111 *pnPage = n;
2112 }
2113 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002114}
2115
2116/*
drhf7c57532003-04-25 13:22:51 +00002117** Forward declaration
2118*/
danielk197776572402004-06-25 02:38:54 +00002119static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002120
2121/*
danielk1977e180dd92007-04-05 17:15:52 +00002122** This routine is used to truncate the cache when a database
2123** is truncated. Drop from the cache all pages whose pgno is
2124** larger than pPager->dbSize and is unreferenced.
2125**
drhac69b052004-05-12 13:30:07 +00002126** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002127**
2128** Actually, at the point this routine is called, it would be
2129** an error to have a referenced page. But rather than delete
2130** that page and guarantee a subsequent segfault, it seems better
2131** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002132*/
danielk1977e180dd92007-04-05 17:15:52 +00002133static void pager_truncate_cache(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00002134 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
drhac69b052004-05-12 13:30:07 +00002135}
2136
drhf7c57532003-04-25 13:22:51 +00002137/*
danielk197717221812005-02-15 03:38:05 +00002138** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002139** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002140** false or until the lock succeeds.
2141**
2142** Return SQLITE_OK on success and an error code if we cannot obtain
2143** the lock.
2144*/
2145static int pager_wait_on_lock(Pager *pPager, int locktype){
2146 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002147
2148 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002149 assert( PAGER_SHARED==SHARED_LOCK );
2150 assert( PAGER_RESERVED==RESERVED_LOCK );
2151 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002152
2153 /* If the file is currently unlocked then the size must be unknown */
danielk1977b3175382008-10-17 18:51:52 +00002154 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 );
drh1aa2d8b2007-01-03 15:34:29 +00002155
danielk197717221812005-02-15 03:38:05 +00002156 if( pPager->state>=locktype ){
2157 rc = SQLITE_OK;
2158 }else{
drhbefdf832008-03-14 19:33:05 +00002159 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002160 do {
drh054889e2005-11-30 03:20:31 +00002161 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002162 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002163 if( rc==SQLITE_OK ){
2164 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002165 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002166 }
2167 }
2168 return rc;
2169}
2170
2171/*
drhf7c57532003-04-25 13:22:51 +00002172** Truncate the file to the number of pages specified.
2173*/
danielk19773b8a05f2007-03-19 17:44:26 +00002174int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
danielk19778c0a7912008-08-20 14:49:23 +00002175 int rc = SQLITE_OK;
danielk1977b3175382008-10-17 18:51:52 +00002176 assert( pPager->state>=PAGER_SHARED );
danielk19778c0a7912008-08-20 14:49:23 +00002177
danielk1977ad0132d2008-06-07 08:58:22 +00002178 sqlite3PagerPagecount(pPager, 0);
danielk1977efaaf572006-01-16 11:29:19 +00002179 if( pPager->errCode ){
2180 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002181 }else if( nPage<(unsigned)pPager->dbSize ){
danielk1977b3175382008-10-17 18:51:52 +00002182 rc = syncJournal(pPager);
2183 if( rc==SQLITE_OK ){
2184 /* Get an exclusive lock on the database before truncating. */
2185 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2186 }
2187 if( rc==SQLITE_OK ){
2188 rc = pager_truncate(pPager, nPage);
danielk19778c0a7912008-08-20 14:49:23 +00002189 }
danielk1977369f27e2004-06-15 11:40:04 +00002190 }
danielk197717221812005-02-15 03:38:05 +00002191
drhf7c57532003-04-25 13:22:51 +00002192 return rc;
2193}
2194
2195/*
drhed7c8552001-04-11 14:29:21 +00002196** Shutdown the page cache. Free all memory and close all files.
2197**
2198** If a transaction was in progress when this routine is called, that
2199** transaction is rolled back. All outstanding pages are invalidated
2200** and their memory is freed. Any attempt to use a page associated
2201** with this page cache after this function returns will likely
2202** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002203**
2204** This function always succeeds. If a transaction is active an attempt
2205** is made to roll it back. If an error occurs during the rollback
2206** a hot journal may be left in the filesystem but no error is returned
2207** to the caller.
drhed7c8552001-04-11 14:29:21 +00002208*/
danielk19773b8a05f2007-03-19 17:44:26 +00002209int sqlite3PagerClose(Pager *pPager){
danielk197713f72992005-12-18 08:51:22 +00002210
drhbafda092007-01-03 23:36:22 +00002211 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002212 sqlite3BeginBenignMalloc();
drhc2ee76c2007-01-04 14:58:14 +00002213 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002214 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002215 pager_reset(pPager);
danielk1977b3175382008-10-17 18:51:52 +00002216 if( !MEMDB ){
2217 pagerUnlockAndRollback(pPager);
2218 }
drhbafda092007-01-03 23:36:22 +00002219 enable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002220 sqlite3EndBenignMalloc();
drh4f0c5872007-03-26 22:05:01 +00002221 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002222 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002223 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002224 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002225 }
drhf5e7bb52008-02-18 14:47:33 +00002226 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977a1fa00d2008-08-27 15:16:33 +00002227 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
danielk1977e94ddc92005-03-21 03:53:38 +00002228 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002229 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002230 }
danielk1977b4b47412007-08-17 15:53:36 +00002231 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002232 /* Temp files are automatically deleted by the OS
2233 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002234 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002235 ** }
2236 */
danielk1977aca790a2005-01-13 11:07:52 +00002237
drhfacf0302008-06-17 15:12:00 +00002238 sqlite3PageFree(pPager->pTmpSpace);
danielk19778c0a7912008-08-20 14:49:23 +00002239 sqlite3PcacheClose(pPager->pPCache);
drh17435752007-08-16 04:30:38 +00002240 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002241 return SQLITE_OK;
2242}
2243
drh87cc3b32007-05-08 21:45:27 +00002244#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002245/*
drh5e00f6c2001-09-13 13:46:56 +00002246** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002247*/
danielk19773b8a05f2007-03-19 17:44:26 +00002248Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002249 return p->pgno;
2250}
drh87cc3b32007-05-08 21:45:27 +00002251#endif
drhed7c8552001-04-11 14:29:21 +00002252
2253/*
drhdf0b3b02001-06-23 11:36:20 +00002254** Increment the reference count for a page. The input pointer is
2255** a reference to the page data.
2256*/
danielk19773b8a05f2007-03-19 17:44:26 +00002257int sqlite3PagerRef(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002258 sqlite3PcacheRef(pPg);
drh8c42ca92001-06-22 19:15:00 +00002259 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002260}
2261
2262/*
drh34e79ce2004-02-08 06:05:46 +00002263** Sync the journal. In other words, make sure all the pages that have
2264** been written to the journal have actually reached the surface of the
2265** disk. It is not safe to modify the original database file until after
2266** the journal has been synced. If the original database is modified before
2267** the journal is synced and a power failure occurs, the unsynced journal
2268** data would be lost and we would be unable to completely rollback the
2269** database changes. Database corruption would occur.
2270**
2271** This routine also updates the nRec field in the header of the journal.
2272** (See comments on the pager_playback() routine for additional information.)
2273** If the sync mode is FULL, two syncs will occur. First the whole journal
2274** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002275**
drh34e79ce2004-02-08 06:05:46 +00002276** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002277** after a power failure, so no sync occurs.
2278**
2279** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2280** the database is stored, then OsSync() is never called on the journal
2281** file. In this case all that is required is to update the nRec field in
2282** the journal header.
drhfa86c412002-02-02 15:01:15 +00002283**
drh34e79ce2004-02-08 06:05:46 +00002284** This routine clears the needSync field of every page current held in
2285** memory.
drh50e5dad2001-09-15 00:57:28 +00002286*/
danielk197776572402004-06-25 02:38:54 +00002287static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002288 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002289
2290 /* Sync the journal before modifying the main database
2291 ** (assuming there is a journal and it needs to be synced.)
2292 */
danielk197776572402004-06-25 02:38:54 +00002293 if( pPager->needSync ){
danielk1977b3175382008-10-17 18:51:52 +00002294 assert( !pPager->tempFile );
2295 if( pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
danielk19774cd2cd52007-08-23 14:48:23 +00002296 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002297 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002298
danielk19774cd2cd52007-08-23 14:48:23 +00002299 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002300 /* Write the nRec value into the journal file header. If in
2301 ** full-synchronous mode, sync the journal first. This ensures that
2302 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002303 ** it as a candidate for rollback.
2304 **
2305 ** This is not required if the persistent media supports the
2306 ** SAFE_APPEND property. Because in this case it is not possible
2307 ** for garbage data to be appended to the file, the nRec field
2308 ** is populated with 0xFFFFFFFF when the journal header is written
2309 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002310 */
danielk19774cd2cd52007-08-23 14:48:23 +00002311 i64 jrnlOff;
2312 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002313 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002314 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002315 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002316 if( rc!=0 ) return rc;
2317 }
danielk197713adf8a2004-06-03 16:08:41 +00002318
danielk197762079062007-08-15 17:08:46 +00002319 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2320 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2321 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002322 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002323 }
danielk19774cd2cd52007-08-23 14:48:23 +00002324 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2325 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2326 IOTRACE(("JSYNC %p\n", pPager))
2327 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2328 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2329 );
2330 if( rc!=0 ) return rc;
2331 }
drhdb48ee02003-01-16 13:42:43 +00002332 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002333 }
drh50e5dad2001-09-15 00:57:28 +00002334 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002335
2336 /* Erase the needSync flag from every page.
2337 */
drhb3df2e12008-09-17 20:06:26 +00002338 sqlite3PcacheClearFlags(pPager->pPCache, PGHDR_NEED_SYNC);
drh50e5dad2001-09-15 00:57:28 +00002339 }
drh03eb96a2002-11-10 23:32:56 +00002340
drh341eae82003-01-21 02:39:36 +00002341#ifndef NDEBUG
2342 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2343 ** flag must also be clear for all pages. Verify that this
2344 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002345 */
drh341eae82003-01-21 02:39:36 +00002346 else{
danielk19778c0a7912008-08-20 14:49:23 +00002347 sqlite3PcacheAssertFlags(pPager->pPCache, 0, PGHDR_NEED_SYNC);
drh03eb96a2002-11-10 23:32:56 +00002348 }
drh341eae82003-01-21 02:39:36 +00002349#endif
drhdb48ee02003-01-16 13:42:43 +00002350
drh81a20f22001-10-12 17:30:04 +00002351 return rc;
drh50e5dad2001-09-15 00:57:28 +00002352}
2353
2354/*
drh2554f8b2003-01-22 01:26:44 +00002355** Given a list of pages (connected by the PgHdr.pDirty pointer) write
danielk1977a858aa22008-08-22 16:22:17 +00002356** every one of those pages out to the database file. No calls are made
2357** to the page-cache to mark the pages as clean. It is the responsibility
2358** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark
2359** the pages as clean.
drh2554f8b2003-01-22 01:26:44 +00002360*/
2361static int pager_write_pagelist(PgHdr *pList){
2362 Pager *pPager;
2363 int rc;
2364
2365 if( pList==0 ) return SQLITE_OK;
2366 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002367
2368 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2369 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002370 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002371 **
drha6abd042004-06-09 17:37:22 +00002372 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2373 ** through an intermediate state PENDING. A PENDING lock prevents new
2374 ** readers from attaching to the database but is unsufficient for us to
2375 ** write. The idea of a PENDING lock is to prevent new readers from
2376 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002377 **
drha6abd042004-06-09 17:37:22 +00002378 ** While the pager is in the RESERVED state, the original database file
2379 ** is unchanged and we can rollback without having to playback the
2380 ** journal into the original database file. Once we transition to
2381 ** EXCLUSIVE, it means the database file has been changed and any rollback
2382 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002383 */
drh684917c2004-10-05 02:41:42 +00002384 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002385 if( rc!=SQLITE_OK ){
2386 return rc;
2387 }
2388
drh2554f8b2003-01-22 01:26:44 +00002389 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002390
2391 /* If the file has not yet been opened, open it now. */
2392 if( !pPager->fd->pMethods ){
2393 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00002394 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002395 if( rc ) return rc;
2396 }
2397
danielk1977687566d2004-11-02 12:56:41 +00002398 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002399 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002400 ** make the file smaller (presumably by auto-vacuum code). Do not write
2401 ** any such pages to the file.
2402 */
danielk197733e32162008-08-23 18:53:08 +00002403 if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
danielk197762079062007-08-15 17:08:46 +00002404 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002405 char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00002406 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2407 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002408 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002409 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002410 PAGER_INCR(sqlite3_pager_writedb_count);
2411 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002412 if( pList->pgno==1 ){
2413 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2414 }
danielk1977687566d2004-11-02 12:56:41 +00002415 }
2416#ifndef NDEBUG
2417 else{
drh4f0c5872007-03-26 22:05:01 +00002418 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002419 }
2420#endif
drh2554f8b2003-01-22 01:26:44 +00002421 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002422#ifdef SQLITE_CHECK_PAGES
2423 pList->pageHash = pager_pagehash(pList);
2424#endif
drh2554f8b2003-01-22 01:26:44 +00002425 pList = pList->pDirty;
2426 }
danielk19778c0a7912008-08-20 14:49:23 +00002427
drh2554f8b2003-01-22 01:26:44 +00002428 return SQLITE_OK;
2429}
2430
2431/*
danielk19778c0a7912008-08-20 14:49:23 +00002432** This function is called by the pcache layer when it has reached some
2433** soft memory limit. The argument is a pointer to a purgeable Pager
2434** object. This function attempts to make a single dirty page that has no
2435** outstanding references (if one exists) clean so that it can be recycled
2436** by the pcache layer.
drh2554f8b2003-01-22 01:26:44 +00002437*/
danielk1977a858aa22008-08-22 16:22:17 +00002438static int pagerStress(void *p, PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002439 Pager *pPager = (Pager *)p;
danielk19778c0a7912008-08-20 14:49:23 +00002440 int rc = SQLITE_OK;
drh8f2e9a12008-02-26 14:46:04 +00002441
danielk19778c200142008-08-25 07:12:28 +00002442 if( pPager->doNotSync ){
2443 return SQLITE_OK;
2444 }
2445
danielk1977a858aa22008-08-22 16:22:17 +00002446 assert( pPg->flags&PGHDR_DIRTY );
2447 if( pPager->errCode==SQLITE_OK ){
2448 if( pPg->flags&PGHDR_NEED_SYNC ){
2449 rc = syncJournal(pPager);
2450 if( rc==SQLITE_OK && pPager->fullSync &&
danielk1977b3175382008-10-17 18:51:52 +00002451 !(pPager->journalMode==PAGER_JOURNALMODE_MEMORY) &&
danielk1977a858aa22008-08-22 16:22:17 +00002452 !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
2453 ){
2454 pPager->nRec = 0;
2455 rc = writeJournalHdr(pPager);
danielk19778c0a7912008-08-20 14:49:23 +00002456 }
danielk19778c0a7912008-08-20 14:49:23 +00002457 }
danielk1977a858aa22008-08-22 16:22:17 +00002458 if( rc==SQLITE_OK ){
2459 pPg->pDirty = 0;
2460 rc = pager_write_pagelist(pPg);
2461 }
2462 if( rc!=SQLITE_OK ){
2463 pager_error(pPager, rc);
2464 }
2465 }
2466
2467 if( rc==SQLITE_OK ){
2468 sqlite3PcacheMakeClean(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00002469 }
2470 return rc;
drh2554f8b2003-01-22 01:26:44 +00002471}
2472
danielk19778c0a7912008-08-20 14:49:23 +00002473
drh2554f8b2003-01-22 01:26:44 +00002474/*
drh19db9352008-03-27 22:42:51 +00002475** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00002476** A hot journal is one that needs to be played back.
2477**
2478** If the current size of the database file is 0 but a journal file
2479** exists, that is probably an old journal left over from a prior
2480** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00002481**
2482** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00002483**
2484** This routine does not open the journal file to examine its
2485** content. Hence, the journal might contain the name of a master
2486** journal file that has been deleted, and hence not be hot. Or
2487** the header of the journal might be zeroed out. This routine
2488** does not discover these cases of a non-hot journal - if the
2489** journal file exists and is not empty this routine assumes it
2490** is hot. The pager_playback() routine will discover that the
2491** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00002492*/
danielk1977d300b8a2008-08-01 10:50:23 +00002493static int hasHotJournal(Pager *pPager, int *pExists){
danielk1977b4b47412007-08-17 15:53:36 +00002494 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977d300b8a2008-08-01 10:50:23 +00002495 int rc = SQLITE_OK;
drh0a846f92008-08-25 17:23:29 +00002496 int exists;
2497 int locked;
2498 assert( pPager!=0 );
2499 assert( pPager->useJournal );
2500 assert( pPager->fd->pMethods );
danielk1977d300b8a2008-08-01 10:50:23 +00002501 *pExists = 0;
drh0a846f92008-08-25 17:23:29 +00002502 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
2503 if( rc==SQLITE_OK && exists ){
2504 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
2505 }
2506 if( rc==SQLITE_OK && exists && !locked ){
2507 int nPage;
2508 rc = sqlite3PagerPagecount(pPager, &nPage);
2509 if( rc==SQLITE_OK ){
2510 if( nPage==0 ){
2511 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2512 }else{
2513 *pExists = 1;
danielk1977861f7452008-06-05 11:39:11 +00002514 }
2515 }
drhbb5f18d2007-04-06 18:23:17 +00002516 }
danielk1977d300b8a2008-08-01 10:50:23 +00002517 return rc;
drh165ffe92005-03-15 17:09:30 +00002518}
2519
2520/*
danielk1977e180dd92007-04-05 17:15:52 +00002521** Read the content of page pPg out of the database file.
2522*/
2523static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2524 int rc;
danielk197762079062007-08-15 17:08:46 +00002525 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002526 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002527 assert(pPager->fd->pMethods||pPager->tempFile);
2528 if( !pPager->fd->pMethods ){
2529 return SQLITE_IOERR_SHORT_READ;
2530 }
danielk197762079062007-08-15 17:08:46 +00002531 offset = (pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002532 rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002533 PAGER_INCR(sqlite3_pager_readdb_count);
2534 PAGER_INCR(pPager->nRead);
2535 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002536 if( pgno==1 ){
danielk19778c0a7912008-08-20 14:49:23 +00002537 memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24],
drh86a88112007-04-16 15:02:19 +00002538 sizeof(pPager->dbFileVers));
2539 }
danielk197730849522008-08-21 04:35:18 +00002540 CODEC1(pPager, pPg->pData, pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002541 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2542 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002543 return rc;
2544}
2545
2546
2547/*
danielk1977e277be02007-03-23 18:12:06 +00002548** This function is called to obtain the shared lock required before
2549** data may be read from the pager cache. If the shared lock has already
2550** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002551**
2552** Immediately after obtaining the shared lock (if required), this function
2553** checks for a hot-journal file. If one is found, an emergency rollback
2554** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002555*/
2556static int pagerSharedLock(Pager *pPager){
2557 int rc = SQLITE_OK;
danielk1977d300b8a2008-08-01 10:50:23 +00002558 int isErrorReset = 0;
danielk1977e277be02007-03-23 18:12:06 +00002559
danielk1977ae72d982007-10-03 08:46:44 +00002560 /* If this database is opened for exclusive access, has no outstanding
2561 ** page references and is in an error-state, now is the chance to clear
2562 ** the error. Discard the contents of the pager-cache and treat any
2563 ** open journal file as a hot-journal.
2564 */
danielk19778c0a7912008-08-20 14:49:23 +00002565 if( !MEMDB && pPager->exclusiveMode
2566 && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode
2567 ){
danielk1977ae72d982007-10-03 08:46:44 +00002568 if( pPager->journalOpen ){
danielk1977d300b8a2008-08-01 10:50:23 +00002569 isErrorReset = 1;
danielk1977ae72d982007-10-03 08:46:44 +00002570 }
danielk1977ae72d982007-10-03 08:46:44 +00002571 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00002572 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00002573 }
2574
2575 /* If the pager is still in an error state, do not proceed. The error
2576 ** state will be cleared at some point in the future when all page
2577 ** references are dropped and the cache can be discarded.
2578 */
2579 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2580 return pPager->errCode;
2581 }
2582
danielk1977d300b8a2008-08-01 10:50:23 +00002583 if( pPager->state==PAGER_UNLOCK || isErrorReset ){
danielk1977b4b47412007-08-17 15:53:36 +00002584 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977b3175382008-10-17 18:51:52 +00002585 int isHotJournal;
shane049fc212008-10-22 16:26:47 +00002586 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00002587 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
2588 if( !pPager->noReadlock ){
2589 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2590 if( rc!=SQLITE_OK ){
2591 assert( pPager->state==PAGER_UNLOCK );
2592 return pager_error(pPager, rc);
danielk1977e277be02007-03-23 18:12:06 +00002593 }
danielk1977b3175382008-10-17 18:51:52 +00002594 assert( pPager->state>=SHARED_LOCK );
2595 }
2596
2597 /* If a journal file exists, and there is no RESERVED lock on the
2598 ** database file, then it either needs to be played back or deleted.
2599 */
2600 if( !isErrorReset ){
2601 rc = hasHotJournal(pPager, &isHotJournal);
2602 if( rc!=SQLITE_OK ){
2603 goto failed;
2604 }
2605 }
2606 if( isErrorReset || isHotJournal ){
2607 /* Get an EXCLUSIVE lock on the database file. At this point it is
2608 ** important that a RESERVED lock is not obtained on the way to the
2609 ** EXCLUSIVE lock. If it were, another process might open the
2610 ** database file, detect the RESERVED lock, and conclude that the
2611 ** database is safe to read while this process is still rolling it
2612 ** back.
2613 **
2614 ** Because the intermediate RESERVED lock is not requested, the
2615 ** second process will get to this point in the code and fail to
2616 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00002617 */
danielk1977b3175382008-10-17 18:51:52 +00002618 if( pPager->state<EXCLUSIVE_LOCK ){
2619 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
danielk1977e277be02007-03-23 18:12:06 +00002620 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002621 rc = pager_error(pPager, rc);
2622 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002623 }
danielk1977b3175382008-10-17 18:51:52 +00002624 pPager->state = PAGER_EXCLUSIVE;
2625 }
2626
2627 /* Open the journal for read/write access. This is because in
2628 ** exclusive-access mode the file descriptor will be kept open and
2629 ** possibly used for a transaction later on. On some systems, the
2630 ** OsTruncate() call used in exclusive-access mode also requires
2631 ** a read/write file handle.
2632 */
2633 if( !isErrorReset && pPager->journalOpen==0 ){
2634 int res;
2635 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
2636 if( rc==SQLITE_OK ){
2637 if( res ){
2638 int fout = 0;
2639 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
2640 assert( !pPager->tempFile );
2641 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
2642 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk1977281d8bd2008-10-29 07:01:56 +00002643 if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
2644 rc = SQLITE_CANTOPEN;
danielk1977b3175382008-10-17 18:51:52 +00002645 sqlite3OsClose(pPager->jfd);
2646 }
2647 }else{
2648 /* If the journal does not exist, that means some other process
2649 ** has already rolled it back */
2650 rc = SQLITE_BUSY;
2651 }
2652 }
2653 }
2654 if( rc!=SQLITE_OK ){
danielk1977b3175382008-10-17 18:51:52 +00002655 goto failed;
2656 }
2657 pPager->journalOpen = 1;
2658 pPager->journalStarted = 0;
2659 pPager->journalOff = 0;
2660 pPager->setMaster = 0;
2661 pPager->journalHdr = 0;
2662
2663 /* Playback and delete the journal. Drop the database write
2664 ** lock and reacquire the read lock.
2665 */
2666 rc = pager_playback(pPager, 1);
2667 if( rc!=SQLITE_OK ){
2668 rc = pager_error(pPager, rc);
2669 goto failed;
2670 }
2671 assert(pPager->state==PAGER_SHARED ||
2672 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2673 );
2674 }
2675
2676 if( sqlite3PcachePagecount(pPager->pPCache)>0 ){
2677 /* The shared-lock has just been acquired on the database file
2678 ** and there are already pages in the cache (from a previous
2679 ** read or write transaction). Check to see if the database
2680 ** has been modified. If the database has changed, flush the
2681 ** cache.
2682 **
2683 ** Database changes is detected by looking at 15 bytes beginning
2684 ** at offset 24 into the file. The first 4 of these 16 bytes are
2685 ** a 32-bit counter that is incremented with each change. The
2686 ** other bytes change randomly with each file change when
2687 ** a codec is in use.
2688 **
2689 ** There is a vanishingly small chance that a change will not be
2690 ** detected. The chance of an undetected change is so small that
2691 ** it can be neglected.
2692 */
2693 char dbFileVers[sizeof(pPager->dbFileVers)];
2694 sqlite3PagerPagecount(pPager, 0);
2695
2696 if( pPager->errCode ){
2697 rc = pPager->errCode;
2698 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002699 }
2700
danielk1977b3175382008-10-17 18:51:52 +00002701 if( pPager->dbSize>0 ){
2702 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
2703 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
2704 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002705 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002706 }
danielk1977b3175382008-10-17 18:51:52 +00002707 }else{
2708 memset(dbFileVers, 0, sizeof(dbFileVers));
2709 }
danielk1977e277be02007-03-23 18:12:06 +00002710
danielk1977b3175382008-10-17 18:51:52 +00002711 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
2712 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002713 }
2714 }
danielk1977c5859712007-03-26 12:26:27 +00002715 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2716 if( pPager->state==PAGER_UNLOCK ){
2717 pPager->state = PAGER_SHARED;
2718 }
danielk1977e277be02007-03-23 18:12:06 +00002719 }
2720
danielk197752b472a2008-05-05 16:23:55 +00002721 failed:
2722 if( rc!=SQLITE_OK ){
2723 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
2724 pager_unlock(pPager);
2725 }
danielk1977e277be02007-03-23 18:12:06 +00002726 return rc;
2727}
2728
2729/*
drhd33d5a82007-04-26 12:11:28 +00002730** Make sure we have the content for a page. If the page was
2731** previously acquired with noContent==1, then the content was
2732** just initialized to zeros instead of being read from disk.
2733** But now we need the real data off of disk. So make sure we
2734** have it. Read it in if we do not have it already.
2735*/
2736static int pager_get_content(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002737 if( pPg->flags&PGHDR_NEED_READ ){
drhd33d5a82007-04-26 12:11:28 +00002738 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
2739 if( rc==SQLITE_OK ){
danielk19778c0a7912008-08-20 14:49:23 +00002740 pPg->flags &= ~PGHDR_NEED_READ;
drhd33d5a82007-04-26 12:11:28 +00002741 }else{
2742 return rc;
2743 }
2744 }
2745 return SQLITE_OK;
2746}
2747
2748/*
danielk19778c0a7912008-08-20 14:49:23 +00002749** If the reference count has reached zero, and the pager is not in the
2750** middle of a write transaction or opened in exclusive mode, unlock it.
2751*/
2752static void pagerUnlockIfUnused(Pager *pPager){
2753 if( (sqlite3PcacheRefCount(pPager->pPCache)==0)
2754 && (!pPager->exclusiveMode || pPager->journalOff>0)
2755 ){
2756 pagerUnlockAndRollback(pPager);
2757 }
2758}
2759
2760/*
2761** Drop a page from the cache using sqlite3PcacheDrop().
2762**
2763** If this means there are now no pages with references to them, a rollback
2764** occurs and the lock on the database is removed.
2765*/
2766static void pagerDropPage(DbPage *pPg){
2767 Pager *pPager = pPg->pPager;
2768 sqlite3PcacheDrop(pPg);
2769 pagerUnlockIfUnused(pPager);
2770}
2771
2772/*
drhd9b02572001-04-15 00:37:09 +00002773** Acquire a page.
2774**
drh58a11682001-11-10 13:51:08 +00002775** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002776** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002777**
drhd33d5a82007-04-26 12:11:28 +00002778** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00002779** file is smaller than the requested page, then no actual disk
2780** read occurs and the memory image of the page is initialized to
2781** all zeros. The extra data appended to a page is always initialized
2782** to zeros the first time a page is loaded into memory.
2783**
drhd9b02572001-04-15 00:37:09 +00002784** The acquisition might fail for several reasons. In all cases,
2785** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002786**
drhd33d5a82007-04-26 12:11:28 +00002787** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002788** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00002789** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00002790** just returns 0. This routine acquires a read-lock the first time it
2791** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00002792** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00002793** or journal files.
drh0787db62007-03-04 13:15:27 +00002794**
drh538f5702007-04-13 02:14:30 +00002795** If noContent is false, the page contents are actually read from disk.
2796** If noContent is true, it means that we do not care about the contents
2797** of the page at this time, so do not do a disk read. Just fill in the
2798** page content with zeros. But mark the fact that we have not read the
2799** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00002800** sqlite3PagerWrite() is called on this page or if this routine is
2801** called again with noContent==0, that means that the content is needed
2802** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002803*/
danielk197765e0ff32008-09-19 09:14:43 +00002804int sqlite3PagerAcquire(
drh538f5702007-04-13 02:14:30 +00002805 Pager *pPager, /* The pager open on the database file */
2806 Pgno pgno, /* Page number to fetch */
2807 DbPage **ppPage, /* Write a pointer to the page here */
2808 int noContent /* Do not bother reading content from disk if true */
2809){
danielk19778c0a7912008-08-20 14:49:23 +00002810 PgHdr *pPg = 0;
drh165ffe92005-03-15 17:09:30 +00002811 int rc;
drhed7c8552001-04-11 14:29:21 +00002812
danielk19778c0a7912008-08-20 14:49:23 +00002813 assert( pPager->state==PAGER_UNLOCK
2814 || sqlite3PcacheRefCount(pPager->pPCache)>0
danielk1977b3175382008-10-17 18:51:52 +00002815 || pgno==1
danielk19778c0a7912008-08-20 14:49:23 +00002816 );
danielk1977e277be02007-03-23 18:12:06 +00002817
danielk197726836652005-01-17 01:33:13 +00002818 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2819 ** number greater than this, or zero, is requested.
2820 */
drh267cb322005-09-16 17:16:52 +00002821 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002822 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002823 }
2824
drhd9b02572001-04-15 00:37:09 +00002825 /* Make sure we have not hit any critical errors.
2826 */
drh836faa42003-01-11 13:30:57 +00002827 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002828 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002829
danielk197713adf8a2004-06-03 16:08:41 +00002830 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002831 ** on the database file. pagerSharedLock() is a no-op if
2832 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002833 */
danielk1977e277be02007-03-23 18:12:06 +00002834 rc = pagerSharedLock(pPager);
2835 if( rc!=SQLITE_OK ){
2836 return rc;
drhed7c8552001-04-11 14:29:21 +00002837 }
danielk1977e277be02007-03-23 18:12:06 +00002838 assert( pPager->state!=PAGER_UNLOCK );
2839
danielk19778c0a7912008-08-20 14:49:23 +00002840 rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg);
2841 if( rc!=SQLITE_OK ){
2842 return rc;
2843 }
danielk19778c0a7912008-08-20 14:49:23 +00002844 if( pPg->pPager==0 ){
2845 /* The pager cache has created a new page. Its content needs to
2846 ** be initialized.
2847 */
danielk1977979f38e2007-03-27 16:19:51 +00002848 int nMax;
drh538f5702007-04-13 02:14:30 +00002849 PAGER_INCR(pPager->nMiss);
danielk19778c0a7912008-08-20 14:49:23 +00002850 pPg->pPager = pPager;
2851 if( sqlite3BitvecTest(pPager->pInJournal, pgno) ){
2852 pPg->flags |= PGHDR_IN_JOURNAL;
drhed7c8552001-04-11 14:29:21 +00002853 }
danielk19778c0a7912008-08-20 14:49:23 +00002854 memset(pPg->pExtra, 0, pPager->nExtra);
danielk197724168722007-04-02 05:07:47 +00002855
danielk1977ad0132d2008-06-07 08:58:22 +00002856 rc = sqlite3PagerPagecount(pPager, &nMax);
2857 if( rc!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002858 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00002859 return rc;
2860 }
danielk197775bab7d2006-01-23 13:09:45 +00002861
danielk1977a1fa00d2008-08-27 15:16:33 +00002862 if( nMax<(int)pgno || MEMDB || noContent ){
drhf8e632b2007-05-08 14:51:36 +00002863 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00002864 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00002865 return SQLITE_FULL;
2866 }
danielk19778c0a7912008-08-20 14:49:23 +00002867 memset(pPg->pData, 0, pPager->pageSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00002868 if( noContent ){
danielk19778c0a7912008-08-20 14:49:23 +00002869 pPg->flags |= PGHDR_NEED_READ;
2870 }
drh538f5702007-04-13 02:14:30 +00002871 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00002872 }else{
danielk1977e180dd92007-04-05 17:15:52 +00002873 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00002874 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
danielk19778c0a7912008-08-20 14:49:23 +00002875 /* sqlite3PagerUnref(pPg); */
2876 pagerDropPage(pPg);
drh551b7732006-11-06 21:20:25 +00002877 return rc;
drh81a20f22001-10-12 17:30:04 +00002878 }
drh306dc212001-05-21 13:45:10 +00002879 }
danielk19773c407372005-02-15 02:54:14 +00002880#ifdef SQLITE_CHECK_PAGES
2881 pPg->pageHash = pager_pagehash(pPg);
2882#endif
drhed7c8552001-04-11 14:29:21 +00002883 }else{
drhd9b02572001-04-15 00:37:09 +00002884 /* The requested page is in the page cache. */
danielk19778c0a7912008-08-20 14:49:23 +00002885 assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00002886 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00002887 if( !noContent ){
2888 rc = pager_get_content(pPg);
2889 if( rc ){
danielk19778c0a7912008-08-20 14:49:23 +00002890 sqlite3PagerUnref(pPg);
drhd33d5a82007-04-26 12:11:28 +00002891 return rc;
2892 }
2893 }
drhed7c8552001-04-11 14:29:21 +00002894 }
danielk19778c0a7912008-08-20 14:49:23 +00002895
danielk19773b8a05f2007-03-19 17:44:26 +00002896 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00002897 return SQLITE_OK;
2898}
danielk19778c0a7912008-08-20 14:49:23 +00002899
drhed7c8552001-04-11 14:29:21 +00002900/*
drh7e3b0a02001-04-28 16:52:40 +00002901** Acquire a page if it is already in the in-memory cache. Do
2902** not read the page from disk. Return a pointer to the page,
2903** or 0 if the page is not in cache.
2904**
danielk19773b8a05f2007-03-19 17:44:26 +00002905** See also sqlite3PagerGet(). The difference between this routine
2906** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002907** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002908** returns NULL if the page is not in cache or if a disk I/O error
2909** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002910*/
danielk19773b8a05f2007-03-19 17:44:26 +00002911DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00002912 PgHdr *pPg = 0;
drh836faa42003-01-11 13:30:57 +00002913 assert( pPager!=0 );
2914 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00002915
danielk19778c0a7912008-08-20 14:49:23 +00002916 if( (pPager->state!=PAGER_UNLOCK)
2917 && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL)
2918 ){
2919 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg);
danielk1977e277be02007-03-23 18:12:06 +00002920 }
danielk19778c0a7912008-08-20 14:49:23 +00002921
danielk19773b8a05f2007-03-19 17:44:26 +00002922 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00002923}
2924
2925/*
drhed7c8552001-04-11 14:29:21 +00002926** Release a page.
2927**
2928** If the number of references to the page drop to zero, then the
2929** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002930** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002931** removed.
2932*/
danielk19773b8a05f2007-03-19 17:44:26 +00002933int sqlite3PagerUnref(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002934 if( pPg ){
2935 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002936 sqlite3PcacheRelease(pPg);
2937 pagerUnlockIfUnused(pPager);
drhed7c8552001-04-11 14:29:21 +00002938 }
drhd9b02572001-04-15 00:37:09 +00002939 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002940}
2941
2942/*
drha6abd042004-06-09 17:37:22 +00002943** Create a journal file for pPager. There should already be a RESERVED
2944** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002945**
2946** Return SQLITE_OK if everything. Return an error code and release the
2947** write lock if anything goes wrong.
2948*/
2949static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00002950 sqlite3_vfs *pVfs = pPager->pVfs;
2951 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
2952
drhda47d772002-12-02 04:25:19 +00002953 int rc;
drha6abd042004-06-09 17:37:22 +00002954 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002955 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00002956 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00002957 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00002958 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00002959 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002960 rc = SQLITE_NOMEM;
2961 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002962 }
danielk1977b4b47412007-08-17 15:53:36 +00002963
drhfdc40e92008-04-17 20:59:37 +00002964 if( pPager->journalOpen==0 ){
2965 if( pPager->tempFile ){
2966 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
2967 }else{
2968 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00002969 }
danielk1977b3175382008-10-17 18:51:52 +00002970 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
2971 sqlite3MemJournalOpen(pPager->jfd);
2972 rc = SQLITE_OK;
2973 }else{
drhfdc40e92008-04-17 20:59:37 +00002974#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977b3175382008-10-17 18:51:52 +00002975 rc = sqlite3JournalOpen(
2976 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
2977 );
drhfdc40e92008-04-17 20:59:37 +00002978#else
danielk1977b3175382008-10-17 18:51:52 +00002979 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
drhfdc40e92008-04-17 20:59:37 +00002980#endif
danielk1977b3175382008-10-17 18:51:52 +00002981 }
drhfdc40e92008-04-17 20:59:37 +00002982 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
2983 pPager->journalOff = 0;
2984 pPager->setMaster = 0;
2985 pPager->journalHdr = 0;
2986 if( rc!=SQLITE_OK ){
2987 if( rc==SQLITE_NOMEM ){
2988 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2989 }
2990 goto failed_to_open_journal;
2991 }
drhda47d772002-12-02 04:25:19 +00002992 }
2993 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002994 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002995 pPager->needSync = 0;
drh968af522003-02-11 14:55:40 +00002996 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00002997 if( pPager->errCode ){
2998 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00002999 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003000 }
drhda47d772002-12-02 04:25:19 +00003001 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003002
danielk197776572402004-06-25 02:38:54 +00003003 rc = writeJournalHdr(pPager);
3004
drhac69b052004-05-12 13:30:07 +00003005 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003006 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003007 }
danielk1977ae72d982007-10-03 08:46:44 +00003008 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003009 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003010 if( rc==SQLITE_OK ){
3011 rc = SQLITE_FULL;
3012 }
3013 }
drh9c105bb2004-10-02 20:38:28 +00003014 return rc;
3015
3016failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003017 sqlite3BitvecDestroy(pPager->pInJournal);
3018 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003019 return rc;
drhda47d772002-12-02 04:25:19 +00003020}
3021
3022/*
drh4b845d72002-03-05 12:41:19 +00003023** Acquire a write-lock on the database. The lock is removed when
3024** the any of the following happen:
3025**
drh80e35f42007-03-30 14:06:34 +00003026** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003027** * sqlite3PagerRollback() is called.
3028** * sqlite3PagerClose() is called.
3029** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003030**
danielk197713adf8a2004-06-03 16:08:41 +00003031** The first parameter to this routine is a pointer to any open page of the
3032** database file. Nothing changes about the page - it is used merely to
3033** acquire a pointer to the Pager structure and as proof that there is
3034** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003035**
danielk197713adf8a2004-06-03 16:08:41 +00003036** The second parameter indicates how much space in bytes to reserve for a
3037** master journal file-name at the start of the journal when it is created.
3038**
3039** A journal file is opened if this is not a temporary file. For temporary
3040** files, the opening of the journal file is deferred until there is an
3041** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003042**
drha6abd042004-06-09 17:37:22 +00003043** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003044**
3045** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3046** immediately instead of waiting until we try to flush the cache. The
3047** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003048*/
danielk19773b8a05f2007-03-19 17:44:26 +00003049int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003050 Pager *pPager = pPg->pPager;
3051 int rc = SQLITE_OK;
3052 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003053 assert( pPager->state!=PAGER_UNLOCK );
3054 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003055 assert( pPager->pInJournal==0 );
danielk1977b3175382008-10-17 18:51:52 +00003056 assert( !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00003057 sqlite3PcacheAssertFlags(pPager->pPCache, 0, PGHDR_IN_JOURNAL);
danielk1977b3175382008-10-17 18:51:52 +00003058 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
3059 if( rc==SQLITE_OK ){
3060 pPager->state = PAGER_RESERVED;
3061 if( exFlag ){
3062 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh684917c2004-10-05 02:41:42 +00003063 }
danielk1977b3175382008-10-17 18:51:52 +00003064 }
3065 if( rc!=SQLITE_OK ){
3066 return rc;
3067 }
3068 pPager->dirtyCache = 0;
3069 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
3070 if( pPager->useJournal && !pPager->tempFile
3071 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
3072 rc = pager_open_journal(pPager);
drh4b845d72002-03-05 12:41:19 +00003073 }
danielk1977334cdb62007-03-26 08:05:12 +00003074 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00003075 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00003076 ** time a (read or write) transaction was successfully concluded
3077 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00003078 ** kept open and either was truncated to 0 bytes or its header was
3079 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00003080 */
3081 assert( pPager->nRec==0 );
3082 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003083 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003084 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003085 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhf5e7bb52008-02-18 14:47:33 +00003086 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003087 rc = SQLITE_NOMEM;
3088 }else{
drh369339d2007-03-30 16:01:55 +00003089 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003090 rc = writeJournalHdr(pPager);
3091 }
drh4b845d72002-03-05 12:41:19 +00003092 }
danielk1977334cdb62007-03-26 08:05:12 +00003093 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003094 return rc;
3095}
3096
3097/*
drh605ad8f2006-05-03 23:34:05 +00003098** Make a page dirty. Set its dirty flag and add it to the dirty
3099** page list.
3100*/
3101static void makeDirty(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003102 sqlite3PcacheMakeDirty(pPg);
drh605ad8f2006-05-03 23:34:05 +00003103}
3104
3105/*
3106** Make a page clean. Clear its dirty bit and remove it from the
3107** dirty page list.
3108*/
3109static void makeClean(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003110 sqlite3PcacheMakeClean(pPg);
drh605ad8f2006-05-03 23:34:05 +00003111}
3112
3113
3114/*
drhed7c8552001-04-11 14:29:21 +00003115** Mark a data page as writeable. The page is written into the journal
3116** if it is not there already. This routine must be called before making
3117** changes to a page.
3118**
3119** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003120** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003121** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003122** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003123** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003124**
3125** If the journal file could not be written because the disk is full,
3126** then this routine returns SQLITE_FULL and does an immediate rollback.
3127** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003128** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003129** reset.
drhed7c8552001-04-11 14:29:21 +00003130*/
danielk19773b8a05f2007-03-19 17:44:26 +00003131static int pager_write(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003132 void *pData = pPg->pData;
drh69688d52001-04-14 16:38:23 +00003133 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003134 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003135
drh6446c4d2001-12-15 14:22:18 +00003136 /* Check for errors
3137 */
danielk1977efaaf572006-01-16 11:29:19 +00003138 if( pPager->errCode ){
3139 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003140 }
drh5e00f6c2001-09-13 13:46:56 +00003141 if( pPager->readOnly ){
3142 return SQLITE_PERM;
3143 }
drh6446c4d2001-12-15 14:22:18 +00003144
danielk197776572402004-06-25 02:38:54 +00003145 assert( !pPager->setMaster );
3146
danielk19773c407372005-02-15 02:54:14 +00003147 CHECK_PAGE(pPg);
3148
drh538f5702007-04-13 02:14:30 +00003149 /* If this page was previously acquired with noContent==1, that means
3150 ** we didn't really read in the content of the page. This can happen
3151 ** (for example) when the page is being moved to the freelist. But
3152 ** now we are (perhaps) moving the page off of the freelist for
3153 ** reuse and we need to know its original content so that content
3154 ** can be stored in the rollback journal. So do the read at this
3155 ** time.
3156 */
drhd33d5a82007-04-26 12:11:28 +00003157 rc = pager_get_content(pPg);
3158 if( rc ){
3159 return rc;
drh538f5702007-04-13 02:14:30 +00003160 }
3161
drh6446c4d2001-12-15 14:22:18 +00003162 /* Mark the page as dirty. If the page has already been written
3163 ** to the journal then we can return right away.
3164 */
drh605ad8f2006-05-03 23:34:05 +00003165 makeDirty(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00003166 if( (pPg->flags&PGHDR_IN_JOURNAL)
3167 && (pageInStatement(pPg) || pPager->stmtInUse==0)
3168 ){
drha6abd042004-06-09 17:37:22 +00003169 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003170 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003171 }else{
drh6446c4d2001-12-15 14:22:18 +00003172
danielk1977a0bf2652004-11-04 14:30:04 +00003173 /* If we get this far, it means that the page needs to be
3174 ** written to the transaction journal or the ckeckpoint journal
3175 ** or both.
3176 **
3177 ** First check to see that the transaction journal exists and
3178 ** create it if it does not.
3179 */
3180 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003181 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003182 if( rc!=SQLITE_OK ){
3183 return rc;
3184 }
3185 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00003186 if( !pPager->journalOpen && pPager->useJournal
3187 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00003188 rc = pager_open_journal(pPager);
3189 if( rc!=SQLITE_OK ) return rc;
3190 }
danielk1977a0bf2652004-11-04 14:30:04 +00003191 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003192 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003193
3194 /* The transaction journal now exists and we have a RESERVED or an
3195 ** EXCLUSIVE lock on the main database file. Write the current page to
3196 ** the transaction journal if it is not there already.
3197 */
danielk1977b3175382008-10-17 18:51:52 +00003198 if( !(pPg->flags&PGHDR_IN_JOURNAL) && pPager->journalOpen ){
danielk1977a0bf2652004-11-04 14:30:04 +00003199 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977b3175382008-10-17 18:51:52 +00003200 u32 cksum;
3201 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00003202
danielk1977b3175382008-10-17 18:51:52 +00003203 /* We should never write to the journal file the page that
3204 ** contains the database locks. The following assert verifies
3205 ** that we do not. */
3206 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
3207 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
3208 cksum = pager_cksum(pPager, (u8*)pData2);
3209 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
3210 if( rc==SQLITE_OK ){
3211 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
3212 pPager->journalOff + 4);
3213 pPager->journalOff += pPager->pageSize+4;
3214 }
3215 if( rc==SQLITE_OK ){
3216 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
3217 pPager->journalOff += 4;
3218 }
3219 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
3220 pPager->journalOff, pPager->pageSize));
3221 PAGER_INCR(sqlite3_pager_writej_count);
3222 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
3223 PAGERID(pPager), pPg->pgno,
3224 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00003225
danielk1977b3175382008-10-17 18:51:52 +00003226 /* An error has occured writing to the journal file. The
3227 ** transaction will be rolled back by the layer above.
3228 */
3229 if( rc!=SQLITE_OK ){
3230 return rc;
3231 }
danielk197707cb5602006-01-20 10:55:05 +00003232
danielk1977b3175382008-10-17 18:51:52 +00003233 pPager->nRec++;
3234 assert( pPager->pInJournal!=0 );
3235 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
3236 if( !pPager->noSync ){
3237 pPg->flags |= PGHDR_NEED_SYNC;
3238 }
3239 if( pPager->stmtInUse ){
3240 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003241 }
danielk197713adf8a2004-06-03 16:08:41 +00003242 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003243 if( !pPager->journalStarted && !pPager->noSync ){
3244 pPg->flags |= PGHDR_NEED_SYNC;
3245 }
drh4f0c5872007-03-26 22:05:01 +00003246 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk19778c0a7912008-08-20 14:49:23 +00003247 PAGERID(pPager), pPg->pgno,
3248 ((pPg->flags&PGHDR_NEED_SYNC)?1:0));
danielk1977a0bf2652004-11-04 14:30:04 +00003249 }
danielk19778c0a7912008-08-20 14:49:23 +00003250 if( pPg->flags&PGHDR_NEED_SYNC ){
danielk1977a0bf2652004-11-04 14:30:04 +00003251 pPager->needSync = 1;
3252 }
danielk19778c0a7912008-08-20 14:49:23 +00003253 pPg->flags |= PGHDR_IN_JOURNAL;
danielk1977a0bf2652004-11-04 14:30:04 +00003254 }
3255
3256 /* If the statement journal is open and the page is not in it,
3257 ** then write the current page to the statement journal. Note that
3258 ** the statement journal format differs from the standard journal format
3259 ** in that it omits the checksums and the header.
3260 */
danielk1977f35843b2007-04-07 15:03:17 +00003261 if( pPager->stmtInUse
3262 && !pageInStatement(pPg)
3263 && (int)pPg->pgno<=pPager->stmtSize
3264 ){
danielk1977b3175382008-10-17 18:51:52 +00003265 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
3266 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
shane049fc212008-10-22 16:26:47 +00003267 assert( (pPg->flags&PGHDR_IN_JOURNAL)
3268 || (int)pPg->pgno>pPager->origDbSize );
danielk1977b3175382008-10-17 18:51:52 +00003269 rc = write32bits(pPager->stfd, offset, pPg->pgno);
3270 if( rc==SQLITE_OK ){
3271 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
drhdb48ee02003-01-16 13:42:43 +00003272 }
danielk1977b3175382008-10-17 18:51:52 +00003273 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
3274 if( rc!=SQLITE_OK ){
3275 return rc;
3276 }
3277 pPager->stmtNRec++;
3278 assert( pPager->pInStmt!=0 );
3279 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhd9b02572001-04-15 00:37:09 +00003280 }
drhfa86c412002-02-02 15:01:15 +00003281 }
3282
3283 /* Update the database size and return.
3284 */
drh1aa2d8b2007-01-03 15:34:29 +00003285 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00003286 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003287 pPager->dbSize = pPg->pgno;
danielk1977b3175382008-10-17 18:51:52 +00003288 if( pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003289 pPager->dbSize++;
3290 }
drh306dc212001-05-21 13:45:10 +00003291 }
drh69688d52001-04-14 16:38:23 +00003292 return rc;
drhed7c8552001-04-11 14:29:21 +00003293}
3294
3295/*
danielk19774099f6e2007-03-19 11:25:20 +00003296** This function is used to mark a data-page as writable. It uses
3297** pager_write() to open a journal file (if it is not already open)
3298** and write the page *pData to the journal.
3299**
3300** The difference between this function and pager_write() is that this
3301** function also deals with the special case where 2 or more pages
3302** fit on a single disk sector. In this case all co-resident pages
3303** must have been written to the journal file before returning.
3304*/
danielk19773b8a05f2007-03-19 17:44:26 +00003305int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003306 int rc = SQLITE_OK;
3307
danielk19773b8a05f2007-03-19 17:44:26 +00003308 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003309 Pager *pPager = pPg->pPager;
3310 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3311
danielk1977b3175382008-10-17 18:51:52 +00003312 if( nPagePerSector>1 ){
danielk19774099f6e2007-03-19 11:25:20 +00003313 Pgno nPageCount; /* Total number of pages in database file */
3314 Pgno pg1; /* First page of the sector pPg is located on. */
3315 int nPage; /* Number of pages starting at pg1 to journal */
3316 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003317 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003318
3319 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3320 ** header to be written between the pages journaled by this function.
3321 */
danielk1977b3175382008-10-17 18:51:52 +00003322 assert( !MEMDB );
danielk19774099f6e2007-03-19 11:25:20 +00003323 assert( pPager->doNotSync==0 );
3324 pPager->doNotSync = 1;
3325
3326 /* This trick assumes that both the page-size and sector-size are
3327 ** an integer power of 2. It sets variable pg1 to the identifier
3328 ** of the first page of the sector pPg is located on.
3329 */
3330 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3331
danielk1977ad0132d2008-06-07 08:58:22 +00003332 sqlite3PagerPagecount(pPager, (int *)&nPageCount);
danielk19774099f6e2007-03-19 11:25:20 +00003333 if( pPg->pgno>nPageCount ){
3334 nPage = (pPg->pgno - pg1)+1;
3335 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3336 nPage = nPageCount+1-pg1;
3337 }else{
3338 nPage = nPagePerSector;
3339 }
3340 assert(nPage>0);
3341 assert(pg1<=pPg->pgno);
3342 assert((pg1+nPage)>pPg->pgno);
3343
3344 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3345 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003346 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00003347 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00003348 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003349 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003350 if( rc==SQLITE_OK ){
3351 rc = pager_write(pPage);
danielk19778c0a7912008-08-20 14:49:23 +00003352 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003353 needSync = 1;
3354 }
danielk19773b8a05f2007-03-19 17:44:26 +00003355 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003356 }
3357 }
drhc81945e2008-03-10 14:12:53 +00003358 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk19778c0a7912008-08-20 14:49:23 +00003359 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003360 needSync = 1;
3361 }
danielk19778c0a7912008-08-20 14:49:23 +00003362 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003363 }
3364 }
3365
danielk1977dd97a492007-08-22 18:54:32 +00003366 /* If the PgHdr.needSync flag is set for any of the nPage pages
3367 ** starting at pg1, then it needs to be set for all of them. Because
3368 ** writing to any of these nPage pages may damage the others, the
3369 ** journal file must contain sync()ed copies of all of them
3370 ** before any of them can be written out to the database file.
3371 */
3372 if( needSync ){
drhb3df2e12008-09-17 20:06:26 +00003373 assert( !MEMDB && pPager->noSync==0 );
danielk1977dd97a492007-08-22 18:54:32 +00003374 for(ii=0; ii<nPage && needSync; ii++){
3375 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
danielk19778c0a7912008-08-20 14:49:23 +00003376 if( pPage ) pPage->flags |= PGHDR_NEED_SYNC;
3377 sqlite3PagerUnref(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003378 }
3379 assert(pPager->needSync);
3380 }
3381
danielk19774099f6e2007-03-19 11:25:20 +00003382 assert( pPager->doNotSync==1 );
3383 pPager->doNotSync = 0;
3384 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003385 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003386 }
3387 return rc;
3388}
3389
3390/*
drhaacc5432002-01-06 17:07:40 +00003391** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003392** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003393** to change the content of the page.
3394*/
danielk19777d3a6662006-01-23 16:21:05 +00003395#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003396int sqlite3PagerIswriteable(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003397 return pPg->flags&PGHDR_DIRTY;
drh6019e162001-07-02 17:51:45 +00003398}
danielk19777d3a6662006-01-23 16:21:05 +00003399#endif
drh6019e162001-07-02 17:51:45 +00003400
drh001bbcb2003-03-19 03:14:00 +00003401/*
drh30e58752002-03-02 20:41:57 +00003402** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003403** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00003404** that page might be marked as dirty.
3405**
3406** The overlying software layer calls this routine when all of the data
3407** on the given page is unused. The pager marks the page as clean so
3408** that it does not get written to disk.
3409**
3410** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003411** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003412** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003413**
3414** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003415** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003416** will thereafter be ignored. This is necessary to avoid a problem
3417** where a page with data is added to the freelist during one part of
3418** a transaction then removed from the freelist during a later part
3419** of the same transaction and reused for some other purpose. When it
3420** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003421** the sqlite3PagerDontRollback() routine is called. But because the
3422** page contains critical data, we still need to be sure it gets
3423** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003424*/
danielk1977a1fa00d2008-08-27 15:16:33 +00003425int sqlite3PagerDontWrite(DbPage *pDbPage){
drh538f5702007-04-13 02:14:30 +00003426 PgHdr *pPg = pDbPage;
3427 Pager *pPager = pPg->pPager;
danielk1977a1fa00d2008-08-27 15:16:33 +00003428 int rc;
drh8e298f92002-07-06 16:28:47 +00003429
danielk1977b3175382008-10-17 18:51:52 +00003430 if( pPg->pgno>pPager->origDbSize ){
danielk1977a1fa00d2008-08-27 15:16:33 +00003431 return SQLITE_OK;
3432 }
3433 if( pPager->pAlwaysRollback==0 ){
3434 assert( pPager->pInJournal );
3435 pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->origDbSize);
3436 if( !pPager->pAlwaysRollback ){
3437 return SQLITE_NOMEM;
3438 }
3439 }
3440 rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno);
3441
3442 if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00003443 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00003444 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
3445 /* If this pages is the last page in the file and the file has grown
3446 ** during the current transaction, then do NOT mark the page as clean.
3447 ** When the database file grows, we must make sure that the last page
3448 ** gets written at least once so that the disk file will be the correct
3449 ** size. If you do not write this page and the size of the file
3450 ** on the disk ends up being too small, that can lead to database
3451 ** corruption during the next transaction.
3452 */
3453 }else{
drh538f5702007-04-13 02:14:30 +00003454 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3455 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
danielk197733e32162008-08-23 18:53:08 +00003456 pPg->flags |= PGHDR_DONT_WRITE;
danielk19773c407372005-02-15 02:54:14 +00003457#ifdef SQLITE_CHECK_PAGES
3458 pPg->pageHash = pager_pagehash(pPg);
3459#endif
drh8124a302002-06-25 14:43:57 +00003460 }
drh30e58752002-03-02 20:41:57 +00003461 }
danielk1977a1fa00d2008-08-27 15:16:33 +00003462 return rc;
drh30e58752002-03-02 20:41:57 +00003463}
3464
3465/*
3466** A call to this routine tells the pager that if a rollback occurs,
3467** it is not necessary to restore the data on the given page. This
3468** means that the pager does not have to record the given page in the
3469** rollback journal.
drh538f5702007-04-13 02:14:30 +00003470**
3471** If we have not yet actually read the content of this page (if
3472** the PgHdr.needRead flag is set) then this routine acts as a promise
3473** that we will never need to read the page content in the future.
3474** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003475*/
danielk19773b8a05f2007-03-19 17:44:26 +00003476void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003477 Pager *pPager = pPg->pPager;
3478
drhd3627af2006-12-18 18:34:51 +00003479 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00003480
3481 /* If the journal file is not open, or DontWrite() has been called on
3482 ** this page (DontWrite() sets the alwaysRollback flag), then this
3483 ** function is a no-op.
3484 */
danielk1977a1fa00d2008-08-27 15:16:33 +00003485 if( pPager->journalOpen==0
3486 || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno)
3487 || pPg->pgno>pPager->origDbSize
danielk19778c0a7912008-08-20 14:49:23 +00003488 ){
danielk197787c29a92008-01-18 11:33:16 +00003489 return;
3490 }
danielk1977a55e9352008-01-21 13:04:34 +00003491
drhc5d0bd92008-04-14 01:00:57 +00003492#ifdef SQLITE_SECURE_DELETE
drha85f7e32008-08-28 02:26:07 +00003493 if( (pPg->flags & PGHDR_IN_JOURNAL)!=0 || (int)pPg->pgno>pPager->origDbSize ){
drhc5d0bd92008-04-14 01:00:57 +00003494 return;
3495 }
3496#endif
3497
3498 /* If SECURE_DELETE is disabled, then there is no way that this
3499 ** routine can be called on a page for which sqlite3PagerDontWrite()
3500 ** has not been previously called during the same transaction.
3501 ** And if DontWrite() has previously been called, the following
3502 ** conditions must be met.
drh10131482008-07-11 03:34:09 +00003503 **
3504 ** (Later:) Not true. If the database is corrupted by having duplicate
3505 ** pages on the freelist (ex: corrupt9.test) then the following is not
3506 ** necessarily true:
danielk1977a55e9352008-01-21 13:04:34 +00003507 */
drh10131482008-07-11 03:34:09 +00003508 /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ); */
danielk1977a55e9352008-01-21 13:04:34 +00003509
drhf5e7bb52008-02-18 14:47:33 +00003510 assert( pPager->pInJournal!=0 );
3511 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003512 pPg->flags |= PGHDR_IN_JOURNAL;
3513 pPg->flags &= ~PGHDR_NEED_READ;
danielk1977a55e9352008-01-21 13:04:34 +00003514 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00003515 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00003516 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00003517 }
danielk1977a55e9352008-01-21 13:04:34 +00003518 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
3519 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003520}
3521
drhac69b052004-05-12 13:30:07 +00003522
drh30e58752002-03-02 20:41:57 +00003523/*
drh80e35f42007-03-30 14:06:34 +00003524** This routine is called to increment the database file change-counter,
3525** stored at byte 24 of the pager file.
3526*/
danielk1977c7b60172007-08-22 11:22:03 +00003527static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00003528 PgHdr *pPgHdr;
3529 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00003530 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00003531
drh701bb3b2008-08-02 03:50:39 +00003532#ifndef SQLITE_ENABLE_ATOMIC_WRITE
3533 assert( isDirect==0 ); /* isDirect is only true for atomic writes */
3534#endif
drh80e35f42007-03-30 14:06:34 +00003535 if( !pPager->changeCountDone ){
3536 /* Open page 1 of the file for writing. */
3537 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3538 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00003539
3540 if( !isDirect ){
3541 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00003542 if( rc!=SQLITE_OK ){
3543 sqlite3PagerUnref(pPgHdr);
3544 return rc;
3545 }
danielk1977c7b60172007-08-22 11:22:03 +00003546 }
3547
drh80e35f42007-03-30 14:06:34 +00003548 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003549 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003550 change_counter++;
danielk19778c0a7912008-08-20 14:49:23 +00003551 put32bits(((char*)pPgHdr->pData)+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00003552
drh701bb3b2008-08-02 03:50:39 +00003553#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977c7b60172007-08-22 11:22:03 +00003554 if( isDirect && pPager->fd->pMethods ){
danielk19778c0a7912008-08-20 14:49:23 +00003555 const void *zBuf = pPgHdr->pData;
danielk1977c7b60172007-08-22 11:22:03 +00003556 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
3557 }
drh701bb3b2008-08-02 03:50:39 +00003558#endif
danielk1977c7b60172007-08-22 11:22:03 +00003559
drh80e35f42007-03-30 14:06:34 +00003560 /* Release the page reference. */
3561 sqlite3PagerUnref(pPgHdr);
3562 pPager->changeCountDone = 1;
3563 }
danielk1977c7b60172007-08-22 11:22:03 +00003564 return rc;
drh80e35f42007-03-30 14:06:34 +00003565}
3566
3567/*
danielk1977f653d782008-03-20 11:04:21 +00003568** Sync the pager file to disk.
3569*/
3570int sqlite3PagerSync(Pager *pPager){
3571 int rc;
drh7426f862008-08-26 21:07:26 +00003572 if( MEMDB ){
3573 rc = SQLITE_OK;
3574 }else{
3575 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
3576 }
danielk1977f653d782008-03-20 11:04:21 +00003577 return rc;
3578}
3579
3580/*
drh80e35f42007-03-30 14:06:34 +00003581** Sync the database file for the pager pPager. zMaster points to the name
3582** of a master journal file that should be written into the individual
3583** journal file. zMaster may be NULL, which is interpreted as no master
3584** journal (a single database transaction).
3585**
3586** This routine ensures that the journal is synced, all dirty pages written
3587** to the database file and the database file synced. The only thing that
3588** remains to commit the transaction is to delete the journal file (or
3589** master journal file if specified).
3590**
3591** Note that if zMaster==NULL, this does not overwrite a previous value
3592** passed to an sqlite3PagerCommitPhaseOne() call.
3593**
3594** If parameter nTrunc is non-zero, then the pager file is truncated to
3595** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00003596**
3597** If the final parameter - noSync - is true, then the database file itself
3598** is not synced. The caller must call sqlite3PagerSync() directly to
3599** sync the database file before calling CommitPhaseTwo() to delete the
3600** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00003601*/
danielk1977f653d782008-03-20 11:04:21 +00003602int sqlite3PagerCommitPhaseOne(
3603 Pager *pPager,
3604 const char *zMaster,
3605 Pgno nTrunc,
3606 int noSync
3607){
drh80e35f42007-03-30 14:06:34 +00003608 int rc = SQLITE_OK;
3609
danielk1977dad31b52008-05-15 11:08:07 +00003610 if( pPager->errCode ){
3611 return pPager->errCode;
3612 }
3613
drhd138c012008-05-13 00:58:18 +00003614 /* If no changes have been made, we can leave the transaction early.
3615 */
3616 if( pPager->dbModified==0 &&
3617 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3618 pPager->exclusiveMode!=0) ){
3619 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3620 return SQLITE_OK;
3621 }
3622
drh80e35f42007-03-30 14:06:34 +00003623 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3624 pPager->zFilename, zMaster, nTrunc);
3625
3626 /* If this is an in-memory db, or no pages have been written to, or this
3627 ** function has already been called, it is a no-op.
3628 */
3629 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3630 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00003631
danielk1977c7b60172007-08-22 11:22:03 +00003632#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3633 /* The atomic-write optimization can be used if all of the
3634 ** following are true:
3635 **
3636 ** + The file-system supports the atomic-write property for
3637 ** blocks of size page-size, and
3638 ** + This commit is not part of a multi-file transaction, and
3639 ** + Exactly one page has been modified and store in the journal file.
3640 **
3641 ** If the optimization can be used, then the journal file will never
3642 ** be created for this transaction.
3643 */
danielk19774d60af92008-09-08 15:35:06 +00003644 int useAtomicWrite;
danielk19778c0a7912008-08-20 14:49:23 +00003645 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
danielk19774d60af92008-09-08 15:35:06 +00003646 useAtomicWrite = (
danielk1977f55b8992007-08-24 08:15:53 +00003647 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00003648 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00003649 pPager->journalOff==jrnlBufferSize(pPager) &&
3650 nTrunc==0 &&
danielk19778c0a7912008-08-20 14:49:23 +00003651 (pPg==0 || pPg->pDirty==0)
danielk1977f55b8992007-08-24 08:15:53 +00003652 );
danielk1977700b9c52008-04-24 12:37:40 +00003653 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00003654 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00003655 /* Update the nRec field in the journal file. */
3656 int offset = pPager->journalHdr + sizeof(aJournalMagic);
3657 assert(pPager->nRec==1);
3658 rc = write32bits(pPager->jfd, offset, pPager->nRec);
3659
3660 /* Update the db file change counter. The following call will modify
3661 ** the in-memory representation of page 1 to include the updated
3662 ** change counter and then write page 1 directly to the database
3663 ** file. Because of the atomic-write property of the host file-system,
3664 ** this is safe.
3665 */
danielk1977ae72d982007-10-03 08:46:44 +00003666 if( rc==SQLITE_OK ){
3667 rc = pager_incr_changecounter(pPager, 1);
3668 }
danielk1977f55b8992007-08-24 08:15:53 +00003669 }else{
3670 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00003671 }
3672
danielk1977ae72d982007-10-03 08:46:44 +00003673 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00003674#endif
3675
drh80e35f42007-03-30 14:06:34 +00003676 /* If a master journal file name has already been written to the
3677 ** journal file, then no sync is required. This happens when it is
3678 ** written, then the process fails to upgrade from a RESERVED to an
3679 ** EXCLUSIVE lock. The next time the process tries to commit the
3680 ** transaction the m-j name will have already been written.
3681 */
3682 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00003683 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003684 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00003685 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00003686#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00003687 if( nTrunc!=0 ){
3688 /* If this transaction has made the database smaller, then all pages
3689 ** being discarded by the truncation must be written to the journal
3690 ** file.
3691 */
3692 Pgno i;
3693 int iSkip = PAGER_MJ_PGNO(pPager);
3694 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3695 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
3696 rc = sqlite3PagerGet(pPager, i, &pPg);
3697 if( rc!=SQLITE_OK ) goto sync_exit;
3698 rc = sqlite3PagerWrite(pPg);
3699 sqlite3PagerUnref(pPg);
3700 if( rc!=SQLITE_OK ) goto sync_exit;
3701 }
3702 }
3703 }
drh80e35f42007-03-30 14:06:34 +00003704#endif
danielk197771aa7ff2008-05-20 07:05:09 +00003705 rc = writeMasterJournal(pPager, zMaster);
3706 if( rc!=SQLITE_OK ) goto sync_exit;
3707 rc = syncJournal(pPager);
3708 }
drh80e35f42007-03-30 14:06:34 +00003709 }
danielk1977c7b60172007-08-22 11:22:03 +00003710 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00003711
3712#ifndef SQLITE_OMIT_AUTOVACUUM
3713 if( nTrunc!=0 ){
3714 rc = sqlite3PagerTruncate(pPager, nTrunc);
3715 if( rc!=SQLITE_OK ) goto sync_exit;
3716 }
3717#endif
3718
3719 /* Write all dirty pages to the database file */
danielk19778c0a7912008-08-20 14:49:23 +00003720 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003721 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00003722 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00003723 assert( rc!=SQLITE_IOERR_BLOCKED );
3724 /* The error might have left the dirty list all fouled up here,
3725 ** but that does not matter because if the if the dirty list did
3726 ** get corrupted, then the transaction will roll back and
3727 ** discard the dirty list. There is an assert in
3728 ** pager_get_all_dirty_pages() that verifies that no attempt
3729 ** is made to use an invalid dirty list.
3730 */
drh153c62c2007-08-24 03:51:33 +00003731 goto sync_exit;
3732 }
danielk19778c0a7912008-08-20 14:49:23 +00003733 sqlite3PcacheCleanAll(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003734
3735 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00003736 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00003737 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00003738 }
3739 IOTRACE(("DBSYNC %p\n", pPager))
3740
3741 pPager->state = PAGER_SYNCED;
3742 }else if( MEMDB && nTrunc!=0 ){
3743 rc = sqlite3PagerTruncate(pPager, nTrunc);
3744 }
3745
3746sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00003747 if( rc==SQLITE_IOERR_BLOCKED ){
3748 /* pager_incr_changecounter() may attempt to obtain an exclusive
3749 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00003750 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00003751 * better to return SQLITE_BUSY.
3752 */
3753 rc = SQLITE_BUSY;
3754 }
drh80e35f42007-03-30 14:06:34 +00003755 return rc;
3756}
3757
3758
3759/*
drhed7c8552001-04-11 14:29:21 +00003760** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003761**
3762** If the commit fails for any reason, a rollback attempt is made
3763** and an error code is returned. If the commit worked, SQLITE_OK
3764** is returned.
drhed7c8552001-04-11 14:29:21 +00003765*/
drh80e35f42007-03-30 14:06:34 +00003766int sqlite3PagerCommitPhaseTwo(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003767 int rc = SQLITE_OK;
drhd9b02572001-04-15 00:37:09 +00003768
danielk1977efaaf572006-01-16 11:29:19 +00003769 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003770 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003771 }
drha6abd042004-06-09 17:37:22 +00003772 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003773 return SQLITE_ERROR;
3774 }
drhd138c012008-05-13 00:58:18 +00003775 if( pPager->dbModified==0 &&
3776 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3777 pPager->exclusiveMode!=0) ){
3778 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3779 return SQLITE_OK;
3780 }
drh4f0c5872007-03-26 22:05:01 +00003781 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003782 assert( pPager->state==PAGER_SYNCED || MEMDB || !pPager->dirtyCache );
3783 rc = pager_end_transaction(pPager, pPager->setMaster);
3784 rc = pager_error(pPager, rc);
drh86f8c192007-08-22 00:39:19 +00003785 return rc;
drhed7c8552001-04-11 14:29:21 +00003786}
3787
3788/*
drha6abd042004-06-09 17:37:22 +00003789** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003790** All in-memory cache pages revert to their original data contents.
3791** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003792**
3793** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003794** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003795** process is writing trash into the journal file (SQLITE_CORRUPT) or
3796** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3797** codes are returned for all these occasions. Otherwise,
3798** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003799*/
danielk19773b8a05f2007-03-19 17:44:26 +00003800int sqlite3PagerRollback(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003801 int rc = SQLITE_OK;
drh4f0c5872007-03-26 22:05:01 +00003802 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003803 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00003804 rc = pager_end_transaction(pPager, pPager->setMaster);
danielk19778c0a7912008-08-20 14:49:23 +00003805 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003806 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003807 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003808 }
danielk19778c0a7912008-08-20 14:49:23 +00003809 rc = pPager->errCode;
drha6abd042004-06-09 17:37:22 +00003810 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003811 if( pPager->state==PAGER_RESERVED ){
3812 int rc2;
3813 rc = pager_playback(pPager, 0);
3814 rc2 = pager_end_transaction(pPager, pPager->setMaster);
3815 if( rc==SQLITE_OK ){
3816 rc = rc2;
3817 }
3818 }else{
3819 rc = pager_playback(pPager, 0);
3820 }
danielk197707cb5602006-01-20 10:55:05 +00003821
danielk1977b3175382008-10-17 18:51:52 +00003822 if( !MEMDB ){
3823 pPager->dbSize = -1;
3824 }
danielk19778c0a7912008-08-20 14:49:23 +00003825
3826 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3827 ** cache. So call pager_error() on the way out to make any error
3828 ** persistent.
3829 */
3830 rc = pager_error(pPager, rc);
3831 }
drh86f8c192007-08-22 00:39:19 +00003832 return rc;
drh98808ba2001-10-18 12:34:46 +00003833}
drhd9b02572001-04-15 00:37:09 +00003834
3835/*
drh5e00f6c2001-09-13 13:46:56 +00003836** Return TRUE if the database file is opened read-only. Return FALSE
3837** if the database is (in theory) writable.
3838*/
danielk19773b8a05f2007-03-19 17:44:26 +00003839int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003840 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003841}
3842
3843/*
drh0f7eb612006-08-08 13:51:43 +00003844** Return the number of references to the pager.
3845*/
danielk19773b8a05f2007-03-19 17:44:26 +00003846int sqlite3PagerRefcount(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003847 return sqlite3PcacheRefCount(pPager->pPCache);
drh0f7eb612006-08-08 13:51:43 +00003848}
3849
danielk197771d5d2c2008-09-29 11:49:47 +00003850/*
3851** Return the number of references to the specified page.
3852*/
3853int sqlite3PagerPageRefcount(DbPage *pPage){
3854 return sqlite3PcachePageRefcount(pPage);
3855}
3856
drh0f7eb612006-08-08 13:51:43 +00003857#ifdef SQLITE_TEST
3858/*
drhd9b02572001-04-15 00:37:09 +00003859** This routine is used for testing and analysis only.
3860*/
danielk19773b8a05f2007-03-19 17:44:26 +00003861int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003862 static int a[11];
danielk19778c0a7912008-08-20 14:49:23 +00003863 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
3864 a[1] = sqlite3PcachePagecount(pPager->pPCache);
3865 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
drhd9b02572001-04-15 00:37:09 +00003866 a[3] = pPager->dbSize;
3867 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003868 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003869 a[6] = pPager->nHit;
3870 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003871 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003872 a[9] = pPager->nRead;
3873 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003874 return a;
3875}
danielk197717b90b52008-06-06 11:11:25 +00003876int sqlite3PagerIsMemdb(Pager *pPager){
3877 return MEMDB;
3878}
drh0f7eb612006-08-08 13:51:43 +00003879#endif
drhdd793422001-06-28 01:54:48 +00003880
drhfa86c412002-02-02 15:01:15 +00003881/*
drhac69b052004-05-12 13:30:07 +00003882** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003883**
3884** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003885** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003886** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003887*/
drh86f8c192007-08-22 00:39:19 +00003888static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003889 int rc;
drhac69b052004-05-12 13:30:07 +00003890 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00003891 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00003892 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00003893 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhda47d772002-12-02 04:25:19 +00003894 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003895 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003896 return SQLITE_OK;
3897 }
drhfa86c412002-02-02 15:01:15 +00003898 assert( pPager->journalOpen );
drhf5e7bb52008-02-18 14:47:33 +00003899 assert( pPager->pInStmt==0 );
3900 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00003901 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00003902 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00003903 return SQLITE_NOMEM;
3904 }
danielk197776572402004-06-25 02:38:54 +00003905 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003906 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003907 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003908 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003909 if( !pPager->stmtOpen ){
danielk1977b3175382008-10-17 18:51:52 +00003910 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
3911 sqlite3MemJournalOpen(pPager->stfd);
3912 }else{
3913 rc = sqlite3PagerOpentemp(pPager, pPager->stfd, SQLITE_OPEN_SUBJOURNAL);
3914 if( rc ){
3915 goto stmt_begin_failed;
3916 }
drh334b2992007-09-06 23:28:23 +00003917 }
drhac69b052004-05-12 13:30:07 +00003918 pPager->stmtOpen = 1;
3919 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003920 }
drhac69b052004-05-12 13:30:07 +00003921 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003922 return SQLITE_OK;
3923
drhac69b052004-05-12 13:30:07 +00003924stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00003925 if( pPager->pInStmt ){
3926 sqlite3BitvecDestroy(pPager->pInStmt);
3927 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003928 }
3929 return rc;
3930}
drh86f8c192007-08-22 00:39:19 +00003931int sqlite3PagerStmtBegin(Pager *pPager){
3932 int rc;
drh86f8c192007-08-22 00:39:19 +00003933 rc = pagerStmtBegin(pPager);
drh86f8c192007-08-22 00:39:19 +00003934 return rc;
3935}
drhfa86c412002-02-02 15:01:15 +00003936
3937/*
drhac69b052004-05-12 13:30:07 +00003938** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003939*/
danielk19773b8a05f2007-03-19 17:44:26 +00003940int sqlite3PagerStmtCommit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003941 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003942 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003943 sqlite3BitvecDestroy(pPager->pInStmt);
3944 pPager->pInStmt = 0;
drhac69b052004-05-12 13:30:07 +00003945 pPager->stmtNRec = 0;
3946 pPager->stmtInUse = 0;
danielk1977b3175382008-10-17 18:51:52 +00003947 if( sqlite3IsMemJournal(pPager->stfd) ){
3948 sqlite3OsTruncate(pPager->stfd, 0);
3949 }
drh663fc632002-02-02 18:49:19 +00003950 }
drhac69b052004-05-12 13:30:07 +00003951 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003952 return SQLITE_OK;
3953}
3954
3955/*
drhac69b052004-05-12 13:30:07 +00003956** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003957*/
danielk19773b8a05f2007-03-19 17:44:26 +00003958int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003959 int rc;
drhac69b052004-05-12 13:30:07 +00003960 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003961 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003962 rc = pager_stmt_playback(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003963 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00003964 }else{
3965 rc = SQLITE_OK;
3966 }
drhac69b052004-05-12 13:30:07 +00003967 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003968 return rc;
3969}
3970
drh73509ee2003-04-06 20:44:45 +00003971/*
3972** Return the full pathname of the database file.
3973*/
danielk19773b8a05f2007-03-19 17:44:26 +00003974const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003975 return pPager->zFilename;
3976}
3977
drhb20ea9d2004-02-09 01:20:36 +00003978/*
drhd0679ed2007-08-28 22:24:34 +00003979** Return the VFS structure for the pager.
3980*/
3981const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
3982 return pPager->pVfs;
3983}
3984
3985/*
drhcc6bb3e2007-08-31 16:11:35 +00003986** Return the file handle for the database file associated
3987** with the pager. This might return NULL if the file has
3988** not yet been opened.
3989*/
3990sqlite3_file *sqlite3PagerFile(Pager *pPager){
3991 return pPager->fd;
3992}
3993
3994/*
danielk19775865e3d2004-06-14 06:03:57 +00003995** Return the directory of the database file.
3996*/
danielk19773b8a05f2007-03-19 17:44:26 +00003997const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00003998 return pPager->zDirectory;
3999}
4000
4001/*
4002** Return the full pathname of the journal file.
4003*/
danielk19773b8a05f2007-03-19 17:44:26 +00004004const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004005 return pPager->zJournal;
4006}
4007
4008/*
drh2c8997b2005-08-27 16:36:48 +00004009** Return true if fsync() calls are disabled for this pager. Return FALSE
4010** if fsync()s are executed normally.
4011*/
danielk19773b8a05f2007-03-19 17:44:26 +00004012int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004013 return pPager->noSync;
4014}
4015
drh7c4ac0c2007-04-05 11:25:58 +00004016#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004017/*
drhb20ea9d2004-02-09 01:20:36 +00004018** Set the codec for this pager
4019*/
danielk19773b8a05f2007-03-19 17:44:26 +00004020void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004021 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004022 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004023 void *pCodecArg
4024){
4025 pPager->xCodec = xCodec;
4026 pPager->pCodecArg = pCodecArg;
4027}
drh7c4ac0c2007-04-05 11:25:58 +00004028#endif
drhb20ea9d2004-02-09 01:20:36 +00004029
danielk1977687566d2004-11-02 12:56:41 +00004030#ifndef SQLITE_OMIT_AUTOVACUUM
4031/*
danielk197787c29a92008-01-18 11:33:16 +00004032** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004033**
drh5e385312007-06-16 04:42:12 +00004034** There must be no references to the page previously located at
4035** pgno (which we call pPgOld) though that page is allowed to be
drhb3df2e12008-09-17 20:06:26 +00004036** in cache. If the page previously located at pgno is not already
drh5e385312007-06-16 04:42:12 +00004037** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004038**
drh5e385312007-06-16 04:42:12 +00004039** References to the page pPg remain valid. Updating any
4040** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004041** allocated along with the page) is the responsibility of the caller.
4042**
danielk19775fd057a2005-03-09 13:09:43 +00004043** A transaction must be active when this routine is called. It used to be
4044** required that a statement transaction was not active, but this restriction
4045** has been removed (CREATE INDEX needs to move a page when a statement
4046** transaction is active).
danielk19774c999992008-07-16 18:17:55 +00004047**
4048** If the fourth argument, isCommit, is non-zero, then this page is being
4049** moved as part of a database reorganization just before the transaction
4050** is being committed. In this case, it is guaranteed that the database page
4051** pPg refers to will not be written to again within this transaction.
danielk1977687566d2004-11-02 12:56:41 +00004052*/
danielk19774c999992008-07-16 18:17:55 +00004053int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
drh5e385312007-06-16 04:42:12 +00004054 PgHdr *pPgOld; /* The page being overwritten. */
danielk197794daf7f2004-11-08 09:26:09 +00004055 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004056
danielk1977687566d2004-11-02 12:56:41 +00004057 assert( pPg->nRef>0 );
4058
drh4f0c5872007-03-26 22:05:01 +00004059 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk19778c0a7912008-08-20 14:49:23 +00004060 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno);
drhb0603412007-02-28 04:47:26 +00004061 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004062
danielk1977b4626a32007-04-28 15:47:43 +00004063 pager_get_content(pPg);
danielk19774c999992008-07-16 18:17:55 +00004064
4065 /* If the journal needs to be sync()ed before page pPg->pgno can
4066 ** be written to, store pPg->pgno in local variable needSyncPgno.
4067 **
4068 ** If the isCommit flag is set, there is no need to remember that
4069 ** the journal needs to be sync()ed before database page pPg->pgno
4070 ** can be written to. The caller has already promised not to write to it.
4071 */
danielk19778c0a7912008-08-20 14:49:23 +00004072 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
danielk197794daf7f2004-11-08 09:26:09 +00004073 needSyncPgno = pPg->pgno;
danielk19778c0a7912008-08-20 14:49:23 +00004074 assert( (pPg->flags&PGHDR_IN_JOURNAL) || (int)pgno>pPager->origDbSize );
4075 assert( pPg->flags&PGHDR_DIRTY );
danielk1977ae825582004-11-23 09:06:55 +00004076 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004077 }
4078
danielk1977ef73ee92004-11-06 12:26:07 +00004079 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00004080 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00004081 ** page pgno before the 'move' operation, it needs to be retained
4082 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004083 */
danielk19778c0a7912008-08-20 14:49:23 +00004084 pPg->flags &= ~(PGHDR_NEED_SYNC|PGHDR_IN_JOURNAL);
danielk1977687566d2004-11-02 12:56:41 +00004085 pPgOld = pager_lookup(pPager, pgno);
danielk19778c0a7912008-08-20 14:49:23 +00004086 assert( !pPgOld || pPgOld->nRef==1 );
danielk1977687566d2004-11-02 12:56:41 +00004087 if( pPgOld ){
danielk19778c0a7912008-08-20 14:49:23 +00004088 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
drh5e385312007-06-16 04:42:12 +00004089 }
danielk19778c0a7912008-08-20 14:49:23 +00004090 if( sqlite3BitvecTest(pPager->pInJournal, pgno) ){
4091 pPg->flags |= PGHDR_IN_JOURNAL;
4092 }
danielk1977687566d2004-11-02 12:56:41 +00004093
danielk19778c0a7912008-08-20 14:49:23 +00004094 sqlite3PcacheMove(pPg, pgno);
4095 if( pPgOld ){
4096 sqlite3PcacheMove(pPgOld, 0);
4097 sqlite3PcacheRelease(pPgOld);
danielk1977f5fdda82004-11-03 08:44:05 +00004098 }
danielk1977f5fdda82004-11-03 08:44:05 +00004099
drh605ad8f2006-05-03 23:34:05 +00004100 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004101 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004102 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00004103
danielk197794daf7f2004-11-08 09:26:09 +00004104 if( needSyncPgno ){
4105 /* If needSyncPgno is non-zero, then the journal file needs to be
4106 ** sync()ed before any data is written to database file page needSyncPgno.
4107 ** Currently, no such page exists in the page-cache and the
danielk19774c999992008-07-16 18:17:55 +00004108 ** "is journaled" bitvec flag has been set. This needs to be remedied by
4109 ** loading the page into the pager-cache and setting the PgHdr.needSync
4110 ** flag.
danielk1977ae825582004-11-23 09:06:55 +00004111 **
danielk1977a98d7b42008-01-18 13:42:54 +00004112 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00004113 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00004114 ** array. Otherwise, if the page is loaded and written again in
4115 ** this transaction, it may be written to the database file before
4116 ** it is synced into the journal file. This way, it may end up in
4117 ** the journal file twice, but that is not a problem.
4118 **
danielk19773b8a05f2007-03-19 17:44:26 +00004119 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004120 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004121 */
4122 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004123 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004124 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004125 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00004126 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00004127 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
4128 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00004129 }
danielk197787c29a92008-01-18 11:33:16 +00004130 return rc;
4131 }
danielk1977ae825582004-11-23 09:06:55 +00004132 pPager->needSync = 1;
drhb3df2e12008-09-17 20:06:26 +00004133 assert( pPager->noSync==0 && !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00004134 pPgHdr->flags |= PGHDR_NEED_SYNC;
4135 pPgHdr->flags |= PGHDR_IN_JOURNAL;
danielk19773b8a05f2007-03-19 17:44:26 +00004136 makeDirty(pPgHdr);
4137 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004138 }
4139
danielk1977687566d2004-11-02 12:56:41 +00004140 return SQLITE_OK;
4141}
4142#endif
4143
danielk19773b8a05f2007-03-19 17:44:26 +00004144/*
4145** Return a pointer to the data for the specified page.
4146*/
4147void *sqlite3PagerGetData(DbPage *pPg){
danielk197771d5d2c2008-09-29 11:49:47 +00004148 assert( pPg->nRef>0 || pPg->pPager->memDb );
danielk19778c0a7912008-08-20 14:49:23 +00004149 return pPg->pData;
danielk19773b8a05f2007-03-19 17:44:26 +00004150}
4151
4152/*
4153** Return a pointer to the Pager.nExtra bytes of "extra" space
4154** allocated along with the specified page.
4155*/
4156void *sqlite3PagerGetExtra(DbPage *pPg){
4157 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00004158 return (pPager?pPg->pExtra:0);
danielk19773b8a05f2007-03-19 17:44:26 +00004159}
4160
danielk197741483462007-03-24 16:45:04 +00004161/*
4162** Get/set the locking-mode for this pager. Parameter eMode must be one
4163** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4164** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4165** the locking-mode is set to the value specified.
4166**
4167** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4168** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4169** locking-mode.
4170*/
4171int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004172 assert( eMode==PAGER_LOCKINGMODE_QUERY
4173 || eMode==PAGER_LOCKINGMODE_NORMAL
4174 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4175 assert( PAGER_LOCKINGMODE_QUERY<0 );
4176 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4177 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00004178 pPager->exclusiveMode = eMode;
4179 }
4180 return (int)pPager->exclusiveMode;
4181}
4182
drh3b020132008-04-17 17:02:01 +00004183/*
drh04335882008-09-26 21:08:08 +00004184** Get/set the journal-mode for this pager. Parameter eMode must be one of:
drh3b020132008-04-17 17:02:01 +00004185**
drh04335882008-09-26 21:08:08 +00004186** PAGER_JOURNALMODE_QUERY
4187** PAGER_JOURNALMODE_DELETE
4188** PAGER_JOURNALMODE_TRUNCATE
4189** PAGER_JOURNALMODE_PERSIST
4190** PAGER_JOURNALMODE_OFF
4191**
4192** If the parameter is not _QUERY, then the journal-mode is set to the
4193** value specified.
4194**
4195** The returned indicate the current (possibly updated)
drh3b020132008-04-17 17:02:01 +00004196** journal-mode.
4197*/
4198int sqlite3PagerJournalMode(Pager *pPager, int eMode){
danielk1977b3175382008-10-17 18:51:52 +00004199 if( !MEMDB ){
4200 assert( eMode==PAGER_JOURNALMODE_QUERY
4201 || eMode==PAGER_JOURNALMODE_DELETE
4202 || eMode==PAGER_JOURNALMODE_TRUNCATE
4203 || eMode==PAGER_JOURNALMODE_PERSIST
4204 || eMode==PAGER_JOURNALMODE_OFF
4205 || eMode==PAGER_JOURNALMODE_MEMORY );
4206 assert( PAGER_JOURNALMODE_QUERY<0 );
4207 if( eMode>=0 ){
4208 pPager->journalMode = eMode;
4209 }else{
4210 assert( eMode==PAGER_JOURNALMODE_QUERY );
4211 }
drh3b020132008-04-17 17:02:01 +00004212 }
drhfdc40e92008-04-17 20:59:37 +00004213 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00004214}
4215
danielk1977b53e4962008-06-04 06:45:59 +00004216/*
4217** Get/set the size-limit used for persistent journal files.
4218*/
4219i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
4220 if( iLimit>=-1 ){
4221 pPager->journalSizeLimit = iLimit;
4222 }
4223 return pPager->journalSizeLimit;
4224}
4225
drh2e66f0b2005-04-28 17:18:48 +00004226#endif /* SQLITE_OMIT_DISKIO */