blob: e0e46ee22748d867ea72defabe8d88004ac9b301 [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**
danielk1977d92db532008-11-17 04:56:24 +000021** @(#) $Id: pager.c,v 1.504 2008/11/17 04:56:24 danielk1977 Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drh2e66f0b2005-04-28 17:18:48 +000023#ifndef SQLITE_OMIT_DISKIO
drhd9b02572001-04-15 00:37:09 +000024#include "sqliteInt.h"
drhed7c8552001-04-11 14:29:21 +000025
26/*
drhdb48ee02003-01-16 13:42:43 +000027** Macros for troubleshooting. Normally turned off
28*/
danielk1977466be562004-06-10 02:16:01 +000029#if 0
drhd3627af2006-12-18 18:34:51 +000030#define sqlite3DebugPrintf printf
drh4f0c5872007-03-26 22:05:01 +000031#define PAGERTRACE1(X) sqlite3DebugPrintf(X)
32#define PAGERTRACE2(X,Y) sqlite3DebugPrintf(X,Y)
33#define PAGERTRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
34#define PAGERTRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
35#define PAGERTRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000036#else
drh4f0c5872007-03-26 22:05:01 +000037#define PAGERTRACE1(X)
38#define PAGERTRACE2(X,Y)
39#define PAGERTRACE3(X,Y,Z)
40#define PAGERTRACE4(X,Y,Z,W)
41#define PAGERTRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000042#endif
43
danielk1977599fcba2004-11-08 07:13:13 +000044/*
drh4f0c5872007-03-26 22:05:01 +000045** The following two macros are used within the PAGERTRACEX() macros above
drhd86959f2005-11-26 03:51:18 +000046** to print out file-descriptors.
danielk1977599fcba2004-11-08 07:13:13 +000047**
drh85b623f2007-12-13 21:54:09 +000048** PAGERID() takes a pointer to a Pager struct as its argument. The
danielk197762079062007-08-15 17:08:46 +000049** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
drh85b623f2007-12-13 21:54:09 +000050** struct as its argument.
danielk1977599fcba2004-11-08 07:13:13 +000051*/
drhc001c582006-03-06 18:23:16 +000052#define PAGERID(p) ((int)(p->fd))
53#define FILEHANDLEID(fd) ((int)fd)
drhdb48ee02003-01-16 13:42:43 +000054
55/*
drhed7c8552001-04-11 14:29:21 +000056** The page cache as a whole is always in one of the following
57** states:
58**
drha6abd042004-06-09 17:37:22 +000059** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000060** writing the database file. There is no
61** data held in memory. This is the initial
62** state.
63**
drha6abd042004-06-09 17:37:22 +000064** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000065** Writing is not permitted. There can be
66** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000067** file at the same time.
drhed7c8552001-04-11 14:29:21 +000068**
drh726de592004-06-10 23:35:50 +000069** PAGER_RESERVED This process has reserved the database for writing
70** but has not yet made any changes. Only one process
71** at a time can reserve the database. The original
72** database file has not been modified so other
73** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000074** database file.
75**
76** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000077** Access is exclusive. No other processes or
78** threads can be reading or writing while one
79** process is writing.
80**
danielk1977aa5ccdf2004-06-14 05:10:42 +000081** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
82** after all dirty pages have been written to the
83** database file and the file has been synced to
drh369339d2007-03-30 16:01:55 +000084** disk. All that remains to do is to remove or
85** truncate the journal file and the transaction
86** will be committed.
danielk1977aa5ccdf2004-06-14 05:10:42 +000087**
drha6abd042004-06-09 17:37:22 +000088** The page cache comes up in PAGER_UNLOCK. The first time a
danielk19773b8a05f2007-03-19 17:44:26 +000089** sqlite3PagerGet() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000090** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000091** the state transitions back to PAGER_UNLOCK. The first time
danielk19773b8a05f2007-03-19 17:44:26 +000092** that sqlite3PagerWrite() is called, the state transitions to
drh369339d2007-03-30 16:01:55 +000093** PAGER_RESERVED. (Note that sqlite3PagerWrite() can only be
drh306dc212001-05-21 13:45:10 +000094** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000095** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh369339d2007-03-30 16:01:55 +000096** PAGER_RESERVED means that there is an open rollback journal.
97** The transition to PAGER_EXCLUSIVE occurs before any changes
98** are made to the database file, though writes to the rollback
99** journal occurs with just PAGER_RESERVED. After an sqlite3PagerRollback()
100** or sqlite3PagerCommitPhaseTwo(), the state can go back to PAGER_SHARED,
101** or it can stay at PAGER_EXCLUSIVE if we are in exclusive access mode.
drhed7c8552001-04-11 14:29:21 +0000102*/
drha6abd042004-06-09 17:37:22 +0000103#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000104#define PAGER_SHARED 1 /* same as SHARED_LOCK */
105#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
106#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
107#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000108
drh684917c2004-10-05 02:41:42 +0000109/*
110** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
111** then failed attempts to get a reserved lock will invoke the busy callback.
112** This is off by default. To see why, consider the following scenario:
113**
114** Suppose thread A already has a shared lock and wants a reserved lock.
115** Thread B already has a reserved lock and wants an exclusive lock. If
116** both threads are using their busy callbacks, it might be a long time
117** be for one of the threads give up and allows the other to proceed.
118** But if the thread trying to get the reserved lock gives up quickly
119** (if it never invokes its busy callback) then the contention will be
120** resolved quickly.
121*/
122#ifndef SQLITE_BUSY_RESERVED_LOCK
123# define SQLITE_BUSY_RESERVED_LOCK 0
124#endif
drhd9b02572001-04-15 00:37:09 +0000125
drhed7c8552001-04-11 14:29:21 +0000126/*
drh887dc4c2004-10-22 16:22:57 +0000127** This macro rounds values up so that if the value is an address it
128** is guaranteed to be an address that is aligned to an 8-byte boundary.
129*/
130#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
131
drh9eb9e262004-02-11 02:18:05 +0000132/*
133** A macro used for invoking the codec if there is one
134*/
135#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000136# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
137# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000138#else
drhc001c582006-03-06 18:23:16 +0000139# define CODEC1(P,D,N,X) /* NO-OP */
140# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000141#endif
142
drhed7c8552001-04-11 14:29:21 +0000143/*
drhed7c8552001-04-11 14:29:21 +0000144** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000145**
drh4f0ee682007-03-30 20:43:40 +0000146** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000147** or SQLITE_FULL. Once one of the first three errors occurs, it persists
148** and is returned as the result of every major pager API call. The
149** SQLITE_FULL return code is slightly different. It persists only until the
150** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000151** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000152** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000153*/
154struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000155 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000156 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000157 u8 journalStarted; /* True if header of journal is synced */
158 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000159 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000160 u8 stmtOpen; /* True if the statement subjournal is open */
161 u8 stmtInUse; /* True we are in a statement subtransaction */
162 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000163 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000164 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000165 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000166 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000167 u8 tempFile; /* zFilename is a temporary file */
168 u8 readOnly; /* True for a read-only database */
169 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000170 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000171 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000172 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000173 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000174 u8 doNotSync; /* Boolean. While true, do not spill the cache */
175 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
drhfdc40e92008-04-17 20:59:37 +0000176 u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */
drhd138c012008-05-13 00:58:18 +0000177 u8 dbModified; /* True if there are any changes to the Db */
drh80e35f42007-03-30 14:06:34 +0000178 u8 changeCountDone; /* Set after incrementing the change-counter */
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*/
drh726de592004-06-10 23:35:50 +0000201 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drheb206252004-10-01 02:00:31 +0000202 i64 journalOff; /* Current byte offset in the journal file */
203 i64 journalHdr; /* Byte offset to previous journal header */
204 i64 stmtHdrOff; /* First journal header written this statement */
205 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000206 i64 stmtJSize; /* Size of journal at stmt_begin() */
drh98c58352008-11-07 00:24:53 +0000207 u32 sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000208#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000209 int nHit, nMiss; /* Cache hits and missing */
210 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000211#endif
danielk1977eaa06f62008-09-18 17:34:44 +0000212 void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000213#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000214 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000215 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000216#endif
danielk19778186df82007-03-06 13:45:59 +0000217 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000218 char dbFileVers[16]; /* Changes whenever database file changes */
danielk1977b53e4962008-06-04 06:45:59 +0000219 i64 journalSizeLimit; /* Size limit for persistent journal files */
danielk19778c0a7912008-08-20 14:49:23 +0000220 PCache *pPCache; /* Pointer to page cache object */
drhd9b02572001-04-15 00:37:09 +0000221};
222
223/*
drh538f5702007-04-13 02:14:30 +0000224** The following global variables hold counters used for
225** testing purposes only. These variables do not exist in
226** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000227*/
228#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000229int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
230int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
231int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
drh538f5702007-04-13 02:14:30 +0000232# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000233#else
drh538f5702007-04-13 02:14:30 +0000234# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000235#endif
236
drh538f5702007-04-13 02:14:30 +0000237
238
drhfcd35c72005-05-21 02:48:08 +0000239/*
drh5e00f6c2001-09-13 13:46:56 +0000240** Journal files begin with the following magic string. The data
241** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000242**
drhae2b40c2004-06-09 19:03:54 +0000243** Since version 2.8.0, the journal format contains additional sanity
244** checking information. If the power fails while the journal is begin
245** written, semi-random garbage data might appear in the journal
246** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000247** to roll the journal back, the database could be corrupted. The additional
248** sanity checking data is an attempt to discover the garbage in the
249** journal and ignore it.
250**
drhae2b40c2004-06-09 19:03:54 +0000251** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000252** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000253** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000254** This cksum is initialized to a 32-bit random value that appears in the
255** journal file right after the header. The random initializer is important,
256** because garbage data that appears at the end of a journal is likely
257** data that was once in other files that have now been deleted. If the
258** garbage data came from an obsolete journal file, the checksums might
259** be correct. But by initializing the checksum to random value which
260** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000261*/
drhae2b40c2004-06-09 19:03:54 +0000262static const unsigned char aJournalMagic[] = {
263 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000264};
265
266/*
drh726de592004-06-10 23:35:50 +0000267** The size of the header and of each page in the journal is determined
268** by the following macros.
drh968af522003-02-11 14:55:40 +0000269*/
drhae2b40c2004-06-09 19:03:54 +0000270#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000271
danielk197776572402004-06-25 02:38:54 +0000272/*
273** The journal header size for this pager. In the future, this could be
274** set to some value read from the disk controller. The important
275** characteristic is that it is the same size as a disk sector.
276*/
277#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
278
drhb7f91642004-10-31 02:22:47 +0000279/*
280** The macro MEMDB is true if we are dealing with an in-memory database.
281** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
282** the value of MEMDB will be a constant and the compiler will optimize
283** out code that would never execute.
284*/
285#ifdef SQLITE_OMIT_MEMORYDB
286# define MEMDB 0
287#else
288# define MEMDB pPager->memDb
289#endif
290
291/*
danielk197776572402004-06-25 02:38:54 +0000292** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
293** reserved for working around a windows/posix incompatibility). It is
294** used in the journal to signify that the remainder of the journal file
295** is devoted to storing a master journal name - there are no more pages to
296** roll back. See comments for function writeMasterJournal() for details.
297*/
danielk1977599fcba2004-11-08 07:13:13 +0000298/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
danielk1977d92db532008-11-17 04:56:24 +0000299#define PAGER_MJ_PGNO(x) ((Pgno)((PENDING_BYTE/((x)->pageSize))+1))
danielk197713adf8a2004-06-03 16:08:41 +0000300
drh968af522003-02-11 14:55:40 +0000301/*
danielk197726836652005-01-17 01:33:13 +0000302** The maximum legal page number is (2^31 - 1).
303*/
304#define PAGER_MAX_PGNO 2147483647
305
306/*
danielk1977f35843b2007-04-07 15:03:17 +0000307** Return true if page *pPg has already been written to the statement
308** journal (or statement snapshot has been created, if *pPg is part
309** of an in-memory database).
310*/
311static int pageInStatement(PgHdr *pPg){
312 Pager *pPager = pPg->pPager;
danielk1977b3175382008-10-17 18:51:52 +0000313 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000314}
drh8ca0c722006-05-07 17:49:38 +0000315
danielk1977bc2ca9e2008-11-13 14:28:28 +0000316static int pageInJournal(PgHdr *pPg){
317 return sqlite3BitvecTest(pPg->pPager->pInJournal, pPg->pgno);
318}
319
drh8ca0c722006-05-07 17:49:38 +0000320/*
drh34e79ce2004-02-08 06:05:46 +0000321** Read a 32-bit integer from the given file descriptor. Store the integer
322** that is read in *pRes. Return SQLITE_OK if everything worked, or an
323** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000324**
325** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000326*/
danielk197762079062007-08-15 17:08:46 +0000327static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000328 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000329 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000330 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000331 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000332 }
drh94f33312002-08-12 12:29:56 +0000333 return rc;
334}
335
336/*
drh97b57482006-01-10 20:32:32 +0000337** Write a 32-bit integer into a string buffer in big-endian byte order.
338*/
drha3152892007-05-05 11:48:52 +0000339#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000340
341/*
drh34e79ce2004-02-08 06:05:46 +0000342** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
343** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000344*/
danielk197762079062007-08-15 17:08:46 +0000345static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000346 char ac[4];
drh97b57482006-01-10 20:32:32 +0000347 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000348 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000349}
350
drh2554f8b2003-01-22 01:26:44 +0000351/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000352** If file pFd is open, call sqlite3OsUnlock() on it.
353*/
354static int osUnlock(sqlite3_file *pFd, int eLock){
355 if( !pFd->pMethods ){
356 return SQLITE_OK;
357 }
358 return sqlite3OsUnlock(pFd, eLock);
359}
360
361/*
danielk1977c7b60172007-08-22 11:22:03 +0000362** This function determines whether or not the atomic-write optimization
363** can be used with this pager. The optimization can be used if:
364**
365** (a) the value returned by OsDeviceCharacteristics() indicates that
366** a database page may be written atomically, and
367** (b) the value returned by OsSectorSize() is less than or equal
368** to the page size.
369**
370** If the optimization cannot be used, 0 is returned. If it can be used,
371** then the value returned is the size of the journal file when it
372** contains rollback data for exactly one page.
373*/
374#ifdef SQLITE_ENABLE_ATOMIC_WRITE
375static int jrnlBufferSize(Pager *pPager){
376 int dc; /* Device characteristics */
377 int nSector; /* Sector size */
drhfacf0302008-06-17 15:12:00 +0000378 int szPage; /* Page size */
danielk1977c7b60172007-08-22 11:22:03 +0000379 sqlite3_file *fd = pPager->fd;
380
381 if( fd->pMethods ){
382 dc = sqlite3OsDeviceCharacteristics(fd);
383 nSector = sqlite3OsSectorSize(fd);
drhfacf0302008-06-17 15:12:00 +0000384 szPage = pPager->pageSize;
danielk1977c7b60172007-08-22 11:22:03 +0000385 }
386
387 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
388 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
389
drhfacf0302008-06-17 15:12:00 +0000390 if( !fd->pMethods ||
391 (dc & (SQLITE_IOCAP_ATOMIC|(szPage>>8)) && nSector<=szPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000392 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
393 }
394 return 0;
395}
396#endif
397
398/*
danielk1977aef0bf62005-12-30 16:28:01 +0000399** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000400** code. The first argument is a pointer to the pager structure, the
401** second the error-code about to be returned by a pager API function.
402** The value returned is a copy of the second argument to this function.
403**
drh4f0ee682007-03-30 20:43:40 +0000404** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000405** the error becomes persistent. Until the persisten error is cleared,
406** subsequent API calls on this Pager will immediately return the same
407** error code.
408**
409** A persistent error indicates that the contents of the pager-cache
410** cannot be trusted. This state can be cleared by completely discarding
411** the contents of the pager-cache. If a transaction was active when
412** the persistent error occured, then the rollback journal may need
413** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000414*/
danielk1977ae72d982007-10-03 08:46:44 +0000415static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000416static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000417 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000418 assert(
419 pPager->errCode==SQLITE_FULL ||
420 pPager->errCode==SQLITE_OK ||
421 (pPager->errCode & 0xff)==SQLITE_IOERR
422 );
danielk1977979f38e2007-03-27 16:19:51 +0000423 if(
drh4ac285a2006-09-15 07:28:50 +0000424 rc2==SQLITE_FULL ||
425 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000426 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000427 ){
428 pPager->errCode = rc;
danielk19778c0a7912008-08-20 14:49:23 +0000429 if( pPager->state==PAGER_UNLOCK
430 && sqlite3PcacheRefCount(pPager->pPCache)==0
431 ){
danielk1977ae72d982007-10-03 08:46:44 +0000432 /* If the pager is already unlocked, call pager_unlock() now to
433 ** clear the error state and ensure that the pager-cache is
434 ** completely empty.
435 */
436 pager_unlock(pPager);
437 }
danielk1977aef0bf62005-12-30 16:28:01 +0000438 }
439 return rc;
440}
441
drh477731b2007-06-16 03:06:27 +0000442/*
443** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
444** on the cache using a hash function. This is used for testing
445** and debugging only.
446*/
danielk19773c407372005-02-15 02:54:14 +0000447#ifdef SQLITE_CHECK_PAGES
448/*
449** Return a 32-bit hash of the page data for pPage.
450*/
drh477731b2007-06-16 03:06:27 +0000451static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000452 u32 hash = 0;
453 int i;
drh477731b2007-06-16 03:06:27 +0000454 for(i=0; i<nByte; i++){
455 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000456 }
457 return hash;
458}
drh477731b2007-06-16 03:06:27 +0000459static u32 pager_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000460 return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
461}
danielk1977bc2ca9e2008-11-13 14:28:28 +0000462static void pager_set_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000463 pPage->pageHash = pager_pagehash(pPage);
drh477731b2007-06-16 03:06:27 +0000464}
danielk19773c407372005-02-15 02:54:14 +0000465
466/*
467** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
468** is defined, and NDEBUG is not defined, an assert() statement checks
469** that the page is either dirty or still matches the calculated page-hash.
470*/
471#define CHECK_PAGE(x) checkPage(x)
472static void checkPage(PgHdr *pPg){
473 Pager *pPager = pPg->pPager;
danielk1977b3175382008-10-17 18:51:52 +0000474 assert( !pPg->pageHash || pPager->errCode
danielk19778c0a7912008-08-20 14:49:23 +0000475 || (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
danielk19773c407372005-02-15 02:54:14 +0000476}
477
478#else
drh8ffa8172007-06-18 17:25:17 +0000479#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000480#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000481#define CHECK_PAGE(x)
drh41d30272008-08-20 21:47:45 +0000482#endif /* SQLITE_CHECK_PAGES */
danielk19773c407372005-02-15 02:54:14 +0000483
drhed7c8552001-04-11 14:29:21 +0000484/*
danielk197776572402004-06-25 02:38:54 +0000485** When this is called the journal file for pager pPager must be open.
486** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000487** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000488**
danielk197765839c62007-08-30 08:08:17 +0000489** zMaster must point to a buffer of at least nMaster bytes allocated by
490** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
491** enough space to write the master journal name). If the master journal
492** name in the journal is longer than nMaster bytes (including a
493** nul-terminator), then this is handled as if no master journal name
494** were present in the journal.
495**
496** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000497** SQLITE_OK returned.
498*/
danielk1977d92db532008-11-17 04:56:24 +0000499static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, u32 nMaster){
danielk197776572402004-06-25 02:38:54 +0000500 int rc;
501 u32 len;
drheb206252004-10-01 02:00:31 +0000502 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000503 u32 cksum;
shane0b8d2762008-07-22 05:18:00 +0000504 u32 u; /* Unsigned loop counter */
danielk197776572402004-06-25 02:38:54 +0000505 unsigned char aMagic[8]; /* A buffer to hold the magic header */
506
danielk197765839c62007-08-30 08:08:17 +0000507 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000508
drh054889e2005-11-30 03:20:31 +0000509 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000510 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000511
danielk197762079062007-08-15 17:08:46 +0000512 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000513 if( rc!=SQLITE_OK ) return rc;
514
danielk197765839c62007-08-30 08:08:17 +0000515 if( len>=nMaster ){
516 return SQLITE_OK;
517 }
518
danielk197762079062007-08-15 17:08:46 +0000519 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000520 if( rc!=SQLITE_OK ) return rc;
521
danielk197762079062007-08-15 17:08:46 +0000522 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000523 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
524
danielk197765839c62007-08-30 08:08:17 +0000525 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000526 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000527 return rc;
528 }
danielk197765839c62007-08-30 08:08:17 +0000529 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000530
531 /* See if the checksum matches the master journal name */
shane0b8d2762008-07-22 05:18:00 +0000532 for(u=0; u<len; u++){
533 cksum -= zMaster[u];
danielk197765839c62007-08-30 08:08:17 +0000534 }
danielk19778191bff2004-06-28 04:52:30 +0000535 if( cksum ){
536 /* If the checksum doesn't add up, then one or more of the disk sectors
537 ** containing the master journal filename is corrupted. This means
538 ** definitely roll back, so just return SQLITE_OK and report a (nul)
539 ** master-journal filename.
540 */
danielk197765839c62007-08-30 08:08:17 +0000541 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000542 }
danielk197776572402004-06-25 02:38:54 +0000543
544 return SQLITE_OK;
545}
546
547/*
548** Seek the journal file descriptor to the next sector boundary where a
549** journal header may be read or written. Pager.journalOff is updated with
550** the new seek offset.
551**
552** i.e for a sector size of 512:
553**
554** Input Offset Output Offset
555** ---------------------------------------
556** 0 0
557** 512 512
558** 100 512
559** 2000 2048
560**
561*/
danielk197762079062007-08-15 17:08:46 +0000562static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000563 i64 offset = 0;
564 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000565 if( c ){
566 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
567 }
568 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
569 assert( offset>=c );
570 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
571 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000572}
573
574/*
drhf3a87622008-04-17 14:16:42 +0000575** Write zeros over the header of the journal file. This has the
576** effect of invalidating the journal file and committing the
577** transaction.
578*/
danielk1977df2566a2008-05-07 19:11:03 +0000579static int zeroJournalHdr(Pager *pPager, int doTruncate){
580 int rc = SQLITE_OK;
danielk197755a25a12008-09-11 10:29:15 +0000581 static const char zeroHdr[28] = {0};
drhf3a87622008-04-17 14:16:42 +0000582
danielk1977df2566a2008-05-07 19:11:03 +0000583 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000584 i64 iLimit = pPager->journalSizeLimit;
585
danielk1977df2566a2008-05-07 19:11:03 +0000586 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000587 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000588 rc = sqlite3OsTruncate(pPager->jfd, 0);
589 }else{
590 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
591 }
danielk197781620542008-06-07 05:19:37 +0000592 if( rc==SQLITE_OK && !pPager->noSync ){
danielk1977df2566a2008-05-07 19:11:03 +0000593 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
594 }
danielk1977b53e4962008-06-04 06:45:59 +0000595
596 /* At this point the transaction is committed but the write lock
597 ** is still held on the file. If there is a size limit configured for
598 ** the persistent journal and the journal file currently consumes more
599 ** space than that limit allows for, truncate it now. There is no need
600 ** to sync the file following this operation.
601 */
602 if( rc==SQLITE_OK && iLimit>0 ){
603 i64 sz;
604 rc = sqlite3OsFileSize(pPager->jfd, &sz);
605 if( rc==SQLITE_OK && sz>iLimit ){
606 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
607 }
608 }
drha06ecba2008-04-22 17:15:17 +0000609 }
drhf3a87622008-04-17 14:16:42 +0000610 return rc;
611}
612
613/*
danielk197776572402004-06-25 02:38:54 +0000614** The journal file must be open when this routine is called. A journal
615** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
616** current location.
617**
618** The format for the journal header is as follows:
619** - 8 bytes: Magic identifying journal format.
620** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
621** - 4 bytes: Random number used for page hash.
622** - 4 bytes: Initial database page count.
623** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000624** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000625**
danielk197767c007b2008-03-20 04:45:49 +0000626** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000627*/
628static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000629 int rc = SQLITE_OK;
630 char *zHeader = pPager->pTmpSpace;
danielk1977d92db532008-11-17 04:56:24 +0000631 u32 nHeader = pPager->pageSize;
632 u32 nWrite;
danielk1977a664f8e2008-04-22 14:31:48 +0000633
634 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
635 nHeader = JOURNAL_HDR_SZ(pPager);
636 }
danielk197776572402004-06-25 02:38:54 +0000637
danielk19774099f6e2007-03-19 11:25:20 +0000638 if( pPager->stmtHdrOff==0 ){
639 pPager->stmtHdrOff = pPager->journalOff;
640 }
641
danielk197762079062007-08-15 17:08:46 +0000642 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000643 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000644
drh97b57482006-01-10 20:32:32 +0000645 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +0000646
647 /*
648 ** Write the nRec Field - the number of page records that follow this
649 ** journal header. Normally, zero is written to this value at this time.
650 ** After the records are added to the journal (and the journal synced,
651 ** if in full-sync mode), the zero is overwritten with the true number
652 ** of records (see syncJournal()).
653 **
654 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
655 ** reading the journal this value tells SQLite to assume that the
656 ** rest of the journal file contains valid page records. This assumption
657 ** is dangerous, as if a failure occured whilst writing to the journal
658 ** file it may contain some garbage data. There are two scenarios
659 ** where this risk can be ignored:
660 **
661 ** * When the pager is in no-sync mode. Corruption can follow a
662 ** power failure in this case anyway.
663 **
664 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
665 ** that garbage data is never appended to the journal file.
666 */
667 assert(pPager->fd->pMethods||pPager->noSync);
danielk1977b3175382008-10-17 18:51:52 +0000668 if( (pPager->noSync) || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY)
danielk19774cd2cd52007-08-23 14:48:23 +0000669 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
670 ){
671 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
672 }else{
673 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
674 }
675
drh97b57482006-01-10 20:32:32 +0000676 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +0000677 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +0000678 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
679 /* The initial database size */
680 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
681 /* The assumed sector size for this process */
682 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +0000683 if( pPager->journalHdr==0 ){
684 /* The page size */
685 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
686 }
danielk197776572402004-06-25 02:38:54 +0000687
danielk1977a664f8e2008-04-22 14:31:48 +0000688 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
689 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
690 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
691 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +0000692 }
danielk1977a664f8e2008-04-22 14:31:48 +0000693
danielk197776572402004-06-25 02:38:54 +0000694 return rc;
695}
696
697/*
698** The journal file must be open when this is called. A journal header file
699** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
700** file. See comments above function writeJournalHdr() for a description of
701** the journal header format.
702**
703** If the header is read successfully, *nRec is set to the number of
704** page records following this header and *dbSize is set to the size of the
705** database before the transaction began, in pages. Also, pPager->cksumInit
706** is set to the value read from the journal header. SQLITE_OK is returned
707** in this case.
708**
709** If the journal header file appears to be corrupted, SQLITE_DONE is
710** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
711** cannot be read from the journal file an error code is returned.
712*/
713static int readJournalHdr(
714 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000715 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000716 u32 *pNRec,
717 u32 *pDbSize
718){
719 int rc;
720 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000721 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +0000722 int iPageSize;
danielk197776572402004-06-25 02:38:54 +0000723
danielk197762079062007-08-15 17:08:46 +0000724 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000725 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
726 return SQLITE_DONE;
727 }
danielk197762079062007-08-15 17:08:46 +0000728 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000729
danielk197762079062007-08-15 17:08:46 +0000730 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000731 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000732 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000733
734 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
735 return SQLITE_DONE;
736 }
737
danielk197762079062007-08-15 17:08:46 +0000738 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000739 if( rc ) return rc;
740
danielk197762079062007-08-15 17:08:46 +0000741 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000742 if( rc ) return rc;
743
danielk197762079062007-08-15 17:08:46 +0000744 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000745 if( rc ) return rc;
746
danielk197767c007b2008-03-20 04:45:49 +0000747 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
748 if( rc==SQLITE_OK
749 && iPageSize>=512
750 && iPageSize<=SQLITE_MAX_PAGE_SIZE
751 && ((iPageSize-1)&iPageSize)==0
752 ){
753 u16 pagesize = iPageSize;
754 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
755 }
756 if( rc ) return rc;
757
danielk197776572402004-06-25 02:38:54 +0000758 /* Update the assumed sector-size to match the value used by
759 ** the process that created this journal. If this journal was
760 ** created by a process other than this one, then this routine
761 ** is being called from within pager_playback(). The local value
762 ** of Pager.sectorSize is restored at the end of that routine.
763 */
drh98c58352008-11-07 00:24:53 +0000764 rc = read32bits(pPager->jfd, jrnlOff+12, &pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000765 if( rc ) return rc;
drh98c58352008-11-07 00:24:53 +0000766 if( (pPager->sectorSize & (pPager->sectorSize-1))!=0
767 || pPager->sectorSize>0x1000000 ){
768 return SQLITE_DONE;
769 }
danielk197776572402004-06-25 02:38:54 +0000770
771 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +0000772 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000773}
774
775
776/*
777** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000778** pPager at the current location. The master journal name must be the last
779** thing written to a journal file. If the pager is in full-sync mode, the
780** journal file descriptor is advanced to the next sector boundary before
781** anything is written. The format is:
782**
783** + 4 bytes: PAGER_MJ_PGNO.
784** + N bytes: length of master journal name.
785** + 4 bytes: N
786** + 4 bytes: Master journal name checksum.
787** + 8 bytes: aJournalMagic[].
788**
789** The master journal page checksum is the sum of the bytes in the master
790** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000791**
792** If zMaster is a NULL pointer (occurs for a single database transaction),
793** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000794*/
795static int writeMasterJournal(Pager *pPager, const char *zMaster){
796 int rc;
797 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000798 int i;
danielk197762079062007-08-15 17:08:46 +0000799 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +0000800 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +0000801 u32 cksum = 0;
802 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000803
danielk1977b3175382008-10-17 18:51:52 +0000804 if( !zMaster || pPager->setMaster ) return SQLITE_OK;
805 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ) return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000806 pPager->setMaster = 1;
807
808 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000809 for(i=0; i<len; i++){
810 cksum += zMaster[i];
811 }
danielk197776572402004-06-25 02:38:54 +0000812
813 /* If in full-sync mode, advance to the next disk sector before writing
814 ** the master journal name. This is in case the previous page written to
815 ** the journal has already been synced.
816 */
817 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000818 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000819 }
danielk197762079062007-08-15 17:08:46 +0000820 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000821 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000822
danielk197762079062007-08-15 17:08:46 +0000823 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000824 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000825 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000826
danielk197762079062007-08-15 17:08:46 +0000827 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000828 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000829 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000830
drh97b57482006-01-10 20:32:32 +0000831 put32bits(zBuf, len);
832 put32bits(&zBuf[4], cksum);
833 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000834 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +0000835 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +0000836 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +0000837
838 /* If the pager is in peristent-journal mode, then the physical
839 ** journal-file may extend past the end of the master-journal name
840 ** and 8 bytes of magic data just written to the file. This is
841 ** dangerous because the code to rollback a hot-journal file
842 ** will not be able to find the master-journal name to determine
843 ** whether or not the journal is hot.
844 **
845 ** Easiest thing to do in this scenario is to truncate the journal
846 ** file to the required size.
847 */
848 if( (rc==SQLITE_OK)
849 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
850 && jrnlSize>jrnlOff
851 ){
852 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
853 }
danielk197776572402004-06-25 02:38:54 +0000854 return rc;
855}
856
857/*
drhed7c8552001-04-11 14:29:21 +0000858** Find a page in the hash table given its page number. Return
859** a pointer to the page or NULL if not found.
860*/
drhd9b02572001-04-15 00:37:09 +0000861static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000862 PgHdr *p;
danielk19778c0a7912008-08-20 14:49:23 +0000863 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &p);
drhed7c8552001-04-11 14:29:21 +0000864 return p;
865}
866
867/*
danielk1977e180dd92007-04-05 17:15:52 +0000868** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000869** sets the state of the pager back to what it was when it was first
870** opened. Any outstanding pages are invalidated and subsequent attempts
871** to access those pages will likely result in a coredump.
872*/
drhd9b02572001-04-15 00:37:09 +0000873static void pager_reset(Pager *pPager){
danielk1977efaaf572006-01-16 11:29:19 +0000874 if( pPager->errCode ) return;
danielk19778c0a7912008-08-20 14:49:23 +0000875 sqlite3PcacheClear(pPager->pPCache);
danielk1977e277be02007-03-23 18:12:06 +0000876}
877
878/*
danielk1977ae72d982007-10-03 08:46:44 +0000879** Unlock the database file.
880**
881** If the pager is currently in error state, discard the contents of
882** the cache and reset the Pager structure internal state. If there is
883** an open journal-file, then the next time a shared-lock is obtained
884** on the pager file (by this or any other process), it will be
885** treated as a hot-journal and rolled back.
886*/
887static void pager_unlock(Pager *pPager){
888 if( !pPager->exclusiveMode ){
danielk1977b3175382008-10-17 18:51:52 +0000889 int rc = osUnlock(pPager->fd, NO_LOCK);
890 if( rc ) pPager->errCode = rc;
danielk1977d92db532008-11-17 04:56:24 +0000891 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +0000892 IOTRACE(("UNLOCK %p\n", pPager))
danielk1977ae72d982007-10-03 08:46:44 +0000893
danielk1977b3175382008-10-17 18:51:52 +0000894 /* Always close the journal file when dropping the database lock.
895 ** Otherwise, another connection with journal_mode=delete might
896 ** delete the file out from under us.
897 */
898 if( pPager->journalOpen ){
899 sqlite3OsClose(pPager->jfd);
900 pPager->journalOpen = 0;
901 sqlite3BitvecDestroy(pPager->pInJournal);
902 pPager->pInJournal = 0;
903 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
904 pPager->pAlwaysRollback = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000905 }
906
danielk1977b3175382008-10-17 18:51:52 +0000907 /* If Pager.errCode is set, the contents of the pager cache cannot be
908 ** trusted. Now that the pager file is unlocked, the contents of the
909 ** cache can be discarded and the error code safely cleared.
910 */
911 if( pPager->errCode ){
912 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
913 pager_reset(pPager);
914 if( pPager->stmtOpen ){
915 sqlite3OsClose(pPager->stfd);
916 sqlite3BitvecDestroy(pPager->pInStmt);
917 pPager->pInStmt = 0;
918 }
919 pPager->stmtOpen = 0;
920 pPager->stmtInUse = 0;
921 pPager->journalOff = 0;
922 pPager->journalStarted = 0;
923 pPager->stmtAutoopen = 0;
924 pPager->origDbSize = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000925 }
danielk1977b3175382008-10-17 18:51:52 +0000926
927 pPager->state = PAGER_UNLOCK;
928 pPager->changeCountDone = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000929 }
930}
931
932/*
933** Execute a rollback if a transaction is active and unlock the
934** database file. If the pager has already entered the error state,
935** do not attempt the rollback.
936*/
937static void pagerUnlockAndRollback(Pager *p){
danielk1977ae72d982007-10-03 08:46:44 +0000938 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
danielk19772d1d86f2008-06-20 14:59:51 +0000939 sqlite3BeginBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000940 sqlite3PagerRollback(p);
danielk19772d1d86f2008-06-20 14:59:51 +0000941 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +0000942 }
943 pager_unlock(p);
danielk1977ae72d982007-10-03 08:46:44 +0000944}
945
946/*
drh80e35f42007-03-30 14:06:34 +0000947** This routine ends a transaction. A transaction is ended by either
948** a COMMIT or a ROLLBACK.
949**
drhed7c8552001-04-11 14:29:21 +0000950** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +0000951** a RESERVED or EXCLUSIVE lock on the database. This routine will release
952** the database lock and acquires a SHARED lock in its place if that is
953** the appropriate thing to do. Release locks usually is appropriate,
954** unless we are in exclusive access mode or unless this is a
955** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
956**
957** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +0000958**
959** TODO: Consider keeping the journal file open for temporary databases.
960** This might give a performance improvement on windows where opening
961** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000962*/
danielk1977df2566a2008-05-07 19:11:03 +0000963static int pager_end_transaction(Pager *pPager, int hasMaster){
danielk197741483462007-03-24 16:45:04 +0000964 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +0000965 int rc2 = SQLITE_OK;
drha6abd042004-06-09 17:37:22 +0000966 if( pPager->state<PAGER_RESERVED ){
967 return SQLITE_OK;
968 }
danielk19773b8a05f2007-03-19 17:44:26 +0000969 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +0000970 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +0000971 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +0000972 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000973 }
drhda47d772002-12-02 04:25:19 +0000974 if( pPager->journalOpen ){
danielk1977b3175382008-10-17 18:51:52 +0000975 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
976 int isMemoryJournal = sqlite3IsMemJournal(pPager->jfd);
977 sqlite3OsClose(pPager->jfd);
978 pPager->journalOpen = 0;
979 if( !isMemoryJournal ){
980 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
981 }
982 }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE
drh04335882008-09-26 21:08:08 +0000983 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){
984 pPager->journalOff = 0;
985 pPager->journalStarted = 0;
986 }else if( pPager->exclusiveMode
danielk197793f7af92008-05-09 16:57:50 +0000987 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
988 ){
989 rc = zeroJournalHdr(pPager, hasMaster);
990 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +0000991 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +0000992 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +0000993 }else{
drh04335882008-09-26 21:08:08 +0000994 assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE || rc );
danielk1977b4b47412007-08-17 15:53:36 +0000995 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +0000996 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +0000997 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +0000998 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +0000999 }
danielk197741483462007-03-24 16:45:04 +00001000 }
drhf5e7bb52008-02-18 14:47:33 +00001001 sqlite3BitvecDestroy(pPager->pInJournal);
1002 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +00001003 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
1004 pPager->pAlwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001005#ifdef SQLITE_CHECK_PAGES
danielk1977bc2ca9e2008-11-13 14:28:28 +00001006 sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash);
danielk19773c407372005-02-15 02:54:14 +00001007#endif
danielk1977bc2ca9e2008-11-13 14:28:28 +00001008 sqlite3PcacheCleanAll(pPager->pPCache);
danielk1977ef317ab2004-06-23 10:43:10 +00001009 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001010 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001011 }else{
drhf5e7bb52008-02-18 14:47:33 +00001012 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001013 }
danielk1977979f38e2007-03-27 16:19:51 +00001014
danielk197741483462007-03-24 16:45:04 +00001015 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001016 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001017 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001018 }else if( pPager->state==PAGER_SYNCED ){
1019 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001020 }
danielk1977334cdb62007-03-26 08:05:12 +00001021 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001022 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001023 pPager->needSync = 0;
danielk19778c0a7912008-08-20 14:49:23 +00001024 /* lruListSetFirstSynced(pPager); */
danielk1977b3175382008-10-17 18:51:52 +00001025 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00001026 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00001027 }
drhd138c012008-05-13 00:58:18 +00001028 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001029
1030 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001031}
1032
drhed7c8552001-04-11 14:29:21 +00001033/*
drh968af522003-02-11 14:55:40 +00001034** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001035**
1036** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001037** random initial value and the page number. We experimented with
1038** a checksum of the entire data, but that was found to be too slow.
1039**
1040** Note that the page number is stored at the beginning of data and
1041** the checksum is stored at the end. This is important. If journal
1042** corruption occurs due to a power failure, the most likely scenario
1043** is that one end or the other of the record will be changed. It is
1044** much less likely that the two ends of the journal record will be
1045** correct and the middle be corrupt. Thus, this "checksum" scheme,
1046** though fast and simple, catches the mostly likely kind of corruption.
1047**
1048** FIX ME: Consider adding every 200th (or so) byte of the data to the
1049** checksum. That way if a single page spans 3 or more disk sectors and
1050** only the middle sector is corrupt, we will still have a reasonable
1051** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001052*/
drh74161702006-02-24 02:53:49 +00001053static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001054 u32 cksum = pPager->cksumInit;
1055 int i = pPager->pageSize-200;
1056 while( i>0 ){
1057 cksum += aData[i];
1058 i -= 200;
1059 }
drh968af522003-02-11 14:55:40 +00001060 return cksum;
1061}
1062
drh605ad8f2006-05-03 23:34:05 +00001063/* Forward declaration */
1064static void makeClean(PgHdr*);
1065
drh968af522003-02-11 14:55:40 +00001066/*
drhfa86c412002-02-02 15:01:15 +00001067** Read a single page from the journal file opened on file descriptor
1068** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001069**
drhc13148f2008-08-27 18:03:20 +00001070** The isMainJrnl flag is true if this is the main rollback journal and
1071** false for the statement journal. The main rollback journal uses
1072** checksums - the statement journal does not.
drhfa86c412002-02-02 15:01:15 +00001073*/
danielk197762079062007-08-15 17:08:46 +00001074static int pager_playback_one_page(
drhc13148f2008-08-27 18:03:20 +00001075 Pager *pPager, /* The pager being played back */
1076 sqlite3_file *jfd, /* The file that is the journal being rolled back */
1077 i64 offset, /* Offset of the page within the journal */
1078 int isMainJrnl /* True for main rollback journal. False for Stmt jrnl */
danielk197762079062007-08-15 17:08:46 +00001079){
drhfa86c412002-02-02 15:01:15 +00001080 int rc;
drhae2b40c2004-06-09 19:03:54 +00001081 PgHdr *pPg; /* An existing page in the cache */
1082 Pgno pgno; /* The page number of a page in journal */
1083 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001084 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001085
drhc13148f2008-08-27 18:03:20 +00001086 /* isMainJrnl should be true for the main journal and false for
drh96362842005-03-20 22:47:56 +00001087 ** statement journals. Verify that this is always the case
1088 */
drhc13148f2008-08-27 18:03:20 +00001089 assert( jfd == (isMainJrnl ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001090 assert( aData );
drh96362842005-03-20 22:47:56 +00001091
danielk197762079062007-08-15 17:08:46 +00001092 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001093 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001094 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001095 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001096 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001097
drh968af522003-02-11 14:55:40 +00001098 /* Sanity checking on the page. This is more important that I originally
1099 ** thought. If a power failure occurs while the journal is being written,
1100 ** it could cause invalid data to be written into the journal. We need to
1101 ** detect this invalid data (with high probability) and ignore it.
1102 */
danielk197775edc162004-06-26 01:48:18 +00001103 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001104 return SQLITE_DONE;
1105 }
drhae2b40c2004-06-09 19:03:54 +00001106 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001107 return SQLITE_OK;
1108 }
drhc13148f2008-08-27 18:03:20 +00001109 if( isMainJrnl ){
danielk197762079062007-08-15 17:08:46 +00001110 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001111 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001112 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001113 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001114 return SQLITE_DONE;
1115 }
1116 }
drhfa86c412002-02-02 15:01:15 +00001117
danielk1977aa5ccdf2004-06-14 05:10:42 +00001118 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001119
1120 /* If the pager is in RESERVED state, then there must be a copy of this
1121 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001122 ** not the database file. The page is left marked dirty in this case.
1123 **
danielk19772df71c72007-05-24 07:22:42 +00001124 ** An exception to the above rule: If the database is in no-sync mode
1125 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001126 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1127 ** during a Movepage() call, then the page may not be in the cache
1128 ** either. So the condition described in the above paragraph is not
1129 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001130 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001131 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1132 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001133 **
1134 ** Ticket #1171: The statement journal might contain page content that is
1135 ** different from the page content at the start of the transaction.
1136 ** This occurs when a page is changed prior to the start of a statement
1137 ** then changed again within the statement. When rolling back such a
1138 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001139 ** for certain that original page contents are synced into the main rollback
1140 ** journal. Otherwise, a power loss might leave modified data in the
1141 ** database file without an entry in the rollback journal that can
1142 ** restore the database to its original form. Two conditions must be
1143 ** met before writing to the database files. (1) the database must be
1144 ** locked. (2) we know that the original page content is fully synced
1145 ** in the main journal either because the page is not in cache or else
1146 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001147 **
1148 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1149 ** is possible to fail a statement on a database that does not yet exist.
1150 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001151 */
drhae2b40c2004-06-09 19:03:54 +00001152 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001153 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1154 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
danielk19778c0a7912008-08-20 14:49:23 +00001155 if( (pPager->state>=PAGER_EXCLUSIVE)
1156 && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC))
1157 && (pPager->fd->pMethods)
1158 ){
drh281b21d2008-08-22 12:57:08 +00001159 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
1160 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst);
danielk1977a3f3a5f2004-06-10 04:32:16 +00001161 }
drhfa86c412002-02-02 15:01:15 +00001162 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001163 /* No page should ever be explicitly rolled back that is in use, except
1164 ** for page 1 which is held in use in order to keep the lock on the
1165 ** database active. However such a page may be rolled back as a result
1166 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001167 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001168 */
drhb6f41482004-05-14 01:58:11 +00001169 void *pData;
danielk19778c0a7912008-08-20 14:49:23 +00001170 pData = pPg->pData;
drhae2b40c2004-06-09 19:03:54 +00001171 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001172 if( pPager->xReiniter ){
danielk1977eaa06f62008-09-18 17:34:44 +00001173 pPager->xReiniter(pPg);
drhde647132004-05-07 17:57:49 +00001174 }
drhc13148f2008-08-27 18:03:20 +00001175 if( isMainJrnl ) makeClean(pPg);
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:
danielk19778191bff2004-06-28 04:52:30 +00001520 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001521 zMaster = pPager->pTmpSpace;
1522 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1523 }
1524 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001525 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001526 }
danielk1977c56774e2008-10-07 11:51:20 +00001527 if( rc==SQLITE_OK && zMaster[0] && res ){
danielk1977979f38e2007-03-27 16:19:51 +00001528 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001529 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001530 */
danielk197765839c62007-08-30 08:08:17 +00001531 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001532 }
danielk197776572402004-06-25 02:38:54 +00001533
1534 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001535 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001536 ** value. Reset it to the correct value for this process.
1537 */
drhc80f0582007-05-01 16:59:48 +00001538 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001539 return rc;
drhed7c8552001-04-11 14:29:21 +00001540}
1541
1542/*
drhac69b052004-05-12 13:30:07 +00001543** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001544**
1545** This is similar to playing back the transaction journal but with
1546** a few extra twists.
1547**
drh663fc632002-02-02 18:49:19 +00001548** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001549** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001550** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001551**
drhac69b052004-05-12 13:30:07 +00001552** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001553** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001554** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001555*/
drh3aac2dd2004-04-26 14:10:20 +00001556static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001557 i64 szJ; /* Size of the full journal */
1558 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001559 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001560 int i; /* Loop counter */
1561 int rc;
1562
danielk197776572402004-06-25 02:38:54 +00001563 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001564
danielk19774099f6e2007-03-19 11:25:20 +00001565 /* Set hdrOff to be the offset just after the end of the last journal
1566 ** page written before the first journal-header for this statement
1567 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001568 ** header was written.
1569 */
1570 hdrOff = pPager->stmtHdrOff;
1571 assert( pPager->fullSync || !hdrOff );
1572 if( !hdrOff ){
1573 hdrOff = szJ;
1574 }
1575
drhfa86c412002-02-02 15:01:15 +00001576 /* Truncate the database back to its original size.
1577 */
danielk1977e180dd92007-04-05 17:15:52 +00001578 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001579 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001580
drhac69b052004-05-12 13:30:07 +00001581 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001582 */
drhac69b052004-05-12 13:30:07 +00001583 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001584 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001585
drhac69b052004-05-12 13:30:07 +00001586 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001587 ** database file. Note that the statement journal omits checksums from
1588 ** each record since power-failure recovery is not important to statement
1589 ** journals.
drhfa86c412002-02-02 15:01:15 +00001590 */
danielk197762079062007-08-15 17:08:46 +00001591 for(i=0; i<nRec; i++){
1592 i64 offset = i*(4+pPager->pageSize);
1593 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001594 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001595 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001596 }
1597
danielk197776572402004-06-25 02:38:54 +00001598 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1599 ** was the size of the journal file when this statement was started, so
1600 ** everything after that needs to be rolled back, either into the
1601 ** database, the memory cache, or both.
1602 **
1603 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1604 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001605 */
danielk197776572402004-06-25 02:38:54 +00001606 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001607 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001608 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001609 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001610 assert( rc!=SQLITE_DONE );
1611 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1612 }
1613
1614 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001615 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001616 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001617 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001618 if( rc!=SQLITE_OK ){
1619 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001620 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001621 }
danielk1977f0113002006-01-24 12:09:17 +00001622 if( nJRec==0 ){
1623 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001624 }
danielk1977f0113002006-01-24 12:09:17 +00001625 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001626 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001627 assert( rc!=SQLITE_DONE );
1628 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1629 }
drhfa86c412002-02-02 15:01:15 +00001630 }
danielk197776572402004-06-25 02:38:54 +00001631
1632 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001633
drh3aac2dd2004-04-26 14:10:20 +00001634end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001635 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001636 pPager->journalOff = szJ;
1637 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001638 }
1639 return rc;
1640}
1641
1642/*
drhf57b14a2001-09-14 18:54:08 +00001643** Change the maximum number of in-memory pages that are allowed.
1644*/
danielk19773b8a05f2007-03-19 17:44:26 +00001645void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
danielk19778c0a7912008-08-20 14:49:23 +00001646 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001647}
1648
1649/*
drh973b6e32003-02-12 14:09:42 +00001650** Adjust the robustness of the database to damage due to OS crashes
1651** or power failures by changing the number of syncs()s when writing
1652** the rollback journal. There are three levels:
1653**
drh054889e2005-11-30 03:20:31 +00001654** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001655** for temporary and transient files.
1656**
1657** NORMAL The journal is synced once before writes begin on the
1658** database. This is normally adequate protection, but
1659** it is theoretically possible, though very unlikely,
1660** that an inopertune power failure could leave the journal
1661** in a state which would cause damage to the database
1662** when it is rolled back.
1663**
1664** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001665** database (with some additional information - the nRec field
1666** of the journal header - being written in between the two
1667** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001668** single disk sector is atomic, then this mode provides
1669** assurance that the journal will not be corrupted to the
1670** point of causing damage to the database during rollback.
1671**
1672** Numeric values associated with these states are OFF==1, NORMAL=2,
1673** and FULL=3.
1674*/
danielk197793758c82005-01-21 08:13:14 +00001675#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh281b21d2008-08-22 12:57:08 +00001676void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){
danielk1977b3175382008-10-17 18:51:52 +00001677 pPager->noSync = level==1 || pPager->tempFile;
drh973b6e32003-02-12 14:09:42 +00001678 pPager->fullSync = level==3 && !pPager->tempFile;
drh281b21d2008-08-22 12:57:08 +00001679 pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001680 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001681}
danielk197793758c82005-01-21 08:13:14 +00001682#endif
drh973b6e32003-02-12 14:09:42 +00001683
1684/*
drhaf6df112005-06-07 02:12:30 +00001685** The following global variable is incremented whenever the library
1686** attempts to open a temporary file. This information is used for
1687** testing and analysis only.
1688*/
drh0f7eb612006-08-08 13:51:43 +00001689#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001690int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001691#endif
drhaf6df112005-06-07 02:12:30 +00001692
1693/*
drh3f56e6e2007-03-15 01:16:47 +00001694** Open a temporary file.
1695**
1696** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001697** other error code if we fail. The OS will automatically delete the temporary
1698** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001699*/
danielk1977b4b47412007-08-17 15:53:36 +00001700static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00001701 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00001702 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00001703 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00001704){
drhfa86c412002-02-02 15:01:15 +00001705 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001706
drh0f7eb612006-08-08 13:51:43 +00001707#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001708 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001709#endif
danielk1977b4b47412007-08-17 15:53:36 +00001710
drh33f4e022007-09-03 15:19:34 +00001711 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
1712 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00001713 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00001714 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00001715 return rc;
1716}
1717
danielk1977a858aa22008-08-22 16:22:17 +00001718static int pagerStress(void *,PgHdr *);
danielk19778c0a7912008-08-20 14:49:23 +00001719
drhfa86c412002-02-02 15:01:15 +00001720/*
drhed7c8552001-04-11 14:29:21 +00001721** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001722** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001723** the first call to sqlite3PagerGet() and is only held open until the
1724** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001725**
drh6446c4d2001-12-15 14:22:18 +00001726** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00001727** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00001728** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001729**
1730** If zFilename is ":memory:" then all information is held in cache.
1731** It is never written to disk. This can be used to implement an
1732** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001733*/
danielk19773b8a05f2007-03-19 17:44:26 +00001734int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001735 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001736 Pager **ppPager, /* Return the Pager structure here */
1737 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001738 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00001739 int flags, /* flags controlling this file */
1740 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00001741){
danielk1977b4b47412007-08-17 15:53:36 +00001742 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001743 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001744 int rc = SQLITE_OK;
1745 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001746 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001747 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001748 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001749 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1750 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977b3175382008-10-17 18:51:52 +00001751 int journalFileSize;
danielk19778c0a7912008-08-20 14:49:23 +00001752 int pcacheSize = sqlite3PcacheSize();
drhfacf0302008-06-17 15:12:00 +00001753 int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00001754 char *zPathname = 0;
1755 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001756
danielk1977b3175382008-10-17 18:51:52 +00001757 if( sqlite3JournalSize(pVfs)>sqlite3MemJournalSize() ){
1758 journalFileSize = sqlite3JournalSize(pVfs);
1759 }else{
1760 journalFileSize = sqlite3MemJournalSize();
1761 }
1762
drh86f8c192007-08-22 00:39:19 +00001763 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001764 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001765
danielk197717b90b52008-06-06 11:11:25 +00001766 /* Compute and store the full pathname in an allocated buffer pointed
1767 ** to by zPathname, length nPathname. Or, if this is a temporary file,
1768 ** leave both nPathname and zPathname set to 0.
1769 */
drh1cc8c442007-08-24 16:08:29 +00001770 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00001771 nPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001772 zPathname = sqlite3Malloc(nPathname*2);
danielk197717b90b52008-06-06 11:11:25 +00001773 if( zPathname==0 ){
1774 return SQLITE_NOMEM;
1775 }
drh1cc8c442007-08-24 16:08:29 +00001776#ifndef SQLITE_OMIT_MEMORYDB
1777 if( strcmp(zFilename,":memory:")==0 ){
1778 memDb = 1;
1779 zPathname[0] = 0;
1780 }else
1781#endif
1782 {
danielk1977adfb9b02007-09-17 07:02:56 +00001783 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00001784 }
danielk197717b90b52008-06-06 11:11:25 +00001785 if( rc!=SQLITE_OK ){
1786 sqlite3_free(zPathname);
1787 return rc;
1788 }
1789 nPathname = strlen(zPathname);
drhae28c012007-08-24 16:29:23 +00001790 }
drh99b90c32008-03-17 13:50:58 +00001791
danielk1977b4b47412007-08-17 15:53:36 +00001792 /* Allocate memory for the pager structure */
1793 pPager = sqlite3MallocZero(
1794 sizeof(*pPager) + /* Pager structure */
danielk19778c0a7912008-08-20 14:49:23 +00001795 pcacheSize + /* PCache object */
danielk1977c7b60172007-08-22 11:22:03 +00001796 journalFileSize + /* The journal file structure */
danielk1977b3175382008-10-17 18:51:52 +00001797 pVfs->szOsFile + /* The main db file */
1798 journalFileSize * 2 + /* The two journal files */
danielk197717b90b52008-06-06 11:11:25 +00001799 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00001800 );
1801 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00001802 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00001803 return SQLITE_NOMEM;
1804 }
danielk19778c0a7912008-08-20 14:49:23 +00001805 pPager->pPCache = (PCache *)&pPager[1];
1806 pPtr = ((u8 *)&pPager[1]) + pcacheSize;
drh33f4e022007-09-03 15:19:34 +00001807 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00001808 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977b3175382008-10-17 18:51:52 +00001809 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile];
1810 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile+journalFileSize];
1811 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile+2*journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00001812 pPager->zDirectory = &pPager->zFilename[nPathname+1];
1813 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00001814 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00001815 if( zPathname ){
1816 memcpy(pPager->zFilename, zPathname, nPathname+1);
1817 sqlite3_free(zPathname);
1818 }
danielk1977b4b47412007-08-17 15:53:36 +00001819
drh153c62c2007-08-24 03:51:33 +00001820 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00001821 */
drhae28c012007-08-24 16:29:23 +00001822 if( zFilename && zFilename[0] && !memDb ){
danielk1977d92db532008-11-17 04:56:24 +00001823 if( nPathname>(pVfs->mxPathname - (int)sizeof("-journal")) ){
drh1cc8c442007-08-24 16:08:29 +00001824 rc = SQLITE_CANTOPEN;
1825 }else{
drh1cc8c442007-08-24 16:08:29 +00001826 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00001827 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
1828 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00001829 readOnly = (fout&SQLITE_OPEN_READONLY);
1830
1831 /* If the file was successfully opened for read/write access,
1832 ** choose a default page size in case we have to create the
1833 ** database file. The default page size is the maximum of:
1834 **
1835 ** + SQLITE_DEFAULT_PAGE_SIZE,
1836 ** + The value returned by sqlite3OsSectorSize()
1837 ** + The largest page size that can be written atomically.
1838 */
1839 if( rc==SQLITE_OK && !readOnly ){
1840 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
drhfacf0302008-06-17 15:12:00 +00001841 if( szPageDflt<iSectorSize ){
1842 szPageDflt = iSectorSize;
drh1cc8c442007-08-24 16:08:29 +00001843 }
danielk19779663b8f2007-08-24 11:52:28 +00001844#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00001845 {
1846 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
1847 int ii;
1848 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1849 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1850 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
drhfacf0302008-06-17 15:12:00 +00001851 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
1852 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii;
danielk19779663b8f2007-08-24 11:52:28 +00001853 }
danielk1977b4b47412007-08-17 15:53:36 +00001854 }
drh1cc8c442007-08-24 16:08:29 +00001855#endif
drhfacf0302008-06-17 15:12:00 +00001856 if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
1857 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
drh1cc8c442007-08-24 16:08:29 +00001858 }
danielk19778def5ea2004-06-16 10:39:52 +00001859 }
drhac69b052004-05-12 13:30:07 +00001860 }
danielk1977b3175382008-10-17 18:51:52 +00001861 }else{
danielk19777a2b1ee2007-08-21 14:27:01 +00001862 /* If a temporary file is requested, it is not opened immediately.
1863 ** In this case we accept the default page size and delay actually
1864 ** opening the file until the first call to OsWrite().
danielk1977b3175382008-10-17 18:51:52 +00001865 **
1866 ** This branch is also run for an in-memory database. An in-memory
1867 ** database is the same as a temp-file that is never written out to
1868 ** disk and uses an in-memory rollback journal.
danielk19777a2b1ee2007-08-21 14:27:01 +00001869 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001870 tempFile = 1;
1871 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001872 }
danielk1977aef0bf62005-12-30 16:28:01 +00001873
danielk1977b4b47412007-08-17 15:53:36 +00001874 if( pPager && rc==SQLITE_OK ){
drhfacf0302008-06-17 15:12:00 +00001875 pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt);
drh3e7a6092002-12-07 21:45:14 +00001876 }
danielk1977aef0bf62005-12-30 16:28:01 +00001877
drh153c62c2007-08-24 03:51:33 +00001878 /* If an error occured in either of the blocks above.
1879 ** Free the Pager structure and close the file.
1880 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00001881 ** any Pager.errMask variables.
1882 */
danielk1977b4b47412007-08-17 15:53:36 +00001883 if( !pPager || !pPager->pTmpSpace ){
1884 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001885 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001886 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001887 }
danielk19778c0a7912008-08-20 14:49:23 +00001888 nExtra = FORCE_ALIGNMENT(nExtra);
danielk197771d5d2c2008-09-29 11:49:47 +00001889 sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
drh41d30272008-08-20 21:47:45 +00001890 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
danielk1977aef0bf62005-12-30 16:28:01 +00001891
drh153c62c2007-08-24 03:51:33 +00001892 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
1893 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00001894
danielk1977b4b47412007-08-17 15:53:36 +00001895 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00001896 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00001897 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001898 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001899
drh99b90c32008-03-17 13:50:58 +00001900 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00001901 if( zPathname ){
1902 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
1903 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
1904 }else{
1905 pPager->zJournal = 0;
1906 }
danielk1977b4b47412007-08-17 15:53:36 +00001907
drh3b59a5c2006-01-15 20:28:28 +00001908 /* pPager->journalOpen = 0; */
drhb3df2e12008-09-17 20:06:26 +00001909 pPager->useJournal = useJournal;
drh7bec5052005-02-06 02:45:41 +00001910 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001911 /* pPager->stmtOpen = 0; */
1912 /* pPager->stmtInUse = 0; */
1913 /* pPager->nRef = 0; */
danielk1977d92db532008-11-17 04:56:24 +00001914 pPager->dbSizeValid = memDb;
drhfacf0302008-06-17 15:12:00 +00001915 pPager->pageSize = szPageDflt;
drh3b59a5c2006-01-15 20:28:28 +00001916 /* pPager->stmtSize = 0; */
1917 /* pPager->stmtJSize = 0; */
1918 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001919 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001920 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001921 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00001922 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00001923 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001924 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001925 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1926 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1927 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1928 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001929 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001930 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001931 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001932 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001933 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00001934 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00001935 /* pPager->pFirst = 0; */
1936 /* pPager->pFirstSynced = 0; */
1937 /* pPager->pLast = 0; */
danielk19778c0a7912008-08-20 14:49:23 +00001938 pPager->nExtra = nExtra;
danielk1977b53e4962008-06-04 06:45:59 +00001939 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk1977b3175382008-10-17 18:51:52 +00001940 assert(pPager->fd->pMethods||tempFile);
1941 setSectorSize(pPager);
1942 if( memDb ){
1943 pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
danielk1977b4721172007-03-19 05:54:48 +00001944 }
drh3b59a5c2006-01-15 20:28:28 +00001945 /* pPager->pBusyHandler = 0; */
1946 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001947 *ppPager = pPager;
1948 return SQLITE_OK;
1949}
1950
1951/*
drh90f5ecb2004-07-22 01:19:35 +00001952** Set the busy handler function.
1953*/
danielk19773b8a05f2007-03-19 17:44:26 +00001954void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00001955 pPager->pBusyHandler = pBusyHandler;
1956}
1957
1958/*
drha6abd042004-06-09 17:37:22 +00001959** Set the reinitializer for this pager. If not NULL, the reinitializer
1960** is called when the content of a page in cache is restored to its original
1961** value as a result of a rollback. The callback gives higher-level code
1962** an opportunity to restore the EXTRA section to agree with the restored
1963** page data.
1964*/
danielk1977eaa06f62008-09-18 17:34:44 +00001965void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*)){
drha6abd042004-06-09 17:37:22 +00001966 pPager->xReiniter = xReinit;
1967}
1968
1969/*
danielk1977a1644fd2007-08-29 12:31:25 +00001970** Set the page size to *pPageSize. If the suggest new page size is
1971** inappropriate, then an alternative page size is set to that
1972** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00001973*/
danielk1977a1644fd2007-08-29 12:31:25 +00001974int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
danielk19771357d9f2008-09-16 05:12:24 +00001975 int rc = pPager->errCode;
1976 if( rc==SQLITE_OK ){
1977 u16 pageSize = *pPageSize;
1978 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
1979 if( pageSize && pageSize!=pPager->pageSize
1980 && (pPager->memDb==0 || pPager->dbSize==0)
1981 && sqlite3PcacheRefCount(pPager->pPCache)==0
1982 ){
1983 char *pNew = (char *)sqlite3PageMalloc(pageSize);
1984 if( !pNew ){
1985 rc = SQLITE_NOMEM;
1986 }else{
1987 pager_reset(pPager);
1988 pPager->pageSize = pageSize;
1989 if( !pPager->memDb ) setSectorSize(pPager);
1990 sqlite3PageFree(pPager->pTmpSpace);
1991 pPager->pTmpSpace = pNew;
1992 sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
1993 }
danielk1977a1644fd2007-08-29 12:31:25 +00001994 }
danielk19771357d9f2008-09-16 05:12:24 +00001995 *pPageSize = pPager->pageSize;
drh1c7880e2005-05-20 20:01:55 +00001996 }
danielk1977a1644fd2007-08-29 12:31:25 +00001997 return rc;
drh90f5ecb2004-07-22 01:19:35 +00001998}
1999
2000/*
drh26b79942007-11-28 16:19:56 +00002001** Return a pointer to the "temporary page" buffer held internally
2002** by the pager. This is a buffer that is big enough to hold the
2003** entire content of a database page. This buffer is used internally
2004** during rollback and will be overwritten whenever a rollback
2005** occurs. But other modules are free to use it too, as long as
2006** no rollbacks are happening.
2007*/
2008void *sqlite3PagerTempSpace(Pager *pPager){
2009 return pPager->pTmpSpace;
2010}
2011
2012/*
drhf8e632b2007-05-08 14:51:36 +00002013** Attempt to set the maximum database page count if mxPage is positive.
2014** Make no changes if mxPage is zero or negative. And never reduce the
2015** maximum page count below the current size of the database.
2016**
2017** Regardless of mxPage, return the current maximum page count.
2018*/
2019int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2020 if( mxPage>0 ){
2021 pPager->mxPgno = mxPage;
2022 }
danielk1977ad0132d2008-06-07 08:58:22 +00002023 sqlite3PagerPagecount(pPager, 0);
drhf8e632b2007-05-08 14:51:36 +00002024 return pPager->mxPgno;
2025}
2026
2027/*
drhc9ac5ca2005-11-04 22:03:30 +00002028** The following set of routines are used to disable the simulated
2029** I/O error mechanism. These routines are used to avoid simulated
2030** errors in places where we do not care about errors.
2031**
2032** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2033** and generate no code.
2034*/
2035#ifdef SQLITE_TEST
2036extern int sqlite3_io_error_pending;
2037extern int sqlite3_io_error_hit;
2038static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002039void disable_simulated_io_errors(void){
2040 saved_cnt = sqlite3_io_error_pending;
2041 sqlite3_io_error_pending = -1;
2042}
2043void enable_simulated_io_errors(void){
2044 sqlite3_io_error_pending = saved_cnt;
2045}
2046#else
drh152410f2005-11-05 15:11:22 +00002047# define disable_simulated_io_errors()
2048# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002049#endif
2050
2051/*
drh90f5ecb2004-07-22 01:19:35 +00002052** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002053** that pDest points to.
2054**
2055** No error checking is done. The rational for this is that this function
2056** may be called even if the file does not exist or contain a header. In
2057** these cases sqlite3OsRead() will return an error, to which the correct
2058** response is to zero the memory at pDest and continue. A real IO error
2059** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002060*/
danielk19773b8a05f2007-03-19 17:44:26 +00002061int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002062 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002063 memset(pDest, 0, N);
danielk1977b3175382008-10-17 18:51:52 +00002064 assert(pPager->fd->pMethods||pPager->tempFile);
danielk19777a2b1ee2007-08-21 14:27:01 +00002065 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002066 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002067 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002068 if( rc==SQLITE_IOERR_SHORT_READ ){
2069 rc = SQLITE_OK;
2070 }
drh90f5ecb2004-07-22 01:19:35 +00002071 }
drh551b7732006-11-06 21:20:25 +00002072 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002073}
2074
2075/*
drh5e00f6c2001-09-13 13:46:56 +00002076** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002077** pPager.
2078**
2079** If the PENDING_BYTE lies on the page directly after the end of the
2080** file, then consider this page part of the file too. For example, if
2081** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2082** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002083*/
danielk1977ad0132d2008-06-07 08:58:22 +00002084int sqlite3PagerPagecount(Pager *pPager, int *pnPage){
danielk19777a2b1ee2007-08-21 14:27:01 +00002085 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002086 int rc;
drhd9b02572001-04-15 00:37:09 +00002087 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002088 if( pPager->errCode ){
danielk19778c0a7912008-08-20 14:49:23 +00002089 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002090 return rc;
drha7aea3d2007-03-15 12:51:16 +00002091 }
danielk1977d92db532008-11-17 04:56:24 +00002092 if( pPager->dbSizeValid ){
danielk197715f411d2005-09-16 10:18:45 +00002093 n = pPager->dbSize;
2094 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002095 assert(pPager->fd->pMethods||pPager->tempFile);
2096 if( (pPager->fd->pMethods)
2097 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002098 pager_error(pPager, rc);
danielk1977ad0132d2008-06-07 08:58:22 +00002099 return rc;
danielk197715f411d2005-09-16 10:18:45 +00002100 }
2101 if( n>0 && n<pPager->pageSize ){
2102 n = 1;
2103 }else{
2104 n /= pPager->pageSize;
2105 }
2106 if( pPager->state!=PAGER_UNLOCK ){
2107 pPager->dbSize = n;
danielk1977d92db532008-11-17 04:56:24 +00002108 pPager->dbSizeValid = 1;
danielk197715f411d2005-09-16 10:18:45 +00002109 }
drhed7c8552001-04-11 14:29:21 +00002110 }
danielk197715f411d2005-09-16 10:18:45 +00002111 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002112 n++;
2113 }
drhf8e632b2007-05-08 14:51:36 +00002114 if( n>pPager->mxPgno ){
2115 pPager->mxPgno = n;
2116 }
danielk1977ad0132d2008-06-07 08:58:22 +00002117 if( pnPage ){
2118 *pnPage = n;
2119 }
2120 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002121}
2122
2123/*
drhf7c57532003-04-25 13:22:51 +00002124** Forward declaration
2125*/
danielk197776572402004-06-25 02:38:54 +00002126static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002127
2128/*
danielk1977e180dd92007-04-05 17:15:52 +00002129** This routine is used to truncate the cache when a database
2130** is truncated. Drop from the cache all pages whose pgno is
2131** larger than pPager->dbSize and is unreferenced.
2132**
drhac69b052004-05-12 13:30:07 +00002133** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002134**
2135** Actually, at the point this routine is called, it would be
2136** an error to have a referenced page. But rather than delete
2137** that page and guarantee a subsequent segfault, it seems better
2138** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002139*/
danielk1977e180dd92007-04-05 17:15:52 +00002140static void pager_truncate_cache(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00002141 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
drhac69b052004-05-12 13:30:07 +00002142}
2143
drhf7c57532003-04-25 13:22:51 +00002144/*
danielk197717221812005-02-15 03:38:05 +00002145** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002146** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002147** false or until the lock succeeds.
2148**
2149** Return SQLITE_OK on success and an error code if we cannot obtain
2150** the lock.
2151*/
2152static int pager_wait_on_lock(Pager *pPager, int locktype){
2153 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002154
2155 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002156 assert( PAGER_SHARED==SHARED_LOCK );
2157 assert( PAGER_RESERVED==RESERVED_LOCK );
2158 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002159
2160 /* If the file is currently unlocked then the size must be unknown */
danielk1977d92db532008-11-17 04:56:24 +00002161 assert( pPager->state>=PAGER_SHARED || pPager->dbSizeValid==0 );
drh1aa2d8b2007-01-03 15:34:29 +00002162
danielk197717221812005-02-15 03:38:05 +00002163 if( pPager->state>=locktype ){
2164 rc = SQLITE_OK;
2165 }else{
drhbefdf832008-03-14 19:33:05 +00002166 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002167 do {
drh054889e2005-11-30 03:20:31 +00002168 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002169 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002170 if( rc==SQLITE_OK ){
2171 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002172 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002173 }
2174 }
2175 return rc;
2176}
2177
2178/*
drhf7c57532003-04-25 13:22:51 +00002179** Truncate the file to the number of pages specified.
2180*/
danielk19773b8a05f2007-03-19 17:44:26 +00002181int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
danielk19778c0a7912008-08-20 14:49:23 +00002182 int rc = SQLITE_OK;
danielk1977b3175382008-10-17 18:51:52 +00002183 assert( pPager->state>=PAGER_SHARED );
danielk19778c0a7912008-08-20 14:49:23 +00002184
danielk1977ad0132d2008-06-07 08:58:22 +00002185 sqlite3PagerPagecount(pPager, 0);
danielk1977efaaf572006-01-16 11:29:19 +00002186 if( pPager->errCode ){
2187 rc = pPager->errCode;
danielk1977d92db532008-11-17 04:56:24 +00002188 }else if( nPage<pPager->dbSize ){
danielk1977b3175382008-10-17 18:51:52 +00002189 rc = syncJournal(pPager);
2190 if( rc==SQLITE_OK ){
2191 /* Get an exclusive lock on the database before truncating. */
2192 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2193 }
2194 if( rc==SQLITE_OK ){
2195 rc = pager_truncate(pPager, nPage);
danielk19778c0a7912008-08-20 14:49:23 +00002196 }
danielk1977369f27e2004-06-15 11:40:04 +00002197 }
danielk197717221812005-02-15 03:38:05 +00002198
drhf7c57532003-04-25 13:22:51 +00002199 return rc;
2200}
2201
2202/*
drhed7c8552001-04-11 14:29:21 +00002203** Shutdown the page cache. Free all memory and close all files.
2204**
2205** If a transaction was in progress when this routine is called, that
2206** transaction is rolled back. All outstanding pages are invalidated
2207** and their memory is freed. Any attempt to use a page associated
2208** with this page cache after this function returns will likely
2209** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002210**
2211** This function always succeeds. If a transaction is active an attempt
2212** is made to roll it back. If an error occurs during the rollback
2213** a hot journal may be left in the filesystem but no error is returned
2214** to the caller.
drhed7c8552001-04-11 14:29:21 +00002215*/
danielk19773b8a05f2007-03-19 17:44:26 +00002216int sqlite3PagerClose(Pager *pPager){
danielk197713f72992005-12-18 08:51:22 +00002217
drhbafda092007-01-03 23:36:22 +00002218 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002219 sqlite3BeginBenignMalloc();
drhc2ee76c2007-01-04 14:58:14 +00002220 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002221 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002222 pager_reset(pPager);
danielk1977b3175382008-10-17 18:51:52 +00002223 if( !MEMDB ){
2224 pagerUnlockAndRollback(pPager);
2225 }
drhbafda092007-01-03 23:36:22 +00002226 enable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002227 sqlite3EndBenignMalloc();
drh4f0c5872007-03-26 22:05:01 +00002228 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002229 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002230 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002231 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002232 }
drhf5e7bb52008-02-18 14:47:33 +00002233 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977a1fa00d2008-08-27 15:16:33 +00002234 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
danielk1977e94ddc92005-03-21 03:53:38 +00002235 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002236 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002237 }
danielk1977b4b47412007-08-17 15:53:36 +00002238 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002239 /* Temp files are automatically deleted by the OS
2240 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002241 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002242 ** }
2243 */
danielk1977aca790a2005-01-13 11:07:52 +00002244
drhfacf0302008-06-17 15:12:00 +00002245 sqlite3PageFree(pPager->pTmpSpace);
danielk19778c0a7912008-08-20 14:49:23 +00002246 sqlite3PcacheClose(pPager->pPCache);
drh17435752007-08-16 04:30:38 +00002247 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002248 return SQLITE_OK;
2249}
2250
drh87cc3b32007-05-08 21:45:27 +00002251#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002252/*
drh5e00f6c2001-09-13 13:46:56 +00002253** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002254*/
danielk19773b8a05f2007-03-19 17:44:26 +00002255Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002256 return p->pgno;
2257}
drh87cc3b32007-05-08 21:45:27 +00002258#endif
drhed7c8552001-04-11 14:29:21 +00002259
2260/*
drhdf0b3b02001-06-23 11:36:20 +00002261** Increment the reference count for a page. The input pointer is
2262** a reference to the page data.
2263*/
danielk19773b8a05f2007-03-19 17:44:26 +00002264int sqlite3PagerRef(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002265 sqlite3PcacheRef(pPg);
drh8c42ca92001-06-22 19:15:00 +00002266 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002267}
2268
2269/*
drh34e79ce2004-02-08 06:05:46 +00002270** Sync the journal. In other words, make sure all the pages that have
2271** been written to the journal have actually reached the surface of the
2272** disk. It is not safe to modify the original database file until after
2273** the journal has been synced. If the original database is modified before
2274** the journal is synced and a power failure occurs, the unsynced journal
2275** data would be lost and we would be unable to completely rollback the
2276** database changes. Database corruption would occur.
2277**
2278** This routine also updates the nRec field in the header of the journal.
2279** (See comments on the pager_playback() routine for additional information.)
2280** If the sync mode is FULL, two syncs will occur. First the whole journal
2281** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002282**
drh34e79ce2004-02-08 06:05:46 +00002283** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002284** after a power failure, so no sync occurs.
2285**
2286** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2287** the database is stored, then OsSync() is never called on the journal
2288** file. In this case all that is required is to update the nRec field in
2289** the journal header.
drhfa86c412002-02-02 15:01:15 +00002290**
drh34e79ce2004-02-08 06:05:46 +00002291** This routine clears the needSync field of every page current held in
2292** memory.
drh50e5dad2001-09-15 00:57:28 +00002293*/
danielk197776572402004-06-25 02:38:54 +00002294static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002295 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002296
2297 /* Sync the journal before modifying the main database
2298 ** (assuming there is a journal and it needs to be synced.)
2299 */
danielk197776572402004-06-25 02:38:54 +00002300 if( pPager->needSync ){
danielk1977b3175382008-10-17 18:51:52 +00002301 assert( !pPager->tempFile );
2302 if( pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
danielk19774cd2cd52007-08-23 14:48:23 +00002303 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002304 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002305
danielk19774cd2cd52007-08-23 14:48:23 +00002306 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002307 /* Write the nRec value into the journal file header. If in
2308 ** full-synchronous mode, sync the journal first. This ensures that
2309 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002310 ** it as a candidate for rollback.
2311 **
2312 ** This is not required if the persistent media supports the
2313 ** SAFE_APPEND property. Because in this case it is not possible
2314 ** for garbage data to be appended to the file, the nRec field
2315 ** is populated with 0xFFFFFFFF when the journal header is written
2316 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002317 */
danielk19774cd2cd52007-08-23 14:48:23 +00002318 i64 jrnlOff;
2319 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002320 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002321 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002322 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002323 if( rc!=0 ) return rc;
2324 }
danielk197713adf8a2004-06-03 16:08:41 +00002325
danielk197762079062007-08-15 17:08:46 +00002326 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2327 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2328 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002329 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002330 }
danielk19774cd2cd52007-08-23 14:48:23 +00002331 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2332 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2333 IOTRACE(("JSYNC %p\n", pPager))
2334 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2335 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2336 );
2337 if( rc!=0 ) return rc;
2338 }
drhdb48ee02003-01-16 13:42:43 +00002339 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002340 }
drh50e5dad2001-09-15 00:57:28 +00002341 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002342
2343 /* Erase the needSync flag from every page.
2344 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00002345 sqlite3PcacheClearSyncFlags(pPager->pPCache);
drh50e5dad2001-09-15 00:57:28 +00002346 }
drh03eb96a2002-11-10 23:32:56 +00002347
drh81a20f22001-10-12 17:30:04 +00002348 return rc;
drh50e5dad2001-09-15 00:57:28 +00002349}
2350
2351/*
drh2554f8b2003-01-22 01:26:44 +00002352** Given a list of pages (connected by the PgHdr.pDirty pointer) write
danielk1977a858aa22008-08-22 16:22:17 +00002353** every one of those pages out to the database file. No calls are made
2354** to the page-cache to mark the pages as clean. It is the responsibility
2355** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark
2356** the pages as clean.
drh2554f8b2003-01-22 01:26:44 +00002357*/
2358static int pager_write_pagelist(PgHdr *pList){
2359 Pager *pPager;
2360 int rc;
2361
2362 if( pList==0 ) return SQLITE_OK;
2363 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002364
2365 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2366 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002367 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002368 **
drha6abd042004-06-09 17:37:22 +00002369 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2370 ** through an intermediate state PENDING. A PENDING lock prevents new
2371 ** readers from attaching to the database but is unsufficient for us to
2372 ** write. The idea of a PENDING lock is to prevent new readers from
2373 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002374 **
drha6abd042004-06-09 17:37:22 +00002375 ** While the pager is in the RESERVED state, the original database file
2376 ** is unchanged and we can rollback without having to playback the
2377 ** journal into the original database file. Once we transition to
2378 ** EXCLUSIVE, it means the database file has been changed and any rollback
2379 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002380 */
drh684917c2004-10-05 02:41:42 +00002381 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002382 if( rc!=SQLITE_OK ){
2383 return rc;
2384 }
2385
drh2554f8b2003-01-22 01:26:44 +00002386 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002387
2388 /* If the file has not yet been opened, open it now. */
2389 if( !pPager->fd->pMethods ){
2390 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00002391 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002392 if( rc ) return rc;
2393 }
2394
danielk1977687566d2004-11-02 12:56:41 +00002395 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002396 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002397 ** make the file smaller (presumably by auto-vacuum code). Do not write
2398 ** any such pages to the file.
2399 */
danielk197733e32162008-08-23 18:53:08 +00002400 if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
danielk197762079062007-08-15 17:08:46 +00002401 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002402 char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00002403 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2404 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002405 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002406 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002407 PAGER_INCR(sqlite3_pager_writedb_count);
2408 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002409 if( pList->pgno==1 ){
2410 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2411 }
danielk1977687566d2004-11-02 12:56:41 +00002412 }
2413#ifndef NDEBUG
2414 else{
drh4f0c5872007-03-26 22:05:01 +00002415 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002416 }
2417#endif
drh2554f8b2003-01-22 01:26:44 +00002418 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002419#ifdef SQLITE_CHECK_PAGES
2420 pList->pageHash = pager_pagehash(pList);
2421#endif
drh2554f8b2003-01-22 01:26:44 +00002422 pList = pList->pDirty;
2423 }
danielk19778c0a7912008-08-20 14:49:23 +00002424
drh2554f8b2003-01-22 01:26:44 +00002425 return SQLITE_OK;
2426}
2427
2428/*
danielk19778c0a7912008-08-20 14:49:23 +00002429** This function is called by the pcache layer when it has reached some
2430** soft memory limit. The argument is a pointer to a purgeable Pager
2431** object. This function attempts to make a single dirty page that has no
2432** outstanding references (if one exists) clean so that it can be recycled
2433** by the pcache layer.
drh2554f8b2003-01-22 01:26:44 +00002434*/
danielk1977a858aa22008-08-22 16:22:17 +00002435static int pagerStress(void *p, PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002436 Pager *pPager = (Pager *)p;
danielk19778c0a7912008-08-20 14:49:23 +00002437 int rc = SQLITE_OK;
drh8f2e9a12008-02-26 14:46:04 +00002438
danielk19778c200142008-08-25 07:12:28 +00002439 if( pPager->doNotSync ){
2440 return SQLITE_OK;
2441 }
2442
danielk1977a858aa22008-08-22 16:22:17 +00002443 assert( pPg->flags&PGHDR_DIRTY );
2444 if( pPager->errCode==SQLITE_OK ){
2445 if( pPg->flags&PGHDR_NEED_SYNC ){
2446 rc = syncJournal(pPager);
2447 if( rc==SQLITE_OK && pPager->fullSync &&
danielk1977b3175382008-10-17 18:51:52 +00002448 !(pPager->journalMode==PAGER_JOURNALMODE_MEMORY) &&
danielk1977a858aa22008-08-22 16:22:17 +00002449 !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
2450 ){
2451 pPager->nRec = 0;
2452 rc = writeJournalHdr(pPager);
danielk19778c0a7912008-08-20 14:49:23 +00002453 }
danielk19778c0a7912008-08-20 14:49:23 +00002454 }
danielk1977a858aa22008-08-22 16:22:17 +00002455 if( rc==SQLITE_OK ){
2456 pPg->pDirty = 0;
2457 rc = pager_write_pagelist(pPg);
2458 }
2459 if( rc!=SQLITE_OK ){
2460 pager_error(pPager, rc);
2461 }
2462 }
2463
2464 if( rc==SQLITE_OK ){
2465 sqlite3PcacheMakeClean(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00002466 }
2467 return rc;
drh2554f8b2003-01-22 01:26:44 +00002468}
2469
danielk19778c0a7912008-08-20 14:49:23 +00002470
drh2554f8b2003-01-22 01:26:44 +00002471/*
drh19db9352008-03-27 22:42:51 +00002472** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00002473** A hot journal is one that needs to be played back.
2474**
2475** If the current size of the database file is 0 but a journal file
2476** exists, that is probably an old journal left over from a prior
2477** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00002478**
2479** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00002480**
2481** This routine does not open the journal file to examine its
2482** content. Hence, the journal might contain the name of a master
2483** journal file that has been deleted, and hence not be hot. Or
2484** the header of the journal might be zeroed out. This routine
2485** does not discover these cases of a non-hot journal - if the
2486** journal file exists and is not empty this routine assumes it
2487** is hot. The pager_playback() routine will discover that the
2488** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00002489*/
danielk1977d300b8a2008-08-01 10:50:23 +00002490static int hasHotJournal(Pager *pPager, int *pExists){
danielk1977b4b47412007-08-17 15:53:36 +00002491 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977d300b8a2008-08-01 10:50:23 +00002492 int rc = SQLITE_OK;
drh0a846f92008-08-25 17:23:29 +00002493 int exists;
2494 int locked;
2495 assert( pPager!=0 );
2496 assert( pPager->useJournal );
2497 assert( pPager->fd->pMethods );
danielk1977d300b8a2008-08-01 10:50:23 +00002498 *pExists = 0;
drh0a846f92008-08-25 17:23:29 +00002499 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
2500 if( rc==SQLITE_OK && exists ){
2501 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
2502 }
2503 if( rc==SQLITE_OK && exists && !locked ){
2504 int nPage;
2505 rc = sqlite3PagerPagecount(pPager, &nPage);
2506 if( rc==SQLITE_OK ){
2507 if( nPage==0 ){
2508 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2509 }else{
2510 *pExists = 1;
danielk1977861f7452008-06-05 11:39:11 +00002511 }
2512 }
drhbb5f18d2007-04-06 18:23:17 +00002513 }
danielk1977d300b8a2008-08-01 10:50:23 +00002514 return rc;
drh165ffe92005-03-15 17:09:30 +00002515}
2516
2517/*
danielk1977e180dd92007-04-05 17:15:52 +00002518** Read the content of page pPg out of the database file.
2519*/
2520static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2521 int rc;
danielk197762079062007-08-15 17:08:46 +00002522 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002523 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002524 assert(pPager->fd->pMethods||pPager->tempFile);
2525 if( !pPager->fd->pMethods ){
2526 return SQLITE_IOERR_SHORT_READ;
2527 }
danielk197762079062007-08-15 17:08:46 +00002528 offset = (pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002529 rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002530 PAGER_INCR(sqlite3_pager_readdb_count);
2531 PAGER_INCR(pPager->nRead);
2532 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002533 if( pgno==1 ){
danielk19778c0a7912008-08-20 14:49:23 +00002534 memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24],
drh86a88112007-04-16 15:02:19 +00002535 sizeof(pPager->dbFileVers));
2536 }
danielk197730849522008-08-21 04:35:18 +00002537 CODEC1(pPager, pPg->pData, pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002538 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2539 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002540 return rc;
2541}
2542
2543
2544/*
danielk1977e277be02007-03-23 18:12:06 +00002545** This function is called to obtain the shared lock required before
2546** data may be read from the pager cache. If the shared lock has already
2547** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002548**
2549** Immediately after obtaining the shared lock (if required), this function
2550** checks for a hot-journal file. If one is found, an emergency rollback
2551** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002552*/
2553static int pagerSharedLock(Pager *pPager){
2554 int rc = SQLITE_OK;
danielk1977d300b8a2008-08-01 10:50:23 +00002555 int isErrorReset = 0;
danielk1977e277be02007-03-23 18:12:06 +00002556
danielk1977ae72d982007-10-03 08:46:44 +00002557 /* If this database is opened for exclusive access, has no outstanding
2558 ** page references and is in an error-state, now is the chance to clear
2559 ** the error. Discard the contents of the pager-cache and treat any
2560 ** open journal file as a hot-journal.
2561 */
danielk19778c0a7912008-08-20 14:49:23 +00002562 if( !MEMDB && pPager->exclusiveMode
2563 && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode
2564 ){
danielk1977ae72d982007-10-03 08:46:44 +00002565 if( pPager->journalOpen ){
danielk1977d300b8a2008-08-01 10:50:23 +00002566 isErrorReset = 1;
danielk1977ae72d982007-10-03 08:46:44 +00002567 }
danielk1977ae72d982007-10-03 08:46:44 +00002568 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00002569 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00002570 }
2571
2572 /* If the pager is still in an error state, do not proceed. The error
2573 ** state will be cleared at some point in the future when all page
2574 ** references are dropped and the cache can be discarded.
2575 */
2576 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2577 return pPager->errCode;
2578 }
2579
danielk1977d300b8a2008-08-01 10:50:23 +00002580 if( pPager->state==PAGER_UNLOCK || isErrorReset ){
danielk1977b4b47412007-08-17 15:53:36 +00002581 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977b3175382008-10-17 18:51:52 +00002582 int isHotJournal;
shane049fc212008-10-22 16:26:47 +00002583 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00002584 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
2585 if( !pPager->noReadlock ){
2586 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2587 if( rc!=SQLITE_OK ){
2588 assert( pPager->state==PAGER_UNLOCK );
2589 return pager_error(pPager, rc);
danielk1977e277be02007-03-23 18:12:06 +00002590 }
danielk1977b3175382008-10-17 18:51:52 +00002591 assert( pPager->state>=SHARED_LOCK );
2592 }
2593
2594 /* If a journal file exists, and there is no RESERVED lock on the
2595 ** database file, then it either needs to be played back or deleted.
2596 */
2597 if( !isErrorReset ){
2598 rc = hasHotJournal(pPager, &isHotJournal);
2599 if( rc!=SQLITE_OK ){
2600 goto failed;
2601 }
2602 }
2603 if( isErrorReset || isHotJournal ){
2604 /* Get an EXCLUSIVE lock on the database file. At this point it is
2605 ** important that a RESERVED lock is not obtained on the way to the
2606 ** EXCLUSIVE lock. If it were, another process might open the
2607 ** database file, detect the RESERVED lock, and conclude that the
2608 ** database is safe to read while this process is still rolling it
2609 ** back.
2610 **
2611 ** Because the intermediate RESERVED lock is not requested, the
2612 ** second process will get to this point in the code and fail to
2613 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00002614 */
danielk1977b3175382008-10-17 18:51:52 +00002615 if( pPager->state<EXCLUSIVE_LOCK ){
2616 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
danielk1977e277be02007-03-23 18:12:06 +00002617 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002618 rc = pager_error(pPager, rc);
2619 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002620 }
danielk1977b3175382008-10-17 18:51:52 +00002621 pPager->state = PAGER_EXCLUSIVE;
2622 }
2623
2624 /* Open the journal for read/write access. This is because in
2625 ** exclusive-access mode the file descriptor will be kept open and
2626 ** possibly used for a transaction later on. On some systems, the
2627 ** OsTruncate() call used in exclusive-access mode also requires
2628 ** a read/write file handle.
2629 */
2630 if( !isErrorReset && pPager->journalOpen==0 ){
2631 int res;
2632 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
2633 if( rc==SQLITE_OK ){
2634 if( res ){
2635 int fout = 0;
2636 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
2637 assert( !pPager->tempFile );
2638 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
2639 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk1977281d8bd2008-10-29 07:01:56 +00002640 if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
2641 rc = SQLITE_CANTOPEN;
danielk1977b3175382008-10-17 18:51:52 +00002642 sqlite3OsClose(pPager->jfd);
2643 }
2644 }else{
2645 /* If the journal does not exist, that means some other process
2646 ** has already rolled it back */
2647 rc = SQLITE_BUSY;
2648 }
2649 }
2650 }
2651 if( rc!=SQLITE_OK ){
danielk1977b3175382008-10-17 18:51:52 +00002652 goto failed;
2653 }
2654 pPager->journalOpen = 1;
2655 pPager->journalStarted = 0;
2656 pPager->journalOff = 0;
2657 pPager->setMaster = 0;
2658 pPager->journalHdr = 0;
2659
2660 /* Playback and delete the journal. Drop the database write
2661 ** lock and reacquire the read lock.
2662 */
2663 rc = pager_playback(pPager, 1);
2664 if( rc!=SQLITE_OK ){
2665 rc = pager_error(pPager, rc);
2666 goto failed;
2667 }
2668 assert(pPager->state==PAGER_SHARED ||
2669 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2670 );
2671 }
2672
2673 if( sqlite3PcachePagecount(pPager->pPCache)>0 ){
2674 /* The shared-lock has just been acquired on the database file
2675 ** and there are already pages in the cache (from a previous
2676 ** read or write transaction). Check to see if the database
2677 ** has been modified. If the database has changed, flush the
2678 ** cache.
2679 **
2680 ** Database changes is detected by looking at 15 bytes beginning
2681 ** at offset 24 into the file. The first 4 of these 16 bytes are
2682 ** a 32-bit counter that is incremented with each change. The
2683 ** other bytes change randomly with each file change when
2684 ** a codec is in use.
2685 **
2686 ** There is a vanishingly small chance that a change will not be
2687 ** detected. The chance of an undetected change is so small that
2688 ** it can be neglected.
2689 */
2690 char dbFileVers[sizeof(pPager->dbFileVers)];
2691 sqlite3PagerPagecount(pPager, 0);
2692
2693 if( pPager->errCode ){
2694 rc = pPager->errCode;
2695 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002696 }
2697
danielk1977d92db532008-11-17 04:56:24 +00002698 assert( pPager->dbSizeValid );
danielk1977b3175382008-10-17 18:51:52 +00002699 if( pPager->dbSize>0 ){
2700 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
2701 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
2702 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002703 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002704 }
danielk1977b3175382008-10-17 18:51:52 +00002705 }else{
2706 memset(dbFileVers, 0, sizeof(dbFileVers));
2707 }
danielk1977e277be02007-03-23 18:12:06 +00002708
danielk1977b3175382008-10-17 18:51:52 +00002709 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
2710 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002711 }
2712 }
danielk1977c5859712007-03-26 12:26:27 +00002713 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2714 if( pPager->state==PAGER_UNLOCK ){
2715 pPager->state = PAGER_SHARED;
2716 }
danielk1977e277be02007-03-23 18:12:06 +00002717 }
2718
danielk197752b472a2008-05-05 16:23:55 +00002719 failed:
2720 if( rc!=SQLITE_OK ){
2721 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
2722 pager_unlock(pPager);
2723 }
danielk1977e277be02007-03-23 18:12:06 +00002724 return rc;
2725}
2726
2727/*
drhd33d5a82007-04-26 12:11:28 +00002728** Make sure we have the content for a page. If the page was
2729** previously acquired with noContent==1, then the content was
2730** just initialized to zeros instead of being read from disk.
2731** But now we need the real data off of disk. So make sure we
2732** have it. Read it in if we do not have it already.
2733*/
2734static int pager_get_content(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002735 if( pPg->flags&PGHDR_NEED_READ ){
drhd33d5a82007-04-26 12:11:28 +00002736 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
2737 if( rc==SQLITE_OK ){
danielk19778c0a7912008-08-20 14:49:23 +00002738 pPg->flags &= ~PGHDR_NEED_READ;
drhd33d5a82007-04-26 12:11:28 +00002739 }else{
2740 return rc;
2741 }
2742 }
2743 return SQLITE_OK;
2744}
2745
2746/*
danielk19778c0a7912008-08-20 14:49:23 +00002747** If the reference count has reached zero, and the pager is not in the
2748** middle of a write transaction or opened in exclusive mode, unlock it.
2749*/
2750static void pagerUnlockIfUnused(Pager *pPager){
2751 if( (sqlite3PcacheRefCount(pPager->pPCache)==0)
2752 && (!pPager->exclusiveMode || pPager->journalOff>0)
2753 ){
2754 pagerUnlockAndRollback(pPager);
2755 }
2756}
2757
2758/*
2759** Drop a page from the cache using sqlite3PcacheDrop().
2760**
2761** If this means there are now no pages with references to them, a rollback
2762** occurs and the lock on the database is removed.
2763*/
2764static void pagerDropPage(DbPage *pPg){
2765 Pager *pPager = pPg->pPager;
2766 sqlite3PcacheDrop(pPg);
2767 pagerUnlockIfUnused(pPager);
2768}
2769
2770/*
drhd9b02572001-04-15 00:37:09 +00002771** Acquire a page.
2772**
drh58a11682001-11-10 13:51:08 +00002773** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002774** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002775**
drhd33d5a82007-04-26 12:11:28 +00002776** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00002777** file is smaller than the requested page, then no actual disk
2778** read occurs and the memory image of the page is initialized to
2779** all zeros. The extra data appended to a page is always initialized
2780** to zeros the first time a page is loaded into memory.
2781**
drhd9b02572001-04-15 00:37:09 +00002782** The acquisition might fail for several reasons. In all cases,
2783** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002784**
drhd33d5a82007-04-26 12:11:28 +00002785** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002786** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00002787** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00002788** just returns 0. This routine acquires a read-lock the first time it
2789** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00002790** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00002791** or journal files.
drh0787db62007-03-04 13:15:27 +00002792**
drh538f5702007-04-13 02:14:30 +00002793** If noContent is false, the page contents are actually read from disk.
2794** If noContent is true, it means that we do not care about the contents
2795** of the page at this time, so do not do a disk read. Just fill in the
2796** page content with zeros. But mark the fact that we have not read the
2797** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00002798** sqlite3PagerWrite() is called on this page or if this routine is
2799** called again with noContent==0, that means that the content is needed
2800** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002801*/
danielk197765e0ff32008-09-19 09:14:43 +00002802int sqlite3PagerAcquire(
drh538f5702007-04-13 02:14:30 +00002803 Pager *pPager, /* The pager open on the database file */
2804 Pgno pgno, /* Page number to fetch */
2805 DbPage **ppPage, /* Write a pointer to the page here */
2806 int noContent /* Do not bother reading content from disk if true */
2807){
danielk19778c0a7912008-08-20 14:49:23 +00002808 PgHdr *pPg = 0;
drh165ffe92005-03-15 17:09:30 +00002809 int rc;
drhed7c8552001-04-11 14:29:21 +00002810
danielk19778c0a7912008-08-20 14:49:23 +00002811 assert( pPager->state==PAGER_UNLOCK
2812 || sqlite3PcacheRefCount(pPager->pPCache)>0
danielk1977b3175382008-10-17 18:51:52 +00002813 || pgno==1
danielk19778c0a7912008-08-20 14:49:23 +00002814 );
danielk1977e277be02007-03-23 18:12:06 +00002815
danielk197726836652005-01-17 01:33:13 +00002816 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2817 ** number greater than this, or zero, is requested.
2818 */
drh267cb322005-09-16 17:16:52 +00002819 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002820 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002821 }
2822
drhd9b02572001-04-15 00:37:09 +00002823 /* Make sure we have not hit any critical errors.
2824 */
drh836faa42003-01-11 13:30:57 +00002825 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002826 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002827
danielk197713adf8a2004-06-03 16:08:41 +00002828 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002829 ** on the database file. pagerSharedLock() is a no-op if
2830 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002831 */
danielk1977e277be02007-03-23 18:12:06 +00002832 rc = pagerSharedLock(pPager);
2833 if( rc!=SQLITE_OK ){
2834 return rc;
drhed7c8552001-04-11 14:29:21 +00002835 }
danielk1977e277be02007-03-23 18:12:06 +00002836 assert( pPager->state!=PAGER_UNLOCK );
2837
danielk19778c0a7912008-08-20 14:49:23 +00002838 rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg);
2839 if( rc!=SQLITE_OK ){
2840 return rc;
2841 }
danielk19778c0a7912008-08-20 14:49:23 +00002842 if( pPg->pPager==0 ){
2843 /* The pager cache has created a new page. Its content needs to
2844 ** be initialized.
2845 */
danielk1977979f38e2007-03-27 16:19:51 +00002846 int nMax;
drh538f5702007-04-13 02:14:30 +00002847 PAGER_INCR(pPager->nMiss);
danielk19778c0a7912008-08-20 14:49:23 +00002848 pPg->pPager = pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002849 memset(pPg->pExtra, 0, pPager->nExtra);
danielk197724168722007-04-02 05:07:47 +00002850
danielk1977ad0132d2008-06-07 08:58:22 +00002851 rc = sqlite3PagerPagecount(pPager, &nMax);
2852 if( rc!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002853 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00002854 return rc;
2855 }
danielk197775bab7d2006-01-23 13:09:45 +00002856
danielk1977a1fa00d2008-08-27 15:16:33 +00002857 if( nMax<(int)pgno || MEMDB || noContent ){
drhf8e632b2007-05-08 14:51:36 +00002858 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00002859 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00002860 return SQLITE_FULL;
2861 }
danielk19778c0a7912008-08-20 14:49:23 +00002862 memset(pPg->pData, 0, pPager->pageSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00002863 if( noContent ){
danielk19778c0a7912008-08-20 14:49:23 +00002864 pPg->flags |= PGHDR_NEED_READ;
2865 }
drh538f5702007-04-13 02:14:30 +00002866 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00002867 }else{
danielk1977e180dd92007-04-05 17:15:52 +00002868 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00002869 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
danielk19778c0a7912008-08-20 14:49:23 +00002870 /* sqlite3PagerUnref(pPg); */
2871 pagerDropPage(pPg);
drh551b7732006-11-06 21:20:25 +00002872 return rc;
drh81a20f22001-10-12 17:30:04 +00002873 }
drh306dc212001-05-21 13:45:10 +00002874 }
danielk19773c407372005-02-15 02:54:14 +00002875#ifdef SQLITE_CHECK_PAGES
2876 pPg->pageHash = pager_pagehash(pPg);
2877#endif
drhed7c8552001-04-11 14:29:21 +00002878 }else{
drhd9b02572001-04-15 00:37:09 +00002879 /* The requested page is in the page cache. */
danielk19778c0a7912008-08-20 14:49:23 +00002880 assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00002881 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00002882 if( !noContent ){
2883 rc = pager_get_content(pPg);
2884 if( rc ){
danielk19778c0a7912008-08-20 14:49:23 +00002885 sqlite3PagerUnref(pPg);
drhd33d5a82007-04-26 12:11:28 +00002886 return rc;
2887 }
2888 }
drhed7c8552001-04-11 14:29:21 +00002889 }
danielk19778c0a7912008-08-20 14:49:23 +00002890
danielk19773b8a05f2007-03-19 17:44:26 +00002891 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00002892 return SQLITE_OK;
2893}
danielk19778c0a7912008-08-20 14:49:23 +00002894
drhed7c8552001-04-11 14:29:21 +00002895/*
drh7e3b0a02001-04-28 16:52:40 +00002896** Acquire a page if it is already in the in-memory cache. Do
2897** not read the page from disk. Return a pointer to the page,
2898** or 0 if the page is not in cache.
2899**
danielk19773b8a05f2007-03-19 17:44:26 +00002900** See also sqlite3PagerGet(). The difference between this routine
2901** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002902** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002903** returns NULL if the page is not in cache or if a disk I/O error
2904** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002905*/
danielk19773b8a05f2007-03-19 17:44:26 +00002906DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00002907 PgHdr *pPg = 0;
drh836faa42003-01-11 13:30:57 +00002908 assert( pPager!=0 );
2909 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00002910
danielk19778c0a7912008-08-20 14:49:23 +00002911 if( (pPager->state!=PAGER_UNLOCK)
2912 && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL)
2913 ){
2914 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg);
danielk1977e277be02007-03-23 18:12:06 +00002915 }
danielk19778c0a7912008-08-20 14:49:23 +00002916
danielk19773b8a05f2007-03-19 17:44:26 +00002917 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00002918}
2919
2920/*
drhed7c8552001-04-11 14:29:21 +00002921** Release a page.
2922**
2923** If the number of references to the page drop to zero, then the
2924** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002925** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002926** removed.
2927*/
danielk19773b8a05f2007-03-19 17:44:26 +00002928int sqlite3PagerUnref(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002929 if( pPg ){
2930 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002931 sqlite3PcacheRelease(pPg);
2932 pagerUnlockIfUnused(pPager);
drhed7c8552001-04-11 14:29:21 +00002933 }
drhd9b02572001-04-15 00:37:09 +00002934 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002935}
2936
2937/*
drha6abd042004-06-09 17:37:22 +00002938** Create a journal file for pPager. There should already be a RESERVED
2939** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002940**
2941** Return SQLITE_OK if everything. Return an error code and release the
2942** write lock if anything goes wrong.
2943*/
2944static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00002945 sqlite3_vfs *pVfs = pPager->pVfs;
2946 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
2947
drhda47d772002-12-02 04:25:19 +00002948 int rc;
drha6abd042004-06-09 17:37:22 +00002949 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002950 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00002951 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00002952 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00002953 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00002954 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002955 rc = SQLITE_NOMEM;
2956 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002957 }
danielk1977b4b47412007-08-17 15:53:36 +00002958
drhfdc40e92008-04-17 20:59:37 +00002959 if( pPager->journalOpen==0 ){
2960 if( pPager->tempFile ){
2961 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
2962 }else{
2963 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00002964 }
danielk1977b3175382008-10-17 18:51:52 +00002965 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
2966 sqlite3MemJournalOpen(pPager->jfd);
2967 rc = SQLITE_OK;
2968 }else{
drhfdc40e92008-04-17 20:59:37 +00002969#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977b3175382008-10-17 18:51:52 +00002970 rc = sqlite3JournalOpen(
2971 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
2972 );
drhfdc40e92008-04-17 20:59:37 +00002973#else
danielk1977b3175382008-10-17 18:51:52 +00002974 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
drhfdc40e92008-04-17 20:59:37 +00002975#endif
danielk1977b3175382008-10-17 18:51:52 +00002976 }
drhfdc40e92008-04-17 20:59:37 +00002977 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
2978 pPager->journalOff = 0;
2979 pPager->setMaster = 0;
2980 pPager->journalHdr = 0;
2981 if( rc!=SQLITE_OK ){
2982 if( rc==SQLITE_NOMEM ){
2983 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2984 }
2985 goto failed_to_open_journal;
2986 }
drhda47d772002-12-02 04:25:19 +00002987 }
2988 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002989 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002990 pPager->needSync = 0;
drh968af522003-02-11 14:55:40 +00002991 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00002992 if( pPager->errCode ){
2993 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00002994 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00002995 }
drhda47d772002-12-02 04:25:19 +00002996 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002997
danielk197776572402004-06-25 02:38:54 +00002998 rc = writeJournalHdr(pPager);
2999
drhac69b052004-05-12 13:30:07 +00003000 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003001 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003002 }
danielk1977ae72d982007-10-03 08:46:44 +00003003 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003004 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003005 if( rc==SQLITE_OK ){
3006 rc = SQLITE_FULL;
3007 }
3008 }
drh9c105bb2004-10-02 20:38:28 +00003009 return rc;
3010
3011failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003012 sqlite3BitvecDestroy(pPager->pInJournal);
3013 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003014 return rc;
drhda47d772002-12-02 04:25:19 +00003015}
3016
3017/*
drh4b845d72002-03-05 12:41:19 +00003018** Acquire a write-lock on the database. The lock is removed when
3019** the any of the following happen:
3020**
drh80e35f42007-03-30 14:06:34 +00003021** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003022** * sqlite3PagerRollback() is called.
3023** * sqlite3PagerClose() is called.
3024** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003025**
danielk197713adf8a2004-06-03 16:08:41 +00003026** The first parameter to this routine is a pointer to any open page of the
3027** database file. Nothing changes about the page - it is used merely to
3028** acquire a pointer to the Pager structure and as proof that there is
3029** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003030**
danielk197713adf8a2004-06-03 16:08:41 +00003031** The second parameter indicates how much space in bytes to reserve for a
3032** master journal file-name at the start of the journal when it is created.
3033**
3034** A journal file is opened if this is not a temporary file. For temporary
3035** files, the opening of the journal file is deferred until there is an
3036** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003037**
drha6abd042004-06-09 17:37:22 +00003038** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003039**
3040** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3041** immediately instead of waiting until we try to flush the cache. The
3042** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003043*/
danielk19773b8a05f2007-03-19 17:44:26 +00003044int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003045 Pager *pPager = pPg->pPager;
3046 int rc = SQLITE_OK;
3047 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003048 assert( pPager->state!=PAGER_UNLOCK );
3049 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003050 assert( pPager->pInJournal==0 );
danielk1977b3175382008-10-17 18:51:52 +00003051 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00003052 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
3053 if( rc==SQLITE_OK ){
3054 pPager->state = PAGER_RESERVED;
3055 if( exFlag ){
3056 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh684917c2004-10-05 02:41:42 +00003057 }
danielk1977b3175382008-10-17 18:51:52 +00003058 }
3059 if( rc!=SQLITE_OK ){
3060 return rc;
3061 }
3062 pPager->dirtyCache = 0;
3063 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
3064 if( pPager->useJournal && !pPager->tempFile
3065 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
3066 rc = pager_open_journal(pPager);
drh4b845d72002-03-05 12:41:19 +00003067 }
danielk1977334cdb62007-03-26 08:05:12 +00003068 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00003069 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00003070 ** time a (read or write) transaction was successfully concluded
3071 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00003072 ** kept open and either was truncated to 0 bytes or its header was
3073 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00003074 */
3075 assert( pPager->nRec==0 );
3076 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003077 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003078 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003079 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhf5e7bb52008-02-18 14:47:33 +00003080 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003081 rc = SQLITE_NOMEM;
3082 }else{
drh369339d2007-03-30 16:01:55 +00003083 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003084 rc = writeJournalHdr(pPager);
3085 }
drh4b845d72002-03-05 12:41:19 +00003086 }
danielk1977334cdb62007-03-26 08:05:12 +00003087 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003088 return rc;
3089}
3090
3091/*
drh605ad8f2006-05-03 23:34:05 +00003092** Make a page dirty. Set its dirty flag and add it to the dirty
3093** page list.
3094*/
3095static void makeDirty(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003096 sqlite3PcacheMakeDirty(pPg);
drh605ad8f2006-05-03 23:34:05 +00003097}
3098
3099/*
3100** Make a page clean. Clear its dirty bit and remove it from the
3101** dirty page list.
3102*/
3103static void makeClean(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003104 sqlite3PcacheMakeClean(pPg);
drh605ad8f2006-05-03 23:34:05 +00003105}
3106
3107
3108/*
drhed7c8552001-04-11 14:29:21 +00003109** Mark a data page as writeable. The page is written into the journal
3110** if it is not there already. This routine must be called before making
3111** changes to a page.
3112**
3113** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003114** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003115** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003116** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003117** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003118**
3119** If the journal file could not be written because the disk is full,
3120** then this routine returns SQLITE_FULL and does an immediate rollback.
3121** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003122** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003123** reset.
drhed7c8552001-04-11 14:29:21 +00003124*/
danielk19773b8a05f2007-03-19 17:44:26 +00003125static int pager_write(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003126 void *pData = pPg->pData;
drh69688d52001-04-14 16:38:23 +00003127 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003128 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003129
drh6446c4d2001-12-15 14:22:18 +00003130 /* Check for errors
3131 */
danielk1977efaaf572006-01-16 11:29:19 +00003132 if( pPager->errCode ){
3133 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003134 }
drh5e00f6c2001-09-13 13:46:56 +00003135 if( pPager->readOnly ){
3136 return SQLITE_PERM;
3137 }
drh6446c4d2001-12-15 14:22:18 +00003138
danielk197776572402004-06-25 02:38:54 +00003139 assert( !pPager->setMaster );
3140
danielk19773c407372005-02-15 02:54:14 +00003141 CHECK_PAGE(pPg);
3142
drh538f5702007-04-13 02:14:30 +00003143 /* If this page was previously acquired with noContent==1, that means
3144 ** we didn't really read in the content of the page. This can happen
3145 ** (for example) when the page is being moved to the freelist. But
3146 ** now we are (perhaps) moving the page off of the freelist for
3147 ** reuse and we need to know its original content so that content
3148 ** can be stored in the rollback journal. So do the read at this
3149 ** time.
3150 */
drhd33d5a82007-04-26 12:11:28 +00003151 rc = pager_get_content(pPg);
3152 if( rc ){
3153 return rc;
drh538f5702007-04-13 02:14:30 +00003154 }
3155
drh6446c4d2001-12-15 14:22:18 +00003156 /* Mark the page as dirty. If the page has already been written
3157 ** to the journal then we can return right away.
3158 */
drh605ad8f2006-05-03 23:34:05 +00003159 makeDirty(pPg);
danielk1977bc2ca9e2008-11-13 14:28:28 +00003160 if( pageInJournal(pPg) && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00003161 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003162 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003163 }else{
drh6446c4d2001-12-15 14:22:18 +00003164
danielk1977a0bf2652004-11-04 14:30:04 +00003165 /* If we get this far, it means that the page needs to be
3166 ** written to the transaction journal or the ckeckpoint journal
3167 ** or both.
3168 **
3169 ** First check to see that the transaction journal exists and
3170 ** create it if it does not.
3171 */
3172 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003173 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003174 if( rc!=SQLITE_OK ){
3175 return rc;
3176 }
3177 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00003178 if( !pPager->journalOpen && pPager->useJournal
3179 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00003180 rc = pager_open_journal(pPager);
3181 if( rc!=SQLITE_OK ) return rc;
3182 }
danielk1977a0bf2652004-11-04 14:30:04 +00003183 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003184 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003185
3186 /* The transaction journal now exists and we have a RESERVED or an
3187 ** EXCLUSIVE lock on the main database file. Write the current page to
3188 ** the transaction journal if it is not there already.
3189 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00003190 if( !pageInJournal(pPg) && pPager->journalOpen ){
danielk1977d92db532008-11-17 04:56:24 +00003191 if( pPg->pgno<=pPager->origDbSize ){
danielk1977b3175382008-10-17 18:51:52 +00003192 u32 cksum;
3193 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00003194
danielk1977b3175382008-10-17 18:51:52 +00003195 /* We should never write to the journal file the page that
3196 ** contains the database locks. The following assert verifies
3197 ** that we do not. */
3198 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
3199 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
3200 cksum = pager_cksum(pPager, (u8*)pData2);
3201 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
3202 if( rc==SQLITE_OK ){
3203 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
3204 pPager->journalOff + 4);
3205 pPager->journalOff += pPager->pageSize+4;
3206 }
3207 if( rc==SQLITE_OK ){
3208 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
3209 pPager->journalOff += 4;
3210 }
3211 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
3212 pPager->journalOff, pPager->pageSize));
3213 PAGER_INCR(sqlite3_pager_writej_count);
3214 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
3215 PAGERID(pPager), pPg->pgno,
3216 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00003217
danielk1977b3175382008-10-17 18:51:52 +00003218 /* An error has occured writing to the journal file. The
3219 ** transaction will be rolled back by the layer above.
3220 */
3221 if( rc!=SQLITE_OK ){
3222 return rc;
3223 }
danielk197707cb5602006-01-20 10:55:05 +00003224
danielk1977b3175382008-10-17 18:51:52 +00003225 pPager->nRec++;
3226 assert( pPager->pInJournal!=0 );
3227 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
3228 if( !pPager->noSync ){
3229 pPg->flags |= PGHDR_NEED_SYNC;
3230 }
3231 if( pPager->stmtInUse ){
3232 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003233 }
danielk197713adf8a2004-06-03 16:08:41 +00003234 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003235 if( !pPager->journalStarted && !pPager->noSync ){
3236 pPg->flags |= PGHDR_NEED_SYNC;
3237 }
drh4f0c5872007-03-26 22:05:01 +00003238 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk19778c0a7912008-08-20 14:49:23 +00003239 PAGERID(pPager), pPg->pgno,
3240 ((pPg->flags&PGHDR_NEED_SYNC)?1:0));
danielk1977a0bf2652004-11-04 14:30:04 +00003241 }
danielk19778c0a7912008-08-20 14:49:23 +00003242 if( pPg->flags&PGHDR_NEED_SYNC ){
danielk1977a0bf2652004-11-04 14:30:04 +00003243 pPager->needSync = 1;
3244 }
danielk1977a0bf2652004-11-04 14:30:04 +00003245 }
3246
3247 /* If the statement journal is open and the page is not in it,
3248 ** then write the current page to the statement journal. Note that
3249 ** the statement journal format differs from the standard journal format
3250 ** in that it omits the checksums and the header.
3251 */
danielk1977f35843b2007-04-07 15:03:17 +00003252 if( pPager->stmtInUse
3253 && !pageInStatement(pPg)
danielk1977d92db532008-11-17 04:56:24 +00003254 && pPg->pgno<=pPager->stmtSize
danielk1977f35843b2007-04-07 15:03:17 +00003255 ){
danielk1977b3175382008-10-17 18:51:52 +00003256 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
3257 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
danielk1977d92db532008-11-17 04:56:24 +00003258 assert( pageInJournal(pPg) || pPg->pgno>pPager->origDbSize );
danielk1977b3175382008-10-17 18:51:52 +00003259 rc = write32bits(pPager->stfd, offset, pPg->pgno);
3260 if( rc==SQLITE_OK ){
3261 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
drhdb48ee02003-01-16 13:42:43 +00003262 }
danielk1977b3175382008-10-17 18:51:52 +00003263 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
3264 if( rc!=SQLITE_OK ){
3265 return rc;
3266 }
3267 pPager->stmtNRec++;
3268 assert( pPager->pInStmt!=0 );
3269 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhd9b02572001-04-15 00:37:09 +00003270 }
drhfa86c412002-02-02 15:01:15 +00003271 }
3272
3273 /* Update the database size and return.
3274 */
drh1aa2d8b2007-01-03 15:34:29 +00003275 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003276 if( pPager->dbSize<pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003277 pPager->dbSize = pPg->pgno;
danielk1977d92db532008-11-17 04:56:24 +00003278 if( pPager->dbSize==(PAGER_MJ_PGNO(pPager)-1) ){
drh1f595712004-06-15 01:40:29 +00003279 pPager->dbSize++;
3280 }
drh306dc212001-05-21 13:45:10 +00003281 }
drh69688d52001-04-14 16:38:23 +00003282 return rc;
drhed7c8552001-04-11 14:29:21 +00003283}
3284
3285/*
danielk19774099f6e2007-03-19 11:25:20 +00003286** This function is used to mark a data-page as writable. It uses
3287** pager_write() to open a journal file (if it is not already open)
3288** and write the page *pData to the journal.
3289**
3290** The difference between this function and pager_write() is that this
3291** function also deals with the special case where 2 or more pages
3292** fit on a single disk sector. In this case all co-resident pages
3293** must have been written to the journal file before returning.
3294*/
danielk19773b8a05f2007-03-19 17:44:26 +00003295int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003296 int rc = SQLITE_OK;
3297
danielk19773b8a05f2007-03-19 17:44:26 +00003298 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003299 Pager *pPager = pPg->pPager;
3300 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3301
danielk1977b3175382008-10-17 18:51:52 +00003302 if( nPagePerSector>1 ){
danielk19774099f6e2007-03-19 11:25:20 +00003303 Pgno nPageCount; /* Total number of pages in database file */
3304 Pgno pg1; /* First page of the sector pPg is located on. */
3305 int nPage; /* Number of pages starting at pg1 to journal */
3306 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003307 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003308
3309 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3310 ** header to be written between the pages journaled by this function.
3311 */
danielk1977b3175382008-10-17 18:51:52 +00003312 assert( !MEMDB );
danielk19774099f6e2007-03-19 11:25:20 +00003313 assert( pPager->doNotSync==0 );
3314 pPager->doNotSync = 1;
3315
3316 /* This trick assumes that both the page-size and sector-size are
3317 ** an integer power of 2. It sets variable pg1 to the identifier
3318 ** of the first page of the sector pPg is located on.
3319 */
3320 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3321
danielk1977ad0132d2008-06-07 08:58:22 +00003322 sqlite3PagerPagecount(pPager, (int *)&nPageCount);
danielk19774099f6e2007-03-19 11:25:20 +00003323 if( pPg->pgno>nPageCount ){
3324 nPage = (pPg->pgno - pg1)+1;
3325 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3326 nPage = nPageCount+1-pg1;
3327 }else{
3328 nPage = nPagePerSector;
3329 }
3330 assert(nPage>0);
3331 assert(pg1<=pPg->pgno);
3332 assert((pg1+nPage)>pPg->pgno);
3333
3334 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3335 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003336 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00003337 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00003338 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003339 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003340 if( rc==SQLITE_OK ){
3341 rc = pager_write(pPage);
danielk19778c0a7912008-08-20 14:49:23 +00003342 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003343 needSync = 1;
3344 }
danielk19773b8a05f2007-03-19 17:44:26 +00003345 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003346 }
3347 }
drhc81945e2008-03-10 14:12:53 +00003348 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk19778c0a7912008-08-20 14:49:23 +00003349 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003350 needSync = 1;
3351 }
danielk19778c0a7912008-08-20 14:49:23 +00003352 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003353 }
3354 }
3355
danielk1977dd97a492007-08-22 18:54:32 +00003356 /* If the PgHdr.needSync flag is set for any of the nPage pages
3357 ** starting at pg1, then it needs to be set for all of them. Because
3358 ** writing to any of these nPage pages may damage the others, the
3359 ** journal file must contain sync()ed copies of all of them
3360 ** before any of them can be written out to the database file.
3361 */
3362 if( needSync ){
drhb3df2e12008-09-17 20:06:26 +00003363 assert( !MEMDB && pPager->noSync==0 );
danielk1977dd97a492007-08-22 18:54:32 +00003364 for(ii=0; ii<nPage && needSync; ii++){
3365 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
danielk19778c0a7912008-08-20 14:49:23 +00003366 if( pPage ) pPage->flags |= PGHDR_NEED_SYNC;
3367 sqlite3PagerUnref(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003368 }
3369 assert(pPager->needSync);
3370 }
3371
danielk19774099f6e2007-03-19 11:25:20 +00003372 assert( pPager->doNotSync==1 );
3373 pPager->doNotSync = 0;
3374 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003375 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003376 }
3377 return rc;
3378}
3379
3380/*
drhaacc5432002-01-06 17:07:40 +00003381** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003382** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003383** to change the content of the page.
3384*/
danielk19777d3a6662006-01-23 16:21:05 +00003385#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003386int sqlite3PagerIswriteable(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003387 return pPg->flags&PGHDR_DIRTY;
drh6019e162001-07-02 17:51:45 +00003388}
danielk19777d3a6662006-01-23 16:21:05 +00003389#endif
drh6019e162001-07-02 17:51:45 +00003390
drh001bbcb2003-03-19 03:14:00 +00003391/*
drh30e58752002-03-02 20:41:57 +00003392** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003393** write the information on page pPg back to the disk, even though
drhdfe88ec2008-11-03 20:55:06 +00003394** that page might be marked as dirty. This happens, for example, when
3395** the page has been added as a leaf of the freelist and so its
3396** content no longer matters.
drh30e58752002-03-02 20:41:57 +00003397**
3398** The overlying software layer calls this routine when all of the data
3399** on the given page is unused. The pager marks the page as clean so
3400** that it does not get written to disk.
3401**
3402** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003403** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003404** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003405**
3406** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003407** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003408** will thereafter be ignored. This is necessary to avoid a problem
3409** where a page with data is added to the freelist during one part of
3410** a transaction then removed from the freelist during a later part
3411** of the same transaction and reused for some other purpose. When it
3412** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003413** the sqlite3PagerDontRollback() routine is called. But because the
3414** page contains critical data, we still need to be sure it gets
3415** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003416*/
danielk1977a1fa00d2008-08-27 15:16:33 +00003417int sqlite3PagerDontWrite(DbPage *pDbPage){
drh538f5702007-04-13 02:14:30 +00003418 PgHdr *pPg = pDbPage;
3419 Pager *pPager = pPg->pPager;
danielk1977a1fa00d2008-08-27 15:16:33 +00003420 int rc;
drh8e298f92002-07-06 16:28:47 +00003421
danielk1977b3175382008-10-17 18:51:52 +00003422 if( pPg->pgno>pPager->origDbSize ){
danielk1977a1fa00d2008-08-27 15:16:33 +00003423 return SQLITE_OK;
3424 }
3425 if( pPager->pAlwaysRollback==0 ){
3426 assert( pPager->pInJournal );
3427 pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->origDbSize);
3428 if( !pPager->pAlwaysRollback ){
3429 return SQLITE_NOMEM;
3430 }
3431 }
3432 rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno);
3433
3434 if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00003435 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003436 if( pPager->dbSize==pPg->pgno && pPager->origDbSize<pPager->dbSize ){
drh8124a302002-06-25 14:43:57 +00003437 /* If this pages is the last page in the file and the file has grown
3438 ** during the current transaction, then do NOT mark the page as clean.
3439 ** When the database file grows, we must make sure that the last page
3440 ** gets written at least once so that the disk file will be the correct
3441 ** size. If you do not write this page and the size of the file
3442 ** on the disk ends up being too small, that can lead to database
3443 ** corruption during the next transaction.
3444 */
3445 }else{
drh538f5702007-04-13 02:14:30 +00003446 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3447 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
danielk197733e32162008-08-23 18:53:08 +00003448 pPg->flags |= PGHDR_DONT_WRITE;
danielk19773c407372005-02-15 02:54:14 +00003449#ifdef SQLITE_CHECK_PAGES
3450 pPg->pageHash = pager_pagehash(pPg);
3451#endif
drh8124a302002-06-25 14:43:57 +00003452 }
drh30e58752002-03-02 20:41:57 +00003453 }
danielk1977a1fa00d2008-08-27 15:16:33 +00003454 return rc;
drh30e58752002-03-02 20:41:57 +00003455}
3456
3457/*
3458** A call to this routine tells the pager that if a rollback occurs,
3459** it is not necessary to restore the data on the given page. This
3460** means that the pager does not have to record the given page in the
3461** rollback journal.
drh538f5702007-04-13 02:14:30 +00003462**
3463** If we have not yet actually read the content of this page (if
3464** the PgHdr.needRead flag is set) then this routine acts as a promise
3465** that we will never need to read the page content in the future.
3466** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003467*/
danielk19773b8a05f2007-03-19 17:44:26 +00003468void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003469 Pager *pPager = pPg->pPager;
3470
drhd3627af2006-12-18 18:34:51 +00003471 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00003472
3473 /* If the journal file is not open, or DontWrite() has been called on
3474 ** this page (DontWrite() sets the alwaysRollback flag), then this
3475 ** function is a no-op.
3476 */
danielk1977a1fa00d2008-08-27 15:16:33 +00003477 if( pPager->journalOpen==0
3478 || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno)
3479 || pPg->pgno>pPager->origDbSize
danielk19778c0a7912008-08-20 14:49:23 +00003480 ){
danielk197787c29a92008-01-18 11:33:16 +00003481 return;
3482 }
danielk1977a55e9352008-01-21 13:04:34 +00003483
drhc5d0bd92008-04-14 01:00:57 +00003484#ifdef SQLITE_SECURE_DELETE
danielk1977d92db532008-11-17 04:56:24 +00003485 if( (pPg->flags & PGHDR_IN_JOURNAL)!=0 || pPg->pgno>pPager->origDbSize ){
drhc5d0bd92008-04-14 01:00:57 +00003486 return;
3487 }
3488#endif
3489
3490 /* If SECURE_DELETE is disabled, then there is no way that this
3491 ** routine can be called on a page for which sqlite3PagerDontWrite()
3492 ** has not been previously called during the same transaction.
3493 ** And if DontWrite() has previously been called, the following
3494 ** conditions must be met.
drh10131482008-07-11 03:34:09 +00003495 **
3496 ** (Later:) Not true. If the database is corrupted by having duplicate
3497 ** pages on the freelist (ex: corrupt9.test) then the following is not
3498 ** necessarily true:
danielk1977a55e9352008-01-21 13:04:34 +00003499 */
drh10131482008-07-11 03:34:09 +00003500 /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ); */
danielk1977a55e9352008-01-21 13:04:34 +00003501
drhf5e7bb52008-02-18 14:47:33 +00003502 assert( pPager->pInJournal!=0 );
3503 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003504 pPg->flags &= ~PGHDR_NEED_READ;
danielk1977a55e9352008-01-21 13:04:34 +00003505 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00003506 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00003507 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00003508 }
danielk1977a55e9352008-01-21 13:04:34 +00003509 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
3510 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003511}
3512
drhac69b052004-05-12 13:30:07 +00003513
drh30e58752002-03-02 20:41:57 +00003514/*
drh80e35f42007-03-30 14:06:34 +00003515** This routine is called to increment the database file change-counter,
3516** stored at byte 24 of the pager file.
3517*/
danielk1977c7b60172007-08-22 11:22:03 +00003518static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00003519 PgHdr *pPgHdr;
3520 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00003521 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00003522
drh701bb3b2008-08-02 03:50:39 +00003523#ifndef SQLITE_ENABLE_ATOMIC_WRITE
3524 assert( isDirect==0 ); /* isDirect is only true for atomic writes */
3525#endif
drh80e35f42007-03-30 14:06:34 +00003526 if( !pPager->changeCountDone ){
3527 /* Open page 1 of the file for writing. */
3528 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3529 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00003530
3531 if( !isDirect ){
3532 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00003533 if( rc!=SQLITE_OK ){
3534 sqlite3PagerUnref(pPgHdr);
3535 return rc;
3536 }
danielk1977c7b60172007-08-22 11:22:03 +00003537 }
3538
drh80e35f42007-03-30 14:06:34 +00003539 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003540 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003541 change_counter++;
danielk19778c0a7912008-08-20 14:49:23 +00003542 put32bits(((char*)pPgHdr->pData)+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00003543
drh701bb3b2008-08-02 03:50:39 +00003544#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977c7b60172007-08-22 11:22:03 +00003545 if( isDirect && pPager->fd->pMethods ){
danielk19778c0a7912008-08-20 14:49:23 +00003546 const void *zBuf = pPgHdr->pData;
danielk1977c7b60172007-08-22 11:22:03 +00003547 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
3548 }
drh701bb3b2008-08-02 03:50:39 +00003549#endif
danielk1977c7b60172007-08-22 11:22:03 +00003550
drh80e35f42007-03-30 14:06:34 +00003551 /* Release the page reference. */
3552 sqlite3PagerUnref(pPgHdr);
3553 pPager->changeCountDone = 1;
3554 }
danielk1977c7b60172007-08-22 11:22:03 +00003555 return rc;
drh80e35f42007-03-30 14:06:34 +00003556}
3557
3558/*
danielk1977f653d782008-03-20 11:04:21 +00003559** Sync the pager file to disk.
3560*/
3561int sqlite3PagerSync(Pager *pPager){
3562 int rc;
drh7426f862008-08-26 21:07:26 +00003563 if( MEMDB ){
3564 rc = SQLITE_OK;
3565 }else{
3566 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
3567 }
danielk1977f653d782008-03-20 11:04:21 +00003568 return rc;
3569}
3570
3571/*
drh80e35f42007-03-30 14:06:34 +00003572** Sync the database file for the pager pPager. zMaster points to the name
3573** of a master journal file that should be written into the individual
3574** journal file. zMaster may be NULL, which is interpreted as no master
3575** journal (a single database transaction).
3576**
3577** This routine ensures that the journal is synced, all dirty pages written
3578** to the database file and the database file synced. The only thing that
3579** remains to commit the transaction is to delete the journal file (or
3580** master journal file if specified).
3581**
3582** Note that if zMaster==NULL, this does not overwrite a previous value
3583** passed to an sqlite3PagerCommitPhaseOne() call.
3584**
3585** If parameter nTrunc is non-zero, then the pager file is truncated to
3586** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00003587**
3588** If the final parameter - noSync - is true, then the database file itself
3589** is not synced. The caller must call sqlite3PagerSync() directly to
3590** sync the database file before calling CommitPhaseTwo() to delete the
3591** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00003592*/
danielk1977f653d782008-03-20 11:04:21 +00003593int sqlite3PagerCommitPhaseOne(
3594 Pager *pPager,
3595 const char *zMaster,
3596 Pgno nTrunc,
3597 int noSync
3598){
drh80e35f42007-03-30 14:06:34 +00003599 int rc = SQLITE_OK;
3600
danielk1977dad31b52008-05-15 11:08:07 +00003601 if( pPager->errCode ){
3602 return pPager->errCode;
3603 }
3604
drhd138c012008-05-13 00:58:18 +00003605 /* If no changes have been made, we can leave the transaction early.
3606 */
3607 if( pPager->dbModified==0 &&
3608 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3609 pPager->exclusiveMode!=0) ){
3610 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3611 return SQLITE_OK;
3612 }
3613
drh80e35f42007-03-30 14:06:34 +00003614 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3615 pPager->zFilename, zMaster, nTrunc);
3616
3617 /* If this is an in-memory db, or no pages have been written to, or this
3618 ** function has already been called, it is a no-op.
3619 */
3620 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3621 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00003622
danielk1977c7b60172007-08-22 11:22:03 +00003623#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3624 /* The atomic-write optimization can be used if all of the
3625 ** following are true:
3626 **
3627 ** + The file-system supports the atomic-write property for
3628 ** blocks of size page-size, and
3629 ** + This commit is not part of a multi-file transaction, and
3630 ** + Exactly one page has been modified and store in the journal file.
3631 **
3632 ** If the optimization can be used, then the journal file will never
3633 ** be created for this transaction.
3634 */
danielk19774d60af92008-09-08 15:35:06 +00003635 int useAtomicWrite;
danielk19778c0a7912008-08-20 14:49:23 +00003636 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
danielk19774d60af92008-09-08 15:35:06 +00003637 useAtomicWrite = (
danielk1977f55b8992007-08-24 08:15:53 +00003638 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00003639 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00003640 pPager->journalOff==jrnlBufferSize(pPager) &&
3641 nTrunc==0 &&
danielk19778c0a7912008-08-20 14:49:23 +00003642 (pPg==0 || pPg->pDirty==0)
danielk1977f55b8992007-08-24 08:15:53 +00003643 );
danielk1977700b9c52008-04-24 12:37:40 +00003644 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00003645 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00003646 /* Update the nRec field in the journal file. */
3647 int offset = pPager->journalHdr + sizeof(aJournalMagic);
3648 assert(pPager->nRec==1);
3649 rc = write32bits(pPager->jfd, offset, pPager->nRec);
3650
3651 /* Update the db file change counter. The following call will modify
3652 ** the in-memory representation of page 1 to include the updated
3653 ** change counter and then write page 1 directly to the database
3654 ** file. Because of the atomic-write property of the host file-system,
3655 ** this is safe.
3656 */
danielk1977ae72d982007-10-03 08:46:44 +00003657 if( rc==SQLITE_OK ){
3658 rc = pager_incr_changecounter(pPager, 1);
3659 }
danielk1977f55b8992007-08-24 08:15:53 +00003660 }else{
3661 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00003662 }
3663
danielk1977ae72d982007-10-03 08:46:44 +00003664 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00003665#endif
3666
drh80e35f42007-03-30 14:06:34 +00003667 /* If a master journal file name has already been written to the
3668 ** journal file, then no sync is required. This happens when it is
3669 ** written, then the process fails to upgrade from a RESERVED to an
3670 ** EXCLUSIVE lock. The next time the process tries to commit the
3671 ** transaction the m-j name will have already been written.
3672 */
3673 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00003674 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003675 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00003676 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00003677#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00003678 if( nTrunc!=0 ){
3679 /* If this transaction has made the database smaller, then all pages
3680 ** being discarded by the truncation must be written to the journal
3681 ** file.
3682 */
3683 Pgno i;
danielk1977d92db532008-11-17 04:56:24 +00003684 Pgno iSkip = PAGER_MJ_PGNO(pPager);
danielk197771aa7ff2008-05-20 07:05:09 +00003685 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3686 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
3687 rc = sqlite3PagerGet(pPager, i, &pPg);
3688 if( rc!=SQLITE_OK ) goto sync_exit;
3689 rc = sqlite3PagerWrite(pPg);
3690 sqlite3PagerUnref(pPg);
3691 if( rc!=SQLITE_OK ) goto sync_exit;
3692 }
3693 }
3694 }
drh80e35f42007-03-30 14:06:34 +00003695#endif
danielk197771aa7ff2008-05-20 07:05:09 +00003696 rc = writeMasterJournal(pPager, zMaster);
3697 if( rc!=SQLITE_OK ) goto sync_exit;
3698 rc = syncJournal(pPager);
3699 }
drh80e35f42007-03-30 14:06:34 +00003700 }
danielk1977c7b60172007-08-22 11:22:03 +00003701 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00003702
3703#ifndef SQLITE_OMIT_AUTOVACUUM
3704 if( nTrunc!=0 ){
3705 rc = sqlite3PagerTruncate(pPager, nTrunc);
3706 if( rc!=SQLITE_OK ) goto sync_exit;
3707 }
3708#endif
3709
3710 /* Write all dirty pages to the database file */
danielk19778c0a7912008-08-20 14:49:23 +00003711 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003712 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00003713 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00003714 assert( rc!=SQLITE_IOERR_BLOCKED );
3715 /* The error might have left the dirty list all fouled up here,
3716 ** but that does not matter because if the if the dirty list did
3717 ** get corrupted, then the transaction will roll back and
3718 ** discard the dirty list. There is an assert in
3719 ** pager_get_all_dirty_pages() that verifies that no attempt
3720 ** is made to use an invalid dirty list.
3721 */
drh153c62c2007-08-24 03:51:33 +00003722 goto sync_exit;
3723 }
danielk19778c0a7912008-08-20 14:49:23 +00003724 sqlite3PcacheCleanAll(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003725
3726 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00003727 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00003728 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00003729 }
3730 IOTRACE(("DBSYNC %p\n", pPager))
3731
3732 pPager->state = PAGER_SYNCED;
3733 }else if( MEMDB && nTrunc!=0 ){
3734 rc = sqlite3PagerTruncate(pPager, nTrunc);
3735 }
3736
3737sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00003738 if( rc==SQLITE_IOERR_BLOCKED ){
3739 /* pager_incr_changecounter() may attempt to obtain an exclusive
3740 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00003741 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00003742 * better to return SQLITE_BUSY.
3743 */
3744 rc = SQLITE_BUSY;
3745 }
drh80e35f42007-03-30 14:06:34 +00003746 return rc;
3747}
3748
3749
3750/*
drhed7c8552001-04-11 14:29:21 +00003751** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003752**
3753** If the commit fails for any reason, a rollback attempt is made
3754** and an error code is returned. If the commit worked, SQLITE_OK
3755** is returned.
drhed7c8552001-04-11 14:29:21 +00003756*/
drh80e35f42007-03-30 14:06:34 +00003757int sqlite3PagerCommitPhaseTwo(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003758 int rc = SQLITE_OK;
drhd9b02572001-04-15 00:37:09 +00003759
danielk1977efaaf572006-01-16 11:29:19 +00003760 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003761 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003762 }
drha6abd042004-06-09 17:37:22 +00003763 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003764 return SQLITE_ERROR;
3765 }
drhd138c012008-05-13 00:58:18 +00003766 if( pPager->dbModified==0 &&
3767 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3768 pPager->exclusiveMode!=0) ){
3769 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3770 return SQLITE_OK;
3771 }
drh4f0c5872007-03-26 22:05:01 +00003772 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003773 assert( pPager->state==PAGER_SYNCED || MEMDB || !pPager->dirtyCache );
3774 rc = pager_end_transaction(pPager, pPager->setMaster);
3775 rc = pager_error(pPager, rc);
drh86f8c192007-08-22 00:39:19 +00003776 return rc;
drhed7c8552001-04-11 14:29:21 +00003777}
3778
3779/*
drha6abd042004-06-09 17:37:22 +00003780** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003781** All in-memory cache pages revert to their original data contents.
3782** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003783**
3784** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003785** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003786** process is writing trash into the journal file (SQLITE_CORRUPT) or
3787** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3788** codes are returned for all these occasions. Otherwise,
3789** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003790*/
danielk19773b8a05f2007-03-19 17:44:26 +00003791int sqlite3PagerRollback(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003792 int rc = SQLITE_OK;
drh4f0c5872007-03-26 22:05:01 +00003793 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003794 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00003795 rc = pager_end_transaction(pPager, pPager->setMaster);
danielk19778c0a7912008-08-20 14:49:23 +00003796 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003797 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003798 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003799 }
danielk19778c0a7912008-08-20 14:49:23 +00003800 rc = pPager->errCode;
drha6abd042004-06-09 17:37:22 +00003801 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003802 if( pPager->state==PAGER_RESERVED ){
3803 int rc2;
3804 rc = pager_playback(pPager, 0);
3805 rc2 = pager_end_transaction(pPager, pPager->setMaster);
3806 if( rc==SQLITE_OK ){
3807 rc = rc2;
3808 }
3809 }else{
3810 rc = pager_playback(pPager, 0);
3811 }
danielk197707cb5602006-01-20 10:55:05 +00003812
danielk1977b3175382008-10-17 18:51:52 +00003813 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00003814 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00003815 }
danielk19778c0a7912008-08-20 14:49:23 +00003816
3817 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3818 ** cache. So call pager_error() on the way out to make any error
3819 ** persistent.
3820 */
3821 rc = pager_error(pPager, rc);
3822 }
drh86f8c192007-08-22 00:39:19 +00003823 return rc;
drh98808ba2001-10-18 12:34:46 +00003824}
drhd9b02572001-04-15 00:37:09 +00003825
3826/*
drh5e00f6c2001-09-13 13:46:56 +00003827** Return TRUE if the database file is opened read-only. Return FALSE
3828** if the database is (in theory) writable.
3829*/
danielk19773b8a05f2007-03-19 17:44:26 +00003830int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003831 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003832}
3833
3834/*
drh0f7eb612006-08-08 13:51:43 +00003835** Return the number of references to the pager.
3836*/
danielk19773b8a05f2007-03-19 17:44:26 +00003837int sqlite3PagerRefcount(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003838 return sqlite3PcacheRefCount(pPager->pPCache);
drh0f7eb612006-08-08 13:51:43 +00003839}
3840
danielk197771d5d2c2008-09-29 11:49:47 +00003841/*
3842** Return the number of references to the specified page.
3843*/
3844int sqlite3PagerPageRefcount(DbPage *pPage){
3845 return sqlite3PcachePageRefcount(pPage);
3846}
3847
drh0f7eb612006-08-08 13:51:43 +00003848#ifdef SQLITE_TEST
3849/*
drhd9b02572001-04-15 00:37:09 +00003850** This routine is used for testing and analysis only.
3851*/
danielk19773b8a05f2007-03-19 17:44:26 +00003852int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003853 static int a[11];
danielk19778c0a7912008-08-20 14:49:23 +00003854 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
3855 a[1] = sqlite3PcachePagecount(pPager->pPCache);
3856 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
danielk1977d92db532008-11-17 04:56:24 +00003857 a[3] = pPager->dbSizeValid ? (int) pPager->dbSize : -1;
drhd9b02572001-04-15 00:37:09 +00003858 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003859 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003860 a[6] = pPager->nHit;
3861 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003862 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003863 a[9] = pPager->nRead;
3864 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003865 return a;
3866}
danielk197717b90b52008-06-06 11:11:25 +00003867int sqlite3PagerIsMemdb(Pager *pPager){
3868 return MEMDB;
3869}
drh0f7eb612006-08-08 13:51:43 +00003870#endif
drhdd793422001-06-28 01:54:48 +00003871
drhfa86c412002-02-02 15:01:15 +00003872/*
drhac69b052004-05-12 13:30:07 +00003873** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003874**
3875** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003876** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003877** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003878*/
drh86f8c192007-08-22 00:39:19 +00003879static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003880 int rc;
drhac69b052004-05-12 13:30:07 +00003881 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00003882 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003883 assert( pPager->dbSizeValid );
drh4f0c5872007-03-26 22:05:01 +00003884 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhda47d772002-12-02 04:25:19 +00003885 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003886 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003887 return SQLITE_OK;
3888 }
drhfa86c412002-02-02 15:01:15 +00003889 assert( pPager->journalOpen );
drhf5e7bb52008-02-18 14:47:33 +00003890 assert( pPager->pInStmt==0 );
3891 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00003892 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00003893 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00003894 return SQLITE_NOMEM;
3895 }
danielk197776572402004-06-25 02:38:54 +00003896 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003897 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003898 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003899 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003900 if( !pPager->stmtOpen ){
danielk1977b3175382008-10-17 18:51:52 +00003901 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
3902 sqlite3MemJournalOpen(pPager->stfd);
3903 }else{
3904 rc = sqlite3PagerOpentemp(pPager, pPager->stfd, SQLITE_OPEN_SUBJOURNAL);
3905 if( rc ){
3906 goto stmt_begin_failed;
3907 }
drh334b2992007-09-06 23:28:23 +00003908 }
drhac69b052004-05-12 13:30:07 +00003909 pPager->stmtOpen = 1;
3910 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003911 }
drhac69b052004-05-12 13:30:07 +00003912 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003913 return SQLITE_OK;
3914
drhac69b052004-05-12 13:30:07 +00003915stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00003916 if( pPager->pInStmt ){
3917 sqlite3BitvecDestroy(pPager->pInStmt);
3918 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003919 }
3920 return rc;
3921}
drh86f8c192007-08-22 00:39:19 +00003922int sqlite3PagerStmtBegin(Pager *pPager){
3923 int rc;
drh86f8c192007-08-22 00:39:19 +00003924 rc = pagerStmtBegin(pPager);
drh86f8c192007-08-22 00:39:19 +00003925 return rc;
3926}
drhfa86c412002-02-02 15:01:15 +00003927
3928/*
drhac69b052004-05-12 13:30:07 +00003929** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003930*/
danielk19773b8a05f2007-03-19 17:44:26 +00003931int sqlite3PagerStmtCommit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003932 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003933 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003934 sqlite3BitvecDestroy(pPager->pInStmt);
3935 pPager->pInStmt = 0;
drhac69b052004-05-12 13:30:07 +00003936 pPager->stmtNRec = 0;
3937 pPager->stmtInUse = 0;
danielk1977b3175382008-10-17 18:51:52 +00003938 if( sqlite3IsMemJournal(pPager->stfd) ){
3939 sqlite3OsTruncate(pPager->stfd, 0);
3940 }
drh663fc632002-02-02 18:49:19 +00003941 }
drhac69b052004-05-12 13:30:07 +00003942 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003943 return SQLITE_OK;
3944}
3945
3946/*
drhac69b052004-05-12 13:30:07 +00003947** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003948*/
danielk19773b8a05f2007-03-19 17:44:26 +00003949int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003950 int rc;
drhac69b052004-05-12 13:30:07 +00003951 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00003952 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003953 rc = pager_stmt_playback(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003954 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00003955 }else{
3956 rc = SQLITE_OK;
3957 }
drhac69b052004-05-12 13:30:07 +00003958 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003959 return rc;
3960}
3961
drh73509ee2003-04-06 20:44:45 +00003962/*
3963** Return the full pathname of the database file.
3964*/
danielk19773b8a05f2007-03-19 17:44:26 +00003965const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003966 return pPager->zFilename;
3967}
3968
drhb20ea9d2004-02-09 01:20:36 +00003969/*
drhd0679ed2007-08-28 22:24:34 +00003970** Return the VFS structure for the pager.
3971*/
3972const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
3973 return pPager->pVfs;
3974}
3975
3976/*
drhcc6bb3e2007-08-31 16:11:35 +00003977** Return the file handle for the database file associated
3978** with the pager. This might return NULL if the file has
3979** not yet been opened.
3980*/
3981sqlite3_file *sqlite3PagerFile(Pager *pPager){
3982 return pPager->fd;
3983}
3984
3985/*
danielk19775865e3d2004-06-14 06:03:57 +00003986** Return the directory of the database file.
3987*/
danielk19773b8a05f2007-03-19 17:44:26 +00003988const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00003989 return pPager->zDirectory;
3990}
3991
3992/*
3993** Return the full pathname of the journal file.
3994*/
danielk19773b8a05f2007-03-19 17:44:26 +00003995const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00003996 return pPager->zJournal;
3997}
3998
3999/*
drh2c8997b2005-08-27 16:36:48 +00004000** Return true if fsync() calls are disabled for this pager. Return FALSE
4001** if fsync()s are executed normally.
4002*/
danielk19773b8a05f2007-03-19 17:44:26 +00004003int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004004 return pPager->noSync;
4005}
4006
drh7c4ac0c2007-04-05 11:25:58 +00004007#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004008/*
drhb20ea9d2004-02-09 01:20:36 +00004009** Set the codec for this pager
4010*/
danielk19773b8a05f2007-03-19 17:44:26 +00004011void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004012 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004013 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004014 void *pCodecArg
4015){
4016 pPager->xCodec = xCodec;
4017 pPager->pCodecArg = pCodecArg;
4018}
drh7c4ac0c2007-04-05 11:25:58 +00004019#endif
drhb20ea9d2004-02-09 01:20:36 +00004020
danielk1977687566d2004-11-02 12:56:41 +00004021#ifndef SQLITE_OMIT_AUTOVACUUM
4022/*
danielk197787c29a92008-01-18 11:33:16 +00004023** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004024**
drh5e385312007-06-16 04:42:12 +00004025** There must be no references to the page previously located at
4026** pgno (which we call pPgOld) though that page is allowed to be
drhb3df2e12008-09-17 20:06:26 +00004027** in cache. If the page previously located at pgno is not already
drh5e385312007-06-16 04:42:12 +00004028** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004029**
drh5e385312007-06-16 04:42:12 +00004030** References to the page pPg remain valid. Updating any
4031** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004032** allocated along with the page) is the responsibility of the caller.
4033**
danielk19775fd057a2005-03-09 13:09:43 +00004034** A transaction must be active when this routine is called. It used to be
4035** required that a statement transaction was not active, but this restriction
4036** has been removed (CREATE INDEX needs to move a page when a statement
4037** transaction is active).
danielk19774c999992008-07-16 18:17:55 +00004038**
4039** If the fourth argument, isCommit, is non-zero, then this page is being
4040** moved as part of a database reorganization just before the transaction
4041** is being committed. In this case, it is guaranteed that the database page
4042** pPg refers to will not be written to again within this transaction.
danielk1977687566d2004-11-02 12:56:41 +00004043*/
danielk19774c999992008-07-16 18:17:55 +00004044int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
drh5e385312007-06-16 04:42:12 +00004045 PgHdr *pPgOld; /* The page being overwritten. */
danielk197794daf7f2004-11-08 09:26:09 +00004046 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004047
danielk1977687566d2004-11-02 12:56:41 +00004048 assert( pPg->nRef>0 );
4049
drh4f0c5872007-03-26 22:05:01 +00004050 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk19778c0a7912008-08-20 14:49:23 +00004051 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno);
drhb0603412007-02-28 04:47:26 +00004052 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004053
danielk1977b4626a32007-04-28 15:47:43 +00004054 pager_get_content(pPg);
danielk19774c999992008-07-16 18:17:55 +00004055
4056 /* If the journal needs to be sync()ed before page pPg->pgno can
4057 ** be written to, store pPg->pgno in local variable needSyncPgno.
4058 **
4059 ** If the isCommit flag is set, there is no need to remember that
4060 ** the journal needs to be sync()ed before database page pPg->pgno
4061 ** can be written to. The caller has already promised not to write to it.
4062 */
danielk19778c0a7912008-08-20 14:49:23 +00004063 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
danielk197794daf7f2004-11-08 09:26:09 +00004064 needSyncPgno = pPg->pgno;
danielk1977d92db532008-11-17 04:56:24 +00004065 assert( pageInJournal(pPg) || pgno>pPager->origDbSize );
danielk19778c0a7912008-08-20 14:49:23 +00004066 assert( pPg->flags&PGHDR_DIRTY );
danielk1977ae825582004-11-23 09:06:55 +00004067 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004068 }
4069
danielk1977ef73ee92004-11-06 12:26:07 +00004070 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00004071 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00004072 ** page pgno before the 'move' operation, it needs to be retained
4073 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004074 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00004075 pPg->flags &= ~PGHDR_NEED_SYNC;
danielk1977687566d2004-11-02 12:56:41 +00004076 pPgOld = pager_lookup(pPager, pgno);
danielk19778c0a7912008-08-20 14:49:23 +00004077 assert( !pPgOld || pPgOld->nRef==1 );
danielk1977687566d2004-11-02 12:56:41 +00004078 if( pPgOld ){
danielk19778c0a7912008-08-20 14:49:23 +00004079 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
drh5e385312007-06-16 04:42:12 +00004080 }
danielk1977687566d2004-11-02 12:56:41 +00004081
danielk19778c0a7912008-08-20 14:49:23 +00004082 sqlite3PcacheMove(pPg, pgno);
4083 if( pPgOld ){
danielk1977bc2ca9e2008-11-13 14:28:28 +00004084 sqlite3PcacheDrop(pPgOld);
danielk1977f5fdda82004-11-03 08:44:05 +00004085 }
danielk1977f5fdda82004-11-03 08:44:05 +00004086
drh605ad8f2006-05-03 23:34:05 +00004087 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004088 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004089 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00004090
danielk197794daf7f2004-11-08 09:26:09 +00004091 if( needSyncPgno ){
4092 /* If needSyncPgno is non-zero, then the journal file needs to be
4093 ** sync()ed before any data is written to database file page needSyncPgno.
4094 ** Currently, no such page exists in the page-cache and the
danielk19774c999992008-07-16 18:17:55 +00004095 ** "is journaled" bitvec flag has been set. This needs to be remedied by
4096 ** loading the page into the pager-cache and setting the PgHdr.needSync
4097 ** flag.
danielk1977ae825582004-11-23 09:06:55 +00004098 **
danielk1977a98d7b42008-01-18 13:42:54 +00004099 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00004100 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00004101 ** array. Otherwise, if the page is loaded and written again in
4102 ** this transaction, it may be written to the database file before
4103 ** it is synced into the journal file. This way, it may end up in
4104 ** the journal file twice, but that is not a problem.
4105 **
danielk19773b8a05f2007-03-19 17:44:26 +00004106 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004107 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004108 */
4109 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004110 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004111 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004112 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00004113 if( rc!=SQLITE_OK ){
danielk1977d92db532008-11-17 04:56:24 +00004114 if( pPager->pInJournal && needSyncPgno<=pPager->origDbSize ){
drhf5e7bb52008-02-18 14:47:33 +00004115 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00004116 }
danielk197787c29a92008-01-18 11:33:16 +00004117 return rc;
4118 }
danielk1977ae825582004-11-23 09:06:55 +00004119 pPager->needSync = 1;
drhb3df2e12008-09-17 20:06:26 +00004120 assert( pPager->noSync==0 && !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00004121 pPgHdr->flags |= PGHDR_NEED_SYNC;
danielk19773b8a05f2007-03-19 17:44:26 +00004122 makeDirty(pPgHdr);
4123 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004124 }
4125
danielk1977687566d2004-11-02 12:56:41 +00004126 return SQLITE_OK;
4127}
4128#endif
4129
danielk19773b8a05f2007-03-19 17:44:26 +00004130/*
4131** Return a pointer to the data for the specified page.
4132*/
4133void *sqlite3PagerGetData(DbPage *pPg){
danielk197771d5d2c2008-09-29 11:49:47 +00004134 assert( pPg->nRef>0 || pPg->pPager->memDb );
danielk19778c0a7912008-08-20 14:49:23 +00004135 return pPg->pData;
danielk19773b8a05f2007-03-19 17:44:26 +00004136}
4137
4138/*
4139** Return a pointer to the Pager.nExtra bytes of "extra" space
4140** allocated along with the specified page.
4141*/
4142void *sqlite3PagerGetExtra(DbPage *pPg){
4143 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00004144 return (pPager?pPg->pExtra:0);
danielk19773b8a05f2007-03-19 17:44:26 +00004145}
4146
danielk197741483462007-03-24 16:45:04 +00004147/*
4148** Get/set the locking-mode for this pager. Parameter eMode must be one
4149** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4150** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4151** the locking-mode is set to the value specified.
4152**
4153** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4154** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4155** locking-mode.
4156*/
4157int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004158 assert( eMode==PAGER_LOCKINGMODE_QUERY
4159 || eMode==PAGER_LOCKINGMODE_NORMAL
4160 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4161 assert( PAGER_LOCKINGMODE_QUERY<0 );
4162 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4163 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00004164 pPager->exclusiveMode = eMode;
4165 }
4166 return (int)pPager->exclusiveMode;
4167}
4168
drh3b020132008-04-17 17:02:01 +00004169/*
drh04335882008-09-26 21:08:08 +00004170** Get/set the journal-mode for this pager. Parameter eMode must be one of:
drh3b020132008-04-17 17:02:01 +00004171**
drh04335882008-09-26 21:08:08 +00004172** PAGER_JOURNALMODE_QUERY
4173** PAGER_JOURNALMODE_DELETE
4174** PAGER_JOURNALMODE_TRUNCATE
4175** PAGER_JOURNALMODE_PERSIST
4176** PAGER_JOURNALMODE_OFF
4177**
4178** If the parameter is not _QUERY, then the journal-mode is set to the
4179** value specified.
4180**
4181** The returned indicate the current (possibly updated)
drh3b020132008-04-17 17:02:01 +00004182** journal-mode.
4183*/
4184int sqlite3PagerJournalMode(Pager *pPager, int eMode){
danielk1977b3175382008-10-17 18:51:52 +00004185 if( !MEMDB ){
4186 assert( eMode==PAGER_JOURNALMODE_QUERY
4187 || eMode==PAGER_JOURNALMODE_DELETE
4188 || eMode==PAGER_JOURNALMODE_TRUNCATE
4189 || eMode==PAGER_JOURNALMODE_PERSIST
4190 || eMode==PAGER_JOURNALMODE_OFF
4191 || eMode==PAGER_JOURNALMODE_MEMORY );
4192 assert( PAGER_JOURNALMODE_QUERY<0 );
4193 if( eMode>=0 ){
4194 pPager->journalMode = eMode;
4195 }else{
4196 assert( eMode==PAGER_JOURNALMODE_QUERY );
4197 }
drh3b020132008-04-17 17:02:01 +00004198 }
drhfdc40e92008-04-17 20:59:37 +00004199 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00004200}
4201
danielk1977b53e4962008-06-04 06:45:59 +00004202/*
4203** Get/set the size-limit used for persistent journal files.
4204*/
4205i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
4206 if( iLimit>=-1 ){
4207 pPager->journalSizeLimit = iLimit;
4208 }
4209 return pPager->journalSizeLimit;
4210}
4211
drh2e66f0b2005-04-28 17:18:48 +00004212#endif /* SQLITE_OMIT_DISKIO */