blob: 900aa1618d0fca05aaa359c677db2f4b350353f3 [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**
danielk1977c56774e2008-10-07 11:51:20 +000021** @(#) $Id: pager.c,v 1.497 2008/10/07 11:51:20 danielk1977 Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drh2e66f0b2005-04-28 17:18:48 +000023#ifndef SQLITE_OMIT_DISKIO
drhd9b02572001-04-15 00:37:09 +000024#include "sqliteInt.h"
drhed7c8552001-04-11 14:29:21 +000025
26/*
drhdb48ee02003-01-16 13:42:43 +000027** Macros for troubleshooting. Normally turned off
28*/
danielk1977466be562004-06-10 02:16:01 +000029#if 0
drhd3627af2006-12-18 18:34:51 +000030#define sqlite3DebugPrintf printf
drh4f0c5872007-03-26 22:05:01 +000031#define PAGERTRACE1(X) sqlite3DebugPrintf(X)
32#define PAGERTRACE2(X,Y) sqlite3DebugPrintf(X,Y)
33#define PAGERTRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
34#define PAGERTRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
35#define PAGERTRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000036#else
drh4f0c5872007-03-26 22:05:01 +000037#define PAGERTRACE1(X)
38#define PAGERTRACE2(X,Y)
39#define PAGERTRACE3(X,Y,Z)
40#define PAGERTRACE4(X,Y,Z,W)
41#define PAGERTRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000042#endif
43
danielk1977599fcba2004-11-08 07:13:13 +000044/*
drh4f0c5872007-03-26 22:05:01 +000045** The following two macros are used within the PAGERTRACEX() macros above
drhd86959f2005-11-26 03:51:18 +000046** to print out file-descriptors.
danielk1977599fcba2004-11-08 07:13:13 +000047**
drh85b623f2007-12-13 21:54:09 +000048** PAGERID() takes a pointer to a Pager struct as its argument. The
danielk197762079062007-08-15 17:08:46 +000049** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
drh85b623f2007-12-13 21:54:09 +000050** struct as its argument.
danielk1977599fcba2004-11-08 07:13:13 +000051*/
drhc001c582006-03-06 18:23:16 +000052#define PAGERID(p) ((int)(p->fd))
53#define FILEHANDLEID(fd) ((int)fd)
drhdb48ee02003-01-16 13:42:43 +000054
55/*
drhed7c8552001-04-11 14:29:21 +000056** The page cache as a whole is always in one of the following
57** states:
58**
drha6abd042004-06-09 17:37:22 +000059** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000060** writing the database file. There is no
61** data held in memory. This is the initial
62** state.
63**
drha6abd042004-06-09 17:37:22 +000064** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000065** Writing is not permitted. There can be
66** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000067** file at the same time.
drhed7c8552001-04-11 14:29:21 +000068**
drh726de592004-06-10 23:35:50 +000069** PAGER_RESERVED This process has reserved the database for writing
70** but has not yet made any changes. Only one process
71** at a time can reserve the database. The original
72** database file has not been modified so other
73** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000074** database file.
75**
76** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000077** Access is exclusive. No other processes or
78** threads can be reading or writing while one
79** process is writing.
80**
danielk1977aa5ccdf2004-06-14 05:10:42 +000081** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
82** after all dirty pages have been written to the
83** database file and the file has been synced to
drh369339d2007-03-30 16:01:55 +000084** disk. All that remains to do is to remove or
85** truncate the journal file and the transaction
86** will be committed.
danielk1977aa5ccdf2004-06-14 05:10:42 +000087**
drha6abd042004-06-09 17:37:22 +000088** The page cache comes up in PAGER_UNLOCK. The first time a
danielk19773b8a05f2007-03-19 17:44:26 +000089** sqlite3PagerGet() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000090** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000091** the state transitions back to PAGER_UNLOCK. The first time
danielk19773b8a05f2007-03-19 17:44:26 +000092** that sqlite3PagerWrite() is called, the state transitions to
drh369339d2007-03-30 16:01:55 +000093** PAGER_RESERVED. (Note that sqlite3PagerWrite() can only be
drh306dc212001-05-21 13:45:10 +000094** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000095** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh369339d2007-03-30 16:01:55 +000096** PAGER_RESERVED means that there is an open rollback journal.
97** The transition to PAGER_EXCLUSIVE occurs before any changes
98** are made to the database file, though writes to the rollback
99** journal occurs with just PAGER_RESERVED. After an sqlite3PagerRollback()
100** or sqlite3PagerCommitPhaseTwo(), the state can go back to PAGER_SHARED,
101** or it can stay at PAGER_EXCLUSIVE if we are in exclusive access mode.
drhed7c8552001-04-11 14:29:21 +0000102*/
drha6abd042004-06-09 17:37:22 +0000103#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000104#define PAGER_SHARED 1 /* same as SHARED_LOCK */
105#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
106#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
107#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000108
drh684917c2004-10-05 02:41:42 +0000109/*
110** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
111** then failed attempts to get a reserved lock will invoke the busy callback.
112** This is off by default. To see why, consider the following scenario:
113**
114** Suppose thread A already has a shared lock and wants a reserved lock.
115** Thread B already has a reserved lock and wants an exclusive lock. If
116** both threads are using their busy callbacks, it might be a long time
117** be for one of the threads give up and allows the other to proceed.
118** But if the thread trying to get the reserved lock gives up quickly
119** (if it never invokes its busy callback) then the contention will be
120** resolved quickly.
121*/
122#ifndef SQLITE_BUSY_RESERVED_LOCK
123# define SQLITE_BUSY_RESERVED_LOCK 0
124#endif
drhd9b02572001-04-15 00:37:09 +0000125
drhed7c8552001-04-11 14:29:21 +0000126/*
drh887dc4c2004-10-22 16:22:57 +0000127** This macro rounds values up so that if the value is an address it
128** is guaranteed to be an address that is aligned to an 8-byte boundary.
129*/
130#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
131
drh9eb9e262004-02-11 02:18:05 +0000132/*
133** A macro used for invoking the codec if there is one
134*/
135#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000136# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
137# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000138#else
drhc001c582006-03-06 18:23:16 +0000139# define CODEC1(P,D,N,X) /* NO-OP */
140# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000141#endif
142
drhed7c8552001-04-11 14:29:21 +0000143/*
drhed7c8552001-04-11 14:29:21 +0000144** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000145**
drh4f0ee682007-03-30 20:43:40 +0000146** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000147** or SQLITE_FULL. Once one of the first three errors occurs, it persists
148** and is returned as the result of every major pager API call. The
149** SQLITE_FULL return code is slightly different. It persists only until the
150** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000151** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000152** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000153*/
154struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000155 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000156 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000157 u8 journalStarted; /* True if header of journal is synced */
158 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000159 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000160 u8 stmtOpen; /* True if the statement subjournal is open */
161 u8 stmtInUse; /* True we are in a statement subtransaction */
162 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000163 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000164 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000165 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000166 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000167 u8 tempFile; /* zFilename is a temporary file */
168 u8 readOnly; /* True for a read-only database */
169 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000170 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000171 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000172 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000173 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000174 u8 doNotSync; /* Boolean. While true, do not spill the cache */
175 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
drhfdc40e92008-04-17 20:59:37 +0000176 u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */
drhd138c012008-05-13 00:58:18 +0000177 u8 dbModified; /* True if there are any changes to the Db */
drh80e35f42007-03-30 14:06:34 +0000178 u8 changeCountDone; /* Set after incrementing the change-counter */
drh33f4e022007-09-03 15:19:34 +0000179 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000180 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000181 int dbSize; /* Number of pages in the file */
182 int origDbSize; /* dbSize before the current change */
183 int stmtSize; /* Size of database (in pages) at stmt_begin() */
184 int nRec; /* Number of pages written to the journal */
185 u32 cksumInit; /* Quasi-random value added to every checksum */
186 int stmtNRec; /* Number of records in stmt subjournal */
187 int nExtra; /* Add this many bytes to each in-memory page */
188 int pageSize; /* Number of bytes in a page */
189 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000190 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000191 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000192 Bitvec *pInJournal; /* One bit for each page in the database file */
193 Bitvec *pInStmt; /* One bit for each page in the database */
danielk1977a1fa00d2008-08-27 15:16:33 +0000194 Bitvec *pAlwaysRollback; /* One bit for each page marked always-rollback */
drhfcd35c72005-05-21 02:48:08 +0000195 char *zFilename; /* Name of the database file */
196 char *zJournal; /* Name of the journal file */
197 char *zDirectory; /* Directory hold database and journal files */
danielk197762079062007-08-15 17:08:46 +0000198 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
199 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000200 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drheb206252004-10-01 02:00:31 +0000201 i64 journalOff; /* Current byte offset in the journal file */
202 i64 journalHdr; /* Byte offset to previous journal header */
203 i64 stmtHdrOff; /* First journal header written this statement */
204 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000205 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000206 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000207#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000208 int nHit, nMiss; /* Cache hits and missing */
209 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000210#endif
danielk1977eaa06f62008-09-18 17:34:44 +0000211 void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000212#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000213 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000214 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000215#endif
danielk19778186df82007-03-06 13:45:59 +0000216 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000217 char dbFileVers[16]; /* Changes whenever database file changes */
danielk1977b53e4962008-06-04 06:45:59 +0000218 i64 journalSizeLimit; /* Size limit for persistent journal files */
danielk19778c0a7912008-08-20 14:49:23 +0000219 PCache *pPCache; /* Pointer to page cache object */
drhd9b02572001-04-15 00:37:09 +0000220};
221
222/*
drh538f5702007-04-13 02:14:30 +0000223** The following global variables hold counters used for
224** testing purposes only. These variables do not exist in
225** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000226*/
227#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000228int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
229int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
230int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
drh538f5702007-04-13 02:14:30 +0000231# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000232#else
drh538f5702007-04-13 02:14:30 +0000233# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000234#endif
235
drh538f5702007-04-13 02:14:30 +0000236
237
drhfcd35c72005-05-21 02:48:08 +0000238/*
drh5e00f6c2001-09-13 13:46:56 +0000239** Journal files begin with the following magic string. The data
240** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000241**
drhae2b40c2004-06-09 19:03:54 +0000242** Since version 2.8.0, the journal format contains additional sanity
243** checking information. If the power fails while the journal is begin
244** written, semi-random garbage data might appear in the journal
245** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000246** to roll the journal back, the database could be corrupted. The additional
247** sanity checking data is an attempt to discover the garbage in the
248** journal and ignore it.
249**
drhae2b40c2004-06-09 19:03:54 +0000250** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000251** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000252** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000253** This cksum is initialized to a 32-bit random value that appears in the
254** journal file right after the header. The random initializer is important,
255** because garbage data that appears at the end of a journal is likely
256** data that was once in other files that have now been deleted. If the
257** garbage data came from an obsolete journal file, the checksums might
258** be correct. But by initializing the checksum to random value which
259** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000260*/
drhae2b40c2004-06-09 19:03:54 +0000261static const unsigned char aJournalMagic[] = {
262 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000263};
264
265/*
drh726de592004-06-10 23:35:50 +0000266** The size of the header and of each page in the journal is determined
267** by the following macros.
drh968af522003-02-11 14:55:40 +0000268*/
drhae2b40c2004-06-09 19:03:54 +0000269#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000270
danielk197776572402004-06-25 02:38:54 +0000271/*
272** The journal header size for this pager. In the future, this could be
273** set to some value read from the disk controller. The important
274** characteristic is that it is the same size as a disk sector.
275*/
276#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
277
drhb7f91642004-10-31 02:22:47 +0000278/*
279** The macro MEMDB is true if we are dealing with an in-memory database.
280** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
281** the value of MEMDB will be a constant and the compiler will optimize
282** out code that would never execute.
283*/
284#ifdef SQLITE_OMIT_MEMORYDB
285# define MEMDB 0
286#else
287# define MEMDB pPager->memDb
288#endif
289
290/*
danielk197776572402004-06-25 02:38:54 +0000291** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
292** reserved for working around a windows/posix incompatibility). It is
293** used in the journal to signify that the remainder of the journal file
294** is devoted to storing a master journal name - there are no more pages to
295** roll back. See comments for function writeMasterJournal() for details.
296*/
danielk1977599fcba2004-11-08 07:13:13 +0000297/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
298#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000299
drh968af522003-02-11 14:55:40 +0000300/*
danielk197726836652005-01-17 01:33:13 +0000301** The maximum legal page number is (2^31 - 1).
302*/
303#define PAGER_MAX_PGNO 2147483647
304
305/*
danielk1977f35843b2007-04-07 15:03:17 +0000306** Return true if page *pPg has already been written to the statement
307** journal (or statement snapshot has been created, if *pPg is part
308** of an in-memory database).
309*/
310static int pageInStatement(PgHdr *pPg){
311 Pager *pPager = pPg->pPager;
312 if( MEMDB ){
danielk19778c0a7912008-08-20 14:49:23 +0000313 return pPg->apSave[1]!=0;
danielk1977f35843b2007-04-07 15:03:17 +0000314 }else{
drhf5e7bb52008-02-18 14:47:33 +0000315 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000316 }
317}
drh8ca0c722006-05-07 17:49:38 +0000318
319/*
drh34e79ce2004-02-08 06:05:46 +0000320** Read a 32-bit integer from the given file descriptor. Store the integer
321** that is read in *pRes. Return SQLITE_OK if everything worked, or an
322** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000323**
324** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000325*/
danielk197762079062007-08-15 17:08:46 +0000326static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000327 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000328 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000329 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000330 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000331 }
drh94f33312002-08-12 12:29:56 +0000332 return rc;
333}
334
335/*
drh97b57482006-01-10 20:32:32 +0000336** Write a 32-bit integer into a string buffer in big-endian byte order.
337*/
drha3152892007-05-05 11:48:52 +0000338#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000339
340/*
drh34e79ce2004-02-08 06:05:46 +0000341** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
342** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000343*/
danielk197762079062007-08-15 17:08:46 +0000344static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000345 char ac[4];
drh97b57482006-01-10 20:32:32 +0000346 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000347 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000348}
349
drh2554f8b2003-01-22 01:26:44 +0000350/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000351** If file pFd is open, call sqlite3OsUnlock() on it.
352*/
353static int osUnlock(sqlite3_file *pFd, int eLock){
354 if( !pFd->pMethods ){
355 return SQLITE_OK;
356 }
357 return sqlite3OsUnlock(pFd, eLock);
358}
359
360/*
danielk1977c7b60172007-08-22 11:22:03 +0000361** This function determines whether or not the atomic-write optimization
362** can be used with this pager. The optimization can be used if:
363**
364** (a) the value returned by OsDeviceCharacteristics() indicates that
365** a database page may be written atomically, and
366** (b) the value returned by OsSectorSize() is less than or equal
367** to the page size.
368**
369** If the optimization cannot be used, 0 is returned. If it can be used,
370** then the value returned is the size of the journal file when it
371** contains rollback data for exactly one page.
372*/
373#ifdef SQLITE_ENABLE_ATOMIC_WRITE
374static int jrnlBufferSize(Pager *pPager){
375 int dc; /* Device characteristics */
376 int nSector; /* Sector size */
drhfacf0302008-06-17 15:12:00 +0000377 int szPage; /* Page size */
danielk1977c7b60172007-08-22 11:22:03 +0000378 sqlite3_file *fd = pPager->fd;
379
380 if( fd->pMethods ){
381 dc = sqlite3OsDeviceCharacteristics(fd);
382 nSector = sqlite3OsSectorSize(fd);
drhfacf0302008-06-17 15:12:00 +0000383 szPage = pPager->pageSize;
danielk1977c7b60172007-08-22 11:22:03 +0000384 }
385
386 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
387 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
388
drhfacf0302008-06-17 15:12:00 +0000389 if( !fd->pMethods ||
390 (dc & (SQLITE_IOCAP_ATOMIC|(szPage>>8)) && nSector<=szPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000391 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
392 }
393 return 0;
394}
395#endif
396
397/*
danielk1977aef0bf62005-12-30 16:28:01 +0000398** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000399** code. The first argument is a pointer to the pager structure, the
400** second the error-code about to be returned by a pager API function.
401** The value returned is a copy of the second argument to this function.
402**
drh4f0ee682007-03-30 20:43:40 +0000403** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000404** the error becomes persistent. Until the persisten error is cleared,
405** subsequent API calls on this Pager will immediately return the same
406** error code.
407**
408** A persistent error indicates that the contents of the pager-cache
409** cannot be trusted. This state can be cleared by completely discarding
410** the contents of the pager-cache. If a transaction was active when
411** the persistent error occured, then the rollback journal may need
412** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000413*/
danielk1977ae72d982007-10-03 08:46:44 +0000414static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000415static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000416 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000417 assert(
418 pPager->errCode==SQLITE_FULL ||
419 pPager->errCode==SQLITE_OK ||
420 (pPager->errCode & 0xff)==SQLITE_IOERR
421 );
danielk1977979f38e2007-03-27 16:19:51 +0000422 if(
drh4ac285a2006-09-15 07:28:50 +0000423 rc2==SQLITE_FULL ||
424 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000425 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000426 ){
427 pPager->errCode = rc;
danielk19778c0a7912008-08-20 14:49:23 +0000428 if( pPager->state==PAGER_UNLOCK
429 && sqlite3PcacheRefCount(pPager->pPCache)==0
430 ){
danielk1977ae72d982007-10-03 08:46:44 +0000431 /* If the pager is already unlocked, call pager_unlock() now to
432 ** clear the error state and ensure that the pager-cache is
433 ** completely empty.
434 */
435 pager_unlock(pPager);
436 }
danielk1977aef0bf62005-12-30 16:28:01 +0000437 }
438 return rc;
439}
440
drh477731b2007-06-16 03:06:27 +0000441/*
442** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
443** on the cache using a hash function. This is used for testing
444** and debugging only.
445*/
danielk19773c407372005-02-15 02:54:14 +0000446#ifdef SQLITE_CHECK_PAGES
447/*
448** Return a 32-bit hash of the page data for pPage.
449*/
drh477731b2007-06-16 03:06:27 +0000450static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000451 u32 hash = 0;
452 int i;
drh477731b2007-06-16 03:06:27 +0000453 for(i=0; i<nByte; i++){
454 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000455 }
456 return hash;
457}
drh477731b2007-06-16 03:06:27 +0000458static u32 pager_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000459 return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
460}
461static u32 pager_set_pagehash(PgHdr *pPage){
462 pPage->pageHash = pager_pagehash(pPage);
drh477731b2007-06-16 03:06:27 +0000463}
danielk19773c407372005-02-15 02:54:14 +0000464
465/*
466** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
467** is defined, and NDEBUG is not defined, an assert() statement checks
468** that the page is either dirty or still matches the calculated page-hash.
469*/
470#define CHECK_PAGE(x) checkPage(x)
471static void checkPage(PgHdr *pPg){
472 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +0000473 assert( !pPg->pageHash || pPager->errCode || MEMDB
474 || (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
danielk19773c407372005-02-15 02:54:14 +0000475}
476
477#else
drh8ffa8172007-06-18 17:25:17 +0000478#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000479#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000480#define CHECK_PAGE(x)
drh41d30272008-08-20 21:47:45 +0000481#endif /* SQLITE_CHECK_PAGES */
danielk19773c407372005-02-15 02:54:14 +0000482
drhed7c8552001-04-11 14:29:21 +0000483/*
danielk197776572402004-06-25 02:38:54 +0000484** When this is called the journal file for pager pPager must be open.
485** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000486** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000487**
danielk197765839c62007-08-30 08:08:17 +0000488** zMaster must point to a buffer of at least nMaster bytes allocated by
489** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
490** enough space to write the master journal name). If the master journal
491** name in the journal is longer than nMaster bytes (including a
492** nul-terminator), then this is handled as if no master journal name
493** were present in the journal.
494**
495** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000496** SQLITE_OK returned.
497*/
danielk197765839c62007-08-30 08:08:17 +0000498static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000499 int rc;
500 u32 len;
drheb206252004-10-01 02:00:31 +0000501 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000502 u32 cksum;
shane0b8d2762008-07-22 05:18:00 +0000503 u32 u; /* Unsigned loop counter */
danielk197776572402004-06-25 02:38:54 +0000504 unsigned char aMagic[8]; /* A buffer to hold the magic header */
505
danielk197765839c62007-08-30 08:08:17 +0000506 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000507
drh054889e2005-11-30 03:20:31 +0000508 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000509 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000510
danielk197762079062007-08-15 17:08:46 +0000511 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000512 if( rc!=SQLITE_OK ) return rc;
513
danielk197765839c62007-08-30 08:08:17 +0000514 if( len>=nMaster ){
515 return SQLITE_OK;
516 }
517
danielk197762079062007-08-15 17:08:46 +0000518 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000519 if( rc!=SQLITE_OK ) return rc;
520
danielk197762079062007-08-15 17:08:46 +0000521 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000522 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
523
danielk197765839c62007-08-30 08:08:17 +0000524 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000525 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000526 return rc;
527 }
danielk197765839c62007-08-30 08:08:17 +0000528 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000529
530 /* See if the checksum matches the master journal name */
shane0b8d2762008-07-22 05:18:00 +0000531 for(u=0; u<len; u++){
532 cksum -= zMaster[u];
danielk197765839c62007-08-30 08:08:17 +0000533 }
danielk19778191bff2004-06-28 04:52:30 +0000534 if( cksum ){
535 /* If the checksum doesn't add up, then one or more of the disk sectors
536 ** containing the master journal filename is corrupted. This means
537 ** definitely roll back, so just return SQLITE_OK and report a (nul)
538 ** master-journal filename.
539 */
danielk197765839c62007-08-30 08:08:17 +0000540 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000541 }
danielk197776572402004-06-25 02:38:54 +0000542
543 return SQLITE_OK;
544}
545
546/*
547** Seek the journal file descriptor to the next sector boundary where a
548** journal header may be read or written. Pager.journalOff is updated with
549** the new seek offset.
550**
551** i.e for a sector size of 512:
552**
553** Input Offset Output Offset
554** ---------------------------------------
555** 0 0
556** 512 512
557** 100 512
558** 2000 2048
559**
560*/
danielk197762079062007-08-15 17:08:46 +0000561static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000562 i64 offset = 0;
563 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000564 if( c ){
565 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
566 }
567 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
568 assert( offset>=c );
569 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
570 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000571}
572
573/*
drhf3a87622008-04-17 14:16:42 +0000574** Write zeros over the header of the journal file. This has the
575** effect of invalidating the journal file and committing the
576** transaction.
577*/
danielk1977df2566a2008-05-07 19:11:03 +0000578static int zeroJournalHdr(Pager *pPager, int doTruncate){
579 int rc = SQLITE_OK;
danielk197755a25a12008-09-11 10:29:15 +0000580 static const char zeroHdr[28] = {0};
drhf3a87622008-04-17 14:16:42 +0000581
danielk1977df2566a2008-05-07 19:11:03 +0000582 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000583 i64 iLimit = pPager->journalSizeLimit;
584
danielk1977df2566a2008-05-07 19:11:03 +0000585 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000586 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000587 rc = sqlite3OsTruncate(pPager->jfd, 0);
588 }else{
589 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
590 }
danielk197781620542008-06-07 05:19:37 +0000591 if( rc==SQLITE_OK && !pPager->noSync ){
danielk1977df2566a2008-05-07 19:11:03 +0000592 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
593 }
danielk1977b53e4962008-06-04 06:45:59 +0000594
595 /* At this point the transaction is committed but the write lock
596 ** is still held on the file. If there is a size limit configured for
597 ** the persistent journal and the journal file currently consumes more
598 ** space than that limit allows for, truncate it now. There is no need
599 ** to sync the file following this operation.
600 */
601 if( rc==SQLITE_OK && iLimit>0 ){
602 i64 sz;
603 rc = sqlite3OsFileSize(pPager->jfd, &sz);
604 if( rc==SQLITE_OK && sz>iLimit ){
605 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
606 }
607 }
drha06ecba2008-04-22 17:15:17 +0000608 }
drhf3a87622008-04-17 14:16:42 +0000609 return rc;
610}
611
612/*
danielk197776572402004-06-25 02:38:54 +0000613** The journal file must be open when this routine is called. A journal
614** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
615** current location.
616**
617** The format for the journal header is as follows:
618** - 8 bytes: Magic identifying journal format.
619** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
620** - 4 bytes: Random number used for page hash.
621** - 4 bytes: Initial database page count.
622** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000623** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000624**
danielk197767c007b2008-03-20 04:45:49 +0000625** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000626*/
627static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000628 int rc = SQLITE_OK;
629 char *zHeader = pPager->pTmpSpace;
630 int nHeader = pPager->pageSize;
631 int nWrite;
632
633 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
634 nHeader = JOURNAL_HDR_SZ(pPager);
635 }
danielk197776572402004-06-25 02:38:54 +0000636
danielk19774099f6e2007-03-19 11:25:20 +0000637 if( pPager->stmtHdrOff==0 ){
638 pPager->stmtHdrOff = pPager->journalOff;
639 }
640
danielk197762079062007-08-15 17:08:46 +0000641 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000642 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000643
drh97b57482006-01-10 20:32:32 +0000644 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +0000645
646 /*
647 ** Write the nRec Field - the number of page records that follow this
648 ** journal header. Normally, zero is written to this value at this time.
649 ** After the records are added to the journal (and the journal synced,
650 ** if in full-sync mode), the zero is overwritten with the true number
651 ** of records (see syncJournal()).
652 **
653 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
654 ** reading the journal this value tells SQLite to assume that the
655 ** rest of the journal file contains valid page records. This assumption
656 ** is dangerous, as if a failure occured whilst writing to the journal
657 ** file it may contain some garbage data. There are two scenarios
658 ** where this risk can be ignored:
659 **
660 ** * When the pager is in no-sync mode. Corruption can follow a
661 ** power failure in this case anyway.
662 **
663 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
664 ** that garbage data is never appended to the journal file.
665 */
666 assert(pPager->fd->pMethods||pPager->noSync);
667 if( (pPager->noSync)
668 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
669 ){
670 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
671 }else{
672 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
673 }
674
drh97b57482006-01-10 20:32:32 +0000675 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +0000676 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +0000677 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
678 /* The initial database size */
679 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
680 /* The assumed sector size for this process */
681 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +0000682 if( pPager->journalHdr==0 ){
683 /* The page size */
684 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
685 }
danielk197776572402004-06-25 02:38:54 +0000686
danielk1977a664f8e2008-04-22 14:31:48 +0000687 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
688 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
689 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
690 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +0000691 }
danielk1977a664f8e2008-04-22 14:31:48 +0000692
danielk197776572402004-06-25 02:38:54 +0000693 return rc;
694}
695
696/*
697** The journal file must be open when this is called. A journal header file
698** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
699** file. See comments above function writeJournalHdr() for a description of
700** the journal header format.
701**
702** If the header is read successfully, *nRec is set to the number of
703** page records following this header and *dbSize is set to the size of the
704** database before the transaction began, in pages. Also, pPager->cksumInit
705** is set to the value read from the journal header. SQLITE_OK is returned
706** in this case.
707**
708** If the journal header file appears to be corrupted, SQLITE_DONE is
709** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
710** cannot be read from the journal file an error code is returned.
711*/
712static int readJournalHdr(
713 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000714 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000715 u32 *pNRec,
716 u32 *pDbSize
717){
718 int rc;
719 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000720 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +0000721 int iPageSize;
danielk197776572402004-06-25 02:38:54 +0000722
danielk197762079062007-08-15 17:08:46 +0000723 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000724 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
725 return SQLITE_DONE;
726 }
danielk197762079062007-08-15 17:08:46 +0000727 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000728
danielk197762079062007-08-15 17:08:46 +0000729 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000730 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000731 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000732
733 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
734 return SQLITE_DONE;
735 }
736
danielk197762079062007-08-15 17:08:46 +0000737 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000738 if( rc ) return rc;
739
danielk197762079062007-08-15 17:08:46 +0000740 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000741 if( rc ) return rc;
742
danielk197762079062007-08-15 17:08:46 +0000743 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000744 if( rc ) return rc;
745
danielk197767c007b2008-03-20 04:45:49 +0000746 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
747 if( rc==SQLITE_OK
748 && iPageSize>=512
749 && iPageSize<=SQLITE_MAX_PAGE_SIZE
750 && ((iPageSize-1)&iPageSize)==0
751 ){
752 u16 pagesize = iPageSize;
753 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
754 }
755 if( rc ) return rc;
756
danielk197776572402004-06-25 02:38:54 +0000757 /* Update the assumed sector-size to match the value used by
758 ** the process that created this journal. If this journal was
759 ** created by a process other than this one, then this routine
760 ** is being called from within pager_playback(). The local value
761 ** of Pager.sectorSize is restored at the end of that routine.
762 */
danielk197762079062007-08-15 17:08:46 +0000763 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000764 if( rc ) return rc;
765
766 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +0000767 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000768}
769
770
771/*
772** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000773** pPager at the current location. The master journal name must be the last
774** thing written to a journal file. If the pager is in full-sync mode, the
775** journal file descriptor is advanced to the next sector boundary before
776** anything is written. The format is:
777**
778** + 4 bytes: PAGER_MJ_PGNO.
779** + N bytes: length of master journal name.
780** + 4 bytes: N
781** + 4 bytes: Master journal name checksum.
782** + 8 bytes: aJournalMagic[].
783**
784** The master journal page checksum is the sum of the bytes in the master
785** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000786**
787** If zMaster is a NULL pointer (occurs for a single database transaction),
788** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000789*/
790static int writeMasterJournal(Pager *pPager, const char *zMaster){
791 int rc;
792 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000793 int i;
danielk197762079062007-08-15 17:08:46 +0000794 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +0000795 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +0000796 u32 cksum = 0;
797 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000798
799 if( !zMaster || pPager->setMaster) return SQLITE_OK;
800 pPager->setMaster = 1;
801
802 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000803 for(i=0; i<len; i++){
804 cksum += zMaster[i];
805 }
danielk197776572402004-06-25 02:38:54 +0000806
807 /* If in full-sync mode, advance to the next disk sector before writing
808 ** the master journal name. This is in case the previous page written to
809 ** the journal has already been synced.
810 */
811 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000812 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000813 }
danielk197762079062007-08-15 17:08:46 +0000814 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000815 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000816
danielk197762079062007-08-15 17:08:46 +0000817 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000818 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000819 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000820
danielk197762079062007-08-15 17:08:46 +0000821 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000822 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000823 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000824
drh97b57482006-01-10 20:32:32 +0000825 put32bits(zBuf, len);
826 put32bits(&zBuf[4], cksum);
827 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000828 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +0000829 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +0000830 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +0000831
832 /* If the pager is in peristent-journal mode, then the physical
833 ** journal-file may extend past the end of the master-journal name
834 ** and 8 bytes of magic data just written to the file. This is
835 ** dangerous because the code to rollback a hot-journal file
836 ** will not be able to find the master-journal name to determine
837 ** whether or not the journal is hot.
838 **
839 ** Easiest thing to do in this scenario is to truncate the journal
840 ** file to the required size.
841 */
842 if( (rc==SQLITE_OK)
843 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
844 && jrnlSize>jrnlOff
845 ){
846 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
847 }
danielk197776572402004-06-25 02:38:54 +0000848 return rc;
849}
850
851/*
drhed7c8552001-04-11 14:29:21 +0000852** Find a page in the hash table given its page number. Return
853** a pointer to the page or NULL if not found.
854*/
drhd9b02572001-04-15 00:37:09 +0000855static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000856 PgHdr *p;
danielk19778c0a7912008-08-20 14:49:23 +0000857 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &p);
drhed7c8552001-04-11 14:29:21 +0000858 return p;
859}
860
861/*
danielk1977e180dd92007-04-05 17:15:52 +0000862** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000863** sets the state of the pager back to what it was when it was first
864** opened. Any outstanding pages are invalidated and subsequent attempts
865** to access those pages will likely result in a coredump.
866*/
drhd9b02572001-04-15 00:37:09 +0000867static void pager_reset(Pager *pPager){
danielk1977efaaf572006-01-16 11:29:19 +0000868 if( pPager->errCode ) return;
danielk19778c0a7912008-08-20 14:49:23 +0000869 sqlite3PcacheClear(pPager->pPCache);
danielk1977e277be02007-03-23 18:12:06 +0000870}
871
872/*
danielk1977ae72d982007-10-03 08:46:44 +0000873** Unlock the database file.
874**
875** If the pager is currently in error state, discard the contents of
876** the cache and reset the Pager structure internal state. If there is
877** an open journal-file, then the next time a shared-lock is obtained
878** on the pager file (by this or any other process), it will be
879** treated as a hot-journal and rolled back.
880*/
881static void pager_unlock(Pager *pPager){
882 if( !pPager->exclusiveMode ){
883 if( !MEMDB ){
drh1aa5af12008-03-07 19:51:14 +0000884 int rc = osUnlock(pPager->fd, NO_LOCK);
drh308aa322008-03-07 20:14:38 +0000885 if( rc ) pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000886 pPager->dbSize = -1;
887 IOTRACE(("UNLOCK %p\n", pPager))
888
drh16e45a42008-04-19 20:34:18 +0000889 /* Always close the journal file when dropping the database lock.
890 ** Otherwise, another connection with journal_mode=delete might
891 ** delete the file out from under us.
892 */
893 if( pPager->journalOpen ){
894 sqlite3OsClose(pPager->jfd);
895 pPager->journalOpen = 0;
896 sqlite3BitvecDestroy(pPager->pInJournal);
897 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +0000898 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
899 pPager->pAlwaysRollback = 0;
drh16e45a42008-04-19 20:34:18 +0000900 }
901
danielk1977ae72d982007-10-03 08:46:44 +0000902 /* If Pager.errCode is set, the contents of the pager cache cannot be
903 ** trusted. Now that the pager file is unlocked, the contents of the
904 ** cache can be discarded and the error code safely cleared.
905 */
906 if( pPager->errCode ){
drh1aa5af12008-03-07 19:51:14 +0000907 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +0000908 pager_reset(pPager);
909 if( pPager->stmtOpen ){
910 sqlite3OsClose(pPager->stfd);
drhf5e7bb52008-02-18 14:47:33 +0000911 sqlite3BitvecDestroy(pPager->pInStmt);
912 pPager->pInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000913 }
danielk1977ae72d982007-10-03 08:46:44 +0000914 pPager->stmtOpen = 0;
915 pPager->stmtInUse = 0;
916 pPager->journalOff = 0;
917 pPager->journalStarted = 0;
918 pPager->stmtAutoopen = 0;
919 pPager->origDbSize = 0;
920 }
921 }
922
923 if( !MEMDB || pPager->errCode==SQLITE_OK ){
924 pPager->state = PAGER_UNLOCK;
925 pPager->changeCountDone = 0;
926 }
927 }
928}
929
930/*
931** Execute a rollback if a transaction is active and unlock the
932** database file. If the pager has already entered the error state,
933** do not attempt the rollback.
934*/
935static void pagerUnlockAndRollback(Pager *p){
danielk1977ae72d982007-10-03 08:46:44 +0000936 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
danielk19772d1d86f2008-06-20 14:59:51 +0000937 sqlite3BeginBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000938 sqlite3PagerRollback(p);
danielk19772d1d86f2008-06-20 14:59:51 +0000939 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000940 }
941 pager_unlock(p);
danielk1977ae72d982007-10-03 08:46:44 +0000942}
943
944/*
drh80e35f42007-03-30 14:06:34 +0000945** This routine ends a transaction. A transaction is ended by either
946** a COMMIT or a ROLLBACK.
947**
drhed7c8552001-04-11 14:29:21 +0000948** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +0000949** a RESERVED or EXCLUSIVE lock on the database. This routine will release
950** the database lock and acquires a SHARED lock in its place if that is
951** the appropriate thing to do. Release locks usually is appropriate,
952** unless we are in exclusive access mode or unless this is a
953** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
954**
955** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +0000956**
957** TODO: Consider keeping the journal file open for temporary databases.
958** This might give a performance improvement on windows where opening
959** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000960*/
danielk1977df2566a2008-05-07 19:11:03 +0000961static int pager_end_transaction(Pager *pPager, int hasMaster){
danielk197741483462007-03-24 16:45:04 +0000962 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +0000963 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +0000964 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000965 if( pPager->state<PAGER_RESERVED ){
966 return SQLITE_OK;
967 }
danielk19773b8a05f2007-03-19 17:44:26 +0000968 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +0000969 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +0000970 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +0000971 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000972 }
drhda47d772002-12-02 04:25:19 +0000973 if( pPager->journalOpen ){
drh04335882008-09-26 21:08:08 +0000974 if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE
975 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){
976 pPager->journalOff = 0;
977 pPager->journalStarted = 0;
978 }else if( pPager->exclusiveMode
danielk197793f7af92008-05-09 16:57:50 +0000979 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
980 ){
981 rc = zeroJournalHdr(pPager, hasMaster);
982 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +0000983 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +0000984 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +0000985 }else{
drh04335882008-09-26 21:08:08 +0000986 assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE || rc );
danielk1977b4b47412007-08-17 15:53:36 +0000987 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +0000988 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +0000989 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +0000990 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +0000991 }
danielk197741483462007-03-24 16:45:04 +0000992 }
drhf5e7bb52008-02-18 14:47:33 +0000993 sqlite3BitvecDestroy(pPager->pInJournal);
994 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +0000995 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
996 pPager->pAlwaysRollback = 0;
danielk19778c0a7912008-08-20 14:49:23 +0000997 sqlite3PcacheCleanAll(pPager->pPCache);
danielk19773c407372005-02-15 02:54:14 +0000998#ifdef SQLITE_CHECK_PAGES
danielk19778c0a7912008-08-20 14:49:23 +0000999 sqlite3PcacheIterate(pPager->pPCache, pager_set_pagehash);
danielk19773c407372005-02-15 02:54:14 +00001000#endif
drhb3df2e12008-09-17 20:06:26 +00001001 sqlite3PcacheClearFlags(pPager->pPCache,
1002 PGHDR_IN_JOURNAL | PGHDR_NEED_SYNC
danielk19778c0a7912008-08-20 14:49:23 +00001003 );
danielk1977ef317ab2004-06-23 10:43:10 +00001004 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001005 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001006 }else{
drhf5e7bb52008-02-18 14:47:33 +00001007 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001008 }
danielk1977979f38e2007-03-27 16:19:51 +00001009
danielk197741483462007-03-24 16:45:04 +00001010 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001011 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001012 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001013 }else if( pPager->state==PAGER_SYNCED ){
1014 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001015 }
danielk1977334cdb62007-03-26 08:05:12 +00001016 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001017 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001018 pPager->needSync = 0;
danielk19778c0a7912008-08-20 14:49:23 +00001019 /* lruListSetFirstSynced(pPager); */
drh588f5bc2007-01-02 18:41:54 +00001020 pPager->dbSize = -1;
drhd138c012008-05-13 00:58:18 +00001021 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001022
1023 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001024}
1025
drhed7c8552001-04-11 14:29:21 +00001026/*
drh968af522003-02-11 14:55:40 +00001027** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001028**
1029** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001030** random initial value and the page number. We experimented with
1031** a checksum of the entire data, but that was found to be too slow.
1032**
1033** Note that the page number is stored at the beginning of data and
1034** the checksum is stored at the end. This is important. If journal
1035** corruption occurs due to a power failure, the most likely scenario
1036** is that one end or the other of the record will be changed. It is
1037** much less likely that the two ends of the journal record will be
1038** correct and the middle be corrupt. Thus, this "checksum" scheme,
1039** though fast and simple, catches the mostly likely kind of corruption.
1040**
1041** FIX ME: Consider adding every 200th (or so) byte of the data to the
1042** checksum. That way if a single page spans 3 or more disk sectors and
1043** only the middle sector is corrupt, we will still have a reasonable
1044** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001045*/
drh74161702006-02-24 02:53:49 +00001046static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001047 u32 cksum = pPager->cksumInit;
1048 int i = pPager->pageSize-200;
1049 while( i>0 ){
1050 cksum += aData[i];
1051 i -= 200;
1052 }
drh968af522003-02-11 14:55:40 +00001053 return cksum;
1054}
1055
drh605ad8f2006-05-03 23:34:05 +00001056/* Forward declaration */
1057static void makeClean(PgHdr*);
1058
drh968af522003-02-11 14:55:40 +00001059/*
drhfa86c412002-02-02 15:01:15 +00001060** Read a single page from the journal file opened on file descriptor
1061** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001062**
drhc13148f2008-08-27 18:03:20 +00001063** The isMainJrnl flag is true if this is the main rollback journal and
1064** false for the statement journal. The main rollback journal uses
1065** checksums - the statement journal does not.
drhfa86c412002-02-02 15:01:15 +00001066*/
danielk197762079062007-08-15 17:08:46 +00001067static int pager_playback_one_page(
drhc13148f2008-08-27 18:03:20 +00001068 Pager *pPager, /* The pager being played back */
1069 sqlite3_file *jfd, /* The file that is the journal being rolled back */
1070 i64 offset, /* Offset of the page within the journal */
1071 int isMainJrnl /* True for main rollback journal. False for Stmt jrnl */
danielk197762079062007-08-15 17:08:46 +00001072){
drhfa86c412002-02-02 15:01:15 +00001073 int rc;
drhae2b40c2004-06-09 19:03:54 +00001074 PgHdr *pPg; /* An existing page in the cache */
1075 Pgno pgno; /* The page number of a page in journal */
1076 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001077 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001078
drhc13148f2008-08-27 18:03:20 +00001079 /* isMainJrnl should be true for the main journal and false for
drh96362842005-03-20 22:47:56 +00001080 ** statement journals. Verify that this is always the case
1081 */
drhc13148f2008-08-27 18:03:20 +00001082 assert( jfd == (isMainJrnl ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001083 assert( aData );
drh96362842005-03-20 22:47:56 +00001084
danielk197762079062007-08-15 17:08:46 +00001085 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001086 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001087 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001088 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001089 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001090
drh968af522003-02-11 14:55:40 +00001091 /* Sanity checking on the page. This is more important that I originally
1092 ** thought. If a power failure occurs while the journal is being written,
1093 ** it could cause invalid data to be written into the journal. We need to
1094 ** detect this invalid data (with high probability) and ignore it.
1095 */
danielk197775edc162004-06-26 01:48:18 +00001096 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001097 return SQLITE_DONE;
1098 }
drhae2b40c2004-06-09 19:03:54 +00001099 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001100 return SQLITE_OK;
1101 }
drhc13148f2008-08-27 18:03:20 +00001102 if( isMainJrnl ){
danielk197762079062007-08-15 17:08:46 +00001103 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001104 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001105 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001106 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001107 return SQLITE_DONE;
1108 }
1109 }
drhfa86c412002-02-02 15:01:15 +00001110
danielk1977aa5ccdf2004-06-14 05:10:42 +00001111 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001112
1113 /* If the pager is in RESERVED state, then there must be a copy of this
1114 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001115 ** not the database file. The page is left marked dirty in this case.
1116 **
danielk19772df71c72007-05-24 07:22:42 +00001117 ** An exception to the above rule: If the database is in no-sync mode
1118 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001119 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1120 ** during a Movepage() call, then the page may not be in the cache
1121 ** either. So the condition described in the above paragraph is not
1122 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001123 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001124 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1125 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001126 **
1127 ** Ticket #1171: The statement journal might contain page content that is
1128 ** different from the page content at the start of the transaction.
1129 ** This occurs when a page is changed prior to the start of a statement
1130 ** then changed again within the statement. When rolling back such a
1131 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001132 ** for certain that original page contents are synced into the main rollback
1133 ** journal. Otherwise, a power loss might leave modified data in the
1134 ** database file without an entry in the rollback journal that can
1135 ** restore the database to its original form. Two conditions must be
1136 ** met before writing to the database files. (1) the database must be
1137 ** locked. (2) we know that the original page content is fully synced
1138 ** in the main journal either because the page is not in cache or else
1139 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001140 **
1141 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1142 ** is possible to fail a statement on a database that does not yet exist.
1143 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001144 */
drhae2b40c2004-06-09 19:03:54 +00001145 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001146 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1147 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
danielk19778c0a7912008-08-20 14:49:23 +00001148 if( (pPager->state>=PAGER_EXCLUSIVE)
1149 && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC))
1150 && (pPager->fd->pMethods)
1151 ){
drh281b21d2008-08-22 12:57:08 +00001152 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
1153 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst);
danielk1977a3f3a5f2004-06-10 04:32:16 +00001154 }
drhfa86c412002-02-02 15:01:15 +00001155 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001156 /* No page should ever be explicitly rolled back that is in use, except
1157 ** for page 1 which is held in use in order to keep the lock on the
1158 ** database active. However such a page may be rolled back as a result
1159 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001160 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001161 */
drhb6f41482004-05-14 01:58:11 +00001162 void *pData;
danielk19778c0a7912008-08-20 14:49:23 +00001163 pData = pPg->pData;
drhae2b40c2004-06-09 19:03:54 +00001164 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001165 if( pPager->xReiniter ){
danielk1977eaa06f62008-09-18 17:34:44 +00001166 pPager->xReiniter(pPg);
drhde647132004-05-07 17:57:49 +00001167 }
drhc13148f2008-08-27 18:03:20 +00001168 if( isMainJrnl ) makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00001169#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001170 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001171#endif
drh86a88112007-04-16 15:02:19 +00001172 /* If this was page 1, then restore the value of Pager.dbFileVers.
1173 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001174 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001175 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001176 }
drh86a88112007-04-16 15:02:19 +00001177
1178 /* Decode the page just read from disk */
1179 CODEC1(pPager, pData, pPg->pgno, 3);
danielk19778c0a7912008-08-20 14:49:23 +00001180 sqlite3PcacheRelease(pPg);
drhfa86c412002-02-02 15:01:15 +00001181 }
1182 return rc;
1183}
1184
1185/*
danielk197713adf8a2004-06-03 16:08:41 +00001186** Parameter zMaster is the name of a master journal file. A single journal
1187** file that referred to the master journal file has just been rolled back.
1188** This routine checks if it is possible to delete the master journal file,
1189** and does so if it is.
drh726de592004-06-10 23:35:50 +00001190**
danielk197765839c62007-08-30 08:08:17 +00001191** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1192** available for use within this function.
1193**
1194**
drh726de592004-06-10 23:35:50 +00001195** The master journal file contains the names of all child journals.
1196** To tell if a master journal can be deleted, check to each of the
1197** children. If all children are either missing or do not refer to
1198** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001199*/
danielk1977b4b47412007-08-17 15:53:36 +00001200static int pager_delmaster(Pager *pPager, const char *zMaster){
1201 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001202 int rc;
1203 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001204 sqlite3_file *pMaster;
1205 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001206 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001207 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001208
1209 /* Open the master journal file exclusively in case some other process
1210 ** is running this routine also. Not that it makes too much difference.
1211 */
drhe5ae5732008-06-15 02:51:47 +00001212 pMaster = (sqlite3_file *)sqlite3Malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001213 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001214 if( !pMaster ){
1215 rc = SQLITE_NOMEM;
1216 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001217 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1218 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001219 }
danielk197713adf8a2004-06-03 16:08:41 +00001220 if( rc!=SQLITE_OK ) goto delmaster_out;
1221 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001222
1223 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001224 if( rc!=SQLITE_OK ) goto delmaster_out;
1225
1226 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001227 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001228 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001229 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001230
1231 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001232 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001233 */
drhe5ae5732008-06-15 02:51:47 +00001234 zMasterJournal = (char *)sqlite3Malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001235 if( !zMasterJournal ){
1236 rc = SQLITE_NOMEM;
1237 goto delmaster_out;
1238 }
danielk197765839c62007-08-30 08:08:17 +00001239 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001240 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001241 if( rc!=SQLITE_OK ) goto delmaster_out;
1242
danielk19775865e3d2004-06-14 06:03:57 +00001243 zJournal = zMasterJournal;
1244 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977861f7452008-06-05 11:39:11 +00001245 int exists;
1246 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
1247 if( rc!=SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001248 goto delmaster_out;
1249 }
danielk1977861f7452008-06-05 11:39:11 +00001250 if( exists ){
danielk197713adf8a2004-06-03 16:08:41 +00001251 /* One of the journals pointed to by the master journal exists.
1252 ** Open it and check if it points at the master journal. If
1253 ** so, return without deleting the master journal file.
1254 */
drh3b7b78b2004-11-24 01:16:43 +00001255 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001256 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1257 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001258 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001259 goto delmaster_out;
1260 }
danielk197713adf8a2004-06-03 16:08:41 +00001261
danielk197765839c62007-08-30 08:08:17 +00001262 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001263 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001264 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001265 goto delmaster_out;
1266 }
danielk197776572402004-06-25 02:38:54 +00001267
danielk197765839c62007-08-30 08:08:17 +00001268 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001269 if( c ){
danielk197776572402004-06-25 02:38:54 +00001270 /* We have a match. Do not delete the master journal file. */
1271 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001272 }
1273 }
danielk19775865e3d2004-06-14 06:03:57 +00001274 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001275 }
1276 }
1277
danielk1977fee2d252007-08-18 10:59:19 +00001278 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001279
1280delmaster_out:
1281 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001282 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001283 }
1284 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001285 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001286 }
danielk1977b4b47412007-08-17 15:53:36 +00001287 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001288 return rc;
1289}
1290
drha6abd042004-06-09 17:37:22 +00001291
danielk1977e180dd92007-04-05 17:15:52 +00001292static void pager_truncate_cache(Pager *pPager);
1293
drha6abd042004-06-09 17:37:22 +00001294/*
drhcb4c40b2004-08-18 19:09:43 +00001295** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001296** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001297**
1298** Might might be the case that the file on disk is smaller than nPage.
1299** This can happen, for example, if we are in the middle of a transaction
1300** which has extended the file size and the new pages are still all held
1301** in cache, then an INSERT or UPDATE does a statement rollback. Some
1302** operating system implementations can get confused if you try to
1303** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001304** so detect this case and write a single zero byte to the end of the new
1305** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001306*/
1307static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001308 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001309 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001310 i64 currentSize, newSize;
1311 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1312 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001313 if( rc==SQLITE_OK && currentSize!=newSize ){
1314 if( currentSize>newSize ){
1315 rc = sqlite3OsTruncate(pPager->fd, newSize);
1316 }else{
1317 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1318 }
drh7fe3f7e2007-11-29 18:44:27 +00001319 }
danielk1977e180dd92007-04-05 17:15:52 +00001320 }
1321 if( rc==SQLITE_OK ){
1322 pPager->dbSize = nPage;
1323 pager_truncate_cache(pPager);
1324 }
1325 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001326}
1327
1328/*
drhc80f0582007-05-01 16:59:48 +00001329** Set the sectorSize for the given pager.
1330**
drh334c80d2008-03-28 17:41:13 +00001331** The sector size is at least as big as the sector size reported
1332** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001333*/
1334static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001335 assert(pPager->fd->pMethods||pPager->tempFile);
1336 if( !pPager->tempFile ){
1337 /* Sector size doesn't matter for temporary files. Also, the file
1338 ** may not have been opened yet, in whcih case the OsSectorSize()
1339 ** call will segfault.
1340 */
1341 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1342 }
drh334c80d2008-03-28 17:41:13 +00001343 if( pPager->sectorSize<512 ){
1344 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001345 }
1346}
1347
1348/*
drhed7c8552001-04-11 14:29:21 +00001349** Playback the journal and thus restore the database file to
1350** the state it was in before we started making changes.
1351**
drh34e79ce2004-02-08 06:05:46 +00001352** The journal file format is as follows:
1353**
drhae2b40c2004-06-09 19:03:54 +00001354** (1) 8 byte prefix. A copy of aJournalMagic[].
1355** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001356** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001357** number of page records from the journal size.
1358** (3) 4 byte big-endian integer which is the initial value for the
1359** sanity checksum.
1360** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001361** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001362** (5) 4 byte big-endian integer which is the sector size. The header
1363** is this many bytes in size.
1364** (6) 4 byte big-endian integer which is the page case.
1365** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001366** name. The value may be zero (indicate that there is no master
1367** journal.)
drh334c80d2008-03-28 17:41:13 +00001368** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001369** and might be shorter than the value read from (5). If the first byte
1370** of the name is \000 then there is no master journal. The master
1371** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001372** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001373** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001374** + pPager->pageSize bytes of data.
1375** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001376**
drh334c80d2008-03-28 17:41:13 +00001377** When we speak of the journal header, we mean the first 8 items above.
1378** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001379**
1380** Call the value from the second bullet "nRec". nRec is the number of
1381** valid page entries in the journal. In most cases, you can compute the
1382** value of nRec from the size of the journal file. But if a power
1383** failure occurred while the journal was being written, it could be the
1384** case that the size of the journal file had already been increased but
1385** the extra entries had not yet made it safely to disk. In such a case,
1386** the value of nRec computed from the file size would be too large. For
1387** that reason, we always use the nRec value in the header.
1388**
1389** If the nRec value is 0xffffffff it means that nRec should be computed
1390** from the file size. This value is used when the user selects the
1391** no-sync option for the journal. A power failure could lead to corruption
1392** in this case. But for things like temporary table (which will be
1393** deleted when the power is restored) we don't care.
1394**
drhd9b02572001-04-15 00:37:09 +00001395** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001396** journal file then all pages up to the first corrupted page are rolled
1397** back (or no pages if the journal header is corrupted). The journal file
1398** is then deleted and SQLITE_OK returned, just as if no corruption had
1399** been encountered.
1400**
1401** If an I/O or malloc() error occurs, the journal-file is not deleted
1402** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001403*/
danielk1977e277be02007-03-23 18:12:06 +00001404static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001405 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001406 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001407 u32 nRec; /* Number of Records in the journal */
shane0b8d2762008-07-22 05:18:00 +00001408 u32 u; /* Unsigned loop counter */
drhd9b02572001-04-15 00:37:09 +00001409 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001410 int rc; /* Result code of a subroutine */
danielk1977861f7452008-06-05 11:39:11 +00001411 int res = 1; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001412 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001413
drhc3a64ba2001-11-22 00:01:27 +00001414 /* Figure out how many records are in the journal. Abort early if
1415 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001416 */
drh8cfbf082001-09-19 13:22:39 +00001417 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001418 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001419 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001420 goto end_playback;
1421 }
drh240c5792004-02-08 00:40:52 +00001422
danielk197776572402004-06-25 02:38:54 +00001423 /* Read the master journal name from the journal, if it is present.
1424 ** If a master journal file name is specified, but the file is not
1425 ** present on disk, then the journal is not hot and does not need to be
1426 ** played back.
drh240c5792004-02-08 00:40:52 +00001427 */
danielk197765839c62007-08-30 08:08:17 +00001428 zMaster = pPager->pTmpSpace;
1429 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977861f7452008-06-05 11:39:11 +00001430 if( rc==SQLITE_OK && zMaster[0] ){
1431 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
drhc3a64ba2001-11-22 00:01:27 +00001432 }
danielk197765839c62007-08-30 08:08:17 +00001433 zMaster = 0;
danielk1977861f7452008-06-05 11:39:11 +00001434 if( rc!=SQLITE_OK || !res ){
danielk1977ce98bba2008-04-03 10:13:01 +00001435 goto end_playback;
1436 }
1437 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001438
danielk197776572402004-06-25 02:38:54 +00001439 /* This loop terminates either when the readJournalHdr() call returns
1440 ** SQLITE_DONE or an IO error occurs. */
1441 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001442
danielk197776572402004-06-25 02:38:54 +00001443 /* Read the next journal header from the journal file. If there are
1444 ** not enough bytes left in the journal file for a complete header, or
1445 ** it is corrupted, then a process must of failed while writing it.
1446 ** This indicates nothing more needs to be rolled back.
1447 */
1448 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1449 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001450 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001451 rc = SQLITE_OK;
1452 }
danielk197776572402004-06-25 02:38:54 +00001453 goto end_playback;
1454 }
1455
1456 /* If nRec is 0xffffffff, then this journal was created by a process
1457 ** working in no-sync mode. This means that the rest of the journal
1458 ** file consists of pages, there are no more journal headers. Compute
1459 ** the value of nRec based on this assumption.
1460 */
1461 if( nRec==0xffffffff ){
1462 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1463 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1464 }
1465
danielk1977e277be02007-03-23 18:12:06 +00001466 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001467 ** process and if this is the final header in the journal, then it means
1468 ** that this part of the journal was being filled but has not yet been
1469 ** synced to disk. Compute the number of pages based on the remaining
1470 ** size of the file.
1471 **
1472 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001473 */
drh8940f4e2007-08-11 00:26:20 +00001474 if( nRec==0 && !isHot &&
1475 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001476 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1477 }
1478
danielk197776572402004-06-25 02:38:54 +00001479 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001480 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001481 */
danielk1977e180dd92007-04-05 17:15:52 +00001482 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001483 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001484 if( rc!=SQLITE_OK ){
1485 goto end_playback;
1486 }
danielk197776572402004-06-25 02:38:54 +00001487 }
1488
danielk197776572402004-06-25 02:38:54 +00001489 /* Copy original pages out of the journal and back into the database file.
1490 */
shane0b8d2762008-07-22 05:18:00 +00001491 for(u=0; u<nRec; u++){
danielk197762079062007-08-15 17:08:46 +00001492 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001493 if( rc!=SQLITE_OK ){
1494 if( rc==SQLITE_DONE ){
1495 rc = SQLITE_OK;
1496 pPager->journalOff = szJ;
1497 break;
1498 }else{
drha9625ea2008-09-03 00:08:29 +00001499 /* If we are unable to rollback, then the database is probably
1500 ** going to end up being corrupt. It is corrupt to us, anyhow.
1501 ** Perhaps the next process to come along can fix it....
1502 */
danielk197798c21902008-09-23 16:41:29 +00001503 rc = SQLITE_CORRUPT_BKPT;
danielk197776572402004-06-25 02:38:54 +00001504 goto end_playback;
1505 }
1506 }
drh968af522003-02-11 14:55:40 +00001507 }
drhed7c8552001-04-11 14:29:21 +00001508 }
drh580eeaf2006-02-24 03:09:37 +00001509 /*NOTREACHED*/
1510 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001511
1512end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001513 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001514 zMaster = pPager->pTmpSpace;
1515 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1516 }
1517 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001518 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001519 }
danielk1977c56774e2008-10-07 11:51:20 +00001520 if( rc==SQLITE_OK && zMaster[0] && res ){
danielk1977979f38e2007-03-27 16:19:51 +00001521 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001522 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001523 */
danielk197765839c62007-08-30 08:08:17 +00001524 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001525 }
danielk197776572402004-06-25 02:38:54 +00001526
1527 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001528 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001529 ** value. Reset it to the correct value for this process.
1530 */
drhc80f0582007-05-01 16:59:48 +00001531 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001532 return rc;
drhed7c8552001-04-11 14:29:21 +00001533}
1534
1535/*
drhac69b052004-05-12 13:30:07 +00001536** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001537**
1538** This is similar to playing back the transaction journal but with
1539** a few extra twists.
1540**
drh663fc632002-02-02 18:49:19 +00001541** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001542** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001543** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001544**
drhac69b052004-05-12 13:30:07 +00001545** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001546** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001547** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001548*/
drh3aac2dd2004-04-26 14:10:20 +00001549static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001550 i64 szJ; /* Size of the full journal */
1551 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001552 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001553 int i; /* Loop counter */
1554 int rc;
1555
danielk197776572402004-06-25 02:38:54 +00001556 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001557
danielk19774099f6e2007-03-19 11:25:20 +00001558 /* Set hdrOff to be the offset just after the end of the last journal
1559 ** page written before the first journal-header for this statement
1560 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001561 ** header was written.
1562 */
1563 hdrOff = pPager->stmtHdrOff;
1564 assert( pPager->fullSync || !hdrOff );
1565 if( !hdrOff ){
1566 hdrOff = szJ;
1567 }
1568
drhfa86c412002-02-02 15:01:15 +00001569 /* Truncate the database back to its original size.
1570 */
danielk1977e180dd92007-04-05 17:15:52 +00001571 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001572 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001573
drhac69b052004-05-12 13:30:07 +00001574 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001575 */
drhac69b052004-05-12 13:30:07 +00001576 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001577 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001578
drhac69b052004-05-12 13:30:07 +00001579 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001580 ** database file. Note that the statement journal omits checksums from
1581 ** each record since power-failure recovery is not important to statement
1582 ** journals.
drhfa86c412002-02-02 15:01:15 +00001583 */
danielk197762079062007-08-15 17:08:46 +00001584 for(i=0; i<nRec; i++){
1585 i64 offset = i*(4+pPager->pageSize);
1586 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001587 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001588 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001589 }
1590
danielk197776572402004-06-25 02:38:54 +00001591 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1592 ** was the size of the journal file when this statement was started, so
1593 ** everything after that needs to be rolled back, either into the
1594 ** database, the memory cache, or both.
1595 **
1596 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1597 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001598 */
danielk197776572402004-06-25 02:38:54 +00001599 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001600 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001601 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001602 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001603 assert( rc!=SQLITE_DONE );
1604 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1605 }
1606
1607 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001608 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001609 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001610 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001611 if( rc!=SQLITE_OK ){
1612 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001613 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001614 }
danielk1977f0113002006-01-24 12:09:17 +00001615 if( nJRec==0 ){
1616 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001617 }
danielk1977f0113002006-01-24 12:09:17 +00001618 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001619 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001620 assert( rc!=SQLITE_DONE );
1621 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1622 }
drhfa86c412002-02-02 15:01:15 +00001623 }
danielk197776572402004-06-25 02:38:54 +00001624
1625 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001626
drh3aac2dd2004-04-26 14:10:20 +00001627end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001628 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001629 pPager->journalOff = szJ;
1630 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001631 }
1632 return rc;
1633}
1634
1635/*
drhf57b14a2001-09-14 18:54:08 +00001636** Change the maximum number of in-memory pages that are allowed.
1637*/
danielk19773b8a05f2007-03-19 17:44:26 +00001638void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
danielk19778c0a7912008-08-20 14:49:23 +00001639 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001640}
1641
1642/*
drh973b6e32003-02-12 14:09:42 +00001643** Adjust the robustness of the database to damage due to OS crashes
1644** or power failures by changing the number of syncs()s when writing
1645** the rollback journal. There are three levels:
1646**
drh054889e2005-11-30 03:20:31 +00001647** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001648** for temporary and transient files.
1649**
1650** NORMAL The journal is synced once before writes begin on the
1651** database. This is normally adequate protection, but
1652** it is theoretically possible, though very unlikely,
1653** that an inopertune power failure could leave the journal
1654** in a state which would cause damage to the database
1655** when it is rolled back.
1656**
1657** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001658** database (with some additional information - the nRec field
1659** of the journal header - being written in between the two
1660** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001661** single disk sector is atomic, then this mode provides
1662** assurance that the journal will not be corrupted to the
1663** point of causing damage to the database during rollback.
1664**
1665** Numeric values associated with these states are OFF==1, NORMAL=2,
1666** and FULL=3.
1667*/
danielk197793758c82005-01-21 08:13:14 +00001668#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh281b21d2008-08-22 12:57:08 +00001669void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){
drhb3df2e12008-09-17 20:06:26 +00001670 pPager->noSync = level==1 || pPager->tempFile || MEMDB;
drh973b6e32003-02-12 14:09:42 +00001671 pPager->fullSync = level==3 && !pPager->tempFile;
drh281b21d2008-08-22 12:57:08 +00001672 pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001673 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001674}
danielk197793758c82005-01-21 08:13:14 +00001675#endif
drh973b6e32003-02-12 14:09:42 +00001676
1677/*
drhaf6df112005-06-07 02:12:30 +00001678** The following global variable is incremented whenever the library
1679** attempts to open a temporary file. This information is used for
1680** testing and analysis only.
1681*/
drh0f7eb612006-08-08 13:51:43 +00001682#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001683int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001684#endif
drhaf6df112005-06-07 02:12:30 +00001685
1686/*
drh3f56e6e2007-03-15 01:16:47 +00001687** Open a temporary file.
1688**
1689** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001690** other error code if we fail. The OS will automatically delete the temporary
1691** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001692*/
danielk1977b4b47412007-08-17 15:53:36 +00001693static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00001694 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00001695 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00001696 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00001697){
drhfa86c412002-02-02 15:01:15 +00001698 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001699
drh0f7eb612006-08-08 13:51:43 +00001700#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001701 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001702#endif
danielk1977b4b47412007-08-17 15:53:36 +00001703
drh33f4e022007-09-03 15:19:34 +00001704 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
1705 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00001706 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00001707 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00001708 return rc;
1709}
1710
danielk1977a858aa22008-08-22 16:22:17 +00001711static int pagerStress(void *,PgHdr *);
danielk19778c0a7912008-08-20 14:49:23 +00001712
drhfa86c412002-02-02 15:01:15 +00001713/*
drhed7c8552001-04-11 14:29:21 +00001714** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001715** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001716** the first call to sqlite3PagerGet() and is only held open until the
1717** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001718**
drh6446c4d2001-12-15 14:22:18 +00001719** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00001720** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00001721** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001722**
1723** If zFilename is ":memory:" then all information is held in cache.
1724** It is never written to disk. This can be used to implement an
1725** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001726*/
danielk19773b8a05f2007-03-19 17:44:26 +00001727int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001728 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001729 Pager **ppPager, /* Return the Pager structure here */
1730 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001731 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00001732 int flags, /* flags controlling this file */
1733 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00001734){
danielk1977b4b47412007-08-17 15:53:36 +00001735 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001736 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001737 int rc = SQLITE_OK;
1738 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001739 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001740 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001741 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001742 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1743 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00001744 int journalFileSize = sqlite3JournalSize(pVfs);
danielk19778c0a7912008-08-20 14:49:23 +00001745 int pcacheSize = sqlite3PcacheSize();
drhfacf0302008-06-17 15:12:00 +00001746 int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00001747 char *zPathname = 0;
1748 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001749
drh86f8c192007-08-22 00:39:19 +00001750 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001751 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001752
danielk197717b90b52008-06-06 11:11:25 +00001753 /* Compute and store the full pathname in an allocated buffer pointed
1754 ** to by zPathname, length nPathname. Or, if this is a temporary file,
1755 ** leave both nPathname and zPathname set to 0.
1756 */
drh1cc8c442007-08-24 16:08:29 +00001757 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00001758 nPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001759 zPathname = sqlite3Malloc(nPathname*2);
danielk197717b90b52008-06-06 11:11:25 +00001760 if( zPathname==0 ){
1761 return SQLITE_NOMEM;
1762 }
drh1cc8c442007-08-24 16:08:29 +00001763#ifndef SQLITE_OMIT_MEMORYDB
1764 if( strcmp(zFilename,":memory:")==0 ){
1765 memDb = 1;
1766 zPathname[0] = 0;
drhb3df2e12008-09-17 20:06:26 +00001767 useJournal = 0;
drh1cc8c442007-08-24 16:08:29 +00001768 }else
1769#endif
1770 {
danielk1977adfb9b02007-09-17 07:02:56 +00001771 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00001772 }
danielk197717b90b52008-06-06 11:11:25 +00001773 if( rc!=SQLITE_OK ){
1774 sqlite3_free(zPathname);
1775 return rc;
1776 }
1777 nPathname = strlen(zPathname);
drhae28c012007-08-24 16:29:23 +00001778 }
drh99b90c32008-03-17 13:50:58 +00001779
danielk1977b4b47412007-08-17 15:53:36 +00001780 /* Allocate memory for the pager structure */
1781 pPager = sqlite3MallocZero(
1782 sizeof(*pPager) + /* Pager structure */
danielk19778c0a7912008-08-20 14:49:23 +00001783 pcacheSize + /* PCache object */
danielk1977c7b60172007-08-22 11:22:03 +00001784 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00001785 pVfs->szOsFile * 3 + /* The main db and two journal files */
danielk197717b90b52008-06-06 11:11:25 +00001786 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00001787 );
1788 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00001789 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00001790 return SQLITE_NOMEM;
1791 }
danielk19778c0a7912008-08-20 14:49:23 +00001792 pPager->pPCache = (PCache *)&pPager[1];
1793 pPtr = ((u8 *)&pPager[1]) + pcacheSize;
drh33f4e022007-09-03 15:19:34 +00001794 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00001795 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00001796 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
1797 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
1798 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00001799 pPager->zDirectory = &pPager->zFilename[nPathname+1];
1800 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00001801 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00001802 if( zPathname ){
1803 memcpy(pPager->zFilename, zPathname, nPathname+1);
1804 sqlite3_free(zPathname);
1805 }
danielk1977b4b47412007-08-17 15:53:36 +00001806
drh153c62c2007-08-24 03:51:33 +00001807 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00001808 */
drhae28c012007-08-24 16:29:23 +00001809 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00001810 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
1811 rc = SQLITE_CANTOPEN;
1812 }else{
drh1cc8c442007-08-24 16:08:29 +00001813 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00001814 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
1815 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00001816 readOnly = (fout&SQLITE_OPEN_READONLY);
1817
1818 /* If the file was successfully opened for read/write access,
1819 ** choose a default page size in case we have to create the
1820 ** database file. The default page size is the maximum of:
1821 **
1822 ** + SQLITE_DEFAULT_PAGE_SIZE,
1823 ** + The value returned by sqlite3OsSectorSize()
1824 ** + The largest page size that can be written atomically.
1825 */
1826 if( rc==SQLITE_OK && !readOnly ){
1827 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
drhfacf0302008-06-17 15:12:00 +00001828 if( szPageDflt<iSectorSize ){
1829 szPageDflt = iSectorSize;
drh1cc8c442007-08-24 16:08:29 +00001830 }
danielk19779663b8f2007-08-24 11:52:28 +00001831#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00001832 {
1833 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
1834 int ii;
1835 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1836 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1837 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
drhfacf0302008-06-17 15:12:00 +00001838 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
1839 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii;
danielk19779663b8f2007-08-24 11:52:28 +00001840 }
danielk1977b4b47412007-08-17 15:53:36 +00001841 }
drh1cc8c442007-08-24 16:08:29 +00001842#endif
drhfacf0302008-06-17 15:12:00 +00001843 if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
1844 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
drh1cc8c442007-08-24 16:08:29 +00001845 }
danielk19778def5ea2004-06-16 10:39:52 +00001846 }
drhac69b052004-05-12 13:30:07 +00001847 }
drh1cc8c442007-08-24 16:08:29 +00001848 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001849 /* If a temporary file is requested, it is not opened immediately.
1850 ** In this case we accept the default page size and delay actually
1851 ** opening the file until the first call to OsWrite().
1852 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001853 tempFile = 1;
1854 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001855 }
danielk1977aef0bf62005-12-30 16:28:01 +00001856
danielk1977b4b47412007-08-17 15:53:36 +00001857 if( pPager && rc==SQLITE_OK ){
drhfacf0302008-06-17 15:12:00 +00001858 pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt);
drh3e7a6092002-12-07 21:45:14 +00001859 }
danielk1977aef0bf62005-12-30 16:28:01 +00001860
drh153c62c2007-08-24 03:51:33 +00001861 /* If an error occured in either of the blocks above.
1862 ** Free the Pager structure and close the file.
1863 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00001864 ** any Pager.errMask variables.
1865 */
danielk1977b4b47412007-08-17 15:53:36 +00001866 if( !pPager || !pPager->pTmpSpace ){
1867 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001868 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001869 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001870 }
danielk19778c0a7912008-08-20 14:49:23 +00001871 nExtra = FORCE_ALIGNMENT(nExtra);
danielk197771d5d2c2008-09-29 11:49:47 +00001872 sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
drh41d30272008-08-20 21:47:45 +00001873 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
danielk1977aef0bf62005-12-30 16:28:01 +00001874
drh153c62c2007-08-24 03:51:33 +00001875 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
1876 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00001877
danielk1977b4b47412007-08-17 15:53:36 +00001878 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00001879 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00001880 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001881 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001882
drh99b90c32008-03-17 13:50:58 +00001883 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00001884 if( zPathname ){
1885 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
1886 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
1887 }else{
1888 pPager->zJournal = 0;
1889 }
danielk1977b4b47412007-08-17 15:53:36 +00001890
drh3b59a5c2006-01-15 20:28:28 +00001891 /* pPager->journalOpen = 0; */
drhb3df2e12008-09-17 20:06:26 +00001892 pPager->useJournal = useJournal;
drh7bec5052005-02-06 02:45:41 +00001893 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001894 /* pPager->stmtOpen = 0; */
1895 /* pPager->stmtInUse = 0; */
1896 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001897 pPager->dbSize = memDb-1;
drhfacf0302008-06-17 15:12:00 +00001898 pPager->pageSize = szPageDflt;
drh3b59a5c2006-01-15 20:28:28 +00001899 /* pPager->stmtSize = 0; */
1900 /* pPager->stmtJSize = 0; */
1901 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001902 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001903 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001904 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00001905 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00001906 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001907 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001908 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1909 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1910 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1911 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001912 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001913 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001914 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001915 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001916 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00001917 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00001918 /* pPager->pFirst = 0; */
1919 /* pPager->pFirstSynced = 0; */
1920 /* pPager->pLast = 0; */
danielk19778c0a7912008-08-20 14:49:23 +00001921 pPager->nExtra = nExtra;
danielk1977b53e4962008-06-04 06:45:59 +00001922 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk19777a2b1ee2007-08-21 14:27:01 +00001923 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00001924 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00001925 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00001926 }
drh3b59a5c2006-01-15 20:28:28 +00001927 /* pPager->pBusyHandler = 0; */
1928 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001929 *ppPager = pPager;
1930 return SQLITE_OK;
1931}
1932
1933/*
drh90f5ecb2004-07-22 01:19:35 +00001934** Set the busy handler function.
1935*/
danielk19773b8a05f2007-03-19 17:44:26 +00001936void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00001937 pPager->pBusyHandler = pBusyHandler;
1938}
1939
1940/*
drha6abd042004-06-09 17:37:22 +00001941** Set the reinitializer for this pager. If not NULL, the reinitializer
1942** is called when the content of a page in cache is restored to its original
1943** value as a result of a rollback. The callback gives higher-level code
1944** an opportunity to restore the EXTRA section to agree with the restored
1945** page data.
1946*/
danielk1977eaa06f62008-09-18 17:34:44 +00001947void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*)){
drha6abd042004-06-09 17:37:22 +00001948 pPager->xReiniter = xReinit;
1949}
1950
1951/*
danielk1977a1644fd2007-08-29 12:31:25 +00001952** Set the page size to *pPageSize. If the suggest new page size is
1953** inappropriate, then an alternative page size is set to that
1954** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00001955*/
danielk1977a1644fd2007-08-29 12:31:25 +00001956int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
danielk19771357d9f2008-09-16 05:12:24 +00001957 int rc = pPager->errCode;
1958 if( rc==SQLITE_OK ){
1959 u16 pageSize = *pPageSize;
1960 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
1961 if( pageSize && pageSize!=pPager->pageSize
1962 && (pPager->memDb==0 || pPager->dbSize==0)
1963 && sqlite3PcacheRefCount(pPager->pPCache)==0
1964 ){
1965 char *pNew = (char *)sqlite3PageMalloc(pageSize);
1966 if( !pNew ){
1967 rc = SQLITE_NOMEM;
1968 }else{
1969 pager_reset(pPager);
1970 pPager->pageSize = pageSize;
1971 if( !pPager->memDb ) setSectorSize(pPager);
1972 sqlite3PageFree(pPager->pTmpSpace);
1973 pPager->pTmpSpace = pNew;
1974 sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
1975 }
danielk1977a1644fd2007-08-29 12:31:25 +00001976 }
danielk19771357d9f2008-09-16 05:12:24 +00001977 *pPageSize = pPager->pageSize;
drh1c7880e2005-05-20 20:01:55 +00001978 }
danielk1977a1644fd2007-08-29 12:31:25 +00001979 return rc;
drh90f5ecb2004-07-22 01:19:35 +00001980}
1981
1982/*
drh26b79942007-11-28 16:19:56 +00001983** Return a pointer to the "temporary page" buffer held internally
1984** by the pager. This is a buffer that is big enough to hold the
1985** entire content of a database page. This buffer is used internally
1986** during rollback and will be overwritten whenever a rollback
1987** occurs. But other modules are free to use it too, as long as
1988** no rollbacks are happening.
1989*/
1990void *sqlite3PagerTempSpace(Pager *pPager){
1991 return pPager->pTmpSpace;
1992}
1993
1994/*
drhf8e632b2007-05-08 14:51:36 +00001995** Attempt to set the maximum database page count if mxPage is positive.
1996** Make no changes if mxPage is zero or negative. And never reduce the
1997** maximum page count below the current size of the database.
1998**
1999** Regardless of mxPage, return the current maximum page count.
2000*/
2001int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2002 if( mxPage>0 ){
2003 pPager->mxPgno = mxPage;
2004 }
danielk1977ad0132d2008-06-07 08:58:22 +00002005 sqlite3PagerPagecount(pPager, 0);
drhf8e632b2007-05-08 14:51:36 +00002006 return pPager->mxPgno;
2007}
2008
2009/*
drhc9ac5ca2005-11-04 22:03:30 +00002010** The following set of routines are used to disable the simulated
2011** I/O error mechanism. These routines are used to avoid simulated
2012** errors in places where we do not care about errors.
2013**
2014** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2015** and generate no code.
2016*/
2017#ifdef SQLITE_TEST
2018extern int sqlite3_io_error_pending;
2019extern int sqlite3_io_error_hit;
2020static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002021void disable_simulated_io_errors(void){
2022 saved_cnt = sqlite3_io_error_pending;
2023 sqlite3_io_error_pending = -1;
2024}
2025void enable_simulated_io_errors(void){
2026 sqlite3_io_error_pending = saved_cnt;
2027}
2028#else
drh152410f2005-11-05 15:11:22 +00002029# define disable_simulated_io_errors()
2030# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002031#endif
2032
2033/*
drh90f5ecb2004-07-22 01:19:35 +00002034** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002035** that pDest points to.
2036**
2037** No error checking is done. The rational for this is that this function
2038** may be called even if the file does not exist or contain a header. In
2039** these cases sqlite3OsRead() will return an error, to which the correct
2040** response is to zero the memory at pDest and continue. A real IO error
2041** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002042*/
danielk19773b8a05f2007-03-19 17:44:26 +00002043int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002044 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002045 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002046 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2047 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002048 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002049 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002050 if( rc==SQLITE_IOERR_SHORT_READ ){
2051 rc = SQLITE_OK;
2052 }
drh90f5ecb2004-07-22 01:19:35 +00002053 }
drh551b7732006-11-06 21:20:25 +00002054 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002055}
2056
2057/*
drh5e00f6c2001-09-13 13:46:56 +00002058** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002059** pPager.
2060**
2061** If the PENDING_BYTE lies on the page directly after the end of the
2062** file, then consider this page part of the file too. For example, if
2063** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2064** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002065*/
danielk1977ad0132d2008-06-07 08:58:22 +00002066int sqlite3PagerPagecount(Pager *pPager, int *pnPage){
danielk19777a2b1ee2007-08-21 14:27:01 +00002067 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002068 int rc;
drhd9b02572001-04-15 00:37:09 +00002069 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002070 if( pPager->errCode ){
danielk19778c0a7912008-08-20 14:49:23 +00002071 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002072 return rc;
drha7aea3d2007-03-15 12:51:16 +00002073 }
drhed7c8552001-04-11 14:29:21 +00002074 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002075 n = pPager->dbSize;
2076 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002077 assert(pPager->fd->pMethods||pPager->tempFile);
2078 if( (pPager->fd->pMethods)
2079 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002080 pager_error(pPager, rc);
danielk1977ad0132d2008-06-07 08:58:22 +00002081 return rc;
danielk197715f411d2005-09-16 10:18:45 +00002082 }
2083 if( n>0 && n<pPager->pageSize ){
2084 n = 1;
2085 }else{
2086 n /= pPager->pageSize;
2087 }
2088 if( pPager->state!=PAGER_UNLOCK ){
2089 pPager->dbSize = n;
2090 }
drhed7c8552001-04-11 14:29:21 +00002091 }
danielk197715f411d2005-09-16 10:18:45 +00002092 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002093 n++;
2094 }
drhf8e632b2007-05-08 14:51:36 +00002095 if( n>pPager->mxPgno ){
2096 pPager->mxPgno = n;
2097 }
danielk1977ad0132d2008-06-07 08:58:22 +00002098 if( pnPage ){
2099 *pnPage = n;
2100 }
2101 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002102}
2103
2104/*
drhf7c57532003-04-25 13:22:51 +00002105** Forward declaration
2106*/
danielk197776572402004-06-25 02:38:54 +00002107static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002108
2109/*
danielk1977e180dd92007-04-05 17:15:52 +00002110** This routine is used to truncate the cache when a database
2111** is truncated. Drop from the cache all pages whose pgno is
2112** larger than pPager->dbSize and is unreferenced.
2113**
drhac69b052004-05-12 13:30:07 +00002114** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002115**
2116** Actually, at the point this routine is called, it would be
2117** an error to have a referenced page. But rather than delete
2118** that page and guarantee a subsequent segfault, it seems better
2119** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002120*/
danielk1977e180dd92007-04-05 17:15:52 +00002121static void pager_truncate_cache(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00002122 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
drhac69b052004-05-12 13:30:07 +00002123}
2124
drhf7c57532003-04-25 13:22:51 +00002125/*
danielk197717221812005-02-15 03:38:05 +00002126** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002127** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002128** false or until the lock succeeds.
2129**
2130** Return SQLITE_OK on success and an error code if we cannot obtain
2131** the lock.
2132*/
2133static int pager_wait_on_lock(Pager *pPager, int locktype){
2134 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002135
2136 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002137 assert( PAGER_SHARED==SHARED_LOCK );
2138 assert( PAGER_RESERVED==RESERVED_LOCK );
2139 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002140
2141 /* If the file is currently unlocked then the size must be unknown */
2142 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2143
danielk197717221812005-02-15 03:38:05 +00002144 if( pPager->state>=locktype ){
2145 rc = SQLITE_OK;
2146 }else{
drhbefdf832008-03-14 19:33:05 +00002147 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002148 do {
drh054889e2005-11-30 03:20:31 +00002149 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002150 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002151 if( rc==SQLITE_OK ){
2152 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002153 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002154 }
2155 }
2156 return rc;
2157}
2158
2159/*
drhf7c57532003-04-25 13:22:51 +00002160** Truncate the file to the number of pages specified.
2161*/
danielk19773b8a05f2007-03-19 17:44:26 +00002162int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
danielk19778c0a7912008-08-20 14:49:23 +00002163 int rc = SQLITE_OK;
drh1aa2d8b2007-01-03 15:34:29 +00002164 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00002165
danielk19778c0a7912008-08-20 14:49:23 +00002166
danielk1977ad0132d2008-06-07 08:58:22 +00002167 sqlite3PagerPagecount(pPager, 0);
danielk1977efaaf572006-01-16 11:29:19 +00002168 if( pPager->errCode ){
2169 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002170 }else if( nPage<(unsigned)pPager->dbSize ){
2171 if( MEMDB ){
2172 pPager->dbSize = nPage;
2173 pager_truncate_cache(pPager);
2174 }else{
2175 rc = syncJournal(pPager);
2176 if( rc==SQLITE_OK ){
2177 /* Get an exclusive lock on the database before truncating. */
2178 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2179 }
2180 if( rc==SQLITE_OK ){
2181 rc = pager_truncate(pPager, nPage);
2182 }
2183 }
danielk1977369f27e2004-06-15 11:40:04 +00002184 }
danielk197717221812005-02-15 03:38:05 +00002185
drhf7c57532003-04-25 13:22:51 +00002186 return rc;
2187}
2188
2189/*
drhed7c8552001-04-11 14:29:21 +00002190** Shutdown the page cache. Free all memory and close all files.
2191**
2192** If a transaction was in progress when this routine is called, that
2193** transaction is rolled back. All outstanding pages are invalidated
2194** and their memory is freed. Any attempt to use a page associated
2195** with this page cache after this function returns will likely
2196** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002197**
2198** This function always succeeds. If a transaction is active an attempt
2199** is made to roll it back. If an error occurs during the rollback
2200** a hot journal may be left in the filesystem but no error is returned
2201** to the caller.
drhed7c8552001-04-11 14:29:21 +00002202*/
danielk19773b8a05f2007-03-19 17:44:26 +00002203int sqlite3PagerClose(Pager *pPager){
danielk197713f72992005-12-18 08:51:22 +00002204
drhbafda092007-01-03 23:36:22 +00002205 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002206 sqlite3BeginBenignMalloc();
drhc2ee76c2007-01-04 14:58:14 +00002207 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002208 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002209 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002210 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002211 enable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002212 sqlite3EndBenignMalloc();
drh4f0c5872007-03-26 22:05:01 +00002213 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002214 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002215 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002216 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002217 }
drhf5e7bb52008-02-18 14:47:33 +00002218 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977a1fa00d2008-08-27 15:16:33 +00002219 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
danielk1977e94ddc92005-03-21 03:53:38 +00002220 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002221 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002222 }
danielk1977b4b47412007-08-17 15:53:36 +00002223 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002224 /* Temp files are automatically deleted by the OS
2225 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002226 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002227 ** }
2228 */
danielk1977aca790a2005-01-13 11:07:52 +00002229
drhfacf0302008-06-17 15:12:00 +00002230 sqlite3PageFree(pPager->pTmpSpace);
danielk19778c0a7912008-08-20 14:49:23 +00002231 sqlite3PcacheClose(pPager->pPCache);
drh17435752007-08-16 04:30:38 +00002232 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002233 return SQLITE_OK;
2234}
2235
drh87cc3b32007-05-08 21:45:27 +00002236#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002237/*
drh5e00f6c2001-09-13 13:46:56 +00002238** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002239*/
danielk19773b8a05f2007-03-19 17:44:26 +00002240Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002241 return p->pgno;
2242}
drh87cc3b32007-05-08 21:45:27 +00002243#endif
drhed7c8552001-04-11 14:29:21 +00002244
2245/*
drhdf0b3b02001-06-23 11:36:20 +00002246** Increment the reference count for a page. The input pointer is
2247** a reference to the page data.
2248*/
danielk19773b8a05f2007-03-19 17:44:26 +00002249int sqlite3PagerRef(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002250 sqlite3PcacheRef(pPg);
drh8c42ca92001-06-22 19:15:00 +00002251 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002252}
2253
2254/*
drh34e79ce2004-02-08 06:05:46 +00002255** Sync the journal. In other words, make sure all the pages that have
2256** been written to the journal have actually reached the surface of the
2257** disk. It is not safe to modify the original database file until after
2258** the journal has been synced. If the original database is modified before
2259** the journal is synced and a power failure occurs, the unsynced journal
2260** data would be lost and we would be unable to completely rollback the
2261** database changes. Database corruption would occur.
2262**
2263** This routine also updates the nRec field in the header of the journal.
2264** (See comments on the pager_playback() routine for additional information.)
2265** If the sync mode is FULL, two syncs will occur. First the whole journal
2266** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002267**
drh34e79ce2004-02-08 06:05:46 +00002268** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002269** after a power failure, so no sync occurs.
2270**
2271** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2272** the database is stored, then OsSync() is never called on the journal
2273** file. In this case all that is required is to update the nRec field in
2274** the journal header.
drhfa86c412002-02-02 15:01:15 +00002275**
drh34e79ce2004-02-08 06:05:46 +00002276** This routine clears the needSync field of every page current held in
2277** memory.
drh50e5dad2001-09-15 00:57:28 +00002278*/
danielk197776572402004-06-25 02:38:54 +00002279static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002280 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002281
2282 /* Sync the journal before modifying the main database
2283 ** (assuming there is a journal and it needs to be synced.)
2284 */
danielk197776572402004-06-25 02:38:54 +00002285 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002286 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002287 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002288 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002289
danielk19774cd2cd52007-08-23 14:48:23 +00002290 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002291 /* Write the nRec value into the journal file header. If in
2292 ** full-synchronous mode, sync the journal first. This ensures that
2293 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002294 ** it as a candidate for rollback.
2295 **
2296 ** This is not required if the persistent media supports the
2297 ** SAFE_APPEND property. Because in this case it is not possible
2298 ** for garbage data to be appended to the file, the nRec field
2299 ** is populated with 0xFFFFFFFF when the journal header is written
2300 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002301 */
danielk19774cd2cd52007-08-23 14:48:23 +00002302 i64 jrnlOff;
2303 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002304 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002305 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002306 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002307 if( rc!=0 ) return rc;
2308 }
danielk197713adf8a2004-06-03 16:08:41 +00002309
danielk197762079062007-08-15 17:08:46 +00002310 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2311 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2312 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002313 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002314 }
danielk19774cd2cd52007-08-23 14:48:23 +00002315 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2316 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2317 IOTRACE(("JSYNC %p\n", pPager))
2318 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2319 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2320 );
2321 if( rc!=0 ) return rc;
2322 }
drhdb48ee02003-01-16 13:42:43 +00002323 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002324 }
drh50e5dad2001-09-15 00:57:28 +00002325 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002326
2327 /* Erase the needSync flag from every page.
2328 */
drhb3df2e12008-09-17 20:06:26 +00002329 sqlite3PcacheClearFlags(pPager->pPCache, PGHDR_NEED_SYNC);
drh50e5dad2001-09-15 00:57:28 +00002330 }
drh03eb96a2002-11-10 23:32:56 +00002331
drh341eae82003-01-21 02:39:36 +00002332#ifndef NDEBUG
2333 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2334 ** flag must also be clear for all pages. Verify that this
2335 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002336 */
drh341eae82003-01-21 02:39:36 +00002337 else{
danielk19778c0a7912008-08-20 14:49:23 +00002338 sqlite3PcacheAssertFlags(pPager->pPCache, 0, PGHDR_NEED_SYNC);
drh03eb96a2002-11-10 23:32:56 +00002339 }
drh341eae82003-01-21 02:39:36 +00002340#endif
drhdb48ee02003-01-16 13:42:43 +00002341
drh81a20f22001-10-12 17:30:04 +00002342 return rc;
drh50e5dad2001-09-15 00:57:28 +00002343}
2344
2345/*
drh2554f8b2003-01-22 01:26:44 +00002346** Given a list of pages (connected by the PgHdr.pDirty pointer) write
danielk1977a858aa22008-08-22 16:22:17 +00002347** every one of those pages out to the database file. No calls are made
2348** to the page-cache to mark the pages as clean. It is the responsibility
2349** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark
2350** the pages as clean.
drh2554f8b2003-01-22 01:26:44 +00002351*/
2352static int pager_write_pagelist(PgHdr *pList){
2353 Pager *pPager;
2354 int rc;
2355
2356 if( pList==0 ) return SQLITE_OK;
2357 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002358
2359 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2360 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002361 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002362 **
drha6abd042004-06-09 17:37:22 +00002363 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2364 ** through an intermediate state PENDING. A PENDING lock prevents new
2365 ** readers from attaching to the database but is unsufficient for us to
2366 ** write. The idea of a PENDING lock is to prevent new readers from
2367 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002368 **
drha6abd042004-06-09 17:37:22 +00002369 ** While the pager is in the RESERVED state, the original database file
2370 ** is unchanged and we can rollback without having to playback the
2371 ** journal into the original database file. Once we transition to
2372 ** EXCLUSIVE, it means the database file has been changed and any rollback
2373 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002374 */
drh684917c2004-10-05 02:41:42 +00002375 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002376 if( rc!=SQLITE_OK ){
2377 return rc;
2378 }
2379
drh2554f8b2003-01-22 01:26:44 +00002380 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002381
2382 /* If the file has not yet been opened, open it now. */
2383 if( !pPager->fd->pMethods ){
2384 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00002385 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002386 if( rc ) return rc;
2387 }
2388
danielk1977687566d2004-11-02 12:56:41 +00002389 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002390 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002391 ** make the file smaller (presumably by auto-vacuum code). Do not write
2392 ** any such pages to the file.
2393 */
danielk197733e32162008-08-23 18:53:08 +00002394 if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
danielk197762079062007-08-15 17:08:46 +00002395 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002396 char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00002397 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2398 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002399 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002400 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002401 PAGER_INCR(sqlite3_pager_writedb_count);
2402 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002403 if( pList->pgno==1 ){
2404 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2405 }
danielk1977687566d2004-11-02 12:56:41 +00002406 }
2407#ifndef NDEBUG
2408 else{
drh4f0c5872007-03-26 22:05:01 +00002409 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002410 }
2411#endif
drh2554f8b2003-01-22 01:26:44 +00002412 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002413#ifdef SQLITE_CHECK_PAGES
2414 pList->pageHash = pager_pagehash(pList);
2415#endif
drh2554f8b2003-01-22 01:26:44 +00002416 pList = pList->pDirty;
2417 }
danielk19778c0a7912008-08-20 14:49:23 +00002418
drh2554f8b2003-01-22 01:26:44 +00002419 return SQLITE_OK;
2420}
2421
2422/*
danielk19778c0a7912008-08-20 14:49:23 +00002423** This function is called by the pcache layer when it has reached some
2424** soft memory limit. The argument is a pointer to a purgeable Pager
2425** object. This function attempts to make a single dirty page that has no
2426** outstanding references (if one exists) clean so that it can be recycled
2427** by the pcache layer.
drh2554f8b2003-01-22 01:26:44 +00002428*/
danielk1977a858aa22008-08-22 16:22:17 +00002429static int pagerStress(void *p, PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002430 Pager *pPager = (Pager *)p;
danielk19778c0a7912008-08-20 14:49:23 +00002431 int rc = SQLITE_OK;
drh8f2e9a12008-02-26 14:46:04 +00002432
danielk19778c200142008-08-25 07:12:28 +00002433 if( pPager->doNotSync ){
2434 return SQLITE_OK;
2435 }
2436
danielk1977a858aa22008-08-22 16:22:17 +00002437 assert( pPg->flags&PGHDR_DIRTY );
2438 if( pPager->errCode==SQLITE_OK ){
2439 if( pPg->flags&PGHDR_NEED_SYNC ){
2440 rc = syncJournal(pPager);
2441 if( rc==SQLITE_OK && pPager->fullSync &&
2442 !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
2443 ){
2444 pPager->nRec = 0;
2445 rc = writeJournalHdr(pPager);
danielk19778c0a7912008-08-20 14:49:23 +00002446 }
danielk19778c0a7912008-08-20 14:49:23 +00002447 }
danielk1977a858aa22008-08-22 16:22:17 +00002448 if( rc==SQLITE_OK ){
2449 pPg->pDirty = 0;
2450 rc = pager_write_pagelist(pPg);
2451 }
2452 if( rc!=SQLITE_OK ){
2453 pager_error(pPager, rc);
2454 }
2455 }
2456
2457 if( rc==SQLITE_OK ){
2458 sqlite3PcacheMakeClean(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00002459 }
2460 return rc;
drh2554f8b2003-01-22 01:26:44 +00002461}
2462
danielk19778c0a7912008-08-20 14:49:23 +00002463
drh2554f8b2003-01-22 01:26:44 +00002464/*
drh19db9352008-03-27 22:42:51 +00002465** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00002466** A hot journal is one that needs to be played back.
2467**
2468** If the current size of the database file is 0 but a journal file
2469** exists, that is probably an old journal left over from a prior
2470** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00002471**
2472** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00002473**
2474** This routine does not open the journal file to examine its
2475** content. Hence, the journal might contain the name of a master
2476** journal file that has been deleted, and hence not be hot. Or
2477** the header of the journal might be zeroed out. This routine
2478** does not discover these cases of a non-hot journal - if the
2479** journal file exists and is not empty this routine assumes it
2480** is hot. The pager_playback() routine will discover that the
2481** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00002482*/
danielk1977d300b8a2008-08-01 10:50:23 +00002483static int hasHotJournal(Pager *pPager, int *pExists){
danielk1977b4b47412007-08-17 15:53:36 +00002484 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977d300b8a2008-08-01 10:50:23 +00002485 int rc = SQLITE_OK;
drh0a846f92008-08-25 17:23:29 +00002486 int exists;
2487 int locked;
2488 assert( pPager!=0 );
2489 assert( pPager->useJournal );
2490 assert( pPager->fd->pMethods );
danielk1977d300b8a2008-08-01 10:50:23 +00002491 *pExists = 0;
drh0a846f92008-08-25 17:23:29 +00002492 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
2493 if( rc==SQLITE_OK && exists ){
2494 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
2495 }
2496 if( rc==SQLITE_OK && exists && !locked ){
2497 int nPage;
2498 rc = sqlite3PagerPagecount(pPager, &nPage);
2499 if( rc==SQLITE_OK ){
2500 if( nPage==0 ){
2501 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2502 }else{
2503 *pExists = 1;
danielk1977861f7452008-06-05 11:39:11 +00002504 }
2505 }
drhbb5f18d2007-04-06 18:23:17 +00002506 }
danielk1977d300b8a2008-08-01 10:50:23 +00002507 return rc;
drh165ffe92005-03-15 17:09:30 +00002508}
2509
2510/*
danielk1977e180dd92007-04-05 17:15:52 +00002511** Read the content of page pPg out of the database file.
2512*/
2513static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2514 int rc;
danielk197762079062007-08-15 17:08:46 +00002515 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002516 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002517 assert(pPager->fd->pMethods||pPager->tempFile);
2518 if( !pPager->fd->pMethods ){
2519 return SQLITE_IOERR_SHORT_READ;
2520 }
danielk197762079062007-08-15 17:08:46 +00002521 offset = (pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002522 rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002523 PAGER_INCR(sqlite3_pager_readdb_count);
2524 PAGER_INCR(pPager->nRead);
2525 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002526 if( pgno==1 ){
danielk19778c0a7912008-08-20 14:49:23 +00002527 memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24],
drh86a88112007-04-16 15:02:19 +00002528 sizeof(pPager->dbFileVers));
2529 }
danielk197730849522008-08-21 04:35:18 +00002530 CODEC1(pPager, pPg->pData, pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002531 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2532 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002533 return rc;
2534}
2535
2536
2537/*
danielk1977e277be02007-03-23 18:12:06 +00002538** This function is called to obtain the shared lock required before
2539** data may be read from the pager cache. If the shared lock has already
2540** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002541**
2542** Immediately after obtaining the shared lock (if required), this function
2543** checks for a hot-journal file. If one is found, an emergency rollback
2544** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002545*/
2546static int pagerSharedLock(Pager *pPager){
2547 int rc = SQLITE_OK;
danielk1977d300b8a2008-08-01 10:50:23 +00002548 int isErrorReset = 0;
danielk1977e277be02007-03-23 18:12:06 +00002549
danielk1977ae72d982007-10-03 08:46:44 +00002550 /* If this database is opened for exclusive access, has no outstanding
2551 ** page references and is in an error-state, now is the chance to clear
2552 ** the error. Discard the contents of the pager-cache and treat any
2553 ** open journal file as a hot-journal.
2554 */
danielk19778c0a7912008-08-20 14:49:23 +00002555 if( !MEMDB && pPager->exclusiveMode
2556 && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode
2557 ){
danielk1977ae72d982007-10-03 08:46:44 +00002558 if( pPager->journalOpen ){
danielk1977d300b8a2008-08-01 10:50:23 +00002559 isErrorReset = 1;
danielk1977ae72d982007-10-03 08:46:44 +00002560 }
danielk1977ae72d982007-10-03 08:46:44 +00002561 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00002562 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00002563 }
2564
2565 /* If the pager is still in an error state, do not proceed. The error
2566 ** state will be cleared at some point in the future when all page
2567 ** references are dropped and the cache can be discarded.
2568 */
2569 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2570 return pPager->errCode;
2571 }
2572
danielk1977d300b8a2008-08-01 10:50:23 +00002573 if( pPager->state==PAGER_UNLOCK || isErrorReset ){
danielk1977b4b47412007-08-17 15:53:36 +00002574 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00002575 if( !MEMDB ){
danielk1977d300b8a2008-08-01 10:50:23 +00002576 int isHotJournal;
danielk19778c0a7912008-08-20 14:49:23 +00002577 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
danielk1977e277be02007-03-23 18:12:06 +00002578 if( !pPager->noReadlock ){
2579 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2580 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002581 assert( pPager->state==PAGER_UNLOCK );
danielk1977e277be02007-03-23 18:12:06 +00002582 return pager_error(pPager, rc);
2583 }
2584 assert( pPager->state>=SHARED_LOCK );
2585 }
2586
2587 /* If a journal file exists, and there is no RESERVED lock on the
2588 ** database file, then it either needs to be played back or deleted.
2589 */
danielk1977d300b8a2008-08-01 10:50:23 +00002590 if( !isErrorReset ){
2591 rc = hasHotJournal(pPager, &isHotJournal);
2592 if( rc!=SQLITE_OK ){
2593 goto failed;
2594 }
drh19db9352008-03-27 22:42:51 +00002595 }
danielk1977d300b8a2008-08-01 10:50:23 +00002596 if( isErrorReset || isHotJournal ){
danielk1977e277be02007-03-23 18:12:06 +00002597 /* Get an EXCLUSIVE lock on the database file. At this point it is
2598 ** important that a RESERVED lock is not obtained on the way to the
2599 ** EXCLUSIVE lock. If it were, another process might open the
2600 ** database file, detect the RESERVED lock, and conclude that the
2601 ** database is safe to read while this process is still rolling it
2602 ** back.
2603 **
2604 ** Because the intermediate RESERVED lock is not requested, the
2605 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00002606 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00002607 */
danielk1977ae72d982007-10-03 08:46:44 +00002608 if( pPager->state<EXCLUSIVE_LOCK ){
2609 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
2610 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002611 rc = pager_error(pPager, rc);
2612 goto failed;
danielk1977ae72d982007-10-03 08:46:44 +00002613 }
2614 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00002615 }
danielk1977e277be02007-03-23 18:12:06 +00002616
drh16e45a42008-04-19 20:34:18 +00002617 /* Open the journal for read/write access. This is because in
drhfd131da2007-08-07 17:13:03 +00002618 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00002619 ** possibly used for a transaction later on. On some systems, the
2620 ** OsTruncate() call used in exclusive-access mode also requires
2621 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00002622 */
danielk1977d300b8a2008-08-01 10:50:23 +00002623 if( !isErrorReset && pPager->journalOpen==0 ){
danielk1977861f7452008-06-05 11:39:11 +00002624 int res;
2625 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
2626 if( rc==SQLITE_OK ){
2627 if( res ){
2628 int fout = 0;
2629 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
2630 assert( !pPager->tempFile );
2631 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
2632 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
2633 if( fout&SQLITE_OPEN_READONLY ){
2634 rc = SQLITE_BUSY;
2635 sqlite3OsClose(pPager->jfd);
2636 }
2637 }else{
2638 /* If the journal does not exist, that means some other process
2639 ** has already rolled it back */
danielk1977ae72d982007-10-03 08:46:44 +00002640 rc = SQLITE_BUSY;
danielk1977ae72d982007-10-03 08:46:44 +00002641 }
danielk1977979f38e2007-03-27 16:19:51 +00002642 }
2643 }
danielk1977e277be02007-03-23 18:12:06 +00002644 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002645 if( rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_UNLOCK
2646 && rc!=SQLITE_IOERR_NOMEM
2647 ){
2648 rc = SQLITE_BUSY;
drh1aa5af12008-03-07 19:51:14 +00002649 }
danielk197752b472a2008-05-05 16:23:55 +00002650 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002651 }
2652 pPager->journalOpen = 1;
2653 pPager->journalStarted = 0;
2654 pPager->journalOff = 0;
2655 pPager->setMaster = 0;
2656 pPager->journalHdr = 0;
2657
2658 /* Playback and delete the journal. Drop the database write
2659 ** lock and reacquire the read lock.
2660 */
2661 rc = pager_playback(pPager, 1);
2662 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002663 rc = pager_error(pPager, rc);
2664 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002665 }
danielk1977c5859712007-03-26 12:26:27 +00002666 assert(pPager->state==PAGER_SHARED ||
2667 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2668 );
danielk1977e277be02007-03-23 18:12:06 +00002669 }
2670
danielk19778c0a7912008-08-20 14:49:23 +00002671 if( sqlite3PcachePagecount(pPager->pPCache)>0 ){
danielk197724168722007-04-02 05:07:47 +00002672 /* The shared-lock has just been acquired on the database file
2673 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00002674 ** read or write transaction). Check to see if the database
2675 ** has been modified. If the database has changed, flush the
2676 ** cache.
2677 **
2678 ** Database changes is detected by looking at 15 bytes beginning
2679 ** at offset 24 into the file. The first 4 of these 16 bytes are
2680 ** a 32-bit counter that is incremented with each change. The
2681 ** other bytes change randomly with each file change when
2682 ** a codec is in use.
2683 **
2684 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00002685 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00002686 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00002687 */
drh86a88112007-04-16 15:02:19 +00002688 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977ad0132d2008-06-07 08:58:22 +00002689 sqlite3PagerPagecount(pPager, 0);
danielk197724168722007-04-02 05:07:47 +00002690
danielk1977e180dd92007-04-05 17:15:52 +00002691 if( pPager->errCode ){
danielk197752b472a2008-05-05 16:23:55 +00002692 rc = pPager->errCode;
2693 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002694 }
2695
danielk1977e180dd92007-04-05 17:15:52 +00002696 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00002697 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00002698 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00002699 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002700 goto failed;
danielk1977e180dd92007-04-05 17:15:52 +00002701 }
drh86a88112007-04-16 15:02:19 +00002702 }else{
2703 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00002704 }
2705
drh86a88112007-04-16 15:02:19 +00002706 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00002707 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002708 }
2709 }
2710 }
danielk1977c5859712007-03-26 12:26:27 +00002711 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2712 if( pPager->state==PAGER_UNLOCK ){
2713 pPager->state = PAGER_SHARED;
2714 }
danielk1977e277be02007-03-23 18:12:06 +00002715 }
2716
danielk197752b472a2008-05-05 16:23:55 +00002717 failed:
2718 if( rc!=SQLITE_OK ){
2719 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
2720 pager_unlock(pPager);
2721 }
danielk1977e277be02007-03-23 18:12:06 +00002722 return rc;
2723}
2724
2725/*
drhd33d5a82007-04-26 12:11:28 +00002726** Make sure we have the content for a page. If the page was
2727** previously acquired with noContent==1, then the content was
2728** just initialized to zeros instead of being read from disk.
2729** But now we need the real data off of disk. So make sure we
2730** have it. Read it in if we do not have it already.
2731*/
2732static int pager_get_content(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002733 if( pPg->flags&PGHDR_NEED_READ ){
drhd33d5a82007-04-26 12:11:28 +00002734 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
2735 if( rc==SQLITE_OK ){
danielk19778c0a7912008-08-20 14:49:23 +00002736 pPg->flags &= ~PGHDR_NEED_READ;
drhd33d5a82007-04-26 12:11:28 +00002737 }else{
2738 return rc;
2739 }
2740 }
2741 return SQLITE_OK;
2742}
2743
2744/*
danielk19778c0a7912008-08-20 14:49:23 +00002745** If the reference count has reached zero, and the pager is not in the
2746** middle of a write transaction or opened in exclusive mode, unlock it.
2747*/
2748static void pagerUnlockIfUnused(Pager *pPager){
2749 if( (sqlite3PcacheRefCount(pPager->pPCache)==0)
2750 && (!pPager->exclusiveMode || pPager->journalOff>0)
2751 ){
2752 pagerUnlockAndRollback(pPager);
2753 }
2754}
2755
2756/*
2757** Drop a page from the cache using sqlite3PcacheDrop().
2758**
2759** If this means there are now no pages with references to them, a rollback
2760** occurs and the lock on the database is removed.
2761*/
2762static void pagerDropPage(DbPage *pPg){
2763 Pager *pPager = pPg->pPager;
2764 sqlite3PcacheDrop(pPg);
2765 pagerUnlockIfUnused(pPager);
2766}
2767
2768/*
drhd9b02572001-04-15 00:37:09 +00002769** Acquire a page.
2770**
drh58a11682001-11-10 13:51:08 +00002771** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002772** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002773**
drhd33d5a82007-04-26 12:11:28 +00002774** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00002775** file is smaller than the requested page, then no actual disk
2776** read occurs and the memory image of the page is initialized to
2777** all zeros. The extra data appended to a page is always initialized
2778** to zeros the first time a page is loaded into memory.
2779**
drhd9b02572001-04-15 00:37:09 +00002780** The acquisition might fail for several reasons. In all cases,
2781** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002782**
drhd33d5a82007-04-26 12:11:28 +00002783** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002784** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00002785** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00002786** just returns 0. This routine acquires a read-lock the first time it
2787** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00002788** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00002789** or journal files.
drh0787db62007-03-04 13:15:27 +00002790**
drh538f5702007-04-13 02:14:30 +00002791** If noContent is false, the page contents are actually read from disk.
2792** If noContent is true, it means that we do not care about the contents
2793** of the page at this time, so do not do a disk read. Just fill in the
2794** page content with zeros. But mark the fact that we have not read the
2795** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00002796** sqlite3PagerWrite() is called on this page or if this routine is
2797** called again with noContent==0, that means that the content is needed
2798** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002799*/
danielk197765e0ff32008-09-19 09:14:43 +00002800int sqlite3PagerAcquire(
drh538f5702007-04-13 02:14:30 +00002801 Pager *pPager, /* The pager open on the database file */
2802 Pgno pgno, /* Page number to fetch */
2803 DbPage **ppPage, /* Write a pointer to the page here */
2804 int noContent /* Do not bother reading content from disk if true */
2805){
danielk19778c0a7912008-08-20 14:49:23 +00002806 PgHdr *pPg = 0;
drh165ffe92005-03-15 17:09:30 +00002807 int rc;
drhed7c8552001-04-11 14:29:21 +00002808
danielk19778c0a7912008-08-20 14:49:23 +00002809 assert( pPager->state==PAGER_UNLOCK
2810 || sqlite3PcacheRefCount(pPager->pPCache)>0
2811 || pgno==1
2812 );
danielk1977e277be02007-03-23 18:12:06 +00002813
danielk197726836652005-01-17 01:33:13 +00002814 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2815 ** number greater than this, or zero, is requested.
2816 */
drh267cb322005-09-16 17:16:52 +00002817 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002818 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002819 }
2820
drhd9b02572001-04-15 00:37:09 +00002821 /* Make sure we have not hit any critical errors.
2822 */
drh836faa42003-01-11 13:30:57 +00002823 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002824 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002825
danielk197713adf8a2004-06-03 16:08:41 +00002826 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002827 ** on the database file. pagerSharedLock() is a no-op if
2828 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002829 */
danielk1977e277be02007-03-23 18:12:06 +00002830 rc = pagerSharedLock(pPager);
2831 if( rc!=SQLITE_OK ){
2832 return rc;
drhed7c8552001-04-11 14:29:21 +00002833 }
danielk1977e277be02007-03-23 18:12:06 +00002834 assert( pPager->state!=PAGER_UNLOCK );
2835
danielk19778c0a7912008-08-20 14:49:23 +00002836 rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg);
2837 if( rc!=SQLITE_OK ){
2838 return rc;
2839 }
danielk19778c0a7912008-08-20 14:49:23 +00002840 if( pPg->pPager==0 ){
2841 /* The pager cache has created a new page. Its content needs to
2842 ** be initialized.
2843 */
danielk1977979f38e2007-03-27 16:19:51 +00002844 int nMax;
drh538f5702007-04-13 02:14:30 +00002845 PAGER_INCR(pPager->nMiss);
danielk19778c0a7912008-08-20 14:49:23 +00002846 pPg->pPager = pPager;
2847 if( sqlite3BitvecTest(pPager->pInJournal, pgno) ){
drhb3df2e12008-09-17 20:06:26 +00002848 assert( !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00002849 pPg->flags |= PGHDR_IN_JOURNAL;
drhed7c8552001-04-11 14:29:21 +00002850 }
danielk19778c0a7912008-08-20 14:49:23 +00002851 memset(pPg->pExtra, 0, pPager->nExtra);
danielk197724168722007-04-02 05:07:47 +00002852
danielk1977ad0132d2008-06-07 08:58:22 +00002853 rc = sqlite3PagerPagecount(pPager, &nMax);
2854 if( rc!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002855 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00002856 return rc;
2857 }
danielk197775bab7d2006-01-23 13:09:45 +00002858
danielk1977a1fa00d2008-08-27 15:16:33 +00002859 if( nMax<(int)pgno || MEMDB || noContent ){
drhf8e632b2007-05-08 14:51:36 +00002860 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00002861 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00002862 return SQLITE_FULL;
2863 }
danielk19778c0a7912008-08-20 14:49:23 +00002864 memset(pPg->pData, 0, pPager->pageSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00002865 if( noContent ){
danielk19778c0a7912008-08-20 14:49:23 +00002866 pPg->flags |= PGHDR_NEED_READ;
2867 }
drh538f5702007-04-13 02:14:30 +00002868 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00002869 }else{
danielk1977e180dd92007-04-05 17:15:52 +00002870 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00002871 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
danielk19778c0a7912008-08-20 14:49:23 +00002872 /* sqlite3PagerUnref(pPg); */
2873 pagerDropPage(pPg);
drh551b7732006-11-06 21:20:25 +00002874 return rc;
drh81a20f22001-10-12 17:30:04 +00002875 }
drh306dc212001-05-21 13:45:10 +00002876 }
danielk19773c407372005-02-15 02:54:14 +00002877#ifdef SQLITE_CHECK_PAGES
2878 pPg->pageHash = pager_pagehash(pPg);
2879#endif
drhed7c8552001-04-11 14:29:21 +00002880 }else{
drhd9b02572001-04-15 00:37:09 +00002881 /* The requested page is in the page cache. */
danielk19778c0a7912008-08-20 14:49:23 +00002882 assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00002883 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00002884 if( !noContent ){
2885 rc = pager_get_content(pPg);
2886 if( rc ){
danielk19778c0a7912008-08-20 14:49:23 +00002887 sqlite3PagerUnref(pPg);
drhd33d5a82007-04-26 12:11:28 +00002888 return rc;
2889 }
2890 }
drhed7c8552001-04-11 14:29:21 +00002891 }
danielk19778c0a7912008-08-20 14:49:23 +00002892
danielk19773b8a05f2007-03-19 17:44:26 +00002893 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00002894 return SQLITE_OK;
2895}
danielk19778c0a7912008-08-20 14:49:23 +00002896
drhed7c8552001-04-11 14:29:21 +00002897/*
drh7e3b0a02001-04-28 16:52:40 +00002898** Acquire a page if it is already in the in-memory cache. Do
2899** not read the page from disk. Return a pointer to the page,
2900** or 0 if the page is not in cache.
2901**
danielk19773b8a05f2007-03-19 17:44:26 +00002902** See also sqlite3PagerGet(). The difference between this routine
2903** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002904** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002905** returns NULL if the page is not in cache or if a disk I/O error
2906** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002907*/
danielk19773b8a05f2007-03-19 17:44:26 +00002908DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00002909 PgHdr *pPg = 0;
drh836faa42003-01-11 13:30:57 +00002910 assert( pPager!=0 );
2911 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00002912
danielk19778c0a7912008-08-20 14:49:23 +00002913 if( (pPager->state!=PAGER_UNLOCK)
2914 && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL)
2915 ){
2916 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg);
danielk1977e277be02007-03-23 18:12:06 +00002917 }
danielk19778c0a7912008-08-20 14:49:23 +00002918
danielk19773b8a05f2007-03-19 17:44:26 +00002919 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00002920}
2921
2922/*
drhed7c8552001-04-11 14:29:21 +00002923** Release a page.
2924**
2925** If the number of references to the page drop to zero, then the
2926** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002927** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002928** removed.
2929*/
danielk19773b8a05f2007-03-19 17:44:26 +00002930int sqlite3PagerUnref(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002931 if( pPg ){
2932 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002933 sqlite3PcacheRelease(pPg);
2934 pagerUnlockIfUnused(pPager);
drhed7c8552001-04-11 14:29:21 +00002935 }
drhd9b02572001-04-15 00:37:09 +00002936 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002937}
2938
2939/*
drha6abd042004-06-09 17:37:22 +00002940** Create a journal file for pPager. There should already be a RESERVED
2941** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002942**
2943** Return SQLITE_OK if everything. Return an error code and release the
2944** write lock if anything goes wrong.
2945*/
2946static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00002947 sqlite3_vfs *pVfs = pPager->pVfs;
2948 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
2949
drhda47d772002-12-02 04:25:19 +00002950 int rc;
drhb7f91642004-10-31 02:22:47 +00002951 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00002952 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002953 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00002954 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00002955 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00002956 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00002957 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002958 rc = SQLITE_NOMEM;
2959 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002960 }
danielk1977b4b47412007-08-17 15:53:36 +00002961
drhfdc40e92008-04-17 20:59:37 +00002962 if( pPager->journalOpen==0 ){
2963 if( pPager->tempFile ){
2964 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
2965 }else{
2966 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00002967 }
drhfdc40e92008-04-17 20:59:37 +00002968#ifdef SQLITE_ENABLE_ATOMIC_WRITE
2969 rc = sqlite3JournalOpen(
2970 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
2971 );
2972#else
2973 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
2974#endif
2975 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
2976 pPager->journalOff = 0;
2977 pPager->setMaster = 0;
2978 pPager->journalHdr = 0;
2979 if( rc!=SQLITE_OK ){
2980 if( rc==SQLITE_NOMEM ){
2981 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2982 }
2983 goto failed_to_open_journal;
2984 }
drhda47d772002-12-02 04:25:19 +00002985 }
2986 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002987 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002988 pPager->needSync = 0;
drh968af522003-02-11 14:55:40 +00002989 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00002990 if( pPager->errCode ){
2991 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00002992 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00002993 }
drhda47d772002-12-02 04:25:19 +00002994 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002995
danielk197776572402004-06-25 02:38:54 +00002996 rc = writeJournalHdr(pPager);
2997
drhac69b052004-05-12 13:30:07 +00002998 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00002999 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003000 }
danielk1977ae72d982007-10-03 08:46:44 +00003001 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003002 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003003 if( rc==SQLITE_OK ){
3004 rc = SQLITE_FULL;
3005 }
3006 }
drh9c105bb2004-10-02 20:38:28 +00003007 return rc;
3008
3009failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003010 sqlite3BitvecDestroy(pPager->pInJournal);
3011 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003012 return rc;
drhda47d772002-12-02 04:25:19 +00003013}
3014
3015/*
drh4b845d72002-03-05 12:41:19 +00003016** Acquire a write-lock on the database. The lock is removed when
3017** the any of the following happen:
3018**
drh80e35f42007-03-30 14:06:34 +00003019** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003020** * sqlite3PagerRollback() is called.
3021** * sqlite3PagerClose() is called.
3022** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003023**
danielk197713adf8a2004-06-03 16:08:41 +00003024** The first parameter to this routine is a pointer to any open page of the
3025** database file. Nothing changes about the page - it is used merely to
3026** acquire a pointer to the Pager structure and as proof that there is
3027** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003028**
danielk197713adf8a2004-06-03 16:08:41 +00003029** The second parameter indicates how much space in bytes to reserve for a
3030** master journal file-name at the start of the journal when it is created.
3031**
3032** A journal file is opened if this is not a temporary file. For temporary
3033** files, the opening of the journal file is deferred until there is an
3034** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003035**
drha6abd042004-06-09 17:37:22 +00003036** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003037**
3038** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3039** immediately instead of waiting until we try to flush the cache. The
3040** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003041*/
danielk19773b8a05f2007-03-19 17:44:26 +00003042int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003043 Pager *pPager = pPg->pPager;
3044 int rc = SQLITE_OK;
3045 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003046 assert( pPager->state!=PAGER_UNLOCK );
3047 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003048 assert( pPager->pInJournal==0 );
danielk19778c0a7912008-08-20 14:49:23 +00003049 sqlite3PcacheAssertFlags(pPager->pPCache, 0, PGHDR_IN_JOURNAL);
drhb7f91642004-10-31 02:22:47 +00003050 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003051 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003052 pPager->origDbSize = pPager->dbSize;
3053 }else{
drh054889e2005-11-30 03:20:31 +00003054 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003055 if( rc==SQLITE_OK ){
3056 pPager->state = PAGER_RESERVED;
3057 if( exFlag ){
3058 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3059 }
3060 }
danielk19779eed5052004-06-04 10:38:30 +00003061 if( rc!=SQLITE_OK ){
3062 return rc;
drhac69b052004-05-12 13:30:07 +00003063 }
drha6abd042004-06-09 17:37:22 +00003064 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003065 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhfdc40e92008-04-17 20:59:37 +00003066 if( pPager->useJournal && !pPager->tempFile
3067 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drhac69b052004-05-12 13:30:07 +00003068 rc = pager_open_journal(pPager);
3069 }
drh4b845d72002-03-05 12:41:19 +00003070 }
danielk1977334cdb62007-03-26 08:05:12 +00003071 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00003072 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00003073 ** time a (read or write) transaction was successfully concluded
3074 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00003075 ** kept open and either was truncated to 0 bytes or its header was
3076 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00003077 */
3078 assert( pPager->nRec==0 );
3079 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003080 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003081 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003082 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhf5e7bb52008-02-18 14:47:33 +00003083 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003084 rc = SQLITE_NOMEM;
3085 }else{
drh369339d2007-03-30 16:01:55 +00003086 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003087 rc = writeJournalHdr(pPager);
3088 }
drh4b845d72002-03-05 12:41:19 +00003089 }
danielk1977334cdb62007-03-26 08:05:12 +00003090 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003091 return rc;
3092}
3093
3094/*
drh605ad8f2006-05-03 23:34:05 +00003095** Make a page dirty. Set its dirty flag and add it to the dirty
3096** page list.
3097*/
3098static void makeDirty(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003099 sqlite3PcacheMakeDirty(pPg);
drh605ad8f2006-05-03 23:34:05 +00003100}
3101
3102/*
3103** Make a page clean. Clear its dirty bit and remove it from the
3104** dirty page list.
3105*/
3106static void makeClean(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003107 sqlite3PcacheMakeClean(pPg);
drh605ad8f2006-05-03 23:34:05 +00003108}
3109
3110
3111/*
drhed7c8552001-04-11 14:29:21 +00003112** Mark a data page as writeable. The page is written into the journal
3113** if it is not there already. This routine must be called before making
3114** changes to a page.
3115**
3116** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003117** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003118** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003119** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003120** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003121**
3122** If the journal file could not be written because the disk is full,
3123** then this routine returns SQLITE_FULL and does an immediate rollback.
3124** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003125** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003126** reset.
drhed7c8552001-04-11 14:29:21 +00003127*/
danielk19773b8a05f2007-03-19 17:44:26 +00003128static int pager_write(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003129 void *pData = pPg->pData;
drh69688d52001-04-14 16:38:23 +00003130 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003131 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003132
drh6446c4d2001-12-15 14:22:18 +00003133 /* Check for errors
3134 */
danielk1977efaaf572006-01-16 11:29:19 +00003135 if( pPager->errCode ){
3136 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003137 }
drh5e00f6c2001-09-13 13:46:56 +00003138 if( pPager->readOnly ){
3139 return SQLITE_PERM;
3140 }
drh6446c4d2001-12-15 14:22:18 +00003141
danielk197776572402004-06-25 02:38:54 +00003142 assert( !pPager->setMaster );
3143
danielk19773c407372005-02-15 02:54:14 +00003144 CHECK_PAGE(pPg);
3145
drh538f5702007-04-13 02:14:30 +00003146 /* If this page was previously acquired with noContent==1, that means
3147 ** we didn't really read in the content of the page. This can happen
3148 ** (for example) when the page is being moved to the freelist. But
3149 ** now we are (perhaps) moving the page off of the freelist for
3150 ** reuse and we need to know its original content so that content
3151 ** can be stored in the rollback journal. So do the read at this
3152 ** time.
3153 */
drhd33d5a82007-04-26 12:11:28 +00003154 rc = pager_get_content(pPg);
3155 if( rc ){
3156 return rc;
drh538f5702007-04-13 02:14:30 +00003157 }
3158
drh6446c4d2001-12-15 14:22:18 +00003159 /* Mark the page as dirty. If the page has already been written
3160 ** to the journal then we can return right away.
3161 */
drh605ad8f2006-05-03 23:34:05 +00003162 makeDirty(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00003163 if( (pPg->flags&PGHDR_IN_JOURNAL)
3164 && (pageInStatement(pPg) || pPager->stmtInUse==0)
3165 ){
drha6abd042004-06-09 17:37:22 +00003166 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003167 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003168 }else{
drh6446c4d2001-12-15 14:22:18 +00003169
danielk1977a0bf2652004-11-04 14:30:04 +00003170 /* If we get this far, it means that the page needs to be
3171 ** written to the transaction journal or the ckeckpoint journal
3172 ** or both.
3173 **
3174 ** First check to see that the transaction journal exists and
3175 ** create it if it does not.
3176 */
3177 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003178 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003179 if( rc!=SQLITE_OK ){
3180 return rc;
3181 }
3182 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00003183 if( !pPager->journalOpen && pPager->useJournal
3184 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00003185 rc = pager_open_journal(pPager);
3186 if( rc!=SQLITE_OK ) return rc;
3187 }
danielk1977a0bf2652004-11-04 14:30:04 +00003188 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003189 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003190
3191 /* The transaction journal now exists and we have a RESERVED or an
3192 ** EXCLUSIVE lock on the main database file. Write the current page to
3193 ** the transaction journal if it is not there already.
3194 */
danielk19778c0a7912008-08-20 14:49:23 +00003195 if( !(pPg->flags&PGHDR_IN_JOURNAL) && (pPager->journalOpen || MEMDB) ){
danielk1977a0bf2652004-11-04 14:30:04 +00003196 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00003197 if( MEMDB ){
drh4f0c5872007-03-26 22:05:01 +00003198 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003199 rc = sqlite3PcachePreserve(pPg, 0);
3200 if( rc!=SQLITE_OK ){
3201 return rc;
danielk1977a0bf2652004-11-04 14:30:04 +00003202 }
3203 }else{
drhbf4bca52007-09-06 22:19:14 +00003204 u32 cksum;
3205 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00003206
drh267cb322005-09-16 17:16:52 +00003207 /* We should never write to the journal file the page that
3208 ** contains the database locks. The following assert verifies
3209 ** that we do not. */
3210 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00003211 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00003212 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00003213 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
3214 if( rc==SQLITE_OK ){
3215 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
3216 pPager->journalOff + 4);
3217 pPager->journalOff += pPager->pageSize+4;
3218 }
3219 if( rc==SQLITE_OK ){
3220 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
3221 pPager->journalOff += 4;
3222 }
3223 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00003224 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00003225 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00003226 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
danielk19778c0a7912008-08-20 14:49:23 +00003227 PAGERID(pPager), pPg->pgno,
3228 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00003229
drhfd131da2007-08-07 17:13:03 +00003230 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00003231 ** transaction will be rolled back by the layer above.
3232 */
danielk1977a0bf2652004-11-04 14:30:04 +00003233 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00003234 return rc;
3235 }
danielk197707cb5602006-01-20 10:55:05 +00003236
danielk1977a0bf2652004-11-04 14:30:04 +00003237 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00003238 assert( pPager->pInJournal!=0 );
3239 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003240 if( !pPager->noSync ){
3241 pPg->flags |= PGHDR_NEED_SYNC;
3242 }
danielk1977a0bf2652004-11-04 14:30:04 +00003243 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00003244 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003245 }
drhac69b052004-05-12 13:30:07 +00003246 }
danielk197713adf8a2004-06-03 16:08:41 +00003247 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003248 if( !pPager->journalStarted && !pPager->noSync ){
3249 pPg->flags |= PGHDR_NEED_SYNC;
3250 }
drh4f0c5872007-03-26 22:05:01 +00003251 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk19778c0a7912008-08-20 14:49:23 +00003252 PAGERID(pPager), pPg->pgno,
3253 ((pPg->flags&PGHDR_NEED_SYNC)?1:0));
danielk1977a0bf2652004-11-04 14:30:04 +00003254 }
danielk19778c0a7912008-08-20 14:49:23 +00003255 if( pPg->flags&PGHDR_NEED_SYNC ){
danielk1977a0bf2652004-11-04 14:30:04 +00003256 pPager->needSync = 1;
3257 }
danielk19778c0a7912008-08-20 14:49:23 +00003258 pPg->flags |= PGHDR_IN_JOURNAL;
danielk1977a0bf2652004-11-04 14:30:04 +00003259 }
3260
3261 /* If the statement journal is open and the page is not in it,
3262 ** then write the current page to the statement journal. Note that
3263 ** the statement journal format differs from the standard journal format
3264 ** in that it omits the checksums and the header.
3265 */
danielk1977f35843b2007-04-07 15:03:17 +00003266 if( pPager->stmtInUse
3267 && !pageInStatement(pPg)
3268 && (int)pPg->pgno<=pPager->stmtSize
3269 ){
drha85f7e32008-08-28 02:26:07 +00003270 assert( (pPg->flags&PGHDR_IN_JOURNAL)
3271 || (int)pPg->pgno>pPager->origDbSize );
danielk1977a0bf2652004-11-04 14:30:04 +00003272 if( MEMDB ){
danielk19778c0a7912008-08-20 14:49:23 +00003273 rc = sqlite3PcachePreserve(pPg, 1);
3274 if( rc!=SQLITE_OK ){
3275 return rc;
danielk1977a0bf2652004-11-04 14:30:04 +00003276 }
drh4f0c5872007-03-26 22:05:01 +00003277 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003278 }else{
danielk197762079062007-08-15 17:08:46 +00003279 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00003280 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
3281 rc = write32bits(pPager->stfd, offset, pPg->pgno);
3282 if( rc==SQLITE_OK ){
3283 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
3284 }
drh4f0c5872007-03-26 22:05:01 +00003285 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003286 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00003287 return rc;
3288 }
danielk1977a0bf2652004-11-04 14:30:04 +00003289 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00003290 assert( pPager->pInStmt!=0 );
3291 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00003292 }
drhd9b02572001-04-15 00:37:09 +00003293 }
drhfa86c412002-02-02 15:01:15 +00003294 }
3295
3296 /* Update the database size and return.
3297 */
drh1aa2d8b2007-01-03 15:34:29 +00003298 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00003299 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003300 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00003301 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003302 pPager->dbSize++;
3303 }
drh306dc212001-05-21 13:45:10 +00003304 }
drh69688d52001-04-14 16:38:23 +00003305 return rc;
drhed7c8552001-04-11 14:29:21 +00003306}
3307
3308/*
danielk19774099f6e2007-03-19 11:25:20 +00003309** This function is used to mark a data-page as writable. It uses
3310** pager_write() to open a journal file (if it is not already open)
3311** and write the page *pData to the journal.
3312**
3313** The difference between this function and pager_write() is that this
3314** function also deals with the special case where 2 or more pages
3315** fit on a single disk sector. In this case all co-resident pages
3316** must have been written to the journal file before returning.
3317*/
danielk19773b8a05f2007-03-19 17:44:26 +00003318int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003319 int rc = SQLITE_OK;
3320
danielk19773b8a05f2007-03-19 17:44:26 +00003321 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003322 Pager *pPager = pPg->pPager;
3323 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3324
3325 if( !MEMDB && nPagePerSector>1 ){
3326 Pgno nPageCount; /* Total number of pages in database file */
3327 Pgno pg1; /* First page of the sector pPg is located on. */
3328 int nPage; /* Number of pages starting at pg1 to journal */
3329 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003330 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003331
3332 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3333 ** header to be written between the pages journaled by this function.
3334 */
3335 assert( pPager->doNotSync==0 );
3336 pPager->doNotSync = 1;
3337
3338 /* This trick assumes that both the page-size and sector-size are
3339 ** an integer power of 2. It sets variable pg1 to the identifier
3340 ** of the first page of the sector pPg is located on.
3341 */
3342 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3343
danielk1977ad0132d2008-06-07 08:58:22 +00003344 sqlite3PagerPagecount(pPager, (int *)&nPageCount);
danielk19774099f6e2007-03-19 11:25:20 +00003345 if( pPg->pgno>nPageCount ){
3346 nPage = (pPg->pgno - pg1)+1;
3347 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3348 nPage = nPageCount+1-pg1;
3349 }else{
3350 nPage = nPagePerSector;
3351 }
3352 assert(nPage>0);
3353 assert(pg1<=pPg->pgno);
3354 assert((pg1+nPage)>pPg->pgno);
3355
3356 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3357 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003358 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00003359 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00003360 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003361 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003362 if( rc==SQLITE_OK ){
3363 rc = pager_write(pPage);
danielk19778c0a7912008-08-20 14:49:23 +00003364 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003365 needSync = 1;
3366 }
danielk19773b8a05f2007-03-19 17:44:26 +00003367 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003368 }
3369 }
drhc81945e2008-03-10 14:12:53 +00003370 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk19778c0a7912008-08-20 14:49:23 +00003371 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003372 needSync = 1;
3373 }
danielk19778c0a7912008-08-20 14:49:23 +00003374 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003375 }
3376 }
3377
danielk1977dd97a492007-08-22 18:54:32 +00003378 /* If the PgHdr.needSync flag is set for any of the nPage pages
3379 ** starting at pg1, then it needs to be set for all of them. Because
3380 ** writing to any of these nPage pages may damage the others, the
3381 ** journal file must contain sync()ed copies of all of them
3382 ** before any of them can be written out to the database file.
3383 */
3384 if( needSync ){
drhb3df2e12008-09-17 20:06:26 +00003385 assert( !MEMDB && pPager->noSync==0 );
danielk1977dd97a492007-08-22 18:54:32 +00003386 for(ii=0; ii<nPage && needSync; ii++){
3387 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
danielk19778c0a7912008-08-20 14:49:23 +00003388 if( pPage ) pPage->flags |= PGHDR_NEED_SYNC;
3389 sqlite3PagerUnref(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003390 }
3391 assert(pPager->needSync);
3392 }
3393
danielk19774099f6e2007-03-19 11:25:20 +00003394 assert( pPager->doNotSync==1 );
3395 pPager->doNotSync = 0;
3396 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003397 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003398 }
3399 return rc;
3400}
3401
3402/*
drhaacc5432002-01-06 17:07:40 +00003403** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003404** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003405** to change the content of the page.
3406*/
danielk19777d3a6662006-01-23 16:21:05 +00003407#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003408int sqlite3PagerIswriteable(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003409 return pPg->flags&PGHDR_DIRTY;
drh6019e162001-07-02 17:51:45 +00003410}
danielk19777d3a6662006-01-23 16:21:05 +00003411#endif
drh6019e162001-07-02 17:51:45 +00003412
drh001bbcb2003-03-19 03:14:00 +00003413/*
drh30e58752002-03-02 20:41:57 +00003414** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003415** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00003416** that page might be marked as dirty.
3417**
3418** The overlying software layer calls this routine when all of the data
3419** on the given page is unused. The pager marks the page as clean so
3420** that it does not get written to disk.
3421**
3422** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003423** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003424** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003425**
3426** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003427** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003428** will thereafter be ignored. This is necessary to avoid a problem
3429** where a page with data is added to the freelist during one part of
3430** a transaction then removed from the freelist during a later part
3431** of the same transaction and reused for some other purpose. When it
3432** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003433** the sqlite3PagerDontRollback() routine is called. But because the
3434** page contains critical data, we still need to be sure it gets
3435** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003436*/
danielk1977a1fa00d2008-08-27 15:16:33 +00003437int sqlite3PagerDontWrite(DbPage *pDbPage){
drh538f5702007-04-13 02:14:30 +00003438 PgHdr *pPg = pDbPage;
3439 Pager *pPager = pPg->pPager;
danielk1977a1fa00d2008-08-27 15:16:33 +00003440 int rc;
drh8e298f92002-07-06 16:28:47 +00003441
danielk1977a1fa00d2008-08-27 15:16:33 +00003442 if( MEMDB || pPg->pgno>pPager->origDbSize ){
3443 return SQLITE_OK;
3444 }
3445 if( pPager->pAlwaysRollback==0 ){
3446 assert( pPager->pInJournal );
3447 pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->origDbSize);
3448 if( !pPager->pAlwaysRollback ){
3449 return SQLITE_NOMEM;
3450 }
3451 }
3452 rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno);
3453
3454 if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00003455 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00003456 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
3457 /* If this pages is the last page in the file and the file has grown
3458 ** during the current transaction, then do NOT mark the page as clean.
3459 ** When the database file grows, we must make sure that the last page
3460 ** gets written at least once so that the disk file will be the correct
3461 ** size. If you do not write this page and the size of the file
3462 ** on the disk ends up being too small, that can lead to database
3463 ** corruption during the next transaction.
3464 */
3465 }else{
drh538f5702007-04-13 02:14:30 +00003466 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3467 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
danielk197733e32162008-08-23 18:53:08 +00003468 pPg->flags |= PGHDR_DONT_WRITE;
danielk19773c407372005-02-15 02:54:14 +00003469#ifdef SQLITE_CHECK_PAGES
3470 pPg->pageHash = pager_pagehash(pPg);
3471#endif
drh8124a302002-06-25 14:43:57 +00003472 }
drh30e58752002-03-02 20:41:57 +00003473 }
danielk1977a1fa00d2008-08-27 15:16:33 +00003474 return rc;
drh30e58752002-03-02 20:41:57 +00003475}
3476
3477/*
3478** A call to this routine tells the pager that if a rollback occurs,
3479** it is not necessary to restore the data on the given page. This
3480** means that the pager does not have to record the given page in the
3481** rollback journal.
drh538f5702007-04-13 02:14:30 +00003482**
3483** If we have not yet actually read the content of this page (if
3484** the PgHdr.needRead flag is set) then this routine acts as a promise
3485** that we will never need to read the page content in the future.
3486** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003487*/
danielk19773b8a05f2007-03-19 17:44:26 +00003488void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003489 Pager *pPager = pPg->pPager;
3490
drhd3627af2006-12-18 18:34:51 +00003491 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00003492
3493 /* If the journal file is not open, or DontWrite() has been called on
3494 ** this page (DontWrite() sets the alwaysRollback flag), then this
3495 ** function is a no-op.
3496 */
danielk1977a1fa00d2008-08-27 15:16:33 +00003497 if( pPager->journalOpen==0
3498 || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno)
3499 || pPg->pgno>pPager->origDbSize
danielk19778c0a7912008-08-20 14:49:23 +00003500 ){
danielk197787c29a92008-01-18 11:33:16 +00003501 return;
3502 }
danielk1977a55e9352008-01-21 13:04:34 +00003503 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
3504
drhc5d0bd92008-04-14 01:00:57 +00003505#ifdef SQLITE_SECURE_DELETE
drha85f7e32008-08-28 02:26:07 +00003506 if( (pPg->flags & PGHDR_IN_JOURNAL)!=0 || (int)pPg->pgno>pPager->origDbSize ){
drhc5d0bd92008-04-14 01:00:57 +00003507 return;
3508 }
3509#endif
3510
3511 /* If SECURE_DELETE is disabled, then there is no way that this
3512 ** routine can be called on a page for which sqlite3PagerDontWrite()
3513 ** has not been previously called during the same transaction.
3514 ** And if DontWrite() has previously been called, the following
3515 ** conditions must be met.
drh10131482008-07-11 03:34:09 +00003516 **
3517 ** (Later:) Not true. If the database is corrupted by having duplicate
3518 ** pages on the freelist (ex: corrupt9.test) then the following is not
3519 ** necessarily true:
danielk1977a55e9352008-01-21 13:04:34 +00003520 */
drh10131482008-07-11 03:34:09 +00003521 /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ); */
danielk1977a55e9352008-01-21 13:04:34 +00003522
drhf5e7bb52008-02-18 14:47:33 +00003523 assert( pPager->pInJournal!=0 );
3524 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003525 pPg->flags |= PGHDR_IN_JOURNAL;
3526 pPg->flags &= ~PGHDR_NEED_READ;
danielk1977a55e9352008-01-21 13:04:34 +00003527 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00003528 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00003529 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00003530 }
danielk1977a55e9352008-01-21 13:04:34 +00003531 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
3532 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003533}
3534
drhac69b052004-05-12 13:30:07 +00003535
drh30e58752002-03-02 20:41:57 +00003536/*
drh80e35f42007-03-30 14:06:34 +00003537** This routine is called to increment the database file change-counter,
3538** stored at byte 24 of the pager file.
3539*/
danielk1977c7b60172007-08-22 11:22:03 +00003540static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00003541 PgHdr *pPgHdr;
3542 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00003543 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00003544
drh701bb3b2008-08-02 03:50:39 +00003545#ifndef SQLITE_ENABLE_ATOMIC_WRITE
3546 assert( isDirect==0 ); /* isDirect is only true for atomic writes */
3547#endif
drh80e35f42007-03-30 14:06:34 +00003548 if( !pPager->changeCountDone ){
3549 /* Open page 1 of the file for writing. */
3550 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3551 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00003552
3553 if( !isDirect ){
3554 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00003555 if( rc!=SQLITE_OK ){
3556 sqlite3PagerUnref(pPgHdr);
3557 return rc;
3558 }
danielk1977c7b60172007-08-22 11:22:03 +00003559 }
3560
drh80e35f42007-03-30 14:06:34 +00003561 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003562 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003563 change_counter++;
danielk19778c0a7912008-08-20 14:49:23 +00003564 put32bits(((char*)pPgHdr->pData)+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00003565
drh701bb3b2008-08-02 03:50:39 +00003566#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977c7b60172007-08-22 11:22:03 +00003567 if( isDirect && pPager->fd->pMethods ){
danielk19778c0a7912008-08-20 14:49:23 +00003568 const void *zBuf = pPgHdr->pData;
danielk1977c7b60172007-08-22 11:22:03 +00003569 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
3570 }
drh701bb3b2008-08-02 03:50:39 +00003571#endif
danielk1977c7b60172007-08-22 11:22:03 +00003572
drh80e35f42007-03-30 14:06:34 +00003573 /* Release the page reference. */
3574 sqlite3PagerUnref(pPgHdr);
3575 pPager->changeCountDone = 1;
3576 }
danielk1977c7b60172007-08-22 11:22:03 +00003577 return rc;
drh80e35f42007-03-30 14:06:34 +00003578}
3579
3580/*
danielk1977f653d782008-03-20 11:04:21 +00003581** Sync the pager file to disk.
3582*/
3583int sqlite3PagerSync(Pager *pPager){
3584 int rc;
drh7426f862008-08-26 21:07:26 +00003585 if( MEMDB ){
3586 rc = SQLITE_OK;
3587 }else{
3588 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
3589 }
danielk1977f653d782008-03-20 11:04:21 +00003590 return rc;
3591}
3592
3593/*
drh80e35f42007-03-30 14:06:34 +00003594** Sync the database file for the pager pPager. zMaster points to the name
3595** of a master journal file that should be written into the individual
3596** journal file. zMaster may be NULL, which is interpreted as no master
3597** journal (a single database transaction).
3598**
3599** This routine ensures that the journal is synced, all dirty pages written
3600** to the database file and the database file synced. The only thing that
3601** remains to commit the transaction is to delete the journal file (or
3602** master journal file if specified).
3603**
3604** Note that if zMaster==NULL, this does not overwrite a previous value
3605** passed to an sqlite3PagerCommitPhaseOne() call.
3606**
3607** If parameter nTrunc is non-zero, then the pager file is truncated to
3608** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00003609**
3610** If the final parameter - noSync - is true, then the database file itself
3611** is not synced. The caller must call sqlite3PagerSync() directly to
3612** sync the database file before calling CommitPhaseTwo() to delete the
3613** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00003614*/
danielk1977f653d782008-03-20 11:04:21 +00003615int sqlite3PagerCommitPhaseOne(
3616 Pager *pPager,
3617 const char *zMaster,
3618 Pgno nTrunc,
3619 int noSync
3620){
drh80e35f42007-03-30 14:06:34 +00003621 int rc = SQLITE_OK;
3622
danielk1977dad31b52008-05-15 11:08:07 +00003623 if( pPager->errCode ){
3624 return pPager->errCode;
3625 }
3626
drhd138c012008-05-13 00:58:18 +00003627 /* If no changes have been made, we can leave the transaction early.
3628 */
3629 if( pPager->dbModified==0 &&
3630 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3631 pPager->exclusiveMode!=0) ){
3632 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3633 return SQLITE_OK;
3634 }
3635
drh80e35f42007-03-30 14:06:34 +00003636 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3637 pPager->zFilename, zMaster, nTrunc);
3638
3639 /* If this is an in-memory db, or no pages have been written to, or this
3640 ** function has already been called, it is a no-op.
3641 */
3642 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3643 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00003644
danielk1977c7b60172007-08-22 11:22:03 +00003645#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3646 /* The atomic-write optimization can be used if all of the
3647 ** following are true:
3648 **
3649 ** + The file-system supports the atomic-write property for
3650 ** blocks of size page-size, and
3651 ** + This commit is not part of a multi-file transaction, and
3652 ** + Exactly one page has been modified and store in the journal file.
3653 **
3654 ** If the optimization can be used, then the journal file will never
3655 ** be created for this transaction.
3656 */
danielk19774d60af92008-09-08 15:35:06 +00003657 int useAtomicWrite;
danielk19778c0a7912008-08-20 14:49:23 +00003658 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
danielk19774d60af92008-09-08 15:35:06 +00003659 useAtomicWrite = (
danielk1977f55b8992007-08-24 08:15:53 +00003660 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00003661 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00003662 pPager->journalOff==jrnlBufferSize(pPager) &&
3663 nTrunc==0 &&
danielk19778c0a7912008-08-20 14:49:23 +00003664 (pPg==0 || pPg->pDirty==0)
danielk1977f55b8992007-08-24 08:15:53 +00003665 );
danielk1977700b9c52008-04-24 12:37:40 +00003666 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00003667 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00003668 /* Update the nRec field in the journal file. */
3669 int offset = pPager->journalHdr + sizeof(aJournalMagic);
3670 assert(pPager->nRec==1);
3671 rc = write32bits(pPager->jfd, offset, pPager->nRec);
3672
3673 /* Update the db file change counter. The following call will modify
3674 ** the in-memory representation of page 1 to include the updated
3675 ** change counter and then write page 1 directly to the database
3676 ** file. Because of the atomic-write property of the host file-system,
3677 ** this is safe.
3678 */
danielk1977ae72d982007-10-03 08:46:44 +00003679 if( rc==SQLITE_OK ){
3680 rc = pager_incr_changecounter(pPager, 1);
3681 }
danielk1977f55b8992007-08-24 08:15:53 +00003682 }else{
3683 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00003684 }
3685
danielk1977ae72d982007-10-03 08:46:44 +00003686 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00003687#endif
3688
drh80e35f42007-03-30 14:06:34 +00003689 /* If a master journal file name has already been written to the
3690 ** journal file, then no sync is required. This happens when it is
3691 ** written, then the process fails to upgrade from a RESERVED to an
3692 ** EXCLUSIVE lock. The next time the process tries to commit the
3693 ** transaction the m-j name will have already been written.
3694 */
3695 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00003696 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003697 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00003698 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00003699#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00003700 if( nTrunc!=0 ){
3701 /* If this transaction has made the database smaller, then all pages
3702 ** being discarded by the truncation must be written to the journal
3703 ** file.
3704 */
3705 Pgno i;
3706 int iSkip = PAGER_MJ_PGNO(pPager);
3707 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3708 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
3709 rc = sqlite3PagerGet(pPager, i, &pPg);
3710 if( rc!=SQLITE_OK ) goto sync_exit;
3711 rc = sqlite3PagerWrite(pPg);
3712 sqlite3PagerUnref(pPg);
3713 if( rc!=SQLITE_OK ) goto sync_exit;
3714 }
3715 }
3716 }
drh80e35f42007-03-30 14:06:34 +00003717#endif
danielk197771aa7ff2008-05-20 07:05:09 +00003718 rc = writeMasterJournal(pPager, zMaster);
3719 if( rc!=SQLITE_OK ) goto sync_exit;
3720 rc = syncJournal(pPager);
3721 }
drh80e35f42007-03-30 14:06:34 +00003722 }
danielk1977c7b60172007-08-22 11:22:03 +00003723 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00003724
3725#ifndef SQLITE_OMIT_AUTOVACUUM
3726 if( nTrunc!=0 ){
3727 rc = sqlite3PagerTruncate(pPager, nTrunc);
3728 if( rc!=SQLITE_OK ) goto sync_exit;
3729 }
3730#endif
3731
3732 /* Write all dirty pages to the database file */
danielk19778c0a7912008-08-20 14:49:23 +00003733 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003734 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00003735 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00003736 assert( rc!=SQLITE_IOERR_BLOCKED );
3737 /* The error might have left the dirty list all fouled up here,
3738 ** but that does not matter because if the if the dirty list did
3739 ** get corrupted, then the transaction will roll back and
3740 ** discard the dirty list. There is an assert in
3741 ** pager_get_all_dirty_pages() that verifies that no attempt
3742 ** is made to use an invalid dirty list.
3743 */
drh153c62c2007-08-24 03:51:33 +00003744 goto sync_exit;
3745 }
danielk19778c0a7912008-08-20 14:49:23 +00003746 sqlite3PcacheCleanAll(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003747
3748 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00003749 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00003750 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00003751 }
3752 IOTRACE(("DBSYNC %p\n", pPager))
3753
3754 pPager->state = PAGER_SYNCED;
3755 }else if( MEMDB && nTrunc!=0 ){
3756 rc = sqlite3PagerTruncate(pPager, nTrunc);
3757 }
3758
3759sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00003760 if( rc==SQLITE_IOERR_BLOCKED ){
3761 /* pager_incr_changecounter() may attempt to obtain an exclusive
3762 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00003763 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00003764 * better to return SQLITE_BUSY.
3765 */
3766 rc = SQLITE_BUSY;
3767 }
drh80e35f42007-03-30 14:06:34 +00003768 return rc;
3769}
3770
3771
3772/*
drhed7c8552001-04-11 14:29:21 +00003773** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003774**
3775** If the commit fails for any reason, a rollback attempt is made
3776** and an error code is returned. If the commit worked, SQLITE_OK
3777** is returned.
drhed7c8552001-04-11 14:29:21 +00003778*/
drh80e35f42007-03-30 14:06:34 +00003779int sqlite3PagerCommitPhaseTwo(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003780 int rc = SQLITE_OK;
drhd9b02572001-04-15 00:37:09 +00003781
danielk1977efaaf572006-01-16 11:29:19 +00003782 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003783 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003784 }
drha6abd042004-06-09 17:37:22 +00003785 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003786 return SQLITE_ERROR;
3787 }
drhd138c012008-05-13 00:58:18 +00003788 if( pPager->dbModified==0 &&
3789 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3790 pPager->exclusiveMode!=0) ){
3791 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3792 return SQLITE_OK;
3793 }
drh4f0c5872007-03-26 22:05:01 +00003794 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003795 if( MEMDB ){
danielk19778c0a7912008-08-20 14:49:23 +00003796 sqlite3PcacheCommit(pPager->pPCache, 0);
3797 sqlite3PcacheCleanAll(pPager->pPCache);
drhb3df2e12008-09-17 20:06:26 +00003798 sqlite3PcacheAssertFlags(pPager->pPCache, 0, PGHDR_IN_JOURNAL);
drha6abd042004-06-09 17:37:22 +00003799 pPager->state = PAGER_SHARED;
danielk19778c0a7912008-08-20 14:49:23 +00003800 }else{
3801 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
3802 rc = pager_end_transaction(pPager, pPager->setMaster);
3803 rc = pager_error(pPager, rc);
drhac69b052004-05-12 13:30:07 +00003804 }
drh86f8c192007-08-22 00:39:19 +00003805 return rc;
drhed7c8552001-04-11 14:29:21 +00003806}
3807
3808/*
drha6abd042004-06-09 17:37:22 +00003809** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003810** All in-memory cache pages revert to their original data contents.
3811** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003812**
3813** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003814** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003815** process is writing trash into the journal file (SQLITE_CORRUPT) or
3816** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3817** codes are returned for all these occasions. Otherwise,
3818** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003819*/
danielk19773b8a05f2007-03-19 17:44:26 +00003820int sqlite3PagerRollback(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003821 int rc = SQLITE_OK;
drh4f0c5872007-03-26 22:05:01 +00003822 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003823 if( MEMDB ){
danielk1977eaa06f62008-09-18 17:34:44 +00003824 sqlite3PcacheRollback(pPager->pPCache, 1, pPager->xReiniter);
3825 sqlite3PcacheRollback(pPager->pPCache, 0, pPager->xReiniter);
danielk19778c0a7912008-08-20 14:49:23 +00003826 sqlite3PcacheCleanAll(pPager->pPCache);
drhb3df2e12008-09-17 20:06:26 +00003827 sqlite3PcacheAssertFlags(pPager->pPCache, 0, PGHDR_IN_JOURNAL);
drhac69b052004-05-12 13:30:07 +00003828 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00003829 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00003830 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003831 pPager->state = PAGER_SHARED;
danielk19778c0a7912008-08-20 14:49:23 +00003832 }else if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00003833 rc = pager_end_transaction(pPager, pPager->setMaster);
danielk19778c0a7912008-08-20 14:49:23 +00003834 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003835 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003836 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003837 }
danielk19778c0a7912008-08-20 14:49:23 +00003838 rc = pPager->errCode;
drha6abd042004-06-09 17:37:22 +00003839 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003840 if( pPager->state==PAGER_RESERVED ){
3841 int rc2;
3842 rc = pager_playback(pPager, 0);
3843 rc2 = pager_end_transaction(pPager, pPager->setMaster);
3844 if( rc==SQLITE_OK ){
3845 rc = rc2;
3846 }
3847 }else{
3848 rc = pager_playback(pPager, 0);
3849 }
danielk197707cb5602006-01-20 10:55:05 +00003850
danielk19778c0a7912008-08-20 14:49:23 +00003851 pPager->dbSize = -1;
3852
3853 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3854 ** cache. So call pager_error() on the way out to make any error
3855 ** persistent.
3856 */
3857 rc = pager_error(pPager, rc);
3858 }
drh86f8c192007-08-22 00:39:19 +00003859 return rc;
drh98808ba2001-10-18 12:34:46 +00003860}
drhd9b02572001-04-15 00:37:09 +00003861
3862/*
drh5e00f6c2001-09-13 13:46:56 +00003863** Return TRUE if the database file is opened read-only. Return FALSE
3864** if the database is (in theory) writable.
3865*/
danielk19773b8a05f2007-03-19 17:44:26 +00003866int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003867 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003868}
3869
3870/*
drh0f7eb612006-08-08 13:51:43 +00003871** Return the number of references to the pager.
3872*/
danielk19773b8a05f2007-03-19 17:44:26 +00003873int sqlite3PagerRefcount(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003874 return sqlite3PcacheRefCount(pPager->pPCache);
drh0f7eb612006-08-08 13:51:43 +00003875}
3876
danielk197771d5d2c2008-09-29 11:49:47 +00003877/*
3878** Return the number of references to the specified page.
3879*/
3880int sqlite3PagerPageRefcount(DbPage *pPage){
3881 return sqlite3PcachePageRefcount(pPage);
3882}
3883
drh0f7eb612006-08-08 13:51:43 +00003884#ifdef SQLITE_TEST
3885/*
drhd9b02572001-04-15 00:37:09 +00003886** This routine is used for testing and analysis only.
3887*/
danielk19773b8a05f2007-03-19 17:44:26 +00003888int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003889 static int a[11];
danielk19778c0a7912008-08-20 14:49:23 +00003890 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
3891 a[1] = sqlite3PcachePagecount(pPager->pPCache);
3892 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
drhd9b02572001-04-15 00:37:09 +00003893 a[3] = pPager->dbSize;
3894 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003895 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003896 a[6] = pPager->nHit;
3897 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003898 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003899 a[9] = pPager->nRead;
3900 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003901 return a;
3902}
danielk197717b90b52008-06-06 11:11:25 +00003903int sqlite3PagerIsMemdb(Pager *pPager){
3904 return MEMDB;
3905}
drh0f7eb612006-08-08 13:51:43 +00003906#endif
drhdd793422001-06-28 01:54:48 +00003907
drhfa86c412002-02-02 15:01:15 +00003908/*
drhac69b052004-05-12 13:30:07 +00003909** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003910**
3911** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003912** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003913** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003914*/
drh86f8c192007-08-22 00:39:19 +00003915static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003916 int rc;
drhac69b052004-05-12 13:30:07 +00003917 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00003918 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00003919 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00003920 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003921 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003922 pPager->stmtInUse = 1;
3923 pPager->stmtSize = pPager->dbSize;
3924 return SQLITE_OK;
3925 }
drhda47d772002-12-02 04:25:19 +00003926 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003927 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003928 return SQLITE_OK;
3929 }
drhfa86c412002-02-02 15:01:15 +00003930 assert( pPager->journalOpen );
drhf5e7bb52008-02-18 14:47:33 +00003931 assert( pPager->pInStmt==0 );
3932 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00003933 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00003934 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00003935 return SQLITE_NOMEM;
3936 }
danielk197776572402004-06-25 02:38:54 +00003937 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003938 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003939 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003940 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003941 if( !pPager->stmtOpen ){
danielk197717b90b52008-06-06 11:11:25 +00003942 rc = sqlite3PagerOpentemp(pPager, pPager->stfd, SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00003943 if( rc ){
3944 goto stmt_begin_failed;
3945 }
drhac69b052004-05-12 13:30:07 +00003946 pPager->stmtOpen = 1;
3947 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003948 }
drhac69b052004-05-12 13:30:07 +00003949 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003950 return SQLITE_OK;
3951
drhac69b052004-05-12 13:30:07 +00003952stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00003953 if( pPager->pInStmt ){
3954 sqlite3BitvecDestroy(pPager->pInStmt);
3955 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003956 }
3957 return rc;
3958}
drh86f8c192007-08-22 00:39:19 +00003959int sqlite3PagerStmtBegin(Pager *pPager){
3960 int rc;
drh86f8c192007-08-22 00:39:19 +00003961 rc = pagerStmtBegin(pPager);
drh86f8c192007-08-22 00:39:19 +00003962 return rc;
3963}
drhfa86c412002-02-02 15:01:15 +00003964
3965/*
drhac69b052004-05-12 13:30:07 +00003966** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003967*/
danielk19773b8a05f2007-03-19 17:44:26 +00003968int sqlite3PagerStmtCommit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003969 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003970 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003971 if( !MEMDB ){
drhf5e7bb52008-02-18 14:47:33 +00003972 sqlite3BitvecDestroy(pPager->pInStmt);
3973 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003974 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003975 sqlite3PcacheCommit(pPager->pPCache, 1);
drhac69b052004-05-12 13:30:07 +00003976 }
3977 pPager->stmtNRec = 0;
3978 pPager->stmtInUse = 0;
drh663fc632002-02-02 18:49:19 +00003979 }
drhac69b052004-05-12 13:30:07 +00003980 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003981 return SQLITE_OK;
3982}
3983
3984/*
drhac69b052004-05-12 13:30:07 +00003985** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003986*/
danielk19773b8a05f2007-03-19 17:44:26 +00003987int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003988 int rc;
drhac69b052004-05-12 13:30:07 +00003989 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003990 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003991 if( MEMDB ){
danielk1977eaa06f62008-09-18 17:34:44 +00003992 sqlite3PcacheRollback(pPager->pPCache, 1, pPager->xReiniter);
drhac69b052004-05-12 13:30:07 +00003993 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00003994 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00003995 rc = SQLITE_OK;
3996 }else{
3997 rc = pager_stmt_playback(pPager);
3998 }
danielk19773b8a05f2007-03-19 17:44:26 +00003999 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00004000 }else{
4001 rc = SQLITE_OK;
4002 }
drhac69b052004-05-12 13:30:07 +00004003 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00004004 return rc;
4005}
4006
drh73509ee2003-04-06 20:44:45 +00004007/*
4008** Return the full pathname of the database file.
4009*/
danielk19773b8a05f2007-03-19 17:44:26 +00004010const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004011 return pPager->zFilename;
4012}
4013
drhb20ea9d2004-02-09 01:20:36 +00004014/*
drhd0679ed2007-08-28 22:24:34 +00004015** Return the VFS structure for the pager.
4016*/
4017const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
4018 return pPager->pVfs;
4019}
4020
4021/*
drhcc6bb3e2007-08-31 16:11:35 +00004022** Return the file handle for the database file associated
4023** with the pager. This might return NULL if the file has
4024** not yet been opened.
4025*/
4026sqlite3_file *sqlite3PagerFile(Pager *pPager){
4027 return pPager->fd;
4028}
4029
4030/*
danielk19775865e3d2004-06-14 06:03:57 +00004031** Return the directory of the database file.
4032*/
danielk19773b8a05f2007-03-19 17:44:26 +00004033const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004034 return pPager->zDirectory;
4035}
4036
4037/*
4038** Return the full pathname of the journal file.
4039*/
danielk19773b8a05f2007-03-19 17:44:26 +00004040const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004041 return pPager->zJournal;
4042}
4043
4044/*
drh2c8997b2005-08-27 16:36:48 +00004045** Return true if fsync() calls are disabled for this pager. Return FALSE
4046** if fsync()s are executed normally.
4047*/
danielk19773b8a05f2007-03-19 17:44:26 +00004048int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004049 return pPager->noSync;
4050}
4051
drh7c4ac0c2007-04-05 11:25:58 +00004052#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004053/*
drhb20ea9d2004-02-09 01:20:36 +00004054** Set the codec for this pager
4055*/
danielk19773b8a05f2007-03-19 17:44:26 +00004056void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004057 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004058 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004059 void *pCodecArg
4060){
4061 pPager->xCodec = xCodec;
4062 pPager->pCodecArg = pCodecArg;
4063}
drh7c4ac0c2007-04-05 11:25:58 +00004064#endif
drhb20ea9d2004-02-09 01:20:36 +00004065
danielk1977687566d2004-11-02 12:56:41 +00004066#ifndef SQLITE_OMIT_AUTOVACUUM
4067/*
danielk197787c29a92008-01-18 11:33:16 +00004068** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004069**
drh5e385312007-06-16 04:42:12 +00004070** There must be no references to the page previously located at
4071** pgno (which we call pPgOld) though that page is allowed to be
drhb3df2e12008-09-17 20:06:26 +00004072** in cache. If the page previously located at pgno is not already
drh5e385312007-06-16 04:42:12 +00004073** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004074**
drh5e385312007-06-16 04:42:12 +00004075** References to the page pPg remain valid. Updating any
4076** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004077** allocated along with the page) is the responsibility of the caller.
4078**
danielk19775fd057a2005-03-09 13:09:43 +00004079** A transaction must be active when this routine is called. It used to be
4080** required that a statement transaction was not active, but this restriction
4081** has been removed (CREATE INDEX needs to move a page when a statement
4082** transaction is active).
danielk19774c999992008-07-16 18:17:55 +00004083**
4084** If the fourth argument, isCommit, is non-zero, then this page is being
4085** moved as part of a database reorganization just before the transaction
4086** is being committed. In this case, it is guaranteed that the database page
4087** pPg refers to will not be written to again within this transaction.
danielk1977687566d2004-11-02 12:56:41 +00004088*/
danielk19774c999992008-07-16 18:17:55 +00004089int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
drh5e385312007-06-16 04:42:12 +00004090 PgHdr *pPgOld; /* The page being overwritten. */
danielk197794daf7f2004-11-08 09:26:09 +00004091 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004092
danielk1977687566d2004-11-02 12:56:41 +00004093 assert( pPg->nRef>0 );
4094
drh4f0c5872007-03-26 22:05:01 +00004095 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk19778c0a7912008-08-20 14:49:23 +00004096 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno);
drhb0603412007-02-28 04:47:26 +00004097 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004098
danielk1977b4626a32007-04-28 15:47:43 +00004099 pager_get_content(pPg);
danielk19774c999992008-07-16 18:17:55 +00004100
4101 /* If the journal needs to be sync()ed before page pPg->pgno can
4102 ** be written to, store pPg->pgno in local variable needSyncPgno.
4103 **
4104 ** If the isCommit flag is set, there is no need to remember that
4105 ** the journal needs to be sync()ed before database page pPg->pgno
4106 ** can be written to. The caller has already promised not to write to it.
4107 */
danielk19778c0a7912008-08-20 14:49:23 +00004108 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
danielk197794daf7f2004-11-08 09:26:09 +00004109 needSyncPgno = pPg->pgno;
danielk19778c0a7912008-08-20 14:49:23 +00004110 assert( (pPg->flags&PGHDR_IN_JOURNAL) || (int)pgno>pPager->origDbSize );
4111 assert( pPg->flags&PGHDR_DIRTY );
danielk1977ae825582004-11-23 09:06:55 +00004112 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004113 }
4114
danielk1977ef73ee92004-11-06 12:26:07 +00004115 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00004116 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00004117 ** page pgno before the 'move' operation, it needs to be retained
4118 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004119 */
danielk19778c0a7912008-08-20 14:49:23 +00004120 pPg->flags &= ~(PGHDR_NEED_SYNC|PGHDR_IN_JOURNAL);
danielk1977687566d2004-11-02 12:56:41 +00004121 pPgOld = pager_lookup(pPager, pgno);
danielk19778c0a7912008-08-20 14:49:23 +00004122 assert( !pPgOld || pPgOld->nRef==1 );
danielk1977687566d2004-11-02 12:56:41 +00004123 if( pPgOld ){
danielk19778c0a7912008-08-20 14:49:23 +00004124 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
drh5e385312007-06-16 04:42:12 +00004125 }
danielk19778c0a7912008-08-20 14:49:23 +00004126 if( sqlite3BitvecTest(pPager->pInJournal, pgno) ){
drhb3df2e12008-09-17 20:06:26 +00004127 assert( !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00004128 pPg->flags |= PGHDR_IN_JOURNAL;
4129 }
danielk1977687566d2004-11-02 12:56:41 +00004130
danielk19778c0a7912008-08-20 14:49:23 +00004131 sqlite3PcacheMove(pPg, pgno);
4132 if( pPgOld ){
4133 sqlite3PcacheMove(pPgOld, 0);
4134 sqlite3PcacheRelease(pPgOld);
danielk1977f5fdda82004-11-03 08:44:05 +00004135 }
danielk1977f5fdda82004-11-03 08:44:05 +00004136
drh605ad8f2006-05-03 23:34:05 +00004137 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004138 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004139 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00004140
danielk197794daf7f2004-11-08 09:26:09 +00004141 if( needSyncPgno ){
4142 /* If needSyncPgno is non-zero, then the journal file needs to be
4143 ** sync()ed before any data is written to database file page needSyncPgno.
4144 ** Currently, no such page exists in the page-cache and the
danielk19774c999992008-07-16 18:17:55 +00004145 ** "is journaled" bitvec flag has been set. This needs to be remedied by
4146 ** loading the page into the pager-cache and setting the PgHdr.needSync
4147 ** flag.
danielk1977ae825582004-11-23 09:06:55 +00004148 **
danielk1977a98d7b42008-01-18 13:42:54 +00004149 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00004150 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00004151 ** array. Otherwise, if the page is loaded and written again in
4152 ** this transaction, it may be written to the database file before
4153 ** it is synced into the journal file. This way, it may end up in
4154 ** the journal file twice, but that is not a problem.
4155 **
danielk19773b8a05f2007-03-19 17:44:26 +00004156 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004157 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004158 */
4159 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004160 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004161 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004162 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00004163 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00004164 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
4165 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00004166 }
danielk197787c29a92008-01-18 11:33:16 +00004167 return rc;
4168 }
danielk1977ae825582004-11-23 09:06:55 +00004169 pPager->needSync = 1;
drhb3df2e12008-09-17 20:06:26 +00004170 assert( pPager->noSync==0 && !MEMDB );
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){
danielk197771d5d2c2008-09-29 11:49:47 +00004185 assert( pPg->nRef>0 || pPg->pPager->memDb );
danielk19778c0a7912008-08-20 14:49:23 +00004186 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/*
drh04335882008-09-26 21:08:08 +00004221** Get/set the journal-mode for this pager. Parameter eMode must be one of:
drh3b020132008-04-17 17:02:01 +00004222**
drh04335882008-09-26 21:08:08 +00004223** PAGER_JOURNALMODE_QUERY
4224** PAGER_JOURNALMODE_DELETE
4225** PAGER_JOURNALMODE_TRUNCATE
4226** PAGER_JOURNALMODE_PERSIST
4227** PAGER_JOURNALMODE_OFF
4228**
4229** If the parameter is not _QUERY, then the journal-mode is set to the
4230** value specified.
4231**
4232** The returned indicate the current (possibly updated)
drh3b020132008-04-17 17:02:01 +00004233** journal-mode.
4234*/
4235int sqlite3PagerJournalMode(Pager *pPager, int eMode){
4236 assert( eMode==PAGER_JOURNALMODE_QUERY
4237 || eMode==PAGER_JOURNALMODE_DELETE
drh04335882008-09-26 21:08:08 +00004238 || eMode==PAGER_JOURNALMODE_TRUNCATE
drhfdc40e92008-04-17 20:59:37 +00004239 || eMode==PAGER_JOURNALMODE_PERSIST
4240 || eMode==PAGER_JOURNALMODE_OFF );
drh3b020132008-04-17 17:02:01 +00004241 assert( PAGER_JOURNALMODE_QUERY<0 );
drhfdc40e92008-04-17 20:59:37 +00004242 if( eMode>=0 ){
4243 pPager->journalMode = eMode;
drh04335882008-09-26 21:08:08 +00004244 }else{
4245 assert( eMode==PAGER_JOURNALMODE_QUERY );
drh3b020132008-04-17 17:02:01 +00004246 }
drhfdc40e92008-04-17 20:59:37 +00004247 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00004248}
4249
danielk1977b53e4962008-06-04 06:45:59 +00004250/*
4251** Get/set the size-limit used for persistent journal files.
4252*/
4253i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
4254 if( iLimit>=-1 ){
4255 pPager->journalSizeLimit = iLimit;
4256 }
4257 return pPager->journalSizeLimit;
4258}
4259
drh2e66f0b2005-04-28 17:18:48 +00004260#endif /* SQLITE_OMIT_DISKIO */