blob: 8107bbc268e23eccd124ecd8165731c9a8c9f408 [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**
drhc047b9f2008-11-21 03:23:43 +000021** @(#) $Id: pager.c,v 1.507 2008/11/21 03:23:43 drh 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 */
danielk1977d92db532008-11-17 04:56:24 +0000179 u8 dbSizeValid; /* Set when dbSize is correct */
drh33f4e022007-09-03 15:19:34 +0000180 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000181 int errCode; /* One of several kinds of errors */
danielk1977d92db532008-11-17 04:56:24 +0000182 Pgno dbSize; /* Number of pages in the file */
183 Pgno origDbSize; /* dbSize before the current change */
184 Pgno stmtSize; /* Size of database (in pages) at stmt_begin() */
drhfcd35c72005-05-21 02:48:08 +0000185 int nRec; /* Number of pages written to the journal */
186 u32 cksumInit; /* Quasi-random value added to every checksum */
187 int stmtNRec; /* Number of records in stmt subjournal */
188 int nExtra; /* Add this many bytes to each in-memory page */
189 int pageSize; /* Number of bytes in a page */
190 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000191 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000192 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000193 Bitvec *pInJournal; /* One bit for each page in the database file */
194 Bitvec *pInStmt; /* One bit for each page in the database */
danielk1977a1fa00d2008-08-27 15:16:33 +0000195 Bitvec *pAlwaysRollback; /* One bit for each page marked always-rollback */
drhfcd35c72005-05-21 02:48:08 +0000196 char *zFilename; /* Name of the database file */
197 char *zJournal; /* Name of the journal file */
198 char *zDirectory; /* Directory hold database and journal files */
danielk197762079062007-08-15 17:08:46 +0000199 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
200 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
danielk19771ceedd32008-11-19 10:22:33 +0000201 int (*xBusyHandler)(void*); /* Function to call when busy */
202 void *pBusyHandlerArg; /* Context argument for xBusyHandler */
drheb206252004-10-01 02:00:31 +0000203 i64 journalOff; /* Current byte offset in the journal file */
204 i64 journalHdr; /* Byte offset to previous journal header */
205 i64 stmtHdrOff; /* First journal header written this statement */
206 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000207 i64 stmtJSize; /* Size of journal at stmt_begin() */
drh98c58352008-11-07 00:24:53 +0000208 u32 sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000209#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000210 int nHit, nMiss; /* Cache hits and missing */
211 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000212#endif
danielk1977eaa06f62008-09-18 17:34:44 +0000213 void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000214#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000215 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000216 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000217#endif
danielk19778186df82007-03-06 13:45:59 +0000218 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000219 char dbFileVers[16]; /* Changes whenever database file changes */
danielk1977b53e4962008-06-04 06:45:59 +0000220 i64 journalSizeLimit; /* Size limit for persistent journal files */
danielk19778c0a7912008-08-20 14:49:23 +0000221 PCache *pPCache; /* Pointer to page cache object */
drhd9b02572001-04-15 00:37:09 +0000222};
223
224/*
drh538f5702007-04-13 02:14:30 +0000225** The following global variables hold counters used for
226** testing purposes only. These variables do not exist in
227** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000228*/
229#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000230int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
231int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
232int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
drh538f5702007-04-13 02:14:30 +0000233# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000234#else
drh538f5702007-04-13 02:14:30 +0000235# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000236#endif
237
drh538f5702007-04-13 02:14:30 +0000238
239
drhfcd35c72005-05-21 02:48:08 +0000240/*
drh5e00f6c2001-09-13 13:46:56 +0000241** Journal files begin with the following magic string. The data
242** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000243**
drhae2b40c2004-06-09 19:03:54 +0000244** Since version 2.8.0, the journal format contains additional sanity
245** checking information. If the power fails while the journal is begin
246** written, semi-random garbage data might appear in the journal
247** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000248** to roll the journal back, the database could be corrupted. The additional
249** sanity checking data is an attempt to discover the garbage in the
250** journal and ignore it.
251**
drhae2b40c2004-06-09 19:03:54 +0000252** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000253** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000254** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000255** This cksum is initialized to a 32-bit random value that appears in the
256** journal file right after the header. The random initializer is important,
257** because garbage data that appears at the end of a journal is likely
258** data that was once in other files that have now been deleted. If the
259** garbage data came from an obsolete journal file, the checksums might
260** be correct. But by initializing the checksum to random value which
261** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000262*/
drhae2b40c2004-06-09 19:03:54 +0000263static const unsigned char aJournalMagic[] = {
264 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000265};
266
267/*
drh726de592004-06-10 23:35:50 +0000268** The size of the header and of each page in the journal is determined
269** by the following macros.
drh968af522003-02-11 14:55:40 +0000270*/
drhae2b40c2004-06-09 19:03:54 +0000271#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000272
danielk197776572402004-06-25 02:38:54 +0000273/*
274** The journal header size for this pager. In the future, this could be
275** set to some value read from the disk controller. The important
276** characteristic is that it is the same size as a disk sector.
277*/
278#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
279
drhb7f91642004-10-31 02:22:47 +0000280/*
281** The macro MEMDB is true if we are dealing with an in-memory database.
282** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
283** the value of MEMDB will be a constant and the compiler will optimize
284** out code that would never execute.
285*/
286#ifdef SQLITE_OMIT_MEMORYDB
287# define MEMDB 0
288#else
289# define MEMDB pPager->memDb
290#endif
291
292/*
danielk197776572402004-06-25 02:38:54 +0000293** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
294** reserved for working around a windows/posix incompatibility). It is
295** used in the journal to signify that the remainder of the journal file
296** is devoted to storing a master journal name - there are no more pages to
297** roll back. See comments for function writeMasterJournal() for details.
298*/
danielk1977599fcba2004-11-08 07:13:13 +0000299/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
danielk1977d92db532008-11-17 04:56:24 +0000300#define PAGER_MJ_PGNO(x) ((Pgno)((PENDING_BYTE/((x)->pageSize))+1))
danielk197713adf8a2004-06-03 16:08:41 +0000301
drh968af522003-02-11 14:55:40 +0000302/*
danielk197726836652005-01-17 01:33:13 +0000303** The maximum legal page number is (2^31 - 1).
304*/
305#define PAGER_MAX_PGNO 2147483647
306
307/*
danielk1977f35843b2007-04-07 15:03:17 +0000308** Return true if page *pPg has already been written to the statement
309** journal (or statement snapshot has been created, if *pPg is part
310** of an in-memory database).
311*/
312static int pageInStatement(PgHdr *pPg){
313 Pager *pPager = pPg->pPager;
danielk1977b3175382008-10-17 18:51:52 +0000314 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000315}
drh8ca0c722006-05-07 17:49:38 +0000316
danielk1977bc2ca9e2008-11-13 14:28:28 +0000317static int pageInJournal(PgHdr *pPg){
318 return sqlite3BitvecTest(pPg->pPager->pInJournal, pPg->pgno);
319}
320
drh8ca0c722006-05-07 17:49:38 +0000321/*
drh34e79ce2004-02-08 06:05:46 +0000322** Read a 32-bit integer from the given file descriptor. Store the integer
323** that is read in *pRes. Return SQLITE_OK if everything worked, or an
324** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000325**
326** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000327*/
danielk197762079062007-08-15 17:08:46 +0000328static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000329 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000330 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000331 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000332 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000333 }
drh94f33312002-08-12 12:29:56 +0000334 return rc;
335}
336
337/*
drh97b57482006-01-10 20:32:32 +0000338** Write a 32-bit integer into a string buffer in big-endian byte order.
339*/
drha3152892007-05-05 11:48:52 +0000340#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000341
342/*
drh34e79ce2004-02-08 06:05:46 +0000343** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
344** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000345*/
danielk197762079062007-08-15 17:08:46 +0000346static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000347 char ac[4];
drh97b57482006-01-10 20:32:32 +0000348 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000349 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000350}
351
drh2554f8b2003-01-22 01:26:44 +0000352/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000353** If file pFd is open, call sqlite3OsUnlock() on it.
354*/
355static int osUnlock(sqlite3_file *pFd, int eLock){
356 if( !pFd->pMethods ){
357 return SQLITE_OK;
358 }
359 return sqlite3OsUnlock(pFd, eLock);
360}
361
362/*
danielk1977c7b60172007-08-22 11:22:03 +0000363** This function determines whether or not the atomic-write optimization
364** can be used with this pager. The optimization can be used if:
365**
366** (a) the value returned by OsDeviceCharacteristics() indicates that
367** a database page may be written atomically, and
368** (b) the value returned by OsSectorSize() is less than or equal
369** to the page size.
370**
371** If the optimization cannot be used, 0 is returned. If it can be used,
372** then the value returned is the size of the journal file when it
373** contains rollback data for exactly one page.
374*/
375#ifdef SQLITE_ENABLE_ATOMIC_WRITE
376static int jrnlBufferSize(Pager *pPager){
377 int dc; /* Device characteristics */
378 int nSector; /* Sector size */
drhfacf0302008-06-17 15:12:00 +0000379 int szPage; /* Page size */
danielk1977c7b60172007-08-22 11:22:03 +0000380 sqlite3_file *fd = pPager->fd;
381
382 if( fd->pMethods ){
383 dc = sqlite3OsDeviceCharacteristics(fd);
384 nSector = sqlite3OsSectorSize(fd);
drhfacf0302008-06-17 15:12:00 +0000385 szPage = pPager->pageSize;
danielk1977c7b60172007-08-22 11:22:03 +0000386 }
387
388 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
389 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
390
drhfacf0302008-06-17 15:12:00 +0000391 if( !fd->pMethods ||
392 (dc & (SQLITE_IOCAP_ATOMIC|(szPage>>8)) && nSector<=szPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000393 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
394 }
395 return 0;
396}
397#endif
398
399/*
danielk1977aef0bf62005-12-30 16:28:01 +0000400** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000401** code. The first argument is a pointer to the pager structure, the
402** second the error-code about to be returned by a pager API function.
403** The value returned is a copy of the second argument to this function.
404**
drh4f0ee682007-03-30 20:43:40 +0000405** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000406** the error becomes persistent. Until the persisten error is cleared,
407** subsequent API calls on this Pager will immediately return the same
408** error code.
409**
410** A persistent error indicates that the contents of the pager-cache
411** cannot be trusted. This state can be cleared by completely discarding
412** the contents of the pager-cache. If a transaction was active when
413** the persistent error occured, then the rollback journal may need
414** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000415*/
danielk1977ae72d982007-10-03 08:46:44 +0000416static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000417static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000418 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000419 assert(
420 pPager->errCode==SQLITE_FULL ||
421 pPager->errCode==SQLITE_OK ||
422 (pPager->errCode & 0xff)==SQLITE_IOERR
423 );
danielk1977979f38e2007-03-27 16:19:51 +0000424 if(
drh4ac285a2006-09-15 07:28:50 +0000425 rc2==SQLITE_FULL ||
426 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000427 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000428 ){
429 pPager->errCode = rc;
danielk19778c0a7912008-08-20 14:49:23 +0000430 if( pPager->state==PAGER_UNLOCK
431 && sqlite3PcacheRefCount(pPager->pPCache)==0
432 ){
danielk1977ae72d982007-10-03 08:46:44 +0000433 /* If the pager is already unlocked, call pager_unlock() now to
434 ** clear the error state and ensure that the pager-cache is
435 ** completely empty.
436 */
437 pager_unlock(pPager);
438 }
danielk1977aef0bf62005-12-30 16:28:01 +0000439 }
440 return rc;
441}
442
drh477731b2007-06-16 03:06:27 +0000443/*
444** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
445** on the cache using a hash function. This is used for testing
446** and debugging only.
447*/
danielk19773c407372005-02-15 02:54:14 +0000448#ifdef SQLITE_CHECK_PAGES
449/*
450** Return a 32-bit hash of the page data for pPage.
451*/
drh477731b2007-06-16 03:06:27 +0000452static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000453 u32 hash = 0;
454 int i;
drh477731b2007-06-16 03:06:27 +0000455 for(i=0; i<nByte; i++){
456 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000457 }
458 return hash;
459}
drh477731b2007-06-16 03:06:27 +0000460static u32 pager_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000461 return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
462}
danielk1977bc2ca9e2008-11-13 14:28:28 +0000463static void pager_set_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000464 pPage->pageHash = pager_pagehash(pPage);
drh477731b2007-06-16 03:06:27 +0000465}
danielk19773c407372005-02-15 02:54:14 +0000466
467/*
468** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
469** is defined, and NDEBUG is not defined, an assert() statement checks
470** that the page is either dirty or still matches the calculated page-hash.
471*/
472#define CHECK_PAGE(x) checkPage(x)
473static void checkPage(PgHdr *pPg){
474 Pager *pPager = pPg->pPager;
danielk1977b3175382008-10-17 18:51:52 +0000475 assert( !pPg->pageHash || pPager->errCode
danielk19778c0a7912008-08-20 14:49:23 +0000476 || (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
danielk19773c407372005-02-15 02:54:14 +0000477}
478
479#else
drh8ffa8172007-06-18 17:25:17 +0000480#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000481#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000482#define CHECK_PAGE(x)
drh41d30272008-08-20 21:47:45 +0000483#endif /* SQLITE_CHECK_PAGES */
danielk19773c407372005-02-15 02:54:14 +0000484
drhed7c8552001-04-11 14:29:21 +0000485/*
danielk197776572402004-06-25 02:38:54 +0000486** When this is called the journal file for pager pPager must be open.
487** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000488** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000489**
danielk197765839c62007-08-30 08:08:17 +0000490** zMaster must point to a buffer of at least nMaster bytes allocated by
491** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
492** enough space to write the master journal name). If the master journal
493** name in the journal is longer than nMaster bytes (including a
494** nul-terminator), then this is handled as if no master journal name
495** were present in the journal.
496**
497** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000498** SQLITE_OK returned.
499*/
danielk1977d92db532008-11-17 04:56:24 +0000500static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, u32 nMaster){
danielk197776572402004-06-25 02:38:54 +0000501 int rc;
502 u32 len;
drheb206252004-10-01 02:00:31 +0000503 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000504 u32 cksum;
shane0b8d2762008-07-22 05:18:00 +0000505 u32 u; /* Unsigned loop counter */
danielk197776572402004-06-25 02:38:54 +0000506 unsigned char aMagic[8]; /* A buffer to hold the magic header */
507
danielk197765839c62007-08-30 08:08:17 +0000508 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000509
drh054889e2005-11-30 03:20:31 +0000510 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000511 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000512
danielk197762079062007-08-15 17:08:46 +0000513 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000514 if( rc!=SQLITE_OK ) return rc;
515
danielk197765839c62007-08-30 08:08:17 +0000516 if( len>=nMaster ){
517 return SQLITE_OK;
518 }
519
danielk197762079062007-08-15 17:08:46 +0000520 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000521 if( rc!=SQLITE_OK ) return rc;
522
danielk197762079062007-08-15 17:08:46 +0000523 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000524 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
525
danielk197765839c62007-08-30 08:08:17 +0000526 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000527 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000528 return rc;
529 }
danielk197765839c62007-08-30 08:08:17 +0000530 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000531
532 /* See if the checksum matches the master journal name */
shane0b8d2762008-07-22 05:18:00 +0000533 for(u=0; u<len; u++){
534 cksum -= zMaster[u];
danielk197765839c62007-08-30 08:08:17 +0000535 }
danielk19778191bff2004-06-28 04:52:30 +0000536 if( cksum ){
537 /* If the checksum doesn't add up, then one or more of the disk sectors
538 ** containing the master journal filename is corrupted. This means
539 ** definitely roll back, so just return SQLITE_OK and report a (nul)
540 ** master-journal filename.
541 */
danielk197765839c62007-08-30 08:08:17 +0000542 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000543 }
danielk197776572402004-06-25 02:38:54 +0000544
545 return SQLITE_OK;
546}
547
548/*
549** Seek the journal file descriptor to the next sector boundary where a
550** journal header may be read or written. Pager.journalOff is updated with
551** the new seek offset.
552**
553** i.e for a sector size of 512:
554**
555** Input Offset Output Offset
556** ---------------------------------------
557** 0 0
558** 512 512
559** 100 512
560** 2000 2048
561**
562*/
danielk197762079062007-08-15 17:08:46 +0000563static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000564 i64 offset = 0;
565 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000566 if( c ){
567 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
568 }
569 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
570 assert( offset>=c );
571 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
572 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000573}
574
575/*
drhf3a87622008-04-17 14:16:42 +0000576** Write zeros over the header of the journal file. This has the
577** effect of invalidating the journal file and committing the
578** transaction.
579*/
danielk1977df2566a2008-05-07 19:11:03 +0000580static int zeroJournalHdr(Pager *pPager, int doTruncate){
581 int rc = SQLITE_OK;
danielk197755a25a12008-09-11 10:29:15 +0000582 static const char zeroHdr[28] = {0};
drhf3a87622008-04-17 14:16:42 +0000583
danielk1977df2566a2008-05-07 19:11:03 +0000584 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000585 i64 iLimit = pPager->journalSizeLimit;
586
danielk1977df2566a2008-05-07 19:11:03 +0000587 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000588 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000589 rc = sqlite3OsTruncate(pPager->jfd, 0);
590 }else{
591 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
592 }
danielk197781620542008-06-07 05:19:37 +0000593 if( rc==SQLITE_OK && !pPager->noSync ){
danielk1977df2566a2008-05-07 19:11:03 +0000594 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
595 }
danielk1977b53e4962008-06-04 06:45:59 +0000596
597 /* At this point the transaction is committed but the write lock
598 ** is still held on the file. If there is a size limit configured for
599 ** the persistent journal and the journal file currently consumes more
600 ** space than that limit allows for, truncate it now. There is no need
601 ** to sync the file following this operation.
602 */
603 if( rc==SQLITE_OK && iLimit>0 ){
604 i64 sz;
605 rc = sqlite3OsFileSize(pPager->jfd, &sz);
606 if( rc==SQLITE_OK && sz>iLimit ){
607 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
608 }
609 }
drha06ecba2008-04-22 17:15:17 +0000610 }
drhf3a87622008-04-17 14:16:42 +0000611 return rc;
612}
613
614/*
danielk197776572402004-06-25 02:38:54 +0000615** The journal file must be open when this routine is called. A journal
616** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
617** current location.
618**
619** The format for the journal header is as follows:
620** - 8 bytes: Magic identifying journal format.
621** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
622** - 4 bytes: Random number used for page hash.
623** - 4 bytes: Initial database page count.
624** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000625** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000626**
danielk197767c007b2008-03-20 04:45:49 +0000627** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000628*/
629static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000630 int rc = SQLITE_OK;
631 char *zHeader = pPager->pTmpSpace;
danielk1977d92db532008-11-17 04:56:24 +0000632 u32 nHeader = pPager->pageSize;
633 u32 nWrite;
danielk1977a664f8e2008-04-22 14:31:48 +0000634
635 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
636 nHeader = JOURNAL_HDR_SZ(pPager);
637 }
danielk197776572402004-06-25 02:38:54 +0000638
danielk19774099f6e2007-03-19 11:25:20 +0000639 if( pPager->stmtHdrOff==0 ){
640 pPager->stmtHdrOff = pPager->journalOff;
641 }
642
danielk197762079062007-08-15 17:08:46 +0000643 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000644 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000645
drh97b57482006-01-10 20:32:32 +0000646 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +0000647
648 /*
649 ** Write the nRec Field - the number of page records that follow this
650 ** journal header. Normally, zero is written to this value at this time.
651 ** After the records are added to the journal (and the journal synced,
652 ** if in full-sync mode), the zero is overwritten with the true number
653 ** of records (see syncJournal()).
654 **
655 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
656 ** reading the journal this value tells SQLite to assume that the
657 ** rest of the journal file contains valid page records. This assumption
658 ** is dangerous, as if a failure occured whilst writing to the journal
659 ** file it may contain some garbage data. There are two scenarios
660 ** where this risk can be ignored:
661 **
662 ** * When the pager is in no-sync mode. Corruption can follow a
663 ** power failure in this case anyway.
664 **
665 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
666 ** that garbage data is never appended to the journal file.
667 */
668 assert(pPager->fd->pMethods||pPager->noSync);
danielk1977b3175382008-10-17 18:51:52 +0000669 if( (pPager->noSync) || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY)
danielk19774cd2cd52007-08-23 14:48:23 +0000670 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
671 ){
672 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
673 }else{
674 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
675 }
676
drh97b57482006-01-10 20:32:32 +0000677 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +0000678 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +0000679 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
680 /* The initial database size */
681 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
682 /* The assumed sector size for this process */
683 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +0000684 if( pPager->journalHdr==0 ){
685 /* The page size */
686 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
687 }
danielk197776572402004-06-25 02:38:54 +0000688
danielk1977a664f8e2008-04-22 14:31:48 +0000689 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
690 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
691 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
692 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +0000693 }
danielk1977a664f8e2008-04-22 14:31:48 +0000694
danielk197776572402004-06-25 02:38:54 +0000695 return rc;
696}
697
698/*
699** The journal file must be open when this is called. A journal header file
700** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
701** file. See comments above function writeJournalHdr() for a description of
702** the journal header format.
703**
704** If the header is read successfully, *nRec is set to the number of
705** page records following this header and *dbSize is set to the size of the
706** database before the transaction began, in pages. Also, pPager->cksumInit
707** is set to the value read from the journal header. SQLITE_OK is returned
708** in this case.
709**
710** If the journal header file appears to be corrupted, SQLITE_DONE is
711** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
712** cannot be read from the journal file an error code is returned.
713*/
714static int readJournalHdr(
715 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000716 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000717 u32 *pNRec,
718 u32 *pDbSize
719){
720 int rc;
721 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000722 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +0000723 int iPageSize;
danielk197776572402004-06-25 02:38:54 +0000724
danielk197762079062007-08-15 17:08:46 +0000725 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000726 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
727 return SQLITE_DONE;
728 }
danielk197762079062007-08-15 17:08:46 +0000729 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000730
danielk197762079062007-08-15 17:08:46 +0000731 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000732 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000733 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000734
735 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
736 return SQLITE_DONE;
737 }
738
danielk197762079062007-08-15 17:08:46 +0000739 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000740 if( rc ) return rc;
741
danielk197762079062007-08-15 17:08:46 +0000742 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000743 if( rc ) return rc;
744
danielk197762079062007-08-15 17:08:46 +0000745 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000746 if( rc ) return rc;
747
danielk197767c007b2008-03-20 04:45:49 +0000748 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
749 if( rc==SQLITE_OK
750 && iPageSize>=512
751 && iPageSize<=SQLITE_MAX_PAGE_SIZE
752 && ((iPageSize-1)&iPageSize)==0
753 ){
754 u16 pagesize = iPageSize;
755 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
756 }
757 if( rc ) return rc;
758
danielk197776572402004-06-25 02:38:54 +0000759 /* Update the assumed sector-size to match the value used by
760 ** the process that created this journal. If this journal was
761 ** created by a process other than this one, then this routine
762 ** is being called from within pager_playback(). The local value
763 ** of Pager.sectorSize is restored at the end of that routine.
764 */
drh98c58352008-11-07 00:24:53 +0000765 rc = read32bits(pPager->jfd, jrnlOff+12, &pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000766 if( rc ) return rc;
drh98c58352008-11-07 00:24:53 +0000767 if( (pPager->sectorSize & (pPager->sectorSize-1))!=0
768 || pPager->sectorSize>0x1000000 ){
769 return SQLITE_DONE;
770 }
danielk197776572402004-06-25 02:38:54 +0000771
772 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +0000773 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000774}
775
776
777/*
778** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000779** pPager at the current location. The master journal name must be the last
780** thing written to a journal file. If the pager is in full-sync mode, the
781** journal file descriptor is advanced to the next sector boundary before
782** anything is written. The format is:
783**
784** + 4 bytes: PAGER_MJ_PGNO.
785** + N bytes: length of master journal name.
786** + 4 bytes: N
787** + 4 bytes: Master journal name checksum.
788** + 8 bytes: aJournalMagic[].
789**
790** The master journal page checksum is the sum of the bytes in the master
791** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000792**
793** If zMaster is a NULL pointer (occurs for a single database transaction),
794** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000795*/
796static int writeMasterJournal(Pager *pPager, const char *zMaster){
797 int rc;
798 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000799 int i;
danielk197762079062007-08-15 17:08:46 +0000800 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +0000801 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +0000802 u32 cksum = 0;
803 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000804
danielk1977b3175382008-10-17 18:51:52 +0000805 if( !zMaster || pPager->setMaster ) return SQLITE_OK;
806 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ) return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000807 pPager->setMaster = 1;
808
809 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000810 for(i=0; i<len; i++){
811 cksum += zMaster[i];
812 }
danielk197776572402004-06-25 02:38:54 +0000813
814 /* If in full-sync mode, advance to the next disk sector before writing
815 ** the master journal name. This is in case the previous page written to
816 ** the journal has already been synced.
817 */
818 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000819 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000820 }
danielk197762079062007-08-15 17:08:46 +0000821 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000822 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000823
danielk197762079062007-08-15 17:08:46 +0000824 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000825 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000826 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000827
danielk197762079062007-08-15 17:08:46 +0000828 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000829 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000830 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000831
drh97b57482006-01-10 20:32:32 +0000832 put32bits(zBuf, len);
833 put32bits(&zBuf[4], cksum);
834 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000835 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +0000836 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +0000837 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +0000838
839 /* If the pager is in peristent-journal mode, then the physical
840 ** journal-file may extend past the end of the master-journal name
841 ** and 8 bytes of magic data just written to the file. This is
842 ** dangerous because the code to rollback a hot-journal file
843 ** will not be able to find the master-journal name to determine
844 ** whether or not the journal is hot.
845 **
846 ** Easiest thing to do in this scenario is to truncate the journal
847 ** file to the required size.
848 */
849 if( (rc==SQLITE_OK)
850 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
851 && jrnlSize>jrnlOff
852 ){
853 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
854 }
danielk197776572402004-06-25 02:38:54 +0000855 return rc;
856}
857
858/*
drhed7c8552001-04-11 14:29:21 +0000859** Find a page in the hash table given its page number. Return
860** a pointer to the page or NULL if not found.
861*/
drhd9b02572001-04-15 00:37:09 +0000862static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000863 PgHdr *p;
danielk19778c0a7912008-08-20 14:49:23 +0000864 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &p);
drhed7c8552001-04-11 14:29:21 +0000865 return p;
866}
867
868/*
danielk1977e180dd92007-04-05 17:15:52 +0000869** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000870** sets the state of the pager back to what it was when it was first
871** opened. Any outstanding pages are invalidated and subsequent attempts
872** to access those pages will likely result in a coredump.
873*/
drhd9b02572001-04-15 00:37:09 +0000874static void pager_reset(Pager *pPager){
danielk1977efaaf572006-01-16 11:29:19 +0000875 if( pPager->errCode ) return;
danielk19778c0a7912008-08-20 14:49:23 +0000876 sqlite3PcacheClear(pPager->pPCache);
danielk1977e277be02007-03-23 18:12:06 +0000877}
878
879/*
danielk1977ae72d982007-10-03 08:46:44 +0000880** Unlock the database file.
881**
882** If the pager is currently in error state, discard the contents of
883** the cache and reset the Pager structure internal state. If there is
884** an open journal-file, then the next time a shared-lock is obtained
885** on the pager file (by this or any other process), it will be
886** treated as a hot-journal and rolled back.
887*/
888static void pager_unlock(Pager *pPager){
889 if( !pPager->exclusiveMode ){
danielk1977b3175382008-10-17 18:51:52 +0000890 int rc = osUnlock(pPager->fd, NO_LOCK);
891 if( rc ) pPager->errCode = rc;
danielk1977d92db532008-11-17 04:56:24 +0000892 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +0000893 IOTRACE(("UNLOCK %p\n", pPager))
danielk1977ae72d982007-10-03 08:46:44 +0000894
danielk1977b3175382008-10-17 18:51:52 +0000895 /* Always close the journal file when dropping the database lock.
896 ** Otherwise, another connection with journal_mode=delete might
897 ** delete the file out from under us.
898 */
899 if( pPager->journalOpen ){
900 sqlite3OsClose(pPager->jfd);
901 pPager->journalOpen = 0;
902 sqlite3BitvecDestroy(pPager->pInJournal);
903 pPager->pInJournal = 0;
904 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
905 pPager->pAlwaysRollback = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000906 }
907
danielk1977b3175382008-10-17 18:51:52 +0000908 /* If Pager.errCode is set, the contents of the pager cache cannot be
909 ** trusted. Now that the pager file is unlocked, the contents of the
910 ** cache can be discarded and the error code safely cleared.
911 */
912 if( pPager->errCode ){
913 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
914 pager_reset(pPager);
915 if( pPager->stmtOpen ){
916 sqlite3OsClose(pPager->stfd);
917 sqlite3BitvecDestroy(pPager->pInStmt);
918 pPager->pInStmt = 0;
919 }
920 pPager->stmtOpen = 0;
921 pPager->stmtInUse = 0;
922 pPager->journalOff = 0;
923 pPager->journalStarted = 0;
924 pPager->stmtAutoopen = 0;
925 pPager->origDbSize = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000926 }
danielk1977b3175382008-10-17 18:51:52 +0000927
928 pPager->state = PAGER_UNLOCK;
929 pPager->changeCountDone = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000930 }
931}
932
933/*
934** Execute a rollback if a transaction is active and unlock the
935** database file. If the pager has already entered the error state,
936** do not attempt the rollback.
937*/
938static void pagerUnlockAndRollback(Pager *p){
danielk1977ae72d982007-10-03 08:46:44 +0000939 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
danielk19772d1d86f2008-06-20 14:59:51 +0000940 sqlite3BeginBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000941 sqlite3PagerRollback(p);
danielk19772d1d86f2008-06-20 14:59:51 +0000942 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000943 }
944 pager_unlock(p);
danielk1977ae72d982007-10-03 08:46:44 +0000945}
946
947/*
drh80e35f42007-03-30 14:06:34 +0000948** This routine ends a transaction. A transaction is ended by either
949** a COMMIT or a ROLLBACK.
950**
drhed7c8552001-04-11 14:29:21 +0000951** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +0000952** a RESERVED or EXCLUSIVE lock on the database. This routine will release
953** the database lock and acquires a SHARED lock in its place if that is
954** the appropriate thing to do. Release locks usually is appropriate,
955** unless we are in exclusive access mode or unless this is a
956** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
957**
958** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +0000959**
960** TODO: Consider keeping the journal file open for temporary databases.
961** This might give a performance improvement on windows where opening
962** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000963*/
danielk1977df2566a2008-05-07 19:11:03 +0000964static int pager_end_transaction(Pager *pPager, int hasMaster){
danielk197741483462007-03-24 16:45:04 +0000965 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +0000966 int rc2 = SQLITE_OK;
drha6abd042004-06-09 17:37:22 +0000967 if( pPager->state<PAGER_RESERVED ){
968 return SQLITE_OK;
969 }
danielk19773b8a05f2007-03-19 17:44:26 +0000970 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +0000971 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +0000972 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +0000973 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000974 }
drhda47d772002-12-02 04:25:19 +0000975 if( pPager->journalOpen ){
danielk1977b3175382008-10-17 18:51:52 +0000976 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
977 int isMemoryJournal = sqlite3IsMemJournal(pPager->jfd);
978 sqlite3OsClose(pPager->jfd);
979 pPager->journalOpen = 0;
980 if( !isMemoryJournal ){
981 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
982 }
983 }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE
drh04335882008-09-26 21:08:08 +0000984 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){
985 pPager->journalOff = 0;
986 pPager->journalStarted = 0;
987 }else if( pPager->exclusiveMode
danielk197793f7af92008-05-09 16:57:50 +0000988 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
989 ){
990 rc = zeroJournalHdr(pPager, hasMaster);
991 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +0000992 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +0000993 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +0000994 }else{
drh04335882008-09-26 21:08:08 +0000995 assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE || rc );
danielk1977b4b47412007-08-17 15:53:36 +0000996 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +0000997 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +0000998 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +0000999 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001000 }
danielk197741483462007-03-24 16:45:04 +00001001 }
drhf5e7bb52008-02-18 14:47:33 +00001002 sqlite3BitvecDestroy(pPager->pInJournal);
1003 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +00001004 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
1005 pPager->pAlwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001006#ifdef SQLITE_CHECK_PAGES
danielk1977bc2ca9e2008-11-13 14:28:28 +00001007 sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash);
danielk19773c407372005-02-15 02:54:14 +00001008#endif
danielk1977bc2ca9e2008-11-13 14:28:28 +00001009 sqlite3PcacheCleanAll(pPager->pPCache);
danielk1977ef317ab2004-06-23 10:43:10 +00001010 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001011 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001012 }else{
drhf5e7bb52008-02-18 14:47:33 +00001013 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001014 }
danielk1977979f38e2007-03-27 16:19:51 +00001015
danielk197741483462007-03-24 16:45:04 +00001016 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001017 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001018 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001019 }else if( pPager->state==PAGER_SYNCED ){
1020 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001021 }
danielk1977334cdb62007-03-26 08:05:12 +00001022 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001023 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001024 pPager->needSync = 0;
danielk19778c0a7912008-08-20 14:49:23 +00001025 /* lruListSetFirstSynced(pPager); */
danielk1977b3175382008-10-17 18:51:52 +00001026 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00001027 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00001028 }
drhd138c012008-05-13 00:58:18 +00001029 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001030
1031 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001032}
1033
drhed7c8552001-04-11 14:29:21 +00001034/*
drh968af522003-02-11 14:55:40 +00001035** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001036**
1037** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001038** random initial value and the page number. We experimented with
1039** a checksum of the entire data, but that was found to be too slow.
1040**
1041** Note that the page number is stored at the beginning of data and
1042** the checksum is stored at the end. This is important. If journal
1043** corruption occurs due to a power failure, the most likely scenario
1044** is that one end or the other of the record will be changed. It is
1045** much less likely that the two ends of the journal record will be
1046** correct and the middle be corrupt. Thus, this "checksum" scheme,
1047** though fast and simple, catches the mostly likely kind of corruption.
1048**
1049** FIX ME: Consider adding every 200th (or so) byte of the data to the
1050** checksum. That way if a single page spans 3 or more disk sectors and
1051** only the middle sector is corrupt, we will still have a reasonable
1052** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001053*/
drh74161702006-02-24 02:53:49 +00001054static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001055 u32 cksum = pPager->cksumInit;
1056 int i = pPager->pageSize-200;
1057 while( i>0 ){
1058 cksum += aData[i];
1059 i -= 200;
1060 }
drh968af522003-02-11 14:55:40 +00001061 return cksum;
1062}
1063
1064/*
drhfa86c412002-02-02 15:01:15 +00001065** Read a single page from the journal file opened on file descriptor
1066** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001067**
drhc13148f2008-08-27 18:03:20 +00001068** The isMainJrnl flag is true if this is the main rollback journal and
1069** false for the statement journal. The main rollback journal uses
1070** checksums - the statement journal does not.
drhfa86c412002-02-02 15:01:15 +00001071*/
danielk197762079062007-08-15 17:08:46 +00001072static int pager_playback_one_page(
drhc13148f2008-08-27 18:03:20 +00001073 Pager *pPager, /* The pager being played back */
1074 sqlite3_file *jfd, /* The file that is the journal being rolled back */
1075 i64 offset, /* Offset of the page within the journal */
1076 int isMainJrnl /* True for main rollback journal. False for Stmt jrnl */
danielk197762079062007-08-15 17:08:46 +00001077){
drhfa86c412002-02-02 15:01:15 +00001078 int rc;
drhae2b40c2004-06-09 19:03:54 +00001079 PgHdr *pPg; /* An existing page in the cache */
1080 Pgno pgno; /* The page number of a page in journal */
1081 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001082 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001083
drhc13148f2008-08-27 18:03:20 +00001084 /* isMainJrnl should be true for the main journal and false for
drh96362842005-03-20 22:47:56 +00001085 ** statement journals. Verify that this is always the case
1086 */
drhc13148f2008-08-27 18:03:20 +00001087 assert( jfd == (isMainJrnl ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001088 assert( aData );
drh96362842005-03-20 22:47:56 +00001089
danielk197762079062007-08-15 17:08:46 +00001090 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001091 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001092 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001093 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001094 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001095
drh968af522003-02-11 14:55:40 +00001096 /* Sanity checking on the page. This is more important that I originally
1097 ** thought. If a power failure occurs while the journal is being written,
1098 ** it could cause invalid data to be written into the journal. We need to
1099 ** detect this invalid data (with high probability) and ignore it.
1100 */
danielk197775edc162004-06-26 01:48:18 +00001101 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001102 return SQLITE_DONE;
1103 }
drhae2b40c2004-06-09 19:03:54 +00001104 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001105 return SQLITE_OK;
1106 }
drhc13148f2008-08-27 18:03:20 +00001107 if( isMainJrnl ){
danielk197762079062007-08-15 17:08:46 +00001108 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001109 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001110 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001111 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001112 return SQLITE_DONE;
1113 }
1114 }
drhfa86c412002-02-02 15:01:15 +00001115
danielk1977aa5ccdf2004-06-14 05:10:42 +00001116 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001117
1118 /* If the pager is in RESERVED state, then there must be a copy of this
1119 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001120 ** not the database file. The page is left marked dirty in this case.
1121 **
danielk19772df71c72007-05-24 07:22:42 +00001122 ** An exception to the above rule: If the database is in no-sync mode
1123 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001124 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1125 ** during a Movepage() call, then the page may not be in the cache
1126 ** either. So the condition described in the above paragraph is not
1127 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001128 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001129 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1130 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001131 **
1132 ** Ticket #1171: The statement journal might contain page content that is
1133 ** different from the page content at the start of the transaction.
1134 ** This occurs when a page is changed prior to the start of a statement
1135 ** then changed again within the statement. When rolling back such a
1136 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001137 ** for certain that original page contents are synced into the main rollback
1138 ** journal. Otherwise, a power loss might leave modified data in the
1139 ** database file without an entry in the rollback journal that can
1140 ** restore the database to its original form. Two conditions must be
1141 ** met before writing to the database files. (1) the database must be
1142 ** locked. (2) we know that the original page content is fully synced
1143 ** in the main journal either because the page is not in cache or else
1144 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001145 **
1146 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1147 ** is possible to fail a statement on a database that does not yet exist.
1148 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001149 */
drhae2b40c2004-06-09 19:03:54 +00001150 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001151 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1152 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
danielk19778c0a7912008-08-20 14:49:23 +00001153 if( (pPager->state>=PAGER_EXCLUSIVE)
1154 && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC))
1155 && (pPager->fd->pMethods)
1156 ){
drh281b21d2008-08-22 12:57:08 +00001157 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
1158 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst);
danielk1977a3f3a5f2004-06-10 04:32:16 +00001159 }
drhfa86c412002-02-02 15:01:15 +00001160 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001161 /* No page should ever be explicitly rolled back that is in use, except
1162 ** for page 1 which is held in use in order to keep the lock on the
1163 ** database active. However such a page may be rolled back as a result
1164 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001165 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001166 */
drhb6f41482004-05-14 01:58:11 +00001167 void *pData;
danielk19778c0a7912008-08-20 14:49:23 +00001168 pData = pPg->pData;
drhae2b40c2004-06-09 19:03:54 +00001169 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001170 if( pPager->xReiniter ){
danielk1977eaa06f62008-09-18 17:34:44 +00001171 pPager->xReiniter(pPg);
drhde647132004-05-07 17:57:49 +00001172 }
drhc047b9f2008-11-21 03:23:43 +00001173 if( isMainJrnl ){
1174 sqlite3PcacheMakeClean(pPg);
1175 }
danielk19773c407372005-02-15 02:54:14 +00001176#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001177 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001178#endif
drh86a88112007-04-16 15:02:19 +00001179 /* If this was page 1, then restore the value of Pager.dbFileVers.
1180 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001181 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001182 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001183 }
drh86a88112007-04-16 15:02:19 +00001184
1185 /* Decode the page just read from disk */
1186 CODEC1(pPager, pData, pPg->pgno, 3);
danielk19778c0a7912008-08-20 14:49:23 +00001187 sqlite3PcacheRelease(pPg);
drhfa86c412002-02-02 15:01:15 +00001188 }
1189 return rc;
1190}
1191
1192/*
danielk197713adf8a2004-06-03 16:08:41 +00001193** Parameter zMaster is the name of a master journal file. A single journal
1194** file that referred to the master journal file has just been rolled back.
1195** This routine checks if it is possible to delete the master journal file,
1196** and does so if it is.
drh726de592004-06-10 23:35:50 +00001197**
danielk197765839c62007-08-30 08:08:17 +00001198** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1199** available for use within this function.
1200**
1201**
drh726de592004-06-10 23:35:50 +00001202** The master journal file contains the names of all child journals.
1203** To tell if a master journal can be deleted, check to each of the
1204** children. If all children are either missing or do not refer to
1205** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001206*/
danielk1977b4b47412007-08-17 15:53:36 +00001207static int pager_delmaster(Pager *pPager, const char *zMaster){
1208 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001209 int rc;
1210 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001211 sqlite3_file *pMaster;
1212 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001213 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001214 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001215
1216 /* Open the master journal file exclusively in case some other process
1217 ** is running this routine also. Not that it makes too much difference.
1218 */
drhe5ae5732008-06-15 02:51:47 +00001219 pMaster = (sqlite3_file *)sqlite3Malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001220 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001221 if( !pMaster ){
1222 rc = SQLITE_NOMEM;
1223 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001224 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1225 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001226 }
danielk197713adf8a2004-06-03 16:08:41 +00001227 if( rc!=SQLITE_OK ) goto delmaster_out;
1228 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001229
1230 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001231 if( rc!=SQLITE_OK ) goto delmaster_out;
1232
1233 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001234 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001235 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001236 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001237
1238 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001239 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001240 */
drhe5ae5732008-06-15 02:51:47 +00001241 zMasterJournal = (char *)sqlite3Malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001242 if( !zMasterJournal ){
1243 rc = SQLITE_NOMEM;
1244 goto delmaster_out;
1245 }
danielk197765839c62007-08-30 08:08:17 +00001246 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001247 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001248 if( rc!=SQLITE_OK ) goto delmaster_out;
1249
danielk19775865e3d2004-06-14 06:03:57 +00001250 zJournal = zMasterJournal;
1251 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977861f7452008-06-05 11:39:11 +00001252 int exists;
1253 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
1254 if( rc!=SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001255 goto delmaster_out;
1256 }
danielk1977861f7452008-06-05 11:39:11 +00001257 if( exists ){
danielk197713adf8a2004-06-03 16:08:41 +00001258 /* One of the journals pointed to by the master journal exists.
1259 ** Open it and check if it points at the master journal. If
1260 ** so, return without deleting the master journal file.
1261 */
drh3b7b78b2004-11-24 01:16:43 +00001262 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001263 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1264 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001265 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001266 goto delmaster_out;
1267 }
danielk197713adf8a2004-06-03 16:08:41 +00001268
danielk197765839c62007-08-30 08:08:17 +00001269 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001270 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001271 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001272 goto delmaster_out;
1273 }
danielk197776572402004-06-25 02:38:54 +00001274
danielk197765839c62007-08-30 08:08:17 +00001275 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001276 if( c ){
danielk197776572402004-06-25 02:38:54 +00001277 /* We have a match. Do not delete the master journal file. */
1278 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001279 }
1280 }
danielk19775865e3d2004-06-14 06:03:57 +00001281 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001282 }
1283 }
1284
danielk1977fee2d252007-08-18 10:59:19 +00001285 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001286
1287delmaster_out:
1288 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001289 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001290 }
1291 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001292 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001293 }
danielk1977b4b47412007-08-17 15:53:36 +00001294 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001295 return rc;
1296}
1297
drha6abd042004-06-09 17:37:22 +00001298
danielk1977e180dd92007-04-05 17:15:52 +00001299static void pager_truncate_cache(Pager *pPager);
1300
drha6abd042004-06-09 17:37:22 +00001301/*
drhcb4c40b2004-08-18 19:09:43 +00001302** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001303** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001304**
1305** Might might be the case that the file on disk is smaller than nPage.
1306** This can happen, for example, if we are in the middle of a transaction
1307** which has extended the file size and the new pages are still all held
1308** in cache, then an INSERT or UPDATE does a statement rollback. Some
1309** operating system implementations can get confused if you try to
1310** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001311** so detect this case and write a single zero byte to the end of the new
1312** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001313*/
danielk1977d92db532008-11-17 04:56:24 +00001314static int pager_truncate(Pager *pPager, Pgno nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001315 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001316 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001317 i64 currentSize, newSize;
1318 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1319 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001320 if( rc==SQLITE_OK && currentSize!=newSize ){
1321 if( currentSize>newSize ){
1322 rc = sqlite3OsTruncate(pPager->fd, newSize);
1323 }else{
1324 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1325 }
drh7fe3f7e2007-11-29 18:44:27 +00001326 }
danielk1977e180dd92007-04-05 17:15:52 +00001327 }
1328 if( rc==SQLITE_OK ){
1329 pPager->dbSize = nPage;
1330 pager_truncate_cache(pPager);
1331 }
1332 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001333}
1334
1335/*
drhc80f0582007-05-01 16:59:48 +00001336** Set the sectorSize for the given pager.
1337**
drh334c80d2008-03-28 17:41:13 +00001338** The sector size is at least as big as the sector size reported
1339** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001340*/
1341static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001342 assert(pPager->fd->pMethods||pPager->tempFile);
1343 if( !pPager->tempFile ){
1344 /* Sector size doesn't matter for temporary files. Also, the file
1345 ** may not have been opened yet, in whcih case the OsSectorSize()
1346 ** call will segfault.
1347 */
1348 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1349 }
drh334c80d2008-03-28 17:41:13 +00001350 if( pPager->sectorSize<512 ){
1351 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001352 }
1353}
1354
1355/*
drhed7c8552001-04-11 14:29:21 +00001356** Playback the journal and thus restore the database file to
1357** the state it was in before we started making changes.
1358**
drh34e79ce2004-02-08 06:05:46 +00001359** The journal file format is as follows:
1360**
drhae2b40c2004-06-09 19:03:54 +00001361** (1) 8 byte prefix. A copy of aJournalMagic[].
1362** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001363** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001364** number of page records from the journal size.
1365** (3) 4 byte big-endian integer which is the initial value for the
1366** sanity checksum.
1367** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001368** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001369** (5) 4 byte big-endian integer which is the sector size. The header
1370** is this many bytes in size.
1371** (6) 4 byte big-endian integer which is the page case.
1372** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001373** name. The value may be zero (indicate that there is no master
1374** journal.)
drh334c80d2008-03-28 17:41:13 +00001375** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001376** and might be shorter than the value read from (5). If the first byte
1377** of the name is \000 then there is no master journal. The master
1378** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001379** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001380** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001381** + pPager->pageSize bytes of data.
1382** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001383**
drh334c80d2008-03-28 17:41:13 +00001384** When we speak of the journal header, we mean the first 8 items above.
1385** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001386**
1387** Call the value from the second bullet "nRec". nRec is the number of
1388** valid page entries in the journal. In most cases, you can compute the
1389** value of nRec from the size of the journal file. But if a power
1390** failure occurred while the journal was being written, it could be the
1391** case that the size of the journal file had already been increased but
1392** the extra entries had not yet made it safely to disk. In such a case,
1393** the value of nRec computed from the file size would be too large. For
1394** that reason, we always use the nRec value in the header.
1395**
1396** If the nRec value is 0xffffffff it means that nRec should be computed
1397** from the file size. This value is used when the user selects the
1398** no-sync option for the journal. A power failure could lead to corruption
1399** in this case. But for things like temporary table (which will be
1400** deleted when the power is restored) we don't care.
1401**
drhd9b02572001-04-15 00:37:09 +00001402** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001403** journal file then all pages up to the first corrupted page are rolled
1404** back (or no pages if the journal header is corrupted). The journal file
1405** is then deleted and SQLITE_OK returned, just as if no corruption had
1406** been encountered.
1407**
1408** If an I/O or malloc() error occurs, the journal-file is not deleted
1409** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001410*/
danielk1977e277be02007-03-23 18:12:06 +00001411static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001412 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001413 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001414 u32 nRec; /* Number of Records in the journal */
shane0b8d2762008-07-22 05:18:00 +00001415 u32 u; /* Unsigned loop counter */
drhd9b02572001-04-15 00:37:09 +00001416 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001417 int rc; /* Result code of a subroutine */
danielk1977861f7452008-06-05 11:39:11 +00001418 int res = 1; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001419 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001420
drhc3a64ba2001-11-22 00:01:27 +00001421 /* Figure out how many records are in the journal. Abort early if
1422 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001423 */
drh8cfbf082001-09-19 13:22:39 +00001424 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001425 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001426 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001427 goto end_playback;
1428 }
drh240c5792004-02-08 00:40:52 +00001429
danielk197776572402004-06-25 02:38:54 +00001430 /* Read the master journal name from the journal, if it is present.
1431 ** If a master journal file name is specified, but the file is not
1432 ** present on disk, then the journal is not hot and does not need to be
1433 ** played back.
drh240c5792004-02-08 00:40:52 +00001434 */
danielk197765839c62007-08-30 08:08:17 +00001435 zMaster = pPager->pTmpSpace;
1436 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977861f7452008-06-05 11:39:11 +00001437 if( rc==SQLITE_OK && zMaster[0] ){
1438 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
drhc3a64ba2001-11-22 00:01:27 +00001439 }
danielk197765839c62007-08-30 08:08:17 +00001440 zMaster = 0;
danielk1977861f7452008-06-05 11:39:11 +00001441 if( rc!=SQLITE_OK || !res ){
danielk1977ce98bba2008-04-03 10:13:01 +00001442 goto end_playback;
1443 }
1444 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001445
danielk197776572402004-06-25 02:38:54 +00001446 /* This loop terminates either when the readJournalHdr() call returns
1447 ** SQLITE_DONE or an IO error occurs. */
1448 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001449
danielk197776572402004-06-25 02:38:54 +00001450 /* Read the next journal header from the journal file. If there are
1451 ** not enough bytes left in the journal file for a complete header, or
1452 ** it is corrupted, then a process must of failed while writing it.
1453 ** This indicates nothing more needs to be rolled back.
1454 */
1455 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1456 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001457 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001458 rc = SQLITE_OK;
1459 }
danielk197776572402004-06-25 02:38:54 +00001460 goto end_playback;
1461 }
1462
1463 /* If nRec is 0xffffffff, then this journal was created by a process
1464 ** working in no-sync mode. This means that the rest of the journal
1465 ** file consists of pages, there are no more journal headers. Compute
1466 ** the value of nRec based on this assumption.
1467 */
1468 if( nRec==0xffffffff ){
1469 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1470 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1471 }
1472
danielk1977e277be02007-03-23 18:12:06 +00001473 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001474 ** process and if this is the final header in the journal, then it means
1475 ** that this part of the journal was being filled but has not yet been
1476 ** synced to disk. Compute the number of pages based on the remaining
1477 ** size of the file.
1478 **
1479 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001480 */
drh8940f4e2007-08-11 00:26:20 +00001481 if( nRec==0 && !isHot &&
1482 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001483 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1484 }
1485
danielk197776572402004-06-25 02:38:54 +00001486 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001487 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001488 */
danielk1977e180dd92007-04-05 17:15:52 +00001489 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001490 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001491 if( rc!=SQLITE_OK ){
1492 goto end_playback;
1493 }
danielk197776572402004-06-25 02:38:54 +00001494 }
1495
danielk197776572402004-06-25 02:38:54 +00001496 /* Copy original pages out of the journal and back into the database file.
1497 */
shane0b8d2762008-07-22 05:18:00 +00001498 for(u=0; u<nRec; u++){
danielk197762079062007-08-15 17:08:46 +00001499 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001500 if( rc!=SQLITE_OK ){
1501 if( rc==SQLITE_DONE ){
1502 rc = SQLITE_OK;
1503 pPager->journalOff = szJ;
1504 break;
1505 }else{
drha9625ea2008-09-03 00:08:29 +00001506 /* If we are unable to rollback, then the database is probably
1507 ** going to end up being corrupt. It is corrupt to us, anyhow.
1508 ** Perhaps the next process to come along can fix it....
1509 */
danielk197798c21902008-09-23 16:41:29 +00001510 rc = SQLITE_CORRUPT_BKPT;
danielk197776572402004-06-25 02:38:54 +00001511 goto end_playback;
1512 }
1513 }
drh968af522003-02-11 14:55:40 +00001514 }
drhed7c8552001-04-11 14:29:21 +00001515 }
drh580eeaf2006-02-24 03:09:37 +00001516 /*NOTREACHED*/
1517 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001518
1519end_playback:
drhc047b9f2008-11-21 03:23:43 +00001520 /* There may be pages in cache that are dirty but which were not in
1521 ** the rollback journal. Such pages would have been taken out of the
1522 ** freelist (and hence marked as DontRollback). All such pages must
1523 ** be reinitialized.
1524 */
1525 if( rc==SQLITE_OK && pPager->xReiniter ){
1526 PgHdr *pDirty; /* List of page that are still dirty */
1527 pDirty = sqlite3PcacheDirtyList(pPager->pPCache);
1528 while( pDirty ){
1529 pPager->xReiniter(pDirty);
1530 sqlite3PcacheMakeClean(pDirty);
1531 pDirty = pDirty->pDirty;
1532 }
1533 }
danielk19778191bff2004-06-28 04:52:30 +00001534 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001535 zMaster = pPager->pTmpSpace;
1536 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1537 }
1538 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001539 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001540 }
danielk1977c56774e2008-10-07 11:51:20 +00001541 if( rc==SQLITE_OK && zMaster[0] && res ){
danielk1977979f38e2007-03-27 16:19:51 +00001542 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001543 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001544 */
danielk197765839c62007-08-30 08:08:17 +00001545 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001546 }
danielk197776572402004-06-25 02:38:54 +00001547
1548 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001549 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001550 ** value. Reset it to the correct value for this process.
1551 */
drhc80f0582007-05-01 16:59:48 +00001552 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001553 return rc;
drhed7c8552001-04-11 14:29:21 +00001554}
1555
1556/*
drhac69b052004-05-12 13:30:07 +00001557** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001558**
1559** This is similar to playing back the transaction journal but with
1560** a few extra twists.
1561**
drh663fc632002-02-02 18:49:19 +00001562** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001563** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001564** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001565**
drhac69b052004-05-12 13:30:07 +00001566** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001567** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001568** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001569*/
drh3aac2dd2004-04-26 14:10:20 +00001570static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001571 i64 szJ; /* Size of the full journal */
1572 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001573 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001574 int i; /* Loop counter */
1575 int rc;
1576
danielk197776572402004-06-25 02:38:54 +00001577 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001578
danielk19774099f6e2007-03-19 11:25:20 +00001579 /* Set hdrOff to be the offset just after the end of the last journal
1580 ** page written before the first journal-header for this statement
1581 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001582 ** header was written.
1583 */
1584 hdrOff = pPager->stmtHdrOff;
1585 assert( pPager->fullSync || !hdrOff );
1586 if( !hdrOff ){
1587 hdrOff = szJ;
1588 }
1589
drhfa86c412002-02-02 15:01:15 +00001590 /* Truncate the database back to its original size.
1591 */
danielk1977e180dd92007-04-05 17:15:52 +00001592 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001593 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001594
drhac69b052004-05-12 13:30:07 +00001595 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001596 */
drhac69b052004-05-12 13:30:07 +00001597 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001598 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001599
drhac69b052004-05-12 13:30:07 +00001600 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001601 ** database file. Note that the statement journal omits checksums from
1602 ** each record since power-failure recovery is not important to statement
1603 ** journals.
drhfa86c412002-02-02 15:01:15 +00001604 */
danielk197762079062007-08-15 17:08:46 +00001605 for(i=0; i<nRec; i++){
1606 i64 offset = i*(4+pPager->pageSize);
1607 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001608 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001609 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001610 }
1611
danielk197776572402004-06-25 02:38:54 +00001612 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1613 ** was the size of the journal file when this statement was started, so
1614 ** everything after that needs to be rolled back, either into the
1615 ** database, the memory cache, or both.
1616 **
1617 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1618 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001619 */
danielk197776572402004-06-25 02:38:54 +00001620 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001621 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001622 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001623 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001624 assert( rc!=SQLITE_DONE );
1625 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1626 }
1627
1628 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001629 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001630 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001631 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001632 if( rc!=SQLITE_OK ){
1633 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001634 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001635 }
danielk1977f0113002006-01-24 12:09:17 +00001636 if( nJRec==0 ){
1637 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001638 }
danielk1977f0113002006-01-24 12:09:17 +00001639 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001640 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001641 assert( rc!=SQLITE_DONE );
1642 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1643 }
drhfa86c412002-02-02 15:01:15 +00001644 }
danielk197776572402004-06-25 02:38:54 +00001645
1646 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001647
drh3aac2dd2004-04-26 14:10:20 +00001648end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001649 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001650 pPager->journalOff = szJ;
1651 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001652 }
1653 return rc;
1654}
1655
1656/*
drhf57b14a2001-09-14 18:54:08 +00001657** Change the maximum number of in-memory pages that are allowed.
1658*/
danielk19773b8a05f2007-03-19 17:44:26 +00001659void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
danielk19778c0a7912008-08-20 14:49:23 +00001660 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001661}
1662
1663/*
drh973b6e32003-02-12 14:09:42 +00001664** Adjust the robustness of the database to damage due to OS crashes
1665** or power failures by changing the number of syncs()s when writing
1666** the rollback journal. There are three levels:
1667**
drh054889e2005-11-30 03:20:31 +00001668** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001669** for temporary and transient files.
1670**
1671** NORMAL The journal is synced once before writes begin on the
1672** database. This is normally adequate protection, but
1673** it is theoretically possible, though very unlikely,
1674** that an inopertune power failure could leave the journal
1675** in a state which would cause damage to the database
1676** when it is rolled back.
1677**
1678** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001679** database (with some additional information - the nRec field
1680** of the journal header - being written in between the two
1681** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001682** single disk sector is atomic, then this mode provides
1683** assurance that the journal will not be corrupted to the
1684** point of causing damage to the database during rollback.
1685**
1686** Numeric values associated with these states are OFF==1, NORMAL=2,
1687** and FULL=3.
1688*/
danielk197793758c82005-01-21 08:13:14 +00001689#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh281b21d2008-08-22 12:57:08 +00001690void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){
danielk1977b3175382008-10-17 18:51:52 +00001691 pPager->noSync = level==1 || pPager->tempFile;
drh973b6e32003-02-12 14:09:42 +00001692 pPager->fullSync = level==3 && !pPager->tempFile;
drh281b21d2008-08-22 12:57:08 +00001693 pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001694 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001695}
danielk197793758c82005-01-21 08:13:14 +00001696#endif
drh973b6e32003-02-12 14:09:42 +00001697
1698/*
drhaf6df112005-06-07 02:12:30 +00001699** The following global variable is incremented whenever the library
1700** attempts to open a temporary file. This information is used for
1701** testing and analysis only.
1702*/
drh0f7eb612006-08-08 13:51:43 +00001703#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001704int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001705#endif
drhaf6df112005-06-07 02:12:30 +00001706
1707/*
drh3f56e6e2007-03-15 01:16:47 +00001708** Open a temporary file.
1709**
1710** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001711** other error code if we fail. The OS will automatically delete the temporary
1712** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001713*/
danielk1977b4b47412007-08-17 15:53:36 +00001714static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00001715 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00001716 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00001717 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00001718){
drhfa86c412002-02-02 15:01:15 +00001719 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001720
drh0f7eb612006-08-08 13:51:43 +00001721#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001722 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001723#endif
danielk1977b4b47412007-08-17 15:53:36 +00001724
drh33f4e022007-09-03 15:19:34 +00001725 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
1726 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00001727 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00001728 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00001729 return rc;
1730}
1731
danielk1977a858aa22008-08-22 16:22:17 +00001732static int pagerStress(void *,PgHdr *);
danielk19778c0a7912008-08-20 14:49:23 +00001733
drhfa86c412002-02-02 15:01:15 +00001734/*
drhed7c8552001-04-11 14:29:21 +00001735** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001736** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001737** the first call to sqlite3PagerGet() and is only held open until the
1738** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001739**
drh6446c4d2001-12-15 14:22:18 +00001740** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00001741** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00001742** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001743**
1744** If zFilename is ":memory:" then all information is held in cache.
1745** It is never written to disk. This can be used to implement an
1746** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001747*/
danielk19773b8a05f2007-03-19 17:44:26 +00001748int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001749 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001750 Pager **ppPager, /* Return the Pager structure here */
1751 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001752 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00001753 int flags, /* flags controlling this file */
1754 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00001755){
danielk1977b4b47412007-08-17 15:53:36 +00001756 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001757 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001758 int rc = SQLITE_OK;
1759 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001760 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001761 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001762 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001763 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1764 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977b3175382008-10-17 18:51:52 +00001765 int journalFileSize;
danielk19778c0a7912008-08-20 14:49:23 +00001766 int pcacheSize = sqlite3PcacheSize();
drhfacf0302008-06-17 15:12:00 +00001767 int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00001768 char *zPathname = 0;
1769 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001770
danielk1977b3175382008-10-17 18:51:52 +00001771 if( sqlite3JournalSize(pVfs)>sqlite3MemJournalSize() ){
1772 journalFileSize = sqlite3JournalSize(pVfs);
1773 }else{
1774 journalFileSize = sqlite3MemJournalSize();
1775 }
1776
drh86f8c192007-08-22 00:39:19 +00001777 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001778 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001779
danielk197717b90b52008-06-06 11:11:25 +00001780 /* Compute and store the full pathname in an allocated buffer pointed
1781 ** to by zPathname, length nPathname. Or, if this is a temporary file,
1782 ** leave both nPathname and zPathname set to 0.
1783 */
drh1cc8c442007-08-24 16:08:29 +00001784 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00001785 nPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001786 zPathname = sqlite3Malloc(nPathname*2);
danielk197717b90b52008-06-06 11:11:25 +00001787 if( zPathname==0 ){
1788 return SQLITE_NOMEM;
1789 }
drh1cc8c442007-08-24 16:08:29 +00001790#ifndef SQLITE_OMIT_MEMORYDB
1791 if( strcmp(zFilename,":memory:")==0 ){
1792 memDb = 1;
1793 zPathname[0] = 0;
1794 }else
1795#endif
1796 {
danielk1977adfb9b02007-09-17 07:02:56 +00001797 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00001798 }
danielk197717b90b52008-06-06 11:11:25 +00001799 if( rc!=SQLITE_OK ){
1800 sqlite3_free(zPathname);
1801 return rc;
1802 }
1803 nPathname = strlen(zPathname);
drhae28c012007-08-24 16:29:23 +00001804 }
drh99b90c32008-03-17 13:50:58 +00001805
danielk1977b4b47412007-08-17 15:53:36 +00001806 /* Allocate memory for the pager structure */
1807 pPager = sqlite3MallocZero(
1808 sizeof(*pPager) + /* Pager structure */
danielk19778c0a7912008-08-20 14:49:23 +00001809 pcacheSize + /* PCache object */
danielk1977c7b60172007-08-22 11:22:03 +00001810 journalFileSize + /* The journal file structure */
danielk1977b3175382008-10-17 18:51:52 +00001811 pVfs->szOsFile + /* The main db file */
1812 journalFileSize * 2 + /* The two journal files */
danielk197717b90b52008-06-06 11:11:25 +00001813 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00001814 );
1815 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00001816 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00001817 return SQLITE_NOMEM;
1818 }
danielk19778c0a7912008-08-20 14:49:23 +00001819 pPager->pPCache = (PCache *)&pPager[1];
1820 pPtr = ((u8 *)&pPager[1]) + pcacheSize;
drh33f4e022007-09-03 15:19:34 +00001821 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00001822 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977b3175382008-10-17 18:51:52 +00001823 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile];
1824 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile+journalFileSize];
1825 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile+2*journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00001826 pPager->zDirectory = &pPager->zFilename[nPathname+1];
1827 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00001828 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00001829 if( zPathname ){
1830 memcpy(pPager->zFilename, zPathname, nPathname+1);
1831 sqlite3_free(zPathname);
1832 }
danielk1977b4b47412007-08-17 15:53:36 +00001833
drh153c62c2007-08-24 03:51:33 +00001834 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00001835 */
drhae28c012007-08-24 16:29:23 +00001836 if( zFilename && zFilename[0] && !memDb ){
danielk1977d92db532008-11-17 04:56:24 +00001837 if( nPathname>(pVfs->mxPathname - (int)sizeof("-journal")) ){
drh1cc8c442007-08-24 16:08:29 +00001838 rc = SQLITE_CANTOPEN;
1839 }else{
drh1cc8c442007-08-24 16:08:29 +00001840 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00001841 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
1842 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00001843 readOnly = (fout&SQLITE_OPEN_READONLY);
1844
1845 /* If the file was successfully opened for read/write access,
1846 ** choose a default page size in case we have to create the
1847 ** database file. The default page size is the maximum of:
1848 **
1849 ** + SQLITE_DEFAULT_PAGE_SIZE,
1850 ** + The value returned by sqlite3OsSectorSize()
1851 ** + The largest page size that can be written atomically.
1852 */
1853 if( rc==SQLITE_OK && !readOnly ){
1854 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
drhfacf0302008-06-17 15:12:00 +00001855 if( szPageDflt<iSectorSize ){
1856 szPageDflt = iSectorSize;
drh1cc8c442007-08-24 16:08:29 +00001857 }
danielk19779663b8f2007-08-24 11:52:28 +00001858#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00001859 {
1860 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
1861 int ii;
1862 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1863 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1864 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
drhfacf0302008-06-17 15:12:00 +00001865 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
1866 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii;
danielk19779663b8f2007-08-24 11:52:28 +00001867 }
danielk1977b4b47412007-08-17 15:53:36 +00001868 }
drh1cc8c442007-08-24 16:08:29 +00001869#endif
drhfacf0302008-06-17 15:12:00 +00001870 if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
1871 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
drh1cc8c442007-08-24 16:08:29 +00001872 }
danielk19778def5ea2004-06-16 10:39:52 +00001873 }
drhac69b052004-05-12 13:30:07 +00001874 }
danielk1977b3175382008-10-17 18:51:52 +00001875 }else{
danielk19777a2b1ee2007-08-21 14:27:01 +00001876 /* If a temporary file is requested, it is not opened immediately.
1877 ** In this case we accept the default page size and delay actually
1878 ** opening the file until the first call to OsWrite().
danielk1977b3175382008-10-17 18:51:52 +00001879 **
1880 ** This branch is also run for an in-memory database. An in-memory
1881 ** database is the same as a temp-file that is never written out to
1882 ** disk and uses an in-memory rollback journal.
danielk19777a2b1ee2007-08-21 14:27:01 +00001883 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001884 tempFile = 1;
1885 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001886 }
danielk1977aef0bf62005-12-30 16:28:01 +00001887
danielk1977b4b47412007-08-17 15:53:36 +00001888 if( pPager && rc==SQLITE_OK ){
drhfacf0302008-06-17 15:12:00 +00001889 pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt);
drh3e7a6092002-12-07 21:45:14 +00001890 }
danielk1977aef0bf62005-12-30 16:28:01 +00001891
drh153c62c2007-08-24 03:51:33 +00001892 /* If an error occured in either of the blocks above.
1893 ** Free the Pager structure and close the file.
1894 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00001895 ** any Pager.errMask variables.
1896 */
danielk1977b4b47412007-08-17 15:53:36 +00001897 if( !pPager || !pPager->pTmpSpace ){
1898 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001899 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001900 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001901 }
danielk19778c0a7912008-08-20 14:49:23 +00001902 nExtra = FORCE_ALIGNMENT(nExtra);
danielk197771d5d2c2008-09-29 11:49:47 +00001903 sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
drh41d30272008-08-20 21:47:45 +00001904 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
danielk1977aef0bf62005-12-30 16:28:01 +00001905
drh153c62c2007-08-24 03:51:33 +00001906 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
1907 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00001908
danielk1977b4b47412007-08-17 15:53:36 +00001909 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00001910 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00001911 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001912 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001913
drh99b90c32008-03-17 13:50:58 +00001914 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00001915 if( zPathname ){
1916 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
1917 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
1918 }else{
1919 pPager->zJournal = 0;
1920 }
danielk1977b4b47412007-08-17 15:53:36 +00001921
drh3b59a5c2006-01-15 20:28:28 +00001922 /* pPager->journalOpen = 0; */
drhb3df2e12008-09-17 20:06:26 +00001923 pPager->useJournal = useJournal;
drh7bec5052005-02-06 02:45:41 +00001924 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001925 /* pPager->stmtOpen = 0; */
1926 /* pPager->stmtInUse = 0; */
1927 /* pPager->nRef = 0; */
danielk1977d92db532008-11-17 04:56:24 +00001928 pPager->dbSizeValid = memDb;
drhfacf0302008-06-17 15:12:00 +00001929 pPager->pageSize = szPageDflt;
drh3b59a5c2006-01-15 20:28:28 +00001930 /* pPager->stmtSize = 0; */
1931 /* pPager->stmtJSize = 0; */
1932 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001933 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001934 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001935 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00001936 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00001937 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001938 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001939 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1940 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1941 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1942 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001943 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001944 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001945 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001946 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001947 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00001948 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00001949 /* pPager->pFirst = 0; */
1950 /* pPager->pFirstSynced = 0; */
1951 /* pPager->pLast = 0; */
danielk19778c0a7912008-08-20 14:49:23 +00001952 pPager->nExtra = nExtra;
danielk1977b53e4962008-06-04 06:45:59 +00001953 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk1977b3175382008-10-17 18:51:52 +00001954 assert(pPager->fd->pMethods||tempFile);
1955 setSectorSize(pPager);
1956 if( memDb ){
1957 pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
danielk1977b4721172007-03-19 05:54:48 +00001958 }
danielk19771ceedd32008-11-19 10:22:33 +00001959 /* pPager->xBusyHandler = 0; */
1960 /* pPager->pBusyHandlerArg = 0; */
drh3b59a5c2006-01-15 20:28:28 +00001961 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001962 *ppPager = pPager;
1963 return SQLITE_OK;
1964}
1965
1966/*
drh90f5ecb2004-07-22 01:19:35 +00001967** Set the busy handler function.
1968*/
danielk19771ceedd32008-11-19 10:22:33 +00001969void sqlite3PagerSetBusyhandler(
1970 Pager *pPager,
1971 int (*xBusyHandler)(void *),
1972 void *pBusyHandlerArg
1973){
1974 pPager->xBusyHandler = xBusyHandler;
1975 pPager->pBusyHandlerArg = pBusyHandlerArg;
drh90f5ecb2004-07-22 01:19:35 +00001976}
1977
1978/*
drha6abd042004-06-09 17:37:22 +00001979** Set the reinitializer for this pager. If not NULL, the reinitializer
1980** is called when the content of a page in cache is restored to its original
1981** value as a result of a rollback. The callback gives higher-level code
1982** an opportunity to restore the EXTRA section to agree with the restored
1983** page data.
1984*/
danielk1977eaa06f62008-09-18 17:34:44 +00001985void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*)){
drha6abd042004-06-09 17:37:22 +00001986 pPager->xReiniter = xReinit;
1987}
1988
1989/*
danielk1977a1644fd2007-08-29 12:31:25 +00001990** Set the page size to *pPageSize. If the suggest new page size is
1991** inappropriate, then an alternative page size is set to that
1992** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00001993*/
danielk1977a1644fd2007-08-29 12:31:25 +00001994int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
danielk19771357d9f2008-09-16 05:12:24 +00001995 int rc = pPager->errCode;
1996 if( rc==SQLITE_OK ){
1997 u16 pageSize = *pPageSize;
1998 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
1999 if( pageSize && pageSize!=pPager->pageSize
2000 && (pPager->memDb==0 || pPager->dbSize==0)
2001 && sqlite3PcacheRefCount(pPager->pPCache)==0
2002 ){
2003 char *pNew = (char *)sqlite3PageMalloc(pageSize);
2004 if( !pNew ){
2005 rc = SQLITE_NOMEM;
2006 }else{
2007 pager_reset(pPager);
2008 pPager->pageSize = pageSize;
2009 if( !pPager->memDb ) setSectorSize(pPager);
2010 sqlite3PageFree(pPager->pTmpSpace);
2011 pPager->pTmpSpace = pNew;
2012 sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
2013 }
danielk1977a1644fd2007-08-29 12:31:25 +00002014 }
danielk19771357d9f2008-09-16 05:12:24 +00002015 *pPageSize = pPager->pageSize;
drh1c7880e2005-05-20 20:01:55 +00002016 }
danielk1977a1644fd2007-08-29 12:31:25 +00002017 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002018}
2019
2020/*
drh26b79942007-11-28 16:19:56 +00002021** Return a pointer to the "temporary page" buffer held internally
2022** by the pager. This is a buffer that is big enough to hold the
2023** entire content of a database page. This buffer is used internally
2024** during rollback and will be overwritten whenever a rollback
2025** occurs. But other modules are free to use it too, as long as
2026** no rollbacks are happening.
2027*/
2028void *sqlite3PagerTempSpace(Pager *pPager){
2029 return pPager->pTmpSpace;
2030}
2031
2032/*
drhf8e632b2007-05-08 14:51:36 +00002033** Attempt to set the maximum database page count if mxPage is positive.
2034** Make no changes if mxPage is zero or negative. And never reduce the
2035** maximum page count below the current size of the database.
2036**
2037** Regardless of mxPage, return the current maximum page count.
2038*/
2039int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2040 if( mxPage>0 ){
2041 pPager->mxPgno = mxPage;
2042 }
danielk1977ad0132d2008-06-07 08:58:22 +00002043 sqlite3PagerPagecount(pPager, 0);
drhf8e632b2007-05-08 14:51:36 +00002044 return pPager->mxPgno;
2045}
2046
2047/*
drhc9ac5ca2005-11-04 22:03:30 +00002048** The following set of routines are used to disable the simulated
2049** I/O error mechanism. These routines are used to avoid simulated
2050** errors in places where we do not care about errors.
2051**
2052** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2053** and generate no code.
2054*/
2055#ifdef SQLITE_TEST
2056extern int sqlite3_io_error_pending;
2057extern int sqlite3_io_error_hit;
2058static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002059void disable_simulated_io_errors(void){
2060 saved_cnt = sqlite3_io_error_pending;
2061 sqlite3_io_error_pending = -1;
2062}
2063void enable_simulated_io_errors(void){
2064 sqlite3_io_error_pending = saved_cnt;
2065}
2066#else
drh152410f2005-11-05 15:11:22 +00002067# define disable_simulated_io_errors()
2068# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002069#endif
2070
2071/*
drh90f5ecb2004-07-22 01:19:35 +00002072** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002073** that pDest points to.
2074**
2075** No error checking is done. The rational for this is that this function
2076** may be called even if the file does not exist or contain a header. In
2077** these cases sqlite3OsRead() will return an error, to which the correct
2078** response is to zero the memory at pDest and continue. A real IO error
2079** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002080*/
danielk19773b8a05f2007-03-19 17:44:26 +00002081int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002082 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002083 memset(pDest, 0, N);
danielk1977b3175382008-10-17 18:51:52 +00002084 assert(pPager->fd->pMethods||pPager->tempFile);
danielk19777a2b1ee2007-08-21 14:27:01 +00002085 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002086 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002087 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002088 if( rc==SQLITE_IOERR_SHORT_READ ){
2089 rc = SQLITE_OK;
2090 }
drh90f5ecb2004-07-22 01:19:35 +00002091 }
drh551b7732006-11-06 21:20:25 +00002092 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002093}
2094
2095/*
drh5e00f6c2001-09-13 13:46:56 +00002096** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002097** pPager.
2098**
2099** If the PENDING_BYTE lies on the page directly after the end of the
2100** file, then consider this page part of the file too. For example, if
2101** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2102** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002103*/
danielk1977ad0132d2008-06-07 08:58:22 +00002104int sqlite3PagerPagecount(Pager *pPager, int *pnPage){
danielk19777a2b1ee2007-08-21 14:27:01 +00002105 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002106 int rc;
drhd9b02572001-04-15 00:37:09 +00002107 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002108 if( pPager->errCode ){
danielk19778c0a7912008-08-20 14:49:23 +00002109 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002110 return rc;
drha7aea3d2007-03-15 12:51:16 +00002111 }
danielk1977d92db532008-11-17 04:56:24 +00002112 if( pPager->dbSizeValid ){
danielk197715f411d2005-09-16 10:18:45 +00002113 n = pPager->dbSize;
2114 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002115 assert(pPager->fd->pMethods||pPager->tempFile);
2116 if( (pPager->fd->pMethods)
2117 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002118 pager_error(pPager, rc);
danielk1977ad0132d2008-06-07 08:58:22 +00002119 return rc;
danielk197715f411d2005-09-16 10:18:45 +00002120 }
2121 if( n>0 && n<pPager->pageSize ){
2122 n = 1;
2123 }else{
2124 n /= pPager->pageSize;
2125 }
2126 if( pPager->state!=PAGER_UNLOCK ){
2127 pPager->dbSize = n;
danielk1977d92db532008-11-17 04:56:24 +00002128 pPager->dbSizeValid = 1;
danielk197715f411d2005-09-16 10:18:45 +00002129 }
drhed7c8552001-04-11 14:29:21 +00002130 }
danielk197715f411d2005-09-16 10:18:45 +00002131 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002132 n++;
2133 }
drhf8e632b2007-05-08 14:51:36 +00002134 if( n>pPager->mxPgno ){
2135 pPager->mxPgno = n;
2136 }
danielk1977ad0132d2008-06-07 08:58:22 +00002137 if( pnPage ){
2138 *pnPage = n;
2139 }
2140 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002141}
2142
2143/*
drhf7c57532003-04-25 13:22:51 +00002144** Forward declaration
2145*/
danielk197776572402004-06-25 02:38:54 +00002146static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002147
2148/*
danielk1977e180dd92007-04-05 17:15:52 +00002149** This routine is used to truncate the cache when a database
2150** is truncated. Drop from the cache all pages whose pgno is
2151** larger than pPager->dbSize and is unreferenced.
2152**
drhac69b052004-05-12 13:30:07 +00002153** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002154**
2155** Actually, at the point this routine is called, it would be
2156** an error to have a referenced page. But rather than delete
2157** that page and guarantee a subsequent segfault, it seems better
2158** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002159*/
danielk1977e180dd92007-04-05 17:15:52 +00002160static void pager_truncate_cache(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00002161 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
drhac69b052004-05-12 13:30:07 +00002162}
2163
drhf7c57532003-04-25 13:22:51 +00002164/*
danielk197717221812005-02-15 03:38:05 +00002165** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002166** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002167** false or until the lock succeeds.
2168**
2169** Return SQLITE_OK on success and an error code if we cannot obtain
2170** the lock.
2171*/
2172static int pager_wait_on_lock(Pager *pPager, int locktype){
2173 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002174
2175 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002176 assert( PAGER_SHARED==SHARED_LOCK );
2177 assert( PAGER_RESERVED==RESERVED_LOCK );
2178 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002179
2180 /* If the file is currently unlocked then the size must be unknown */
danielk1977d92db532008-11-17 04:56:24 +00002181 assert( pPager->state>=PAGER_SHARED || pPager->dbSizeValid==0 );
drh1aa2d8b2007-01-03 15:34:29 +00002182
danielk197717221812005-02-15 03:38:05 +00002183 if( pPager->state>=locktype ){
2184 rc = SQLITE_OK;
2185 }else{
danielk197717221812005-02-15 03:38:05 +00002186 do {
drh054889e2005-11-30 03:20:31 +00002187 rc = sqlite3OsLock(pPager->fd, locktype);
danielk19771ceedd32008-11-19 10:22:33 +00002188 }while( rc==SQLITE_BUSY && pPager->xBusyHandler(pPager->pBusyHandlerArg) );
danielk197717221812005-02-15 03:38:05 +00002189 if( rc==SQLITE_OK ){
2190 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002191 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002192 }
2193 }
2194 return rc;
2195}
2196
2197/*
drhf7c57532003-04-25 13:22:51 +00002198** Truncate the file to the number of pages specified.
2199*/
danielk19773b8a05f2007-03-19 17:44:26 +00002200int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
danielk19778c0a7912008-08-20 14:49:23 +00002201 int rc = SQLITE_OK;
danielk1977b3175382008-10-17 18:51:52 +00002202 assert( pPager->state>=PAGER_SHARED );
danielk19778c0a7912008-08-20 14:49:23 +00002203
danielk1977ad0132d2008-06-07 08:58:22 +00002204 sqlite3PagerPagecount(pPager, 0);
danielk1977efaaf572006-01-16 11:29:19 +00002205 if( pPager->errCode ){
2206 rc = pPager->errCode;
danielk1977d92db532008-11-17 04:56:24 +00002207 }else if( nPage<pPager->dbSize ){
danielk1977b3175382008-10-17 18:51:52 +00002208 rc = syncJournal(pPager);
2209 if( rc==SQLITE_OK ){
2210 /* Get an exclusive lock on the database before truncating. */
2211 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2212 }
2213 if( rc==SQLITE_OK ){
2214 rc = pager_truncate(pPager, nPage);
danielk19778c0a7912008-08-20 14:49:23 +00002215 }
danielk1977369f27e2004-06-15 11:40:04 +00002216 }
danielk197717221812005-02-15 03:38:05 +00002217
drhf7c57532003-04-25 13:22:51 +00002218 return rc;
2219}
2220
2221/*
drhed7c8552001-04-11 14:29:21 +00002222** Shutdown the page cache. Free all memory and close all files.
2223**
2224** If a transaction was in progress when this routine is called, that
2225** transaction is rolled back. All outstanding pages are invalidated
2226** and their memory is freed. Any attempt to use a page associated
2227** with this page cache after this function returns will likely
2228** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002229**
2230** This function always succeeds. If a transaction is active an attempt
2231** is made to roll it back. If an error occurs during the rollback
2232** a hot journal may be left in the filesystem but no error is returned
2233** to the caller.
drhed7c8552001-04-11 14:29:21 +00002234*/
danielk19773b8a05f2007-03-19 17:44:26 +00002235int sqlite3PagerClose(Pager *pPager){
danielk197713f72992005-12-18 08:51:22 +00002236
drhbafda092007-01-03 23:36:22 +00002237 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002238 sqlite3BeginBenignMalloc();
drhc2ee76c2007-01-04 14:58:14 +00002239 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002240 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002241 pager_reset(pPager);
danielk1977b3175382008-10-17 18:51:52 +00002242 if( !MEMDB ){
2243 pagerUnlockAndRollback(pPager);
2244 }
drhbafda092007-01-03 23:36:22 +00002245 enable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002246 sqlite3EndBenignMalloc();
drh4f0c5872007-03-26 22:05:01 +00002247 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002248 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002249 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002250 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002251 }
drhf5e7bb52008-02-18 14:47:33 +00002252 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977a1fa00d2008-08-27 15:16:33 +00002253 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
danielk1977e94ddc92005-03-21 03:53:38 +00002254 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002255 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002256 }
danielk1977b4b47412007-08-17 15:53:36 +00002257 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002258 /* Temp files are automatically deleted by the OS
2259 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002260 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002261 ** }
2262 */
danielk1977aca790a2005-01-13 11:07:52 +00002263
drhfacf0302008-06-17 15:12:00 +00002264 sqlite3PageFree(pPager->pTmpSpace);
danielk19778c0a7912008-08-20 14:49:23 +00002265 sqlite3PcacheClose(pPager->pPCache);
drh17435752007-08-16 04:30:38 +00002266 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002267 return SQLITE_OK;
2268}
2269
drh87cc3b32007-05-08 21:45:27 +00002270#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002271/*
drh5e00f6c2001-09-13 13:46:56 +00002272** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002273*/
danielk19773b8a05f2007-03-19 17:44:26 +00002274Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002275 return p->pgno;
2276}
drh87cc3b32007-05-08 21:45:27 +00002277#endif
drhed7c8552001-04-11 14:29:21 +00002278
2279/*
drhdf0b3b02001-06-23 11:36:20 +00002280** Increment the reference count for a page. The input pointer is
2281** a reference to the page data.
2282*/
danielk19773b8a05f2007-03-19 17:44:26 +00002283int sqlite3PagerRef(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002284 sqlite3PcacheRef(pPg);
drh8c42ca92001-06-22 19:15:00 +00002285 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002286}
2287
2288/*
drh34e79ce2004-02-08 06:05:46 +00002289** Sync the journal. In other words, make sure all the pages that have
2290** been written to the journal have actually reached the surface of the
2291** disk. It is not safe to modify the original database file until after
2292** the journal has been synced. If the original database is modified before
2293** the journal is synced and a power failure occurs, the unsynced journal
2294** data would be lost and we would be unable to completely rollback the
2295** database changes. Database corruption would occur.
2296**
2297** This routine also updates the nRec field in the header of the journal.
2298** (See comments on the pager_playback() routine for additional information.)
2299** If the sync mode is FULL, two syncs will occur. First the whole journal
2300** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002301**
drh34e79ce2004-02-08 06:05:46 +00002302** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002303** after a power failure, so no sync occurs.
2304**
2305** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2306** the database is stored, then OsSync() is never called on the journal
2307** file. In this case all that is required is to update the nRec field in
2308** the journal header.
drhfa86c412002-02-02 15:01:15 +00002309**
drh34e79ce2004-02-08 06:05:46 +00002310** This routine clears the needSync field of every page current held in
2311** memory.
drh50e5dad2001-09-15 00:57:28 +00002312*/
danielk197776572402004-06-25 02:38:54 +00002313static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002314 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002315
2316 /* Sync the journal before modifying the main database
2317 ** (assuming there is a journal and it needs to be synced.)
2318 */
danielk197776572402004-06-25 02:38:54 +00002319 if( pPager->needSync ){
danielk1977b3175382008-10-17 18:51:52 +00002320 assert( !pPager->tempFile );
2321 if( pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
danielk19774cd2cd52007-08-23 14:48:23 +00002322 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002323 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002324
danielk19774cd2cd52007-08-23 14:48:23 +00002325 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002326 /* Write the nRec value into the journal file header. If in
2327 ** full-synchronous mode, sync the journal first. This ensures that
2328 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002329 ** it as a candidate for rollback.
2330 **
2331 ** This is not required if the persistent media supports the
2332 ** SAFE_APPEND property. Because in this case it is not possible
2333 ** for garbage data to be appended to the file, the nRec field
2334 ** is populated with 0xFFFFFFFF when the journal header is written
2335 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002336 */
danielk19774cd2cd52007-08-23 14:48:23 +00002337 i64 jrnlOff;
2338 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002339 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002340 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002341 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002342 if( rc!=0 ) return rc;
2343 }
danielk197713adf8a2004-06-03 16:08:41 +00002344
danielk197762079062007-08-15 17:08:46 +00002345 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2346 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2347 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002348 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002349 }
danielk19774cd2cd52007-08-23 14:48:23 +00002350 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2351 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2352 IOTRACE(("JSYNC %p\n", pPager))
2353 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2354 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2355 );
2356 if( rc!=0 ) return rc;
2357 }
drhdb48ee02003-01-16 13:42:43 +00002358 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002359 }
drh50e5dad2001-09-15 00:57:28 +00002360 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002361
2362 /* Erase the needSync flag from every page.
2363 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00002364 sqlite3PcacheClearSyncFlags(pPager->pPCache);
drh50e5dad2001-09-15 00:57:28 +00002365 }
drh03eb96a2002-11-10 23:32:56 +00002366
drh81a20f22001-10-12 17:30:04 +00002367 return rc;
drh50e5dad2001-09-15 00:57:28 +00002368}
2369
2370/*
drh2554f8b2003-01-22 01:26:44 +00002371** Given a list of pages (connected by the PgHdr.pDirty pointer) write
danielk1977a858aa22008-08-22 16:22:17 +00002372** every one of those pages out to the database file. No calls are made
2373** to the page-cache to mark the pages as clean. It is the responsibility
2374** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark
2375** the pages as clean.
drh2554f8b2003-01-22 01:26:44 +00002376*/
2377static int pager_write_pagelist(PgHdr *pList){
2378 Pager *pPager;
2379 int rc;
2380
2381 if( pList==0 ) return SQLITE_OK;
2382 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002383
2384 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2385 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002386 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002387 **
drha6abd042004-06-09 17:37:22 +00002388 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2389 ** through an intermediate state PENDING. A PENDING lock prevents new
2390 ** readers from attaching to the database but is unsufficient for us to
2391 ** write. The idea of a PENDING lock is to prevent new readers from
2392 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002393 **
drha6abd042004-06-09 17:37:22 +00002394 ** While the pager is in the RESERVED state, the original database file
2395 ** is unchanged and we can rollback without having to playback the
2396 ** journal into the original database file. Once we transition to
2397 ** EXCLUSIVE, it means the database file has been changed and any rollback
2398 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002399 */
drh684917c2004-10-05 02:41:42 +00002400 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002401 if( rc!=SQLITE_OK ){
2402 return rc;
2403 }
2404
drh2554f8b2003-01-22 01:26:44 +00002405 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002406
2407 /* If the file has not yet been opened, open it now. */
2408 if( !pPager->fd->pMethods ){
2409 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00002410 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002411 if( rc ) return rc;
2412 }
2413
danielk1977687566d2004-11-02 12:56:41 +00002414 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002415 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002416 ** make the file smaller (presumably by auto-vacuum code). Do not write
2417 ** any such pages to the file.
2418 */
danielk197733e32162008-08-23 18:53:08 +00002419 if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
danielk197762079062007-08-15 17:08:46 +00002420 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002421 char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00002422 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2423 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002424 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002425 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002426 PAGER_INCR(sqlite3_pager_writedb_count);
2427 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002428 if( pList->pgno==1 ){
2429 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2430 }
danielk1977687566d2004-11-02 12:56:41 +00002431 }
2432#ifndef NDEBUG
2433 else{
drh4f0c5872007-03-26 22:05:01 +00002434 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002435 }
2436#endif
drh2554f8b2003-01-22 01:26:44 +00002437 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002438#ifdef SQLITE_CHECK_PAGES
2439 pList->pageHash = pager_pagehash(pList);
2440#endif
drh2554f8b2003-01-22 01:26:44 +00002441 pList = pList->pDirty;
2442 }
danielk19778c0a7912008-08-20 14:49:23 +00002443
drh2554f8b2003-01-22 01:26:44 +00002444 return SQLITE_OK;
2445}
2446
2447/*
danielk19778c0a7912008-08-20 14:49:23 +00002448** This function is called by the pcache layer when it has reached some
2449** soft memory limit. The argument is a pointer to a purgeable Pager
2450** object. This function attempts to make a single dirty page that has no
2451** outstanding references (if one exists) clean so that it can be recycled
2452** by the pcache layer.
drh2554f8b2003-01-22 01:26:44 +00002453*/
danielk1977a858aa22008-08-22 16:22:17 +00002454static int pagerStress(void *p, PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002455 Pager *pPager = (Pager *)p;
danielk19778c0a7912008-08-20 14:49:23 +00002456 int rc = SQLITE_OK;
drh8f2e9a12008-02-26 14:46:04 +00002457
danielk19778c200142008-08-25 07:12:28 +00002458 if( pPager->doNotSync ){
2459 return SQLITE_OK;
2460 }
2461
danielk1977a858aa22008-08-22 16:22:17 +00002462 assert( pPg->flags&PGHDR_DIRTY );
2463 if( pPager->errCode==SQLITE_OK ){
2464 if( pPg->flags&PGHDR_NEED_SYNC ){
2465 rc = syncJournal(pPager);
2466 if( rc==SQLITE_OK && pPager->fullSync &&
danielk1977b3175382008-10-17 18:51:52 +00002467 !(pPager->journalMode==PAGER_JOURNALMODE_MEMORY) &&
danielk1977a858aa22008-08-22 16:22:17 +00002468 !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
2469 ){
2470 pPager->nRec = 0;
2471 rc = writeJournalHdr(pPager);
danielk19778c0a7912008-08-20 14:49:23 +00002472 }
danielk19778c0a7912008-08-20 14:49:23 +00002473 }
danielk1977a858aa22008-08-22 16:22:17 +00002474 if( rc==SQLITE_OK ){
2475 pPg->pDirty = 0;
2476 rc = pager_write_pagelist(pPg);
2477 }
2478 if( rc!=SQLITE_OK ){
2479 pager_error(pPager, rc);
2480 }
2481 }
2482
2483 if( rc==SQLITE_OK ){
2484 sqlite3PcacheMakeClean(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00002485 }
2486 return rc;
drh2554f8b2003-01-22 01:26:44 +00002487}
2488
danielk19778c0a7912008-08-20 14:49:23 +00002489
drh2554f8b2003-01-22 01:26:44 +00002490/*
drh19db9352008-03-27 22:42:51 +00002491** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00002492** A hot journal is one that needs to be played back.
2493**
2494** If the current size of the database file is 0 but a journal file
2495** exists, that is probably an old journal left over from a prior
2496** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00002497**
2498** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00002499**
2500** This routine does not open the journal file to examine its
2501** content. Hence, the journal might contain the name of a master
2502** journal file that has been deleted, and hence not be hot. Or
2503** the header of the journal might be zeroed out. This routine
2504** does not discover these cases of a non-hot journal - if the
2505** journal file exists and is not empty this routine assumes it
2506** is hot. The pager_playback() routine will discover that the
2507** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00002508*/
danielk1977d300b8a2008-08-01 10:50:23 +00002509static int hasHotJournal(Pager *pPager, int *pExists){
danielk1977b4b47412007-08-17 15:53:36 +00002510 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977d300b8a2008-08-01 10:50:23 +00002511 int rc = SQLITE_OK;
drh0a846f92008-08-25 17:23:29 +00002512 int exists;
2513 int locked;
2514 assert( pPager!=0 );
2515 assert( pPager->useJournal );
2516 assert( pPager->fd->pMethods );
danielk1977d300b8a2008-08-01 10:50:23 +00002517 *pExists = 0;
drh0a846f92008-08-25 17:23:29 +00002518 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
2519 if( rc==SQLITE_OK && exists ){
2520 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
2521 }
2522 if( rc==SQLITE_OK && exists && !locked ){
2523 int nPage;
2524 rc = sqlite3PagerPagecount(pPager, &nPage);
2525 if( rc==SQLITE_OK ){
2526 if( nPage==0 ){
2527 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2528 }else{
2529 *pExists = 1;
danielk1977861f7452008-06-05 11:39:11 +00002530 }
2531 }
drhbb5f18d2007-04-06 18:23:17 +00002532 }
danielk1977d300b8a2008-08-01 10:50:23 +00002533 return rc;
drh165ffe92005-03-15 17:09:30 +00002534}
2535
2536/*
danielk1977e180dd92007-04-05 17:15:52 +00002537** Read the content of page pPg out of the database file.
2538*/
2539static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2540 int rc;
danielk197762079062007-08-15 17:08:46 +00002541 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002542 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002543 assert(pPager->fd->pMethods||pPager->tempFile);
2544 if( !pPager->fd->pMethods ){
2545 return SQLITE_IOERR_SHORT_READ;
2546 }
danielk197762079062007-08-15 17:08:46 +00002547 offset = (pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002548 rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002549 PAGER_INCR(sqlite3_pager_readdb_count);
2550 PAGER_INCR(pPager->nRead);
2551 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002552 if( pgno==1 ){
danielk19778c0a7912008-08-20 14:49:23 +00002553 memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24],
drh86a88112007-04-16 15:02:19 +00002554 sizeof(pPager->dbFileVers));
2555 }
danielk197730849522008-08-21 04:35:18 +00002556 CODEC1(pPager, pPg->pData, pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002557 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2558 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002559 return rc;
2560}
2561
2562
2563/*
danielk1977e277be02007-03-23 18:12:06 +00002564** This function is called to obtain the shared lock required before
2565** data may be read from the pager cache. If the shared lock has already
2566** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002567**
2568** Immediately after obtaining the shared lock (if required), this function
2569** checks for a hot-journal file. If one is found, an emergency rollback
2570** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002571*/
2572static int pagerSharedLock(Pager *pPager){
2573 int rc = SQLITE_OK;
danielk1977d300b8a2008-08-01 10:50:23 +00002574 int isErrorReset = 0;
danielk1977e277be02007-03-23 18:12:06 +00002575
danielk1977ae72d982007-10-03 08:46:44 +00002576 /* If this database is opened for exclusive access, has no outstanding
2577 ** page references and is in an error-state, now is the chance to clear
2578 ** the error. Discard the contents of the pager-cache and treat any
2579 ** open journal file as a hot-journal.
2580 */
danielk19778c0a7912008-08-20 14:49:23 +00002581 if( !MEMDB && pPager->exclusiveMode
2582 && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode
2583 ){
danielk1977ae72d982007-10-03 08:46:44 +00002584 if( pPager->journalOpen ){
danielk1977d300b8a2008-08-01 10:50:23 +00002585 isErrorReset = 1;
danielk1977ae72d982007-10-03 08:46:44 +00002586 }
danielk1977ae72d982007-10-03 08:46:44 +00002587 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00002588 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00002589 }
2590
2591 /* If the pager is still in an error state, do not proceed. The error
2592 ** state will be cleared at some point in the future when all page
2593 ** references are dropped and the cache can be discarded.
2594 */
2595 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2596 return pPager->errCode;
2597 }
2598
danielk1977d300b8a2008-08-01 10:50:23 +00002599 if( pPager->state==PAGER_UNLOCK || isErrorReset ){
danielk1977b4b47412007-08-17 15:53:36 +00002600 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977b3175382008-10-17 18:51:52 +00002601 int isHotJournal;
shane049fc212008-10-22 16:26:47 +00002602 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00002603 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
2604 if( !pPager->noReadlock ){
2605 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2606 if( rc!=SQLITE_OK ){
2607 assert( pPager->state==PAGER_UNLOCK );
2608 return pager_error(pPager, rc);
danielk1977e277be02007-03-23 18:12:06 +00002609 }
danielk1977b3175382008-10-17 18:51:52 +00002610 assert( pPager->state>=SHARED_LOCK );
2611 }
2612
2613 /* If a journal file exists, and there is no RESERVED lock on the
2614 ** database file, then it either needs to be played back or deleted.
2615 */
2616 if( !isErrorReset ){
2617 rc = hasHotJournal(pPager, &isHotJournal);
2618 if( rc!=SQLITE_OK ){
2619 goto failed;
2620 }
2621 }
2622 if( isErrorReset || isHotJournal ){
2623 /* Get an EXCLUSIVE lock on the database file. At this point it is
2624 ** important that a RESERVED lock is not obtained on the way to the
2625 ** EXCLUSIVE lock. If it were, another process might open the
2626 ** database file, detect the RESERVED lock, and conclude that the
2627 ** database is safe to read while this process is still rolling it
2628 ** back.
2629 **
2630 ** Because the intermediate RESERVED lock is not requested, the
2631 ** second process will get to this point in the code and fail to
2632 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00002633 */
danielk1977b3175382008-10-17 18:51:52 +00002634 if( pPager->state<EXCLUSIVE_LOCK ){
2635 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
danielk1977e277be02007-03-23 18:12:06 +00002636 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002637 rc = pager_error(pPager, rc);
2638 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002639 }
danielk1977b3175382008-10-17 18:51:52 +00002640 pPager->state = PAGER_EXCLUSIVE;
2641 }
2642
2643 /* Open the journal for read/write access. This is because in
2644 ** exclusive-access mode the file descriptor will be kept open and
2645 ** possibly used for a transaction later on. On some systems, the
2646 ** OsTruncate() call used in exclusive-access mode also requires
2647 ** a read/write file handle.
2648 */
2649 if( !isErrorReset && pPager->journalOpen==0 ){
2650 int res;
2651 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
2652 if( rc==SQLITE_OK ){
2653 if( res ){
2654 int fout = 0;
2655 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
2656 assert( !pPager->tempFile );
2657 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
2658 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk1977281d8bd2008-10-29 07:01:56 +00002659 if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
2660 rc = SQLITE_CANTOPEN;
danielk1977b3175382008-10-17 18:51:52 +00002661 sqlite3OsClose(pPager->jfd);
2662 }
2663 }else{
2664 /* If the journal does not exist, that means some other process
2665 ** has already rolled it back */
2666 rc = SQLITE_BUSY;
2667 }
2668 }
2669 }
2670 if( rc!=SQLITE_OK ){
danielk1977b3175382008-10-17 18:51:52 +00002671 goto failed;
2672 }
2673 pPager->journalOpen = 1;
2674 pPager->journalStarted = 0;
2675 pPager->journalOff = 0;
2676 pPager->setMaster = 0;
2677 pPager->journalHdr = 0;
2678
2679 /* Playback and delete the journal. Drop the database write
2680 ** lock and reacquire the read lock.
2681 */
2682 rc = pager_playback(pPager, 1);
2683 if( rc!=SQLITE_OK ){
2684 rc = pager_error(pPager, rc);
2685 goto failed;
2686 }
2687 assert(pPager->state==PAGER_SHARED ||
2688 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2689 );
2690 }
2691
2692 if( sqlite3PcachePagecount(pPager->pPCache)>0 ){
2693 /* The shared-lock has just been acquired on the database file
2694 ** and there are already pages in the cache (from a previous
2695 ** read or write transaction). Check to see if the database
2696 ** has been modified. If the database has changed, flush the
2697 ** cache.
2698 **
2699 ** Database changes is detected by looking at 15 bytes beginning
2700 ** at offset 24 into the file. The first 4 of these 16 bytes are
2701 ** a 32-bit counter that is incremented with each change. The
2702 ** other bytes change randomly with each file change when
2703 ** a codec is in use.
2704 **
2705 ** There is a vanishingly small chance that a change will not be
2706 ** detected. The chance of an undetected change is so small that
2707 ** it can be neglected.
2708 */
2709 char dbFileVers[sizeof(pPager->dbFileVers)];
2710 sqlite3PagerPagecount(pPager, 0);
2711
2712 if( pPager->errCode ){
2713 rc = pPager->errCode;
2714 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002715 }
2716
danielk1977d92db532008-11-17 04:56:24 +00002717 assert( pPager->dbSizeValid );
danielk1977b3175382008-10-17 18:51:52 +00002718 if( pPager->dbSize>0 ){
2719 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
2720 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
2721 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002722 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002723 }
danielk1977b3175382008-10-17 18:51:52 +00002724 }else{
2725 memset(dbFileVers, 0, sizeof(dbFileVers));
2726 }
danielk1977e277be02007-03-23 18:12:06 +00002727
danielk1977b3175382008-10-17 18:51:52 +00002728 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
2729 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002730 }
2731 }
danielk1977c5859712007-03-26 12:26:27 +00002732 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2733 if( pPager->state==PAGER_UNLOCK ){
2734 pPager->state = PAGER_SHARED;
2735 }
danielk1977e277be02007-03-23 18:12:06 +00002736 }
2737
danielk197752b472a2008-05-05 16:23:55 +00002738 failed:
2739 if( rc!=SQLITE_OK ){
2740 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
2741 pager_unlock(pPager);
2742 }
danielk1977e277be02007-03-23 18:12:06 +00002743 return rc;
2744}
2745
2746/*
drhd33d5a82007-04-26 12:11:28 +00002747** Make sure we have the content for a page. If the page was
2748** previously acquired with noContent==1, then the content was
2749** just initialized to zeros instead of being read from disk.
2750** But now we need the real data off of disk. So make sure we
2751** have it. Read it in if we do not have it already.
2752*/
2753static int pager_get_content(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002754 if( pPg->flags&PGHDR_NEED_READ ){
drhd33d5a82007-04-26 12:11:28 +00002755 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
2756 if( rc==SQLITE_OK ){
danielk19778c0a7912008-08-20 14:49:23 +00002757 pPg->flags &= ~PGHDR_NEED_READ;
drhd33d5a82007-04-26 12:11:28 +00002758 }else{
2759 return rc;
2760 }
2761 }
2762 return SQLITE_OK;
2763}
2764
2765/*
danielk19778c0a7912008-08-20 14:49:23 +00002766** If the reference count has reached zero, and the pager is not in the
2767** middle of a write transaction or opened in exclusive mode, unlock it.
2768*/
2769static void pagerUnlockIfUnused(Pager *pPager){
2770 if( (sqlite3PcacheRefCount(pPager->pPCache)==0)
2771 && (!pPager->exclusiveMode || pPager->journalOff>0)
2772 ){
2773 pagerUnlockAndRollback(pPager);
2774 }
2775}
2776
2777/*
2778** Drop a page from the cache using sqlite3PcacheDrop().
2779**
2780** If this means there are now no pages with references to them, a rollback
2781** occurs and the lock on the database is removed.
2782*/
2783static void pagerDropPage(DbPage *pPg){
2784 Pager *pPager = pPg->pPager;
2785 sqlite3PcacheDrop(pPg);
2786 pagerUnlockIfUnused(pPager);
2787}
2788
2789/*
drhd9b02572001-04-15 00:37:09 +00002790** Acquire a page.
2791**
drh58a11682001-11-10 13:51:08 +00002792** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002793** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002794**
drhd33d5a82007-04-26 12:11:28 +00002795** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00002796** file is smaller than the requested page, then no actual disk
2797** read occurs and the memory image of the page is initialized to
2798** all zeros. The extra data appended to a page is always initialized
2799** to zeros the first time a page is loaded into memory.
2800**
drhd9b02572001-04-15 00:37:09 +00002801** The acquisition might fail for several reasons. In all cases,
2802** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002803**
drhd33d5a82007-04-26 12:11:28 +00002804** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002805** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00002806** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00002807** just returns 0. This routine acquires a read-lock the first time it
2808** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00002809** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00002810** or journal files.
drh0787db62007-03-04 13:15:27 +00002811**
drh538f5702007-04-13 02:14:30 +00002812** If noContent is false, the page contents are actually read from disk.
2813** If noContent is true, it means that we do not care about the contents
2814** of the page at this time, so do not do a disk read. Just fill in the
2815** page content with zeros. But mark the fact that we have not read the
2816** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00002817** sqlite3PagerWrite() is called on this page or if this routine is
2818** called again with noContent==0, that means that the content is needed
2819** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002820*/
danielk197765e0ff32008-09-19 09:14:43 +00002821int sqlite3PagerAcquire(
drh538f5702007-04-13 02:14:30 +00002822 Pager *pPager, /* The pager open on the database file */
2823 Pgno pgno, /* Page number to fetch */
2824 DbPage **ppPage, /* Write a pointer to the page here */
2825 int noContent /* Do not bother reading content from disk if true */
2826){
danielk19778c0a7912008-08-20 14:49:23 +00002827 PgHdr *pPg = 0;
drh165ffe92005-03-15 17:09:30 +00002828 int rc;
drhed7c8552001-04-11 14:29:21 +00002829
danielk19778c0a7912008-08-20 14:49:23 +00002830 assert( pPager->state==PAGER_UNLOCK
2831 || sqlite3PcacheRefCount(pPager->pPCache)>0
danielk1977b3175382008-10-17 18:51:52 +00002832 || pgno==1
danielk19778c0a7912008-08-20 14:49:23 +00002833 );
danielk1977e277be02007-03-23 18:12:06 +00002834
danielk197726836652005-01-17 01:33:13 +00002835 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2836 ** number greater than this, or zero, is requested.
2837 */
drh267cb322005-09-16 17:16:52 +00002838 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002839 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002840 }
2841
drhd9b02572001-04-15 00:37:09 +00002842 /* Make sure we have not hit any critical errors.
2843 */
drh836faa42003-01-11 13:30:57 +00002844 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002845 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002846
danielk197713adf8a2004-06-03 16:08:41 +00002847 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002848 ** on the database file. pagerSharedLock() is a no-op if
2849 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002850 */
danielk1977e277be02007-03-23 18:12:06 +00002851 rc = pagerSharedLock(pPager);
2852 if( rc!=SQLITE_OK ){
2853 return rc;
drhed7c8552001-04-11 14:29:21 +00002854 }
danielk1977e277be02007-03-23 18:12:06 +00002855 assert( pPager->state!=PAGER_UNLOCK );
2856
danielk19778c0a7912008-08-20 14:49:23 +00002857 rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg);
2858 if( rc!=SQLITE_OK ){
2859 return rc;
2860 }
danielk19778c0a7912008-08-20 14:49:23 +00002861 if( pPg->pPager==0 ){
2862 /* The pager cache has created a new page. Its content needs to
2863 ** be initialized.
2864 */
danielk1977979f38e2007-03-27 16:19:51 +00002865 int nMax;
drh538f5702007-04-13 02:14:30 +00002866 PAGER_INCR(pPager->nMiss);
danielk19778c0a7912008-08-20 14:49:23 +00002867 pPg->pPager = pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002868 memset(pPg->pExtra, 0, pPager->nExtra);
danielk197724168722007-04-02 05:07:47 +00002869
danielk1977ad0132d2008-06-07 08:58:22 +00002870 rc = sqlite3PagerPagecount(pPager, &nMax);
2871 if( rc!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002872 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00002873 return rc;
2874 }
danielk197775bab7d2006-01-23 13:09:45 +00002875
danielk1977a1fa00d2008-08-27 15:16:33 +00002876 if( nMax<(int)pgno || MEMDB || noContent ){
drhf8e632b2007-05-08 14:51:36 +00002877 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00002878 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00002879 return SQLITE_FULL;
2880 }
danielk19778c0a7912008-08-20 14:49:23 +00002881 memset(pPg->pData, 0, pPager->pageSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00002882 if( noContent ){
danielk19778c0a7912008-08-20 14:49:23 +00002883 pPg->flags |= PGHDR_NEED_READ;
2884 }
drh538f5702007-04-13 02:14:30 +00002885 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00002886 }else{
danielk1977e180dd92007-04-05 17:15:52 +00002887 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00002888 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
danielk19778c0a7912008-08-20 14:49:23 +00002889 /* sqlite3PagerUnref(pPg); */
2890 pagerDropPage(pPg);
drh551b7732006-11-06 21:20:25 +00002891 return rc;
drh81a20f22001-10-12 17:30:04 +00002892 }
drh306dc212001-05-21 13:45:10 +00002893 }
danielk19773c407372005-02-15 02:54:14 +00002894#ifdef SQLITE_CHECK_PAGES
2895 pPg->pageHash = pager_pagehash(pPg);
2896#endif
drhed7c8552001-04-11 14:29:21 +00002897 }else{
drhd9b02572001-04-15 00:37:09 +00002898 /* The requested page is in the page cache. */
danielk19778c0a7912008-08-20 14:49:23 +00002899 assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00002900 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00002901 if( !noContent ){
2902 rc = pager_get_content(pPg);
2903 if( rc ){
danielk19778c0a7912008-08-20 14:49:23 +00002904 sqlite3PagerUnref(pPg);
drhd33d5a82007-04-26 12:11:28 +00002905 return rc;
2906 }
2907 }
drhed7c8552001-04-11 14:29:21 +00002908 }
danielk19778c0a7912008-08-20 14:49:23 +00002909
danielk19773b8a05f2007-03-19 17:44:26 +00002910 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00002911 return SQLITE_OK;
2912}
danielk19778c0a7912008-08-20 14:49:23 +00002913
drhed7c8552001-04-11 14:29:21 +00002914/*
drh7e3b0a02001-04-28 16:52:40 +00002915** Acquire a page if it is already in the in-memory cache. Do
2916** not read the page from disk. Return a pointer to the page,
2917** or 0 if the page is not in cache.
2918**
danielk19773b8a05f2007-03-19 17:44:26 +00002919** See also sqlite3PagerGet(). The difference between this routine
2920** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002921** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002922** returns NULL if the page is not in cache or if a disk I/O error
2923** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002924*/
danielk19773b8a05f2007-03-19 17:44:26 +00002925DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00002926 PgHdr *pPg = 0;
drh836faa42003-01-11 13:30:57 +00002927 assert( pPager!=0 );
2928 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00002929
danielk19778c0a7912008-08-20 14:49:23 +00002930 if( (pPager->state!=PAGER_UNLOCK)
2931 && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL)
2932 ){
2933 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg);
danielk1977e277be02007-03-23 18:12:06 +00002934 }
danielk19778c0a7912008-08-20 14:49:23 +00002935
danielk19773b8a05f2007-03-19 17:44:26 +00002936 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00002937}
2938
2939/*
drhed7c8552001-04-11 14:29:21 +00002940** Release a page.
2941**
2942** If the number of references to the page drop to zero, then the
2943** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002944** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002945** removed.
2946*/
danielk19773b8a05f2007-03-19 17:44:26 +00002947int sqlite3PagerUnref(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002948 if( pPg ){
2949 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002950 sqlite3PcacheRelease(pPg);
2951 pagerUnlockIfUnused(pPager);
drhed7c8552001-04-11 14:29:21 +00002952 }
drhd9b02572001-04-15 00:37:09 +00002953 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002954}
2955
2956/*
drha6abd042004-06-09 17:37:22 +00002957** Create a journal file for pPager. There should already be a RESERVED
2958** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002959**
2960** Return SQLITE_OK if everything. Return an error code and release the
2961** write lock if anything goes wrong.
2962*/
2963static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00002964 sqlite3_vfs *pVfs = pPager->pVfs;
2965 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
2966
drhda47d772002-12-02 04:25:19 +00002967 int rc;
drha6abd042004-06-09 17:37:22 +00002968 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002969 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00002970 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00002971 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00002972 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00002973 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002974 rc = SQLITE_NOMEM;
2975 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002976 }
danielk1977b4b47412007-08-17 15:53:36 +00002977
drhfdc40e92008-04-17 20:59:37 +00002978 if( pPager->journalOpen==0 ){
2979 if( pPager->tempFile ){
2980 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
2981 }else{
2982 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00002983 }
danielk1977b3175382008-10-17 18:51:52 +00002984 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
2985 sqlite3MemJournalOpen(pPager->jfd);
2986 rc = SQLITE_OK;
2987 }else{
drhfdc40e92008-04-17 20:59:37 +00002988#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977b3175382008-10-17 18:51:52 +00002989 rc = sqlite3JournalOpen(
2990 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
2991 );
drhfdc40e92008-04-17 20:59:37 +00002992#else
danielk1977b3175382008-10-17 18:51:52 +00002993 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
drhfdc40e92008-04-17 20:59:37 +00002994#endif
danielk1977b3175382008-10-17 18:51:52 +00002995 }
drhfdc40e92008-04-17 20:59:37 +00002996 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
2997 pPager->journalOff = 0;
2998 pPager->setMaster = 0;
2999 pPager->journalHdr = 0;
3000 if( rc!=SQLITE_OK ){
3001 if( rc==SQLITE_NOMEM ){
3002 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3003 }
3004 goto failed_to_open_journal;
3005 }
drhda47d772002-12-02 04:25:19 +00003006 }
3007 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003008 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003009 pPager->needSync = 0;
drh968af522003-02-11 14:55:40 +00003010 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003011 if( pPager->errCode ){
3012 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003013 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003014 }
drhda47d772002-12-02 04:25:19 +00003015 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003016
danielk197776572402004-06-25 02:38:54 +00003017 rc = writeJournalHdr(pPager);
3018
drhac69b052004-05-12 13:30:07 +00003019 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003020 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003021 }
danielk1977ae72d982007-10-03 08:46:44 +00003022 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003023 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003024 if( rc==SQLITE_OK ){
3025 rc = SQLITE_FULL;
3026 }
3027 }
drh9c105bb2004-10-02 20:38:28 +00003028 return rc;
3029
3030failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003031 sqlite3BitvecDestroy(pPager->pInJournal);
3032 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003033 return rc;
drhda47d772002-12-02 04:25:19 +00003034}
3035
3036/*
drh4b845d72002-03-05 12:41:19 +00003037** Acquire a write-lock on the database. The lock is removed when
3038** the any of the following happen:
3039**
drh80e35f42007-03-30 14:06:34 +00003040** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003041** * sqlite3PagerRollback() is called.
3042** * sqlite3PagerClose() is called.
3043** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003044**
danielk197713adf8a2004-06-03 16:08:41 +00003045** The first parameter to this routine is a pointer to any open page of the
3046** database file. Nothing changes about the page - it is used merely to
3047** acquire a pointer to the Pager structure and as proof that there is
3048** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003049**
danielk197713adf8a2004-06-03 16:08:41 +00003050** The second parameter indicates how much space in bytes to reserve for a
3051** master journal file-name at the start of the journal when it is created.
3052**
3053** A journal file is opened if this is not a temporary file. For temporary
3054** files, the opening of the journal file is deferred until there is an
3055** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003056**
drha6abd042004-06-09 17:37:22 +00003057** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003058**
3059** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3060** immediately instead of waiting until we try to flush the cache. The
3061** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003062*/
danielk19773b8a05f2007-03-19 17:44:26 +00003063int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003064 Pager *pPager = pPg->pPager;
3065 int rc = SQLITE_OK;
3066 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003067 assert( pPager->state!=PAGER_UNLOCK );
3068 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003069 assert( pPager->pInJournal==0 );
danielk1977b3175382008-10-17 18:51:52 +00003070 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00003071 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
3072 if( rc==SQLITE_OK ){
3073 pPager->state = PAGER_RESERVED;
3074 if( exFlag ){
3075 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh684917c2004-10-05 02:41:42 +00003076 }
danielk1977b3175382008-10-17 18:51:52 +00003077 }
3078 if( rc!=SQLITE_OK ){
3079 return rc;
3080 }
3081 pPager->dirtyCache = 0;
3082 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
3083 if( pPager->useJournal && !pPager->tempFile
3084 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
3085 rc = pager_open_journal(pPager);
drh4b845d72002-03-05 12:41:19 +00003086 }
danielk1977334cdb62007-03-26 08:05:12 +00003087 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00003088 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00003089 ** time a (read or write) transaction was successfully concluded
3090 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00003091 ** kept open and either was truncated to 0 bytes or its header was
3092 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00003093 */
3094 assert( pPager->nRec==0 );
3095 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003096 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003097 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003098 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhf5e7bb52008-02-18 14:47:33 +00003099 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003100 rc = SQLITE_NOMEM;
3101 }else{
drh369339d2007-03-30 16:01:55 +00003102 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003103 rc = writeJournalHdr(pPager);
3104 }
drh4b845d72002-03-05 12:41:19 +00003105 }
danielk1977334cdb62007-03-26 08:05:12 +00003106 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003107 return rc;
3108}
3109
3110/*
drhed7c8552001-04-11 14:29:21 +00003111** Mark a data page as writeable. The page is written into the journal
3112** if it is not there already. This routine must be called before making
3113** changes to a page.
3114**
3115** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003116** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003117** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003118** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003119** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003120**
3121** If the journal file could not be written because the disk is full,
3122** then this routine returns SQLITE_FULL and does an immediate rollback.
3123** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003124** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003125** reset.
drhed7c8552001-04-11 14:29:21 +00003126*/
danielk19773b8a05f2007-03-19 17:44:26 +00003127static int pager_write(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003128 void *pData = pPg->pData;
drh69688d52001-04-14 16:38:23 +00003129 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003130 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003131
drh6446c4d2001-12-15 14:22:18 +00003132 /* Check for errors
3133 */
danielk1977efaaf572006-01-16 11:29:19 +00003134 if( pPager->errCode ){
3135 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003136 }
drh5e00f6c2001-09-13 13:46:56 +00003137 if( pPager->readOnly ){
3138 return SQLITE_PERM;
3139 }
drh6446c4d2001-12-15 14:22:18 +00003140
danielk197776572402004-06-25 02:38:54 +00003141 assert( !pPager->setMaster );
3142
danielk19773c407372005-02-15 02:54:14 +00003143 CHECK_PAGE(pPg);
3144
drh538f5702007-04-13 02:14:30 +00003145 /* If this page was previously acquired with noContent==1, that means
3146 ** we didn't really read in the content of the page. This can happen
3147 ** (for example) when the page is being moved to the freelist. But
3148 ** now we are (perhaps) moving the page off of the freelist for
3149 ** reuse and we need to know its original content so that content
3150 ** can be stored in the rollback journal. So do the read at this
3151 ** time.
3152 */
drhd33d5a82007-04-26 12:11:28 +00003153 rc = pager_get_content(pPg);
3154 if( rc ){
3155 return rc;
drh538f5702007-04-13 02:14:30 +00003156 }
3157
drh6446c4d2001-12-15 14:22:18 +00003158 /* Mark the page as dirty. If the page has already been written
3159 ** to the journal then we can return right away.
3160 */
drhc047b9f2008-11-21 03:23:43 +00003161 sqlite3PcacheMakeDirty(pPg);
danielk1977bc2ca9e2008-11-13 14:28:28 +00003162 if( pageInJournal(pPg) && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00003163 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003164 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003165 }else{
drh6446c4d2001-12-15 14:22:18 +00003166
danielk1977a0bf2652004-11-04 14:30:04 +00003167 /* If we get this far, it means that the page needs to be
3168 ** written to the transaction journal or the ckeckpoint journal
3169 ** or both.
3170 **
3171 ** First check to see that the transaction journal exists and
3172 ** create it if it does not.
3173 */
3174 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003175 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003176 if( rc!=SQLITE_OK ){
3177 return rc;
3178 }
3179 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00003180 if( !pPager->journalOpen && pPager->useJournal
3181 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00003182 rc = pager_open_journal(pPager);
3183 if( rc!=SQLITE_OK ) return rc;
3184 }
danielk1977a0bf2652004-11-04 14:30:04 +00003185 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003186 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003187
3188 /* The transaction journal now exists and we have a RESERVED or an
3189 ** EXCLUSIVE lock on the main database file. Write the current page to
3190 ** the transaction journal if it is not there already.
3191 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00003192 if( !pageInJournal(pPg) && pPager->journalOpen ){
danielk1977d92db532008-11-17 04:56:24 +00003193 if( pPg->pgno<=pPager->origDbSize ){
danielk1977b3175382008-10-17 18:51:52 +00003194 u32 cksum;
3195 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00003196
danielk1977b3175382008-10-17 18:51:52 +00003197 /* We should never write to the journal file the page that
3198 ** contains the database locks. The following assert verifies
3199 ** that we do not. */
3200 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
3201 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
3202 cksum = pager_cksum(pPager, (u8*)pData2);
3203 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
3204 if( rc==SQLITE_OK ){
3205 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
3206 pPager->journalOff + 4);
3207 pPager->journalOff += pPager->pageSize+4;
3208 }
3209 if( rc==SQLITE_OK ){
3210 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
3211 pPager->journalOff += 4;
3212 }
3213 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
3214 pPager->journalOff, pPager->pageSize));
3215 PAGER_INCR(sqlite3_pager_writej_count);
3216 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
3217 PAGERID(pPager), pPg->pgno,
3218 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00003219
danielk1977b3175382008-10-17 18:51:52 +00003220 /* An error has occured writing to the journal file. The
3221 ** transaction will be rolled back by the layer above.
3222 */
3223 if( rc!=SQLITE_OK ){
3224 return rc;
3225 }
danielk197707cb5602006-01-20 10:55:05 +00003226
danielk1977b3175382008-10-17 18:51:52 +00003227 pPager->nRec++;
3228 assert( pPager->pInJournal!=0 );
3229 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
3230 if( !pPager->noSync ){
3231 pPg->flags |= PGHDR_NEED_SYNC;
3232 }
3233 if( pPager->stmtInUse ){
3234 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003235 }
danielk197713adf8a2004-06-03 16:08:41 +00003236 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003237 if( !pPager->journalStarted && !pPager->noSync ){
3238 pPg->flags |= PGHDR_NEED_SYNC;
3239 }
drh4f0c5872007-03-26 22:05:01 +00003240 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk19778c0a7912008-08-20 14:49:23 +00003241 PAGERID(pPager), pPg->pgno,
3242 ((pPg->flags&PGHDR_NEED_SYNC)?1:0));
danielk1977a0bf2652004-11-04 14:30:04 +00003243 }
danielk19778c0a7912008-08-20 14:49:23 +00003244 if( pPg->flags&PGHDR_NEED_SYNC ){
danielk1977a0bf2652004-11-04 14:30:04 +00003245 pPager->needSync = 1;
3246 }
danielk1977a0bf2652004-11-04 14:30:04 +00003247 }
3248
3249 /* If the statement journal is open and the page is not in it,
3250 ** then write the current page to the statement journal. Note that
3251 ** the statement journal format differs from the standard journal format
3252 ** in that it omits the checksums and the header.
3253 */
danielk1977f35843b2007-04-07 15:03:17 +00003254 if( pPager->stmtInUse
3255 && !pageInStatement(pPg)
danielk1977d92db532008-11-17 04:56:24 +00003256 && pPg->pgno<=pPager->stmtSize
danielk1977f35843b2007-04-07 15:03:17 +00003257 ){
danielk1977b3175382008-10-17 18:51:52 +00003258 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
3259 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
danielk1977d92db532008-11-17 04:56:24 +00003260 assert( pageInJournal(pPg) || pPg->pgno>pPager->origDbSize );
danielk1977b3175382008-10-17 18:51:52 +00003261 rc = write32bits(pPager->stfd, offset, pPg->pgno);
3262 if( rc==SQLITE_OK ){
3263 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
drhdb48ee02003-01-16 13:42:43 +00003264 }
danielk1977b3175382008-10-17 18:51:52 +00003265 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
3266 if( rc!=SQLITE_OK ){
3267 return rc;
3268 }
3269 pPager->stmtNRec++;
3270 assert( pPager->pInStmt!=0 );
3271 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhd9b02572001-04-15 00:37:09 +00003272 }
drhfa86c412002-02-02 15:01:15 +00003273 }
3274
3275 /* Update the database size and return.
3276 */
drh1aa2d8b2007-01-03 15:34:29 +00003277 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003278 if( pPager->dbSize<pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003279 pPager->dbSize = pPg->pgno;
danielk1977d92db532008-11-17 04:56:24 +00003280 if( pPager->dbSize==(PAGER_MJ_PGNO(pPager)-1) ){
drh1f595712004-06-15 01:40:29 +00003281 pPager->dbSize++;
3282 }
drh306dc212001-05-21 13:45:10 +00003283 }
drh69688d52001-04-14 16:38:23 +00003284 return rc;
drhed7c8552001-04-11 14:29:21 +00003285}
3286
3287/*
danielk19774099f6e2007-03-19 11:25:20 +00003288** This function is used to mark a data-page as writable. It uses
3289** pager_write() to open a journal file (if it is not already open)
3290** and write the page *pData to the journal.
3291**
3292** The difference between this function and pager_write() is that this
3293** function also deals with the special case where 2 or more pages
3294** fit on a single disk sector. In this case all co-resident pages
3295** must have been written to the journal file before returning.
3296*/
danielk19773b8a05f2007-03-19 17:44:26 +00003297int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003298 int rc = SQLITE_OK;
3299
danielk19773b8a05f2007-03-19 17:44:26 +00003300 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003301 Pager *pPager = pPg->pPager;
3302 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3303
danielk1977b3175382008-10-17 18:51:52 +00003304 if( nPagePerSector>1 ){
danielk19774099f6e2007-03-19 11:25:20 +00003305 Pgno nPageCount; /* Total number of pages in database file */
3306 Pgno pg1; /* First page of the sector pPg is located on. */
3307 int nPage; /* Number of pages starting at pg1 to journal */
3308 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003309 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003310
3311 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3312 ** header to be written between the pages journaled by this function.
3313 */
danielk1977b3175382008-10-17 18:51:52 +00003314 assert( !MEMDB );
danielk19774099f6e2007-03-19 11:25:20 +00003315 assert( pPager->doNotSync==0 );
3316 pPager->doNotSync = 1;
3317
3318 /* This trick assumes that both the page-size and sector-size are
3319 ** an integer power of 2. It sets variable pg1 to the identifier
3320 ** of the first page of the sector pPg is located on.
3321 */
3322 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3323
danielk1977ad0132d2008-06-07 08:58:22 +00003324 sqlite3PagerPagecount(pPager, (int *)&nPageCount);
danielk19774099f6e2007-03-19 11:25:20 +00003325 if( pPg->pgno>nPageCount ){
3326 nPage = (pPg->pgno - pg1)+1;
3327 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3328 nPage = nPageCount+1-pg1;
3329 }else{
3330 nPage = nPagePerSector;
3331 }
3332 assert(nPage>0);
3333 assert(pg1<=pPg->pgno);
3334 assert((pg1+nPage)>pPg->pgno);
3335
3336 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3337 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003338 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00003339 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00003340 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003341 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003342 if( rc==SQLITE_OK ){
3343 rc = pager_write(pPage);
danielk19778c0a7912008-08-20 14:49:23 +00003344 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003345 needSync = 1;
3346 }
danielk19773b8a05f2007-03-19 17:44:26 +00003347 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003348 }
3349 }
drhc81945e2008-03-10 14:12:53 +00003350 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk19778c0a7912008-08-20 14:49:23 +00003351 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003352 needSync = 1;
3353 }
danielk19778c0a7912008-08-20 14:49:23 +00003354 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003355 }
3356 }
3357
danielk1977dd97a492007-08-22 18:54:32 +00003358 /* If the PgHdr.needSync flag is set for any of the nPage pages
3359 ** starting at pg1, then it needs to be set for all of them. Because
3360 ** writing to any of these nPage pages may damage the others, the
3361 ** journal file must contain sync()ed copies of all of them
3362 ** before any of them can be written out to the database file.
3363 */
3364 if( needSync ){
drhb3df2e12008-09-17 20:06:26 +00003365 assert( !MEMDB && pPager->noSync==0 );
danielk1977dd97a492007-08-22 18:54:32 +00003366 for(ii=0; ii<nPage && needSync; ii++){
3367 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
danielk19778c0a7912008-08-20 14:49:23 +00003368 if( pPage ) pPage->flags |= PGHDR_NEED_SYNC;
3369 sqlite3PagerUnref(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003370 }
3371 assert(pPager->needSync);
3372 }
3373
danielk19774099f6e2007-03-19 11:25:20 +00003374 assert( pPager->doNotSync==1 );
3375 pPager->doNotSync = 0;
3376 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003377 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003378 }
3379 return rc;
3380}
3381
3382/*
drhaacc5432002-01-06 17:07:40 +00003383** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003384** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003385** to change the content of the page.
3386*/
danielk19777d3a6662006-01-23 16:21:05 +00003387#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003388int sqlite3PagerIswriteable(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003389 return pPg->flags&PGHDR_DIRTY;
drh6019e162001-07-02 17:51:45 +00003390}
danielk19777d3a6662006-01-23 16:21:05 +00003391#endif
drh6019e162001-07-02 17:51:45 +00003392
drh001bbcb2003-03-19 03:14:00 +00003393/*
drh30e58752002-03-02 20:41:57 +00003394** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003395** write the information on page pPg back to the disk, even though
drhdfe88ec2008-11-03 20:55:06 +00003396** that page might be marked as dirty. This happens, for example, when
3397** the page has been added as a leaf of the freelist and so its
3398** content no longer matters.
drh30e58752002-03-02 20:41:57 +00003399**
3400** The overlying software layer calls this routine when all of the data
3401** on the given page is unused. The pager marks the page as clean so
3402** that it does not get written to disk.
3403**
3404** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003405** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003406** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003407**
3408** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003409** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003410** will thereafter be ignored. This is necessary to avoid a problem
3411** where a page with data is added to the freelist during one part of
3412** a transaction then removed from the freelist during a later part
3413** of the same transaction and reused for some other purpose. When it
3414** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003415** the sqlite3PagerDontRollback() routine is called. But because the
3416** page contains critical data, we still need to be sure it gets
3417** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003418*/
danielk1977a1fa00d2008-08-27 15:16:33 +00003419int sqlite3PagerDontWrite(DbPage *pDbPage){
drh538f5702007-04-13 02:14:30 +00003420 PgHdr *pPg = pDbPage;
3421 Pager *pPager = pPg->pPager;
danielk1977a1fa00d2008-08-27 15:16:33 +00003422 int rc;
drh8e298f92002-07-06 16:28:47 +00003423
danielk1977b3175382008-10-17 18:51:52 +00003424 if( pPg->pgno>pPager->origDbSize ){
danielk1977a1fa00d2008-08-27 15:16:33 +00003425 return SQLITE_OK;
3426 }
3427 if( pPager->pAlwaysRollback==0 ){
3428 assert( pPager->pInJournal );
3429 pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->origDbSize);
3430 if( !pPager->pAlwaysRollback ){
3431 return SQLITE_NOMEM;
3432 }
3433 }
3434 rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno);
3435
3436 if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00003437 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003438 if( pPager->dbSize==pPg->pgno && pPager->origDbSize<pPager->dbSize ){
drh8124a302002-06-25 14:43:57 +00003439 /* If this pages is the last page in the file and the file has grown
3440 ** during the current transaction, then do NOT mark the page as clean.
3441 ** When the database file grows, we must make sure that the last page
3442 ** gets written at least once so that the disk file will be the correct
3443 ** size. If you do not write this page and the size of the file
3444 ** on the disk ends up being too small, that can lead to database
3445 ** corruption during the next transaction.
3446 */
3447 }else{
drh538f5702007-04-13 02:14:30 +00003448 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3449 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
danielk197733e32162008-08-23 18:53:08 +00003450 pPg->flags |= PGHDR_DONT_WRITE;
danielk19773c407372005-02-15 02:54:14 +00003451#ifdef SQLITE_CHECK_PAGES
3452 pPg->pageHash = pager_pagehash(pPg);
3453#endif
drh8124a302002-06-25 14:43:57 +00003454 }
drh30e58752002-03-02 20:41:57 +00003455 }
danielk1977a1fa00d2008-08-27 15:16:33 +00003456 return rc;
drh30e58752002-03-02 20:41:57 +00003457}
3458
3459/*
3460** A call to this routine tells the pager that if a rollback occurs,
3461** it is not necessary to restore the data on the given page. This
3462** means that the pager does not have to record the given page in the
3463** rollback journal.
drh538f5702007-04-13 02:14:30 +00003464**
3465** If we have not yet actually read the content of this page (if
3466** the PgHdr.needRead flag is set) then this routine acts as a promise
3467** that we will never need to read the page content in the future.
3468** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003469*/
danielk19773b8a05f2007-03-19 17:44:26 +00003470void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003471 Pager *pPager = pPg->pPager;
3472
drhd3627af2006-12-18 18:34:51 +00003473 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00003474
3475 /* If the journal file is not open, or DontWrite() has been called on
3476 ** this page (DontWrite() sets the alwaysRollback flag), then this
3477 ** function is a no-op.
3478 */
danielk1977a1fa00d2008-08-27 15:16:33 +00003479 if( pPager->journalOpen==0
3480 || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno)
3481 || pPg->pgno>pPager->origDbSize
danielk19778c0a7912008-08-20 14:49:23 +00003482 ){
danielk197787c29a92008-01-18 11:33:16 +00003483 return;
3484 }
danielk1977a55e9352008-01-21 13:04:34 +00003485
drhc5d0bd92008-04-14 01:00:57 +00003486#ifdef SQLITE_SECURE_DELETE
drh1feb7dd2008-11-19 18:30:29 +00003487 if( sqlite3BitvecTest(pPager->pInJournal, pPg->pgno)!=0
3488 || pPg->pgno>pPager->origDbSize ){
drhc5d0bd92008-04-14 01:00:57 +00003489 return;
3490 }
3491#endif
3492
3493 /* If SECURE_DELETE is disabled, then there is no way that this
3494 ** routine can be called on a page for which sqlite3PagerDontWrite()
3495 ** has not been previously called during the same transaction.
3496 ** And if DontWrite() has previously been called, the following
3497 ** conditions must be met.
drh10131482008-07-11 03:34:09 +00003498 **
3499 ** (Later:) Not true. If the database is corrupted by having duplicate
3500 ** pages on the freelist (ex: corrupt9.test) then the following is not
3501 ** necessarily true:
danielk1977a55e9352008-01-21 13:04:34 +00003502 */
drh10131482008-07-11 03:34:09 +00003503 /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ); */
danielk1977a55e9352008-01-21 13:04:34 +00003504
drhf5e7bb52008-02-18 14:47:33 +00003505 assert( pPager->pInJournal!=0 );
3506 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003507 pPg->flags &= ~PGHDR_NEED_READ;
danielk1977a55e9352008-01-21 13:04:34 +00003508 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00003509 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00003510 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00003511 }
danielk1977a55e9352008-01-21 13:04:34 +00003512 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
3513 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003514}
3515
drhac69b052004-05-12 13:30:07 +00003516
drh30e58752002-03-02 20:41:57 +00003517/*
drh80e35f42007-03-30 14:06:34 +00003518** This routine is called to increment the database file change-counter,
3519** stored at byte 24 of the pager file.
3520*/
danielk1977c7b60172007-08-22 11:22:03 +00003521static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00003522 PgHdr *pPgHdr;
3523 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00003524 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00003525
drh701bb3b2008-08-02 03:50:39 +00003526#ifndef SQLITE_ENABLE_ATOMIC_WRITE
3527 assert( isDirect==0 ); /* isDirect is only true for atomic writes */
3528#endif
drh80e35f42007-03-30 14:06:34 +00003529 if( !pPager->changeCountDone ){
3530 /* Open page 1 of the file for writing. */
3531 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3532 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00003533
3534 if( !isDirect ){
3535 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00003536 if( rc!=SQLITE_OK ){
3537 sqlite3PagerUnref(pPgHdr);
3538 return rc;
3539 }
danielk1977c7b60172007-08-22 11:22:03 +00003540 }
3541
drh80e35f42007-03-30 14:06:34 +00003542 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003543 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003544 change_counter++;
danielk19778c0a7912008-08-20 14:49:23 +00003545 put32bits(((char*)pPgHdr->pData)+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00003546
drh701bb3b2008-08-02 03:50:39 +00003547#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977c7b60172007-08-22 11:22:03 +00003548 if( isDirect && pPager->fd->pMethods ){
danielk19778c0a7912008-08-20 14:49:23 +00003549 const void *zBuf = pPgHdr->pData;
danielk1977c7b60172007-08-22 11:22:03 +00003550 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
3551 }
drh701bb3b2008-08-02 03:50:39 +00003552#endif
danielk1977c7b60172007-08-22 11:22:03 +00003553
drh80e35f42007-03-30 14:06:34 +00003554 /* Release the page reference. */
3555 sqlite3PagerUnref(pPgHdr);
3556 pPager->changeCountDone = 1;
3557 }
danielk1977c7b60172007-08-22 11:22:03 +00003558 return rc;
drh80e35f42007-03-30 14:06:34 +00003559}
3560
3561/*
danielk1977f653d782008-03-20 11:04:21 +00003562** Sync the pager file to disk.
3563*/
3564int sqlite3PagerSync(Pager *pPager){
3565 int rc;
drh7426f862008-08-26 21:07:26 +00003566 if( MEMDB ){
3567 rc = SQLITE_OK;
3568 }else{
3569 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
3570 }
danielk1977f653d782008-03-20 11:04:21 +00003571 return rc;
3572}
3573
3574/*
drh80e35f42007-03-30 14:06:34 +00003575** Sync the database file for the pager pPager. zMaster points to the name
3576** of a master journal file that should be written into the individual
3577** journal file. zMaster may be NULL, which is interpreted as no master
3578** journal (a single database transaction).
3579**
3580** This routine ensures that the journal is synced, all dirty pages written
3581** to the database file and the database file synced. The only thing that
3582** remains to commit the transaction is to delete the journal file (or
3583** master journal file if specified).
3584**
3585** Note that if zMaster==NULL, this does not overwrite a previous value
3586** passed to an sqlite3PagerCommitPhaseOne() call.
3587**
3588** If parameter nTrunc is non-zero, then the pager file is truncated to
3589** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00003590**
3591** If the final parameter - noSync - is true, then the database file itself
3592** is not synced. The caller must call sqlite3PagerSync() directly to
3593** sync the database file before calling CommitPhaseTwo() to delete the
3594** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00003595*/
danielk1977f653d782008-03-20 11:04:21 +00003596int sqlite3PagerCommitPhaseOne(
3597 Pager *pPager,
3598 const char *zMaster,
3599 Pgno nTrunc,
3600 int noSync
3601){
drh80e35f42007-03-30 14:06:34 +00003602 int rc = SQLITE_OK;
3603
danielk1977dad31b52008-05-15 11:08:07 +00003604 if( pPager->errCode ){
3605 return pPager->errCode;
3606 }
3607
drhd138c012008-05-13 00:58:18 +00003608 /* If no changes have been made, we can leave the transaction early.
3609 */
3610 if( pPager->dbModified==0 &&
3611 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3612 pPager->exclusiveMode!=0) ){
3613 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3614 return SQLITE_OK;
3615 }
3616
drh80e35f42007-03-30 14:06:34 +00003617 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3618 pPager->zFilename, zMaster, nTrunc);
3619
3620 /* If this is an in-memory db, or no pages have been written to, or this
3621 ** function has already been called, it is a no-op.
3622 */
3623 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3624 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00003625
danielk1977c7b60172007-08-22 11:22:03 +00003626#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3627 /* The atomic-write optimization can be used if all of the
3628 ** following are true:
3629 **
3630 ** + The file-system supports the atomic-write property for
3631 ** blocks of size page-size, and
3632 ** + This commit is not part of a multi-file transaction, and
3633 ** + Exactly one page has been modified and store in the journal file.
3634 **
3635 ** If the optimization can be used, then the journal file will never
3636 ** be created for this transaction.
3637 */
danielk19774d60af92008-09-08 15:35:06 +00003638 int useAtomicWrite;
danielk19778c0a7912008-08-20 14:49:23 +00003639 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
danielk19774d60af92008-09-08 15:35:06 +00003640 useAtomicWrite = (
danielk1977f55b8992007-08-24 08:15:53 +00003641 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00003642 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00003643 pPager->journalOff==jrnlBufferSize(pPager) &&
3644 nTrunc==0 &&
danielk19778c0a7912008-08-20 14:49:23 +00003645 (pPg==0 || pPg->pDirty==0)
danielk1977f55b8992007-08-24 08:15:53 +00003646 );
danielk1977700b9c52008-04-24 12:37:40 +00003647 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00003648 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00003649 /* Update the nRec field in the journal file. */
3650 int offset = pPager->journalHdr + sizeof(aJournalMagic);
3651 assert(pPager->nRec==1);
3652 rc = write32bits(pPager->jfd, offset, pPager->nRec);
3653
3654 /* Update the db file change counter. The following call will modify
3655 ** the in-memory representation of page 1 to include the updated
3656 ** change counter and then write page 1 directly to the database
3657 ** file. Because of the atomic-write property of the host file-system,
3658 ** this is safe.
3659 */
danielk1977ae72d982007-10-03 08:46:44 +00003660 if( rc==SQLITE_OK ){
3661 rc = pager_incr_changecounter(pPager, 1);
3662 }
danielk1977f55b8992007-08-24 08:15:53 +00003663 }else{
3664 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00003665 }
3666
danielk1977ae72d982007-10-03 08:46:44 +00003667 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00003668#endif
3669
drh80e35f42007-03-30 14:06:34 +00003670 /* If a master journal file name has already been written to the
3671 ** journal file, then no sync is required. This happens when it is
3672 ** written, then the process fails to upgrade from a RESERVED to an
3673 ** EXCLUSIVE lock. The next time the process tries to commit the
3674 ** transaction the m-j name will have already been written.
3675 */
3676 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00003677 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003678 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00003679 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00003680#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00003681 if( nTrunc!=0 ){
3682 /* If this transaction has made the database smaller, then all pages
3683 ** being discarded by the truncation must be written to the journal
3684 ** file.
3685 */
3686 Pgno i;
danielk1977d92db532008-11-17 04:56:24 +00003687 Pgno iSkip = PAGER_MJ_PGNO(pPager);
danielk197771aa7ff2008-05-20 07:05:09 +00003688 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3689 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
3690 rc = sqlite3PagerGet(pPager, i, &pPg);
3691 if( rc!=SQLITE_OK ) goto sync_exit;
3692 rc = sqlite3PagerWrite(pPg);
3693 sqlite3PagerUnref(pPg);
3694 if( rc!=SQLITE_OK ) goto sync_exit;
3695 }
3696 }
3697 }
drh80e35f42007-03-30 14:06:34 +00003698#endif
danielk197771aa7ff2008-05-20 07:05:09 +00003699 rc = writeMasterJournal(pPager, zMaster);
3700 if( rc!=SQLITE_OK ) goto sync_exit;
3701 rc = syncJournal(pPager);
3702 }
drh80e35f42007-03-30 14:06:34 +00003703 }
danielk1977c7b60172007-08-22 11:22:03 +00003704 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00003705
3706#ifndef SQLITE_OMIT_AUTOVACUUM
3707 if( nTrunc!=0 ){
3708 rc = sqlite3PagerTruncate(pPager, nTrunc);
3709 if( rc!=SQLITE_OK ) goto sync_exit;
3710 }
3711#endif
3712
3713 /* Write all dirty pages to the database file */
danielk19778c0a7912008-08-20 14:49:23 +00003714 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003715 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00003716 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00003717 assert( rc!=SQLITE_IOERR_BLOCKED );
3718 /* The error might have left the dirty list all fouled up here,
3719 ** but that does not matter because if the if the dirty list did
3720 ** get corrupted, then the transaction will roll back and
3721 ** discard the dirty list. There is an assert in
3722 ** pager_get_all_dirty_pages() that verifies that no attempt
3723 ** is made to use an invalid dirty list.
3724 */
drh153c62c2007-08-24 03:51:33 +00003725 goto sync_exit;
3726 }
danielk19778c0a7912008-08-20 14:49:23 +00003727 sqlite3PcacheCleanAll(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003728
3729 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00003730 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00003731 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00003732 }
3733 IOTRACE(("DBSYNC %p\n", pPager))
3734
3735 pPager->state = PAGER_SYNCED;
3736 }else if( MEMDB && nTrunc!=0 ){
3737 rc = sqlite3PagerTruncate(pPager, nTrunc);
3738 }
3739
3740sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00003741 if( rc==SQLITE_IOERR_BLOCKED ){
3742 /* pager_incr_changecounter() may attempt to obtain an exclusive
3743 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00003744 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00003745 * better to return SQLITE_BUSY.
3746 */
3747 rc = SQLITE_BUSY;
3748 }
drh80e35f42007-03-30 14:06:34 +00003749 return rc;
3750}
3751
3752
3753/*
drhed7c8552001-04-11 14:29:21 +00003754** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003755**
3756** If the commit fails for any reason, a rollback attempt is made
3757** and an error code is returned. If the commit worked, SQLITE_OK
3758** is returned.
drhed7c8552001-04-11 14:29:21 +00003759*/
drh80e35f42007-03-30 14:06:34 +00003760int sqlite3PagerCommitPhaseTwo(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003761 int rc = SQLITE_OK;
drhd9b02572001-04-15 00:37:09 +00003762
danielk1977efaaf572006-01-16 11:29:19 +00003763 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003764 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003765 }
drha6abd042004-06-09 17:37:22 +00003766 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003767 return SQLITE_ERROR;
3768 }
drhd138c012008-05-13 00:58:18 +00003769 if( pPager->dbModified==0 &&
3770 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3771 pPager->exclusiveMode!=0) ){
3772 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3773 return SQLITE_OK;
3774 }
drh4f0c5872007-03-26 22:05:01 +00003775 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003776 assert( pPager->state==PAGER_SYNCED || MEMDB || !pPager->dirtyCache );
3777 rc = pager_end_transaction(pPager, pPager->setMaster);
3778 rc = pager_error(pPager, rc);
drh86f8c192007-08-22 00:39:19 +00003779 return rc;
drhed7c8552001-04-11 14:29:21 +00003780}
3781
3782/*
drha6abd042004-06-09 17:37:22 +00003783** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003784** All in-memory cache pages revert to their original data contents.
3785** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003786**
3787** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003788** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003789** process is writing trash into the journal file (SQLITE_CORRUPT) or
3790** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3791** codes are returned for all these occasions. Otherwise,
3792** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003793*/
danielk19773b8a05f2007-03-19 17:44:26 +00003794int sqlite3PagerRollback(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003795 int rc = SQLITE_OK;
drh4f0c5872007-03-26 22:05:01 +00003796 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003797 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00003798 rc = pager_end_transaction(pPager, pPager->setMaster);
danielk19778c0a7912008-08-20 14:49:23 +00003799 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003800 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003801 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003802 }
danielk19778c0a7912008-08-20 14:49:23 +00003803 rc = pPager->errCode;
drha6abd042004-06-09 17:37:22 +00003804 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003805 if( pPager->state==PAGER_RESERVED ){
3806 int rc2;
3807 rc = pager_playback(pPager, 0);
3808 rc2 = pager_end_transaction(pPager, pPager->setMaster);
3809 if( rc==SQLITE_OK ){
3810 rc = rc2;
3811 }
3812 }else{
3813 rc = pager_playback(pPager, 0);
3814 }
danielk197707cb5602006-01-20 10:55:05 +00003815
danielk1977b3175382008-10-17 18:51:52 +00003816 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00003817 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00003818 }
danielk19778c0a7912008-08-20 14:49:23 +00003819
3820 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3821 ** cache. So call pager_error() on the way out to make any error
3822 ** persistent.
3823 */
3824 rc = pager_error(pPager, rc);
3825 }
drh86f8c192007-08-22 00:39:19 +00003826 return rc;
drh98808ba2001-10-18 12:34:46 +00003827}
drhd9b02572001-04-15 00:37:09 +00003828
3829/*
drh5e00f6c2001-09-13 13:46:56 +00003830** Return TRUE if the database file is opened read-only. Return FALSE
3831** if the database is (in theory) writable.
3832*/
danielk19773b8a05f2007-03-19 17:44:26 +00003833int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003834 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003835}
3836
3837/*
drh0f7eb612006-08-08 13:51:43 +00003838** Return the number of references to the pager.
3839*/
danielk19773b8a05f2007-03-19 17:44:26 +00003840int sqlite3PagerRefcount(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003841 return sqlite3PcacheRefCount(pPager->pPCache);
drh0f7eb612006-08-08 13:51:43 +00003842}
3843
danielk197771d5d2c2008-09-29 11:49:47 +00003844/*
3845** Return the number of references to the specified page.
3846*/
3847int sqlite3PagerPageRefcount(DbPage *pPage){
3848 return sqlite3PcachePageRefcount(pPage);
3849}
3850
drh0f7eb612006-08-08 13:51:43 +00003851#ifdef SQLITE_TEST
3852/*
drhd9b02572001-04-15 00:37:09 +00003853** This routine is used for testing and analysis only.
3854*/
danielk19773b8a05f2007-03-19 17:44:26 +00003855int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003856 static int a[11];
danielk19778c0a7912008-08-20 14:49:23 +00003857 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
3858 a[1] = sqlite3PcachePagecount(pPager->pPCache);
3859 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
danielk1977d92db532008-11-17 04:56:24 +00003860 a[3] = pPager->dbSizeValid ? (int) pPager->dbSize : -1;
drhd9b02572001-04-15 00:37:09 +00003861 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003862 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003863 a[6] = pPager->nHit;
3864 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003865 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003866 a[9] = pPager->nRead;
3867 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003868 return a;
3869}
danielk197717b90b52008-06-06 11:11:25 +00003870int sqlite3PagerIsMemdb(Pager *pPager){
3871 return MEMDB;
3872}
drh0f7eb612006-08-08 13:51:43 +00003873#endif
drhdd793422001-06-28 01:54:48 +00003874
drhfa86c412002-02-02 15:01:15 +00003875/*
drhac69b052004-05-12 13:30:07 +00003876** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003877**
3878** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003879** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003880** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003881*/
drh86f8c192007-08-22 00:39:19 +00003882static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003883 int rc;
drhac69b052004-05-12 13:30:07 +00003884 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00003885 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003886 assert( pPager->dbSizeValid );
drh4f0c5872007-03-26 22:05:01 +00003887 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhda47d772002-12-02 04:25:19 +00003888 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003889 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003890 return SQLITE_OK;
3891 }
drhfa86c412002-02-02 15:01:15 +00003892 assert( pPager->journalOpen );
drhf5e7bb52008-02-18 14:47:33 +00003893 assert( pPager->pInStmt==0 );
3894 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00003895 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00003896 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00003897 return SQLITE_NOMEM;
3898 }
danielk197776572402004-06-25 02:38:54 +00003899 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003900 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003901 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003902 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003903 if( !pPager->stmtOpen ){
danielk1977b3175382008-10-17 18:51:52 +00003904 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
3905 sqlite3MemJournalOpen(pPager->stfd);
3906 }else{
3907 rc = sqlite3PagerOpentemp(pPager, pPager->stfd, SQLITE_OPEN_SUBJOURNAL);
3908 if( rc ){
3909 goto stmt_begin_failed;
3910 }
drh334b2992007-09-06 23:28:23 +00003911 }
drhac69b052004-05-12 13:30:07 +00003912 pPager->stmtOpen = 1;
3913 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003914 }
drhac69b052004-05-12 13:30:07 +00003915 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003916 return SQLITE_OK;
3917
drhac69b052004-05-12 13:30:07 +00003918stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00003919 if( pPager->pInStmt ){
3920 sqlite3BitvecDestroy(pPager->pInStmt);
3921 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003922 }
3923 return rc;
3924}
drh86f8c192007-08-22 00:39:19 +00003925int sqlite3PagerStmtBegin(Pager *pPager){
3926 int rc;
drh86f8c192007-08-22 00:39:19 +00003927 rc = pagerStmtBegin(pPager);
drh86f8c192007-08-22 00:39:19 +00003928 return rc;
3929}
drhfa86c412002-02-02 15:01:15 +00003930
3931/*
drhac69b052004-05-12 13:30:07 +00003932** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003933*/
danielk19773b8a05f2007-03-19 17:44:26 +00003934int sqlite3PagerStmtCommit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003935 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003936 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003937 sqlite3BitvecDestroy(pPager->pInStmt);
3938 pPager->pInStmt = 0;
drhac69b052004-05-12 13:30:07 +00003939 pPager->stmtNRec = 0;
3940 pPager->stmtInUse = 0;
danielk1977b3175382008-10-17 18:51:52 +00003941 if( sqlite3IsMemJournal(pPager->stfd) ){
3942 sqlite3OsTruncate(pPager->stfd, 0);
3943 }
drh663fc632002-02-02 18:49:19 +00003944 }
drhac69b052004-05-12 13:30:07 +00003945 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003946 return SQLITE_OK;
3947}
3948
3949/*
drhac69b052004-05-12 13:30:07 +00003950** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003951*/
danielk19773b8a05f2007-03-19 17:44:26 +00003952int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003953 int rc;
drhac69b052004-05-12 13:30:07 +00003954 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003955 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003956 rc = pager_stmt_playback(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003957 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00003958 }else{
3959 rc = SQLITE_OK;
3960 }
drhac69b052004-05-12 13:30:07 +00003961 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003962 return rc;
3963}
3964
drh73509ee2003-04-06 20:44:45 +00003965/*
3966** Return the full pathname of the database file.
3967*/
danielk19773b8a05f2007-03-19 17:44:26 +00003968const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003969 return pPager->zFilename;
3970}
3971
drhb20ea9d2004-02-09 01:20:36 +00003972/*
drhd0679ed2007-08-28 22:24:34 +00003973** Return the VFS structure for the pager.
3974*/
3975const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
3976 return pPager->pVfs;
3977}
3978
3979/*
drhcc6bb3e2007-08-31 16:11:35 +00003980** Return the file handle for the database file associated
3981** with the pager. This might return NULL if the file has
3982** not yet been opened.
3983*/
3984sqlite3_file *sqlite3PagerFile(Pager *pPager){
3985 return pPager->fd;
3986}
3987
3988/*
danielk19775865e3d2004-06-14 06:03:57 +00003989** Return the directory of the database file.
3990*/
danielk19773b8a05f2007-03-19 17:44:26 +00003991const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00003992 return pPager->zDirectory;
3993}
3994
3995/*
3996** Return the full pathname of the journal file.
3997*/
danielk19773b8a05f2007-03-19 17:44:26 +00003998const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00003999 return pPager->zJournal;
4000}
4001
4002/*
drh2c8997b2005-08-27 16:36:48 +00004003** Return true if fsync() calls are disabled for this pager. Return FALSE
4004** if fsync()s are executed normally.
4005*/
danielk19773b8a05f2007-03-19 17:44:26 +00004006int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004007 return pPager->noSync;
4008}
4009
drh7c4ac0c2007-04-05 11:25:58 +00004010#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004011/*
drhb20ea9d2004-02-09 01:20:36 +00004012** Set the codec for this pager
4013*/
danielk19773b8a05f2007-03-19 17:44:26 +00004014void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004015 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004016 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004017 void *pCodecArg
4018){
4019 pPager->xCodec = xCodec;
4020 pPager->pCodecArg = pCodecArg;
4021}
drh7c4ac0c2007-04-05 11:25:58 +00004022#endif
drhb20ea9d2004-02-09 01:20:36 +00004023
danielk1977687566d2004-11-02 12:56:41 +00004024#ifndef SQLITE_OMIT_AUTOVACUUM
4025/*
danielk197787c29a92008-01-18 11:33:16 +00004026** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004027**
drh5e385312007-06-16 04:42:12 +00004028** There must be no references to the page previously located at
4029** pgno (which we call pPgOld) though that page is allowed to be
drhb3df2e12008-09-17 20:06:26 +00004030** in cache. If the page previously located at pgno is not already
drh5e385312007-06-16 04:42:12 +00004031** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004032**
drh5e385312007-06-16 04:42:12 +00004033** References to the page pPg remain valid. Updating any
4034** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004035** allocated along with the page) is the responsibility of the caller.
4036**
danielk19775fd057a2005-03-09 13:09:43 +00004037** A transaction must be active when this routine is called. It used to be
4038** required that a statement transaction was not active, but this restriction
4039** has been removed (CREATE INDEX needs to move a page when a statement
4040** transaction is active).
danielk19774c999992008-07-16 18:17:55 +00004041**
4042** If the fourth argument, isCommit, is non-zero, then this page is being
4043** moved as part of a database reorganization just before the transaction
4044** is being committed. In this case, it is guaranteed that the database page
4045** pPg refers to will not be written to again within this transaction.
danielk1977687566d2004-11-02 12:56:41 +00004046*/
danielk19774c999992008-07-16 18:17:55 +00004047int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
drh5e385312007-06-16 04:42:12 +00004048 PgHdr *pPgOld; /* The page being overwritten. */
danielk197794daf7f2004-11-08 09:26:09 +00004049 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004050
danielk1977687566d2004-11-02 12:56:41 +00004051 assert( pPg->nRef>0 );
4052
drh4f0c5872007-03-26 22:05:01 +00004053 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk19778c0a7912008-08-20 14:49:23 +00004054 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno);
drhb0603412007-02-28 04:47:26 +00004055 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004056
danielk1977b4626a32007-04-28 15:47:43 +00004057 pager_get_content(pPg);
danielk19774c999992008-07-16 18:17:55 +00004058
4059 /* If the journal needs to be sync()ed before page pPg->pgno can
4060 ** be written to, store pPg->pgno in local variable needSyncPgno.
4061 **
4062 ** If the isCommit flag is set, there is no need to remember that
4063 ** the journal needs to be sync()ed before database page pPg->pgno
4064 ** can be written to. The caller has already promised not to write to it.
4065 */
danielk19778c0a7912008-08-20 14:49:23 +00004066 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
danielk197794daf7f2004-11-08 09:26:09 +00004067 needSyncPgno = pPg->pgno;
danielk1977d92db532008-11-17 04:56:24 +00004068 assert( pageInJournal(pPg) || pgno>pPager->origDbSize );
danielk19778c0a7912008-08-20 14:49:23 +00004069 assert( pPg->flags&PGHDR_DIRTY );
danielk1977ae825582004-11-23 09:06:55 +00004070 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004071 }
4072
danielk1977ef73ee92004-11-06 12:26:07 +00004073 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00004074 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00004075 ** page pgno before the 'move' operation, it needs to be retained
4076 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004077 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00004078 pPg->flags &= ~PGHDR_NEED_SYNC;
danielk1977687566d2004-11-02 12:56:41 +00004079 pPgOld = pager_lookup(pPager, pgno);
danielk19778c0a7912008-08-20 14:49:23 +00004080 assert( !pPgOld || pPgOld->nRef==1 );
danielk1977687566d2004-11-02 12:56:41 +00004081 if( pPgOld ){
danielk19778c0a7912008-08-20 14:49:23 +00004082 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
drh5e385312007-06-16 04:42:12 +00004083 }
danielk1977687566d2004-11-02 12:56:41 +00004084
danielk19778c0a7912008-08-20 14:49:23 +00004085 sqlite3PcacheMove(pPg, pgno);
4086 if( pPgOld ){
danielk1977bc2ca9e2008-11-13 14:28:28 +00004087 sqlite3PcacheDrop(pPgOld);
danielk1977f5fdda82004-11-03 08:44:05 +00004088 }
danielk1977f5fdda82004-11-03 08:44:05 +00004089
drhc047b9f2008-11-21 03:23:43 +00004090 sqlite3PcacheMakeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004091 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004092 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00004093
danielk197794daf7f2004-11-08 09:26:09 +00004094 if( needSyncPgno ){
4095 /* If needSyncPgno is non-zero, then the journal file needs to be
4096 ** sync()ed before any data is written to database file page needSyncPgno.
4097 ** Currently, no such page exists in the page-cache and the
danielk19774c999992008-07-16 18:17:55 +00004098 ** "is journaled" bitvec flag has been set. This needs to be remedied by
4099 ** loading the page into the pager-cache and setting the PgHdr.needSync
4100 ** flag.
danielk1977ae825582004-11-23 09:06:55 +00004101 **
danielk1977a98d7b42008-01-18 13:42:54 +00004102 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00004103 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00004104 ** array. Otherwise, if the page is loaded and written again in
4105 ** this transaction, it may be written to the database file before
4106 ** it is synced into the journal file. This way, it may end up in
4107 ** the journal file twice, but that is not a problem.
4108 **
danielk19773b8a05f2007-03-19 17:44:26 +00004109 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004110 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004111 */
4112 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004113 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004114 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004115 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00004116 if( rc!=SQLITE_OK ){
danielk1977d92db532008-11-17 04:56:24 +00004117 if( pPager->pInJournal && needSyncPgno<=pPager->origDbSize ){
drhf5e7bb52008-02-18 14:47:33 +00004118 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00004119 }
danielk197787c29a92008-01-18 11:33:16 +00004120 return rc;
4121 }
danielk1977ae825582004-11-23 09:06:55 +00004122 pPager->needSync = 1;
drhb3df2e12008-09-17 20:06:26 +00004123 assert( pPager->noSync==0 && !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00004124 pPgHdr->flags |= PGHDR_NEED_SYNC;
drhc047b9f2008-11-21 03:23:43 +00004125 sqlite3PcacheMakeDirty(pPgHdr);
danielk19773b8a05f2007-03-19 17:44:26 +00004126 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004127 }
4128
danielk1977687566d2004-11-02 12:56:41 +00004129 return SQLITE_OK;
4130}
4131#endif
4132
danielk19773b8a05f2007-03-19 17:44:26 +00004133/*
4134** Return a pointer to the data for the specified page.
4135*/
4136void *sqlite3PagerGetData(DbPage *pPg){
danielk197771d5d2c2008-09-29 11:49:47 +00004137 assert( pPg->nRef>0 || pPg->pPager->memDb );
danielk19778c0a7912008-08-20 14:49:23 +00004138 return pPg->pData;
danielk19773b8a05f2007-03-19 17:44:26 +00004139}
4140
4141/*
4142** Return a pointer to the Pager.nExtra bytes of "extra" space
4143** allocated along with the specified page.
4144*/
4145void *sqlite3PagerGetExtra(DbPage *pPg){
4146 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00004147 return (pPager?pPg->pExtra:0);
danielk19773b8a05f2007-03-19 17:44:26 +00004148}
4149
danielk197741483462007-03-24 16:45:04 +00004150/*
4151** Get/set the locking-mode for this pager. Parameter eMode must be one
4152** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4153** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4154** the locking-mode is set to the value specified.
4155**
4156** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4157** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4158** locking-mode.
4159*/
4160int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004161 assert( eMode==PAGER_LOCKINGMODE_QUERY
4162 || eMode==PAGER_LOCKINGMODE_NORMAL
4163 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4164 assert( PAGER_LOCKINGMODE_QUERY<0 );
4165 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4166 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00004167 pPager->exclusiveMode = eMode;
4168 }
4169 return (int)pPager->exclusiveMode;
4170}
4171
drh3b020132008-04-17 17:02:01 +00004172/*
drh04335882008-09-26 21:08:08 +00004173** Get/set the journal-mode for this pager. Parameter eMode must be one of:
drh3b020132008-04-17 17:02:01 +00004174**
drh04335882008-09-26 21:08:08 +00004175** PAGER_JOURNALMODE_QUERY
4176** PAGER_JOURNALMODE_DELETE
4177** PAGER_JOURNALMODE_TRUNCATE
4178** PAGER_JOURNALMODE_PERSIST
4179** PAGER_JOURNALMODE_OFF
4180**
4181** If the parameter is not _QUERY, then the journal-mode is set to the
4182** value specified.
4183**
4184** The returned indicate the current (possibly updated)
drh3b020132008-04-17 17:02:01 +00004185** journal-mode.
4186*/
4187int sqlite3PagerJournalMode(Pager *pPager, int eMode){
danielk1977b3175382008-10-17 18:51:52 +00004188 if( !MEMDB ){
4189 assert( eMode==PAGER_JOURNALMODE_QUERY
4190 || eMode==PAGER_JOURNALMODE_DELETE
4191 || eMode==PAGER_JOURNALMODE_TRUNCATE
4192 || eMode==PAGER_JOURNALMODE_PERSIST
4193 || eMode==PAGER_JOURNALMODE_OFF
4194 || eMode==PAGER_JOURNALMODE_MEMORY );
4195 assert( PAGER_JOURNALMODE_QUERY<0 );
4196 if( eMode>=0 ){
4197 pPager->journalMode = eMode;
4198 }else{
4199 assert( eMode==PAGER_JOURNALMODE_QUERY );
4200 }
drh3b020132008-04-17 17:02:01 +00004201 }
drhfdc40e92008-04-17 20:59:37 +00004202 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00004203}
4204
danielk1977b53e4962008-06-04 06:45:59 +00004205/*
4206** Get/set the size-limit used for persistent journal files.
4207*/
4208i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
4209 if( iLimit>=-1 ){
4210 pPager->journalSizeLimit = iLimit;
4211 }
4212 return pPager->journalSizeLimit;
4213}
4214
drh2e66f0b2005-04-28 17:18:48 +00004215#endif /* SQLITE_OMIT_DISKIO */