blob: 02467c7ca26fb58eba656852c374a704c2a628ab [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**
danielk197767ddef62008-12-23 19:15:56 +000021** @(#) $Id: pager.c,v 1.523 2008/12/23 19:15:57 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/*
danielk1977fd7f0452008-12-17 17:30:26 +0000144** An instance of the following structure is allocated for each active
145** savepoint and statement transaction in the system. All such structures
146** are stored in the Pager.aSavepoint[] array, which is allocated and
147** resized using sqlite3Realloc().
148**
149** When a savepoint is created, the PagerSavepoint.iHdrOffset field is
150** set to 0. If a journal-header is written into the main journal while
151** the savepoint is active, then iHdrOffset is set to the byte offset
152** immediately following the last journal record written into the main
153** journal before the journal-header. This is required during savepoint
154** rollback (see pagerPlaybackSavepoint()).
155*/
156typedef struct PagerSavepoint PagerSavepoint;
157struct PagerSavepoint {
158 i64 iOffset; /* Starting offset in main journal */
159 i64 iHdrOffset; /* See above */
160 Bitvec *pInSavepoint; /* Set of pages in this savepoint */
161 Pgno nOrig; /* Original number of pages in file */
162 Pgno iSubRec; /* Index of first record in sub-journal */
163};
164
165/*
drhed7c8552001-04-11 14:29:21 +0000166** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000167**
drh4f0ee682007-03-30 20:43:40 +0000168** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000169** or SQLITE_FULL. Once one of the first three errors occurs, it persists
170** and is returned as the result of every major pager API call. The
171** SQLITE_FULL return code is slightly different. It persists only until the
172** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000173** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000174** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000175*/
176struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000177 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000178 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000179 u8 journalStarted; /* True if header of journal is synced */
180 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000181 u8 noReadlock; /* Do not bother to obtain readlocks */
drh603240c2002-03-05 01:11:12 +0000182 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000183 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000184 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000185 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000186 u8 tempFile; /* zFilename is a temporary file */
187 u8 readOnly; /* True for a read-only database */
188 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000189 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000190 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000191 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000192 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000193 u8 doNotSync; /* Boolean. While true, do not spill the cache */
194 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
drhfdc40e92008-04-17 20:59:37 +0000195 u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */
drhd138c012008-05-13 00:58:18 +0000196 u8 dbModified; /* True if there are any changes to the Db */
drh80e35f42007-03-30 14:06:34 +0000197 u8 changeCountDone; /* Set after incrementing the change-counter */
danielk1977d92db532008-11-17 04:56:24 +0000198 u8 dbSizeValid; /* Set when dbSize is correct */
drh33f4e022007-09-03 15:19:34 +0000199 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000200 int errCode; /* One of several kinds of errors */
danielk1977d92db532008-11-17 04:56:24 +0000201 Pgno dbSize; /* Number of pages in the file */
202 Pgno origDbSize; /* dbSize before the current change */
drhfcd35c72005-05-21 02:48:08 +0000203 int nRec; /* Number of pages written to the journal */
204 u32 cksumInit; /* Quasi-random value added to every checksum */
205 int stmtNRec; /* Number of records in stmt subjournal */
206 int nExtra; /* Add this many bytes to each in-memory page */
207 int pageSize; /* Number of bytes in a page */
208 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000209 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000210 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000211 Bitvec *pInJournal; /* One bit for each page in the database file */
danielk1977a1fa00d2008-08-27 15:16:33 +0000212 Bitvec *pAlwaysRollback; /* One bit for each page marked always-rollback */
drhfcd35c72005-05-21 02:48:08 +0000213 char *zFilename; /* Name of the database file */
214 char *zJournal; /* Name of the journal file */
215 char *zDirectory; /* Directory hold database and journal files */
danielk197762079062007-08-15 17:08:46 +0000216 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
danielk1977fd7f0452008-12-17 17:30:26 +0000217 sqlite3_file *sjfd; /* File descriptor for the sub-journal*/
danielk19771ceedd32008-11-19 10:22:33 +0000218 int (*xBusyHandler)(void*); /* Function to call when busy */
219 void *pBusyHandlerArg; /* Context argument for xBusyHandler */
drheb206252004-10-01 02:00:31 +0000220 i64 journalOff; /* Current byte offset in the journal file */
221 i64 journalHdr; /* Byte offset to previous journal header */
drh98c58352008-11-07 00:24:53 +0000222 u32 sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000223#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000224 int nHit, nMiss; /* Cache hits and missing */
225 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000226#endif
danielk1977eaa06f62008-09-18 17:34:44 +0000227 void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000228#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000229 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000230 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000231#endif
danielk19778186df82007-03-06 13:45:59 +0000232 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000233 char dbFileVers[16]; /* Changes whenever database file changes */
danielk1977b53e4962008-06-04 06:45:59 +0000234 i64 journalSizeLimit; /* Size limit for persistent journal files */
danielk19778c0a7912008-08-20 14:49:23 +0000235 PCache *pPCache; /* Pointer to page cache object */
danielk1977fd7f0452008-12-17 17:30:26 +0000236
237 PagerSavepoint *aSavepoint;
238 int nSavepoint;
drhd9b02572001-04-15 00:37:09 +0000239};
240
241/*
drh538f5702007-04-13 02:14:30 +0000242** The following global variables hold counters used for
243** testing purposes only. These variables do not exist in
244** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000245*/
246#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000247int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
248int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
249int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
drh538f5702007-04-13 02:14:30 +0000250# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000251#else
drh538f5702007-04-13 02:14:30 +0000252# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000253#endif
254
drh538f5702007-04-13 02:14:30 +0000255
256
drhfcd35c72005-05-21 02:48:08 +0000257/*
drh5e00f6c2001-09-13 13:46:56 +0000258** Journal files begin with the following magic string. The data
259** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000260**
drhae2b40c2004-06-09 19:03:54 +0000261** Since version 2.8.0, the journal format contains additional sanity
262** checking information. If the power fails while the journal is begin
263** written, semi-random garbage data might appear in the journal
264** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000265** to roll the journal back, the database could be corrupted. The additional
266** sanity checking data is an attempt to discover the garbage in the
267** journal and ignore it.
268**
drhae2b40c2004-06-09 19:03:54 +0000269** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000270** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000271** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000272** This cksum is initialized to a 32-bit random value that appears in the
273** journal file right after the header. The random initializer is important,
274** because garbage data that appears at the end of a journal is likely
275** data that was once in other files that have now been deleted. If the
276** garbage data came from an obsolete journal file, the checksums might
277** be correct. But by initializing the checksum to random value which
278** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000279*/
drhae2b40c2004-06-09 19:03:54 +0000280static const unsigned char aJournalMagic[] = {
281 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000282};
283
284/*
drh726de592004-06-10 23:35:50 +0000285** The size of the header and of each page in the journal is determined
286** by the following macros.
drh968af522003-02-11 14:55:40 +0000287*/
drhae2b40c2004-06-09 19:03:54 +0000288#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000289
danielk197776572402004-06-25 02:38:54 +0000290/*
291** The journal header size for this pager. In the future, this could be
292** set to some value read from the disk controller. The important
293** characteristic is that it is the same size as a disk sector.
294*/
295#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
296
drhb7f91642004-10-31 02:22:47 +0000297/*
298** The macro MEMDB is true if we are dealing with an in-memory database.
299** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
300** the value of MEMDB will be a constant and the compiler will optimize
301** out code that would never execute.
302*/
303#ifdef SQLITE_OMIT_MEMORYDB
304# define MEMDB 0
305#else
306# define MEMDB pPager->memDb
307#endif
308
309/*
danielk197776572402004-06-25 02:38:54 +0000310** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
311** reserved for working around a windows/posix incompatibility). It is
312** used in the journal to signify that the remainder of the journal file
313** is devoted to storing a master journal name - there are no more pages to
314** roll back. See comments for function writeMasterJournal() for details.
315*/
danielk1977599fcba2004-11-08 07:13:13 +0000316/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
danielk1977d92db532008-11-17 04:56:24 +0000317#define PAGER_MJ_PGNO(x) ((Pgno)((PENDING_BYTE/((x)->pageSize))+1))
danielk197713adf8a2004-06-03 16:08:41 +0000318
drh968af522003-02-11 14:55:40 +0000319/*
danielk197726836652005-01-17 01:33:13 +0000320** The maximum legal page number is (2^31 - 1).
321*/
322#define PAGER_MAX_PGNO 2147483647
323
324/*
danielk1977fd7f0452008-12-17 17:30:26 +0000325** Return false if it is necessary to write page *pPg into the sub-journal.
326** More accurately, true is returned if either:
327**
328** * No savepoints are open, or
329** * The page has been saved to the sub-journal since the most recent
330** savepoint was opened.
331**
332** TODO: There's a bug here. To do with PagerSavepoint.nOrig. Also consider
333** the idea that the page may not be required by the outermost savepoint
334** but may be required by some earlier savepoint, due to an incremental
335** vacuum operation.
danielk1977f35843b2007-04-07 15:03:17 +0000336*/
danielk1977fd7f0452008-12-17 17:30:26 +0000337static int pageInSavepoint(PgHdr *pPg){
danielk1977f35843b2007-04-07 15:03:17 +0000338 Pager *pPager = pPg->pPager;
danielk1977fd7f0452008-12-17 17:30:26 +0000339 if( pPager->nSavepoint==0 ){
340 return 1;
341 }
342 return sqlite3BitvecTest(
343 pPager->aSavepoint[pPager->nSavepoint-1].pInSavepoint, pPg->pgno
344 );
danielk1977f35843b2007-04-07 15:03:17 +0000345}
drh8ca0c722006-05-07 17:49:38 +0000346
danielk1977bc2ca9e2008-11-13 14:28:28 +0000347static int pageInJournal(PgHdr *pPg){
348 return sqlite3BitvecTest(pPg->pPager->pInJournal, pPg->pgno);
349}
350
drh8ca0c722006-05-07 17:49:38 +0000351/*
drh34e79ce2004-02-08 06:05:46 +0000352** Read a 32-bit integer from the given file descriptor. Store the integer
353** that is read in *pRes. Return SQLITE_OK if everything worked, or an
354** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000355**
356** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000357*/
danielk197762079062007-08-15 17:08:46 +0000358static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000359 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000360 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000361 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000362 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000363 }
drh94f33312002-08-12 12:29:56 +0000364 return rc;
365}
366
367/*
drh97b57482006-01-10 20:32:32 +0000368** Write a 32-bit integer into a string buffer in big-endian byte order.
369*/
drha3152892007-05-05 11:48:52 +0000370#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000371
372/*
drh34e79ce2004-02-08 06:05:46 +0000373** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
374** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000375*/
danielk197762079062007-08-15 17:08:46 +0000376static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000377 char ac[4];
drh97b57482006-01-10 20:32:32 +0000378 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000379 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000380}
381
drh2554f8b2003-01-22 01:26:44 +0000382/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000383** If file pFd is open, call sqlite3OsUnlock() on it.
384*/
385static int osUnlock(sqlite3_file *pFd, int eLock){
386 if( !pFd->pMethods ){
387 return SQLITE_OK;
388 }
389 return sqlite3OsUnlock(pFd, eLock);
390}
391
392/*
danielk1977c7b60172007-08-22 11:22:03 +0000393** This function determines whether or not the atomic-write optimization
394** can be used with this pager. The optimization can be used if:
395**
396** (a) the value returned by OsDeviceCharacteristics() indicates that
397** a database page may be written atomically, and
398** (b) the value returned by OsSectorSize() is less than or equal
399** to the page size.
400**
401** If the optimization cannot be used, 0 is returned. If it can be used,
402** then the value returned is the size of the journal file when it
403** contains rollback data for exactly one page.
404*/
405#ifdef SQLITE_ENABLE_ATOMIC_WRITE
406static int jrnlBufferSize(Pager *pPager){
407 int dc; /* Device characteristics */
408 int nSector; /* Sector size */
drhfacf0302008-06-17 15:12:00 +0000409 int szPage; /* Page size */
danielk1977c7b60172007-08-22 11:22:03 +0000410 sqlite3_file *fd = pPager->fd;
411
412 if( fd->pMethods ){
413 dc = sqlite3OsDeviceCharacteristics(fd);
414 nSector = sqlite3OsSectorSize(fd);
drhfacf0302008-06-17 15:12:00 +0000415 szPage = pPager->pageSize;
danielk1977c7b60172007-08-22 11:22:03 +0000416 }
417
418 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
419 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
420
drhfacf0302008-06-17 15:12:00 +0000421 if( !fd->pMethods ||
422 (dc & (SQLITE_IOCAP_ATOMIC|(szPage>>8)) && nSector<=szPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000423 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
424 }
425 return 0;
426}
427#endif
428
429/*
danielk1977aef0bf62005-12-30 16:28:01 +0000430** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000431** code. The first argument is a pointer to the pager structure, the
432** second the error-code about to be returned by a pager API function.
433** The value returned is a copy of the second argument to this function.
434**
drh4f0ee682007-03-30 20:43:40 +0000435** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000436** the error becomes persistent. Until the persisten error is cleared,
437** subsequent API calls on this Pager will immediately return the same
438** error code.
439**
440** A persistent error indicates that the contents of the pager-cache
441** cannot be trusted. This state can be cleared by completely discarding
442** the contents of the pager-cache. If a transaction was active when
443** the persistent error occured, then the rollback journal may need
444** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000445*/
danielk1977ae72d982007-10-03 08:46:44 +0000446static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000447static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000448 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000449 assert(
450 pPager->errCode==SQLITE_FULL ||
451 pPager->errCode==SQLITE_OK ||
452 (pPager->errCode & 0xff)==SQLITE_IOERR
453 );
danielk1977979f38e2007-03-27 16:19:51 +0000454 if(
drh4ac285a2006-09-15 07:28:50 +0000455 rc2==SQLITE_FULL ||
456 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000457 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000458 ){
459 pPager->errCode = rc;
danielk19778c0a7912008-08-20 14:49:23 +0000460 if( pPager->state==PAGER_UNLOCK
461 && sqlite3PcacheRefCount(pPager->pPCache)==0
462 ){
danielk1977ae72d982007-10-03 08:46:44 +0000463 /* If the pager is already unlocked, call pager_unlock() now to
464 ** clear the error state and ensure that the pager-cache is
465 ** completely empty.
466 */
467 pager_unlock(pPager);
468 }
danielk1977aef0bf62005-12-30 16:28:01 +0000469 }
470 return rc;
471}
472
drh477731b2007-06-16 03:06:27 +0000473/*
474** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
475** on the cache using a hash function. This is used for testing
476** and debugging only.
477*/
danielk19773c407372005-02-15 02:54:14 +0000478#ifdef SQLITE_CHECK_PAGES
479/*
480** Return a 32-bit hash of the page data for pPage.
481*/
drh477731b2007-06-16 03:06:27 +0000482static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000483 u32 hash = 0;
484 int i;
drh477731b2007-06-16 03:06:27 +0000485 for(i=0; i<nByte; i++){
486 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000487 }
488 return hash;
489}
drh477731b2007-06-16 03:06:27 +0000490static u32 pager_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000491 return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
492}
danielk1977bc2ca9e2008-11-13 14:28:28 +0000493static void pager_set_pagehash(PgHdr *pPage){
danielk19778c0a7912008-08-20 14:49:23 +0000494 pPage->pageHash = pager_pagehash(pPage);
drh477731b2007-06-16 03:06:27 +0000495}
danielk19773c407372005-02-15 02:54:14 +0000496
497/*
498** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
499** is defined, and NDEBUG is not defined, an assert() statement checks
500** that the page is either dirty or still matches the calculated page-hash.
501*/
502#define CHECK_PAGE(x) checkPage(x)
503static void checkPage(PgHdr *pPg){
504 Pager *pPager = pPg->pPager;
danielk1977b3175382008-10-17 18:51:52 +0000505 assert( !pPg->pageHash || pPager->errCode
danielk19778c0a7912008-08-20 14:49:23 +0000506 || (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
danielk19773c407372005-02-15 02:54:14 +0000507}
508
509#else
drh8ffa8172007-06-18 17:25:17 +0000510#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000511#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000512#define CHECK_PAGE(x)
drh41d30272008-08-20 21:47:45 +0000513#endif /* SQLITE_CHECK_PAGES */
danielk19773c407372005-02-15 02:54:14 +0000514
drhed7c8552001-04-11 14:29:21 +0000515/*
danielk197776572402004-06-25 02:38:54 +0000516** When this is called the journal file for pager pPager must be open.
517** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000518** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000519**
danielk197765839c62007-08-30 08:08:17 +0000520** zMaster must point to a buffer of at least nMaster bytes allocated by
521** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
522** enough space to write the master journal name). If the master journal
523** name in the journal is longer than nMaster bytes (including a
524** nul-terminator), then this is handled as if no master journal name
525** were present in the journal.
526**
527** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000528** SQLITE_OK returned.
529*/
danielk1977d92db532008-11-17 04:56:24 +0000530static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, u32 nMaster){
danielk197776572402004-06-25 02:38:54 +0000531 int rc;
532 u32 len;
drheb206252004-10-01 02:00:31 +0000533 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000534 u32 cksum;
shane0b8d2762008-07-22 05:18:00 +0000535 u32 u; /* Unsigned loop counter */
danielk197776572402004-06-25 02:38:54 +0000536 unsigned char aMagic[8]; /* A buffer to hold the magic header */
537
danielk197765839c62007-08-30 08:08:17 +0000538 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000539
drh054889e2005-11-30 03:20:31 +0000540 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000541 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000542
danielk197762079062007-08-15 17:08:46 +0000543 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000544 if( rc!=SQLITE_OK ) return rc;
545
danielk197765839c62007-08-30 08:08:17 +0000546 if( len>=nMaster ){
547 return SQLITE_OK;
548 }
549
danielk197762079062007-08-15 17:08:46 +0000550 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000551 if( rc!=SQLITE_OK ) return rc;
552
danielk197762079062007-08-15 17:08:46 +0000553 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000554 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
555
danielk197765839c62007-08-30 08:08:17 +0000556 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000557 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000558 return rc;
559 }
danielk197765839c62007-08-30 08:08:17 +0000560 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000561
562 /* See if the checksum matches the master journal name */
shane0b8d2762008-07-22 05:18:00 +0000563 for(u=0; u<len; u++){
564 cksum -= zMaster[u];
danielk197765839c62007-08-30 08:08:17 +0000565 }
danielk19778191bff2004-06-28 04:52:30 +0000566 if( cksum ){
567 /* If the checksum doesn't add up, then one or more of the disk sectors
568 ** containing the master journal filename is corrupted. This means
569 ** definitely roll back, so just return SQLITE_OK and report a (nul)
570 ** master-journal filename.
571 */
danielk197765839c62007-08-30 08:08:17 +0000572 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000573 }
danielk197776572402004-06-25 02:38:54 +0000574
575 return SQLITE_OK;
576}
577
578/*
579** Seek the journal file descriptor to the next sector boundary where a
580** journal header may be read or written. Pager.journalOff is updated with
581** the new seek offset.
582**
583** i.e for a sector size of 512:
584**
585** Input Offset Output Offset
586** ---------------------------------------
587** 0 0
588** 512 512
589** 100 512
590** 2000 2048
591**
592*/
danielk197762079062007-08-15 17:08:46 +0000593static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000594 i64 offset = 0;
595 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000596 if( c ){
597 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
598 }
599 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
600 assert( offset>=c );
601 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
602 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000603}
604
605/*
drhf3a87622008-04-17 14:16:42 +0000606** Write zeros over the header of the journal file. This has the
607** effect of invalidating the journal file and committing the
608** transaction.
609*/
danielk1977df2566a2008-05-07 19:11:03 +0000610static int zeroJournalHdr(Pager *pPager, int doTruncate){
611 int rc = SQLITE_OK;
danielk197755a25a12008-09-11 10:29:15 +0000612 static const char zeroHdr[28] = {0};
drhf3a87622008-04-17 14:16:42 +0000613
danielk1977df2566a2008-05-07 19:11:03 +0000614 if( pPager->journalOff ){
danielk1977b53e4962008-06-04 06:45:59 +0000615 i64 iLimit = pPager->journalSizeLimit;
616
danielk1977df2566a2008-05-07 19:11:03 +0000617 IOTRACE(("JZEROHDR %p\n", pPager))
danielk1977b53e4962008-06-04 06:45:59 +0000618 if( doTruncate || iLimit==0 ){
danielk1977df2566a2008-05-07 19:11:03 +0000619 rc = sqlite3OsTruncate(pPager->jfd, 0);
620 }else{
621 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
622 }
danielk197781620542008-06-07 05:19:37 +0000623 if( rc==SQLITE_OK && !pPager->noSync ){
danielk1977df2566a2008-05-07 19:11:03 +0000624 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags);
625 }
danielk1977b53e4962008-06-04 06:45:59 +0000626
627 /* At this point the transaction is committed but the write lock
628 ** is still held on the file. If there is a size limit configured for
629 ** the persistent journal and the journal file currently consumes more
630 ** space than that limit allows for, truncate it now. There is no need
631 ** to sync the file following this operation.
632 */
633 if( rc==SQLITE_OK && iLimit>0 ){
634 i64 sz;
635 rc = sqlite3OsFileSize(pPager->jfd, &sz);
636 if( rc==SQLITE_OK && sz>iLimit ){
637 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
638 }
639 }
drha06ecba2008-04-22 17:15:17 +0000640 }
drhf3a87622008-04-17 14:16:42 +0000641 return rc;
642}
643
644/*
danielk197776572402004-06-25 02:38:54 +0000645** The journal file must be open when this routine is called. A journal
646** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
647** current location.
648**
649** The format for the journal header is as follows:
650** - 8 bytes: Magic identifying journal format.
651** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
652** - 4 bytes: Random number used for page hash.
653** - 4 bytes: Initial database page count.
654** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000655** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000656**
danielk197767c007b2008-03-20 04:45:49 +0000657** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000658*/
659static int writeJournalHdr(Pager *pPager){
danielk1977a664f8e2008-04-22 14:31:48 +0000660 int rc = SQLITE_OK;
661 char *zHeader = pPager->pTmpSpace;
danielk1977d92db532008-11-17 04:56:24 +0000662 u32 nHeader = pPager->pageSize;
663 u32 nWrite;
danielk1977fd7f0452008-12-17 17:30:26 +0000664 int ii;
danielk1977a664f8e2008-04-22 14:31:48 +0000665
666 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
667 nHeader = JOURNAL_HDR_SZ(pPager);
668 }
danielk197776572402004-06-25 02:38:54 +0000669
danielk1977fd7f0452008-12-17 17:30:26 +0000670 /* If there are active savepoints and any of them were created since the
671 ** most recent journal header was written, update the PagerSavepoint.iHdrOff
672 ** fields now.
673 */
674 for(ii=0; ii<pPager->nSavepoint; ii++){
675 if( pPager->aSavepoint[ii].iHdrOffset==0 ){
676 pPager->aSavepoint[ii].iHdrOffset = pPager->journalOff;
677 }
danielk19774099f6e2007-03-19 11:25:20 +0000678 }
679
danielk197762079062007-08-15 17:08:46 +0000680 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000681 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000682
drh97b57482006-01-10 20:32:32 +0000683 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +0000684
685 /*
686 ** Write the nRec Field - the number of page records that follow this
687 ** journal header. Normally, zero is written to this value at this time.
688 ** After the records are added to the journal (and the journal synced,
689 ** if in full-sync mode), the zero is overwritten with the true number
690 ** of records (see syncJournal()).
691 **
692 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
693 ** reading the journal this value tells SQLite to assume that the
694 ** rest of the journal file contains valid page records. This assumption
695 ** is dangerous, as if a failure occured whilst writing to the journal
696 ** file it may contain some garbage data. There are two scenarios
697 ** where this risk can be ignored:
698 **
699 ** * When the pager is in no-sync mode. Corruption can follow a
700 ** power failure in this case anyway.
701 **
702 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
703 ** that garbage data is never appended to the journal file.
704 */
705 assert(pPager->fd->pMethods||pPager->noSync);
danielk1977b3175382008-10-17 18:51:52 +0000706 if( (pPager->noSync) || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY)
danielk19774cd2cd52007-08-23 14:48:23 +0000707 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
708 ){
709 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
710 }else{
711 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
712 }
713
drh97b57482006-01-10 20:32:32 +0000714 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +0000715 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +0000716 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
717 /* The initial database size */
718 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
719 /* The assumed sector size for this process */
720 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
drh08609ce2008-11-29 22:49:23 +0000721
722 /* Initializing the tail of the buffer is not necessary. Everything
723 ** works find if the following memset() is omitted. But initializing
724 ** the memory prevents valgrind from complaining, so we are willing to
725 ** take the performance hit.
726 */
727 memset(&zHeader[sizeof(aJournalMagic)+16], 0,
728 nHeader-(sizeof(aJournalMagic)+16));
729
danielk197767c007b2008-03-20 04:45:49 +0000730 if( pPager->journalHdr==0 ){
731 /* The page size */
732 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
733 }
danielk197776572402004-06-25 02:38:54 +0000734
danielk1977a664f8e2008-04-22 14:31:48 +0000735 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
736 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
737 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
738 pPager->journalOff += nHeader;
danielk197776572402004-06-25 02:38:54 +0000739 }
danielk1977a664f8e2008-04-22 14:31:48 +0000740
danielk197776572402004-06-25 02:38:54 +0000741 return rc;
742}
743
744/*
745** The journal file must be open when this is called. A journal header file
746** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
747** file. See comments above function writeJournalHdr() for a description of
748** the journal header format.
749**
750** If the header is read successfully, *nRec is set to the number of
751** page records following this header and *dbSize is set to the size of the
752** database before the transaction began, in pages. Also, pPager->cksumInit
753** is set to the value read from the journal header. SQLITE_OK is returned
754** in this case.
755**
756** If the journal header file appears to be corrupted, SQLITE_DONE is
757** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
758** cannot be read from the journal file an error code is returned.
759*/
760static int readJournalHdr(
761 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000762 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000763 u32 *pNRec,
764 u32 *pDbSize
765){
766 int rc;
767 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +0000768 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +0000769 int iPageSize;
danielk197776572402004-06-25 02:38:54 +0000770
danielk197762079062007-08-15 17:08:46 +0000771 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000772 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
773 return SQLITE_DONE;
774 }
danielk197762079062007-08-15 17:08:46 +0000775 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000776
danielk197762079062007-08-15 17:08:46 +0000777 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000778 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +0000779 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +0000780
781 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
782 return SQLITE_DONE;
783 }
784
danielk197762079062007-08-15 17:08:46 +0000785 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +0000786 if( rc ) return rc;
787
danielk197762079062007-08-15 17:08:46 +0000788 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000789 if( rc ) return rc;
790
danielk197762079062007-08-15 17:08:46 +0000791 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000792 if( rc ) return rc;
793
danielk197767c007b2008-03-20 04:45:49 +0000794 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
795 if( rc==SQLITE_OK
796 && iPageSize>=512
797 && iPageSize<=SQLITE_MAX_PAGE_SIZE
798 && ((iPageSize-1)&iPageSize)==0
799 ){
drh4f21c4a2008-12-10 22:15:00 +0000800 u16 pagesize = (u16)iPageSize;
danielk197767c007b2008-03-20 04:45:49 +0000801 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
802 }
803 if( rc ) return rc;
804
danielk197776572402004-06-25 02:38:54 +0000805 /* Update the assumed sector-size to match the value used by
806 ** the process that created this journal. If this journal was
807 ** created by a process other than this one, then this routine
808 ** is being called from within pager_playback(). The local value
809 ** of Pager.sectorSize is restored at the end of that routine.
810 */
drh98c58352008-11-07 00:24:53 +0000811 rc = read32bits(pPager->jfd, jrnlOff+12, &pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000812 if( rc ) return rc;
drh98c58352008-11-07 00:24:53 +0000813 if( (pPager->sectorSize & (pPager->sectorSize-1))!=0
814 || pPager->sectorSize>0x1000000 ){
815 return SQLITE_DONE;
816 }
danielk197776572402004-06-25 02:38:54 +0000817
818 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +0000819 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000820}
821
822
823/*
824** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000825** pPager at the current location. The master journal name must be the last
826** thing written to a journal file. If the pager is in full-sync mode, the
827** journal file descriptor is advanced to the next sector boundary before
828** anything is written. The format is:
829**
830** + 4 bytes: PAGER_MJ_PGNO.
831** + N bytes: length of master journal name.
832** + 4 bytes: N
833** + 4 bytes: Master journal name checksum.
834** + 8 bytes: aJournalMagic[].
835**
836** The master journal page checksum is the sum of the bytes in the master
837** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000838**
839** If zMaster is a NULL pointer (occurs for a single database transaction),
840** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000841*/
842static int writeMasterJournal(Pager *pPager, const char *zMaster){
843 int rc;
844 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000845 int i;
danielk197762079062007-08-15 17:08:46 +0000846 i64 jrnlOff;
danielk1977df2566a2008-05-07 19:11:03 +0000847 i64 jrnlSize;
drh97b57482006-01-10 20:32:32 +0000848 u32 cksum = 0;
849 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000850
danielk1977b3175382008-10-17 18:51:52 +0000851 if( !zMaster || pPager->setMaster ) return SQLITE_OK;
852 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ) return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +0000853 pPager->setMaster = 1;
854
drhea678832008-12-10 19:26:22 +0000855 len = sqlite3Strlen30(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000856 for(i=0; i<len; i++){
857 cksum += zMaster[i];
858 }
danielk197776572402004-06-25 02:38:54 +0000859
860 /* If in full-sync mode, advance to the next disk sector before writing
861 ** the master journal name. This is in case the previous page written to
862 ** the journal has already been synced.
863 */
864 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +0000865 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000866 }
danielk197762079062007-08-15 17:08:46 +0000867 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +0000868 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000869
danielk197762079062007-08-15 17:08:46 +0000870 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000871 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000872 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +0000873
danielk197762079062007-08-15 17:08:46 +0000874 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +0000875 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +0000876 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +0000877
drh97b57482006-01-10 20:32:32 +0000878 put32bits(zBuf, len);
879 put32bits(&zBuf[4], cksum);
880 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +0000881 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
danielk1977df2566a2008-05-07 19:11:03 +0000882 jrnlOff += 8+sizeof(aJournalMagic);
drh2c8997b2005-08-27 16:36:48 +0000883 pPager->needSync = !pPager->noSync;
danielk1977df2566a2008-05-07 19:11:03 +0000884
885 /* If the pager is in peristent-journal mode, then the physical
886 ** journal-file may extend past the end of the master-journal name
887 ** and 8 bytes of magic data just written to the file. This is
888 ** dangerous because the code to rollback a hot-journal file
889 ** will not be able to find the master-journal name to determine
890 ** whether or not the journal is hot.
891 **
892 ** Easiest thing to do in this scenario is to truncate the journal
893 ** file to the required size.
894 */
895 if( (rc==SQLITE_OK)
896 && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK
897 && jrnlSize>jrnlOff
898 ){
899 rc = sqlite3OsTruncate(pPager->jfd, jrnlOff);
900 }
danielk197776572402004-06-25 02:38:54 +0000901 return rc;
902}
903
904/*
drhed7c8552001-04-11 14:29:21 +0000905** Find a page in the hash table given its page number. Return
906** a pointer to the page or NULL if not found.
907*/
drhd9b02572001-04-15 00:37:09 +0000908static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000909 PgHdr *p;
danielk19778c0a7912008-08-20 14:49:23 +0000910 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &p);
drhed7c8552001-04-11 14:29:21 +0000911 return p;
912}
913
914/*
danielk1977e180dd92007-04-05 17:15:52 +0000915** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000916** sets the state of the pager back to what it was when it was first
917** opened. Any outstanding pages are invalidated and subsequent attempts
918** to access those pages will likely result in a coredump.
919*/
drhd9b02572001-04-15 00:37:09 +0000920static void pager_reset(Pager *pPager){
danielk1977efaaf572006-01-16 11:29:19 +0000921 if( pPager->errCode ) return;
danielk19778c0a7912008-08-20 14:49:23 +0000922 sqlite3PcacheClear(pPager->pPCache);
danielk1977e277be02007-03-23 18:12:06 +0000923}
924
danielk197734cf35d2008-12-18 18:31:38 +0000925/*
926** Free all structures in the Pager.aSavepoint[] array and set both
927** Pager.aSavepoint and Pager.nSavepoint to zero. Close the sub-journal
928** if it is open and the pager is not in exclusive mode.
929*/
danielk1977fd7f0452008-12-17 17:30:26 +0000930static void releaseAllSavepoint(Pager *pPager){
931 int ii;
932 for(ii=0; ii<pPager->nSavepoint; ii++){
933 sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
934 }
935 if( !pPager->exclusiveMode ){
936 sqlite3OsClose(pPager->sjfd);
937 }
938 sqlite3_free(pPager->aSavepoint);
939 pPager->aSavepoint = 0;
940 pPager->nSavepoint = 0;
danielk197767ddef62008-12-23 19:15:56 +0000941 pPager->stmtNRec = 0;
danielk1977fd7f0452008-12-17 17:30:26 +0000942}
943
danielk197734cf35d2008-12-18 18:31:38 +0000944/*
945** Set the bit number pgno in the PagerSavepoint.pInSavepoint bitvecs of
946** all open savepoints.
947*/
danielk1977fd7f0452008-12-17 17:30:26 +0000948static int addToSavepointBitvecs(Pager *pPager, Pgno pgno){
949 int ii;
950 for(ii=0; ii<pPager->nSavepoint; ii++){
951 PagerSavepoint *p = &pPager->aSavepoint[ii];
952 if( pgno<=p->nOrig ){
953 /* TODO: malloc() failure handling */
954 sqlite3BitvecSet(p->pInSavepoint, pgno);
955 }
956 }
957 return SQLITE_OK;
958}
959
danielk1977e277be02007-03-23 18:12:06 +0000960/*
danielk1977ae72d982007-10-03 08:46:44 +0000961** Unlock the database file.
962**
963** If the pager is currently in error state, discard the contents of
964** the cache and reset the Pager structure internal state. If there is
965** an open journal-file, then the next time a shared-lock is obtained
966** on the pager file (by this or any other process), it will be
967** treated as a hot-journal and rolled back.
968*/
969static void pager_unlock(Pager *pPager){
970 if( !pPager->exclusiveMode ){
danielk1977b3175382008-10-17 18:51:52 +0000971 int rc = osUnlock(pPager->fd, NO_LOCK);
972 if( rc ) pPager->errCode = rc;
danielk1977d92db532008-11-17 04:56:24 +0000973 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +0000974 IOTRACE(("UNLOCK %p\n", pPager))
danielk1977ae72d982007-10-03 08:46:44 +0000975
danielk1977b3175382008-10-17 18:51:52 +0000976 /* Always close the journal file when dropping the database lock.
977 ** Otherwise, another connection with journal_mode=delete might
978 ** delete the file out from under us.
979 */
980 if( pPager->journalOpen ){
981 sqlite3OsClose(pPager->jfd);
982 pPager->journalOpen = 0;
983 sqlite3BitvecDestroy(pPager->pInJournal);
984 pPager->pInJournal = 0;
985 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
986 pPager->pAlwaysRollback = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000987 }
988
danielk1977b3175382008-10-17 18:51:52 +0000989 /* If Pager.errCode is set, the contents of the pager cache cannot be
990 ** trusted. Now that the pager file is unlocked, the contents of the
991 ** cache can be discarded and the error code safely cleared.
992 */
993 if( pPager->errCode ){
994 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
995 pager_reset(pPager);
danielk1977fd7f0452008-12-17 17:30:26 +0000996 releaseAllSavepoint(pPager);
danielk1977b3175382008-10-17 18:51:52 +0000997 pPager->journalOff = 0;
998 pPager->journalStarted = 0;
danielk1977b3175382008-10-17 18:51:52 +0000999 pPager->origDbSize = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001000 }
danielk1977b3175382008-10-17 18:51:52 +00001001
1002 pPager->state = PAGER_UNLOCK;
1003 pPager->changeCountDone = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001004 }
1005}
1006
1007/*
1008** Execute a rollback if a transaction is active and unlock the
1009** database file. If the pager has already entered the error state,
1010** do not attempt the rollback.
1011*/
1012static void pagerUnlockAndRollback(Pager *p){
danielk1977ae72d982007-10-03 08:46:44 +00001013 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
danielk19772d1d86f2008-06-20 14:59:51 +00001014 sqlite3BeginBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001015 sqlite3PagerRollback(p);
danielk19772d1d86f2008-06-20 14:59:51 +00001016 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001017 }
1018 pager_unlock(p);
danielk1977ae72d982007-10-03 08:46:44 +00001019}
1020
1021/*
drh80e35f42007-03-30 14:06:34 +00001022** This routine ends a transaction. A transaction is ended by either
1023** a COMMIT or a ROLLBACK.
1024**
drhed7c8552001-04-11 14:29:21 +00001025** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001026** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1027** the database lock and acquires a SHARED lock in its place if that is
1028** the appropriate thing to do. Release locks usually is appropriate,
1029** unless we are in exclusive access mode or unless this is a
1030** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1031**
1032** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001033**
1034** TODO: Consider keeping the journal file open for temporary databases.
1035** This might give a performance improvement on windows where opening
1036** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001037*/
danielk1977df2566a2008-05-07 19:11:03 +00001038static int pager_end_transaction(Pager *pPager, int hasMaster){
danielk197741483462007-03-24 16:45:04 +00001039 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001040 int rc2 = SQLITE_OK;
drha6abd042004-06-09 17:37:22 +00001041 if( pPager->state<PAGER_RESERVED ){
1042 return SQLITE_OK;
1043 }
danielk1977fd7f0452008-12-17 17:30:26 +00001044 releaseAllSavepoint(pPager);
drhda47d772002-12-02 04:25:19 +00001045 if( pPager->journalOpen ){
danielk1977b3175382008-10-17 18:51:52 +00001046 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
1047 int isMemoryJournal = sqlite3IsMemJournal(pPager->jfd);
1048 sqlite3OsClose(pPager->jfd);
1049 pPager->journalOpen = 0;
1050 if( !isMemoryJournal ){
1051 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
1052 }
1053 }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE
drh04335882008-09-26 21:08:08 +00001054 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){
1055 pPager->journalOff = 0;
1056 pPager->journalStarted = 0;
1057 }else if( pPager->exclusiveMode
danielk197793f7af92008-05-09 16:57:50 +00001058 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
1059 ){
1060 rc = zeroJournalHdr(pPager, hasMaster);
1061 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +00001062 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001063 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001064 }else{
drh04335882008-09-26 21:08:08 +00001065 assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE || rc );
danielk1977b4b47412007-08-17 15:53:36 +00001066 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001067 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +00001068 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +00001069 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001070 }
danielk197741483462007-03-24 16:45:04 +00001071 }
drhf5e7bb52008-02-18 14:47:33 +00001072 sqlite3BitvecDestroy(pPager->pInJournal);
1073 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +00001074 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
1075 pPager->pAlwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001076#ifdef SQLITE_CHECK_PAGES
danielk1977bc2ca9e2008-11-13 14:28:28 +00001077 sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash);
danielk19773c407372005-02-15 02:54:14 +00001078#endif
danielk1977bc2ca9e2008-11-13 14:28:28 +00001079 sqlite3PcacheCleanAll(pPager->pPCache);
danielk1977ef317ab2004-06-23 10:43:10 +00001080 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001081 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001082 }else{
drhf5e7bb52008-02-18 14:47:33 +00001083 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001084 }
danielk1977979f38e2007-03-27 16:19:51 +00001085
danielk197741483462007-03-24 16:45:04 +00001086 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001087 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001088 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001089 }else if( pPager->state==PAGER_SYNCED ){
1090 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001091 }
danielk1977334cdb62007-03-26 08:05:12 +00001092 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001093 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001094 pPager->needSync = 0;
danielk19778c0a7912008-08-20 14:49:23 +00001095 /* lruListSetFirstSynced(pPager); */
danielk1977b3175382008-10-17 18:51:52 +00001096 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00001097 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00001098 }
drhd138c012008-05-13 00:58:18 +00001099 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001100
1101 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001102}
1103
drhed7c8552001-04-11 14:29:21 +00001104/*
drh968af522003-02-11 14:55:40 +00001105** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001106**
1107** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001108** random initial value and the page number. We experimented with
1109** a checksum of the entire data, but that was found to be too slow.
1110**
1111** Note that the page number is stored at the beginning of data and
1112** the checksum is stored at the end. This is important. If journal
1113** corruption occurs due to a power failure, the most likely scenario
1114** is that one end or the other of the record will be changed. It is
1115** much less likely that the two ends of the journal record will be
1116** correct and the middle be corrupt. Thus, this "checksum" scheme,
1117** though fast and simple, catches the mostly likely kind of corruption.
1118**
1119** FIX ME: Consider adding every 200th (or so) byte of the data to the
1120** checksum. That way if a single page spans 3 or more disk sectors and
1121** only the middle sector is corrupt, we will still have a reasonable
1122** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001123*/
drh74161702006-02-24 02:53:49 +00001124static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001125 u32 cksum = pPager->cksumInit;
1126 int i = pPager->pageSize-200;
1127 while( i>0 ){
1128 cksum += aData[i];
1129 i -= 200;
1130 }
drh968af522003-02-11 14:55:40 +00001131 return cksum;
1132}
1133
1134/*
drhfa86c412002-02-02 15:01:15 +00001135** Read a single page from the journal file opened on file descriptor
1136** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001137**
drhc13148f2008-08-27 18:03:20 +00001138** The isMainJrnl flag is true if this is the main rollback journal and
1139** false for the statement journal. The main rollback journal uses
1140** checksums - the statement journal does not.
drhfa86c412002-02-02 15:01:15 +00001141*/
danielk197762079062007-08-15 17:08:46 +00001142static int pager_playback_one_page(
danielk1977fd7f0452008-12-17 17:30:26 +00001143 Pager *pPager, /* The pager being played back */
1144 int isMainJrnl, /* 1 -> main journal. 0 -> sub-journal. */
1145 i64 offset, /* Offset of record to playback */
danielk1977ecfef982008-12-20 08:39:57 +00001146 int isSavepnt, /* True for a savepoint rollback */
danielk1977fd7f0452008-12-17 17:30:26 +00001147 Bitvec *pDone /* Bitvec of pages already played back */
danielk197762079062007-08-15 17:08:46 +00001148){
drhfa86c412002-02-02 15:01:15 +00001149 int rc;
drhae2b40c2004-06-09 19:03:54 +00001150 PgHdr *pPg; /* An existing page in the cache */
1151 Pgno pgno; /* The page number of a page in journal */
1152 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001153 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
danielk1977fd7f0452008-12-17 17:30:26 +00001154 sqlite3_file *jfd = (isMainJrnl ? pPager->jfd : pPager->sjfd);
drhfa86c412002-02-02 15:01:15 +00001155
danielk1977fd7f0452008-12-17 17:30:26 +00001156 /* The temp storage must be allocated at this point */
danielk19778186df82007-03-06 13:45:59 +00001157 assert( aData );
danielk1977488af092008-12-19 16:31:11 +00001158 assert( isMainJrnl || pDone );
danielk1977ecfef982008-12-20 08:39:57 +00001159 assert( isSavepnt || pDone==0 );
drh96362842005-03-20 22:47:56 +00001160
danielk197762079062007-08-15 17:08:46 +00001161 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001162 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001163 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001164 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001165 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001166
drh968af522003-02-11 14:55:40 +00001167 /* Sanity checking on the page. This is more important that I originally
1168 ** thought. If a power failure occurs while the journal is being written,
1169 ** it could cause invalid data to be written into the journal. We need to
1170 ** detect this invalid data (with high probability) and ignore it.
1171 */
danielk197775edc162004-06-26 01:48:18 +00001172 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001173 return SQLITE_DONE;
1174 }
danielk1977fd7f0452008-12-17 17:30:26 +00001175 if( pgno>(Pgno)pPager->dbSize || sqlite3BitvecTest(pDone, pgno) ){
drh968af522003-02-11 14:55:40 +00001176 return SQLITE_OK;
1177 }
drhc13148f2008-08-27 18:03:20 +00001178 if( isMainJrnl ){
danielk197762079062007-08-15 17:08:46 +00001179 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001180 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001181 pPager->journalOff += 4;
danielk1977ecfef982008-12-20 08:39:57 +00001182 if( !isSavepnt && pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001183 return SQLITE_DONE;
1184 }
1185 }
danielk1977fd7f0452008-12-17 17:30:26 +00001186 if( pDone && (rc = sqlite3BitvecSet(pDone, pgno)) ){
1187 return rc;
1188 }
drhfa86c412002-02-02 15:01:15 +00001189
danielk1977aa5ccdf2004-06-14 05:10:42 +00001190 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001191
1192 /* If the pager is in RESERVED state, then there must be a copy of this
1193 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001194 ** not the database file. The page is left marked dirty in this case.
1195 **
danielk19772df71c72007-05-24 07:22:42 +00001196 ** An exception to the above rule: If the database is in no-sync mode
1197 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001198 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1199 ** during a Movepage() call, then the page may not be in the cache
1200 ** either. So the condition described in the above paragraph is not
1201 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001202 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001203 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1204 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001205 **
1206 ** Ticket #1171: The statement journal might contain page content that is
1207 ** different from the page content at the start of the transaction.
1208 ** This occurs when a page is changed prior to the start of a statement
1209 ** then changed again within the statement. When rolling back such a
1210 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001211 ** for certain that original page contents are synced into the main rollback
1212 ** journal. Otherwise, a power loss might leave modified data in the
1213 ** database file without an entry in the rollback journal that can
1214 ** restore the database to its original form. Two conditions must be
1215 ** met before writing to the database files. (1) the database must be
1216 ** locked. (2) we know that the original page content is fully synced
1217 ** in the main journal either because the page is not in cache or else
1218 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001219 **
1220 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1221 ** is possible to fail a statement on a database that does not yet exist.
1222 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001223 */
drhae2b40c2004-06-09 19:03:54 +00001224 pPg = pager_lookup(pPager, pgno);
danielk1977ecfef982008-12-20 08:39:57 +00001225 PAGERTRACE5("PLAYBACK %d page %d hash(%08x) %s\n",
1226 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData),
1227 (isMainJrnl?"main-journal":"sub-journal")
1228 );
danielk19778c0a7912008-08-20 14:49:23 +00001229 if( (pPager->state>=PAGER_EXCLUSIVE)
1230 && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC))
1231 && (pPager->fd->pMethods)
1232 ){
drh281b21d2008-08-22 12:57:08 +00001233 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
1234 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst);
danielk1977a3f3a5f2004-06-10 04:32:16 +00001235 }
drhfa86c412002-02-02 15:01:15 +00001236 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001237 /* No page should ever be explicitly rolled back that is in use, except
1238 ** for page 1 which is held in use in order to keep the lock on the
1239 ** database active. However such a page may be rolled back as a result
1240 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001241 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001242 */
drhb6f41482004-05-14 01:58:11 +00001243 void *pData;
danielk19778c0a7912008-08-20 14:49:23 +00001244 pData = pPg->pData;
drhae2b40c2004-06-09 19:03:54 +00001245 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001246 if( pPager->xReiniter ){
danielk1977eaa06f62008-09-18 17:34:44 +00001247 pPager->xReiniter(pPg);
drhde647132004-05-07 17:57:49 +00001248 }
danielk1977ecfef982008-12-20 08:39:57 +00001249 if( isMainJrnl && (!isSavepnt || pPager->journalOff<=pPager->journalHdr) ){
danielk1977488af092008-12-19 16:31:11 +00001250 /* If the contents of this page were just restored from the main
1251 ** journal file, then its content must be as they were when the
1252 ** transaction was first opened. In this case we can mark the page
1253 ** as clean, since there will be no need to write it out to the.
1254 **
1255 ** There is one exception to this rule. If the page is being rolled
1256 ** back as part of a savepoint (or statement) rollback from an
1257 ** unsynced portion of the main journal file, then it is not safe
1258 ** to mark the page as clean. This is because marking the page as
1259 ** clean will clear the PGHDR_NEED_SYNC flag. Since the page is
1260 ** already in the journal file (recorded in Pager.pInJournal) and
1261 ** the PGHDR_NEED_SYNC flag is cleared, if the page is written to
1262 ** again within this transaction, it will be marked as dirty but
1263 ** the PGHDR_NEED_SYNC flag will not be set. It could then potentially
1264 ** be written out into the database file before its journal file
1265 ** segment is synced. If a crash occurs during or following this,
1266 ** database corruption may ensue.
1267 */
drhc047b9f2008-11-21 03:23:43 +00001268 sqlite3PcacheMakeClean(pPg);
1269 }
danielk19773c407372005-02-15 02:54:14 +00001270#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001271 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001272#endif
drh86a88112007-04-16 15:02:19 +00001273 /* If this was page 1, then restore the value of Pager.dbFileVers.
1274 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001275 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001276 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001277 }
drh86a88112007-04-16 15:02:19 +00001278
1279 /* Decode the page just read from disk */
1280 CODEC1(pPager, pData, pPg->pgno, 3);
danielk19778c0a7912008-08-20 14:49:23 +00001281 sqlite3PcacheRelease(pPg);
drhfa86c412002-02-02 15:01:15 +00001282 }
1283 return rc;
1284}
1285
1286/*
danielk197713adf8a2004-06-03 16:08:41 +00001287** Parameter zMaster is the name of a master journal file. A single journal
1288** file that referred to the master journal file has just been rolled back.
1289** This routine checks if it is possible to delete the master journal file,
1290** and does so if it is.
drh726de592004-06-10 23:35:50 +00001291**
danielk197765839c62007-08-30 08:08:17 +00001292** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1293** available for use within this function.
1294**
1295**
drh726de592004-06-10 23:35:50 +00001296** The master journal file contains the names of all child journals.
1297** To tell if a master journal can be deleted, check to each of the
1298** children. If all children are either missing or do not refer to
1299** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001300*/
danielk1977b4b47412007-08-17 15:53:36 +00001301static int pager_delmaster(Pager *pPager, const char *zMaster){
1302 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001303 int rc;
1304 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001305 sqlite3_file *pMaster;
1306 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001307 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001308 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001309
1310 /* Open the master journal file exclusively in case some other process
1311 ** is running this routine also. Not that it makes too much difference.
1312 */
drhe5ae5732008-06-15 02:51:47 +00001313 pMaster = (sqlite3_file *)sqlite3Malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001314 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001315 if( !pMaster ){
1316 rc = SQLITE_NOMEM;
1317 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001318 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1319 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001320 }
danielk197713adf8a2004-06-03 16:08:41 +00001321 if( rc!=SQLITE_OK ) goto delmaster_out;
1322 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001323
1324 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001325 if( rc!=SQLITE_OK ) goto delmaster_out;
1326
1327 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001328 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001329 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001330 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001331
1332 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001333 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001334 */
drh4f21c4a2008-12-10 22:15:00 +00001335 zMasterJournal = (char *)sqlite3Malloc((int)nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001336 if( !zMasterJournal ){
1337 rc = SQLITE_NOMEM;
1338 goto delmaster_out;
1339 }
danielk197765839c62007-08-30 08:08:17 +00001340 zMasterPtr = &zMasterJournal[nMasterJournal];
drh4f21c4a2008-12-10 22:15:00 +00001341 rc = sqlite3OsRead(pMaster, zMasterJournal, (int)nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001342 if( rc!=SQLITE_OK ) goto delmaster_out;
1343
danielk19775865e3d2004-06-14 06:03:57 +00001344 zJournal = zMasterJournal;
1345 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977861f7452008-06-05 11:39:11 +00001346 int exists;
1347 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
1348 if( rc!=SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001349 goto delmaster_out;
1350 }
danielk1977861f7452008-06-05 11:39:11 +00001351 if( exists ){
danielk197713adf8a2004-06-03 16:08:41 +00001352 /* One of the journals pointed to by the master journal exists.
1353 ** Open it and check if it points at the master journal. If
1354 ** so, return without deleting the master journal file.
1355 */
drh3b7b78b2004-11-24 01:16:43 +00001356 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001357 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1358 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001359 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001360 goto delmaster_out;
1361 }
danielk197713adf8a2004-06-03 16:08:41 +00001362
danielk197765839c62007-08-30 08:08:17 +00001363 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001364 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001365 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001366 goto delmaster_out;
1367 }
danielk197776572402004-06-25 02:38:54 +00001368
danielk197765839c62007-08-30 08:08:17 +00001369 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001370 if( c ){
danielk197776572402004-06-25 02:38:54 +00001371 /* We have a match. Do not delete the master journal file. */
1372 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001373 }
1374 }
drhea678832008-12-10 19:26:22 +00001375 zJournal += (sqlite3Strlen30(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001376 }
1377 }
1378
danielk1977fee2d252007-08-18 10:59:19 +00001379 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001380
1381delmaster_out:
1382 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001383 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001384 }
1385 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001386 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001387 }
danielk1977b4b47412007-08-17 15:53:36 +00001388 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001389 return rc;
1390}
1391
drha6abd042004-06-09 17:37:22 +00001392
danielk1977e180dd92007-04-05 17:15:52 +00001393static void pager_truncate_cache(Pager *pPager);
1394
drha6abd042004-06-09 17:37:22 +00001395/*
drhcb4c40b2004-08-18 19:09:43 +00001396** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001397** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001398**
1399** Might might be the case that the file on disk is smaller than nPage.
1400** This can happen, for example, if we are in the middle of a transaction
1401** which has extended the file size and the new pages are still all held
1402** in cache, then an INSERT or UPDATE does a statement rollback. Some
1403** operating system implementations can get confused if you try to
1404** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001405** so detect this case and write a single zero byte to the end of the new
1406** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001407*/
danielk1977d92db532008-11-17 04:56:24 +00001408static int pager_truncate(Pager *pPager, Pgno nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001409 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001410 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001411 i64 currentSize, newSize;
1412 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1413 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001414 if( rc==SQLITE_OK && currentSize!=newSize ){
1415 if( currentSize>newSize ){
1416 rc = sqlite3OsTruncate(pPager->fd, newSize);
1417 }else{
1418 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1419 }
drh7fe3f7e2007-11-29 18:44:27 +00001420 }
danielk1977e180dd92007-04-05 17:15:52 +00001421 }
1422 if( rc==SQLITE_OK ){
1423 pPager->dbSize = nPage;
1424 pager_truncate_cache(pPager);
1425 }
1426 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001427}
1428
1429/*
drhc80f0582007-05-01 16:59:48 +00001430** Set the sectorSize for the given pager.
1431**
drh334c80d2008-03-28 17:41:13 +00001432** The sector size is at least as big as the sector size reported
1433** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001434*/
1435static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001436 assert(pPager->fd->pMethods||pPager->tempFile);
1437 if( !pPager->tempFile ){
1438 /* Sector size doesn't matter for temporary files. Also, the file
1439 ** may not have been opened yet, in whcih case the OsSectorSize()
1440 ** call will segfault.
1441 */
1442 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1443 }
drh334c80d2008-03-28 17:41:13 +00001444 if( pPager->sectorSize<512 ){
1445 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001446 }
1447}
1448
1449/*
drhed7c8552001-04-11 14:29:21 +00001450** Playback the journal and thus restore the database file to
1451** the state it was in before we started making changes.
1452**
drh34e79ce2004-02-08 06:05:46 +00001453** The journal file format is as follows:
1454**
drhae2b40c2004-06-09 19:03:54 +00001455** (1) 8 byte prefix. A copy of aJournalMagic[].
1456** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001457** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001458** number of page records from the journal size.
1459** (3) 4 byte big-endian integer which is the initial value for the
1460** sanity checksum.
1461** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001462** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001463** (5) 4 byte big-endian integer which is the sector size. The header
1464** is this many bytes in size.
1465** (6) 4 byte big-endian integer which is the page case.
1466** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001467** name. The value may be zero (indicate that there is no master
1468** journal.)
drh334c80d2008-03-28 17:41:13 +00001469** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001470** and might be shorter than the value read from (5). If the first byte
1471** of the name is \000 then there is no master journal. The master
1472** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001473** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001474** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001475** + pPager->pageSize bytes of data.
1476** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001477**
drh334c80d2008-03-28 17:41:13 +00001478** When we speak of the journal header, we mean the first 8 items above.
1479** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001480**
1481** Call the value from the second bullet "nRec". nRec is the number of
1482** valid page entries in the journal. In most cases, you can compute the
1483** value of nRec from the size of the journal file. But if a power
1484** failure occurred while the journal was being written, it could be the
1485** case that the size of the journal file had already been increased but
1486** the extra entries had not yet made it safely to disk. In such a case,
1487** the value of nRec computed from the file size would be too large. For
1488** that reason, we always use the nRec value in the header.
1489**
1490** If the nRec value is 0xffffffff it means that nRec should be computed
1491** from the file size. This value is used when the user selects the
1492** no-sync option for the journal. A power failure could lead to corruption
1493** in this case. But for things like temporary table (which will be
1494** deleted when the power is restored) we don't care.
1495**
drhd9b02572001-04-15 00:37:09 +00001496** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001497** journal file then all pages up to the first corrupted page are rolled
1498** back (or no pages if the journal header is corrupted). The journal file
1499** is then deleted and SQLITE_OK returned, just as if no corruption had
1500** been encountered.
1501**
1502** If an I/O or malloc() error occurs, the journal-file is not deleted
1503** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001504*/
danielk1977e277be02007-03-23 18:12:06 +00001505static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001506 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001507 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001508 u32 nRec; /* Number of Records in the journal */
shane0b8d2762008-07-22 05:18:00 +00001509 u32 u; /* Unsigned loop counter */
drhd9b02572001-04-15 00:37:09 +00001510 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001511 int rc; /* Result code of a subroutine */
danielk1977861f7452008-06-05 11:39:11 +00001512 int res = 1; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001513 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001514
drhc3a64ba2001-11-22 00:01:27 +00001515 /* Figure out how many records are in the journal. Abort early if
1516 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001517 */
drh8cfbf082001-09-19 13:22:39 +00001518 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001519 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001520 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001521 goto end_playback;
1522 }
drh240c5792004-02-08 00:40:52 +00001523
danielk197776572402004-06-25 02:38:54 +00001524 /* Read the master journal name from the journal, if it is present.
1525 ** If a master journal file name is specified, but the file is not
1526 ** present on disk, then the journal is not hot and does not need to be
1527 ** played back.
drh240c5792004-02-08 00:40:52 +00001528 */
danielk197765839c62007-08-30 08:08:17 +00001529 zMaster = pPager->pTmpSpace;
1530 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977861f7452008-06-05 11:39:11 +00001531 if( rc==SQLITE_OK && zMaster[0] ){
1532 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
drhc3a64ba2001-11-22 00:01:27 +00001533 }
danielk197765839c62007-08-30 08:08:17 +00001534 zMaster = 0;
danielk1977861f7452008-06-05 11:39:11 +00001535 if( rc!=SQLITE_OK || !res ){
danielk1977ce98bba2008-04-03 10:13:01 +00001536 goto end_playback;
1537 }
1538 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001539
danielk197776572402004-06-25 02:38:54 +00001540 /* This loop terminates either when the readJournalHdr() call returns
1541 ** SQLITE_DONE or an IO error occurs. */
1542 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001543
danielk197776572402004-06-25 02:38:54 +00001544 /* Read the next journal header from the journal file. If there are
1545 ** not enough bytes left in the journal file for a complete header, or
1546 ** it is corrupted, then a process must of failed while writing it.
1547 ** This indicates nothing more needs to be rolled back.
1548 */
1549 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1550 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001551 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001552 rc = SQLITE_OK;
1553 }
danielk197776572402004-06-25 02:38:54 +00001554 goto end_playback;
1555 }
1556
1557 /* If nRec is 0xffffffff, then this journal was created by a process
1558 ** working in no-sync mode. This means that the rest of the journal
1559 ** file consists of pages, there are no more journal headers. Compute
1560 ** the value of nRec based on this assumption.
1561 */
1562 if( nRec==0xffffffff ){
1563 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
drh4f21c4a2008-12-10 22:15:00 +00001564 nRec = (int)((szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager));
danielk197776572402004-06-25 02:38:54 +00001565 }
1566
danielk1977e277be02007-03-23 18:12:06 +00001567 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001568 ** process and if this is the final header in the journal, then it means
1569 ** that this part of the journal was being filled but has not yet been
1570 ** synced to disk. Compute the number of pages based on the remaining
1571 ** size of the file.
1572 **
1573 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001574 */
drh8940f4e2007-08-11 00:26:20 +00001575 if( nRec==0 && !isHot &&
1576 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
drh4f21c4a2008-12-10 22:15:00 +00001577 nRec = (int)((szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager));
danielk1977e277be02007-03-23 18:12:06 +00001578 }
1579
danielk197776572402004-06-25 02:38:54 +00001580 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001581 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001582 */
danielk1977e180dd92007-04-05 17:15:52 +00001583 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001584 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001585 if( rc!=SQLITE_OK ){
1586 goto end_playback;
1587 }
danielk197776572402004-06-25 02:38:54 +00001588 }
1589
danielk197776572402004-06-25 02:38:54 +00001590 /* Copy original pages out of the journal and back into the database file.
1591 */
shane0b8d2762008-07-22 05:18:00 +00001592 for(u=0; u<nRec; u++){
danielk1977ecfef982008-12-20 08:39:57 +00001593 rc = pager_playback_one_page(pPager, 1, pPager->journalOff, 0, 0);
danielk197776572402004-06-25 02:38:54 +00001594 if( rc!=SQLITE_OK ){
1595 if( rc==SQLITE_DONE ){
1596 rc = SQLITE_OK;
1597 pPager->journalOff = szJ;
1598 break;
1599 }else{
drha9625ea2008-09-03 00:08:29 +00001600 /* If we are unable to rollback, then the database is probably
1601 ** going to end up being corrupt. It is corrupt to us, anyhow.
1602 ** Perhaps the next process to come along can fix it....
1603 */
danielk197798c21902008-09-23 16:41:29 +00001604 rc = SQLITE_CORRUPT_BKPT;
danielk197776572402004-06-25 02:38:54 +00001605 goto end_playback;
1606 }
1607 }
drh968af522003-02-11 14:55:40 +00001608 }
drhed7c8552001-04-11 14:29:21 +00001609 }
drh580eeaf2006-02-24 03:09:37 +00001610 /*NOTREACHED*/
1611 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001612
1613end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001614 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001615 zMaster = pPager->pTmpSpace;
1616 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1617 }
1618 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001619 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001620 }
danielk1977c56774e2008-10-07 11:51:20 +00001621 if( rc==SQLITE_OK && zMaster[0] && res ){
danielk1977979f38e2007-03-27 16:19:51 +00001622 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001623 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001624 */
danielk197765839c62007-08-30 08:08:17 +00001625 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001626 }
danielk197776572402004-06-25 02:38:54 +00001627
1628 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001629 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001630 ** value. Reset it to the correct value for this process.
1631 */
drhc80f0582007-05-01 16:59:48 +00001632 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001633 return rc;
drhed7c8552001-04-11 14:29:21 +00001634}
1635
1636/*
danielk1977fd7f0452008-12-17 17:30:26 +00001637** Playback a savepoint.
drhfa86c412002-02-02 15:01:15 +00001638*/
danielk1977fd7f0452008-12-17 17:30:26 +00001639static int pagerPlaybackSavepoint(Pager *pPager, PagerSavepoint *pSavepoint){
drheb206252004-10-01 02:00:31 +00001640 i64 szJ; /* Size of the full journal */
danielk1977fd7f0452008-12-17 17:30:26 +00001641 i64 iHdrOff; /* End of first segment of main-journal records */
1642 Pgno ii; /* Loop counter */
1643 int rc; /* Return code */
1644 Bitvec *pDone = 0; /* Bitvec to ensure pages played back only once */
drhfa86c412002-02-02 15:01:15 +00001645
danielk1977fd7f0452008-12-17 17:30:26 +00001646 /* Allocate a bitvec to use to store the set of pages rolled back */
1647 if( pSavepoint ){
1648 pDone = sqlite3BitvecCreate(pSavepoint->nOrig);
1649 if( !pDone ){
1650 return SQLITE_NOMEM;
1651 }
danielk197776572402004-06-25 02:38:54 +00001652 }
danielk1977fd7f0452008-12-17 17:30:26 +00001653
1654 /* Truncate the database back to the size it was before the
1655 ** savepoint being reverted was opened.
drhfa86c412002-02-02 15:01:15 +00001656 */
danielk1977fd7f0452008-12-17 17:30:26 +00001657 rc = pager_truncate(pPager, pSavepoint?pSavepoint->nOrig:pPager->origDbSize);
drh1aa2d8b2007-01-03 15:34:29 +00001658 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001659
danielk1977fd7f0452008-12-17 17:30:26 +00001660 /* Now roll back all main journal file records that occur after byte
1661 ** byte offset PagerSavepoint.iOffset that have a page number less than
1662 ** or equal to PagerSavepoint.nOrig. As each record is played back,
1663 ** the corresponding bit in bitvec PagerSavepoint.pInSavepoint is
1664 ** cleared.
drhfa86c412002-02-02 15:01:15 +00001665 */
danielk1977fd7f0452008-12-17 17:30:26 +00001666 szJ = pPager->journalOff;
1667 if( pSavepoint ){
1668 iHdrOff = pSavepoint->iHdrOffset ? pSavepoint->iHdrOffset : szJ;
1669 pPager->journalOff = pSavepoint->iOffset;
1670 while( rc==SQLITE_OK && pPager->journalOff<iHdrOff ){
danielk1977ecfef982008-12-20 08:39:57 +00001671 rc = pager_playback_one_page(pPager, 1, pPager->journalOff, 1, pDone);
danielk1977fd7f0452008-12-17 17:30:26 +00001672 assert( rc!=SQLITE_DONE );
1673 }
1674 }else{
1675 pPager->journalOff = 0;
drhfa86c412002-02-02 15:01:15 +00001676 }
danielk1977fd7f0452008-12-17 17:30:26 +00001677 while( rc==SQLITE_OK && pPager->journalOff<szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001678 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001679 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001680 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
danielk1977fd7f0452008-12-17 17:30:26 +00001681 assert( rc!=SQLITE_DONE );
danielk1977f0113002006-01-24 12:09:17 +00001682 if( nJRec==0 ){
danielk1977fd7f0452008-12-17 17:30:26 +00001683 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001684 }
danielk197712dd5492008-12-18 15:45:07 +00001685 for(ii=0; rc==SQLITE_OK && ii<nJRec && pPager->journalOff<szJ; ii++){
danielk1977ecfef982008-12-20 08:39:57 +00001686 rc = pager_playback_one_page(pPager, 1, pPager->journalOff, 1, pDone);
danielk197776572402004-06-25 02:38:54 +00001687 assert( rc!=SQLITE_DONE );
danielk1977fd7f0452008-12-17 17:30:26 +00001688 }
1689 }
1690 assert( rc!=SQLITE_OK || pPager->journalOff==szJ );
1691
1692 /* Now roll back pages from the sub-journal. */
1693 if( pSavepoint ){
1694 for(ii=pSavepoint->iSubRec; rc==SQLITE_OK && ii<pPager->stmtNRec; ii++){
1695 i64 offset = ii*(4+pPager->pageSize);
danielk1977ecfef982008-12-20 08:39:57 +00001696 rc = pager_playback_one_page(pPager, 0, offset, 1, pDone);
danielk1977fd7f0452008-12-17 17:30:26 +00001697 assert( rc!=SQLITE_DONE );
danielk197776572402004-06-25 02:38:54 +00001698 }
drhfa86c412002-02-02 15:01:15 +00001699 }
danielk197776572402004-06-25 02:38:54 +00001700
danielk1977fd7f0452008-12-17 17:30:26 +00001701 sqlite3BitvecDestroy(pDone);
1702 if( rc==SQLITE_OK ){
danielk197775edc162004-06-26 01:48:18 +00001703 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001704 }
1705 return rc;
1706}
1707
1708/*
drhf57b14a2001-09-14 18:54:08 +00001709** Change the maximum number of in-memory pages that are allowed.
1710*/
danielk19773b8a05f2007-03-19 17:44:26 +00001711void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
danielk19778c0a7912008-08-20 14:49:23 +00001712 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001713}
1714
1715/*
drh973b6e32003-02-12 14:09:42 +00001716** Adjust the robustness of the database to damage due to OS crashes
1717** or power failures by changing the number of syncs()s when writing
1718** the rollback journal. There are three levels:
1719**
drh054889e2005-11-30 03:20:31 +00001720** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001721** for temporary and transient files.
1722**
1723** NORMAL The journal is synced once before writes begin on the
1724** database. This is normally adequate protection, but
1725** it is theoretically possible, though very unlikely,
1726** that an inopertune power failure could leave the journal
1727** in a state which would cause damage to the database
1728** when it is rolled back.
1729**
1730** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001731** database (with some additional information - the nRec field
1732** of the journal header - being written in between the two
1733** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001734** single disk sector is atomic, then this mode provides
1735** assurance that the journal will not be corrupted to the
1736** point of causing damage to the database during rollback.
1737**
1738** Numeric values associated with these states are OFF==1, NORMAL=2,
1739** and FULL=3.
1740*/
danielk197793758c82005-01-21 08:13:14 +00001741#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh281b21d2008-08-22 12:57:08 +00001742void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){
drh4f21c4a2008-12-10 22:15:00 +00001743 pPager->noSync = (level==1 || pPager->tempFile) ?1:0;
1744 pPager->fullSync = (level==3 && !pPager->tempFile) ?1:0;
drh281b21d2008-08-22 12:57:08 +00001745 pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001746 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001747}
danielk197793758c82005-01-21 08:13:14 +00001748#endif
drh973b6e32003-02-12 14:09:42 +00001749
1750/*
drhaf6df112005-06-07 02:12:30 +00001751** The following global variable is incremented whenever the library
1752** attempts to open a temporary file. This information is used for
1753** testing and analysis only.
1754*/
drh0f7eb612006-08-08 13:51:43 +00001755#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001756int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001757#endif
drhaf6df112005-06-07 02:12:30 +00001758
1759/*
drh3f56e6e2007-03-15 01:16:47 +00001760** Open a temporary file.
1761**
1762** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001763** other error code if we fail. The OS will automatically delete the temporary
1764** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001765*/
danielk1977b4b47412007-08-17 15:53:36 +00001766static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00001767 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00001768 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00001769 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00001770){
drhfa86c412002-02-02 15:01:15 +00001771 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001772
drh0f7eb612006-08-08 13:51:43 +00001773#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001774 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001775#endif
danielk1977b4b47412007-08-17 15:53:36 +00001776
drh33f4e022007-09-03 15:19:34 +00001777 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
1778 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00001779 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00001780 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00001781 return rc;
1782}
1783
danielk1977a858aa22008-08-22 16:22:17 +00001784static int pagerStress(void *,PgHdr *);
danielk19778c0a7912008-08-20 14:49:23 +00001785
drhfa86c412002-02-02 15:01:15 +00001786/*
drhed7c8552001-04-11 14:29:21 +00001787** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001788** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001789** the first call to sqlite3PagerGet() and is only held open until the
1790** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001791**
drh6446c4d2001-12-15 14:22:18 +00001792** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00001793** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00001794** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001795**
1796** If zFilename is ":memory:" then all information is held in cache.
1797** It is never written to disk. This can be used to implement an
1798** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001799*/
danielk19773b8a05f2007-03-19 17:44:26 +00001800int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001801 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001802 Pager **ppPager, /* Return the Pager structure here */
1803 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001804 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00001805 int flags, /* flags controlling this file */
1806 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00001807){
danielk1977b4b47412007-08-17 15:53:36 +00001808 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001809 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001810 int rc = SQLITE_OK;
1811 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001812 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001813 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001814 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001815 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1816 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977b3175382008-10-17 18:51:52 +00001817 int journalFileSize;
danielk19778c0a7912008-08-20 14:49:23 +00001818 int pcacheSize = sqlite3PcacheSize();
drhfacf0302008-06-17 15:12:00 +00001819 int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00001820 char *zPathname = 0;
1821 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001822
danielk1977b3175382008-10-17 18:51:52 +00001823 if( sqlite3JournalSize(pVfs)>sqlite3MemJournalSize() ){
1824 journalFileSize = sqlite3JournalSize(pVfs);
1825 }else{
1826 journalFileSize = sqlite3MemJournalSize();
1827 }
1828
drh86f8c192007-08-22 00:39:19 +00001829 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001830 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001831
danielk197717b90b52008-06-06 11:11:25 +00001832 /* Compute and store the full pathname in an allocated buffer pointed
1833 ** to by zPathname, length nPathname. Or, if this is a temporary file,
1834 ** leave both nPathname and zPathname set to 0.
1835 */
drh1cc8c442007-08-24 16:08:29 +00001836 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00001837 nPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001838 zPathname = sqlite3Malloc(nPathname*2);
danielk197717b90b52008-06-06 11:11:25 +00001839 if( zPathname==0 ){
1840 return SQLITE_NOMEM;
1841 }
drh1cc8c442007-08-24 16:08:29 +00001842#ifndef SQLITE_OMIT_MEMORYDB
1843 if( strcmp(zFilename,":memory:")==0 ){
1844 memDb = 1;
1845 zPathname[0] = 0;
1846 }else
1847#endif
1848 {
danielk1977adfb9b02007-09-17 07:02:56 +00001849 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00001850 }
danielk197717b90b52008-06-06 11:11:25 +00001851 if( rc!=SQLITE_OK ){
1852 sqlite3_free(zPathname);
1853 return rc;
1854 }
drhea678832008-12-10 19:26:22 +00001855 nPathname = sqlite3Strlen30(zPathname);
drhae28c012007-08-24 16:29:23 +00001856 }
drh99b90c32008-03-17 13:50:58 +00001857
danielk1977b4b47412007-08-17 15:53:36 +00001858 /* Allocate memory for the pager structure */
1859 pPager = sqlite3MallocZero(
1860 sizeof(*pPager) + /* Pager structure */
danielk19778c0a7912008-08-20 14:49:23 +00001861 pcacheSize + /* PCache object */
danielk1977c7b60172007-08-22 11:22:03 +00001862 journalFileSize + /* The journal file structure */
danielk1977b3175382008-10-17 18:51:52 +00001863 pVfs->szOsFile + /* The main db file */
1864 journalFileSize * 2 + /* The two journal files */
danielk197717b90b52008-06-06 11:11:25 +00001865 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00001866 );
1867 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00001868 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00001869 return SQLITE_NOMEM;
1870 }
danielk19778c0a7912008-08-20 14:49:23 +00001871 pPager->pPCache = (PCache *)&pPager[1];
1872 pPtr = ((u8 *)&pPager[1]) + pcacheSize;
drh33f4e022007-09-03 15:19:34 +00001873 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00001874 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977fd7f0452008-12-17 17:30:26 +00001875 pPager->sjfd = (sqlite3_file*)&pPtr[pVfs->szOsFile];
danielk1977b3175382008-10-17 18:51:52 +00001876 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile+journalFileSize];
1877 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile+2*journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00001878 pPager->zDirectory = &pPager->zFilename[nPathname+1];
1879 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00001880 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00001881 if( zPathname ){
1882 memcpy(pPager->zFilename, zPathname, nPathname+1);
1883 sqlite3_free(zPathname);
1884 }
danielk1977b4b47412007-08-17 15:53:36 +00001885
drh153c62c2007-08-24 03:51:33 +00001886 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00001887 */
drhae28c012007-08-24 16:29:23 +00001888 if( zFilename && zFilename[0] && !memDb ){
danielk1977d92db532008-11-17 04:56:24 +00001889 if( nPathname>(pVfs->mxPathname - (int)sizeof("-journal")) ){
drh1cc8c442007-08-24 16:08:29 +00001890 rc = SQLITE_CANTOPEN;
1891 }else{
drh1cc8c442007-08-24 16:08:29 +00001892 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00001893 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
1894 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00001895 readOnly = (fout&SQLITE_OPEN_READONLY);
1896
1897 /* If the file was successfully opened for read/write access,
1898 ** choose a default page size in case we have to create the
1899 ** database file. The default page size is the maximum of:
1900 **
1901 ** + SQLITE_DEFAULT_PAGE_SIZE,
1902 ** + The value returned by sqlite3OsSectorSize()
1903 ** + The largest page size that can be written atomically.
1904 */
1905 if( rc==SQLITE_OK && !readOnly ){
1906 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
drhfacf0302008-06-17 15:12:00 +00001907 if( szPageDflt<iSectorSize ){
1908 szPageDflt = iSectorSize;
drh1cc8c442007-08-24 16:08:29 +00001909 }
danielk19779663b8f2007-08-24 11:52:28 +00001910#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00001911 {
1912 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
1913 int ii;
1914 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1915 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1916 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
drhfacf0302008-06-17 15:12:00 +00001917 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
1918 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii;
danielk19779663b8f2007-08-24 11:52:28 +00001919 }
danielk1977b4b47412007-08-17 15:53:36 +00001920 }
drh1cc8c442007-08-24 16:08:29 +00001921#endif
drhfacf0302008-06-17 15:12:00 +00001922 if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
1923 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
drh1cc8c442007-08-24 16:08:29 +00001924 }
danielk19778def5ea2004-06-16 10:39:52 +00001925 }
drhac69b052004-05-12 13:30:07 +00001926 }
danielk1977b3175382008-10-17 18:51:52 +00001927 }else{
danielk19777a2b1ee2007-08-21 14:27:01 +00001928 /* If a temporary file is requested, it is not opened immediately.
1929 ** In this case we accept the default page size and delay actually
1930 ** opening the file until the first call to OsWrite().
danielk1977b3175382008-10-17 18:51:52 +00001931 **
1932 ** This branch is also run for an in-memory database. An in-memory
1933 ** database is the same as a temp-file that is never written out to
1934 ** disk and uses an in-memory rollback journal.
danielk19777a2b1ee2007-08-21 14:27:01 +00001935 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001936 tempFile = 1;
1937 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001938 }
danielk1977aef0bf62005-12-30 16:28:01 +00001939
danielk1977b4b47412007-08-17 15:53:36 +00001940 if( pPager && rc==SQLITE_OK ){
drhfacf0302008-06-17 15:12:00 +00001941 pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt);
drh3e7a6092002-12-07 21:45:14 +00001942 }
danielk1977aef0bf62005-12-30 16:28:01 +00001943
drh153c62c2007-08-24 03:51:33 +00001944 /* If an error occured in either of the blocks above.
1945 ** Free the Pager structure and close the file.
1946 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00001947 ** any Pager.errMask variables.
1948 */
danielk1977b4b47412007-08-17 15:53:36 +00001949 if( !pPager || !pPager->pTmpSpace ){
1950 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001951 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001952 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001953 }
danielk19778c0a7912008-08-20 14:49:23 +00001954 nExtra = FORCE_ALIGNMENT(nExtra);
danielk197771d5d2c2008-09-29 11:49:47 +00001955 sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
drh41d30272008-08-20 21:47:45 +00001956 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
danielk1977aef0bf62005-12-30 16:28:01 +00001957
drh153c62c2007-08-24 03:51:33 +00001958 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
1959 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00001960
danielk1977b4b47412007-08-17 15:53:36 +00001961 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00001962 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
drhea678832008-12-10 19:26:22 +00001963 for(i=sqlite3Strlen30(pPager->zDirectory);
1964 i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001965 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001966
drh99b90c32008-03-17 13:50:58 +00001967 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00001968 if( zPathname ){
1969 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
1970 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
1971 }else{
1972 pPager->zJournal = 0;
1973 }
danielk1977b4b47412007-08-17 15:53:36 +00001974
drh3b59a5c2006-01-15 20:28:28 +00001975 /* pPager->journalOpen = 0; */
drh4f21c4a2008-12-10 22:15:00 +00001976 pPager->useJournal = (u8)useJournal;
1977 pPager->noReadlock = (noReadlock && readOnly) ?1:0;
drh3b59a5c2006-01-15 20:28:28 +00001978 /* pPager->stmtOpen = 0; */
1979 /* pPager->stmtInUse = 0; */
1980 /* pPager->nRef = 0; */
drh4f21c4a2008-12-10 22:15:00 +00001981 pPager->dbSizeValid = (u8)memDb;
drhfacf0302008-06-17 15:12:00 +00001982 pPager->pageSize = szPageDflt;
drh3b59a5c2006-01-15 20:28:28 +00001983 /* pPager->stmtSize = 0; */
1984 /* pPager->stmtJSize = 0; */
1985 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001986 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001987 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001988 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00001989 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00001990 /* pPager->errMask = 0; */
drh4f21c4a2008-12-10 22:15:00 +00001991 pPager->tempFile = (u8)tempFile;
drh369339d2007-03-30 16:01:55 +00001992 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1993 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1994 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
drh4f21c4a2008-12-10 22:15:00 +00001995 pPager->exclusiveMode = (u8)tempFile;
1996 pPager->memDb = (u8)memDb;
1997 pPager->readOnly = (u8)readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001998 /* pPager->needSync = 0; */
drh4f21c4a2008-12-10 22:15:00 +00001999 pPager->noSync = (pPager->tempFile || !useJournal) ?1:0;
2000 pPager->fullSync = pPager->noSync ?0:1;
danielk1977f036aef2007-08-20 05:36:51 +00002001 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002002 /* pPager->pFirst = 0; */
2003 /* pPager->pFirstSynced = 0; */
2004 /* pPager->pLast = 0; */
danielk19778c0a7912008-08-20 14:49:23 +00002005 pPager->nExtra = nExtra;
danielk1977b53e4962008-06-04 06:45:59 +00002006 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk1977b3175382008-10-17 18:51:52 +00002007 assert(pPager->fd->pMethods||tempFile);
2008 setSectorSize(pPager);
2009 if( memDb ){
2010 pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
danielk1977b4721172007-03-19 05:54:48 +00002011 }
danielk19771ceedd32008-11-19 10:22:33 +00002012 /* pPager->xBusyHandler = 0; */
2013 /* pPager->pBusyHandlerArg = 0; */
drh3b59a5c2006-01-15 20:28:28 +00002014 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002015 *ppPager = pPager;
2016 return SQLITE_OK;
2017}
2018
2019/*
drh90f5ecb2004-07-22 01:19:35 +00002020** Set the busy handler function.
2021*/
danielk19771ceedd32008-11-19 10:22:33 +00002022void sqlite3PagerSetBusyhandler(
2023 Pager *pPager,
2024 int (*xBusyHandler)(void *),
2025 void *pBusyHandlerArg
2026){
2027 pPager->xBusyHandler = xBusyHandler;
2028 pPager->pBusyHandlerArg = pBusyHandlerArg;
drh90f5ecb2004-07-22 01:19:35 +00002029}
2030
2031/*
drha6abd042004-06-09 17:37:22 +00002032** Set the reinitializer for this pager. If not NULL, the reinitializer
2033** is called when the content of a page in cache is restored to its original
2034** value as a result of a rollback. The callback gives higher-level code
2035** an opportunity to restore the EXTRA section to agree with the restored
2036** page data.
2037*/
danielk1977eaa06f62008-09-18 17:34:44 +00002038void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*)){
drha6abd042004-06-09 17:37:22 +00002039 pPager->xReiniter = xReinit;
2040}
2041
2042/*
danielk1977a1644fd2007-08-29 12:31:25 +00002043** Set the page size to *pPageSize. If the suggest new page size is
2044** inappropriate, then an alternative page size is set to that
2045** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002046*/
danielk1977a1644fd2007-08-29 12:31:25 +00002047int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
danielk19771357d9f2008-09-16 05:12:24 +00002048 int rc = pPager->errCode;
2049 if( rc==SQLITE_OK ){
2050 u16 pageSize = *pPageSize;
2051 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
2052 if( pageSize && pageSize!=pPager->pageSize
2053 && (pPager->memDb==0 || pPager->dbSize==0)
2054 && sqlite3PcacheRefCount(pPager->pPCache)==0
2055 ){
2056 char *pNew = (char *)sqlite3PageMalloc(pageSize);
2057 if( !pNew ){
2058 rc = SQLITE_NOMEM;
2059 }else{
2060 pager_reset(pPager);
2061 pPager->pageSize = pageSize;
2062 if( !pPager->memDb ) setSectorSize(pPager);
2063 sqlite3PageFree(pPager->pTmpSpace);
2064 pPager->pTmpSpace = pNew;
2065 sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
2066 }
danielk1977a1644fd2007-08-29 12:31:25 +00002067 }
drh4f21c4a2008-12-10 22:15:00 +00002068 *pPageSize = (u16)pPager->pageSize;
drh1c7880e2005-05-20 20:01:55 +00002069 }
danielk1977a1644fd2007-08-29 12:31:25 +00002070 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002071}
2072
2073/*
drh26b79942007-11-28 16:19:56 +00002074** Return a pointer to the "temporary page" buffer held internally
2075** by the pager. This is a buffer that is big enough to hold the
2076** entire content of a database page. This buffer is used internally
2077** during rollback and will be overwritten whenever a rollback
2078** occurs. But other modules are free to use it too, as long as
2079** no rollbacks are happening.
2080*/
2081void *sqlite3PagerTempSpace(Pager *pPager){
2082 return pPager->pTmpSpace;
2083}
2084
2085/*
drhf8e632b2007-05-08 14:51:36 +00002086** Attempt to set the maximum database page count if mxPage is positive.
2087** Make no changes if mxPage is zero or negative. And never reduce the
2088** maximum page count below the current size of the database.
2089**
2090** Regardless of mxPage, return the current maximum page count.
2091*/
2092int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2093 if( mxPage>0 ){
2094 pPager->mxPgno = mxPage;
2095 }
danielk1977ad0132d2008-06-07 08:58:22 +00002096 sqlite3PagerPagecount(pPager, 0);
drhf8e632b2007-05-08 14:51:36 +00002097 return pPager->mxPgno;
2098}
2099
2100/*
drhc9ac5ca2005-11-04 22:03:30 +00002101** The following set of routines are used to disable the simulated
2102** I/O error mechanism. These routines are used to avoid simulated
2103** errors in places where we do not care about errors.
2104**
2105** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2106** and generate no code.
2107*/
2108#ifdef SQLITE_TEST
2109extern int sqlite3_io_error_pending;
2110extern int sqlite3_io_error_hit;
2111static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002112void disable_simulated_io_errors(void){
2113 saved_cnt = sqlite3_io_error_pending;
2114 sqlite3_io_error_pending = -1;
2115}
2116void enable_simulated_io_errors(void){
2117 sqlite3_io_error_pending = saved_cnt;
2118}
2119#else
drh152410f2005-11-05 15:11:22 +00002120# define disable_simulated_io_errors()
2121# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002122#endif
2123
2124/*
drh90f5ecb2004-07-22 01:19:35 +00002125** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002126** that pDest points to.
2127**
2128** No error checking is done. The rational for this is that this function
2129** may be called even if the file does not exist or contain a header. In
2130** these cases sqlite3OsRead() will return an error, to which the correct
2131** response is to zero the memory at pDest and continue. A real IO error
2132** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002133*/
danielk19773b8a05f2007-03-19 17:44:26 +00002134int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002135 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002136 memset(pDest, 0, N);
danielk1977b3175382008-10-17 18:51:52 +00002137 assert(pPager->fd->pMethods||pPager->tempFile);
danielk19777a2b1ee2007-08-21 14:27:01 +00002138 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002139 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002140 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002141 if( rc==SQLITE_IOERR_SHORT_READ ){
2142 rc = SQLITE_OK;
2143 }
drh90f5ecb2004-07-22 01:19:35 +00002144 }
drh551b7732006-11-06 21:20:25 +00002145 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002146}
2147
2148/*
drh5e00f6c2001-09-13 13:46:56 +00002149** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002150** pPager.
2151**
2152** If the PENDING_BYTE lies on the page directly after the end of the
2153** file, then consider this page part of the file too. For example, if
2154** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2155** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002156*/
danielk1977ad0132d2008-06-07 08:58:22 +00002157int sqlite3PagerPagecount(Pager *pPager, int *pnPage){
danielk19777a2b1ee2007-08-21 14:27:01 +00002158 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002159 int rc;
drhd9b02572001-04-15 00:37:09 +00002160 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002161 if( pPager->errCode ){
danielk19778c0a7912008-08-20 14:49:23 +00002162 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002163 return rc;
drha7aea3d2007-03-15 12:51:16 +00002164 }
danielk1977d92db532008-11-17 04:56:24 +00002165 if( pPager->dbSizeValid ){
danielk197715f411d2005-09-16 10:18:45 +00002166 n = pPager->dbSize;
2167 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002168 assert(pPager->fd->pMethods||pPager->tempFile);
2169 if( (pPager->fd->pMethods)
2170 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002171 pager_error(pPager, rc);
danielk1977ad0132d2008-06-07 08:58:22 +00002172 return rc;
danielk197715f411d2005-09-16 10:18:45 +00002173 }
2174 if( n>0 && n<pPager->pageSize ){
2175 n = 1;
2176 }else{
2177 n /= pPager->pageSize;
2178 }
2179 if( pPager->state!=PAGER_UNLOCK ){
drh4f21c4a2008-12-10 22:15:00 +00002180 pPager->dbSize = (int)n;
danielk1977d92db532008-11-17 04:56:24 +00002181 pPager->dbSizeValid = 1;
danielk197715f411d2005-09-16 10:18:45 +00002182 }
drhed7c8552001-04-11 14:29:21 +00002183 }
danielk197715f411d2005-09-16 10:18:45 +00002184 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002185 n++;
2186 }
drhf8e632b2007-05-08 14:51:36 +00002187 if( n>pPager->mxPgno ){
drh4f21c4a2008-12-10 22:15:00 +00002188 pPager->mxPgno = (Pgno)n;
drhf8e632b2007-05-08 14:51:36 +00002189 }
danielk1977ad0132d2008-06-07 08:58:22 +00002190 if( pnPage ){
drh4f21c4a2008-12-10 22:15:00 +00002191 *pnPage = (int)n;
danielk1977ad0132d2008-06-07 08:58:22 +00002192 }
2193 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002194}
2195
2196/*
drhf7c57532003-04-25 13:22:51 +00002197** Forward declaration
2198*/
danielk197776572402004-06-25 02:38:54 +00002199static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002200
2201/*
danielk1977e180dd92007-04-05 17:15:52 +00002202** This routine is used to truncate the cache when a database
2203** is truncated. Drop from the cache all pages whose pgno is
2204** larger than pPager->dbSize and is unreferenced.
2205**
drhac69b052004-05-12 13:30:07 +00002206** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002207**
2208** Actually, at the point this routine is called, it would be
2209** an error to have a referenced page. But rather than delete
2210** that page and guarantee a subsequent segfault, it seems better
2211** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002212*/
danielk1977e180dd92007-04-05 17:15:52 +00002213static void pager_truncate_cache(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00002214 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
drhac69b052004-05-12 13:30:07 +00002215}
2216
drhf7c57532003-04-25 13:22:51 +00002217/*
danielk197717221812005-02-15 03:38:05 +00002218** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002219** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002220** false or until the lock succeeds.
2221**
2222** Return SQLITE_OK on success and an error code if we cannot obtain
2223** the lock.
2224*/
2225static int pager_wait_on_lock(Pager *pPager, int locktype){
2226 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002227
2228 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002229 assert( PAGER_SHARED==SHARED_LOCK );
2230 assert( PAGER_RESERVED==RESERVED_LOCK );
2231 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002232
2233 /* If the file is currently unlocked then the size must be unknown */
danielk1977d92db532008-11-17 04:56:24 +00002234 assert( pPager->state>=PAGER_SHARED || pPager->dbSizeValid==0 );
drh1aa2d8b2007-01-03 15:34:29 +00002235
danielk197717221812005-02-15 03:38:05 +00002236 if( pPager->state>=locktype ){
2237 rc = SQLITE_OK;
2238 }else{
danielk197717221812005-02-15 03:38:05 +00002239 do {
drh054889e2005-11-30 03:20:31 +00002240 rc = sqlite3OsLock(pPager->fd, locktype);
danielk19771ceedd32008-11-19 10:22:33 +00002241 }while( rc==SQLITE_BUSY && pPager->xBusyHandler(pPager->pBusyHandlerArg) );
danielk197717221812005-02-15 03:38:05 +00002242 if( rc==SQLITE_OK ){
drh4f21c4a2008-12-10 22:15:00 +00002243 pPager->state = (u8)locktype;
drhb0603412007-02-28 04:47:26 +00002244 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002245 }
2246 }
2247 return rc;
2248}
2249
2250/*
drhf7c57532003-04-25 13:22:51 +00002251** Truncate the file to the number of pages specified.
2252*/
danielk19773b8a05f2007-03-19 17:44:26 +00002253int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
danielk19778c0a7912008-08-20 14:49:23 +00002254 int rc = SQLITE_OK;
danielk1977b3175382008-10-17 18:51:52 +00002255 assert( pPager->state>=PAGER_SHARED );
danielk19778c0a7912008-08-20 14:49:23 +00002256
danielk1977ad0132d2008-06-07 08:58:22 +00002257 sqlite3PagerPagecount(pPager, 0);
danielk1977efaaf572006-01-16 11:29:19 +00002258 if( pPager->errCode ){
2259 rc = pPager->errCode;
danielk1977d92db532008-11-17 04:56:24 +00002260 }else if( nPage<pPager->dbSize ){
danielk1977b3175382008-10-17 18:51:52 +00002261 rc = syncJournal(pPager);
2262 if( rc==SQLITE_OK ){
2263 /* Get an exclusive lock on the database before truncating. */
2264 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2265 }
2266 if( rc==SQLITE_OK ){
2267 rc = pager_truncate(pPager, nPage);
danielk19778c0a7912008-08-20 14:49:23 +00002268 }
danielk1977369f27e2004-06-15 11:40:04 +00002269 }
danielk197717221812005-02-15 03:38:05 +00002270
drhf7c57532003-04-25 13:22:51 +00002271 return rc;
2272}
2273
2274/*
drhed7c8552001-04-11 14:29:21 +00002275** Shutdown the page cache. Free all memory and close all files.
2276**
2277** If a transaction was in progress when this routine is called, that
2278** transaction is rolled back. All outstanding pages are invalidated
2279** and their memory is freed. Any attempt to use a page associated
2280** with this page cache after this function returns will likely
2281** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002282**
2283** This function always succeeds. If a transaction is active an attempt
2284** is made to roll it back. If an error occurs during the rollback
2285** a hot journal may be left in the filesystem but no error is returned
2286** to the caller.
drhed7c8552001-04-11 14:29:21 +00002287*/
danielk19773b8a05f2007-03-19 17:44:26 +00002288int sqlite3PagerClose(Pager *pPager){
danielk197713f72992005-12-18 08:51:22 +00002289
drhbafda092007-01-03 23:36:22 +00002290 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002291 sqlite3BeginBenignMalloc();
drhc2ee76c2007-01-04 14:58:14 +00002292 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002293 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002294 pager_reset(pPager);
danielk1977b3175382008-10-17 18:51:52 +00002295 if( !MEMDB ){
2296 pagerUnlockAndRollback(pPager);
2297 }
drhbafda092007-01-03 23:36:22 +00002298 enable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002299 sqlite3EndBenignMalloc();
drh4f0c5872007-03-26 22:05:01 +00002300 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002301 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002302 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002303 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002304 }
drhf5e7bb52008-02-18 14:47:33 +00002305 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977a1fa00d2008-08-27 15:16:33 +00002306 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
danielk1977fd7f0452008-12-17 17:30:26 +00002307 releaseAllSavepoint(pPager);
danielk1977b4b47412007-08-17 15:53:36 +00002308 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002309 /* Temp files are automatically deleted by the OS
2310 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002311 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002312 ** }
2313 */
danielk1977aca790a2005-01-13 11:07:52 +00002314
drhfacf0302008-06-17 15:12:00 +00002315 sqlite3PageFree(pPager->pTmpSpace);
danielk19778c0a7912008-08-20 14:49:23 +00002316 sqlite3PcacheClose(pPager->pPCache);
drh17435752007-08-16 04:30:38 +00002317 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002318 return SQLITE_OK;
2319}
2320
drh87cc3b32007-05-08 21:45:27 +00002321#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002322/*
drh5e00f6c2001-09-13 13:46:56 +00002323** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002324*/
danielk19773b8a05f2007-03-19 17:44:26 +00002325Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002326 return p->pgno;
2327}
drh87cc3b32007-05-08 21:45:27 +00002328#endif
drhed7c8552001-04-11 14:29:21 +00002329
2330/*
drhdf0b3b02001-06-23 11:36:20 +00002331** Increment the reference count for a page. The input pointer is
2332** a reference to the page data.
2333*/
danielk19773b8a05f2007-03-19 17:44:26 +00002334int sqlite3PagerRef(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002335 sqlite3PcacheRef(pPg);
drh8c42ca92001-06-22 19:15:00 +00002336 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002337}
2338
2339/*
drh34e79ce2004-02-08 06:05:46 +00002340** Sync the journal. In other words, make sure all the pages that have
2341** been written to the journal have actually reached the surface of the
2342** disk. It is not safe to modify the original database file until after
2343** the journal has been synced. If the original database is modified before
2344** the journal is synced and a power failure occurs, the unsynced journal
2345** data would be lost and we would be unable to completely rollback the
2346** database changes. Database corruption would occur.
2347**
2348** This routine also updates the nRec field in the header of the journal.
2349** (See comments on the pager_playback() routine for additional information.)
2350** If the sync mode is FULL, two syncs will occur. First the whole journal
2351** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002352**
drh34e79ce2004-02-08 06:05:46 +00002353** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002354** after a power failure, so no sync occurs.
2355**
2356** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2357** the database is stored, then OsSync() is never called on the journal
2358** file. In this case all that is required is to update the nRec field in
2359** the journal header.
drhfa86c412002-02-02 15:01:15 +00002360**
drh34e79ce2004-02-08 06:05:46 +00002361** This routine clears the needSync field of every page current held in
2362** memory.
drh50e5dad2001-09-15 00:57:28 +00002363*/
danielk197776572402004-06-25 02:38:54 +00002364static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002365 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002366
2367 /* Sync the journal before modifying the main database
2368 ** (assuming there is a journal and it needs to be synced.)
2369 */
danielk197776572402004-06-25 02:38:54 +00002370 if( pPager->needSync ){
danielk1977b3175382008-10-17 18:51:52 +00002371 assert( !pPager->tempFile );
2372 if( pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
danielk19774cd2cd52007-08-23 14:48:23 +00002373 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002374 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002375
danielk19774cd2cd52007-08-23 14:48:23 +00002376 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002377 /* Write the nRec value into the journal file header. If in
2378 ** full-synchronous mode, sync the journal first. This ensures that
2379 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002380 ** it as a candidate for rollback.
2381 **
2382 ** This is not required if the persistent media supports the
2383 ** SAFE_APPEND property. Because in this case it is not possible
2384 ** for garbage data to be appended to the file, the nRec field
2385 ** is populated with 0xFFFFFFFF when the journal header is written
2386 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002387 */
danielk19774cd2cd52007-08-23 14:48:23 +00002388 i64 jrnlOff;
2389 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002390 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002391 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002392 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002393 if( rc!=0 ) return rc;
2394 }
danielk197713adf8a2004-06-03 16:08:41 +00002395
danielk197762079062007-08-15 17:08:46 +00002396 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2397 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2398 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002399 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002400 }
danielk19774cd2cd52007-08-23 14:48:23 +00002401 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2402 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2403 IOTRACE(("JSYNC %p\n", pPager))
2404 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2405 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2406 );
2407 if( rc!=0 ) return rc;
2408 }
drhdb48ee02003-01-16 13:42:43 +00002409 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002410 }
drh50e5dad2001-09-15 00:57:28 +00002411 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002412
2413 /* Erase the needSync flag from every page.
2414 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00002415 sqlite3PcacheClearSyncFlags(pPager->pPCache);
drh50e5dad2001-09-15 00:57:28 +00002416 }
drh03eb96a2002-11-10 23:32:56 +00002417
drh81a20f22001-10-12 17:30:04 +00002418 return rc;
drh50e5dad2001-09-15 00:57:28 +00002419}
2420
2421/*
drh2554f8b2003-01-22 01:26:44 +00002422** Given a list of pages (connected by the PgHdr.pDirty pointer) write
danielk1977a858aa22008-08-22 16:22:17 +00002423** every one of those pages out to the database file. No calls are made
2424** to the page-cache to mark the pages as clean. It is the responsibility
2425** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark
2426** the pages as clean.
drh2554f8b2003-01-22 01:26:44 +00002427*/
2428static int pager_write_pagelist(PgHdr *pList){
2429 Pager *pPager;
2430 int rc;
2431
2432 if( pList==0 ) return SQLITE_OK;
2433 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002434
2435 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2436 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002437 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002438 **
drha6abd042004-06-09 17:37:22 +00002439 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2440 ** through an intermediate state PENDING. A PENDING lock prevents new
2441 ** readers from attaching to the database but is unsufficient for us to
2442 ** write. The idea of a PENDING lock is to prevent new readers from
2443 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002444 **
drha6abd042004-06-09 17:37:22 +00002445 ** While the pager is in the RESERVED state, the original database file
2446 ** is unchanged and we can rollback without having to playback the
2447 ** journal into the original database file. Once we transition to
2448 ** EXCLUSIVE, it means the database file has been changed and any rollback
2449 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002450 */
drh684917c2004-10-05 02:41:42 +00002451 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002452 if( rc!=SQLITE_OK ){
2453 return rc;
2454 }
2455
drh2554f8b2003-01-22 01:26:44 +00002456 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002457
2458 /* If the file has not yet been opened, open it now. */
2459 if( !pPager->fd->pMethods ){
2460 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00002461 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002462 if( rc ) return rc;
2463 }
2464
danielk1977687566d2004-11-02 12:56:41 +00002465 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002466 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002467 ** make the file smaller (presumably by auto-vacuum code). Do not write
2468 ** any such pages to the file.
2469 */
danielk197733e32162008-08-23 18:53:08 +00002470 if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
danielk197762079062007-08-15 17:08:46 +00002471 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002472 char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6);
danielk197712dd5492008-12-18 15:45:07 +00002473
drh477731b2007-06-16 03:06:27 +00002474 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2475 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002476 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002477 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002478 PAGER_INCR(sqlite3_pager_writedb_count);
2479 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002480 if( pList->pgno==1 ){
2481 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2482 }
danielk1977687566d2004-11-02 12:56:41 +00002483 }
2484#ifndef NDEBUG
2485 else{
drh4f0c5872007-03-26 22:05:01 +00002486 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002487 }
2488#endif
drh2554f8b2003-01-22 01:26:44 +00002489 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002490#ifdef SQLITE_CHECK_PAGES
2491 pList->pageHash = pager_pagehash(pList);
2492#endif
drh2554f8b2003-01-22 01:26:44 +00002493 pList = pList->pDirty;
2494 }
danielk19778c0a7912008-08-20 14:49:23 +00002495
drh2554f8b2003-01-22 01:26:44 +00002496 return SQLITE_OK;
2497}
2498
2499/*
danielk19778c0a7912008-08-20 14:49:23 +00002500** This function is called by the pcache layer when it has reached some
2501** soft memory limit. The argument is a pointer to a purgeable Pager
2502** object. This function attempts to make a single dirty page that has no
2503** outstanding references (if one exists) clean so that it can be recycled
2504** by the pcache layer.
drh2554f8b2003-01-22 01:26:44 +00002505*/
danielk1977a858aa22008-08-22 16:22:17 +00002506static int pagerStress(void *p, PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002507 Pager *pPager = (Pager *)p;
danielk19778c0a7912008-08-20 14:49:23 +00002508 int rc = SQLITE_OK;
drh8f2e9a12008-02-26 14:46:04 +00002509
danielk19778c200142008-08-25 07:12:28 +00002510 if( pPager->doNotSync ){
2511 return SQLITE_OK;
2512 }
2513
danielk1977a858aa22008-08-22 16:22:17 +00002514 assert( pPg->flags&PGHDR_DIRTY );
2515 if( pPager->errCode==SQLITE_OK ){
2516 if( pPg->flags&PGHDR_NEED_SYNC ){
2517 rc = syncJournal(pPager);
2518 if( rc==SQLITE_OK && pPager->fullSync &&
danielk1977b3175382008-10-17 18:51:52 +00002519 !(pPager->journalMode==PAGER_JOURNALMODE_MEMORY) &&
danielk1977a858aa22008-08-22 16:22:17 +00002520 !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
2521 ){
2522 pPager->nRec = 0;
2523 rc = writeJournalHdr(pPager);
danielk19778c0a7912008-08-20 14:49:23 +00002524 }
danielk19778c0a7912008-08-20 14:49:23 +00002525 }
danielk1977a858aa22008-08-22 16:22:17 +00002526 if( rc==SQLITE_OK ){
2527 pPg->pDirty = 0;
2528 rc = pager_write_pagelist(pPg);
2529 }
2530 if( rc!=SQLITE_OK ){
2531 pager_error(pPager, rc);
2532 }
2533 }
2534
2535 if( rc==SQLITE_OK ){
2536 sqlite3PcacheMakeClean(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00002537 }
2538 return rc;
drh2554f8b2003-01-22 01:26:44 +00002539}
2540
danielk19778c0a7912008-08-20 14:49:23 +00002541
drh2554f8b2003-01-22 01:26:44 +00002542/*
drh19db9352008-03-27 22:42:51 +00002543** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00002544** A hot journal is one that needs to be played back.
2545**
2546** If the current size of the database file is 0 but a journal file
2547** exists, that is probably an old journal left over from a prior
2548** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00002549**
2550** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00002551**
2552** This routine does not open the journal file to examine its
2553** content. Hence, the journal might contain the name of a master
2554** journal file that has been deleted, and hence not be hot. Or
2555** the header of the journal might be zeroed out. This routine
2556** does not discover these cases of a non-hot journal - if the
2557** journal file exists and is not empty this routine assumes it
2558** is hot. The pager_playback() routine will discover that the
2559** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00002560*/
danielk1977d300b8a2008-08-01 10:50:23 +00002561static int hasHotJournal(Pager *pPager, int *pExists){
danielk1977b4b47412007-08-17 15:53:36 +00002562 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977d300b8a2008-08-01 10:50:23 +00002563 int rc = SQLITE_OK;
drhea678832008-12-10 19:26:22 +00002564 int exists = 0;
2565 int locked = 0;
drh0a846f92008-08-25 17:23:29 +00002566 assert( pPager!=0 );
2567 assert( pPager->useJournal );
2568 assert( pPager->fd->pMethods );
danielk1977d300b8a2008-08-01 10:50:23 +00002569 *pExists = 0;
drh0a846f92008-08-25 17:23:29 +00002570 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
2571 if( rc==SQLITE_OK && exists ){
2572 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
2573 }
2574 if( rc==SQLITE_OK && exists && !locked ){
2575 int nPage;
2576 rc = sqlite3PagerPagecount(pPager, &nPage);
2577 if( rc==SQLITE_OK ){
2578 if( nPage==0 ){
2579 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2580 }else{
2581 *pExists = 1;
danielk1977861f7452008-06-05 11:39:11 +00002582 }
2583 }
drhbb5f18d2007-04-06 18:23:17 +00002584 }
danielk1977d300b8a2008-08-01 10:50:23 +00002585 return rc;
drh165ffe92005-03-15 17:09:30 +00002586}
2587
2588/*
danielk1977e180dd92007-04-05 17:15:52 +00002589** Read the content of page pPg out of the database file.
2590*/
2591static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2592 int rc;
danielk197762079062007-08-15 17:08:46 +00002593 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002594 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002595 assert(pPager->fd->pMethods||pPager->tempFile);
2596 if( !pPager->fd->pMethods ){
2597 return SQLITE_IOERR_SHORT_READ;
2598 }
danielk197762079062007-08-15 17:08:46 +00002599 offset = (pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002600 rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002601 PAGER_INCR(sqlite3_pager_readdb_count);
2602 PAGER_INCR(pPager->nRead);
2603 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002604 if( pgno==1 ){
danielk19778c0a7912008-08-20 14:49:23 +00002605 memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24],
drh86a88112007-04-16 15:02:19 +00002606 sizeof(pPager->dbFileVers));
2607 }
danielk197730849522008-08-21 04:35:18 +00002608 CODEC1(pPager, pPg->pData, pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002609 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2610 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002611 return rc;
2612}
2613
2614
2615/*
danielk1977e277be02007-03-23 18:12:06 +00002616** This function is called to obtain the shared lock required before
2617** data may be read from the pager cache. If the shared lock has already
2618** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002619**
2620** Immediately after obtaining the shared lock (if required), this function
2621** checks for a hot-journal file. If one is found, an emergency rollback
2622** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002623*/
2624static int pagerSharedLock(Pager *pPager){
2625 int rc = SQLITE_OK;
danielk1977d300b8a2008-08-01 10:50:23 +00002626 int isErrorReset = 0;
danielk1977e277be02007-03-23 18:12:06 +00002627
danielk1977ae72d982007-10-03 08:46:44 +00002628 /* If this database is opened for exclusive access, has no outstanding
2629 ** page references and is in an error-state, now is the chance to clear
2630 ** the error. Discard the contents of the pager-cache and treat any
2631 ** open journal file as a hot-journal.
2632 */
danielk19778c0a7912008-08-20 14:49:23 +00002633 if( !MEMDB && pPager->exclusiveMode
2634 && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode
2635 ){
danielk1977ae72d982007-10-03 08:46:44 +00002636 if( pPager->journalOpen ){
danielk1977d300b8a2008-08-01 10:50:23 +00002637 isErrorReset = 1;
danielk1977ae72d982007-10-03 08:46:44 +00002638 }
danielk1977ae72d982007-10-03 08:46:44 +00002639 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00002640 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00002641 }
2642
2643 /* If the pager is still in an error state, do not proceed. The error
2644 ** state will be cleared at some point in the future when all page
2645 ** references are dropped and the cache can be discarded.
2646 */
2647 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2648 return pPager->errCode;
2649 }
2650
danielk1977d300b8a2008-08-01 10:50:23 +00002651 if( pPager->state==PAGER_UNLOCK || isErrorReset ){
danielk1977b4b47412007-08-17 15:53:36 +00002652 sqlite3_vfs *pVfs = pPager->pVfs;
drh4f21c4a2008-12-10 22:15:00 +00002653 int isHotJournal = 0;
shane049fc212008-10-22 16:26:47 +00002654 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00002655 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
2656 if( !pPager->noReadlock ){
2657 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2658 if( rc!=SQLITE_OK ){
2659 assert( pPager->state==PAGER_UNLOCK );
2660 return pager_error(pPager, rc);
danielk1977e277be02007-03-23 18:12:06 +00002661 }
danielk1977b3175382008-10-17 18:51:52 +00002662 assert( pPager->state>=SHARED_LOCK );
2663 }
2664
2665 /* If a journal file exists, and there is no RESERVED lock on the
2666 ** database file, then it either needs to be played back or deleted.
2667 */
2668 if( !isErrorReset ){
2669 rc = hasHotJournal(pPager, &isHotJournal);
2670 if( rc!=SQLITE_OK ){
2671 goto failed;
2672 }
2673 }
2674 if( isErrorReset || isHotJournal ){
2675 /* Get an EXCLUSIVE lock on the database file. At this point it is
2676 ** important that a RESERVED lock is not obtained on the way to the
2677 ** EXCLUSIVE lock. If it were, another process might open the
2678 ** database file, detect the RESERVED lock, and conclude that the
2679 ** database is safe to read while this process is still rolling it
2680 ** back.
2681 **
2682 ** Because the intermediate RESERVED lock is not requested, the
2683 ** second process will get to this point in the code and fail to
2684 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00002685 */
danielk1977b3175382008-10-17 18:51:52 +00002686 if( pPager->state<EXCLUSIVE_LOCK ){
2687 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
danielk1977e277be02007-03-23 18:12:06 +00002688 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002689 rc = pager_error(pPager, rc);
2690 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002691 }
danielk1977b3175382008-10-17 18:51:52 +00002692 pPager->state = PAGER_EXCLUSIVE;
2693 }
2694
2695 /* Open the journal for read/write access. This is because in
2696 ** exclusive-access mode the file descriptor will be kept open and
2697 ** possibly used for a transaction later on. On some systems, the
2698 ** OsTruncate() call used in exclusive-access mode also requires
2699 ** a read/write file handle.
2700 */
2701 if( !isErrorReset && pPager->journalOpen==0 ){
2702 int res;
2703 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
2704 if( rc==SQLITE_OK ){
2705 if( res ){
2706 int fout = 0;
2707 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
2708 assert( !pPager->tempFile );
2709 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
2710 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk1977281d8bd2008-10-29 07:01:56 +00002711 if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
2712 rc = SQLITE_CANTOPEN;
danielk1977b3175382008-10-17 18:51:52 +00002713 sqlite3OsClose(pPager->jfd);
2714 }
2715 }else{
2716 /* If the journal does not exist, that means some other process
2717 ** has already rolled it back */
2718 rc = SQLITE_BUSY;
2719 }
2720 }
2721 }
2722 if( rc!=SQLITE_OK ){
danielk1977b3175382008-10-17 18:51:52 +00002723 goto failed;
2724 }
2725 pPager->journalOpen = 1;
2726 pPager->journalStarted = 0;
2727 pPager->journalOff = 0;
2728 pPager->setMaster = 0;
2729 pPager->journalHdr = 0;
2730
2731 /* Playback and delete the journal. Drop the database write
2732 ** lock and reacquire the read lock.
2733 */
2734 rc = pager_playback(pPager, 1);
2735 if( rc!=SQLITE_OK ){
2736 rc = pager_error(pPager, rc);
2737 goto failed;
2738 }
2739 assert(pPager->state==PAGER_SHARED ||
2740 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2741 );
2742 }
2743
2744 if( sqlite3PcachePagecount(pPager->pPCache)>0 ){
2745 /* The shared-lock has just been acquired on the database file
2746 ** and there are already pages in the cache (from a previous
2747 ** read or write transaction). Check to see if the database
2748 ** has been modified. If the database has changed, flush the
2749 ** cache.
2750 **
2751 ** Database changes is detected by looking at 15 bytes beginning
2752 ** at offset 24 into the file. The first 4 of these 16 bytes are
2753 ** a 32-bit counter that is incremented with each change. The
2754 ** other bytes change randomly with each file change when
2755 ** a codec is in use.
2756 **
2757 ** There is a vanishingly small chance that a change will not be
2758 ** detected. The chance of an undetected change is so small that
2759 ** it can be neglected.
2760 */
2761 char dbFileVers[sizeof(pPager->dbFileVers)];
2762 sqlite3PagerPagecount(pPager, 0);
2763
2764 if( pPager->errCode ){
2765 rc = pPager->errCode;
2766 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002767 }
2768
danielk1977d92db532008-11-17 04:56:24 +00002769 assert( pPager->dbSizeValid );
danielk1977b3175382008-10-17 18:51:52 +00002770 if( pPager->dbSize>0 ){
2771 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
2772 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
2773 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002774 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002775 }
danielk1977b3175382008-10-17 18:51:52 +00002776 }else{
2777 memset(dbFileVers, 0, sizeof(dbFileVers));
2778 }
danielk1977e277be02007-03-23 18:12:06 +00002779
danielk1977b3175382008-10-17 18:51:52 +00002780 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
2781 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002782 }
2783 }
danielk1977c5859712007-03-26 12:26:27 +00002784 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2785 if( pPager->state==PAGER_UNLOCK ){
2786 pPager->state = PAGER_SHARED;
2787 }
danielk1977e277be02007-03-23 18:12:06 +00002788 }
2789
danielk197752b472a2008-05-05 16:23:55 +00002790 failed:
2791 if( rc!=SQLITE_OK ){
2792 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
2793 pager_unlock(pPager);
2794 }
danielk1977e277be02007-03-23 18:12:06 +00002795 return rc;
2796}
2797
2798/*
drhd33d5a82007-04-26 12:11:28 +00002799** Make sure we have the content for a page. If the page was
2800** previously acquired with noContent==1, then the content was
2801** just initialized to zeros instead of being read from disk.
2802** But now we need the real data off of disk. So make sure we
2803** have it. Read it in if we do not have it already.
2804*/
2805static int pager_get_content(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002806 if( pPg->flags&PGHDR_NEED_READ ){
drhd33d5a82007-04-26 12:11:28 +00002807 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
2808 if( rc==SQLITE_OK ){
danielk19778c0a7912008-08-20 14:49:23 +00002809 pPg->flags &= ~PGHDR_NEED_READ;
drhd33d5a82007-04-26 12:11:28 +00002810 }else{
2811 return rc;
2812 }
2813 }
2814 return SQLITE_OK;
2815}
2816
2817/*
danielk19778c0a7912008-08-20 14:49:23 +00002818** If the reference count has reached zero, and the pager is not in the
2819** middle of a write transaction or opened in exclusive mode, unlock it.
2820*/
2821static void pagerUnlockIfUnused(Pager *pPager){
2822 if( (sqlite3PcacheRefCount(pPager->pPCache)==0)
2823 && (!pPager->exclusiveMode || pPager->journalOff>0)
2824 ){
2825 pagerUnlockAndRollback(pPager);
2826 }
2827}
2828
2829/*
2830** Drop a page from the cache using sqlite3PcacheDrop().
2831**
2832** If this means there are now no pages with references to them, a rollback
2833** occurs and the lock on the database is removed.
2834*/
2835static void pagerDropPage(DbPage *pPg){
2836 Pager *pPager = pPg->pPager;
2837 sqlite3PcacheDrop(pPg);
2838 pagerUnlockIfUnused(pPager);
2839}
2840
2841/*
drhd9b02572001-04-15 00:37:09 +00002842** Acquire a page.
2843**
drh58a11682001-11-10 13:51:08 +00002844** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002845** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002846**
drhd33d5a82007-04-26 12:11:28 +00002847** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00002848** file is smaller than the requested page, then no actual disk
2849** read occurs and the memory image of the page is initialized to
2850** all zeros. The extra data appended to a page is always initialized
2851** to zeros the first time a page is loaded into memory.
2852**
drhd9b02572001-04-15 00:37:09 +00002853** The acquisition might fail for several reasons. In all cases,
2854** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002855**
drhd33d5a82007-04-26 12:11:28 +00002856** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002857** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00002858** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00002859** just returns 0. This routine acquires a read-lock the first time it
2860** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00002861** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00002862** or journal files.
drh0787db62007-03-04 13:15:27 +00002863**
drh538f5702007-04-13 02:14:30 +00002864** If noContent is false, the page contents are actually read from disk.
2865** If noContent is true, it means that we do not care about the contents
2866** of the page at this time, so do not do a disk read. Just fill in the
2867** page content with zeros. But mark the fact that we have not read the
2868** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00002869** sqlite3PagerWrite() is called on this page or if this routine is
2870** called again with noContent==0, that means that the content is needed
2871** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002872*/
danielk197765e0ff32008-09-19 09:14:43 +00002873int sqlite3PagerAcquire(
drh538f5702007-04-13 02:14:30 +00002874 Pager *pPager, /* The pager open on the database file */
2875 Pgno pgno, /* Page number to fetch */
2876 DbPage **ppPage, /* Write a pointer to the page here */
2877 int noContent /* Do not bother reading content from disk if true */
2878){
danielk19778c0a7912008-08-20 14:49:23 +00002879 PgHdr *pPg = 0;
drh165ffe92005-03-15 17:09:30 +00002880 int rc;
drhed7c8552001-04-11 14:29:21 +00002881
danielk19778c0a7912008-08-20 14:49:23 +00002882 assert( pPager->state==PAGER_UNLOCK
2883 || sqlite3PcacheRefCount(pPager->pPCache)>0
danielk1977b3175382008-10-17 18:51:52 +00002884 || pgno==1
danielk19778c0a7912008-08-20 14:49:23 +00002885 );
danielk1977e277be02007-03-23 18:12:06 +00002886
danielk197726836652005-01-17 01:33:13 +00002887 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2888 ** number greater than this, or zero, is requested.
2889 */
drh267cb322005-09-16 17:16:52 +00002890 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002891 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002892 }
2893
drhd9b02572001-04-15 00:37:09 +00002894 /* Make sure we have not hit any critical errors.
2895 */
drh836faa42003-01-11 13:30:57 +00002896 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002897 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002898
danielk197713adf8a2004-06-03 16:08:41 +00002899 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002900 ** on the database file. pagerSharedLock() is a no-op if
2901 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002902 */
danielk1977e277be02007-03-23 18:12:06 +00002903 rc = pagerSharedLock(pPager);
2904 if( rc!=SQLITE_OK ){
2905 return rc;
drhed7c8552001-04-11 14:29:21 +00002906 }
danielk1977e277be02007-03-23 18:12:06 +00002907 assert( pPager->state!=PAGER_UNLOCK );
2908
danielk19778c0a7912008-08-20 14:49:23 +00002909 rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg);
2910 if( rc!=SQLITE_OK ){
2911 return rc;
2912 }
danielk19778c0a7912008-08-20 14:49:23 +00002913 if( pPg->pPager==0 ){
2914 /* The pager cache has created a new page. Its content needs to
2915 ** be initialized.
2916 */
danielk1977979f38e2007-03-27 16:19:51 +00002917 int nMax;
drh538f5702007-04-13 02:14:30 +00002918 PAGER_INCR(pPager->nMiss);
danielk19778c0a7912008-08-20 14:49:23 +00002919 pPg->pPager = pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002920 memset(pPg->pExtra, 0, pPager->nExtra);
danielk197724168722007-04-02 05:07:47 +00002921
danielk1977ad0132d2008-06-07 08:58:22 +00002922 rc = sqlite3PagerPagecount(pPager, &nMax);
2923 if( rc!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002924 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00002925 return rc;
2926 }
danielk197775bab7d2006-01-23 13:09:45 +00002927
danielk1977a1fa00d2008-08-27 15:16:33 +00002928 if( nMax<(int)pgno || MEMDB || noContent ){
drhf8e632b2007-05-08 14:51:36 +00002929 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00002930 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00002931 return SQLITE_FULL;
2932 }
danielk19778c0a7912008-08-20 14:49:23 +00002933 memset(pPg->pData, 0, pPager->pageSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00002934 if( noContent ){
danielk19778c0a7912008-08-20 14:49:23 +00002935 pPg->flags |= PGHDR_NEED_READ;
2936 }
drh538f5702007-04-13 02:14:30 +00002937 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00002938 }else{
danielk1977e180dd92007-04-05 17:15:52 +00002939 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00002940 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
danielk19778c0a7912008-08-20 14:49:23 +00002941 /* sqlite3PagerUnref(pPg); */
2942 pagerDropPage(pPg);
drh551b7732006-11-06 21:20:25 +00002943 return rc;
drh81a20f22001-10-12 17:30:04 +00002944 }
drh306dc212001-05-21 13:45:10 +00002945 }
danielk19773c407372005-02-15 02:54:14 +00002946#ifdef SQLITE_CHECK_PAGES
2947 pPg->pageHash = pager_pagehash(pPg);
2948#endif
drhed7c8552001-04-11 14:29:21 +00002949 }else{
drhd9b02572001-04-15 00:37:09 +00002950 /* The requested page is in the page cache. */
danielk19778c0a7912008-08-20 14:49:23 +00002951 assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00002952 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00002953 if( !noContent ){
2954 rc = pager_get_content(pPg);
2955 if( rc ){
danielk19778c0a7912008-08-20 14:49:23 +00002956 sqlite3PagerUnref(pPg);
drhd33d5a82007-04-26 12:11:28 +00002957 return rc;
2958 }
2959 }
drhed7c8552001-04-11 14:29:21 +00002960 }
danielk19778c0a7912008-08-20 14:49:23 +00002961
danielk19773b8a05f2007-03-19 17:44:26 +00002962 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00002963 return SQLITE_OK;
2964}
danielk19778c0a7912008-08-20 14:49:23 +00002965
drhed7c8552001-04-11 14:29:21 +00002966/*
drh7e3b0a02001-04-28 16:52:40 +00002967** Acquire a page if it is already in the in-memory cache. Do
2968** not read the page from disk. Return a pointer to the page,
2969** or 0 if the page is not in cache.
2970**
danielk19773b8a05f2007-03-19 17:44:26 +00002971** See also sqlite3PagerGet(). The difference between this routine
2972** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002973** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002974** returns NULL if the page is not in cache or if a disk I/O error
2975** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002976*/
danielk19773b8a05f2007-03-19 17:44:26 +00002977DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00002978 PgHdr *pPg = 0;
drh836faa42003-01-11 13:30:57 +00002979 assert( pPager!=0 );
2980 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00002981
danielk19778c0a7912008-08-20 14:49:23 +00002982 if( (pPager->state!=PAGER_UNLOCK)
2983 && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL)
2984 ){
2985 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg);
danielk1977e277be02007-03-23 18:12:06 +00002986 }
danielk19778c0a7912008-08-20 14:49:23 +00002987
danielk19773b8a05f2007-03-19 17:44:26 +00002988 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00002989}
2990
2991/*
drhed7c8552001-04-11 14:29:21 +00002992** Release a page.
2993**
2994** If the number of references to the page drop to zero, then the
2995** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002996** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002997** removed.
2998*/
danielk19773b8a05f2007-03-19 17:44:26 +00002999int sqlite3PagerUnref(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003000 if( pPg ){
3001 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00003002 sqlite3PcacheRelease(pPg);
3003 pagerUnlockIfUnused(pPager);
drhed7c8552001-04-11 14:29:21 +00003004 }
drhd9b02572001-04-15 00:37:09 +00003005 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003006}
3007
danielk1977fd7f0452008-12-17 17:30:26 +00003008static int openSubJournal(Pager *pPager){
3009 int rc = SQLITE_OK;
3010 if( pPager->journalOpen && !pPager->sjfd->pMethods ){
3011 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
3012 sqlite3MemJournalOpen(pPager->sjfd);
3013 }else{
3014 rc = sqlite3PagerOpentemp(pPager, pPager->sjfd, SQLITE_OPEN_SUBJOURNAL);
3015 }
3016 }
3017 return rc;
3018}
3019
drhed7c8552001-04-11 14:29:21 +00003020/*
drha6abd042004-06-09 17:37:22 +00003021** Create a journal file for pPager. There should already be a RESERVED
3022** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003023**
3024** Return SQLITE_OK if everything. Return an error code and release the
3025** write lock if anything goes wrong.
3026*/
3027static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003028 sqlite3_vfs *pVfs = pPager->pVfs;
3029 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3030
drhda47d772002-12-02 04:25:19 +00003031 int rc;
drha6abd042004-06-09 17:37:22 +00003032 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003033 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003034 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003035 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003036 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00003037 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003038 rc = SQLITE_NOMEM;
3039 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003040 }
danielk1977b4b47412007-08-17 15:53:36 +00003041
drhfdc40e92008-04-17 20:59:37 +00003042 if( pPager->journalOpen==0 ){
3043 if( pPager->tempFile ){
3044 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3045 }else{
3046 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00003047 }
danielk1977b3175382008-10-17 18:51:52 +00003048 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
3049 sqlite3MemJournalOpen(pPager->jfd);
3050 rc = SQLITE_OK;
3051 }else{
drhfdc40e92008-04-17 20:59:37 +00003052#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977b3175382008-10-17 18:51:52 +00003053 rc = sqlite3JournalOpen(
3054 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3055 );
drhfdc40e92008-04-17 20:59:37 +00003056#else
danielk1977b3175382008-10-17 18:51:52 +00003057 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
drhfdc40e92008-04-17 20:59:37 +00003058#endif
danielk1977b3175382008-10-17 18:51:52 +00003059 }
drhfdc40e92008-04-17 20:59:37 +00003060 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3061 pPager->journalOff = 0;
3062 pPager->setMaster = 0;
3063 pPager->journalHdr = 0;
3064 if( rc!=SQLITE_OK ){
3065 if( rc==SQLITE_NOMEM ){
3066 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3067 }
3068 goto failed_to_open_journal;
3069 }
drhda47d772002-12-02 04:25:19 +00003070 }
3071 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003072 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003073 pPager->needSync = 0;
drh968af522003-02-11 14:55:40 +00003074 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003075 if( pPager->errCode ){
3076 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003077 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003078 }
drhda47d772002-12-02 04:25:19 +00003079 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003080
danielk197776572402004-06-25 02:38:54 +00003081 rc = writeJournalHdr(pPager);
3082
danielk1977fd7f0452008-12-17 17:30:26 +00003083 if( pPager->nSavepoint && rc==SQLITE_OK ){
3084 rc = openSubJournal(pPager);
drhda47d772002-12-02 04:25:19 +00003085 }
danielk1977ae72d982007-10-03 08:46:44 +00003086 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003087 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003088 if( rc==SQLITE_OK ){
3089 rc = SQLITE_FULL;
3090 }
3091 }
drh9c105bb2004-10-02 20:38:28 +00003092 return rc;
3093
3094failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003095 sqlite3BitvecDestroy(pPager->pInJournal);
3096 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003097 return rc;
drhda47d772002-12-02 04:25:19 +00003098}
3099
3100/*
drh4b845d72002-03-05 12:41:19 +00003101** Acquire a write-lock on the database. The lock is removed when
3102** the any of the following happen:
3103**
drh80e35f42007-03-30 14:06:34 +00003104** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003105** * sqlite3PagerRollback() is called.
3106** * sqlite3PagerClose() is called.
3107** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003108**
danielk197713adf8a2004-06-03 16:08:41 +00003109** The first parameter to this routine is a pointer to any open page of the
3110** database file. Nothing changes about the page - it is used merely to
3111** acquire a pointer to the Pager structure and as proof that there is
3112** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003113**
danielk197713adf8a2004-06-03 16:08:41 +00003114** The second parameter indicates how much space in bytes to reserve for a
3115** master journal file-name at the start of the journal when it is created.
3116**
3117** A journal file is opened if this is not a temporary file. For temporary
3118** files, the opening of the journal file is deferred until there is an
3119** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003120**
drha6abd042004-06-09 17:37:22 +00003121** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003122**
3123** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3124** immediately instead of waiting until we try to flush the cache. The
3125** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003126*/
danielk19773b8a05f2007-03-19 17:44:26 +00003127int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003128 Pager *pPager = pPg->pPager;
3129 int rc = SQLITE_OK;
3130 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003131 assert( pPager->state!=PAGER_UNLOCK );
3132 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003133 assert( pPager->pInJournal==0 );
danielk1977b3175382008-10-17 18:51:52 +00003134 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00003135 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
3136 if( rc==SQLITE_OK ){
3137 pPager->state = PAGER_RESERVED;
3138 if( exFlag ){
3139 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh684917c2004-10-05 02:41:42 +00003140 }
danielk1977b3175382008-10-17 18:51:52 +00003141 }
3142 if( rc!=SQLITE_OK ){
3143 return rc;
3144 }
3145 pPager->dirtyCache = 0;
3146 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
3147 if( pPager->useJournal && !pPager->tempFile
3148 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
3149 rc = pager_open_journal(pPager);
drh4b845d72002-03-05 12:41:19 +00003150 }
danielk1977334cdb62007-03-26 08:05:12 +00003151 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00003152 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00003153 ** time a (read or write) transaction was successfully concluded
3154 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00003155 ** kept open and either was truncated to 0 bytes or its header was
3156 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00003157 */
3158 assert( pPager->nRec==0 );
3159 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003160 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003161 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003162 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhf5e7bb52008-02-18 14:47:33 +00003163 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003164 rc = SQLITE_NOMEM;
3165 }else{
drh369339d2007-03-30 16:01:55 +00003166 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003167 rc = writeJournalHdr(pPager);
3168 }
drh4b845d72002-03-05 12:41:19 +00003169 }
danielk1977334cdb62007-03-26 08:05:12 +00003170 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003171 return rc;
3172}
3173
3174/*
drhed7c8552001-04-11 14:29:21 +00003175** Mark a data page as writeable. The page is written into the journal
3176** if it is not there already. This routine must be called before making
3177** changes to a page.
3178**
3179** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003180** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003181** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003182** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003183** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003184**
3185** If the journal file could not be written because the disk is full,
3186** then this routine returns SQLITE_FULL and does an immediate rollback.
3187** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003188** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003189** reset.
drhed7c8552001-04-11 14:29:21 +00003190*/
danielk19773b8a05f2007-03-19 17:44:26 +00003191static int pager_write(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003192 void *pData = pPg->pData;
drh69688d52001-04-14 16:38:23 +00003193 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003194 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003195
drh6446c4d2001-12-15 14:22:18 +00003196 /* Check for errors
3197 */
danielk1977efaaf572006-01-16 11:29:19 +00003198 if( pPager->errCode ){
3199 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003200 }
drh5e00f6c2001-09-13 13:46:56 +00003201 if( pPager->readOnly ){
3202 return SQLITE_PERM;
3203 }
drh6446c4d2001-12-15 14:22:18 +00003204
danielk197776572402004-06-25 02:38:54 +00003205 assert( !pPager->setMaster );
3206
danielk19773c407372005-02-15 02:54:14 +00003207 CHECK_PAGE(pPg);
3208
drh538f5702007-04-13 02:14:30 +00003209 /* If this page was previously acquired with noContent==1, that means
3210 ** we didn't really read in the content of the page. This can happen
3211 ** (for example) when the page is being moved to the freelist. But
3212 ** now we are (perhaps) moving the page off of the freelist for
3213 ** reuse and we need to know its original content so that content
3214 ** can be stored in the rollback journal. So do the read at this
3215 ** time.
3216 */
drhd33d5a82007-04-26 12:11:28 +00003217 rc = pager_get_content(pPg);
3218 if( rc ){
3219 return rc;
drh538f5702007-04-13 02:14:30 +00003220 }
3221
drh6446c4d2001-12-15 14:22:18 +00003222 /* Mark the page as dirty. If the page has already been written
3223 ** to the journal then we can return right away.
3224 */
drhc047b9f2008-11-21 03:23:43 +00003225 sqlite3PcacheMakeDirty(pPg);
danielk1977fd7f0452008-12-17 17:30:26 +00003226 if( pageInJournal(pPg) && pageInSavepoint(pPg) ){
drha6abd042004-06-09 17:37:22 +00003227 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003228 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003229 }else{
drh6446c4d2001-12-15 14:22:18 +00003230
danielk1977a0bf2652004-11-04 14:30:04 +00003231 /* If we get this far, it means that the page needs to be
3232 ** written to the transaction journal or the ckeckpoint journal
3233 ** or both.
3234 **
3235 ** First check to see that the transaction journal exists and
3236 ** create it if it does not.
3237 */
3238 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003239 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003240 if( rc!=SQLITE_OK ){
3241 return rc;
3242 }
3243 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00003244 if( !pPager->journalOpen && pPager->useJournal
3245 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00003246 rc = pager_open_journal(pPager);
3247 if( rc!=SQLITE_OK ) return rc;
3248 }
danielk1977a0bf2652004-11-04 14:30:04 +00003249 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003250 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003251
3252 /* The transaction journal now exists and we have a RESERVED or an
3253 ** EXCLUSIVE lock on the main database file. Write the current page to
3254 ** the transaction journal if it is not there already.
3255 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00003256 if( !pageInJournal(pPg) && pPager->journalOpen ){
danielk1977d92db532008-11-17 04:56:24 +00003257 if( pPg->pgno<=pPager->origDbSize ){
danielk1977b3175382008-10-17 18:51:52 +00003258 u32 cksum;
3259 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00003260
danielk1977b3175382008-10-17 18:51:52 +00003261 /* We should never write to the journal file the page that
3262 ** contains the database locks. The following assert verifies
3263 ** that we do not. */
3264 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
3265 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
3266 cksum = pager_cksum(pPager, (u8*)pData2);
3267 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
3268 if( rc==SQLITE_OK ){
3269 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
3270 pPager->journalOff + 4);
3271 pPager->journalOff += pPager->pageSize+4;
3272 }
3273 if( rc==SQLITE_OK ){
3274 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
3275 pPager->journalOff += 4;
3276 }
3277 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
3278 pPager->journalOff, pPager->pageSize));
3279 PAGER_INCR(sqlite3_pager_writej_count);
3280 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
3281 PAGERID(pPager), pPg->pgno,
3282 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00003283
danielk1977f3107512008-12-22 10:58:46 +00003284 /* Even if an IO or diskfull error occurred while journalling the
3285 ** page in the block above, set the need-sync flag for the page.
3286 ** Otherwise, when the transaction is rolled back, the logic in
3287 ** playback_one_page() will think that the page needs to be restored
3288 ** in the database file. And if an IO error occurs while doing so,
3289 ** then corruption may follow.
3290 */
3291 if( !pPager->noSync ){
3292 pPg->flags |= PGHDR_NEED_SYNC;
danielk1977a4124bd2008-12-23 10:37:47 +00003293 pPager->needSync = 1;
danielk1977f3107512008-12-22 10:58:46 +00003294 }
3295
danielk1977b3175382008-10-17 18:51:52 +00003296 /* An error has occured writing to the journal file. The
3297 ** transaction will be rolled back by the layer above.
3298 */
3299 if( rc!=SQLITE_OK ){
3300 return rc;
3301 }
danielk197707cb5602006-01-20 10:55:05 +00003302
danielk1977b3175382008-10-17 18:51:52 +00003303 pPager->nRec++;
3304 assert( pPager->pInJournal!=0 );
3305 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977fd7f0452008-12-17 17:30:26 +00003306 addToSavepointBitvecs(pPager, pPg->pgno);
danielk197713adf8a2004-06-03 16:08:41 +00003307 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003308 if( !pPager->journalStarted && !pPager->noSync ){
3309 pPg->flags |= PGHDR_NEED_SYNC;
danielk1977a4124bd2008-12-23 10:37:47 +00003310 pPager->needSync = 1;
danielk19778c0a7912008-08-20 14:49:23 +00003311 }
drh4f0c5872007-03-26 22:05:01 +00003312 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk19778c0a7912008-08-20 14:49:23 +00003313 PAGERID(pPager), pPg->pgno,
3314 ((pPg->flags&PGHDR_NEED_SYNC)?1:0));
danielk1977a0bf2652004-11-04 14:30:04 +00003315 }
danielk1977a0bf2652004-11-04 14:30:04 +00003316 }
3317
3318 /* If the statement journal is open and the page is not in it,
3319 ** then write the current page to the statement journal. Note that
3320 ** the statement journal format differs from the standard journal format
3321 ** in that it omits the checksums and the header.
3322 */
danielk1977fd7f0452008-12-17 17:30:26 +00003323 if( !pageInSavepoint(pPg) ){
danielk1977b3175382008-10-17 18:51:52 +00003324 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
3325 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
danielk1977d92db532008-11-17 04:56:24 +00003326 assert( pageInJournal(pPg) || pPg->pgno>pPager->origDbSize );
danielk1977fd7f0452008-12-17 17:30:26 +00003327 rc = write32bits(pPager->sjfd, offset, pPg->pgno);
danielk1977b3175382008-10-17 18:51:52 +00003328 if( rc==SQLITE_OK ){
danielk1977fd7f0452008-12-17 17:30:26 +00003329 rc = sqlite3OsWrite(pPager->sjfd, pData2, pPager->pageSize, offset+4);
drhdb48ee02003-01-16 13:42:43 +00003330 }
danielk197767ddef62008-12-23 19:15:56 +00003331 PAGERTRACE3("STMT-JOURNAL %d page %d @ %d\n", PAGERID(pPager), pPg->pgno);
danielk1977b3175382008-10-17 18:51:52 +00003332 if( rc!=SQLITE_OK ){
3333 return rc;
3334 }
3335 pPager->stmtNRec++;
danielk1977fd7f0452008-12-17 17:30:26 +00003336 assert( pPager->nSavepoint>0 );
3337 addToSavepointBitvecs(pPager, pPg->pgno);
drhd9b02572001-04-15 00:37:09 +00003338 }
drhfa86c412002-02-02 15:01:15 +00003339 }
3340
3341 /* Update the database size and return.
3342 */
drh1aa2d8b2007-01-03 15:34:29 +00003343 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003344 if( pPager->dbSize<pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003345 pPager->dbSize = pPg->pgno;
danielk1977d92db532008-11-17 04:56:24 +00003346 if( pPager->dbSize==(PAGER_MJ_PGNO(pPager)-1) ){
drh1f595712004-06-15 01:40:29 +00003347 pPager->dbSize++;
3348 }
drh306dc212001-05-21 13:45:10 +00003349 }
drh69688d52001-04-14 16:38:23 +00003350 return rc;
drhed7c8552001-04-11 14:29:21 +00003351}
3352
3353/*
danielk19774099f6e2007-03-19 11:25:20 +00003354** This function is used to mark a data-page as writable. It uses
3355** pager_write() to open a journal file (if it is not already open)
3356** and write the page *pData to the journal.
3357**
3358** The difference between this function and pager_write() is that this
3359** function also deals with the special case where 2 or more pages
3360** fit on a single disk sector. In this case all co-resident pages
3361** must have been written to the journal file before returning.
3362*/
danielk19773b8a05f2007-03-19 17:44:26 +00003363int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003364 int rc = SQLITE_OK;
3365
danielk19773b8a05f2007-03-19 17:44:26 +00003366 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003367 Pager *pPager = pPg->pPager;
3368 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3369
danielk1977b3175382008-10-17 18:51:52 +00003370 if( nPagePerSector>1 ){
danielk19774099f6e2007-03-19 11:25:20 +00003371 Pgno nPageCount; /* Total number of pages in database file */
3372 Pgno pg1; /* First page of the sector pPg is located on. */
3373 int nPage; /* Number of pages starting at pg1 to journal */
3374 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003375 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003376
3377 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3378 ** header to be written between the pages journaled by this function.
3379 */
danielk1977b3175382008-10-17 18:51:52 +00003380 assert( !MEMDB );
danielk19774099f6e2007-03-19 11:25:20 +00003381 assert( pPager->doNotSync==0 );
3382 pPager->doNotSync = 1;
3383
3384 /* This trick assumes that both the page-size and sector-size are
3385 ** an integer power of 2. It sets variable pg1 to the identifier
3386 ** of the first page of the sector pPg is located on.
3387 */
3388 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3389
danielk1977ad0132d2008-06-07 08:58:22 +00003390 sqlite3PagerPagecount(pPager, (int *)&nPageCount);
danielk19774099f6e2007-03-19 11:25:20 +00003391 if( pPg->pgno>nPageCount ){
3392 nPage = (pPg->pgno - pg1)+1;
3393 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3394 nPage = nPageCount+1-pg1;
3395 }else{
3396 nPage = nPagePerSector;
3397 }
3398 assert(nPage>0);
3399 assert(pg1<=pPg->pgno);
3400 assert((pg1+nPage)>pPg->pgno);
3401
3402 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3403 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003404 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00003405 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00003406 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003407 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003408 if( rc==SQLITE_OK ){
3409 rc = pager_write(pPage);
danielk19778c0a7912008-08-20 14:49:23 +00003410 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003411 needSync = 1;
danielk1977a4124bd2008-12-23 10:37:47 +00003412 assert(pPager->needSync);
danielk1977dd97a492007-08-22 18:54:32 +00003413 }
danielk19773b8a05f2007-03-19 17:44:26 +00003414 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003415 }
3416 }
drhc81945e2008-03-10 14:12:53 +00003417 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk19778c0a7912008-08-20 14:49:23 +00003418 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003419 needSync = 1;
3420 }
danielk19778c0a7912008-08-20 14:49:23 +00003421 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003422 }
3423 }
3424
danielk1977dd97a492007-08-22 18:54:32 +00003425 /* If the PgHdr.needSync flag is set for any of the nPage pages
3426 ** starting at pg1, then it needs to be set for all of them. Because
3427 ** writing to any of these nPage pages may damage the others, the
3428 ** journal file must contain sync()ed copies of all of them
3429 ** before any of them can be written out to the database file.
3430 */
3431 if( needSync ){
drhb3df2e12008-09-17 20:06:26 +00003432 assert( !MEMDB && pPager->noSync==0 );
danielk1977dd97a492007-08-22 18:54:32 +00003433 for(ii=0; ii<nPage && needSync; ii++){
3434 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
danielk19778c0a7912008-08-20 14:49:23 +00003435 if( pPage ) pPage->flags |= PGHDR_NEED_SYNC;
3436 sqlite3PagerUnref(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003437 }
3438 assert(pPager->needSync);
3439 }
3440
danielk19774099f6e2007-03-19 11:25:20 +00003441 assert( pPager->doNotSync==1 );
3442 pPager->doNotSync = 0;
3443 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003444 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003445 }
3446 return rc;
3447}
3448
3449/*
drhaacc5432002-01-06 17:07:40 +00003450** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003451** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003452** to change the content of the page.
3453*/
danielk19777d3a6662006-01-23 16:21:05 +00003454#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003455int sqlite3PagerIswriteable(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003456 return pPg->flags&PGHDR_DIRTY;
drh6019e162001-07-02 17:51:45 +00003457}
danielk19777d3a6662006-01-23 16:21:05 +00003458#endif
drh6019e162001-07-02 17:51:45 +00003459
drh001bbcb2003-03-19 03:14:00 +00003460/*
drh30e58752002-03-02 20:41:57 +00003461** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003462** write the information on page pPg back to the disk, even though
drhdfe88ec2008-11-03 20:55:06 +00003463** that page might be marked as dirty. This happens, for example, when
3464** the page has been added as a leaf of the freelist and so its
3465** content no longer matters.
drh30e58752002-03-02 20:41:57 +00003466**
3467** The overlying software layer calls this routine when all of the data
3468** on the given page is unused. The pager marks the page as clean so
3469** that it does not get written to disk.
3470**
3471** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003472** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003473** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003474**
3475** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003476** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003477** will thereafter be ignored. This is necessary to avoid a problem
3478** where a page with data is added to the freelist during one part of
3479** a transaction then removed from the freelist during a later part
3480** of the same transaction and reused for some other purpose. When it
3481** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003482** the sqlite3PagerDontRollback() routine is called. But because the
3483** page contains critical data, we still need to be sure it gets
3484** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003485*/
danielk1977a1fa00d2008-08-27 15:16:33 +00003486int sqlite3PagerDontWrite(DbPage *pDbPage){
drh538f5702007-04-13 02:14:30 +00003487 PgHdr *pPg = pDbPage;
3488 Pager *pPager = pPg->pPager;
danielk1977a1fa00d2008-08-27 15:16:33 +00003489 int rc;
drh8e298f92002-07-06 16:28:47 +00003490
danielk1977b3175382008-10-17 18:51:52 +00003491 if( pPg->pgno>pPager->origDbSize ){
danielk1977a1fa00d2008-08-27 15:16:33 +00003492 return SQLITE_OK;
3493 }
3494 if( pPager->pAlwaysRollback==0 ){
3495 assert( pPager->pInJournal );
3496 pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->origDbSize);
3497 if( !pPager->pAlwaysRollback ){
3498 return SQLITE_NOMEM;
3499 }
3500 }
3501 rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno);
3502
danielk1977fd7f0452008-12-17 17:30:26 +00003503 if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && pPager->nSavepoint==0 ){
drh1aa2d8b2007-01-03 15:34:29 +00003504 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003505 if( pPager->dbSize==pPg->pgno && pPager->origDbSize<pPager->dbSize ){
drh8124a302002-06-25 14:43:57 +00003506 /* If this pages is the last page in the file and the file has grown
3507 ** during the current transaction, then do NOT mark the page as clean.
3508 ** When the database file grows, we must make sure that the last page
3509 ** gets written at least once so that the disk file will be the correct
3510 ** size. If you do not write this page and the size of the file
3511 ** on the disk ends up being too small, that can lead to database
3512 ** corruption during the next transaction.
3513 */
3514 }else{
drh538f5702007-04-13 02:14:30 +00003515 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3516 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
danielk197733e32162008-08-23 18:53:08 +00003517 pPg->flags |= PGHDR_DONT_WRITE;
danielk19773c407372005-02-15 02:54:14 +00003518#ifdef SQLITE_CHECK_PAGES
3519 pPg->pageHash = pager_pagehash(pPg);
3520#endif
drh8124a302002-06-25 14:43:57 +00003521 }
drh30e58752002-03-02 20:41:57 +00003522 }
danielk1977a1fa00d2008-08-27 15:16:33 +00003523 return rc;
drh30e58752002-03-02 20:41:57 +00003524}
3525
3526/*
3527** A call to this routine tells the pager that if a rollback occurs,
3528** it is not necessary to restore the data on the given page. This
3529** means that the pager does not have to record the given page in the
3530** rollback journal.
drh538f5702007-04-13 02:14:30 +00003531**
3532** If we have not yet actually read the content of this page (if
3533** the PgHdr.needRead flag is set) then this routine acts as a promise
3534** that we will never need to read the page content in the future.
3535** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003536*/
danielk19773b8a05f2007-03-19 17:44:26 +00003537void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003538 Pager *pPager = pPg->pPager;
3539
drhd3627af2006-12-18 18:34:51 +00003540 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00003541
3542 /* If the journal file is not open, or DontWrite() has been called on
3543 ** this page (DontWrite() sets the alwaysRollback flag), then this
3544 ** function is a no-op.
3545 */
danielk1977a1fa00d2008-08-27 15:16:33 +00003546 if( pPager->journalOpen==0
3547 || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno)
3548 || pPg->pgno>pPager->origDbSize
danielk19778c0a7912008-08-20 14:49:23 +00003549 ){
danielk197787c29a92008-01-18 11:33:16 +00003550 return;
3551 }
danielk1977a55e9352008-01-21 13:04:34 +00003552
drhc5d0bd92008-04-14 01:00:57 +00003553#ifdef SQLITE_SECURE_DELETE
drh1feb7dd2008-11-19 18:30:29 +00003554 if( sqlite3BitvecTest(pPager->pInJournal, pPg->pgno)!=0
3555 || pPg->pgno>pPager->origDbSize ){
drhc5d0bd92008-04-14 01:00:57 +00003556 return;
3557 }
3558#endif
3559
3560 /* If SECURE_DELETE is disabled, then there is no way that this
3561 ** routine can be called on a page for which sqlite3PagerDontWrite()
3562 ** has not been previously called during the same transaction.
3563 ** And if DontWrite() has previously been called, the following
3564 ** conditions must be met.
drh10131482008-07-11 03:34:09 +00003565 **
3566 ** (Later:) Not true. If the database is corrupted by having duplicate
3567 ** pages on the freelist (ex: corrupt9.test) then the following is not
3568 ** necessarily true:
danielk1977a55e9352008-01-21 13:04:34 +00003569 */
drh10131482008-07-11 03:34:09 +00003570 /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ); */
danielk1977a55e9352008-01-21 13:04:34 +00003571
drhf5e7bb52008-02-18 14:47:33 +00003572 assert( pPager->pInJournal!=0 );
3573 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003574 pPg->flags &= ~PGHDR_NEED_READ;
danielk1977fd7f0452008-12-17 17:30:26 +00003575 addToSavepointBitvecs(pPager, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00003576 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
3577 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003578}
3579
drhac69b052004-05-12 13:30:07 +00003580
drh30e58752002-03-02 20:41:57 +00003581/*
drh80e35f42007-03-30 14:06:34 +00003582** This routine is called to increment the database file change-counter,
3583** stored at byte 24 of the pager file.
3584*/
danielk1977c7b60172007-08-22 11:22:03 +00003585static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00003586 PgHdr *pPgHdr;
3587 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00003588 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00003589
drh701bb3b2008-08-02 03:50:39 +00003590#ifndef SQLITE_ENABLE_ATOMIC_WRITE
3591 assert( isDirect==0 ); /* isDirect is only true for atomic writes */
3592#endif
danielk197712dd5492008-12-18 15:45:07 +00003593 if( !pPager->changeCountDone && pPager->dbSize>0 ){
drh80e35f42007-03-30 14:06:34 +00003594 /* Open page 1 of the file for writing. */
3595 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3596 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00003597
3598 if( !isDirect ){
3599 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00003600 if( rc!=SQLITE_OK ){
3601 sqlite3PagerUnref(pPgHdr);
3602 return rc;
3603 }
danielk1977c7b60172007-08-22 11:22:03 +00003604 }
3605
drh80e35f42007-03-30 14:06:34 +00003606 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003607 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003608 change_counter++;
danielk19778c0a7912008-08-20 14:49:23 +00003609 put32bits(((char*)pPgHdr->pData)+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00003610
drh701bb3b2008-08-02 03:50:39 +00003611#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977c7b60172007-08-22 11:22:03 +00003612 if( isDirect && pPager->fd->pMethods ){
danielk19778c0a7912008-08-20 14:49:23 +00003613 const void *zBuf = pPgHdr->pData;
danielk1977c7b60172007-08-22 11:22:03 +00003614 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
3615 }
drh701bb3b2008-08-02 03:50:39 +00003616#endif
danielk1977c7b60172007-08-22 11:22:03 +00003617
drh80e35f42007-03-30 14:06:34 +00003618 /* Release the page reference. */
3619 sqlite3PagerUnref(pPgHdr);
3620 pPager->changeCountDone = 1;
3621 }
danielk1977c7b60172007-08-22 11:22:03 +00003622 return rc;
drh80e35f42007-03-30 14:06:34 +00003623}
3624
3625/*
danielk1977f653d782008-03-20 11:04:21 +00003626** Sync the pager file to disk.
3627*/
3628int sqlite3PagerSync(Pager *pPager){
3629 int rc;
drh7426f862008-08-26 21:07:26 +00003630 if( MEMDB ){
3631 rc = SQLITE_OK;
3632 }else{
3633 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
3634 }
danielk1977f653d782008-03-20 11:04:21 +00003635 return rc;
3636}
3637
3638/*
drh80e35f42007-03-30 14:06:34 +00003639** Sync the database file for the pager pPager. zMaster points to the name
3640** of a master journal file that should be written into the individual
3641** journal file. zMaster may be NULL, which is interpreted as no master
3642** journal (a single database transaction).
3643**
3644** This routine ensures that the journal is synced, all dirty pages written
3645** to the database file and the database file synced. The only thing that
3646** remains to commit the transaction is to delete the journal file (or
3647** master journal file if specified).
3648**
3649** Note that if zMaster==NULL, this does not overwrite a previous value
3650** passed to an sqlite3PagerCommitPhaseOne() call.
3651**
3652** If parameter nTrunc is non-zero, then the pager file is truncated to
3653** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00003654**
3655** If the final parameter - noSync - is true, then the database file itself
3656** is not synced. The caller must call sqlite3PagerSync() directly to
3657** sync the database file before calling CommitPhaseTwo() to delete the
3658** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00003659*/
danielk1977f653d782008-03-20 11:04:21 +00003660int sqlite3PagerCommitPhaseOne(
3661 Pager *pPager,
3662 const char *zMaster,
3663 Pgno nTrunc,
3664 int noSync
3665){
drh80e35f42007-03-30 14:06:34 +00003666 int rc = SQLITE_OK;
3667
danielk1977dad31b52008-05-15 11:08:07 +00003668 if( pPager->errCode ){
3669 return pPager->errCode;
3670 }
3671
drhd138c012008-05-13 00:58:18 +00003672 /* If no changes have been made, we can leave the transaction early.
3673 */
3674 if( pPager->dbModified==0 &&
3675 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3676 pPager->exclusiveMode!=0) ){
3677 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3678 return SQLITE_OK;
3679 }
3680
drh80e35f42007-03-30 14:06:34 +00003681 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3682 pPager->zFilename, zMaster, nTrunc);
3683
3684 /* If this is an in-memory db, or no pages have been written to, or this
3685 ** function has already been called, it is a no-op.
3686 */
3687 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3688 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00003689
danielk1977c7b60172007-08-22 11:22:03 +00003690#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3691 /* The atomic-write optimization can be used if all of the
3692 ** following are true:
3693 **
3694 ** + The file-system supports the atomic-write property for
3695 ** blocks of size page-size, and
3696 ** + This commit is not part of a multi-file transaction, and
3697 ** + Exactly one page has been modified and store in the journal file.
3698 **
3699 ** If the optimization can be used, then the journal file will never
3700 ** be created for this transaction.
3701 */
danielk19774d60af92008-09-08 15:35:06 +00003702 int useAtomicWrite;
danielk19778c0a7912008-08-20 14:49:23 +00003703 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
danielk19774d60af92008-09-08 15:35:06 +00003704 useAtomicWrite = (
danielk1977f55b8992007-08-24 08:15:53 +00003705 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00003706 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00003707 pPager->journalOff==jrnlBufferSize(pPager) &&
3708 nTrunc==0 &&
danielk19778c0a7912008-08-20 14:49:23 +00003709 (pPg==0 || pPg->pDirty==0)
danielk1977f55b8992007-08-24 08:15:53 +00003710 );
danielk1977700b9c52008-04-24 12:37:40 +00003711 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00003712 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00003713 /* Update the nRec field in the journal file. */
3714 int offset = pPager->journalHdr + sizeof(aJournalMagic);
3715 assert(pPager->nRec==1);
3716 rc = write32bits(pPager->jfd, offset, pPager->nRec);
3717
3718 /* Update the db file change counter. The following call will modify
3719 ** the in-memory representation of page 1 to include the updated
3720 ** change counter and then write page 1 directly to the database
3721 ** file. Because of the atomic-write property of the host file-system,
3722 ** this is safe.
3723 */
danielk1977ae72d982007-10-03 08:46:44 +00003724 if( rc==SQLITE_OK ){
3725 rc = pager_incr_changecounter(pPager, 1);
3726 }
danielk1977f55b8992007-08-24 08:15:53 +00003727 }else{
3728 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00003729 }
3730
danielk1977ae72d982007-10-03 08:46:44 +00003731 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00003732#endif
3733
drh80e35f42007-03-30 14:06:34 +00003734 /* If a master journal file name has already been written to the
3735 ** journal file, then no sync is required. This happens when it is
3736 ** written, then the process fails to upgrade from a RESERVED to an
3737 ** EXCLUSIVE lock. The next time the process tries to commit the
3738 ** transaction the m-j name will have already been written.
3739 */
3740 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00003741 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003742 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00003743 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00003744#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00003745 if( nTrunc!=0 ){
3746 /* If this transaction has made the database smaller, then all pages
3747 ** being discarded by the truncation must be written to the journal
3748 ** file.
3749 */
3750 Pgno i;
danielk1977d92db532008-11-17 04:56:24 +00003751 Pgno iSkip = PAGER_MJ_PGNO(pPager);
danielk197771aa7ff2008-05-20 07:05:09 +00003752 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3753 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
3754 rc = sqlite3PagerGet(pPager, i, &pPg);
3755 if( rc!=SQLITE_OK ) goto sync_exit;
3756 rc = sqlite3PagerWrite(pPg);
3757 sqlite3PagerUnref(pPg);
3758 if( rc!=SQLITE_OK ) goto sync_exit;
3759 }
3760 }
3761 }
drh80e35f42007-03-30 14:06:34 +00003762#endif
danielk197771aa7ff2008-05-20 07:05:09 +00003763 rc = writeMasterJournal(pPager, zMaster);
3764 if( rc!=SQLITE_OK ) goto sync_exit;
3765 rc = syncJournal(pPager);
3766 }
drh80e35f42007-03-30 14:06:34 +00003767 }
danielk1977c7b60172007-08-22 11:22:03 +00003768 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00003769
3770#ifndef SQLITE_OMIT_AUTOVACUUM
3771 if( nTrunc!=0 ){
3772 rc = sqlite3PagerTruncate(pPager, nTrunc);
3773 if( rc!=SQLITE_OK ) goto sync_exit;
3774 }
3775#endif
3776
3777 /* Write all dirty pages to the database file */
danielk19778c0a7912008-08-20 14:49:23 +00003778 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003779 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00003780 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00003781 assert( rc!=SQLITE_IOERR_BLOCKED );
3782 /* The error might have left the dirty list all fouled up here,
3783 ** but that does not matter because if the if the dirty list did
3784 ** get corrupted, then the transaction will roll back and
3785 ** discard the dirty list. There is an assert in
3786 ** pager_get_all_dirty_pages() that verifies that no attempt
3787 ** is made to use an invalid dirty list.
3788 */
drh153c62c2007-08-24 03:51:33 +00003789 goto sync_exit;
3790 }
danielk19778c0a7912008-08-20 14:49:23 +00003791 sqlite3PcacheCleanAll(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003792
3793 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00003794 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00003795 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00003796 }
3797 IOTRACE(("DBSYNC %p\n", pPager))
3798
3799 pPager->state = PAGER_SYNCED;
3800 }else if( MEMDB && nTrunc!=0 ){
3801 rc = sqlite3PagerTruncate(pPager, nTrunc);
3802 }
3803
3804sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00003805 if( rc==SQLITE_IOERR_BLOCKED ){
3806 /* pager_incr_changecounter() may attempt to obtain an exclusive
3807 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00003808 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00003809 * better to return SQLITE_BUSY.
3810 */
3811 rc = SQLITE_BUSY;
3812 }
drh80e35f42007-03-30 14:06:34 +00003813 return rc;
3814}
3815
3816
3817/*
drhed7c8552001-04-11 14:29:21 +00003818** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003819**
3820** If the commit fails for any reason, a rollback attempt is made
3821** and an error code is returned. If the commit worked, SQLITE_OK
3822** is returned.
drhed7c8552001-04-11 14:29:21 +00003823*/
drh80e35f42007-03-30 14:06:34 +00003824int sqlite3PagerCommitPhaseTwo(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003825 int rc = SQLITE_OK;
drhd9b02572001-04-15 00:37:09 +00003826
danielk1977efaaf572006-01-16 11:29:19 +00003827 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003828 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003829 }
drha6abd042004-06-09 17:37:22 +00003830 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003831 return SQLITE_ERROR;
3832 }
drhd138c012008-05-13 00:58:18 +00003833 if( pPager->dbModified==0 &&
3834 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3835 pPager->exclusiveMode!=0) ){
3836 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3837 return SQLITE_OK;
3838 }
drh4f0c5872007-03-26 22:05:01 +00003839 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003840 assert( pPager->state==PAGER_SYNCED || MEMDB || !pPager->dirtyCache );
3841 rc = pager_end_transaction(pPager, pPager->setMaster);
3842 rc = pager_error(pPager, rc);
drh86f8c192007-08-22 00:39:19 +00003843 return rc;
drhed7c8552001-04-11 14:29:21 +00003844}
3845
3846/*
drha6abd042004-06-09 17:37:22 +00003847** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003848** All in-memory cache pages revert to their original data contents.
3849** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003850**
3851** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003852** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003853** process is writing trash into the journal file (SQLITE_CORRUPT) or
3854** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3855** codes are returned for all these occasions. Otherwise,
3856** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003857*/
danielk19773b8a05f2007-03-19 17:44:26 +00003858int sqlite3PagerRollback(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003859 int rc = SQLITE_OK;
drh4f0c5872007-03-26 22:05:01 +00003860 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003861 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00003862 rc = pager_end_transaction(pPager, pPager->setMaster);
danielk19778c0a7912008-08-20 14:49:23 +00003863 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003864 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003865 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003866 }
danielk19778c0a7912008-08-20 14:49:23 +00003867 rc = pPager->errCode;
drha6abd042004-06-09 17:37:22 +00003868 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003869 if( pPager->state==PAGER_RESERVED ){
3870 int rc2;
3871 rc = pager_playback(pPager, 0);
3872 rc2 = pager_end_transaction(pPager, pPager->setMaster);
3873 if( rc==SQLITE_OK ){
3874 rc = rc2;
3875 }
3876 }else{
3877 rc = pager_playback(pPager, 0);
3878 }
danielk197707cb5602006-01-20 10:55:05 +00003879
danielk1977b3175382008-10-17 18:51:52 +00003880 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00003881 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00003882 }
danielk19778c0a7912008-08-20 14:49:23 +00003883
3884 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3885 ** cache. So call pager_error() on the way out to make any error
3886 ** persistent.
3887 */
3888 rc = pager_error(pPager, rc);
3889 }
drh86f8c192007-08-22 00:39:19 +00003890 return rc;
drh98808ba2001-10-18 12:34:46 +00003891}
drhd9b02572001-04-15 00:37:09 +00003892
3893/*
drh5e00f6c2001-09-13 13:46:56 +00003894** Return TRUE if the database file is opened read-only. Return FALSE
3895** if the database is (in theory) writable.
3896*/
drhf49661a2008-12-10 16:45:50 +00003897u8 sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003898 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003899}
3900
3901/*
drh0f7eb612006-08-08 13:51:43 +00003902** Return the number of references to the pager.
3903*/
danielk19773b8a05f2007-03-19 17:44:26 +00003904int sqlite3PagerRefcount(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003905 return sqlite3PcacheRefCount(pPager->pPCache);
drh0f7eb612006-08-08 13:51:43 +00003906}
3907
danielk197771d5d2c2008-09-29 11:49:47 +00003908/*
3909** Return the number of references to the specified page.
3910*/
3911int sqlite3PagerPageRefcount(DbPage *pPage){
3912 return sqlite3PcachePageRefcount(pPage);
3913}
3914
drh0f7eb612006-08-08 13:51:43 +00003915#ifdef SQLITE_TEST
3916/*
drhd9b02572001-04-15 00:37:09 +00003917** This routine is used for testing and analysis only.
3918*/
danielk19773b8a05f2007-03-19 17:44:26 +00003919int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003920 static int a[11];
danielk19778c0a7912008-08-20 14:49:23 +00003921 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
3922 a[1] = sqlite3PcachePagecount(pPager->pPCache);
3923 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
danielk1977d92db532008-11-17 04:56:24 +00003924 a[3] = pPager->dbSizeValid ? (int) pPager->dbSize : -1;
drhd9b02572001-04-15 00:37:09 +00003925 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003926 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003927 a[6] = pPager->nHit;
3928 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003929 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003930 a[9] = pPager->nRead;
3931 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003932 return a;
3933}
danielk197717b90b52008-06-06 11:11:25 +00003934int sqlite3PagerIsMemdb(Pager *pPager){
3935 return MEMDB;
3936}
drh0f7eb612006-08-08 13:51:43 +00003937#endif
drhdd793422001-06-28 01:54:48 +00003938
drhfa86c412002-02-02 15:01:15 +00003939/*
danielk1977fd7f0452008-12-17 17:30:26 +00003940** Ensure that there are at least nSavepoint savepoints open.
drhfa86c412002-02-02 15:01:15 +00003941*/
danielk1977fd7f0452008-12-17 17:30:26 +00003942int sqlite3PagerOpenSavepoint(Pager *pPager, int nSavepoint){
3943 int rc = SQLITE_OK;
3944
danielk197712dd5492008-12-18 15:45:07 +00003945 if( nSavepoint>pPager->nSavepoint && pPager->useJournal ){
danielk1977fd7f0452008-12-17 17:30:26 +00003946 int ii;
3947
3948 /* Either the sub-journal is open or there are no active savepoints. */
3949 assert( pPager->nSavepoint==0 || pPager->sjfd->pMethods );
3950
3951 /* Grow the Pager.aSavepoint array using realloc(). Return SQLITE_NOMEM
3952 ** if the allocation fails. Otherwise, zero the new portion in case a
3953 ** malloc failure occurs while populating it in the for(...) loop below.
3954 */
3955 PagerSavepoint *aNew = (PagerSavepoint *)sqlite3Realloc(
3956 pPager->aSavepoint, sizeof(PagerSavepoint)*nSavepoint
3957 );
3958 if( !aNew ){
3959 return SQLITE_NOMEM;
3960 }
3961 memset(&aNew[pPager->nSavepoint], 0,
3962 (nSavepoint - pPager->nSavepoint) * sizeof(PagerSavepoint)
3963 );
3964 pPager->aSavepoint = aNew;
3965 ii = pPager->nSavepoint;
3966 pPager->nSavepoint = nSavepoint;
3967
3968 /* Populate the PagerSavepoint structures just allocated. */
3969 for(/* no-op */; ii<nSavepoint; ii++){
danielk197712dd5492008-12-18 15:45:07 +00003970 assert( pPager->dbSizeValid );
danielk1977fd7f0452008-12-17 17:30:26 +00003971 aNew[ii].nOrig = pPager->dbSize;
danielk197767ddef62008-12-23 19:15:56 +00003972 if( pPager->journalOpen && pPager->journalOff>0 ){
3973 aNew[ii].iOffset = pPager->journalOff;
3974 }else{
3975 aNew[ii].iOffset = JOURNAL_HDR_SZ(pPager);
3976 }
danielk1977fd7f0452008-12-17 17:30:26 +00003977 aNew[ii].iSubRec = pPager->stmtNRec;
3978 aNew[ii].pInSavepoint = sqlite3BitvecCreate(pPager->dbSize);
3979 if( !aNew[ii].pInSavepoint ){
3980 return SQLITE_NOMEM;
danielk1977b3175382008-10-17 18:51:52 +00003981 }
drh334b2992007-09-06 23:28:23 +00003982 }
danielk1977fd7f0452008-12-17 17:30:26 +00003983
3984 /* Open the sub-journal, if it is not already opened. */
3985 rc = openSubJournal(pPager);
drh0f892532002-05-30 12:27:03 +00003986 }
danielk1977fd7f0452008-12-17 17:30:26 +00003987
drh86f8c192007-08-22 00:39:19 +00003988 return rc;
3989}
drhfa86c412002-02-02 15:01:15 +00003990
3991/*
danielk1977fd7f0452008-12-17 17:30:26 +00003992** Parameter op is always either SAVEPOINT_ROLLBACK or SAVEPOINT_RELEASE.
3993** If it is SAVEPOINT_RELEASE, then release and destroy the savepoint with
3994** index iSavepoint. If it is SAVEPOINT_ROLLBACK, then rollback all changes
3995** that have occured since savepoint iSavepoint was created.
3996**
3997** In either case, all savepoints with an index greater than iSavepoint
3998** are destroyed.
3999**
4000** If there are less than (iSavepoint+1) active savepoints when this
4001** function is called it is a no-op.
4002*/
4003int sqlite3PagerSavepoint(Pager *pPager, int op, int iSavepoint){
4004 int rc = SQLITE_OK;
4005
4006 assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
4007
4008 if( iSavepoint<pPager->nSavepoint ){
4009 int ii;
4010 int nNew = iSavepoint + (op==SAVEPOINT_ROLLBACK);
4011 for(ii=nNew; ii<pPager->nSavepoint; ii++){
4012 sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
4013 }
4014 pPager->nSavepoint = nNew;
4015
danielk19778a7adb02008-12-22 11:43:35 +00004016 if( op==SAVEPOINT_ROLLBACK && pPager->jfd->pMethods ){
danielk1977f3107512008-12-22 10:58:46 +00004017 PagerSavepoint *pSavepoint = (nNew==0)?0:&pPager->aSavepoint[nNew-1];
danielk1977fd7f0452008-12-17 17:30:26 +00004018 rc = pagerPlaybackSavepoint(pPager, pSavepoint);
4019 assert(rc!=SQLITE_DONE);
4020 }
danielk1977f3107512008-12-22 10:58:46 +00004021
danielk1977fd7f0452008-12-17 17:30:26 +00004022 /* If this is a release of the outermost savepoint, truncate
4023 ** the sub-journal. */
4024 if( nNew==0 && op==SAVEPOINT_RELEASE && pPager->sjfd->pMethods ){
4025 assert( rc==SQLITE_OK );
4026 rc = sqlite3OsTruncate(pPager->sjfd, 0);
4027 pPager->stmtNRec = 0;
danielk1977b3175382008-10-17 18:51:52 +00004028 }
drh663fc632002-02-02 18:49:19 +00004029 }
drhfa86c412002-02-02 15:01:15 +00004030 return rc;
4031}
4032
drh73509ee2003-04-06 20:44:45 +00004033/*
4034** Return the full pathname of the database file.
4035*/
danielk19773b8a05f2007-03-19 17:44:26 +00004036const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004037 return pPager->zFilename;
4038}
4039
drhb20ea9d2004-02-09 01:20:36 +00004040/*
drhd0679ed2007-08-28 22:24:34 +00004041** Return the VFS structure for the pager.
4042*/
4043const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
4044 return pPager->pVfs;
4045}
4046
4047/*
drhcc6bb3e2007-08-31 16:11:35 +00004048** Return the file handle for the database file associated
4049** with the pager. This might return NULL if the file has
4050** not yet been opened.
4051*/
4052sqlite3_file *sqlite3PagerFile(Pager *pPager){
4053 return pPager->fd;
4054}
4055
4056/*
danielk19775865e3d2004-06-14 06:03:57 +00004057** Return the directory of the database file.
4058*/
danielk19773b8a05f2007-03-19 17:44:26 +00004059const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004060 return pPager->zDirectory;
4061}
4062
4063/*
4064** Return the full pathname of the journal file.
4065*/
danielk19773b8a05f2007-03-19 17:44:26 +00004066const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004067 return pPager->zJournal;
4068}
4069
4070/*
drh2c8997b2005-08-27 16:36:48 +00004071** Return true if fsync() calls are disabled for this pager. Return FALSE
4072** if fsync()s are executed normally.
4073*/
danielk19773b8a05f2007-03-19 17:44:26 +00004074int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004075 return pPager->noSync;
4076}
4077
drh7c4ac0c2007-04-05 11:25:58 +00004078#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004079/*
drhb20ea9d2004-02-09 01:20:36 +00004080** Set the codec for this pager
4081*/
danielk19773b8a05f2007-03-19 17:44:26 +00004082void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004083 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004084 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004085 void *pCodecArg
4086){
4087 pPager->xCodec = xCodec;
4088 pPager->pCodecArg = pCodecArg;
4089}
drh7c4ac0c2007-04-05 11:25:58 +00004090#endif
drhb20ea9d2004-02-09 01:20:36 +00004091
danielk1977687566d2004-11-02 12:56:41 +00004092#ifndef SQLITE_OMIT_AUTOVACUUM
4093/*
danielk197787c29a92008-01-18 11:33:16 +00004094** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004095**
drh5e385312007-06-16 04:42:12 +00004096** There must be no references to the page previously located at
4097** pgno (which we call pPgOld) though that page is allowed to be
drhb3df2e12008-09-17 20:06:26 +00004098** in cache. If the page previously located at pgno is not already
drh5e385312007-06-16 04:42:12 +00004099** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004100**
drh5e385312007-06-16 04:42:12 +00004101** References to the page pPg remain valid. Updating any
4102** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004103** allocated along with the page) is the responsibility of the caller.
4104**
danielk19775fd057a2005-03-09 13:09:43 +00004105** A transaction must be active when this routine is called. It used to be
4106** required that a statement transaction was not active, but this restriction
4107** has been removed (CREATE INDEX needs to move a page when a statement
4108** transaction is active).
danielk19774c999992008-07-16 18:17:55 +00004109**
4110** If the fourth argument, isCommit, is non-zero, then this page is being
4111** moved as part of a database reorganization just before the transaction
4112** is being committed. In this case, it is guaranteed that the database page
4113** pPg refers to will not be written to again within this transaction.
danielk1977687566d2004-11-02 12:56:41 +00004114*/
danielk19774c999992008-07-16 18:17:55 +00004115int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
drh5e385312007-06-16 04:42:12 +00004116 PgHdr *pPgOld; /* The page being overwritten. */
danielk197794daf7f2004-11-08 09:26:09 +00004117 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004118
danielk1977687566d2004-11-02 12:56:41 +00004119 assert( pPg->nRef>0 );
4120
drh4f0c5872007-03-26 22:05:01 +00004121 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk19778c0a7912008-08-20 14:49:23 +00004122 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno);
drhb0603412007-02-28 04:47:26 +00004123 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004124
danielk1977b4626a32007-04-28 15:47:43 +00004125 pager_get_content(pPg);
danielk19774c999992008-07-16 18:17:55 +00004126
4127 /* If the journal needs to be sync()ed before page pPg->pgno can
4128 ** be written to, store pPg->pgno in local variable needSyncPgno.
4129 **
4130 ** If the isCommit flag is set, there is no need to remember that
4131 ** the journal needs to be sync()ed before database page pPg->pgno
4132 ** can be written to. The caller has already promised not to write to it.
4133 */
danielk19778c0a7912008-08-20 14:49:23 +00004134 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
danielk197794daf7f2004-11-08 09:26:09 +00004135 needSyncPgno = pPg->pgno;
danielk19770cd1bbd2008-11-26 07:25:52 +00004136 assert( pageInJournal(pPg) || pPg->pgno>pPager->origDbSize );
danielk19778c0a7912008-08-20 14:49:23 +00004137 assert( pPg->flags&PGHDR_DIRTY );
danielk1977ae825582004-11-23 09:06:55 +00004138 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004139 }
4140
danielk1977ef73ee92004-11-06 12:26:07 +00004141 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00004142 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00004143 ** page pgno before the 'move' operation, it needs to be retained
4144 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004145 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00004146 pPg->flags &= ~PGHDR_NEED_SYNC;
danielk1977687566d2004-11-02 12:56:41 +00004147 pPgOld = pager_lookup(pPager, pgno);
danielk19778c0a7912008-08-20 14:49:23 +00004148 assert( !pPgOld || pPgOld->nRef==1 );
danielk1977687566d2004-11-02 12:56:41 +00004149 if( pPgOld ){
danielk19778c0a7912008-08-20 14:49:23 +00004150 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
drh5e385312007-06-16 04:42:12 +00004151 }
danielk1977687566d2004-11-02 12:56:41 +00004152
danielk19778c0a7912008-08-20 14:49:23 +00004153 sqlite3PcacheMove(pPg, pgno);
4154 if( pPgOld ){
danielk1977bc2ca9e2008-11-13 14:28:28 +00004155 sqlite3PcacheDrop(pPgOld);
danielk1977f5fdda82004-11-03 08:44:05 +00004156 }
danielk1977f5fdda82004-11-03 08:44:05 +00004157
drhc047b9f2008-11-21 03:23:43 +00004158 sqlite3PcacheMakeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004159 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004160 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00004161
danielk197794daf7f2004-11-08 09:26:09 +00004162 if( needSyncPgno ){
4163 /* If needSyncPgno is non-zero, then the journal file needs to be
4164 ** sync()ed before any data is written to database file page needSyncPgno.
4165 ** Currently, no such page exists in the page-cache and the
danielk19774c999992008-07-16 18:17:55 +00004166 ** "is journaled" bitvec flag has been set. This needs to be remedied by
4167 ** loading the page into the pager-cache and setting the PgHdr.needSync
4168 ** flag.
danielk1977ae825582004-11-23 09:06:55 +00004169 **
danielk1977a98d7b42008-01-18 13:42:54 +00004170 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00004171 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00004172 ** array. Otherwise, if the page is loaded and written again in
4173 ** this transaction, it may be written to the database file before
4174 ** it is synced into the journal file. This way, it may end up in
4175 ** the journal file twice, but that is not a problem.
4176 **
danielk19773b8a05f2007-03-19 17:44:26 +00004177 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004178 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004179 */
4180 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004181 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004182 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004183 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00004184 if( rc!=SQLITE_OK ){
danielk1977d92db532008-11-17 04:56:24 +00004185 if( pPager->pInJournal && needSyncPgno<=pPager->origDbSize ){
drhf5e7bb52008-02-18 14:47:33 +00004186 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00004187 }
danielk197787c29a92008-01-18 11:33:16 +00004188 return rc;
4189 }
danielk1977ae825582004-11-23 09:06:55 +00004190 pPager->needSync = 1;
drhb3df2e12008-09-17 20:06:26 +00004191 assert( pPager->noSync==0 && !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00004192 pPgHdr->flags |= PGHDR_NEED_SYNC;
drhc047b9f2008-11-21 03:23:43 +00004193 sqlite3PcacheMakeDirty(pPgHdr);
danielk19773b8a05f2007-03-19 17:44:26 +00004194 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004195 }
4196
danielk1977687566d2004-11-02 12:56:41 +00004197 return SQLITE_OK;
4198}
4199#endif
4200
danielk19773b8a05f2007-03-19 17:44:26 +00004201/*
4202** Return a pointer to the data for the specified page.
4203*/
4204void *sqlite3PagerGetData(DbPage *pPg){
danielk197771d5d2c2008-09-29 11:49:47 +00004205 assert( pPg->nRef>0 || pPg->pPager->memDb );
danielk19778c0a7912008-08-20 14:49:23 +00004206 return pPg->pData;
danielk19773b8a05f2007-03-19 17:44:26 +00004207}
4208
4209/*
4210** Return a pointer to the Pager.nExtra bytes of "extra" space
4211** allocated along with the specified page.
4212*/
4213void *sqlite3PagerGetExtra(DbPage *pPg){
4214 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00004215 return (pPager?pPg->pExtra:0);
danielk19773b8a05f2007-03-19 17:44:26 +00004216}
4217
danielk197741483462007-03-24 16:45:04 +00004218/*
4219** Get/set the locking-mode for this pager. Parameter eMode must be one
4220** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4221** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4222** the locking-mode is set to the value specified.
4223**
4224** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4225** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4226** locking-mode.
4227*/
4228int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004229 assert( eMode==PAGER_LOCKINGMODE_QUERY
4230 || eMode==PAGER_LOCKINGMODE_NORMAL
4231 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4232 assert( PAGER_LOCKINGMODE_QUERY<0 );
4233 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4234 if( eMode>=0 && !pPager->tempFile ){
drh1bd10f82008-12-10 21:19:56 +00004235 pPager->exclusiveMode = (u8)eMode;
danielk197741483462007-03-24 16:45:04 +00004236 }
4237 return (int)pPager->exclusiveMode;
4238}
4239
drh3b020132008-04-17 17:02:01 +00004240/*
drh04335882008-09-26 21:08:08 +00004241** Get/set the journal-mode for this pager. Parameter eMode must be one of:
drh3b020132008-04-17 17:02:01 +00004242**
drh04335882008-09-26 21:08:08 +00004243** PAGER_JOURNALMODE_QUERY
4244** PAGER_JOURNALMODE_DELETE
4245** PAGER_JOURNALMODE_TRUNCATE
4246** PAGER_JOURNALMODE_PERSIST
4247** PAGER_JOURNALMODE_OFF
4248**
4249** If the parameter is not _QUERY, then the journal-mode is set to the
4250** value specified.
4251**
4252** The returned indicate the current (possibly updated)
drh3b020132008-04-17 17:02:01 +00004253** journal-mode.
4254*/
4255int sqlite3PagerJournalMode(Pager *pPager, int eMode){
danielk1977b3175382008-10-17 18:51:52 +00004256 if( !MEMDB ){
4257 assert( eMode==PAGER_JOURNALMODE_QUERY
4258 || eMode==PAGER_JOURNALMODE_DELETE
4259 || eMode==PAGER_JOURNALMODE_TRUNCATE
4260 || eMode==PAGER_JOURNALMODE_PERSIST
4261 || eMode==PAGER_JOURNALMODE_OFF
4262 || eMode==PAGER_JOURNALMODE_MEMORY );
4263 assert( PAGER_JOURNALMODE_QUERY<0 );
4264 if( eMode>=0 ){
drh1bd10f82008-12-10 21:19:56 +00004265 pPager->journalMode = (u8)eMode;
danielk1977b3175382008-10-17 18:51:52 +00004266 }else{
4267 assert( eMode==PAGER_JOURNALMODE_QUERY );
4268 }
drh3b020132008-04-17 17:02:01 +00004269 }
drhfdc40e92008-04-17 20:59:37 +00004270 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00004271}
4272
danielk1977b53e4962008-06-04 06:45:59 +00004273/*
4274** Get/set the size-limit used for persistent journal files.
4275*/
4276i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
4277 if( iLimit>=-1 ){
4278 pPager->journalSizeLimit = iLimit;
4279 }
4280 return pPager->journalSizeLimit;
4281}
4282
drh2e66f0b2005-04-28 17:18:48 +00004283#endif /* SQLITE_OMIT_DISKIO */