blob: 196e23e25ba2b10d92ee163906e5abce0c791426 [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**
danielk1977a1fa00d2008-08-27 15:16:33 +000021** @(#) $Id: pager.c,v 1.483 2008/08/27 15:16:34 danielk1977 Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drh2e66f0b2005-04-28 17:18:48 +000023#ifndef SQLITE_OMIT_DISKIO
drhd9b02572001-04-15 00:37:09 +000024#include "sqliteInt.h"
drhed7c8552001-04-11 14:29:21 +000025
26/*
drhdb48ee02003-01-16 13:42:43 +000027** Macros for troubleshooting. Normally turned off
28*/
danielk1977466be562004-06-10 02:16:01 +000029#if 0
drhd3627af2006-12-18 18:34:51 +000030#define sqlite3DebugPrintf printf
drh4f0c5872007-03-26 22:05:01 +000031#define PAGERTRACE1(X) sqlite3DebugPrintf(X)
32#define PAGERTRACE2(X,Y) sqlite3DebugPrintf(X,Y)
33#define PAGERTRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
34#define PAGERTRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
35#define PAGERTRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000036#else
drh4f0c5872007-03-26 22:05:01 +000037#define PAGERTRACE1(X)
38#define PAGERTRACE2(X,Y)
39#define PAGERTRACE3(X,Y,Z)
40#define PAGERTRACE4(X,Y,Z,W)
41#define PAGERTRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000042#endif
43
danielk1977599fcba2004-11-08 07:13:13 +000044/*
drh4f0c5872007-03-26 22:05:01 +000045** The following two macros are used within the PAGERTRACEX() macros above
drhd86959f2005-11-26 03:51:18 +000046** to print out file-descriptors.
danielk1977599fcba2004-11-08 07:13:13 +000047**
drh85b623f2007-12-13 21:54:09 +000048** PAGERID() takes a pointer to a Pager struct as its argument. The
danielk197762079062007-08-15 17:08:46 +000049** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
drh85b623f2007-12-13 21:54:09 +000050** struct as its argument.
danielk1977599fcba2004-11-08 07:13:13 +000051*/
drhc001c582006-03-06 18:23:16 +000052#define PAGERID(p) ((int)(p->fd))
53#define FILEHANDLEID(fd) ((int)fd)
drhdb48ee02003-01-16 13:42:43 +000054
55/*
drhed7c8552001-04-11 14:29:21 +000056** The page cache as a whole is always in one of the following
57** states:
58**
drha6abd042004-06-09 17:37:22 +000059** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000060** writing the database file. There is no
61** data held in memory. This is the initial
62** state.
63**
drha6abd042004-06-09 17:37:22 +000064** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000065** Writing is not permitted. There can be
66** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000067** file at the same time.
drhed7c8552001-04-11 14:29:21 +000068**
drh726de592004-06-10 23:35:50 +000069** PAGER_RESERVED This process has reserved the database for writing
70** but has not yet made any changes. Only one process
71** at a time can reserve the database. The original
72** database file has not been modified so other
73** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000074** database file.
75**
76** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000077** Access is exclusive. No other processes or
78** threads can be reading or writing while one
79** process is writing.
80**
danielk1977aa5ccdf2004-06-14 05:10:42 +000081** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
82** after all dirty pages have been written to the
83** database file and the file has been synced to
drh369339d2007-03-30 16:01:55 +000084** disk. All that remains to do is to remove or
85** truncate the journal file and the transaction
86** will be committed.
danielk1977aa5ccdf2004-06-14 05:10:42 +000087**
drha6abd042004-06-09 17:37:22 +000088** The page cache comes up in PAGER_UNLOCK. The first time a
danielk19773b8a05f2007-03-19 17:44:26 +000089** sqlite3PagerGet() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000090** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000091** the state transitions back to PAGER_UNLOCK. The first time
danielk19773b8a05f2007-03-19 17:44:26 +000092** that sqlite3PagerWrite() is called, the state transitions to
drh369339d2007-03-30 16:01:55 +000093** PAGER_RESERVED. (Note that sqlite3PagerWrite() can only be
drh306dc212001-05-21 13:45:10 +000094** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000095** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh369339d2007-03-30 16:01:55 +000096** PAGER_RESERVED means that there is an open rollback journal.
97** The transition to PAGER_EXCLUSIVE occurs before any changes
98** are made to the database file, though writes to the rollback
99** journal occurs with just PAGER_RESERVED. After an sqlite3PagerRollback()
100** or sqlite3PagerCommitPhaseTwo(), the state can go back to PAGER_SHARED,
101** or it can stay at PAGER_EXCLUSIVE if we are in exclusive access mode.
drhed7c8552001-04-11 14:29:21 +0000102*/
drha6abd042004-06-09 17:37:22 +0000103#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000104#define PAGER_SHARED 1 /* same as SHARED_LOCK */
105#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
106#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
107#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000108
drh684917c2004-10-05 02:41:42 +0000109/*
110** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
111** then failed attempts to get a reserved lock will invoke the busy callback.
112** This is off by default. To see why, consider the following scenario:
113**
114** Suppose thread A already has a shared lock and wants a reserved lock.
115** Thread B already has a reserved lock and wants an exclusive lock. If
116** both threads are using their busy callbacks, it might be a long time
117** be for one of the threads give up and allows the other to proceed.
118** But if the thread trying to get the reserved lock gives up quickly
119** (if it never invokes its busy callback) then the contention will be
120** resolved quickly.
121*/
122#ifndef SQLITE_BUSY_RESERVED_LOCK
123# define SQLITE_BUSY_RESERVED_LOCK 0
124#endif
drhd9b02572001-04-15 00:37:09 +0000125
drhed7c8552001-04-11 14:29:21 +0000126/*
drh887dc4c2004-10-22 16:22:57 +0000127** This macro rounds values up so that if the value is an address it
128** is guaranteed to be an address that is aligned to an 8-byte boundary.
129*/
130#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
131
drh9eb9e262004-02-11 02:18:05 +0000132/*
133** A macro used for invoking the codec if there is one
134*/
135#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000136# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
137# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000138#else
drhc001c582006-03-06 18:23:16 +0000139# define CODEC1(P,D,N,X) /* NO-OP */
140# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000141#endif
142
drhed7c8552001-04-11 14:29:21 +0000143/*
drhed7c8552001-04-11 14:29:21 +0000144** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000145**
drh4f0ee682007-03-30 20:43:40 +0000146** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000147** or SQLITE_FULL. Once one of the first three errors occurs, it persists
148** and is returned as the result of every major pager API call. The
149** SQLITE_FULL return code is slightly different. It persists only until the
150** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000151** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000152** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000153*/
154struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000155 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000156 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000157 u8 journalStarted; /* True if header of journal is synced */
158 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000159 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000160 u8 stmtOpen; /* True if the statement subjournal is open */
161 u8 stmtInUse; /* True we are in a statement subtransaction */
162 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000163 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000164 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000165 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000166 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000167 u8 tempFile; /* zFilename is a temporary file */
168 u8 readOnly; /* True for a read-only database */
169 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000170 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000171 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000172 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000173 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000174 u8 doNotSync; /* Boolean. While true, do not spill the cache */
175 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
drhfdc40e92008-04-17 20:59:37 +0000176 u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */
drhd138c012008-05-13 00:58:18 +0000177 u8 dbModified; /* True if there are any changes to the Db */
drh80e35f42007-03-30 14:06:34 +0000178 u8 changeCountDone; /* Set after incrementing the change-counter */
drh33f4e022007-09-03 15:19:34 +0000179 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000180 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000181 int dbSize; /* Number of pages in the file */
182 int origDbSize; /* dbSize before the current change */
183 int stmtSize; /* Size of database (in pages) at stmt_begin() */
184 int nRec; /* Number of pages written to the journal */
185 u32 cksumInit; /* Quasi-random value added to every checksum */
186 int stmtNRec; /* Number of records in stmt subjournal */
187 int nExtra; /* Add this many bytes to each in-memory page */
188 int pageSize; /* Number of bytes in a page */
189 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000190 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000191 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000192 Bitvec *pInJournal; /* One bit for each page in the database file */
193 Bitvec *pInStmt; /* One bit for each page in the database */
danielk1977a1fa00d2008-08-27 15:16:33 +0000194 Bitvec *pAlwaysRollback; /* One bit for each page marked always-rollback */
drhfcd35c72005-05-21 02:48:08 +0000195 char *zFilename; /* Name of the database file */
196 char *zJournal; /* Name of the journal file */
197 char *zDirectory; /* Directory hold database and journal files */
danielk197762079062007-08-15 17:08:46 +0000198 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
199 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000200 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drheb206252004-10-01 02:00:31 +0000201 i64 journalOff; /* Current byte offset in the journal file */
202 i64 journalHdr; /* Byte offset to previous journal header */
203 i64 stmtHdrOff; /* First journal header written this statement */
204 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000205 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000206 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000207#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000208 int nHit, nMiss; /* Cache hits and missing */
209 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000210#endif
danielk19773b8a05f2007-03-19 17:44:26 +0000211 void (*xDestructor)(DbPage*,int); /* Call this routine when freeing pages */
212 void (*xReiniter)(DbPage*,int); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000213#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000214 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000215 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000216#endif
danielk19778186df82007-03-06 13:45:59 +0000217 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000218 char dbFileVers[16]; /* Changes whenever database file changes */
danielk1977b53e4962008-06-04 06:45:59 +0000219 i64 journalSizeLimit; /* Size limit for persistent journal files */
danielk19778c0a7912008-08-20 14:49:23 +0000220 PCache *pPCache; /* Pointer to page cache object */
drhd9b02572001-04-15 00:37:09 +0000221};
222
223/*
drh538f5702007-04-13 02:14:30 +0000224** The following global variables hold counters used for
225** testing purposes only. These variables do not exist in
226** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000227*/
228#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000229int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
230int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
231int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
drh538f5702007-04-13 02:14:30 +0000232# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000233#else
drh538f5702007-04-13 02:14:30 +0000234# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000235#endif
236
drh538f5702007-04-13 02:14:30 +0000237
238
drhfcd35c72005-05-21 02:48:08 +0000239/*
drh5e00f6c2001-09-13 13:46:56 +0000240** Journal files begin with the following magic string. The data
241** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000242**
drhae2b40c2004-06-09 19:03:54 +0000243** Since version 2.8.0, the journal format contains additional sanity
244** checking information. If the power fails while the journal is begin
245** written, semi-random garbage data might appear in the journal
246** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000247** to roll the journal back, the database could be corrupted. The additional
248** sanity checking data is an attempt to discover the garbage in the
249** journal and ignore it.
250**
drhae2b40c2004-06-09 19:03:54 +0000251** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000252** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000253** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000254** This cksum is initialized to a 32-bit random value that appears in the
255** journal file right after the header. The random initializer is important,
256** because garbage data that appears at the end of a journal is likely
257** data that was once in other files that have now been deleted. If the
258** garbage data came from an obsolete journal file, the checksums might
259** be correct. But by initializing the checksum to random value which
260** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000261*/
drhae2b40c2004-06-09 19:03:54 +0000262static const unsigned char aJournalMagic[] = {
263 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000264};
265
266/*
drh726de592004-06-10 23:35:50 +0000267** The size of the header and of each page in the journal is determined
268** by the following macros.
drh968af522003-02-11 14:55:40 +0000269*/
drhae2b40c2004-06-09 19:03:54 +0000270#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000271
danielk197776572402004-06-25 02:38:54 +0000272/*
273** The journal header size for this pager. In the future, this could be
274** set to some value read from the disk controller. The important
275** characteristic is that it is the same size as a disk sector.
276*/
277#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
278
drhb7f91642004-10-31 02:22:47 +0000279/*
280** The macro MEMDB is true if we are dealing with an in-memory database.
281** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
282** the value of MEMDB will be a constant and the compiler will optimize
283** out code that would never execute.
284*/
285#ifdef SQLITE_OMIT_MEMORYDB
286# define MEMDB 0
287#else
288# define MEMDB pPager->memDb
289#endif
290
291/*
danielk197776572402004-06-25 02:38:54 +0000292** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
293** reserved for working around a windows/posix incompatibility). It is
294** used in the journal to signify that the remainder of the journal file
295** is devoted to storing a master journal name - there are no more pages to
296** roll back. See comments for function writeMasterJournal() for details.
297*/
danielk1977599fcba2004-11-08 07:13:13 +0000298/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
299#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000300
drh968af522003-02-11 14:55:40 +0000301/*
danielk197726836652005-01-17 01:33:13 +0000302** The maximum legal page number is (2^31 - 1).
303*/
304#define PAGER_MAX_PGNO 2147483647
305
306/*
danielk1977f35843b2007-04-07 15:03:17 +0000307** Return true if page *pPg has already been written to the statement
308** journal (or statement snapshot has been created, if *pPg is part
309** of an in-memory database).
310*/
311static int pageInStatement(PgHdr *pPg){
312 Pager *pPager = pPg->pPager;
313 if( MEMDB ){
danielk19778c0a7912008-08-20 14:49:23 +0000314 return pPg->apSave[1]!=0;
danielk1977f35843b2007-04-07 15:03:17 +0000315 }else{
drhf5e7bb52008-02-18 14:47:33 +0000316 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000317 }
318}
drh8ca0c722006-05-07 17:49:38 +0000319
320/*
drh34e79ce2004-02-08 06:05:46 +0000321** Read a 32-bit integer from the given file descriptor. Store the integer
322** that is read in *pRes. Return SQLITE_OK if everything worked, or an
323** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000324**
325** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000326*/
danielk197762079062007-08-15 17:08:46 +0000327static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000328 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000329 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000330 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000331 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000332 }
drh94f33312002-08-12 12:29:56 +0000333 return rc;
334}
335
336/*
drh97b57482006-01-10 20:32:32 +0000337** Write a 32-bit integer into a string buffer in big-endian byte order.
338*/
drha3152892007-05-05 11:48:52 +0000339#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000340
341/*
drh34e79ce2004-02-08 06:05:46 +0000342** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
343** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000344*/
danielk197762079062007-08-15 17:08:46 +0000345static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000346 char ac[4];
drh97b57482006-01-10 20:32:32 +0000347 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000348 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000349}
350
drh2554f8b2003-01-22 01:26:44 +0000351/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000352** If file pFd is open, call sqlite3OsUnlock() on it.
353*/
354static int osUnlock(sqlite3_file *pFd, int eLock){
355 if( !pFd->pMethods ){
356 return SQLITE_OK;
357 }
358 return sqlite3OsUnlock(pFd, eLock);
359}
360
361/*
danielk1977c7b60172007-08-22 11:22:03 +0000362** This function determines whether or not the atomic-write optimization
363** can be used with this pager. The optimization can be used if:
364**
365** (a) the value returned by OsDeviceCharacteristics() indicates that
366** a database page may be written atomically, and
367** (b) the value returned by OsSectorSize() is less than or equal
368** to the page size.
369**
370** If the optimization cannot be used, 0 is returned. If it can be used,
371** then the value returned is the size of the journal file when it
372** contains rollback data for exactly one page.
373*/
374#ifdef SQLITE_ENABLE_ATOMIC_WRITE
375static int jrnlBufferSize(Pager *pPager){
376 int dc; /* Device characteristics */
377 int nSector; /* Sector size */
drhfacf0302008-06-17 15:12:00 +0000378 int szPage; /* Page size */
danielk1977c7b60172007-08-22 11:22:03 +0000379 sqlite3_file *fd = pPager->fd;
380
381 if( fd->pMethods ){
382 dc = sqlite3OsDeviceCharacteristics(fd);
383 nSector = sqlite3OsSectorSize(fd);
drhfacf0302008-06-17 15:12:00 +0000384 szPage = pPager->pageSize;
danielk1977c7b60172007-08-22 11:22:03 +0000385 }
386
387 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
388 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
389
drhfacf0302008-06-17 15:12:00 +0000390 if( !fd->pMethods ||
391 (dc & (SQLITE_IOCAP_ATOMIC|(szPage>>8)) && nSector<=szPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000392 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
393 }
394 return 0;
395}
396#endif
397
398/*
danielk1977aef0bf62005-12-30 16:28:01 +0000399** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000400** code. The first argument is a pointer to the pager structure, the
401** second the error-code about to be returned by a pager API function.
402** The value returned is a copy of the second argument to this function.
403**
drh4f0ee682007-03-30 20:43:40 +0000404** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000405** the error becomes persistent. Until the persisten error is cleared,
406** subsequent API calls on this Pager will immediately return the same
407** error code.
408**
409** A persistent error indicates that the contents of the pager-cache
410** cannot be trusted. This state can be cleared by completely discarding
411** the contents of the pager-cache. If a transaction was active when
412** the persistent error occured, then the rollback journal may need
413** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000414*/
danielk1977ae72d982007-10-03 08:46:44 +0000415static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000416static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000417 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000418 assert(
419 pPager->errCode==SQLITE_FULL ||
420 pPager->errCode==SQLITE_OK ||
421 (pPager->errCode & 0xff)==SQLITE_IOERR
422 );
danielk1977979f38e2007-03-27 16:19:51 +0000423 if(
drh4ac285a2006-09-15 07:28:50 +0000424 rc2==SQLITE_FULL ||
425 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000426 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000427 ){
428 pPager->errCode = rc;
danielk19778c0a7912008-08-20 14:49:23 +0000429 if( pPager->state==PAGER_UNLOCK
430 && sqlite3PcacheRefCount(pPager->pPCache)==0
431 ){
danielk1977ae72d982007-10-03 08:46:44 +0000432 /* If the pager is already unlocked, call pager_unlock() now to
433 ** clear the error state and ensure that the pager-cache is
434 ** completely empty.
435 */
436 pager_unlock(pPager);
437 }
danielk1977aef0bf62005-12-30 16:28:01 +0000438 }
439 return rc;
440}
441
drh477731b2007-06-16 03:06:27 +0000442/*
443** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
444** on the cache using a hash function. This is used for testing
445** and debugging only.
446*/
danielk19773c407372005-02-15 02:54:14 +0000447#ifdef SQLITE_CHECK_PAGES
448/*
449** Return a 32-bit hash of the page data for pPage.
450*/
drh477731b2007-06-16 03:06:27 +0000451static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000452 u32 hash = 0;
453 int i;
drh477731b2007-06-16 03:06:27 +0000454 for(i=0; i<nByte; i++){
455 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000456 }
457 return hash;
458}
drh477731b2007-06-16 03:06:27 +0000459static u32 pager_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000460 return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
461}
462static u32 pager_set_pagehash(PgHdr *pPage){
463 pPage->pageHash = pager_pagehash(pPage);
drh477731b2007-06-16 03:06:27 +0000464}
danielk19773c407372005-02-15 02:54:14 +0000465
466/*
467** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
468** is defined, and NDEBUG is not defined, an assert() statement checks
469** that the page is either dirty or still matches the calculated page-hash.
470*/
471#define CHECK_PAGE(x) checkPage(x)
472static void checkPage(PgHdr *pPg){
473 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +0000474 assert( !pPg->pageHash || pPager->errCode || MEMDB
475 || (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
danielk19773c407372005-02-15 02:54:14 +0000476}
477
478#else
drh8ffa8172007-06-18 17:25:17 +0000479#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000480#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000481#define CHECK_PAGE(x)
drh41d30272008-08-20 21:47:45 +0000482#endif /* SQLITE_CHECK_PAGES */
danielk19773c407372005-02-15 02:54:14 +0000483
drhed7c8552001-04-11 14:29:21 +0000484/*
danielk197776572402004-06-25 02:38:54 +0000485** When this is called the journal file for pager pPager must be open.
486** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000487** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000488**
danielk197765839c62007-08-30 08:08:17 +0000489** zMaster must point to a buffer of at least nMaster bytes allocated by
490** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
491** enough space to write the master journal name). If the master journal
492** name in the journal is longer than nMaster bytes (including a
493** nul-terminator), then this is handled as if no master journal name
494** were present in the journal.
495**
496** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000497** SQLITE_OK returned.
498*/
danielk197765839c62007-08-30 08:08:17 +0000499static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000500 int rc;
501 u32 len;
drheb206252004-10-01 02:00:31 +0000502 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000503 u32 cksum;
shane0b8d2762008-07-22 05:18:00 +0000504 u32 u; /* Unsigned loop counter */
danielk197776572402004-06-25 02:38:54 +0000505 unsigned char aMagic[8]; /* A buffer to hold the magic header */
506
danielk197765839c62007-08-30 08:08:17 +0000507 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000508
drh054889e2005-11-30 03:20:31 +0000509 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000510 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000511
danielk197762079062007-08-15 17:08:46 +0000512 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000513 if( rc!=SQLITE_OK ) return rc;
514
danielk197765839c62007-08-30 08:08:17 +0000515 if( len>=nMaster ){
516 return SQLITE_OK;
517 }
518
danielk197762079062007-08-15 17:08:46 +0000519 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000520 if( rc!=SQLITE_OK ) return rc;
521
danielk197762079062007-08-15 17:08:46 +0000522 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000523 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
524
danielk197765839c62007-08-30 08:08:17 +0000525 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000526 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000527 return rc;
528 }
danielk197765839c62007-08-30 08:08:17 +0000529 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000530
531 /* See if the checksum matches the master journal name */
shane0b8d2762008-07-22 05:18:00 +0000532 for(u=0; u<len; u++){
533 cksum -= zMaster[u];
danielk197765839c62007-08-30 08:08:17 +0000534 }
danielk19778191bff2004-06-28 04:52:30 +0000535 if( cksum ){
536 /* If the checksum doesn't add up, then one or more of the disk sectors
537 ** containing the master journal filename is corrupted. This means
538 ** definitely roll back, so just return SQLITE_OK and report a (nul)
539 ** master-journal filename.
540 */
danielk197765839c62007-08-30 08:08:17 +0000541 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000542 }
danielk197776572402004-06-25 02:38:54 +0000543
544 return SQLITE_OK;
545}
546
547/*
548** Seek the journal file descriptor to the next sector boundary where a
549** journal header may be read or written. Pager.journalOff is updated with
550** the new seek offset.
551**
552** i.e for a sector size of 512:
553**
554** Input Offset Output Offset
555** ---------------------------------------
556** 0 0
557** 512 512
558** 100 512
559** 2000 2048
560**
561*/
danielk197762079062007-08-15 17:08:46 +0000562static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000563 i64 offset = 0;
564 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000565 if( c ){
566 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
567 }
568 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
569 assert( offset>=c );
570 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
571 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000572}
573
574/*
drhf3a87622008-04-17 14:16:42 +0000575** Write zeros over the header of the journal file. This has the
576** effect of invalidating the journal file and committing the
577** transaction.
578*/
danielk1977df2566a2008-05-07 19:11:03 +0000579static int zeroJournalHdr(Pager *pPager, int doTruncate){
580 int rc = SQLITE_OK;
drhf3a87622008-04-17 14:16:42 +0000581 static const char zeroHdr[28];
582
danielk1977df2566a2008-05-07 19:11:03 +0000583 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000584 i64 iLimit = pPager->journalSizeLimit;
585
danielk1977df2566a2008-05-07 19:11:03 +0000586 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000587 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000588 rc = sqlite3OsTruncate(pPager->jfd, 0);
589 }else{
590 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
591 }
danielk197781620542008-06-07 05:19:37 +0000592 if( rc==SQLITE_OK && !pPager->noSync ){
danielk1977df2566a2008-05-07 19:11:03 +0000593 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
594 }
danielk1977b53e4962008-06-04 06:45:59 +0000595
596 /* At this point the transaction is committed but the write lock
597 ** is still held on the file. If there is a size limit configured for
598 ** the persistent journal and the journal file currently consumes more
599 ** space than that limit allows for, truncate it now. There is no need
600 ** to sync the file following this operation.
601 */
602 if( rc==SQLITE_OK && iLimit>0 ){
603 i64 sz;
604 rc = sqlite3OsFileSize(pPager->jfd, &sz);
605 if( rc==SQLITE_OK && sz>iLimit ){
606 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
607 }
608 }
drha06ecba2008-04-22 17:15:17 +0000609 }
drhf3a87622008-04-17 14:16:42 +0000610 return rc;
611}
612
613/*
danielk197776572402004-06-25 02:38:54 +0000614** The journal file must be open when this routine is called. A journal
615** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
616** current location.
617**
618** The format for the journal header is as follows:
619** - 8 bytes: Magic identifying journal format.
620** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
621** - 4 bytes: Random number used for page hash.
622** - 4 bytes: Initial database page count.
623** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000624** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000625**
danielk197767c007b2008-03-20 04:45:49 +0000626** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000627*/
628static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000629 int rc = SQLITE_OK;
630 char *zHeader = pPager->pTmpSpace;
631 int nHeader = pPager->pageSize;
632 int nWrite;
633
634 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
635 nHeader = JOURNAL_HDR_SZ(pPager);
636 }
danielk197776572402004-06-25 02:38:54 +0000637
danielk19774099f6e2007-03-19 11:25:20 +0000638 if( pPager->stmtHdrOff==0 ){
639 pPager->stmtHdrOff = pPager->journalOff;
640 }
641
danielk197762079062007-08-15 17:08:46 +0000642 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000643 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000644
drh97b57482006-01-10 20:32:32 +0000645 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +0000646
647 /*
648 ** Write the nRec Field - the number of page records that follow this
649 ** journal header. Normally, zero is written to this value at this time.
650 ** After the records are added to the journal (and the journal synced,
651 ** if in full-sync mode), the zero is overwritten with the true number
652 ** of records (see syncJournal()).
653 **
654 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
655 ** reading the journal this value tells SQLite to assume that the
656 ** rest of the journal file contains valid page records. This assumption
657 ** is dangerous, as if a failure occured whilst writing to the journal
658 ** file it may contain some garbage data. There are two scenarios
659 ** where this risk can be ignored:
660 **
661 ** * When the pager is in no-sync mode. Corruption can follow a
662 ** power failure in this case anyway.
663 **
664 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
665 ** that garbage data is never appended to the journal file.
666 */
667 assert(pPager->fd->pMethods||pPager->noSync);
668 if( (pPager->noSync)
669 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
670 ){
671 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
672 }else{
673 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
674 }
675
drh97b57482006-01-10 20:32:32 +0000676 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +0000677 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +0000678 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
679 /* The initial database size */
680 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
681 /* The assumed sector size for this process */
682 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +0000683 if( pPager->journalHdr==0 ){
684 /* The page size */
685 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
686 }
danielk197776572402004-06-25 02:38:54 +0000687
danielk1977a664f8e2008-04-22 14:31:48 +0000688 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
689 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
690 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
691 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +0000692 }
danielk1977a664f8e2008-04-22 14:31:48 +0000693
danielk197776572402004-06-25 02:38:54 +0000694 return rc;
695}
696
697/*
698** The journal file must be open when this is called. A journal header file
699** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
700** file. See comments above function writeJournalHdr() for a description of
701** the journal header format.
702**
703** If the header is read successfully, *nRec is set to the number of
704** page records following this header and *dbSize is set to the size of the
705** database before the transaction began, in pages. Also, pPager->cksumInit
706** is set to the value read from the journal header. SQLITE_OK is returned
707** in this case.
708**
709** If the journal header file appears to be corrupted, SQLITE_DONE is
710** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
711** cannot be read from the journal file an error code is returned.
712*/
713static int readJournalHdr(
714 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000715 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000716 u32 *pNRec,
717 u32 *pDbSize
718){
719 int rc;
720 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000721 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +0000722 int iPageSize;
danielk197776572402004-06-25 02:38:54 +0000723
danielk197762079062007-08-15 17:08:46 +0000724 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000725 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
726 return SQLITE_DONE;
727 }
danielk197762079062007-08-15 17:08:46 +0000728 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000729
danielk197762079062007-08-15 17:08:46 +0000730 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000731 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000732 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000733
734 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
735 return SQLITE_DONE;
736 }
737
danielk197762079062007-08-15 17:08:46 +0000738 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000739 if( rc ) return rc;
740
danielk197762079062007-08-15 17:08:46 +0000741 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000742 if( rc ) return rc;
743
danielk197762079062007-08-15 17:08:46 +0000744 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000745 if( rc ) return rc;
746
danielk197767c007b2008-03-20 04:45:49 +0000747 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
748 if( rc==SQLITE_OK
749 && iPageSize>=512
750 && iPageSize<=SQLITE_MAX_PAGE_SIZE
751 && ((iPageSize-1)&iPageSize)==0
752 ){
753 u16 pagesize = iPageSize;
754 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
755 }
756 if( rc ) return rc;
757
danielk197776572402004-06-25 02:38:54 +0000758 /* Update the assumed sector-size to match the value used by
759 ** the process that created this journal. If this journal was
760 ** created by a process other than this one, then this routine
761 ** is being called from within pager_playback(). The local value
762 ** of Pager.sectorSize is restored at the end of that routine.
763 */
danielk197762079062007-08-15 17:08:46 +0000764 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000765 if( rc ) return rc;
766
767 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +0000768 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000769}
770
771
772/*
773** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000774** pPager at the current location. The master journal name must be the last
775** thing written to a journal file. If the pager is in full-sync mode, the
776** journal file descriptor is advanced to the next sector boundary before
777** anything is written. The format is:
778**
779** + 4 bytes: PAGER_MJ_PGNO.
780** + N bytes: length of master journal name.
781** + 4 bytes: N
782** + 4 bytes: Master journal name checksum.
783** + 8 bytes: aJournalMagic[].
784**
785** The master journal page checksum is the sum of the bytes in the master
786** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000787**
788** If zMaster is a NULL pointer (occurs for a single database transaction),
789** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000790*/
791static int writeMasterJournal(Pager *pPager, const char *zMaster){
792 int rc;
793 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000794 int i;
danielk197762079062007-08-15 17:08:46 +0000795 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +0000796 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +0000797 u32 cksum = 0;
798 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000799
800 if( !zMaster || pPager->setMaster) return SQLITE_OK;
801 pPager->setMaster = 1;
802
803 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000804 for(i=0; i<len; i++){
805 cksum += zMaster[i];
806 }
danielk197776572402004-06-25 02:38:54 +0000807
808 /* If in full-sync mode, advance to the next disk sector before writing
809 ** the master journal name. This is in case the previous page written to
810 ** the journal has already been synced.
811 */
812 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000813 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000814 }
danielk197762079062007-08-15 17:08:46 +0000815 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000816 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000817
danielk197762079062007-08-15 17:08:46 +0000818 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000819 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000820 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000821
danielk197762079062007-08-15 17:08:46 +0000822 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000823 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000824 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000825
drh97b57482006-01-10 20:32:32 +0000826 put32bits(zBuf, len);
827 put32bits(&zBuf[4], cksum);
828 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000829 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +0000830 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +0000831 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +0000832
833 /* If the pager is in peristent-journal mode, then the physical
834 ** journal-file may extend past the end of the master-journal name
835 ** and 8 bytes of magic data just written to the file. This is
836 ** dangerous because the code to rollback a hot-journal file
837 ** will not be able to find the master-journal name to determine
838 ** whether or not the journal is hot.
839 **
840 ** Easiest thing to do in this scenario is to truncate the journal
841 ** file to the required size.
842 */
843 if( (rc==SQLITE_OK)
844 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
845 && jrnlSize>jrnlOff
846 ){
847 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
848 }
danielk197776572402004-06-25 02:38:54 +0000849 return rc;
850}
851
852/*
drhed7c8552001-04-11 14:29:21 +0000853** Find a page in the hash table given its page number. Return
854** a pointer to the page or NULL if not found.
855*/
drhd9b02572001-04-15 00:37:09 +0000856static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000857 PgHdr *p;
danielk19778c0a7912008-08-20 14:49:23 +0000858 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &p);
drhed7c8552001-04-11 14:29:21 +0000859 return p;
860}
861
862/*
danielk1977e180dd92007-04-05 17:15:52 +0000863** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000864** sets the state of the pager back to what it was when it was first
865** opened. Any outstanding pages are invalidated and subsequent attempts
866** to access those pages will likely result in a coredump.
867*/
drhd9b02572001-04-15 00:37:09 +0000868static void pager_reset(Pager *pPager){
danielk1977efaaf572006-01-16 11:29:19 +0000869 if( pPager->errCode ) return;
danielk19778c0a7912008-08-20 14:49:23 +0000870 sqlite3PcacheClear(pPager->pPCache);
danielk1977e277be02007-03-23 18:12:06 +0000871}
872
873/*
danielk1977ae72d982007-10-03 08:46:44 +0000874** Unlock the database file.
875**
876** If the pager is currently in error state, discard the contents of
877** the cache and reset the Pager structure internal state. If there is
878** an open journal-file, then the next time a shared-lock is obtained
879** on the pager file (by this or any other process), it will be
880** treated as a hot-journal and rolled back.
881*/
882static void pager_unlock(Pager *pPager){
883 if( !pPager->exclusiveMode ){
884 if( !MEMDB ){
drh1aa5af12008-03-07 19:51:14 +0000885 int rc = osUnlock(pPager->fd, NO_LOCK);
drh308aa322008-03-07 20:14:38 +0000886 if( rc ) pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000887 pPager->dbSize = -1;
888 IOTRACE(("UNLOCK %p\n", pPager))
889
drh16e45a42008-04-19 20:34:18 +0000890 /* Always close the journal file when dropping the database lock.
891 ** Otherwise, another connection with journal_mode=delete might
892 ** delete the file out from under us.
893 */
894 if( pPager->journalOpen ){
895 sqlite3OsClose(pPager->jfd);
896 pPager->journalOpen = 0;
897 sqlite3BitvecDestroy(pPager->pInJournal);
898 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +0000899 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
900 pPager->pAlwaysRollback = 0;
drh16e45a42008-04-19 20:34:18 +0000901 }
902
danielk1977ae72d982007-10-03 08:46:44 +0000903 /* If Pager.errCode is set, the contents of the pager cache cannot be
904 ** trusted. Now that the pager file is unlocked, the contents of the
905 ** cache can be discarded and the error code safely cleared.
906 */
907 if( pPager->errCode ){
drh1aa5af12008-03-07 19:51:14 +0000908 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +0000909 pager_reset(pPager);
910 if( pPager->stmtOpen ){
911 sqlite3OsClose(pPager->stfd);
drhf5e7bb52008-02-18 14:47:33 +0000912 sqlite3BitvecDestroy(pPager->pInStmt);
913 pPager->pInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000914 }
danielk1977ae72d982007-10-03 08:46:44 +0000915 pPager->stmtOpen = 0;
916 pPager->stmtInUse = 0;
917 pPager->journalOff = 0;
918 pPager->journalStarted = 0;
919 pPager->stmtAutoopen = 0;
920 pPager->origDbSize = 0;
921 }
922 }
923
924 if( !MEMDB || pPager->errCode==SQLITE_OK ){
925 pPager->state = PAGER_UNLOCK;
926 pPager->changeCountDone = 0;
927 }
928 }
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;
drhb7f91642004-10-31 02:22:47 +0000965 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000966 if( pPager->state<PAGER_RESERVED ){
967 return SQLITE_OK;
968 }
danielk19773b8a05f2007-03-19 17:44:26 +0000969 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +0000970 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +0000971 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +0000972 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000973 }
drhda47d772002-12-02 04:25:19 +0000974 if( pPager->journalOpen ){
danielk197793f7af92008-05-09 16:57:50 +0000975 if( pPager->exclusiveMode
976 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
977 ){
978 rc = zeroJournalHdr(pPager, hasMaster);
979 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +0000980 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +0000981 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +0000982 }else{
danielk1977b4b47412007-08-17 15:53:36 +0000983 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +0000984 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +0000985 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +0000986 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +0000987 }
danielk197741483462007-03-24 16:45:04 +0000988 }
drhf5e7bb52008-02-18 14:47:33 +0000989 sqlite3BitvecDestroy(pPager->pInJournal);
990 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +0000991 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
992 pPager->pAlwaysRollback = 0;
danielk19778c0a7912008-08-20 14:49:23 +0000993 sqlite3PcacheCleanAll(pPager->pPCache);
danielk19773c407372005-02-15 02:54:14 +0000994#ifdef SQLITE_CHECK_PAGES
danielk19778c0a7912008-08-20 14:49:23 +0000995 sqlite3PcacheIterate(pPager->pPCache, pager_set_pagehash);
danielk19773c407372005-02-15 02:54:14 +0000996#endif
danielk1977a1fa00d2008-08-27 15:16:33 +0000997 sqlite3PcacheSetFlags(pPager->pPCache,
998 ~(PGHDR_IN_JOURNAL | PGHDR_NEED_SYNC), 0
danielk19778c0a7912008-08-20 14:49:23 +0000999 );
danielk1977ef317ab2004-06-23 10:43:10 +00001000 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001001 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001002 }else{
drhf5e7bb52008-02-18 14:47:33 +00001003 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001004 }
danielk1977979f38e2007-03-27 16:19:51 +00001005
danielk197741483462007-03-24 16:45:04 +00001006 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001007 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001008 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001009 }else if( pPager->state==PAGER_SYNCED ){
1010 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001011 }
danielk1977334cdb62007-03-26 08:05:12 +00001012 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001013 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001014 pPager->needSync = 0;
danielk19778c0a7912008-08-20 14:49:23 +00001015 /* lruListSetFirstSynced(pPager); */
drh588f5bc2007-01-02 18:41:54 +00001016 pPager->dbSize = -1;
drhd138c012008-05-13 00:58:18 +00001017 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001018
1019 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001020}
1021
drhed7c8552001-04-11 14:29:21 +00001022/*
drh968af522003-02-11 14:55:40 +00001023** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001024**
1025** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001026** random initial value and the page number. We experimented with
1027** a checksum of the entire data, but that was found to be too slow.
1028**
1029** Note that the page number is stored at the beginning of data and
1030** the checksum is stored at the end. This is important. If journal
1031** corruption occurs due to a power failure, the most likely scenario
1032** is that one end or the other of the record will be changed. It is
1033** much less likely that the two ends of the journal record will be
1034** correct and the middle be corrupt. Thus, this "checksum" scheme,
1035** though fast and simple, catches the mostly likely kind of corruption.
1036**
1037** FIX ME: Consider adding every 200th (or so) byte of the data to the
1038** checksum. That way if a single page spans 3 or more disk sectors and
1039** only the middle sector is corrupt, we will still have a reasonable
1040** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001041*/
drh74161702006-02-24 02:53:49 +00001042static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001043 u32 cksum = pPager->cksumInit;
1044 int i = pPager->pageSize-200;
1045 while( i>0 ){
1046 cksum += aData[i];
1047 i -= 200;
1048 }
drh968af522003-02-11 14:55:40 +00001049 return cksum;
1050}
1051
drh605ad8f2006-05-03 23:34:05 +00001052/* Forward declaration */
1053static void makeClean(PgHdr*);
1054
drh968af522003-02-11 14:55:40 +00001055/*
drhfa86c412002-02-02 15:01:15 +00001056** Read a single page from the journal file opened on file descriptor
1057** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001058**
drh726de592004-06-10 23:35:50 +00001059** If useCksum==0 it means this journal does not use checksums. Checksums
1060** are not used in statement journals because statement journals do not
1061** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001062*/
danielk197762079062007-08-15 17:08:46 +00001063static int pager_playback_one_page(
1064 Pager *pPager,
1065 sqlite3_file *jfd,
1066 i64 offset,
1067 int useCksum
1068){
drhfa86c412002-02-02 15:01:15 +00001069 int rc;
drhae2b40c2004-06-09 19:03:54 +00001070 PgHdr *pPg; /* An existing page in the cache */
1071 Pgno pgno; /* The page number of a page in journal */
1072 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001073 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001074
drh96362842005-03-20 22:47:56 +00001075 /* useCksum should be true for the main journal and false for
1076 ** statement journals. Verify that this is always the case
1077 */
drh9cbe6352005-11-29 03:13:21 +00001078 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001079 assert( aData );
drh96362842005-03-20 22:47:56 +00001080
danielk197762079062007-08-15 17:08:46 +00001081 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001082 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001083 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001084 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001085 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001086
drh968af522003-02-11 14:55:40 +00001087 /* Sanity checking on the page. This is more important that I originally
1088 ** thought. If a power failure occurs while the journal is being written,
1089 ** it could cause invalid data to be written into the journal. We need to
1090 ** detect this invalid data (with high probability) and ignore it.
1091 */
danielk197775edc162004-06-26 01:48:18 +00001092 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001093 return SQLITE_DONE;
1094 }
drhae2b40c2004-06-09 19:03:54 +00001095 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001096 return SQLITE_OK;
1097 }
drhae2b40c2004-06-09 19:03:54 +00001098 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001099 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001100 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001101 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001102 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001103 return SQLITE_DONE;
1104 }
1105 }
drhfa86c412002-02-02 15:01:15 +00001106
danielk1977aa5ccdf2004-06-14 05:10:42 +00001107 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001108
1109 /* If the pager is in RESERVED state, then there must be a copy of this
1110 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001111 ** not the database file. The page is left marked dirty in this case.
1112 **
danielk19772df71c72007-05-24 07:22:42 +00001113 ** An exception to the above rule: If the database is in no-sync mode
1114 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001115 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1116 ** during a Movepage() call, then the page may not be in the cache
1117 ** either. So the condition described in the above paragraph is not
1118 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001119 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001120 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1121 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001122 **
1123 ** Ticket #1171: The statement journal might contain page content that is
1124 ** different from the page content at the start of the transaction.
1125 ** This occurs when a page is changed prior to the start of a statement
1126 ** then changed again within the statement. When rolling back such a
1127 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001128 ** for certain that original page contents are synced into the main rollback
1129 ** journal. Otherwise, a power loss might leave modified data in the
1130 ** database file without an entry in the rollback journal that can
1131 ** restore the database to its original form. Two conditions must be
1132 ** met before writing to the database files. (1) the database must be
1133 ** locked. (2) we know that the original page content is fully synced
1134 ** in the main journal either because the page is not in cache or else
1135 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001136 **
1137 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1138 ** is possible to fail a statement on a database that does not yet exist.
1139 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001140 */
drhae2b40c2004-06-09 19:03:54 +00001141 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001142 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1143 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
danielk19778c0a7912008-08-20 14:49:23 +00001144 if( (pPager->state>=PAGER_EXCLUSIVE)
1145 && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC))
1146 && (pPager->fd->pMethods)
1147 ){
drh281b21d2008-08-22 12:57:08 +00001148 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
1149 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst);
danielk1977a3f3a5f2004-06-10 04:32:16 +00001150 }
drhfa86c412002-02-02 15:01:15 +00001151 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001152 /* No page should ever be explicitly rolled back that is in use, except
1153 ** for page 1 which is held in use in order to keep the lock on the
1154 ** database active. However such a page may be rolled back as a result
1155 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001156 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001157 */
drhb6f41482004-05-14 01:58:11 +00001158 void *pData;
danielk197728129562005-01-11 10:25:06 +00001159 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
danielk19778c0a7912008-08-20 14:49:23 +00001160 pData = pPg->pData;
drhae2b40c2004-06-09 19:03:54 +00001161 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001162 if( pPager->xReiniter ){
1163 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001164 }
danielk19778c0a7912008-08-20 14:49:23 +00001165 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00001166#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001167 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001168#endif
drh86a88112007-04-16 15:02:19 +00001169 /* If this was page 1, then restore the value of Pager.dbFileVers.
1170 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001171 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001172 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001173 }
drh86a88112007-04-16 15:02:19 +00001174
1175 /* Decode the page just read from disk */
1176 CODEC1(pPager, pData, pPg->pgno, 3);
danielk19778c0a7912008-08-20 14:49:23 +00001177 sqlite3PcacheRelease(pPg);
drhfa86c412002-02-02 15:01:15 +00001178 }
1179 return rc;
1180}
1181
1182/*
danielk197713adf8a2004-06-03 16:08:41 +00001183** Parameter zMaster is the name of a master journal file. A single journal
1184** file that referred to the master journal file has just been rolled back.
1185** This routine checks if it is possible to delete the master journal file,
1186** and does so if it is.
drh726de592004-06-10 23:35:50 +00001187**
danielk197765839c62007-08-30 08:08:17 +00001188** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1189** available for use within this function.
1190**
1191**
drh726de592004-06-10 23:35:50 +00001192** The master journal file contains the names of all child journals.
1193** To tell if a master journal can be deleted, check to each of the
1194** children. If all children are either missing or do not refer to
1195** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001196*/
danielk1977b4b47412007-08-17 15:53:36 +00001197static int pager_delmaster(Pager *pPager, const char *zMaster){
1198 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001199 int rc;
1200 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001201 sqlite3_file *pMaster;
1202 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001203 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001204 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001205
1206 /* Open the master journal file exclusively in case some other process
1207 ** is running this routine also. Not that it makes too much difference.
1208 */
drhe5ae5732008-06-15 02:51:47 +00001209 pMaster = (sqlite3_file *)sqlite3Malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001210 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001211 if( !pMaster ){
1212 rc = SQLITE_NOMEM;
1213 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001214 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1215 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001216 }
danielk197713adf8a2004-06-03 16:08:41 +00001217 if( rc!=SQLITE_OK ) goto delmaster_out;
1218 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001219
1220 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001221 if( rc!=SQLITE_OK ) goto delmaster_out;
1222
1223 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001224 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001225 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001226 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001227
1228 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001229 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001230 */
drhe5ae5732008-06-15 02:51:47 +00001231 zMasterJournal = (char *)sqlite3Malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001232 if( !zMasterJournal ){
1233 rc = SQLITE_NOMEM;
1234 goto delmaster_out;
1235 }
danielk197765839c62007-08-30 08:08:17 +00001236 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001237 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001238 if( rc!=SQLITE_OK ) goto delmaster_out;
1239
danielk19775865e3d2004-06-14 06:03:57 +00001240 zJournal = zMasterJournal;
1241 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977861f7452008-06-05 11:39:11 +00001242 int exists;
1243 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
1244 if( rc!=SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001245 goto delmaster_out;
1246 }
danielk1977861f7452008-06-05 11:39:11 +00001247 if( exists ){
danielk197713adf8a2004-06-03 16:08:41 +00001248 /* One of the journals pointed to by the master journal exists.
1249 ** Open it and check if it points at the master journal. If
1250 ** so, return without deleting the master journal file.
1251 */
drh3b7b78b2004-11-24 01:16:43 +00001252 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001253 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1254 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001255 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001256 goto delmaster_out;
1257 }
danielk197713adf8a2004-06-03 16:08:41 +00001258
danielk197765839c62007-08-30 08:08:17 +00001259 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001260 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001261 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001262 goto delmaster_out;
1263 }
danielk197776572402004-06-25 02:38:54 +00001264
danielk197765839c62007-08-30 08:08:17 +00001265 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001266 if( c ){
danielk197776572402004-06-25 02:38:54 +00001267 /* We have a match. Do not delete the master journal file. */
1268 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001269 }
1270 }
danielk19775865e3d2004-06-14 06:03:57 +00001271 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001272 }
1273 }
1274
danielk1977fee2d252007-08-18 10:59:19 +00001275 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001276
1277delmaster_out:
1278 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001279 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001280 }
1281 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001282 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001283 }
danielk1977b4b47412007-08-17 15:53:36 +00001284 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001285 return rc;
1286}
1287
drha6abd042004-06-09 17:37:22 +00001288
danielk1977e180dd92007-04-05 17:15:52 +00001289static void pager_truncate_cache(Pager *pPager);
1290
drha6abd042004-06-09 17:37:22 +00001291/*
drhcb4c40b2004-08-18 19:09:43 +00001292** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001293** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001294**
1295** Might might be the case that the file on disk is smaller than nPage.
1296** This can happen, for example, if we are in the middle of a transaction
1297** which has extended the file size and the new pages are still all held
1298** in cache, then an INSERT or UPDATE does a statement rollback. Some
1299** operating system implementations can get confused if you try to
1300** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001301** so detect this case and write a single zero byte to the end of the new
1302** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001303*/
1304static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001305 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001306 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001307 i64 currentSize, newSize;
1308 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1309 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001310 if( rc==SQLITE_OK && currentSize!=newSize ){
1311 if( currentSize>newSize ){
1312 rc = sqlite3OsTruncate(pPager->fd, newSize);
1313 }else{
1314 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1315 }
drh7fe3f7e2007-11-29 18:44:27 +00001316 }
danielk1977e180dd92007-04-05 17:15:52 +00001317 }
1318 if( rc==SQLITE_OK ){
1319 pPager->dbSize = nPage;
1320 pager_truncate_cache(pPager);
1321 }
1322 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001323}
1324
1325/*
drhc80f0582007-05-01 16:59:48 +00001326** Set the sectorSize for the given pager.
1327**
drh334c80d2008-03-28 17:41:13 +00001328** The sector size is at least as big as the sector size reported
1329** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001330*/
1331static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001332 assert(pPager->fd->pMethods||pPager->tempFile);
1333 if( !pPager->tempFile ){
1334 /* Sector size doesn't matter for temporary files. Also, the file
1335 ** may not have been opened yet, in whcih case the OsSectorSize()
1336 ** call will segfault.
1337 */
1338 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1339 }
drh334c80d2008-03-28 17:41:13 +00001340 if( pPager->sectorSize<512 ){
1341 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001342 }
1343}
1344
1345/*
drhed7c8552001-04-11 14:29:21 +00001346** Playback the journal and thus restore the database file to
1347** the state it was in before we started making changes.
1348**
drh34e79ce2004-02-08 06:05:46 +00001349** The journal file format is as follows:
1350**
drhae2b40c2004-06-09 19:03:54 +00001351** (1) 8 byte prefix. A copy of aJournalMagic[].
1352** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001353** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001354** number of page records from the journal size.
1355** (3) 4 byte big-endian integer which is the initial value for the
1356** sanity checksum.
1357** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001358** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001359** (5) 4 byte big-endian integer which is the sector size. The header
1360** is this many bytes in size.
1361** (6) 4 byte big-endian integer which is the page case.
1362** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001363** name. The value may be zero (indicate that there is no master
1364** journal.)
drh334c80d2008-03-28 17:41:13 +00001365** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001366** and might be shorter than the value read from (5). If the first byte
1367** of the name is \000 then there is no master journal. The master
1368** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001369** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001370** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001371** + pPager->pageSize bytes of data.
1372** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001373**
drh334c80d2008-03-28 17:41:13 +00001374** When we speak of the journal header, we mean the first 8 items above.
1375** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001376**
1377** Call the value from the second bullet "nRec". nRec is the number of
1378** valid page entries in the journal. In most cases, you can compute the
1379** value of nRec from the size of the journal file. But if a power
1380** failure occurred while the journal was being written, it could be the
1381** case that the size of the journal file had already been increased but
1382** the extra entries had not yet made it safely to disk. In such a case,
1383** the value of nRec computed from the file size would be too large. For
1384** that reason, we always use the nRec value in the header.
1385**
1386** If the nRec value is 0xffffffff it means that nRec should be computed
1387** from the file size. This value is used when the user selects the
1388** no-sync option for the journal. A power failure could lead to corruption
1389** in this case. But for things like temporary table (which will be
1390** deleted when the power is restored) we don't care.
1391**
drhd9b02572001-04-15 00:37:09 +00001392** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001393** journal file then all pages up to the first corrupted page are rolled
1394** back (or no pages if the journal header is corrupted). The journal file
1395** is then deleted and SQLITE_OK returned, just as if no corruption had
1396** been encountered.
1397**
1398** If an I/O or malloc() error occurs, the journal-file is not deleted
1399** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001400*/
danielk1977e277be02007-03-23 18:12:06 +00001401static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001402 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001403 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001404 u32 nRec; /* Number of Records in the journal */
shane0b8d2762008-07-22 05:18:00 +00001405 u32 u; /* Unsigned loop counter */
drhd9b02572001-04-15 00:37:09 +00001406 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001407 int rc; /* Result code of a subroutine */
danielk1977861f7452008-06-05 11:39:11 +00001408 int res = 1; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001409 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001410
drhc3a64ba2001-11-22 00:01:27 +00001411 /* Figure out how many records are in the journal. Abort early if
1412 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001413 */
drh8cfbf082001-09-19 13:22:39 +00001414 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001415 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001416 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001417 goto end_playback;
1418 }
drh240c5792004-02-08 00:40:52 +00001419
danielk197776572402004-06-25 02:38:54 +00001420 /* Read the master journal name from the journal, if it is present.
1421 ** If a master journal file name is specified, but the file is not
1422 ** present on disk, then the journal is not hot and does not need to be
1423 ** played back.
drh240c5792004-02-08 00:40:52 +00001424 */
danielk197765839c62007-08-30 08:08:17 +00001425 zMaster = pPager->pTmpSpace;
1426 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977861f7452008-06-05 11:39:11 +00001427 if( rc==SQLITE_OK && zMaster[0] ){
1428 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
drhc3a64ba2001-11-22 00:01:27 +00001429 }
danielk197765839c62007-08-30 08:08:17 +00001430 zMaster = 0;
danielk1977861f7452008-06-05 11:39:11 +00001431 if( rc!=SQLITE_OK || !res ){
danielk1977ce98bba2008-04-03 10:13:01 +00001432 goto end_playback;
1433 }
1434 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001435
danielk197776572402004-06-25 02:38:54 +00001436 /* This loop terminates either when the readJournalHdr() call returns
1437 ** SQLITE_DONE or an IO error occurs. */
1438 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001439
danielk197776572402004-06-25 02:38:54 +00001440 /* Read the next journal header from the journal file. If there are
1441 ** not enough bytes left in the journal file for a complete header, or
1442 ** it is corrupted, then a process must of failed while writing it.
1443 ** This indicates nothing more needs to be rolled back.
1444 */
1445 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1446 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001447 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001448 rc = SQLITE_OK;
1449 }
danielk197776572402004-06-25 02:38:54 +00001450 goto end_playback;
1451 }
1452
1453 /* If nRec is 0xffffffff, then this journal was created by a process
1454 ** working in no-sync mode. This means that the rest of the journal
1455 ** file consists of pages, there are no more journal headers. Compute
1456 ** the value of nRec based on this assumption.
1457 */
1458 if( nRec==0xffffffff ){
1459 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1460 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1461 }
1462
danielk1977e277be02007-03-23 18:12:06 +00001463 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001464 ** process and if this is the final header in the journal, then it means
1465 ** that this part of the journal was being filled but has not yet been
1466 ** synced to disk. Compute the number of pages based on the remaining
1467 ** size of the file.
1468 **
1469 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001470 */
drh8940f4e2007-08-11 00:26:20 +00001471 if( nRec==0 && !isHot &&
1472 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001473 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1474 }
1475
danielk197776572402004-06-25 02:38:54 +00001476 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001477 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001478 */
danielk1977e180dd92007-04-05 17:15:52 +00001479 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001480 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001481 if( rc!=SQLITE_OK ){
1482 goto end_playback;
1483 }
danielk197776572402004-06-25 02:38:54 +00001484 }
1485
danielk197776572402004-06-25 02:38:54 +00001486 /* Copy original pages out of the journal and back into the database file.
1487 */
shane0b8d2762008-07-22 05:18:00 +00001488 for(u=0; u<nRec; u++){
danielk197762079062007-08-15 17:08:46 +00001489 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001490 if( rc!=SQLITE_OK ){
1491 if( rc==SQLITE_DONE ){
1492 rc = SQLITE_OK;
1493 pPager->journalOff = szJ;
1494 break;
1495 }else{
1496 goto end_playback;
1497 }
1498 }
drh968af522003-02-11 14:55:40 +00001499 }
drhed7c8552001-04-11 14:29:21 +00001500 }
drh580eeaf2006-02-24 03:09:37 +00001501 /*NOTREACHED*/
1502 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001503
1504end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001505 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001506 zMaster = pPager->pTmpSpace;
1507 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1508 }
1509 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001510 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001511 }
danielk197765839c62007-08-30 08:08:17 +00001512 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001513 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001514 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001515 */
danielk197765839c62007-08-30 08:08:17 +00001516 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001517 }
danielk197776572402004-06-25 02:38:54 +00001518
1519 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001520 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001521 ** value. Reset it to the correct value for this process.
1522 */
drhc80f0582007-05-01 16:59:48 +00001523 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001524 return rc;
drhed7c8552001-04-11 14:29:21 +00001525}
1526
1527/*
drhac69b052004-05-12 13:30:07 +00001528** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001529**
1530** This is similar to playing back the transaction journal but with
1531** a few extra twists.
1532**
drh663fc632002-02-02 18:49:19 +00001533** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001534** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001535** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001536**
drhac69b052004-05-12 13:30:07 +00001537** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001538** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001539** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001540*/
drh3aac2dd2004-04-26 14:10:20 +00001541static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001542 i64 szJ; /* Size of the full journal */
1543 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001544 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001545 int i; /* Loop counter */
1546 int rc;
1547
danielk197776572402004-06-25 02:38:54 +00001548 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001549
danielk19774099f6e2007-03-19 11:25:20 +00001550 /* Set hdrOff to be the offset just after the end of the last journal
1551 ** page written before the first journal-header for this statement
1552 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001553 ** header was written.
1554 */
1555 hdrOff = pPager->stmtHdrOff;
1556 assert( pPager->fullSync || !hdrOff );
1557 if( !hdrOff ){
1558 hdrOff = szJ;
1559 }
1560
drhfa86c412002-02-02 15:01:15 +00001561 /* Truncate the database back to its original size.
1562 */
danielk1977e180dd92007-04-05 17:15:52 +00001563 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001564 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001565
drhac69b052004-05-12 13:30:07 +00001566 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001567 */
drhac69b052004-05-12 13:30:07 +00001568 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001569 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001570
drhac69b052004-05-12 13:30:07 +00001571 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001572 ** database file. Note that the statement journal omits checksums from
1573 ** each record since power-failure recovery is not important to statement
1574 ** journals.
drhfa86c412002-02-02 15:01:15 +00001575 */
danielk197762079062007-08-15 17:08:46 +00001576 for(i=0; i<nRec; i++){
1577 i64 offset = i*(4+pPager->pageSize);
1578 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001579 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001580 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001581 }
1582
danielk197776572402004-06-25 02:38:54 +00001583 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1584 ** was the size of the journal file when this statement was started, so
1585 ** everything after that needs to be rolled back, either into the
1586 ** database, the memory cache, or both.
1587 **
1588 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1589 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001590 */
danielk197776572402004-06-25 02:38:54 +00001591 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001592 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001593 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001594 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001595 assert( rc!=SQLITE_DONE );
1596 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1597 }
1598
1599 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001600 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001601 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001602 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001603 if( rc!=SQLITE_OK ){
1604 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001605 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001606 }
danielk1977f0113002006-01-24 12:09:17 +00001607 if( nJRec==0 ){
1608 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001609 }
danielk1977f0113002006-01-24 12:09:17 +00001610 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001611 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001612 assert( rc!=SQLITE_DONE );
1613 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1614 }
drhfa86c412002-02-02 15:01:15 +00001615 }
danielk197776572402004-06-25 02:38:54 +00001616
1617 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001618
drh3aac2dd2004-04-26 14:10:20 +00001619end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001620 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001621 pPager->journalOff = szJ;
1622 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001623 }
1624 return rc;
1625}
1626
1627/*
drhf57b14a2001-09-14 18:54:08 +00001628** Change the maximum number of in-memory pages that are allowed.
1629*/
danielk19773b8a05f2007-03-19 17:44:26 +00001630void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
danielk19778c0a7912008-08-20 14:49:23 +00001631 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001632}
1633
1634/*
drh973b6e32003-02-12 14:09:42 +00001635** Adjust the robustness of the database to damage due to OS crashes
1636** or power failures by changing the number of syncs()s when writing
1637** the rollback journal. There are three levels:
1638**
drh054889e2005-11-30 03:20:31 +00001639** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001640** for temporary and transient files.
1641**
1642** NORMAL The journal is synced once before writes begin on the
1643** database. This is normally adequate protection, but
1644** it is theoretically possible, though very unlikely,
1645** that an inopertune power failure could leave the journal
1646** in a state which would cause damage to the database
1647** when it is rolled back.
1648**
1649** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001650** database (with some additional information - the nRec field
1651** of the journal header - being written in between the two
1652** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001653** single disk sector is atomic, then this mode provides
1654** assurance that the journal will not be corrupted to the
1655** point of causing damage to the database during rollback.
1656**
1657** Numeric values associated with these states are OFF==1, NORMAL=2,
1658** and FULL=3.
1659*/
danielk197793758c82005-01-21 08:13:14 +00001660#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh281b21d2008-08-22 12:57:08 +00001661void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){
drh973b6e32003-02-12 14:09:42 +00001662 pPager->noSync = level==1 || pPager->tempFile;
1663 pPager->fullSync = level==3 && !pPager->tempFile;
drh281b21d2008-08-22 12:57:08 +00001664 pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001665 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001666}
danielk197793758c82005-01-21 08:13:14 +00001667#endif
drh973b6e32003-02-12 14:09:42 +00001668
1669/*
drhaf6df112005-06-07 02:12:30 +00001670** The following global variable is incremented whenever the library
1671** attempts to open a temporary file. This information is used for
1672** testing and analysis only.
1673*/
drh0f7eb612006-08-08 13:51:43 +00001674#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001675int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001676#endif
drhaf6df112005-06-07 02:12:30 +00001677
1678/*
drh3f56e6e2007-03-15 01:16:47 +00001679** Open a temporary file.
1680**
1681** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001682** other error code if we fail. The OS will automatically delete the temporary
1683** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001684*/
danielk1977b4b47412007-08-17 15:53:36 +00001685static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00001686 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00001687 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00001688 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00001689){
drhfa86c412002-02-02 15:01:15 +00001690 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001691
drh0f7eb612006-08-08 13:51:43 +00001692#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001693 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001694#endif
danielk1977b4b47412007-08-17 15:53:36 +00001695
drh33f4e022007-09-03 15:19:34 +00001696 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
1697 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00001698 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00001699 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00001700 return rc;
1701}
1702
danielk1977a858aa22008-08-22 16:22:17 +00001703static int pagerStress(void *,PgHdr *);
danielk19778c0a7912008-08-20 14:49:23 +00001704
drhfa86c412002-02-02 15:01:15 +00001705/*
drhed7c8552001-04-11 14:29:21 +00001706** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001707** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001708** the first call to sqlite3PagerGet() and is only held open until the
1709** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001710**
drh6446c4d2001-12-15 14:22:18 +00001711** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00001712** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00001713** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001714**
1715** If zFilename is ":memory:" then all information is held in cache.
1716** It is never written to disk. This can be used to implement an
1717** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001718*/
danielk19773b8a05f2007-03-19 17:44:26 +00001719int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001720 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001721 Pager **ppPager, /* Return the Pager structure here */
1722 const char *zFilename, /* Name of the database file to open */
danielk19778c0a7912008-08-20 14:49:23 +00001723 void (*xDesc)(DbPage*), /* Page destructor function */
drhda47d772002-12-02 04:25:19 +00001724 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00001725 int flags, /* flags controlling this file */
1726 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00001727){
danielk1977b4b47412007-08-17 15:53:36 +00001728 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001729 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001730 int rc = SQLITE_OK;
1731 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001732 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001733 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001734 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001735 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1736 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00001737 int journalFileSize = sqlite3JournalSize(pVfs);
danielk19778c0a7912008-08-20 14:49:23 +00001738 int pcacheSize = sqlite3PcacheSize();
drhfacf0302008-06-17 15:12:00 +00001739 int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00001740 char *zPathname = 0;
1741 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001742
drh86f8c192007-08-22 00:39:19 +00001743 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001744 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001745
danielk197717b90b52008-06-06 11:11:25 +00001746 /* Compute and store the full pathname in an allocated buffer pointed
1747 ** to by zPathname, length nPathname. Or, if this is a temporary file,
1748 ** leave both nPathname and zPathname set to 0.
1749 */
drh1cc8c442007-08-24 16:08:29 +00001750 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00001751 nPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001752 zPathname = sqlite3Malloc(nPathname*2);
danielk197717b90b52008-06-06 11:11:25 +00001753 if( zPathname==0 ){
1754 return SQLITE_NOMEM;
1755 }
drh1cc8c442007-08-24 16:08:29 +00001756#ifndef SQLITE_OMIT_MEMORYDB
1757 if( strcmp(zFilename,":memory:")==0 ){
1758 memDb = 1;
1759 zPathname[0] = 0;
1760 }else
1761#endif
1762 {
danielk1977adfb9b02007-09-17 07:02:56 +00001763 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00001764 }
danielk197717b90b52008-06-06 11:11:25 +00001765 if( rc!=SQLITE_OK ){
1766 sqlite3_free(zPathname);
1767 return rc;
1768 }
1769 nPathname = strlen(zPathname);
drhae28c012007-08-24 16:29:23 +00001770 }
drh99b90c32008-03-17 13:50:58 +00001771
danielk1977b4b47412007-08-17 15:53:36 +00001772 /* Allocate memory for the pager structure */
1773 pPager = sqlite3MallocZero(
1774 sizeof(*pPager) + /* Pager structure */
danielk19778c0a7912008-08-20 14:49:23 +00001775 pcacheSize + /* PCache object */
danielk1977c7b60172007-08-22 11:22:03 +00001776 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00001777 pVfs->szOsFile * 3 + /* The main db and two journal files */
danielk197717b90b52008-06-06 11:11:25 +00001778 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00001779 );
1780 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00001781 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00001782 return SQLITE_NOMEM;
1783 }
danielk19778c0a7912008-08-20 14:49:23 +00001784 pPager->pPCache = (PCache *)&pPager[1];
1785 pPtr = ((u8 *)&pPager[1]) + pcacheSize;
drh33f4e022007-09-03 15:19:34 +00001786 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00001787 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00001788 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
1789 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
1790 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00001791 pPager->zDirectory = &pPager->zFilename[nPathname+1];
1792 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00001793 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00001794 if( zPathname ){
1795 memcpy(pPager->zFilename, zPathname, nPathname+1);
1796 sqlite3_free(zPathname);
1797 }
danielk1977b4b47412007-08-17 15:53:36 +00001798
drh153c62c2007-08-24 03:51:33 +00001799 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00001800 */
drhae28c012007-08-24 16:29:23 +00001801 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00001802 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
1803 rc = SQLITE_CANTOPEN;
1804 }else{
drh1cc8c442007-08-24 16:08:29 +00001805 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00001806 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
1807 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00001808 readOnly = (fout&SQLITE_OPEN_READONLY);
1809
1810 /* If the file was successfully opened for read/write access,
1811 ** choose a default page size in case we have to create the
1812 ** database file. The default page size is the maximum of:
1813 **
1814 ** + SQLITE_DEFAULT_PAGE_SIZE,
1815 ** + The value returned by sqlite3OsSectorSize()
1816 ** + The largest page size that can be written atomically.
1817 */
1818 if( rc==SQLITE_OK && !readOnly ){
1819 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
drhfacf0302008-06-17 15:12:00 +00001820 if( szPageDflt<iSectorSize ){
1821 szPageDflt = iSectorSize;
drh1cc8c442007-08-24 16:08:29 +00001822 }
danielk19779663b8f2007-08-24 11:52:28 +00001823#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00001824 {
1825 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
1826 int ii;
1827 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1828 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1829 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
drhfacf0302008-06-17 15:12:00 +00001830 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
1831 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii;
danielk19779663b8f2007-08-24 11:52:28 +00001832 }
danielk1977b4b47412007-08-17 15:53:36 +00001833 }
drh1cc8c442007-08-24 16:08:29 +00001834#endif
drhfacf0302008-06-17 15:12:00 +00001835 if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
1836 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
drh1cc8c442007-08-24 16:08:29 +00001837 }
danielk19778def5ea2004-06-16 10:39:52 +00001838 }
drhac69b052004-05-12 13:30:07 +00001839 }
drh1cc8c442007-08-24 16:08:29 +00001840 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001841 /* If a temporary file is requested, it is not opened immediately.
1842 ** In this case we accept the default page size and delay actually
1843 ** opening the file until the first call to OsWrite().
1844 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001845 tempFile = 1;
1846 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001847 }
danielk1977aef0bf62005-12-30 16:28:01 +00001848
danielk1977b4b47412007-08-17 15:53:36 +00001849 if( pPager && rc==SQLITE_OK ){
drhfacf0302008-06-17 15:12:00 +00001850 pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt);
drh3e7a6092002-12-07 21:45:14 +00001851 }
danielk1977aef0bf62005-12-30 16:28:01 +00001852
drh153c62c2007-08-24 03:51:33 +00001853 /* If an error occured in either of the blocks above.
1854 ** Free the Pager structure and close the file.
1855 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00001856 ** any Pager.errMask variables.
1857 */
danielk1977b4b47412007-08-17 15:53:36 +00001858 if( !pPager || !pPager->pTmpSpace ){
1859 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001860 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001861 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001862 }
danielk19778c0a7912008-08-20 14:49:23 +00001863 nExtra = FORCE_ALIGNMENT(nExtra);
drh41d30272008-08-20 21:47:45 +00001864 sqlite3PcacheOpen(szPageDflt, nExtra, !memDb, xDesc,
1865 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
danielk1977aef0bf62005-12-30 16:28:01 +00001866
drh153c62c2007-08-24 03:51:33 +00001867 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
1868 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00001869
danielk1977b4b47412007-08-17 15:53:36 +00001870 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00001871 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00001872 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001873 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001874
drh99b90c32008-03-17 13:50:58 +00001875 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00001876 if( zPathname ){
1877 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
1878 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
1879 }else{
1880 pPager->zJournal = 0;
1881 }
danielk1977b4b47412007-08-17 15:53:36 +00001882
drh3b59a5c2006-01-15 20:28:28 +00001883 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00001884 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001885 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001886 /* pPager->stmtOpen = 0; */
1887 /* pPager->stmtInUse = 0; */
1888 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001889 pPager->dbSize = memDb-1;
drhfacf0302008-06-17 15:12:00 +00001890 pPager->pageSize = szPageDflt;
drh3b59a5c2006-01-15 20:28:28 +00001891 /* pPager->stmtSize = 0; */
1892 /* pPager->stmtJSize = 0; */
1893 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001894 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001895 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001896 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00001897 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00001898 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001899 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001900 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1901 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1902 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1903 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001904 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001905 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001906 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001907 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001908 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00001909 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00001910 /* pPager->pFirst = 0; */
1911 /* pPager->pFirstSynced = 0; */
1912 /* pPager->pLast = 0; */
danielk19778c0a7912008-08-20 14:49:23 +00001913 pPager->nExtra = nExtra;
danielk1977b53e4962008-06-04 06:45:59 +00001914 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk19777a2b1ee2007-08-21 14:27:01 +00001915 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00001916 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00001917 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00001918 }
drh3b59a5c2006-01-15 20:28:28 +00001919 /* pPager->pBusyHandler = 0; */
1920 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001921 *ppPager = pPager;
1922 return SQLITE_OK;
1923}
1924
1925/*
drh90f5ecb2004-07-22 01:19:35 +00001926** Set the busy handler function.
1927*/
danielk19773b8a05f2007-03-19 17:44:26 +00001928void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00001929 pPager->pBusyHandler = pBusyHandler;
1930}
1931
1932/*
drha6abd042004-06-09 17:37:22 +00001933** Set the reinitializer for this pager. If not NULL, the reinitializer
1934** is called when the content of a page in cache is restored to its original
1935** value as a result of a rollback. The callback gives higher-level code
1936** an opportunity to restore the EXTRA section to agree with the restored
1937** page data.
1938*/
danielk19773b8a05f2007-03-19 17:44:26 +00001939void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00001940 pPager->xReiniter = xReinit;
1941}
1942
1943/*
danielk1977a1644fd2007-08-29 12:31:25 +00001944** Set the page size to *pPageSize. If the suggest new page size is
1945** inappropriate, then an alternative page size is set to that
1946** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00001947*/
danielk1977a1644fd2007-08-29 12:31:25 +00001948int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
1949 int rc = SQLITE_OK;
1950 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00001951 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00001952 if( pageSize && pageSize!=pPager->pageSize
drh7426f862008-08-26 21:07:26 +00001953 && (pPager->memDb==0 || pPager->dbSize==0)
1954 && sqlite3PcacheRefCount(pPager->pPCache)==0
danielk1977a1644fd2007-08-29 12:31:25 +00001955 ){
drhfacf0302008-06-17 15:12:00 +00001956 char *pNew = (char *)sqlite3PageMalloc(pageSize);
danielk1977a1644fd2007-08-29 12:31:25 +00001957 if( !pNew ){
1958 rc = SQLITE_NOMEM;
1959 }else{
danielk1977a1644fd2007-08-29 12:31:25 +00001960 pager_reset(pPager);
1961 pPager->pageSize = pageSize;
drh7426f862008-08-26 21:07:26 +00001962 if( !pPager->memDb ) setSectorSize(pPager);
drhfacf0302008-06-17 15:12:00 +00001963 sqlite3PageFree(pPager->pTmpSpace);
danielk1977a1644fd2007-08-29 12:31:25 +00001964 pPager->pTmpSpace = pNew;
danielk19778c0a7912008-08-20 14:49:23 +00001965 sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
danielk1977a1644fd2007-08-29 12:31:25 +00001966 }
drh1c7880e2005-05-20 20:01:55 +00001967 }
danielk1977a1644fd2007-08-29 12:31:25 +00001968 *pPageSize = pPager->pageSize;
1969 return rc;
drh90f5ecb2004-07-22 01:19:35 +00001970}
1971
1972/*
drh26b79942007-11-28 16:19:56 +00001973** Return a pointer to the "temporary page" buffer held internally
1974** by the pager. This is a buffer that is big enough to hold the
1975** entire content of a database page. This buffer is used internally
1976** during rollback and will be overwritten whenever a rollback
1977** occurs. But other modules are free to use it too, as long as
1978** no rollbacks are happening.
1979*/
1980void *sqlite3PagerTempSpace(Pager *pPager){
1981 return pPager->pTmpSpace;
1982}
1983
1984/*
drhf8e632b2007-05-08 14:51:36 +00001985** Attempt to set the maximum database page count if mxPage is positive.
1986** Make no changes if mxPage is zero or negative. And never reduce the
1987** maximum page count below the current size of the database.
1988**
1989** Regardless of mxPage, return the current maximum page count.
1990*/
1991int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
1992 if( mxPage>0 ){
1993 pPager->mxPgno = mxPage;
1994 }
danielk1977ad0132d2008-06-07 08:58:22 +00001995 sqlite3PagerPagecount(pPager, 0);
drhf8e632b2007-05-08 14:51:36 +00001996 return pPager->mxPgno;
1997}
1998
1999/*
drhc9ac5ca2005-11-04 22:03:30 +00002000** The following set of routines are used to disable the simulated
2001** I/O error mechanism. These routines are used to avoid simulated
2002** errors in places where we do not care about errors.
2003**
2004** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2005** and generate no code.
2006*/
2007#ifdef SQLITE_TEST
2008extern int sqlite3_io_error_pending;
2009extern int sqlite3_io_error_hit;
2010static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002011void disable_simulated_io_errors(void){
2012 saved_cnt = sqlite3_io_error_pending;
2013 sqlite3_io_error_pending = -1;
2014}
2015void enable_simulated_io_errors(void){
2016 sqlite3_io_error_pending = saved_cnt;
2017}
2018#else
drh152410f2005-11-05 15:11:22 +00002019# define disable_simulated_io_errors()
2020# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002021#endif
2022
2023/*
drh90f5ecb2004-07-22 01:19:35 +00002024** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002025** that pDest points to.
2026**
2027** No error checking is done. The rational for this is that this function
2028** may be called even if the file does not exist or contain a header. In
2029** these cases sqlite3OsRead() will return an error, to which the correct
2030** response is to zero the memory at pDest and continue. A real IO error
2031** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002032*/
danielk19773b8a05f2007-03-19 17:44:26 +00002033int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002034 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002035 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002036 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2037 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002038 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002039 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002040 if( rc==SQLITE_IOERR_SHORT_READ ){
2041 rc = SQLITE_OK;
2042 }
drh90f5ecb2004-07-22 01:19:35 +00002043 }
drh551b7732006-11-06 21:20:25 +00002044 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002045}
2046
2047/*
drh5e00f6c2001-09-13 13:46:56 +00002048** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002049** pPager.
2050**
2051** If the PENDING_BYTE lies on the page directly after the end of the
2052** file, then consider this page part of the file too. For example, if
2053** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2054** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002055*/
danielk1977ad0132d2008-06-07 08:58:22 +00002056int sqlite3PagerPagecount(Pager *pPager, int *pnPage){
danielk19777a2b1ee2007-08-21 14:27:01 +00002057 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002058 int rc;
drhd9b02572001-04-15 00:37:09 +00002059 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002060 if( pPager->errCode ){
danielk19778c0a7912008-08-20 14:49:23 +00002061 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002062 return rc;
drha7aea3d2007-03-15 12:51:16 +00002063 }
drhed7c8552001-04-11 14:29:21 +00002064 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002065 n = pPager->dbSize;
2066 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002067 assert(pPager->fd->pMethods||pPager->tempFile);
2068 if( (pPager->fd->pMethods)
2069 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002070 pager_error(pPager, rc);
danielk1977ad0132d2008-06-07 08:58:22 +00002071 return rc;
danielk197715f411d2005-09-16 10:18:45 +00002072 }
2073 if( n>0 && n<pPager->pageSize ){
2074 n = 1;
2075 }else{
2076 n /= pPager->pageSize;
2077 }
2078 if( pPager->state!=PAGER_UNLOCK ){
2079 pPager->dbSize = n;
2080 }
drhed7c8552001-04-11 14:29:21 +00002081 }
danielk197715f411d2005-09-16 10:18:45 +00002082 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002083 n++;
2084 }
drhf8e632b2007-05-08 14:51:36 +00002085 if( n>pPager->mxPgno ){
2086 pPager->mxPgno = n;
2087 }
danielk1977ad0132d2008-06-07 08:58:22 +00002088 if( pnPage ){
2089 *pnPage = n;
2090 }
2091 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002092}
2093
2094/*
drhf7c57532003-04-25 13:22:51 +00002095** Forward declaration
2096*/
danielk197776572402004-06-25 02:38:54 +00002097static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002098
2099/*
danielk1977e180dd92007-04-05 17:15:52 +00002100** This routine is used to truncate the cache when a database
2101** is truncated. Drop from the cache all pages whose pgno is
2102** larger than pPager->dbSize and is unreferenced.
2103**
drhac69b052004-05-12 13:30:07 +00002104** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002105**
2106** Actually, at the point this routine is called, it would be
2107** an error to have a referenced page. But rather than delete
2108** that page and guarantee a subsequent segfault, it seems better
2109** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002110*/
danielk1977e180dd92007-04-05 17:15:52 +00002111static void pager_truncate_cache(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00002112 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
drhac69b052004-05-12 13:30:07 +00002113}
2114
drhf7c57532003-04-25 13:22:51 +00002115/*
danielk197717221812005-02-15 03:38:05 +00002116** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002117** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002118** false or until the lock succeeds.
2119**
2120** Return SQLITE_OK on success and an error code if we cannot obtain
2121** the lock.
2122*/
2123static int pager_wait_on_lock(Pager *pPager, int locktype){
2124 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002125
2126 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002127 assert( PAGER_SHARED==SHARED_LOCK );
2128 assert( PAGER_RESERVED==RESERVED_LOCK );
2129 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002130
2131 /* If the file is currently unlocked then the size must be unknown */
2132 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2133
danielk197717221812005-02-15 03:38:05 +00002134 if( pPager->state>=locktype ){
2135 rc = SQLITE_OK;
2136 }else{
drhbefdf832008-03-14 19:33:05 +00002137 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002138 do {
drh054889e2005-11-30 03:20:31 +00002139 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002140 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002141 if( rc==SQLITE_OK ){
2142 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002143 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002144 }
2145 }
2146 return rc;
2147}
2148
2149/*
drhf7c57532003-04-25 13:22:51 +00002150** Truncate the file to the number of pages specified.
2151*/
danielk19773b8a05f2007-03-19 17:44:26 +00002152int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
danielk19778c0a7912008-08-20 14:49:23 +00002153 int rc = SQLITE_OK;
drh1aa2d8b2007-01-03 15:34:29 +00002154 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00002155
danielk19778c0a7912008-08-20 14:49:23 +00002156
danielk1977ad0132d2008-06-07 08:58:22 +00002157 sqlite3PagerPagecount(pPager, 0);
danielk1977efaaf572006-01-16 11:29:19 +00002158 if( pPager->errCode ){
2159 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002160 }else if( nPage<(unsigned)pPager->dbSize ){
2161 if( MEMDB ){
2162 pPager->dbSize = nPage;
2163 pager_truncate_cache(pPager);
2164 }else{
2165 rc = syncJournal(pPager);
2166 if( rc==SQLITE_OK ){
2167 /* Get an exclusive lock on the database before truncating. */
2168 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2169 }
2170 if( rc==SQLITE_OK ){
2171 rc = pager_truncate(pPager, nPage);
2172 }
2173 }
danielk1977369f27e2004-06-15 11:40:04 +00002174 }
danielk197717221812005-02-15 03:38:05 +00002175
drhf7c57532003-04-25 13:22:51 +00002176 return rc;
2177}
2178
2179/*
drhed7c8552001-04-11 14:29:21 +00002180** Shutdown the page cache. Free all memory and close all files.
2181**
2182** If a transaction was in progress when this routine is called, that
2183** transaction is rolled back. All outstanding pages are invalidated
2184** and their memory is freed. Any attempt to use a page associated
2185** with this page cache after this function returns will likely
2186** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002187**
2188** This function always succeeds. If a transaction is active an attempt
2189** is made to roll it back. If an error occurs during the rollback
2190** a hot journal may be left in the filesystem but no error is returned
2191** to the caller.
drhed7c8552001-04-11 14:29:21 +00002192*/
danielk19773b8a05f2007-03-19 17:44:26 +00002193int sqlite3PagerClose(Pager *pPager){
danielk197713f72992005-12-18 08:51:22 +00002194
drhbafda092007-01-03 23:36:22 +00002195 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002196 sqlite3BeginBenignMalloc();
drhc2ee76c2007-01-04 14:58:14 +00002197 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002198 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002199 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002200 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002201 enable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002202 sqlite3EndBenignMalloc();
drh4f0c5872007-03-26 22:05:01 +00002203 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002204 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002205 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002206 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002207 }
drhf5e7bb52008-02-18 14:47:33 +00002208 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977a1fa00d2008-08-27 15:16:33 +00002209 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
danielk1977e94ddc92005-03-21 03:53:38 +00002210 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002211 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002212 }
danielk1977b4b47412007-08-17 15:53:36 +00002213 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002214 /* Temp files are automatically deleted by the OS
2215 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002216 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002217 ** }
2218 */
danielk1977aca790a2005-01-13 11:07:52 +00002219
drhfacf0302008-06-17 15:12:00 +00002220 sqlite3PageFree(pPager->pTmpSpace);
danielk19778c0a7912008-08-20 14:49:23 +00002221 sqlite3PcacheClose(pPager->pPCache);
drh17435752007-08-16 04:30:38 +00002222 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002223 return SQLITE_OK;
2224}
2225
drh87cc3b32007-05-08 21:45:27 +00002226#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002227/*
drh5e00f6c2001-09-13 13:46:56 +00002228** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002229*/
danielk19773b8a05f2007-03-19 17:44:26 +00002230Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002231 return p->pgno;
2232}
drh87cc3b32007-05-08 21:45:27 +00002233#endif
drhed7c8552001-04-11 14:29:21 +00002234
2235/*
drhdf0b3b02001-06-23 11:36:20 +00002236** Increment the reference count for a page. The input pointer is
2237** a reference to the page data.
2238*/
danielk19773b8a05f2007-03-19 17:44:26 +00002239int sqlite3PagerRef(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002240 sqlite3PcacheRef(pPg);
drh8c42ca92001-06-22 19:15:00 +00002241 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002242}
2243
2244/*
drh34e79ce2004-02-08 06:05:46 +00002245** Sync the journal. In other words, make sure all the pages that have
2246** been written to the journal have actually reached the surface of the
2247** disk. It is not safe to modify the original database file until after
2248** the journal has been synced. If the original database is modified before
2249** the journal is synced and a power failure occurs, the unsynced journal
2250** data would be lost and we would be unable to completely rollback the
2251** database changes. Database corruption would occur.
2252**
2253** This routine also updates the nRec field in the header of the journal.
2254** (See comments on the pager_playback() routine for additional information.)
2255** If the sync mode is FULL, two syncs will occur. First the whole journal
2256** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002257**
drh34e79ce2004-02-08 06:05:46 +00002258** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002259** after a power failure, so no sync occurs.
2260**
2261** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2262** the database is stored, then OsSync() is never called on the journal
2263** file. In this case all that is required is to update the nRec field in
2264** the journal header.
drhfa86c412002-02-02 15:01:15 +00002265**
drh34e79ce2004-02-08 06:05:46 +00002266** This routine clears the needSync field of every page current held in
2267** memory.
drh50e5dad2001-09-15 00:57:28 +00002268*/
danielk197776572402004-06-25 02:38:54 +00002269static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002270 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002271
2272 /* Sync the journal before modifying the main database
2273 ** (assuming there is a journal and it needs to be synced.)
2274 */
danielk197776572402004-06-25 02:38:54 +00002275 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002276 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002277 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002278 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002279
danielk19774cd2cd52007-08-23 14:48:23 +00002280 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002281 /* Write the nRec value into the journal file header. If in
2282 ** full-synchronous mode, sync the journal first. This ensures that
2283 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002284 ** it as a candidate for rollback.
2285 **
2286 ** This is not required if the persistent media supports the
2287 ** SAFE_APPEND property. Because in this case it is not possible
2288 ** for garbage data to be appended to the file, the nRec field
2289 ** is populated with 0xFFFFFFFF when the journal header is written
2290 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002291 */
danielk19774cd2cd52007-08-23 14:48:23 +00002292 i64 jrnlOff;
2293 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002294 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002295 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002296 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002297 if( rc!=0 ) return rc;
2298 }
danielk197713adf8a2004-06-03 16:08:41 +00002299
danielk197762079062007-08-15 17:08:46 +00002300 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2301 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2302 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002303 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002304 }
danielk19774cd2cd52007-08-23 14:48:23 +00002305 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2306 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2307 IOTRACE(("JSYNC %p\n", pPager))
2308 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2309 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2310 );
2311 if( rc!=0 ) return rc;
2312 }
drhdb48ee02003-01-16 13:42:43 +00002313 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002314 }
drh50e5dad2001-09-15 00:57:28 +00002315 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002316
2317 /* Erase the needSync flag from every page.
2318 */
danielk19778c0a7912008-08-20 14:49:23 +00002319 sqlite3PcacheSetFlags(pPager->pPCache, ~PGHDR_NEED_SYNC, 0);
2320 /* lruListSetFirstSynced(pPager); */
drh50e5dad2001-09-15 00:57:28 +00002321 }
drh03eb96a2002-11-10 23:32:56 +00002322
drh341eae82003-01-21 02:39:36 +00002323#ifndef NDEBUG
2324 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2325 ** flag must also be clear for all pages. Verify that this
2326 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002327 */
drh341eae82003-01-21 02:39:36 +00002328 else{
danielk19778c0a7912008-08-20 14:49:23 +00002329 sqlite3PcacheAssertFlags(pPager->pPCache, 0, PGHDR_NEED_SYNC);
2330 /* assert( pPager->lru.pFirstSynced==pPager->lru.pFirst ); */
drh03eb96a2002-11-10 23:32:56 +00002331 }
drh341eae82003-01-21 02:39:36 +00002332#endif
drhdb48ee02003-01-16 13:42:43 +00002333
drh81a20f22001-10-12 17:30:04 +00002334 return rc;
drh50e5dad2001-09-15 00:57:28 +00002335}
2336
2337/*
drh2554f8b2003-01-22 01:26:44 +00002338** Given a list of pages (connected by the PgHdr.pDirty pointer) write
danielk1977a858aa22008-08-22 16:22:17 +00002339** every one of those pages out to the database file. No calls are made
2340** to the page-cache to mark the pages as clean. It is the responsibility
2341** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark
2342** the pages as clean.
drh2554f8b2003-01-22 01:26:44 +00002343*/
2344static int pager_write_pagelist(PgHdr *pList){
2345 Pager *pPager;
2346 int rc;
2347
2348 if( pList==0 ) return SQLITE_OK;
2349 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002350
2351 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2352 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002353 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002354 **
drha6abd042004-06-09 17:37:22 +00002355 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2356 ** through an intermediate state PENDING. A PENDING lock prevents new
2357 ** readers from attaching to the database but is unsufficient for us to
2358 ** write. The idea of a PENDING lock is to prevent new readers from
2359 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002360 **
drha6abd042004-06-09 17:37:22 +00002361 ** While the pager is in the RESERVED state, the original database file
2362 ** is unchanged and we can rollback without having to playback the
2363 ** journal into the original database file. Once we transition to
2364 ** EXCLUSIVE, it means the database file has been changed and any rollback
2365 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002366 */
drh684917c2004-10-05 02:41:42 +00002367 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002368 if( rc!=SQLITE_OK ){
2369 return rc;
2370 }
2371
drh2554f8b2003-01-22 01:26:44 +00002372 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002373
2374 /* If the file has not yet been opened, open it now. */
2375 if( !pPager->fd->pMethods ){
2376 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00002377 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002378 if( rc ) return rc;
2379 }
2380
danielk1977687566d2004-11-02 12:56:41 +00002381 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002382 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002383 ** make the file smaller (presumably by auto-vacuum code). Do not write
2384 ** any such pages to the file.
2385 */
danielk197733e32162008-08-23 18:53:08 +00002386 if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
danielk197762079062007-08-15 17:08:46 +00002387 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002388 char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00002389 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2390 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002391 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002392 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002393 PAGER_INCR(sqlite3_pager_writedb_count);
2394 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002395 if( pList->pgno==1 ){
2396 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2397 }
danielk1977687566d2004-11-02 12:56:41 +00002398 }
2399#ifndef NDEBUG
2400 else{
drh4f0c5872007-03-26 22:05:01 +00002401 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002402 }
2403#endif
drh2554f8b2003-01-22 01:26:44 +00002404 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002405#ifdef SQLITE_CHECK_PAGES
2406 pList->pageHash = pager_pagehash(pList);
2407#endif
danielk1977a858aa22008-08-22 16:22:17 +00002408 /* makeClean(pList); */
drh2554f8b2003-01-22 01:26:44 +00002409 pList = pList->pDirty;
2410 }
danielk19778c0a7912008-08-20 14:49:23 +00002411
2412 /* sqlite3PcacheCleanAll(pPager->pPCache); */
drh2554f8b2003-01-22 01:26:44 +00002413 return SQLITE_OK;
2414}
2415
2416/*
danielk19778c0a7912008-08-20 14:49:23 +00002417** This function is called by the pcache layer when it has reached some
2418** soft memory limit. The argument is a pointer to a purgeable Pager
2419** object. This function attempts to make a single dirty page that has no
2420** outstanding references (if one exists) clean so that it can be recycled
2421** by the pcache layer.
drh2554f8b2003-01-22 01:26:44 +00002422*/
danielk1977a858aa22008-08-22 16:22:17 +00002423static int pagerStress(void *p, PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002424 Pager *pPager = (Pager *)p;
danielk19778c0a7912008-08-20 14:49:23 +00002425 int rc = SQLITE_OK;
drh8f2e9a12008-02-26 14:46:04 +00002426
danielk19778c200142008-08-25 07:12:28 +00002427 if( pPager->doNotSync ){
2428 return SQLITE_OK;
2429 }
2430
danielk1977a858aa22008-08-22 16:22:17 +00002431 assert( pPg->flags&PGHDR_DIRTY );
2432 if( pPager->errCode==SQLITE_OK ){
2433 if( pPg->flags&PGHDR_NEED_SYNC ){
2434 rc = syncJournal(pPager);
2435 if( rc==SQLITE_OK && pPager->fullSync &&
2436 !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
2437 ){
2438 pPager->nRec = 0;
2439 rc = writeJournalHdr(pPager);
danielk19778c0a7912008-08-20 14:49:23 +00002440 }
danielk19778c0a7912008-08-20 14:49:23 +00002441 }
danielk1977a858aa22008-08-22 16:22:17 +00002442 if( rc==SQLITE_OK ){
2443 pPg->pDirty = 0;
2444 rc = pager_write_pagelist(pPg);
2445 }
2446 if( rc!=SQLITE_OK ){
2447 pager_error(pPager, rc);
2448 }
2449 }
2450
2451 if( rc==SQLITE_OK ){
2452 sqlite3PcacheMakeClean(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00002453 }
2454 return rc;
drh2554f8b2003-01-22 01:26:44 +00002455}
2456
danielk19778c0a7912008-08-20 14:49:23 +00002457
drh2554f8b2003-01-22 01:26:44 +00002458/*
drh19db9352008-03-27 22:42:51 +00002459** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00002460** A hot journal is one that needs to be played back.
2461**
2462** If the current size of the database file is 0 but a journal file
2463** exists, that is probably an old journal left over from a prior
2464** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00002465**
2466** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00002467**
2468** This routine does not open the journal file to examine its
2469** content. Hence, the journal might contain the name of a master
2470** journal file that has been deleted, and hence not be hot. Or
2471** the header of the journal might be zeroed out. This routine
2472** does not discover these cases of a non-hot journal - if the
2473** journal file exists and is not empty this routine assumes it
2474** is hot. The pager_playback() routine will discover that the
2475** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00002476*/
danielk1977d300b8a2008-08-01 10:50:23 +00002477static int hasHotJournal(Pager *pPager, int *pExists){
danielk1977b4b47412007-08-17 15:53:36 +00002478 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977d300b8a2008-08-01 10:50:23 +00002479 int rc = SQLITE_OK;
drh0a846f92008-08-25 17:23:29 +00002480 int exists;
2481 int locked;
2482 assert( pPager!=0 );
2483 assert( pPager->useJournal );
2484 assert( pPager->fd->pMethods );
danielk1977d300b8a2008-08-01 10:50:23 +00002485 *pExists = 0;
drh0a846f92008-08-25 17:23:29 +00002486 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
2487 if( rc==SQLITE_OK && exists ){
2488 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
2489 }
2490 if( rc==SQLITE_OK && exists && !locked ){
2491 int nPage;
2492 rc = sqlite3PagerPagecount(pPager, &nPage);
2493 if( rc==SQLITE_OK ){
2494 if( nPage==0 ){
2495 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2496 }else{
2497 *pExists = 1;
danielk1977861f7452008-06-05 11:39:11 +00002498 }
2499 }
drhbb5f18d2007-04-06 18:23:17 +00002500 }
danielk1977d300b8a2008-08-01 10:50:23 +00002501 return rc;
drh165ffe92005-03-15 17:09:30 +00002502}
2503
2504/*
danielk1977e180dd92007-04-05 17:15:52 +00002505** Read the content of page pPg out of the database file.
2506*/
2507static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2508 int rc;
danielk197762079062007-08-15 17:08:46 +00002509 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002510 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002511 assert(pPager->fd->pMethods||pPager->tempFile);
2512 if( !pPager->fd->pMethods ){
2513 return SQLITE_IOERR_SHORT_READ;
2514 }
danielk197762079062007-08-15 17:08:46 +00002515 offset = (pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002516 rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002517 PAGER_INCR(sqlite3_pager_readdb_count);
2518 PAGER_INCR(pPager->nRead);
2519 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002520 if( pgno==1 ){
danielk19778c0a7912008-08-20 14:49:23 +00002521 memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24],
drh86a88112007-04-16 15:02:19 +00002522 sizeof(pPager->dbFileVers));
2523 }
danielk197730849522008-08-21 04:35:18 +00002524 CODEC1(pPager, pPg->pData, pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002525 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2526 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002527 return rc;
2528}
2529
2530
2531/*
danielk1977e277be02007-03-23 18:12:06 +00002532** This function is called to obtain the shared lock required before
2533** data may be read from the pager cache. If the shared lock has already
2534** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002535**
2536** Immediately after obtaining the shared lock (if required), this function
2537** checks for a hot-journal file. If one is found, an emergency rollback
2538** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002539*/
2540static int pagerSharedLock(Pager *pPager){
2541 int rc = SQLITE_OK;
danielk1977d300b8a2008-08-01 10:50:23 +00002542 int isErrorReset = 0;
danielk1977e277be02007-03-23 18:12:06 +00002543
danielk1977ae72d982007-10-03 08:46:44 +00002544 /* If this database is opened for exclusive access, has no outstanding
2545 ** page references and is in an error-state, now is the chance to clear
2546 ** the error. Discard the contents of the pager-cache and treat any
2547 ** open journal file as a hot-journal.
2548 */
danielk19778c0a7912008-08-20 14:49:23 +00002549 if( !MEMDB && pPager->exclusiveMode
2550 && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode
2551 ){
danielk1977ae72d982007-10-03 08:46:44 +00002552 if( pPager->journalOpen ){
danielk1977d300b8a2008-08-01 10:50:23 +00002553 isErrorReset = 1;
danielk1977ae72d982007-10-03 08:46:44 +00002554 }
danielk1977ae72d982007-10-03 08:46:44 +00002555 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00002556 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00002557 }
2558
2559 /* If the pager is still in an error state, do not proceed. The error
2560 ** state will be cleared at some point in the future when all page
2561 ** references are dropped and the cache can be discarded.
2562 */
2563 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2564 return pPager->errCode;
2565 }
2566
danielk1977d300b8a2008-08-01 10:50:23 +00002567 if( pPager->state==PAGER_UNLOCK || isErrorReset ){
danielk1977b4b47412007-08-17 15:53:36 +00002568 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00002569 if( !MEMDB ){
danielk1977d300b8a2008-08-01 10:50:23 +00002570 int isHotJournal;
danielk19778c0a7912008-08-20 14:49:23 +00002571 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
danielk1977e277be02007-03-23 18:12:06 +00002572 if( !pPager->noReadlock ){
2573 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2574 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002575 assert( pPager->state==PAGER_UNLOCK );
danielk1977e277be02007-03-23 18:12:06 +00002576 return pager_error(pPager, rc);
2577 }
2578 assert( pPager->state>=SHARED_LOCK );
2579 }
2580
2581 /* If a journal file exists, and there is no RESERVED lock on the
2582 ** database file, then it either needs to be played back or deleted.
2583 */
danielk1977d300b8a2008-08-01 10:50:23 +00002584 if( !isErrorReset ){
2585 rc = hasHotJournal(pPager, &isHotJournal);
2586 if( rc!=SQLITE_OK ){
2587 goto failed;
2588 }
drh19db9352008-03-27 22:42:51 +00002589 }
danielk1977d300b8a2008-08-01 10:50:23 +00002590 if( isErrorReset || isHotJournal ){
danielk1977e277be02007-03-23 18:12:06 +00002591 /* Get an EXCLUSIVE lock on the database file. At this point it is
2592 ** important that a RESERVED lock is not obtained on the way to the
2593 ** EXCLUSIVE lock. If it were, another process might open the
2594 ** database file, detect the RESERVED lock, and conclude that the
2595 ** database is safe to read while this process is still rolling it
2596 ** back.
2597 **
2598 ** Because the intermediate RESERVED lock is not requested, the
2599 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00002600 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00002601 */
danielk1977ae72d982007-10-03 08:46:44 +00002602 if( pPager->state<EXCLUSIVE_LOCK ){
2603 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
2604 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002605 rc = pager_error(pPager, rc);
2606 goto failed;
danielk1977ae72d982007-10-03 08:46:44 +00002607 }
2608 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00002609 }
danielk1977e277be02007-03-23 18:12:06 +00002610
drh16e45a42008-04-19 20:34:18 +00002611 /* Open the journal for read/write access. This is because in
drhfd131da2007-08-07 17:13:03 +00002612 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00002613 ** possibly used for a transaction later on. On some systems, the
2614 ** OsTruncate() call used in exclusive-access mode also requires
2615 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00002616 */
danielk1977d300b8a2008-08-01 10:50:23 +00002617 if( !isErrorReset && pPager->journalOpen==0 ){
danielk1977861f7452008-06-05 11:39:11 +00002618 int res;
2619 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
2620 if( rc==SQLITE_OK ){
2621 if( res ){
2622 int fout = 0;
2623 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
2624 assert( !pPager->tempFile );
2625 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
2626 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
2627 if( fout&SQLITE_OPEN_READONLY ){
2628 rc = SQLITE_BUSY;
2629 sqlite3OsClose(pPager->jfd);
2630 }
2631 }else{
2632 /* If the journal does not exist, that means some other process
2633 ** has already rolled it back */
danielk1977ae72d982007-10-03 08:46:44 +00002634 rc = SQLITE_BUSY;
danielk1977ae72d982007-10-03 08:46:44 +00002635 }
danielk1977979f38e2007-03-27 16:19:51 +00002636 }
2637 }
danielk1977e277be02007-03-23 18:12:06 +00002638 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002639 if( rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_UNLOCK
2640 && rc!=SQLITE_IOERR_NOMEM
2641 ){
2642 rc = SQLITE_BUSY;
drh1aa5af12008-03-07 19:51:14 +00002643 }
danielk197752b472a2008-05-05 16:23:55 +00002644 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002645 }
2646 pPager->journalOpen = 1;
2647 pPager->journalStarted = 0;
2648 pPager->journalOff = 0;
2649 pPager->setMaster = 0;
2650 pPager->journalHdr = 0;
2651
2652 /* Playback and delete the journal. Drop the database write
2653 ** lock and reacquire the read lock.
2654 */
2655 rc = pager_playback(pPager, 1);
2656 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002657 rc = pager_error(pPager, rc);
2658 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002659 }
danielk1977c5859712007-03-26 12:26:27 +00002660 assert(pPager->state==PAGER_SHARED ||
2661 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2662 );
danielk1977e277be02007-03-23 18:12:06 +00002663 }
2664
danielk19778c0a7912008-08-20 14:49:23 +00002665 if( sqlite3PcachePagecount(pPager->pPCache)>0 ){
danielk197724168722007-04-02 05:07:47 +00002666 /* The shared-lock has just been acquired on the database file
2667 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00002668 ** read or write transaction). Check to see if the database
2669 ** has been modified. If the database has changed, flush the
2670 ** cache.
2671 **
2672 ** Database changes is detected by looking at 15 bytes beginning
2673 ** at offset 24 into the file. The first 4 of these 16 bytes are
2674 ** a 32-bit counter that is incremented with each change. The
2675 ** other bytes change randomly with each file change when
2676 ** a codec is in use.
2677 **
2678 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00002679 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00002680 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00002681 */
drh86a88112007-04-16 15:02:19 +00002682 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977ad0132d2008-06-07 08:58:22 +00002683 sqlite3PagerPagecount(pPager, 0);
danielk197724168722007-04-02 05:07:47 +00002684
danielk1977e180dd92007-04-05 17:15:52 +00002685 if( pPager->errCode ){
danielk197752b472a2008-05-05 16:23:55 +00002686 rc = pPager->errCode;
2687 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002688 }
2689
danielk1977e180dd92007-04-05 17:15:52 +00002690 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00002691 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00002692 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00002693 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002694 goto failed;
danielk1977e180dd92007-04-05 17:15:52 +00002695 }
drh86a88112007-04-16 15:02:19 +00002696 }else{
2697 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00002698 }
2699
drh86a88112007-04-16 15:02:19 +00002700 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00002701 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002702 }
2703 }
2704 }
danielk1977c5859712007-03-26 12:26:27 +00002705 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2706 if( pPager->state==PAGER_UNLOCK ){
2707 pPager->state = PAGER_SHARED;
2708 }
danielk1977e277be02007-03-23 18:12:06 +00002709 }
2710
danielk197752b472a2008-05-05 16:23:55 +00002711 failed:
2712 if( rc!=SQLITE_OK ){
2713 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
2714 pager_unlock(pPager);
2715 }
danielk1977e277be02007-03-23 18:12:06 +00002716 return rc;
2717}
2718
2719/*
drhd33d5a82007-04-26 12:11:28 +00002720** Make sure we have the content for a page. If the page was
2721** previously acquired with noContent==1, then the content was
2722** just initialized to zeros instead of being read from disk.
2723** But now we need the real data off of disk. So make sure we
2724** have it. Read it in if we do not have it already.
2725*/
2726static int pager_get_content(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002727 if( pPg->flags&PGHDR_NEED_READ ){
drhd33d5a82007-04-26 12:11:28 +00002728 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
2729 if( rc==SQLITE_OK ){
danielk19778c0a7912008-08-20 14:49:23 +00002730 pPg->flags &= ~PGHDR_NEED_READ;
drhd33d5a82007-04-26 12:11:28 +00002731 }else{
2732 return rc;
2733 }
2734 }
2735 return SQLITE_OK;
2736}
2737
2738/*
danielk19778c0a7912008-08-20 14:49:23 +00002739** If the reference count has reached zero, and the pager is not in the
2740** middle of a write transaction or opened in exclusive mode, unlock it.
2741*/
2742static void pagerUnlockIfUnused(Pager *pPager){
2743 if( (sqlite3PcacheRefCount(pPager->pPCache)==0)
2744 && (!pPager->exclusiveMode || pPager->journalOff>0)
2745 ){
2746 pagerUnlockAndRollback(pPager);
2747 }
2748}
2749
2750/*
2751** Drop a page from the cache using sqlite3PcacheDrop().
2752**
2753** If this means there are now no pages with references to them, a rollback
2754** occurs and the lock on the database is removed.
2755*/
2756static void pagerDropPage(DbPage *pPg){
2757 Pager *pPager = pPg->pPager;
2758 sqlite3PcacheDrop(pPg);
2759 pagerUnlockIfUnused(pPager);
2760}
2761
2762/*
drhd9b02572001-04-15 00:37:09 +00002763** Acquire a page.
2764**
drh58a11682001-11-10 13:51:08 +00002765** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002766** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002767**
drhd33d5a82007-04-26 12:11:28 +00002768** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00002769** file is smaller than the requested page, then no actual disk
2770** read occurs and the memory image of the page is initialized to
2771** all zeros. The extra data appended to a page is always initialized
2772** to zeros the first time a page is loaded into memory.
2773**
drhd9b02572001-04-15 00:37:09 +00002774** The acquisition might fail for several reasons. In all cases,
2775** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002776**
drhd33d5a82007-04-26 12:11:28 +00002777** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002778** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00002779** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00002780** just returns 0. This routine acquires a read-lock the first time it
2781** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00002782** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00002783** or journal files.
drh0787db62007-03-04 13:15:27 +00002784**
drh538f5702007-04-13 02:14:30 +00002785** If noContent is false, the page contents are actually read from disk.
2786** If noContent is true, it means that we do not care about the contents
2787** of the page at this time, so do not do a disk read. Just fill in the
2788** page content with zeros. But mark the fact that we have not read the
2789** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00002790** sqlite3PagerWrite() is called on this page or if this routine is
2791** called again with noContent==0, that means that the content is needed
2792** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002793*/
drh86f8c192007-08-22 00:39:19 +00002794static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00002795 Pager *pPager, /* The pager open on the database file */
2796 Pgno pgno, /* Page number to fetch */
2797 DbPage **ppPage, /* Write a pointer to the page here */
2798 int noContent /* Do not bother reading content from disk if true */
2799){
danielk19778c0a7912008-08-20 14:49:23 +00002800 PgHdr *pPg = 0;
drh165ffe92005-03-15 17:09:30 +00002801 int rc;
drhed7c8552001-04-11 14:29:21 +00002802
danielk19778c0a7912008-08-20 14:49:23 +00002803 assert( pPager->state==PAGER_UNLOCK
2804 || sqlite3PcacheRefCount(pPager->pPCache)>0
2805 || pgno==1
2806 );
danielk1977e277be02007-03-23 18:12:06 +00002807
danielk197726836652005-01-17 01:33:13 +00002808 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2809 ** number greater than this, or zero, is requested.
2810 */
drh267cb322005-09-16 17:16:52 +00002811 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002812 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002813 }
2814
drhd9b02572001-04-15 00:37:09 +00002815 /* Make sure we have not hit any critical errors.
2816 */
drh836faa42003-01-11 13:30:57 +00002817 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002818 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002819
danielk197713adf8a2004-06-03 16:08:41 +00002820 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002821 ** on the database file. pagerSharedLock() is a no-op if
2822 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002823 */
danielk1977e277be02007-03-23 18:12:06 +00002824 rc = pagerSharedLock(pPager);
2825 if( rc!=SQLITE_OK ){
2826 return rc;
drhed7c8552001-04-11 14:29:21 +00002827 }
danielk1977e277be02007-03-23 18:12:06 +00002828 assert( pPager->state!=PAGER_UNLOCK );
2829
danielk19778c0a7912008-08-20 14:49:23 +00002830 rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg);
2831 if( rc!=SQLITE_OK ){
2832 return rc;
2833 }
danielk19778c0a7912008-08-20 14:49:23 +00002834 if( pPg->pPager==0 ){
2835 /* The pager cache has created a new page. Its content needs to
2836 ** be initialized.
2837 */
danielk1977979f38e2007-03-27 16:19:51 +00002838 int nMax;
drh538f5702007-04-13 02:14:30 +00002839 PAGER_INCR(pPager->nMiss);
danielk19778c0a7912008-08-20 14:49:23 +00002840 pPg->pPager = pPager;
2841 if( sqlite3BitvecTest(pPager->pInJournal, pgno) ){
2842 pPg->flags |= PGHDR_IN_JOURNAL;
drhed7c8552001-04-11 14:29:21 +00002843 }
danielk19778c0a7912008-08-20 14:49:23 +00002844 memset(pPg->pExtra, 0, pPager->nExtra);
danielk197724168722007-04-02 05:07:47 +00002845
danielk1977ad0132d2008-06-07 08:58:22 +00002846 rc = sqlite3PagerPagecount(pPager, &nMax);
2847 if( rc!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002848 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00002849 return rc;
2850 }
danielk197775bab7d2006-01-23 13:09:45 +00002851
danielk1977a1fa00d2008-08-27 15:16:33 +00002852 if( nMax<(int)pgno || MEMDB || noContent ){
drhf8e632b2007-05-08 14:51:36 +00002853 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00002854 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00002855 return SQLITE_FULL;
2856 }
danielk19778c0a7912008-08-20 14:49:23 +00002857 memset(pPg->pData, 0, pPager->pageSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00002858 if( noContent ){
danielk19778c0a7912008-08-20 14:49:23 +00002859 pPg->flags |= PGHDR_NEED_READ;
2860 }
drh538f5702007-04-13 02:14:30 +00002861 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00002862 }else{
danielk1977e180dd92007-04-05 17:15:52 +00002863 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00002864 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
danielk19778c0a7912008-08-20 14:49:23 +00002865 /* sqlite3PagerUnref(pPg); */
2866 pagerDropPage(pPg);
drh551b7732006-11-06 21:20:25 +00002867 return rc;
drh81a20f22001-10-12 17:30:04 +00002868 }
drh306dc212001-05-21 13:45:10 +00002869 }
danielk19773c407372005-02-15 02:54:14 +00002870#ifdef SQLITE_CHECK_PAGES
2871 pPg->pageHash = pager_pagehash(pPg);
2872#endif
drhed7c8552001-04-11 14:29:21 +00002873 }else{
drhd9b02572001-04-15 00:37:09 +00002874 /* The requested page is in the page cache. */
danielk19778c0a7912008-08-20 14:49:23 +00002875 assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00002876 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00002877 if( !noContent ){
2878 rc = pager_get_content(pPg);
2879 if( rc ){
danielk19778c0a7912008-08-20 14:49:23 +00002880 sqlite3PagerUnref(pPg);
drhd33d5a82007-04-26 12:11:28 +00002881 return rc;
2882 }
2883 }
drhed7c8552001-04-11 14:29:21 +00002884 }
danielk19778c0a7912008-08-20 14:49:23 +00002885
danielk19773b8a05f2007-03-19 17:44:26 +00002886 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00002887 return SQLITE_OK;
2888}
danielk19778c0a7912008-08-20 14:49:23 +00002889
drh86f8c192007-08-22 00:39:19 +00002890int sqlite3PagerAcquire(
2891 Pager *pPager, /* The pager open on the database file */
2892 Pgno pgno, /* Page number to fetch */
2893 DbPage **ppPage, /* Write a pointer to the page here */
2894 int noContent /* Do not bother reading content from disk if true */
2895){
2896 int rc;
drh86f8c192007-08-22 00:39:19 +00002897 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
drh86f8c192007-08-22 00:39:19 +00002898 return rc;
2899}
2900
drhed7c8552001-04-11 14:29:21 +00002901
2902/*
drh7e3b0a02001-04-28 16:52:40 +00002903** Acquire a page if it is already in the in-memory cache. Do
2904** not read the page from disk. Return a pointer to the page,
2905** or 0 if the page is not in cache.
2906**
danielk19773b8a05f2007-03-19 17:44:26 +00002907** See also sqlite3PagerGet(). The difference between this routine
2908** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002909** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002910** returns NULL if the page is not in cache or if a disk I/O error
2911** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002912*/
danielk19773b8a05f2007-03-19 17:44:26 +00002913DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00002914 PgHdr *pPg = 0;
drh836faa42003-01-11 13:30:57 +00002915 assert( pPager!=0 );
2916 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00002917
danielk19778c0a7912008-08-20 14:49:23 +00002918 if( (pPager->state!=PAGER_UNLOCK)
2919 && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL)
2920 ){
2921 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg);
danielk1977e277be02007-03-23 18:12:06 +00002922 }
danielk19778c0a7912008-08-20 14:49:23 +00002923
danielk19773b8a05f2007-03-19 17:44:26 +00002924 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00002925}
2926
2927/*
drhed7c8552001-04-11 14:29:21 +00002928** Release a page.
2929**
2930** If the number of references to the page drop to zero, then the
2931** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002932** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002933** removed.
2934*/
danielk19773b8a05f2007-03-19 17:44:26 +00002935int sqlite3PagerUnref(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002936 if( pPg ){
2937 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002938 sqlite3PcacheRelease(pPg);
2939 pagerUnlockIfUnused(pPager);
drhed7c8552001-04-11 14:29:21 +00002940 }
drhd9b02572001-04-15 00:37:09 +00002941 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002942}
2943
2944/*
drha6abd042004-06-09 17:37:22 +00002945** Create a journal file for pPager. There should already be a RESERVED
2946** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002947**
2948** Return SQLITE_OK if everything. Return an error code and release the
2949** write lock if anything goes wrong.
2950*/
2951static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00002952 sqlite3_vfs *pVfs = pPager->pVfs;
2953 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
2954
drhda47d772002-12-02 04:25:19 +00002955 int rc;
drhb7f91642004-10-31 02:22:47 +00002956 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00002957 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002958 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00002959 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00002960 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00002961 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00002962 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002963 rc = SQLITE_NOMEM;
2964 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002965 }
danielk1977b4b47412007-08-17 15:53:36 +00002966
drhfdc40e92008-04-17 20:59:37 +00002967 if( pPager->journalOpen==0 ){
2968 if( pPager->tempFile ){
2969 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
2970 }else{
2971 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00002972 }
drhfdc40e92008-04-17 20:59:37 +00002973#ifdef SQLITE_ENABLE_ATOMIC_WRITE
2974 rc = sqlite3JournalOpen(
2975 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
2976 );
2977#else
2978 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
2979#endif
2980 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
2981 pPager->journalOff = 0;
2982 pPager->setMaster = 0;
2983 pPager->journalHdr = 0;
2984 if( rc!=SQLITE_OK ){
2985 if( rc==SQLITE_NOMEM ){
2986 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2987 }
2988 goto failed_to_open_journal;
2989 }
drhda47d772002-12-02 04:25:19 +00002990 }
2991 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002992 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002993 pPager->needSync = 0;
drh968af522003-02-11 14:55:40 +00002994 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00002995 if( pPager->errCode ){
2996 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00002997 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00002998 }
drhda47d772002-12-02 04:25:19 +00002999 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003000
danielk197776572402004-06-25 02:38:54 +00003001 rc = writeJournalHdr(pPager);
3002
drhac69b052004-05-12 13:30:07 +00003003 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003004 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003005 }
danielk1977ae72d982007-10-03 08:46:44 +00003006 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003007 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003008 if( rc==SQLITE_OK ){
3009 rc = SQLITE_FULL;
3010 }
3011 }
drh9c105bb2004-10-02 20:38:28 +00003012 return rc;
3013
3014failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003015 sqlite3BitvecDestroy(pPager->pInJournal);
3016 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003017 return rc;
drhda47d772002-12-02 04:25:19 +00003018}
3019
3020/*
drh4b845d72002-03-05 12:41:19 +00003021** Acquire a write-lock on the database. The lock is removed when
3022** the any of the following happen:
3023**
drh80e35f42007-03-30 14:06:34 +00003024** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003025** * sqlite3PagerRollback() is called.
3026** * sqlite3PagerClose() is called.
3027** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003028**
danielk197713adf8a2004-06-03 16:08:41 +00003029** The first parameter to this routine is a pointer to any open page of the
3030** database file. Nothing changes about the page - it is used merely to
3031** acquire a pointer to the Pager structure and as proof that there is
3032** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003033**
danielk197713adf8a2004-06-03 16:08:41 +00003034** The second parameter indicates how much space in bytes to reserve for a
3035** master journal file-name at the start of the journal when it is created.
3036**
3037** A journal file is opened if this is not a temporary file. For temporary
3038** files, the opening of the journal file is deferred until there is an
3039** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003040**
drha6abd042004-06-09 17:37:22 +00003041** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003042**
3043** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3044** immediately instead of waiting until we try to flush the cache. The
3045** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003046*/
danielk19773b8a05f2007-03-19 17:44:26 +00003047int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003048 Pager *pPager = pPg->pPager;
3049 int rc = SQLITE_OK;
3050 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003051 assert( pPager->state!=PAGER_UNLOCK );
3052 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003053 assert( pPager->pInJournal==0 );
danielk19778c0a7912008-08-20 14:49:23 +00003054 sqlite3PcacheAssertFlags(pPager->pPCache, 0, PGHDR_IN_JOURNAL);
drhb7f91642004-10-31 02:22:47 +00003055 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003056 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003057 pPager->origDbSize = pPager->dbSize;
3058 }else{
drh054889e2005-11-30 03:20:31 +00003059 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003060 if( rc==SQLITE_OK ){
3061 pPager->state = PAGER_RESERVED;
3062 if( exFlag ){
3063 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3064 }
3065 }
danielk19779eed5052004-06-04 10:38:30 +00003066 if( rc!=SQLITE_OK ){
3067 return rc;
drhac69b052004-05-12 13:30:07 +00003068 }
drha6abd042004-06-09 17:37:22 +00003069 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003070 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhfdc40e92008-04-17 20:59:37 +00003071 if( pPager->useJournal && !pPager->tempFile
3072 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drhac69b052004-05-12 13:30:07 +00003073 rc = pager_open_journal(pPager);
3074 }
drh4b845d72002-03-05 12:41:19 +00003075 }
danielk1977334cdb62007-03-26 08:05:12 +00003076 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00003077 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00003078 ** time a (read or write) transaction was successfully concluded
3079 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00003080 ** kept open and either was truncated to 0 bytes or its header was
3081 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00003082 */
3083 assert( pPager->nRec==0 );
3084 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003085 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003086 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003087 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhf5e7bb52008-02-18 14:47:33 +00003088 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003089 rc = SQLITE_NOMEM;
3090 }else{
drh369339d2007-03-30 16:01:55 +00003091 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003092 rc = writeJournalHdr(pPager);
3093 }
drh4b845d72002-03-05 12:41:19 +00003094 }
danielk1977334cdb62007-03-26 08:05:12 +00003095 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003096 return rc;
3097}
3098
3099/*
drh605ad8f2006-05-03 23:34:05 +00003100** Make a page dirty. Set its dirty flag and add it to the dirty
3101** page list.
3102*/
3103static void makeDirty(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003104 sqlite3PcacheMakeDirty(pPg);
drh605ad8f2006-05-03 23:34:05 +00003105}
3106
3107/*
3108** Make a page clean. Clear its dirty bit and remove it from the
3109** dirty page list.
3110*/
3111static void makeClean(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003112 sqlite3PcacheMakeClean(pPg);
drh605ad8f2006-05-03 23:34:05 +00003113}
3114
3115
3116/*
drhed7c8552001-04-11 14:29:21 +00003117** Mark a data page as writeable. The page is written into the journal
3118** if it is not there already. This routine must be called before making
3119** changes to a page.
3120**
3121** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003122** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003123** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003124** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003125** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003126**
3127** If the journal file could not be written because the disk is full,
3128** then this routine returns SQLITE_FULL and does an immediate rollback.
3129** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003130** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003131** reset.
drhed7c8552001-04-11 14:29:21 +00003132*/
danielk19773b8a05f2007-03-19 17:44:26 +00003133static int pager_write(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003134 void *pData = pPg->pData;
drh69688d52001-04-14 16:38:23 +00003135 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003136 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003137
drh6446c4d2001-12-15 14:22:18 +00003138 /* Check for errors
3139 */
danielk1977efaaf572006-01-16 11:29:19 +00003140 if( pPager->errCode ){
3141 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003142 }
drh5e00f6c2001-09-13 13:46:56 +00003143 if( pPager->readOnly ){
3144 return SQLITE_PERM;
3145 }
drh6446c4d2001-12-15 14:22:18 +00003146
danielk197776572402004-06-25 02:38:54 +00003147 assert( !pPager->setMaster );
3148
danielk19773c407372005-02-15 02:54:14 +00003149 CHECK_PAGE(pPg);
3150
drh538f5702007-04-13 02:14:30 +00003151 /* If this page was previously acquired with noContent==1, that means
3152 ** we didn't really read in the content of the page. This can happen
3153 ** (for example) when the page is being moved to the freelist. But
3154 ** now we are (perhaps) moving the page off of the freelist for
3155 ** reuse and we need to know its original content so that content
3156 ** can be stored in the rollback journal. So do the read at this
3157 ** time.
3158 */
drhd33d5a82007-04-26 12:11:28 +00003159 rc = pager_get_content(pPg);
3160 if( rc ){
3161 return rc;
drh538f5702007-04-13 02:14:30 +00003162 }
3163
drh6446c4d2001-12-15 14:22:18 +00003164 /* Mark the page as dirty. If the page has already been written
3165 ** to the journal then we can return right away.
3166 */
drh605ad8f2006-05-03 23:34:05 +00003167 makeDirty(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00003168 if( (pPg->flags&PGHDR_IN_JOURNAL)
3169 && (pageInStatement(pPg) || pPager->stmtInUse==0)
3170 ){
drha6abd042004-06-09 17:37:22 +00003171 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003172 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003173 }else{
drh6446c4d2001-12-15 14:22:18 +00003174
danielk1977a0bf2652004-11-04 14:30:04 +00003175 /* If we get this far, it means that the page needs to be
3176 ** written to the transaction journal or the ckeckpoint journal
3177 ** or both.
3178 **
3179 ** First check to see that the transaction journal exists and
3180 ** create it if it does not.
3181 */
3182 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003183 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003184 if( rc!=SQLITE_OK ){
3185 return rc;
3186 }
3187 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00003188 if( !pPager->journalOpen && pPager->useJournal
3189 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00003190 rc = pager_open_journal(pPager);
3191 if( rc!=SQLITE_OK ) return rc;
3192 }
danielk1977a0bf2652004-11-04 14:30:04 +00003193 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003194 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003195
3196 /* The transaction journal now exists and we have a RESERVED or an
3197 ** EXCLUSIVE lock on the main database file. Write the current page to
3198 ** the transaction journal if it is not there already.
3199 */
danielk19778c0a7912008-08-20 14:49:23 +00003200 if( !(pPg->flags&PGHDR_IN_JOURNAL) && (pPager->journalOpen || MEMDB) ){
danielk1977a0bf2652004-11-04 14:30:04 +00003201 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00003202 if( MEMDB ){
drh4f0c5872007-03-26 22:05:01 +00003203 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003204 rc = sqlite3PcachePreserve(pPg, 0);
3205 if( rc!=SQLITE_OK ){
3206 return rc;
danielk1977a0bf2652004-11-04 14:30:04 +00003207 }
3208 }else{
drhbf4bca52007-09-06 22:19:14 +00003209 u32 cksum;
3210 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00003211
drh267cb322005-09-16 17:16:52 +00003212 /* We should never write to the journal file the page that
3213 ** contains the database locks. The following assert verifies
3214 ** that we do not. */
3215 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00003216 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00003217 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00003218 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
3219 if( rc==SQLITE_OK ){
3220 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
3221 pPager->journalOff + 4);
3222 pPager->journalOff += pPager->pageSize+4;
3223 }
3224 if( rc==SQLITE_OK ){
3225 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
3226 pPager->journalOff += 4;
3227 }
3228 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00003229 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00003230 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00003231 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
danielk19778c0a7912008-08-20 14:49:23 +00003232 PAGERID(pPager), pPg->pgno,
3233 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00003234
drhfd131da2007-08-07 17:13:03 +00003235 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00003236 ** transaction will be rolled back by the layer above.
3237 */
danielk1977a0bf2652004-11-04 14:30:04 +00003238 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00003239 return rc;
3240 }
danielk197707cb5602006-01-20 10:55:05 +00003241
danielk1977a0bf2652004-11-04 14:30:04 +00003242 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00003243 assert( pPager->pInJournal!=0 );
3244 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003245 if( !pPager->noSync ){
3246 pPg->flags |= PGHDR_NEED_SYNC;
3247 }
danielk1977a0bf2652004-11-04 14:30:04 +00003248 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00003249 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003250 }
drhac69b052004-05-12 13:30:07 +00003251 }
danielk197713adf8a2004-06-03 16:08:41 +00003252 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003253 if( !pPager->journalStarted && !pPager->noSync ){
3254 pPg->flags |= PGHDR_NEED_SYNC;
3255 }
drh4f0c5872007-03-26 22:05:01 +00003256 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk19778c0a7912008-08-20 14:49:23 +00003257 PAGERID(pPager), pPg->pgno,
3258 ((pPg->flags&PGHDR_NEED_SYNC)?1:0));
danielk1977a0bf2652004-11-04 14:30:04 +00003259 }
danielk19778c0a7912008-08-20 14:49:23 +00003260 if( pPg->flags&PGHDR_NEED_SYNC ){
danielk1977a0bf2652004-11-04 14:30:04 +00003261 pPager->needSync = 1;
3262 }
danielk19778c0a7912008-08-20 14:49:23 +00003263 pPg->flags |= PGHDR_IN_JOURNAL;
danielk1977a0bf2652004-11-04 14:30:04 +00003264 }
3265
3266 /* If the statement journal is open and the page is not in it,
3267 ** then write the current page to the statement journal. Note that
3268 ** the statement journal format differs from the standard journal format
3269 ** in that it omits the checksums and the header.
3270 */
danielk1977f35843b2007-04-07 15:03:17 +00003271 if( pPager->stmtInUse
3272 && !pageInStatement(pPg)
3273 && (int)pPg->pgno<=pPager->stmtSize
3274 ){
danielk19778c0a7912008-08-20 14:49:23 +00003275 assert(
3276 (pPg->flags&PGHDR_IN_JOURNAL) || (int)pPg->pgno>pPager->origDbSize );
danielk1977a0bf2652004-11-04 14:30:04 +00003277 if( MEMDB ){
danielk19778c0a7912008-08-20 14:49:23 +00003278 rc = sqlite3PcachePreserve(pPg, 1);
3279 if( rc!=SQLITE_OK ){
3280 return rc;
danielk1977a0bf2652004-11-04 14:30:04 +00003281 }
drh4f0c5872007-03-26 22:05:01 +00003282 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003283 /* page_add_to_stmt_list(pPg); */
danielk1977a0bf2652004-11-04 14:30:04 +00003284 }else{
danielk197762079062007-08-15 17:08:46 +00003285 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00003286 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
3287 rc = write32bits(pPager->stfd, offset, pPg->pgno);
3288 if( rc==SQLITE_OK ){
3289 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
3290 }
drh4f0c5872007-03-26 22:05:01 +00003291 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003292 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00003293 return rc;
3294 }
danielk1977a0bf2652004-11-04 14:30:04 +00003295 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00003296 assert( pPager->pInStmt!=0 );
3297 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00003298 }
drhd9b02572001-04-15 00:37:09 +00003299 }
drhfa86c412002-02-02 15:01:15 +00003300 }
3301
3302 /* Update the database size and return.
3303 */
drh1aa2d8b2007-01-03 15:34:29 +00003304 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00003305 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003306 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00003307 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003308 pPager->dbSize++;
3309 }
drh306dc212001-05-21 13:45:10 +00003310 }
drh69688d52001-04-14 16:38:23 +00003311 return rc;
drhed7c8552001-04-11 14:29:21 +00003312}
3313
3314/*
danielk19774099f6e2007-03-19 11:25:20 +00003315** This function is used to mark a data-page as writable. It uses
3316** pager_write() to open a journal file (if it is not already open)
3317** and write the page *pData to the journal.
3318**
3319** The difference between this function and pager_write() is that this
3320** function also deals with the special case where 2 or more pages
3321** fit on a single disk sector. In this case all co-resident pages
3322** must have been written to the journal file before returning.
3323*/
danielk19773b8a05f2007-03-19 17:44:26 +00003324int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003325 int rc = SQLITE_OK;
3326
danielk19773b8a05f2007-03-19 17:44:26 +00003327 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003328 Pager *pPager = pPg->pPager;
3329 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3330
3331 if( !MEMDB && nPagePerSector>1 ){
3332 Pgno nPageCount; /* Total number of pages in database file */
3333 Pgno pg1; /* First page of the sector pPg is located on. */
3334 int nPage; /* Number of pages starting at pg1 to journal */
3335 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003336 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003337
3338 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3339 ** header to be written between the pages journaled by this function.
3340 */
3341 assert( pPager->doNotSync==0 );
3342 pPager->doNotSync = 1;
3343
3344 /* This trick assumes that both the page-size and sector-size are
3345 ** an integer power of 2. It sets variable pg1 to the identifier
3346 ** of the first page of the sector pPg is located on.
3347 */
3348 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3349
danielk1977ad0132d2008-06-07 08:58:22 +00003350 sqlite3PagerPagecount(pPager, (int *)&nPageCount);
danielk19774099f6e2007-03-19 11:25:20 +00003351 if( pPg->pgno>nPageCount ){
3352 nPage = (pPg->pgno - pg1)+1;
3353 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3354 nPage = nPageCount+1-pg1;
3355 }else{
3356 nPage = nPagePerSector;
3357 }
3358 assert(nPage>0);
3359 assert(pg1<=pPg->pgno);
3360 assert((pg1+nPage)>pPg->pgno);
3361
3362 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3363 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003364 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00003365 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00003366 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003367 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003368 if( rc==SQLITE_OK ){
3369 rc = pager_write(pPage);
danielk19778c0a7912008-08-20 14:49:23 +00003370 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003371 needSync = 1;
3372 }
danielk19773b8a05f2007-03-19 17:44:26 +00003373 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003374 }
3375 }
drhc81945e2008-03-10 14:12:53 +00003376 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk19778c0a7912008-08-20 14:49:23 +00003377 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003378 needSync = 1;
3379 }
danielk19778c0a7912008-08-20 14:49:23 +00003380 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003381 }
3382 }
3383
danielk1977dd97a492007-08-22 18:54:32 +00003384 /* If the PgHdr.needSync flag is set for any of the nPage pages
3385 ** starting at pg1, then it needs to be set for all of them. Because
3386 ** writing to any of these nPage pages may damage the others, the
3387 ** journal file must contain sync()ed copies of all of them
3388 ** before any of them can be written out to the database file.
3389 */
3390 if( needSync ){
3391 for(ii=0; ii<nPage && needSync; ii++){
3392 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
danielk19778c0a7912008-08-20 14:49:23 +00003393 if( pPage ) pPage->flags |= PGHDR_NEED_SYNC;
3394 sqlite3PagerUnref(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003395 }
3396 assert(pPager->needSync);
3397 }
3398
danielk19774099f6e2007-03-19 11:25:20 +00003399 assert( pPager->doNotSync==1 );
3400 pPager->doNotSync = 0;
3401 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003402 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003403 }
3404 return rc;
3405}
3406
3407/*
drhaacc5432002-01-06 17:07:40 +00003408** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003409** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003410** to change the content of the page.
3411*/
danielk19777d3a6662006-01-23 16:21:05 +00003412#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003413int sqlite3PagerIswriteable(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003414 return pPg->flags&PGHDR_DIRTY;
drh6019e162001-07-02 17:51:45 +00003415}
danielk19777d3a6662006-01-23 16:21:05 +00003416#endif
drh6019e162001-07-02 17:51:45 +00003417
drh001bbcb2003-03-19 03:14:00 +00003418/*
drh30e58752002-03-02 20:41:57 +00003419** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003420** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00003421** that page might be marked as dirty.
3422**
3423** The overlying software layer calls this routine when all of the data
3424** on the given page is unused. The pager marks the page as clean so
3425** that it does not get written to disk.
3426**
3427** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003428** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003429** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003430**
3431** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003432** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003433** will thereafter be ignored. This is necessary to avoid a problem
3434** where a page with data is added to the freelist during one part of
3435** a transaction then removed from the freelist during a later part
3436** of the same transaction and reused for some other purpose. When it
3437** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003438** the sqlite3PagerDontRollback() routine is called. But because the
3439** page contains critical data, we still need to be sure it gets
3440** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003441*/
danielk1977a1fa00d2008-08-27 15:16:33 +00003442int sqlite3PagerDontWrite(DbPage *pDbPage){
drh538f5702007-04-13 02:14:30 +00003443 PgHdr *pPg = pDbPage;
3444 Pager *pPager = pPg->pPager;
danielk1977a1fa00d2008-08-27 15:16:33 +00003445 int rc;
drh8e298f92002-07-06 16:28:47 +00003446
danielk1977a1fa00d2008-08-27 15:16:33 +00003447 if( MEMDB || pPg->pgno>pPager->origDbSize ){
3448 return SQLITE_OK;
3449 }
3450 if( pPager->pAlwaysRollback==0 ){
3451 assert( pPager->pInJournal );
3452 pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->origDbSize);
3453 if( !pPager->pAlwaysRollback ){
3454 return SQLITE_NOMEM;
3455 }
3456 }
3457 rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno);
3458
3459 if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00003460 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00003461 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
3462 /* If this pages is the last page in the file and the file has grown
3463 ** during the current transaction, then do NOT mark the page as clean.
3464 ** When the database file grows, we must make sure that the last page
3465 ** gets written at least once so that the disk file will be the correct
3466 ** size. If you do not write this page and the size of the file
3467 ** on the disk ends up being too small, that can lead to database
3468 ** corruption during the next transaction.
3469 */
3470 }else{
drh538f5702007-04-13 02:14:30 +00003471 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3472 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
danielk197733e32162008-08-23 18:53:08 +00003473 pPg->flags |= PGHDR_DONT_WRITE;
danielk19773c407372005-02-15 02:54:14 +00003474#ifdef SQLITE_CHECK_PAGES
3475 pPg->pageHash = pager_pagehash(pPg);
3476#endif
drh8124a302002-06-25 14:43:57 +00003477 }
drh30e58752002-03-02 20:41:57 +00003478 }
danielk1977a1fa00d2008-08-27 15:16:33 +00003479 return rc;
drh30e58752002-03-02 20:41:57 +00003480}
3481
3482/*
3483** A call to this routine tells the pager that if a rollback occurs,
3484** it is not necessary to restore the data on the given page. This
3485** means that the pager does not have to record the given page in the
3486** rollback journal.
drh538f5702007-04-13 02:14:30 +00003487**
3488** If we have not yet actually read the content of this page (if
3489** the PgHdr.needRead flag is set) then this routine acts as a promise
3490** that we will never need to read the page content in the future.
3491** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003492*/
danielk19773b8a05f2007-03-19 17:44:26 +00003493void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003494 Pager *pPager = pPg->pPager;
3495
drhd3627af2006-12-18 18:34:51 +00003496 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00003497
3498 /* If the journal file is not open, or DontWrite() has been called on
3499 ** this page (DontWrite() sets the alwaysRollback flag), then this
3500 ** function is a no-op.
3501 */
danielk1977a1fa00d2008-08-27 15:16:33 +00003502 if( pPager->journalOpen==0
3503 || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno)
3504 || pPg->pgno>pPager->origDbSize
danielk19778c0a7912008-08-20 14:49:23 +00003505 ){
danielk197787c29a92008-01-18 11:33:16 +00003506 return;
3507 }
danielk1977a55e9352008-01-21 13:04:34 +00003508 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
3509
drhc5d0bd92008-04-14 01:00:57 +00003510#ifdef SQLITE_SECURE_DELETE
danielk1977a1fa00d2008-08-27 15:16:33 +00003511 if( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize ){
drhc5d0bd92008-04-14 01:00:57 +00003512 return;
3513 }
3514#endif
3515
3516 /* If SECURE_DELETE is disabled, then there is no way that this
3517 ** routine can be called on a page for which sqlite3PagerDontWrite()
3518 ** has not been previously called during the same transaction.
3519 ** And if DontWrite() has previously been called, the following
3520 ** conditions must be met.
drh10131482008-07-11 03:34:09 +00003521 **
3522 ** (Later:) Not true. If the database is corrupted by having duplicate
3523 ** pages on the freelist (ex: corrupt9.test) then the following is not
3524 ** necessarily true:
danielk1977a55e9352008-01-21 13:04:34 +00003525 */
drh10131482008-07-11 03:34:09 +00003526 /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ); */
danielk1977a55e9352008-01-21 13:04:34 +00003527
drhf5e7bb52008-02-18 14:47:33 +00003528 assert( pPager->pInJournal!=0 );
3529 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003530 pPg->flags |= PGHDR_IN_JOURNAL;
3531 pPg->flags &= ~PGHDR_NEED_READ;
danielk1977a55e9352008-01-21 13:04:34 +00003532 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00003533 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00003534 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00003535 }
danielk1977a55e9352008-01-21 13:04:34 +00003536 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
3537 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003538}
3539
drhac69b052004-05-12 13:30:07 +00003540
drh30e58752002-03-02 20:41:57 +00003541/*
drh80e35f42007-03-30 14:06:34 +00003542** This routine is called to increment the database file change-counter,
3543** stored at byte 24 of the pager file.
3544*/
danielk1977c7b60172007-08-22 11:22:03 +00003545static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00003546 PgHdr *pPgHdr;
3547 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00003548 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00003549
drh701bb3b2008-08-02 03:50:39 +00003550#ifndef SQLITE_ENABLE_ATOMIC_WRITE
3551 assert( isDirect==0 ); /* isDirect is only true for atomic writes */
3552#endif
drh80e35f42007-03-30 14:06:34 +00003553 if( !pPager->changeCountDone ){
3554 /* Open page 1 of the file for writing. */
3555 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3556 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00003557
3558 if( !isDirect ){
3559 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00003560 if( rc!=SQLITE_OK ){
3561 sqlite3PagerUnref(pPgHdr);
3562 return rc;
3563 }
danielk1977c7b60172007-08-22 11:22:03 +00003564 }
3565
drh80e35f42007-03-30 14:06:34 +00003566 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003567 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003568 change_counter++;
danielk19778c0a7912008-08-20 14:49:23 +00003569 put32bits(((char*)pPgHdr->pData)+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00003570
drh701bb3b2008-08-02 03:50:39 +00003571#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977c7b60172007-08-22 11:22:03 +00003572 if( isDirect && pPager->fd->pMethods ){
danielk19778c0a7912008-08-20 14:49:23 +00003573 const void *zBuf = pPgHdr->pData;
danielk1977c7b60172007-08-22 11:22:03 +00003574 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
3575 }
drh701bb3b2008-08-02 03:50:39 +00003576#endif
danielk1977c7b60172007-08-22 11:22:03 +00003577
drh80e35f42007-03-30 14:06:34 +00003578 /* Release the page reference. */
3579 sqlite3PagerUnref(pPgHdr);
3580 pPager->changeCountDone = 1;
3581 }
danielk1977c7b60172007-08-22 11:22:03 +00003582 return rc;
drh80e35f42007-03-30 14:06:34 +00003583}
3584
3585/*
danielk1977f653d782008-03-20 11:04:21 +00003586** Sync the pager file to disk.
3587*/
3588int sqlite3PagerSync(Pager *pPager){
3589 int rc;
drh7426f862008-08-26 21:07:26 +00003590 if( MEMDB ){
3591 rc = SQLITE_OK;
3592 }else{
3593 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
3594 }
danielk1977f653d782008-03-20 11:04:21 +00003595 return rc;
3596}
3597
3598/*
drh80e35f42007-03-30 14:06:34 +00003599** Sync the database file for the pager pPager. zMaster points to the name
3600** of a master journal file that should be written into the individual
3601** journal file. zMaster may be NULL, which is interpreted as no master
3602** journal (a single database transaction).
3603**
3604** This routine ensures that the journal is synced, all dirty pages written
3605** to the database file and the database file synced. The only thing that
3606** remains to commit the transaction is to delete the journal file (or
3607** master journal file if specified).
3608**
3609** Note that if zMaster==NULL, this does not overwrite a previous value
3610** passed to an sqlite3PagerCommitPhaseOne() call.
3611**
3612** If parameter nTrunc is non-zero, then the pager file is truncated to
3613** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00003614**
3615** If the final parameter - noSync - is true, then the database file itself
3616** is not synced. The caller must call sqlite3PagerSync() directly to
3617** sync the database file before calling CommitPhaseTwo() to delete the
3618** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00003619*/
danielk1977f653d782008-03-20 11:04:21 +00003620int sqlite3PagerCommitPhaseOne(
3621 Pager *pPager,
3622 const char *zMaster,
3623 Pgno nTrunc,
3624 int noSync
3625){
drh80e35f42007-03-30 14:06:34 +00003626 int rc = SQLITE_OK;
3627
danielk1977dad31b52008-05-15 11:08:07 +00003628 if( pPager->errCode ){
3629 return pPager->errCode;
3630 }
3631
drhd138c012008-05-13 00:58:18 +00003632 /* If no changes have been made, we can leave the transaction early.
3633 */
3634 if( pPager->dbModified==0 &&
3635 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3636 pPager->exclusiveMode!=0) ){
3637 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3638 return SQLITE_OK;
3639 }
3640
drh80e35f42007-03-30 14:06:34 +00003641 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3642 pPager->zFilename, zMaster, nTrunc);
3643
3644 /* If this is an in-memory db, or no pages have been written to, or this
3645 ** function has already been called, it is a no-op.
3646 */
3647 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3648 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00003649
danielk1977c7b60172007-08-22 11:22:03 +00003650#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3651 /* The atomic-write optimization can be used if all of the
3652 ** following are true:
3653 **
3654 ** + The file-system supports the atomic-write property for
3655 ** blocks of size page-size, and
3656 ** + This commit is not part of a multi-file transaction, and
3657 ** + Exactly one page has been modified and store in the journal file.
3658 **
3659 ** If the optimization can be used, then the journal file will never
3660 ** be created for this transaction.
3661 */
danielk19778c0a7912008-08-20 14:49:23 +00003662 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
danielk1977f55b8992007-08-24 08:15:53 +00003663 int useAtomicWrite = (
3664 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00003665 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00003666 pPager->journalOff==jrnlBufferSize(pPager) &&
3667 nTrunc==0 &&
danielk19778c0a7912008-08-20 14:49:23 +00003668 (pPg==0 || pPg->pDirty==0)
danielk1977f55b8992007-08-24 08:15:53 +00003669 );
danielk1977700b9c52008-04-24 12:37:40 +00003670 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00003671 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00003672 /* Update the nRec field in the journal file. */
3673 int offset = pPager->journalHdr + sizeof(aJournalMagic);
3674 assert(pPager->nRec==1);
3675 rc = write32bits(pPager->jfd, offset, pPager->nRec);
3676
3677 /* Update the db file change counter. The following call will modify
3678 ** the in-memory representation of page 1 to include the updated
3679 ** change counter and then write page 1 directly to the database
3680 ** file. Because of the atomic-write property of the host file-system,
3681 ** this is safe.
3682 */
danielk1977ae72d982007-10-03 08:46:44 +00003683 if( rc==SQLITE_OK ){
3684 rc = pager_incr_changecounter(pPager, 1);
3685 }
danielk1977f55b8992007-08-24 08:15:53 +00003686 }else{
3687 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00003688 }
3689
danielk1977ae72d982007-10-03 08:46:44 +00003690 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00003691#endif
3692
drh80e35f42007-03-30 14:06:34 +00003693 /* If a master journal file name has already been written to the
3694 ** journal file, then no sync is required. This happens when it is
3695 ** written, then the process fails to upgrade from a RESERVED to an
3696 ** EXCLUSIVE lock. The next time the process tries to commit the
3697 ** transaction the m-j name will have already been written.
3698 */
3699 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00003700 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003701 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00003702 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00003703#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00003704 if( nTrunc!=0 ){
3705 /* If this transaction has made the database smaller, then all pages
3706 ** being discarded by the truncation must be written to the journal
3707 ** file.
3708 */
3709 Pgno i;
3710 int iSkip = PAGER_MJ_PGNO(pPager);
3711 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3712 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
3713 rc = sqlite3PagerGet(pPager, i, &pPg);
3714 if( rc!=SQLITE_OK ) goto sync_exit;
3715 rc = sqlite3PagerWrite(pPg);
3716 sqlite3PagerUnref(pPg);
3717 if( rc!=SQLITE_OK ) goto sync_exit;
3718 }
3719 }
3720 }
drh80e35f42007-03-30 14:06:34 +00003721#endif
danielk197771aa7ff2008-05-20 07:05:09 +00003722 rc = writeMasterJournal(pPager, zMaster);
3723 if( rc!=SQLITE_OK ) goto sync_exit;
3724 rc = syncJournal(pPager);
3725 }
drh80e35f42007-03-30 14:06:34 +00003726 }
danielk1977c7b60172007-08-22 11:22:03 +00003727 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00003728
3729#ifndef SQLITE_OMIT_AUTOVACUUM
3730 if( nTrunc!=0 ){
3731 rc = sqlite3PagerTruncate(pPager, nTrunc);
3732 if( rc!=SQLITE_OK ) goto sync_exit;
3733 }
3734#endif
3735
3736 /* Write all dirty pages to the database file */
danielk19778c0a7912008-08-20 14:49:23 +00003737 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003738 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00003739 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00003740 assert( rc!=SQLITE_IOERR_BLOCKED );
3741 /* The error might have left the dirty list all fouled up here,
3742 ** but that does not matter because if the if the dirty list did
3743 ** get corrupted, then the transaction will roll back and
3744 ** discard the dirty list. There is an assert in
3745 ** pager_get_all_dirty_pages() that verifies that no attempt
3746 ** is made to use an invalid dirty list.
3747 */
drh153c62c2007-08-24 03:51:33 +00003748 goto sync_exit;
3749 }
danielk19778c0a7912008-08-20 14:49:23 +00003750 sqlite3PcacheCleanAll(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003751
3752 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00003753 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00003754 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00003755 }
3756 IOTRACE(("DBSYNC %p\n", pPager))
3757
3758 pPager->state = PAGER_SYNCED;
3759 }else if( MEMDB && nTrunc!=0 ){
3760 rc = sqlite3PagerTruncate(pPager, nTrunc);
3761 }
3762
3763sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00003764 if( rc==SQLITE_IOERR_BLOCKED ){
3765 /* pager_incr_changecounter() may attempt to obtain an exclusive
3766 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00003767 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00003768 * better to return SQLITE_BUSY.
3769 */
3770 rc = SQLITE_BUSY;
3771 }
drh80e35f42007-03-30 14:06:34 +00003772 return rc;
3773}
3774
3775
3776/*
drhed7c8552001-04-11 14:29:21 +00003777** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003778**
3779** If the commit fails for any reason, a rollback attempt is made
3780** and an error code is returned. If the commit worked, SQLITE_OK
3781** is returned.
drhed7c8552001-04-11 14:29:21 +00003782*/
drh80e35f42007-03-30 14:06:34 +00003783int sqlite3PagerCommitPhaseTwo(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003784 int rc = SQLITE_OK;
drhd9b02572001-04-15 00:37:09 +00003785
danielk1977efaaf572006-01-16 11:29:19 +00003786 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003787 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003788 }
drha6abd042004-06-09 17:37:22 +00003789 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003790 return SQLITE_ERROR;
3791 }
drhd138c012008-05-13 00:58:18 +00003792 if( pPager->dbModified==0 &&
3793 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3794 pPager->exclusiveMode!=0) ){
3795 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3796 return SQLITE_OK;
3797 }
drh4f0c5872007-03-26 22:05:01 +00003798 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003799 if( MEMDB ){
danielk19778c0a7912008-08-20 14:49:23 +00003800 sqlite3PcacheCommit(pPager->pPCache, 0);
3801 sqlite3PcacheCleanAll(pPager->pPCache);
3802 sqlite3PcacheSetFlags(pPager->pPCache,
danielk1977a1fa00d2008-08-27 15:16:33 +00003803 ~(PGHDR_IN_JOURNAL | PGHDR_NEED_SYNC), 0
danielk19778c0a7912008-08-20 14:49:23 +00003804 );
drha6abd042004-06-09 17:37:22 +00003805 pPager->state = PAGER_SHARED;
danielk19778c0a7912008-08-20 14:49:23 +00003806 }else{
3807 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
3808 rc = pager_end_transaction(pPager, pPager->setMaster);
3809 rc = pager_error(pPager, rc);
drhac69b052004-05-12 13:30:07 +00003810 }
drh86f8c192007-08-22 00:39:19 +00003811 return rc;
drhed7c8552001-04-11 14:29:21 +00003812}
3813
3814/*
drha6abd042004-06-09 17:37:22 +00003815** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003816** All in-memory cache pages revert to their original data contents.
3817** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003818**
3819** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003820** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003821** process is writing trash into the journal file (SQLITE_CORRUPT) or
3822** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3823** codes are returned for all these occasions. Otherwise,
3824** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003825*/
danielk19773b8a05f2007-03-19 17:44:26 +00003826int sqlite3PagerRollback(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003827 int rc = SQLITE_OK;
drh4f0c5872007-03-26 22:05:01 +00003828 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003829 if( MEMDB ){
danielk19778c0a7912008-08-20 14:49:23 +00003830 sqlite3PcacheRollback(pPager->pPCache, 1);
3831 sqlite3PcacheRollback(pPager->pPCache, 0);
3832 sqlite3PcacheCleanAll(pPager->pPCache);
3833 sqlite3PcacheSetFlags(pPager->pPCache,
danielk1977a1fa00d2008-08-27 15:16:33 +00003834 ~(PGHDR_IN_JOURNAL | PGHDR_NEED_SYNC), 0
danielk19778c0a7912008-08-20 14:49:23 +00003835 );
drhac69b052004-05-12 13:30:07 +00003836 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00003837 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00003838 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003839 pPager->state = PAGER_SHARED;
danielk19778c0a7912008-08-20 14:49:23 +00003840 }else if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00003841 rc = pager_end_transaction(pPager, pPager->setMaster);
danielk19778c0a7912008-08-20 14:49:23 +00003842 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003843 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003844 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003845 }
danielk19778c0a7912008-08-20 14:49:23 +00003846 rc = pPager->errCode;
drha6abd042004-06-09 17:37:22 +00003847 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003848 if( pPager->state==PAGER_RESERVED ){
3849 int rc2;
3850 rc = pager_playback(pPager, 0);
3851 rc2 = pager_end_transaction(pPager, pPager->setMaster);
3852 if( rc==SQLITE_OK ){
3853 rc = rc2;
3854 }
3855 }else{
3856 rc = pager_playback(pPager, 0);
3857 }
danielk197707cb5602006-01-20 10:55:05 +00003858
danielk19778c0a7912008-08-20 14:49:23 +00003859 pPager->dbSize = -1;
3860
3861 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3862 ** cache. So call pager_error() on the way out to make any error
3863 ** persistent.
3864 */
3865 rc = pager_error(pPager, rc);
3866 }
drh86f8c192007-08-22 00:39:19 +00003867 return rc;
drh98808ba2001-10-18 12:34:46 +00003868}
drhd9b02572001-04-15 00:37:09 +00003869
3870/*
drh5e00f6c2001-09-13 13:46:56 +00003871** Return TRUE if the database file is opened read-only. Return FALSE
3872** if the database is (in theory) writable.
3873*/
danielk19773b8a05f2007-03-19 17:44:26 +00003874int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003875 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003876}
3877
3878/*
drh0f7eb612006-08-08 13:51:43 +00003879** Return the number of references to the pager.
3880*/
danielk19773b8a05f2007-03-19 17:44:26 +00003881int sqlite3PagerRefcount(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003882 return sqlite3PcacheRefCount(pPager->pPCache);
drh0f7eb612006-08-08 13:51:43 +00003883}
3884
3885#ifdef SQLITE_TEST
3886/*
drhd9b02572001-04-15 00:37:09 +00003887** This routine is used for testing and analysis only.
3888*/
danielk19773b8a05f2007-03-19 17:44:26 +00003889int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003890 static int a[11];
danielk19778c0a7912008-08-20 14:49:23 +00003891 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
3892 a[1] = sqlite3PcachePagecount(pPager->pPCache);
3893 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
drhd9b02572001-04-15 00:37:09 +00003894 a[3] = pPager->dbSize;
3895 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003896 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003897 a[6] = pPager->nHit;
3898 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003899 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003900 a[9] = pPager->nRead;
3901 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003902 return a;
3903}
danielk197717b90b52008-06-06 11:11:25 +00003904int sqlite3PagerIsMemdb(Pager *pPager){
3905 return MEMDB;
3906}
drh0f7eb612006-08-08 13:51:43 +00003907#endif
drhdd793422001-06-28 01:54:48 +00003908
drhfa86c412002-02-02 15:01:15 +00003909/*
drhac69b052004-05-12 13:30:07 +00003910** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003911**
3912** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003913** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003914** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003915*/
drh86f8c192007-08-22 00:39:19 +00003916static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003917 int rc;
drhac69b052004-05-12 13:30:07 +00003918 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00003919 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00003920 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00003921 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003922 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003923 pPager->stmtInUse = 1;
3924 pPager->stmtSize = pPager->dbSize;
3925 return SQLITE_OK;
3926 }
drhda47d772002-12-02 04:25:19 +00003927 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003928 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003929 return SQLITE_OK;
3930 }
drhfa86c412002-02-02 15:01:15 +00003931 assert( pPager->journalOpen );
drhf5e7bb52008-02-18 14:47:33 +00003932 assert( pPager->pInStmt==0 );
3933 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00003934 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00003935 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00003936 return SQLITE_NOMEM;
3937 }
danielk197776572402004-06-25 02:38:54 +00003938 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003939 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003940 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003941 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003942 if( !pPager->stmtOpen ){
danielk197717b90b52008-06-06 11:11:25 +00003943 rc = sqlite3PagerOpentemp(pPager, pPager->stfd, SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00003944 if( rc ){
3945 goto stmt_begin_failed;
3946 }
drhac69b052004-05-12 13:30:07 +00003947 pPager->stmtOpen = 1;
3948 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003949 }
drhac69b052004-05-12 13:30:07 +00003950 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003951 return SQLITE_OK;
3952
drhac69b052004-05-12 13:30:07 +00003953stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00003954 if( pPager->pInStmt ){
3955 sqlite3BitvecDestroy(pPager->pInStmt);
3956 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003957 }
3958 return rc;
3959}
drh86f8c192007-08-22 00:39:19 +00003960int sqlite3PagerStmtBegin(Pager *pPager){
3961 int rc;
drh86f8c192007-08-22 00:39:19 +00003962 rc = pagerStmtBegin(pPager);
drh86f8c192007-08-22 00:39:19 +00003963 return rc;
3964}
drhfa86c412002-02-02 15:01:15 +00003965
3966/*
drhac69b052004-05-12 13:30:07 +00003967** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003968*/
danielk19773b8a05f2007-03-19 17:44:26 +00003969int sqlite3PagerStmtCommit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003970 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003971 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003972 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00003973 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhf5e7bb52008-02-18 14:47:33 +00003974 sqlite3BitvecDestroy(pPager->pInStmt);
3975 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003976 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003977 sqlite3PcacheCommit(pPager->pPCache, 1);
drhac69b052004-05-12 13:30:07 +00003978 }
3979 pPager->stmtNRec = 0;
3980 pPager->stmtInUse = 0;
drh663fc632002-02-02 18:49:19 +00003981 }
drhac69b052004-05-12 13:30:07 +00003982 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003983 return SQLITE_OK;
3984}
3985
3986/*
drhac69b052004-05-12 13:30:07 +00003987** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003988*/
danielk19773b8a05f2007-03-19 17:44:26 +00003989int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003990 int rc;
drhac69b052004-05-12 13:30:07 +00003991 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003992 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003993 if( MEMDB ){
danielk19778c0a7912008-08-20 14:49:23 +00003994 sqlite3PcacheRollback(pPager->pPCache, 1);
drhac69b052004-05-12 13:30:07 +00003995 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00003996 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00003997 rc = SQLITE_OK;
3998 }else{
3999 rc = pager_stmt_playback(pPager);
4000 }
danielk19773b8a05f2007-03-19 17:44:26 +00004001 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00004002 }else{
4003 rc = SQLITE_OK;
4004 }
drhac69b052004-05-12 13:30:07 +00004005 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00004006 return rc;
4007}
4008
drh73509ee2003-04-06 20:44:45 +00004009/*
4010** Return the full pathname of the database file.
4011*/
danielk19773b8a05f2007-03-19 17:44:26 +00004012const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004013 return pPager->zFilename;
4014}
4015
drhb20ea9d2004-02-09 01:20:36 +00004016/*
drhd0679ed2007-08-28 22:24:34 +00004017** Return the VFS structure for the pager.
4018*/
4019const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
4020 return pPager->pVfs;
4021}
4022
4023/*
drhcc6bb3e2007-08-31 16:11:35 +00004024** Return the file handle for the database file associated
4025** with the pager. This might return NULL if the file has
4026** not yet been opened.
4027*/
4028sqlite3_file *sqlite3PagerFile(Pager *pPager){
4029 return pPager->fd;
4030}
4031
4032/*
danielk19775865e3d2004-06-14 06:03:57 +00004033** Return the directory of the database file.
4034*/
danielk19773b8a05f2007-03-19 17:44:26 +00004035const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004036 return pPager->zDirectory;
4037}
4038
4039/*
4040** Return the full pathname of the journal file.
4041*/
danielk19773b8a05f2007-03-19 17:44:26 +00004042const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004043 return pPager->zJournal;
4044}
4045
4046/*
drh2c8997b2005-08-27 16:36:48 +00004047** Return true if fsync() calls are disabled for this pager. Return FALSE
4048** if fsync()s are executed normally.
4049*/
danielk19773b8a05f2007-03-19 17:44:26 +00004050int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004051 return pPager->noSync;
4052}
4053
drh7c4ac0c2007-04-05 11:25:58 +00004054#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004055/*
drhb20ea9d2004-02-09 01:20:36 +00004056** Set the codec for this pager
4057*/
danielk19773b8a05f2007-03-19 17:44:26 +00004058void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004059 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004060 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004061 void *pCodecArg
4062){
4063 pPager->xCodec = xCodec;
4064 pPager->pCodecArg = pCodecArg;
4065}
drh7c4ac0c2007-04-05 11:25:58 +00004066#endif
drhb20ea9d2004-02-09 01:20:36 +00004067
danielk1977687566d2004-11-02 12:56:41 +00004068#ifndef SQLITE_OMIT_AUTOVACUUM
4069/*
danielk197787c29a92008-01-18 11:33:16 +00004070** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004071**
drh5e385312007-06-16 04:42:12 +00004072** There must be no references to the page previously located at
4073** pgno (which we call pPgOld) though that page is allowed to be
4074** in cache. If the page previous located at pgno is not already
4075** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004076**
drh5e385312007-06-16 04:42:12 +00004077** References to the page pPg remain valid. Updating any
4078** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004079** allocated along with the page) is the responsibility of the caller.
4080**
danielk19775fd057a2005-03-09 13:09:43 +00004081** A transaction must be active when this routine is called. It used to be
4082** required that a statement transaction was not active, but this restriction
4083** has been removed (CREATE INDEX needs to move a page when a statement
4084** transaction is active).
danielk19774c999992008-07-16 18:17:55 +00004085**
4086** If the fourth argument, isCommit, is non-zero, then this page is being
4087** moved as part of a database reorganization just before the transaction
4088** is being committed. In this case, it is guaranteed that the database page
4089** pPg refers to will not be written to again within this transaction.
danielk1977687566d2004-11-02 12:56:41 +00004090*/
danielk19774c999992008-07-16 18:17:55 +00004091int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
drh5e385312007-06-16 04:42:12 +00004092 PgHdr *pPgOld; /* The page being overwritten. */
danielk197794daf7f2004-11-08 09:26:09 +00004093 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004094
danielk1977687566d2004-11-02 12:56:41 +00004095 assert( pPg->nRef>0 );
4096
drh4f0c5872007-03-26 22:05:01 +00004097 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk19778c0a7912008-08-20 14:49:23 +00004098 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno);
drhb0603412007-02-28 04:47:26 +00004099 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004100
danielk1977b4626a32007-04-28 15:47:43 +00004101 pager_get_content(pPg);
danielk19774c999992008-07-16 18:17:55 +00004102
4103 /* If the journal needs to be sync()ed before page pPg->pgno can
4104 ** be written to, store pPg->pgno in local variable needSyncPgno.
4105 **
4106 ** If the isCommit flag is set, there is no need to remember that
4107 ** the journal needs to be sync()ed before database page pPg->pgno
4108 ** can be written to. The caller has already promised not to write to it.
4109 */
danielk19778c0a7912008-08-20 14:49:23 +00004110 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
danielk197794daf7f2004-11-08 09:26:09 +00004111 needSyncPgno = pPg->pgno;
danielk19778c0a7912008-08-20 14:49:23 +00004112 assert( (pPg->flags&PGHDR_IN_JOURNAL) || (int)pgno>pPager->origDbSize );
4113 assert( pPg->flags&PGHDR_DIRTY );
danielk1977ae825582004-11-23 09:06:55 +00004114 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004115 }
4116
danielk1977ef73ee92004-11-06 12:26:07 +00004117 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00004118 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00004119 ** page pgno before the 'move' operation, it needs to be retained
4120 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004121 */
danielk19778c0a7912008-08-20 14:49:23 +00004122 pPg->flags &= ~(PGHDR_NEED_SYNC|PGHDR_IN_JOURNAL);
danielk1977687566d2004-11-02 12:56:41 +00004123 pPgOld = pager_lookup(pPager, pgno);
danielk19778c0a7912008-08-20 14:49:23 +00004124 assert( !pPgOld || pPgOld->nRef==1 );
danielk1977687566d2004-11-02 12:56:41 +00004125 if( pPgOld ){
danielk19778c0a7912008-08-20 14:49:23 +00004126 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
drh5e385312007-06-16 04:42:12 +00004127 }
danielk19778c0a7912008-08-20 14:49:23 +00004128 if( sqlite3BitvecTest(pPager->pInJournal, pgno) ){
4129 pPg->flags |= PGHDR_IN_JOURNAL;
4130 }
danielk1977687566d2004-11-02 12:56:41 +00004131
danielk19778c0a7912008-08-20 14:49:23 +00004132 sqlite3PcacheMove(pPg, pgno);
4133 if( pPgOld ){
4134 sqlite3PcacheMove(pPgOld, 0);
4135 sqlite3PcacheRelease(pPgOld);
danielk1977f5fdda82004-11-03 08:44:05 +00004136 }
danielk1977f5fdda82004-11-03 08:44:05 +00004137
drh605ad8f2006-05-03 23:34:05 +00004138 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004139 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004140 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00004141
danielk197794daf7f2004-11-08 09:26:09 +00004142 if( needSyncPgno ){
4143 /* If needSyncPgno is non-zero, then the journal file needs to be
4144 ** sync()ed before any data is written to database file page needSyncPgno.
4145 ** Currently, no such page exists in the page-cache and the
danielk19774c999992008-07-16 18:17:55 +00004146 ** "is journaled" bitvec flag has been set. This needs to be remedied by
4147 ** loading the page into the pager-cache and setting the PgHdr.needSync
4148 ** flag.
danielk1977ae825582004-11-23 09:06:55 +00004149 **
danielk1977a98d7b42008-01-18 13:42:54 +00004150 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00004151 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00004152 ** array. Otherwise, if the page is loaded and written again in
4153 ** this transaction, it may be written to the database file before
4154 ** it is synced into the journal file. This way, it may end up in
4155 ** the journal file twice, but that is not a problem.
4156 **
danielk19773b8a05f2007-03-19 17:44:26 +00004157 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004158 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004159 */
4160 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004161 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004162 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004163 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00004164 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00004165 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
4166 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00004167 }
danielk197787c29a92008-01-18 11:33:16 +00004168 return rc;
4169 }
danielk1977ae825582004-11-23 09:06:55 +00004170 pPager->needSync = 1;
danielk19778c0a7912008-08-20 14:49:23 +00004171 pPgHdr->flags |= PGHDR_NEED_SYNC;
4172 pPgHdr->flags |= PGHDR_IN_JOURNAL;
danielk19773b8a05f2007-03-19 17:44:26 +00004173 makeDirty(pPgHdr);
4174 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004175 }
4176
danielk1977687566d2004-11-02 12:56:41 +00004177 return SQLITE_OK;
4178}
4179#endif
4180
danielk19773b8a05f2007-03-19 17:44:26 +00004181/*
4182** Return a pointer to the data for the specified page.
4183*/
4184void *sqlite3PagerGetData(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00004185 assert( pPg->nRef>0 );
4186 return pPg->pData;
danielk19773b8a05f2007-03-19 17:44:26 +00004187}
4188
4189/*
4190** Return a pointer to the Pager.nExtra bytes of "extra" space
4191** allocated along with the specified page.
4192*/
4193void *sqlite3PagerGetExtra(DbPage *pPg){
4194 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00004195 return (pPager?pPg->pExtra:0);
danielk19773b8a05f2007-03-19 17:44:26 +00004196}
4197
danielk197741483462007-03-24 16:45:04 +00004198/*
4199** Get/set the locking-mode for this pager. Parameter eMode must be one
4200** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4201** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4202** the locking-mode is set to the value specified.
4203**
4204** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4205** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4206** locking-mode.
4207*/
4208int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004209 assert( eMode==PAGER_LOCKINGMODE_QUERY
4210 || eMode==PAGER_LOCKINGMODE_NORMAL
4211 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4212 assert( PAGER_LOCKINGMODE_QUERY<0 );
4213 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4214 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00004215 pPager->exclusiveMode = eMode;
4216 }
4217 return (int)pPager->exclusiveMode;
4218}
4219
drh3b020132008-04-17 17:02:01 +00004220/*
4221** Get/set the journal-mode for this pager. Parameter eMode must be one
4222** of PAGER_JOURNALMODE_QUERY, PAGER_JOURNALMODE_DELETE or
4223** PAGER_JOURNALMODE_PERSIST. If the parameter is not _QUERY, then
4224** the journal-mode is set to the value specified.
4225**
4226** The returned value is either PAGER_JOURNALMODE_DELETE or
4227** PAGER_JOURNALMODE_PERSIST, indicating the current (possibly updated)
4228** journal-mode.
4229*/
4230int sqlite3PagerJournalMode(Pager *pPager, int eMode){
4231 assert( eMode==PAGER_JOURNALMODE_QUERY
4232 || eMode==PAGER_JOURNALMODE_DELETE
drhfdc40e92008-04-17 20:59:37 +00004233 || eMode==PAGER_JOURNALMODE_PERSIST
4234 || eMode==PAGER_JOURNALMODE_OFF );
drh3b020132008-04-17 17:02:01 +00004235 assert( PAGER_JOURNALMODE_QUERY<0 );
4236 assert( PAGER_JOURNALMODE_DELETE>=0 && PAGER_JOURNALMODE_PERSIST>=0 );
drhfdc40e92008-04-17 20:59:37 +00004237 if( eMode>=0 ){
4238 pPager->journalMode = eMode;
drh3b020132008-04-17 17:02:01 +00004239 }
drhfdc40e92008-04-17 20:59:37 +00004240 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00004241}
4242
danielk1977b53e4962008-06-04 06:45:59 +00004243/*
4244** Get/set the size-limit used for persistent journal files.
4245*/
4246i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
4247 if( iLimit>=-1 ){
4248 pPager->journalSizeLimit = iLimit;
4249 }
4250 return pPager->journalSizeLimit;
4251}
4252
drh2e66f0b2005-04-28 17:18:48 +00004253#endif /* SQLITE_OMIT_DISKIO */