blob: b17be5f2316034b273d7acc0320cf506daf5148a [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**
danielk1977bc2ca9e2008-11-13 14:28:28 +000021** @(#) $Id: pager.c,v 1.503 2008/11/13 14:28:29 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() */
drh98c58352008-11-07 00:24:53 +0000206 u32 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
danielk1977bc2ca9e2008-11-13 14:28:28 +0000315static int pageInJournal(PgHdr *pPg){
316 return sqlite3BitvecTest(pPg->pPager->pInJournal, pPg->pgno);
317}
318
drh8ca0c722006-05-07 17:49:38 +0000319/*
drh34e79ce2004-02-08 06:05:46 +0000320** Read a 32-bit integer from the given file descriptor. Store the integer
321** that is read in *pRes. Return SQLITE_OK if everything worked, or an
322** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000323**
324** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000325*/
danielk197762079062007-08-15 17:08:46 +0000326static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000327 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000328 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000329 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000330 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000331 }
drh94f33312002-08-12 12:29:56 +0000332 return rc;
333}
334
335/*
drh97b57482006-01-10 20:32:32 +0000336** Write a 32-bit integer into a string buffer in big-endian byte order.
337*/
drha3152892007-05-05 11:48:52 +0000338#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000339
340/*
drh34e79ce2004-02-08 06:05:46 +0000341** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
342** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000343*/
danielk197762079062007-08-15 17:08:46 +0000344static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000345 char ac[4];
drh97b57482006-01-10 20:32:32 +0000346 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000347 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000348}
349
drh2554f8b2003-01-22 01:26:44 +0000350/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000351** If file pFd is open, call sqlite3OsUnlock() on it.
352*/
353static int osUnlock(sqlite3_file *pFd, int eLock){
354 if( !pFd->pMethods ){
355 return SQLITE_OK;
356 }
357 return sqlite3OsUnlock(pFd, eLock);
358}
359
360/*
danielk1977c7b60172007-08-22 11:22:03 +0000361** This function determines whether or not the atomic-write optimization
362** can be used with this pager. The optimization can be used if:
363**
364** (a) the value returned by OsDeviceCharacteristics() indicates that
365** a database page may be written atomically, and
366** (b) the value returned by OsSectorSize() is less than or equal
367** to the page size.
368**
369** If the optimization cannot be used, 0 is returned. If it can be used,
370** then the value returned is the size of the journal file when it
371** contains rollback data for exactly one page.
372*/
373#ifdef SQLITE_ENABLE_ATOMIC_WRITE
374static int jrnlBufferSize(Pager *pPager){
375 int dc; /* Device characteristics */
376 int nSector; /* Sector size */
drhfacf0302008-06-17 15:12:00 +0000377 int szPage; /* Page size */
danielk1977c7b60172007-08-22 11:22:03 +0000378 sqlite3_file *fd = pPager->fd;
379
380 if( fd->pMethods ){
381 dc = sqlite3OsDeviceCharacteristics(fd);
382 nSector = sqlite3OsSectorSize(fd);
drhfacf0302008-06-17 15:12:00 +0000383 szPage = pPager->pageSize;
danielk1977c7b60172007-08-22 11:22:03 +0000384 }
385
386 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
387 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
388
drhfacf0302008-06-17 15:12:00 +0000389 if( !fd->pMethods ||
390 (dc & (SQLITE_IOCAP_ATOMIC|(szPage>>8)) && nSector<=szPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000391 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
392 }
393 return 0;
394}
395#endif
396
397/*
danielk1977aef0bf62005-12-30 16:28:01 +0000398** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000399** code. The first argument is a pointer to the pager structure, the
400** second the error-code about to be returned by a pager API function.
401** The value returned is a copy of the second argument to this function.
402**
drh4f0ee682007-03-30 20:43:40 +0000403** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000404** the error becomes persistent. Until the persisten error is cleared,
405** subsequent API calls on this Pager will immediately return the same
406** error code.
407**
408** A persistent error indicates that the contents of the pager-cache
409** cannot be trusted. This state can be cleared by completely discarding
410** the contents of the pager-cache. If a transaction was active when
411** the persistent error occured, then the rollback journal may need
412** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000413*/
danielk1977ae72d982007-10-03 08:46:44 +0000414static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000415static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000416 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000417 assert(
418 pPager->errCode==SQLITE_FULL ||
419 pPager->errCode==SQLITE_OK ||
420 (pPager->errCode & 0xff)==SQLITE_IOERR
421 );
danielk1977979f38e2007-03-27 16:19:51 +0000422 if(
drh4ac285a2006-09-15 07:28:50 +0000423 rc2==SQLITE_FULL ||
424 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000425 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000426 ){
427 pPager->errCode = rc;
danielk19778c0a7912008-08-20 14:49:23 +0000428 if( pPager->state==PAGER_UNLOCK
429 && sqlite3PcacheRefCount(pPager->pPCache)==0
430 ){
danielk1977ae72d982007-10-03 08:46:44 +0000431 /* If the pager is already unlocked, call pager_unlock() now to
432 ** clear the error state and ensure that the pager-cache is
433 ** completely empty.
434 */
435 pager_unlock(pPager);
436 }
danielk1977aef0bf62005-12-30 16:28:01 +0000437 }
438 return rc;
439}
440
drh477731b2007-06-16 03:06:27 +0000441/*
442** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
443** on the cache using a hash function. This is used for testing
444** and debugging only.
445*/
danielk19773c407372005-02-15 02:54:14 +0000446#ifdef SQLITE_CHECK_PAGES
447/*
448** Return a 32-bit hash of the page data for pPage.
449*/
drh477731b2007-06-16 03:06:27 +0000450static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000451 u32 hash = 0;
452 int i;
drh477731b2007-06-16 03:06:27 +0000453 for(i=0; i<nByte; i++){
454 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000455 }
456 return hash;
457}
drh477731b2007-06-16 03:06:27 +0000458static u32 pager_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000459 return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
460}
danielk1977bc2ca9e2008-11-13 14:28:28 +0000461static void pager_set_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000462 pPage->pageHash = pager_pagehash(pPage);
drh477731b2007-06-16 03:06:27 +0000463}
danielk19773c407372005-02-15 02:54:14 +0000464
465/*
466** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
467** is defined, and NDEBUG is not defined, an assert() statement checks
468** that the page is either dirty or still matches the calculated page-hash.
469*/
470#define CHECK_PAGE(x) checkPage(x)
471static void checkPage(PgHdr *pPg){
472 Pager *pPager = pPg->pPager;
danielk1977b3175382008-10-17 18:51:52 +0000473 assert( !pPg->pageHash || pPager->errCode
danielk19778c0a7912008-08-20 14:49:23 +0000474 || (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
danielk19773c407372005-02-15 02:54:14 +0000475}
476
477#else
drh8ffa8172007-06-18 17:25:17 +0000478#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000479#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000480#define CHECK_PAGE(x)
drh41d30272008-08-20 21:47:45 +0000481#endif /* SQLITE_CHECK_PAGES */
danielk19773c407372005-02-15 02:54:14 +0000482
drhed7c8552001-04-11 14:29:21 +0000483/*
danielk197776572402004-06-25 02:38:54 +0000484** When this is called the journal file for pager pPager must be open.
485** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000486** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000487**
danielk197765839c62007-08-30 08:08:17 +0000488** zMaster must point to a buffer of at least nMaster bytes allocated by
489** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
490** enough space to write the master journal name). If the master journal
491** name in the journal is longer than nMaster bytes (including a
492** nul-terminator), then this is handled as if no master journal name
493** were present in the journal.
494**
495** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000496** SQLITE_OK returned.
497*/
danielk197765839c62007-08-30 08:08:17 +0000498static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000499 int rc;
500 u32 len;
drheb206252004-10-01 02:00:31 +0000501 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000502 u32 cksum;
shane0b8d2762008-07-22 05:18:00 +0000503 u32 u; /* Unsigned loop counter */
danielk197776572402004-06-25 02:38:54 +0000504 unsigned char aMagic[8]; /* A buffer to hold the magic header */
505
danielk197765839c62007-08-30 08:08:17 +0000506 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000507
drh054889e2005-11-30 03:20:31 +0000508 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000509 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000510
danielk197762079062007-08-15 17:08:46 +0000511 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000512 if( rc!=SQLITE_OK ) return rc;
513
danielk197765839c62007-08-30 08:08:17 +0000514 if( len>=nMaster ){
515 return SQLITE_OK;
516 }
517
danielk197762079062007-08-15 17:08:46 +0000518 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000519 if( rc!=SQLITE_OK ) return rc;
520
danielk197762079062007-08-15 17:08:46 +0000521 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000522 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
523
danielk197765839c62007-08-30 08:08:17 +0000524 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000525 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000526 return rc;
527 }
danielk197765839c62007-08-30 08:08:17 +0000528 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000529
530 /* See if the checksum matches the master journal name */
shane0b8d2762008-07-22 05:18:00 +0000531 for(u=0; u<len; u++){
532 cksum -= zMaster[u];
danielk197765839c62007-08-30 08:08:17 +0000533 }
danielk19778191bff2004-06-28 04:52:30 +0000534 if( cksum ){
535 /* If the checksum doesn't add up, then one or more of the disk sectors
536 ** containing the master journal filename is corrupted. This means
537 ** definitely roll back, so just return SQLITE_OK and report a (nul)
538 ** master-journal filename.
539 */
danielk197765839c62007-08-30 08:08:17 +0000540 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000541 }
danielk197776572402004-06-25 02:38:54 +0000542
543 return SQLITE_OK;
544}
545
546/*
547** Seek the journal file descriptor to the next sector boundary where a
548** journal header may be read or written. Pager.journalOff is updated with
549** the new seek offset.
550**
551** i.e for a sector size of 512:
552**
553** Input Offset Output Offset
554** ---------------------------------------
555** 0 0
556** 512 512
557** 100 512
558** 2000 2048
559**
560*/
danielk197762079062007-08-15 17:08:46 +0000561static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000562 i64 offset = 0;
563 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000564 if( c ){
565 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
566 }
567 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
568 assert( offset>=c );
569 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
570 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000571}
572
573/*
drhf3a87622008-04-17 14:16:42 +0000574** Write zeros over the header of the journal file. This has the
575** effect of invalidating the journal file and committing the
576** transaction.
577*/
danielk1977df2566a2008-05-07 19:11:03 +0000578static int zeroJournalHdr(Pager *pPager, int doTruncate){
579 int rc = SQLITE_OK;
danielk197755a25a12008-09-11 10:29:15 +0000580 static const char zeroHdr[28] = {0};
drhf3a87622008-04-17 14:16:42 +0000581
danielk1977df2566a2008-05-07 19:11:03 +0000582 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000583 i64 iLimit = pPager->journalSizeLimit;
584
danielk1977df2566a2008-05-07 19:11:03 +0000585 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000586 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000587 rc = sqlite3OsTruncate(pPager->jfd, 0);
588 }else{
589 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
590 }
danielk197781620542008-06-07 05:19:37 +0000591 if( rc==SQLITE_OK && !pPager->noSync ){
danielk1977df2566a2008-05-07 19:11:03 +0000592 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
593 }
danielk1977b53e4962008-06-04 06:45:59 +0000594
595 /* At this point the transaction is committed but the write lock
596 ** is still held on the file. If there is a size limit configured for
597 ** the persistent journal and the journal file currently consumes more
598 ** space than that limit allows for, truncate it now. There is no need
599 ** to sync the file following this operation.
600 */
601 if( rc==SQLITE_OK && iLimit>0 ){
602 i64 sz;
603 rc = sqlite3OsFileSize(pPager->jfd, &sz);
604 if( rc==SQLITE_OK && sz>iLimit ){
605 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
606 }
607 }
drha06ecba2008-04-22 17:15:17 +0000608 }
drhf3a87622008-04-17 14:16:42 +0000609 return rc;
610}
611
612/*
danielk197776572402004-06-25 02:38:54 +0000613** The journal file must be open when this routine is called. A journal
614** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
615** current location.
616**
617** The format for the journal header is as follows:
618** - 8 bytes: Magic identifying journal format.
619** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
620** - 4 bytes: Random number used for page hash.
621** - 4 bytes: Initial database page count.
622** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000623** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000624**
danielk197767c007b2008-03-20 04:45:49 +0000625** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000626*/
627static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000628 int rc = SQLITE_OK;
629 char *zHeader = pPager->pTmpSpace;
630 int nHeader = pPager->pageSize;
631 int nWrite;
632
633 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
634 nHeader = JOURNAL_HDR_SZ(pPager);
635 }
danielk197776572402004-06-25 02:38:54 +0000636
danielk19774099f6e2007-03-19 11:25:20 +0000637 if( pPager->stmtHdrOff==0 ){
638 pPager->stmtHdrOff = pPager->journalOff;
639 }
640
danielk197762079062007-08-15 17:08:46 +0000641 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000642 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000643
drh97b57482006-01-10 20:32:32 +0000644 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +0000645
646 /*
647 ** Write the nRec Field - the number of page records that follow this
648 ** journal header. Normally, zero is written to this value at this time.
649 ** After the records are added to the journal (and the journal synced,
650 ** if in full-sync mode), the zero is overwritten with the true number
651 ** of records (see syncJournal()).
652 **
653 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
654 ** reading the journal this value tells SQLite to assume that the
655 ** rest of the journal file contains valid page records. This assumption
656 ** is dangerous, as if a failure occured whilst writing to the journal
657 ** file it may contain some garbage data. There are two scenarios
658 ** where this risk can be ignored:
659 **
660 ** * When the pager is in no-sync mode. Corruption can follow a
661 ** power failure in this case anyway.
662 **
663 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
664 ** that garbage data is never appended to the journal file.
665 */
666 assert(pPager->fd->pMethods||pPager->noSync);
danielk1977b3175382008-10-17 18:51:52 +0000667 if( (pPager->noSync) || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY)
danielk19774cd2cd52007-08-23 14:48:23 +0000668 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
669 ){
670 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
671 }else{
672 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
673 }
674
drh97b57482006-01-10 20:32:32 +0000675 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +0000676 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +0000677 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
678 /* The initial database size */
679 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
680 /* The assumed sector size for this process */
681 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +0000682 if( pPager->journalHdr==0 ){
683 /* The page size */
684 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
685 }
danielk197776572402004-06-25 02:38:54 +0000686
danielk1977a664f8e2008-04-22 14:31:48 +0000687 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
688 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
689 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
690 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +0000691 }
danielk1977a664f8e2008-04-22 14:31:48 +0000692
danielk197776572402004-06-25 02:38:54 +0000693 return rc;
694}
695
696/*
697** The journal file must be open when this is called. A journal header file
698** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
699** file. See comments above function writeJournalHdr() for a description of
700** the journal header format.
701**
702** If the header is read successfully, *nRec is set to the number of
703** page records following this header and *dbSize is set to the size of the
704** database before the transaction began, in pages. Also, pPager->cksumInit
705** is set to the value read from the journal header. SQLITE_OK is returned
706** in this case.
707**
708** If the journal header file appears to be corrupted, SQLITE_DONE is
709** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
710** cannot be read from the journal file an error code is returned.
711*/
712static int readJournalHdr(
713 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000714 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000715 u32 *pNRec,
716 u32 *pDbSize
717){
718 int rc;
719 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000720 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +0000721 int iPageSize;
danielk197776572402004-06-25 02:38:54 +0000722
danielk197762079062007-08-15 17:08:46 +0000723 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000724 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
725 return SQLITE_DONE;
726 }
danielk197762079062007-08-15 17:08:46 +0000727 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000728
danielk197762079062007-08-15 17:08:46 +0000729 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000730 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000731 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000732
733 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
734 return SQLITE_DONE;
735 }
736
danielk197762079062007-08-15 17:08:46 +0000737 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000738 if( rc ) return rc;
739
danielk197762079062007-08-15 17:08:46 +0000740 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000741 if( rc ) return rc;
742
danielk197762079062007-08-15 17:08:46 +0000743 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000744 if( rc ) return rc;
745
danielk197767c007b2008-03-20 04:45:49 +0000746 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
747 if( rc==SQLITE_OK
748 && iPageSize>=512
749 && iPageSize<=SQLITE_MAX_PAGE_SIZE
750 && ((iPageSize-1)&iPageSize)==0
751 ){
752 u16 pagesize = iPageSize;
753 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
754 }
755 if( rc ) return rc;
756
danielk197776572402004-06-25 02:38:54 +0000757 /* Update the assumed sector-size to match the value used by
758 ** the process that created this journal. If this journal was
759 ** created by a process other than this one, then this routine
760 ** is being called from within pager_playback(). The local value
761 ** of Pager.sectorSize is restored at the end of that routine.
762 */
drh98c58352008-11-07 00:24:53 +0000763 rc = read32bits(pPager->jfd, jrnlOff+12, &pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000764 if( rc ) return rc;
drh98c58352008-11-07 00:24:53 +0000765 if( (pPager->sectorSize & (pPager->sectorSize-1))!=0
766 || pPager->sectorSize>0x1000000 ){
767 return SQLITE_DONE;
768 }
danielk197776572402004-06-25 02:38:54 +0000769
770 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +0000771 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000772}
773
774
775/*
776** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000777** pPager at the current location. The master journal name must be the last
778** thing written to a journal file. If the pager is in full-sync mode, the
779** journal file descriptor is advanced to the next sector boundary before
780** anything is written. The format is:
781**
782** + 4 bytes: PAGER_MJ_PGNO.
783** + N bytes: length of master journal name.
784** + 4 bytes: N
785** + 4 bytes: Master journal name checksum.
786** + 8 bytes: aJournalMagic[].
787**
788** The master journal page checksum is the sum of the bytes in the master
789** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000790**
791** If zMaster is a NULL pointer (occurs for a single database transaction),
792** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000793*/
794static int writeMasterJournal(Pager *pPager, const char *zMaster){
795 int rc;
796 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000797 int i;
danielk197762079062007-08-15 17:08:46 +0000798 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +0000799 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +0000800 u32 cksum = 0;
801 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000802
danielk1977b3175382008-10-17 18:51:52 +0000803 if( !zMaster || pPager->setMaster ) return SQLITE_OK;
804 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ) return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000805 pPager->setMaster = 1;
806
807 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000808 for(i=0; i<len; i++){
809 cksum += zMaster[i];
810 }
danielk197776572402004-06-25 02:38:54 +0000811
812 /* If in full-sync mode, advance to the next disk sector before writing
813 ** the master journal name. This is in case the previous page written to
814 ** the journal has already been synced.
815 */
816 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000817 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000818 }
danielk197762079062007-08-15 17:08:46 +0000819 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000820 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000821
danielk197762079062007-08-15 17:08:46 +0000822 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000823 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000824 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000825
danielk197762079062007-08-15 17:08:46 +0000826 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000827 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000828 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000829
drh97b57482006-01-10 20:32:32 +0000830 put32bits(zBuf, len);
831 put32bits(&zBuf[4], cksum);
832 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000833 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +0000834 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +0000835 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +0000836
837 /* If the pager is in peristent-journal mode, then the physical
838 ** journal-file may extend past the end of the master-journal name
839 ** and 8 bytes of magic data just written to the file. This is
840 ** dangerous because the code to rollback a hot-journal file
841 ** will not be able to find the master-journal name to determine
842 ** whether or not the journal is hot.
843 **
844 ** Easiest thing to do in this scenario is to truncate the journal
845 ** file to the required size.
846 */
847 if( (rc==SQLITE_OK)
848 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
849 && jrnlSize>jrnlOff
850 ){
851 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
852 }
danielk197776572402004-06-25 02:38:54 +0000853 return rc;
854}
855
856/*
drhed7c8552001-04-11 14:29:21 +0000857** Find a page in the hash table given its page number. Return
858** a pointer to the page or NULL if not found.
859*/
drhd9b02572001-04-15 00:37:09 +0000860static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000861 PgHdr *p;
danielk19778c0a7912008-08-20 14:49:23 +0000862 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &p);
drhed7c8552001-04-11 14:29:21 +0000863 return p;
864}
865
866/*
danielk1977e180dd92007-04-05 17:15:52 +0000867** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000868** sets the state of the pager back to what it was when it was first
869** opened. Any outstanding pages are invalidated and subsequent attempts
870** to access those pages will likely result in a coredump.
871*/
drhd9b02572001-04-15 00:37:09 +0000872static void pager_reset(Pager *pPager){
danielk1977efaaf572006-01-16 11:29:19 +0000873 if( pPager->errCode ) return;
danielk19778c0a7912008-08-20 14:49:23 +0000874 sqlite3PcacheClear(pPager->pPCache);
danielk1977e277be02007-03-23 18:12:06 +0000875}
876
877/*
danielk1977ae72d982007-10-03 08:46:44 +0000878** Unlock the database file.
879**
880** If the pager is currently in error state, discard the contents of
881** the cache and reset the Pager structure internal state. If there is
882** an open journal-file, then the next time a shared-lock is obtained
883** on the pager file (by this or any other process), it will be
884** treated as a hot-journal and rolled back.
885*/
886static void pager_unlock(Pager *pPager){
887 if( !pPager->exclusiveMode ){
danielk1977b3175382008-10-17 18:51:52 +0000888 int rc = osUnlock(pPager->fd, NO_LOCK);
889 if( rc ) pPager->errCode = rc;
890 pPager->dbSize = -1;
891 IOTRACE(("UNLOCK %p\n", pPager))
danielk1977ae72d982007-10-03 08:46:44 +0000892
danielk1977b3175382008-10-17 18:51:52 +0000893 /* Always close the journal file when dropping the database lock.
894 ** Otherwise, another connection with journal_mode=delete might
895 ** delete the file out from under us.
896 */
897 if( pPager->journalOpen ){
898 sqlite3OsClose(pPager->jfd);
899 pPager->journalOpen = 0;
900 sqlite3BitvecDestroy(pPager->pInJournal);
901 pPager->pInJournal = 0;
902 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
903 pPager->pAlwaysRollback = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000904 }
905
danielk1977b3175382008-10-17 18:51:52 +0000906 /* If Pager.errCode is set, the contents of the pager cache cannot be
907 ** trusted. Now that the pager file is unlocked, the contents of the
908 ** cache can be discarded and the error code safely cleared.
909 */
910 if( pPager->errCode ){
911 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
912 pager_reset(pPager);
913 if( pPager->stmtOpen ){
914 sqlite3OsClose(pPager->stfd);
915 sqlite3BitvecDestroy(pPager->pInStmt);
916 pPager->pInStmt = 0;
917 }
918 pPager->stmtOpen = 0;
919 pPager->stmtInUse = 0;
920 pPager->journalOff = 0;
921 pPager->journalStarted = 0;
922 pPager->stmtAutoopen = 0;
923 pPager->origDbSize = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000924 }
danielk1977b3175382008-10-17 18:51:52 +0000925
926 pPager->state = PAGER_UNLOCK;
927 pPager->changeCountDone = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000928 }
929}
930
931/*
932** Execute a rollback if a transaction is active and unlock the
933** database file. If the pager has already entered the error state,
934** do not attempt the rollback.
935*/
936static void pagerUnlockAndRollback(Pager *p){
danielk1977ae72d982007-10-03 08:46:44 +0000937 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
danielk19772d1d86f2008-06-20 14:59:51 +0000938 sqlite3BeginBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000939 sqlite3PagerRollback(p);
danielk19772d1d86f2008-06-20 14:59:51 +0000940 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000941 }
942 pager_unlock(p);
danielk1977ae72d982007-10-03 08:46:44 +0000943}
944
945/*
drh80e35f42007-03-30 14:06:34 +0000946** This routine ends a transaction. A transaction is ended by either
947** a COMMIT or a ROLLBACK.
948**
drhed7c8552001-04-11 14:29:21 +0000949** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +0000950** a RESERVED or EXCLUSIVE lock on the database. This routine will release
951** the database lock and acquires a SHARED lock in its place if that is
952** the appropriate thing to do. Release locks usually is appropriate,
953** unless we are in exclusive access mode or unless this is a
954** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
955**
956** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +0000957**
958** TODO: Consider keeping the journal file open for temporary databases.
959** This might give a performance improvement on windows where opening
960** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000961*/
danielk1977df2566a2008-05-07 19:11:03 +0000962static int pager_end_transaction(Pager *pPager, int hasMaster){
danielk197741483462007-03-24 16:45:04 +0000963 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +0000964 int rc2 = SQLITE_OK;
drha6abd042004-06-09 17:37:22 +0000965 if( pPager->state<PAGER_RESERVED ){
966 return SQLITE_OK;
967 }
danielk19773b8a05f2007-03-19 17:44:26 +0000968 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +0000969 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +0000970 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +0000971 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000972 }
drhda47d772002-12-02 04:25:19 +0000973 if( pPager->journalOpen ){
danielk1977b3175382008-10-17 18:51:52 +0000974 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
975 int isMemoryJournal = sqlite3IsMemJournal(pPager->jfd);
976 sqlite3OsClose(pPager->jfd);
977 pPager->journalOpen = 0;
978 if( !isMemoryJournal ){
979 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
980 }
981 }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE
drh04335882008-09-26 21:08:08 +0000982 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){
983 pPager->journalOff = 0;
984 pPager->journalStarted = 0;
985 }else if( pPager->exclusiveMode
danielk197793f7af92008-05-09 16:57:50 +0000986 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
987 ){
988 rc = zeroJournalHdr(pPager, hasMaster);
989 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +0000990 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +0000991 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +0000992 }else{
drh04335882008-09-26 21:08:08 +0000993 assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE || rc );
danielk1977b4b47412007-08-17 15:53:36 +0000994 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +0000995 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +0000996 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +0000997 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +0000998 }
danielk197741483462007-03-24 16:45:04 +0000999 }
drhf5e7bb52008-02-18 14:47:33 +00001000 sqlite3BitvecDestroy(pPager->pInJournal);
1001 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +00001002 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
1003 pPager->pAlwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001004#ifdef SQLITE_CHECK_PAGES
danielk1977bc2ca9e2008-11-13 14:28:28 +00001005 sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash);
danielk19773c407372005-02-15 02:54:14 +00001006#endif
danielk1977bc2ca9e2008-11-13 14:28:28 +00001007 sqlite3PcacheCleanAll(pPager->pPCache);
danielk1977ef317ab2004-06-23 10:43:10 +00001008 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001009 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001010 }else{
drhf5e7bb52008-02-18 14:47:33 +00001011 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001012 }
danielk1977979f38e2007-03-27 16:19:51 +00001013
danielk197741483462007-03-24 16:45:04 +00001014 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001015 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001016 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001017 }else if( pPager->state==PAGER_SYNCED ){
1018 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001019 }
danielk1977334cdb62007-03-26 08:05:12 +00001020 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001021 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001022 pPager->needSync = 0;
danielk19778c0a7912008-08-20 14:49:23 +00001023 /* lruListSetFirstSynced(pPager); */
danielk1977b3175382008-10-17 18:51:52 +00001024 if( !MEMDB ){
1025 pPager->dbSize = -1;
1026 }
drhd138c012008-05-13 00:58:18 +00001027 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001028
1029 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001030}
1031
drhed7c8552001-04-11 14:29:21 +00001032/*
drh968af522003-02-11 14:55:40 +00001033** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001034**
1035** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001036** random initial value and the page number. We experimented with
1037** a checksum of the entire data, but that was found to be too slow.
1038**
1039** Note that the page number is stored at the beginning of data and
1040** the checksum is stored at the end. This is important. If journal
1041** corruption occurs due to a power failure, the most likely scenario
1042** is that one end or the other of the record will be changed. It is
1043** much less likely that the two ends of the journal record will be
1044** correct and the middle be corrupt. Thus, this "checksum" scheme,
1045** though fast and simple, catches the mostly likely kind of corruption.
1046**
1047** FIX ME: Consider adding every 200th (or so) byte of the data to the
1048** checksum. That way if a single page spans 3 or more disk sectors and
1049** only the middle sector is corrupt, we will still have a reasonable
1050** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001051*/
drh74161702006-02-24 02:53:49 +00001052static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001053 u32 cksum = pPager->cksumInit;
1054 int i = pPager->pageSize-200;
1055 while( i>0 ){
1056 cksum += aData[i];
1057 i -= 200;
1058 }
drh968af522003-02-11 14:55:40 +00001059 return cksum;
1060}
1061
drh605ad8f2006-05-03 23:34:05 +00001062/* Forward declaration */
1063static void makeClean(PgHdr*);
1064
drh968af522003-02-11 14:55:40 +00001065/*
drhfa86c412002-02-02 15:01:15 +00001066** Read a single page from the journal file opened on file descriptor
1067** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001068**
drhc13148f2008-08-27 18:03:20 +00001069** The isMainJrnl flag is true if this is the main rollback journal and
1070** false for the statement journal. The main rollback journal uses
1071** checksums - the statement journal does not.
drhfa86c412002-02-02 15:01:15 +00001072*/
danielk197762079062007-08-15 17:08:46 +00001073static int pager_playback_one_page(
drhc13148f2008-08-27 18:03:20 +00001074 Pager *pPager, /* The pager being played back */
1075 sqlite3_file *jfd, /* The file that is the journal being rolled back */
1076 i64 offset, /* Offset of the page within the journal */
1077 int isMainJrnl /* True for main rollback journal. False for Stmt jrnl */
danielk197762079062007-08-15 17:08:46 +00001078){
drhfa86c412002-02-02 15:01:15 +00001079 int rc;
drhae2b40c2004-06-09 19:03:54 +00001080 PgHdr *pPg; /* An existing page in the cache */
1081 Pgno pgno; /* The page number of a page in journal */
1082 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001083 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001084
drhc13148f2008-08-27 18:03:20 +00001085 /* isMainJrnl should be true for the main journal and false for
drh96362842005-03-20 22:47:56 +00001086 ** statement journals. Verify that this is always the case
1087 */
drhc13148f2008-08-27 18:03:20 +00001088 assert( jfd == (isMainJrnl ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001089 assert( aData );
drh96362842005-03-20 22:47:56 +00001090
danielk197762079062007-08-15 17:08:46 +00001091 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001092 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001093 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001094 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001095 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001096
drh968af522003-02-11 14:55:40 +00001097 /* Sanity checking on the page. This is more important that I originally
1098 ** thought. If a power failure occurs while the journal is being written,
1099 ** it could cause invalid data to be written into the journal. We need to
1100 ** detect this invalid data (with high probability) and ignore it.
1101 */
danielk197775edc162004-06-26 01:48:18 +00001102 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001103 return SQLITE_DONE;
1104 }
drhae2b40c2004-06-09 19:03:54 +00001105 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001106 return SQLITE_OK;
1107 }
drhc13148f2008-08-27 18:03:20 +00001108 if( isMainJrnl ){
danielk197762079062007-08-15 17:08:46 +00001109 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001110 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001111 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001112 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001113 return SQLITE_DONE;
1114 }
1115 }
drhfa86c412002-02-02 15:01:15 +00001116
danielk1977aa5ccdf2004-06-14 05:10:42 +00001117 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001118
1119 /* If the pager is in RESERVED state, then there must be a copy of this
1120 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001121 ** not the database file. The page is left marked dirty in this case.
1122 **
danielk19772df71c72007-05-24 07:22:42 +00001123 ** An exception to the above rule: If the database is in no-sync mode
1124 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001125 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1126 ** during a Movepage() call, then the page may not be in the cache
1127 ** either. So the condition described in the above paragraph is not
1128 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001129 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001130 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1131 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001132 **
1133 ** Ticket #1171: The statement journal might contain page content that is
1134 ** different from the page content at the start of the transaction.
1135 ** This occurs when a page is changed prior to the start of a statement
1136 ** then changed again within the statement. When rolling back such a
1137 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001138 ** for certain that original page contents are synced into the main rollback
1139 ** journal. Otherwise, a power loss might leave modified data in the
1140 ** database file without an entry in the rollback journal that can
1141 ** restore the database to its original form. Two conditions must be
1142 ** met before writing to the database files. (1) the database must be
1143 ** locked. (2) we know that the original page content is fully synced
1144 ** in the main journal either because the page is not in cache or else
1145 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001146 **
1147 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1148 ** is possible to fail a statement on a database that does not yet exist.
1149 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001150 */
drhae2b40c2004-06-09 19:03:54 +00001151 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001152 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1153 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
danielk19778c0a7912008-08-20 14:49:23 +00001154 if( (pPager->state>=PAGER_EXCLUSIVE)
1155 && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC))
1156 && (pPager->fd->pMethods)
1157 ){
drh281b21d2008-08-22 12:57:08 +00001158 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
1159 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst);
danielk1977a3f3a5f2004-06-10 04:32:16 +00001160 }
drhfa86c412002-02-02 15:01:15 +00001161 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001162 /* No page should ever be explicitly rolled back that is in use, except
1163 ** for page 1 which is held in use in order to keep the lock on the
1164 ** database active. However such a page may be rolled back as a result
1165 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001166 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001167 */
drhb6f41482004-05-14 01:58:11 +00001168 void *pData;
danielk19778c0a7912008-08-20 14:49:23 +00001169 pData = pPg->pData;
drhae2b40c2004-06-09 19:03:54 +00001170 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001171 if( pPager->xReiniter ){
danielk1977eaa06f62008-09-18 17:34:44 +00001172 pPager->xReiniter(pPg);
drhde647132004-05-07 17:57:49 +00001173 }
drhc13148f2008-08-27 18:03:20 +00001174 if( isMainJrnl ) makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00001175#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001176 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001177#endif
drh86a88112007-04-16 15:02:19 +00001178 /* If this was page 1, then restore the value of Pager.dbFileVers.
1179 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001180 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001181 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001182 }
drh86a88112007-04-16 15:02:19 +00001183
1184 /* Decode the page just read from disk */
1185 CODEC1(pPager, pData, pPg->pgno, 3);
danielk19778c0a7912008-08-20 14:49:23 +00001186 sqlite3PcacheRelease(pPg);
drhfa86c412002-02-02 15:01:15 +00001187 }
1188 return rc;
1189}
1190
1191/*
danielk197713adf8a2004-06-03 16:08:41 +00001192** Parameter zMaster is the name of a master journal file. A single journal
1193** file that referred to the master journal file has just been rolled back.
1194** This routine checks if it is possible to delete the master journal file,
1195** and does so if it is.
drh726de592004-06-10 23:35:50 +00001196**
danielk197765839c62007-08-30 08:08:17 +00001197** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1198** available for use within this function.
1199**
1200**
drh726de592004-06-10 23:35:50 +00001201** The master journal file contains the names of all child journals.
1202** To tell if a master journal can be deleted, check to each of the
1203** children. If all children are either missing or do not refer to
1204** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001205*/
danielk1977b4b47412007-08-17 15:53:36 +00001206static int pager_delmaster(Pager *pPager, const char *zMaster){
1207 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001208 int rc;
1209 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001210 sqlite3_file *pMaster;
1211 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001212 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001213 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001214
1215 /* Open the master journal file exclusively in case some other process
1216 ** is running this routine also. Not that it makes too much difference.
1217 */
drhe5ae5732008-06-15 02:51:47 +00001218 pMaster = (sqlite3_file *)sqlite3Malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001219 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001220 if( !pMaster ){
1221 rc = SQLITE_NOMEM;
1222 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001223 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1224 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001225 }
danielk197713adf8a2004-06-03 16:08:41 +00001226 if( rc!=SQLITE_OK ) goto delmaster_out;
1227 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001228
1229 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001230 if( rc!=SQLITE_OK ) goto delmaster_out;
1231
1232 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001233 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001234 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001235 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001236
1237 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001238 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001239 */
drhe5ae5732008-06-15 02:51:47 +00001240 zMasterJournal = (char *)sqlite3Malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001241 if( !zMasterJournal ){
1242 rc = SQLITE_NOMEM;
1243 goto delmaster_out;
1244 }
danielk197765839c62007-08-30 08:08:17 +00001245 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001246 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001247 if( rc!=SQLITE_OK ) goto delmaster_out;
1248
danielk19775865e3d2004-06-14 06:03:57 +00001249 zJournal = zMasterJournal;
1250 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977861f7452008-06-05 11:39:11 +00001251 int exists;
1252 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
1253 if( rc!=SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001254 goto delmaster_out;
1255 }
danielk1977861f7452008-06-05 11:39:11 +00001256 if( exists ){
danielk197713adf8a2004-06-03 16:08:41 +00001257 /* One of the journals pointed to by the master journal exists.
1258 ** Open it and check if it points at the master journal. If
1259 ** so, return without deleting the master journal file.
1260 */
drh3b7b78b2004-11-24 01:16:43 +00001261 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001262 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1263 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001264 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001265 goto delmaster_out;
1266 }
danielk197713adf8a2004-06-03 16:08:41 +00001267
danielk197765839c62007-08-30 08:08:17 +00001268 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001269 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001270 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001271 goto delmaster_out;
1272 }
danielk197776572402004-06-25 02:38:54 +00001273
danielk197765839c62007-08-30 08:08:17 +00001274 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001275 if( c ){
danielk197776572402004-06-25 02:38:54 +00001276 /* We have a match. Do not delete the master journal file. */
1277 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001278 }
1279 }
danielk19775865e3d2004-06-14 06:03:57 +00001280 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001281 }
1282 }
1283
danielk1977fee2d252007-08-18 10:59:19 +00001284 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001285
1286delmaster_out:
1287 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001288 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001289 }
1290 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001291 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001292 }
danielk1977b4b47412007-08-17 15:53:36 +00001293 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001294 return rc;
1295}
1296
drha6abd042004-06-09 17:37:22 +00001297
danielk1977e180dd92007-04-05 17:15:52 +00001298static void pager_truncate_cache(Pager *pPager);
1299
drha6abd042004-06-09 17:37:22 +00001300/*
drhcb4c40b2004-08-18 19:09:43 +00001301** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001302** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001303**
1304** Might might be the case that the file on disk is smaller than nPage.
1305** This can happen, for example, if we are in the middle of a transaction
1306** which has extended the file size and the new pages are still all held
1307** in cache, then an INSERT or UPDATE does a statement rollback. Some
1308** operating system implementations can get confused if you try to
1309** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001310** so detect this case and write a single zero byte to the end of the new
1311** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001312*/
1313static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001314 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001315 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001316 i64 currentSize, newSize;
1317 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1318 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001319 if( rc==SQLITE_OK && currentSize!=newSize ){
1320 if( currentSize>newSize ){
1321 rc = sqlite3OsTruncate(pPager->fd, newSize);
1322 }else{
1323 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1324 }
drh7fe3f7e2007-11-29 18:44:27 +00001325 }
danielk1977e180dd92007-04-05 17:15:52 +00001326 }
1327 if( rc==SQLITE_OK ){
1328 pPager->dbSize = nPage;
1329 pager_truncate_cache(pPager);
1330 }
1331 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001332}
1333
1334/*
drhc80f0582007-05-01 16:59:48 +00001335** Set the sectorSize for the given pager.
1336**
drh334c80d2008-03-28 17:41:13 +00001337** The sector size is at least as big as the sector size reported
1338** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001339*/
1340static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001341 assert(pPager->fd->pMethods||pPager->tempFile);
1342 if( !pPager->tempFile ){
1343 /* Sector size doesn't matter for temporary files. Also, the file
1344 ** may not have been opened yet, in whcih case the OsSectorSize()
1345 ** call will segfault.
1346 */
1347 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1348 }
drh334c80d2008-03-28 17:41:13 +00001349 if( pPager->sectorSize<512 ){
1350 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001351 }
1352}
1353
1354/*
drhed7c8552001-04-11 14:29:21 +00001355** Playback the journal and thus restore the database file to
1356** the state it was in before we started making changes.
1357**
drh34e79ce2004-02-08 06:05:46 +00001358** The journal file format is as follows:
1359**
drhae2b40c2004-06-09 19:03:54 +00001360** (1) 8 byte prefix. A copy of aJournalMagic[].
1361** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001362** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001363** number of page records from the journal size.
1364** (3) 4 byte big-endian integer which is the initial value for the
1365** sanity checksum.
1366** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001367** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001368** (5) 4 byte big-endian integer which is the sector size. The header
1369** is this many bytes in size.
1370** (6) 4 byte big-endian integer which is the page case.
1371** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001372** name. The value may be zero (indicate that there is no master
1373** journal.)
drh334c80d2008-03-28 17:41:13 +00001374** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001375** and might be shorter than the value read from (5). If the first byte
1376** of the name is \000 then there is no master journal. The master
1377** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001378** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001379** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001380** + pPager->pageSize bytes of data.
1381** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001382**
drh334c80d2008-03-28 17:41:13 +00001383** When we speak of the journal header, we mean the first 8 items above.
1384** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001385**
1386** Call the value from the second bullet "nRec". nRec is the number of
1387** valid page entries in the journal. In most cases, you can compute the
1388** value of nRec from the size of the journal file. But if a power
1389** failure occurred while the journal was being written, it could be the
1390** case that the size of the journal file had already been increased but
1391** the extra entries had not yet made it safely to disk. In such a case,
1392** the value of nRec computed from the file size would be too large. For
1393** that reason, we always use the nRec value in the header.
1394**
1395** If the nRec value is 0xffffffff it means that nRec should be computed
1396** from the file size. This value is used when the user selects the
1397** no-sync option for the journal. A power failure could lead to corruption
1398** in this case. But for things like temporary table (which will be
1399** deleted when the power is restored) we don't care.
1400**
drhd9b02572001-04-15 00:37:09 +00001401** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001402** journal file then all pages up to the first corrupted page are rolled
1403** back (or no pages if the journal header is corrupted). The journal file
1404** is then deleted and SQLITE_OK returned, just as if no corruption had
1405** been encountered.
1406**
1407** If an I/O or malloc() error occurs, the journal-file is not deleted
1408** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001409*/
danielk1977e277be02007-03-23 18:12:06 +00001410static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001411 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001412 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001413 u32 nRec; /* Number of Records in the journal */
shane0b8d2762008-07-22 05:18:00 +00001414 u32 u; /* Unsigned loop counter */
drhd9b02572001-04-15 00:37:09 +00001415 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001416 int rc; /* Result code of a subroutine */
danielk1977861f7452008-06-05 11:39:11 +00001417 int res = 1; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001418 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001419
drhc3a64ba2001-11-22 00:01:27 +00001420 /* Figure out how many records are in the journal. Abort early if
1421 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001422 */
drh8cfbf082001-09-19 13:22:39 +00001423 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001424 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001425 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001426 goto end_playback;
1427 }
drh240c5792004-02-08 00:40:52 +00001428
danielk197776572402004-06-25 02:38:54 +00001429 /* Read the master journal name from the journal, if it is present.
1430 ** If a master journal file name is specified, but the file is not
1431 ** present on disk, then the journal is not hot and does not need to be
1432 ** played back.
drh240c5792004-02-08 00:40:52 +00001433 */
danielk197765839c62007-08-30 08:08:17 +00001434 zMaster = pPager->pTmpSpace;
1435 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977861f7452008-06-05 11:39:11 +00001436 if( rc==SQLITE_OK && zMaster[0] ){
1437 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
drhc3a64ba2001-11-22 00:01:27 +00001438 }
danielk197765839c62007-08-30 08:08:17 +00001439 zMaster = 0;
danielk1977861f7452008-06-05 11:39:11 +00001440 if( rc!=SQLITE_OK || !res ){
danielk1977ce98bba2008-04-03 10:13:01 +00001441 goto end_playback;
1442 }
1443 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001444
danielk197776572402004-06-25 02:38:54 +00001445 /* This loop terminates either when the readJournalHdr() call returns
1446 ** SQLITE_DONE or an IO error occurs. */
1447 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001448
danielk197776572402004-06-25 02:38:54 +00001449 /* Read the next journal header from the journal file. If there are
1450 ** not enough bytes left in the journal file for a complete header, or
1451 ** it is corrupted, then a process must of failed while writing it.
1452 ** This indicates nothing more needs to be rolled back.
1453 */
1454 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1455 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001456 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001457 rc = SQLITE_OK;
1458 }
danielk197776572402004-06-25 02:38:54 +00001459 goto end_playback;
1460 }
1461
1462 /* If nRec is 0xffffffff, then this journal was created by a process
1463 ** working in no-sync mode. This means that the rest of the journal
1464 ** file consists of pages, there are no more journal headers. Compute
1465 ** the value of nRec based on this assumption.
1466 */
1467 if( nRec==0xffffffff ){
1468 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1469 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1470 }
1471
danielk1977e277be02007-03-23 18:12:06 +00001472 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001473 ** process and if this is the final header in the journal, then it means
1474 ** that this part of the journal was being filled but has not yet been
1475 ** synced to disk. Compute the number of pages based on the remaining
1476 ** size of the file.
1477 **
1478 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001479 */
drh8940f4e2007-08-11 00:26:20 +00001480 if( nRec==0 && !isHot &&
1481 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001482 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1483 }
1484
danielk197776572402004-06-25 02:38:54 +00001485 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001486 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001487 */
danielk1977e180dd92007-04-05 17:15:52 +00001488 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001489 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001490 if( rc!=SQLITE_OK ){
1491 goto end_playback;
1492 }
danielk197776572402004-06-25 02:38:54 +00001493 }
1494
danielk197776572402004-06-25 02:38:54 +00001495 /* Copy original pages out of the journal and back into the database file.
1496 */
shane0b8d2762008-07-22 05:18:00 +00001497 for(u=0; u<nRec; u++){
danielk197762079062007-08-15 17:08:46 +00001498 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001499 if( rc!=SQLITE_OK ){
1500 if( rc==SQLITE_DONE ){
1501 rc = SQLITE_OK;
1502 pPager->journalOff = szJ;
1503 break;
1504 }else{
drha9625ea2008-09-03 00:08:29 +00001505 /* If we are unable to rollback, then the database is probably
1506 ** going to end up being corrupt. It is corrupt to us, anyhow.
1507 ** Perhaps the next process to come along can fix it....
1508 */
danielk197798c21902008-09-23 16:41:29 +00001509 rc = SQLITE_CORRUPT_BKPT;
danielk197776572402004-06-25 02:38:54 +00001510 goto end_playback;
1511 }
1512 }
drh968af522003-02-11 14:55:40 +00001513 }
drhed7c8552001-04-11 14:29:21 +00001514 }
drh580eeaf2006-02-24 03:09:37 +00001515 /*NOTREACHED*/
1516 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001517
1518end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001519 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001520 zMaster = pPager->pTmpSpace;
1521 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1522 }
1523 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001524 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001525 }
danielk1977c56774e2008-10-07 11:51:20 +00001526 if( rc==SQLITE_OK && zMaster[0] && res ){
danielk1977979f38e2007-03-27 16:19:51 +00001527 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001528 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001529 */
danielk197765839c62007-08-30 08:08:17 +00001530 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001531 }
danielk197776572402004-06-25 02:38:54 +00001532
1533 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001534 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001535 ** value. Reset it to the correct value for this process.
1536 */
drhc80f0582007-05-01 16:59:48 +00001537 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001538 return rc;
drhed7c8552001-04-11 14:29:21 +00001539}
1540
1541/*
drhac69b052004-05-12 13:30:07 +00001542** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001543**
1544** This is similar to playing back the transaction journal but with
1545** a few extra twists.
1546**
drh663fc632002-02-02 18:49:19 +00001547** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001548** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001549** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001550**
drhac69b052004-05-12 13:30:07 +00001551** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001552** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001553** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001554*/
drh3aac2dd2004-04-26 14:10:20 +00001555static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001556 i64 szJ; /* Size of the full journal */
1557 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001558 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001559 int i; /* Loop counter */
1560 int rc;
1561
danielk197776572402004-06-25 02:38:54 +00001562 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001563
danielk19774099f6e2007-03-19 11:25:20 +00001564 /* Set hdrOff to be the offset just after the end of the last journal
1565 ** page written before the first journal-header for this statement
1566 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001567 ** header was written.
1568 */
1569 hdrOff = pPager->stmtHdrOff;
1570 assert( pPager->fullSync || !hdrOff );
1571 if( !hdrOff ){
1572 hdrOff = szJ;
1573 }
1574
drhfa86c412002-02-02 15:01:15 +00001575 /* Truncate the database back to its original size.
1576 */
danielk1977e180dd92007-04-05 17:15:52 +00001577 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001578 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001579
drhac69b052004-05-12 13:30:07 +00001580 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001581 */
drhac69b052004-05-12 13:30:07 +00001582 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001583 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001584
drhac69b052004-05-12 13:30:07 +00001585 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001586 ** database file. Note that the statement journal omits checksums from
1587 ** each record since power-failure recovery is not important to statement
1588 ** journals.
drhfa86c412002-02-02 15:01:15 +00001589 */
danielk197762079062007-08-15 17:08:46 +00001590 for(i=0; i<nRec; i++){
1591 i64 offset = i*(4+pPager->pageSize);
1592 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001593 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001594 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001595 }
1596
danielk197776572402004-06-25 02:38:54 +00001597 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1598 ** was the size of the journal file when this statement was started, so
1599 ** everything after that needs to be rolled back, either into the
1600 ** database, the memory cache, or both.
1601 **
1602 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1603 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001604 */
danielk197776572402004-06-25 02:38:54 +00001605 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001606 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001607 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001608 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001609 assert( rc!=SQLITE_DONE );
1610 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1611 }
1612
1613 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001614 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001615 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001616 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001617 if( rc!=SQLITE_OK ){
1618 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001619 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001620 }
danielk1977f0113002006-01-24 12:09:17 +00001621 if( nJRec==0 ){
1622 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001623 }
danielk1977f0113002006-01-24 12:09:17 +00001624 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001625 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001626 assert( rc!=SQLITE_DONE );
1627 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1628 }
drhfa86c412002-02-02 15:01:15 +00001629 }
danielk197776572402004-06-25 02:38:54 +00001630
1631 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001632
drh3aac2dd2004-04-26 14:10:20 +00001633end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001634 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001635 pPager->journalOff = szJ;
1636 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001637 }
1638 return rc;
1639}
1640
1641/*
drhf57b14a2001-09-14 18:54:08 +00001642** Change the maximum number of in-memory pages that are allowed.
1643*/
danielk19773b8a05f2007-03-19 17:44:26 +00001644void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
danielk19778c0a7912008-08-20 14:49:23 +00001645 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001646}
1647
1648/*
drh973b6e32003-02-12 14:09:42 +00001649** Adjust the robustness of the database to damage due to OS crashes
1650** or power failures by changing the number of syncs()s when writing
1651** the rollback journal. There are three levels:
1652**
drh054889e2005-11-30 03:20:31 +00001653** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001654** for temporary and transient files.
1655**
1656** NORMAL The journal is synced once before writes begin on the
1657** database. This is normally adequate protection, but
1658** it is theoretically possible, though very unlikely,
1659** that an inopertune power failure could leave the journal
1660** in a state which would cause damage to the database
1661** when it is rolled back.
1662**
1663** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001664** database (with some additional information - the nRec field
1665** of the journal header - being written in between the two
1666** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001667** single disk sector is atomic, then this mode provides
1668** assurance that the journal will not be corrupted to the
1669** point of causing damage to the database during rollback.
1670**
1671** Numeric values associated with these states are OFF==1, NORMAL=2,
1672** and FULL=3.
1673*/
danielk197793758c82005-01-21 08:13:14 +00001674#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh281b21d2008-08-22 12:57:08 +00001675void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){
danielk1977b3175382008-10-17 18:51:52 +00001676 pPager->noSync = level==1 || pPager->tempFile;
drh973b6e32003-02-12 14:09:42 +00001677 pPager->fullSync = level==3 && !pPager->tempFile;
drh281b21d2008-08-22 12:57:08 +00001678 pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001679 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001680}
danielk197793758c82005-01-21 08:13:14 +00001681#endif
drh973b6e32003-02-12 14:09:42 +00001682
1683/*
drhaf6df112005-06-07 02:12:30 +00001684** The following global variable is incremented whenever the library
1685** attempts to open a temporary file. This information is used for
1686** testing and analysis only.
1687*/
drh0f7eb612006-08-08 13:51:43 +00001688#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001689int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001690#endif
drhaf6df112005-06-07 02:12:30 +00001691
1692/*
drh3f56e6e2007-03-15 01:16:47 +00001693** Open a temporary file.
1694**
1695** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001696** other error code if we fail. The OS will automatically delete the temporary
1697** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001698*/
danielk1977b4b47412007-08-17 15:53:36 +00001699static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00001700 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00001701 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00001702 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00001703){
drhfa86c412002-02-02 15:01:15 +00001704 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001705
drh0f7eb612006-08-08 13:51:43 +00001706#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001707 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001708#endif
danielk1977b4b47412007-08-17 15:53:36 +00001709
drh33f4e022007-09-03 15:19:34 +00001710 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
1711 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00001712 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00001713 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00001714 return rc;
1715}
1716
danielk1977a858aa22008-08-22 16:22:17 +00001717static int pagerStress(void *,PgHdr *);
danielk19778c0a7912008-08-20 14:49:23 +00001718
drhfa86c412002-02-02 15:01:15 +00001719/*
drhed7c8552001-04-11 14:29:21 +00001720** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001721** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001722** the first call to sqlite3PagerGet() and is only held open until the
1723** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001724**
drh6446c4d2001-12-15 14:22:18 +00001725** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00001726** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00001727** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001728**
1729** If zFilename is ":memory:" then all information is held in cache.
1730** It is never written to disk. This can be used to implement an
1731** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001732*/
danielk19773b8a05f2007-03-19 17:44:26 +00001733int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001734 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001735 Pager **ppPager, /* Return the Pager structure here */
1736 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001737 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00001738 int flags, /* flags controlling this file */
1739 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00001740){
danielk1977b4b47412007-08-17 15:53:36 +00001741 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001742 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001743 int rc = SQLITE_OK;
1744 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001745 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001746 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001747 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001748 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1749 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977b3175382008-10-17 18:51:52 +00001750 int journalFileSize;
danielk19778c0a7912008-08-20 14:49:23 +00001751 int pcacheSize = sqlite3PcacheSize();
drhfacf0302008-06-17 15:12:00 +00001752 int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00001753 char *zPathname = 0;
1754 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001755
danielk1977b3175382008-10-17 18:51:52 +00001756 if( sqlite3JournalSize(pVfs)>sqlite3MemJournalSize() ){
1757 journalFileSize = sqlite3JournalSize(pVfs);
1758 }else{
1759 journalFileSize = sqlite3MemJournalSize();
1760 }
1761
drh86f8c192007-08-22 00:39:19 +00001762 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001763 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001764
danielk197717b90b52008-06-06 11:11:25 +00001765 /* Compute and store the full pathname in an allocated buffer pointed
1766 ** to by zPathname, length nPathname. Or, if this is a temporary file,
1767 ** leave both nPathname and zPathname set to 0.
1768 */
drh1cc8c442007-08-24 16:08:29 +00001769 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00001770 nPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001771 zPathname = sqlite3Malloc(nPathname*2);
danielk197717b90b52008-06-06 11:11:25 +00001772 if( zPathname==0 ){
1773 return SQLITE_NOMEM;
1774 }
drh1cc8c442007-08-24 16:08:29 +00001775#ifndef SQLITE_OMIT_MEMORYDB
1776 if( strcmp(zFilename,":memory:")==0 ){
1777 memDb = 1;
1778 zPathname[0] = 0;
1779 }else
1780#endif
1781 {
danielk1977adfb9b02007-09-17 07:02:56 +00001782 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00001783 }
danielk197717b90b52008-06-06 11:11:25 +00001784 if( rc!=SQLITE_OK ){
1785 sqlite3_free(zPathname);
1786 return rc;
1787 }
1788 nPathname = strlen(zPathname);
drhae28c012007-08-24 16:29:23 +00001789 }
drh99b90c32008-03-17 13:50:58 +00001790
danielk1977b4b47412007-08-17 15:53:36 +00001791 /* Allocate memory for the pager structure */
1792 pPager = sqlite3MallocZero(
1793 sizeof(*pPager) + /* Pager structure */
danielk19778c0a7912008-08-20 14:49:23 +00001794 pcacheSize + /* PCache object */
danielk1977c7b60172007-08-22 11:22:03 +00001795 journalFileSize + /* The journal file structure */
danielk1977b3175382008-10-17 18:51:52 +00001796 pVfs->szOsFile + /* The main db file */
1797 journalFileSize * 2 + /* The two journal files */
danielk197717b90b52008-06-06 11:11:25 +00001798 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00001799 );
1800 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00001801 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00001802 return SQLITE_NOMEM;
1803 }
danielk19778c0a7912008-08-20 14:49:23 +00001804 pPager->pPCache = (PCache *)&pPager[1];
1805 pPtr = ((u8 *)&pPager[1]) + pcacheSize;
drh33f4e022007-09-03 15:19:34 +00001806 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00001807 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977b3175382008-10-17 18:51:52 +00001808 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile];
1809 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile+journalFileSize];
1810 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile+2*journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00001811 pPager->zDirectory = &pPager->zFilename[nPathname+1];
1812 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00001813 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00001814 if( zPathname ){
1815 memcpy(pPager->zFilename, zPathname, nPathname+1);
1816 sqlite3_free(zPathname);
1817 }
danielk1977b4b47412007-08-17 15:53:36 +00001818
drh153c62c2007-08-24 03:51:33 +00001819 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00001820 */
drhae28c012007-08-24 16:29:23 +00001821 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00001822 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
1823 rc = SQLITE_CANTOPEN;
1824 }else{
drh1cc8c442007-08-24 16:08:29 +00001825 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00001826 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
1827 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00001828 readOnly = (fout&SQLITE_OPEN_READONLY);
1829
1830 /* If the file was successfully opened for read/write access,
1831 ** choose a default page size in case we have to create the
1832 ** database file. The default page size is the maximum of:
1833 **
1834 ** + SQLITE_DEFAULT_PAGE_SIZE,
1835 ** + The value returned by sqlite3OsSectorSize()
1836 ** + The largest page size that can be written atomically.
1837 */
1838 if( rc==SQLITE_OK && !readOnly ){
1839 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
drhfacf0302008-06-17 15:12:00 +00001840 if( szPageDflt<iSectorSize ){
1841 szPageDflt = iSectorSize;
drh1cc8c442007-08-24 16:08:29 +00001842 }
danielk19779663b8f2007-08-24 11:52:28 +00001843#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00001844 {
1845 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
1846 int ii;
1847 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1848 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1849 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
drhfacf0302008-06-17 15:12:00 +00001850 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
1851 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii;
danielk19779663b8f2007-08-24 11:52:28 +00001852 }
danielk1977b4b47412007-08-17 15:53:36 +00001853 }
drh1cc8c442007-08-24 16:08:29 +00001854#endif
drhfacf0302008-06-17 15:12:00 +00001855 if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
1856 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
drh1cc8c442007-08-24 16:08:29 +00001857 }
danielk19778def5ea2004-06-16 10:39:52 +00001858 }
drhac69b052004-05-12 13:30:07 +00001859 }
danielk1977b3175382008-10-17 18:51:52 +00001860 }else{
danielk19777a2b1ee2007-08-21 14:27:01 +00001861 /* If a temporary file is requested, it is not opened immediately.
1862 ** In this case we accept the default page size and delay actually
1863 ** opening the file until the first call to OsWrite().
danielk1977b3175382008-10-17 18:51:52 +00001864 **
1865 ** This branch is also run for an in-memory database. An in-memory
1866 ** database is the same as a temp-file that is never written out to
1867 ** disk and uses an in-memory rollback journal.
danielk19777a2b1ee2007-08-21 14:27:01 +00001868 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001869 tempFile = 1;
1870 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001871 }
danielk1977aef0bf62005-12-30 16:28:01 +00001872
danielk1977b4b47412007-08-17 15:53:36 +00001873 if( pPager && rc==SQLITE_OK ){
drhfacf0302008-06-17 15:12:00 +00001874 pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt);
drh3e7a6092002-12-07 21:45:14 +00001875 }
danielk1977aef0bf62005-12-30 16:28:01 +00001876
drh153c62c2007-08-24 03:51:33 +00001877 /* If an error occured in either of the blocks above.
1878 ** Free the Pager structure and close the file.
1879 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00001880 ** any Pager.errMask variables.
1881 */
danielk1977b4b47412007-08-17 15:53:36 +00001882 if( !pPager || !pPager->pTmpSpace ){
1883 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001884 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001885 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001886 }
danielk19778c0a7912008-08-20 14:49:23 +00001887 nExtra = FORCE_ALIGNMENT(nExtra);
danielk197771d5d2c2008-09-29 11:49:47 +00001888 sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
drh41d30272008-08-20 21:47:45 +00001889 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
danielk1977aef0bf62005-12-30 16:28:01 +00001890
drh153c62c2007-08-24 03:51:33 +00001891 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
1892 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00001893
danielk1977b4b47412007-08-17 15:53:36 +00001894 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00001895 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00001896 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001897 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001898
drh99b90c32008-03-17 13:50:58 +00001899 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00001900 if( zPathname ){
1901 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
1902 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
1903 }else{
1904 pPager->zJournal = 0;
1905 }
danielk1977b4b47412007-08-17 15:53:36 +00001906
drh3b59a5c2006-01-15 20:28:28 +00001907 /* pPager->journalOpen = 0; */
drhb3df2e12008-09-17 20:06:26 +00001908 pPager->useJournal = useJournal;
drh7bec5052005-02-06 02:45:41 +00001909 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001910 /* pPager->stmtOpen = 0; */
1911 /* pPager->stmtInUse = 0; */
1912 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001913 pPager->dbSize = memDb-1;
drhfacf0302008-06-17 15:12:00 +00001914 pPager->pageSize = szPageDflt;
drh3b59a5c2006-01-15 20:28:28 +00001915 /* pPager->stmtSize = 0; */
1916 /* pPager->stmtJSize = 0; */
1917 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001918 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001919 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001920 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00001921 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00001922 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001923 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001924 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1925 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1926 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1927 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001928 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001929 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001930 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001931 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001932 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00001933 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00001934 /* pPager->pFirst = 0; */
1935 /* pPager->pFirstSynced = 0; */
1936 /* pPager->pLast = 0; */
danielk19778c0a7912008-08-20 14:49:23 +00001937 pPager->nExtra = nExtra;
danielk1977b53e4962008-06-04 06:45:59 +00001938 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk1977b3175382008-10-17 18:51:52 +00001939 assert(pPager->fd->pMethods||tempFile);
1940 setSectorSize(pPager);
1941 if( memDb ){
1942 pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
danielk1977b4721172007-03-19 05:54:48 +00001943 }
drh3b59a5c2006-01-15 20:28:28 +00001944 /* pPager->pBusyHandler = 0; */
1945 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001946 *ppPager = pPager;
1947 return SQLITE_OK;
1948}
1949
1950/*
drh90f5ecb2004-07-22 01:19:35 +00001951** Set the busy handler function.
1952*/
danielk19773b8a05f2007-03-19 17:44:26 +00001953void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00001954 pPager->pBusyHandler = pBusyHandler;
1955}
1956
1957/*
drha6abd042004-06-09 17:37:22 +00001958** Set the reinitializer for this pager. If not NULL, the reinitializer
1959** is called when the content of a page in cache is restored to its original
1960** value as a result of a rollback. The callback gives higher-level code
1961** an opportunity to restore the EXTRA section to agree with the restored
1962** page data.
1963*/
danielk1977eaa06f62008-09-18 17:34:44 +00001964void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*)){
drha6abd042004-06-09 17:37:22 +00001965 pPager->xReiniter = xReinit;
1966}
1967
1968/*
danielk1977a1644fd2007-08-29 12:31:25 +00001969** Set the page size to *pPageSize. If the suggest new page size is
1970** inappropriate, then an alternative page size is set to that
1971** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00001972*/
danielk1977a1644fd2007-08-29 12:31:25 +00001973int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
danielk19771357d9f2008-09-16 05:12:24 +00001974 int rc = pPager->errCode;
1975 if( rc==SQLITE_OK ){
1976 u16 pageSize = *pPageSize;
1977 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
1978 if( pageSize && pageSize!=pPager->pageSize
1979 && (pPager->memDb==0 || pPager->dbSize==0)
1980 && sqlite3PcacheRefCount(pPager->pPCache)==0
1981 ){
1982 char *pNew = (char *)sqlite3PageMalloc(pageSize);
1983 if( !pNew ){
1984 rc = SQLITE_NOMEM;
1985 }else{
1986 pager_reset(pPager);
1987 pPager->pageSize = pageSize;
1988 if( !pPager->memDb ) setSectorSize(pPager);
1989 sqlite3PageFree(pPager->pTmpSpace);
1990 pPager->pTmpSpace = pNew;
1991 sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
1992 }
danielk1977a1644fd2007-08-29 12:31:25 +00001993 }
danielk19771357d9f2008-09-16 05:12:24 +00001994 *pPageSize = pPager->pageSize;
drh1c7880e2005-05-20 20:01:55 +00001995 }
danielk1977a1644fd2007-08-29 12:31:25 +00001996 return rc;
drh90f5ecb2004-07-22 01:19:35 +00001997}
1998
1999/*
drh26b79942007-11-28 16:19:56 +00002000** Return a pointer to the "temporary page" buffer held internally
2001** by the pager. This is a buffer that is big enough to hold the
2002** entire content of a database page. This buffer is used internally
2003** during rollback and will be overwritten whenever a rollback
2004** occurs. But other modules are free to use it too, as long as
2005** no rollbacks are happening.
2006*/
2007void *sqlite3PagerTempSpace(Pager *pPager){
2008 return pPager->pTmpSpace;
2009}
2010
2011/*
drhf8e632b2007-05-08 14:51:36 +00002012** Attempt to set the maximum database page count if mxPage is positive.
2013** Make no changes if mxPage is zero or negative. And never reduce the
2014** maximum page count below the current size of the database.
2015**
2016** Regardless of mxPage, return the current maximum page count.
2017*/
2018int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2019 if( mxPage>0 ){
2020 pPager->mxPgno = mxPage;
2021 }
danielk1977ad0132d2008-06-07 08:58:22 +00002022 sqlite3PagerPagecount(pPager, 0);
drhf8e632b2007-05-08 14:51:36 +00002023 return pPager->mxPgno;
2024}
2025
2026/*
drhc9ac5ca2005-11-04 22:03:30 +00002027** The following set of routines are used to disable the simulated
2028** I/O error mechanism. These routines are used to avoid simulated
2029** errors in places where we do not care about errors.
2030**
2031** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2032** and generate no code.
2033*/
2034#ifdef SQLITE_TEST
2035extern int sqlite3_io_error_pending;
2036extern int sqlite3_io_error_hit;
2037static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002038void disable_simulated_io_errors(void){
2039 saved_cnt = sqlite3_io_error_pending;
2040 sqlite3_io_error_pending = -1;
2041}
2042void enable_simulated_io_errors(void){
2043 sqlite3_io_error_pending = saved_cnt;
2044}
2045#else
drh152410f2005-11-05 15:11:22 +00002046# define disable_simulated_io_errors()
2047# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002048#endif
2049
2050/*
drh90f5ecb2004-07-22 01:19:35 +00002051** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002052** that pDest points to.
2053**
2054** No error checking is done. The rational for this is that this function
2055** may be called even if the file does not exist or contain a header. In
2056** these cases sqlite3OsRead() will return an error, to which the correct
2057** response is to zero the memory at pDest and continue. A real IO error
2058** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002059*/
danielk19773b8a05f2007-03-19 17:44:26 +00002060int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002061 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002062 memset(pDest, 0, N);
danielk1977b3175382008-10-17 18:51:52 +00002063 assert(pPager->fd->pMethods||pPager->tempFile);
danielk19777a2b1ee2007-08-21 14:27:01 +00002064 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002065 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002066 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002067 if( rc==SQLITE_IOERR_SHORT_READ ){
2068 rc = SQLITE_OK;
2069 }
drh90f5ecb2004-07-22 01:19:35 +00002070 }
drh551b7732006-11-06 21:20:25 +00002071 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002072}
2073
2074/*
drh5e00f6c2001-09-13 13:46:56 +00002075** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002076** pPager.
2077**
2078** If the PENDING_BYTE lies on the page directly after the end of the
2079** file, then consider this page part of the file too. For example, if
2080** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2081** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002082*/
danielk1977ad0132d2008-06-07 08:58:22 +00002083int sqlite3PagerPagecount(Pager *pPager, int *pnPage){
danielk19777a2b1ee2007-08-21 14:27:01 +00002084 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002085 int rc;
drhd9b02572001-04-15 00:37:09 +00002086 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002087 if( pPager->errCode ){
danielk19778c0a7912008-08-20 14:49:23 +00002088 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002089 return rc;
drha7aea3d2007-03-15 12:51:16 +00002090 }
drhed7c8552001-04-11 14:29:21 +00002091 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002092 n = pPager->dbSize;
2093 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002094 assert(pPager->fd->pMethods||pPager->tempFile);
2095 if( (pPager->fd->pMethods)
2096 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002097 pager_error(pPager, rc);
danielk1977ad0132d2008-06-07 08:58:22 +00002098 return rc;
danielk197715f411d2005-09-16 10:18:45 +00002099 }
2100 if( n>0 && n<pPager->pageSize ){
2101 n = 1;
2102 }else{
2103 n /= pPager->pageSize;
2104 }
2105 if( pPager->state!=PAGER_UNLOCK ){
2106 pPager->dbSize = n;
2107 }
drhed7c8552001-04-11 14:29:21 +00002108 }
danielk197715f411d2005-09-16 10:18:45 +00002109 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002110 n++;
2111 }
drhf8e632b2007-05-08 14:51:36 +00002112 if( n>pPager->mxPgno ){
2113 pPager->mxPgno = n;
2114 }
danielk1977ad0132d2008-06-07 08:58:22 +00002115 if( pnPage ){
2116 *pnPage = n;
2117 }
2118 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002119}
2120
2121/*
drhf7c57532003-04-25 13:22:51 +00002122** Forward declaration
2123*/
danielk197776572402004-06-25 02:38:54 +00002124static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002125
2126/*
danielk1977e180dd92007-04-05 17:15:52 +00002127** This routine is used to truncate the cache when a database
2128** is truncated. Drop from the cache all pages whose pgno is
2129** larger than pPager->dbSize and is unreferenced.
2130**
drhac69b052004-05-12 13:30:07 +00002131** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002132**
2133** Actually, at the point this routine is called, it would be
2134** an error to have a referenced page. But rather than delete
2135** that page and guarantee a subsequent segfault, it seems better
2136** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002137*/
danielk1977e180dd92007-04-05 17:15:52 +00002138static void pager_truncate_cache(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00002139 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
drhac69b052004-05-12 13:30:07 +00002140}
2141
drhf7c57532003-04-25 13:22:51 +00002142/*
danielk197717221812005-02-15 03:38:05 +00002143** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002144** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002145** false or until the lock succeeds.
2146**
2147** Return SQLITE_OK on success and an error code if we cannot obtain
2148** the lock.
2149*/
2150static int pager_wait_on_lock(Pager *pPager, int locktype){
2151 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002152
2153 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002154 assert( PAGER_SHARED==SHARED_LOCK );
2155 assert( PAGER_RESERVED==RESERVED_LOCK );
2156 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002157
2158 /* If the file is currently unlocked then the size must be unknown */
danielk1977b3175382008-10-17 18:51:52 +00002159 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 );
drh1aa2d8b2007-01-03 15:34:29 +00002160
danielk197717221812005-02-15 03:38:05 +00002161 if( pPager->state>=locktype ){
2162 rc = SQLITE_OK;
2163 }else{
drhbefdf832008-03-14 19:33:05 +00002164 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002165 do {
drh054889e2005-11-30 03:20:31 +00002166 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002167 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002168 if( rc==SQLITE_OK ){
2169 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002170 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002171 }
2172 }
2173 return rc;
2174}
2175
2176/*
drhf7c57532003-04-25 13:22:51 +00002177** Truncate the file to the number of pages specified.
2178*/
danielk19773b8a05f2007-03-19 17:44:26 +00002179int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
danielk19778c0a7912008-08-20 14:49:23 +00002180 int rc = SQLITE_OK;
danielk1977b3175382008-10-17 18:51:52 +00002181 assert( pPager->state>=PAGER_SHARED );
danielk19778c0a7912008-08-20 14:49:23 +00002182
danielk1977ad0132d2008-06-07 08:58:22 +00002183 sqlite3PagerPagecount(pPager, 0);
danielk1977efaaf572006-01-16 11:29:19 +00002184 if( pPager->errCode ){
2185 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002186 }else if( nPage<(unsigned)pPager->dbSize ){
danielk1977b3175382008-10-17 18:51:52 +00002187 rc = syncJournal(pPager);
2188 if( rc==SQLITE_OK ){
2189 /* Get an exclusive lock on the database before truncating. */
2190 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2191 }
2192 if( rc==SQLITE_OK ){
2193 rc = pager_truncate(pPager, nPage);
danielk19778c0a7912008-08-20 14:49:23 +00002194 }
danielk1977369f27e2004-06-15 11:40:04 +00002195 }
danielk197717221812005-02-15 03:38:05 +00002196
drhf7c57532003-04-25 13:22:51 +00002197 return rc;
2198}
2199
2200/*
drhed7c8552001-04-11 14:29:21 +00002201** Shutdown the page cache. Free all memory and close all files.
2202**
2203** If a transaction was in progress when this routine is called, that
2204** transaction is rolled back. All outstanding pages are invalidated
2205** and their memory is freed. Any attempt to use a page associated
2206** with this page cache after this function returns will likely
2207** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002208**
2209** This function always succeeds. If a transaction is active an attempt
2210** is made to roll it back. If an error occurs during the rollback
2211** a hot journal may be left in the filesystem but no error is returned
2212** to the caller.
drhed7c8552001-04-11 14:29:21 +00002213*/
danielk19773b8a05f2007-03-19 17:44:26 +00002214int sqlite3PagerClose(Pager *pPager){
danielk197713f72992005-12-18 08:51:22 +00002215
drhbafda092007-01-03 23:36:22 +00002216 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002217 sqlite3BeginBenignMalloc();
drhc2ee76c2007-01-04 14:58:14 +00002218 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002219 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002220 pager_reset(pPager);
danielk1977b3175382008-10-17 18:51:52 +00002221 if( !MEMDB ){
2222 pagerUnlockAndRollback(pPager);
2223 }
drhbafda092007-01-03 23:36:22 +00002224 enable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002225 sqlite3EndBenignMalloc();
drh4f0c5872007-03-26 22:05:01 +00002226 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002227 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002228 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002229 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002230 }
drhf5e7bb52008-02-18 14:47:33 +00002231 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977a1fa00d2008-08-27 15:16:33 +00002232 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
danielk1977e94ddc92005-03-21 03:53:38 +00002233 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002234 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002235 }
danielk1977b4b47412007-08-17 15:53:36 +00002236 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002237 /* Temp files are automatically deleted by the OS
2238 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002239 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002240 ** }
2241 */
danielk1977aca790a2005-01-13 11:07:52 +00002242
drhfacf0302008-06-17 15:12:00 +00002243 sqlite3PageFree(pPager->pTmpSpace);
danielk19778c0a7912008-08-20 14:49:23 +00002244 sqlite3PcacheClose(pPager->pPCache);
drh17435752007-08-16 04:30:38 +00002245 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002246 return SQLITE_OK;
2247}
2248
drh87cc3b32007-05-08 21:45:27 +00002249#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002250/*
drh5e00f6c2001-09-13 13:46:56 +00002251** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002252*/
danielk19773b8a05f2007-03-19 17:44:26 +00002253Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002254 return p->pgno;
2255}
drh87cc3b32007-05-08 21:45:27 +00002256#endif
drhed7c8552001-04-11 14:29:21 +00002257
2258/*
drhdf0b3b02001-06-23 11:36:20 +00002259** Increment the reference count for a page. The input pointer is
2260** a reference to the page data.
2261*/
danielk19773b8a05f2007-03-19 17:44:26 +00002262int sqlite3PagerRef(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002263 sqlite3PcacheRef(pPg);
drh8c42ca92001-06-22 19:15:00 +00002264 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002265}
2266
2267/*
drh34e79ce2004-02-08 06:05:46 +00002268** Sync the journal. In other words, make sure all the pages that have
2269** been written to the journal have actually reached the surface of the
2270** disk. It is not safe to modify the original database file until after
2271** the journal has been synced. If the original database is modified before
2272** the journal is synced and a power failure occurs, the unsynced journal
2273** data would be lost and we would be unable to completely rollback the
2274** database changes. Database corruption would occur.
2275**
2276** This routine also updates the nRec field in the header of the journal.
2277** (See comments on the pager_playback() routine for additional information.)
2278** If the sync mode is FULL, two syncs will occur. First the whole journal
2279** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002280**
drh34e79ce2004-02-08 06:05:46 +00002281** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002282** after a power failure, so no sync occurs.
2283**
2284** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2285** the database is stored, then OsSync() is never called on the journal
2286** file. In this case all that is required is to update the nRec field in
2287** the journal header.
drhfa86c412002-02-02 15:01:15 +00002288**
drh34e79ce2004-02-08 06:05:46 +00002289** This routine clears the needSync field of every page current held in
2290** memory.
drh50e5dad2001-09-15 00:57:28 +00002291*/
danielk197776572402004-06-25 02:38:54 +00002292static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002293 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002294
2295 /* Sync the journal before modifying the main database
2296 ** (assuming there is a journal and it needs to be synced.)
2297 */
danielk197776572402004-06-25 02:38:54 +00002298 if( pPager->needSync ){
danielk1977b3175382008-10-17 18:51:52 +00002299 assert( !pPager->tempFile );
2300 if( pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
danielk19774cd2cd52007-08-23 14:48:23 +00002301 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002302 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002303
danielk19774cd2cd52007-08-23 14:48:23 +00002304 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002305 /* Write the nRec value into the journal file header. If in
2306 ** full-synchronous mode, sync the journal first. This ensures that
2307 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002308 ** it as a candidate for rollback.
2309 **
2310 ** This is not required if the persistent media supports the
2311 ** SAFE_APPEND property. Because in this case it is not possible
2312 ** for garbage data to be appended to the file, the nRec field
2313 ** is populated with 0xFFFFFFFF when the journal header is written
2314 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002315 */
danielk19774cd2cd52007-08-23 14:48:23 +00002316 i64 jrnlOff;
2317 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002318 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002319 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002320 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002321 if( rc!=0 ) return rc;
2322 }
danielk197713adf8a2004-06-03 16:08:41 +00002323
danielk197762079062007-08-15 17:08:46 +00002324 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2325 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2326 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002327 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002328 }
danielk19774cd2cd52007-08-23 14:48:23 +00002329 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2330 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2331 IOTRACE(("JSYNC %p\n", pPager))
2332 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2333 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2334 );
2335 if( rc!=0 ) return rc;
2336 }
drhdb48ee02003-01-16 13:42:43 +00002337 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002338 }
drh50e5dad2001-09-15 00:57:28 +00002339 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002340
2341 /* Erase the needSync flag from every page.
2342 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00002343 sqlite3PcacheClearSyncFlags(pPager->pPCache);
drh50e5dad2001-09-15 00:57:28 +00002344 }
drh03eb96a2002-11-10 23:32:56 +00002345
drh81a20f22001-10-12 17:30:04 +00002346 return rc;
drh50e5dad2001-09-15 00:57:28 +00002347}
2348
2349/*
drh2554f8b2003-01-22 01:26:44 +00002350** Given a list of pages (connected by the PgHdr.pDirty pointer) write
danielk1977a858aa22008-08-22 16:22:17 +00002351** every one of those pages out to the database file. No calls are made
2352** to the page-cache to mark the pages as clean. It is the responsibility
2353** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark
2354** the pages as clean.
drh2554f8b2003-01-22 01:26:44 +00002355*/
2356static int pager_write_pagelist(PgHdr *pList){
2357 Pager *pPager;
2358 int rc;
2359
2360 if( pList==0 ) return SQLITE_OK;
2361 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002362
2363 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2364 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002365 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002366 **
drha6abd042004-06-09 17:37:22 +00002367 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2368 ** through an intermediate state PENDING. A PENDING lock prevents new
2369 ** readers from attaching to the database but is unsufficient for us to
2370 ** write. The idea of a PENDING lock is to prevent new readers from
2371 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002372 **
drha6abd042004-06-09 17:37:22 +00002373 ** While the pager is in the RESERVED state, the original database file
2374 ** is unchanged and we can rollback without having to playback the
2375 ** journal into the original database file. Once we transition to
2376 ** EXCLUSIVE, it means the database file has been changed and any rollback
2377 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002378 */
drh684917c2004-10-05 02:41:42 +00002379 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002380 if( rc!=SQLITE_OK ){
2381 return rc;
2382 }
2383
drh2554f8b2003-01-22 01:26:44 +00002384 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002385
2386 /* If the file has not yet been opened, open it now. */
2387 if( !pPager->fd->pMethods ){
2388 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00002389 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002390 if( rc ) return rc;
2391 }
2392
danielk1977687566d2004-11-02 12:56:41 +00002393 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002394 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002395 ** make the file smaller (presumably by auto-vacuum code). Do not write
2396 ** any such pages to the file.
2397 */
danielk197733e32162008-08-23 18:53:08 +00002398 if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
danielk197762079062007-08-15 17:08:46 +00002399 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002400 char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00002401 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2402 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002403 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002404 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002405 PAGER_INCR(sqlite3_pager_writedb_count);
2406 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002407 if( pList->pgno==1 ){
2408 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2409 }
danielk1977687566d2004-11-02 12:56:41 +00002410 }
2411#ifndef NDEBUG
2412 else{
drh4f0c5872007-03-26 22:05:01 +00002413 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002414 }
2415#endif
drh2554f8b2003-01-22 01:26:44 +00002416 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002417#ifdef SQLITE_CHECK_PAGES
2418 pList->pageHash = pager_pagehash(pList);
2419#endif
drh2554f8b2003-01-22 01:26:44 +00002420 pList = pList->pDirty;
2421 }
danielk19778c0a7912008-08-20 14:49:23 +00002422
drh2554f8b2003-01-22 01:26:44 +00002423 return SQLITE_OK;
2424}
2425
2426/*
danielk19778c0a7912008-08-20 14:49:23 +00002427** This function is called by the pcache layer when it has reached some
2428** soft memory limit. The argument is a pointer to a purgeable Pager
2429** object. This function attempts to make a single dirty page that has no
2430** outstanding references (if one exists) clean so that it can be recycled
2431** by the pcache layer.
drh2554f8b2003-01-22 01:26:44 +00002432*/
danielk1977a858aa22008-08-22 16:22:17 +00002433static int pagerStress(void *p, PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002434 Pager *pPager = (Pager *)p;
danielk19778c0a7912008-08-20 14:49:23 +00002435 int rc = SQLITE_OK;
drh8f2e9a12008-02-26 14:46:04 +00002436
danielk19778c200142008-08-25 07:12:28 +00002437 if( pPager->doNotSync ){
2438 return SQLITE_OK;
2439 }
2440
danielk1977a858aa22008-08-22 16:22:17 +00002441 assert( pPg->flags&PGHDR_DIRTY );
2442 if( pPager->errCode==SQLITE_OK ){
2443 if( pPg->flags&PGHDR_NEED_SYNC ){
2444 rc = syncJournal(pPager);
2445 if( rc==SQLITE_OK && pPager->fullSync &&
danielk1977b3175382008-10-17 18:51:52 +00002446 !(pPager->journalMode==PAGER_JOURNALMODE_MEMORY) &&
danielk1977a858aa22008-08-22 16:22:17 +00002447 !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
2448 ){
2449 pPager->nRec = 0;
2450 rc = writeJournalHdr(pPager);
danielk19778c0a7912008-08-20 14:49:23 +00002451 }
danielk19778c0a7912008-08-20 14:49:23 +00002452 }
danielk1977a858aa22008-08-22 16:22:17 +00002453 if( rc==SQLITE_OK ){
2454 pPg->pDirty = 0;
2455 rc = pager_write_pagelist(pPg);
2456 }
2457 if( rc!=SQLITE_OK ){
2458 pager_error(pPager, rc);
2459 }
2460 }
2461
2462 if( rc==SQLITE_OK ){
2463 sqlite3PcacheMakeClean(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00002464 }
2465 return rc;
drh2554f8b2003-01-22 01:26:44 +00002466}
2467
danielk19778c0a7912008-08-20 14:49:23 +00002468
drh2554f8b2003-01-22 01:26:44 +00002469/*
drh19db9352008-03-27 22:42:51 +00002470** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00002471** A hot journal is one that needs to be played back.
2472**
2473** If the current size of the database file is 0 but a journal file
2474** exists, that is probably an old journal left over from a prior
2475** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00002476**
2477** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00002478**
2479** This routine does not open the journal file to examine its
2480** content. Hence, the journal might contain the name of a master
2481** journal file that has been deleted, and hence not be hot. Or
2482** the header of the journal might be zeroed out. This routine
2483** does not discover these cases of a non-hot journal - if the
2484** journal file exists and is not empty this routine assumes it
2485** is hot. The pager_playback() routine will discover that the
2486** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00002487*/
danielk1977d300b8a2008-08-01 10:50:23 +00002488static int hasHotJournal(Pager *pPager, int *pExists){
danielk1977b4b47412007-08-17 15:53:36 +00002489 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977d300b8a2008-08-01 10:50:23 +00002490 int rc = SQLITE_OK;
drh0a846f92008-08-25 17:23:29 +00002491 int exists;
2492 int locked;
2493 assert( pPager!=0 );
2494 assert( pPager->useJournal );
2495 assert( pPager->fd->pMethods );
danielk1977d300b8a2008-08-01 10:50:23 +00002496 *pExists = 0;
drh0a846f92008-08-25 17:23:29 +00002497 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
2498 if( rc==SQLITE_OK && exists ){
2499 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
2500 }
2501 if( rc==SQLITE_OK && exists && !locked ){
2502 int nPage;
2503 rc = sqlite3PagerPagecount(pPager, &nPage);
2504 if( rc==SQLITE_OK ){
2505 if( nPage==0 ){
2506 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2507 }else{
2508 *pExists = 1;
danielk1977861f7452008-06-05 11:39:11 +00002509 }
2510 }
drhbb5f18d2007-04-06 18:23:17 +00002511 }
danielk1977d300b8a2008-08-01 10:50:23 +00002512 return rc;
drh165ffe92005-03-15 17:09:30 +00002513}
2514
2515/*
danielk1977e180dd92007-04-05 17:15:52 +00002516** Read the content of page pPg out of the database file.
2517*/
2518static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2519 int rc;
danielk197762079062007-08-15 17:08:46 +00002520 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002521 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002522 assert(pPager->fd->pMethods||pPager->tempFile);
2523 if( !pPager->fd->pMethods ){
2524 return SQLITE_IOERR_SHORT_READ;
2525 }
danielk197762079062007-08-15 17:08:46 +00002526 offset = (pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002527 rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002528 PAGER_INCR(sqlite3_pager_readdb_count);
2529 PAGER_INCR(pPager->nRead);
2530 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002531 if( pgno==1 ){
danielk19778c0a7912008-08-20 14:49:23 +00002532 memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24],
drh86a88112007-04-16 15:02:19 +00002533 sizeof(pPager->dbFileVers));
2534 }
danielk197730849522008-08-21 04:35:18 +00002535 CODEC1(pPager, pPg->pData, pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002536 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2537 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002538 return rc;
2539}
2540
2541
2542/*
danielk1977e277be02007-03-23 18:12:06 +00002543** This function is called to obtain the shared lock required before
2544** data may be read from the pager cache. If the shared lock has already
2545** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002546**
2547** Immediately after obtaining the shared lock (if required), this function
2548** checks for a hot-journal file. If one is found, an emergency rollback
2549** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002550*/
2551static int pagerSharedLock(Pager *pPager){
2552 int rc = SQLITE_OK;
danielk1977d300b8a2008-08-01 10:50:23 +00002553 int isErrorReset = 0;
danielk1977e277be02007-03-23 18:12:06 +00002554
danielk1977ae72d982007-10-03 08:46:44 +00002555 /* If this database is opened for exclusive access, has no outstanding
2556 ** page references and is in an error-state, now is the chance to clear
2557 ** the error. Discard the contents of the pager-cache and treat any
2558 ** open journal file as a hot-journal.
2559 */
danielk19778c0a7912008-08-20 14:49:23 +00002560 if( !MEMDB && pPager->exclusiveMode
2561 && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode
2562 ){
danielk1977ae72d982007-10-03 08:46:44 +00002563 if( pPager->journalOpen ){
danielk1977d300b8a2008-08-01 10:50:23 +00002564 isErrorReset = 1;
danielk1977ae72d982007-10-03 08:46:44 +00002565 }
danielk1977ae72d982007-10-03 08:46:44 +00002566 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00002567 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00002568 }
2569
2570 /* If the pager is still in an error state, do not proceed. The error
2571 ** state will be cleared at some point in the future when all page
2572 ** references are dropped and the cache can be discarded.
2573 */
2574 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2575 return pPager->errCode;
2576 }
2577
danielk1977d300b8a2008-08-01 10:50:23 +00002578 if( pPager->state==PAGER_UNLOCK || isErrorReset ){
danielk1977b4b47412007-08-17 15:53:36 +00002579 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977b3175382008-10-17 18:51:52 +00002580 int isHotJournal;
shane049fc212008-10-22 16:26:47 +00002581 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00002582 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
2583 if( !pPager->noReadlock ){
2584 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2585 if( rc!=SQLITE_OK ){
2586 assert( pPager->state==PAGER_UNLOCK );
2587 return pager_error(pPager, rc);
danielk1977e277be02007-03-23 18:12:06 +00002588 }
danielk1977b3175382008-10-17 18:51:52 +00002589 assert( pPager->state>=SHARED_LOCK );
2590 }
2591
2592 /* If a journal file exists, and there is no RESERVED lock on the
2593 ** database file, then it either needs to be played back or deleted.
2594 */
2595 if( !isErrorReset ){
2596 rc = hasHotJournal(pPager, &isHotJournal);
2597 if( rc!=SQLITE_OK ){
2598 goto failed;
2599 }
2600 }
2601 if( isErrorReset || isHotJournal ){
2602 /* Get an EXCLUSIVE lock on the database file. At this point it is
2603 ** important that a RESERVED lock is not obtained on the way to the
2604 ** EXCLUSIVE lock. If it were, another process might open the
2605 ** database file, detect the RESERVED lock, and conclude that the
2606 ** database is safe to read while this process is still rolling it
2607 ** back.
2608 **
2609 ** Because the intermediate RESERVED lock is not requested, the
2610 ** second process will get to this point in the code and fail to
2611 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00002612 */
danielk1977b3175382008-10-17 18:51:52 +00002613 if( pPager->state<EXCLUSIVE_LOCK ){
2614 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
danielk1977e277be02007-03-23 18:12:06 +00002615 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002616 rc = pager_error(pPager, rc);
2617 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002618 }
danielk1977b3175382008-10-17 18:51:52 +00002619 pPager->state = PAGER_EXCLUSIVE;
2620 }
2621
2622 /* Open the journal for read/write access. This is because in
2623 ** exclusive-access mode the file descriptor will be kept open and
2624 ** possibly used for a transaction later on. On some systems, the
2625 ** OsTruncate() call used in exclusive-access mode also requires
2626 ** a read/write file handle.
2627 */
2628 if( !isErrorReset && pPager->journalOpen==0 ){
2629 int res;
2630 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
2631 if( rc==SQLITE_OK ){
2632 if( res ){
2633 int fout = 0;
2634 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
2635 assert( !pPager->tempFile );
2636 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
2637 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk1977281d8bd2008-10-29 07:01:56 +00002638 if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
2639 rc = SQLITE_CANTOPEN;
danielk1977b3175382008-10-17 18:51:52 +00002640 sqlite3OsClose(pPager->jfd);
2641 }
2642 }else{
2643 /* If the journal does not exist, that means some other process
2644 ** has already rolled it back */
2645 rc = SQLITE_BUSY;
2646 }
2647 }
2648 }
2649 if( rc!=SQLITE_OK ){
danielk1977b3175382008-10-17 18:51:52 +00002650 goto failed;
2651 }
2652 pPager->journalOpen = 1;
2653 pPager->journalStarted = 0;
2654 pPager->journalOff = 0;
2655 pPager->setMaster = 0;
2656 pPager->journalHdr = 0;
2657
2658 /* Playback and delete the journal. Drop the database write
2659 ** lock and reacquire the read lock.
2660 */
2661 rc = pager_playback(pPager, 1);
2662 if( rc!=SQLITE_OK ){
2663 rc = pager_error(pPager, rc);
2664 goto failed;
2665 }
2666 assert(pPager->state==PAGER_SHARED ||
2667 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2668 );
2669 }
2670
2671 if( sqlite3PcachePagecount(pPager->pPCache)>0 ){
2672 /* The shared-lock has just been acquired on the database file
2673 ** and there are already pages in the cache (from a previous
2674 ** read or write transaction). Check to see if the database
2675 ** has been modified. If the database has changed, flush the
2676 ** cache.
2677 **
2678 ** Database changes is detected by looking at 15 bytes beginning
2679 ** at offset 24 into the file. The first 4 of these 16 bytes are
2680 ** a 32-bit counter that is incremented with each change. The
2681 ** other bytes change randomly with each file change when
2682 ** a codec is in use.
2683 **
2684 ** There is a vanishingly small chance that a change will not be
2685 ** detected. The chance of an undetected change is so small that
2686 ** it can be neglected.
2687 */
2688 char dbFileVers[sizeof(pPager->dbFileVers)];
2689 sqlite3PagerPagecount(pPager, 0);
2690
2691 if( pPager->errCode ){
2692 rc = pPager->errCode;
2693 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002694 }
2695
danielk1977b3175382008-10-17 18:51:52 +00002696 if( pPager->dbSize>0 ){
2697 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
2698 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
2699 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002700 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002701 }
danielk1977b3175382008-10-17 18:51:52 +00002702 }else{
2703 memset(dbFileVers, 0, sizeof(dbFileVers));
2704 }
danielk1977e277be02007-03-23 18:12:06 +00002705
danielk1977b3175382008-10-17 18:51:52 +00002706 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
2707 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002708 }
2709 }
danielk1977c5859712007-03-26 12:26:27 +00002710 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2711 if( pPager->state==PAGER_UNLOCK ){
2712 pPager->state = PAGER_SHARED;
2713 }
danielk1977e277be02007-03-23 18:12:06 +00002714 }
2715
danielk197752b472a2008-05-05 16:23:55 +00002716 failed:
2717 if( rc!=SQLITE_OK ){
2718 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
2719 pager_unlock(pPager);
2720 }
danielk1977e277be02007-03-23 18:12:06 +00002721 return rc;
2722}
2723
2724/*
drhd33d5a82007-04-26 12:11:28 +00002725** Make sure we have the content for a page. If the page was
2726** previously acquired with noContent==1, then the content was
2727** just initialized to zeros instead of being read from disk.
2728** But now we need the real data off of disk. So make sure we
2729** have it. Read it in if we do not have it already.
2730*/
2731static int pager_get_content(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002732 if( pPg->flags&PGHDR_NEED_READ ){
drhd33d5a82007-04-26 12:11:28 +00002733 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
2734 if( rc==SQLITE_OK ){
danielk19778c0a7912008-08-20 14:49:23 +00002735 pPg->flags &= ~PGHDR_NEED_READ;
drhd33d5a82007-04-26 12:11:28 +00002736 }else{
2737 return rc;
2738 }
2739 }
2740 return SQLITE_OK;
2741}
2742
2743/*
danielk19778c0a7912008-08-20 14:49:23 +00002744** If the reference count has reached zero, and the pager is not in the
2745** middle of a write transaction or opened in exclusive mode, unlock it.
2746*/
2747static void pagerUnlockIfUnused(Pager *pPager){
2748 if( (sqlite3PcacheRefCount(pPager->pPCache)==0)
2749 && (!pPager->exclusiveMode || pPager->journalOff>0)
2750 ){
2751 pagerUnlockAndRollback(pPager);
2752 }
2753}
2754
2755/*
2756** Drop a page from the cache using sqlite3PcacheDrop().
2757**
2758** If this means there are now no pages with references to them, a rollback
2759** occurs and the lock on the database is removed.
2760*/
2761static void pagerDropPage(DbPage *pPg){
2762 Pager *pPager = pPg->pPager;
2763 sqlite3PcacheDrop(pPg);
2764 pagerUnlockIfUnused(pPager);
2765}
2766
2767/*
drhd9b02572001-04-15 00:37:09 +00002768** Acquire a page.
2769**
drh58a11682001-11-10 13:51:08 +00002770** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002771** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002772**
drhd33d5a82007-04-26 12:11:28 +00002773** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00002774** file is smaller than the requested page, then no actual disk
2775** read occurs and the memory image of the page is initialized to
2776** all zeros. The extra data appended to a page is always initialized
2777** to zeros the first time a page is loaded into memory.
2778**
drhd9b02572001-04-15 00:37:09 +00002779** The acquisition might fail for several reasons. In all cases,
2780** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002781**
drhd33d5a82007-04-26 12:11:28 +00002782** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002783** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00002784** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00002785** just returns 0. This routine acquires a read-lock the first time it
2786** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00002787** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00002788** or journal files.
drh0787db62007-03-04 13:15:27 +00002789**
drh538f5702007-04-13 02:14:30 +00002790** If noContent is false, the page contents are actually read from disk.
2791** If noContent is true, it means that we do not care about the contents
2792** of the page at this time, so do not do a disk read. Just fill in the
2793** page content with zeros. But mark the fact that we have not read the
2794** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00002795** sqlite3PagerWrite() is called on this page or if this routine is
2796** called again with noContent==0, that means that the content is needed
2797** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002798*/
danielk197765e0ff32008-09-19 09:14:43 +00002799int sqlite3PagerAcquire(
drh538f5702007-04-13 02:14:30 +00002800 Pager *pPager, /* The pager open on the database file */
2801 Pgno pgno, /* Page number to fetch */
2802 DbPage **ppPage, /* Write a pointer to the page here */
2803 int noContent /* Do not bother reading content from disk if true */
2804){
danielk19778c0a7912008-08-20 14:49:23 +00002805 PgHdr *pPg = 0;
drh165ffe92005-03-15 17:09:30 +00002806 int rc;
drhed7c8552001-04-11 14:29:21 +00002807
danielk19778c0a7912008-08-20 14:49:23 +00002808 assert( pPager->state==PAGER_UNLOCK
2809 || sqlite3PcacheRefCount(pPager->pPCache)>0
danielk1977b3175382008-10-17 18:51:52 +00002810 || pgno==1
danielk19778c0a7912008-08-20 14:49:23 +00002811 );
danielk1977e277be02007-03-23 18:12:06 +00002812
danielk197726836652005-01-17 01:33:13 +00002813 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2814 ** number greater than this, or zero, is requested.
2815 */
drh267cb322005-09-16 17:16:52 +00002816 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002817 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002818 }
2819
drhd9b02572001-04-15 00:37:09 +00002820 /* Make sure we have not hit any critical errors.
2821 */
drh836faa42003-01-11 13:30:57 +00002822 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002823 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002824
danielk197713adf8a2004-06-03 16:08:41 +00002825 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002826 ** on the database file. pagerSharedLock() is a no-op if
2827 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002828 */
danielk1977e277be02007-03-23 18:12:06 +00002829 rc = pagerSharedLock(pPager);
2830 if( rc!=SQLITE_OK ){
2831 return rc;
drhed7c8552001-04-11 14:29:21 +00002832 }
danielk1977e277be02007-03-23 18:12:06 +00002833 assert( pPager->state!=PAGER_UNLOCK );
2834
danielk19778c0a7912008-08-20 14:49:23 +00002835 rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg);
2836 if( rc!=SQLITE_OK ){
2837 return rc;
2838 }
danielk19778c0a7912008-08-20 14:49:23 +00002839 if( pPg->pPager==0 ){
2840 /* The pager cache has created a new page. Its content needs to
2841 ** be initialized.
2842 */
danielk1977979f38e2007-03-27 16:19:51 +00002843 int nMax;
drh538f5702007-04-13 02:14:30 +00002844 PAGER_INCR(pPager->nMiss);
danielk19778c0a7912008-08-20 14:49:23 +00002845 pPg->pPager = pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002846 memset(pPg->pExtra, 0, pPager->nExtra);
danielk197724168722007-04-02 05:07:47 +00002847
danielk1977ad0132d2008-06-07 08:58:22 +00002848 rc = sqlite3PagerPagecount(pPager, &nMax);
2849 if( rc!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002850 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00002851 return rc;
2852 }
danielk197775bab7d2006-01-23 13:09:45 +00002853
danielk1977a1fa00d2008-08-27 15:16:33 +00002854 if( nMax<(int)pgno || MEMDB || noContent ){
drhf8e632b2007-05-08 14:51:36 +00002855 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00002856 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00002857 return SQLITE_FULL;
2858 }
danielk19778c0a7912008-08-20 14:49:23 +00002859 memset(pPg->pData, 0, pPager->pageSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00002860 if( noContent ){
danielk19778c0a7912008-08-20 14:49:23 +00002861 pPg->flags |= PGHDR_NEED_READ;
2862 }
drh538f5702007-04-13 02:14:30 +00002863 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00002864 }else{
danielk1977e180dd92007-04-05 17:15:52 +00002865 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00002866 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
danielk19778c0a7912008-08-20 14:49:23 +00002867 /* sqlite3PagerUnref(pPg); */
2868 pagerDropPage(pPg);
drh551b7732006-11-06 21:20:25 +00002869 return rc;
drh81a20f22001-10-12 17:30:04 +00002870 }
drh306dc212001-05-21 13:45:10 +00002871 }
danielk19773c407372005-02-15 02:54:14 +00002872#ifdef SQLITE_CHECK_PAGES
2873 pPg->pageHash = pager_pagehash(pPg);
2874#endif
drhed7c8552001-04-11 14:29:21 +00002875 }else{
drhd9b02572001-04-15 00:37:09 +00002876 /* The requested page is in the page cache. */
danielk19778c0a7912008-08-20 14:49:23 +00002877 assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00002878 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00002879 if( !noContent ){
2880 rc = pager_get_content(pPg);
2881 if( rc ){
danielk19778c0a7912008-08-20 14:49:23 +00002882 sqlite3PagerUnref(pPg);
drhd33d5a82007-04-26 12:11:28 +00002883 return rc;
2884 }
2885 }
drhed7c8552001-04-11 14:29:21 +00002886 }
danielk19778c0a7912008-08-20 14:49:23 +00002887
danielk19773b8a05f2007-03-19 17:44:26 +00002888 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00002889 return SQLITE_OK;
2890}
danielk19778c0a7912008-08-20 14:49:23 +00002891
drhed7c8552001-04-11 14:29:21 +00002892/*
drh7e3b0a02001-04-28 16:52:40 +00002893** Acquire a page if it is already in the in-memory cache. Do
2894** not read the page from disk. Return a pointer to the page,
2895** or 0 if the page is not in cache.
2896**
danielk19773b8a05f2007-03-19 17:44:26 +00002897** See also sqlite3PagerGet(). The difference between this routine
2898** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002899** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002900** returns NULL if the page is not in cache or if a disk I/O error
2901** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002902*/
danielk19773b8a05f2007-03-19 17:44:26 +00002903DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00002904 PgHdr *pPg = 0;
drh836faa42003-01-11 13:30:57 +00002905 assert( pPager!=0 );
2906 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00002907
danielk19778c0a7912008-08-20 14:49:23 +00002908 if( (pPager->state!=PAGER_UNLOCK)
2909 && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL)
2910 ){
2911 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg);
danielk1977e277be02007-03-23 18:12:06 +00002912 }
danielk19778c0a7912008-08-20 14:49:23 +00002913
danielk19773b8a05f2007-03-19 17:44:26 +00002914 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00002915}
2916
2917/*
drhed7c8552001-04-11 14:29:21 +00002918** Release a page.
2919**
2920** If the number of references to the page drop to zero, then the
2921** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002922** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002923** removed.
2924*/
danielk19773b8a05f2007-03-19 17:44:26 +00002925int sqlite3PagerUnref(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002926 if( pPg ){
2927 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002928 sqlite3PcacheRelease(pPg);
2929 pagerUnlockIfUnused(pPager);
drhed7c8552001-04-11 14:29:21 +00002930 }
drhd9b02572001-04-15 00:37:09 +00002931 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002932}
2933
2934/*
drha6abd042004-06-09 17:37:22 +00002935** Create a journal file for pPager. There should already be a RESERVED
2936** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002937**
2938** Return SQLITE_OK if everything. Return an error code and release the
2939** write lock if anything goes wrong.
2940*/
2941static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00002942 sqlite3_vfs *pVfs = pPager->pVfs;
2943 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
2944
drhda47d772002-12-02 04:25:19 +00002945 int rc;
drha6abd042004-06-09 17:37:22 +00002946 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002947 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00002948 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00002949 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00002950 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00002951 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002952 rc = SQLITE_NOMEM;
2953 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002954 }
danielk1977b4b47412007-08-17 15:53:36 +00002955
drhfdc40e92008-04-17 20:59:37 +00002956 if( pPager->journalOpen==0 ){
2957 if( pPager->tempFile ){
2958 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
2959 }else{
2960 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00002961 }
danielk1977b3175382008-10-17 18:51:52 +00002962 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
2963 sqlite3MemJournalOpen(pPager->jfd);
2964 rc = SQLITE_OK;
2965 }else{
drhfdc40e92008-04-17 20:59:37 +00002966#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977b3175382008-10-17 18:51:52 +00002967 rc = sqlite3JournalOpen(
2968 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
2969 );
drhfdc40e92008-04-17 20:59:37 +00002970#else
danielk1977b3175382008-10-17 18:51:52 +00002971 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
drhfdc40e92008-04-17 20:59:37 +00002972#endif
danielk1977b3175382008-10-17 18:51:52 +00002973 }
drhfdc40e92008-04-17 20:59:37 +00002974 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
2975 pPager->journalOff = 0;
2976 pPager->setMaster = 0;
2977 pPager->journalHdr = 0;
2978 if( rc!=SQLITE_OK ){
2979 if( rc==SQLITE_NOMEM ){
2980 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2981 }
2982 goto failed_to_open_journal;
2983 }
drhda47d772002-12-02 04:25:19 +00002984 }
2985 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002986 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002987 pPager->needSync = 0;
drh968af522003-02-11 14:55:40 +00002988 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00002989 if( pPager->errCode ){
2990 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00002991 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00002992 }
drhda47d772002-12-02 04:25:19 +00002993 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002994
danielk197776572402004-06-25 02:38:54 +00002995 rc = writeJournalHdr(pPager);
2996
drhac69b052004-05-12 13:30:07 +00002997 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00002998 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00002999 }
danielk1977ae72d982007-10-03 08:46:44 +00003000 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003001 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003002 if( rc==SQLITE_OK ){
3003 rc = SQLITE_FULL;
3004 }
3005 }
drh9c105bb2004-10-02 20:38:28 +00003006 return rc;
3007
3008failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003009 sqlite3BitvecDestroy(pPager->pInJournal);
3010 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003011 return rc;
drhda47d772002-12-02 04:25:19 +00003012}
3013
3014/*
drh4b845d72002-03-05 12:41:19 +00003015** Acquire a write-lock on the database. The lock is removed when
3016** the any of the following happen:
3017**
drh80e35f42007-03-30 14:06:34 +00003018** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003019** * sqlite3PagerRollback() is called.
3020** * sqlite3PagerClose() is called.
3021** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003022**
danielk197713adf8a2004-06-03 16:08:41 +00003023** The first parameter to this routine is a pointer to any open page of the
3024** database file. Nothing changes about the page - it is used merely to
3025** acquire a pointer to the Pager structure and as proof that there is
3026** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003027**
danielk197713adf8a2004-06-03 16:08:41 +00003028** The second parameter indicates how much space in bytes to reserve for a
3029** master journal file-name at the start of the journal when it is created.
3030**
3031** A journal file is opened if this is not a temporary file. For temporary
3032** files, the opening of the journal file is deferred until there is an
3033** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003034**
drha6abd042004-06-09 17:37:22 +00003035** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003036**
3037** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3038** immediately instead of waiting until we try to flush the cache. The
3039** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003040*/
danielk19773b8a05f2007-03-19 17:44:26 +00003041int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003042 Pager *pPager = pPg->pPager;
3043 int rc = SQLITE_OK;
3044 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003045 assert( pPager->state!=PAGER_UNLOCK );
3046 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003047 assert( pPager->pInJournal==0 );
danielk1977b3175382008-10-17 18:51:52 +00003048 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00003049 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
3050 if( rc==SQLITE_OK ){
3051 pPager->state = PAGER_RESERVED;
3052 if( exFlag ){
3053 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh684917c2004-10-05 02:41:42 +00003054 }
danielk1977b3175382008-10-17 18:51:52 +00003055 }
3056 if( rc!=SQLITE_OK ){
3057 return rc;
3058 }
3059 pPager->dirtyCache = 0;
3060 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
3061 if( pPager->useJournal && !pPager->tempFile
3062 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
3063 rc = pager_open_journal(pPager);
drh4b845d72002-03-05 12:41:19 +00003064 }
danielk1977334cdb62007-03-26 08:05:12 +00003065 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00003066 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00003067 ** time a (read or write) transaction was successfully concluded
3068 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00003069 ** kept open and either was truncated to 0 bytes or its header was
3070 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00003071 */
3072 assert( pPager->nRec==0 );
3073 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003074 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003075 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003076 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhf5e7bb52008-02-18 14:47:33 +00003077 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003078 rc = SQLITE_NOMEM;
3079 }else{
drh369339d2007-03-30 16:01:55 +00003080 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003081 rc = writeJournalHdr(pPager);
3082 }
drh4b845d72002-03-05 12:41:19 +00003083 }
danielk1977334cdb62007-03-26 08:05:12 +00003084 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003085 return rc;
3086}
3087
3088/*
drh605ad8f2006-05-03 23:34:05 +00003089** Make a page dirty. Set its dirty flag and add it to the dirty
3090** page list.
3091*/
3092static void makeDirty(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003093 sqlite3PcacheMakeDirty(pPg);
drh605ad8f2006-05-03 23:34:05 +00003094}
3095
3096/*
3097** Make a page clean. Clear its dirty bit and remove it from the
3098** dirty page list.
3099*/
3100static void makeClean(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003101 sqlite3PcacheMakeClean(pPg);
drh605ad8f2006-05-03 23:34:05 +00003102}
3103
3104
3105/*
drhed7c8552001-04-11 14:29:21 +00003106** Mark a data page as writeable. The page is written into the journal
3107** if it is not there already. This routine must be called before making
3108** changes to a page.
3109**
3110** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003111** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003112** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003113** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003114** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003115**
3116** If the journal file could not be written because the disk is full,
3117** then this routine returns SQLITE_FULL and does an immediate rollback.
3118** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003119** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003120** reset.
drhed7c8552001-04-11 14:29:21 +00003121*/
danielk19773b8a05f2007-03-19 17:44:26 +00003122static int pager_write(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003123 void *pData = pPg->pData;
drh69688d52001-04-14 16:38:23 +00003124 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003125 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003126
drh6446c4d2001-12-15 14:22:18 +00003127 /* Check for errors
3128 */
danielk1977efaaf572006-01-16 11:29:19 +00003129 if( pPager->errCode ){
3130 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003131 }
drh5e00f6c2001-09-13 13:46:56 +00003132 if( pPager->readOnly ){
3133 return SQLITE_PERM;
3134 }
drh6446c4d2001-12-15 14:22:18 +00003135
danielk197776572402004-06-25 02:38:54 +00003136 assert( !pPager->setMaster );
3137
danielk19773c407372005-02-15 02:54:14 +00003138 CHECK_PAGE(pPg);
3139
drh538f5702007-04-13 02:14:30 +00003140 /* If this page was previously acquired with noContent==1, that means
3141 ** we didn't really read in the content of the page. This can happen
3142 ** (for example) when the page is being moved to the freelist. But
3143 ** now we are (perhaps) moving the page off of the freelist for
3144 ** reuse and we need to know its original content so that content
3145 ** can be stored in the rollback journal. So do the read at this
3146 ** time.
3147 */
drhd33d5a82007-04-26 12:11:28 +00003148 rc = pager_get_content(pPg);
3149 if( rc ){
3150 return rc;
drh538f5702007-04-13 02:14:30 +00003151 }
3152
drh6446c4d2001-12-15 14:22:18 +00003153 /* Mark the page as dirty. If the page has already been written
3154 ** to the journal then we can return right away.
3155 */
drh605ad8f2006-05-03 23:34:05 +00003156 makeDirty(pPg);
danielk1977bc2ca9e2008-11-13 14:28:28 +00003157 if( pageInJournal(pPg) && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00003158 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003159 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003160 }else{
drh6446c4d2001-12-15 14:22:18 +00003161
danielk1977a0bf2652004-11-04 14:30:04 +00003162 /* If we get this far, it means that the page needs to be
3163 ** written to the transaction journal or the ckeckpoint journal
3164 ** or both.
3165 **
3166 ** First check to see that the transaction journal exists and
3167 ** create it if it does not.
3168 */
3169 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003170 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003171 if( rc!=SQLITE_OK ){
3172 return rc;
3173 }
3174 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00003175 if( !pPager->journalOpen && pPager->useJournal
3176 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00003177 rc = pager_open_journal(pPager);
3178 if( rc!=SQLITE_OK ) return rc;
3179 }
danielk1977a0bf2652004-11-04 14:30:04 +00003180 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003181 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003182
3183 /* The transaction journal now exists and we have a RESERVED or an
3184 ** EXCLUSIVE lock on the main database file. Write the current page to
3185 ** the transaction journal if it is not there already.
3186 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00003187 if( !pageInJournal(pPg) && pPager->journalOpen ){
danielk1977a0bf2652004-11-04 14:30:04 +00003188 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977b3175382008-10-17 18:51:52 +00003189 u32 cksum;
3190 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00003191
danielk1977b3175382008-10-17 18:51:52 +00003192 /* We should never write to the journal file the page that
3193 ** contains the database locks. The following assert verifies
3194 ** that we do not. */
3195 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
3196 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
3197 cksum = pager_cksum(pPager, (u8*)pData2);
3198 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
3199 if( rc==SQLITE_OK ){
3200 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
3201 pPager->journalOff + 4);
3202 pPager->journalOff += pPager->pageSize+4;
3203 }
3204 if( rc==SQLITE_OK ){
3205 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
3206 pPager->journalOff += 4;
3207 }
3208 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
3209 pPager->journalOff, pPager->pageSize));
3210 PAGER_INCR(sqlite3_pager_writej_count);
3211 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
3212 PAGERID(pPager), pPg->pgno,
3213 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00003214
danielk1977b3175382008-10-17 18:51:52 +00003215 /* An error has occured writing to the journal file. The
3216 ** transaction will be rolled back by the layer above.
3217 */
3218 if( rc!=SQLITE_OK ){
3219 return rc;
3220 }
danielk197707cb5602006-01-20 10:55:05 +00003221
danielk1977b3175382008-10-17 18:51:52 +00003222 pPager->nRec++;
3223 assert( pPager->pInJournal!=0 );
3224 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
3225 if( !pPager->noSync ){
3226 pPg->flags |= PGHDR_NEED_SYNC;
3227 }
3228 if( pPager->stmtInUse ){
3229 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003230 }
danielk197713adf8a2004-06-03 16:08:41 +00003231 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003232 if( !pPager->journalStarted && !pPager->noSync ){
3233 pPg->flags |= PGHDR_NEED_SYNC;
3234 }
drh4f0c5872007-03-26 22:05:01 +00003235 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk19778c0a7912008-08-20 14:49:23 +00003236 PAGERID(pPager), pPg->pgno,
3237 ((pPg->flags&PGHDR_NEED_SYNC)?1:0));
danielk1977a0bf2652004-11-04 14:30:04 +00003238 }
danielk19778c0a7912008-08-20 14:49:23 +00003239 if( pPg->flags&PGHDR_NEED_SYNC ){
danielk1977a0bf2652004-11-04 14:30:04 +00003240 pPager->needSync = 1;
3241 }
danielk1977a0bf2652004-11-04 14:30:04 +00003242 }
3243
3244 /* If the statement journal is open and the page is not in it,
3245 ** then write the current page to the statement journal. Note that
3246 ** the statement journal format differs from the standard journal format
3247 ** in that it omits the checksums and the header.
3248 */
danielk1977f35843b2007-04-07 15:03:17 +00003249 if( pPager->stmtInUse
3250 && !pageInStatement(pPg)
3251 && (int)pPg->pgno<=pPager->stmtSize
3252 ){
danielk1977b3175382008-10-17 18:51:52 +00003253 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
3254 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
danielk1977bc2ca9e2008-11-13 14:28:28 +00003255 assert( pageInJournal(pPg) || (int)pPg->pgno>pPager->origDbSize );
danielk1977b3175382008-10-17 18:51:52 +00003256 rc = write32bits(pPager->stfd, offset, pPg->pgno);
3257 if( rc==SQLITE_OK ){
3258 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
drhdb48ee02003-01-16 13:42:43 +00003259 }
danielk1977b3175382008-10-17 18:51:52 +00003260 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
3261 if( rc!=SQLITE_OK ){
3262 return rc;
3263 }
3264 pPager->stmtNRec++;
3265 assert( pPager->pInStmt!=0 );
3266 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhd9b02572001-04-15 00:37:09 +00003267 }
drhfa86c412002-02-02 15:01:15 +00003268 }
3269
3270 /* Update the database size and return.
3271 */
drh1aa2d8b2007-01-03 15:34:29 +00003272 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00003273 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003274 pPager->dbSize = pPg->pgno;
danielk1977b3175382008-10-17 18:51:52 +00003275 if( pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003276 pPager->dbSize++;
3277 }
drh306dc212001-05-21 13:45:10 +00003278 }
drh69688d52001-04-14 16:38:23 +00003279 return rc;
drhed7c8552001-04-11 14:29:21 +00003280}
3281
3282/*
danielk19774099f6e2007-03-19 11:25:20 +00003283** This function is used to mark a data-page as writable. It uses
3284** pager_write() to open a journal file (if it is not already open)
3285** and write the page *pData to the journal.
3286**
3287** The difference between this function and pager_write() is that this
3288** function also deals with the special case where 2 or more pages
3289** fit on a single disk sector. In this case all co-resident pages
3290** must have been written to the journal file before returning.
3291*/
danielk19773b8a05f2007-03-19 17:44:26 +00003292int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003293 int rc = SQLITE_OK;
3294
danielk19773b8a05f2007-03-19 17:44:26 +00003295 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003296 Pager *pPager = pPg->pPager;
3297 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3298
danielk1977b3175382008-10-17 18:51:52 +00003299 if( nPagePerSector>1 ){
danielk19774099f6e2007-03-19 11:25:20 +00003300 Pgno nPageCount; /* Total number of pages in database file */
3301 Pgno pg1; /* First page of the sector pPg is located on. */
3302 int nPage; /* Number of pages starting at pg1 to journal */
3303 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003304 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003305
3306 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3307 ** header to be written between the pages journaled by this function.
3308 */
danielk1977b3175382008-10-17 18:51:52 +00003309 assert( !MEMDB );
danielk19774099f6e2007-03-19 11:25:20 +00003310 assert( pPager->doNotSync==0 );
3311 pPager->doNotSync = 1;
3312
3313 /* This trick assumes that both the page-size and sector-size are
3314 ** an integer power of 2. It sets variable pg1 to the identifier
3315 ** of the first page of the sector pPg is located on.
3316 */
3317 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3318
danielk1977ad0132d2008-06-07 08:58:22 +00003319 sqlite3PagerPagecount(pPager, (int *)&nPageCount);
danielk19774099f6e2007-03-19 11:25:20 +00003320 if( pPg->pgno>nPageCount ){
3321 nPage = (pPg->pgno - pg1)+1;
3322 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3323 nPage = nPageCount+1-pg1;
3324 }else{
3325 nPage = nPagePerSector;
3326 }
3327 assert(nPage>0);
3328 assert(pg1<=pPg->pgno);
3329 assert((pg1+nPage)>pPg->pgno);
3330
3331 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3332 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003333 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00003334 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00003335 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003336 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003337 if( rc==SQLITE_OK ){
3338 rc = pager_write(pPage);
danielk19778c0a7912008-08-20 14:49:23 +00003339 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003340 needSync = 1;
3341 }
danielk19773b8a05f2007-03-19 17:44:26 +00003342 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003343 }
3344 }
drhc81945e2008-03-10 14:12:53 +00003345 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk19778c0a7912008-08-20 14:49:23 +00003346 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003347 needSync = 1;
3348 }
danielk19778c0a7912008-08-20 14:49:23 +00003349 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003350 }
3351 }
3352
danielk1977dd97a492007-08-22 18:54:32 +00003353 /* If the PgHdr.needSync flag is set for any of the nPage pages
3354 ** starting at pg1, then it needs to be set for all of them. Because
3355 ** writing to any of these nPage pages may damage the others, the
3356 ** journal file must contain sync()ed copies of all of them
3357 ** before any of them can be written out to the database file.
3358 */
3359 if( needSync ){
drhb3df2e12008-09-17 20:06:26 +00003360 assert( !MEMDB && pPager->noSync==0 );
danielk1977dd97a492007-08-22 18:54:32 +00003361 for(ii=0; ii<nPage && needSync; ii++){
3362 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
danielk19778c0a7912008-08-20 14:49:23 +00003363 if( pPage ) pPage->flags |= PGHDR_NEED_SYNC;
3364 sqlite3PagerUnref(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003365 }
3366 assert(pPager->needSync);
3367 }
3368
danielk19774099f6e2007-03-19 11:25:20 +00003369 assert( pPager->doNotSync==1 );
3370 pPager->doNotSync = 0;
3371 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003372 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003373 }
3374 return rc;
3375}
3376
3377/*
drhaacc5432002-01-06 17:07:40 +00003378** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003379** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003380** to change the content of the page.
3381*/
danielk19777d3a6662006-01-23 16:21:05 +00003382#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003383int sqlite3PagerIswriteable(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003384 return pPg->flags&PGHDR_DIRTY;
drh6019e162001-07-02 17:51:45 +00003385}
danielk19777d3a6662006-01-23 16:21:05 +00003386#endif
drh6019e162001-07-02 17:51:45 +00003387
drh001bbcb2003-03-19 03:14:00 +00003388/*
drh30e58752002-03-02 20:41:57 +00003389** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003390** write the information on page pPg back to the disk, even though
drhdfe88ec2008-11-03 20:55:06 +00003391** that page might be marked as dirty. This happens, for example, when
3392** the page has been added as a leaf of the freelist and so its
3393** content no longer matters.
drh30e58752002-03-02 20:41:57 +00003394**
3395** The overlying software layer calls this routine when all of the data
3396** on the given page is unused. The pager marks the page as clean so
3397** that it does not get written to disk.
3398**
3399** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003400** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003401** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003402**
3403** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003404** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003405** will thereafter be ignored. This is necessary to avoid a problem
3406** where a page with data is added to the freelist during one part of
3407** a transaction then removed from the freelist during a later part
3408** of the same transaction and reused for some other purpose. When it
3409** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003410** the sqlite3PagerDontRollback() routine is called. But because the
3411** page contains critical data, we still need to be sure it gets
3412** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003413*/
danielk1977a1fa00d2008-08-27 15:16:33 +00003414int sqlite3PagerDontWrite(DbPage *pDbPage){
drh538f5702007-04-13 02:14:30 +00003415 PgHdr *pPg = pDbPage;
3416 Pager *pPager = pPg->pPager;
danielk1977a1fa00d2008-08-27 15:16:33 +00003417 int rc;
drh8e298f92002-07-06 16:28:47 +00003418
danielk1977b3175382008-10-17 18:51:52 +00003419 if( pPg->pgno>pPager->origDbSize ){
danielk1977a1fa00d2008-08-27 15:16:33 +00003420 return SQLITE_OK;
3421 }
3422 if( pPager->pAlwaysRollback==0 ){
3423 assert( pPager->pInJournal );
3424 pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->origDbSize);
3425 if( !pPager->pAlwaysRollback ){
3426 return SQLITE_NOMEM;
3427 }
3428 }
3429 rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno);
3430
3431 if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00003432 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00003433 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
3434 /* If this pages is the last page in the file and the file has grown
3435 ** during the current transaction, then do NOT mark the page as clean.
3436 ** When the database file grows, we must make sure that the last page
3437 ** gets written at least once so that the disk file will be the correct
3438 ** size. If you do not write this page and the size of the file
3439 ** on the disk ends up being too small, that can lead to database
3440 ** corruption during the next transaction.
3441 */
3442 }else{
drh538f5702007-04-13 02:14:30 +00003443 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3444 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
danielk197733e32162008-08-23 18:53:08 +00003445 pPg->flags |= PGHDR_DONT_WRITE;
danielk19773c407372005-02-15 02:54:14 +00003446#ifdef SQLITE_CHECK_PAGES
3447 pPg->pageHash = pager_pagehash(pPg);
3448#endif
drh8124a302002-06-25 14:43:57 +00003449 }
drh30e58752002-03-02 20:41:57 +00003450 }
danielk1977a1fa00d2008-08-27 15:16:33 +00003451 return rc;
drh30e58752002-03-02 20:41:57 +00003452}
3453
3454/*
3455** A call to this routine tells the pager that if a rollback occurs,
3456** it is not necessary to restore the data on the given page. This
3457** means that the pager does not have to record the given page in the
3458** rollback journal.
drh538f5702007-04-13 02:14:30 +00003459**
3460** If we have not yet actually read the content of this page (if
3461** the PgHdr.needRead flag is set) then this routine acts as a promise
3462** that we will never need to read the page content in the future.
3463** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003464*/
danielk19773b8a05f2007-03-19 17:44:26 +00003465void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003466 Pager *pPager = pPg->pPager;
3467
drhd3627af2006-12-18 18:34:51 +00003468 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00003469
3470 /* If the journal file is not open, or DontWrite() has been called on
3471 ** this page (DontWrite() sets the alwaysRollback flag), then this
3472 ** function is a no-op.
3473 */
danielk1977a1fa00d2008-08-27 15:16:33 +00003474 if( pPager->journalOpen==0
3475 || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno)
3476 || pPg->pgno>pPager->origDbSize
danielk19778c0a7912008-08-20 14:49:23 +00003477 ){
danielk197787c29a92008-01-18 11:33:16 +00003478 return;
3479 }
danielk1977a55e9352008-01-21 13:04:34 +00003480
drhc5d0bd92008-04-14 01:00:57 +00003481#ifdef SQLITE_SECURE_DELETE
drha85f7e32008-08-28 02:26:07 +00003482 if( (pPg->flags & PGHDR_IN_JOURNAL)!=0 || (int)pPg->pgno>pPager->origDbSize ){
drhc5d0bd92008-04-14 01:00:57 +00003483 return;
3484 }
3485#endif
3486
3487 /* If SECURE_DELETE is disabled, then there is no way that this
3488 ** routine can be called on a page for which sqlite3PagerDontWrite()
3489 ** has not been previously called during the same transaction.
3490 ** And if DontWrite() has previously been called, the following
3491 ** conditions must be met.
drh10131482008-07-11 03:34:09 +00003492 **
3493 ** (Later:) Not true. If the database is corrupted by having duplicate
3494 ** pages on the freelist (ex: corrupt9.test) then the following is not
3495 ** necessarily true:
danielk1977a55e9352008-01-21 13:04:34 +00003496 */
drh10131482008-07-11 03:34:09 +00003497 /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ); */
danielk1977a55e9352008-01-21 13:04:34 +00003498
drhf5e7bb52008-02-18 14:47:33 +00003499 assert( pPager->pInJournal!=0 );
3500 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003501 pPg->flags &= ~PGHDR_NEED_READ;
danielk1977a55e9352008-01-21 13:04:34 +00003502 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00003503 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00003504 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00003505 }
danielk1977a55e9352008-01-21 13:04:34 +00003506 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
3507 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003508}
3509
drhac69b052004-05-12 13:30:07 +00003510
drh30e58752002-03-02 20:41:57 +00003511/*
drh80e35f42007-03-30 14:06:34 +00003512** This routine is called to increment the database file change-counter,
3513** stored at byte 24 of the pager file.
3514*/
danielk1977c7b60172007-08-22 11:22:03 +00003515static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00003516 PgHdr *pPgHdr;
3517 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00003518 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00003519
drh701bb3b2008-08-02 03:50:39 +00003520#ifndef SQLITE_ENABLE_ATOMIC_WRITE
3521 assert( isDirect==0 ); /* isDirect is only true for atomic writes */
3522#endif
drh80e35f42007-03-30 14:06:34 +00003523 if( !pPager->changeCountDone ){
3524 /* Open page 1 of the file for writing. */
3525 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3526 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00003527
3528 if( !isDirect ){
3529 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00003530 if( rc!=SQLITE_OK ){
3531 sqlite3PagerUnref(pPgHdr);
3532 return rc;
3533 }
danielk1977c7b60172007-08-22 11:22:03 +00003534 }
3535
drh80e35f42007-03-30 14:06:34 +00003536 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003537 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003538 change_counter++;
danielk19778c0a7912008-08-20 14:49:23 +00003539 put32bits(((char*)pPgHdr->pData)+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00003540
drh701bb3b2008-08-02 03:50:39 +00003541#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977c7b60172007-08-22 11:22:03 +00003542 if( isDirect && pPager->fd->pMethods ){
danielk19778c0a7912008-08-20 14:49:23 +00003543 const void *zBuf = pPgHdr->pData;
danielk1977c7b60172007-08-22 11:22:03 +00003544 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
3545 }
drh701bb3b2008-08-02 03:50:39 +00003546#endif
danielk1977c7b60172007-08-22 11:22:03 +00003547
drh80e35f42007-03-30 14:06:34 +00003548 /* Release the page reference. */
3549 sqlite3PagerUnref(pPgHdr);
3550 pPager->changeCountDone = 1;
3551 }
danielk1977c7b60172007-08-22 11:22:03 +00003552 return rc;
drh80e35f42007-03-30 14:06:34 +00003553}
3554
3555/*
danielk1977f653d782008-03-20 11:04:21 +00003556** Sync the pager file to disk.
3557*/
3558int sqlite3PagerSync(Pager *pPager){
3559 int rc;
drh7426f862008-08-26 21:07:26 +00003560 if( MEMDB ){
3561 rc = SQLITE_OK;
3562 }else{
3563 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
3564 }
danielk1977f653d782008-03-20 11:04:21 +00003565 return rc;
3566}
3567
3568/*
drh80e35f42007-03-30 14:06:34 +00003569** Sync the database file for the pager pPager. zMaster points to the name
3570** of a master journal file that should be written into the individual
3571** journal file. zMaster may be NULL, which is interpreted as no master
3572** journal (a single database transaction).
3573**
3574** This routine ensures that the journal is synced, all dirty pages written
3575** to the database file and the database file synced. The only thing that
3576** remains to commit the transaction is to delete the journal file (or
3577** master journal file if specified).
3578**
3579** Note that if zMaster==NULL, this does not overwrite a previous value
3580** passed to an sqlite3PagerCommitPhaseOne() call.
3581**
3582** If parameter nTrunc is non-zero, then the pager file is truncated to
3583** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00003584**
3585** If the final parameter - noSync - is true, then the database file itself
3586** is not synced. The caller must call sqlite3PagerSync() directly to
3587** sync the database file before calling CommitPhaseTwo() to delete the
3588** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00003589*/
danielk1977f653d782008-03-20 11:04:21 +00003590int sqlite3PagerCommitPhaseOne(
3591 Pager *pPager,
3592 const char *zMaster,
3593 Pgno nTrunc,
3594 int noSync
3595){
drh80e35f42007-03-30 14:06:34 +00003596 int rc = SQLITE_OK;
3597
danielk1977dad31b52008-05-15 11:08:07 +00003598 if( pPager->errCode ){
3599 return pPager->errCode;
3600 }
3601
drhd138c012008-05-13 00:58:18 +00003602 /* If no changes have been made, we can leave the transaction early.
3603 */
3604 if( pPager->dbModified==0 &&
3605 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3606 pPager->exclusiveMode!=0) ){
3607 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3608 return SQLITE_OK;
3609 }
3610
drh80e35f42007-03-30 14:06:34 +00003611 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3612 pPager->zFilename, zMaster, nTrunc);
3613
3614 /* If this is an in-memory db, or no pages have been written to, or this
3615 ** function has already been called, it is a no-op.
3616 */
3617 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3618 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00003619
danielk1977c7b60172007-08-22 11:22:03 +00003620#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3621 /* The atomic-write optimization can be used if all of the
3622 ** following are true:
3623 **
3624 ** + The file-system supports the atomic-write property for
3625 ** blocks of size page-size, and
3626 ** + This commit is not part of a multi-file transaction, and
3627 ** + Exactly one page has been modified and store in the journal file.
3628 **
3629 ** If the optimization can be used, then the journal file will never
3630 ** be created for this transaction.
3631 */
danielk19774d60af92008-09-08 15:35:06 +00003632 int useAtomicWrite;
danielk19778c0a7912008-08-20 14:49:23 +00003633 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
danielk19774d60af92008-09-08 15:35:06 +00003634 useAtomicWrite = (
danielk1977f55b8992007-08-24 08:15:53 +00003635 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00003636 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00003637 pPager->journalOff==jrnlBufferSize(pPager) &&
3638 nTrunc==0 &&
danielk19778c0a7912008-08-20 14:49:23 +00003639 (pPg==0 || pPg->pDirty==0)
danielk1977f55b8992007-08-24 08:15:53 +00003640 );
danielk1977700b9c52008-04-24 12:37:40 +00003641 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00003642 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00003643 /* Update the nRec field in the journal file. */
3644 int offset = pPager->journalHdr + sizeof(aJournalMagic);
3645 assert(pPager->nRec==1);
3646 rc = write32bits(pPager->jfd, offset, pPager->nRec);
3647
3648 /* Update the db file change counter. The following call will modify
3649 ** the in-memory representation of page 1 to include the updated
3650 ** change counter and then write page 1 directly to the database
3651 ** file. Because of the atomic-write property of the host file-system,
3652 ** this is safe.
3653 */
danielk1977ae72d982007-10-03 08:46:44 +00003654 if( rc==SQLITE_OK ){
3655 rc = pager_incr_changecounter(pPager, 1);
3656 }
danielk1977f55b8992007-08-24 08:15:53 +00003657 }else{
3658 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00003659 }
3660
danielk1977ae72d982007-10-03 08:46:44 +00003661 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00003662#endif
3663
drh80e35f42007-03-30 14:06:34 +00003664 /* If a master journal file name has already been written to the
3665 ** journal file, then no sync is required. This happens when it is
3666 ** written, then the process fails to upgrade from a RESERVED to an
3667 ** EXCLUSIVE lock. The next time the process tries to commit the
3668 ** transaction the m-j name will have already been written.
3669 */
3670 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00003671 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003672 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00003673 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00003674#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00003675 if( nTrunc!=0 ){
3676 /* If this transaction has made the database smaller, then all pages
3677 ** being discarded by the truncation must be written to the journal
3678 ** file.
3679 */
3680 Pgno i;
3681 int iSkip = PAGER_MJ_PGNO(pPager);
3682 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3683 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
3684 rc = sqlite3PagerGet(pPager, i, &pPg);
3685 if( rc!=SQLITE_OK ) goto sync_exit;
3686 rc = sqlite3PagerWrite(pPg);
3687 sqlite3PagerUnref(pPg);
3688 if( rc!=SQLITE_OK ) goto sync_exit;
3689 }
3690 }
3691 }
drh80e35f42007-03-30 14:06:34 +00003692#endif
danielk197771aa7ff2008-05-20 07:05:09 +00003693 rc = writeMasterJournal(pPager, zMaster);
3694 if( rc!=SQLITE_OK ) goto sync_exit;
3695 rc = syncJournal(pPager);
3696 }
drh80e35f42007-03-30 14:06:34 +00003697 }
danielk1977c7b60172007-08-22 11:22:03 +00003698 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00003699
3700#ifndef SQLITE_OMIT_AUTOVACUUM
3701 if( nTrunc!=0 ){
3702 rc = sqlite3PagerTruncate(pPager, nTrunc);
3703 if( rc!=SQLITE_OK ) goto sync_exit;
3704 }
3705#endif
3706
3707 /* Write all dirty pages to the database file */
danielk19778c0a7912008-08-20 14:49:23 +00003708 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003709 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00003710 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00003711 assert( rc!=SQLITE_IOERR_BLOCKED );
3712 /* The error might have left the dirty list all fouled up here,
3713 ** but that does not matter because if the if the dirty list did
3714 ** get corrupted, then the transaction will roll back and
3715 ** discard the dirty list. There is an assert in
3716 ** pager_get_all_dirty_pages() that verifies that no attempt
3717 ** is made to use an invalid dirty list.
3718 */
drh153c62c2007-08-24 03:51:33 +00003719 goto sync_exit;
3720 }
danielk19778c0a7912008-08-20 14:49:23 +00003721 sqlite3PcacheCleanAll(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003722
3723 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00003724 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00003725 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00003726 }
3727 IOTRACE(("DBSYNC %p\n", pPager))
3728
3729 pPager->state = PAGER_SYNCED;
3730 }else if( MEMDB && nTrunc!=0 ){
3731 rc = sqlite3PagerTruncate(pPager, nTrunc);
3732 }
3733
3734sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00003735 if( rc==SQLITE_IOERR_BLOCKED ){
3736 /* pager_incr_changecounter() may attempt to obtain an exclusive
3737 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00003738 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00003739 * better to return SQLITE_BUSY.
3740 */
3741 rc = SQLITE_BUSY;
3742 }
drh80e35f42007-03-30 14:06:34 +00003743 return rc;
3744}
3745
3746
3747/*
drhed7c8552001-04-11 14:29:21 +00003748** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003749**
3750** If the commit fails for any reason, a rollback attempt is made
3751** and an error code is returned. If the commit worked, SQLITE_OK
3752** is returned.
drhed7c8552001-04-11 14:29:21 +00003753*/
drh80e35f42007-03-30 14:06:34 +00003754int sqlite3PagerCommitPhaseTwo(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003755 int rc = SQLITE_OK;
drhd9b02572001-04-15 00:37:09 +00003756
danielk1977efaaf572006-01-16 11:29:19 +00003757 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003758 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003759 }
drha6abd042004-06-09 17:37:22 +00003760 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003761 return SQLITE_ERROR;
3762 }
drhd138c012008-05-13 00:58:18 +00003763 if( pPager->dbModified==0 &&
3764 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3765 pPager->exclusiveMode!=0) ){
3766 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3767 return SQLITE_OK;
3768 }
drh4f0c5872007-03-26 22:05:01 +00003769 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003770 assert( pPager->state==PAGER_SYNCED || MEMDB || !pPager->dirtyCache );
3771 rc = pager_end_transaction(pPager, pPager->setMaster);
3772 rc = pager_error(pPager, rc);
drh86f8c192007-08-22 00:39:19 +00003773 return rc;
drhed7c8552001-04-11 14:29:21 +00003774}
3775
3776/*
drha6abd042004-06-09 17:37:22 +00003777** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003778** All in-memory cache pages revert to their original data contents.
3779** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003780**
3781** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003782** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003783** process is writing trash into the journal file (SQLITE_CORRUPT) or
3784** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3785** codes are returned for all these occasions. Otherwise,
3786** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003787*/
danielk19773b8a05f2007-03-19 17:44:26 +00003788int sqlite3PagerRollback(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003789 int rc = SQLITE_OK;
drh4f0c5872007-03-26 22:05:01 +00003790 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003791 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00003792 rc = pager_end_transaction(pPager, pPager->setMaster);
danielk19778c0a7912008-08-20 14:49:23 +00003793 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003794 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003795 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003796 }
danielk19778c0a7912008-08-20 14:49:23 +00003797 rc = pPager->errCode;
drha6abd042004-06-09 17:37:22 +00003798 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003799 if( pPager->state==PAGER_RESERVED ){
3800 int rc2;
3801 rc = pager_playback(pPager, 0);
3802 rc2 = pager_end_transaction(pPager, pPager->setMaster);
3803 if( rc==SQLITE_OK ){
3804 rc = rc2;
3805 }
3806 }else{
3807 rc = pager_playback(pPager, 0);
3808 }
danielk197707cb5602006-01-20 10:55:05 +00003809
danielk1977b3175382008-10-17 18:51:52 +00003810 if( !MEMDB ){
3811 pPager->dbSize = -1;
3812 }
danielk19778c0a7912008-08-20 14:49:23 +00003813
3814 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3815 ** cache. So call pager_error() on the way out to make any error
3816 ** persistent.
3817 */
3818 rc = pager_error(pPager, rc);
3819 }
drh86f8c192007-08-22 00:39:19 +00003820 return rc;
drh98808ba2001-10-18 12:34:46 +00003821}
drhd9b02572001-04-15 00:37:09 +00003822
3823/*
drh5e00f6c2001-09-13 13:46:56 +00003824** Return TRUE if the database file is opened read-only. Return FALSE
3825** if the database is (in theory) writable.
3826*/
danielk19773b8a05f2007-03-19 17:44:26 +00003827int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003828 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003829}
3830
3831/*
drh0f7eb612006-08-08 13:51:43 +00003832** Return the number of references to the pager.
3833*/
danielk19773b8a05f2007-03-19 17:44:26 +00003834int sqlite3PagerRefcount(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003835 return sqlite3PcacheRefCount(pPager->pPCache);
drh0f7eb612006-08-08 13:51:43 +00003836}
3837
danielk197771d5d2c2008-09-29 11:49:47 +00003838/*
3839** Return the number of references to the specified page.
3840*/
3841int sqlite3PagerPageRefcount(DbPage *pPage){
3842 return sqlite3PcachePageRefcount(pPage);
3843}
3844
drh0f7eb612006-08-08 13:51:43 +00003845#ifdef SQLITE_TEST
3846/*
drhd9b02572001-04-15 00:37:09 +00003847** This routine is used for testing and analysis only.
3848*/
danielk19773b8a05f2007-03-19 17:44:26 +00003849int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003850 static int a[11];
danielk19778c0a7912008-08-20 14:49:23 +00003851 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
3852 a[1] = sqlite3PcachePagecount(pPager->pPCache);
3853 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
drhd9b02572001-04-15 00:37:09 +00003854 a[3] = pPager->dbSize;
3855 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003856 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003857 a[6] = pPager->nHit;
3858 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003859 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003860 a[9] = pPager->nRead;
3861 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003862 return a;
3863}
danielk197717b90b52008-06-06 11:11:25 +00003864int sqlite3PagerIsMemdb(Pager *pPager){
3865 return MEMDB;
3866}
drh0f7eb612006-08-08 13:51:43 +00003867#endif
drhdd793422001-06-28 01:54:48 +00003868
drhfa86c412002-02-02 15:01:15 +00003869/*
drhac69b052004-05-12 13:30:07 +00003870** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003871**
3872** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003873** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003874** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003875*/
drh86f8c192007-08-22 00:39:19 +00003876static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003877 int rc;
drhac69b052004-05-12 13:30:07 +00003878 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00003879 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00003880 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00003881 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhda47d772002-12-02 04:25:19 +00003882 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003883 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003884 return SQLITE_OK;
3885 }
drhfa86c412002-02-02 15:01:15 +00003886 assert( pPager->journalOpen );
drhf5e7bb52008-02-18 14:47:33 +00003887 assert( pPager->pInStmt==0 );
3888 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00003889 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00003890 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00003891 return SQLITE_NOMEM;
3892 }
danielk197776572402004-06-25 02:38:54 +00003893 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003894 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003895 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003896 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003897 if( !pPager->stmtOpen ){
danielk1977b3175382008-10-17 18:51:52 +00003898 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
3899 sqlite3MemJournalOpen(pPager->stfd);
3900 }else{
3901 rc = sqlite3PagerOpentemp(pPager, pPager->stfd, SQLITE_OPEN_SUBJOURNAL);
3902 if( rc ){
3903 goto stmt_begin_failed;
3904 }
drh334b2992007-09-06 23:28:23 +00003905 }
drhac69b052004-05-12 13:30:07 +00003906 pPager->stmtOpen = 1;
3907 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003908 }
drhac69b052004-05-12 13:30:07 +00003909 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003910 return SQLITE_OK;
3911
drhac69b052004-05-12 13:30:07 +00003912stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00003913 if( pPager->pInStmt ){
3914 sqlite3BitvecDestroy(pPager->pInStmt);
3915 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003916 }
3917 return rc;
3918}
drh86f8c192007-08-22 00:39:19 +00003919int sqlite3PagerStmtBegin(Pager *pPager){
3920 int rc;
drh86f8c192007-08-22 00:39:19 +00003921 rc = pagerStmtBegin(pPager);
drh86f8c192007-08-22 00:39:19 +00003922 return rc;
3923}
drhfa86c412002-02-02 15:01:15 +00003924
3925/*
drhac69b052004-05-12 13:30:07 +00003926** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003927*/
danielk19773b8a05f2007-03-19 17:44:26 +00003928int sqlite3PagerStmtCommit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003929 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003930 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003931 sqlite3BitvecDestroy(pPager->pInStmt);
3932 pPager->pInStmt = 0;
drhac69b052004-05-12 13:30:07 +00003933 pPager->stmtNRec = 0;
3934 pPager->stmtInUse = 0;
danielk1977b3175382008-10-17 18:51:52 +00003935 if( sqlite3IsMemJournal(pPager->stfd) ){
3936 sqlite3OsTruncate(pPager->stfd, 0);
3937 }
drh663fc632002-02-02 18:49:19 +00003938 }
drhac69b052004-05-12 13:30:07 +00003939 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003940 return SQLITE_OK;
3941}
3942
3943/*
drhac69b052004-05-12 13:30:07 +00003944** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003945*/
danielk19773b8a05f2007-03-19 17:44:26 +00003946int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003947 int rc;
drhac69b052004-05-12 13:30:07 +00003948 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003949 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003950 rc = pager_stmt_playback(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003951 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00003952 }else{
3953 rc = SQLITE_OK;
3954 }
drhac69b052004-05-12 13:30:07 +00003955 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003956 return rc;
3957}
3958
drh73509ee2003-04-06 20:44:45 +00003959/*
3960** Return the full pathname of the database file.
3961*/
danielk19773b8a05f2007-03-19 17:44:26 +00003962const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003963 return pPager->zFilename;
3964}
3965
drhb20ea9d2004-02-09 01:20:36 +00003966/*
drhd0679ed2007-08-28 22:24:34 +00003967** Return the VFS structure for the pager.
3968*/
3969const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
3970 return pPager->pVfs;
3971}
3972
3973/*
drhcc6bb3e2007-08-31 16:11:35 +00003974** Return the file handle for the database file associated
3975** with the pager. This might return NULL if the file has
3976** not yet been opened.
3977*/
3978sqlite3_file *sqlite3PagerFile(Pager *pPager){
3979 return pPager->fd;
3980}
3981
3982/*
danielk19775865e3d2004-06-14 06:03:57 +00003983** Return the directory of the database file.
3984*/
danielk19773b8a05f2007-03-19 17:44:26 +00003985const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00003986 return pPager->zDirectory;
3987}
3988
3989/*
3990** Return the full pathname of the journal file.
3991*/
danielk19773b8a05f2007-03-19 17:44:26 +00003992const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00003993 return pPager->zJournal;
3994}
3995
3996/*
drh2c8997b2005-08-27 16:36:48 +00003997** Return true if fsync() calls are disabled for this pager. Return FALSE
3998** if fsync()s are executed normally.
3999*/
danielk19773b8a05f2007-03-19 17:44:26 +00004000int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004001 return pPager->noSync;
4002}
4003
drh7c4ac0c2007-04-05 11:25:58 +00004004#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004005/*
drhb20ea9d2004-02-09 01:20:36 +00004006** Set the codec for this pager
4007*/
danielk19773b8a05f2007-03-19 17:44:26 +00004008void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004009 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004010 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004011 void *pCodecArg
4012){
4013 pPager->xCodec = xCodec;
4014 pPager->pCodecArg = pCodecArg;
4015}
drh7c4ac0c2007-04-05 11:25:58 +00004016#endif
drhb20ea9d2004-02-09 01:20:36 +00004017
danielk1977687566d2004-11-02 12:56:41 +00004018#ifndef SQLITE_OMIT_AUTOVACUUM
4019/*
danielk197787c29a92008-01-18 11:33:16 +00004020** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004021**
drh5e385312007-06-16 04:42:12 +00004022** There must be no references to the page previously located at
4023** pgno (which we call pPgOld) though that page is allowed to be
drhb3df2e12008-09-17 20:06:26 +00004024** in cache. If the page previously located at pgno is not already
drh5e385312007-06-16 04:42:12 +00004025** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004026**
drh5e385312007-06-16 04:42:12 +00004027** References to the page pPg remain valid. Updating any
4028** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004029** allocated along with the page) is the responsibility of the caller.
4030**
danielk19775fd057a2005-03-09 13:09:43 +00004031** A transaction must be active when this routine is called. It used to be
4032** required that a statement transaction was not active, but this restriction
4033** has been removed (CREATE INDEX needs to move a page when a statement
4034** transaction is active).
danielk19774c999992008-07-16 18:17:55 +00004035**
4036** If the fourth argument, isCommit, is non-zero, then this page is being
4037** moved as part of a database reorganization just before the transaction
4038** is being committed. In this case, it is guaranteed that the database page
4039** pPg refers to will not be written to again within this transaction.
danielk1977687566d2004-11-02 12:56:41 +00004040*/
danielk19774c999992008-07-16 18:17:55 +00004041int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
drh5e385312007-06-16 04:42:12 +00004042 PgHdr *pPgOld; /* The page being overwritten. */
danielk197794daf7f2004-11-08 09:26:09 +00004043 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004044
danielk1977687566d2004-11-02 12:56:41 +00004045 assert( pPg->nRef>0 );
4046
drh4f0c5872007-03-26 22:05:01 +00004047 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk19778c0a7912008-08-20 14:49:23 +00004048 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno);
drhb0603412007-02-28 04:47:26 +00004049 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004050
danielk1977b4626a32007-04-28 15:47:43 +00004051 pager_get_content(pPg);
danielk19774c999992008-07-16 18:17:55 +00004052
4053 /* If the journal needs to be sync()ed before page pPg->pgno can
4054 ** be written to, store pPg->pgno in local variable needSyncPgno.
4055 **
4056 ** If the isCommit flag is set, there is no need to remember that
4057 ** the journal needs to be sync()ed before database page pPg->pgno
4058 ** can be written to. The caller has already promised not to write to it.
4059 */
danielk19778c0a7912008-08-20 14:49:23 +00004060 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
danielk197794daf7f2004-11-08 09:26:09 +00004061 needSyncPgno = pPg->pgno;
danielk1977bc2ca9e2008-11-13 14:28:28 +00004062 assert( pageInJournal(pPg) || (int)pgno>pPager->origDbSize );
danielk19778c0a7912008-08-20 14:49:23 +00004063 assert( pPg->flags&PGHDR_DIRTY );
danielk1977ae825582004-11-23 09:06:55 +00004064 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004065 }
4066
danielk1977ef73ee92004-11-06 12:26:07 +00004067 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00004068 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00004069 ** page pgno before the 'move' operation, it needs to be retained
4070 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004071 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00004072 pPg->flags &= ~PGHDR_NEED_SYNC;
danielk1977687566d2004-11-02 12:56:41 +00004073 pPgOld = pager_lookup(pPager, pgno);
danielk19778c0a7912008-08-20 14:49:23 +00004074 assert( !pPgOld || pPgOld->nRef==1 );
danielk1977687566d2004-11-02 12:56:41 +00004075 if( pPgOld ){
danielk19778c0a7912008-08-20 14:49:23 +00004076 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
drh5e385312007-06-16 04:42:12 +00004077 }
danielk1977687566d2004-11-02 12:56:41 +00004078
danielk19778c0a7912008-08-20 14:49:23 +00004079 sqlite3PcacheMove(pPg, pgno);
4080 if( pPgOld ){
danielk1977bc2ca9e2008-11-13 14:28:28 +00004081 sqlite3PcacheDrop(pPgOld);
danielk1977f5fdda82004-11-03 08:44:05 +00004082 }
danielk1977f5fdda82004-11-03 08:44:05 +00004083
drh605ad8f2006-05-03 23:34:05 +00004084 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004085 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004086 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00004087
danielk197794daf7f2004-11-08 09:26:09 +00004088 if( needSyncPgno ){
4089 /* If needSyncPgno is non-zero, then the journal file needs to be
4090 ** sync()ed before any data is written to database file page needSyncPgno.
4091 ** Currently, no such page exists in the page-cache and the
danielk19774c999992008-07-16 18:17:55 +00004092 ** "is journaled" bitvec flag has been set. This needs to be remedied by
4093 ** loading the page into the pager-cache and setting the PgHdr.needSync
4094 ** flag.
danielk1977ae825582004-11-23 09:06:55 +00004095 **
danielk1977a98d7b42008-01-18 13:42:54 +00004096 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00004097 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00004098 ** array. Otherwise, if the page is loaded and written again in
4099 ** this transaction, it may be written to the database file before
4100 ** it is synced into the journal file. This way, it may end up in
4101 ** the journal file twice, but that is not a problem.
4102 **
danielk19773b8a05f2007-03-19 17:44:26 +00004103 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004104 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004105 */
4106 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004107 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004108 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004109 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00004110 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00004111 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
4112 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00004113 }
danielk197787c29a92008-01-18 11:33:16 +00004114 return rc;
4115 }
danielk1977ae825582004-11-23 09:06:55 +00004116 pPager->needSync = 1;
drhb3df2e12008-09-17 20:06:26 +00004117 assert( pPager->noSync==0 && !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00004118 pPgHdr->flags |= PGHDR_NEED_SYNC;
danielk19773b8a05f2007-03-19 17:44:26 +00004119 makeDirty(pPgHdr);
4120 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004121 }
4122
danielk1977687566d2004-11-02 12:56:41 +00004123 return SQLITE_OK;
4124}
4125#endif
4126
danielk19773b8a05f2007-03-19 17:44:26 +00004127/*
4128** Return a pointer to the data for the specified page.
4129*/
4130void *sqlite3PagerGetData(DbPage *pPg){
danielk197771d5d2c2008-09-29 11:49:47 +00004131 assert( pPg->nRef>0 || pPg->pPager->memDb );
danielk19778c0a7912008-08-20 14:49:23 +00004132 return pPg->pData;
danielk19773b8a05f2007-03-19 17:44:26 +00004133}
4134
4135/*
4136** Return a pointer to the Pager.nExtra bytes of "extra" space
4137** allocated along with the specified page.
4138*/
4139void *sqlite3PagerGetExtra(DbPage *pPg){
4140 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00004141 return (pPager?pPg->pExtra:0);
danielk19773b8a05f2007-03-19 17:44:26 +00004142}
4143
danielk197741483462007-03-24 16:45:04 +00004144/*
4145** Get/set the locking-mode for this pager. Parameter eMode must be one
4146** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4147** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4148** the locking-mode is set to the value specified.
4149**
4150** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4151** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4152** locking-mode.
4153*/
4154int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004155 assert( eMode==PAGER_LOCKINGMODE_QUERY
4156 || eMode==PAGER_LOCKINGMODE_NORMAL
4157 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4158 assert( PAGER_LOCKINGMODE_QUERY<0 );
4159 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4160 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00004161 pPager->exclusiveMode = eMode;
4162 }
4163 return (int)pPager->exclusiveMode;
4164}
4165
drh3b020132008-04-17 17:02:01 +00004166/*
drh04335882008-09-26 21:08:08 +00004167** Get/set the journal-mode for this pager. Parameter eMode must be one of:
drh3b020132008-04-17 17:02:01 +00004168**
drh04335882008-09-26 21:08:08 +00004169** PAGER_JOURNALMODE_QUERY
4170** PAGER_JOURNALMODE_DELETE
4171** PAGER_JOURNALMODE_TRUNCATE
4172** PAGER_JOURNALMODE_PERSIST
4173** PAGER_JOURNALMODE_OFF
4174**
4175** If the parameter is not _QUERY, then the journal-mode is set to the
4176** value specified.
4177**
4178** The returned indicate the current (possibly updated)
drh3b020132008-04-17 17:02:01 +00004179** journal-mode.
4180*/
4181int sqlite3PagerJournalMode(Pager *pPager, int eMode){
danielk1977b3175382008-10-17 18:51:52 +00004182 if( !MEMDB ){
4183 assert( eMode==PAGER_JOURNALMODE_QUERY
4184 || eMode==PAGER_JOURNALMODE_DELETE
4185 || eMode==PAGER_JOURNALMODE_TRUNCATE
4186 || eMode==PAGER_JOURNALMODE_PERSIST
4187 || eMode==PAGER_JOURNALMODE_OFF
4188 || eMode==PAGER_JOURNALMODE_MEMORY );
4189 assert( PAGER_JOURNALMODE_QUERY<0 );
4190 if( eMode>=0 ){
4191 pPager->journalMode = eMode;
4192 }else{
4193 assert( eMode==PAGER_JOURNALMODE_QUERY );
4194 }
drh3b020132008-04-17 17:02:01 +00004195 }
drhfdc40e92008-04-17 20:59:37 +00004196 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00004197}
4198
danielk1977b53e4962008-06-04 06:45:59 +00004199/*
4200** Get/set the size-limit used for persistent journal files.
4201*/
4202i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
4203 if( iLimit>=-1 ){
4204 pPager->journalSizeLimit = iLimit;
4205 }
4206 return pPager->journalSizeLimit;
4207}
4208
drh2e66f0b2005-04-28 17:18:48 +00004209#endif /* SQLITE_OMIT_DISKIO */